ts-proto 1.106.0 → 1.107.0

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+# [1.107.0](https://github.com/stephenh/ts-proto/compare/v1.106.2...v1.107.0) (2022-03-04)
+
+
+### Features
+
+* Allow simultaneous services and generic service definitions ([#512](https://github.com/stephenh/ts-proto/issues/512)) ([680831e](https://github.com/stephenh/ts-proto/commit/680831e76f1a4ceb4337442a157d7e702cb14bfc))
+
+## [1.106.2](https://github.com/stephenh/ts-proto/compare/v1.106.1...v1.106.2) (2022-02-27)
+
+
+### Bug Fixes
+
+* Add M1/ARM support for the test suite ([#516](https://github.com/stephenh/ts-proto/issues/516)) ([7cf5625](https://github.com/stephenh/ts-proto/commit/7cf56251726d149eebd015367476f36e4edb48aa))
+
+## [1.106.1](https://github.com/stephenh/ts-proto/compare/v1.106.0...v1.106.1) (2022-02-21)
+
+
+### Bug Fixes
+
+* support json_name containing hyphen on all field types ([#521](https://github.com/stephenh/ts-proto/issues/521)) ([8d9e78e](https://github.com/stephenh/ts-proto/commit/8d9e78eb39c460f6727458f6a2dd149deb983668))
+
 # [1.106.0](https://github.com/stephenh/ts-proto/compare/v1.105.2...v1.106.0) (2022-02-21)
 
 

package/README.markdown

@@ -362,6 +362,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. These definitions contain descriptors for each method with links to request and response types, which allows to generate server and client stubs at runtime, and also generate strong types for them at compile time. An example of a library that uses this approach is [nice-grpc](https://github.com/deeplay-io/nice-grpc).
 
+- With `--ts_proto_opt=outputServices=generic-definitions,outputServices=default`, ts-proto will output both generic definitions and interfaces.  This is useful if you want to rely on the interfaces, but also have some reflection capabilities at runtime.
+
 - 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

package/build/main.js

@@ -118,29 +118,34 @@ function generateFile(ctx, fileDesc) {
             }
             chunks.push(ts_poet_1.code `export const ${serviceConstName} = "${serviceDesc.name}";`);
         }
-        else if (options.outputServices === options_1.ServiceOption.GRPC) {
-            chunks.push(generate_grpc_js_1.generateGrpcJsService(ctx, fileDesc, sInfo, serviceDesc));
-        }
-        else if (options.outputServices === options_1.ServiceOption.GENERIC) {
-            chunks.push(generate_generic_service_definition_1.generateGenericServiceDefinition(ctx, fileDesc, sInfo, serviceDesc));
-        }
-        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));
-            if (options.outputClientImpl === true) {
-                chunks.push(generate_services_1.generateServiceClientImpl(ctx, fileDesc, serviceDesc));
-            }
-            else if (options.outputClientImpl === 'grpc-web') {
-                chunks.push(generate_grpc_web_1.generateGrpcClientImpl(ctx, fileDesc, serviceDesc));
-                chunks.push(generate_grpc_web_1.generateGrpcServiceDesc(fileDesc, serviceDesc));
-                serviceDesc.method.forEach((method) => {
-                    chunks.push(generate_grpc_web_1.generateGrpcMethodDesc(ctx, serviceDesc, method));
-                    if (method.serverStreaming) {
-                        hasServerStreamingMethods = true;
+        else {
+            const uniqueServices = [...new Set(options.outputServices)].sort();
+            uniqueServices.forEach((outputService) => {
+                if (outputService === options_1.ServiceOption.GRPC) {
+                    chunks.push(generate_grpc_js_1.generateGrpcJsService(ctx, fileDesc, sInfo, serviceDesc));
+                }
+                else if (outputService === options_1.ServiceOption.GENERIC) {
+                    chunks.push(generate_generic_service_definition_1.generateGenericServiceDefinition(ctx, fileDesc, sInfo, serviceDesc));
+                }
+                else if (outputService === 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));
+                    if (options.outputClientImpl === true) {
+                        chunks.push(generate_services_1.generateServiceClientImpl(ctx, fileDesc, serviceDesc));
                     }
-                });
-            }
+                    else if (options.outputClientImpl === 'grpc-web') {
+                        chunks.push(generate_grpc_web_1.generateGrpcClientImpl(ctx, fileDesc, serviceDesc));
+                        chunks.push(generate_grpc_web_1.generateGrpcServiceDesc(fileDesc, serviceDesc));
+                        serviceDesc.method.forEach((method) => {
+                            chunks.push(generate_grpc_web_1.generateGrpcMethodDesc(ctx, serviceDesc, method));
+                            if (method.serverStreaming) {
+                                hasServerStreamingMethods = true;
+                            }
+                        });
+                    }
+                }
+            });
         }
         serviceDesc.method.forEach((methodDesc, index) => {
             if (methodDesc.serverStreaming || methodDesc.clientStreaming) {
@@ -148,7 +153,9 @@ function generateFile(ctx, fileDesc) {
             }
         });
     });
-    if (options.outputServices === options_1.ServiceOption.DEFAULT && options.outputClientImpl && fileDesc.service.length > 0) {
+    if (options.outputServices.includes(options_1.ServiceOption.DEFAULT) &&
+        options.outputClientImpl &&
+        fileDesc.service.length > 0) {
         if (options.outputClientImpl === true) {
             chunks.push(generate_services_1.generateRpcType(ctx, hasStreamingMethods));
         }
@@ -897,6 +904,7 @@ function generateFromJson(ctx, fullName, messageDesc) {
         const fieldName = case_1.maybeSnakeToCamel(field.name, options);
         const jsonName = utils_1.getFieldJsonName(field, options);
         const jsonProperty = utils_1.getPropertyAccessor('object', jsonName);
+        const jsonPropertyOptional = utils_1.getPropertyAccessor('object', jsonName, true);
         // get code that extracts value from incoming object
         const readSnippet = (from) => {
             if (types_1.isEnum(field)) {
@@ -1025,12 +1033,12 @@ function generateFromJson(ctx, fullName, messageDesc) {
             else {
                 const readValueSnippet = readSnippet('e');
                 if (readValueSnippet.toString() === ts_poet_1.code `e`.toString()) {
-                    chunks.push(ts_poet_1.code `${fieldName}: Array.isArray(object?.${jsonName}) ? [...${jsonProperty}] : [],`);
+                    chunks.push(ts_poet_1.code `${fieldName}: Array.isArray(${jsonPropertyOptional}) ? [...${jsonProperty}] : [],`);
                 }
                 else {
                     // Explicit `any` type required to make TS with noImplicitAny happy. `object` is also `any` here.
                     chunks.push(ts_poet_1.code `
-            ${fieldName}: Array.isArray(object?.${jsonName}) ? ${jsonProperty}.map((e: any) => ${readValueSnippet}): [],
+            ${fieldName}: Array.isArray(${jsonPropertyOptional}) ? ${jsonProperty}.map((e: any) => ${readValueSnippet}): [],
           `);
                 }
             }
@@ -1051,7 +1059,7 @@ function generateFromJson(ctx, fullName, messageDesc) {
             }
         }
         else if (types_1.isAnyValueType(field)) {
-            chunks.push(ts_poet_1.code `${fieldName}: ${ctx.utils.isSet}(object?.${jsonName})
+            chunks.push(ts_poet_1.code `${fieldName}: ${ctx.utils.isSet}(${jsonPropertyOptional})
         ? ${readSnippet(`${jsonProperty}`)}
         : undefined,
       `);
@@ -1185,10 +1193,10 @@ function generateToJson(ctx, fullName, messageDesc) {
         if (types_1.isMapType(ctx, messageDesc, field)) {
             // Maps might need their values transformed, i.e. bytes --> base64
             chunks.push(ts_poet_1.code `
-        obj.${jsonName} = {};
+        ${jsonProperty} = {};
         if (message.${fieldName}) {
           Object.entries(message.${fieldName}).forEach(([k, v]) => {
-            obj.${jsonName}[k] = ${readSnippet('v')};
+            ${jsonProperty}[k] = ${readSnippet('v')};
           });
         }
       `);
@@ -1197,9 +1205,9 @@ function generateToJson(ctx, fullName, messageDesc) {
             // Arrays might need their elements transformed
             chunks.push(ts_poet_1.code `
         if (message.${fieldName}) {
-          obj.${jsonName} = message.${fieldName}.map(e => ${readSnippet('e')});
+          ${jsonProperty} = message.${fieldName}.map(e => ${readSnippet('e')});
         } else {
-          obj.${jsonName} = [];
+          ${jsonProperty} = [];
         }
       `);
         }

package/build/options.js

@@ -51,7 +51,7 @@ function defaultOptions() {
         constEnums: false,
         enumsAsLiterals: false,
         outputClientImpl: true,
-        outputServices: ServiceOption.DEFAULT,
+        outputServices: [],
         returnObservable: false,
         addGrpcMetadata: false,
         addNestjsRestParameter: false,
@@ -95,7 +95,14 @@ function optionsFromParameter(parameter) {
     }
     // Treat outputServices=false as NONE
     if (options.outputServices === false) {
-        options.outputServices = ServiceOption.NONE;
+        options.outputServices = [ServiceOption.NONE];
+    }
+    // Existing type-coercion inside parseParameter leaves a little to be desired.
+    if (typeof options.outputServices == 'string') {
+        options.outputServices = [options.outputServices];
+    }
+    if (options.outputServices.length == 0) {
+        options.outputServices = [ServiceOption.DEFAULT];
     }
     if (options.useDate === true) {
         // Treat useDate=true as DATE

package/build/utils.js

@@ -137,7 +137,7 @@ class FormattedMethodDescriptor {
      */
     static formatName(methodName, options) {
         let result = methodName;
-        if (options.lowerCaseServiceMethods || options.outputServices === options_1.ServiceOption.GRPC) {
+        if (options.lowerCaseServiceMethods || options.outputServices.includes(options_1.ServiceOption.GRPC)) {
             result = case_1.camelCase(result);
         }
         return result;
@@ -160,12 +160,13 @@ exports.getFieldJsonName = getFieldJsonName;
  * For simplicity, we don't match the ECMA 5/6 rules for valid identifiers exactly, and return array syntax liberally.
  * @param objectName
  * @param propertyName
+ * @param optional
  */
-function getPropertyAccessor(objectName, propertyName) {
+function getPropertyAccessor(objectName, propertyName, optional = false) {
     let validIdentifier = /^[a-zA-Z_$][\w$]*$/;
     return validIdentifier.test(propertyName)
-        ? `${objectName}.${propertyName}`
-        : `${objectName}[${JSON.stringify(propertyName)}]`;
+        ? `${objectName}${optional ? '?' : ''}.${propertyName}`
+        : `${objectName}${optional ? '?.' : ''}[${JSON.stringify(propertyName)}]`;
 }
 exports.getPropertyAccessor = getPropertyAccessor;
 function impProto(options, module, type) {

package/package.json

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