@retab/node 1.0.98 → 1.0.99

package/dist/api/workflows/runs/client.d.ts

@@ -1,11 +1,11 @@
 import { CompositionClient, RequestOptions } from "../../../client.js";
-import { MIMEDataInput, WorkflowRun, PaginatedList, CancelWorkflowResponse, ResumeWorkflowResponse } from "../../../types.js";
+import { MIMEDataInput, WorkflowRun, PaginatedList, CancelWorkflowResponse, ResumeWorkflowResponse, WorkflowRunExportResponse, WorkflowRunStatus, WorkflowRunTriggerType } from "../../../types.js";
 import APIWorkflowRunSteps from "./steps/client.js";
 /**
  * Workflow Runs API client for managing workflow executions.
  *
  * Sub-clients:
- * - steps: Step output operations (get, list)
+ * - steps: Step output operations (get, list, getMany, getAll)
  */
 export default class APIWorkflowRuns extends CompositionClient {
     steps: APIWorkflowRunSteps;
@@ -17,24 +17,12 @@ export default class APIWorkflowRuns extends CompositionClient {
      * The returned WorkflowRun will have status "running" - use get()
      * to check for updates on the run status.
      *
-     * @param workflowId - The ID of the workflow to run
-     * @param documents - Mapping of start node IDs to their input documents
-     * @param jsonInputs - Mapping of start_json node IDs to their input JSON data
-     * @param options - Optional request options
-     * @returns The created workflow run with status "running"
-     *
      * @example
      * ```typescript
      * const run = await client.workflows.runs.create({
      *     workflowId: "wf_abc123",
-     *     documents: {
-     *         "start-node-1": "./invoice.pdf",
-     *     },
-     *     jsonInputs: {
-     *         "json-node-1": { key: "value" },
-     *     },
+     *     documents: { "start-node-1": "./invoice.pdf" },
      * });
-     * console.log(`Run started: ${run.id}, status: ${run.status}`);
      * ```
      */
     create({ workflowId, documents, jsonInputs, }: {
@@ -44,47 +32,27 @@ export default class APIWorkflowRuns extends CompositionClient {
     }, options?: RequestOptions): Promise<WorkflowRun>;
     /**
      * Get a workflow run by ID.
-     *
-     * @param runId - The ID of the workflow run to retrieve
-     * @param options - Optional request options
-     * @returns The workflow run
-     *
-     * @example
-     * ```typescript
-     * const run = await client.workflows.runs.get("run_abc123");
-     * console.log(`Run status: ${run.status}`);
-     * ```
      */
     get(runId: string, options?: RequestOptions): Promise<WorkflowRun>;
     /**
      * List workflow runs with filtering and pagination.
-     *
-     * @example
-     * ```typescript
-     * const runs = await client.workflows.runs.list({
-     *     workflowId: "wf_abc123",
-     *     status: "completed",
-     *     limit: 10,
-     * });
-     * console.log(`Found ${runs.data.length} runs`);
-     * ```
      */
     list({ workflowId, status, statuses, excludeStatus, triggerType, triggerTypes, fromDate, toDate, minCost, maxCost, minDuration, maxDuration, search, sortBy, fields, before, after, limit, order, }?: {
         workflowId?: string;
-        status?: "pending" | "running" | "completed" | "error" | "waiting_for_human" | "cancelled";
-        statuses?: string;
-        excludeStatus?: "pending" | "running" | "completed" | "error" | "waiting_for_human" | "cancelled";
-        triggerType?: "manual" | "api" | "schedule" | "webhook" | "email" | "restart";
-        triggerTypes?: string;
-        fromDate?: string;
-        toDate?: string;
+        status?: WorkflowRunStatus;
+        statuses?: WorkflowRunStatus[] | string;
+        excludeStatus?: WorkflowRunStatus;
+        triggerType?: WorkflowRunTriggerType;
+        triggerTypes?: WorkflowRunTriggerType[] | string;
+        fromDate?: string | Date;
+        toDate?: string | Date;
         minCost?: number;
         maxCost?: number;
         minDuration?: number;
         maxDuration?: number;
         search?: string;
         sortBy?: string;
-        fields?: string;
+        fields?: string[] | string;
         before?: string;
         after?: string;
         limit?: number;
@@ -92,70 +60,22 @@ export default class APIWorkflowRuns extends CompositionClient {
     }, options?: RequestOptions): Promise<PaginatedList>;
     /**
      * Delete a workflow run and its associated step data.
-     *
-     * @param runId - The ID of the workflow run to delete
-     * @param options - Optional request options
-     *
-     * @example
-     * ```typescript
-     * await client.workflows.runs.delete("run_abc123");
-     * ```
      */
     delete(runId: string, options?: RequestOptions): Promise<void>;
     /**
      * Cancel a running or pending workflow run.
-     *
-     * @param runId - The ID of the workflow run to cancel
-     * @param commandId - Optional idempotency key for deduplicating cancel commands
-     * @param options - Optional request options
-     * @returns The updated run with cancellation status
-     *
-     * @example
-     * ```typescript
-     * const result = await client.workflows.runs.cancel("run_abc123");
-     * console.log(`Cancellation: ${result.cancellation_status}`);
-     * ```
      */
     cancel(runId: string, { commandId }?: {
         commandId?: string;
     }, options?: RequestOptions): Promise<CancelWorkflowResponse>;
     /**
      * Restart a completed or failed workflow run with the same inputs.
-     *
-     * @param runId - The ID of the workflow run to restart
-     * @param commandId - Optional idempotency key for deduplicating restart commands
-     * @param options - Optional request options
-     * @returns The new workflow run
-     *
-     * @example
-     * ```typescript
-     * const newRun = await client.workflows.runs.restart("run_abc123");
-     * console.log(`New run: ${newRun.id}`);
-     * ```
      */
     restart(runId: string, { commandId }?: {
         commandId?: string;
     }, options?: RequestOptions): Promise<WorkflowRun>;
     /**
      * Resume a workflow run after human-in-the-loop (HIL) review.
-     *
-     * @param runId - The ID of the workflow run to resume
-     * @param nodeId - The ID of the HIL node being approved/rejected
-     * @param approved - Whether the human approved the data
-     * @param modifiedData - Optional modified data if the human made changes
-     * @param commandId - Optional idempotency key for deduplicating resume commands
-     * @param options - Optional request options
-     * @returns The resume response with status and queue information
-     *
-     * @example
-     * ```typescript
-     * const result = await client.workflows.runs.resume("run_abc123", {
-     *     nodeId: "hil-node-1",
-     *     approved: true,
-     *     modifiedData: { field: "corrected value" },
-     * });
-     * console.log(`Resume status: ${result.resume_status}`);
-     * ```
      */
     resume(runId: string, { nodeId, approved, modifiedData, commandId, }: {
         nodeId: string;
@@ -166,58 +86,82 @@ export default class APIWorkflowRuns extends CompositionClient {
     /**
      * Poll a workflow run until it reaches a terminal state.
      *
-     * Terminal states: "completed", "error", "cancelled".
+     * Terminal states: "completed", "error", "cancelled", "waiting_for_human".
      *
      * @param runId - The ID of the workflow run to wait for
      * @param pollIntervalMs - Milliseconds between polls (default: 2000)
      * @param timeoutMs - Maximum time to wait in milliseconds (default: 600000 = 10 minutes)
-     * @returns The workflow run in a terminal state
-     * @throws Error if the run doesn't complete within the timeout
+     * @param onStatus - Optional callback invoked with the WorkflowRun on each poll
      *
      * @example
      * ```typescript
      * const run = await client.workflows.runs.waitForCompletion("run_abc123", {
-     *     pollIntervalMs: 1000,
-     *     timeoutMs: 300000,
+     *     onStatus: (r) => console.log(`${r.status}...`),
      * });
-     * console.log(`Final status: ${run.status}`);
      * ```
      */
-    waitForCompletion(runId: string, { pollIntervalMs, timeoutMs, }?: {
+    waitForCompletion(runId: string, { pollIntervalMs, timeoutMs, onStatus, }?: {
         pollIntervalMs?: number;
         timeoutMs?: number;
+        onStatus?: (run: WorkflowRun) => void | Promise<void>;
+    }): Promise<WorkflowRun>;
+    wait_for_completion(runId: string, { poll_interval_ms, timeout_ms, on_status, }?: {
+        poll_interval_ms?: number;
+        timeout_ms?: number;
+        on_status?: (run: WorkflowRun) => void | Promise<void>;
     }): Promise<WorkflowRun>;
     /**
      * Create a workflow run and wait for it to complete.
      *
-     * Convenience method that combines create() and waitForCompletion().
-     *
-     * @param workflowId - The ID of the workflow to run
-     * @param documents - Mapping of start node IDs to their input documents
-     * @param jsonInputs - Mapping of start_json node IDs to their input JSON data
-     * @param pollIntervalMs - Milliseconds between polls (default: 2000)
-     * @param timeoutMs - Maximum time to wait in milliseconds (default: 600000)
-     * @param options - Optional request options
-     * @returns The workflow run in a terminal state
-     *
      * @example
      * ```typescript
+     * import { raiseForStatus } from "retab";
+     *
      * const run = await client.workflows.runs.createAndWait({
      *     workflowId: "wf_abc123",
      *     documents: { "start-node-1": "./invoice.pdf" },
-     *     timeoutMs: 120000,
+     *     onStatus: (r) => console.log(`${r.status}...`),
      * });
-     * if (run.status === "completed") {
-     *     console.log("Outputs:", run.final_outputs);
-     * }
+     * raiseForStatus(run);
+     * console.log(run.final_outputs);
      * ```
      */
-    createAndWait({ workflowId, documents, jsonInputs, pollIntervalMs, timeoutMs, }: {
+    createAndWait({ workflowId, documents, jsonInputs, pollIntervalMs, timeoutMs, onStatus, }: {
         workflowId: string;
         documents?: Record<string, MIMEDataInput>;
         jsonInputs?: Record<string, Record<string, unknown>>;
         pollIntervalMs?: number;
         timeoutMs?: number;
+        onStatus?: (run: WorkflowRun) => void | Promise<void>;
     }, options?: RequestOptions): Promise<WorkflowRun>;
+    /**
+     * Get the configuration snapshot used for a run.
+     */
+    getConfig(runId: string, options?: RequestOptions): Promise<Record<string, unknown>>;
+    /**
+     * Get the DAG-ordered execution order for a run.
+     */
+    executionOrder(runId: string, options?: RequestOptions): Promise<Record<string, unknown>>;
+    /**
+     * Get a signed URL for downloading a document from a run step.
+     */
+    getDocumentUrl(runId: string, nodeId: string, options?: RequestOptions): Promise<Record<string, unknown>>;
+    /**
+     * Export run results as structured CSV data.
+     *
+     * @returns Object with `csv_data` (string), `rows` (number), `columns` (number)
+     */
+    export({ workflowId, nodeId, exportSource, selectedRunIds, status, excludeStatus, fromDate, toDate, triggerTypes, preferredColumns, }: {
+        workflowId: string;
+        nodeId: string;
+        exportSource?: "outputs" | "inputs";
+        selectedRunIds?: string[];
+        status?: string;
+        excludeStatus?: string;
+        fromDate?: string | Date;
+        toDate?: string | Date;
+        triggerTypes?: WorkflowRunTriggerType[];
+        preferredColumns?: string[];
+    }, options?: RequestOptions): Promise<WorkflowRunExportResponse>;
 }
 //# sourceMappingURL=client.d.ts.map

package/dist/api/workflows/runs/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/api/workflows/runs/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACvE,OAAO,EACH,aAAa,EAEb,WAAW,EAEX,aAAa,EAEb,sBAAsB,EAEtB,sBAAsB,EAEzB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,mBAAmB,MAAM,mBAAmB,CAAC;AAQpD;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,iBAAiB;IACnD,KAAK,EAAE,mBAAmB,CAAC;gBAEtB,MAAM,EAAE,iBAAiB;IAKrC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,MAAM,CACR,EACI,UAAU,EACV,SAAS,EACT,UAAU,GACb,EAAE;QACC,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;QAC1C,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;KACxD,EACD,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,WAAW,CAAC;IAkCvB;;;;;;;;;;;;OAYG;IACG,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;IASxE;;;;;;;;;;;;OAYG;IACG,IAAI,CACN,EACI,UAAU,EACV,MAAM,EACN,QAAQ,EACR,aAAa,EACb,WAAW,EACX,YAAY,EACZ,QAAQ,EACR,MAAM,EACN,OAAO,EACP,OAAO,EACP,WAAW,EACX,WAAW,EACX,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACN,KAAK,EACL,KAAU,EACV,KAAc,GACjB,GAAE;QACC,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,OAAO,GAAG,mBAAmB,GAAG,WAAW,CAAC;QAC3F,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,aAAa,CAAC,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,OAAO,GAAG,mBAAmB,GAAG,WAAW,CAAC;QAClG,WAAW,CAAC,EAAE,QAAQ,GAAG,KAAK,GAAG,UAAU,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;QAC9E,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;KACrB,EACN,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,aAAa,CAAC;IAoCzB;;;;;;;;;;OAUG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IASpE;;;;;;;;;;;;;OAaG;IACG,MAAM,CACR,KAAK,EAAE,MAAM,EACb,EAAE,SAAS,EAAE,GAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO,EAC1C,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,sBAAsB,CAAC;IAclC;;;;;;;;;;;;;OAaG;IACG,OAAO,CACT,KAAK,EAAE,MAAM,EACb,EAAE,SAAS,EAAE,GAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO,EAC1C,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,WAAW,CAAC;IAcvB;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,MAAM,CACR,KAAK,EAAE,MAAM,EACb,EACI,MAAM,EACN,QAAQ,EACR,YAAY,EACZ,SAAS,GACZ,EAAE;QACC,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,OAAO,CAAC;QAClB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;QAC9C,SAAS,CAAC,EAAE,MAAM,CAAC;KACtB,EACD,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,sBAAsB,CAAC;IAkBlC;;;;;;;;;;;;;;;;;;;OAmBG;IACG,iBAAiB,CACnB,KAAK,EAAE,MAAM,EACb,EACI,cAAqB,EACrB,SAAkB,GACrB,GAAE;QACC,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,SAAS,CAAC,EAAE,MAAM,CAAC;KACjB,GACP,OAAO,CAAC,WAAW,CAAC;IAuBvB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,aAAa,CACf,EACI,UAAU,EACV,SAAS,EACT,UAAU,EACV,cAAqB,EACrB,SAAkB,GACrB,EAAE;QACC,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;QAC1C,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QACrD,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,SAAS,CAAC,EAAE,MAAM,CAAC;KACtB,EACD,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,WAAW,CAAC;CAO1B"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/api/workflows/runs/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACvE,OAAO,EACH,aAAa,EAEb,WAAW,EAEX,aAAa,EAEb,sBAAsB,EAEtB,sBAAsB,EAEtB,yBAAyB,EAEzB,iBAAiB,EACjB,sBAAsB,EACzB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,mBAAmB,MAAM,mBAAmB,CAAC;AAyBpD;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,iBAAiB;IACnD,KAAK,EAAE,mBAAmB,CAAC;gBAEtB,MAAM,EAAE,iBAAiB;IAKrC;;;;;;;;;;;;;;OAcG;IACG,MAAM,CACR,EACI,UAAU,EACV,SAAS,EACT,UAAU,GACb,EAAE;QACC,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;QAC1C,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;KACxD,EACD,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,WAAW,CAAC;IAkCvB;;OAEG;IACG,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;IASxE;;OAEG;IACG,IAAI,CACN,EACI,UAAU,EACV,MAAM,EACN,QAAQ,EACR,aAAa,EACb,WAAW,EACX,YAAY,EACZ,QAAQ,EACR,MAAM,EACN,OAAO,EACP,OAAO,EACP,WAAW,EACX,WAAW,EACX,MAAM,EACN,MAAM,EACN,MAAM,EACN,MAAM,EACN,KAAK,EACL,KAAU,EACV,KAAc,GACjB,GAAE;QACC,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,MAAM,CAAC,EAAE,iBAAiB,CAAC;QAC3B,QAAQ,CAAC,EAAE,iBAAiB,EAAE,GAAG,MAAM,CAAC;QACxC,aAAa,CAAC,EAAE,iBAAiB,CAAC;QAClC,WAAW,CAAC,EAAE,sBAAsB,CAAC;QACrC,YAAY,CAAC,EAAE,sBAAsB,EAAE,GAAG,MAAM,CAAC;QACjD,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;KACrB,EACN,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,aAAa,CAAC;IAoCzB;;OAEG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IASpE;;OAEG;IACG,MAAM,CACR,KAAK,EAAE,MAAM,EACb,EAAE,SAAS,EAAE,GAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO,EAC1C,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,sBAAsB,CAAC;IAclC;;OAEG;IACG,OAAO,CACT,KAAK,EAAE,MAAM,EACb,EAAE,SAAS,EAAE,GAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO,EAC1C,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,WAAW,CAAC;IAcvB;;OAEG;IACG,MAAM,CACR,KAAK,EAAE,MAAM,EACb,EACI,MAAM,EACN,QAAQ,EACR,YAAY,EACZ,SAAS,GACZ,EAAE;QACC,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,OAAO,CAAC;QAClB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;QAC9C,SAAS,CAAC,EAAE,MAAM,CAAC;KACtB,EACD,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,sBAAsB,CAAC;IAkBlC;;;;;;;;;;;;;;;;OAgBG;IACG,iBAAiB,CACnB,KAAK,EAAE,MAAM,EACb,EACI,cAAqB,EACrB,SAAkB,EAClB,QAAQ,GACX,GAAE;QACC,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;KACpD,GACP,OAAO,CAAC,WAAW,CAAC;IAyBjB,mBAAmB,CACrB,KAAK,EAAE,MAAM,EACb,EACI,gBAAuB,EACvB,UAAmB,EACnB,SAAS,GACZ,GAAE;QACC,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;KACrD,GACP,OAAO,CAAC,WAAW,CAAC;IAQvB;;;;;;;;;;;;;;;OAeG;IACG,aAAa,CACf,EACI,UAAU,EACV,SAAS,EACT,UAAU,EACV,cAAqB,EACrB,SAAkB,EAClB,QAAQ,GACX,EAAE;QACC,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;QAC1C,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;QACrD,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;KACzD,EACD,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,WAAW,CAAC;IAQvB;;OAEG;IACG,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAS1F;;OAEG;IACG,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAS/F;;OAEG;IACG,cAAc,CAChB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IASnC;;;;OAIG;IACG,MAAM,CACR,EACI,UAAU,EACV,MAAM,EACN,YAAwB,EACxB,cAAc,EACd,MAAM,EACN,aAAa,EACb,QAAQ,EACR,MAAM,EACN,YAAY,EACZ,gBAAgB,GACnB,EAAE;QACC,UAAU,EAAE,MAAM,CAAC;QACnB,MAAM,EAAE,MAAM,CAAC;QACf,YAAY,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;QACpC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;QAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,YAAY,CAAC,EAAE,sBAAsB,EAAE,CAAC;QACxC,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;KAC/B,EACD,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,yBAAyB,CAAC;CAuBxC"}

package/dist/api/workflows/runs/client.js

@@ -1,7 +1,23 @@
+import * as z from "zod";
 import { CompositionClient } from "../../../client.js";
-import { ZMIMEData, ZWorkflowRun, ZPaginatedList, ZCancelWorkflowResponse, ZResumeWorkflowResponse, } from "../../../types.js";
+import { ZMIMEData, ZWorkflowRun, ZPaginatedList, ZCancelWorkflowResponse, ZResumeWorkflowResponse, ZWorkflowRunExportResponse, } from "../../../types.js";
 import APIWorkflowRunSteps from "./steps/client.js";
 const TERMINAL_STATUSES = new Set(["completed", "error", "cancelled"]);
+function normalizeCsvParam(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    return Array.isArray(value) ? value.join(",") : value;
+}
+function normalizeDateParam(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value instanceof Date) {
+        return value.toISOString().slice(0, 10);
+    }
+    return value;
+}
 function sleep(ms) {
     return new Promise((resolve) => setTimeout(resolve, ms));
 }
@@ -9,7 +25,7 @@ function sleep(ms) {
  * Workflow Runs API client for managing workflow executions.
  *
  * Sub-clients:
- * - steps: Step output operations (get, list)
+ * - steps: Step output operations (get, list, getMany, getAll)
  */
 export default class APIWorkflowRuns extends CompositionClient {
     constructor(client) {
@@ -23,24 +39,12 @@ export default class APIWorkflowRuns extends CompositionClient {
      * The returned WorkflowRun will have status "running" - use get()
      * to check for updates on the run status.
      *
-     * @param workflowId - The ID of the workflow to run
-     * @param documents - Mapping of start node IDs to their input documents
-     * @param jsonInputs - Mapping of start_json node IDs to their input JSON data
-     * @param options - Optional request options
-     * @returns The created workflow run with status "running"
-     *
      * @example
      * ```typescript
      * const run = await client.workflows.runs.create({
      *     workflowId: "wf_abc123",
-     *     documents: {
-     *         "start-node-1": "./invoice.pdf",
-     *     },
-     *     jsonInputs: {
-     *         "json-node-1": { key: "value" },
-     *     },
+     *     documents: { "start-node-1": "./invoice.pdf" },
      * });
-     * console.log(`Run started: ${run.id}, status: ${run.status}`);
      * ```
      */
     async create({ workflowId, documents, jsonInputs, }, options) {
@@ -73,16 +77,6 @@ export default class APIWorkflowRuns extends CompositionClient {
     }
     /**
      * Get a workflow run by ID.
-     *
-     * @param runId - The ID of the workflow run to retrieve
-     * @param options - Optional request options
-     * @returns The workflow run
-     *
-     * @example
-     * ```typescript
-     * const run = await client.workflows.runs.get("run_abc123");
-     * console.log(`Run status: ${run.status}`);
-     * ```
      */
     async get(runId, options) {
         return this._fetchJson(ZWorkflowRun, {
@@ -94,35 +88,25 @@ export default class APIWorkflowRuns extends CompositionClient {
     }
     /**
      * List workflow runs with filtering and pagination.
-     *
-     * @example
-     * ```typescript
-     * const runs = await client.workflows.runs.list({
-     *     workflowId: "wf_abc123",
-     *     status: "completed",
-     *     limit: 10,
-     * });
-     * console.log(`Found ${runs.data.length} runs`);
-     * ```
      */
     async list({ workflowId, status, statuses, excludeStatus, triggerType, triggerTypes, fromDate, toDate, minCost, maxCost, minDuration, maxDuration, search, sortBy, fields, before, after, limit = 20, order = "desc", } = {}, options) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const params = {
             workflow_id: workflowId,
             status,
-            statuses,
+            statuses: normalizeCsvParam(statuses),
             exclude_status: excludeStatus,
             trigger_type: triggerType,
-            trigger_types: triggerTypes,
-            from_date: fromDate,
-            to_date: toDate,
+            trigger_types: normalizeCsvParam(triggerTypes),
+            from_date: normalizeDateParam(fromDate),
+            to_date: normalizeDateParam(toDate),
             min_cost: minCost,
             max_cost: maxCost,
             min_duration: minDuration,
             max_duration: maxDuration,
             search,
             sort_by: sortBy,
-            fields,
+            fields: normalizeCsvParam(fields),
             before,
             after,
             limit,
@@ -138,14 +122,6 @@ export default class APIWorkflowRuns extends CompositionClient {
     }
     /**
      * Delete a workflow run and its associated step data.
-     *
-     * @param runId - The ID of the workflow run to delete
-     * @param options - Optional request options
-     *
-     * @example
-     * ```typescript
-     * await client.workflows.runs.delete("run_abc123");
-     * ```
      */
     async delete(runId, options) {
         return this._fetchJson({
@@ -157,17 +133,6 @@ export default class APIWorkflowRuns extends CompositionClient {
     }
     /**
      * Cancel a running or pending workflow run.
-     *
-     * @param runId - The ID of the workflow run to cancel
-     * @param commandId - Optional idempotency key for deduplicating cancel commands
-     * @param options - Optional request options
-     * @returns The updated run with cancellation status
-     *
-     * @example
-     * ```typescript
-     * const result = await client.workflows.runs.cancel("run_abc123");
-     * console.log(`Cancellation: ${result.cancellation_status}`);
-     * ```
      */
     async cancel(runId, { commandId } = {}, options) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -184,17 +149,6 @@ export default class APIWorkflowRuns extends CompositionClient {
     }
     /**
      * Restart a completed or failed workflow run with the same inputs.
-     *
-     * @param runId - The ID of the workflow run to restart
-     * @param commandId - Optional idempotency key for deduplicating restart commands
-     * @param options - Optional request options
-     * @returns The new workflow run
-     *
-     * @example
-     * ```typescript
-     * const newRun = await client.workflows.runs.restart("run_abc123");
-     * console.log(`New run: ${newRun.id}`);
-     * ```
      */
     async restart(runId, { commandId } = {}, options) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -211,24 +165,6 @@ export default class APIWorkflowRuns extends CompositionClient {
     }
     /**
      * Resume a workflow run after human-in-the-loop (HIL) review.
-     *
-     * @param runId - The ID of the workflow run to resume
-     * @param nodeId - The ID of the HIL node being approved/rejected
-     * @param approved - Whether the human approved the data
-     * @param modifiedData - Optional modified data if the human made changes
-     * @param commandId - Optional idempotency key for deduplicating resume commands
-     * @param options - Optional request options
-     * @returns The resume response with status and queue information
-     *
-     * @example
-     * ```typescript
-     * const result = await client.workflows.runs.resume("run_abc123", {
-     *     nodeId: "hil-node-1",
-     *     approved: true,
-     *     modifiedData: { field: "corrected value" },
-     * });
-     * console.log(`Resume status: ${result.resume_status}`);
-     * ```
      */
     async resume(runId, { nodeId, approved, modifiedData, commandId, }, options) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -251,24 +187,21 @@ export default class APIWorkflowRuns extends CompositionClient {
     /**
      * Poll a workflow run until it reaches a terminal state.
      *
-     * Terminal states: "completed", "error", "cancelled".
+     * Terminal states: "completed", "error", "cancelled", "waiting_for_human".
      *
      * @param runId - The ID of the workflow run to wait for
      * @param pollIntervalMs - Milliseconds between polls (default: 2000)
      * @param timeoutMs - Maximum time to wait in milliseconds (default: 600000 = 10 minutes)
-     * @returns The workflow run in a terminal state
-     * @throws Error if the run doesn't complete within the timeout
+     * @param onStatus - Optional callback invoked with the WorkflowRun on each poll
      *
      * @example
      * ```typescript
      * const run = await client.workflows.runs.waitForCompletion("run_abc123", {
-     *     pollIntervalMs: 1000,
-     *     timeoutMs: 300000,
+     *     onStatus: (r) => console.log(`${r.status}...`),
      * });
-     * console.log(`Final status: ${run.status}`);
      * ```
      */
-    async waitForCompletion(runId, { pollIntervalMs = 2000, timeoutMs = 600000, } = {}) {
+    async waitForCompletion(runId, { pollIntervalMs = 2000, timeoutMs = 600000, onStatus, } = {}) {
         if (pollIntervalMs <= 0)
             throw new Error("pollIntervalMs must be positive");
         if (timeoutMs <= 0)
@@ -276,7 +209,9 @@ export default class APIWorkflowRuns extends CompositionClient {
         const deadline = Date.now() + timeoutMs;
         while (true) {
             const run = await this.get(runId);
-            if (TERMINAL_STATUSES.has(run.status)) {
+            if (onStatus)
+                await onStatus(run);
+            if (TERMINAL_STATUSES.has(run.status) || run.status === "waiting_for_human") {
                 return run;
             }
             if (Date.now() >= deadline) {
@@ -285,33 +220,97 @@ export default class APIWorkflowRuns extends CompositionClient {
             await sleep(pollIntervalMs);
         }
     }
+    async wait_for_completion(runId, { poll_interval_ms = 2000, timeout_ms = 600000, on_status, } = {}) {
+        return this.waitForCompletion(runId, {
+            pollIntervalMs: poll_interval_ms,
+            timeoutMs: timeout_ms,
+            onStatus: on_status,
+        });
+    }
     /**
      * Create a workflow run and wait for it to complete.
      *
-     * Convenience method that combines create() and waitForCompletion().
-     *
-     * @param workflowId - The ID of the workflow to run
-     * @param documents - Mapping of start node IDs to their input documents
-     * @param jsonInputs - Mapping of start_json node IDs to their input JSON data
-     * @param pollIntervalMs - Milliseconds between polls (default: 2000)
-     * @param timeoutMs - Maximum time to wait in milliseconds (default: 600000)
-     * @param options - Optional request options
-     * @returns The workflow run in a terminal state
-     *
      * @example
      * ```typescript
+     * import { raiseForStatus } from "retab";
+     *
      * const run = await client.workflows.runs.createAndWait({
      *     workflowId: "wf_abc123",
      *     documents: { "start-node-1": "./invoice.pdf" },
-     *     timeoutMs: 120000,
+     *     onStatus: (r) => console.log(`${r.status}...`),
      * });
-     * if (run.status === "completed") {
-     *     console.log("Outputs:", run.final_outputs);
-     * }
+     * raiseForStatus(run);
+     * console.log(run.final_outputs);
      * ```
      */
-    async createAndWait({ workflowId, documents, jsonInputs, pollIntervalMs = 2000, timeoutMs = 600000, }, options) {
+    async createAndWait({ workflowId, documents, jsonInputs, pollIntervalMs = 2000, timeoutMs = 600000, onStatus, }, options) {
         const run = await this.create({ workflowId, documents, jsonInputs }, options);
-        return this.waitForCompletion(run.id, { pollIntervalMs, timeoutMs });
+        return this.waitForCompletion(run.id, { pollIntervalMs, timeoutMs, onStatus });
+    }
+    /**
+     * Get the configuration snapshot used for a run.
+     */
+    async getConfig(runId, options) {
+        return this._fetchJson(z.record(z.any()), {
+            url: `/workflows/runs/${runId}/config`,
+            method: "GET",
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
+    /**
+     * Get the DAG-ordered execution order for a run.
+     */
+    async executionOrder(runId, options) {
+        return this._fetchJson(z.record(z.any()), {
+            url: `/workflows/runs/${runId}/execution-order`,
+            method: "GET",
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
+    /**
+     * Get a signed URL for downloading a document from a run step.
+     */
+    async getDocumentUrl(runId, nodeId, options) {
+        return this._fetchJson(z.record(z.any()), {
+            url: `/workflows/runs/${runId}/documents/${nodeId}`,
+            method: "GET",
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
+    /**
+     * Export run results as structured CSV data.
+     *
+     * @returns Object with `csv_data` (string), `rows` (number), `columns` (number)
+     */
+    async export({ workflowId, nodeId, exportSource = "outputs", selectedRunIds, status, excludeStatus, fromDate, toDate, triggerTypes, preferredColumns, }, options) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const body = {
+            workflow_id: workflowId,
+            node_id: nodeId,
+            export_source: exportSource,
+            preferred_columns: preferredColumns || [],
+        };
+        if (selectedRunIds !== undefined)
+            body.selected_run_ids = selectedRunIds;
+        if (status !== undefined)
+            body.status = status;
+        if (excludeStatus !== undefined)
+            body.exclude_status = excludeStatus;
+        if (fromDate !== undefined)
+            body.from_date = normalizeDateParam(fromDate);
+        if (toDate !== undefined)
+            body.to_date = normalizeDateParam(toDate);
+        if (triggerTypes !== undefined)
+            body.trigger_types = triggerTypes;
+        return this._fetchJson(ZWorkflowRunExportResponse, {
+            url: "/workflows/runs/export_payload",
+            method: "POST",
+            body: { ...body, ...(options?.body || {}) },
+            params: options?.params,
+            headers: options?.headers,
+        });
     }
 }