@manyos/smileconnect-api 1.48.0 → 1.49.0

package/conf/clients.json

@@ -18,7 +18,8 @@
         "basequery": "1=2",
         "fields": [],
         "constants": [],
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "incident": {
         "basequery": "1=1",
@@ -32,7 +33,8 @@
         "basequery": "1=2",
         "fields": [],
         "constants": [],
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "person": {
         "basequery": "1=2",
@@ -50,7 +52,8 @@
         "basequery": "1=2",
         "fields": [],
         "constants": [],
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "supportGroup": {
         "basequery": "1=2",
@@ -74,7 +77,8 @@
         "basequery": "1=2",
         "fields": [],
         "constants": [],
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "task": {
         "basequery": "1=2",
@@ -86,7 +90,8 @@
         "basequery": "1=2",
         "fields": [],
         "constants": [],
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "flowBuilder": {
         "basequery": "1=2",
@@ -303,7 +308,14 @@
         "scripts": {
           "POST": {
             "preMapping": [
-              "reject"
+              "attachi"
+            ]
+          }
+        },
+        "attachmentScripts": {
+          "POST": {
+            "preMapping": [
+              "attachi"
             ]
           }
         }
@@ -523,7 +535,8 @@
           }
         ],
         "basequery": "",
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "incidentWorklog": {
         "fields": [
@@ -545,7 +558,8 @@
           }
         ],
         "basequery": "",
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "problemWorklog": {
         "fields": [
@@ -567,7 +581,8 @@
           }
         ],
         "basequery": "",
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "task": {
         "basequery": "1=1",
@@ -636,8 +651,15 @@
             "value": "Other"
           }
         ],
-        "basequery": "",
-        "scripts": {}
+        "basequery": "1=1",
+        "scripts": {},
+        "attachmentScripts": {
+          "POST": {
+            "preMapping": [
+              "attachi"
+            ]
+          }
+        }
       },
       "flowBuilder": {
         "constants": [
@@ -828,7 +850,8 @@
           }
         ],
         "basequery": "",
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "workOrder": {
         "fields": [
@@ -1004,7 +1027,8 @@
           }
         ],
         "basequery": "",
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "incidentWorklog": {
         "fields": [
@@ -1026,7 +1050,8 @@
           }
         ],
         "basequery": "",
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "problemWorklog": {
         "fields": [
@@ -1048,7 +1073,8 @@
           }
         ],
         "basequery": "",
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "task": {
         "basequery": "1=1",
@@ -1119,7 +1145,8 @@
           }
         ],
         "basequery": "",
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "flowBuilder": {
         "constants": [
@@ -1276,7 +1303,8 @@
           }
         ],
         "basequery": "",
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "workOrder": {
         "basequery": "",
@@ -1453,7 +1481,8 @@
           }
         ],
         "basequery": "",
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "incidentWorklog": {
         "fields": [
@@ -1475,7 +1504,8 @@
           }
         ],
         "basequery": "",
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "problemWorklog": {
         "fields": [
@@ -1497,7 +1527,8 @@
           }
         ],
         "basequery": "",
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "task": {
         "basequery": "1=1",
@@ -1568,7 +1599,8 @@
           }
         ],
         "basequery": "",
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "flowBuilder": {
         "constants": [
@@ -1731,7 +1763,8 @@
           }
         ],
         "basequery": "",
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "workOrder": {
         "basequery": "",
@@ -1907,7 +1940,8 @@
           }
         ],
         "basequery": "",
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "incidentWorklog": {
         "fields": [
@@ -1929,7 +1963,8 @@
           }
         ],
         "basequery": "",
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "problemWorklog": {
         "fields": [
@@ -1951,7 +1986,8 @@
           }
         ],
         "basequery": "",
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "task": {
         "basequery": "1=1",
@@ -2022,7 +2058,8 @@
           }
         ],
         "basequery": "",
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "flowBuilder": {
         "constants": [
@@ -2185,7 +2222,8 @@
           }
         ],
         "basequery": "",
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "workOrder": {
         "basequery": "",
@@ -2361,7 +2399,8 @@
           }
         ],
         "basequery": "",
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "incidentWorklog": {
         "fields": [
@@ -2383,7 +2422,8 @@
           }
         ],
         "basequery": "",
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "problemWorklog": {
         "fields": [
@@ -2405,7 +2445,8 @@
           }
         ],
         "basequery": "",
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "task": {
         "basequery": "1=1",
@@ -2476,7 +2517,8 @@
           }
         ],
         "basequery": "",
