@bufbuild/protobuf 0.0.1-alpha.1 → 0.0.2-alpha.2

package/dist/types/json-format.d.ts

@@ -8,102 +8,89 @@ import type { IMessageTypeRegistry } from "./type-registry";
  * based, or delegate to speed optimized generated code.
  */
 export interface JsonFormat {
-  /**
-   * Provide options for parsing JSON data.
-   */
-  makeReadOptions(
-    options?: Partial<JsonReadOptions>
-  ): Readonly<JsonReadOptions>;
-  /**
-   * Provide options for serializing to JSON.
-   */
-  makeWriteOptions(
-    options?: Partial<JsonWriteStringOptions>
-  ): Readonly<JsonWriteStringOptions>;
-  /**
-   * Parse a message from JSON.
-   */
-  readMessage<T extends Message<T>>(
-    type: MessageType<T>,
-    jsonValue: JsonValue,
-    options: JsonReadOptions,
-    message?: T
-  ): T;
-  /**
-   * Serialize a message to JSON.
-   */
-  writeMessage(message: Message, options: JsonWriteOptions): JsonValue;
-  /**
-   * Parse a single scalar value from JSON.
-   * This method may throw an error, but it may have a blank error message.
-   * Callers are expected to provide context.
-   */
-  readScalar(type: ScalarType, json: JsonValue): any;
-  /**
-   * Serialize a single scalar value to JSON.
-   */
-  writeScalar(
-    type: ScalarType,
-    value: any,
-    emitDefaultValues: boolean
-  ): JsonValue | undefined;
-  /**
-   * Returns a short string representation of a JSON value, suitable for error messages.
-   */
-  debug(json: JsonValue): string;
+    /**
+     * Provide options for parsing JSON data.
+     */
+    makeReadOptions(options?: Partial<JsonReadOptions>): Readonly<JsonReadOptions>;
+    /**
+     * Provide options for serializing to JSON.
+     */
+    makeWriteOptions(options?: Partial<JsonWriteStringOptions>): Readonly<JsonWriteStringOptions>;
+    /**
+     * Parse a message from JSON.
+     */
+    readMessage<T extends Message<T>>(type: MessageType<T>, jsonValue: JsonValue, options: JsonReadOptions, message?: T): T;
+    /**
+     * Serialize a message to JSON.
+     */
+    writeMessage(message: Message, options: JsonWriteOptions): JsonValue;
+    /**
+     * Parse a single scalar value from JSON.
+     * This method may throw an error, but it may have a blank error message.
+     * Callers are expected to provide context.
+     */
+    readScalar(type: ScalarType, json: JsonValue): any;
+    /**
+     * Serialize a single scalar value to JSON.
+     */
+    writeScalar(type: ScalarType, value: any, emitDefaultValues: boolean): JsonValue | undefined;
+    /**
+     * Returns a short string representation of a JSON value, suitable for error messages.
+     */
+    debug(json: JsonValue): string;
 }
 /**
  * Options for parsing JSON data.
  */
 export interface JsonReadOptions {
-  /**
-   * Ignore unknown fields: Proto3 JSON parser should reject unknown fields
-   * by default. This option ignores unknown fields in parsing, as well as
-   * unrecognized enum string representations.
-   */
-  ignoreUnknownFields: boolean;
-  /**
-   * This option is required to read `google.protobuf.Any`
-   * from JSON format.
-   */
-  typeRegistry?: IMessageTypeRegistry;
+    /**
+     * Ignore unknown fields: Proto3 JSON parser should reject unknown fields
+     * by default. This option ignores unknown fields in parsing, as well as
+     * unrecognized enum string representations.
+     */
+    ignoreUnknownFields: boolean;
+    /**
+     * This option is required to read `google.protobuf.Any`
+     * from JSON format.
+     */
+    typeRegistry?: IMessageTypeRegistry;
 }
 /**
  * Options for serializing to JSON.
  */
 export interface JsonWriteOptions {
-  /**
-   * Emit fields with default values: Fields with default values are omitted
-   * by default in proto3 JSON output. This option overrides this behavior
-   * and outputs fields with their default values.
-   */
-  emitDefaultValues: boolean;
-  /**
-   * Emit enum values as integers instead of strings: The name of an enum
-   * value is used by default in JSON output. An option may be provided to
-   * use the numeric value of the enum value instead.
-   */
-  enumAsInteger: boolean;
-  /**
-   * Use proto field name instead of lowerCamelCase name: By default proto3
-   * JSON printer should convert the field name to lowerCamelCase and use
-   * that as the JSON name. An implementation may provide an option to use
-   * proto field name as the JSON name instead. Proto3 JSON parsers are
-   * required to accept both the converted lowerCamelCase name and the proto
-   * field name.
-   */
-  useProtoFieldName: boolean;
-  /**
-   * This option is required to write `google.protobuf.Any`
-   * to JSON format.
-   */
-  typeRegistry?: IMessageTypeRegistry;
+    /**
+     * Emit fields with default values: Fields with default values are omitted
+     * by default in proto3 JSON output. This option overrides this behavior
+     * and outputs fields with their default values.
+     */
+    emitDefaultValues: boolean;
+    /**
+     * Emit enum values as integers instead of strings: The name of an enum
+     * value is used by default in JSON output. An option may be provided to
+     * use the numeric value of the enum value instead.
+     */
+    enumAsInteger: boolean;
+    /**
+     * Use proto field name instead of lowerCamelCase name: By default proto3
+     * JSON printer should convert the field name to lowerCamelCase and use
+     * that as the JSON name. An implementation may provide an option to use
+     * proto field name as the JSON name instead. Proto3 JSON parsers are
+     * required to accept both the converted lowerCamelCase name and the proto
+     * field name.
+     */
+    useProtoFieldName: boolean;
+    /**
+     * This option is required to write `google.protobuf.Any`
+     * to JSON format.
+     */
+    typeRegistry?: IMessageTypeRegistry;
 }
 /**
  * Options for serializing to JSON.
  */
 export interface JsonWriteStringOptions extends JsonWriteOptions {
-  prettySpaces: number;
+    prettySpaces: number;
 }
 /**
  * Represents any possible JSON value:
@@ -114,16 +101,10 @@ export interface JsonWriteStringOptions extends JsonWriteOptions {
  * - object (with any JSON value as property)
  * - array (with any JSON value as element)
  */
