ts-proto 1.166.4 → 1.167.1

package/README.markdown

@@ -539,7 +539,9 @@ Generated code will be placed in the Gradle build directory.
 
   This will disable `exportCommonSymbols` to avoid name collisions on the common symbols.
 
-- With `--emitDefaultValues=json-methods`, the generated toJSON method will emit scalars like `0` and `""` as json fields.
+- With `--ts_proto_opt=emitDefaultValues=json-methods`, the generated toJSON method will emit scalars like `0` and `""` as json fields.
+
+- With `--ts_proto_opt=comments=false`, comments won't be copied from the proto files to the generated code.
 
 ### NestJS Support
 

package/build/enums.js

@@ -11,7 +11,7 @@ function generateEnum(ctx, fullName, enumDesc, sourceInfo) {
     const { options } = ctx;
     const chunks = [];
     let unrecognizedEnum = { present: false };
-    (0, utils_1.maybeAddComment)(sourceInfo, chunks, (_a = enumDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
+    (0, utils_1.maybeAddComment)(options, sourceInfo, chunks, (_a = enumDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
     if (options.enumsAsLiterals) {
         chunks.push((0, ts_poet_1.code) `export const ${(0, ts_poet_1.def)(fullName)} = {`);
     }
@@ -27,7 +27,7 @@ function generateEnum(ctx, fullName, enumDesc, sourceInfo) {
         if (valueDesc.number === options.unrecognizedEnumValue) {
             unrecognizedEnum = { present: true, name: memberName };
         }
-        (0, utils_1.maybeAddComment)(info, chunks, (_a = valueDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated, `${memberName} - `);
+        (0, utils_1.maybeAddComment)(options, 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 && !unrecognizedEnum.present) {

package/build/generate-generic-service-definition.js

@@ -13,7 +13,7 @@ const utils_1 = require("./utils");
 function generateGenericServiceDefinition(ctx, fileDesc, sourceInfo, serviceDesc) {
     var _a, _b, _c;
     const chunks = [];
-    (0, utils_1.maybeAddComment)(sourceInfo, chunks, (_a = serviceDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
+    (0, utils_1.maybeAddComment)(ctx.options, sourceInfo, chunks, (_a = serviceDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
     // Service definition type
     const name = (0, ts_poet_1.def)(`${serviceDesc.name}Definition`);
     chunks.push((0, ts_poet_1.code) `
@@ -31,7 +31,7 @@ function generateGenericServiceDefinition(ctx, fileDesc, sourceInfo, serviceDesc
   `);
     for (const [index, methodDesc] of serviceDesc.method.entries()) {
         const info = sourceInfo.lookup(sourceInfo_1.Fields.service.method, index);
-        (0, utils_1.maybeAddComment)(info, chunks, (_c = methodDesc.options) === null || _c === void 0 ? void 0 : _c.deprecated);
+        (0, utils_1.maybeAddComment)(ctx.options, info, chunks, (_c = methodDesc.options) === null || _c === void 0 ? void 0 : _c.deprecated);
         chunks.push((0, ts_poet_1.code) `
       ${(0, case_1.uncapitalize)(methodDesc.name)}: ${generateMethodDefinition(ctx, methodDesc)},
     `);

package/build/generate-grpc-js.js

@@ -41,7 +41,7 @@ exports.generateGrpcJsService = generateGrpcJsService;
 function generateServiceDefinition(ctx, fileDesc, sourceInfo, serviceDesc) {
     var _a, _b;
     const chunks = [];
-    (0, utils_1.maybeAddComment)(sourceInfo, chunks, (_a = serviceDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
+    (0, utils_1.maybeAddComment)(ctx.options, sourceInfo, chunks, (_a = serviceDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
     // Service definition type
     const name = (0, ts_poet_1.def)(`${serviceDesc.name}Service`);
     chunks.push((0, ts_poet_1.code) `
@@ -56,7 +56,7 @@ function generateServiceDefinition(ctx, fileDesc, sourceInfo, serviceDesc) {
         const inputType = (0, types_1.messageToTypeName)(ctx, methodDesc.inputType);
         const outputType = (0, types_1.messageToTypeName)(ctx, methodDesc.outputType);
         const info = sourceInfo.lookup(sourceInfo_1.Fields.service.method, index);
-        (0, utils_1.maybeAddComment)(info, chunks, (_b = methodDesc.options) === null || _b === void 0 ? void 0 : _b.deprecated);
+        (0, utils_1.maybeAddComment)(ctx.options, info, chunks, (_b = methodDesc.options) === null || _b === void 0 ? void 0 : _b.deprecated);
         const inputEncoder = (0, encode_1.generateEncoder)(ctx, methodDesc.inputType);
         const outputEncoder = (0, encode_1.generateEncoder)(ctx, methodDesc.outputType);
         const inputDecoder = (0, encode_1.generateDecoder)(ctx, methodDesc.inputType);
@@ -87,7 +87,7 @@ function generateServerStub(ctx, sourceInfo, serviceDesc) {
         const inputType = (0, types_1.messageToTypeName)(ctx, methodDesc.inputType);
         const outputType = (0, types_1.messageToTypeName)(ctx, methodDesc.outputType);
         const info = sourceInfo.lookup(sourceInfo_1.Fields.service.method, index);
-        (0, utils_1.maybeAddComment)(info, chunks, (_a = methodDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
+        (0, utils_1.maybeAddComment)(ctx.options, info, chunks, (_a = methodDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
         const callType = methodDesc.clientStreaming
             ? methodDesc.serverStreaming
                 ? handleBidiStreamingCall
@@ -111,7 +111,7 @@ function generateClientStub(ctx, sourceInfo, serviceDesc) {
         const inputType = (0, types_1.messageToTypeName)(ctx, methodDesc.inputType);
         const outputType = (0, types_1.messageToTypeName)(ctx, methodDesc.outputType);
         const info = sourceInfo.lookup(sourceInfo_1.Fields.service.method, index);
-        (0, utils_1.maybeAddComment)(info, chunks, (_a = methodDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
+        (0, utils_1.maybeAddComment)(ctx.options, info, chunks, (_a = methodDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
         const responseCallback = (0, ts_poet_1.code) `(error: ${ServiceError} | null, response: ${outputType}) => void`;
         if (methodDesc.clientStreaming) {
             if (methodDesc.serverStreaming) {

package/build/generate-nestjs.js

@@ -11,7 +11,7 @@ function generateNestjsServiceController(ctx, fileDesc, sourceInfo, serviceDesc)
     const { options } = ctx;
     const chunks = [];
     const Metadata = (0, ts_poet_1.imp)("Metadata@@grpc/grpc-js");
-    (0, utils_1.maybeAddComment)(sourceInfo, chunks, (_a = serviceDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
+    (0, utils_1.maybeAddComment)(options, sourceInfo, chunks, (_a = serviceDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
     const t = options.context ? `<${main_1.contextTypeVar}>` : "";
     chunks.push((0, ts_poet_1.code) `
     export interface ${serviceDesc.name}Controller${t} {
@@ -20,7 +20,7 @@ function generateNestjsServiceController(ctx, fileDesc, sourceInfo, serviceDesc)
         var _a;
         (0, utils_1.assertInstanceOf)(methodDesc, utils_1.FormattedMethodDescriptor);
         const info = sourceInfo.lookup(sourceInfo_1.Fields.service.method, index);
-        (0, utils_1.maybeAddComment)(info, chunks, (_a = serviceDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
+        (0, utils_1.maybeAddComment)(options, info, chunks, (_a = serviceDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
         const params = [];
         if (options.context) {
             params.push((0, ts_poet_1.code) `ctx: Context`);
@@ -74,7 +74,7 @@ function generateNestjsServiceClient(ctx, fileDesc, sourceInfo, serviceDesc) {
     const { options } = ctx;
     const chunks = [];
     const Metadata = (0, ts_poet_1.imp)("Metadata@@grpc/grpc-js");
-    (0, utils_1.maybeAddComment)(sourceInfo, chunks);
+    (0, utils_1.maybeAddComment)(options, sourceInfo, chunks);
     const t = options.context ? `<${main_1.contextTypeVar}>` : ``;
     chunks.push((0, ts_poet_1.code) `
     export interface ${serviceDesc.name}Client${t} {
@@ -98,7 +98,7 @@ function generateNestjsServiceClient(ctx, fileDesc, sourceInfo, serviceDesc) {
         // Return observable since nestjs client always returns an Observable
         const returns = (0, types_1.responseObservable)(ctx, methodDesc);
         const info = sourceInfo.lookup(sourceInfo_1.Fields.service.method, index);
-        (0, utils_1.maybeAddComment)(info, chunks, (_a = methodDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
+        (0, utils_1.maybeAddComment)(options, info, chunks, (_a = methodDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
         chunks.push((0, ts_poet_1.code) `
       ${methodDesc.formattedName}(
         ${(0, ts_poet_1.joinCode)(params, { on: "," })}

package/build/generate-nice-grpc.js

@@ -32,7 +32,7 @@ function generateServerStub(ctx, sourceInfo, serviceDesc) {
         }
         const ServerStreamingMethodResult = ctx.utils.NiceGrpcServerStreamingMethodResult;
         const info = sourceInfo.lookup(sourceInfo_1.Fields.service.method, index);
-        (0, utils_1.maybeAddComment)(info, chunks, (_a = methodDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
+        (0, utils_1.maybeAddComment)(ctx.options, info, chunks, (_a = methodDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
         if (methodDesc.clientStreaming) {
             if (methodDesc.serverStreaming) {
                 // bidi streaming
@@ -89,7 +89,7 @@ function generateClientStub(ctx, sourceInfo, serviceDesc) {
         }
         const outputType = (0, types_1.messageToTypeName)(ctx, methodDesc.outputType, { keepValueType: true });
         const info = sourceInfo.lookup(sourceInfo_1.Fields.service.method, index);
-        (0, utils_1.maybeAddComment)(info, chunks, (_a = methodDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
+        (0, utils_1.maybeAddComment)(ctx.options, info, chunks, (_a = methodDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
         if (methodDesc.clientStreaming) {
             if (methodDesc.serverStreaming) {
                 // bidi streaming

package/build/generate-services.js

@@ -20,14 +20,14 @@ function generateService(ctx, fileDesc, sourceInfo, serviceDesc) {
     var _a;
     const { options } = ctx;
     const chunks = [];
-    (0, utils_1.maybeAddComment)(sourceInfo, chunks, (_a = serviceDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
+    (0, utils_1.maybeAddComment)(options, sourceInfo, chunks, (_a = serviceDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
     const maybeTypeVar = options.context ? `<${main_1.contextTypeVar}>` : "";
     chunks.push((0, ts_poet_1.code) `export interface ${(0, ts_poet_1.def)(serviceDesc.name)}${maybeTypeVar} {`);
     serviceDesc.method.forEach((methodDesc, index) => {
         var _a;
         (0, utils_1.assertInstanceOf)(methodDesc, utils_1.FormattedMethodDescriptor);
         const info = sourceInfo.lookup(sourceInfo_1.Fields.service.method, index);
-        (0, utils_1.maybeAddComment)(info, chunks, (_a = methodDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
+        (0, utils_1.maybeAddComment)(options, info, chunks, (_a = methodDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
         const params = [];
         if (options.context) {
             params.push((0, ts_poet_1.code) `ctx: Context`);

package/build/main.js

@@ -52,7 +52,7 @@ function generateFile(ctx, fileDesc) {
     // Syntax, unlike most fields, is not repeated and thus does not use an index
     const sourceInfo = sourceInfo_1.default.fromDescriptor(fileDesc);
     const headerComment = sourceInfo.lookup(sourceInfo_1.Fields.file.syntax, undefined);
-    (0, utils_1.maybeAddComment)(headerComment, chunks, (_a = fileDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
+    (0, utils_1.maybeAddComment)(options, headerComment, chunks, (_a = fileDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
     // Apply formatting to methods here, so they propagate globally
     for (let svc of fileDesc.service) {
         for (let i = 0; i < svc.method.length; i++) {
@@ -249,6 +249,14 @@ function generateFile(ctx, fileDesc) {
     if (options.outputSchema) {
         chunks.push(...(0, schema_1.generateSchema)(ctx, fileDesc, sourceInfo));
     }
+    // https://www.typescriptlang.org/docs/handbook/2/modules.html:
+    // > In TypeScript, just as in ECMAScript 2015, any file containing a top-level import or export is considered a module.
+    // > Conversely, a file without any top-level import or export declarations is treated as a script whose contents are available in the global scope (and therefore to modules as well).
+    //
+    // Thus, to mark an empty file a module, we need to add `export {}` to it.
+    if (options.esModuleInterop && chunks.length === 0) {
+        chunks.push((0, ts_poet_1.code) `export {};`);
+    }
     chunks.push(...Object.values(utils).map((v) => {
         if (v instanceof ConditionalOutput_1.ConditionalOutput) {
             return (0, ts_poet_1.code) `${v.ifUsed}`;
@@ -624,7 +632,7 @@ function generateInterfaceDeclaration(ctx, fullName, messageDesc, sourceInfo, fu
     var _a;
     const { options } = ctx;
     const chunks = [];
-    (0, utils_1.maybeAddComment)(sourceInfo, chunks, (_a = messageDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
+    (0, utils_1.maybeAddComment)(options, sourceInfo, chunks, (_a = messageDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
     // interface name should be defined to avoid import collisions
     chunks.push((0, ts_poet_1.code) `export interface ${(0, ts_poet_1.def)(fullName)} {`);
     if ((0, options_1.addTypeToMessages)(options)) {
@@ -643,7 +651,7 @@ function generateInterfaceDeclaration(ctx, fullName, messageDesc, sourceInfo, fu
             return;
         }
         const info = sourceInfo.lookup(sourceInfo_1.Fields.message.field, index);
-        (0, utils_1.maybeAddComment)(info, chunks, (_a = fieldDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
+        (0, utils_1.maybeAddComment)(options, info, chunks, (_a = fieldDesc.options) === null || _a === void 0 ? void 0 : _a.deprecated);
         const fieldKey = (0, utils_1.safeAccessor)((0, utils_1.getFieldName)(fieldDesc, options));
         const isOptional = (0, types_1.isOptionalProperty)(fieldDesc, messageDesc.options, options);
         const type = (0, types_1.toTypeName)(ctx, messageDesc, fieldDesc, isOptional);
@@ -672,14 +680,14 @@ function generateOneofProperty(ctx, messageDesc, oneofIndex, sourceInfo) {
     // that ability. For now just concatenate all comments into one big one.
     let comments: Array<string> = [];
     const info = sourceInfo.lookup(Fields.message.oneof_decl, oneofIndex);
-    maybeAddComment(info, (text) => comments.push(text));
+    maybeAddComment(options, info, (text) => comments.push(text));
     messageDesc.field.forEach((field, index) => {
       if (!isWithinOneOf(field) || field.oneofIndex !== oneofIndex) {
         return;
       }
       const info = sourceInfo.lookup(Fields.message.field, index);
       const name = maybeSnakeToCamel(field.name, options);
-      maybeAddComment(info, (text) => comments.push(name + '\n' + text));
+      maybeAddComment(options, info, (text) => comments.push(name + '\n' + text));
     });
     if (comments.length) {
       prop = prop.addJavadoc(comments.join('\n'));
@@ -1170,7 +1178,7 @@ function generateEncode(ctx, fullName, messageDesc) {
                 for (const v of ${messageProperty}) {
                   if (BigInt.asUintN(64, v) !== v) {
                     throw new ${utils.globalThis}.Error('a value provided in array field ${fieldName} of type ${fieldType} is too large');
-                  }                
+                  }
                   writer.${(0, types_1.toReaderCall)(field)}(${rhs("v")});
                 }
                 writer.ldelim();
@@ -1921,14 +1929,14 @@ function generateFromPartial(ctx, fullName, messageDesc) {
         chunks.push((0, ts_poet_1.code) `
       create<I extends ${utils.Exact}<${utils.DeepPartial}<${fullName}>, I>>(base?: I): ${fullName} {
         return ${fullName}.fromPartial(base ?? ({} as any));
-      },  
+      },
     `);
     }
     else {
         chunks.push((0, ts_poet_1.code) `
       create(base?: ${utils.DeepPartial}<${fullName}>): ${fullName} {
         return ${fullName}.fromPartial(base ?? {});
-      },  
+      },
     `);
     }
     // create the fromPartial function declaration

package/build/options.js

@@ -97,6 +97,7 @@ function defaultOptions() {
         rpcBeforeRequest: false,
         rpcAfterResponse: false,
         rpcErrorHandler: false,
+        comments: true,
     };
 }
 exports.defaultOptions = defaultOptions;

package/build/utils.js

@@ -79,7 +79,10 @@ exports.upperFirst = upperFirst;
 // Since we don't know what form the comment originally took, it may contain closing block comments.
 const CloseComment = /\*\//g;
 /** Removes potentially harmful characters from comments and pushes it into chunks. */
-function maybeAddComment(desc, chunks, deprecated, prefix = "") {
+function maybeAddComment(options, desc, chunks, deprecated, prefix = "") {
+    if (!options.comments) {
+        return;
+    }
     let lines = [];
     if (desc.leadingComments || desc.trailingComments) {
         let content = (desc.leadingComments || desc.trailingComments || "").replace(CloseComment, "* /").trim();

package/package.json

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