@bufbuild/protoplugin 2.3.0 → 2.5.0

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

@@ -91,6 +91,13 @@ export interface GeneratedFile {
      * `json_types=true`.
      */
     importJson(desc: DescMessage | DescEnum): ImportSymbol;
+    /**
+     * Import a message Valid type generated by protoc-gen-es.
+     *
+     * Note that protoc-gen-es only generates valid types with the plugin option
+     * `valid_types`.
+     */
+    importValid(desc: DescMessage): ImportSymbol;
     /**
      * Import a descriptor generated by protoc-gen-es.
      */
@@ -126,6 +133,8 @@ export interface GeneratedFileController extends GeneratedFile {
 }
 export type ResolveDescImportFn = (desc: DescMessage | DescEnum | DescExtension | DescService | DescFile, typeOnly?: boolean) => ImportSymbol;
 export type ResolveShapeImportFn = (desc: DescMessage | DescEnum) => ImportSymbol;
+export type ResolveJsonImportFn = (desc: DescMessage | DescEnum) => ImportSymbol;
+export type ResolveValidImportFn = (desc: DescMessage) => 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, resolveJsonImport: 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: ResolveJsonImportFn, resolveValidImport: ResolveValidImportFn, createPreamble: CreatePreambleFn, runtime: RuntimeImports): GeneratedFileController;

package/dist/cjs/generated-file.js

@@ -18,7 +18,7 @@ const protobuf_1 = require("@bufbuild/protobuf");
 const import_symbol_js_1 = require("./import-symbol.js");
 const import_path_js_1 = require("./import-path.js");
 const jsdoc_js_1 = require("./jsdoc.js");
