@temporalio/proto 0.19.0 → 0.22.0

package/lib/patch-protobuf-root.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Create a version of `root` with non-nested namespaces to match the generated types.
+ * For more information, see:
+ * https://github.com/temporalio/sdk-typescript/blob/main/docs/protobuf-libraries.md#current-solution
+ * @param root Generated by `pbjs -t json-module -w commonjs -o json-module.js *.proto`
+ * @returns A new patched `root`
+ */
+export declare function patchProtobufRoot<T extends Record<string, unknown>>(root: T): T;

package/lib/patch-protobuf-root.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.patchProtobufRoot = void 0;
+const ROOT_PROPS = [
+    'options',
+    'parsedOptions',
+    'name',
+    'parent',
+    'resolved',
+    'comment',
+    'filename',
+    'nested',
+    '_nestedArray',
+];
+/**
+ * Create a version of `root` with non-nested namespaces to match the generated types.
+ * For more information, see:
+ * https://github.com/temporalio/sdk-typescript/blob/main/docs/protobuf-libraries.md#current-solution
+ * @param root Generated by `pbjs -t json-module -w commonjs -o json-module.js *.proto`
+ * @returns A new patched `root`
+ */
+function patchProtobufRoot(root) {
+    return _patchProtobufRoot(root);
+}
+exports.patchProtobufRoot = patchProtobufRoot;
+function _patchProtobufRoot(root, name) {
+    const newRoot = new root.constructor(isNamespace(root) ? name : {});
+    for (const key in root) {
+        newRoot[key] = root[key];
+    }
+    if (isRecord(root.nested)) {
+        for (const typeOrNamespace in root.nested) {
+            const value = root.nested[typeOrNamespace];
+            if (ROOT_PROPS.includes(typeOrNamespace)) {
+                console.log(`patchProtobufRoot warning: overriding property '${typeOrNamespace}' that is used by protobufjs with the '${typeOrNamespace}' protobuf ${isNamespace(value) ? 'namespace' : 'type'}. This may result in protobufjs not working property.`);
+            }
+            if (isNamespace(value)) {
+                newRoot[typeOrNamespace] = _patchProtobufRoot(value, typeOrNamespace);
+            }
+            else if (isType(value)) {
+                newRoot[typeOrNamespace] = value;
+            }
+        }
+    }
+    return newRoot;
+}
+function isType(value) {
+    return isRecord(value) && value.constructor.name === 'Type';
+}
+function isNamespace(value) {
+    return isRecord(value) && value.constructor.name === 'Namespace';
+}
+// Duplicate from type-helpers instead of importing in order to avoid circular dependency
+function isRecord(value) {
+    return typeof value === 'object' && value !== null;
+}
+//# sourceMappingURL=patch-protobuf-root.js.map

package/lib/patch-protobuf-root.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"patch-protobuf-root.js","sourceRoot":"","sources":["../src/patch-protobuf-root.ts"],"names":[],"mappings":";;;AAAA,MAAM,UAAU,GAAG;IACjB,SAAS;IACT,eAAe;IACf,MAAM;IACN,QAAQ;IACR,UAAU;IACV,SAAS;IACT,UAAU;IACV,QAAQ;IACR,cAAc;CACf,CAAC;AAEF;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAAoC,IAAO;IAC1E,OAAO,kBAAkB,CAAC,IAAI,CAAC,CAAC;AAClC,CAAC;AAFD,8CAEC;AAED,SAAS,kBAAkB,CAAoC,IAAO,EAAE,IAAa;IACnF,MAAM,OAAO,GAAG,IAAK,IAAI,CAAC,WAAmB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC7E,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACtB,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;KAC1B;IAED,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;QACzB,KAAK,MAAM,eAAe,IAAI,IAAI,CAAC,MAAM,EAAE;YACzC,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;YAC3C,IAAI,UAAU,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE;gBACxC,OAAO,CAAC,GAAG,CACT,mDAAmD,eAAe,0CAA0C,eAAe,cACzH,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,MACrC,uDAAuD,CACxD,CAAC;aACH;YAED,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE;gBACtB,OAAO,CAAC,eAAe,CAAC,GAAG,kBAAkB,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;aACvE;iBAAM,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE;gBACxB,OAAO,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC;aAClC;SACF;KACF;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAKD,SAAS,MAAM,CAAC,KAAc;IAC5B,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,MAAM,CAAC;AAC9D,CAAC;AAED,SAAS,WAAW,CAAC,KAAc;IACjC,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,WAAW,CAAC;AACnE,CAAC;AAED,yFAAyF;AACzF,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC;AACrD,CAAC"}

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "@temporalio/proto",
-  "version": "0.19.0",
+  "version": "0.22.0",
   "description": "Temporal.io SDK compiled protobuf definitions",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "main": "protos/index.js",
+  "types": "protos/index.d.ts",
+  "files": [
+    "protos/",
+    "lib/"
+  ],
   "scripts": {
     "build": "node ./scripts/compile-proto.js"
   },
@@ -29,5 +33,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "02748d3fc3f321669ffa09f0ca012b81900b0fc0"
+  "gitHead": "3aa1f14982bd170d21b728cbf016dc4f1b595a76"
 }

package/{lib → protos}/index.d.ts

@@ -1,34 +1,32 @@
 /**
  * This package contains code generated from the Temporal `sdk-core` protobuf definitions using [protobufjs](https://www.npmjs.com/package/protobufjs), it is used by the Temporal worker and client packages.
- * 
+ *
  * You will most likely never import this package directly.
- * 
+ *
  * ### Core SDK API
- * 
+ *
  * [Core SDK](https://github.com/temporalio/sdk-core) interfaces can be accessed in the `coresdk` namespace.
- * 
+ *
  * ```ts
  * import { coresdk } from '@temporalio/proto';
  * const activityTask: coresdk.activity_task.IActivityTask = { ... };
  * ```
- * 
+ *
  * 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).
- * 
+ *
  * ### Temporal Service API
- * 
+ *
  * Temporal API interfaces - used to communicate with the Temporal service - can be accessed in the `temporal` namespace.
- * 
+ *
  * ```ts
  * import { temporal } from '@temporalio/proto';
  * const retryPolicy: temporal.api.common.v1.IRetryPolicy = { ... };
  * ```
- * 
+ *
  * 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).
- * 
+ *
  * The gRPC service methods are documented in the proto comments and in the corresponding [`tctl` docs](https://docs.temporal.io/docs/tctl/).
  * @module
  */
 
-export { coresdk } from './coresdk';
-export * from './temporal';
-
+export * from './root';

package/protos/index.js

@@ -0,0 +1 @@
+module.exports = require('./root');