ts-proto 1.105.1 → 1.105.2

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [1.105.2](https://github.com/stephenh/ts-proto/compare/v1.105.1...v1.105.2) (2022-02-17)
+
+
+### Bug Fixes
+
+* Fix snakeToCamel single value parsing. ([#513](https://github.com/stephenh/ts-proto/issues/513)) ([e1ad866](https://github.com/stephenh/ts-proto/commit/e1ad866c95751c37ed13f02f4da2dc9076ab4758))
+
 ## [1.105.1](https://github.com/stephenh/ts-proto/compare/v1.105.0...v1.105.1) (2022-02-14)
 
 

package/README.markdown

@@ -23,6 +23,7 @@
     - [Only Types](#only-types)
     - [NestJS Support](#nestjs-support)
     - [Watch Mode](#watch-mode)
+    - [Basic gRPC implementation](#basic-grpc-implementation)
 - [Sponsors](#sponsors)
 - [Development](#development)
 - [Assumptions](#assumptions)
@@ -406,6 +407,51 @@ If you want to run `ts-proto` on every change of a proto file, you'll need to us
 "proto:watch": "chokidar \"**/*.proto\" -c \"npm run proto:generate\""
 ```
 
+### Basic gRPC implementation
+
+`ts-proto` is RPC framework agnostic - how you transmit your data to and from
+your data source is up to you. The generated client implementations all expect
+a `rpc` parameter, which type is defined like this: 
+
+```ts
+interface Rpc {
+  request(service: string, method: string, data: Uint8Array): Promise<Uint8Array>;
+}
+```
+
+If you're working with gRPC, a simple implementation could look like this: 
+
+```ts
+type RpcImpl = (service: string, method: string, data: Uint8Array) => Promise<Uint8Array>;
+
+const sendRequest: RpcImpl = (service, method, data) => {
+  // Conventionally in gRPC, the request path looks like
+  //   "package.names.ServiceName/MethodName",
+  // we therefore construct such a string
+  const path = `${service}/${method}`;
+
+  return new Promise((resolve, reject) => {
+    // makeUnaryRequest transmits the result (and error) with a callback
+    // transform this into a promise!
+    const resultCallback: UnaryCallback<any> = (err, res) => {
+      if (err) {
+        return reject(err);
+      }
+      resolve(res);
+    };
+
+    function passThrough(argument: any) {
+      return argument;
+    }
+
+    // Using passThrough as the serialize and deserialize functions
+    conn.makeUnaryRequest(path, passThrough, passThrough, data, resultCallback);
+  });
+};
+
+const rpc: Rpc = { request: sendRequest }
+```
+
 # Sponsors
 
 Kudos to our sponsors:
@@ -591,6 +637,7 @@ Their interpretation is defined by the Protobuf specification, and libraries are
   * [google.protobuf.Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#Value)  &lrarr; `any | undefined` (i.e. `number | string | boolean | null | array | object`)
   * [google.protobuf.ListValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#ListValue) &lrarr; `any[]`
   * [google.protobuf.Struct](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#Struct) &lrarr; `{ [key: string]: any } | undefined`
+  * [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask) &lrarr; `string[]` (only in the JSON, `FieldMask` is still a message)
 
 ## Wrapper Types
 

package/build/options.js

@@ -111,6 +111,9 @@ function optionsFromParameter(parameter) {
     else if (options.snakeToCamel === true) {
         options.snakeToCamel = ['keys', 'json'];
     }
+    else if (typeof options.snakeToCamel === 'string') {
+        options.snakeToCamel = [options.snakeToCamel];
+    }
     return options;
 }
 exports.optionsFromParameter = optionsFromParameter;
@@ -118,8 +121,14 @@ exports.optionsFromParameter = optionsFromParameter;
 function parseParameter(parameter) {
     const options = {};
     const pairs = parameter.split(',').map((s) => s.split('='));
-    pairs.forEach(([key, value]) => {
-        options[key] = value === 'true' ? true : value === 'false' ? false : value;
+    pairs.forEach(([key, _value]) => {
+        const value = _value === 'true' ? true : _value === 'false' ? false : _value;
+        if (options[key]) {
+            options[key] = [options[key], value];
+        }
+        else {
+            options[key] = value;
+        }
     });
     return options;
 }

package/package.json

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