-export declare type JsonValue =
-  | number
-  | string
-  | boolean
-  | null
-  | JsonObject
-  | JsonValue[];
+export declare type JsonValue = number | string | boolean | null | JsonObject | JsonValue[];
 /**
  * Represents a JSON object.
  */
 export declare type JsonObject = {
-  [k: string]: JsonValue;
+    [k: string]: JsonValue;
 };

package/dist/types/message-type.d.ts

@@ -2,12 +2,7 @@ import type { FieldList } from "./field-list.js";
 import type { ProtoRuntime } from "./private/proto-runtime.js";
 import type { JsonReadOptions, JsonValue } from "./json-format.js";
 import type { BinaryReadOptions } from "./binary-format.js";
-import type {
-  AnyMessage,
-  Message,
-  PartialMessage,
-  PlainMessage,
-} from "./message.js";
+import type { AnyMessage, Message, PartialMessage, PlainMessage } from "./message.js";
 import type { FieldWrapper } from "./private/field-wrapper.js";
 /**
  * MessageType represents a protobuf message. It provides:
@@ -16,43 +11,40 @@ import type { FieldWrapper } from "./private/field-wrapper.js";
  * - common functionality like serialization
  */
 export interface MessageType<T extends Message<T> = AnyMessage> {
-  /**
-   * Create a new instance of this type.
-   */
-  new (data?: PartialMessage<T>): T;
-  /**
-   * The fully qualified name of the message.
-   */
-  readonly typeName: string;
-  /**
-   * Field metadata.
-   */
-  readonly fields: FieldList;
-  /**
-   * Provides serialization and other functionality.
-   */
-  readonly runtime: ProtoRuntime;
-  /**
-   * When used as a field, unwrap this message to a simple value.
-   */
-  readonly fieldWrapper?: FieldWrapper<T>;
-  /**
-   * Parse serialized binary data.
-   */
-  fromBinary(data: Uint8Array, options?: Partial<BinaryReadOptions>): T;
-  /**
-   * Parse a JSON object.
-   */
-  fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): T;
-  /**
-   * Parse a JSON string.
-   */
-  fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): T;
-  /**
-   * Returns true if the given arguments have equal field values, recursively.
-   */
-  equals(
-    a: T | PlainMessage<T> | undefined,
-    b: T | PlainMessage<T> | undefined
-  ): boolean;
+    /**
+     * Create a new instance of this type.
+     */
+    new (data?: PartialMessage<T>): T;
+    /**
+     * The fully qualified name of the message.
+     */
+    readonly typeName: string;
+    /**
+     * Field metadata.
+     */
+    readonly fields: FieldList;
+    /**
+     * Provides serialization and other functionality.
+     */
+    readonly runtime: ProtoRuntime;
+    /**
+     * When used as a field, unwrap this message to a simple value.
+     */
+    readonly fieldWrapper?: FieldWrapper<T>;
+    /**
+     * Parse serialized binary data.
+     */
+    fromBinary(data: Uint8Array, options?: Partial<BinaryReadOptions>): T;
+    /**
+     * Parse a JSON object.
+     */
+    fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): T;
+    /**
+     * Parse a JSON string.
+     */
+    fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): T;
+    /**
+     * Returns true if the given arguments have equal field values, recursively.
+     */
+    equals(a: T | PlainMessage<T> | undefined, b: T | PlainMessage<T> | undefined): boolean;
 }

