@dbos-inc/dbos-sdk 3.6.5-preview → 3.6.7-preview

package/dist/src/adminserver.d.ts

@@ -1,6 +1,6 @@
-/// <reference types="koa__router" />
-import Koa from 'koa';
-import Router from '@koa/router';
+/// <reference types="node" />
+/// <reference types="node" />
+import * as http from 'http';
 import { DBOSExecutor } from './dbos-executor';
 import { GlobalLogger } from './telemetry/logs';
 import { QueueParameters } from './wfqueue';
@@ -13,95 +13,81 @@ export declare const HealthUrl = "/dbos-healthz";
 export declare const PerfUrl = "/dbos-perf";
 export declare const DeactivateUrl = "/deactivate";
 export declare const WorkflowQueuesMetadataUrl = "/dbos-workflow-queues-metadata";
+interface Route {
+    method: string;
+    path: string;
+    handler: (req: http.IncomingMessage, res: http.ServerResponse, params?: Record<string, string>) => Promise<void>;
+}
 export declare class DBOSAdminServer {
-    readonly dbosExec: DBOSExecutor;
-    readonly adminApp: Koa;
-    readonly logger: GlobalLogger;
-    static nRegisteredEndpoints: number;
-    static instance?: DBOSAdminServer;
-    /**
-     * Create a Koa app.
-     * @param dbosExec User pass in an DBOS workflow executor instance.
-     * TODO: maybe call dbosExec.init() somewhere in this class?
-     */
-    constructor(dbosExec: DBOSExecutor);
-    static setupAdminApp(dbosExec: DBOSExecutor): Koa;
+    static setupAdminApp(dbosExec: DBOSExecutor): http.Server;
     static checkPortAvailabilityIPv4Ipv6(port: number, logger: GlobalLogger): Promise<void>;
     static checkPortAvailability(port: number, host: string): Promise<void>;
     /**
      * Health check endpoint.
      */
-    static registerHealthEndpoint(dbosExec: DBOSExecutor, router: Router): void;
+    static registerHealthEndpoint(dbosExec: DBOSExecutor, routes: Route[]): void;
     /**
      * Register workflow queue metadata endpoint.
      */
-    static registerQueueMetadataEndpoint(dbosExec: DBOSExecutor, router: Router): void;
+    static registerQueueMetadataEndpoint(dbosExec: DBOSExecutor, routes: Route[]): void;
     /**
      * Register workflow recovery endpoint.
      * Receives a list of executor IDs and returns a list of workflowUUIDs.
      */
-    static registerRecoveryEndpoint(dbosExec: DBOSExecutor, router: Router): void;
+    static registerRecoveryEndpoint(dbosExec: DBOSExecutor, routes: Route[]): void;
     /**
      * Register performance endpoint.
      * Returns information on VM performance since last call.
      */
-    static registerPerfEndpoint(dbosExec: DBOSExecutor, router: Router): void;
+    static lastELU: import("perf_hooks").EventLoopUtilization;
+    static registerPerfEndpoint(dbosExec: DBOSExecutor, routes: Route[]): void;
     /**
      * Register Deactivate endpoint.
      * Deactivate consumers so that they don't start new workflows.
-     *
      */
     static isDeactivated: boolean;
-    static registerDeactivateEndpoint(dbosExec: DBOSExecutor, router: Router): void;
-    static registerGarbageCollectEndpoint(dbosExec: DBOSExecutor, router: Router): void;
-    static registerGlobalTimeoutEndpoint(dbosExec: DBOSExecutor, router: Router): void;
+    static registerDeactivateEndpoint(dbosExec: DBOSExecutor, routes: Route[]): void;
+    static registerGarbageCollectEndpoint(dbosExec: DBOSExecutor, routes: Route[]): void;
+    static registerGlobalTimeoutEndpoint(dbosExec: DBOSExecutor, routes: Route[]): void;
     /**
-     *
      * Register Cancel Workflow endpoint.
      * Cancels a workflow by setting its status to CANCELLED.
      */
-    static registerCancelWorkflowEndpoint(dbosExec: DBOSExecutor, router: Router): void;
+    static registerCancelWorkflowEndpoint(dbosExec: DBOSExecutor, routes: Route[]): void;
     /**
-     *
      * Register Resume Workflow endpoint.
      * Resume a workflow.
      */
-    static registerResumeWorkflowEndpoint(dbosExec: DBOSExecutor, router: Router): void;
+    static registerResumeWorkflowEndpoint(dbosExec: DBOSExecutor, routes: Route[]): void;
     /**
-     *
      * Register Restart Workflow endpoint.
      * Restart a workflow.
      */
-    static registerRestartWorkflowEndpoint(dbosExec: DBOSExecutor, router: Router): void;
+    static registerRestartWorkflowEndpoint(dbosExec: DBOSExecutor, routes: Route[]): void;
     /**
-     *
      * Register Fork Workflow endpoint.
-     *
      */
-    static registerForkWorkflowEndpoint(dbosExec: DBOSExecutor, router: Router): void;
+    static registerForkWorkflowEndpoint(dbosExec: DBOSExecutor, routes: Route[]): void;
     /**
-     *
      * Register List Workflow Steps endpoint.
      * List steps for a given workflow.
      */
-    static registerListWorkflowStepsEndpoint(dbosExec: DBOSExecutor, router: Router): void;
+    static registerListWorkflowStepsEndpoint(dbosExec: DBOSExecutor, routes: Route[]): void;
     /**
-     *
      * Register List Workflows endpoint.
      * List workflows with optional filtering via request body.
      */
-    static registerListWorkflowsEndpoint(dbosExec: DBOSExecutor, router: Router): void;
+    static registerListWorkflowsEndpoint(dbosExec: DBOSExecutor, routes: Route[]): void;
     /**
-     *
      * Register List Queued Workflows endpoint.
      * List queued workflows with optional filtering via request body.
      */
-    static registerListQueuedWorkflowsEndpoint(dbosExec: DBOSExecutor, router: Router): void;
+    static registerListQueuedWorkflowsEndpoint(dbosExec: DBOSExecutor, routes: Route[]): void;
     /**
-     *
      * Register Get Workflow endpoint.
      * Get detailed information about a specific workflow by ID.
      */
-    static registerGetWorkflowEndpoint(dbosExec: DBOSExecutor, router: Router): void;
+    static registerGetWorkflowEndpoint(dbosExec: DBOSExecutor, routes: Route[]): void;
 }
