@bufbuild/protobuf 1.9.0 → 2.0.0-alpha.2

package/dist/esm/create-registry-from-desc.d.ts

@@ -1,15 +0,0 @@
-import type { IEnumTypeRegistry, IExtensionRegistry, IMessageTypeRegistry, IServiceTypeRegistry } from "./type-registry.js";
-import { FileDescriptorSet } from "./google/protobuf/descriptor_pb.js";
-import type { DescriptorSet } from "./descriptor-set.js";
-/**
- * Create a registry from a set of descriptors. The types returned by this
- * registry behave exactly like types from generated code.
- *
- * This function accepts google.protobuf.FileDescriptorSet in serialized or
- * deserialized form. Alternatively, it also accepts a DescriptorSet (see
- * createDescriptorSet()).
- *
- * By default, all well-known types with a specialized JSON representation
- * are replaced with their generated counterpart in this package.
- */
-export declare function createRegistryFromDescriptors(input: DescriptorSet | FileDescriptorSet | Uint8Array, replaceWkt?: boolean): IMessageTypeRegistry & IEnumTypeRegistry & IExtensionRegistry & IServiceTypeRegistry;

package/dist/esm/create-registry-from-desc.js

@@ -1,261 +0,0 @@
-// 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.
-import { assert } from "./private/assert.js";
-import { proto3 } from "./proto3.js";
-import { proto2 } from "./proto2.js";
-import { ScalarType } from "./scalar.js";
-import { localName } from "./private/names.js";
-import { Timestamp } from "./google/protobuf/timestamp_pb.js";
-import { Duration } from "./google/protobuf/duration_pb.js";
-import { Any } from "./google/protobuf/any_pb.js";
-import { Empty } from "./google/protobuf/empty_pb.js";
-import { FieldMask } from "./google/protobuf/field_mask_pb.js";
-import { ListValue, NullValue, Struct, Value, } from "./google/protobuf/struct_pb.js";
-import { getEnumType } from "./private/enum.js";
-import { BoolValue, BytesValue, DoubleValue, FloatValue, Int32Value, Int64Value, StringValue, UInt32Value, UInt64Value, } from "./google/protobuf/wrappers_pb.js";
-import { FieldDescriptorProto_Label, FieldDescriptorProto_Type, FileDescriptorSet, } from "./google/protobuf/descriptor_pb.js";
-import { createDescriptorSet } from "./create-descriptor-set.js";
-import { isMessage } from "./is-message.js";
-// well-known message types with specialized JSON representation
-const wkMessages = [
-    Any,
-    Duration,
-    Empty,
-    FieldMask,
-    Struct,
-    Value,
-    ListValue,
-    Timestamp,
-    Duration,
-    DoubleValue,
-    FloatValue,
-    Int64Value,
-    Int32Value,
-    UInt32Value,
-    UInt64Value,
-    BoolValue,
-    StringValue,
-    BytesValue,
-];
-// well-known enum types with specialized JSON representation
-const wkEnums = [getEnumType(NullValue)];
-/**
- * Create a registry from a set of descriptors. The types returned by this
- * registry behave exactly like types from generated code.
- *
- * This function accepts google.protobuf.FileDescriptorSet in serialized or
- * deserialized form. Alternatively, it also accepts a DescriptorSet (see
- * createDescriptorSet()).
- *
- * By default, all well-known types with a specialized JSON representation
- * are replaced with their generated counterpart in this package.
- */
-export function createRegistryFromDescriptors(input, replaceWkt = true) {
-    const set = input instanceof Uint8Array || isMessage(input, FileDescriptorSet)
-        ? createDescriptorSet(input)
-        : input;
-    const enums = new Map();
-    const messages = new Map();
-    const extensions = new Map();
-    const extensionsByExtendee = new Map();
-    const services = {};
-    if (replaceWkt) {
-        for (const mt of wkMessages) {
-            messages.set(mt.typeName, mt);
-        }
-        for (const et of wkEnums) {
-            enums.set(et.typeName, et);
-        }
-    }
-    return {
-        /**
-         * May raise an error on invalid descriptors.
-         */
-        findEnum(typeName) {
-            const existing = enums.get(typeName);
-            if (existing) {
-                return existing;
-            }
-            const desc = set.enums.get(typeName);
-            if (!desc) {
-                return undefined;
-            }
-            const runtime = desc.file.syntax == "proto3" ? proto3 : proto2;
-            const type = runtime.makeEnumType(typeName, desc.values.map((u) => ({
-                no: u.number,
-                name: u.name,
-                localName: localName(u),
-            })), {});
-            enums.set(typeName, type);
-            return type;
-        },
-        /**
-         * May raise an error on invalid descriptors.
-         */
-        findMessage(typeName) {
-            const existing = messages.get(typeName);
-            if (existing) {
-                return existing;
-            }
-            const desc = set.messages.get(typeName);
-            if (!desc) {
-                return undefined;
-            }
-            const runtime = desc.file.syntax == "proto3" ? proto3 : proto2;
-            const fields = [];
-            const type = runtime.makeMessageType(typeName, () => fields, {
-                localName: localName(desc),
-            });
-            messages.set(typeName, type);
-            for (const field of desc.fields) {
-                fields.push(makeFieldInfo(field, this));
-            }
-            return type;
-        },
-        /**
-         * May raise an error on invalid descriptors.
-         */
-        findService(typeName) {
-            const existing = services[typeName];
-            if (existing) {
-                return existing;
-            }
-            const desc = set.services.get(typeName);
-            if (!desc) {
-                return undefined;
-            }
-            const methods = {};
-            for (const method of desc.methods) {
-                const I = resolve(method.input, this, method);
-                const O = resolve(method.output, this, method);
-                methods[localName(method)] = {
-                    name: method.name,
-                    I,
-                    O,
-                    kind: method.methodKind,
-                    idempotency: method.idempotency,
-                    // We do not surface options at this time
-                    // options: {},
-                };
-            }
-            return (services[typeName] = {
-                typeName: desc.typeName,
-                methods,
-            });
-        },
-        /**
-         * May raise an error on invalid descriptors.
-         */
-        findExtensionFor(typeName, no) {
-            var _a;
-            if (!set.messages.has(typeName)) {
-                return undefined;
-            }
-            let extensionsByNo = extensionsByExtendee.get(typeName);
-            if (!extensionsByNo) {
-                // maintain a lookup for extension desc by number
-                extensionsByNo = new Map();
-                extensionsByExtendee.set(typeName, extensionsByNo);
-                for (const desc of set.extensions.values()) {
-                    if (desc.extendee.typeName == typeName) {
-                        extensionsByNo.set(desc.number, desc);
-                    }
-                }
-            }
-            const desc = (_a = extensionsByExtendee.get(typeName)) === null || _a === void 0 ? void 0 : _a.get(no);
-            return desc ? this.findExtension(desc.typeName) : undefined;
-        },
-        /**
-         * May raise an error on invalid descriptors.
-         */
-        findExtension(typeName) {
-            const existing = extensions.get(typeName);
-            if (existing) {
-                return existing;
-            }
-            const desc = set.extensions.get(typeName);
-            if (!desc) {
-                return undefined;
-            }
-            const extendee = resolve(desc.extendee, this, desc);
-            const runtime = desc.file.syntax == "proto3" ? proto3 : proto2;
-            const ext = runtime.makeExtension(typeName, extendee, makeFieldInfo(desc, this));
-            extensions.set(typeName, ext);
-            return ext;
-        },
-    };
-}
-function makeFieldInfo(desc, registry) {
-    var _a;
-    const f = {
-        kind: desc.fieldKind,
-        no: desc.number,
-        name: desc.name,
-        jsonName: desc.jsonName,
-        delimited: desc.proto.type == FieldDescriptorProto_Type.GROUP,
-        repeated: desc.repeated,
-        packed: desc.packed,
-        oneof: (_a = desc.oneof) === null || _a === void 0 ? void 0 : _a.name,
-        opt: desc.optional,
-        req: desc.proto.label === FieldDescriptorProto_Label.REQUIRED,
-    };
-    switch (desc.fieldKind) {
-        case "map": {
-            assert(desc.kind == "field"); // maps are not allowed for extensions
-            let T;
-            switch (desc.mapValue.kind) {
-                case "scalar":
-                    T = desc.mapValue.scalar;
-                    break;
-                case "enum": {
-                    T = resolve(desc.mapValue.enum, registry, desc);
-                    break;
-                }
-                case "message": {
-                    T = resolve(desc.mapValue.message, registry, desc);
-                    break;
-                }
-            }
-            f.K = desc.mapKey;
-            f.V = {
-                kind: desc.mapValue.kind,
-                T,
-            };
-            break;
-        }
-        case "message": {
-            f.T = resolve(desc.message, registry, desc);
-            break;
-        }
-        case "enum": {
-            f.T = resolve(desc.enum, registry, desc);
-            f.default = desc.getDefaultValue();
-            break;
-        }
-        case "scalar": {
-            f.L = desc.longType;
-            f.T = desc.scalar;
-            f.default = desc.getDefaultValue();
-            break;
-        }
-    }
-    return f;
-}
-function resolve(desc, registry, context) {
-    const type = desc.kind == "message"
-        ? registry.findMessage(desc.typeName)
-        : registry.findEnum(desc.typeName);
-    assert(type, `${desc.toString()}" for ${context.toString()} not found`);
-    return type;
-}

