@temporalio/client/lib/types.d.ts

Temporal.io SDK Client sub-package

import type * as grpc from '@grpc/grpc-js';
import type { TypedSearchAttributes, SearchAttributes, SearchAttributeValue, Priority } from '@temporalio/common';
import * as proto from '@temporalio/proto';
import { Replace } from '@temporalio/common/lib/type-helpers';
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' | '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;
    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 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;