@bufbuild/protobuf 1.3.1 → 1.3.2

package/dist/cjs/google/protobuf/struct_pb.js

@@ -14,7 +14,7 @@
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ListValue = exports.Value = exports.Struct = exports.NullValue = void 0;
-// @generated by protoc-gen-es v1.3.1 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
+// @generated by protoc-gen-es v1.3.2 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
 // @generated from file google/protobuf/struct.proto (package google.protobuf, syntax proto3)
 /* eslint-disable */
 const proto3_js_1 = require("../../proto3.js");

package/dist/cjs/google/protobuf/type_pb.js

@@ -14,7 +14,7 @@
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Option = exports.EnumValue = exports.Enum = exports.Field_Cardinality = exports.Field_Kind = exports.Field = exports.Type = exports.Syntax = void 0;
-// @generated by protoc-gen-es v1.3.1 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
+// @generated by protoc-gen-es v1.3.2 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
 // @generated from file google/protobuf/type.proto (package google.protobuf, syntax proto3)
 /* eslint-disable */
 const proto3_js_1 = require("../../proto3.js");

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

@@ -0,0 +1,421 @@
+/**
+ * Protobuf binary format wire types.
+ *
+ * A wire type provides just enough information to find the length of the
+ * following value.
+ *
+ * See https://developers.google.com/protocol-buffers/docs/encoding#structure
+ */
+export declare enum WireType {
+    /**
+     * Used for int32, int64, uint32, uint64, sint32, sint64, bool, enum
+     */
+    Varint = 0,
+    /**
+     * Used for fixed64, sfixed64, double.
+     * Always 8 bytes with little-endian byte order.
+     */
+    Bit64 = 1,
+    /**
+     * Used for string, bytes, embedded messages, packed repeated fields
+     *
+     * Only repeated numeric types (types which use the varint, 32-bit,
+     * or 64-bit wire types) can be packed. In proto3, such fields are
+     * packed by default.
+     */
+    LengthDelimited = 2,
+    /**
+     * Used for groups
+     * @deprecated
+     */
+    StartGroup = 3,
+    /**
+     * Used for groups
+     * @deprecated
+     */
+    EndGroup = 4,
+    /**
+     * Used for fixed32, sfixed32, float.
+     * Always 4 bytes with little-endian byte order.
+     */
+    Bit32 = 5
+}
+type TextEncoderLike = {
+    encode(input?: string): Uint8Array;
+};
+type TextDecoderLike = {
+    decode(input?: Uint8Array): string;
+};
+export interface IBinaryReader {
+    /**
+     * Current position.
+     */
+    readonly pos: number;
+    /**
+     * Number of bytes available in this reader.
+     */
+    readonly len: number;
+    /**
+     * Reads a tag - field number and wire type.
+     */
+    tag(): [number, WireType];
+    /**
+     * Skip one element on the wire and return the skipped data.
+     */
+    skip(wireType: WireType): Uint8Array;
+    /**
+     * Read a `int32` field, a signed 32 bit varint.
+     */
+    uint32(): number;
+    /**
+     * Read a `sint32` field, a signed, zigzag-encoded 32-bit varint.
+     */
+    int32(): number;
+    /**
+     * Read a `sint32` field, a signed, zigzag-encoded 32-bit varint.
+     */
+    sint32(): number;
+    /**
+     * Read a `int64` field, a signed 64-bit varint.
+     */
+    int64(): bigint | string;
+    /**
+     * Read a `sint64` field, a signed, zig-zag-encoded 64-bit varint.
+     */
+    sint64(): bigint | string;
+    /**
+     * Read a `fixed64` field, a signed, fixed-length 64-bit integer.
+     */
+    sfixed64(): bigint | string;
+    /**
+     * Read a `uint64` field, an unsigned 64-bit varint.
+     */
+    uint64(): bigint | string;
+    /**
+     * Read a `fixed64` field, an unsigned, fixed-length 64 bit integer.
+     */
+    fixed64(): bigint | string;
+    /**
+     * Read a `bool` field, a variant.
+     */
+    bool(): boolean;
+    /**
+     * Read a `fixed32` field, an unsigned, fixed-length 32-bit integer.
+     */
+    fixed32(): number;
+    /**
+     * Read a `sfixed32` field, a signed, fixed-length 32-bit integer.
+     */
+    sfixed32(): number;
+    /**
+     * Read a `float` field, 32-bit floating point number.
+     */
+    float(): number;
+    /**
+     * Read a `double` field, a 64-bit floating point number.
+     */
+    double(): number;
+    /**
+     * Read a `bytes` field, length-delimited arbitrary data.
+     */
+    bytes(): Uint8Array;
+    /**
+     * Read a `string` field, length-delimited data converted to UTF-8 text.
+     */
+    string(): string;
+}
+export interface IBinaryWriter {
+    /**
+     * Return all bytes written and reset this writer.
+     */
+    finish(): Uint8Array;
+    /**
+     * Start a new fork for length-delimited data like a message
+     * or a packed repeated field.
+     *
+     * Must be joined later with `join()`.
+     */
+    fork(): IBinaryWriter;
+    /**
+     * Join the last fork. Write its length and bytes, then
+     * return to the previous state.
+     */
+    join(): IBinaryWriter;
+    /**
+     * Writes a tag (field number and wire type).
+     *
+     * Equivalent to `uint32( (fieldNo << 3 | type) >>> 0 )`
+     *
+     * Generated code should compute the tag ahead of time and call `uint32()`.
+     */
+    tag(fieldNo: number, type: WireType): IBinaryWriter;
+    /**
+     * Write a chunk of raw bytes.
+     */
+    raw(chunk: Uint8Array): IBinaryWriter;
+    /**
+     * Write a `uint32` value, an unsigned 32 bit varint.
+     */
+    uint32(value: number): IBinaryWriter;
+    /**
+     * Write a `int32` value, a signed 32 bit varint.
+     */
+    int32(value: number): IBinaryWriter;
+    /**
+     * Write a `sint32` value, a signed, zigzag-encoded 32-bit varint.
+     */
+    sint32(value: number): IBinaryWriter;
+    /**
+     * Write a `int64` value, a signed 64-bit varint.
+     */
+    int64(value: string | number | bigint): IBinaryWriter;
+    /**
+     * Write a `uint64` value, an unsigned 64-bit varint.
+     */
+    uint64(value: string | number | bigint): IBinaryWriter;
+    /**
+     * Write a `sint64` value, a signed, zig-zag-encoded 64-bit varint.
+     */
+    sint64(value: string | number | bigint): IBinaryWriter;
+    /**
+     * Write a `fixed64` value, an unsigned, fixed-length 64 bit integer.
+     */
+    fixed64(value: string | number | bigint): IBinaryWriter;
+    /**
+     * Write a `fixed64` value, a signed, fixed-length 64-bit integer.
+     */
+    sfixed64(value: string | number | bigint): IBinaryWriter;
+    /**
+     * Write a `bool` value, a variant.
+     */
+    bool(value: boolean): IBinaryWriter;
+    /**
+     * Write a `fixed32` value, an unsigned, fixed-length 32-bit integer.
+     */
+    fixed32(value: number): IBinaryWriter;
+    /**
+     * Write a `sfixed32` value, a signed, fixed-length 32-bit integer.
+     */
+    sfixed32(value: number): IBinaryWriter;
+    /**
+     * Write a `float` value, 32-bit floating point number.
+     */
+    float(value: number): IBinaryWriter;
+    /**
+     * Write a `double` value, a 64-bit floating point number.
+     */
+    double(value: number): IBinaryWriter;
+    /**
+     * Write a `bytes` value, length-delimited arbitrary data.
+     */
+    bytes(value: Uint8Array): IBinaryWriter;
+    /**
+     * Write a `string` value, length-delimited data converted to UTF-8 text.
+     */
+    string(value: string): IBinaryWriter;
+}
+export declare class BinaryWriter implements IBinaryWriter {
+    /**
+     * We cannot allocate a buffer for the entire output
+     * because we don't know it's size.
+     *
+     * So we collect smaller chunks of known size and
+     * concat them later.
+     *
+     * Use `raw()` to push data to this array. It will flush
+     * `buf` first.
+     */
+    private chunks;
+    /**
+     * A growing buffer for byte values. If you don't know
+     * the size of the data you are writing, push to this
+     * array.
+     */
+    protected buf: number[];
+    /**
+     * Previous fork states.
+     */
+    private stack;
+    /**
+     * Text encoder instance to convert UTF-8 to bytes.
+     */
+    private readonly textEncoder;
+    constructor(textEncoder?: TextEncoderLike);
+    /**
+     * Return all bytes written and reset this writer.
+     */
+    finish(): Uint8Array;
+    /**
+     * Start a new fork for length-delimited data like a message
+     * or a packed repeated field.
+     *
+     * Must be joined later with `join()`.
+     */
+    fork(): IBinaryWriter;
+    /**
+     * Join the last fork. Write its length and bytes, then
+     * return to the previous state.
+     */
+    join(): IBinaryWriter;
+    /**
+     * Writes a tag (field number and wire type).
+     *
+     * Equivalent to `uint32( (fieldNo << 3 | type) >>> 0 )`.
+     *
+     * Generated code should compute the tag ahead of time and call `uint32()`.
+     */
+    tag(fieldNo: number, type: WireType): IBinaryWriter;
+    /**
+     * Write a chunk of raw bytes.
+     */
+    raw(chunk: Uint8Array): IBinaryWriter;
+    /**
+     * Write a `uint32` value, an unsigned 32 bit varint.
+     */
+    uint32(value: number): IBinaryWriter;
+    /**
+     * Write a `int32` value, a signed 32 bit varint.
+     */
+    int32(value: number): IBinaryWriter;
+    /**
+     * Write a `bool` value, a variant.
+     */
+    bool(value: boolean): IBinaryWriter;
+    /**
+     * Write a `bytes` value, length-delimited arbitrary data.
+     */
+    bytes(value: Uint8Array): IBinaryWriter;
+    /**
+     * Write a `string` value, length-delimited data converted to UTF-8 text.
+     */
+    string(value: string): IBinaryWriter;
+    /**
+     * Write a `float` value, 32-bit floating point number.
+     */
+    float(value: number): IBinaryWriter;
+    /**
+     * Write a `double` value, a 64-bit floating point number.
+     */
+    double(value: number): IBinaryWriter;
+    /**
+     * Write a `fixed32` value, an unsigned, fixed-length 32-bit integer.
+     */
+    fixed32(value: number): IBinaryWriter;
+    /**
+     * Write a `sfixed32` value, a signed, fixed-length 32-bit integer.
+     */
+    sfixed32(value: number): IBinaryWriter;
+    /**
+     * Write a `sint32` value, a signed, zigzag-encoded 32-bit varint.
+     */
+    sint32(value: number): IBinaryWriter;
+    /**
+     * Write a `fixed64` value, a signed, fixed-length 64-bit integer.
+     */
+    sfixed64(value: string | number | bigint): IBinaryWriter;
+    /**
+     * Write a `fixed64` value, an unsigned, fixed-length 64 bit integer.
+     */
+    fixed64(value: string | number | bigint): IBinaryWriter;
+    /**
+     * Write a `int64` value, a signed 64-bit varint.
+     */
+    int64(value: string | number | bigint): IBinaryWriter;
+    /**
+     * Write a `sint64` value, a signed, zig-zag-encoded 64-bit varint.
+     */
+    sint64(value: string | number | bigint): IBinaryWriter;
+    /**
+     * Write a `uint64` value, an unsigned 64-bit varint.
+     */
+    uint64(value: string | number | bigint): IBinaryWriter;
+}
+export declare class BinaryReader implements IBinaryReader {
+    /**
+     * Current position.
+     */
+    pos: number;
+    /**
+     * Number of bytes available in this reader.
+     */
+    readonly len: number;
+    private readonly buf;
+    private readonly view;
+    private readonly textDecoder;
+    constructor(buf: Uint8Array, textDecoder?: TextDecoderLike);
+    /**
+     * Reads a tag - field number and wire type.
+     */
+    tag(): [number, WireType];
+    /**
+     * Skip one element on the wire and return the skipped data.
+     * Supports WireType.StartGroup since v2.0.0-alpha.23.
+     */
+    skip(wireType: WireType): Uint8Array;
+    protected varint64: () => [number, number];
+    /**
+     * Throws error if position in byte array is out of range.
+     */
+    protected assertBounds(): void;
+    /**
+     * Read a `uint32` field, an unsigned 32 bit varint.
+     */
+    uint32: () => number;
+    /**
+     * Read a `int32` field, a signed 32 bit varint.
+     */
+    int32(): number;
+    /**
+     * Read a `sint32` field, a signed, zigzag-encoded 32-bit varint.
+     */
+    sint32(): number;
+    /**
+     * Read a `int64` field, a signed 64-bit varint.
+     */
+    int64(): bigint | string;
+    /**
+     * Read a `uint64` field, an unsigned 64-bit varint.
+     */
+    uint64(): bigint | string;
+    /**
+     * Read a `sint64` field, a signed, zig-zag-encoded 64-bit varint.
+     */
+    sint64(): bigint | string;
+    /**
+     * Read a `bool` field, a variant.
+     */
+    bool(): boolean;
+    /**
+     * Read a `fixed32` field, an unsigned, fixed-length 32-bit integer.
+     */
+    fixed32(): number;
+    /**
+     * Read a `sfixed32` field, a signed, fixed-length 32-bit integer.
+     */
+    sfixed32(): number;
+    /**
+     * Read a `fixed64` field, an unsigned, fixed-length 64 bit integer.
+     */
+    fixed64(): bigint | string;
+    /**
+     * Read a `fixed64` field, a signed, fixed-length 64-bit integer.
+     */
+    sfixed64(): bigint | string;
+    /**
+     * Read a `float` field, 32-bit floating point number.
+     */
+    float(): number;
+    /**
+     * Read a `double` field, a 64-bit floating point number.
+     */
+    double(): number;
+    /**
+     * Read a `bytes` field, length-delimited arbitrary data.
+     */
+    bytes(): Uint8Array;
+    /**
+     * Read a `string` field, length-delimited data converted to UTF-8 text.
+     */
+    string(): string;
+}
+export {};

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

