@dbos-inc/dbos-sdk 0.7.18-preview

package/dist/src/error.js

@@ -0,0 +1,164 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DBOSConfigKeyTypeError = exports.DBOSUndefinedDecoratorInputError = exports.DBOSNotAuthorizedError = exports.DBOSResponseError = exports.DuplicateWorkflowEventError = exports.DBOSDataValidationError = exports.DBOSPostgresExporterError = exports.DBOSNotRegisteredError = exports.DBOSWorkflowConflictUUIDError = exports.DBOSTopicPermissionDeniedError = exports.DBOSInitializationError = exports.DBOSWorkflowPermissionDeniedError = exports.DBOSError = exports.isClientError = void 0;
+const pg_1 = require("pg");
+function formatPgDatabaseError(err) {
+    let msg = "";
+    if (err.severity) {
+        msg = msg.concat(`severity: ${err.severity} \n`);
+    }
+    if (err.code) {
+        msg = msg.concat(`code: ${err.code} \n`);
+    }
+    if (err.detail) {
+        msg = msg.concat(`detail: ${err.detail} \n`);
+    }
+    if (err.hint) {
+        msg = msg.concat(`hint: ${err.hint} \n`);
+    }
+    if (err.position) {
+        msg = msg.concat(`position: ${err.position} \n`);
+    }
+    if (err.internalPosition) {
+        msg = msg.concat(`internalPosition: ${err.internalPosition} \n`);
+    }
+    if (err.internalQuery) {
+        msg = msg.concat(`internalQuery: ${err.internalQuery} \n`);
+    }
+    if (err.where) {
+        msg = msg.concat(`where: ${err.where} \n`);
+    }
+    if (err.schema) {
+        msg = msg.concat(`schema: ${err.schema} \n`);
+    }
+    if (err.table) {
+        msg = msg.concat(`table: ${err.table} \n`);
+    }
+    if (err.column) {
+        msg = msg.concat(`column: ${err.column} \n`);
+    }
+    if (err.dataType) {
+        msg = msg.concat(`dataType: ${err.dataType} \n`);
+    }
+    if (err.constraint) {
+        msg = msg.concat(`constraint: ${err.constraint} \n`);
+    }
+    if (err.file) {
+        msg = msg.concat(`file: ${err.file} \n`);
+    }
+    if (err.line) {
+        msg = msg.concat(`line: ${err.line} \n`);
+    }
+    return msg;
+}
+// Return if the error is caused by client request or by server internal.
+function isClientError(dbosErrorCode) {
+    return (dbosErrorCode === DataValidationError) || (dbosErrorCode === WorkflowPermissionDeniedError) || (dbosErrorCode === TopicPermissionDeniedError) || (dbosErrorCode === ConflictingUUIDError) || (dbosErrorCode === NotRegisteredError);
+}
+exports.isClientError = isClientError;
+class DBOSError extends Error {
+    dbosErrorCode;
+    // TODO: define a better coding system.
+    constructor(msg, dbosErrorCode = 1) {
+        super(msg);
+        this.dbosErrorCode = dbosErrorCode;
+    }
+}
+exports.DBOSError = DBOSError;
+const WorkflowPermissionDeniedError = 2;
+class DBOSWorkflowPermissionDeniedError extends DBOSError {
+    constructor(runAs, workflowName) {
+        const msg = `Subject ${runAs} does not have permission to run workflow ${workflowName}`;
+        super(msg, WorkflowPermissionDeniedError);
+    }
+}
+exports.DBOSWorkflowPermissionDeniedError = DBOSWorkflowPermissionDeniedError;
+const InitializationError = 3;
+class DBOSInitializationError extends DBOSError {
+    constructor(msg) {
+        super(msg, InitializationError);
+    }
+}
+exports.DBOSInitializationError = DBOSInitializationError;
+const TopicPermissionDeniedError = 4;
+class DBOSTopicPermissionDeniedError extends DBOSError {
+    constructor(destinationUUID, workflowUUID, functionID, runAs) {
+        const msg = `Subject ${runAs} does not have permission on destination UUID ${destinationUUID}.` + `(workflow UUID: ${workflowUUID}, function ID: ${functionID})`;
+        super(msg, TopicPermissionDeniedError);
+    }
+}
+exports.DBOSTopicPermissionDeniedError = DBOSTopicPermissionDeniedError;
+const ConflictingUUIDError = 5;
+class DBOSWorkflowConflictUUIDError extends DBOSError {
+    constructor(workflowUUID) {
+        super(`Conflicting UUID ${workflowUUID}`, ConflictingUUIDError);
+    }
+}
+exports.DBOSWorkflowConflictUUIDError = DBOSWorkflowConflictUUIDError;
+const NotRegisteredError = 6;
+class DBOSNotRegisteredError extends DBOSError {
+    constructor(name) {
+        const msg = `Operation (Name: ${name}) not registered`;
+        super(msg, NotRegisteredError);
+    }
+}
+exports.DBOSNotRegisteredError = DBOSNotRegisteredError;
+const PostgresExporterError = 7;
+class DBOSPostgresExporterError extends DBOSError {
+    constructor(err) {
+        let msg = `PostgresExporter error: ${err.message} \n`;
+        if (err instanceof pg_1.DatabaseError) {
+            msg = msg.concat(formatPgDatabaseError(err));
+        }
+        super(msg, PostgresExporterError);
+    }
+}
+exports.DBOSPostgresExporterError = DBOSPostgresExporterError;
+const DataValidationError = 9;
+class DBOSDataValidationError extends DBOSError {
+    constructor(msg) {
+        super(msg, DataValidationError);
+    }
+}
+exports.DBOSDataValidationError = DBOSDataValidationError;
+const DuplicateWorkflowEvent = 10;
+class DuplicateWorkflowEventError extends DBOSError {
+    constructor(workflowUUID, key) {
+        super(`Workflow ${workflowUUID} has already emitted an event with key ${key}`, DuplicateWorkflowEvent);
+    }
+}
+exports.DuplicateWorkflowEventError = DuplicateWorkflowEventError;
+// This error is thrown by applications.
+const ResponseError = 11;
+class DBOSResponseError extends DBOSError {
+    status;
+    constructor(msg, status = 500) {
+        super(msg, ResponseError);
+        this.status = status;
+    }
+}
+exports.DBOSResponseError = DBOSResponseError;
+const NotAuthorizedError = 12;
+class DBOSNotAuthorizedError extends DBOSError {
+    status;
+    constructor(msg, status = 403) {
+        super(msg, NotAuthorizedError);
+        this.status = status;
+    }
+}
+exports.DBOSNotAuthorizedError = DBOSNotAuthorizedError;
+const UndefinedDecoratorInputError = 13;
+class DBOSUndefinedDecoratorInputError extends DBOSError {
+    constructor(decoratorName) {
+        super(`${decoratorName} received undefined input. Possible circular dependency?`, UndefinedDecoratorInputError);
+    }
+}
+exports.DBOSUndefinedDecoratorInputError = DBOSUndefinedDecoratorInputError;
+const ConfigKeyTypeError = 14;
+class DBOSConfigKeyTypeError extends DBOSError {
+    constructor(configKey, expectedType, actualType) {
+        super(`${configKey} should be of type ${expectedType}, but got ${actualType}`, ConfigKeyTypeError);
+    }
+}
+exports.DBOSConfigKeyTypeError = DBOSConfigKeyTypeError;
+//# sourceMappingURL=error.js.map

