@aptre/protobuf-es-lite 0.3.0 → 0.4.0

package/dist/enum.d.ts

@@ -1,3 +1,4 @@
+import { DescEnum } from "./index.js";
 /**
  * Reflection information for a protobuf enumeration.
  */
@@ -33,8 +34,17 @@ export interface EnumValueInfo {
      */
     readonly localName: string;
 }
-export declare function normalizeEnumValue(value: EnumValueInfo | Omit<EnumValueInfo, "localName">): EnumValueInfo;
 /**
  * Create a new EnumType with the given values.
  */
 export declare function createEnumType(typeName: string, values: (EnumValueInfo | Omit<EnumValueInfo, "localName">)[], _opt?: {}): EnumType;
+export declare function enumInfoZeroValue(values: (EnumValueInfo | Omit<EnumValueInfo, "localName">)[]): number;
+export declare function enumDescZeroValue(info: DescEnum): number;
+export declare function enumZeroValue<T extends EnumType>(info: T): number;
+/**
+ * Returns the normalized version of the enum value.
+ * Null is cast to the default value.
+ * String names are cast to the number enum.
+ * If string and the value is unknown, throws an error.
+ */
+export declare function normalizeEnumValue(info: EnumType, value: string | number | null | undefined): number;

package/dist/enum.js

@@ -1,9 +1,3 @@
-export function normalizeEnumValue(value) {
-    if ("localName" in value) {
-        return value;
-    }
-    return { ...value, localName: value.name };
-}
 /**
  * Create a new EnumType with the given values.
  */
@@ -16,7 +10,7 @@ _opt) {
     for (const value of values) {
         // We do not surface options at this time
         // const value: EnumValueInfo = {...v, options: v.options ?? emptyReadonlyObject};
-        const n = normalizeEnumValue(value);
+        const n = "localName" in value ? value : { ...value, localName: value.name };
         normalValues.push(n);
         names[value.name] = n;
         numbers[value.no] = n;
@@ -34,3 +28,58 @@ _opt) {
         },
     };
 }
+// enumInfoZeroValue returns the zero value for an enum info.
+export function enumInfoZeroValue(values) {
+    if (!values?.length) {
+        return 0;
+    }
+    // In proto3, the first enum value must be zero.
+    // In proto2, protobuf-go returns the first value as the default.
+    const zeroValue = values[0];
+    return zeroValue.no;
+}
+// enumDescZeroValue returns the zero value for an enum description.
+export function enumDescZeroValue(info) {
+    // In proto3, the first enum value must be zero.
+    // In proto2, protobuf-go returns the first value as the default.
+    if (info.values.length < 1) {
+        throw new Error("invalid enum: missing at least one value");
+    }
+    const zeroValue = info.values[0];
+    return zeroValue.number;
+}
+// enumZeroValue returns the zero value for an enum type.
+export function enumZeroValue(info) {
+    // In proto3, the first enum value must be zero.
+    // In proto2, protobuf-go returns the first value as the default.
+    if (info.values.length < 1) {
+        throw new Error("invalid enum: missing at least one value");
+    }
+    const zeroValue = info.values[0];
+    return zeroValue.no;
+}
+/**
+ * Returns the normalized version of the enum value.
+ * Null is cast to the default value.
+ * String names are cast to the number enum.
+ * If string and the value is unknown, throws an error.
+ */
+export function normalizeEnumValue(info, value) {
+    const zeroValue = enumZeroValue(info);
+    if (value == null) {
+        return zeroValue;
+    }
+    if (value === "" || value === zeroValue) {
+        return zeroValue;
+    }
+    if (typeof value === "string") {
+        // TODO: strip the type name prefix as well? MyEnum_VALUE
+        const val = info.findName(value);
+        if (!val) {
+            throw new Error(`enum ${info.typeName}: invalid value: "${value}"`);
+        }
+        return val.no;
+    }
+    // return the number value
+    return value;
+}

package/dist/field-wrapper.d.ts

@@ -5,8 +5,8 @@ import { ScalarType } from "./scalar.js";
  * ergonomic for use as a message field.
  */
 export interface FieldWrapper<T = any, U = any> {
-    wrapField(value: U): T;
-    unwrapField(value: T): U;
+    wrapField(value: U | null | undefined): T;
+    unwrapField(value: T): U | null | undefined;
 }
 /**
  * Wrap a primitive message field value in its corresponding wrapper

package/dist/field.d.ts

@@ -28,7 +28,42 @@ import { protoCamelCase } from "./names.js";
  * - "default": Only proto2: An explicit default value.
  * - "delimited": Only proto2: Use the tag-delimited group encoding.
  */
-export type FieldInfo = fiRules<fiScalar> | fiRules<fiEnum> | fiRules<fiMessage> | fiRules<fiMap>;
+export type FieldInfo = ScalarFieldInfo | EnumFieldInfo | MessageFieldInfo | MapFieldInfo;
+/**
+ * ScalarFieldInfo represents a scalar field.
+ * It includes rules for field presence, repetition, and packing.
+ */
+export type ScalarFieldInfo = fiRules<fiScalar>;
+/**
+ * EnumFieldInfo represents an enum field.
+ * It includes rules for field presence, repetition, and packing.
+ */
+export type EnumFieldInfo = fiRules<fiEnum>;
+/**
+ * MessageFieldInfo represents a message field.
+ * It includes rules for field presence, repetition, and packing.
+ */
+export type MessageFieldInfo = fiRules<fiMessage>;
+/**
+ * MapFieldInfo represents a map field with a scalar key type and
+ * a scalar, enum, or message value type.
+ * It includes rules for field presence, repetition, and packing.
+ */
+export type MapFieldInfo = fiRules<fiMap>;
+/**
+ * MapValueInfo represents the value type of a map field.
+ * The value can be a scalar, enum, or message type.
+ */
+export type MapValueInfo = {
+    readonly kind: "scalar";
+    readonly T: ScalarType;
+} | {
+    readonly kind: "enum";
+    readonly T: EnumType;
+} | {
+    readonly kind: "message";
+    readonly T: MessageType<any> | (() => MessageType<any>);
+};
 /**
  * Provides convenient access to field information of a message type.
  */