package/dist/esm/create-registry.d.ts

@@ -1,9 +0,0 @@
-import type { MessageType } from "./message-type.js";
-import type { EnumType } from "./enum.js";
-import type { ServiceType } from "./service-type.js";
-import type { IEnumTypeRegistry, IExtensionRegistry, IMessageTypeRegistry, IServiceTypeRegistry } from "./type-registry.js";
-import type { Extension } from "./extension.js";
-/**
- * Create a new registry from the given types.
- */
-export declare function createRegistry(...types: Array<MessageType | EnumType | ServiceType | Extension>): IMessageTypeRegistry & IEnumTypeRegistry & IExtensionRegistry & IServiceTypeRegistry;

package/dist/esm/create-registry.js

@@ -1,90 +0,0 @@
-// 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.
-/**
- * Create a new registry from the given types.
- */
-export function createRegistry(...types) {
-    const messages = {};
-    const enums = {};
-    const services = {};
-    const extensionsByName = new Map();
-    const extensionsByExtendee = new Map();
-    const registry = {
-        findMessage(typeName) {
-            return messages[typeName];
-        },
-        findEnum(typeName) {
-            return enums[typeName];
-        },
-        findService(typeName) {
-            return services[typeName];
-        },
-        findExtensionFor(typeName, no) {
-            var _a, _b;
-            return (_b = (_a = extensionsByExtendee.get(typeName)) === null || _a === void 0 ? void 0 : _a.get(no)) !== null && _b !== void 0 ? _b : undefined;
-        },
-        findExtension(typeName) {
-            var _a;
-            return (_a = extensionsByName.get(typeName)) !== null && _a !== void 0 ? _a : undefined;
-        },
-    };
-    function addType(type) {
-        var _a;
-        if ("fields" in type) {
-            if (!registry.findMessage(type.typeName)) {
-                messages[type.typeName] = type;
-                type.fields.list().forEach(addField);
-            }
-        }
-        else if ("methods" in type) {
-            if (!registry.findService(type.typeName)) {
-                services[type.typeName] = type;
-                for (const method of Object.values(type.methods)) {
-                    addType(method.I);
-                    addType(method.O);
-                }
-            }
-        }
-        else if ("extendee" in type) {
-            if (!extensionsByName.has(type.typeName)) {
-                extensionsByName.set(type.typeName, type);
-                const extendeeName = type.extendee.typeName;
-                if (!extensionsByExtendee.has(extendeeName)) {
-                    extensionsByExtendee.set(extendeeName, new Map());
-                }
-                (_a = extensionsByExtendee.get(extendeeName)) === null || _a === void 0 ? void 0 : _a.set(type.field.no, type);
-                addType(type.extendee);
-                addField(type.field);
-            }
-        }
-        else {
-            enums[type.typeName] = type;
-        }
-    }
-    function addField(field) {
-        if (field.kind == "message") {
-            addType(field.T);
-        }
-        else if (field.kind == "map" && field.V.kind == "message") {
-            addType(field.V.T);
-        }
-        else if (field.kind == "enum") {
-            addType(field.T);
-        }
-    }
-    for (const type of types) {
-        addType(type);
-    }
-    return registry;
-}

