@neo4j-cypher/query-tools 2.0.0-next.19

package/dist/cjs/src/queries/procedures.js

@@ -0,0 +1,106 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.procedureSchema = void 0;
+exports.listProcedures = listProcedures;
+const ajv_1 = __importDefault(require("ajv"));
+const neo4j_driver_1 = require("neo4j-driver");
+const clean_type_1 = require("../data-transforms/clean-type");
+exports.procedureSchema = {
+    type: 'object',
+    properties: {
+        admin: { type: 'boolean' },
+        argumentDescription: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    name: { type: 'string' },
+                    description: { type: 'string' },
+                    type: { type: 'string' },
+                    default: { type: 'string', nullable: true },
+                    isDeprecated: { type: 'boolean', default: false },
+                },
+                required: ['name', 'description', 'type', 'isDeprecated'],
+            },
+        },
+        description: { type: 'string' },
+        mode: { type: 'string' },
+        name: { type: 'string' },
+        option: { type: 'object' },
+        returnDescription: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    name: { type: 'string' },
+                    description: { type: 'string' },
+                    type: { type: 'string' },
+                    isDeprecated: { type: 'boolean', default: false },
+                },
+                required: ['name', 'description', 'type', 'isDeprecated'],
+            },
+        },
+        signature: { type: 'string' },
+        worksOnSystem: { type: 'boolean' },
+        deprecatedBy: { type: 'string', nullable: true },
+    },
+    required: [
+        'admin',
+        'argumentDescription',
+        'description',
+        'mode',
+        'name',
+        'option',
+        'returnDescription',
+        'signature',
+        'worksOnSystem',
+    ],
+    additionalProperties: true,
+};
+const validateProcedure = new ajv_1.default({ useDefaults: true }).compile(exports.procedureSchema);
+function cleanTypes(result) {
+    return {
+        ...result,
+        argumentDescription: result.argumentDescription.map(clean_type_1.cleanTypeDescription),
+        returnDescription: result.returnDescription.map(clean_type_1.cleanTypeDescription),
+    };
+}
+/**
+ * Gets available procedures on your database
+ * https://neo4j.com/docs/cypher-manual/current/clauses/listing-procedures/
+ */
+function listProcedures({ executableByMe, cypherVersion } = {
+    executableByMe: false,
+    cypherVersion: undefined,
+}) {
+    const query = `${cypherVersion ? cypherVersion + ' ' : ''}
+    SHOW PROCEDURES 
+    ${executableByMe ? 'EXECUTABLE BY CURRENT USER' : ''}
+    YIELD *`;
+    const resultTransformer = neo4j_driver_1.resultTransformers.mappedResultTransformer({
+        map(record) {
+            // Assign default values (e.g. isDeprecated) in case they are not present
+            const objResult = record.toObject();
+            validateProcedure(objResult);
+            // Type is verified in integration tests
+            // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+            const result = cleanTypes(objResult);
+            return result;
+        },
+        collect(procedures, summary) {
+            return { procedures, summary };
+        },
+    });
+    return {
+        query,
+        queryConfig: {
+            routing: 'READ',
+            database: 'system',
+            resultTransformer,
+        },
+    };
+}
+//# sourceMappingURL=procedures.js.map

package/dist/cjs/src/queries/procedures.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"procedures.js","sourceRoot":"","sources":["../../../../src/queries/procedures.ts"],"names":[],"mappings":";;;;;;AAgFA,wCAoCC;AAnHD,8CAA0C;AAC1C,+CAAkD;AAClD,8DAAqE;AAQxD,QAAA,eAAe,GAAmC;IAC7D,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAC1B,mBAAmB,EAAE;YACnB,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACxB,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC/B,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACxB,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;oBAC3C,YAAY,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;iBAClD;gBACD,QAAQ,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,cAAc,CAAC;aAC1D;SACF;QACD,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC/B,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACxB,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACxB,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC1B,iBAAiB,EAAE;YACjB,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACxB,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC/B,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACxB,YAAY,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;iBAClD;gBACD,QAAQ,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,cAAc,CAAC;aAC1D;SACF;QACD,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC7B,aAAa,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAClC,YAAY,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;KACjD;IACD,QAAQ,EAAE;QACR,OAAO;QACP,qBAAqB;QACrB,aAAa;QACb,MAAM;QACN,MAAM;QACN,QAAQ;QACR,mBAAmB;QACnB,WAAW;QACX,eAAe;KAChB;IACD,oBAAoB,EAAE,IAAI;CAC3B,CAAC;AAEF,MAAM,iBAAiB,GAAG,IAAI,aAAG,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,OAAO,CAC9D,uBAAe,CAChB,CAAC;AAEF,SAAS,UAAU,CAAC,MAAsB;IACxC,OAAO;QACL,GAAG,MAAM;QACT,mBAAmB,EAAE,MAAM,CAAC,mBAAmB,CAAC,GAAG,CAAC,iCAAoB,CAAC;QACzE,iBAAiB,EAAE,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,iCAAoB,CAAC;KACtE,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAgB,cAAc,CAC5B,EAAE,cAAc,EAAE,aAAa,KAAwB;IACrD,cAAc,EAAE,KAAK;IACrB,aAAa,EAAE,SAAS;CACzB;IAID,MAAM,KAAK,GAAG,GAAG,aAAa,CAAC,CAAC,CAAC,aAAa,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE;;MAErD,cAAc,CAAC,CAAC,CAAC,4BAA4B,CAAC,CAAC,CAAC,EAAE;YAC5C,CAAC;IAEX,MAAM,iBAAiB,GAAG,iCAAkB,CAAC,uBAAuB,CAAC;QACnE,GAAG,CAAC,MAAM;YACR,yEAAyE;YACzE,MAAM,SAAS,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YACpC,iBAAiB,CAAC,SAAS,CAAC,CAAC;YAC7B,wCAAwC;YACxC,yEAAyE;YACzE,MAAM,MAAM,GAAG,UAAU,CAAC,SAA2B,CAAC,CAAC;YACvD,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,OAAO,CAAC,UAAU,EAAE,OAAO;YACzB,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;QACjC,CAAC;KACF,CAAC,CAAC;IAEH,OAAO;QACL,KAAK;QACL,WAAW,EAAE;YACX,OAAO,EAAE,MAAM;YACf,QAAQ,EAAE,QAAQ;YAClB,iBAAiB;SAClB;KACF,CAAC;AACJ,CAAC"}

