@bufbuild/protobuf 1.4.2 → 1.5.0

package/dist/cjs/descriptor-set.d.ts

@@ -1,6 +1,7 @@
-import type { DescriptorProto, EnumDescriptorProto, EnumValueDescriptorProto, FieldDescriptorProto, FileDescriptorProto, MethodDescriptorProto, OneofDescriptorProto, ServiceDescriptorProto } from "./google/protobuf/descriptor_pb.js";
-import type { ScalarType, LongType } from "./field.js";
+import type { DescriptorProto, Edition, EnumDescriptorProto, EnumValueDescriptorProto, FieldDescriptorProto, FileDescriptorProto, MethodDescriptorProto, OneofDescriptorProto, ServiceDescriptorProto } from "./google/protobuf/descriptor_pb.js";
+import type { LongType, ScalarType } from "./field.js";
 import type { MethodIdempotency, MethodKind } from "./service-type.js";
+import type { MergedFeatureSet } from "./private/feature-set.js";
 /**
  * DescriptorSet provides a convenient interface for working with a set
  * of google.protobuf.FileDescriptorProto.
@@ -50,7 +51,12 @@ export interface DescFile {
     /**
      * The syntax specified in the protobuf source.
      */
-    readonly syntax: "proto3" | "proto2";
+    readonly syntax: "proto3" | "proto2" | "editions";
+    /**
+     * The edition of the protobuf file. Will be EDITION_PROTO2 for syntax="proto2",
+     * EDITION_PROTO3 for syntax="proto3";
+     */
+    readonly edition: Exclude<Edition, Edition.EDITION_1_TEST_ONLY | Edition.EDITION_2_TEST_ONLY | Edition.EDITION_99997_TEST_ONLY | Edition.EDITION_99998_TEST_ONLY | Edition.EDITION_99999_TEST_ONLY>;
     /**
      * The name of the file, excluding the .proto suffix.
      * For a protobuf file `foo/bar.proto`, this is `foo/bar`.
@@ -91,6 +97,10 @@ export interface DescFile {
      * Get comments on the package element in the protobuf source.
      */
     getPackageComments(): DescComments;
+    /**
+     * Get the edition features for this protobuf element.
+     */
+    getFeatures(): MergedFeatureSet;
     toString(): string;
 }
 /**
@@ -135,6 +145,10 @@ export interface DescEnum {
      * Get comments on the element in the protobuf source.
      */
     getComments(): DescComments;
+    /**
+     * Get the edition features for this protobuf element.
+     */
+    getFeatures(): MergedFeatureSet;
     toString(): string;
 }
 /**
@@ -171,6 +185,10 @@ export interface DescEnumValue {
      * Get comments on the element in the protobuf source.
      */
     getComments(): DescComments;
+    /**
+     * Get the edition features for this protobuf element.
+     */
+    getFeatures(): MergedFeatureSet;
     toString(): string;
 }
 /**
@@ -234,6 +252,10 @@ export interface DescMessage {
      * Get comments on the element in the protobuf source.
      */
     getComments(): DescComments;
+    /**
+     * Get the edition features for this protobuf element.
+     */
+    getFeatures(): MergedFeatureSet;
     toString(): string;
 }
 /**
@@ -290,10 +312,14 @@ interface DescFieldCommon {
      */
     readonly packed: boolean;
     /**
-     * Is this field packed by default? Only valid for enum fields, and for
-     * scalar fields except BYTES and STRING.
+     * Is this field packed by default? Only valid for repeated enum fields, and
+     * for repeated scalar fields except BYTES and STRING.
+     *
      * In proto3 syntax, fields are packed by default. In proto2 syntax, fields
      * are unpacked by default.
+     *
+     * With editions, the default is whatever the edition specifies as a default.
+     * In edition 2023, fields are packed by default.
      */
     readonly packedByDefault: boolean;
     /**
@@ -318,6 +344,10 @@ interface DescFieldCommon {
      * protobuf source.
      */
     declarationString(): string;
+    /**
+     * Get the edition features for this protobuf element.
+     */
+    getFeatures(): MergedFeatureSet;
     toString(): string;
 }
 interface DescFieldScalar {
@@ -534,6 +564,10 @@ export interface DescOneof {
      * Get comments on the element in the protobuf source.
      */
     getComments(): DescComments;
+    /**
+     * Get the edition features for this protobuf element.
+     */
+    getFeatures(): MergedFeatureSet;
     toString(): string;
 }
 /**
@@ -569,6 +603,10 @@ export interface DescService {
      * Get comments on the element in the protobuf source.
      */
     getComments(): DescComments;
+    /**
+     * Get the edition features for this protobuf element.
+     */
+    getFeatures(): MergedFeatureSet;
     toString(): string;
 }
 /**
@@ -612,6 +650,10 @@ export interface DescMethod {
      * Get comments on the element in the protobuf source.
      */
     getComments(): DescComments;
