@bufbuild/protoplugin 2.0.0-alpha.3 → 2.0.0-beta.1

package/dist/cjs/schema.js

@@ -27,30 +27,32 @@ function createSchema(request, parameter, pluginName, pluginVersion, minimumEdit
     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);
+    const runtime = (0, runtime_imports_js_1.createRuntimeImports)(parameter.parsed.bootstrapWkt);
+    const resolveDescImport = (desc, typeOnly) => (0, import_symbol_js_1.createImportSymbol)((0, names_js_1.generatedDescName)(desc), (0, names_js_1.generateFilePath)(desc.kind == "file" ? desc : desc.file, parameter.parsed.bootstrapWkt, filesToGenerate), typeOnly);
+    const resolveShapeImport = (desc) => (0, import_symbol_js_1.createImportSymbol)((0, names_js_1.generatedShapeName)(desc), (0, names_js_1.generateFilePath)(desc.file, parameter.parsed.bootstrapWkt, filesToGenerate), true);
+    const resolveJsonImport = (desc) => (0, import_symbol_js_1.createImportSymbol)((0, names_js_1.generatedJsonTypeName)(desc), (0, names_js_1.generateFilePath)(desc.file, parameter.parsed.bootstrapWkt, filesToGenerate), true);
+    const createPreamble = (descFile) => (0, file_preamble_js_1.makeFilePreamble)(descFile, pluginName, pluginVersion, parameter.sanitized, parameter.parsed.tsNocheck);
+    const rewriteImport = (importPath) => (0, import_path_js_1.rewriteImportPath)(importPath, parameter.parsed.rewriteImports, parameter.parsed.importExtension);
     return {
-        targets: parameter.targets,
+        targets: parameter.parsed.targets,
         proto: request,
         files: filesToGenerate,
         allFiles: allFiles,
+        options: parameter.parsed,
         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
-            rewriteImport, resolveDescImport, resolveShapeImport, createPreamble, runtime);
+            const genFile = (0, generated_file_js_1.createGeneratedFile)(name, (0, import_path_js_1.deriveImportPath)(name), target === "js" ? parameter.parsed.jsImportStyle : "module", // ts and dts always use import/export, only js may use commonjs
+            rewriteImport, resolveDescImport, resolveShapeImport, resolveJsonImport, createPreamble, runtime);
             generatedFiles.push(genFile);
             return genFile;
         },
         getFileInfo() {
             return generatedFiles
                 .map((f) => f.getFileInfo())
-                .filter((fi) => parameter.keepEmptyFiles || fi.content.length > 0);
+                .filter((fi) => parameter.parsed.keepEmptyFiles || fi.content.length > 0);
         },
         prepareGenerate(newTarget) {
             target = newTarget;
@@ -100,7 +102,7 @@ function getFilesToGenerate(request, minimumEdition, maximumEdition) {
         const sourceFile = request.sourceFileDescriptors.find((s) => s.name == protoFile.name);
         return sourceFile !== null && sourceFile !== void 0 ? sourceFile : protoFile;
     });
