JS SDK Beta

.github/workflows/ci.yml

@@ -0,0 +1,38 @@
+name: JS CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        rust:
+          - stable
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Setup Node.js environment
+      uses: actions/[email protected]
+
+    - name: Setup Deno
+      uses: denoland/[email protected]
+
+    - name: NPM install with caching
+      run: npm install
+
+    - name: Build
+      run: npm run build
+
+    - name: Node Test
+      run: npm run test
+
+    - name: Deno Test
+      run: deno test -A ./tests/mod.test.ts

.gitignore

@@ -0,0 +1,130 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "printWidth": 120,
+  "trailingComma": "all",
+  "singleQuote": true
+}

.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+    "deno.enable": true,
+    "deno.lint": true,
+    "deno.unstable": true,
+    "deno.enablePaths": [
+        "./src/deno/mod.ts",
+        "./examples/deno.ts",
+        "./tests/mod.test.ts"
+    ]
+}

Makefile

@@ -0,0 +1,32 @@
+.PHONY: test
+
+prepare:
+	npm install
+
+build:
+	npm run build
+
+test: prepare
+	npm run test
+	deno test -A .\tests\mod.test.ts
+
+clean:
+	echo "No clean implemented"
+
+publish: clean prepare build
+	npm publish
+
+format:
+	npx prettier --write src
+
+lint:
+	npx prettier --check src
+
+docs:
+	npx typedoc --out doc src
+
+show-docs: docs
+	open doc/index.html
+
+update-kernel:
+	node update-kernel.js

README.md

@@ -1 +1,19 @@
-# Extism JavaScript SDK
+# Extism JS SDK
+
+## Run Examples:
+
+```
+npm run build
+
+node --experimental-wasi-unstable-preview1 ./examples/node.js wasm/config.wasm
+
+deno run -A ./examples/deno.js ./wasm/config.wasm
+
+bun run ./examples/node.js wasm/config.wasm
+```
+
+## Update `extism-kernel.wasm`:
+We are shipping an embedded kernel in base64 form in plugin.ts. To update it, you can run these commands:
+```
+make update-kernel
+```

build.js

@@ -0,0 +1,29 @@
+const { build } = require("esbuild");
+const { peerDependencies } = require('./package.json')
+const fs = require('fs')
+
+const sharedConfig = {
+    bundle: true,
+    minify: true,
+    drop: [], // preseve debugger statements
+    external: Object.keys(peerDependencies || {}),
+};
+
+// NodeJS CSJ
+build({
+    ...sharedConfig,
+    entryPoints: ["src/node/index.ts"],
+    platform: 'node', // for CJS
+    outfile: "dist/node/index.js",
+    external: [ './src/mod.ts', "sync-fetch", "child_process" ]
+});
+
+// Browser ESM
+build({
+    ...sharedConfig,
+    entryPoints: ["src/browser/index.ts"],
+    outfile: "dist/browser/index.mjs",
+    platform: 'neutral',
+    external: [ './src/mod.ts', "sync-fetch", "child_process" ],
+    format: "esm",
+});

examples/deno.js

@@ -0,0 +1,22 @@
+import { ExtismPlugin, ExtismPluginOptions } from '../src/deno/mod.ts'
+
+async function main() {
+    const filename = Deno.args[0] || "wasm/hello.wasm";
+    const funcname = Deno.args[1] || "run_test";
+    const input = Deno.args[2] || "this is a test";
+    const wasm = {
+        path: filename
+    }
+
+    const options = new ExtismPluginOptions()
+        .withConfig("thing", "testing")
+        .withWasi();
+
+    const plugin = await ExtismPlugin.new(wasm, options);
+
+    const res = await plugin.call(funcname, new TextEncoder().encode(input));
+    const s = new TextDecoder().decode(res.buffer);
+    console.log(s)
+}
+
+main();