@dudousxd/nestjs-durable 0.27.0 → 0.29.0

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { StepError, WorkflowRef, SingletonConfig, StateStore, Transport, NamedTransport, ControlPlane, ScheduledWorkflow, RetentionPolicy, QueueConfig, AdmissionBackend, WorkflowClass, WorkflowInputOf, StartOptions, RunResult, RunGateway, WorkflowEngine, EntityHandler, RunDetail, RunQuery, WorkflowRun, EngineEvent, RunRequest, RunReply, StepInvocation, TenantEvent } from '@dudousxd/nestjs-durable-core';
+import { StepError, WorkflowRef, SingletonConfig, StateStore, Transport, NamedTransport, ControlPlane, ScheduledWorkflow, RetentionPolicy, QueueConfig, AdmissionBackend, WorkflowClass, WorkflowInputOf, StartOptions, RunResult, RunGateway, WorkflowEngine, EntityHandler, RunDetail, RunQuery, WorkflowRun, GroupHealth, EngineEvent, RunRequest, RunReply, StepInvocation, TenantEvent } from '@dudousxd/nestjs-durable-core';
 import { z } from 'zod';
 import { ConcurrencyOption, StartRunDeps, RunRedisWorkerOptions, RunningWorker, DurableWorkerRuntime } from '@dudousxd/durable-worker';
 import { DynamicModule, InjectionToken, OnModuleInit, OnApplicationBootstrap, OnApplicationShutdown, Provider } from '@nestjs/common';
@@ -106,7 +106,7 @@ interface WorkflowOptions {
      * Start a fresh run of this workflow whenever any of these events is published via
      * `publishEvent(name, payload)` — the payload becomes the run's input. e.g.
      * `onEvent: ['user.registered', 'user.invited']`. The same subscription can also be declared with
-     * the `@OnEvent(...)` class decorator; the two are merged.
+     * the `@OnDurableEvent(...)` class decorator; the two are merged.
      */
     onEvent?: string[];
     /**
@@ -234,11 +234,16 @@ declare const ON_EVENT_METADATA: unique symbol;
 /**
  * Subscribe a `@Workflow` class to one or more events: when any of them is published via
  * `publishEvent(name, payload)`, a fresh run of the workflow starts with the payload as input.
- * Equivalent to `@Workflow({ onEvent })` — use whichever reads better; multiple `@OnEvent(...)`
- * decorators and the option are all merged.
+ * Equivalent to `@Workflow({ onEvent })` — use whichever reads better; multiple
+ * `@OnDurableEvent(...)` decorators and the option are all merged.
+ *
+ * Named "durable" on purpose: `@nestjs/event-emitter` exports an `@OnEvent` decorator, and in an
+ * app using both libs an auto-import picking the wrong one fails silently in either direction.
  */
-declare function OnEvent(...events: string[]): ClassDecorator;
-/** All events a workflow class subscribes to — the union of `@Workflow({ onEvent })` and `@OnEvent`. */
+declare function OnDurableEvent(...events: string[]): ClassDecorator;
+/** @deprecated Renamed to `OnDurableEvent` — this alias clashes with `@nestjs/event-emitter`'s `@OnEvent` and will be removed in the next minor. */
+declare const OnEvent: typeof OnDurableEvent;
+/** All events a workflow class subscribes to — the union of `@Workflow({ onEvent })` and `@OnDurableEvent`. */
 declare function getOnEvents(meta: WorkflowMeta, target: object): string[];
 
 /**
@@ -712,6 +717,8 @@ declare class ProxyRunGateway implements RunGateway {
     private request;
     getRunDetail(runId: string): Promise<RunDetail | null>;
     listRuns(query: RunQuery): Promise<WorkflowRun[]>;
+    /** Round-trips to the operator, which scopes the result to this tenant's own `@<tenant>` groups. */
+    workerHealth(): Promise<GroupHealth[]>;
     cancel(runId: string, opts?: {
         compensate?: boolean;
     }): Promise<RunResult | null>;
@@ -796,6 +803,9 @@ declare class StoreRunGateway implements RunGateway {
     constructor(store: StateStore, engine: WorkflowEngine);
     getRunDetail(runId: string): Promise<RunDetail | null>;
     listRuns(query: RunQuery): Promise<WorkflowRun[]>;
+    /** Every group the engine knows about — unscoped. A tenant proxy's request is scoped by the
+     *  `RunRequestResponder` (to the requester's `@<tenant>` groups); the operator's own UI sees all. */
+    workerHealth(): Promise<GroupHealth[]>;
     cancel(runId: string, opts?: {
         compensate?: boolean;
     }): Promise<RunResult | null>;
@@ -901,7 +911,7 @@ declare class WorkflowService {
     }>;
     /**
      * Publish a named event. Resumes runs waiting on it via `ctx.waitForEvent(name, { match })` and
-     * starts a fresh run of every workflow subscribed via `@Workflow({ onEvent })` / `@OnEvent` (the
+     * starts a fresh run of every workflow subscribed via `@Workflow({ onEvent })` / `@OnDurableEvent` (the
      * payload becomes its input). Pass `opts.id` to dedupe redeliveries. Returns how many runs it
      * touched (resumed + started).
      */
@@ -910,4 +920,4 @@ declare class WorkflowService {
     }): Promise<number>;
 }
 
