@coherentglobal/spark-execute-sdk 0.3.0

package/.babelrc

@@ -0,0 +1,12 @@
+{
+  "presets": [
+    [
+      "@babel/preset-env",
+      {
+        "targets": {
+          "esmodules": true
+        }
+      }
+    ]
+  ]
+}

package/.eslintrc.json

@@ -0,0 +1,21 @@
+{
+  "extends": [
+    "airbnb/base",
+    "prettier",
+    "plugin:node/recommended",
+    "plugin:mocha/recommended"
+  ],
+  "parserOptions": {
+    "ecmaVersion": 2020
+  },
+  "plugins": ["prettier", "mocha"],
+  "rules": {
+    "prettier/prettier": "error",
+    "no-unused-vars": "warn",
+    "no-console": "off",
+    "func-names": "off",
+    "no-process-exit": "off",
+    "object-shorthand": "off",
+    "class-methods-use-this": "off"
+  }
+}

package/.github/workflows/build-publish.yml

@@ -0,0 +1,46 @@
+name: Build and Publish Action
+
+on:
+  push:
+    branches: 
+      - dev
+
+jobs:
+  build:
+    name: Build & Publish
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Cache node modules
+        id: cache-npm
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-node-modules
+        with:
+          # npm cache files are stored in `~/.npm` on Linux/macOS
+          path: ~/.npm
+          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-build-${{ env.cache-name }}-
+            ${{ runner.os }}-build-
+            ${{ runner.os }}-
+
+      - if: ${{ steps.cache-npm.outputs.cache-hit != 'true' }}
+        name: List the state of node modules
+        continue-on-error: true
+        run: npm list
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: 'https://registry.npmjs.org'
+          always-auth: true
+      - name: Install dependencies and build 🔧
+        run: npm install && npm run bundle:full
+      - name: Publish package on NPM 📦
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -0,0 +1,92 @@
+<div align="center">
+	<br>
+	<h1> Spark Execute SDK </h1>
+</div>
+
+# About the Project
+
+A Software Development Kit (SDK) that can run either WASM or Fallback Endpoint to call Spark Api model calculation.
+
+# How to's
+
+## Installation
+
+```
+npm install @coherentglobal/spark-execute-sdk
+```
+
+or
+
+```
+yarn add @coherentglobal/spark-execute-sdk
+```
+
+## Usage
+
+### Configuration
+
+```js
+const config = {
+	sparkEndpoint: {
+    url: "https://excel.dev.coherent.global", // Spark Endpoint to be used on Fallback
+    tenant: "tenant", // Spark tenant name
+    authType: public | syntheticKey | bearerToken
+    // If syntheticKey
+    syntheticKey: "apiKey" or generateSyntheticKey(), // value or a func - func call every time making API call, user will do cache
+    // If bearerToken
+    bearerToken: generateToken(), //a func - func call every time making API call, user will do cache
+  },
+	nodegenModels: [
+		{
+			versionId: "uuid",
+			type: "base64",
+			binary: Blob | Base64 | BinaryUnit | Func(versionId), // a binary zipped file or a function the will get the zipped file
+			metadata: {
+				// Spark Model Metadata
+			}
+		}
+	]
+}
+```
+
+## Methods
+
+### Initialize Spark Execute SDK
+
+Instantiate the Model Class.
+
+```js
+const Spark = new Spark(config);
+```
+
+### Execute
+
+### (async) execute(input)
+
+Perform the calculation. The sdk will use the request_meta.version_uuid of input argument to locate the model
+
+```js
+const response = await Spark.execute(input).catch((err) => {
+  // Do something here
+});
+```
+
+### Sample Input
+
+```json
+{
+  "request_data": {
+    "inputs": {
+      "Input": 1
+    }
+  },
+  "request_meta": {
+    "version_id": "<model id>",
+    "transaction_date": "2022-09-19T04:17:17.142Z",
+    "call_purpose": "Spark - API Tester",
+    "source_system": "",
+    "correlation_id": "",
+    "requested_output": ""
+  }
+}
+```