-function createGeneratedFile(name, importPath, jsImportStyle, rewriteImport, resolveDescImport, resolveShapeImport, resolveJsonImport, createPreamble, runtime) {
+function createGeneratedFile(name, importPath, jsImportStyle, rewriteImport, resolveDescImport, resolveShapeImport, resolveJsonImport, resolveValidImport, createPreamble, runtime) {
     let preamble;
     const el = [];
     return {
@@ -45,6 +45,7 @@ function createGeneratedFile(name, importPath, jsImportStyle, rewriteImport, res
                 resolveDescImport,
                 resolveShapeImport,
                 resolveJsonImport,
+                resolveValidImport,
             }, printables);
             el.push("\n");
         },
@@ -91,6 +92,9 @@ function createGeneratedFile(name, importPath, jsImportStyle, rewriteImport, res
         importJson(desc) {
             return resolveJsonImport(desc);
         },
+        importValid(desc) {
+            return resolveValidImport(desc);
+        },
         import(name, from, typeOnly = false) {
             return (0, import_symbol_js_1.createImportSymbol)(name, from, typeOnly);
         },
@@ -241,6 +245,9 @@ function printableToEl(opt, printables) {
                         case "es_json_type_ref":
                             el.push(opt.resolveJsonImport(p.desc));
                             break;
+                        case "es_valid_type_ref":
+                            el.push(opt.resolveValidImport(p.desc));
+                            break;
                         case "es_jsdoc":
                             el.push((0, jsdoc_js_1.formatJsDocBlock)(p.text, p.indentation));
                             break;

package/dist/cjs/names.d.ts

@@ -15,3 +15,7 @@ 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;
+/**
+ * Return a safe identifier for a generated Valid type.
+ */
+export declare function generatedValidTypeName(desc: DescEnum | DescMessage): string;

package/dist/cjs/names.js

@@ -17,7 +17,8 @@ exports.generateFilePath = generateFilePath;
 exports.generatedDescName = generatedDescName;
 exports.generatedShapeName = generatedShapeName;
 exports.generatedJsonTypeName = generatedJsonTypeName;
-const codegenv1_1 = require("@bufbuild/protobuf/codegenv1");
+exports.generatedValidTypeName = generatedValidTypeName;
+const codegenv2_1 = require("@bufbuild/protobuf/codegenv2");
 const reflect_1 = require("@bufbuild/protobuf/reflect");
 const safe_identifier_js_1 = require("./safe-identifier.js");
 /**
@@ -31,7 +32,7 @@ function generateFilePath(file, bootstrapWkt, filesToGenerate) {
     //    "bootstrap_wkt". In that case, we cannot refer to the runtime package
     //    itself.
     // 2. We were explicitly asked to generate the well-known type.
-    const wktFrom = codegenv1_1.wktPublicImportPaths[file.proto.name];
+    const wktFrom = codegenv2_1.wktPublicImportPaths[file.proto.name];
     if (wktFrom !== undefined &&
         !bootstrapWkt &&
         !filesToGenerate.find((f) => f.name === file.name)) {
@@ -73,6 +74,17 @@ function generatedJsonTypeName(desc) {
     }
     return name;
 }
+/**
+ * Return a safe identifier for a generated Valid type.
+ */
+function generatedValidTypeName(desc) {
+    const { validTypeNames } = allNames(desc.file);
+    const name = validTypeNames.get(desc);
+    if (name === undefined) {
+        throw new Error(`unable to determine unique valid type name for ${desc.toString()}`);
+    }
+    return name;
+}
 /**
  * Compute the ideal name for a generated descriptor.
  */
@@ -107,6 +119,13 @@ function idealJsonTypeName(desc, i) {
     const salt = i === 0 ? "" : i === 1 ? "$" : `$${i - 1}`;
     return (0, safe_identifier_js_1.safeIdentifier)(identifier(desc) + "Json" + salt);
 }
+/**
+ * Compute the ideal name for a generated Valid type.
+ */
+function idealValidTypeName(desc, i) {
+    const salt = i === 0 ? "" : i === 1 ? "$" : `$${i - 1}`;
+    return (0, safe_identifier_js_1.safeIdentifier)(identifier(desc) + "Valid" + salt);
+}
 /**
  * Return an identifier for the given descriptor based on its type name.
  *
@@ -189,5 +208,20 @@ function allNames(file) {
         taken.add(name);
         jsonTypeNames.set(desc, name);
     }
-    return { shapeNames, jsonTypeNames, descNames };
+    const validTypeNames = new Map();
+    for (const desc of (0, reflect_1.nestedTypes)(file)) {
+        if (desc.kind != "enum" && desc.kind != "message") {
+            continue;
+        }
+        let name;
+        for (let i = 0;; i++) {
+            name = idealValidTypeName(desc, i);
+            if (!taken.has(name)) {
+                break;
+            }
+        }
+        taken.add(name);
+        validTypeNames.set(desc, name);
+    }
+    return { shapeNames, jsonTypeNames, validTypeNames, descNames };
 }

package/dist/cjs/printable.d.ts

@@ -3,7 +3,7 @@ import type { ImportSymbol } from "./import-symbol.js";
 /**
  * All types that can be passed to GeneratedFile.print()
  */
-export type Printable = string | number | boolean | bigint | Uint8Array | ImportSymbol | ExportStatement | JSDocBlock | LiteralString | LiteralProtoInt64 | DescImport | ShapeImport | JsonTypeImport | Printable[];
+export type Printable = string | number | boolean | bigint | Uint8Array | ImportSymbol | ExportStatement | JSDocBlock | LiteralString | LiteralProtoInt64 | DescImport | ShapeImport | JsonTypeImport | ValidTypeImport | Printable[];
 export type ExportStatement = {
     kind: "es_export_stmt";
     name: string;
@@ -32,6 +32,10 @@ export type JsonTypeImport = {
     readonly kind: "es_json_type_ref";
     desc: DescMessage | DescEnum;
 };
+export type ValidTypeImport = {
+    readonly kind: "es_valid_type_ref";
+    desc: DescMessage;
+};
 export type JSDocBlock = {
     readonly kind: "es_jsdoc";
     text: string;

package/dist/cjs/runtime-imports.d.ts

@@ -1,5 +1,5 @@
 import type { ImportSymbol } from "./import-symbol.js";
-import { symbols } from "@bufbuild/protobuf/codegenv1";
+import { symbols } from "@bufbuild/protobuf/codegenv2";
 export type RuntimeImports = mapRecord<typeof symbols>;
 export declare function createRuntimeImports(bootstrapWkt: boolean): RuntimeImports;
 type mapRecord<T extends Record<string, unknown>> = {

package/dist/cjs/runtime-imports.js

@@ -15,9 +15,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createRuntimeImports = createRuntimeImports;
 const import_symbol_js_1 = require("./import-symbol.js");
-const codegenv1_1 = require("@bufbuild/protobuf/codegenv1");
+const codegenv2_1 = require("@bufbuild/protobuf/codegenv2");
 function createRuntimeImports(bootstrapWkt) {
-    return mapRecord(codegenv1_1.symbols, bootstrapWkt);
+    return mapRecord(codegenv2_1.symbols, bootstrapWkt);
 }
 function mapRecord(record, bootstrapWkt) {
     const result = Object.create(null);

package/dist/cjs/schema.js

@@ -31,6 +31,7 @@ function createSchema(request, parameter, pluginName, pluginVersion, minimumEdit
     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 resolveValidImport = (desc) => (0, import_symbol_js_1.createImportSymbol)((0, names_js_1.generatedValidTypeName)(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 {
@@ -45,7 +46,7 @@ function createSchema(request, parameter, pluginName, pluginVersion, minimumEdit
                 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.parsed.jsImportStyle : "module", // ts and dts always use import/export, only js may use commonjs
-            rewriteImport, resolveDescImport, resolveShapeImport, resolveJsonImport, createPreamble, runtime);
+            rewriteImport, resolveDescImport, resolveShapeImport, resolveJsonImport, resolveValidImport, createPreamble, runtime);
             generatedFiles.push(genFile);
             return genFile;
         },

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

@@ -91,6 +91,13 @@ export interface GeneratedFile {
      * `json_types=true`.
      */
     importJson(desc: DescMessage | DescEnum): ImportSymbol;
+    /**
+     * Import a message Valid type generated by protoc-gen-es.
+     *
+     * Note that protoc-gen-es only generates valid types with the plugin option
+     * `valid_types`.
+     */
+    importValid(desc: DescMessage): ImportSymbol;
     /**
      * Import a descriptor generated by protoc-gen-es.
      */
@@ -126,6 +133,8 @@ export interface GeneratedFileController extends GeneratedFile {
 }
 export type ResolveDescImportFn = (desc: DescMessage | DescEnum | DescExtension | DescService | DescFile, typeOnly?: boolean) => ImportSymbol;
 export type ResolveShapeImportFn = (desc: DescMessage | DescEnum) => ImportSymbol;
+export type ResolveJsonImportFn = (desc: DescMessage | DescEnum) => ImportSymbol;
+export type ResolveValidImportFn = (desc: DescMessage) => 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, resolveJsonImport: 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: ResolveJsonImportFn, resolveValidImport: ResolveValidImportFn, 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, resolveJsonImport, createPreamble, runtime) {
+export function createGeneratedFile(name, importPath, jsImportStyle, rewriteImport, resolveDescImport, resolveShapeImport, resolveJsonImport, resolveValidImport, createPreamble, runtime) {
     let preamble;
     const el = [];
     return {
@@ -42,6 +42,7 @@ export function createGeneratedFile(name, importPath, jsImportStyle, rewriteImpo
                 resolveDescImport,
                 resolveShapeImport,
                 resolveJsonImport,
+                resolveValidImport,
             }, printables);
             el.push("\n");
         },
@@ -88,6 +89,9 @@ export function createGeneratedFile(name, importPath, jsImportStyle, rewriteImpo
         importJson(desc) {
             return resolveJsonImport(desc);
         },
+        importValid(desc) {
+            return resolveValidImport(desc);
+        },
         import(name, from, typeOnly = false) {
             return createImportSymbol(name, from, typeOnly);
         },
@@ -238,6 +242,9 @@ function printableToEl(opt, printables) {
                         case "es_json_type_ref":
                             el.push(opt.resolveJsonImport(p.desc));
                             break;
+                        case "es_valid_type_ref":
+                            el.push(opt.resolveValidImport(p.desc));
+                            break;
                         case "es_jsdoc":
                             el.push(formatJsDocBlock(p.text, p.indentation));
                             break;

package/dist/esm/names.d.ts

@@ -15,3 +15,7 @@ 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;
+/**
+ * Return a safe identifier for a generated Valid type.
+ */
+export declare function generatedValidTypeName(desc: DescEnum | DescMessage): string;

package/dist/esm/names.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 { wktPublicImportPaths } from "@bufbuild/protobuf/codegenv1";
+import { wktPublicImportPaths } from "@bufbuild/protobuf/codegenv2";
 import { nestedTypes } from "@bufbuild/protobuf/reflect";
 import { safeIdentifier } from "./safe-identifier.js";
 /**
@@ -67,6 +67,17 @@ export function generatedJsonTypeName(desc) {
     }
     return name;
 }
+/**
+ * Return a safe identifier for a generated Valid type.
+ */
+export function generatedValidTypeName(desc) {
+    const { validTypeNames } = allNames(desc.file);
+    const name = validTypeNames.get(desc);
+    if (name === undefined) {
+        throw new Error(`unable to determine unique valid type name for ${desc.toString()}`);
+    }
+    return name;
+}
 /**
  * Compute the ideal name for a generated descriptor.
  */
@@ -101,6 +112,13 @@ function idealJsonTypeName(desc, i) {
     const salt = i === 0 ? "" : i === 1 ? "$" : `$${i - 1}`;
     return safeIdentifier(identifier(desc) + "Json" + salt);
 }
+/**
+ * Compute the ideal name for a generated Valid type.
+ */
+function idealValidTypeName(desc, i) {
+    const salt = i === 0 ? "" : i === 1 ? "$" : `$${i - 1}`;
+    return safeIdentifier(identifier(desc) + "Valid" + salt);
+}
 /**
  * Return an identifier for the given descriptor based on its type name.
  *
@@ -183,5 +201,20 @@ function allNames(file) {
         taken.add(name);
         jsonTypeNames.set(desc, name);
     }
-    return { shapeNames, jsonTypeNames, descNames };
+    const validTypeNames = new Map();
+    for (const desc of nestedTypes(file)) {
+        if (desc.kind != "enum" && desc.kind != "message") {
+            continue;
+        }
+        let name;
+        for (let i = 0;; i++) {
+            name = idealValidTypeName(desc, i);
+            if (!taken.has(name)) {
+                break;
+            }
+        }
+        taken.add(name);
+        validTypeNames.set(desc, name);
+    }
+    return { shapeNames, jsonTypeNames, validTypeNames, descNames };
 }

package/dist/esm/printable.d.ts

@@ -3,7 +3,7 @@ import type { ImportSymbol } from "./import-symbol.js";
 /**
  * All types that can be passed to GeneratedFile.print()
  */
-export type Printable = string | number | boolean | bigint | Uint8Array | ImportSymbol | ExportStatement | JSDocBlock | LiteralString | LiteralProtoInt64 | DescImport | ShapeImport | JsonTypeImport | Printable[];
+export type Printable = string | number | boolean | bigint | Uint8Array | ImportSymbol | ExportStatement | JSDocBlock | LiteralString | LiteralProtoInt64 | DescImport | ShapeImport | JsonTypeImport | ValidTypeImport | Printable[];
 export type ExportStatement = {
     kind: "es_export_stmt";
     name: string;
@@ -32,6 +32,10 @@ export type JsonTypeImport = {
     readonly kind: "es_json_type_ref";
     desc: DescMessage | DescEnum;
 };
+export type ValidTypeImport = {
+    readonly kind: "es_valid_type_ref";
+    desc: DescMessage;
+};
 export type JSDocBlock = {
     readonly kind: "es_jsdoc";
     text: string;

package/dist/esm/runtime-imports.d.ts

@@ -1,5 +1,5 @@
 import type { ImportSymbol } from "./import-symbol.js";
-import { symbols } from "@bufbuild/protobuf/codegenv1";
+import { symbols } from "@bufbuild/protobuf/codegenv2";
 export type RuntimeImports = mapRecord<typeof symbols>;
 export declare function createRuntimeImports(bootstrapWkt: boolean): RuntimeImports;
 type mapRecord<T extends Record<string, unknown>> = {

package/dist/esm/runtime-imports.js

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 import { createImportSymbol } from "./import-symbol.js";
-import { symbols } from "@bufbuild/protobuf/codegenv1";
+import { symbols } from "@bufbuild/protobuf/codegenv2";
 export function createRuntimeImports(bootstrapWkt) {
     return mapRecord(symbols, bootstrapWkt);
 }

package/dist/esm/schema.js

@@ -18,7 +18,7 @@ import { createGeneratedFile } from "./generated-file.js";
 import { createImportSymbol } from "./import-symbol.js";
 import { deriveImportPath, rewriteImportPath } from "./import-path.js";
 import { makeFilePreamble } from "./file-preamble.js";
-import { generatedDescName, generatedShapeName, generateFilePath, generatedJsonTypeName, } from "./names.js";
+import { generatedDescName, generatedShapeName, generateFilePath, generatedJsonTypeName, generatedValidTypeName, } from "./names.js";
 import { createRuntimeImports } from "./runtime-imports.js";
 export function createSchema(request, parameter, pluginName, pluginVersion, minimumEdition, maximumEdition) {
     const { allFiles, filesToGenerate } = getFilesToGenerate(request, minimumEdition, maximumEdition);
@@ -28,6 +28,7 @@ export function createSchema(request, parameter, pluginName, pluginVersion, mini
     const resolveDescImport = (desc, typeOnly) => createImportSymbol(generatedDescName(desc), generateFilePath(desc.kind == "file" ? desc : desc.file, parameter.parsed.bootstrapWkt, filesToGenerate), typeOnly);
     const resolveShapeImport = (desc) => createImportSymbol(generatedShapeName(desc), generateFilePath(desc.file, parameter.parsed.bootstrapWkt, filesToGenerate), true);
     const resolveJsonImport = (desc) => createImportSymbol(generatedJsonTypeName(desc), generateFilePath(desc.file, parameter.parsed.bootstrapWkt, filesToGenerate), true);
+    const resolveValidImport = (desc) => createImportSymbol(generatedValidTypeName(desc), generateFilePath(desc.file, parameter.parsed.bootstrapWkt, filesToGenerate), true);
     const createPreamble = (descFile) => makeFilePreamble(descFile, pluginName, pluginVersion, parameter.sanitized, parameter.parsed.tsNocheck);
     const rewriteImport = (importPath) => rewriteImportPath(importPath, parameter.parsed.rewriteImports, parameter.parsed.importExtension);
     return {
@@ -42,7 +43,7 @@ export function createSchema(request, parameter, pluginName, pluginVersion, mini
                 throw new Error("prepareGenerate() must be called before generateFile()");
             }
             const genFile = createGeneratedFile(name, 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);
+            rewriteImport, resolveDescImport, resolveShapeImport, resolveJsonImport, resolveValidImport, createPreamble, runtime);
             generatedFiles.push(genFile);
             return genFile;
         },

package/package.json

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