@dudousxd/nestjs-durable-core 0.29.1 → 0.30.0

package/dist/index.d.cts

@@ -226,6 +226,14 @@ interface StateStore {
     createRun(run: WorkflowRun): Promise<void>;
     updateRun(runId: string, patch: Partial<WorkflowRun>): Promise<void>;
     getRun(runId: string): Promise<WorkflowRun | null>;
+    /**
+     * Hard-delete a run and all of its rows — the run plus its checkpoints, signal waiters, and
+     * normalized search-attribute rows. Unlike a cancelled run (which stays as terminal history), a
+     * deleted run is GONE: it no longer appears in {@link getRun} or {@link listRuns}. This removes
+     * exactly the one run — the engine's {@link WorkflowEngine.deleteRun} handles the child cascade.
+     * No-op if the run doesn't exist. (Token-keyed buffered signals are transient and left alone.)
+     */
+    deleteRun(runId: string): Promise<void>;
     getCheckpoint(runId: string, seq: number): Promise<StepCheckpoint | null>;
     /**
      * Persist a checkpoint and advance the run atomically. Durable semantics depend on this
@@ -1501,6 +1509,17 @@ declare class WorkflowEngine {
     cancelWhere(filter: Omit<RunQuery, 'limit' | 'offset'>, opts?: {
         compensate?: boolean;
     }): Promise<RunResult[]>;
+    /**
+     * Hard-delete a run and its entire subtree. Unlike {@link cancel} (which marks a run `cancelled`
+     * but keeps it as history), delete REMOVES the run and all its rows (checkpoints, signal waiters,
+     * search-attribute rows) — it vanishes from {@link getRun} and {@link listRuns}. Use it to purge a
+     * finished run whose data is being deleted (e.g. a pipeline run whose result rows are cleared).
+     *
+     * Cascades depth-first via {@link getRunChildren} so children are gone before the parent (no
+     * orphaned child runs). Prefer {@link cancel} first for a live run — deleting one mid-flight orphans
+     * its worker (its next checkpoint write fails). Returns the number of runs deleted (0 if absent).
+     */
+    deleteRun(runId: string): Promise<number>;
     /**
      * Cascade cancellation to a run's children — both awaited (`ctx.child`, found via its live
      * `child:<id>` waiter) and fire-and-forget (`ctx.startChild`, found via its `spawn:<id>`
@@ -1789,6 +1808,7 @@ declare class CodecStateStore implements StateStore {
     createRun(run: WorkflowRun): Promise<void>;
     updateRun(runId: string, patch: Partial<WorkflowRun>): Promise<void>;
     getRun(runId: string): Promise<WorkflowRun | null>;
+    deleteRun(runId: string): Promise<void>;
     getCheckpoint(runId: string, seq: number): Promise<StepCheckpoint | null>;
     saveCheckpoint(checkpoint: StepCheckpoint): Promise<void>;
     transaction<T>(work: (tx: {
@@ -2025,6 +2045,7 @@ declare class InMemoryStateStore implements StateStore {
     createRun(run: WorkflowRun): Promise<void>;
     updateRun(runId: string, patch: Partial<WorkflowRun>): Promise<void>;
     getRun(runId: string): Promise<WorkflowRun | null>;
+    deleteRun(runId: string): Promise<void>;
     getCheckpoint(runId: string, seq: number): Promise<StepCheckpoint | null>;
     saveCheckpoint(checkpoint: StepCheckpoint): Promise<void>;
     listIncompleteRuns(): Promise<WorkflowRun[]>;

package/dist/index.d.ts

@@ -226,6 +226,14 @@ interface StateStore {
     createRun(run: WorkflowRun): Promise<void>;
     updateRun(runId: string, patch: Partial<WorkflowRun>): Promise<void>;
     getRun(runId: string): Promise<WorkflowRun | null>;
+    /**
+     * Hard-delete a run and all of its rows — the run plus its checkpoints, signal waiters, and
+     * normalized search-attribute rows. Unlike a cancelled run (which stays as terminal history), a
+     * deleted run is GONE: it no longer appears in {@link getRun} or {@link listRuns}. This removes
+     * exactly the one run — the engine's {@link WorkflowEngine.deleteRun} handles the child cascade.
+     * No-op if the run doesn't exist. (Token-keyed buffered signals are transient and left alone.)
+     */
+    deleteRun(runId: string): Promise<void>;
     getCheckpoint(runId: string, seq: number): Promise<StepCheckpoint | null>;
     /**
      * Persist a checkpoint and advance the run atomically. Durable semantics depend on this
@@ -1501,6 +1509,17 @@ declare class WorkflowEngine {
     cancelWhere(filter: Omit<RunQuery, 'limit' | 'offset'>, opts?: {
         compensate?: boolean;
     }): Promise<RunResult[]>;
+    /**
+     * Hard-delete a run and its entire subtree. Unlike {@link cancel} (which marks a run `cancelled`
+     * but keeps it as history), delete REMOVES the run and all its rows (checkpoints, signal waiters,
+     * search-attribute rows) — it vanishes from {@link getRun} and {@link listRuns}. Use it to purge a
+     * finished run whose data is being deleted (e.g. a pipeline run whose result rows are cleared).
+     *
+     * Cascades depth-first via {@link getRunChildren} so children are gone before the parent (no
+     * orphaned child runs). Prefer {@link cancel} first for a live run — deleting one mid-flight orphans
+     * its worker (its next checkpoint write fails). Returns the number of runs deleted (0 if absent).
+     */
+    deleteRun(runId: string): Promise<number>;
     /**
      * Cascade cancellation to a run's children — both awaited (`ctx.child`, found via its live
      * `child:<id>` waiter) and fire-and-forget (`ctx.startChild`, found via its `spawn:<id>`
@@ -1789,6 +1808,7 @@ declare class CodecStateStore implements StateStore {
     createRun(run: WorkflowRun): Promise<void>;
     updateRun(runId: string, patch: Partial<WorkflowRun>): Promise<void>;
     getRun(runId: string): Promise<WorkflowRun | null>;
+    deleteRun(runId: string): Promise<void>;
     getCheckpoint(runId: string, seq: number): Promise<StepCheckpoint | null>;
     saveCheckpoint(checkpoint: StepCheckpoint): Promise<void>;
     transaction<T>(work: (tx: {
@@ -2025,6 +2045,7 @@ declare class InMemoryStateStore implements StateStore {
     createRun(run: WorkflowRun): Promise<void>;
     updateRun(runId: string, patch: Partial<WorkflowRun>): Promise<void>;
     getRun(runId: string): Promise<WorkflowRun | null>;
+    deleteRun(runId: string): Promise<void>;
     getCheckpoint(runId: string, seq: number): Promise<StepCheckpoint | null>;
     saveCheckpoint(checkpoint: StepCheckpoint): Promise<void>;
     listIncompleteRuns(): Promise<WorkflowRun[]>;

package/dist/index.js

@@ -2115,6 +2115,26 @@ var WorkflowEngine = class {
     return results;
   }
   /**
+  * Hard-delete a run and its entire subtree. Unlike {@link cancel} (which marks a run `cancelled`
+  * but keeps it as history), delete REMOVES the run and all its rows (checkpoints, signal waiters,
+  * search-attribute rows) — it vanishes from {@link getRun} and {@link listRuns}. Use it to purge a
+  * finished run whose data is being deleted (e.g. a pipeline run whose result rows are cleared).
+  *
+  * Cascades depth-first via {@link getRunChildren} so children are gone before the parent (no
+  * orphaned child runs). Prefer {@link cancel} first for a live run — deleting one mid-flight orphans
+  * its worker (its next checkpoint write fails). Returns the number of runs deleted (0 if absent).
+  */
+  async deleteRun(runId) {
+    const run = await this.store.getRun(runId);
+    if (!run) return 0;
+    let deleted = 0;
+    for (const childId of await this.getRunChildren(runId)) {
+      deleted += await this.deleteRun(childId);
+    }
+    await this.store.deleteRun(runId);
+    return deleted + 1;
+  }
+  /**
   * Cascade cancellation to a run's children — both awaited (`ctx.child`, found via its live
   * `child:<id>` waiter) and fire-and-forget (`ctx.startChild`, found via its `spawn:<id>`
   * checkpoint). Recursive, so a whole subtree is cancelled; the terminal guard in `cancel` stops it
@@ -3274,6 +3294,9 @@ var CodecStateStore = class {
   async getRun(runId) {
     return this.decRun(await this.inner.getRun(runId));
   }
+  deleteRun(runId) {
+    return this.inner.deleteRun(runId);
+  }
   async getCheckpoint(runId, seq) {
     return this.decCp(await this.inner.getCheckpoint(runId, seq));
   }
@@ -3668,6 +3691,16 @@ var InMemoryStateStore = class {
       ...run
     } : null;
   }
+  async deleteRun(runId) {
+    this.runs.delete(runId);
+    for (const [key, cp] of this.checkpoints) {
+      if (cp.runId === runId) this.checkpoints.delete(key);
+    }
+    for (const [token, waiter] of this.signalWaiters) {
+      if (waiter.runId === runId) this.signalWaiters.delete(token);
+    }
+    this.reindexAttributes(runId, void 0);
+  }
   async getCheckpoint(runId, seq) {
     const cp = this.checkpoints.get(this.key(runId, seq));
     return cp ? {