package/dist/cjs/src/queries/roles.d.ts

@@ -0,0 +1,11 @@
+import type { ExecuteQueryArgs } from '../types/sdkTypes.js';
+export type Neo4jRole = {
+    role: string;
+};
+/**
+ * Gets available roles in your database
+ * https://neo4j.com/docs/operations-manual/current/authentication-authorization/manage-roles/#access-control-list-roles
+ */
+export declare function listRoles(): ExecuteQueryArgs<{
+    roles: Neo4jRole[];
+}>;

package/dist/cjs/src/queries/roles.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listRoles = listRoles;
+const neo4j_driver_1 = require("neo4j-driver");
+/**
+ * Gets available roles in your database
+ * https://neo4j.com/docs/operations-manual/current/authentication-authorization/manage-roles/#access-control-list-roles
+ */
+function listRoles() {
+    const query = `SHOW ROLES`;
+    const resultTransformer = neo4j_driver_1.resultTransformers.mappedResultTransformer({
+        map(record) {
+            return record.toObject();
+        },
+        collect(roles, summary) {
+            return { roles, summary };
+        },
+    });
+    return {
+        query,
+        queryConfig: { resultTransformer, routing: 'READ', database: 'system' },
+    };
+}
+//# sourceMappingURL=roles.js.map

package/dist/cjs/src/queries/roles.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"roles.js","sourceRoot":"","sources":["../../../../src/queries/roles.ts"],"names":[],"mappings":";;AAWA,8BAkBC;AA7BD,+CAAkD;AAOlD;;;GAGG;AACH,SAAgB,SAAS;IAGvB,MAAM,KAAK,GAAG,YAAY,CAAC;IAE3B,MAAM,iBAAiB,GAAG,iCAAkB,CAAC,uBAAuB,CAAC;QACnE,GAAG,CAAC,MAAM;YACR,OAAO,MAAM,CAAC,QAAQ,EAAe,CAAC;QACxC,CAAC;QACD,OAAO,CAAC,KAAK,EAAE,OAAO;YACpB,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;QAC5B,CAAC;KACF,CAAC,CAAC;IAEH,OAAO;QACL,KAAK;QACL,WAAW,EAAE,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE;KACxE,CAAC;AACJ,CAAC"}

package/dist/cjs/src/queries/users.d.ts

@@ -0,0 +1,15 @@
+import type { ExecuteQueryArgs } from '../types/sdkTypes.js';
+export type Neo4jUser = {
+    user: string;
+    roles: string[];
+    passwordChangeRequired: string;
+    suspended?: boolean;
+    home?: string;
+};
+/**
+ * Gets available users in your database
+ * https://neo4j.com/docs/cypher-manual/current/administration/access-control/manage-users/#access-control-list-users
+ */
+export declare function listUsers(): ExecuteQueryArgs<{
+    users: Neo4jUser[];
+}>;

package/dist/cjs/src/queries/users.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listUsers = listUsers;
+const neo4j_driver_1 = require("neo4j-driver");
+/**
+ * Gets available users in your database
+ * https://neo4j.com/docs/cypher-manual/current/administration/access-control/manage-users/#access-control-list-users
+ */
+function listUsers() {
+    const query = `SHOW USERS`;
+    const resultTransformer = neo4j_driver_1.resultTransformers.mappedResultTransformer({
+        map(record) {
+            return record.toObject();
+        },
+        collect(users, summary) {
+            return { users, summary };
+        },
+    });
+    return {
+        query,
+        queryConfig: { resultTransformer, routing: 'READ', database: 'system' },
+    };
+}
+//# sourceMappingURL=users.js.map