package/dist/types/message.d.ts

@@ -1,10 +1,5 @@
 import type { BinaryReadOptions, BinaryWriteOptions } from "./binary-format.js";
-import type {
-  JsonReadOptions,
-  JsonValue,
-  JsonWriteOptions,
-  JsonWriteStringOptions,
-} from "./json-format.js";
+import type { JsonReadOptions, JsonValue, JsonWriteOptions, JsonWriteStringOptions } from "./json-format.js";
 import type { MessageType } from "./message-type.js";
 /**
  * AnyMessage is an interface implemented by all messages. If you need to
@@ -12,7 +7,7 @@ import type { MessageType } from "./message-type.js";
  * index signature to access fields with message["fieldname"].
  */
 export interface AnyMessage extends Message<AnyMessage> {
-  [k: string]: any;
+    [k: string]: any;
 }
 /**
  * Message is the base class of every message, generated, or created at
@@ -22,58 +17,58 @@ export interface AnyMessage extends Message<AnyMessage> {
  * run time, use proto3.makeMessageType().
  */
 export declare class Message<T extends Message<T> = AnyMessage> {
-  /**
-   * Compare with a message of the same type.
-   */
-  equals(other: T | PlainMessage<T> | undefined): boolean;
-  /**
-   * Create a deep copy.
-   */
-  clone(): T;
-  /**
-   * Parse from binary data, merging fields.
-   *
-   * Repeated fields are appended. Map entries are added, overwriting
-   * existing keys.
-   *
-   * If a message field is already present, it will be merged with the
-   * new data.
-   */
-  fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): this;
-  /**
-   * Parse a message from a JSON value.
-   */
-  fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): this;
-  /**
-   * Parse a message from a JSON string.
-   */
-  fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): this;
-  /**
-   * Serialize the message to binary data.
-   */
-  toBinary(options?: Partial<BinaryWriteOptions>): Uint8Array;
-  /**
-   * Serialize the message to a JSON value, a JavaScript value that can be
-   * passed to JSON.stringify().
-   */
-  toJson(options?: Partial<JsonWriteOptions>): JsonValue;
-  /**
-   * Serialize the message to a JSON string.
-   */
-  toJsonString(options?: Partial<JsonWriteStringOptions>): string;
-  /**
-   * Retrieve the MessageType of this message - a singleton that represents
-   * the protobuf message declaration and provides metadata for reflection-
-   * based operations.
-   */
-  getType(): MessageType<T>;
+    /**
+     * Compare with a message of the same type.
+     */
+    equals(other: T | PlainMessage<T> | undefined): boolean;
+    /**
+     * Create a deep copy.
+     */
+    clone(): T;
+    /**
+     * Parse from binary data, merging fields.
+     *
+     * Repeated fields are appended. Map entries are added, overwriting
+     * existing keys.
+     *
+     * If a message field is already present, it will be merged with the
+     * new data.
+     */
+    fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): this;
+    /**
+     * Parse a message from a JSON value.
+     */
+    fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): this;
+    /**
+     * Parse a message from a JSON string.
+     */
+    fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): this;
+    /**
+     * Serialize the message to binary data.
+     */
+    toBinary(options?: Partial<BinaryWriteOptions>): Uint8Array;
+    /**
+     * Serialize the message to a JSON value, a JavaScript value that can be
+     * passed to JSON.stringify().
+     */
+    toJson(options?: Partial<JsonWriteOptions>): JsonValue;
+    /**
+     * Serialize the message to a JSON string.
+     */
+    toJsonString(options?: Partial<JsonWriteStringOptions>): string;
+    /**
+     * Retrieve the MessageType of this message - a singleton that represents
+     * the protobuf message declaration and provides metadata for reflection-
+     * based operations.
+     */
+    getType(): MessageType<T>;
 }
 /**
  * PlainMessage<T> strips all methods from a message, leaving only fields
  * and oneof groups.
  */
 export declare type PlainMessage<T extends Message> = {
-  [P in keyof T as T[P] extends Function ? never : P]: T[P];
+    [P in keyof T as T[P] extends Function ? never : P]: T[P];
 };
 /**
  * PartialMessage<T> constructs a type from a message. The resulting type
@@ -84,41 +79,21 @@ export declare type PlainMessage<T extends Message> = {
  * and respects `oneof` groups.
  */
 export declare type PartialMessage<T extends Message> = {
-  [P in keyof T as T[P] extends Function ? never : P]?: PartialField<T[P]>;
+    [P in keyof T as T[P] extends Function ? never : P]?: PartialField<T[P]>;
 };
