@blokjs/runner 0.2.2 → 0.6.0

package/dist/workflow/PersistenceHelper.js

@@ -2,22 +2,32 @@
  * Apply a step's output to `ctx.state` according to the step's persistence
  * knobs.
  *
- * **Rules** (in order):
+ * **Rules** (evaluated in order):
+ * 0. **Errored result → no-op.** A step that threw, returned `success:
+ *    false`, or carries a non-null `error` / `errors` field does NOT write
+ *    state. Authors can rely on `ctx.state[<step-id>] === undefined` as a
+ *    truthful "did this step actually succeed?" check inside a
+ *    `tryCatch.catch` arm. Without this guard, the framework's internal
+ *    `BlokResponse.setError()` writes `data = {}` and the helper would
+ *    persist that empty object — making the natural existence check
+ *    meaningless. (See [tryCatch docs](../../../docs/c/devtools/tryCatch.mdx).)
  * 1. `ephemeral: true` → no-op. Output is only available via `ctx.prev`.
- * 2. Legacy `set_var: false` → treated as `ephemeral: true` (back-compat).
- * 3. `spread: true` AND `data` is a plain object → shallow-merge data's
+ * 2. `spread: true` AND `data` is a plain object → shallow-merge data's
  *    top-level keys into `ctx.state`.
