@bytecodealliance/jco 1.14.0 → 1.15.0

package/src/common.js

@@ -1,11 +1,17 @@
 import { normalize, resolve, sep, dirname } from 'node:path';
 import { tmpdir } from 'node:os';
-import { readFile, writeFile, rm, mkdtemp, mkdir } from 'node:fs/promises';
+import {
+    readFile,
+    writeFile,
+    rm,
+    mkdtemp,
+    mkdir,
+    stat,
+} from 'node:fs/promises';
 import { spawn } from 'node:child_process';
 import { argv0 } from 'node:process';
 import { platform } from 'node:process';
-
-import c from 'chalk-template';
+import * as nodeUtils from 'node:util';
 
 export const isWindows = platform === 'win32';
 
@@ -27,6 +33,9 @@ export const ASYNC_WASI_EXPORTS = [
 
 export const DEFAULT_ASYNC_MODE = 'sync';
 
+/** Path of WIT files by default when one is not specified */
+export const DEFAULT_WIT_PATH = './wit';
+
 let _showSpinner = false;
 export function setShowSpinner(val) {
     _showSpinner = val;
@@ -64,16 +73,23 @@ export function fixedDigitDisplay(num, maxChars) {
     return ' '.repeat(maxChars - str.length) + str;
 }
 
-export function table(data, align = []) {
-    if (data.length === 0) {
+/**
+ * Generate tabular output
+ *
+ * @param {string[][]} rows - data to put in rows
+ * @param {string[]} align - alignment of columns
+ * @returns string
+ */
+export function table(rows, align = []) {
+    if (rows.length === 0) {
         return '';
     }
-    const colLens = data.reduce(
+    const colLens = rows.reduce(
         (maxLens, cur) => maxLens.map((len, i) => Math.max(len, cur[i].length)),
-        data[0].map((cell) => cell.length)
+        rows[0].map((cell) => cell.length)
     );
     let outTable = '';
-    for (const row of data) {
+    for (const row of rows) {
         for (const [i, cell] of row.entries()) {
             if (align[i] === 'right') {
                 outTable += ' '.repeat(colLens[i] - cell.length) + cell;
@@ -90,27 +106,52 @@ export function table(data, align = []) {
  * Securely creates a temporary directory and returns its path.
  *
  * The new directory is created using `fsPromises.mkdtemp()`.
+ *
+ * @returns {Promise<string>} A `Promise` that resovles to a created temporary directory path
  */
 export async function getTmpDir() {
     return await mkdtemp(normalize(tmpdir() + sep));
 }
 
-async function readFileCli(file, encoding) {
+/**
+ * Read a given file, throwing a formatted error if one occurs
+ *
+ * @param {string} filePath - path to teh file to read
+ * @param {encoding} encoding - file encoding
+ * @returns {Promise<Buffer>} A promise that resolves to the contents of the file
+ */
+async function readFileCli(filePath, encoding) {
     try {
-        return await readFile(file, encoding);
+        return await readFile(filePath, encoding);
     } catch {
-        throw c`Unable to read file {bold ${file}}`;
+        throw `Unable to read file ${styleText('bold', filePath)}`;
     }
 }
 export { readFileCli as readFile };
 
-export async function spawnIOTmp(cmd, input, args) {
+/**
+ * Spawn a command that processes a given wasm binary bytes with some
+ * command.
+ *
+ * The command invocations that are generated by this function
+ * take the following form:
+ *
+ * ```
+ * <cmd> <input wasm file> <...arguments> <output wasm file>
+ * ```
+ *
+ * @param {string} cmd - the command to run
+ * @param {Buffer<ArrayBufferLike>} inputWasmBytes - bytes that of the input WebAssembly binary
+ * @param {string[]} args - arguments to pass to the command (after the input file and before the output file)
+ * @returns {Promise<Buffer<ArrayBufferLike>>} A `Promise` that resolves when the command has exited
+ */
+export async function spawnIOTmp(cmd, inputWasmBytes, args) {
     const tmpDir = await getTmpDir();
     try {
         const inFile = resolve(tmpDir, 'in.wasm');
         let outFile = resolve(tmpDir, 'out.wasm');
 
-        await writeFile(inFile, input);
+        await writeFile(inFile, inputWasmBytes);
 
         const cp = spawn(argv0, [cmd, inFile, ...args, outFile], {
             stdio: 'pipe',
@@ -139,23 +180,75 @@ export async function spawnIOTmp(cmd, input, args) {
     }
 }
 
+/**
+ * Given an object that has file names as keys and file contents as values,
+ * write out the files to a their locations.
+ *
+ * This function also prints out the files that were written
+ *
+ * @param {Record<string, string>} files - object which contains files to be written out
+ * @param {boolean} summaryTitle - whether to print the summary after writing out files
+ * @returns {Promise<void>>} A `Promise` that resolves when the fiels are all written
+ *
+ */
 export async function writeFiles(files, summaryTitle) {
     await Promise.all(
-        Object.entries(files).map(async ([name, file]) => {
-            await mkdir(dirname(name), { recursive: true });
-            await writeFile(name, file);
+        Object.entries(files).map(async ([filePath, contents]) => {
+            await mkdir(dirname(filePath), { recursive: true });
+            await writeFile(filePath, contents);
         })
     );
     if (!summaryTitle) {
         return;
     }
-    console.log(c`
-  {bold ${summaryTitle}:}
-
-${table(
-    Object.entries(files).map(([name, source]) => [
-        c` - {italic ${name}}  `,
-        c`{black.italic ${sizeStr(source.length)}}`,
-    ])
-)}`);
+
+    let rows = Object.entries(files).map(([name, source]) => [
+        ` - ${styleText('italic', name)}  `,
+        `${styleText(['black', 'italic'], sizeStr(source.length))}`,
+    ]);
+    console.log(`
+  ${styleText('bold', summaryTitle + ":")}
+
+${table(rows)}`);
+}
+
+/**
+ * Resolve the deafult WIT path, given a possibly
+ *
+ * @param {string | undefined} [witPath]
+ * @returns {Promise<string>}
+ */
+export async function resolveDefaultWITPath(witPath) {
+    if (witPath) {
+        return witPath;
+    }
+
+    // Use a default/standard current-folder WIT directory (wit) if we can find it
+    const witDirExists = await stat(DEFAULT_WIT_PATH)
+        .then((p) => p.isDirectory())
+        .catch(() => false);
+    if (!witDirExists) {
+        throw new Error(
+            'Failed to determine WIT directory, please specify WIT directory argument'
+        );
+    }
+    witPath = resolve(DEFAULT_WIT_PATH);
+    console.error(
+        `no WIT directory specified, using detected WIT directory @ [${DEFAULT_WIT_PATH}]`
+    );
+    return witPath;
+}
+
+/**
+ * Partial polyfill for 'node:utils' `styleText()`
+ *
+ * @param {string | string[]} styles - styles to apply to the given text
+ * @param {string} text - text that should be styled
+ * @returns {string} The styled string
+ */
+export function styleText(styles, text) {
+    if (nodeUtils.styleText) {
+        return nodeUtils.styleText(styles, text);
+    }
+    return text;
 }

package/src/jco.js

@@ -1,6 +1,5 @@
 #!/usr/bin/env node
 
-import c from 'chalk-template';
 import { program, Option } from 'commander';
 
 import { opt } from './cmd/opt.js';
@@ -17,15 +16,16 @@ import {
     componentWit,
 } from './cmd/wasm-tools.js';
 import { componentize } from './cmd/componentize.js';
+import { styleText } from './common.js';
 
 program
     .name('jco')
     .description(
-        c`{bold jco - WebAssembly JS Component Tools}\n      JS Component Transpilation Bindgen & Wasm Tools for JS`
+        `${styleText('bold', "jco - WebAssembly JS Component Tools")}\n      JS Component Transpilation Bindgen & Wasm Tools for JS`
     )
     .usage('<command> [options]')
     .enablePositionalOptions()
-    .version('1.14.0');
+    .version('1.15.0');
 
 function myParseInt(value) {
     return parseInt(value, 10);
@@ -41,6 +41,16 @@ function collectOptions(value, previous) {
     return previous.concat([value]);
 }
 
+/** Choices for features (enabling/disabling) */
+const FEATURE_CHOICES = [
+    'clocks',
+    'http',
+    'random',
+    'stdio',
+    'fetch-event',
+    'all',
+];
+
 program
     .command('componentize')
     .description('Create a component from a JavaScript module')
@@ -58,9 +68,17 @@ program
         new Option(
             '-d, --disable <feature...>',
             'disable WASI features'
-        ).choices(['clocks', 'http', 'random', 'stdio', 'fetch-event', 'all'])
+        ).choices(FEATURE_CHOICES)
+    )
+    .addOption(
+        new Option('--enable <feature...>', 'enable WASI features').choices(
+            FEATURE_CHOICES
+        )
+    )
+    .option(
+        '--debug',
+        'configure jco for debug (e.g. disable all features except stdio, etc)'
     )
-    // .addOption(new Option('-e, --enable <feature...>', 'enable WASI features').choices(['http']))
     .option(
         '--preview2-adapter <adapter>',
         'provide a custom preview2 adapter path'
@@ -186,10 +204,10 @@ program
     .command('types')
     .description('Generate types for the given WIT')
     .usage('<wit-path> -o <out-dir>')
-    .argument('<wit-path>', 'path to a WIT file or directory')
+    .argument('[<wit-path>]', 'path to a WIT file or directory')
     .option('--name <name>', 'custom output name')
     .option('-n, --world-name <world>', 'WIT world to generate types for')
-    .requiredOption('-o, --out-dir <out-dir>', 'output directory')
+    .option('-o, --out-dir <out-dir>', 'output directory')
     .option(
         '--tla-compat',
         'generates types for the TLA compat output with an async $init promise export'
@@ -243,10 +261,10 @@ program
     .command('guest-types')
     .description('(experimental) Generate guest types for the given WIT')
     .usage('<wit-path> -o <out-dir>')
-    .argument('<wit-path>', 'path to a WIT file or directory')
+    .argument('[<wit-path>]', 'path to a WIT file or directory')
     .option('--name <name>', 'custom output name')
     .option('-n, --world-name <world>', 'WIT world to generate types for')
-    .requiredOption('-o, --out-dir <out-dir>', 'output directory')
+    .option('-o, --out-dir <out-dir>', 'output directory')
     .option('-q, --quiet', 'disable output summary')
     .option(
         '--feature <feature>',
@@ -468,7 +486,7 @@ function asyncAction(cmd) {
             } catch (e) {
                 process.stdout.write(`(jco ${cmd.name}) `);
                 if (typeof e === 'string') {
-                    console.error(c`{red.bold Error}: ${e}\n`);
+                    console.error(`${styleText(['red', 'bold'], "Error")}: ${e}\n`);
                 } else {
                     console.error(e);
                 }

package/types/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.js"],"names":[],"mappings":"AAgBA;;;GAGG;AACH,8BAHW,UAAU,CAAC,GAAoC,CAAC,CAAC,CAAC,CAAC,GAClD,OAAO,CAAC,UAAU,CAAC,GAAoC,CAAC,CAAC,CAKpE;AACD;;;GAGG;AACH,2BAHW,UAAU,CAAC,GAAoC,CAAC,CAAC,CAAC,CAAC,GAClD,OAAO,CAAC,UAAU,CAAC,GAAoC,CAAC,CAAC,CAKpE;AACD;;;GAGG;AACH,qCAHW,UAAU,CAAC,GAA2C,CAAC,CAAC,CAAC,CAAC,GACzD,OAAO,CAAC,UAAU,CAAC,GAA2C,CAAC,CAAC,CAK3E;AACD;;;;GAIG;AACH,qCAJW,UAAU,CAAC,GAA2C,CAAC,CAAC,CAAC,CAAC,YAC1D,UAAU,CAAC,GAA2C,CAAC,CAAC,CAAC,CAAC,GACzD,OAAO,CAAC,UAAU,CAAC,GAA2C,CAAC,CAAC,CAK3E;AACD;;;GAGG;AACH,0CAHW,UAAU,CAAC,GAA6C,CAAC,CAAC,CAAC,CAAC,GAC3D,OAAO,CAAC,UAAU,CAAC,GAA6C,CAAC,CAAC,CAK7E;AACD;;;;GAIG;AACH,oCAJW,UAAU,CAAC,GAA0C,CAAC,CAAC,CAAC,CAAC,YACzD,UAAU,CAAC,GAA0C,CAAC,CAAC,CAAC,CAAC,GACxD,OAAO,CAAC,UAAU,CAAC,GAA0C,CAAC,CAAC,CAK1E;AACD;;;GAGG;AACH,qCAHW,UAAU,CAAC,GAA2C,CAAC,CAAC,CAAC,CAAC,GACzD,OAAO,CAAC,UAAU,CAAC,GAA2C,CAAC,CAAC,CAK3E;AACD,kDAKC;AACD,kDAKC"}

package/types/browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../src/browser.js"],"names":[],"mappings":"AAMA,uDAGC;AAED,4DAGC"}

package/types/common.d.ts

@@ -0,0 +1,80 @@
+export function setShowSpinner(val: any): void;
+export function getShowSpinner(): boolean;
+export function sizeStr(num: any): string;
+export function fixedDigitDisplay(num: any, maxChars: any): string;
+/**
+ * Generate tabular output
+ *
+ * @param {string[][]} rows - data to put in rows
+ * @param {string[]} align - alignment of columns
+ * @returns string
+ */
+export function table(rows: string[][], align?: string[]): string;
+/**
+ * Securely creates a temporary directory and returns its path.
+ *
+ * The new directory is created using `fsPromises.mkdtemp()`.
+ *
+ * @returns {Promise<string>} A `Promise` that resovles to a created temporary directory path
+ */
+export function getTmpDir(): Promise<string>;
+/**
+ * Spawn a command that processes a given wasm binary bytes with some
+ * command.
+ *
+ * The command invocations that are generated by this function
+ * take the following form:
+ *
+ * ```
+ * <cmd> <input wasm file> <...arguments> <output wasm file>
+ * ```
+ *
+ * @param {string} cmd - the command to run
+ * @param {Buffer<ArrayBufferLike>} inputWasmBytes - bytes that of the input WebAssembly binary
+ * @param {string[]} args - arguments to pass to the command (after the input file and before the output file)
+ * @returns {Promise<Buffer<ArrayBufferLike>>} A `Promise` that resolves when the command has exited
+ */
+export function spawnIOTmp(cmd: string, inputWasmBytes: Buffer<ArrayBufferLike>, args: string[]): Promise<Buffer<ArrayBufferLike>>;
+/**
+ * Given an object that has file names as keys and file contents as values,
+ * write out the files to a their locations.
+ *
+ * This function also prints out the files that were written
+ *
+ * @param {Record<string, string>} files - object which contains files to be written out
+ * @param {boolean} summaryTitle - whether to print the summary after writing out files
+ * @returns {Promise<void>>} A `Promise` that resolves when the fiels are all written
+ *
+ */
+export function writeFiles(files: Record<string, string>, summaryTitle: boolean): Promise<void>;
+/**
+ * Resolve the deafult WIT path, given a possibly
+ *
+ * @param {string | undefined} [witPath]
+ * @returns {Promise<string>}
+ */
+export function resolveDefaultWITPath(witPath?: string | undefined): Promise<string>;
+/**
+ * Partial polyfill for 'node:utils' `styleText()`
+ *
+ * @param {string | string[]} styles - styles to apply to the given text
+ * @param {string} text - text that should be styled
+ * @returns {string} The styled string
+ */
+export function styleText(styles: string | string[], text: string): string;
+export const isWindows: boolean;
+export const ASYNC_WASI_IMPORTS: string[];
+export const ASYNC_WASI_EXPORTS: string[];
+export const DEFAULT_ASYNC_MODE: "sync";
+/** Path of WIT files by default when one is not specified */
+export const DEFAULT_WIT_PATH: "./wit";
+export { readFileCli as readFile };
+/**
+ * Read a given file, throwing a formatted error if one occurs
+ *
+ * @param {string} filePath - path to teh file to read
+ * @param {encoding} encoding - file encoding
+ * @returns {Promise<Buffer>} A promise that resolves to the contents of the file
+ */
+declare function readFileCli(filePath: string, encoding: any): Promise<Buffer>;
+//# sourceMappingURL=common.d.ts.map

package/types/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../src/common.js"],"names":[],"mappings":"AAuCA,+CAEC;AACD,0CAIC;AAED,0CASC;AAED,mEAcC;AAED;;;;;;GAMG;AACH,4BAJW,MAAM,EAAE,EAAE,UACV,MAAM,EAAE,UAuBlB;AAED;;;;;;GAMG;AACH,6BAFa,OAAO,CAAC,MAAM,CAAC,CAI3B;AAkBD;;;;;;;;;;;;;;;GAeG;AACH,gCALW,MAAM,kBACN,MAAM,CAAC,eAAe,CAAC,QACvB,MAAM,EAAE,GACN,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAmC5C;AAED;;;;;;;;;;GAUG;AACH,kCALW,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,gBACtB,OAAO,GACL,OAAO,CAAC,IAAI,CAAC,CAsBzB;AAED;;;;;GAKG;AACH,gDAHW,MAAM,GAAG,SAAS,GAChB,OAAO,CAAC,MAAM,CAAC,CAqB3B;AAED;;;;;;GAMG;AACH,kCAJW,MAAM,GAAG,MAAM,EAAE,QACjB,MAAM,GACJ,MAAM,CAOlB;AA9OD,gCAA8C;AAE9C,0CASE;AAEF,0CAGE;AAEF,iCAAkC,MAAM,CAAC;AAEzC,6DAA6D;AAC7D,+BAAgC,OAAO,CAAC;;AA+ExC;;;;;;GAMG;AACH,uCAJW,MAAM,kBAEJ,OAAO,CAAC,MAAM,CAAC,CAQ3B"}

package/types/jco.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jco.d.ts","sourceRoot":"","sources":["../src/jco.js"],"names":[],"mappings":""}

package/types/ora-shim.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ora-shim.d.ts","sourceRoot":"","sources":["../src/ora-shim.js"],"names":[],"mappings":"AAAA,2BAA2B;AAC3B,mCAEC;AAED;IACI,cAAU;IACV,aAAS;CACZ"}

package/src/api.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["api.js"],"names":[],"mappings":"AAgBA;;;GAGG;AACH,8BAHW,UAAU,CAAC,GAAoC,CAAC,CAAC,CAAC,CAAC,GAClD,OAAO,CAAC,UAAU,CAAC,GAAoC,CAAC,CAAC,CAKpE;AACD;;;GAGG;AACH,2BAHW,UAAU,CAAC,GAAoC,CAAC,CAAC,CAAC,CAAC,GAClD,OAAO,CAAC,UAAU,CAAC,GAAoC,CAAC,CAAC,CAKpE;AACD;;;GAGG;AACH,qCAHW,UAAU,CAAC,GAA2C,CAAC,CAAC,CAAC,CAAC,GACzD,OAAO,CAAC,UAAU,CAAC,GAA2C,CAAC,CAAC,CAK3E;AACD;;;;GAIG;AACH,qCAJW,UAAU,CAAC,GAA2C,CAAC,CAAC,CAAC,CAAC,YAC1D,UAAU,CAAC,GAA2C,CAAC,CAAC,CAAC,CAAC,GACzD,OAAO,CAAC,UAAU,CAAC,GAA2C,CAAC,CAAC,CAK3E;AACD;;;GAGG;AACH,0CAHW,UAAU,CAAC,GAA6C,CAAC,CAAC,CAAC,CAAC,GAC3D,OAAO,CAAC,UAAU,CAAC,GAA6C,CAAC,CAAC,CAK7E;AACD;;;;GAIG;AACH,oCAJW,UAAU,CAAC,GAA0C,CAAC,CAAC,CAAC,CAAC,YACzD,UAAU,CAAC,GAA0C,CAAC,CAAC,CAAC,CAAC,GACxD,OAAO,CAAC,UAAU,CAAC,GAA0C,CAAC,CAAC,CAK1E;AACD;;;GAGG;AACH,qCAHW,UAAU,CAAC,GAA2C,CAAC,CAAC,CAAC,CAAC,GACzD,OAAO,CAAC,UAAU,CAAC,GAA2C,CAAC,CAAC,CAK3E;AACD,kDAKC;AACD,kDAKC"}

package/src/browser.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["browser.js"],"names":[],"mappings":"AAMA,uDAGC;AAED,4DAGC"}

package/src/common.d.ts

@@ -1,20 +0,0 @@
-export function setShowSpinner(val: any): void;
-export function getShowSpinner(): boolean;
-export function sizeStr(num: any): string;
-export function fixedDigitDisplay(num: any, maxChars: any): string;
-export function table(data: any, align?: any[]): string;
-/**
- * Securely creates a temporary directory and returns its path.
- *
- * The new directory is created using `fsPromises.mkdtemp()`.
- */
-export function getTmpDir(): Promise<string>;
-export function spawnIOTmp(cmd: any, input: any, args: any): Promise<Buffer<ArrayBufferLike>>;
-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 +0,0 @@
-{"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/jco.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"jco.d.ts","sourceRoot":"","sources":["jco.js"],"names":[],"mappings":""}

package/src/ora-shim.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ora-shim.d.ts","sourceRoot":"","sources":["ora-shim.js"],"names":[],"mappings":"AAAA,2BAA2B;AAC3B,mCAEC;AAED;IACI,cAAU;IACV,aAAS;CACZ"}