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

package/.prettierrc

@@ -0,0 +1,6 @@
+{
+  "singleQuote": true,
+  "useTabs":false,
+  "tabWidth": 2,
+  "printWidth": 120
+}

package/CHANGELOG.md

@@ -1,6 +1,23 @@
 # Changelog
 
 All notable changes to this project will be documented in this file.
+# [0.2.2] - 2024-10-23
+
+- Fix compatibility node-RED > 3.1.0
+
+# [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
 

package/docker-compose.yml

@@ -2,13 +2,13 @@ version: '3.7'
 
 services:
   nodered:
-    image: nodered/node-red:2.0.6-12
+    image: nodered/node-red:3.1.9-18
     # network_mode: host
     extra_hosts:
-      - "api.yousolution.local:192.168.1.100"
+      - 'api.yousolution.local:192.168.1.100'
     volumes:
       - ./data:/data
     ports:
       - '1880:1880'
     environment:
-      NODE_ENV: 'dev'
+      NODE_ENV: 'dev'

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.html

@@ -1,72 +1,72 @@
 <script type="text/javascript">
-  RED.nodes.registerType('deleteSap',{
+  RED.nodes.registerType('deleteSap', {
     category: 'Sap',
     color: '#FFC300',
     defaults: {
-      name: {value: ''},
-      entity: {value: ''},
-      udo: {value: ''},
-      udt: {value: ''},
-      entityId: {value: ''},
-      docEntry: {value: ''},
-      code: {value: ''},
-      headers: {value: ''}
+      name: { value: '' },
+      entity: { value: '' },
+      udo: { value: '' },
+      udt: { value: '' },
+      entityId: { value: '' },
+      docEntry: { value: '', validate: (v) => true },
+      code: { value: '', validate: (v) => true },
+      headers: { value: '' },
     },
-    inputs:1,
-    outputs:1,
+    inputs: 1,
+    outputs: 1,
     icon: 'font-awesome/fa-trash',
-    label: function() {
-      return this.name||"Sap delete";
+    label: function () {
+      return this.name || 'Sap delete';
     },
-    oneditprepare: function() {
-      $("#node-input-entityId").typedInput({
-        type:"msg",
-        types:["msg"],
-        typeField: "#node-input-entityId-type",
-        value: 'entityId'
+    oneditprepare: function () {
+      $('#node-input-entityId').typedInput({
+        type: 'msg',
+        types: ['msg'],
+        typeField: '#node-input-entityId-type',
+        value: 'entityId',
       });
 
-      $("#node-input-docEntry").typedInput({
-        type:"msg",
-        types:["msg"],
-        typeField: "#node-input-docEntry-type",
-        value: 'docEntry'
+      $('#node-input-docEntry').typedInput({
+        type: 'msg',
+        types: ['msg'],
+        typeField: '#node-input-docEntry-type',
+        value: 'docEntry',
       });
 
-      $("#node-input-headers").typedInput({
-        type:"msg",
-        types:["msg"],
-        typeField: "#node-input-headers-type",
-        value: 'headers'
+      $('#node-input-headers').typedInput({
+        type: 'msg',
+        types: ['msg'],
+        typeField: '#node-input-headers-type',
+        value: 'headers',
       });
 
-      jQuery("#node-input-entity").change(function() {
+      jQuery('#node-input-entity').change(function () {
         jQuery('#container-udo').hide();
         jQuery('#container-docEntry').hide();
         jQuery('#container-udt').hide();
         jQuery('#container-code').hide();
         jQuery('#container-entityId').show();
 
-        if (jQuery(this).val() === 'UDO'){ 
+        if (jQuery(this).val() === 'UDO') {
           jQuery('#container-udo').show();
           jQuery('#container-docEntry').show();
-        } 
-        if (jQuery(this).val() === 'UDT'){ 
+        }
+        if (jQuery(this).val() === 'UDT') {
           jQuery('#container-udt').show();
           jQuery('#container-code').show();
-        } 
-        if(jQuery(this).val() !== 'UDO' || jQuery(this).val() !== 'UDT') {
+        }
+        if (jQuery(this).val() !== 'UDO' || jQuery(this).val() !== 'UDT') {
           jQuery('#container-entityId').hide();
         }
       });
-    }
+    },
   });
 </script>
-  
+
 <script type="text/html" data-template-name="deleteSap">
   <div class="form-row">
     <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
-    <input type="text" id="node-input-name" placeholder="Name">
+    <input type="text" id="node-input-name" placeholder="Name" />
   </div>
 
   <div class="form-row">
@@ -277,131 +277,130 @@
 
   <div class="form-row" style="display:none" id="container-udo">
     <label for="node-input-udo"><i class="fa fa-gears"></i> UDO</label>
-    <input type="text" id="node-input-udo" placeholder="UDO Name">
+    <input type="text" id="node-input-udo" placeholder="UDO Name" />
   </div>
 
   <div class="form-row" style="display:none" id="container-udt">
     <label for="node-input-udt"><i class="fa fa-gears"></i> UDT</label>
-    <input type="text" id="node-input-udt" placeholder="UDT Name">
+    <input type="text" id="node-input-udt" placeholder="UDT Name" />
   </div>
 
   <div class="form-row" style="display:none" id="container-entityId">
     <label for="node-input-type"><i class="fa fa-key"></i> EntityId</label>
-    <input type="text" id="node-input-entityId">
-    <input type="hidden" id="node-input-entityId-type">
+    <input type="text" id="node-input-entityId" />
+    <input type="hidden" id="node-input-entityId-type" />
   </div>
 
   <div class="form-row" style="display:none" id="container-docEntry">
     <label for="node-input-type"><i class="fa fa-key"></i> DocEntry</label>
-    <input type="text" id="node-input-docEntry">
-    <input type="hidden" id="node-input-docEntry-type">
+    <input type="text" id="node-input-docEntry" />
+    <input type="hidden" id="node-input-docEntry-type" />
   </div>
 
   <div class="form-row" style="display:none" id="container-code">
     <label for="node-input-type"><i class="fa fa-key"></i> Code</label>
-    <input type="text" id="node-input-code">
-    <input type="hidden" id="node-input-code-type">
+    <input type="text" id="node-input-code" />
+    <input type="hidden" id="node-input-code-type" />
   </div>
 
   <div class="form-row">
     <label for="node-input-type"><i class="fa fa-gears"></i> Headers</label>
-    <input type="text" id="node-input-headers">
-    <input type="hidden" id="node-input-headers-type">
+    <input type="text" id="node-input-headers" />
+    <input type="hidden" id="node-input-headers-type" />
   </div>
 </script>
-  
+
 <!-- Documentation -->
 <script type="text/html" data-help-name="deleteSap">
   <p>Delete action</p>
-  
+
   <h3>Inputs</h3>
+  <dl class="message-properties">
+    <dt>
+      Name
+      <span class="property-type">string</span>
+    </dt>
+    <dd>the node's name</dd>
+    <dt>
+      Entity
+      <span class="property-type">string</span>
+    </dt>
+    <dd>the entity name of SAP</dd>
+    <dt>
+      entityId
+      <span class="property-type">number | string</span>
+    </dt>
+    <dd>the id of the entity of SAP</dd>
+  </dl>
+
+  <h3>Outputs</h3>
+  <ol class="node-ports">
+    <li>
+      Standard output
       <dl class="message-properties">
-          <dt>Name
-            <span class="property-type">string</span>
-          </dt>
-          <dd> the node's name </dd>
-          <dt>Entity
-            <span class="property-type">string</span>
-          </dt>
-          <dd> the entity name of SAP </dd>
-          <dt>entityId
-            <span class="property-type">number | string</span>
-          </dt>
-          <dd> the id of the entity of SAP </dd>
+        <dt>payload <span class="property-type">string</span></dt>
+        <dd>the standard output of the command.</dd>
       </dl>
-  
-   <h3>Outputs</h3>
-       <ol class="node-ports">
-           <li>Standard output
-               <dl class="message-properties">
-                   <dt>payload <span class="property-type">string</span></dt>
-                   <dd>the standard output of the command.</dd>
-               </dl>
-           </li>
-       </ol>
-  
+    </li>
+  </ol>
+
   <h3>Details</h3>
-      <p>this node is used to delete an entity of SAP.
-        See the examples to understand how to use it.
-      </p>
-      <!-- <p><code>msg.payload</code> is used as the payload of the published message.
+  <p>this node is used to delete an entity of SAP. See the examples to understand how to use it.</p>
+  <!-- <p><code>msg.payload</code> is used as the payload of the published message.
       If it contains an Object it will be converted to a JSON string before being sent.
       If it contains a binary Buffer the message will be published as-is.</p>
       <p>The topic used can be configured in the node or, if left blank, can be set
       by <code>msg.topic</code>.</p>
       <p>Likewise the QoS and retain values can be configured in the node or, if left
       blank, set by <code>msg.qos</code> and <code>msg.retain</code> respectively.</p> -->
-  
+
   <h3>References</h3>
-      <ul>
-          <li><a href="https://sap-samples.github.io/smb-summit-hackathon/b1sl.html" target="_black">Service layer API docs</a> - for more details </li>
-          <li><a href="https://github.com/yousolution-cloud/node-red-contrib-you-sap-service-layer">@yousolution-cloud/node-red-contrib-you-sap-service-layer</a> - the nodes github repository</li>
-      </ul>
-</script><!-- Documentation -->
+  <ul>
+    <li>
+      <a href="https://sap-samples.github.io/smb-summit-hackathon/b1sl.html" target="_black">Service layer API docs</a>
+      - for more details
+    </li>
+    <li>
+      <a href="https://github.com/yousolution-cloud/node-red-contrib-you-sap-service-layer"
+        >@yousolution-cloud/node-red-contrib-you-sap-service-layer</a
+      >
+      - the nodes github repository
+    </li>
+  </ul>
+</script>
+<!-- Documentation -->
 <script type="text/html" data-help-name="closeSap">
   <p>Close action</p>
-  
+
   <h3>Inputs</h3>
       <dl class="message-properties">
-          <dt>Name
-            <span class="property-type">string</span>
-          </dt>
-          <dd> the node's name </dd>
-          <dt>Entity
-            <span class="property-type">string</span>
-          </dt>
-          <dd> the entity name of SAP resource </dd>
-          <dt>entityId
-            <span class="property-type">number | string</span>
-          </dt>
-          <dd> the id of the entity of SAP resource </dd>
+        <dt>payload <span class="property-type">string</span></dt>
+        <dd>the standard output of the command.</dd>
       </dl>
-  
-   <h3>Outputs</h3>
-       <ol class="node-ports">
-           <li>Standard output
-               <dl class="message-properties">
-                   <dt>payload <span class="property-type">string</span></dt>
-                   <dd>the standard output of the command.</dd>
-               </dl>
-           </li>
-       </ol>
-  
+    </li>
+  </ol>
+
   <h3>Details</h3>
-      <p>this node is used to close the entity of SAP resource.
-        See the examples to understand how to use it.
-      </p>
-      <!-- <p><code>msg.payload</code> is used as the payload of the published message.
+  <p>this node is used to close the entity of SAP resource. See the examples to understand how to use it.</p>
+  <!-- <p><code>msg.payload</code> is used as the payload of the published message.
       If it contains an Object it will be converted to a JSON string before being sent.
       If it contains a binary Buffer the message will be published as-is.</p>
       <p>The topic used can be configured in the node or, if left blank, can be set
       by <code>msg.topic</code>.</p>
       <p>Likewise the QoS and retain values can be configured in the node or, if left
       blank, set by <code>msg.qos</code> and <code>msg.retain</code> respectively.</p> -->
-  
+
   <h3>References</h3>
-      <ul>
-          <li><a href="https://sap-samples.github.io/smb-summit-hackathon/b1sl.html" target="_black">Service layer API docs</a> - for more details </li>
-          <li><a href="https://github.com/yousolution-cloud/node-red-contrib-you-sap-service-layer">@yousolution-cloud/node-red-contrib-you-sap-service-layer</a> - the nodes github repository</li>
-      </ul>
-</script>
+  <ul>
+    <li>
+      <a href="https://sap-samples.github.io/smb-summit-hackathon/b1sl.html" target="_black">Service layer API docs</a>
+      - for more details
+    </li>
+    <li>
+      <a href="https://github.com/yousolution-cloud/node-red-contrib-you-sap-service-layer"
+        >@yousolution-cloud/node-red-contrib-you-sap-service-layer</a
+      >
+      - the nodes github repository
+    </li>
+  </ul>
+</script>

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(result.status <= 205) {
+          node.status({ fill: 'green', shape: 'dot', text: 'success' });
+          node.send(msg);
+        }
       } catch (error) {
         node.status({ fill: 'red', shape: 'dot', text: 'Error' });
         done(error);