ts-proto 1.82.4 → 1.83.2

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+## [1.83.2](https://github.com/stephenh/ts-proto/compare/v1.83.1...v1.83.2) (2021-10-26)
+
+
+### Bug Fixes
+
+* Add missing defaults to fromPartial if options.oneof is UNIONS ([#375](https://github.com/stephenh/ts-proto/issues/375)) ([21781e9](https://github.com/stephenh/ts-proto/commit/21781e98bb6117b540be8c3f2c38ac3ad5cbbb44))
+
+## [1.83.1](https://github.com/stephenh/ts-proto/compare/v1.83.0...v1.83.1) (2021-09-17)
+
+
+### Bug Fixes
+
+* deprecated grpc and replace with @grpc/grpc-js ([#362](https://github.com/stephenh/ts-proto/issues/362)) ([1a11b97](https://github.com/stephenh/ts-proto/commit/1a11b97e9b5e92e79fdd4e22d3e8ea4536af243b))
+
+# [1.83.0](https://github.com/stephenh/ts-proto/compare/v1.82.5...v1.83.0) (2021-09-12)
+
+
+### Features
+
+* Service generation option ([#357](https://github.com/stephenh/ts-proto/issues/357)) ([7a2cf83](https://github.com/stephenh/ts-proto/commit/7a2cf831c3768e5afd76dea37f3165df4886136e))
+
+## [1.82.5](https://github.com/stephenh/ts-proto/compare/v1.82.4...v1.82.5) (2021-08-05)
+
+
+### Bug Fixes
+
+* Field starting with '_' generates an interface property starting with 'undefined' ([#344](https://github.com/stephenh/ts-proto/issues/344)) ([fab354f](https://github.com/stephenh/ts-proto/commit/fab354f3f8f3aae51bb0377f98138bc80a1113e3))
+
 ## [1.82.4](https://github.com/stephenh/ts-proto/compare/v1.82.3...v1.82.4) (2021-08-04)
 
 

package/README.markdown

@@ -230,7 +230,7 @@ Generated code will be placed in the Gradle build directory.
   The default behavior is `forceLong=number`, which will internally still use the `long` library to encode/decode values on the wire (so you will still see a `util.Long = Long` line in your output), but will convert the `long` values to `number` automatically for you. Note that a runtime error is thrown if, while doing this conversion, a 64-bit value is larger than can be correctly stored as a `number`.
 
 - With `--ts_proto_opt=esModuleInterop=true` changes output to be `esModuleInterop` compliant.
-  
+
   Specifically the `Long` imports will be generated as `import Long from 'long'` instead of `import * as Long from 'long'`.
 
 - With `--ts_proto_opt=env=node` or `browser` or `both`, ts-proto will make environment-specific assumptions in your output. This defaults to `both`, which makes no environment-specific assumptions.
@@ -259,20 +259,20 @@ Generated code will be placed in the Gradle build directory.
   ```
 
   However, the type-safety of `useOptionals=false` is admittedly tedious if you have many inherently-unused fields, so you can use `useOptionals=true` if that trade-off makes sense for your project.
-  
+
   You can also use the generated `SomeMessage.fromPartial` methods to opt into the optionality on a per-call-site basis. The `fromPartial` allows the creator/writer to have default values applied (i.e. `undefined` --> `0`), and the return value will still be the non-optional type that provides a consistent view (i.e. always `0`) to clients.
 
-  Eventually if TypesCript supports [Exact Types](https://github.com/microsoft/TypeScript/issues/12936), that should allow ts-proto to switch to `useOptionals=true` as the default/only behavior, have the generated `Message.encode`/`Message.toPartial`/etc. methods accept `Exact<T>` versions of the message types, and the result would be both safe + succinct.
+  Eventually if TypeScript supports [Exact Types](https://github.com/microsoft/TypeScript/issues/12936), that should allow ts-proto to switch to `useOptionals=true` as the default/only behavior, have the generated `Message.encode`/`Message.toPartial`/etc. methods accept `Exact<T>` versions of the message types, and the result would be both safe + succinct.
 
   Also see the comment in [this issue](https://github.com/stephenh/ts-proto/issues/120#issuecomment-678375833) which explains the nuance behind making all fields optional (currently `useOptionals` only makes message fields optional), specifically that a message created with `const message: Message = { ...key not set... }` (so `key` is `undefined`) vs. `const message = Message.decode(...key not set...)` (so `key` is the default value) would look different to clients.
 
   Note that RPC methods, like `service.ping({ key: ... })`, accept `DeepPartial` versions of the request messages, because of the same rationale that it makes it easy for the writer call-site to get default values for free, and because the "reader" is the internal ts-proto serialization code, it can apply the defaults as necessary.
 
 - With `--ts_proto_opt=exportCommonSymbols=false`, utility types like `DeepPartial` won't be `export`d.
-  
+
   This should make it possible to use create barrel imports of the generated output, i.e. `import * from ./foo` and `import * from ./bar`.
-  
-  Note that if you have the same message name used in multiple `*.proto` files, you will still get import conflicts. 
+
+  Note that if you have the same message name used in multiple `*.proto` files, you will still get import conflicts.
 
 - With `--ts_proto_opt=oneof=unions`, `oneof` fields will be generated as ADTs.
 
@@ -336,6 +336,8 @@ Generated code will be placed in the Gradle build directory.
 
 - With `--ts_proto_opt=outputServices=generic-definitions`, ts-proto will output generic (framework-agnostic) service definitions.
 
+- With `--ts_proto_opt=outputServices=false`, or `=none`, ts-proto will output NO service definitions.
+
 - With `--ts_proto_opt=emitImportedFiles=false`, ts-proto will not emit `google/protobuf/*` files unless you explicit add files to `protoc` like this
 `protoc --plugin=./node_modules/.bin/protoc-gen-ts_proto my_message.proto google/protobuf/duration.proto`
 
@@ -410,7 +412,7 @@ If you want fields where you can model set/unset, see Wrapper Types.
 # Wrapper Types
 
 In core Protobuf, unset primitive fields become their respective default values (so you loose ability to distinguish "unset" from "default").
- 
+
 However, unset message fields stay `null`.
 
 This allows a cute hack where you can model a logical `string | unset` by creating a field that is technically a message (i.e. so it can stay `null` for the unset case), but the message only has a single string field (i.e for storing the value in the set case).
@@ -426,9 +428,9 @@ This makes dealing with `string | unset` in your code much nicer, albeit it's un
 Numbers are by default assumed to be plain JavaScript `number`s.
 
 This is fine for Protobuf types like `int32` and `float`, but 64-bit types like `int64` can't be 100% represented by JavaScript's `number` type, because `int64` can have larger/smaller values than `number`.
- 
+
 ts-proto's default configuration (which is `forceLong=number`) is to still use `number` for 64-bit fields, and then throw an error if a value (at runtime) is larger than `Number.MAX_SAFE_INTEGER`.
- 
+
 If you expect to use 64-bit / higher-than-`MAX_SAFE_INTEGER` values, then you can use the ts-proto `forceLong` option, which uses the [long](https://www.npmjs.com/package/long) npm package to support the entire range of 64-bit values.
 
 The protobuf number types map to JavaScript types based on the `forceLong` config option:

package/build/case.js

@@ -7,7 +7,8 @@ function maybeSnakeToCamel(s, options) {
             .split('_')
             .map((word, i) => {
             if (i === 0) {
-                return word[0] + word.substring(1).toLowerCase();
+                // if first symbol is "_" then skip it
+                return word ? word[0] + word.substring(1).toLowerCase() : '';
             }
             else {
                 return capitalize(word.toLowerCase());

package/build/generate-nestjs.js

@@ -10,7 +10,7 @@ function generateNestjsServiceController(ctx, fileDesc, sourceInfo, serviceDesc)
     var _a;
     const { options } = ctx;
     const chunks = [];
-    const Metadata = options.outputServices === 'grpc-js' ? ts_poet_1.imp('Metadata@@grpc/grpc-js') : ts_poet_1.imp('Metadata@grpc');
+    const Metadata = ts_poet_1.imp('Metadata@@grpc/grpc-js');
     utils_1.maybeAddComment(sourceInfo, chunks, (_a = serviceDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
     const t = options.context ? `<${main_1.contextTypeVar}>` : '';
     chunks.push(ts_poet_1.code `
@@ -73,7 +73,7 @@ exports.generateNestjsServiceController = generateNestjsServiceController;
 function generateNestjsServiceClient(ctx, fileDesc, sourceInfo, serviceDesc) {
     const { options } = ctx;
     const chunks = [];
-    const Metadata = options.outputServices === 'grpc-js' ? ts_poet_1.imp('Metadata@@grpc/grpc-js') : ts_poet_1.imp('Metadata@grpc');
+    const Metadata = ts_poet_1.imp('Metadata@@grpc/grpc-js');
     utils_1.maybeAddComment(sourceInfo, chunks);
     const t = options.context ? `<${main_1.contextTypeVar}>` : ``;
     chunks.push(ts_poet_1.code `

package/build/generate-services.js

@@ -48,7 +48,7 @@ function generateService(ctx, fileDesc, sourceInfo, serviceDesc) {
             params.push(ts_poet_1.code `metadata?: grpc.Metadata`);
         }
         else if (options.addGrpcMetadata) {
-            const Metadata = ts_poet_1.imp('Metadata@grpc');
+            const Metadata = ts_poet_1.imp('Metadata@@grpc/grpc-js');
             const q = options.addNestjsRestParameter ? '' : '?';
             params.push(ts_poet_1.code `metadata${q}: ${Metadata}`);
         }

package/build/main.js

@@ -107,13 +107,13 @@ function generateFile(ctx, fileDesc) {
             }
             chunks.push(ts_poet_1.code `export const ${serviceConstName} = "${serviceDesc.name}";`);
         }
-        else if (options.outputServices === 'grpc-js') {
+        else if (options.outputServices === options_1.ServiceOption.GRPC) {
             chunks.push(generate_grpc_js_1.generateGrpcJsService(ctx, fileDesc, sInfo, serviceDesc));
         }
-        else if (options.outputServices === 'generic-definitions') {
+        else if (options.outputServices === options_1.ServiceOption.GENERIC) {
             chunks.push(generate_generic_service_definition_1.generateGenericServiceDefinition(ctx, fileDesc, sInfo, serviceDesc));
         }
-        else {
+        else if (options.outputServices === options_1.ServiceOption.DEFAULT) {
             // This service could be Twirp or grpc-web or JSON (maybe). So far all of their
             // interfaces are fairly similar so we share the same service interface.
             chunks.push(generate_services_1.generateService(ctx, fileDesc, sInfo, serviceDesc));
@@ -132,7 +132,7 @@ function generateFile(ctx, fileDesc) {
             }
         }
     });
-    if (!options.outputServices && options.outputClientImpl && fileDesc.service.length > 0) {
+    if (options.outputServices === options_1.ServiceOption.DEFAULT && options.outputClientImpl && fileDesc.service.length > 0) {
         if (options.outputClientImpl === true) {
             chunks.push(generate_services_1.generateRpcType(ctx));
         }
@@ -239,6 +239,7 @@ function makeByteUtils() {
     const globalThis = ts_poet_1.conditionalOutput('globalThis', ts_poet_1.code `
       declare var self: any | undefined;
       declare var window: any | undefined;
+      declare var global: any | undefined;
       var globalThis: any = (() => {
         if (typeof globalThis !== "undefined") return globalThis;
         if (typeof self !== "undefined") return self;
@@ -1081,7 +1082,7 @@ function generateFromPartial(ctx, fullName, messageDesc) {
                 chunks.push(ts_poet_1.code `message.${fieldName} = ${readSnippet(`object.${fieldName}`)};`);
             }
         }
-        if (!types_1.isRepeated(field) && options.oneof !== options_1.OneofOption.UNIONS) {
+        if (!types_1.isRepeated(field) && !types_1.isWithinOneOfThatShouldBeUnion(options, field)) {
             chunks.push(ts_poet_1.code `} else {`);
             const v = types_1.isWithinOneOf(field) ? 'undefined' : types_1.defaultValue(ctx, field);
             chunks.push(ts_poet_1.code `message.${fieldName} = ${v}`);

package/build/options.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTsPoetOpts = exports.optionsFromParameter = exports.defaultOptions = exports.OneofOption = exports.EnvOption = exports.DateOption = exports.LongOption = void 0;
+exports.getTsPoetOpts = exports.optionsFromParameter = exports.defaultOptions = exports.ServiceOption = exports.OneofOption = exports.EnvOption = exports.DateOption = exports.LongOption = void 0;
 var LongOption;
 (function (LongOption) {
     LongOption["NUMBER"] = "number";
@@ -24,6 +24,13 @@ var OneofOption;
     OneofOption["PROPERTIES"] = "properties";
     OneofOption["UNIONS"] = "unions";
 })(OneofOption = exports.OneofOption || (exports.OneofOption = {}));
+var ServiceOption;
+(function (ServiceOption) {
+    ServiceOption["GRPC"] = "grpc-js";
+    ServiceOption["GENERIC"] = "generic-definitions";
+    ServiceOption["DEFAULT"] = "default";
+    ServiceOption["NONE"] = "none";
+})(ServiceOption = exports.ServiceOption || (exports.ServiceOption = {}));
 function defaultOptions() {
     return {
         context: false,
@@ -41,7 +48,7 @@ function defaultOptions() {
         stringEnums: false,
         constEnums: false,
         outputClientImpl: true,
-        outputServices: false,
+        outputServices: ServiceOption.DEFAULT,
         returnObservable: false,
         addGrpcMetadata: false,
         addNestjsRestParameter: false,
@@ -80,6 +87,10 @@ function optionsFromParameter(parameter) {
     if (options.forceLong === true) {
         options.forceLong = LongOption.LONG;
     }
+    // Treat outputServices=false as NONE
+    if (options.outputServices === false) {
+        options.outputServices = ServiceOption.NONE;
+    }
     if (options.useDate === true) {
         // Treat useDate=true as DATE
         options.useDate = DateOption.DATE;

package/build/utils.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FormattedMethodDescriptor = exports.assertInstanceOf = exports.maybePrefixPackage = exports.prefixDisableLinter = exports.maybeAddComment = exports.upperFirst = exports.lowerFirst = exports.singular = exports.fail = exports.readToBuffer = exports.protoFilesToGenerate = void 0;
 const ts_poet_1 = require("ts-poet");
+const options_1 = require("./options");
 const case_1 = require("./case");
 function protoFilesToGenerate(request) {
     return request.protoFile.filter((f) => request.fileToGenerate.includes(f.name));
@@ -136,7 +137,7 @@ class FormattedMethodDescriptor {
      */
     static formatName(methodName, options) {
         let result = methodName;
-        if (options.lowerCaseServiceMethods || options.outputServices === 'grpc-js') {
+        if (options.lowerCaseServiceMethods || options.outputServices === options_1.ServiceOption.GRPC) {
             result = case_1.camelCase(result);
         }
         return result;

package/package.json

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