@dbos-inc/dbos-sdk 0.7.18-preview

package/dist/src/testing/testing_runtime.js

@@ -0,0 +1,147 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestingRuntimeImpl = exports.createInternalTestRuntime = exports.createTestingRuntime = void 0;
+const context_1 = require("../context");
+const decorators_1 = require("../decorators");
+const error_1 = require("../error");
+const server_1 = require("../httpServer/server");
+const dbos_executor_1 = require("../dbos-executor");
+const config_1 = require("../dbos-runtime/config");
+const lodash_1 = require("lodash");
+const pg_1 = require("pg");
+/**
+ * Create a testing runtime. Warn: this function will drop the existing system DB and create a clean new one. Don't run tests against your production database!
+ */
+async function createTestingRuntime(userClasses, configFilePath = config_1.dbosConfigFilePath) {
+    const [dbosConfig] = (0, config_1.parseConfigFile)({ configfile: configFilePath });
+    // Drop system database. Testing runtime always uses Postgres for local testing.
+    const pgSystemClient = new pg_1.Client({
+        user: dbosConfig.poolConfig.user,
+        port: dbosConfig.poolConfig.port,
+        host: dbosConfig.poolConfig.host,
+        password: dbosConfig.poolConfig.password,
+        database: dbosConfig.poolConfig.database,
+    });
+    await pgSystemClient.connect();
+    await pgSystemClient.query(`DROP DATABASE IF EXISTS ${dbosConfig.system_database};`);
+    await pgSystemClient.end();
+    const otr = createInternalTestRuntime(userClasses, dbosConfig, undefined);
+    return otr;
+}
+exports.createTestingRuntime = createTestingRuntime;
+/**
+ * For internal unit tests which allows us to provide different system DB and control its behavior.
+ */
+async function createInternalTestRuntime(userClasses, testConfig, systemDB) {
+    const otr = new TestingRuntimeImpl();
+    await otr.init(userClasses, testConfig, systemDB);
+    return otr;
+}
+exports.createInternalTestRuntime = createInternalTestRuntime;
+/**
+ * This class provides a runtime to test Opeorn functions in unit tests.
+ */
+class TestingRuntimeImpl {
+    #server = null;
+    #applicationConfig = undefined;
+    /**
+     * Initialize the testing runtime by loading user functions specified in classes and using the specified config.
+     * This should be the first function call before any subsequent calls.
+     */
+    async init(userClasses, testConfig, systemDB) {
+        const dbosConfig = testConfig ? [testConfig] : (0, config_1.parseConfigFile)();
+        const dbosExec = new dbos_executor_1.DBOSExecutor(dbosConfig[0], systemDB);
+        await dbosExec.init(...userClasses);
+        this.#server = new server_1.DBOSHttpServer(dbosExec);
+        this.#applicationConfig = dbosExec.config.application;
+    }
+    /**
+     * Release resources after tests.
+     */
+    async destroy() {
+        await this.#server?.dbosExec.destroy();
+    }
+    getConfig(key, defaultValue) {
+        if (!this.#applicationConfig || !(0, lodash_1.has)(this.#applicationConfig, key)) {
+            if (defaultValue) {
+                return defaultValue;
+            }
+            return undefined;
+        }
+        // eslint-disable-next-line  @typescript-eslint/no-unsafe-assignment
+        const value = (0, lodash_1.get)(this.#applicationConfig, key);
+        if (defaultValue && typeof value !== typeof defaultValue) {
+            throw new error_1.DBOSConfigKeyTypeError(key, typeof defaultValue, typeof value);
+        }
+        return value;
+    }
+    /**
+     * Generate a proxy object for the provided class that wraps direct calls (i.e. OpClass.someMethod(param))
+     * to invoke workflows, transactions, and communicators;
+     */
+    invoke(object, workflowUUID, params) {
+        const dbosExec = this.getDBOSExec();
+        const ops = (0, decorators_1.getRegisteredOperations)(object);
+        const proxy = {};
+        // Creates a context to pass in necessary info.
+        const span = dbosExec.tracer.startSpan("test");
+        const oc = new context_1.DBOSContextImpl("test", span, dbosExec.logger);
+        oc.authenticatedUser = params?.authenticatedUser ?? "";
+        oc.request = params?.request ?? {};
+        oc.authenticatedRoles = params?.authenticatedRoles ?? [];
+        const wfParams = { workflowUUID: workflowUUID, parentCtx: oc };
+        for (const op of ops) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+            proxy[op.name] = op.txnConfig
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+                ? (...args) => dbosExec.transaction(op.registeredFunction, wfParams, ...args)
+                : op.workflowConfig
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+                    ? (...args) => dbosExec.workflow(op.registeredFunction, wfParams, ...args)
+                    : op.commConfig
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+                        ? (...args) => dbosExec.external(op.registeredFunction, wfParams, ...args)
+                        : undefined;
+        }
+        return proxy;
+    }
+    /**
+     * Return a request handler callback for node's native http/http2 server, which includes all registered HTTP endpoints.
+     */
+    getHandlersCallback() {
+        if (!this.#server) {
+            throw new error_1.DBOSError("Uninitialized testing runtime! Did you forget to call init() first?");
+        }
+        return this.#server.app.callback();
+    }
+    async send(destinationUUID, message, topic, idempotencyKey) {
+        return this.getDBOSExec().send(destinationUUID, message, topic, idempotencyKey);
+    }
+    async getEvent(workflowUUID, key, timeoutSeconds = dbos_executor_1.DBOSExecutor.defaultNotificationTimeoutSec) {
+        return this.getDBOSExec().getEvent(workflowUUID, key, timeoutSeconds);
+    }
+    retrieveWorkflow(workflowUUID) {
+        return this.getDBOSExec().retrieveWorkflow(workflowUUID);
+    }
+    async queryUserDB(sql, ...params) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        return this.getDBOSExec().userDatabase.query(sql, ...params);
+    }
+    async createUserSchema() {
+        return this.getDBOSExec().userDatabase.createSchema();
+    }
+    dropUserSchema() {
+        return this.getDBOSExec().userDatabase.dropSchema();
+    }
+    /**
+     * For internal tests use only -- return the workflow executor object.
+     */
+    getDBOSExec() {
+        if (!this.#server) {
+            throw new error_1.DBOSError("Uninitialized testing runtime! Did you forget to call init() first?");
+        }
+        return this.#server.dbosExec;
+    }
+}
+exports.TestingRuntimeImpl = TestingRuntimeImpl;
+//# sourceMappingURL=testing_runtime.js.map