@@ -0,0 +1,87 @@
+import type { Message } from "./message.js";
+import type { IBinaryReader, IBinaryWriter, WireType } from "./binary-encoding.js";
+/**
+ * BinaryFormat is the contract for serializing messages to and from binary
+ * data. Implementations may be specific to a proto syntax, and can be
+ * reflection based, or delegate to speed optimized generated code.
+ */
+export interface BinaryFormat {
+    /**
+     * Provide options for parsing binary data.
+     */
+    makeReadOptions(options?: Partial<BinaryReadOptions>): Readonly<BinaryReadOptions>;
+    /**
+     * Provide options for serializing binary data.
+     */
+    makeWriteOptions(options?: Partial<BinaryWriteOptions>): Readonly<BinaryWriteOptions>;
+    /**
+     * Parse a message from binary data, merging fields.
+     */
+    readMessage(message: Message, reader: IBinaryReader, length: number, options: BinaryReadOptions): void;
+    /**
+     * Serialize a message to binary data.
+     */
+    writeMessage(message: Message, writer: IBinaryWriter, options: BinaryWriteOptions): void;
+    /**
+     * Retrieve the unknown fields for the given message.
+     *
+     * Unknown fields are well-formed protocol buffer serialized data for
+     * fields that the parserdoes not recognize.
+     *
+     * For more details see https://developers.google.com/protocol-buffers/docs/proto3#unknowns
+     */
+    listUnknownFields(message: Message): ReadonlyArray<{
+        no: number;
+        wireType: WireType;
+        data: Uint8Array;
+    }>;
+    /**
+     * Discard unknown fields for the given message.
+     */
+    discardUnknownFields(message: Message): void;
+    /**
+     * Retrieve the unknown fields for the given message and write them to
+     * the given writer. This method is called when a message is serialized,
+     * so the fields that are unknown to the parser persist through a round
+     * trip.
+     */
+    writeUnknownFields(message: Message, writer: IBinaryWriter): void;
+    /**
+     * Store an unknown field for the given message. The parser will use this
+     * method if it does not recognize a field, unless the option
+     * `readUnknownFields` has been disabled.
+     */
+    onUnknownField(message: Message, no: number, wireType: WireType, data: Uint8Array): void;
+}
+/**
+ * Options for parsing binary data.
+ */
+export interface BinaryReadOptions {
+    /**
+     * Retain unknown fields during parsing? The default behavior is to retain
+     * unknown fields and include them in the serialized output.
+     *
+     * For more details see https://developers.google.com/protocol-buffers/docs/proto3#unknowns
+     */
+    readUnknownFields: boolean;
+    /**
+     * Allows to use a custom implementation to decode binary data.
+     */
+    readerFactory: (bytes: Uint8Array) => IBinaryReader;
+}
+/**
+ * Options for serializing to binary data.
+ */
+export interface BinaryWriteOptions {
+    /**
+     * Include unknown fields in the serialized output? The default behavior
+     * is to retain unknown fields and include them in the serialized output.
+     *
+     * For more details see https://developers.google.com/protocol-buffers/docs/proto3#unknowns
+     */
+    writeUnknownFields: boolean;
+    /**
+     * Allows to use a custom implementation to encode binary data.
+     */
+    writerFactory: () => IBinaryWriter;
+}