-        "scripts": {}
+        "scripts": {},
+        "attachmentScripts": {}
       },
       "flowBuilder": {
         "constants": [

package/conf/scripts/attachi.js

@@ -0,0 +1,2 @@
+log.debug('globalScriptParams', globalScriptParams)
+log.debug('file', requestData)

package/controller/scriptController.js

@@ -62,7 +62,7 @@ async function executeScript(scriptId, requestData, params, clientId, globalScri
 }
 
 async function executeCode(code, requestData, params, logStream, executedByScript, clientId, scriptId, globalScriptParams) {
-    const log = require('@manyos/logger').setupLog('SMILEcatalog_Script_' + scriptId);
+    const log = require('@manyos/logger').setupLog('SMILEconnect_Script_' + scriptId);
     //todo should only be added once
     /*if (logStream) {
         log.addStream(logStream);
@@ -104,7 +104,7 @@ async function executeCode(code, requestData, params, logStream, executedByScrip
     //todo Add timeout
     try {
         const result = await vm.run(
-            `return new Promise(async function(resolve, reject) {try {${code}} catch (error) {reject(error);}});`,
+            `return new Promise(async function(resolve, reject) {try {{${code}}resolve()} catch (error) {reject(error);}});`,
             scriptId || 'vm.js');
         log.debug('script ended', result);
         return result;

package/controller/taskController.js

@@ -445,14 +445,41 @@ async function updateTask(clientConfig, id, taskData, globalScriptParams) {
     return result;
 }
 
-function setWorklogAttachment(clientConfig, worklogId, file, attachmentId) {
+async function setWorklogAttachment(clientConfig, worklogId, file, attachmentId, globalScriptParams) {
+    const scripts = clientConfig.taskWorklog.attachmentScripts.POST;
+    if (!globalScriptParams) {
+        globalScriptParams = {}
+    }
+    globalScriptParams.isAttachment = true
+    globalScriptParams.attachmentId = attachmentId
+    //run preScripts
+    if (scripts && scripts.preMapping) {
+        await scriptController.runScripts(scripts.preMapping, file, clientConfig.clientId, globalScriptParams);
+    }
     const fieldId = getAttachmentFieldId(attachmentId);
-    return arquery.setAttachment(CONSTANTS.FORM_TASK_WORKLOG, worklogId, fieldId, file);
+    const result = await arquery.setAttachment(CONSTANTS.FORM_TASK_WORKLOG, worklogId, fieldId, file);
+
+    return result
 }
 
-function getWorklogAttachment(clientConfig, worklogId, attachmentId) {
+async function getWorklogAttachment(clientConfig, worklogId, attachmentId, globalScriptParams) {
+    const scripts = clientConfig.taskWorklog.attachmentScripts.GET;
+    if (!globalScriptParams) {
+        globalScriptParams = {}
+    }
+    globalScriptParams.isAttachment = true
+    globalScriptParams.attachmentId = attachmentId
+    //run preScripts
+    if (scripts && scripts.preMapping) {
+        await scriptController.runScripts(scripts.preMapping, undefined, clientConfig.clientId, globalScriptParams);
+    }
     const fieldId = getAttachmentFieldId(attachmentId);
-    return arquery.getAttachment(CONSTANTS.FORM_TASK_WORKLOG, worklogId, fieldId);
+    const result = await arquery.getAttachment(CONSTANTS.FORM_TASK_WORKLOG, worklogId, fieldId);
+    //run afterExecution
+    if (scripts && scripts.afterExecution) {
+        await scriptController.runScripts(scripts.afterExecution, result, clientConfig.clientId, globalScriptParams);
+    }
+    return result
 }
 
 function getAttachmentFieldId(attachmentId) {

package/controller/ticketWorkLogController.js

@@ -84,14 +84,43 @@ async function createWorklog(ticketConfig, clientConfig, ticketId, data, globalS
     return result;
 }
 
-function setWorklogAttachment(ticketConfig, clientConfig, worklogId, file, attachmentId) {
+async function setWorklogAttachment(ticketConfig, clientConfig, worklogId, file, attachmentId, globalScriptParams) {
+    const scripts = clientConfig[ticketConfig.requestTypeWorkLog].attachmentScripts.POST;
+    if (!globalScriptParams) {
+        globalScriptParams = {}
+    }
+    globalScriptParams.isAttachment = true
+    globalScriptParams.attachmentId = attachmentId
+    //run preScripts
+    if (scripts && scripts.preMapping) {
+        await scriptController.runScripts(scripts.preMapping, file, clientConfig.clientId, globalScriptParams);
+    }
     const fieldId = getAttachmentFieldId(attachmentId);
-    return arquery.setAttachment(ticketConfig.forms.workLog, worklogId, fieldId, file);
+    const result = await arquery.setAttachment(ticketConfig.forms.workLog, worklogId, fieldId, file);
+    //run afterExecution
+    if (scripts && scripts.afterExecution) {
+        await scriptController.runScripts(scripts.afterExecution, file, clientConfig.clientId, globalScriptParams);
+    }
+    return result
 }
 
-function getWorklogAttachment(ticketConfig, clientConfig, worklogId, attachmentId) {
+async function getWorklogAttachment(ticketConfig, clientConfig, worklogId, attachmentId, globalScriptParams) {
+    const scripts = clientConfig[ticketConfig.requestTypeWorkLog].attachmentScripts.GET;
+    if (!globalScriptParams) {
+        globalScriptParams = {}
+    }
+    globalScriptParams.isAttachment = true
+    globalScriptParams.attachmentId = attachmentId
+    //run preScripts
+    if (scripts && scripts.preMapping) {
+        await scriptController.runScripts(scripts.preMapping, undefined, clientConfig.clientId, globalScriptParams);
+    }
     const fieldId = getAttachmentFieldId(attachmentId);
-    return arquery.getAttachment(ticketConfig.forms.workLog, worklogId, fieldId);
+    const result = await arquery.getAttachment(ticketConfig.forms.workLog, worklogId, fieldId);
+    if (scripts && scripts.afterExecution) {
+        await scriptController.runScripts(scripts.afterExecution, result, clientConfig.clientId, globalScriptParams);
+    }
+    return result
 }
 
 function getAttachmentFieldId(attachmentId) {

package/docs/releases.md

@@ -2,6 +2,9 @@
 
 ## API 
 
+### 1.49.0 - 04.11.21
+Add attachmentScripts to Worklogs
+
 ### 1.48.0 - 03.11.21
 Add parameter SSO_USERNAME_ATTRIBUTE to config.
 

package/package.json

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

package/routes/taskRoutes.js

@@ -287,7 +287,7 @@ module.exports = (function () {
                 };
             } else {
                 //fileContent = JSON.parse(file.data);
-                task.setWorklogAttachment(req.user.config, worklogId, file, attachmentId).then(
+                task.setWorklogAttachment(req.user.config, worklogId, file, attachmentId, req.globalScriptParams).then(
                     uploadResult => {
                         req.result = uploadResult;
                         next();
@@ -318,7 +318,7 @@ module.exports = (function () {
         );
 
         //fileContent = JSON.parse(file.data);
-        task.getWorklogAttachment(req.user.config, worklogId, attachmentId).then(
+        task.getWorklogAttachment(req.user.config, worklogId, attachmentId, req.globalScriptParams).then(
             downloadResult => {
                 req.downloadResult = downloadResult;
                 next();

package/routes/ticketWorkLogRoutes.js

@@ -91,7 +91,7 @@ module.exports = (function() {
                 };
             } else {
                 //fileContent = JSON.parse(file.data);
-                ticketWorkLogController.setWorklogAttachment(req.ticketConfig, req.user.config, worklogId, file, attachmentId).then(
+                ticketWorkLogController.setWorklogAttachment(req.ticketConfig, req.user.config, worklogId, file, attachmentId, req.globalScriptParams).then(
                     uploadResult => {
                         req.result = uploadResult;
                         next();
@@ -123,7 +123,7 @@ module.exports = (function() {
             );
 
             //fileContent = JSON.parse(file.data);
-            ticketWorkLogController.getWorklogAttachment(req.ticketConfig, req.user.config, worklogId, attachmentId).then(
+            ticketWorkLogController.getWorklogAttachment(req.ticketConfig, req.user.config, worklogId, attachmentId, req.globalScriptParams).then(
                 downloadResult => {
                     req.downloadResult = downloadResult;
                     next();

package/util/config.js

@@ -261,6 +261,10 @@ function checkClientConfig(client) {
                 clientConfig[key].scripts = {};
                 log.info('add scripts', key);
             }
+            if (key.endsWith('Worklog') && !clientConfig[key].attachmentScripts) {
+                clientConfig[key].attachmentScripts = {};
+                log.info('add attachmentScripts', key);
+            }
         }
     });
     //add too less