ts-proto 1.162.0 → 1.162.2

package/build/encode.js

@@ -18,7 +18,7 @@ function generateEncoder(ctx, typeName) {
         }
         return (0, ts_poet_1.code) `${TimestampValue}.encode(${value}).finish()`;
     }
-    if (name == "Struct") {
+    if (name == "Struct" || name == "Value") {
         const StructType = (0, utils_1.impProto)(ctx.options, "google/protobuf/struct", name);
         return (0, ts_poet_1.code) `${StructType}.encode(${StructType}.wrap(value)).finish()`;
     }
@@ -64,7 +64,7 @@ function generateDecoder(ctx, typeName) {
         }
         return decoder;
     }
-    if (name == "Struct" || name == "ListValue") {
+    if (name == "Struct" || name == "ListValue" || name == "Value") {
         TypeValue = (0, utils_1.impProto)(ctx.options, "google/protobuf/struct", name);
         return (0, ts_poet_1.code) `${TypeValue}.unwrap(${TypeValue}.decode(value))`;
     }

package/build/generate-struct-wrappers.js

@@ -134,9 +134,7 @@ function generateUnwrapDeep(ctx, fullProtoTypeName, fieldNames) {
     }`);
     }
     if ((0, types_1.isFieldMaskTypeName)(fullProtoTypeName)) {
-        chunks.push((0, ts_poet_1.code) `unwrap(message: ${ctx.options.useReadonlyTypes ? "any" : "FieldMask"}): string[] {
-      return message.paths;
-    }`);
+        chunks.push(generateFieldMaskUnwrap(ctx));
     }
     return chunks;
 }
@@ -303,13 +301,18 @@ function generateUnwrapShallow(ctx, fullProtoTypeName, fieldNames) {
     }`);
     }
     if ((0, types_1.isFieldMaskTypeName)(fullProtoTypeName)) {
-        chunks.push((0, ts_poet_1.code) `unwrap(message: ${ctx.options.useReadonlyTypes ? "any" : "FieldMask"}): string[] {
-      return message.paths;
-    }`);
+        chunks.push(generateFieldMaskUnwrap(ctx));
     }
     return chunks;
 }
 exports.generateUnwrapShallow = generateUnwrapShallow;
+function generateFieldMaskUnwrap(ctx) {
+    const returnType = ctx.options.useOptionals === "all" ? "string[] | undefined" : "string[]";
+    const pathModifier = ctx.options.useOptionals === "all" ? "?" : "";
+    return (0, ts_poet_1.code) `unwrap(message: ${ctx.options.useReadonlyTypes ? "any" : "FieldMask"}): ${returnType} {
+    return message${pathModifier}.paths;
+  }`;
+}
 function maybeReadonly(options) {
     return options.useReadonlyTypes ? "readonly " : "";
 }

package/build/main.js