+    /**
+     * Get the edition features for this protobuf element.
+     */
+    getFeatures(): MergedFeatureSet;
     toString(): string;
 }
 /**

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

@@ -240,7 +240,7 @@ class Any extends message_js_1.Message {
             throw new Error(`invalid type url: ${url}`);
         }
         const slash = url.lastIndexOf("/");
-        const name = slash > 0 ? url.substring(slash + 1) : url;
+        const name = slash >= 0 ? url.substring(slash + 1) : url;
         if (!name.length) {
             throw new Error(`invalid type url: ${url}`);
         }

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

@@ -21,7 +21,7 @@ exports.GeneratedCodeInfo_Annotation_Semantic = exports.GeneratedCodeInfo_Annota
 // The messages in this file describe the definitions found in .proto files.
 // A valid .proto file can be translated directly to a FileDescriptorProto
 // without any other information (e.g. without reading its imports).
-// @generated by protoc-gen-es v1.4.2 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
+// @generated by protoc-gen-es v1.5.0 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
 // @generated from file google/protobuf/descriptor.proto (package google.protobuf, syntax proto2)
 /* eslint-disable */
 const proto2_js_1 = require("../../proto2.js");

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.4.2 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
+// @generated by protoc-gen-es v1.5.0 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.4.2 with parameter "bootstrap_wkt=true,ts_nocheck=false,target=ts"
+// @generated by protoc-gen-es v1.5.0 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/cjs/private/feature-set.d.ts

@@ -0,0 +1,21 @@
+import { Edition, FeatureSet, FeatureSetDefaults } from "../google/protobuf/descriptor_pb.js";
+/**
+ * Static edition feature defaults supported by @bufbuild/protobuf.
+ */
+export declare const featureSetDefaults: FeatureSetDefaults;
+/**
+ * A merged google.protobuf.FeaturesSet, with all fields guaranteed to be set.
+ */
+export type MergedFeatureSet = FeatureSet & Required<FeatureSet>;
+/**
+ * A function that resolves features for the given edition.
+ *
+ * If no feature set is provided, the default feature set for the edition is
+ * returned. If features are provided, they are merged into the edition default
+ * features.
+ */
+export type FeatureResolverFn = (edition: Edition, a?: FeatureSet, b?: FeatureSet) => MergedFeatureSet;
+/**
+ * Create an edition feature resolver with the given feature set defaults.
+ */
+export declare function createFeatureResolver(compiledFeatureSetDefaults: FeatureSetDefaults): FeatureResolverFn;

package/dist/cjs/private/feature-set.js

