ts-proto 1.121.0 → 1.121.3

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## [1.121.3](https://github.com/stephenh/ts-proto/compare/v1.121.2...v1.121.3) (2022-08-06)
+
+
+### Bug Fixes
+
+* Use underscore separator in snakeToCamel. ([#648](https://github.com/stephenh/ts-proto/issues/648)) ([b374910](https://github.com/stephenh/ts-proto/commit/b374910a8fb1d0efe6c5c5322f8788cc3cc1ca6c))
+
+## [1.121.2](https://github.com/stephenh/ts-proto/compare/v1.121.1...v1.121.2) (2022-08-06)
+
+
+### Bug Fixes
+
+* Fix push_to_buf_registry check. ([22ac914](https://github.com/stephenh/ts-proto/commit/22ac914cd8626258ceb35fd435b899a819518988))
+
+## [1.121.1](https://github.com/stephenh/ts-proto/compare/v1.121.0...v1.121.1) (2022-07-28)
+
+
+### Bug Fixes
+
+* Revert "feat: support grpc-web client straming ([#617](https://github.com/stephenh/ts-proto/issues/617))" ([#632](https://github.com/stephenh/ts-proto/issues/632)) ([2f4ecc7](https://github.com/stephenh/ts-proto/commit/2f4ecc7434df6b8f2ff08b929f9032170b04e858))
+
 # [1.121.0](https://github.com/stephenh/ts-proto/compare/v1.120.0...v1.121.0) (2022-07-28)
 
 

package/README.markdown

@@ -339,7 +339,15 @@ Generated code will be placed in the Gradle build directory.
 
 - With `--ts_proto_opt=lowerCaseServiceMethods=true`, the method names of service methods will be lowered/camel-case, i.e. `service.findFoo` instead of `service.FindFoo`.
 
-- With `--ts_proto_opt=snakeToCamel=false`, fields will be kept snake case. `snakeToCamel` can also be set as string with `--ts_proto_opt=snakeToCamel=keys,json`. `keys` will keep field names as camelCase and `json` will keep json field names as camelCase. Empty string will keep field names as snake_case.
+- With `--ts_proto_opt=snakeToCamel=false`, fields will be kept snake case in both the message keys and the `toJSON` / `fromJSON` methods.
+
+  `snakeToCamel` can also be set as a `_`-delimited list of strings (comma is reserved as the flag delimited), i.e. `--ts_proto_opt=snakeToCamel=keys_json`, where including `keys` will make message keys be camel case and including `json` will make JSON keys be camel case.
+
+   Empty string, i.e. `snakeToCamel=`, will keep both messages keys and `JSON` keys as snake case (it is the same as `snakeToCamel=false`).
+
+   Note that to use the `json_name` attribute, you'll have to use the `json`.
+
+   The default behavior is `keys_json`, i.e. both will be camel cased, and `json_name` will be used if set.
 
 - With `--ts_proto_opt=outputEncodeMethods=false`, the `Message.encode` and `Message.decode` methods for working with protobuf-encoded/binary data will not be output.
 
@@ -435,7 +443,7 @@ Generated code will be placed in the Gradle build directory.
   Requires `onlyTypes=true`. Implies `useDate=string` and `stringEnums=true`. This option is to generate types that can be directly used with marshalling/unmarshalling Protobuf messages serialized as JSON.  
   You may also want to set `useOptionals=all`, as gRPC gateways are not required to send default value for scalar values.
 
-- With '--ts_proto_opt=useNumericEnumForJson=true`, the JSON converter (`toJSON`) will encode enum values as int, rather than a string literal.
+- With `--ts_proto_opt=useNumericEnumForJson=true`, the JSON converter (`toJSON`) will encode enum values as int, rather than a string literal.
 
 ### NestJS Support
 

package/build/generate-grpc-web.js

@@ -18,7 +18,7 @@ function generateGrpcClientImpl(ctx, _fileDesc, serviceDesc) {
     // Create the constructor(rpc: Rpc)
     chunks.push((0, ts_poet_1.code) `
     private readonly rpc: Rpc;
-
+    
     constructor(rpc: Rpc) {
   `);
     chunks.push((0, ts_poet_1.code) `this.rpc = rpc;`);
@@ -46,11 +46,9 @@ function generateRpcMethod(ctx, serviceDesc, methodDesc) {
         return (0, ts_poet_1.code) `
     ${methodDesc.formattedName}(
       request: ${inputType},
-      options?: {
-        metadata?: grpc.Metadata,
-        rpcOptions?: grpc.RpcOptions,
-    }): ${returns} {
-      return this.rpc.stream(${methodDescName(serviceDesc, methodDesc)}, request, options?.metadata, options?.rpcOptions)
+      metadata?: grpc.Metadata,
+    ): ${returns} {
+      throw new Error('ts-proto does not yet support client streaming!');
     }
   `;
     }
@@ -85,7 +83,7 @@ exports.generateGrpcServiceDesc = generateGrpcServiceDesc;
  * implementation.
  */
 function generateGrpcMethodDesc(ctx, serviceDesc, methodDesc) {
-    const inputType = (0, types_1.rawRequestType)(ctx, methodDesc);
+    const inputType = (0, types_1.requestType)(ctx, methodDesc);
     const outputType = (0, types_1.responseType)(ctx, methodDesc);
     // grpc-web expects this to be a class, but the ts-proto messages are just interfaces.
     //
@@ -111,15 +109,13 @@ function generateGrpcMethodDesc(ctx, serviceDesc, methodDesc) {
     deserializeBinary(data: Uint8Array) {
       return { ...${outputType}.decode(data), toObject() { return this; } };
     }
-}`;
-    const streaming = methodDesc.clientStreaming || methodDesc.serverStreaming;
-    const methodDef = streaming ? 'MethodDefinitionish' : 'UnaryMethodDefinitionish';
+  }`;
     return (0, ts_poet_1.code) `
-    export const ${methodDescName(serviceDesc, methodDesc)}: ${methodDef} = {
+    export const ${methodDescName(serviceDesc, methodDesc)}: UnaryMethodDefinitionish = {
       methodName: "${methodDesc.name}",
       service: ${serviceDesc.name}Desc,
-      requestStream: ${methodDesc.clientStreaming ? true : false},
-      responseStream: ${methodDesc.serverStreaming ? true : false},
+      requestStream: false,
+      responseStream: ${methodDesc.serverStreaming ? 'true' : 'false'},
       requestType: ${requestFn} as any,
       responseType: ${responseFn} as any,
     };
@@ -137,10 +133,6 @@ function addGrpcWebMisc(ctx, hasStreamingMethods) {
     interface UnaryMethodDefinitionishR extends ${grpc}.UnaryMethodDefinition<any, any> { requestStream: any; responseStream: any; }
   `);
     chunks.push((0, ts_poet_1.code) `type UnaryMethodDefinitionish = UnaryMethodDefinitionishR;`);
-    chunks.push((0, ts_poet_1.code) `
-    interface MethodDefinitionishR extends ${grpc}.MethodDefinition<any, any> { requestStream: any; responseStream: any; }
-`);
-    chunks.push((0, ts_poet_1.code) `type MethodDefinitionish = MethodDefinitionishR;`);
     chunks.push(generateGrpcWebRpcType(ctx, options.returnObservable, hasStreamingMethods));
     chunks.push(generateGrpcWebImpl(ctx, options.returnObservable, hasStreamingMethods));
     return (0, ts_poet_1.joinCode)(chunks, { on: '\n\n' });
@@ -164,14 +156,8 @@ function generateGrpcWebRpcType(ctx, returnObservable, hasStreamingMethods) {
         methodDesc: T,
         request: any,
         metadata: grpc.Metadata | undefined,
-      ): ${(0, types_1.observableType)(ctx)}<any>;`);
-        chunks.push((0, ts_poet_1.code) `
-  stream<T extends MethodDefinitionish>(
-    methodDesc: T,
-    request: ${(0, types_1.observableType)(ctx)}<any>,
-    metadata: grpc.Metadata | undefined,
-    rpcOptions: grpc.RpcOptions | undefined
-  ): ${(0, types_1.observableType)(ctx)}<any>;`);
+      ): ${(0, types_1.observableType)(ctx)}<any>;
+    `);
     }
     chunks.push((0, ts_poet_1.code) `}`);
     return (0, ts_poet_1.joinCode)(chunks, { on: '\n' });
@@ -192,7 +178,7 @@ function generateGrpcWebImpl(ctx, returnObservable, hasStreamingMethods) {
     export class GrpcWebImpl {
       private host: string;
       private options: ${options};
-
+      
       constructor(host: string, options: ${options}) {
         this.host = host;
         this.options = options;
@@ -206,7 +192,6 @@ function generateGrpcWebImpl(ctx, returnObservable, hasStreamingMethods) {
     }
     if (hasStreamingMethods) {
         chunks.push(createInvokeMethod(ctx));
-        chunks.push(createStreamMethod(ctx));
     }
     chunks.push((0, ts_poet_1.code) `}`);
     return (0, ts_poet_1.joinCode)(chunks, { trim: false });
@@ -274,7 +259,7 @@ function createObservableUnaryMethod(ctx) {
           },
         });
       }).pipe(${take}(1));
-    }
+    } 
   `;
 }
 function createInvokeMethod(ctx) {
@@ -320,50 +305,3 @@ function createInvokeMethod(ctx) {
     }
   `;
 }
-function createStreamMethod(ctx) {
-    return (0, ts_poet_1.code) `
-  stream<T extends MethodDefinitionish>(
-    methodDesc: T,
-    _request: ${(0, types_1.observableType)(ctx)}<any>,
-    metadata: ${grpc}.Metadata | undefined,
-    rpcOptions: ${grpc}.RpcOptions | undefined
-  ): ${(0, types_1.observableType)(ctx)}<any> {
-    const defaultOptions = {
-      host: this.host,
-      debug: rpcOptions?.debug || this.options.debug,
-      transport: rpcOptions?.transport || this.options.streamingTransport || this.options.transport,
-    }
-
-    let started = false;
-    const client = ${grpc}.client(methodDesc, defaultOptions);
-
-    const subscription = _request.subscribe((_req: any) => {
-      const request = { ..._req, ...methodDesc.requestType };
-      if (!started) {
-        client.start(metadata);
-        started = true;
-      }
-      client.send(request);
-    })
-
-    subscription.add(() => {
-      client.finishSend();
-    })
-
-    return new Observable((observer) => {
-      client.onEnd((code: ${grpc}.Code, message: string, trailers: ${grpc}.Metadata) => {
-        subscription.unsubscribe();
-        if (code === 0) {
-          observer.complete();
-        } else {
-          observer.error(new Error(\`Error \${code} \${message}\`));
-        }
-      })
-      client.onMessage((res: any) => {
-        observer.next(res);
-      })
-      observer.add(() => client.close())
-    }).pipe(share());
-  }
-`;
-}

package/build/generate-services.js

@@ -42,14 +42,7 @@ function generateService(ctx, fileDesc, sourceInfo, serviceDesc) {
         // Use metadata as last argument for interface only configuration
         if (options.outputClientImpl === 'grpc-web') {
             // We have to use grpc.Metadata where grpc will come from @improbable-eng
-            if (methodDesc.clientStreaming) {
-                params.push((0, ts_poet_1.code) `options?: {
-          metadata?: grpc.Metadata,
-          rpcOptions?: grpc.RpcOptions}`);
-            }
-            else {
-                params.push((0, ts_poet_1.code) `metadata?: grpc.Metadata`);
-            }
+            params.push((0, ts_poet_1.code) `metadata?: grpc.Metadata`);
         }
         else if (options.addGrpcMetadata) {
             const Metadata = (0, ts_poet_1.imp)('Metadata@@grpc/grpc-js');

package/build/main.js

@@ -115,6 +115,7 @@ function generateFile(ctx, fileDesc) {
             }
         }, options);
     }
