@bufbuild/protoplugin 1.5.1 → 1.7.0

package/README.md

@@ -26,8 +26,8 @@ declaration files automatically using our internal TypeScript compiler.
 it to generate JavaScript and declaration files with your own version of 
 TypeScript and your own compiler options.
 
-With `protoplugin`, you have all the tools at your disposal to produce ECMAScript-compliant
-code.  
+With `@bufbuild/protoplugin`, you have all the tools at your disposal to produce 
+ECMAScript-compliant code.  
 
 ## Usage
 

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

@@ -1,6 +1,7 @@
 import { 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.
@@ -15,6 +16,20 @@ interface PluginInit {
      * options.
      */
     parseOption?: (key: string, value: string) => void;
+    /**
+     * Whether the plugin supports editions.
+     */
+    supportsEditions?: boolean;
+    /**
+     * 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.
+     */
+    featureSetDefaults?: FeatureSetDefaults;
     /**
      * A function which will generate TypeScript files based on proto input.
      * This function will be invoked by the plugin framework when the plugin runs.
@@ -45,14 +60,19 @@ interface PluginInit {
      */
     generateDts?: (schema: Schema, target: "dts") => void;
     /**
-     * A optional function which will transpile a given set of files.
+     * An optional function which will transpile a given set of files.
      *
-     * This funcion is meant to be used in place of either generateJs,
+     * This function is meant to be used in place of either generateJs,
      * generateDts, or both.  However, those functions will take precedence.
      * This means that if generateJs, generateDts, and this transpile function
      * are all provided, this transpile function will be ignored.
+     *
+     * If jsImportStyle is "module" (the standard behavior), the function is
+     * expected to use ECMAScript module import and export statements when
+     * transpiling to JS. If jsImportStyle is "legacy_commonjs", the function is
+     * expected to use CommonJs require() and exports when transpiling to JS.
      */
-    transpile?: (files: FileInfo[], transpileJs: boolean, transpileDts: boolean) => FileInfo[];
+    transpile?: (files: FileInfo[], transpileJs: boolean, transpileDts: boolean, jsImportStyle: "module" | "legacy_commonjs") => FileInfo[];
 }
 /**
  * Create a new code generator plugin for ECMAScript.

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

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2021-2023 Buf Technologies, Inc.
+// 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.
@@ -16,7 +16,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createEcmaScriptPlugin = void 0;
 const schema_js_1 = require("./ecmascript/schema.js");
 const transpile_js_1 = require("./ecmascript/transpile.js");
-const error_js_1 = require("./error.js");
+const parameter_js_1 = require("./ecmascript/parameter.js");
+const protobuf_1 = require("@bufbuild/protobuf");
 /**
  * Create a new code generator plugin for ECMAScript.
  * The plugin can generate JavaScript, TypeScript, or TypeScript declaration
@@ -29,9 +30,9 @@ function createEcmaScriptPlugin(init) {
         name: init.name,
         version: init.version,
         run(req) {
-            var _a;
-            const { targets, tsNocheck, bootstrapWkt, rewriteImports, importExtension, keepEmptyFiles, pluginParameter, } = parseParameter(req.parameter, init.parseOption);
-            const { schema, getFileInfo } = (0, schema_js_1.createSchema)(req, targets, tsNocheck, bootstrapWkt, rewriteImports, importExtension, keepEmptyFiles, init.name, init.version, pluginParameter);
+            var _a, _b;
+            const parameter = (0, parameter_js_1.parseParameter)(req.parameter, init.parseOption);
+            const schema = (0, schema_js_1.createSchema)(req, parameter, init.name, init.version, init.featureSetDefaults);
             const targetTs = schema.targets.includes("ts");
             const targetJs = schema.targets.includes("js");
             const targetDts = schema.targets.includes("dts");
@@ -45,6 +46,7 @@ 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
@@ -56,10 +58,11 @@ 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 {
@@ -68,6 +71,7 @@ function createEcmaScriptPlugin(init) {
             }
             if (targetDts) {
                 if (init.generateDts) {
+                    schema.prepareGenerate("dts");
                     init.generateDts(schema, "dts");
                 }
                 else {
@@ -79,7 +83,7 @@ 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));
             }
@@ -89,140 +93,27 @@ function createEcmaScriptPlugin(init) {
             if (transpileJs || transpileDts) {
                 const transpileFn = (_a = init.transpile) !== null && _a !== void 0 ? _a : transpile_js_1.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 (0, schema_js_1.toResponse)(files);
+            return toResponse(files, (_b = init.supportsEditions) !== null && _b !== void 0 ? _b : false);
         },
     };
 }
 exports.createEcmaScriptPlugin = createEcmaScriptPlugin;
-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 error_js_1.PluginOptionError(raw);
-                    }
-                }
-                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 error_js_1.PluginOptionError(raw);
-                }
-                break;
-            case "bootstrap_wkt":
-                switch (value) {
-                    case "true":
-                    case "1":
-                        bootstrapWkt = true;
-                        break;
-                    case "false":
-                    case "0":
-                        bootstrapWkt = false;
-                        break;
-                    default:
-                        throw new error_js_1.PluginOptionError(raw);
-                }
-                break;
-            case "rewrite_imports": {
-                const parts = value.split(":");
-                if (parts.length !== 2) {
-                    throw new error_js_1.PluginOptionError(raw, "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 error_js_1.PluginOptionError(raw);
-                }
-                break;
-            }
-            default:
-                if (parseOption === undefined) {
-                    throw new error_js_1.PluginOptionError(raw);
-                }
-                try {
-                    parseOption(key, value);
-                }
-                catch (e) {
-                    throw new error_js_1.PluginOptionError(raw, 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 [];
+function toResponse(files, supportsEditions) {
+    let supportedFeatures = protobuf_1.CodeGeneratorResponse_Feature.PROTO3_OPTIONAL;
+    if (supportsEditions) {
+        supportedFeatures =
+            supportedFeatures | protobuf_1.CodeGeneratorResponse_Feature.SUPPORTS_EDITIONS;
     }
-    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 new protobuf_1.CodeGeneratorResponse({
+        supportedFeatures: protobuf_1.protoInt64.parse(supportedFeatures),
+        file: files.map((f) => {
+            if (f.preamble !== undefined) {
+                f.content = f.preamble + "\n" + f.content;
+            }
+            return f;
+        }),
     });
 }

package/dist/cjs/ecmascript/custom-options.d.ts

@@ -1,12 +1,16 @@
 import type { AnyDesc } from "@bufbuild/protobuf";
 import { Message, MessageType, ScalarType } from "@bufbuild/protobuf";
 /**
+ * @deprecated Please use extensions instead.
+ *
  * Returns the value of a custom option with a scalar type.
  *
  * If no option is found, returns undefined.
  */
 export declare function findCustomScalarOption<T extends ScalarType>(desc: AnyDesc, extensionNumber: number, scalarType: T): ScalarValue<T> | undefined;
 /**
+ * @deprecated Please use extensions instead.
+ *
  * Returns the value of a custom message option for the given descriptor and
  * extension number.
  * The msgType param is then used to deserialize the message for returning to
@@ -19,6 +23,8 @@ export declare function findCustomScalarOption<T extends ScalarType>(desc: AnyDe
  */
 export declare function findCustomMessageOption<T extends Message<T>>(desc: AnyDesc, extensionNumber: number, msgType: MessageType<T>): T | undefined;
 /**
+ * @deprecated Please use extensions instead.
+ *
  * Returns the value of a custom enum option for the given descriptor and
  * extension number.
  *
@@ -26,6 +32,8 @@ export declare function findCustomMessageOption<T extends Message<T>>(desc: AnyD
  */
 export declare function findCustomEnumOption(desc: AnyDesc, extensionNumber: number): number | undefined;
 /**
+ * @deprecated Please use extensions instead.
+ *
  * ScalarValue is a conditional type that pairs a ScalarType value with its concrete type.
  */
 type ScalarValue<T> = T extends ScalarType.STRING ? string : T extends ScalarType.INT32 ? number : T extends ScalarType.UINT32 ? number : T extends ScalarType.UINT32 ? number : T extends ScalarType.SINT32 ? number : T extends ScalarType.FIXED32 ? number : T extends ScalarType.SFIXED32 ? number : T extends ScalarType.FLOAT ? number : T extends ScalarType.DOUBLE ? number : T extends ScalarType.INT64 ? bigint | string : T extends ScalarType.SINT64 ? bigint | string : T extends ScalarType.SFIXED64 ? bigint | string : T extends ScalarType.UINT64 ? bigint | string : T extends ScalarType.FIXED64 ? bigint | string : T extends ScalarType.BOOL ? boolean : T extends ScalarType.BYTES ? Uint8Array : never;

package/dist/cjs/ecmascript/custom-options.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2021-2023 Buf Technologies, Inc.
+// 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.
@@ -16,6 +16,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.findCustomEnumOption = exports.findCustomMessageOption = exports.findCustomScalarOption = void 0;
 const protobuf_1 = require("@bufbuild/protobuf");
 /**
+ * @deprecated Please use extensions instead.
+ *
  * Returns the value of a custom option with a scalar type.
  *
  * If no option is found, returns undefined.
@@ -63,6 +65,8 @@ function findCustomScalarOption(desc, extensionNumber, scalarType) {
 }
 exports.findCustomScalarOption = findCustomScalarOption;
 /**
+ * @deprecated Please use extensions instead.
+ *
  * Returns the value of a custom message option for the given descriptor and
  * extension number.
  * The msgType param is then used to deserialize the message for returning to
@@ -89,6 +93,8 @@ function findCustomMessageOption(desc, extensionNumber, msgType) {
 }
 exports.findCustomMessageOption = findCustomMessageOption;
 /**
+ * @deprecated Please use extensions instead.
+ *
  * Returns the value of a custom enum option for the given descriptor and
  * extension number.
  *

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

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

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

@@ -0,0 +1,24 @@
+"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.createExportDeclaration = void 0;
+function createExportDeclaration(declaration, name) {
+    return {
+        kind: "es_export_decl",
+        declaration,
+        name,
+    };
+}
+exports.createExportDeclaration = createExportDeclaration;

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

@@ -1,20 +1,19 @@
-import { DescEnum, DescEnumValue, DescField, DescFile, DescMessage, DescMethod, DescOneof, DescService, LongType, ScalarType } from "@bufbuild/protobuf";
+import type { DescExtension } 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.
  */
-export declare function getFieldTyping(field: DescField, file: GeneratedFile): {
+export declare function getFieldTyping(field: DescField | DescExtension, file: GeneratedFile): {
     typing: Printable;
     optional: boolean;
 };
 export declare function scalarTypeScriptType(type: ScalarType, longType: LongType): Printable;
 export declare function literalString(value: string): string;
-export declare function getFieldExplicitDefaultValue(field: DescField, protoInt64Symbol: ImportSymbol): Printable | undefined;
+export declare function getFieldExplicitDefaultValue(field: DescField | DescExtension, protoInt64Symbol: ImportSymbol): Printable | undefined;
 export declare function getFieldIntrinsicDefaultValue(field: DescField): {
     defaultValue: Printable | undefined;
     typingInferrable: boolean;

package/dist/cjs/ecmascript/gencommon.js

@@ -1,5 +1,5 @@
 "use strict";
-// Copyright 2021-2023 Buf Technologies, Inc.
+// 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.
@@ -13,7 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFieldIntrinsicDefaultValue = exports.getFieldExplicitDefaultValue = exports.literalString = exports.scalarTypeScriptType = exports.getFieldTyping = exports.makeJsDoc = exports.createJsDocBlock = exports.makeFilePreamble = void 0;
+exports.getFieldIntrinsicDefaultValue = exports.getFieldExplicitDefaultValue = exports.literalString = exports.scalarTypeScriptType = exports.getFieldTyping = exports.makeFilePreamble = void 0;
 const protobuf_1 = require("@bufbuild/protobuf");
 const { localName, getUnwrappedFieldType, scalarDefaultValue } = protobuf_1.codegenInfo;
 function makeFilePreamble(file, pluginName, pluginVersion, parameter, tsNoCheck) {
@@ -73,80 +73,6 @@ function makeFilePreamble(file, pluginName, pluginVersion, parameter, tsNoCheck)
     return trimSuffix(builder.join(""), "\n");
 }
 exports.makeFilePreamble = makeFilePreamble;
-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} */`
-    ];
-}
-exports.createJsDocBlock = createJsDocBlock;
-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 [];
-}
-exports.makeJsDoc = makeJsDoc;
 /**
  * Returns an expression for the TypeScript typing of a field,
  * and whether the property should be optional.

package/dist/cjs/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 | DescExtension | Printable[];
 /**
  * FileInfo represents an intermediate type using for transpiling TypeScript internally.
  */
@@ -48,13 +50,45 @@ 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>, 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 | DescExtension): Printable;
     /**
      * Import a message or enumeration generated by protoc-gen-es.
      */
-    import(type: DescMessage | DescEnum): ImportSymbol;
+    import(type: DescMessage | DescEnum | DescExtension): ImportSymbol;
     /**
      * Import any symbol from a file or package.
      *
@@ -66,16 +100,17 @@ 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 CreateTypeImportFn = (desc: DescMessage | DescEnum | DescExtension) => ImportSymbol;
 type RewriteImportPathFn = (path: string) => string;
-export declare function createGeneratedFile(name: string, importPath: string, rewriteImportPath: RewriteImportPathFn, createTypeImport: CreateTypeImportFn, runtimeImports: RuntimeImports, preambleSettings: {
-    pluginName: string;
-    pluginVersion: string;
-    pluginParameter: string;
-    tsNocheck: boolean;
-}, keepEmpty: boolean): GeneratedFile & GenerateFileToFileInfo;
+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 {};