-export { CONTEXT_ACCESSOR, type ContextAccessor, type ContextStore, DEAD_LETTER_METADATA, DURABLE_STEP_METADATA, DURABLE_WORKER_RUNNERS, DeadLetter, DurableModule, type DurableModuleAsyncOptions, type DurableModuleOptions, type DurableRetentionOptions, DurableStartClient, DurableStep, type DurableStepInterceptor, type DurableStepMeta, ENTITY_METADATA, ENTITY_ON_METADATA, Entity, EntityService, IN_APP_RUN_REDIS_WORKER, IN_APP_WORKER_BINDING, IN_APP_WORKER_RUNNERS, IN_APP_WORKER_RUNTIME, type InAppWorkerBinding, InAppWorkerBootstrap, ON_EVENT_METADATA, On, OnEvent, ProxyRunGateway, RUN_GATEWAY, RUN_REDIS_WORKER, type RunLookupStore, type RunRedisWorkerFn, RunRequestResponder, type RunRequestTransport, STEP_INTERCEPTOR_METADATA, Step, StepInterceptor, type StepOptions, StoreRunGateway, TenantEventRepublisher, ThinStepRegistrar, ThinWorkerBootstrap, ThinWorkflowRegistrar, type UserRef, WORKFLOW_METADATA, Workflow, type WorkflowMeta, type WorkflowOptions, WorkflowService, entityConfigFor, getDurableStepMeta, getEntityMeta, getOnEvents, getWorkflowMeta, inAppWorkerProviders, isDeadLetterHandler, isDrivingOperator, isOperatorRole, isStepInterceptor, thinWorkerProviders, unavailableRunGateway };
+export { CONTEXT_ACCESSOR, type ContextAccessor, type ContextStore, DEAD_LETTER_METADATA, DURABLE_STEP_METADATA, DURABLE_WORKER_RUNNERS, DeadLetter, DurableModule, type DurableModuleAsyncOptions, type DurableModuleOptions, type DurableRetentionOptions, DurableStartClient, DurableStep, type DurableStepInterceptor, type DurableStepMeta, ENTITY_METADATA, ENTITY_ON_METADATA, Entity, EntityService, IN_APP_RUN_REDIS_WORKER, IN_APP_WORKER_BINDING, IN_APP_WORKER_RUNNERS, IN_APP_WORKER_RUNTIME, type InAppWorkerBinding, InAppWorkerBootstrap, ON_EVENT_METADATA, On, OnDurableEvent, OnEvent, ProxyRunGateway, RUN_GATEWAY, RUN_REDIS_WORKER, type RunLookupStore, type RunRedisWorkerFn, RunRequestResponder, type RunRequestTransport, STEP_INTERCEPTOR_METADATA, Step, StepInterceptor, type StepOptions, StoreRunGateway, TenantEventRepublisher, ThinStepRegistrar, ThinWorkerBootstrap, ThinWorkflowRegistrar, type UserRef, WORKFLOW_METADATA, Workflow, type WorkflowMeta, type WorkflowOptions, WorkflowService, entityConfigFor, getDurableStepMeta, getEntityMeta, getOnEvents, getWorkflowMeta, inAppWorkerProviders, isDeadLetterHandler, isDrivingOperator, isOperatorRole, isStepInterceptor, thinWorkerProviders, unavailableRunGateway };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { StepError, WorkflowRef, SingletonConfig, StateStore, Transport, NamedTransport, ControlPlane, ScheduledWorkflow, RetentionPolicy, QueueConfig, AdmissionBackend, WorkflowClass, WorkflowInputOf, StartOptions, RunResult, RunGateway, WorkflowEngine, EntityHandler, RunDetail, RunQuery, WorkflowRun, EngineEvent, RunRequest, RunReply, StepInvocation, TenantEvent } from '@dudousxd/nestjs-durable-core';
+import { StepError, WorkflowRef, SingletonConfig, StateStore, Transport, NamedTransport, ControlPlane, ScheduledWorkflow, RetentionPolicy, QueueConfig, AdmissionBackend, WorkflowClass, WorkflowInputOf, StartOptions, RunResult, RunGateway, WorkflowEngine, EntityHandler, RunDetail, RunQuery, WorkflowRun, GroupHealth, EngineEvent, RunRequest, RunReply, StepInvocation, TenantEvent } from '@dudousxd/nestjs-durable-core';
 import { z } from 'zod';
 import { ConcurrencyOption, StartRunDeps, RunRedisWorkerOptions, RunningWorker, DurableWorkerRuntime } from '@dudousxd/durable-worker';
 import { DynamicModule, InjectionToken, OnModuleInit, OnApplicationBootstrap, OnApplicationShutdown, Provider } from '@nestjs/common';
