@temporalio/proto 0.18.0 → 0.20.0

package/README.md

@@ -2,16 +2,11 @@
 
 [![NPM](https://img.shields.io/npm/v/@temporalio/proto?style=for-the-badge)](https://www.npmjs.com/package/@temporalio/proto)
 
-Part of the [Temporal](https://temporal.io) [TypeScript SDK](https://www.npmjs.com/package/temporalio).
+Part of [Temporal](https://temporal.io)'s TypeScript SDK (see [docs](https://docs.temporal.io/docs/typescript/introduction/) and [samples](https://github.com/temporalio/samples-typescript)).
 
-You should probably not be using this package directly. See instead:
+You should usually not be using this package directly. Instead use:
 
-- https://typescript.temporal.io/api/namespaces/client
-- https://typescript.temporal.io/api/namespaces/activity
-- https://typescript.temporal.io/api/namespaces/worker
-- https://typescript.temporal.io/api/namespaces/workflow
-
-More docs:
-
-- See code samples [here](https://github.com/temporalio/samples-typescript)
-- See full introduction on the [docs site](https://docs.temporal.io/docs/typescript/introduction)
+- [`@temporalio/client`](https://typescript.temporal.io/api/namespaces/client)
+- [`@temporalio/worker`](https://typescript.temporal.io/api/namespaces/worker)
+- [`@temporalio/workflow`](https://typescript.temporal.io/api/namespaces/workflow)
+- [`@temporalio/activity`](https://typescript.temporal.io/api/namespaces/activity)

package/lib/coresdk.d.ts

@@ -9,9 +9,6 @@ export namespace coresdk {
       /** ActivityHeartbeat taskToken */
       taskToken?: (Uint8Array|null);
 
-      /** ActivityHeartbeat taskQueue */
-      taskQueue?: (string|null);
-
       /** ActivityHeartbeat details */
       details?: (coresdk.common.IPayload[]|null);
   }
@@ -28,9 +25,6 @@ export namespace coresdk {
       /** ActivityHeartbeat taskToken. */
       public taskToken: Uint8Array;
 
-      /** ActivityHeartbeat taskQueue. */
-      public taskQueue: string;
-
       /** ActivityHeartbeat details. */
       public details: coresdk.common.IPayload[];
 
@@ -97,9 +91,6 @@ export namespace coresdk {
       /** ActivityTaskCompletion taskToken */
       taskToken?: (Uint8Array|null);
 
-      /** ActivityTaskCompletion taskQueue */
-      taskQueue?: (string|null);
-
       /** ActivityTaskCompletion result */
       result?: (coresdk.activity_result.IActivityExecutionResult|null);
   }
@@ -116,9 +107,6 @@ export namespace coresdk {
       /** ActivityTaskCompletion taskToken. */
       public taskToken: Uint8Array;
 
-      /** ActivityTaskCompletion taskQueue. */
-      public taskQueue: string;
-
       /** ActivityTaskCompletion result. */
       public result?: (coresdk.activity_result.IActivityExecutionResult|null);
 
@@ -1872,23 +1860,74 @@ export namespace coresdk {
       /** Properties of a StartWorkflow. */
       interface IStartWorkflow {
 
-          /** The identifier the lang-specific sdk uses to execute workflow code */
+          /** StartWorkflow workflowType */
           workflowType?: (string|null);
 
-          /** The workflow id used on the temporal server */
+          /** StartWorkflow workflowId */
           workflowId?: (string|null);
 
-          /** Inputs to the workflow code */
+          /** StartWorkflow arguments */
           "arguments"?: (coresdk.common.IPayload[]|null);
 
-          /** RandomSeedUpdatedAttributes are used to deliver seed updates. */
+          /** StartWorkflow randomnessSeed */
           randomnessSeed?: (Long|null);
 
-          /** Used to add metadata e.g. for tracing and auth, meant to be read and written to by interceptors. */
+          /** StartWorkflow headers */
           headers?: ({ [k: string]: coresdk.common.IPayload }|null);
+
+          /** StartWorkflow identity */
+          identity?: (string|null);
+
+          /** StartWorkflow parentWorkflowInfo */
+          parentWorkflowInfo?: (coresdk.common.INamespacedWorkflowExecution|null);
+
+          /** StartWorkflow workflowExecutionTimeout */
+          workflowExecutionTimeout?: (google.protobuf.IDuration|null);
+
+          /** StartWorkflow workflowRunTimeout */
+          workflowRunTimeout?: (google.protobuf.IDuration|null);
+
+          /** StartWorkflow workflowTaskTimeout */
+          workflowTaskTimeout?: (google.protobuf.IDuration|null);
+
+          /** StartWorkflow continuedFromExecutionRunId */
+          continuedFromExecutionRunId?: (string|null);
+
+          /** StartWorkflow continuedInitiator */
+          continuedInitiator?: (temporal.api.enums.v1.ContinueAsNewInitiator|null);
+
+          /** StartWorkflow continuedFailure */
+          continuedFailure?: (temporal.api.failure.v1.IFailure|null);
+
+          /** StartWorkflow lastCompletionResult */
+          lastCompletionResult?: (temporal.api.common.v1.IPayloads|null);
+
+          /** StartWorkflow firstExecutionRunId */
+          firstExecutionRunId?: (string|null);
+
+          /** StartWorkflow retryPolicy */
+          retryPolicy?: (temporal.api.common.v1.IRetryPolicy|null);
+
+          /** StartWorkflow attempt */
+          attempt?: (number|null);
+
+          /** StartWorkflow cronSchedule */
+          cronSchedule?: (string|null);
+
+          /** StartWorkflow workflowExecutionExpirationTime */
+          workflowExecutionExpirationTime?: (google.protobuf.ITimestamp|null);
+
+          /** StartWorkflow cronScheduleToScheduleInterval */
+          cronScheduleToScheduleInterval?: (google.protobuf.IDuration|null);
+
+          /** StartWorkflow memo */
+          memo?: (temporal.api.common.v1.IMemo|null);
+
+          /** StartWorkflow searchAttributes */
+          searchAttributes?: (temporal.api.common.v1.ISearchAttributes|null);
       }
 
-      /** Start a new workflow */
+      /** Represents a StartWorkflow. */
       class StartWorkflow implements IStartWorkflow {
 
           /**
@@ -1897,21 +1936,72 @@ export namespace coresdk {
            */
           constructor(properties?: coresdk.workflow_activation.IStartWorkflow);
 
-          /** The identifier the lang-specific sdk uses to execute workflow code */
+          /** StartWorkflow workflowType. */
           public workflowType: string;
 
-          /** The workflow id used on the temporal server */
+          /** StartWorkflow workflowId. */
           public workflowId: string;
 
-          /** Inputs to the workflow code */
+          /** StartWorkflow arguments. */
           public arguments: coresdk.common.IPayload[];
 
-          /** RandomSeedUpdatedAttributes are used to deliver seed updates. */
+          /** StartWorkflow randomnessSeed. */
           public randomnessSeed: Long;
 
-          /** Used to add metadata e.g. for tracing and auth, meant to be read and written to by interceptors. */
+          /** StartWorkflow headers. */
           public headers: { [k: string]: coresdk.common.IPayload };
 
+          /** StartWorkflow identity. */
+          public identity: string;
+
+          /** StartWorkflow parentWorkflowInfo. */
+          public parentWorkflowInfo?: (coresdk.common.INamespacedWorkflowExecution|null);
+
+          /** StartWorkflow workflowExecutionTimeout. */
+          public workflowExecutionTimeout?: (google.protobuf.IDuration|null);
+
+          /** StartWorkflow workflowRunTimeout. */
+          public workflowRunTimeout?: (google.protobuf.IDuration|null);
+
+          /** StartWorkflow workflowTaskTimeout. */
+          public workflowTaskTimeout?: (google.protobuf.IDuration|null);
+
+          /** StartWorkflow continuedFromExecutionRunId. */
+          public continuedFromExecutionRunId: string;
+
+          /** StartWorkflow continuedInitiator. */
+          public continuedInitiator: temporal.api.enums.v1.ContinueAsNewInitiator;
+
+          /** StartWorkflow continuedFailure. */
+          public continuedFailure?: (temporal.api.failure.v1.IFailure|null);
+
+          /** StartWorkflow lastCompletionResult. */
+          public lastCompletionResult?: (temporal.api.common.v1.IPayloads|null);
+
+          /** StartWorkflow firstExecutionRunId. */
+          public firstExecutionRunId: string;
+
+          /** StartWorkflow retryPolicy. */
+          public retryPolicy?: (temporal.api.common.v1.IRetryPolicy|null);
+
+          /** StartWorkflow attempt. */
+          public attempt: number;
+
+          /** StartWorkflow cronSchedule. */
+          public cronSchedule: string;
+
+          /** StartWorkflow workflowExecutionExpirationTime. */
+          public workflowExecutionExpirationTime?: (google.protobuf.ITimestamp|null);
+
+          /** StartWorkflow cronScheduleToScheduleInterval. */
+          public cronScheduleToScheduleInterval?: (google.protobuf.IDuration|null);
+
+          /** StartWorkflow memo. */
+          public memo?: (temporal.api.common.v1.IMemo|null);
+
+          /** StartWorkflow searchAttributes. */
+          public searchAttributes?: (temporal.api.common.v1.ISearchAttributes|null);
+
           /**
            * Encodes the specified StartWorkflow message. Does not implicitly {@link coresdk.workflow_activation.StartWorkflow.verify|verify} messages.
            * @param message StartWorkflow message or plain object to encode
@@ -2633,6 +2723,9 @@ export namespace coresdk {
 
           /** QueryWorkflow arguments */
           "arguments"?: (coresdk.common.IPayload[]|null);
+
+          /** Headers attached to the query */
+          headers?: ({ [k: string]: coresdk.common.IPayload }|null);
       }
 
       /** Query a workflow */
@@ -2653,6 +2746,9 @@ export namespace coresdk {
           /** QueryWorkflow arguments. */
           public arguments: coresdk.common.IPayload[];
 
+          /** Headers attached to the query */
+          public headers: { [k: string]: coresdk.common.IPayload };
+
           /**
            * Encodes the specified QueryWorkflow message. Does not implicitly {@link coresdk.workflow_activation.QueryWorkflow.verify|verify} messages.
            * @param message QueryWorkflow message or plain object to encode
@@ -2797,9 +2893,12 @@ export namespace coresdk {
 
           /** SignalWorkflow identity */
           identity?: (string|null);
+
+          /** SignalWorkflow headers */
+          headers?: ({ [k: string]: coresdk.common.IPayload }|null);
       }
 
-      /** Send a signal to a workflow */
+      /** Represents a SignalWorkflow. */
       class SignalWorkflow implements ISignalWorkflow {
 
           /**
@@ -2817,6 +2916,9 @@ export namespace coresdk {
           /** SignalWorkflow identity. */
           public identity: string;
 
+          /** SignalWorkflow headers. */
+          public headers: { [k: string]: coresdk.common.IPayload };
+
           /**
            * Encodes the specified SignalWorkflow message. Does not implicitly {@link coresdk.workflow_activation.SignalWorkflow.verify|verify} messages.
            * @param message SignalWorkflow message or plain object to encode
@@ -3623,6 +3725,9 @@ export namespace coresdk {
 
           /** WorkflowCommand requestCancelLocalActivity */
           requestCancelLocalActivity?: (coresdk.workflow_commands.IRequestCancelLocalActivity|null);
+
+          /** WorkflowCommand upsertWorkflowSearchAttributesCommandAttributes */
+          upsertWorkflowSearchAttributesCommandAttributes?: (coresdk.workflow_commands.IUpsertWorkflowSearchAttributes|null);
       }
 
       /** Represents a WorkflowCommand. */
@@ -3685,8 +3790,11 @@ export namespace coresdk {
           /** WorkflowCommand requestCancelLocalActivity. */
           public requestCancelLocalActivity?: (coresdk.workflow_commands.IRequestCancelLocalActivity|null);
 
+          /** WorkflowCommand upsertWorkflowSearchAttributesCommandAttributes. */
+          public upsertWorkflowSearchAttributesCommandAttributes?: (coresdk.workflow_commands.IUpsertWorkflowSearchAttributes|null);
+
           /** WorkflowCommand variant. */
-          public variant?: ("startTimer"|"scheduleActivity"|"respondToQuery"|"requestCancelActivity"|"cancelTimer"|"completeWorkflowExecution"|"failWorkflowExecution"|"continueAsNewWorkflowExecution"|"cancelWorkflowExecution"|"setPatchMarker"|"startChildWorkflowExecution"|"cancelUnstartedChildWorkflowExecution"|"requestCancelExternalWorkflowExecution"|"signalExternalWorkflowExecution"|"cancelSignalWorkflow"|"scheduleLocalActivity"|"requestCancelLocalActivity");
+          public variant?: ("startTimer"|"scheduleActivity"|"respondToQuery"|"requestCancelActivity"|"cancelTimer"|"completeWorkflowExecution"|"failWorkflowExecution"|"continueAsNewWorkflowExecution"|"cancelWorkflowExecution"|"setPatchMarker"|"startChildWorkflowExecution"|"cancelUnstartedChildWorkflowExecution"|"requestCancelExternalWorkflowExecution"|"signalExternalWorkflowExecution"|"cancelSignalWorkflow"|"scheduleLocalActivity"|"requestCancelLocalActivity"|"upsertWorkflowSearchAttributesCommandAttributes");
 
           /**
            * Encodes the specified WorkflowCommand message. Does not implicitly {@link coresdk.workflow_commands.WorkflowCommand.verify|verify} messages.
@@ -3921,8 +4029,8 @@ export namespace coresdk {
           /** ScheduleActivity taskQueue */
           taskQueue?: (string|null);
 
-          /** ScheduleActivity headerFields */
-          headerFields?: ({ [k: string]: coresdk.common.IPayload }|null);
+          /** ScheduleActivity headers */
+          headers?: ({ [k: string]: coresdk.common.IPayload }|null);
 
           /** Arguments/input to the activity. Called "input" upstream. */
           "arguments"?: (coresdk.common.IPayload[]|null);
@@ -3970,8 +4078,8 @@ export namespace coresdk {
           /** ScheduleActivity taskQueue. */
           public taskQueue: string;
 
-          /** ScheduleActivity headerFields. */
-          public headerFields: { [k: string]: coresdk.common.IPayload };
+          /** ScheduleActivity headers. */
+          public headers: { [k: string]: coresdk.common.IPayload };
 
           /** Arguments/input to the activity. Called "input" upstream. */
           public arguments: coresdk.common.IPayload[];
@@ -4069,8 +4177,8 @@ export namespace coresdk {
           /** scheduling time (as provided in `DoBackoff`) */
           originalScheduleTime?: (google.protobuf.ITimestamp|null);
 
-          /** ScheduleLocalActivity headerFields */
-          headerFields?: ({ [k: string]: coresdk.common.IPayload }|null);
+          /** ScheduleLocalActivity headers */
+          headers?: ({ [k: string]: coresdk.common.IPayload }|null);
 
           /** Arguments/input to the activity. */
           "arguments"?: (coresdk.common.IPayload[]|null);
@@ -4118,8 +4226,8 @@ export namespace coresdk {
           /** scheduling time (as provided in `DoBackoff`) */
           public originalScheduleTime?: (google.protobuf.ITimestamp|null);
 
-          /** ScheduleLocalActivity headerFields. */
-          public headerFields: { [k: string]: coresdk.common.IPayload };
+          /** ScheduleLocalActivity headers. */
+          public headers: { [k: string]: coresdk.common.IPayload };
 
           /** Arguments/input to the activity. */
           public arguments: coresdk.common.IPayload[];
@@ -4699,7 +4807,7 @@ export namespace coresdk {
           memo?: ({ [k: string]: coresdk.common.IPayload }|null);
 
           /** Header fields */
-          header?: ({ [k: string]: coresdk.common.IPayload }|null);
+          headers?: ({ [k: string]: coresdk.common.IPayload }|null);
 
           /** Search attributes */
           searchAttributes?: ({ [k: string]: coresdk.common.IPayload }|null);
@@ -4733,7 +4841,7 @@ export namespace coresdk {
           public memo: { [k: string]: coresdk.common.IPayload };
 
           /** Header fields */
-          public header: { [k: string]: coresdk.common.IPayload };
+          public headers: { [k: string]: coresdk.common.IPayload };
 
           /** Search attributes */
           public searchAttributes: { [k: string]: coresdk.common.IPayload };
@@ -4990,7 +5098,7 @@ export namespace coresdk {
           cronSchedule?: (string|null);
 
           /** Header fields */
-          header?: ({ [k: string]: coresdk.common.IPayload }|null);
+          headers?: ({ [k: string]: coresdk.common.IPayload }|null);
 
           /** Memo fields */
           memo?: ({ [k: string]: coresdk.common.IPayload }|null);
@@ -5051,7 +5159,7 @@ export namespace coresdk {
           public cronSchedule: string;
 
           /** Header fields */
-          public header: { [k: string]: coresdk.common.IPayload };
+          public headers: { [k: string]: coresdk.common.IPayload };
 
           /** Memo fields */
           public memo: { [k: string]: coresdk.common.IPayload };
@@ -5303,6 +5411,9 @@ export namespace coresdk {
 
           /** Arguments for the handler */
           args?: (coresdk.common.IPayload[]|null);
+
+          /** Headers to attach to the signal */
+          headers?: ({ [k: string]: coresdk.common.IPayload }|null);
       }
 
       /** Send a signal to an external or child workflow */
@@ -5329,6 +5440,9 @@ export namespace coresdk {
           /** Arguments for the handler */
           public args: coresdk.common.IPayload[];
 
+          /** Headers to attach to the signal */
+          public headers: { [k: string]: coresdk.common.IPayload };
+
           /** SignalExternalWorkflowExecution target. */
           public target?: ("workflowExecution"|"childWorkflowId");
 
@@ -5464,6 +5578,88 @@ export namespace coresdk {
            */
           public toJSON(): { [k: string]: any };
       }
+
+      /** Properties of an UpsertWorkflowSearchAttributes. */
+      interface IUpsertWorkflowSearchAttributes {
+
+          /** Lang's incremental sequence number as passed to `UpsertWorkflowSearchAttributes` */
+          seq?: (number|null);
+
+          /** SearchAttributes fields - equivalent to indexed_fields on api. Key = search index, Value = value? */
+          searchAttributes?: ({ [k: string]: coresdk.common.IPayload }|null);
+      }
+
+      /** Represents an UpsertWorkflowSearchAttributes. */
+      class UpsertWorkflowSearchAttributes implements IUpsertWorkflowSearchAttributes {
+
+          /**
+           * Constructs a new UpsertWorkflowSearchAttributes.
+           * @param [properties] Properties to set
+           */
+          constructor(properties?: coresdk.workflow_commands.IUpsertWorkflowSearchAttributes);
+
+          /** Lang's incremental sequence number as passed to `UpsertWorkflowSearchAttributes` */
+          public seq: number;
+
+          /** SearchAttributes fields - equivalent to indexed_fields on api. Key = search index, Value = value? */
+          public searchAttributes: { [k: string]: coresdk.common.IPayload };
+
+          /**
+           * Encodes the specified UpsertWorkflowSearchAttributes message. Does not implicitly {@link coresdk.workflow_commands.UpsertWorkflowSearchAttributes.verify|verify} messages.
+           * @param message UpsertWorkflowSearchAttributes message or plain object to encode
+           * @param [writer] Writer to encode to
+           * @returns Writer
+           */
+          public static encode(message: coresdk.workflow_commands.IUpsertWorkflowSearchAttributes, writer?: $protobuf.Writer): $protobuf.Writer;
+
+          /**
+           * Encodes the specified UpsertWorkflowSearchAttributes message, length delimited. Does not implicitly {@link coresdk.workflow_commands.UpsertWorkflowSearchAttributes.verify|verify} messages.
+           * @param message UpsertWorkflowSearchAttributes message or plain object to encode
+           * @param [writer] Writer to encode to
+           * @returns Writer
+           */
+          public static encodeDelimited(message: coresdk.workflow_commands.IUpsertWorkflowSearchAttributes, writer?: $protobuf.Writer): $protobuf.Writer;
+
+          /**
+           * Decodes an UpsertWorkflowSearchAttributes message from the specified reader or buffer.
+           * @param reader Reader or buffer to decode from
+           * @param [length] Message length if known beforehand
+           * @returns UpsertWorkflowSearchAttributes
+           * @throws {Error} If the payload is not a reader or valid buffer
+           * @throws {$protobuf.util.ProtocolError} If required fields are missing
+           */
+          public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): coresdk.workflow_commands.UpsertWorkflowSearchAttributes;
+
+          /**
+           * Decodes an UpsertWorkflowSearchAttributes message from the specified reader or buffer, length delimited.
+           * @param reader Reader or buffer to decode from
+           * @returns UpsertWorkflowSearchAttributes
+           * @throws {Error} If the payload is not a reader or valid buffer
+           * @throws {$protobuf.util.ProtocolError} If required fields are missing
+           */
+          public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): coresdk.workflow_commands.UpsertWorkflowSearchAttributes;
+
+          /**
+           * Creates an UpsertWorkflowSearchAttributes message from a plain object. Also converts values to their respective internal types.
+           * @param object Plain object
+           * @returns UpsertWorkflowSearchAttributes
+           */
+          public static fromObject(object: { [k: string]: any }): coresdk.workflow_commands.UpsertWorkflowSearchAttributes;
+
+          /**
+           * Creates a plain object from an UpsertWorkflowSearchAttributes message. Also converts values to other types if specified.
+           * @param message UpsertWorkflowSearchAttributes
+           * @param [options] Conversion options
+           * @returns Plain object
+           */
+          public static toObject(message: coresdk.workflow_commands.UpsertWorkflowSearchAttributes, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+          /**
+           * Converts this UpsertWorkflowSearchAttributes to JSON.
+           * @returns JSON object
+           */
+          public toJSON(): { [k: string]: any };
+      }
   }
 
   /** Namespace workflow_completion. */
@@ -5472,9 +5668,6 @@ export namespace coresdk {
       /** Properties of a WorkflowActivationCompletion. */
       interface IWorkflowActivationCompletion {
 
-          /** WorkflowActivationCompletion taskQueue */
-          taskQueue?: (string|null);
-
           /** WorkflowActivationCompletion runId */
           runId?: (string|null);
 
@@ -5494,9 +5687,6 @@ export namespace coresdk {
            */
           constructor(properties?: coresdk.workflow_completion.IWorkflowActivationCompletion);
 
-          /** WorkflowActivationCompletion taskQueue. */
-          public taskQueue: string;
-
           /** WorkflowActivationCompletion runId. */
           public runId: string;
 
@@ -10402,6 +10592,13 @@ export namespace temporal {
                   PENDING_ACTIVITY_STATE_CANCEL_REQUESTED = 3
               }
 
+              /** PendingWorkflowTaskState enum. */
+              enum PendingWorkflowTaskState {
+                  PENDING_WORKFLOW_TASK_STATE_UNSPECIFIED = 0,
+                  PENDING_WORKFLOW_TASK_STATE_SCHEDULED = 1,
+                  PENDING_WORKFLOW_TASK_STATE_STARTED = 2
+              }
+
               /** HistoryEventFilterType enum. */
               enum HistoryEventFilterType {
                   HISTORY_EVENT_FILTER_TYPE_UNSPECIFIED = 0,