-declare type PartialField<F> = F extends
-  | Date
-  | Uint8Array
-  | bigint
-  | boolean
-  | string
-  | number
-  ? F
-  : F extends Array<infer U>
-  ? Array<PartialField<U>>
-  : F extends ReadonlyArray<infer U>
-  ? ReadonlyArray<PartialField<U>>
-  : F extends OneofSelectedMessage<infer C, infer V>
-  ? {
-      case: C;
-      value: PartialMessage<V>;
-    }
-  : F extends {
-      case: string | undefined;
-      value?: unknown;
-    }
-  ? F
-  : F extends Message
-  ? PartialMessage<F>
-  : F extends {
-      [key: string | number]: Message<infer U>;
-    }
-  ? {
-      [key: string | number]: PartialMessage<U>;
-    }
-  : F;
+declare type PartialField<F> = F extends (Date | Uint8Array | bigint | boolean | string | number) ? F : F extends Array<infer U> ? Array<PartialField<U>> : F extends ReadonlyArray<infer U> ? ReadonlyArray<PartialField<U>> : F extends OneofSelectedMessage<infer C, infer V> ? {
+    case: C;
+    value: PartialMessage<V>;
+} : F extends {
+    case: string | undefined;
+    value?: unknown;
+} ? F : F extends Message ? PartialMessage<F> : F extends {
+    [key: string | number]: Message<infer U>;
+} ? {
+    [key: string | number]: PartialMessage<U>;
+} : F;
 declare type OneofSelectedMessage<K extends string, M extends Message> = {
-  case: K;
-  value: M;
+    case: K;
+    value: M;
 };
 export {};

