@bytecodealliance/preview2-shim 0.17.2 → 0.17.4

package/README.md

@@ -6,6 +6,53 @@ Node.js support is fully tested and conformant against the Wasmtime test suite.
 
 Browser support is considered experimental, and not currently suitable for production applications.
 
+# Features
+
+## WASI Shim object for easy instantiation
+
+An default instantiation object can be used via the `WASIShim` class in `@bytecodealliance/preview2-shim/instantiation`:
+
+```typescript
+import { WASIShim } from '@bytecodealliance/preview2-shim/instantiation';
+import type {
+    VersionedWASIImportObject,
+    WASIImportObject,
+} from '@bytecodealliance/preview2-shim/instantiation';
+
+const shim = new WASIShim();
+
+const unversioned: WASIImportObject = shim.getImportObject();
+// console.log('unversioned', unversioned);
+unversioned satisfies WASIImportObject;
+unversioned satisfies VersionedWASIImportObject<''>;
+
+const versioned: VersionedWASIImportObject<'0.2.3'> = shim.getImportObject({
+    asVersion: '0.2.3',
+});
+//console.log('versioned', versioned);
+versioned satisfies VersionedWASIImportObject<'0.2.3'>;
+```
+
+The import object generated by `getImportObject` can be easily used in `instantiate()` calls
+produced by [`jco transpile`][jco] (with `--instantiation=async`):
+
+```js
+import { WASIShim } from '@bytecodealliance/preview2-shim/instantiation';
+
+// The code below assumes that you have output your transpiled WebAssembly component to `dist/transpiled`
+import { instantiate } from './dist/transpiled/component.js';
+
+const loader = async (path: string) => {
+    const buf = await readFile(`./dist/transpiled/${path}`);
+    return await WebAssembly.compile(buf.buffer as ArrayBuffer);
+};
+const component = await instantiate(loader, new WASIShim().getImportObject());
+
+// TODO: Code that uses your component's exports goes here.
+```
+
+[jco]: https://www.npmjs.com/package/@bytecodealliance/jco
+
 # License
 
 This project is licensed under the Apache 2.0 license with the LLVM exception.

package/lib/browser/cli.js

@@ -1,128 +1,101 @@
-import { _setCwd as fsSetCwd } from './filesystem.js';
 import { streams } from './io.js';
 const { InputStream, OutputStream } = streams;
 
-const symbolDispose = Symbol.dispose ?? Symbol.for('dispose');
-
-let _env = [], _args = [], _cwd = "/";
-export function _setEnv (envObj) {
-  _env = Object.entries(envObj);
-}
-export function _setArgs (args) {
-  _args = args;
-}
-
-export function _setCwd (cwd) {
-  fsSetCwd(_cwd = cwd);
-}
+export { _setEnv, _setArgs, environment } from './environment.js';
+export { _setCwd } from './config.js';
 
-export const environment = {
-  getEnvironment () {
-    return _env;
-  },
-  getArguments () {
-    return _args;
-  },
-  initialCwd () {
-    return _cwd;
-  }
-};
+const symbolDispose = Symbol.dispose ?? Symbol.for('dispose');
 
 class ComponentExit extends Error {
-  constructor(code) {
-    super(`Component exited ${code === 0 ? 'successfully' : 'with error'}`);
-    this.exitError = true;
-    this.code = code;
-  }
+    constructor(code) {
+        super(`Component exited ${code === 0 ? 'successfully' : 'with error'}`);
+        this.exitError = true;
+        this.code = code;
+    }
 }
 
 export const exit = {
-  exit (status) {
-    throw new ComponentExit(status.tag === 'err' ? 1 : 0);
-  },
-  exitWithCode (code) {
-    throw new ComponentExit(code);
-  }
+    exit(status) {
+        throw new ComponentExit(status.tag === 'err' ? 1 : 0);
+    },
+    exitWithCode(code) {
+        throw new ComponentExit(code);
+    },
 };
 
 /**
- * @param {import('../common/io.js').InputStreamHandler} handler 
+ * @param {import('../common/io.js').InputStreamHandler} handler
  */
