@bufbuild/protoplugin 1.5.0 → 1.6.0

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

@@ -11,9 +11,10 @@
 // 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 { createSchema, toResponse } from "./ecmascript/schema.js";
+import { createSchema } from "./ecmascript/schema.js";
 import { transpile } from "./ecmascript/transpile.js";
-import { PluginOptionError } from "./error.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,8 +28,8 @@ export function createEcmaScriptPlugin(init) {
         version: init.version,
         run(req) {
             var _a;
-            const { targets, tsNocheck, bootstrapWkt, rewriteImports, importExtension, keepEmptyFiles, pluginParameter, } = parseParameter(req.parameter, init.parseOption);
-            const { schema, getFileInfo } = createSchema(req, targets, tsNocheck, bootstrapWkt, rewriteImports, importExtension, keepEmptyFiles, init.name, init.version, pluginParameter);
+            const parameter = parseParameter(req.parameter, init.parseOption);
+            const schema = createSchema(req, parameter, init.name, init.version);
             const targetTs = schema.targets.includes("ts");
             const targetJs = schema.targets.includes("js");
             const targetDts = schema.targets.includes("dts");
@@ -42,6 +43,7 @@ export function createEcmaScriptPlugin(init) {
             if (targetTs ||
                 (targetJs && !init.generateJs) ||
                 (targetDts && !init.generateDts)) {
+                schema.prepareGenerate("ts");
                 init.generateTs(schema, "ts");
                 // Save off the generated TypeScript files so that we can pass these
                 // to the transpilation process if necessary.  We do not want to pass
@@ -53,10 +55,11 @@ export function createEcmaScriptPlugin(init) {
                 // a generateJs function and expect to transpile declarations.
                 // 3.  Transpiling is somewhat expensive and situations with an
                 // extremely large amount of files could have performance impacts.
-                tsFiles = getFileInfo();
+                tsFiles = schema.getFileInfo();
             }
             if (targetJs) {
                 if (init.generateJs) {
+                    schema.prepareGenerate("js");
                     init.generateJs(schema, "js");
                 }
                 else {
@@ -65,6 +68,7 @@ export function createEcmaScriptPlugin(init) {
             }
             if (targetDts) {
                 if (init.generateDts) {
+                    schema.prepareGenerate("dts");
                     init.generateDts(schema, "dts");
                 }
                 else {
@@ -76,7 +80,7 @@ export function createEcmaScriptPlugin(init) {
             // generated TypeScript files to assist in transpilation.  If they were
             // generated but not specified in the target out, we shouldn't produce
             // these files in the CodeGeneratorResponse.
-            let files = getFileInfo();
+            let files = schema.getFileInfo();
             if (!targetTs && tsFiles.length > 0) {
                 files = files.filter((file) => !tsFiles.some((tsFile) => tsFile.name === file.name));
             }
@@ -86,139 +90,21 @@ export function createEcmaScriptPlugin(init) {
             if (transpileJs || transpileDts) {
                 const transpileFn = (_a = init.transpile) !== null && _a !== void 0 ? _a : transpile;
                 // Transpile the TypeScript files and add to the master list of files
-                const transpiledFiles = transpileFn(tsFiles, transpileJs, transpileDts);
+                const transpiledFiles = transpileFn(tsFiles, transpileJs, transpileDts, parameter.jsImportStyle);
                 files.push(...transpiledFiles);
             }
             return toResponse(files);
         },
     };
 }
-function parseParameter(parameter, parseOption) {
-    let targets = ["js", "dts"];
-    let tsNocheck = true;
-    let bootstrapWkt = false;
-    let keepEmptyFiles = false;
-    const rewriteImports = [];
-    let importExtension = ".js";
-    const rawParameters = [];
-    for (const { key, value, raw } of splitParameter(parameter)) {
-        // Whether this key/value plugin parameter pair should be
-        // printed to the generated file preamble
-        let printToFile = true;
-        switch (key) {
-            case "target":
-                targets = [];
-                for (const rawTarget of value.split("+")) {
-                    switch (rawTarget) {
-                        case "js":
-                        case "ts":
-                        case "dts":
-                            if (targets.indexOf(rawTarget) < 0) {
-                                targets.push(rawTarget);
-                            }
-                            break;
-                        default:
-                            throw new PluginOptionError(`${key}=${value}`);
-                    }
-                }
-                value.split("+");
-                break;
-            case "ts_nocheck":
-                switch (value) {
-                    case "true":
-                    case "1":
-                        tsNocheck = true;
-                        break;
-                    case "false":
-                    case "0":
-                        tsNocheck = false;
-                        break;
-                    default:
-                        throw new PluginOptionError(`${key}=${value}`);
-                }
-                break;
-            case "bootstrap_wkt":
-                switch (value) {
-                    case "true":
-                    case "1":
-                        bootstrapWkt = true;
-                        break;
-                    case "false":
-                    case "0":
-                        bootstrapWkt = false;
-                        break;
-                    default:
-                        throw new PluginOptionError(`${key}=${value}`);
-                }
-                break;
-            case "rewrite_imports": {
-                const parts = value.split(":");
-                if (parts.length !== 2) {
-                    throw new PluginOptionError(`${key}=${value}`, "must be in the form of <pattern>:<target>");
-                }
-                const [pattern, target] = parts;
-                rewriteImports.push({ pattern, target });
-                // rewrite_imports can be noisy and is more of an implementation detail
-                // so we strip it out of the preamble
-                printToFile = false;
-                break;
-            }
-            case "import_extension": {
-                importExtension = value === "none" ? "" : value;
-                break;
-            }
-            case "keep_empty_files": {
-                switch (value) {
-                    case "true":
-                    case "1":
-                        keepEmptyFiles = true;
-                        break;
-                    case "false":
-                    case "0":
-                        keepEmptyFiles = false;
-                        break;
-                    default:
-                        throw new PluginOptionError(`${key}=${value}`);
-                }
-                break;
+function toResponse(files) {
+    return new CodeGeneratorResponse({
+        supportedFeatures: protoInt64.parse(CodeGeneratorResponse_Feature.PROTO3_OPTIONAL),
+        file: files.map((f) => {
+            if (f.preamble !== undefined) {
+                f.content = f.preamble + "\n" + f.content;
             }
-            default:
-                if (parseOption === undefined) {
-                    throw new PluginOptionError(`${key}=${value}`);
-                }
-                try {
-                    parseOption(key, value);
-                }
-                catch (e) {
-                    throw new PluginOptionError(`${key}=${value}`, e);
-                }
-                break;
-        }
-        if (printToFile) {
-            rawParameters.push(raw);
-        }
-    }
-    const pluginParameter = rawParameters.join(",");
-    return {
-        targets,
-        tsNocheck,
-        bootstrapWkt,
-        rewriteImports,
-        importExtension,
-        keepEmptyFiles,
-        pluginParameter,
-    };
-}
-function splitParameter(parameter) {
-    if (parameter == undefined) {
-        return [];
-    }
-    return parameter.split(",").map((raw) => {
-        const i = raw.indexOf("=");
-        return {
-            key: i === -1 ? raw : raw.substring(0, i),
-            value: i === -1 ? "" : raw.substring(i + 1),
-            raw,
-        };
+            return f;
+        }),
     });
 }

package/dist/esm/ecmascript/export-declaration.d.ts

@@ -0,0 +1,7 @@
+import { DescEnum, DescMessage } from "@bufbuild/protobuf";
+export type ExportDeclaration = {
+    readonly kind: "es_export_decl";
+    declaration: string;
+    name: string | DescMessage | DescEnum;
+};
+export declare function createExportDeclaration(declaration: string, name: ExportDeclaration["name"]): ExportDeclaration;

package/dist/esm/ecmascript/export-declaration.js

@@ -0,0 +1,20 @@
+// Copyright 2021-2023 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.
+export function createExportDeclaration(declaration, name) {
+    return {
+        kind: "es_export_decl",
+        declaration,
+        name,
+    };
+}

package/dist/esm/ecmascript/gencommon.d.ts

@@ -1,9 +1,7 @@
-import { DescEnum, DescEnumValue, DescField, DescFile, DescMessage, DescMethod, DescOneof, DescService, LongType, ScalarType } from "@bufbuild/protobuf";
+import { DescField, DescFile, LongType, ScalarType } from "@bufbuild/protobuf";
 import type { GeneratedFile, Printable } from "./generated-file.js";
 import type { ImportSymbol } from "./import-symbol.js";
 export declare function makeFilePreamble(file: DescFile, pluginName: string, pluginVersion: string, parameter: string, tsNoCheck: boolean): string;
-export declare function createJsDocBlock(text: string, indentation?: string): Printable;
-export declare function makeJsDoc(desc: DescEnum | DescEnumValue | DescMessage | DescOneof | DescField | DescService | DescMethod, indentation?: string): Printable;
 /**
  * Returns an expression for the TypeScript typing of a field,
  * and whether the property should be optional.

package/dist/esm/ecmascript/gencommon.js

@@ -11,7 +11,7 @@
 // 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 { codegenInfo, LongType, ScalarType, } from "@bufbuild/protobuf";
+import { codegenInfo, Edition, LongType, ScalarType, } from "@bufbuild/protobuf";
 const { localName, getUnwrappedFieldType, scalarDefaultValue } = codegenInfo;
 export function makeFilePreamble(file, pluginName, pluginVersion, parameter, tsNoCheck) {
     const builder = [];
@@ -42,7 +42,25 @@ export function makeFilePreamble(file, pluginName, pluginVersion, parameter, tsN
     if (file.proto.package !== undefined) {
         builder.push(`package ${file.proto.package}, `);
     }
-    builder.push(`syntax ${file.syntax})\n`);
+    switch (file.edition) {
+        case Edition.EDITION_PROTO2:
+            builder.push(`syntax proto2)\n`);
+            break;
+        case Edition.EDITION_PROTO3:
+            builder.push(`syntax proto3)\n`);
+            break;
+        default: {
+            const editionString = Edition[file.edition];
+            if (typeof editionString == "string") {
+                const e = editionString.replace("EDITION_", "").toLowerCase();
+                builder.push(`edition ${e})\n`);
+            }
+            else {
+                builder.push(`unknown edition\n`);
+            }
+            break;
+        }
+    }
     builder.push("/* eslint-disable */\n");
     if (tsNoCheck) {
         builder.push("// @ts-nocheck\n");
@@ -51,78 +69,6 @@ export function makeFilePreamble(file, pluginName, pluginVersion, parameter, tsN
     writeLeadingComments(file.getPackageComments());
     return trimSuffix(builder.join(""), "\n");
 }
-export function createJsDocBlock(text, indentation = "") {
-    if (text.trim().length == 0) {
-        return [];
-    }
-    let lines = text.split("\n");
-    if (lines.length === 0) {
-        return [];
-    }
-    lines = lines.map((l) => l.split("*/").join("*\\/"));
-    lines = lines.map((l) => (l.length > 0 ? " " + l : l));
-    // prettier-ignore
-    return [
-        `${indentation}/**\n`,
-        ...lines.map((l) => `${indentation} *${l}\n`),
-        `${indentation} */`
-    ];
-}
-export function makeJsDoc(desc, indentation = "") {
-    var _a, _b;
-    const comments = desc.getComments();
-    let text = "";
-    if (comments.leading !== undefined) {
-        text += comments.leading;
-        if (text.endsWith("\n")) {
-            text = text.substring(0, text.length - 1);
-        }
-    }
-    if (comments.trailing !== undefined) {
-        if (text.length > 0) {
-            text += "\n\n";
-        }
-        text += comments.trailing;
-        if (text.endsWith("\n")) {
-            text = text.substring(0, text.length - 1);
-        }
-    }
-    if (text.length > 0) {
-        text += "\n\n";
-    }
-    text = text
-        .split("\n")
-        .map((line) => (line.startsWith(" ") ? line.substring(1) : line))
-        .join("\n");
-    switch (desc.kind) {
-        case "enum_value":
-            text += `@generated from enum value: ${desc.declarationString()};`;
-            break;
-        case "field":
-            text += `@generated from field: ${desc.declarationString()};`;
-            break;
-        default:
-            text += `@generated from ${desc.toString()}`;
-            break;
-    }
-    let deprecated = desc.deprecated;
-    switch (desc.kind) {
-        case "enum":
-        case "message":
-        case "service":
-            deprecated = deprecated || ((_b = (_a = desc.file.proto.options) === null || _a === void 0 ? void 0 : _a.deprecated) !== null && _b !== void 0 ? _b : false);
-            break;
-        default:
-            break;
-    }
-    if (deprecated) {
-        text += "\n@deprecated";
-    }
-    if (text.length > 0) {
-        return createJsDocBlock(text, indentation);
-    }
-    return [];
-}
 /**
  * Returns an expression for the TypeScript typing of a field,
  * and whether the property should be optional.

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

@@ -1,10 +1,12 @@
-import type { DescEnum, DescFile, DescMessage } from "@bufbuild/protobuf";
+import type { AnyDesc, DescEnum, DescExtension, DescFile, DescMessage } from "@bufbuild/protobuf";
 import type { ImportSymbol } from "./import-symbol.js";
 import type { RuntimeImports } from "./runtime-imports.js";
+import type { ExportDeclaration } from "./export-declaration.js";
+import type { JSDocBlock } from "./jsdoc.js";
 /**
  * All types that can be passed to GeneratedFile.print()
  */
-export type Printable = string | number | boolean | bigint | Uint8Array | ImportSymbol | DescMessage | DescEnum | Printable[];
+export type Printable = string | number | boolean | bigint | Uint8Array | ImportSymbol | ExportDeclaration | JSDocBlock | DescMessage | DescEnum | Printable[];
 /**
  * FileInfo represents an intermediate type using for transpiling TypeScript internally.
  */
@@ -48,9 +50,41 @@ export interface GeneratedFile {
      */
     print(fragments: TemplateStringsArray, ...printables: Printable[]): void;
     /**
-     * Reserves an identifier in this file.
+     * @deprecated Please use createImportSymbol() from @bufbuild/protoplugin/ecmascript instead
      */
     export(name: string): ImportSymbol;
+    /**
+     * Create a string literal.
+     */
+    string(string: string): Printable;
+    /**
+     * Create a JSDoc comment block with the given text. Line breaks and white-space
+     * stay intact.
+     */
+    jsDoc(text: string, indentation?: string): JSDocBlock;
+    /**
+     * 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 | DescExtension>, indentation?: string): JSDocBlock;
+    /**
+     * Create a printable export statement. For example:
+     *
+     * ```ts
+     * f.print(f.exportDecl("abstract class", "MyClass"), " {}")
+     * ```
+     *
+     * Will generate as:
+     * ```ts
+     * export abstract class MyClass {}
+     * ```
+     *
+     * Using this method is preferred over a calling print() with a literal export
+     * 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): Printable;
     /**
      * Import a message or enumeration generated by protoc-gen-es.
      */
@@ -66,16 +100,21 @@ export interface GeneratedFile {
      * relative to the current file.
      */
     import(name: string, from: string): ImportSymbol;
+    /**
+     * In case you need full control over exports and imports, use print() and
+     * formulate your own imports and exports based on this property.
+     */
+    readonly jsImportStyle: "module" | "legacy_commonjs";
 }
-export interface GenerateFileToFileInfo {
-    getFileInfo(): FileInfo | undefined;
+export interface GeneratedFileController extends GeneratedFile {
+    getFileInfo(): FileInfo;
 }
 type CreateTypeImportFn = (desc: DescMessage | DescEnum) => ImportSymbol;
 type RewriteImportPathFn = (path: string) => string;
-export declare function createGeneratedFile(name: string, importPath: string, rewriteImportPath: RewriteImportPathFn, createTypeImport: CreateTypeImportFn, runtimeImports: RuntimeImports, preambleSettings: {
+export declare function createGeneratedFile(name: string, importPath: string, jsImportStyle: "module" | "legacy_commonjs", rewriteImportPath: RewriteImportPathFn, createTypeImport: CreateTypeImportFn, runtimeImports: RuntimeImports, preambleSettings: {
     pluginName: string;
     pluginVersion: string;
     pluginParameter: string;
     tsNocheck: boolean;
-}, keepEmpty: boolean): GeneratedFile & GenerateFileToFileInfo;
+}): GeneratedFileController;
 export {};

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

@@ -14,7 +14,9 @@
 import { createImportSymbol } from "./import-symbol.js";
 import { literalString, makeFilePreamble } from "./gencommon.js";
 import { makeImportPathRelative } from "./import-path.js";
-export function createGeneratedFile(name, importPath, rewriteImportPath, createTypeImport, runtimeImports, preambleSettings, keepEmpty) {
+import { createExportDeclaration } from "./export-declaration.js";
+import { createJsDocBlock } from "./jsdoc.js";
+export function createGeneratedFile(name, importPath, jsImportStyle, rewriteImportPath, createTypeImport, runtimeImports, preambleSettings) {
     let preamble;
     const el = [];
     return {
@@ -41,6 +43,15 @@ export function createGeneratedFile(name, importPath, rewriteImportPath, createT
         export(name) {
             return createImportSymbol(name, importPath);
         },
+        exportDecl(declaration, name) {
+            return createExportDeclaration(declaration, name);
+        },
+        string(string) {
+            return literalString(string);
+        },
+        jsDoc(textOrDesc, indentation) {
+            return createJsDocBlock(textOrDesc, indentation);
+        },
         import(typeOrName, from) {
             if (typeof typeOrName == "string") {
                 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
@@ -48,42 +59,81 @@ export function createGeneratedFile(name, importPath, rewriteImportPath, createT
             }
             return createTypeImport(typeOrName);
         },
+        jsImportStyle,
         getFileInfo() {
-            const content = elToContent(el, importPath, rewriteImportPath);
-            if (!keepEmpty && content.length === 0) {
-                return;
-            }
             return {
                 name,
-                content,
+                content: elToContent(el, importPath, rewriteImportPath, jsImportStyle == "legacy_commonjs"),
                 preamble,
             };
         },
     };
 }
-function elToContent(el, importerPath, rewriteImportPath) {
+function elToContent(el, importerPath, rewriteImportPath, legacyCommonJs) {
+    if (el.length == 0) {
+        return "";
+    }
     const c = [];
+    if (legacyCommonJs) {
+        c.push(`"use strict";\n`);
+        c.push(`Object.defineProperty(exports, "__esModule", { value: true });\n`);
+        c.push(`\n`);
+    }
     const symbolToIdentifier = processImports(el, importerPath, rewriteImportPath, (typeOnly, from, names) => {
-        const p = names.map(({ name, alias }) => alias == undefined ? name : `${name} as ${alias}`);
-        const what = `{ ${p.join(", ")} }`;
-        if (typeOnly) {
-            c.push(`import type ${what} from ${literalString(from)};\n`);
+        if (legacyCommonJs) {
+            const p = names.map(({ name, alias }) => alias == undefined ? name : `${name}: ${alias}`);
+            const what = `{ ${p.join(", ")} }`;
+            c.push(`const ${what} = require(${literalString(from)});\n`);
         }
         else {
-            c.push(`import ${what} from ${literalString(from)};\n`);
+            const p = names.map(({ name, alias }) => alias == undefined ? name : `${name} as ${alias}`);
+            const what = `{ ${p.join(", ")} }`;
+            if (typeOnly) {
+                c.push(`import type ${what} from ${literalString(from)};\n`);
+            }
+            else {
+                c.push(`import ${what} from ${literalString(from)};\n`);
+            }
         }
     });
     if (c.length > 0) {
         c.push("\n");
     }
+    const legacyCommonJsExportNames = [];
     for (const e of el) {
         if (typeof e == "string") {
             c.push(e);
-            continue;
         }
-        const ident = symbolToIdentifier.get(e.id);
-        if (ident != undefined) {
-            c.push(ident);
+        else {
+            switch (e.kind) {
+                case "es_symbol": {
+                    const ident = symbolToIdentifier.get(e.id);
+                    if (ident != undefined) {
+                        c.push(ident);
+                    }
+                    break;
+                }
+                case "es_export_stmt":
+                    if (legacyCommonJs) {
+                        legacyCommonJsExportNames.push(e.name);
+                    }
+                    else {
+                        c.push("export ");
+                    }
+                    if (e.declaration !== undefined && e.declaration.length > 0) {
+                        c.push(e.declaration, " ");
+                    }
+                    c.push(e.name);
+                    break;
+            }
+        }
+    }
+    if (legacyCommonJs) {
+        if (legacyCommonJsExportNames.length > 0) {
+            c.push(`\n`);
+        }
+        for (const name of legacyCommonJsExportNames) {
+            c.push(`exports.`, name, " = ", name, ";\n");
         }
     }
     return c.join("");
@@ -116,6 +166,18 @@ function printableToEl(printables, el, createTypeImport, runtimeImports) {
                         case "es_symbol":
                             el.push(p);
                             break;
+                        case "es_jsdoc":
+                            el.push(p.toString());
+                            break;
+                        case "es_export_decl":
+                            el.push({
+                                kind: "es_export_stmt",
+                                declaration: p.declaration,
+                                name: typeof p.name == "string"
+                                    ? p.name
+                                    : createTypeImport(p.name).name,
+                            });
+                            break;
                         case "message":
                         case "enum":
                             el.push(createTypeImport(p));
@@ -149,7 +211,7 @@ function processImports(el, importerPath, rewriteImportPath, makeImportStatement
     const foreignSymbols = [];
     // Walk through all symbols used and populate the collections above.
     for (const s of el) {
-        if (typeof s == "string") {
+        if (typeof s != "object" || s.kind !== "es_symbol") {
             continue;
         }
         symbolToIdentifier.set(s.id, s.name);

package/dist/esm/ecmascript/index.d.ts

@@ -1,9 +1,24 @@
+import { AnyDesc, DescExtension, DescFile } from "@bufbuild/protobuf";
+import { Printable } from "./generated-file.js";
 export { reifyWkt } from "./reify-wkt.js";
-export { Target } from "./target.js";
-export { Schema } from "./schema.js";
-export { RuntimeImports } from "./runtime-imports.js";
-export { GeneratedFile, FileInfo, Printable } from "./generated-file.js";
-export { ImportSymbol } from "./import-symbol.js";
+export type { Target } from "./target.js";
+export type { Schema } from "./schema.js";
+export type { RuntimeImports } from "./runtime-imports.js";
+export type { GeneratedFile, FileInfo, Printable } from "./generated-file.js";
+export type { ImportSymbol } from "./import-symbol.js";
+export { createImportSymbol } from "./import-symbol.js";
 export declare const localName: (desc: import("@bufbuild/protobuf").DescEnum | import("@bufbuild/protobuf").DescMessage | import("@bufbuild/protobuf").DescService | import("@bufbuild/protobuf").DescEnumValue | import("@bufbuild/protobuf").DescField | import("@bufbuild/protobuf").DescOneof | import("@bufbuild/protobuf").DescMethod) => string;
-export { createJsDocBlock, getFieldExplicitDefaultValue, getFieldIntrinsicDefaultValue, getFieldTyping, makeJsDoc, literalString, } from "./gencommon.js";
+export { getFieldExplicitDefaultValue, getFieldIntrinsicDefaultValue, getFieldTyping, } from "./gencommon.js";
 export { findCustomScalarOption, findCustomMessageOption, findCustomEnumOption, } from "./custom-options.js";
+/**
+ * @deprecated Please use GeneratedFile.string() instead
+ */
+export declare function literalString(value: string): string;
+/**
+ * @deprecated Please use GeneratedFile.jsDoc() instead
+ */
+export declare function makeJsDoc(desc: Exclude<AnyDesc, DescFile | DescExtension>, indentation?: string): Printable;
+/**
+ * @deprecated Please use GeneratedFile.jsDoc() instead
+ */
+export declare function createJsDocBlock(text: string, indentation?: string): Printable;

package/dist/esm/ecmascript/index.js

@@ -11,8 +11,29 @@
 // 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 { codegenInfo } from "@bufbuild/protobuf";
+import { codegenInfo, } from "@bufbuild/protobuf";
+import { createJsDocBlock as createJsDocBlockInternal } from "./jsdoc.js";
+import { literalString as literalStringInternal } from "./gencommon.js";
 export { reifyWkt } from "./reify-wkt.js";
+export { createImportSymbol } from "./import-symbol.js";
 export const { localName } = codegenInfo;
-export { createJsDocBlock, getFieldExplicitDefaultValue, getFieldIntrinsicDefaultValue, getFieldTyping, makeJsDoc, literalString, } from "./gencommon.js";
+export { getFieldExplicitDefaultValue, getFieldIntrinsicDefaultValue, getFieldTyping, } from "./gencommon.js";
 export { findCustomScalarOption, findCustomMessageOption, findCustomEnumOption, } from "./custom-options.js";
+/**
+ * @deprecated Please use GeneratedFile.string() instead
+ */
+export function literalString(value) {
+    return literalStringInternal(value);
+}
+/**
+ * @deprecated Please use GeneratedFile.jsDoc() instead
+ */
+export function makeJsDoc(desc, indentation = "") {
+    return createJsDocBlockInternal(desc, indentation).toString();
+}
+/**
+ * @deprecated Please use GeneratedFile.jsDoc() instead
+ */
+export function createJsDocBlock(text, indentation = "") {
+    return createJsDocBlockInternal(text, indentation).toString();
+}