ts-proto 1.92.1 → 1.93.2

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+## [1.93.2](https://github.com/stephenh/ts-proto/compare/v1.93.1...v1.93.2) (2021-12-09)
+
+
+### Bug Fixes
+
+* standalone dockerized protoc alias ([#438](https://github.com/stephenh/ts-proto/issues/438)) ([466f7d9](https://github.com/stephenh/ts-proto/commit/466f7d91551c6297fc1b9677f7a5839f8cdba0c6))
+
+## [1.93.1](https://github.com/stephenh/ts-proto/compare/v1.93.0...v1.93.1) (2021-12-08)
+
+
+### Bug Fixes
+
+* Unwrap google.protobuf.BytesValue to Buffer when env=node ([#439](https://github.com/stephenh/ts-proto/issues/439)) ([73aa836](https://github.com/stephenh/ts-proto/commit/73aa8368300818068f3cddc5f046d990c66ab4f2))
+
+# [1.93.0](https://github.com/stephenh/ts-proto/compare/v1.92.2...v1.93.0) (2021-12-08)
+
+
+### Features
+
+* Allow optional suffix for generated files ([#431](https://github.com/stephenh/ts-proto/issues/431)) ([d826966](https://github.com/stephenh/ts-proto/commit/d826966f22830920444963b3894ffc0be9b7c319))
+
+## [1.92.2](https://github.com/stephenh/ts-proto/compare/v1.92.1...v1.92.2) (2021-12-08)
+
+
+### Bug Fixes
+
+* noImplicitReturns error in Value.unwrap ([#436](https://github.com/stephenh/ts-proto/issues/436)) ([2d7a5d0](https://github.com/stephenh/ts-proto/commit/2d7a5d04c72ace58fa3a6745c3857f6cc0468543)), closes [#432](https://github.com/stephenh/ts-proto/issues/432)
+
 ## [1.92.1](https://github.com/stephenh/ts-proto/compare/v1.92.0...v1.92.1) (2021-12-02)
 
 

package/README.markdown

@@ -9,25 +9,29 @@
 
 ## Table of contents
 
+- [ts-proto](#ts-proto)
+  - [Table of contents](#table-of-contents)
+- [Overview](#overview)
 - [QuickStart](#quickstart)
 - [Goals](#goals)
 - [Example Types](#example-types)
 - [Highlights](#highlights)
 - [Auto-Batching / N+1 Prevention](#auto-batching--n1-prevention)
 - [Usage](#usage)
-  - [Supported options](#supported-options)
-  - [Only Types](#only-types)
-  - [NestJS Support](NESTJS.markdown)
+    - [Supported options](#supported-options)
+    - [Only Types](#only-types)
+    - [NestJS Support](#nestjs-support)
+    - [Watch Mode](#watch-mode)
+- [Sponsors](#sponsors)
 - [Development](#development)
 - [Assumptions](#assumptions)
 - [Todo](#todo)
 - [OneOf Handling](#oneof-handling)
-- [Default Values and Unset Fields](#default-values-and-unset-fields)
+- [Default values and unset fields](#default-values-and-unset-fields)
 - [Well-Known Types](#well-known-types)
   - [Wrapper Types](#wrapper-types)
   - [JSON Types (Struct Types)](#json-types-struct-types)
   - [Timestamp](#timestamp)
-- [Wrapper Types](#wrapper-types)
 - [Number Types](#number-types)
 - [Current Status of Optional Values](#current-status-of-optional-values)
 
@@ -344,6 +348,8 @@ Generated code will be placed in the Gradle build directory.
 - With `--ts_proto_opt=emitImportedFiles=false`, ts-proto will not emit `google/protobuf/*` files unless you explicit add files to `protoc` like this
 `protoc --plugin=./node_modules/.bin/protoc-gen-ts_proto my_message.proto google/protobuf/duration.proto`
 
+- With `--ts_proto_opt=fileSuffix=<SUFFIX>`, ts-proto will emit generated files using the specified suffix. A `helloworld.proto` file with `fileSuffix=.pb` would be generated as `helloworld.pb.ts`. This is common behavior in other protoc plugins and provides a way to quickly glob all the generated files. 
+
 ### Only Types
 
 If you're looking for `ts-proto` to generate only types for your Protobuf types then passing all three of `outputEncodeMethods`, `outputJsonMethods`, and `outputClientImpl` as `false` is probably what you want, i.e.:
@@ -354,6 +360,15 @@ If you're looking for `ts-proto` to generate only types for your Protobuf types
 
 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).
 
+### Watch Mode
+
+If you want to run `ts-proto` on every change of a proto file, you'll need to use a tool like [chokidar-cli](https://www.npmjs.com/package/chokidar-cli) and use it as a script in `package.json`:
+
+```json
+"proto:generate": "protoc --ts_proto_out=. ./<proto_path>/<proto_name>.proto --ts_proto_opt=esModuleInterop=true",
+"proto:watch": "chokidar \"**/*.proto\" -c \"npm run proto:generate\""
+```
+
 # Sponsors
 
 Kudos to our sponsors:

package/build/encode.js

@@ -4,24 +4,25 @@ exports.generateDecoder = exports.generateEncoder = void 0;
 const ts_poet_1 = require("ts-poet");
 const types_1 = require("./types");
 const options_1 = require("./options");
+const utils_1 = require("./utils");
 function generateEncoder(ctx, typeName) {
     const name = types_1.wrapperTypeName(typeName);
     if (!name) {
         return ts_poet_1.code `${types_1.messageToTypeName(ctx, typeName, { keepValueType: true })}.encode(value).finish()`;
     }
     if (name == 'Timestamp') {
-        const TimestampValue = ts_poet_1.imp(`${name}@./google/protobuf/timestamp`);
+        const TimestampValue = utils_1.impProto(ctx.options, 'google/protobuf/timestamp', name);
         return ts_poet_1.code `${TimestampValue}.encode(${ctx.utils.toTimestamp}(value)).finish()`;
     }
     if (name == 'Struct') {
-        const StructType = ts_poet_1.imp(`${name}@./google/protobuf/struct`);
+        const StructType = utils_1.impProto(ctx.options, 'google/protobuf/struct', name);
         return ts_poet_1.code `${StructType}.encode(${StructType}.wrap(value)).finish()`;
     }
     if (name == 'ListValue') {
-        const ListValueType = ts_poet_1.imp(`${name}@./google/protobuf/struct`);
+        const ListValueType = utils_1.impProto(ctx.options, 'google/protobuf/struct', name);
         return ts_poet_1.code `${ListValueType}.encode({values: value ?? []}).finish()`;
     }
-    const TypeValue = ts_poet_1.imp(`${name}@./google/protobuf/wrappers`);
+    const TypeValue = utils_1.impProto(ctx.options, 'google/protobuf/wrappers', name);
     switch (name) {
         case 'StringValue':
             return ts_poet_1.code `${TypeValue}.encode({value: value ?? ""}).finish()`;
@@ -45,20 +46,21 @@ function generateEncoder(ctx, typeName) {
 }
 exports.generateEncoder = generateEncoder;
 function generateDecoder(ctx, typeName) {
+    const { options } = ctx;
     let name = types_1.wrapperTypeName(typeName);
     if (!name) {
         return ts_poet_1.code `${types_1.messageToTypeName(ctx, typeName, { keepValueType: true })}.decode(value)`;
     }
     let TypeValue;
     if (name == 'Timestamp') {
-        TypeValue = ts_poet_1.imp(`${name}@./google/protobuf/timestamp`);
+        TypeValue = utils_1.impProto(ctx.options, 'google/protobuf/timestamp', name);
         return ts_poet_1.code `${TypeValue}.decode(value)`;
     }
     if (name == 'Struct' || name == 'ListValue') {
-        TypeValue = ts_poet_1.imp(`${name}@./google/protobuf/struct`);
+        TypeValue = utils_1.impProto(ctx.options, 'google/protobuf/struct', name);
         return ts_poet_1.code `${TypeValue}.unwrap(${TypeValue}.decode(value))`;
     }
-    TypeValue = ts_poet_1.imp(`${name}@./google/protobuf/wrappers`);
+    TypeValue = utils_1.impProto(ctx.options, 'google/protobuf/wrappers', name);
     return ts_poet_1.code `${TypeValue}.decode(value).value`;
 }
 exports.generateDecoder = generateDecoder;

package/build/main.js

@@ -30,7 +30,8 @@ function generateFile(ctx, fileDesc) {
     //
     // We'll also assume that the fileDesc.name is already the `company/foo.proto` path, with
     // the package already implicitly in it, so we won't re-append/strip/etc. it out/back in.
-    const moduleName = fileDesc.name.replace('.proto', '.ts');
+    const suffix = `${options.fileSuffix}.ts`;
+    const moduleName = fileDesc.name.replace('.proto', suffix);
     const chunks = [];
     // Indicate this file's source protobuf package for reflective use with google.protobuf.Any
     if (options.exportCommonSymbols) {
@@ -316,7 +317,7 @@ function makeDeepPartial(options, longs) {
     return { Builtin, DeepPartial, Exact };
 }
 function makeTimestampMethods(options, longs) {
-    const Timestamp = ts_poet_1.imp('Timestamp@./google/protobuf/timestamp');
+    const Timestamp = utils_1.impProto(options, 'google/protobuf/timestamp', 'Timestamp');
     let seconds = 'date.getTime() / 1_000';
     let toNumberCode = 't.seconds';
     if (options.forceLong === options_1.LongOption.LONG) {
@@ -530,7 +531,7 @@ function generateDecode(ctx, fullName, messageDesc) {
             }
             else if (types_1.isEnum(field)) {
                 if (options.stringEnums) {
-                    const fromJson = types_1.getEnumMethod(typeMap, field.typeName, 'FromJSON');
+                    const fromJson = types_1.getEnumMethod(ctx, field.typeName, 'FromJSON');
                     readSnippet = ts_poet_1.code `${fromJson}(${readSnippet})`;
                 }
                 else {
@@ -629,7 +630,7 @@ function generateEncode(ctx, fullName, messageDesc) {
         let writeSnippet;
         if (types_1.isEnum(field) && options.stringEnums) {
             const tag = ((field.number << 3) | types_1.basicWireType(field.type)) >>> 0;
-            const toNumber = types_1.getEnumMethod(typeMap, field.typeName, 'ToNumber');
+            const toNumber = types_1.getEnumMethod(ctx, field.typeName, 'ToNumber');
             writeSnippet = (place) => ts_poet_1.code `writer.uint32(${tag}).${types_1.toReaderCall(field)}(${toNumber}(${place}))`;
         }
         else if (types_1.isScalar(field) || types_1.isEnum(field)) {
@@ -691,7 +692,7 @@ function generateEncode(ctx, fullName, messageDesc) {
                 // embedded inside of it, and we want to drop that so that we can encode it packed
                 // (i.e. just one tag and multiple values).
                 const tag = ((field.number << 3) | 2) >>> 0;
-                const toNumber = types_1.getEnumMethod(typeMap, field.typeName, 'ToNumber');
+                const toNumber = types_1.getEnumMethod(ctx, field.typeName, 'ToNumber');
                 chunks.push(ts_poet_1.code `
           writer.uint32(${tag}).fork();
           for (const v of message.${fieldName}) {
@@ -771,7 +772,7 @@ function generateFromJson(ctx, fullName, messageDesc) {
         // get a generic 'reader.doSomething' bit that is specific to the basic type
         const readSnippet = (from) => {
             if (types_1.isEnum(field)) {
-                const fromJson = types_1.getEnumMethod(typeMap, field.typeName, 'FromJSON');
+                const fromJson = types_1.getEnumMethod(ctx, field.typeName, 'FromJSON');
                 return ts_poet_1.code `${fromJson}(${from})`;
             }
             else if (types_1.isPrimitive(field)) {
@@ -943,7 +944,7 @@ function generateToJson(ctx, fullName, messageDesc) {
         const jsonName = utils_1.determineFieldJsonName(field, options);
         const readSnippet = (from) => {
             if (types_1.isEnum(field)) {
-                const toJson = types_1.getEnumMethod(typeMap, field.typeName, 'ToJSON');
+                const toJson = types_1.getEnumMethod(ctx, field.typeName, 'ToJSON');
                 return types_1.isWithinOneOf(field)
                     ? ts_poet_1.code `${from} !== undefined ? ${toJson}(${from}) : undefined`
                     : ts_poet_1.code `${toJson}(${from})`;
@@ -961,7 +962,7 @@ function generateToJson(ctx, fullName, messageDesc) {
                 // For map types, drill-in and then admittedly re-hard-code our per-value-type logic
                 const valueType = typeMap.get(field.typeName)[2].field[1];
                 if (types_1.isEnum(valueType)) {
-                    const toJson = types_1.getEnumMethod(typeMap, valueType.typeName, 'ToJSON');
+                    const toJson = types_1.getEnumMethod(ctx, valueType.typeName, 'ToJSON');
                     return ts_poet_1.code `${toJson}(${from})`;
                 }
                 else if (types_1.isBytes(valueType)) {
@@ -1052,7 +1053,7 @@ function generateToJson(ctx, fullName, messageDesc) {
 function generateFromPartial(ctx, fullName, messageDesc) {
     const { options, utils, typeMap } = ctx;
     const chunks = [];
-    const Timestamp = ts_poet_1.imp('Timestamp@./google/protobuf/timestamp');
+    const Timestamp = utils_1.impProto(options, 'google/protobuf/timestamp', 'Timestamp');
     // create the basic function declaration
     const paramName = messageDesc.field.length > 0 ? 'object' : '_';
     chunks.push(ts_poet_1.code `
@@ -1222,19 +1223,20 @@ function generateUnwrap(fullProtoTypeName) {
     }
     if (types_1.isAnyValueTypeName(fullProtoTypeName)) {
         chunks.push(ts_poet_1.code `unwrap(message: Value): string | number | boolean | Object | null | Array<any> | undefined {
-      if (message.stringValue !== undefined) {
+      if (message?.stringValue !== undefined) {
         return message.stringValue;
-      } else if (message.numberValue !== undefined) {
+      } else if (message?.numberValue !== undefined) {
         return message.numberValue;
-      } else if (message.boolValue !== undefined) {
+      } else if (message?.boolValue !== undefined) {
         return message.boolValue;
-      } else if (message.structValue !== undefined) {
+      } else if (message?.structValue !== undefined) {
         return message.structValue;
-      } else if (message.listValue !== undefined) {
+      } else if (message?.listValue !== undefined) {
           return message.listValue;
-      } else if (message.nullValue !== undefined) {
+      } else if (message?.nullValue !== undefined) {
         return null;
       }
+      return undefined;
     }`);
     }
     if (types_1.isListValueTypeName(fullProtoTypeName)) {

package/build/options.js

@@ -40,6 +40,7 @@ function defaultOptions() {
         useDate: DateOption.DATE,
         oneof: OneofOption.PROPERTIES,
         esModuleInterop: false,
+        fileSuffix: '',
         lowerCaseServiceMethods: false,
         outputEncodeMethods: true,
         outputJsonMethods: true,

package/build/types.js

@@ -411,7 +411,7 @@ function valueTypeName(ctx, typeName) {
         case '.google.protobuf.BoolValue':
             return ts_poet_1.code `boolean`;
         case '.google.protobuf.BytesValue':
-            return ts_poet_1.code `Uint8Array`;
+            return ctx.options.env === options_1.EnvOption.NODE ? ts_poet_1.code `Buffer` : ts_poet_1.code `Uint8Array`;
         case '.google.protobuf.ListValue':
             return ts_poet_1.code `Array<any>`;
         case '.google.protobuf.Value':
@@ -481,16 +481,16 @@ function messageToTypeName(ctx, protoType, typeOptions = {}) {
         }
     }
     const [module, type] = toModuleAndType(typeMap, protoType);
-    return ts_poet_1.code `${ts_poet_1.imp(`${type}@./${module}`)}`;
+    return ts_poet_1.code `${utils_1.impProto(options, module, type)}`;
 }
 exports.messageToTypeName = messageToTypeName;
 /** Breaks `.some_proto_namespace.Some.Message` into `['some_proto_namespace', 'Some_Message', Descriptor]. */
 function toModuleAndType(typeMap, protoType) {
     return typeMap.get(protoType) || utils_1.fail(`No type found for ${protoType}`);
 }
-function getEnumMethod(typeMap, enumProtoType, methodSuffix) {
-    const [module, type] = toModuleAndType(typeMap, enumProtoType);
-    return ts_poet_1.imp(`${case_1.camelCase(type)}${methodSuffix}@./${module}`);
+function getEnumMethod(ctx, enumProtoType, methodSuffix) {
+    const [module, type] = toModuleAndType(ctx.typeMap, enumProtoType);
+    return utils_1.impProto(ctx.options, module, `${case_1.camelCase(type)}${methodSuffix}`);
 }
 exports.getEnumMethod = getEnumMethod;
 /** Return the TypeName for any field (primitive/message/etc.) as exposed in the interface. */

package/build/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.determineFieldJsonName = 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.determineFieldJsonName = exports.FormattedMethodDescriptor = exports.assertInstanceOf = exports.maybePrefixPackage = exports.prefixDisableLinter = exports.maybeAddComment = exports.upperFirst = exports.lowerFirst = exports.singular = exports.fail = exports.readToBuffer = exports.protoFilesToGenerate = void 0;
 const ts_poet_1 = require("ts-poet");
 const options_1 = require("./options");
 const case_1 = require("./case");
@@ -153,3 +153,7 @@ function determineFieldJsonName(field, options) {
     return case_1.maybeSnakeToCamel(field.name, options);
 }
 exports.determineFieldJsonName = determineFieldJsonName;
+function impProto(options, module, type) {
+    return ts_poet_1.imp(`${type}@./${module}${options.fileSuffix}`);
+}
+exports.impProto = impProto;

package/package.json

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