ts-proto 1.156.5 → 1.156.7

package/build/main.js

@@ -614,9 +614,6 @@ function generateInterfaceDeclaration(ctx, fullName, messageDesc, sourceInfo, fu
         const name = (0, case_1.maybeSnakeToCamel)(fieldDesc.name, options);
         const isOptional = (0, types_1.isOptionalProperty)(fieldDesc, messageDesc.options, options);
         const type = (0, types_1.toTypeName)(ctx, messageDesc, fieldDesc, isOptional);
-        if (isOptional && !type.toString().includes("undefined")) {
-            console.warn(name, type);
-        }
         chunks.push((0, ts_poet_1.code) `${maybeReadonly(options)}${name}${isOptional ? "?" : ""}: ${type}, `);
     });
     if (ctx.options.unknownFields) {
@@ -680,7 +677,7 @@ function generateBaseInstanceFactory(ctx, fullName, messageDesc, fullTypeName) {
         const val = (0, types_1.isWithinOneOf)(field)
             ? "undefined"
             : (0, types_1.isMapType)(ctx, messageDesc, field)
-                ? ctx.options.useMapType
+                ? (0, types_1.shouldGenerateJSMapType)(ctx, messageDesc, field)
                     ? "new Map()"
                     : "{}"
                 : (0, types_1.isRepeated)(field)
@@ -808,16 +805,22 @@ function generateDecode(ctx, fullName, messageDesc) {
         const initializerNecessary = !options.initializeFieldsAsUndefined && (0, types_1.isOptionalProperty)(field, messageDesc.options, options);
         if ((0, types_1.isRepeated)(field)) {
             const maybeNonNullAssertion = ctx.options.useOptionals === "all" ? "!" : "";
-            if ((0, types_1.isMapType)(ctx, messageDesc, field)) {
+            const mapType = (0, types_1.detectMapType)(ctx, messageDesc, field);
+            if (mapType) {
                 // We need a unique const within the `cast` statement
                 const varName = `entry${field.number}`;
-                const valueSetterSnippet = ctx.options.useMapType
-                    ? `message.${fieldName}${maybeNonNullAssertion}.set(${varName}.key, ${varName}.value)`
-                    : `message.${fieldName}${maybeNonNullAssertion}[${varName}.key] = ${varName}.value`;
+                const generateMapType = (0, types_1.shouldGenerateJSMapType)(ctx, messageDesc, field);
+                let valueSetterSnippet;
+                if (generateMapType) {
+                    valueSetterSnippet = `message.${fieldName}${maybeNonNullAssertion}.set(${varName}.key, ${varName}.value)`;
+                }
+                else {
+                    valueSetterSnippet = `message.${fieldName}${maybeNonNullAssertion}[${varName}.key] = ${varName}.value`;
+                }
                 const initializerSnippet = initializerNecessary
                     ? `
             if (message.${fieldName} === undefined) {
-              message.${fieldName} = ${ctx.options.useMapType ? "new Map()" : "{}"};
+              message.${fieldName} = ${generateMapType ? "new Map()" : "{}"};
             }`
                     : "";
                 chunks.push((0, ts_poet_1.code) `
@@ -1011,8 +1014,9 @@ function generateEncode(ctx, fullName, messageDesc) {
               }
             `
                     : writeSnippet(`{ ${maybeTypeField} key: key as any, value }`);
-                const optionalAlternative = isOptional ? (ctx.options.useMapType ? " || new Map()" : " || {}") : "";
-                if (ctx.options.useMapType) {
+                const useMapType = (0, types_1.shouldGenerateJSMapType)(ctx, messageDesc, field);
+                const optionalAlternative = isOptional ? (useMapType ? " || new Map()" : " || {}") : "";
+                if (useMapType) {
                     chunks.push((0, ts_poet_1.code) `
             (message.${fieldName}${optionalAlternative}).forEach((value, key) => {
               ${entryWriteSnippet}
@@ -1535,7 +1539,7 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
             if ((0, types_1.isMapType)(ctx, messageDesc, field)) {
                 const fieldType = (0, types_1.toTypeName)(ctx, messageDesc, field);
                 const i = convertFromObjectKey(ctx, messageDesc, field, "key");
-                if (ctx.options.useMapType) {
+                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})
@@ -1736,7 +1740,7 @@ 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) {
+            if ((0, types_1.shouldGenerateJSMapType)(ctx, messageDesc, field)) {
                 chunks.push((0, ts_poet_1.code) `
           if (message.${fieldName}?.size) {
             ${jsonProperty} = {};
@@ -1904,7 +1908,7 @@ function generateFromPartial(ctx, fullName, messageDesc) {
                 const noValueSnippet = noDefaultValue
                     ? `(object.${fieldName} === undefined || object.${fieldName} === null) ? undefined : `
                     : "";
-                if (ctx.options.useMapType) {
+                if ((0, types_1.shouldGenerateJSMapType)(ctx, messageDesc, field)) {
                     chunks.push((0, ts_poet_1.code) `
             message.${fieldName} = ${noValueSnippet} (() => {
               const m = new Map();
@@ -1973,7 +1977,7 @@ function convertFromObjectKey(ctx, messageDesc, field, variableName) {
     if (keyType.toCodeString([]) === "string") {
         return (0, ts_poet_1.code) `${variableName}`;
     }
-    else if ((0, types_1.isLong)(keyField) && ctx.options.useMapType) {
+    else if ((0, types_1.isLong)(keyField) && (0, types_1.shouldGenerateJSMapType)(ctx, messageDesc, field)) {
         if (ctx.options.forceLong === options_1.LongOption.LONG) {
             return (0, ts_poet_1.code) `${(0, case_1.capitalize)(keyType.toCodeString([]))}.fromValue(${variableName})`;
         }
@@ -1996,7 +2000,7 @@ function convertToObjectKey(ctx, messageDesc, field, variableName) {
     if (keyType.toCodeString([]) === "string") {
         return (0, ts_poet_1.code) `${variableName}`;
     }
-    else if ((0, types_1.isLong)(keyField) && ctx.options.useMapType) {
+    else if ((0, types_1.isLong)(keyField) && (0, types_1.shouldGenerateJSMapType)(ctx, messageDesc, field)) {
         if (ctx.options.forceLong === options_1.LongOption.LONG) {
             return (0, ts_poet_1.code) `${ctx.utils.longToNumber}(${variableName})`;
         }

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.observableType = 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;
+exports.detectBatchMethod = exports.responsePromiseOrObservable = exports.responseObservable = exports.responsePromise = exports.responseType = exports.requestType = exports.observableType = exports.rawRequestType = exports.detectMapType = exports.shouldGenerateJSMapType = 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");
@@ -587,7 +587,7 @@ function toTypeName(ctx, messageDesc, field, ensureOptional = false) {
         const mapType = messageDesc ? detectMapType(ctx, messageDesc, field) : false;
         if (mapType) {
             const { keyType, valueType } = mapType;
-            if (ctx.options.useMapType) {
+            if (shouldGenerateJSMapType(ctx, messageDesc, field)) {
                 return finalize((0, ts_poet_1.code) `Map<${keyType}, ${valueType}>`, ensureOptional);
             }
             return finalize((0, ts_poet_1.code) `{ [key: ${keyType} ]: ${valueType} }`, ensureOptional);
@@ -622,6 +622,29 @@ function toTypeName(ctx, messageDesc, field, ensureOptional = false) {
         ensureOptional);
 }
 exports.toTypeName = toTypeName;
+/**
+ * For a protobuf map field, if the generated code should use the javascript Map type.
+ *
+ * If the type of a protobuf map key corresponds to the Long type, we always use the Map type. This avoids generating
+ * invalid code such as below (using Long as key of a javascript object):
+ *
+ * export interface Foo {
+ *  bar: { [key: Long]: Long }
+ * }
+ *
+ * See https://github.com/stephenh/ts-proto/issues/708 for more details.
+ */
+function shouldGenerateJSMapType(ctx, message, field) {
+    if (ctx.options.useMapType) {
+        return true;
+    }
+    const mapType = detectMapType(ctx, message, field);
+    if (!mapType) {
+        return false;
+    }
+    return isLong(mapType.keyField) && ctx.options.forceLong === options_1.LongOption.LONG;
+}
+exports.shouldGenerateJSMapType = shouldGenerateJSMapType;
 function detectMapType(ctx, messageDesc, fieldDesc) {
     var _a;
     const { typeMap } = ctx;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-proto",
-  "version": "1.156.5",
+  "version": "1.156.7",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",
@@ -54,7 +54,7 @@
     "mongodb": "^5.7.0",
     "nice-grpc": "^2.1.4",
     "object-hash": "^3.0.0",
-    "prettier": "^3.0.0",
+    "prettier": "^2.8.8",
     "protobufjs-cli": "^1.1.1",
     "reflect-metadata": "^0.1.13",
     "rxjs": "^7.8.1",