@@ -106,7 +106,7 @@ interface WorkflowOptions {
      * Start a fresh run of this workflow whenever any of these events is published via
      * `publishEvent(name, payload)` — the payload becomes the run's input. e.g.
      * `onEvent: ['user.registered', 'user.invited']`. The same subscription can also be declared with
-     * the `@OnEvent(...)` class decorator; the two are merged.
+     * the `@OnDurableEvent(...)` class decorator; the two are merged.
      */
     onEvent?: string[];
     /**
@@ -234,11 +234,16 @@ declare const ON_EVENT_METADATA: unique symbol;
 /**
  * Subscribe a `@Workflow` class to one or more events: when any of them is published via
  * `publishEvent(name, payload)`, a fresh run of the workflow starts with the payload as input.
- * Equivalent to `@Workflow({ onEvent })` — use whichever reads better; multiple `@OnEvent(...)`
- * decorators and the option are all merged.
+ * Equivalent to `@Workflow({ onEvent })` — use whichever reads better; multiple
+ * `@OnDurableEvent(...)` decorators and the option are all merged.
+ *
+ * Named "durable" on purpose: `@nestjs/event-emitter` exports an `@OnEvent` decorator, and in an
+ * app using both libs an auto-import picking the wrong one fails silently in either direction.
  */
-declare function OnEvent(...events: string[]): ClassDecorator;
-/** All events a workflow class subscribes to — the union of `@Workflow({ onEvent })` and `@OnEvent`. */
+declare function OnDurableEvent(...events: string[]): ClassDecorator;
+/** @deprecated Renamed to `OnDurableEvent` — this alias clashes with `@nestjs/event-emitter`'s `@OnEvent` and will be removed in the next minor. */
+declare const OnEvent: typeof OnDurableEvent;
+/** All events a workflow class subscribes to — the union of `@Workflow({ onEvent })` and `@OnDurableEvent`. */
 declare function getOnEvents(meta: WorkflowMeta, target: object): string[];
 
 /**
@@ -712,6 +717,8 @@ declare class ProxyRunGateway implements RunGateway {
     private request;
     getRunDetail(runId: string): Promise<RunDetail | null>;
     listRuns(query: RunQuery): Promise<WorkflowRun[]>;
+    /** Round-trips to the operator, which scopes the result to this tenant's own `@<tenant>` groups. */
+    workerHealth(): Promise<GroupHealth[]>;
     cancel(runId: string, opts?: {
         compensate?: boolean;
     }): Promise<RunResult | null>;
@@ -796,6 +803,9 @@ declare class StoreRunGateway implements RunGateway {
     constructor(store: StateStore, engine: WorkflowEngine);
     getRunDetail(runId: string): Promise<RunDetail | null>;
     listRuns(query: RunQuery): Promise<WorkflowRun[]>;
+    /** Every group the engine knows about — unscoped. A tenant proxy's request is scoped by the
+     *  `RunRequestResponder` (to the requester's `@<tenant>` groups); the operator's own UI sees all. */
+    workerHealth(): Promise<GroupHealth[]>;
     cancel(runId: string, opts?: {
         compensate?: boolean;
     }): Promise<RunResult | null>;
@@ -901,7 +911,7 @@ declare class WorkflowService {
     }>;
     /**
      * Publish a named event. Resumes runs waiting on it via `ctx.waitForEvent(name, { match })` and
-     * starts a fresh run of every workflow subscribed via `@Workflow({ onEvent })` / `@OnEvent` (the
+     * starts a fresh run of every workflow subscribed via `@Workflow({ onEvent })` / `@OnDurableEvent` (the
      * payload becomes its input). Pass `opts.id` to dedupe redeliveries. Returns how many runs it
      * touched (resumed + started).
      */
@@ -910,4 +920,4 @@ declare class WorkflowService {
     }): Promise<number>;
 }
 
