@bufbuild/protobuf 1.8.0 → 2.0.0-alpha.1

package/dist/cjs/service-type.js

@@ -1,53 +0,0 @@
-"use strict";
-// 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.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MethodIdempotency = exports.MethodKind = void 0;
-/**
- * MethodKind represents the four method types that can be declared in
- * protobuf with the `stream` keyword:
- *
- * 1. Unary:           rpc (Input) returns (Output)
- * 2. ServerStreaming: rpc (Input) returns (stream Output)
- * 3. ClientStreaming: rpc (stream Input) returns (Output)
- * 4. BiDiStreaming:   rpc (stream Input) returns (stream Output)
- */
-var MethodKind;
-(function (MethodKind) {
-    MethodKind[MethodKind["Unary"] = 0] = "Unary";
-    MethodKind[MethodKind["ServerStreaming"] = 1] = "ServerStreaming";
-    MethodKind[MethodKind["ClientStreaming"] = 2] = "ClientStreaming";
-    MethodKind[MethodKind["BiDiStreaming"] = 3] = "BiDiStreaming";
-})(MethodKind || (exports.MethodKind = MethodKind = {}));
-/**
- * Is this method side-effect-free (or safe in HTTP parlance), or just
- * idempotent, or neither? HTTP based RPC implementation may choose GET verb
- * for safe methods, and PUT verb for idempotent methods instead of the
- * default POST.
- *
- * This enum matches the protobuf enum google.protobuf.MethodOptions.IdempotencyLevel,
- * defined in the well-known type google/protobuf/descriptor.proto, but
- * drops UNKNOWN.
- */
-var MethodIdempotency;
-(function (MethodIdempotency) {
-    /**
-     * Idempotent, no side effects.
-     */
-    MethodIdempotency[MethodIdempotency["NoSideEffects"] = 1] = "NoSideEffects";
-    /**
-     * Idempotent, but may have side effects.
-     */
-    MethodIdempotency[MethodIdempotency["Idempotent"] = 2] = "Idempotent";
-})(MethodIdempotency || (exports.MethodIdempotency = MethodIdempotency = {}));

package/dist/cjs/to-plain-message.d.ts

@@ -1,12 +0,0 @@
-import { Message } from "./message.js";
-import type { PlainMessage } from "./message.js";
-/**
- * toPlainMessage returns a new object by stripping
- * all methods from a message, leaving only fields and
- * oneof groups. It is recursive, meaning it applies this
- * same logic to all nested message fields as well.
- *
- * If the argument is already a plain message, it is
- * returned as-is.
- */
-export declare function toPlainMessage<T extends Message<T>>(message: T | PlainMessage<T>): PlainMessage<T>;

package/dist/cjs/to-plain-message.js

@@ -1,72 +0,0 @@
-"use strict";
-// 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.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.toPlainMessage = void 0;
-const is_message_js_1 = require("./is-message.js");
-/**
- * toPlainMessage returns a new object by stripping
- * all methods from a message, leaving only fields and
- * oneof groups. It is recursive, meaning it applies this
- * same logic to all nested message fields as well.
- *
- * If the argument is already a plain message, it is
- * returned as-is.
- */
-function toPlainMessage(message) {
-    if (!(0, is_message_js_1.isMessage)(message)) {
-        return message;
-    }
-    const type = message.getType();
-    const target = {};
-    for (const member of type.fields.byMember()) {
-        const source = message[member.localName];
-        let copy;
-        if (member.repeated) {
-            copy = source.map((e) => toPlainValue(e));
-        }
-        else if (member.kind == "map") {
-            copy = {};
-            for (const [key, v] of Object.entries(source)) {
-                copy[key] = toPlainValue(v);
-            }
-        }
-        else if (member.kind == "oneof") {
-            const f = member.findField(source.case);
-            copy = f
-                ? { case: source.case, value: toPlainValue(source.value) }
-                : { case: undefined };
-        }
-        else {
-            copy = toPlainValue(source);
-        }
-        target[member.localName] = copy;
-    }
-    return target;
-}
-exports.toPlainMessage = toPlainMessage;
-function toPlainValue(value) {
-    if (value === undefined) {
-        return value;
-    }
-    if ((0, is_message_js_1.isMessage)(value)) {
-        return toPlainMessage(value);
-    }
-    if (value instanceof Uint8Array) {
-        const c = new Uint8Array(value.byteLength);
-        c.set(value);
-        return c;
-    }
-    return value;
-}

package/dist/cjs/type-registry.d.ts

@@ -1,57 +0,0 @@
-import type { MessageType } from "./message-type.js";
-import type { EnumType } from "./enum.js";
-import type { ServiceType } from "./service-type.js";
-import type { Extension } from "./extension.js";
-/**
- * IMessageTypeRegistry provides look-up for message types.
- *
- * You can conveniently create a registry using the createRegistry()
- * function:
- *
- * ```ts
- * import { createRegistry } from "@bufbuild/protobuf";
- * import { MyMessage, MyOtherMessage } from "./gen/my_message_pb.js";
- *
- * const reg: IMessageTypeRegistry = createRegistry(
- *   MyMessage,
- *   MyOtherMessage,
- * );
- * ```
- */
-export interface IMessageTypeRegistry {
-    /**
-     * Find a message type by its protobuf type name.
-     */
-    findMessage(typeName: string): MessageType | undefined;
-}
-/**
- * IEnumTypeRegistry provides look-up for enum types.
- */
-export interface IEnumTypeRegistry {
-    /**
-     * Find an enum type by its protobuf type name.
-     */
-    findEnum(typeName: string): EnumType | undefined;
-}
-/**
- * IServiceTypeRegistry provides look-up for service types.
- */
-export interface IServiceTypeRegistry {
-    /**
-     * Find a service type by its protobuf type name.
-     */
-    findService(typeName: string): ServiceType | undefined;
-}
-/**
- * IExtensionRegistry provides look-up for extensions.
- */
-export interface IExtensionRegistry {
-    /**
-     * Find an extension by the extendee type name and the extension number.
-     */
-    findExtensionFor(extendee: string, no: number): Extension | undefined;
-    /**
-     * Find an extension type by its protobuf type name.
-     */
-    findExtension(typeName: string): Extension | undefined;
-}

package/dist/cjs/type-registry.js

@@ -1,15 +0,0 @@
-"use strict";
-// 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.
-Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,420 +0,0 @@
-/**
- * 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,
-    /**
-     * Start of a tag-delimited aggregate, such as a proto2 group, or a message
-     * in editions with message_encoding = DELIMITED.
-     */
-    StartGroup = 3,
-    /**
-     * End of a tag-delimited aggregate.
-     */
-    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 {};