package/dist/cjs/src/queries/users.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"users.js","sourceRoot":"","sources":["../../../../src/queries/users.ts"],"names":[],"mappings":";;AAgBA,8BAkBC;AAlCD,+CAAkD;AAYlD;;;GAGG;AACH,SAAgB,SAAS;IAGvB,MAAM,KAAK,GAAG,YAAY,CAAC;IAE3B,MAAM,iBAAiB,GAAG,iCAAkB,CAAC,uBAAuB,CAAC;QACnE,GAAG,CAAC,MAAM;YACR,OAAO,MAAM,CAAC,QAAQ,EAAe,CAAC;QACxC,CAAC;QACD,OAAO,CAAC,KAAK,EAAE,OAAO;YACpB,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;QAC5B,CAAC;KACF,CAAC,CAAC;IAEH,OAAO;QACL,KAAK;QACL,WAAW,EAAE,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE;KACxE,CAAC;AACJ,CAAC"}

package/dist/cjs/src/queries/version.d.ts

@@ -0,0 +1,7 @@
+import { ExecuteQueryArgs } from '../types/sdkTypes';
+/**
+ * Get dbms version
+ */
+export declare function getVersion(): ExecuteQueryArgs<{
+    serverVersion: string | undefined;
+}>;

package/dist/cjs/src/queries/version.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getVersion = getVersion;
+const neo4j_driver_1 = require("neo4j-driver");
+/**
+ * Get dbms version
+ */
+function getVersion() {
+    const query = 'CALL dbms.components() YIELD versions';
+    const resultTransformer = neo4j_driver_1.resultTransformers.mappedResultTransformer({
+        map(record) {
+            const obj = record.toObject();
+            const versions = obj.versions;
+            const version = versions?.at(0);
+            return version;
+        },
+        collect(versions, summary) {
+            return { serverVersion: versions.at(0), summary };
+        },
+    });
+    return {
+        query,
+        queryConfig: { resultTransformer, routing: 'READ', database: 'system' },
+    };
+}
+//# sourceMappingURL=version.js.map

package/dist/cjs/src/queries/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../../../src/queries/version.ts"],"names":[],"mappings":";;AAMA,gCAqBC;AA3BD,+CAAkD;AAGlD;;GAEG;AACH,SAAgB,UAAU;IAGxB,MAAM,KAAK,GAAG,uCAAuC,CAAC;IAEtD,MAAM,iBAAiB,GAAG,iCAAkB,CAAC,uBAAuB,CAAC;QACnE,GAAG,CAAC,MAAM;YACR,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC9B,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAoB,CAAC;YAC1C,MAAM,OAAO,GAAG,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;YAChC,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,OAAO,CAAC,QAAQ,EAAE,OAAO;YACvB,OAAO,EAAE,aAAa,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC;QACpD,CAAC;KACF,CAAC,CAAC;IAEH,OAAO;QACL,KAAK;QACL,WAAW,EAAE,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE;KACxE,CAAC;AACJ,CAAC"}

package/dist/cjs/src/schemaPoller.d.ts

@@ -0,0 +1,44 @@
+import { EventEmitter } from 'events';
+import { Config } from 'neo4j-driver';
+import { ConnectionError } from './connectionErrorHandler';
+import { MetadataPoller } from './metadataPoller';
+import { Neo4jConnection } from './neo4jConnection';
+export type ConnnectionResult = {
+    success: boolean;
+    retriable?: boolean;
+    error?: ConnectionError;
+};
+export declare class Neo4jSchemaPoller {
+    connection?: Neo4jConnection;
+    metadata?: MetadataPoller;
+    events: EventEmitter;
+    private driver?;
+    private reconnectionTimeout?;
+    private retries;
+    private lastError?;
+    private parameters;
+    setParameters(parameters: Record<string, unknown>): void;
+    connect(url: string, credentials: {
+        username: string;
+        password: string;
+    }, config: {
+        driverConfig?: Config;
+        appName: string;
+    }, database?: string): Promise<ConnnectionResult>;
+    persistentConnect(url: string, credentials: {
+        username: string;
+        password: string;
+    }, config: {
+        driverConfig?: Config;
+        appName: string;
+    }, database?: string): Promise<ConnnectionResult>;
+    disconnect(): void;
+    private connectAndStartMetadataPoller;
+    private initializeDriver;
+    private setReconnectionTimeout;
+    private handleSuccessfulConnection;
+    private handleNonSuccessfulConnection;
+    private handlePermanentlyFailingConnection;
+    private formatConnectionErrorFriendlyMessage;
+    private resetRetries;
+}

