@dbos-inc/dbos-sdk 0.7.18-preview

package/dist/src/cloud-cli/utils.d.ts

@@ -0,0 +1,3 @@
+import { DBOSCloudCredentials } from "./login";
+export declare function getCloudCredentials(): DBOSCloudCredentials;
+//# sourceMappingURL=utils.d.ts.map

package/dist/src/cloud-cli/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/cloud-cli/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAe,MAAM,SAAS,CAAC;AAG5D,wBAAgB,mBAAmB,IAAI,oBAAoB,CAM1D"}

package/dist/src/cloud-cli/utils.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCloudCredentials = void 0;
+const login_1 = require("./login");
+const fs_1 = __importDefault(require("fs"));
+function getCloudCredentials() {
+    const userCredentials = JSON.parse(fs_1.default.readFileSync(`./${login_1.dbosEnvPath}/credentials`).toString("utf-8"));
+    return {
+        userName: userCredentials.userName,
+        token: userCredentials.token.replace(/\r|\n/g, ""), // Trim the trailing /r /n.
+    };
+}
+exports.getCloudCredentials = getCloudCredentials;
+//# sourceMappingURL=utils.js.map

package/dist/src/cloud-cli/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/cloud-cli/utils.ts"],"names":[],"mappings":";;;;;;AAAA,mCAA4D;AAC5D,4CAAoB;AAEpB,SAAgB,mBAAmB;IACjC,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,YAAE,CAAC,YAAY,CAAC,KAAK,mBAAW,cAAc,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAyB,CAAC;IAC9H,OAAO;QACL,QAAQ,EAAE,eAAe,CAAC,QAAQ;QAClC,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,EAAE,2BAA2B;KAChF,CAAC;AACJ,CAAC;AAND,kDAMC"}

package/dist/src/communicator.d.ts

@@ -0,0 +1,24 @@
+import { Span } from "@opentelemetry/sdk-trace-base";
+import { WinstonLogger as Logger } from "./telemetry/logs";
+import { WorkflowContextImpl } from "./workflow";
+import { DBOSContext, DBOSContextImpl } from "./context";
+export type Communicator<T extends any[], R> = (ctxt: CommunicatorContext, ...args: T) => Promise<R>;
+export interface CommunicatorConfig {
+    retriesAllowed?: boolean;
+    intervalSeconds?: number;
+    maxAttempts?: number;
+    backoffRate?: number;
+}
+export interface CommunicatorContext extends DBOSContext {
+    readonly retriesAllowed: boolean;
+    readonly maxAttempts: number;
+}
+export declare class CommunicatorContextImpl extends DBOSContextImpl implements CommunicatorContext {
+    readonly functionID: number;
+    readonly retriesAllowed: boolean;
+    readonly intervalSeconds: number;
+    readonly maxAttempts: number;
+    readonly backoffRate: number;
+    constructor(workflowContext: WorkflowContextImpl, functionID: number, span: Span, logger: Logger, params: CommunicatorConfig, commName: string);
+}
+//# sourceMappingURL=communicator.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"communicator.d.ts","sourceRoot":"","sources":["../../src/communicator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,+BAA+B,CAAC;AACrD,OAAO,EAAE,aAAa,IAAI,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAGzD,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,mBAAmB,EAAE,GAAG,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;AAErG,MAAM,WAAW,kBAAkB;IACjC,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,mBAAoB,SAAQ,WAAW;IAEtD,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC;IACjC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED,qBAAa,uBAAwB,SAAQ,eAAgB,YAAW,mBAAmB;IAEzF,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC;IACjC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;gBAGjB,eAAe,EAAE,mBAAmB,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,QAAQ,EAAE,MAAM;CAY/I"}

package/dist/src/communicator.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommunicatorContextImpl = void 0;
+const context_1 = require("./context");
+class CommunicatorContextImpl extends context_1.DBOSContextImpl {
+    functionID;
+    retriesAllowed;
+    intervalSeconds;
+    maxAttempts;
+    backoffRate;
+    // TODO: Validate the parameters.
+    constructor(workflowContext, functionID, span, logger, params, commName) {
+        super(commName, span, logger, workflowContext);
+        this.functionID = functionID;
+        this.retriesAllowed = params.retriesAllowed ?? true;
+        this.intervalSeconds = params.intervalSeconds ?? 1;
+        this.maxAttempts = params.maxAttempts ?? 3;
+        this.backoffRate = params.backoffRate ?? 2;
+        if (workflowContext.applicationConfig) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            this.applicationConfig = workflowContext.applicationConfig;
+        }
+    }
+}
+exports.CommunicatorContextImpl = CommunicatorContextImpl;
+//# sourceMappingURL=communicator.js.map

package/dist/src/communicator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"communicator.js","sourceRoot":"","sources":["../../src/communicator.ts"],"names":[],"mappings":";;;AAGA,uCAAyD;AAkBzD,MAAa,uBAAwB,SAAQ,yBAAe;IAEjD,UAAU,CAAS;IACnB,cAAc,CAAU;IACxB,eAAe,CAAS;IACxB,WAAW,CAAS;IACpB,WAAW,CAAS;IAE7B,iCAAiC;IACjC,YAAY,eAAoC,EAAE,UAAkB,EAAE,IAAU,EAAE,MAAc,EAAE,MAA0B,EAAE,QAAgB;QAC5I,KAAK,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC;QAC/C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,IAAI,IAAI,CAAC;QACpD,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,IAAI,CAAC,CAAC;QACnD,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,IAAI,CAAC,CAAC;QAC3C,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,IAAI,CAAC,CAAC;QAC3C,IAAI,eAAe,CAAC,iBAAiB,EAAE;YACrC,mEAAmE;YAClE,IAAI,CAAC,iBAAiB,GAAG,eAAe,CAAC,iBAAiB,CAAC;SAC7D;IACH,CAAC;CACF;AArBD,0DAqBC"}

