src/api/routes/work.js
/*
* Copyright (C) 2019 Akhilesh Kumar
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
import * as utils from '../helpers/utils';
import {
formatQueryParameters,
loadEntityRelationshipsForBrowse,
validateBrowseRequestQueryParameters
} from '../helpers/middleware';
import {
getEntityAliases,
getEntityIdentifiers,
getEntityRelationships,
getWorkBasicInfo
} from '../helpers/formatEntityData';
import {Router} from 'express';
import {makeEntityLoader} from '../helpers/entityLoader';
import {toLower} from 'lodash';
const router = Router();
const workBasicRelations = [
'defaultAlias.language',
'languageSet.languages',
'disambiguation',
'workType'
];
const workError = 'Work not found';
/**
*@swagger
*components:
* schemas:
* WorkDetail:
* type: object
* properties:
* bbid:
* type: string
* format: uuid
* example: ba446064-90a5-447b-abe5-139be547da2e
* defaultAlias:
* $ref: '#/components/schemas/Alias'
* disambiguation:
* type: string
* example: 'First work in the series'
* entityType:
* type: string
* example: 'Work'
* languages:
* type: array
* items:
* type: string
* description: Three letter ISO 639-3 language code
* example: eng
* workType:
* type: string
* example: 'Novel'
* BrowsedWorks:
* type: object
* properties:
* bbid:
* type: string
* format: uuid
* example: 'f94d74ce-c748-4130-8d59-38b290af8af3'
* works:
* type: array
* items:
* type: object
* properties:
* entity:
* $ref: '#/components/schemas/WorkDetail'
* relationships:
* type: array
* items:
* type: object
* properties:
* relationshipTypeID:
* type: number
* example: 8
* relationshipType:
* type: string
* example: 'Author'
*
*/
/**
*@swagger
*'/work/{bbid}':
* get:
* tags:
* - Lookup Requests
* summary: Lookup Work by BBID
* description: Returns the basic details of the Work
* operationId: getWorkByBbid
* parameters:
* - name: bbid
* in: path
* description: BBID of the Work
* required: true
* schema:
* type: string
* format: uuid
* responses:
* 200:
* description: Basic information of the Work entity
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/WorkDetail'
* 404:
* description: Work not found
* 400:
* description: Invalid BBID
*/
router.get('/:bbid',
makeEntityLoader('Work', workBasicRelations, workError),
async (req, res) => {
const workBasicInfo = await getWorkBasicInfo(res.locals.entity);
return res.status(200).send(workBasicInfo);
});
/**
*@swagger
* '/work/{bbid}/aliases':
* get:
* tags:
* - Lookup Requests
* summary: Get list of aliases of a Work by BBID
* description: Returns the list of aliases of a Work
* operationId: getAliasesOfWorkByBbid
* parameters:
* - name: bbid
* in: path
* description: BBID of the Work
* required: true
* schema:
* type: string
* format: uuid
* responses:
* 200:
* description: List of aliases with BBID of a Work entity
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Aliases'
* 404:
* description: Work not found
* 400:
* description: Invalid BBID
*/
router.get('/:bbid/aliases',
makeEntityLoader('Work', utils.aliasesRelations, workError),
async (req, res) => {
const workAliasesList = await getEntityAliases(res.locals.entity);
return res.status(200).send(workAliasesList);
});
/**
* @swagger
* '/work/{bbid}/identifiers':
* get:
* tags:
* - Lookup Requests
* summary: Get list of identifiers of the Work by BBID
* description: Returns the list of identifiers of the Work
* operationId: getIdentifiersOfWorkByBbid
* parameters:
* - name: bbid
* in: path
* description: BBID of the Work
* required: true
* schema:
* type: string
* format: uuid
* responses:
* 200:
* description: List of identifiers with BBID of the Work entity
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Identifiers'
* 404:
* description: Work not found
* 400:
* description: Invalid BBID
*/
router.get('/:bbid/identifiers',
makeEntityLoader('Work', utils.identifiersRelations, workError),
async (req, res) => {
const workIdentifiersList = await getEntityIdentifiers(res.locals.entity);
return res.status(200).send(workIdentifiersList);
});
/**
* @swagger
* '/work/{bbid}/relationships':
* get:
* tags:
* - Lookup Requests
* summary: Get list of relationships of the Work by BBID
* description: Returns the list of relationships of the Work
* operationId: getRelationshipsOfWorkByBbid
* parameters:
* - name: bbid
* in: path
* description: BBID of the Work
* required: true
* schema:
* type: string
* format: uuid
* responses:
* 200:
* description: List of relationships with BBID of the Work entity
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/Relationships'
* 404:
* description: Work not found
* 400:
* description: Invalid BBID
*/
router.get('/:bbid/relationships',
makeEntityLoader('Work', utils.relationshipsRelations, workError),
async (req, res) => {
const workRelationshipList = await getEntityRelationships(res.locals.entity);
return res.status(200).send(workRelationshipList);
});
/**
* @swagger
* '/work':
* get:
* tags:
* - Browse Requests
* summary: Gets a list of Works related to another Entity
* description: BBID of an Author, or an Edition, or a Work, or a Publisher, or a Series is passed as query parameter and their related Works are fetched
* operationId: getRelatedWorkByBbid
* parameters:
* - name: author
* in: query
* description: BBID of the corresponding Author
* required: false
* schema:
* type: string
* format: uuid
* - name: edition
* in: query
* description: BBID of the corresponding Edition
* required: false
* schema:
* type: string
* format: uuid
* - name: publisher
* in: query
* description: BBID of the corresponding Publisher
* required: false
* schema:
* type: string
* format: uuid
* - name: series
* in: query
* description: BBID of the corresponding Series
* required: false
* schema:
* type: string
* format: uuid
* - name: work
* in: query
* description: BBID of the corresponding Work
* required: false
* schema:
* type: string
* format: uuid
* - name: type
* in: query
* description: filter by Work type
* required: false
* schema:
* type: string
* enum: [novel, short story, epic, poem, play, article, scientific paper, non-fiction, anthology, serial, introduction, novella]
* - name: language
* in: query
* description: filter by Work language (ISO 639-3 three letter code)
* required: false
* schema:
* type: string
* responses:
* 200:
* description: List of Works which are related to another Entity
* content:
* application/json:
* schema:
* $ref: '#/components/schemas/BrowsedAuthors'
* 404:
* description: author/edition/series/work/publisher (other entity) not found
* 400:
* description: Invalid BBID passed in the query params OR Multiple browsed entities passed in parameters
*/
router.get('/',
formatQueryParameters(),
validateBrowseRequestQueryParameters(['author', 'edition', 'series', 'work', 'publisher']),
makeEntityLoader(null, utils.relationshipsRelations, 'Entity not found', true),
loadEntityRelationshipsForBrowse(),
async (req, res) => {
function relationshipsFilterMethod(relatedEntity) {
let workTypeMatched = true;
let workLanguageMatched = true;
if (req.query.type) {
workTypeMatched = toLower(relatedEntity.workType) === toLower(req.query.type);
}
if (req.query.language) {
workLanguageMatched = relatedEntity.languages.includes(toLower(req.query.language));
}
return workTypeMatched && workLanguageMatched;
}
const workRelationshipList = await utils.getBrowsedRelationships(
req.app.locals.orm, res.locals, 'Work',
getWorkBasicInfo, workBasicRelations, relationshipsFilterMethod
);
return res.status(200).send({
bbid: req.query.bbid,
works: workRelationshipList
});
});
export default router;