package/dist/cjs/src/schemaPoller.js

@@ -0,0 +1,167 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Neo4jSchemaPoller = void 0;
+const events_1 = require("events");
+const neo4j_driver_1 = __importDefault(require("neo4j-driver"));
+const connectionErrorHandler_1 = require("./connectionErrorHandler");
+const metadataPoller_1 = require("./metadataPoller");
+const neo4jConnection_1 = require("./neo4jConnection");
+const databases_js_1 = require("./queries/databases.js");
+const version_1 = require("./queries/version");
+const MAX_RETRY_ATTEMPTS = 5;
+const RETRY_INTERVAL_MS = 30000;
+class Neo4jSchemaPoller {
+    connection;
+    metadata;
+    events = new events_1.EventEmitter();
+    driver;
+    reconnectionTimeout;
+    retries = MAX_RETRY_ATTEMPTS;
+    lastError;
+    parameters = {};
+    setParameters(parameters) {
+        this.parameters = parameters;
+        if (this.metadata) {
+            this.metadata.dbSchema.parameters = parameters;
+        }
+        else {
+            this.metadata = new metadataPoller_1.DisconnectedMetadataPoller(parameters);
+        }
+    }
+    async connect(url, credentials, config, database) {
+        try {
+            this.driver = await this.initializeDriver(url, credentials, config, database);
+        }
+        catch (error) {
+            console.error('Error connecting to Neo4j.', error);
+            return {
+                success: false,
+                retriable: (0, connectionErrorHandler_1.isRetriableNeo4jError)(error),
+                error: (0, connectionErrorHandler_1.getConnectionError)(error),
+            };
+        }
+        return { success: true };
+    }
+    async persistentConnect(url, credentials, config, database) {
+        const shouldHaveConnection = this.connection !== undefined;
+        const connectionAlive = await this.connection?.healthcheck();
+        const shouldUpdateConnection = this.connection && database && this.connection?.currentDb !== database;
+        if (!connectionAlive || shouldUpdateConnection) {
+            if (shouldHaveConnection && !shouldUpdateConnection) {
+                console.error('Connection to Neo4j dropped');
+                this.disconnect();
+            }
+            else if (shouldUpdateConnection) {
+                this.disconnect();
+            }
+            try {
+                await this.connectAndStartMetadataPoller(url, credentials, config, database);
+                this.reconnectionTimeout = this.setReconnectionTimeout(url, credentials, config, database);
+                return this.handleSuccessfulConnection();
+            }
+            catch (error) {
+                console.error('Error connecting to Neo4j.', error);
+                this.retries -= 1;
+                this.lastError = (0, connectionErrorHandler_1.getConnectionError)(error);
+                if (!(0, connectionErrorHandler_1.isRetriableNeo4jError)(error)) {
+                    return this.handlePermanentlyFailingConnection();
+                }
+                if (this.retries > 0) {
+                    this.reconnectionTimeout = this.setReconnectionTimeout(url, credentials, config, database);
+                    return this.handleNonSuccessfulConnection();
+                }
+                return this.handlePermanentlyFailingConnection();
+            }
+        }
+        this.reconnectionTimeout = this.setReconnectionTimeout(url, credentials, config, database);
+        return { success: true };
+    }
+    disconnect() {
+        if (this.connection) {
+            // eslint-disable-next-line no-console
+            console.log('Disconnected from Neo4j');
+        }
+        this.connection?.dispose();
+        this.metadata?.stopBackgroundPolling();
+        this.connection = undefined;
+        const parameters = this.metadata?.dbSchema?.parameters ?? {};
+        this.metadata = new metadataPoller_1.DisconnectedMetadataPoller(parameters);
+        this.driver = undefined;
+        clearTimeout(this.reconnectionTimeout);
+    }
+    async connectAndStartMetadataPoller(url, credentials, config, database) {
+        this.driver =
+            this.driver ??
+                (await this.initializeDriver(url, credentials, config, database));
+        const { query: dbQuery, queryConfig: dbQueryConfig } = (0, databases_js_1.listDatabases)();
+        const { databases, summary } = await this.driver.executeQuery(dbQuery, {}, dbQueryConfig);
+        const protocolVersion = summary.server.protocolVersion?.toString() ?? 'unknown';
+        this.connection = new neo4jConnection_1.Neo4jConnection(credentials.username, protocolVersion, databases, this.driver, database);
+        const { query: versionQuery, queryConfig: versionQueryConfig } = (0, version_1.getVersion)();
+        const { serverVersion } = await this.driver.executeQuery(versionQuery, {}, versionQueryConfig);
+        this.metadata = new metadataPoller_1.ConnectedMetadataPoller(databases, this.parameters, serverVersion, this.connection, this.events);
+        this.metadata.startBackgroundPolling();
+    }
+    async initializeDriver(url, credentials, config, database) {
+        const driver = neo4j_driver_1.default.driver(url, neo4j_driver_1.default.auth.basic(credentials.username, credentials.password), { userAgent: config.appName, ...config.driverConfig });
+        await driver.verifyConnectivity({ database: database });
+        if (await driver.supportsSessionAuth()) {
+            if (!(await driver.verifyAuthentication())) {
+                throw new Error('Invalid credentials');
+            }
+        }
+        return driver;
+    }
+    setReconnectionTimeout(url, credentials, config, database) {
+        return setTimeout(() => {
+            void this.persistentConnect(url, credentials, config, database);
+        }, RETRY_INTERVAL_MS);
+    }
+    handleSuccessfulConnection() {
+        this.resetRetries();
+        // eslint-disable-next-line no-console
+        console.log('Established connection to Neo4j');
+        this.events.emit('connectionConnected');
+        return { success: true };
+    }
+    handleNonSuccessfulConnection() {
+        const connectionError = this.formatConnectionErrorFriendlyMessage(this.lastError, true);
+        this.events.emit('connectionErrored', connectionError);
+        return {
+            success: false,
+            retriable: true,
+            error: connectionError,
+        };
+    }
+    handlePermanentlyFailingConnection() {
+        this.resetRetries();
+        const connectionError = this.formatConnectionErrorFriendlyMessage(this.lastError, false);
+        this.events.emit('connectionFailed', connectionError);
+        return {
+            success: false,
+            retriable: false,
+            error: connectionError,
+        };
+    }
+    formatConnectionErrorFriendlyMessage(connectionError = {
+        message: '',
+        friendlyMessage: connectionErrorHandler_1.FRIENDLY_ERROR_MESSAGES.Default,
+        code: '',
+    }, retriable) {
+        const friendlyMessage = retriable
+            ? `${connectionError.friendlyMessage}. Retrying in ${RETRY_INTERVAL_MS / 1000} seconds`
+            : connectionError.friendlyMessage;
+        return {
+            ...connectionError,
+            friendlyMessage: friendlyMessage,
+        };
+    }
+    resetRetries() {
+        this.retries = MAX_RETRY_ATTEMPTS;
+    }
+}
+exports.Neo4jSchemaPoller = Neo4jSchemaPoller;
+//# sourceMappingURL=schemaPoller.js.map

