@bytecodealliance/jco 0.14.1 → 1.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bytecodealliance/jco",
-  "version": "0.14.1",
+  "version": "1.0.0",
   "description": "JavaScript tooling for working with WebAssembly Components",
   "author": "Guy Bedford",
   "bin": {
@@ -18,7 +18,7 @@
   },
   "type": "module",
   "dependencies": {
-    "@bytecodealliance/preview2-shim": "0.14.1",
+    "@bytecodealliance/preview2-shim": "0.15.1",
     "binaryen": "^111.0.0",
     "chalk-template": "^0.4.0",
     "commander": "^9.4.1",
@@ -27,14 +27,14 @@
     "terser": "^5.16.1"
   },
   "devDependencies": {
-    "@bytecodealliance/componentize-js": "^0.5.0",
+    "@bytecodealliance/componentize-js": "^0.6.0",
     "@types/node": "^18.11.17",
     "@typescript-eslint/eslint-plugin": "^5.41.0",
     "@typescript-eslint/parser": "^5.41.0",
     "eslint": "^8.30.0",
     "mocha": "^10.2.0",
     "terser": "^5.16.1",
-    "typescript": "^4.3.2"
+    "typescript": "^5.3.3"
   },
   "repository": {
     "type": "git",

package/src/api.d.ts

@@ -2,39 +2,39 @@
  * @param {Parameters<import('../obj/wasm-tools.js').print>[0]} binary
  * @return {Promise<ReturnType<import('../obj/wasm-tools.js').print>>}
  */
-export function print(binary: Parameters<import('../obj/wasm-tools.js').print>[0]): Promise<ReturnType<import('../obj/wasm-tools.js').print>>;
+export function print(binary: any): Promise<ReturnType<import('../obj/wasm-tools.js').print>>;
 /**
  * @param {Parameters<import('../obj/wasm-tools.js').parse>[0]} wat
  * @return {Promise<ReturnType<import('../obj/wasm-tools.js').parse>>}
  */
-export function parse(wat: Parameters<import('../obj/wasm-tools.js').parse>[0]): Promise<ReturnType<import('../obj/wasm-tools.js').parse>>;
+export function parse(wat: any): Promise<ReturnType<import('../obj/wasm-tools.js').parse>>;
 /**
  * @param {Parameters<import('../obj/wasm-tools.js').componentWit>[0]} binary
  * @return {Promise<ReturnType<import('../obj/wasm-tools.js').componentWit>>}
  */
-export function componentWit(binary: Parameters<import('../obj/wasm-tools.js').componentWit>[0]): Promise<ReturnType<import('../obj/wasm-tools.js').componentWit>>;
+export function componentWit(binary: any): Promise<ReturnType<import('../obj/wasm-tools.js').componentWit>>;
 /**
  * @param {Parameters<import('../obj/wasm-tools.js').componentNew>[0]} binary
  * @param {Parameters<import('../obj/wasm-tools.js').componentNew>[1]} adapters
  * @return {Promise<ReturnType<import('../obj/wasm-tools.js').componentNew>>}
  */
-export function componentNew(binary: Parameters<import('../obj/wasm-tools.js').componentNew>[0], adapters: Parameters<import('../obj/wasm-tools.js').componentNew>[1]): Promise<ReturnType<import('../obj/wasm-tools.js').componentNew>>;
+export function componentNew(binary: any, adapters: any): Promise<ReturnType<import('../obj/wasm-tools.js').componentNew>>;
 /**
  * @param {Parameters<import('../obj/wasm-tools.js').componentEmbed>[0]} embedOpts
  * @return {Promise<ReturnType<import('../obj/wasm-tools.js').componentEmbed>>}
  */
-export function componentEmbed(embedOpts: Parameters<import('../obj/wasm-tools.js').componentEmbed>[0]): Promise<ReturnType<import('../obj/wasm-tools.js').componentEmbed>>;
+export function componentEmbed(embedOpts: any): Promise<ReturnType<import('../obj/wasm-tools.js').componentEmbed>>;
 /**
  * @param {Parameters<import('../obj/wasm-tools.js').metadataAdd>[0]} binary
  * @param {Parameters<import('../obj/wasm-tools.js').metadataAdd>[1]} metadata
  * @return {Promise<ReturnType<import('../obj/wasm-tools.js').metadataAdd>>}
  */
-export function metadataAdd(binary: Parameters<import('../obj/wasm-tools.js').metadataAdd>[0], metadata: Parameters<import('../obj/wasm-tools.js').metadataAdd>[1]): Promise<ReturnType<import('../obj/wasm-tools.js').metadataAdd>>;
+export function metadataAdd(binary: any, metadata: any): Promise<ReturnType<import('../obj/wasm-tools.js').metadataAdd>>;
 /**
  * @param {Parameters<import('../obj/wasm-tools.js').metadataShow>[0]} binary
  * @return {Promise<ReturnType<import('../obj/wasm-tools.js').metadataShow>>}
  */
-export function metadataShow(binary: Parameters<import('../obj/wasm-tools.js').metadataShow>[0]): Promise<ReturnType<import('../obj/wasm-tools.js').metadataShow>>;
+export function metadataShow(binary: any): Promise<ReturnType<import('../obj/wasm-tools.js').metadataShow>>;
 export function preview1AdapterCommandPath(): URL;
 export function preview1AdapterReactorPath(): URL;
 export { optimizeComponent as opt } from "./cmd/opt.js";

package/src/api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["api.js"],"names":[],"mappings":"AAKA;;;GAGG;AACH,8BAHW,WAAW,OAAO,sBAAsB,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,GAClD,QAAQ,WAAW,OAAO,sBAAsB,EAAE,KAAK,CAAC,CAAC,CAKpE;AACD;;;GAGG;AACH,2BAHW,WAAW,OAAO,sBAAsB,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,GAClD,QAAQ,WAAW,OAAO,sBAAsB,EAAE,KAAK,CAAC,CAAC,CAKpE;AACD;;;GAGG;AACH,qCAHW,WAAW,OAAO,sBAAsB,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,GACzD,QAAQ,WAAW,OAAO,sBAAsB,EAAE,YAAY,CAAC,CAAC,CAK3E;AACD;;;;GAIG;AACH,qCAJW,WAAW,OAAO,sBAAsB,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,YAC1D,WAAW,OAAO,sBAAsB,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,GACzD,QAAQ,WAAW,OAAO,sBAAsB,EAAE,YAAY,CAAC,CAAC,CAK3E;AACD;;;GAGG;AACH,0CAHW,WAAW,OAAO,sBAAsB,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,GAC3D,QAAQ,WAAW,OAAO,sBAAsB,EAAE,cAAc,CAAC,CAAC,CAK7E;AACD;;;;GAIG;AACH,oCAJW,WAAW,OAAO,sBAAsB,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,YACzD,WAAW,OAAO,sBAAsB,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,GACxD,QAAQ,WAAW,OAAO,sBAAsB,EAAE,WAAW,CAAC,CAAC,CAK1E;AACD;;;GAGG;AACH,qCAHW,WAAW,OAAO,sBAAsB,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,GACzD,QAAQ,WAAW,OAAO,sBAAsB,EAAE,YAAY,CAAC,CAAC,CAK3E;AACD,kDAEC;AACD,kDAEC"}
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["api.js"],"names":[],"mappings":"AAKA;;;GAGG;AACH,oCAFY,QAAQ,WAAW,OAAO,sBAAsB,EAAE,KAAK,CAAC,CAAC,CAKpE;AACD;;;GAGG;AACH,iCAFY,QAAQ,WAAW,OAAO,sBAAsB,EAAE,KAAK,CAAC,CAAC,CAKpE;AACD;;;GAGG;AACH,2CAFY,QAAQ,WAAW,OAAO,sBAAsB,EAAE,YAAY,CAAC,CAAC,CAK3E;AACD;;;;GAIG;AACH,0DAFY,QAAQ,WAAW,OAAO,sBAAsB,EAAE,YAAY,CAAC,CAAC,CAK3E;AACD;;;GAGG;AACH,gDAFY,QAAQ,WAAW,OAAO,sBAAsB,EAAE,cAAc,CAAC,CAAC,CAK7E;AACD;;;;GAIG;AACH,yDAFY,QAAQ,WAAW,OAAO,sBAAsB,EAAE,WAAW,CAAC,CAAC,CAK1E;AACD;;;GAGG;AACH,2CAFY,QAAQ,WAAW,OAAO,sBAAsB,EAAE,YAAY,CAAC,CAAC,CAK3E;AACD,kDAEC;AACD,kDAEC"}

