@neo4j-cypher/query-tools 2.0.0-next.38 → 2.0.0-next.39

package/dist/types/vitest.config.d.mts

@@ -1,2 +1,2 @@
-declare const _default: import("vite").UserConfig;
+declare const _default: import("vitest/config").UserWorkspaceConfig;
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neo4j-cypher/query-tools",
-  "version": "2.0.0-next.38",
+  "version": "2.0.0-next.39",
   "description": "",
   "bugs": {
     "url": "https://github.com/neo4j/cypher-language-support/issues"
@@ -26,7 +26,7 @@
   "dependencies": {
     "ajv": "^8.12.0",
     "neo4j-driver": "6.0.1",
-    "@neo4j-cypher/language-support": "2.0.0-next.38"
+    "@neo4j-cypher/language-support": "2.0.0-next.39"
   },
   "devDependencies": {
     "@testcontainers/neo4j": "^11.5.1"
@@ -39,9 +39,10 @@
     "build-esm": "tsc --outDir dist/esm",
     "build-commonjs": "esbuild ./src/index.ts --bundle --format=cjs --sourcemap --packages=external --outfile=dist/cjs/index.cjs",
     "build-types": "tsc --emitDeclarationOnly --outDir dist/types",
+    "check-api-report": "tsx checkApiReport.ts",
+    "gen-api-report": "pnpm build-types && pnpm check-api-report",
     "dev": "concurrently 'npm:build-esm -- --watch' 'npm:build-commonjs -- --watch'",
     "clean": "rm -rf dist tsconfig*.tsbuildinfo",
-    "test": "vitest run extract-unique-nodes-and-relationships",
-    "test:polling": "vitest run pollingIntegrationTests"
+    "test": "vitest run"
   }
 }

package/src/cypher-execution/extract-unique-nodes-and-relationships.test.ts

@@ -1,4 +1,4 @@
-import type { Record } from 'neo4j-driver';
+import type { Record as Neo4jRecord } from 'neo4j-driver';
 import { Node, Path, PathSegment, Relationship } from 'neo4j-driver';
 
 import { describe, expect, test } from 'vitest';
