ts-proto 1.176.3 → 1.178.0

package/README.markdown

@@ -434,7 +434,7 @@ Generated code will be placed in the Gradle build directory.
 
 - With `--ts_proto_opt=annotateFilesWithVersion=false`, the generated files will not contain the versions of `protoc` and `ts-proto` used to generate the file. This option is normally set to `true`, such that files list the versions used.
 
-- With `--ts_proto_opt=outputSchema=true`, meta typings will be generated that can later be used in other code generators.
+- With `--ts_proto_opt=outputSchema=true`, meta typings will be generated that can later be used in other code generators. If outputSchema is instead specified to be `no-file-descriptor` then we do not include the file descriptor in the generated schema. This is useful if you are trying to minimize the size of the generated schema.
 
 - With `--ts_proto_opt=outputTypeAnnotations=true`, each message will be given a `$type` field containing its fully-qualified name. You can use `--ts_proto_opt=outputTypeAnnotations=static-only` to omit it from the `interface` declaration, or `--ts_proto_opt=outputTypeAnnotations=optional` to make it an optional property on the `interface` definition. The latter option may be useful if you want to use the `$type` field for runtime type checking on responses from a server.
 
@@ -603,6 +603,11 @@ export interface User {
 }
 ```
 
+- With `--ts_proto_opt=noDefaultsForOptionals=true`, `undefined` primitive values will not be defaulted as per the protobuf spec. Additionally unlike the standard behavior, when a field is set to it's standard default value, it *will* be encoded allowing it to be sent over the wire and distinguished from undefined values. For example if a message does not set a boolean value, ordinarily this would be defaulted to `false` which is different to it being undefined. 
+
+This option allows the library to act in a compatible way with the [Wire implementation](https://square.github.io/wire/) maintained and used by Square/Block. Note: this option should only be used in combination with other client/server code generated using Wire or ts-proto with this option enabled.
+
+
 ### NestJS Support
 
 We have a great way of working together with [nestjs](https://docs.nestjs.com/microservices/grpc). `ts-proto` generates `interfaces` and `decorators` for you controller, client. For more information see the [nestjs readme](NESTJS.markdown).

package/build/main.js

@@ -509,7 +509,7 @@ function makeTimestampMethods(options, longs, bytes) {
     const NanoDate = (0, ts_poet_1.imp)("NanoDate=nano-date");
     let seconds = "Math.trunc(date.getTime() / 1_000)";
     let toNumberCode = "t.seconds";
-    const makeToNumberCode = (methodCall) => `t.seconds${options.useOptionals === "all" ? "?" : ""}.${methodCall}`;
+    const makeToNumberCode = (methodCall) => `t.seconds${options.useOptionals === "all" || options.noDefaultsForOptionals ? "?" : ""}.${methodCall}`;
     if (options.forceLong === options_1.LongOption.LONG) {
         toNumberCode = makeToNumberCode("toNumber()");
         seconds = (0, ts_poet_1.code) `${longs.numberToLong}(${seconds})`;
@@ -926,10 +926,14 @@ function generateDecode(ctx, fullName, messageDesc) {
               ${messageProperty} = ${generateMapType ? "new Map()" : "{}"};
             }`
                     : "";
