@bufbuild/protoc-gen-es 2.0.0-alpha.1 → 2.0.0-alpha.3

package/README.md

@@ -91,19 +91,18 @@ By default, we generate JavaScript and TypeScript declaration files, which
 produces the smallest code size and is the most compatible with various
 bundler configurations. If you prefer to generate TypeScript, use `target=ts`.
 
-### `import_extension=.js`
+### `import_extension`
 
 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))
-uses a `.js` file extensions in import paths, even in TypeScript files.
+does not add a file extensions to import paths.
 
-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
+Some environments require an import extension. For example, using [ECMAScript modules in Node.js](https://www.typescriptlang.org/docs/handbook/esm-node.html) requires the `.js` extension, and Deno requires `.ts`. With this plugin option, you can add `.js`/`.ts` 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=.js` to add the `.js` extension.
+- `import_extension=.ts` to add the `.ts` extension.
+- `import_extension=none` to not add an extension. (Default)
 
 ### `js_import_style`
 

package/dist/cjs/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@bufbuild/protoc-gen-es",
-    "version": "2.0.0-alpha.1",
+    "version": "2.0.0-alpha.3",
     "description": "Protocol Buffers code generator for ECMAScript",
     "license": "Apache-2.0",
     "repository": {
@@ -20,15 +20,19 @@
     },
     "preferUnplugged": true,
     "dependencies": {
-        "@bufbuild/protobuf": "^2.0.0-alpha.1",
-        "@bufbuild/protoplugin": "2.0.0-alpha.1"
+        "@bufbuild/protobuf": "^2.0.0-alpha.3",
+        "@bufbuild/protoplugin": "2.0.0-alpha.3"
     },
     "peerDependencies": {
-        "@bufbuild/protobuf": "2.0.0-alpha.1"
+        "@bufbuild/protobuf": "2.0.0-alpha.3"
     },
     "peerDependenciesMeta": {
         "@bufbuild/protobuf": {
             "optional": true
         }
-    }
+    },
+    "files": [
+        "dist/**",
+        "bin/**"
+    ]
 }

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