package/src/cmd/run.d.ts

@@ -1,2 +1,3 @@
 export function run(componentPath: any, args: any, opts: any): Promise<void>;
+export function serve(componentPath: any, args: any, opts: any): Promise<void>;
 //# sourceMappingURL=run.d.ts.map

package/src/cmd/run.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["run.js"],"names":[],"mappings":"AASA,6EA+FC"}
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["run.js"],"names":[],"mappings":"AASA,6EAmBC;AAED,+EA2BC"}

package/src/cmd/run.js

@@ -10,7 +10,54 @@ import c from 'chalk-template';
 export async function run (componentPath, args, opts) {
   // Ensure that `args` is an array
   args = [...args];
+  return runComponent(componentPath, args, opts, `
+    if (!mod.run || !mod.run.run) {
+      console.error('Not a valid command component to execute.');
+      process.exit(1);
+    }
+    try {
+      mod.run.run();
+      // for stdout flushing
+      await new Promise(resolve => setTimeout(resolve));
+      process.exit(0);
+    }
+    catch (e) {
+      console.error(e);
+      process.exit(1);
+    }
+  `);
+}
+
+export async function serve (componentPath, args, opts) {
+  let tryFindPort = false;
+  let { port, host } = opts;
+  if (port === undefined) {
+    tryFindPort = true;
+    port = '8000';
+  }
+  // Ensure that `args` is an array
+  args = [...args];
+  return runComponent(componentPath, args, opts, `
+    import { HTTPServer } from '@bytecodealliance/preview2-shim/http';
+    const server = new HTTPServer(mod.incomingHandler);
+    ${tryFindPort ? `
+    let port = ${port};
+    while (true) {
+      try {
+        server.listen(port, ${JSON.stringify(host)});
+        break;
+      } catch (e) {
+        if (e.code !== 'EADDRINUSE')
+          throw e;
+      }
+      port++;
+    }
+    ` : `server.listen(${port}, ${JSON.stringify(host)})`}
+    console.error(\`Server listening on \${port}...\`);
+  `);
+}
 
