@temporalio/client 1.14.1 → 1.15.0

package/src/task-queue-client.ts

@@ -13,18 +13,19 @@ type IUpdateWorkerBuildIdCompatibilityRequest =
 type GetWorkerTaskReachabilityResponse = temporal.api.workflowservice.v1.GetWorkerTaskReachabilityResponse;
 
 /**
- * @experimental The Worker Versioning API is still being designed. Major changes are expected.
+ * @deprecated Worker Versioning is now deprecated. Please use the Worker Deployment API instead: https://docs.temporal.io/worker-deployments
  */
 export type TaskQueueClientOptions = BaseClientOptions;
 
 /**
- * @experimental The Worker Versioning API is still being designed. Major changes are expected.
+ * @deprecated Worker Versioning is now deprecated. Please use the Worker Deployment API instead: https://docs.temporal.io/worker-deployments
  */
 export type LoadedTaskQueueClientOptions = LoadedWithDefaults<TaskQueueClientOptions>;
 
 /**
  * A stand-in for a Build Id for unversioned Workers
- * @experimental The Worker Versioning API is still being designed. Major changes are expected.
+ *
+ * @deprecated Worker Versioning is now deprecated. Please use the Worker Deployment API instead: https://docs.temporal.io/worker-deployments
  */
 export const UnversionedBuildId = Symbol.for('__temporal_unversionedBuildId');
 export type UnversionedBuildIdType = typeof UnversionedBuildId;