package/dist/src/context.d.ts

@@ -0,0 +1,60 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Span } from "@opentelemetry/sdk-trace-base";
+import { WinstonLogger as Logger, Logger as DBOSLogger } from "./telemetry/logs";
+import { IncomingHttpHeaders } from "http";
+import { ParsedUrlQuery } from "querystring";
+import { DBOSExecutor } from "./dbos-executor";
+export interface HTTPRequest {
+    readonly headers?: IncomingHttpHeaders;
+    readonly rawHeaders?: string[];
+    readonly params?: unknown;
+    readonly body?: unknown;
+    readonly rawBody?: string;
+    readonly query?: ParsedUrlQuery;
+    readonly querystring?: string;
+    readonly url?: string;
+    readonly ip?: string;
+}
+export interface DBOSContext {
+    readonly request: HTTPRequest;
+    readonly workflowUUID: string;
+    readonly authenticatedUser: string;
+    readonly authenticatedRoles: string[];
+    readonly assumedRole: string;
+    readonly logger: DBOSLogger;
+    readonly span: Span;
+    getConfig<T>(key: string): T | undefined;
+    getConfig<T>(key: string, defaultValue: T): T;
+}
+export declare class DBOSContextImpl implements DBOSContext {
+    readonly operationName: string;
+    readonly span: Span;
+    request: HTTPRequest;
+    authenticatedUser: string;
+    authenticatedRoles: string[];
+    assumedRole: string;
+    workflowUUID: string;
+    readonly logger: DBOSLogger;
+    constructor(operationName: string, span: Span, logger: Logger, parentCtx?: DBOSContextImpl);
+    /*** Application configuration ***/
+    applicationConfig?: any;
+    getConfig<T>(key: string): T | undefined;
+    getConfig<T>(key: string, defaultValue: T): T;
+}
+/**
+ * TODO : move logger and application, getConfig to a BaseContext which is at the root of all contexts
+ */
+export declare class InitContext {
+    readonly wfe: DBOSExecutor;
+    readonly logger: Logger;
+    private userDatabase;
+    private application;
+    constructor(wfe: DBOSExecutor);
+    createUserSchema(): Promise<void>;
+    dropUserSchema(): Promise<void>;
+    queryUserDB<R>(sql: string, ...params: unknown[]): Promise<R[]>;
+    getConfig<T>(key: string): T | undefined;
+    getConfig<T>(key: string, defaultValue: T): T;
+}
+//# sourceMappingURL=context.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../src/context.ts"],"names":[],"mappings":";;AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,+BAA+B,CAAC;AACrD,OAAO,EAAE,aAAa,IAAI,MAAM,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEjF,OAAO,EAAE,mBAAmB,EAAE,MAAM,MAAM,CAAC;AAC3C,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAI/C,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAC;IACvC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,cAAc,CAAC;IAChC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC;IAC9B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,EAAE,CAAC;IACtC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAE7B,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAEpB,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAAC;IACzC,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,GAAG,CAAC,CAAC;CAC/C;AAED,qBAAa,eAAgB,YAAW,WAAW;IAQrC,QAAQ,CAAC,aAAa,EAAE,MAAM;IAAE,QAAQ,CAAC,IAAI,EAAE,IAAI;IAP/D,OAAO,EAAE,WAAW,CAAM;IAC1B,iBAAiB,EAAE,MAAM,CAAM;IAC/B,kBAAkB,EAAE,MAAM,EAAE,CAAM;IAClC,WAAW,EAAE,MAAM,CAAM;IACzB,YAAY,EAAE,MAAM,CAAM;IAC1B,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;gBAEP,aAAa,EAAE,MAAM,EAAW,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,eAAe;IAW5G,mCAAmC;IAEnC,iBAAiB,CAAC,EAAE,GAAG,CAAC;IACxB,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IACxC,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,GAAG,CAAC;CAmB9C;AAGD;;GAEG;AACH,qBAAa,WAAW;IASV,QAAQ,CAAC,GAAG,EAAE,YAAY;IAPtC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAGxB,OAAO,CAAC,YAAY,CAAe;IAEnC,OAAO,CAAC,WAAW,CAAM;gBAEJ,GAAG,EAAE,YAAY;IAOtC,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAIjC,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAI/B,WAAW,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAK/D,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IACxC,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,GAAG,CAAC;CAmB9C"}

