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

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @neo4j-cypher/query-tools
 
+## 2.0.0-next.39
+
+### Patch Changes
+
+- Updated dependencies [b510128]
+- Updated dependencies [8b991d6]
+- Updated dependencies [b510128]
+  - @neo4j-cypher/language-support@2.0.0-next.39
+
 ## 2.0.0-next.38
 
 ### Patch Changes

package/api-extractor/api-report.api.md

@@ -0,0 +1,340 @@
+## API Report File for "@neo4j-cypher/query-tools"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { Config } from 'neo4j-driver';
+import type { CypherVersion } from '@neo4j-cypher/language-support';
+import type { Date as Date_2 } from 'neo4j-driver';
+import type { DateTime } from 'neo4j-driver';
+import type { DbSchema } from '@neo4j-cypher/language-support';
+import type { Driver } from 'neo4j-driver';
+import type { Duration } from 'neo4j-driver';
+import { EventEmitter } from 'events';
+import { Integer } from 'neo4j-driver';
+import type { LocalDateTime } from 'neo4j-driver';
+import type { LocalTime } from 'neo4j-driver';
+import type { ManagedTransaction } from 'neo4j-driver';
+import type { Node as Node_2 } from 'neo4j-driver';
+import type { Path } from 'neo4j-driver';
+import type { Point } from 'neo4j-driver';
+import type { QueryConfig } from 'neo4j-driver';
+import type { QueryResult } from 'neo4j-driver';
+import type { Record as Record_2 } from 'neo4j-driver';
+import type { RecordShape } from 'neo4j-driver';
+import type { Relationship } from 'neo4j-driver';
+import { ResultSummary } from 'neo4j-driver';
+import { ResultTransformer } from 'neo4j-driver';
+import type { Session } from 'neo4j-driver';
+import type { Time } from 'neo4j-driver';
+import { types } from 'neo4j-driver';
+import type { Vector } from 'neo4j-driver';
+
+// @public (undocumented)
+export function addAnnotationProp(obj: Record<string, unknown>, type: string | unknown, prop?: string): Record<string, unknown>;
+
+// @public (undocumented)
+export type ConnectionError = {
+    message: string;
+    friendlyMessage: string;
+    code: string;
+};
+
+// @public (undocumented)
+export type ConnnectionResult = {
+    success: boolean;
+    retriable?: boolean;
+    error?: ConnectionError;
+};
+
+// @public
+export type CypherBasicPropertyType = null | boolean | number | string | Integer | bigint | Int8Array | CypherTemporalType | Point | Vector<BigInt64Array | Float32Array | Float64Array | Int8Array | Int16Array | Int32Array>;
+
+// @public (undocumented)
+export const cypherDataToCypherCSVString: (map: CypherDataType | undefined, stringStyle: StringStyle) => string;
+
+// @public (undocumented)
+export const cypherDataToString: (map: CypherDataType | undefined, stringStyle?: StringStyle, quoteStrings?: boolean) => string;
+
+// @public (undocumented)
+export type CypherDataType = CypherBasicPropertyType | CypherStructuralType | CypherMap | CypherList;
+
+// @public (undocumented)
+export type CypherDataTypeName = CypherPropertyName | 'Node' | 'Relationship' | 'Path' | 'Map' | 'Vector';
+
+// @public (undocumented)
+export type CypherList = (CypherBasicPropertyType | CypherStructuralType | CypherMap | CypherList)[];
+
+// @public (undocumented)
+export interface CypherMap {
+    // (undocumented)
+    [key: string]: CypherBasicPropertyType | CypherStructuralType | CypherMap | CypherList;
+}
+
+// @public (undocumented)
+export class CypherMetadataPoller extends MetadataPoller {
+    constructor(databases: Database[], parameters: Record<string, unknown>, serverCypherVersions: string[] | undefined, connection: Neo4jConnection, events: EventEmitter);
+    // (undocumented)
+    dbSchema: DbSchema;
+    // (undocumented)
+    fetchDbSchema(): Promise<void>;
+    // (undocumented)
+    startBackgroundPolling(intervalSeconds?: number): void;
+    // (undocumented)
+    stopBackgroundPolling(): void;
+}
+
+// @public (undocumented)
+export type CypherProperty = CypherBasicPropertyType | CypherBasicPropertyType[];
+
+// @public (undocumented)
+export type CypherPropertyName = 'Float' | 'null' | 'String' | 'Bigint' | 'Boolean' | `List${string}` | 'LocalTime' | 'Time' | 'Date' | 'LocalDateTime' | 'DateTime' | 'Integer' | 'Duration' | 'Point' | 'ByteArray' | 'Vector' | 'Unknown';
+
+// @public (undocumented)
+export type CypherStringStyle = 'cypher' | 'cypher-with-ids';
+
+// @public (undocumented)
+export type CypherStructuralType = Node_2 | Relationship | Path;
+
+// @public (undocumented)
+export type CypherTemporalType = Date_2<NumberOrInteger> | Time<NumberOrInteger> | DateTime | LocalTime<NumberOrInteger> | LocalDateTime | Duration<NumberOrInteger>;
+
+// @public (undocumented)
+export type Database = {
+    name: string;
+    address: string;
+    role: string;
+    requestedStatus: DatabaseStatus;
+    currentStatus: DatabaseStatus;
+    statusMessage?: string;
+    error: string;
+    default: boolean;
+    home: boolean;
+    aliases?: string[];
+    type?: 'system' | 'composite' | 'standard' | 'graph shard' | 'property shard';
+    writer?: boolean;
+    access?: string;
+    constituents?: string[];
+    defaultLanguage?: CypherVersion;
+};
+
+// @public (undocumented)
+export type DatabaseStatus = 'online' | 'offline' | 'starting' | 'stopping' | 'store copying' | 'initial' | 'dirty' | 'quarantined' | 'unknown' | 'dropped' | 'deallocating';
+
+// @public
+export type DeduplicatedNodesAndRels = {
+    nodes: Node_2<Integer, Properties, string>[];
+    relationships: Relationship<Integer, Properties, string>[];
+    limitHit: boolean;
+};
+
+// @public (undocumented)
+export function deleteAnnotationProp(obj: Record<string, unknown>): void;
+
+// @public (undocumented)
+export function deserializeTypeAnnotations(rawItem: Record<string, unknown>): QueryResult | Record_2;
+
+// @public (undocumented)
+export function deserializeTypeAnnotations(rawItem: any): any;
+
+// @public (undocumented)
+export class EmptyMetadataPoller extends MetadataPoller {
+    constructor(parameters: Record<string, unknown>);
+    // (undocumented)
+    dbSchema: DbSchema;
+    // (undocumented)
+    fetchDbSchema(): void;
+    // (undocumented)
+    startBackgroundPolling(): void;
+    // (undocumented)
+    stopBackgroundPolling(): void;
+}
+
+// @public (undocumented)
+export const ESCAPE_CHAR = "_";
+
+// @public (undocumented)
+export type ExecuteQueryArgs<T> = {
+    query: string;
+    queryConfig: ExtendedQueryConfig<Result<T>>;
+};
+
+// @public (undocumented)
+export type ExtendedQueryConfig<T> = QueryConfig<T> & Required<Pick<QueryConfig<T>, 'routing' | 'resultTransformer'>>;
+
+// @public
+export const extractUniqueNodesAndRels: (records: Record_2[], input?: {
+    nodeLimit?: number;
+    keepDanglingRels?: boolean;
+}) => DeduplicatedNodesAndRels;
+
+// @public (undocumented)
+export const FRIENDLY_ERROR_MESSAGES: {
+    Default: string;
+    [key: string]: string;
+};
+
+// @public (undocumented)
+export function getCypherTypeName(val?: CypherDataType): CypherDataTypeName;
+
+// @public (undocumented)
+export const getPropertyTypeDisplayName: (val?: CypherProperty) => CypherPropertyName;
+
+// @public
+export function getVersion(): ExecuteQueryArgs<{
+    serverVersion: string | undefined;
+}>;
+
+// @public
+export type GraphResult = DeduplicatedNodesAndRels & {
+    records: Record_2[];
+    summary: ResultSummary<Integer>;
+};
+
+// @public
+export const graphResultTransformer: ResultTransformer<GraphResult>;
+
+// @public (undocumented)
+export const isCypherBasicPropertyType: (value: unknown) => value is CypherBasicPropertyType;
+
+// @public (undocumented)
+export const isCypherPropertyType: (value: unknown) => value is CypherProperty;
+
+// @public (undocumented)
+export const isCypherTemporalType: (anything: unknown) => anything is CypherTemporalType;
+
+// @public (undocumented)
+export function isInt8Array(val: unknown): val is Int8Array;
+
+// @public (undocumented)
+export abstract class MetadataPoller {
+    // (undocumented)
+    dbSchema: DbSchema;
+    // (undocumented)
+    abstract fetchDbSchema(): void;
+    // (undocumented)
+    abstract startBackgroundPolling(intervalSeconds?: number): void;
+    // (undocumented)
+    abstract stopBackgroundPolling(): void;
+}
+
+// @public (undocumented)
+export class Neo4jConnection {
+    constructor(connectedUser: string, protocolVersion: string, databases: Database[], driver: Driver, database?: string);
+    // (undocumented)
+    connectedUser: string;
+    // (undocumented)
+    currentDb: string | undefined;
+    // (undocumented)
+    databases: Database[];
+    // (undocumented)
+    dispose(): void;
+    // (undocumented)
+    driver: Driver;
+    // (undocumented)
+    evalQuery(session: Session, query: string, parameters: Record<string, unknown>, metadata: object, tx?: ManagedTransaction): Promise<{
+        records: any[];
+        summary: ResultSummary<Integer>;
+        recordLimitHit: boolean;
+    }>;
+    // (undocumented)
+    healthcheck(): Promise<boolean>;
+    // (undocumented)
+    protocolVersion: string;
+    // (undocumented)
+    runCypherQuery(input: RunCypherQueryArgs): Promise<QueryResultWithLimit>;
+    // (undocumented)
+    runSdkQuery<T>(input: ExecuteQueryArgs<T>, input2: SdkQueryArgs): Promise<T>;
+    // (undocumented)
+    serverVersion: string | undefined;
+}
+
+// @public (undocumented)
+export class Neo4jSchemaPoller {
+    // (undocumented)
+    connect(url: string, credentials: {
+        username: string;
+        password: string;
+    }, config: {
+        driverConfig?: Config;
+        appName: string;
+    }, database?: string): Promise<ConnnectionResult>;
+    // (undocumented)
+    connection?: Neo4jConnection;
+    // (undocumented)
+    disconnect(): void;
+    // (undocumented)
+    events: EventEmitter;
+    // (undocumented)
+    metadata?: MetadataPoller;
+    // (undocumented)
+    persistentConnect(url: string, credentials: {
+        username: string;
+        password: string;
+    }, config: {
+        driverConfig?: Config;
+        appName: string;
+    }, database?: string): Promise<ConnnectionResult>;
+    // (undocumented)
+    setParameters(parameters: Record<string, unknown>): void;
+}
+
+// @public (undocumented)
+export type Neo4jType = typeof types.Record | typeof types.Result | typeof types.ResultSummary | typeof types.Node | typeof types.PathSegment | typeof types.Path | typeof types.Relationship | typeof types.Point | typeof types.Date | typeof types.DateTime | typeof types.Duration | typeof types.LocalDateTime | typeof types.LocalTime | typeof types.Time | typeof types.Integer | typeof types.Vector | Record<string, unknown> | Neo4jType[] | undefined | null;
+
+// @public (undocumented)
+export type NumberOrInteger = number | Integer | bigint;
+
+// @public (undocumented)
+export type Properties = RecordShape<string, CypherProperty>;
+
+// @public (undocumented)
+export function propertyToString(property: CypherProperty, quoteStrings?: boolean, localeFormattedDates?: boolean): string;
+
+// @public (undocumented)
+export type QueryResultWithLimit = QueryResult & {
+    recordLimitHit: boolean;
+};
+
+// @public (undocumented)
+export type QueryType = 'system' | 'user-direct' | 'user-action' | 'user-transpiled';
+
+// @public (undocumented)
+export const RESERVED_TYPE_PROPERTY_NAME = "transport-class";
+
+// @public (undocumented)
+export type Result<T> = T & {
+    summary: ResultSummary;
+};
+
+// @public (undocumented)
+export type RunCypherQueryArgs = {
+    query: string;
+    parameters: Record<string, unknown>;
+    database?: string;
+    abortSignal?: AbortSignal;
+    implicitTransaction?: boolean;
+};
+
+// @public (undocumented)
+export type SdkQueryArgs = {
+    queryType: QueryType;
+    abortSignal?: AbortSignal;
+};
+
+// @public (undocumented)
+export function serializeTypeAnnotations(item: QueryResult | Record_2): Record<string, unknown>;
+
+// @public (undocumented)
+export function serializeTypeAnnotations(item: Neo4jType): Record<string, unknown> | null | undefined | unknown[];
+
+// @public (undocumented)
+export const spacialFormat: (p: Point) => string;
+
+// @public (undocumented)
+export type StringStyle = 'json' | CypherStringStyle;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/api-extractor.json

@@ -0,0 +1,10 @@
+/**
+ * Config file for API Extractor.  For more info, please visit: https://api-extractor.com
+ */
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+
+  "extends": "../../api-extractor-base.json",
+
+  "mainEntryPointFilePath": "./dist/types/src/index.d.ts"
+}

package/checkApiReport.ts

@@ -0,0 +1,4 @@
+import { runApiExtractor } from '../../scripts/runApiExtractor.js';
+
+// Deliberately outside src/ so it is not part of the package's tsc build.
+runApiExtractor(import.meta.dirname);

package/dist/cjs/index.cjs

@@ -1415,7 +1415,7 @@ var ConnectedMetadataPoller = class extends MetadataPoller {
 // package.json
 var package_default = {
   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"
@@ -1443,10 +1443,11 @@ var package_default = {
     "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"
   },
   dependencies: {
     "@neo4j-cypher/language-support": "workspace:*",