@bufbuild/protoplugin 1.9.0 → 2.0.0-alpha.1

package/dist/cjs/ecmascript/schema.js

@@ -15,37 +15,35 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createSchema = void 0;
 const protobuf_1 = require("@bufbuild/protobuf");
+const wkt_1 = require("@bufbuild/protobuf/wkt");
+const reflect_1 = require("@bufbuild/protobuf/reflect");
 const generated_file_js_1 = require("./generated-file.js");
-const runtime_imports_js_1 = require("./runtime-imports.js");
 const import_symbol_js_1 = require("./import-symbol.js");
 const import_path_js_1 = require("./import-path.js");
 const file_preamble_js_1 = require("./file-preamble.js");
-function createSchema(request, parameter, pluginName, pluginVersion, featureSetDefaults) {
-    const descriptorSet = (0, protobuf_1.createDescriptorSet)(request.protoFile, {
-        featureSetDefaults,
-    });
-    const filesToGenerate = findFilesToGenerate(descriptorSet, request);
-    const runtime = (0, runtime_imports_js_1.createRuntimeImports)(parameter.bootstrapWkt);
-    const createTypeImport = (desc) => {
-        const name = protobuf_1.codegenInfo.localName(desc);
-        const from = (0, import_path_js_1.makeImportPath)(desc.file, parameter.bootstrapWkt, filesToGenerate);
-        return (0, import_symbol_js_1.createImportSymbol)(name, from);
-    };
-    const createPreamble = (descFile) => (0, file_preamble_js_1.makeFilePreamble)(descFile, pluginName, pluginVersion, parameter.sanitizedParameter, parameter.tsNocheck);
+const names_js_1 = require("./names.js");
+const runtime_imports_js_1 = require("./runtime-imports.js");
+function createSchema(request, parameter, pluginName, pluginVersion, minimumEdition, maximumEdition) {
+    const { allFiles, filesToGenerate } = getFilesToGenerate(request, minimumEdition, maximumEdition);
     let target;
     const generatedFiles = [];
+    const runtime = (0, runtime_imports_js_1.createRuntimeImports)(parameter.bootstrapWkt);
+    const resolveDescImport = (desc, typeOnly) => (0, import_symbol_js_1.createImportSymbol)((0, names_js_1.localDescName)(desc), (0, names_js_1.generateFilePath)(desc.kind == "file" ? desc : desc.file, parameter.bootstrapWkt, filesToGenerate), typeOnly);
+    const resolveShapeImport = (desc) => (0, import_symbol_js_1.createImportSymbol)((0, names_js_1.localShapeName)(desc), (0, names_js_1.generateFilePath)(desc.file, parameter.bootstrapWkt, filesToGenerate), true);
+    const createPreamble = (descFile) => (0, file_preamble_js_1.makeFilePreamble)(descFile, pluginName, pluginVersion, parameter.sanitizedParameter, parameter.tsNocheck);
+    const rewriteImport = (importPath) => (0, import_path_js_1.rewriteImportPath)(importPath, parameter.rewriteImports, parameter.importExtension);
     return {
         targets: parameter.targets,
-        runtime,
         proto: request,
         files: filesToGenerate,
-        allFiles: descriptorSet.files,
+        allFiles: allFiles,
+        typesInFile: reflect_1.nestedTypes,
         generateFile(name) {
             if (target === undefined) {
                 throw new Error("prepareGenerate() must be called before generateFile()");
             }
             const genFile = (0, generated_file_js_1.createGeneratedFile)(name, (0, import_path_js_1.deriveImportPath)(name), target === "js" ? parameter.jsImportStyle : "module", // ts and dts always use import/export, only js may use commonjs
-            (importPath) => (0, import_path_js_1.rewriteImportPath)(importPath, parameter.rewriteImports, parameter.importExtension), createTypeImport, runtime, createPreamble);
+            rewriteImport, resolveDescImport, resolveShapeImport, createPreamble, runtime);
             generatedFiles.push(genFile);
             return genFile;
         },
@@ -60,10 +58,56 @@ function createSchema(request, parameter, pluginName, pluginVersion, featureSetD
     };
 }
 exports.createSchema = createSchema;
-function findFilesToGenerate(descriptorSet, request) {
-    const missing = request.fileToGenerate.filter((fileToGenerate) => descriptorSet.files.every((file) => fileToGenerate !== file.name + ".proto"));
+function getFilesToGenerate(request, minimumEdition, maximumEdition) {
+    if (minimumEdition > maximumEdition) {
+        throw new Error(`configured minimumEdition ${editionToString(minimumEdition)} > maximumEdition ${editionToString(maximumEdition)} - please contact plugin author`);
+    }
+    const missing = request.fileToGenerate.filter((fileToGenerate) => !request.protoFile.find((f) => f.name === fileToGenerate));
     if (missing.length) {
-        throw `files_to_generate missing in the request: ${missing.join(", ")}`;
+        throw new Error(`files_to_generate missing in the request: ${missing.join(", ")}`);
+    }
+    for (const file of request.protoFile) {
+        if (request.fileToGenerate.includes(file.name)) {
+            let edition;
+            switch (file.syntax) {
+                case "":
+                case "proto2":
+                    edition = wkt_1.Edition.EDITION_PROTO2;
+                    break;
+                case "proto3":
+                    edition = wkt_1.Edition.EDITION_PROTO3;
+                    break;
+                case "editions":
+                    edition = file.edition;
+                    break;
+                default:
+                    edition = wkt_1.Edition.EDITION_UNKNOWN;
+                    break;
+            }
+            if (edition < minimumEdition) {
+                throw new Error(`${file.name}: unsupported edition ${editionToString(edition)} - the earliest supported edition is ${editionToString(minimumEdition)}`);
+            }
+            if (edition > maximumEdition) {
+                throw new Error(`${file.name}: unsupported edition ${editionToString(edition)} - the latest supported edition is ${editionToString(maximumEdition)}`);
+            }
+        }
+    }
+    const registry = (0, reflect_1.createFileRegistry)((0, protobuf_1.create)(wkt_1.FileDescriptorSetDesc, {
+        file: request.protoFile,
+    }));
+    const allFiles = [];
+    const filesToGenerate = [];
+    for (const file of registry.files) {
+        allFiles.push(file);
+        if (request.fileToGenerate.includes(file.proto.name)) {
+            filesToGenerate.push(file);
+        }
+    }
+    return { allFiles, filesToGenerate };
+}
+function editionToString(edition) {
+    if (edition in wkt_1.Edition) {
+        return wkt_1.Edition[edition].replace(/^EDITION_/, "");
     }
-    return descriptorSet.files.filter((file) => request.fileToGenerate.includes(file.name + ".proto"));
+    return `unknown (${edition})`;
 }

package/dist/cjs/index.d.ts

@@ -1,8 +1,4 @@
-import type { Schema as SchemaInternal } from "./ecmascript/schema.js";
 export type { Plugin } from "./plugin.js";
 export { runNodeJs } from "./run-node.js";
 export { createEcmaScriptPlugin } from "./create-es-plugin.js";
-/**
- * @deprecated Please use Schema from @bufbuild/protoplugin/ecmascript instead
- */
-export type Schema = SchemaInternal;
+export { getComments, getDeclarationString, getPackageComments, getSyntaxComments, } from "./source-code-info.js";

package/dist/cjs/index.js

@@ -13,8 +13,13 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createEcmaScriptPlugin = exports.runNodeJs = void 0;
+exports.getSyntaxComments = exports.getPackageComments = exports.getDeclarationString = exports.getComments = exports.createEcmaScriptPlugin = exports.runNodeJs = void 0;
 var run_node_js_1 = require("./run-node.js");
 Object.defineProperty(exports, "runNodeJs", { enumerable: true, get: function () { return run_node_js_1.runNodeJs; } });
 var create_es_plugin_js_1 = require("./create-es-plugin.js");
 Object.defineProperty(exports, "createEcmaScriptPlugin", { enumerable: true, get: function () { return create_es_plugin_js_1.createEcmaScriptPlugin; } });
+var source_code_info_js_1 = require("./source-code-info.js");
+Object.defineProperty(exports, "getComments", { enumerable: true, get: function () { return source_code_info_js_1.getComments; } });
+Object.defineProperty(exports, "getDeclarationString", { enumerable: true, get: function () { return source_code_info_js_1.getDeclarationString; } });
+Object.defineProperty(exports, "getPackageComments", { enumerable: true, get: function () { return source_code_info_js_1.getPackageComments; } });
+Object.defineProperty(exports, "getSyntaxComments", { enumerable: true, get: function () { return source_code_info_js_1.getSyntaxComments; } });

package/dist/cjs/plugin.d.ts

@@ -1,4 +1,4 @@
-import type { CodeGeneratorRequest, CodeGeneratorResponse } from "@bufbuild/protobuf";
+import type { CodeGeneratorRequest, CodeGeneratorResponse } from "@bufbuild/protobuf/wkt";
 /**
  * Represents any code generator plugin.
  */

package/dist/cjs/run-node.js

@@ -14,8 +14,9 @@
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runNodeJs = void 0;
-const protobuf_1 = require("@bufbuild/protobuf");
 const error_js_1 = require("./error.js");
+const protobuf_1 = require("@bufbuild/protobuf");
+const wkt_1 = require("@bufbuild/protobuf/wkt");
 /**
  * Run a plugin with Node.js.
  *
@@ -40,9 +41,9 @@ function runNodeJs(plugin) {
     }
     readBytes(process.stdin)
         .then((data) => {
-        const req = protobuf_1.CodeGeneratorRequest.fromBinary(data);
+        const req = (0, protobuf_1.fromBinary)(wkt_1.CodeGeneratorRequestDesc, data);
         const res = plugin.run(req);
-        return writeBytes(process.stdout, res.toBinary());
+        return writeBytes(process.stdout, (0, protobuf_1.toBinary)(wkt_1.CodeGeneratorResponseDesc, res));
     })
         .then(() => process.exit(0))
         .catch((reason) => {

package/dist/cjs/source-code-info.d.ts

@@ -0,0 +1,18 @@
+import type { DescField, DescEnumValue, DescExtension, DescComments, AnyDesc, DescFile } from "@bufbuild/protobuf";
+/**
+ * Get comments on the package element in the protobuf source.
+ */
+export declare function getPackageComments(desc: DescFile): DescComments;
+/**
+ * Get comments on the syntax element in the protobuf source.
+ */
+export declare function getSyntaxComments(desc: DescFile): DescComments;
+/**
+ * Get comments on the element in the protobuf source.
+ */
+export declare function getComments(desc: Exclude<AnyDesc, DescFile>): DescComments;
+/**
+ * Return a string that matches the definition of a field in the protobuf
+ * source. Does not take custom options into account.
+ */
+export declare function getDeclarationString(desc: DescField | DescExtension | DescEnumValue): string;

package/dist/cjs/source-code-info.js

@@ -0,0 +1,259 @@
+"use strict";
+// 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.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDeclarationString = exports.getComments = exports.getSyntaxComments = exports.getPackageComments = void 0;
+const protobuf_1 = require("@bufbuild/protobuf");
+const reflect_1 = require("@bufbuild/protobuf/reflect");
+const wkt_1 = require("@bufbuild/protobuf/wkt");
+/**
+ * Get comments on the package element in the protobuf source.
+ */
+function getPackageComments(desc) {
+    return findComments(desc.proto.sourceCodeInfo, [
+        FieldNumber.FileDescriptorProto_Package,
+    ]);
+}
+exports.getPackageComments = getPackageComments;
+/**
+ * Get comments on the syntax element in the protobuf source.
+ */
+function getSyntaxComments(desc) {
+    return findComments(desc.proto.sourceCodeInfo, [
+        FieldNumber.FileDescriptorProto_Syntax,
+    ]);
+}
+exports.getSyntaxComments = getSyntaxComments;
+/**
+ * Get comments on the element in the protobuf source.
+ */
+function getComments(desc) {
+    let path = [];
+    let file;
+    switch (desc.kind) {
+        case "enum":
+            path = desc.parent
+                ? [
+                    ...getComments(desc.parent).sourcePath,
+                    FieldNumber.DescriptorProto_EnumType,
+                    desc.parent.proto.enumType.indexOf(desc.proto),
+                ]
+                : [
+                    FieldNumber.FileDescriptorProto_EnumType,
+                    desc.file.proto.enumType.indexOf(desc.proto),
+                ];
+            file = desc.file;
+            break;
+        case "oneof":
+            path = [
+                ...getComments(desc.parent).sourcePath,
+                FieldNumber.DescriptorProto_OneofDecl,
+                desc.parent.proto.oneofDecl.indexOf(desc.proto),
+            ];
+            file = desc.parent.file;
+            break;
+        case "message":
+            path = desc.parent
+                ? [
+                    ...getComments(desc.parent).sourcePath,
+                    FieldNumber.DescriptorProto_NestedType,
+                    desc.parent.proto.nestedType.indexOf(desc.proto),
+                ]
+                : [
+                    FieldNumber.FileDescriptorProto_MessageType,
+                    desc.file.proto.messageType.indexOf(desc.proto),
+                ];
+            file = desc.file;
+            break;
+        case "enum_value":
+            path = [
+                ...getComments(desc.parent).sourcePath,
+                FieldNumber.EnumDescriptorProto_Value,
+                desc.parent.proto.value.indexOf(desc.proto),
+            ];
+            file = desc.parent.file;
+            break;
+        case "field":
+            path = [
+                ...getComments(desc.parent).sourcePath,
+                FieldNumber.DescriptorProto_Field,
+                desc.parent.proto.field.indexOf(desc.proto),
+            ];
+            file = desc.parent.file;
+            break;
+        case "extension":
+            path = desc.parent
+                ? [
+                    ...getComments(desc.parent).sourcePath,
+                    FieldNumber.DescriptorProto_Extension,
+                    desc.parent.proto.extension.indexOf(desc.proto),
+                ]
+                : [
+                    FieldNumber.FileDescriptorProto_Extension,
+                    desc.file.proto.extension.indexOf(desc.proto),
+                ];
+            file = desc.file;
+            break;
+        case "service":
+            path = [
+                FieldNumber.FileDescriptorProto_Service,
+                desc.file.proto.service.indexOf(desc.proto),
+            ];
+            file = desc.file;
+            break;
+        case "rpc":
+            path = [
+                ...getComments(desc.parent).sourcePath,
+                FieldNumber.ServiceDescriptorProto_Method,
+                desc.parent.proto.method.indexOf(desc.proto),
+            ];
+            file = desc.parent.file;
+            break;
+    }
+    return findComments(file.proto.sourceCodeInfo, path);
+}
+exports.getComments = getComments;
+/**
+ * Return a string that matches the definition of a field in the protobuf
+ * source. Does not take custom options into account.
+ */
+function getDeclarationString(desc) {
+    var _a;
+    if (desc.kind === "enum_value") {
+        let str = `${desc.name} = ${desc.number}`;
+        if (((_a = desc.proto.options) === null || _a === void 0 ? void 0 : _a.deprecated) === true) {
+            str += " [deprecated = true]";
+        }
+        return str;
+    }
+    const file = desc.kind === "extension" ? desc.file : desc.parent.file;
+    const parts = [];
+    function typeName(f) {
+        if (f.message) {
+            return f.message.typeName;
+        }
+        if (f.enum) {
+            return f.enum.typeName;
+        }
+        return reflect_1.ScalarType[f.scalar].toLowerCase();
+    }
+    switch (desc.fieldKind) {
+        case "scalar":
+        case "enum":
+        case "message":
+            if (file.edition === wkt_1.Edition.EDITION_PROTO2 &&
+                (0, protobuf_1.isFieldSet)(wkt_1.FieldDescriptorProtoDesc, desc.proto, "label") &&
+                desc.proto.label == wkt_1.FieldDescriptorProto_Label.REQUIRED) {
+                parts.push("required");
+            }
+            if (desc.optional) {
+                parts.push("optional");
+            }
+            parts.push(typeName(desc));
+            break;
+        case "list":
+            parts.push("repeated", typeName(desc));
+            break;
+        case "map": {
+            const k = reflect_1.ScalarType[desc.mapKey].toLowerCase();
+            const v = typeName(desc);
+            parts.push(`map<${k}, ${v}>`);
+            break;
+        }
+    }
+    parts.push(desc.name, "=", desc.number.toString());
+    const options = [];
+    const protoOptions = desc.proto.options;
+    if (protoOptions !== undefined &&
+        (0, protobuf_1.isFieldSet)(wkt_1.FieldOptionsDesc, protoOptions, "packed")) {
+        options.push(`packed = ${protoOptions.packed.toString()}`);
+    }
+    if ((0, protobuf_1.isFieldSet)(wkt_1.FieldDescriptorProtoDesc, desc.proto, "defaultValue")) {
+        let defaultValue = desc.proto.defaultValue;
+        if (desc.proto.type == wkt_1.FieldDescriptorProto_Type.BYTES ||
+            desc.proto.type == wkt_1.FieldDescriptorProto_Type.STRING) {
+            defaultValue = '"' + defaultValue.replace('"', '\\"') + '"';
+        }
+        options.push(`default = ${defaultValue}`);
+    }
+    if (desc.kind == "field" && desc.jsonName !== (0, reflect_1.protoCamelCase)(desc.name)) {
+        options.push(`json_name = "${desc.jsonName}"`);
+    }
+    if (protoOptions !== undefined &&
+        (0, protobuf_1.isFieldSet)(wkt_1.FieldOptionsDesc, protoOptions, "jstype")) {
+        options.push(`jstype = ${wkt_1.FieldOptions_JSType[protoOptions.jstype]}`);
+    }
+    if (protoOptions !== undefined &&
+        (0, protobuf_1.isFieldSet)(wkt_1.FieldOptionsDesc, protoOptions, "deprecated")) {
+        options.push(`deprecated = true`);
+    }
+    if (options.length > 0) {
+        parts.push("[" + options.join(", ") + "]");
+    }
+    return parts.join(" ");
+}
+exports.getDeclarationString = getDeclarationString;
+/**
+ * Find comments.
+ */
+function findComments(sourceCodeInfo, sourcePath) {
+    if (!sourceCodeInfo) {
+        return {
+            leadingDetached: [],
+            sourcePath,
+        };
+    }
+    for (const location of sourceCodeInfo.location) {
+        if (location.path.length !== sourcePath.length) {
+            continue;
+        }
+        if (location.path.some((value, index) => sourcePath[index] !== value)) {
+            continue;
+        }
+        return {
+            leadingDetached: location.leadingDetachedComments,
+            leading: (0, protobuf_1.isFieldSet)(wkt_1.SourceCodeInfo_LocationDesc, location, "leadingComments")
+                ? location.leadingComments
+                : undefined,
+            trailing: (0, protobuf_1.isFieldSet)(wkt_1.SourceCodeInfo_LocationDesc, location, "trailingComments")
+                ? location.trailingComments
+                : undefined,
+            sourcePath,
+        };
+    }
+    return {
+        leadingDetached: [],
+        sourcePath,
+    };
+}
+/**
+ * The following field numbers are used to find comments in
+ * google.protobuf.SourceCodeInfo.
+ */
+var FieldNumber;
+(function (FieldNumber) {
+    FieldNumber[FieldNumber["FileDescriptorProto_Package"] = 2] = "FileDescriptorProto_Package";
+    FieldNumber[FieldNumber["FileDescriptorProto_MessageType"] = 4] = "FileDescriptorProto_MessageType";
+    FieldNumber[FieldNumber["FileDescriptorProto_EnumType"] = 5] = "FileDescriptorProto_EnumType";
+    FieldNumber[FieldNumber["FileDescriptorProto_Service"] = 6] = "FileDescriptorProto_Service";
+    FieldNumber[FieldNumber["FileDescriptorProto_Extension"] = 7] = "FileDescriptorProto_Extension";
+    FieldNumber[FieldNumber["FileDescriptorProto_Syntax"] = 12] = "FileDescriptorProto_Syntax";
+    FieldNumber[FieldNumber["DescriptorProto_Field"] = 2] = "DescriptorProto_Field";
+    FieldNumber[FieldNumber["DescriptorProto_NestedType"] = 3] = "DescriptorProto_NestedType";
+    FieldNumber[FieldNumber["DescriptorProto_EnumType"] = 4] = "DescriptorProto_EnumType";
+    FieldNumber[FieldNumber["DescriptorProto_Extension"] = 6] = "DescriptorProto_Extension";
+    FieldNumber[FieldNumber["DescriptorProto_OneofDecl"] = 8] = "DescriptorProto_OneofDecl";
+    FieldNumber[FieldNumber["EnumDescriptorProto_Value"] = 2] = "EnumDescriptorProto_Value";
+    FieldNumber[FieldNumber["ServiceDescriptorProto_Method"] = 2] = "ServiceDescriptorProto_Method";
+})(FieldNumber || (FieldNumber = {}));

package/dist/esm/create-es-plugin.d.ts

@@ -1,7 +1,7 @@
+import type { SupportedEdition } from "@bufbuild/protobuf";
 import type { Schema } from "./ecmascript/schema.js";
 import type { FileInfo } from "./ecmascript/generated-file.js";
 import type { Plugin } from "./plugin.js";
-import type { FeatureSetDefaults } from "@bufbuild/protobuf";
 interface PluginInit {
     /**
      * Name of this code generator plugin.
@@ -17,19 +17,15 @@ interface PluginInit {
      */
     parseOption?: (key: string, value: string) => void;
     /**
-     * Whether the plugin supports editions.
+     * The earliest edition supported by this plugin. Defaults to the minimum
+     * edition supported by @bufbuild/protobuf.
      */
-    supportsEditions?: boolean;
+    minimumEdition?: SupportedEdition;
     /**
-     * By default, plugins support all editions supported by createDescriptorSet()
-     * from @bufbuild/protobuf, if supportsEditions is enabled.
-     *
-     * This option can be used to limit support for specific editions, by providing
-     * your own google.protobuf.FeatureSetDefaults generated by protoc with the
-     * flags --experimental_edition_defaults_out, --experimental_edition_defaults_minimum,
-     * and --experimental_edition_defaults_maximum.
+     * The latest edition supported by this plugin. Defaults to the maximum
+     * edition supported by @bufbuild/protobuf.
      */
-    featureSetDefaults?: FeatureSetDefaults;
+    maximumEdition?: SupportedEdition;
     /**
      * A function which will generate TypeScript files based on proto input.
      * This function will be invoked by the plugin framework when the plugin runs.

package/dist/esm/create-es-plugin.js

@@ -11,10 +11,12 @@
 // 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 { create, protoInt64 } from "@bufbuild/protobuf";
+import { minimumEdition as minimumEditionUpstream, maximumEdition as maximumEditionUpstream, } from "@bufbuild/protobuf/reflect";
+import { CodeGeneratorResponse_Feature, CodeGeneratorResponseDesc, } from "@bufbuild/protobuf/wkt";
 import { createSchema } from "./ecmascript/schema.js";
 import { transpile } from "./ecmascript/transpile.js";
 import { parseParameter } from "./ecmascript/parameter.js";
-import { CodeGeneratorResponse, CodeGeneratorResponse_Feature, protoInt64, } from "@bufbuild/protobuf";
 /**
  * Create a new code generator plugin for ECMAScript.
  * The plugin can generate JavaScript, TypeScript, or TypeScript declaration
@@ -27,9 +29,11 @@ export function createEcmaScriptPlugin(init) {
         name: init.name,
         version: init.version,
         run(req) {
-            var _a, _b;
+            var _a, _b, _c;
+            const minimumEdition = (_a = init.minimumEdition) !== null && _a !== void 0 ? _a : minimumEditionUpstream;
+            const maximumEdition = (_b = init.maximumEdition) !== null && _b !== void 0 ? _b : maximumEditionUpstream;
             const parameter = parseParameter(req.parameter, init.parseOption);
-            const schema = createSchema(req, parameter, init.name, init.version, init.featureSetDefaults);
+            const schema = createSchema(req, parameter, init.name, init.version, minimumEdition, maximumEdition);
             const targetTs = schema.targets.includes("ts");
             const targetJs = schema.targets.includes("js");
             const targetDts = schema.targets.includes("dts");
@@ -88,23 +92,21 @@ export function createEcmaScriptPlugin(init) {
             // but no generate function was provided.  This also means that we will
             // have generated .ts files above.
             if (transpileJs || transpileDts) {
-                const transpileFn = (_a = init.transpile) !== null && _a !== void 0 ? _a : transpile;
+                const transpileFn = (_c = init.transpile) !== null && _c !== void 0 ? _c : transpile;
                 // Transpile the TypeScript files and add to the master list of files
                 const transpiledFiles = transpileFn(tsFiles, transpileJs, transpileDts, parameter.jsImportStyle);
                 files.push(...transpiledFiles);
             }
-            return toResponse(files, (_b = init.supportsEditions) !== null && _b !== void 0 ? _b : false);
+            return toResponse(files, minimumEdition, maximumEdition);
         },
     };
 }
-function toResponse(files, supportsEditions) {
-    let supportedFeatures = CodeGeneratorResponse_Feature.PROTO3_OPTIONAL;
-    if (supportsEditions) {
-        supportedFeatures =
-            supportedFeatures | CodeGeneratorResponse_Feature.SUPPORTS_EDITIONS;
-    }
-    return new CodeGeneratorResponse({
-        supportedFeatures: protoInt64.parse(supportedFeatures),
+function toResponse(files, minimumEdition, maximumEdition) {
+    return create(CodeGeneratorResponseDesc, {
+        supportedFeatures: protoInt64.parse(CodeGeneratorResponse_Feature.PROTO3_OPTIONAL |
+            CodeGeneratorResponse_Feature.SUPPORTS_EDITIONS),
+        minimumEdition,
+        maximumEdition,
         file: files.map((f) => {
             if (f.preamble !== undefined) {
                 f.content = f.preamble + "\n" + f.content;

package/dist/esm/ecmascript/file-preamble.js

@@ -11,7 +11,8 @@
 // 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 { Edition } from "@bufbuild/protobuf";
+import { Edition } from "@bufbuild/protobuf/wkt";
+import { getPackageComments, getSyntaxComments } from "../source-code-info.js";
 export function makeFilePreamble(file, pluginName, pluginVersion, parameter, tsNoCheck) {
     const builder = [];
     const trimSuffix = (str, suffix) => str.endsWith(suffix) ? str.substring(0, str.length - suffix.length) : str;
@@ -31,14 +32,14 @@ export function makeFilePreamble(file, pluginName, pluginVersion, parameter, tsN
             builder.push("\n");
         }
     };
-    writeLeadingComments(file.getSyntaxComments());
+    writeLeadingComments(getSyntaxComments(file));
     builder.push(`// @generated by ${pluginName} ${pluginVersion}`);
     if (parameter !== "") {
         builder.push(` with parameter "${parameter}"`);
     }
     builder.push("\n");
     builder.push(`// @generated from file ${file.name}.proto (`);
-    if (file.proto.package !== undefined) {
+    if (file.proto.package.length > 0) {
         builder.push(`package ${file.proto.package}, `);
     }
     switch (file.edition) {
@@ -65,6 +66,6 @@ export function makeFilePreamble(file, pluginName, pluginVersion, parameter, tsN
         builder.push("// @ts-nocheck\n");
     }
     builder.push("\n");
-    writeLeadingComments(file.getPackageComments());
+    writeLeadingComments(getPackageComments(file));
     return trimSuffix(builder.join(""), "\n");
 }

package/dist/esm/ecmascript/generated-file.d.ts

@@ -1,12 +1,7 @@
-import type { AnyDesc, DescEnum, DescExtension, DescFile, DescMessage } from "@bufbuild/protobuf";
+import type { AnyDesc, DescEnum, DescExtension, DescFile, DescMessage, DescService } from "@bufbuild/protobuf";
 import type { ImportSymbol } from "./import-symbol.js";
+import type { Printable } from "./printable.js";
 import type { RuntimeImports } from "./runtime-imports.js";
-import type { JSDocBlock } from "./jsdoc.js";
-import type { ExportDeclaration, LiteralProtoInt64, LiteralString, RefDescEnum, RefDescMessage } from "./opaque-printables.js";
-/**
- * All types that can be passed to GeneratedFile.print()
- */
-export type Printable = string | number | boolean | bigint | Uint8Array | ImportSymbol | ExportDeclaration | JSDocBlock | LiteralString | LiteralProtoInt64 | RefDescMessage | RefDescEnum | DescMessage | DescEnum | DescExtension | Printable[];
 /**
  * FileInfo represents an intermediate type using for transpiling TypeScript internally.
  */
@@ -49,10 +44,6 @@ export interface GeneratedFile {
      * See print(Printable[]) for behavior when printing Printable items.
      */
     print(fragments: TemplateStringsArray, ...printables: Printable[]): void;
-    /**
-     * @deprecated Please use createImportSymbol() from @bufbuild/protoplugin/ecmascript instead
-     */
-    export(name: string): ImportSymbol;
     /**
      * Create a string literal.
      */
@@ -61,13 +52,13 @@ export interface GeneratedFile {
      * Create a JSDoc comment block with the given text. Line breaks and white-space
      * stay intact.
      */
-    jsDoc(text: string, indentation?: string): JSDocBlock;
+    jsDoc(text: string, indentation?: string): Printable;
     /**
      * Create a JSDoc comment block for the given message, enumeration, or other
      * descriptor. The comment block will contain the original comments from the
      * protobuf source, and annotations such as `@generated from message MyMessage`.
      */
-    jsDoc(desc: Exclude<AnyDesc, DescFile>, indentation?: string): JSDocBlock;
+    jsDoc(desc: Exclude<AnyDesc, DescFile>, indentation?: string): Printable;
     /**
      * Create a printable export statement. For example:
      *
@@ -84,11 +75,15 @@ export interface GeneratedFile {
      * statement. If the plugin option `js_import_style=legacy_commonjs` is set,
      * exports will automatically be generated for CommonJS.
      */
-    exportDecl(declaration: string, name: string | DescMessage | DescEnum | DescExtension): Printable;
+    exportDecl(declaration: string, name: string): Printable;
     /**
      * Import a message or enumeration generated by protoc-gen-es.
      */
-    import(type: DescMessage | DescEnum | DescExtension): ImportSymbol;
+    importShape(desc: DescMessage | DescEnum): ImportSymbol;
+    /**
+     * Import a descriptor generated by protoc-gen-es.
+     */
+    importDesc(desc: DescMessage | DescEnum | DescExtension | DescService | DescFile, typeOnly?: boolean): ImportSymbol;
     /**
      * Import any symbol from a file or package.
      *
@@ -105,12 +100,16 @@ export interface GeneratedFile {
      * formulate your own imports and exports based on this property.
      */
     readonly jsImportStyle: "module" | "legacy_commonjs";
+    /**
+     * Provides some symbols from the runtime library @bufbuild/protobuf.
+     */
+    readonly runtime: RuntimeImports;
 }
 export interface GeneratedFileController extends GeneratedFile {
     getFileInfo(): FileInfo;
 }
-type CreateTypeImportFn = (desc: DescMessage | DescEnum | DescExtension) => ImportSymbol;
-type RewriteImportPathFn = (path: string) => string;
-type CreatePreambleFn = (descFile: DescFile) => string;
-export declare function createGeneratedFile(name: string, importPath: string, jsImportStyle: "module" | "legacy_commonjs", rewriteImportPath: RewriteImportPathFn, createTypeImport: CreateTypeImportFn, runtimeImports: RuntimeImports, createPreamble: CreatePreambleFn): GeneratedFileController;
-export {};
+export type ResolveDescImportFn = (desc: DescMessage | DescEnum | DescExtension | DescService | DescFile, typeOnly?: boolean) => ImportSymbol;
+export type ResolveShapeImportFn = (desc: DescMessage | DescEnum) => ImportSymbol;
+export type RewriteImportFn = (path: string) => string;
+export type CreatePreambleFn = (descFile: DescFile) => string;
+export declare function createGeneratedFile(name: string, importPath: string, jsImportStyle: "module" | "legacy_commonjs", rewriteImport: RewriteImportFn, resolveDescImport: ResolveDescImportFn, resolveShapeImport: ResolveShapeImportFn, createPreamble: CreatePreambleFn, runtime: RuntimeImports): GeneratedFileController;