@bufbuild/protobuf 1.8.0 → 2.0.0-alpha.1

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

@@ -1,113 +0,0 @@
-import type { Message } from "./message.js";
-import type { IBinaryReader, IBinaryWriter, WireType } from "./binary-encoding.js";
-import type { FieldInfo } from "./field.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.
-     *
-     * Supports two message encodings:
-     * - length-prefixed: delimitedMessageEncoding is false or omitted, and
-     *   lengthOrEndTagFieldNo is the expected length of the message in the reader.
-     * - delimited: delimitedMessageEncoding is true, and lengthOrEndTagFieldNo is
-     *   the field number in a tag with wire type end-group signalling the end of
-     *   the message in the reader.
-     *
-     * delimitedMessageEncoding is optional for backwards compatibility.
-     */
-    readMessage(message: Message, reader: IBinaryReader, lengthOrEndTagFieldNo: number, options: BinaryReadOptions, delimitedMessageEncoding?: boolean): void;
-    /**
-     * Parse a field from binary data, and store it in the given target.
-     *
-     * The target must be an initialized message object, with oneof groups,
-     * repeated fields and maps already present.
-     */
-    readField(target: Record<string, any>, // eslint-disable-line @typescript-eslint/no-explicit-any -- `any` is the best choice for dynamic access
-    reader: IBinaryReader, field: FieldInfo, wireType: WireType, options: BinaryReadOptions): void;
-    /**
-     * Serialize a message to binary data.
-     */
-    writeMessage(message: Message, writer: IBinaryWriter, options: BinaryWriteOptions): void;
-    /**
-     * Serialize a field value to binary data.
-     *
-     * The value must be an array for repeated fields, a record object for map
-     * fields. Only selected oneof fields should be passed to this method.
-     */
-    writeField(field: FieldInfo, value: any, // eslint-disable-line @typescript-eslint/no-explicit-any -- `any` is the best choice for dynamic access
-    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

@@ -1,33 +0,0 @@
-import { reifyWkt } from "./private/reify-wkt.js";
-import type { DescEnum, DescEnumValue, DescField, DescExtension, DescMessage, DescMethod, DescOneof, DescService } from "./descriptor-set.js";
-import type { ScalarValue } from "./scalar.js";
-import { LongType, ScalarType } from "./scalar.js";
-interface CodegenInfo {
-    /**
-     * Name of the runtime library NPM package.
-     */
-    readonly packageName: string;
-    readonly localName: (desc: DescEnum | DescEnumValue | DescMessage | DescExtension | DescOneof | DescField | DescService | DescMethod) => string;
-    readonly symbols: Record<RuntimeSymbolName, RuntimeSymbolInfo>;
-    readonly getUnwrappedFieldType: (field: DescField | DescExtension) => ScalarType | undefined;
-    readonly wktSourceFiles: readonly string[];
-    /**
-     * @deprecated please use scalarZeroValue instead
-     */
-    readonly scalarDefaultValue: (type: ScalarType, longType: LongType) => any;
-    readonly scalarZeroValue: <T extends ScalarType, L extends LongType>(type: T, longType: L) => ScalarValue<T, L>;
-    /**
-     * @deprecated please use reifyWkt from @bufbuild/protoplugin/ecmascript instead
-     */
-    readonly reifyWkt: typeof reifyWkt;
-    readonly safeIdentifier: (name: string) => string;
-    readonly safeObjectProperty: (name: string) => string;
-}
-type RuntimeSymbolName = "proto2" | "proto3" | "Message" | "PartialMessage" | "PlainMessage" | "FieldList" | "MessageType" | "Extension" | "BinaryReadOptions" | "BinaryWriteOptions" | "JsonReadOptions" | "JsonWriteOptions" | "JsonValue" | "JsonObject" | "protoDouble" | "protoInt64" | "ScalarType" | "LongType" | "MethodKind" | "MethodIdempotency" | "IMessageTypeRegistry";
-type RuntimeSymbolInfo = {
-    typeOnly: boolean;
-    publicImportPath: string;
-    privateImportPath: string;
-};
-export declare const codegenInfo: CodegenInfo;
-export {};

package/dist/esm/codegen-info.js

@@ -1,67 +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 { localName, safeIdentifier, safeObjectProperty, } from "./private/names.js";
-import { getUnwrappedFieldType } from "./private/field-wrapper.js";
-import { scalarZeroValue } from "./private/scalars.js";
-import { reifyWkt } from "./private/reify-wkt.js";
-import { LongType, ScalarType } from "./scalar.js";
-const packageName = "@bufbuild/protobuf";
-export const codegenInfo = {
-    packageName: "@bufbuild/protobuf",
-    localName,
-    reifyWkt,
-    getUnwrappedFieldType,
-    scalarDefaultValue: scalarZeroValue,
-    scalarZeroValue,
-    safeIdentifier,
-    safeObjectProperty,
-    // prettier-ignore
-    symbols: {
-        proto2: { typeOnly: false, privateImportPath: "./proto2.js", publicImportPath: packageName },
-        proto3: { typeOnly: false, privateImportPath: "./proto3.js", publicImportPath: packageName },
-        Message: { typeOnly: false, privateImportPath: "./message.js", publicImportPath: packageName },
-        PartialMessage: { typeOnly: true, privateImportPath: "./message.js", publicImportPath: packageName },
-        PlainMessage: { typeOnly: true, privateImportPath: "./message.js", publicImportPath: packageName },
-        FieldList: { typeOnly: true, privateImportPath: "./field-list.js", publicImportPath: packageName },
-        MessageType: { typeOnly: true, privateImportPath: "./message-type.js", publicImportPath: packageName },
-        Extension: { typeOnly: true, privateImportPath: "./extension.js", publicImportPath: packageName },
-        BinaryReadOptions: { typeOnly: true, privateImportPath: "./binary-format.js", publicImportPath: packageName },
-        BinaryWriteOptions: { typeOnly: true, privateImportPath: "./binary-format.js", publicImportPath: packageName },
-        JsonReadOptions: { typeOnly: true, privateImportPath: "./json-format.js", publicImportPath: packageName },
-        JsonWriteOptions: { typeOnly: true, privateImportPath: "./json-format.js", publicImportPath: packageName },
-        JsonValue: { typeOnly: true, privateImportPath: "./json-format.js", publicImportPath: packageName },
-        JsonObject: { typeOnly: true, privateImportPath: "./json-format.js", publicImportPath: packageName },
-        protoDouble: { typeOnly: false, privateImportPath: "./proto-double.js", publicImportPath: packageName },
-        protoInt64: { typeOnly: false, privateImportPath: "./proto-int64.js", publicImportPath: packageName },
-        ScalarType: { typeOnly: false, privateImportPath: "./scalar.js", publicImportPath: packageName },
-        LongType: { typeOnly: false, privateImportPath: "./scalar.js", publicImportPath: packageName },
-        MethodKind: { typeOnly: false, privateImportPath: "./service-type.js", publicImportPath: packageName },
-        MethodIdempotency: { typeOnly: false, privateImportPath: "./service-type.js", publicImportPath: packageName },
-        IMessageTypeRegistry: { typeOnly: true, privateImportPath: "./type-registry.js", publicImportPath: packageName },
-    },
-    wktSourceFiles: [
-        "google/protobuf/compiler/plugin.proto",
-        "google/protobuf/any.proto",
-        "google/protobuf/api.proto",
-        "google/protobuf/descriptor.proto",
-        "google/protobuf/duration.proto",
-        "google/protobuf/empty.proto",
-        "google/protobuf/field_mask.proto",
-        "google/protobuf/source_context.proto",
-        "google/protobuf/struct.proto",
-        "google/protobuf/timestamp.proto",
-        "google/protobuf/type.proto",
-        "google/protobuf/wrappers.proto",
-    ],
-};

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

@@ -1,36 +0,0 @@
-import { FeatureSetDefaults, FileDescriptorProto, FileDescriptorSet } from "./google/protobuf/descriptor_pb.js";
-import type { DescriptorSet } from "./descriptor-set.js";
-import type { BinaryReadOptions, BinaryWriteOptions } from "./binary-format.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, options?: CreateDescriptorSetOptions): DescriptorSet;
-/**
- * Options to createDescriptorSet()
- */
-interface CreateDescriptorSetOptions {
-    /**
-     * Editions support language-specific features with extensions to
-     * google.protobuf.FeatureSet. They can define defaults, and specify on
-     * which targets the features can be set.
-     *
-     * To create a DescriptorSet that provides your language-specific features,
-     * you have to provide a google.protobuf.FeatureSetDefaults message in this
-     * option. It can also specify the minimum and maximum supported edition.
-     *
-     * The defaults can be generated with `protoc` - see the flag
-     * `--experimental_edition_defaults_out`.
-     */
-    featureSetDefaults?: FeatureSetDefaults;
-    /**
-     * Internally, data is serialized when features are resolved. The
-     * serialization options given here will be used for feature resolution.
-     */
-    serializationOptions?: Partial<BinaryReadOptions & BinaryWriteOptions>;
-}
-export {};