package/dist/esm/codegen-info.d.ts

@@ -0,0 +1,23 @@
+import { localName, safeIdentifier, safeObjectProperty } from "./private/names.js";
+import { getUnwrappedFieldType } from "./private/field-wrapper.js";
+import { scalarDefaultValue } from "./private/scalars.js";
+import { reifyWkt } from "./private/reify-wkt.js";
+interface CodegenInfo {
+    readonly packageName: string;
+    readonly localName: typeof localName;
+    readonly symbols: Record<RuntimeSymbolName, RuntimeSymbolInfo>;
+    readonly getUnwrappedFieldType: typeof getUnwrappedFieldType;
+    readonly wktSourceFiles: readonly string[];
+    readonly scalarDefaultValue: typeof scalarDefaultValue;
+    readonly reifyWkt: typeof reifyWkt;
+    readonly safeIdentifier: typeof safeIdentifier;
+    readonly safeObjectProperty: typeof safeObjectProperty;
+}
+type RuntimeSymbolName = "proto2" | "proto3" | "Message" | "PartialMessage" | "PlainMessage" | "FieldList" | "MessageType" | "BinaryReadOptions" | "BinaryWriteOptions" | "JsonReadOptions" | "JsonWriteOptions" | "JsonValue" | "JsonObject" | "protoDouble" | "protoInt64" | "ScalarType" | "MethodKind" | "MethodIdempotency" | "IMessageTypeRegistry";
+type RuntimeSymbolInfo = {
+    typeOnly: boolean;
+    publicImportPath: string;
+    privateImportPath: string;
+};
+export declare const codegenInfo: CodegenInfo;
+export {};

package/dist/esm/create-descriptor-set.d.ts

@@ -0,0 +1,16 @@
+import type { FieldDescriptorProto } from "./google/protobuf/descriptor_pb.js";
+import { FileDescriptorProto, FileDescriptorSet } from "./google/protobuf/descriptor_pb.js";
+import type { DescriptorSet } from "./descriptor-set.js";
+/**
+ * Create a DescriptorSet, a convenient interface for working with a set of
+ * google.protobuf.FileDescriptorProto.
+ *
+ * Note that files must be given in topological order, so each file appears
+ * before any file that imports it. Protocol buffer compilers always produce
+ * files in topological order.
+ */
+export declare function createDescriptorSet(input: FileDescriptorProto[] | FileDescriptorSet | Uint8Array): DescriptorSet;
+/**
+ * Get the default `packed` state of a repeated field.
+ */
+export declare function isPackedFieldByDefault(proto: FieldDescriptorProto, syntax: "proto2" | "proto3"): boolean;

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

@@ -0,0 +1,15 @@
+import type { IEnumTypeRegistry, 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 & IServiceTypeRegistry;

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

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