+export {};
 //# sourceMappingURL=adminserver.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"adminserver.d.ts","sourceRoot":"","sources":["../../src/adminserver.ts"],"names":[],"mappings":";AAAA,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,MAAM,MAAM,aAAa,CAAC;AAKjC,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAIhD,OAAO,EAAE,eAAe,EAAiB,MAAM,WAAW,CAAC;AAK3D,MAAM,MAAM,qBAAqB,GAAG,eAAe,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAEvE,eAAO,MAAM,kBAAkB,yBAAyB,CAAC;AACzD,eAAO,MAAM,mBAAmB,4BAA4B,CAAC;AAC7D,eAAO,MAAM,SAAS,kBAAkB,CAAC;AACzC,eAAO,MAAM,OAAO,eAAe,CAAC;AACpC,eAAO,MAAM,aAAa,gBAAgB,CAAC;AAC3C,eAAO,MAAM,yBAAyB,mCAAmC,CAAC;AAE1E,qBAAa,eAAe;IAWd,QAAQ,CAAC,QAAQ,EAAE,YAAY;IAV3C,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,MAAM,CAAC,oBAAoB,EAAE,MAAM,CAAK;IACxC,MAAM,CAAC,QAAQ,CAAC,EAAE,eAAe,CAAa;IAE9C;;;;OAIG;gBACkB,QAAQ,EAAE,YAAY;IAM3C,MAAM,CAAC,aAAa,CAAC,QAAQ,EAAE,YAAY,GAAG,GAAG;WA0BpC,6BAA6B,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY;WAkChE,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB7E;;OAEG;IACH,MAAM,CAAC,sBAAsB,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM;IAUpE;;OAEG;IACH,MAAM,CAAC,6BAA6B,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM;IAoB3E;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM;IAkBtE;;;OAGG;IACH,MAAM,CAAC,oBAAoB,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM;IAalE;;;;OAIG;IACH,MAAM,CAAC,aAAa,UAAS;IAC7B,MAAM,CAAC,0BAA0B,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM;IAgBxE,MAAM,CAAC,8BAA8B,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM;IAa5E,MAAM,CAAC,6BAA6B,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM;IAY3E;;;;OAIG;IAEH,MAAM,CAAC,8BAA8B,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM;IAW5E;;;;OAIG;IAEH,MAAM,CAAC,8BAA8B,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM;IA2B5E;;;;OAIG;IAEH,MAAM,CAAC,+BAA+B,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM;IAe7E;;;;OAIG;IAEH,MAAM,CAAC,4BAA4B,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM;IA6C1E;;;;OAIG;IAEH,MAAM,CAAC,iCAAiC,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM;IAkB/E;;;;OAIG;IACH,MAAM,CAAC,6BAA6B,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM;IA8C3E;;;;OAIG;IACH,MAAM,CAAC,mCAAmC,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM;IAsCjF;;;;OAIG;IACH,MAAM,CAAC,2BAA2B,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM;CAgB1E"}
