@upstash/workflow 0.2.7 → 0.2.8

package/index.d.mts

@@ -1,6 +1,6 @@
-import { R as RouteFunction, W as WorkflowServeOptions, E as ExclusiveValidationOptions, N as NotifyResponse, a as Waiter, S as Step } from './types-Cuqlx2Cr.mjs';
-export { A as AsyncStepFunction, C as CallResponse, q as CallSettings, D as Duration, k as FailureFunctionPayload, F as FinishCondition, H as HeaderParams, L as LogLevel, o as NotifyStepResponse, P as ParallelCallState, j as PublicServeOptions, g as RawStep, l as RequiredExceptFields, i as StepFunction, f as StepType, e as StepTypes, h as SyncStepFunction, T as Telemetry, p as WaitEventOptions, m as WaitRequest, n as WaitStepResponse, c as WorkflowClient, b as WorkflowContext, s as WorkflowLogger, r as WorkflowLoggerOptions, d as WorkflowReceiver } from './types-Cuqlx2Cr.mjs';
-import { Client as Client$1, QstashError } from '@upstash/qstash';
+import { R as RouteFunction, W as WorkflowServeOptions, E as ExclusiveValidationOptions, S as StepType, a as RawStep, N as NotifyResponse, b as Waiter, c as Step } from './types-B62AnIU3.mjs';
+export { A as AsyncStepFunction, C as CallResponse, r as CallSettings, D as Duration, l as FailureFunctionPayload, F as FinishCondition, H as HeaderParams, L as LogLevel, p as NotifyStepResponse, P as ParallelCallState, k as PublicServeOptions, m as RequiredExceptFields, j as StepFunction, h as StepTypes, i as SyncStepFunction, T as Telemetry, q as WaitEventOptions, n as WaitRequest, o as WaitStepResponse, f as WorkflowClient, e as WorkflowContext, t as WorkflowLogger, s as WorkflowLoggerOptions, g as WorkflowReceiver, d as WorkflowTool } from './types-B62AnIU3.mjs';
+import { HTTPMethods, State, Client as Client$1, QstashError } from '@upstash/qstash';
 import 'zod';
 import 'ai';
 import '@ai-sdk/openai';
@@ -17,6 +17,233 @@ declare const serve: <TInitialPayload = unknown, TRequest extends Request = Requ
     handler: (request: TRequest) => Promise<TResponse>;
 };
 
