@bufbuild/protobuf 1.2.0 → 1.3.0

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

@@ -0,0 +1,63 @@
+// Copyright 2021-2023 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.
+/* eslint-disable @typescript-eslint/no-explicit-any,@typescript-eslint/no-unsafe-assignment,@typescript-eslint/no-unsafe-member-access,@typescript-eslint/no-unsafe-return,@typescript-eslint/no-unsafe-argument,no-case-declarations */
+import { Message } from "./message.js";
+/**
+ * toPlainMessage returns a new object by striping
+ * 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.
+ */
+export function toPlainMessage(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;
+}
+function toPlainValue(value) {
+    if (value === undefined) {
+        return value;
+    }
+    if (value instanceof Message) {
+        return toPlainMessage(value);
+    }
+    if (value instanceof Uint8Array) {
+        const c = new Uint8Array(value.byteLength);
+        c.set(value);
+        return c;
+    }
+    return value;
+}

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

@@ -13,7 +13,7 @@ interface CodegenInfo {
     readonly safeIdentifier: typeof safeIdentifier;
     readonly safeObjectProperty: typeof safeObjectProperty;
 }
-type RuntimeSymbolName = "proto2" | "proto3" | "Message" | "PartialMessage" | "PlainMessage" | "FieldList" | "MessageType" | "BinaryReadOptions" | "BinaryWriteOptions" | "JsonReadOptions" | "JsonWriteOptions" | "JsonValue" | "JsonObject" | "protoInt64" | "ScalarType" | "MethodKind" | "MethodIdempotency" | "IMessageTypeRegistry";
+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;

package/dist/types/google/protobuf/any_pb.d.ts

@@ -36,7 +36,7 @@ import type { BinaryReadOptions } from "../../binary-format.js";
  *       foo = any.unpack(Foo.getDefaultInstance());
  *     }
  *
- * Example 3: Pack and unpack a message in Python.
+ *  Example 3: Pack and unpack a message in Python.
  *
  *     foo = Foo(...)
  *     any = Any()
@@ -46,7 +46,7 @@ import type { BinaryReadOptions } from "../../binary-format.js";
  *       any.Unpack(foo)
  *       ...
  *
- * Example 4: Pack and unpack a message in Go
+ *  Example 4: Pack and unpack a message in Go
  *
  *      foo := &pb.Foo{...}
  *      any, err := anypb.New(foo)
@@ -66,7 +66,7 @@ import type { BinaryReadOptions } from "../../binary-format.js";
  * name "y.z".
  *
  * JSON
- *
+ * ====
  * The JSON representation of an `Any` value uses the regular
  * representation of the deserialized, embedded message, with an
  * additional field `@type` which contains the type URL. Example:

package/dist/types/google/protobuf/api_pb.d.ts

@@ -197,7 +197,7 @@ export declare class Method extends Message<Method> {
  * The mixin construct implies that all methods in `AccessControl` are
  * also declared with same name and request/response types in
  * `Storage`. A documentation generator or annotation processor will
- * see the effective `Storage.GetAcl` method after inheriting
+ * see the effective `Storage.GetAcl` method after inherting
  * documentation and annotations as follows:
  *
  *     service Storage {

package/dist/types/google/protobuf/descriptor_pb.d.ts

@@ -242,6 +242,23 @@ export declare class ExtensionRangeOptions extends Message<ExtensionRangeOptions
      * @generated from field: repeated google.protobuf.UninterpretedOption uninterpreted_option = 999;
      */
     uninterpretedOption: UninterpretedOption[];
+    /**
+     * go/protobuf-stripping-extension-declarations
+     * Like Metadata, but we use a repeated field to hold all extension
+     * declarations. This should avoid the size increases of transforming a large
+     * extension range into small ranges in generated binaries.
+     *
+     * @generated from field: repeated google.protobuf.ExtensionRangeOptions.Declaration declaration = 2;
+     */
+    declaration: ExtensionRangeOptions_Declaration[];
+    /**
+     * The verification state of the range.
+     * TODO(b/278783756): flip the default to DECLARATION once all empty ranges
+     * are marked as UNVERIFIED.
+     *
+     * @generated from field: optional google.protobuf.ExtensionRangeOptions.VerificationState verification = 3 [default = UNVERIFIED];
+     */
+    verification?: ExtensionRangeOptions_VerificationState;
     constructor(data?: PartialMessage<ExtensionRangeOptions>);
     static readonly runtime: typeof proto2;
     static readonly typeName = "google.protobuf.ExtensionRangeOptions";
@@ -251,6 +268,79 @@ export declare class ExtensionRangeOptions extends Message<ExtensionRangeOptions
     static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): ExtensionRangeOptions;
     static equals(a: ExtensionRangeOptions | PlainMessage<ExtensionRangeOptions> | undefined, b: ExtensionRangeOptions | PlainMessage<ExtensionRangeOptions> | undefined): boolean;
 }
