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

package/dist/cjs/from-json.d.ts

@@ -1,7 +1,7 @@
-import { type DescMessage } from "./descriptors.js";
+import { type DescEnum, type DescMessage } from "./descriptors.js";
 import type { JsonValue } from "./json-value.js";
 import type { Registry } from "./registry.js";
-import type { MessageShape } from "./types.js";
+import type { EnumJsonType, EnumShape, MessageShape } from "./types.js";
 /**
  * Options for parsing JSON data.
  */
@@ -21,7 +21,7 @@ export interface JsonReadOptions {
 /**
  * Parse a message from a JSON string.
  */
-export declare function fromJsonString<Desc extends DescMessage>(messageDesc: Desc, json: string, options?: Partial<JsonReadOptions>): MessageShape<Desc>;
+export declare function fromJsonString<Desc extends DescMessage>(schema: Desc, json: string, options?: Partial<JsonReadOptions>): MessageShape<Desc>;
 /**
  * Parse a message from a JSON string, merging fields.
  *
@@ -31,11 +31,11 @@ export declare function fromJsonString<Desc extends DescMessage>(messageDesc: De
  * If a message field is already present, it will be merged with the
  * new data.
  */
-export declare function mergeFromJsonString<Desc extends DescMessage>(messageDesc: Desc, target: MessageShape<Desc>, json: string, options?: Partial<JsonReadOptions>): void;
+export declare function mergeFromJsonString<Desc extends DescMessage>(schema: Desc, target: MessageShape<Desc>, json: string, options?: Partial<JsonReadOptions>): MessageShape<Desc>;
 /**
  * Parse a message from a JSON value.
  */
-export declare function fromJson<Desc extends DescMessage>(messageDesc: Desc, json: JsonValue, options?: Partial<JsonReadOptions>): MessageShape<Desc>;
+export declare function fromJson<Desc extends DescMessage>(schema: Desc, json: JsonValue, options?: Partial<JsonReadOptions>): MessageShape<Desc>;
 /**
  * Parse a message from a JSON value, merging fields.
  *
@@ -45,4 +45,12 @@ export declare function fromJson<Desc extends DescMessage>(messageDesc: Desc, js
  * If a message field is already present, it will be merged with the
  * new data.
  */
-export declare function mergeFromJson<Desc extends DescMessage>(messageDesc: Desc, target: MessageShape<Desc>, json: JsonValue, options?: Partial<JsonReadOptions>): void;
+export declare function mergeFromJson<Desc extends DescMessage>(schema: Desc, target: MessageShape<Desc>, json: JsonValue, options?: Partial<JsonReadOptions>): MessageShape<Desc>;
+/**
+ * Parses an enum value from JSON.
+ */
+export declare function enumFromJson<Desc extends DescEnum>(descEnum: Desc, json: EnumJsonType<Desc>): EnumShape<Desc>;
+/**
+ * Is the given value a JSON enum value?
+ */
+export declare function isEnumJson<Desc extends DescEnum>(descEnum: Desc, value: unknown): value is EnumJsonType<Desc>;

package/dist/cjs/from-json.js

@@ -13,7 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergeFromJson = exports.fromJson = exports.mergeFromJsonString = exports.fromJsonString = void 0;
+exports.isEnumJson = exports.enumFromJson = exports.mergeFromJson = exports.fromJson = exports.mergeFromJsonString = exports.fromJsonString = void 0;
 /* eslint-disable no-case-declarations,@typescript-eslint/restrict-template-expressions */
 const descriptors_js_1 = require("./descriptors.js");
 const proto_int64_js_1 = require("./proto-int64.js");
@@ -35,8 +35,8 @@ function makeReadOptions(options) {
 /**
  * Parse a message from a JSON string.
  */
-function fromJsonString(messageDesc, json, options) {
-    return fromJson(messageDesc, parseJsonString(json, messageDesc.typeName), options);
+function fromJsonString(schema, json, options) {
+    return fromJson(schema, parseJsonString(json, schema.typeName), options);
 }
 exports.fromJsonString = fromJsonString;
 /**
@@ -48,15 +48,15 @@ exports.fromJsonString = fromJsonString;
  * If a message field is already present, it will be merged with the
  * new data.
  */
-function mergeFromJsonString(messageDesc, target, json, options) {
-    mergeFromJson(messageDesc, target, parseJsonString(json, messageDesc.typeName), options);
+function mergeFromJsonString(schema, target, json, options) {
+    return mergeFromJson(schema, target, parseJsonString(json, schema.typeName), options);
 }
 exports.mergeFromJsonString = mergeFromJsonString;
 /**
  * Parse a message from a JSON value.
  */
-function fromJson(messageDesc, json, options) {
-    const msg = (0, reflect_js_1.reflect)(messageDesc);
+function fromJson(schema, json, options) {
+    const msg = (0, reflect_js_1.reflect)(schema);
     try {
         readMessage(msg, json, makeReadOptions(options));
     }
@@ -81,9 +81,9 @@ exports.fromJson = fromJson;
  * If a message field is already present, it will be merged with the
  * new data.
  */
-function mergeFromJson(messageDesc, target, json, options) {
+function mergeFromJson(schema, target, json, options) {
     try {
-        readMessage((0, reflect_js_1.reflect)(messageDesc, target), json, makeReadOptions(options));
+        readMessage((0, reflect_js_1.reflect)(schema, target), json, makeReadOptions(options));
     }
     catch (e) {
         if ((0, error_js_1.isFieldError)(e)) {
@@ -94,8 +94,27 @@ function mergeFromJson(messageDesc, target, json, options) {
         }
         throw e;
     }
+    return target;
 }
 exports.mergeFromJson = mergeFromJson;
+/**
+ * Parses an enum value from JSON.
+ */
+function enumFromJson(descEnum, json) {
+    const val = readEnum(descEnum, json, false, false);
+    if (val === tokenIgnoredUnknownEnum) {
+        throw new Error(`cannot decode ${String(descEnum)} from JSON: ${(0, reflect_check_js_1.formatVal)(json)}`);
+    }
+    return val;
+}
+exports.enumFromJson = enumFromJson;
+/**
+ * Is the given value a JSON enum value?
+ */
+function isEnumJson(descEnum, value) {
+    return undefined !== descEnum.values.find((v) => v.name === value);
+}
+exports.isEnumJson = isEnumJson;
 function readMessage(msg, json, opts) {
     var _a;
     if (tryWktFromJson(msg, json, opts)) {
@@ -153,17 +172,18 @@ function readField(msg, field, json, opts) {
             readMessageField(msg, field, json, opts);
             break;
         case "list":
-            readListField(msg, field, json, opts);
+            readListField(msg.get(field), json, opts);
             break;
         case "map":
-            readMapField(msg, field, json, opts);
+            readMapField(msg.get(field), json, opts);
             break;
     }
 }
-function readMapField(msg, field, json, opts) {
+function readMapField(map, json, opts) {
     if (json === null) {
         return;
     }
+    const field = map.field();
     if (typeof json != "object" || Array.isArray(json)) {
         throw new error_js_1.FieldError(field, "expected object, got " + (0, reflect_check_js_1.formatVal)(json));
     }
@@ -171,45 +191,32 @@ function readMapField(msg, field, json, opts) {
         if (jsonMapValue === null) {
             throw new error_js_1.FieldError(field, "map value must not be null");
         }
-        const key = mapKeyFromJson(field.mapKey, jsonMapKey);
+        let value;
         switch (field.mapKind) {
             case "message":
                 const msgValue = (0, reflect_js_1.reflect)(field.message);
                 readMessage(msgValue, jsonMapValue, opts);
-                // TODO fix types
-                // @ts-expect-error TODO
-                const err = msg.setMapEntry(field, key, msgValue);
-                if (err) {
-                    throw err;
-                }
+                value = msgValue;
                 break;
             case "enum":
-                const enumValue = readEnum(field.enum, jsonMapValue, opts.ignoreUnknownFields, true);
-                if (enumValue !== tokenIgnoredUnknownEnum) {
-                    // TODO fix types
-                    // @ts-expect-error TODO
-                    const err = msg.setMapEntry(field, key, enumValue);
-                    if (err) {
-                        throw err;
-                    }
+                value = readEnum(field.enum, jsonMapValue, opts.ignoreUnknownFields, true);
+                if (value === tokenIgnoredUnknownEnum) {
+                    return;
                 }
                 break;
             case "scalar":
-                const err2 = msg.setMapEntry(field, 
-                // TODO fix types
-                // @ts-expect-error TODO
-                key, scalarFromJson(field, jsonMapValue, true));
-                if (err2) {
-                    throw err2;
-                }
+                value = scalarFromJson(field, jsonMapValue, true);
                 break;
         }
+        const key = mapKeyFromJson(field.mapKey, jsonMapKey);
+        map.set(key, value);
     }
 }
-function readListField(msg, field, json, opts) {
+function readListField(list, json, opts) {
     if (json === null) {
         return;
     }
+    const field = list.field();
     if (!Array.isArray(json)) {
         throw new error_js_1.FieldError(field, "expected Array, got " + (0, reflect_check_js_1.formatVal)(json));
     }
@@ -221,19 +228,16 @@ function readListField(msg, field, json, opts) {
             case "message":
                 const msgValue = (0, reflect_js_1.reflect)(field.message);
                 readMessage(msgValue, jsonItem, opts);
-                msg.addListItem(field, msgValue);
+                list.add(msgValue);
                 break;
             case "enum":
                 const enumValue = readEnum(field.enum, jsonItem, opts.ignoreUnknownFields, true);
                 if (enumValue !== tokenIgnoredUnknownEnum) {
-                    msg.addListItem(field, enumValue);
+                    list.add(enumValue);
                 }
                 break;
             case "scalar":
-                const err = msg.addListItem(field, scalarFromJson(field, jsonItem, true));
-                if (err) {
-                    throw err;
-                }
+                list.add(scalarFromJson(field, jsonItem, true));
                 break;
         }
     }
@@ -262,12 +266,7 @@ function readScalarField(msg, field, json) {
         msg.clear(field);
     }
     else {
-        // TODO fix type error
-        // @ts-expect-error TODO
-        const err = msg.set(field, scalarValue);
-        if (err) {
-            throw err;
-        }
+        msg.set(field, scalarValue);
     }
 }
 const tokenIgnoredUnknownEnum = Symbol();
@@ -467,10 +466,7 @@ function tryWktFromJson(msg, jsonValue, opts) {
                     msg.clear(valueField);
                 }
                 else {
-                    const err = msg.set(valueField, scalarFromJson(valueField, jsonValue, true));
-                    if (err) {
-                        throw err;
-                    }
+                    msg.set(valueField, scalarFromJson(valueField, jsonValue, true));
                 }
                 return true;
             }
@@ -581,7 +577,7 @@ function structFromJson(struct, json) {
         throw new Error(`cannot decode message ${struct.$typeName} from JSON ${(0, reflect_check_js_1.formatVal)(json)}`);
     }
     for (const [k, v] of Object.entries(json)) {
-        const parsedV = (0, create_js_1.create)(index_js_1.ValueDesc);
+        const parsedV = (0, create_js_1.create)(index_js_1.ValueSchema);
         valueFromJson(parsedV, v);
         struct.fields[k] = parsedV;
     }
@@ -602,12 +598,12 @@ function valueFromJson(value, json) {
                 value.kind = { case: "nullValue", value: index_js_1.NullValue.NULL_VALUE };
             }
             else if (Array.isArray(json)) {
-                const listValue = (0, create_js_1.create)(index_js_1.ListValueDesc);
+                const listValue = (0, create_js_1.create)(index_js_1.ListValueSchema);
                 listValueFromJson(listValue, json);
                 value.kind = { case: "listValue", value: listValue };
             }
             else {
-                const struct = (0, create_js_1.create)(index_js_1.StructDesc);
+                const struct = (0, create_js_1.create)(index_js_1.StructSchema);
                 structFromJson(struct, json);
                 value.kind = { case: "structValue", value: struct };
             }
@@ -622,7 +618,7 @@ function listValueFromJson(listValue, json) {
         throw new Error(`cannot decode message ${listValue.$typeName} from JSON ${(0, reflect_check_js_1.formatVal)(json)}`);
     }
     for (const e of json) {
-        const value = (0, create_js_1.create)(index_js_1.ValueDesc);
+        const value = (0, create_js_1.create)(index_js_1.ValueSchema);
         valueFromJson(value, e);
         listValue.values.push(value);
     }

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

@@ -4,4 +4,4 @@ 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.
  */
-export declare function isMessage<Desc extends DescMessage>(arg: unknown, desc?: Desc): arg is MessageShape<Desc>;
+export declare function isMessage<Desc extends DescMessage>(arg: unknown, schema?: Desc): arg is MessageShape<Desc>;

package/dist/cjs/is-message.js

@@ -18,7 +18,7 @@ exports.isMessage = void 0;
  * Determine whether the given `arg` is a message.
  * If `desc` is set, determine whether `arg` is this specific message.
  */
-function isMessage(arg, desc) {
+function isMessage(arg, schema) {
     const isMessage = arg !== null &&
         typeof arg == "object" &&
         "$typeName" in arg &&
@@ -26,9 +26,9 @@ function isMessage(arg, desc) {
     if (!isMessage) {
         return false;
     }
-    if (desc === undefined) {
+    if (schema === undefined) {
         return true;
     }
-    return desc.typeName === arg.$typeName;
+    return schema.typeName === arg.$typeName;
 }
 exports.isMessage = isMessage;

package/dist/cjs/reflect/guard.js

@@ -15,7 +15,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isReflectMessage = exports.isReflectMap = exports.isReflectList = exports.isOneofADT = exports.isObject = void 0;
 const unsafe_js_1 = require("./unsafe.js");
-const is_message_js_1 = require("../is-message.js");
 function isObject(arg) {
     return arg !== null && typeof arg == "object" && !Array.isArray(arg);
 }
@@ -71,8 +70,9 @@ exports.isReflectMap = isReflectMap;
 function isReflectMessage(arg, messageDesc) {
     return (isObject(arg) &&
         unsafe_js_1.unsafeLocal in arg &&
-        "message" in arg &&
-        (0, is_message_js_1.isMessage)(arg.message) &&
-        (messageDesc === undefined || arg.message.$typeName == messageDesc.typeName));
+        "desc" in arg &&
+        isObject(arg.desc) &&
+        arg.desc.kind === "message" &&
+        (messageDesc === undefined || arg.desc.typeName == messageDesc.typeName));
 }
 exports.isReflectMessage = isReflectMessage;

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

@@ -1,5 +1,4 @@
 import { type DescField, type DescMessage, type DescOneof } from "../descriptors.js";
-import { FieldError } from "./error.js";
 import { unsafeLocal } from "./unsafe.js";
 import type { Message, UnknownField } from "../types.js";
 import type { ScalarValue } from "./scalar.js";
@@ -87,7 +86,7 @@ export interface ReflectMessage {
      * Note that get() never returns `undefined`. To determine whether a field is
      * set, use isSet().
      */
-    get<Field extends DescField>(field: Field): ReflectGetValue<Field>;
+    get<Field extends DescField>(field: Field): ReflectMessageGet<Field>;
     /**
      * Set a field value.
      *
@@ -105,22 +104,10 @@ export interface ReflectMessage {
      * - Map fields:
      *   ReflectMap.
      *
-     * Returns an error if the value is invalid for the field. `undefined` is not
+     * Throws 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: ReflectAddListItemValue<Field>): FieldError | undefined;
-    /**
-     * Set a map entry.
-     */
-    setMapEntry<Field extends DescField & {
-        fieldKind: "map";
-    }>(field: Field, key: MapEntryKey, value: ReflectSetMapEntryValue<Field>): FieldError | undefined;
+    set<Field extends DescField>(field: Field, value: unknown): void;
     /**
      * Returns the unknown fields of the message.
      */
@@ -159,16 +146,16 @@ export interface ReflectList<V = unknown> extends Iterable<V> {
      */
     get(index: number): V | undefined;
     /**
-     * Adds an item - or several items - at the end of the list.
-     * Returns an error if an item is invalid for this list.
+     * Adds an item at the end of the list.
+     * Throws an error if an item is invalid for this list.
      */
-    add(...item: V[]): FieldError | undefined;
+    add(item: V): void;
     /**
      * Replaces the item at the specified index with the specified item.
-     * Returns an error if the index is out of range (index < 0 || index >= size).
-     * Returns an error if the item is invalid for this list.
+     * Throws an error if the index is out of range (index < 0 || index >= size).
+     * Throws an error if the item is invalid for this list.
      */
-    set(index: number, item: V): FieldError | undefined;
+    set(index: number, item: V): void;
     /**
      * Removes all items from the list.
      */
@@ -190,7 +177,7 @@ export interface ReflectList<V = unknown> extends Iterable<V> {
  *   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> {
+export interface ReflectMap<K = unknown, V = unknown> extends ReadonlyMap<K, V> {
     /**
      * Returns the map field.
      */
@@ -204,46 +191,19 @@ export interface ReflectMap<K extends MapEntryKey = MapEntryKey, V = unknown> ex
     delete(key: K): boolean;
     /**
      * Sets or replaces the item at the specified key with the specified value.
-     * Returns an error if the key or value is invalid for this map.
+     * Throws an error if the key or value is invalid for this map.
      */
-    set(key: K, value: V): FieldError | undefined;
+    set(key: K, value: V): this;
     /**
      * Removes all entries from the map.
      */
     clear(): void;
     [unsafeLocal]: Record<string, unknown>;
 }
-/**
- * A ReflectMap key.
- */
-export type MapEntryKey = string | number | bigint | boolean;
-type enumVal = number;
 /**
  * The return type of ReflectMessage.get()
  */
-export type ReflectGetValue<Field extends DescField = DescField> = (Field extends {
-    fieldKind: "map";
-} ? (Field extends {
-    mapKind: "message";
-} ? ReflectMap<MapEntryKey, ReflectMessage> : Field extends {
-    mapKind: "enum";
-} ? ReflectMap<MapEntryKey, enumVal> : Field extends {
-    mapKind: "scalar";
-    scalar: infer T;
-} ? ReflectMap<MapEntryKey, ScalarValue<T>> : never) : Field extends {
-    fieldKind: "list";
-} ? ReflectList : Field extends {
-    fieldKind: "enum";
-} ? number : Field extends {
-    fieldKind: "message";
-} ? ReflectMessage : Field extends {
-    fieldKind: "scalar";
-    scalar: infer T;
-} ? ScalarValue<T> : never);
-/**
- * The type of the "value" argument of ReflectMessage.set()
- */
-export type ReflectSetValue<Field extends DescField = DescField> = (Field extends {
+export type ReflectMessageGet<Field extends DescField = DescField> = (Field extends {
     fieldKind: "map";
 } ? ReflectMap : Field extends {
     fieldKind: "list";
@@ -255,30 +215,3 @@ export type ReflectSetValue<Field extends DescField = DescField> = (Field extend
     fieldKind: "scalar";
     scalar: infer T;
 } ? ScalarValue<T> : never);
-/**
- * The type of the "value" argument of ReflectMessage.addListItem()
- */
-export type ReflectAddListItemValue<Field extends DescField & {
-    fieldKind: "list";
-}> = (Field extends {
-    listKind: "scalar";
-    scalar: infer T;
-} ? ScalarValue<T> : Field extends {
-    listKind: "enum";
-} ? enumVal : Field extends {
-    listKind: "message";
-} ? ReflectMessage : never);
-/**
- * The type of the "value" argument of ReflectMessage.setMapEntry()
- */
-export type ReflectSetMapEntryValue<Field extends DescField & {
-    fieldKind: "map";
-}> = (Field extends {
-    mapKind: "enum";
-} ? enumVal : Field extends {
-    mapKind: "message";
-} ? ReflectMessage : Field extends {
-    mapKind: "scalar";
-    scalar: infer T;
-} ? ScalarValue<T> : never);
-export {};

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

@@ -1,32 +1,43 @@
 import { type DescField, type DescMessage } from "../descriptors.js";
 import type { MessageShape } from "../types.js";
-import type { MapEntryKey, ReflectList, ReflectMap, ReflectMessage } from "./reflect-types.js";
+import type { 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,
-     * a value for an uint32 field must be a ECMAScript Number >= 0.
-     *
-     * Note that setting a message field validates the type of the message,
-     * but does not check its fields.
-     *
-     * In some contexts, field values are trusted, and performance can be
-     * improved by disabling validation by setting disableFieldValueCheck to
-     * `false`.
-     */
-    disableFieldValueCheck?: boolean;
-}): ReflectMessage;
+export declare function reflect<Desc extends DescMessage>(messageDesc: Desc, message?: MessageShape<Desc>, 
+/**
+ * By default, field values are validated when setting them. For example,
+ * a value for an uint32 field must be a ECMAScript Number >= 0.
+ *
+ * When field values are trusted, performance can be improved by disabling
+ * checks.
+ */
+check?: boolean): ReflectMessage;
 /**
  * Create a ReflectList.
  */
 export declare function reflectList<V>(field: DescField & {
     fieldKind: "list";
-}, unsafeInput?: unknown[], check?: boolean): ReflectList<V>;
+}, unsafeInput?: unknown[], 
+/**
+ * By default, field values are validated when setting them. For example,
+ * a value for an uint32 field must be a ECMAScript Number >= 0.
+ *
+ * When field values are trusted, performance can be improved by disabling
+ * checks.
+ */
+check?: boolean): ReflectList<V>;
 /**
  * Create a ReflectMap.
  */
-export declare function reflectMap<K extends MapEntryKey, V>(field: DescField & {
+export declare function reflectMap<K = unknown, V = unknown>(field: DescField & {
     fieldKind: "map";
-}, unsafeInput?: Record<string, unknown>, check?: boolean): ReflectMap<K, V>;
+}, unsafeInput?: Record<string, unknown>, 
+/**
+ * By default, field values are validated when setting them. For example,
+ * a value for an uint32 field must be a ECMAScript Number >= 0.
+ *
+ * When field values are trusted, performance can be improved by disabling
+ * checks.
+ */
+check?: boolean): ReflectMap<K, V>;