frogql 0.2.0-rc.2 → 0.2.1

package/CHANGELOG.md

@@ -8,6 +8,17 @@ Released in lock-step with the [PyPI `frogql` package](https://pypi.org/project/
 
 ## [Unreleased]
 
+## [0.2.0-rc.3] — 2026-05-12
+
+### Fixed
+
+- Host package now ships `index.js` and `index.d.ts`. The `0.2.0-rc.2` tarball uploaded those files as build artifacts only and they never reached the publish job, so the package on npm contained README + LICENSE + package.json with no JavaScript. `require('frogql')` returned `Cannot find module './index.js'` for every consumer.
+- Both files are now checked into git (canonical napi-rs pattern). Removed from `node/.gitignore`.
+
+### Deprecated
+
+- `frogql@0.2.0-rc.2` — broken, use `frogql@0.2.0-rc.3` or later.
+
 ## [0.2.0-rc.2] — 2026-05-12
 
 ### Added

package/index.d.ts

@@ -0,0 +1,147 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/* auto-generated by NAPI-RS */
+
+/** Result of `Connection.schema()`. */
+export interface SchemaSummary {
+  nodeLabels: Array<string>
+  edgeLabels: Array<string>
+  nodeCount: number
+  edgeCount: number
+}
+/** One entry in `Connection.graphTypes()`. */
+export interface GraphTypeSummary {
+  name: string
+  active: boolean
+  /** Number of node types declared in this graph type, if known. */
+  nodes?: number
+  /** Number of edge types declared in this graph type, if known. */
+  edges?: number
+}
+/**
+ * Shape of a node reference inside an `execute()` row. `kind` is
+ * always `"node"`. Cast `execute()` rows to `{ x: NodeRef }` etc.
+ */
+export interface NodeRef {
+  kind: string
+  id: number
+  labels: Array<string>
+  /**
+   * Free-form property bag. Values are JSON-compatible (number /
+   * string / boolean / null / nested object / array).
+   */
+  props: any
+}
+/**
+ * Shape of an edge reference inside an `execute()` row. `kind` is
+ * always `"edge"`. `props` is present when returned via `RETURN e`
+ * (top-level `Value::Edge`); omitted in path context to keep payloads
+ * small.
+ */
+export interface EdgeRef {
+  kind: string
+  id: number
+  labels: Array<string>
+  props?: any
+}
+/**
+ * Counters returned from a successful DML statement (INSERT / SET /
+ * REMOVE / DELETE / DETACH DELETE).
+ */
+export interface DmCounters {
+  nodesInserted: number
+  edgesInserted: number
+  nodesDeleted: number
+  edgesDeleted: number
+  nodesModified: number
+  edgesModified: number
+  rows: number
+}
+/** Result envelope for `CREATE / USE / DROP GRAPH TYPE`. */
+export interface DdlOk {
+  ok: boolean
+  /** Always `"ddl"` for catalog statements. */
+  kind: string
+  message: string
+}
+/** Result envelope for `CREATE / DROP INDEX`. */
+export interface IndexResult {
+  ok: boolean
+  /** Always `"index"`. */
+  kind: string
+  name: string
+  /** Present on CREATE, absent on DROP. */
+  label?: string
+  /** Present on CREATE, absent on DROP. */
+  prop?: string
+  /** `"HASH"` or `"BTREE"`. Present on CREATE only. */
+  indexKind?: string
+  /** Number of (label, prop) entries indexed. Present on CREATE only. */
+  entries?: number
+  /** Present when DROP failed (index not found). */
+  error?: string
+}
+/** One entry in `SHOW INDEXES`. */
+export interface IndexSummary {
+  name: string
+  label: string
+  prop: string
+  /** `"HASH"` or `"BTREE"`. */
+  kind: string
+  /**
+   * `true` for auto-built indexes (memory-only), `false` for
+   * DDL-declared (persisted in `.gdb`).
+   */
+  auto: boolean
+  entries: number
+}
+/**
+ * Open or create a `.gdb` database. Eagerly warms the LTJ TripleIndex
+ * so the first `execute()` on the returned Connection runs at warm
+ * cache speed.
+ */
+export declare function open(path: string): Connection
+/**
+ * Import a JSON graph (`{nodes: [...], edges: [...]}`) into a fresh
+ * `.gdb` at `dbPath`. Overwrites the destination.
+ */
+export declare function importJson(dbPath: string, jsonPath: string): void
+/**
+ * Import a directory of CSVs (configured via `spanner_import_config.json`)
+ * into a fresh `.gdb` at `dbPath`. Overwrites the destination.
+ */
+export declare function importCsv(dbPath: string, csvDir: string): void
+export declare class Connection {
+  get nodeCount(): number
+  get edgeCount(): number
+  /**
+   * Run a GQL statement. The return is polymorphic — depends on
+   * statement kind:
+   * - Query with RETURN: `Array<Record<string, unknown>>` keyed by alias
+   * - Query without RETURN: `Array<{ _paths, ...vars }>`
+   * - CREATE / USE / DROP GRAPH TYPE: `DdlOk`
+   * - SHOW GRAPH TYPES: `Array<GraphTypeSummary>`
+   * - SHOW GRAPH TYPE / SHOW CURRENT GRAPH TYPE / VALIDATE GRAPH TYPE: object
+   * - CREATE / DROP INDEX: `IndexResult`
+   * - SHOW INDEXES: `Array<IndexSummary>`
+   * - DML: `DmCounters`
+   *
+   * Cast the return to the expected shape:
+   * `const rows = conn.execute("MATCH ...") as Array<{ x: NodeRef }>`
+   */
+  execute(query: string, limit?: number | undefined | null): unknown
+  /**
+   * Persist the merged base+overlay state back to the file the
+   * connection was opened from. Mirrors `.save` REPL command and
+   * SQLite's explicit-save model.
+   */
+  save(): void
+  /** List graph types currently in the catalog with active markers. */
+  graphTypes(): Array<GraphTypeSummary>
+  /**
+   * Lightweight schema summary derived from the live graph: sorted
+   * label sets + node / edge counts. Does NOT consult the catalog.
+   */
+  schema(): SchemaSummary
+}

package/index.js

@@ -0,0 +1,318 @@
+/* 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, 'frogql.android-arm64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./frogql.android-arm64.node')
+          } else {
+            nativeBinding = require('frogql-android-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(join(__dirname, 'frogql.android-arm-eabi.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./frogql.android-arm-eabi.node')
+          } else {
+            nativeBinding = require('frogql-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, 'frogql.win32-x64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./frogql.win32-x64-msvc.node')
+          } else {
+            nativeBinding = require('frogql-win32-x64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'ia32':
+        localFileExisted = existsSync(
+          join(__dirname, 'frogql.win32-ia32-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./frogql.win32-ia32-msvc.node')
+          } else {
+            nativeBinding = require('frogql-win32-ia32-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'frogql.win32-arm64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./frogql.win32-arm64-msvc.node')
+          } else {
+            nativeBinding = require('frogql-win32-arm64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Windows: ${arch}`)
+    }
+    break
+  case 'darwin':
+    localFileExisted = existsSync(join(__dirname, 'frogql.darwin-universal.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./frogql.darwin-universal.node')
+      } else {
+        nativeBinding = require('frogql-darwin-universal')
+      }
+      break
+    } catch {}
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(join(__dirname, 'frogql.darwin-x64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./frogql.darwin-x64.node')
+          } else {
+            nativeBinding = require('frogql-darwin-x64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'frogql.darwin-arm64.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./frogql.darwin-arm64.node')
+          } else {
+            nativeBinding = require('frogql-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, 'frogql.freebsd-x64.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./frogql.freebsd-x64.node')
+      } else {
+        nativeBinding = require('frogql-freebsd-x64')
+      }
+    } catch (e) {
+      loadError = e
+    }
+    break
+  case 'linux':
+    switch (arch) {
+      case 'x64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'frogql.linux-x64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./frogql.linux-x64-musl.node')
+            } else {
+              nativeBinding = require('frogql-linux-x64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'frogql.linux-x64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./frogql.linux-x64-gnu.node')
+            } else {
+              nativeBinding = require('frogql-linux-x64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'frogql.linux-arm64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./frogql.linux-arm64-musl.node')
+            } else {
+              nativeBinding = require('frogql-linux-arm64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'frogql.linux-arm64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./frogql.linux-arm64-gnu.node')
+            } else {
+              nativeBinding = require('frogql-linux-arm64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'frogql.linux-arm-musleabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./frogql.linux-arm-musleabihf.node')
+            } else {
+              nativeBinding = require('frogql-linux-arm-musleabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'frogql.linux-arm-gnueabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./frogql.linux-arm-gnueabihf.node')
+            } else {
+              nativeBinding = require('frogql-linux-arm-gnueabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'riscv64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'frogql.linux-riscv64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./frogql.linux-riscv64-musl.node')
+            } else {
+              nativeBinding = require('frogql-linux-riscv64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'frogql.linux-riscv64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./frogql.linux-riscv64-gnu.node')
+            } else {
+              nativeBinding = require('frogql-linux-riscv64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 's390x':
+        localFileExisted = existsSync(
+          join(__dirname, 'frogql.linux-s390x-gnu.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./frogql.linux-s390x-gnu.node')
+          } else {
+            nativeBinding = require('frogql-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 { Connection, open, importJson, importCsv } = nativeBinding
+
+module.exports.Connection = Connection
+module.exports.open = open
+module.exports.importJson = importJson
+module.exports.importCsv = importCsv

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "frogql",
-  "version": "0.2.0-rc.2",
+  "version": "0.2.1",
   "description": "froGQL — embedded GQL graph database with ISO GQL path patterns (Rust core, Node.js bindings via napi-rs)",
   "main": "index.js",
   "types": "index.d.ts",
@@ -65,10 +65,10 @@
     "provenance": true
   },
   "optionalDependencies": {
-    "frogql-darwin-x64": "0.2.0-rc.2",
-    "frogql-darwin-arm64": "0.2.0-rc.2",
-    "frogql-linux-x64-gnu": "0.2.0-rc.2",
-    "frogql-linux-arm64-gnu": "0.2.0-rc.2",
-    "frogql-win32-x64-msvc": "0.2.0-rc.2"
+    "frogql-darwin-x64": "0.2.1",
+    "frogql-darwin-arm64": "0.2.1",
+    "frogql-linux-x64-gnu": "0.2.1",
+    "frogql-linux-arm64-gnu": "0.2.1",
+    "frogql-win32-x64-msvc": "0.2.1"
   }
 }