-export function _setStdin (handler) {
-  stdinStream.handler = handler;
+export function _setStdin(handler) {
+    stdinStream.handler = handler;
 }
 /**
- * @param {import('../common/io.js').OutputStreamHandler} handler 
+ * @param {import('../common/io.js').OutputStreamHandler} handler
  */
-export function _setStderr (handler) {
-  stderrStream.handler = handler;
+export function _setStderr(handler) {
+    stderrStream.handler = handler;
 }
 /**
- * @param {import('../common/io.js').OutputStreamHandler} handler 
+ * @param {import('../common/io.js').OutputStreamHandler} handler
  */
-export function _setStdout (handler) {
-  stdoutStream.handler = handler;
+export function _setStdout(handler) {
+    stdoutStream.handler = handler;
 }
 
 const stdinStream = new InputStream({
-  blockingRead (_len) {
-    // TODO
-  },
-  subscribe () {
-    // TODO
-  },
-  [symbolDispose] () {
-    // TODO
-  }
+    blockingRead(_len) {
+        // TODO
+    },
+    subscribe() {
+        // TODO
+    },
+    [symbolDispose]() {
+        // TODO
+    },
 });
 let textDecoder = new TextDecoder();
 const stdoutStream = new OutputStream({
-  write (contents) {
-    if (contents[contents.length - 1] == 10) {
-      // console.log already appends a new line
-      contents = contents.subarray(0, contents.length - 1);
-    }
-    console.log(textDecoder.decode(contents));
-  },
-  blockingFlush () {
-  },
-  [symbolDispose] () {
-  }
+    write(contents) {
+        if (contents[contents.length - 1] == 10) {
+            // console.log already appends a new line
+            contents = contents.subarray(0, contents.length - 1);
+        }
+        console.log(textDecoder.decode(contents));
+    },
+    blockingFlush() {},
+    [symbolDispose]() {},
 });
 const stderrStream = new OutputStream({
-  write (contents) {
-    if (contents[contents.length - 1] == 10) {
-      // console.error already appends a new line
-      contents = contents.subarray(0, contents.length - 1);
-    }
-    console.error(textDecoder.decode(contents));
-  },
-  blockingFlush () {
-  },
-  [symbolDispose] () {
-
-  }
+    write(contents) {
+        if (contents[contents.length - 1] == 10) {
+            // console.error already appends a new line
+            contents = contents.subarray(0, contents.length - 1);
+        }
+        console.error(textDecoder.decode(contents));
+    },
+    blockingFlush() {},
+    [symbolDispose]() {},
 });
 
 export const stdin = {
-  InputStream,
-  getStdin () {
-    return stdinStream;
-  }
+    InputStream,
+    getStdin() {
+        return stdinStream;
+    },
 };
 
 export const stdout = {
-  OutputStream,
-  getStdout () {
-    return stdoutStream;
-  }
+    OutputStream,
+    getStdout() {
+        return stdoutStream;
+    },
 };
 
 export const stderr = {
-  OutputStream,
-  getStderr () {
-    return stderrStream;
-  }
+    OutputStream,
+    getStderr() {
+        return stderrStream;
+    },
 };
 
 class TerminalInput {}
@@ -133,30 +106,30 @@ const terminalStderrInstance = new TerminalOutput();
 const terminalStdinInstance = new TerminalInput();
 
 export const terminalInput = {
-  TerminalInput
+    TerminalInput,
 };
 
 export const terminalOutput = {
-  TerminalOutput
+    TerminalOutput,
 };
 
 export const terminalStderr = {
-  TerminalOutput,
-  getTerminalStderr () {
-    return terminalStderrInstance;
-  }
+    TerminalOutput,
+    getTerminalStderr() {
+        return terminalStderrInstance;
+    },
 };
 
 export const terminalStdin = {
-  TerminalInput,
-  getTerminalStdin () {
-    return terminalStdinInstance;
-  }
+    TerminalInput,
+    getTerminalStdin() {
+        return terminalStdinInstance;
+    },
 };
 
 export const terminalStdout = {
-  TerminalOutput,
-  getTerminalStdout () {
-    return terminalStdoutInstance;
-  }
+    TerminalOutput,
+    getTerminalStdout() {
+        return terminalStdoutInstance;
+    },
 };

package/lib/browser/clocks.js

@@ -1,34 +1,35 @@
 export const monotonicClock = {
-  resolution() {
-    // usually we dont get sub-millisecond accuracy in the browser
-    // Note: is there a better way to determine this?
-    return 1e6;
-  },
-  now () {
-    // performance.now() is in milliseconds, but we want nanoseconds
-    return BigInt(Math.floor(performance.now() * 1e6));
-  },
-  subscribeInstant (instant) {
-    instant = BigInt(instant);
-    const now = this.now();
-    if (instant <= now)
-      return this.subscribeDuration(0);
-    return this.subscribeDuration(instant - now);
-  },
-  subscribeDuration (_duration) {
-    _duration = BigInt(_duration);
-    console.log(`[monotonic-clock] subscribe`);
-  }
+    resolution() {
+        // usually we dont get sub-millisecond accuracy in the browser
+        // Note: is there a better way to determine this?
+        return 1e6;
+    },
+    now() {
+        // performance.now() is in milliseconds, but we want nanoseconds
+        return BigInt(Math.floor(performance.now() * 1e6));
+    },
+    subscribeInstant(instant) {
+        instant = BigInt(instant);
+        const now = this.now();
+        if (instant <= now) {
+            return this.subscribeDuration(0);
+        }
+        return this.subscribeDuration(instant - now);
+    },
+    subscribeDuration(_duration) {
+        _duration = BigInt(_duration);
+        console.log(`[monotonic-clock] subscribe`);
+    },
 };
 
 export const wallClock = {
-  now() {
-    let now = Date.now(); // in milliseconds
-    const seconds = BigInt(Math.floor(now / 1e3));
-    const nanoseconds = (now % 1e3) * 1e6;
-    return { seconds, nanoseconds };
-  },
-  resolution() {
-    return { seconds: 0n, nanoseconds: 1e6 };
-  }
+    now() {
+        let now = Date.now(); // in milliseconds
+        const seconds = BigInt(Math.floor(now / 1e3));
+        const nanoseconds = (now % 1e3) * 1e6;
+        return { seconds, nanoseconds };
+    },
+    resolution() {
+        return { seconds: 0n, nanoseconds: 1e6 };
+    },
 };

package/lib/browser/config.js

@@ -0,0 +1,6 @@
+// eslint-disable-next-line no-unused-vars
+let _cwd = '/';
+
+export function _setCwd(cwd) {
+    _cwd = cwd;
+}

package/lib/browser/environment.js

@@ -0,0 +1,29 @@
+import { _setCwd as fsSetCwd } from './config.js';
+
+let _env = [],
+    _args = [],
+    _cwd = '/';
+
+export function _setEnv(envObj) {
+    _env = Object.entries(envObj);
+}
+
+export function _setArgs(args) {
+    _args = args;
+}
+
+export function _setCwd(cwd) {
+    fsSetCwd((_cwd = cwd));
+}
+
+export const environment = {
+    getEnvironment() {
+        return _env;
+    },
+    getArguments() {
+        return _args;
+    },
+    initialCwd() {
+        return _cwd;
+    },
+};