-    const registry = (0, protobuf_1.createFileRegistry)((0, protobuf_1.create)(wkt_1.FileDescriptorSetDesc, {
+    const registry = (0, protobuf_1.createFileRegistry)((0, protobuf_1.create)(wkt_1.FileDescriptorSetSchema, {
         file: allProtoWithSourceOptions,
     }));
     const allFiles = [];

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

@@ -22,7 +22,7 @@ const wkt_1 = require("@bufbuild/protobuf/wkt");
  */
 function getPackageComments(desc) {
     return findComments(desc.proto.sourceCodeInfo, [
-        wkt_1.FileDescriptorProtoDesc.field.package.number,
+        wkt_1.FileDescriptorProtoSchema.field.package.number,
     ]);
 }
 exports.getPackageComments = getPackageComments;
@@ -31,7 +31,7 @@ exports.getPackageComments = getPackageComments;
  */
 function getSyntaxComments(desc) {
     return findComments(desc.proto.sourceCodeInfo, [
-        wkt_1.FileDescriptorProtoDesc.field.syntax.number,
+        wkt_1.FileDescriptorProtoSchema.field.syntax.number,
     ]);
 }
 exports.getSyntaxComments = getSyntaxComments;
@@ -46,11 +46,11 @@ function getComments(desc) {
             path = desc.parent
                 ? [
                     ...getComments(desc.parent).sourcePath,
-                    wkt_1.DescriptorProtoDesc.field.enumType.number,
+                    wkt_1.DescriptorProtoSchema.field.enumType.number,
                     desc.parent.proto.enumType.indexOf(desc.proto),
                 ]
                 : [
-                    wkt_1.FileDescriptorProtoDesc.field.enumType.number,
+                    wkt_1.FileDescriptorProtoSchema.field.enumType.number,
                     desc.file.proto.enumType.indexOf(desc.proto),
                 ];
             file = desc.file;
@@ -58,7 +58,7 @@ function getComments(desc) {
         case "oneof":
             path = [
                 ...getComments(desc.parent).sourcePath,
-                wkt_1.DescriptorProtoDesc.field.oneofDecl.number,
+                wkt_1.DescriptorProtoSchema.field.oneofDecl.number,
                 desc.parent.proto.oneofDecl.indexOf(desc.proto),
             ];
             file = desc.parent.file;
@@ -67,11 +67,11 @@ function getComments(desc) {
             path = desc.parent
                 ? [
                     ...getComments(desc.parent).sourcePath,
-                    wkt_1.DescriptorProtoDesc.field.nestedType.number,
+                    wkt_1.DescriptorProtoSchema.field.nestedType.number,
                     desc.parent.proto.nestedType.indexOf(desc.proto),
                 ]
                 : [
-                    wkt_1.FileDescriptorProtoDesc.field.messageType.number,
+                    wkt_1.FileDescriptorProtoSchema.field.messageType.number,
                     desc.file.proto.messageType.indexOf(desc.proto),
                 ];
             file = desc.file;
@@ -79,7 +79,7 @@ function getComments(desc) {
         case "enum_value":
             path = [
                 ...getComments(desc.parent).sourcePath,
-                wkt_1.EnumDescriptorProtoDesc.field.value.number,
+                wkt_1.EnumDescriptorProtoSchema.field.value.number,
                 desc.parent.proto.value.indexOf(desc.proto),
             ];
             file = desc.parent.file;
@@ -87,7 +87,7 @@ function getComments(desc) {
         case "field":
             path = [
                 ...getComments(desc.parent).sourcePath,
-                wkt_1.DescriptorProtoDesc.field.field.number,
+                wkt_1.DescriptorProtoSchema.field.field.number,
                 desc.parent.proto.field.indexOf(desc.proto),
             ];
             file = desc.parent.file;
@@ -96,18 +96,18 @@ function getComments(desc) {
             path = desc.parent
                 ? [
                     ...getComments(desc.parent).sourcePath,
-                    wkt_1.DescriptorProtoDesc.field.extension.number,
+                    wkt_1.DescriptorProtoSchema.field.extension.number,
                     desc.parent.proto.extension.indexOf(desc.proto),
                 ]
                 : [
-                    wkt_1.FileDescriptorProtoDesc.field.extension.number,
+                    wkt_1.FileDescriptorProtoSchema.field.extension.number,
                     desc.file.proto.extension.indexOf(desc.proto),
                 ];
             file = desc.file;
             break;
         case "service":
             path = [
-                wkt_1.FileDescriptorProtoDesc.field.service.number,
+                wkt_1.FileDescriptorProtoSchema.field.service.number,
                 desc.file.proto.service.indexOf(desc.proto),
             ];
             file = desc.file;
@@ -115,7 +115,7 @@ function getComments(desc) {
         case "rpc":
             path = [
                 ...getComments(desc.parent).sourcePath,
-                wkt_1.ServiceDescriptorProtoDesc.field.method.number,
+                wkt_1.ServiceDescriptorProtoSchema.field.method.number,
                 desc.parent.proto.method.indexOf(desc.proto),
             ];
             file = desc.parent.file;
@@ -133,7 +133,7 @@ function getFeatureOptionStrings(desc) {
     const strings = [];
     const features = (_a = desc.proto.options) === null || _a === void 0 ? void 0 : _a.features;
     if (features !== undefined) {
-        const r = (0, reflect_1.reflect)(wkt_1.FeatureSetDesc, features);
+        const r = (0, reflect_1.reflect)(wkt_1.FeatureSetSchema, features);
         for (const f of r.fields) {
             if (f.fieldKind != "enum" || !r.isSet(f)) {
                 continue;
@@ -197,10 +197,10 @@ function getDeclarationString(desc) {
     const options = [];
     const protoOptions = desc.proto.options;
     if (protoOptions !== undefined &&
-        (0, protobuf_1.isFieldSet)(protoOptions, wkt_1.FieldOptionsDesc.field.packed)) {
+        (0, protobuf_1.isFieldSet)(protoOptions, wkt_1.FieldOptionsSchema.field.packed)) {
         options.push(`packed = ${protoOptions.packed.toString()}`);
     }
-    if ((0, protobuf_1.isFieldSet)(desc.proto, wkt_1.FieldDescriptorProtoDesc.field.defaultValue)) {
+    if ((0, protobuf_1.isFieldSet)(desc.proto, wkt_1.FieldDescriptorProtoSchema.field.defaultValue)) {
         let defaultValue = desc.proto.defaultValue;
         if (desc.proto.type == wkt_1.FieldDescriptorProto_Type.BYTES ||
             desc.proto.type == wkt_1.FieldDescriptorProto_Type.STRING) {
@@ -212,11 +212,11 @@ function getDeclarationString(desc) {
         options.push(`json_name = "${desc.jsonName}"`);
     }
     if (protoOptions !== undefined &&
-        (0, protobuf_1.isFieldSet)(protoOptions, wkt_1.FieldOptionsDesc.field.jstype)) {
+        (0, protobuf_1.isFieldSet)(protoOptions, wkt_1.FieldOptionsSchema.field.jstype)) {
         options.push(`jstype = ${wkt_1.FieldOptions_JSType[protoOptions.jstype]}`);
     }
     if (protoOptions !== undefined &&
-        (0, protobuf_1.isFieldSet)(protoOptions, wkt_1.FieldOptionsDesc.field.deprecated)) {
+        (0, protobuf_1.isFieldSet)(protoOptions, wkt_1.FieldOptionsSchema.field.deprecated)) {
         options.push(`deprecated = true`);
     }
     options.push(...getFeatureOptionStrings(desc));
@@ -270,10 +270,10 @@ function findComments(sourceCodeInfo, sourcePath) {
         }
         return {
             leadingDetached: location.leadingDetachedComments,
-            leading: (0, protobuf_1.isFieldSet)(location, wkt_1.SourceCodeInfo_LocationDesc.field.leadingComments)
+            leading: (0, protobuf_1.isFieldSet)(location, wkt_1.SourceCodeInfo_LocationSchema.field.leadingComments)
                 ? location.leadingComments
                 : undefined,
-            trailing: (0, protobuf_1.isFieldSet)(location, wkt_1.SourceCodeInfo_LocationDesc.field.trailingComments)
+            trailing: (0, protobuf_1.isFieldSet)(location, wkt_1.SourceCodeInfo_LocationSchema.field.trailingComments)
                 ? location.trailingComments
                 : undefined,
             sourcePath,

package/dist/cjs/transpile.js

@@ -26,7 +26,7 @@ const defaultOptions = {
     strict: false,
     // modules
     module: typescript_1.default.ModuleKind.ES2020,
-    moduleResolution: typescript_1.default.ModuleResolutionKind.NodeJs,
+    moduleResolution: typescript_1.default.ModuleResolutionKind.Node10,
     noResolve: true,
     resolveJsonModule: false,
     // emit
@@ -39,7 +39,7 @@ const defaultOptions = {
     checkJs: false,
     // Language and Environment
     lib: [],
-    moduleDetection: "force",
+    moduleDetection: typescript_1.default.ModuleDetectionKind.Force,
     target: typescript_1.default.ScriptTarget.ES2017,
     // Completeness
     skipLibCheck: true,

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

@@ -2,7 +2,8 @@ import { type SupportedEdition } from "@bufbuild/protobuf";
 import type { Schema } from "./schema.js";
 import type { FileInfo } from "./generated-file.js";
 import type { Plugin } from "./plugin.js";
-interface PluginInit {
+import type { RawPluginOptions } from "./parameter.js";
+interface PluginInit<Options extends object> {
     /**
      * Name of this code generator plugin.
      */
@@ -15,7 +16,7 @@ interface PluginInit {
      * An optional parsing function which can be used to parse your own plugin
      * options.
      */
-    parseOption?: (key: string, value: string) => void;
+    parseOptions?: (rawOptions: RawPluginOptions) => Options;
     /**
      * The earliest edition supported by this plugin. Defaults to the minimum
      * edition supported by @bufbuild/protobuf.
@@ -32,7 +33,7 @@ interface PluginInit {
      *
      * Note that this is required to be provided for plugin initialization.
      */
-    generateTs: (schema: Schema, target: "ts") => void;
+    generateTs: (schema: Schema<Options>, target: "ts") => void;
     /**
      * A optional function which will generate JavaScript files based on proto
      * input.  This function will be invoked by the  plugin framework when the
@@ -43,7 +44,7 @@ interface PluginInit {
      * JavaScript files.  If not, the plugin framework will transpile the files
      * itself.
      */
-    generateJs?: (schema: Schema, target: "js") => void;
+    generateJs?: (schema: Schema<Options>, target: "js") => void;
     /**
      * A optional function which will generate TypeScript declaration files
      * based on proto input.  This function will be invoked by the plugin
@@ -54,7 +55,7 @@ interface PluginInit {
      * declaration files.  If not, the plugin framework will transpile the files
      * itself.
      */
-    generateDts?: (schema: Schema, target: "dts") => void;
+    generateDts?: (schema: Schema<Options>, target: "dts") => void;
     /**
      * An optional function which will transpile a given set of files.
      *
@@ -75,5 +76,5 @@ interface PluginInit {
  * The plugin can generate JavaScript, TypeScript, or TypeScript declaration
  * files.
  */
-export declare function createEcmaScriptPlugin(init: PluginInit): Plugin;
+export declare function createEcmaScriptPlugin<Options extends object = object>(init: PluginInit<Options>): Plugin;
 export {};

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

@@ -13,7 +13,7 @@
 // limitations under the License.
 import { create, protoInt64 } from "@bufbuild/protobuf";
 import { minimumEdition as minimumEditionUpstream, maximumEdition as maximumEditionUpstream, } from "@bufbuild/protobuf";
-import { CodeGeneratorResponse_Feature, CodeGeneratorResponseDesc, } from "@bufbuild/protobuf/wkt";
+import { CodeGeneratorResponse_Feature, CodeGeneratorResponseSchema, } from "@bufbuild/protobuf/wkt";
 import { createSchema } from "./schema.js";
 import { transpile } from "./transpile.js";
 import { parseParameter } from "./parameter.js";
@@ -32,7 +32,7 @@ export function createEcmaScriptPlugin(init) {
             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 parameter = parseParameter(req.parameter, init.parseOptions);
             const schema = createSchema(req, parameter, init.name, init.version, minimumEdition, maximumEdition);
             const targetTs = schema.targets.includes("ts");
             const targetJs = schema.targets.includes("js");
@@ -94,7 +94,7 @@ export function createEcmaScriptPlugin(init) {
             if (transpileJs || transpileDts) {
                 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);
+                const transpiledFiles = transpileFn(tsFiles, transpileJs, transpileDts, parameter.parsed.jsImportStyle);
                 files.push(...transpiledFiles);
             }
             return toResponse(files, minimumEdition, maximumEdition);
@@ -102,7 +102,7 @@ export function createEcmaScriptPlugin(init) {
     };
 }
 function toResponse(files, minimumEdition, maximumEdition) {
-    return create(CodeGeneratorResponseDesc, {
+    return create(CodeGeneratorResponseSchema, {
         supportedFeatures: protoInt64.parse(CodeGeneratorResponse_Feature.PROTO3_OPTIONAL |
             CodeGeneratorResponse_Feature.SUPPORTS_EDITIONS),
         minimumEdition,

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

@@ -58,7 +58,7 @@ export interface GeneratedFile {
      * 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): Printable;
+    jsDoc(schema: Exclude<AnyDesc, DescFile>, indentation?: string): Printable;
     /**
      * Create a printable export statement. For example:
      *
@@ -79,11 +79,18 @@ export interface GeneratedFile {
     /**
      * Import a message or enumeration generated by protoc-gen-es.
      */
-    importShape(desc: DescMessage | DescEnum): ImportSymbol;
+    importShape(schema: DescMessage | DescEnum): ImportSymbol;
+    /**
+     * Import a message or enumeration JSON type generated by protoc-gen-es.
+     *
+     * Note that protoc-gen-es only generates JSON types with the plugin option
+     * `json_types=true`.
+     */
+    importJson(desc: DescMessage | DescEnum): ImportSymbol;
     /**
      * Import a descriptor generated by protoc-gen-es.
      */
-    importDesc(desc: DescMessage | DescEnum | DescExtension | DescService | DescFile, typeOnly?: boolean): ImportSymbol;
+    importSchema(schema: DescMessage | DescEnum | DescExtension | DescService | DescFile, typeOnly?: boolean): ImportSymbol;
     /**
      * Import any symbol from a file or package.
      *
@@ -94,10 +101,15 @@ export interface GeneratedFile {
      * relative to the project root. The import path is automatically made
      * relative to the current file.
      */
-    import(name: string, from: string): ImportSymbol;
+    import(name: string, from: string, typeOnly?: boolean): ImportSymbol;
     /**
      * In case you need full control over exports and imports, use print() and
      * formulate your own imports and exports based on this property.
+     *
+     * With the plugin option `js_import_style=legacy_commonjs`, this property
+     * reports "legacy_commonjs", but only if the current target is "js".
+     * This matches the behavior of import(), which also only generates CommonJS
+     * under this condition.
      */
     readonly jsImportStyle: "module" | "legacy_commonjs";
     /**
@@ -112,4 +124,4 @@ export type ResolveDescImportFn = (desc: DescMessage | DescEnum | DescExtension
 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;
+export declare function createGeneratedFile(name: string, importPath: string, jsImportStyle: "module" | "legacy_commonjs", rewriteImport: RewriteImportFn, resolveDescImport: ResolveDescImportFn, resolveShapeImport: ResolveShapeImportFn, resolveJsonImport: ResolveShapeImportFn, createPreamble: CreatePreambleFn, runtime: RuntimeImports): GeneratedFileController;

package/dist/esm/generated-file.js

@@ -15,7 +15,7 @@ import { protoInt64, ScalarType, } from "@bufbuild/protobuf";
 import { createImportSymbol } from "./import-symbol.js";
 import { makeImportPathRelative } from "./import-path.js";
 import { createJsDocTextFromDesc, formatJsDocBlock } from "./jsdoc.js";
-export function createGeneratedFile(name, importPath, jsImportStyle, rewriteImport, resolveDescImport, resolveShapeImport, createPreamble, runtime) {
+export function createGeneratedFile(name, importPath, jsImportStyle, rewriteImport, resolveDescImport, resolveShapeImport, resolveJsonImport, createPreamble, runtime) {
     let preamble;
     const el = [];
     return {
@@ -41,6 +41,7 @@ export function createGeneratedFile(name, importPath, jsImportStyle, rewriteImpo
                 runtime,
                 resolveDescImport,
                 resolveShapeImport,
+                resolveJsonImport,
             }, printables);
             el.push("\n");
         },
@@ -57,23 +58,26 @@ export function createGeneratedFile(name, importPath, jsImportStyle, rewriteImpo
                 value: string,
             };
         },
-        jsDoc(textOrDesc, indentation) {
+        jsDoc(textOrSchema, indentation) {
             return {
                 kind: "es_jsdoc",
-                text: typeof textOrDesc == "string"
-                    ? textOrDesc
-                    : createJsDocTextFromDesc(textOrDesc),
+                text: typeof textOrSchema == "string"
+                    ? textOrSchema
+                    : createJsDocTextFromDesc(textOrSchema),
                 indentation,
             };
         },
-        importDesc(desc, typeOnly = false) {
-            return resolveDescImport(desc, typeOnly);
+        importSchema(schema, typeOnly = false) {
+            return resolveDescImport(schema, typeOnly);
         },
-        importShape(desc) {
-            return resolveShapeImport(desc);
+        importShape(schema) {
+            return resolveShapeImport(schema);
         },
-        import(name, from) {
-            return createImportSymbol(name, from);
+        importJson(desc) {
+            return resolveJsonImport(desc);
+        },
+        import(name, from, typeOnly = false) {
+            return createImportSymbol(name, from, typeOnly);
         },
         jsImportStyle,
         runtime,
@@ -219,6 +223,9 @@ function printableToEl(opt, printables) {
                         case "es_shape_ref":
                             el.push(opt.resolveShapeImport(p.desc));
                             break;
+                        case "es_json_type_ref":
+                            el.push(opt.resolveJsonImport(p.desc));
+                            break;
                         case "es_jsdoc":
                             el.push(formatJsDocBlock(p.text, p.indentation));
                             break;

package/dist/esm/index.d.ts

@@ -4,6 +4,7 @@ export { createEcmaScriptPlugin } from "./create-es-plugin.js";
 export { getComments, getDeclarationString, getPackageComments, getSyntaxComments, } from "./source-code-info.js";
 export type { Target } from "./target.js";
 export type { Schema } from "./schema.js";
+export type { EcmaScriptPluginOptions } from "./parameter.js";
 export type { GeneratedFile, FileInfo } from "./generated-file.js";
 export type { ImportSymbol } from "./import-symbol.js";
 export { createImportSymbol } from "./import-symbol.js";

package/dist/esm/names.d.ts

@@ -1,4 +1,17 @@
 import type { DescEnum, DescExtension, DescFile, DescMessage, DescService } from "@bufbuild/protobuf";
+/**
+ * Return a file path for the give file descriptor.
+ */
 export declare function generateFilePath(file: DescFile, bootstrapWkt: boolean, filesToGenerate: DescFile[]): string;
-export declare function localDescName(desc: DescFile | DescEnum | DescMessage | DescExtension | DescService): string;
-export declare function localShapeName(desc: DescEnum | DescMessage): string;
+/**
+ * Return a safe identifier for a generated descriptor.
+ */
+export declare function generatedDescName(desc: DescFile | DescEnum | DescMessage | DescExtension | DescService): string;
+/**
+ * Return a safe identifier for a generated shape.
+ */
+export declare function generatedShapeName(desc: DescEnum | DescMessage): string;
+/**
+ * Return a safe identifier for a generated JSON type.
+ */
+export declare function generatedJsonTypeName(desc: DescEnum | DescMessage): string;

package/dist/esm/names.js

@@ -14,6 +14,9 @@
 import { wktPublicImportPaths } from "@bufbuild/protobuf/codegenv1";
 import { nestedTypes } from "@bufbuild/protobuf/reflect";
 import { safeIdentifier } from "./safe-identifier.js";
+/**
+ * Return a file path for the give file descriptor.
+ */
 export function generateFilePath(file, bootstrapWkt, filesToGenerate) {
     // Well-known types are published with the runtime package. We usually want
     // the generated code to import them from the runtime package, with the
@@ -30,84 +33,155 @@ export function generateFilePath(file, bootstrapWkt, filesToGenerate) {
     }
     return "./" + file.name + "_pb.js";
 }
-export function localDescName(desc) {
+/**
+ * Return a safe identifier for a generated descriptor.
+ */
+export function generatedDescName(desc) {
     const file = desc.kind == "file" ? desc : desc.file;
     const { descNames } = allNames(file);
     const name = descNames.get(desc);
     if (name === undefined) {
-        throw new Error(`unable to determine unique identifier for ${desc.toString()}`);
+        throw new Error(`unable to determine unique descriptor name for ${desc.toString()}`);
     }
     return name;
 }
-export function localShapeName(desc) {
+/**
+ * Return a safe identifier for a generated shape.
+ */
+export function generatedShapeName(desc) {
     const { shapeNames } = allNames(desc.file);
     const name = shapeNames.get(desc);
     if (name === undefined) {
-        throw new Error(`unable to determine unique identifier for ${desc.toString()}`);
+        throw new Error(`unable to determine unique shape name for ${desc.toString()}`);
     }
     return name;
 }
+/**
+ * Return a safe identifier for a generated JSON type.
+ */
+export function generatedJsonTypeName(desc) {
+    const { jsonTypeNames } = allNames(desc.file);
+    const name = jsonTypeNames.get(desc);
+    if (name === undefined) {
+        throw new Error(`unable to determine unique json type name for ${desc.toString()}`);
+    }
+    return name;
+}
+/**
+ * Compute the ideal name for a generated descriptor.
+ */
 function idealDescName(desc, i) {
     const escape = i === 0 ? "" : i === 1 ? "$" : `$${i - 1}`;
+    if (desc.kind == "file") {
+        const name = "file_" + desc.name.replace(/[^a-zA-Z0-9_]+/g, "_");
+        return safeIdentifier(name + escape);
+    }
     switch (desc.kind) {
-        case "file":
-            return (safeIdentifier("fileDesc_" + desc.name.replace(/[^a-zA-Z0-9_]+/g, "_")) + escape);
         case "enum":
-            return baseName(desc) + "Desc" + escape;
+            return safeIdentifier(identifier(desc) + "Schema" + escape);
         case "message":
-            return baseName(desc) + "Desc" + escape;
+            return safeIdentifier(identifier(desc) + "Schema" + escape);
         case "extension":
-            return baseName(desc) + escape;
+            return safeIdentifier(identifier(desc) + escape);
         case "service":
-            return baseName(desc) + escape;
+            return safeIdentifier(identifier(desc) + escape);
     }
 }
+/**
+ * Compute the ideal name for a generated shape.
+ */
 function idealShapeName(desc, i) {
     const escape = i === 0 ? "" : i === 1 ? "$" : `$${i - 1}`;
-    return baseName(desc) + escape;
+    return safeIdentifier(identifier(desc) + escape);
 }
-function baseName(desc) {
+/**
+ * Compute the ideal name for a generated JSON type.
+ */
+function idealJsonTypeName(desc, i) {
+    const escape = i === 0 ? "" : i === 1 ? "$" : `$${i - 1}`;
+    return safeIdentifier(identifier(desc) + "Json" + escape);
+}
+/**
+ * Return an identifier for the given descriptor based on its type name.
+ *
+ * The type name for a protobuf message is the package name (if any), plus
+ * the names of parent messages it is nested in (if any), plus the name of
+ * the element, separated by dots. For example: foo.bar.ParentMsg.MyEnum.
+ *
+ * ECMAScript does not have packages or namespaces, so we need a single
+ * identifier. Our convention is to drop the package name, and to join other
+ * parts of the name with an underscore. For example: ParentMsg_MyEnum.
+ */
+function identifier(desc) {
     const pkg = desc.file.proto.package;
     const offset = pkg.length > 0 ? pkg.length + 1 : 0;
-    const name = desc.typeName.substring(offset).replace(/\./g, "_");
-    return safeIdentifier(name);
+    const nameWithoutPkg = desc.typeName.substring(offset);
+    return nameWithoutPkg.replace(/\./g, "_");
 }
+/**
+ * Compute all ideal names for the elements in the file, resolving name clashes.
+ */
 function allNames(file) {
     const taken = new Set();
+    // In the first pass, register shape names
     const shapeNames = new Map();
+    for (const desc of nestedTypes(file)) {
+        if (desc.kind != "enum" && desc.kind != "message") {
+            continue;
+        }
+        let name;
+        for (let i = 0;; i++) {
+            name = idealShapeName(desc, i);
+            if (!taken.has(name)) {
+                break;
+            }
+        }
+        taken.add(name);
+        shapeNames.set(desc, name);
+    }
+    // In the second pass, register desc names
     const descNames = new Map();
     for (const desc of [file, ...nestedTypes(file)]) {
+        let name;
         switch (desc.kind) {
             case "enum":
             case "message": {
-                let descName;
-                let shapeName;
                 for (let i = 0;; i++) {
-                    descName = idealDescName(desc, i);
-                    shapeName = idealShapeName(desc, i);
-                    if (!taken.has(descName) && !taken.has(shapeName)) {
+                    name = idealDescName(desc, i);
+                    if (!taken.has(name)) {
                         break;
                     }
                 }
-                taken.add(descName);
-                taken.add(shapeName);
-                descNames.set(desc, descName);
-                shapeNames.set(desc, shapeName);
                 break;
             }
             default: {
-                let descName;
                 for (let i = 0;; i++) {
-                    descName = idealDescName(desc, i);
-                    if (!taken.has(descName)) {
+                    name = idealDescName(desc, i);
+                    if (!taken.has(name)) {
                         break;
                     }
                 }
-                taken.add(descName);
-                descNames.set(desc, descName);
                 break;
             }
         }
+        taken.add(name);
+        descNames.set(desc, name);
+    }
+    // In the third pass, register json type names
+    const jsonTypeNames = new Map();
+    for (const desc of nestedTypes(file)) {
+        if (desc.kind != "enum" && desc.kind != "message") {
+            continue;
+        }
+        let name;
+        for (let i = 0;; i++) {
+            name = idealJsonTypeName(desc, i);
+            if (!taken.has(name)) {
+                break;
+            }
+        }
+        taken.add(name);
+        jsonTypeNames.set(desc, name);
     }
-    return { shapeNames, descNames };
+    return { shapeNames, jsonTypeNames, descNames };
 }