@dudousxd/nestjs-durable-dashboard 0.52.1 → 0.54.0

package/dist/server/index.d.cts

@@ -1,5 +1,5 @@
 import * as _dudousxd_nestjs_durable_core from '@dudousxd/nestjs-durable-core';
-import { RunGateway, StateStore, WorkflowEngine, ScheduleListQuery, ScheduleDescription, RunResult, RunQuery, RunListItem, RunFacetQuery, RunFacetRow, RunValueAxis, RunValueFacetOptions, RunValueFacetRow, DurableTopology, GroupHealth, RunDetailOptions, RunDetail, FanPageQuery, FanPage, UpdateResult, EngineEvent, AttributeFilter } from '@dudousxd/nestjs-durable-core';
+import { RunGateway, StateStore, WorkflowEngine, ScheduleListQuery, ScheduleDescription, RunResult, RunQuery, RunListItem, RunFacetQuery, RunFacetRow, RunValueAxis, RunValueFacetOptions, RunValueFacetRow, DurableTopology, GroupHealth, RunDetailOptions, RunDetail, FanPageQuery, FanPage, RepublishLifecycleResult, WorkflowLifecycleLinks, UpdateResult, EngineEvent, AttributeFilter } from '@dudousxd/nestjs-durable-core';
 export { RunDetail } from '@dudousxd/nestjs-durable-core';
 import * as rxjs from 'rxjs';
 import { Observable } from 'rxjs';