+/**
+ * The verification state of the extension range.
+ *
+ * @generated from enum google.protobuf.ExtensionRangeOptions.VerificationState
+ */
+export declare enum ExtensionRangeOptions_VerificationState {
+    /**
+     * All the extensions of the range must be declared.
+     *
+     * @generated from enum value: DECLARATION = 0;
+     */
+    DECLARATION = 0,
+    /**
+     * @generated from enum value: UNVERIFIED = 1;
+     */
+    UNVERIFIED = 1
+}
+/**
+ * @generated from message google.protobuf.ExtensionRangeOptions.Declaration
+ */
+export declare class ExtensionRangeOptions_Declaration extends Message<ExtensionRangeOptions_Declaration> {
+    /**
+     * The extension number declared within the extension range.
+     *
+     * @generated from field: optional int32 number = 1;
+     */
+    number?: number;
+    /**
+     * The fully-qualified name of the extension field. There must be a leading
+     * dot in front of the full name.
+     *
+     * @generated from field: optional string full_name = 2;
+     */
+    fullName?: string;
+    /**
+     * The fully-qualified type name of the extension field. Unlike
+     * Metadata.type, Declaration.type must have a leading dot for messages
+     * and enums.
+     *
+     * @generated from field: optional string type = 3;
+     */
+    type?: string;
+    /**
+     * Deprecated. Please use "repeated".
+     *
+     * @generated from field: optional bool is_repeated = 4 [deprecated = true];
+     * @deprecated
+     */
+    isRepeated?: boolean;
+    /**
+     * If true, indicates that the number is reserved in the extension range,
+     * and any extension field with the number will fail to compile. Set this
+     * when a declared extension field is deleted.
+     *
+     * @generated from field: optional bool reserved = 5;
+     */
+    reserved?: boolean;
+    /**
+     * If true, indicates that the extension must be defined as repeated.
+     * Otherwise the extension must be defined as optional.
+     *
+     * @generated from field: optional bool repeated = 6;
+     */
+    repeated?: boolean;
+    constructor(data?: PartialMessage<ExtensionRangeOptions_Declaration>);
+    static readonly runtime: typeof proto2;
+    static readonly typeName = "google.protobuf.ExtensionRangeOptions.Declaration";
+    static readonly fields: FieldList;
+    static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): ExtensionRangeOptions_Declaration;
+    static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): ExtensionRangeOptions_Declaration;
+    static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): ExtensionRangeOptions_Declaration;
+    static equals(a: ExtensionRangeOptions_Declaration | PlainMessage<ExtensionRangeOptions_Declaration> | undefined, b: ExtensionRangeOptions_Declaration | PlainMessage<ExtensionRangeOptions_Declaration> | undefined): boolean;
+}
 /**
  * Describes a field within a message.
  *
@@ -985,8 +1075,10 @@ export declare class FieldOptions extends Message<FieldOptions> {
     /**
      * The ctype option instructs the C++ code generator to use a different
      * representation of the field than it normally would.  See the specific
-     * options below.  This option is not yet implemented in the open source
-     * release -- sorry, we'll try to include it in a future version!
+     * options below.  This option is only implemented to support use of
+     * [ctype=CORD] and [ctype=STRING] (the default) on non-repeated fields of
+     * type "bytes" in the open source release -- sorry, we'll try to include
+     * other types in a future version!
      *
      * @generated from field: optional google.protobuf.FieldOptions.CType ctype = 1 [default = STRING];
      */
