grafeo-ogm 1.0.0

package/dist/esm/testing/neo4j-record-factory.js

@@ -0,0 +1,36 @@
+import neo4j from 'neo4j-driver';
+/**
+ * Factory for creating mock Neo4j Record objects for testing.
+ */
+export class Neo4jRecordFactory {
+    /**
+     * Create a Neo4j Record from a plain object.
+     * @param data - Object with keys as field names and values as properties
+     * @returns A Neo4j Record instance with get(), toObject(), and keys
+     */
+    static create(data) {
+        const keys = Object.keys(data);
+        const values = keys.map((k) => data[k]);
+        return new neo4j.types.Record(keys, values);
+    }
+    /**
+     * Create a Neo4j Integer value.
+     */
+    static integer(value) {
+        return neo4j.int(value);
+    }
+    /**
+     * Create a Neo4j DateTime value from an ISO string.
+     */
+    static dateTime(isoString) {
+        const d = new Date(isoString);
+        return new neo4j.types.DateTime(d.getUTCFullYear(), d.getUTCMonth() + 1, d.getUTCDate(), d.getUTCHours(), d.getUTCMinutes(), d.getUTCSeconds(), d.getUTCMilliseconds() * 1000000, 0);
+    }
+    /**
+     * Create a mock Neo4j Node.
+     */
+    static node(labels, properties) {
+        return new neo4j.types.Node(neo4j.int(0), labels, properties);
+    }
+}
+//# sourceMappingURL=neo4j-record-factory.js.map

package/dist/esm/testing/neo4j-record-factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"neo4j-record-factory.js","sourceRoot":"","sources":["../../../src/testing/neo4j-record-factory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAyC,MAAM,cAAc,CAAC;AAErE;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAC7B;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,IAA6B;QACzC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACxC,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAA2B,CAAC;IACxE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,OAAO,CAAC,KAAa;QAC1B,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,SAAiB;QAC/B,MAAM,CAAC,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC;QAC9B,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,QAAQ,CAC7B,CAAC,CAAC,cAAc,EAAE,EAClB,CAAC,CAAC,WAAW,EAAE,GAAG,CAAC,EACnB,CAAC,CAAC,UAAU,EAAE,EACd,CAAC,CAAC,WAAW,EAAE,EACf,CAAC,CAAC,aAAa,EAAE,EACjB,CAAC,CAAC,aAAa,EAAE,EACjB,CAAC,CAAC,kBAAkB,EAAE,GAAG,OAAS,EAClC,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAI,CAAC,MAAgB,EAAE,UAAmC;QAC/D,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;IAChE,CAAC;CACF"}

package/dist/esm/testing/selection-set-factory.d.ts

@@ -0,0 +1,24 @@
+type FieldSpec = string | Record<string, FieldSpec[]>;
+/**
+ * Convenience factory for building GraphQL selection sets in tests.
+ */
+export declare class SelectionSetFactory {
+    /**
+     * Build a GraphQL selection set string from a simplified spec.
+     *
+     * @example
+     *   SelectionSetFactory.gql(['id', 'name', { drugs: ['id', 'drugName'] }])
+     *   // => '{ id name drugs { id drugName } }'
+     */
+    static gql(fields: FieldSpec[]): string;
+    /**
+     * Build a select object from a simplified spec.
+     *
+     * @example
+     *   SelectionSetFactory.select(['id', 'name', { drugs: ['id', 'drugName'] }])
+     *   // => { id: true, name: true, drugs: { select: { id: true, drugName: true } } }
+     */
+    static select(fields: FieldSpec[]): Record<string, unknown>;
+}
+export {};
+//# sourceMappingURL=selection-set-factory.d.ts.map

package/dist/esm/testing/selection-set-factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"selection-set-factory.d.ts","sourceRoot":"","sources":["../../../src/testing/selection-set-factory.ts"],"names":[],"mappings":"AAAA,KAAK,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;AAEtD;;GAEG;AACH,qBAAa,mBAAmB;IAC9B;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM;IAYvC;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAW5D"}

