@ruby/wasm-wasi 2.6.2 → 2.7.0

package/dist/cjs/bindgen/legacy/rb-abi-guest.js

@@ -1,42 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RbAbiValue = exports.RbIseq = exports.RbAbiGuest = void 0;
+exports.RbAbiValue = exports.RbAbiGuest = void 0;
 const intrinsics_js_1 = require("./intrinsics.js");
 class RbAbiGuest {
     constructor() {
         this._resource0_slab = new intrinsics_js_1.Slab();
-        this._resource1_slab = new intrinsics_js_1.Slab();
     }
     addToImports(imports) {
         if (!("canonical_abi" in imports))
             imports["canonical_abi"] = {};
-        imports.canonical_abi['resource_drop_rb-iseq'] = i => {
+        imports.canonical_abi['resource_drop_rb-abi-value'] = i => {
             this._resource0_slab.remove(i).drop();
         };
-        imports.canonical_abi['resource_clone_rb-iseq'] = i => {
+        imports.canonical_abi['resource_clone_rb-abi-value'] = i => {
             const obj = this._resource0_slab.get(i);
             return this._resource0_slab.insert(obj.clone());
         };
-        imports.canonical_abi['resource_get_rb-iseq'] = i => {
-            return this._resource0_slab.get(i)._wasm_val;
-        };
-        imports.canonical_abi['resource_new_rb-iseq'] = i => {
-            const registry = this._registry0;
-            return this._resource0_slab.insert(new RbIseq(i, this));
-        };
-        imports.canonical_abi['resource_drop_rb-abi-value'] = i => {
-            this._resource1_slab.remove(i).drop();
-        };
-        imports.canonical_abi['resource_clone_rb-abi-value'] = i => {
-            const obj = this._resource1_slab.get(i);
-            return this._resource1_slab.insert(obj.clone());
-        };
         imports.canonical_abi['resource_get_rb-abi-value'] = i => {
-            return this._resource1_slab.get(i)._wasm_val;
+            return this._resource0_slab.get(i)._wasm_val;
         };
         imports.canonical_abi['resource_new_rb-abi-value'] = i => {
-            const registry = this._registry1;
-            return this._resource1_slab.insert(new RbAbiValue(i, this));
+            const registry = this._registry0;
+            return this._resource0_slab.insert(new RbAbiValue(i, this));
         };
     }
     async instantiate(module, imports) {
@@ -57,32 +42,12 @@ class RbAbiGuest {
             this.instance = instance;
         }
         this._exports = this.instance.exports;
-        this._registry0 = new FinalizationRegistry(this._exports['canonical_abi_drop_rb-iseq']);
-        this._registry1 = new FinalizationRegistry(this._exports['canonical_abi_drop_rb-abi-value']);
+        this._registry0 = new FinalizationRegistry(this._exports['canonical_abi_drop_rb-abi-value']);
     }
     rubyShowVersion() {
         this._exports['ruby-show-version: func() -> ()']();
     }
-    rubyInit() {
-        this._exports['ruby-init: func() -> ()']();
-    }
-    rubySysinit(arg0) {
-        const memory = this._exports.memory;
-        const realloc = this._exports["cabi_realloc"];
-        const vec1 = arg0;
-        const len1 = vec1.length;
-        const result1 = realloc(0, 0, 4, len1 * 8);
-        for (let i = 0; i < vec1.length; i++) {
-            const e = vec1[i];
-            const base = result1 + i * 8;
-            const ptr0 = (0, intrinsics_js_1.utf8_encode)(e, realloc, memory);
-            const len0 = intrinsics_js_1.UTF8_ENCODED_LEN;
-            (0, intrinsics_js_1.data_view)(memory).setInt32(base + 4, len0, true);
-            (0, intrinsics_js_1.data_view)(memory).setInt32(base + 0, ptr0, true);
-        }
-        this._exports['ruby-sysinit: func(args: list<string>) -> ()'](result1, len1);
-    }
-    rubyOptions(arg0) {
+    rubyInit(arg0) {
         const memory = this._exports.memory;
         const realloc = this._exports["cabi_realloc"];
         const vec1 = arg0;
@@ -96,15 +61,7 @@ class RbAbiGuest {
             (0, intrinsics_js_1.data_view)(memory).setInt32(base + 4, len0, true);
             (0, intrinsics_js_1.data_view)(memory).setInt32(base + 0, ptr0, true);
         }
-        const ret = this._exports['ruby-options: func(args: list<string>) -> handle<rb-iseq>'](result1, len1);
-        return this._resource0_slab.remove(ret);
-    }
-    rubyScript(arg0) {
-        const memory = this._exports.memory;
-        const realloc = this._exports["cabi_realloc"];
-        const ptr0 = (0, intrinsics_js_1.utf8_encode)(arg0, realloc, memory);
-        const len0 = intrinsics_js_1.UTF8_ENCODED_LEN;
-        this._exports['ruby-script: func(name: string) -> ()'](ptr0, len0);
+        this._exports['ruby-init: func(args: list<string>) -> ()'](result1, len1);
     }
     rubyInitLoadpath() {
         this._exports['ruby-init-loadpath: func() -> ()']();
@@ -115,7 +72,7 @@ class RbAbiGuest {
         const ptr0 = (0, intrinsics_js_1.utf8_encode)(arg0, realloc, memory);
         const len0 = intrinsics_js_1.UTF8_ENCODED_LEN;
         const ret = this._exports['rb-eval-string-protect: func(str: string) -> tuple<handle<rb-abi-value>, s32>'](ptr0, len0);
-        return [this._resource1_slab.remove((0, intrinsics_js_1.data_view)(memory).getInt32(ret + 0, true)), (0, intrinsics_js_1.data_view)(memory).getInt32(ret + 4, true)];
+        return [this._resource0_slab.remove((0, intrinsics_js_1.data_view)(memory).getInt32(ret + 0, true)), (0, intrinsics_js_1.data_view)(memory).getInt32(ret + 4, true)];
     }
     rbFuncallvProtect(arg0, arg1, arg2) {
         const memory = this._exports.memory;
@@ -132,10 +89,10 @@ class RbAbiGuest {
             const obj1 = e;
             if (!(obj1 instanceof RbAbiValue))
                 throw new TypeError('expected instance of RbAbiValue');
-            (0, intrinsics_js_1.data_view)(memory).setInt32(base + 0, this._resource1_slab.insert(obj1.clone()), true);
+            (0, intrinsics_js_1.data_view)(memory).setInt32(base + 0, this._resource0_slab.insert(obj1.clone()), true);
         }
-        const ret = this._exports['rb-funcallv-protect: func(recv: handle<rb-abi-value>, mid: u32, args: list<handle<rb-abi-value>>) -> tuple<handle<rb-abi-value>, s32>'](this._resource1_slab.insert(obj0.clone()), (0, intrinsics_js_1.to_uint32)(arg1), result2, len2);
-        return [this._resource1_slab.remove((0, intrinsics_js_1.data_view)(memory).getInt32(ret + 0, true)), (0, intrinsics_js_1.data_view)(memory).getInt32(ret + 4, true)];
+        const ret = this._exports['rb-funcallv-protect: func(recv: handle<rb-abi-value>, mid: u32, args: list<handle<rb-abi-value>>) -> tuple<handle<rb-abi-value>, s32>'](this._resource0_slab.insert(obj0.clone()), (0, intrinsics_js_1.to_uint32)(arg1), result2, len2);
+        return [this._resource0_slab.remove((0, intrinsics_js_1.data_view)(memory).getInt32(ret + 0, true)), (0, intrinsics_js_1.data_view)(memory).getInt32(ret + 4, true)];
     }
     rbIntern(arg0) {
         const memory = this._exports.memory;
@@ -147,7 +104,7 @@ class RbAbiGuest {
     }
     rbErrinfo() {
         const ret = this._exports['rb-errinfo: func() -> handle<rb-abi-value>']();
-        return this._resource1_slab.remove(ret);
+        return this._resource0_slab.remove(ret);
     }
     rbClearErrinfo() {
         this._exports['rb-clear-errinfo: func() -> ()']();
@@ -157,7 +114,7 @@ class RbAbiGuest {
         const obj0 = arg0;
         if (!(obj0 instanceof RbAbiValue))
             throw new TypeError('expected instance of RbAbiValue');
-        const ret = this._exports['rstring-ptr: func(value: handle<rb-abi-value>) -> string'](this._resource1_slab.insert(obj0.clone()));
+        const ret = this._exports['rstring-ptr: func(value: handle<rb-abi-value>) -> string'](this._resource0_slab.insert(obj0.clone()));
         const ptr1 = (0, intrinsics_js_1.data_view)(memory).getInt32(ret + 0, true);
         const len1 = (0, intrinsics_js_1.data_view)(memory).getInt32(ret + 4, true);
         const result1 = intrinsics_js_1.UTF8_DECODER.decode(new Uint8Array(memory.buffer, ptr1, len1));
@@ -184,7 +141,7 @@ class RbAbiGuest {
     }
 }
 exports.RbAbiGuest = RbAbiGuest;
-class RbIseq {
+class RbAbiValue {
     constructor(wasm_val, obj) {
         this._wasm_val = wasm_val;
         this._obj = obj;
@@ -200,31 +157,6 @@ class RbIseq {
         if (this._refcnt !== 0)
             return;
         this._obj._registry0.unregister(this);
-        const dtor = this._obj._exports['canonical_abi_drop_rb-iseq'];
-        const wasm_val = this._wasm_val;
-        delete this._obj;
-        delete this._refcnt;
-        delete this._wasm_val;
-        dtor(wasm_val);
-    }
-}
-exports.RbIseq = RbIseq;
-class RbAbiValue {
-    constructor(wasm_val, obj) {
-        this._wasm_val = wasm_val;
-        this._obj = obj;
-        this._refcnt = 1;
-        obj._registry1.register(this, wasm_val, this);
-    }
-    clone() {
-        this._refcnt += 1;
-        return this;
-    }
-    drop() {
-        this._refcnt -= 1;
-        if (this._refcnt !== 0)
-            return;
-        this._obj._registry1.unregister(this);
         const dtor = this._obj._exports['canonical_abi_drop_rb-abi-value'];
         const wasm_val = this._wasm_val;
         delete this._obj;

package/dist/cjs/bindgen/legacy/rb-js-abi-host.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.addRbJsAbiHostToImports = void 0;
+exports.addRbJsAbiHostToImports = addRbJsAbiHostToImports;
 const intrinsics_js_1 = require("./intrinsics.js");
 function addRbJsAbiHostToImports(imports, obj, get_export) {
     if (!("rb-js-abi-host" in imports))
@@ -280,4 +280,3 @@ function addRbJsAbiHostToImports(imports, obj, get_export) {
             obj.dropJsAbiValue(val);
     };
 }
-exports.addRbJsAbiHostToImports = addRbJsAbiHostToImports;

package/dist/cjs/binding.d.ts

@@ -6,10 +6,7 @@ import * as RbAbi from "./bindgen/legacy/rb-abi-guest.js";
  */
 export interface Binding {
     rubyShowVersion(): void;
-    rubyInit(): void;
-    rubySysinit(args: string[]): void;
-    rubyOptions(args: string[]): void;
-    rubyScript(name: string): void;
+    rubyInit(args: string[]): void;
     rubyInitLoadpath(): void;
     rbEvalStringProtect(str: string): [RbAbiValue, number];
     rbFuncallvProtect(recv: RbAbiValue, mid: RbAbi.RbId, args: RbAbiValue[]): [RbAbiValue, number];
@@ -34,10 +31,7 @@ export declare class ComponentBinding implements Binding {
     constructor();
     setUnderlying(underlying: typeof RubyJsRubyRuntime): void;
     rubyShowVersion(): void;
-    rubyInit(): void;
-    rubySysinit(args: string[]): void;
-    rubyOptions(args: string[]): void;
-    rubyScript(name: string): void;
+    rubyInit(args: string[]): void;
     rubyInitLoadpath(): void;
     rbEvalStringProtect(str: string): [RbAbiValue, number];
     rbFuncallvProtect(recv: RbAbiValue, mid: number, args: RbAbiValue[]): [RbAbiValue, number];

package/dist/cjs/binding.js

@@ -17,17 +17,8 @@ class ComponentBinding {
     rubyShowVersion() {
         this.underlying.rubyShowVersion();
     }
-    rubyInit() {
-        this.underlying.rubyInit();
-    }
-    rubySysinit(args) {
-        this.underlying.rubySysinit(args);
-    }
-    rubyOptions(args) {
-        this.underlying.rubyOptions(args);
-    }
-    rubyScript(name) {
-        this.underlying.rubyScript(name);
+    rubyInit(args) {
+        this.underlying.rubyInit(args);
     }
     rubyInitLoadpath() {
         this.underlying.rubyInitLoadpath();

package/dist/cjs/browser.js

@@ -15,18 +15,16 @@ const DefaultRubyVM = async (rubyModule, options = {}) => {
         new browser_wasi_shim_1.PreopenDirectory("/", new Map()),
     ];
     const wasi = new browser_wasi_shim_1.WASI(args, env, fds, { debug: false });
-    const vm = new vm_js_1.RubyVM();
-    const imports = {
-        wasi_snapshot_preview1: wasi.wasiImport,
-    };
-    vm.addToImports(imports);
     const printer = ((_b = options.consolePrint) !== null && _b !== void 0 ? _b : true) ? (0, console_js_1.consolePrinter)() : undefined;
-    printer === null || printer === void 0 ? void 0 : printer.addToImports(imports);
-    const instance = await WebAssembly.instantiate(rubyModule, imports);
-    await vm.setInstance(instance);
-    printer === null || printer === void 0 ? void 0 : printer.setMemory(instance.exports.memory);
-    wasi.initialize(instance);
-    vm.initialize();
+    const { vm, instance } = await vm_js_1.RubyVM.instantiateModule({
+        module: rubyModule, wasip1: wasi,
+        addToImports: (imports) => {
+            printer === null || printer === void 0 ? void 0 : printer.addToImports(imports);
+        },
+        setMemory: (memory) => {
+            printer === null || printer === void 0 ? void 0 : printer.setMemory(memory);
+        }
+    });
     return {
         vm,
         wasi,

package/dist/cjs/browser.script.d.ts

@@ -1,5 +1,19 @@
 import { DefaultRubyVM } from "./browser.js";
+import { RubyComponentInstantiator } from "./vm.js";
+/**
+ * The main entry point of `<script type="text/ruby">`-based scripting with WebAssembly Core Module.
+ */
 export declare const main: (pkg: {
     name: string;
     version: string;
 }, options?: Parameters<typeof DefaultRubyVM>[1]) => Promise<void>;
+/**
+ * The main entry point of `<script type="text/ruby">`-based scripting with WebAssembly Component.
+ */
+export declare const componentMain: (pkg: {
+    name: string;
+    version: string;
+}, options: {
+    instantiate: RubyComponentInstantiator;
+    wasip2: any;
+}) => Promise<void>;

package/dist/cjs/browser.script.js

@@ -1,12 +1,33 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.main = void 0;
+exports.componentMain = exports.main = void 0;
 const tslib_1 = require("tslib");
 const browser_js_1 = require("./browser.js");
+const vm_js_1 = require("./vm.js");
+/**
+ * The main entry point of `<script type="text/ruby">`-based scripting with WebAssembly Core Module.
+ */
 const main = async (pkg, options) => {
     const response = fetch(`https://cdn.jsdelivr.net/npm/${pkg.name}@${pkg.version}/dist/ruby+stdlib.wasm`);
     const module = await compileWebAssemblyModule(response);
     const { vm } = await (0, browser_js_1.DefaultRubyVM)(module, options);
+    await mainWithRubyVM(vm);
+};
+exports.main = main;
+/**
+ * The main entry point of `<script type="text/ruby">`-based scripting with WebAssembly Component.
+ */
+const componentMain = async (pkg, options) => {
+    const componentUrl = `https://cdn.jsdelivr.net/npm/${pkg.name}@${pkg.version}/dist/component`;
+    const fetchComponentFile = (relativePath) => fetch(`${componentUrl}/${relativePath}`);
+    const { vm } = await vm_js_1.RubyVM.instantiateComponent(Object.assign(Object.assign({}, options), { getCoreModule: (relativePath) => {
+            const response = fetchComponentFile(relativePath);
+            return compileWebAssemblyModule(response);
+        } }));
+    await mainWithRubyVM(vm);
+};
+exports.componentMain = componentMain;
+const mainWithRubyVM = async (vm) => {
     vm.printVersion();
     globalThis.rubyVM = vm;
     // Wait for the text/ruby script tag to be read.
@@ -19,7 +40,6 @@ const main = async (pkg, options) => {
         runRubyScriptsInHtml(vm);
     }
 };
-exports.main = main;
 const runRubyScriptsInHtml = async (vm) => {
     var _a, e_1, _b, _c;
     const tags = document.querySelectorAll('script[type="text/ruby"]');

package/dist/cjs/console.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.consolePrinter = void 0;
+exports.consolePrinter = consolePrinter;
 /**
  * Create a console printer that can be used as an overlay of WASI imports.
  * See the example below for how to use it.
@@ -103,4 +103,3 @@ function consolePrinter({ stdout, stderr, } = {
         },
     };
 }
-exports.consolePrinter = consolePrinter;

package/dist/cjs/node.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { WASI } from "wasi";
 import { RubyVM } from "./vm.js";
 export declare const DefaultRubyVM: (rubyModule: WebAssembly.Module, options?: {

package/dist/cjs/node.js

@@ -5,15 +5,7 @@ const wasi_1 = require("wasi");
 const vm_js_1 = require("./vm.js");
 const DefaultRubyVM = async (rubyModule, options = {}) => {
     const wasi = new wasi_1.WASI({ env: options.env, version: "preview1", returnOnExit: true });
-    const vm = new vm_js_1.RubyVM();
-    const imports = {
-        wasi_snapshot_preview1: wasi.wasiImport,
-    };
-    vm.addToImports(imports);
-    const instance = await WebAssembly.instantiate(rubyModule, imports);
-    await vm.setInstance(instance);
-    wasi.initialize(instance);
-    vm.initialize();
+    const { vm, instance } = await vm_js_1.RubyVM.instantiateModule({ module: rubyModule, wasip1: wasi });
     return {
         vm,
         wasi,

package/dist/cjs/vm.d.ts

@@ -2,39 +2,172 @@ import type { RubyJsJsRuntime } from "./bindgen/interfaces/ruby-js-js-runtime.js
 import type { RubyJsRubyRuntime } from "./bindgen/interfaces/ruby-js-ruby-runtime.js";
 import { JsAbiValue } from "./bindgen/legacy/rb-js-abi-host.js";
 import { Binding, RbAbiValue } from "./binding.js";
+/**
+ * A function type that instantiates a Ruby component
+ */
+export type RubyComponentInstantiator = ((getCoreModule: (path: string) => WebAssembly.Module, importObject: any, instantiateCore?: (module: WebAssembly.Module, imports: Record<string, any>) => WebAssembly.Instance | Promise<WebAssembly.Instance>) => Promise<({
+    rubyRuntime: typeof RubyJsRubyRuntime;
+})>);
+export type RubyInitComponentOptions = {
+    /**
+     * A lower-level instantiation function that instantiates the Ruby component with the given component
+     * that implements "ruby:js/js-runtime" WIT interface.
+     */
+    instantiate: (_: typeof RubyJsJsRuntime) => Promise<typeof RubyJsRubyRuntime>;
+    /**
+     * The arguments to pass to the Ruby VM. Note that the first argument must be the Ruby program name.
+     *
+     * @default ["ruby.wasm", "-EUTF-8", "-e_=0"]
+     */
+    args?: string[];
+} | {
+    /**
+     * An `instantiate` function generated by `@bytecodealliance/jco` that instantiates the Ruby component.
+     */
+    instantiate: RubyComponentInstantiator;
+    /**
+     * A function that returns a WebAssembly Core module within the Ruby component transpiled by `@bytecodealliance/jco`.
+     */
+    getCoreModule: (path: string) => Promise<WebAssembly.Module>;
+    /**
+     * An optional function used to instantiate a WebAssembly Core module
+     */
+    instantiateCore?: (module: WebAssembly.Module, imports: Record<string, any>) => WebAssembly.Instance | Promise<WebAssembly.Instance>;
+    /**
+     * WASI Preview 2 implementation, typically imported from `import * as wasip2 from "@bytecodealliance/preview2-shim"`
+     */
+    wasip2: any;
+    /**
+     * The arguments to pass to the Ruby VM. Note that the first argument must be the Ruby program name.
+     *
+     * @default ["ruby.wasm", "-EUTF-8", "-e_=0"]
+     */
+    args?: string[];
+};
+export type RubyInitModuleOptions = {
+    /**
+     * The WebAssembly module that contains the Ruby VM
+     */
+    module: WebAssembly.Module;
+    /**
+     * WASI Preview 1 implementation supporting reactor model ABI
+     */
+    wasip1: {
+        wasiImport: WebAssembly.ModuleImports;
+        initialize(instance: WebAssembly.Instance): void;
+    };
+    /**
+     * The arguments to pass to the Ruby VM. Note that the first argument must be the Ruby program name.
+     * @default ["ruby.wasm", "-EUTF-8", "-e_=0"]
+     */
+    args?: string[];
+    /**
+     * A hook to add additional imports to the WebAssembly instance
+     */
+    addToImports?: (imports: WebAssembly.Imports) => void;
+    /**
+     * A hook called with the WebAssembly memory instance just after the Ruby VM is instantiated
+     */
+    setMemory?: (memory: WebAssembly.Memory) => void;
+};
+export type RubyInitOptions = RubyInitComponentOptions | RubyInitModuleOptions;
 /**
  * A Ruby VM instance
- *
- * @example
- *
- * const wasi = new WASI();
- * const vm = new RubyVM();
- * const imports = {
- *   wasi_snapshot_preview1: wasi.wasiImport,
- * };
- *
- * vm.addToImports(imports);
- *
- * const instance = await WebAssembly.instantiate(rubyModule, imports);
- * await vm.setInstance(instance);
- * wasi.initialize(instance);
- * vm.initialize();
- *
+ * @see {@link RubyVM.instantiateComponent} and {@link RubyVM.instantiateModule} to create a new instance
+ * @category Essentials
  */
 export declare class RubyVM {
+    /**
+     * @private Only for internal use.
+     */
     guest: Binding;
     private instance;
     private transport;
     private exceptionFormatter;
     private interfaceState;
+    /**
+     * Instantiate a Ruby VM with the given WebAssembly Core module with WASI Preview 1 implementation.
+     *
+     * @param options The options to instantiate the Ruby VM
+     * @returns A promise that resolves to the Ruby VM instance and the WebAssembly instance
+     * @category Essentials
+     *
+     * @example
+     *
+     * import { WASI } from "@bjorn3/browser_wasi_shim";
+     * const wasip1 = new WASI([], [], []);
+     * const module = await WebAssembly.compile("./path/to/ruby.wasm");
+     * const { vm } = await RubyVM.instantiateModule({ module, wasip1 });
+     *
+     */
+    static instantiateModule(options: RubyInitModuleOptions): Promise<{
+        vm: RubyVM;
+        instance: WebAssembly.Instance;
+    }>;
+    /**
+     * Instantiate a Ruby VM with the given WebAssembly component with WASI Preview 2 implementation.
+     *
+     * @param options The options to instantiate the Ruby VM
+     * @returns A promise that resolves to the Ruby VM instance
+     * @category Essentials
+     *
+     * @example
+     *
+     * // First, you need to transpile the Ruby component to a JavaScript module using jco.
+     * // $ jco transpile --no-wasi-shim --instantiation --valid-lifting-optimization ./ruby.component.wasm -o ./component
+     * // Then, you can instantiate the Ruby VM with the component:
+     *
+     * import * as wasip2 from "@bytecodealliance/preview2-shim"
+     * import fs from "fs/promises";
+     * import path from "path";
+     *
+     * const { instantiate } = await import("./component/ruby.component.js");
+     * const getCoreModule = async (relativePath) => {
+     *   const buffer = await fs.readFile(path.join("./component", relativePath));
+     *   return WebAssembly.compile(buffer);
+     * }
+     *
+     * const { vm } = await RubyVM.instantiateComponent({
+     *   instantiate, getCoreModule, wasip2,
+     * });
+     *
+     */
+    static instantiateComponent(options: RubyInitComponentOptions): Promise<{
+        vm: RubyVM;
+    }>;
+    /**
+     * Create a new Ruby VM instance with low-level initialization control.
+     *
+     * @category Low-level initialization
+     * @example
+     *
+     * ```javascript
+     * const wasi = new WASI();
+     * const vm = new RubyVM();
+     * const imports = {
+     *   wasi_snapshot_preview1: wasi.wasiImport,
+     * };
+     *
+     * vm.addToImports(imports);
+     *
+     * const instance = await WebAssembly.instantiate(rubyModule, imports);
+     * await vm.setInstance(instance);
+     * wasi.initialize(instance);
+     * vm.initialize();
+     * ```
+     *
+     */
+    constructor();
+    /**
+     * @private Only for internal use.
+     */
     constructor(binding?: Binding);
-    static _instantiate(initComponent: (_: typeof RubyJsJsRuntime) => Promise<typeof RubyJsRubyRuntime>, options: {
-        args?: string[];
-    }): Promise<RubyVM>;
+    private static _instantiate;
     /**
      * Initialize the Ruby VM with the given command line arguments
      * @param args The command line arguments to pass to Ruby. Must be
      * an array of strings starting with the Ruby program name.
+     * @category Low-level initialization
      */
     initialize(args?: string[]): void;
     /**
@@ -45,12 +178,14 @@ export declare class RubyVM {
      * @param instance The WebAssembly instance to interact with. Must
      * be instantiated from a Ruby built with JS extension, and built
      * with Reactor ABI instead of command line.
+     * @category Low-level initialization
      */
     setInstance(instance: WebAssembly.Instance): Promise<void>;
     /**
      * Add intrinsic import entries, which is necessary to interact JavaScript
      * and Ruby's WebAssembly instance.
      * @param imports The import object to add to the WebAssembly instance
+     * @category Low-level initialization
      */
     addToImports(imports: WebAssembly.Imports): void;
     private throwProhibitRewindException;
@@ -63,6 +198,7 @@ export declare class RubyVM {
      * Runs a string of Ruby code from JavaScript
      * @param code The Ruby code to run
      * @returns the result of the last expression
+     * @category Essentials
      *
      * @example
      * vm.eval("puts 'hello world'");
@@ -76,6 +212,7 @@ export declare class RubyVM {
      * Returns a promise that resolves when execution completes.
      * @param code The Ruby code to run
      * @returns a promise that resolves to the result of the last expression
+     * @category Essentials
      *
      * @example
      * const text = await vm.evalAsync(`
@@ -131,6 +268,7 @@ declare class JsValueTransport {
 }
 /**
  * A RbValue is an object that represents a value in Ruby
+ * @category Essentials
  */
 export declare class RbValue {
     private inner;