@bufbuild/protobuf 2.0.0-alpha.1 → 2.0.0-alpha.3

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

@@ -1,56 +1,8 @@
-/**
- * Scalar value types. This is a subset of field types declared by protobuf
- * enum google.protobuf.FieldDescriptorProto.Type The types GROUP and MESSAGE
- * are omitted, but the numerical values are identical.
- */
-export declare enum ScalarType {
-    DOUBLE = 1,
-    FLOAT = 2,
-    INT64 = 3,
-    UINT64 = 4,
-    INT32 = 5,
-    FIXED64 = 6,
-    FIXED32 = 7,
-    BOOL = 8,
-    STRING = 9,
-    BYTES = 12,
-    UINT32 = 13,
-    SFIXED32 = 15,
-    SFIXED64 = 16,
-    SINT32 = 17,// Uses ZigZag encoding.
-    SINT64 = 18
-}
-/**
- * JavaScript representation of fields with 64 bit integral types (int64, uint64,
- * sint64, fixed64, sfixed64).
- *
- * This is a subset of google.protobuf.FieldOptions.JSType, which defines JS_NORMAL,
- * JS_STRING, and JS_NUMBER. Protobuf-ES uses BigInt by default, but will use
- * String if `[jstype = JS_STRING]` is specified.
- *
- * ```protobuf
- * uint64 field_a = 1; // BigInt
- * uint64 field_b = 2 [jstype = JS_NORMAL]; // BigInt
- * uint64 field_b = 2 [jstype = JS_NUMBER]; // BigInt
- * uint64 field_b = 2 [jstype = JS_STRING]; // String
- * ```
- */
-export declare enum LongType {
-    /**
-     * Use JavaScript BigInt.
-     */
-    BIGINT = 0,
-    /**
-     * Use JavaScript String.
-     *
-     * Field option `[jstype = JS_STRING]`.
-     */
-    STRING = 1
-}
+import { ScalarType } from "../descriptors.js";
 /**
  * ScalarValue maps from a scalar field type to a TypeScript value type.
  */
-export type ScalarValue<T = ScalarType, L extends LongType = LongType.STRING | LongType.BIGINT> = T extends ScalarType.STRING ? string : T extends ScalarType.INT32 ? number : T extends ScalarType.UINT32 ? number : T extends ScalarType.UINT32 ? number : T extends ScalarType.SINT32 ? number : T extends ScalarType.FIXED32 ? number : T extends ScalarType.SFIXED32 ? number : T extends ScalarType.FLOAT ? number : T extends ScalarType.DOUBLE ? number : T extends ScalarType.INT64 ? L extends LongType.STRING ? string : bigint : T extends ScalarType.SINT64 ? L extends LongType.STRING ? string : bigint : T extends ScalarType.SFIXED64 ? L extends LongType.STRING ? string : bigint : T extends ScalarType.UINT64 ? L extends LongType.STRING ? string : bigint : T extends ScalarType.FIXED64 ? L extends LongType.STRING ? string : bigint : T extends ScalarType.BOOL ? boolean : T extends ScalarType.BYTES ? Uint8Array : never;
+export type ScalarValue<T = ScalarType, LongAsString extends boolean = false> = T extends ScalarType.STRING ? string : T extends ScalarType.INT32 ? number : T extends ScalarType.UINT32 ? number : T extends ScalarType.SINT32 ? number : T extends ScalarType.FIXED32 ? number : T extends ScalarType.SFIXED32 ? number : T extends ScalarType.FLOAT ? number : T extends ScalarType.DOUBLE ? number : T extends ScalarType.INT64 ? LongAsString extends true ? string : bigint : T extends ScalarType.SINT64 ? LongAsString extends true ? string : bigint : T extends ScalarType.SFIXED64 ? LongAsString extends true ? string : bigint : T extends ScalarType.UINT64 ? LongAsString extends true ? string : bigint : T extends ScalarType.FIXED64 ? LongAsString extends true ? string : bigint : T extends ScalarType.BOOL ? boolean : T extends ScalarType.BYTES ? Uint8Array : never;
 /**
  * Returns true if both scalar values are equal.
  */
