ts-proto 1.176.2 → 1.177.0

package/README.markdown

@@ -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).
@@ -687,8 +692,7 @@ The commands below assume you have **Docker** installed. If you are using OS X,
 - Run `yarn build:test` to generate the test files.
   > _This runs the following commands:_
   >
-  > - `proto2bin` — Converts integration test `.proto` files to `.bin`.
-  > - `bin2ts` — Runs `ts-proto` on the `.bin` files to generate `.ts` files.
+  > - `proto2ts` — Runs `ts-proto` on the `integration/**/*.proto` files to generate `.ts` files.
   > - `proto2pbjs` — Generates a reference implementation using `pbjs` for testing compatibility.
 - Run `yarn test`
 
@@ -704,8 +708,8 @@ The commands below assume you have **Docker** installed. If you are using OS X,
   - Add/update a `integration/your-new-test/some-test.ts` unit test, even if it's as trivial as just making sure the generated code compiles
 - Modify the `ts-proto` code generation logic:
   - Most important logic is found in [src/main.ts](src/main.ts).
-  - After any changes to `src/*.ts` files, run `yarn bin2ts` to re-codegen all integration tests
-    - Or `yarn bin2ts your-new-test` to re-codegen a specific test
+  - After any changes to `src/*.ts` files, run `yarn proto2ts` to re-codegen all integration tests
+    - Or `yarn proto2ts your-new-test` to re-codegen a specific test
     - Again leaving `yarn watch` running should "just do the right thing"
 - Run `yarn test` to verify your changes pass all existing tests
 - Commit and submit a PR

package/build/main.js

@@ -334,7 +334,6 @@ function makeLongUtils(options, bytes) {
         ${configure}();
       }
     `);
-    // TODO This is unused?
     const numberToLong = (0, ts_poet_1.conditionalOutput)("numberToLong", (0, ts_poet_1.code) `
       function numberToLong(number: number) {
         return ${Long}.fromNumber(number);
@@ -355,6 +354,9 @@ function makeLongUtils(options, bytes) {
         if (long.gt(${bytes.globalThis}.Number.MAX_SAFE_INTEGER)) {
           throw new ${bytes.globalThis}.Error("Value is larger than Number.MAX_SAFE_INTEGER")
         }
+        if (long.lt(${bytes.globalThis}.Number.MIN_SAFE_INTEGER)) {
+          throw new ${bytes.globalThis}.Error("Value is smaller than Number.MIN_SAFE_INTEGER")
+        }
         return long.toNumber();
       }
     `);
@@ -507,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})`;
@@ -924,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

@@ -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/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.2",
+  "version": "1.177.0",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",
@@ -10,12 +10,10 @@
   "types": "build/index.d.ts",
   "scripts": {
     "build": "yarn tsc",
-    "build:test": "yarn proto2bin && yarn proto2pbjs && yarn bin2ts",
+    "build:test": "yarn proto2ts && yarn proto2pbjs",
     "prepare": "yarn build",
-    "proto2bin": "docker compose run --rm protoc update-bins.sh",
-    "proto2bin-node": "docker compose run --rm node update-bins.sh",
+    "proto2ts": "docker compose run --rm protoc update-code.sh",
     "proto2pbjs": "docker compose run --rm protoc pbjs.sh",
-    "bin2ts": "docker compose run --rm protoc codegen.sh",
     "test": "yarn jest -c jest.config.js",
     "tsc:check": "./tsc-check.sh tsconfig.json tests/tsconfig.json integration/tsconfig.json integration/tsconfig.proto.json protos/tsconfig.json",
     "format": "prettier --write {src,tests}/**/*.ts integration/*.ts",
@@ -62,7 +60,7 @@
     "rxjs": "^7.8.1",
     "semantic-release": "^21.0.7",
     "ts-jest": "^29.1.1",
-    "tsx": "^3.14.0",
+    "tsx": "^4.11.2",
     "typescript": "^5.1.6",
     "uglify-js": "^3.17.4"
   },