package/dist/cjs/src/schemaPoller.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemaPoller.js","sourceRoot":"","sources":["../../../src/schemaPoller.ts"],"names":[],"mappings":";;;;;;AAAA,mCAAsC;AACtC,gEAAqD;AACrD,qEAKkC;AAClC,qDAI0B;AAC1B,uDAAoD;AACpD,yDAAuD;AACvD,+CAA+C;AAQ/C,MAAM,kBAAkB,GAAG,CAAC,CAAC;AAC7B,MAAM,iBAAiB,GAAG,KAAK,CAAC;AAEhC,MAAa,iBAAiB;IACrB,UAAU,CAAmB;IAC7B,QAAQ,CAAkB;IAC1B,MAAM,GAAiB,IAAI,qBAAY,EAAE,CAAC;IACzC,MAAM,CAAU;IAChB,mBAAmB,CAAiC;IACpD,OAAO,GAAG,kBAAkB,CAAC;IAC7B,SAAS,CAAmB;IAC5B,UAAU,GAA4B,EAAE,CAAC;IAEjD,aAAa,CAAC,UAAmC;QAC/C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAE7B,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,GAAG,UAAU,CAAC;QACjD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,IAAI,2CAA0B,CAAC,UAAU,CAAC,CAAC;QAC7D,CAAC;IACH,CAAC;IAED,KAAK,CAAC,OAAO,CACX,GAAW,EACX,WAAmD,EACnD,MAAkD,EAClD,QAAiB;QAEjB,IAAI,CAAC;YACH,IAAI,CAAC,MAAM,GAAG,MAAM,IAAI,CAAC,gBAAgB,CACvC,GAAG,EACH,WAAW,EACX,MAAM,EACN,QAAQ,CACT,CAAC;QACJ,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,OAAO,CAAC,KAAK,CAAC,4BAA4B,EAAE,KAAK,CAAC,CAAC;YACnD,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,SAAS,EAAE,IAAA,8CAAqB,EAAC,KAAK,CAAC;gBACvC,KAAK,EAAE,IAAA,2CAAkB,EAAC,KAAK,CAAC;aACjC,CAAC;QACJ,CAAC;QAED,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,GAAW,EACX,WAAmD,EACnD,MAAkD,EAClD,QAAiB;QAEjB,MAAM,oBAAoB,GAAG,IAAI,CAAC,UAAU,KAAK,SAAS,CAAC;QAC3D,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,CAAC;QAC7D,MAAM,sBAAsB,GAC1B,IAAI,CAAC,UAAU,IAAI,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE,SAAS,KAAK,QAAQ,CAAC;QAEzE,IAAI,CAAC,eAAe,IAAI,sBAAsB,EAAE,CAAC;YAC/C,IAAI,oBAAoB,IAAI,CAAC,sBAAsB,EAAE,CAAC;gBACpD,OAAO,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;gBAC7C,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,CAAC;iBAAM,IAAI,sBAAsB,EAAE,CAAC;gBAClC,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,CAAC;YAED,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,6BAA6B,CACtC,GAAG,EACH,WAAW,EACX,MAAM,EACN,QAAQ,CACT,CAAC;gBAEF,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,sBAAsB,CACpD,GAAG,EACH,WAAW,EACX,MAAM,EACN,QAAQ,CACT,CAAC;gBAEF,OAAO,IAAI,CAAC,0BAA0B,EAAE,CAAC;YAC3C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,4BAA4B,EAAE,KAAK,CAAC,CAAC;gBACnD,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC;gBAClB,IAAI,CAAC,SAAS,GAAG,IAAA,2CAAkB,EAAC,KAAK,CAAC,CAAC;gBAE3C,IAAI,CAAC,IAAA,8CAAqB,EAAC,KAAK,CAAC,EAAE,CAAC;oBAClC,OAAO,IAAI,CAAC,kCAAkC,EAAE,CAAC;gBACnD,CAAC;gBAED,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC,EAAE,CAAC;oBACrB,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,sBAAsB,CACpD,GAAG,EACH,WAAW,EACX,MAAM,EACN,QAAQ,CACT,CAAC;oBAEF,OAAO,IAAI,CAAC,6BAA6B,EAAE,CAAC;gBAC9C,CAAC;gBAED,OAAO,IAAI,CAAC,kCAAkC,EAAE,CAAC;YACnD,CAAC;QACH,CAAC;QAED,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,sBAAsB,CACpD,GAAG,EACH,WAAW,EACX,MAAM,EACN,QAAQ,CACT,CAAC;QAEF,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC3B,CAAC;IAED,UAAU;QACR,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,sCAAsC;YACtC,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;QACzC,CAAC;QACD,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE,CAAC;QAC3B,IAAI,CAAC,QAAQ,EAAE,qBAAqB,EAAE,CAAC;QACvC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,UAAU,IAAI,EAAE,CAAC;QAC7D,IAAI,CAAC,QAAQ,GAAG,IAAI,2CAA0B,CAAC,UAAU,CAAC,CAAC;QAC3D,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,YAAY,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IACzC,CAAC;IAEO,KAAK,CAAC,6BAA6B,CACzC,GAAW,EACX,WAAmD,EACnD,MAAkD,EAClD,QAAiB;QAEjB,IAAI,CAAC,MAAM;YACT,IAAI,CAAC,MAAM;gBACX,CAAC,MAAM,IAAI,CAAC,gBAAgB,CAAC,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;QAEpE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,GAAG,IAAA,4BAAa,GAAE,CAAC;QACvE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAC3D,OAAO,EACP,EAAE,EACF,aAAa,CACd,CAAC;QAEF,MAAM,eAAe,GACnB,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,QAAQ,EAAE,IAAI,SAAS,CAAC;QAE1D,IAAI,CAAC,UAAU,GAAG,IAAI,iCAAe,CACnC,WAAW,CAAC,QAAQ,EACpB,eAAe,EACf,SAAS,EACT,IAAI,CAAC,MAAM,EACX,QAAQ,CACT,CAAC;QAEF,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,kBAAkB,EAAE,GAC5D,IAAA,oBAAU,GAAE,CAAC;QACf,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CACtD,YAAY,EACZ,EAAE,EACF,kBAAkB,CACnB,CAAC;QAEF,IAAI,CAAC,QAAQ,GAAG,IAAI,wCAAuB,CACzC,SAAS,EACT,IAAI,CAAC,UAAU,EACf,aAAa,EACb,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,MAAM,CACZ,CAAC;QAEF,IAAI,CAAC,QAAQ,CAAC,sBAAsB,EAAE,CAAC;IACzC,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAC5B,GAAW,EACX,WAAmD,EACnD,MAAkD,EAClD,QAAiB;QAEjB,MAAM,MAAM,GAAG,sBAAK,CAAC,MAAM,CACzB,GAAG,EACH,sBAAK,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAAC,EAC5D,EAAE,SAAS,EAAE,MAAM,CAAC,OAAO,EAAE,GAAG,MAAM,CAAC,YAAY,EAAE,CACtD,CAAC;QAEF,MAAM,MAAM,CAAC,kBAAkB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;QAExD,IAAI,MAAM,MAAM,CAAC,mBAAmB,EAAE,EAAE,CAAC;YACvC,IAAI,CAAC,CAAC,MAAM,MAAM,CAAC,oBAAoB,EAAE,CAAC,EAAE,CAAC;gBAC3C,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,sBAAsB,CAC5B,GAAW,EACX,WAAmD,EACnD,MAAkD,EAClD,QAAiB;QAEjB,OAAO,UAAU,CAAC,GAAG,EAAE;YACrB,KAAK,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;QAClE,CAAC,EAAE,iBAAiB,CAAC,CAAC;IACxB,CAAC;IAEO,0BAA0B;QAChC,IAAI,CAAC,YAAY,EAAE,CAAC;QAEpB,sCAAsC;QACtC,OAAO,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAExC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC3B,CAAC;IAEO,6BAA6B;QACnC,MAAM,eAAe,GAAG,IAAI,CAAC,oCAAoC,CAC/D,IAAI,CAAC,SAAS,EACd,IAAI,CACL,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE,eAAe,CAAC,CAAC;QAEvD,OAAO;YACL,OAAO,EAAE,KAAK;YACd,SAAS,EAAE,IAAI;YACf,KAAK,EAAE,eAAe;SACvB,CAAC;IACJ,CAAC;IAEO,kCAAkC;QACxC,IAAI,CAAC,YAAY,EAAE,CAAC;QAEpB,MAAM,eAAe,GAAG,IAAI,CAAC,oCAAoC,CAC/D,IAAI,CAAC,SAAS,EACd,KAAK,CACN,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kBAAkB,EAAE,eAAe,CAAC,CAAC;QAEtD,OAAO;YACL,OAAO,EAAE,KAAK;YACd,SAAS,EAAE,KAAK;YAChB,KAAK,EAAE,eAAe;SACvB,CAAC;IACJ,CAAC;IAEO,oCAAoC,CAC1C,kBAAmC;QACjC,OAAO,EAAE,EAAE;QACX,eAAe,EAAE,gDAAuB,CAAC,OAAO;QAChD,IAAI,EAAE,EAAE;KACT,EACD,SAAkB;QAElB,MAAM,eAAe,GAAG,SAAS;YAC/B,CAAC,CAAC,GAAG,eAAe,CAAC,eAAe,iBAChC,iBAAiB,GAAG,IACtB,UAAU;YACZ,CAAC,CAAC,eAAe,CAAC,eAAe,CAAC;QAEpC,OAAO;YACL,GAAG,eAAe;YAClB,eAAe,EAAE,eAAe;SACjC,CAAC;IACJ,CAAC;IAEO,YAAY;QAClB,IAAI,CAAC,OAAO,GAAG,kBAAkB,CAAC;IACpC,CAAC;CACF;AAlRD,8CAkRC"}

