@grafeo-db/js 0.1.4 → 0.4.1

package/index.d.ts

@@ -1,5 +1,135 @@
-// grafeo-js - Node.js/TypeScript bindings for Grafeo
-// Pre-alpha - bindings are under development.
-// See https://grafeo.dev for current status.
+/* tslint:disable */
+/* eslint-disable */
 
-export {};
+/* auto-generated by NAPI-RS */
+
+/** Returns the active SIMD instruction set for vector operations. */
+export declare function simdSupport(): string
+/** Returns the Grafeo version. */
+export declare function version(): string
+export type JsGrafeoDB = GrafeoDB
+/** Your connection to a Grafeo database. */
+export declare class GrafeoDB {
+  /** Create a database. Pass a path for persistence, or omit for in-memory. */
+  static create(path?: string | undefined | null): JsGrafeoDb
+  /** Open an existing database at the given path. */
+  static open(path: string): JsGrafeoDb
+  /** Execute a GQL query. Returns a Promise<QueryResult>. */
+  execute(query: string, params?: any | undefined | null): Promise<QueryResult>
+  /** Execute a Cypher query. */
+  executeCypher(query: string, params?: any | undefined | null): Promise<QueryResult>
+  /** Execute a Gremlin query. */
+  executeGremlin(query: string, params?: any | undefined | null): Promise<QueryResult>
+  /** Execute a GraphQL query. */
+  executeGraphql(query: string, params?: any | undefined | null): Promise<QueryResult>
+  /** Execute a SPARQL query against the RDF triple store. */
+  executeSparql(query: string): Promise<QueryResult>
+  /** Create a node with labels and optional properties. */
+  createNode(labels: Array<string>, properties?: object | undefined | null): JsNode
+  /** Create an edge between two nodes. */
+  createEdge(sourceId: number, targetId: number, edgeType: string, properties?: object | undefined | null): JsEdge
+  /** Get a node by ID. */
+  getNode(id: number): JsNode | null
+  /** Get an edge by ID. */
+  getEdge(id: number): JsEdge | null
+  /** Delete a node by ID. Returns true if the node existed. */
+  deleteNode(id: number): boolean
+  /** Delete an edge by ID. Returns true if the edge existed. */
+  deleteEdge(id: number): boolean
+  /** Set a property on a node. */
+  setNodeProperty(id: number, key: string, value: unknown): void
+  /** Set a property on an edge. */
+  setEdgeProperty(id: number, key: string, value: unknown): void
+  /** Get the number of nodes. */
+  get nodeCount(): number
+  /** Get the number of edges. */
+  get edgeCount(): number
+  /** Begin a transaction. */
+  beginTransaction(): Transaction
+  /** Create a vector similarity index on a node property. */
+  createVectorIndex(label: string, property: string, dimensions?: number | undefined | null, metric?: string | undefined | null, m?: number | undefined | null, efConstruction?: number | undefined | null): Promise<void>
+  /** Search for the k nearest neighbors of a query vector. */
+  vectorSearch(label: string, property: string, query: Array<number>, k: number, ef?: number | undefined | null): Promise<Array<Array<number>>>
+  /** Bulk-insert nodes with vector properties. */
+  batchCreateNodes(label: string, property: string, vectors: Array<Array<number>>): Promise<Array<number>>
+  /** Batch search for nearest neighbors of multiple query vectors. */
+  batchVectorSearch(label: string, property: string, queries: Array<Array<number>>, k: number, ef?: number | undefined | null): Promise<Array<Array<Array<number>>>>
+  /** Close the database. */
+  close(): void
+}
+/** A node in the graph with labels and properties. */
+export declare class JsNode {
+  /** Get the node ID. */
+  get id(): number
+  /** Get the node labels. */
+  get labels(): Array<string>
+  /** Get a property value by key. */
+  get(key: string): unknown
+  /** Get all properties as a plain object. */
+  properties(): object
+  /** Check if the node has a specific label. */
+  hasLabel(label: string): boolean
+  /** String representation. */
+  toString(): string
+}
+/** An edge (relationship) between two nodes with a type and properties. */
+export declare class JsEdge {
+  /** Get the edge ID. */
+  get id(): number
+  /** Get the edge type (relationship type). */
+  get edgeType(): string
+  /** Get the source node ID. */
+  get sourceId(): number
+  /** Get the target node ID. */
+  get targetId(): number
+  /** Get a property value by key. */
+  get(key: string): unknown
+  /** Get all properties as a plain object. */
+  properties(): object
+  /** String representation. */
+  toString(): string
+}
+/** Results from a query - access rows, nodes, and edges. */
+export declare class QueryResult {
+  /** Get column names. */
+  get columns(): Array<string>
+  /** Get number of rows. */
+  get length(): number
+  /** Query execution time in milliseconds (if available). */
+  get executionTimeMs(): number | null
+  /** Number of rows scanned during execution (if available). */
+  get rowsScanned(): number | null
+  /** Get a single row by index as a plain object. */
+  get(index: number): object
+  /** Get all rows as an array of objects. */
+  toArray(): Array<object>
+  /** Get first column of first row (single value). */
+  scalar(): unknown
+  /** Get nodes found in the result. */
+  nodes(): Array<JsNode>
+  /** Get edges found in the result. */
+  edges(): Array<JsEdge>
+  /** Get all rows as an array of arrays (no column names). */
+  rows(): object
+}
+/**
+ * A database transaction with explicit commit/rollback.
+ *
+ * In Node.js 22+, use with `using` for automatic cleanup:
+ * ```js
+ * using tx = db.beginTransaction();
+ * await tx.execute("INSERT (:Person {name: 'Alice'})");
+ * tx.commit();
+ * // auto-rollback if commit not called
+ * ```
+ */
+export declare class Transaction {
+  /** Execute a query within this transaction. */
+  execute(query: string, params?: any | undefined | null): Promise<QueryResult>
+  /** Commit the transaction. */
+  commit(): void
+  /** Roll back the transaction. */
+  rollback(): void
+  /** Whether the transaction is still active. */
+  get isActive(): boolean
+}

