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

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 All notable changes to this project will be documented in this file.
 
+# [0.1.1] - 2022-12-09
+
+- Added label output to nextLink block
+- Fix authentication for subflows compatibility
+- Bug fix
+
+# [0.1.0] - 2022-07-28
+
+- Added sqlQuery node to execute saved sql from SAP Service Layer
+- Added a second output to the nextLink node to check when pagination is finished
+- Bug fix
+
 # [0.0.5] - 2022-05-27
 
 - Change cross join

package/nodes/SQLQuery.html

@@ -0,0 +1,180 @@
+<script type="text/javascript">
+  RED.nodes.registerType('SQLQuery',{
+    category: 'Sap',
+    color: '#FFC300',
+    defaults: {
+      name: {value: ''},
+      sqlCode: {value: ''},
+      // sqlName: {value: ''},
+      // sqlText: {value: ''},
+      headers: {value: ''},
+      nextLink: {value: ''},
+      bodyPost: {value: ''}
+    },
+    inputs:1,
+    outputs:1,
+    icon: 'font-awesome/fa-search',
+    label: function() {
+      return this.name||"SQL Query";
+    },
+    oneditprepare: function() {
+
+      $("#node-input-sqlCode").typedInput({
+        type:"msg",
+        types:["msg"],
+        typeField: "#node-input-sqlCode-type",
+        value: 'sqlCode'
+      });
+
+      // $("#node-input-sqlName").typedInput({
+      //   type:"msg",
+      //   types:["msg"],
+      //   typeField: "#node-input-sqlName-type",
+      //   value: 'sqlName'
+      // });
+
+      // $("#node-input-sqlText").typedInput({
+      //   type:"msg",
+      //   types:["msg"],
+      //   typeField: "#node-input-sqlText-type",
+      //   value: 'sqlText'
+      // });
+
+      $("#node-input-headers").typedInput({
+        type:"msg",
+        types:["msg"],
+        typeField: "#node-input-headers-type",
+        value: 'headers'
+      });
+
+      $("#node-input-nextLink").typedInput({
+        type:"msg",
+        types:["msg"],
+        typeField: "#node-input-nextLink-type",
+        value: 'nextLink'
+      });
+
+      $("#node-input-bodyPost").typedInput({
+        type:"msg",
+        types:["msg"],
+        typeField: "#node-input-bodyPost-type",
+        value: 'bodyPost'
+      });
+
+      // jQuery("#node-input-entity").change(function() {
+      //   jQuery('#container-udo').hide();
+      //   jQuery('#container-udt').hide();
+      //   jQuery('#container-partnerName').hide();
+      //   jQuery('#container-scriptName').hide();
+      //   if (jQuery(this).val() === 'UDO'){ 
+      //     jQuery('#container-udo').show();
+      //   } 
+      //   if (jQuery(this).val() === 'UDT'){
+      //     jQuery('#container-udt').show();
+      //   } 
+      //   if (jQuery(this).val() === 'script'){
+      //     jQuery('#container-partnerName').show();
+      //     jQuery('#container-scriptName').show();
+      //   } 
+        
+      // });
+    }
+  });
+</script>
+
+<script type="text/html" data-template-name="SQLQuery">
+  <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">
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-type"><i class="fa fa-cog"></i> SqlCode</label>
+    <input type="text" id="node-input-sqlCode">
+    <input type="hidden" id="node-input-sqlCode-type">
+  </div>
+
+  <!-- <div class="form-row">
+    <label for="node-input-type"><i class="fa fa-cog"></i> SqlName</label>
+    <input type="text" id="node-input-sqlName">
+    <input type="hidden" id="node-input-sqlName-type">
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-type"><i class="fa fa-cog"></i> SqlText</label>
+    <input type="text" id="node-input-sqlText">
+    <input type="hidden" id="node-input-sqlText-type">
+  </div> -->
+
+  <div class="form-row">
+    <label for="node-input-type"><i class="fa fa-cog"></i> Headers</label>
+    <input type="text" id="node-input-headers">
+    <input type="hidden" id="node-input-headers-type">
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-type"><i class="fa fa-cog"></i> NextLink</label>
+    <input type="text" id="node-input-nextLink">
+    <input type="hidden" id="node-input-nextLink-type">
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-type"><i class="fa fa-cog"></i> BodyPost</label>
+    <input type="text" id="node-input-bodyPost">
+    <input type="hidden" id="node-input-bodyPost-type">
+  </div>
+</script>
+
+
+<!-- Documentation -->
+<script type="text/html" data-help-name="SQLQuery">
+  <p>Create a new Entity 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>bodyPost
+            <span class="property-type">object</span>
+          </dt>
+          <dd> the data of the entity </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>
+  
+  <h3>Details</h3>
+      <p>this node is used to create the 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>