package/dist/src/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../src/error.ts"],"names":[],"mappings":";;;AAAA,2BAAmC;AAEnC,SAAS,qBAAqB,CAAC,GAAkB;IAC/C,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,IAAI,GAAG,CAAC,QAAQ,EAAE;QAChB,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,aAAa,GAAG,CAAC,QAAQ,KAAK,CAAC,CAAC;KAClD;IACD,IAAI,GAAG,CAAC,IAAI,EAAE;QACZ,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,IAAI,KAAK,CAAC,CAAC;KAC1C;IACD,IAAI,GAAG,CAAC,MAAM,EAAE;QACd,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,WAAW,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC;KAC9C;IACD,IAAI,GAAG,CAAC,IAAI,EAAE;QACZ,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,IAAI,KAAK,CAAC,CAAC;KAC1C;IACD,IAAI,GAAG,CAAC,QAAQ,EAAE;QAChB,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,aAAa,GAAG,CAAC,QAAQ,KAAK,CAAC,CAAC;KAClD;IACD,IAAI,GAAG,CAAC,gBAAgB,EAAE;QACxB,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,qBAAqB,GAAG,CAAC,gBAAgB,KAAK,CAAC,CAAC;KAClE;IACD,IAAI,GAAG,CAAC,aAAa,EAAE;QACrB,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,kBAAkB,GAAG,CAAC,aAAa,KAAK,CAAC,CAAC;KAC5D;IACD,IAAI,GAAG,CAAC,KAAK,EAAE;QACb,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,UAAU,GAAG,CAAC,KAAK,KAAK,CAAC,CAAC;KAC5C;IACD,IAAI,GAAG,CAAC,MAAM,EAAE;QACd,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,WAAW,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC;KAC9C;IACD,IAAI,GAAG,CAAC,KAAK,EAAE;QACb,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,UAAU,GAAG,CAAC,KAAK,KAAK,CAAC,CAAC;KAC5C;IACD,IAAI,GAAG,CAAC,MAAM,EAAE;QACd,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,WAAW,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC;KAC9C;IACD,IAAI,GAAG,CAAC,QAAQ,EAAE;QAChB,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,aAAa,GAAG,CAAC,QAAQ,KAAK,CAAC,CAAC;KAClD;IACD,IAAI,GAAG,CAAC,UAAU,EAAE;QAClB,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,eAAe,GAAG,CAAC,UAAU,KAAK,CAAC,CAAC;KACtD;IACD,IAAI,GAAG,CAAC,IAAI,EAAE;QACZ,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,IAAI,KAAK,CAAC,CAAC;KAC1C;IACD,IAAI,GAAG,CAAC,IAAI,EAAE;QACZ,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,IAAI,KAAK,CAAC,CAAC;KAC1C;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,yEAAyE;AACzE,SAAgB,aAAa,CAAC,aAAqB;IACjD,OAAO,CAAC,aAAa,KAAK,mBAAmB,CAAC,IAAI,CAAC,aAAa,KAAK,6BAA6B,CAAC,IAAI,CAAC,aAAa,KAAK,0BAA0B,CAAC,IAAI,CAAC,aAAa,KAAK,oBAAoB,CAAC,IAAI,CAAC,aAAa,KAAK,kBAAkB,CAAC,CAAC;AAC9O,CAAC;AAFD,sCAEC;AAED,MAAa,SAAU,SAAQ,KAAK;IAEA;IADlC,uCAAuC;IACvC,YAAY,GAAW,EAAW,gBAAwB,CAAC;QACzD,KAAK,CAAC,GAAG,CAAC,CAAC;QADqB,kBAAa,GAAb,aAAa,CAAY;IAE3D,CAAC;CACF;AALD,8BAKC;AAED,MAAM,6BAA6B,GAAG,CAAC,CAAC;AACxC,MAAa,iCAAkC,SAAQ,SAAS;IAC9D,YAAY,KAAa,EAAE,YAAoB;QAC7C,MAAM,GAAG,GAAG,WAAW,KAAK,6CAA6C,YAAY,EAAE,CAAC;QACxF,KAAK,CAAC,GAAG,EAAE,6BAA6B,CAAC,CAAC;IAC5C,CAAC;CACF;AALD,8EAKC;AAED,MAAM,mBAAmB,GAAG,CAAC,CAAC;AAC9B,MAAa,uBAAwB,SAAQ,SAAS;IACpD,YAAY,GAAW;QACrB,KAAK,CAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC;IAClC,CAAC;CACF;AAJD,0DAIC;AAED,MAAM,0BAA0B,GAAG,CAAC,CAAC;AACrC,MAAa,8BAA+B,SAAQ,SAAS;IAC3D,YAAY,eAAuB,EAAE,YAAoB,EAAE,UAAkB,EAAE,KAAa;QAC1F,MAAM,GAAG,GAAG,WAAW,KAAK,iDAAiD,eAAe,GAAG,GAAG,mBAAmB,YAAY,kBAAkB,UAAU,GAAG,CAAC;QACjK,KAAK,CAAC,GAAG,EAAE,0BAA0B,CAAC,CAAC;IACzC,CAAC;CACF;AALD,wEAKC;AAED,MAAM,oBAAoB,GAAG,CAAC,CAAC;AAC/B,MAAa,6BAA8B,SAAQ,SAAS;IAC1D,YAAY,YAAoB;QAC9B,KAAK,CAAC,oBAAoB,YAAY,EAAE,EAAE,oBAAoB,CAAC,CAAC;IAClE,CAAC;CACF;AAJD,sEAIC;AAED,MAAM,kBAAkB,GAAG,CAAC,CAAC;AAC7B,MAAa,sBAAuB,SAAQ,SAAS;IACnD,YAAY,IAAY;QACtB,MAAM,GAAG,GAAG,oBAAoB,IAAI,kBAAkB,CAAC;QACvD,KAAK,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC;IACjC,CAAC;CACF;AALD,wDAKC;AAED,MAAM,qBAAqB,GAAG,CAAC,CAAC;AAChC,MAAa,yBAA0B,SAAQ,SAAS;IACtD,YAAY,GAAU;QACpB,IAAI,GAAG,GAAG,2BAA2B,GAAG,CAAC,OAAO,KAAK,CAAC;QACtD,IAAI,GAAG,YAAY,kBAAa,EAAE;YAChC,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC;SAC9C;QACD,KAAK,CAAC,GAAG,EAAE,qBAAqB,CAAC,CAAC;IACpC,CAAC;CACF;AARD,8DAQC;AAED,MAAM,mBAAmB,GAAG,CAAC,CAAC;AAC9B,MAAa,uBAAwB,SAAQ,SAAS;IACpD,YAAY,GAAW;QACrB,KAAK,CAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC;IAClC,CAAC;CACF;AAJD,0DAIC;AAED,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAa,2BAA4B,SAAQ,SAAS;IACxD,YAAY,YAAoB,EAAE,GAAW;QAC3C,KAAK,CAAC,YAAY,YAAY,0CAA0C,GAAG,EAAE,EAAE,sBAAsB,CAAC,CAAC;IACzG,CAAC;CACF;AAJD,kEAIC;AAED,wCAAwC;AACxC,MAAM,aAAa,GAAG,EAAE,CAAC;AACzB,MAAa,iBAAkB,SAAQ,SAAS;IACZ;IAAlC,YAAY,GAAW,EAAW,SAAiB,GAAG;QACpD,KAAK,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QADM,WAAM,GAAN,MAAM,CAAc;IAEtD,CAAC;CACF;AAJD,8CAIC;AAED,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAa,sBAAuB,SAAQ,SAAS;IACjB;IAAlC,YAAY,GAAW,EAAW,SAAiB,GAAG;QACpD,KAAK,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC;QADC,WAAM,GAAN,MAAM,CAAc;IAEtD,CAAC;CACF;AAJD,wDAIC;AAED,MAAM,4BAA4B,GAAG,EAAE,CAAC;AACxC,MAAa,gCAAiC,SAAQ,SAAS;IAC7D,YAAY,aAAqB;QAC/B,KAAK,CAAC,GAAG,aAAa,0DAA0D,EAAE,4BAA4B,CAAC,CAAC;IAClH,CAAC;CACF;AAJD,4EAIC;AAED,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAa,sBAAuB,SAAQ,SAAS;IACnD,YAAY,SAAiB,EAAE,YAAoB,EAAE,UAAkB;QACrE,KAAK,CAAC,GAAG,SAAS,sBAAsB,YAAY,aAAa,UAAU,EAAE,EAAE,kBAAkB,CAAC,CAAC;IACrG,CAAC;CACF;AAJD,wDAIC"}