package/dist/esm/descriptor-set.js

@@ -1,14 +0,0 @@
-// 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.
-import { LongType, ScalarType } from "./scalar.js";

package/dist/esm/enum.d.ts

@@ -1,35 +0,0 @@
-/**
- * Reflection information for a protobuf enumeration.
- */
-export interface EnumType {
-    /**
-     * The fully qualified name of the enumeration.
-     */
-    readonly typeName: string;
-    readonly values: readonly EnumValueInfo[];
-    /**
-     * Find an enum value by its (protobuf) name.
-     */
-    findName(name: string): EnumValueInfo | undefined;
-    /**
-     * Find an enum value by its number.
-     */
-    findNumber(no: number): EnumValueInfo | undefined;
-}
-/**
- * Reflection information for a protobuf enumeration value.
- */
-export interface EnumValueInfo {
-    /**
-     * The numeric enumeration value, as specified in the protobuf source.
-     */
-    readonly no: number;
-    /**
-     * The name of the enumeration value, as specified in the protobuf source.
-     */
-    readonly name: string;
-    /**
-     * The name of the enumeration value in generated code.
-     */
-    readonly localName: string;
-}

package/dist/esm/extension-accessor.d.ts

@@ -1,35 +0,0 @@
-import type { Message } from "./message.js";
-import type { BinaryReadOptions, BinaryWriteOptions } from "./binary-format.js";
-import type { Extension } from "./extension.js";
-/**
- * Retrieve an extension value from a message.
- *
- * The function never returns undefined. Use hasExtension() to check whether an
- * extension is set. If the extension is not set, this function returns the
- * default value (if one was specified in the protobuf source), or the zero value
- * (for example `0` for numeric types, `[]` for repeated extension fields, and
- * an empty message instance for message fields).
- *
- * Extensions are stored as unknown fields on a message. To mutate an extension
- * value, make sure to store the new value with setExtension() after mutating.
- *
- * If the extension does not extend the given message, an error is raised.
- */
-export declare function getExtension<E extends Message<E>, V>(message: E, extension: Extension<E, V>, options?: Partial<BinaryReadOptions>): V;
-/**
- * Set an extension value on a message. If the message already has a value for
- * this extension, the value is replaced.
- *
- * If the extension does not extend the given message, an error is raised.
- */
-export declare function setExtension<E extends Message<E>, V>(message: E, extension: Extension<E, V>, value: V, options?: Partial<BinaryReadOptions & BinaryWriteOptions>): void;
-/**
- * Remove an extension value from a message.
- *
- * If the extension does not extend the given message, an error is raised.
- */
-export declare function clearExtension<E extends Message<E>, V>(message: E, extension: Extension<E, V>): void;
-/**
- * Check whether an extension is set on a message.
- */
-export declare function hasExtension<E extends Message<E>, V>(message: E, extension: Extension<E, V>): boolean;

