@grafeo-db/grafeo-wasm 0.5.0

package/README.md

@@ -0,0 +1,83 @@
+# @grafeo-db/wasm
+
+Low-level WebAssembly binary for [Grafeo](https://github.com/GrafeoDB/grafeo), a high-performance graph database.
+
+## Which Package Do You Need?
+
+| Package | Use Case |
+|---------|----------|
+| [`@grafeo-db/web`](https://www.npmjs.com/package/@grafeo-db/web) | Browser apps with IndexedDB, Web Workers, React/Vue/Svelte (recommended) |
+| [`@grafeo-db/wasm`](https://www.npmjs.com/package/@grafeo-db/wasm) | Raw WASM binary for custom loaders or non-standard runtimes |
+| [`@grafeo-db/js`](https://www.npmjs.com/package/@grafeo-db/js) | Node.js native bindings (faster than WASM for server-side) |
+
+**Most users should use `@grafeo-db/web`** - it wraps this package and adds browser-specific features.
+
+## Installation
+
+```bash
+npm install @grafeo-db/wasm
+```
+
+## Usage
+
+```typescript
+import init, { GrafeoCore } from '@grafeo-db/wasm';
+
+// Initialize the WASM module
+await init();
+
+// Low-level API
+const core = new GrafeoCore();
+const result = core.execute(`MATCH (n:Person) RETURN n.name`);
+```
+
+## Progress
+
+- [ ] Core WASM bindings via wasm-bindgen
+- [ ] In-memory database support
+- [ ] All query languages (GQL, Cypher, SPARQL, GraphQL, Gremlin)
+- [ ] TypeScript type definitions
+- [ ] Size optimization (target: <1MB gzipped)
+
+## Package Contents
+
+```
+@grafeo-db/wasm/
+├── grafeo_wasm_bg.wasm    # WebAssembly binary
+├── grafeo_wasm.js         # JavaScript loader
+├── grafeo_wasm.d.ts       # TypeScript definitions
+└── package.json
+```
+
+## Target Bundle Size
+
+| Build | Size (gzip) |
+|-------|-------------|
+| Full (all languages) | ~600 KB |
+| Minimal (GQL only) | ~300 KB |
+
+## Runtime Support
+
+| Runtime | Status |
+|---------|--------|
+| Browser (Chrome, Firefox, Safari, Edge) | Planned |
+| Deno | Planned |
+| Cloudflare Workers | Planned |
+| Node.js | Use `@grafeo-db/js` instead |
+
+## Current Alternatives
+
+While WASM bindings are in development, you can use:
+
+- **Python**: [`grafeo`](https://pypi.org/project/grafeo/) - fully functional
+- **Rust**: [`grafeo`](https://crates.io/crates/grafeo) - fully functional
+
+## Links
+
+- [Documentation](https://grafeo.dev)
+- [GitHub](https://github.com/GrafeoDB/grafeo)
+- [Roadmap](https://github.com/GrafeoDB/grafeo/blob/main/docs/roadmap.md)
+
+## License
+
+Apache-2.0

package/grafeo_wasm.d.ts

@@ -0,0 +1,94 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * A Grafeo graph database instance running in WebAssembly.
+ *
+ * All data is held in memory within the WASM heap. For persistence,
+ * use `exportSnapshot()` / `importSnapshot()` with IndexedDB or
+ * the higher-level `@grafeo-db/web` package.
+ */
+export class Database {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Returns the number of edges in the database.
+     */
+    edgeCount(): number;
+    /**
+     * Executes a GQL query and returns results as an array of objects.
+     *
+     * Each row becomes a JavaScript object with column names as keys.
+     *
+     * ```js
+     * const results = db.execute("MATCH (p:Person) RETURN p.name, p.age");
+     * // [{name: "Alice", age: 30}, {name: "Bob", age: 25}]
+     * ```
+     */
+    execute(query: string): any;
+    /**
+     * Executes a GQL query and returns raw columns, rows, and metadata.
+     *
+     * Returns `{ columns: string[], rows: any[][], executionTimeMs?: number }`.
+     */
+    executeRaw(query: string): any;
+    /**
+     * Executes a query using a specific query language.
+     *
+     * Supported languages: `"gql"`, `"cypher"`, `"sparql"`, `"gremlin"`, `"graphql"`.
+     * Languages require their corresponding feature flag to be enabled.
+     *
+     * ```js
+     * const results = db.executeWithLanguage(
+     *   "MATCH (p:Person) RETURN p.name",
+     *   "cypher"
+     * );
+     * ```
+     */
+    executeWithLanguage(query: string, language: string): any;
+    /**
+     * Exports the database to a binary snapshot.
+     *
+     * Returns a `Uint8Array` that can be stored in IndexedDB, localStorage,
+     * or sent over the network. Restore with `Database.importSnapshot()`.
+     *
+     * ```js
+     * const bytes = db.exportSnapshot();
+     * // Store in IndexedDB, download as file, etc.
+     * ```
+     */
+    exportSnapshot(): Uint8Array;
+    /**
+     * Creates a database from a binary snapshot.
+     *
+     * The `data` must have been produced by `exportSnapshot()`.
+     *
+     * ```js
+     * const db = Database.importSnapshot(bytes);
+     * ```
+     */
+    static importSnapshot(data: Uint8Array): Database;
+    /**
+     * Creates a new in-memory database.
+     */
+    constructor();
+    /**
+     * Returns the number of nodes in the database.
+     */
+    nodeCount(): number;
+    /**
+     * Returns schema information about the database.
+     *
+     * Returns an object describing labels, edge types, and property keys.
+     *
+     * ```js
+     * const schema = db.schema();
+     * // { lpg: { labels: [...], edgeTypes: [...], propertyKeys: [...] } }
+     * ```
+     */
+    schema(): any;
+    /**
+     * Returns the Grafeo version.
+     */
+    static version(): string;
+}

package/grafeo_wasm.js

@@ -0,0 +1,9 @@
+/* @ts-self-types="./grafeo_wasm.d.ts" */
+
+import * as wasm from "./grafeo_wasm_bg.wasm";
+import { __wbg_set_wasm } from "./grafeo_wasm_bg.js";
+__wbg_set_wasm(wasm);
+wasm.__wbindgen_start();
+export {
+    Database
+} from "./grafeo_wasm_bg.js";

package/grafeo_wasm_bg.js

@@ -0,0 +1,443 @@
+/**
+ * A Grafeo graph database instance running in WebAssembly.
+ *
+ * All data is held in memory within the WASM heap. For persistence,
+ * use `exportSnapshot()` / `importSnapshot()` with IndexedDB or
+ * the higher-level `@grafeo-db/web` package.
+ */
+export class Database {
+    static __wrap(ptr) {
+        ptr = ptr >>> 0;
+        const obj = Object.create(Database.prototype);
+        obj.__wbg_ptr = ptr;
+        DatabaseFinalization.register(obj, obj.__wbg_ptr, obj);
+        return obj;
+    }
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        DatabaseFinalization.unregister(this);
+        return ptr;
+    }
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_database_free(ptr, 0);
+    }
+    /**
+     * Returns the number of edges in the database.
+     * @returns {number}
+     */
+    edgeCount() {
+        const ret = wasm.database_edgeCount(this.__wbg_ptr);
+        return ret >>> 0;
+    }
+    /**
+     * Executes a GQL query and returns results as an array of objects.
+     *
+     * Each row becomes a JavaScript object with column names as keys.
+     *
+     * ```js
+     * const results = db.execute("MATCH (p:Person) RETURN p.name, p.age");
+     * // [{name: "Alice", age: 30}, {name: "Bob", age: 25}]
+     * ```
+     * @param {string} query
+     * @returns {any}
+     */
+    execute(query) {
+        const ptr0 = passStringToWasm0(query, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.database_execute(this.__wbg_ptr, ptr0, len0);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
+    /**
+     * Executes a GQL query and returns raw columns, rows, and metadata.
+     *
+     * Returns `{ columns: string[], rows: any[][], executionTimeMs?: number }`.
+     * @param {string} query
+     * @returns {any}
+     */
+    executeRaw(query) {
+        const ptr0 = passStringToWasm0(query, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.database_executeRaw(this.__wbg_ptr, ptr0, len0);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
+    /**
+     * Executes a query using a specific query language.
+     *
+     * Supported languages: `"gql"`, `"cypher"`, `"sparql"`, `"gremlin"`, `"graphql"`.
+     * Languages require their corresponding feature flag to be enabled.
+     *
+     * ```js
+     * const results = db.executeWithLanguage(
+     *   "MATCH (p:Person) RETURN p.name",
+     *   "cypher"
+     * );
+     * ```
+     * @param {string} query
+     * @param {string} language
+     * @returns {any}
+     */
+    executeWithLanguage(query, language) {
+        const ptr0 = passStringToWasm0(query, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ptr1 = passStringToWasm0(language, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len1 = WASM_VECTOR_LEN;
+        const ret = wasm.database_executeWithLanguage(this.__wbg_ptr, ptr0, len0, ptr1, len1);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
+    /**
+     * Exports the database to a binary snapshot.
+     *
+     * Returns a `Uint8Array` that can be stored in IndexedDB, localStorage,
+     * or sent over the network. Restore with `Database.importSnapshot()`.
+     *
+     * ```js
+     * const bytes = db.exportSnapshot();
+     * // Store in IndexedDB, download as file, etc.
+     * ```
+     * @returns {Uint8Array}
+     */
+    exportSnapshot() {
+        const ret = wasm.database_exportSnapshot(this.__wbg_ptr);
+        if (ret[3]) {
+            throw takeFromExternrefTable0(ret[2]);
+        }
+        var v1 = getArrayU8FromWasm0(ret[0], ret[1]).slice();
+        wasm.__wbindgen_free(ret[0], ret[1] * 1, 1);
+        return v1;
+    }
+    /**
+     * Creates a database from a binary snapshot.
+     *
+     * The `data` must have been produced by `exportSnapshot()`.
+     *
+     * ```js
+     * const db = Database.importSnapshot(bytes);
+     * ```
+     * @param {Uint8Array} data
+     * @returns {Database}
+     */
+    static importSnapshot(data) {
+        const ptr0 = passArray8ToWasm0(data, wasm.__wbindgen_malloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.database_importSnapshot(ptr0, len0);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return Database.__wrap(ret[0]);
+    }
+    /**
+     * Creates a new in-memory database.
+     */
+    constructor() {
+        const ret = wasm.database_new();
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        this.__wbg_ptr = ret[0] >>> 0;
+        DatabaseFinalization.register(this, this.__wbg_ptr, this);
+        return this;
+    }
+    /**
+     * Returns the number of nodes in the database.
+     * @returns {number}
+     */
+    nodeCount() {
+        const ret = wasm.database_nodeCount(this.__wbg_ptr);
+        return ret >>> 0;
+    }
+    /**
+     * Returns schema information about the database.
+     *
+     * Returns an object describing labels, edge types, and property keys.
+     *
+     * ```js
+     * const schema = db.schema();
+     * // { lpg: { labels: [...], edgeTypes: [...], propertyKeys: [...] } }
+     * ```
+     * @returns {any}
+     */
+    schema() {
+        const ret = wasm.database_schema(this.__wbg_ptr);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
+    /**
+     * Returns the Grafeo version.
+     * @returns {string}
+     */
+    static version() {
+        let deferred1_0;
+        let deferred1_1;
+        try {
+            const ret = wasm.database_version();
+            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) Database.prototype[Symbol.dispose] = Database.prototype.free;
+export function __wbg_Error_8c4e43fe74559d73(arg0, arg1) {
+    const ret = Error(getStringFromWasm0(arg0, arg1));
+    return ret;
+}
+export function __wbg_String_8f0eb39a4a4c2f66(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);
+}
+export function __wbg___wbindgen_throw_be289d5034ed271b(arg0, arg1) {
+    throw new Error(getStringFromWasm0(arg0, arg1));
+}
+export function __wbg_error_7534b8e9a36f1ab4(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);
+    }
+}
+export function __wbg_getRandomValues_1c61fac11405ffdc() { return handleError(function (arg0, arg1) {
+    globalThis.crypto.getRandomValues(getArrayU8FromWasm0(arg0, arg1));
+}, arguments); }
+export function __wbg_length_32ed9a279acd054c(arg0) {
+    const ret = arg0.length;
+    return ret;
+}
+export function __wbg_length_9a7876c9728a0979(arg0) {
+    const ret = arg0.length;
+    return ret;
+}
+export function __wbg_new_361308b2356cecd0() {
+    const ret = new Object();
+    return ret;
+}
+export function __wbg_new_3eb36ae241fe6f44() {
+    const ret = new Array();
+    return ret;
+}
+export function __wbg_new_8a6f238a6ece86ea() {
+    const ret = new Error();
+    return ret;
+}
+export function __wbg_new_with_length_1763c527b2923202(arg0) {
+    const ret = new Array(arg0 >>> 0);
+    return ret;
+}
+export function __wbg_new_with_length_63f2683cc2521026(arg0) {
+    const ret = new Float32Array(arg0 >>> 0);
+    return ret;
+}
+export function __wbg_new_with_length_a2c39cbe88fd8ff1(arg0) {
+    const ret = new Uint8Array(arg0 >>> 0);
+    return ret;
+}
+export function __wbg_set_3f1d0b984ed272ed(arg0, arg1, arg2) {
+    arg0[arg1] = arg2;
+}
+export function __wbg_set_6cb8631f80447a67() { return handleError(function (arg0, arg1, arg2) {
+    const ret = Reflect.set(arg0, arg1, arg2);
+    return ret;
+}, arguments); }
+export function __wbg_set_cc56eefd2dd91957(arg0, arg1, arg2) {
+    arg0.set(getArrayU8FromWasm0(arg1, arg2));
+}
+export function __wbg_set_f43e577aea94465b(arg0, arg1, arg2) {
+    arg0[arg1 >>> 0] = arg2;
+}
+export function __wbg_set_f8edeec46569cc70(arg0, arg1, arg2) {
+    arg0.set(getArrayF32FromWasm0(arg1, arg2));
+}
+export function __wbg_stack_0ed75d68575b0f3c(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);
+}
+export function __wbindgen_cast_0000000000000001(arg0) {
+    // Cast intrinsic for `F64 -> Externref`.
+    const ret = arg0;
+    return ret;
+}
+export function __wbindgen_cast_0000000000000002(arg0, arg1) {
+    // Cast intrinsic for `Ref(String) -> Externref`.
+    const ret = getStringFromWasm0(arg0, arg1);
+    return ret;
+}
+export function __wbindgen_cast_0000000000000003(arg0) {
+    // Cast intrinsic for `U64 -> Externref`.
+    const ret = BigInt.asUintN(64, arg0);
+    return ret;
+}
+export function __wbindgen_init_externref_table() {
+    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);
+}
+const DatabaseFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_database_free(ptr >>> 0, 1));
+
+function addToExternrefTable0(obj) {
+    const idx = wasm.__externref_table_alloc();
+    wasm.__wbindgen_externrefs.set(idx, obj);
+    return idx;
+}
+
+function getArrayF32FromWasm0(ptr, len) {
+    ptr = ptr >>> 0;
+    return getFloat32ArrayMemory0().subarray(ptr / 4, ptr / 4 + len);
+}
+
+function getArrayU8FromWasm0(ptr, len) {
+    ptr = ptr >>> 0;
+    return getUint8ArrayMemory0().subarray(ptr / 1, ptr / 1 + len);
+}
+
+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;
+}
+
+let cachedFloat32ArrayMemory0 = null;
+function getFloat32ArrayMemory0() {
+    if (cachedFloat32ArrayMemory0 === null || cachedFloat32ArrayMemory0.byteLength === 0) {
+        cachedFloat32ArrayMemory0 = new Float32Array(wasm.memory.buffer);
+    }
+    return cachedFloat32ArrayMemory0;
+}
+
+function getStringFromWasm0(ptr, len) {
+    ptr = ptr >>> 0;
+    return decodeText(ptr, len);
+}
+
+let cachedUint8ArrayMemory0 = null;
+function getUint8ArrayMemory0() {
+    if (cachedUint8ArrayMemory0 === null || cachedUint8ArrayMemory0.byteLength === 0) {
+        cachedUint8ArrayMemory0 = new Uint8Array(wasm.memory.buffer);
+    }
+    return cachedUint8ArrayMemory0;
+}
+
+function handleError(f, args) {
+    try {
+        return f.apply(this, args);
+    } catch (e) {
+        const idx = addToExternrefTable0(e);
+        wasm.__wbindgen_exn_store(idx);
+    }
+}
+
+function passArray8ToWasm0(arg, malloc) {
+    const ptr = malloc(arg.length * 1, 1) >>> 0;
+    getUint8ArrayMemory0().set(arg, ptr / 1);
+    WASM_VECTOR_LEN = arg.length;
+    return ptr;
+}
+
+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 wasm;
+export function __wbg_set_wasm(val) {
+    wasm = val;
+}

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@grafeo-db/grafeo-wasm",
+  "type": "module",
+  "collaborators": [
+    "S.T. Grond"
+  ],
+  "description": "WebAssembly bindings for Grafeo graph database",
+  "version": "0.5.0",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/GrafeoDB/grafeo"
+  },
+  "files": [
+    "grafeo_wasm_bg.wasm",
+    "grafeo_wasm.js",
+    "grafeo_wasm_bg.js",
+    "grafeo_wasm.d.ts"
+  ],
+  "main": "grafeo_wasm.js",
+  "types": "grafeo_wasm.d.ts",
+  "sideEffects": [
+    "./grafeo_wasm.js",
+    "./snippets/*"
+  ]
+}