@bytecodealliance/jco 1.13.2 → 1.14.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bytecodealliance/jco",
-  "version": "1.13.2",
+  "version": "1.14.0",
   "description": "JavaScript tooling for working with WebAssembly Components",
   "homepage": "https://github.com/bytecodealliance/jco#readme",
   "author": "Guy Bedford",
@@ -67,7 +67,7 @@
   },
   "dependencies": {
     "@bytecodealliance/componentize-js": "^0.18.4",
-    "@bytecodealliance/preview2-shim": "^0.17.2",
+    "@bytecodealliance/preview2-shim": "^0.17.3",
     "binaryen": "^123.0.0",
     "chalk-template": "^1",
     "commander": "^14",
@@ -77,9 +77,9 @@
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^19.8.1",
-    "@types/node": "^24.2.1",
-    "@typescript-eslint/eslint-plugin": "^8.39.0",
-    "@typescript-eslint/parser": "^8.39.0",
+    "@types/node": "^24.3.0",
+    "@typescript-eslint/eslint-plugin": "^8.39.1",
+    "@typescript-eslint/parser": "^8.39.1",
     "commitlint": "^19.8.1",
     "conventional-changelog-conventionalcommits": "^9.1.0",
     "eslint": "^9.33.0",
@@ -87,7 +87,7 @@
     "eslint-plugin-prettier": "^5.5.4",
     "mime": "^4.0.7",
     "prettier": "^3.6.2",
-    "puppeteer": "^24.16.1",
+    "puppeteer": "^24.16.2",
     "semver": "^7.7.1",
     "smol-toml": "^1.4.2",
     "typescript": "^5.9.2",

package/src/cmd/componentize.js

@@ -28,6 +28,7 @@ export async function componentize(jsSource, opts) {
             enableFeatures: opts.enable,
             preview2Adapter: opts.preview2Adapter,
             debugBuild: opts.debugStarlingmonkeyBuild,
+            engine: opts.engine,
             debug: {
                 bindings: opts.debugBindings,
                 bindingsDir: opts.debugBindingsDir,

package/src/cmd/opt.js

@@ -136,7 +136,8 @@ export async function optimizeComponent(componentBytes, opts) {
                             metadata.range[0],
                             metadata.range[1]
                         ),
-                        args
+                        args,
+                        opts
                     );
 
                     // compute the size change, including the change to
@@ -280,13 +281,13 @@ export async function optimizeComponent(componentBytes, opts) {
  * @param {Array<string>} args
  * @returns {Promise<Uint8Array>}
  */
-async function wasmOpt(source, args) {
-    const wasmOptPath = fileURLToPath(
-        import.meta.resolve('binaryen/bin/wasm-opt')
-    );
+async function wasmOpt(source, args, transpileOpts) {
+    const wasmOptBin =
+        transpileOpts?.wasmOptBin ??
+        fileURLToPath(import.meta.resolve('binaryen/bin/wasm-opt'));
 
     try {
-        return await spawnIOTmp(wasmOptPath, source, [...args, '-o']);
+        return await spawnIOTmp(wasmOptBin, source, [...args, '-o']);
     } catch (e) {
         if (e.toString().includes('BasicBlock requested')) {
             return wasmOpt(source, args);

package/src/cmd/transpile.js

@@ -1,6 +1,5 @@
 /* global Buffer */
 
-import { platform } from 'node:process';
 import { extname, basename, resolve } from 'node:path';
 
 import c from 'chalk-template';
@@ -18,13 +17,14 @@ import {
     writeFiles,
     ASYNC_WASI_IMPORTS,
     ASYNC_WASI_EXPORTS,
+    DEFAULT_ASYNC_MODE,
 } from '../common.js';
 import { $init as wasmToolsInit, tools } from '../../obj/wasm-tools.js';
 const { componentEmbed, componentNew } = tools;
 
 import ora from '#ora';
 
-const isWindows = platform === 'win32';
+import { isWindows } from '../common.js';
 
 // These re-exports exist to avoid breaking backwards compatibility
 export { types, guestTypes, typesComponent } from './types.js';
@@ -122,6 +122,7 @@ async function wasm2Js(source) {
  *   multiMemory?: bool,
  *   experimentalIdlImports?: bool,
  *   optArgs?: string[],
+ *   wasmOptBin?: string[],
  * }} opts
  * @returns {Promise<{ files: { [filename: string]: Uint8Array }, imports: string[], exports: [string, 'function' | 'instance'][] }>}
  */
@@ -168,22 +169,36 @@ export async function transpileComponent(component, opts = {}) {
         instantiation = { tag: 'async' };
     }
 
-    const asyncMode =
-        !opts.asyncMode || opts.asyncMode === 'sync'
-            ? null
-            : {
-                  tag: opts.asyncMode,
-                  val: {
-                      imports: opts.asyncImports || [],
-                      exports: opts.asyncExports || [],
-                  },
-              };
+    // Get the configured async mode then transform it into what the types component expects
+    // Build list of async imports/exports
+    let asyncImports = new Set([...(opts.asyncImports ?? [])]);
+    let asyncExports = new Set([...(opts.asyncExports ?? [])]);
+    let asyncMode = opts.asyncMode ?? DEFAULT_ASYNC_MODE;
+    if (asyncMode === 'sync' && asyncExports.size > 0) {
+        throw new Error(
+            'async exports cannot be specified in sync mode (consider removing --async-mode=jspi)'
+        );
+    }
+    let asyncModeObj;
+    if (asyncMode === 'sync') {
+        asyncModeObj = null;
+    } else if (asyncMode === 'jspi') {
+        asyncModeObj = {
+            tag: 'jspi',
+            val: {
+                imports: [...asyncImports],
+                exports: [...asyncExports],
+            },
+        };
+    } else {
+        throw new Error(`invalid/unrecognized async mode [${asyncMode}]`);
+    }
 
     let { files, imports, exports } = generate(component, {
         name: opts.name ?? 'component',
         map: Object.entries(opts.map ?? {}),
         instantiation,
-        asyncMode,
+        asyncMode: asyncModeObj,
         importBindings: opts.importBindings
             ? { tag: opts.importBindings }
             : null,

package/src/cmd/types.js

@@ -1,4 +1,3 @@
-import { platform } from 'node:process';
 import { stat } from 'node:fs/promises';
 import { extname, basename, resolve } from 'node:path';
 
@@ -9,13 +8,13 @@ import {
     generateTypes,
 } from '../../obj/js-component-bindgen-component.js';
 import {
+    isWindows,
     writeFiles,
     ASYNC_WASI_IMPORTS,
     ASYNC_WASI_EXPORTS,
+    DEFAULT_ASYNC_MODE,
 } from '../common.js';
 
-const isWindows = platform === 'win32';
-
 export async function types(witPath, opts) {
     const files = await typesComponent(witPath, opts);
     await writeFiles(files, opts.quiet ? false : 'Generated Type Files');
@@ -47,6 +46,8 @@ export async function guestTypes(witPath, opts) {
  *   features?: string[] | 'all',
  *   asyncWasiImports?: string[],
  *   asyncWasiExports?: string[],
+ *   asyncExports?: string[],
+ *   asyncImports?: string[],
  *   guest?: bool,
  * }} opts
  * @returns {Promise<{ [filename: string]: Uint8Array }>}
@@ -67,6 +68,7 @@ export async function typesComponent(witPath, opts) {
         outDir += '/';
     }
 
+    // Bulid list of enabled features
     let features = null;
     if (opts.allFeatures) {
         features = { tag: 'all' };
@@ -76,24 +78,36 @@ export async function typesComponent(witPath, opts) {
         features = { tag: 'list', val: opts.features };
     }
 
+    // Build list of async imports/exports
+    let asyncImports = new Set([...(opts.asyncImports ?? [])]);
     if (opts.asyncWasiImports) {
-        opts.asyncImports = ASYNC_WASI_IMPORTS.concat(opts.asyncImports || []);
+        ASYNC_WASI_IMPORTS.forEach((v) => asyncImports.add(v));
     }
+    let asyncExports = new Set([...(opts.asyncExports ?? [])]);
     if (opts.asyncWasiExports) {
-        opts.asyncExports = ASYNC_WASI_EXPORTS.concat(opts.asyncExports || []);
+        ASYNC_WASI_EXPORTS.forEach((v) => asyncExports.add(v));
     }
 
-    const asyncMode =
-        !opts.asyncMode || opts.asyncMode === 'sync'
-            ? null
-            : {
-                  tag: opts.asyncMode,
-                  val: {
-                      imports: opts.asyncImports || [],
-                      exports: opts.asyncExports || [],
-                  },
-              };
+    // For simple type generation, we choose the "async mode" for the user
+    // even though it is not relevant here (JSPI may not be used, as types may
+    // be used to generate a guest that is never transpiled).
+    let asyncMode = opts.asyncMode ?? DEFAULT_ASYNC_MODE;
+    let asyncModeObj;
+    if (asyncMode === 'jspi' || asyncExports.size > 0) {
+        asyncModeObj = {
+            tag: 'jspi',
+            val: {
+                imports: [...asyncImports],
+                exports: [...asyncExports],
+            },
+        };
+    } else if (asyncMode === 'sync') {
+        asyncModeObj = null;
+    } else {
+        throw new Error(`invalid/unrecognized async mode [${asyncMode}]`);
+    }
 
+    // Run the type generation
     let types;
     const absWitPath = resolve(witPath);
     try {
@@ -104,7 +118,7 @@ export async function typesComponent(witPath, opts) {
             world: opts.worldName,
             features,
             guest: opts.guest ?? false,
-            asyncMode,
+            asyncMode: asyncModeObj,
         }).map(([name, file]) => [`${outDir}${name}`, file]);
     } catch (err) {
         if (err.toString().includes('does not match previous package name')) {

package/src/common.d.ts

@@ -14,6 +14,7 @@ export function writeFiles(files: any, summaryTitle: any): Promise<void>;
 export const isWindows: boolean;
 export const ASYNC_WASI_IMPORTS: string[];
 export const ASYNC_WASI_EXPORTS: string[];
+export const DEFAULT_ASYNC_MODE: "sync";
 export { readFileCli as readFile };
 declare function readFileCli(file: any, encoding: any): Promise<Buffer<ArrayBufferLike>>;
 //# sourceMappingURL=common.d.ts.map

package/src/common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["common.js"],"names":[],"mappings":"AA4BA,+CAEC;AACD,0CAIC;AAED,0CASC;AAED,mEAcC;AAED,wDAoBC;AAED;;;;GAIG;AACH,6CAEC;AAWD,8FAiCC;AAED,yEAmBC;AArJD,gCAA8C;AAE9C,0CASE;AAEF,0CAGE;;AAsEF,yFAMC"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["common.js"],"names":[],"mappings":"AA8BA,+CAEC;AACD,0CAIC;AAED,0CASC;AAED,mEAcC;AAED,wDAoBC;AAED;;;;GAIG;AACH,6CAEC;AAWD,8FAiCC;AAED,yEAmBC;AAvJD,gCAA8C;AAE9C,0CASE;AAEF,0CAGE;AAEF,iCAAkC,MAAM,CAAC;;AAsEzC,yFAMC"}

package/src/common.js

@@ -25,6 +25,8 @@ export const ASYNC_WASI_EXPORTS = [
     'wasi:http/incoming-handler#handle',
 ];
 
+export const DEFAULT_ASYNC_MODE = 'sync';
+
 let _showSpinner = false;
 export function setShowSpinner(val) {
     _showSpinner = val;

package/src/jco.js

@@ -25,7 +25,7 @@ program
     )
     .usage('<command> [options]')
     .enablePositionalOptions()
-    .version('1.13.2');
+    .version('1.14.0');
 
 function myParseInt(value) {
     return parseInt(value, 10);
@@ -69,6 +69,7 @@ program
         '--debug-starlingmonkey-build',
         'use a debug build of StarlingMonkey'
     )
+    .option('--engine <path>', 'use a specific StarlingMonkey build')
     .requiredOption('-o, --out <out>', 'output component file')
     .option(
         '--debug-bindings',
@@ -223,7 +224,7 @@ program
     )
     .option(
         '--async-exports <exports...>',
-        'EXPERIMENTAL: async component exports (examples: "wasi:cli/run@#run", "handle")'
+        'EXPERIMENTAL: async component exports (examples: "ns:pkg/iface#func", "wasi:cli/run@0.2.3#run", "handle")'
     )
     .option('-q, --quiet', 'disable output summary')
     .option(
@@ -233,6 +234,9 @@ program
         []
     )
     .option('--all-features', 'enable all features')
+    .option(
+        "--wasm-opt-bin <path-to-wasm-opt>', 'wasm-opt binary path (default: 'binaryen/bin/wasm-opt')"
+    )
     .action(asyncAction(types));
 
 program
@@ -251,6 +255,18 @@ program
         []
     )
     .option('--all-features', 'enable all features')
+    .option(
+        '--async-exports <exports...>',
+        'EXPERIMENTAL: generate async exports (examples: "ns:pkg/iface#func", "wasi:cli/run@0.2.3#run", "handle")'
+    )
+    .addOption(
+        new Option(
+            '--async-mode [mode]',
+            'EXPERIMENTAL: use async imports and exports'
+        )
+            .choices(['sync', 'jspi'])
+            .preset('sync')
+    )
     .action(asyncAction(guestTypes));
 
 program
@@ -344,6 +360,9 @@ program
     )
     .option('--asyncify', 'runs Asyncify pass in wasm-opt')
     .option('-q, --quiet')
+    .option(
+        "--wasm-opt-bin <path-to-wasm-opt>', 'wasm-opt binary path (default: 'binaryen/bin/wasm-opt')"
+    )
     .allowExcessArguments(true)
     .action(asyncAction(opt));