frogql-wasm 0.2.3

package/README.md

@@ -0,0 +1,102 @@
+# frogql-wasm
+
+froGQL compiled to WebAssembly: an in-browser, in-RAM graph engine.
+
+Wraps the `MemoryGraphStore` backend plus the shared compiler/runtime and
+exposes a `Connection` to JavaScript via `wasm-bindgen`. There is no
+filesystem in the browser, so the binding works entirely with the JSON
+shape `MemoryGraphStore` understands.
+
+## Install & use (from any app)
+
+Published to npm as **`frogql-wasm`** (unscoped). The package is built with
+the wasm-pack `web` target, so it works in Vite / Rollup / esbuild / plain
+browsers with no extra bundler plugin — call `await init()` once, then use
+the API.
+
+```bash
+npm install frogql-wasm
+```
+
+```js
+import init, { open_json } from "frogql-wasm";
+
+await init();                              // load the .wasm (once, up front)
+
+const conn = open_json(JSON.stringify({
+  nodes: [{ id: "a", labels: ["Person"], props: { name: "Alice" } }],
+  edges: [],
+}));
+
+conn.execute("MATCH (n:Person) RETURN n.name AS name");  // [{ name: "Alice" }]
+conn.execute("INSERT (b:Person {name: 'Bob'})");          // { nodes_inserted: 1, ... }
+conn.node_count;                                          // 2
+
+const snapshot = conn.to_json();           // persist this string (e.g. IndexedDB)
+const restored = open_json(snapshot);      // reload later
+```
+
+Verified: a fresh project that `npm install`s the package and runs
+`vite build` bundles the `.wasm` (≈300 kB gzip) with no plugin.
+
+- `open_json(json)` → `Connection`. Parses `{ "nodes": [...], "edges": [...] }`.
+- `Connection.execute(query, limit?)` → rows array (read queries) or a
+  counters object (INSERT / SET / REMOVE / DELETE). `limit` defaults to 100.
+- `Connection.to_json()` → JSON string of the live merged view (base +
+  any mutations). Round-trips through `open_json`.
+- `Connection.schema()` → `{ node_labels, edge_labels, node_count, edge_count }`.
+- `Connection.node_count` / `edge_count` (getters).
+
+Not supported in this backend (no catalog / secondary index in memory):
+`CREATE/USE/DROP GRAPH TYPE`, `CREATE INDEX`. Queries typecheck against the
+inferred DEFAULT schema.
+
+## Build
+
+```bash
+# one-time toolchain
+rustup target add wasm32-unknown-unknown
+cargo install wasm-bindgen-cli --version 0.2.122   # match the wasm-bindgen crate
+
+# generate the JS package (web target)
+cargo build -p frogql-wasm --target wasm32-unknown-unknown --release
+wasm-bindgen target/wasm32-unknown-unknown/release/frogql_wasm.wasm \
+  --out-dir <out> --target web
+```
+
+`wasm-pack build wasm --target web` (after `cargo install wasm-pack`) is the
+all-in-one alternative and additionally runs `wasm-opt` to shrink the binary
+(~855 kB vs ~1 MB). This is exactly what the npm release job
+(`.github/workflows/release-wasm.yml`) runs to produce the published
+`frogql-wasm` package.
+
+The playground frontend wires this up: `playground/frontend/scripts/build-wasm.sh`
+(run via `npm run build:wasm`) regenerates the bindings into
+`playground/frontend/src/frogql-wasm/` (gitignored), which the React app imports.
+
+### Marshaling note
+
+Results are returned via `serde_wasm_bindgen::Serializer::json_compatible()`,
+not `serde_wasm_bindgen::to_value`. The default serializes `serde_json` maps as
+JS `Map` objects, which surface as empty `{}` under `JSON.stringify` / bracket
+access. `json_compatible()` serializes them as plain objects.
+
+## Test
+
+The engine core (`query_json` / `dm_json`) is unit-tested on the host
+target — no browser needed:
+
+```bash
+cargo test -p frogql-wasm
+```
+
+The JavaScript marshaling layer on top (`JsValue` conversion) only runs in
+a JS environment; exercise it with `wasm-pack test --headless --firefox`
+once `wasm-pack` is installed.
+
+## Persistence
+
+Phase 1 persists the graph as the `to_json()` string in IndexedDB.
+Persisting the binary `.gdb` format (and on-demand paging for graphs that
+do not fit in RAM) is Phase 2 — it requires abstracting the `Pager` off
+`std::fs::File` onto OPFS. See `docs/internals/wasm-browser-plan.md`.

