@nanobpm/urban 0.82.1 → 0.84.0

package/dist/runtime/engine/nanosdk.js

@@ -48,6 +48,278 @@ export function normalizeProcessInstanceState(raw) {
             return undefined;
     }
 }
+/** Map the engine's element-instance `state` onto the transport-agnostic
+ *  {@link ElementInstanceState} union, or `undefined` for an unrecognized value (which the
+ *  caller skips rather than surfacing a malformed row). Case-insensitive so a future casing
+ *  tweak on the engine side doesn't silently drop element instances. Kept separate from
+ *  {@link normalizeProcessInstanceState} — the two model distinct engine enums that only
+ *  coincide today — so element and process state can diverge without a hidden coupling. */
+export function normalizeElementInstanceState(raw) {
+    if (typeof raw !== "string")
+        return undefined;
+    switch (raw.toUpperCase()) {
+        case "ACTIVE":
+            return "ACTIVE";
+        case "COMPLETED":
+            return "COMPLETED";
+        case "TERMINATED":
+            return "TERMINATED";
+        default:
+            return undefined;
+    }
+}
+/** Map the engine's wait-state `waitStateType` onto the transport-agnostic
+ *  {@link WaitStateType} union, or `undefined` for an unrecognized value. Case-insensitive
+ *  so a casing tweak doesn't silently drop parks. */
+export function normalizeWaitStateType(raw) {
+    if (typeof raw !== "string")
+        return undefined;
+    switch (raw.toUpperCase()) {
+        case "JOB":
+            return "JOB";
+        case "MESSAGE":
+            return "MESSAGE";
+        case "USER_TASK":
+            return "USER_TASK";
+        case "TIMER":
+            return "TIMER";
+        case "SIGNAL":
+            return "SIGNAL";
+        case "CONDITION":
+            return "CONDITION";
+        default:
+            return undefined;
+    }
+}
+/** Map the engine's incident `state` onto the transport-agnostic {@link IncidentState} union,
+ *  falling back to `"UNKNOWN"` for an unrecognized/absent value (an incident is never dropped
+ *  for an odd state — unlike element/process rows, whose state is a hard identity field — so a
+ *  caller still sees the fault). Case-insensitive so a casing tweak doesn't mis-map. */
+export function normalizeIncidentState(raw) {
+    if (typeof raw !== "string")
+        return "UNKNOWN";
+    switch (raw.toUpperCase()) {
+        case "ACTIVE":
+            return "ACTIVE";
+        case "MIGRATED":
+            return "MIGRATED";
+        case "PENDING":
+            return "PENDING";
+        case "RESOLVED":
+            return "RESOLVED";
+        default:
+            return "UNKNOWN";
+    }
+}
+/** A non-empty string form of an engine key/id, or `undefined` when absent/blank (including a
+ *  whitespace-only string). Coerces a numeric key to a string (the engine may serialize a key
+ *  either way) but never `String(...)`-coerces an arbitrary object into a garbage
+ *  `"[object Object]"` id. The blank check trims, matching `getElementInstance`'s blank-key
+ *  guard and the form-key presence helpers, so a `"   "` key can never leak into a result. */
+function presentEngineKey(value) {
+    if (typeof value === "number") {
+        return Number.isFinite(value) ? String(value) : undefined;
+    }
+    if (typeof value !== "string")
+        return undefined;
+    const trimmed = value.trim();
+    return trimmed === "" ? undefined : trimmed;
+}
+/** The non-empty, trimmed string form of a *required* engine key, or throws when the value is
+ *  absent/blank (including a whitespace-only string). A mutating seam operation addresses a
+ *  single entity by key, so a blank key is a caller bug that must fail fast with an actionable
+ *  message rather than reach the engine as an empty path segment / invalid changeset and surface
+ *  an opaque transport error. Reuses {@link presentEngineKey}'s trim-and-coerce rule so a padded
+ *  key like `" 5 "` is normalized identically to how read paths resolve it. */
+function requireEngineKey(value, name) {
+    const key = presentEngineKey(value);
+    if (key === undefined) {
+        throw new Error(`${name} must be a non-empty key`);
+    }
+    return key;
+}
+/** A required text field (a wait-state discriminator's `jobType`/`messageName`/`signalName`),
+ *  or `undefined` when absent or blank — the caller skips the row rather than emitting a typed
+ *  wait state carrying an empty required string. Returns the trimmed value, matching the
+ *  presence rule used for keys, so surrounding whitespace can never leak into a result. */
+function presentText(value) {
+    if (typeof value !== "string")
+        return undefined;
+    const trimmed = value.trim();
+    return trimmed === "" ? undefined : trimmed;
+}
+/** The element type carried on an element-instance/wait-state row. The Camunda SDK DTO calls
+ *  it `type`; a plain REST/Rust-engine body may call it `elementType`. Accept either. */
+function pickElementType(row) {
+    return presentText(row.elementType) ?? presentText(row.type);
+}
+/** Map one engine element-instance row onto an {@link ElementInstanceSummary}, or `undefined`
+ *  when the row is malformed (missing key/elementId/process instance, or an unrecognized
+ *  state). The single source of truth both `searchElementInstances` and `getElementInstance`
+ *  extract through, so the two cannot drift. */
+export function mapElementInstanceRow(row, log) {
+    const elementInstanceKey = presentEngineKey(row.elementInstanceKey);
+    if (elementInstanceKey === undefined) {
+        log("warn", "skipping element instance with no key in engine response");
+        return undefined;
+    }
+    const processInstanceKey = presentEngineKey(row.processInstanceKey);
+    if (processInstanceKey === undefined) {
+        log("warn", "skipping element instance with no processInstanceKey in engine response", {
+            elementInstanceKey,
+        });
+        return undefined;
+    }
+    const elementId = typeof row.elementId === "string" && row.elementId.trim() !== ""
+        ? row.elementId.trim()
+        : undefined;
+    if (elementId === undefined) {
+        log("warn", "skipping element instance with no elementId in engine response", {
+            elementInstanceKey,
+        });
+        return undefined;
+    }
+    const state = normalizeElementInstanceState(row.state);
+    if (state === undefined) {
+        log("warn", "skipping element instance with unrecognized state", {
+            elementInstanceKey,
+            state: String(row.state),
+        });
+        return undefined;
+    }
+    const elementType = pickElementType(row);
+    return {
+        elementInstanceKey,
+        processInstanceKey,
+        elementId,
+        ...(elementType ? { elementType } : {}),
+        state,
+    };
+}
+/** Map one engine wait-state row onto an {@link ElementInstanceWaitState}, or `undefined`
+ *  when the row is malformed (missing identity, or an unrecognized `waitStateType`). The
+ *  Camunda SDK nests the park-specific fields under `details`; a plain REST body may inline
+ *  them — read `details` first, then fall back to the row itself, so both wire shapes map. */
+export function mapElementInstanceWaitStateRow(row, log) {
+    const elementInstanceKey = presentEngineKey(row.elementInstanceKey);
+    const processInstanceKey = presentEngineKey(row.processInstanceKey);
+    const elementId = typeof row.elementId === "string" && row.elementId.trim() !== ""
+        ? row.elementId.trim()
+        : undefined;
+    if (elementInstanceKey === undefined || processInstanceKey === undefined || elementId === undefined) {
+        log("warn", "skipping element-instance wait state with incomplete identity in engine response");
+        return undefined;
+    }
+    const details = isRecord(row.details) ? row.details : row;
+    const waitStateType = normalizeWaitStateType(details.waitStateType ?? row.waitStateType);
+    if (waitStateType === undefined) {
+        log("warn", "skipping element-instance wait state with unrecognized waitStateType", {
+            elementInstanceKey,
+            waitStateType: String(details.waitStateType ?? row.waitStateType),
+        });
+        return undefined;
+    }
+    const elementType = pickElementType(row);
+    const base = {
+        elementInstanceKey,
+        processInstanceKey,
+        elementId,
+        ...(elementType ? { elementType } : {}),
+    };
+    switch (waitStateType) {
+        case "JOB": {
+            // `jobType` is the required discriminator of a JOB park; without it the row is malformed.
+            const jobType = presentText(details.jobType);
+            if (jobType === undefined) {
+                log("warn", "skipping JOB wait state with no jobType in engine response", {
+                    elementInstanceKey,
+                });
+                return undefined;
+            }
+            const jobKey = presentEngineKey(details.jobKey);
+            return { ...base, waitStateType, jobType, ...(jobKey ? { jobKey } : {}) };
+        }
+        case "MESSAGE": {
+            // `messageName` is the required discriminator of a MESSAGE park.
+            const messageName = presentText(details.messageName);
+            if (messageName === undefined) {
+                log("warn", "skipping MESSAGE wait state with no messageName in engine response", {
+                    elementInstanceKey,
+                });
+                return undefined;
+            }
+            const correlationKey = presentText(details.correlationKey);
+            return {
+                ...base,
+                waitStateType,
+                messageName,
+                ...(correlationKey ? { correlationKey } : {}),
+            };
+        }
+        case "USER_TASK": {
+            // `userTaskKey` is the required identity of a USER_TASK park; without it the row is
+            // malformed. Skip it (like the missing-identity guards above) rather than emit a typed
+            // wait state carrying an empty key that would break a downstream join.
+            const userTaskKey = presentEngineKey(details.taskKey ?? details.userTaskKey);
+            if (userTaskKey === undefined) {
+                log("warn", "skipping USER_TASK wait state with no userTaskKey in engine response", {
+                    elementInstanceKey,
+                });
+                return undefined;
+            }
+            return { ...base, waitStateType, userTaskKey };
+        }
+        case "SIGNAL": {
+            // `signalName` is the required discriminator of a SIGNAL park.
+            const signalName = presentText(details.signalName);
+            if (signalName === undefined) {
+                log("warn", "skipping SIGNAL wait state with no signalName in engine response", {
+                    elementInstanceKey,
+                });
+                return undefined;
+            }
+            return { ...base, waitStateType, signalName };
+        }
+        case "TIMER":
+            return { ...base, waitStateType };
+        case "CONDITION":
+            return { ...base, waitStateType };
+    }
+}
+/** Map one engine incident row onto an {@link IncidentSummary}, or `undefined` when the row is
+ *  malformed (missing the `incidentKey` or the owning `processInstanceKey` — the two identity
+ *  fields a caller needs to resolve/act on it). `jobKey`/`elementInstanceKey`/`errorType`/
+ *  `errorMessage` are best-effort diagnostics: present when the engine reports them, omitted
+ *  otherwise. The single source of truth `searchIncidents` extracts through. */
+export function mapIncidentRow(row, log) {
+    const incidentKey = presentEngineKey(row.incidentKey);
+    if (incidentKey === undefined) {
+        log("warn", "skipping incident with no incidentKey in engine response");
+        return undefined;
+    }
+    const processInstanceKey = presentEngineKey(row.processInstanceKey);
+    if (processInstanceKey === undefined) {
+        log("warn", "skipping incident with no processInstanceKey in engine response", {
+            incidentKey,
+        });
+        return undefined;
+    }
+    const elementId = presentText(row.elementId);
+    const elementInstanceKey = presentEngineKey(row.elementInstanceKey);
+    const jobKey = presentEngineKey(row.jobKey);
+    const errorType = presentText(row.errorType);
+    const errorMessage = presentText(row.errorMessage);
+    return {
+        incidentKey,
+        processInstanceKey,
+        ...(elementId ? { elementId } : {}),
+        ...(elementInstanceKey ? { elementInstanceKey } : {}),
+        ...(jobKey ? { jobKey } : {}),
+        ...(errorType ? { errorType } : {}),
+        ...(errorMessage ? { errorMessage } : {}),
+        state: normalizeIncidentState(row.state),
+    };
+}
 /**
  * An `EngineClient` backed entirely by a `@nanobpm/nano-sdk` client. Deploy, create,
  * message, and user-task calls map one-to-one onto the SDK's client methods; workers
@@ -215,6 +487,121 @@ export class SdkEngineClient {
             return [{ processInstanceKey: String(key), state }];
         });
     }
+    async searchElementInstances(filter) {
+        // Mirror `searchProcessInstances`: build the engine filter from the transport-agnostic
+        // selectors, read at zero-wait consistency (an element-instance search is eventually
+        // consistent), and map each row through the single `mapElementInstanceRow` gate — which
+        // also `searchElementInstances`/`getElementInstance` share — dropping malformed rows.
+        const f = {};
+        if (filter?.processInstanceKey)
+            f.processInstanceKey = filter.processInstanceKey;
+        if (filter?.elementId)
+            f.elementId = filter.elementId;
+        if (filter?.state)
+            f.state = filter.state;
+        const body = await this.client.searchElementInstances({ filter: f }, { consistency: { waitUpToMs: 0 } });
+        const items = Array.isArray(body.items) ? body.items.filter(isRecord) : [];
+        return items.flatMap((it) => {
+            const mapped = mapElementInstanceRow(it, this.log);
+            return mapped ? [mapped] : [];
+        });
+    }
+    async searchElementInstanceWaitStates(filter) {
+        // The wait-states search surfaces *every* park (job/message/timer/signal/condition/user
+        // task), not just user tasks. Same zero-wait read + per-row mapping-gate shape as
+        // `searchElementInstances`; the SDK nests park-specific fields under `details`, which
+        // `mapElementInstanceWaitStateRow` unwraps.
+        const f = {};
+        if (filter?.processInstanceKey)
+            f.processInstanceKey = filter.processInstanceKey;
+        if (filter?.elementId)
+            f.elementId = filter.elementId;
+        if (filter?.waitStateType)
+            f.waitStateType = filter.waitStateType;
+        const body = await this.client.searchElementInstanceWaitStates({ filter: f }, { consistency: { waitUpToMs: 0 } });
+        const items = Array.isArray(body.items) ? body.items.filter(isRecord) : [];
+        return items.flatMap((it) => {
+            const mapped = mapElementInstanceWaitStateRow(it, this.log);
+            return mapped ? [mapped] : [];
+        });
+    }
+    async getElementInstance(elementInstanceKey) {
+        // A blank key can never address an element instance — short-circuit to null rather than
+        // issue a `GET /element-instances/` with an empty segment. Normalize the key up front (as
+        // `getForm` resolves a normalized identifier before fetching) so a padded-but-valid key
+        // like `" 5 "` addresses the same element instance rather than 404ing on the raw segment.
+        if (typeof elementInstanceKey !== "string" || elementInstanceKey.trim() === "") {
+            return null;
+        }
+        const key = elementInstanceKey.trim();
+        let body;
+        try {
+            body = await this.client.getElementInstance({ elementInstanceKey: key }, { consistency: { waitUpToMs: 0 } });
+        }
+        catch (err) {
+            // A 404 (no such element instance) is an expected "not found", not a fault — mirror
+            // `getForm`, which treats a failed fetch as absence (null) rather than propagating.
+            this.log("warn", "getElementInstance: engine fetch failed", {
+                elementInstanceKey: key,
+                err: err instanceof Error ? err.message : String(err),
+            });
+            return null;
+        }
+        if (!isRecord(body))
+            return null;
+        return mapElementInstanceRow(body, this.log) ?? null;
+    }
+    async searchIncidents(filter) {
+        // Same shape as `searchElementInstances`: build the engine filter from the transport-agnostic
+        // selectors, read at zero-wait consistency (an incident search is eventually consistent), and
+        // map each row through the single `mapIncidentRow` gate, dropping malformed rows.
+        const f = {};
+        // Normalize the request selectors the same way the response mapper normalizes keys: a
+        // whitespace-only/padded `processInstanceKey` must not reach the engine as a garbage filter
+        // segment (which would silently return surprising empty results).
+        const processInstanceKey = presentEngineKey(filter?.processInstanceKey);
+        if (processInstanceKey)
+            f.processInstanceKey = processInstanceKey;
+        if (filter?.state)
+            f.state = filter.state;
+        const body = await this.client.searchIncidents({ filter: f }, { consistency: { waitUpToMs: 0 } });
+        const items = Array.isArray(body.items) ? body.items.filter(isRecord) : [];
+        return items.flatMap((it) => {
+            const mapped = mapIncidentRow(it, this.log);
+            return mapped ? [mapped] : [];
+        });
+    }
+    async resolveIncident(input) {
+        await this.client.resolveIncident({
+            incidentKey: requireEngineKey(input.incidentKey, "incidentKey"),
+        });
+    }
+    async updateJobRetries(input) {
+        // The "retry a failed job" operation: a job's remaining retries are the `retries` field of
+        // the `updateJob` changeset. Bumping them back above zero makes a failed job activatable so a
+        // paired `resolveIncident` can return it to the pool.
+        const jobKey = requireEngineKey(input.jobKey, "jobKey");
+        // `retries` serializes straight into the engine changeset, and `number` admits `NaN`,
+        // fractional, and negative values — none of which is a valid retry count. Reject them up
+        // front so a tool-driven call fails with a clear message instead of an opaque engine error.
+        if (!Number.isInteger(input.retries) || input.retries < 0) {
+            throw new Error("retries must be a non-negative integer");
+        }
+        await this.client.updateJob({
+            jobKey,
+            changeset: { retries: input.retries },
+        });
+    }
+    async setVariables(input) {
+        // A scope is addressed by its element-instance key (the process instance's root scope is an
+        // element instance too), so `scopeKey` maps straight onto `elementInstanceKey`. `local`
+        // defaults to engine behaviour (propagate to the outermost scope) when unset.
+        await this.client.createElementInstanceVariables({
+            elementInstanceKey: requireEngineKey(input.scopeKey, "scopeKey"),
+            variables: input.variables,
+            ...(input.local === undefined ? {} : { local: input.local }),
+        });
+    }
     async registerWorker(jobType, handler, options) {
         const worker = this.client.createJobWorker({
             jobType,

package/dist/runtime/index.d.ts

@@ -8,7 +8,7 @@ export { bindModeToHost, expandEnv, expandEnvString, isBindMode, loadManifest, p
 export type { ActionDecl, AppManifest, BindMode, ChatSurface, DataSource, DomainField, DomainType, InstanceTracking, LlmBinding, NetworkConfig, PagesSurface, Surfaces, TaskInboxSurface, Trigger, Worker, } from "./core/manifest.ts";
 export { collectManifestIssues, ManifestValidationError, validateManifest, } from "./core/validate.ts";
 export type { ValidationIssue } from "./core/validate.ts";
-export type { EngineClient, EngineJob, FormSchema, HostContext, HttpHandler, HttpRequest, HttpResponse, HttpServer, JobHandler, ProcessInstanceSnapshot, ProcessInstanceState, SqliteDb, UserTaskState, UserTaskSummary, UserTaskFilter, WatchHandle, WorkerSubscription, } from "./core/host.ts";
+export type { EngineClient, ElementInstanceState, ElementInstanceSummary, ElementInstanceFilter, ElementInstanceWaitState, ElementInstanceWaitStateFilter, WaitStateType, EngineJob, FormSchema, HostContext, HttpHandler, HttpRequest, HttpResponse, HttpServer, IncidentState, EngineIncidentState, IncidentFilter, IncidentSummary, JobHandler, ProcessInstanceSnapshot, ProcessInstanceState, SqliteDb, UserTaskState, UserTaskSummary, UserTaskFilter, WatchHandle, WorkerSubscription, } from "./core/host.ts";
 export { buildFormSchema, parseFormSchema, pickFormLinkage, presentFormIdentifier, resolveFormIdentifier, } from "./core/form-contract.ts";
 export type { AppApi, Mounted, RuntimeContext } from "./core/context.ts";
 export { createLogger } from "./core/logger.ts";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@nanobpm/urban",
-	"version": "0.82.1",
+	"version": "0.84.0",
 	"description": "Urban: build and run code-first apps on Nano — runtime, derivation toolkit, and CLI in one. Author durable processes with @nanobpm/workflow (defineFlow), a typed datasource, forms, triggers and surfaces from a nano.app.json manifest, on Node or Deno.",
 	"license": "Apache-2.0",
 	"type": "module",

package/src/runtime/core/host.ts

@@ -261,6 +261,153 @@ export interface UserTaskFilter {
   candidateGroup?: string;
 }
 
+/**
+ * An element instance's lifecycle state, as the engine reports it on a
+ * `/v2/element-instances/search` result. Mirrors the engine's `ElementInstanceStateEnum`:
+ * `ACTIVE` (a token is currently *at* this element), `COMPLETED` (the token has left it), or
+ * `TERMINATED` (the element was interrupted). Structurally the same state set as
+ * {@link ProcessInstanceState} (one active state plus the `COMPLETED`/`TERMINATED` terminals),
+ * but a distinct concept — element instances are the tokens *within* a process instance — so it
+ * is kept as its own type rather than aliased.
+ */
+export type ElementInstanceState = "ACTIVE" | "COMPLETED" | "TERMINATED";
+
+/**
+ * A single element instance ("token") as {@link EngineClient.searchElementInstances} and
+ * {@link EngineClient.getElementInstance} report it — the finest-grained "how far has this
+ * process instance progressed" signal, below the process-instance lifecycle
+ * ({@link ProcessInstanceSnapshot}) and independent of whether the element is a user task
+ * ({@link UserTaskSummary}). It surfaces active *non-user-task* elements (a service task, a
+ * gateway, a catch event) a user-task search cannot see — "the furthest element reached".
+ * Carries the element instance's own key, its identity (`elementId`, its BPMN `elementType`
+ * when the engine reports it), the owning process instance, and its lifecycle `state`.
+ */
+export interface ElementInstanceSummary {
+  readonly elementInstanceKey: string;
+  readonly processInstanceKey: string;
+  readonly elementId: string;
+  /** The BPMN element type (e.g. `"SERVICE_TASK"`, `"USER_TASK"`,
+   *  `"INTERMEDIATE_CATCH_EVENT"`), when the engine reports it. Kept transport-agnostic (a
+   *  bare string) so a new BPMN element type on the engine flows through without having to be
+   *  enumerated here. Absent when the adapter's read model does not carry it. */
+  readonly elementType?: string;
+  readonly state: ElementInstanceState;
+}
+
+/**
+ * The kind of wait an element instance is parked in, as a
+ * `/v2/element-instances/wait-states/search` result reports it. Unlike a user-task search,
+ * this surfaces *every* park — a `JOB` (a service task awaiting a worker), a `MESSAGE`
+ * (an event awaiting correlation), a `TIMER`, a `SIGNAL`, a `CONDITION`, as well as a
+ * `USER_TASK` — so a consumer can read "what is this instance blocked on" beyond user tasks.
+ */
+export type WaitStateType =
+  | "JOB"
+  | "MESSAGE"
+  | "USER_TASK"
+  | "TIMER"
+  | "SIGNAL"
+  | "CONDITION";
+
+/**
+ * A single parked (waiting) element instance as
+ * {@link EngineClient.searchElementInstanceWaitStates} reports it. Every variant carries the
+ * element instance's identity; the `waitStateType` discriminates the park-specific fields — a
+ * `JOB` carries the `jobType`/`jobKey` it is parked on, a `MESSAGE` the awaited
+ * `messageName`/`correlationKey`, a `USER_TASK` the `userTaskKey`, a `SIGNAL` the
+ * `signalName` — so a caller narrows on `waitStateType` to reach them type-safely rather than
+ * probing a flat optional-field bag.
+ */
+export type ElementInstanceWaitState =
+  & {
+    readonly elementInstanceKey: string;
+    readonly processInstanceKey: string;
+    readonly elementId: string;
+    readonly elementType?: string;
+  }
+  & (
+    | { readonly waitStateType: "JOB"; readonly jobType: string; readonly jobKey?: string }
+    | {
+      readonly waitStateType: "MESSAGE";
+      readonly messageName: string;
+      readonly correlationKey?: string;
+    }
+    | { readonly waitStateType: "USER_TASK"; readonly userTaskKey: string }
+    | { readonly waitStateType: "TIMER" }
+    | { readonly waitStateType: "SIGNAL"; readonly signalName: string }
+    | { readonly waitStateType: "CONDITION" }
+  );
+
+/**
+ * Selectors for an element-instance search: which process instance, element, and/or lifecycle
+ * state to match. Used by {@link EngineClient.searchElementInstances}.
+ */
+export interface ElementInstanceFilter {
+  processInstanceKey?: string;
+  elementId?: string;
+  state?: ElementInstanceState;
+}
+
+/**
+ * Selectors for an element-instance *wait-state* search: which process instance, element,
+ * and/or kind of wait to match. Used by {@link EngineClient.searchElementInstanceWaitStates}.
+ * There is deliberately no lifecycle-`state` selector — a wait state is always an active park.
+ */
+export interface ElementInstanceWaitStateFilter {
+  processInstanceKey?: string;
+  elementId?: string;
+  waitStateType?: WaitStateType;
+}
+
+/**
+ * The engine's own incident-state enum — the lifecycle states an engine actually reports and
+ * that are valid as a search selector. An `ACTIVE` incident is an open fault a human/agent can
+ * act on (resolve/retry); the other values are terminal or transitional. This is the single
+ * source of truth for real engine states; {@link IncidentState} derives from it.
+ */
+export type EngineIncidentState = "ACTIVE" | "MIGRATED" | "PENDING" | "RESOLVED";
+
+/**
+ * The lifecycle state of an incident, as {@link EngineClient.searchIncidents} reports it.
+ * Extends {@link EngineIncidentState} with the client-side `"UNKNOWN"` sentinel — a fallback
+ * used when the engine returns an unrecognized/absent value, so an incident is surfaced rather
+ * than dropped for an odd state. Because `"UNKNOWN"` is not a real engine state, it is not a
+ * valid {@link IncidentFilter} selector. A caller narrows on this union rather than probing a
+ * raw string.
+ */
+export type IncidentState = EngineIncidentState | "UNKNOWN";
+
+/**
+ * Selectors for an incident search: which process instance and/or lifecycle state to match.
+ * Used by {@link EngineClient.searchIncidents}. An eventually consistent (zero-wait) read; an
+ * unset selector matches every incident.
+ */
+export interface IncidentFilter {
+  processInstanceKey?: string;
+  state?: EngineIncidentState;
+}
+
+/**
+ * A single incident (a stuck token — a job out of retries, an unhandled error, a failed
+ * gateway evaluation) as {@link EngineClient.searchIncidents} reports it. Carries the
+ * `incidentKey` a caller passes to {@link EngineClient.resolveIncident}, the owning
+ * `processInstanceKey`, and — when the incident is job-backed — the `jobKey` a caller passes
+ * to {@link EngineClient.updateJobRetries} to make the job retriable before resolving.
+ * `errorType`/`errorMessage` are the engine's fault description; they are free-form across
+ * engines (the live SDK reports a Camunda error-type enum, the in-process engine a coarser
+ * `kind`), so treat them as diagnostic text, not a stable taxonomy.
+ */
+export interface IncidentSummary {
+  readonly incidentKey: string;
+  readonly processInstanceKey: string;
+  readonly elementId?: string;
+  readonly elementInstanceKey?: string;
+  readonly jobKey?: string;
+  readonly errorType?: string;
+  readonly errorMessage?: string;
+  readonly state: IncidentState;
+}
+
 /**
  * A deployed form's form-js schema plus its identifying metadata, as
  * {@link EngineClient.getForm} returns it. `schema` is the parsed form-js document
@@ -350,6 +497,77 @@ export interface EngineClient {
     processInstanceKeys?: string[];
     state?: ProcessInstanceState;
   }): Promise<ProcessInstanceSnapshot[]>;
+  /**
+   * Search element instances ("tokens") by process instance, element, and/or lifecycle state
+   * (`POST /v2/element-instances/search`). Where {@link searchProcessInstances} answers "is
+   * this instance still running" and {@link searchUserTasks} answers "what user tasks are
+   * open", this answers "what element has a token reached" — including the active
+   * *non-user-task* elements (a service task, a gateway, a catch event) that a user-task
+   * search cannot see, i.e. "the furthest element reached". An eventually consistent
+   * (zero-wait) read; each {@link ElementInstanceSummary} carries the element instance's key,
+   * its `elementId`/`elementType`, the owning process instance, and its `state`.
+   */
+  searchElementInstances(
+    filter?: ElementInstanceFilter,
+  ): Promise<ElementInstanceSummary[]>;
+  /**
+   * Search the *wait states* of element instances
+   * (`POST /v2/element-instances/wait-states/search`) — every park, not only user tasks. A
+   * `JOB` park (a service task awaiting a worker), a `MESSAGE` park (an event awaiting
+   * correlation), a `TIMER`/`SIGNAL`/`CONDITION`, plus `USER_TASK`. A zero-wait read; each
+   * result is discriminated by `waitStateType` (see {@link ElementInstanceWaitState}), so a
+   * consumer can read the job/message parks a {@link searchUserTasks} cannot surface.
+   */
+  searchElementInstanceWaitStates(
+    filter?: ElementInstanceWaitStateFilter,
+  ): Promise<ElementInstanceWaitState[]>;
+  /**
+   * Fetch a single element instance by its key (`GET /v2/element-instances/{elementInstanceKey}`),
+   * or `null` when it cannot be resolved — the key is blank, no such element instance exists
+   * (a 404), or the fetch otherwise fails. A read is treated as absence rather than propagating
+   * (mirroring {@link getForm}), so a caller distinguishes "have it" from "don't" without a
+   * try/catch. A zero-wait read returning the same {@link ElementInstanceSummary} shape as
+   * {@link searchElementInstances}.
+   */
+  getElementInstance(
+    elementInstanceKey: string,
+  ): Promise<ElementInstanceSummary | null>;
+  /**
+   * Search incidents by owning process instance and/or lifecycle state
+   * (`POST /v2/incidents/search`) — the open faults blocking one or more instances (a job out
+   * of retries, an unhandled error, a failed gateway evaluation). An eventually consistent
+   * (zero-wait) read; each {@link IncidentSummary} carries the `incidentKey` to pass to
+   * {@link resolveIncident} and, for a job-backed incident, the `jobKey` to pass to
+   * {@link updateJobRetries}. The debugging counterpart to the read accessors above: where
+   * they answer "how far has this instance progressed", this answers "why is it stuck".
+   */
+  searchIncidents(filter?: IncidentFilter): Promise<IncidentSummary[]>;
+  /**
+   * Resolve an open incident by key (`POST /v2/incidents/{incidentKey}/resolution`), unblocking
+   * the parked token: a job incident returns the job to the activatable pool (so it must have
+   * retries left first — see {@link updateJobRetries}), a gateway incident re-evaluates, an
+   * uncaught-error incident re-creates the service-task job. A mutating operation.
+   */
+  resolveIncident(input: { incidentKey: string }): Promise<void>;
+  /**
+   * Update the remaining retries of a job (`PATCH /v2/jobs/{jobKey}`) — the "retry a failed
+   * job" operation. Setting a failed job's retries back above zero makes it activatable again;
+   * paired with {@link resolveIncident}, this is how a stuck `jobNoRetries` incident is cleared
+   * (bump retries, then resolve). A mutating operation.
+   */
+  updateJobRetries(input: { jobKey: string; retries: number }): Promise<void>;
+  /**
+   * Set (merge) variables into a scope (`PUT /v2/element-instances/{scopeKey}/variables`).
+   * `scopeKey` is a process-instance key or an element-instance key; when `local` is `true` the
+   * variables are merged strictly into that local scope, otherwise (the default) they propagate
+   * to the outermost scope. A mutating operation used to repair state before resolving an
+   * incident or to steer an instance during debugging.
+   */
+  setVariables(input: {
+    scopeKey: string;
+    variables: Record<string, unknown>;
+    local?: boolean;
+  }): Promise<void>;
   /** Register a push worker for a job type. Draining is handled by the adapter. */
   registerWorker(
     jobType: string,
@@ -384,6 +602,13 @@ export const ENGINE_CLIENT_METHODS = [
   "getForm",
   "completeUserTask",
   "searchProcessInstances",
+  "searchElementInstances",
+  "searchElementInstanceWaitStates",
+  "getElementInstance",
+  "searchIncidents",
+  "resolveIncident",
+  "updateJobRetries",
+  "setVariables",
   "registerWorker",
   "close",
 ] as const satisfies readonly (keyof EngineClient)[];