package/dist/cjs/src/types/cypher-data-types.d.ts

@@ -0,0 +1,41 @@
+import type { Date, DateTime, Duration, Integer, LocalDateTime, LocalTime, Node, Path, Point, Relationship, Time } from 'neo4j-driver';
+type NumberOrInteger = number | Integer | bigint;
+/**
+      The neo4j driver type mapping - https://neo4j.com/docs/javascript-manual/current/cypher-workflow/#js-driver-type-mapping
+      
+      Star denotes custom driver class.
+      
+      Cypher(neo4j) -  Driver type(js)
+      null          - null
+      List          - array
+      Map           - Object
+      Boolean       - boolean
+      Integer       - Integer*
+      Float         - number
+      String        - string
+      ByteArray     - Int8Array
+      Date          - Date*
+      Time          - Time*
+      LocalTime     - LocalTime*
+      DateTime      - DateTime*
+      LocalDateTime - LocalDateTime*
+      Duration      - Duration*
+      Point         - Point*
+      Node          - Node*
+      Relationship  - Relationship*
+      Path          - Path*
+      */
+export type CypherBasicPropertyType = null | boolean | number | string | Integer | bigint | Int8Array | CypherTemporalType | Point;
+export type CypherTemporalType = Date<NumberOrInteger> | Time<NumberOrInteger> | DateTime | LocalTime<NumberOrInteger> | LocalDateTime | Duration<NumberOrInteger>;
+export type CypherProperty = CypherBasicPropertyType | CypherBasicPropertyType[];
+export type CypherStructuralType = Node | Relationship | Path;
+export type CypherList = (CypherBasicPropertyType | CypherStructuralType | CypherMap | CypherList)[];
+export interface CypherMap {
+    [key: string]: CypherBasicPropertyType | CypherStructuralType | CypherMap | CypherList;
+}
+export type CypherDataType = CypherBasicPropertyType | CypherStructuralType | CypherMap | CypherList;
+export declare const isCypherTemporalType: (anything: unknown) => anything is CypherTemporalType;
+export declare const isCypherBasicPropertyType: (value: unknown) => value is CypherBasicPropertyType;
+export declare const isCypherPropertyType: (value: unknown) => value is CypherProperty;
+export declare function isInt8Array(val: unknown): val is Int8Array;
+export {};