-export { CONTEXT_ACCESSOR, type ContextAccessor, type ContextStore, DEAD_LETTER_METADATA, DURABLE_STEP_METADATA, DURABLE_WORKER_RUNNERS, DeadLetter, DurableModule, type DurableModuleAsyncOptions, type DurableModuleOptions, type DurableRetentionOptions, DurableStartClient, DurableStep, type DurableStepInterceptor, type DurableStepMeta, ENTITY_METADATA, ENTITY_ON_METADATA, Entity, EntityService, IN_APP_RUN_REDIS_WORKER, IN_APP_WORKER_BINDING, IN_APP_WORKER_RUNNERS, IN_APP_WORKER_RUNTIME, type InAppWorkerBinding, InAppWorkerBootstrap, ON_EVENT_METADATA, On, OnEvent, ProxyRunGateway, RUN_GATEWAY, RUN_REDIS_WORKER, type RunLookupStore, type RunRedisWorkerFn, RunRequestResponder, type RunRequestTransport, STEP_INTERCEPTOR_METADATA, Step, StepInterceptor, type StepOptions, StoreRunGateway, TenantEventRepublisher, ThinStepRegistrar, ThinWorkerBootstrap, ThinWorkflowRegistrar, type UserRef, WORKFLOW_METADATA, Workflow, type WorkflowMeta, type WorkflowOptions, WorkflowService, entityConfigFor, getDurableStepMeta, getEntityMeta, getOnEvents, getWorkflowMeta, inAppWorkerProviders, isDeadLetterHandler, isDrivingOperator, isOperatorRole, isStepInterceptor, thinWorkerProviders, unavailableRunGateway };
+export { CONTEXT_ACCESSOR, type ContextAccessor, type ContextStore, DEAD_LETTER_METADATA, DURABLE_STEP_METADATA, DURABLE_WORKER_RUNNERS, DeadLetter, DurableModule, type DurableModuleAsyncOptions, type DurableModuleOptions, type DurableRetentionOptions, DurableStartClient, DurableStep, type DurableStepInterceptor, type DurableStepMeta, ENTITY_METADATA, ENTITY_ON_METADATA, Entity, EntityService, IN_APP_RUN_REDIS_WORKER, IN_APP_WORKER_BINDING, IN_APP_WORKER_RUNNERS, IN_APP_WORKER_RUNTIME, type InAppWorkerBinding, InAppWorkerBootstrap, ON_EVENT_METADATA, On, OnDurableEvent, OnEvent, ProxyRunGateway, RUN_GATEWAY, RUN_REDIS_WORKER, type RunLookupStore, type RunRedisWorkerFn, RunRequestResponder, type RunRequestTransport, STEP_INTERCEPTOR_METADATA, Step, StepInterceptor, type StepOptions, StoreRunGateway, TenantEventRepublisher, ThinStepRegistrar, ThinWorkerBootstrap, ThinWorkflowRegistrar, type UserRef, WORKFLOW_METADATA, Workflow, type WorkflowMeta, type WorkflowOptions, WorkflowService, entityConfigFor, getDurableStepMeta, getEntityMeta, getOnEvents, getWorkflowMeta, inAppWorkerProviders, isDeadLetterHandler, isDrivingOperator, isOperatorRole, isStepInterceptor, thinWorkerProviders, unavailableRunGateway };

package/dist/index.js

@@ -91,7 +91,7 @@ function isDeadLetterHandler(method) {
 }
 __name(isDeadLetterHandler, "isDeadLetterHandler");
 var ON_EVENT_METADATA = Symbol("nestjs-durable:on-event");