package/dist/src/testing/testing_runtime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing_runtime.js","sourceRoot":"","sources":["../../../src/testing/testing_runtime.ts"],"names":[],"mappings":";;;AAGA,wCAA0D;AAC1D,8CAAwD;AACxD,oCAA6D;AAE7D,iDAAsD;AACtD,oDAA4D;AAC5D,mDAA6E;AAM7E,mCAAkC;AAClC,2BAA4B;AAE5B;;GAEG;AACI,KAAK,UAAU,oBAAoB,CAAC,WAAqB,EAAE,iBAAyB,2BAAkB;IAC3G,MAAM,CAAE,UAAU,CAAE,GAAG,IAAA,wBAAe,EAAC,EAAC,UAAU,EAAE,cAAc,EAAC,CAAC,CAAC;IAErE,gFAAgF;IAChF,MAAM,cAAc,GAAG,IAAI,WAAM,CAAC;QAChC,IAAI,EAAE,UAAU,CAAC,UAAU,CAAC,IAAI;QAChC,IAAI,EAAE,UAAU,CAAC,UAAU,CAAC,IAAI;QAChC,IAAI,EAAE,UAAU,CAAC,UAAU,CAAC,IAAI;QAChC,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC,QAAQ;QACxC,QAAQ,EAAE,UAAU,CAAC,UAAU,CAAC,QAAQ;KACzC,CAAC,CAAC;IACH,MAAM,cAAc,CAAC,OAAO,EAAE,CAAC;IAC/B,MAAM,cAAc,CAAC,KAAK,CAAC,2BAA2B,UAAU,CAAC,eAAe,GAAG,CAAC,CAAC;IACrF,MAAM,cAAc,CAAC,GAAG,EAAE,CAAC;IAE3B,MAAM,GAAG,GAAG,yBAAyB,CAAC,WAAW,EAAE,UAAU,EAAE,SAAS,CAAC,CAAA;IACzE,OAAO,GAAG,CAAC;AACb,CAAC;AAjBD,oDAiBC;AA2BD;;GAEG;AACI,KAAK,UAAU,yBAAyB,CAAC,WAAqB,EAAE,UAAsB,EAAE,QAAyB;IACtH,MAAM,GAAG,GAAG,IAAI,kBAAkB,EAAE,CAAC;IACrC,MAAM,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;IAClD,OAAO,GAAG,CAAC;AACb,CAAC;AAJD,8DAIC;AAED;;GAEG;AACH,MAAa,kBAAkB;IAC7B,OAAO,GAA0B,IAAI,CAAC;IACtC,kBAAkB,GAAY,SAAS,CAAC;IAExC;;;OAGG;IACH,KAAK,CAAC,IAAI,CAAC,WAAqB,EAAE,UAAuB,EAAE,QAAyB;QAClF,MAAM,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAA,wBAAe,GAAE,CAAC;QACjE,MAAM,QAAQ,GAAG,IAAI,4BAAY,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;QAC3D,MAAM,QAAQ,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC;QACpC,IAAI,CAAC,OAAO,GAAG,IAAI,uBAAc,CAAC,QAAQ,CAAC,CAAC;QAC5C,IAAI,CAAC,kBAAkB,GAAG,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC;IACxD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO;QACX,MAAM,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;IACzC,CAAC;IAOD,SAAS,CAAI,GAAW,EAAE,YAAgB;QACxC,IAAI,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,IAAA,YAAG,EAAC,IAAI,CAAC,kBAAkB,EAAE,GAAG,CAAC,EAAE;YAClE,IAAI,YAAY,EAAE;gBAChB,OAAO,YAAY,CAAC;aACrB;YACD,OAAO,SAAS,CAAC;SAClB;QAED,oEAAoE;QACpE,MAAM,KAAK,GAAG,IAAA,YAAG,EAAC,IAAI,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAC;QAChD,IAAI,YAAY,IAAI,OAAO,KAAK,KAAK,OAAO,YAAY,EAAE;YACxD,MAAM,IAAI,8BAAsB,CAAC,GAAG,EAAE,OAAO,YAAY,EAAE,OAAO,KAAK,CAAC,CAAC;SAC1E;QACD,OAAO,KAAU,CAAC;IACpB,CAAC;IAED;;;OAGG;IACH,MAAM,CAAmB,MAAS,EAAE,YAAqB,EAAE,MAA6B;QACtF,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACpC,MAAM,GAAG,GAAG,IAAA,oCAAuB,EAAC,MAAM,CAAC,CAAC;QAE5C,MAAM,KAAK,GAAQ,EAAE,CAAC;QAEtB,+CAA+C;QAC/C,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC/C,MAAM,EAAE,GAAG,IAAI,yBAAe,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC9D,EAAE,CAAC,iBAAiB,GAAG,MAAM,EAAE,iBAAiB,IAAI,EAAE,CAAC;QACvD,EAAE,CAAC,OAAO,GAAG,MAAM,EAAE,OAAO,IAAI,EAAE,CAAC;QACnC,EAAE,CAAC,kBAAkB,GAAG,MAAM,EAAE,kBAAkB,IAAI,EAAE,CAAC;QAEzD,MAAM,QAAQ,GAAmB,EAAE,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;QAC/E,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE;YACpB,sEAAsE;YACtE,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS;gBAC3B,iEAAiE;gBACjE,CAAC,CAAC,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC,kBAA6C,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;gBAC/G,CAAC,CAAC,EAAE,CAAC,cAAc;oBACnB,iEAAiE;oBACjE,CAAC,CAAC,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,kBAA0C,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;oBACzG,CAAC,CAAC,EAAE,CAAC,UAAU;wBACf,iEAAiE;wBACjE,CAAC,CAAC,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,kBAA8C,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC;wBAC7G,CAAC,CAAC,SAAS,CAAC;SACf;QACD,OAAO,KAAuB,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,mBAAmB;QACjB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,MAAM,IAAI,iBAAS,CAAC,qEAAqE,CAAC,CAAC;SAC5F;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;IACrC,CAAC;IAED,KAAK,CAAC,IAAI,CAA6B,eAAuB,EAAE,OAAU,EAAE,KAAc,EAAE,cAAuB;QACjH,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,eAAe,EAAE,OAAO,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;IAClF,CAAC;IAED,KAAK,CAAC,QAAQ,CAA6B,YAAoB,EAAE,GAAW,EAAE,iBAAyB,4BAAY,CAAC,6BAA6B;QAC/I,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE,cAAc,CAAC,CAAC;IACxE,CAAC;IAED,gBAAgB,CAAI,YAAoB;QACtC,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;IAC3D,CAAC;IAED,KAAK,CAAC,WAAW,CAAI,GAAW,EAAE,GAAG,MAAa;QAChD,iEAAiE;QACjE,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED,KAAK,CAAC,gBAAgB;QACpB,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,YAAY,CAAC,YAAY,EAAE,CAAC;IACxD,CAAC;IAED,cAAc;QACZ,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC;IACtD,CAAC;IAED;;OAEG;IACH,WAAW;QACT,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,MAAM,IAAI,iBAAS,CAAC,qEAAqE,CAAC,CAAC;SAC5F;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC/B,CAAC;CACF;AA1HD,gDA0HC"}