package/dist/esm/testing/selection-set-factory.js

@@ -0,0 +1,40 @@
+/**
+ * Convenience factory for building GraphQL selection sets in tests.
+ */
+export class SelectionSetFactory {
+    /**
+     * Build a GraphQL selection set string from a simplified spec.
+     *
+     * @example
+     *   SelectionSetFactory.gql(['id', 'name', { drugs: ['id', 'drugName'] }])
+     *   // => '{ id name drugs { id drugName } }'
+     */
+    static gql(fields) {
+        const parts = [];
+        for (const field of fields)
+            if (typeof field === 'string')
+                parts.push(field);
+            else
+                for (const [key, nested] of Object.entries(field))
+                    parts.push(`${key} ${SelectionSetFactory.gql(nested)}`);
+        return `{ ${parts.join(' ')} }`;
+    }
+    /**
+     * Build a select object from a simplified spec.
+     *
+     * @example
+     *   SelectionSetFactory.select(['id', 'name', { drugs: ['id', 'drugName'] }])
+     *   // => { id: true, name: true, drugs: { select: { id: true, drugName: true } } }
+     */
+    static select(fields) {
+        const result = {};
+        for (const field of fields)
+            if (typeof field === 'string')
+                result[field] = true;
+            else
+                for (const [key, nested] of Object.entries(field))
+                    result[key] = { select: SelectionSetFactory.select(nested) };
+        return result;
+    }
+}
+//# sourceMappingURL=selection-set-factory.js.map

