@adonis-agora/durable 0.6.1 → 0.8.0

package/dist/src/workflow-ref.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"workflow-ref.d.ts","sourceRoot":"","sources":["../../src/workflow-ref.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,EAAE,OAAO,MAAmD,CAAC;AAE3F,2DAA2D;AAC3D,MAAM,WAAW,eAAe;IAC9B,+EAA+E;IAC/E,IAAI,EAAE,MAAM,CAAC;IACb,yFAAyF;IACzF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gEAAgE;IAChE,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,kFAAkF;IAClF,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACnC,oFAAoF;IACpF,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,+FAA+F;AAC/F,MAAM,WAAW,YAAa,SAAQ,eAAe;IACnD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAAE,eAAe,IACvC,CAAC,SAAS,QAAQ,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK;IAAE,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,GAAG,OAAO,CAAA;CAAE,EAC7F,QAAQ,CAAC,KACR,CAAC,CASL;AAED,gGAAgG;AAChG,wBAAgB,YAAY,CAAC,MAAM,EAAE,OAAO,GAAG,YAAY,GAAG,SAAS,CAGtE;AAED,sGAAsG;AACtG,MAAM,MAAM,aAAa,CAAC,MAAM,GAAG,OAAO,EAAE,OAAO,GAAG,OAAO,IAAI,QAAQ,MACvE,GAAG,IAAI,EAAE,KAAK,EAAE,KACb;IACH,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;CAC5D,CAAC;AAEF,yGAAyG;AACzG,MAAM,MAAM,WAAW,CAAC,MAAM,GAAG,OAAO,EAAE,OAAO,GAAG,OAAO,IACvD,MAAM,GACN,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEnC,uDAAuD;AACvD,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,MACjD,GAAG,IAAI,EAAE,KAAK,EAAE,KACb;IACH,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC;CAC1C,GACG,CAAC,GACD,OAAO,CAAC;AAEZ,gFAAgF;AAChF,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,MAClD,GAAG,IAAI,EAAE,KAAK,EAAE,KACb;IACH,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC,CAAC;CACxC,GACG,OAAO,CAAC,CAAC,CAAC,GACV,OAAO,CAAC;AAEZ;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,WAAW,GAAG,MAAM,CASrD"}
+{"version":3,"file":"workflow-ref.d.ts","sourceRoot":"","sources":["../../src/workflow-ref.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,2GAA2G;AAC3G,MAAM,WAAW,eAAe;IAC9B,+EAA+E;IAC/E,IAAI,EAAE,MAAM,CAAC;IACb,yFAAyF;IACzF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gEAAgE;IAChE,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,kFAAkF;IAClF,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACnC,oFAAoF;IACpF,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,sGAAsG;AACtG,MAAM,WAAW,YAAa,SAAQ,eAAe;IACnD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,OAAO,GAAG,YAAY,GAAG,SAAS,CAOtE;AAED,mGAAmG;AACnG,MAAM,MAAM,aAAa,CAAC,MAAM,GAAG,OAAO,EAAE,OAAO,GAAG,OAAO,IAAI,QAAQ,MACvE,GAAG,IAAI,EAAE,KAAK,EAAE,KACb;IACH,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;CAC5D,CAAC;AAEF,yGAAyG;AACzG,MAAM,MAAM,WAAW,CAAC,MAAM,GAAG,OAAO,EAAE,OAAO,GAAG,OAAO,IACvD,MAAM,GACN,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEnC,uDAAuD;AACvD,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,MACjD,GAAG,IAAI,EAAE,KAAK,EAAE,KACb;IACH,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC;CAC1C,GACG,CAAC,GACD,OAAO,CAAC;AAEZ,gFAAgF;AAChF,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS,QAAQ,MAClD,GAAG,IAAI,EAAE,KAAK,EAAE,KACb;IACH,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC,CAAC;CACxC,GACG,OAAO,CAAC,CAAC,CAAC,GACV,OAAO,CAAC;AAEZ;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,WAAW,GAAG,MAAM,CASrD"}

package/dist/src/workflow-ref.js

@@ -6,53 +6,31 @@
  * string stays available for the cross-runtime case.
  */
 /**
- * The symbol the `@Workflow` decorator stamps the full options onto (name + version + tags …), so
- * auto-discovery can register the class against the engine and a class ref can be resolved back to
- * its name via {@link workflowName}. A global-registry symbol (`Symbol.for`) so it survives duplicate
- * copies of this package in a dependency tree.
+ * Read a class's {@link WorkflowMeta} — its name/version/tags/… — from its `static workflow =
+ * { name, version, … }` config (the {@link BaseWorkflow} authoring form). Any absent `version` is
+ * normalized to `'1'`. Returns `undefined` for a class carrying no valid config (a class with no
+ * `static workflow`, or one whose `name` is not a string, is not a registrable workflow).
  */
-export const WORKFLOW_META_KEY = Symbol.for('@agora/durable:workflow-meta');
-/**
- * Class decorator marking a class as a durable workflow. Stamps the full options (name + version +
- * tags …) so a class ref resolves via {@link workflowName} and the provider's `app/workflows`
- * auto-discovery can register it on the engine — no manual `engine.register(...)`. The class must
- * expose `run(ctx, input)`; that method becomes the workflow body.
- *
- * ```ts
- * @Workflow({ name: 'order', version: '1' })
- * export default class OrderWorkflow {
- *   async run(ctx: WorkflowCtx, input: { id: string }) { ... }
- * }
- * ```
- */
-export function Workflow(options) {
-    return (target) => {
-        const meta = { ...options, version: options.version ?? '1' };
-        Object.defineProperty(target, WORKFLOW_META_KEY, {
-            value: meta,
-            enumerable: false,
-            configurable: true,
-        });
-        return target;
-    };
-}
-/** Read the {@link WorkflowMeta} a `@Workflow` decorator stamped on a class, or `undefined`. */
 export function workflowMeta(target) {
     if (typeof target !== 'function')
         return undefined;
-    return target[WORKFLOW_META_KEY];
+    const config = target.workflow;
+    if (config && typeof config === 'object' && typeof config.name === 'string') {
+        return { ...config, version: config.version ?? '1' };
+    }
+    return undefined;
 }
 /**
  * Resolve a {@link WorkflowRef} to its registered workflow name: a string is returned as-is; a
- * `@Workflow` class is resolved via the name the decorator stamped in its metadata. Throws if a
- * class was never decorated (so it carries no registered name).
+ * workflow class is resolved via the name on its `static workflow` config. Throws if a class carries
+ * no `static workflow` config (so it has no registered name).
  */
 export function workflowName(ref) {
     if (typeof ref === 'string')
         return ref;
     const name = workflowMeta(ref)?.name;
     if (!name) {
-        throw new Error(`workflow class ${ref.name} has no registered name — is it decorated with @Workflow({ name })?`);
+        throw new Error(`workflow class ${ref.name} has no registered name — does it declare \`static workflow = { name }\`?`);
     }
     return name;
 }

package/dist/src/workflow-ref.js.map

@@ -1 +1 @@
-{"version":3,"file":"workflow-ref.js","sourceRoot":"","sources":["../../src/workflow-ref.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAkB,MAAM,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC;AAqB3F;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,QAAQ,CAAC,OAAwB;IAC/C,OAAO,CACL,MAAS,EACN,EAAE;QACL,MAAM,IAAI,GAAiB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,GAAG,EAAE,CAAC;QAC3E,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,iBAAiB,EAAE;YAC/C,KAAK,EAAE,IAAI;YACX,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,IAAI;SACnB,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AAED,gGAAgG;AAChG,MAAM,UAAU,YAAY,CAAC,MAAe;IAC1C,IAAI,OAAO,MAAM,KAAK,UAAU;QAAE,OAAO,SAAS,CAAC;IACnD,OAAQ,MAAiD,CAAC,iBAAiB,CAAC,CAAC;AAC/E,CAAC;AAgCD;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,GAAgB;IAC3C,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,GAAG,CAAC;IACxC,MAAM,IAAI,GAAG,YAAY,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC;IACrC,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CACb,kBAAkB,GAAG,CAAC,IAAI,qEAAqE,CAChG,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}
+{"version":3,"file":"workflow-ref.js","sourceRoot":"","sources":["../../src/workflow-ref.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAqBH;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,MAAe;IAC1C,IAAI,OAAO,MAAM,KAAK,UAAU;QAAE,OAAO,SAAS,CAAC;IACnD,MAAM,MAAM,GAAI,MAAyC,CAAC,QAAQ,CAAC;IACnE,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC5E,OAAO,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,GAAG,EAAE,CAAC;IACvD,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAgCD;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,GAAgB;IAC3C,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,GAAG,CAAC;IACxC,MAAM,IAAI,GAAG,YAAY,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC;IACrC,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CACb,kBAAkB,GAAG,CAAC,IAAI,2EAA2E,CACtG,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/stubs/database/migrations/create_durable_tables.stub

@@ -5,7 +5,7 @@ import { BaseSchema } from '@adonisjs/lucid/schema'
 
 /**
  * Durable workflow tables for the @adonis-agora/durable `lucid` state store: runs, step checkpoints, the
- * search-attribute side-table, signal waiters and buffered signals. JSON payloads are stored as TEXT (the store
+ * search-attribute side-table, signal waiters, buffered signals and buffered events. JSON payloads are stored as TEXT (the store
  * (de)serializes them) and timestamps as epoch-ms integers, so the schema is portable across
  * SQLite / Postgres / MySQL.
  */
@@ -79,9 +79,21 @@ export default class extends BaseSchema {
       table.text('payload')
       table.index(['token'], 'durable_buffered_signals_token_idx')
     })
+
+    // Reliable (buffered) events: a publish matching no live waiter keeps ONE copy here, consumed by
+    // the first future matching `waitForEvent`. Keyed by `name` (many waiters share a name with
+    // different `match`); `id` is the caller-minted PK; `published_at` is epoch-ms.
+    this.schema.createTable('durable_buffered_events', (table) => {
+      table.string('id').primary()
+      table.string('name').notNullable()
+      table.text('payload')
+      table.bigInteger('published_at').notNullable()
+      table.index(['name', 'published_at'], 'durable_buffered_events_name_idx')
+    })
   }
 
   async down() {
+    this.schema.dropTableIfExists('durable_buffered_events')
     this.schema.dropTableIfExists('durable_buffered_signals')
     this.schema.dropTableIfExists('durable_signal_waiters')
     this.schema.dropTableIfExists('durable_run_attributes')

package/dist/stubs/make/workflow/main.stub

@@ -6,17 +6,18 @@
     to: app.makePath('app/workflows', entity.path, workflowFileName + '.ts')
   })
 }}}
