@manyos/smileconnect-api 1.67.0 → 1.69.0

package/conf/clients.json

@@ -1,139 +1,4 @@
 [
-  {
-    "name": "horsti",
-    "config": {
-      "cmdbobject": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "change": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "changeWorklog": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {},
-        "attachmentScripts": {}
-      },
-      "incident": {
-        "basequery": "1=1",
-        "fields": [
-          "Description"
-        ],
-        "constants": [],
-        "scripts": {}
-      },
-      "incidentWorklog": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {},
-        "attachmentScripts": {}
-      },
-      "person": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "problem": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "problemWorklog": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {},
-        "attachmentScripts": {}
-      },
-      "supportGroup": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "organisation": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "workOrder": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "workOrderWorklog": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {},
-        "attachmentScripts": {}
-      },
-      "task": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "taskWorklog": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {},
-        "attachmentScripts": {}
-      },
-      "flowBuilder": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "changeTemplate": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "incidentTemplate": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "problemTemplate": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "workOrderTemplate": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "taskTemplate": {
-        "basequery": "1=2",
-        "fields": [],
-        "constants": [],
-        "scripts": {}
-      },
-      "options": {
-        "translateSelectionFields": true
-      }
-    }
-  },
   {
     "name": "smileconnectGui",
     "config": {
@@ -2685,5 +2550,140 @@
         "scripts": {}
       }
     }
+  },
+  {
+    "name": "horsti",
+    "config": {
+      "cmdbobject": {
+        "fields": [],
+        "constants": [],
+        "scripts": {},
+        "basequery": ""
+      },
+      "change": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "changeWorklog": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {},
+        "attachmentScripts": {}
+      },
+      "incident": {
+        "basequery": "1=1",
+        "fields": [
+          "Description"
+        ],
+        "constants": [],
+        "scripts": {}
+      },
+      "incidentWorklog": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {},
+        "attachmentScripts": {}
+      },
+      "person": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "problem": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "problemWorklog": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {},
+        "attachmentScripts": {}
+      },
+      "supportGroup": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "organisation": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "workOrder": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "workOrderWorklog": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {},
+        "attachmentScripts": {}
+      },
+      "task": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "taskWorklog": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {},
+        "attachmentScripts": {}
+      },
+      "flowBuilder": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "changeTemplate": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "incidentTemplate": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "problemTemplate": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "workOrderTemplate": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "taskTemplate": {
+        "basequery": "1=2",
+        "fields": [],
+        "constants": [],
+        "scripts": {}
+      },
+      "options": {
+        "translateSelectionFields": true
+      }
+    }
   }
 ]

package/docs/configuration/config.md

@@ -208,6 +208,13 @@ Sample:
 
 *MAX_HTTP_SOCKETS=15*
 
+### DOC_SERVERS
+
+Array of Servers in JSON Format, that are used in the generated openapi specification.
+
+Sample:
+
+*DOC_SERVERS=[{"url":"https://smileconnect-dev.xyz.com", "description":"dev"}, {"url":"https://smileconnect.xyz.com", "description":"prod"}]*
 
 # Event Manager
 

package/docs/releases.md

@@ -1,8 +1,11 @@
 # Release Notes
 
 ## API
+### 1.68.0 - 23.04.24
+Add configurable server names to openapi documentation
+
 ### 1.67.0 - 09.04.24
-Add crypto to scripts
+Add crypto & jsonweboken to scripts
 
 ### 1.65.2 - 01.03.24
 Add foundation data to dynamic api spec
@@ -204,6 +207,15 @@ e.g.
 */v1/incidents?impersonateUser=abc123
 
 ## Event Manager
+### 1.35.0 - 29.04.24
+Add attachment support for outbound mappings
+
+### 1.34.0 - 26.04.24
+Add outbound(custom payload) mapping to webhooks
+
+### 1.33.0 - 10.04.24
+Add crypto & jsonweboken to scripts
+
 ### 1.31.0 - 18.07.23
 Introduce advanced logging for events. Each event log record will contain details about the associated event. (e.g. Event Id, Ticketnumber, etc.)
 