package/dist/types/private/assert.d.ts

@@ -1,10 +1,7 @@
 /**
  * Assert that condition is truthy or throw error (with message)
  */
-export declare function assert(
-  condition: unknown,
-  msg?: string
-): asserts condition;
+export declare function assert(condition: unknown, msg?: string): asserts condition;
 /**
  * Assert a valid signed protobuf 32-bit integer.
  */

package/dist/types/private/binary-format-common.d.ts

@@ -3,36 +3,10 @@ import type { BinaryWriteOptions } from "../binary-format.js";
 import type { BinaryFormat } from "../binary-format.js";
 import { FieldInfo, ScalarType } from "../field.js";
 import type { MessageType } from "../message-type.js";
-export declare function makeBinaryFormatCommon(): Omit<
-  BinaryFormat,
-  "writeMessage"
->;
-export declare function writeMapEntry(
-  writer: IBinaryWriter,
-  options: BinaryWriteOptions,
-  field: FieldInfo & {
+export declare function makeBinaryFormatCommon(): Omit<BinaryFormat, "writeMessage">;
+export declare function writeMapEntry(writer: IBinaryWriter, options: BinaryWriteOptions, field: FieldInfo & {
     kind: "map";
-  },
-  key: any,
-  value: any
-): void;
-export declare function writeMessageField(
-  writer: IBinaryWriter,
-  options: BinaryWriteOptions,
-  type: MessageType,
-  fieldNo: number,
-  value: any
-): void;
-export declare function writeScalar(
-  writer: IBinaryWriter,
-  type: ScalarType,
-  fieldNo: number,
-  value: any,
-  emitIntrinsicDefault: boolean
-): void;
-export declare function writePacked(
-  writer: IBinaryWriter,
-  type: ScalarType,
-  fieldNo: number,
-  value: any[]
-): void;
+}, key: any, value: any): void;
+export declare function writeMessageField(writer: IBinaryWriter, options: BinaryWriteOptions, type: MessageType, fieldNo: number, value: any): void;
+export declare function writeScalar(writer: IBinaryWriter, type: ScalarType, fieldNo: number, value: any, emitIntrinsicDefault: boolean): void;
+export declare function writePacked(writer: IBinaryWriter, type: ScalarType, fieldNo: number, value: any[]): void;

package/dist/types/private/enum.d.ts

@@ -3,8 +3,8 @@ import type { EnumType, EnumValueInfo } from "../enum.js";
  * Represents a generated enum.
  */
 export interface EnumObject {
-  [key: number]: string;
-  [k: string]: number | string;
+    [key: number]: string;
+    [k: string]: number | string;
 }
 /**
  * Get reflection information from a generated enum.
@@ -15,15 +15,17 @@ export declare function getEnumType(enumObject: EnumObject): EnumType;
 /**
  * Sets reflection information on a generated enum.
  */
-export declare function setEnumType(
-  enumObject: EnumObject,
-  typeName: string,
-  values: EnumValueInfo[]
-): void;
+export declare function setEnumType(enumObject: EnumObject, typeName: string, values: EnumValueInfo[]): void;
 /**
  * Create a new EnumType with the given values.
  */
-export declare function makeEnumType(
-  typeName: string,
-  values: EnumValueInfo[]
-): EnumType;
+export declare function makeEnumType(typeName: string, values: EnumValueInfo[]): EnumType;
+/**
+ * Create a new enum object with the given values.
+ */
+export declare function makeEnum(typeName: string, values: EnumValueInfo[], opt?: {
+    /**
+     * MY_ENUM_ for `enum MyEnum {MY_ENUM_A=0; MY_ENUM_B=1;}`, or blank string
+     */
+    sharedPrefix?: string;
+}): EnumObject;