@@ -615,10 +615,10 @@ function generateInterfaceDeclaration(ctx, fullName, messageDesc, sourceInfo, fu
         }
         const info = sourceInfo.lookup(sourceInfo_1.Fields.message.field, index);
         (0, utils_1.maybeAddComment)(info, chunks, (_a = fieldDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
-        const { validatedPropertyName } = (0, utils_1.propertyNameComposition)(fieldDesc, options);
+        const fieldKey = (0, utils_1.safeAccessor)((0, utils_1.getFieldName)(fieldDesc, options));
         const isOptional = (0, types_1.isOptionalProperty)(fieldDesc, messageDesc.options, options);
         const type = (0, types_1.toTypeName)(ctx, messageDesc, fieldDesc, isOptional);
-        chunks.push((0, ts_poet_1.code) `${maybeReadonly(options)}${validatedPropertyName}${isOptional ? "?" : ""}: ${type}, `);
+        chunks.push((0, ts_poet_1.code) `${maybeReadonly(options)}${fieldKey}${isOptional ? "?" : ""}: ${type}, `);
     });
     if (ctx.options.unknownFields) {
         chunks.push((0, ts_poet_1.code) `_unknownFields?: {[key: number]: Uint8Array[]} | undefined,`);
@@ -670,16 +670,16 @@ function generateBaseInstanceFactory(ctx, fullName, messageDesc, fullTypeName) {
             if (!processedOneofs.has(oneofIndex)) {
                 processedOneofs.add(oneofIndex);
                 const name = options.useJsonName
-                    ? (0, utils_1.propertyNameComposition)(field, options).validatedPropertyName
+                    ? (0, utils_1.getFieldName)(field, options)
                     : (0, case_1.maybeSnakeToCamel)(messageDesc.oneofDecl[oneofIndex].name, ctx.options);
-                fields.push((0, ts_poet_1.code) `${name}: undefined`);
+                fields.push((0, ts_poet_1.code) `${(0, utils_1.safeAccessor)(name)}: undefined`);
             }
             continue;
         }
         if (!options.initializeFieldsAsUndefined && (0, types_1.isOptionalProperty)(field, messageDesc.options, options)) {
             continue;
         }
-        const { validatedPropertyName } = (0, utils_1.propertyNameComposition)(field, options);
+        const fieldKey = (0, utils_1.safeAccessor)((0, utils_1.getFieldName)(field, options));
         const val = (0, types_1.isWithinOneOf)(field)
             ? "undefined"
             : (0, types_1.isMapType)(ctx, messageDesc, field)
@@ -689,7 +689,7 @@ function generateBaseInstanceFactory(ctx, fullName, messageDesc, fullTypeName) {
                 : (0, types_1.isRepeated)(field)
                     ? "[]"
                     : (0, types_1.defaultValue)(ctx, field);
-        fields.push((0, ts_poet_1.code) `${validatedPropertyName}: ${val}`);
+        fields.push((0, ts_poet_1.code) `${fieldKey}: ${val}`);
     }
     if ((0, options_1.addTypeToMessages)(options)) {
         fields.unshift((0, ts_poet_1.code) `$type: '${fullTypeName}'`);
@@ -797,8 +797,8 @@ function generateDecode(ctx, fullName, messageDesc) {
   `);
     // add a case for each incoming field
     messageDesc.field.forEach((field) => {
-        const { propertyName } = (0, utils_1.propertyNameComposition)(field, options);
-        const messageProperty = (0, utils_1.getPropertyAccessor)("message", propertyName);
+        const fieldName = (0, utils_1.getFieldName)(field, options);
+        const messageProperty = (0, utils_1.getPropertyAccessor)("message", fieldName);
         chunks.push((0, ts_poet_1.code) `case ${field.number}:`);
         const tag = ((field.number << 3) | (0, types_1.basicWireType)(field.type)) >>> 0;
         const tagCheck = (0, ts_poet_1.code) `
@@ -884,7 +884,7 @@ function generateDecode(ctx, fullName, messageDesc) {
                 : (0, utils_1.getPropertyAccessor)("message", (0, case_1.maybeSnakeToCamel)(messageDesc.oneofDecl[field.oneofIndex].name, options));
             chunks.push((0, ts_poet_1.code) `
         ${tagCheck}
-        ${oneofNameWithMessage} = { $case: '${propertyName}', ${propertyName}: ${readSnippet} };
+        ${oneofNameWithMessage} = { $case: '${fieldName}', ${fieldName}: ${readSnippet} };
       `);
         }
         else {
@@ -1025,8 +1025,8 @@ function generateEncode(ctx, fullName, messageDesc) {
         .reduce((result, field) => ((result[field.oneofIndex] || (result[field.oneofIndex] = [])).push(field), result), {});
     // then add a case for each field
     messageDesc.field.forEach((field) => {
-        const { propertyName, validatedPropertyName } = (0, utils_1.propertyNameComposition)(field, options);
-        const messageProperty = (0, utils_1.getPropertyAccessor)("message", propertyName);
+        const fieldName = (0, utils_1.getFieldName)(field, options);
+        const messageProperty = (0, utils_1.getPropertyAccessor)("message", fieldName);
         // get a generic writer.doSomething based on the basic type
         const writeSnippet = getEncodeWriteSnippet(ctx, field);
         const isOptional = (0, types_1.isOptionalProperty)(field, messageDesc.options, options);
@@ -1121,7 +1121,7 @@ function generateEncode(ctx, fullName, messageDesc) {
                 writer.uint32(${tag}).fork();
                 for (const v of ${messageProperty}) {
                   if (BigInt.asIntN(64, v) !== v) {
-                    throw new Error('a value provided in array field ${propertyName} of type ${fieldType} is too large');
+                    throw new Error('a value provided in array field ${fieldName} of type ${fieldType} is too large');
                   }
                   writer.${(0, types_1.toReaderCall)(field)}(${rhs("v")});
                 }
@@ -1134,7 +1134,7 @@ function generateEncode(ctx, fullName, messageDesc) {
                 writer.uint32(${tag}).fork();
                 for (const v of ${messageProperty}) {
                   if (BigInt.asUintN(64, v) !== v) {
-                    throw new Error('a value provided in array field ${propertyName} of type ${fieldType} is too large');
+                    throw new Error('a value provided in array field ${fieldName} of type ${fieldType} is too large');
                   }                
                   writer.${(0, types_1.toReaderCall)(field)}(${rhs("v")});
                 }
@@ -1469,7 +1469,8 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
     // add a check for each incoming field
     messageDesc.field.forEach((field) => {
         var _a;
-        const { validatedPropertyName: fieldName } = (0, utils_1.propertyNameComposition)(field, options);
+        const fieldName = (0, utils_1.getFieldName)(field, options);
+        const fieldKey = (0, utils_1.safeAccessor)(fieldName);
         const jsonName = (0, utils_1.getFieldJsonName)(field, options);
         const jsonProperty = (0, utils_1.getPropertyAccessor)("object", jsonName);
         const jsonPropertyOptional = (0, utils_1.getPropertyAccessor)("object", jsonName, true);
@@ -1605,7 +1606,7 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
                 if ((0, types_1.shouldGenerateJSMapType)(ctx, messageDesc, field)) {
                     const fallback = noDefaultValue ? "undefined" : "new Map()";
                     chunks.push((0, ts_poet_1.code) `
-            ${fieldName}: ${ctx.utils.isObject}(${jsonProperty})
+            ${fieldKey}: ${ctx.utils.isObject}(${jsonProperty})
               ? Object.entries(${jsonProperty}).reduce<${fieldType}>((acc, [key, value]) => {
                   acc.set(${i}, ${readSnippet("value")});
                   return acc;
@@ -1616,7 +1617,7 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
                 else {
                     const fallback = noDefaultValue ? "undefined" : "{}";
                     chunks.push((0, ts_poet_1.code) `
-            ${fieldName}: ${ctx.utils.isObject}(${jsonProperty})
+            ${fieldKey}: ${ctx.utils.isObject}(${jsonProperty})
               ? Object.entries(${jsonProperty}).reduce<${fieldType}>((acc, [key, value]) => {
                   acc[${i}] = ${readSnippet("value")};
                   return acc;
@@ -1629,12 +1630,12 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
                 const fallback = noDefaultValue ? "undefined" : "[]";
                 const readValueSnippet = readSnippet("e");
                 if (readValueSnippet.toString() === (0, ts_poet_1.code) `e`.toString()) {
-                    chunks.push((0, ts_poet_1.code) `${fieldName}: ${ctx.utils.globalThis}.Array.isArray(${jsonPropertyOptional}) ? [...${jsonProperty}] : [],`);
+                    chunks.push((0, ts_poet_1.code) `${fieldKey}: ${ctx.utils.globalThis}.Array.isArray(${jsonPropertyOptional}) ? [...${jsonProperty}] : [],`);
                 }
                 else {
                     // Explicit `any` type required to make TS with noImplicitAny happy. `object` is also `any` here.
                     chunks.push((0, ts_poet_1.code) `
-            ${fieldName}: ${ctx.utils.globalThis}.Array.isArray(${jsonPropertyOptional}) ? ${jsonProperty}.map((e: any) => ${readValueSnippet}): ${fallback},
+            ${fieldKey}: ${ctx.utils.globalThis}.Array.isArray(${jsonPropertyOptional}) ? ${jsonProperty}.map((e: any) => ${readValueSnippet}): ${fallback},
           `);
                 }
             }
@@ -1648,26 +1649,26 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
                 chunks.push((0, ts_poet_1.code) `${fieldName}: `);
             }
             const ternaryIf = (0, ts_poet_1.code) `${ctx.utils.isSet}(${jsonProperty})`;
-            const ternaryThen = (0, ts_poet_1.code) `{ $case: '${fieldName}', ${fieldName}: ${readSnippet(`${jsonProperty}`)}`;
+            const ternaryThen = (0, ts_poet_1.code) `{ $case: '${fieldName}', ${fieldKey}: ${readSnippet(`${jsonProperty}`)}`;
             chunks.push((0, ts_poet_1.code) `${ternaryIf} ? ${ternaryThen}} : `);
             if (field === lastCase) {
                 chunks.push((0, ts_poet_1.code) `undefined,`);
             }
         }
         else if ((0, types_1.isAnyValueType)(field)) {
-            chunks.push((0, ts_poet_1.code) `${fieldName}: ${ctx.utils.isSet}(${jsonPropertyOptional})
+            chunks.push((0, ts_poet_1.code) `${fieldKey}: ${ctx.utils.isSet}(${jsonPropertyOptional})
         ? ${readSnippet(`${jsonProperty}`)}
         : undefined,
       `);
         }
         else if ((0, types_1.isStructType)(field)) {
-            chunks.push((0, ts_poet_1.code) `${fieldName}: ${ctx.utils.isObject}(${jsonProperty})
+            chunks.push((0, ts_poet_1.code) `${fieldKey}: ${ctx.utils.isObject}(${jsonProperty})
           ? ${readSnippet(`${jsonProperty}`)}
           : undefined,`);
         }
         else if ((0, types_1.isListValueType)(field)) {
             chunks.push((0, ts_poet_1.code) `
-        ${fieldName}: ${ctx.utils.globalThis}.Array.isArray(${jsonProperty})
+        ${fieldKey}: ${ctx.utils.globalThis}.Array.isArray(${jsonProperty})
           ? ${readSnippet(`${jsonProperty}`)}
           : undefined,
       `);
@@ -1675,7 +1676,7 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
         else {
             const fallback = (0, types_1.isWithinOneOf)(field) || noDefaultValue ? "undefined" : (0, types_1.defaultValue)(ctx, field);
             chunks.push((0, ts_poet_1.code) `
-        ${fieldName}: ${ctx.utils.isSet}(${jsonProperty})
+        ${fieldKey}: ${ctx.utils.isSet}(${jsonProperty})
           ? ${readSnippet(`${jsonProperty}`)}
           : ${fallback},
       `);
@@ -1686,11 +1687,13 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
     chunks.push((0, ts_poet_1.code) `}`);
     return (0, ts_poet_1.joinCode)(chunks, { on: "\n" });
 }
-function generateCanonicalToJson(fullName, fullProtobufTypeName) {
+function generateCanonicalToJson(fullName, fullProtobufTypeName, { useOptionals }) {
     if ((0, types_1.isFieldMaskTypeName)(fullProtobufTypeName)) {
+        const returnType = useOptionals === "all" ? "string | undefined" : "string";
+        const pathModifier = useOptionals === "all" ? "?" : "";
         return (0, ts_poet_1.code) `
-    toJSON(message: ${fullName}): string {
-      return message.paths.join(',');
+    toJSON(message: ${fullName}): ${returnType} {
+      return message.paths${pathModifier}.join(',');
     }
   `;
     }
@@ -1699,7 +1702,7 @@ function generateCanonicalToJson(fullName, fullProtobufTypeName) {
 function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
     const { options, utils, typeMap } = ctx;
     const chunks = [];
-    const canonicalToJson = generateCanonicalToJson(fullName, fullProtobufTypeName);
+    const canonicalToJson = generateCanonicalToJson(fullName, fullProtobufTypeName, options);
     if (canonicalToJson) {
         chunks.push(canonicalToJson);
         return (0, ts_poet_1.joinCode)(chunks, { on: "\n" });
@@ -1711,10 +1714,10 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
   `);
     // then add a case for each field
     messageDesc.field.forEach((field) => {
-        const { validatedPropertyName: fieldName, propertyName } = (0, utils_1.propertyNameComposition)(field, options);
+        const fieldName = (0, utils_1.getFieldName)(field, options);
         const jsonName = (0, utils_1.getFieldJsonName)(field, options);
         const jsonProperty = (0, utils_1.getPropertyAccessor)("obj", jsonName);
-        const messageProperty = (0, utils_1.getPropertyAccessor)("message", propertyName);
+        const messageProperty = (0, utils_1.getPropertyAccessor)("message", fieldName);
         const readSnippet = (from) => {
             if ((0, types_1.isEnum)(field)) {
                 const toJson = (0, types_1.getEnumMethod)(ctx, field.typeName, "ToJSON");
@@ -1902,9 +1905,9 @@ function generateFromPartial(ctx, fullName, messageDesc) {
     chunks.push((0, ts_poet_1.code) `const message = ${createBase}${maybeAsAny(options)};`);
     // add a check for each incoming field
     messageDesc.field.forEach((field) => {
-        const { propertyName } = (0, utils_1.propertyNameComposition)(field, options);
-        const messageProperty = (0, utils_1.getPropertyAccessor)("message", propertyName);
-        const objectProperty = (0, utils_1.getPropertyAccessor)("object", propertyName);
+        const fieldName = (0, utils_1.getFieldName)(field, options);
+        const messageProperty = (0, utils_1.getPropertyAccessor)("message", fieldName);
+        const objectProperty = (0, utils_1.getPropertyAccessor)("object", fieldName);
         const readSnippet = (from) => {
             if (((0, types_1.isLong)(field) || (0, types_1.isLongValueType)(field)) && options.forceLong === options_1.LongOption.LONG) {
                 return (0, ts_poet_1.code) `Long.fromValue(${from})`;
@@ -2009,19 +2012,17 @@ function generateFromPartial(ctx, fullName, messageDesc) {
             }
         }
         else if ((0, types_1.isWithinOneOfThatShouldBeUnion)(options, field)) {
-            const oneofName = options.useJsonName
-                ? propertyName
-                : (0, case_1.maybeSnakeToCamel)(messageDesc.oneofDecl[field.oneofIndex].name, options);
+            const oneofName = (0, case_1.maybeSnakeToCamel)(messageDesc.oneofDecl[field.oneofIndex].name, options);
             const oneofNameWithMessage = (0, utils_1.getPropertyAccessor)("message", oneofName);
             const oneofNameWithObject = (0, utils_1.getPropertyAccessor)("object", oneofName);
-            const v = readSnippet(`${oneofNameWithObject}.${propertyName}`);
+            const v = readSnippet(`${oneofNameWithObject}.${fieldName}`);
             chunks.push((0, ts_poet_1.code) `
         if (
-          ${oneofNameWithObject}?.$case === '${propertyName}'
-          && ${oneofNameWithObject}?.${propertyName} !== undefined
-          && ${oneofNameWithObject}?.${propertyName} !== null
+          ${oneofNameWithObject}?.$case === '${fieldName}'
+          && ${oneofNameWithObject}?.${fieldName} !== undefined
+          && ${oneofNameWithObject}?.${fieldName} !== null
         ) {
-          ${oneofNameWithMessage} = { $case: '${propertyName}', ${propertyName}: ${v} };
+          ${oneofNameWithMessage} = { $case: '${fieldName}', ${fieldName}: ${v} };
         }
       `);
         }

package/build/types.js

@@ -512,6 +512,7 @@ function wrapperTypeName(typeName) {
         case ".google.protobuf.ListValue":
         case ".google.protobuf.Timestamp":
         case ".google.protobuf.Struct":
+        case ".google.protobuf.Value":
             return typeName.split(".")[3];
         default:
             return undefined;

package/build/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.impProto = exports.impFile = exports.getPropertyAccessor = exports.propertyNameComposition = 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;
+exports.impProto = exports.impFile = exports.getPropertyAccessor = exports.safeAccessor = exports.getFieldName = 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");
@@ -199,30 +199,24 @@ function getFieldJsonName(field, options) {
     }
 }
 exports.getFieldJsonName = getFieldJsonName;
-function propertyNameComposition(field, options) {
+function getFieldName(field, options) {
     if (options.useJsonName) {
-        const jsonName = field.jsonName;
-        return {
-            propertyName: jsonName,
-            validatedPropertyName: validateObjectProperty(jsonName),
-        };
-    }
-    const propertyName = (0, case_1.maybeSnakeToCamel)(field.name, options);
-    return {
-        propertyName,
-        validatedPropertyName: propertyName,
-    };
+        return field.jsonName;
+    }
+    return (0, case_1.maybeSnakeToCamel)(field.name, options);
 }
-exports.propertyNameComposition = propertyNameComposition;
+exports.getFieldName = getFieldName;
 /**
  * https://github.com/eslint-community/eslint-plugin-security/blob/main/docs/the-dangers-of-square-bracket-notation.md
  */
-function isValidateObjectProperty(propertyName) {
+function isValidIdentifier(propertyName) {
     return /^[a-zA-Z_$][\w$]*$/.test(propertyName);
 }
-function validateObjectProperty(propertyName) {
-    return isValidateObjectProperty(propertyName) ? propertyName : JSON.stringify(propertyName);
+/** Returns `bar` or `"bar"` if `propertyName` isn't a safe property name. */
+function safeAccessor(propertyName) {
+    return isValidIdentifier(propertyName) ? propertyName : JSON.stringify(propertyName);
 }
+exports.safeAccessor = safeAccessor;
 /**
  * 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.
@@ -231,9 +225,9 @@ function validateObjectProperty(propertyName) {
  * @param optional
  */
 function getPropertyAccessor(objectName, propertyName, optional = false) {
-    return isValidateObjectProperty(propertyName)
+    return isValidIdentifier(propertyName)
         ? `${objectName}${optional ? "?" : ""}.${propertyName}`
-        : `${objectName}${optional ? "?." : ""}[${validateObjectProperty(propertyName)}]`;
+        : `${objectName}${optional ? "?." : ""}[${safeAccessor(propertyName)}]`;
 }
 exports.getPropertyAccessor = getPropertyAccessor;
 function impFile(options, spec) {

package/package.json

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