ts-proto 1.135.3 → 1.136.1

package/README.markdown

@@ -412,6 +412,8 @@ 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=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`.
 
 - 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/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;`);

package/build/generate-services.js

@@ -39,6 +39,9 @@ function generateService(ctx, fileDesc, sourceInfo, serviceDesc) {
         const partialInput = options.outputClientImpl === "grpc-web";
         const inputType = (0, types_1.requestType)(ctx, methodDesc, partialInput);
         params.push((0, ts_poet_1.code) `request: ${inputType}`);
+        if (options.useAbortSignal) {
+            params.push((0, ts_poet_1.code) `abortSignal?: AbortSignal`);
+        }
         // 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
@@ -72,16 +75,20 @@ function generateService(ctx, fileDesc, sourceInfo, serviceDesc) {
     return (0, ts_poet_1.joinCode)(chunks, { on: "\n" });
 }
 exports.generateService = generateService;
-function generateRegularRpcMethod(ctx, fileDesc, serviceDesc, methodDesc) {
+function generateRegularRpcMethod(ctx, methodDesc) {
     (0, utils_1.assertInstanceOf)(methodDesc, utils_1.FormattedMethodDescriptor);
-    const { options, utils } = ctx;
+    const { options } = ctx;
     const Reader = (0, utils_1.impFile)(ctx.options, "Reader@protobufjs/minimal");
     const rawInputType = (0, types_1.rawRequestType)(ctx, methodDesc, { keepValueType: true });
     const inputType = (0, types_1.requestType)(ctx, methodDesc);
-    const outputType = (0, types_1.responseType)(ctx, methodDesc);
     const rawOutputType = (0, types_1.responseType)(ctx, methodDesc, { keepValueType: true });
-    const params = [...(options.context ? [(0, ts_poet_1.code) `ctx: Context`] : []), (0, ts_poet_1.code) `request: ${inputType}`];
+    const params = [
+        ...(options.context ? [(0, ts_poet_1.code) `ctx: Context`] : []),
+        (0, ts_poet_1.code) `request: ${inputType}`,
+        ...(options.useAbortSignal ? [(0, ts_poet_1.code) `abortSignal?: AbortSignal`] : []),
+    ];
     const maybeCtx = options.context ? "ctx," : "";
+    const maybeAbortSignal = options.useAbortSignal ? "abortSignal || undefined," : "";
     let encode = (0, ts_poet_1.code) `${rawInputType}.encode(request).finish()`;
     let decode = (0, ts_poet_1.code) `data => ${rawOutputType}.decode(new ${Reader}(data))`;
     // if (options.useDate && rawOutputType.toString().includes("Timestamp")) {
@@ -131,7 +138,8 @@ function generateRegularRpcMethod(ctx, fileDesc, serviceDesc, methodDesc) {
         ${maybeCtx}
         this.service,
         "${methodDesc.name}",
-        data
+        data,
+        ${maybeAbortSignal}
       );
       return ${decode};
     }
@@ -172,7 +180,7 @@ function generateServiceClientImpl(ctx, fileDesc, serviceDesc) {
             chunks.push(generateCachingRpcMethod(ctx, fileDesc, serviceDesc, methodDesc));
         }
         else {
-            chunks.push(generateRegularRpcMethod(ctx, fileDesc, serviceDesc, methodDesc));
+            chunks.push(generateRegularRpcMethod(ctx, methodDesc));
         }
     }
     chunks.push((0, ts_poet_1.code) `}`);
@@ -267,6 +275,7 @@ function generateRpcType(ctx, hasStreamingMethods) {
     const { options } = ctx;
     const maybeContext = options.context ? "<Context>" : "";
     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>`]];
     if (hasStreamingMethods) {
         const observable = (0, types_1.observableType)(ctx);
@@ -286,7 +295,8 @@ function generateRpcType(ctx, hasStreamingMethods) {
         ${maybeContextParam}
         service: string,
         method: string,
-        data: ${method[1]}
+        data: ${method[1]},
+        ${maybeAbortSignalParam}
       ): ${method[2]};`);
     });
     chunks.push((0, ts_poet_1.code) `    }`);

package/build/main.js

