@bytecodealliance/jco 0.8.0 → 0.9.1

package/LICENSE

@@ -0,0 +1,220 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+
+--- LLVM Exceptions to the Apache 2.0 License ----
+
+As an exception, if, as a result of your compiling your source code, portions
+of this Software are embedded into an Object form of such source code, you
+may redistribute such embedded portions in such Object form without complying
+with the conditions of Sections 4(a), 4(b) and 4(d) of the License.
+
+In addition, if you combine or link compiled forms of this Software with
+software that is licensed under the GPLv2 ("Combined Software") and if a
+court of competent jurisdiction determines that the patent provision (Section
+3), the indemnity provision (Section 9) or other Section of the License
+conflicts with the conditions of the GPLv2, you may retroactively and
+prospectively choose to deem waived or otherwise exclude such Section(s) of
+the License, but only in their entirety and only with respect to the Combined
+Software.
+

package/README.md

@@ -65,6 +65,44 @@ Commands:
   help [command]                        display help for command
 ```
 
+For help with individual command options, use `jco <cmd> --help`.
+
+### Transpile
+
+To transpile a component into JS:
+
+```
+jco transpile component.wasm -o out-dir
+```
+
+The resultant file can be imported providing the bindings of the component as if it were imported directly:
+
+app.js
+```
+import { fn } from './out-dir/component.js';
+
+fn();
+```
+
+Imports can be remapped using the `--map` flag, or to provide imports as an argument use the `--instantiation` option.
+
+Components relying on WASI bindings will contain external WASI imports, which are automatically updated
+to the `@bytecodealliance/preview-shim` package. This package can be installed from npm separately for
+runtime usage. This shim layer supports both Node.js and browsers.
+
+Options include:
+* `--name`: Give a custom name for the component JS file in `out-dir/[name].js`
+* `--minify`: Minify the component JS
+* `--optimize`: Runs the internal core Wasm files through Binaryen for optimization. Optimization options can be passed with a `-- <binaryen options>` flag separator.
+* `--tla-compat`: Instead of relying on top-level-await, requires an `$init` promise to be imported and awaited first.
+* `--js`: Converts core Wasm files to JavaScript for environments that don't even support core Wasm.
+* `--base64-cutoff=<number>`: Sets the maximum number of bytes for inlining Wasm files into the JS using base64 encoding. Set to zero to disable base64 inlining entirely.
+* `--no-wasi-shim`: Disable the WASI shim mapping to `@bytecodealliance/preview2-shim`.
+* `--map`: Provide custom mappings for world imports. Supports both wildcard mappings (`*` similarly as in the package.json "exports" field) as well as `#` mappings for targetting exported interfaces. For example, the WASI mappings are internally defined with mappings like `--map wasi:filesystem/*=@bytecodealliance/preview2-shim/filesystem#*` to map `import as * filesystem from 'wasi:filesystem/filesystem'` to `import { filesystem } from '@bytecodealliance/preview2-shim/filesystem`.
+* `--no-nodejs-compat`: Disables Node.js compat in the output to load core Wasm with FS methods.
+* `--instantiation`: Instead of a direct ES module, export an `instantiate` function which can take the imports as an argument instead of implicit imports.
+* `--valid-lifting-optimization`: Internal validations are removed assuming that core Wasm binaries are valid components, providing a minor output size saving.
+
 ### Componentize
 
 To componentize a JS file run:
