@manyos/smileconnect-api 1.49.2 → 1.51.0

package/conf/clients.json

@@ -198,7 +198,7 @@
               "script2"
             ],
             "postMapping": [
-              "script2"
+              "script1"
             ]
           },
           "POST": {

package/conf/scripts/script1.js

@@ -1,2 +1 @@
-//requestData.Name = "Horstdidü";
-resolve();
+// requestData.Name = "Horstdidü";

package/controller/customFormController.js

@@ -12,6 +12,15 @@ const mappingUtil = require('../util/mappingUtil');
 
 const ticketCache = new CacheService(process.env.CACHETTL_TICKETS || 1); // Create a new cache service instance
 
+function getIdField(formConfig) {
+    const mapping = formConfig.mapping
+    const idField = Object.keys(mapping).find(key => mapping[key] === 'id');
+    if (!idField) {
+        return '1'
+    }
+    return idField
+}
+
 function getRecords(formConfig, clientConfig, includeString, customOptions, globalScriptParams) {
     let query = '1=1';
     return queryRecords(formConfig, clientConfig, query, null, null, customOptions, includeString, globalScriptParams);
@@ -141,8 +150,9 @@ async function handleRecord(formConfig, record, mapping, clientConfig, includeAr
 }
 
 async function getRecord(formConfig, clientConfig, id, mapping, includeString, globalScriptParams) {
-    const query = `'1'=\"${id}\"`;
-    const returnValue = await queryRecords(formConfig, clientConfig, query, mapping, null, null, includeString, globalScriptParams);
+    const idField = getIdField(formConfig)
+    const query = `'${idField}'=\"${id}\"`;
+    const returnValue = await queryRecords(formConfig, clientConfig, query, mapping, null, {limit:1}, includeString, globalScriptParams);
     const record =  returnValue.data[0];
     return {data: record};
 }
@@ -169,7 +179,9 @@ async function updateRecord(formConfig, clientConfig, id, recordData, globalScri
         await scriptController.runScripts(scripts.postMapping, recordData, clientConfig.clientId, globalScriptParams);
     }
 
-    const update = await arquery.updateEntry(formConfig.formName, id, recordData);
+    const internalId = await getInternalId(formConfig, clientConfig, id)
+
+    const update = await arquery.updateEntry(formConfig.formName, internalId, recordData);
 
     //run afterExecution
     if (scripts && scripts.afterExecution) {
@@ -179,6 +191,16 @@ async function updateRecord(formConfig, clientConfig, id, recordData, globalScri
     return update;
 }
 
+async function getInternalId(formConfig, clientConfig, id) {
+    const idField = getIdField(formConfig)
+    const query = `'${idField}'=\"${id}\"`;
+    const result = await arquery.executeARQuery(formConfig.formName, clientConfig[formConfig.configName].basequery || null, query , '1', {limit:1})
+    if (result && result.data && result.data.length >0) {
+        return Object.values(result.data[0])[0]
+    }
+    throw new Error (`Internal Id for Record ${id} in Form ${formConfig.formName} could not be found`)
+}
+
 function searchRecords(formConfig, clientConfig, searchString, fields, options, includeString, globalScriptParams) {
     const mapping = formConfig.mapping
     const mappedString = searchUtil.applyCustomFormMapping(searchString, mapping);

package/docs/adapter.md

@@ -221,6 +221,66 @@ const resultUpdate = await adapter.remedy.update(settings.form, settings.id, set
 
 Will return return the id of the updated record. e.g. 000000000000115 or throw an error.
 
+### getAttachment
+
+```javascript
+async getAttachment(form, entryId, attachmentFieldId, options)
+```
+
+Parameter:
+
+* form (string):
+
+The form used to where the attachmentField is on
+
+* entryId (string):
+
+The id of the record on which the attachment is on
+
+* attachmentFieldId:
+
+The id of the attachment field
+
+Full example:
+```javascript
+const file = adapter.remedy.getAttachment('CHG:WorkLog', 'CWL000000002484', '1000000353')
+const fileName = file.name
+const fileData = file.data
+```
+
+### setAttachment
+
+```javascript
+async getAttachment(form, entryId, attachmentFieldId, file, options)
+```
+
+Parameter:
+
+* form (string):
+
+The form used to where the attachmentField is on
+
+* entryId (string):
+
+The id of the record on which the attachment is on
+
+* attachmentFieldId:
+
+The id of the attachment field
+
+* file
+
+An Object containing the file
+
+Full example:
+```javascript
+const file = {
+    data: fs.readFileSync('test/files/logo.png'),
+    name: 'logo.png',
+    mimetype: 'image/png'
+};
+await adapter.remedy.setAttachment('CHG:WorkLog', 'CWL000000002484', '1000000353', file)
+```
 
 ### Options
 

package/docs/releases.md

@@ -2,8 +2,14 @@
 
 ## API 
 
+### 1.50.1 - 05.11.21
+Add setAttachment & getAttachment to Remedy Adapter
+
+### 1.50.0 - 05.11.21
+Use custom defined id in customForms
+
 ### 1.49.2 - 05.11.21
-Fix issue: Class specific Attributes not working in CMDBObject create & update
+Fix issue: Custom classAttributes not working in cmdbObjects PUT & POST
 
 ### 1.49.1 - 04.11.21
 Fix issue: Self Mapping in custom Forms removed attribute

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@manyos/smileconnect-api",
-  "version": "1.49.2",
+  "version": "1.51.0",
   "description": "A proxy and abstraction layer for BMCs IT Service Management Suite",
   "main": "app.js",
   "scripts": {
@@ -38,7 +38,7 @@
     "request-promise-native": "^1.0.9",
     "socket.io": "^2.4.1",
     "uuid": "^3.4.0",
-    "vm2": "3.9.3"
+    "vm2": "^3.9.5"
   },
   "devDependencies": {
     "chai": "^4.3.4",

package/test/customFormTest.js

@@ -0,0 +1,111 @@
+const assert = require('chai').assert;
+let chai = require('chai');
+let chaiHttp = require('chai-http');
+let should = chai.should();
+let server = require('../app');
+const TestUtils = require('./testUtils')
+require('dotenv').config();
+
+//Integrations Tests here
+
+chai.use(chaiHttp);
+
+describe('Integration Tests - customForms', function () {
+
+    let authUser = {'id':process.env.TEST_ID, 'secret':process.env.TEST_SECRET};
+
+    before((done) => {
+
+        // Authenticate the user to get a token
+        TestUtils.authenticateUser(authUser, server)
+            .then((accessToken) => {
+                // Keep the token on the user so we can use it in the tests
+                authUser.access_token = accessToken;
+                return done();
+            })
+            .catch((err) => done(err));
+    });
+
+    describe('GET custom Form Data', function () {
+        it ('it should get a spezific record by id', function (done) {
+            chai.request(server)
+                .get('/v1/customForms/persons/rhannemann')
+                .set('Authorization', 'Bearer ' + authUser.access_token)
+                .end(function(err, res) {
+                    res.should.have.status(200);
+                    res.body.data.should.be.an('object');
+                    res.body.data.should.have.property('name');
+                    res.body.data.should.have.property('id');
+                    done();
+                })
+        })
+
+        it ('it should get all customForm records', function (done) {
+            chai.request(server)
+                .get('/v1/customForms/persons?limit=5')
+                .set('Authorization', 'Bearer ' + authUser.access_token)
+                .end(function(err, res) {
+                    res.should.have.status(200);
+                    res.body.data.should.be.an('array');
+                    res.body.data.length.should.be.above(0);
+                    done();
+                })
+        })
+
+        it ('it should search customForms', function (done) {
+            const searchString = `'name' LIKE "Robert Hannemann%"`;
+            chai.request(server)
+                .post('/v1/customForms/persons/search')
+                .set('Authorization', 'Bearer ' + authUser.access_token)
+                .send({searchString})
+                .end(function(err, res) {
+                    res.should.have.status(200);
+                    res.body.data.should.be.an('array');
+                    res.body.data.length.should.be.above(0);
+                    done();
+                })
+        })
+
+        it ('it should update a customForm Record by id', function (done) {
+            const data = {
+                name: 'Robert Hannemann' + new Date()
+            }
+            chai.request(server)
+                .put('/v1/customForms/persons/rhannemann')
+                .set('Authorization', 'Bearer ' + authUser.access_token)
+                .send({data})
+                .end(function(err, res) {
+                    res.should.have.status(200);
+                    res.body.data.should.be.an('object');
+                    res.body.data.should.have.property('name');
+                    res.body.data.should.have.property('id');
+                    res.body.data.name.should.be.equal(data.name)
+                    done();
+                })
+        })
+
+        it ('it should create a customForm Record', function (done) {
+            const data = {
+                "userId": "Demo",
+                "classId": "00001",
+                "Department": "Mux",
+                "classTitle": "Blup",
+                "cost": 55,
+                "location": "Muc",
+                "startDate": "Mon Nov 07 16:00:00 GMT 2005"
+            }
+            chai.request(server)
+                .post('/v1/customForms/enrollments')
+                .set('Authorization', 'Bearer ' + authUser.access_token)
+                .send({data})
+                .end(function(err, res) {
+                    res.should.have.status(200);
+                    res.body.data.should.be.an('object');
+                    res.body.data.should.have.property('location');
+                    res.body.data.should.have.property('id');
+                    res.body.data.location.should.be.equal(data.location)
+                    done();
+                })
+        })
+    })
+})