@@ -0,0 +1,107 @@
+"use strict";
+// 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.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createFeatureResolver = exports.featureSetDefaults = void 0;
+const descriptor_pb_js_1 = require("../google/protobuf/descriptor_pb.js");
+const proto_base64_js_1 = require("../proto-base64.js");
+/**
+ * Static edition feature defaults supported by @bufbuild/protobuf.
+ */
+exports.featureSetDefaults = descriptor_pb_js_1.FeatureSetDefaults.fromBinary(proto_base64_js_1.protoBase64.dec(
+/*upstream-inject-feature-defaults-start*/ "ChESDAgBEAIYAiABKAEwAhjmBwoREgwIAhABGAEgAigBMAEY5wcKERIMCAEQARgBIAIoATABGOgHIOYHKOgH" /*upstream-inject-feature-defaults-end*/));
+/**
+ * Create an edition feature resolver with the given feature set defaults.
+ */
+function createFeatureResolver(compiledFeatureSetDefaults) {
+    const min = compiledFeatureSetDefaults.minimumEdition;
+    const max = compiledFeatureSetDefaults.maximumEdition;
+    if (min === undefined ||
+        max === undefined ||
+        compiledFeatureSetDefaults.defaults.some((d) => d.edition === undefined)) {
+        throw new Error("Invalid FeatureSetDefaults");
+    }
+    const defaultsBinByEdition = new Map();
+    return (edition, ...rest) => {
+        var _a, _b;
+        let defaultsBin = defaultsBinByEdition.get(edition);
+        if (defaultsBin === undefined) {
+            if (edition < min) {
+                throw new Error(`Edition ${descriptor_pb_js_1.Edition[edition]} is earlier than the minimum supported edition ${descriptor_pb_js_1.Edition[min]}`);
+            }
+            if (max < edition) {
+                throw new Error(`Edition ${descriptor_pb_js_1.Edition[edition]} is later than the maximum supported edition ${descriptor_pb_js_1.Edition[max]}`);
+            }
+            let highestMatch = undefined;
+            for (const c of compiledFeatureSetDefaults.defaults) {
+                const e = (_a = c.edition) !== null && _a !== void 0 ? _a : 0;
+                if (e > edition) {
+                    continue;
+                }
+                if (highestMatch !== undefined && highestMatch.e > e) {
+                    continue;
+                }
+                highestMatch = {
+                    e,
+                    f: (_b = c.features) !== null && _b !== void 0 ? _b : new descriptor_pb_js_1.FeatureSet(),
+                };
+            }
+            if (highestMatch === undefined) {
+                throw new Error(`No valid default found for edition ${descriptor_pb_js_1.Edition[edition]}`);
+            }
+            defaultsBin = highestMatch.f.toBinary();
+            defaultsBinByEdition.set(edition, defaultsBin);
+        }
+        const f = descriptor_pb_js_1.FeatureSet.fromBinary(defaultsBin);
+        for (const c of rest) {
+            if (c !== undefined) {
+                f.fromBinary(c.toBinary());
+            }
+        }
+        if (!validateMergedFeatures(f)) {
+            throw new Error(`Invalid FeatureSet for edition ${descriptor_pb_js_1.Edition[edition]}`);
+        }
+        return f;
+    };
+}
+exports.createFeatureResolver = createFeatureResolver;
+// When protoc generates google.protobuf.FeatureSetDefaults, it ensures that
+// fields are not repeated or required, do not use oneof, and have a default
+// value.
+//
+// When features for an element are resolved, features of the element and its
+// parents are merged into the default FeatureSet for the edition. Because unset
+// fields in the FeatureSet of an element do not unset the default FeatureSet
+// values, a resolved FeatureSet is guaranteed to have all fields set. This is
+// also the case for extensions to FeatureSet that a user might provide, and for
+// features from the future.
+//
+// We cannot exhaustively validate correctness of FeatureSetDefaults at runtime
+// without knowing the schema: If no value for a feature is provided, we do not
+// know that it exists at all.
+//
+// As a sanity check, we validate that all fields known to our version of
+// FeatureSet are set.
+function validateMergedFeatures(featureSet) {
+    for (const fi of descriptor_pb_js_1.FeatureSet.fields.list()) {
+        const v = featureSet[fi.localName];
+        if (v === undefined) {
+            return false;
+        }
+        if (fi.kind == "enum" && v === 0) {
+            return false;
+        }
+    }
+    return true;
+}

package/dist/cjs/private/text-format.d.ts

@@ -0,0 +1,4 @@
+import type { DescEnum } from "../descriptor-set.js";
+import { ScalarType } from "../field.js";
+export declare function parseTextFormatEnumValue(descEnum: DescEnum, value: string): number;
+export declare function parseTextFormatScalarValue(type: ScalarType, value: string): number | boolean | string | bigint | Uint8Array;

package/dist/cjs/private/text-format.js

