ts-proto 1.163.0 → 1.164.0

package/README.markdown

@@ -446,6 +446,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`.

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/options.js

@@ -87,6 +87,8 @@ function defaultOptions() {
         outputExtensions: false,
         outputIndex: false,
         M: {},
+        outputBeforeRequest: false,
+        outputAfterResponse: false,
     };
 }
 exports.defaultOptions = defaultOptions;
@@ -175,6 +177,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.0",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",