@tybys/wasm-util 0.1.0 → 0.3.0

package/README.md

@@ -8,6 +8,51 @@ WebAssembly related utils for browser environment
 
 All example code below need to be bundled by ES module bundlers like `webpack` / `rollup`, or specify import map in browser native ES module runtime.
 
+### WASI polyfill for browser
+
+The API is similar to the `require('wasi').WASI` in Node.js.
+
+You can use `memfs-browser` to provide filesystem capability.
+
+- Example: [https://github.com/toyobayashi/wasi-wabt](https://github.com/toyobayashi/wasi-wabt)
+- Demo: [https://toyobayashi.github.io/wasi-wabt/](https://toyobayashi.github.io/wasi-wabt/)
+
+```js
+import { load, WASI } from '@tybys/wasm-util'
+import { Volumn, createFsFromVolume } from 'memfs-browser'
+
+const fs = createFsFromVolume(Volume.from({
+  '/home/wasi': null
+}))
+
+const wasi = new WASI({
+  args: ['chrome', 'file.wasm'],
+  env: {
+    NODE_ENV: 'development',
+    WASI_SDK_PATH: '/opt/wasi-sdk'
+  },
+  preopens: {
+    '/': '/'
+  },
+  filesystem: { type: 'memfs', fs },
+
+  // redirect stdout / stderr
+
+  // print (text) { console.log(text) },
+  // printErr (text) { console.error(text) }
+})
+
+const imports = {
+  wasi_snapshot_preview1: wasi.wasiImport
+}
+
+const { module, instance } = await load('/path/to/file.wasm', imports)
+wasi.start(instance)
+// wasi.initialize(instance)
+```
+
+Implemented syscalls: [wasi_snapshot_preview1](#wasi_snapshot_preview1)
+
 ### `load` / `loadSync`
 
 `loadSync` has 4KB wasm size limit in browser.
@@ -99,49 +144,7 @@ await p
 console.log(Date.now() - now >= 200)
 ```
 
-### WASI polyfill for browser
-
-The API is similar to the `require('wasi').WASI` in Node.js.
-
-You can use `memfs-browser` to provide filesystem capability.
-
-```js
-import { load, WASI } from '@tybys/wasm-util'
-import { Volumn, createFsFromVolume } from 'memfs-browser'
-
-const fs = createFsFromVolume(Volume.from({
-  '/home/wasi': null
-}))
-
-const wasi = new WASI({
-  args: ['chrome', 'file.wasm'],
-  env: {
-    NODE_ENV: 'development',
-    WASI_SDK_PATH: '/opt/wasi-sdk'
-  },
-  preopens: {
-    '/': '/'
-  },
-  filesystem: { type: 'memfs', fs },
-
-  // redirect stdout / stderr
-
-  // print (text) { console.log(text) },
-  // printErr (text) { console.error(text) }
-})
-
-const imports = {
-  wasi_snapshot_preview1: wasi.wasiImport
-}
-
-const { module, instance } = await load('/path/to/file.wasm', imports)
-wasi.start(instance)
-// wasi.initialize(instance)
-```
-
-Implemented syscalls:
-
-#### wasi_snapshot_preview1
+### wasi_snapshot_preview1
 
 - [x] args_get
 - [x] args_sizes_get

package/dist/wasm-util.d.ts

@@ -64,7 +64,7 @@ export declare function load(urlOrBuffer: string | URL | BufferSource, imports?:
 export declare function loadSync(buffer: BufferSource, imports?: WebAssembly.Imports, asyncify?: AsyncifyOptions): WebAssembly.WebAssemblyInstantiatedSource;
 
 /** @public */
-export declare class Memory extends WebAssembly.Memory {
+export declare class Memory extends WebAssemblyMemory {
     constructor(descriptor: WebAssembly.MemoryDescriptor);
     get HEAP8(): Int8Array;
     get HEAPU8(): Uint8Array;
@@ -79,6 +79,11 @@ export declare class Memory extends WebAssembly.Memory {
     get view(): DataView;
 }
 
+/** @public */
+export declare type PromisifyExports<T, U> = T extends Record<string, any> ? {
+    [P in keyof T]: T[P] extends Callable ? U extends Array<keyof T> ? P extends U[number] ? AsyncifyExportFunction<T[P]> : T[P] : AsyncifyExportFunction<T[P]> : T[P];
+} : T;
+
 /** @public */
 export declare class WASI {
     private [kSetMemory];
@@ -108,6 +113,24 @@ export declare interface WASIOptions {
     };
 }
 
+/** @public */
+export declare const WebAssemblyMemory: {
+    new (descriptor: WebAssembly.MemoryDescriptor): WebAssembly.Memory;
+    prototype: WebAssembly.Memory;
+};
+
+/** @public */
+export declare function wrapAsyncExport<T extends Function = any>(f: Function): T;
+
+/** @public */
+export declare function wrapAsyncImport(f: Function, parameterType: WebAssembly.ValueType[], returnType: WebAssembly.ValueType[]): Function;
+
+/** @public */
+export declare function wrapExports<T extends WebAssembly.Exports>(exports: T): PromisifyExports<T, void>;
+
+/** @public */
+export declare function wrapExports<T extends WebAssembly.Exports, U extends Array<keyof T>>(exports: T, needWrap: U): PromisifyExports<T, U>;
+
 export { }
 
 export as namespace wasmUtil;

package/dist/wasm-util.esm-bundler.js

@@ -1,3 +1,12 @@
+const _WebAssembly = typeof WebAssembly !== 'undefined'
+    ? WebAssembly
+    : typeof WXWebAssembly !== 'undefined'
+        ? WXWebAssembly
+        : undefined;
+if (!_WebAssembly) {
+    throw new Error('WebAssembly is not supported in this environment');
+}
+
 function validateObject(value, name) {
     if (value === null || typeof value !== 'object') {
         throw new TypeError(`${name} must be an object. Received ${value === null ? 'null' : typeof value}`);
@@ -30,6 +39,17 @@ function validateUndefined(value, name) {
 }
 function isPromiseLike(obj) {
     return !!(obj && (typeof obj === 'object' || typeof obj === 'function') && typeof obj.then === 'function');
+}
+function wrapInstanceExports(exports, mapFn) {
+    const newExports = Object.create(null);
+    Object.keys(exports).forEach(name => {
+        const exportValue = exports[name];
+        Object.defineProperty(newExports, name, {
+            enumerable: true,
+            value: mapFn(exportValue, name)
+        });
+    });
+    return newExports;
 }
 
 const ignoreNames = [
@@ -69,7 +89,7 @@ class Asyncify {
         if (this.exports) {
             throw new Error('Asyncify has been initialized');
         }
-        if (!(memory instanceof WebAssembly.Memory)) {
+        if (!(memory instanceof _WebAssembly.Memory)) {
             throw new TypeError('Require WebAssembly.Memory object');
         }
         const exports = instance.exports;
@@ -104,7 +124,7 @@ class Asyncify {
             new Int32Array(memory.buffer, this.dataPtr).set([address.start, address.end]);
         }
         this.exports = this.wrapExports(exports, options.wrapExports);
-        const asyncifiedInstance = Object.create(WebAssembly.Instance.prototype);
+        const asyncifiedInstance = Object.create(_WebAssembly.Instance.prototype);
         Object.defineProperty(asyncifiedInstance, 'exports', { value: this.exports });
         // Object.setPrototypeOf(instance, Instance.prototype)
         return asyncifiedInstance;
@@ -163,20 +183,13 @@ class Asyncify {
         });
     }
     wrapExports(exports, needWrap) {
-        const newExports = Object.create(null);
-        Object.keys(exports).forEach(name => {
-            const exportValue = exports[name];
+        return wrapInstanceExports(exports, (exportValue, name) => {
             let ignore = ignoreNames.indexOf(name) !== -1 || typeof exportValue !== 'function';
             if (Array.isArray(needWrap)) {
                 ignore = ignore || (needWrap.indexOf(name) === -1);
             }
-            Object.defineProperty(newExports, name, {
-                enumerable: true,
-                value: ignore ? exportValue : this.wrapExportFunction(exportValue)
-            });
+            return ignore ? exportValue : this.wrapExportFunction(exportValue);
         });
-        // wrappedExports.set(exports, newExports)
-        return newExports;
     }
 }
 // /** @public */
@@ -194,9 +207,12 @@ class Asyncify {
 // Object.defineProperty(Instance.prototype, 'exports', { enumerable: true })
 
 async function fetchWasm(urlOrBuffer, imports) {
+    if (typeof wx !== 'undefined' && typeof __wxConfig !== 'undefined') {
+        return await _WebAssembly.instantiate(urlOrBuffer, imports);
+    }
     const response = await fetch(urlOrBuffer);
     const buffer = await response.arrayBuffer();
-    const source = await WebAssembly.instantiate(buffer, imports);
+    const source = await _WebAssembly.instantiate(buffer, imports);
     return source;
 }
 /** @public */
@@ -213,7 +229,7 @@ async function load(urlOrBuffer, imports, asyncify) {
         imports = asyncifyHelper.wrapImports(imports);
     }
     if (urlOrBuffer instanceof ArrayBuffer || ArrayBuffer.isView(urlOrBuffer)) {
-        source = await WebAssembly.instantiate(urlOrBuffer, imports);
+        source = await _WebAssembly.instantiate(urlOrBuffer, imports);
         if (asyncify) {
             const memory = source.instance.exports.memory || ((_a = imports.env) === null || _a === void 0 ? void 0 : _a.memory);
             return { module: source.module, instance: asyncifyHelper.init(memory, source.instance, asyncify) };
@@ -223,9 +239,9 @@ async function load(urlOrBuffer, imports, asyncify) {
     if (typeof urlOrBuffer !== 'string' && !(urlOrBuffer instanceof URL)) {
         throw new TypeError('Invalid source');
     }
-    if (typeof WebAssembly.instantiateStreaming === 'function') {
+    if (typeof _WebAssembly.instantiateStreaming === 'function') {
         try {
-            source = await WebAssembly.instantiateStreaming(fetch(urlOrBuffer), imports);
+            source = await _WebAssembly.instantiateStreaming(fetch(urlOrBuffer), imports);
         }
         catch (_) {
             source = await fetchWasm(urlOrBuffer, imports);
@@ -255,8 +271,8 @@ function loadSync(buffer, imports, asyncify) {
         asyncifyHelper = new Asyncify();
         imports = asyncifyHelper.wrapImports(imports);
     }
-    const module = new WebAssembly.Module(buffer);
-    const instance = new WebAssembly.Instance(module, imports);
+    const module = new _WebAssembly.Module(buffer);
+    const instance = new _WebAssembly.Instance(module, imports);
     const source = { instance, module };
     if (asyncify) {
         const memory = source.instance.exports.memory || ((_a = imports.env) === null || _a === void 0 ? void 0 : _a.memory);
@@ -842,7 +858,9 @@ class FileDescriptorTable {
 }
 
 /** @public */
-class Memory extends WebAssembly.Memory {
+const WebAssemblyMemory = _WebAssembly.Memory;
+/** @public */
+class Memory extends WebAssemblyMemory {
     // eslint-disable-next-line @typescript-eslint/no-useless-constructor
     constructor(descriptor) {
         super(descriptor);
@@ -861,7 +879,7 @@ class Memory extends WebAssembly.Memory {
 }
 /** @public */
 function extendMemory(memory) {
-    if (Object.getPrototypeOf(memory) === WebAssembly.Memory.prototype) {
+    if (Object.getPrototypeOf(memory) === _WebAssembly.Memory.prototype) {
         Object.setPrototypeOf(memory, Memory.prototype);
     }
     return memory;
@@ -972,7 +990,7 @@ function readStdin() {
 class WASI$1 {
     constructor(args, env, preopens, stdio, filesystem, print, printErr) {
         this._setMemory = function _setMemory(m) {
-            if (!(m instanceof WebAssembly.Memory)) {
+            if (!(m instanceof _WebAssembly.Memory)) {
                 throw new TypeError('"instance.exports.memory" property must be a WebAssembly.Memory');
             }
             _memory.set(this, extendMemory(m));
@@ -1279,6 +1297,9 @@ class WASI$1 {
             let buffer;
             let nread = 0;
             if (fd === 0) {
+                if (typeof window === 'undefined' || typeof window.prompt !== 'function') {
+                    return 58 /* WasiErrno.ENOTSUP */;
+                }
                 buffer = readStdin();
                 nread = buffer ? copyMemory(ioVecs, buffer) : 0;
             }
@@ -1876,4 +1897,42 @@ function wasiReturnOnProcExit(rval) {
     throw kExitCode;
 }
 
-export { Asyncify, Memory, WASI, extendMemory, load, loadSync };
+function checkWebAssemblyFunction() {
+    const WebAssemblyFunction = _WebAssembly.Function;
+    if (typeof WebAssemblyFunction !== 'function') {
+        throw new Error('WebAssembly.Function is not supported in this environment.' +
+            ' If you are using V8 based browser like Chrome, try to specify' +
+            ' --js-flag="--wasm-staging --experimental-wasm-stack-switching"');
+    }
+    return WebAssemblyFunction;
+}
+/** @public */
+function wrapAsyncImport(f, parameterType, returnType) {
+    const WebAssemblyFunction = checkWebAssemblyFunction();
+    if (typeof f !== 'function') {
+        throw new TypeError('Function required');
+    }
+    const parameters = parameterType.slice(0);
+    parameters.unshift('externref');
+    return new WebAssemblyFunction({ parameters, results: returnType }, f, { suspending: 'first' });
+}
+/** @public */
+function wrapAsyncExport(f) {
+    const WebAssemblyFunction = checkWebAssemblyFunction();
+    if (typeof f !== 'function') {
+        throw new TypeError('Function required');
+    }
+    return new WebAssemblyFunction({ parameters: [...WebAssemblyFunction.type(f).parameters.slice(1)], results: ['externref'] }, f, { promising: 'first' });
+}
+/** @public */
+function wrapExports(exports, needWrap) {
+    return wrapInstanceExports(exports, (exportValue, name) => {
+        let ignore = typeof exportValue !== 'function';
+        if (Array.isArray(needWrap)) {
+            ignore = ignore || (needWrap.indexOf(name) === -1);
+        }
+        return ignore ? exportValue : wrapAsyncExport(exportValue);
+    });
+}
+
+export { Asyncify, Memory, WASI, WebAssemblyMemory, extendMemory, load, loadSync, wrapAsyncExport, wrapAsyncImport, wrapExports };

package/dist/wasm-util.esm.js

@@ -1,3 +1,12 @@
+const _WebAssembly = typeof WebAssembly !== 'undefined'
+    ? WebAssembly
+    : typeof WXWebAssembly !== 'undefined'
+        ? WXWebAssembly
+        : undefined;
+if (!_WebAssembly) {
+    throw new Error('WebAssembly is not supported in this environment');
+}
+
 function validateObject(value, name) {
     if (value === null || typeof value !== 'object') {
         throw new TypeError(`${name} must be an object. Received ${value === null ? 'null' : typeof value}`);
@@ -30,6 +39,17 @@ function validateUndefined(value, name) {
 }
 function isPromiseLike(obj) {
     return !!(obj && (typeof obj === 'object' || typeof obj === 'function') && typeof obj.then === 'function');
+}
+function wrapInstanceExports(exports, mapFn) {
+    const newExports = Object.create(null);
+    Object.keys(exports).forEach(name => {
+        const exportValue = exports[name];
+        Object.defineProperty(newExports, name, {
+            enumerable: true,
+            value: mapFn(exportValue, name)
+        });
+    });
+    return newExports;
 }
 
 const ignoreNames = [
@@ -69,7 +89,7 @@ class Asyncify {
         if (this.exports) {
             throw new Error('Asyncify has been initialized');
         }
-        if (!(memory instanceof WebAssembly.Memory)) {
+        if (!(memory instanceof _WebAssembly.Memory)) {
             throw new TypeError('Require WebAssembly.Memory object');
         }
         const exports = instance.exports;
@@ -104,7 +124,7 @@ class Asyncify {
             new Int32Array(memory.buffer, this.dataPtr).set([address.start, address.end]);
         }
         this.exports = this.wrapExports(exports, options.wrapExports);
-        const asyncifiedInstance = Object.create(WebAssembly.Instance.prototype);
+        const asyncifiedInstance = Object.create(_WebAssembly.Instance.prototype);
         Object.defineProperty(asyncifiedInstance, 'exports', { value: this.exports });
         // Object.setPrototypeOf(instance, Instance.prototype)
         return asyncifiedInstance;
@@ -163,20 +183,13 @@ class Asyncify {
         });
     }
     wrapExports(exports, needWrap) {
-        const newExports = Object.create(null);
-        Object.keys(exports).forEach(name => {
-            const exportValue = exports[name];
+        return wrapInstanceExports(exports, (exportValue, name) => {
             let ignore = ignoreNames.indexOf(name) !== -1 || typeof exportValue !== 'function';
             if (Array.isArray(needWrap)) {
                 ignore = ignore || (needWrap.indexOf(name) === -1);
             }
-            Object.defineProperty(newExports, name, {
-                enumerable: true,
-                value: ignore ? exportValue : this.wrapExportFunction(exportValue)
-            });
+            return ignore ? exportValue : this.wrapExportFunction(exportValue);
         });
-        // wrappedExports.set(exports, newExports)
-        return newExports;
     }
 }
 // /** @public */
@@ -194,9 +207,12 @@ class Asyncify {
 // Object.defineProperty(Instance.prototype, 'exports', { enumerable: true })
 
 async function fetchWasm(urlOrBuffer, imports) {
+    if (typeof wx !== 'undefined' && typeof __wxConfig !== 'undefined') {
+        return await _WebAssembly.instantiate(urlOrBuffer, imports);
+    }
     const response = await fetch(urlOrBuffer);
     const buffer = await response.arrayBuffer();
-    const source = await WebAssembly.instantiate(buffer, imports);
+    const source = await _WebAssembly.instantiate(buffer, imports);
     return source;
 }
 /** @public */
@@ -213,7 +229,7 @@ async function load(urlOrBuffer, imports, asyncify) {
         imports = asyncifyHelper.wrapImports(imports);
     }
     if (urlOrBuffer instanceof ArrayBuffer || ArrayBuffer.isView(urlOrBuffer)) {
-        source = await WebAssembly.instantiate(urlOrBuffer, imports);
+        source = await _WebAssembly.instantiate(urlOrBuffer, imports);
         if (asyncify) {
             const memory = source.instance.exports.memory || ((_a = imports.env) === null || _a === void 0 ? void 0 : _a.memory);
             return { module: source.module, instance: asyncifyHelper.init(memory, source.instance, asyncify) };
@@ -223,9 +239,9 @@ async function load(urlOrBuffer, imports, asyncify) {
     if (typeof urlOrBuffer !== 'string' && !(urlOrBuffer instanceof URL)) {
         throw new TypeError('Invalid source');
     }
-    if (typeof WebAssembly.instantiateStreaming === 'function') {
+    if (typeof _WebAssembly.instantiateStreaming === 'function') {
         try {
-            source = await WebAssembly.instantiateStreaming(fetch(urlOrBuffer), imports);
+            source = await _WebAssembly.instantiateStreaming(fetch(urlOrBuffer), imports);
         }
         catch (_) {
             source = await fetchWasm(urlOrBuffer, imports);
@@ -255,8 +271,8 @@ function loadSync(buffer, imports, asyncify) {
         asyncifyHelper = new Asyncify();
         imports = asyncifyHelper.wrapImports(imports);
     }
-    const module = new WebAssembly.Module(buffer);
-    const instance = new WebAssembly.Instance(module, imports);
+    const module = new _WebAssembly.Module(buffer);
+    const instance = new _WebAssembly.Instance(module, imports);
     const source = { instance, module };
     if (asyncify) {
         const memory = source.instance.exports.memory || ((_a = imports.env) === null || _a === void 0 ? void 0 : _a.memory);
@@ -842,7 +858,9 @@ class FileDescriptorTable {
 }
 
 /** @public */
-class Memory extends WebAssembly.Memory {
+const WebAssemblyMemory = _WebAssembly.Memory;
+/** @public */
+class Memory extends WebAssemblyMemory {
     // eslint-disable-next-line @typescript-eslint/no-useless-constructor
     constructor(descriptor) {
         super(descriptor);
@@ -861,7 +879,7 @@ class Memory extends WebAssembly.Memory {
 }
 /** @public */
 function extendMemory(memory) {
-    if (Object.getPrototypeOf(memory) === WebAssembly.Memory.prototype) {
+    if (Object.getPrototypeOf(memory) === _WebAssembly.Memory.prototype) {
         Object.setPrototypeOf(memory, Memory.prototype);
     }
     return memory;
@@ -972,7 +990,7 @@ function readStdin() {
 class WASI$1 {
     constructor(args, env, preopens, stdio, filesystem, print, printErr) {
         this._setMemory = function _setMemory(m) {
-            if (!(m instanceof WebAssembly.Memory)) {
+            if (!(m instanceof _WebAssembly.Memory)) {
                 throw new TypeError('"instance.exports.memory" property must be a WebAssembly.Memory');
             }
             _memory.set(this, extendMemory(m));
@@ -1279,6 +1297,9 @@ class WASI$1 {
             let buffer;
             let nread = 0;
             if (fd === 0) {
+                if (typeof window === 'undefined' || typeof window.prompt !== 'function') {
+                    return 58 /* WasiErrno.ENOTSUP */;
+                }
                 buffer = readStdin();
                 nread = buffer ? copyMemory(ioVecs, buffer) : 0;
             }
@@ -1876,4 +1897,42 @@ function wasiReturnOnProcExit(rval) {
     throw kExitCode;
 }
 
-export { Asyncify, Memory, WASI, extendMemory, load, loadSync };
+function checkWebAssemblyFunction() {
+    const WebAssemblyFunction = _WebAssembly.Function;
+    if (typeof WebAssemblyFunction !== 'function') {
+        throw new Error('WebAssembly.Function is not supported in this environment.' +
+            ' If you are using V8 based browser like Chrome, try to specify' +
+            ' --js-flag="--wasm-staging --experimental-wasm-stack-switching"');
+    }
+    return WebAssemblyFunction;
+}
+/** @public */
+function wrapAsyncImport(f, parameterType, returnType) {
+    const WebAssemblyFunction = checkWebAssemblyFunction();
+    if (typeof f !== 'function') {
+        throw new TypeError('Function required');
+    }
+    const parameters = parameterType.slice(0);
+    parameters.unshift('externref');
+    return new WebAssemblyFunction({ parameters, results: returnType }, f, { suspending: 'first' });
+}
+/** @public */
+function wrapAsyncExport(f) {
+    const WebAssemblyFunction = checkWebAssemblyFunction();
+    if (typeof f !== 'function') {
+        throw new TypeError('Function required');
+    }
+    return new WebAssemblyFunction({ parameters: [...WebAssemblyFunction.type(f).parameters.slice(1)], results: ['externref'] }, f, { promising: 'first' });
+}
+/** @public */
+function wrapExports(exports, needWrap) {
+    return wrapInstanceExports(exports, (exportValue, name) => {
+        let ignore = typeof exportValue !== 'function';
+        if (Array.isArray(needWrap)) {
+            ignore = ignore || (needWrap.indexOf(name) === -1);
+        }
+        return ignore ? exportValue : wrapAsyncExport(exportValue);
+    });
+}
+
+export { Asyncify, Memory, WASI, WebAssemblyMemory, extendMemory, load, loadSync, wrapAsyncExport, wrapAsyncImport, wrapExports };