@@ -0,0 +1,189 @@
+"use strict";
+// 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.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseTextFormatScalarValue = exports.parseTextFormatEnumValue = void 0;
+const assert_js_1 = require("./assert.js");
+const field_js_1 = require("../field.js");
+const proto_int64_js_1 = require("../proto-int64.js");
+function parseTextFormatEnumValue(descEnum, value) {
+    const enumValue = descEnum.values.find((v) => v.name === value);
+    (0, assert_js_1.assert)(enumValue, `cannot parse ${descEnum.name} default value: ${value}`);
+    return enumValue.number;
+}
+exports.parseTextFormatEnumValue = parseTextFormatEnumValue;
+function parseTextFormatScalarValue(type, value) {
+    switch (type) {
+        case field_js_1.ScalarType.STRING:
+            return value;
+        case field_js_1.ScalarType.BYTES: {
+            const u = unescapeBytesDefaultValue(value);
+            if (u === false) {
+                throw new Error(`cannot parse ${field_js_1.ScalarType[type]} default value: ${value}`);
+            }
+            return u;
+        }
+        case field_js_1.ScalarType.INT64:
+        case field_js_1.ScalarType.SFIXED64:
+        case field_js_1.ScalarType.SINT64:
+            return proto_int64_js_1.protoInt64.parse(value);
+        case field_js_1.ScalarType.UINT64:
+        case field_js_1.ScalarType.FIXED64:
+            return proto_int64_js_1.protoInt64.uParse(value);
+        case field_js_1.ScalarType.DOUBLE:
+        case field_js_1.ScalarType.FLOAT:
+            switch (value) {
+                case "inf":
+                    return Number.POSITIVE_INFINITY;
+                case "-inf":
+                    return Number.NEGATIVE_INFINITY;
+                case "nan":
+                    return Number.NaN;
+                default:
+                    return parseFloat(value);
+            }
+        case field_js_1.ScalarType.BOOL:
+            return value === "true";
+        case field_js_1.ScalarType.INT32:
+        case field_js_1.ScalarType.UINT32:
+        case field_js_1.ScalarType.SINT32:
+        case field_js_1.ScalarType.FIXED32:
+        case field_js_1.ScalarType.SFIXED32:
+            return parseInt(value, 10);
+    }
+}
+exports.parseTextFormatScalarValue = parseTextFormatScalarValue;
+/**
+ * Parses a text-encoded default value (proto2) of a BYTES field.
+ */
+function unescapeBytesDefaultValue(str) {
+    const b = [];
+    const input = {
+        tail: str,
+        c: "",
+        next() {
+            if (this.tail.length == 0) {
+                return false;
+            }
+            this.c = this.tail[0];
+            this.tail = this.tail.substring(1);
+            return true;
+        },
+        take(n) {
+            if (this.tail.length >= n) {
+                const r = this.tail.substring(0, n);
+                this.tail = this.tail.substring(n);
+                return r;
+            }
+            return false;
+        },
+    };
+    while (input.next()) {
+        switch (input.c) {
+            case "\\":
+                if (input.next()) {
+                    switch (input.c) {
+                        case "\\":
+                            b.push(input.c.charCodeAt(0));
+                            break;
+                        case "b":
+                            b.push(0x08);
+                            break;
+                        case "f":
+                            b.push(0x0c);
+                            break;
+                        case "n":
+                            b.push(0x0a);
+                            break;
+                        case "r":
+                            b.push(0x0d);
+                            break;
+                        case "t":
+                            b.push(0x09);
+                            break;
+                        case "v":
+                            b.push(0x0b);
+                            break;
+                        case "0":
+                        case "1":
+                        case "2":
+                        case "3":
+                        case "4":
+                        case "5":
+                        case "6":
+                        case "7": {
+                            const s = input.c;
+                            const t = input.take(2);
+                            if (t === false) {
+                                return false;
+                            }
+                            const n = parseInt(s + t, 8);
+                            if (isNaN(n)) {
+                                return false;
+                            }
+                            b.push(n);
+                            break;
+                        }
+                        case "x": {
+                            const s = input.c;
+                            const t = input.take(2);
+                            if (t === false) {
+                                return false;
+                            }
+                            const n = parseInt(s + t, 16);
+                            if (isNaN(n)) {
+                                return false;
+                            }
+                            b.push(n);
+                            break;
+                        }
+                        case "u": {
+                            const s = input.c;
+                            const t = input.take(4);
+                            if (t === false) {
+                                return false;
+                            }
+                            const n = parseInt(s + t, 16);
+                            if (isNaN(n)) {
+                                return false;
+                            }
+                            const chunk = new Uint8Array(4);
+                            const view = new DataView(chunk.buffer);
+                            view.setInt32(0, n, true);
+                            b.push(chunk[0], chunk[1], chunk[2], chunk[3]);
+                            break;
+                        }
+                        case "U": {
+                            const s = input.c;
+                            const t = input.take(8);
+                            if (t === false) {
+                                return false;
+                            }
+                            const tc = proto_int64_js_1.protoInt64.uEnc(s + t);
+                            const chunk = new Uint8Array(8);
+                            const view = new DataView(chunk.buffer);
+                            view.setInt32(0, tc.lo, true);
+                            view.setInt32(4, tc.hi, true);
+                            b.push(chunk[0], chunk[1], chunk[2], chunk[3], chunk[4], chunk[5], chunk[6], chunk[7]);
+                            break;
+                        }
+                    }
+                }
+                break;
+            default:
+                b.push(input.c.charCodeAt(0));
+        }
+    }
+    return new Uint8Array(b);
+}

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

@@ -1,5 +1,4 @@
-import type { FieldDescriptorProto } from "./google/protobuf/descriptor_pb.js";
-import { FileDescriptorProto, FileDescriptorSet } from "./google/protobuf/descriptor_pb.js";
+import { FeatureSetDefaults, 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
@@ -9,8 +8,23 @@ import type { DescriptorSet } from "./descriptor-set.js";
  * before any file that imports it. Protocol buffer compilers always produce
  * files in topological order.
  */
-export declare function createDescriptorSet(input: FileDescriptorProto[] | FileDescriptorSet | Uint8Array): DescriptorSet;
+export declare function createDescriptorSet(input: FileDescriptorProto[] | FileDescriptorSet | Uint8Array, options?: CreateDescriptorSetOptions): DescriptorSet;
 /**
- * Get the default `packed` state of a repeated field.
+ * Options to createDescriptorSet()
  */
-export declare function isPackedFieldByDefault(proto: FieldDescriptorProto, syntax: "proto2" | "proto3"): boolean;
+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.
+     *
+     * The defaults can be generated with `protoc` - see the flag
+     * `--experimental_edition_defaults_out`.
+     */
+    featureSetDefaults?: FeatureSetDefaults;
+}
+export {};