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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (162) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/dist/cjs/index.cjs +1848 -0
  3. package/dist/cjs/index.cjs.map +7 -0
  4. package/dist/esm/package.json +9 -8
  5. package/dist/esm/src/connectionErrorHandler.d.ts +1 -2
  6. package/dist/esm/src/connectionErrorHandler.js +1 -1
  7. package/dist/esm/src/connectionErrorHandler.js.map +1 -1
  8. package/dist/esm/src/cypher-execution/extract-unique-nodes-and-relationships.d.ts +1 -1
  9. package/dist/esm/src/cypher-execution/extract-unique-nodes-and-relationships.test.js +0 -4
  10. package/dist/esm/src/cypher-execution/extract-unique-nodes-and-relationships.test.js.map +1 -1
  11. package/dist/esm/src/cypher-execution/query-result.js +2 -9
  12. package/dist/esm/src/cypher-execution/query-result.js.map +1 -1
  13. package/dist/esm/src/data-transforms/record-to-string.js +1 -2
  14. package/dist/esm/src/data-transforms/record-to-string.js.map +1 -1
  15. package/dist/esm/src/integration-tests/pollingIntegrationTests.test.js.map +1 -1
  16. package/dist/esm/src/integration-tests/setupTestContainer.d.ts +1 -1
  17. package/dist/esm/src/integration-tests/setupTestContainer.js +1 -1
  18. package/dist/esm/src/integration-tests/setupTestContainer.js.map +1 -1
  19. package/dist/esm/src/metadataPoller.d.ts +4 -4
  20. package/dist/esm/src/metadataPoller.js +1 -1
  21. package/dist/esm/src/metadataPoller.js.map +1 -1
  22. package/dist/esm/src/neo4jConnection.d.ts +4 -4
  23. package/dist/esm/src/neo4jConnection.js +2 -2
  24. package/dist/esm/src/neo4jConnection.js.map +1 -1
  25. package/dist/esm/src/queries/dataSummary.d.ts +1 -1
  26. package/dist/esm/src/queries/dataSummary.js.map +1 -1
  27. package/dist/esm/src/queries/databases.d.ts +3 -13
  28. package/dist/esm/src/queries/databases.js +2 -5
  29. package/dist/esm/src/queries/databases.js.map +1 -1
  30. package/dist/esm/src/queries/functions.d.ts +1 -3
  31. package/dist/esm/src/queries/functions.js +2 -3
  32. package/dist/esm/src/queries/functions.js.map +1 -1
  33. package/dist/esm/src/queries/graphSchema.d.ts +2 -2
  34. package/dist/esm/src/queries/graphSchema.js +1 -1
  35. package/dist/esm/src/queries/graphSchema.js.map +1 -1
  36. package/dist/esm/src/queries/procedures.d.ts +1 -3
  37. package/dist/esm/src/queries/procedures.js +2 -3
  38. package/dist/esm/src/queries/procedures.js.map +1 -1
  39. package/dist/esm/src/queries/version.d.ts +1 -1
  40. package/dist/esm/src/result-transformers/graph-result-transformer.d.ts +4 -3
  41. package/dist/esm/src/result-transformers/graph-result-transformer.js +2 -2
  42. package/dist/esm/src/result-transformers/graph-result-transformer.js.map +1 -1
  43. package/dist/esm/src/schemaPoller.d.ts +3 -3
  44. package/dist/esm/src/schemaPoller.js.map +1 -1
  45. package/dist/esm/src/types/sdkTypes.d.ts +1 -6
  46. package/dist/esm/tsconfig.tsbuildinfo +1 -1
  47. package/dist/types/src/connectionErrorHandler.d.ts +1 -2
  48. package/dist/types/src/cypher-execution/extract-unique-nodes-and-relationships.d.ts +1 -1
  49. package/dist/types/src/integration-tests/setupTestContainer.d.ts +1 -1
  50. package/dist/types/src/metadataPoller.d.ts +4 -4
  51. package/dist/types/src/neo4jConnection.d.ts +4 -4
  52. package/dist/types/src/queries/dataSummary.d.ts +1 -1
  53. package/dist/types/src/queries/databases.d.ts +3 -13
  54. package/dist/types/src/queries/functions.d.ts +1 -3
  55. package/dist/types/src/queries/graphSchema.d.ts +2 -2
  56. package/dist/types/src/queries/procedures.d.ts +1 -3
  57. package/dist/types/src/queries/version.d.ts +1 -1
  58. package/dist/types/src/result-transformers/graph-result-transformer.d.ts +4 -3
  59. package/dist/types/src/schemaPoller.d.ts +3 -3
  60. package/dist/types/src/types/sdkTypes.d.ts +1 -6
  61. package/dist/types/tsconfig.tsbuildinfo +1 -1
  62. package/package.json +10 -9
  63. package/src/connectionErrorHandler.ts +6 -3
  64. package/src/cypher-execution/extract-unique-nodes-and-relationships.test.ts +0 -4
  65. package/src/cypher-execution/extract-unique-nodes-and-relationships.ts +1 -1
  66. package/src/cypher-execution/query-result.ts +1 -13
  67. package/src/data-transforms/record-to-string.ts +2 -3
  68. package/src/integration-tests/pollingIntegrationTests.test.ts +6 -5
  69. package/src/integration-tests/setupTestContainer.ts +3 -2
  70. package/src/metadataPoller.ts +14 -10
  71. package/src/neo4jConnection.ts +6 -6
  72. package/src/queries/dataSummary.ts +4 -4
  73. package/src/queries/databases.ts +5 -7
  74. package/src/queries/functions.ts +7 -4
  75. package/src/queries/graphSchema.ts +8 -7
  76. package/src/queries/procedures.ts +7 -4
  77. package/src/queries/version.ts +1 -1
  78. package/src/result-transformers/graph-result-transformer.ts +5 -11
  79. package/src/schemaPoller.ts +4 -3
  80. package/src/types/sdkTypes.ts +1 -7
  81. package/tsconfig.json +4 -4
  82. package/tsconfig.node.json +1 -2
  83. package/dist/cjs/package.json +0 -46
  84. package/dist/cjs/src/connectionErrorHandler.d.ts +0 -12
  85. package/dist/cjs/src/connectionErrorHandler.js +0 -41
  86. package/dist/cjs/src/connectionErrorHandler.js.map +0 -1
  87. package/dist/cjs/src/cypher-execution/extract-unique-nodes-and-relationships.d.ts +0 -33
  88. package/dist/cjs/src/cypher-execution/extract-unique-nodes-and-relationships.js +0 -93
  89. package/dist/cjs/src/cypher-execution/extract-unique-nodes-and-relationships.js.map +0 -1
  90. package/dist/cjs/src/cypher-execution/extract-unique-nodes-and-relationships.test.d.ts +0 -1
  91. package/dist/cjs/src/cypher-execution/extract-unique-nodes-and-relationships.test.js +0 -129
  92. package/dist/cjs/src/cypher-execution/extract-unique-nodes-and-relationships.test.js.map +0 -1
  93. package/dist/cjs/src/cypher-execution/query-result.d.ts +0 -11
  94. package/dist/cjs/src/cypher-execution/query-result.js +0 -239
  95. package/dist/cjs/src/cypher-execution/query-result.js.map +0 -1
  96. package/dist/cjs/src/data-transforms/clean-type.d.ts +0 -6
  97. package/dist/cjs/src/data-transforms/clean-type.js +0 -16
  98. package/dist/cjs/src/data-transforms/clean-type.js.map +0 -1
  99. package/dist/cjs/src/data-transforms/cypher-type-names.d.ts +0 -6
  100. package/dist/cjs/src/data-transforms/cypher-type-names.js +0 -91
  101. package/dist/cjs/src/data-transforms/cypher-type-names.js.map +0 -1
  102. package/dist/cjs/src/data-transforms/format-float.d.ts +0 -1
  103. package/dist/cjs/src/data-transforms/format-float.js +0 -14
  104. package/dist/cjs/src/data-transforms/format-float.js.map +0 -1
  105. package/dist/cjs/src/data-transforms/record-to-string.d.ts +0 -8
  106. package/dist/cjs/src/data-transforms/record-to-string.js +0 -185
  107. package/dist/cjs/src/data-transforms/record-to-string.js.map +0 -1
  108. package/dist/cjs/src/index.d.ts +0 -17
  109. package/dist/cjs/src/index.js +0 -33
  110. package/dist/cjs/src/index.js.map +0 -1
  111. package/dist/cjs/src/integration-tests/pollingIntegrationTests.test.d.ts +0 -1
  112. package/dist/cjs/src/integration-tests/pollingIntegrationTests.test.js +0 -42
  113. package/dist/cjs/src/integration-tests/pollingIntegrationTests.test.js.map +0 -1
  114. package/dist/cjs/src/integration-tests/setupTestContainer.d.ts +0 -10
  115. package/dist/cjs/src/integration-tests/setupTestContainer.js +0 -23
  116. package/dist/cjs/src/integration-tests/setupTestContainer.js.map +0 -1
  117. package/dist/cjs/src/metadataPoller.d.ts +0 -34
  118. package/dist/cjs/src/metadataPoller.js +0 -214
  119. package/dist/cjs/src/metadataPoller.js.map +0 -1
  120. package/dist/cjs/src/neo4jConnection.d.ts +0 -36
  121. package/dist/cjs/src/neo4jConnection.js +0 -128
  122. package/dist/cjs/src/neo4jConnection.js.map +0 -1
  123. package/dist/cjs/src/queries/dataSummary.d.ts +0 -7
  124. package/dist/cjs/src/queries/dataSummary.js +0 -33
  125. package/dist/cjs/src/queries/dataSummary.js.map +0 -1
  126. package/dist/cjs/src/queries/databases.d.ts +0 -38
  127. package/dist/cjs/src/queries/databases.js +0 -114
  128. package/dist/cjs/src/queries/databases.js.map +0 -1
  129. package/dist/cjs/src/queries/functions.d.ts +0 -16
  130. package/dist/cjs/src/queries/functions.js +0 -88
  131. package/dist/cjs/src/queries/functions.js.map +0 -1
  132. package/dist/cjs/src/queries/graphSchema.d.ts +0 -28
  133. package/dist/cjs/src/queries/graphSchema.js +0 -88
  134. package/dist/cjs/src/queries/graphSchema.js.map +0 -1
  135. package/dist/cjs/src/queries/procedures.d.ts +0 -16
  136. package/dist/cjs/src/queries/procedures.js +0 -106
  137. package/dist/cjs/src/queries/procedures.js.map +0 -1
  138. package/dist/cjs/src/queries/roles.d.ts +0 -11
  139. package/dist/cjs/src/queries/roles.js +0 -24
  140. package/dist/cjs/src/queries/roles.js.map +0 -1
  141. package/dist/cjs/src/queries/users.d.ts +0 -15
  142. package/dist/cjs/src/queries/users.js +0 -24
  143. package/dist/cjs/src/queries/users.js.map +0 -1
  144. package/dist/cjs/src/queries/version.d.ts +0 -7
  145. package/dist/cjs/src/queries/version.js +0 -32
  146. package/dist/cjs/src/queries/version.js.map +0 -1
  147. package/dist/cjs/src/result-transformers/graph-result-transformer.d.ts +0 -36
  148. package/dist/cjs/src/result-transformers/graph-result-transformer.js +0 -37
  149. package/dist/cjs/src/result-transformers/graph-result-transformer.js.map +0 -1
  150. package/dist/cjs/src/schemaPoller.d.ts +0 -45
  151. package/dist/cjs/src/schemaPoller.js +0 -199
  152. package/dist/cjs/src/schemaPoller.js.map +0 -1
  153. package/dist/cjs/src/types/cypher-data-types.d.ts +0 -41
  154. package/dist/cjs/src/types/cypher-data-types.js +0 -47
  155. package/dist/cjs/src/types/cypher-data-types.js.map +0 -1
  156. package/dist/cjs/src/types/sdkTypes.d.ts +0 -23
  157. package/dist/cjs/src/types/sdkTypes.js +0 -11
  158. package/dist/cjs/src/types/sdkTypes.js.map +0 -1
  159. package/dist/cjs/tsconfig.tsbuildinfo +0 -1
  160. package/dist/cjs/vitest.config.d.mts +0 -2
  161. package/dist/cjs/vitest.config.mjs +0 -10
  162. package/dist/cjs/vitest.config.mjs.map +0 -1
