@temporalio/client
Version:
Temporal.io SDK Client sub-package
298 lines (297 loc) • 15.1 kB
TypeScript
import type * as grpc from '@grpc/grpc-js';
import type { TypedSearchAttributes, SearchAttributes, SearchAttributeValue, Priority, RetryPolicy, WorkerDeploymentVersion } from '@temporalio/common';
import * as proto from '@temporalio/proto';
import type { Replace } from '@temporalio/common/lib/type-helpers';
import type { ConnectionPlugin } from './connection';
export interface WorkflowExecution {
workflowId: string;
runId?: string;
}
export type StartWorkflowExecutionRequest = proto.temporal.api.workflowservice.v1.IStartWorkflowExecutionRequest;
export type GetWorkflowExecutionHistoryRequest = proto.temporal.api.workflowservice.v1.IGetWorkflowExecutionHistoryRequest;
export type DescribeWorkflowExecutionResponse = proto.temporal.api.workflowservice.v1.IDescribeWorkflowExecutionResponse;
export type RawWorkflowExecutionInfo = proto.temporal.api.workflow.v1.IWorkflowExecutionInfo;
export type TerminateWorkflowExecutionResponse = proto.temporal.api.workflowservice.v1.ITerminateWorkflowExecutionResponse;
export type RequestCancelWorkflowExecutionResponse = proto.temporal.api.workflowservice.v1.IRequestCancelWorkflowExecutionResponse;
export type WorkflowExecutionStatusName = 'UNSPECIFIED' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' | 'TERMINATED' | 'CONTINUED_AS_NEW' | 'TIMED_OUT' | 'PAUSED' | 'UNKNOWN';
export interface WorkflowExecutionInfo {
type: string;
workflowId: string;
runId: string;
taskQueue: string;
status: {
code: proto.temporal.api.enums.v1.WorkflowExecutionStatus;
name: WorkflowExecutionStatusName;
};
historyLength: number;
/**
 * Size of Workflow history in bytes.
 *
 * This value is only available in server versions >= 1.20
 */
historySize?: number;
startTime: Date;
executionTime?: Date;
closeTime?: Date;
memo?: Record<string, unknown>;
/** @deprecated Use {@link typedSearchAttributes} instead. */
searchAttributes: SearchAttributes;
typedSearchAttributes: TypedSearchAttributes;
parentExecution?: Required<proto.temporal.api.common.v1.IWorkflowExecution>;
rootExecution?: Required<proto.temporal.api.common.v1.IWorkflowExecution>;
raw: RawWorkflowExecutionInfo;
priority?: Priority;
}
export interface CountWorkflowExecution {
count: number;
groups: {
count: number;
groupValues: SearchAttributeValue[];
}[];
}
export type WorkflowExecutionDescription = Replace<WorkflowExecutionInfo, {
raw: DescribeWorkflowExecutionResponse;
}> & {
/**
* General fixed details for this workflow execution that may appear in UI/CLI.
* This can be in Temporal markdown format and can span multiple lines.
*
* @experimental User metadata is a new API and susceptible to change.
*/
staticDetails: () => Promise<string | undefined>;
/**
* A single-line fixed summary for this workflow execution that may appear in the UI/CLI.
* This can be in single-line Temporal markdown format.
*
* @experimental User metadata is a new API and susceptible to change.
*/
staticSummary: () => Promise<string | undefined>;
};
export type WorkflowService = proto.temporal.api.workflowservice.v1.WorkflowService;
export declare const WorkflowService: typeof proto.temporal.api.workflowservice.v1.WorkflowService;
export type OperatorService = proto.temporal.api.operatorservice.v1.OperatorService;
export declare const OperatorService: typeof proto.temporal.api.operatorservice.v1.OperatorService;
export type TestService = proto.temporal.api.testservice.v1.TestService;
export declare const TestService: typeof proto.temporal.api.testservice.v1.TestService;
export type HealthService = proto.grpc.health.v1.Health;
export declare const HealthService: typeof proto.grpc.health.v1.Health;
/**
* Mapping of string to valid gRPC metadata value
*/
export type Metadata = Record<string, grpc.MetadataValue>;
/**
* User defined context for gRPC client calls
*/
export interface CallContext {
/**
* {@link Deadline | https://grpc.io/blog/deadlines/} for gRPC client calls
*/
deadline?: number | Date;
/**
* Metadata to set on gRPC requests
*/
metadata?: Metadata;
abortSignal?: AbortSignal;
}
/**
* Connection interface used by high level SDK clients.
*/
export interface ConnectionLike {
workflowService: WorkflowService;
operatorService: OperatorService;
plugins: ConnectionPlugin[];
close(): Promise<void>;
ensureConnected(): Promise<void>;
/**
* Set a deadline for any service requests executed in `fn`'s scope.
*
* The deadline is a point in time after which any pending gRPC request will be considered as failed;
* this will locally result in the request call throwing a {@link grpc.ServiceError|ServiceError}
* with code {@link grpc.status.DEADLINE_EXCEEDED|DEADLINE_EXCEEDED}; see {@link isGrpcDeadlineError}.
*
* It is stronly recommended to explicitly set deadlines. If no deadline is set, then it is
* possible for the client to end up waiting forever for a response.
*
* This method is only a convenience wrapper around {@link Connection.withDeadline}.
*
* @param deadline a point in time after which the request will be considered as failed; either a
* Date object, or a number of milliseconds since the Unix epoch (UTC).
* @returns the value returned from `fn`
*
* @see https://grpc.io/docs/guides/deadlines/
*/
withDeadline<R>(deadline: number | Date, fn: () => Promise<R>): Promise<R>;
/**
* Set metadata for any service requests executed in `fn`'s scope.
*
* @returns returned value of `fn`
*/
withMetadata<R>(metadata: Metadata, fn: () => Promise<R>): Promise<R>;
/**
* Set an {@link AbortSignal} that, when aborted, cancels any ongoing service requests executed in
* `fn`'s scope. This will locally result in the request call throwing a {@link grpc.ServiceError|ServiceError}
* with code {@link grpc.status.CANCELLED|CANCELLED}; see {@link isGrpcCancelledError}.
*
* @returns value returned from `fn`
*
* @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
*/
withAbortSignal<R>(abortSignal: AbortSignal, fn: () => Promise<R>): Promise<R>;
}
export declare const InternalConnectionLikeSymbol: unique symbol;
export type InternalConnectionLike = ConnectionLike & {
[InternalConnectionLikeSymbol]?: {
/**
* Capability flag that determines whether the connection supports eager workflow start.
* This will only be true if the underlying connection is a {@link NativeConnection}.
*/
readonly supportsEagerStart?: boolean;
};
};
export declare const QueryRejectCondition: {
readonly NONE: "NONE";
readonly NOT_OPEN: "NOT_OPEN";
readonly NOT_COMPLETED_CLEANLY: "NOT_COMPLETED_CLEANLY";
/** @deprecated Use {@link NONE} instead. */
readonly QUERY_REJECT_CONDITION_NONE: "NONE";
/** @deprecated Use {@link NOT_OPEN} instead. */
readonly QUERY_REJECT_CONDITION_NOT_OPEN: "NOT_OPEN";
/** @deprecated Use {@link NOT_COMPLETED_CLEANLY} instead. */
readonly QUERY_REJECT_CONDITION_NOT_COMPLETED_CLEANLY: "NOT_COMPLETED_CLEANLY";
/** @deprecated Use `undefined` instead. */
readonly QUERY_REJECT_CONDITION_UNSPECIFIED: undefined;
};
export type QueryRejectCondition = (typeof QueryRejectCondition)[keyof typeof QueryRejectCondition];
export declare const encodeQueryRejectCondition: (input: "NONE" | "NOT_OPEN" | "NOT_COMPLETED_CLEANLY" | "QUERY_REJECT_CONDITION_NONE" | "QUERY_REJECT_CONDITION_NOT_OPEN" | "QUERY_REJECT_CONDITION_NOT_COMPLETED_CLEANLY" | proto.temporal.api.enums.v1.QueryRejectCondition | null | undefined) => proto.temporal.api.enums.v1.QueryRejectCondition | undefined, decodeQueryRejectCondition: (input: proto.temporal.api.enums.v1.QueryRejectCondition | null | undefined) => "NONE" | "NOT_OPEN" | "NOT_COMPLETED_CLEANLY" | undefined;
/**
* Return type of {@link ActivityClient.count}
*
* @experimental Standalone Activities are experimental. APIs may be subject to change.
*/
export interface CountActivityExecutions {
readonly count: number;
readonly groups?: {
readonly count: number;
readonly groupValues?: any[];
}[];
}
/**
* @experimental Standalone Activities are experimental. APIs may be subject to change.
*/
export type RawActivityExecutionInfo = proto.temporal.api.activity.v1.IActivityExecutionInfo;
/**
* @experimental Standalone Activities are experimental. APIs may be subject to change.
*/
export type RawActivityExecutionListInfo = proto.temporal.api.activity.v1.IActivityExecutionListInfo;
/**
* Type of elements returned by {@link ActivityClient.list}
*
* @experimental Standalone Activities are experimental. APIs may be subject to change.
*/
export interface ActivityExecutionInfo {
rawListInfo?: RawActivityExecutionListInfo;
activityId: string;
activityRunId: string;
activityType: string;
scheduleTime?: Date;
closeTime?: Date;
status: ActivityExecutionStatus;
typedSearchAttributes: TypedSearchAttributes;
taskQueue: string;
executionDurationMs?: number;
}
/**
* Return type of {@link ActivityClient.describe}
*
* @experimental Standalone Activities are experimental. APIs may be subject to change.
*/
export interface ActivityExecutionDescription extends ActivityExecutionInfo {
rawInfo: RawActivityExecutionInfo;
runState?: PendingActivityState;
scheduleToCloseTimeoutMs?: number;
scheduleToStartTimeoutMs?: number;
startToCloseTimeoutMs?: number;
heartbeatTimeoutMs?: number;
retryPolicy: RetryPolicy;
lastHeartbeatTime?: Date;
lastStartedTime?: Date;
attempt: number;
expirationTime?: Date;
lastWorkerIdentity?: string;
currentRetryIntervalMs?: number;
lastAttemptCompleteTime?: Date;
nextAttemptScheduleTime?: Date;
lastDeploymentVersion?: WorkerDeploymentVersion;
priority: Priority;
canceledReason?: string;
getHeartbeatDetails<T = any>(): Promise<T | undefined>;
getLastFailure(): Promise<Error | undefined>;
}
/**
* @experimental Standalone Activities are experimental. APIs may be subject to change.
*/
export declare const ActivityIdReusePolicy: {
readonly ALLOW_DUPLICATE: "ALLOW_DUPLICATE";
readonly ALLOW_DUPLICATE_FAILED_ONLY: "ALLOW_DUPLICATE_FAILED_ONLY";
readonly REJECT_DUPLICATE: "REJECT_DUPLICATE";
};
/**
* @experimental Standalone Activities are experimental. APIs may be subject to change.
*/
export type ActivityIdReusePolicy = (typeof ActivityIdReusePolicy)[keyof typeof ActivityIdReusePolicy];
/**
* @experimental Standalone Activities are experimental. APIs may be subject to change.
*/
export declare const encodeActivityIdReusePolicy: (input: "ALLOW_DUPLICATE" | "ALLOW_DUPLICATE_FAILED_ONLY" | "REJECT_DUPLICATE" | proto.temporal.api.enums.v1.ActivityIdReusePolicy | "ACTIVITY_ID_REUSE_POLICY_ALLOW_DUPLICATE" | "ACTIVITY_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY" | "ACTIVITY_ID_REUSE_POLICY_REJECT_DUPLICATE" | null | undefined) => proto.temporal.api.enums.v1.ActivityIdReusePolicy | undefined, decodeActivityIdReusePolicy: (input: proto.temporal.api.enums.v1.ActivityIdReusePolicy | null | undefined) => "ALLOW_DUPLICATE" | "ALLOW_DUPLICATE_FAILED_ONLY" | "REJECT_DUPLICATE" | undefined;
/**
* @experimental Standalone Activities are experimental. APIs may be subject to change.
*/
export declare const ActivityIdConflictPolicy: {
readonly FAIL: "FAIL";
readonly USE_EXISTING: "USE_EXISTING";
};
/**
* @experimental Standalone Activities are experimental. APIs may be subject to change.
*/
export type ActivityIdConflictPolicy = (typeof ActivityIdConflictPolicy)[keyof typeof ActivityIdConflictPolicy];
/**
* @experimental Standalone Activities are experimental. APIs may be subject to change.
*/
export declare const encodeActivityIdConflictPolicy: (input: "FAIL" | "USE_EXISTING" | proto.temporal.api.enums.v1.ActivityIdConflictPolicy | "ACTIVITY_ID_CONFLICT_POLICY_FAIL" | "ACTIVITY_ID_CONFLICT_POLICY_USE_EXISTING" | null | undefined) => proto.temporal.api.enums.v1.ActivityIdConflictPolicy | undefined, decodeActivityIdConflictPolicy: (input: proto.temporal.api.enums.v1.ActivityIdConflictPolicy | null | undefined) => "FAIL" | "USE_EXISTING" | undefined;
/**
* @experimental Standalone Activities are experimental. APIs may be subject to change.
*/
export declare const ActivityExecutionStatus: {
readonly RUNNING: "RUNNING";
readonly COMPLETED: "COMPLETED";
readonly FAILED: "FAILED";
readonly CANCELED: "CANCELED";
readonly TERMINATED: "TERMINATED";
readonly TIMED_OUT: "TIMED_OUT";
};
/**
* @experimental Standalone Activities are experimental. APIs may be subject to change.
*/
export type ActivityExecutionStatus = (typeof ActivityExecutionStatus)[keyof typeof ActivityExecutionStatus];
/**
* @experimental Standalone Activities are experimental. APIs may be subject to change.
*/
export declare const encodeActivityExecutionStatus: (input: "RUNNING" | "COMPLETED" | "FAILED" | "TERMINATED" | "TIMED_OUT" | "CANCELED" | proto.temporal.api.enums.v1.ActivityExecutionStatus | "ACTIVITY_EXECUTION_STATUS_RUNNING" | "ACTIVITY_EXECUTION_STATUS_COMPLETED" | "ACTIVITY_EXECUTION_STATUS_FAILED" | "ACTIVITY_EXECUTION_STATUS_CANCELED" | "ACTIVITY_EXECUTION_STATUS_TERMINATED" | "ACTIVITY_EXECUTION_STATUS_TIMED_OUT" | null | undefined) => proto.temporal.api.enums.v1.ActivityExecutionStatus | undefined, decodeActivityExecutionStatus: (input: proto.temporal.api.enums.v1.ActivityExecutionStatus | null | undefined) => "RUNNING" | "COMPLETED" | "FAILED" | "TERMINATED" | "TIMED_OUT" | "CANCELED" | undefined;
/**
* @experimental Standalone Activities are experimental. APIs may be subject to change.
*/
export declare const PendingActivityState: {
readonly SCHEDULED: "SCHEDULED";
readonly STARTED: "STARTED";
readonly CANCEL_REQUESTED: "CANCEL_REQUESTED";
readonly PAUSED: "PAUSED";
readonly PAUSE_REQUESTED: "PAUSE_REQUESTED";
};
/**
* @experimental Standalone Activities are experimental. APIs may be subject to change.
*/
export type PendingActivityState = (typeof PendingActivityState)[keyof typeof PendingActivityState];
/**
* @experimental Standalone Activities are experimental. APIs may be subject to change.
*/
export declare const encodePendingActivityState: (input: "CANCEL_REQUESTED" | "PAUSED" | "SCHEDULED" | "STARTED" | "PAUSE_REQUESTED" | proto.temporal.api.enums.v1.PendingActivityState | "PENDING_ACTIVITY_STATE_SCHEDULED" | "PENDING_ACTIVITY_STATE_STARTED" | "PENDING_ACTIVITY_STATE_CANCEL_REQUESTED" | "PENDING_ACTIVITY_STATE_PAUSED" | "PENDING_ACTIVITY_STATE_PAUSE_REQUESTED" | null | undefined) => proto.temporal.api.enums.v1.PendingActivityState | undefined, decodePendingActivityState: (input: proto.temporal.api.enums.v1.PendingActivityState | null | undefined) => "CANCEL_REQUESTED" | "PAUSED" | "SCHEDULED" | "STARTED" | "PAUSE_REQUESTED" | undefined;