@@ -58,7 +10,7 @@ export declare function scalarEquals(type: ScalarType, a: string | boolean | num
 /**
  * Returns the zero value for the given scalar type.
  */
-export declare function scalarZeroValue<T extends ScalarType, L extends LongType>(type: T, longType: L): ScalarValue<T, L>;
+export declare function scalarZeroValue<T extends ScalarType, LongAsString extends boolean>(type: T, longAsString: LongAsString): ScalarValue<T, LongAsString>;
 /**
  * Returns true for a zero-value. For example, an integer has the zero-value `0`,
  * a boolean is `false`, a string is `""`, and bytes is an empty Uint8Array.
@@ -67,7 +19,3 @@ export declare function scalarZeroValue<T extends ScalarType, L extends LongType
  * optional or repeated.
  */
 export declare function isScalarZeroValue(type: ScalarType, value: unknown): boolean;
-export type InvalidScalarValueErr = false | "invalid UTF8" | `${string} out of range`;
-export declare function checkScalarValue(value: unknown, scalar: ScalarType): true | InvalidScalarValueErr;
-export declare function scalarTypeDescription(scalar: ScalarType): string;
-export declare function scalarTypeScriptType(scalar: ScalarType, long: LongType): "string" | "boolean" | "bigint" | "bigint | string" | "Uint8Array" | "number";

package/dist/esm/reflect/scalar.js

@@ -12,72 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 import { protoInt64 } from "../proto-int64.js";
-import { getTextEncoding } from "../wire/text-encoding.js";
-/**
- * Scalar value types. This is a subset of field types declared by protobuf
- * enum google.protobuf.FieldDescriptorProto.Type The types GROUP and MESSAGE
- * are omitted, but the numerical values are identical.
- */
-export var ScalarType;
-(function (ScalarType) {
-    // 0 is reserved for errors.
-    // Order is weird for historical reasons.
-    ScalarType[ScalarType["DOUBLE"] = 1] = "DOUBLE";
-    ScalarType[ScalarType["FLOAT"] = 2] = "FLOAT";
-    // Not ZigZag encoded.  Negative numbers take 10 bytes.  Use TYPE_SINT64 if
-    // negative values are likely.
-    ScalarType[ScalarType["INT64"] = 3] = "INT64";
-    ScalarType[ScalarType["UINT64"] = 4] = "UINT64";
-    // Not ZigZag encoded.  Negative numbers take 10 bytes.  Use TYPE_SINT32 if
-    // negative values are likely.
-    ScalarType[ScalarType["INT32"] = 5] = "INT32";
-    ScalarType[ScalarType["FIXED64"] = 6] = "FIXED64";
-    ScalarType[ScalarType["FIXED32"] = 7] = "FIXED32";
-    ScalarType[ScalarType["BOOL"] = 8] = "BOOL";
-    ScalarType[ScalarType["STRING"] = 9] = "STRING";
-    // Tag-delimited aggregate.
-    // Group type is deprecated and not supported in proto3. However, Proto3
-    // implementations should still be able to parse the group wire format and
-    // treat group fields as unknown fields.
-    // TYPE_GROUP = 10,
-    // TYPE_MESSAGE = 11,  // Length-delimited aggregate.
-    // New in version 2.
-    ScalarType[ScalarType["BYTES"] = 12] = "BYTES";
-    ScalarType[ScalarType["UINT32"] = 13] = "UINT32";
-    // TYPE_ENUM = 14,
-    ScalarType[ScalarType["SFIXED32"] = 15] = "SFIXED32";
-    ScalarType[ScalarType["SFIXED64"] = 16] = "SFIXED64";
-    ScalarType[ScalarType["SINT32"] = 17] = "SINT32";
-    ScalarType[ScalarType["SINT64"] = 18] = "SINT64";
-})(ScalarType || (ScalarType = {}));
-/**
- * JavaScript representation of fields with 64 bit integral types (int64, uint64,
- * sint64, fixed64, sfixed64).
- *
- * This is a subset of google.protobuf.FieldOptions.JSType, which defines JS_NORMAL,
- * JS_STRING, and JS_NUMBER. Protobuf-ES uses BigInt by default, but will use
- * String if `[jstype = JS_STRING]` is specified.
- *
- * ```protobuf
- * uint64 field_a = 1; // BigInt
- * uint64 field_b = 2 [jstype = JS_NORMAL]; // BigInt
- * uint64 field_b = 2 [jstype = JS_NUMBER]; // BigInt
- * uint64 field_b = 2 [jstype = JS_STRING]; // String
- * ```
- */
-export var LongType;
-(function (LongType) {
-    /**
-     * Use JavaScript BigInt.
-     */
-    LongType[LongType["BIGINT"] = 0] = "BIGINT";
-    /**
-     * Use JavaScript String.
-     *
-     * Field option `[jstype = JS_STRING]`.
-     */
-    LongType[LongType["STRING"] = 1] = "STRING";
-})(LongType || (LongType = {}));
+import { ScalarType } from "../descriptors.js";
 /**
  * Returns true if both scalar values are equal.
  */
@@ -119,27 +54,27 @@ export function scalarEquals(type, a, b) {
 /**
  * Returns the zero value for the given scalar type.
  */
-export function scalarZeroValue(type, longType) {
+export function scalarZeroValue(type, longAsString) {
     switch (type) {
+        case ScalarType.STRING:
+            return "";
         case ScalarType.BOOL:
             return false;
-        case ScalarType.UINT64:
-        case ScalarType.FIXED64:
-        case ScalarType.INT64:
-        case ScalarType.SFIXED64:
-        case ScalarType.SINT64:
-            return (longType == 0 ? protoInt64.zero : "0");
+        default:
+            // Handles INT32, UINT32, SINT32, FIXED32, SFIXED32.
+            // We do not use individual cases to save a few bytes code size.
+            return 0;
         case ScalarType.DOUBLE:
         case ScalarType.FLOAT:
             return 0.0;
+        case ScalarType.INT64:
+        case ScalarType.UINT64:
+        case ScalarType.SFIXED64:
+        case ScalarType.FIXED64:
+        case ScalarType.SINT64:
+            return (longAsString ? "0" : protoInt64.zero);
         case ScalarType.BYTES:
             return new Uint8Array(0);
-        case ScalarType.STRING:
-            return "";
-        default:
-            // Handles INT32, UINT32, SINT32, FIXED32, SFIXED32.
-            // We do not use individual cases to save a few bytes code size.
-            return 0;
     }
 }
 /**
@@ -161,129 +96,3 @@ export function isScalarZeroValue(type, value) {
             return value == 0; // Loose comparison matches 0n, 0 and "0"
     }
 }
-const FLOAT32_MAX = 3.4028234663852886e38, FLOAT32_MIN = -3.4028234663852886e38, UINT32_MAX = 0xffffffff, INT32_MAX = 0x7fffffff, INT32_MIN = -0x80000000;
-// TODO this checks UTF-8 validity
-export function checkScalarValue(value, scalar) {
-    switch (scalar) {
-        case ScalarType.DOUBLE:
-            return typeof value == "number";
-        case ScalarType.FLOAT:
-            if (typeof value != "number") {
-                return false;
-            }
-            if (Number.isNaN(value) || !Number.isFinite(value)) {
-                return true;
-            }
-            if (value > FLOAT32_MAX || value < FLOAT32_MIN) {
-                return `${value.toFixed()} out of range`;
-            }
-            return true;
-        case ScalarType.INT32:
-        case ScalarType.SFIXED32:
-        case ScalarType.SINT32:
-            // signed
-            if (typeof value !== "number" || !Number.isInteger(value)) {
-                return false;
-            }
-            if (value > INT32_MAX || value < INT32_MIN) {
-                return `${value.toFixed()} out of range`;
-            }
-            return true;
-        case ScalarType.FIXED32:
-        case ScalarType.UINT32:
-            // unsigned
-            if (typeof value !== "number" || !Number.isInteger(value)) {
-                return false;
-            }
-            if (value > UINT32_MAX || value < 0) {
-                return `${value.toFixed()} out of range`;
-            }
-            return true;
-        case ScalarType.BOOL:
-            return typeof value == "boolean";
-        case ScalarType.STRING:
-            if (typeof value != "string") {
-                return false;
-            }
-            return getTextEncoding().checkUtf8(value) || "invalid UTF8";
-        case ScalarType.BYTES:
-            return value instanceof Uint8Array;
-        case ScalarType.INT64:
-        case ScalarType.SFIXED64:
-        case ScalarType.SINT64:
-            // signed
-            if (typeof value != "string" &&
-                typeof value !== "bigint" &&
-                typeof value !== "number") {
-                return false;
-            }
-            try {
-                protoInt64.parse(value);
-            }
-            catch (e) {
-                return `${value} out of range`;
-            }
-            return true;
-        case ScalarType.FIXED64:
-        case ScalarType.UINT64:
-            // unsigned
-            if (typeof value != "string" &&
-                typeof value !== "bigint" &&
-                typeof value !== "number") {
-                return false;
-            }
-            try {
-                protoInt64.uParse(value);
-            }
-            catch (e) {
-                return `${value} out of range`;
-            }
-            return true;
-    }
-}
-export function scalarTypeDescription(scalar) {
-    switch (scalar) {
-        case ScalarType.STRING:
-            return "string";
-        case ScalarType.BOOL:
-            return "boolean";
-        case ScalarType.INT64:
-        case ScalarType.SINT64:
-        case ScalarType.SFIXED64:
-            return "bigint (int64)";
-        case ScalarType.UINT64:
-        case ScalarType.FIXED64:
-            return "bigint (uint64)";
-        case ScalarType.BYTES:
-            return "Uint8Array";
-        case ScalarType.DOUBLE:
-            return "number (float64)";
-        case ScalarType.FLOAT:
-            return "number (float32)";
-        case ScalarType.FIXED32:
-        case ScalarType.UINT32:
-            return "number (uint32)";
-        case ScalarType.INT32:
-        case ScalarType.SFIXED32:
-        case ScalarType.SINT32:
-            return "number (int32)";
-    }
-}
-export function scalarTypeScriptType(scalar, long) {
-    switch (scalar) {
-        case ScalarType.STRING:
-            return "string";
-        case ScalarType.BOOL:
-            return "boolean";
-        case ScalarType.UINT64:
-        case ScalarType.SFIXED64:
-        case ScalarType.FIXED64:
-        case ScalarType.SINT64:
-        case ScalarType.INT64:
-            return long == LongType.STRING ? "string" : "bigint";
-        case ScalarType.BYTES:
-            return "Uint8Array";
-        default:
-            return "number";
-    }
-}

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

@@ -1,4 +1,4 @@
-import type { DescField, DescOneof } from "../desc-types.js";
+import type { DescField, DescOneof } from "../descriptors.js";
 export declare const unsafeLocal: unique symbol;
 /**
  * Return the selected field of a oneof group.

package/dist/esm/reflect/unsafe.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.
-import { localName } from "./names.js";
 import { isScalarZeroValue, scalarZeroValue } from "./scalar.js";
 // bootstrap-inject google.protobuf.FeatureSet.FieldPresence.IMPLICIT: const $name: FeatureSet_FieldPresence.$localName = $number;
 const IMPLICIT = 2;
@@ -23,11 +22,11 @@ export const unsafeLocal = Symbol.for("reflect unsafe local");
  */
 export function unsafeOneofCase(target, // eslint-disable-line @typescript-eslint/no-explicit-any -- `any` is the best choice for dynamic access
 oneof) {
-    const c = target[localName(oneof)].case;
+    const c = target[oneof.localName].case;
     if (c === undefined) {
         return c;
     }
-    return oneof.fields.find((f) => localName(f) === c);
+    return oneof.fields.find((f) => f.localName === c);
 }
 /**
  * Returns true if the field is set.
@@ -36,28 +35,28 @@ oneof) {
  */
 export function unsafeIsSet(target, // eslint-disable-line @typescript-eslint/no-explicit-any -- `any` is the best choice for dynamic access
 field) {
-    const name = localName(field);
+    const name = field.localName;
     if (field.oneof) {
-        return target[localName(field.oneof)].case === name; // eslint-disable-line @typescript-eslint/no-unsafe-member-access
+        return target[field.oneof.localName].case === name; // eslint-disable-line @typescript-eslint/no-unsafe-member-access
     }
+    if (field.presence != IMPLICIT) {
+        // Fields with explicit presence have properties on the prototype chain
+        // for default / zero values (except for proto3).
+        return (target[name] !== undefined &&
+            Object.prototype.hasOwnProperty.call(target, name));
+    }
+    // eslint-disable-next-line @typescript-eslint/switch-exhaustiveness-check
     switch (field.fieldKind) {
-        case "message":
-            return target[name] !== undefined;
         case "list":
             return target[name].length > 0;
         case "map":
             return Object.keys(target[name]).length > 0; // eslint-disable-line @typescript-eslint/no-unsafe-argument
-        default:
-            if (field.presence == IMPLICIT) {
-                if (field.fieldKind == "enum") {
-                    return target[name] !== field.enum.values[0].number;
-                }
-                return !isScalarZeroValue(field.scalar, target[name]);
-            }
-            // EXPLICIT and LEGACY_REQUIRED
-            return (target[name] !== undefined &&
-                Object.prototype.hasOwnProperty.call(target, name));
+        case "scalar":
+            return !isScalarZeroValue(field.scalar, target[name]);
+        case "enum":
+            return target[name] !== field.enum.values[0].number;
     }
+    throw new Error("message field with implicit presence");
 }
 /**
  * Returns true if the field is set, but only for singular fields with explicit
@@ -75,15 +74,14 @@ export function unsafeIsSetExplicit(target, localName) {
  * @private
  */
 export function unsafeGet(target, field) {
-    const name = localName(field);
     if (field.oneof) {
-        const oneof = target[localName(field.oneof)];
-        if (oneof.case === name) {
+        const oneof = target[field.oneof.localName];
+        if (oneof.case === field.localName) {
             return oneof.value;
         }
         return undefined;
     }
-    return target[name];
+    return target[field.localName];
 }
 /**
  * Set a field value, respecting oneof groups.
@@ -91,15 +89,14 @@ export function unsafeGet(target, field) {
  * @private
  */
 export function unsafeSet(target, field, value) {
-    const name = localName(field);
     if (field.oneof) {
-        target[localName(field.oneof)] = {
-            case: name,
+        target[field.oneof.localName] = {
+            case: field.localName,
             value: value,
         };
     }
     else {
-        target[name] = value;
+        target[field.localName] = value;
     }
 }
 /**
@@ -109,14 +106,21 @@ export function unsafeSet(target, field, value) {
  */
 export function unsafeClear(target, // eslint-disable-line @typescript-eslint/no-explicit-any -- `any` is the best choice for dynamic access
 field) {
-    const name = localName(field);
+    const name = field.localName;
     if (field.oneof) {
-        const oneofLocalName = localName(field.oneof);
+        const oneofLocalName = field.oneof.localName;
         if (target[oneofLocalName].case === name) {
             target[oneofLocalName] = { case: undefined };
         }
     }
+    else if (field.presence != IMPLICIT) {
+        // Fields with explicit presence have properties on the prototype chain
+        // for default / zero values (except for proto3). By deleting their own
+        // property, the field is reset.
+        delete target[name];
+    }
     else {
+        // eslint-disable-next-line @typescript-eslint/switch-exhaustiveness-check
         switch (field.fieldKind) {
             case "map":
                 target[name] = {};
@@ -124,19 +128,12 @@ field) {
             case "list":
                 target[name] = [];
                 break;
-            case "message":
-                delete target[name];
+            case "enum":
+                target[name] = field.enum.values[0].number;
+                break;
+            case "scalar":
+                target[name] = scalarZeroValue(field.scalar, field.longAsString);
                 break;
-            default:
-                if (field.presence == IMPLICIT) {
-                    target[name] =
-                        field.fieldKind == "enum"
-                            ? field.enum.values[0].number
-                            : scalarZeroValue(field.scalar, field.longType);
-                }
-                else {
-                    delete target[name];
-                }
         }
     }
 }
@@ -146,8 +143,7 @@ field) {
  * @private
  */
 export function unsafeAddListItem(target, field, value) {
-    const name = localName(field);
-    target[name].push(value);
+    target[field.localName].push(value);
 }
 /**
  * Set a map entry.
@@ -155,6 +151,5 @@ export function unsafeAddListItem(target, field, value) {
  * @private
  */
 export function unsafeSetMapEntry(target, field, key, value) {
-    const name = localName(field);
-    target[name][key] = value;
+    target[field.localName][key] = value;
 }

package/dist/esm/{reflect/registry.d.ts → registry.d.ts}

@@ -1,5 +1,5 @@
-import type { FileDescriptorProto, FileDescriptorSet } from "../wkt/gen/google/protobuf/descriptor_pb.js";
-import type { DescEnum, DescExtension, DescFile, DescMessage, DescService, SupportedEdition } from "../desc-types.js";
+import type { FileDescriptorProto, FileDescriptorSet } from "./wkt/gen/google/protobuf/descriptor_pb.js";
+import { type DescEnum, type DescExtension, type DescFile, type DescMessage, type DescService, type SupportedEdition } from "./descriptors.js";
 /**
  * A set of descriptors for messages, enumerations, extensions,
  * and services.