@andreiltd/componentize-qjs-binding-win32-arm64-msvc 0.2.0 → 0.2.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

package/README.md

@@ -1,3 +1,397 @@
-# `@andreiltd/componentize-qjs-binding-win32-arm64-msvc`
+# componentize-qjs
 
-This is the **aarch64-pc-windows-msvc** binary for `@andreiltd/componentize-qjs-binding`
+[![CI](https://github.com/andreiltd/componentize-qjs/actions/workflows/ci.yml/badge.svg)](https://github.com/andreiltd/componentize-qjs/actions/workflows/ci.yml)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+Convert JavaScript source code into
+[WebAssembly components](https://component-model.bytecodealliance.org/) using
+[QuickJS](https://github.com/quickjs-ng/quickjs).
+
+## Overview
+
+`componentize-qjs` takes a JavaScript source file and a
+[WIT](https://component-model.bytecodealliance.org/design/wit.html) definition,
+and produces a standalone WebAssembly component that can run on any
+component-model runtime (e.g. [Wasmtime](https://wasmtime.dev/)).
+
+Under the hood it:
+
+1. Embeds the [QuickJS](https://github.com/quickjs-ng/quickjs) engine (via
+   [rquickjs](https://github.com/DelSkayn/rquickjs)) as the JavaScript
+   runtime.
+2. Uses [wit-dylib](https://crates.io/crates/wit-dylib) to generate WIT
+   bindings that bridge the component model and the JS engine.
+3. Snapshots the initialized JS state with
+   [Wizer](https://github.com/bytecodealliance/wizer) so startup cost is paid at
+   build time, not at runtime.
+
+## Prerequisites
+
+Rust **1.94** or later is required (the `wasm32-wasip2` target needs a recent
+toolchain for PIC support in wasi-libc).
+
+## Installation
+
+### Rust CLI (crates.io)
+
+```bash
+cargo install componentize-qjs-cli --locked
+```
+
+This installs the `componentize-qjs` command.
+
+### Rust CLI (from source)
+
+```bash
+cargo install --path . --locked
+```
+
+### Prebuilt CLI binaries
+
+Prebuilt CLI archives are attached to each
+[GitHub release](https://github.com/andreiltd/componentize-qjs/releases) for
+Linux, macOS, and Windows.
+
+### npm package
+
+```bash
+npm install componentize-qjs
+```
+
+This pulls in the right prebuilt native binding for your platform via the
+`@andreiltd/componentize-qjs-binding-*` optional dependencies.
+
+If you want to build from source run:
+
+```bash
+cd npm && npm install && npm run build
+```
+
+## Quick Start
+
+**1. Define a WIT interface** (`hello.wit`):
+
+```wit
+package test:hello;
+
+world hello {
+    export greet: func(name: string) -> string;
+}
+```
+
+**2. Implement it in JavaScript** (`hello.js`):
+
+JavaScript sources are ES modules. Export WIT functions and interfaces directly
+from the module.
+
+```js
+export function greet(name) {
+    return `Hello, ${name}!`;
+}
+```
+
+**3. Build the component:**
+
+```bash
+componentize-qjs --wit hello.wit --js hello.js -o hello.wasm
+```
+
+**4. Run it:**
+
+```bash
+wasmtime run --wasm component-model-async=y --invoke 'greet("World")' hello.wasm
+# "Hello, World!"
+```
+
+The built-in runtime published with componentize-qjs includes component-model
+async support. A custom runtime built without that Cargo feature can be passed
+with `--runtime` for sync-only components.
+
+## CLI Reference
+
+```
+componentize-qjs [OPTIONS] --wit <WIT> --js <JS>
+```
+
+| Flag | Short | Description |
+|---|---|---|
+| `--wit <PATH>` | `-w` | Path to the WIT file or directory |
+| `--js <PATH>` | `-j` | Path to the JavaScript source file |
+| `--output <PATH>` | `-o` | Output path (default: `output.wasm`) |
+| `--world <NAME>` | `-n` | World name when the WIT defines multiple worlds |
+| `--stub-wasi` | | Replace all WASI imports with trap stubs |
+| `--minify` | `-m` | Minify JS source before embedding |
+| `--opt-size` | | Use the built-in QuickJS runtime optimized for size |
+| `--runtime <PATH>` | | Custom QuickJS runtime Wasm module to embed |
+
+### Cargo features
+
+| Feature | Effect |
+|---|---|
+| `opt-size` | Selects the bundled opt-size runtime when no runtime option is provided by the CLI or npm API |
+
+Build with features:
+
+```bash
+cargo build --release --features opt-size
+```
+
+## Using Imports
+
+WIT imports are available as ES module imports using their fully-qualified WIT
+interface name:
+
+```wit
+// imports.wit
+package local:test;
+
+interface math {
+    add: func(a: s32, b: s32) -> s32;
+    multiply: func(a: s32, b: s32) -> s32;
+}
+
+world imports {
+    import math;
+    export double-add: func(a: s32, b: s32) -> s32;
+}
+```
+
+```js
+// imports.js
+import math from "local:test/math";
+
+export function doubleAdd(a, b) {
+    const sum = math.add(a, b);
+    return math.multiply(sum, 2);
+}
+```
+
+## WIT Type Mappings
+
+### Primitive Types
+
+| WIT Type | JS Type | Notes |
+|----------|---------|-------|
+| `bool` | `boolean` | |
+| `u8`, `u16`, `u32` | `number` | |
+| `s8`, `s16`, `s32` | `number` | |
+| `u64`, `s64` | `number` | Precision limited to 2⁵³ (Number.MAX_SAFE_INTEGER) |
+| `f32`, `f64` | `number` | |
+| `char` | `string` | Must be exactly one Unicode scalar value |
+| `string` | `string` | |
+
+### Compound Types
+
+| WIT Type | JS Type | Example |
+|----------|---------|---------|
+| `list<T>` | `Array` | `[1, 2, 3]` |
+| `list<u8>` | `Uint8Array` or `Array` | `new Uint8Array([1, 2, 3])` |
+| `tuple<T, U, ...>` | `Array` | `[42, "hello"]` |
+| `option<T>` | `T \| null \| undefined` | `null` for none |
+| `result<T, E>` | `{ tag: "ok"\|"err", val?: T\|E }` | `{ tag: "ok", val: 42 }` |
+| `record { ... }` | `object` (camelCase keys) | `{ myField: 1 }` |
+| `variant` | `{ tag: number, val?: T }` | `{ tag: 0, val: "hi" }` |
+| `enum` | `number` | Lookup tables provided on the interface |
+| `flags` | `number` (bitmask) | Bit constants provided on the interface |
+| `own<R>`, `borrow<R>` | `number` (handle) | Opaque resource handle |
+
+### Async Exports
+
+Async exports are declared with the `async` keyword in WIT and implemented
+as JavaScript `async` functions:
+
+```wit
+package example:greeting;
+
+world greeter {
+    export greet: async func(name: string) -> string;
+}
+```
+
+```js
+export async function greet(name) {
+    // You can use await here
+    await Promise.resolve();
+    return `Hello, ${name}!`;
+}
+```
+
+### Streams
+
+Streams transfer a sequence of values between components.
+The `wit` global provides `Stream` and `Future` constructors for creating
+stream/future pairs. The type is automatically determined from the WIT definition:
+
+```wit
+package example:streaming;
+
+world streaming {
+    export produce: async func() -> stream<u8>;
+}
+```
+
+```js
+async function produce() {
+    // When only one stream type exists in the WIT, no argument needed
+    const { readable, writable } = wit.Stream();
+
+    writable.write(new Uint8Array([1, 2, 3]));
+    writable.drop();
+
+    return readable;
+}
+```
+
+When the WIT defines multiple stream types, use the type constant:
+
+```js
+// wit.Stream.U8, wit.Stream.STRING, wit.Stream.U32, etc.
+const { readable, writable } = wit.Stream(wit.Stream.U8);
+const { readable, writable } = wit.Stream(wit.Stream.STRING);
+```
+
+Available type constants (populated from WIT metadata):
+
+| WIT type | Constant |
+|----------|----------|
+| `stream<u8>` / `future<u8>` | `wit.Stream.U8` / `wit.Future.U8` |
+| `stream<u32>` / `future<u32>` | `wit.Stream.U32` / `wit.Future.U32` |
+| `stream<string>` / `future<string>` | `wit.Stream.STRING` / `wit.Future.STRING` |
+| `stream<f64>` / `future<f64>` | `wit.Stream.F64` / `wit.Future.F64` |
+
+All constructors return `{ readable, writable }`.
+
+**Complex element types** are also supported. The type constant is generated
+recursively from the WIT type structure:
+
+```js
+// stream<result<string, u32>>
+wit.Stream(wit.Stream.RESULT_STRING_U32);
+
+// stream<option<u32>>
+wit.Stream(wit.Stream.OPTION_U32);
+
+// stream<tuple<u32, string>>
+wit.Stream(wit.Stream.TUPLE_U32_STRING);
+
+// Named record types use their WIT name:
+// record point { x: f64, y: f64 }
+// stream<point>
+wit.Stream(wit.Stream.POINT);
+```
+
+Use `wit.Stream.types` or `wit.Future.types` to discover all available type
+constants at runtime.
+
+**StreamReadable methods:**
+
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `read(count?)` | `Promise<T[]>` (or `Uint8Array` for `u8`) | Read up to `count` values |
+| `cancelRead()` | result or `undefined` | Cancel an in-progress read |
+| `drop()` | `void` | Release the stream handle |
+
+**StreamWritable methods:**
+
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `write(data)` | `Promise<number>` | Write values, returns count written |
+| `writeAll(data)` | `Promise<number>` | Write all values, retrying as needed |
+| `cancelWrite()` | result or `undefined` | Cancel an in-progress write |
+| `drop()` | `void` | Release the stream handle |
+
+### Futures
+
+Futures transfer a single value. They work like streams but carry exactly one
+value:
+
+```wit
+package example:async-value;
+
+world async-value {
+    export compute: async func() -> future<string>;
+}
+```
+
+```js
+async function compute() {
+    const { readable, writable } = wit.Future();
+
+    // Write the value (fire-and-forget; completes when reader reads)
+    writable.write("computed result");
+
+    return readable;
+}
+```
+
+**Future type constants** follow the same pattern: `wit.Future.U32`,
+`wit.Future.STRING`, etc.
+
+**FutureReadable methods:**
+
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `read()` | `Promise<T>` | Read the single value |
+| `cancelRead()` | result or `undefined` | Cancel an in-progress read |
+| `drop()` | `void` | Release the future handle |
+
+**FutureWritable methods:**
+
+| Method | Returns | Description |
+|--------|---------|-------------|
+| `write(value)` | `Promise<boolean>` | Write the value, returns success |
+| `cancelWrite()` | result or `undefined` | Cancel an in-progress write |
+| `drop()` | `void` | Release the future handle |
+
+### Resource Cleanup
+
+Stream and future handles support
+[Explicit Resource Management](https://github.com/tc39/proposal-explicit-resource-management)
+via `Symbol.dispose`. In environments that support `using`:
+
+```js
+{
+    using stream = wit.Stream();
+    // stream.writable and stream.readable are auto-dropped when leaving scope
+}
+```
+
+Otherwise, call `.drop()` explicitly to release handles.
+
+## Node.js API
+
+The npm package exposes both a CLI and a programmatic API.
+
+### CLI
+
+```bash
+npx componentize-qjs --wit hello.wit --js hello.js -o hello.wasm
+```
+
+(Or, if you installed the package globally, just `componentize-qjs ...`.)
+
+### Usage
+
+```js
+import { componentize } from "componentize-qjs";
+
+const { component } = await componentize({
+    witPath: "hello.wit",
+    jsSource: "export function greet(name) { return `Hello, ${name}!`; }",
+    optSize: true,
+});
+// component is a Buffer containing the WebAssembly component bytes
+```
+
+Runtime selection is available through `optSize`, `runtime`, or `runtimeBytes`; provide only one of those options. The `runtime` option is a path to a custom QuickJS runtime Wasm module.
+
+## Acknowledgments
+
+This project builds on ideas and code from:
+
+- [ComponentizeJS](https://github.com/dicej/componentize-js) by Joel Dice
+- [lua-component-demo](https://github.com/alexcrichton/lua-component-demo) by Alex Crichton
+
+## License
+
+Licensed under [Apache-2.0](LICENSE).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@andreiltd/componentize-qjs-binding-win32-arm64-msvc",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "cpu": [
     "arm64"
   ],