ts-proto 1.139.0 → 1.140.0

package/README.markdown

@@ -352,6 +352,10 @@ Generated code will be placed in the Gradle build directory.
 
 - With `--ts_proto_opt=unrecognizedEnum=false` enums will not contain an `UNRECOGNIZED` key with value of -1.
 
+- With `--ts_proto_opt=removeEnumPrefix=true` generated enums will have the enum name removed from members.
+
+  `FooBar.FOO_BAR_BAZ = "FOO_BAR_BAZ"` will generate `FooBar.BAZ = "FOO_BAR_BAZ"`
+
 - 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 in both the message keys and the `toJSON` / `fromJSON` methods.
@@ -400,7 +404,7 @@ Generated code will be placed in the Gradle build directory.
 
 - With `--ts_proto_opt=nestJs=true`, the defaults will change to generate [NestJS protobuf](https://docs.nestjs.com/microservices/grpc) friendly types & service interfaces that can be used in both the client-side and server-side of NestJS protobuf implementations. See the [nestjs readme](NESTJS.markdown) for more information and implementation examples.
 
-  Specifically `outputEncodeMethods`, `outputJsonMethods`, and `outputClientImpl` will all be false, and `lowerCaseServiceMethods` will be true.
+  Specifically `outputEncodeMethods`, `outputJsonMethods`, and `outputClientImpl` will all be false, `lowerCaseServiceMethods` will be true and `outputServices` will be ignored.
 
   Note that `addGrpcMetadata`, `addNestjsRestParameter` and `returnObservable` will still be false.
 

package/build/enums.js

@@ -23,8 +23,10 @@ function generateEnum(ctx, fullName, enumDesc, sourceInfo) {
     enumDesc.value.forEach((valueDesc, index) => {
         var _a;
         const info = sourceInfo.lookup(sourceInfo_1.Fields.enum.value, index);
-        (0, utils_1.maybeAddComment)(info, chunks, (_a = valueDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated, `${valueDesc.name} - `);
-        chunks.push((0, ts_poet_1.code) `${valueDesc.name} ${delimiter} ${options.stringEnums ? `"${valueDesc.name}"` : valueDesc.number.toString()},`);
+        const valueName = getValueName(ctx, fullName, valueDesc);
+        const memberName = getMemberName(ctx, fullName, valueDesc);
+        (0, utils_1.maybeAddComment)(info, chunks, (_a = valueDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated, `${memberName} - `);
+        chunks.push((0, ts_poet_1.code) `${memberName} ${delimiter} ${options.stringEnums ? `"${valueName}"` : valueDesc.number.toString()},`);
     });
     if (options.unrecognizedEnum)
         chunks.push((0, ts_poet_1.code) `
@@ -60,10 +62,12 @@ function generateEnumFromJson(ctx, fullName, enumDesc) {
     chunks.push((0, ts_poet_1.code) `export function ${(0, ts_poet_1.def)(functionName)}(object: any): ${fullName} {`);
     chunks.push((0, ts_poet_1.code) `switch (object) {`);
     for (const valueDesc of enumDesc.value) {
+        const memberName = getMemberName(ctx, fullName, valueDesc);
+        const valueName = getValueName(ctx, fullName, valueDesc);
         chunks.push((0, ts_poet_1.code) `
       case ${valueDesc.number}:
-      case "${valueDesc.name}":
-        return ${fullName}.${valueDesc.name};
+      case "${valueName}":
+        return ${fullName}.${memberName};
     `);
     }
     if (options.unrecognizedEnum) {
@@ -95,10 +99,13 @@ function generateEnumToJson(ctx, fullName, enumDesc) {
     chunks.push((0, ts_poet_1.code) `switch (object) {`);
     for (const valueDesc of enumDesc.value) {
         if (ctx.options.useNumericEnumForJson) {
-            chunks.push((0, ts_poet_1.code) `case ${fullName}.${valueDesc.name}: return ${valueDesc.number};`);
+            const memberName = getMemberName(ctx, fullName, valueDesc);
+            chunks.push((0, ts_poet_1.code) `case ${fullName}.${memberName}: return ${valueDesc.number};`);
         }
         else {
-            chunks.push((0, ts_poet_1.code) `case ${fullName}.${valueDesc.name}: return "${valueDesc.name}";`);
+            const memberName = getMemberName(ctx, fullName, valueDesc);
+            const valueName = getValueName(ctx, fullName, valueDesc);
+            chunks.push((0, ts_poet_1.code) `case ${fullName}.${memberName}: return "${valueName}";`);
         }
     }
     if (options.unrecognizedEnum) {
@@ -137,7 +144,7 @@ function generateEnumToNumber(ctx, fullName, enumDesc) {
     chunks.push((0, ts_poet_1.code) `export function ${(0, ts_poet_1.def)(functionName)}(object: ${fullName}): number {`);
     chunks.push((0, ts_poet_1.code) `switch (object) {`);
     for (const valueDesc of enumDesc.value) {
-        chunks.push((0, ts_poet_1.code) `case ${fullName}.${valueDesc.name}: return ${valueDesc.number};`);
+        chunks.push((0, ts_poet_1.code) `case ${fullName}.${getMemberName(ctx, fullName, valueDesc)}: return ${valueDesc.number};`);
     }
     if (options.unrecognizedEnum) {
         chunks.push((0, ts_poet_1.code) `
@@ -158,3 +165,12 @@ function generateEnumToNumber(ctx, fullName, enumDesc) {
     return (0, ts_poet_1.joinCode)(chunks, { on: "\n" });
 }
 exports.generateEnumToNumber = generateEnumToNumber;
+function getMemberName(ctx, fullName, valueDesc) {
+    if (ctx.options.removeEnumPrefix) {
+        return valueDesc.name.replace(`${(0, case_1.camelToSnake)(fullName)}_`, "");
+    }
+    return valueDesc.name;
+}
+function getValueName(ctx, fullName, valueDesc) {
+    return valueDesc.name;
+}

package/build/generate-grpc-web.js

@@ -39,6 +39,8 @@ exports.generateGrpcClientImpl = generateGrpcClientImpl;
 /** Creates the RPC methods that client code actually calls. */
 function generateRpcMethod(ctx, serviceDesc, methodDesc) {
     (0, utils_1.assertInstanceOf)(methodDesc, utils_1.FormattedMethodDescriptor);
+    const { options } = ctx;
+    const { useAbortSignal } = options;
     const requestMessage = (0, types_1.rawRequestType)(ctx, methodDesc);
     const inputType = (0, types_1.requestType)(ctx, methodDesc, true);
     const returns = (0, types_1.responsePromiseOrObservable)(ctx, methodDesc);
@@ -47,6 +49,7 @@ function generateRpcMethod(ctx, serviceDesc, methodDesc) {
     ${methodDesc.formattedName}(
       request: ${inputType},
       metadata?: grpc.Metadata,
+      ${useAbortSignal ? "abortSignal?: AbortSignal," : ""}
     ): ${returns} {
       throw new Error('ts-proto does not yet support client streaming!');
     }
@@ -57,10 +60,12 @@ function generateRpcMethod(ctx, serviceDesc, methodDesc) {
     ${methodDesc.formattedName}(
       request: ${inputType},
       metadata?: grpc.Metadata,
+      ${useAbortSignal ? "abortSignal?: AbortSignal," : ""}
     ): ${returns} {
       return this.rpc.${method}(
         ${methodDescName(serviceDesc, methodDesc)},
         ${requestMessage}.fromPartial(request),
+        ${useAbortSignal ? "abortSignal," : ""}
         metadata,
       );
     }
@@ -145,6 +150,8 @@ exports.addGrpcWebMisc = addGrpcWebMisc;
 /** Makes an `Rpc` interface to decouple from the low-level grpc-web `grpc.invoke and grpc.unary`/etc. methods. */
 function generateGrpcWebRpcType(ctx, returnObservable, hasStreamingMethods) {
     const chunks = [];
+    const { options } = ctx;
+    const { useAbortSignal } = options;
     chunks.push((0, ts_poet_1.code) `interface Rpc {`);
     const wrapper = returnObservable ? (0, types_1.observableType)(ctx) : "Promise";
     chunks.push((0, ts_poet_1.code) `
@@ -152,6 +159,7 @@ function generateGrpcWebRpcType(ctx, returnObservable, hasStreamingMethods) {
       methodDesc: T,
       request: any,
       metadata: grpc.Metadata | undefined,
+      ${useAbortSignal ? "abortSignal?: AbortSignal," : ""}
     ): ${wrapper}<any>;
   `);
     if (hasStreamingMethods) {
@@ -160,6 +168,7 @@ function generateGrpcWebRpcType(ctx, returnObservable, hasStreamingMethods) {
         methodDesc: T,
         request: any,
         metadata: grpc.Metadata | undefined,
+        ${useAbortSignal ? "abortSignal?: AbortSignal," : ""}
       ): ${(0, types_1.observableType)(ctx)}<any>;
     `);
     }
@@ -201,11 +210,23 @@ function generateGrpcWebImpl(ctx, returnObservable, hasStreamingMethods) {
     return (0, ts_poet_1.joinCode)(chunks, { trim: false });
 }
 function createPromiseUnaryMethod(ctx) {
+    const { options } = ctx;
+    const { useAbortSignal } = options;
+    const maybeAbortSignal = useAbortSignal
+        ? `
+      const abortHandler = () => {
+        client.close();
+        reject(new Error("Aborted"));
+      }
+
+      if (abortSignal) abortSignal.addEventListener("abort", abortHandler);`
+        : "";
     return (0, ts_poet_1.code) `
     unary<T extends UnaryMethodDefinitionish>(
       methodDesc: T,
       _request: any,
-      metadata: grpc.Metadata | undefined
+      metadata: grpc.Metadata | undefined,
+      ${useAbortSignal ? "abortSignal?: AbortSignal," : ""}
     ): Promise<any> {
       const request = { ..._request, ...methodDesc.requestType };
       const maybeCombinedMetadata =
@@ -213,7 +234,7 @@ function createPromiseUnaryMethod(ctx) {
           ? new ${BrowserHeaders}({ ...this.options?.metadata.headersMap, ...metadata?.headersMap })
           : metadata || this.options.metadata;
       return new Promise((resolve, reject) => {
-      ${grpc}.unary(methodDesc, {
+        ${useAbortSignal ? `const client =` : ""} ${grpc}.unary(methodDesc, {
           request,
           host: this.host,
           metadata: maybeCombinedMetadata,
@@ -228,16 +249,29 @@ function createPromiseUnaryMethod(ctx) {
             }
           },
         });
+
+        ${maybeAbortSignal}
       });
     }
   `;
 }
 function createObservableUnaryMethod(ctx) {
+    const { options } = ctx;
+    const { useAbortSignal } = options;
+    const maybeAbortSignal = useAbortSignal
+        ? `
+      const abortHandler = () => {
+        observer.error("Aborted");
+        client.close();
+      };
+      if (abortSignal) abortSignal.addEventListener("abort", abortHandler);`
+        : "";
     return (0, ts_poet_1.code) `
     unary<T extends UnaryMethodDefinitionish>(
       methodDesc: T,
       _request: any,
-      metadata: grpc.Metadata | undefined
+      metadata: grpc.Metadata | undefined,
+      ${useAbortSignal ? "abortSignal?: AbortSignal," : ""}
     ): ${(0, types_1.observableType)(ctx)}<any> {
       const request = { ..._request, ...methodDesc.requestType };
       const maybeCombinedMetadata =
@@ -245,7 +279,7 @@ function createObservableUnaryMethod(ctx) {
           ? new ${BrowserHeaders}({ ...this.options?.metadata.headersMap, ...metadata?.headersMap })
           : metadata || this.options.metadata;
       return new Observable(observer => {
-        ${grpc}.unary(methodDesc, {
+        ${useAbortSignal ? `const client =` : ""} ${grpc}.unary(methodDesc, {
           request,
           host: this.host,
           metadata: maybeCombinedMetadata,
@@ -261,16 +295,31 @@ function createObservableUnaryMethod(ctx) {
             }
           },
         });
+
+
+      ${maybeAbortSignal}
+
       }).pipe(${take}(1));
     } 
   `;
 }
 function createInvokeMethod(ctx) {
+    const { options } = ctx;
+    const { useAbortSignal } = options;
+    const maybeAbortSignal = useAbortSignal
+        ? `
+      const abortHandler = () => {
+        observer.error("Aborted");
+        client.close();
+      };
+      if (abortSignal) abortSignal.addEventListener("abort", abortHandler);`
+        : "";
     return (0, ts_poet_1.code) `
     invoke<T extends UnaryMethodDefinitionish>(
       methodDesc: T,
       _request: any,
-      metadata: grpc.Metadata | undefined
+      metadata: grpc.Metadata | undefined,
+      ${useAbortSignal ? "abortSignal?: AbortSignal," : ""}
     ): ${(0, types_1.observableType)(ctx)}<any> {
       const upStreamCodes = this.options.upStreamRetryCodes || [];
       const DEFAULT_TIMEOUT_TIME: number = 3_000;
@@ -301,7 +350,11 @@ function createInvokeMethod(ctx) {
               }
             },
           });
-          observer.add(() => client.close());
+          observer.add(() => {
+            if (!observer.closed) return client.close()
+          });
+
+          ${maybeAbortSignal}
         });
         upStream();
       }).pipe(${share}());

package/build/generate-services.js

@@ -39,9 +39,6 @@ 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
@@ -56,6 +53,9 @@ function generateService(ctx, fileDesc, sourceInfo, serviceDesc) {
             const Metadata = (0, ts_poet_1.imp)(options.metadataType);
             params.push((0, ts_poet_1.code) `metadata?: ${Metadata}`);
         }
+        if (options.useAbortSignal) {
+            params.push((0, ts_poet_1.code) `abortSignal?: AbortSignal`);
+        }
         if (options.addNestjsRestParameter) {
             params.push((0, ts_poet_1.code) `...rest: any`);
         }

package/build/options.js

@@ -52,6 +52,7 @@ function defaultOptions() {
         outputTypeRegistry: false,
         stringEnums: false,
         constEnums: false,
+        removeEnumPrefix: false,
         enumsAsLiterals: false,
         outputClientImpl: true,
         outputServices: [],

package/package.json

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