@workplane/dbos 0.3.1

package/README.md

@@ -0,0 +1,35 @@
+# @workplane/dbos
+
+Optional DBOS durability layer for the workplane server. Wraps store operations in durable DBOS workflows so the control plane survives process crashes and replays in-flight operations.
+
+## Install
+
+```bash
+npm install @workplane/dbos @workplane/types @dbos-inc/dbos-sdk
+```
+
+## Usage
+
+Enable by setting `WORKPLANE_USE_DBOS=true` before starting the workplane server — no code changes needed. The server dynamically imports this package and swaps `VanillaWorkflows` for `DbosWorkflows`.
+
+```bash
+WORKPLANE_USE_DBOS=true workplane-server
+```
+
+## Programmatic use
+
+```ts
+import { createDbosWorkflows } from "@workplane/dbos";
+
+const workflows = createDbosWorkflows(store);  // store satisfies ServerWorkflows
+await workflows.launch({
+  appName: "my-app",
+  systemDatabaseUrl: process.env.DATABASE_URL,
+});
+// workflows now implements ServerWorkflows with DBOS durability
+```
+
+## Requirements
+
+- Postgres (for DBOS system tables, separate from the workplane app schema)
+- `DBOS_APPLICATION_NAME` env var (optional, defaults to `workplane-server`)

package/dist/index.d.ts

@@ -0,0 +1,24 @@
+import { ServerWorkflows, CreateTaskInput, TaskRecord, RunStatus, RunRecord, RunLogInput, ArtifactInput, ArtifactRecord, AppendInputEventInput, RunInputEvent } from '@workplane/types';
+
+declare class DbosWorkflows implements ServerWorkflows {
+    private readonly registered;
+    constructor(store: ServerWorkflows);
+    launch(options: {
+        appName: string;
+        systemDatabaseUrl: string;
+        conductorKey?: string;
+        conductorUrl?: string;
+    }): Promise<void>;
+    shutdown(): Promise<void>;
+    createTask(input: CreateTaskInput): Promise<TaskRecord>;
+    retryTask(taskId: string): Promise<TaskRecord | null>;
+    cancelTask(taskId: string): Promise<TaskRecord | null>;
+    updateRunStatus(runId: string, status: RunStatus, error?: string): Promise<RunRecord | null>;
+    appendRunLogs(runId: string, logs: RunLogInput[]): Promise<number>;
+    createArtifact(runId: string, input: ArtifactInput): Promise<ArtifactRecord>;
+    appendInputEvent(runId: string, input: AppendInputEventInput): Promise<RunInputEvent>;
+    markInputDelivered(runId: string, sequence: number): Promise<void>;
+}
+declare function createDbosWorkflows(store: ServerWorkflows): DbosWorkflows;
+
+export { DbosWorkflows, createDbosWorkflows };

package/dist/index.js

