@jsonjoy.com/json-pack 1.21.0 → 17.59.0

package/lib/JsonPackExtension.d.ts

@@ -1,3 +1,11 @@
+/**
+ * A wrapping for MessagePack extension or CBOR tag value. When encoder
+ * encounters {@link JsonPackExtension} it will encode it as a MessagePack
+ * extension or CBOR tag. Likewise, the decoder will
+ * decode extensions into {@link JsonPackExtension}.
+ *
+ * @category Value
+ */
 export declare class JsonPackExtension<T = Uint8Array> {
     readonly tag: number;
     readonly val: T;

package/lib/JsonPackExtension.js

@@ -1,6 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JsonPackExtension = void 0;
+/**
+ * A wrapping for MessagePack extension or CBOR tag value. When encoder
+ * encounters {@link JsonPackExtension} it will encode it as a MessagePack
+ * extension or CBOR tag. Likewise, the decoder will
+ * decode extensions into {@link JsonPackExtension}.
+ *
+ * @category Value
+ */
 class JsonPackExtension {
     constructor(tag, val) {
         this.tag = tag;

package/lib/JsonPackExtension.js.map

@@ -1 +1 @@
-{"version":3,"file":"JsonPackExtension.js","sourceRoot":"","sources":["../src/JsonPackExtension.ts"],"names":[],"mappings":";;;AAQA,MAAa,iBAAiB;IAC5B,YACkB,GAAW,EACX,GAAM;QADN,QAAG,GAAH,GAAG,CAAQ;QACX,QAAG,GAAH,GAAG,CAAG;IACrB,CAAC;CACL;AALD,8CAKC"}
+{"version":3,"file":"JsonPackExtension.js","sourceRoot":"","sources":["../src/JsonPackExtension.ts"],"names":[],"mappings":";;;AAAA;;;;;;;GAOG;AACH,MAAa,iBAAiB;IAC5B,YACkB,GAAW,EACX,GAAM;QADN,QAAG,GAAH,GAAG,CAAQ;QACX,QAAG,GAAH,GAAG,CAAG;IACrB,CAAC;CACL;AALD,8CAKC"}

package/lib/JsonPackMpint.d.ts

@@ -1,8 +1,33 @@
+/**
+ * Represents an SSH multiprecision integer (mpint).
+ *
+ * An mpint is stored in two's complement format, 8 bits per byte, MSB first.
+ * According to RFC 4251:
+ * - Negative numbers have the value 1 as the most significant bit of the first byte
+ * - If the most significant bit would be set for a positive number, the number MUST be preceded by a zero byte
+ * - Unnecessary leading bytes with the value 0 or 255 MUST NOT be included
+ * - The value zero MUST be stored as a string with zero bytes of data
+ */
 export declare class JsonPackMpint {
+    /**
+     * The raw bytes representing the mpint in two's complement format, MSB first.
+     */
     readonly data: Uint8Array;
     constructor(data: Uint8Array);
+    /**
+     * Create an mpint from a BigInt value.
+     */
     static fromBigInt(value: bigint): JsonPackMpint;
+    /**
+     * Convert the mpint to a BigInt value.
+     */
     toBigInt(): bigint;
+    /**
+     * Create an mpint from a number (limited to safe integer range).
+     */
     static fromNumber(value: number): JsonPackMpint;
+    /**
+     * Convert the mpint to a number (throws if out of safe integer range).
+     */
     toNumber(): number;
 }

package/lib/JsonPackMpint.js

@@ -1,10 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JsonPackMpint = void 0;
+/**
+ * Represents an SSH multiprecision integer (mpint).
+ *
+ * An mpint is stored in two's complement format, 8 bits per byte, MSB first.
+ * According to RFC 4251:
+ * - Negative numbers have the value 1 as the most significant bit of the first byte
+ * - If the most significant bit would be set for a positive number, the number MUST be preceded by a zero byte
+ * - Unnecessary leading bytes with the value 0 or 255 MUST NOT be included
+ * - The value zero MUST be stored as a string with zero bytes of data
+ */
 class JsonPackMpint {
     constructor(data) {
         this.data = data;
     }
+    /**
+     * Create an mpint from a BigInt value.
+     */
     static fromBigInt(value) {
         if (value === BigInt(0)) {
             return new JsonPackMpint(new Uint8Array(0));
@@ -12,43 +25,54 @@ class JsonPackMpint {
         const negative = value < BigInt(0);
         const bytes = [];
         if (negative) {
+            // For negative numbers, work with two's complement
             const absValue = -value;
             const bitLength = absValue.toString(2).length;
-            const byteLength = Math.ceil((bitLength + 1) / 8);
+            const byteLength = Math.ceil((bitLength + 1) / 8); // +1 for sign bit
+            // Calculate two's complement
             const twoComplement = (BigInt(1) << BigInt(byteLength * 8)) + value;
             for (let i = byteLength - 1; i >= 0; i--) {
                 bytes.push(Number((twoComplement >> BigInt(i * 8)) & BigInt(0xff)));
             }
+            // Ensure MSB is 1 for negative numbers
             while (bytes.length > 0 && bytes[0] === 0xff && bytes.length > 1 && (bytes[1] & 0x80) !== 0) {
                 bytes.shift();
             }
         }
         else {
+            // For positive numbers
             let tempValue = value;
             while (tempValue > BigInt(0)) {
                 bytes.unshift(Number(tempValue & BigInt(0xff)));
                 tempValue >>= BigInt(8);
             }
+            // Add leading zero if MSB is set (to indicate positive number)
             if (bytes[0] & 0x80) {
                 bytes.unshift(0);
             }
         }
         return new JsonPackMpint(new Uint8Array(bytes));
     }
+    /**
+     * Convert the mpint to a BigInt value.
+     */
     toBigInt() {
         if (this.data.length === 0) {
             return BigInt(0);
         }
         const negative = (this.data[0] & 0x80) !== 0;
         if (negative) {
+            // Two's complement for negative numbers
             let value = BigInt(0);
             for (let i = 0; i < this.data.length; i++) {
                 value = (value << BigInt(8)) | BigInt(this.data[i]);
             }
+            // Convert from two's complement
             const bitLength = this.data.length * 8;
             return value - (BigInt(1) << BigInt(bitLength));
         }
         else {
+            // Positive number
             let value = BigInt(0);
             for (let i = 0; i < this.data.length; i++) {
                 value = (value << BigInt(8)) | BigInt(this.data[i]);
@@ -56,12 +80,18 @@ class JsonPackMpint {
             return value;
         }
     }
+    /**
+     * Create an mpint from a number (limited to safe integer range).
+     */
     static fromNumber(value) {
         if (!Number.isInteger(value)) {
             throw new Error('Value must be an integer');
         }
         return JsonPackMpint.fromBigInt(BigInt(value));
     }
+    /**
+     * Convert the mpint to a number (throws if out of safe integer range).
+     */
     toNumber() {
         const bigIntValue = this.toBigInt();
         if (bigIntValue > BigInt(Number.MAX_SAFE_INTEGER) || bigIntValue < BigInt(Number.MIN_SAFE_INTEGER)) {

package/lib/JsonPackMpint.js.map

@@ -1 +1 @@
-{"version":3,"file":"JsonPackMpint.js","sourceRoot":"","sources":["../src/JsonPackMpint.ts"],"names":[],"mappings":";;;AAUA,MAAa,aAAa;IAMxB,YAAY,IAAgB;QAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAKM,MAAM,CAAC,UAAU,CAAC,KAAa;QACpC,IAAI,KAAK,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;YACxB,OAAO,IAAI,aAAa,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9C,CAAC;QAED,MAAM,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QACnC,MAAM,KAAK,GAAa,EAAE,CAAC;QAE3B,IAAI,QAAQ,EAAE,CAAC;YAEb,MAAM,QAAQ,GAAG,CAAC,KAAK,CAAC;YACxB,MAAM,SAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;YAC9C,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAGlD,MAAM,aAAa,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;YAEpE,KAAK,IAAI,CAAC,GAAG,UAAU,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBACzC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,aAAa,IAAI,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACtE,CAAC;YAGD,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC5F,KAAK,CAAC,KAAK,EAAE,CAAC;YAChB,CAAC;QACH,CAAC;aAAM,CAAC;YAEN,IAAI,SAAS,GAAG,KAAK,CAAC;YACtB,OAAO,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC7B,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBAChD,SAAS,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC;YAC1B,CAAC;YAGD,IAAI,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC;gBACpB,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACnB,CAAC;QACH,CAAC;QAED,OAAO,IAAI,aAAa,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAClD,CAAC;IAKM,QAAQ;QACb,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;QACnB,CAAC;QAED,MAAM,QAAQ,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QAE7C,IAAI,QAAQ,EAAE,CAAC;YAEb,IAAI,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YACtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC1C,KAAK,GAAG,CAAC,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YACtD,CAAC;YAED,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;YACvC,OAAO,KAAK,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;QAClD,CAAC;aAAM,CAAC;YAEN,IAAI,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YACtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC1C,KAAK,GAAG,CAAC,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YACtD,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAKM,MAAM,CAAC,UAAU,CAAC,KAAa;QACpC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC9C,CAAC;QACD,OAAO,aAAa,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACjD,CAAC;IAKM,QAAQ;QACb,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QACpC,IAAI,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACnG,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QACD,OAAO,MAAM,CAAC,WAAW,CAAC,CAAC;IAC7B,CAAC;CACF;AAxGD,sCAwGC"}
+{"version":3,"file":"JsonPackMpint.js","sourceRoot":"","sources":["../src/JsonPackMpint.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;GASG;AACH,MAAa,aAAa;IAMxB,YAAY,IAAgB;QAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,UAAU,CAAC,KAAa;QACpC,IAAI,KAAK,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;YACxB,OAAO,IAAI,aAAa,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9C,CAAC;QAED,MAAM,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QACnC,MAAM,KAAK,GAAa,EAAE,CAAC;QAE3B,IAAI,QAAQ,EAAE,CAAC;YACb,mDAAmD;YACnD,MAAM,QAAQ,GAAG,CAAC,KAAK,CAAC;YACxB,MAAM,SAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;YAC9C,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,kBAAkB;YAErE,6BAA6B;YAC7B,MAAM,aAAa,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;YAEpE,KAAK,IAAI,CAAC,GAAG,UAAU,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBACzC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,aAAa,IAAI,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACtE,CAAC;YAED,uCAAuC;YACvC,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC5F,KAAK,CAAC,KAAK,EAAE,CAAC;YAChB,CAAC;QACH,CAAC;aAAM,CAAC;YACN,uBAAuB;YACvB,IAAI,SAAS,GAAG,KAAK,CAAC;YACtB,OAAO,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC7B,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBAChD,SAAS,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC;YAC1B,CAAC;YAED,+DAA+D;YAC/D,IAAI,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC;gBACpB,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACnB,CAAC;QACH,CAAC;QAED,OAAO,IAAI,aAAa,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACI,QAAQ;QACb,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;QACnB,CAAC;QAED,MAAM,QAAQ,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QAE7C,IAAI,QAAQ,EAAE,CAAC;YACb,wCAAwC;YACxC,IAAI,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YACtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC1C,KAAK,GAAG,CAAC,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YACtD,CAAC;YACD,gCAAgC;YAChC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;YACvC,OAAO,KAAK,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;QAClD,CAAC;aAAM,CAAC;YACN,kBAAkB;YAClB,IAAI,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YACtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC1C,KAAK,GAAG,CAAC,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YACtD,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,UAAU,CAAC,KAAa;QACpC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC9C,CAAC;QACD,OAAO,aAAa,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACjD,CAAC;IAED;;OAEG;IACI,QAAQ;QACb,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QACpC,IAAI,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACnG,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QACD,OAAO,MAAM,CAAC,WAAW,CAAC,CAAC;IAC7B,CAAC;CACF;AAxGD,sCAwGC"}

package/lib/JsonPackValue.d.ts

@@ -1,3 +1,13 @@
+/**
+ * Use this wrapper is you have a pre-encoded MessagePack or CBOR value and you would
+ * like to dump it into a the document as-is. The contents of `buf` will
+ * be written as is to the document.
+ *
+ * It also serves as CBOR simple value container. In which case the type of value
+ * `val` field is "number".
+ *
+ * @category Value
+ */
 export declare class JsonPackValue<T = Uint8Array> {
     readonly val: T;
     constructor(val: T);

package/lib/JsonPackValue.js

@@ -1,6 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JsonPackValue = void 0;
+/**
+ * Use this wrapper is you have a pre-encoded MessagePack or CBOR value and you would
+ * like to dump it into a the document as-is. The contents of `buf` will
+ * be written as is to the document.
+ *
+ * It also serves as CBOR simple value container. In which case the type of value
+ * `val` field is "number".
+ *
+ * @category Value
+ */
 class JsonPackValue {
     constructor(val) {
         this.val = val;

package/lib/JsonPackValue.js.map

@@ -1 +1 @@
-{"version":3,"file":"JsonPackValue.js","sourceRoot":"","sources":["../src/JsonPackValue.ts"],"names":[],"mappings":";;;AAUA,MAAa,aAAa;IACxB,YAA4B,GAAM;QAAN,QAAG,GAAH,GAAG,CAAG;IAAG,CAAC;CACvC;AAFD,sCAEC"}
+{"version":3,"file":"JsonPackValue.js","sourceRoot":"","sources":["../src/JsonPackValue.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;GASG;AACH,MAAa,aAAa;IACxB,YAA4B,GAAM;QAAN,QAAG,GAAH,GAAG,CAAG;IAAG,CAAC;CACvC;AAFD,sCAEC"}

package/lib/avro/AvroDecoder.d.ts

@@ -1,29 +1,96 @@
 import { Reader } from '@jsonjoy.com/buffers/lib/Reader';
 import type { BinaryJsonDecoder } from '../types';
+/**
+ * Apache Avro binary decoder for basic value decoding.
+ * Implements the Avro binary decoding specification without schema validation.
+ * Based on https://avro.apache.org/docs/1.12.0/specification/
+ */
 export declare class AvroDecoder implements BinaryJsonDecoder {
     reader: Reader;
     read(uint8: Uint8Array): unknown;
     decode(uint8: Uint8Array): unknown;
+    /**
+     * Generic method to read any value - typically used when schema type is unknown
+     */
     readAny(): unknown;
+    /**
+     * Reads an Avro null value.
+     */
     readNull(): null;
+    /**
+     * Reads an Avro boolean value.
+     */
     readBoolean(): boolean;
+    /**
+     * Reads an Avro int value using zigzag decoding.
+     */
     readInt(): number;
+    /**
+     * Reads an Avro long value using zigzag decoding.
+     */
     readLong(): number | bigint;
+    /**
+     * Reads an Avro float value using IEEE 754 single-precision.
+     */
     readFloat(): number;
+    /**
+     * Reads an Avro double value using IEEE 754 double-precision.
+     */
     readDouble(): number;
+    /**
+     * Reads an Avro bytes value with length-prefixed encoding.
+     */
     readBytes(): Uint8Array;
+    /**
+     * Reads an Avro string value with UTF-8 encoding and length prefix.
+     */
     readString(): string;
+    /**
+     * Reads an Avro array with length-prefixed encoding.
+     * The itemReader function is called for each array item.
+     */
     readArray<T>(itemReader: () => T): T[];
+    /**
+     * Reads an Avro map with length-prefixed encoding.
+     * The valueReader function is called for each map value.
+     */
     readMap<T>(valueReader: () => T): Record<string, T>;
+    /**
+     * Reads an Avro union value.
+     * Returns an object with index and value.
+     */
     readUnion<T>(schemaReaders: Array<() => T>): {
         index: number;
         value: T;
     };
+    /**
+     * Reads an Avro enum value.
+     * Returns the symbol index.
+     */
     readEnum(): number;
+    /**
+     * Reads an Avro fixed value with specified length.
+     */
     readFixed(size: number): Uint8Array;
+    /**
+     * Reads an Avro record.
+     * The fieldReaders array contains functions to read each field in order.
+     */
     readRecord<T>(fieldReaders: Array<() => any>): T;
+    /**
+     * Reads a variable-length integer (for unsigned values like lengths)
+     */
     private readVarIntUnsigned;
+    /**
+     * Reads a variable-length long
+     */
     private readVarLong;
+    /**
+     * Decodes a 32-bit integer using zigzag decoding
+     */
     private decodeZigZag32;
+    /**
+     * Decodes a 64-bit integer using zigzag decoding
+     */
     private decodeZigZag64;
 }

package/lib/avro/AvroDecoder.js

@@ -2,6 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AvroDecoder = void 0;
 const Reader_1 = require("@jsonjoy.com/buffers/lib/Reader");
+/**
+ * Apache Avro binary decoder for basic value decoding.
+ * Implements the Avro binary decoding specification without schema validation.
+ * Based on https://avro.apache.org/docs/1.12.0/specification/
+ */
 class AvroDecoder {
     constructor() {
         this.reader = new Reader_1.Reader();
@@ -14,66 +19,103 @@ class AvroDecoder {
         this.reader.reset(uint8);
         return this.readAny();
     }
+    /**
+     * Generic method to read any value - typically used when schema type is unknown
+     */
     readAny() {
         throw new Error('readAny() requires schema information. Use readNull, readBoolean, etc. directly.');
     }
+    /**
+     * Reads an Avro null value.
+     */
     readNull() {
+        // Null values are encoded as zero bytes
         return null;
     }
+    /**
+     * Reads an Avro boolean value.
+     */
     readBoolean() {
         return this.reader.u8() === 1;
     }
+    /**
+     * Reads an Avro int value using zigzag decoding.
+     */
     readInt() {
         const zigzag = this.readVarIntUnsigned();
         return this.decodeZigZag32(zigzag);
     }
+    /**
+     * Reads an Avro long value using zigzag decoding.
+     */
     readLong() {
         const zigzag = this.readVarLong();
         const decoded = this.decodeZigZag64(zigzag);
+        // Return number if it fits in safe integer range, otherwise bigint
         if (decoded >= BigInt(Number.MIN_SAFE_INTEGER) && decoded <= BigInt(Number.MAX_SAFE_INTEGER)) {
             return Number(decoded);
         }
         return decoded;
     }
+    /**
+     * Reads an Avro float value using IEEE 754 single-precision.
+     */
     readFloat() {
         const reader = this.reader;
-        const value = reader.view.getFloat32(reader.x, true);
+        const value = reader.view.getFloat32(reader.x, true); // little-endian
         reader.x += 4;
         return value;
     }
+    /**
+     * Reads an Avro double value using IEEE 754 double-precision.
+     */
     readDouble() {
         const reader = this.reader;
-        const value = reader.view.getFloat64(reader.x, true);
+        const value = reader.view.getFloat64(reader.x, true); // little-endian
         reader.x += 8;
         return value;
     }
+    /**
+     * Reads an Avro bytes value with length-prefixed encoding.
+     */
     readBytes() {
         const length = this.readVarIntUnsigned();
         return this.reader.buf(length);
     }
+    /**
+     * Reads an Avro string value with UTF-8 encoding and length prefix.
+     */
     readString() {
         const length = this.readVarIntUnsigned();
         const bytes = this.reader.buf(length);
         return new TextDecoder().decode(bytes);
     }
+    /**
+     * Reads an Avro array with length-prefixed encoding.
+     * The itemReader function is called for each array item.
+     */
     readArray(itemReader) {
         const result = [];
         while (true) {
             const count = this.readVarIntUnsigned();
             if (count === 0)
-                break;
+                break; // End of array marker
             for (let i = 0; i < count; i++) {
                 result.push(itemReader());
             }
         }
         return result;
     }
+    /**
+     * Reads an Avro map with length-prefixed encoding.
+     * The valueReader function is called for each map value.
+     */
     readMap(valueReader) {
         const result = {};
         while (true) {
             const count = this.readVarIntUnsigned();
             if (count === 0)
-                break;
+                break; // End of map marker
             for (let i = 0; i < count; i++) {
                 const key = this.readString();
                 if (key === '__proto__')
@@ -83,6 +125,10 @@ class AvroDecoder {
         }
         return result;
     }
+    /**
+     * Reads an Avro union value.
+     * Returns an object with index and value.
+     */
     readUnion(schemaReaders) {
         const index = this.decodeZigZag32(this.readVarIntUnsigned());
         if (index < 0 || index >= schemaReaders.length) {
@@ -91,20 +137,37 @@ class AvroDecoder {
         const value = schemaReaders[index]();
         return { index, value };
     }
+    /**
+     * Reads an Avro enum value.
+     * Returns the symbol index.
+     */
     readEnum() {
         return this.decodeZigZag32(this.readVarIntUnsigned());
     }
+    /**
+     * Reads an Avro fixed value with specified length.
+     */
     readFixed(size) {
         return this.reader.buf(size);
     }
+    /**
+     * Reads an Avro record.
+     * The fieldReaders array contains functions to read each field in order.
+     */
     readRecord(fieldReaders) {
         const result = {};
         for (let i = 0; i < fieldReaders.length; i++) {
             const fieldValue = fieldReaders[i]();
+            // Note: This generic record reader doesn't know field names
+            // The schema-aware decoder will handle proper field mapping
             result[`field${i}`] = fieldValue;
         }
         return result;
     }
+    // Utility methods for Avro decoding
+    /**
+     * Reads a variable-length integer (for unsigned values like lengths)
+     */
     readVarIntUnsigned() {
         const reader = this.reader;
         let result = 0;
@@ -119,8 +182,11 @@ class AvroDecoder {
                 throw new Error('Variable-length integer is too long');
             }
         }
-        return result >>> 0;
+        return result >>> 0; // Convert to unsigned 32-bit
     }
+    /**
+     * Reads a variable-length long
+     */
     readVarLong() {
         const reader = this.reader;
         let result = BigInt(0);
@@ -137,9 +203,15 @@ class AvroDecoder {
         }
         return result;
     }
+    /**
+     * Decodes a 32-bit integer using zigzag decoding
+     */
     decodeZigZag32(value) {
         return (value >>> 1) ^ -(value & 1);
     }
+    /**
+     * Decodes a 64-bit integer using zigzag decoding
+     */
     decodeZigZag64(value) {
         return (value >> BigInt(1)) ^ -(value & BigInt(1));
     }

package/lib/avro/AvroDecoder.js.map

@@ -1 +1 @@
-{"version":3,"file":"AvroDecoder.js","sourceRoot":"","sources":["../../src/avro/AvroDecoder.ts"],"names":[],"mappings":";;;AAAA,4DAAuD;AAQvD,MAAa,WAAW;IAAxB;QACS,WAAM,GAAG,IAAI,eAAM,EAAE,CAAC;IA8O/B,CAAC;IA5OQ,IAAI,CAAC,KAAiB;QAC3B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IACxB,CAAC;IAEM,MAAM,CAAC,KAAiB;QAC7B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IACxB,CAAC;IAKM,OAAO;QACZ,MAAM,IAAI,KAAK,CAAC,kFAAkF,CAAC,CAAC;IACtG,CAAC;IAKM,QAAQ;QAEb,OAAO,IAAI,CAAC;IACd,CAAC;IAKM,WAAW;QAChB,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;IAChC,CAAC;IAKM,OAAO;QACZ,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACzC,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAKM,QAAQ;QACb,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAClC,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAG5C,IAAI,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC;YAC7F,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC;QACzB,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAKM,SAAS;QACd,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QACrD,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC;QACd,OAAO,KAAK,CAAC;IACf,CAAC;IAKM,UAAU;QACf,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QACrD,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC;QACd,OAAO,KAAK,CAAC;IACf,CAAC;IAKM,SAAS;QACd,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAKM,UAAU;QACf,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACzC,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAMM,SAAS,CAAI,UAAmB;QACrC,MAAM,MAAM,GAAQ,EAAE,CAAC;QAEvB,OAAO,IAAI,EAAE,CAAC;YACZ,MAAM,KAAK,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxC,IAAI,KAAK,KAAK,CAAC;gBAAE,MAAM;YAEvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC/B,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAMM,OAAO,CAAI,WAAoB;QACpC,MAAM,MAAM,GAAsB,EAAE,CAAC;QAErC,OAAO,IAAI,EAAE,CAAC;YACZ,MAAM,KAAK,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxC,IAAI,KAAK,KAAK,CAAC;gBAAE,MAAM;YAEvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC/B,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;gBAC9B,IAAI,GAAG,KAAK,WAAW;oBAAE,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;gBACxD,MAAM,CAAC,GAAG,CAAC,GAAG,WAAW,EAAE,CAAC;YAC9B,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAMM,SAAS,CAAI,aAA6B;QAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC;QAC7D,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC;YAC/C,MAAM,IAAI,KAAK,CAAC,wBAAwB,KAAK,EAAE,CAAC,CAAC;QACnD,CAAC;QAED,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;QACrC,OAAO,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC;IACxB,CAAC;IAMM,QAAQ;QACb,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACxD,CAAC;IAKM,SAAS,CAAC,IAAY;QAC3B,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAMM,UAAU,CAAI,YAA8B;QACjD,MAAM,MAAM,GAAQ,EAAE,CAAC;QACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7C,MAAM,UAAU,GAAG,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;YAGrC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC;QACnC,CAAC;QACD,OAAO,MAAW,CAAC;IACrB,CAAC;IAOO,kBAAkB;QACxB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,IAAI,KAAK,GAAG,CAAC,CAAC;QAEd,OAAO,IAAI,EAAE,CAAC;YACZ,MAAM,IAAI,GAAG,MAAM,CAAC,EAAE,EAAE,CAAC;YACzB,MAAM,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,KAAK,CAAC;YAEjC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;gBAAE,MAAM;YAE/B,KAAK,IAAI,CAAC,CAAC;YACX,IAAI,KAAK,IAAI,EAAE,EAAE,CAAC;gBAChB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;YACzD,CAAC;QACH,CAAC;QAED,OAAO,MAAM,KAAK,CAAC,CAAC;IACtB,CAAC;IAKO,WAAW;QACjB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QACvB,IAAI,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QAEtB,OAAO,IAAI,EAAE,CAAC;YACZ,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;YACjC,MAAM,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC;YAEzC,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC;gBAAE,MAAM;YAE/C,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC;YACnB,IAAI,KAAK,IAAI,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;gBACxB,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;YACtD,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAKO,cAAc,CAAC,KAAa;QAClC,OAAO,CAAC,KAAK,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;IACtC,CAAC;IAKO,cAAc,CAAC,KAAa;QAClC,OAAO,CAAC,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACrD,CAAC;CACF;AA/OD,kCA+OC"}
+{"version":3,"file":"AvroDecoder.js","sourceRoot":"","sources":["../../src/avro/AvroDecoder.ts"],"names":[],"mappings":";;;AAAA,4DAAuD;AAGvD;;;;GAIG;AACH,MAAa,WAAW;IAAxB;QACS,WAAM,GAAG,IAAI,eAAM,EAAE,CAAC;IA8O/B,CAAC;IA5OQ,IAAI,CAAC,KAAiB;QAC3B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IACxB,CAAC;IAEM,MAAM,CAAC,KAAiB;QAC7B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,MAAM,IAAI,KAAK,CAAC,kFAAkF,CAAC,CAAC;IACtG,CAAC;IAED;;OAEG;IACI,QAAQ;QACb,wCAAwC;QACxC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,WAAW;QAChB,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;IAChC,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACzC,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAED;;OAEG;IACI,QAAQ;QACb,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAClC,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAE5C,mEAAmE;QACnE,IAAI,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC;YAC7F,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC;QACzB,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACI,SAAS;QACd,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,gBAAgB;QACtE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC;QACd,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,UAAU;QACf,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,gBAAgB;QACtE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC;QACd,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,SAAS;QACd,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,UAAU;QACf,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACzC,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAED;;;OAGG;IACI,SAAS,CAAI,UAAmB;QACrC,MAAM,MAAM,GAAQ,EAAE,CAAC;QAEvB,OAAO,IAAI,EAAE,CAAC;YACZ,MAAM,KAAK,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxC,IAAI,KAAK,KAAK,CAAC;gBAAE,MAAM,CAAC,sBAAsB;YAE9C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC/B,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACI,OAAO,CAAI,WAAoB;QACpC,MAAM,MAAM,GAAsB,EAAE,CAAC;QAErC,OAAO,IAAI,EAAE,CAAC;YACZ,MAAM,KAAK,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxC,IAAI,KAAK,KAAK,CAAC;gBAAE,MAAM,CAAC,oBAAoB;YAE5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC/B,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;gBAC9B,IAAI,GAAG,KAAK,WAAW;oBAAE,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;gBACxD,MAAM,CAAC,GAAG,CAAC,GAAG,WAAW,EAAE,CAAC;YAC9B,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACI,SAAS,CAAI,aAA6B;QAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC;QAC7D,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC;YAC/C,MAAM,IAAI,KAAK,CAAC,wBAAwB,KAAK,EAAE,CAAC,CAAC;QACnD,CAAC;QAED,MAAM,KAAK,GAAG,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;QACrC,OAAO,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC;IACxD,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,IAAY;QAC3B,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACI,UAAU,CAAI,YAA8B;QACjD,MAAM,MAAM,GAAQ,EAAE,CAAC;QACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7C,MAAM,UAAU,GAAG,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;YACrC,4DAA4D;YAC5D,4DAA4D;YAC5D,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC;QACnC,CAAC;QACD,OAAO,MAAW,CAAC;IACrB,CAAC;IAED,oCAAoC;IAEpC;;OAEG;IACK,kBAAkB;QACxB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,IAAI,KAAK,GAAG,CAAC,CAAC;QAEd,OAAO,IAAI,EAAE,CAAC;YACZ,MAAM,IAAI,GAAG,MAAM,CAAC,EAAE,EAAE,CAAC;YACzB,MAAM,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,KAAK,CAAC;YAEjC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;gBAAE,MAAM;YAE/B,KAAK,IAAI,CAAC,CAAC;YACX,IAAI,KAAK,IAAI,EAAE,EAAE,CAAC;gBAChB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;YACzD,CAAC;QACH,CAAC;QAED,OAAO,MAAM,KAAK,CAAC,CAAC,CAAC,6BAA6B;IACpD,CAAC;IAED;;OAEG;IACK,WAAW;QACjB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QACvB,IAAI,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QAEtB,OAAO,IAAI,EAAE,CAAC;YACZ,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;YACjC,MAAM,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC;YAEzC,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC;gBAAE,MAAM;YAE/C,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC;YACnB,IAAI,KAAK,IAAI,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;gBACxB,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;YACtD,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACK,cAAc,CAAC,KAAa;QAClC,OAAO,CAAC,KAAK,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACK,cAAc,CAAC,KAAa;QAClC,OAAO,CAAC,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACrD,CAAC;CACF;AA/OD,kCA+OC"}

package/lib/avro/AvroEncoder.d.ts

@@ -1,30 +1,101 @@
 import type { IWriter, IWriterGrowable } from '@jsonjoy.com/buffers/lib';
 import type { BinaryJsonEncoder } from '../types';
+/**
+ * Apache Avro binary encoder for basic value encoding.
+ * Implements the Avro binary encoding specification without schema validation.
+ * Based on https://avro.apache.org/docs/1.12.0/specification/
+ */
 export declare class AvroEncoder implements BinaryJsonEncoder {
     readonly writer: IWriter & IWriterGrowable;
     constructor(writer: IWriter & IWriterGrowable);
     encode(value: unknown): Uint8Array;
+    /**
+     * Called when the encoder encounters a value that it does not know how to encode.
+     */
     writeUnknown(value: unknown): void;
     writeAny(value: unknown): void;
+    /**
+     * Writes an Avro null value.
+     */
     writeNull(): void;
+    /**
+     * Writes an Avro boolean value.
+     */
     writeBoolean(bool: boolean): void;
+    /**
+     * Writes an Avro int value using zigzag encoding.
+     */
     writeInt(int: number): void;
+    /**
+     * Writes an Avro long value using zigzag encoding.
+     */
     writeLong(long: number | bigint): void;
+    /**
+     * Writes an Avro float value using IEEE 754 single-precision.
+     */
     writeFloatAvro(float: number): void;
+    /**
+     * Writes an Avro double value using IEEE 754 double-precision.
+     */
     writeDouble(double: number): void;
+    /**
+     * Writes an Avro bytes value with length-prefixed encoding.
+     */
     writeBin(bytes: Uint8Array): void;
+    /**
+     * Writes an Avro string value with UTF-8 encoding and length prefix.
+     */
     writeStr(str: string): void;
+    /**
+     * Writes an Avro array with length-prefixed encoding.
+     */
     writeArr(arr: unknown[]): void;
+    /**
+     * Writes an Avro map with length-prefixed encoding.
+     */
     writeObj(obj: Record<string, unknown>): void;
+    /**
+     * Generic number writing - determines type based on value
+     */
     writeNumber(num: number): void;
+    /**
+     * Writes an integer value
+     */
     writeInteger(int: number): void;
+    /**
+     * Writes an unsigned integer value
+     */
     writeUInteger(uint: number): void;
+    /**
+     * Writes a float value (interface method)
+     */
     writeFloat(float: number): void;
+    /**
+     * Writes a float value using IEEE 754 single-precision.
+     */
     private writeFloatValue;
+    /**
+     * Writes an ASCII string (same as regular string in Avro)
+     */
     writeAsciiStr(str: string): void;
+    /**
+     * Encodes a variable-length integer (for signed values with zigzag)
+     */
     private writeVarIntSigned;
+    /**
+     * Encodes a variable-length integer (for unsigned values like lengths)
+     */
     private writeVarIntUnsigned;
+    /**
+     * Encodes a variable-length long using Avro's encoding
+     */
     private writeVarLong;
+    /**
+     * Encodes a 32-bit integer using zigzag encoding
+     */
     private encodeZigZag32;
+    /**
+     * Encodes a 64-bit integer using zigzag encoding
+     */
     private encodeZigZag64;
 }