package/dist/src/transaction.d.ts

@@ -0,0 +1,28 @@
+import { UserDatabaseName, UserDatabaseClient } from "./user_database";
+import { WorkflowContextImpl } from "./workflow";
+import { Span } from "@opentelemetry/sdk-trace-base";
+import { DBOSContext, DBOSContextImpl } from "./context";
+import { ValuesOf } from "./utils";
+import { WinstonLogger as Logger } from "./telemetry/logs";
+export type Transaction<T extends any[], R> = (ctxt: TransactionContext<any>, ...args: T) => Promise<R>;
+export interface TransactionConfig {
+    isolationLevel?: IsolationLevel;
+    readOnly?: boolean;
+}
+export declare const IsolationLevel: {
+    readonly ReadUncommitted: "READ UNCOMMITTED";
+    readonly ReadCommitted: "READ COMMITTED";
+    readonly RepeatableRead: "REPEATABLE READ";
+    readonly Serializable: "SERIALIZABLE";
+};
+export type IsolationLevel = ValuesOf<typeof IsolationLevel>;
+export interface TransactionContext<T extends UserDatabaseClient> extends DBOSContext {
+    readonly client: T;
+}
+export declare class TransactionContextImpl<T extends UserDatabaseClient> extends DBOSContextImpl implements TransactionContext<T> {
+    readonly clientKind: UserDatabaseName;
+    readonly client: T;
+    readonly functionID: number;
+    constructor(clientKind: UserDatabaseName, client: T, workflowContext: WorkflowContextImpl, span: Span, logger: Logger, functionID: number, operationName: string);
+}
+//# sourceMappingURL=transaction.d.ts.map