@@ -32,7 +33,7 @@ export type UnversionedBuildIdType = typeof UnversionedBuildId;
 /**
  * Client for starting Workflow executions and creating Workflow handles
  *
- * @experimental The Worker Versioning API is still being designed. Major changes are expected.
+ * @deprecated Worker Versioning is now deprecated. Please use the Worker Deployment API instead: https://docs.temporal.io/worker-deployments
  */
 export class TaskQueueClient extends BaseClient {
   public readonly options: LoadedTaskQueueClientOptions;
@@ -63,6 +64,8 @@ export class TaskQueueClient extends BaseClient {
    *
    * @param taskQueue The task queue to make changes to.
    * @param operation The operation to be performed.
+   *
+   * @deprecated Worker Versioning is now deprecated. Please use the Worker Deployment API instead: https://docs.temporal.io/worker-deployments
    */
   public async updateBuildIdCompatibility(taskQueue: string, operation: BuildIdOperation): Promise<void> {
     const request: IUpdateWorkerBuildIdCompatibilityRequest = {
@@ -107,6 +110,8 @@ export class TaskQueueClient extends BaseClient {
    * @param taskQueue The task queue to fetch the compatibility information for.
    * @returns The sets of compatible Build Ids for the given task queue, or undefined if the queue
    *          has no Build Ids defined on it.
+   *
+   * @deprecated Worker Versioning is now deprecated. Please use the Worker Deployment API instead: https://docs.temporal.io/worker-deployments
    */
   public async getBuildIdCompatability(taskQueue: string): Promise<WorkerBuildIdVersionSets | undefined> {
     let resp;
@@ -134,6 +139,8 @@ export class TaskQueueClient extends BaseClient {
    * task queues that reachability information could not be retrieved for will be marked with a
    * `NotFetched` entry in {@link BuildIdReachability.taskQueueReachability}. The caller may issue
    * another call to get the reachability for those task queues.
+   *
+   * @deprecated Worker Versioning is now deprecated. Please use the Worker Deployment API instead: https://docs.temporal.io/worker-deployments
    */
   public async getReachability(options: ReachabilityOptions): Promise<ReachabilityResponse> {
     let resp;
@@ -170,9 +177,20 @@ export class TaskQueueClient extends BaseClient {
 
 /**
  * Options for {@link TaskQueueClient.getReachability}
+ *
+ * @deprecated Worker Versioning is now deprecated. Please use the Worker Deployment API instead: https://docs.temporal.io/worker-deployments
  */
 export type ReachabilityOptions = RequireAtLeastOne<BaseReachabilityOptions, 'buildIds' | 'taskQueues'>;
 
+/**
+ * There are different types of reachability:
+ *   - `NEW_WORKFLOWS`: The Build Id might be used by new workflows
+ *   - `EXISTING_WORKFLOWS` The Build Id might be used by open workflows and/or closed workflows.
+ *   - `OPEN_WORKFLOWS` The Build Id might be used by open workflows
+ *   - `CLOSED_WORKFLOWS` The Build Id might be used by closed workflows
+ *
+ * @deprecated Worker Versioning is now deprecated. Please use the Worker Deployment API instead: https://docs.temporal.io/worker-deployments
+ */
 export const ReachabilityType = {
   /** The Build Id might be used by new workflows. */
   NEW_WORKFLOWS: 'NEW_WORKFLOWS',
@@ -186,14 +204,6 @@ export const ReachabilityType = {
   /** The Build Id might be used by closed workflows. */
   CLOSED_WORKFLOWS: 'CLOSED_WORKFLOWS',
 } as const;
-
-/**
- * There are different types of reachability:
- *   - `NEW_WORKFLOWS`: The Build Id might be used by new workflows
- *   - `EXISTING_WORKFLOWS` The Build Id might be used by open workflows and/or closed workflows.
- *   - `OPEN_WORKFLOWS` The Build Id might be used by open workflows
- *   - `CLOSED_WORKFLOWS` The Build Id might be used by closed workflows
- */
 export type ReachabilityType = (typeof ReachabilityType)[keyof typeof ReachabilityType];
 
 export const [encodeTaskReachability, decodeTaskReachability] = makeProtoEnumConverters<
@@ -215,6 +225,8 @@ export const [encodeTaskReachability, decodeTaskReachability] = makeProtoEnumCon
 
 /**
  * See {@link ReachabilityOptions}
+ *
+ * @deprecated Worker Versioning is now deprecated. Please use the Worker Deployment API instead: https://docs.temporal.io/worker-deployments
  */
 export interface BaseReachabilityOptions {
   /**
@@ -231,13 +243,22 @@ export interface BaseReachabilityOptions {
   reachability?: ReachabilityType;
 }
 
+/**
+ * @deprecated Worker Versioning is now deprecated. Please use the Worker Deployment API instead: https://docs.temporal.io/worker-deployments
+ */
 export interface ReachabilityResponse {
   /** Maps Build Ids to their reachability information. */
   buildIdReachability: Record<string | UnversionedBuildIdType, BuildIdReachability>;
 }
 
+/**
+ * @deprecated Worker Versioning is now deprecated. Please use the Worker Deployment API instead: https://docs.temporal.io/worker-deployments
+ */
 export type ReachabilityTypeResponse = ReachabilityType | 'NOT_FETCHED';
 
+/**
+ * @deprecated Worker Versioning is now deprecated. Please use the Worker Deployment API instead: https://docs.temporal.io/worker-deployments
+ */
 export interface BuildIdReachability {
   /**
    *  Maps Task Queue names to how the Build Id may be reachable from them. If they are not
@@ -284,7 +305,7 @@ export function reachabilityResponseFromProto(resp: GetWorkerTaskReachabilityRes
  * - Id passed is incorrect
  * - Build Id has been scavenged by the server.
  *
- * @experimental The Worker Versioning API is still being designed. Major changes are expected.
+ * @deprecated Worker Versioning is now deprecated. Please use the Worker Deployment API instead: https://docs.temporal.io/worker-deployments
  */
 @SymbolBasedInstanceOfError('BuildIdNotFoundError')
 export class BuildIdNotFoundError extends Error {}

package/src/types.ts

@@ -29,6 +29,7 @@ export type WorkflowExecutionStatusName =
   | 'TERMINATED'
   | 'CONTINUED_AS_NEW'
   | 'TIMED_OUT'
+  | 'PAUSED'
   | 'UNKNOWN'; // UNKNOWN is reserved for future enum values
 
 export interface WorkflowExecutionInfo {
@@ -49,7 +50,7 @@ export interface WorkflowExecutionInfo {
   closeTime?: Date;
   memo?: Record<string, unknown>;
   /** @deprecated Use {@link typedSearchAttributes} instead. */
-  searchAttributes: SearchAttributes; // eslint-disable-line deprecation/deprecation
+  searchAttributes: SearchAttributes; // eslint-disable-line @typescript-eslint/no-deprecated
   typedSearchAttributes: TypedSearchAttributes;
   parentExecution?: Required<proto.temporal.api.common.v1.IWorkflowExecution>;
   rootExecution?: Required<proto.temporal.api.common.v1.IWorkflowExecution>;
@@ -61,7 +62,7 @@ export interface CountWorkflowExecution {
   count: number;
   groups: {
     count: number;
-    groupValues: SearchAttributeValue[]; // eslint-disable-line deprecation/deprecation
+    groupValues: SearchAttributeValue[]; // eslint-disable-line @typescript-eslint/no-deprecated
   }[];
 }
 
@@ -123,6 +124,7 @@ export interface CallContext {
  */
 export interface ConnectionLike {
   workflowService: WorkflowService;
+  operatorService: OperatorService;
   plugins: ConnectionPlugin[];
   close(): Promise<void>;
   ensureConnected(): Promise<void>;
@@ -183,16 +185,16 @@ export const QueryRejectCondition = {
   NOT_COMPLETED_CLEANLY: 'NOT_COMPLETED_CLEANLY',
 
   /** @deprecated Use {@link NONE} instead. */
-  QUERY_REJECT_CONDITION_NONE: 'NONE', // eslint-disable-line deprecation/deprecation
+  QUERY_REJECT_CONDITION_NONE: 'NONE',
 
   /** @deprecated Use {@link NOT_OPEN} instead. */
-  QUERY_REJECT_CONDITION_NOT_OPEN: 'NOT_OPEN', // eslint-disable-line deprecation/deprecation
+  QUERY_REJECT_CONDITION_NOT_OPEN: 'NOT_OPEN',
 
   /** @deprecated Use {@link NOT_COMPLETED_CLEANLY} instead. */
-  QUERY_REJECT_CONDITION_NOT_COMPLETED_CLEANLY: 'NOT_COMPLETED_CLEANLY', // eslint-disable-line deprecation/deprecation
+  QUERY_REJECT_CONDITION_NOT_COMPLETED_CLEANLY: 'NOT_COMPLETED_CLEANLY',
 
   /** @deprecated Use `undefined` instead. */
-  QUERY_REJECT_CONDITION_UNSPECIFIED: undefined, // eslint-disable-line deprecation/deprecation
+  QUERY_REJECT_CONDITION_UNSPECIFIED: undefined,
 } as const;
 export type QueryRejectCondition = (typeof QueryRejectCondition)[keyof typeof QueryRejectCondition];
 

package/src/workflow-client.ts

@@ -296,7 +296,7 @@ export interface WorkflowClientOptions extends BaseClientOptions {
    *
    * Useful for injecting auth headers and tracing Workflow executions
    */
-  // eslint-disable-next-line deprecation/deprecation
+  // eslint-disable-next-line @typescript-eslint/no-deprecated
   interceptors?: WorkflowClientInterceptors | WorkflowClientInterceptor[];
 
   /**
@@ -1033,7 +1033,7 @@ export class WorkflowClient extends BaseClient {
     }
     return {
       updateId: request.request!.meta!.updateId!,
-      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+
       workflowRunId: response.updateRef!.workflowExecution!.runId!,
       outcome: response.outcome ?? undefined,
     };
@@ -1237,9 +1237,9 @@ export class WorkflowClient extends BaseClient {
       retryPolicy: options.retry ? compileRetryPolicy(options.retry) : undefined,
       memo: options.memo ? { fields: await encodeMapToPayloads(this.dataConverter, options.memo) } : undefined,
       searchAttributes:
-        options.searchAttributes || options.typedSearchAttributes // eslint-disable-line deprecation/deprecation
+        options.searchAttributes || options.typedSearchAttributes // eslint-disable-line @typescript-eslint/no-deprecated
           ? {
-              indexedFields: encodeUnifiedSearchAttributes(options.searchAttributes, options.typedSearchAttributes), // eslint-disable-line deprecation/deprecation
+              indexedFields: encodeUnifiedSearchAttributes(options.searchAttributes, options.typedSearchAttributes), // eslint-disable-line @typescript-eslint/no-deprecated
             }
           : undefined,
       cronSchedule: options.cronSchedule,
@@ -1326,9 +1326,9 @@ export class WorkflowClient extends BaseClient {
       retryPolicy: opts.retry ? compileRetryPolicy(opts.retry) : undefined,
       memo: opts.memo ? { fields: await encodeMapToPayloads(this.dataConverter, opts.memo) } : undefined,
       searchAttributes:
-        opts.searchAttributes || opts.typedSearchAttributes // eslint-disable-line deprecation/deprecation
+        opts.searchAttributes || opts.typedSearchAttributes // eslint-disable-line @typescript-eslint/no-deprecated
           ? {
-              indexedFields: encodeUnifiedSearchAttributes(opts.searchAttributes, opts.typedSearchAttributes), // eslint-disable-line deprecation/deprecation
+              indexedFields: encodeUnifiedSearchAttributes(opts.searchAttributes, opts.typedSearchAttributes), // eslint-disable-line @typescript-eslint/no-deprecated
             }
           : undefined,
       cronSchedule: opts.cronSchedule,
@@ -1649,7 +1649,7 @@ export class WorkflowClient extends BaseClient {
 
   protected getOrMakeInterceptors(workflowId: string, runId?: string): WorkflowClientInterceptor[] {
     if (typeof this.options.interceptors === 'object' && 'calls' in this.options.interceptors) {
-      // eslint-disable-next-line deprecation/deprecation
+      // eslint-disable-next-line @typescript-eslint/no-deprecated
       const factories = (this.options.interceptors as WorkflowClientInterceptors).calls ?? [];
       return factories.map((ctor) => ctor({ workflowId, runId }));
     }

package/src/workflow-options.ts

@@ -50,8 +50,6 @@ export interface WorkflowOptions extends CommonWorkflowOptions {
 
   /**
    * Override the versioning behavior of the Workflow that is about to be started.
-   *
-   * @experimental Deployment based versioning is experimental and may change in the future.
    */
   versioningOverride?: VersioningOverride;
 

package/src/workflow-update-stage.ts

@@ -20,7 +20,7 @@ export const WorkflowUpdateStage = {
    * This is not an allowed value.
    * @deprecated
    */
-  UNSPECIFIED: undefined, // eslint-disable-line deprecation/deprecation
+  UNSPECIFIED: undefined,
 } as const;
 export type WorkflowUpdateStage = (typeof WorkflowUpdateStage)[keyof typeof WorkflowUpdateStage];