package/dist/src/context.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InitContext = exports.DBOSContextImpl = void 0;
+const logs_1 = require("./telemetry/logs");
+const lodash_1 = require("lodash");
+const error_1 = require("./error");
+class DBOSContextImpl {
+    operationName;
+    span;
+    request = {}; // Raw incoming HTTP request.
+    authenticatedUser = ""; // The user that has been authenticated
+    authenticatedRoles = []; // All roles the user has according to authentication
+    assumedRole = ""; // Role in use - that user has and provided authorization to current function
+    workflowUUID = ""; // Workflow UUID. Empty for HandlerContexts.
+    logger; // Wrapper around the global logger for this context.
+    constructor(operationName, span, logger, parentCtx) {
+        this.operationName = operationName;
+        this.span = span;
+        this.logger = new logs_1.Logger(logger, this);
+        if (parentCtx) {
+            this.request = parentCtx.request;
+            this.authenticatedUser = parentCtx.authenticatedUser;
+            this.authenticatedRoles = parentCtx.authenticatedRoles;
+            this.assumedRole = parentCtx.assumedRole;
+            this.workflowUUID = parentCtx.workflowUUID;
+        }
+    }
+    /*** Application configuration ***/
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    applicationConfig;
+    getConfig(key, defaultValue) {
+        // If there is no application config at all, or the key is missing, return the default value or undefined.
+        if (!this.applicationConfig || !(0, lodash_1.has)(this.applicationConfig, key)) {
+            if (defaultValue) {
+                return defaultValue;
+            }
+            return undefined;
+        }
+        // If the key is found and the default value is provided, check whether the value is of the same type.
+        // 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;
+    }
+}
+exports.DBOSContextImpl = DBOSContextImpl;
+/**
+ * TODO : move logger and application, getConfig to a BaseContext which is at the root of all contexts
+ */
+class InitContext {
+    wfe;
+    logger;
+    // All private Not exposed
+    userDatabase;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    application;
+    constructor(wfe) {
+        this.wfe = wfe;
+        this.logger = wfe.logger;
+        this.userDatabase = wfe.userDatabase;
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        this.application = wfe.config.application;
+    }
+    createUserSchema() {
+        return this.userDatabase.createSchema();
+    }
+    dropUserSchema() {
+        return this.userDatabase.dropSchema();
+    }
+    queryUserDB(sql, ...params) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        return this.userDatabase.query(sql, ...params);
+    }
+    getConfig(key, defaultValue) {
+        // If there is no application config at all, or the key is missing, return the default value or undefined.
+        if (!this.application || !(0, lodash_1.has)(this.application, key)) {
+            if (defaultValue) {
+                return defaultValue;
+            }
+            return undefined;
+        }
+        // If the key is found and the default value is provided, check whether the value is of the same type.
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        const value = (0, lodash_1.get)(this.wfe.config.application, key);
+        if (defaultValue && typeof value !== typeof defaultValue) {
+            throw new error_1.DBOSConfigKeyTypeError(key, typeof defaultValue, typeof value);
+        }
+        return value;
+    }
+}
+exports.InitContext = InitContext;
+//# sourceMappingURL=context.js.map

package/dist/src/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/context.ts"],"names":[],"mappings":";;;AACA,2CAAiF;AACjF,mCAAkC;AAKlC,mCAAiD;AA6BjD,MAAa,eAAe;IAQL;IAAgC;IAPrD,OAAO,GAAgB,EAAE,CAAC,CAAU,6BAA6B;IACjE,iBAAiB,GAAW,EAAE,CAAC,CAAK,uCAAuC;IAC3E,kBAAkB,GAAa,EAAE,CAAC,CAAE,qDAAqD;IACzF,WAAW,GAAW,EAAE,CAAC,CAAW,6EAA6E;IACjH,YAAY,GAAW,EAAE,CAAC,CAAU,4CAA4C;IACvE,MAAM,CAAa,CAAM,qDAAqD;IAEvF,YAAqB,aAAqB,EAAW,IAAU,EAAE,MAAc,EAAE,SAA2B;QAAvF,kBAAa,GAAb,aAAa,CAAQ;QAAW,SAAI,GAAJ,IAAI,CAAM;QAC7D,IAAI,CAAC,MAAM,GAAG,IAAI,aAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC3C,IAAI,SAAS,EAAE;YACb,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC;YACjC,IAAI,CAAC,iBAAiB,GAAG,SAAS,CAAC,iBAAiB,CAAC;YACrD,IAAI,CAAC,kBAAkB,GAAG,SAAS,CAAC,kBAAkB,CAAC;YACvD,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC,WAAW,CAAC;YACzC,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC,YAAY,CAAC;SAC5C;IACH,CAAC;IAED,mCAAmC;IACnC,8DAA8D;IAC9D,iBAAiB,CAAO;IAGxB,SAAS,CAAI,GAAW,EAAE,YAAgB;QACxC,0GAA0G;QAC1G,IAAI,CAAC,IAAI,CAAC,iBAAiB,IAAI,CAAC,IAAA,YAAG,EAAC,IAAI,CAAC,iBAAiB,EAAE,GAAG,CAAC,EAAE;YAChE,IAAI,YAAY,EAAE;gBAChB,OAAO,YAAY,CAAC;aACrB;YACD,OAAO,SAAS,CAAC;SAClB;QAED,sGAAsG;QACtG,mEAAmE;QACnE,MAAM,KAAK,GAAG,IAAA,YAAG,EAAC,IAAI,CAAC,iBAAiB,EAAE,GAAG,CAAC,CAAC;QAC/C,IAAI,YAAY,IAAI,OAAO,KAAK,KAAK,OAAO,YAAY,EAAE;YACxD,MAAM,IAAI,8BAAsB,CAAC,GAAG,EAAE,OAAO,YAAY,EAAE,OAAO,KAAK,CAAC,CAAC;SAC1E;QAED,OAAO,KAAU,CAAC;IACpB,CAAC;CACF;AA1CD,0CA0CC;AAGD;;GAEG;AACH,MAAa,WAAW;IASD;IAPZ,MAAM,CAAS;IAExB,0BAA0B;IAClB,YAAY,CAAe;IACnC,8DAA8D;IACtD,WAAW,CAAM;IAEzB,YAAqB,GAAiB;QAAjB,QAAG,GAAH,GAAG,CAAc;QACpC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QACzB,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC;QACrC,mEAAmE;QACnE,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC;IAC5C,CAAC;IAED,gBAAgB;QACd,OAAO,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,CAAC;IAC1C,CAAC;IAED,cAAc;QACZ,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC;IACxC,CAAC;IAED,WAAW,CAAI,GAAW,EAAE,GAAG,MAAiB;QAC9C,iEAAiE;QACjE,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,CAAC;IACjD,CAAC;IAID,SAAS,CAAI,GAAW,EAAE,YAAgB;QACxC,0GAA0G;QAC1G,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAA,YAAG,EAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,EAAE;YACpD,IAAI,YAAY,EAAE;gBAChB,OAAO,YAAY,CAAC;aACrB;YACD,OAAO,SAAS,CAAC;SAClB;QAED,sGAAsG;QACtG,mEAAmE;QACnE,MAAM,KAAK,GAAG,IAAA,YAAG,EAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;QACpD,IAAI,YAAY,IAAI,OAAO,KAAK,KAAK,OAAO,YAAY,EAAE;YACxD,MAAM,IAAI,8BAAsB,CAAC,GAAG,EAAE,OAAO,YAAY,EAAE,OAAO,KAAK,CAAC,CAAC;SAC1E;QAED,OAAO,KAAU,CAAC;IACpB,CAAC;CACF;AAjDD,kCAiDC"}

