@manyos/smileconnect-api 1.52.0 → 1.52.2

package/app.js

@@ -181,6 +181,13 @@ app.use('/v1/health', function (req, res, next) {
     res.json({status:"ok"})
 })
 
+//health check
+app.use('/v1/openapi/:clientId', async function (req, res, next) {
+    const clientId = req.params.clientId;
+    const spec = await config.getDesignPackage(clientId)
+    res.json(spec)
+})
+
 const maxFilesize = process.env.MAX_FILESIZE || 5;
 
 app.use(fileUpload({

package/conf/clients.json

@@ -332,7 +332,8 @@
           "Work Order ID",
           "Status",
           "InstanceId",
-          "WO Type Field 2",
+          "WO Type Field 02",
+          "WO Type Field 10",
           "Categorization Tier 1",
           "Categorization Tier 2",
           "Categorization Tier 3",

package/controller/ticketCIRelationController.js

@@ -390,13 +390,15 @@ async function getOppositeAssocTypeByType(assocType) {
 async function getOppositeAssocTypeByCode(assocCode) {
     const assocTypes = await getAssocTypes();
     return assocTypes.find(assoc => {
-        return assoc.assocCode === assocCode;
+        return assoc.assocCode === assocCode;å
     });
 }
 
 function doesCIRelationExists(ticketRelations, newRelation) {
+    log.debug('check for relation old', ticketRelations)
+    log.debug('check for relation new', newRelation)
     const relationFound = ticketRelations.find(relation => {
-        return (relation.ciId === newRelation.ciId &&
+        return ((relation.ciId === newRelation.ciId || relation.ciId === newRelation.ciReconId || relation.ciReconId === newRelation.ciId) &&
             relation.relationType === newRelation.relationType);
     });
     if (relationFound) {

package/docs/releases.md

@@ -1,6 +1,13 @@
 # Release Notes
 
 ## API 
+
+### 1.52.2 - 16.11.11
+Fix issue: Inbound Events Names missed 'Worklog' for Task Worklogs
+
+### 1.52.1 - 12.11.11
+Fix issue: Task CI relations might be removed on duplicate updates
+
 ### 1.52.0 - 09.11.21
 Allow 16k header
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@manyos/smileconnect-api",
-  "version": "1.52.0",
+  "version": "1.52.2",
   "description": "A proxy and abstraction layer for BMCs IT Service Management Suite",
   "main": "app.js",
   "scripts": {

package/routes/appConfigRoutes.js

@@ -377,6 +377,27 @@ module.exports = (function() {
             }
         });
 
+    /*routes.get('/clients/:id/designPackage',
+        async function (req, res, next) {
+            const id = req.params.id;
+            setEventData(
+                req,
+                CONSTANTS.EVENT_BASE_APC,
+                CONSTANTS.EVENT_ACTION_QUERY,
+                CONSTANTS.FORM_APC_CLIENTS,
+                id
+            );
+
+            try {
+                const clientDesignPackage = await config.getDesignPackage(id)
+                req.result = clientDesignPackage
+                next();
+            } catch (error) {
+                next(error);
+            }
+        });
+    */
+
     routes.get('/clients', isAuthorizedAdmin,
         function (req, res, next) {
             const id = req.params.id;
@@ -450,5 +471,34 @@ module.exports = (function() {
             }
         });
 
+    routes.get('/forms/:id/fields', isAuthorizedAdmin,
+        async function (req, res, next) {
+            const id = req.params.id;
+            const nameOnly = req.query.nameOnly;
+            setEventData(
+                req,
+                CONSTANTS.EVENT_BASE_APC,
+                CONSTANTS.EVENT_ACTION_QUERY,
+                CONSTANTS.FORM_APC_FORMS_FIELDS,
+                id
+            );
+
+            try {
+                let fields = await config.getFields(id);
+                if (nameOnly === 'true') {
+                    fields = fields.map(x => x.name);
+                }
+                if (fields && Array.isArray(fields)) {
+                    fields.sort();
+                }
+                req.result = {
+                    "data": fields
+                };
+                next();
+            } catch (error) {
+                next(error);
+            }
+        });
+
     return routes;
 })();

package/routes/taskRoutes.js

@@ -158,7 +158,7 @@ module.exports = (function () {
         req.globalScriptParams.id2 = taskId
         eventLog.setEventData(
             req,
-            req.parentEventBase + '_' + CONSTANTS.EVENT_BASE_TAS,
+            req.parentEventBase + '_' + CONSTANTS.EVENT_BASE_TAS_WORKLOG,
             CONSTANTS.EVENT_ACTION_QUERY,
             CONSTANTS.FORM_TASK_WORKLOG,
             req.parentId,
@@ -184,7 +184,7 @@ module.exports = (function () {
         req.globalScriptParams.id2 = taskId
         eventLog.setEventData(
             req,
-            req.parentEventBase + '_' + CONSTANTS.EVENT_BASE_TAS,
+            req.parentEventBase + '_' + CONSTANTS.EVENT_BASE_TAS_WORKLOG,
             CONSTANTS.EVENT_ACTION_CREATE,
             CONSTANTS.FORM_TASK_WORKLOG,
             req.parentId,
@@ -228,7 +228,7 @@ module.exports = (function () {
         req.globalScriptParams.id3 = worklogId
         eventLog.setEventData(
             req,
-            req.parentEventBase + '_' + CONSTANTS.EVENT_BASE_TAS,
+            req.parentEventBase + '_' + CONSTANTS.EVENT_BASE_TAS_WORKLOG,
             CONSTANTS.EVENT_ACTION_QUERY,
             CONSTANTS.FORM_TASK_WORKLOG,
             req.parentId,

package/util/config.js

@@ -6,6 +6,7 @@ const log = require('@manyos/logger').setupLog('SMILEconnect_' + path.basename(_
 
 const clientConfigFile = 'conf/clients.json';
 const arquery = require('../util/arquery');
+const mappingUtil = require('../util/mappingUtil');
 const CacheService = require ('../util/cache.service');
 
 const CONSTANTS = require('./constants');
@@ -78,6 +79,15 @@ async function setCustomFormMapping(mapping, objectType) {
     return getCustomFormMapping(objectType)
 }
 
+function getDeprecatedMappingAsCustom(objectType) {
+    const deprecatedMapping = getMapping(objectType)
+    const mapping = {}
+    deprecatedMapping.forEach(item => {
+        mapping[item.oldName] = item.newName
+    })
+    return mapping
+}
+
 function getMapping(objectType) {
     const configFile = 'conf/mapping.json';
     log.debug('start to read config from file', configFile);
@@ -297,6 +307,213 @@ async function checkConfig() {
     log.info('check config done');
 }
 
+async function getDesignPackage(clientId) {
+    const info = {
+        title: `SMILEconnect Interface for ${clientId}`,
+        description: `This document contains the SMILEconnect OpenAPI specification for the client ${clientId}`,
+        version: Date.now(),
+        contact: {
+            email: 'mail@manyos.it'
+        },
+        termsOfService: 'https://manyos.it'
+    }
+    const servers = [
+        {
+            url: "https://url123",
+            description: "dev"
+        },
+        {
+            url: "https://url12345",
+            description: "prod"
+        }
+    ]
+    const clientConfig = await getClientConfig(clientId)
+    const schemas = {}
+    let paths = {}
+    const keys = Object.keys(ticketConfig)
+    for (let x=0; x<keys.length; x++) {
+        const key = keys[x]
+        const config = ticketConfig[key]
+        const clientObjectConfig = clientConfig[config.requestType]
+        if (clientObjectConfig) {
+            {
+                const mapping = getDeprecatedMappingAsCustom(config.requestType)
+                schemas[config.requestType] = await getObjectSchema(clientObjectConfig, mapping, config.forms.regular)
+                paths = {...paths, ... await getPathDef(config.assocTicketType, config.baseURI, config.requestType)}
+            }
+            if (config.requestTypeWorkLog) {
+                const mapping = getDeprecatedMappingAsCustom(config.requestTypeWorkLog)
+                schemas[config.requestTypeWorkLog] = await getObjectSchema(clientConfig[config.requestTypeWorkLog], mapping, config.forms.workLog)
+                paths = {...paths, ... await getPathDef(config.assocTicketType, config.baseURI + '/{ticketId}/worklogs', config.requestTypeWorkLog, true, true)}
+            }
+            if (config.requestTemplate) {
+                const mapping = getDeprecatedMappingAsCustom(config.requestTemplate)
+                schemas[config.requestTemplate] = await getObjectSchema(clientConfig[config.requestTemplate], mapping, config.forms.template)
+            }
+        }
+    }
+    const customFormMappings = await getCustomFormMapping()
+    const customKeys = Object.keys(customFormMappings)
+    for (let x=0; x<customKeys.length; x++) {
+        const key = customKeys[x]
+        const formName = customFormMappings[key].formName
+        const clientObjectConfig = clientConfig[`custom_${formName}`]
+        log.debug('key', key, clientObjectConfig)
+        if (clientObjectConfig) {
+            schemas[key] = await getObjectSchema(clientObjectConfig, customFormMappings[key].mapping, formName)
+            paths = {...paths, ... await getPathDef(key, '/v1/customForms/' + key, key)}
+        }
+    }
+    return {openapi: "3.0.1", info, servers, paths, components: {schemas}}
+}
+
+async function getPathDef(objectName, baseUri, tag, isSubTicket, suppressUpdate, suppressCreate) {
+    const ticketIdParam = {
+        name: "ticketId",
+        description: "id of the parent object to retrieve",
+        schema: {
+            "type": "string"
+        },
+        in: "path",
+        required: true
+    }
+    const parameters = [
+        {
+            name: "id",
+            description: "id of the object to retrieve",
+            schema: {
+                "type": "string"
+            },
+            in: "path",
+            required: true
+        }
+    ]
+    if (isSubTicket) {
+        parameters.push(ticketIdParam)
+    }
+
+    const pathDef = {}
+    pathDef[`${baseUri}/{id}`] = {
+        parameters,
+        get: {
+            tags: [tag],
+            summary: `Get a single ${objectName} object by id`,
+            description: "A single object is returned in the data attribute",
+            parameters: [],
+            responses: await getApiResponse(tag, true)
+        }
+    }
+    if (!suppressUpdate) {
+        pathDef[`${baseUri}/{id}`].put = {
+            tags: [tag],
+                summary: `Update an object of type ${objectName}`,
+                description: "A single object is returned in the data attribute",
+                parameters: [],
+                responses: await getApiResponse(tag, false)
+        }
+    }
+
+    pathDef[`${baseUri}`] = {
+        get: {
+            tags: [tag],
+            summary: `Get a list of object of type ${objectName}`,
+            description: "An array ob objects is returned in the data attribute",
+            parameters: [],
+            responses: await getApiResponse(tag, false)
+        }
+    }
+    if (!suppressCreate) {
+        pathDef[`${baseUri}`].post = {
+            tags: [tag],
+            summary: `Create a new object of type ${objectName}`,
+            description: "A single object is returned in the data attribute",
+            parameters: [],
+            responses: await getApiResponse(tag, false)
+        }
+    }
+    if (isSubTicket) {
+        pathDef[`${baseUri}`].parameters = [ticketIdParam]
+    }
+    return pathDef
+}
+
+async function getApiResponse(schema, single) {
+    responses = {
+        "200": {
+            description: "successful operation",
+            content: {
+                "application/json": {
+                    schema: {
+                        type: "object",
+                        properties: {
+                            data: {}
+                        }
+                    }
+                }
+            }
+        }
+    }
+    if (!single) {
+        responses["200"].content["application/json"].schema.properties.data = {
+            type: "array",
+            items: {
+                "$ref": `#/components/schemas/${schema}`
+            }
+        }
+    } else {
+        responses["200"].content["application/json"].schema.properties.data = {
+            "$ref": `#/components/schemas/${schema}`
+        }
+    }
+    return responses
+}
+
+async function getObjectSchema(clientObjectConfig, mapping, formName) {
+    const fields = await getFields(formName)
+    const required = []
+    const properties = {}
+    log.debug('clientObjConf', clientObjectConfig)
+    clientObjectConfig.fields.forEach(field => {
+        const mappedName = mapping[field]
+        const fieldDef = {}
+        const fieldDetails = fields.find(item => item.name === field)
+
+        if (fieldDetails) {
+            fieldDef.type = fieldDetails.type
+            if (fieldDetails.entryMode === 'Required') {
+                required.push(mappedName)
+            }
+            if(fieldDetails.fieldLimit) {
+                fieldDef.maxLength = fieldDetails.fieldLimit.maxLength
+            }
+            if (fieldDetails.type === 'SelectionField') {
+                fieldDef.type = 'string'
+                if (fieldDetails.fieldLimit && fieldDetails.fieldLimit.values) {
+                    const enumVals = fieldDetails.fieldLimit.values.map(item => item.enumItemName)
+                    fieldDef.enum = enumVals
+                } else if (fieldDetails.fieldLimit && fieldDetails.fieldLimit.valueMapping) {
+                    const enumVals = Object.values(fieldDetails.fieldLimit.valueMapping)
+                    fieldDef.enum = enumVals
+                }
+
+            } else if (fieldDetails.type === 'CharacterField') {
+                fieldDef.type = 'string'
+            } else if (fieldDetails.type === 'DateTimeField') {
+                fieldDef.type = 'string'
+                fieldDef.format = 'date-time'
+            } else if (fieldDetails.type === 'DateField') {
+                fieldDef.format = 'date'
+            } else if (fieldDetails.type === 'DecimalField') {
+                fieldDef.type = 'number'
+            }
+            //fieldDef.details = fieldDetails
+        }
+        properties[mappedName] = fieldDef
+    })
+    //mappedFields.push(fields)
+    return {required, properties}
+}
+
 function getForms() {
     log.debug('get forms');
     const key = 'forms';
@@ -416,5 +633,6 @@ module.exports = {
     getFields,
     ticketConfig,
     getCustomFormMapping,
-    setCustomFormMapping
+    setCustomFormMapping,
+    getDesignPackage
 };

package/util/constants.js

@@ -68,6 +68,8 @@ module.exports = {
 
     EVENT_BASE_TAS: "TAS",
 
+    EVENT_BASE_TAS_WORKLOG: "TAS_Worklog",
+
     EVENT_ACTION_QUERY: 'Query',
     EVENT_ACTION_CREATE: 'Create',
     EVENT_ACTION_MODIFY: 'Modify',

package/util/mappingUtil.js

@@ -1,4 +1,5 @@
 const path = require('path');
+const {getFields} = require("./config");
 const log = require('@manyos/logger').setupLog('SMILEconnect_' + path.basename(__filename));
 
 function applyMapping2Remedy(entryData, mapping, constants, fields) {
@@ -91,6 +92,19 @@ function getFieldsForCreate(mapping, mappingNew, clientFields) {
     return targetList;
 }
 
+//get the allowed fields for a POST Action based on a PUT/GET Action
+/*function mapField(mapping, remedyField) {
+    const mapped = mapping.find(element => {
+        return element.oldName === remedyField;
+    });
+    log.debug(mapped)
+    if (mapped) {
+        return mapped.newName
+    }
+
+    return remedyField;
+}*/
+
 function applyCustomFormMapping(object, mapping, requestIdField) {
     //Apply mapping
     Object.keys(mapping).forEach(remedyName => {