package/dist/esm/extension-accessor.js

@@ -1,107 +0,0 @@
-// 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.
-import { assert } from "./private/assert.js";
-import { createExtensionContainer, filterUnknownFields, } from "./private/extensions.js";
-/**
- * Retrieve an extension value from a message.
- *
- * The function never returns undefined. Use hasExtension() to check whether an
- * extension is set. If the extension is not set, this function returns the
- * default value (if one was specified in the protobuf source), or the zero value
- * (for example `0` for numeric types, `[]` for repeated extension fields, and
- * an empty message instance for message fields).
- *
- * Extensions are stored as unknown fields on a message. To mutate an extension
- * value, make sure to store the new value with setExtension() after mutating.
- *
- * If the extension does not extend the given message, an error is raised.
- */
-export function getExtension(message, extension, options) {
-    assertExtendee(extension, message);
-    const opt = extension.runtime.bin.makeReadOptions(options);
-    const ufs = filterUnknownFields(message.getType().runtime.bin.listUnknownFields(message), extension.field);
-    const [container, get] = createExtensionContainer(extension);
-    for (const uf of ufs) {
-        extension.runtime.bin.readField(container, opt.readerFactory(uf.data), extension.field, uf.wireType, opt);
-    }
-    return get();
-}
-/**
- * Set an extension value on a message. If the message already has a value for
- * this extension, the value is replaced.
- *
- * If the extension does not extend the given message, an error is raised.
- */
-export function setExtension(message, extension, value, options) {
-    assertExtendee(extension, message);
-    const readOpt = extension.runtime.bin.makeReadOptions(options);
-    const writeOpt = extension.runtime.bin.makeWriteOptions(options);
-    if (hasExtension(message, extension)) {
-        const ufs = message
-            .getType()
-            .runtime.bin.listUnknownFields(message)
-            .filter((uf) => uf.no != extension.field.no);
-        message.getType().runtime.bin.discardUnknownFields(message);
-        for (const uf of ufs) {
-            message
-                .getType()
-                .runtime.bin.onUnknownField(message, uf.no, uf.wireType, uf.data);
-        }
-    }
-    const writer = writeOpt.writerFactory();
-    let f = extension.field;
-    // Implicit presence does not apply to extensions, see https://github.com/protocolbuffers/protobuf/issues/8234
-    // We patch the field info to use explicit presence:
-    if (!f.opt && !f.repeated && (f.kind == "enum" || f.kind == "scalar")) {
-        f = Object.assign(Object.assign({}, extension.field), { opt: true });
-    }
-    extension.runtime.bin.writeField(f, value, writer, writeOpt);
-    const reader = readOpt.readerFactory(writer.finish());
-    while (reader.pos < reader.len) {
-        const [no, wireType] = reader.tag();
-        const data = reader.skip(wireType);
-        message.getType().runtime.bin.onUnknownField(message, no, wireType, data);
-    }
-}
-/**
- * Remove an extension value from a message.
- *
- * If the extension does not extend the given message, an error is raised.
- */
-export function clearExtension(message, extension) {
-    assertExtendee(extension, message);
-    if (hasExtension(message, extension)) {
-        const bin = message.getType().runtime.bin;
-        const ufs = bin
-            .listUnknownFields(message)
-            .filter((uf) => uf.no != extension.field.no);
-        bin.discardUnknownFields(message);
-        for (const uf of ufs) {
-            bin.onUnknownField(message, uf.no, uf.wireType, uf.data);
-        }
-    }
-}
-/**
- * Check whether an extension is set on a message.
- */
-export function hasExtension(message, extension) {
-    const messageType = message.getType();
-    return (extension.extendee.typeName === messageType.typeName &&
-        !!messageType.runtime.bin
-            .listUnknownFields(message)
-            .find((uf) => uf.no == extension.field.no));
-}
-function assertExtendee(extension, message) {
-    assert(extension.extendee.typeName == message.getType().typeName, `extension ${extension.typeName} can only be applied to message ${extension.extendee.typeName}`);
-}