@@ -1,5 +1,5 @@
1
- import { Neo4jError } from 'neo4j-driver';
2
1
  export declare const FRIENDLY_ERROR_MESSAGES: {
2
+ Default: string;
3
3
  [key: string]: string;
4
4
  };
5
5
  export type ConnectionError = {
@@ -8,5 +8,4 @@ export type ConnectionError = {
8
8
  code: string;
9
9
  };
10
10
  export declare function isRetriableNeo4jError(error: unknown): boolean;
11
- export declare function isNeo4jError(error: unknown): error is Neo4jError;
12
11
  export declare function getConnectionError(error: unknown): ConnectionError;
@@ -1,5 +1,5 @@
1
1
  import type { Integer, Node, Record, RecordShape, Relationship } from 'neo4j-driver';
2
- import { CypherProperty } from '../types/cypher-data-types.js';
2
+ import type { CypherProperty } from '../types/cypher-data-types.js';
3
3
  export type Properties = RecordShape<string, CypherProperty>;
4
4
  /**
5
5
  * Result type containing deduplicated nodes and relationships extracted from Neo4j records.
@@ -1,4 +1,4 @@
1
- import { StartedNeo4jContainer } from '@testcontainers/neo4j';
1
+ import type { StartedNeo4jContainer } from '@testcontainers/neo4j';
2
2
  type ContainerOpts = {
3
3
  containerName: string;
4
4
  neo4jVersion: string;
@@ -1,7 +1,7 @@
1
- import { DbSchema } from '@neo4j-cypher/language-support';
2
- import { EventEmitter } from 'events';
3
- import { Neo4jConnection } from './neo4jConnection.js';
4
- import { Database } from './queries/databases.js';
1
+ import type { DbSchema } from '@neo4j-cypher/language-support';
2
+ import type { EventEmitter } from 'events';
3
+ import type { Neo4jConnection } from './neo4jConnection.js';
4
+ import type { Database } from './queries/databases.js';
5
5
  export declare abstract class MetadataPoller {
6
6
  dbSchema: DbSchema;
7
7
  abstract stopBackgroundPolling(): void;
@@ -1,6 +1,6 @@
1
- import { Driver, ManagedTransaction, QueryResult, RecordShape, Session } from 'neo4j-driver';
2
- import { Database } from './queries/databases.js';
3
- import { ExecuteQueryArgs, QueryType } from './types/sdkTypes.js';
1
+ import type { Driver, ManagedTransaction, QueryResult, Session } from 'neo4j-driver';
2
+ import type { Database } from './queries/databases.js';
3
+ import type { ExecuteQueryArgs, QueryType } from './types/sdkTypes.js';
4
4
  type SdkQueryArgs = {
5
5
  queryType: QueryType;
6
6
  abortSignal?: AbortSignal;
@@ -24,7 +24,7 @@ export declare class Neo4jConnection {
24
24
  serverVersion: string | undefined;
25
25
  constructor(connectedUser: string, protocolVersion: string, databases: Database[], driver: Driver, database?: string);
26
26
  evalQuery(session: Session, query: string, parameters: Record<string, unknown>, metadata: object, tx?: ManagedTransaction): Promise<{
27
- records: import("neo4j-driver").Record<RecordShape, PropertyKey, RecordShape<PropertyKey, number>>[];
27
+ records: any[];
28
28
  summary: import("neo4j-driver").ResultSummary<import("neo4j-driver").Integer>;
29
29
  recordLimitHit: boolean;
30
30
  }>;
@@ -1,4 +1,4 @@
1
- import { ExecuteQueryArgs } from '../types/sdkTypes.js';
1
+ import type { ExecuteQueryArgs } from '../types/sdkTypes.js';
2
2
  export type DataSummary = {
3
3
  labels: string[];
4
4
  relationshipTypes: string[];
@@ -1,6 +1,6 @@
1
1
  import type { CypherVersion } from '@neo4j-cypher/language-support';
2
- import { ExecuteQueryArgs } from '../types/sdkTypes.js';
3
- export type DatabaseStatus = 'online' | 'offline' | 'starting' | 'stopping' | 'store copying' | 'initial' | 'dirty' | 'quarantined' | 'unknown' | 'dropped' | 'deallocating';
2
+ import type { ExecuteQueryArgs } from '../types/sdkTypes.js';
3
+ type DatabaseStatus = 'online' | 'offline' | 'starting' | 'stopping' | 'store copying' | 'initial' | 'dirty' | 'quarantined' | 'unknown' | 'dropped' | 'deallocating';
4
4
  export type Database = {
5
5
  name: string;
6
6
  address: string;
@@ -25,14 +25,4 @@ export type Database = {
25
25
  export declare function listDatabases(): ExecuteQueryArgs<{
26
26
  databases: Database[];
27
27
  }>;
28
- /**
29
- * In clustered environments a single logical database can be backed by multiple physical database instances
30
- * running on a different servers.
31
- * This function returns a record of logical databases.
32
- * A database instance is uniquely identified by its name and address.
33
- * A logical database is uniquely identified by its name.
34
- * @input instances - a record of database instances
35
- * @output a record of logical databases
36
- */
37
- export declare function getLogicalDatabases(instances: Record<string, Database>): Record<string, Database>;
38
- export declare function sortDatabases(databases: Database[]): Database[];
28
+ export {};
@@ -1,11 +1,9 @@
1
- import { CypherVersion, Neo4jFunction } from '@neo4j-cypher/language-support';
2
- import { JSONSchemaType } from 'ajv';
1
+ import type { CypherVersion, Neo4jFunction } from '@neo4j-cypher/language-support';
3
2
  import type { ExecuteQueryArgs } from '../types/sdkTypes.js';
4
3
  type ListFunctionArgs = {
5
4
  executableByMe: boolean;
6
5
  cypherVersion?: CypherVersion;
7
6
  };
8
- export declare const functionSchema: JSONSchemaType<Neo4jFunction>;
9
7
  /**
10
8
  * Gets available functions in your database
11
9
  * https://neo4j.com/docs/cypher-manual/current/clauses/listing-functions/
@@ -1,5 +1,5 @@
1
- import { ExecuteQueryArgs } from '../types/sdkTypes.js';
2
- export type NeoNode = {
1
+ import type { ExecuteQueryArgs } from '../types/sdkTypes.js';
2
+ type NeoNode = {
3
3
  labels: string[];
4
4
  elementId: string;
5
5
  };
@@ -1,11 +1,9 @@
1
- import { CypherVersion, Neo4jProcedure } from '@neo4j-cypher/language-support';
2
- import { JSONSchemaType } from 'ajv';
1
+ import type { CypherVersion, Neo4jProcedure } from '@neo4j-cypher/language-support';
3
2
  import type { ExecuteQueryArgs } from '../types/sdkTypes.js';
4
3
  type ListProcedureArgs = {
5
4
  executableByMe: boolean;
6
5
  cypherVersion?: CypherVersion;
7
6
  };
8
- export declare const procedureSchema: JSONSchemaType<Neo4jProcedure>;
9
7
  /**
10
8
  * Gets available procedures on your database
11
9
  * https://neo4j.com/docs/cypher-manual/current/clauses/listing-procedures/
@@ -1,4 +1,4 @@
1
- import { ExecuteQueryArgs } from '../types/sdkTypes.js';
1
+ import type { ExecuteQueryArgs } from '../types/sdkTypes.js';
2
2
  /**
3
3
  * Get dbms version
4
4
  */
@@ -1,12 +1,12 @@
1
- import { Integer, Record, ResultSummary } from 'neo4j-driver';
2
- import { DeduplicatedNodesAndRels } from '../cypher-execution/extract-unique-nodes-and-relationships.js';
1
+ import type { Integer, Record, ResultSummary } from 'neo4j-driver';
2
+ import type { DeduplicatedNodesAndRels } from '../cypher-execution/extract-unique-nodes-and-relationships.js';
3
3
  /**
4
4
  * Result type for graph queries that includes deduplicated nodes and relationships
5
5
  * along with the original records and query summary.
6
6
  *
7
7
  * See {@link DeduplicatedNodesAndRels} for the type of the nodes and relationships.
8
8
  */
9
- export type GraphResult = DeduplicatedNodesAndRels & {
9
+ type GraphResult = DeduplicatedNodesAndRels & {
10
10
  /** Original Neo4j records returned by the query */
11
11
  records: Record[];
12
12
  summary: ResultSummary<Integer>;
@@ -34,3 +34,4 @@ export type GraphResult = DeduplicatedNodesAndRels & {
34
34
  * @returns ResultTransformer producing {@link GraphResult}
35
35
  */
36
36
  export declare const graphResultTransformer: import("neo4j-driver").ResultTransformer<GraphResult>;
37
+ export {};
@@ -1,7 +1,7 @@
1
1
  import { EventEmitter } from 'events';
2
- import { Config } from 'neo4j-driver';
3
- import { ConnectionError } from './connectionErrorHandler.js';
4
- import { MetadataPoller } from './metadataPoller.js';
2
+ import type { Config } from 'neo4j-driver';
3
+ import type { ConnectionError } from './connectionErrorHandler.js';
4
+ import type { MetadataPoller } from './metadataPoller.js';
5
5
  import { Neo4jConnection } from './neo4jConnection.js';
6
6
  export type ConnnectionResult = {
7
7
  success: boolean;
@@ -7,12 +7,7 @@ export declare const DbType: {
7
7
  PROPERTY_SHARD: string;
8
8
  };
9
9
  export type QueryType = 'system' | 'user-direct' | 'user-action' | 'user-transpiled';
10
- export type CypherTransactionMetadata = {
11
- app: 'neo4j-sdk';
12
- type: QueryType;
13
- version?: string;
14
- };
15
- export type ExtendedQueryConfig<T> = QueryConfig<T> & Required<Pick<QueryConfig<T>, 'routing' | 'resultTransformer'>>;
10
+ type ExtendedQueryConfig<T> = QueryConfig<T> & Required<Pick<QueryConfig<T>, 'routing' | 'resultTransformer'>>;
16
11
  type Result<T> = T & {
17
12
  summary: ResultSummary;
18
13
  };