@bufbuild/protobuf 2.12.1 → 2.13.0

package/README.md

@@ -6,7 +6,7 @@ code generator plugin.
 ## Protocol Buffers for ECMAScript
 
 A complete implementation of [Protocol Buffers](https://protobuf.dev/) in TypeScript,
-suitable for web browsers, Node.js, and Deno, created by [Buf](https://buf.build).
+suitable for web browsers, Node.js, Deno, and Bun, created by [Buf](https://buf.build).
 
 **Protobuf-ES** is a solid, modern alternative to existing Protobuf implementations for the JavaScript ecosystem. It's
 the first project in this space to provide a comprehensive plugin framework and decouple the base types from RPC
@@ -19,7 +19,7 @@ Some additional features that set it apart from the others:
 - Generation of idiomatic JavaScript and TypeScript code
 - Generation of [much smaller bundles](https://github.com/bufbuild/protobuf-es/tree/main/packages/bundle-size/)
 - Implementation of all proto3 features, including the [canonical JSON format](https://protobuf.dev/programming-guides/proto3/#json)
-- Implementation of all proto2 features, except for extensions and the text format
+- Implementation of all proto2 features, including extensions and the text format
 - Usage of standard JavaScript APIs instead of the [Closure Library](http://googlecode.blogspot.com/2009/11/introducing-closure-tools.html)
 - Compatibility is covered by the Protocol Buffers [conformance tests](https://github.com/bufbuild/protobuf-es/tree/main/packages/protobuf-conformance/)
 - Descriptor and reflection support

package/dist/commonjs/codegenv1/symbols.d.ts

@@ -132,4 +132,9 @@ export declare const symbols: {
         readonly bootstrapWktFrom: "../../json-value.js";
         readonly from: "@bufbuild/protobuf";
     };
+    readonly UnknownEnum: {
+        readonly typeOnly: true;
+        readonly bootstrapWktFrom: "../../types.js";
+        readonly from: "@bufbuild/protobuf";
+    };
 };

package/dist/commonjs/codegenv2/enum.d.ts

@@ -9,10 +9,21 @@ import type { JsonValue } from "../json-value.js";
 export declare function enumDesc<Shape extends number, JsonType extends JsonValue = JsonValue>(file: DescFile, path: number, ...paths: number[]): GenEnum<Shape, JsonType>;
 /**
  * Construct a TypeScript enum object at runtime from a descriptor.
+ *
+ * The returned object is identical to a transpiled TS enum and includes the
+ * reverse mapping, see https://www.typescriptlang.org/docs/handbook/enums.html#reverse-mappings
  */
-export declare function tsEnum(desc: DescEnum): enumObject;
-type enumObject = {
+export declare function tsEnum(desc: DescEnum): {
     [key: number]: string;
-    [k: string]: number | string;
+    [k: string]: string | number;
+};
+/**
+ * Construct an object enum at runtime from a descriptor.
+ *
+ * The returned object is a record of enum value name to integer value. It's
+ * a subset of transpiled TS enums - it does not include the reverse mapping,
+ * and only supports lookup by value name.
+ */
+export declare function objEnum(desc: DescEnum): {
+    [key: string]: number;
 };
-export {};

package/dist/commonjs/codegenv2/enum.js

@@ -15,6 +15,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.enumDesc = enumDesc;
 exports.tsEnum = tsEnum;
+exports.objEnum = objEnum;
 /**
  * Hydrate an enum descriptor.
  *
@@ -29,6 +30,9 @@ function enumDesc(file, path, ...paths) {
 }
 /**
  * Construct a TypeScript enum object at runtime from a descriptor.
+ *
+ * The returned object is identical to a transpiled TS enum and includes the
+ * reverse mapping, see https://www.typescriptlang.org/docs/handbook/enums.html#reverse-mappings
  */
 function tsEnum(desc) {
     const enumObject = {};
@@ -38,3 +42,17 @@ function tsEnum(desc) {
     }
     return enumObject;
 }
+/**
+ * Construct an object enum at runtime from a descriptor.
+ *
+ * The returned object is a record of enum value name to integer value. It's
+ * a subset of transpiled TS enums - it does not include the reverse mapping,
+ * and only supports lookup by value name.
+ */
+function objEnum(desc) {
+    const enumObject = {};
+    for (const value of desc.values) {
+        enumObject[value.localName] = value.number;
+    }
+    return enumObject;
+}

package/dist/commonjs/codegenv2/symbols.d.ts

@@ -70,6 +70,11 @@ export declare const symbols: {
         readonly bootstrapWktFrom: "../../json-value.js";
         readonly from: "@bufbuild/protobuf";
     };
+    readonly UnknownEnum: {
+        readonly typeOnly: true;
+        readonly bootstrapWktFrom: "../../types.js";
+        readonly from: "@bufbuild/protobuf";
+    };
     readonly codegen: {
         readonly boot: {
             readonly typeOnly: false;
@@ -106,6 +111,11 @@ export declare const symbols: {
             readonly bootstrapWktFrom: "../../codegenv2/enum.js";
             readonly from: string;
         };
+        readonly objEnum: {
+            readonly typeOnly: false;
+            readonly bootstrapWktFrom: "../../codegenv2/enum.js";
+            readonly from: string;
+        };
         readonly GenFile: {
             readonly typeOnly: true;
             readonly bootstrapWktFrom: "../../codegenv2/types.js";

package/dist/commonjs/codegenv2/symbols.js

@@ -55,6 +55,7 @@ exports.symbols = {
     protoInt64: { typeOnly: false, bootstrapWktFrom: "../../proto-int64.js", from: exports.packageName },
     JsonValue: { typeOnly: true, bootstrapWktFrom: "../../json-value.js", from: exports.packageName },
     JsonObject: { typeOnly: true, bootstrapWktFrom: "../../json-value.js", from: exports.packageName },
+    UnknownEnum: { typeOnly: true, bootstrapWktFrom: "../../types.js", from: exports.packageName },
     codegen: {
         boot: { typeOnly: false, bootstrapWktFrom: "../../codegenv2/boot.js", from: exports.packageName + "/codegenv2" },
         fileDesc: { typeOnly: false, bootstrapWktFrom: "../../codegenv2/file.js", from: exports.packageName + "/codegenv2" },
@@ -63,6 +64,7 @@ exports.symbols = {
         messageDesc: { typeOnly: false, bootstrapWktFrom: "../../codegenv2/message.js", from: exports.packageName + "/codegenv2" },
         serviceDesc: { typeOnly: false, bootstrapWktFrom: "../../codegenv2/service.js", from: exports.packageName + "/codegenv2" },
         tsEnum: { typeOnly: false, bootstrapWktFrom: "../../codegenv2/enum.js", from: exports.packageName + "/codegenv2" },
+        objEnum: { typeOnly: false, bootstrapWktFrom: "../../codegenv2/enum.js", from: exports.packageName + "/codegenv2" },
         GenFile: { typeOnly: true, bootstrapWktFrom: "../../codegenv2/types.js", from: exports.packageName + "/codegenv2" },
         GenEnum: { typeOnly: true, bootstrapWktFrom: "../../codegenv2/types.js", from: exports.packageName + "/codegenv2" },
         GenExtension: { typeOnly: true, bootstrapWktFrom: "../../codegenv2/types.js", from: exports.packageName + "/codegenv2" },

package/dist/commonjs/create.js

@@ -20,11 +20,11 @@ const scalar_js_1 = require("./reflect/scalar.js");
 const guard_js_1 = require("./reflect/guard.js");
 const unsafe_js_1 = require("./reflect/unsafe.js");
 const wrappers_js_1 = require("./wkt/wrappers.js");
-// bootstrap-inject google.protobuf.Edition.EDITION_PROTO3: const $name: Edition.$localName = $number;
+// bootstrap-inject google.protobuf.Edition.EDITION_PROTO3: const $name = $number;
 const EDITION_PROTO3 = 999;
-// bootstrap-inject google.protobuf.Edition.EDITION_PROTO2: const $name: Edition.$localName = $number;
+// bootstrap-inject google.protobuf.Edition.EDITION_PROTO2: const $name = $number;
 const EDITION_PROTO2 = 998;
-// bootstrap-inject google.protobuf.FeatureSet.FieldPresence.IMPLICIT: const $name: FeatureSet_FieldPresence.$localName = $number;
+// bootstrap-inject google.protobuf.FeatureSet.FieldPresence.IMPLICIT: const $name = $number;
 const IMPLICIT = 2;
 /**
  * Create a new message instance.

package/dist/commonjs/descriptors.d.ts

@@ -1,7 +1,7 @@
 import type { DescriptorProto, Edition, EnumDescriptorProto, EnumValueDescriptorProto, FeatureSet_FieldPresence, FieldDescriptorProto, FileDescriptorProto, MethodDescriptorProto, MethodOptions_IdempotencyLevel, OneofDescriptorProto, ServiceDescriptorProto } from "./wkt/gen/google/protobuf/descriptor_pb.js";
 import type { ScalarValue } from "./reflect/scalar.js";
-export type SupportedEdition = Extract<Edition, Edition.EDITION_PROTO2 | Edition.EDITION_PROTO3 | Edition.EDITION_2023 | Edition.EDITION_2024>;
-type SupportedFieldPresence = Extract<FeatureSet_FieldPresence, FeatureSet_FieldPresence.EXPLICIT | FeatureSet_FieldPresence.IMPLICIT | FeatureSet_FieldPresence.LEGACY_REQUIRED>;
+export type SupportedEdition = Extract<Edition, typeof Edition.EDITION_PROTO2 | typeof Edition.EDITION_PROTO3 | typeof Edition.EDITION_2023 | typeof Edition.EDITION_2024>;
+type SupportedFieldPresence = Extract<FeatureSet_FieldPresence, typeof FeatureSet_FieldPresence.EXPLICIT | typeof FeatureSet_FieldPresence.IMPLICIT | typeof FeatureSet_FieldPresence.LEGACY_REQUIRED>;
 /**
  * Scalar value types. This is a subset of field types declared by protobuf
  * enum google.protobuf.FieldDescriptorProto.Type The types GROUP and MESSAGE

package/dist/commonjs/index.d.ts

@@ -16,3 +16,4 @@ export * from "./from-json.js";
 export * from "./merge.js";
 export { hasExtension, getExtension, setExtension, clearExtension, hasOption, getOption, } from "./extensions.js";
 export * from "./proto-int64.js";
+export * from "./unknown-enum.js";

package/dist/commonjs/index.js

@@ -52,3 +52,4 @@ Object.defineProperty(exports, "clearExtension", { enumerable: true, get: functi
 Object.defineProperty(exports, "hasOption", { enumerable: true, get: function () { return extensions_js_1.hasOption; } });
 Object.defineProperty(exports, "getOption", { enumerable: true, get: function () { return extensions_js_1.getOption; } });
 __exportStar(require("./proto-int64.js"), exports);
+__exportStar(require("./unknown-enum.js"), exports);

package/dist/commonjs/reflect/reflect.js

@@ -25,6 +25,8 @@ const wrappers_js_1 = require("../wkt/wrappers.js");
 const scalar_js_1 = require("./scalar.js");
 const proto_int64_js_1 = require("../proto-int64.js");
 const guard_js_1 = require("./guard.js");
+// google.protobuf.NullValue.NULL_VALUE;
+const NULL_VALUE = 0;
 /**
  * Create a ReflectMessage.
  */
@@ -515,8 +517,7 @@ function wktValueToReflect(json) {
             break;
         case "object":
             if (json === null) {
-                const nullValue = 0;
-                value.kind = { case: "nullValue", value: nullValue };
+                value.kind = { case: "nullValue", value: NULL_VALUE };
             }
             else if (Array.isArray(json)) {
                 const listValue = {

package/dist/commonjs/reflect/unsafe.js

@@ -21,7 +21,7 @@ exports.unsafeGet = unsafeGet;
 exports.unsafeSet = unsafeSet;
 exports.unsafeClear = unsafeClear;
 const scalar_js_1 = require("./scalar.js");
-// bootstrap-inject google.protobuf.FeatureSet.FieldPresence.IMPLICIT: const $name: FeatureSet_FieldPresence.$localName = $number;
+// bootstrap-inject google.protobuf.FeatureSet.FieldPresence.IMPLICIT: const $name = $number;
 const IMPLICIT = 2;
 exports.unsafeLocal = Symbol.for("reflect unsafe local");
 /**

package/dist/commonjs/registry.js

@@ -193,43 +193,43 @@ function initBaseRegistry(inputs) {
     }
     return registry;
 }
-// bootstrap-inject google.protobuf.Edition.EDITION_PROTO2: const $name: Edition.$localName = $number;
+// bootstrap-inject google.protobuf.Edition.EDITION_PROTO2: const $name = $number;
 const EDITION_PROTO2 = 998;
-// bootstrap-inject google.protobuf.Edition.EDITION_PROTO3: const $name: Edition.$localName = $number;
+// bootstrap-inject google.protobuf.Edition.EDITION_PROTO3: const $name = $number;
 const EDITION_PROTO3 = 999;
-// bootstrap-inject google.protobuf.Edition.EDITION_UNSTABLE: const $name: Edition.$localName = $number;
+// bootstrap-inject google.protobuf.Edition.EDITION_UNSTABLE: const $name = $number;
 const EDITION_UNSTABLE = 9999;
-// bootstrap-inject google.protobuf.FieldDescriptorProto.Type.TYPE_STRING: const $name: FieldDescriptorProto_Type.$localName = $number;
+// bootstrap-inject google.protobuf.FieldDescriptorProto.Type.TYPE_STRING: const $name = $number;
 const TYPE_STRING = 9;
-// bootstrap-inject google.protobuf.FieldDescriptorProto.Type.TYPE_GROUP: const $name: FieldDescriptorProto_Type.$localName = $number;
+// bootstrap-inject google.protobuf.FieldDescriptorProto.Type.TYPE_GROUP: const $name = $number;
 const TYPE_GROUP = 10;
-// bootstrap-inject google.protobuf.FieldDescriptorProto.Type.TYPE_MESSAGE: const $name: FieldDescriptorProto_Type.$localName = $number;
+// bootstrap-inject google.protobuf.FieldDescriptorProto.Type.TYPE_MESSAGE: const $name = $number;
 const TYPE_MESSAGE = 11;
-// bootstrap-inject google.protobuf.FieldDescriptorProto.Type.TYPE_BYTES: const $name: FieldDescriptorProto_Type.$localName = $number;
+// bootstrap-inject google.protobuf.FieldDescriptorProto.Type.TYPE_BYTES: const $name = $number;
 const TYPE_BYTES = 12;
-// bootstrap-inject google.protobuf.FieldDescriptorProto.Type.TYPE_ENUM: const $name: FieldDescriptorProto_Type.$localName = $number;
+// bootstrap-inject google.protobuf.FieldDescriptorProto.Type.TYPE_ENUM: const $name = $number;
 const TYPE_ENUM = 14;
-// bootstrap-inject google.protobuf.FieldDescriptorProto.Label.LABEL_REPEATED: const $name: FieldDescriptorProto_Label.$localName = $number;
+// bootstrap-inject google.protobuf.FieldDescriptorProto.Label.LABEL_REPEATED: const $name = $number;
 const LABEL_REPEATED = 3;
-// bootstrap-inject google.protobuf.FieldDescriptorProto.Label.LABEL_REQUIRED: const $name: FieldDescriptorProto_Label.$localName = $number;
+// bootstrap-inject google.protobuf.FieldDescriptorProto.Label.LABEL_REQUIRED: const $name = $number;
 const LABEL_REQUIRED = 2;
-// bootstrap-inject google.protobuf.FieldOptions.JSType.JS_STRING: const $name: FieldOptions_JSType.$localName = $number;
+// bootstrap-inject google.protobuf.FieldOptions.JSType.JS_STRING: const $name = $number;
 const JS_STRING = 1;
-// bootstrap-inject google.protobuf.MethodOptions.IdempotencyLevel.IDEMPOTENCY_UNKNOWN: const $name: MethodOptions_IdempotencyLevel.$localName = $number;
+// bootstrap-inject google.protobuf.MethodOptions.IdempotencyLevel.IDEMPOTENCY_UNKNOWN: const $name = $number;
 const IDEMPOTENCY_UNKNOWN = 0;
-// bootstrap-inject google.protobuf.FeatureSet.FieldPresence.EXPLICIT: const $name: FeatureSet_FieldPresence.$localName = $number;
+// bootstrap-inject google.protobuf.FeatureSet.FieldPresence.EXPLICIT: const $name = $number;
 const EXPLICIT = 1;
-// bootstrap-inject google.protobuf.FeatureSet.FieldPresence.IMPLICIT: const $name: FeatureSet_FieldPresence.$localName = $number;
+// bootstrap-inject google.protobuf.FeatureSet.FieldPresence.IMPLICIT: const $name = $number;
 const IMPLICIT = 2;
-// bootstrap-inject google.protobuf.FeatureSet.FieldPresence.LEGACY_REQUIRED: const $name: FeatureSet_FieldPresence.$localName = $number;
+// bootstrap-inject google.protobuf.FeatureSet.FieldPresence.LEGACY_REQUIRED: const $name = $number;
 const LEGACY_REQUIRED = 3;
-// bootstrap-inject google.protobuf.FeatureSet.RepeatedFieldEncoding.PACKED: const $name: FeatureSet_RepeatedFieldEncoding.$localName = $number;
+// bootstrap-inject google.protobuf.FeatureSet.RepeatedFieldEncoding.PACKED: const $name = $number;
 const PACKED = 1;
-// bootstrap-inject google.protobuf.FeatureSet.MessageEncoding.DELIMITED: const $name: FeatureSet_MessageEncoding.$localName = $number;
+// bootstrap-inject google.protobuf.FeatureSet.MessageEncoding.DELIMITED: const $name = $number;
 const DELIMITED = 2;
-// bootstrap-inject google.protobuf.FeatureSet.EnumType.OPEN: const $name: FeatureSet_EnumType.$localName = $number;
+// bootstrap-inject google.protobuf.FeatureSet.EnumType.OPEN: const $name = $number;
 const OPEN = 1;
-// bootstrap-inject google.protobuf.FeatureSet.Utf8Validation.VERIFY: const $name: FeatureSet_Utf8Validation.$localName = $number;
+// bootstrap-inject google.protobuf.FeatureSet.Utf8Validation.VERIFY: const $name = $number;
 const VERIFY = 2;
 // biome-ignore format: want this to read well
 // bootstrap-inject defaults: EDITION_PROTO2 to EDITION_2024: export const minimumEdition: SupportedEdition = $minimumEdition, maximumEdition: SupportedEdition = $maximumEdition;

package/dist/commonjs/to-binary.js

@@ -18,7 +18,7 @@ exports.writeField = writeField;
 const reflect_js_1 = require("./reflect/reflect.js");
 const binary_encoding_js_1 = require("./wire/binary-encoding.js");
 const descriptors_js_1 = require("./descriptors.js");
-// bootstrap-inject google.protobuf.FeatureSet.FieldPresence.LEGACY_REQUIRED: const $name: FeatureSet_FieldPresence.$localName = $number;
+// bootstrap-inject google.protobuf.FeatureSet.FieldPresence.LEGACY_REQUIRED: const $name = $number;
 const LEGACY_REQUIRED = 3;
 // Default options for serializing binary data.
 const writeDefaults = {

package/dist/commonjs/to-json.js

@@ -24,9 +24,9 @@ const wrappers_js_1 = require("./wkt/wrappers.js");
 const index_js_2 = require("./wire/index.js");
 const extensions_js_1 = require("./extensions.js");
 const reflect_check_js_1 = require("./reflect/reflect-check.js");
-// bootstrap-inject google.protobuf.FeatureSet.FieldPresence.LEGACY_REQUIRED: const $name: FeatureSet_FieldPresence.$localName = $number;
+// bootstrap-inject google.protobuf.FeatureSet.FieldPresence.LEGACY_REQUIRED: const $name = $number;
 const LEGACY_REQUIRED = 3;
-// bootstrap-inject google.protobuf.FeatureSet.FieldPresence.IMPLICIT: const $name: FeatureSet_FieldPresence.$localName = $number;
+// bootstrap-inject google.protobuf.FeatureSet.FieldPresence.IMPLICIT: const $name = $number;
 const IMPLICIT = 2;
 // Default options for serializing to JSON.
 const jsonWriteDefaults = {

package/dist/commonjs/txtpb/from-text.d.ts

@@ -0,0 +1,35 @@
+import { type DescMessage } from "../descriptors.js";
+import type { Registry } from "../registry.js";
+import type { MessageShape } from "../types.js";
+/**
+ * Options for parsing the protobuf text format.
+ */
+export interface TextReadOptions {
+    /**
+     * The registry to resolve `google.protobuf.Any` and extensions. Parsing an
+     * Any in its expanded form, or an extension field, requires it.
+     */
+    registry?: Registry | undefined;
+    /**
+     * The maximum depth of nested messages to parse. A message nesting deeper
+     * than this fails with an error instead of exhausting the call stack.
+     * Defaults to 100.
+     */
+    recursionLimit: number;
+}
+/**
+ * Parse a message from the protobuf text format.
+ *
+ * Requires BigInt: throws immediately if the environment does not support it.
+ */
+export declare function fromText<Desc extends DescMessage>(schema: Desc, text: string, options?: Partial<TextReadOptions>): MessageShape<Desc>;
+/**
+ * Parse a message from the protobuf text format, merging into the target.
+ *
+ * Repeated fields are appended, singular fields are overwritten (last wins),
+ * message fields are merged, and map entries are added (overwriting an existing
+ * key).
+ *
+ * Requires BigInt: throws immediately if the environment does not support it.
+ */
+export declare function mergeFromText<Desc extends DescMessage>(schema: Desc, target: MessageShape<Desc>, text: string, options?: Partial<TextReadOptions>): MessageShape<Desc>;