feat: optional one of properties (#705)

* feat(plugin): optional fields for oneof properties * chore: remove yarn-error log * test: add omit oneOf fields test Co-authored-by: Larkooo <larko236@outlook.com> Co-authored-by: Stephen Haberman <stephen.haberman@gmail.com>
stephenh · Nov 20, 2022 · 4c6cbb0 · 4c6cbb0
1 parent 55d2920
commit 4c6cbb0
Show file tree

Hide file tree

Showing 20 changed files with 83 additions and 72 deletions.
diff --git a/integration/grpc-js/google/protobuf/struct.ts b/integration/grpc-js/google/protobuf/struct.ts
@@ -67,27 +67,27 @@ export interface Struct_FieldsEntry {
  */
 export interface Value {
   /** Represents a null value. */
-  nullValue:
+  nullValue?:
     | NullValue
     | undefined;
   /** Represents a double value. */
-  numberValue:
+  numberValue?:
     | number
     | undefined;
   /** Represents a string value. */
-  stringValue:
+  stringValue?:
     | string
     | undefined;
   /** Represents a boolean value. */
-  boolValue:
+  boolValue?:
     | boolean
     | undefined;
   /** Represents a structured value. */
-  structValue:
+  structValue?:
     | { [key: string]: any }
     | undefined;
   /** Represents a repeated `Value`. */
-  listValue: Array<any> | undefined;
+  listValue?: Array<any> | undefined;
 }
 
 /**

diff --git a/integration/meta-typings/simple.ts b/integration/meta-typings/simple.ts
@@ -78,8 +78,8 @@ export interface Nested_InnerMessage_DeepMessage {
 }
 
 export interface OneOfMessage {
-  first: string | undefined;
-  last: string | undefined;
+  first?: string | undefined;
+  last?: string | undefined;
 }
 
 export interface SimpleWithWrappers {

diff --git a/integration/nice-grpc/google/protobuf/struct.ts b/integration/nice-grpc/google/protobuf/struct.ts
@@ -67,27 +67,27 @@ export interface Struct_FieldsEntry {
  */
 export interface Value {
   /** Represents a null value. */
-  nullValue:
+  nullValue?:
     | NullValue
     | undefined;
   /** Represents a double value. */
-  numberValue:
+  numberValue?:
     | number
     | undefined;
   /** Represents a string value. */
-  stringValue:
+  stringValue?:
     | string
     | undefined;
   /** Represents a boolean value. */
-  boolValue:
+  boolValue?:
     | boolean
     | undefined;
   /** Represents a structured value. */
-  structValue:
+  structValue?:
     | { [key: string]: any }
     | undefined;
   /** Represents a repeated `Value`. */
-  listValue: Array<any> | undefined;
+  listValue?: Array<any> | undefined;
 }
 
 /**

diff --git a/integration/oneof-properties/oneof-properties-test.ts b/integration/oneof-properties/oneof-properties-test.ts
@@ -161,4 +161,12 @@ describe('oneof=properties (default)', () => {
     let fromJson = PleaseChoose.fromJSON(pbjsJson);
     expect(fromJson).toEqual(debbie);
   });
+
+  it('should allow to omit oneOf fields', () => {
+    const msg: PleaseChoose = {
+       name: 'foo',
+       age: 42,
+    };
+    expect(msg).toBeDefined();
+  });
 });
diff --git a/integration/oneof-properties/oneof.ts b/integration/oneof-properties/oneof.ts
@@ -9,28 +9,28 @@ export interface PleaseChoose {
    * Use this if you want a number. Numbers are great. Who doesn't
    * like them?
    */
-  aNumber:
+  aNumber?:
     | number
     | undefined;
   /**
    * Use this if you want a string. Strings are also nice. Not as
    * nice as numbers, but what are you going to do...
    */
-  aString: string | undefined;
-  aMessage:
+  aString?: string | undefined;
+  aMessage?:
     | PleaseChoose_Submessage
     | undefined;
   /**
    * We also added a bool option! This was added after the 'age'
    * field, so it has a higher number.
    */
-  aBool: boolean | undefined;
-  bunchaBytes: Uint8Array | undefined;
-  anEnum: PleaseChoose_StateEnum | undefined;
+  aBool?: boolean | undefined;
+  bunchaBytes?: Uint8Array | undefined;
+  anEnum?: PleaseChoose_StateEnum | undefined;
   age: number;
-  either: string | undefined;
-  or: string | undefined;
-  thirdOption: string | undefined;
+  either?: string | undefined;
+  or?: string | undefined;
+  thirdOption?: string | undefined;
 }
 
 export enum PleaseChoose_StateEnum {

diff --git a/integration/options/options.ts b/integration/options/options.ts
@@ -16,7 +16,7 @@ export interface MyMessage {
   foo?: number | undefined;
   foo2?: number | undefined;
   bar?: string | undefined;
-  quux: string | undefined;
+  quux?: string | undefined;
 }
 
 export interface RequestType {

diff --git a/integration/simple-optionals/simple.ts b/integration/simple-optionals/simple.ts
@@ -169,8 +169,8 @@ export interface Nested_InnerMessage_DeepMessage {
 }
 
 export interface OneOfMessage {
-  first: string | undefined;
-  last: string | undefined;
+  first?: string | undefined;
+  last?: string | undefined;
 }
 
 export interface SimpleWithWrappers {

diff --git a/integration/simple-prototype-defaults/simple.ts b/integration/simple-prototype-defaults/simple.ts
@@ -173,8 +173,8 @@ export interface Nested_InnerMessage_DeepMessage {
 }
 
 export interface OneOfMessage {
-  first: string | undefined;
-  last: string | undefined;
+  first?: string | undefined;
+  last?: string | undefined;
 }
 
 export interface SimpleWithWrappers {

diff --git a/integration/simple-snake/google/protobuf/struct.ts b/integration/simple-snake/google/protobuf/struct.ts
@@ -67,27 +67,27 @@ export interface Struct_FieldsEntry {
  */
 export interface Value {
   /** Represents a null value. */
-  null_value:
+  null_value?:
     | NullValue
     | undefined;
   /** Represents a double value. */
-  number_value:
+  number_value?:
     | number
     | undefined;
   /** Represents a string value. */
-  string_value:
+  string_value?:
     | string
     | undefined;
   /** Represents a boolean value. */
-  bool_value:
+  bool_value?:
     | boolean
     | undefined;
   /** Represents a structured value. */
-  struct_value:
+  struct_value?:
     | { [key: string]: any }
     | undefined;
   /** Represents a repeated `Value`. */
-  list_value: Array<any> | undefined;
+  list_value?: Array<any> | undefined;
 }
 
 /**

diff --git a/integration/simple-snake/simple.ts b/integration/simple-snake/simple.ts
@@ -170,8 +170,8 @@ export interface Nested_InnerMessage_DeepMessage {
 }
 
 export interface OneOfMessage {
-  first: string | undefined;
-  last: string | undefined;
+  first?: string | undefined;
+  last?: string | undefined;
 }
 
 export interface SimpleWithWrappers {

diff --git a/integration/simple-string-enums/google/protobuf/struct.ts b/integration/simple-string-enums/google/protobuf/struct.ts
@@ -77,27 +77,27 @@ export interface Struct_FieldsEntry {
  */
 export interface Value {
   /** Represents a null value. */
-  nullValue:
+  nullValue?:
     | NullValue
     | undefined;
   /** Represents a double value. */
-  numberValue:
+  numberValue?:
     | number
     | undefined;
   /** Represents a string value. */
-  stringValue:
+  stringValue?:
     | string
     | undefined;
   /** Represents a boolean value. */
-  boolValue:
+  boolValue?:
     | boolean
     | undefined;
   /** Represents a structured value. */
-  structValue:
+  structValue?:
     | { [key: string]: any }
     | undefined;
   /** Represents a repeated `Value`. */
-  listValue: Array<any> | undefined;
+  listValue?: Array<any> | undefined;
 }
 
 /**

diff --git a/integration/simple-unrecognized-enum/simple.ts b/integration/simple-unrecognized-enum/simple.ts
@@ -157,8 +157,8 @@ export interface Nested_InnerMessage_DeepMessage {
 }
 
 export interface OneOfMessage {
-  first: string | undefined;
-  last: string | undefined;
+  first?: string | undefined;
+  last?: string | undefined;
 }
 
 export interface SimpleWithWrappers {

diff --git a/integration/simple/simple.ts b/integration/simple/simple.ts
@@ -174,8 +174,8 @@ export interface Nested_InnerMessage_DeepMessage {
 }
 
 export interface OneOfMessage {
-  first: string | undefined;
-  last: string | undefined;
+  first?: string | undefined;
+  last?: string | undefined;
 }
 
 export interface SimpleWithWrappers {

diff --git a/integration/struct/google/protobuf/struct.ts b/integration/struct/google/protobuf/struct.ts
@@ -67,27 +67,27 @@ export interface Struct_FieldsEntry {
  */
 export interface Value {
   /** Represents a null value. */
-  nullValue:
+  nullValue?:
     | NullValue
     | undefined;
   /** Represents a double value. */
-  numberValue:
+  numberValue?:
     | number
     | undefined;
   /** Represents a string value. */
-  stringValue:
+  stringValue?:
     | string
     | undefined;
   /** Represents a boolean value. */
-  boolValue:
+  boolValue?:
     | boolean
     | undefined;
   /** Represents a structured value. */
-  structValue:
+  structValue?:
     | { [key: string]: any }
     | undefined;
   /** Represents a repeated `Value`. */
-  listValue: Array<any> | undefined;
+  listValue?: Array<any> | undefined;
 }
 
 /**

diff --git a/integration/type-registry/google/protobuf/struct.ts b/integration/type-registry/google/protobuf/struct.ts
@@ -71,27 +71,27 @@ export interface Struct_FieldsEntry {
 export interface Value {
   $type: "google.protobuf.Value";
   /** Represents a null value. */
-  nullValue:
+  nullValue?:
     | NullValue
     | undefined;
   /** Represents a double value. */
-  numberValue:
+  numberValue?:
     | number
     | undefined;
   /** Represents a string value. */
-  stringValue:
+  stringValue?:
     | string
     | undefined;
   /** Represents a boolean value. */
-  boolValue:
+  boolValue?:
     | boolean
     | undefined;
   /** Represents a structured value. */
-  structValue:
+  structValue?:
     | { [key: string]: any }
     | undefined;
   /** Represents a repeated `Value`. */
-  listValue: Array<any> | undefined;
+  listValue?: Array<any> | undefined;
 }
 
 /**

diff --git a/integration/types-with-underscores/file.ts b/integration/types-with-underscores/file.ts
@@ -4,7 +4,7 @@ import * as _m0 from "protobufjs/minimal";
 export const protobufPackage = "";
 
 export interface Baz {
-  foo: FooBar | undefined;
+  foo?: FooBar | undefined;
 }
 
 export interface FooBar {

diff --git a/integration/unknown-fields/options.ts b/integration/unknown-fields/options.ts
@@ -13,7 +13,7 @@ export interface MyMessage {
   foo?: number | undefined;
   foo2?: number | undefined;
   bar?: string | undefined;
-  quux: string | undefined;
+  quux?: string | undefined;
 }
 
 export interface RequestType {

diff --git a/integration/use-numeric-enum-json/google/protobuf/struct.ts b/integration/use-numeric-enum-json/google/protobuf/struct.ts
@@ -67,27 +67,27 @@ export interface Struct_FieldsEntry {
  */
 export interface Value {
   /** Represents a null value. */
-  nullValue:
+  nullValue?:
     | NullValue
     | undefined;
   /** Represents a double value. */
-  numberValue:
+  numberValue?:
     | number
     | undefined;
   /** Represents a string value. */
-  stringValue:
+  stringValue?:
     | string
     | undefined;
   /** Represents a boolean value. */
-  boolValue:
+  boolValue?:
     | boolean
     | undefined;
   /** Represents a structured value. */
-  structValue:
+  structValue?:
     | { [key: string]: any }
     | undefined;
   /** Represents a repeated `Value`. */
-  listValue: Array<any> | undefined;
+  listValue?: Array<any> | undefined;
 }
 
 /**