package/dist/src/data_validation.d.ts

@@ -0,0 +1,3 @@
+import { MethodRegistrationBase } from "./decorators";
+export declare function validateMethodArgs<Args extends unknown[]>(methReg: MethodRegistrationBase, args: Args): Args;
+//# sourceMappingURL=data_validation.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"data_validation.d.ts","sourceRoot":"","sources":["../../src/data_validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAsB,MAAM,cAAc,CAAC;AAI1E,wBAAgB,kBAAkB,CAAC,IAAI,SAAS,OAAO,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE,IAAI,EAAE,IAAI,QA4KrG"}

package/dist/src/data_validation.js

@@ -0,0 +1,168 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateMethodArgs = void 0;
+const decorators_1 = require("./decorators");
+const error_1 = require("./error");
+function validateMethodArgs(methReg, args) {
+    let opCtx = undefined;
+    const validationError = (msg) => {
+        const err = new error_1.DBOSDataValidationError(msg);
+        opCtx?.span.addEvent("DataValidationError", { message: err.message });
+        return err;
+    };
+    // Input validation
+    methReg.args.forEach((argDescriptor, idx) => {
+        if (idx === 0) {
+            // Context, may find a more robust way.
+            opCtx = args[idx];
+            return;
+        }
+        // Do we have an arg at all
+        if (idx >= args.length) {
+            if (argDescriptor.required === decorators_1.ArgRequiredOptions.REQUIRED ||
+                argDescriptor.required === decorators_1.ArgRequiredOptions.DEFAULT && methReg.defaults?.defaultArgRequired === decorators_1.ArgRequiredOptions.REQUIRED) {
+                throw validationError(`Insufficient number of arguments calling ${methReg.name} - ${args.length}/${methReg.args.length}`);
+            }
+            return;
+        }
+        let argValue = args[idx];
+        // So... there is such a thing as "undefined", and another thing called "null"
+        // We will fold this to "undefined" for our APIs.  It's just a rule of ours.
+        if (argValue === null) {
+            argValue = undefined;
+            args[idx] = undefined;
+        }
+        if (argValue === undefined && (argDescriptor.required === decorators_1.ArgRequiredOptions.REQUIRED ||
+            (argDescriptor.required === decorators_1.ArgRequiredOptions.DEFAULT && methReg.defaults?.defaultArgRequired === decorators_1.ArgRequiredOptions.REQUIRED))) {
+            throw validationError(`Missing required argument ${argDescriptor.name} of ${methReg.name}`);
+        }
+        if (argValue === undefined) {
+            return;
+        }
+        if (argValue instanceof String) {
+            argValue = argValue.toString();
+            args[idx] = argValue;
+        }
+        if (argValue instanceof Boolean) {
+            argValue = argValue.valueOf();
+            args[idx] = argValue;
+        }
+        if (argValue instanceof Number) {
+            argValue = argValue.valueOf();
+            args[idx] = argValue;
+        }
+        if (argValue instanceof BigInt) { // ES2020+
+            argValue = argValue.valueOf();
+            args[idx] = argValue;
+        }
+        // Maybe look into https://www.npmjs.com/package/validator
+        //  We could support emails and other validations too with something like that...
+        if (argDescriptor.dataType.dataType === 'text' || argDescriptor.dataType.dataType === 'varchar') {
+            if ((typeof argValue !== 'string')) {
+                throw validationError(`Argument ${argDescriptor.name} of ${methReg.name} is marked as type '${argDescriptor.dataType.dataType}' and should be a string`);
+            }
+            if (argDescriptor.dataType.length > 0) {
+                if (argValue.length > argDescriptor.dataType.length) {
+                    throw validationError(`Argument ${argDescriptor.name} of ${methReg.name} is marked as type '${argDescriptor.dataType.dataType}' with maximum length ${argDescriptor.dataType.length} but has length ${argValue.length}`);
+                }
+            }
+        }
+        if (argDescriptor.dataType.dataType === 'boolean') {
+            if (typeof argValue !== 'boolean') {
+                if (typeof argValue == 'number') {
+                    if (argValue === 0 || argValue === 1) {
+                        argValue = (argValue != 0 ? true : false);
+                        args[idx] = argValue;
+                    }
+                    else {
+                        throw validationError(`Argument ${argDescriptor.name} of ${methReg.name} is marked as type '${argDescriptor.dataType.dataType}' and may be a number (0 or 1) convertible to boolean, but was ${argValue}.`);
+                    }
+                }
+                else if (typeof argValue == 'string') {
+                    if (argValue.toLowerCase() === 't' || argValue.toLowerCase() === 'true' || argValue === '1') {
+                        argValue = true;
+                        args[idx] = argValue;
+                    }
+                    else if (argValue.toLowerCase() === 'f' || argValue.toLowerCase() === 'false' || argValue === '0') {
+                        argValue = false;
+                        args[idx] = argValue;
+                    }
+                    else {
+                        throw validationError(`Argument ${argDescriptor.name} of ${methReg.name} is marked as type '${argDescriptor.dataType.dataType}' and may be a string convertible to boolean, but was ${argValue}.`);
+                    }
+                }
+                else {
+                    throw validationError(`Argument ${argDescriptor.name} of ${methReg.name} is marked as type '${argDescriptor.dataType.dataType}' and should be a boolean`);
+                }
+            }
+        }
+        if (argDescriptor.dataType.dataType === 'decimal') {
+            // Range check precision and scale... wishing there was a bigdecimal
+            //  Floats don't really permit us to check the scale.
+            if (typeof argValue !== 'number') {
+                throw validationError(`Argument ${argDescriptor.name} of ${methReg.name} is marked as type '${argDescriptor.dataType.dataType}' and should be a number`);
+            }
+            let prec = argDescriptor.dataType.precision;
+            if (prec > 0) {
+                if (argDescriptor.dataType.scale > 0) {
+                    prec = prec - argDescriptor.dataType.scale;
+                }
+                if (Math.abs(argValue) >= Math.exp(prec)) {
+                    throw validationError(`Argument ${argDescriptor.name} of ${methReg.name} is out of range for type '${argDescriptor.dataType.formatAsString()}`);
+                }
+            }
+        }
+        if (argDescriptor.dataType.dataType === 'double' || argDescriptor.dataType.dataType === 'integer') {
+            if (typeof argValue !== 'number') {
+                if (typeof argValue === 'string') {
+                    const n = parseFloat(argValue);
+                    if (isNaN(n)) {
+                        throw validationError(`Argument ${argDescriptor.name} of ${methReg.name} is marked as type '${argDescriptor.dataType.dataType}' and should be a number`);
+                    }
+                    argValue = n;
+                    args[idx] = argValue;
+                }
+                else if (typeof argValue === 'bigint') {
+                    // Hum, maybe we should allow bigint as a type, number won't even do 64-bit.
+                    argValue = Number(argValue).valueOf();
+                    args[idx] = argValue;
+                }
+                else {
+                    throw validationError(`Argument ${argDescriptor.name} of ${methReg.name} is marked as type '${argDescriptor.dataType.dataType}' and should be a number`);
+                }
+            }
+            if (argDescriptor.dataType.dataType === 'integer') {
+                if (!Number.isInteger(argValue)) {
+                    throw validationError(`Argument ${argDescriptor.name} of ${methReg.name} is marked as type '${argDescriptor.dataType.dataType}' but has a fractional part`);
+                }
+            }
+        }
+        if (argDescriptor.dataType.dataType === 'timestamp') {
+            if (!(argValue instanceof Date)) {
+                if (typeof argValue == 'string') {
+                    const d = Date.parse(argValue);
+                    if (isNaN(d)) {
+                        throw validationError(`Argument ${argDescriptor.name} of ${methReg.name} is marked as type '${argDescriptor.dataType.dataType}' but is a string that will not parse as Date`);
+                    }
+                    argValue = new Date(d);
+                    args[idx] = argValue;
+                }
+                else {
+                    throw validationError(`Argument ${argDescriptor.name} of ${methReg.name} is marked as type '${argDescriptor.dataType.dataType}' but is not a date or time`);
+                }
+            }
+        }
+        if (argDescriptor.dataType.dataType === 'uuid') {
+            // This validation is loose.  A tighter one would be:
+            // /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$/
+            // That matches UUID version 1-5.
+            if (!/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.test(String(argValue))) {
+                throw validationError(`Argument ${argDescriptor.name} of ${methReg.name} is marked as type '${argDescriptor.dataType.dataType}' but is not a valid UUID`);
+            }
+        }
+        // JSON can be anything.  We can validate it against a schema at some later version...
+    });
+    return args;
+}
+exports.validateMethodArgs = validateMethodArgs;
+//# sourceMappingURL=data_validation.js.map