package/frogql_wasm.d.ts

@@ -0,0 +1,79 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * A live in-memory graph plus the caches that keep query latency flat.
+ */
+export class Connection {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Execute one GQL statement. Read queries return an array of row
+     * objects; data-modifying statements return a counters object.
+     * `limit` caps the number of rows (default 100 when omitted on the
+     * JS side).
+     */
+    execute(query: string, limit?: number | null): any;
+    /**
+     * `{ node_labels, edge_labels, node_count, edge_count }`, mirroring
+     * the Python/Node `schema()` summary.
+     */
+    schema(): any;
+    /**
+     * Serialise the live merged view (base + overlay) to a JSON string —
+     * the unit to hand IndexedDB for persistence. Re-open it later with
+     * `open_json`.
+     */
+    to_json(): string;
+    readonly edge_count: number;
+    readonly node_count: number;
+}
+
+/**
+ * Parse a JSON graph document (`{"nodes": [...], "edges": [...]}`) and
+ * open a connection over it. Warms the LTJ index eagerly so the first
+ * query is as fast as the rest.
+ */
+export function open_json(json: string): Connection;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_connection_free: (a: number, b: number) => void;
+    readonly connection_edge_count: (a: number) => number;
+    readonly connection_execute: (a: number, b: number, c: number, d: number) => [number, number, number];
+    readonly connection_node_count: (a: number) => number;
+    readonly connection_schema: (a: number) => [number, number, number];
+    readonly connection_to_json: (a: number) => [number, number];
+    readonly open_json: (a: number, b: number) => [number, number, number];
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __externref_table_dealloc: (a: number) => void;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;

package/frogql_wasm.js

