ts-proto 2.11.10 → 2.12.1

package/README.markdown

@@ -7,7 +7,7 @@
 
 ## ts-proto 2.x Release Notes
 
-The 2.x release of ts-proto migrated the low-level Protobuf serializing that its `encode` and `decode` method use from the venerable, but aging & stagnant, `protobufjs` package to `@bufbuild/protobuf`.
+The 2.x release of ts-proto migrated the low-level Protobuf serializing that its `encode` and `decode` method use from the venerable `protobufjs` package to `@bufbuild/protobuf`.
 
 If you only used the `encode` and `decode` methods, this should largely be a non-breaking change.
 
@@ -321,7 +321,7 @@ Generated code will be placed in the Gradle build directory.
 
   With `--ts_proto_opt=forceLong=string`, all 64-bit numbers will be output as strings.
 
-  With `--ts_proto_opt=forceLong=bigint`, all 64-bit numbers will be output as `BigInt`s. This option still uses the `long` library to encode/decode internally within `protobuf.js`, but then converts to/from `BigInt`s in the ts-proto-generated code.
+  With `--ts_proto_opt=forceLong=bigint`, all 64-bit numbers will be output as `BigInt`s. This option still uses the `long` library to encode/decode internally within `protobuf.js`, but then converts to/from `BigInt`s in the ts-proto-generated code. As with `forceLong=long`, `DeepPartial` widens 64-bit fields to `string | number | bigint`, and `fromPartial`/`create` coerce those inputs to `BigInt` (matching what `fromJSON` already does), so you can pass a string or number and get a `BigInt` back.
 
   The default behavior is `forceLong=number`, which will internally still use the `long` library to encode/decode values on the wire (so you will still see a `util.Long = Long` line in your output), but will convert the `long` values to `number` automatically for you. Note that a runtime error is thrown if, while doing this conversion, a 64-bit value is larger than can be correctly stored as a `number`.
 

package/build/src/main.js

