@bytecodealliance/jco 0.10.3 → 0.11.1

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "@bytecodealliance/jco",
-  "version": "0.10.3",
+  "version": "0.11.1",
   "description": "JavaScript tooling for working with WebAssembly Components",
   "author": "Guy Bedford",
   "bin": {
     "jco": "src/jco.js"
   },
-  "exports": "./src/api.js",
+  "exports": {
+    "browser": "./src/browser.js",
+    "default": "./src/api.js"
+  },
   "imports": {
     "#ora": {
       "browser": "./src/ora-shim.js",
@@ -15,7 +18,7 @@
   },
   "type": "module",
   "dependencies": {
-    "@bytecodealliance/preview2-shim": "0.0.12",
+    "@bytecodealliance/preview2-shim": "0.0.14",
     "binaryen": "^111.0.0",
     "chalk-template": "^0.4.0",
     "commander": "^9.4.1",
@@ -24,7 +27,7 @@
     "terser": "^5.16.1"
   },
   "devDependencies": {
-    "@bytecodealliance/componentize-js": "^0.1.1",
+    "@bytecodealliance/componentize-js": "^0.2.0",
     "@types/node": "^18.11.17",
     "@typescript-eslint/eslint-plugin": "^5.41.0",
     "@typescript-eslint/parser": "^5.41.0",

package/src/api.js

@@ -1,6 +1,7 @@
 export { optimizeComponent as opt } from './cmd/opt.js';
 export { transpileComponent as transpile } from './cmd/transpile.js';
-import { $init, print as printFn, parse as parseFn, componentWit as componentWitFn, componentNew as componentNewFn, componentEmbed as componentEmbedFn, metadataAdd as metadataAddFn, metadataShow as metadataShowFn } from "../obj/wasm-tools.js";
+import { $init, tools } from "../obj/wasm-tools.js";
+const { print: printFn, parse: parseFn, componentWit: componentWitFn, componentNew: componentNewFn, componentEmbed: componentEmbedFn, metadataAdd: metadataAddFn, metadataShow: metadataShowFn } = tools;
 
 /**
  * @param {Parameters<import('../obj/wasm-tools.js').print>[0]} binary

package/src/browser.js

@@ -0,0 +1,3 @@
+import { $init, generate, generateTypes } from '../obj/js-component-bindgen-component.js';
+await $init;
+export { generate as transpile, generateTypes }

package/src/cmd/opt.js

@@ -1,4 +1,5 @@
-import { $init, metadataShow, print } from '../../obj/wasm-tools.js';
+import { $init, tools } from '../../obj/wasm-tools.js';
+const { metadataShow, print } = tools;
 import { writeFile } from 'fs/promises';
 import { fileURLToPath } from 'url';
 import c from 'chalk-template';

package/src/cmd/run.js

@@ -0,0 +1,103 @@
+import { transpile } from './transpile.js';
+import { tmpdir } from 'node:os';
+import { rm, stat, mkdir, writeFile, symlink, chmod } from 'node:fs/promises';
+import { basename, resolve, extname } from 'node:path';
+import { spawn } from 'node:child_process';
+import { argv0, exit } from 'node:process';
+import { fileURLToPath } from 'node:url';
+import * as crypto from 'node:crypto';
+import c from 'chalk-template';
+
+function getTmpDir (name) {
+  return resolve(tmpdir(), crypto.createHash('sha256').update(name).update(Math.random().toString()).digest('hex'));
+}
+
+export async function run (componentPath, args) {
+  const name = basename(componentPath.slice(0, -extname(componentPath).length || Infinity));
+  const outDir = resolve(getTmpDir(name));
+  let cp;
+  try {
+    try {
+      await transpile(componentPath, {
+        name,
+        quiet: true,
+        noTypescript: true,
+        wasiShim: true,
+        outDir
+      });
+    }
+    catch (e) {
+      console.error(c`{red ERR}: Unable to transpile command for execution`);
+      throw e;
+    }
+
+    await mkdir(resolve(outDir, 'node_modules', '@bytecodealliance'), { recursive: true });
+    await writeFile(resolve(outDir, 'package.json'), JSON.stringify({ type: 'module' }));
+
+    let preview2ShimPath = fileURLToPath(new URL('../../node_modules/@bytecodealliance/preview2-shim', import.meta.url));
+    while (true) {
+      try {
+        if ((await stat(preview2ShimPath)).isDirectory()) {
+          break;
+        }
+      }
+      catch {}
+      let len = preview2ShimPath.length;
+      preview2ShimPath = resolve(preview2ShimPath, '../../../node_modules/@bytecodealliance/preview2-shim');
+      if (preview2ShimPath.length === len) {
+        console.error(c`{red ERR}: Unable to locate the {bold @bytecodealliance/preview2-shim} package, make sure it is installed.`);
+        return;
+      }
+    }
+
+    await symlink(preview2ShimPath, resolve(outDir, 'node_modules/@bytecodealliance/preview2-shim'), 'dir');
+
+    const runPath = resolve(outDir, '_run.js');
+    await writeFile(runPath, `
+      import { _setEnv, _setArgs, _setCwd } from '@bytecodealliance/preview2-shim/cli';
+      _setArgs(process.argv.slice(1));
+      _setEnv(process.env);
+      _setCwd(process.cwd());
+      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 {
+        const mod = await import('./${name}.js');
+        if (!mod.run || !mod.run.run) {
+          logInvalidCommand();
+          process.exit(1);
+        }
+        try {
+          mod.run.run();
+        }
+        catch (e) {
+          console.error(e);
+          process.exit(1);
+        }
+      }
+      catch (e) {
+        logInvalidCommand();
+        throw e;
+      }
+    `);
+    await chmod(runPath, 0o777);
+
+    cp = spawn(argv0, [runPath, ...args], { stdio: 'inherit' });
+  }
+  finally {
+    if (!cp) {
+      try {
+        await rm(outDir, { recursive: true });
+      } catch {}
+    }
+  }
+
+  const exitCode = await new Promise((resolve, reject) => {
+    cp.on('error', reject);
+    cp.on('exit', resolve);
+  });
+  try {
+    await rm(outDir, { recursive: true });
+  } catch {}
+  exit(exitCode);
+}

package/src/cmd/transpile.js

@@ -10,8 +10,8 @@ import { fileURLToPath } from 'url';
 import ora from '#ora';
 
 export async function transpile (componentPath, opts, program) {
-  const varIdx = program.parent.rawArgs.indexOf('--');
-  if (varIdx !== -1)
+  const varIdx = program?.parent.rawArgs.indexOf('--');
+  if (varIdx !== undefined && varIdx !== -1)
     opts.optArgs = program.parent.rawArgs.slice(varIdx + 1);
   const component = await readFile(componentPath);
 
@@ -90,7 +90,7 @@ export async function transpileComponent (component, opts = {}) {
 
   if (opts.wasiShim !== false) {
     opts.map = Object.assign({
-      'wasi:cli-base/*': '@bytecodealliance/preview2-shim/cli-base#*',
+      'wasi:cli/*': '@bytecodealliance/preview2-shim/cli#*',
       'wasi:clocks/*': '@bytecodealliance/preview2-shim/clocks#*',
       'wasi:filesystem/*': '@bytecodealliance/preview2-shim/filesystem#*',
       'wasi:http/*': '@bytecodealliance/preview2-shim/http#*',
@@ -108,6 +108,7 @@ export async function transpileComponent (component, opts = {}) {
     instantiation: opts.instantiation || opts.js,
     validLiftingOptimization: opts.validLiftingOptimization ?? false,
     noNodejsCompat: !(opts.nodejsCompat ?? true),
+    noTypescript: opts.noTypescript || false,
     tlaCompat: opts.tlaCompat ?? false,
     base64Cutoff: opts.js ? 0 : opts.base64Cutoff ?? 5000
   });

package/src/cmd/wasm-tools.js

@@ -1,6 +1,7 @@
 import { writeFile } from "node:fs/promises";
 import { readFile } from '../common.js';
-import { $init, print as printFn, parse as parseFn, componentWit as componentWitFn, componentNew as componentNewFn, componentEmbed as componentEmbedFn, metadataAdd as metadataAddFn, metadataShow as metadataShowFn } from "../../obj/wasm-tools.js";
+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';
 
@@ -37,8 +38,14 @@ export async function componentNew(file, opts) {
   await $init;
   const source = file ? await readFile(file) : null;
   let adapters = null;
+  if (opts.wasiReactor && opts.wasiCommand)
+    throw new Error('Must select one of --wasi-command or --wasi-reactor');
+  if (opts.wasiReactor)
+    adapters = [['wasi_snapshot_preview1', (await readFile(new URL('../../lib/wasi_snapshot_preview1.reactor.wasm', import.meta.url))).buffer]];
+  else if (opts.wasiCommand)
+    adapters = [['wasi_snapshot_preview1', (await readFile(new URL('../../lib/wasi_snapshot_preview1.command.wasm', import.meta.url))).buffer]];
   if (opts.adapt)
-    adapters = await Promise.all(opts.adapt.map(async adapt => {
+    adapters = adapters.concat(await Promise.all(opts.adapt.map(async adapt => {
       let adapter;
       if (adapt.includes('='))
         adapter = adapt.split('=');
@@ -46,7 +53,7 @@ export async function componentNew(file, opts) {
         adapter = [basename(adapt).slice(0, -extname(adapt).length), adapt];
       adapter[1] = await readFile(adapter[1]);
       return adapter;
-    }));
+    })));
   const output = componentNewFn(source, adapters);
   await writeFile(opts.output, output);
 }

package/src/jco.js

@@ -2,6 +2,7 @@
 import { program } from 'commander';
 import { opt } from './cmd/opt.js';
 import { transpile } from './cmd/transpile.js';
+import { run } 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';
@@ -10,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.10.3');
+  .version('0.11.0');
 
 function myParseInt(value) {
   return parseInt(value, 10);
@@ -47,6 +48,13 @@ program.command('transpile')
   .option('--', 'for --optimize, custom wasm-opt arguments (defaults to best size optimization)')
   .action(asyncAction(transpile));
 
+  program.command('run')
+  .description('Run a WebAssembly Command component')
+  .usage('<command.wasm> <args...>')
+  .argument('<command>', 'Wasm command binary to run')
+  .argument('[args...]', 'Any CLI arguments to provide to the command')
+  .action(asyncAction(run));
+
 program.command('opt')
   .description('optimizes a Wasm component, including running wasm-opt Binaryen optimizations')
   .usage('<component-file> -o <output-file>')
@@ -94,6 +102,8 @@ program.command('new')
   .requiredOption('-o, --output <output-file>', 'Wasm component output filepath')
   .option('--name <name>', 'custom output name')
   .option('--adapt <[NAME=]adapter...>', 'component adapters to apply')
+  .option('--wasi-reactor', 'build with the WASI Reactor adapter')
+  .option('--wasi-command', 'build with the WASI Command adapter')
   .action(asyncAction(componentNew));
 
 program.command('embed')

package/obj/imports/wasi-cli-base-exit.d.ts

@@ -1,4 +0,0 @@
-export namespace WasiCliBaseExit {
-  export function exit(status: Result<void, void>): void;
-}
-export type Result<T, E> = { tag: 'ok', val: T } | { tag: 'err', val: E };

package/obj/imports/wasi-cli-base-preopens.d.ts

@@ -1,5 +0,0 @@
-export namespace WasiCliBasePreopens {
-  export function getDirectories(): [Descriptor, string][];
-}
-import type { Descriptor } from '../imports/wasi-filesystem-filesystem';
-export { Descriptor };

package/obj/interfaces/preopens.d.ts

@@ -1,5 +0,0 @@
-export namespace Preopens {
-  export function getDirectories(): [Descriptor, string][];
-}
-import type { Descriptor } from '../interfaces/wasi-filesystem-filesystem';
-export { Descriptor };

package/obj/interfaces/random.d.ts

@@ -1,3 +0,0 @@
-export namespace Random {
-  export function getRandomBytes(len: bigint): Uint8Array | ArrayBuffer;
-}

package/obj/interfaces/stderr.d.ts

@@ -1,5 +0,0 @@
-export namespace Stderr {
-  export function getStderr(): OutputStream;
-}
-import type { OutputStream } from '../interfaces/wasi-io-streams';
-export { OutputStream };

package/obj/interfaces/stdin.d.ts

@@ -1,5 +0,0 @@
-export namespace Stdin {
-  export function getStdin(): InputStream;
-}
-import type { InputStream } from '../interfaces/wasi-io-streams';
-export { InputStream };

package/obj/interfaces/stdout.d.ts

@@ -1,5 +0,0 @@
-export namespace Stdout {
-  export function getStdout(): OutputStream;
-}
-import type { OutputStream } from '../interfaces/wasi-io-streams';
-export { OutputStream };

package/obj/interfaces/streams.d.ts

@@ -1,21 +0,0 @@
-export namespace Streams {
-  export function read(this: InputStream, len: bigint): [Uint8Array | ArrayBuffer, StreamStatus];
-  export function blockingRead(this: InputStream, len: bigint): [Uint8Array | ArrayBuffer, StreamStatus];
-  export function dropInputStream(this: InputStream): void;
-  export function write(this: OutputStream, buf: Uint8Array): [bigint, StreamStatus];
-  export function blockingWrite(this: OutputStream, buf: Uint8Array): [bigint, StreamStatus];
-  export function dropOutputStream(this: OutputStream): void;
-}
-export type InputStream = number;
-/**
- * # Variants
- * 
- * ## `"open"`
- * 
- * ## `"ended"`
- */
-export type StreamStatus = 'open' | 'ended';
-export interface StreamError {
-  dummy: number,
-}
-export type OutputStream = number;

package/obj/interfaces/wall-clock.d.ts

@@ -1,6 +0,0 @@
-export namespace WallClock {
-}
-export interface Datetime {
-  seconds: bigint,
-  nanoseconds: number,
-}

package/obj/interfaces/wasi-cli-base-environment.d.ts

@@ -1,3 +0,0 @@
-export namespace WasiCliBaseEnvironment {
-  export function getEnvironment(): [string, string][];
-}

package/obj/interfaces/wasi-cli-base-preopens.d.ts

@@ -1,5 +0,0 @@
-export namespace WasiCliBasePreopens {
-  export function getDirectories(): [Descriptor, string][];
-}
-import type { Descriptor } from '../interfaces/wasi-filesystem-filesystem';
-export { Descriptor };

package/obj/interfaces/wasi-cli-base-stderr.d.ts

@@ -1,5 +0,0 @@
-export namespace WasiCliBaseStderr {
-  export function getStderr(): OutputStream;
-}
-import type { OutputStream } from '../interfaces/wasi-io-streams';
-export { OutputStream };

package/obj/interfaces/wasi-cli-base-stdin.d.ts

@@ -1,5 +0,0 @@
-export namespace WasiCliBaseStdin {
-  export function getStdin(): InputStream;
-}
-import type { InputStream } from '../interfaces/wasi-io-streams';
-export { InputStream };

package/obj/interfaces/wasi-cli-base-stdout.d.ts

@@ -1,5 +0,0 @@
-export namespace WasiCliBaseStdout {
-  export function getStdout(): OutputStream;
-}
-import type { OutputStream } from '../interfaces/wasi-io-streams';
-export { OutputStream };

package/obj/interfaces/wasi-filesystem-filesystem.d.ts

@@ -1,152 +0,0 @@
-export namespace WasiFilesystemFilesystem {
-  export function readViaStream(this: Descriptor, offset: Filesize): InputStream;
-  export function writeViaStream(this: Descriptor, offset: Filesize): OutputStream;
-  export function appendViaStream(this: Descriptor): OutputStream;
-  export function getType(this: Descriptor): DescriptorType;
-  export function stat(this: Descriptor): DescriptorStat;
-  export function openAt(this: Descriptor, pathFlags: PathFlags, path: string, openFlags: OpenFlags, flags: DescriptorFlags, modes: Modes): Descriptor;
-  export function dropDescriptor(this: Descriptor): void;
-  export function dropDirectoryEntryStream(this: DirectoryEntryStream): void;
-}
-export type Descriptor = number;
-export type Filesize = bigint;
-import type { InputStream } from '../interfaces/wasi-io-streams';
-export { InputStream };
-/**
- * # Variants
- * 
- * ## `"access"`
- * 
- * ## `"would-block"`
- * 
- * ## `"already"`
- * 
- * ## `"bad-descriptor"`
- * 
- * ## `"busy"`
- * 
- * ## `"deadlock"`
- * 
- * ## `"quota"`
- * 
- * ## `"exist"`
- * 
- * ## `"file-too-large"`
- * 
- * ## `"illegal-byte-sequence"`
- * 
- * ## `"in-progress"`
- * 
- * ## `"interrupted"`
- * 
- * ## `"invalid"`
- * 
- * ## `"io"`
- * 
- * ## `"is-directory"`
- * 
- * ## `"loop"`
- * 
- * ## `"too-many-links"`
- * 
- * ## `"message-size"`
- * 
- * ## `"name-too-long"`
- * 
- * ## `"no-device"`
- * 
- * ## `"no-entry"`
- * 
- * ## `"no-lock"`
- * 
- * ## `"insufficient-memory"`
- * 
- * ## `"insufficient-space"`
- * 
- * ## `"not-directory"`
- * 
- * ## `"not-empty"`
- * 
- * ## `"not-recoverable"`
- * 
- * ## `"unsupported"`
- * 
- * ## `"no-tty"`
- * 
- * ## `"no-such-device"`
- * 
- * ## `"overflow"`
- * 
- * ## `"not-permitted"`
- * 
- * ## `"pipe"`
- * 
- * ## `"read-only"`
- * 
- * ## `"invalid-seek"`
- * 
- * ## `"text-file-busy"`
- * 
- * ## `"cross-device"`
- */
-export type ErrorCode = 'access' | 'would-block' | 'already' | 'bad-descriptor' | 'busy' | 'deadlock' | 'quota' | 'exist' | 'file-too-large' | 'illegal-byte-sequence' | 'in-progress' | 'interrupted' | 'invalid' | 'io' | 'is-directory' | 'loop' | 'too-many-links' | 'message-size' | 'name-too-long' | 'no-device' | 'no-entry' | 'no-lock' | 'insufficient-memory' | 'insufficient-space' | 'not-directory' | 'not-empty' | 'not-recoverable' | 'unsupported' | 'no-tty' | 'no-such-device' | 'overflow' | 'not-permitted' | 'pipe' | 'read-only' | 'invalid-seek' | 'text-file-busy' | 'cross-device';
-import type { OutputStream } from '../interfaces/wasi-io-streams';
-export { OutputStream };
-/**
- * # Variants
- * 
- * ## `"unknown"`
- * 
- * ## `"block-device"`
- * 
- * ## `"character-device"`
- * 
- * ## `"directory"`
- * 
- * ## `"fifo"`
- * 
- * ## `"symbolic-link"`
- * 
- * ## `"regular-file"`
- * 
- * ## `"socket"`
- */
-export type DescriptorType = 'unknown' | 'block-device' | 'character-device' | 'directory' | 'fifo' | 'symbolic-link' | 'regular-file' | 'socket';
-export type Device = bigint;
-export type Inode = bigint;
-export type LinkCount = bigint;
-import type { Datetime } from '../interfaces/wasi-clocks-wall-clock';
-export { Datetime };
-export interface DescriptorStat {
-  device: Device,
-  inode: Inode,
-  type: DescriptorType,
-  linkCount: LinkCount,
-  size: Filesize,
-  dataAccessTimestamp: Datetime,
-  dataModificationTimestamp: Datetime,
-  statusChangeTimestamp: Datetime,
-}
-export interface PathFlags {
-  symlinkFollow?: boolean,
-}
-export interface OpenFlags {
-  create?: boolean,
-  directory?: boolean,
-  exclusive?: boolean,
-  truncate?: boolean,
-}
-export interface DescriptorFlags {
-  read?: boolean,
-  write?: boolean,
-  fileIntegritySync?: boolean,
-  dataIntegritySync?: boolean,
-  requestedWriteSync?: boolean,
-  mutateDirectory?: boolean,
-}
-export interface Modes {
-  readable?: boolean,
-  writable?: boolean,
-  executable?: boolean,
-}
-export type DirectoryEntryStream = number;

package/obj/interfaces/wasi-io-streams.d.ts

@@ -1,21 +0,0 @@
-export namespace WasiIoStreams {
-  export function read(this: InputStream, len: bigint): [Uint8Array, StreamStatus];
-  export function blockingRead(this: InputStream, len: bigint): [Uint8Array, StreamStatus];
-  export function dropInputStream(this: InputStream): void;
-  export function write(this: OutputStream, buf: Uint8Array): [bigint, StreamStatus];
-  export function blockingWrite(this: OutputStream, buf: Uint8Array): [bigint, StreamStatus];
-  export function dropOutputStream(this: OutputStream): void;
-}
-export type InputStream = number;
-/**
- * # Variants
- * 
- * ## `"open"`
- * 
- * ## `"ended"`
- */
-export type StreamStatus = 'open' | 'ended';
-export interface StreamError {
-  dummy: number,
-}
-export type OutputStream = number;