@@ -0,0 +1,397 @@
+/* @ts-self-types="./frogql_wasm.d.ts" */
+
+/**
+ * A live in-memory graph plus the caches that keep query latency flat.
+ */
+export class Connection {
+    static __wrap(ptr) {
+        const obj = Object.create(Connection.prototype);
+        obj.__wbg_ptr = ptr;
+        ConnectionFinalization.register(obj, obj.__wbg_ptr, obj);
+        return obj;
+    }
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        ConnectionFinalization.unregister(this);
+        return ptr;
+    }
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_connection_free(ptr, 0);
+    }
+    /**
+     * @returns {number}
+     */
+    get edge_count() {
+        const ret = wasm.connection_edge_count(this.__wbg_ptr);
+        return ret >>> 0;
+    }
+    /**
+     * Execute one GQL statement. Read queries return an array of row
+     * objects; data-modifying statements return a counters object.
+     * `limit` caps the number of rows (default 100 when omitted on the
+     * JS side).
+     * @param {string} query
+     * @param {number | null} [limit]
+     * @returns {any}
+     */
+    execute(query, limit) {
+        const ptr0 = passStringToWasm0(query, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.connection_execute(this.__wbg_ptr, ptr0, len0, isLikeNone(limit) ? Number.MAX_SAFE_INTEGER : (limit) >>> 0);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
+    /**
+     * @returns {number}
+     */
+    get node_count() {
+        const ret = wasm.connection_node_count(this.__wbg_ptr);
+        return ret >>> 0;
+    }
+    /**
+     * `{ node_labels, edge_labels, node_count, edge_count }`, mirroring
+     * the Python/Node `schema()` summary.
+     * @returns {any}
+     */
+    schema() {
+        const ret = wasm.connection_schema(this.__wbg_ptr);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
+    /**
+     * Serialise the live merged view (base + overlay) to a JSON string —
+     * the unit to hand IndexedDB for persistence. Re-open it later with
+     * `open_json`.
+     * @returns {string}
+     */
+    to_json() {
+        let deferred1_0;
+        let deferred1_1;
+        try {
+            const ret = wasm.connection_to_json(this.__wbg_ptr);
+            deferred1_0 = ret[0];
+            deferred1_1 = ret[1];
+            return getStringFromWasm0(ret[0], ret[1]);
+        } finally {
+            wasm.__wbindgen_free(deferred1_0, deferred1_1, 1);
+        }
+    }
+}
+if (Symbol.dispose) Connection.prototype[Symbol.dispose] = Connection.prototype.free;
+
+/**
+ * Parse a JSON graph document (`{"nodes": [...], "edges": [...]}`) and
+ * open a connection over it. Warms the LTJ index eagerly so the first
+ * query is as fast as the rest.
+ * @param {string} json
+ * @returns {Connection}
+ */
+export function open_json(json) {
+    const ptr0 = passStringToWasm0(json, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+    const len0 = WASM_VECTOR_LEN;
+    const ret = wasm.open_json(ptr0, len0);
+    if (ret[2]) {
+        throw takeFromExternrefTable0(ret[1]);
+    }
+    return Connection.__wrap(ret[0]);
+}
+function __wbg_get_imports() {
+    const import0 = {
+        __proto__: null,
+        __wbg_Error_ef53bc310eb298a0: function(arg0, arg1) {
+            const ret = Error(getStringFromWasm0(arg0, arg1));
+            return ret;
+        },
+        __wbg_String_8564e559799eccda: function(arg0, arg1) {
+            const ret = String(arg1);
+            const ptr1 = passStringToWasm0(ret, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len1 = WASM_VECTOR_LEN;
+            getDataViewMemory0().setInt32(arg0 + 4 * 1, len1, true);
+            getDataViewMemory0().setInt32(arg0 + 4 * 0, ptr1, true);
+        },
+        __wbg___wbindgen_is_string_c236cabd84a4d769: function(arg0) {
+            const ret = typeof(arg0) === 'string';
+            return ret;
+        },
+        __wbg___wbindgen_throw_1506f2235d1bdba0: function(arg0, arg1) {
+            throw new Error(getStringFromWasm0(arg0, arg1));
+        },
+        __wbg_error_a6fa202b58aa1cd3: function(arg0, arg1) {
+            let deferred0_0;
+            let deferred0_1;
+            try {
+                deferred0_0 = arg0;
+                deferred0_1 = arg1;
+                console.error(getStringFromWasm0(arg0, arg1));
+            } finally {
+                wasm.__wbindgen_free(deferred0_0, deferred0_1, 1);
+            }
+        },
+        __wbg_new_227d7c05414eb861: function() {
+            const ret = new Error();
+            return ret;
+        },
+        __wbg_new_622fc80556be2e26: function() {
+            const ret = new Map();
+            return ret;
+        },
+        __wbg_new_ce1ab61c1c2b300d: function() {
+            const ret = new Object();
+            return ret;
+        },
+        __wbg_new_d90091b82fdf5b91: function() {
+            const ret = new Array();
+            return ret;
+        },
+        __wbg_set_52b1e1eb5bed906a: function(arg0, arg1, arg2) {
+            const ret = arg0.set(arg1, arg2);
+            return ret;
+        },
+        __wbg_set_6be42768c690e380: function(arg0, arg1, arg2) {
+            arg0[arg1] = arg2;
+        },
+        __wbg_set_dca99999bba88a9a: function(arg0, arg1, arg2) {
+            arg0[arg1 >>> 0] = arg2;
+        },
+        __wbg_stack_3b0d974bbf31e44f: function(arg0, arg1) {
+            const ret = arg1.stack;
+            const ptr1 = passStringToWasm0(ret, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+            const len1 = WASM_VECTOR_LEN;
+            getDataViewMemory0().setInt32(arg0 + 4 * 1, len1, true);
+            getDataViewMemory0().setInt32(arg0 + 4 * 0, ptr1, true);
+        },
+        __wbindgen_cast_0000000000000001: function(arg0) {
+            // Cast intrinsic for `F64 -> Externref`.
+            const ret = arg0;
+            return ret;
+        },
+        __wbindgen_cast_0000000000000002: function(arg0) {
+            // Cast intrinsic for `I64 -> Externref`.
+            const ret = arg0;
+            return ret;
+        },
+        __wbindgen_cast_0000000000000003: function(arg0, arg1) {
+            // Cast intrinsic for `Ref(String) -> Externref`.
+            const ret = getStringFromWasm0(arg0, arg1);
+            return ret;
+        },
+        __wbindgen_cast_0000000000000004: function(arg0) {
+            // Cast intrinsic for `U64 -> Externref`.
+            const ret = BigInt.asUintN(64, arg0);
+            return ret;
+        },
+        __wbindgen_init_externref_table: function() {
+            const table = wasm.__wbindgen_externrefs;
+            const offset = table.grow(4);
+            table.set(0, undefined);
+            table.set(offset + 0, undefined);
+            table.set(offset + 1, null);
+            table.set(offset + 2, true);
+            table.set(offset + 3, false);
+        },
+    };
+    return {
+        __proto__: null,
+        "./frogql_wasm_bg.js": import0,
+    };
+}
+
+const ConnectionFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_connection_free(ptr, 1));
+
+let cachedDataViewMemory0 = null;
+function getDataViewMemory0() {
+    if (cachedDataViewMemory0 === null || cachedDataViewMemory0.buffer.detached === true || (cachedDataViewMemory0.buffer.detached === undefined && cachedDataViewMemory0.buffer !== wasm.memory.buffer)) {
+        cachedDataViewMemory0 = new DataView(wasm.memory.buffer);
+    }
+    return cachedDataViewMemory0;
+}
+
+function getStringFromWasm0(ptr, len) {
+    return decodeText(ptr >>> 0, len);
+}
+
+let cachedUint8ArrayMemory0 = null;
+function getUint8ArrayMemory0() {
+    if (cachedUint8ArrayMemory0 === null || cachedUint8ArrayMemory0.byteLength === 0) {
+        cachedUint8ArrayMemory0 = new Uint8Array(wasm.memory.buffer);
+    }
+    return cachedUint8ArrayMemory0;
+}
+
+function isLikeNone(x) {
+    return x === undefined || x === null;
+}
+
+function passStringToWasm0(arg, malloc, realloc) {
+    if (realloc === undefined) {
+        const buf = cachedTextEncoder.encode(arg);
+        const ptr = malloc(buf.length, 1) >>> 0;
+        getUint8ArrayMemory0().subarray(ptr, ptr + buf.length).set(buf);
+        WASM_VECTOR_LEN = buf.length;
+        return ptr;
+    }
+
+    let len = arg.length;
+    let ptr = malloc(len, 1) >>> 0;
+
+    const mem = getUint8ArrayMemory0();
+
+    let offset = 0;
+
+    for (; offset < len; offset++) {
+        const code = arg.charCodeAt(offset);
+        if (code > 0x7F) break;
+        mem[ptr + offset] = code;
+    }
+    if (offset !== len) {
+        if (offset !== 0) {
+            arg = arg.slice(offset);
+        }
+        ptr = realloc(ptr, len, len = offset + arg.length * 3, 1) >>> 0;
+        const view = getUint8ArrayMemory0().subarray(ptr + offset, ptr + len);
+        const ret = cachedTextEncoder.encodeInto(arg, view);
+
+        offset += ret.written;
+        ptr = realloc(ptr, len, offset, 1) >>> 0;
+    }
+
+    WASM_VECTOR_LEN = offset;
+    return ptr;
+}
+
+function takeFromExternrefTable0(idx) {
+    const value = wasm.__wbindgen_externrefs.get(idx);
+    wasm.__externref_table_dealloc(idx);
+    return value;
+}
+
+let cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+cachedTextDecoder.decode();
+const MAX_SAFARI_DECODE_BYTES = 2146435072;
+let numBytesDecoded = 0;
+function decodeText(ptr, len) {
+    numBytesDecoded += len;
+    if (numBytesDecoded >= MAX_SAFARI_DECODE_BYTES) {
+        cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+        cachedTextDecoder.decode();
+        numBytesDecoded = len;
+    }
+    return cachedTextDecoder.decode(getUint8ArrayMemory0().subarray(ptr, ptr + len));
+}
+
+const cachedTextEncoder = new TextEncoder();
+
+if (!('encodeInto' in cachedTextEncoder)) {
+    cachedTextEncoder.encodeInto = function (arg, view) {
+        const buf = cachedTextEncoder.encode(arg);
+        view.set(buf);
+        return {
+            read: arg.length,
+            written: buf.length
+        };
+    };
+}
+
+let WASM_VECTOR_LEN = 0;
+
+let wasmModule, wasmInstance, wasm;
+function __wbg_finalize_init(instance, module) {
+    wasmInstance = instance;
+    wasm = instance.exports;
+    wasmModule = module;
+    cachedDataViewMemory0 = null;
+    cachedUint8ArrayMemory0 = null;
+    wasm.__wbindgen_start();
+    return wasm;
+}
+
+async function __wbg_load(module, imports) {
+    if (typeof Response === 'function' && module instanceof Response) {
+        if (typeof WebAssembly.instantiateStreaming === 'function') {
+            try {
+                return await WebAssembly.instantiateStreaming(module, imports);
+            } catch (e) {
+                const validResponse = module.ok && expectedResponseType(module.type);
+
+                if (validResponse && module.headers.get('Content-Type') !== 'application/wasm') {
+                    console.warn("`WebAssembly.instantiateStreaming` failed because your server does not serve Wasm with `application/wasm` MIME type. Falling back to `WebAssembly.instantiate` which is slower. Original error:\n", e);
+
+                } else { throw e; }
+            }
+        }
+
+        const bytes = await module.arrayBuffer();
+        return await WebAssembly.instantiate(bytes, imports);
+    } else {
+        const instance = await WebAssembly.instantiate(module, imports);
+
+        if (instance instanceof WebAssembly.Instance) {
+            return { instance, module };
+        } else {
+            return instance;
+        }
+    }
+
+    function expectedResponseType(type) {
+        switch (type) {
+            case 'basic': case 'cors': case 'default': return true;
+        }
+        return false;
+    }
+}
+
+function initSync(module) {
+    if (wasm !== undefined) return wasm;
+
+
+    if (module !== undefined) {
+        if (Object.getPrototypeOf(module) === Object.prototype) {
+            ({module} = module)
+        } else {
+            console.warn('using deprecated parameters for `initSync()`; pass a single object instead')
+        }
+    }
+
+    const imports = __wbg_get_imports();
+    if (!(module instanceof WebAssembly.Module)) {
+        module = new WebAssembly.Module(module);
+    }
+    const instance = new WebAssembly.Instance(module, imports);
+    return __wbg_finalize_init(instance, module);
+}
+
+async function __wbg_init(module_or_path) {
+    if (wasm !== undefined) return wasm;
+
+
+    if (module_or_path !== undefined) {
+        if (Object.getPrototypeOf(module_or_path) === Object.prototype) {
+            ({module_or_path} = module_or_path)
+        } else {
+            console.warn('using deprecated parameters for the initialization function; pass a single object instead')
+        }
+    }
+
+    if (module_or_path === undefined) {
+        module_or_path = new URL('frogql_wasm_bg.wasm', import.meta.url);
+    }
+    const imports = __wbg_get_imports();
+
+    if (typeof module_or_path === 'string' || (typeof Request === 'function' && module_or_path instanceof Request) || (typeof URL === 'function' && module_or_path instanceof URL)) {
+        module_or_path = fetch(module_or_path);
+    }
+
+    const { instance, module } = await __wbg_load(await module_or_path, imports);
+
+    return __wbg_finalize_init(instance, module);
+}
+
+export { initSync, __wbg_init as default };

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "frogql-wasm",
+  "type": "module",
+  "description": "froGQL — embedded GQL graph database with ISO GQL path patterns (Rust core, WebAssembly bindings for the browser)",
+  "version": "0.2.3",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pleiad/frogql"
+  },
+  "files": [
+    "frogql_wasm_bg.wasm",
+    "frogql_wasm.js",
+    "frogql_wasm.d.ts"
+  ],
+  "main": "frogql_wasm.js",
+  "types": "frogql_wasm.d.ts",
+  "sideEffects": [
+    "./snippets/*"
+  ]
+}