-function OnEvent(...events) {
+function OnDurableEvent(...events) {
   return (target) => {
     const existing = Reflect.getMetadata(ON_EVENT_METADATA, target) ?? [];
     Reflect.defineMetadata(ON_EVENT_METADATA, [
@@ -100,7 +100,8 @@ function OnEvent(...events) {
     ], target);
   };
 }
-__name(OnEvent, "OnEvent");
+__name(OnDurableEvent, "OnDurableEvent");
+var OnEvent = OnDurableEvent;
 function getOnEvents(meta, target) {
   const fromDecorator = Reflect.getMetadata(ON_EVENT_METADATA, target) ?? [];
   return [
@@ -429,6 +430,9 @@ function unavailableRunGateway() {
     listRuns(_query) {
       return tenantGatewayUnavailable("listRuns");
     },
+    workerHealth() {
+      return tenantGatewayUnavailable("workerHealth");
+    },
     cancel(_runId) {
       return tenantGatewayUnavailable("cancel");
     },
@@ -826,6 +830,12 @@ var ProxyRunGateway = class {
       query
     });
   }
+  /** Round-trips to the operator, which scopes the result to this tenant's own `@<tenant>` groups. */
+  workerHealth() {
+    return this.request({
+      kind: "workerHealth"
+    });
+  }
   cancel(runId, opts) {
     return this.request(opts === void 0 ? {
       kind: "cancel",
@@ -1022,6 +1032,17 @@ var RunRequestResponder = class {
         }
       };
     }
+    if (body.kind === "workerHealth") {
+      const all = await this.gateway.workerHealth();
+      const data = all.filter((h) => h.group.endsWith(`@${msg.tenant}`));
+      return {
+        requestId: msg.requestId,
+        result: {
+          ok: true,
+          data
+        }
+      };
+    }
     const detail = await this.gateway.getRunDetail(body.runId);
     if (detail && detail.run.namespace !== msg.tenant) {
       return {
@@ -1125,6 +1146,11 @@ var StoreRunGateway = class {
   listRuns(query) {
     return this.store.listRuns(query);
   }
+  /** Every group the engine knows about — unscoped. A tenant proxy's request is scoped by the
+  *  `RunRequestResponder` (to the requester's `@<tenant>` groups); the operator's own UI sees all. */
+  workerHealth() {
+    return this.engine.workerHealth();
+  }
   cancel(runId, opts) {
     return this.engine.cancel(runId, opts);
   }
@@ -1274,7 +1300,7 @@ var CONTEXT_ACCESSOR = Symbol.for("@dudousxd/nestjs-context:accessor");
 var RUN_GATEWAY = Symbol.for("nestjs-durable:run-gateway");
 
 // src/workflow.registrar.ts
-import { DURABLE_OPTIONS_CANONICAL as DURABLE_OPTIONS_CANONICAL6, RemoteWorkflowExecutor, STATE_STORE_CANONICAL as STATE_STORE_CANONICAL3, WorkflowEngine as WorkflowEngine4, parseDuration as parseDuration2, sanitizeQueueToken, tenantGroup, workflowName as workflowName2 } from "@dudousxd/nestjs-durable-core";
+import { DURABLE_OPTIONS_CANONICAL as DURABLE_OPTIONS_CANONICAL6, RemoteWorkflowExecutor, STATE_STORE_CANONICAL as STATE_STORE_CANONICAL3, WorkflowEngine as WorkflowEngine4, bindWorkflowClass, parseDuration as parseDuration2, sanitizeQueueToken, tenantGroup, workflowName as workflowName2 } from "@dudousxd/nestjs-durable-core";
 import { Inject as Inject7, Injectable as Injectable10 } from "@nestjs/common";
 import { DiscoveryService as DiscoveryService4, MetadataScanner as MetadataScanner4 } from "@nestjs/core";
 
@@ -1424,6 +1450,10 @@ var WorkflowRegistrar = class {
           executor: new RemoteWorkflowExecutor(this.inAppWorker.transport, meta.name, this.inAppWorker.partition)
         } : {}
       });
+      bindWorkflowClass(workflowCtor, {
+        start: /* @__PURE__ */ __name((name, input, runId, opts) => this.engine.start(name, input, runId, opts), "start"),
+        waitForRun: /* @__PURE__ */ __name((runId, opts) => this.engine.waitForRun(runId, opts), "waitForRun")
+      });
       const inline = this.findDeadLetterHandler(workflow);
       if (inline && meta.deadLetterWorkflow) {
         throw new Error(`@Workflow ${meta.name} declares both an inline @DeadLetter() method and a deadLetterWorkflow option. Use one: the inline handler, or the reference.`);
@@ -1540,7 +1570,7 @@ var WorkflowService = class {
   }
   /**
   * Publish a named event. Resumes runs waiting on it via `ctx.waitForEvent(name, { match })` and
-  * starts a fresh run of every workflow subscribed via `@Workflow({ onEvent })` / `@OnEvent` (the
+  * starts a fresh run of every workflow subscribed via `@Workflow({ onEvent })` / `@OnDurableEvent` (the
   * payload becomes its input). Pass `opts.id` to dedupe redeliveries. Returns how many runs it
   * touched (resumed + started).
   */
@@ -1874,6 +1904,7 @@ export {
   InAppWorkerBootstrap,
   ON_EVENT_METADATA,
   On,
+  OnDurableEvent,
   OnEvent,
   ProxyRunGateway,
   RUN_GATEWAY,