package/index.js

@@ -1,5 +1,321 @@
-throw new Error(
-  'grafeo-js 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/'
-);
+/* tslint:disable */
+/* eslint-disable */
+/* prettier-ignore */
+
+/* auto-generated by NAPI-RS */
+
+const { existsSync, readFileSync } = require('fs')
+const { join } = require('path')
+
+const { platform, arch } = process
+
+let nativeBinding = null
+let localFileExisted = false
+let loadError = null
+
+function isMusl() {
+  // For Node 10
+  if (!process.report || typeof process.report.getReport !== 'function') {
+    try {
+      const lddPath = require('child_process').execSync('which ldd').toString().trim()
+      return readFileSync(lddPath, 'utf8').includes('musl')
+    } catch (e) {
+      return true
+    }
+  } else {
+    const { glibcVersionRuntime } = process.report.getReport().header
+    return !glibcVersionRuntime
+  }
+}
+
+switch (platform) {
+  case 'android':
+    switch (arch) {
+      case 'arm64':
+        localFileExisted = existsSync(join(__dirname, 'grafeo.android-arm64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./grafeo.android-arm64.node')
+          } else {
+            nativeBinding = require('@grafeo-db/js-android-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(join(__dirname, 'grafeo.android-arm-eabi.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./grafeo.android-arm-eabi.node')
+          } else {
+            nativeBinding = require('@grafeo-db/js-android-arm-eabi')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Android ${arch}`)
+    }
+    break
+  case 'win32':
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(
+          join(__dirname, 'grafeo.win32-x64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./grafeo.win32-x64-msvc.node')
+          } else {
+            nativeBinding = require('@grafeo-db/js-win32-x64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'ia32':
+        localFileExisted = existsSync(
+          join(__dirname, 'grafeo.win32-ia32-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./grafeo.win32-ia32-msvc.node')
+          } else {
+            nativeBinding = require('@grafeo-db/js-win32-ia32-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'grafeo.win32-arm64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./grafeo.win32-arm64-msvc.node')
+          } else {
+            nativeBinding = require('@grafeo-db/js-win32-arm64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Windows: ${arch}`)
+    }
+    break
+  case 'darwin':
+    localFileExisted = existsSync(join(__dirname, 'grafeo.darwin-universal.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./grafeo.darwin-universal.node')
+      } else {
+        nativeBinding = require('@grafeo-db/js-darwin-universal')
+      }
+      break
+    } catch {}
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(join(__dirname, 'grafeo.darwin-x64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./grafeo.darwin-x64.node')
+          } else {
+            nativeBinding = require('@grafeo-db/js-darwin-x64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'grafeo.darwin-arm64.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./grafeo.darwin-arm64.node')
+          } else {
+            nativeBinding = require('@grafeo-db/js-darwin-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on macOS: ${arch}`)
+    }
+    break
+  case 'freebsd':
+    if (arch !== 'x64') {
+      throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
+    }
+    localFileExisted = existsSync(join(__dirname, 'grafeo.freebsd-x64.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./grafeo.freebsd-x64.node')
+      } else {
+        nativeBinding = require('@grafeo-db/js-freebsd-x64')
+      }
+    } catch (e) {
+      loadError = e
+    }
+    break
+  case 'linux':
+    switch (arch) {
+      case 'x64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'grafeo.linux-x64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./grafeo.linux-x64-musl.node')
+            } else {
+              nativeBinding = require('@grafeo-db/js-linux-x64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'grafeo.linux-x64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./grafeo.linux-x64-gnu.node')
+            } else {
+              nativeBinding = require('@grafeo-db/js-linux-x64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'grafeo.linux-arm64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./grafeo.linux-arm64-musl.node')
+            } else {
+              nativeBinding = require('@grafeo-db/js-linux-arm64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'grafeo.linux-arm64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./grafeo.linux-arm64-gnu.node')
+            } else {
+              nativeBinding = require('@grafeo-db/js-linux-arm64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'grafeo.linux-arm-musleabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./grafeo.linux-arm-musleabihf.node')
+            } else {
+              nativeBinding = require('@grafeo-db/js-linux-arm-musleabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'grafeo.linux-arm-gnueabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./grafeo.linux-arm-gnueabihf.node')
+            } else {
+              nativeBinding = require('@grafeo-db/js-linux-arm-gnueabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'riscv64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'grafeo.linux-riscv64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./grafeo.linux-riscv64-musl.node')
+            } else {
+              nativeBinding = require('@grafeo-db/js-linux-riscv64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'grafeo.linux-riscv64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./grafeo.linux-riscv64-gnu.node')
+            } else {
+              nativeBinding = require('@grafeo-db/js-linux-riscv64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 's390x':
+        localFileExisted = existsSync(
+          join(__dirname, 'grafeo.linux-s390x-gnu.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./grafeo.linux-s390x-gnu.node')
+          } else {
+            nativeBinding = require('@grafeo-db/js-linux-s390x-gnu')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Linux: ${arch}`)
+    }
+    break
+  default:
+    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
+}
+
+if (!nativeBinding) {
+  if (loadError) {
+    throw loadError
+  }
+  throw new Error(`Failed to load native binding`)
+}
+
+const { GrafeoDB, JsNode, JsEdge, QueryResult, Transaction, simdSupport, version } = nativeBinding
+
+module.exports.GrafeoDB = GrafeoDB
+module.exports.JsNode = JsNode
+module.exports.JsEdge = JsEdge
+module.exports.QueryResult = QueryResult
+module.exports.Transaction = Transaction
+module.exports.simdSupport = simdSupport
+module.exports.version = version

package/package.json

@@ -1,7 +1,24 @@
 {
   "name": "@grafeo-db/js",
-  "version": "0.1.4",
+  "version": "0.4.1",
   "description": "Node.js/TypeScript bindings for Grafeo - a high-performance embeddable graph database",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "napi": {
+    "name": "grafeo",
+    "triples": {
+      "defaults": true,
+      "additional": [
+        "aarch64-apple-darwin",
+        "aarch64-unknown-linux-gnu",
+        "aarch64-unknown-linux-musl"
+      ]
+    }
+  },
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
   "keywords": [
     "graph",
     "database",
@@ -10,22 +27,41 @@
     "sparql",
     "knowledge-graph",
     "native",
-    "napi"
+    "napi",
+    "embedded"
   ],
   "author": "StevenBtw",
-  "license": "MIT",
+  "license": "AGPL-3.0-or-later",
   "repository": {
     "type": "git",
     "url": "https://github.com/GrafeoDB/grafeo.git",
-    "directory": "crates/bindings/js"
+    "directory": "crates/bindings/node"
   },
   "homepage": "https://grafeo.dev",
   "bugs": {
     "url": "https://github.com/GrafeoDB/grafeo/issues"
   },
-  "main": "index.js",
-  "types": "index.d.ts",
   "engines": {
     "node": ">=18"
+  },
+  "scripts": {
+    "artifacts": "napi artifacts",
+    "build": "napi build --platform --release --features full",
+    "build:debug": "napi build --platform",
+    "test": "vitest run",
+    "prepublishOnly": "napi prepublish -t npm",
+    "version": "napi version"
+  },
+  "devDependencies": {
+    "@napi-rs/cli": "^2.18.0",
+    "vitest": "^4.0.18"
+  },
+  "optionalDependencies": {
+    "@grafeo-db/js-win32-x64-msvc": "0.4.1",
+    "@grafeo-db/js-darwin-x64": "0.4.1",
+    "@grafeo-db/js-linux-x64-gnu": "0.4.1",
+    "@grafeo-db/js-darwin-arm64": "0.4.1",
+    "@grafeo-db/js-linux-arm64-gnu": "0.4.1",
+    "@grafeo-db/js-linux-arm64-musl": "0.4.1"
   }
-}
+}

package/README.md

@@ -1,29 +0,0 @@
-# @grafeo-db/js
-
-Node.js/TypeScript bindings for [Grafeo](https://grafeo.dev) - a high-performance, pure-Rust, embeddable graph database.
-
-## Status
-
-**Pre-alpha** - The Node.js bindings are under development.
-
-For production use, please use the [Python bindings](https://pypi.org/project/grafeo/) which are fully functional.
-
-## Installation
-
-```bash
-npm install @grafeo-db/js
-```
-
-## Planned Features
-
-- Native Node.js bindings via napi-rs
-- Full TypeScript type definitions
-- Support for GQL, Cypher, SPARQL, and GraphQL query languages
-- Zero-copy data transfer where possible
-- Async/await API
-
-## Links
-
-- [Documentation](https://grafeo.dev)
-- [GitHub](https://github.com/GrafeoDB/grafeo)
-- [Python Package](https://pypi.org/project/grafeo/)