Add jco-generated TypeScript interface of the js gem world

Author: kateinoigakukun

.github/workflows/build.yml

@@ -103,6 +103,8 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: true
       - uses: actions/download-artifact@v4
         with:
           name: build-manifest
@@ -131,6 +133,7 @@ jobs:
           chmod +x ./build-exec
           # wait for docker exec to be ready
           timeout 10 bash -c 'until ./build-exec bundle config set --local without check; do sleep 1; done'
+      - run: ./build-exec rustup target add wasm32-wasi # For jco build
       - run: ./build-exec ./bin/setup
       - run: ./build-exec bundle exec rake compile
       - name: Pre-release configuration

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/jco"]
+	path = vendor/jco
+	url = [email protected]:kateinoigakukun/jco.git

bin/setup

@@ -7,4 +7,12 @@ root="$(cd "$(dirname "$0")/.." && pwd)"
 
 env BUNDLE_GEMFILE="$root/Gemfile" bundle install
 env BUNDLE_GEMFILE="$root/packages/npm-packages/ruby-wasm-wasi/Gemfile" bundle install
+
+# Build vendored jco if Rust toolchain is available and submodule is checked out
+if command -v rustc && [ -f vendor/jco/package.json ]; then
+  npm -C vendor/jco install
+  npm -C vendor/jco run build
+else
+  echo "Rust toolchain not found or jco submodule not checked out, skipping jco build"
+fi
 npm ci

package-lock.json

@@ -53,13 +53,14 @@
     "build": "npm run build:rollup && npm run build:tsc && npm run build:static && ./tools/post-build.sh ./dist"
   },
   "devDependencies": {
+    "@bjorn3/browser_wasi_shim": "^0.2.19",
+    "@bytecodealliance/jco": "../../../vendor/jco",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-typescript": "^11.1.6",
     "@types/jest": "^29.5.11",
     "@types/node": "20.12.2",
     "jest": "^29.7.0",
     "prettier": "^3.2.5",
-    "@bjorn3/browser_wasi_shim": "^0.2.19",
     "typescript": "^5.4.3"
   },
   "dependencies": {

packages/npm-packages/ruby-wasm-wasi/package.json

@@ -0,0 +1,45 @@
+export namespace RubyJsJsRuntime {
+  export function evalJs(code: string): JsAbiResult;
+  export function isJs(value: JsAbiValue): boolean;
+  export function instanceOf(value: JsAbiValue, klass: JsAbiValue): boolean;
+  export function globalThis(): JsAbiValue;
+  export function intToJsNumber(value: number): JsAbiValue;
+  export function floatToJsNumber(value: number): JsAbiValue;
+  export function stringToJsString(value: string): JsAbiValue;
+  export function boolToJsBool(value: boolean): JsAbiValue;
+  export function procToJsFunction(value: number): JsAbiValue;
+  export function rbObjectToJsRbValue(rawRbAbiValue: number): JsAbiValue;
+  export function jsValueToString(value: JsAbiValue): string;
+  export function jsValueToInteger(value: JsAbiValue): RawInteger;
+  export function exportJsValueToHost(value: JsAbiValue): void;
+  export function importJsValueFromHost(): JsAbiValue;
+  export function jsValueTypeof(value: JsAbiValue): string;
+  export function jsValueEqual(lhs: JsAbiValue, rhs: JsAbiValue): boolean;
+  export function jsValueStrictlyEqual(lhs: JsAbiValue, rhs: JsAbiValue): boolean;
+  export function reflectApply(target: JsAbiValue, thisArgument: JsAbiValue, arguments: JsAbiValue[]): JsAbiResult;
+  export function reflectGet(target: JsAbiValue, propertyKey: string): JsAbiResult;
+  export function reflectSet(target: JsAbiValue, propertyKey: string, value: JsAbiValue): JsAbiResult;
+  export function throwProhibitRewindException(message: string): void;
+  export { JsAbiValue };
+}
+export type JsAbiResult = JsAbiResultSuccess | JsAbiResultFailure;
+export interface JsAbiResultSuccess {
+  tag: 'success',
+  val: JsAbiValue,
+}
+export interface JsAbiResultFailure {
+  tag: 'failure',
+  val: JsAbiValue,
+}
+export type RawInteger = RawIntegerAsFloat | RawIntegerBignum;
+export interface RawIntegerAsFloat {
+  tag: 'as-float',
+  val: number,
+}
+export interface RawIntegerBignum {
+  tag: 'bignum',
+  val: string,
+}
+
+export class JsAbiValue {
+}

packages/npm-packages/ruby-wasm-wasi/src/bindgen/interfaces/ruby-js-js-runtime.d.ts

@@ -0,0 +1,30 @@
+export namespace RubyJsRubyRuntime {
+  export function rubyShowVersion(): void;
+  export function rubyInit(): void;
+  export function rubySysinit(args: string[]): void;
+  export function rubyOptions(args: string[]): RbIseq;
+  export function rubyScript(name: string): void;
+  export function rubyInitLoadpath(): void;
+  export function rbEvalStringProtect(str: string): [RbAbiValue, number];
+  export function rbFuncallvProtect(recv: RbAbiValue, mid: RbId, args: RbAbiValue[]): [RbAbiValue, number];
+  export function rbIntern(name: string): RbId;
+  export function rbErrinfo(): RbAbiValue;
+  export function rbClearErrinfo(): void;
+  export function rstringPtr(value: RbAbiValue): string;
+  export function rbVmBugreport(): void;
+  export function rbGcEnable(): boolean;
+  export function rbGcDisable(): boolean;
+  export function rbSetShouldProhibitRewind(newValue: boolean): boolean;
+  export { RbIseq };
+  export { RbAbiValue };
+}
+import type { JsAbiValue } from './ruby-js-js-runtime.js';
+export { JsAbiValue };
+export type RbErrno = number;
+export type RbId = number;
+
+export class RbIseq {
+}
+
+export class RbAbiValue {
+}

packages/npm-packages/ruby-wasm-wasi/src/bindgen/interfaces/ruby-js-ruby-runtime.d.ts

@@ -0,0 +1,40 @@
+/*
+ * This script generates TypeScript bindings from the WIT definitions
+ * in the js gem.
+ */
+import { fileURLToPath } from "url";
+import { generateTypes, $init } from "../../../../node_modules/@bytecodealliance/jco/obj/js-component-bindgen-component.js";
+import path from "path"
+import fs from "fs/promises"
+
+async function main() {
+  const selfPath = fileURLToPath(import.meta.url)
+  const witDir = path.resolve(path.join(
+    selfPath,
+    "../../../../gems/js/wit"
+  ))
+  await $init
+  console.log(`Generating TypeScript bindings from ${witDir}`)
+  const generated = generateTypes("ruby", {
+    wit: {
+      tag: "dir",
+      val: witDir
+    },
+    world: "ext",
+    tlaCompat: true
+  })
+  const bindgenDir = path.join(selfPath, "../../src/bindgen")
+  for (const [name, content] of generated) {
+    if (name == "ruby.d.ts") {
+      console.log(`Skipping ${name}`)
+      continue;
+    }
+
+    const filePath = path.join(bindgenDir, name)
+    console.log(`Writing ${filePath}`)
+    await fs.mkdir(path.dirname(filePath), { recursive: true })
+    await fs.writeFile(filePath, content)
+  }
+}
+
+await main()