ts-proto 1.107.0 → 1.108.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.108.0](https://github.com/stephenh/ts-proto/compare/v1.107.0...v1.108.0) (2022-03-07)
+
+
+### Features
+
+* represent field masks as `string[]` ([#525](https://github.com/stephenh/ts-proto/issues/525)) ([903b216](https://github.com/stephenh/ts-proto/commit/903b216238db025e24ec3cfb2d20063aec1a40ed))
+
 # [1.107.0](https://github.com/stephenh/ts-proto/compare/v1.106.2...v1.107.0) (2022-03-04)
 
 

package/README.markdown

@@ -622,24 +622,19 @@ Their interpretation is defined by the Protobuf specification, and libraries are
 
 `ts-proto` currently automatically converts these messages to their corresponding native types.
 
-- Wrapper Types:
-
-  * [google.protobuf.DoubleValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#DoubleValue) ⇆ `number | undefined`
-  * [google.protobuf.FloatValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#FloatValue) ⇆ `number | undefined`
-  * [google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#Int64Value) ⇆ `number | undefined`
-  * [google.protobuf.UInt64Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#UInt64Value) ⇆ `number | undefined`
-  * [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#Int32Value) ⇆ `number | undefined`
-  * [google.protobuf.UInt32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#UInt32Value) ⇆ `number | undefined`
-  * [google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#BoolValue) ⇆ `boolean | undefined`
-  * [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#StringValue) ⇆ `string | undefined`
-  * [google.protobuf.BytesValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.BytesValue) ⇆ `Uint8Array | undefined`
-
-- JSON Types (Struct Types):
-
-  * [google.protobuf.Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#Value)  ⇆ `any | undefined` (i.e. `number | string | boolean | null | array | object`)
-  * [google.protobuf.ListValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#ListValue) ⇆ `any[]`
-  * [google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#Struct) ⇆ `{ [key: string]: any } | undefined`
-  * [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask) ⇆ `string[]` (only in the JSON, `FieldMask` is still a message)
+ * [google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#boolvalue) ⇆ `boolean`
+ * [google.protobuf.BytesValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#bytesvalue) ⇆ `Uint8Array`
+ * [google.protobuf.DoubleValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#doublevalue) ⇆ `number`
+ * [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask) ⇆ `string[]`
+ * [google.protobuf.FloatValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#floatvalue) ⇆ `number`
+ * [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#int32value) ⇆ `number`
+ * [google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#int64value) ⇆ `number`
+ * [google.protobuf.ListValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#listvalue) ⇆ `any[]`
+ * [google.protobuf.UInt32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#uint32value) ⇆ `number`
+ * [google.protobuf.UInt64Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#uint64value) ⇆ `number`
+ * [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#stringvalue) ⇆ `string`
+ * [google.protobuf.Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#value)  ⇆ `any` (i.e. `number | string | boolean | null | array | object`)
+ * [google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) ⇆ `{ [key: string]: any }`
 
 ## Wrapper Types
 

package/build/main.js

@@ -80,8 +80,8 @@ function generateFile(ctx, fileDesc) {
                 staticMembers.push(generateDecode(ctx, fullName, message));
             }
             if (options.outputJsonMethods) {
-                staticMembers.push(generateFromJson(ctx, fullName, message));
-                staticMembers.push(generateToJson(ctx, fullName, message));
+                staticMembers.push(generateFromJson(ctx, fullName, fullTypeName, message));
+                staticMembers.push(generateToJson(ctx, fullName, fullTypeName, message));
             }
             if (options.outputPartialMethods) {
                 staticMembers.push(generateFromPartial(ctx, fullName, message));
@@ -604,7 +604,7 @@ function generateDecode(ctx, fullName, messageDesc) {
         else if (types_1.isValueType(ctx, field)) {
             const type = types_1.basicTypeName(ctx, field, { keepValueType: true });
             const unwrap = (decodedValue) => {
-                if (types_1.isListValueType(field) || types_1.isStructType(field) || types_1.isAnyValueType(field)) {
+                if (types_1.isListValueType(field) || types_1.isStructType(field) || types_1.isAnyValueType(field) || types_1.isFieldMaskType(field)) {
                     return ts_poet_1.code `${type}.unwrap(${decodedValue})`;
                 }
                 return ts_poet_1.code `${decodedValue}.value`;
@@ -729,7 +729,7 @@ function generateEncode(ctx, fullName, messageDesc) {
             const maybeTypeField = options.outputTypeRegistry ? `$type: '${field.typeName.slice(1)}',` : '';
             const type = types_1.basicTypeName(ctx, field, { keepValueType: true });
             const wrappedValue = (place) => {
-                if (types_1.isAnyValueType(field) || types_1.isListValueType(field) || types_1.isStructType(field)) {
+                if (types_1.isAnyValueType(field) || types_1.isListValueType(field) || types_1.isStructType(field) || types_1.isFieldMaskType(field)) {
                     return ts_poet_1.code `${type}.wrap(${place})`;
                 }
                 return ts_poet_1.code `{${maybeTypeField} value: ${place}!}`;
@@ -887,7 +887,7 @@ function generateEncode(ctx, fullName, messageDesc) {
  * This is very similar to decode, we loop through looking for properties, with
  * a few special cases for https://developers.google.com/protocol-buffers/docs/proto3#json.
  * */
-function generateFromJson(ctx, fullName, messageDesc) {
+function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
     const { options, utils, typeMap } = ctx;
     const chunks = [];
     // create the basic function declaration
@@ -899,8 +899,18 @@ function generateFromJson(ctx, fullName, messageDesc) {
         chunks.push(ts_poet_1.code `$type: ${fullName}.$type,`);
     }
     const oneofFieldsCases = messageDesc.oneofDecl.map((oneof, oneofIndex) => messageDesc.field.filter(types_1.isWithinOneOf).filter((field) => field.oneofIndex === oneofIndex));
+    const canonicalFromJson = {
+        ['google.protobuf.FieldMask']: {
+            paths: (from) => ts_poet_1.code `typeof(${from}) === 'string'
+        ? ${from}.split(",").filter(Boolean)
+        : Array.isArray(${from}?.paths)
+        ? ${from}.paths.map(String)
+        : []`,
+        },
+    };
     // add a check for each incoming field
     messageDesc.field.forEach((field) => {
+        var _a;
         const fieldName = case_1.maybeSnakeToCamel(field.name, options);
         const jsonName = utils_1.getFieldJsonName(field, options);
         const jsonProperty = utils_1.getPropertyAccessor('object', jsonName);
@@ -944,7 +954,8 @@ function generateFromJson(ctx, fullName, messageDesc) {
                 return ts_poet_1.code `${from}`;
             }
             else if (types_1.isFieldMaskType(field)) {
-                return ts_poet_1.code `{paths: ${from}.split(",")}`;
+                const type = types_1.basicTypeName(ctx, field, { keepValueType: true });
+                return ts_poet_1.code `${type}.unwrap(${type}.fromJSON(${from}))`;
             }
             else if (types_1.isListValueType(field)) {
                 return ts_poet_1.code `[...${from}]`;
@@ -1017,7 +1028,10 @@ function generateFromJson(ctx, fullName, messageDesc) {
             }
         };
         // and then use the snippet to handle repeated fields if necessary
-        if (types_1.isRepeated(field)) {
+        if ((_a = canonicalFromJson[fullTypeName]) === null || _a === void 0 ? void 0 : _a[fieldName]) {
+            chunks.push(ts_poet_1.code `${fieldName}: ${canonicalFromJson[fullTypeName][fieldName]('object')},`);
+        }
+        else if (types_1.isRepeated(field)) {
             if (types_1.isMapType(ctx, messageDesc, field)) {
                 const fieldType = types_1.toTypeName(ctx, messageDesc, field);
                 const i = maybeCastToNumber(ctx, messageDesc, field, 'key');
@@ -1090,9 +1104,24 @@ function generateFromJson(ctx, fullName, messageDesc) {
     chunks.push(ts_poet_1.code `}`);
     return ts_poet_1.joinCode(chunks, { on: '\n' });
 }
-function generateToJson(ctx, fullName, messageDesc) {
+function generateCanonicalToJson(fullName, fullProtobufTypeName) {
+    if (types_1.isFieldMaskTypeName(fullProtobufTypeName)) {
+        return ts_poet_1.code `
+    toJSON(message: ${fullName}): string {
+      return message.paths.join(',');
+    }
+  `;
+    }
+    return undefined;
+}
+function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
     const { options, utils, typeMap } = ctx;
     const chunks = [];
+    const canonicalToJson = generateCanonicalToJson(fullName, fullProtobufTypeName);
+    if (canonicalToJson) {
+        chunks.push(canonicalToJson);
+        return ts_poet_1.joinCode(chunks, { on: '\n' });
+    }
     // create the basic function declaration
     chunks.push(ts_poet_1.code `
     toJSON(${messageDesc.field.length > 0 ? 'message' : '_'}: ${fullName}): unknown {
@@ -1165,7 +1194,8 @@ function generateToJson(ctx, fullName, messageDesc) {
                 return ts_poet_1.code `${from}`;
             }
             else if (types_1.isFieldMaskType(field)) {
-                return ts_poet_1.code `${from}.paths.join()`;
+                const type = types_1.basicTypeName(ctx, field, { keepValueType: true });
+                return ts_poet_1.code `${type}.toJSON(${type}.wrap(${from}))`;
             }
             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 });
@@ -1431,6 +1461,11 @@ function generateWrap(ctx, fullProtoTypeName) {
       return result;
     }`);
     }
+    if (types_1.isFieldMaskTypeName(fullProtoTypeName)) {
+        chunks.push(ts_poet_1.code `wrap(paths: string[]): FieldMask {
+      return {paths: paths};
+    }`);
+    }
     return chunks;
 }
 function generateUnwrap(ctx, fullProtoTypeName) {
@@ -1488,6 +1523,11 @@ function generateUnwrap(ctx, fullProtoTypeName) {
       return message.values;
     }`);
     }
+    if (types_1.isFieldMaskTypeName(fullProtoTypeName)) {
+        chunks.push(ts_poet_1.code `unwrap(message: FieldMask): string[] {
+      return message.paths;
+    }`);
+    }
     return chunks;
 }
 exports.contextTypeVar = 'Context extends DataLoaders';

package/build/types.js

@@ -458,6 +458,8 @@ function valueTypeName(ctx, typeName) {
             return ts_poet_1.code `any`;
         case '.google.protobuf.Struct':
             return ts_poet_1.code `{[key: string]: any}`;
+        case '.google.protobuf.FieldMask':
+            return ts_poet_1.code `string[]`;
         default:
             return undefined;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-proto",
-  "version": "1.107.0",
+  "version": "1.108.0",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",
@@ -11,6 +11,7 @@
     "build": "yarn tsc",
     "build:test": "yarn proto2bin && yarn proto2pbjs && yarn bin2ts",
     "build:test:local": "yarn proto2bin:local && yarn proto2pbjs:local && yarn bin2ts:local",
+    "prepare": "yarn build",
     "proto2bin": "docker-compose run --rm protoc update-bins.sh",
     "proto2bin-node": "docker-compose run --rm node update-bins.sh",
     "proto2pbjs": "docker-compose run --rm protoc pbjs.sh",