@temporalio/common/lib/workflow-options.d.ts

Common library for code that's used across the Client, Worker, and/or Workflow

import type { temporal } from '@temporalio/proto';
import { SearchAttributes, Workflow } from './interfaces';
import { RetryPolicy } from './retry-policy';
import { Duration } from './time';
/**
 * Defines what happens when trying to start a Workflow with the same ID as a *Closed* Workflow.
 *
 * See {@link WorkflowOptions.workflowIdConflictPolicy} for what happens when trying to start a
 * Workflow with the same ID as a *Running* Workflow.
 *
 * Concept: {@link https://docs.temporal.io/concepts/what-is-a-workflow-id-reuse-policy/ | Workflow Id Reuse Policy}
 *
 * *Note: It is not possible to have two actively running Workflows with the same ID.*
 *
 */
export declare const WorkflowIdReusePolicy: {
    /**
     * The Workflow can be started if the previous Workflow is in a Closed state.
     * @default
     */
    readonly ALLOW_DUPLICATE: "ALLOW_DUPLICATE";
    /**
     * The Workflow can be started if the previous Workflow is in a Closed state that is not Completed.
     */
    readonly ALLOW_DUPLICATE_FAILED_ONLY: "ALLOW_DUPLICATE_FAILED_ONLY";
    /**
     * The Workflow cannot be started.
     */
    readonly REJECT_DUPLICATE: "REJECT_DUPLICATE";
    /**
     * Terminate the current Workflow if one is already running; otherwise allow reusing the Workflow ID.
     *
     * @deprecated Use {@link WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE} instead, and
     *             set `WorkflowOptions.workflowIdConflictPolicy` to
     *             {@link WorkflowIdConflictPolicy.WORKFLOW_ID_CONFLICT_POLICY_TERMINATE_EXISTING}.
     *             When using this option, `WorkflowOptions.workflowIdConflictPolicy` must be left unspecified.
     */
    readonly TERMINATE_IF_RUNNING: "TERMINATE_IF_RUNNING";
    /**
     * No need to use this. If a `WorkflowIdReusePolicy` is set to this, or is not set at all, the default value will be used.
     *
     * @deprecated Either leave property `undefined`, or use {@link ALLOW_DUPLICATE} instead.
     */
    readonly WORKFLOW_ID_REUSE_POLICY_UNSPECIFIED: undefined;
    /** @deprecated Use {@link ALLOW_DUPLICATE} instead. */
    readonly WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE: "ALLOW_DUPLICATE";
    /** @deprecated Use {@link ALLOW_DUPLICATE_FAILED_ONLY} instead. */
    readonly WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY: "ALLOW_DUPLICATE_FAILED_ONLY";
    /** @deprecated Use {@link REJECT_DUPLICATE} instead. */
    readonly WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE: "REJECT_DUPLICATE";
    /** @deprecated Use {@link TERMINATE_IF_RUNNING} instead. */
    readonly WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING: "TERMINATE_IF_RUNNING";
};
export type WorkflowIdReusePolicy = (typeof WorkflowIdReusePolicy)[keyof typeof WorkflowIdReusePolicy];
export declare const encodeWorkflowIdReusePolicy: (input: "ALLOW_DUPLICATE" | "ALLOW_DUPLICATE_FAILED_ONLY" | "REJECT_DUPLICATE" | "TERMINATE_IF_RUNNING" | "WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE" | "WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY" | "WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE" | "WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING" | temporal.api.enums.v1.WorkflowIdReusePolicy | null | undefined) => temporal.api.enums.v1.WorkflowIdReusePolicy | undefined, decodeWorkflowIdReusePolicy: (input: temporal.api.enums.v1.WorkflowIdReusePolicy | null | undefined) => "ALLOW_DUPLICATE" | "ALLOW_DUPLICATE_FAILED_ONLY" | "REJECT_DUPLICATE" | "TERMINATE_IF_RUNNING" | undefined;
/**
 * Defines what happens when trying to start a Workflow with the same ID as a *Running* Workflow.
 *
 * See {@link WorkflowOptions.workflowIdReusePolicy} for what happens when trying to start a Workflow
 * with the same ID as a *Closed* Workflow.
 *
 * *Note: It is never possible to have two _actively running_ Workflows with the same ID.*
 */