- * 4. Default → `ctx.state[as ?? name] = data`.
+ * 3. Default → `ctx.state[as ?? name] = data`.
  *
  * Mutates `ctx.state` in place. Always safe to call (no-op on missing data
  * unless `spread` is set, which is an authoring-time error to combine with
  * non-object output and is detected at workflow load time, not here).
  */
 export function applyStepOutput(ctx, step, result) {
-    // Rule 1 & 2 — opt-out paths
-    if (step.ephemeral === true)
+    // Rule 0 — error guard. Centralized so all callers (Blok.run,
+    // RuntimeAdapterNode.run, SubworkflowNode.dispatchSync) inherit the
+    // same truthful-state contract without each re-implementing the check.
+    if (isErroredResult(result))
         return;
-    if (step.set_var === false)
+    // Rule 1 — opt-out path
+    if (step.ephemeral === true)
         return;
     // Defensive: ensure state exists (TriggerBase initializes it, but
     // some legacy code paths construct ctx by hand).
@@ -26,7 +36,7 @@ export function applyStepOutput(ctx, step, result) {
     }
     const state = ctx.state;
     const data = result?.data;
-    // Rule 3 — spread
+    // Rule 2 — spread
     if (step.spread === true) {
         if (isPlainObject(data)) {
             Object.assign(state, data);
@@ -36,7 +46,7 @@ export function applyStepOutput(ctx, step, result) {
         // author is aware.
         return;
     }
-    // Rule 4 — default-store
+    // Rule 3 — default-store
     if (data === undefined)
         return;
     const key = step.as ?? step.name;
@@ -54,4 +64,20 @@ function isPlainObject(value) {
     const proto = Object.getPrototypeOf(value);
     return proto === null || proto === Object.prototype;
 }
+/**
+ * Detect whether a step result represents a failure. Three indicators —
+ * `success: false`, a non-null `error` (ResponseContext / BlokResponse
+ * shape), or a non-null `errors` (ExecutionResult shape from the runtime
+ * adapters) — are all treated equivalently. Any one is enough to skip
+ * persistence so the next step's `ctx.state[<id>]` check tells the truth.
+ */
+function isErroredResult(result) {
+    if (result.success === false)
+        return true;
+    if (result.error !== undefined && result.error !== null)
+        return true;
+    if (result.errors !== undefined && result.errors !== null)
+        return true;
+    return false;
+}
 //# sourceMappingURL=PersistenceHelper.js.map

package/dist/workflow/PersistenceHelper.js.map

@@ -1 +1 @@
-{"version":3,"file":"PersistenceHelper.js","sourceRoot":"","sources":["../../src/workflow/PersistenceHelper.ts"],"names":[],"mappings":"AAiCA;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,eAAe,CAAC,GAAY,EAAE,IAAqB,EAAE,MAAyB;IAC7F,6BAA6B;IAC7B,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI;QAAE,OAAO;IACpC,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK;QAAE,OAAO;IAEnC,kEAAkE;IAClE,iDAAiD;IACjD,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;QAChD,GAA0C,CAAC,KAAK,GAAG,EAAE,CAAC;IACxD,CAAC;IAED,MAAM,KAAK,GAAG,GAAG,CAAC,KAAgC,CAAC;IACnD,MAAM,IAAI,GAAG,MAAM,EAAE,IAAI,CAAC;IAE1B,kBAAkB;IAClB,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;QAC1B,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAC5B,CAAC;QACD,6DAA6D;QAC7D,6DAA6D;QAC7D,mBAAmB;QACnB,OAAO;IACR,CAAC;IAED,yBAAyB;IACzB,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO;IAC/B,MAAM,GAAG,GAAG,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC;IACjC,IAAI,CAAC,GAAG;QAAE,OAAO,CAAC,+DAA+D;IACjF,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;AACnB,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACpC,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACxD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC5C,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACvC,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAC3C,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,MAAM,CAAC,SAAS,CAAC;AACrD,CAAC"}
+{"version":3,"file":"PersistenceHelper.js","sourceRoot":"","sources":["../../src/workflow/PersistenceHelper.ts"],"names":[],"mappings":"AAkCA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,eAAe,CAAC,GAAY,EAAE,IAAqB,EAAE,MAAyB;IAC7F,8DAA8D;IAC9D,oEAAoE;IACpE,uEAAuE;IACvE,IAAI,eAAe,CAAC,MAAM,CAAC;QAAE,OAAO;IAEpC,wBAAwB;IACxB,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI;QAAE,OAAO;IAEpC,kEAAkE;IAClE,iDAAiD;IACjD,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;QAChD,GAA0C,CAAC,KAAK,GAAG,EAAE,CAAC;IACxD,CAAC;IAED,MAAM,KAAK,GAAG,GAAG,CAAC,KAAgC,CAAC;IACnD,MAAM,IAAI,GAAG,MAAM,EAAE,IAAI,CAAC;IAE1B,kBAAkB;IAClB,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;QAC1B,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAC5B,CAAC;QACD,6DAA6D;QAC7D,6DAA6D;QAC7D,mBAAmB;QACnB,OAAO;IACR,CAAC;IAED,yBAAyB;IACzB,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO;IAC/B,MAAM,GAAG,GAAG,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC;IACjC,IAAI,CAAC,GAAG;QAAE,OAAO,CAAC,+DAA+D;IACjF,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;AACnB,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACpC,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACxD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC5C,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACvC,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAC3C,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,MAAM,CAAC,SAAS,CAAC;AACrD,CAAC;AAED;;;;;;GAMG;AACH,SAAS,eAAe,CAAC,MAAyB;IACjD,IAAI,MAAM,CAAC,OAAO,KAAK,KAAK;QAAE,OAAO,IAAI,CAAC;IAC1C,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IACrE,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IACvE,OAAO,KAAK,CAAC;AACd,CAAC"}

package/dist/workflow/WorkflowNormalizer.d.ts

@@ -1,56 +1,43 @@
-/**
- * WorkflowNormalizer — accepts v1 or v2 workflow shapes and projects both
- * to the single canonical internal shape that `Configuration.getSteps` /
- * `Configuration.getNodes` already consume.
- *
- * **Input shapes accepted**
- *
- * v1 (legacy):
- * ```
- * {
- *   name, version, trigger,
- *   steps: [{ name, node, type, active?, stop?, set_var? }],
- *   nodes: { [stepName]: { inputs?, conditions? } }
- * }
- * ```
- *
- * v2 (canonical):
- * ```
- * {
- *   name, version, trigger,
- *   steps: [
- *     { id, use, type?, inputs?, as?, spread?, ephemeral?, active?, stop? }
- *   | { id, branch: { when, then, else? } }
- *   ]
- * }
- * ```
- *
- * **Output shape** (always v1-compatible internal):
- * ```
- * {
- *   name, version, trigger,           // method "*" normalized to "ANY"
- *   steps: [{ name, node, type, active, stop, set_var, as, spread, ephemeral, ... }],
- *   nodes: { [stepName]: { inputs?, conditions? } }
- * }
- * ```
- *
- * **Why a single internal shape?** The runner core (RunnerSteps,
- * Configuration, Blok.run, etc.) is unchanged. Normalization is purely
- * an authoring-layer concern. Old workflows keep running; new authoring
- * shapes get translated transparently.
- */
+interface RetryConfig {
+    maxAttempts: number;
+    minTimeoutInMs?: number;
+    maxTimeoutInMs?: number;
+    factor?: number;
+}
 interface InternalStep {
     name: string;
     node: string;
     type: string;
     active?: boolean;
     stop?: boolean;
-    set_var?: boolean;
     as?: string;
     spread?: boolean;
     ephemeral?: boolean;
     stream_logs?: boolean;
     flow?: boolean;
+    idempotencyKey?: string;
+    idempotencyKeyTTL?: number;
+    retry?: RetryConfig;
+    subworkflow?: string;
+    wait?: boolean;
+    /**
+     * Tier 2 quick-wins — per-attempt execution timeout. Number (ms) or
+     * duration string (`"30s"`, etc.). Configuration thread-through
+     * normalizes to milliseconds via `parseDuration`.
+     */
+    maxDuration?: number | string;
+    /**
+     * PR 4 — `wait.for(duration)` / `wait.until(date)` step.
+     *
+     * Discriminates by `type === "wait"` and the presence of either
+     * `waitForMs` (numeric ms after parseDuration) or `waitUntil` (number
+     * ms-since-epoch OR string for $-proxy / ISO).
+     *
+     * `wait?: boolean` above is the sub-workflow `wait: true|false` flag
+     * — separate concern, separate field.
+     */
+    waitForMs?: number;
+    waitUntil?: number | string;
     [key: string]: unknown;
 }
 interface InternalNodeConfig {
@@ -71,6 +58,25 @@ export interface InternalWorkflow {
     trigger: Record<string, unknown>;
     steps: InternalStep[];
     nodes: Record<string, InternalNodeConfig>;
+    /**
+     * v0.5 — when `true`, this workflow is registered as middleware and is
+     * NOT exposed as a public HTTP route. Invoked from another workflow's
+     * `trigger.http.middleware: [...]` array (or `appliedMiddleware` below).
+     */
+    middleware?: true;
+    /**
+     * v0.5.2 — workflow-level middleware chain. Authors write `middleware:
+     * [...]` at the top level of the workflow definition; the normalizer
+     * routes the array form here while keeping `middleware: true` as the
+     * marker bit. Applies to ALL triggers of this workflow, runs BEFORE
+     * any trigger-level middleware. Use this when a chain (auth, rate-limit)
+     * applies uniformly across every trigger of a workflow — saves
+     * repeating the same list on every trigger config.
+     *
+     * Mutually exclusive with `middleware: true` — a workflow cannot
+     * simultaneously be a middleware AND apply other middleware to itself.
+     */
+    appliedMiddleware?: readonly string[];
 }
 /**
  * Convert any accepted workflow shape into the canonical internal shape.