package/dist/src/httpServer/handler.d.ts

@@ -0,0 +1,62 @@
+import { MethodRegistration, MethodParameter, MethodRegistrationBase } from "../decorators";
+import { DBOSExecutor } from "../dbos-executor";
+import { DBOSContext, DBOSContextImpl } from "../context";
+import Koa from "koa";
+import { TailParameters, WorkflowHandle, WorkflowContext, WFInvokeFuncs } from "../workflow";
+import { W3CTraceContextPropagator } from "@opentelemetry/core";
+type WFFunc = (ctxt: WorkflowContext, ...args: any[]) => Promise<any>;
+export type InvokeFuncs<T> = WFInvokeFuncs<T> & HandlerWfFuncs<T>;
+type HandlerWfFuncs<T> = {
+    [P in keyof T as T[P] extends WFFunc ? P : never]: T[P] extends WFFunc ? (...args: TailParameters<T[P]>) => Promise<WorkflowHandle<Awaited<ReturnType<T[P]>>>> : never;
+};
+export interface HandlerContext extends DBOSContext {
+    readonly koaContext: Koa.Context;
+    invoke<T extends object>(targetClass: T, workflowUUID?: string): InvokeFuncs<T>;
+    retrieveWorkflow<R>(workflowUUID: string): WorkflowHandle<R>;
+    send<T extends NonNullable<any>>(destinationUUID: string, message: T, topic?: string, idempotencyKey?: string): Promise<void>;
+    getEvent<T extends NonNullable<any>>(workflowUUID: string, key: string, timeoutSeconds?: number): Promise<T | null>;
+}
+export declare class HandlerContextImpl extends DBOSContextImpl implements HandlerContext {
+    #private;
+    readonly koaContext: Koa.Context;
+    readonly W3CTraceContextPropagator: W3CTraceContextPropagator;
+    constructor(wfe: DBOSExecutor, koaContext: Koa.Context);
+    send<T extends NonNullable<any>>(destinationUUID: string, message: T, topic?: string, idempotencyKey?: string): Promise<void>;
+    getEvent<T extends NonNullable<any>>(workflowUUID: string, key: string, timeoutSeconds?: number): Promise<T | null>;
+    retrieveWorkflow<R>(workflowUUID: string): WorkflowHandle<R>;
+    /**
+     * Generate a proxy object for the provided class that wraps direct calls (i.e. OpClass.someMethod(param))
+     * to use WorkflowContext.Transaction(OpClass.someMethod, param);
+     */
+    invoke<T extends object>(object: T, workflowUUID?: string): InvokeFuncs<T>;
+}
+export declare enum APITypes {
+    GET = "GET",
+    POST = "POST"
+}
+export declare enum ArgSources {
+    DEFAULT = "DEFAULT",
+    BODY = "BODY",
+    QUERY = "QUERY",
+    URL = "URL"
+}
+export interface HandlerRegistrationBase extends MethodRegistrationBase {
+    apiType: APITypes;
+    apiURL: string;
+    args: HandlerParameter[];
+}
+export declare class HandlerRegistration<This, Args extends unknown[], Return> extends MethodRegistration<This, Args, Return> {
+    apiType: APITypes;
+    apiURL: string;
+    args: HandlerParameter[];
+    constructor(origFunc: (this: This, ...args: Args) => Promise<Return>);
+}
+export declare class HandlerParameter extends MethodParameter {
+    argSource: ArgSources;
+    constructor(idx: number, at: Function);
+}
+export declare function GetApi(url: string): <This, Ctx extends DBOSContext, Args extends unknown[], Return>(target: object, propertyKey: string, inDescriptor: TypedPropertyDescriptor<(this: This, ctx: Ctx, ...args: Args) => Promise<Return>>) => TypedPropertyDescriptor<(this: This, ctx: Ctx, ...args: Args) => Promise<Return>>;
+export declare function PostApi(url: string): <This, Ctx extends DBOSContext, Args extends unknown[], Return>(target: object, propertyKey: string, inDescriptor: TypedPropertyDescriptor<(this: This, ctx: Ctx, ...args: Args) => Promise<Return>>) => TypedPropertyDescriptor<(this: This, ctx: Ctx, ...args: Args) => Promise<Return>>;
+export declare function ArgSource(source: ArgSources): (target: object, propertyKey: string | symbol, parameterIndex: number) => void;
+export {};
+//# sourceMappingURL=handler.d.ts.map

