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

package/dist/cjs/is-message.d.ts

@@ -1,5 +1,5 @@
 import type { MessageShape } from "./types.js";
-import type { DescMessage } from "./desc-types.js";
+import type { DescMessage } from "./descriptors.js";
 /**
  * Determine whether the given `arg` is a message.
  * If `desc` is set, determine whether `arg` is this specific message.

package/dist/cjs/proto-int64.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Int64Support for the current environment.
+ */
+export declare const protoInt64: Int64Support;
 /**
  * We use the `bigint` primitive to represent 64-bit integral types. If bigint
  * is unavailable, we fall back to a string representation, which means that
@@ -91,5 +95,4 @@ interface Int64Support {
      */
     uDec(lo: number, hi: number): bigint;
 }
-export declare const protoInt64: Int64Support;
 export {};

package/dist/cjs/proto-int64.js

@@ -14,8 +14,11 @@
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.protoInt64 = void 0;
-const assert_js_1 = require("./reflect/assert.js");
 const varint_js_1 = require("./wire/varint.js");
+/**
+ * Int64Support for the current environment.
+ */
+exports.protoInt64 = makeInt64Support();
 function makeInt64Support() {
     const dv = new DataView(new ArrayBuffer(8));
     // note that Safari 14 implements BigInt, but not the DataView methods
@@ -35,14 +38,14 @@ function makeInt64Support() {
             parse(value) {
                 const bi = typeof value == "bigint" ? value : BigInt(value);
                 if (bi > MAX || bi < MIN) {
-                    throw new Error(`int64 invalid: ${value}`);
+                    throw new Error(`invalid int64: ${value}`);
                 }
                 return bi;
             },
             uParse(value) {
                 const bi = typeof value == "bigint" ? value : BigInt(value);
                 if (bi > UMAX || bi < UMIN) {
-                    throw new Error(`uint64 invalid: ${value}`);
+                    throw new Error(`invalid uint64: ${value}`);
                 }
                 return bi;
             },
@@ -72,8 +75,6 @@ function makeInt64Support() {
             },
         };
     }
-    const assertInt64String = (value) => (0, assert_js_1.assert)(/^-?[0-9]+$/.test(value), `int64 invalid: ${value}`);
-    const assertUInt64String = (value) => (0, assert_js_1.assert)(/^[0-9]+$/.test(value), `uint64 invalid: ${value}`);
     return {
         zero: "0",
         supported: false,
@@ -113,4 +114,13 @@ function makeInt64Support() {
         },
     };
 }
-exports.protoInt64 = makeInt64Support();
+function assertInt64String(value) {
+    if (!/^-?[0-9]+$/.test(value)) {
+        throw new Error("invalid int64: " + value);
+    }
+}
+function assertUInt64String(value) {
+    if (!/^[0-9]+$/.test(value)) {
+        throw new Error("invalid uint64: " + value);
+    }
+}

package/dist/cjs/reflect/error.d.ts