+                const ifValueCheck = `${varName}.value !== undefined ${(0, utils_1.withAndMaybeCheckIsNotNull)(options, `${varName}.value`)}`;
+                const maybeIfKeyCheck = `${options.noDefaultsForOptionals
+                    ? ` && ${varName}.key !== undefined ${(0, utils_1.withAndMaybeCheckIsNotNull)(options, `${varName}.key`)}`
+                    : ""}`;
                 chunks.push((0, ts_poet_1.code) `
           ${tagCheck}
           const ${varName} = ${readSnippet};
-          if (${varName}.value !== undefined ${(0, utils_1.withAndMaybeCheckIsNotNull)(options, `${varName}.value`)}) {
+          if (${ifValueCheck}${maybeIfKeyCheck}) {
             ${initializerSnippet}
             ${valueSetterSnippet};
           }

package/build/options.d.ts

@@ -68,7 +68,7 @@ export type Options = {
     unrecognizedEnumName: string;
     unrecognizedEnumValue: number;
     exportCommonSymbols: boolean;
-    outputSchema: boolean;
+    outputSchema: boolean | "no-file-descriptor";
     onlyTypes: boolean;
     emitImportedFiles: boolean;
     useAbortSignal: boolean;
@@ -96,6 +96,7 @@ export type Options = {
     disableProto2DefaultValues: boolean;
     useNullAsOptional: boolean;
     annotateFilesWithVersion: boolean;
+    noDefaultsForOptionals: boolean;
 };
 export declare function defaultOptions(): Options;
 export declare function optionsFromParameter(parameter: string | undefined): Options;

package/build/options.js

@@ -103,6 +103,7 @@ function defaultOptions() {
         disableProto2DefaultValues: false,
         useNullAsOptional: false,
         annotateFilesWithVersion: true,
+        noDefaultsForOptionals: false,
     };
 }
 exports.defaultOptions = defaultOptions;

package/build/schema.js

@@ -28,8 +28,7 @@ function generateSchema(ctx, fileDesc, sourceInfo) {
     };
 
     export interface ProtoMetadata {
-      fileDescriptor: ${fileDescriptorProto};
-      references: { [key: string]: any };
+      ${ctx.options.outputSchema !== "no-file-descriptor" ? (0, ts_poet_1.code) `fileDescriptor: ${fileDescriptorProto};\n` : ""}references: { [key: string]: any };
       dependencies?: ProtoMetadata[];
       options?: {
         options?: { [key: string]: any };
@@ -142,8 +141,9 @@ function generateSchema(ctx, fileDesc, sourceInfo) {
     });
     chunks.push((0, ts_poet_1.code) `
     export const ${(0, ts_poet_1.def)("protoMetadata")}: ProtoMetadata = {
-      fileDescriptor: ${fileDescriptorProto}.fromPartial(${descriptor}),
-      references: { ${(0, ts_poet_1.joinCode)(references, { on: "," })} },
+      ${ctx.options.outputSchema !== "no-file-descriptor"
+        ? (0, ts_poet_1.code) `fileDescriptor: ${fileDescriptorProto}.fromPartial(${descriptor}),\n`
+        : ""}references: { ${(0, ts_poet_1.joinCode)(references, { on: "," })} },
       dependencies: [${(0, ts_poet_1.joinCode)(dependencies, { on: "," })}],
       ${fileOptions || messagesOptions.length > 0 || servicesOptions.length > 0 || enumsOptions.length > 0
         ? (0, ts_poet_1.code) `options: {

package/build/types.d.ts

@@ -1,7 +1,7 @@
-import { CodeGeneratorRequest, DescriptorProto, EnumDescriptorProto, FieldDescriptorProto, FieldDescriptorProto_Type, FileDescriptorProto, MessageOptions, MethodDescriptorProto, ServiceDescriptorProto } from "ts-proto-descriptors";
 import { Code, Import } from "ts-poet";
-import { Options } from "./options";
+import { CodeGeneratorRequest, DescriptorProto, EnumDescriptorProto, FieldDescriptorProto, FieldDescriptorProto_Type, FileDescriptorProto, MessageOptions, MethodDescriptorProto, ServiceDescriptorProto } from "ts-proto-descriptors";
 import { Context } from "./context";
+import { Options } from "./options";
 /** Based on https://github.com/dcodeIO/protobuf.js/blob/master/src/types.js#L37. */
 export declare function basicWireType(type: FieldDescriptorProto_Type): number;
 export declare function basicLongWireType(type: FieldDescriptorProto_Type): number | undefined;

package/build/types.js

@@ -2,14 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.detectBatchMethod = exports.responsePromiseOrObservable = exports.responseObservable = exports.responsePromise = exports.responseType = exports.requestType = exports.observableType = exports.rawRequestType = exports.detectMapType = exports.shouldGenerateJSMapType = exports.toTypeName = exports.getEnumMethod = exports.messageToTypeName = exports.wrapperTypeName = exports.valueTypeName = exports.isEmptyType = exports.isLongValueType = exports.isStructTypeName = exports.isStructType = exports.isListValueTypeName = exports.isListValueType = exports.isFieldMaskTypeName = exports.isFieldMaskType = exports.isBytesValueType = exports.isAnyValueTypeName = exports.isAnyValueType = exports.isValueType = exports.isTimestamp = exports.isObjectId = 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.getFieldOptionsJsType = exports.packedType = exports.toReaderCall = exports.basicTypeName = exports.basicLongWireType = exports.basicWireType = void 0;
 exports.isJsTypeFieldOption = void 0;
-const ts_proto_descriptors_1 = require("ts-proto-descriptors");
 const ts_poet_1 = require("ts-poet");
-const options_1 = require("./options");
-const visit_1 = require("./visit");
-const utils_1 = require("./utils");
-const sourceInfo_1 = require("./sourceInfo");
+const ts_proto_descriptors_1 = require("ts-proto-descriptors");
 const case_1 = require("./case");
 const enums_1 = require("./enums");
+const options_1 = require("./options");
+const sourceInfo_1 = require("./sourceInfo");
+const utils_1 = require("./utils");
+const visit_1 = require("./visit");
 /** Based on https://github.com/dcodeIO/protobuf.js/blob/master/src/types.js#L37. */
 function basicWireType(type) {
     switch (type) {
@@ -189,6 +189,9 @@ function getFieldOptionsJsType(field, options) {
 exports.getFieldOptionsJsType = getFieldOptionsJsType;
 function defaultValue(ctx, field) {
     const { typeMap, options, utils, currentFile } = ctx;
+    if (options.noDefaultsForOptionals) {
+        return options.useNullAsOptional ? null : undefined;
+    }
     const useDefaultValue = !currentFile.isProto3Syntax && !options.disableProto2DefaultValues && field.defaultValue;
     const numericDefaultVal = useDefaultValue ? field.defaultValue : 0;
     switch (field.type) {
@@ -265,6 +268,11 @@ exports.defaultValue = defaultValue;
 function notDefaultCheck(ctx, field, messageOptions, place) {
     const { typeMap, options, currentFile } = ctx;
     const isOptional = isOptionalProperty(field, messageOptions, options, currentFile.isProto3Syntax);
+    if (options.noDefaultsForOptionals) {
+        return isOptional
+            ? (0, ts_poet_1.code) `${place} !== undefined ${(0, utils_1.withAndMaybeCheckIsNotNull)(options, place)}`
+            : (0, ts_poet_1.code) `${place} !== undefined`;
+    }
     const maybeNotUndefinedAnd = isOptional
         ? `${place} !== undefined ${(0, utils_1.withAndMaybeCheckIsNotNull)(options, place)} &&`
         : "";
@@ -368,6 +376,7 @@ function isOptionalProperty(field, messageOptions, options, isProto3Syntax) {
     const deprecatedOnly = options.useOptionals === "deprecatedOnly" && field.options && field.options.deprecated;
     return ((optionalMessages && isMessage(field) && !isRepeated(field)) ||
         ((optionalAll || deprecatedOnly) && !(messageOptions === null || messageOptions === void 0 ? void 0 : messageOptions.mapEntry)) ||
+        (options.noDefaultsForOptionals && !isRepeated(field) && (isScalar(field) || isEnum(field))) ||
         // file is proto2, we have enabled proto2 optionals, and the field itself is optional
         (!isProto3Syntax &&
             field.label === ts_proto_descriptors_1.FieldDescriptorProto_Label.LABEL_OPTIONAL &&

package/package.json

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