ts-proto 1.163.0 → 1.164.1

package/README.markdown

@@ -147,6 +147,8 @@ If you'd like an out-of-the-box RPC framework built on top of ts-proto, there ar
 
 (Note for potential contributors, if you develop other frameworks/mini-frameworks, or even blog posts/tutorials, on using `ts-proto`, we're happy to link to them.)
 
+We also don't support clients for `google.api.http`-based [Google Cloud](https://cloud.google.com/endpoints/docs/grpc/transcoding) APIs, see [#948](https://github.com/stephenh/ts-proto/issues/948) if you'd like to submit a PR.
+
 # Example Types
 
 The generated types are "just data", i.e.:
@@ -446,6 +448,10 @@ Generated code will be placed in the Gradle build directory.
 
 - With `--ts_proto_opt=outputServices=false`, or `=none`, ts-proto will output NO service definitions.
 
+- With `--ts_proto_opt=outputBeforeRequest=true`, ts-proto will add a function definition to the Rpc interface definition with the signature: `beforeRequest(request: <RequestType>)`. It will will also automatically set `outputTypeRegistry=true` and `outputServices=true`. Each of the Service's methods will call `beforeRequest` before performing it's request.
+
+- With `--ts_proto_opt=outputAfterResponse=true`, ts-proto will add a function definition to the Rpc interface definition with the signature: `afterResponse(response: <ResponseType>)`. It will will also automatically set `outputTypeRegistry=true` and `outputServices=true`. Each of the Service's methods will call `afterResponse` before returning the response.
+
 - With `--ts_proto_opt=useAbortSignal=true`, the generated services will accept an `AbortSignal` to cancel RPC calls.
 
 - With `--ts_proto_opt=useAsyncIterable=true`, the generated services will use `AsyncIterable` instead of `Observable`.
@@ -885,11 +891,14 @@ ExampleMessage.encode({ anything: true });
 ## Timestamp
 
 The representation of `google.protobuf.Timestamp` is configurable by the `useDate` flag.
+The `useJsonTimestamp` flag controls precision when `useDate` is `false`.
 
 | Protobuf well-known type    | Default/`useDate=true` | `useDate=false`                      | `useDate=string` |
 | --------------------------- | ---------------------- | ------------------------------------ | ---------------- |
 | `google.protobuf.Timestamp` | `Date`                 | `{ seconds: number, nanos: number }` | `string`         |
 
+When using `useDate=false` and `useJsonTimestamp=raw` timestamp is represented as `{ seconds: number, nanos: number }`, but has nanosecond precision.
+
 # Number Types
 
 Numbers are by default assumed to be plain JavaScript `number`s.

package/build/generate-services.js

@@ -88,7 +88,23 @@ function generateRegularRpcMethod(ctx, methodDesc) {
     const maybeCtx = options.context ? "ctx," : "";
     const maybeAbortSignal = options.useAbortSignal ? "abortSignal || undefined," : "";
     let encode = (0, ts_poet_1.code) `${rawInputType}.encode(request).finish()`;
+    let beforeRequest;
+    if (options.outputBeforeRequest) {
+        beforeRequest = (0, ts_poet_1.code) `
+    if (this.rpc.beforeRequest) {
+      this.rpc.beforeRequest(request);
+    }`;
+    }
     let decode = (0, ts_poet_1.code) `data => ${rawOutputType}.decode(${Reader}.create(data))`;
+    if (options.outputAfterResponse) {
+        decode = (0, ts_poet_1.code) `data => {
+      const response = ${rawOutputType}.decode(${Reader}.create(data));
+      if (this.rpc.afterResponse) {
+        this.rpc.afterResponse(response);
+      }
+      return response;
+    }`;
+    }
     // if (options.useDate && rawOutputType.toString().includes("Timestamp")) {
     //   decode = code`data => ${utils.fromTimestamp}(${rawOutputType}.decode(${Reader}.create(data)))`;
     // }
@@ -131,7 +147,7 @@ function generateRegularRpcMethod(ctx, methodDesc) {
     ${methodDesc.formattedName}(
       ${(0, ts_poet_1.joinCode)(params, { on: "," })}
     ): ${(0, types_1.responsePromiseOrObservable)(ctx, methodDesc)} {
-      const data = ${encode};
+      const data = ${encode}; ${beforeRequest ? beforeRequest : ""}
       const ${returnVariable} = this.rpc.${rpcMethod}(
         ${maybeCtx}
         this.service,
@@ -285,6 +301,13 @@ function generateRpcType(ctx, hasStreamingMethods) {
     const maybeContextParam = options.context ? "ctx: Context," : "";
     const maybeAbortSignalParam = options.useAbortSignal ? "abortSignal?: AbortSignal," : "";
     const methods = [[(0, ts_poet_1.code) `request`, (0, ts_poet_1.code) `Uint8Array`, (0, ts_poet_1.code) `Promise<Uint8Array>`]];
+    const additionalMethods = [];
+    if (options.outputBeforeRequest) {
+        additionalMethods.push((0, ts_poet_1.code) `beforeRequest?<T extends { [k in keyof T]: unknown }>(request: T): void;`);
+    }
+    if (options.outputAfterResponse) {
+        additionalMethods.push((0, ts_poet_1.code) `afterResponse?<T extends { [k in keyof T]: unknown }>(response: T): void;`);
+    }
     if (hasStreamingMethods) {
         const observable = (0, types_1.observableType)(ctx, true);
         methods.push([(0, ts_poet_1.code) `clientStreamingRequest`, (0, ts_poet_1.code) `${observable}<Uint8Array>`, (0, ts_poet_1.code) `Promise<Uint8Array>`]);
@@ -307,6 +330,7 @@ function generateRpcType(ctx, hasStreamingMethods) {
         ${maybeAbortSignalParam}
       ): ${method[2]};`);
     });
+    additionalMethods.forEach((method) => chunks.push(method));
     chunks.push((0, ts_poet_1.code) `    }`);
     return (0, ts_poet_1.joinCode)(chunks, { on: "\n" });
 }

package/build/main.js

@@ -2,24 +2,24 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.contextTypeVar = exports.makeUtils = exports.generateFile = void 0;
 const ts_poet_1 = require("ts-poet");
+const ConditionalOutput_1 = require("ts-poet/build/ConditionalOutput");
 const ts_proto_descriptors_1 = require("ts-proto-descriptors");
-const types_1 = require("./types");
-const sourceInfo_1 = require("./sourceInfo");
-const utils_1 = require("./utils");
 const case_1 = require("./case");
-const generate_nestjs_1 = require("./generate-nestjs");
-const generate_services_1 = require("./generate-services");
-const generate_grpc_web_1 = require("./generate-grpc-web");
-const generate_async_iterable_1 = require("./generate-async-iterable");
 const enums_1 = require("./enums");
-const visit_1 = require("./visit");
-const options_1 = require("./options");
-const schema_1 = require("./schema");
-const ConditionalOutput_1 = require("ts-poet/build/ConditionalOutput");
-const generate_grpc_js_1 = require("./generate-grpc-js");
+const generate_async_iterable_1 = require("./generate-async-iterable");
 const generate_generic_service_definition_1 = require("./generate-generic-service-definition");
+const generate_grpc_js_1 = require("./generate-grpc-js");
+const generate_grpc_web_1 = require("./generate-grpc-web");
+const generate_nestjs_1 = require("./generate-nestjs");
 const generate_nice_grpc_1 = require("./generate-nice-grpc");
+const generate_services_1 = require("./generate-services");
 const generate_struct_wrappers_1 = require("./generate-struct-wrappers");
+const options_1 = require("./options");
+const schema_1 = require("./schema");
+const sourceInfo_1 = require("./sourceInfo");
+const types_1 = require("./types");
+const utils_1 = require("./utils");
+const visit_1 = require("./visit");
 function generateFile(ctx, fileDesc) {
     var _a;
     const { options, utils } = ctx;
@@ -1733,7 +1733,10 @@ function generateToJson(ctx, fullName, fullProtobufTypeName, messageDesc) {
                 return (0, ts_poet_1.code) `${from}`;
             }
             else if ((0, types_1.isTimestamp)(field) && options.useDate === options_1.DateOption.TIMESTAMP) {
-                return (0, ts_poet_1.code) `${from}`;
+                if (options.useJsonTimestamp === options_1.JsonTimestampOption.RAW) {
+                    return (0, ts_poet_1.code) `${from}`;
+                }
+                return (0, ts_poet_1.code) `${utils.fromTimestamp}(${from}).toISOString()`;
             }
             else if ((0, types_1.isMapType)(ctx, messageDesc, field)) {
                 // For map types, drill-in and then admittedly re-hard-code our per-value-type logic

package/build/options.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.addTypeToMessages = exports.getTsPoetOpts = exports.optionsFromParameter = exports.defaultOptions = exports.ServiceOption = exports.OneofOption = exports.EnvOption = exports.DateOption = exports.LongOption = void 0;
+exports.addTypeToMessages = exports.getTsPoetOpts = exports.optionsFromParameter = exports.defaultOptions = exports.ServiceOption = exports.OneofOption = exports.EnvOption = exports.JsonTimestampOption = exports.DateOption = exports.LongOption = void 0;
 var LongOption;
 (function (LongOption) {
     LongOption["NUMBER"] = "number";
@@ -14,6 +14,11 @@ var DateOption;
     DateOption["STRING"] = "string";
     DateOption["TIMESTAMP"] = "timestamp";
 })(DateOption || (exports.DateOption = DateOption = {}));
+var JsonTimestampOption;
+(function (JsonTimestampOption) {
+    JsonTimestampOption["RFC3339"] = "rfc3339";
+    JsonTimestampOption["RAW"] = "raw";
+})(JsonTimestampOption || (exports.JsonTimestampOption = JsonTimestampOption = {}));
 var EnvOption;
 (function (EnvOption) {
     EnvOption["NODE"] = "node";
@@ -42,6 +47,7 @@ function defaultOptions() {
         forceLong: LongOption.NUMBER,
         useOptionals: "none",
         useDate: DateOption.DATE,
+        useJsonTimestamp: JsonTimestampOption.RFC3339,
         useMongoObjectId: false,
         oneof: OneofOption.PROPERTIES,
         esModuleInterop: false,
@@ -87,6 +93,8 @@ function defaultOptions() {
         outputExtensions: false,
         outputIndex: false,
         M: {},
+        outputBeforeRequest: false,
+        outputAfterResponse: false,
     };
 }
 exports.defaultOptions = defaultOptions;
@@ -175,6 +183,9 @@ function optionsFromParameter(parameter) {
     if (options.outputIndex) {
         options.exportCommonSymbols = false;
     }
+    if (options.outputBeforeRequest || options.outputAfterResponse) {
+        options.outputServices = [ServiceOption.DEFAULT];
+    }
     if (options.unrecognizedEnumValue) {
         // Make sure to cast number options to an actual number
         options.unrecognizedEnumValue = Number(options.unrecognizedEnumValue);

package/package.json

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