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

package/dist/cjs/from-binary.js

@@ -62,12 +62,12 @@ function readMessage(message, reader, options, delimited, lengthOrDelimitedField
     const unknownFields = (_a = message.getUnknown()) !== null && _a !== void 0 ? _a : [];
     while (reader.pos < end) {
         [fieldNo, wireType] = reader.tag();
-        if (wireType == binary_encoding_js_1.WireType.EndGroup) {
+        if (delimited && wireType == binary_encoding_js_1.WireType.EndGroup) {
             break;
         }
         const field = message.findNumber(fieldNo);
         if (!field) {
-            const data = reader.skip(wireType);
+            const data = reader.skip(wireType, fieldNo);
             if (options.readUnknownFields) {
                 unknownFields.push({ no: fieldNo, wireType, data });
             }
@@ -90,7 +90,7 @@ function readMessage(message, reader, options, delimited, lengthOrDelimitedField
 function readField(message, reader, field, wireType, options) {
     switch (field.fieldKind) {
         case "scalar":
-            message.set(field, readScalar(reader, field.scalar, field.longType));
+            message.set(field, readScalar(reader, field.scalar));
             break;
         case "enum":
             message.set(field, readScalar(reader, scalar_js_1.ScalarType.INT32));
@@ -102,15 +102,13 @@ function readField(message, reader, field, wireType, options) {
             readListField(message, reader, options, field, wireType);
             break;
         case "map":
-            // eslint-disable-next-line no-case-declarations
-            const [key, val] = readMapEntry(field, reader, options);
-            message.setMapEntry(field, key, val);
+            readMapEntry(message, field, reader, options);
             break;
     }
 }
 exports.readField = readField;
 // Read a map field, expecting key field = 1, value field = 2
-function readMapEntry(field, reader, options) {
+function readMapEntry(message, field, reader, options) {
     let key, val;
     const end = reader.pos + reader.uint32();
     while (reader.pos < end) {
@@ -150,7 +148,7 @@ function readMapEntry(field, reader, options) {
                 break;
         }
     }
-    return [key, val];
+    message.setMapEntry(field, key, val);
 }
 function readListField(message, reader, options, field, wireType) {
     var _a;
@@ -159,17 +157,16 @@ function readListField(message, reader, options, field, wireType) {
         return;
     }
     const scalarType = (_a = field.scalar) !== null && _a !== void 0 ? _a : scalar_js_1.ScalarType.INT32;
-    const longType = field.listKind == "scalar" ? field.longType : undefined;
     const packed = wireType == binary_encoding_js_1.WireType.LengthDelimited &&
         scalarType != scalar_js_1.ScalarType.STRING &&
         scalarType != scalar_js_1.ScalarType.BYTES;
     if (!packed) {
-        message.addListItem(field, readScalar(reader, scalarType, longType));
+        message.addListItem(field, readScalar(reader, scalarType));
         return;
     }
     const e = reader.uint32() + reader.pos;
     while (reader.pos < e) {
-        message.addListItem(field, readScalar(reader, scalarType, longType));
+        message.addListItem(field, readScalar(reader, scalarType));
     }
 }
 function readMessageField(reader, options, field, mergeMessage) {
@@ -178,14 +175,7 @@ function readMessageField(reader, options, field, mergeMessage) {
     readMessage(message, reader, options, delimited, delimited ? field.number : reader.uint32());
     return message;
 }
-function readScalar(reader, type, longType) {
-    let v = readScalarValue(reader, type);
-    if (longType === scalar_js_1.LongType.STRING) {
-        v = typeof v == "bigint" ? v.toString() : v;
-    }
-    return v;
-}
-function readScalarValue(reader, type) {
+function readScalar(reader, type) {
     switch (type) {
         case scalar_js_1.ScalarType.STRING:
             return reader.string();

package/dist/cjs/from-json.js

@@ -175,7 +175,7 @@ function readMapField(msg, field, json, opts) {
                 break;
             case "scalar":
                 try {
-                    msg.setMapEntry(field, key, readScalar(field.scalar, jsonMapValue, scalar_js_1.LongType.BIGINT, true));
+                    msg.setMapEntry(field, key, readScalar(field.scalar, jsonMapValue, true));
                 }
                 catch (e) {
                     let m = `cannot decode map value for field ${msg.desc.typeName}.${field.name} from JSON: ${(0, reflect_check_js_1.formatVal)(jsonMapValue)}`;
@@ -213,7 +213,7 @@ function readListField(msg, field, json, opts) {
                 break;
             case "scalar":
                 try {
-                    msg.addListItem(field, readScalar(field.scalar, jsonItem, field.longType, true));
+                    msg.addListItem(field, readScalar(field.scalar, jsonItem, true));
                 }
                 catch (e) {
                     let m = `cannot decode field ${msg.desc.typeName}.${field.name} from JSON: ${(0, reflect_check_js_1.formatVal)(jsonItem)}`;
@@ -246,7 +246,7 @@ function readEnumField(msg, field, json, opts) {
 }
 function readScalarField(msg, field, json) {
     try {
-        const scalarValue = readScalar(field.scalar, json, field.longType, false);
+        const scalarValue = readScalar(field.scalar, json, false);
         if (scalarValue === tokenNull) {
             msg.clear(field);
         }
@@ -274,7 +274,7 @@ function readMapKey(type, json) {
                 break;
         }
     }
-    return readScalar(type, json, scalar_js_1.LongType.BIGINT, true);
+    return readScalar(type, json, true);
 }
 const tokenIgnoredUnknownEnum = Symbol();
 function readEnum(desc, json, ignoreUnknownFields, nullAsZeroValue) {
@@ -304,10 +304,10 @@ function readEnum(desc, json, ignoreUnknownFields, nullAsZeroValue) {
     throw new Error(`cannot decode enum ${desc.typeName} from JSON: ${(0, reflect_check_js_1.formatVal)(json)}`);
 }
 const tokenNull = Symbol();
-function readScalar(type, json, longType, nullAsZeroValue) {
+function readScalar(type, json, nullAsZeroValue) {
     if (json === null) {
         if (nullAsZeroValue) {
-            return (0, scalar_js_1.scalarZeroValue)(type, longType);
+            return (0, scalar_js_1.scalarZeroValue)(type, scalar_js_1.LongType.BIGINT);
         }
         return tokenNull;
     }
@@ -373,16 +373,12 @@ function readScalar(type, json, longType, nullAsZeroValue) {
         case scalar_js_1.ScalarType.SINT64:
             if (typeof json != "number" && typeof json != "string")
                 break;
-            const long = proto_int64_js_1.protoInt64.parse(json);
-            // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
-            return longType ? long.toString() : long;
+            return proto_int64_js_1.protoInt64.parse(json);
         case scalar_js_1.ScalarType.FIXED64:
         case scalar_js_1.ScalarType.UINT64:
             if (typeof json != "number" && typeof json != "string")
                 break;
-            const uLong = proto_int64_js_1.protoInt64.uParse(json);
-            // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
-            return longType ? uLong.toString() : uLong;
+            return proto_int64_js_1.protoInt64.uParse(json);
         // bool:
         case scalar_js_1.ScalarType.BOOL:
             if (typeof json !== "boolean")
@@ -450,7 +446,7 @@ function tryWktFromJson(msg, jsonValue, opts) {
                     msg.clear(valueField);
                 }
                 else {
-                    msg.set(valueField, readScalar(valueField.scalar, jsonValue, valueField.longType, true));
+                    msg.set(valueField, readScalar(valueField.scalar, jsonValue, true));
                 }
                 return true;
             }

package/dist/cjs/index.d.ts

@@ -12,5 +12,5 @@ export { fromBinary, mergeFromBinary } from "./from-binary.js";
 export type { BinaryReadOptions } from "./from-binary.js";
 export * from "./to-json.js";
 export * from "./from-json.js";
-export { hasExtension, getExtension, setExtension, clearExtension, } from "./extensions.js";
+export { hasExtension, getExtension, setExtension, clearExtension, hasOption, getOption, } from "./extensions.js";
 export * from "./proto-int64.js";

package/dist/cjs/index.js

@@ -27,7 +27,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.clearExtension = exports.setExtension = exports.getExtension = exports.hasExtension = exports.mergeFromBinary = exports.fromBinary = exports.toBinary = void 0;
+exports.getOption = exports.hasOption = exports.clearExtension = exports.setExtension = exports.getExtension = exports.hasExtension = exports.mergeFromBinary = exports.fromBinary = exports.toBinary = void 0;
 __exportStar(require("./types.js"), exports);
 __exportStar(require("./is-message.js"), exports);
 __exportStar(require("./create.js"), exports);
@@ -47,4 +47,6 @@ Object.defineProperty(exports, "hasExtension", { enumerable: true, get: function
 Object.defineProperty(exports, "getExtension", { enumerable: true, get: function () { return extensions_js_1.getExtension; } });
 Object.defineProperty(exports, "setExtension", { enumerable: true, get: function () { return extensions_js_1.setExtension; } });
 Object.defineProperty(exports, "clearExtension", { enumerable: true, get: function () { return extensions_js_1.clearExtension; } });
+Object.defineProperty(exports, "hasOption", { enumerable: true, get: function () { return extensions_js_1.hasOption; } });
+Object.defineProperty(exports, "getOption", { enumerable: true, get: function () { return extensions_js_1.getOption; } });
 __exportStar(require("./proto-int64.js"), exports);

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.

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.

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 "../desc-types.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-types.d.ts

@@ -3,30 +3,149 @@ import { FieldError } from "./error.js";
 import { unsafeLocal } from "./unsafe.js";
 import type { Message, UnknownField } from "../types.js";
 import type { LongType, ScalarValue } from "./scalar.js";
+/**
+ * ReflectMessage provides dynamic access and manipulation of a message.
+ */
 export interface ReflectMessage {
+    /**
+     * The underlying message instance.
+     */
     readonly message: Message;
+    /**
+     * The descriptor for the message.
+     */
     readonly desc: DescMessage;
+    /**
+     * The fields of the message. This is a shortcut to message.fields.
+     */
     readonly fields: readonly DescField[];
+    /**
+     * The fields of the message, sorted by field number ascending.
+     */
     readonly sortedFields: readonly DescField[];
+    /**
+     * Oneof groups of the message. This is a shortcut to message.oneofs.
+     */
     readonly oneofs: readonly DescOneof[];
+    /**
+     * Fields and oneof groups for this message. This is a shortcut to message.members.
+     */
     readonly members: readonly (DescField | DescOneof)[];
+    /**
+     * Find a field by number.
+     */
     findNumber(number: number): DescField | undefined;
+    /**
+     * Returns true if the field is set.
+     *
+     * - Scalar and enum fields with implicit presence (proto3):
+     *   Set if not a zero value.
+     *
+     * - Scalar and enum fields with explicit presence (proto2, oneof):
+     *   Set if a value was set when creating or parsing the message, or when a
+     *   value was assigned to the field's property.
+     *
+     * - Message fields:
+     *   Set if the property is not undefined.
+     *
+     * - List and map fields:
+     *   Set if not empty.
+     */
     isSet(field: DescField): boolean;
+    /**
+     * Resets the field, so that isSet() will return false.
+     */
     clear(field: DescField): void;
+    /**
+     * Return the selected field of a oneof group.
+     */
     oneofCase(oneof: DescOneof): DescField | undefined;
+    /**
+     * Returns the field value. Values are converted or wrapped to make it easier
+     * to manipulate messages.
+     *
+     * - Scalar fields:
+     *   Returns the value, but converts 64-bit integer fields with the option
+     *   `jstype=JS_STRING` to a bigint value.
+     *   If the field is not set, the default value is returned. If no default
+     *   value is set, the zero value is returned.
+     *
+     * - Enum fields:
+     *   Returns the numeric value. If the field is not set, the default value is
+     *   returned. If no default value is set, the zero value is returned.
+     *
+     * - Message fields:
+     *   Returns a ReflectMessage. If the field is not set, a new message is
+     *   returned, but not set on the field.
+     *
+     * - List fields:
+     *   Returns a ReflectList object.
+     *
+     * - Map fields:
+     *   Returns a ReflectMap object.
+     *
+     * Note that get() never returns `undefined`. To determine whether a field is
+     * set, use isSet().
+     */
     get<Field extends DescField>(field: Field): ReflectGetValue<Field>;
+    /**
+     * Set a field value.
+     *
+     * Expects values in the same form that get() returns:
+     *
+     * - Scalar fields:
+     *   64-bit integer fields with the option `jstype=JS_STRING` as a bigint value.
+     *
+     * - Message fields:
+     *   ReflectMessage.
+     *
+     * - List fields:
+     *   ReflectList.
+     *
+     * - Map fields:
+     *   ReflectMap.
+     *
+     * Returns an error if the value is invalid for the field. `undefined` is not
+     * a valid value. To reset a field, use clear().
+     */
     set<Field extends DescField>(field: Field, value: ReflectSetValue<Field>): FieldError | undefined;
+    /**
+     * Add an item to a list field.
+     */
     addListItem<Field extends DescField & {
         fieldKind: "list";
-    }>(field: Field, value: NewListItem<Field>): FieldError | undefined;
+    }>(field: Field, value: ReflectAddListItemValue<Field>): FieldError | undefined;
+    /**
+     * Set a map entry.
+     */
     setMapEntry<Field extends DescField & {
         fieldKind: "map";
-    }>(field: Field, key: MapEntryKey, value: NewMapEntryValue<Field>): FieldError | undefined;
+    }>(field: Field, key: MapEntryKey, value: ReflectSetMapEntryValue<Field>): FieldError | undefined;
+    /**
+     * Returns the unknown fields of the message.
+     */
     getUnknown(): UnknownField[] | undefined;
+    /**
+     * Sets the unknown fields of the message, overwriting any previous values.
+     */
     setUnknown(value: UnknownField[]): void;
     [unsafeLocal]: Message;
 }
+/**
+ * ReflectList provides dynamic access and manipulation of a list field on a
+ * message.
+ *
+ * ReflectList is iterable - you can loop through all items with a for...of loop.
+ *
+ * Values are converted or wrapped to make it easier to manipulate them:
+ * - Scalar 64-bit integer fields with the option `jstype=JS_STRING` are
+ *   converted to bigint.
+ * - Messages are wrapped in a ReflectMessage.
+ */
 export interface ReflectList<V = unknown> extends Iterable<V> {
+    /**
+     * Returns the list field.
+     */
     field(): DescField & {
         fieldKind: "list";
     };
@@ -60,7 +179,21 @@ export interface ReflectList<V = unknown> extends Iterable<V> {
     values(): IterableIterator<V>;
     [unsafeLocal]: unknown[];
 }
+/**
+ * ReflectMap provides dynamic access and manipulation of a map field on a
+ * message.
+ *
+ * ReflectMap is iterable - you can loop through all entries with a for...of loop.
+ *
+ * Keys and values are converted or wrapped to make it easier to manipulate them:
+ * - A map field is a record object on a message, where keys are always strings.
+ *   ReflectMap converts keys to their closest possible type in TypeScript.
+ * - Messages are wrapped in a ReflectMessage.
+ */
 export interface ReflectMap<K extends MapEntryKey = MapEntryKey, V = unknown> extends ReadonlyMap<K, V> {
+    /**
+     * Returns the map field.
+     */
     field(): DescField & {
         fieldKind: "map";
     };
@@ -80,9 +213,15 @@ export interface ReflectMap<K extends MapEntryKey = MapEntryKey, V = unknown> ex
     clear(): void;
     [unsafeLocal]: Record<string, unknown>;
 }
+/**
+ * A ReflectMap key.
+ */
 export type MapEntryKey = string | number | bigint | boolean;
 type enumVal = number;
-type ReflectGetValue<Field extends DescField = DescField> = (Field extends {
+/**
+ * The return type of ReflectMessage.get()
+ */
+export type ReflectGetValue<Field extends DescField = DescField> = (Field extends {
     fieldKind: "map";
 } ? (Field extends {
     mapKind: "message";
@@ -95,25 +234,31 @@ type ReflectGetValue<Field extends DescField = DescField> = (Field extends {
     fieldKind: "list";
 } ? ReflectList : Field extends {
     fieldKind: "enum";
-} ? number | undefined : Field extends {
+} ? number : Field extends {
     fieldKind: "message";
 } ? ReflectMessage : Field extends {
     fieldKind: "scalar";
     scalar: infer T;
-} ? ScalarValue<T> | undefined : never);
-type ReflectSetValue<Field extends DescField = DescField> = (Field extends {
+} ? ScalarValue<T> : never);
+/**
+ * The type of the "value" argument of ReflectMessage.set()
+ */
+export type ReflectSetValue<Field extends DescField = DescField> = (Field extends {
     fieldKind: "map";
 } ? ReflectMap : Field extends {
     fieldKind: "list";
 } ? ReflectList : Field extends {
     fieldKind: "enum";
-} ? number | undefined : Field extends {
+} ? number : Field extends {
     fieldKind: "message";
 } ? ReflectMessage : Field extends {
     fieldKind: "scalar";
     scalar: infer T;
-} ? ScalarValue<T> | undefined : never);
-type NewListItem<Field extends DescField & {
+} ? ScalarValue<T> : never);
+/**
+ * The type of the "value" argument of ReflectMessage.addListItem()
+ */
+export type ReflectAddListItemValue<Field extends DescField & {
     fieldKind: "list";
 }> = (Field extends {
     listKind: "scalar";
@@ -123,7 +268,10 @@ type NewListItem<Field extends DescField & {
 } ? enumVal : Field extends {
     listKind: "message";
 } ? ReflectMessage : never);
-type NewMapEntryValue<Field extends DescField & {
+/**
+ * The type of the "value" argument of ReflectMessage.setMapEntry()
+ */
+export type ReflectSetMapEntryValue<Field extends DescField & {
     fieldKind: "map";
 }> = (Field extends {
     mapKind: "enum";

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

@@ -1,6 +1,9 @@
 import type { DescField, DescMessage } from "../desc-types.js";
 import type { MessageShape } from "../types.js";
 import type { MapEntryKey, ReflectList, ReflectMap, ReflectMessage } from "./reflect-types.js";
+/**
+ * Create a ReflectMessage.
+ */
 export declare function reflect<Desc extends DescMessage>(messageDesc: Desc, message?: MessageShape<Desc>, opt?: {
     /**
      * By default, field values are validated when setting them. For example,
@@ -15,9 +18,15 @@ export declare function reflect<Desc extends DescMessage>(messageDesc: Desc, mes
      */
     disableFieldValueCheck?: boolean;
 }): ReflectMessage;
+/**
+ * Create a ReflectList.
+ */
 export declare function reflectList<V>(field: DescField & {
     fieldKind: "list";
-}, unsafeInput?: unknown[]): ReflectList<V>;
+}, unsafeInput?: unknown[], check?: boolean): ReflectList<V>;
+/**
+ * Create a ReflectMap.
+ */
 export declare function reflectMap<K extends MapEntryKey, V>(field: DescField & {
     fieldKind: "map";
-}, unsafeInput?: Record<string, unknown>): ReflectMap<K, V>;
+}, unsafeInput?: Record<string, unknown>, check?: boolean): ReflectMap<K, V>;