package/dist/src/transaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.d.ts","sourceRoot":"","sources":["../../src/transaction.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACvE,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,+BAA+B,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,aAAa,IAAI,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAG3D,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,kBAAkB,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;AAExG,MAAM,WAAW,iBAAiB;IAChC,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,eAAO,MAAM,cAAc;;;;;CAKjB,CAAC;AACX,MAAM,MAAM,cAAc,GAAG,QAAQ,CAAC,OAAO,cAAc,CAAC,CAAC;AAE7D,MAAM,WAAW,kBAAkB,CAAC,CAAC,SAAS,kBAAkB,CAAE,SAAQ,WAAW;IACnF,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;CACpB;AAED,qBAAa,sBAAsB,CAAC,CAAC,SAAS,kBAAkB,CAAE,SAAQ,eAAgB,YAAW,kBAAkB,CAAC,CAAC,CAAC;IAEtH,QAAQ,CAAC,UAAU,EAAE,gBAAgB;IACrC,QAAQ,CAAC,MAAM,EAAE,CAAC;IAIlB,QAAQ,CAAC,UAAU,EAAE,MAAM;gBALlB,UAAU,EAAE,gBAAgB,EAC5B,MAAM,EAAE,CAAC,EAClB,eAAe,EAAE,mBAAmB,EACpC,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,MAAM,EACL,UAAU,EAAE,MAAM,EAC3B,aAAa,EAAE,MAAM;CAQxB"}