package/dist/src/httpServer/handler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"handler.d.ts","sourceRoot":"","sources":["../../../src/httpServer/handler.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAA8D,sBAAsB,EAA2B,MAAM,eAAe,CAAC;AACjL,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,EAAY,cAAc,EAAE,cAAc,EAAkB,eAAe,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAEvH,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAMhE,KAAK,MAAM,GAAG,CAAC,IAAI,EAAE,eAAe,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;AACtE,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;AAElE,KAAK,cAAc,CAAC,CAAC,IAAI;KACtB,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK;CACvK,CAAA;AAED,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAC,OAAO,CAAC;IACjC,MAAM,CAAC,CAAC,SAAS,MAAM,EAAE,WAAW,EAAE,CAAC,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;IAChF,gBAAgB,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;IAC7D,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,CAAC;IAC9H,QAAQ,CAAC,CAAC,SAAS,WAAW,CAAC,GAAG,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;CACrH;AAED,qBAAa,kBAAmB,SAAQ,eAAgB,YAAW,cAAc;;IAIhD,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAC,OAAO;IAF/D,QAAQ,CAAC,yBAAyB,EAAE,yBAAyB,CAAC;gBAElD,GAAG,EAAE,YAAY,EAAW,UAAU,EAAE,GAAG,CAAC,OAAO;IA0CzD,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;IAI7H,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,gBAAgB,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,GAAG,cAAc,CAAC,CAAC,CAAC;IAI5D;;;OAGG;IACH,MAAM,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC;CAoC3E;AAMD,oBAAY,QAAQ;IAClB,GAAG,QAAQ;IACX,IAAI,SAAS;CACd;AAED,oBAAY,UAAU;IACpB,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,KAAK,UAAU;IACf,GAAG,QAAQ;CACZ;AAED,MAAM,WAAW,uBAAwB,SAAQ,sBAAsB;IACrE,OAAO,EAAE,QAAQ,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,gBAAgB,EAAE,CAAC;CAC1B;AAED,qBAAa,mBAAmB,CAAC,IAAI,EAAE,IAAI,SAAS,OAAO,EAAE,EAAE,MAAM,CAAE,SAAQ,kBAAkB,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC;IACnH,OAAO,EAAE,QAAQ,CAAgB;IACjC,MAAM,EAAE,MAAM,CAAM;IAEpB,IAAI,EAAE,gBAAgB,EAAE,CAAM;gBAClB,QAAQ,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,MAAM,CAAC;CAGrE;AAED,qBAAa,gBAAiB,SAAQ,eAAe;IACnD,SAAS,EAAE,UAAU,CAAsB;gBAG/B,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ;CAGtC;AAMD,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,2EAEtB,MAAM,eACD,MAAM,wLAWtB;AAED,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,2EAEvB,MAAM,eACD,MAAM,wLAWtB;AAMD,wBAAgB,SAAS,CAAC,MAAM,EAAE,UAAU,YACjB,MAAM,eAAe,MAAM,GAAG,MAAM,kBAAkB,MAAM,UAMtF"}

package/dist/src/httpServer/handler.js