package/dist/src/data_validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"data_validation.js","sourceRoot":"","sources":["../../src/data_validation.ts"],"names":[],"mappings":";;;AAAA,6CAA0E;AAE1E,mCAAkD;AAElD,SAAgB,kBAAkB,CAAyB,OAA+B,EAAE,IAAU;IAElG,IAAI,KAAK,GAAiC,SAAS,CAAC;IAEpD,MAAM,eAAe,GAAG,CAAC,GAAU,EAAE,EAAE;QACnC,MAAM,GAAG,GAAG,IAAI,+BAAuB,CAAC,GAAG,CAAC,CAAC;QAC7C,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,qBAAqB,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;QACtE,OAAO,GAAG,CAAC;IACf,CAAC,CAAA;IAED,mBAAmB;IACnB,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,GAAG,EAAE,EAAE;QACxC,IAAI,GAAG,KAAK,CAAC,EACb;YACE,uCAAuC;YACvC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAoB,CAAC;YACrC,OAAO;SACR;QAED,2BAA2B;QAC3B,IAAI,GAAG,IAAI,IAAI,CAAC,MAAM,EAAE;YACtB,IAAI,aAAa,CAAC,QAAQ,KAAK,+BAAkB,CAAC,QAAQ;gBACvD,aAAa,CAAC,QAAQ,KAAK,+BAAkB,CAAC,OAAO,IAAI,OAAO,CAAC,QAAQ,EAAE,kBAAkB,KAAK,+BAAkB,CAAC,QAAQ,EAChI;gBACE,MAAM,eAAe,CAAC,4CAA4C,OAAO,CAAC,IAAI,MAAM,IAAI,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;aAC3H;YACD,OAAO;SACR;QAED,IAAI,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;QAEzB,8EAA8E;QAC9E,4EAA4E;QAC5E,IAAI,QAAQ,KAAK,IAAI,EAAE;YACrB,QAAQ,GAAG,SAAS,CAAC;YACrB,IAAI,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;SACvB;QAED,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,aAAa,CAAC,QAAQ,KAAK,+BAAkB,CAAC,QAAQ;YACnF,CAAC,aAAa,CAAC,QAAQ,KAAK,+BAAkB,CAAC,OAAO,IAAI,OAAO,CAAC,QAAQ,EAAE,kBAAkB,KAAK,+BAAkB,CAAC,QAAQ,CAAC,CAAC,EAClI;YACE,MAAM,eAAe,CAAC,6BAA6B,aAAa,CAAC,IAAI,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;SAC7F;QACD,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,OAAO;SACR;QAED,IAAI,QAAQ,YAAY,MAAM,EAAE;YAC9B,QAAQ,GAAG,QAAQ,CAAC,QAAQ,EAAE,CAAC;YAC/B,IAAI,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;SACtB;QACD,IAAI,QAAQ,YAAY,OAAO,EAAE;YAC/B,QAAQ,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAA;YAC7B,IAAI,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;SACtB;QACD,IAAI,QAAQ,YAAY,MAAM,EAAE;YAC9B,QAAQ,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAA;YAC7B,IAAI,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;SACtB;QACD,IAAI,QAAQ,YAAY,MAAM,EAAE,EAAE,UAAU;YAC1C,QAAQ,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAA;YAC7B,IAAI,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;SACtB;QAED,0DAA0D;QAC1D,iFAAiF;QACjF,IAAI,aAAa,CAAC,QAAQ,CAAC,QAAQ,KAAK,MAAM,IAAI,aAAa,CAAC,QAAQ,CAAC,QAAQ,KAAK,SAAS,EAAE;YAC/F,IAAI,CAAC,OAAO,QAAQ,KAAK,QAAQ,CAAC,EAAE;gBAClC,MAAM,eAAe,CAAC,YAAY,aAAa,CAAC,IAAI,OAAO,OAAO,CAAC,IAAI,uBAAuB,aAAa,CAAC,QAAQ,CAAC,QAAQ,0BAA0B,CAAC,CAAC;aAC1J;YACD,IAAI,aAAa,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;gBACrC,IAAI,QAAQ,CAAC,MAAM,GAAG,aAAa,CAAC,QAAQ,CAAC,MAAM,EAAE;oBACnD,MAAM,eAAe,CAAC,YAAY,aAAa,CAAC,IAAI,OAAO,OAAO,CAAC,IAAI,uBAAuB,aAAa,CAAC,QAAQ,CAAC,QAAQ,yBAAyB,aAAa,CAAC,QAAQ,CAAC,MAAM,mBAAmB,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;iBAC1N;aACF;SACF;QACD,IAAI,aAAa,CAAC,QAAQ,CAAC,QAAQ,KAAK,SAAS,EAAE;YACjD,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE;gBACjC,IAAI,OAAO,QAAQ,IAAI,QAAQ,EAAE;oBAC/B,IAAI,QAAQ,KAAK,CAAC,IAAI,QAAQ,KAAK,CAAC,EAAE;wBACpC,QAAQ,GAAG,CAAC,QAAQ,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;wBAC1C,IAAI,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;qBACtB;yBACI;wBACH,MAAM,eAAe,CAAC,YAAY,aAAa,CAAC,IAAI,OAAO,OAAO,CAAC,IAAI,uBAAuB,aAAa,CAAC,QAAQ,CAAC,QAAQ,kEAAkE,QAAQ,GAAG,CAAC,CAAC;qBAC7M;iBACF;qBACI,IAAI,OAAO,QAAQ,IAAI,QAAQ,EAAE;oBACpC,IAAI,QAAQ,CAAC,WAAW,EAAE,KAAK,GAAG,IAAI,QAAQ,CAAC,WAAW,EAAE,KAAK,MAAM,IAAI,QAAQ,KAAK,GAAG,EAAE;wBAC3F,QAAQ,GAAG,IAAI,CAAC;wBAChB,IAAI,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;qBACtB;yBACI,IAAI,QAAQ,CAAC,WAAW,EAAE,KAAK,GAAG,IAAI,QAAQ,CAAC,WAAW,EAAE,KAAK,OAAO,IAAI,QAAQ,KAAK,GAAG,EAAE;wBACjG,QAAQ,GAAG,KAAK,CAAC;wBACjB,IAAI,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;qBACtB;yBACI;wBACH,MAAM,eAAe,CAAC,YAAY,aAAa,CAAC,IAAI,OAAO,OAAO,CAAC,IAAI,uBAAuB,aAAa,CAAC,QAAQ,CAAC,QAAQ,yDAAyD,QAAQ,GAAG,CAAC,CAAC;qBACpM;iBACF;qBACI;oBACH,MAAM,eAAe,CAAC,YAAY,aAAa,CAAC,IAAI,OAAO,OAAO,CAAC,IAAI,uBAAuB,aAAa,CAAC,QAAQ,CAAC,QAAQ,2BAA2B,CAAC,CAAC;iBAC3J;aACF;SACF;QACD,IAAI,aAAa,CAAC,QAAQ,CAAC,QAAQ,KAAK,SAAS,EAAE;YACjD,oEAAoE;YACpE,qDAAqD;YACrD,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;gBAChC,MAAM,eAAe,CAAC,YAAY,aAAa,CAAC,IAAI,OAAO,OAAO,CAAC,IAAI,uBAAuB,aAAa,CAAC,QAAQ,CAAC,QAAQ,0BAA0B,CAAC,CAAC;aAC1J;YACD,IAAI,IAAI,GAAG,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC;YAC5C,IAAI,IAAI,GAAG,CAAC,EAAE;gBACZ,IAAI,aAAa,CAAC,QAAQ,CAAC,KAAK,GAAG,CAAC,EAAE;oBACpC,IAAI,GAAG,IAAI,GAAG,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC;iBAC5C;gBACD,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;oBACxC,MAAM,eAAe,CAAC,YAAY,aAAa,CAAC,IAAI,OAAO,OAAO,CAAC,IAAI,8BAA8B,aAAa,CAAC,QAAQ,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;iBACjJ;aACF;SACF;QACD,IAAI,aAAa,CAAC,QAAQ,CAAC,QAAQ,KAAK,QAAQ,IAAI,aAAa,CAAC,QAAQ,CAAC,QAAQ,KAAK,SAAS,EAAE;YACjG,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;gBAChC,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;oBAChC,MAAM,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;oBAC/B,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE;wBACZ,MAAM,eAAe,CAAC,YAAY,aAAa,CAAC,IAAI,OAAO,OAAO,CAAC,IAAI,uBAAuB,aAAa,CAAC,QAAQ,CAAC,QAAQ,0BAA0B,CAAC,CAAC;qBAC1J;oBACD,QAAQ,GAAG,CAAC,CAAC;oBACb,IAAI,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;iBACtB;qBACI,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;oBACrC,4EAA4E;oBAC5E,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,CAAC;oBACtC,IAAI,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;iBACtB;qBACI;oBACH,MAAM,eAAe,CAAC,YAAY,aAAa,CAAC,IAAI,OAAO,OAAO,CAAC,IAAI,uBAAuB,aAAa,CAAC,QAAQ,CAAC,QAAQ,0BAA0B,CAAC,CAAC;iBAC1J;aACF;YACD,IAAI,aAAa,CAAC,QAAQ,CAAC,QAAQ,KAAK,SAAS,EAAE;gBACjD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE;oBAC/B,MAAM,eAAe,CAAC,YAAY,aAAa,CAAC,IAAI,OAAO,OAAO,CAAC,IAAI,uBAAuB,aAAa,CAAC,QAAQ,CAAC,QAAQ,6BAA6B,CAAC,CAAC;iBAC7J;aACF;SACF;QACD,IAAI,aAAa,CAAC,QAAQ,CAAC,QAAQ,KAAK,WAAW,EAAE;YACnD,IAAI,CAAC,CAAC,QAAQ,YAAY,IAAI,CAAC,EAAE;gBAC/B,IAAI,OAAO,QAAQ,IAAI,QAAQ,EAAE;oBAC/B,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;oBAC/B,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE;wBACZ,MAAM,eAAe,CAAC,YAAY,aAAa,CAAC,IAAI,OAAO,OAAO,CAAC,IAAI,uBAAuB,aAAa,CAAC,QAAQ,CAAC,QAAQ,+CAA+C,CAAC,CAAC;qBAC/K;oBACD,QAAQ,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;oBACvB,IAAI,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC;iBACtB;qBACI;oBACH,MAAM,eAAe,CAAC,YAAY,aAAa,CAAC,IAAI,OAAO,OAAO,CAAC,IAAI,uBAAuB,aAAa,CAAC,QAAQ,CAAC,QAAQ,6BAA6B,CAAC,CAAC;iBAC7J;aACF;SACF;QACD,IAAI,aAAa,CAAC,QAAQ,CAAC,QAAQ,KAAK,MAAM,EAAE;YAC9C,qDAAqD;YACrD,+FAA+F;YAC/F,iCAAiC;YACjC,IAAI,CAAC,+EAA+E,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE;gBAC3G,MAAM,eAAe,CAAC,YAAY,aAAa,CAAC,IAAI,OAAO,OAAO,CAAC,IAAI,uBAAuB,aAAa,CAAC,QAAQ,CAAC,QAAQ,2BAA2B,CAAC,CAAC;aAC3J;SACF;QACD,sFAAsF;IAC1F,CAAC,CAAC,CAAC;IACH,OAAO,IAAI,CAAC;AAChB,CAAC;AA5KD,gDA4KC"}