package/dist/cjs/src/types/cypher-data-types.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCypherPropertyType = exports.isCypherBasicPropertyType = exports.isCypherTemporalType = void 0;
+exports.isInt8Array = isInt8Array;
+const neo4j_driver_1 = require("neo4j-driver");
+const isCypherTemporalType = (anything) => {
+    if (typeof anything === 'object' && anything !== null) {
+        return [
+            neo4j_driver_1.isDate,
+            neo4j_driver_1.isTime,
+            neo4j_driver_1.isDateTime,
+            neo4j_driver_1.isLocalTime,
+            neo4j_driver_1.isLocalDateTime,
+            neo4j_driver_1.isDuration,
+        ].some((tester) => tester(anything));
+    }
+    return false;
+};
+exports.isCypherTemporalType = isCypherTemporalType;
+const isCypherBasicPropertyType = (value) => {
+    const valType = typeof value;
+    return (value === null ||
+        valType === 'boolean' ||
+        valType === 'string' ||
+        valType === 'number' ||
+        valType === 'bigint' ||
+        value?.constructor === Int8Array ||
+        (0, neo4j_driver_1.isInt)(value) ||
+        (0, exports.isCypherTemporalType)(value) ||
+        (0, neo4j_driver_1.isPoint)(value));
+};
+exports.isCypherBasicPropertyType = isCypherBasicPropertyType;
+const isCypherPropertyType = (value) => {
+    if (Array.isArray(value)) {
+        if (value.length === 0) {
+            return true;
+        }
+        return (0, exports.isCypherBasicPropertyType)(value[0]);
+    }
+    return (0, exports.isCypherBasicPropertyType)(value);
+};
+exports.isCypherPropertyType = isCypherPropertyType;
+function isInt8Array(val) {
+    return (typeof val === 'object' && val !== null && val.constructor === Int8Array);
+}
+//# sourceMappingURL=cypher-data-types.js.map