@@ -0,0 +1,168 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArgSource = exports.PostApi = exports.GetApi = exports.HandlerParameter = exports.HandlerRegistration = exports.ArgSources = exports.APITypes = exports.HandlerContextImpl = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const decorators_1 = require("../decorators");
+const dbos_executor_1 = require("../dbos-executor");
+const context_1 = require("../context");
+const core_1 = require("@opentelemetry/core");
+const api_1 = require("@opentelemetry/api");
+class HandlerContextImpl extends context_1.DBOSContextImpl {
+    koaContext;
+    #wfe;
+    W3CTraceContextPropagator;
+    constructor(wfe, koaContext) {
+        // If present, retrieve the trace context from the request
+        const httpTracer = new core_1.W3CTraceContextPropagator();
+        const extractedSpanContext = api_1.trace.getSpanContext(httpTracer.extract(api_1.ROOT_CONTEXT, koaContext.request.headers, api_1.defaultTextMapGetter));
+        let span;
+        const spanAttributes = {
+            operationName: koaContext.url,
+        };
+        if (extractedSpanContext === undefined) {
+            span = wfe.tracer.startSpan(koaContext.url, spanAttributes);
+        }
+        else {
+            extractedSpanContext.isRemote = true;
+            span = wfe.tracer.startSpanWithContext(extractedSpanContext, koaContext.url, spanAttributes);
+        }
+        super(koaContext.url, span, wfe.logger);
+        this.koaContext = koaContext;
+        this.W3CTraceContextPropagator = httpTracer;
+        this.request = {
+            headers: koaContext.request.headers,
+            rawHeaders: koaContext.req.rawHeaders,
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            params: koaContext.params,
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            body: koaContext.request.body,
+            rawBody: koaContext.request.rawBody,
+            query: koaContext.request.query,
+            querystring: koaContext.request.querystring,
+            url: koaContext.request.url,
+            ip: koaContext.request.ip,
+        };
+        if (wfe.config.application) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            this.applicationConfig = wfe.config.application;
+        }
+        this.#wfe = wfe;
+    }
+    ///////////////////////
+    /* PUBLIC INTERFACE  */
+    ///////////////////////
+    async send(destinationUUID, message, topic, idempotencyKey) {
+        return this.#wfe.send(destinationUUID, message, topic, idempotencyKey);
+    }
+    async getEvent(workflowUUID, key, timeoutSeconds = dbos_executor_1.DBOSExecutor.defaultNotificationTimeoutSec) {
+        return this.#wfe.getEvent(workflowUUID, key, timeoutSeconds);
+    }
+    retrieveWorkflow(workflowUUID) {
+        return this.#wfe.retrieveWorkflow(workflowUUID);
+    }
+    /**
+     * Generate a proxy object for the provided class that wraps direct calls (i.e. OpClass.someMethod(param))
+     * to use WorkflowContext.Transaction(OpClass.someMethod, param);
+     */
+    invoke(object, workflowUUID) {
+        const ops = (0, decorators_1.getRegisteredOperations)(object);
+        const proxy = {};
+        const params = { workflowUUID: workflowUUID, parentCtx: this };
+        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) => this.#transaction(op.registeredFunction, params, ...args)
+                : op.workflowConfig
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+                    ? (...args) => this.#workflow(op.registeredFunction, params, ...args)
+                    : op.commConfig
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+                        ? (...args) => this.#external(op.registeredFunction, params, ...args)
+                        : undefined;
+        }
+        return proxy;
+    }
+    //////////////////////
+    /* PRIVATE METHODS */
+    /////////////////////
+    async #workflow(wf, params, ...args) {
+        return this.#wfe.workflow(wf, params, ...args);
+    }
+    async #transaction(txn, params, ...args) {
+        return this.#wfe.transaction(txn, params, ...args);
+    }
+    async #external(commFn, params, ...args) {
+        return this.#wfe.external(commFn, params, ...args);
+    }
+}
+exports.HandlerContextImpl = HandlerContextImpl;
+//////////////////////////
+/* REGISTRATION OBJECTS */
+//////////////////////////
+var APITypes;
+(function (APITypes) {
+    APITypes["GET"] = "GET";
+    APITypes["POST"] = "POST";
+})(APITypes || (exports.APITypes = APITypes = {}));
+var ArgSources;
+(function (ArgSources) {
+    ArgSources["DEFAULT"] = "DEFAULT";
+    ArgSources["BODY"] = "BODY";
+    ArgSources["QUERY"] = "QUERY";
+    ArgSources["URL"] = "URL";
+})(ArgSources || (exports.ArgSources = ArgSources = {}));
+class HandlerRegistration extends decorators_1.MethodRegistration {
+    apiType = APITypes.GET;
+    apiURL = "";
+    args = [];
+    constructor(origFunc) {
+        super(origFunc);
+    }
+}
+exports.HandlerRegistration = HandlerRegistration;
+class HandlerParameter extends decorators_1.MethodParameter {
+    argSource = ArgSources.DEFAULT;
+    // eslint-disable-next-line @typescript-eslint/ban-types
+    constructor(idx, at) {
+        super(idx, at);
+    }
+}
+exports.HandlerParameter = HandlerParameter;
+/////////////////////////
+/* ENDPOINT DECORATORS */
+/////////////////////////
+function GetApi(url) {
+    function apidec(target, propertyKey, inDescriptor) {
+        const { descriptor, registration } = (0, decorators_1.registerAndWrapFunction)(target, propertyKey, inDescriptor);
+        const handlerRegistration = registration;
+        handlerRegistration.apiURL = url;
+        handlerRegistration.apiType = APITypes.GET;
+        return descriptor;
+    }
+    return apidec;
+}
+exports.GetApi = GetApi;
+function PostApi(url) {
+    function apidec(target, propertyKey, inDescriptor) {
+        const { descriptor, registration } = (0, decorators_1.registerAndWrapFunction)(target, propertyKey, inDescriptor);
+        const handlerRegistration = registration;
+        handlerRegistration.apiURL = url;
+        handlerRegistration.apiType = APITypes.POST;
+        return descriptor;
+    }
+    return apidec;
+}
+exports.PostApi = PostApi;
+///////////////////////////////////
+/* ENDPOINT PARAMETER DECORATORS */
+///////////////////////////////////
+function ArgSource(source) {
+    return function (target, propertyKey, parameterIndex) {
+        const existingParameters = (0, decorators_1.getOrCreateMethodArgsRegistration)(target, propertyKey);
+        const curParam = existingParameters[parameterIndex];
+        curParam.argSource = source;
+    };
+}
+exports.ArgSource = ArgSource;
+//# sourceMappingURL=handler.js.map

