@ohos-ports/componentize-qjs-binding-openharmony-arm64 0.0.0-stage → 0.4.5-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/README.md CHANGED
@@ -1,3 +1,518 @@
1
- # Temporary Holding Version
1
+ # componentize-qjs
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ [![CI](https://github.com/andreiltd/componentize-qjs/actions/workflows/ci.yml/badge.svg)](https://github.com/andreiltd/componentize-qjs/actions/workflows/ci.yml)
4
+ [![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
5
+
6
+ Convert JavaScript source code into
7
+ [WebAssembly components](https://component-model.bytecodealliance.org/) using
8
+ [QuickJS](https://github.com/quickjs-ng/quickjs).
9
+
10
+ ## Overview
11
+
12
+ `componentize-qjs` takes a JavaScript source file and a
13
+ [WIT](https://component-model.bytecodealliance.org/design/wit.html) definition,
14
+ and produces a standalone WebAssembly component that can run on any
15
+ component-model runtime (e.g. [Wasmtime](https://wasmtime.dev/)).
16
+
17
+ Under the hood it:
18
+
19
+ 1. Embeds the [QuickJS](https://github.com/quickjs-ng/quickjs) engine (via
20
+ [rquickjs](https://github.com/DelSkayn/rquickjs)) as the JavaScript
21
+ runtime.
22
+ 2. Uses [wit-dylib](https://crates.io/crates/wit-dylib) to generate WIT
23
+ bindings that bridge the component model and the JS engine.
24
+ 3. Snapshots the initialized JS state with
25
+ [Wizer](https://github.com/bytecodealliance/wizer) so startup cost is paid at
26
+ build time, not at runtime.
27
+
28
+ ## Prerequisites
29
+
30
+ Rust **1.94** or later is required (the `wasm32-wasip2` target needs a recent
31
+ toolchain for PIC support in wasi-libc).
32
+
33
+ ## Installation
34
+
35
+ ### Rust CLI (crates.io)
36
+
37
+ ```bash
38
+ cargo install componentize-qjs-cli --locked
39
+ ```
40
+
41
+ This installs the `componentize-qjs` command.
42
+
43
+ ### Rust CLI (from source)
44
+
45
+ ```bash
46
+ cargo install --path . --locked
47
+ ```
48
+
49
+ ### Prebuilt CLI binaries
50
+
51
+ Prebuilt CLI archives are attached to each
52
+ [GitHub release](https://github.com/andreiltd/componentize-qjs/releases) for
53
+ Linux, macOS, and Windows.
54
+
55
+ ### npm package
56
+
57
+ ```bash
58
+ npm install componentize-qjs
59
+ ```
60
+
61
+ This pulls in the right prebuilt native binding for your platform via the
62
+ `@andreiltd/componentize-qjs-binding-*` optional dependencies.
63
+
64
+ If you want to build from source run:
65
+
66
+ ```bash
67
+ cd npm && npm install && npm run build
68
+ ```
69
+
70
+ ## Quick Start
71
+
72
+ **1. Define a WIT interface** (`hello.wit`):
73
+
74
+ ```wit
75
+ package test:hello;
76
+
77
+ world hello {
78
+ export greet: func(name: string) -> string;
79
+ }
80
+ ```
81
+
82
+ **2. Implement it in JavaScript** (`hello.js`):
83
+
84
+ JavaScript sources are ES modules. Export WIT functions and interfaces directly
85
+ from the module.
86
+
87
+ ```js
88
+ export function greet(name) {
89
+ return `Hello, ${name}!`;
90
+ }
91
+ ```
92
+
93
+ **3. Build the component:**
94
+
95
+ ```bash
96
+ componentize-qjs --wit hello.wit --js hello.js -o hello.wasm
97
+ ```
98
+
99
+ **4. Run it:**
100
+
101
+ ```bash
102
+ wasmtime run --wasm component-model-async=y --invoke 'greet("World")' hello.wasm
103
+ # "Hello, World!"
104
+ ```
105
+
106
+ The built-in runtime published with componentize-qjs includes component-model
107
+ async support. Pass `--sync` to embed the built-in non-async runtime instead,
108
+ producing components that run on hosts without component-model async support. A
109
+ custom runtime can also be supplied with `--runtime`.
110
+
111
+ ## CLI Reference
112
+
113
+ ```
114
+ componentize-qjs [OPTIONS] --wit <WIT> --js <JS>
115
+ ```
116
+
117
+ | Flag | Short | Description |
118
+ |---|---|---|
119
+ | `--wit <PATH>` | `-w` | Path to the WIT file or directory |
120
+ | `--js <PATH>` | `-j` | Path to the JavaScript source file |
121
+ | `--output <PATH>` | `-o` | Output path (default: `output.wasm`) |
122
+ | `--module-root <PATH>` | | Root directory exposed read-only during Wizer for resolving JavaScript imports |
123
+ | `--world <NAME>` | `-n` | World name when the WIT defines multiple worlds |
124
+ | `--stub-wasi` | | Replace all WASI imports with trap stubs |
125
+ | `--minify` | `-m` | Minify JS source before embedding |
126
+ | `--opt-size` | | Use the built-in QuickJS runtime optimized for size |
127
+ | `--sync` | | Use the built-in non-async runtime (combine with `--opt-size` for the non-async opt-size runtime) |
128
+ | `--runtime <PATH>` | | Custom QuickJS runtime Wasm module to embed |
129
+
130
+ ### Cargo features
131
+
132
+ | Feature | Effect |
133
+ |---|---|
134
+ | `component-model-async` | (default) Embed the component-model async runtime as the default built-in. The non-async runtime is always embedded and selectable via `--sync`. Disable to build a smaller binary with only the non-async runtime |
135
+ | `opt-size` | Selects the bundled opt-size runtime when no runtime option is provided by the CLI or npm API |
136
+
137
+ Build with features:
138
+
139
+ ```bash
140
+ cargo build --release --features opt-size
141
+ ```
142
+
143
+ ## Using Imports
144
+
145
+ WIT imports are available as ES module imports using their fully-qualified WIT
146
+ interface name:
147
+
148
+ ```wit
149
+ // imports.wit
150
+ package local:test;
151
+
152
+ interface math {
153
+ add: func(a: s32, b: s32) -> s32;
154
+ multiply: func(a: s32, b: s32) -> s32;
155
+ }
156
+
157
+ world imports {
158
+ import math;
159
+ export double-add: func(a: s32, b: s32) -> s32;
160
+ }
161
+ ```
162
+
163
+ ```js
164
+ // imports.js
165
+ import math from "local:test/math";
166
+
167
+ export function doubleAdd(a, b) {
168
+ const sum = math.add(a, b);
169
+ return math.multiply(sum, 2);
170
+ }
171
+ ```
172
+
173
+ JavaScript modules imported by the entry file are resolved during Wizer
174
+ initialization. Relative imports are resolved from the entry file path passed to
175
+ `--js`; bare package imports are resolved under the read-only module root. By
176
+ default the CLI uses the current directory when the entry file is under it, or
177
+ the entry file's parent directory otherwise. Use `--module-root <PATH>` to expose
178
+ a project root that contains shared files or `node_modules`.
179
+
180
+ ## WIT Type Mappings
181
+
182
+ ### Primitive Types
183
+
184
+ | WIT Type | JS Type | Notes |
185
+ |----------|---------|-------|
186
+ | `bool` | `boolean` | |
187
+ | `u8`, `u16`, `u32` | `number` | |
188
+ | `s8`, `s16`, `s32` | `number` | |
189
+ | `u64`, `s64` | `number` | Precision limited to 2⁵³ (Number.MAX_SAFE_INTEGER) |
190
+ | `f32`, `f64` | `number` | |
191
+ | `char` | `string` | Must be exactly one Unicode scalar value |
192
+ | `string` | `string` | |
193
+
194
+ ### Compound Types
195
+
196
+ | WIT Type | JS Type | Example |
197
+ |----------|---------|---------|
198
+ | `list<T>` | `Array` | `[1, 2, 3]` |
199
+ | `list<u8>` | `Uint8Array` or `Array` | `new Uint8Array([1, 2, 3])` |
200
+ | `map<K, V>` | `Map` | `new Map([["key", value]])` |
201
+ | `tuple<T, U, ...>` | `Array` | `[42, "hello"]` |
202
+ | `option<T>` | `T \| null` (nested: `{ tag: "some"\|"none", val }`) | `null` for none; `option<option<T>>` is wrapped |
203
+ | `result<T, E>` | top-level function result: return `T` or throw `E`; nested result: `{ tag: "ok"\|"err", val?: T\|E }` | `return 42` / `throw "error"` |
204
+ | `record { ... }` | `object` (camelCase keys) | `{ myField: 1 }` |
205
+ | `variant` | `{ tag: string, val?: T }` | `{ tag: "circle", val: 2.5 }` |
206
+ | `enum` | `string` (case name) | `"red"` |
207
+ | `flags` | `object` (camelCase booleans) | `{ read: true, write: false }` |
208
+ | `own<R>`, `borrow<R>` | resource object (methods on its prototype) | `input.blockingRead(n)` |
209
+
210
+ ### Imported Resources
211
+
212
+ Imported resources are exposed as JavaScript classes. Resource methods are
213
+ called on the handle:
214
+
215
+ ```js
216
+ import stdin from "wasi:cli/stdin@0.2.12";
217
+ import stdout from "wasi:cli/stdout@0.2.12";
218
+
219
+ const input = stdin.getStdin(); // an InputStream
220
+ const output = stdout.getStdout(); // an OutputStream
221
+
222
+ // Methods whose WIT return type is result<...> return the ok payload or throw.
223
+ const chunk = input.blockingRead(4096); // method on the resource (len is a number)
224
+ output.blockingWriteAndFlush(chunk);
225
+ ```
226
+
227
+ `[static]` methods are exposed on the resource class and `[constructor]` makes
228
+ the class callable with `new`.
229
+
230
+ Owned imported resources support `[Symbol.dispose]()` for deterministic
231
+ cleanup. Passing one to a WIT `own<T>` parameter transfers ownership and
232
+ invalidates the original wrapper. Borrowed wrappers expire when their component
233
+ call completes and cannot be transferred or disposed as owners. Resources lent
234
+ to an in-flight import remain alive and cannot be disposed or transferred until
235
+ that import completes. Ownership is restored for unconsumed stream/future writes
236
+ and for imported calls cancelled before they start. Await imports using an
237
+ incoming borrowed resource before returning from its export.
238
+
239
+ ### Async Exports
240
+
241
+ Async exports are declared with the `async` keyword in WIT and implemented
242
+ as JavaScript `async` functions:
243
+
244
+ ```wit
245
+ package example:greeting;
246
+
247
+ world greeter {
248
+ export greet: async func(name: string) -> string;
249
+ }
250
+ ```
251
+
252
+ ```js
253
+ export async function greet(name) {
254
+ // You can use await here
255
+ await Promise.resolve();
256
+ return `Hello, ${name}!`;
257
+ }
258
+ ```
259
+
260
+ Exported resource methods and static methods may also be async. Implement them
261
+ as `async` members on the exported JavaScript class; resource constructors
262
+ remain synchronous:
263
+
264
+ ```wit
265
+ package example:counter;
266
+
267
+ interface counter-api {
268
+ resource counter {
269
+ constructor(initial: u32);
270
+ add: async func(value: u32) -> u32;
271
+ create: static async func(initial: u32) -> counter;
272
+ }
273
+ }
274
+
275
+ world counter {
276
+ export counter-api;
277
+ }
278
+ ```
279
+
280
+ ```js
281
+ class Counter {
282
+ constructor(initial) { this.value = initial; }
283
+ async add(value) { this.value += value; return this.value; }
284
+ static async create(initial) { return new this(initial); }
285
+ }
286
+
287
+ export const counterApi = { Counter };
288
+ ```
289
+
290
+ ### Streams
291
+
292
+ Streams transfer a sequence of values between components. Lifted WIT streams
293
+ implement the JavaScript async-iterable protocol, and async or synchronous
294
+ iterables are lowered to WIT streams automatically. The stream type is inferred
295
+ from the function parameter or result:
296
+
297
+ ```wit
298
+ package example:streaming;
299
+
300
+ world streaming {
301
+ export uppercase: async func(input: stream<string>) -> stream<string>;
302
+ }
303
+ ```
304
+
305
+ ```js
306
+ export async function uppercase(input) {
307
+ return (async function* () {
308
+ for await (const value of input) {
309
+ yield value.toUpperCase();
310
+ }
311
+ })();
312
+ }
313
+ ```
314
+
315
+ Async iteration yields one element at a time, except for `stream<u8>`, which
316
+ yields bounded `Uint8Array` chunks to avoid one promise per byte.
317
+
318
+ Use the `wit.Stream` factory when direct access to both endpoints is needed. If
319
+ only one stream type exists in the WIT world, the type may be omitted:
320
+
321
+ ```js
322
+ const { readable, writable } = wit.Stream(wit.Stream.U8);
323
+ await writable.writeAll(new Uint8Array([1, 2, 3]));
324
+ writable.drop();
325
+ ```
326
+
327
+ `wit.Stream.from` adapts an iterable explicitly and exposes a completion
328
+ promise:
329
+
330
+ ```js
331
+ const source = (async function* () {
332
+ yield "one";
333
+ yield "two";
334
+ })();
335
+ const { readable, completion } = wit.Stream.from(source, wit.Stream.STRING);
336
+ ```
337
+
338
+ Available type constants (populated from WIT metadata):
339
+
340
+ | WIT type | Constant |
341
+ |----------|----------|
342
+ | `stream<u8>` / `future<u8>` | `wit.Stream.U8` / `wit.Future.U8` |
343
+ | `stream<u32>` / `future<u32>` | `wit.Stream.U32` / `wit.Future.U32` |
344
+ | `stream<string>` / `future<string>` | `wit.Stream.STRING` / `wit.Future.STRING` |
345
+ | `stream<f64>` / `future<f64>` | `wit.Stream.F64` / `wit.Future.F64` |
346
+
347
+ All constructors return `{ readable, writable }`.
348
+
349
+ **Complex element types** are also supported. The type constant is generated
350
+ recursively from the WIT type structure:
351
+
352
+ ```js
353
+ // stream<result<string, u32>>
354
+ wit.Stream(wit.Stream.RESULT_STRING_U32);
355
+
356
+ // stream<option<u32>>
357
+ wit.Stream(wit.Stream.OPTION_U32);
358
+
359
+ // stream<tuple<u32, string>>
360
+ wit.Stream(wit.Stream.TUPLE_U32_STRING);
361
+
362
+ // Named record types use their WIT name:
363
+ // record point { x: f64, y: f64 }
364
+ // stream<point>
365
+ wit.Stream(wit.Stream.POINT);
366
+ ```
367
+
368
+ Explicit WIT stream aliases are also exposed as constants:
369
+
370
+ ```wit
371
+ type prompt-stream = stream<message-chunk>;
372
+ ```
373
+
374
+ ```js
375
+ wit.Stream(wit.Stream.PROMPT_STREAM);
376
+ ```
377
+
378
+ Use `wit.Stream.types` or `wit.Future.types` to discover all available type
379
+ constants at runtime.
380
+
381
+ **StreamReadable methods:**
382
+
383
+ | Method | Returns | Description |
384
+ |--------|---------|-------------|
385
+ | `read(count?)` | `Promise<T[]>` (or `Uint8Array` for `u8`) | Read up to `count` values |
386
+ | `next()` | `Promise<IteratorResult<T>>` | Read the next value (`Uint8Array` chunk for `u8`) |
387
+ | `return()` | `Promise<IteratorResult<T>>` | End iteration and release the readable handle |
388
+ | `cancelRead()` | result or `undefined` | Cancel an in-progress read |
389
+ | `drop()` | `void` | Release the stream handle |
390
+ | `[Symbol.asyncIterator]()` | `StreamReadable` | Consume the stream with `for await...of` |
391
+
392
+ **StreamWritable methods:**
393
+
394
+ | Method | Returns | Description |
395
+ |--------|---------|-------------|
396
+ | `write(data)` | `Promise<number>` | Write values, returns count written |
397
+ | `writeOne(value)` | `Promise<number>` | Write exactly one value, including array-shaped WIT values |
398
+ | `writeAll(data)` | `Promise<number>` | Write all values, retrying as needed |
399
+ | `writeIterableItem(value)` | `Promise<boolean>` | Write one iterable yield, batching matching numeric typed arrays |
400
+ | `cancelWrite()` | result or `undefined` | Cancel an in-progress write |
401
+ | `drop()` | `void` | Release the stream handle |
402
+
403
+ ### Futures
404
+
405
+ Futures transfer a single value. They work like streams but carry exactly one
406
+ value:
407
+
408
+ ```wit
409
+ package example:async-value;
410
+
411
+ world async-value {
412
+ export compute: async func() -> future<string>;
413
+ }
414
+ ```
415
+
416
+ ```js
417
+ export async function compute() {
418
+ const { readable, writable } = wit.Future();
419
+
420
+ // Write the value (fire-and-forget; completes when reader reads)
421
+ writable.write("computed result");
422
+
423
+ return readable;
424
+ }
425
+ ```
426
+
427
+ **Future type constants** follow the same pattern: `wit.Future.U32`,
428
+ `wit.Future.STRING`, etc.
429
+
430
+ Future handles are deliberately not thenable: use `await readable.read()` to
431
+ obtain the payload. This keeps `return readable` in an async export from
432
+ implicitly consuming the future, and preserves nested future handles.
433
+ Repeated `read()` calls share the same Promise; a cancelled read rejects that
434
+ Promise and allows a subsequent read to retry.
435
+
436
+ `wit.Future.from(value, type)` adapts a value or Promise and returns
437
+ `{ readable, completion }`. Return its `readable` from an async export rather
438
+ than returning the payload Promise directly, which JavaScript would await.
439
+
440
+ **FutureReadable methods:**
441
+
442
+ | Method | Returns | Description |
443
+ |--------|---------|-------------|
444
+ | `read()` | `Promise<T>` | Read the single value |
445
+ | `cancelRead()` | result or `undefined` | Cancel an in-progress read |
446
+ | `drop()` | `void` | Release the future handle |
447
+
448
+ **FutureWritable methods:**
449
+
450
+ | Method | Returns | Description |
451
+ |--------|---------|-------------|
452
+ | `write(value)` | `Promise<boolean>` | Write the value, returns success |
453
+ | `cancelWrite()` | result or `undefined` | Cancel an in-progress write |
454
+ | `drop()` | `void` | Release the future handle |
455
+
456
+ ### Resource Cleanup
457
+
458
+ Owned imported resources, stream endpoints, and future endpoints support
459
+ [Explicit Resource Management](https://github.com/tc39/proposal-explicit-resource-management)
460
+ via `Symbol.dispose`. In environments that support `using`:
461
+
462
+ ```js
463
+ {
464
+ const stream = wit.Stream();
465
+ using writable = stream.writable;
466
+ using readable = stream.readable;
467
+ // Each endpoint is disposed when leaving scope.
468
+ }
469
+ ```
470
+
471
+ The factory's `{ readable, writable }` pair is not itself disposable.
472
+ Complete an endpoint's pending operation (or cancel it and await its
473
+ settlement) before leaving its `using` scope or calling `.drop()`.
474
+ Host-requested task cancellation retains pending ABI buffers until the host
475
+ acknowledges each operation's completion or cancellation.
476
+
477
+ Otherwise, call `.drop()` explicitly to release handles.
478
+
479
+ ## Node.js API
480
+
481
+ The npm package exposes both a CLI and a programmatic API.
482
+
483
+ ### CLI
484
+
485
+ ```bash
486
+ npx componentize-qjs --wit hello.wit --js hello.js -o hello.wasm
487
+ ```
488
+
489
+ (Or, if you installed the package globally, just `componentize-qjs ...`.)
490
+
491
+ ### Usage
492
+
493
+ ```js
494
+ import { componentize } from "componentize-qjs";
495
+
496
+ const { component } = await componentize({
497
+ witPath: "hello.wit",
498
+ jsSource: "export function greet(name) { return `Hello, ${name}!`; }",
499
+ optSize: true,
500
+ });
501
+ // component is a Buffer containing the WebAssembly component bytes
502
+ ```
503
+
504
+ Runtime selection is available through `optSize`, `sync`, `runtime`, or
505
+ `runtimeBytes`. `optSize` and `sync` may be combined to select the non-async
506
+ opt-size runtime, but neither can be combined with a custom `runtime`/`runtimeBytes`.
507
+ The `runtime` option is a path to a custom QuickJS runtime Wasm module.
508
+
509
+ ## Acknowledgments
510
+
511
+ This project builds on ideas and code from:
512
+
513
+ - [ComponentizeJS](https://github.com/dicej/componentize-js) by Joel Dice
514
+ - [lua-component-demo](https://github.com/alexcrichton/lua-component-demo) by Alex Crichton
515
+
516
+ ## License
517
+
518
+ Licensed under [Apache-2.0](LICENSE).
@@ -0,0 +1,4 @@
1
+ [diffend] Oversized file quarantined before diffing.
2
+ name: package/componentize-qjs.openharmony-arm64.node
3
+ size: 33617728 bytes
4
+ sha256: 21bb097022ffed536c4fceb11df264d178068e6279098c93a0c97d413cc6adc5
package/package.json CHANGED
@@ -1,6 +1,27 @@
1
1
  {
2
2
  "name": "@ohos-ports/componentize-qjs-binding-openharmony-arm64",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "0.4.5-beta.2",
4
+ "cpu": "arm64",
5
+ "main": "componentize-qjs.openharmony-arm64.node",
6
+ "files": [
7
+ "componentize-qjs.openharmony-arm64.node"
8
+ ],
9
+ "description": "Convert JavaScript to WebAssembly components using QuickJS",
10
+ "homepage": "https://github.com/andreiltd/componentize-qjs",
11
+ "license": "Apache-2.0",
12
+ "engines": {
13
+ "node": ">=18.0.0"
14
+ },
15
+ "repository": {
16
+ "type": "git",
17
+ "url": "git+https://github.com/ohos-ports/ohos-ports.git",
18
+ "directory": "ports/componentize-qjs-binding-openharmony-arm64/0.4.5"
19
+ },
20
+ "bugs": {
21
+ "url": "https://github.com/ohos-ports/ohos-ports/issues"
22
+ },
23
+ "publishConfig": {
24
+ "access": "public"
25
+ },
26
+ "os": "openharmony"
27
+ }