package/nodes/SQLQuery.js

@@ -0,0 +1,43 @@
+process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
+const axios = require('axios');
+const Support = require('./support');
+
+module.exports = function (RED) {
+  function SQLQuery(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+    // reset status
+    node.status({});
+
+    node.on('input', async (msg, send, done) => {
+      // reset status
+      node.status({});
+      try {
+        const data = msg[config.bodyPost];
+        const params = {
+          SqlCode: msg[config.sqlCode],
+        };
+
+        if (!params.SqlCode) {
+          const missingParams = [];
+          params.SqlCode ? null : missingParams.push('SqlCode');
+          done(new Error(`Missing mandatory params: ${missingParams.join(',')}.`));
+          return;
+        }
+
+        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.nextLink = result.data['odata.nextLink'] || result.data['@odata.nextLink'];
+        msg.statusCode = result.status;
+        node.status({ fill: 'green', shape: 'dot', text: 'success' });
+        node.send(msg);
+      } catch (error) {
+        node.status({ fill: 'red', shape: 'dot', text: 'Error' });
+        done(error);
+      }
+    });
+  }
+  RED.nodes.registerType('SQLQuery', SQLQuery, {});
+};

package/nodes/authenticateSap.html

@@ -9,8 +9,10 @@
       version: {value: ''}
     },
     credentials: {
-      company: {type: "string"}, 
+      company: {type: "string"},
+      companyType: {type: 'string'},
       user: {type:"string"},
+      userType: {type: 'string'},
       password: {type:"password"}
     },
     inputs:1,
@@ -18,6 +20,19 @@
     icon: 'font-awesome/fa-lock',
     label: function() {
       return this.name||"Sap authenticate";
+    },
+    oneditprepare: function() { 
+      $("#node-input-company").typedInput({
+        default:"msg",
+        types:["msg", "str"],
+        typeField: "#node-input-companyType"
+      });
+
+      $("#node-input-user").typedInput({
+        default:"msg",
+        types:["msg", "str"],
+        typeField: "#node-input-userType"
+      });
     }
   });
 </script>
@@ -49,11 +64,13 @@
   <div class="form-row">
     <label for="node-input-company"><i class="fa fa-tag"></i> Company</label>
     <input type="text" id="node-input-company" placeholder="company">
+    <input type="hidden" id="node-input-companyType">
   </div>
 
   <div class="form-row">
     <label for="node-input-user"><i class="fa fa-tag"></i> User</label>
     <input type="text" id="node-input-user" placeholder="user">
+    <input type="hidden" id="node-input-userType">
   </div>
 
   <div class="form-row">

package/nodes/authenticateSap.js