export type WorkflowIdConflictPolicy = (typeof WorkflowIdConflictPolicy)[keyof typeof WorkflowIdConflictPolicy];
export declare const WorkflowIdConflictPolicy: {
    /**
     * Do not start a new Workflow. Instead raise a `WorkflowExecutionAlreadyStartedError`.
     */
    readonly FAIL: "FAIL";
    /**
     * Do not start a new Workflow. Instead return a Workflow Handle for the already Running Workflow.
     */
    readonly USE_EXISTING: "USE_EXISTING";
    /**
     * Start a new Workflow, terminating the current workflow if one is already running.
     */
    readonly TERMINATE_EXISTING: "TERMINATE_EXISTING";
};
export declare const encodeWorkflowIdConflictPolicy: (input: "FAIL" | "USE_EXISTING" | "TERMINATE_EXISTING" | temporal.api.enums.v1.WorkflowIdConflictPolicy | "WORKFLOW_ID_CONFLICT_POLICY_FAIL" | "WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING" | "WORKFLOW_ID_CONFLICT_POLICY_TERMINATE_EXISTING" | null | undefined) => temporal.api.enums.v1.WorkflowIdConflictPolicy | undefined, decodeWorkflowIdConflictPolicy: (input: temporal.api.enums.v1.WorkflowIdConflictPolicy | null | undefined) => "FAIL" | "USE_EXISTING" | "TERMINATE_EXISTING" | undefined;
export interface BaseWorkflowOptions {
    /**
     * Defines what happens when trying to start a Workflow with the same ID as a *Closed* Workflow.
     *
     * *Note: It is not possible to have two actively running Workflows with the same ID.*
     *
     * @default {@link WorkflowIdReusePolicy.WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE}
     */
    workflowIdReusePolicy?: WorkflowIdReusePolicy;
    /**
     * Defines what happens when trying to start a Workflow with the same ID as a *Running* Workflow.
     *
     * *Note: It is not possible to have two actively running Workflows with the same ID.*
     *
     * @default {@link WorkflowIdConflictPolicy.WORKFLOW_ID_CONFLICT_POLICY_UNSPECIFIED}
     */
    workflowIdConflictPolicy?: WorkflowIdConflictPolicy;
    /**
     * Controls how a Workflow Execution is retried.
     *
     * By default, Workflow Executions are not retried. Do not override this behavior unless you know what you're doing.
     * {@link https://docs.temporal.io/concepts/what-is-a-retry-policy/ | More information}.
     */
    retry?: RetryPolicy;
    /**
     * Optional cron schedule for Workflow. If a cron schedule is specified, the Workflow will run as a cron based on the
     * schedule. The scheduling will be based on UTC time. The schedule for the next run only happens after the current
     * run is completed/failed/timeout. If a RetryPolicy is also supplied, and the Workflow failed or timed out, the
     * Workflow will be retried based on the retry policy. While the Workflow is retrying, it won't schedule its next run.
     * If the next schedule is due while the Workflow is running (or retrying), then it will skip that schedule. Cron
     * Workflow will not stop until it is terminated or cancelled (by returning temporal.CanceledError).
     * https://crontab.guru/ is useful for testing your cron expressions.
     */
    cronSchedule?: string;
    /**
     * Specifies additional non-indexed information to attach to the Workflow Execution. The values can be anything that
     * is serializable by {@link DataConverter}.
     */
    memo?: Record<string, unknown>;
    /**
     * Specifies additional indexed information to attach to the Workflow Execution. More info:
     * https://docs.temporal.io/docs/typescript/search-attributes
     *
     * Values are always converted using {@link JsonPayloadConverter}, even when a custom data converter is provided.
     */
    searchAttributes?: SearchAttributes;
}
export type WithWorkflowArgs<W extends Workflow, T> = T & (Parameters<W> extends [any, ...any[]] ? {
    /**
     * Arguments to pass to the Workflow
     */
    args: Parameters<W> | Readonly<Parameters<W>>;
} : {
    /**
     * Arguments to pass to the Workflow
     */
    args?: Parameters<W> | Readonly<Parameters<W>>;
});
export interface WorkflowDurationOptions {
    /**
     * The time after which workflow run is automatically terminated by Temporal service. Do not
     * rely on run timeout for business level timeouts. It is preferred to use in workflow timers
     * for this purpose.
     *
     * @format number of milliseconds or {@link https://www.npmjs.com/package/ms | ms-formatted string}
     */
    workflowRunTimeout?: Duration;
    /**
     *
     * The time after which workflow execution (which includes run retries and continue as new) is
     * automatically terminated by Temporal service. Do not rely on execution timeout for business
     * level timeouts. It is preferred to use in workflow timers for this purpose.
     *
     * @format number of milliseconds or {@link https://www.npmjs.com/package/ms | ms-formatted string}
     */
    workflowExecutionTimeout?: Duration;
    /**
     * Maximum execution time of a single workflow task. Default is 10 seconds.
     *
     * @format number of milliseconds or {@link https://www.npmjs.com/package/ms | ms-formatted string}
     */
    workflowTaskTimeout?: Duration;
}
export type CommonWorkflowOptions = BaseWorkflowOptions & WorkflowDurationOptions;
export declare function extractWorkflowType<T extends Workflow>(workflowTypeOrFunc: string | T): string;