ts-proto 1.94.0 → 1.95.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.95.0](https://github.com/stephenh/ts-proto/compare/v1.94.0...v1.95.0) (2021-12-14)
+
+
+### Features
+
+* Add useOptionals=all to enable non-field members to be optional. ([#402](https://github.com/stephenh/ts-proto/issues/402)) ([e7b70cb](https://github.com/stephenh/ts-proto/commit/e7b70cbd7b9bd43bf9e6e54e25bc48c527718317))
+
 # [1.94.0](https://github.com/stephenh/ts-proto/compare/v1.93.3...v1.94.0) (2021-12-14)
 
 

package/build/main.js

@@ -19,6 +19,14 @@ const generate_generic_service_definition_1 = require("./generate-generic-servic
 function generateFile(ctx, fileDesc) {
     var _a;
     const { options, utils } = ctx;
+    if (options.useOptionals === false) {
+        console.warn("ts-proto: Passing useOptionals as a boolean option is deprecated and will be removed in a future version. Please pass the string 'none' instead of false.");
+        options.useOptionals = 'none';
+    }
+    else if (options.useOptionals === true) {
+        console.warn("ts-proto: Passing useOptionals as a boolean option is deprecated and will be removed in a future version. Please pass the string 'messages' instead of true.");
+        options.useOptionals = 'messages';
+    }
     // Google's protofiles are organized like Java, where package == the folder the file
     // is in, and file == a specific service within the package. I.e. you can have multiple
     // company/foo.proto and company/bar.proto files, where package would be 'company'.
@@ -388,10 +396,6 @@ function makeTimestampMethods(options, longs) {
       `);
     return { toTimestamp, fromTimestamp, fromJsonTimestamp };
 }
-// When useOptionals=true, non-scalar fields are translated into optional properties.
-function isOptionalProperty(field, options) {
-    return (options.useOptionals && types_1.isMessage(field) && !types_1.isRepeated(field)) || field.proto3Optional;
-}
 // Create the interface with properties
 function generateInterfaceDeclaration(ctx, fullName, messageDesc, sourceInfo, fullTypeName) {
     var _a;
@@ -419,7 +423,7 @@ function generateInterfaceDeclaration(ctx, fullName, messageDesc, sourceInfo, fu
         utils_1.maybeAddComment(info, chunks, (_a = fieldDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
         const name = case_1.maybeSnakeToCamel(fieldDesc.name, options);
         const type = types_1.toTypeName(ctx, messageDesc, fieldDesc);
-        const q = isOptionalProperty(fieldDesc, options) ? '?' : '';
+        const q = types_1.isOptionalProperty(fieldDesc, messageDesc.options, options) ? '?' : '';
         chunks.push(ts_poet_1.code `${name}${q}: ${type}, `);
     });
     chunks.push(ts_poet_1.code `}`);
@@ -662,6 +666,7 @@ function generateEncode(ctx, fullName, messageDesc) {
         else {
             throw new Error(`Unhandled field ${field}`);
         }
+        const isOptional = types_1.isOptionalProperty(field, messageDesc.options, options);
         if (types_1.isRepeated(field)) {
             if (types_1.isMapType(ctx, messageDesc, field)) {
                 const valueType = typeMap.get(field.typeName)[2].field[1];
@@ -673,18 +678,29 @@ function generateEncode(ctx, fullName, messageDesc) {
               }
             `
                     : writeSnippet(`{ ${maybeTypeField} key: key as any, value }`);
+                const optionalAlternative = isOptional ? ' || {}' : '';
                 chunks.push(ts_poet_1.code `
-          Object.entries(message.${fieldName}).forEach(([key, value]) => {
+          Object.entries(message.${fieldName}${optionalAlternative}).forEach(([key, value]) => {
             ${entryWriteSnippet}
           });
         `);
             }
             else if (types_1.packedType(field.type) === undefined) {
-                chunks.push(ts_poet_1.code `
+                const listWriteSnippet = ts_poet_1.code `
           for (const v of message.${fieldName}) {
             ${writeSnippet('v!')};
           }
-        `);
+        `;
+                if (isOptional) {
+                    chunks.push(ts_poet_1.code `
+            if (message.${fieldName} !== undefined && message.${fieldName}.length !== 0) {
+              ${listWriteSnippet}
+            }
+          `);
+                }
+                else {
+                    chunks.push(listWriteSnippet);
+                }
             }
             else if (types_1.isEnum(field) && options.stringEnums) {
                 // This is a lot like the `else` clause, but we wrap `fooToNumber` around it.
@@ -693,24 +709,44 @@ function generateEncode(ctx, fullName, messageDesc) {
                 // (i.e. just one tag and multiple values).
                 const tag = ((field.number << 3) | 2) >>> 0;
                 const toNumber = types_1.getEnumMethod(ctx, field.typeName, 'ToNumber');
-                chunks.push(ts_poet_1.code `
+                const listWriteSnippet = ts_poet_1.code `
           writer.uint32(${tag}).fork();
           for (const v of message.${fieldName}) {
             writer.${types_1.toReaderCall(field)}(${toNumber}(v));
           }
           writer.ldelim();
-        `);
+        `;
+                if (isOptional) {
+                    chunks.push(ts_poet_1.code `
+            if (message.${fieldName} !== undefined && message.${fieldName}.length !== 0) {
+              ${listWriteSnippet}
+            }
+          `);
+                }
+                else {
+                    chunks.push(listWriteSnippet);
+                }
             }
             else {
                 // Ideally we'd reuse `writeSnippet` but it has tagging embedded inside of it.
                 const tag = ((field.number << 3) | 2) >>> 0;
-                chunks.push(ts_poet_1.code `
+                const listWriteSnippet = ts_poet_1.code `
           writer.uint32(${tag}).fork();
           for (const v of message.${fieldName}) {
             writer.${types_1.toReaderCall(field)}(v);
           }
           writer.ldelim();
-        `);
+        `;
+                if (isOptional) {
+                    chunks.push(ts_poet_1.code `
+            if (message.${fieldName} !== undefined && message.${fieldName}.length !== 0) {
+              ${listWriteSnippet}
+            }
+          `);
+                }
+                else {
+                    chunks.push(listWriteSnippet);
+                }
             }
         }
         else if (types_1.isWithinOneOfThatShouldBeUnion(options, field)) {
@@ -738,7 +774,7 @@ function generateEncode(ctx, fullName, messageDesc) {
         }
         else if (types_1.isScalar(field) || types_1.isEnum(field)) {
             chunks.push(ts_poet_1.code `
-        if (${types_1.notDefaultCheck(ctx, field, `message.${fieldName}`)}) {
+        if (${types_1.notDefaultCheck(ctx, field, messageDesc.options, `message.${fieldName}`)}) {
           ${writeSnippet(`message.${fieldName}`)};
         }
       `);

package/build/options.js

@@ -36,7 +36,7 @@ function defaultOptions() {
         context: false,
         snakeToCamel: ['json', 'keys'],
         forceLong: LongOption.NUMBER,
-        useOptionals: false,
+        useOptionals: 'none',
         useDate: DateOption.DATE,
         oneof: OneofOption.PROPERTIES,
         esModuleInterop: false,

package/build/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.detectBatchMethod = exports.responsePromiseOrObservable = exports.responseObservable = exports.responsePromise = exports.responseType = exports.requestType = exports.rawRequestType = exports.detectMapType = exports.toTypeName = exports.getEnumMethod = exports.messageToTypeName = exports.wrapperTypeName = exports.valueTypeName = exports.isEmptyType = exports.isLongValueType = exports.isStructTypeName = exports.isStructType = exports.isListValueTypeName = exports.isListValueType = exports.isBytesValueType = exports.isAnyValueTypeName = exports.isAnyValueType = exports.isValueType = exports.isTimestamp = exports.isMapType = exports.isWholeNumber = exports.isLong = exports.isRepeated = exports.isWithinOneOfThatShouldBeUnion = exports.isWithinOneOf = exports.isEnum = exports.isMessage = exports.isBytes = exports.isPrimitive = exports.isScalar = exports.createTypeMap = exports.notDefaultCheck = exports.defaultValue = exports.packedType = exports.toReaderCall = exports.basicTypeName = exports.basicLongWireType = exports.basicWireType = void 0;
+exports.detectBatchMethod = exports.responsePromiseOrObservable = exports.responseObservable = exports.responsePromise = exports.responseType = exports.requestType = exports.rawRequestType = exports.detectMapType = exports.toTypeName = exports.getEnumMethod = exports.messageToTypeName = exports.wrapperTypeName = exports.valueTypeName = exports.isEmptyType = exports.isLongValueType = exports.isStructTypeName = exports.isStructType = exports.isListValueTypeName = exports.isListValueType = exports.isBytesValueType = exports.isAnyValueTypeName = exports.isAnyValueType = exports.isValueType = exports.isTimestamp = exports.isMapType = exports.isWholeNumber = exports.isLong = exports.isRepeated = exports.isWithinOneOfThatShouldBeUnion = exports.isWithinOneOf = exports.isEnum = exports.isMessage = exports.isBytes = exports.isPrimitive = exports.isOptionalProperty = exports.isScalar = exports.createTypeMap = exports.notDefaultCheck = exports.defaultValue = exports.packedType = exports.toReaderCall = exports.basicTypeName = exports.basicLongWireType = exports.basicWireType = void 0;
 const ts_proto_descriptors_1 = require("ts-proto-descriptors");
 const ts_poet_1 = require("ts-poet");
 const options_1 = require("./options");
@@ -225,8 +225,10 @@ function defaultValue(ctx, field) {
 }
 exports.defaultValue = defaultValue;
 /** Creates code that checks that the field is not the default value. Supports scalars and enums. */
-function notDefaultCheck(ctx, field, place) {
+function notDefaultCheck(ctx, field, messageOptions, place) {
     const { typeMap, options } = ctx;
+    const isOptional = isOptionalProperty(field, messageOptions, options);
+    const maybeNotUndefinedAnd = isOptional ? `${place} !== undefined && ` : '';
     switch (field.type) {
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_DOUBLE:
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_FLOAT:
@@ -235,7 +237,7 @@ function notDefaultCheck(ctx, field, place) {
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_SINT32:
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_FIXED32:
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_SFIXED32:
-            return ts_poet_1.code `${place} !== 0`;
+            return ts_poet_1.code `${maybeNotUndefinedAnd} ${place} !== 0`;
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_ENUM:
             // proto3 enforces enums starting at 0, however proto2 does not, so we have
             // to probe and see if zero is an allowed value. If it's not, pick the first one.
@@ -245,10 +247,10 @@ function notDefaultCheck(ctx, field, place) {
             const zerothValue = enumProto.value.find((v) => v.number === 0) || enumProto.value[0];
             if (options.stringEnums) {
                 const enumType = messageToTypeName(ctx, field.typeName);
-                return ts_poet_1.code `${place} !== ${enumType}.${zerothValue.name}`;
+                return ts_poet_1.code `${maybeNotUndefinedAnd} ${place} !== ${enumType}.${zerothValue.name}`;
             }
             else {
-                return ts_poet_1.code `${place} !== ${zerothValue.number}`;
+                return ts_poet_1.code `${maybeNotUndefinedAnd} ${place} !== ${zerothValue.number}`;
             }
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_UINT64:
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_FIXED64:
@@ -256,20 +258,20 @@ function notDefaultCheck(ctx, field, place) {
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_SINT64:
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_SFIXED64:
             if (options.forceLong === options_1.LongOption.LONG) {
-                return ts_poet_1.code `!${place}.isZero()`;
+                return ts_poet_1.code `${maybeNotUndefinedAnd} !${place}.isZero()`;
             }
             else if (options.forceLong === options_1.LongOption.STRING) {
-                return ts_poet_1.code `${place} !== "0"`;
+                return ts_poet_1.code `${maybeNotUndefinedAnd} ${place} !== "0"`;
             }
             else {
-                return ts_poet_1.code `${place} !== 0`;
+                return ts_poet_1.code `${maybeNotUndefinedAnd} ${place} !== 0`;
             }
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_BOOL:
             return ts_poet_1.code `${place} === true`;
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_STRING:
-            return ts_poet_1.code `${place} !== ""`;
+            return ts_poet_1.code `${maybeNotUndefinedAnd} ${place} !== ""`;
         case ts_proto_descriptors_1.FieldDescriptorProto_Type.TYPE_BYTES:
-            return ts_poet_1.code `${place}.length !== 0`;
+            return ts_poet_1.code `${maybeNotUndefinedAnd} ${place}.length !== 0`;
         default:
             throw new Error('Not implemented for the given type.');
     }
@@ -314,6 +316,18 @@ function isScalar(field) {
     return scalarTypes.includes(field.type);
 }
 exports.isScalar = isScalar;
+// When useOptionals='messages', non-scalar fields are translated into optional
+// properties. When useOptionals='all', all fields are translated into
+// optional properties, with the exception of map Entry key/values, which must
+// always be present.
+function isOptionalProperty(field, messageOptions, options) {
+    const optionalMessages = options.useOptionals === true || options.useOptionals === 'messages' || options.useOptionals === 'all';
+    const optionalAll = options.useOptionals === 'all';
+    return ((optionalMessages && isMessage(field) && !isRepeated(field)) ||
+        (optionalAll && !(messageOptions === null || messageOptions === void 0 ? void 0 : messageOptions.mapEntry)) ||
+        field.proto3Optional);
+}
+exports.isOptionalProperty = isOptionalProperty;
 /** This includes all scalars, enums and the [groups type](https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/DescriptorProtos.FieldDescriptorProto.Type.html#TYPE_GROUP) */
 function isPrimitive(field) {
     return !isMessage(field);
@@ -475,11 +489,14 @@ function messageToTypeName(ctx, protoType, typeOptions = {}) {
     // them to basic built-in types, we union the type with undefined to
     // indicate the value is optional. Exceptions:
     // - If the field is repeated, values cannot be undefined.
-    // - If useOptionals=true, all non-scalar types are already optional
-    //   properties, so there's no need for that union.
+    // - If useOptionals='messages' or useOptionals='all', all non-scalar types
+    //   are already optional properties, so there's no need for that union.
     let valueType = valueTypeName(ctx, protoType);
     if (!typeOptions.keepValueType && valueType) {
-        if (!!typeOptions.repeated || options.useOptionals) {
+        if (!!typeOptions.repeated ||
+            options.useOptionals === true ||
+            options.useOptionals === 'messages' ||
+            options.useOptionals === 'all') {
             return valueType;
         }
         return ts_poet_1.code `${valueType} | undefined`;
@@ -522,18 +539,21 @@ function toTypeName(ctx, messageDesc, field) {
         // in messageToTypeName, so no need to consider them for that here.
         return type;
     }
-    // By default (useOptionals=false, oneof=properties), non-scalar fields
+    // By default (useOptionals='none', oneof=properties), non-scalar fields
     // outside oneofs and all fields within a oneof clause need to be unioned
     // with `undefined` to indicate the value is optional.
     //
-    // When useOptionals=true, non-scalar fields are translated to optional
-    // properties, so no need for the union with `undefined` here.
+    // When useOptionals='messages' or useOptionals='all', non-scalar fields are
+    // translated to optional properties, so no need for the union with
+    // `undefined` here.
     //
     // When oneof=unions, we generate a single property for the entire `oneof`
     // clause, spelling each option out inside a large type union. No need for
     // union with `undefined` here, either.
     const { options } = ctx;
-    if ((!isWithinOneOf(field) && isMessage(field) && !options.useOptionals) ||
+    if ((!isWithinOneOf(field) &&
+        isMessage(field) &&
+        (options.useOptionals === false || options.useOptionals === 'none')) ||
         (isWithinOneOf(field) && options.oneof === options_1.OneofOption.PROPERTIES) ||
         (isWithinOneOf(field) && field.proto3Optional)) {
         return ts_poet_1.code `${type} | undefined`;

package/package.json

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