@@ -113,6 +113,17 @@ interface ResolvedDashboardAuth {
  * Operator-only ops (metrics/deliverWebhook/getEvent/update) still need direct `store`/`engine`
  * access; they stay `@Optional()` and throw a clear error when absent.
  */
+/**
+ * A workflow's lifecycle links as `GET workflows/:name/lifecycle` answers them, plus `triggerCounts`:
+ * per subscriber of `startsOnSettle`, how many runs it was started for (`triggered`) and how many
+ * times starting it failed (`failed`), counted by this process's metrics since it started.
+ */
+interface WorkflowLifecyclePage extends WorkflowLifecycleLinks {
+    triggerCounts?: Record<string, {
+        triggered: number;
+        failed: number;
+    }> | undefined;
+}
 declare class DashboardService {
     private readonly gateway;
     private readonly store?;
@@ -176,6 +187,23 @@ declare class DashboardService {
     cancel(runId: string, opts?: {
         compensate?: boolean;
     }): Promise<RunResult | null>;
+    /**
+     * Publish a settled run's lifecycle event again, to its subscribers that have not started (or to
+     * `subscriber` alone). Undefined when the gateway cannot republish (a tenant proxy).
+     */
+    republishLifecycle(runId: string, subscriber?: string): Promise<RepublishLifecycleResult | undefined>;
+    /**
+     * Who starts whom through lifecycle events, for `workflow`, plus `triggerCounts` when this process
+     * counts the engine's events (the control plane) and the workflow has subscribers. Undefined when
+     * the gateway cannot answer.
+     */
+    workflowLifecycle(workflow: string): Promise<WorkflowLifecyclePage | undefined>;
+    /**
+     * How many runs each subscriber of `links.workflow` was started for and how many times starting it
+     * failed, counted by this process's metrics since it started. Undefined without metrics (a tenant)
+     * or without subscribers.
+     */
+    private triggerCountsOf;
     /**
      * Apply `retry` or `cancel` to every run matching a filter (status / tag / workflow / namespace /
      * origin) — e.g. "retry every `dead` run tagged `type:mel`". The filter is the same one the run
@@ -318,6 +346,11 @@ declare class DurableApiController {
     resumeSchedule(id: string): Promise<_dudousxd_nestjs_durable_core.ScheduleDescription>;
     /** Start one run of the schedule now, outside its cadence. */
     triggerSchedule(id: string): Promise<_dudousxd_nestjs_durable_core.RunResult>;
+    /**
+     * Who starts whom through lifecycle events, for one workflow: the workflows that start when it
+     * settles, and the ones whose settling starts it. What the console's workflow page lists.
+     */
+    workflowLifecycle(name: string): Promise<WorkflowLifecyclePage>;
     /** This deployment's durable role (control plane vs tenant) + tenant name — for the header badge. */
     topology(): _dudousxd_nestjs_durable_core.DurableTopology;
     /**
@@ -334,6 +367,13 @@ declare class DurableApiController {
         children: string[];
         fans?: _dudousxd_nestjs_durable_core.FanSummary[] | undefined;
         childCount?: number | undefined;
+        triggered?: string[] | undefined;
+        triggeredBy?: _dudousxd_nestjs_durable_core.LifecycleSource | undefined;
+        lifecycleSubscribers?: string[] | undefined;
+        workflowLifecycle?: _dudousxd_nestjs_durable_core.WorkflowLifecycleLinks | undefined;
+        lifecycleDeliveries?: _dudousxd_nestjs_durable_core.LifecycleDelivery[] | undefined;
+        waitsFor?: _dudousxd_nestjs_durable_core.RunWaitLink[] | undefined;
+        awaitedBy?: _dudousxd_nestjs_durable_core.RunWaitLink[] | undefined;
     }>;
     /** One page of a summarized fan's members, in seq order. Versioned like {@link run}. */
     fanMembers(id: string, group: string, offset?: string, limit?: string, failed?: string, ifNoneMatch?: string, response?: unknown): Promise<{
@@ -362,6 +402,13 @@ declare class DurableApiController {
         applied: number;
     }>;
     cancel(id: string, compensate?: string): Promise<_dudousxd_nestjs_durable_core.RunResult>;
+    /**
+     * Publish a settled run's lifecycle event again, to the subscribers that have not started from it
+     * (or only `subscriber`). Same gate as retry/cancel.
+     */
+    republishLifecycle(id: string, body?: {
+        subscriber?: string;
+    }): Promise<_dudousxd_nestjs_durable_core.RepublishLifecycleResult>;
     continue(id: string): Promise<_dudousxd_nestjs_durable_core.RunResult>;
     /** Re-dispatch a run's stuck `pending` remote steps — recovery for a lost step dispatch. */
     redispatch(id: string): Promise<_dudousxd_nestjs_durable_core.RunResult & {
@@ -732,4 +779,4 @@ declare class DurableUiController {
     asset(file: string): StreamableFile;
 }
 
-export { DASHBOARD_API_PATH, DASHBOARD_BASE_PATH, DASHBOARD_GATE, DURABLE_DASHBOARD_TOKEN_ENV, type DashboardAuthOptions, type DashboardGate, type DashboardGateMode, type DashboardGateOptions, DashboardService, type DashboardSessionUser, DurableApiController, DurableApiModule, DurableApiSessionGuard, DurableAuthController, type DurableDashboardAsyncOptions, DurableDashboardGateGuard, DurableDashboardModule, type DurableDashboardOptions, DurableUiController, DurableUiSessionGuard, type UnauthenticatedPageContext, type UnauthenticatedPageHook, dashboardGateProvider, readDashboardToken, reportDashboardGate, resolveDashboardGate };
+export { DASHBOARD_API_PATH, DASHBOARD_BASE_PATH, DASHBOARD_GATE, DURABLE_DASHBOARD_TOKEN_ENV, type DashboardAuthOptions, type DashboardGate, type DashboardGateMode, type DashboardGateOptions, DashboardService, type DashboardSessionUser, DurableApiController, DurableApiModule, DurableApiSessionGuard, DurableAuthController, type DurableDashboardAsyncOptions, DurableDashboardGateGuard, DurableDashboardModule, type DurableDashboardOptions, DurableUiController, DurableUiSessionGuard, type UnauthenticatedPageContext, type UnauthenticatedPageHook, type WorkflowLifecyclePage, dashboardGateProvider, readDashboardToken, reportDashboardGate, resolveDashboardGate };

package/dist/server/index.d.ts

@@ -1,5 +1,5 @@
 import * as _dudousxd_nestjs_durable_core from '@dudousxd/nestjs-durable-core';
-import { RunGateway, StateStore, WorkflowEngine, ScheduleListQuery, ScheduleDescription, RunResult, RunQuery, RunListItem, RunFacetQuery, RunFacetRow, RunValueAxis, RunValueFacetOptions, RunValueFacetRow, DurableTopology, GroupHealth, RunDetailOptions, RunDetail, FanPageQuery, FanPage, UpdateResult, EngineEvent, AttributeFilter } from '@dudousxd/nestjs-durable-core';
+import { RunGateway, StateStore, WorkflowEngine, ScheduleListQuery, ScheduleDescription, RunResult, RunQuery, RunListItem, RunFacetQuery, RunFacetRow, RunValueAxis, RunValueFacetOptions, RunValueFacetRow, DurableTopology, GroupHealth, RunDetailOptions, RunDetail, FanPageQuery, FanPage, RepublishLifecycleResult, WorkflowLifecycleLinks, UpdateResult, EngineEvent, AttributeFilter } from '@dudousxd/nestjs-durable-core';
 export { RunDetail } from '@dudousxd/nestjs-durable-core';
 import * as rxjs from 'rxjs';
 import { Observable } from 'rxjs';
@@ -113,6 +113,17 @@ interface ResolvedDashboardAuth {
  * Operator-only ops (metrics/deliverWebhook/getEvent/update) still need direct `store`/`engine`
  * access; they stay `@Optional()` and throw a clear error when absent.
  */
+/**
+ * A workflow's lifecycle links as `GET workflows/:name/lifecycle` answers them, plus `triggerCounts`:
+ * per subscriber of `startsOnSettle`, how many runs it was started for (`triggered`) and how many
+ * times starting it failed (`failed`), counted by this process's metrics since it started.
+ */
+interface WorkflowLifecyclePage extends WorkflowLifecycleLinks {
+    triggerCounts?: Record<string, {
+        triggered: number;
+        failed: number;
+    }> | undefined;
+}
 declare class DashboardService {
     private readonly gateway;
     private readonly store?;
@@ -176,6 +187,23 @@ declare class DashboardService {
     cancel(runId: string, opts?: {
         compensate?: boolean;
     }): Promise<RunResult | null>;
+    /**
+     * Publish a settled run's lifecycle event again, to its subscribers that have not started (or to
+     * `subscriber` alone). Undefined when the gateway cannot republish (a tenant proxy).
+     */
+    republishLifecycle(runId: string, subscriber?: string): Promise<RepublishLifecycleResult | undefined>;
+    /**
+     * Who starts whom through lifecycle events, for `workflow`, plus `triggerCounts` when this process
+     * counts the engine's events (the control plane) and the workflow has subscribers. Undefined when
+     * the gateway cannot answer.
+     */
+    workflowLifecycle(workflow: string): Promise<WorkflowLifecyclePage | undefined>;
+    /**
+     * How many runs each subscriber of `links.workflow` was started for and how many times starting it
+     * failed, counted by this process's metrics since it started. Undefined without metrics (a tenant)
+     * or without subscribers.
+     */
+    private triggerCountsOf;
     /**
      * Apply `retry` or `cancel` to every run matching a filter (status / tag / workflow / namespace /
      * origin) — e.g. "retry every `dead` run tagged `type:mel`". The filter is the same one the run
@@ -318,6 +346,11 @@ declare class DurableApiController {
     resumeSchedule(id: string): Promise<_dudousxd_nestjs_durable_core.ScheduleDescription>;
     /** Start one run of the schedule now, outside its cadence. */
     triggerSchedule(id: string): Promise<_dudousxd_nestjs_durable_core.RunResult>;
+    /**
+     * Who starts whom through lifecycle events, for one workflow: the workflows that start when it
+     * settles, and the ones whose settling starts it. What the console's workflow page lists.
+     */
+    workflowLifecycle(name: string): Promise<WorkflowLifecyclePage>;
     /** This deployment's durable role (control plane vs tenant) + tenant name — for the header badge. */
     topology(): _dudousxd_nestjs_durable_core.DurableTopology;
     /**
@@ -334,6 +367,13 @@ declare class DurableApiController {
         children: string[];
         fans?: _dudousxd_nestjs_durable_core.FanSummary[] | undefined;
         childCount?: number | undefined;
+        triggered?: string[] | undefined;
+        triggeredBy?: _dudousxd_nestjs_durable_core.LifecycleSource | undefined;
+        lifecycleSubscribers?: string[] | undefined;
+        workflowLifecycle?: _dudousxd_nestjs_durable_core.WorkflowLifecycleLinks | undefined;
+        lifecycleDeliveries?: _dudousxd_nestjs_durable_core.LifecycleDelivery[] | undefined;
+        waitsFor?: _dudousxd_nestjs_durable_core.RunWaitLink[] | undefined;
+        awaitedBy?: _dudousxd_nestjs_durable_core.RunWaitLink[] | undefined;
     }>;
     /** One page of a summarized fan's members, in seq order. Versioned like {@link run}. */
     fanMembers(id: string, group: string, offset?: string, limit?: string, failed?: string, ifNoneMatch?: string, response?: unknown): Promise<{
@@ -362,6 +402,13 @@ declare class DurableApiController {
         applied: number;
     }>;
     cancel(id: string, compensate?: string): Promise<_dudousxd_nestjs_durable_core.RunResult>;
+    /**
+     * Publish a settled run's lifecycle event again, to the subscribers that have not started from it
+     * (or only `subscriber`). Same gate as retry/cancel.
+     */
+    republishLifecycle(id: string, body?: {
+        subscriber?: string;
+    }): Promise<_dudousxd_nestjs_durable_core.RepublishLifecycleResult>;
     continue(id: string): Promise<_dudousxd_nestjs_durable_core.RunResult>;
     /** Re-dispatch a run's stuck `pending` remote steps — recovery for a lost step dispatch. */
     redispatch(id: string): Promise<_dudousxd_nestjs_durable_core.RunResult & {
@@ -732,4 +779,4 @@ declare class DurableUiController {
     asset(file: string): StreamableFile;
 }
 
-export { DASHBOARD_API_PATH, DASHBOARD_BASE_PATH, DASHBOARD_GATE, DURABLE_DASHBOARD_TOKEN_ENV, type DashboardAuthOptions, type DashboardGate, type DashboardGateMode, type DashboardGateOptions, DashboardService, type DashboardSessionUser, DurableApiController, DurableApiModule, DurableApiSessionGuard, DurableAuthController, type DurableDashboardAsyncOptions, DurableDashboardGateGuard, DurableDashboardModule, type DurableDashboardOptions, DurableUiController, DurableUiSessionGuard, type UnauthenticatedPageContext, type UnauthenticatedPageHook, dashboardGateProvider, readDashboardToken, reportDashboardGate, resolveDashboardGate };
+export { DASHBOARD_API_PATH, DASHBOARD_BASE_PATH, DASHBOARD_GATE, DURABLE_DASHBOARD_TOKEN_ENV, type DashboardAuthOptions, type DashboardGate, type DashboardGateMode, type DashboardGateOptions, DashboardService, type DashboardSessionUser, DurableApiController, DurableApiModule, DurableApiSessionGuard, DurableAuthController, type DurableDashboardAsyncOptions, DurableDashboardGateGuard, DurableDashboardModule, type DurableDashboardOptions, DurableUiController, DurableUiSessionGuard, type UnauthenticatedPageContext, type UnauthenticatedPageHook, type WorkflowLifecyclePage, dashboardGateProvider, readDashboardToken, reportDashboardGate, resolveDashboardGate };

package/dist/server/index.js

@@ -174,6 +174,51 @@ var DashboardService = class {
     return this.gateway.cancel(runId, opts);
   }
   /**
+  * Publish a settled run's lifecycle event again, to its subscribers that have not started (or to
+  * `subscriber` alone). Undefined when the gateway cannot republish (a tenant proxy).
+  */
+  async republishLifecycle(runId, subscriber) {
+    return this.gateway.republishLifecycle?.({
+      runId,
+      ...subscriber !== void 0 ? {
+        subscriber
+      } : {}
+    });
+  }
+  /**
+  * Who starts whom through lifecycle events, for `workflow`, plus `triggerCounts` when this process
+  * counts the engine's events (the control plane) and the workflow has subscribers. Undefined when
+  * the gateway cannot answer.
+  */
+  async workflowLifecycle(workflow) {
+    const links = await this.gateway.workflowLifecycle?.(workflow);
+    if (!links) return links;
+    const counts = this.triggerCountsOf(links);
+    return counts ? {
+      ...links,
+      triggerCounts: counts
+    } : links;
+  }
+  /**
+  * How many runs each subscriber of `links.workflow` was started for and how many times starting it
+  * failed, counted by this process's metrics since it started. Undefined without metrics (a tenant)
+  * or without subscribers.
+  */
+  triggerCountsOf(links) {
+    const snapshot = this.metricsCollector?.snapshot();
+    if (!snapshot || links.startsOnSettle.length === 0) return void 0;
+    const triggered = snapshot.triggeredBySubscriber[links.workflow] ?? {};
+    const failed = snapshot.triggerFailedBySubscriber[links.workflow] ?? {};
+    const counts = {};
+    for (const { workflow } of links.startsOnSettle) {
+      counts[workflow] = {
+        triggered: triggered[workflow] ?? 0,
+        failed: failed[workflow] ?? 0
+      };
+    }
+    return counts;
+  }
+  /**
   * Apply `retry` or `cancel` to every run matching a filter (status / tag / workflow / namespace /
   * origin) — e.g. "retry every `dead` run tagged `type:mel`". The filter is the same one the run
   * list uses, so a bulk action can never reach wider than the list it was launched from — but note
@@ -274,7 +319,7 @@ DashboardService = _ts_decorate([
 
 // src/server/durable-api.controller.ts
 import { ApplyFilter, ApplyFilterInterceptor, FilterRunner } from "@dudousxd/nestjs-filter";
-import { Body, Controller, Get, Header, Headers, NotFoundException, Param, Post, Query, Res, Sse, UseFilters, UseInterceptors } from "@nestjs/common";
+import { BadRequestException as BadRequestException2, Body, Controller, Get, Header, Headers, NotFoundException, NotImplementedException, Param, Post, Query, Res, Sse, UseFilters, UseInterceptors } from "@nestjs/common";
 
 // src/server/durable-run.ts
 var DurableRun = class {
@@ -1202,6 +1247,15 @@ var DurableApiController = class {
   triggerSchedule(id) {
     return this.dashboard.triggerSchedule(id).catch(notFound);
   }
+  /**
+  * Who starts whom through lifecycle events, for one workflow: the workflows that start when it
+  * settles, and the ones whose settling starts it. What the console's workflow page lists.
+  */
+  async workflowLifecycle(name) {
+    const links = await this.dashboard.workflowLifecycle(name).catch(notSupportedByServer);
+    if (!links) throw new NotImplementedException("workflow lifecycle links need the control plane");
+    return links;
+  }
   /** This deployment's durable role (control plane vs tenant) + tenant name — for the header badge. */
   topology() {
     return this.dashboard.topology();
@@ -1277,6 +1331,28 @@ var DurableApiController = class {
     if (!result) throw new NotFoundException(`run ${id} not found`);
     return result;
   }
+  /**
+  * Publish a settled run's lifecycle event again, to the subscribers that have not started from it
+  * (or only `subscriber`). Same gate as retry/cancel.
+  */
+  async republishLifecycle(id, body) {
+    let result;
+    try {
+      result = await this.dashboard.republishLifecycle(id, body?.subscriber || void 0);
+    } catch (error) {
+      const message = error instanceof Error ? error.message : String(error);
+      if (/^run .* not found$/.test(message)) throw new NotFoundException(message);
+      if (/^run .* has not settled/.test(message)) throw new BadRequestException2(message);
+      if (error?.code === "bad-request") {
+        throw new BadRequestException2(message);
+      }
+      return notSupportedByServer(error);
+    }
+    if (!result) {
+      throw new NotImplementedException("republishing lifecycle events needs the control plane");
+    }
+    return result;
+  }
   async continue(id) {
     const result = await this.dashboard.continue(id);
     if (!result) throw new NotFoundException(`run ${id} is not paused at a breakpoint`);
@@ -1392,6 +1468,15 @@ _ts_decorate5([
   ]),
   _ts_metadata4("design:returntype", void 0)
 ], DurableApiController.prototype, "triggerSchedule", null);
+_ts_decorate5([
+  Get("workflows/:name/lifecycle"),
+  _ts_param2(0, Param("name")),
+  _ts_metadata4("design:type", Function),
+  _ts_metadata4("design:paramtypes", [
+    String
+  ]),
+  _ts_metadata4("design:returntype", Promise)
+], DurableApiController.prototype, "workflowLifecycle", null);
 _ts_decorate5([
   Get("topology"),
   _ts_metadata4("design:type", Function),
@@ -1491,6 +1576,17 @@ _ts_decorate5([
   ]),
   _ts_metadata4("design:returntype", Promise)
 ], DurableApiController.prototype, "cancel", null);
+_ts_decorate5([
+  Post("runs/:id/republish-lifecycle"),
+  _ts_param2(0, Param("id")),
+  _ts_param2(1, Body()),
+  _ts_metadata4("design:type", Function),
+  _ts_metadata4("design:paramtypes", [
+    String,
+    Object
+  ]),
+  _ts_metadata4("design:returntype", Promise)
+], DurableApiController.prototype, "republishLifecycle", null);
 _ts_decorate5([
   Post("runs/:id/continue"),
   _ts_param2(0, Param("id")),
@@ -1561,9 +1657,16 @@ function notFound(error) {
   throw error;
 }
 __name(notFound, "notFound");
+function notSupportedByServer(error) {
+  if (error?.code === "unsupported-request") {
+    throw new NotImplementedException(error instanceof Error ? error.message : String(error));
+  }
+  throw error;
+}
+__name(notSupportedByServer, "notSupportedByServer");
 
 // src/server/durable-auth.controller.ts
-import { BadRequestException as BadRequestException2, Body as Body2, Controller as Controller3, Get as Get3, Header as Header3, HttpCode, Inject as Inject4, Logger as Logger2, NotFoundException as NotFoundException3, Optional as Optional3, Post as Post2, Req, Res as Res2, UnauthorizedException } from "@nestjs/common";
+import { BadRequestException as BadRequestException3, Body as Body2, Controller as Controller3, Get as Get3, Header as Header3, HttpCode, Inject as Inject4, Logger as Logger2, NotFoundException as NotFoundException3, Optional as Optional3, Post as Post2, Req, Res as Res2, UnauthorizedException } from "@nestjs/common";
 
 // src/server/auth/dashboard-auth-config.ts
 var DASHBOARD_AUTH = Symbol("DASHBOARD_AUTH");
@@ -2346,7 +2449,7 @@ var DurableAuthController = class _DurableAuthController {
     const auth = this.requireAuth();
     if (!auth.modes.includes("login")) throw new NotFoundException3();
     if (!isString(body?.username) || !isString(body?.password)) {
-      throw new BadRequestException2("Body must include string `username` and `password`.");
+      throw new BadRequestException3("Body must include string `username` and `password`.");
     }
     const { username, password } = body;
     const user = await this.runHook("login", () => auth.login?.(username, password) ?? null);