@@ -283,16 +318,7 @@ interface fiMap extends fiShared {
     /**
      * Map value type. Can be scalar, enum, or message.
      */
-    readonly V: {
-        readonly kind: "scalar";
-        readonly T: ScalarType;
-    } | {
-        readonly kind: "enum";
-        readonly T: EnumType;
-    } | {
-        readonly kind: "message";
-        readonly T: MessageType<any> | (() => MessageType<any>);
-    };
+    readonly V: MapValueInfo;
     /**
      * Is the field repeated? Never true for maps.
      */

package/dist/google/protobuf/any.pb.js

@@ -27,7 +27,7 @@
 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-import { applyPartialMessage, createMessageType, ScalarType } from "../../index.js";
+import { applyPartialMessage, createMessageType, ScalarType, } from "../../index.js";
 export const protobufPackage = "google.protobuf";
 // Any_Wkt contains the well-known-type overrides for Any.
 const Any_Wkt = {
@@ -42,7 +42,10 @@ const Any_Wkt = {
         }
         const message = messageType.fromBinary(msg.value);
         let json = messageType.toJson(message, options);
-        if (typeName.startsWith("google.protobuf.") || (json === null || Array.isArray(json) || typeof json !== "object")) {
+        if (typeName.startsWith("google.protobuf.") ||
+            json === null ||
+            Array.isArray(json) ||
+            typeof json !== "object") {
             json = { value: json };
         }
         json["@type"] = typeName;
@@ -50,7 +53,9 @@ const Any_Wkt = {
     },
     fromJson(json, options) {
         if (json === null || Array.isArray(json) || typeof json != "object") {
-            throw new Error(`cannot decode message google.protobuf.Any from JSON: expected object but got ${json === null ? "null" : Array.isArray(json) ? "array" : typeof json}`);
+            throw new Error(`cannot decode message google.protobuf.Any from JSON: expected object but got ${json === null ? "null"
+                : Array.isArray(json) ? "array"
+                    : typeof json}`);
         }
         if (Object.keys(json).length == 0) {
             return {};
@@ -64,7 +69,8 @@ const Any_Wkt = {
             throw new Error(`cannot decode message google.protobuf.Any from JSON: ${typeUrl} is not in the type registry`);
         }
         let message;
-        if (typeName.startsWith("google.protobuf.") && Object.prototype.hasOwnProperty.call(json, "value")) {
+        if (typeName.startsWith("google.protobuf.") &&
+            Object.prototype.hasOwnProperty.call(json, "value")) {
             message = messageType.fromJson(json["value"], options);
         }
         else {
@@ -91,11 +97,16 @@ const Any_Wkt = {
     unpack(msg, registry) {
         const typeUrl = msg.typeUrl;
         const messageType = !!typeUrl && registry.findMessage(typeUrl);
-        return messageType ? { message: messageType.fromBinary(msg.value), messageType } : undefined;
+        return messageType ?
+            { message: messageType.fromBinary(msg.value), messageType }
+            : undefined;
     },
     is(msg, msgType) {
         const name = msg.typeUrl;
-        return !!name && (typeof msgType === 'string' ? name === msgType : name === msgType.typeName);
+        return (!!name &&
+            (typeof msgType === "string" ?
+                name === msgType
+                : name === msgType.typeName));
     },
 };
 // Any contains the message type declaration for Any.

package/dist/google/protobuf/api.pb.js

@@ -40,7 +40,13 @@ export const Method = createMessageType({
         { no: 3, name: "request_streaming", kind: "scalar", T: ScalarType.BOOL },
         { no: 4, name: "response_type_url", kind: "scalar", T: ScalarType.STRING },
         { no: 5, name: "response_streaming", kind: "scalar", T: ScalarType.BOOL },
-        { no: 6, name: "options", kind: "message", T: () => Option, repeated: true },
+        {
+            no: 6,
+            name: "options",
+            kind: "message",
+            T: () => Option,
+            repeated: true,
+        },
         { no: 7, name: "syntax", kind: "enum", T: Syntax_Enum },
     ],
     packedByDefault: true,
@@ -59,8 +65,20 @@ export const Api = createMessageType({
     typeName: "google.protobuf.Api",
     fields: [
         { no: 1, name: "name", kind: "scalar", T: ScalarType.STRING },
-        { no: 2, name: "methods", kind: "message", T: () => Method, repeated: true },
-        { no: 3, name: "options", kind: "message", T: () => Option, repeated: true },
+        {
+            no: 2,
+            name: "methods",
+            kind: "message",
+            T: () => Method,
+            repeated: true,
+        },
+        {
+            no: 3,
+            name: "options",
+            kind: "message",
+            T: () => Option,
+            repeated: true,
+        },
         { no: 4, name: "version", kind: "scalar", T: ScalarType.STRING },
         { no: 5, name: "source_context", kind: "message", T: () => SourceContext },
         { no: 6, name: "mixins", kind: "message", T: () => Mixin, repeated: true },