@minigraf/wasi 1.0.0

package/README.md

@@ -0,0 +1,24 @@
+# @minigraf/wasi
+
+WASI WebAssembly package for Minigraf.
+
+This package contains the `wasm32-wasip1` CLI binary as
+`minigraf-wasi.wasm` plus a small Node.js ESM loader. It is intended for
+server-side WASM runtimes such as Wasmtime, Wasmer, and Node's WASI support.
+
+```js
+import { WASI } from "node:wasi";
+import { startMinigrafWasi } from "@minigraf/wasi";
+
+const wasi = new WASI({
+  version: "preview1",
+  args: ["minigraf"],
+  env: process.env,
+  preopens: { "/tmp": "/tmp" },
+});
+
+await startMinigrafWasi(wasi);
+```
+
+Use `MINIGRAF_WASI_WASM_PATH` or the `wasmPath` option to point the loader at
+an alternate `.wasm` file during tests or custom packaging.

package/index.d.ts

@@ -0,0 +1,47 @@
+export interface MinigrafWasiOptions {
+  wasmPath?: string;
+}
+
+export interface WasiWithImportObject {
+  getImportObject(): WebAssembly.Imports;
+  start?(instance: WebAssembly.Instance): void;
+}
+
+export interface WasiWithLegacyImport {
+  wasiImport: Record<string, WebAssembly.ImportValue>;
+  start?(instance: WebAssembly.Instance): void;
+}
+
+export type MinigrafWasiRuntime =
+  | WasiWithImportObject
+  | WasiWithLegacyImport
+  | ({ wasi_snapshot_preview1: Record<string, WebAssembly.ImportValue> } & {
+      start?(instance: WebAssembly.Instance): void;
+    });
+
+export function getMinigrafWasiPath(options?: MinigrafWasiOptions): string;
+
+export function readMinigrafWasi(
+  options?: MinigrafWasiOptions,
+): Promise<ArrayBuffer>;
+
+export function compileMinigrafWasi(
+  options?: MinigrafWasiOptions,
+): Promise<WebAssembly.Module>;
+
+export function instantiateMinigrafWasi(
+  imports?: WebAssembly.Imports,
+  options?: MinigrafWasiOptions,
+): Promise<WebAssembly.Instance>;
+
+export function instantiateMinigrafWasiWith(
+  wasi: MinigrafWasiRuntime,
+  options?: MinigrafWasiOptions,
+): Promise<WebAssembly.Instance>;
+
+export function startMinigrafWasi(
+  wasi: MinigrafWasiRuntime & {
+    start(instance: WebAssembly.Instance): void;
+  },
+  options?: MinigrafWasiOptions,
+): Promise<WebAssembly.Instance>;

package/index.js

@@ -0,0 +1,66 @@
+import { readFile } from "node:fs/promises";
+import { fileURLToPath } from "node:url";
+
+const DEFAULT_WASM_URL = new URL("./minigraf-wasi.wasm", import.meta.url);
+
+export function getMinigrafWasiPath(options = {}) {
+  return (
+    options.wasmPath ??
+    process.env.MINIGRAF_WASI_WASM_PATH ??
+    fileURLToPath(DEFAULT_WASM_URL)
+  );
+}
+
+export async function readMinigrafWasi(options = {}) {
+  const buffer = await readFile(getMinigrafWasiPath(options));
+  return buffer.buffer.slice(
+    buffer.byteOffset,
+    buffer.byteOffset + buffer.byteLength,
+  );
+}
+
+export async function compileMinigrafWasi(options = {}) {
+  return WebAssembly.compile(await readMinigrafWasi(options));
+}
+
+export async function instantiateMinigrafWasi(imports = {}, options = {}) {
+  const module = await compileMinigrafWasi(options);
+  return WebAssembly.instantiate(module, imports);
+}
+
+export async function instantiateMinigrafWasiWith(wasi, options = {}) {
+  return instantiateMinigrafWasi(importObjectFromWasi(wasi), options);
+}
+
+export async function startMinigrafWasi(wasi, options = {}) {
+  const instance = await instantiateMinigrafWasiWith(wasi, options);
+
+  if (typeof wasi.start !== "function") {
+    throw new TypeError("WASI object must expose start(instance)");
+  }
+
+  wasi.start(instance);
+  return instance;
+}
+
+function importObjectFromWasi(wasi) {
+  if (!wasi || typeof wasi !== "object") {
+    throw new TypeError("WASI object is required");
+  }
+
+  if (typeof wasi.getImportObject === "function") {
+    return wasi.getImportObject();
+  }
+
+  if (wasi.wasiImport) {
+    return { wasi_snapshot_preview1: wasi.wasiImport };
+  }
+
+  if (wasi.wasi_snapshot_preview1) {
+    return wasi;
+  }
+
+  throw new TypeError(
+    "WASI object must expose getImportObject(), wasiImport, or wasi_snapshot_preview1",
+  );
+}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@minigraf/wasi",
+  "type": "module",
+  "collaborators": [
+    "Aditya Mukhopadhyay"
+  ],
+  "description": "WASI WebAssembly build of Minigraf, a bi-temporal Datalog graph database",
+  "version": "1.0.0",
+  "license": "MIT OR Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/project-minigraf/minigraf"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "minigraf-wasi.wasm",
+    "README.md"
+  ],
+  "main": "index.js",
+  "types": "index.d.ts",
+  "scripts": {
+    "test": "node --test package.test.js"
+  },
+  "keywords": [
+    "graph",
+    "datalog",
+    "bitemporal",
+    "embedded",
+    "database",
+    "wasi",
+    "webassembly"
+  ]
+}