@coherentglobal/wasm-runner 0.0.22

package/README.md

@@ -0,0 +1,263 @@
+<div align="center">
+	<br>
+	<br>
+	<!-- <img width="200" src="" alt="Wasm Runnert"> -->
+	<br>
+	<h1> Wasm Runner Browser </h1>
+</div>
+
+<div align="center">
+	<a href='https://github.com/CoherentCapital/wasm-runner-js/issues'>Report Bug</a>
+	·
+	<a href='https://github.com/CoherentCapital/wasm-runner-js/issues'>Request Feature</a>
+</div>
+
+- [About the Project](#about-the-project)
+  - [Demo](#demo)
+- [Getting Started](#getting-started)
+  - [Prerequisites](#prerequisites)
+  - [Install](#install)
+  - [Usage](#usage)
+    - [Browser ( HTML )](#browser--html-)
+    - [React](#react)
+- [Development](#development)
+  - [Setup](#setup)
+  - [Methods](#methods)
+  - [Initialize Model](#initialize-model)
+  - [Limitations](#limitations)
+- [FootNote](#footnote)
+  - [Sample Payload](#sample-payload)
+
+# About the Project
+
+Run wasm models on browser, on server, on mobile
+
+## Demo
+
+Link: https://jeengine.s3.ap-southeast-1.amazonaws.com/wasm/index.html
+
+# Getting Started
+
+## Prerequisites
+
+1. Download and setup AWS CLI to your machine.
+2. Run `aws configure` on your preferred terminal and fill-out the necessary fields.
+
+Execute this command to retrieve the authorization token. This **token is only valid for 12 hours** after the retrieval.
+
+```
+export CODEARTIFACT_AUTH_TOKEN=`aws codeartifact get-authorization-token --domain coherent-global --domain-owner 792307798794 --query authorizationToken --output text`
+```
+
+3. Create or update your `.npmrc` file.
+
+```
+registry=https://registry.yarnpkg.com
+@coherentglobal:registry=https://coherent-global-792307798794.d.codeartifact.ap-southeast-1.amazonaws.com/npm/coherent-global/
+//coherent-global-792307798794.d.codeartifact.ap-southeast-1.amazonaws.com/npm/coherent-global/:always-auth=true
+//coherent-global-792307798794.d.codeartifact.ap-southeast-1.amazonaws.com/npm/coherent-global/:_authToken=${CODEARTIFACT_AUTH_TOKEN}
+
+```
+
+## Install
+
+To use WasmRunner SDK, run
+
+```
+npm install "@coherentglobal/wasm-runner"
+```
+
+or
+
+```
+yarn add "@coherentglobal/wasm-runner"
+```
+
+## Usage
+
+### Browser ( HTML )
+
+First we call the SDK
+
+```html
+<script src="https://wasm-runner-sdk.s3.ap-southeast-1.amazonaws.com/wasmrunner.min.js"></script>
+```
+
+Then create our javascript that initializes the model and runs it.
+
+```js
+const param = {
+  id: "f30f5935-36c2-4155-aede-523ab2245fd6",
+  url: "<zip url>",
+};
+
+const payload = {
+  request_data: {
+    inputs: {
+      age: 60,
+      insure: "Insure",
+      medical: "Yes",
+      plan: "Plan 1",
+    },
+  },
+  request_meta: {
+    service_uri: "",
+    service_uuid: "",
+    version: "",
+    version_uuid: "f30f5935-36c2-4155-aede-523ab2245fd6",
+    transaction_date: "2021-08-18T04:17:17.142Z",
+    call_purpose: "postman_request",
+    source_system: "",
+    correlation_id: "",
+    requested_output: "",
+  },
+};
+
+const wasmRunner = new WasmRunner(param);
+await wasmRunner.initialize();
+const response = await wasmRunner
+  .execute(payload)
+  .catch((err) => ({ error: err.v3 }));
+
+// Do something with the response
+```
+
+### React
+
+We can call the SDK directly, then follow the normal process of initializing a model then calling the execute method for calculation.
+
+```js
+import { WasmRunner } from "@coherentglobal/wasm-runner";
+
+const param = {
+  id: "f30f5935-36c2-4155-aede-523ab2245fd6",
+  url: "<zip url>",
+};
+
+const payload = {
+  request_data: {
+    inputs: {
+      age: 60,
+      insure: "Insure",
+      medical: "Yes",
+      plan: "Plan 1",
+    },
+  },
+  request_meta: {
+    service_uri: "",
+    service_uuid: "",
+    version: "",
+    version_uuid: "f30f5935-36c2-4155-aede-523ab2245fd6",
+    transaction_date: "2021-08-18T04:17:17.142Z",
+    call_purpose: "postman_request",
+    source_system: "",
+    correlation_id: "",
+    requested_output: "",
+  },
+};
+
+const wasmRunner = new WasmRunner(param);
+await wasmRunner.initialize();
+const response = await wasmRunner
+  .execute(payload)
+  .catch((err) => ({ error: err.v3 }));
+
+// Do something the response
+```
+
+# Development
+
+## Setup
+
+Clone the repo, then install the dependencies
+
+```bash
+$ git clone https://github.com/CoherentCapital/wasm-runner-js.git
+$ yarn install
+```
+
+## Methods
+
+### (async) append(modelConfig)
+
+Append and initialized new model to runner
+
+```js
+await wasmRunner.append(param)
+```
+
+### (async) execute(input)
+
+Perform calculation. The runner will use request_meta.version_uuid of input argument to locate model
+
+```js
+const response = await wasmRunner
+  .execute(payload)
+  .catch((err) => {
+    // Do something here
+  });
+```
+
+### isExist(id)
+
+Check if model existed
+
+```js
+if (wasmRunner.isExist(id)) {
+  // Do something here
+}
+```
+### remove(id)
+
+Remove model from runner
+
+```js
+wasmRunner.remove(id)
+```
+
+## Initialize Model
+
+There are two ways to initialize a model. First is when you instantiating a class,
+
+```js
+const wasmRunner = new WasmRunner(param);
+```
+
+And the second way is by using the append method.
+
+```js
+await wasmRunner.append(param)
+```
+# Limitations
+
+## Lower Level Error
+
+Please note that if there's lower level error that occurs, wasm runner can't handle that kind of exception.
+
+# FootNote
+
+## Sample Payload
+
+``` js
+{
+  "request_data": {
+    "inputs": {
+      "age": 60,
+      "insure": "Insure",
+      "medical": "Yes",
+      "plan": "Plan 1"
+    }
+  },
+  "request_meta": {
+    "service_uri": "",
+    "service_uuid": "",
+    "version": "",
+    "version_uuid": "<model id>",
+    "transaction_date": "2021-08-18T04:17:17.142Z",
+    "call_purpose": "postman_request",
+    "source_system": "",
+    "correlation_id": "",
+    "requested_output": ""
+  }
+}
+```

package/dist/browser/template/main.template.d.ts

@@ -0,0 +1 @@
+export default function buildWorkerFN(runtime: any, license?: string): string;

package/dist/browser/template/main.template.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+function buildWorkerFN(runtime, license = "") {
+    return `
+    ${runtime}
+
+    const license = '${license}';
+
+    %%%WORKER%%%
+`;
+}
+exports.default = buildWorkerFN;
+//# sourceMappingURL=main.template.js.map

package/dist/browser/template/main.template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.template.js","sourceRoot":"","sources":["../../../src/browser/template/main.template.js"],"names":[],"mappings":";;AAAA,SAAwB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,EAAE;IACzD,OAAO;MACH,OAAO;;uBAEU,OAAO;;;CAG7B,CAAC;AACF,CAAC;AARD,gCAQC"}

package/dist/browser/template/runtime.template.d.ts

@@ -0,0 +1 @@
+declare function runtime(wasmBinaryFile: any): (Module: any) => any;