package/dist/types/private/field-list.d.ts

@@ -1,25 +1,18 @@
 import type { FieldInfo, OneofInfo, PartialFieldInfo } from "../field.js";
 import type { FieldList } from "../field-list.js";
-export declare type FieldListSource =
-  | readonly PartialFieldInfo[]
-  | readonly FieldInfo[]
-  | (() => readonly PartialFieldInfo[])
-  | (() => readonly FieldInfo[]);
+export declare type FieldListSource = readonly PartialFieldInfo[] | readonly FieldInfo[] | (() => readonly PartialFieldInfo[]) | (() => readonly FieldInfo[]);
 export declare class InternalFieldList implements FieldList {
-  private readonly _fields;
-  private readonly _normalizer;
-  private all?;
-  private numbersAsc?;
-  private jsonNames?;
-  private numbers?;
-  private members?;
-  constructor(
-    fields: FieldListSource,
-    normalizer: (p: FieldListSource) => FieldInfo[]
-  );
-  findJsonName(jsonName: string): FieldInfo | undefined;
-  find(fieldNo: number): FieldInfo | undefined;
-  list(): readonly FieldInfo[];
-  byNumber(): readonly FieldInfo[];
-  byMember(): readonly (FieldInfo | OneofInfo)[];
+    private readonly _fields;
+    private readonly _normalizer;
+    private all?;
+    private numbersAsc?;
+    private jsonNames?;
+    private numbers?;
+    private members?;
+    constructor(fields: FieldListSource, normalizer: (p: FieldListSource) => FieldInfo[]);
+    findJsonName(jsonName: string): FieldInfo | undefined;
+    find(fieldNo: number): FieldInfo | undefined;
+    list(): readonly FieldInfo[];
+    byNumber(): readonly FieldInfo[];
+    byMember(): readonly (FieldInfo | OneofInfo)[];
 }

package/dist/types/private/field-wrapper.d.ts

@@ -8,20 +8,14 @@ import type { MessageType } from "../message-type.js";
  * and cannot be used to arbitrarily modify types in generated code.
  */
 export interface FieldWrapper<T extends Message<T> = any, U = any> {
-  wrapField(value: U): T;
-  unwrapField(value: T): U;
+    wrapField(value: U): T;
+    unwrapField(value: T): U;
 }
 /**
  * Wrap field values whose message type has a wrapper.
  */
-export declare function wrapField<T extends Message<T>>(
-  type: MessageType<T>,
-  value: any
-): T;
+export declare function wrapField<T extends Message<T>>(type: MessageType<T>, value: any): T;
 /**
  * Unwrap field values whose message type has a wrapper.
  */
-export declare function unwrapField<T extends Message<T>>(
-  type: MessageType<T>,
-  value: T
-): any;
+export declare function unwrapField<T extends Message<T>>(type: MessageType<T>, value: T): any;

package/dist/types/private/field.d.ts

@@ -1,15 +1,15 @@
 import type { FieldInfo, OneofInfo } from "../field.js";
 export declare class InternalOneofInfo implements OneofInfo {
-  readonly kind = "oneof";
-  readonly name: string;
-  readonly localName: string;
-  readonly repeated = false;
-  readonly packed = false;
-  readonly opt = false;
-  readonly default: undefined;
-  readonly fields: FieldInfo[];
-  private _lookup?;
-  constructor(name: string);
-  addField(field: FieldInfo): void;
-  findField(localName: string): FieldInfo | undefined;
+    readonly kind = "oneof";
+    readonly name: string;
+    readonly localName: string;
+    readonly repeated = false;
+    readonly packed = false;
+    readonly opt = false;
+    readonly default: undefined;
+    readonly fields: FieldInfo[];
+    private _lookup?;
+    constructor(name: string);
+    addField(field: FieldInfo): void;
+    findField(localName: string): FieldInfo | undefined;
 }