package/dist/src/transaction.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionContextImpl = exports.IsolationLevel = void 0;
+const context_1 = require("./context");
+exports.IsolationLevel = {
+    ReadUncommitted: "READ UNCOMMITTED",
+    ReadCommitted: "READ COMMITTED",
+    RepeatableRead: "REPEATABLE READ",
+    Serializable: "SERIALIZABLE",
+};
+class TransactionContextImpl extends context_1.DBOSContextImpl {
+    clientKind;
+    client;
+    functionID;
+    constructor(clientKind, client, workflowContext, span, logger, functionID, operationName) {
+        super(operationName, span, logger, workflowContext);
+        this.clientKind = clientKind;
+        this.client = client;
+        this.functionID = functionID;
+        if (workflowContext.applicationConfig) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            this.applicationConfig = workflowContext.applicationConfig;
+        }
+    }
+}
+exports.TransactionContextImpl = TransactionContextImpl;
+//# sourceMappingURL=transaction.js.map

package/dist/src/transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.js","sourceRoot":"","sources":["../../src/transaction.ts"],"names":[],"mappings":";;;AAIA,uCAAyD;AAY5C,QAAA,cAAc,GAAG;IAC5B,eAAe,EAAE,kBAAkB;IACnC,aAAa,EAAE,gBAAgB;IAC/B,cAAc,EAAE,iBAAiB;IACjC,YAAY,EAAE,cAAc;CACpB,CAAC;AAOX,MAAa,sBAAqD,SAAQ,yBAAe;IAE5E;IACA;IAIA;IANX,YACW,UAA4B,EAC5B,MAAS,EAClB,eAAoC,EACpC,IAAU,EACV,MAAc,EACL,UAAkB,EAC3B,aAAqB;QAErB,KAAK,CAAC,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC;QAR3C,eAAU,GAAV,UAAU,CAAkB;QAC5B,WAAM,GAAN,MAAM,CAAG;QAIT,eAAU,GAAV,UAAU,CAAQ;QAI3B,IAAI,eAAe,CAAC,iBAAiB,EAAE;YACrC,mEAAmE;YACnE,IAAI,CAAC,iBAAiB,GAAG,eAAe,CAAC,iBAAiB,CAAC;SAC5D;IACH,CAAC;CACF;AAhBD,wDAgBC"}

package/dist/src/user_database.d.ts

