@dudousxd/nestjs-durable-dashboard 0.50.0 → 0.51.1

package/dist/server/index.d.cts

@@ -199,8 +199,12 @@ declare class DashboardService {
     }) | null>;
     /**
      * Deliver a `ctx.webhook()` callback: turn an inbound POST (token + body) into the signal the
-     * waiting run is parked on. Returns the run result, or `null` if no run waits on that token (a
-     * stale/duplicate callback) — a safe no-op the controller maps to 404. Control-plane-only.
+     * run is (or will be) parked on. A callback that arrives BEFORE the run reaches `wait()` (the url
+     * was handed out and the run is still busy or sleeping) is buffered, and `wait()` consumes it, so
+     * the result is the run's current status. Returns `null` — mapped to 404 by the controller — for a
+     * token that is not a webhook token, whose run doesn't exist or is terminal, or whose wait already
+     * resolved (a duplicate): nothing is buffered for those, so a public endpoint can't leave junk
+     * rows behind or signal non-webhook tokens. Control-plane-only.
      */
     deliverWebhook(token: string, body: unknown): Promise<RunResult | null>;
     /** Side-effect-free read of a value a run published via `ctx.setEvent` (a live query). Control-plane-only. */
@@ -319,10 +323,23 @@ declare class DurableApiController {
     /**
      * A run's detail. Fans wider than {@link FAN_INLINE_MAX} come back as one `FanSummary` each, their
      * members paged by `runs/:id/fans/:group`; `?full=true` returns every checkpoint instead.
+     *
+     * When the gateway can version the detail without reading it, the response carries an `ETag`, and
+     * a poll whose `If-None-Match` still names it gets a 304 before the timeline is read. The browser
+     * sends that header itself (the response is `no-cache`), so a console poll needs no code for it.
      */
-    run(id: string, full?: string): Promise<_dudousxd_nestjs_durable_core.RunDetail>;
-    /** One page of a summarized fan's members, in seq order. */
-    fanMembers(id: string, group: string, offset?: string, limit?: string, failed?: string): Promise<_dudousxd_nestjs_durable_core.FanPage>;
+    run(id: string, full?: string, ifNoneMatch?: string, response?: unknown): Promise<{
+        run: _dudousxd_nestjs_durable_core.WorkflowRun;
+        timeline: _dudousxd_nestjs_durable_core.StepCheckpoint[];
+        children: string[];
+        fans?: _dudousxd_nestjs_durable_core.FanSummary[] | undefined;
+        childCount?: number | 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<{
+        items: _dudousxd_nestjs_durable_core.StepCheckpoint[];
+        total: number;
+    }>;
     /** Server-Sent Events stream of a run's live lifecycle events — the dashboard tails it instead
      *  of polling. Cross-pod when the transport has a control plane (see DashboardService.streamRun). */
     stream(id: string): rxjs.Observable<{

package/dist/server/index.d.ts

@@ -199,8 +199,12 @@ declare class DashboardService {
     }) | null>;
     /**
      * Deliver a `ctx.webhook()` callback: turn an inbound POST (token + body) into the signal the
-     * waiting run is parked on. Returns the run result, or `null` if no run waits on that token (a
-     * stale/duplicate callback) — a safe no-op the controller maps to 404. Control-plane-only.
+     * run is (or will be) parked on. A callback that arrives BEFORE the run reaches `wait()` (the url
+     * was handed out and the run is still busy or sleeping) is buffered, and `wait()` consumes it, so
+     * the result is the run's current status. Returns `null` — mapped to 404 by the controller — for a
+     * token that is not a webhook token, whose run doesn't exist or is terminal, or whose wait already
+     * resolved (a duplicate): nothing is buffered for those, so a public endpoint can't leave junk
+     * rows behind or signal non-webhook tokens. Control-plane-only.
      */
     deliverWebhook(token: string, body: unknown): Promise<RunResult | null>;
     /** Side-effect-free read of a value a run published via `ctx.setEvent` (a live query). Control-plane-only. */
@@ -319,10 +323,23 @@ declare class DurableApiController {
     /**
      * A run's detail. Fans wider than {@link FAN_INLINE_MAX} come back as one `FanSummary` each, their
      * members paged by `runs/:id/fans/:group`; `?full=true` returns every checkpoint instead.
+     *
+     * When the gateway can version the detail without reading it, the response carries an `ETag`, and
+     * a poll whose `If-None-Match` still names it gets a 304 before the timeline is read. The browser
+     * sends that header itself (the response is `no-cache`), so a console poll needs no code for it.
      */
-    run(id: string, full?: string): Promise<_dudousxd_nestjs_durable_core.RunDetail>;
-    /** One page of a summarized fan's members, in seq order. */
-    fanMembers(id: string, group: string, offset?: string, limit?: string, failed?: string): Promise<_dudousxd_nestjs_durable_core.FanPage>;
+    run(id: string, full?: string, ifNoneMatch?: string, response?: unknown): Promise<{
+        run: _dudousxd_nestjs_durable_core.WorkflowRun;
+        timeline: _dudousxd_nestjs_durable_core.StepCheckpoint[];
+        children: string[];
+        fans?: _dudousxd_nestjs_durable_core.FanSummary[] | undefined;
+        childCount?: number | 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<{
+        items: _dudousxd_nestjs_durable_core.StepCheckpoint[];
+        total: number;
+    }>;
     /** Server-Sent Events stream of a run's live lifecycle events — the dashboard tails it instead
      *  of polling. Cross-pod when the transport has a control plane (see DashboardService.streamRun). */
     stream(id: string): rxjs.Observable<{