@bufbuild/protobuf 2.0.0-alpha.3 → 2.0.0-beta.1

package/dist/esm/reflect/unsafe.js

@@ -137,19 +137,3 @@ field) {
         }
     }
 }
-/**
- * Add an item to a list field.
- *
- * @private
- */
-export function unsafeAddListItem(target, field, value) {
-    target[field.localName].push(value);
-}
-/**
- * Set a map entry.
- *
- * @private
- */
-export function unsafeSetMapEntry(target, field, key, value) {
-    target[field.localName][key] = value;
-}

package/dist/esm/registry.d.ts

@@ -39,8 +39,20 @@ export interface Registry {
     getService(typeName: string): DescService | undefined;
 }
 /**
- * A set of descriptors for messages, enumerations, extensions,
- * and services - and files.
+ * A registry that allows adding and removing descriptors.
+ */
+export interface MutableRegistry extends Registry {
+    /**
+     * Adds the given descriptor - but not types nested within - to the registry.
+     */
+    add(desc: DescMessage | DescEnum | DescExtension | DescService): void;
+    /**
+     * Remove the given descriptor - but not types nested within - from the registry.
+     */
+    remove(desc: DescMessage | DescEnum | DescExtension | DescService): void;
+}
+/**
+ * A registry that includes files.
  */
 export interface FileRegistry extends Registry {
     /**
@@ -64,6 +76,10 @@ export interface FileRegistry extends Registry {
  * For duplicate descriptors (same type name), the one given last wins.
  */
 export declare function createRegistry(...input: (Registry | DescFile | DescMessage | DescEnum | DescExtension | DescService)[]): Registry;
+/**
+ * Create a registry that allows adding and removing descriptors.
+ */
+export declare function createMutableRegistry(...input: (Registry | DescFile | DescMessage | DescEnum | DescExtension | DescService)[]): MutableRegistry;
 /**
  * Create a registry (including file descriptors) from a google.protobuf.FileDescriptorSet
  * message.

package/dist/esm/registry.js

@@ -28,28 +28,23 @@ import { protoCamelCase, safeObjectProperty } from "./reflect/names.js";
  * For duplicate descriptors (same type name), the one given last wins.
  */
 export function createRegistry(...input) {
-    const reg = createMutableRegistry();
-    for (const i of input) {
-        switch (i.kind) {
-            case "registry":
-                for (const n of i) {
-                    reg.add(n);
-                }
-                break;
-            case "file":
-                for (const n of nestedTypes(i)) {
-                    reg.add(n);
-                }
-                break;
-            default:
-                reg.add(i);
-                break;
-        }
-    }
-    return reg;
+    return initBaseRegistry(input);
+}
+/**
+ * Create a registry that allows adding and removing descriptors.
+ */
+export function createMutableRegistry(...input) {
+    const reg = initBaseRegistry(input);
+    return Object.assign(Object.assign({}, reg), { remove(desc) {
+            var _a;
+            if (desc.kind == "extension") {
+                (_a = reg.extendees.get(desc.extendee.typeName)) === null || _a === void 0 ? void 0 : _a.delete(desc.number);
+            }
+            reg.types.delete(desc.typeName);
+        } });
 }
 export function createFileRegistry(...args) {
-    const registry = createMutableRegistry();
+    const registry = createBaseRegistry();
     if ("$typeName" in args[0] &&
         args[0].$typeName == "google.protobuf.FileDescriptorSet") {
         for (const file of args[0].file) {
@@ -76,7 +71,7 @@ export function createFileRegistry(...args) {
                     throw new Error(`Unable to resolve ${protoFileName}, imported by ${file.name}`);
                 }
                 if ("kind" in dep) {
-                    addDescFile(dep, registry);
+                    registry.addFile(dep, false, true);
                 }
                 else {
                     seen.add(dep.name);
@@ -92,57 +87,53 @@ export function createFileRegistry(...args) {
     else {
         for (const fileReg of args) {
             for (const file of fileReg.files) {
-                registry.add(file);
-                for (const type of nestedTypes(file)) {
-                    registry.add(type);
-                }
+                registry.addFile(file);
             }
         }
     }
     return registry;
 }
 /**
- * Create a mutable file registry.
  * @private
  */
-function createMutableRegistry() {
+function createBaseRegistry() {
     const types = new Map();
     const extendees = new Map();
     const files = new Map();
     return {
         kind: "registry",
+        types,
+        extendees,
         [Symbol.iterator]() {
             return types.values();
         },
         get files() {
             return files.values();
         },
-        add(desc) {
-            switch (desc.kind) {
-                case "file":
-                    files.set(desc.proto.name, desc);
-                    break;
-                // @ts-expect-error TS7029
-                case "extension":
-                    // eslint-disable-next-line no-case-declarations
-                    let numberToExt = extendees.get(desc.extendee.typeName);
-                    if (!numberToExt) {
-                        extendees.set(desc.extendee.typeName, (numberToExt = new Map()));
-                    }
-                    numberToExt.set(desc.number, desc);
-                // eslint-disable-next-line no-fallthrough
-                default:
-                    types.set(desc.typeName, desc);
+        addFile(file, skipTypes, withDeps) {
+            files.set(file.proto.name, file);
+            // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
+            if (!skipTypes) {
+                for (const type of nestedTypes(file)) {
+                    this.add(type);
+                }
+            }
+            // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
+            if (withDeps) {
+                for (const f of file.dependencies) {
+                    this.addFile(f, skipTypes, withDeps);
+                }
             }
         },
-        remove(desc) {
-            switch (desc.kind) {
-                case "file":
-                    files.delete(desc.proto.name);
-                    break;
-                default:
-                    types.delete(desc.typeName);
+        add(desc) {
+            if (desc.kind == "extension") {
+                let numberToExt = extendees.get(desc.extendee.typeName);
+                if (!numberToExt) {
+                    extendees.set(desc.extendee.typeName, (numberToExt = new Map()));
+                }
+                numberToExt.set(desc.number, desc);
             }
+            types.set(desc.typeName, desc);
         },
         get(typeName) {
             return types.get(typeName);
@@ -173,16 +164,26 @@ function createMutableRegistry() {
     };
 }
 /**
- * Add the file descriptor and the types it contains to the registry.
+ * @private
  */
-function addDescFile(file, reg) {
-    reg.add(file);
-    for (const type of nestedTypes(file)) {
-        reg.add(type);
-    }
-    for (const dep of file.dependencies) {
-        addDescFile(dep, reg);
+function initBaseRegistry(inputs) {
+    const registry = createBaseRegistry();
+    for (const input of inputs) {
+        switch (input.kind) {
+            case "registry":
+                for (const n of input) {
+                    registry.add(n);
+                }
+                break;
+            case "file":
+                registry.addFile(input);
+                break;
+            default:
+                registry.add(input);
+                break;
+        }
     }
+    return registry;
 }
 // bootstrap-inject google.protobuf.Edition.EDITION_PROTO2: const $name: Edition.$localName = $number;
 const EDITION_PROTO2 = 998;
@@ -301,7 +302,7 @@ function addFile(proto, reg) {
         addFields(message, reg, mapEntries);
         addExtensions(message, reg);
     }
-    reg.add(file);
+    reg.addFile(file, true);
 }
 /**
  * Create descriptors for extensions, and add them to the message / file,

package/dist/esm/to-binary.d.ts

@@ -17,7 +17,7 @@ export interface BinaryWriteOptions {
      */
     writeUnknownFields: boolean;
 }
-export declare function toBinary<Desc extends DescMessage>(messageDesc: Desc, message: MessageShape<Desc>, options?: Partial<BinaryWriteOptions>): Uint8Array;
+export declare function toBinary<Desc extends DescMessage>(schema: Desc, message: MessageShape<Desc>, options?: Partial<BinaryWriteOptions>): Uint8Array;
 /**
  * @private
  */

package/dist/esm/to-binary.js

@@ -23,8 +23,8 @@ const writeDefaults = {
 function makeWriteOptions(options) {
     return options ? Object.assign(Object.assign({}, writeDefaults), options) : writeDefaults;
 }
-export function toBinary(messageDesc, message, options) {
-    return writeFields(new BinaryWriter(), makeWriteOptions(options), reflect(messageDesc, message)).finish();
+export function toBinary(schema, message, options) {
+    return writeFields(new BinaryWriter(), makeWriteOptions(options), reflect(schema, message)).finish();
 }
 function writeFields(writer, opts, msg) {
     var _a;

package/dist/esm/to-json.d.ts

@@ -1,7 +1,7 @@
-import { type DescMessage } from "./descriptors.js";
+import { type DescEnum, type DescMessage } from "./descriptors.js";
 import type { JsonValue } from "./json-value.js";
 import type { Registry } from "./registry.js";
-import type { MessageShape } from "./types.js";
+import type { EnumJsonType, EnumShape, MessageJsonType, MessageShape } from "./types.js";
 /**
  * Options for serializing to JSON.
  */
@@ -44,8 +44,18 @@ export interface JsonWriteStringOptions extends JsonWriteOptions {
  * Serialize the message to a JSON value, a JavaScript value that can be
  * passed to JSON.stringify().
  */
-export declare function toJson<Desc extends DescMessage>(messageDesc: Desc, message: MessageShape<Desc>, options?: Partial<JsonWriteOptions>): JsonValue;
+export declare function toJson<Desc extends DescMessage, Opts extends Partial<JsonWriteOptions> | undefined = undefined>(schema: Desc, message: MessageShape<Desc>, options?: Opts): ToJson<Desc, Opts>;
+type ToJson<Desc extends DescMessage, Opts extends undefined | Partial<JsonWriteOptions>> = Opts extends undefined | {
+    alwaysEmitImplicit?: false;
+    enumAsInteger?: false;
+    useProtoFieldName?: false;
+} ? MessageJsonType<Desc> : JsonValue;
 /**
  * Serialize the message to a JSON string.
  */
-export declare function toJsonString<Desc extends DescMessage>(messageDesc: Desc, message: MessageShape<Desc>, options?: Partial<JsonWriteStringOptions>): string;
+export declare function toJsonString<Desc extends DescMessage>(schema: Desc, message: MessageShape<Desc>, options?: Partial<JsonWriteStringOptions>): string;
+/**
+ * Serialize a single enum value to JSON.
+ */
+export declare function enumToJson<Desc extends DescEnum>(descEnum: Desc, value: EnumShape<Desc>): EnumJsonType<Desc>;
+export {};

package/dist/esm/to-json.js

@@ -37,17 +37,31 @@ function makeWriteOptions(options) {
  * Serialize the message to a JSON value, a JavaScript value that can be
  * passed to JSON.stringify().
  */
-export function toJson(messageDesc, message, options) {
-    return reflectToJson(reflect(messageDesc, message), makeWriteOptions(options));
+export function toJson(schema, message, options) {
+    return reflectToJson(reflect(schema, message), makeWriteOptions(options));
 }
 /**
  * Serialize the message to a JSON string.
  */
-export function toJsonString(messageDesc, message, options) {
+export function toJsonString(schema, message, options) {
     var _a;
-    const jsonValue = toJson(messageDesc, message, options);
+    const jsonValue = toJson(schema, message, options);
     return JSON.stringify(jsonValue, null, (_a = options === null || options === void 0 ? void 0 : options.prettySpaces) !== null && _a !== void 0 ? _a : 0);
 }
+/**
+ * Serialize a single enum value to JSON.
+ */
+export function enumToJson(descEnum, value) {
+    var _a;
+    if (descEnum.typeName == "google.protobuf.NullValue") {
+        return null;
+    }
+    const name = (_a = descEnum.values.find((v) => v.number === value)) === null || _a === void 0 ? void 0 : _a.name;
+    if (name === undefined) {
+        throw new Error(`${String(value)} is not a value in ${descEnum.toString()}`);
+    }
+    return name;
+}
 function reflectToJson(msg, opts) {
     var _a;
     const wktJson = tryWktToJson(msg, opts);
@@ -98,7 +112,7 @@ function fieldToJson(f, val, opts) {
         case "message":
             return reflectToJson(val, opts);
         case "enum":
-            return enumToJson(f.enum, val, opts.enumAsInteger);
+            return enumToJsonInternal(f.enum, val, opts.enumAsInteger);
         case "list":
             return listToJson(val, opts);
         case "map":
@@ -111,19 +125,17 @@ function mapToJson(map, opts) {
     switch (f.mapKind) {
         case "scalar":
             for (const [entryKey, entryValue] of map) {
-                jsonObj[entryKey.toString()] = scalarToJson(f, entryValue); // JSON standard allows only (double quoted) string as property key
+                jsonObj[entryKey] = scalarToJson(f, entryValue);
             }
             break;
         case "message":
             for (const [entryKey, entryValue] of map) {
-                // JSON standard allows only (double quoted) string as property key
-                jsonObj[entryKey.toString()] = reflectToJson(entryValue, opts);
+                jsonObj[entryKey] = reflectToJson(entryValue, opts);
             }
             break;
         case "enum":
             for (const [entryKey, entryValue] of map) {
-                // JSON standard allows only (double quoted) string as property key
-                jsonObj[entryKey.toString()] = enumToJson(f.enum, entryValue, opts.enumAsInteger);
+                jsonObj[entryKey] = enumToJsonInternal(f.enum, entryValue, opts.enumAsInteger);
             }
             break;
     }
@@ -140,7 +152,7 @@ function listToJson(list, opts) {
             break;
         case "enum":
             for (const item of list) {
-                jsonArr.push(enumToJson(f.enum, item, opts.enumAsInteger));
+                jsonArr.push(enumToJsonInternal(f.enum, item, opts.enumAsInteger));
             }
             break;
         case "message":
@@ -151,7 +163,7 @@ function listToJson(list, opts) {
     }
     return opts.alwaysEmitImplicit || jsonArr.length > 0 ? jsonArr : undefined;
 }
-function enumToJson(desc, value, enumAsInteger) {
+function enumToJsonInternal(desc, value, enumAsInteger) {
     var _a;
     if (typeof value != "number") {
         throw new Error(`cannot encode ${desc} to JSON: expected number, got ${formatVal(value)}`);

package/dist/esm/types.d.ts

@@ -2,6 +2,7 @@ import type { GenDescEnum, GenDescExtension, GenDescMessage } from "./codegenv1/
 import type { DescEnum, DescExtension, DescMessage } from "./descriptors.js";
 import type { OneofADT } from "./reflect/guard.js";
 import type { WireType } from "./wire/index.js";
+import type { JsonValue } from "./json-value.js";
 /**
  * The type `Message` contains the properties shared by all messages.
  */
@@ -19,6 +20,10 @@ export type Message<TypeName extends string = string> = {
  * Extract the message type from a message descriptor.
  */
 export type MessageShape<Desc extends DescMessage> = Desc extends GenDescMessage<infer RuntimeShape> ? RuntimeShape : Message;
+/**
+ * Extract the message JSON type from a message descriptor.
+ */
+export type MessageJsonType<Desc extends DescMessage> = Desc extends GenDescMessage<Message, infer JsonType> ? JsonType : JsonValue;
 /**
  * Extract the init type from a message descriptor.
  * The init type is accepted by the function create().
@@ -28,6 +33,10 @@ export type MessageInitShape<Desc extends DescMessage> = Desc extends GenDescMes
  * Extract the enum type of from an enum descriptor.
  */
 export type EnumShape<Desc extends DescEnum> = Desc extends GenDescEnum<infer RuntimeShape> ? RuntimeShape : number;
+/**
+ * Extract the enum JSON type from a enum descriptor.
+ */
+export type EnumJsonType<Desc extends DescEnum> = Desc extends GenDescEnum<unknown, infer JsonType> ? JsonType : string | null;
 /**
  * Extract the value type from an extension descriptor.
  */

package/dist/esm/wire/binary-encoding.js

@@ -457,29 +457,50 @@ export class BinaryReader {
     }
 }
 /**
- * Assert a valid signed protobuf 32-bit integer.
+ * Assert a valid signed protobuf 32-bit integer as a number or string.
  */
 function assertInt32(arg) {
-    if (typeof arg !== "number")
+    if (typeof arg == "string") {
+        arg = Number(arg);
+    }
+    else if (typeof arg != "number") {
         throw new Error("invalid int32: " + typeof arg);
-    if (!Number.isInteger(arg) || arg > INT32_MAX || arg < INT32_MIN)
+    }
+    if (!Number.isInteger(arg) ||
+        arg > INT32_MAX ||
+        arg < INT32_MIN)
         throw new Error("invalid int32: " + arg);
 }
 /**
- * Assert a valid unsigned protobuf 32-bit integer.
+ * Assert a valid unsigned protobuf 32-bit integer as a number or string.
  */
 function assertUInt32(arg) {
-    if (typeof arg !== "number")
+    if (typeof arg == "string") {
+        arg = Number(arg);
+    }
+    else if (typeof arg != "number") {
         throw new Error("invalid uint32: " + typeof arg);
-    if (!Number.isInteger(arg) || arg > UINT32_MAX || arg < 0)
+    }
+    if (!Number.isInteger(arg) ||
+        arg > UINT32_MAX ||
+        arg < 0)
         throw new Error("invalid uint32: " + arg);
 }
 /**
- * Assert a valid protobuf float value.
+ * Assert a valid protobuf float value as a number or string.
  */
 function assertFloat32(arg) {
-    if (typeof arg !== "number")
+    if (typeof arg == "string") {
+        const o = arg;
+        arg = Number(arg);
+        if (isNaN(arg) && o !== "NaN") {
+            throw new Error("invalid float32: " + o);
+        }
+    }
+    else if (typeof arg != "number") {
         throw new Error("invalid float32: " + typeof arg);
-    if (Number.isFinite(arg) && (arg > FLOAT32_MAX || arg < FLOAT32_MIN))
+    }
+    if (Number.isFinite(arg) &&
+        (arg > FLOAT32_MAX || arg < FLOAT32_MIN))
         throw new Error("invalid float32: " + arg);
 }

package/dist/esm/wkt/any.d.ts

@@ -5,15 +5,15 @@ import type { Registry } from "../registry.js";
 /**
  * Creates a `google.protobuf.Any` from a message.
  */
-export declare function anyPack<Desc extends DescMessage>(messageDesc: Desc, message: MessageShape<Desc>): Any;
+export declare function anyPack<Desc extends DescMessage>(schema: Desc, message: MessageShape<Desc>): Any;
 /**
  * Packs the message into the given any.
  */
-export declare function anyPack<Desc extends DescMessage>(messageDesc: Desc, message: MessageShape<Desc>, into: Any): void;
+export declare function anyPack<Desc extends DescMessage>(schema: Desc, message: MessageShape<Desc>, into: Any): void;
 /**
- * Returns true if the Any contains the type given by messageDesc.
+ * Returns true if the Any contains the type given by schema.
  */
-export declare function anyIs(any: Any, messageDesc: DescMessage): boolean;
+export declare function anyIs(any: Any, schema: DescMessage): boolean;
 /**
  * Returns true if the Any contains a message with the given typeName.
  */
@@ -29,10 +29,10 @@ export declare function anyUnpack(any: Any, registry: Registry): Message | undef
  * Unpacks the message the Any represents.
  *
  * Returns undefined if the Any is empty, or if it does not contain the type
- * given by messageDesc.
+ * given by schema.
  */
-export declare function anyUnpack<Desc extends DescMessage>(any: Any, messageDesc: Desc): MessageShape<Desc> | undefined;
+export declare function anyUnpack<Desc extends DescMessage>(any: Any, schema: Desc): MessageShape<Desc> | undefined;
 /**
  * Same as anyUnpack but unpacks into the target message.
  */
-export declare function anyUnpackTo<Desc extends DescMessage>(any: Any, messageDesc: Desc, message: MessageShape<Desc>): void;
+export declare function anyUnpackTo<Desc extends DescMessage>(any: Any, schema: Desc, message: MessageShape<Desc>): MessageShape<Desc> | undefined;

package/dist/esm/wkt/any.js

@@ -11,17 +11,17 @@
 // 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 { AnyDesc } from "./gen/google/protobuf/any_pb.js";
+import { AnySchema } from "./gen/google/protobuf/any_pb.js";
 import { create } from "../create.js";
 import { toBinary } from "../to-binary.js";
 import { fromBinary, mergeFromBinary } from "../from-binary.js";
-export function anyPack(messageDesc, message, into) {
+export function anyPack(schema, message, into) {
     let ret = false;
     if (!into) {
-        into = create(AnyDesc);
+        into = create(AnySchema);
         ret = true;
     }
-    into.value = toBinary(messageDesc, message);
+    into.value = toBinary(schema, message);
     into.typeUrl = typeNameToUrl(message.$typeName);
     return ret ? into : undefined;
 }
@@ -50,11 +50,11 @@ export function anyUnpack(any, registryOrMessageDesc) {
 /**
  * Same as anyUnpack but unpacks into the target message.
  */
-export function anyUnpackTo(any, messageDesc, message) {
+export function anyUnpackTo(any, schema, message) {
     if (any.typeUrl === "") {
         return undefined;
     }
-    return mergeFromBinary(messageDesc, message, any.value);
+    return mergeFromBinary(schema, message, any.value);
 }
 function typeNameToUrl(name) {
     return `type.googleapis.com/${name}`;

package/dist/esm/wkt/gen/google/protobuf/any_pb.d.ts

@@ -3,7 +3,7 @@ import type { Message } from "../../../../types.js";
 /**
  * Describes the file google/protobuf/any.proto.
  */
-export declare const fileDesc_google_protobuf_any: GenDescFile;
+export declare const file_google_protobuf_any: GenDescFile;
 /**
  * `Any` contains an arbitrary serialized protocol buffer message along with a
  * URL that describes the type of the serialized message.
@@ -136,8 +136,14 @@ export type Any = Message<"google.protobuf.Any"> & {
      */
     value: Uint8Array;
 };
+/**
+ * JSON type for the message google.protobuf.Any.
+ */
+export type AnyJson = {
+    "@type"?: string;
+};
 /**
  * Describes the message google.protobuf.Any.
- * Use `create(AnyDesc)` to create a new message.
+ * Use `create(AnySchema)` to create a new message.
  */
-export declare const AnyDesc: GenDescMessage<Any>;
+export declare const AnySchema: GenDescMessage<Any, AnyJson>;

package/dist/esm/wkt/gen/google/protobuf/any_pb.js

@@ -16,9 +16,9 @@ import { messageDesc } from "../../../../codegenv1/message.js";
 /**
  * Describes the file google/protobuf/any.proto.
  */
-export const fileDesc_google_protobuf_any = /*@__PURE__*/ fileDesc("Chlnb29nbGUvcHJvdG9idWYvYW55LnByb3RvEg9nb29nbGUucHJvdG9idWYiJgoDQW55EhAKCHR5cGVfdXJsGAEgASgJEg0KBXZhbHVlGAIgASgMQnYKE2NvbS5nb29nbGUucHJvdG9idWZCCEFueVByb3RvUAFaLGdvb2dsZS5nb2xhbmcub3JnL3Byb3RvYnVmL3R5cGVzL2tub3duL2FueXBiogIDR1BCqgIeR29vZ2xlLlByb3RvYnVmLldlbGxLbm93blR5cGVzYgZwcm90bzM");
+export const file_google_protobuf_any = /*@__PURE__*/ fileDesc("Chlnb29nbGUvcHJvdG9idWYvYW55LnByb3RvEg9nb29nbGUucHJvdG9idWYiJgoDQW55EhAKCHR5cGVfdXJsGAEgASgJEg0KBXZhbHVlGAIgASgMQnYKE2NvbS5nb29nbGUucHJvdG9idWZCCEFueVByb3RvUAFaLGdvb2dsZS5nb2xhbmcub3JnL3Byb3RvYnVmL3R5cGVzL2tub3duL2FueXBiogIDR1BCqgIeR29vZ2xlLlByb3RvYnVmLldlbGxLbm93blR5cGVzYgZwcm90bzM");
 /**
  * Describes the message google.protobuf.Any.
- * Use `create(AnyDesc)` to create a new message.
+ * Use `create(AnySchema)` to create a new message.
  */
-export const AnyDesc = /*@__PURE__*/ messageDesc(fileDesc_google_protobuf_any, 0);
+export const AnySchema = /*@__PURE__*/ messageDesc(file_google_protobuf_any, 0);