+{"version":3,"file":"adminserver.d.ts","sourceRoot":"","sources":["../../src/adminserver.ts"],"names":[],"mappings":";;AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAI7B,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAIhD,OAAO,EAAE,eAAe,EAAiB,MAAM,WAAW,CAAC;AAK3D,MAAM,MAAM,qBAAqB,GAAG,eAAe,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAEvE,eAAO,MAAM,kBAAkB,yBAAyB,CAAC;AACzD,eAAO,MAAM,mBAAmB,4BAA4B,CAAC;AAC7D,eAAO,MAAM,SAAS,kBAAkB,CAAC;AACzC,eAAO,MAAM,OAAO,eAAe,CAAC;AACpC,eAAO,MAAM,aAAa,gBAAgB,CAAC;AAC3C,eAAO,MAAM,yBAAyB,mCAAmC,CAAC;AAG1E,UAAU,KAAK;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC,eAAe,EAAE,GAAG,EAAE,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAClH;AA4ED,qBAAa,eAAe;IAC1B,MAAM,CAAC,aAAa,CAAC,QAAQ,EAAE,YAAY,GAAG,IAAI,CAAC,MAAM;WA+D5C,6BAA6B,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY;WAkChE,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB7E;;OAEG;IACH,MAAM,CAAC,sBAAsB,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE;IAYrE;;OAEG;IACH,MAAM,CAAC,6BAA6B,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE;IAqB5E;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE;IAmBvE;;;OAGG;IACH,MAAM,CAAC,OAAO,4CAAsC;IACpD,MAAM,CAAC,oBAAoB,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE;IAenE;;;OAGG;IACH,MAAM,CAAC,aAAa,UAAS;IAC7B,MAAM,CAAC,0BAA0B,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE;IAkBzE,MAAM,CAAC,8BAA8B,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE;IAgB7E,MAAM,CAAC,6BAA6B,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE;IAe5E;;;OAGG;IACH,MAAM,CAAC,8BAA8B,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE;IAc7E;;;OAGG;IACH,MAAM,CAAC,8BAA8B,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE;IA4B7E;;;OAGG;IACH,MAAM,CAAC,+BAA+B,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE;IAiB9E;;OAEG;IACH,MAAM,CAAC,4BAA4B,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE;IA8C3E;;;OAGG;IACH,MAAM,CAAC,iCAAiC,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE;IAqBhF;;;OAGG;IACH,MAAM,CAAC,6BAA6B,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE;IAiD5E;;;OAGG;IACH,MAAM,CAAC,mCAAmC,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE;IAyClF;;;OAGG;IACH,MAAM,CAAC,2BAA2B,CAAC,QAAQ,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE;CAkB3E"}