@@ -1,4 +1,4 @@
-import type { DescField, DescOneof } from "../desc-types.js";
+import type { DescField, DescOneof } from "../descriptors.js";
 declare const errorNames: string[];
 export declare class FieldError extends Error {
     readonly name: (typeof errorNames)[number];

package/dist/cjs/reflect/guard.d.ts

@@ -1,7 +1,7 @@
 import type { Message } from "../types.js";
 import type { ScalarValue } from "./scalar.js";
 import type { ReflectList, ReflectMap, ReflectMessage } from "./reflect-types.js";
-import type { DescField, DescMessage } from "../desc-types.js";
+import type { DescField, DescMessage } from "../descriptors.js";
 export declare function isObject(arg: unknown): arg is Record<string, unknown>;
 export declare function isOneofADT(arg: unknown): arg is OneofADT;
 export type OneofADT = {

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

@@ -3,6 +3,5 @@ export * from "./names.js";
 export * from "./nested-types.js";
 export * from "./reflect.js";
 export * from "./reflect-types.js";
-export * from "./registry.js";
 export * from "./scalar.js";
 export { isReflectList, isReflectMap, isReflectMessage } from "./guard.js";

package/dist/cjs/reflect/index.js

@@ -33,7 +33,6 @@ __exportStar(require("./names.js"), exports);
 __exportStar(require("./nested-types.js"), exports);
 __exportStar(require("./reflect.js"), exports);
 __exportStar(require("./reflect-types.js"), exports);
-__exportStar(require("./registry.js"), exports);
 __exportStar(require("./scalar.js"), exports);
 var guard_js_1 = require("./guard.js");
 Object.defineProperty(exports, "isReflectList", { enumerable: true, get: function () { return guard_js_1.isReflectList; } });

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

@@ -1,15 +1,3 @@
-import type { DescEnumValue, DescField } from "../desc-types.js";
-import type { DescMethod, DescOneof } from "../desc-types.js";
-/**
- * Returns the name of a protobuf element in generated code.
- *
- * Field names - including oneofs - are converted to lowerCamelCase. For methods,
- * the first character is made lowercase. All names are escaped to be safe object
- * property names.
- *
- * This function does not provide names for messages, enumerations, and services.
- */
-export declare function localName(desc: DescEnumValue | DescOneof | DescField | DescMethod): string;
 /**
  * Converts snake_case to protoCamelCase according to the convention
  * used by protoc to convert a field name to a JSON name.
@@ -18,6 +6,6 @@ export declare function protoCamelCase(snakeCase: string): string;
 /**
  * Escapes names that are reserved for ECMAScript built-in object properties.
  *
- * Also see safeIdentifier() from @bufbuild/protoplugin/ecmascript.
+ * Also see safeIdentifier() from @bufbuild/protoplugin.
  */
 export declare function safeObjectProperty(name: string): string;

package/dist/cjs/reflect/names.js

@@ -13,45 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.safeObjectProperty = exports.protoCamelCase = exports.localName = void 0;
-/**
- * Returns the name of a protobuf element in generated code.
- *
- * Field names - including oneofs - are converted to lowerCamelCase. For methods,
- * the first character is made lowercase. All names are escaped to be safe object
- * property names.
- *
- * This function does not provide names for messages, enumerations, and services.
- */
-function localName(desc) {
-    const name = desc.name;
-    switch (desc.kind) {
-        // @ts-expect-error TS7029
-        case "field":
-            if (desc.oneof !== undefined) {
-                // oneof member names are not properties, but values of the `case` property.
-                return protoCamelCase(name);
-            }
-        // eslint-disable-next-line no-fallthrough
-        case "oneof":
-            return safeObjectProperty(protoCamelCase(name));
-        case "enum_value": {
-            let name = desc.name;
-            const sharedPrefix = desc.parent.sharedPrefix;
-            if (sharedPrefix !== undefined) {
-                name = name.substring(sharedPrefix.length);
-            }
-            return safeObjectProperty(name);
-        }
-        case "rpc": {
-            if (name.length == 0) {
-                return name;
-            }
-            return safeObjectProperty(name[0].toLowerCase() + name.substring(1));
-        }
-    }
-}
-exports.localName = localName;
+exports.safeObjectProperty = exports.protoCamelCase = void 0;
 /**
  * Converts snake_case to protoCamelCase according to the convention
  * used by protoc to convert a field name to a JSON name.
@@ -104,7 +66,7 @@ const reservedObjectProperties = new Set([
 /**
  * Escapes names that are reserved for ECMAScript built-in object properties.
  *
- * Also see safeIdentifier() from @bufbuild/protoplugin/ecmascript.
+ * Also see safeIdentifier() from @bufbuild/protoplugin.
  */
 function safeObjectProperty(name) {
     return reservedObjectProperties.has(name) ? name + "$" : name;

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

@@ -1,2 +1,12 @@
-import type { DescEnum, DescExtension, DescFile, DescMessage, DescService } from "../desc-types.js";
+import type { AnyDesc, DescEnum, DescExtension, DescFile, DescMessage, DescService } from "../descriptors.js";
+/**
+ * Iterate over all types - enumerations, extensions, services, messages -
+ * and enumerations, extensions and messages nested in messages.
+ */
 export declare function nestedTypes(desc: DescFile | DescMessage): Iterable<DescMessage | DescEnum | DescExtension | DescService>;
+/**
+ * Returns the ancestors of a given Protobuf element, up to the file.
+ */
+export declare function parentTypes(desc: AnyDesc): Parent[];
+type Parent = DescFile | DescEnum | DescMessage | DescService;
+export {};

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

@@ -13,7 +13,11 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.nestedTypes = void 0;
+exports.parentTypes = exports.nestedTypes = void 0;
+/**
+ * Iterate over all types - enumerations, extensions, services, messages -
+ * and enumerations, extensions and messages nested in messages.
+ */
 function* nestedTypes(desc) {
     switch (desc.kind) {
         case "file":
@@ -36,3 +40,32 @@ function* nestedTypes(desc) {
     }
 }
 exports.nestedTypes = nestedTypes;
+/**
+ * Returns the ancestors of a given Protobuf element, up to the file.
+ */
+function parentTypes(desc) {
+    const parents = [];
+    while (desc.kind !== "file") {
+        const p = parent(desc);
+        desc = p;
+        parents.push(p);
+    }
+    return parents;
+}
+exports.parentTypes = parentTypes;
+function parent(desc) {
+    var _a;
+    switch (desc.kind) {
+        case "enum_value":
+        case "field":
+        case "oneof":
+        case "rpc":
+            return desc.parent;
+        case "service":
+            return desc.file;
+        case "extension":
+        case "enum":
+        case "message":
+            return (_a = desc.parent) !== null && _a !== void 0 ? _a : desc.file;
+    }
+}

package/dist/cjs/reflect/reflect-check.d.ts

@@ -1,9 +1,18 @@
-import type { DescField } from "../desc-types.js";
+import { type DescField } from "../descriptors.js";
 import { FieldError } from "./error.js";
+/**
+ * Check whether the given field value is valid for the reflect API.
+ */
 export declare function checkField(field: DescField, value: unknown): FieldError | undefined;
+/**
+ * Check whether the given list item is valid for the reflect API.
+ */
 export declare function checkListItem(field: DescField & {
     fieldKind: "list";
 }, index: number, value: unknown): FieldError | undefined;
+/**
+ * Check whether the given map key and value are valid for the reflect API.
+ */
 export declare function checkMapEntry(field: DescField & {
     fieldKind: "map";
 }, key: unknown, value: unknown): FieldError | undefined;

package/dist/cjs/reflect/reflect-check.js

@@ -14,11 +14,16 @@
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.formatVal = exports.checkMapEntry = exports.checkListItem = exports.checkField = void 0;
-const scalar_js_1 = require("./scalar.js");
-const scalar_js_2 = require("./scalar.js");
+const descriptors_js_1 = require("../descriptors.js");
 const is_message_js_1 = require("../is-message.js");
 const error_js_1 = require("./error.js");
 const guard_js_1 = require("./guard.js");
+const binary_encoding_js_1 = require("../wire/binary-encoding.js");
+const text_encoding_js_1 = require("../wire/text-encoding.js");
+const proto_int64_js_1 = require("../proto-int64.js");
+/**
+ * Check whether the given field value is valid for the reflect API.
+ */
 function checkField(field, value) {
     const check = field.fieldKind == "list"
         ? (0, guard_js_1.isReflectList)(value, field)
@@ -43,6 +48,9 @@ function checkField(field, value) {
     return new error_js_1.FieldError(field, reason);
 }
 exports.checkField = checkField;
+/**
+ * Check whether the given list item is valid for the reflect API.
+ */
 function checkListItem(field, index, value) {
     const check = checkSingular(field, value);
     if (check !== true) {
@@ -51,8 +59,11 @@ function checkListItem(field, index, value) {
     return undefined;
 }
 exports.checkListItem = checkListItem;
+/**
+ * Check whether the given map key and value are valid for the reflect API.
+ */
 function checkMapEntry(field, key, value) {
-    const checkKey = (0, scalar_js_2.checkScalarValue)(key, field.mapKey);
+    const checkKey = checkScalarValue(key, field.mapKey);
     if (checkKey !== true) {
         return new error_js_1.FieldError(field, `invalid map key: ${reasonSingular({ scalar: field.mapKey }, key, checkKey)}`);
     }
@@ -65,7 +76,7 @@ function checkMapEntry(field, key, value) {
 exports.checkMapEntry = checkMapEntry;
 function checkSingular(field, value) {
     if (field.scalar !== undefined) {
-        return (0, scalar_js_2.checkScalarValue)(value, field.scalar);
+        return checkScalarValue(value, field.scalar);
     }
     if (field.enum !== undefined) {
         if (field.enum.open) {
@@ -75,11 +86,89 @@ function checkSingular(field, value) {
     }
     return (0, guard_js_1.isReflectMessage)(value, field.message);
 }
+function checkScalarValue(value, scalar) {
+    switch (scalar) {
+        case descriptors_js_1.ScalarType.DOUBLE:
+            return typeof value == "number";
+        case descriptors_js_1.ScalarType.FLOAT:
+            if (typeof value != "number") {
+                return false;
+            }
+            if (Number.isNaN(value) || !Number.isFinite(value)) {
+                return true;
+            }
+            if (value > binary_encoding_js_1.FLOAT32_MAX || value < binary_encoding_js_1.FLOAT32_MIN) {
+                return `${value.toFixed()} out of range`;
+            }
+            return true;
+        case descriptors_js_1.ScalarType.INT32:
+        case descriptors_js_1.ScalarType.SFIXED32:
+        case descriptors_js_1.ScalarType.SINT32:
+            // signed
+            if (typeof value !== "number" || !Number.isInteger(value)) {
+                return false;
+            }
+            if (value > binary_encoding_js_1.INT32_MAX || value < binary_encoding_js_1.INT32_MIN) {
+                return `${value.toFixed()} out of range`;
+            }
+            return true;
+        case descriptors_js_1.ScalarType.FIXED32:
+        case descriptors_js_1.ScalarType.UINT32:
+            // unsigned
+            if (typeof value !== "number" || !Number.isInteger(value)) {
+                return false;
+            }
+            if (value > binary_encoding_js_1.UINT32_MAX || value < 0) {
+                return `${value.toFixed()} out of range`;
+            }
+            return true;
+        case descriptors_js_1.ScalarType.BOOL:
+            return typeof value == "boolean";
+        case descriptors_js_1.ScalarType.STRING:
+            if (typeof value != "string") {
+                return false;
+            }
+            return (0, text_encoding_js_1.getTextEncoding)().checkUtf8(value) || "invalid UTF8";
+        case descriptors_js_1.ScalarType.BYTES:
+            return value instanceof Uint8Array;
+        case descriptors_js_1.ScalarType.INT64:
+        case descriptors_js_1.ScalarType.SFIXED64:
+        case descriptors_js_1.ScalarType.SINT64:
+            // signed
+            if (typeof value != "string" &&
+                typeof value !== "bigint" &&
+                typeof value !== "number") {
+                return false;
+            }
+            try {
+                proto_int64_js_1.protoInt64.parse(value);
+            }
+            catch (e) {
+                return `${value} out of range`;
+            }
+            return true;
+        case descriptors_js_1.ScalarType.FIXED64:
+        case descriptors_js_1.ScalarType.UINT64:
+            // unsigned
+            if (typeof value != "string" &&
+                typeof value !== "bigint" &&
+                typeof value !== "number") {
+                return false;
+            }
+            try {
+                proto_int64_js_1.protoInt64.uParse(value);
+            }
+            catch (e) {
+                return `${value} out of range`;
+            }
+            return true;
+    }
+}
 function reasonSingular(field, val, details) {
     details =
         typeof details == "string" ? `: ${details}` : `, got ${formatVal(val)}`;
     if (field.scalar !== undefined) {
-        return `expected ${(0, scalar_js_1.scalarTypeDescription)(field.scalar)}` + details;
+        return `expected ${scalarTypeDescription(field.scalar)}` + details;
     }
     else if (field.enum !== undefined) {
         return `expected ${field.enum.toString()}` + details;
@@ -135,16 +224,44 @@ function formatReflectList(field) {
         case "enum":
             return `ReflectList (${field.enum.toString()})`;
         case "scalar":
-            return `ReflectList (${scalar_js_1.ScalarType[field.scalar]})`;
+            return `ReflectList (${descriptors_js_1.ScalarType[field.scalar]})`;
     }
 }
 function formatReflectMap(field) {
     switch (field.mapKind) {
         case "message":
-            return `ReflectMap (${scalar_js_1.ScalarType[field.mapKey]}, ${field.message.toString()})`;
+            return `ReflectMap (${descriptors_js_1.ScalarType[field.mapKey]}, ${field.message.toString()})`;
         case "enum":
-            return `ReflectMap (${scalar_js_1.ScalarType[field.mapKey]}, ${field.enum.toString()})`;
+            return `ReflectMap (${descriptors_js_1.ScalarType[field.mapKey]}, ${field.enum.toString()})`;
         case "scalar":
-            return `ReflectMap (${scalar_js_1.ScalarType[field.mapKey]}, ${scalar_js_1.ScalarType[field.scalar]})`;
+            return `ReflectMap (${descriptors_js_1.ScalarType[field.mapKey]}, ${descriptors_js_1.ScalarType[field.scalar]})`;
+    }
+}
+function scalarTypeDescription(scalar) {
+    switch (scalar) {
+        case descriptors_js_1.ScalarType.STRING:
+            return "string";
+        case descriptors_js_1.ScalarType.BOOL:
+            return "boolean";
+        case descriptors_js_1.ScalarType.INT64:
+        case descriptors_js_1.ScalarType.SINT64:
+        case descriptors_js_1.ScalarType.SFIXED64:
+            return "bigint (int64)";
+        case descriptors_js_1.ScalarType.UINT64:
+        case descriptors_js_1.ScalarType.FIXED64:
+            return "bigint (uint64)";
+        case descriptors_js_1.ScalarType.BYTES:
+            return "Uint8Array";
+        case descriptors_js_1.ScalarType.DOUBLE:
+            return "number (float64)";
+        case descriptors_js_1.ScalarType.FLOAT:
+            return "number (float32)";
+        case descriptors_js_1.ScalarType.FIXED32:
+        case descriptors_js_1.ScalarType.UINT32:
+            return "number (uint32)";
+        case descriptors_js_1.ScalarType.INT32:
+        case descriptors_js_1.ScalarType.SFIXED32:
+        case descriptors_js_1.ScalarType.SINT32:
+            return "number (int32)";
     }
 }