leangraph 1.0.0

package/dist/types.d.ts

@@ -0,0 +1,136 @@
+/**
+ * Options for creating a GraphDB client.
+ * All options support environment variable defaults.
+ */
+export interface GraphDBOptions {
+    /**
+     * Base URL of the GraphDB server.
+     * Used in production mode. Ignored in development mode.
+     * @default GRAPHDB_URL env var or 'https://leangraph.io'
+     * @example 'https://my-graphdb.example.com'
+     */
+    url?: string;
+    /**
+     * Project name.
+     * In production: used as part of the API endpoint path.
+     * In development: used as the database filename.
+     * @default GRAPHDB_PROJECT env var (required)
+     */
+    project?: string;
+    /**
+     * API key for authentication.
+     * Used in production mode. Ignored in development mode.
+     * @default GRAPHDB_API_KEY env var
+     */
+    apiKey?: string;
+    /**
+     * Environment name for data isolation.
+     * @default NODE_ENV or 'production'
+     */
+    env?: string;
+    /**
+     * Path for local data storage.
+     * Only used in development mode (when NODE_ENV=development).
+     * - Use ':memory:' for an in-memory database (resets on restart)
+     * @default GRAPHDB_DATA_PATH env var or './data'
+     */
+    dataPath?: string;
+}
+/**
+ * Full response from a query, including metadata.
+ */
+export interface QueryResponse<T = Record<string, unknown>> {
+    success: boolean;
+    data: T[];
+    meta: {
+        count: number;
+        time_ms: number;
+    };
+    error?: {
+        message: string;
+        position?: number;
+        line?: number;
+        column?: number;
+    };
+}
+/**
+ * Health check response.
+ */
+export interface HealthResponse {
+    status: string;
+    timestamp: string;
+}
+/**
+ * Result type for node queries.
+ * In Neo4j 3.5 format, nodes return their properties directly.
+ */
+export type NodeResult = Record<string, unknown>;
+/**
+ * GraphDB client interface.
+ * Both local and remote clients implement this interface.
+ */
+export interface GraphDBClient {
+    /**
+     * Execute a Cypher query and return the data array.
+     * @throws GraphDBError if the query fails
+     */
+    query<T = Record<string, unknown>>(cypher: string, params?: Record<string, unknown>): Promise<T[]>;
+    /**
+     * Execute a Cypher query and return the full response including metadata.
+     * @throws GraphDBError if the query fails
+     */
+    queryRaw<T = Record<string, unknown>>(cypher: string, params?: Record<string, unknown>): Promise<QueryResponse<T>>;
+    /**
+     * Execute a mutating query (CREATE, SET, DELETE, MERGE) without expecting return data.
+     * @throws GraphDBError if the query fails
+     */
+    execute(cypher: string, params?: Record<string, unknown>): Promise<void>;
+    /**
+     * Create a node with the given label and properties.
+     * @returns The generated node ID
+     */
+    createNode(label: string, properties?: Record<string, unknown>): Promise<string>;
+    /**
+     * Create an edge between two nodes.
+     */
+    createEdge(sourceId: string, type: string, targetId: string, properties?: Record<string, unknown>): Promise<void>;
+    /**
+     * Get a node by label and property filter.
+     * @returns The node's properties, or null if not found
+     */
+    getNode(label: string, filter: Record<string, unknown>): Promise<NodeResult | null>;
+    /**
+     * Delete a node by ID (with DETACH to remove connected edges).
+     */
+    deleteNode(id: string): Promise<void>;
+    /**
+     * Update properties on a node.
+     */
+    updateNode(id: string, properties: Record<string, unknown>): Promise<void>;
+    /**
+     * Check health.
+     * Local: always returns ok.
+     * Remote: calls the server health endpoint.
+     */
+    health(): Promise<HealthResponse>;
+    /**
+     * Close the client and release resources.
+     * Important: Always call this when done to prevent resource leaks.
+     */
+    close(): void;
+}
+/**
+ * Error thrown by GraphDB operations.
+ * Contains optional position information for Cypher parse errors.
+ */
+export declare class GraphDBError extends Error {
+    readonly position?: number;
+    readonly line?: number;
+    readonly column?: number;
+    constructor(message: string, options?: {
+        position?: number;
+        line?: number;
+        column?: number;
+    });
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAMA;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAMD;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACxD,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,KAAK,CAAC,EAAE;QACN,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAMjD;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,KAAK,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IAEhB;;;OAGG;IACH,QAAQ,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAClC,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAE7B;;;OAGG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzE;;;OAGG;IACH,UAAU,CACR,KAAK,EAAE,MAAM,EACb,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACnC,OAAO,CAAC,MAAM,CAAC,CAAC;IAEnB;;OAEG;IACH,UAAU,CACR,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,EAChB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACnC,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;OAGG;IACH,OAAO,CACL,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC9B,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtC;;OAEG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3E;;;;OAIG;IACH,MAAM,IAAI,OAAO,CAAC,cAAc,CAAC,CAAC;IAElC;;;OAGG;IACH,KAAK,IAAI,IAAI,CAAC;CACf;AAMD;;;GAGG;AACH,qBAAa,YAAa,SAAQ,KAAK;IACrC,SAAgB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClC,SAAgB,IAAI,CAAC,EAAE,MAAM,CAAC;IAC9B,SAAgB,MAAM,CAAC,EAAE,MAAM,CAAC;gBAG9B,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;QACR,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CAQJ"}

package/dist/types.js

@@ -0,0 +1,21 @@
+// LeanGraph - Shared Types
+// ============================================================================
+// Error Class
+// ============================================================================
+/**
+ * Error thrown by GraphDB operations.
+ * Contains optional position information for Cypher parse errors.
+ */
+export class GraphDBError extends Error {
+    position;
+    line;
+    column;
+    constructor(message, options) {
+        super(message);
+        this.name = "GraphDBError";
+        this.position = options?.position;
+        this.line = options?.line;
+        this.column = options?.column;
+    }
+}
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,2BAA2B;AA0K3B,+EAA+E;AAC/E,cAAc;AACd,+EAA+E;AAE/E;;;GAGG;AACH,MAAM,OAAO,YAAa,SAAQ,KAAK;IACrB,QAAQ,CAAU;IAClB,IAAI,CAAU;IACd,MAAM,CAAU;IAEhC,YACE,OAAe,EACf,OAIC;QAED,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,OAAO,EAAE,QAAQ,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,OAAO,EAAE,IAAI,CAAC;QAC1B,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,MAAM,CAAC;IAChC,CAAC;CACF"}

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "leangraph",
+  "version": "1.0.0",
+  "description": "SQLite-based graph database with Cypher query support",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "leangraph": "dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "prepare": "[ -d .git ] && cp hooks/pre-commit .git/hooks/ && chmod +x .git/hooks/pre-commit || true",
+    "build": "tsc",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "dev": "tsx watch src/server.ts",
+    "tck": "node --import tsx test/tck/run-test.ts",
+    "tck:failing": "node --import tsx test/tck/list-failing-tests.ts",
+    "tck:check-fixed": "TCK_TEST_ALL=1 npm test 2>&1 | grep -A 50 'from FAILING_TESTS that now PASS'",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "@hono/node-server": "^1.13.0",
+    "better-sqlite3": "^11.0.0",
+    "commander": "^12.0.0",
+    "hono": "^4.0.0"
+  },
+  "devDependencies": {
+    "@types/better-sqlite3": "^7.6.0",
+    "@types/node": "^22.0.0",
+    "@vitest/coverage-v8": "^4.0.16",
+    "tsx": "^4.0.0",
+    "typescript": "^5.3.0",
+    "vitest": "^4.0.16"
+  },
+  "keywords": [
+    "leangraph",
+    "graph",
+    "database",
+    "graphdb",
+    "cypher",
+    "opencypher",
+    "sqlite",
+    "typescript",
+    "neo4j",
+    "query"
+  ],
+  "author": "Conrad Lelubre",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/co-l/leangraph.git"
+  },
+  "homepage": "https://leangraph.io",
+  "bugs": {
+    "url": "https://github.com/co-l/leangraph/issues"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}