package/dist/cjs/src/types/cypher-data-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cypher-data-types.js","sourceRoot":"","sources":["../../../../src/types/cypher-data-types.ts"],"names":[],"mappings":";;;AAoJA,kCAIC;AA3ID,+CASsB;AA+Ef,MAAM,oBAAoB,GAAG,CAClC,QAAiB,EACe,EAAE;IAClC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACtD,OAAO;YACL,qBAAM;YACN,qBAAM;YACN,yBAAU;YACV,0BAAW;YACX,8BAAe;YACf,yBAAU;SACX,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAdW,QAAA,oBAAoB,wBAc/B;AAEK,MAAM,yBAAyB,GAAG,CACvC,KAAc,EACoB,EAAE;IACpC,MAAM,OAAO,GAAG,OAAO,KAAK,CAAC;IAE7B,OAAO,CACL,KAAK,KAAK,IAAI;QACd,OAAO,KAAK,SAAS;QACrB,OAAO,KAAK,QAAQ;QACpB,OAAO,KAAK,QAAQ;QACpB,OAAO,KAAK,QAAQ;QACpB,KAAK,EAAE,WAAW,KAAK,SAAS;QAChC,IAAA,oBAAK,EAAC,KAAK,CAAC;QACZ,IAAA,4BAAoB,EAAC,KAAK,CAAC;QAC3B,IAAA,sBAAO,EAAC,KAAK,CAAC,CACf,CAAC;AACJ,CAAC,CAAC;AAhBW,QAAA,yBAAyB,6BAgBpC;AAEK,MAAM,oBAAoB,GAAG,CAClC,KAAc,EACW,EAAE;IAC3B,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,IAAA,iCAAyB,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO,IAAA,iCAAyB,EAAC,KAAK,CAAC,CAAC;AAC1C,CAAC,CAAC;AAXW,QAAA,oBAAoB,wBAW/B;AAEF,SAAgB,WAAW,CAAC,GAAY;IACtC,OAAO,CACL,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,CAAC,WAAW,KAAK,SAAS,CACzE,CAAC;AACJ,CAAC"}

package/dist/cjs/src/types/sdkTypes.d.ts

@@ -0,0 +1,17 @@
+import type { QueryConfig, ResultSummary } from 'neo4j-driver';
+export type DbType = 'system' | 'standard' | 'composite';
+export type QueryType = 'system' | 'user-direct' | 'user-action' | 'user-transpiled';
+export type CypherTransactionMetadata = {
+    app: 'neo4j-sdk';
+    type: QueryType;
+    version?: string;
+};
+export type ExtendedQueryConfig<T> = QueryConfig<T> & Required<Pick<QueryConfig<T>, 'routing' | 'resultTransformer'>>;
+type Result<T> = T & {
+    summary: ResultSummary;
+};
+export type ExecuteQueryArgs<T> = {
+    query: string;
+    queryConfig: ExtendedQueryConfig<Result<T>>;
+};
+export {};

package/dist/cjs/src/types/sdkTypes.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=sdkTypes.js.map

package/dist/cjs/src/types/sdkTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdkTypes.js","sourceRoot":"","sources":["../../../../src/types/sdkTypes.ts"],"names":[],"mappings":""}