@bufbuild/protoc-gen-es 2.12.0 → 2.13.0

package/README.md

@@ -1,6 +1,6 @@
 # @bufbuild/protoc-gen-es
 
-The code generator plugin for Protocol Buffers for ECMAScript. Learn more about the project at [github.com/bufbuild/protobuf-es](https://github.com/bufbuild/protobuf-es).
+The code generator plugin for Protocol Buffers for ECMAScript. Learn more about the project at [protobufes.com](https://protobufes.com/).
 
 ## Installation
 
@@ -107,15 +107,19 @@ By default, [protoc-gen-es] inserts its version number at the top of each genera
 
 ### `json_types=true`
 
-Generates JSON types for every Protobuf message and enumeration. Calling `toJson()` automatically returns the JSON type if available. Learn more about [JSON types](https://github.com/bufbuild/protobuf-es/blob/main/MANUAL.md#json-types).
+Generates JSON types for every Protobuf message and enumeration. Calling `toJson()` automatically returns the JSON type if available. Learn more about [JSON types](https://protobufes.com/reference/json-types/).
 
 ### `valid_types` (experimental)
 
 Generates a Valid type for every Protobuf message. Possible values:
 
-- `valid_types=legacy_required`: Message fields with the `required` label, or the Edition feature `features.field_presence=LEGACY_REQUIRED`, are generated as non-optional properties. 
+- `valid_types=legacy_required`: Message fields with the `required` label, or the Edition feature `features.field_presence=LEGACY_REQUIRED`, are generated as non-optional properties.
 - `valid_types=protovalidate_required`: Message fields with protovalidate's [`required` rule](https://buf.build/docs/reference/protovalidate/rules/field_rules/#required)    rule are generated as non-optional properties.
 
 You can combine both options with `+`—for example, `valid_types=legacy_required+protovalidate_required`.
 
-Learn more about [Valid types](https://github.com/bufbuild/protobuf-es/blob/main/MANUAL.md#valid-types).
+Learn more about [Valid types](https://protobufes.com/reference/valid-types/).
+
+### `erasable_syntax=true` (experimental)
+
+Generates Protobuf enums as an object with `as const` for [running TypeScript natively in Node.js](https://nodejs.org/learn/typescript/run-natively), and for compatibility with the `tsconfig` option [erasableSyntaxOnly](https://www.typescriptlang.org/tsconfig/#erasableSyntaxOnly). See [Enums vs Objects](https://protobufes.com/reference/generated-code/#enums-vs-objects) for details.

package/dist/cjs/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@bufbuild/protoc-gen-es",
-    "version": "2.12.0",
+    "version": "2.13.0",
     "license": "Apache-2.0",
     "description": "Protocol Buffers code generator for ECMAScript",
     "keywords": [
@@ -10,6 +10,7 @@
         "ecmascript",
         "protoc-plugin"
     ],
+    "homepage": "https://protobufes.com/",
     "repository": {
         "type": "git",
         "url": "https://github.com/bufbuild/protobuf-es.git",
@@ -32,14 +33,14 @@
     },
     "preferUnplugged": true,
     "dependencies": {
-        "@bufbuild/protobuf": "2.12.0",
-        "@bufbuild/protoplugin": "2.12.0"
+        "@bufbuild/protobuf": "2.13.0",
+        "@bufbuild/protoplugin": "2.13.0"
     },
     "devDependencies": {
         "upstream-protobuf": "*"
     },
     "peerDependencies": {
-        "@bufbuild/protobuf": "2.12.0"
+        "@bufbuild/protobuf": "2.13.0"
     },
     "peerDependenciesMeta": {
         "@bufbuild/protobuf": {

package/dist/cjs/src/protoc-gen-es-plugin.js

@@ -35,6 +35,7 @@ function parseOptions(options) {
         legacyRequired: false,
         protovalidateRequired: false,
     };
+    let erasableSyntax = false;
     for (const { key, value } of options) {
         switch (key) {
             case "json_types":
@@ -57,18 +58,23 @@ function parseOptions(options) {
                     }
                 }
                 break;
+            case "erasable_syntax":
+                if (!["true", "1", "false", "0"].includes(value)) {
+                    throw "please provide true or false";
+                }
+                erasableSyntax = ["true", "1"].includes(value);
+                break;
             default:
                 throw new Error();
         }
     }
-    return { jsonTypes, validTypes };
+    return { jsonTypes, validTypes, erasableSyntax };
 }
 // This annotation informs bundlers that the succeeding function call is free of
 // side effects. This means the symbol can be removed from the module during
 // tree-shaking if it is unused.
 // See https://github.com/bufbuild/protobuf-es/pull/470
 const pure = "/*@__PURE__*/";
-// biome-ignore format: want this to read well
 function generateTs(schema) {
     for (const file of schema.files) {
         const f = schema.generateFile(file.name + "_pb.ts");
@@ -98,7 +104,12 @@ function generateTs(schema) {
                     break;
                 }
                 case "enum": {
-                    generateEnumShape(f, desc);
+                    if (schema.options.erasableSyntax) {
+                        generateObjEnum(f, desc, "ts");
+                    }
+                    else {
+                        generateEnumShape(f, desc);
+                    }
                     if (schema.options.jsonTypes) {
                         generateEnumJsonShape(f, desc, "ts");
                     }
@@ -144,7 +155,6 @@ function generateTs(schema) {
         }
     }
 }
-// biome-ignore format: want this to read well
 function generateJs(schema) {
     for (const file of schema.files) {
         const f = schema.generateFile(file.name + "_pb.js");
@@ -177,12 +187,12 @@ function generateJs(schema) {
                         f.print("  ", call, ";");
                         f.print();
                     }
-                    // declare TypeScript enum
+                    // generate enum
                     {
                         f.print(f.jsDoc(desc));
                         f.print(f.export("const", f.importShape(desc).name), " = ", pure);
-                        const { tsEnum } = f.runtime.codegen;
-                        const call = (0, util_js_1.functionCall)(tsEnum, [f.importSchema(desc)]);
+                        const enumFn = schema.options.erasableSyntax ? f.runtime.codegen.objEnum : f.runtime.codegen.tsEnum;
+                        const call = (0, util_js_1.functionCall)(enumFn, [f.importSchema(desc)]);
                         f.print("  ", call, ";");
                         f.print();
                     }
@@ -212,7 +222,6 @@ function generateJs(schema) {
         }
     }
 }
-// biome-ignore format: want this to read well
 function generateDts(schema) {
     for (const file of schema.files) {
         const f = schema.generateFile(file.name + "_pb.d.ts");
@@ -239,7 +248,12 @@ function generateDts(schema) {
                     break;
                 }
                 case "enum": {
-                    generateEnumShape(f, desc);
+                    if (schema.options.erasableSyntax) {
+                        generateObjEnum(f, desc, "dts");
+                    }
+                    else {
+                        generateEnumShape(f, desc);
+                    }
                     if (schema.options.jsonTypes) {
                         generateEnumJsonShape(f, desc, "dts");
                     }
@@ -304,7 +318,6 @@ function generateDescDoc(f, desc) {
         text: lines.join("\n"),
     });
 }
-// biome-ignore format: want this to read well
 function getFileDescCall(f, file, schema) {
     // Schema provides files with source retention options. Since we do not want to
     // embed source retention options in generated code, we use FileDescriptorProto
@@ -330,7 +343,6 @@ function getFileDescCall(f, file, schema) {
     }
     return (0, util_js_1.functionCall)(fileDesc, [f.string(info.base64())]);
 }
-// biome-ignore format: want this to read well
 function getServiceShapeExpr(f, service) {
     const p = ["{\n"];
     for (const method of service.methods) {
@@ -344,7 +356,6 @@ function getServiceShapeExpr(f, service) {
     p.push("}");
     return p;
 }
-// biome-ignore format: want this to read well
 function generateEnumShape(f, enumeration) {
     f.print(f.jsDoc(enumeration));
     f.print(f.export("enum", f.importShape(enumeration).name), " {");
@@ -358,7 +369,34 @@ function generateEnumShape(f, enumeration) {
     f.print("}");
     f.print();
 }
-// biome-ignore format: want this to read well
+function generateObjEnum(f, enumeration, target) {
+    const { name } = f.importShape(enumeration);
+    f.print(f.jsDoc(enumeration));
+    if (target == "ts") {
+        f.print(f.export("const", name), " = {");
+    }
+    else {
+        f.print(f.export("declare const", name), ": {");
+    }
+    for (const value of enumeration.values) {
+        if (enumeration.values.indexOf(value) > 0) {
+            f.print();
+        }
+        f.print(f.jsDoc(value, "  "));
+        f.print("  ", (target == "ts" ? "" : "readonly "), value.localName, ": ", value.number, ",");
+    }
+    f.print("}", (target == "ts" ? " as const" : ""), ";");
+    f.print();
+    generateObjEnumType(f, enumeration, target);
+}
+function generateObjEnumType(f, enumeration, target) {
+    const { name } = f.importShape(enumeration);
+    f.print(f.jsDoc(enumeration));
+    const declaration = target == "ts" ? "type" : "declare type";
+    const unknown = enumeration.open ? [" | ", f.runtime.UnknownEnum] : [];
+    f.print(f.export(declaration, name), " = (typeof ", name, ")[keyof typeof ", name, "]", unknown, ";");
+    f.print();
+}
 function generateEnumJsonShape(f, enumeration, target) {
     f.print(f.jsDoc(enumeration));
     const declaration = target == "ts" ? "type" : "declare type";
@@ -377,7 +415,6 @@ function generateEnumJsonShape(f, enumeration, target) {
     f.print(f.export(declaration, f.importJson(enumeration).name), " = ", values, ";");
     f.print();
 }
-// biome-ignore format: want this to read well
 function generateMessageShape(f, message, target) {
     const { Message } = f.runtime;
     const declaration = target == "ts" ? "type" : "declare type";
@@ -392,7 +429,6 @@ function generateMessageShape(f, message, target) {
     f.print("};");
     f.print();
 }
-// biome-ignore format: want this to read well
 function generateMessageValidShape(f, message, validTypes, target) {
     const declaration = target == "ts" ? "type" : "declare type";
     if (!(0, valid_types_js_1.messageNeedsCustomValidType)(message, validTypes)) {
@@ -412,7 +448,6 @@ function generateMessageValidShape(f, message, validTypes, target) {
     f.print("};");
     f.print();
 }
-// biome-ignore format: want this to read well
 function generateMessageShapeMember(f, member, validTypes) {
     switch (member.kind) {
         case "oneof":
@@ -447,7 +482,6 @@ function generateMessageShapeMember(f, member, validTypes) {
             break;
     }
 }
-// biome-ignore format: want this to read well
 function generateMessageJsonShape(f, message, target) {
     const exp = f.export(target == "ts" ? "type" : "declare type", f.importJson(message).name);
     f.print(f.jsDoc(message));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bufbuild/protoc-gen-es",
-  "version": "2.12.0",
+  "version": "2.13.0",
   "license": "Apache-2.0",
   "description": "Protocol Buffers code generator for ECMAScript",
   "keywords": [
@@ -10,6 +10,7 @@
     "ecmascript",
     "protoc-plugin"
   ],
+  "homepage": "https://protobufes.com/",
   "repository": {
     "type": "git",
     "url": "https://github.com/bufbuild/protobuf-es.git",
@@ -32,14 +33,14 @@
   },
   "preferUnplugged": true,
   "dependencies": {
-    "@bufbuild/protobuf": "2.12.0",
-    "@bufbuild/protoplugin": "2.12.0"
+    "@bufbuild/protobuf": "2.13.0",
+    "@bufbuild/protoplugin": "2.13.0"
   },
   "devDependencies": {
     "upstream-protobuf": "*"
   },
   "peerDependencies": {
-    "@bufbuild/protobuf": "2.12.0"
+    "@bufbuild/protobuf": "2.13.0"
   },
   "peerDependenciesMeta": {
     "@bufbuild/protobuf": {