DEP-1: SDK additions (#52)

* DEP-1: Support for rich query, list channels, list assets and addition of x-api-key header integration for SaaS

* Update docs, NPM publish github action added

* Update errors.js

Co-authored-by: KK, Amith <amith.kk@unisys.com>

Author: amithkk

.eslintrc

@@ -2,7 +2,8 @@
   "env": {
       "browser": true,
       "commonjs": true,
-      "es6": true
+      "es6": true,
+      "mocha": true
   },
   "extends": "airbnb-base",
   "globals": {
@@ -15,7 +16,7 @@
   "rules": {
       "linebreak-style":"off",
       "func-names": ["warn", "as-needed", { "generators": "never" }],
-      "max-classes-per-file": ["error", 2],
+      "max-classes-per-file": "off",
       "no-underscore-dangle": "off"
   }
 }

.github/workflows/publish.yml

@@ -0,0 +1,17 @@
+name: Publish on NPM
+on:
+  release:
+    types: [created]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '14.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm install
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -115,4 +115,7 @@ dist
 .pnp.*
 
 # generated documentation
-docs/gen
+docs/gen
+
+# Consumer Examples WIP
+sdk-consumer-examples/

README.md

@@ -9,16 +9,18 @@ The DBoM SDK for Node.js provides a high level API to interact with a DBoM node.
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
 
-- [Getting Started](#getting-started)
-  - [Prerequisites](#prerequisites)
-  - [Development](#development)
-- [Usage](#usage)
-  - [Create and Update Asset](#create-and-update-asset)
-  - [Attach or Detach SubAsset](#attach-or-detach-subasset)
-  - [Validate or Audit the Asset](#validate-or-audit-the-asset)
-- [Docs](#docs)
-- [Getting Help](#getting-help)
-- [Getting Involved](#getting-involved)
+- [DBoM Node SDK](#dbom-node-sdk)
+  - [Table of Contents](#table-of-contents)
+  - [Getting Started](#getting-started)
+    - [Prerequisites](#prerequisites)
+    - [Development](#development)
+  - [Usage](#usage)
+    - [Create and Update Asset](#create-and-update-asset)
+    - [Attach or Detach SubAsset](#attach-or-detach-subasset)
+    - [Validate or Audit the Asset](#validate-or-audit-the-asset)
+  - [Docs](#docs)
+  - [Getting help](#getting-help)
+  - [Getting involved](#getting-involved)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -58,7 +60,7 @@ The DBoM SDK can now be imported:
 
 ```javascript
 const DbomNode = require('@dbom/sdk');
-let dNode = new DbomNode('<gateway-uri>', '<signing-service-uri>');
+let dNode = new DbomNode('<gateway-uri>', '<optional-signing-service-uri>', '<optional-api-key>');
 ```
 
 ### Create and Update Asset