ts-proto 1.147.2 → 1.148.0

package/README.markdown

@@ -78,7 +78,7 @@ It will also generate client implementations of `PingService`; currently [Twirp]
 - `npm install ts-proto`
 - `protoc --plugin=./node_modules/.bin/protoc-gen-ts_proto --ts_proto_out=. ./simple.proto`
   - (Note that the output parameter name, `ts_proto_out`, is named based on the suffix of the plugin's name, i.e. "ts_proto" suffix in the `--plugin=./node_modules/.bin/protoc-gen-ts_proto` parameter becomes the `_out` prefix, per `protoc`'s CLI conventions.)
-  - On Windows, use `protoc --plugin=protoc-gen-ts_proto=.\node_modules\.bin\protoc-gen-ts_proto.cmd --ts_proto_out=. ./simple.proto` (see [#93](https://github.com/stephenh/ts-proto/issues/93))
+  - On Windows, use `protoc --plugin=protoc-gen-ts_proto=".\\node_modules\\.bin\\protoc-gen-ts_proto.cmd" --ts_proto_out=. ./simple.proto` (see [#93](https://github.com/stephenh/ts-proto/issues/93))
   - Ensure you're using a modern `protoc`, i.e. the original `protoc` `3.0.0` doesn't support the `_opt` flag
 
 This will generate `*.ts` source files for the given `*.proto` types.
@@ -509,6 +509,10 @@ Generated code will be placed in the Gradle build directory.
   Extension encode/decode methods are compliant with the `outputEncodeMethods` option, and if `unknownFields=true`,
   the `setExtension` and `getExtension` methods will be created for extendable messages, also compliant with `outputEncodeMethods` (setExtension = encode, getExtension = decode).
 
+- With `--ts_proto_opt=outputIndex=true`, index files will be generated based on the proto package namespaces.
+
+  This will disable `exportCommonSymbols` to avoid name collisions on the common symbols.
+
 ### NestJS Support
 
 We have a great way of working together with [nestjs](https://docs.nestjs.com/microservices/grpc). `ts-proto` generates `interfaces` and `decorators` for you controller, client. For more information see the [nestjs readme](NESTJS.markdown).

package/build/generate-grpc-web.js

@@ -214,12 +214,10 @@ function createPromiseUnaryMethod(ctx) {
     const { useAbortSignal } = options;
     const maybeAbortSignal = useAbortSignal
         ? `
-      const abortHandler = () => {
+      if (abortSignal) abortSignal.addEventListener("abort", () => {
         client.close();
-        reject(new Error("Aborted"));
-      }
-
-      if (abortSignal) abortSignal.addEventListener("abort", abortHandler);`
+        reject(abortSignal.reason);
+      });`
         : "";
     return (0, ts_poet_1.code) `
     unary<T extends UnaryMethodDefinitionish>(
@@ -260,11 +258,10 @@ function createObservableUnaryMethod(ctx) {
     const { useAbortSignal } = options;
     const maybeAbortSignal = useAbortSignal
         ? `
-      const abortHandler = () => {
-        observer.error("Aborted");
+      if (abortSignal) abortSignal.addEventListener("abort", () => {
+        observer.error(abortSignal.reason);
         client.close();
-      };
-      if (abortSignal) abortSignal.addEventListener("abort", abortHandler);`
+      });`
         : "";
     return (0, ts_poet_1.code) `
     unary<T extends UnaryMethodDefinitionish>(
@@ -308,11 +305,10 @@ function createInvokeMethod(ctx) {
     const { useAbortSignal } = options;
     const maybeAbortSignal = useAbortSignal
         ? `
-      const abortHandler = () => {
-        observer.error("Aborted");
+      if (abortSignal) abortSignal.addEventListener("abort", () => {
+        observer.error(abortSignal.reason);
         client.close();
-      };
-      if (abortSignal) abortSignal.addEventListener("abort", abortHandler);`
+      });`
         : "";
     return (0, ts_poet_1.code) `
     invoke<T extends UnaryMethodDefinitionish>(

package/build/main.js

@@ -507,15 +507,15 @@ function makeTimestampMethods(options, longs) {
     const fromTimestamp = (0, ts_poet_1.conditionalOutput)("fromTimestamp", options.useDate === options_1.DateOption.STRING
         ? (0, ts_poet_1.code) `
           function fromTimestamp(t: ${Timestamp}): string {
-            let millis = ${toNumberCode} * 1_000;
-            millis += t.nanos / 1_000_000;
+            let millis = (${toNumberCode} || 0) * 1_000;
+            millis += (t.nanos || 0) / 1_000_000;
             return new Date(millis).toISOString();
           }
         `
         : (0, ts_poet_1.code) `
           function fromTimestamp(t: ${Timestamp}): Date {
-            let millis = ${toNumberCode} * 1_000;
-            millis += t.nanos / 1_000_000;
+            let millis = (${toNumberCode} || 0) * 1_000;
+            millis += (t.nanos || 0) / 1_000_000;
             return new Date(millis);
           }
         `);

package/build/options.js

@@ -80,6 +80,7 @@ function defaultOptions() {
         useReadonlyTypes: false,
         useSnakeTypeName: true,
         outputExtensions: false,
+        outputIndex: false,
         M: {},
     };
 }
@@ -160,6 +161,9 @@ function optionsFromParameter(parameter) {
     if (options.nestJs) {
         options.initializeFieldsAsUndefined = false;
     }
+    if (options.outputIndex) {
+        options.exportCommonSymbols = false;
+    }
     return options;
 }
 exports.optionsFromParameter = optionsFromParameter;

package/build/plugin.js

@@ -33,6 +33,12 @@ async function main() {
         const content = code.toString({ ...(0, options_1.getTsPoetOpts)(options), path });
         files.push({ name: path, content });
     }
+    if (options.outputIndex) {
+        for (const [path, code] of (0, utils_1.generateIndexFiles)(filesToGenerate, options)) {
+            const content = code.toString({ ...(0, options_1.getTsPoetOpts)(options), path });
+            files.push({ name: path, content });
+        }
+    }
     const response = ts_proto_descriptors_1.CodeGeneratorResponse.fromPartial({
         file: files,
         supportedFeatures: ts_proto_descriptors_1.CodeGeneratorResponse_Feature.FEATURE_PROTO3_OPTIONAL,

package/build/utils.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.impProto = exports.impFile = exports.getPropertyAccessor = exports.getFieldJsonName = exports.FormattedMethodDescriptor = exports.assertInstanceOf = exports.maybePrefixPackage = exports.prefixDisableLinter = exports.maybeAddComment = exports.upperFirst = exports.lowerFirst = exports.singular = exports.fail = exports.readToBuffer = exports.protoFilesToGenerate = void 0;
+exports.impProto = exports.impFile = exports.getPropertyAccessor = exports.getFieldJsonName = exports.FormattedMethodDescriptor = exports.assertInstanceOf = exports.maybePrefixPackage = exports.prefixDisableLinter = exports.maybeAddComment = exports.upperFirst = exports.lowerFirst = exports.singular = exports.fail = exports.readToBuffer = exports.generateIndexFiles = exports.protoFilesToGenerate = void 0;
+const path = require("path");
 const ts_poet_1 = require("ts-poet");
 const options_1 = require("./options");
 const case_1 = require("./case");
@@ -8,6 +9,40 @@ function protoFilesToGenerate(request) {
     return request.protoFile.filter((f) => request.fileToGenerate.includes(f.name));
 }
 exports.protoFilesToGenerate = protoFilesToGenerate;
+function generateIndexFiles(files, options) {
+    const packageTree = {
+        index: "index.ts",
+        leaves: {},
+        chunks: [],
+    };
+    for (const { name, package: pkg } of files) {
+        const moduleName = name.replace(".proto", options.fileSuffix);
+        const pkgParts = pkg.length > 0 ? pkg.split(".") : [];
+        const branch = pkgParts.reduce((branch, part, i) => {
+            if (!(part in branch.leaves)) {
+                const prePkgParts = pkgParts.slice(0, i + 1);
+                const index = `index.${prePkgParts.join(".")}.ts`;
+                branch.chunks.push((0, ts_poet_1.code) `export * as ${part} from "./${path.basename(index, ".ts")}";`);
+                branch.leaves[part] = {
+                    index,
+                    leaves: {},
+                    chunks: [],
+                };
+            }
+            return branch.leaves[part];
+        }, packageTree);
+        branch.chunks.push((0, ts_poet_1.code) `export * from "./${moduleName}";`);
+    }
+    const indexFiles = [];
+    let branches = [packageTree];
+    let currentBranch;
+    while ((currentBranch = branches.pop())) {
+        indexFiles.push([currentBranch.index, (0, ts_poet_1.joinCode)(currentBranch.chunks)]);
+        branches.push(...Object.values(currentBranch.leaves));
+    }
+    return indexFiles;
+}
+exports.generateIndexFiles = generateIndexFiles;
 function readToBuffer(stream) {
     return new Promise((resolve) => {
         const ret = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-proto",
-  "version": "1.147.2",
+  "version": "1.148.0",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",