@@ -1087,9 +1179,14 @@ export declare class FieldOptions extends Message<FieldOptions> {
      */
     retention?: FieldOptions_OptionRetention;
     /**
-     * @generated from field: optional google.protobuf.FieldOptions.OptionTargetType target = 18;
+     * @generated from field: optional google.protobuf.FieldOptions.OptionTargetType target = 18 [deprecated = true];
+     * @deprecated
      */
     target?: FieldOptions_OptionTargetType;
+    /**
+     * @generated from field: repeated google.protobuf.FieldOptions.OptionTargetType targets = 19;
+     */
+    targets: FieldOptions_OptionTargetType[];
     /**
      * The parser stores options it doesn't recognize here. See above.
      *
@@ -1116,6 +1213,13 @@ export declare enum FieldOptions_CType {
      */
     STRING = 0,
     /**
+     * The option [ctype=CORD] may be applied to a non-repeated field of type
+     * "bytes". It indicates that in C++, the data should be stored in a Cord
+     * instead of a string.  For very large strings, this may reduce memory
+     * fragmentation. It may also allow better performance when parsing from a
+     * Cord, or when parsing with aliasing enabled, as the parsed Cord may then
+     * alias the original buffer.
+     *
      * @generated from enum value: CORD = 1;
      */
     CORD = 1,

package/dist/types/google/protobuf/struct_pb.d.ts

@@ -8,7 +8,7 @@ import type { BinaryReadOptions } from "../../binary-format.js";
  * `NullValue` is a singleton enumeration to represent the null value for the
  * `Value` type union.
  *
- *  The JSON representation for `NullValue` is JSON `null`.
+ * The JSON representation for `NullValue` is JSON `null`.
  *
  * @generated from enum google.protobuf.NullValue
  */

package/dist/types/google/protobuf/timestamp_pb.d.ts

@@ -92,7 +92,7 @@ import type { BinaryReadOptions } from "../../binary-format.js";
  * [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
  * the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
  * the Joda Time's [`ISODateTimeFormat.dateTime()`](
- * http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D
+ * http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()
  * ) to obtain a formatter capable of generating timestamps in this format.
  *
  *

package/dist/types/google/protobuf/type_pb.d.ts

@@ -23,7 +23,13 @@ export declare enum Syntax {
      *
      * @generated from enum value: SYNTAX_PROTO3 = 1;
      */
-    PROTO3 = 1
+    PROTO3 = 1,
+    /**
+     * Syntax `editions`.
+     *
+     * @generated from enum value: SYNTAX_EDITIONS = 2;
+     */
+    EDITIONS = 2
 }
 /**
  * A protocol buffer message type.
@@ -67,6 +73,12 @@ export declare class Type extends Message<Type> {
      * @generated from field: google.protobuf.Syntax syntax = 6;
      */
     syntax: Syntax;
+    /**
+     * The source edition string, only valid when syntax is SYNTAX_EDITIONS.
+     *
+     * @generated from field: string edition = 7;
+     */
+    edition: string;
     constructor(data?: PartialMessage<Type>);
     static readonly runtime: typeof proto3;
     static readonly typeName = "google.protobuf.Type";
@@ -341,6 +353,12 @@ export declare class Enum extends Message<Enum> {
      * @generated from field: google.protobuf.Syntax syntax = 5;
      */
     syntax: Syntax;
+    /**
+     * The source edition string, only valid when syntax is SYNTAX_EDITIONS.
+     *
+     * @generated from field: string edition = 6;
+     */
+    edition: string;
     constructor(data?: PartialMessage<Enum>);
     static readonly runtime: typeof proto3;
     static readonly typeName = "google.protobuf.Enum";

package/dist/types/index.d.ts

@@ -1,10 +1,12 @@
 export { proto3 } from "./proto3.js";
 export { proto2 } from "./proto2.js";
+export { protoDouble } from "./proto-double.js";
 export { protoInt64 } from "./proto-int64.js";
 export { protoBase64 } from "./proto-base64.js";
 export { protoDelimited } from "./proto-delimited.js";
 export { codegenInfo } from "./codegen-info.js";
-export { Message, AnyMessage, PartialMessage, PlainMessage, } from "./message.js";
+export { Message } from "./message.js";
+export type { AnyMessage, PartialMessage, PlainMessage } from "./message.js";
 export type { FieldInfo } from "./field.js";
 export type { FieldList } from "./field-list.js";
 export { ScalarType } from "./field.js";
@@ -15,12 +17,13 @@ export { MethodKind, MethodIdempotency } from "./service-type.js";
 export { WireType, BinaryWriter, BinaryReader } from "./binary-encoding.js";
 export type { IBinaryReader, IBinaryWriter } from "./binary-encoding.js";
 export type { BinaryFormat, BinaryWriteOptions, BinaryReadOptions, } from "./binary-format.js";
-export { JsonFormat, JsonObject, JsonValue, JsonReadOptions, JsonWriteOptions, JsonWriteStringOptions, } from "./json-format.js";
-export { DescriptorSet, AnyDesc, DescFile, DescEnum, DescEnumValue, DescMessage, DescOneof, DescField, DescService, DescMethod, DescExtension, DescComments, } from "./descriptor-set.js";
+export type { JsonFormat, JsonObject, JsonValue, JsonReadOptions, JsonWriteOptions, JsonWriteStringOptions, } from "./json-format.js";
+export type { DescriptorSet, AnyDesc, DescFile, DescEnum, DescEnumValue, DescMessage, DescOneof, DescField, DescService, DescMethod, DescExtension, DescComments, } from "./descriptor-set.js";
 export { createDescriptorSet } from "./create-descriptor-set.js";
-export { IMessageTypeRegistry } from "./type-registry.js";
+export type { IMessageTypeRegistry } from "./type-registry.js";
 export { createRegistry } from "./create-registry.js";
 export { createRegistryFromDescriptors } from "./create-registry-from-desc.js";
+export { toPlainMessage } from "./to-plain-message.js";
 export * from "./google/protobuf/compiler/plugin_pb.js";
 export * from "./google/protobuf/api_pb.js";
 export * from "./google/protobuf/any_pb.js";

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

@@ -1,7 +1,8 @@
-import { IBinaryWriter } from "../binary-encoding.js";
+import type { IBinaryWriter } from "../binary-encoding.js";
 import type { BinaryWriteOptions } from "../binary-format.js";
 import type { BinaryFormat } from "../binary-format.js";
-import { FieldInfo, ScalarType } from "../field.js";
+import { ScalarType } from "../field.js";
+import type { FieldInfo } 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 & {

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

@@ -1,5 +1,6 @@
 import type { JsonFormat, JsonValue, JsonWriteOptions } from "../json-format.js";
-import { FieldInfo, ScalarType } from "../field.js";
+import { ScalarType } from "../field.js";
+import type { FieldInfo } from "../field.js";
 import type { EnumType } from "../enum.js";
 type JsonFormatWriteFieldFn = (field: FieldInfo, value: any, options: JsonWriteOptions) => JsonValue | undefined;
 export declare function makeJsonFormatCommon(makeWriteField: (writeEnumFn: typeof writeEnum, writeScalarFn: typeof writeScalar) => JsonFormatWriteFieldFn): JsonFormat;

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

@@ -1,4 +1,5 @@
-import { AnyMessage, Message } from "../message.js";
+import { Message } from "../message.js";
+import type { AnyMessage } from "../message.js";
 import type { FieldListSource } from "./field-list.js";
 import type { MessageType } from "../message-type.js";
 import type { ProtoRuntime } from "./proto-runtime.js";

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

@@ -1,5 +1,6 @@
 import { ScalarType } from "../field.js";
-import { IBinaryWriter, WireType } from "../binary-encoding.js";
+import type { IBinaryWriter } from "../binary-encoding.js";
+import { WireType } from "../binary-encoding.js";
 /**
  * Returns true if both scalar values are equal.
  */

package/dist/types/proto-base64.d.ts

@@ -12,15 +12,7 @@ export declare const protoBase64: {
      */
     readonly dec: (base64Str: string) => Uint8Array;
     /**
-     * Decodes a base64 string to a byte array.
-     *
-     * - ignores white-space, including line breaks and tabs
-     * - allows inner padding (can decode concatenated base64 strings)
-     * - does not require padding
-     * - understands base64url encoding:
-     *   "-" instead of "+",
-     *   "_" instead of "/",
-     *   no padding
+     * Encode a byte array to a base64 string.
      */
     readonly enc: (bytes: Uint8Array) => string;
 };

package/dist/types/proto-double.d.ts

@@ -0,0 +1,5 @@
+export declare const protoDouble: {
+    readonly NaN: number;
+    readonly POSITIVE_INFINITY: number;
+    readonly NEGATIVE_INFINITY: number;
+};

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

@@ -0,0 +1,9 @@
+import { Message } from "./message.js";
+import type { PlainMessage } from "./message.js";
+/**
+ * toPlainMessage returns a new object by striping
+ * 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.
+ */
+export declare function toPlainMessage<T extends Message<T>>(message: T): PlainMessage<T>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bufbuild/protobuf",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "license": "(Apache-2.0 AND BSD-3-Clause)",
   "description": "A complete implementation of Protocol Buffers in TypeScript, suitable for web browsers and Node.js.",
   "repository": {
@@ -13,7 +13,7 @@
     "clean": "rm -rf ./dist/cjs/* ./dist/esm/* ./dist/types/*",
     "build": "npm run build:cjs && npm run build:esm+types",
     "build:cjs": "../../node_modules/typescript/bin/tsc --project tsconfig.json --module commonjs --outDir ./dist/cjs && echo >./dist/cjs/package.json '{\"type\":\"commonjs\"}'",
-    "build:esm+types": "../../node_modules/typescript/bin/tsc --project tsconfig.json --module ES2015 --outDir ./dist/esm --declaration --declarationDir ./dist/types"
+    "build:esm+types": "../../node_modules/typescript/bin/tsc --project tsconfig.json --module ES2015 --verbatimModuleSyntax --outDir ./dist/esm --declaration --declarationDir ./dist/types"
   },
   "main": "./dist/cjs/index.js",
   "type": "module",