ts-proto 1.144.0 → 1.145.0

package/build/generate-generic-service-definition.js

@@ -67,12 +67,11 @@ function generateMethodOptions(ctx, options) {
         else if (options.idempotencyLevel === ts_proto_descriptors_1.MethodOptions_IdempotencyLevel.NO_SIDE_EFFECTS) {
             chunks.push((0, ts_poet_1.code) `idempotencyLevel: 'NO_SIDE_EFFECTS',`);
         }
-        if ("_unknownFields" in options) {
-            const msgUnknownFields = options["_unknownFields"];
+        if (options._unknownFields !== undefined) {
             const unknownFieldsChunks = [];
             unknownFieldsChunks.push((0, ts_poet_1.code) `{`);
-            for (const key of Object.keys(msgUnknownFields)) {
-                const values = msgUnknownFields[key];
+            for (const key in options._unknownFields) {
+                const values = options._unknownFields[key];
                 const valuesChunks = [];
                 for (const value of values) {
                     valuesChunks.push((0, ts_poet_1.code) `${ctx.options.env == "node" ? "Buffer.from" : "new Uint8Array"}([${value.join(", ")}])`);

package/build/main.js

@@ -957,10 +957,10 @@ function generateEncode(ctx, fullName, messageDesc) {
               }
             `
                     : writeSnippet(`{ ${maybeTypeField} key: key as any, value }`);
-                const optionalAlternative = isOptional ? " || {}" : "";
+                const optionalAlternative = isOptional ? (ctx.options.useMapType ? " || new Map()" : " || {}") : "";
                 if (ctx.options.useMapType) {
                     chunks.push((0, ts_poet_1.code) `
-            message.${fieldName}${optionalAlternative}.forEach((value, key) => {
+            (message.${fieldName}${optionalAlternative}).forEach((value, key) => {
               ${entryWriteSnippet}
             });
           `);
@@ -1212,6 +1212,9 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
                         else if ((0, types_1.isLong)(valueField) && options.forceLong === options_1.LongOption.LONG) {
                             return (0, ts_poet_1.code) `Long.fromValue(${from} as Long | string)`;
                         }
+                        else if ((0, types_1.isLong)(valueField) && options.forceLong === options_1.LongOption.BIGINT) {
+                            return (0, ts_poet_1.code) `BigInt(${from} as string | number | bigint | boolean)`;
+                        }
                         else if ((0, types_1.isEnum)(valueField)) {
                             const fromJson = (0, types_1.getEnumMethod)(ctx, valueField.typeName, "FromJSON");
                             return (0, ts_poet_1.code) `${fromJson}(${from})`;
@@ -1250,6 +1253,7 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
                 throw new Error(`Unhandled field ${field}`);
             }
         };
+        const noDefaultValue = !options.initializeFieldsAsUndefined && (0, types_1.isOptionalProperty)(field, messageDesc.options, options);
         // and then use the snippet to handle repeated fields if necessary
         if ((_a = canonicalFromJson[fullTypeName]) === null || _a === void 0 ? void 0 : _a[fieldName]) {
             chunks.push((0, ts_poet_1.code) `${fieldName}: ${canonicalFromJson[fullTypeName][fieldName]("object")},`);
@@ -1257,29 +1261,32 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
         else if ((0, types_1.isRepeated)(field)) {
             if ((0, types_1.isMapType)(ctx, messageDesc, field)) {
                 const fieldType = (0, types_1.toTypeName)(ctx, messageDesc, field);
-                const i = maybeCastToNumber(ctx, messageDesc, field, "key");
+                const i = convertFromObjectKey(ctx, messageDesc, field, "key");
                 if (ctx.options.useMapType) {
+                    const fallback = noDefaultValue ? "undefined" : "new Map()";
                     chunks.push((0, ts_poet_1.code) `
             ${fieldName}: ${ctx.utils.isObject}(${jsonProperty})
               ? Object.entries(${jsonProperty}).reduce<${fieldType}>((acc, [key, value]) => {
                   acc.set(${i}, ${readSnippet("value")});
                   return acc;
                 }, new Map())
-              : new Map(),
+              : ${fallback},
           `);
                 }
                 else {
+                    const fallback = noDefaultValue ? "undefined" : "{}";
                     chunks.push((0, ts_poet_1.code) `
             ${fieldName}: ${ctx.utils.isObject}(${jsonProperty})
               ? Object.entries(${jsonProperty}).reduce<${fieldType}>((acc, [key, value]) => {
                   acc[${i}] = ${readSnippet("value")};
                   return acc;
                 }, {})
-              : {},
+              : ${fallback},
           `);
                 }
             }
             else {
+                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}: Array.isArray(${jsonPropertyOptional}) ? [...${jsonProperty}] : [],`);
@@ -1287,7 +1294,7 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
                 else {
                     // Explicit `any` type required to make TS with noImplicitAny happy. `object` is also `any` here.
                     chunks.push((0, ts_poet_1.code) `
-            ${fieldName}: Array.isArray(${jsonPropertyOptional}) ? ${jsonProperty}.map((e: any) => ${readValueSnippet}): [],
+            ${fieldName}: Array.isArray(${jsonPropertyOptional}) ? ${jsonProperty}.map((e: any) => ${readValueSnippet}): ${fallback},
           `);
                 }
             }
@@ -1326,7 +1333,7 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
       `);
         }
         else {
-            const fallback = (0, types_1.isWithinOneOf)(field) ? "undefined" : (0, types_1.defaultValue)(ctx, field);
+            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})
           ? ${readSnippet(`${jsonProperty}`)}
@@ -1463,12 +1470,13 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
         };
         if ((0, types_1.isMapType)(ctx, messageDesc, field)) {
             // Maps might need their values transformed, i.e. bytes --> base64
+            const i = convertToObjectKey(ctx, messageDesc, field, "k");
             if (ctx.options.useMapType) {
                 chunks.push((0, ts_poet_1.code) `
           ${jsonProperty} = {};
           if (message.${fieldName}) {
             message.${fieldName}.forEach((v, k) => {
-              ${jsonProperty}[k] = ${readSnippet("v")};
+              ${jsonProperty}[${i}] = ${readSnippet("v")};
             });
           }
         `);
@@ -1478,7 +1486,7 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
           ${jsonProperty} = {};
           if (message.${fieldName}) {
             Object.entries(message.${fieldName}).forEach(([k, v]) => {
-              ${jsonProperty}[k] = ${readSnippet("v")};
+              ${jsonProperty}[${i}] = ${readSnippet("v")};
             });
           }
         `);
@@ -1572,6 +1580,9 @@ function generateFromPartial(ctx, fullName, messageDesc) {
                         else if ((0, types_1.isLong)(valueField) && options.forceLong === options_1.LongOption.LONG) {
                             return (0, ts_poet_1.code) `Long.fromValue(${from})`;
                         }
+                        else if ((0, types_1.isLong)(valueField) && options.forceLong === options_1.LongOption.BIGINT) {
+                            return (0, ts_poet_1.code) `BigInt(${from} as string | number | bigint | boolean)`;
+                        }
                         else {
                             const cstr = (0, case_1.capitalize)(valueType.toCodeString([]));
                             return (0, ts_poet_1.code) `${cstr}(${from})`;
@@ -1607,18 +1618,22 @@ function generateFromPartial(ctx, fullName, messageDesc) {
                 throw new Error(`Unhandled field ${field}`);
             }
         };
+        const noDefaultValue = !options.initializeFieldsAsUndefined && (0, types_1.isOptionalProperty)(field, messageDesc.options, options);
         // and then use the snippet to handle repeated fields if necessary
         if ((0, types_1.isRepeated)(field)) {
             if ((0, types_1.isMapType)(ctx, messageDesc, field)) {
                 const fieldType = (0, types_1.toTypeName)(ctx, messageDesc, field);
-                const i = maybeCastToNumber(ctx, messageDesc, field, "key");
+                const i = convertFromObjectKey(ctx, messageDesc, field, "key");
+                const noValueSnippet = noDefaultValue
+                    ? `(object.${fieldName} === undefined || object.${fieldName} === null) ? undefined : `
+                    : "";
                 if (ctx.options.useMapType) {
                     chunks.push((0, ts_poet_1.code) `
-            message.${fieldName} = (() => {
+            message.${fieldName} = ${noValueSnippet} (() => {
               const m = new Map();
               (object.${fieldName} as ${fieldType} ?? new Map()).forEach((value, key) => {
                 if (value !== undefined) {
-                  m.set(${i}, ${readSnippet("value")});
+                  m.set(key, ${readSnippet("value")});
                 }
               });
               return m;
@@ -1627,7 +1642,7 @@ function generateFromPartial(ctx, fullName, messageDesc) {
                 }
                 else {
                     chunks.push((0, ts_poet_1.code) `
-            message.${fieldName} = Object.entries(object.${fieldName} ?? {}).reduce<${fieldType}>((acc, [key, value]) => {
+            message.${fieldName} = ${noValueSnippet} Object.entries(object.${fieldName} ?? {}).reduce<${fieldType}>((acc, [key, value]) => {
               if (value !== undefined) {
                 acc[${i}] = ${readSnippet("value")};
               }
@@ -1637,8 +1652,9 @@ function generateFromPartial(ctx, fullName, messageDesc) {
                 }
             }
             else {
+                const fallback = noDefaultValue ? "undefined" : "[]";
                 chunks.push((0, ts_poet_1.code) `
-          message.${fieldName} = object.${fieldName}?.map((e) => ${readSnippet("e")}) || [];
+          message.${fieldName} = object.${fieldName}?.map((e) => ${readSnippet("e")}) || ${fallback};
         `);
             }
         }
@@ -1657,11 +1673,11 @@ function generateFromPartial(ctx, fullName, messageDesc) {
         }
         else if (readSnippet(`x`).toCodeString([]) == "x") {
             // An optimized case of the else below that works when `readSnippet` returns the plain input
-            const fallback = (0, types_1.isWithinOneOf)(field) ? "undefined" : (0, types_1.defaultValue)(ctx, field);
+            const fallback = (0, types_1.isWithinOneOf)(field) || noDefaultValue ? "undefined" : (0, types_1.defaultValue)(ctx, field);
             chunks.push((0, ts_poet_1.code) `message.${fieldName} = object.${fieldName} ?? ${fallback};`);
         }
         else {
-            const fallback = (0, types_1.isWithinOneOf)(field) ? "undefined" : (0, types_1.defaultValue)(ctx, field);
+            const fallback = (0, types_1.isWithinOneOf)(field) || noDefaultValue ? "undefined" : (0, types_1.defaultValue)(ctx, field);
             chunks.push((0, ts_poet_1.code) `
         message.${fieldName} = (object.${fieldName} !== undefined && object.${fieldName} !== null)
           ? ${readSnippet(`object.${fieldName}`)}
@@ -1675,13 +1691,47 @@ function generateFromPartial(ctx, fullName, messageDesc) {
     return (0, ts_poet_1.joinCode)(chunks, { on: "\n" });
 }
 exports.contextTypeVar = "Context extends DataLoaders";
-function maybeCastToNumber(ctx, messageDesc, field, variableName) {
-    const { keyType } = (0, types_1.detectMapType)(ctx, messageDesc, field);
+function convertFromObjectKey(ctx, messageDesc, field, variableName) {
+    const { keyType, keyField } = (0, types_1.detectMapType)(ctx, messageDesc, field);
     if (keyType.toCodeString([]) === "string") {
-        return variableName;
+        return (0, ts_poet_1.code) `${variableName}`;
+    }
+    else if ((0, types_1.isLong)(keyField) && ctx.options.useMapType) {
+        if (ctx.options.forceLong === options_1.LongOption.LONG) {
+            return (0, ts_poet_1.code) `${(0, case_1.capitalize)(keyType.toCodeString([]))}.fromValue(${variableName})`;
+        }
+        else if (ctx.options.forceLong === options_1.LongOption.BIGINT) {
+            return (0, ts_poet_1.code) `BigInt(${variableName})`;
+        }
+        else if (ctx.options.forceLong === options_1.LongOption.STRING) {
+            return (0, ts_poet_1.code) `String(${variableName})`;
+        }
+        else {
+            return (0, ts_poet_1.code) `Number(${variableName})`;
+        }
+    }
+    else {
+        return (0, ts_poet_1.code) `Number(${variableName})`;
+    }
+}
+function convertToObjectKey(ctx, messageDesc, field, variableName) {
+    const { keyType, keyField } = (0, types_1.detectMapType)(ctx, messageDesc, field);
+    if (keyType.toCodeString([]) === "string") {
+        return (0, ts_poet_1.code) `${variableName}`;
+    }
+    else if ((0, types_1.isLong)(keyField) && ctx.options.useMapType) {
+        if (ctx.options.forceLong === options_1.LongOption.LONG) {
+            return (0, ts_poet_1.code) `${ctx.utils.longToNumber}(${variableName})`;
+        }
+        else if (ctx.options.forceLong === options_1.LongOption.BIGINT) {
+            return (0, ts_poet_1.code) `${variableName}.toString()`;
+        }
+        else {
+            return (0, ts_poet_1.code) `${variableName}`;
+        }
     }
     else {
-        return `Number(${variableName})`;
+        return (0, ts_poet_1.code) `${variableName}`;
     }
 }
 function maybeReadonly(options) {

package/build/schema.js

@@ -78,8 +78,8 @@ function generateSchema(ctx, fileDesc, sourceInfo) {
     };
     let fileOptions;
     if (fileDesc.options) {
-        fileOptions = encodedOptionsToOptions(ctx, ".google.protobuf.FileOptions", fileDesc.options["_unknownFields"]);
-        delete fileDesc.options["_unknownFields"];
+        fileOptions = encodedOptionsToOptions(ctx, ".google.protobuf.FileOptions", fileDesc.options._unknownFields);
+        delete fileDesc.options._unknownFields;
     }
     const messagesOptions = [];
     (fileDesc.messageType || []).forEach((message) => {
@@ -93,8 +93,8 @@ function generateSchema(ctx, fileDesc, sourceInfo) {
         const methodsOptions = [];
         service.method.forEach((method) => {
             if (method.options) {
-                const methodOptions = encodedOptionsToOptions(ctx, ".google.protobuf.MethodOptions", method.options["_unknownFields"]);
-                delete method.options["_unknownFields"];
+                const methodOptions = encodedOptionsToOptions(ctx, ".google.protobuf.MethodOptions", method.options._unknownFields);
+                delete method.options._unknownFields;
                 if (methodOptions) {
                     methodsOptions.push((0, ts_poet_1.code) `'${method.name}': ${methodOptions}`);
                 }
@@ -102,8 +102,8 @@ function generateSchema(ctx, fileDesc, sourceInfo) {
         });
         let serviceOptions;
         if (service.options) {
-            serviceOptions = encodedOptionsToOptions(ctx, ".google.protobuf.ServiceOptions", service.options["_unknownFields"]);
-            delete service.options["_unknownFields"];
+            serviceOptions = encodedOptionsToOptions(ctx, ".google.protobuf.ServiceOptions", service.options._unknownFields);
+            delete service.options._unknownFields;
         }
         if (methodsOptions.length > 0 || serviceOptions) {
             servicesOptions.push((0, ts_poet_1.code) `
@@ -119,8 +119,8 @@ function generateSchema(ctx, fileDesc, sourceInfo) {
         const valuesOptions = [];
         Enum.value.forEach((value) => {
             if (value.options) {
-                const valueOptions = encodedOptionsToOptions(ctx, ".google.protobuf.EnumValueOptions", value.options["_unknownFields"]);
-                delete value.options["_unknownFields"];
+                const valueOptions = encodedOptionsToOptions(ctx, ".google.protobuf.EnumValueOptions", value.options._unknownFields);
+                delete value.options._unknownFields;
                 if (valueOptions) {
                     valuesOptions.push((0, ts_poet_1.code) `'${value.name}': ${valueOptions}`);
                 }
@@ -128,8 +128,8 @@ function generateSchema(ctx, fileDesc, sourceInfo) {
         });
         let enumOptions;
         if (Enum.options) {
-            enumOptions = encodedOptionsToOptions(ctx, ".google.protobuf.EnumOptions", Enum.options["_unknownFields"]);
-            delete Enum.options["_unknownFields"];
+            enumOptions = encodedOptionsToOptions(ctx, ".google.protobuf.EnumOptions", Enum.options._unknownFields);
+            delete Enum.options._unknownFields;
         }
         if (valuesOptions.length > 0 || enumOptions) {
             enumsOptions.push((0, ts_poet_1.code) `
@@ -185,7 +185,8 @@ function encodedOptionsToOptions(ctx, extendee, encodedOptions) {
         return undefined;
     }
     const resultOptions = [];
-    for (const [key, value] of Object.entries(encodedOptions)) {
+    for (const key in encodedOptions) {
+        const value = encodedOptions[key];
         const extension = extensionCache[extendee][parseInt(key, 10) >>> 3];
         resultOptions.push(getExtensionValue(ctx, extension, value));
     }
@@ -198,8 +199,8 @@ function resolveMessageOptions(ctx, message) {
     const fieldsOptions = [];
     message.field.forEach((field) => {
         if (field.options) {
-            const fieldOptions = encodedOptionsToOptions(ctx, ".google.protobuf.FieldOptions", field.options["_unknownFields"]);
-            delete field.options["_unknownFields"];
+            const fieldOptions = encodedOptionsToOptions(ctx, ".google.protobuf.FieldOptions", field.options._unknownFields);
+            delete field.options._unknownFields;
             if (fieldOptions) {
                 fieldsOptions.push((0, ts_poet_1.code) `'${field.name}': ${fieldOptions}`);
             }
@@ -208,8 +209,8 @@ function resolveMessageOptions(ctx, message) {
     const oneOfsOptions = [];
     message.oneofDecl.forEach((oneOf) => {
         if (oneOf.options) {
-            const oneOfOptions = encodedOptionsToOptions(ctx, ".google.protobuf.OneofOptions", oneOf.options["_unknownFields"]);
-            delete oneOf.options["_unknownFields"];
+            const oneOfOptions = encodedOptionsToOptions(ctx, ".google.protobuf.OneofOptions", oneOf.options._unknownFields);
+            delete oneOf.options._unknownFields;
             if (oneOfOptions) {
                 oneOfsOptions.push((0, ts_poet_1.code) `'${oneOf.name}': ${oneOfOptions}`);
             }
@@ -226,8 +227,8 @@ function resolveMessageOptions(ctx, message) {
     }
     let messageOptions;
     if (message.options) {
-        messageOptions = encodedOptionsToOptions(ctx, ".google.protobuf.MessageOptions", message.options["_unknownFields"]);
-        delete message.options["_unknownFields"];
+        messageOptions = encodedOptionsToOptions(ctx, ".google.protobuf.MessageOptions", message.options._unknownFields);
+        delete message.options._unknownFields;
     }
     if (fieldsOptions.length > 0 || oneOfsOptions.length > 0 || nestedOptions.length > 0 || messageOptions) {
         return (0, ts_poet_1.code) `

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-proto",
-  "version": "1.144.0",
+  "version": "1.145.0",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",
@@ -65,7 +65,7 @@
     "object-hash": "^1.3.1",
     "protobufjs": "^6.11.3",
     "ts-poet": "^6.4.1",
-    "ts-proto-descriptors": "1.7.1"
+    "ts-proto-descriptors": "1.8.0"
   },
   "packageManager": "yarn@3.3.0"
 }