ts-proto 1.153.3 → 1.155.0

package/README.markdown

@@ -728,26 +728,15 @@ Foo.fromJSON({ bar: "" }); // => { bar: '' }
 Foo.fromJSON({ bar: "baz" }); // => { bar: 'baz' }
 ```
 
-When writing JSON, `ts-proto` currently does **not** normalize message when converting to JSON, other than omitting unset fields, but it may do so in the future.
+When writing JSON, `ts-proto` normalizes messages by omitting unset fields and fields set to their default values.
 
 ```typescript
-// Current ts-proto behavior
-Foo.toJSON({}); // => { }
-Foo.toJSON({ bar: undefined }); // => { }
-Foo.toJSON({ bar: "" }); // => { bar: '' } - note: this is the default value, but it's not omitted
-Foo.toJSON({ bar: "baz" }); // => { bar: 'baz' }
-```
-
-```typescript
-// Possible future behavior, where ts-proto would normalize message
 Foo.toJSON({}); // => { }
 Foo.toJSON({ bar: undefined }); // => { }
 Foo.toJSON({ bar: "" }); // => { } - note: omitting the default value, as expected
 Foo.toJSON({ bar: "baz" }); // => { bar: 'baz' }
 ```
 
-- Please open an issue if you need this behavior.
-
 # Well-Known Types
 
 Protobuf comes with several predefined message definitions, called "[Well-Known Types](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf)".

package/build/main.js

@@ -310,29 +310,13 @@ function makeProtobufStructWrapper(options) {
 function makeLongUtils(options, bytes) {
     // Regardless of which `forceLong` config option we're using, we always use
     // the `long` library to either represent or at least sanity-check 64-bit values
-    const util = (0, utils_1.impFile)(options, "util@protobufjs/minimal");
-    const configure = (0, utils_1.impFile)(options, "configure@protobufjs/minimal");
-    // Before esModuleInterop, we had to use 'import * as Long from long` b/c long is
-    // an `export =` module and exports only the Long constructor (which is callable).
-    // See https://www.typescriptlang.org/docs/handbook/modules.html#export--and-import--require.
-    //
-    // With esModuleInterop on, `* as Long` is no longer the constructor, it's the module,
-    // so we want to go back to `import { Long } from long`, which is specifically forbidden
-    // due to `export =` w/o esModuleInterop.
-    //
-    // I.e there is not an import for long that "just works" in both esModuleInterop and
-    // not esModuleInterop.
-    const LongImp = options.esModuleInterop ? (0, ts_poet_1.imp)("Long=long") : (0, ts_poet_1.imp)("Long*long");
-    const disclaimer = options.esModuleInterop
-        ? ""
-        : `
-    // If you get a compile-error about 'Constructor<Long> and ... have no overlap',
-    // add '--ts_proto_opt=esModuleInterop=true' as a flag when calling 'protoc'.`;
+    const util = (0, utils_1.impFile)(options, `util@protobufjs/minimal`);
+    const configure = (0, utils_1.impFile)(options, `configure@protobufjs/minimal`);
+    const LongImp = (0, ts_poet_1.imp)("Long=long");
     // Instead of exposing `LongImp` directly, let callers think that they are getting the
     // `imp(Long)` but really it is that + our long initialization snippet. This means the
     // initialization code will only be emitted in files that actually use the Long import.
     const Long = (0, ts_poet_1.conditionalOutput)("Long", (0, ts_poet_1.code) `
-      ${disclaimer}
       if (${util}.Long !== ${LongImp}) {
         ${util}.Long = ${LongImp} as any;
         ${configure}();
@@ -1662,9 +1646,7 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
         const readSnippet = (from) => {
             if ((0, types_1.isEnum)(field)) {
                 const toJson = (0, types_1.getEnumMethod)(ctx, field.typeName, "ToJSON");
-                return (0, types_1.isWithinOneOf)(field)
-                    ? (0, ts_poet_1.code) `${from} !== undefined ? ${toJson}(${from}) : undefined`
-                    : (0, ts_poet_1.code) `${toJson}(${from})`;
+                return (0, ts_poet_1.code) `${toJson}(${from})`;
             }
             else if ((0, types_1.isObjectId)(field) && options.useMongoObjectId) {
                 return (0, ts_poet_1.code) `${from}.toString()`;
@@ -1729,19 +1711,13 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
             }
             else if ((0, types_1.isMessage)(field) && !(0, types_1.isValueType)(ctx, field) && !(0, types_1.isMapType)(ctx, messageDesc, field)) {
                 const type = (0, types_1.basicTypeName)(ctx, field, { keepValueType: true });
-                return (0, ts_poet_1.code) `${from} ? ${type}.toJSON(${from}) : ${(0, types_1.defaultValue)(ctx, field)}`;
+                return (0, ts_poet_1.code) `${type}.toJSON(${from})`;
             }
             else if ((0, types_1.isBytes)(field)) {
-                if ((0, types_1.isWithinOneOf)(field)) {
-                    return (0, ts_poet_1.code) `${from} !== undefined ? ${utils.base64FromBytes}(${from}) : undefined`;
-                }
-                else {
-                    return (0, ts_poet_1.code) `${utils.base64FromBytes}(${from} !== undefined ? ${from} : ${(0, types_1.defaultValue)(ctx, field)})`;
-                }
+                return (0, ts_poet_1.code) `${utils.base64FromBytes}(${from})`;
             }
             else if ((0, types_1.isLong)(field) && options.forceLong === options_1.LongOption.LONG) {
-                const v = (0, types_1.isWithinOneOf)(field) ? "undefined" : (0, types_1.defaultValue)(ctx, field);
-                return (0, ts_poet_1.code) `(${from} || ${v}).toString()`;
+                return (0, ts_poet_1.code) `(${from} || ${(0, types_1.defaultValue)(ctx, field)}).toString()`;
             }
             else if ((0, types_1.isLong)(field) && options.forceLong === options_1.LongOption.BIGINT) {
                 return (0, ts_poet_1.code) `${from}.toString()`;
@@ -1758,8 +1734,8 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
             const i = convertToObjectKey(ctx, messageDesc, field, "k");
             if (ctx.options.useMapType) {
                 chunks.push((0, ts_poet_1.code) `
-          ${jsonProperty} = {};
-          if (message.${fieldName}) {
+          if (message.${fieldName}?.size) {
+            ${jsonProperty} = {};
             message.${fieldName}.forEach((v, k) => {
               ${jsonProperty}[${i}] = ${readSnippet("v")};
             });
@@ -1768,34 +1744,46 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
             }
             else {
                 chunks.push((0, ts_poet_1.code) `
-          ${jsonProperty} = {};
-          if (message.${fieldName}) {
-            Object.entries(message.${fieldName}).forEach(([k, v]) => {
-              ${jsonProperty}[${i}] = ${readSnippet("v")};
-            });
+        if (message.${fieldName}) {
+            const entries = Object.entries(message.${fieldName});
+            if (entries.length > 0) {
+              ${jsonProperty} = {};
+              entries.forEach(([k, v]) => {
+                ${jsonProperty}[${i}] = ${readSnippet("v")};
+              });
+            }
           }
         `);
             }
         }
         else if ((0, types_1.isRepeated)(field)) {
             // Arrays might need their elements transformed
+            const transformElement = readSnippet("e");
+            const maybeMap = transformElement.toCodeString([]) !== "e" ? (0, ts_poet_1.code) `.map(e => ${transformElement})` : "";
             chunks.push((0, ts_poet_1.code) `
-        if (message.${fieldName}) {
-          ${jsonProperty} = message.${fieldName}.map(e => ${readSnippet("e")});
-        } else {
-          ${jsonProperty} = [];
+        if (message.${fieldName}?.length) {
+          ${jsonProperty} = message.${fieldName}${maybeMap};
         }
       `);
         }
         else if ((0, types_1.isWithinOneOfThatShouldBeUnion)(options, field)) {
             // oneofs in a union are only output as `oneof name = ...`
             const oneofName = (0, case_1.maybeSnakeToCamel)(messageDesc.oneofDecl[field.oneofIndex].name, options);
-            const v = readSnippet(`message.${oneofName}?.${fieldName}`);
-            chunks.push((0, ts_poet_1.code) `message.${oneofName}?.$case === '${fieldName}' && (${jsonProperty} = ${v});`);
+            chunks.push((0, ts_poet_1.code) `
+        if (message.${oneofName}?.$case === '${fieldName}') {
+          ${jsonProperty} = ${readSnippet(`message.${oneofName}.${fieldName}`)};
+        }
+      `);
         }
         else {
-            const v = readSnippet(`message.${fieldName}`);
-            chunks.push((0, ts_poet_1.code) `message.${fieldName} !== undefined && (${jsonProperty} = ${v});`);
+            const check = ((0, types_1.isScalar)(field) || (0, types_1.isEnum)(field)) && !(0, types_1.isWithinOneOf)(field)
+                ? (0, types_1.notDefaultCheck)(ctx, field, messageDesc.options, `message.${fieldName}`)
+                : `message.${fieldName} !== undefined`;
+            chunks.push((0, ts_poet_1.code) `
+        if (${check}) {
+          ${jsonProperty} = ${readSnippet(`message.${fieldName}`)};
+        }
+      `);
         }
     });
     chunks.push((0, ts_poet_1.code) `return obj;`);

