@grafeo-db/wasm 0.1.4 → 0.5.1

package/README.md

@@ -1,12 +1,16 @@
 # @grafeo-db/wasm
 
-WebAssembly bindings for [Grafeo](https://grafeo.dev) - a high-performance, pure-Rust, embeddable graph database.
+Low-level WebAssembly binary for [Grafeo](https://github.com/GrafeoDB/grafeo), a high-performance graph database.
 
-## Status
+## Which Package Do You Need?
 
-**Pre-alpha** - The WebAssembly bindings are under development.
+| 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) |
 
-For production use, please use the [Python bindings](https://pypi.org/project/grafeo/) which are fully functional.
+**Most users should use `@grafeo-db/web`** - it wraps this package and adds browser-specific features.
 
 ## Installation
 
@@ -14,16 +18,66 @@ For production use, please use the [Python bindings](https://pypi.org/project/gr
 npm install @grafeo-db/wasm
 ```
 
-## Planned Features
+## Usage
 
-- Browser and Node.js compatible WebAssembly module
-- Full TypeScript type definitions
-- Support for GQL, Cypher, SPARQL, and GraphQL query languages
-- In-memory graph database in the browser
-- Persistence via IndexedDB or OPFS
+```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)
-- [Python Package](https://pypi.org/project/grafeo/)
+- [Roadmap](https://github.com/GrafeoDB/grafeo/blob/main/docs/roadmap.md)
+
+## License
+
+Apache-2.0

package/grafeo_wasm.d.ts

@@ -1,5 +1,94 @@
-// grafeo-wasm - WebAssembly bindings for Grafeo
-// Pre-alpha - bindings are under development.
-// See https://grafeo.dev for current status.
+/* tslint:disable */
+/* eslint-disable */
 
-export {};
+/**
+ * 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

@@ -1,5 +1,9 @@
-throw new Error(
-  'grafeo-wasm is pre-alpha and not yet implemented. ' +
-  'Please see https://grafeo.dev for the current status. ' +
-  'For production use, consider the Python bindings: https://pypi.org/project/grafeo/'
-);
+/* @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.wasm.d.ts

@@ -0,0 +1,22 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export const __wbg_database_free: (a: number, b: number) => void;
+export const database_edgeCount: (a: number) => number;
+export const database_execute: (a: number, b: number, c: number) => [number, number, number];
+export const database_executeRaw: (a: number, b: number, c: number) => [number, number, number];
+export const database_executeWithLanguage: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
+export const database_exportSnapshot: (a: number) => [number, number, number, number];
+export const database_importSnapshot: (a: number, b: number) => [number, number, number];
+export const database_new: () => [number, number, number];
+export const database_nodeCount: (a: number) => number;
+export const database_schema: (a: number) => [number, number, number];
+export const database_version: () => [number, number];
+export const __wbindgen_malloc: (a: number, b: number) => number;
+export const __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+export const __wbindgen_free: (a: number, b: number, c: number) => void;
+export const __wbindgen_exn_store: (a: number) => void;
+export const __externref_table_alloc: () => number;
+export const __wbindgen_externrefs: WebAssembly.Table;
+export const __externref_table_dealloc: (a: number) => void;
+export const __wbindgen_start: () => void;

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@grafeo-db/wasm",
-  "version": "0.1.4",
+  "type": "module",
+  "version": "0.5.1",
   "description": "WebAssembly bindings for Grafeo - a high-performance embeddable graph database",
   "keywords": [
     "graph",
@@ -12,8 +13,8 @@
     "wasm",
     "webassembly"
   ],
-  "author": "StevenBtw",
-  "license": "MIT",
+  "author": "S.T. Grond",
+  "license": "Apache-2.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/GrafeoDB/grafeo.git",
@@ -28,6 +29,11 @@
   "files": [
     "grafeo_wasm.js",
     "grafeo_wasm.d.ts",
-    "grafeo_wasm_bg.wasm"
+    "grafeo_wasm_bg.wasm",
+    "grafeo_wasm_bg.wasm.d.ts"
+  ],
+  "sideEffects": [
+    "./grafeo_wasm.js",
+    "./snippets/*"
   ]
 }