@bufbuild/protobuf 2.2.5 → 2.4.0

package/dist/esm/from-json.js

@@ -11,7 +11,6 @@
 // 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 no-case-declarations,@typescript-eslint/restrict-template-expressions */
 import { ScalarType, } from "./descriptors.js";
 import { protoInt64 } from "./proto-int64.js";
 import { create } from "./create.js";
@@ -96,7 +95,7 @@ export function mergeFromJson(schema, target, json, options) {
 export function enumFromJson(descEnum, json) {
     const val = readEnum(descEnum, json, false, false);
     if (val === tokenIgnoredUnknownEnum) {
-        throw new Error(`cannot decode ${String(descEnum)} from JSON: ${formatVal(json)}`);
+        throw new Error(`cannot decode ${descEnum} from JSON: ${formatVal(json)}`);
     }
     return val;
 }
@@ -139,6 +138,7 @@ function readMessage(msg, json, opts) {
             let extension = undefined;
             if (jsonKey.startsWith("[") &&
                 jsonKey.endsWith("]") &&
+                // biome-ignore lint/suspicious/noAssignInExpressions: no
                 (extension = (_a = opts.registry) === null || _a === void 0 ? void 0 : _a.getExtension(jsonKey.substring(1, jsonKey.length - 1))) &&
                 extension.extendee.typeName === msg.desc.typeName) {
                 const [container, field, get] = createExtensionContainer(extension);
@@ -268,7 +268,6 @@ function readEnum(desc, json, ignoreUnknownFields, nullAsZeroValue) {
         }
         return nullAsZeroValue ? desc.values[0].number : tokenNull;
     }
-    // eslint-disable-next-line @typescript-eslint/switch-exhaustiveness-check
     switch (typeof json) {
         case "number":
             if (Number.isInteger(json)) {
@@ -297,7 +296,6 @@ function scalarFromJson(field, json, nullAsZeroValue) {
     }
     // int64, sfixed64, sint64, fixed64, uint64: Reflect supports string and number.
     // string, bool: Supported by reflect.
-    // eslint-disable-next-line @typescript-eslint/switch-exhaustiveness-check
     switch (field.scalar) {
         // float, double: JSON value will be a number or one of the special string values "NaN", "Infinity", and "-Infinity".
         // Either numbers or strings are accepted. Exponent notation is also accepted.
@@ -310,11 +308,11 @@ function scalarFromJson(field, json, nullAsZeroValue) {
             if (json === "-Infinity")
                 return Number.NEGATIVE_INFINITY;
             if (typeof json == "number") {
-                if (isNaN(json)) {
+                if (Number.isNaN(json)) {
                     // NaN must be encoded with string constants
                     throw new FieldError(field, "unexpected NaN number");
                 }
-                if (!isFinite(json)) {
+                if (!Number.isFinite(json)) {
                     // Infinity must be encoded with string constants
                     throw new FieldError(field, "unexpected infinite number");
                 }
@@ -330,7 +328,7 @@ function scalarFromJson(field, json, nullAsZeroValue) {
                     break;
                 }
                 const float = Number(json);
-                if (!isFinite(float)) {
+                if (!Number.isFinite(float)) {
                     // Infinity and NaN must be encoded with string constants
                     break;
                 }
@@ -371,7 +369,6 @@ function scalarFromJson(field, json, nullAsZeroValue) {
 function mapKeyFromJson(type, json) {
     switch (type) {
         case ScalarType.BOOL:
-            // eslint-disable-next-line @typescript-eslint/switch-exhaustiveness-check
             switch (json) {
                 case "true":
                     return true;
@@ -489,11 +486,12 @@ function anyFromJson(any, json, opts) {
     const msg = reflect(desc);
     if (typeName.startsWith("google.protobuf.") &&
         Object.prototype.hasOwnProperty.call(json, "value")) {
-        const value = json["value"];
+        const value = json.value;
         readMessage(msg, value, opts);
     }
     else {
         const copy = Object.assign({}, json);
+        // biome-ignore lint/performance/noDelete: <explanation>
         delete copy["@type"];
         readMessage(msg, copy, opts);
     }
@@ -508,7 +506,7 @@ function timestampFromJson(timestamp, json) {
         throw new Error(`cannot decode message ${timestamp.$typeName} from JSON: invalid RFC 3339 string`);
     }
     const ms = Date.parse(
-    //prettier-ignore
+    // biome-ignore format: want this to read well
     matches[1] + "-" + matches[2] + "-" + matches[3] + "T" + matches[4] + ":" + matches[5] + ":" + matches[6] + (matches[8] ? matches[8] : "Z"));
     if (Number.isNaN(ms)) {
         throw new Error(`cannot decode message ${timestamp.$typeName} from JSON: invalid RFC 3339 string`);

package/dist/esm/proto-int64.js

@@ -28,7 +28,10 @@ function makeInt64Support() {
             typeof process.env != "object" ||
             process.env.BUF_BIGINT_DISABLE !== "1");
     if (ok) {
-        const MIN = BigInt("-9223372036854775808"), MAX = BigInt("9223372036854775807"), UMIN = BigInt("0"), UMAX = BigInt("18446744073709551615");
+        const MIN = BigInt("-9223372036854775808");
+        const MAX = BigInt("9223372036854775807");
+        const UMIN = BigInt("0");
+        const UMAX = BigInt("18446744073709551615");
         return {
             zero: BigInt(0),
             supported: true,

package/dist/esm/reflect/guard.js

@@ -31,7 +31,8 @@ export function isReflectList(arg, field) {
         "field" in arg &&
         typeof arg.field == "function") {
         if (field !== undefined) {
-            const a = field, b = arg.field();
+            const a = field;
+            const b = arg.field();
             return (a.listKind == b.listKind &&
                 a.scalar === b.scalar &&
                 ((_a = a.message) === null || _a === void 0 ? void 0 : _a.typeName) === ((_b = b.message) === null || _b === void 0 ? void 0 : _b.typeName) &&

package/dist/esm/reflect/index.d.ts

@@ -4,4 +4,5 @@ export * from "./nested-types.js";
 export * from "./reflect.js";
 export * from "./reflect-types.js";
 export * from "./scalar.js";
+export * from "./path.js";
 export { isReflectList, isReflectMap, isReflectMessage } from "./guard.js";

package/dist/esm/reflect/index.js

@@ -17,4 +17,5 @@ export * from "./nested-types.js";
 export * from "./reflect.js";
 export * from "./reflect-types.js";
 export * from "./scalar.js";
+export * from "./path.js";
 export { isReflectList, isReflectMap, isReflectMessage } from "./guard.js";

package/dist/esm/reflect/names.d.ts

@@ -1,3 +1,11 @@
+import type { AnyDesc } from "../descriptors.js";
+/**
+ * Return a fully-qualified name for a Protobuf descriptor.
+ * For a file descriptor, return the original file path.
+ *
+ * See https://protobuf.com/docs/language-spec#fully-qualified-names
+ */
+export declare function qualifiedName(desc: AnyDesc): string;
 /**
  * Converts snake_case to protoCamelCase according to the convention
  * used by protoc to convert a field name to a JSON name.

package/dist/esm/reflect/names.js

@@ -11,6 +11,33 @@
 // 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.
+/**
+ * Return a fully-qualified name for a Protobuf descriptor.
+ * For a file descriptor, return the original file path.
+ *
+ * See https://protobuf.com/docs/language-spec#fully-qualified-names
+ */
+export function qualifiedName(desc) {
+    switch (desc.kind) {
+        case "field":
+        case "oneof":
+        case "rpc":
+            return desc.parent.typeName + "." + desc.name;
+        case "enum_value": {
+            const p = desc.parent.parent
+                ? desc.parent.parent.typeName
+                : desc.parent.file.proto.package;
+            return p + (p.length > 0 ? "." : "") + desc.name;
+        }
+        case "service":
+        case "message":
+        case "enum":
+        case "extension":
+            return desc.typeName;
+        case "file":
+            return desc.proto.name;
+    }
+}
 /**
  * Converts snake_case to protoCamelCase according to the convention
  * used by protoc to convert a field name to a JSON name.

package/dist/esm/reflect/nested-types.d.ts

@@ -4,6 +4,29 @@ import type { AnyDesc, DescEnum, DescExtension, DescFile, DescMessage, DescServi
  * and enumerations, extensions and messages nested in messages.
  */
 export declare function nestedTypes(desc: DescFile | DescMessage): Iterable<DescMessage | DescEnum | DescExtension | DescService>;
+/**
+ * Iterate over types referenced by fields of the given message.
+ *
+ * For example:
+ *
+ * ```proto
+ * syntax="proto3";
+ *
+ * message Example {
+ *   Msg singular = 1;
+ *   repeated Level list = 2;
+ * }
+ *
+ * message Msg {}
+ *
+ * enum Level {
+ *   LEVEL_UNSPECIFIED = 0;
+ * }
+ * ```
+ *
+ * The message Example references the message Msg, and the enum Level.
+ */
+export declare function usedTypes(descMessage: DescMessage): Iterable<DescMessage | DescEnum>;
 /**
  * Returns the ancestors of a given Protobuf element, up to the file.
  */

package/dist/esm/reflect/nested-types.js

@@ -36,6 +36,45 @@ export function* nestedTypes(desc) {
             break;
     }
 }
+/**
+ * Iterate over types referenced by fields of the given message.
+ *
+ * For example:
+ *
+ * ```proto
+ * syntax="proto3";
+ *
+ * message Example {
+ *   Msg singular = 1;
+ *   repeated Level list = 2;
+ * }
+ *
+ * message Msg {}
+ *
+ * enum Level {
+ *   LEVEL_UNSPECIFIED = 0;
+ * }
+ * ```
+ *
+ * The message Example references the message Msg, and the enum Level.
+ */
+export function usedTypes(descMessage) {
+    return usedTypesInternal(descMessage, new Set());
+}
+function* usedTypesInternal(descMessage, seen) {
+    var _a, _b;
+    for (const field of descMessage.fields) {
+        const ref = (_b = (_a = field.enum) !== null && _a !== void 0 ? _a : field.message) !== null && _b !== void 0 ? _b : undefined;
+        if (!ref || seen.has(ref.typeName)) {
+            continue;
+        }
+        seen.add(ref.typeName);
+        yield ref;
+        if (ref.kind == "message") {
+            yield* usedTypesInternal(ref, seen);
+        }
+    }
+}
 /**
  * Returns the ancestors of a given Protobuf element, up to the file.
  */

package/dist/esm/reflect/path.d.ts

@@ -0,0 +1,107 @@
+import { type DescExtension, type DescField, type DescMessage, type DescOneof } from "../descriptors.js";
+import type { Registry } from "../registry.js";
+/**
+ * A path to a (nested) member of a Protobuf message, such as a field, oneof,
+ * extension, list element, or map entry.
+ *
+ * Note that we may add additional types to this union in the future to support
+ * more use cases.
+ */
+export type Path = (DescField | DescExtension | DescOneof | {
+    kind: "list_sub";
+    index: number;
+} | {
+    kind: "map_sub";
+    key: string | number | bigint | boolean;
+})[];
+/**
+ * Builds a Path.
+ */
+export type PathBuilder = {
+    /**
+     * The root message of the path.
+     */
+    readonly schema: DescMessage;
+    /**
+     * Add field access.
+     *
+     * Throws an InvalidPathError if the field cannot be added to the path.
+     */
+    field(field: DescField): PathBuilder;
+    /**
+     * Access a oneof.
+     *
+     * Throws an InvalidPathError if the oneof cannot be added to the path.
+     *
+     */
+    oneof(oneof: DescOneof): PathBuilder;
+    /**
+     * Access an extension.
+     *
+     * Throws an InvalidPathError if the extension cannot be added to the path.
+     */
+    extension(extension: DescExtension): PathBuilder;
+    /**
+     * Access a list field by index.
+     *
+     * Throws an InvalidPathError if the list access cannot be added to the path.
+     */
+    list(index: number): PathBuilder;
+    /**
+     * Access a map field by key.
+     *
+     * Throws an InvalidPathError if the map access cannot be added to the path.
+     */
+    map(key: string | number | bigint | boolean): PathBuilder;
+    /**
+     * Append a path.
+     *
+     * Throws an InvalidPathError if the path cannot be added.
+     */
+    add(path: Path | PathBuilder): PathBuilder;
+    /**
+     * Return the path.
+     */
+    toPath(): Path;
+    /**
+     * Create a copy of this builder.
+     */
+    clone(): PathBuilder;
+    /**
+     * Get the current container - a list, map, or message.
+     */
+    getLeft(): DescMessage | (DescField & {
+        fieldKind: "list";
+    }) | (DescField & {
+        fieldKind: "map";
+    }) | undefined;
+};
+/**
+ * Create a PathBuilder.
+ */
+export declare function buildPath(schema: DescMessage): PathBuilder;
+/**
+ * Parse a Path from a string.
+ *
+ * Throws an InvalidPathError if the path is invalid.
+ *
+ * Note that a Registry must be provided via the options argument to parse
+ * paths that refer to an extension.
+ */
+export declare function parsePath(schema: DescMessage, path: string, options?: {
+    registry?: Registry;
+}): Path;
+/**
+ * Stringify a path.
+ */
+export declare function pathToString(path: Path): string;
+/**
+ * InvalidPathError is thrown for invalid Paths, for example during parsing from
+ * a string, or when a new Path is built.
+ */
+export declare class InvalidPathError extends Error {
+    name: string;
+    readonly schema: DescMessage;
+    readonly path: Path | string;
+    constructor(schema: DescMessage, message: string, path: string | Path);
+}