@@ -39,7 +39,7 @@ describe('extractNodesAndRels', () => {
     const boltRecord = {
       keys: ['p'],
       get: () => path,
-    } as unknown as Record;
+    } as unknown as Neo4jRecord;
 
     const { nodes, relationships } = extractUniqueNodesAndRels([boltRecord]);
 
@@ -106,7 +106,7 @@ describe('extractNodesAndRels', () => {
     const boltRecord = {
       keys: ['n'],
       get: () => [node1, node2, relationship],
-    } as unknown as Record;
+    } as unknown as Neo4jRecord;
 
     const { nodes, relationships, limitHit } = extractUniqueNodesAndRels([
       boltRecord,
@@ -149,7 +149,7 @@ describe('extractNodesAndRels', () => {
     const boltRecord = {
       keys: ['p'],
       get: () => path,
-    } as unknown as Record;
+    } as unknown as Neo4jRecord;
 
     const { nodes, relationships, limitHit } = extractUniqueNodesAndRels(
       [boltRecord],
@@ -202,7 +202,7 @@ describe('extractNodesAndRels', () => {
     const boltRecord = {
       keys: ['p'],
       get: () => path,
-    } as unknown as Record;
+    } as unknown as Neo4jRecord;
 
     const { nodes, relationships, limitHit } = extractUniqueNodesAndRels(
       [boltRecord],

package/src/cypher-execution/extract-unique-nodes-and-relationships.ts

@@ -32,9 +32,8 @@ export type DeduplicatedNodesAndRels = {
  * nested objects.
  *
  * @param records - Array of Neo4j records to process
- * @param options - Configuration options for extraction
- * @param options.nodeLimit - Maximum number of unique nodes to extract (optional)
- * @param options.keepDanglingRels - Whether to keep relationships whose start/end nodes are missing (default: false)
+ * @param nodeLimit - Configuration option: Maximum number of unique nodes to extract (optional)
+ * @param keepDanglingRels - Configuration option:  Whether to keep relationships whose start/end nodes are missing (default: false)
  *
  * @returns The {@link DeduplicatedNodesAndRels} containing unique nodes and relationships
  */

package/src/cypher-execution/query-result.ts

@@ -1,3 +1,4 @@
+// oxlint-disable typescript/no-explicit-any
 import type { QueryResult, Record as Neo4jRecord } from 'neo4j-driver';
 import { int, isInt, isVector, types, Vector } from 'neo4j-driver';
 

package/src/data-transforms/cypher-type-names.ts

@@ -22,7 +22,7 @@ import {
   isInt8Array,
 } from '../types/cypher-data-types.js';
 
-type CypherPropertyName =
+export type CypherPropertyName =
   | 'Float'
   | 'null'
   | 'String'

package/src/index.ts

@@ -7,7 +7,10 @@ export {
   getCypherTypeName,
   getPropertyTypeDisplayName,
 } from './data-transforms/cypher-type-names.js';
-export type { CypherDataTypeName } from './data-transforms/cypher-type-names.js';
+export type {
+  CypherDataTypeName,
+  CypherPropertyName,
+} from './data-transforms/cypher-type-names.js';
 export * from './data-transforms/record-to-string.js';
 export * from './types/cypher-data-types.js';
 export type {
@@ -18,10 +21,21 @@ export type {
 export type {
   Neo4jConnection,
   QueryResultWithLimit,
+  RunCypherQueryArgs,
+  SdkQueryArgs,
 } from './neo4jConnection.js';
-export type { Database } from './queries/databases.js';
-export { graphResultTransformer } from './result-transformers/graph-result-transformer.js';
+export type { Database, DatabaseStatus } from './queries/databases.js';
+export {
+  graphResultTransformer,
+  GraphResult,
+} from './result-transformers/graph-result-transformer.js';
 export { Neo4jSchemaPoller } from './schemaPoller.js';
 export type { ConnnectionResult } from './schemaPoller.js';
 export type { CypherDataType } from './types/cypher-data-types.js';
 export { getVersion } from './queries/version.js';
+export {
+  ExecuteQueryArgs,
+  QueryType,
+  ExtendedQueryConfig,
+  Result,
+} from './types/sdkTypes.js';

package/src/neo4jConnection.ts

@@ -33,12 +33,12 @@ function resolveInitialDatabase(
   return home?.name ?? def?.name ?? system?.name ?? databases[0]?.name;
 }
 
-type SdkQueryArgs = {
+export type SdkQueryArgs = {
   queryType: QueryType;
   abortSignal?: AbortSignal;
 };
 
-type RunCypherQueryArgs = {
+export type RunCypherQueryArgs = {
   query: string;
   parameters: Record<string, unknown>;
   database?: string;
@@ -77,6 +77,7 @@ export class Neo4jConnection {
     } else {
       result = tx.run(query, parameters);
     }
+    // oxlint-disable-next-line typescript/no-explicit-any
     const records: Array<any> = [];
     let recordLimitHit = false;
 

package/src/queries/databases.ts

@@ -3,7 +3,7 @@ import { resultTransformers } from 'neo4j-driver';
 import type { ExecuteQueryArgs } from '../types/sdkTypes.js';
 import { DbType } from '../types/sdkTypes.js';
 
-type DatabaseStatus =
+export type DatabaseStatus =
   | 'online'
   | 'offline'
   | 'starting'

package/src/result-transformers/graph-result-transformer.ts

@@ -1,4 +1,8 @@
-import type { Integer, Record, ResultSummary } from 'neo4j-driver';
+import type {
+  Integer,
+  Record as Neo4jRecord,
+  ResultSummary,
+} from 'neo4j-driver';
 import { resultTransformers } from 'neo4j-driver';
 
 import type { DeduplicatedNodesAndRels } from '../cypher-execution/extract-unique-nodes-and-relationships.js';
@@ -10,9 +14,9 @@ import { extractUniqueNodesAndRels } from '../cypher-execution/extract-unique-no
  *
  * See {@link DeduplicatedNodesAndRels} for the type of the nodes and relationships.
  */
-type GraphResult = DeduplicatedNodesAndRels & {
+export type GraphResult = DeduplicatedNodesAndRels & {
   /** Original Neo4j records returned by the query */
-  records: Record[];
+  records: Neo4jRecord[];
   summary: ResultSummary<Integer>;
 };
 

package/src/{integration-tests → tests/integration}/pollingIntegrationTests.test.ts

@@ -2,11 +2,11 @@ import type { Driver, Session } from 'neo4j-driver';
 import { auth, driver } from 'neo4j-driver';
 import { createAndStartTestContainer } from './setupTestContainer.js';
 import type { StartedNeo4jContainer } from '@testcontainers/neo4j';
-import type { GraphSchema } from '../queries/graphSchema.js';
+import type { GraphSchema } from '../../queries/graphSchema.js';
 import {
   extractRelationshipsWithNamedNodes,
   validateGraphSchema,
-} from '../queries/graphSchema.js';
+} from '../../queries/graphSchema.js';
 
 describe('Polling integration', () => {
   let session: Session;

package/src/types/cypher-data-types.ts

@@ -23,7 +23,7 @@ import {
   isTime,
   isVector,
 } from 'neo4j-driver';
-type NumberOrInteger = number | Integer | bigint;
+export type NumberOrInteger = number | Integer | bigint;
 
 /**
       The neo4j driver type mapping - https://neo4j.com/docs/javascript-manual/current/cypher-workflow/#js-driver-type-mapping

package/src/types/sdkTypes.ts

@@ -18,10 +18,10 @@ export type QueryType =
   // Query that has been derived from the user input.
   | 'user-transpiled';
 
-type ExtendedQueryConfig<T> = QueryConfig<T> &
+export type ExtendedQueryConfig<T> = QueryConfig<T> &
   Required<Pick<QueryConfig<T>, 'routing' | 'resultTransformer'>>;
 
-type Result<T> = T & { summary: ResultSummary };
+export type Result<T> = T & { summary: ResultSummary };
 
 export type ExecuteQueryArgs<T> = {
   query: string;

package/vitest.config.mts

@@ -1,9 +1,25 @@
-import { defineConfig } from 'vitest/config';
+import { defineProject } from 'vitest/config';
 
-export default defineConfig({
+export default defineProject({
   test: {
     globals: true,
-    hookTimeout: 90000,
-    include: ['src/**/*.{test,spec}.?(c|m)[jt]s?(x)'],
+    projects: [
+      {
+        extends: true,
+        test: {
+          name: 'unit',
+          include: ['src/**/*.test.ts'],
+          exclude: ['src/tests/integration/**'],
+        },
+      },
+      {
+        extends: true,
+        test: {
+          name: 'integration',
+          include: ['src/tests/integration/**/*.test.ts'],
+          hookTimeout: 90000,
+        },
+      },
+    ],
   },
 });

package/dist/esm/src/integration-tests/pollingIntegrationTests.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"pollingIntegrationTests.test.js","sourceRoot":"","sources":["../../../../src/integration-tests/pollingIntegrationTests.test.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AAGtE,OAAO,EACL,kCAAkC,EAClC,mBAAmB,GACpB,MAAM,2BAA2B,CAAC;AAEnC,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACnC,IAAI,OAAgB,CAAC;IACrB,IAAI,aAAoC,CAAC;IACzC,IAAI,UAAkB,CAAC;IACvB,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,aAAa,GAAG,MAAM,2BAA2B,EAAE,CAAC;QACpD,MAAM,aAAa,GAAG,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;QACnE,UAAU,GAAG,MAAM,CACjB,qBAAqB,aAAa,EAAE,EACpC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,CAAC,CAChC,CAAC;QACF,OAAO,GAAG,UAAU,CAAC,OAAO,EAAE,CAAC;QAC/B,MAAM,WAAW,GACf,6FAA6F,CAAC;QAChG,MAAM,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,KAAK,IAAI,EAAE;QAClB,MAAM,OAAO,CAAC,KAAK,EAAE,CAAC;QACtB,MAAM,UAAU,CAAC,KAAK,EAAE,CAAC;QACzB,MAAM,aAAa,CAAC,IAAI,EAAE,CAAC;IAC7B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QAC3E,MAAM,KAAK,GAAG,wCAAwC,CAAC;QACvD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACxC,mBAAmB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QACnD,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;QACtF,MAAM,KAAK,GAAG,wCAAwC,CAAC;QACvD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACxC,MAAM,YAAY,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAE,CAAC,QAAQ,EAAE,CAAkB,CAAC;QACtE,mBAAmB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;QACrC,MAAM,WAAW,GAAG,kCAAkC,CAAC,YAAY,CAAC,CAAC;QACrE,MAAM,CAAC,WAAW,CAAC,CAAC,cAAc,CAAC;YACjC,IAAI,EAAE,SAAS;YACf,EAAE,EAAE,OAAO;YACX,OAAO,EAAE,YAAY;SACtB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/esm/src/integration-tests/setupTestContainer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"setupTestContainer.js","sourceRoot":"","sources":["../../../../src/integration-tests/setupTestContainer.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAQvD,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAC/C,OAAsB;IACpB,aAAa,EAAE,2BAA2B;IAC1C,YAAY,EAAE,oBAAoB;CACnC;IAED,MAAM,QAAQ,GAAG,UAAU,CAAC;IAC5B,MAAM,GAAG,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE,8BAA8B,EAAE,KAAK,EAAE,CAAC;IAEnE,MAAM,SAAS,GAAG,MAAM,IAAI,cAAc,CAAC,IAAI,CAAC,YAAY,CAAC;SAC1D,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC;SAC5B,QAAQ,EAAE;SACV,YAAY,CAAC,QAAQ,CAAC;SACtB,eAAe,CAAC,GAAG,CAAC;QACrB,4DAA4D;QAC5D,sDAAsD;QACtD,gDAAgD;SAC/C,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC;SAC5B,KAAK,EAAE,CAAC;IAEX,OAAO,SAAS,CAAC;AACnB,CAAC"}