ts-proto 1.102.0 → 1.104.0

package/CHANGELOG.md

@@ -1,3 +1,36 @@
+# [1.104.0](https://github.com/stephenh/ts-proto/compare/v1.103.0...v1.104.0) (2022-01-21)
+
+
+### Bug Fixes
+
+* Leave mixed case in all words. ([#488](https://github.com/stephenh/ts-proto/issues/488)) ([8a26c9c](https://github.com/stephenh/ts-proto/commit/8a26c9cba4c9897700aafe1a7f59d0b0f537764b))
+
+
+### Features
+
+* enable prototype for defaults for ts-proto-descriptors ([#487](https://github.com/stephenh/ts-proto/issues/487)) ([2b5640f](https://github.com/stephenh/ts-proto/commit/2b5640f582e6adb4e81797a9cec217896061aadb))
+
+# [1.103.0](https://github.com/stephenh/ts-proto/compare/v1.102.2...v1.103.0) (2022-01-20)
+
+
+### Features
+
+* add usePrototypeForDefaults option ([#484](https://github.com/stephenh/ts-proto/issues/484)) ([8e8c810](https://github.com/stephenh/ts-proto/commit/8e8c81016968e7d772dfac5ed54800898f039cbe))
+
+## [1.102.2](https://github.com/stephenh/ts-proto/compare/v1.102.1...v1.102.2) (2022-01-19)
+
+
+### Bug Fixes
+
+* Have snakeToCamel leave existing mixed case. ([#482](https://github.com/stephenh/ts-proto/issues/482)) ([c0bf0fc](https://github.com/stephenh/ts-proto/commit/c0bf0fc13da70e2bde923cd1746119d2e7ac4b2f)), closes [#478](https://github.com/stephenh/ts-proto/issues/478)
+
+## [1.102.1](https://github.com/stephenh/ts-proto/compare/v1.102.0...v1.102.1) (2022-01-19)
+
+
+### Bug Fixes
+
+* Pin ts-proto-descriptors to 1.3.1. ([#481](https://github.com/stephenh/ts-proto/issues/481)) ([6f362bf](https://github.com/stephenh/ts-proto/commit/6f362bfd3517a6bcb440d65e7ac63cd2b0bcc293)), closes [#480](https://github.com/stephenh/ts-proto/issues/480)
+
 # [1.102.0](https://github.com/stephenh/ts-proto/compare/v1.101.0...v1.102.0) (2022-01-18)
 
 

package/README.markdown

@@ -376,6 +376,14 @@ Generated code will be placed in the Gradle build directory.
 
 - With `--ts_proto_opt=unknownFields=true`, all unknown fields will be parsed and output as arrays of buffers.
 
+- With `--ts_proto_opt=usePrototypeForDefaults=true`, the generated code will wrap new objects with `Object.create`.
+
+  This allows code to do hazzer checks to detect when default values have been applied, which due to proto3's behavior of not putting default values on the wire, is typically only useful for interacting with proto2 messages.
+
+  When enabled, default values are inherited from a prototype, and so code can use Object.keys().includes("someField") to detect if someField was actually decoded or not.
+
+  Note that, as indicated, this means Object.keys will not include set-by-default fields, so if you have code that iterates over messages keys in a generic fashion, it will have to also iterate over keys inherited from the prototype.
+
 ### Only Types
 
 If you're looking for `ts-proto` to generate only types for your Protobuf types then passing all three of `outputEncodeMethods`, `outputJsonMethods`, and `outputClientImpl` as `false` is probably what you want, i.e.:

package/build/case.js

@@ -3,16 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.camelCase = exports.capitalize = exports.camelToSnake = exports.maybeSnakeToCamel = void 0;
 function maybeSnakeToCamel(s, options) {
     if (options.snakeToCamel.includes('keys') && s.includes('_')) {
+        const hasLowerCase = !!s.match(/[a-z]/);
         return s
             .split('_')
             .map((word, i) => {
-            if (i === 0) {
-                // if first symbol is "_" then skip it
-                return word ? word[0] + word.substring(1).toLowerCase() : '';
-            }
-            else {
-                return capitalize(word.toLowerCase());
-            }
+            // If the word is already mixed case, leave the exist case as-is
+            word = hasLowerCase ? word : word.toLowerCase();
+            return i === 0 ? word : capitalize(word);
         })
             .join('');
     }

package/build/main.js

@@ -537,6 +537,10 @@ function generateBaseInstanceFactory(ctx, fullName, messageDesc, fullTypeName) {
 function generateDecode(ctx, fullName, messageDesc) {
     const { options, utils, typeMap } = ctx;
     const chunks = [];
+    let createBase = ts_poet_1.code `createBase${fullName}()`;
+    if (options.usePrototypeForDefaults) {
+        createBase = ts_poet_1.code `Object.create(${createBase}) as ${fullName}`;
+    }
     // create the basic function declaration
     chunks.push(ts_poet_1.code `
     decode(
@@ -545,7 +549,7 @@ function generateDecode(ctx, fullName, messageDesc) {
     ): ${fullName} {
       const reader = input instanceof ${Reader} ? input : new ${Reader}(input);
       let end = length === undefined ? reader.len : reader.pos + length;
-      const message = createBase${fullName}();
+      const message = ${createBase};
   `);
     if (options.unknownFields) {
         chunks.push(ts_poet_1.code `(message as any)._unknownFields = {}`);
@@ -1221,7 +1225,11 @@ function generateFromPartial(ctx, fullName, messageDesc) {
       fromPartial(${paramName}: ${utils.DeepPartial}<${fullName}>): ${fullName} {
     `);
     }
-    chunks.push(ts_poet_1.code `const message = createBase${fullName}();`);
+    let createBase = ts_poet_1.code `createBase${fullName}()`;
+    if (options.usePrototypeForDefaults) {
+        createBase = ts_poet_1.code `Object.create(${createBase}) as ${fullName}`;
+    }
+    chunks.push(ts_poet_1.code `const message = ${createBase};`);
     // add a check for each incoming field
     messageDesc.field.forEach((field) => {
         const fieldName = case_1.maybeSnakeToCamel(field.name, options);

package/build/options.js

@@ -64,6 +64,7 @@ function defaultOptions() {
         emitImportedFiles: true,
         useExactTypes: true,
         unknownFields: false,
+        usePrototypeForDefaults: false,
     };
 }
 exports.defaultOptions = defaultOptions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-proto",
-  "version": "1.102.0",
+  "version": "1.104.0",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",
@@ -64,6 +64,6 @@
     "object-hash": "^1.3.1",
     "protobufjs": "^6.8.8",
     "ts-poet": "^4.5.0",
-    "ts-proto-descriptors": "^1.2.1"
+    "ts-proto-descriptors": "1.3.1"
   }
 }