ts-proto 1.92.2 → 1.93.3

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+## [1.93.3](https://github.com/stephenh/ts-proto/compare/v1.93.2...v1.93.3) (2021-12-13)
+
+
+### Bug Fixes
+
+* support mutliple options in snakeToCamel flag  ([#429](https://github.com/stephenh/ts-proto/issues/429)) ([cff6674](https://github.com/stephenh/ts-proto/commit/cff667406cba21676546fd91b04cf2cbc571ed7d)), closes [#423](https://github.com/stephenh/ts-proto/issues/423)
+
+## [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)
 
 

package/README.markdown

@@ -289,9 +289,7 @@ Generated code will be placed in the Gradle build directory.
 
 - With `--ts_proto_opt=lowerCaseServiceMethods=true`, the method names of service methods will be lowered/camel-case, i.e. `service.findFoo` instead of `service.FindFoo`.
 
-- With `--ts_proto_opt=snakeToCamel=false`, fields will be kept snake case.
-
-  Defaults to `true`.
+- With `--ts_proto_opt=snakeToCamel=false`, fields will be kept snake case. `snakeToCamel` can also be set as string with `--ts_proto_opt=snakeToCamel=keys,json`. `keys` will keep field names as camelCase and `json` will keep json field names as camelCase. Empty string will keep field names as snake_case.
 
 - With `--ts_proto_opt=outputEncodeMethods=false`, the `Message.encode` and `Message.decode` methods for working with protobuf-encoded/binary data will not be output.
 
@@ -348,6 +346,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.:

package/build/case.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.camelCase = exports.capitalize = exports.camelToSnake = exports.maybeSnakeToCamel = void 0;
+exports.camelCase = exports.capitalize = exports.camelToSnake = exports.stringToSnakeCase = exports.maybeSnakeToCamel = void 0;
 function maybeSnakeToCamel(s, options) {
-    if (options.snakeToCamel && s.includes('_')) {
+    const fromStringSnakeToCamel = typeof options.snakeToCamel === 'string' && options.snakeToCamel.includes('keys');
+    const fromBooleanSnakeToCamel = options.snakeToCamel === true;
+    if ((fromBooleanSnakeToCamel || fromStringSnakeToCamel) && s.includes('_')) {
         return s
             .split('_')
             .map((word, i) => {
@@ -21,6 +23,10 @@ function maybeSnakeToCamel(s, options) {
     }
 }
 exports.maybeSnakeToCamel = maybeSnakeToCamel;
+function stringToSnakeCase(s) {
+    return s.replace(/([a-z])([A-Z])/g, '$1_$2').toLowerCase();
+}
+exports.stringToSnakeCase = stringToSnakeCase;
 function camelToSnake(s) {
     return s
         .replace(/[\w]([A-Z])/g, function (m) {

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 `

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");
@@ -147,9 +147,15 @@ exports.FormattedMethodDescriptor = FormattedMethodDescriptor;
 function determineFieldJsonName(field, options) {
     // By default jsonName is camelCased by the protocol compilier unless the user has
     // set a "json_name" option on this field.
-    if (field.jsonName.length > 0) {
+    const fromStringSnakeToCamel = typeof options.snakeToCamel === 'string' && options.snakeToCamel.includes('json');
+    const fromBooleanSnakeToCamel = options.snakeToCamel === true;
+    if (fromBooleanSnakeToCamel || fromStringSnakeToCamel) {
         return field.jsonName;
     }
-    return case_1.maybeSnakeToCamel(field.name, options);
+    return case_1.stringToSnakeCase(field.name);
 }
 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.2",
+  "version": "1.93.3",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",