package/dist/src/httpServer/handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"handler.js","sourceRoot":"","sources":["../../../src/httpServer/handler.ts"],"names":[],"mappings":";;;AAAA,uDAAuD;AACvD,8CAAiL;AACjL,oDAAgD;AAChD,wCAA0D;AAI1D,8CAAgE;AAChE,4CAA+E;AAoB/E,MAAa,kBAAmB,SAAQ,yBAAe;IAIb;IAH/B,IAAI,CAAe;IACnB,yBAAyB,CAA4B;IAE9D,YAAY,GAAiB,EAAW,UAAuB;QAC7D,0DAA0D;QAC1D,MAAM,UAAU,GAAG,IAAI,gCAAyB,EAAE,CAAC;QACnD,MAAM,oBAAoB,GAAG,WAAK,CAAC,cAAc,CAC7C,UAAU,CAAC,OAAO,CAAC,kBAAY,EAAE,UAAU,CAAC,OAAO,CAAC,OAAO,EAAE,0BAAoB,CAAC,CACrF,CAAA;QACD,IAAI,IAAU,CAAC;QACf,MAAM,cAAc,GAAG;YACrB,aAAa,EAAE,UAAU,CAAC,GAAG;SAC9B,CAAC;QACF,IAAI,oBAAoB,KAAK,SAAS,EAAE;YACtC,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;SAC7D;aAAM;YACL,oBAAoB,CAAC,QAAQ,GAAG,IAAI,CAAC;YACrC,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,oBAAoB,CAAC,oBAAoB,EAAE,UAAU,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;SAC9F;QACD,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;QAhBF,eAAU,GAAV,UAAU,CAAa;QAiB7D,IAAI,CAAC,yBAAyB,GAAG,UAAU,CAAC;QAC5C,IAAI,CAAC,OAAO,GAAG;YACb,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,OAAO;YACnC,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC,UAAU;YACrC,mEAAmE;YACnE,MAAM,EAAE,UAAU,CAAC,MAAM;YACzB,mEAAmE;YACnE,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,IAAI;YAC7B,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,OAAO;YACnC,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK;YAC/B,WAAW,EAAE,UAAU,CAAC,OAAO,CAAC,WAAW;YAC3C,GAAG,EAAE,UAAU,CAAC,OAAO,CAAC,GAAG;YAC3B,EAAE,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE;SAC1B,CAAC;QACF,IAAI,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE;YAC1B,mEAAmE;YACnE,IAAI,CAAC,iBAAiB,GAAG,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC;SACjD;QACD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;IAClB,CAAC;IAED,uBAAuB;IACvB,uBAAuB;IACvB,uBAAuB;IAEvB,KAAK,CAAC,IAAI,CAA6B,eAAuB,EAAE,OAAU,EAAE,KAAc,EAAE,cAAuB;QACjH,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,OAAO,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;IACzE,CAAC;IAED,KAAK,CAAC,QAAQ,CAA6B,YAAoB,EAAE,GAAW,EAAE,iBAAyB,4BAAY,CAAC,6BAA6B;QAC/I,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE,cAAc,CAAC,CAAC;IAC/D,CAAC;IAED,gBAAgB,CAAI,YAAoB;QACtC,OAAO,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACH,MAAM,CAAmB,MAAS,EAAE,YAAqB;QACvD,MAAM,GAAG,GAAG,IAAA,oCAAuB,EAAC,MAAM,CAAC,CAAC;QAE5C,MAAM,KAAK,GAAQ,EAAE,CAAC;QACtB,MAAM,MAAM,GAAG,EAAE,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;QAC/D,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,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,kBAA6C,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;gBAC1G,CAAC,CAAC,EAAE,CAAC,cAAc;oBACnB,iEAAiE;oBACjE,CAAC,CAAC,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,kBAA0C,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;oBACpG,CAAC,CAAC,EAAE,CAAC,UAAU;wBACf,iEAAiE;wBACjE,CAAC,CAAC,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,kBAA8C,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;wBACxG,CAAC,CAAC,SAAS,CAAC;SACf;QACD,OAAO,KAAuB,CAAC;IACjC,CAAC;IAED,sBAAsB;IACtB,qBAAqB;IACrB,qBAAqB;IAErB,KAAK,CAAC,SAAS,CAAqB,EAAkB,EAAE,MAAsB,EAAE,GAAG,IAAO;QACxF,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IACjD,CAAC;IAED,KAAK,CAAC,YAAY,CAAqB,GAAsB,EAAE,MAAsB,EAAE,GAAG,IAAO;QAC/F,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,SAAS,CAAqB,MAA0B,EAAE,MAAsB,EAAE,GAAG,IAAO;QAChG,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IACrD,CAAC;CACF;AAlGD,gDAkGC;AAED,0BAA0B;AAC1B,0BAA0B;AAC1B,0BAA0B;AAE1B,IAAY,QAGX;AAHD,WAAY,QAAQ;IAClB,uBAAW,CAAA;IACX,yBAAa,CAAA;AACf,CAAC,EAHW,QAAQ,wBAAR,QAAQ,QAGnB;AAED,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,iCAAmB,CAAA;IACnB,2BAAa,CAAA;IACb,6BAAe,CAAA;IACf,yBAAW,CAAA;AACb,CAAC,EALW,UAAU,0BAAV,UAAU,QAKrB;AAQD,MAAa,mBAA0D,SAAQ,+BAAsC;IACnH,OAAO,GAAa,QAAQ,CAAC,GAAG,CAAC;IACjC,MAAM,GAAW,EAAE,CAAC;IAEpB,IAAI,GAAuB,EAAE,CAAC;IAC9B,YAAY,QAAwD;QAClE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAClB,CAAC;CACF;AARD,kDAQC;AAED,MAAa,gBAAiB,SAAQ,4BAAe;IACnD,SAAS,GAAe,UAAU,CAAC,OAAO,CAAC;IAE3C,wDAAwD;IACxD,YAAY,GAAW,EAAE,EAAY;QACnC,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IACjB,CAAC;CACF;AAPD,4CAOC;AAED,yBAAyB;AACzB,yBAAyB;AACzB,yBAAyB;AAEzB,SAAgB,MAAM,CAAC,GAAW;IAChC,SAAS,MAAM,CACb,MAAc,EACd,WAAmB,EACnB,YAA+F;QAE/F,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,IAAA,oCAAuB,EAAC,MAAM,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;QAChG,MAAM,mBAAmB,GAAG,YAAkE,CAAC;QAC/F,mBAAmB,CAAC,MAAM,GAAG,GAAG,CAAC;QACjC,mBAAmB,CAAC,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC;QAE3C,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAdD,wBAcC;AAED,SAAgB,OAAO,CAAC,GAAW;IACjC,SAAS,MAAM,CACb,MAAc,EACd,WAAmB,EACnB,YAA+F;QAE/F,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,IAAA,oCAAuB,EAAC,MAAM,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;QAChG,MAAM,mBAAmB,GAAG,YAAkE,CAAC;QAC/F,mBAAmB,CAAC,MAAM,GAAG,GAAG,CAAC;QACjC,mBAAmB,CAAC,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC;QAE5C,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAdD,0BAcC;AAED,mCAAmC;AACnC,mCAAmC;AACnC,mCAAmC;AAEnC,SAAgB,SAAS,CAAC,MAAkB;IAC1C,OAAO,UAAU,MAAc,EAAE,WAA4B,EAAE,cAAsB;QACnF,MAAM,kBAAkB,GAAG,IAAA,8CAAiC,EAAC,MAAM,EAAE,WAAW,CAAC,CAAC;QAElF,MAAM,QAAQ,GAAG,kBAAkB,CAAC,cAAc,CAAqB,CAAC;QACxE,QAAQ,CAAC,SAAS,GAAG,MAAM,CAAC;IAC9B,CAAC,CAAC;AACJ,CAAC;AAPD,8BAOC"}

package/dist/src/httpServer/middleware.d.ts