+    let hasServerStreamingMethods = false;
     let hasStreamingMethods = false;
     (0, visit_1.visitServices)(fileDesc, sourceInfo, (serviceDesc, sInfo) => {
         if (options.nestJs) {
@@ -154,7 +155,12 @@ function generateFile(ctx, fileDesc) {
                         chunks.push((0, generate_grpc_web_1.generateGrpcClientImpl)(ctx, fileDesc, serviceDesc));
                         chunks.push((0, generate_grpc_web_1.generateGrpcServiceDesc)(fileDesc, serviceDesc));
                         serviceDesc.method.forEach((method) => {
-                            chunks.push((0, generate_grpc_web_1.generateGrpcMethodDesc)(ctx, serviceDesc, method));
+                            if (!method.clientStreaming) {
+                                chunks.push((0, generate_grpc_web_1.generateGrpcMethodDesc)(ctx, serviceDesc, method));
+                            }
+                            if (method.serverStreaming) {
+                                hasServerStreamingMethods = true;
+                            }
                         });
                     }
                 }
@@ -173,7 +179,7 @@ function generateFile(ctx, fileDesc) {
             chunks.push((0, generate_services_1.generateRpcType)(ctx, hasStreamingMethods));
         }
         else if (options.outputClientImpl === 'grpc-web') {
-            chunks.push((0, generate_grpc_web_1.addGrpcWebMisc)(ctx, hasStreamingMethods));
+            chunks.push((0, generate_grpc_web_1.addGrpcWebMisc)(ctx, hasServerStreamingMethods));
         }
     }
     if (options.context) {

package/build/options.js

@@ -134,7 +134,7 @@ function optionsFromParameter(parameter) {
         options.snakeToCamel = ['keys', 'json'];
     }
     else if (typeof options.snakeToCamel === 'string') {
-        options.snakeToCamel = [options.snakeToCamel];
+        options.snakeToCamel = options.snakeToCamel.split('_');
     }
     if (options.useJsonWireFormat) {
         if (!options.onlyTypes) {

package/build/types.js

@@ -641,7 +641,7 @@ function responseObservable(ctx, methodDesc) {
 exports.responseObservable = responseObservable;
 function responsePromiseOrObservable(ctx, methodDesc) {
     const { options } = ctx;
-    if (options.returnObservable || methodDesc.serverStreaming || methodDesc.clientStreaming) {
+    if (options.returnObservable || methodDesc.serverStreaming) {
         return responseObservable(ctx, methodDesc);
     }
     return responsePromise(ctx, methodDesc);

package/package.json

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