package/docs/scripts.md

@@ -286,6 +286,45 @@ Allows custom headers in outbound events.
 customHeaders['X-API-GATEWAYUSER'] = 'gatewayuser1';
 ```
 
+## customPayload
+
+Allows custom payload in outbound events.
+
+Options:
+* body
+  Allows a custom body to be sent.
+* contentType
+  Content Type to sent. Defaults to application/json
+* method
+  Method to be used. Defaults to POST. Possible Values are POST, PUT, GET, PATCH, DELETE 
+* agent
+  Can be used to apply dynamic proxy settings.
+
+```javascript
+const retrunValue = await adapter.smileconnect.getTicket('incidents', 'INC000000004601');
+customData.incident = retrunValue.data;
+
+customPayload.body = `{
+   "vendorTicketId" :"{{customData.incident.id}}",
+   "lastUser": "{{customData.incident.lastModifiedBy}}",
+   "shortText": "{{customData.incident.summary}}"
+}`;
+
+//Optional Change of Content Type - defaults to application/json
+customPayload.contentType = "text/plain";
+
+//Optional Change of method. Defaults to POST
+customPayload.method = 'PUT';
+```
+
+The body field will be rendered with moustache template engine. The following variables can be accessed to dynamically replace values:
+* requestData 
+* params 
+* clientId 
+* customData
+
+[See also](https://manyos.it/blog/2024/4/26/new-feature-update-for-smileconnect-enhanced-customization-of-webhook-requests)
+
 # Returning values
 
 Values can be returned with the function *resolve()*

package/package.json

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

package/util/config.js

@@ -1,5 +1,6 @@
 const fs = require('fs');
 const fsPromises = require('fs').promises;
+require('dotenv').config();
 
 const path = require('path');
 const log = require('@manyos/logger').setupLog('SMILEconnect', path.basename(__filename));
@@ -158,6 +159,7 @@ function getConstants(objectType) {
 }
 
 function checkMapping() {
+    let updateRequired = false;
     log.info('check mapping');
     const mappingDefs = [
         'cmdbobject',
@@ -187,43 +189,60 @@ function checkMapping() {
     ];
     const mappings = getMappings() || {};
     const mappingKeys = Object.keys(mappings);
+    log.info(`check ${mappingKeys.length} mappings`);
     //delete too many
     mappingKeys.forEach(key=>{
         if (!mappingDefs.includes(key) && !key.startsWith('cmdbobject_') && !key.startsWith('custom_')) {
-            log.info('delete from mapping', key);
+            log.warn('delete from mapping', key);
             delete mappings[key];
+            updateRequired = true;
         }
     });
     //add too less
     mappingDefs.forEach(mappingDef => {
         if (!mappingKeys.includes(mappingDef)) {
-            log.info('add to mapping', mappingDef);
+            log.warn('add to mapping', mappingDef);
             mappings[mappingDef] = [];
+            updateRequired = true;
         }
     });
     //save
-    setMappings(mappings);
-    log.info('check mapping done');
+    if (updateRequired === true) {
+        log.warn('check mapping done. Mappings update required. New mappings', mappings);
+        setMappings(mappings);
+        log.warn('check mapping done. Mappings updated.');
+    } else {
+        log.info('check mapping done. No update required.');
+    }
 }
 
 async function checkCustomFormMapping() {
     log.info('check customForm mapping');
     const mappings = await getCustomFormMapping();
     const mappingAliases = Object.keys(mappings)
+    log.info(`${mappingAliases.length} customForm mappings found.`);
+    let configUpdateRequired = false;
     mappingAliases.forEach(mappingAlias => {
         const mappingDef = mappings[mappingAlias]
-        log.debug('check', mappingDef)
+        log.info('check customForm Mapping', mappingDef)
         if (!mappingDef.formName || !mappingDef.mapping) {
-            log.error('Remove wrong custom Form mapping', mappingDef)
-            delete mappings[mappingAlias]
+            log.error('Remove wrong custom Form mapping', mappingDef);
+            delete mappings[mappingAlias];
+            configUpdateRequired = true;
         }
     })
     // save
-    await setCustomFormMapping(mappings);
-    log.info('check customForm mapping done');
+    if (configUpdateRequired === true) {
+        log.warn('Config update required for customFormMapping. New config', mappings);
+        await setCustomFormMapping(mappings);
+        log.info('check customForm mapping done. customFormMapping updated.');
+    } else {
+        log.info('check customForm mapping done. No update required.');
+    }
 }
 
 function checkClientConfig(client) {
+    let updateRequired = false;
     const clientKeys = [
         'cmdbobject',
         'change',
@@ -252,28 +271,34 @@ function checkClientConfig(client) {
     //delete too many
     clientConfigKeys.forEach(key=>{
         if (!clientKeys.includes(key) && !(key === 'options') && !(key.startsWith('custom_'))) {
-            log.info('delete from clientconfig', key);
+            log.warn('delete from clientconfig', key);
             delete clientConfig[key];
+            updateRequired = true;
         } else if (clientKeys.includes(key) && !(key === 'options')) {
-            if (!clientConfig[key].basequery) {
+            if (!(typeof clientConfig[key].basequery === 'string')) {
                 clientConfig[key].basequery = '';
-                log.info('add basequery', key);
+                log.warn('add basequery', key);
+                updateRequired = true;
             }
             if (!clientConfig[key].fields) {
                 clientConfig[key].fields = [];
-                log.info('add fields', key);
+                log.warn('add fields', key);
+                updateRequired = true;
             }
             if (!clientConfig[key].constants) {
                 clientConfig[key].constants = [];
-                log.info('add constants', key);
+                log.warn('add constants', key);
+                updateRequired = true;
             }
             if (!clientConfig[key].scripts) {
                 clientConfig[key].scripts = {};
-                log.info('add scripts', key);
+                log.warn('add scripts', key);
+                updateRequired = true;
             }
             if (key.endsWith('Worklog') && !clientConfig[key].attachmentScripts) {
                 clientConfig[key].attachmentScripts = {};
-                log.info('add attachmentScripts', key);
+                log.warn('add attachmentScripts', key);
+                updateRequired = true;
             }
         }
     });
@@ -281,22 +306,29 @@ function checkClientConfig(client) {
     clientKeys.forEach(clientKey => {
         if (!clientConfigKeys.includes(clientKey)) {
             log.info('add to mapping', clientKey);
+            updateRequired = true;
             clientConfig[clientKey] = clientConfigItemTemplate;
         }
     });
 
     if (!clientConfig.options) {
         clientConfig.options = {};
+        updateRequired = true;
     }
 
     if (clientConfig.options.translateSelectionFields === undefined) {
         clientConfig.options.translateSelectionFields = true;
+        updateRequired = true;
     }
 
-    client.config = clientConfig;
-    //save
-    setClient(client.name, client);
-    log.info('check config for client done', client.name);
+    if (updateRequired === true) {
+        log.warn(`check config for client ${client.name} done. Update required.`);
+        client.config = clientConfig;
+        //save
+        setClient(client.name, client);
+        log.warn(`check config for client ${client.name} done. Update done.`);
+    }
+    log.info(`check config for client ${client.name} done. No update required.`);
 }
 
 function checkClientConfigs() {
@@ -326,16 +358,19 @@ async function getDesignPackage(clientId) {
         },
         termsOfService: 'https://manyos.it'
     }
-    const servers = [
-        {
-            url: "https://url123",
-            description: "dev"
-        },
-        {
-            url: "https://url12345",
-            description: "prod"
+    let servers = []
+
+    if (process.env.DOC_SERVERS) {
+        try {
+            const doc_servers = JSON.parse(process.env.DOC_SERVERS);
+            if (doc_servers && Array.isArray(doc_servers)) {
+                servers = doc_servers;
+            }
+        } catch (error) {
+            log.error("Can't read server for openapi docs.", error);
         }
-    ]
+    }
+
     const clientConfig = await getClientConfig(clientId)
     const schemas = {}
     let paths = {}
@@ -621,8 +656,7 @@ function getFields(form) {
     log.debug('get fields for', form);
     const key = 'fields/' + form;
     return configCache.get(key, async function () {
-        const result = await arquery.getMetaData(form);
-        return result;
+        return await arquery.getMetaData(form);
     });
 }
 

package/CHANGELOG.md

@@ -1,75 +0,0 @@
-# CHANGELOG
-
-This file lists all non-trivial changes to Beautiful Jekyll.
-
-I often make small changes to documentation, to the demo site, or to the general look-and-feel. These changes will not be listed here. Any other minor changes will also not be listed here.
-
-**2018-12-24** Add support for Staticman comments (#440) (thanks @VincentTam)
-
-**2018-10-19** Move Google Analytics to the head (#419) (thanks @jpvicari)
-
-**2018-06-08** Add support for Facebook comments (#350) (thanks @npes87184)
-
-**2018-02-22** Automatically generate sitemap (#323) (thanks @JosemyDuarte)
-
-**2018-01-18** Add clickable tags to each post and a tags index page, works for GitHub sites (#307) (thanks @OCram85)
-
-**2018-01-14** Redo Dockerfile (#302) (thanks @jennydaman)
-
-**2018-01-06** More color personalization options (#297 and #299) (thanks @jennydaman)
-
-**2018-01-05** Abstract the social networks logic (thanks @OCram85)
-
-**2018-01-03** Avatar image no longer causes a ghost click (thanks @alefi87)
-
-**2017-10-16** Add GitHub buttons to posts (#265) (thanks @yonicd)
-
-**2017-09-04** Ability to change colour/image of navbar/footer/body
-
-**2017-08-17** Add support for notification, error, and warning boxes in markdown (#227) (thanks @OCram85)
-
-**2017-08-12** Add social buttons for twitch, yelp, and steam (#234) (thanks @TheRealBenForce)
-
-**2017-03-30** Make the footer contact links friendly for screen readers (thanks @eugenius1)
-
-**2017-03-30** Started a CHANGELOG file (thanks @eugenius1)
-
-**2017-01-28** Add Subresource Integrity (SRI) support (#164) (thanks @tony-ho)
-
-**2017-01-09** Add Google Tag Manager Integration (#157) (thanks @csarigoz)
-
-**2017-01-06** Add options to configure HTML document title (#154) (thanks @tony-ho)
-
-**2016-12-25** Allow dynamic images on each blog post (#143) (thanks @bbritten)
-
-**2016-12-15** Support `title-img` config param to have image in the navbar instead of text
-
-**2016-12-08** Add support for phone numbers in footer; fix #136
-
-**2016-12-06** Update gemfile (#134) (thanks @stephentuso)
-
-**2016-10-09** Add Docker deployment (#114) (thanks @mangar)
-
-**2016-08-06** Add social share buttons for posts (thanks @rtlee9)
-
-**2016-07-29** Add CSS styling to code chunks
-
-**2016-07-27** Add clickable tags that lead to a tag page (doesn't work for GitHub hosted sites) (thanks @epwalsh)
-
-**2016-07-21** Add support for twitter cards (sharing on Twitter will be better); fixes #70
-
-**2016-03-18** Support full-width images in page headers; fixes #37
-
-**2016-03-18** Support menus in navigation bar
-
-**2016-02-07** Avatar is now conditional (thanks @hristoyankov)
-
-**2016-02-02** Migrate (forced to...) to jekyll 3
-
-**2016-01-22** Make sure not to include JQuery twice, fixes #29
-
-**2015-11-19** Support external links in navigation bar; fixes #3
-
-... Many small changes because the site was in its infancy
-
-**2015-03-12** Beautiful Jekyll version 0.0000001 is released!