-import { Workflow } from '@adonis-agora/durable'
+import { BaseWorkflow } from '@adonis-agora/durable'
 import type { WorkflowCtx } from '@adonis-agora/durable'
 
 interface {{ workflowName }}Input {
   // Define your workflow input here
 }
 
-@Workflow({ name: '{{ registeredName }}', version: '1' })
-export default class {{ workflowName }}Workflow {
+export default class {{ workflowName }}Workflow extends BaseWorkflow {
+  static workflow = { name: '{{ registeredName }}', version: '1' }
+
   async run(ctx: WorkflowCtx, input: {{ workflowName }}Input) {
-    // Your workflow logic here — compose ctx.step / ctx.call / ctx.child / ctx.sleep …
+    // Your workflow logic here — compose ctx.step / ctx.localStep / ctx.child / ctx.sleep …
     return input
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonis-agora/durable",
-  "version": "0.6.1",
+  "version": "0.8.0",
   "description": "Durable cross-app workflows for AdonisJS — deterministic replay engine, AdonisJS binding, ace commands, dashboard, OpenTelemetry, Telescope, testing harness and Redis admission, all in one package. Part of the Agora ecosystem.",
   "license": "MIT",
   "repository": {
@@ -18,6 +18,11 @@
       "import": "./dist/src/index.js",
       "default": "./dist/src/index.js"
     },
+    "./services/main": {
+      "types": "./dist/src/services/main.d.ts",
+      "import": "./dist/src/services/main.js",
+      "default": "./dist/src/services/main.js"
+    },
     "./durable_provider": {
       "types": "./dist/providers/durable_provider.d.ts",
       "import": "./dist/providers/durable_provider.js",
@@ -58,6 +63,11 @@
       "import": "./dist/src/hooks/workflows.js",
       "default": "./dist/src/hooks/workflows.js"
     },
+    "./hooks/steps": {
+      "types": "./dist/src/hooks/steps.d.ts",
+      "import": "./dist/src/hooks/steps.js",
+      "default": "./dist/src/hooks/steps.js"
+    },
     "./admission-redis": {
       "types": "./dist/src/admission-redis/index.d.ts",
       "import": "./dist/src/admission-redis/index.js",

package/dist/src/remote-step-factory.d.ts

@@ -1,15 +0,0 @@
-import type { z } from 'zod';
-import type { RemoteStepDef, StepOptions } from './interfaces.js';
-export interface RemoteStepConfig<TInput, TOutput> extends StepOptions {
-    name: string;
-    /** Worker group expected to handle this step. Defaults to the `name` prefix before the first dot. */
-    group?: string;
-    input: z.ZodType<TInput>;
-    output: z.ZodType<TOutput>;
-}
-/**
- * Defines a typed handle to a step that runs on a remote worker. Call it from a workflow with
- * `ctx.call(step, input)`; a worker registers a handler under the same `name`.
- */
-export declare function remoteStep<TInput, TOutput>(config: RemoteStepConfig<TInput, TOutput>): RemoteStepDef<TInput, TOutput>;
-//# sourceMappingURL=remote-step-factory.d.ts.map

package/dist/src/remote-step-factory.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"remote-step-factory.d.ts","sourceRoot":"","sources":["../../src/remote-step-factory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAC7B,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAElE,MAAM,WAAW,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAE,SAAQ,WAAW;IACpE,IAAI,EAAE,MAAM,CAAC;IACb,qGAAqG;IACrG,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACzB,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;CAC5B;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,OAAO,EACxC,MAAM,EAAE,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,GACxC,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,CAMhC"}

package/dist/src/remote-step-factory.js

@@ -1,12 +0,0 @@
-/**
- * Defines a typed handle to a step that runs on a remote worker. Call it from a workflow with
- * `ctx.call(step, input)`; a worker registers a handler under the same `name`.
- */
-export function remoteStep(config) {
-    return {
-        ...config,
-        group: config.group ?? config.name.split('.')[0] ?? config.name,
-        __remote: true,
-    };
-}
-//# sourceMappingURL=remote-step-factory.js.map

package/dist/src/remote-step-factory.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"remote-step-factory.js","sourceRoot":"","sources":["../../src/remote-step-factory.ts"],"names":[],"mappings":"AAWA;;;GAGG;AACH,MAAM,UAAU,UAAU,CACxB,MAAyC;IAEzC,OAAO;QACL,GAAG,MAAM;QACT,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI;QAC/D,QAAQ,EAAE,IAAI;KACf,CAAC;AACJ,CAAC"}