package/dist/src/dbos-executor.d.ts

@@ -0,0 +1,79 @@
+/// <reference types="node" />
+import { Workflow, WorkflowConfig, WorkflowHandle, WorkflowParams } from './workflow';
+import { Transaction, TransactionConfig } from './transaction';
+import { CommunicatorConfig, Communicator } from './communicator';
+import { TelemetryCollector } from './telemetry/collector';
+import { Tracer } from './telemetry/traces';
+import { WinstonLogger as Logger } from './telemetry/logs';
+import { TelemetryConfig } from './telemetry';
+import { PoolConfig } from 'pg';
+import { SystemDatabase } from './system_database';
+import { UserDatabase, UserDatabaseName } from './user_database';
+import { MethodRegistrationBase } from './decorators';
+export interface DBOSNull {
+}
+export declare const dbosNull: DBOSNull;
+export interface DBOSConfig {
+    readonly poolConfig: PoolConfig;
+    readonly userDbclient?: UserDatabaseName;
+    readonly telemetry?: TelemetryConfig;
+    readonly system_database: string;
+    readonly observability_database?: string;
+    readonly application?: any;
+    readonly dbClientMetadata?: any;
+}
+interface WorkflowInfo<T extends any[], R> {
+    workflow: Workflow<T, R>;
+    config: WorkflowConfig;
+}
+export declare class DBOSExecutor {
+    #private;
+    readonly config: DBOSConfig;
+    initialized: boolean;
+    userDatabase: UserDatabase;
+    readonly systemDatabase: SystemDatabase;
+    readonly tempWorkflowName = "temp_workflow";
+    readonly workflowInfoMap: Map<string, WorkflowInfo<any, any>>;
+    readonly transactionConfigMap: Map<string, TransactionConfig>;
+    readonly communicatorConfigMap: Map<string, CommunicatorConfig>;
+    readonly topicConfigMap: Map<string, string[]>;
+    readonly registeredOperations: Array<MethodRegistrationBase>;
+    readonly initialEpochTimeMs: number;
+    readonly pendingWorkflowMap: Map<string, Promise<unknown>>;
+    readonly telemetryCollector: TelemetryCollector;
+    readonly flushBufferIntervalMs: number;
+    readonly flushBufferID: NodeJS.Timeout;
+    static readonly defaultNotificationTimeoutSec = 60;
+    readonly logger: Logger;
+    readonly tracer: Tracer;
+    entities: Function[];
+    constructor(config: DBOSConfig, systemDatabase?: SystemDatabase);
+    configureDbClient(): void;
+    init(...classes: object[]): Promise<void>;
+    destroy(): Promise<void>;
+    workflow<T extends any[], R>(wf: Workflow<T, R>, params: WorkflowParams, ...args: T): Promise<WorkflowHandle<R>>;
+    internalWorkflow<T extends any[], R>(wf: Workflow<T, R>, params: WorkflowParams, callerUUID?: string, callerFunctionID?: number, ...args: T): Promise<WorkflowHandle<R>>;
+    transaction<T extends any[], R>(txn: Transaction<T, R>, params: WorkflowParams, ...args: T): Promise<R>;
+    external<T extends any[], R>(commFn: Communicator<T, R>, params: WorkflowParams, ...args: T): Promise<R>;
+    send<T extends NonNullable<any>>(destinationUUID: string, message: T, topic?: string, idempotencyKey?: string): Promise<void>;
+    /**
+     * Wait for a workflow to emit an event, then return its value.
+     */
+    getEvent<T extends NonNullable<any>>(workflowUUID: string, key: string, timeoutSeconds?: number): Promise<T | null>;
+    /**
+     * Retrieve a handle for a workflow UUID.
+     */
+    retrieveWorkflow<R>(workflowUUID: string): WorkflowHandle<R>;
+    /**
+     * A recovery process that by default runs during executor init time.
+     * It runs to completion all pending workflows that were executing when the previous executor failed.
+     */
+    recoverPendingWorkflows(executorIDs?: string[]): Promise<WorkflowHandle<any>[]>;
+    /**
+     * Periodically flush the workflow output buffer to the system database.
+     */
+    flushWorkflowStatusBuffer(): Promise<void>;
+    logRegisteredHTTPUrls(): void;
+}
+export {};
+//# sourceMappingURL=dbos-executor.d.ts.map

