@upstash/workflow 0.2.3 → 0.2.4

package/{types-R9q4MUwl.d.ts → types-Bt4-paRy.d.ts}

@@ -63,10 +63,11 @@ declare class AutoExecutor {
     private readonly nonPlanStepCount;
     private readonly steps;
     private indexInCurrentList;
+    private telemetry?;
     stepCount: number;
     planStepCount: number;
     protected executingStep: string | false;
-    constructor(context: WorkflowContext, steps: Step[], debug?: WorkflowLogger);
+    constructor(context: WorkflowContext, steps: Step[], telemetry?: Telemetry, debug?: WorkflowLogger);
     /**
      * Adds the step function to the list of step functions to run in
      * parallel. After adding the function, defers the execution, so
@@ -512,7 +513,7 @@ declare class WorkflowContext<TInitialPayload = unknown> {
      * Number of retries
      */
     readonly retries: number;
-    constructor({ qstashClient, workflowRunId, headers, steps, url, failureUrl, debug, initialPayload, env, retries, }: {
+    constructor({ qstashClient, workflowRunId, headers, steps, url, failureUrl, debug, initialPayload, env, retries, telemetry, }: {
         qstashClient: WorkflowClient;
         workflowRunId: string;
         headers: Headers;
@@ -523,6 +524,7 @@ declare class WorkflowContext<TInitialPayload = unknown> {
         initialPayload: TInitialPayload;
         env?: Record<string, string | undefined>;
         retries?: number;
+        telemetry?: Telemetry;
     });
     /**
      * Executes a workflow step
@@ -838,7 +840,7 @@ type WorkflowServeOptions<TResponse extends Response = Response, TInitialPayload
      * @returns void
      */
     failureFunction?: (failureData: {
-        context: Omit<WorkflowContext<TInitialPayload>, "run" | "sleepUntil" | "sleep" | "call" | "waitForEvent" | "notify">;
+        context: Omit<WorkflowContext<TInitialPayload>, "run" | "sleepUntil" | "sleep" | "call" | "waitForEvent" | "notify" | "cancel" | "api">;
         failStatus: number;
         failResponse: string;
         failHeaders: Record<string, string[]>;
@@ -876,6 +878,26 @@ type WorkflowServeOptions<TResponse extends Response = Response, TInitialPayload
      * Not part of the public API. Only available in serveBase, which is not exported.
      */
     useJSONContent?: boolean;
+    /**
+     * By default, Workflow SDK sends telemetry about SDK version, framework or runtime.
+     *
+     * Set `disableTelemetry` to disable this behavior.
+     */
+    disableTelemetry?: boolean;
+};
+type Telemetry = {
+    /**
+     * sdk version
+     */
+    sdk: string;
+    /**
+     * platform (such as nextjs/cloudflare)
+     */
+    framework: string;
+    /**
+     * node version
+     */
+    runtime?: string;
 };
 type PublicServeOptions<TInitialPayload = unknown, TResponse extends Response = Response> = Omit<WorkflowServeOptions<TResponse, TInitialPayload>, "onStepFinish" | "useJSONContent">;
 /**
@@ -971,5 +993,68 @@ type CallSettings<TBody = unknown> = {
     retries?: number;
     timeout?: Duration | number;
 };
+type HeaderParams = {
+    /**
+     * whether the request is a first invocation request.
+     */
+    initHeaderValue: "true" | "false";
+    /**
+     * run id of the workflow
+     */
+    workflowRunId: string;
+    /**
+     * url where the workflow is hosted
+     */
+    workflowUrl: string;
+    /**
+     * user headers which will be forwarded in the request
+     */
+    userHeaders?: Headers;
+    /**
+     * failure url to call incase of failure
+     */
+    failureUrl?: WorkflowServeOptions["failureUrl"];
+    /**
+     * retry setting of requests except context.call
+     */
+    retries?: number;
+    /**
+     * telemetry to include in timeoutHeaders.
+     *
+     * Only needed/used when the step is a waitForEvent step
+     */
+    telemetry?: Telemetry;
+} & ({
+    /**
+     * step to generate headers for
+     */
+    step: Step;
+    /**
+     * number of retries in context.call
+     */
+    callRetries?: number;
+    /**
+     * timeout duration in context.call
+     */
+    callTimeout?: number | Duration;
+} | {
+    /**
+     * step not passed. Either first invocation or simply getting headers for
+     * third party callack.
+     */
+    step?: never;
+    /**
+     * number of retries in context.call
+     *
+     * set to never because this is not a context.call step
+     */
+    callRetries?: never;
+    /**
+     * timeout duration in context.call
+     *
+     * set to never because this is not a context.call step
+     */
+    callTimeout?: never;
+});
 
-export { type AsyncStepFunction as A, type CallResponse as C, type Duration as D, type FinishCondition as F, type LogLevel as L, type NotifyResponse as N, type ParallelCallState as P, type RouteFunction as R, type Step as S, type WorkflowServeOptions as W, type Waiter as a, WorkflowContext as b, type WorkflowClient as c, type WorkflowReceiver as d, StepTypes as e, type StepType as f, type RawStep as g, type SyncStepFunction as h, type StepFunction as i, type PublicServeOptions as j, type FailureFunctionPayload as k, type RequiredExceptFields as l, type WaitRequest as m, type WaitStepResponse as n, type NotifyStepResponse as o, type WaitEventOptions as p, type CallSettings as q, type WorkflowLoggerOptions as r, WorkflowLogger as s };
+export { type AsyncStepFunction as A, type CallResponse as C, type Duration as D, type FinishCondition as F, type HeaderParams as H, type LogLevel as L, type NotifyResponse as N, type ParallelCallState as P, type RouteFunction as R, type Step as S, type Telemetry as T, type WorkflowServeOptions as W, type Waiter as a, WorkflowContext as b, type WorkflowClient as c, type WorkflowReceiver as d, StepTypes as e, type StepType as f, type RawStep as g, type SyncStepFunction as h, type StepFunction as i, type PublicServeOptions as j, type FailureFunctionPayload as k, type RequiredExceptFields as l, type WaitRequest as m, type WaitStepResponse as n, type NotifyStepResponse as o, type WaitEventOptions as p, type CallSettings as q, type WorkflowLoggerOptions as r, WorkflowLogger as s };