package/dist/esm/testing/selection-set-factory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"selection-set-factory.js","sourceRoot":"","sources":["../../../src/testing/selection-set-factory.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAC9B;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,CAAC,MAAmB;QAC5B,MAAM,KAAK,GAAa,EAAE,CAAC;QAE3B,KAAK,MAAM,KAAK,IAAI,MAAM;YACxB,IAAI,OAAO,KAAK,KAAK,QAAQ;gBAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;;gBAE/C,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;oBAC/C,KAAK,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,mBAAmB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAE9D,OAAO,KAAK,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;IAClC,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,CAAC,MAAmB;QAC/B,MAAM,MAAM,GAA4B,EAAE,CAAC;QAE3C,KAAK,MAAM,KAAK,IAAI,MAAM;YACxB,IAAI,OAAO,KAAK,KAAK,QAAQ;gBAAE,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;;gBAElD,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;oBAC/C,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,mBAAmB,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QAEnE,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/dist/esm/utils/lucene.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Escapes special Lucene characters in a query string.
+ * Special characters: + - && || ! ( ) { } [ ] ^ " ~ * ? : \ /
+ *
+ * Handles multi-character operators (&&, ||) as atomic units,
+ * then escapes remaining individual special characters.
+ */
+export declare function sanitizeLuceneQuery(query: string): string;
+//# sourceMappingURL=lucene.d.ts.map

package/dist/esm/utils/lucene.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lucene.d.ts","sourceRoot":"","sources":["../../../src/utils/lucene.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAgBzD"}

package/dist/esm/utils/lucene.js

@@ -0,0 +1,22 @@
+/**
+ * Escapes special Lucene characters in a query string.
+ * Special characters: + - && || ! ( ) { } [ ] ^ " ~ * ? : \ /
+ *
+ * Handles multi-character operators (&&, ||) as atomic units,
+ * then escapes remaining individual special characters.
+ */
+export function sanitizeLuceneQuery(query) {
+    // First pass: escape multi-char operators as atomic units
+    // Use placeholders to prevent double-escaping by the second pass
+    let result = query
+        .replace(/&&/g, '\u0000AND\u0000')
+        .replace(/\|\|/g, '\u0000OR\u0000');
+    // Second pass: escape individual special characters (& and | individually)
+    result = result.replace(/([+\-&|!(){}[\]^"~*?:\\/])/g, '\\$1');
+    // Restore multi-char operators with proper escaping
+    result = result
+        .replace(/\u0000AND\u0000/g, '\\&\\&')
+        .replace(/\u0000OR\u0000/g, '\\|\\|');
+    return result;
+}
+//# sourceMappingURL=lucene.js.map

package/dist/esm/utils/lucene.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lucene.js","sourceRoot":"","sources":["../../../src/utils/lucene.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAAa;IAC/C,0DAA0D;IAC1D,iEAAiE;IACjE,IAAI,MAAM,GAAG,KAAK;SACf,OAAO,CAAC,KAAK,EAAE,iBAAiB,CAAC;SACjC,OAAO,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;IAEtC,2EAA2E;IAC3E,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;IAE/D,oDAAoD;IACpD,MAAM,GAAG,MAAM;SACZ,OAAO,CAAC,kBAAkB,EAAE,QAAQ,CAAC;SACrC,OAAO,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAC;IAExC,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/esm/utils/validation.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Assert that a key is not a prototype pollution vector.
+ */
+export declare function assertSafeKey(key: string, context: string): void;
+/**
+ * Validate that a string is a safe Cypher identifier.
+ * Throws if the identifier contains characters that could enable Cypher injection.
+ */
+export declare function assertSafeIdentifier(value: string, context: string): void;
+/**
+ * Escape an identifier for safe interpolation into Cypher queries.
+ * Wraps in backticks and doubles any existing backticks inside.
+ * This handles Cypher reserved words (ORDER, MATCH, SET, CALL, etc.)
+ * since backtick-quoted identifiers bypass keyword interpretation.
+ */
+export declare function escapeIdentifier(identifier: string): string;
+/**
+ * Validate a label name is a safe identifier and return it backtick-escaped.
+ */
+export declare function assertSafeLabel(label: string): string;
+/**
+ * Validate sort direction is strictly ASC or DESC.
+ */
+export declare function assertSortDirection(direction: string): 'ASC' | 'DESC';
+//# sourceMappingURL=validation.d.ts.map

package/dist/esm/utils/validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../../src/utils/validation.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAKhE;AAKD;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAKzE;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAG3D;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAGrD;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,CAMrE"}

package/dist/esm/utils/validation.js

@@ -0,0 +1,46 @@
+import { OGMError } from '../errors';
+/** Dangerous property names that could indicate prototype pollution */
+const BLOCKED_KEYS = new Set(['__proto__', 'constructor', 'prototype']);
+/**
+ * Assert that a key is not a prototype pollution vector.
+ */
+export function assertSafeKey(key, context) {
+    if (BLOCKED_KEYS.has(key))
+        throw new OGMError(`Potentially dangerous key "${key}" in ${context}. This key is not allowed.`);
+}
+/** Regex for valid Cypher identifiers */
+const SAFE_IDENTIFIER = /^[a-zA-Z_][a-zA-Z0-9_]*$/;
+/**
+ * Validate that a string is a safe Cypher identifier.
+ * Throws if the identifier contains characters that could enable Cypher injection.
+ */
+export function assertSafeIdentifier(value, context) {
+    if (!SAFE_IDENTIFIER.test(value))
+        throw new OGMError(`Invalid identifier "${value}" in ${context}. Identifiers must match /^[a-zA-Z_][a-zA-Z0-9_]*$/.`);
+}
+/**
+ * Escape an identifier for safe interpolation into Cypher queries.
+ * Wraps in backticks and doubles any existing backticks inside.
+ * This handles Cypher reserved words (ORDER, MATCH, SET, CALL, etc.)
+ * since backtick-quoted identifiers bypass keyword interpretation.
+ */
+export function escapeIdentifier(identifier) {
+    const sanitized = identifier.replace(/`/g, '``');
+    return `\`${sanitized}\``;
+}
+/**
+ * Validate a label name is a safe identifier and return it backtick-escaped.
+ */
+export function assertSafeLabel(label) {
+    assertSafeIdentifier(label, 'label');
+    return escapeIdentifier(label);
+}
+/**
+ * Validate sort direction is strictly ASC or DESC.
+ */
+export function assertSortDirection(direction) {
+    if (direction !== 'ASC' && direction !== 'DESC')
+        throw new OGMError(`Invalid sort direction "${direction}". Must be "ASC" or "DESC".`);
+    return direction;
+}
+//# sourceMappingURL=validation.js.map

package/dist/esm/utils/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../../src/utils/validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAErC,uEAAuE;AACvE,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC,CAAC;AAExE;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,GAAW,EAAE,OAAe;IACxD,IAAI,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC;QACvB,MAAM,IAAI,QAAQ,CAChB,8BAA8B,GAAG,QAAQ,OAAO,4BAA4B,CAC7E,CAAC;AACN,CAAC;AAED,yCAAyC;AACzC,MAAM,eAAe,GAAG,0BAA0B,CAAC;AAEnD;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAa,EAAE,OAAe;IACjE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC;QAC9B,MAAM,IAAI,QAAQ,CAChB,uBAAuB,KAAK,QAAQ,OAAO,sDAAsD,CAClG,CAAC;AACN,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,UAAkB;IACjD,MAAM,SAAS,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACjD,OAAO,KAAK,SAAS,IAAI,CAAC;AAC5B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,KAAa;IAC3C,oBAAoB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACrC,OAAO,gBAAgB,CAAC,KAAK,CAAC,CAAC;AACjC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,SAAiB;IACnD,IAAI,SAAS,KAAK,KAAK,IAAI,SAAS,KAAK,MAAM;QAC7C,MAAM,IAAI,QAAQ,CAChB,2BAA2B,SAAS,6BAA6B,CAClE,CAAC;IACJ,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "grafeo-ogm",
+  "version": "1.0.0",
+  "description": "Type-safe Object-Graph Mapper for Neo4j with GraphQL SDL schema support",
+  "license": "MIT",
+  "author": "Alejandro Guzman",
+  "keywords": [
+    "neo4j",
+    "ogm",
+    "cypher",
+    "graphql",
+    "graph-database",
+    "typescript",
+    "object-graph-mapper"
+  ],
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/cjs/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
+    },
+    "./testing": {
+      "import": {
+        "types": "./dist/esm/testing/index.d.ts",
+        "default": "./dist/esm/testing/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/testing/index.d.ts",
+        "default": "./dist/cjs/testing/index.js"
+      }
+    }
+  },
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "pnpm run clean && tsc -p tsconfig.cjs.json && tsc -p tsconfig.esm.json && node -e \"const fs=require('fs');fs.writeFileSync('dist/cjs/package.json','{\\\"type\\\":\\\"commonjs\\\"}\\n');fs.writeFileSync('dist/esm/package.json','{\\\"type\\\":\\\"module\\\"}\\n');\"",
+    "test": "jest",
+    "lint": "eslint src/",
+    "lint:fix": "eslint src/ --fix",
+    "format": "prettier --write \"src/**/*.ts\" \"tests/**/*.ts\"",
+    "format:check": "prettier --check \"src/**/*.ts\" \"tests/**/*.ts\"",
+    "prepublishOnly": "pnpm run build"
+  },
+  "dependencies": {
+    "graphql": "^16.0.0",
+    "pluralize": "^8.0.0"
+  },
+  "peerDependencies": {
+    "neo4j-driver": "^5.0.0"
+  },
+  "devDependencies": {
+    "@eslint/eslintrc": "^3.3.3",
+    "@eslint/js": "^9.39.2",
+    "@types/jest": "^29.0.0",
+    "@types/node": "^24.10.13",
+    "@types/pluralize": "^0.0.33",
+    "@typescript-eslint/eslint-plugin": "^8.56.0",
+    "@typescript-eslint/parser": "^8.56.0",
+    "eslint": "^9.39.2",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.5",
+    "globals": "^16.5.0",
+    "jest": "^29.0.0",
+    "prettier": "^3.8.1",
+    "ts-jest": "^29.0.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.0.0"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/aleguzman/grafeo-ogm.git"
+  }
+}