+async function runComponent (componentPath, args, opts, executor) {
   const jcoImport = opts.jcoImport ? resolve(opts.jcoImport) : null;
 
   const name = basename(componentPath.slice(0, -extname(componentPath).length || Infinity));
@@ -18,6 +65,7 @@ export async function run (componentPath, args, opts) {
   if (opts.jcoDir) {
     await mkdir(outDir, { recursive: true });
   }
+
   try {
     try {
       await transpile(componentPath, {
@@ -26,7 +74,8 @@ export async function run (componentPath, args, opts) {
         noTypescript: true,
         wasiShim: true,
         outDir,
-        tracing: opts.jcoTrace
+        tracing: opts.jcoTrace,
+        map: opts.jcoMap
       });
     }
     catch (e) {
@@ -63,30 +112,11 @@ export async function run (componentPath, args, opts) {
     const runPath = resolve(outDir, '_run.js');
     await writeFile(runPath, `
       ${jcoImport ? `import ${JSON.stringify(pathToFileURL(jcoImport))}` : ''}
-      function logInvalidCommand () {
-        console.error('Not a valid command component to execute, make sure it was built to a command adapter and with the same version.');
-      }
       try {
         process.argv[1] = "${name}";
-        const mod = await import('./${name}.js');
-        if (!mod.run || !mod.run.run) {
-          logInvalidCommand();
-          process.exit(1);
-        }
-        try {
-          mod.run.run();
-          // TODO: figure out stdout flush!
-          setTimeout(() => {});
-        }
-        catch (e) {
-          console.error(e);
-          process.exit(1);
-        }
-      }
-      catch (e) {
-        logInvalidCommand();
-        throw e;
-      }
+      } catch {}
+      const mod = await import('./${name}.js');
+      ${executor}
     `);
 
     process.exitCode = await new Promise((resolve, reject) => {
@@ -102,4 +132,4 @@ export async function run (componentPath, args, opts) {
         await rm(outDir, { recursive: true });
     } catch {}
   }
-}
+}

package/src/cmd/transpile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transpile.d.ts","sourceRoot":"","sources":["transpile.js"],"names":[],"mappings":"AAWA,sFA2BC;AAuBD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,8CAlBW,UAAU;UAEV,MAAM;oBACI,OAAO,GAAG,MAAM;UAC1B,OAAO,MAAM,EAAE,MAAM,CAAC;;;;;;;;;;cAUlB,MAAM,EAAE;;;;;aAEoD,MAAM,EAAE;aAAW,CAAC,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC,EAAE;GAmShI"}
+{"version":3,"file":"transpile.d.ts","sourceRoot":"","sources":["transpile.js"],"names":[],"mappings":"AAgBA,sFAqCC;AAuBD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,8CAlBW,UAAU;UAEV,MAAM;oBACI,OAAO,GAAG,MAAM;UAC1B,OAAO,MAAM,EAAE,MAAM,CAAC;;;;;;;;;;cAUlB,MAAM,EAAE;;;;;aAEoD,MAAM,EAAE;aAAW,CAAC,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC,EAAE;GAiShI"}

package/src/cmd/transpile.js

@@ -1,19 +1,34 @@
 import { $init, generate } from '../../obj/js-component-bindgen-component.js';
-import { writeFile } from 'fs/promises';
-import { mkdir } from 'fs/promises';
-import { dirname, extname, basename } from 'path';
+import { writeFile } from 'node:fs/promises';
+import { mkdir } from 'node:fs/promises';
+import { dirname, extname, basename, resolve } from 'node:path';
 import c from 'chalk-template';
 import { readFile, sizeStr, table, spawnIOTmp, setShowSpinner, getShowSpinner } from '../common.js';
 import { optimizeComponent } from './opt.js';
 import { minify } from 'terser';
 import { fileURLToPath } from 'url';
+import { $init as wasmToolsInit, tools } from "../../obj/wasm-tools.js";
+const { componentEmbed, componentNew } = tools;
 import ora from '#ora';
+import { platform } from 'node:process';
+
+const isWindows = platform === 'win32';
 
 export async function transpile (componentPath, opts, program) {
   const varIdx = program?.parent.rawArgs.indexOf('--');
   if (varIdx !== undefined && varIdx !== -1)
     opts.optArgs = program.parent.rawArgs.slice(varIdx + 1);
-  const component = await readFile(componentPath);
+
+  let component;
+  if (!opts.stub) {
+    component = await readFile(componentPath);
+  } else {
+    await wasmToolsInit;
+    component = componentNew(componentEmbed({
+      dummy: true,
+      witPath: (isWindows ? '//?/' : '') + resolve(componentPath)
+    }), []);
+  }
 
   if (!opts.quiet)
     setShowSpinner(true);
@@ -81,7 +96,7 @@ async function wasm2Js (source) {
  */
 export async function transpileComponent (component, opts = {}) {
   await $init;
-  if (opts.noWasiShim || opts.instantiation) opts.wasiShim = false;
+  if (opts.instantiation) opts.wasiShim = false;
 
   let spinner;
   const showSpinner = getShowSpinner();
@@ -119,8 +134,8 @@ export async function transpileComponent (component, opts = {}) {
     instantiation,
     validLiftingOptimization: opts.validLiftingOptimization ?? false,
     tracing: opts.tracing ?? false,
-    noNodejsCompat: !(opts.nodejsCompat ?? true),
-    noTypescript: opts.noTypescript || false,
+    noNodejsCompat: opts.nodejsCompat === false,
+    noTypescript: opts.typescript === false,
     tlaCompat: opts.tlaCompat ?? false,
     base64Cutoff: opts.js ? 0 : opts.base64Cutoff ?? 5000,
     noNamespacedExports: opts.namespacedExports === false,

package/src/cmd/wasm-tools.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"wasm-tools.d.ts","sourceRoot":"","sources":["wasm-tools.js"],"names":[],"mappings":"AAQA,2DAKC;AAED,2DASC;AAED,kEASC;AAED,kEAsBC;AAED,oEAaC;AAED,iEAUC;AAED,kEAiCC"}
+{"version":3,"file":"wasm-tools.d.ts","sourceRoot":"","sources":["wasm-tools.js"],"names":[],"mappings":"AAOA,2DAKC;AAED,2DASC;AAED,kEASC;AAED,kEAsBC;AAED,oEAaC;AAED,iEAUC;AAED,kEAiCC"}

package/src/cmd/wasm-tools.js

@@ -4,7 +4,6 @@ import { $init, tools } from "../../obj/wasm-tools.js";
 const { print: printFn, parse: parseFn, componentWit: componentWitFn, componentNew: componentNewFn, componentEmbed: componentEmbedFn, metadataAdd: metadataAddFn, metadataShow: metadataShowFn } = tools;
 import { resolve, basename, extname } from 'node:path';
 import c from 'chalk-template';
-import { platform } from 'node:process';
 
 export async function parse(file, opts) {
   await $init;

package/src/jco.js

@@ -2,7 +2,7 @@
 import { program, Option } from 'commander';
 import { opt } from './cmd/opt.js';
 import { transpile } from './cmd/transpile.js';
-import { run } from './cmd/run.js';
+import { run as runCmd, serve as serveCmd } from './cmd/run.js';
 import { parse, print, componentNew, componentEmbed, metadataAdd, metadataShow, componentWit } from './cmd/wasm-tools.js';
 import { componentize } from './cmd/componentize.js';
 import c from 'chalk-template';
@@ -11,7 +11,7 @@ program
   .name('jco')
   .description(c`{bold jco - WebAssembly JS Component Tools}\n      JS Component Transpilation Bindgen & Wasm Tools for JS`)
   .usage('<command> [options]')
-  .version('0.14.1');
+  .version('1.0.0');
 
 function myParseInt(value) {
   return parseInt(value, 10);
@@ -19,7 +19,7 @@ function myParseInt(value) {
 
 program.command('componentize')
   .description('Create a component from a JavaScript module')
-  .usage('<js-source> -o <component-path>')
+  .usage('<js-source> --wit wit-world.wit -o <component-path>')
   .argument('<js-source>', 'JS source file to build')
   .requiredOption('-w, --wit <path>', 'WIT path to build with')
   .option('-n, --world-name <name>', 'WIT world to build')
@@ -44,6 +44,7 @@ program.command('transpile')
   .option('--no-nodejs-compat', 'disables compatibility in Node.js without a fetch global')
   .option('-M, --map <mappings...>', 'specifier=./output custom mappings for the component imports')
   .option('--no-wasi-shim', 'disable automatic rewriting of WASI imports to use @bytecodealliance/preview2-shim')
+  .option('--stub', 'generate a stub implementation from a WIT file directly')
   .option('--js', 'output JS instead of core WebAssembly')
   .addOption(new Option('-I, --instantiation [mode]', 'output for custom module instantiation').choices(['async', 'sync']).preset('async'))
   .option('-q, --quiet', 'disable logging')
@@ -52,15 +53,48 @@ program.command('transpile')
   .action(asyncAction(transpile));
 
 program.command('run')
-  .description('Run a WebAssembly Command component')
+  .description('Run a WASI Command component')
   .usage('<command.wasm> <args...>')
   .helpOption(false)
-  .argument('<command>', 'Wasm command binary to run')
+  .allowUnknownOption(true)
+  .allowExcessArguments(true)
+  .argument('<command>', 'WASI command binary to run')
   .option('--jco-dir <dir>', 'Instead of using a temporary dir, set the output directory for the run command')
   .option('--jco-trace', 'Enable call tracing')
   .option('--jco-import <module>', 'Custom module to import before the run executes to support custom environment setup')
-  .argument('[args...]', 'Any CLI arguments to provide to the command')
-  .action(asyncAction(run));
+  .option('--jco-map <mappings...>', 'specifier=./output custom mappings for the component imports')
+  .argument('[args...]', 'Any CLI arguments for the component')
+  .action(asyncAction(async function run (cmd, args, opts, command) {
+    // specially only allow help option in first position
+    if (cmd === '--help' || cmd === '-h') {
+      command.help();
+    } else {
+      return runCmd(cmd, args, opts);
+    }
+  }));
+
+program.command('serve')
+  .description('Serve a WASI HTTP component')
+  .usage('<server.wasm> <args...>')
+  .helpOption(false)
+  .allowUnknownOption(true)
+  .allowExcessArguments(true)
+  .argument('<server>', 'WASI server binary to run')
+  .option('--port <number>')
+  .option('--host <host>')
+  .option('--jco-dir <dir>', 'Instead of using a temporary dir, set the output directory for the transpiled code')
+  .option('--jco-trace', 'Enable call tracing')
+  .option('--jco-import <module>', 'Custom module to import before the server executes to support custom environment setup')
+  .option('--jco-map <mappings...>', 'specifier=./output custom mappings for the component imports')
+  .argument('[args...]', 'Any CLI arguments for the component')
+  .action(asyncAction(async function serve (cmd, args, opts, command) {
+    // specially only allow help option in first position
+    if (cmd === '--help' || cmd === '-h') {
+      command.help();
+    } else {
+      return serveCmd(cmd, args, opts);
+    }
+  }));
 
 program.command('opt')
   .description('optimizes a Wasm component, including running wasm-opt Binaryen optimizations')
@@ -124,6 +158,8 @@ program.command('embed')
   .option('-m, --metadata <metadata...>', 'field=name[@version] producer metadata to add with the embedding')
   .action(asyncAction(componentEmbed));
 
+program.showHelpAfterError();
+
 program.parse();
 
 function asyncAction (cmd) {

package/obj/interfaces/wasi-sockets-tcp.d.ts

@@ -1,6 +0,0 @@
-export namespace WasiSocketsTcp {
-  export { TcpSocket };
-}
-
-export class TcpSocket {
-}