@@ -74,7 +74,7 @@ function generateFile(ctx, fileDesc) {
     }
     if (options.outputEncodeMethods || options.outputJsonMethods || options.outputTypeRegistry) {
         // then add the encoder/decoder/base instance
-        (0, visit_1.visit)(fileDesc, sourceInfo, (fullName, message, sInfo, fullProtoTypeName) => {
+        (0, visit_1.visit)(fileDesc, sourceInfo, (fullName, message, _sInfo, fullProtoTypeName) => {
             const fullTypeName = (0, utils_1.maybePrefixPackage)(fileDesc, fullProtoTypeName);
             chunks.push(generateBaseInstanceFactory(ctx, fullName, message, fullTypeName));
             const staticMembers = [];
@@ -170,7 +170,7 @@ function generateFile(ctx, fileDesc) {
                 }
             });
         }
-        serviceDesc.method.forEach((methodDesc, index) => {
+        serviceDesc.method.forEach((methodDesc, _index) => {
             if (methodDesc.serverStreaming || methodDesc.clientStreaming) {
                 hasStreamingMethods = true;
             }
@@ -220,12 +220,12 @@ function makeUtils(options) {
     return {
         ...bytes,
         ...makeDeepPartial(options, longs),
-        ...makeObjectIdMethods(options),
+        ...makeObjectIdMethods(),
         ...makeTimestampMethods(options, longs),
         ...longs,
         ...makeComparisonUtils(),
         ...makeNiceGrpcServerStreamingMethodResult(),
-        ...makeGrpcWebErrorClass(),
+        ...makeGrpcWebErrorClass(bytes),
     };
 }
 exports.makeUtils = makeUtils;
@@ -297,11 +297,11 @@ function makeLongUtils(options, bytes) {
     return { numberToLong, longToNumber, longToString, Long };
 }
 function makeByteUtils() {
-    const globalThis = (0, ts_poet_1.conditionalOutput)("globalThis", (0, ts_poet_1.code) `
+    const globalThis = (0, ts_poet_1.conditionalOutput)("tsProtoGlobalThis", (0, ts_poet_1.code) `
       declare var self: any | undefined;
       declare var window: any | undefined;
       declare var global: any | undefined;
-      var globalThis: any = (() => {
+      var tsProtoGlobalThis: any = (() => {
         if (typeof globalThis !== "undefined") return globalThis;
         if (typeof self !== "undefined") return self;
         if (typeof window !== "undefined") return window;
@@ -375,7 +375,7 @@ function makeDeepPartial(options, longs) {
     `);
     return { Builtin, DeepPartial, Exact };
 }
-function makeObjectIdMethods(options) {
+function makeObjectIdMethods() {
     const mongodb = (0, ts_poet_1.imp)("mongodb*mongodb");
     const fromProtoObjectId = (0, ts_poet_1.conditionalOutput)("fromProtoObjectId", (0, ts_poet_1.code) `
       function fromProtoObjectId(oid: ObjectId): ${mongodb}.ObjectId {
@@ -492,9 +492,9 @@ function makeNiceGrpcServerStreamingMethodResult() {
     `);
     return { NiceGrpcServerStreamingMethodResult };
 }
-function makeGrpcWebErrorClass() {
+function makeGrpcWebErrorClass(bytes) {
     const GrpcWebError = (0, ts_poet_1.conditionalOutput)("GrpcWebError", (0, ts_poet_1.code) `
-      export class GrpcWebError extends globalThis.Error {
+      export class GrpcWebError extends ${bytes.globalThis}.Error {
         constructor(message: string, public code: grpc.Code, public metadata: grpc.Metadata) {
           super(message);
         }

package/build/options.js

@@ -66,6 +66,7 @@ function defaultOptions() {
         onlyTypes: false,
         emitImportedFiles: true,
         useExactTypes: true,
+        useAbortSignal: false,
         useAsyncIterable: false,
         unknownFields: false,
         usePrototypeForDefaults: false,

package/build/sourceInfo.js

@@ -45,11 +45,6 @@ class EmptyDescription {
  * defined in a protocol buffer.
  */
 class SourceInfo {
-    // Private
-    constructor(sourceCode, selfDescription) {
-        this.sourceCode = sourceCode;
-        this.selfDescription = selfDescription;
-    }
     /** Returns an empty SourceInfo */
     static empty() {
         return new SourceInfo({}, new EmptyDescription());
@@ -68,6 +63,11 @@ class SourceInfo {
         }
         return new SourceInfo(map, new EmptyDescription());
     }
+    // Private
+    constructor(sourceCode, selfDescription) {
+        this.sourceCode = sourceCode;
+        this.selfDescription = selfDescription;
+    }
     /** Returns the code span [start line, start column, end line] */
     get span() {
         return this.selfDescription.span;

package/build/utils.js

@@ -105,6 +105,13 @@ exports.assertInstanceOf = assertInstanceOf;
  * A MethodDescriptorProto subclass that adds formatted properties
  */
 class FormattedMethodDescriptor {
+    /**
+     * The name of this method with formatting applied according to the `Options` object passed to the constructor.
+     * Automatically updates to any changes to the `Options` or `name` of this object
+     */
+    get formattedName() {
+        return FormattedMethodDescriptor.formatName(this.name, this.ctxOptions);
+    }
     constructor(src, options) {
         this.ctxOptions = options;
         this.original = src;
@@ -115,13 +122,6 @@ class FormattedMethodDescriptor {
         this.clientStreaming = src.clientStreaming;
         this.serverStreaming = src.serverStreaming;
     }
-    /**
-     * The name of this method with formatting applied according to the `Options` object passed to the constructor.
-     * Automatically updates to any changes to the `Options` or `name` of this object
-     */
-    get formattedName() {
-        return FormattedMethodDescriptor.formatName(this.name, this.ctxOptions);
-    }
     /**
      * Retrieve the source `MethodDescriptorProto` used to construct this object
      * @returns The source `MethodDescriptorProto` used to construct this object

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-proto",
-  "version": "1.135.3",
+  "version": "1.136.1",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",
@@ -55,7 +55,7 @@
     "semantic-release": "^19.0.3",
     "ts-jest": "^28.0.5",
     "tsx": "^3.8.2",
-    "typescript": "^4.7.4",
+    "typescript": "^4.9.4",
     "uglify-js": "^3.16.1"
   },
   "dependencies": {