@@ -38,8 +38,9 @@ function generateTs(schema) {
         f.preamble(file);
         const { GenDescFile } = f.runtime.codegen;
         const fileDesc = f.importDesc(file);
-        f.print(f.exportDecl("const", fileDesc.name), ": ", GenDescFile, " = ", pure);
-        f.print("  ", getFileDescCall(f, file), ";");
+        generateDescDoc(f, file);
+        f.print(f.export("const", fileDesc.name), ": ", GenDescFile, " = ", pure);
+        f.print("  ", getFileDescCall(f, file, schema), ";");
         f.print();
         for (const desc of schema.typesInFile(file)) {
             switch (desc.kind) {
@@ -47,12 +48,10 @@ function generateTs(schema) {
                     generateMessageShape(f, desc, "ts");
                     const { GenDescMessage, messageDesc } = f.runtime.codegen;
                     const MessageShape = f.importShape(desc);
-                    const fileDesc = f.importDesc(file);
                     const name = f.importDesc(desc).name;
-                    f.print("// Describes the ", desc.toString(), ".");
-                    f.print("// Use `create(", name, ")` to create a new ", MessageShape.name, ".");
+                    generateDescDoc(f, desc);
                     const call = (0, util_1.functionCall)(messageDesc, [fileDesc, ...(0, codegenv1_1.pathInFileDesc)(desc)]);
-                    f.print(f.exportDecl("const", name), ": ", GenDescMessage, "<", MessageShape, ">", " = ", pure);
+                    f.print(f.export("const", name), ": ", GenDescMessage, "<", MessageShape, ">", " = ", pure);
                     f.print("  ", call, ";");
                     f.print();
                     break;
@@ -61,11 +60,10 @@ function generateTs(schema) {
                     generateEnumShape(f, desc);
                     const { GenDescEnum, enumDesc } = f.runtime.codegen;
                     const EnumShape = f.importShape(desc);
-                    const fileDesc = f.importDesc(file);
-                    f.print("// Describes the ", desc.toString(), ".");
+                    generateDescDoc(f, desc);
                     const name = f.importDesc(desc).name;
                     const call = (0, util_1.functionCall)(enumDesc, [fileDesc, ...(0, codegenv1_1.pathInFileDesc)(desc)]);
-                    f.print(f.exportDecl("const", name), ": ", GenDescEnum, "<", EnumShape, ">", " = ", pure);
+                    f.print(f.export("const", name), ": ", GenDescEnum, "<", EnumShape, ">", " = ", pure);
                     f.print("  ", call, ";");
                     f.print();
                     break;
@@ -74,10 +72,10 @@ function generateTs(schema) {
                     const { GenDescExtension, extDesc } = f.runtime.codegen;
                     const name = f.importDesc(desc).name;
                     const E = f.importShape(desc.extendee);
-                    const V = (0, util_1.getFieldTypeInfo)(desc).typing;
-                    const call = (0, util_1.functionCall)(extDesc, [f.importDesc(file), ...(0, codegenv1_1.pathInFileDesc)(desc)]);
+                    const V = (0, util_1.fieldTypeScriptType)(desc).typing;
+                    const call = (0, util_1.functionCall)(extDesc, [fileDesc, ...(0, codegenv1_1.pathInFileDesc)(desc)]);
                     f.print(f.jsDoc(desc));
-                    f.print(f.exportDecl("const", name), ": ", GenDescExtension, "<", E, ", ", V, ">", " = ", pure);
+                    f.print(f.export("const", name), ": ", GenDescExtension, "<", E, ", ", V, ">", " = ", pure);
                     f.print("  ", call, ";");
                     f.print();
                     break;
@@ -85,9 +83,9 @@ function generateTs(schema) {
                 case "service": {
                     const { GenDescService, serviceDesc } = f.runtime.codegen;
                     const name = f.importDesc(desc).name;
-                    const call = (0, util_1.functionCall)(serviceDesc, [f.importDesc(file), ...(0, codegenv1_1.pathInFileDesc)(desc)]);
+                    const call = (0, util_1.functionCall)(serviceDesc, [fileDesc, ...(0, codegenv1_1.pathInFileDesc)(desc)]);
                     f.print(f.jsDoc(desc));
-                    f.print(f.exportDecl("const", name), ": ", GenDescService, "<", getServiceShapeExpr(f, desc), "> = ", pure);
+                    f.print(f.export("const", name), ": ", GenDescService, "<", getServiceShapeExpr(f, desc), "> = ", pure);
                     f.print("  ", call, ";");
                     f.print();
                     break;
@@ -102,18 +100,18 @@ function generateJs(schema) {
         const f = schema.generateFile(file.name + "_pb.js");
         f.preamble(file);
         const fileDesc = f.importDesc(file);
-        f.print(f.exportDecl("const", fileDesc.name), " = ", pure);
-        f.print("  ", getFileDescCall(f, file), ";");
+        generateDescDoc(f, file);
+        f.print(f.export("const", fileDesc.name), " = ", pure);
+        f.print("  ", getFileDescCall(f, file, schema), ";");
         f.print();
         for (const desc of schema.typesInFile(file)) {
             switch (desc.kind) {
                 case "message": {
                     const { messageDesc } = f.runtime.codegen;
-                    const MessageShape = f.importShape(desc);
                     const name = f.importDesc(desc).name;
-                    f.print("// Describes the ", desc.toString(), ". Use `create(", name, ")` to create a new ", MessageShape.name, ".");
+                    generateDescDoc(f, desc);
                     const call = (0, util_1.functionCall)(messageDesc, [fileDesc, ...(0, codegenv1_1.pathInFileDesc)(desc)]);
-                    f.print(f.exportDecl("const", name), " = ", pure);
+                    f.print(f.export("const", name), " = ", pure);
                     f.print("  ", call, ";");
                     f.print();
                     break;
@@ -122,10 +120,10 @@ function generateJs(schema) {
                     // generate descriptor
                     {
                         const { enumDesc } = f.runtime.codegen;
-                        f.print("// Describes the ", desc.toString(), ".");
+                        generateDescDoc(f, desc);
                         const name = f.importDesc(desc).name;
                         const call = (0, util_1.functionCall)(enumDesc, [fileDesc, ...(0, codegenv1_1.pathInFileDesc)(desc)]);
-                        f.print(f.exportDecl("const", name), " = ", pure);
+                        f.print(f.export("const", name), " = ", pure);
                         f.print("  ", call, ";");
                         f.print();
                     }
@@ -134,7 +132,7 @@ function generateJs(schema) {
                         f.print(f.jsDoc(desc));
                         const { tsEnum } = f.runtime.codegen;
                         const call = (0, util_1.functionCall)(tsEnum, [f.importDesc(desc)]);
-                        f.print(f.exportDecl("const", f.importShape(desc).name), " = ", pure);
+                        f.print(f.export("const", f.importShape(desc).name), " = ", pure);
                         f.print("  ", call, ";");
                         f.print();
                     }
@@ -143,9 +141,9 @@ function generateJs(schema) {
                 case "extension": {
                     const { extDesc } = f.runtime.codegen;
                     const name = f.importDesc(desc).name;
-                    const call = (0, util_1.functionCall)(extDesc, [f.importDesc(desc.file), ...(0, codegenv1_1.pathInFileDesc)(desc)]);
+                    const call = (0, util_1.functionCall)(extDesc, [fileDesc, ...(0, codegenv1_1.pathInFileDesc)(desc)]);
                     f.print(f.jsDoc(desc));
-                    f.print(f.exportDecl("const", name), " = ", pure);
+                    f.print(f.export("const", name), " = ", pure);
                     f.print("  ", call, ";");
                     f.print();
                     break;
@@ -154,8 +152,8 @@ function generateJs(schema) {
                     const { serviceDesc } = f.runtime.codegen;
                     const name = f.importDesc(desc).name;
                     f.print(f.jsDoc(desc));
-                    const call = (0, util_1.functionCall)(serviceDesc, [f.importDesc(desc.file), ...(0, codegenv1_1.pathInFileDesc)(desc)]);
-                    f.print(f.exportDecl("const", name), " = ", pure);
+                    const call = (0, util_1.functionCall)(serviceDesc, [fileDesc, ...(0, codegenv1_1.pathInFileDesc)(desc)]);
+                    f.print(f.export("const", name), " = ", pure);
                     f.print("  ", call, ";");
                     f.print();
                     break;
@@ -171,7 +169,8 @@ function generateDts(schema) {
         f.preamble(file);
         const { GenDescFile } = f.runtime.codegen;
         const fileDesc = f.importDesc(file);
-        f.print(f.exportDecl("declare const", fileDesc.name), ": ", GenDescFile, ";");
+        generateDescDoc(f, file);
+        f.print(f.export("declare const", fileDesc.name), ": ", GenDescFile, ";");
         f.print();
         for (const desc of schema.typesInFile(file)) {
             switch (desc.kind) {
@@ -180,8 +179,8 @@ function generateDts(schema) {
                     const { GenDescMessage } = f.runtime.codegen;
                     const MessageShape = f.importShape(desc);
                     const name = f.importDesc(desc).name;
-                    f.print("// Describes the ", desc.toString(), ". Use `create(", name, ")` to create a new ", MessageShape.name, ".");
-                    f.print(f.exportDecl("declare const", name), ": ", GenDescMessage, "<", MessageShape, ">", ";");
+                    generateDescDoc(f, desc);
+                    f.print(f.export("declare const", name), ": ", GenDescMessage, "<", MessageShape, ">", ";");
                     f.print();
                     break;
                 }
@@ -189,9 +188,9 @@ function generateDts(schema) {
                     generateEnumShape(f, desc);
                     const { GenDescEnum } = f.runtime.codegen;
                     const EnumShape = f.importShape(desc);
-                    f.print("// Describes the ", desc.toString(), ".");
+                    generateDescDoc(f, desc);
                     const name = f.importDesc(desc).name;
-                    f.print(f.exportDecl("declare const", name), ": ", GenDescEnum, "<", EnumShape, ">;");
+                    f.print(f.export("declare const", name), ": ", GenDescEnum, "<", EnumShape, ">;");
                     f.print();
                     break;
                 }
@@ -199,9 +198,9 @@ function generateDts(schema) {
                     const { GenDescExtension } = f.runtime.codegen;
                     const name = f.importDesc(desc).name;
                     const E = f.importShape(desc.extendee);
-                    const V = (0, util_1.getFieldTypeInfo)(desc).typing;
+                    const V = (0, util_1.fieldTypeScriptType)(desc).typing;
                     f.print(f.jsDoc(desc));
-                    f.print(f.exportDecl("declare const", name), ": ", GenDescExtension, "<", E, ", ", V, ">;");
+                    f.print(f.export("declare const", name), ": ", GenDescExtension, "<", E, ", ", V, ">;");
                     f.print();
                     break;
                 }
@@ -209,7 +208,7 @@ function generateDts(schema) {
                     const { GenDescService } = f.runtime.codegen;
                     const name = f.importDesc(desc).name;
                     f.print(f.jsDoc(desc));
-                    f.print(f.exportDecl("declare const", name), ": ", GenDescService, "<", getServiceShapeExpr(f, desc), ">;");
+                    f.print(f.export("declare const", name), ": ", GenDescService, "<", getServiceShapeExpr(f, desc), ">;");
                     f.print();
                     break;
                 }
@@ -217,9 +216,39 @@ function generateDts(schema) {
         }
     }
 }
+function generateDescDoc(f, desc) {
+    let lines;
+    switch (desc.kind) {
+        case "file":
+            lines = [`Describes the ${desc.toString()}.`];
+            break;
+        case "message":
+            lines = [
+                `Describes the ${desc.toString()}.`,
+                `Use \`create(${f.importDesc(desc).name})\` to create a new message.`,
+            ];
+            break;
+        case "enum":
+            lines = [`Describes the ${desc.toString()}.`];
+            break;
+    }
+    const deprecated = desc.deprecated || (0, reflect_1.parentTypes)(desc).some((d) => d.deprecated);
+    if (deprecated) {
+        lines.push("@deprecated");
+    }
+    f.print({
+        kind: "es_jsdoc",
+        text: lines.join("\n"),
+    });
+}
 // prettier-ignore
-function getFileDescCall(f, file) {
-    const info = (0, codegenv1_1.embedFileDesc)(file);
+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
+    // messages from CodeGeneratorRequest.proto_file instead.
+    const sourceFile = file.proto;
+    const runtimeFile = schema.proto.protoFile.find(f => f.name == sourceFile.name);
+    const info = (0, codegenv1_1.embedFileDesc)(runtimeFile !== null && runtimeFile !== void 0 ? runtimeFile : sourceFile);
     if (info.bootable && !f.runtime.create.from.startsWith("@bufbuild/protobuf")) {
         // google/protobuf/descriptor.proto is embedded as a plain object when
         // bootstrapping to avoid recursion
@@ -247,10 +276,10 @@ function getServiceShapeExpr(f, service) {
     print("{");
     for (const method of service.methods) {
         print(f.jsDoc(method, "  "));
-        print("  ", (0, reflect_1.localName)(method), ": {");
-        print("    kind: ", f.string(method.methodKind), ";");
-        print("    I: ", f.importShape(method.input), ";");
-        print("    O: ", f.importShape(method.output), ";");
+        print("  ", method.localName, ": {");
+        print("    methodKind: ", f.string(method.methodKind), ";");
+        print("    input: typeof ", f.importDesc(method.input, true), ";");
+        print("    output: typeof ", f.importDesc(method.output, true), ";");
         print("  },");
     }
     print("}");
@@ -259,13 +288,13 @@ function getServiceShapeExpr(f, service) {
 // prettier-ignore
 function generateEnumShape(f, enumeration) {
     f.print(f.jsDoc(enumeration));
-    f.print(f.exportDecl("enum", f.importShape(enumeration).name), " {");
+    f.print(f.export("enum", f.importShape(enumeration).name), " {");
     for (const value of enumeration.values) {
         if (enumeration.values.indexOf(value) > 0) {
             f.print();
         }
         f.print(f.jsDoc(value, "  "));
-        f.print("  ", (0, reflect_1.localName)(value), " = ", value.number, ",");
+        f.print("  ", value.localName, " = ", value.number, ",");
     }
     f.print("}");
     f.print();
@@ -275,31 +304,31 @@ function generateMessageShape(f, message, target) {
     const { Message } = f.runtime;
     const declaration = target == "ts" ? "type" : "declare type";
     f.print(f.jsDoc(message));
-    f.print(f.exportDecl(declaration, f.importShape(message).name), " = ", Message, "<", f.string(message.typeName), "> & {");
+    f.print(f.export(declaration, f.importShape(message).name), " = ", Message, "<", f.string(message.typeName), "> & {");
     for (const member of message.members) {
         switch (member.kind) {
             case "oneof":
                 f.print(f.jsDoc(member, "  "));
-                f.print("  ", (0, reflect_1.localName)(member), ": {");
+                f.print("  ", member.localName, ": {");
                 for (const field of member.fields) {
                     if (member.fields.indexOf(field) > 0) {
                         f.print(`  } | {`);
                     }
                     f.print(f.jsDoc(field, "    "));
-                    const { typing } = (0, util_1.getFieldTypeInfo)(field);
+                    const { typing } = (0, util_1.fieldTypeScriptType)(field);
                     f.print(`    value: `, typing, `;`);
-                    f.print(`    case: "`, (0, reflect_1.localName)(field), `";`);
+                    f.print(`    case: "`, field.localName, `";`);
                 }
                 f.print(`  } | { case: undefined; value?: undefined };`);
                 break;
             default: {
                 f.print(f.jsDoc(member, "  "));
-                const { typing, optional } = (0, util_1.getFieldTypeInfo)(member);
-                if ((0, util_1.fieldUsesPrototype)(member) || !optional) {
-                    f.print("  ", (0, reflect_1.localName)(member), ": ", typing, ";");
+                const { typing, optional } = (0, util_1.fieldTypeScriptType)(member);
+                if (optional) {
+                    f.print("  ", member.localName, "?: ", typing, ";");
                 }
                 else {
-                    f.print("  ", (0, reflect_1.localName)(member), "?: ", typing, ";");
+                    f.print("  ", member.localName, ": ", typing, ";");
                 }
                 break;
             }

package/dist/cjs/src/util.js

@@ -13,41 +13,22 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.arrayLiteral = exports.functionCall = exports.getFieldTypeInfo = exports.fieldUsesPrototype = void 0;
-const reflect_1 = require("@bufbuild/protobuf/reflect");
+exports.arrayLiteral = exports.functionCall = exports.fieldTypeScriptType = void 0;
+const protobuf_1 = require("@bufbuild/protobuf");
+const codegenv1_1 = require("@bufbuild/protobuf/codegenv1");
 const wkt_1 = require("@bufbuild/protobuf/wkt");
-/**
- * Tells whether a field uses the prototype chain for field presence.
- * Behavior must match with the counterpart in @bufbuild/protobuf.
- */
-function fieldUsesPrototype(field) {
-    if (field.parent.file.edition != wkt_1.Edition.EDITION_PROTO2) {
-        return false;
-    }
-    if (field.fieldKind != "scalar" && field.fieldKind != "enum") {
-        return false;
-    }
-    if (field.oneof) {
-        return false;
-    }
-    // proto2 singular scalar and enum fields use an initial value on the prototype chain
-    return true;
-}
-exports.fieldUsesPrototype = fieldUsesPrototype;
-function getFieldTypeInfo(field) {
+function fieldTypeScriptType(field) {
     const typing = [];
-    let typingInferrableFromZeroValue;
     let optional = false;
     switch (field.fieldKind) {
         case "scalar":
-            typing.push((0, reflect_1.scalarTypeScriptType)(field.scalar, field.longType));
-            optional = field.optional;
-            typingInferrableFromZeroValue = true;
+            typing.push((0, codegenv1_1.scalarTypeScriptType)(field.scalar, field.longAsString));
+            optional = field.proto.proto3Optional;
             break;
         case "message": {
             if (!field.oneof && (0, wkt_1.isWrapperDesc)(field.message)) {
                 const baseType = field.message.fields[0].scalar;
-                typing.push((0, reflect_1.scalarTypeScriptType)(baseType, reflect_1.LongType.BIGINT));
+                typing.push((0, codegenv1_1.scalarTypeScriptType)(baseType, false));
             }
             else {
                 typing.push({
@@ -56,7 +37,6 @@ function getFieldTypeInfo(field) {
                 });
             }
             optional = true;
-            typingInferrableFromZeroValue = true;
             break;
         }
         case "enum":
@@ -64,12 +44,10 @@ function getFieldTypeInfo(field) {
                 kind: "es_shape_ref",
                 desc: field.enum,
             });
-            optional = field.optional;
-            typingInferrableFromZeroValue = true;
+            optional = field.proto.proto3Optional;
             break;
         case "list":
             optional = false;
-            typingInferrableFromZeroValue = false;
             switch (field.listKind) {
                 case "enum":
                     typing.push({
@@ -78,7 +56,7 @@ function getFieldTypeInfo(field) {
                     }, "[]");
                     break;
                 case "scalar":
-                    typing.push((0, reflect_1.scalarTypeScriptType)(field.scalar, field.longType), "[]");
+                    typing.push((0, codegenv1_1.scalarTypeScriptType)(field.scalar, field.longAsString), "[]");
                     break;
                 case "message": {
                     typing.push({
@@ -92,11 +70,11 @@ function getFieldTypeInfo(field) {
         case "map": {
             let keyType;
             switch (field.mapKey) {
-                case reflect_1.ScalarType.INT32:
-                case reflect_1.ScalarType.FIXED32:
-                case reflect_1.ScalarType.UINT32:
-                case reflect_1.ScalarType.SFIXED32:
-                case reflect_1.ScalarType.SINT32:
+                case protobuf_1.ScalarType.INT32:
+                case protobuf_1.ScalarType.FIXED32:
+                case protobuf_1.ScalarType.UINT32:
+                case protobuf_1.ScalarType.SFIXED32:
+                case protobuf_1.ScalarType.SINT32:
                     keyType = "number";
                     break;
                 default:
@@ -106,7 +84,7 @@ function getFieldTypeInfo(field) {
             let valueType;
             switch (field.mapKind) {
                 case "scalar":
-                    valueType = (0, reflect_1.scalarTypeScriptType)(field.scalar, reflect_1.LongType.BIGINT);
+                    valueType = (0, codegenv1_1.scalarTypeScriptType)(field.scalar, false);
                     break;
                 case "message":
                     valueType = {
@@ -122,14 +100,13 @@ function getFieldTypeInfo(field) {
                     break;
             }
             typing.push("{ [key: ", keyType, "]: ", valueType, " }");
-            typingInferrableFromZeroValue = false;
             optional = false;
             break;
         }
     }
-    return { typing, optional, typingInferrableFromZeroValue };
+    return { typing, optional };
 }
-exports.getFieldTypeInfo = getFieldTypeInfo;
+exports.fieldTypeScriptType = fieldTypeScriptType;
 function functionCall(fn, args, typeParams) {
     let tp = [];
     if (typeParams !== undefined && typeParams.length > 0) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bufbuild/protoc-gen-es",
-  "version": "2.0.0-alpha.1",
+  "version": "2.0.0-alpha.3",
   "description": "Protocol Buffers code generator for ECMAScript",
   "license": "Apache-2.0",
   "repository": {
@@ -20,15 +20,19 @@
   },
   "preferUnplugged": true,
   "dependencies": {
-    "@bufbuild/protobuf": "^2.0.0-alpha.1",
-    "@bufbuild/protoplugin": "2.0.0-alpha.1"
+    "@bufbuild/protobuf": "^2.0.0-alpha.3",
+    "@bufbuild/protoplugin": "2.0.0-alpha.3"
   },
   "peerDependencies": {
-    "@bufbuild/protobuf": "2.0.0-alpha.1"
+    "@bufbuild/protobuf": "2.0.0-alpha.3"
   },
   "peerDependenciesMeta": {
     "@bufbuild/protobuf": {
       "optional": true
     }
-  }
+  },
+  "files": [
+    "dist/**",
+    "bin/**"
+  ]
 }

package/src/protoc-gen-es-plugin.ts

@@ -1,336 +0,0 @@
-// Copyright 2021-2024 Buf Technologies, Inc.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-import type {
-  DescEnum,
-  DescFile,
-  DescMessage,
-  DescService,
-} from "@bufbuild/protobuf";
-import { localName } from "@bufbuild/protobuf/reflect";
-import { embedFileDesc, pathInFileDesc } from "@bufbuild/protobuf/codegenv1";
-import { createEcmaScriptPlugin } from "@bufbuild/protoplugin";
-import type {
-  Schema,
-  GeneratedFile,
-  Printable,
-  Target,
-} from "@bufbuild/protoplugin/ecmascript";
-import {
-  arrayLiteral,
-  fieldUsesPrototype,
-  functionCall,
-  getFieldTypeInfo,
-} from "./util";
-import { version } from "../package.json";
-
-export const protocGenEs = createEcmaScriptPlugin({
-  name: "protoc-gen-es",
-  version: `v${String(version)}`,
-  generateTs,
-  generateJs,
-  generateDts,
-});
-
-// 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__*/";
-
-// prettier-ignore
-function generateTs(schema: Schema) {
-  for (const file of schema.files) {
-    const f = schema.generateFile(file.name + "_pb.ts");
-    f.preamble(file);
-    const { GenDescFile } = f.runtime.codegen;
-    const fileDesc = f.importDesc(file);
-    f.print(f.exportDecl("const", fileDesc.name), ": ", GenDescFile, " = ", pure);
-    f.print("  ", getFileDescCall(f, file), ";");
-    f.print();
-    for (const desc of schema.typesInFile(file)) {
-      switch (desc.kind) {
-        case "message": {
-          generateMessageShape(f, desc, "ts");
-          const {GenDescMessage, messageDesc} = f.runtime.codegen;
-          const MessageShape = f.importShape(desc);
-          const fileDesc = f.importDesc(file);
-          const name = f.importDesc(desc).name;
-          f.print("// Describes the ", desc.toString(), ".");
-          f.print("// Use `create(", name, ")` to create a new ", MessageShape.name, ".");
-          const call = functionCall(messageDesc, [fileDesc, ...pathInFileDesc(desc)]);
-          f.print(f.exportDecl("const", name), ": ", GenDescMessage, "<", MessageShape, ">", " = ", pure);
-          f.print("  ", call, ";");
-          f.print();
-          break;
-        }
-        case "enum": {
-          generateEnumShape(f, desc);
-          const {GenDescEnum, enumDesc} = f.runtime.codegen;
-          const EnumShape = f.importShape(desc);
-          const fileDesc = f.importDesc(file);
-          f.print("// Describes the ", desc.toString(), ".");
-          const name = f.importDesc(desc).name;
-          const call = functionCall(enumDesc, [fileDesc, ...pathInFileDesc(desc)]);
-          f.print(f.exportDecl("const", name), ": ", GenDescEnum, "<", EnumShape, ">", " = ", pure);
-          f.print("  ", call, ";");
-          f.print();
-          break;
-        }
-        case "extension": {
-          const { GenDescExtension, extDesc } = f.runtime.codegen;
-          const name = f.importDesc(desc).name;
-          const E = f.importShape(desc.extendee);
-          const V = getFieldTypeInfo(desc).typing;
-          const call = functionCall(extDesc, [f.importDesc(file), ...pathInFileDesc(desc)]);
-          f.print(f.jsDoc(desc));
-          f.print(f.exportDecl("const", name), ": ", GenDescExtension, "<", E, ", ", V, ">", " = ", pure);
-          f.print("  ", call, ";");
-          f.print();
-          break;
-        }
-        case "service": {
-          const { GenDescService, serviceDesc} = f.runtime.codegen;
-          const name = f.importDesc(desc).name;
-          const call = functionCall(serviceDesc, [f.importDesc(file), ...pathInFileDesc(desc)]);
-          f.print(f.jsDoc(desc));
-          f.print(f.exportDecl("const", name), ": ", GenDescService, "<", getServiceShapeExpr(f, desc), "> = ", pure);
-          f.print("  ", call, ";");
-          f.print();
-          break;
-        }
-      }
-    }
-  }
-}
-
-// prettier-ignore
-function generateJs(schema: Schema) {
-  for (const file of schema.files) {
-    const f = schema.generateFile(file.name + "_pb.js");
-    f.preamble(file);
-    const fileDesc = f.importDesc(file);
-    f.print(f.exportDecl("const", fileDesc.name), " = ", pure);
-    f.print("  ", getFileDescCall(f, file), ";");
-    f.print();
-    for (const desc of schema.typesInFile(file)) {
-      switch (desc.kind) {
-        case "message": {
-          const { messageDesc} = f.runtime.codegen;
-          const MessageShape = f.importShape(desc);
-          const name = f.importDesc(desc).name;
-          f.print("// Describes the ", desc.toString(), ". Use `create(", name, ")` to create a new ", MessageShape.name, ".");
-          const call = functionCall(messageDesc, [fileDesc, ...pathInFileDesc(desc)]);
-          f.print(f.exportDecl("const", name), " = ", pure);
-          f.print("  ", call, ";");
-          f.print();
-          break;
-        }
-        case "enum": {
-          // generate descriptor
-          {
-            const { enumDesc } = f.runtime.codegen;
-            f.print("// Describes the ", desc.toString(), ".");
-            const name = f.importDesc(desc).name;
-            const call = functionCall(enumDesc, [fileDesc, ...pathInFileDesc(desc)]);
-            f.print(f.exportDecl("const", name), " = ", pure);
-            f.print("  ", call, ";");
-            f.print();
-          }
-          // declare TypeScript enum
-          {
-            f.print(f.jsDoc(desc));
-            const { tsEnum } = f.runtime.codegen;
-            const call = functionCall(tsEnum, [f.importDesc(desc)]);
-            f.print(f.exportDecl("const", f.importShape(desc).name), " = ", pure);
-            f.print("  ", call, ";");
-            f.print();
-          }
-          break;
-        }
-        case "extension": {
-          const { extDesc } = f.runtime.codegen;
-          const name = f.importDesc(desc).name;
-          const call = functionCall(extDesc, [f.importDesc(desc.file), ...pathInFileDesc(desc)]);
-          f.print(f.jsDoc(desc));
-          f.print(f.exportDecl("const", name), " = ", pure);
-          f.print("  ", call, ";");
-          f.print();
-          break;
-        }
-        case "service": {
-          const { serviceDesc} = f.runtime.codegen;
-          const name = f.importDesc(desc).name;
-          f.print(f.jsDoc(desc));
-          const call = functionCall(serviceDesc, [f.importDesc(desc.file), ...pathInFileDesc(desc)]);
-          f.print(f.exportDecl("const", name), " = ", pure);
-          f.print("  ", call, ";");
-          f.print();
-          break;
-        }
-      }
-    }
-  }
-}
-
-// prettier-ignore
-function generateDts(schema: Schema) {
-  for (const file of schema.files) {
-    const f = schema.generateFile(file.name + "_pb.d.ts");
-    f.preamble(file);
-    const { GenDescFile } = f.runtime.codegen;
-    const fileDesc = f.importDesc(file);
-    f.print(f.exportDecl("declare const", fileDesc.name), ": ", GenDescFile, ";");
-    f.print();
-    for (const desc of schema.typesInFile(file)) {
-      switch (desc.kind) {
-        case "message": {
-          generateMessageShape(f, desc, "dts");
-          const { GenDescMessage } = f.runtime.codegen;
-          const MessageShape = f.importShape(desc);
-          const name = f.importDesc(desc).name;
-          f.print("// Describes the ", desc.toString(), ". Use `create(", name, ")` to create a new ", MessageShape.name, ".");
-          f.print(f.exportDecl("declare const", name), ": ", GenDescMessage, "<", MessageShape, ">", ";");
-          f.print();
-          break;
-        }
-        case "enum": {
-          generateEnumShape(f, desc);
-          const { GenDescEnum } = f.runtime.codegen;
-          const EnumShape = f.importShape(desc);
-          f.print("// Describes the ", desc.toString(), ".");
-          const name = f.importDesc(desc).name;
-          f.print(f.exportDecl("declare const", name), ": ", GenDescEnum, "<", EnumShape, ">;");
-          f.print();
-          break;
-        }
-        case "extension": {
-          const { GenDescExtension } = f.runtime.codegen;
-          const name = f.importDesc(desc).name;
-          const E = f.importShape(desc.extendee);
-          const V = getFieldTypeInfo(desc).typing;
-          f.print(f.jsDoc(desc));
-          f.print(f.exportDecl("declare const", name), ": ", GenDescExtension, "<", E, ", ", V, ">;");
-          f.print();
-          break;
-        }
-        case "service": {
-          const { GenDescService } = f.runtime.codegen;
-          const name = f.importDesc(desc).name;
-          f.print(f.jsDoc(desc));
-          f.print(f.exportDecl("declare const", name), ": ", GenDescService, "<", getServiceShapeExpr(f, desc), ">;");
-          f.print();
-          break;
-        }
-      }
-    }
-  }
-}
-
-// prettier-ignore
-function getFileDescCall(f: GeneratedFile, file: DescFile) {
-  const info = embedFileDesc(file);
-  if (info.bootable && !f.runtime.create.from.startsWith("@bufbuild/protobuf")) {
-    // google/protobuf/descriptor.proto is embedded as a plain object when
-    // bootstrapping to avoid recursion
-    return functionCall(f.runtime.codegen.boot, [JSON.stringify(info.boot())]);
-  }
-  const { fileDesc } = f.runtime.codegen;
-  if (file.dependencies.length > 0) {
-    const deps: Printable = file.dependencies.map((f) => ({
-      kind: "es_desc_ref",
-      desc: f,
-    }));
-    return functionCall(fileDesc, [
-      f.string(info.base64()),
-      arrayLiteral(deps),
-    ]);
-  }
-  return functionCall(fileDesc, [f.string(info.base64())]);
-}
-
-// prettier-ignore
-function getServiceShapeExpr(f: GeneratedFile, service: DescService): Printable {
-  const p: Printable[] = [];
-  function print(...printables: Printable[]) {
-    p.push(...printables, "\n");
-  }
-  print("{");
-  for (const method of service.methods) {
-    print(f.jsDoc(method, "  "));
-    print("  ", localName(method), ": {");
-    print("    kind: ", f.string(method.methodKind), ";");
-    print("    I: ", f.importShape(method.input), ";");
-    print("    O: ", f.importShape(method.output), ";");
-    print("  },");
-  }
-  print("}");
-  return p;
-}
-
-// prettier-ignore
-function generateEnumShape(f: GeneratedFile, enumeration: DescEnum) {
-  f.print(f.jsDoc(enumeration));
-  f.print(f.exportDecl("enum", f.importShape(enumeration).name), " {");
-  for (const value of enumeration.values) {
-    if (enumeration.values.indexOf(value) > 0) {
-      f.print();
-    }
-    f.print(f.jsDoc(value, "  "));
-    f.print("  ", localName(value), " = ", value.number, ",");
-  }
-  f.print("}");
-  f.print();
-}
-
-// prettier-ignore
-function generateMessageShape(f: GeneratedFile, message: DescMessage, target: Extract<Target, "ts" | "dts">) {
-  const { Message } = f.runtime;
-  const declaration = target == "ts" ? "type" : "declare type";
-  f.print(f.jsDoc(message));
-  f.print(f.exportDecl(declaration, f.importShape(message).name), " = ", Message, "<", f.string(message.typeName), "> & {");
-  for (const member of message.members) {
-    switch (member.kind) {
-      case "oneof":
-        f.print(f.jsDoc(member, "  "));
-        f.print("  ", localName(member), ": {");
-        for (const field of member.fields) {
-          if (member.fields.indexOf(field) > 0) {
-            f.print(`  } | {`);
-          }
-          f.print(f.jsDoc(field, "    "));
-          const { typing } = getFieldTypeInfo(field);
-          f.print(`    value: `, typing, `;`);
-          f.print(`    case: "`, localName(field), `";`);
-        }
-        f.print(`  } | { case: undefined; value?: undefined };`);
-        break;
-      default: {
-        f.print(f.jsDoc(member, "  "));
-        const {typing, optional} = getFieldTypeInfo(member);
-        if (fieldUsesPrototype(member) || !optional) {
-          f.print("  ", localName(member), ": ", typing, ";");
-        } else {
-          f.print("  ", localName(member), "?: ", typing, ";");
-        }
-        break;
-      }
-    }
-    if (message.members.indexOf(member) < message.members.length - 1) {
-      f.print();
-    }
-  }
-  f.print("};");
-  f.print();
-}

package/src/util.ts

@@ -1,176 +0,0 @@
-// Copyright 2021-2024 Buf Technologies, Inc.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//      http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-import type { DescExtension, DescField } from "@bufbuild/protobuf";
-import {
-  LongType,
-  ScalarType,
-  scalarTypeScriptType,
-} from "@bufbuild/protobuf/reflect";
-import { Edition, isWrapperDesc } from "@bufbuild/protobuf/wkt";
-import type { Printable } from "@bufbuild/protoplugin/ecmascript";
-
-/**
- * Tells whether a field uses the prototype chain for field presence.
- * Behavior must match with the counterpart in @bufbuild/protobuf.
- */
-export function fieldUsesPrototype(field: DescField): field is DescField & {
-  fieldKind: "scalar" | "enum";
-  oneof: undefined;
-  repeated: false;
-} {
-  if (field.parent.file.edition != Edition.EDITION_PROTO2) {
-    return false;
-  }
-  if (field.fieldKind != "scalar" && field.fieldKind != "enum") {
-    return false;
-  }
-  if (field.oneof) {
-    return false;
-  }
-  // proto2 singular scalar and enum fields use an initial value on the prototype chain
-  return true;
-}
-
-export function getFieldTypeInfo(field: DescField | DescExtension): {
-  typing: Printable;
-  optional: boolean;
-  typingInferrableFromZeroValue: boolean;
-} {
-  const typing: Printable = [];
-  let typingInferrableFromZeroValue: boolean;
-  let optional = false;
-  switch (field.fieldKind) {
-    case "scalar":
-      typing.push(scalarTypeScriptType(field.scalar, field.longType));
-      optional = field.optional;
-      typingInferrableFromZeroValue = true;
-      break;
-    case "message": {
-      if (!field.oneof && isWrapperDesc(field.message)) {
-        const baseType = field.message.fields[0].scalar;
-        typing.push(scalarTypeScriptType(baseType, LongType.BIGINT));
-      } else {
-        typing.push({
-          kind: "es_shape_ref",
-          desc: field.message,
-        });
-      }
-      optional = true;
-      typingInferrableFromZeroValue = true;
-      break;
-    }
-    case "enum":
-      typing.push({
-        kind: "es_shape_ref",
-        desc: field.enum,
-      });
-      optional = field.optional;
-      typingInferrableFromZeroValue = true;
-      break;
-    case "list":
-      optional = false;
-      typingInferrableFromZeroValue = false;
-      switch (field.listKind) {
-        case "enum":
-          typing.push(
-            {
-              kind: "es_shape_ref",
-              desc: field.enum,
-            },
-            "[]",
-          );
-          break;
-        case "scalar":
-          typing.push(scalarTypeScriptType(field.scalar, field.longType), "[]");
-          break;
-        case "message": {
-          typing.push(
-            {
-              kind: "es_shape_ref",
-              desc: field.message,
-            },
-            "[]",
-          );
-          break;
-        }
-      }
-      break;
-    case "map": {
-      let keyType: string;
-      switch (field.mapKey) {
-        case ScalarType.INT32:
-        case ScalarType.FIXED32:
-        case ScalarType.UINT32:
-        case ScalarType.SFIXED32:
-        case ScalarType.SINT32:
-          keyType = "number";
-          break;
-        default:
-          keyType = "string";
-          break;
-      }
-      let valueType: Printable;
-      switch (field.mapKind) {
-        case "scalar":
-          valueType = scalarTypeScriptType(field.scalar, LongType.BIGINT);
-          break;
-        case "message":
-          valueType = {
-            kind: "es_shape_ref",
-            desc: field.message,
-          };
-          break;
-        case "enum":
-          valueType = {
-            kind: "es_shape_ref",
-            desc: field.enum,
-          };
-          break;
-      }
-      typing.push("{ [key: ", keyType, "]: ", valueType, " }");
-      typingInferrableFromZeroValue = false;
-      optional = false;
-      break;
-    }
-  }
-  return { typing, optional, typingInferrableFromZeroValue };
-}
-
-export function functionCall(
-  fn: Printable,
-  args: Printable[],
-  typeParams?: Printable[],
-): Printable {
-  let tp: Printable = [];
-  if (typeParams !== undefined && typeParams.length > 0) {
-    tp = ["<", commaSeparate(typeParams), ">"];
-  }
-  return [fn, ...tp, "(", commaSeparate(args), ")"];
-}
-
-export function arrayLiteral(elements: Printable[]): Printable {
-  return ["[", commaSeparate(elements), "]"];
-}
-
-function commaSeparate(elements: Printable[]): Printable {
-  const r: Printable[] = [];
-  for (let i = 0; i < elements.length; i++) {
-    r.push(elements[i]);
-    if (i < elements.length - 1) {
-      r.push(", ");
-    }
-  }
-  return r;
-}

package/tsconfig.json

@@ -1,12 +0,0 @@
-{
-  "files": ["src/protoc-gen-es-plugin.ts"],
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    // We import the plugin's version number from package.json
-    "resolveJsonModule": true,
-    // This package is CommonJS
-    "verbatimModuleSyntax": false,
-    "module": "CommonJS",
-    "moduleResolution": "Node10"
-  }
-}