@bufbuild/protoplugin 2.11.0 → 2.12.0

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

@@ -30,20 +30,20 @@ interface PluginInit<Options extends object> {
      * If your plugin does not recognize an option, it must throw an Error in
      * parseOptions.
      */
-    parseOptions?: (rawOptions: {
+    parseOptions?: ((rawOptions: {
         key: string;
         value: string;
-    }[]) => Options;
+    }[]) => Options) | undefined;
     /**
      * The earliest edition supported by this plugin. Defaults to the minimum
      * edition supported by @bufbuild/protobuf.
      */
-    minimumEdition?: SupportedEdition;
+    minimumEdition?: SupportedEdition | undefined;
     /**
      * The latest edition supported by this plugin. Defaults to the maximum
      * edition supported by @bufbuild/protobuf.
      */
-    maximumEdition?: SupportedEdition;
+    maximumEdition?: SupportedEdition | undefined;
     /**
      * A function which will generate TypeScript files based on proto input.
      * This function will be invoked by the plugin framework when the plugin runs.
@@ -61,7 +61,7 @@ interface PluginInit<Options extends object> {
      * JavaScript files.  If not, the plugin framework will transpile the files
      * itself.
      */
-    generateJs?: (schema: Schema<Options>, target: "js") => void;
+    generateJs?: ((schema: Schema<Options>, target: "js") => void) | undefined;
     /**
      * A optional function which will generate TypeScript declaration files
      * based on proto input.  This function will be invoked by the plugin
@@ -72,7 +72,7 @@ interface PluginInit<Options extends object> {
      * declaration files.  If not, the plugin framework will transpile the files
      * itself.
      */
-    generateDts?: (schema: Schema<Options>, target: "dts") => void;
+    generateDts?: ((schema: Schema<Options>, target: "dts") => void) | undefined;
     /**
      * An optional function which will transpile a given set of files.
      *
@@ -86,7 +86,7 @@ interface PluginInit<Options extends object> {
      * 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, jsImportStyle: "module" | "legacy_commonjs") => FileInfo[];
+    transpile?: ((files: FileInfo[], transpileJs: boolean, transpileDts: boolean, jsImportStyle: "module" | "legacy_commonjs") => FileInfo[]) | undefined;
 }
 /**
  * Create a new code generator plugin for ECMAScript.

package/dist/cjs/file-preamble.js

@@ -58,7 +58,10 @@ function makeFilePreamble(file, pluginName, pluginVersion, parameter, tsNoCheck)
             builder.push("syntax proto3)\n");
             break;
         default: {
-            const editionString = wkt_1.Edition[file.edition];
+            // Report the raw edition from the descriptor so files using
+            // EDITION_UNSTABLE (which we collapse to maximumEdition internally)
+            // still render as "edition unstable".
+            const editionString = wkt_1.Edition[file.proto.edition];
             if (typeof editionString == "string") {
                 const e = editionString.replace("EDITION_", "").toLowerCase();
                 builder.push(`edition ${e})\n`);

package/dist/cjs/printable.d.ts

@@ -39,5 +39,5 @@ export type ValidTypeImport = {
 export type JSDocBlock = {
     readonly kind: "es_jsdoc";
     text: string;
-    indentation?: string;
+    indentation?: string | undefined;
 };

package/dist/cjs/schema.js

@@ -86,6 +86,11 @@ function getFilesToGenerate(request, minimumEdition, maximumEdition) {
                     edition = wkt_1.Edition.EDITION_UNKNOWN;
                     break;
             }
+            // EDITION_UNSTABLE is a sandbox for in-development features; accept
+            // it regardless of the plugin's min/max bounds.
+            if (edition === wkt_1.Edition.EDITION_UNSTABLE) {
+                continue;
+            }
             if (edition < minimumEdition) {
                 throw new Error(`${file.name}: unsupported edition ${editionToString(edition)} - the earliest supported edition is ${editionToString(minimumEdition)}`);
             }

package/dist/cjs/transpile.js

@@ -42,9 +42,11 @@ const vfs_1 = require("@typescript/vfs");
  * npm does not support that yet.
  */
 function createTranspiler(options, files) {
-    const fsMap = (0, vfs_1.createDefaultMapFromNodeModules)({
-        target: options.target,
-    });
+    const fsMapOptions = {};
+    if (options.target) {
+        fsMapOptions.target = options.target;
+    }
+    const fsMap = (0, vfs_1.createDefaultMapFromNodeModules)(fsMapOptions);
     for (const file of files) {
         fsMap.set(file.name, file.content);
     }

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

@@ -30,20 +30,20 @@ interface PluginInit<Options extends object> {
      * If your plugin does not recognize an option, it must throw an Error in
      * parseOptions.
      */
-    parseOptions?: (rawOptions: {
+    parseOptions?: ((rawOptions: {
         key: string;
         value: string;
-    }[]) => Options;
+    }[]) => Options) | undefined;
     /**
      * The earliest edition supported by this plugin. Defaults to the minimum
      * edition supported by @bufbuild/protobuf.
      */
-    minimumEdition?: SupportedEdition;
+    minimumEdition?: SupportedEdition | undefined;
     /**
      * The latest edition supported by this plugin. Defaults to the maximum
      * edition supported by @bufbuild/protobuf.
      */
-    maximumEdition?: SupportedEdition;
+    maximumEdition?: SupportedEdition | undefined;
     /**
      * A function which will generate TypeScript files based on proto input.
      * This function will be invoked by the plugin framework when the plugin runs.
@@ -61,7 +61,7 @@ interface PluginInit<Options extends object> {
      * JavaScript files.  If not, the plugin framework will transpile the files
      * itself.
      */
-    generateJs?: (schema: Schema<Options>, target: "js") => void;
+    generateJs?: ((schema: Schema<Options>, target: "js") => void) | undefined;
     /**
      * A optional function which will generate TypeScript declaration files
      * based on proto input.  This function will be invoked by the plugin
@@ -72,7 +72,7 @@ interface PluginInit<Options extends object> {
      * declaration files.  If not, the plugin framework will transpile the files
      * itself.
      */
-    generateDts?: (schema: Schema<Options>, target: "dts") => void;
+    generateDts?: ((schema: Schema<Options>, target: "dts") => void) | undefined;
     /**
      * An optional function which will transpile a given set of files.
      *
@@ -86,7 +86,7 @@ interface PluginInit<Options extends object> {
      * 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, jsImportStyle: "module" | "legacy_commonjs") => FileInfo[];
+    transpile?: ((files: FileInfo[], transpileJs: boolean, transpileDts: boolean, jsImportStyle: "module" | "legacy_commonjs") => FileInfo[]) | undefined;
 }
 /**
  * Create a new code generator plugin for ECMAScript.

package/dist/esm/file-preamble.js

@@ -55,7 +55,10 @@ export function makeFilePreamble(file, pluginName, pluginVersion, parameter, tsN
             builder.push("syntax proto3)\n");
             break;
         default: {
-            const editionString = Edition[file.edition];
+            // Report the raw edition from the descriptor so files using
+            // EDITION_UNSTABLE (which we collapse to maximumEdition internally)
+            // still render as "edition unstable".
+            const editionString = Edition[file.proto.edition];
             if (typeof editionString == "string") {
                 const e = editionString.replace("EDITION_", "").toLowerCase();
                 builder.push(`edition ${e})\n`);

package/dist/esm/printable.d.ts

@@ -39,5 +39,5 @@ export type ValidTypeImport = {
 export type JSDocBlock = {
     readonly kind: "es_jsdoc";
     text: string;
-    indentation?: string;
+    indentation?: string | undefined;
 };

package/dist/esm/schema.js

@@ -83,6 +83,11 @@ function getFilesToGenerate(request, minimumEdition, maximumEdition) {
                     edition = Edition.EDITION_UNKNOWN;
                     break;
             }
+            // EDITION_UNSTABLE is a sandbox for in-development features; accept
+            // it regardless of the plugin's min/max bounds.
+            if (edition === Edition.EDITION_UNSTABLE) {
+                continue;
+            }
             if (edition < minimumEdition) {
                 throw new Error(`${file.name}: unsupported edition ${editionToString(edition)} - the earliest supported edition is ${editionToString(minimumEdition)}`);
             }

package/dist/esm/transpile.js

@@ -36,9 +36,11 @@ import { createDefaultMapFromNodeModules, createSystem, createVirtualCompilerHos
  * npm does not support that yet.
  */
 function createTranspiler(options, files) {
-    const fsMap = createDefaultMapFromNodeModules({
-        target: options.target,
-    });
+    const fsMapOptions = {};
+    if (options.target) {
+        fsMapOptions.target = options.target;
+    }
+    const fsMap = createDefaultMapFromNodeModules(fsMapOptions);
     for (const file of files) {
         fsMap.set(file.name, file.content);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bufbuild/protoplugin",
-  "version": "2.11.0",
+  "version": "2.12.0",
   "license": "Apache-2.0",
   "description": "Helps to create your own Protocol Buffers code generators.",
   "keywords": [
@@ -35,7 +35,7 @@
     }
   },
   "dependencies": {
-    "@bufbuild/protobuf": "2.11.0",
+    "@bufbuild/protobuf": "2.12.0",
     "@typescript/vfs": "^1.6.2",
     "typescript": "5.4.5"
   },