@@ -0,0 +1,132 @@
+import { Pool, PoolConfig, PoolClient } from "pg";
+import { IsolationLevel, TransactionConfig } from "./transaction";
+import { ValuesOf } from "./utils";
+import { Knex } from "knex";
+export interface UserDatabase {
+    init(): Promise<void>;
+    destroy(): Promise<void>;
+    getName(): UserDatabaseName;
+    transaction<R, T extends unknown[]>(transactionFunction: UserDatabaseTransaction<R, T>, config: TransactionConfig, ...args: T): Promise<R>;
+    queryFunction<C extends UserDatabaseClient, R, T extends unknown[]>(queryFunction: UserDatabaseQuery<C, R, T>, ...params: T): Promise<R>;
+    query<R, T extends unknown[]>(sql: string, ...params: T): Promise<R[]>;
+    queryWithClient<R, T extends unknown[] = unknown[]>(client: UserDatabaseClient, sql: string, ...params: T): Promise<R[]>;
+    isRetriableTransactionError(error: unknown): boolean;
+    isKeyConflictError(error: unknown): boolean;
+    createSchema(): Promise<void>;
+    dropSchema(): Promise<void>;
+}
+type UserDatabaseQuery<C extends UserDatabaseClient, R, T extends unknown[]> = (ctxt: C, ...args: T) => Promise<R>;
+type UserDatabaseTransaction<R, T extends unknown[]> = (ctxt: UserDatabaseClient, ...args: T) => Promise<R>;
+export type UserDatabaseClient = PoolClient | PrismaClient | TypeORMEntityManager | Knex;
+export declare const UserDatabaseName: {
+    readonly PGNODE: "pg-node";
+    readonly PRISMA: "prisma";
+    readonly TYPEORM: "typeorm";
+    readonly KNEX: "knex";
+};
+export type UserDatabaseName = ValuesOf<typeof UserDatabaseName>;
+/**
+ * node-postgres user data access interface
+ */
+export declare class PGNodeUserDatabase implements UserDatabase {
+    readonly poolConfig: PoolConfig;
+    readonly pool: Pool;
+    constructor(poolConfig: PoolConfig);
+    init(): Promise<void>;
+    destroy(): Promise<void>;
+    getName(): "pg-node";
+    transaction<R, T extends unknown[]>(txn: UserDatabaseTransaction<R, T>, config: TransactionConfig, ...args: T): Promise<R>;
+    queryFunction<C extends UserDatabaseClient, R, T extends unknown[]>(func: UserDatabaseQuery<C, R, T>, ...args: T): Promise<R>;
+    query<R, T extends unknown[]>(sql: string, ...params: T): Promise<R[]>;
+    queryWithClient<R, T extends unknown[]>(client: UserDatabaseClient, sql: string, ...params: T): Promise<R[]>;
+    getPostgresErrorCode(error: unknown): string | null;
+    isRetriableTransactionError(error: unknown): boolean;
+    isKeyConflictError(error: unknown): boolean;
+    createSchema(): Promise<void>;
+    dropSchema(): Promise<void>;
+}
+/**
+ * Prisma user data access interface
+ */
+export interface PrismaClient {
+    $queryRawUnsafe<R, T extends unknown[]>(query: string, ...params: T): Promise<R[]>;
+    $transaction<R>(fn: (prisma: unknown) => Promise<R>, options?: {
+        maxWait?: number;
+        timeout?: number;
+        isolationLevel?: unknown;
+    }): Promise<R>;
+    $disconnect(): Promise<void>;
+}
+export declare class PrismaUserDatabase implements UserDatabase {
+    readonly prisma: PrismaClient;
+    constructor(prisma: PrismaClient);
+    init(): Promise<void>;
+    destroy(): Promise<void>;
+    getName(): "prisma";
+    transaction<R, T extends unknown[]>(transaction: UserDatabaseTransaction<R, T>, config: TransactionConfig, ...args: T): Promise<R>;
+    queryFunction<C extends UserDatabaseClient, R, T extends unknown[]>(func: UserDatabaseQuery<C, R, T>, ...args: T): Promise<R>;
+    query<R, T extends unknown[]>(sql: string, ...params: T): Promise<R[]>;
+    queryWithClient<R, T extends unknown[]>(client: UserDatabaseClient, sql: string, ...params: T): Promise<R[]>;
+    getPostgresErrorCode(error: unknown): string | null;
+    isRetriableTransactionError(error: unknown): boolean;
+    isKeyConflictError(error: unknown): boolean;
+    createSchema(): Promise<void>;
+    dropSchema(): Promise<void>;
+}
+export interface TypeORMDataSource {
+    readonly isInitialized: boolean;
+    readonly manager: TypeORMEntityManager;
+    initialize(): Promise<this>;
+    query<R = unknown>(query: string): Promise<R>;
+    destroy(): Promise<void>;
+    synchronize(): Promise<void>;
+    dropDatabase(): Promise<void>;
+}
+export interface TypeORMEntityManager {
+    query<R, T extends unknown[]>(query: string, parameters?: T): Promise<R>;
+    transaction<R>(isolationLevel: IsolationLevel, runinTransaction: (entityManager: TypeORMEntityManager) => Promise<R>): Promise<R>;
+}
+export interface QueryFailedError<T> {
+    driverError: T;
+}
+/**
+ * TypeORM user data access interface
+ */
+export declare class TypeORMDatabase implements UserDatabase {
+    readonly ds: TypeORMDataSource;
+    readonly dataSource: TypeORMDataSource;
+    constructor(ds: TypeORMDataSource);
+    init(): Promise<void>;
+    destroy(): Promise<void>;
+    getName(): "typeorm";
+    transaction<R, T extends unknown[]>(txn: UserDatabaseTransaction<R, T>, config: TransactionConfig, ...args: T): Promise<R>;
+    queryFunction<C extends UserDatabaseClient, R, T extends unknown[]>(func: UserDatabaseQuery<C, R, T>, ...args: T): Promise<R>;
+    query<R>(sql: string, ...params: unknown[]): Promise<R[]>;
+    queryWithClient<R, T extends unknown[]>(client: UserDatabaseClient, sql: string, ...params: T): Promise<R[]>;
+    getPostgresErrorCode(error: unknown): string | null;
+    isRetriableTransactionError(error: unknown): boolean;
+    isKeyConflictError(error: unknown): boolean;
+    createSchema(): Promise<void>;
+    dropSchema(): Promise<void>;
+}
+/**
+ * Knex user data access interface
+ */
+export declare class KnexUserDatabase implements UserDatabase {
+    readonly knex: Knex;
+    constructor(knex: Knex);
+    init(): Promise<void>;
+    destroy(): Promise<void>;
+    getName(): "knex";
+    transaction<R, T extends unknown[]>(transactionFunction: UserDatabaseTransaction<R, T>, config: TransactionConfig, ...args: T): Promise<R>;
+    queryFunction<C extends UserDatabaseClient, R, T extends unknown[]>(func: UserDatabaseQuery<C, R, T>, ...args: T): Promise<R>;
+    query<R, T extends unknown[]>(sql: string, ...params: T): Promise<R[]>;
+    queryWithClient<R, T extends unknown[]>(client: Knex, sql: string, ...uparams: T): Promise<R[]>;
+    getPostgresErrorCode(error: unknown): string | null;
+    isRetriableTransactionError(error: unknown): boolean;
+    isKeyConflictError(error: unknown): boolean;
+    createSchema(): Promise<void>;
+    dropSchema(): Promise<void>;
+}
+export {};
+//# sourceMappingURL=user_database.d.ts.map

