@temporalio/proto 0.18.0 → 0.19.0-rc.1
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/index.d.ts +8 -1
- package/package.json +2 -2
- package/scripts/compile-proto.js +1 -1
package/README.md
CHANGED
|
@@ -2,16 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/@temporalio/proto)
|
|
4
4
|
|
|
5
|
-
Part of
|
|
5
|
+
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)).
|
|
6
6
|
|
|
7
|
-
You should
|
|
7
|
+
You should usually not be using this package directly. Instead use:
|
|
8
8
|
|
|
9
|
-
- https://typescript.temporal.io/api/namespaces/client
|
|
10
|
-
- https://typescript.temporal.io/api/namespaces/
|
|
11
|
-
- https://typescript.temporal.io/api/namespaces/
|
|
12
|
-
- https://typescript.temporal.io/api/namespaces/
|
|
13
|
-
|
|
14
|
-
More docs:
|
|
15
|
-
|
|
16
|
-
- See code samples [here](https://github.com/temporalio/samples-typescript)
|
|
17
|
-
- See full introduction on the [docs site](https://docs.temporal.io/docs/typescript/introduction)
|
|
9
|
+
- [`@temporalio/client`](https://typescript.temporal.io/api/namespaces/client)
|
|
10
|
+
- [`@temporalio/worker`](https://typescript.temporal.io/api/namespaces/worker)
|
|
11
|
+
- [`@temporalio/workflow`](https://typescript.temporal.io/api/namespaces/workflow)
|
|
12
|
+
- [`@temporalio/activity`](https://typescript.temporal.io/api/namespaces/activity)
|
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/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@temporalio/proto",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.19.0-rc.1",
|
|
4
4
|
"description": "Temporal.io SDK compiled protobuf definitions",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"types": "lib/index.d.ts",
|
|
@@ -29,5 +29,5 @@
|
|
|
29
29
|
"publishConfig": {
|
|
30
30
|
"access": "public"
|
|
31
31
|
},
|
|
32
|
-
"gitHead": "
|
|
32
|
+
"gitHead": "186341ed7285e468c145121433f2c239e53934a6"
|
|
33
33
|
}
|
package/scripts/compile-proto.js
CHANGED
|
@@ -73,7 +73,7 @@ async function main() {
|
|
|
73
73
|
const genMTime = Math.min(mtime(coresdkJsOutputFile), mtime(serviceJsOutputFile));
|
|
74
74
|
|
|
75
75
|
if (protosMTime < genMTime) {
|
|
76
|
-
console.log('
|
|
76
|
+
console.log('Assuming protos are up to date');
|
|
77
77
|
return;
|
|
78
78
|
}
|
|
79
79
|
|