package/dist/esm/extension.d.ts

@@ -1,24 +0,0 @@
-import type { FieldInfo } from "./field.js";
-import type { AnyMessage, Message } from "./message.js";
-import type { MessageType } from "./message-type.js";
-import type { ProtoRuntime } from "./private/proto-runtime.js";
-export interface Extension<E extends Message<E> = AnyMessage, V = unknown> {
-    /**
-     * The fully qualified name of the extension.
-     */
-    readonly typeName: string;
-    /**
-     * The message extended by this extension.
-     */
-    readonly extendee: MessageType<E>;
-    /**
-     * Field information for this extension. Note that required fields, maps,
-     * oneof are not allowed in extensions. Behavior of "localName" property is
-     * undefined and must not be relied upon.
-     */
-    readonly field: FieldInfo;
-    /**
-     * Provides serialization and other functionality.
-     */
-    readonly runtime: ProtoRuntime;
-}

package/dist/esm/field-list.d.ts

@@ -1,27 +0,0 @@
-import type { FieldInfo, OneofInfo } from "./field.js";
-/**
- * Provides convenient access to field information of a message type.
- */
-export interface FieldList {
-    /**
-     * Find field information by field name or json_name.
-     */
-    findJsonName(jsonName: string): FieldInfo | undefined;
-    /**
-     * Find field information by proto field number.
-     */
-    find(fieldNo: number): FieldInfo | undefined;
-    /**
-     * Return field information in the order they appear in the source.
-     */
-    list(): readonly FieldInfo[];
-    /**
-     * Return field information ordered by field number ascending.
-     */
-    byNumber(): readonly FieldInfo[];
-    /**
-     * In order of appearance in the source, list fields and
-     * oneof groups.
-     */
-    byMember(): readonly (FieldInfo | OneofInfo)[];
-}