@bufbuild/protoc-gen-es 1.5.0 → 1.6.0

package/README.md

@@ -98,12 +98,25 @@ By default, [protoc-gen-es](https://www.npmjs.com/package/@bufbuild/protoc-gen-e
 uses a `.js` file extensions in import paths, even in TypeScript files.
 
 This is unintuitive, but necessary for [ECMAScript modules in Node.js](https://www.typescriptlang.org/docs/handbook/esm-node.html).
-Unfortunately, not all bundlers and tools have caught up yet, and Deno 
-requires `.ts`. With this plugin option, you can replace `.js` extensions 
+Unfortunately, not all bundlers and tools have caught up yet, and Deno
+requires `.ts`. With this plugin option, you can replace `.js` extensions
 in import paths with the given value. For example, set
 
-- `import_extension=none` to remove the `.js` extension
-- `import_extension=.ts` to replace the `.js` extension with `.ts`
+- `import_extension=none` to remove the `.js` extension.
+- `import_extension=.ts` to replace the `.js` extension with `.ts`.
+
+### `js_import_style`
+
+By default, [protoc-gen-es](https://www.npmjs.com/package/@bufbuild/protoc-gen-es)
+(and all other plugins based on [@bufbuild/protoplugin](https://www.npmjs.com/package/@bufbuild/protoplugin))
+generate ECMAScript `import` and `export` statements. For use cases where 
+CommonJS is difficult to avoid, this option can be used to generate CommonJS 
+`require()` calls.
+
+Possible values:
+- `js_import_style=module` generate ECMAScript `import` / `export` statements - 
+  the default behavior.
+- `js_import_style=legacy_commonjs` generate CommonJS `require()` calls.
 
 
 ### `keep_empty_files=true`

package/dist/cjs/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@bufbuild/protoc-gen-es",
-    "version": "1.5.0",
+    "version": "1.6.0",
     "description": "Protocol Buffers code generator for ECMAScript",
     "license": "Apache-2.0",
     "repository": {
@@ -20,11 +20,11 @@
     },
     "preferUnplugged": true,
     "dependencies": {
-        "@bufbuild/protobuf": "^1.5.0",
-        "@bufbuild/protoplugin": "1.5.0"
+        "@bufbuild/protobuf": "^1.6.0",
+        "@bufbuild/protoplugin": "1.6.0"
     },
     "peerDependencies": {
-        "@bufbuild/protobuf": "1.5.0"
+        "@bufbuild/protobuf": "1.6.0"
     },
     "peerDependenciesMeta": {
         "@bufbuild/protobuf": {

package/dist/cjs/src/declaration.js

@@ -32,13 +32,13 @@ function generateDts(schema) {
 exports.generateDts = generateDts;
 // prettier-ignore
 function generateEnum(schema, f, enumeration) {
-    f.print((0, ecmascript_1.makeJsDoc)(enumeration));
+    f.print(f.jsDoc(enumeration));
     f.print("export declare enum ", enumeration, " {");
     for (const value of enumeration.values) {
         if (enumeration.values.indexOf(value) > 0) {
             f.print();
         }
-        f.print((0, ecmascript_1.makeJsDoc)(value, "  "));
+        f.print(f.jsDoc(value, "  "));
         f.print("  ", (0, ecmascript_1.localName)(value), " = ", value.number, ",");
     }
     f.print("}");
@@ -48,7 +48,7 @@ function generateEnum(schema, f, enumeration) {
 function generateMessage(schema, f, message) {
     const protoN = (0, editions_js_1.getNonEditionRuntime)(schema, message.file);
     const { PartialMessage, FieldList, Message, PlainMessage, BinaryReadOptions, JsonReadOptions, JsonValue } = schema.runtime;
-    f.print((0, ecmascript_1.makeJsDoc)(message));
+    f.print(f.jsDoc(message));
     f.print("export declare class ", message, " extends ", Message, "<", message, "> {");
     for (const member of message.members) {
         switch (member.kind) {
@@ -65,7 +65,7 @@ function generateMessage(schema, f, message) {
     f.print();
     generateWktMethods(schema, f, message);
     f.print("  static readonly runtime: typeof ", protoN, ";");
-    f.print('  static readonly typeName = ', (0, ecmascript_1.literalString)(message.typeName), ';');
+    f.print('  static readonly typeName = ', f.string(message.typeName), ';');
     f.print("  static readonly fields: ", FieldList, ";");
     // In case we start supporting options, we have to surface them here
     //f.print("  static readonly options: { readonly [extensionName: string]: ", rt.JsonValue, " } = {};")
@@ -90,13 +90,13 @@ function generateMessage(schema, f, message) {
 }
 // prettier-ignore
 function generateOneof(schema, f, oneof) {
-    f.print((0, ecmascript_1.makeJsDoc)(oneof, "  "));
+    f.print(f.jsDoc(oneof, "  "));
     f.print("  ", (0, ecmascript_1.localName)(oneof), ": {");
     for (const field of oneof.fields) {
         if (oneof.fields.indexOf(field) > 0) {
             f.print(`  } | {`);
         }
-        f.print((0, ecmascript_1.makeJsDoc)(field, "    "));
+        f.print(f.jsDoc(field, "    "));
         const { typing } = (0, ecmascript_1.getFieldTyping)(field, f);
         f.print(`    value: `, typing, `;`);
         f.print(`    case: "`, (0, ecmascript_1.localName)(field), `";`);
@@ -104,7 +104,7 @@ function generateOneof(schema, f, oneof) {
     f.print(`  } | { case: undefined; value?: undefined };`);
 }
 function generateField(schema, f, field) {
-    f.print((0, ecmascript_1.makeJsDoc)(field, "  "));
+    f.print(f.jsDoc(field, "  "));
     const e = [];
     e.push("  ", (0, ecmascript_1.localName)(field));
     const { typing, optional } = (0, ecmascript_1.getFieldTyping)(field, f);

package/dist/cjs/src/javascript.js

@@ -34,19 +34,19 @@ exports.generateJs = generateJs;
 // prettier-ignore
 function generateEnum(schema, f, enumeration) {
     const protoN = (0, editions_js_1.getNonEditionRuntime)(schema, enumeration.file);
-    f.print((0, ecmascript_1.makeJsDoc)(enumeration));
-    f.print("export const ", enumeration, " = ", protoN, ".makeEnum(");
+    f.print(f.jsDoc(enumeration));
+    f.print(f.exportDecl("const", enumeration), " = ", protoN, ".makeEnum(");
     f.print(`  "`, enumeration.typeName, `",`);
     f.print(`  [`);
     if (enumeration.sharedPrefix === undefined) {
         for (const value of enumeration.values) {
-            f.print("    {no: ", value.number, ", name: ", (0, ecmascript_1.literalString)(value.name), "},");
+            f.print("    {no: ", value.number, ", name: ", f.string(value.name), "},");
         }
     }
     else {
         for (const value of enumeration.values) {
             const localName = value.name.substring(enumeration.sharedPrefix.length);
-            f.print("    {no: ", value.number, ", name: ", (0, ecmascript_1.literalString)(value.name), ", localName: ", (0, ecmascript_1.literalString)(localName), "},");
+            f.print("    {no: ", value.number, ", name: ", f.string(value.name), ", localName: ", f.string(localName), "},");
         }
     }
     f.print(`  ],`);
@@ -56,9 +56,9 @@ function generateEnum(schema, f, enumeration) {
 // prettier-ignore
 function generateMessage(schema, f, message) {
     const protoN = (0, editions_js_1.getNonEditionRuntime)(schema, message.file);
-    f.print((0, ecmascript_1.makeJsDoc)(message));
-    f.print("export const ", message, " = ", protoN, ".makeMessageType(");
-    f.print(`  `, (0, ecmascript_1.literalString)(message.typeName), `,`);
+    f.print(f.jsDoc(message));
+    f.print(f.exportDecl("const", message), " = ", protoN, ".makeMessageType(");
+    f.print(`  `, f.string(message.typeName), `,`);
     if (message.fields.length == 0) {
         f.print("  [],");
     }
@@ -74,7 +74,7 @@ function generateMessage(schema, f, message) {
             .makeMessageType(message.typeName, []).name;
     if (needsLocalName) {
         // local name is not inferrable from the type name, we need to provide it
-        f.print(`  {localName: `, (0, ecmascript_1.literalString)((0, ecmascript_1.localName)(message)), `},`);
+        f.print(`  {localName: `, f.string((0, ecmascript_1.localName)(message)), `},`);
     }
     f.print(");");
     f.print();
@@ -119,6 +119,9 @@ function generateFieldInfo(schema, f, field) {
             break;
         case "message":
             e.push(`kind: "message", T: `, field.message, `, `);
+            if (field.proto.type === protobuf_1.FieldDescriptorProto_Type.GROUP) {
+                e.push(`delimited: true, `);
+            }
             break;
         case "enum":
             e.push(`kind: "enum", T: `, protoN, `.getEnumType(`, field.enum, `), `);

package/dist/cjs/src/typescript.js

@@ -35,13 +35,13 @@ exports.generateTs = generateTs;
 // prettier-ignore
 function generateEnum(schema, f, enumeration) {
     const protoN = (0, editions_js_1.getNonEditionRuntime)(schema, enumeration.file);
-    f.print((0, ecmascript_1.makeJsDoc)(enumeration));
-    f.print("export enum ", enumeration, " {");
+    f.print(f.jsDoc(enumeration));
+    f.print(f.exportDecl("enum", enumeration), " {");
     for (const value of enumeration.values) {
         if (enumeration.values.indexOf(value) > 0) {
             f.print();
         }
-        f.print((0, ecmascript_1.makeJsDoc)(value, "  "));
+        f.print(f.jsDoc(value, "  "));
         f.print("  ", (0, ecmascript_1.localName)(value), " = ", value.number, ",");
     }
     f.print("}");
@@ -57,8 +57,8 @@ function generateEnum(schema, f, enumeration) {
 function generateMessage(schema, f, message) {
     const protoN = (0, editions_js_1.getNonEditionRuntime)(schema, message.file);
     const { PartialMessage, FieldList, Message, PlainMessage, BinaryReadOptions, JsonReadOptions, JsonValue } = schema.runtime;
-    f.print((0, ecmascript_1.makeJsDoc)(message));
-    f.print("export class ", message, " extends ", Message, "<", message, "> {");
+    f.print(f.jsDoc(message));
+    f.print(f.exportDecl("class", message), " extends ", Message, "<", message, "> {");
     for (const member of message.members) {
         switch (member.kind) {
             case "oneof":
@@ -77,7 +77,7 @@ function generateMessage(schema, f, message) {
     f.print();
     generateWktMethods(schema, f, message);
     f.print("  static readonly runtime: typeof ", protoN, " = ", protoN, ";");
-    f.print('  static readonly typeName = ', (0, ecmascript_1.literalString)(message.typeName), ';');
+    f.print('  static readonly typeName = ', f.string(message.typeName), ';');
     f.print("  static readonly fields: ", FieldList, " = ", protoN, ".util.newFieldList(() => [");
     for (const field of message.fields) {
         (0, javascript_js_1.generateFieldInfo)(schema, f, field);
@@ -114,13 +114,13 @@ function generateMessage(schema, f, message) {
 }
 // prettier-ignore
 function generateOneof(schema, f, oneof) {
-    f.print((0, ecmascript_1.makeJsDoc)(oneof, "  "));
+    f.print(f.jsDoc(oneof, "  "));
     f.print("  ", (0, ecmascript_1.localName)(oneof), ": {");
     for (const field of oneof.fields) {
         if (oneof.fields.indexOf(field) > 0) {
             f.print(`  } | {`);
         }
-        f.print((0, ecmascript_1.makeJsDoc)(field, "    "));
+        f.print(f.jsDoc(field, "    "));
         const { typing } = (0, ecmascript_1.getFieldTyping)(field, f);
         f.print(`    value: `, typing, `;`);
         f.print(`    case: "`, (0, ecmascript_1.localName)(field), `";`);
@@ -128,7 +128,7 @@ function generateOneof(schema, f, oneof) {
     f.print(`  } | { case: undefined; value?: undefined } = { case: undefined };`);
 }
 function generateField(schema, f, field) {
-    f.print((0, ecmascript_1.makeJsDoc)(field, "  "));
+    f.print(f.jsDoc(field, "  "));
     const e = [];
     e.push("  ", (0, ecmascript_1.localName)(field));
     const { defaultValue, typingInferrable } = (0, ecmascript_1.getFieldIntrinsicDefaultValue)(field);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bufbuild/protoc-gen-es",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "Protocol Buffers code generator for ECMAScript",
   "license": "Apache-2.0",
   "repository": {
@@ -20,11 +20,11 @@
   },
   "preferUnplugged": true,
   "dependencies": {
-    "@bufbuild/protobuf": "^1.5.0",
-    "@bufbuild/protoplugin": "1.5.0"
+    "@bufbuild/protobuf": "^1.6.0",
+    "@bufbuild/protoplugin": "1.6.0"
   },
   "peerDependencies": {
-    "@bufbuild/protobuf": "1.5.0"
+    "@bufbuild/protobuf": "1.6.0"
   },
   "peerDependenciesMeta": {
     "@bufbuild/protobuf": {

package/src/declaration.ts

@@ -25,9 +25,7 @@ import type {
 } from "@bufbuild/protoplugin/ecmascript";
 import {
   getFieldTyping,
-  literalString,
   localName,
-  makeJsDoc,
   reifyWkt,
 } from "@bufbuild/protoplugin/ecmascript";
 import { getNonEditionRuntime } from "./editions.js";
@@ -48,13 +46,13 @@ export function generateDts(schema: Schema) {
 
 // prettier-ignore
 function generateEnum(schema: Schema, f: GeneratedFile, enumeration: DescEnum) {
-  f.print(makeJsDoc(enumeration));
+  f.print(f.jsDoc(enumeration));
   f.print("export declare enum ", enumeration, " {");
   for (const value of enumeration.values) {
     if (enumeration.values.indexOf(value) > 0) {
       f.print();
     }
-    f.print(makeJsDoc(value, "  "));
+    f.print(f.jsDoc(value, "  "));
     f.print("  ", localName(value), " = ", value.number, ",");
   }
   f.print("}");
@@ -73,7 +71,7 @@ function generateMessage(schema: Schema, f: GeneratedFile, message: DescMessage)
     JsonReadOptions,
     JsonValue
   } = schema.runtime;
-  f.print(makeJsDoc(message));
+  f.print(f.jsDoc(message));
   f.print("export declare class ", message, " extends ", Message, "<", message, "> {");
   for (const member of message.members) {
     switch (member.kind) {
@@ -90,7 +88,7 @@ function generateMessage(schema: Schema, f: GeneratedFile, message: DescMessage)
   f.print();
   generateWktMethods(schema, f, message);
   f.print("  static readonly runtime: typeof ", protoN, ";");
-  f.print('  static readonly typeName = ', literalString(message.typeName), ';');
+  f.print('  static readonly typeName = ', f.string(message.typeName), ';');
   f.print("  static readonly fields: ", FieldList, ";");
   // In case we start supporting options, we have to surface them here
   //f.print("  static readonly options: { readonly [extensionName: string]: ", rt.JsonValue, " } = {};")
@@ -116,13 +114,13 @@ function generateMessage(schema: Schema, f: GeneratedFile, message: DescMessage)
 
 // prettier-ignore
 function generateOneof(schema: Schema, f: GeneratedFile, oneof: DescOneof) {
-  f.print(makeJsDoc(oneof, "  "));
+  f.print(f.jsDoc(oneof, "  "));
   f.print("  ", localName(oneof), ": {");
   for (const field of oneof.fields) {
     if (oneof.fields.indexOf(field) > 0) {
       f.print(`  } | {`);
     }
-    f.print(makeJsDoc(field, "    "));
+    f.print(f.jsDoc(field, "    "));
     const { typing } = getFieldTyping(field, f);
     f.print(`    value: `, typing, `;`);
     f.print(`    case: "`, localName(field), `";`);
@@ -131,7 +129,7 @@ function generateOneof(schema: Schema, f: GeneratedFile, oneof: DescOneof) {
 }
 
 function generateField(schema: Schema, f: GeneratedFile, field: DescField) {
-  f.print(makeJsDoc(field, "  "));
+  f.print(f.jsDoc(field, "  "));
   const e: Printable = [];
   e.push("  ", localName(field));
   const { typing, optional } = getFieldTyping(field, f);

package/src/javascript.ts

@@ -13,7 +13,13 @@
 // limitations under the License.
 
 import type { DescEnum, DescField, DescMessage } from "@bufbuild/protobuf";
-import { LongType, proto2, proto3, ScalarType } from "@bufbuild/protobuf";
+import {
+  FieldDescriptorProto_Type,
+  LongType,
+  proto2,
+  proto3,
+  ScalarType,
+} from "@bufbuild/protobuf";
 import type {
   GeneratedFile,
   Printable,
@@ -21,9 +27,7 @@ import type {
 } from "@bufbuild/protoplugin/ecmascript";
 import {
   getFieldExplicitDefaultValue,
-  literalString,
   localName,
-  makeJsDoc,
   reifyWkt,
 } from "@bufbuild/protoplugin/ecmascript";
 import { getNonEditionRuntime } from "./editions.js";
@@ -45,18 +49,18 @@ export function generateJs(schema: Schema) {
 // prettier-ignore
 function generateEnum(schema: Schema, f: GeneratedFile, enumeration: DescEnum) {
   const protoN = getNonEditionRuntime(schema, enumeration.file);
-  f.print(makeJsDoc(enumeration));
-  f.print("export const ", enumeration, " = ", protoN, ".makeEnum(")
+  f.print(f.jsDoc(enumeration));
+  f.print(f.exportDecl("const", enumeration), " = ", protoN, ".makeEnum(")
   f.print(`  "`, enumeration.typeName, `",`)
   f.print(`  [`)
   if (enumeration.sharedPrefix === undefined) {
     for (const value of enumeration.values) {
-      f.print("    {no: ", value.number, ", name: ", literalString(value.name), "},")
+      f.print("    {no: ", value.number, ", name: ", f.string(value.name), "},")
     }
   } else {
     for (const value of enumeration.values) {
       const localName = value.name.substring(enumeration.sharedPrefix.length);
-      f.print("    {no: ", value.number, ", name: ", literalString(value.name), ", localName: ", literalString(localName), "},")
+      f.print("    {no: ", value.number, ", name: ", f.string(value.name), ", localName: ", f.string(localName), "},")
     }
   }
   f.print(`  ],`)
@@ -67,9 +71,9 @@ function generateEnum(schema: Schema, f: GeneratedFile, enumeration: DescEnum) {
 // prettier-ignore
 function generateMessage(schema: Schema, f: GeneratedFile, message: DescMessage) {
   const protoN = getNonEditionRuntime(schema, message.file);
-  f.print(makeJsDoc(message));
-  f.print("export const ", message, " = ", protoN, ".makeMessageType(")
-  f.print(`  `, literalString(message.typeName), `,`)
+  f.print(f.jsDoc(message));
+  f.print(f.exportDecl("const", message), " = ", protoN, ".makeMessageType(")
+  f.print(`  `, f.string(message.typeName), `,`)
   if (message.fields.length == 0) {
     f.print("  [],")
   } else {
@@ -84,7 +88,7 @@ function generateMessage(schema: Schema, f: GeneratedFile, message: DescMessage)
       .makeMessageType(message.typeName, []).name;
   if (needsLocalName) {
     // local name is not inferrable from the type name, we need to provide it
-    f.print(`  {localName: `, literalString(localName(message)), `},`)
+    f.print(`  {localName: `, f.string(localName(message)), `},`)
   }
   f.print(");")
   f.print()
@@ -130,6 +134,9 @@ export function generateFieldInfo(schema: Schema, f: GeneratedFile, field: DescF
       break;
     case "message":
       e.push(`kind: "message", T: `, field.message, `, `);
+      if (field.proto.type === FieldDescriptorProto_Type.GROUP) {
+        e.push(`delimited: true, `);
+      }
       break;
     case "enum":
       e.push(`kind: "enum", T: `, protoN, `.getEnumType(`, field.enum, `), `);

package/src/typescript.ts

@@ -27,9 +27,7 @@ import type {
 import {
   getFieldIntrinsicDefaultValue,
   getFieldTyping,
-  literalString,
   localName,
-  makeJsDoc,
   reifyWkt,
 } from "@bufbuild/protoplugin/ecmascript";
 import { generateFieldInfo } from "./javascript.js";
@@ -52,13 +50,13 @@ export function generateTs(schema: Schema) {
 // prettier-ignore
 function generateEnum(schema: Schema, f: GeneratedFile, enumeration: DescEnum) {
   const protoN = getNonEditionRuntime(schema, enumeration.file);
-  f.print(makeJsDoc(enumeration));
-  f.print("export enum ", enumeration, " {");
+  f.print(f.jsDoc(enumeration));
+  f.print(f.exportDecl("enum", enumeration), " {");
   for (const value of enumeration.values) {
     if (enumeration.values.indexOf(value) > 0) {
       f.print();
     }
-    f.print(makeJsDoc(value, "  "));
+    f.print(f.jsDoc(value, "  "));
     f.print("  ", localName(value), " = ", value.number, ",");
   }
   f.print("}");
@@ -83,8 +81,8 @@ function generateMessage(schema: Schema, f: GeneratedFile, message: DescMessage)
     JsonReadOptions,
     JsonValue
   } = schema.runtime;
-  f.print(makeJsDoc(message));
-  f.print("export class ", message, " extends ", Message, "<", message, "> {");
+  f.print(f.jsDoc(message));
+  f.print(f.exportDecl("class", message), " extends ", Message, "<", message, "> {");
   for (const member of message.members) {
     switch (member.kind) {
       case "oneof":
@@ -103,7 +101,7 @@ function generateMessage(schema: Schema, f: GeneratedFile, message: DescMessage)
   f.print();
   generateWktMethods(schema, f, message);
   f.print("  static readonly runtime: typeof ", protoN, " = ", protoN, ";");
-  f.print('  static readonly typeName = ', literalString(message.typeName), ';');
+  f.print('  static readonly typeName = ', f.string(message.typeName), ';');
   f.print("  static readonly fields: ", FieldList, " = ", protoN, ".util.newFieldList(() => [");
   for (const field of message.fields) {
     generateFieldInfo(schema, f, field);
@@ -141,13 +139,13 @@ function generateMessage(schema: Schema, f: GeneratedFile, message: DescMessage)
 
 // prettier-ignore
 function generateOneof(schema: Schema, f: GeneratedFile, oneof: DescOneof) {
-  f.print(makeJsDoc(oneof, "  "));
+  f.print(f.jsDoc(oneof, "  "));
   f.print("  ", localName(oneof), ": {");
   for (const field of oneof.fields) {
     if (oneof.fields.indexOf(field) > 0) {
       f.print(`  } | {`);
     }
-    f.print(makeJsDoc(field, "    "));
+    f.print(f.jsDoc(field, "    "));
     const { typing } = getFieldTyping(field, f);
     f.print(`    value: `, typing, `;`);
     f.print(`    case: "`, localName(field), `";`);
@@ -156,7 +154,7 @@ function generateOneof(schema: Schema, f: GeneratedFile, oneof: DescOneof) {
 }
 
 function generateField(schema: Schema, f: GeneratedFile, field: DescField) {
-  f.print(makeJsDoc(field, "  "));
+  f.print(f.jsDoc(field, "  "));
   const e: Printable = [];
   e.push("  ", localName(field));
   const { defaultValue, typingInferrable } =