@@ -87,20 +125,6 @@ See [ComponentizeJS](https://github.com/bytecodealliance/componentize-js) for mo
 
 Transpile a Component to JS.
 
-**Transpilation options:**
-
-* `name?: string` - name for the generated JS file.
-* `instantiation?: bool` - instead of a direct ES module, output the raw instantiation function for custom virtualization.
-* `map?: Record<string, string>` - remap component imports
-* `validLiftingOptimization?: bool` - optimization to reduce code size
-* `noNodejsCompat?: bool` - disables Node.js compatible output
-* `tlaCompat?: bool` - enable compat in JS runtimes without TLA support
-* `base64Cutoff?: number` - size in bytes, under which Wasm modules get inlined as base64.
-* `js?: bool` - convert Wasm into JS instead for execution compatibility in JS environments without Wasm support.
-* `minify?: bool` - minify the output JS.
-* `optimize?: bool` - optimize the component with Binaryen wasm-opt first.
-* `optArgs?: string[]` - if using optimize, custom optimization options (defaults to best optimization, but this is very slow)
-
 #### `opt(component: Uint8Array, opts?): Promise<{ component: Uint8Array }>`
 
 Optimize a Component with the [Binaryen Wasm-opt](https://www.npmjs.com/package/binaryen) project.

package/lib/console.js

@@ -0,0 +1,7 @@
+export function log(msg) {
+  console.log(msg);
+}
+
+export function error(msg) {
+  console.error(msg);
+}

package/obj/imports/environment.d.ts

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

package/obj/imports/exit.d.ts

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

package/obj/imports/filesystem.d.ts

@@ -0,0 +1,152 @@
+export namespace ImportsFilesystem {
+  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 '../imports/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 '../imports/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 '../imports/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/imports/preopens.d.ts

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

package/obj/imports/random.d.ts

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

package/obj/imports/stderr.d.ts

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

package/obj/imports/stdin.d.ts

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

package/obj/imports/stdout.d.ts

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

package/obj/imports/streams.d.ts

@@ -0,0 +1,12 @@
+export namespace ImportsStreams {
+  export function read(this: InputStream, len: bigint): [Uint8Array | ArrayBuffer, boolean];
+  export function blockingRead(this: InputStream, len: bigint): [Uint8Array | ArrayBuffer, boolean];
+  export function dropInputStream(this: InputStream): void;
+  export function write(this: OutputStream, buf: Uint8Array): bigint;
+  export function blockingWrite(this: OutputStream, buf: Uint8Array): bigint;
+  export function dropOutputStream(this: OutputStream): void;
+}
+export type InputStream = number;
+export interface StreamError {
+}
+export type OutputStream = number;

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

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

package/obj/js-component-bindgen-component.d.ts

@@ -0,0 +1,60 @@
+export type Wit = WitSource | WitBinary | WitPath;
+export interface WitSource {
+  tag: 'source',
+  val: string,
+}
+export interface WitBinary {
+  tag: 'binary',
+  val: Uint8Array,
+}
+export interface WitPath {
+  tag: 'path',
+  val: string,
+}
+export type Maps = [string, string][];
+export interface TypeGenerationOptions {
+  wit: Wit,
+  world?: string,
+  tlaCompat?: boolean,
+  instantiation?: boolean,
+  map?: Maps,
+}
+export interface GenerateOptions {
+  name: string,
+  noTypescript?: boolean,
+  instantiation?: boolean,
+  map?: Maps,
+  compat?: boolean,
+  noNodejsCompat?: boolean,
+  base64Cutoff?: number,
+  tlaCompat?: boolean,
+  validLiftingOptimization?: boolean,
+}
+export type Files = [string, Uint8Array][];
+/**
+* # Variants
+* 
+* ## `"function"`
+* 
+* ## `"instance"`
+*/
+export type ExportType = 'function' | 'instance';
+export interface Transpiled {
+  files: Files,
+  imports: string[],
+  exports: [string, ExportType][],
+}
+import { ImportsEnvironment } from './imports/environment';
+import { ImportsExit } from './imports/exit';
+import { ImportsPreopens } from './imports/preopens';
+import { ImportsStderr } from './imports/stderr';
+import { ImportsStdin } from './imports/stdin';
+import { ImportsStdout } from './imports/stdout';
+import { ImportsWallClock } from './imports/wall-clock';
+import { ImportsFilesystem } from './imports/filesystem';
+import { ImportsStreams } from './imports/streams';
+import { ImportsRandom } from './imports/random';
+export function generate(component: Uint8Array | ArrayBuffer, options: GenerateOptions): Transpiled;
+export function generateTypes(name: string, options: TypeGenerationOptions): Files;
+
+export const $init: Promise<void>;