@@ -0,0 +1,102 @@
+// src/index.ts
+import { DBOS } from "@dbos-inc/dbos-sdk";
+var DbosWorkflows = class {
+  registered;
+  constructor(store) {
+    const createTask = DBOS.registerWorkflow(
+      async (input) => DBOS.runStep(() => store.createTask(input), { name: "store-create-task" }),
+      { name: "createTaskWorkflow" }
+    );
+    const retryTask = DBOS.registerWorkflow(
+      async (taskId) => DBOS.runStep(() => store.retryTask(taskId), { name: "store-retry-task" }),
+      { name: "retryTaskWorkflow" }
+    );
+    const cancelTask = DBOS.registerWorkflow(
+      async (taskId) => DBOS.runStep(() => store.cancelTask(taskId), { name: "store-cancel-task" }),
+      { name: "cancelTaskWorkflow" }
+    );
+    const updateRunStatus = DBOS.registerWorkflow(
+      async (runId, status, error) => DBOS.runStep(() => store.updateRunStatus(runId, status, error), { name: "store-update-run-status" }),
+      { name: "updateRunStatusWorkflow" }
+    );
+    const appendRunLogs = DBOS.registerWorkflow(
+      async (runId, logs) => DBOS.runStep(() => store.appendRunLogs(runId, logs), { name: "store-append-run-logs" }),
+      { name: "appendRunLogsWorkflow" }
+    );
+    const createArtifact = DBOS.registerWorkflow(
+      async (runId, input) => DBOS.runStep(() => store.createArtifact(runId, input), { name: "store-create-artifact" }),
+      { name: "createArtifactWorkflow" }
+    );
+    const appendInputEvent = DBOS.registerWorkflow(
+      async (runId, input) => DBOS.runStep(() => store.appendInputEvent(runId, input), { name: "store-append-input-event" }),
+      { name: "appendInputEventWorkflow" }
+    );
+    const markInputDelivered = DBOS.registerWorkflow(
+      async (runId, sequence) => DBOS.runStep(() => store.markInputDelivered(runId, sequence), { name: "store-mark-input-delivered" }),
+      { name: "markInputDeliveredWorkflow" }
+    );
+    this.registered = {
+      createTask,
+      retryTask,
+      cancelTask,
+      updateRunStatus,
+      appendRunLogs,
+      createArtifact,
+      appendInputEvent,
+      markInputDelivered
+    };
+  }
+  async launch(options) {
+    DBOS.setConfig({
+      name: options.appName,
+      systemDatabaseUrl: options.systemDatabaseUrl
+    });
+    await DBOS.launch({
+      conductorKey: options.conductorKey,
+      conductorURL: options.conductorUrl
+    });
+  }
+  async shutdown() {
+    await DBOS.shutdown();
+  }
+  async createTask(input) {
+    const handle = await DBOS.startWorkflow(this.registered.createTask)(input);
+    return handle.getResult();
+  }
+  async retryTask(taskId) {
+    const handle = await DBOS.startWorkflow(this.registered.retryTask)(taskId);
+    return handle.getResult();
+  }
+  async cancelTask(taskId) {
+    const handle = await DBOS.startWorkflow(this.registered.cancelTask)(taskId);
+    return handle.getResult();
+  }
+  async updateRunStatus(runId, status, error) {
+    const handle = await DBOS.startWorkflow(this.registered.updateRunStatus)(runId, status, error);
+    return handle.getResult();
+  }
+  async appendRunLogs(runId, logs) {
+    const handle = await DBOS.startWorkflow(this.registered.appendRunLogs)(runId, logs);
+    return handle.getResult();
+  }
+  async createArtifact(runId, input) {
+    const handle = await DBOS.startWorkflow(this.registered.createArtifact)(runId, input);
+    return handle.getResult();
+  }
+  async appendInputEvent(runId, input) {
+    const handle = await DBOS.startWorkflow(this.registered.appendInputEvent)(runId, input);
+    return handle.getResult();
+  }
+  async markInputDelivered(runId, sequence) {
+    const handle = await DBOS.startWorkflow(this.registered.markInputDelivered)(runId, sequence);
+    await handle.getResult();
+  }
+};
+function createDbosWorkflows(store) {
+  return new DbosWorkflows(store);
+}
+export {
+  DbosWorkflows,
+  createDbosWorkflows
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { DBOS } from \"@dbos-inc/dbos-sdk\";\nimport type {\n  AppendInputEventInput,\n  ArtifactInput,\n  ArtifactRecord,\n  CreateTaskInput,\n  RunInputEvent,\n  RunLogInput,\n  RunRecord,\n  RunStatus,\n  ServerWorkflows,\n  TaskRecord,\n} from \"@workplane/types\";\n\nexport class DbosWorkflows implements ServerWorkflows {\n  private readonly registered: ServerWorkflows;\n\n  constructor(store: ServerWorkflows) {\n    const createTask = DBOS.registerWorkflow(\n      async (input: CreateTaskInput) =>\n        DBOS.runStep(() => store.createTask(input), { name: \"store-create-task\" }),\n      { name: \"createTaskWorkflow\" },\n    );\n\n    const retryTask = DBOS.registerWorkflow(\n      async (taskId: string) =>\n        DBOS.runStep(() => store.retryTask(taskId), { name: \"store-retry-task\" }),\n      { name: \"retryTaskWorkflow\" },\n    );\n\n    const cancelTask = DBOS.registerWorkflow(\n      async (taskId: string) =>\n        DBOS.runStep(() => store.cancelTask(taskId), { name: \"store-cancel-task\" }),\n      { name: \"cancelTaskWorkflow\" },\n    );\n\n    const updateRunStatus = DBOS.registerWorkflow(\n      async (runId: string, status: RunStatus, error?: string) =>\n        DBOS.runStep(() => store.updateRunStatus(runId, status, error), { name: \"store-update-run-status\" }),\n      { name: \"updateRunStatusWorkflow\" },\n    );\n\n    const appendRunLogs = DBOS.registerWorkflow(\n      async (runId: string, logs: RunLogInput[]) =>\n        DBOS.runStep(() => store.appendRunLogs(runId, logs), { name: \"store-append-run-logs\" }),\n      { name: \"appendRunLogsWorkflow\" },\n    );\n\n    const createArtifact = DBOS.registerWorkflow(\n      async (runId: string, input: ArtifactInput) =>\n        DBOS.runStep(() => store.createArtifact(runId, input), { name: \"store-create-artifact\" }),\n      { name: \"createArtifactWorkflow\" },\n    );\n\n    const appendInputEvent = DBOS.registerWorkflow(\n      async (runId: string, input: AppendInputEventInput) =>\n        DBOS.runStep(() => store.appendInputEvent(runId, input), { name: \"store-append-input-event\" }),\n      { name: \"appendInputEventWorkflow\" },\n    );\n\n    const markInputDelivered = DBOS.registerWorkflow(\n      async (runId: string, sequence: number) =>\n        DBOS.runStep(() => store.markInputDelivered(runId, sequence), { name: \"store-mark-input-delivered\" }),\n      { name: \"markInputDeliveredWorkflow\" },\n    );\n\n    this.registered = {\n      createTask,\n      retryTask,\n      cancelTask,\n      updateRunStatus,\n      appendRunLogs,\n      createArtifact,\n      appendInputEvent,\n      markInputDelivered,\n    };\n  }\n\n  async launch(options: {\n    appName: string;\n    systemDatabaseUrl: string;\n    conductorKey?: string;\n    conductorUrl?: string;\n  }): Promise<void> {\n    DBOS.setConfig({\n      name: options.appName,\n      systemDatabaseUrl: options.systemDatabaseUrl,\n    });\n    await DBOS.launch({\n      conductorKey: options.conductorKey,\n      conductorURL: options.conductorUrl,\n    });\n  }\n\n  async shutdown(): Promise<void> {\n    await DBOS.shutdown();\n  }\n\n  async createTask(input: CreateTaskInput): Promise<TaskRecord> {\n    const handle = await DBOS.startWorkflow(this.registered.createTask)(input);\n    return handle.getResult();\n  }\n\n  async retryTask(taskId: string): Promise<TaskRecord | null> {\n    const handle = await DBOS.startWorkflow(this.registered.retryTask)(taskId);\n    return handle.getResult();\n  }\n\n  async cancelTask(taskId: string): Promise<TaskRecord | null> {\n    const handle = await DBOS.startWorkflow(this.registered.cancelTask)(taskId);\n    return handle.getResult();\n  }\n\n  async updateRunStatus(runId: string, status: RunStatus, error?: string): Promise<RunRecord | null> {\n    const handle = await DBOS.startWorkflow(this.registered.updateRunStatus)(runId, status, error);\n    return handle.getResult();\n  }\n\n  async appendRunLogs(runId: string, logs: RunLogInput[]): Promise<number> {\n    const handle = await DBOS.startWorkflow(this.registered.appendRunLogs)(runId, logs);\n    return handle.getResult();\n  }\n\n  async createArtifact(runId: string, input: ArtifactInput): Promise<ArtifactRecord> {\n    const handle = await DBOS.startWorkflow(this.registered.createArtifact)(runId, input);\n    return handle.getResult();\n  }\n\n  async appendInputEvent(runId: string, input: AppendInputEventInput): Promise<RunInputEvent> {\n    const handle = await DBOS.startWorkflow(this.registered.appendInputEvent)(runId, input);\n    return handle.getResult();\n  }\n\n  async markInputDelivered(runId: string, sequence: number): Promise<void> {\n    const handle = await DBOS.startWorkflow(this.registered.markInputDelivered)(runId, sequence);\n    await handle.getResult();\n  }\n}\n\nexport function createDbosWorkflows(store: ServerWorkflows): DbosWorkflows {\n  return new DbosWorkflows(store);\n}\n"],"mappings":";AAAA,SAAS,YAAY;AAcd,IAAM,gBAAN,MAA+C;AAAA,EACnC;AAAA,EAEjB,YAAY,OAAwB;AAClC,UAAM,aAAa,KAAK;AAAA,MACtB,OAAO,UACL,KAAK,QAAQ,MAAM,MAAM,WAAW,KAAK,GAAG,EAAE,MAAM,oBAAoB,CAAC;AAAA,MAC3E,EAAE,MAAM,qBAAqB;AAAA,IAC/B;AAEA,UAAM,YAAY,KAAK;AAAA,MACrB,OAAO,WACL,KAAK,QAAQ,MAAM,MAAM,UAAU,MAAM,GAAG,EAAE,MAAM,mBAAmB,CAAC;AAAA,MAC1E,EAAE,MAAM,oBAAoB;AAAA,IAC9B;AAEA,UAAM,aAAa,KAAK;AAAA,MACtB,OAAO,WACL,KAAK,QAAQ,MAAM,MAAM,WAAW,MAAM,GAAG,EAAE,MAAM,oBAAoB,CAAC;AAAA,MAC5E,EAAE,MAAM,qBAAqB;AAAA,IAC/B;AAEA,UAAM,kBAAkB,KAAK;AAAA,MAC3B,OAAO,OAAe,QAAmB,UACvC,KAAK,QAAQ,MAAM,MAAM,gBAAgB,OAAO,QAAQ,KAAK,GAAG,EAAE,MAAM,0BAA0B,CAAC;AAAA,MACrG,EAAE,MAAM,0BAA0B;AAAA,IACpC;AAEA,UAAM,gBAAgB,KAAK;AAAA,MACzB,OAAO,OAAe,SACpB,KAAK,QAAQ,MAAM,MAAM,cAAc,OAAO,IAAI,GAAG,EAAE,MAAM,wBAAwB,CAAC;AAAA,MACxF,EAAE,MAAM,wBAAwB;AAAA,IAClC;AAEA,UAAM,iBAAiB,KAAK;AAAA,MAC1B,OAAO,OAAe,UACpB,KAAK,QAAQ,MAAM,MAAM,eAAe,OAAO,KAAK,GAAG,EAAE,MAAM,wBAAwB,CAAC;AAAA,MAC1F,EAAE,MAAM,yBAAyB;AAAA,IACnC;AAEA,UAAM,mBAAmB,KAAK;AAAA,MAC5B,OAAO,OAAe,UACpB,KAAK,QAAQ,MAAM,MAAM,iBAAiB,OAAO,KAAK,GAAG,EAAE,MAAM,2BAA2B,CAAC;AAAA,MAC/F,EAAE,MAAM,2BAA2B;AAAA,IACrC;AAEA,UAAM,qBAAqB,KAAK;AAAA,MAC9B,OAAO,OAAe,aACpB,KAAK,QAAQ,MAAM,MAAM,mBAAmB,OAAO,QAAQ,GAAG,EAAE,MAAM,6BAA6B,CAAC;AAAA,MACtG,EAAE,MAAM,6BAA6B;AAAA,IACvC;AAEA,SAAK,aAAa;AAAA,MAChB;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,OAAO,SAKK;AAChB,SAAK,UAAU;AAAA,MACb,MAAM,QAAQ;AAAA,MACd,mBAAmB,QAAQ;AAAA,IAC7B,CAAC;AACD,UAAM,KAAK,OAAO;AAAA,MAChB,cAAc,QAAQ;AAAA,MACtB,cAAc,QAAQ;AAAA,IACxB,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,WAA0B;AAC9B,UAAM,KAAK,SAAS;AAAA,EACtB;AAAA,EAEA,MAAM,WAAW,OAA6C;AAC5D,UAAM,SAAS,MAAM,KAAK,cAAc,KAAK,WAAW,UAAU,EAAE,KAAK;AACzE,WAAO,OAAO,UAAU;AAAA,EAC1B;AAAA,EAEA,MAAM,UAAU,QAA4C;AAC1D,UAAM,SAAS,MAAM,KAAK,cAAc,KAAK,WAAW,SAAS,EAAE,MAAM;AACzE,WAAO,OAAO,UAAU;AAAA,EAC1B;AAAA,EAEA,MAAM,WAAW,QAA4C;AAC3D,UAAM,SAAS,MAAM,KAAK,cAAc,KAAK,WAAW,UAAU,EAAE,MAAM;AAC1E,WAAO,OAAO,UAAU;AAAA,EAC1B;AAAA,EAEA,MAAM,gBAAgB,OAAe,QAAmB,OAA2C;AACjG,UAAM,SAAS,MAAM,KAAK,cAAc,KAAK,WAAW,eAAe,EAAE,OAAO,QAAQ,KAAK;AAC7F,WAAO,OAAO,UAAU;AAAA,EAC1B;AAAA,EAEA,MAAM,cAAc,OAAe,MAAsC;AACvE,UAAM,SAAS,MAAM,KAAK,cAAc,KAAK,WAAW,aAAa,EAAE,OAAO,IAAI;AAClF,WAAO,OAAO,UAAU;AAAA,EAC1B;AAAA,EAEA,MAAM,eAAe,OAAe,OAA+C;AACjF,UAAM,SAAS,MAAM,KAAK,cAAc,KAAK,WAAW,cAAc,EAAE,OAAO,KAAK;AACpF,WAAO,OAAO,UAAU;AAAA,EAC1B;AAAA,EAEA,MAAM,iBAAiB,OAAe,OAAsD;AAC1F,UAAM,SAAS,MAAM,KAAK,cAAc,KAAK,WAAW,gBAAgB,EAAE,OAAO,KAAK;AACtF,WAAO,OAAO,UAAU;AAAA,EAC1B;AAAA,EAEA,MAAM,mBAAmB,OAAe,UAAiC;AACvE,UAAM,SAAS,MAAM,KAAK,cAAc,KAAK,WAAW,kBAAkB,EAAE,OAAO,QAAQ;AAC3F,UAAM,OAAO,UAAU;AAAA,EACzB;AACF;AAEO,SAAS,oBAAoB,OAAuC;AACzE,SAAO,IAAI,cAAc,KAAK;AAChC;","names":[]}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@workplane/dbos",
+  "version": "0.3.1",
+  "private": false,
+  "type": "module",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MindStaq/workplane.git"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "@dbos-inc/dbos-sdk": "^4.18.10",
+    "@workplane/types": "0.3.1"
+  },
+  "scripts": {
+    "build": "tsup"
+  }
+}