ts-proto 1.104.1 → 1.106.0

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+# [1.106.0](https://github.com/stephenh/ts-proto/compare/v1.105.2...v1.106.0) (2022-02-21)
+
+
+### Features
+
+* Support json names containing non-alphanumeric characters ([#520](https://github.com/stephenh/ts-proto/issues/520)) ([ce44668](https://github.com/stephenh/ts-proto/commit/ce44668b8fe01b14f50ac3c5c950f73db769fa76))
+
+## [1.105.2](https://github.com/stephenh/ts-proto/compare/v1.105.1...v1.105.2) (2022-02-17)
+
+
+### Bug Fixes
+
+* Fix snakeToCamel single value parsing. ([#513](https://github.com/stephenh/ts-proto/issues/513)) ([e1ad866](https://github.com/stephenh/ts-proto/commit/e1ad866c95751c37ed13f02f4da2dc9076ab4758))
+
+## [1.105.1](https://github.com/stephenh/ts-proto/compare/v1.105.0...v1.105.1) (2022-02-14)
+
+
+### Bug Fixes
+
+* generate canonical JSON encoding for FieldMasks ([#510](https://github.com/stephenh/ts-proto/issues/510)) ([0ec4e97](https://github.com/stephenh/ts-proto/commit/0ec4e97a2649dc15af1c925f8a2ff6adf1e17d9b))
+
+# [1.105.0](https://github.com/stephenh/ts-proto/compare/v1.104.1...v1.105.0) (2022-02-12)
+
+
+### Features
+
+* Bump ts-proto-descriptors. ([#489](https://github.com/stephenh/ts-proto/issues/489)) ([d454448](https://github.com/stephenh/ts-proto/commit/d454448b1889b1576c1ebcc6964a55a03af7d921)), closes [#493](https://github.com/stephenh/ts-proto/issues/493)
+
 ## [1.104.1](https://github.com/stephenh/ts-proto/compare/v1.104.0...v1.104.1) (2022-02-12)
 
 

package/README.markdown

@@ -23,6 +23,7 @@
     - [Only Types](#only-types)
     - [NestJS Support](#nestjs-support)
     - [Watch Mode](#watch-mode)
+    - [Basic gRPC implementation](#basic-grpc-implementation)
 - [Sponsors](#sponsors)
 - [Development](#development)
 - [Assumptions](#assumptions)
@@ -331,7 +332,7 @@ Generated code will be placed in the Gradle build directory.
 
   (Note that this only uses the grpc-web runtime, you don't need to use any of their generated code, i.e. the ts-proto output replaces their `ts-protoc-gen` output.)
 
-  You'll need to add the `@improbable-eng/grpc-web` and a transport to your project's `package.json`; see the `integration/grpc-web` directory for a working example.
+  You'll need to add the `@improbable-eng/grpc-web` and a transport to your project's `package.json`; see the `integration/grpc-web` directory for a working example. Also see [#504](https://github.com/stephenh/ts-proto/issues/504) for integrating with [grpc-web-devtools](https://github.com/SafetyCulture/grpc-web-devtools).
 
 - With `--ts_proto_opt=returnObservable=true`, the return type of service methods will be `Observable<T>` instead of `Promise<T>`.
 
@@ -406,6 +407,51 @@ If you want to run `ts-proto` on every change of a proto file, you'll need to us
 "proto:watch": "chokidar \"**/*.proto\" -c \"npm run proto:generate\""
 ```
 
+### Basic gRPC implementation
+
+`ts-proto` is RPC framework agnostic - how you transmit your data to and from
+your data source is up to you. The generated client implementations all expect
+a `rpc` parameter, which type is defined like this: 
+
+```ts
+interface Rpc {
+  request(service: string, method: string, data: Uint8Array): Promise<Uint8Array>;
+}
+```
+
+If you're working with gRPC, a simple implementation could look like this: 
+
+```ts
+type RpcImpl = (service: string, method: string, data: Uint8Array) => Promise<Uint8Array>;
+
+const sendRequest: RpcImpl = (service, method, data) => {
+  // Conventionally in gRPC, the request path looks like
+  //   "package.names.ServiceName/MethodName",
+  // we therefore construct such a string
+  const path = `${service}/${method}`;
+
+  return new Promise((resolve, reject) => {
+    // makeUnaryRequest transmits the result (and error) with a callback
+    // transform this into a promise!
+    const resultCallback: UnaryCallback<any> = (err, res) => {
+      if (err) {
+        return reject(err);
+      }
+      resolve(res);
+    };
+
+    function passThrough(argument: any) {
+      return argument;
+    }
+
+    // Using passThrough as the serialize and deserialize functions
+    conn.makeUnaryRequest(path, passThrough, passThrough, data, resultCallback);
+  });
+};
+
+const rpc: Rpc = { request: sendRequest }
+```
+
 # Sponsors
 
 Kudos to our sponsors:
@@ -591,6 +637,7 @@ Their interpretation is defined by the Protobuf specification, and libraries are
   * [google.protobuf.Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#Value)  &lrarr; `any | undefined` (i.e. `number | string | boolean | null | array | object`)
   * [google.protobuf.ListValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#ListValue) &lrarr; `any[]`
   * [google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#Struct) &lrarr; `{ [key: string]: any } | undefined`
+  * [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask) &lrarr; `string[]` (only in the JSON, `FieldMask` is still a message)
 
 ## Wrapper Types
 

package/build/main.js

@@ -895,7 +895,8 @@ function generateFromJson(ctx, fullName, messageDesc) {
     // add a check for each incoming field
     messageDesc.field.forEach((field) => {
         const fieldName = case_1.maybeSnakeToCamel(field.name, options);
-        const jsonName = utils_1.determineFieldJsonName(field, options);
+        const jsonName = utils_1.getFieldJsonName(field, options);
+        const jsonProperty = utils_1.getPropertyAccessor('object', jsonName);
         // get code that extracts value from incoming object
         const readSnippet = (from) => {
             if (types_1.isEnum(field)) {
@@ -934,6 +935,9 @@ function generateFromJson(ctx, fullName, messageDesc) {
             else if (types_1.isAnyValueType(field) || types_1.isStructType(field)) {
                 return ts_poet_1.code `${from}`;
             }
+            else if (types_1.isFieldMaskType(field)) {
+                return ts_poet_1.code `{paths: ${from}.split(",")}`;
+            }
             else if (types_1.isListValueType(field)) {
                 return ts_poet_1.code `[...${from}]`;
             }
@@ -1010,8 +1014,8 @@ function generateFromJson(ctx, fullName, messageDesc) {
                 const fieldType = types_1.toTypeName(ctx, messageDesc, field);
                 const i = maybeCastToNumber(ctx, messageDesc, field, 'key');
                 chunks.push(ts_poet_1.code `
-          ${fieldName}: ${ctx.utils.isObject}(object.${jsonName})
-            ? Object.entries(object.${jsonName}).reduce<${fieldType}>((acc, [key, value]) => {
+          ${fieldName}: ${ctx.utils.isObject}(${jsonProperty})
+            ? Object.entries(${jsonProperty}).reduce<${fieldType}>((acc, [key, value]) => {
                 acc[${i}] = ${readSnippet('value')};
                 return acc;
               }, {})
@@ -1021,12 +1025,12 @@ function generateFromJson(ctx, fullName, messageDesc) {
             else {
                 const readValueSnippet = readSnippet('e');
                 if (readValueSnippet.toString() === ts_poet_1.code `e`.toString()) {
-                    chunks.push(ts_poet_1.code `${fieldName}: Array.isArray(object?.${jsonName}) ? [...object.${jsonName}] : [],`);
+                    chunks.push(ts_poet_1.code `${fieldName}: Array.isArray(object?.${jsonName}) ? [...${jsonProperty}] : [],`);
                 }
                 else {
                     // Explicit `any` type required to make TS with noImplicitAny happy. `object` is also `any` here.
                     chunks.push(ts_poet_1.code `
-            ${fieldName}: Array.isArray(object?.${jsonName}) ? object.${jsonName}.map((e: any) => ${readValueSnippet}): [],
+            ${fieldName}: Array.isArray(object?.${jsonName}) ? ${jsonProperty}.map((e: any) => ${readValueSnippet}): [],
           `);
                 }
             }
@@ -1039,8 +1043,8 @@ function generateFromJson(ctx, fullName, messageDesc) {
                 const fieldName = case_1.maybeSnakeToCamel(messageDesc.oneofDecl[field.oneofIndex].name, options);
                 chunks.push(ts_poet_1.code `${fieldName}: `);
             }
-            const ternaryIf = ts_poet_1.code `${ctx.utils.isSet}(object.${jsonName})`;
-            const ternaryThen = ts_poet_1.code `{ $case: '${fieldName}', ${fieldName}: ${readSnippet(`object.${jsonName}`)}`;
+            const ternaryIf = ts_poet_1.code `${ctx.utils.isSet}(${jsonProperty})`;
+            const ternaryThen = ts_poet_1.code `{ $case: '${fieldName}', ${fieldName}: ${readSnippet(`${jsonProperty}`)}`;
             chunks.push(ts_poet_1.code `${ternaryIf} ? ${ternaryThen}} : `);
             if (field === lastCase) {
                 chunks.push(ts_poet_1.code `undefined,`);
@@ -1048,27 +1052,27 @@ function generateFromJson(ctx, fullName, messageDesc) {
         }
         else if (types_1.isAnyValueType(field)) {
             chunks.push(ts_poet_1.code `${fieldName}: ${ctx.utils.isSet}(object?.${jsonName})
-        ? ${readSnippet(`object.${jsonName}`)}
+        ? ${readSnippet(`${jsonProperty}`)}
         : undefined,
       `);
         }
         else if (types_1.isStructType(field)) {
-            chunks.push(ts_poet_1.code `${fieldName}: ${ctx.utils.isObject}(object.${jsonName})
-          ? ${readSnippet(`object.${jsonName}`)}
+            chunks.push(ts_poet_1.code `${fieldName}: ${ctx.utils.isObject}(${jsonProperty})
+          ? ${readSnippet(`${jsonProperty}`)}
           : undefined,`);
         }
         else if (types_1.isListValueType(field)) {
             chunks.push(ts_poet_1.code `
-        ${fieldName}: Array.isArray(object.${jsonName})
-          ? ${readSnippet(`object.${jsonName}`)}
+        ${fieldName}: Array.isArray(${jsonProperty})
+          ? ${readSnippet(`${jsonProperty}`)}
           : undefined,
       `);
         }
         else {
             const fallback = types_1.isWithinOneOf(field) ? 'undefined' : types_1.defaultValue(ctx, field);
             chunks.push(ts_poet_1.code `
-        ${fieldName}: ${ctx.utils.isSet}(object.${jsonName})
-          ? ${readSnippet(`object.${jsonName}`)}
+        ${fieldName}: ${ctx.utils.isSet}(${jsonProperty})
+          ? ${readSnippet(`${jsonProperty}`)}
           : ${fallback},
       `);
         }
@@ -1089,7 +1093,8 @@ function generateToJson(ctx, fullName, messageDesc) {
     // then add a case for each field
     messageDesc.field.forEach((field) => {
         const fieldName = case_1.maybeSnakeToCamel(field.name, options);
-        const jsonName = utils_1.determineFieldJsonName(field, options);
+        const jsonName = utils_1.getFieldJsonName(field, options);
+        const jsonProperty = utils_1.getPropertyAccessor('obj', jsonName);
         const readSnippet = (from) => {
             if (types_1.isEnum(field)) {
                 const toJson = types_1.getEnumMethod(ctx, field.typeName, 'ToJSON');
@@ -1151,6 +1156,9 @@ function generateToJson(ctx, fullName, messageDesc) {
             else if (types_1.isAnyValueType(field)) {
                 return ts_poet_1.code `${from}`;
             }
+            else if (types_1.isFieldMaskType(field)) {
+                return ts_poet_1.code `${from}.paths.join()`;
+            }
             else if (types_1.isMessage(field) && !types_1.isValueType(ctx, field) && !types_1.isMapType(ctx, messageDesc, field)) {
                 const type = types_1.basicTypeName(ctx, field, { keepValueType: true });
                 return ts_poet_1.code `${from} ? ${type}.toJSON(${from}) : ${types_1.defaultValue(ctx, field)}`;
@@ -1199,11 +1207,11 @@ function generateToJson(ctx, fullName, messageDesc) {
             // oneofs in a union are only output as `oneof name = ...`
             const oneofName = case_1.maybeSnakeToCamel(messageDesc.oneofDecl[field.oneofIndex].name, options);
             const v = readSnippet(`message.${oneofName}?.${fieldName}`);
-            chunks.push(ts_poet_1.code `message.${oneofName}?.$case === '${fieldName}' && (obj.${jsonName} = ${v});`);
+            chunks.push(ts_poet_1.code `message.${oneofName}?.$case === '${fieldName}' && (${jsonProperty} = ${v});`);
         }
         else {
             const v = readSnippet(`message.${fieldName}`);
-            chunks.push(ts_poet_1.code `message.${fieldName} !== undefined && (obj.${jsonName} = ${v});`);
+            chunks.push(ts_poet_1.code `message.${fieldName} !== undefined && (${jsonProperty} = ${v});`);
         }
     });
     chunks.push(ts_poet_1.code `return obj;`);
@@ -1323,7 +1331,7 @@ function generateFromPartial(ctx, fullName, messageDesc) {
           && object.${oneofName}?.${fieldName} !== null
         ) {
           message.${oneofName} = { $case: '${fieldName}', ${fieldName}: ${v} };
-        }  
+        }
       `);
         }
         else if (readSnippet(`x`).toCodeString() == 'x') {
@@ -1362,7 +1370,7 @@ function generateWrap(ctx, fullProtoTypeName) {
         if (ctx.options.oneof === options_1.OneofOption.UNIONS) {
             chunks.push(ts_poet_1.code `wrap(value: any): Value {
         const result = createBaseValue();
-        
+
         if (value === null) {
           result.kind = {$case: 'nullValue', nullValue: NullValue.NULL_VALUE};
         } else if (typeof value === 'boolean') {

package/build/options.js

@@ -111,6 +111,9 @@ function optionsFromParameter(parameter) {
     else if (options.snakeToCamel === true) {
         options.snakeToCamel = ['keys', 'json'];
     }
+    else if (typeof options.snakeToCamel === 'string') {
+        options.snakeToCamel = [options.snakeToCamel];
+    }
     return options;
 }
 exports.optionsFromParameter = optionsFromParameter;
@@ -118,8 +121,14 @@ exports.optionsFromParameter = optionsFromParameter;
 function parseParameter(parameter) {
     const options = {};
     const pairs = parameter.split(',').map((s) => s.split('='));
-    pairs.forEach(([key, value]) => {
-        options[key] = value === 'true' ? true : value === 'false' ? false : value;
+    pairs.forEach(([key, _value]) => {
+        const value = _value === 'true' ? true : _value === 'false' ? false : _value;
+        if (options[key]) {
+            options[key] = [options[key], value];
+        }
+        else {
+            options[key] = value;
+        }
     });
     return options;
 }

package/build/schema.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateSchema = void 0;
+const ts_proto_descriptors_1 = require("ts-proto-descriptors");
 const ts_poet_1 = require("ts-poet");
 const visit_1 = require("./visit");
 const utils_1 = require("./utils");
@@ -36,7 +37,7 @@ function generateSchema(ctx, fileDesc, sourceInfo) {
         return ts_poet_1.code `${ts_poet_1.imp(`protoMetadata@./${dep.replace('.proto', '')}`)}`;
     });
     // Use toObject so that we get enums as numbers (instead of the default toJSON behavior)
-    const descriptor = { ...fileDesc };
+    const descriptor = ts_proto_descriptors_1.FileDescriptorProto.fromPartial(fileDesc);
     // Only keep locations that include comments
     descriptor.sourceCodeInfo = {
         location: ((_a = descriptor.sourceCodeInfo) === null || _a === void 0 ? void 0 : _a.location.filter((loc) => loc['leadingComments'] || loc['trailingComments'])) || [],

package/build/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.detectBatchMethod = exports.responsePromiseOrObservable = exports.responseObservable = exports.responsePromise = exports.responseType = exports.requestType = exports.rawRequestType = exports.detectMapType = exports.toTypeName = exports.getEnumMethod = exports.messageToTypeName = exports.wrapperTypeName = exports.valueTypeName = exports.isEmptyType = exports.isLongValueType = exports.isStructTypeName = exports.isStructType = exports.isListValueTypeName = exports.isListValueType = exports.isBytesValueType = exports.isAnyValueTypeName = exports.isAnyValueType = exports.isValueType = exports.isTimestamp = exports.isObjectId = exports.isMapType = exports.isWholeNumber = exports.isLong = exports.isRepeated = exports.isWithinOneOfThatShouldBeUnion = exports.isWithinOneOf = exports.isEnum = exports.isMessage = exports.isBytes = exports.isPrimitive = exports.isOptionalProperty = exports.isScalar = exports.createTypeMap = exports.notDefaultCheck = exports.defaultValue = exports.packedType = exports.toReaderCall = exports.basicTypeName = exports.basicLongWireType = exports.basicWireType = void 0;
+exports.detectBatchMethod = exports.responsePromiseOrObservable = exports.responseObservable = exports.responsePromise = exports.responseType = exports.requestType = exports.rawRequestType = exports.detectMapType = exports.toTypeName = exports.getEnumMethod = exports.messageToTypeName = exports.wrapperTypeName = exports.valueTypeName = exports.isEmptyType = exports.isLongValueType = exports.isStructTypeName = exports.isStructType = exports.isListValueTypeName = exports.isListValueType = exports.isFieldMaskTypeName = exports.isFieldMaskType = exports.isBytesValueType = exports.isAnyValueTypeName = exports.isAnyValueType = exports.isValueType = exports.isTimestamp = exports.isObjectId = exports.isMapType = exports.isWholeNumber = exports.isLong = exports.isRepeated = exports.isWithinOneOfThatShouldBeUnion = exports.isWithinOneOf = exports.isEnum = exports.isMessage = exports.isBytes = exports.isPrimitive = exports.isOptionalProperty = exports.isScalar = exports.createTypeMap = exports.notDefaultCheck = exports.defaultValue = exports.packedType = exports.toReaderCall = exports.basicTypeName = exports.basicLongWireType = exports.basicWireType = void 0;
 const ts_proto_descriptors_1 = require("ts-proto-descriptors");
 const ts_poet_1 = require("ts-poet");
 const options_1 = require("./options");
@@ -403,6 +403,14 @@ function isBytesValueType(field) {
     return field.typeName === '.google.protobuf.BytesValue';
 }
 exports.isBytesValueType = isBytesValueType;
+function isFieldMaskType(field) {
+    return isFieldMaskTypeName(field.typeName);
+}
+exports.isFieldMaskType = isFieldMaskType;
+function isFieldMaskTypeName(typeName) {
+    return typeName === 'google.protobuf.FieldMask' || typeName === '.google.protobuf.FieldMask';
+}
+exports.isFieldMaskTypeName = isFieldMaskTypeName;
 function isListValueType(field) {
     return isListValueTypeName(field.typeName);
 }

package/build/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+exports.impProto = 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;
 const ts_poet_1 = require("ts-poet");
 const options_1 = require("./options");
 const case_1 = require("./case");
@@ -144,7 +144,7 @@ class FormattedMethodDescriptor {
     }
 }
 exports.FormattedMethodDescriptor = FormattedMethodDescriptor;
-function determineFieldJsonName(field, options) {
+function getFieldJsonName(field, options) {
     // jsonName will be camelCased by the protocol compiler, plus can be overridden by the user,
     // so just use that instead of our own maybeSnakeToCamel
     if (options.snakeToCamel.includes('json')) {
@@ -154,7 +154,20 @@ function determineFieldJsonName(field, options) {
         return field.name;
     }
 }
-exports.determineFieldJsonName = determineFieldJsonName;
+exports.getFieldJsonName = getFieldJsonName;
+/**
+ * Returns a snippet for reading an object's property, such as `foo.bar`, or `foo['bar']` if the property name contains unusual characters.
+ * For simplicity, we don't match the ECMA 5/6 rules for valid identifiers exactly, and return array syntax liberally.
+ * @param objectName
+ * @param propertyName
+ */
+function getPropertyAccessor(objectName, propertyName) {
+    let validIdentifier = /^[a-zA-Z_$][\w$]*$/;
+    return validIdentifier.test(propertyName)
+        ? `${objectName}.${propertyName}`
+        : `${objectName}[${JSON.stringify(propertyName)}]`;
+}
+exports.getPropertyAccessor = getPropertyAccessor;
 function impProto(options, module, type) {
     return ts_poet_1.imp(`${type}@./${module}${options.fileSuffix}`);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-proto",
-  "version": "1.104.1",
+  "version": "1.106.0",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",
@@ -64,6 +64,6 @@
     "object-hash": "^1.3.1",
     "protobufjs": "^6.8.8",
     "ts-poet": "^4.5.0",
-    "ts-proto-descriptors": "1.3.1"
+    "ts-proto-descriptors": "1.6.0"
   }
 }