@@ -9,9 +9,9 @@ module.exports = function (RED) {
     // reset status
     node.status({});
 
-    const flowContext = node.context().flow;
+    const globalContext = node.context().global;
 
-    flowContext.set(`_YOU_SapServiceLayer_${node.id}`, {
+    globalContext.set(`_YOU_SapServiceLayer_${node.id}`, {
       host: config.host,
       port: config.port,
       version: config.version,
@@ -27,6 +27,18 @@ module.exports = function (RED) {
     }
 
     node.on('input', async (msg, send, done) => {
+      // If Company setted from msg
+      if (node.credentials.companyType == 'msg') {
+        const company = msg[node.credentials.company];
+        globalContext.set(`_YOU_SapServiceLayer_${node.id}.credentials.CompanyDB`, company);
+      }
+
+      // If User setted from msg
+      if (node.credentials.userType == 'msg') {
+        const user = msg[node.credentials.user];
+        globalContext.set(`_YOU_SapServiceLayer_${node.id}.credentials.UserName`, user);
+      }
+
       // reset status
       node.status({});
 
@@ -36,7 +48,7 @@ module.exports = function (RED) {
         return;
       }
 
-      const headers = flowContext.get(`_YOU_SapServiceLayer_${node.id}.headers`);
+      const headers = globalContext.get(`_YOU_SapServiceLayer_${node.id}.headers`);
 
       msg._YOU_SapServiceLayer = {
         idAuth: node.id,
@@ -45,7 +57,7 @@ module.exports = function (RED) {
       if (!headers) {
         try {
           const result = await Support.login(node, node.id);
-          flowContext.set(`_YOU_SapServiceLayer_${node.id}.headers`, result.headers['set-cookie']);
+          globalContext.set(`_YOU_SapServiceLayer_${node.id}.headers`, result.headers['set-cookie']);
         } catch (error) {
           msg.payload = error;
           if (error.response && error.response.data) {
@@ -65,7 +77,9 @@ module.exports = function (RED) {
   RED.nodes.registerType('authenticateSap', AuthenticateSapNode, {
     credentials: {
       company: { type: 'text' },
+      companyType: { type: 'text' },
       user: { type: 'text' },
+      userType: { type: 'text' },
       password: { type: 'password' },
     },
   });

package/nodes/createSQLQuery.html

@@ -0,0 +1,166 @@
+<script type="text/javascript">
+  RED.nodes.registerType('createSQLQuery',{
+    category: 'Sap',
+    color: '#FFC300',
+    defaults: {
+      name: {value: ''},
+      sqlCode: {value: ''},
+      sqlName: {value: ''},
+      sqlText: {value: ''},
+      headers: {value: ''},
+      bodyPost: {value: ''}
+    },
+    inputs:1,
+    outputs:1,
+    icon: 'font-awesome/fa-plus',
+    label: function() {
+      return this.name||"Create SQL Query";
+    },
+    oneditprepare: function() {
+
+      $("#node-input-sqlCode").typedInput({
+        type:"msg",
+        types:["msg"],
+        typeField: "#node-input-sqlCode-type",
+        value: 'sqlCode'
+      });
+
+      $("#node-input-sqlName").typedInput({
+        type:"msg",
+        types:["msg"],
+        typeField: "#node-input-sqlName-type",
+        value: 'sqlName'
+      });
+
+      $("#node-input-sqlText").typedInput({
+        type:"msg",
+        types:["msg"],
+        typeField: "#node-input-sqlText-type",
+        value: 'sqlText'
+      });
+
+      $("#node-input-headers").typedInput({
+        type:"msg",
+        types:["msg"],
+        typeField: "#node-input-headers-type",
+        value: 'headers'
+      });
+
+      $("#node-input-bodyPost").typedInput({
+        type:"msg",
+        types:["msg"],
+        typeField: "#node-input-bodyPost-type",
+        value: 'bodyPost'
+      });
+
+      // jQuery("#node-input-entity").change(function() {
+      //   jQuery('#container-udo').hide();
+      //   jQuery('#container-udt').hide();
+      //   jQuery('#container-partnerName').hide();
+      //   jQuery('#container-scriptName').hide();
+      //   if (jQuery(this).val() === 'UDO'){ 
+      //     jQuery('#container-udo').show();
+      //   } 
+      //   if (jQuery(this).val() === 'UDT'){
+      //     jQuery('#container-udt').show();
+      //   } 
+      //   if (jQuery(this).val() === 'script'){
+      //     jQuery('#container-partnerName').show();
+      //     jQuery('#container-scriptName').show();
+      //   } 
+        
+      // });
+    }
+  });
+</script>
+
+<script type="text/html" data-template-name="createSQLQuery">
+  <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">
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-type"><i class="fa fa-cog"></i> SqlCode</label>
+    <input type="text" id="node-input-sqlCode">
+    <input type="hidden" id="node-input-sqlCode-type">
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-type"><i class="fa fa-cog"></i> SqlName</label>
+    <input type="text" id="node-input-sqlName">
+    <input type="hidden" id="node-input-sqlName-type">
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-type"><i class="fa fa-cog"></i> SqlText</label>
+    <input type="text" id="node-input-sqlText">
+    <input type="hidden" id="node-input-sqlText-type">
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-type"><i class="fa fa-cog"></i> Headers</label>
+    <input type="text" id="node-input-headers">
+    <input type="hidden" id="node-input-headers-type">
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-type"><i class="fa fa-cog"></i> BodyPost</label>
+    <input type="text" id="node-input-bodyPost">
+    <input type="hidden" id="node-input-bodyPost-type">
+  </div>
+</script>
+
+
+<!-- Documentation -->
+<script type="text/html" data-help-name="createSQLQuery">
+  <p>Create a new SQL query from SAP service layer</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>bodyPost
+            <span class="property-type">object</span>
+          </dt>
+          <dd> the data of the entity </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>
+  
+  <h3>Details</h3>
+      <p>this node is used to create the 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>

package/nodes/createSQLQuery.js

@@ -0,0 +1,67 @@
+process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
+const axios = require('axios');
+const Support = require('./support');
+
+module.exports = function (RED) {
+  function CreateSQLQuery(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+    // reset status
+    node.status({});
+
+    node.on('input', async (msg, send, done) => {
+      // reset status
+      node.status({});
+      try {
+        // const data = msg[config.bodyPost];
+        const data = {
+          SqlCode: msg[config.sqlCode],
+          SqlName: msg[config.sqlName],
+          SqlText: msg[config.sqlText],
+        };
+
+        if (!data.SqlCode || !data.SqlName || !data.SqlText) {
+          const missingParams = [];
+          data.SqlCode ? null : missingParams.push('SqlCode');
+          data.SqlName ? null : missingParams.push('SqlName');
+          data.SqlText ? null : missingParams.push('SqlText');
+          done(new Error(`Missing mandatory params: ${missingParams.join(',')}.`));
+          return;
+        }
+
+        // if (!data.SqlCode) {
+        //   node.status({ fill: 'red', shape: 'dot', text: 'SqlCode must have value' });
+        //   done(new Error('SqlCode must have value'));
+        //   return;
+        // }
+        // if (!data.SqlName) {
+        //   node.status({ fill: 'red', shape: 'dot', text: 'SqlName must have value' });
+        //   done(new Error('SqlName must have value'));
+        //   return;
+        // }
+        // if (!data.SqlText) {
+        //   node.status({ fill: 'red', shape: 'dot', text: 'SqlText must have value' });
+        //   done(new Error('SqlText must have value'));
+        //   return;
+        // }
+
+        // if (!data) {
+        //   node.status({ fill: 'red', shape: 'dot', text: 'bodyPost must have value' });
+        //   done(new Error('bodyPost must have value'));
+        //   return;
+        // }
+        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.statusCode = result.status;
+        node.status({ fill: 'green', shape: 'dot', text: 'success' });
+        node.send(msg);
+      } catch (error) {
+        node.status({ fill: 'red', shape: 'dot', text: 'Error' });
+        done(error);
+      }
+    });
+  }
+  RED.nodes.registerType('createSQLQuery', CreateSQLQuery, {});
+};

package/nodes/crossJoinSap.js

@@ -21,7 +21,7 @@ module.exports = function (RED) {
         const result = await Support.sendRequest({ node, msg, config, axios, login, options });
         msg.payload = result.data;
         msg.statusCode = result.status;
-        msg.nextLink = result.data['odata.nextLink'];
+        msg.nextLink = result.data['odata.nextLink'] || result.data['@odata.nextLink'];
         node.status({ fill: 'green', shape: 'dot', text: 'success' });
         node.send(msg);
       } catch (error) {

package/nodes/listSap.js

@@ -20,7 +20,7 @@ module.exports = function (RED) {
         const login = Support.login;
         const result = await Support.sendRequest({ node, msg, config, axios, login, options });
         msg.payload = result.data;
-        msg.nextLink = result.data['odata.nextLink'];
+        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);