@manyos/smileconnect-api 1.47.0 → 1.49.0

package/app.js

@@ -50,6 +50,7 @@ const https = require('https');
 const maxHTTPSockets = process.env.MAX_HTTP_SOCKETS || 10;
 
 const SSO_CLIENTNAME_ATTRIBUTE = process.env.SSO_CLIENTNAME_ATTRIBUTE || 'azp';
+const SSO_USERNAME_ATTRIBUTE = process.env.SSO_USERNAME_ATTRIBUTE || 'preferred_username';
 
 http.globalAgent.maxSockets = maxHTTPSockets;
 https.globalAgent.maxSockets = maxHTTPSockets;
@@ -157,7 +158,7 @@ passport.use(
             'scope': jwt_payload.scope,
             'exp': jwt_payload.exp,
             'config': clientConfig,
-            'username': jwt_payload.preferred_username
+            'username': jwt_payload[SSO_USERNAME_ATTRIBUTE]
         }
         log.debug('Passport User', jwt_payload);
         const resource_access = jwt_payload.resource_access;

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/configuration/config.md

@@ -86,6 +86,16 @@ Sample:
 
 *SSO_CLIENTNAME_ATTRIBUTE = "preferred_username"*
 
+### SSO_USERNAME_ATTRIBUTE
+
+The attribute that contains the user name in the token. User name is used to identify admins. It is only needed for configuration.
+
+Default: *preferred_username*
+
+Sample:
+
+*SSO_CLIENTNAME_ATTRIBUTE = "email"*
+
 ### ADMIN_USERS
 
 List of users who are allowed to access /v1/appconfig endpoints.
@@ -267,6 +277,34 @@ Sample:
 
 *SSO_ISSUER=https://sso.mydomain.io/auth/realms/itsmproxy*
 
+### SSO_CLIENTNAME_ATTRIBUTE
+
+The attribute that contains the client name in the token.
+
+Default: *azp*
+
+Set this value if you only want to use a single client in the SSO and service accounts as clients in SMILEconnect. This can be used to manage your SMILEconnect clients via a directory service like LDAP/AD. [More Info](https://datatracker.ietf.org/doc/html/rfc6749#section-1.3.3)
+
+Sample:
+
+*SSO_CLIENTNAME_ATTRIBUTE = "preferred_username"*
+
+### SSO_USERNAME_ATTRIBUTE
+
+The attribute that contains the user name in the token. User name is used to identify admins. It is only needed for configuration.
+
+Default: *preferred_username*
+
+Sample:
+
+*SSO_CLIENTNAME_ATTRIBUTE = "email"*
+
+### ADMIN_USERS
+
+List of users who are allowed to access /v1/appconfig endpoints.
+
+Sample:
+ADMIN_USERS=username1, username2
 
 ## Logging
 
@@ -306,6 +344,22 @@ The URL of the OIDC Provider for user authentication
 Sample:
 *REACT_APP_SSO_URL=https://sso.mydomain.io/auth/realms/itsmproxy*
 
+since version 1.5.2:
+For manual OICD endpoint configuration you must provide all of the following parameters:
+*REACT_APP_OIDC_AUTHORIZATION_ENDPOINT=https://sso.mydomain.io/auth/realms/itsmproxy/protocol/openid-connect/auth*
+*REACT_APP_OIDC_USERINFO_ENDPOINT=https://sso.mydomain.io/auth/realms/itsmproxy/protocol/openid-connect/userinfo*
+*REACT_APP_OIDC_END_SESSION_ENDPOINT=https://sso.mydomain.io/auth/realms/itsmproxy/protocol/openid-connect/logout*
+*REACT_APP_OIDC_JWKS_URI=https://sso.mydomain.io/auth/realms/itsmproxy/protocol/openid-connect/certs*
+*REACT_APP_OIDC_TOKEN_ENDPOINT=https://sso.mydomain.io/auth/realms/itsmproxy/protocol/openid-connect/token*
+
+To allow Authorization Flow with PKCE set 
+REACT_APP_OIDC_RESPONSE_TYPE=code 
+Default value is "token id_token", which uses Implicit Flow.
+
+Use REACT_APP_OIDC_TOKEN to choose the token to use. Default is access_token
+
+Use REACT_APP_OIDC_SCOPE to choose the oidc scope
+
 ## GUI
 
 ### REACT_APP_GUI_URL

package/docs/openapi.json

@@ -4479,7 +4479,9 @@
                         "OIDC": [
                         ]
                     }