package/dist/src/dbos-executor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dbos-executor.d.ts","sourceRoot":"","sources":["../../src/dbos-executor.ts"],"names":[],"mappings":";AAOA,OAAO,EAEL,QAAQ,EACR,cAAc,EAEd,cAAc,EACd,cAAc,EAIf,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAElE,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAsB,aAAa,IAAI,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAChC,OAAO,EAAE,cAAc,EAA0B,MAAM,mBAAmB,CAAC;AAE3E,OAAO,EAGL,YAAY,EAEZ,gBAAgB,EAEjB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,sBAAsB,EAA6E,MAAM,cAAc,CAAC;AAMjI,MAAM,WAAW,QAAQ;CAAI;AAC7B,eAAO,MAAM,QAAQ,EAAE,QAAa,CAAC;AAGrC,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAChC,QAAQ,CAAC,YAAY,CAAC,EAAE,gBAAgB,CAAC;IACzC,QAAQ,CAAC,SAAS,CAAC,EAAE,eAAe,CAAC;IACrC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,sBAAsB,CAAC,EAAE,MAAM,CAAC;IACzC,QAAQ,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC;IAC3B,QAAQ,CAAC,gBAAgB,CAAC,EAAE,GAAG,CAAC;CACjC;AAED,UAAU,YAAY,CAAC,CAAC,SAAS,GAAG,EAAE,EAAE,CAAC;IACvC,QAAQ,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACzB,MAAM,EAAE,cAAc,CAAC;CACxB;AAED,qBAAa,YAAY;;IAwCX,QAAQ,CAAC,MAAM,EAAE,UAAU;IAvCvC,WAAW,EAAE,OAAO,CAAC;IAErB,YAAY,EAAE,YAAY,CAAmC;IAE7D,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;IAGxC,QAAQ,CAAC,gBAAgB,mBAAmB;IAE5C,QAAQ,CAAC,eAAe,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAU1D;IACH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAa;IAC1E,QAAQ,CAAC,qBAAqB,EAAE,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAa;IAC5E,QAAQ,CAAC,cAAc,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAa;IAC3D,QAAQ,CAAC,oBAAoB,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAM;IAClE,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IACpC,QAAQ,CAAC,kBAAkB,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAa;IAEvE,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAChD,QAAQ,CAAC,qBAAqB,EAAE,MAAM,CAAQ;IAC9C,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC,OAAO,CAAC;IAEvC,MAAM,CAAC,QAAQ,CAAC,6BAA6B,MAAM;IAEnD,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAExB,QAAQ,EAAE,QAAQ,EAAE,CAAK;gBAGJ,MAAM,EAAE,UAAU,EAAE,cAAc,CAAC,EAAE,cAAc;IA4BxE,iBAAiB;IAmEX,IAAI,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAmDzC,OAAO;IAuCP,QAAQ,CAAC,CAAC,SAAS,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAKhH,gBAAgB,CAAC,CAAC,SAAS,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAqExK,WAAW,CAAC,CAAC,SAAS,GAAG,EAAE,EAAE,CAAC,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IASvG,QAAQ,CAAC,CAAC,SAAS,GAAG,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IASxG,IAAI,CAAC,CAAC,SAAS,WAAW,CAAC,GAAG,CAAC,EAAE,eAAe,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IASnI;;OAEG;IACG,QAAQ,CAAC,CAAC,SAAS,WAAW,CAAC,GAAG,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,cAAc,GAAE,MAAmD,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAIrK;;OAEG;IACH,gBAAgB,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,GAAG,cAAc,CAAC,CAAC,CAAC;IAS5D;;;OAGG;IACG,uBAAuB,CAAC,WAAW,GAAE,MAAM,EAAc,GAAG,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;IA4ChG;;OAEG;IACG,yBAAyB;IAM/B,qBAAqB;CActB"}