@yousolution/node-red-contrib-you-sap-service-layer 0.1.1 → 0.2.1

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file.
 
+# [0.2.0] - 2024-06-19
+
+> *Warning Breaking Change!* please make backups of flows and try in test environment before upgrading
+
+- We have improved the management of login token expiration
+- We have updated the manage dynamic login on AUTH Request
+- We have updated the result handling in PATCH request
+- We have resolved an error send Entry on UDT PATCH request
+- We have updated the result handling in SERVICE request
+- We have updated the error parsing function
+- We Add Service "OrdersService_Preview" on SERVICE
+- Bug Fix
+- Library Axios & Odata Updated
+
 # [0.1.1] - 2022-12-09
 
 - Added label output to nextLink block

package/docker-compose.yml

@@ -2,7 +2,7 @@ version: '3.7'
 
 services:
   nodered:
-    image: nodered/node-red:2.0.6-12
+    image: nodered/node-red:3.1.0
     # network_mode: host
     extra_hosts:
       - "api.yousolution.local:192.168.1.100"

package/nodes/SQLQuery.js

@@ -1,6 +1,7 @@
 process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
 const axios = require('axios');
 const Support = require('./support');
+const { VerifyErrorSL } = require('./manageErrors');
 
 module.exports = function (RED) {
   function SQLQuery(config) {
@@ -28,11 +29,13 @@ module.exports = function (RED) {
         const options = { method: 'POST', hasRawQuery: false, isSQLQuery: true, data: data };
         const login = Support.login;
         const result = await Support.sendRequest({ node, msg, config, axios, login, options });
-        msg.payload = result.data;
+        msg.payload = VerifyErrorSL(node, msg, result.data);//result.data;
         msg.nextLink = result.data['odata.nextLink'] || result.data['@odata.nextLink'];
         msg.statusCode = result.status;
-        node.status({ fill: 'green', shape: 'dot', text: 'success' });
-        node.send(msg);
+        if(msg.payload) {
+          node.status({ fill: 'green', shape: 'dot', text: 'success' });
+          node.send(msg);
+        }
       } catch (error) {
         node.status({ fill: 'red', shape: 'dot', text: 'Error' });
         done(error);

package/nodes/authenticateSap.js

@@ -22,15 +22,32 @@ module.exports = function (RED) {
       },
     });
 
-    if (!node.credentials.user || !node.credentials.password || !node.credentials.company) {
+    if (!node.credentials.user || !node.credentials.company) {
       node.status({ fill: 'gray', shape: 'ring', text: 'Missing credentials' });
     }
 
     node.on('input', async (msg, send, done) => {
+
+      if(!node.credentials.password && !msg.password){
+        node.status({ fill: 'gray', shape: 'ring', text: 'Missing credentials Password Code' });
+      }
+
+      if(msg.password){
+        globalContext.set(`_YOU_SapServiceLayer_${node.id}.credentials.Password`, msg.password);
+        //node.status({ fill: 'gray', shape: 'ring', text: 'Missing credentials Password Code' });
+      }
+      
       // If Company setted from msg
       if (node.credentials.companyType == 'msg') {
         const company = msg[node.credentials.company];
+        let currentCompany = globalContext.get(`_YOU_SapServiceLayer_${node.id}.credentials.CompanyDB`);
+
+        if(company !== currentCompany) {
+          globalContext.set(`_YOU_SapServiceLayer_${node.id}.headers`, null);
+        }
+
         globalContext.set(`_YOU_SapServiceLayer_${node.id}.credentials.CompanyDB`, company);
+
       }
 
       // If User setted from msg
@@ -42,36 +59,62 @@ module.exports = function (RED) {
       // reset status
       node.status({});
 
-      if (!node.credentials.user || !node.credentials.password || !node.credentials.company) {
+      if (!node.credentials.user || !node.credentials.company) {
         node.status({ fill: 'red', shape: 'dot', text: 'Missing credentials' });
         done(new Error('Missing credentials'));
         return;
       }
 
+      let currentDate = new Date();
       const headers = globalContext.get(`_YOU_SapServiceLayer_${node.id}.headers`);
+      const exipiredTime = globalContext.get(`_YOU_SapServiceLayer_${node.id}.exp`);
+      let validToken = true;
 
       msg._YOU_SapServiceLayer = {
         idAuth: node.id,
       };
 
-      if (!headers) {
+      if(headers && exipiredTime) {
+        let providedDate = new Date(exipiredTime);
+        let timeDifference = currentDate - providedDate;
+        let minutesDifference = timeDifference / (1000 * 60);
+        validToken = minutesDifference > 25 ? false : true;
+      }
+
+
+      if (!headers  || !validToken) {
         try {
           const result = await Support.login(node, node.id);
-          globalContext.set(`_YOU_SapServiceLayer_${node.id}.headers`, result.headers['set-cookie']);
+          if(result.data.hasOwnProperty("error")) {
+            node.error( result.data.error , msg);
+            node.status({ fill: 'red', shape: 'dot', text: 'disconnected' });
+          }
+          else {
+            globalContext.set(`_YOU_SapServiceLayer_${node.id}.headers`, result.headers['set-cookie']);
+            globalContext.set(`_YOU_SapServiceLayer_${node.id}.exp`, currentDate.toISOString());
+            node.send(msg);
+            node.status({ fill: 'green', shape: 'dot', text: 'connected' });
+          }
+          // globalContext.set(`_YOU_SapServiceLayer_${node.id}.headers`, result.headers['set-cookie']);
+          // globalContext.set(`_YOU_SapServiceLayer_${node.id}.exp`, currentDate.toISOString());
         } catch (error) {
           msg.payload = error;
           if (error.response && error.response.data) {
             msg.statusCode = error.response.status;
             msg.payload = error.response.data;
           }
-          node.send(msg);
+          node.error( error , msg);
+          //node.send(msg);
           node.status({ fill: 'red', shape: 'dot', text: 'disconnected' });
           done(error);
-          return;
+          //return;
         }
       }
-      node.send(msg);
-      node.status({ fill: 'green', shape: 'dot', text: 'connected' });
+      else {
+        node.send(msg);
+        node.status({ fill: 'green', shape: 'dot', text: 'connected' });
+      }
+
     });
   }
   RED.nodes.registerType('authenticateSap', AuthenticateSapNode, {

package/nodes/closeSap.js

@@ -1,6 +1,8 @@
 process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
 const axios = require('axios');
 const Support = require('./support');
+const { VerifyErrorSL } = require('./manageErrors');
+
 
 module.exports = function (RED) {
   function CloseSapNode(config) {
@@ -18,10 +20,12 @@ module.exports = function (RED) {
         const options = { method: 'POST', hasRawQuery: false, hasEntityId: true, isClose: true };
         const login = Support.login;
         const result = await Support.sendRequest({ node, msg, config, axios, login, options });
-        msg.payload = result.data;
+        msg.payload = VerifyErrorSL(node, msg, result.data);// result.data;
         msg.statusCode = result.status;
-        node.status({ fill: 'green', shape: 'dot', text: 'success' });
-        node.send(msg);
+        if(msg.payload) {
+          node.status({ fill: 'green', shape: 'dot', text: 'success' });
+          node.send(msg);
+        }
       } catch (error) {
         node.status({ fill: 'red', shape: 'dot', text: 'Error' });
         done(error);

package/nodes/createSQLQuery.js

@@ -1,6 +1,7 @@
 process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
 const axios = require('axios');
 const Support = require('./support');
+const { VerifyErrorSL } = require('./manageErrors');
 
 module.exports = function (RED) {
   function CreateSQLQuery(config) {
@@ -53,10 +54,12 @@ module.exports = function (RED) {
         const options = { method: 'POST', hasRawQuery: false, isCreateSQLQuery: true, data: data };
         const login = Support.login;
         const result = await Support.sendRequest({ node, msg, config, axios, login, options });
-        msg.payload = result;
+        msg.payload = VerifyErrorSL(node, msg, result.data);//result.data;
         msg.statusCode = result.status;
-        node.status({ fill: 'green', shape: 'dot', text: 'success' });
-        node.send(msg);
+        if(msg.payload) {
+          node.status({ fill: 'green', shape: 'dot', text: 'success' });
+          node.send(msg);
+        }
       } catch (error) {
         node.status({ fill: 'red', shape: 'dot', text: 'Error' });
         done(error);

package/nodes/createSap.js

@@ -1,6 +1,7 @@
 process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
 const axios = require('axios');
 const Support = require('./support');
+const { VerifyErrorSL } = require('./manageErrors');
 
 module.exports = function (RED) {
   function CreateSapNode(config) {
@@ -22,13 +23,16 @@ module.exports = function (RED) {
         const options = { method: 'POST', hasRawQuery: false, data: data };
         const login = Support.login;
         const result = await Support.sendRequest({ node, msg, config, axios, login, options });
-        msg.payload = result;
+        msg.payload =VerifyErrorSL(node, msg, result.data);// result.data;
         msg.statusCode = result.status;
-        node.status({ fill: 'green', shape: 'dot', text: 'success' });
-        node.send(msg);
+        if(msg.payload) {
+          node.status({ fill: 'green', shape: 'dot', text: 'success' });
+          node.send(msg);
+        }
       } catch (error) {
         node.status({ fill: 'red', shape: 'dot', text: 'Error' });
-        done(error);
+        //node.error(error, msg);
+       // done(error);
       }
     });
   }

package/nodes/crossJoinSap.js

@@ -1,6 +1,7 @@
 process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
 const axios = require('axios');
 const Support = require('./support');
+const { VerifyErrorSL } = require('./manageErrors');
 // const buildQuery = require('odata-query').default;
 
 module.exports = function (RED) {
@@ -19,11 +20,13 @@ module.exports = function (RED) {
         const options = { method: 'GET', hasRawQuery: true, hasEntityId: false, isCrossJoin: true };
         const login = Support.login;
         const result = await Support.sendRequest({ node, msg, config, axios, login, options });
-        msg.payload = result.data;
+        msg.payload = VerifyErrorSL(node, msg, result.data);// result.data;
         msg.statusCode = result.status;
         msg.nextLink = result.data['odata.nextLink'] || result.data['@odata.nextLink'];
-        node.status({ fill: 'green', shape: 'dot', text: 'success' });
-        node.send(msg);
+        if(msg.payload) {
+          node.status({ fill: 'green', shape: 'dot', text: 'success' });
+          node.send(msg);
+        }
       } catch (error) {
         node.status({ fill: 'red', shape: 'dot', text: 'Error' });
         done(error);

package/nodes/deleteSap.js

@@ -1,6 +1,7 @@
 process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
 const axios = require('axios');
 const Support = require('./support');
+const { VerifyErrorSL } = require('./manageErrors');
 
 module.exports = function (RED) {
   function DeleteSapNode(config) {
@@ -18,10 +19,12 @@ module.exports = function (RED) {
         const options = { method: 'DELETE', hasRawQuery: true, hasEntityId: true, data: {} };
         const login = Support.login;
         const result = await Support.sendRequest({ node, msg, config, axios, login, options });
-        msg.payload = result.data;
+        msg.payload = VerifyErrorSL(node, msg, result.data, true );// result.data;
         msg.statusCode = result.status;
-        node.status({ fill: 'green', shape: 'dot', text: 'success' });
-        node.send(msg);
+        if(msg.payload) {
+          node.status({ fill: 'green', shape: 'dot', text: 'success' });
+          node.send(msg);
+        }
       } catch (error) {
         node.status({ fill: 'red', shape: 'dot', text: 'Error' });
         done(error);

package/nodes/getSap.js

@@ -1,6 +1,7 @@
 process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
 const axios = require('axios');
 const Support = require('./support');
+const { VerifyErrorSL } = require('./manageErrors');
 // const buildQuery = require('odata-query').default;
 
 module.exports = function (RED) {
@@ -17,10 +18,12 @@ module.exports = function (RED) {
         const options = { method: 'GET', hasRawQuery: true, hasEntityId: true };
         const login = Support.login;
         const result = await Support.sendRequest({ node, msg, config, axios, login, options });
-        msg.payload = result.data;
+        msg.payload = VerifyErrorSL(node, msg, result.data);//result.data;
         msg.statusCode = result.status;
-        node.status({ fill: 'green', shape: 'dot', text: 'success' });
-        node.send(msg);
+        if(msg.payload) {
+          node.status({ fill: 'green', shape: 'dot', text: 'success' });
+          node.send(msg);
+        }
       } catch (error) {
         node.status({ fill: 'red', shape: 'dot', text: 'Error' });
         done(error);

package/nodes/listSap.js

@@ -2,6 +2,7 @@ process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
 const axios = require('axios');
 const Support = require('./support');
 const buildQuery = require('odata-query').default;
+const { VerifyErrorSL } = require('./manageErrors');
 
 module.exports = function (RED) {
   function ListSapNode(config) {
@@ -19,11 +20,13 @@ module.exports = function (RED) {
         const options = { method: 'GET', hasRawQuery: true };
         const login = Support.login;
         const result = await Support.sendRequest({ node, msg, config, axios, login, options });
-        msg.payload = result.data;
+        msg.payload = VerifyErrorSL(node, msg, result.data);//result.data;
         msg.nextLink = result.data['odata.nextLink'] || result.data['@odata.nextLink'];
         msg.statusCode = result.status;
-        node.status({ fill: 'green', shape: 'dot', text: 'success' });
-        node.send(msg);
+        if(msg.payload) {
+          node.status({ fill: 'green', shape: 'dot', text: 'success' });
+          node.send(msg);
+        }
       } catch (error) {
         node.status({ fill: 'red', shape: 'dot', text: 'Error' });
         done(error);

package/nodes/manageErrors.js

@@ -0,0 +1,39 @@
+
+function VerifyErrorSL (node, msg, response, consentEmpty=false) {
+    if (!response.hasOwnProperty("success") && !response.hasOwnProperty("error") && !Object.keys(response).length && !consentEmpty) {  // Error Generic
+        msg.payload = response;
+        node.error('Not Valid Requests', msg)
+        node.status({ fill: 'red', shape: 'dot', text: 'Not Valid  Requests' });
+    }
+    else if(response.hasOwnProperty("error")){ //Error ServiceLayer
+        if(response.error.hasOwnProperty('message')){
+            if(response.error.message.hasOwnProperty('value')) {
+                msg.payload = response;
+                node.error(response.error.message.value, msg)
+                node.status({ fill: 'red', shape: 'dot', text: response.error.message.value });
+            }
+            else {
+                msg.payload = response;
+                node.error(response.error.message , msg)
+                node.status({ fill: 'red', shape: 'dot', text: response.error.message });
+            }
+        }
+        else {
+            msg.payload = response;
+            node.error(response.reason , msg)
+            node.status({ fill: 'red', shape: 'dot', text: JSON.stringify(response) });
+        }
+
+    }
+    else { // OK Response 
+        return response;
+    }
+
+
+}
+ 
+
+
+module.exports = {
+    VerifyErrorSL: VerifyErrorSL,
+};

package/nodes/manipulateEntitySap.js

@@ -2,6 +2,7 @@ process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
 const axios = require('axios');
 const Support = require('./support');
 const entities = require('../resources/entities.json');
+const { VerifyErrorSL } = require('./manageErrors');
 
 module.exports = function (RED) {
   function ManipulateEntitySap(config) {
@@ -24,10 +25,12 @@ module.exports = function (RED) {
         const options = { method: 'POST', hasRawQuery: false, hasEntityId: true, isManipulate: true, data: data };
         const login = Support.login;
         const result = await Support.sendRequest({ node, msg, config, axios, login, options });
-        msg.payload = result.data;
+        msg.payload = VerifyErrorSL(node, msg, result.data);//result.data;
         msg.statusCode = result.status;
-        node.status({ fill: 'green', shape: 'dot', text: 'success' });
-        node.send(msg);
+        if(msg.payload) {
+          node.status({ fill: 'green', shape: 'dot', text: 'success' });
+          node.send(msg);
+        }
       } catch (error) {
         node.status({ fill: 'red', shape: 'dot', text: 'Error' });
         done(error);

package/nodes/patchSap.html

@@ -339,12 +339,12 @@
     </select>
   </div>
 
-  <div class="form-row" style="display:none" id="container-UDO">
+  <div class="form-row" style="display:none" id="container-udo">
     <label for="node-input-udo"><i class="fa fa-tag"></i> UDO</label>
     <input type="text" id="node-input-udo" placeholder="UDO Name">
   </div>
 
-  <div class="form-row" style="display:none" id="container-UDT">
+  <div class="form-row" style="display:none" id="container-udt">
     <label for="node-input-udt"><i class="fa fa-tag"></i> UDT</label>
     <input type="text" id="node-input-udt" placeholder="UDT Name">
   </div>

package/nodes/patchSap.js

@@ -1,6 +1,7 @@
 process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
 const axios = require('axios');
 const Support = require('./support');
+const { VerifyErrorSL } = require('./manageErrors');
 
 module.exports = function (RED) {
   function PatchSapNode(config) {
@@ -23,10 +24,12 @@ module.exports = function (RED) {
         const options = { method: 'PATCH', hasRawQuery: false, hasEntityId: true, data: data };
         const login = Support.login;
         const result = await Support.sendRequest({ node, msg, config, axios, login, options });
-        msg.payload = result.data;
+        msg.payload = VerifyErrorSL(node, msg, result.data, true);//result.data;
         msg.statusCode = result.status;
-        node.status({ fill: 'green', shape: 'dot', text: 'success' });
-        node.send(msg);
+        if(msg.payload) {
+          node.status({ fill: 'green', shape: 'dot', text: 'success' });
+          node.send(msg);
+        }
       } catch (error) {
         node.status({ fill: 'red', shape: 'dot', text: 'Error' });
         done(error);

package/nodes/serviceSap.js

@@ -1,6 +1,7 @@
 process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
 const axios = require('axios');
 const Support = require('./support');
+const { VerifyErrorSL } = require('./manageErrors');
 const services = require('../resources/services.json');
 
 module.exports = function (RED) {
@@ -23,10 +24,12 @@ module.exports = function (RED) {
         const options = { method: 'POST', hasRawQuery: false, isService: true, data: data };
         const login = Support.login;
         const result = await Support.sendRequest({ node, msg, config, axios, login, options });
-        msg.payload = result;
+        msg.payload = VerifyErrorSL(node, msg, result.data);//result.data;
         msg.statusCode = result.status;
-        node.status({ fill: 'green', shape: 'dot', text: 'success' });
-        node.send(msg);
+        if(msg.payload) {
+          node.status({ fill: 'green', shape: 'dot', text: 'success' });
+          node.send(msg);
+        }
       } catch (error) {
         node.status({ fill: 'red', shape: 'dot', text: 'Error' });
         done(error);

package/nodes/support.js

@@ -7,6 +7,7 @@ const thickIdApi = [
   'AssetClasses',
   'AssetDepreciationGroups',
   'AssetGroups',
+  'AlternateCatNum',
   'BankChargesAllocationCodes',
   'BusinessPartners',
   'CampaignResponseType',
@@ -83,12 +84,7 @@ async function login(node, idAuth) {
       'Content-Length': dataString.length,
     },
   };
-
-  // try {
   return await axiosLibrary(options);
-  // } catch (error) {
-  //   throw Error(`ERROR FUNCTION LOGIN: ${error}`);
-  // }
 }
 
 async function sendRequest({ node, msg, config, axios, login, options }) {
@@ -124,10 +120,13 @@ async function sendRequest({ node, msg, config, axios, login, options }) {
           msg.statusCode = error.response.status;
           msg.payload = error.response.data;
           msg.requestUrl = requestOptions.axiosOptions.url;
-          node.send(msg);
-          throw new Error(JSON.stringify(error.response.data));
+          //node.send(msg);
+          node.error(JSON.stringify(error.response.data), msg);
+          //throw new Error(JSON.stringify(error.response.data));
+        }
+        else {
+          throw error;
         }
-        throw error;
       }
       // }
     }
@@ -135,10 +134,14 @@ async function sendRequest({ node, msg, config, axios, login, options }) {
       msg.statusCode = error.response.status;
       msg.payload = error.response.data;
       msg.requestUrl = requestOptions.axiosOptions.url;
-      node.send(msg);
-      throw new Error(JSON.stringify(error.response.data));
+      //node.send(msg);
+      node.error(JSON.stringify(error.response.data), msg)
+     // throw new Error(JSON.stringify(error.response.data));
+    }
+    else {
+      throw error;
     }
-    throw error;
+
   }
 }
 
@@ -252,7 +255,13 @@ function generateRequest(node, msg, config, options) {
     }
 
     if (thickIdApi.includes(entity) || config.entity === 'UDT') {
-      url = `https://${host}:${port}/b1s/${version}/${entity}('${entityId}')`;
+      if(Number.isInteger(entityId)){
+        url = `https://${host}:${port}/b1s/${version}/${entity}(${entityId})`;
+      }
+      else {
+        url = `https://${host}:${port}/b1s/${version}/${entity}('${entityId}')`;
+      }
+      
     } else {
       url = `https://${host}:${port}/b1s/${version}/${entity}(${entityId})`;
     }

package/package.json

@@ -1,10 +1,13 @@
 {
   "name": "@yousolution/node-red-contrib-you-sap-service-layer",
-  "version": "0.1.1",
+  "version": "0.2.1",
   "description": "Unofficial module SAP Service Layer for NODE-RED",
   "license": "MIT",
   "scripts": {
-    "update": "npm pack && mv yousolution-node-red-contrib-you-sap-service-layer-$npm_package_version.tgz ./data && cd data && npm i yousolution-node-red-contrib-you-sap-service-layer-$npm_package_version.tgz && docker-compose restart",
+    "update": "run-script-os",
+    "update:linux:darwin": "npm pack && mv yousolution-node-red-contrib-you-sap-service-layer-$npm_package_version.tgz ./data && cd data && npm i yousolution-node-red-contrib-you-sap-service-layer-$npm_package_version.tgz && docker-compose restart",
+    "update:win32": "npm pack && copy yousolution-node-red-contrib-you-sap-service-layer-%npm_package_version%.tgz .\\data\\ && cd .\\data\\ && npm i yousolution-node-red-contrib-you-sap-service-layer-%npm_package_version%.tgz && docker-compose restart",
+    "update:default": "npm pack && mv yousolution-node-red-contrib-you-sap-service-layer-$npm_package_version.tgz ./data && cd data && npm i yousolution-node-red-contrib-you-sap-service-layer-$npm_package_version.tgz && docker-compose restart",
     "test": "mocha 'test/**/*.spec.js'",
     "coverage": "nyc npm run test"
   },
@@ -37,8 +40,8 @@
     }
   },
   "dependencies": {
-    "axios": "^0.23.0",
-    "odata-query": "^6.7.1"
+    "axios": "^1.2.2",
+    "odata-query": "^7.0.4"
   },
   "repository": {
     "type": "git",
@@ -56,6 +59,7 @@
     "node-red": "^2.1.4",
     "node-red-node-test-helper": "^0.2.7",
     "nyc": "^15.1.0",
+    "run-script-os": "^1.1.6",
     "sinon": "^12.0.1"
   }
 }

package/resources/services.json

@@ -200,7 +200,7 @@
   "NFModelsService": ["NFModelsService_GetList"],
   "NFTaxCategoriesService": ["NFTaxCategoriesService_GetList"],
   "OccurrenceCodesService": ["OccurrenceCodesService_GetList"],
-  "OrdersService": ["OrdersService_GetApprovalTemplates", "OrdersService_HandleApprovalRequest"],
+  "OrdersService": ["OrdersService_GetApprovalTemplates", "OrdersService_Preview" ,"OrdersService_HandleApprovalRequest"],
   "PartnersSetupsService": ["PartnersSetupsService_GetList"],
   "PaymentBlocksService": ["PaymentBlocksService_GetPaymentBlockList"],
   "PaymentCalculationService": ["PaymentCalculationService_GetPaymentAmount"],