@@ -0,0 +1,56 @@
+import Koa from "koa";
+import { ClassRegistration, RegistrationDefaults } from "../decorators";
+import { UserDatabaseClient } from "../user_database";
+import { Span } from "@opentelemetry/sdk-trace-base";
+import { Logger as DBOSLogger } from "../telemetry/logs";
+import { OpenAPIV3 as OpenApi3 } from 'openapi-types';
+export interface MiddlewareContext {
+    readonly koaContext: Koa.Context;
+    readonly name: string;
+    readonly requiredRole: string[];
+    readonly logger: DBOSLogger;
+    readonly span: Span;
+    getConfig<T>(key: string, deflt: T | undefined): T | undefined;
+    query<C extends UserDatabaseClient, R, T extends unknown[]>(qry: (dbclient: C, ...args: T) => Promise<R>, ...args: T): Promise<R>;
+}
+/**
+ * Authentication middleware that executes before a request reaches a function.
+ * This is expected to:
+ *   - Validate the request found in the handler context and extract auth information from the request.
+ *   - Map the HTTP request to the user identity and roles defined in app.
+ * If this succeeds, return the current authenticated user and a list of roles.
+ * If any step fails, throw an error.
+ */
+export type DBOSHttpAuthMiddleware = (ctx: MiddlewareContext) => Promise<DBOSHttpAuthReturn | void>;
+export interface DBOSHttpAuthReturn {
+    authenticatedUser: string;
+    authenticatedRoles: string[];
+}
+export interface MiddlewareDefaults extends RegistrationDefaults {
+    koaMiddlewares?: Koa.Middleware[];
+    authMiddleware?: DBOSHttpAuthMiddleware;
+}
+export declare class MiddlewareClassRegistration<CT extends {
+    new (...args: unknown[]): object;
+}> extends ClassRegistration<CT> implements MiddlewareDefaults {
+    authMiddleware?: DBOSHttpAuthMiddleware;
+    koaMiddlewares?: Koa.Middleware[];
+    constructor(ctor: CT);
+}
+/**
+ * Define an authentication function for each endpoint in this class.
+ */
+export declare function Authentication(authMiddleware: DBOSHttpAuthMiddleware): <T extends new (...args: unknown[]) => object>(ctor: T) => void;
+/**
+ * Define Koa middleware that is applied in order to each endpoint in this class.
+ */
+export declare function KoaMiddleware(...koaMiddleware: Koa.Middleware[]): <T extends new (...args: unknown[]) => object>(ctor: T) => void;
+type SecurityScheme = Exclude<OpenApi3.SecuritySchemeObject, OpenApi3.OAuth2SecurityScheme>;
+/**
+ * Declare an OpenApi Security Scheme (https://spec.openapis.org/oas/v3.0.3#security-scheme-object
+ * for the methods of a class. Note, this decorator is only used in OpenApi generation and does not
+ * affect runtime behavior of the app.
+ */
+export declare function OpenApiSecurityScheme(securityScheme: SecurityScheme): <T extends new (...args: unknown[]) => object>(_ctor: T) => void;
+export {};
+//# sourceMappingURL=middleware.d.ts.map

package/dist/src/httpServer/middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"middleware.d.ts","sourceRoot":"","sources":["../../../src/httpServer/middleware.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,EAAE,iBAAiB,EAAE,oBAAoB,EAAgC,MAAM,eAAe,CAAC;AAGtG,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAEtD,OAAO,EAAE,IAAI,EAAE,MAAM,+BAA+B,CAAC;AACrD,OAAO,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,SAAS,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAC;AAGtD,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAC,OAAO,CAAC;IACjC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,CAAC;IAEhC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAEpB,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,SAAS,GAAG,CAAC,GAAG,SAAS,CAAC;IAE/D,KAAK,CAAC,CAAC,SAAS,kBAAkB,EAAE,CAAC,EAAE,CAAC,SAAS,OAAO,EAAE,EAAE,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;CACnI;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,sBAAsB,GAAG,CAAC,GAAG,EAAE,iBAAiB,KAAK,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAAC;AAEpG,MAAM,WAAW,kBAAkB;IACjC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,kBAAkB,EAAE,MAAM,EAAE,CAAC;CAC9B;AAGD,MAAM,WAAW,kBAAmB,SAAQ,oBAAoB;IAC9D,cAAc,CAAC,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC;IAClC,cAAc,CAAC,EAAE,sBAAsB,CAAC;CACzC;AAED,qBAAa,2BAA2B,CAAC,EAAE,SAAS;IAAE,KAAI,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,CAAA;CAAE,CAAE,SAAQ,iBAAiB,CAAC,EAAE,CAAE,YAAW,kBAAkB;IAClJ,cAAc,CAAC,EAAE,sBAAsB,CAAC;IACxC,cAAc,CAAC,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC;gBAEtB,IAAI,EAAE,EAAE;CAGrB;AAMD;;GAEG;AACH,wBAAgB,cAAc,CAAC,cAAc,EAAE,sBAAsB,4BAI1B,OAAO,EAAE,KAAG,MAAM,mBAK5D;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,GAAG,aAAa,EAAE,GAAG,CAAC,UAAU,EAAE,4BAMrB,OAAO,EAAE,KAAG,MAAM,mBAK5D;AAOD,KAAK,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,oBAAoB,EAAE,QAAQ,CAAC,oBAAoB,CAAC,CAAC;AAE5F;;;;GAIG;AAEH,wBAAgB,qBAAqB,CAAC,cAAc,EAAE,cAAc,4BACxB,OAAO,EAAE,KAAG,MAAM,oBAC7D"}

