@wpkernel/pipeline 1.0.0 → 1.1.0

package/dist/core/runner/program.js

@@ -1,146 +1,163 @@
 import { composeK as h, maybeThen as b } from "../async-utils.js";
-import { makeCommitStage as R, makeAfterFragmentsStage as H, makeFinalizeResultStage as A, isHalt as c, makeHelperStageFactory as w } from "./stage-factories.js";
-const L = (r, l) => {
-  const f = (o) => ({
+import { makeCommitStage as R, makeAfterFragmentsStage as A, makeFinalizeResultStage as H, isHalt as l, makeHelperStageFactory as w, isPaused as g } from "./stage-factories.js";
+const _ = (n) => n.stageIndex ?? 0, v = (n, a) => ({
+  stageIndex: _(n),
+  state: n,
+  token: a?.token,
+  pauseKind: a?.pauseKind,
+  payload: a?.payload,
+  createdAt: Date.now()
+}), C = (n, a) => ({
+  __paused: !0,
+  snapshot: v(n, a)
+}), L = (n, a) => {
+  const u = (e) => ({
     __halt: !0,
-    error: o
-  }), g = (o) => (t) => ({
-    context: o.context,
-    reporter: o.reporter,
-    userState: o.userState
-  }), u = {
-    pushStep: l.pushStep,
-    toRollbackContext: (o) => ({
-      context: o.context,
-      extensionCoordinator: o.extensionCoordinator,
-      extensionState: o.extensionState,
-      extensionStack: o.extensionStack
+    error: e
+  }), f = (e) => (t) => ({
+    context: e.context,
+    reporter: e.reporter,
+    userState: e.userState
+  }), x = {
+    pushStep: a.pushStep,
+    toRollbackContext: (e) => ({
+      context: e.context,
+      extensionCoordinator: e.extensionCoordinator,
+      extensionState: e.extensionState,
+      extensionStack: e.extensionStack
     }),
-    halt: f,
-    isHalt: c,
-    onHelperRollbackError: r.options.onHelperRollbackError
-  }, x = w({
-    pushStep: l.pushStep,
-    toRollbackContext: (o) => ({
-      context: o.context,
-      extensionCoordinator: o.extensionCoordinator,
-      extensionState: o.extensionState,
-      extensionStack: o.extensionStack
+    halt: u,
+    pause: n.options.supportsPause ? (e, t) => C(e, t) : void 0,
+    isHalt: l,
+    onHelperRollbackError: n.options.onHelperRollbackError
+  }, k = w({
+    pushStep: a.pushStep,
+    toRollbackContext: (e) => ({
+      context: e.context,
+      extensionCoordinator: e.extensionCoordinator,
+      extensionState: e.extensionState,
+      extensionStack: e.extensionStack
     }),
-    halt: f,
-    isHalt: c,
-    onHelperRollbackError: r.options.onHelperRollbackError
-  }), k = (o, t, i) => {
-    const a = {
-      getOrder: (e) => e.helperOrders?.get(o) ?? [],
-      makeArgs: g,
-      onVisited: (e, n, s) => t?.onVisited ? t.onVisited(e, n, s) : e,
-      readRollbacks: (e) => e.helperRollbacks?.get(o)?.map((n) => n.helper) ?? [],
+    halt: u,
+    isHalt: l,
+    onHelperRollbackError: n.options.onHelperRollbackError
+  }), p = (e, t, s) => {
+    const i = {
+      getOrder: (o) => o.helperOrders?.get(e) ?? [],
+      makeArgs: f,
+      onVisited: (o, r, c) => t?.onVisited ? t.onVisited(o, r, c) : o,
+      readRollbacks: (o) => o.helperRollbacks?.get(e)?.map((r) => r.helper) ?? [],
       invoke: ({
-        helper: e,
-        args: n,
-        next: s
+        helper: o,
+        args: r,
+        next: c
       }) => {
-        if (typeof e == "function")
-          return e(n, s);
-        if (typeof e == "object" && e !== null && "apply" in e && typeof e.apply == "function")
-          return e.apply(n, s);
+        if (typeof o == "function")
+          return o(r, c);
+        if (typeof o == "object" && o !== null && "apply" in o && typeof o.apply == "function")
+          return o.apply(r, c);
         throw new Error(
-          `Invalid helper: expected function or object with .apply method. Got: ${typeof e}`
+          `Invalid helper: expected function or object with .apply method. Got: ${typeof o}`
         );
       },
       ...t
     };
-    return t?.makeArgs ? a.makeArgs = t.makeArgs : i && (a.makeArgs = (e) => (n) => i({
-      state: e,
-      helper: n.helper,
-      context: e.context
-    })), x(
-      o,
-      a
+    return t?.makeArgs ? i.makeArgs = t.makeArgs : s && (i.makeArgs = (o) => (r) => s({
+      state: o,
+      helper: r.helper,
+      context: o.context
+    })), k(
+      e,
+      i
     );
-  }, m = (o) => H({
-    isHalt: c,
+  }, m = (e) => A({
+    isHalt: l,
+    isPaused: g,
     execute: (t) => {
-      t.executedLifecycles.add(o);
-      const i = t.extensionCoordinator;
-      if (!i)
+      t.executedLifecycles.add(e);
+      const s = t.extensionCoordinator;
+      if (!s)
         return t;
-      const a = l.buildHookOptions(
+      const i = a.buildHookOptions(
         t,
-        o
+        e
       );
       return b(
-        i.runLifecycle(
-          o,
+        s.runLifecycle(
+          e,
           {
-            hooks: r.extensionHooks,
-            hookOptions: a
+            hooks: n.extensionHooks,
+            hookOptions: i
           }
         ),
-        (e) => ({
+        (o) => ({
           ...t,
-          extensionState: e,
+          extensionState: o,
           extensionStack: [
             ...t.extensionStack ?? [],
             {
-              coordinator: i,
-              state: e
+              coordinator: s,
+              state: o
             }
           ],
-          userState: e.artifact
+          userState: o.artifact
         })
       );
     }
   }), S = R({
-    isHalt: c,
-    commit: (o) => {
-      const t = o.extensionCoordinator;
+    isHalt: l,
+    isPaused: g,
+    commit: (e) => {
+      const t = e.extensionCoordinator;
       if (t)
-        return t.commit(o.extensionState);
+        return t.commit(e.extensionState);
     },
-    rollbackToHalt: (o, t) => ({
+    rollbackToHalt: (e, t) => ({
       __halt: !0,
       error: t
     })
-  }), p = A({
-    isHalt: c,
-    finalize: (o) => {
-      const i = {
-        ...o,
-        diagnostics: r.diagnosticManager.readDiagnostics()
+  }), d = H({
+    isHalt: l,
+    isPaused: g,
+    finalize: (e) => {
+      const s = {
+        ...e,
+        diagnostics: n.diagnosticManager.readDiagnostics()
       };
-      if (r.extensionHooks.length > 0) {
-        const a = i.executedLifecycles, e = /* @__PURE__ */ new Set();
-        for (const n of r.extensionHooks)
-          a?.has(n.lifecycle) || e.add(n.lifecycle);
-        if (e.size > 0) {
-          const n = Array.from(e).map((s) => `"${s}"`).join(", ");
-          i.reporter.warn?.(
-            `The following extension hooks will be ignored because their lifecycles were not executed: ${n}`
+      if (n.extensionHooks.length > 0) {
+        const i = s.executedLifecycles, o = /* @__PURE__ */ new Set();
+        for (const r of n.extensionHooks)
+          i?.has(r.lifecycle) || o.add(r.lifecycle);
+        if (o.size > 0) {
+          const r = Array.from(o).map((c) => `"${c}"`).join(", ");
+          s.reporter.warn?.(
+            `The following extension hooks will be ignored because their lifecycles were not executed: ${r}`
           );
         }
       }
-      return i;
+      return s;
     }
   }), y = {
-    runnerEnv: u,
-    finalizeResult: p,
+    runnerEnv: x,
+    finalizeResult: d,
     makeLifecycleStage: m,
     commitStage: S,
-    makeHelperStage: k,
+    makeHelperStage: p,
     extensions: {
-      lifecycles: r.extensionLifecycles
+      lifecycles: n.extensionLifecycles
     },
-    diagnosticManager: r.diagnosticManager
+    diagnosticManager: n.diagnosticManager
   };
-  if (!r.stages)
+  if (!n.stages)
     throw new Error(
       "Agnostic Runner requires 'stages' factory to be defined."
     );
-  const d = r.stages(y);
-  return h(...[...d].reverse());
+  return n.stages(y);
+}, E = (n, a) => {
+  const u = L(n, a);
+  return h(...[...u].reverse());
 };
 export {
-  L as createAgnosticProgram
+  E as createAgnosticProgram,
+  L as createAgnosticStages
 };

package/dist/core/runner/stage-factories.d.ts

@@ -1,8 +1,9 @@
 import { Program } from '../async-utils';
-import { Helper, HelperApplyOptions, HelperKind, MaybePromise, PipelineReporter } from '../types';
+import { Helper, HelperApplyOptions, HelperKind, MaybePromise, PipelinePaused, PipelineReporter } from '../types';
 import { RegisteredHelper } from '../dependency-graph';
 import { Halt, HelperInvokeOptions, StageEnv, HelperStageSpec } from './types';
 export declare function isHalt<TRunResult>(value: unknown): value is Halt<TRunResult>;
+export declare function isPaused<TState>(value: unknown): value is PipelinePaused<TState>;
 /**
  * Generic stage constructor that executes an ordered helper list with middleware-style `next()`.
  * @param options
@@ -27,43 +28,51 @@ export declare function createHelpersProgram<TContext, TReporter extends Pipelin
  * @param options.isHalt
  * @param options.snapshotFragments
  * @param options.applyArtifact
+ * @param options.isPaused
  */
 export declare function makeFinalizeFragmentsStage<TState, THalt extends Halt<unknown>, TFragments>(options: {
     isHalt: (value: TState | THalt) => value is THalt;
+    isPaused?: (value: unknown) => value is PipelinePaused<TState>;
     snapshotFragments: (state: TState) => TFragments;
     applyArtifact: (state: TState, fragments: TFragments) => TState;
-}): Program<TState | THalt>;
+}): Program<TState | THalt | PipelinePaused<TState>>;
 /**
  * Generic stage builder for "after fragments" style hooks.
  * @param options
  * @param options.isHalt
  * @param options.execute
+ * @param options.isPaused
  */
 export declare function makeAfterFragmentsStage<TState, THalt extends Halt<unknown>>(options: {
     isHalt: (value: TState | THalt) => value is THalt;
+    isPaused?: (value: unknown) => value is PipelinePaused<TState>;
     execute: (state: TState) => MaybePromise<TState>;
-}): Program<TState | THalt>;
+}): Program<TState | THalt | PipelinePaused<TState>>;
 /**
  * Commit stage builder.
  * @param options
  * @param options.isHalt
  * @param options.commit
  * @param options.rollbackToHalt
+ * @param options.isPaused
  */
 export declare function makeCommitStage<TState, THalt extends Halt<unknown>>(options: {
     isHalt: (value: TState | THalt) => value is THalt;
+    isPaused?: (value: unknown) => value is PipelinePaused<TState>;
     commit: (state: TState) => MaybePromise<void>;
     rollbackToHalt: (state: TState, error: unknown) => MaybePromise<THalt>;
-}): Program<TState | THalt>;
+}): Program<TState | THalt | PipelinePaused<TState>>;
 /**
  * Simple finalizer that snapshots helpers/diagnostics into state.
  * @param options
  * @param options.isHalt
  * @param options.finalize
+ * @param options.isPaused
  */
 export declare function makeFinalizeResultStage<TState, THalt extends Halt<unknown>>(options: {
     isHalt: (value: TState | THalt) => value is THalt;
+    isPaused?: (value: unknown) => value is PipelinePaused<TState>;
     finalize: (state: TState) => TState;
-}): Program<TState | THalt>;
-export declare function makeHelperStageFactory<TState, TRunResult, TContext, TOptions, TReporter extends PipelineReporter, TUserState>(config: StageEnv<TState, TRunResult, TContext, TOptions, TReporter, TUserState>): <TKind extends HelperKind, THelper extends Helper<TContext, TInput, TOutput, TReporter, TKind>, TInput, TOutput>(kind: string, spec: HelperStageSpec<TState, TContext, TReporter, TKind, THelper, TInput, TOutput>) => Program<TState | Halt<TRunResult>>;
+}): Program<TState | THalt | PipelinePaused<TState>>;
+export declare function makeHelperStageFactory<TState, TRunResult, TContext, TOptions, TReporter extends PipelineReporter, TUserState>(config: StageEnv<TState, TRunResult, TContext, TOptions, TReporter, TUserState>): <TKind extends HelperKind, THelper extends Helper<TContext, TInput, TOutput, TReporter, TKind>, TInput, TOutput>(kind: string, spec: HelperStageSpec<TState, TContext, TReporter, TKind, THelper, TInput, TOutput>) => Program<TState | Halt<TRunResult> | PipelinePaused<TState>>;
 //# sourceMappingURL=stage-factories.d.ts.map

package/dist/core/runner/stage-factories.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stage-factories.d.ts","sourceRoot":"","sources":["../../../src/core/runner/stage-factories.ts"],"names":[],"mappings":"AAAA,OAAO,EAIN,KAAK,OAAO,EACZ,MAAM,gBAAgB,CAAC;AAGxB,OAAO,KAAK,EACX,MAAM,EACN,kBAAkB,EAClB,UAAU,EACV,YAAY,EAEZ,gBAAgB,EAChB,MAAM,UAAU,CAAC;AAClB,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,KAAK,EACX,IAAI,EACJ,mBAAmB,EAEnB,QAAQ,EACR,eAAe,EAEf,MAAM,SAAS,CAAC;AAmBjB,wBAAgB,MAAM,CAAC,UAAU,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,IAAI,CAAC,UAAU,CAAC,CAO5E;AAED;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CACnC,QAAQ,EACR,SAAS,SAAS,gBAAgB,EAClC,KAAK,SAAS,UAAU,EACxB,OAAO,SAAS,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,EACnE,MAAM,EACN,OAAO,EACP,MAAM,EACL,OAAO,EAAE;IACV,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;IACzD,QAAQ,EAAE,CACT,KAAK,EAAE,MAAM,KACT,CACJ,KAAK,EAAE,gBAAgB,CAAC,OAAO,CAAC,KAC5B,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;IAC9D,MAAM,EAAE,CACP,aAAa,EAAE,mBAAmB,CACjC,OAAO,EACP,MAAM,EACN,OAAO,EACP,QAAQ,EACR,SAAS,CACT,KACG,YAAY,CAAC,IAAI,CAAC,CAAC;IACxB,UAAU,EAAE,CAAC,KAAK,EAAE,gBAAgB,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;IACvD,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC;IAC3D,gBAAgB,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;CAC9D,GAAG,CAAC,KAAK,EAAE,MAAM,KAAK,YAAY,CAAC,MAAM,CAAC,CAgD1C;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CACzC,MAAM,EACN,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,EAC3B,UAAU,EACT,OAAO,EAAE;IACV,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,KAAK,KAAK,IAAI,KAAK,CAAC;IAClD,iBAAiB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,UAAU,CAAC;IACjD,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,KAAK,MAAM,CAAC;CAChE,GAAG,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC,CAO1B;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACtC,MAAM,EACN,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,EAC1B,OAAO,EAAE;IACV,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,KAAK,KAAK,IAAI,KAAK,CAAC;IAClD,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC;CACjD,GAAG,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC,CAG1B;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE;IAC7E,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,KAAK,KAAK,IAAI,KAAK,CAAC;IAClD,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;IAC9C,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,KAAK,YAAY,CAAC,KAAK,CAAC,CAAC;CACvE,GAAG,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC,CAe1B;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACtC,MAAM,EACN,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,EAC1B,OAAO,EAAE;IACV,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,KAAK,KAAK,IAAI,KAAK,CAAC;IAClD,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;CACpC,GAAG,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC,CAG1B;AAED,wBAAgB,sBAAsB,CACrC,MAAM,EACN,UAAU,EACV,QAAQ,EACR,QAAQ,EACR,SAAS,SAAS,gBAAgB,EAClC,UAAU,EAEV,MAAM,EAAE,QAAQ,CACf,MAAM,EACN,UAAU,EACV,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,UAAU,CACV,IAGA,KAAK,SAAS,UAAU,EACxB,OAAO,SAAS,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,EACnE,MAAM,EACN,OAAO,EAEP,MAAM,MAAM,EACZ,MAAM,eAAe,CACpB,MAAM,EACN,QAAQ,EACR,SAAS,EACT,KAAK,EACL,OAAO,EACP,MAAM,EACN,OAAO,CACP,KACC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CA2IrC"}
+{"version":3,"file":"stage-factories.d.ts","sourceRoot":"","sources":["../../../src/core/runner/stage-factories.ts"],"names":[],"mappings":"AAAA,OAAO,EAIN,KAAK,OAAO,EACZ,MAAM,gBAAgB,CAAC;AAGxB,OAAO,KAAK,EACX,MAAM,EACN,kBAAkB,EAClB,UAAU,EACV,YAAY,EACZ,cAAc,EAEd,gBAAgB,EAChB,MAAM,UAAU,CAAC;AAClB,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,KAAK,EACX,IAAI,EACJ,mBAAmB,EAEnB,QAAQ,EACR,eAAe,EAEf,MAAM,SAAS,CAAC;AAmBjB,wBAAgB,MAAM,CAAC,UAAU,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,IAAI,CAAC,UAAU,CAAC,CAO5E;AAED,wBAAgB,QAAQ,CAAC,MAAM,EAC9B,KAAK,EAAE,OAAO,GACZ,KAAK,IAAI,cAAc,CAAC,MAAM,CAAC,CAOjC;AAED;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CACnC,QAAQ,EACR,SAAS,SAAS,gBAAgB,EAClC,KAAK,SAAS,UAAU,EACxB,OAAO,SAAS,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,EACnE,MAAM,EACN,OAAO,EACP,MAAM,EACL,OAAO,EAAE;IACV,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;IACzD,QAAQ,EAAE,CACT,KAAK,EAAE,MAAM,KACT,CACJ,KAAK,EAAE,gBAAgB,CAAC,OAAO,CAAC,KAC5B,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;IAC9D,MAAM,EAAE,CACP,aAAa,EAAE,mBAAmB,CACjC,OAAO,EACP,MAAM,EACN,OAAO,EACP,QAAQ,EACR,SAAS,CACT,KACG,YAAY,CAAC,IAAI,CAAC,CAAC;IACxB,UAAU,EAAE,CAAC,KAAK,EAAE,gBAAgB,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;IACvD,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC;IAC3D,gBAAgB,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;CAC9D,GAAG,CAAC,KAAK,EAAE,MAAM,KAAK,YAAY,CAAC,MAAM,CAAC,CAgD1C;AAED;;;;;;;GAOG;AACH,wBAAgB,0BAA0B,CACzC,MAAM,EACN,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,EAC3B,UAAU,EACT,OAAO,EAAE;IACV,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,KAAK,KAAK,IAAI,KAAK,CAAC;IAClD,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC;IAC/D,iBAAiB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,UAAU,CAAC;IACjD,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,KAAK,MAAM,CAAC;CAChE,GAAG,OAAO,CAAC,MAAM,GAAG,KAAK,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,CAsBnD;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CACtC,MAAM,EACN,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,EAC1B,OAAO,EAAE;IACV,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,KAAK,KAAK,IAAI,KAAK,CAAC;IAClD,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC;IAC/D,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,YAAY,CAAC,MAAM,CAAC,CAAC;CACjD,GAAG,OAAO,CAAC,MAAM,GAAG,KAAK,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,CAanD;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE;IAC7E,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,KAAK,KAAK,IAAI,KAAK,CAAC;IAClD,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC;IAC/D,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;IAC9C,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,KAAK,YAAY,CAAC,KAAK,CAAC,CAAC;CACvE,GAAG,OAAO,CAAC,MAAM,GAAG,KAAK,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,CA8BnD;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CACtC,MAAM,EACN,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,EAC1B,OAAO,EAAE;IACV,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,KAAK,KAAK,IAAI,KAAK,CAAC;IAClD,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC;IAC/D,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;CACpC,GAAG,OAAO,CAAC,MAAM,GAAG,KAAK,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,CAanD;AAED,wBAAgB,sBAAsB,CACrC,MAAM,EACN,UAAU,EACV,QAAQ,EACR,QAAQ,EACR,SAAS,SAAS,gBAAgB,EAClC,UAAU,EAEV,MAAM,EAAE,QAAQ,CACf,MAAM,EACN,UAAU,EACV,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,UAAU,CACV,IAGA,KAAK,SAAS,UAAU,EACxB,OAAO,SAAS,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,EACnE,MAAM,EACN,OAAO,EAEP,MAAM,MAAM,EACZ,MAAM,eAAe,CACpB,MAAM,EACN,QAAQ,EACR,SAAS,EACT,KAAK,EACL,OAAO,EACP,MAAM,EACN,OAAO,CACP,KACC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,CAgJ9D"}

package/dist/core/runner/stage-factories.js

@@ -1,121 +1,138 @@
-import { maybeTry as y, maybeThen as S, isPromiseLike as C } from "../async-utils.js";
-import { executeHelpers as E } from "../execution-utils.js";
-import { runHelperStageWithRollback as F } from "./rollback.js";
-function _(r) {
+import { maybeTry as R, maybeThen as S, isPromiseLike as y } from "../async-utils.js";
+import { executeHelpers as _ } from "../execution-utils.js";
+import { runHelperStageWithRollback as C } from "./rollback.js";
+function v(r) {
   return !!(r && typeof r == "object" && "__halt" in r && r.__halt === !0);
 }
-function v(r) {
+function E(r) {
+  return !!(r && typeof r == "object" && "__paused" in r && r.__paused === !0);
+}
+function F(r) {
   const {
-    getOrder: c,
-    makeArgs: t,
-    invoke: e,
-    recordStep: a,
-    onVisited: i,
-    registerRollback: u
-  } = r, f = (n, k, p) => {
-    const s = e({ helper: n, args: k, next: p });
-    return u ? C(s) ? s.then((o) => {
-      u(n, o);
-    }) : (u(n, s), s) : s;
+    getOrder: u,
+    makeArgs: n,
+    invoke: t,
+    recordStep: e,
+    onVisited: l,
+    registerRollback: i
+  } = r, k = (c, f, p) => {
+    const s = t({ helper: c, args: f, next: p });
+    return i ? y(s) ? s.then((o) => {
+      i(c, o);
+    }) : (i(c, s), s) : s;
   };
-  return (n) => {
-    const k = c(n), p = E(k, t(n), f, a);
+  return (c) => {
+    const f = u(c), p = _(f, n(c), k, e);
     return S(
       p,
-      (s) => i(n, s)
+      (s) => l(c, s)
     );
   };
 }
 function z(r) {
-  const { isHalt: c, snapshotFragments: t, applyArtifact: e } = r;
-  return (a) => c(a) ? a : e(a, t(a));
+  const {
+    isHalt: u,
+    isPaused: n,
+    snapshotFragments: t,
+    applyArtifact: e
+  } = r;
+  return (l) => n && n(l) || u(l) ? l : e(
+    l,
+    t(l)
+  );
 }
 function T(r) {
-  const { isHalt: c, execute: t } = r;
-  return (e) => c(e) ? e : t(e);
+  const { isHalt: u, isPaused: n, execute: t } = r;
+  return (e) => n && n(e) || u(e) ? e : t(e);
 }
 function V(r) {
-  const { isHalt: c, commit: t, rollbackToHalt: e } = r, a = (i) => {
-    const u = () => i;
-    return y(
-      () => S(t(i), u),
-      (n) => e(i, n)
+  const {
+    isHalt: u,
+    isPaused: n,
+    commit: t,
+    rollbackToHalt: e
+  } = r, l = (i) => {
+    const k = () => i;
+    return R(
+      () => S(t(i), k),
+      (f) => e(i, f)
     );
   };
-  return (i) => c(i) ? i : a(i);
+  return (i) => n && n(i) || u(i) ? i : l(i);
 }
-function j(r) {
-  const { isHalt: c, finalize: t } = r;
-  return (e) => c(e) ? e : t(e);
+function B(r) {
+  const { isHalt: u, isPaused: n, finalize: t } = r;
+  return (e) => n && n(e) || u(e) ? e : t(e);
 }
 function M(r) {
-  return function(t, e) {
+  return function(n, t) {
     const {
-      pushStep: a,
-      toRollbackContext: i,
-      halt: u,
-      isHalt: f,
-      onHelperRollbackError: n
-    } = r, k = ({
+      pushStep: e,
+      toRollbackContext: l,
+      halt: i,
+      isHalt: k,
+      onHelperRollbackError: c
+    } = r, f = t.invoke ?? (({
       helper: o,
       args: m,
-      next: l
-    }) => o.apply(m, l), p = (o) => (m, l) => {
-      if (!(!l || typeof l != "object") && "rollback" in l) {
-        const g = l.rollback;
-        g && o.push({ helper: m, rollback: g });
+      next: a
+    }) => o.apply(m, a)), p = (o) => (m, a) => {
+      if (!(!a || typeof a != "object") && "rollback" in a) {
+        const d = a.rollback;
+        d && o.push({ helper: m, rollback: d });
       }
-    }, s = () => n ? (o) => n({
+    }, s = () => c ? (o) => c({
       ...o,
       helper: o.helper
     }) : void 0;
     return (o) => {
-      if (f(o))
+      if (k(o) || E(o))
         return o;
       let m = o.helperExecution;
       m || (m = /* @__PURE__ */ new Map(), o.helperExecution = m);
-      let l = m.get(t);
-      l || (l = {
-        kind: t,
+      let a = m.get(n);
+      a || (a = {
+        kind: n,
         executed: [],
         missing: [],
         registered: []
         // Registered populated by getOrder result?
-      }, m.set(t, l));
-      const g = (b) => {
-        a(b), l.executed.push(
-          b.helper.key
+      }, m.set(n, a));
+      const d = (g) => {
+        e(g), a.executed.push(
+          g.helper.key
         );
-      }, H = [
-        ...e.readRollbacks?.(o) ?? []
-      ], h = i(o), d = v({
-        getOrder: e.getOrder,
-        makeArgs: e.makeArgs,
-        invoke: k,
-        recordStep: g,
-        onVisited: (b, R) => e.onVisited(b, R, H),
-        registerRollback: p(H)
-      }), x = {
-        context: h.context,
-        rollbackContext: h,
-        helperRollbacks: H,
+      }, b = [
+        ...t.readRollbacks?.(o) ?? []
+      ], H = l(o), h = F({
+        getOrder: t.getOrder,
+        makeArgs: t.makeArgs,
+        invoke: f,
+        recordStep: d,
+        onVisited: (g, x) => t.onVisited(g, x, b),
+        registerRollback: p(b)
+      }), P = {
+        context: H.context,
+        rollbackContext: H,
+        helperRollbacks: b,
         onHelperRollbackError: s()
       };
-      return F({
+      return C({
         state: o,
-        program: d,
-        rollbackPlan: x,
-        halt: u
+        program: h,
+        rollbackPlan: P,
+        halt: i
       });
     };
   };
 }
 export {
-  v as createHelpersProgram,
-  _ as isHalt,
+  F as createHelpersProgram,
+  v as isHalt,
+  E as isPaused,
   T as makeAfterFragmentsStage,
   V as makeCommitStage,
   z as makeFinalizeFragmentsStage,
-  j as makeFinalizeResultStage,
+  B as makeFinalizeResultStage,
   M as makeHelperStageFactory
 };

package/dist/core/runner/types.d.ts

@@ -1,7 +1,7 @@
 import { RegisteredHelper } from '../dependency-graph';
 import { Program } from '../async-utils';
 import { ErrorFactory } from '../error-factory';
-import { Helper, HelperApplyOptions, HelperExecutionSnapshot, HelperKind, MaybePromise, PipelineDiagnostic, PipelineExtensionHookOptions, PipelineExtensionLifecycle, PipelineExtensionRollbackErrorMetadata, PipelineReporter, PipelineStep } from '../types';
+import { Helper, HelperApplyOptions, HelperExecutionSnapshot, HelperKind, MaybePromise, PipelinePauseOptions, PipelinePauseSnapshot, PipelinePaused, PipelineDiagnostic, PipelineExtensionHookOptions, PipelineExtensionLifecycle, PipelineExtensionRollbackErrorMetadata, PipelineReporter, PipelineStep } from '../types';
 import { PipelineRollback } from '../rollback';
 import { ExtensionCoordinator, ExtensionLifecycleState } from '../internal/extension-coordinator.types';
 import { AgnosticDiagnosticManager } from './diagnostics';
@@ -17,6 +17,7 @@ export interface AgnosticRunnerOptions<TRunOptions, TUserState, TContext extends
         readonly options: TRunOptions;
     }) => TUserState;
     readonly createError: ErrorFactory;
+    readonly supportsPause?: boolean;
     readonly onExtensionRollbackError?: (options: {
         readonly error: unknown;
         readonly extensionKeys: readonly string[];
@@ -75,6 +76,8 @@ export interface AgnosticState<TRunOptions, TUserState, TContext extends {
     readonly steps: PipelineStep[];
     readonly diagnostics: TDiagnostic[];
     readonly executedLifecycles: Set<string>;
+    readonly stageIndex?: number;
+    readonly resumeInput?: unknown;
     readonly helperExecution?: Map<string, HelperExecutionSnapshot>;
     readonly helperRollbacks?: Map<string, Array<{
         readonly helper: unknown;
@@ -113,6 +116,7 @@ export type StageEnv<TState, TRunResult, TContext, TOptions, TReporter extends P
     pushStep: (entry: RegisteredHelper<unknown>) => void;
     toRollbackContext: (state: TState) => RollbackContext<TContext, TOptions, TUserState>;
     halt: (error?: unknown) => Halt<TRunResult>;
+    pause?: (state: TState, options?: PipelinePauseOptions) => PipelinePaused<TState>;
     isHalt: (value: unknown) => value is Halt<TRunResult>;
     onHelperRollbackError?: (options: {
         readonly error: unknown;
@@ -121,7 +125,8 @@ export type StageEnv<TState, TRunResult, TContext, TOptions, TReporter extends P
         readonly context: TContext;
     }) => void;
 };
-export type PipelineStage<TState, TResult> = Program<TState | TResult>;
+export type PipelineStage<TState, TResult> = Program<TState | TResult | PipelinePaused<TState>>;
+export type PipelineStepResult<TState, TRunResult> = TState | PipelinePaused<TState> | Halt<TRunResult>;
 export type AgnosticStageDeps<TState, TResult, TContext, TRunOptions, TReporter extends PipelineReporter, TDiagnostic extends PipelineDiagnostic, TUserState> = {
     readonly runnerEnv: StageEnv<TState, TResult, TContext, TRunOptions, TReporter, TUserState>;
     readonly finalizeResult: PipelineStage<TState, Halt<TResult>>;
@@ -167,6 +172,13 @@ export interface AgnosticRunner<TRunOptions, TUserState, TContext extends {
     readonly prepareContext: (runOptions: TRunOptions) => AgnosticRunContext<TRunOptions, TUserState, TContext, TReporter, TDiagnostic>;
     readonly executeRun: (context: AgnosticRunContext<TRunOptions, TUserState, TContext, TReporter, TDiagnostic>) => MaybePromise<TRunResult>;
 }
+export interface AgnosticResumableRunner<TRunOptions, TUserState, TContext extends {
+    reporter: TReporter;
+}, TReporter extends PipelineReporter, TDiagnostic extends PipelineDiagnostic, TRunResult> {
+    readonly prepareContext: (runOptions: TRunOptions) => AgnosticRunContext<TRunOptions, TUserState, TContext, TReporter, TDiagnostic>;
+    readonly executeRun: (context: AgnosticRunContext<TRunOptions, TUserState, TContext, TReporter, TDiagnostic>) => MaybePromise<TRunResult | PipelinePaused<AgnosticState<TRunOptions, TUserState, TContext, TReporter, TDiagnostic>>>;
+    readonly executeResume: (snapshot: PipelinePauseSnapshot<AgnosticState<TRunOptions, TUserState, TContext, TReporter, TDiagnostic>>, resumeInput?: unknown) => MaybePromise<TRunResult | PipelinePaused<AgnosticState<TRunOptions, TUserState, TContext, TReporter, TDiagnostic>>>;
+}
 export type HelperInvokeOptions<THelper, TInput, TOutput, TContext, TReporter extends PipelineReporter> = {
     readonly helper: THelper;
     readonly args: HelperApplyOptions<TContext, TInput, TOutput, TReporter>;
@@ -175,6 +187,7 @@ export type HelperInvokeOptions<THelper, TInput, TOutput, TContext, TReporter ex
 export type HelperStageSpec<TState, TContext, TReporter extends PipelineReporter, TKind extends HelperKind, THelper extends Helper<TContext, TInput, TOutput, TReporter, TKind>, TInput, TOutput> = {
     readonly getOrder: (state: TState) => RegisteredHelper<THelper>[];
     readonly makeArgs: (state: TState) => (entry: RegisteredHelper<THelper>) => HelperApplyOptions<TContext, TInput, TOutput, TReporter>;
+    readonly invoke?: (invokeOptions: HelperInvokeOptions<THelper, TInput, TOutput, TContext, TReporter>) => MaybePromise<void>;
     readonly onVisited: (state: TState, visited: Set<string>, rollbacks: RollbackEntry<THelper>[]) => TState;
     readonly readRollbacks?: (state: TState) => RollbackEntry<THelper>[] | undefined;
 };