@grafeo-db/wasm-lite 0.5.33 → 0.5.34

package/grafeo_wasm.d.ts

@@ -24,6 +24,10 @@ export class Database {
      * CSR adjacency, and switches to read-only mode. After this call, write
      * operations will fail. Gives ~60x memory reduction and 100x+ traversal
      * speedup for read-only workloads.
+     *
+     * # Errors
+     *
+     * Returns `JsError` if compaction fails (e.g., the database is already in compact mode).
      */
     compact(): void;
     /**
@@ -43,12 +47,20 @@ export class Database {
      * const results = db.execute("MATCH (p:Person) RETURN p.name, p.age");
      * // [{name: "Alix", age: 30}, {name: "Gus", age: 25}]
      * ```
+     *
+     * # Errors
+     *
+     * Returns `JsError` if the query fails to parse or execute.
      */
     execute(query: string): any;
     /**
      * Executes a GQL query and returns raw columns, rows, and metadata.
      *
      * Returns `{ columns: string[], rows: any[][], executionTimeMs?: number }`.
+     *
+     * # Errors
+     *
+     * Returns `JsError` if the query fails to parse or execute.
      */
     executeRaw(query: string): any;
     /**
@@ -60,6 +72,10 @@ export class Database {
      * const raw = db.executeRawWithLanguage("MATCH (p:Person) RETURN p.name", "cypher");
      * // { columns: ["p.name"], rows: [["Alix"], ["Gus"]], executionTimeMs: 0.5 }
      * ```
+     *
+     * # Errors
+     *
+     * Returns `JsError` if the language is unsupported or the query fails to parse or execute.
      */
     executeRawWithLanguage(query: string, language: string): any;
     /**
@@ -74,6 +90,10 @@ export class Database {
      *   "cypher"
      * );
      * ```
+     *
+     * # Errors
+     *
+     * Returns `JsError` if the language is unsupported or the query fails to parse or execute.
      */
     executeWithLanguage(query: string, language: string): any;
     /**
@@ -88,6 +108,10 @@ export class Database {
      *   { name: "Alix" }
      * );
      * ```
+     *
+     * # Errors
+     *
+     * Returns `JsError` if `params` is invalid, the language is unsupported, or the query fails.
      */
     executeWithLanguageAndParams(query: string, language: string, params: any): any;
     /**
@@ -102,6 +126,10 @@ export class Database {
      *   { name: "Alix" }
      * );
      * ```
+     *
+     * # Errors
+     *
+     * Returns `JsError` if `params` is not a valid object, or if the query fails to parse or execute.
      */
     executeWithParams(query: string, params: any): any;
     /**
@@ -114,6 +142,10 @@ export class Database {
      * const bytes = db.exportSnapshot();
      * // Store in IndexedDB, download as file, etc.
      * ```
+     *
+     * # Errors
+     *
+     * Returns `JsError` if snapshot serialisation fails.
      */
     exportSnapshot(): Uint8Array;
     /**
@@ -138,6 +170,10 @@ export class Database {
      * });
      * // { nodes: 2, edges: 1 }
      * ```
+     *
+     * # Errors
+     *
+     * Returns `JsError` if `data` cannot be deserialised or if an edge references an out-of-bounds node index.
      */
     importLpg(data: any): any;
     /**
@@ -175,6 +211,14 @@ export class Database {
      *   { mode: "edges", edgeType: "KNOWS", source: "from", target: "to" }
      * );
      * ```
+     *
+     * # Errors
+     *
+     * Returns `JsError` if:
+     * - `options` cannot be deserialised or has an invalid `mode`.
+     * - `rows` is not an array of objects.
+     * - A required column (`label`, `edgeType`, `source`, `target`) is missing.
+     * - A source/target value is not a valid non-negative integer.
      */
     importRows(rows: any, options: any): number;
     /**
@@ -185,10 +229,18 @@ export class Database {
      * ```js
      * const db = Database.importSnapshot(bytes);
      * ```
+     *
+     * # Errors
+     *
+     * Returns `JsError` if `data` is not a valid snapshot or deserialisation fails.
      */
     static importSnapshot(data: Uint8Array): Database;
     /**
      * Returns high-level database information (counts, mode, features).
+     *
+     * # Errors
+     *
+     * Returns `JsError` if the info data cannot be serialised to a JS value.
      */
     info(): any;
     /**
@@ -204,10 +256,18 @@ export class Database {
      * console.log(`Store: ${usage.store.total_bytes} bytes`);
      * console.log(`Indexes: ${usage.indexes.total_bytes} bytes`);
      * ```
+     *
+     * # Errors
+     *
+     * Returns `JsError` if the memory usage data cannot be serialised to a JS value.
      */
     memoryUsage(): any;
     /**
      * Creates a new in-memory database.
+     *
+     * # Errors
+     *
+     * Returns `JsError` if the database fails to initialise.
      */
     constructor();
     /**
@@ -229,6 +289,10 @@ export class Database {
      * const schema = db.schema();
      * // { lpg: { labels: [...], edgeTypes: [...], propertyKeys: [...] } }
      * ```
+     *
+     * # Errors
+     *
+     * Returns `JsError` if the schema info cannot be serialised to a JS value.
      */
     schema(): any;
     /**

package/grafeo_wasm_bg.js

@@ -38,6 +38,10 @@ export class Database {
      * CSR adjacency, and switches to read-only mode. After this call, write
      * operations will fail. Gives ~60x memory reduction and 100x+ traversal
      * speedup for read-only workloads.
+     *
+     * # Errors
+     *
+     * Returns `JsError` if compaction fails (e.g., the database is already in compact mode).
      */
     compact() {
         try {
@@ -89,6 +93,10 @@ export class Database {
      * const results = db.execute("MATCH (p:Person) RETURN p.name, p.age");
      * // [{name: "Alix", age: 30}, {name: "Gus", age: 25}]
      * ```
+     *
+     * # Errors
+     *
+     * Returns `JsError` if the query fails to parse or execute.
      * @param {string} query
      * @returns {any}
      */
@@ -113,6 +121,10 @@ export class Database {
      * Executes a GQL query and returns raw columns, rows, and metadata.
      *
      * Returns `{ columns: string[], rows: any[][], executionTimeMs?: number }`.
+     *
+     * # Errors
+     *
+     * Returns `JsError` if the query fails to parse or execute.
      * @param {string} query
      * @returns {any}
      */
@@ -142,6 +154,10 @@ export class Database {
      * const raw = db.executeRawWithLanguage("MATCH (p:Person) RETURN p.name", "cypher");
      * // { columns: ["p.name"], rows: [["Alix"], ["Gus"]], executionTimeMs: 0.5 }
      * ```
+     *
+     * # Errors
+     *
+     * Returns `JsError` if the language is unsupported or the query fails to parse or execute.
      * @param {string} query
      * @param {string} language
      * @returns {any}
@@ -177,6 +193,10 @@ export class Database {
      *   "cypher"
      * );
      * ```
+     *
+     * # Errors
+     *
+     * Returns `JsError` if the language is unsupported or the query fails to parse or execute.
      * @param {string} query
      * @param {string} language
      * @returns {any}
@@ -212,6 +232,10 @@ export class Database {
      *   { name: "Alix" }
      * );
      * ```
+     *
+     * # Errors
+     *
+     * Returns `JsError` if `params` is invalid, the language is unsupported, or the query fails.
      * @param {string} query
      * @param {string} language
      * @param {any} params
@@ -248,6 +272,10 @@ export class Database {
      *   { name: "Alix" }
      * );
      * ```
+     *
+     * # Errors
+     *
+     * Returns `JsError` if `params` is not a valid object, or if the query fails to parse or execute.
      * @param {string} query
      * @param {any} params
      * @returns {any}
@@ -279,6 +307,10 @@ export class Database {
      * const bytes = db.exportSnapshot();
      * // Store in IndexedDB, download as file, etc.
      * ```
+     *
+     * # Errors
+     *
+     * Returns `JsError` if snapshot serialisation fails.
      * @returns {Uint8Array}
      */
     exportSnapshot() {
@@ -321,6 +353,10 @@ export class Database {
      * });
      * // { nodes: 2, edges: 1 }
      * ```
+     *
+     * # Errors
+     *
+     * Returns `JsError` if `data` cannot be deserialised or if an edge references an out-of-bounds node index.
      * @param {any} data
      * @returns {any}
      */
@@ -374,6 +410,14 @@ export class Database {
      *   { mode: "edges", edgeType: "KNOWS", source: "from", target: "to" }
      * );
      * ```
+     *
+     * # Errors
+     *
+     * Returns `JsError` if:
+     * - `options` cannot be deserialised or has an invalid `mode`.
+     * - `rows` is not an array of objects.
+     * - A required column (`label`, `edgeType`, `source`, `target`) is missing.
+     * - A source/target value is not a valid non-negative integer.
      * @param {any} rows
      * @param {any} options
      * @returns {number}
@@ -401,6 +445,10 @@ export class Database {
      * ```js
      * const db = Database.importSnapshot(bytes);
      * ```
+     *
+     * # Errors
+     *
+     * Returns `JsError` if `data` is not a valid snapshot or deserialisation fails.
      * @param {Uint8Array} data
      * @returns {Database}
      */
@@ -423,6 +471,10 @@ export class Database {
     }
     /**
      * Returns high-level database information (counts, mode, features).
+     *
+     * # Errors
+     *
+     * Returns `JsError` if the info data cannot be serialised to a JS value.
      * @returns {any}
      */
     info() {
@@ -453,6 +505,10 @@ export class Database {
      * console.log(`Store: ${usage.store.total_bytes} bytes`);
      * console.log(`Indexes: ${usage.indexes.total_bytes} bytes`);
      * ```
+     *
+     * # Errors
+     *
+     * Returns `JsError` if the memory usage data cannot be serialised to a JS value.
      * @returns {any}
      */
     memoryUsage() {
@@ -472,6 +528,10 @@ export class Database {
     }
     /**
      * Creates a new in-memory database.
+     *
+     * # Errors
+     *
+     * Returns `JsError` if the database fails to initialise.
      */
     constructor() {
         try {
@@ -515,6 +575,10 @@ export class Database {
      * const schema = db.schema();
      * // { lpg: { labels: [...], edgeTypes: [...], propertyKeys: [...] } }
      * ```
+     *
+     * # Errors
+     *
+     * Returns `JsError` if the schema info cannot be serialised to a JS value.
      * @returns {any}
      */
     schema() {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@grafeo-db/wasm-lite",
   "type": "module",
-  "version": "0.5.33",
+  "version": "0.5.34",
   "description": "WebAssembly bindings for Grafeo - GQL-only lightweight variant",
   "keywords": [
     "graph",