@yousolution/node-red-contrib-you-sap-service-layer 0.0.3

package/.vscode/launch.json

@@ -0,0 +1,23 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "args": [
+        "-u",
+        "tdd",
+        "--timeout",
+        "999999",
+        "--colors",
+        "${workspaceFolder}/test"
+      ],
+      "internalConsoleOptions": "openOnSessionStart",
+      "name": "Mocha Tests",
+      "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
+      "request": "launch",
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
+      "type": "pwa-node"
+    }
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+# [0.0.1] - 2021-11-22
+
+### First release.
+
+- First public release of unofficial SAP Service Layer for NODE-RED.
+
+# [0.0.3] - 2022-04-15
+
+- Refactoring and add unit tests

package/README.md

@@ -0,0 +1,126 @@
+<!-- [![NPM version][npm-version-image]][npm-url]
+[![NPM downloads per month][npm-downloads-month-image]][npm-url]
+[![NPM downloads total][npm-downloads-total-image]][npm-url]
+[![MIT License][license-image]][license-url] -->
+
+# Unofficial SAP Service layer nodes for Node-RED.
+
+[![Platform](https://img.shields.io/badge/platform-Node--RED-red)](https://nodered.org)
+
+This module provides a set of nodes for Node-RED to quickly create integration flows with SAP service layer.
+
+# Installation
+
+[![NPM](https://nodei.co/npm/node-red-contrib-you-sap-service-layer.png?downloads=true)](https://nodei.co/npm/node-red-contrib-you-sap-service-layer/)
+
+You can install the nodes using node-red's "Manage palette" in the side bar.
+
+Or run the following command in the root directory of your Node-RED installation
+
+    npm install @yousolution/node-red-contrib-you-sap-service-layer --save
+
+# Dependencies
+
+The nodes are tested with `Node.js v12.22.6` and `Node-RED v2.0.6`.
+
+- [axios](https://github.com/axios/axios)
+- [odata-query](https://github.com/techniq/odata-query)
+
+# Changelog
+
+Changes can be followed [here](/CHANGELOG.md).
+
+# Usage
+
+## Basics
+
+### Authenticate (node authenticateSap)
+
+Use this node to authenticate with a valid SAP service layer API access\
+The node requires the following credentials:
+
+- host
+- port
+- company
+- user
+- password
+
+You can see how to use it in the example flows in the _/examples_ directory.\
+_For more details see official [SAP Service layer documentation](https://sap-samples.github.io/smb-summit-hackathon/b1sl.html)_
+
+### Retrieve a list of entities (node listSap)
+
+Use this node to retrieve a list of entities
+
+1. Select the type of entity you want to retrieve as a list
+2. If you want to add filter/options use oData params _optional_\
+   Query options on entities:
+
+| option   | description                                                                 |
+| -------- | --------------------------------------------------------------------------- |
+| $filter  | Restrict the set of business objects returned.                              |
+| $orderby | Specify the order in which business objects are returned from the service.  |
+| $select  | Restrict the service to return only the properties requested by the client. |
+| $skip    | Specify that the result excludes the first n entities.                      |
+| $top     | Specify that only the first n records should be returned.                   |
+
+You can see how to use it in the example flows in the _/examples_ directory.\
+_For more details see official [SAP Service layer documentation](https://sap-samples.github.io/smb-summit-hackathon/b1sl.html)_
+
+### Get single entity (node getSap)
+
+Use this node to get a single entity by providing the primary key
+
+1. Select the type of entity you want to retrieve
+2. Use _objectId_ as primary key of entity
+3. Use _oData_ to filter the response fields _optional_\
+
+Query options on single entity:
+
+| option  | description                                                                 |
+| ------- | --------------------------------------------------------------------------- |
+| $select | Restrict the service to return only the properties requested by the client. |
+
+You can see how to use it in the example flows in the _/examples_ directory.\
+_For more details see official [SAP Service layer documentation](https://sap-samples.github.io/smb-summit-hackathon/b1sl.html)_
+
+### Create a new entity (node createSap)
+
+Use this node to create a new entity.
+
+1. Select the type of entity you want to create
+2. Use _msg.bodyPost_ to provide the entity's fields
+3. Use _msg.createParams_ to provide object params
+
+You can see how to use it in the example flows in the _/examples_ directory.\
+_For more details see official [SAP Service layer documentation](https://sap-samples.github.io/smb-summit-hackathon/b1sl.html)_
+
+### Update an object
+
+Use this node to update an object.
+
+1. Select the type of object you want to update
+2. Use _objectId_ as primary key of object
+3. Use _msg.updateParams_ to provide object params
+
+You can see how to use it in the example flows in the _/examples_ directory.\
+_For more details see official [SAP Service layer documentation](https://sap-samples.github.io/smb-summit-hackathon/b1sl.html)_
+
+### Delete an Object
+
+Use this node to delete an object.
+
+1. Select the type of object you want to delete
+2. Use _objectId_ as primary key of object
+
+You can see how to use it in the example flows in the _/examples_ directory.\
+_For more details see official [SAP Service layer documentation](https://sap-samples.github.io/smb-summit-hackathon/b1sl.html)_
+
+### Count the number of objects per type
+
+Use this node to count the number of objects per type.
+
+1. Select the type of object you want to count
+
+You can see how to use it in the example flows in the _/examples_ directory.\
+_For more details see official [SAP Service layer documentation](https://sap-samples.github.io/smb-summit-hackathon/b1sl.html)_

package/data/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "node-red-project",
+  "description": "A Node-RED Project",
+  "version": "0.0.1",
+  "private": true,
+  "dependencies": {
+    "@types/node-red": "^1.1.1",
+    "@yousolution/node-red-contrib-you-sap-service-layer": "file:yousolution-node-red-contrib-you-sap-service-layer-0.0.3.tgz",
+    "@yousolution/node-red-contrib-you-yousolution.cloud": "file:nodes/yousolution-node-red-contrib-you-yousolution.cloud-0.0.1-1.tgz",
+    "faker": "^6.6.6",
+    "node-red-contrib-sse-client": "~0.2.2",
+    "node-red-node-email": "~1.14.0"
+  }
+}

package/docker-compose.yml

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