package/dist/src/httpServer/middleware.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenApiSecurityScheme = exports.KoaMiddleware = exports.Authentication = exports.MiddlewareClassRegistration = void 0;
+const decorators_1 = require("../decorators");
+const error_1 = require("../error");
+class MiddlewareClassRegistration extends decorators_1.ClassRegistration {
+    authMiddleware;
+    koaMiddlewares;
+    constructor(ctor) {
+        super(ctor);
+    }
+}
+exports.MiddlewareClassRegistration = MiddlewareClassRegistration;
+/////////////////////////////////
+/* MIDDLEWARE CLASS DECORATORS */
+/////////////////////////////////
+/**
+ * Define an authentication function for each endpoint in this class.
+ */
+function Authentication(authMiddleware) {
+    if (authMiddleware === undefined) {
+        throw new error_1.DBOSUndefinedDecoratorInputError("Authentication");
+    }
+    function clsdec(ctor) {
+        const clsreg = (0, decorators_1.getOrCreateClassRegistration)(ctor);
+        clsreg.authMiddleware = authMiddleware;
+    }
+    return clsdec;
+}
+exports.Authentication = Authentication;
+/**
+ * Define Koa middleware that is applied in order to each endpoint in this class.
+ */
+function KoaMiddleware(...koaMiddleware) {
+    koaMiddleware.forEach((i) => {
+        if (i === undefined) {
+            throw new error_1.DBOSUndefinedDecoratorInputError("KoaMiddleware");
+        }
+    });
+    function clsdec(ctor) {
+        const clsreg = (0, decorators_1.getOrCreateClassRegistration)(ctor);
+        clsreg.koaMiddlewares = koaMiddleware;
+    }
+    return clsdec;
+}
+exports.KoaMiddleware = KoaMiddleware;
+/**
+ * Declare an OpenApi Security Scheme (https://spec.openapis.org/oas/v3.0.3#security-scheme-object
+ * for the methods of a class. Note, this decorator is only used in OpenApi generation and does not
+ * affect runtime behavior of the app.
+ */
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+function OpenApiSecurityScheme(securityScheme) {
+    return function (_ctor) { };
+}
+exports.OpenApiSecurityScheme = OpenApiSecurityScheme;
+//# sourceMappingURL=middleware.js.map

package/dist/src/httpServer/middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"middleware.js","sourceRoot":"","sources":["../../../src/httpServer/middleware.ts"],"names":[],"mappings":";;;AACA,8CAAsG;AACtG,oCAA4D;AA2C5D,MAAa,2BAA4E,SAAQ,8BAAqB;IACpH,cAAc,CAA0B;IACxC,cAAc,CAAoB;IAElC,YAAY,IAAQ;QAClB,KAAK,CAAC,IAAI,CAAC,CAAC;IACd,CAAC;CACF;AAPD,kEAOC;AAED,iCAAiC;AACjC,iCAAiC;AACjC,iCAAiC;AAEjC;;GAEG;AACH,SAAgB,cAAc,CAAC,cAAsC;IACnE,IAAI,cAAc,KAAK,SAAS,EAAE;QAChC,MAAM,IAAI,wCAAgC,CAAC,gBAAgB,CAAC,CAAC;KAC9D;IACD,SAAS,MAAM,CAAgD,IAAO;QACpE,MAAM,MAAM,GAAG,IAAA,yCAA4B,EAAC,IAAI,CAAmC,CAAC;QACpF,MAAM,CAAC,cAAc,GAAG,cAAc,CAAC;IACzC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AATD,wCASC;AAED;;GAEG;AACH,SAAgB,aAAa,CAAC,GAAG,aAA+B;IAC9D,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QAC1B,IAAI,CAAC,KAAK,SAAS,EAAE;YACnB,MAAM,IAAI,wCAAgC,CAAC,eAAe,CAAC,CAAC;SAC7D;IACH,CAAC,CAAC,CAAC;IACH,SAAS,MAAM,CAAgD,IAAO;QACpE,MAAM,MAAM,GAAG,IAAA,yCAA4B,EAAC,IAAI,CAAmC,CAAC;QACpF,MAAM,CAAC,cAAc,GAAG,aAAa,CAAC;IACxC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAXD,sCAWC;AASD;;;;GAIG;AACH,6DAA6D;AAC7D,SAAgB,qBAAqB,CAAC,cAA8B;IAClE,OAAO,UAAyD,KAAQ,IAAI,CAAC,CAAA;AAC/E,CAAC;AAFD,sDAEC"}

package/dist/src/httpServer/server.d.ts

@@ -0,0 +1,40 @@
+/// <reference types="koa__router" />
+/// <reference types="node" />
+/// <reference types="node/http" />
+/// <reference types="@koa/bodyparser/dist/body-parser" />
+import Koa from 'koa';
+import Router from '@koa/router';
+import { DBOSExecutor } from "../dbos-executor";
+import { Logger } from "winston";
+export declare const WorkflowUUIDHeader = "dbos-workflowuuid";
+export declare const WorkflowRecoveryUrl = "/dbos-workflow-recovery";
+export declare class DBOSHttpServer {
+    readonly dbosExec: DBOSExecutor;
+    readonly app: Koa;
+    readonly router: Router;
+    readonly logger: Logger;
+    /**
+     * Create a Koa app.
+     * @param dbosExec User pass in an DBOS workflow executor instance.
+     * TODO: maybe call wfe.init() somewhere in this class?
+     */
+    constructor(dbosExec: DBOSExecutor, config?: {
+        koa?: Koa;
+        router?: Router;
+    });
+    /**
+     * Register HTTP endpoints and attach to the app. Then start the server at the given port.
+     * @param port
+     */
+    listen(port: number): import("http").Server<typeof import("http").IncomingMessage, typeof import("http").ServerResponse>;
+    /**
+     * Register workflow recovery endpoint.
+     * Receives a list of executor IDs and returns a list of workflowUUIDs.
+     */
+    static registerRecoveryEndpoint(wfe: DBOSExecutor, router: Router): void;
+    /**
+     * Register decorated functions as HTTP endpoints.
+     */
+    static registerDecoratedEndpoints(wfe: DBOSExecutor, router: Router): void;
+}
+//# sourceMappingURL=server.d.ts.map

package/dist/src/httpServer/server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../../src/httpServer/server.ts"],"names":[],"mappings":";;;;AAAA,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,MAAM,MAAM,aAAa,CAAC;AAiBjC,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAKjC,eAAO,MAAM,kBAAkB,sBAAsB,CAAC;AACtD,eAAO,MAAM,mBAAmB,4BAA4B,CAAA;AAE5D,qBAAa,cAAc;IAUb,QAAQ,CAAC,QAAQ,EAAE,YAAY;IAT3C,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;IAClB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAExB;;;;OAIG;gBACkB,QAAQ,EAAE,YAAY,EAAE,MAAM,GAAE;QAAE,GAAG,CAAC,EAAE,GAAG,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAO;IAuBxF;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM;IAOnB;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,GAAG,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM;IAmBjE;;OAEG;IACH,MAAM,CAAC,0BAA0B,CAAC,GAAG,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM;CAsKpE"}