package/dist/src/user_database.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user_database.d.ts","sourceRoot":"","sources":["../../src/user_database.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,EAAoC,MAAM,IAAI,CAAC;AAEpF,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAE5B,MAAM,WAAW,YAAY;IAC3B,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACtB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,OAAO,IAAI,gBAAgB,CAAC;IAG5B,WAAW,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EAAE,mBAAmB,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAE3I,aAAa,CAAC,CAAC,SAAS,kBAAkB,EAAE,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EAAE,aAAa,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAEzI,KAAK,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IAEvE,eAAe,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,GAAG,OAAO,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IAGzH,2BAA2B,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC;IAErD,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC;IAI5C,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9B,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7B;AAED,KAAK,iBAAiB,CAAC,CAAC,SAAS,kBAAkB,EAAE,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;AACnH,KAAK,uBAAuB,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,kBAAkB,EAAE,GAAG,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;AAE5G,MAAM,MAAM,kBAAkB,GAAG,UAAU,GAAG,YAAY,GAAG,oBAAoB,GAAG,IAAI,CAAC;AAEzF,eAAO,MAAM,gBAAgB;;;;;CAKnB,CAAC;AACX,MAAM,MAAM,gBAAgB,GAAG,QAAQ,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEjE;;GAEG;AACH,qBAAa,kBAAmB,YAAW,YAAY;IAGzC,QAAQ,CAAC,UAAU,EAAE,UAAU;IAF3C,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;gBAEC,UAAU,EAAE,UAAU;IAIrC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAKrB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAI9B,OAAO;IAID,WAAW,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EAAE,GAAG,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAoB1H,aAAa,CAAC,CAAC,SAAS,kBAAkB,EAAE,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAY7H,KAAK,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAMtE,eAAe,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAOlH,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI;IAKnD,2BAA2B,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAOpD,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IASrC,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAI7B,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;CAGlC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,eAAe,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IACnF,YAAY,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,cAAc,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAC7I,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9B;AAiBD,qBAAa,kBAAmB,YAAW,YAAY;IACzC,QAAQ,CAAC,MAAM,EAAE,YAAY;gBAApB,MAAM,EAAE,YAAY;IAEnC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAKrB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAI9B,OAAO;IAID,WAAW,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EAAE,WAAW,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAqBlI,aAAa,CAAC,CAAC,SAAS,kBAAkB,EAAE,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAI7H,KAAK,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAKtE,eAAe,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAMlH,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI;IAKnD,2BAA2B,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAIpD,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAMrC,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAI7B,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;CAGlC;AAED,MAAM,WAAW,iBAAiB;IAEhC,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;IAChC,QAAQ,CAAC,OAAO,EAAE,oBAAoB,CAAC;IACvC,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,KAAK,CAAC,CAAC,GAAG,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAC9C,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IACxE,WAAW,CAAC,CAAC,EAAE,cAAc,EAAE,cAAc,EAAE,gBAAgB,EAAE,CAAC,aAAa,EAAE,oBAAoB,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;CAClI;AAED,MAAM,WAAW,gBAAgB,CAAC,CAAC;IACjC,WAAW,EAAE,CAAC,CAAA;CACf;AAED;;GAEG;AACH,qBAAa,eAAgB,YAAW,YAAY;IAGtC,QAAQ,CAAC,EAAE,EAAE,iBAAiB;IAF1C,QAAQ,CAAC,UAAU,EAAE,iBAAiB,CAAC;gBAElB,EAAE,EAAE,iBAAiB;IAIpC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IASrB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAM9B,OAAO;IAID,WAAW,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EAAE,GAAG,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAW1H,aAAa,CAAC,CAAC,SAAS,kBAAkB,EAAE,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAI7H,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAMzD,eAAe,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAOlH,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI;IAUnD,2BAA2B,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAIpD,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAKrC,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAG7B,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;CAGlC;AAED;;GAEG;AACH,qBAAa,gBAAiB,YAAW,YAAY;IAEvC,QAAQ,CAAC,IAAI,EAAE,IAAI;gBAAV,IAAI,EAAE,IAAI;IAEzB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAKrB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAI9B,OAAO;IAID,WAAW,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EAAE,mBAAmB,EAAE,uBAAuB,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAqB1I,aAAa,CAAC,CAAC,SAAS,kBAAkB,EAAE,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAU7H,KAAK,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAKtE,eAAe,CAAC,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IASrG,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI;IAKnD,2BAA2B,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAIpD,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAMrC,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAI7B,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;CAGlC"}