package/build/options.js

@@ -202,12 +202,15 @@ function parseParameter(parameter) {
 function parseParamValue(value) {
     return value === "true" ? true : value === "false" ? false : value;
 }
-function getTsPoetOpts(_options) {
-    const imports = ["protobufjs/minimal" + _options.importSuffix];
+function getTsPoetOpts(options) {
+    const { importSuffix, esModuleInterop } = options;
+    const pbjs = "protobufjs/minimal" + importSuffix;
     return {
         prefix: `/* eslint-disable */`,
         dprintOptions: { preferSingleLine: true, lineWidth: 120 },
-        ...(_options.esModuleInterop ? { forceDefaultImport: imports } : { forceModuleImport: imports }),
+        forceRequireImport: esModuleInterop ? [] : ["long"],
+        forceDefaultImport: esModuleInterop ? [pbjs] : [],
+        forceModuleImport: esModuleInterop ? [] : [pbjs],
     };
 }
 exports.getTsPoetOpts = getTsPoetOpts;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-proto",
-  "version": "1.153.3",
+  "version": "1.155.0",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",
@@ -67,8 +67,8 @@
   "dependencies": {
     "case-anything": "^2.1.13",
     "protobufjs": "^7.2.4",
-    "ts-poet": "^6.4.1",
-    "ts-proto-descriptors": "1.12.0"
+    "ts-poet": "^6.5.0",
+    "ts-proto-descriptors": "1.13.0"
   },
   "packageManager": "yarn@3.6.0"
 }