ts-proto 1.102.2 → 1.105.0

package/CHANGELOG.md

@@ -1,3 +1,36 @@
+# [1.105.0](https://github.com/stephenh/ts-proto/compare/v1.104.1...v1.105.0) (2022-02-12)
+
+
+### Features
+
+* Bump ts-proto-descriptors. ([#489](https://github.com/stephenh/ts-proto/issues/489)) ([d454448](https://github.com/stephenh/ts-proto/commit/d454448b1889b1576c1ebcc6964a55a03af7d921)), closes [#493](https://github.com/stephenh/ts-proto/issues/493)
+
+## [1.104.1](https://github.com/stephenh/ts-proto/compare/v1.104.0...v1.104.1) (2022-02-12)
+
+
+### Bug Fixes
+
+* make struct types play well with type registry ([#503](https://github.com/stephenh/ts-proto/issues/503)) ([d62f854](https://github.com/stephenh/ts-proto/commit/d62f85478011c7eb3dbca196f79b452895406ece))
+
+# [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)
 
 

package/README.markdown

@@ -376,11 +376,22 @@ 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.
 
-### Only Types
+- With `--ts_proto_opt=onlyTypes=true`, only types will be emitted, and imports for `long` and `protobufjs/minimal` will be excluded.
+
+  Note: _This is a combination_ of `outputJsonMethods=false,outputEncodeMethods=false,outputClientImpl=false,nestJs=false`
+
+- 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.:
 
-`--ts_proto_opt=outputEncodeMethods=false,outputJsonMethods=false,outputClientImpl=false`.
+`--ts_proto_opt=onlyTypes=true`.
 
 ### NestJS Support
 

package/build/case.js

@@ -7,13 +7,9 @@ function maybeSnakeToCamel(s, options) {
         return s
             .split('_')
             .map((word, i) => {
-            if (i === 0) {
-                // if first symbol is "_" then skip it
-                return word ? word[0] + (hasLowerCase ? word.substring(1) : 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);
@@ -1341,7 +1349,7 @@ function generateWrap(ctx, fullProtoTypeName) {
     const chunks = [];
     if (types_1.isStructTypeName(fullProtoTypeName)) {
         chunks.push(ts_poet_1.code `wrap(object: {[key: string]: any} | undefined): Struct {
-      const struct = Struct.fromPartial({});
+      const struct = createBaseStruct();
       if (object !== undefined) {
         Object.keys(object).forEach(key => {
           struct.fields[key] = object[key];
@@ -1353,50 +1361,58 @@ function generateWrap(ctx, fullProtoTypeName) {
     if (types_1.isAnyValueTypeName(fullProtoTypeName)) {
         if (ctx.options.oneof === options_1.OneofOption.UNIONS) {
             chunks.push(ts_poet_1.code `wrap(value: any): Value {
-      if (value === null) {
-        return {kind: {$case: 'nullValue', nullValue: NullValue.NULL_VALUE}};
-      } else if (typeof value === 'boolean') {
-        return {kind: {$case: 'boolValue', boolValue: value}};
-      } else if (typeof value === 'number') {
-        return {kind: {$case: 'numberValue', numberValue: value}};
-      } else if (typeof value === 'string') {
-        return {kind: {$case: 'stringValue', stringValue: value}};
-      } else if (Array.isArray(value)) {
-        return {kind: {$case: 'listValue', listValue: value}};
-      } else if (typeof value === 'object') {
-        return {kind: {$case: 'structValue', structValue: value}};
-      } else if (typeof value === 'undefined') {
-        return {} as Value;
-      } else {
-        throw new Error('Unsupported any value type: ' + typeof value);
-      }
+        const result = createBaseValue();
+        
+        if (value === null) {
+          result.kind = {$case: 'nullValue', nullValue: NullValue.NULL_VALUE};
+        } else if (typeof value === 'boolean') {
+          result.kind = {$case: 'boolValue', boolValue: value};
+        } else if (typeof value === 'number') {
+          result.kind = {$case: 'numberValue', numberValue: value};
+        } else if (typeof value === 'string') {
+          result.kind = {$case: 'stringValue', stringValue: value};
+        } else if (Array.isArray(value)) {
+          result.kind = {$case: 'listValue', listValue: value};
+        } else if (typeof value === 'object') {
+          result.kind = {$case: 'structValue', structValue: value};
+        } else if (typeof value !== 'undefined') {
+          throw new Error('Unsupported any value type: ' + typeof value);
+        }
+
+        return result;
     }`);
         }
         else {
             chunks.push(ts_poet_1.code `wrap(value: any): Value {
-      if (value === null) {
-        return {nullValue: NullValue.NULL_VALUE} as Value;
-      } else if (typeof value === 'boolean') {
-        return {boolValue: value} as Value;
-      } else if (typeof value === 'number') {
-        return {numberValue: value} as Value;
-      } else if (typeof value === 'string') {
-        return {stringValue: value} as Value;
-      } else if (Array.isArray(value)) {
-        return {listValue: value} as Value;
-      } else if (typeof value === 'object') {
-        return {structValue: value} as Value;
-      } else if (typeof value === 'undefined') {
-        return {} as Value;
-      } else {
-        throw new Error('Unsupported any value type: ' + typeof value);
-      }
+        const result = createBaseValue();
+
+        if (value === null) {
+          result.nullValue = NullValue.NULL_VALUE;
+        } else if (typeof value === 'boolean') {
+          result.boolValue = value;
+        } else if (typeof value === 'number') {
+          result.numberValue = value;
+        } else if (typeof value === 'string') {
+          result.stringValue = value;
+        } else if (Array.isArray(value)) {
+          result.listValue = value;
+        } else if (typeof value === 'object') {
+          result.structValue = value;
+        } else if (typeof value !== 'undefined') {
+          throw new Error('Unsupported any value type: ' + typeof value);
+        }
+
+        return result;
     }`);
         }
     }
     if (types_1.isListValueTypeName(fullProtoTypeName)) {
         chunks.push(ts_poet_1.code `wrap(value: Array<any> | undefined): ListValue {
-      return {values: value ?? []};
+      const result = createBaseListValue();
+
+      result.values = value ?? [];
+
+      return result;
     }`);
     }
     return chunks;

package/build/options.js

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

package/build/schema.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateSchema = void 0;
+const ts_proto_descriptors_1 = require("ts-proto-descriptors");
 const ts_poet_1 = require("ts-poet");
 const visit_1 = require("./visit");
 const utils_1 = require("./utils");
@@ -36,7 +37,7 @@ function generateSchema(ctx, fileDesc, sourceInfo) {
         return ts_poet_1.code `${ts_poet_1.imp(`protoMetadata@./${dep.replace('.proto', '')}`)}`;
     });
     // Use toObject so that we get enums as numbers (instead of the default toJSON behavior)
-    const descriptor = { ...fileDesc };
+    const descriptor = ts_proto_descriptors_1.FileDescriptorProto.fromPartial(fileDesc);
     // Only keep locations that include comments
     descriptor.sourceCodeInfo = {
         location: ((_a = descriptor.sourceCodeInfo) === null || _a === void 0 ? void 0 : _a.location.filter((loc) => loc['leadingComments'] || loc['trailingComments'])) || [],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-proto",
-  "version": "1.102.2",
+  "version": "1.105.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.3.1"
+    "ts-proto-descriptors": "1.6.0"
   }
 }