@temporalio/proto 0.17.2 → 0.19.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -11
- package/lib/coresdk.d.ts +4303 -3729
- package/lib/coresdk.js +8326 -7428
- package/lib/index.d.ts +8 -1
- package/lib/temporal.d.ts +57 -2
- package/lib/temporal.js +150 -2
- package/package.json +2 -2
- package/scripts/compile-proto.js +5 -3
package/lib/index.d.ts
CHANGED
|
@@ -12,6 +12,8 @@
|
|
|
12
12
|
* const activityTask: coresdk.activity_task.IActivityTask = { ... };
|
|
13
13
|
* ```
|
|
14
14
|
*
|
|
15
|
+
* The source protos are in the [sdk-core repo](https://github.com/temporalio/sdk-core/tree/ts-release/protos/local/temporal/sdk/core), for example [`ActivityTask` in `activity_task.proto`](https://github.com/temporalio/sdk-core/blob/85454935e39f789aaaa81f8a05773f8e2cdbcde2/protos/local/temporal/sdk/core/activity_task/activity_task.proto#L12).
|
|
16
|
+
*
|
|
15
17
|
* ### Temporal Service API
|
|
16
18
|
*
|
|
17
19
|
* Temporal API interfaces - used to communicate with the Temporal service - can be accessed in the `temporal` namespace.
|
|
@@ -20,8 +22,13 @@
|
|
|
20
22
|
* import { temporal } from '@temporalio/proto';
|
|
21
23
|
* const retryPolicy: temporal.api.common.v1.IRetryPolicy = { ... };
|
|
22
24
|
* ```
|
|
25
|
+
*
|
|
26
|
+
* The source protos are in [sdk-core/protos/api_upstream/temporal/api/](https://github.com/temporalio/sdk-core/tree/ts-release/protos/api_upstream/temporal/api), for example [`RetryPolicy` in `temporal/api/common/v1/message.proto`](https://github.com/temporalio/sdk-core/blob/85454935e39f789aaaa81f8a05773f8e2cdbcde2/protos/api_upstream/temporal/api/common/v1/message.proto#L96).
|
|
27
|
+
*
|
|
28
|
+
* The gRPC service methods are documented in the proto comments and in the corresponding [`tctl` docs](https://docs.temporal.io/docs/tctl/).
|
|
23
29
|
* @module
|
|
24
30
|
*/
|
|
25
31
|
|
|
26
|
-
export * from './temporal';
|
|
27
32
|
export { coresdk } from './coresdk';
|
|
33
|
+
export * from './temporal';
|
|
34
|
+
|
package/lib/temporal.d.ts
CHANGED
|
@@ -1409,6 +1409,9 @@ export namespace temporal {
|
|
|
1409
1409
|
|
|
1410
1410
|
/** UpdateNamespaceRequest deleteBadBinary */
|
|
1411
1411
|
deleteBadBinary?: (string|null);
|
|
1412
|
+
|
|
1413
|
+
/** UpdateNamespaceRequest promoteNamespace */
|
|
1414
|
+
promoteNamespace?: (boolean|null);
|
|
1412
1415
|
}
|
|
1413
1416
|
|
|
1414
1417
|
/** Represents an UpdateNamespaceRequest. */
|
|
@@ -1438,6 +1441,9 @@ export namespace temporal {
|
|
|
1438
1441
|
/** UpdateNamespaceRequest deleteBadBinary. */
|
|
1439
1442
|
public deleteBadBinary: string;
|
|
1440
1443
|
|
|
1444
|
+
/** UpdateNamespaceRequest promoteNamespace. */
|
|
1445
|
+
public promoteNamespace: boolean;
|
|
1446
|
+
|
|
1441
1447
|
/**
|
|
1442
1448
|
* Encodes the specified UpdateNamespaceRequest message. Does not implicitly {@link temporal.api.workflowservice.v1.UpdateNamespaceRequest.verify|verify} messages.
|
|
1443
1449
|
* @param message UpdateNamespaceRequest message or plain object to encode
|
|
@@ -4650,6 +4656,9 @@ export namespace temporal {
|
|
|
4650
4656
|
|
|
4651
4657
|
/** SignalWorkflowExecutionRequest control */
|
|
4652
4658
|
control?: (string|null);
|
|
4659
|
+
|
|
4660
|
+
/** SignalWorkflowExecutionRequest header */
|
|
4661
|
+
header?: (temporal.api.common.v1.IHeader|null);
|
|
4653
4662
|
}
|
|
4654
4663
|
|
|
4655
4664
|
/** Represents a SignalWorkflowExecutionRequest. */
|
|
@@ -4682,6 +4691,9 @@ export namespace temporal {
|
|
|
4682
4691
|
/** SignalWorkflowExecutionRequest control. */
|
|
4683
4692
|
public control: string;
|
|
4684
4693
|
|
|
4694
|
+
/** SignalWorkflowExecutionRequest header. */
|
|
4695
|
+
public header?: (temporal.api.common.v1.IHeader|null);
|
|
4696
|
+
|
|
4685
4697
|
/**
|
|
4686
4698
|
* Encodes the specified SignalWorkflowExecutionRequest message. Does not implicitly {@link temporal.api.workflowservice.v1.SignalWorkflowExecutionRequest.verify|verify} messages.
|
|
4687
4699
|
* @param message SignalWorkflowExecutionRequest message or plain object to encode
|
|
@@ -7587,6 +7599,12 @@ export namespace temporal {
|
|
|
7587
7599
|
|
|
7588
7600
|
/** GetClusterInfoResponse historyShardCount */
|
|
7589
7601
|
historyShardCount?: (number|null);
|
|
7602
|
+
|
|
7603
|
+
/** GetClusterInfoResponse persistenceStore */
|
|
7604
|
+
persistenceStore?: (string|null);
|
|
7605
|
+
|
|
7606
|
+
/** GetClusterInfoResponse visibilityStore */
|
|
7607
|
+
visibilityStore?: (string|null);
|
|
7590
7608
|
}
|
|
7591
7609
|
|
|
7592
7610
|
/** Represents a GetClusterInfoResponse. */
|
|
@@ -7616,6 +7634,12 @@ export namespace temporal {
|
|
|
7616
7634
|
/** GetClusterInfoResponse historyShardCount. */
|
|
7617
7635
|
public historyShardCount: number;
|
|
7618
7636
|
|
|
7637
|
+
/** GetClusterInfoResponse persistenceStore. */
|
|
7638
|
+
public persistenceStore: string;
|
|
7639
|
+
|
|
7640
|
+
/** GetClusterInfoResponse visibilityStore. */
|
|
7641
|
+
public visibilityStore: string;
|
|
7642
|
+
|
|
7619
7643
|
/**
|
|
7620
7644
|
* Encodes the specified GetClusterInfoResponse message. Does not implicitly {@link temporal.api.workflowservice.v1.GetClusterInfoResponse.verify|verify} messages.
|
|
7621
7645
|
* @param message GetClusterInfoResponse message or plain object to encode
|
|
@@ -7922,7 +7946,8 @@ export namespace temporal {
|
|
|
7922
7946
|
NAMESPACE_STATE_UNSPECIFIED = 0,
|
|
7923
7947
|
NAMESPACE_STATE_REGISTERED = 1,
|
|
7924
7948
|
NAMESPACE_STATE_DEPRECATED = 2,
|
|
7925
|
-
NAMESPACE_STATE_DELETED = 3
|
|
7949
|
+
NAMESPACE_STATE_DELETED = 3,
|
|
7950
|
+
NAMESPACE_STATE_HANDOVER = 4
|
|
7926
7951
|
}
|
|
7927
7952
|
|
|
7928
7953
|
/** ArchivalState enum. */
|
|
@@ -7989,7 +8014,7 @@ export namespace temporal {
|
|
|
7989
8014
|
/** IndexedValueType enum. */
|
|
7990
8015
|
enum IndexedValueType {
|
|
7991
8016
|
INDEXED_VALUE_TYPE_UNSPECIFIED = 0,
|
|
7992
|
-
|
|
8017
|
+
INDEXED_VALUE_TYPE_TEXT = 1,
|
|
7993
8018
|
INDEXED_VALUE_TYPE_KEYWORD = 2,
|
|
7994
8019
|
INDEXED_VALUE_TYPE_INT = 3,
|
|
7995
8020
|
INDEXED_VALUE_TYPE_DOUBLE = 4,
|
|
@@ -11305,6 +11330,9 @@ export namespace temporal {
|
|
|
11305
11330
|
|
|
11306
11331
|
/** WorkflowExecutionSignaledEventAttributes identity */
|
|
11307
11332
|
identity?: (string|null);
|
|
11333
|
+
|
|
11334
|
+
/** WorkflowExecutionSignaledEventAttributes header */
|
|
11335
|
+
header?: (temporal.api.common.v1.IHeader|null);
|
|
11308
11336
|
}
|
|
11309
11337
|
|
|
11310
11338
|
/** Represents a WorkflowExecutionSignaledEventAttributes. */
|
|
@@ -11325,6 +11353,9 @@ export namespace temporal {
|
|
|
11325
11353
|
/** WorkflowExecutionSignaledEventAttributes identity. */
|
|
11326
11354
|
public identity: string;
|
|
11327
11355
|
|
|
11356
|
+
/** WorkflowExecutionSignaledEventAttributes header. */
|
|
11357
|
+
public header?: (temporal.api.common.v1.IHeader|null);
|
|
11358
|
+
|
|
11328
11359
|
/**
|
|
11329
11360
|
* Encodes the specified WorkflowExecutionSignaledEventAttributes message. Does not implicitly {@link temporal.api.history.v1.WorkflowExecutionSignaledEventAttributes.verify|verify} messages.
|
|
11330
11361
|
* @param message WorkflowExecutionSignaledEventAttributes message or plain object to encode
|
|
@@ -11787,6 +11818,9 @@ export namespace temporal {
|
|
|
11787
11818
|
|
|
11788
11819
|
/** SignalExternalWorkflowExecutionInitiatedEventAttributes childWorkflowOnly */
|
|
11789
11820
|
childWorkflowOnly?: (boolean|null);
|
|
11821
|
+
|
|
11822
|
+
/** SignalExternalWorkflowExecutionInitiatedEventAttributes header */
|
|
11823
|
+
header?: (temporal.api.common.v1.IHeader|null);
|
|
11790
11824
|
}
|
|
11791
11825
|
|
|
11792
11826
|
/** Represents a SignalExternalWorkflowExecutionInitiatedEventAttributes. */
|
|
@@ -11819,6 +11853,9 @@ export namespace temporal {
|
|
|
11819
11853
|
/** SignalExternalWorkflowExecutionInitiatedEventAttributes childWorkflowOnly. */
|
|
11820
11854
|
public childWorkflowOnly: boolean;
|
|
11821
11855
|
|
|
11856
|
+
/** SignalExternalWorkflowExecutionInitiatedEventAttributes header. */
|
|
11857
|
+
public header?: (temporal.api.common.v1.IHeader|null);
|
|
11858
|
+
|
|
11822
11859
|
/**
|
|
11823
11860
|
* Encodes the specified SignalExternalWorkflowExecutionInitiatedEventAttributes message. Does not implicitly {@link temporal.api.history.v1.SignalExternalWorkflowExecutionInitiatedEventAttributes.verify|verify} messages.
|
|
11824
11861
|
* @param message SignalExternalWorkflowExecutionInitiatedEventAttributes message or plain object to encode
|
|
@@ -16330,6 +16367,9 @@ export namespace temporal {
|
|
|
16330
16367
|
|
|
16331
16368
|
/** SignalExternalWorkflowExecutionCommandAttributes childWorkflowOnly */
|
|
16332
16369
|
childWorkflowOnly?: (boolean|null);
|
|
16370
|
+
|
|
16371
|
+
/** SignalExternalWorkflowExecutionCommandAttributes header */
|
|
16372
|
+
header?: (temporal.api.common.v1.IHeader|null);
|
|
16333
16373
|
}
|
|
16334
16374
|
|
|
16335
16375
|
/** Represents a SignalExternalWorkflowExecutionCommandAttributes. */
|
|
@@ -16359,6 +16399,9 @@ export namespace temporal {
|
|
|
16359
16399
|
/** SignalExternalWorkflowExecutionCommandAttributes childWorkflowOnly. */
|
|
16360
16400
|
public childWorkflowOnly: boolean;
|
|
16361
16401
|
|
|
16402
|
+
/** SignalExternalWorkflowExecutionCommandAttributes header. */
|
|
16403
|
+
public header?: (temporal.api.common.v1.IHeader|null);
|
|
16404
|
+
|
|
16362
16405
|
/**
|
|
16363
16406
|
* Encodes the specified SignalExternalWorkflowExecutionCommandAttributes message. Does not implicitly {@link temporal.api.command.v1.SignalExternalWorkflowExecutionCommandAttributes.verify|verify} messages.
|
|
16364
16407
|
* @param message SignalExternalWorkflowExecutionCommandAttributes message or plain object to encode
|
|
@@ -17782,6 +17825,9 @@ export namespace temporal {
|
|
|
17782
17825
|
|
|
17783
17826
|
/** UpdateNamespaceInfo data */
|
|
17784
17827
|
data?: ({ [k: string]: string }|null);
|
|
17828
|
+
|
|
17829
|
+
/** UpdateNamespaceInfo state */
|
|
17830
|
+
state?: (temporal.api.enums.v1.NamespaceState|null);
|
|
17785
17831
|
}
|
|
17786
17832
|
|
|
17787
17833
|
/** Represents an UpdateNamespaceInfo. */
|
|
@@ -17802,6 +17848,9 @@ export namespace temporal {
|
|
|
17802
17848
|
/** UpdateNamespaceInfo data. */
|
|
17803
17849
|
public data: { [k: string]: string };
|
|
17804
17850
|
|
|
17851
|
+
/** UpdateNamespaceInfo state. */
|
|
17852
|
+
public state: temporal.api.enums.v1.NamespaceState;
|
|
17853
|
+
|
|
17805
17854
|
/**
|
|
17806
17855
|
* Encodes the specified UpdateNamespaceInfo message. Does not implicitly {@link temporal.api.namespace.v1.UpdateNamespaceInfo.verify|verify} messages.
|
|
17807
17856
|
* @param message UpdateNamespaceInfo message or plain object to encode
|
|
@@ -17875,6 +17924,9 @@ export namespace temporal {
|
|
|
17875
17924
|
|
|
17876
17925
|
/** WorkflowQuery queryArgs */
|
|
17877
17926
|
queryArgs?: (temporal.api.common.v1.IPayloads|null);
|
|
17927
|
+
|
|
17928
|
+
/** WorkflowQuery header */
|
|
17929
|
+
header?: (temporal.api.common.v1.IHeader|null);
|
|
17878
17930
|
}
|
|
17879
17931
|
|
|
17880
17932
|
/** Represents a WorkflowQuery. */
|
|
@@ -17892,6 +17944,9 @@ export namespace temporal {
|
|
|
17892
17944
|
/** WorkflowQuery queryArgs. */
|
|
17893
17945
|
public queryArgs?: (temporal.api.common.v1.IPayloads|null);
|
|
17894
17946
|
|
|
17947
|
+
/** WorkflowQuery header. */
|
|
17948
|
+
public header?: (temporal.api.common.v1.IHeader|null);
|
|
17949
|
+
|
|
17895
17950
|
/**
|
|
17896
17951
|
* Encodes the specified WorkflowQuery message. Does not implicitly {@link temporal.api.query.v1.WorkflowQuery.verify|verify} messages.
|
|
17897
17952
|
* @param message WorkflowQuery message or plain object to encode
|