-                ]
+                ],
+                "summary": "Get a single record",
+                "description": "Receive a single record from a custom form, identified by its id."
             },
             "put": {
                 "requestBody": {
@@ -4505,7 +4507,9 @@
                         "OIDC": [
                         ]
                     }
-                ]
+                ],
+                "summary": "Update a record",
+                "description": "Update a single record on a custom form, identified by its id."
             },
             "parameters": [
                 {

package/docs/releases.md

@@ -2,8 +2,15 @@
 
 ## API 
 
+### 1.49.0 - 04.11.21
+Add attachmentScripts to Worklogs
+
+### 1.48.0 - 03.11.21
+Add parameter SSO_USERNAME_ATTRIBUTE to config.
+
 ### 1.47.0 - 22.10.21
 Add xmlParser to scripts.
+
 See https://www.npmjs.com/package/fast-xml-parser
 
 Add customForms
@@ -13,6 +20,7 @@ Fix known issue: Check for activation Task Phase and activate if reached
 
 ### 1.46.3 - 18.10.21
 Fix issue: Task not activated when phase already active
+
 Known issues: Tasks might get activated early
 
 ### 1.46.2 - 14.10.21
@@ -47,7 +55,9 @@ Allow also "isPublic": "true" instead of "isPublic": true for Ticket Worklogs
 
 ### 1.43.0 - 20.09.21
 Allow bypassCache option in Remedy Adapter
+
 Add support for Task Phasing
+
 Regenrate Task Flow on Task Update
 
 ### 1.42.1 - 09.09.21
@@ -59,7 +69,9 @@ Add IDs to POST Actions for After Execution Scripts
 ### 1.41.4 - 10.08.21
 
 Fix mapping for Ticket Worklogs
+
 Fix mapping for Task Worklogs
+
 Fix issue with sort in Remedy Adapter
 
 ### 1.41.0 - 03.08.21
@@ -78,6 +90,9 @@ e.g.
 
 ## Event Manager
 
+### 1.18.0 - 03.11.21
+Add parameter SSO_USERNAME_ATTRIBUTE to config.
+
 ### 1.17.1 - 01.10.21
 Fix issue: TicketNumber3 added to Event Data
 
@@ -94,6 +109,22 @@ Update Record added to [Remedy Adapter](adapter#remedy).
 The eventmanager will check all outbound webhooks for an event. If one fails, the whole Event will be set to error and the details will be added to the error message.
 
 ## GUI
+### 1.5.5 - 03.11.21
+Add Parameter REACT_APP_OIDC_SCOPE to choose the oicd scope
+
+### 1.5.4 - 03.11.21
+Add Parameter REACT_APP_OIDC_TOKEN to choose the token to use (access_token/id_token)
+
+### 1.5.3 - 03.11.21
+Allow Authorization Flow with PKCE. Added Parameter: REACT_APP_OIDC_RESPONSE_TYPE. 
+Default value is "token id_token". To use Authorization Flow with PKCE you need to set "REACT_APP_OIDC_RESPONSE_TYPE=code"
+
+### 1.5.2 - 03.11.21
+Fix: OIDC Endpoints URL are wrong for some OIDC Providers. Also added parameters for manual endpoint configuration
+
+### 1.5.1 - 22.10.21
+Custom Forms added
+
 
 ### 1.4.18 - 11.08.21
 hovering on fields in mappingtable, destroys values in "new" mapping, in some situations

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@manyos/smileconnect-api",
-  "version": "1.47.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