+type BaseStepLog = {
+    /**
+     * id of the step
+     */
+    stepId?: number;
+    /**
+     * name of the step
+     */
+    stepName: string;
+    /**
+     * type of the step (example: "call", "wait", "invoke")
+     */
+    stepType: StepType;
+    /**
+     * call type of the step.
+     *
+     * in most cases it's `step`. For context.call, it will become `toCallback` and `fromCallback`
+     * as the step executes.
+     */
+    callType: RawStep["callType"];
+    /**
+     * message id of the step
+     */
+    messageId: string;
+    /**
+     * result of the step
+     *
+     * will be undefined for an unfinished parallel step.
+     */
+    out: unknown;
+    /**
+     * number of parallel steps
+     *
+     * if the step is sequential (non-parallel), will be 1.
+     */
+    concurrent: number;
+    /**
+     * state of the step
+     */
+    state: "STEP_PROGRESS" | "STEP_SUCCESS" | "STEP_RETRY" | "STEP_FAILED";
+    /**
+     * time when the step was created
+     */
+    createdAt: number;
+    /**
+     * headers
+     */
+    headers: Record<string, string[]>;
+};
+type CallUrlGroup = {
+    /**
+     * URL called in context.call
+     */
+    callUrl: string;
+    /**
+     * Method used in context.call
+     */
+    callMethod: HTTPMethods;
+    /**
+     * headers sent in context.call
+     */
+    callHeaders: Record<string, string[]>;
+    /**
+     * Body sent in context.call
+    */
+    callBody: unknown;
+};
+type CallResponseStatusGroup = {
+    /**
+     * Status code of the context.call response
+     */
+    callResponseStatus: number;
+    /**
+     * Response body of the context.call response
+     */
+    callResponseBody: unknown;
+    /**
+     * Headers received from the context.call response
+     */
+    callResponseHeaders: Record<string, string[]>;
+} & CallUrlGroup;
+type InvokedWorkflowGroup = {
+    /**
+     * id of the workflow run invoked in context.invoke
+     */
+    invokedWorkflowRunId: string;
+    /**
+     * URL of the workflow invoked in context.invoke
+     */
+    invokedWorkflowUrl: string;
+    /**
+     * Time when the workflow was invoked
+     */
+    invokedWorkflowCreatedAt: number;
+    /**
+     * Body sent in context.invoke
+     */
+    invokedWorkflowRunBody: unknown;
+    /**
+     * Headers sent in context.invoke
+     */
+    invokedWorkflowRunHeaders: Record<string, string[]>;
+};
+type WaitEventGroup = {
+    /**
+     * id of the event waited in context.waitForEvent
+     */
+    waitEventId: string;
+    /**
+     * Duration until the time when the event will be triggered due to timeout
+     */
+    waitTimeoutDuration: string;
+    /**
+     * Time when the event will be triggered due to timeout
+     */
+    waitTimeoutDeadline: number;
+    /**
+     * Whether the event was triggered due to timeout
+     */
+    waitTimeout: boolean;
+};
+type AsOptional<TType> = TType | {
+    [P in keyof TType]?: never;
+};
+type StepLog = BaseStepLog & AsOptional<CallUrlGroup> & AsOptional<CallResponseStatusGroup> & AsOptional<InvokedWorkflowGroup> & AsOptional<WaitEventGroup>;
+type StepLogGroup = {
+    /**
+     * Log which belongs to a single step
+     */
+    steps: [StepLog];
+    /**
+     * Log which belongs to a single step
+     */
+    type: "sequential";
+} | {
+    /**
+     * Log which belongs to parallel steps
+     */
+    steps: StepLog[];
+    /**
+     * Log which belongs to parallel steps
+     */
+    type: "parallel";
+} | {
+    /**
+     * Log which belongs to the next step
+     */
+    steps: {
+        messageId: string;
+        state: "STEP_PROGRESS" | "STEP_RETRY" | "STEP_FAILED";
+    }[];
+    /**
+     * Log which belongs to the next step
+     */
+    type: "next";
+};
+type FailureFunctionLog = {
+    /**
+     * messageId of the message published for handling the failure
+     */
+    messageId: string;
+    /**
+     * URL of the function that handles the failure
+     */
+    url: string;
+    /**
+     * State of the message published for failure
+     */
+    state: State;
+    /**
+     * Headers received from the step which caused the workflow to fail
+     */
+    failHeaders: Record<string, string[]>;
+    /**
+     * Status code of the step which caused the workflow to fail
+     */
+    failStatus: number;
+    /**
+     * Response body of the step which caused the workflow to fail
+     */
+    failResponse: string;
+    dlqId: string;
+};
+type WorkflowRunLog = {
+    /**
+     * Unique identifier for the workflow run
+     */
+    workflowRunId: string;
+    /**
+     * URL of the workflow that was run
+     */
+    workflowUrl: string;
+    /**
+     * State of the workflow run
+     *
+     * - RUN_STARTED: Workflow run has started and is in progress
+     * - RUN_SUCCESS: Workflow run has completed successfully
+     * - RUN_FAILED: Workflow run has failed
+     */
+    workflowState: "RUN_STARTED" | "RUN_SUCCESS" | "RUN_FAILED" | "RUN_CANCELED";
+    /**
+     * Time when the workflow run was created
+     *
+     * in unix milliseconds format
+     */
+    workflowRunCreatedAt: number;
+    /**
+     * Time when the workflow run was completed
+     *
+     * in unix milliseconds format
+     */
+    workflowRunCompletedAt?: number;
+    /**
+     * Message published when the workflow fails if failureUrl or failureFunction
+     * are set.
+     */
+    failureFunction?: FailureFunctionLog;
+    /**
+     *
+     */
+    steps: StepLogGroup[];
+};
+type WorkflowRunLogs = {
+    cursor: string;
+    runs: WorkflowRunLog[];
+};
+
 type ClientConfig = ConstructorParameters<typeof Client$1>[0];
 /**
  * Workflow client for canceling & notifying workflows and getting waiters of an
@@ -164,6 +391,41 @@ declare class Client {
     }): Promise<{
         workflowRunId: string;
     }>;
+    /**
+      * Fetches logs for workflow runs.
+      *
+      * @param workflowRunId - The ID of the workflow run to fetch logs for.
+      * @param cursor - The cursor for pagination.
+      * @param count - Number of runs to fetch. Default value is 10.
+      * @param state - The state of the workflow run.
+      * @param workflowUrl - The URL of the workflow. Should be an exact match.
+      * @param workflowCreatedAt - The creation time of the workflow. If you have two workflow runs with the same URL, you can use this to filter them.
+      * @returns A promise that resolves to either a `WorkflowRunLog` or a `WorkflowRunResponse`.
+      *
+      * @example
+      * Fetch logs for a specific workflow run:
+      * ```typescript
+      * const { runs } = await client.logs({ workflowRunId: '12345' });
+      * const steps = runs[0].steps; // access steps
+      * ```
+      *
+      * @example
+      * Fetch logs with pagination:
+      * ```typescript
+      * const { runs, cursor } = await client.logs();
+      * const steps = runs[0].steps // access steps
+      *
+      * const { runs: nextRuns, cursor: nextCursor } = await client.logs({ cursor, count: 2 });
+      * ```
+      */
+    logs(params?: {
+        workflowRunId?: WorkflowRunLog["workflowRunId"];
+        cursor?: string;
+        count?: number;
+        state?: WorkflowRunLog["workflowState"];
+        workflowUrl?: WorkflowRunLog["workflowUrl"];
+        workflowCreatedAt?: WorkflowRunLog["workflowRunCreatedAt"];
+    }): Promise<WorkflowRunLogs>;
 }
 
 /**
@@ -192,4 +454,4 @@ declare class WorkflowAbort extends Error {
     constructor(stepName: string, stepInfo?: Step, cancelWorkflow?: boolean);
 }
 
-export { Client, ExclusiveValidationOptions, NotifyResponse, RouteFunction, Step, Waiter, WorkflowAbort, WorkflowError, WorkflowServeOptions, serve };
+export { Client, ExclusiveValidationOptions, NotifyResponse, RawStep, RouteFunction, Step, type StepLog, StepType, Waiter, WorkflowAbort, WorkflowError, type WorkflowRunLog, type WorkflowRunLogs, WorkflowServeOptions, serve };

package/index.d.ts

@@ -1,6 +1,6 @@
-import { R as RouteFunction, W as WorkflowServeOptions, E as ExclusiveValidationOptions, N as NotifyResponse, a as Waiter, S as Step } from './types-Cuqlx2Cr.js';
-export { A as AsyncStepFunction, C as CallResponse, q as CallSettings, D as Duration, k as FailureFunctionPayload, F as FinishCondition, H as HeaderParams, L as LogLevel, o as NotifyStepResponse, P as ParallelCallState, j as PublicServeOptions, g as RawStep, l as RequiredExceptFields, i as StepFunction, f as StepType, e as StepTypes, h as SyncStepFunction, T as Telemetry, p as WaitEventOptions, m as WaitRequest, n as WaitStepResponse, c as WorkflowClient, b as WorkflowContext, s as WorkflowLogger, r as WorkflowLoggerOptions, d as WorkflowReceiver } from './types-Cuqlx2Cr.js';
-import { Client as Client$1, QstashError } from '@upstash/qstash';
+import { R as RouteFunction, W as WorkflowServeOptions, E as ExclusiveValidationOptions, S as StepType, a as RawStep, N as NotifyResponse, b as Waiter, c as Step } from './types-B62AnIU3.js';
+export { A as AsyncStepFunction, C as CallResponse, r as CallSettings, D as Duration, l as FailureFunctionPayload, F as FinishCondition, H as HeaderParams, L as LogLevel, p as NotifyStepResponse, P as ParallelCallState, k as PublicServeOptions, m as RequiredExceptFields, j as StepFunction, h as StepTypes, i as SyncStepFunction, T as Telemetry, q as WaitEventOptions, n as WaitRequest, o as WaitStepResponse, f as WorkflowClient, e as WorkflowContext, t as WorkflowLogger, s as WorkflowLoggerOptions, g as WorkflowReceiver, d as WorkflowTool } from './types-B62AnIU3.js';
+import { HTTPMethods, State, Client as Client$1, QstashError } from '@upstash/qstash';
 import 'zod';
 import 'ai';
 import '@ai-sdk/openai';
@@ -17,6 +17,233 @@ declare const serve: <TInitialPayload = unknown, TRequest extends Request = Requ
     handler: (request: TRequest) => Promise<TResponse>;
 };
 
+type BaseStepLog = {
+    /**
+     * id of the step
+     */
+    stepId?: number;
+    /**
+     * name of the step
+     */
+    stepName: string;
+    /**
+     * type of the step (example: "call", "wait", "invoke")
+     */
+    stepType: StepType;
+    /**
+     * call type of the step.
+     *
+     * in most cases it's `step`. For context.call, it will become `toCallback` and `fromCallback`
+     * as the step executes.
+     */
+    callType: RawStep["callType"];
+    /**
+     * message id of the step
+     */
+    messageId: string;
+    /**
+     * result of the step
+     *
+     * will be undefined for an unfinished parallel step.
+     */
+    out: unknown;
+    /**
+     * number of parallel steps
+     *
+     * if the step is sequential (non-parallel), will be 1.
+     */
+    concurrent: number;
+    /**
+     * state of the step
+     */
+    state: "STEP_PROGRESS" | "STEP_SUCCESS" | "STEP_RETRY" | "STEP_FAILED";
+    /**
+     * time when the step was created
+     */
+    createdAt: number;
+    /**
+     * headers
+     */
+    headers: Record<string, string[]>;
+};
+type CallUrlGroup = {
+    /**
+     * URL called in context.call
+     */
+    callUrl: string;
+    /**
+     * Method used in context.call
+     */
+    callMethod: HTTPMethods;
+    /**
+     * headers sent in context.call
+     */
+    callHeaders: Record<string, string[]>;
+    /**
+     * Body sent in context.call
+    */
+    callBody: unknown;
+};
+type CallResponseStatusGroup = {
+    /**
+     * Status code of the context.call response
+     */
+    callResponseStatus: number;
+    /**
+     * Response body of the context.call response
+     */
+    callResponseBody: unknown;
+    /**
+     * Headers received from the context.call response
+     */
+    callResponseHeaders: Record<string, string[]>;
+} & CallUrlGroup;
+type InvokedWorkflowGroup = {
+    /**
+     * id of the workflow run invoked in context.invoke
+     */
+    invokedWorkflowRunId: string;
+    /**
+     * URL of the workflow invoked in context.invoke
+     */
+    invokedWorkflowUrl: string;
+    /**
+     * Time when the workflow was invoked
+     */
+    invokedWorkflowCreatedAt: number;
+    /**
+     * Body sent in context.invoke
+     */
+    invokedWorkflowRunBody: unknown;
+    /**
+     * Headers sent in context.invoke
+     */
+    invokedWorkflowRunHeaders: Record<string, string[]>;
+};
+type WaitEventGroup = {
+    /**
+     * id of the event waited in context.waitForEvent
+     */
+    waitEventId: string;
+    /**
+     * Duration until the time when the event will be triggered due to timeout
+     */
+    waitTimeoutDuration: string;
+    /**
+     * Time when the event will be triggered due to timeout
+     */
+    waitTimeoutDeadline: number;
+    /**
+     * Whether the event was triggered due to timeout
+     */
+    waitTimeout: boolean;
+};
+type AsOptional<TType> = TType | {
+    [P in keyof TType]?: never;
+};
+type StepLog = BaseStepLog & AsOptional<CallUrlGroup> & AsOptional<CallResponseStatusGroup> & AsOptional<InvokedWorkflowGroup> & AsOptional<WaitEventGroup>;
+type StepLogGroup = {
+    /**
+     * Log which belongs to a single step
+     */
+    steps: [StepLog];
+    /**
+     * Log which belongs to a single step
+     */
+    type: "sequential";
+} | {
+    /**
+     * Log which belongs to parallel steps
+     */
+    steps: StepLog[];
+    /**
+     * Log which belongs to parallel steps
+     */
+    type: "parallel";
+} | {
+    /**
+     * Log which belongs to the next step
+     */
+    steps: {
+        messageId: string;
+        state: "STEP_PROGRESS" | "STEP_RETRY" | "STEP_FAILED";
+    }[];
+    /**
+     * Log which belongs to the next step
+     */
+    type: "next";
+};
+type FailureFunctionLog = {
+    /**
+     * messageId of the message published for handling the failure
+     */
+    messageId: string;
+    /**
+     * URL of the function that handles the failure
+     */
+    url: string;
+    /**
+     * State of the message published for failure
+     */
+    state: State;
+    /**
+     * Headers received from the step which caused the workflow to fail
+     */
+    failHeaders: Record<string, string[]>;
+    /**
+     * Status code of the step which caused the workflow to fail
+     */
+    failStatus: number;
+    /**
+     * Response body of the step which caused the workflow to fail
+     */
+    failResponse: string;
+    dlqId: string;
+};
+type WorkflowRunLog = {
+    /**
+     * Unique identifier for the workflow run
+     */
+    workflowRunId: string;
+    /**
+     * URL of the workflow that was run
+     */
+    workflowUrl: string;
+    /**
+     * State of the workflow run
+     *
+     * - RUN_STARTED: Workflow run has started and is in progress
+     * - RUN_SUCCESS: Workflow run has completed successfully
+     * - RUN_FAILED: Workflow run has failed
+     */
+    workflowState: "RUN_STARTED" | "RUN_SUCCESS" | "RUN_FAILED" | "RUN_CANCELED";
+    /**
+     * Time when the workflow run was created
+     *
+     * in unix milliseconds format
+     */
+    workflowRunCreatedAt: number;
+    /**
+     * Time when the workflow run was completed
+     *
+     * in unix milliseconds format
+     */
+    workflowRunCompletedAt?: number;
+    /**
+     * Message published when the workflow fails if failureUrl or failureFunction
+     * are set.
+     */
+    failureFunction?: FailureFunctionLog;
+    /**
+     *
+     */
+    steps: StepLogGroup[];
+};
+type WorkflowRunLogs = {
+    cursor: string;
+    runs: WorkflowRunLog[];
+};
+
 type ClientConfig = ConstructorParameters<typeof Client$1>[0];
 /**
  * Workflow client for canceling & notifying workflows and getting waiters of an
@@ -164,6 +391,41 @@ declare class Client {
     }): Promise<{
         workflowRunId: string;
     }>;
+    /**
+      * Fetches logs for workflow runs.
+      *
+      * @param workflowRunId - The ID of the workflow run to fetch logs for.
+      * @param cursor - The cursor for pagination.
+      * @param count - Number of runs to fetch. Default value is 10.
+      * @param state - The state of the workflow run.
+      * @param workflowUrl - The URL of the workflow. Should be an exact match.
+      * @param workflowCreatedAt - The creation time of the workflow. If you have two workflow runs with the same URL, you can use this to filter them.
+      * @returns A promise that resolves to either a `WorkflowRunLog` or a `WorkflowRunResponse`.
+      *
+      * @example
+      * Fetch logs for a specific workflow run:
+      * ```typescript
+      * const { runs } = await client.logs({ workflowRunId: '12345' });
+      * const steps = runs[0].steps; // access steps
+      * ```
+      *
+      * @example
+      * Fetch logs with pagination:
+      * ```typescript
+      * const { runs, cursor } = await client.logs();
+      * const steps = runs[0].steps // access steps
+      *
+      * const { runs: nextRuns, cursor: nextCursor } = await client.logs({ cursor, count: 2 });
+      * ```
+      */
+    logs(params?: {
+        workflowRunId?: WorkflowRunLog["workflowRunId"];
+        cursor?: string;
+        count?: number;
+        state?: WorkflowRunLog["workflowState"];
+        workflowUrl?: WorkflowRunLog["workflowUrl"];
+        workflowCreatedAt?: WorkflowRunLog["workflowRunCreatedAt"];
+    }): Promise<WorkflowRunLogs>;
 }
 
 /**
@@ -192,4 +454,4 @@ declare class WorkflowAbort extends Error {
     constructor(stepName: string, stepInfo?: Step, cancelWorkflow?: boolean);
 }
 
-export { Client, ExclusiveValidationOptions, NotifyResponse, RouteFunction, Step, Waiter, WorkflowAbort, WorkflowError, WorkflowServeOptions, serve };
+export { Client, ExclusiveValidationOptions, NotifyResponse, RawStep, RouteFunction, Step, type StepLog, StepType, Waiter, WorkflowAbort, WorkflowError, type WorkflowRunLog, type WorkflowRunLogs, WorkflowServeOptions, serve };