@@ -492,6 +492,8 @@ function makeDeepPartial(options, longs) {
     const maybeExport = options.exportCommonSymbols ? "export" : "";
     // Allow passing longs as numbers or strings, nad we'll convert them
     const maybeLong = options.forceLong === options_1.LongOption.LONG ? (0, ts_poet_1.code) ` : T extends ${longs.Long} ? string | number | Long ` : "";
+    // Allow passing bigints as numbers or strings; fromPartial coerces them via BigInt()
+    const maybeBigInt = options.forceLong === options_1.LongOption.BIGINT ? (0, ts_poet_1.code) `T extends bigint ? string | number | bigint : ` : "";
     const optionalBuiltins = [];
     if (options.forceLong === options_1.LongOption.BIGINT) {
         optionalBuiltins.push("bigint");
@@ -512,7 +514,7 @@ function makeDeepPartial(options, longs) {
     // Based on the type from ts-essentials
     const keys = (0, options_1.addTypeToMessages)(options) ? (0, ts_poet_1.code) `Exclude<keyof T, '$type'>` : (0, ts_poet_1.code) `keyof T`;
     const DeepPartial = (0, ts_poet_1.conditionalOutput)("DeepPartial", (0, ts_poet_1.code) `
-      ${maybeExport} type DeepPartial<T> =  T extends ${Builtin}
+      ${maybeExport} type DeepPartial<T> = ${maybeBigInt} T extends ${Builtin}
         ? T
         ${maybeLong}
         : T extends globalThis.Array<infer U>
@@ -720,7 +722,7 @@ function makeTimestampMethods(options, longs, bytes) {
               const seconds = ${seconds};
               const remainder = instant.round({ smallestUnit: "seconds",  roundingMode: "floor" }).until(instant);
               const nanos = (remainder.milliseconds * 1_000_000) + (remainder.microseconds * 1_000) + remainder.nanoseconds;
-            
+
               return { ${maybeTypeField} seconds, nanos };
             }
           `
@@ -1087,7 +1089,13 @@ function generateDecode(ctx, fullName, messageDesc) {
       length?: number,
     ): ${fullName} {
       const reader = input instanceof ${BinaryReader} ? input : new ${BinaryReader}(input);
-      const end = length === undefined ? reader.len : reader.pos + length;
+      const previousRecursionDepth = (reader as any).__tsProtoDecodeDepth ?? 0;
+      if (previousRecursionDepth >= 100) {
+        throw new ${ctx.utils.globalThis}.Error("protobuf decode recursion limit exceeded");
+      }
+      (reader as any).__tsProtoDecodeDepth = previousRecursionDepth + 1;
+      try {
+        const end = length === undefined ? reader.len : reader.pos + length;
   `);
     chunks.push((0, ts_poet_1.code) `const message = ${createBase}${maybeAsAny(options)};`);
     // start the tag loop
@@ -1253,7 +1261,12 @@ function generateDecode(ctx, fullName, messageDesc) {
     // and then wrap up the while/return
     chunks.push((0, ts_poet_1.code) `}`);
     chunks.push((0, ts_poet_1.code) `return message;`);
-    chunks.push((0, ts_poet_1.code) `}`);
+    chunks.push((0, ts_poet_1.code) `
+      } finally {
+        (reader as any).__tsProtoDecodeDepth = previousRecursionDepth;
+      }
+    }
+  `);
     return (0, ts_poet_1.joinCode)(chunks, { on: "\n" });
 }
 /** Returns a generic writer.doSomething based on the basic type */
@@ -2037,7 +2050,10 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
                         protoJsonComparison = (0, ts_poet_1.code) `
                  : ${ctx.utils.isObject}(${protoJsonProperty})
                  ? (${ctx.utils.globalThis}.Object.entries(${protoJsonProperty}) as [string, any][]).reduce((acc: ${fieldType}, [key, value]: [string, any]) => {
-                     acc[${i}] = ${readSnippet("value")};
+                     ${ctx.utils.globalThis}.Object.defineProperty(acc, ${i}, {
+                       value: ${readSnippet("value")},
+                       enumerable: true, configurable: true, writable: true,
+                     });
                      return acc;
                    }, {})
                `;
@@ -2045,7 +2061,10 @@ function generateFromJson(ctx, fullName, fullTypeName, messageDesc) {
                     chunks.push((0, ts_poet_1.code) `
             ${fieldKey}: ${ctx.utils.isObject}(${jsonProperty})
               ? (${ctx.utils.globalThis}.Object.entries(${jsonProperty}) as [string, any][]).reduce((acc: ${fieldType}, [key, value]: [string, any]) => {
-                  acc[${i}] = ${readSnippet("value")};
+                  ${ctx.utils.globalThis}.Object.defineProperty(acc, ${i}, {
+                    value: ${readSnippet("value")},
+                    enumerable: true, configurable: true, writable: true,
+                  });
                   return acc;
                 }, {})
               ${protoJsonComparison}
@@ -2219,6 +2238,9 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
         const jsonName = (0, utils_1.getFieldJsonName)(field, options);
         const jsonProperty = (0, utils_1.getPropertyAccessor)("obj", jsonName);
         const messageProperty = (0, utils_1.getPropertyAccessor)("message", fieldName);
+        const setJsonProperty = (value) => jsonName === "__proto__"
+            ? (0, ts_poet_1.code) `${utils.globalThis}.Object.defineProperty(obj, "__proto__", { value: ${value}, enumerable: true });`
+            : (0, ts_poet_1.code) `${jsonProperty} = ${value};`;
         const readSnippet = (from) => {
             if ((0, types_1.isEnum)(field)) {
                 const toJson = (0, types_1.getEnumMethod)(ctx, field.typeName, "ToJSON");
@@ -2330,7 +2352,7 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
             if ((0, types_1.shouldGenerateJSMapType)(ctx, messageDesc, field)) {
                 chunks.push((0, ts_poet_1.code) `
           if (${messageProperty}?.size) {
-            ${jsonProperty} = {};
+            ${setJsonProperty("{}")}
             ${messageProperty}.forEach((v, k) => {
               ${jsonProperty}[${i}] = ${readSnippet("v")};
             });
@@ -2343,7 +2365,7 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
         if (${messageProperty}) {
             const entries = ${utils.globalThis}.Object.entries(${messageProperty}) as [string, ${mapInfo.valueType}][];
             if (entries.length > 0) {
-              ${jsonProperty} = {};
+              ${setJsonProperty("{}")}
               entries.forEach(([k, v]) => {
                 ${jsonProperty}[${i}] = ${readSnippet("v")};
               });
@@ -2358,7 +2380,7 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
             const maybeMap = needMap ? (0, ts_poet_1.code) `.map(e => ${readSnippet("e")})` : "";
             chunks.push((0, ts_poet_1.code) `
         if (${messageProperty}?.length) {
-          ${jsonProperty} = ${messageProperty}${maybeMap};
+          ${setJsonProperty((0, ts_poet_1.code) `${messageProperty}${maybeMap}`)}
         }
       `);
         }
@@ -2370,7 +2392,7 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
             const valueName = (0, utils_1.oneofValueName)(fieldName, options);
             chunks.push((0, ts_poet_1.code) `
         ${currentIfTarget === oneofNameWithMessage ? "else " : ""}if (${oneofNameWithMessage}?.$case === '${fieldName}') {
-          ${jsonProperty} = ${readSnippet(`${oneofNameWithMessage}.${valueName}`)};
+          ${setJsonProperty(readSnippet(`${oneofNameWithMessage}.${valueName}`))}
         }
       `);
             currentIfTarget = oneofNameWithMessage;
@@ -2382,7 +2404,7 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
                 : `${messageProperty} !== undefined ${(0, utils_1.withAndMaybeCheckIsNotNull)(options, messageProperty)}`;
             chunks.push((0, ts_poet_1.code) `
         if (${check}) {
-          ${jsonProperty} = ${readSnippet(`${messageProperty}`)};
+          ${setJsonProperty(readSnippet(`${messageProperty}`))}
         }
       `);
         }
@@ -2443,6 +2465,11 @@ function generateFromPartial(ctx, fullName, messageDesc) {
                 !(0, types_1.isJsTypeFieldOption)(options, field)) {
                 return (0, ts_poet_1.code) `Long.fromValue(${from})`;
             }
+            else if (((0, types_1.isLong)(field) || (0, types_1.isLongValueType)(field)) &&
+                options.forceLong === options_1.LongOption.BIGINT &&
+                !(0, types_1.isJsTypeFieldOption)(options, field)) {
+                return (0, ts_poet_1.code) `BigInt(${from})`;
+            }
             else if ((0, types_1.isObjectId)(field) && options.useMongoObjectId) {
                 return (0, ts_poet_1.code) `${from} as mongodb.ObjectId`;
             }

package/build/src/types.js

@@ -296,7 +296,7 @@ function defaultValue(ctx, field) {
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_BOOL:
             return useDefaultValue ? field.defaultValue : false;
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_STRING:
-            return useDefaultValue ? `"${field.defaultValue}"` : '""';
+            return useDefaultValue ? JSON.stringify(field.defaultValue) : '""';
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_BYTES:
             // todo(proto2): need to look into all the possible default values for the bytes type, and handle each one
             if (options.env === options_1.EnvOption.NODE) {

package/package.json

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