@synnaxlabs/client 0.56.1 → 0.57.0

package/dist/src/framer/frame.d.ts

@@ -2,8 +2,10 @@ import { MultiSeries, Series, SeriesDigest, SeriesPayload, Size, TelemValue, Tim
 import { z } from 'zod';
 import { channel } from '../channel';
 type ColumnType = "key" | "name" | null;
+/** A frame's shape without its samples, for logging and debugging. */
 export interface Digest extends Record<channel.Key | channel.Name, SeriesDigest[]> {
 }
+/** Anything {@link Frame}'s constructor accepts. */
 export type CrudeFrame = Frame | CrudePayload | Map<channel.Key | channel.Name, Series[] | Series> | Record<channel.Key | channel.Name, Series[] | Series>;
 /**
  * A frame is a collection of series mapped to a particular channel. Frames
@@ -69,9 +71,7 @@ export declare class Frame {
      * otherwise.
      */
     get uniqueNames(): string[];
-    /**
-     * @returns the unique columns in the frame.
-     */
+    /** @returns the unique columns in the frame. */
     get uniqueColumns(): channel.Key[] | channel.Name[];
     toPayload(): Payload;
     /**
@@ -112,18 +112,9 @@ export declare class Frame {
      * @param keys the channel keys or names.
      */
     get(keys: channel.Key[] | channel.Name[]): Frame;
-    /**
-     * Pushes a set of series for the given channel onto the frame.
-     *
-     * @param key the channel key or name;
-     * @param v the series to push.
-     */
+    /** Pushes a set of series for the given channel onto the frame. */
     push(key: channel.Key | channel.Name, ...v: Series[]): void;
-    /**
-     * Pushes the frame onto the current frame.
-     *
-     * @param frame  - the frame to push.
-     */
+    /** Pushes the frame onto the current frame. */
     push(frame: Frame): void;
     /**
      * @returns a shallow copy of this frame containing all series in the current frame and the
@@ -137,14 +128,12 @@ export declare class Frame {
     has(channel: channel.Key | channel.Name): boolean;
     /**
      * @returns a new frame containing the mapped output of the provided function.
-     * @param fn a function that takes a channel key and series and returns a
-     * boolean.
+     * @param fn a function that takes a channel key and series and returns a boolean.
      */
     map(fn: (k: channel.Key | channel.Name, arr: Series, i: number) => [channel.Key | channel.Name, Series]): Frame;
     mapFilter(fn: (k: channel.Key | channel.Name, arr: Series, i: number) => [channel.Key | channel.Name, Series, boolean]): Frame;
     /**
      * Iterates over all series in the current frame.
-     *
      * @param fn a function that takes a channel key and series.
      */
     forEach(fn: (k: channel.Key | channel.Name, arr: Series, i: number) => void): void;
@@ -172,6 +161,7 @@ export declare class Frame {
     get length(): number;
     toString(): string;
 }
+/** Zod schema for a frame on the wire. */
 export declare const frameZ: z.ZodObject<{
     keys: z.ZodUnion<readonly [z.ZodPipe<z.ZodNull, z.ZodTransform<number[], null>>, z.ZodDefault<z.ZodArray<z.ZodNumber>>]>;
     series: z.ZodUnion<readonly [z.ZodPipe<z.ZodNull, z.ZodTransform<{
@@ -186,17 +176,21 @@ export declare const frameZ: z.ZodObject<{
                 value: z.ZodBigInt;
             }, z.core.$strip>, z.ZodTransform<TimeStamp, {
                 value: bigint;
-            }>>, z.ZodPipe<z.ZodString, z.ZodTransform<TimeStamp, string>>, z.ZodPipe<z.ZodNumber, z.ZodTransform<TimeStamp, number>>, z.ZodPipe<z.ZodBigInt, z.ZodTransform<TimeStamp, bigint>>, z.ZodPipe<z.ZodDate, z.ZodTransform<TimeStamp, Date>>, z.ZodPipe<z.ZodCustom<import('@synnaxlabs/x').TimeSpan, import('@synnaxlabs/x').TimeSpan>, z.ZodTransform<TimeStamp, import('@synnaxlabs/x').TimeSpan>>, z.ZodPipe<z.ZodUnion<readonly [z.ZodTuple<[z.ZodInt], null>, z.ZodTuple<[z.ZodInt, z.ZodInt], null>, z.ZodTuple<[z.ZodInt, z.ZodInt, z.ZodInt], null>]>, z.ZodTransform<TimeStamp, [number, number, number] | [number, number] | [number]>>]>;
+            }>>, z.ZodPipe<z.ZodString, z.ZodTransform<TimeStamp, string>>, z.ZodPipe<z.ZodNumber, z.ZodTransform<TimeStamp, number>>, z.ZodPipe<z.ZodBigInt, z.ZodTransform<TimeStamp, bigint>>, z.ZodPipe<z.ZodDate, z.ZodTransform<TimeStamp, Date>>, z.ZodPipe<z.ZodCustom<import('@synnaxlabs/x').TimeSpan, import('@synnaxlabs/x').TimeSpan>, z.ZodTransform<TimeStamp, import('@synnaxlabs/x').TimeSpan>>, z.ZodPipe<z.ZodUnion<readonly [z.ZodTuple<[z.ZodInt], null>, z.ZodTuple<[z.ZodInt, z.ZodInt], null>, z.ZodTuple<[z.ZodInt, z.ZodInt, z.ZodInt], null>]>, z.ZodTransform<TimeStamp, [number, number] | [number] | [number, number, number]>>]>;
             end: z.ZodUnion<readonly [z.ZodCustom<TimeStamp, TimeStamp>, z.ZodPipe<z.ZodObject<{
                 value: z.ZodBigInt;
             }, z.core.$strip>, z.ZodTransform<TimeStamp, {
                 value: bigint;
-            }>>, z.ZodPipe<z.ZodString, z.ZodTransform<TimeStamp, string>>, z.ZodPipe<z.ZodNumber, z.ZodTransform<TimeStamp, number>>, z.ZodPipe<z.ZodBigInt, z.ZodTransform<TimeStamp, bigint>>, z.ZodPipe<z.ZodDate, z.ZodTransform<TimeStamp, Date>>, z.ZodPipe<z.ZodCustom<import('@synnaxlabs/x').TimeSpan, import('@synnaxlabs/x').TimeSpan>, z.ZodTransform<TimeStamp, import('@synnaxlabs/x').TimeSpan>>, z.ZodPipe<z.ZodUnion<readonly [z.ZodTuple<[z.ZodInt], null>, z.ZodTuple<[z.ZodInt, z.ZodInt], null>, z.ZodTuple<[z.ZodInt, z.ZodInt, z.ZodInt], null>]>, z.ZodTransform<TimeStamp, [number, number, number] | [number, number] | [number]>>]>;
+            }>>, z.ZodPipe<z.ZodString, z.ZodTransform<TimeStamp, string>>, z.ZodPipe<z.ZodNumber, z.ZodTransform<TimeStamp, number>>, z.ZodPipe<z.ZodBigInt, z.ZodTransform<TimeStamp, bigint>>, z.ZodPipe<z.ZodDate, z.ZodTransform<TimeStamp, Date>>, z.ZodPipe<z.ZodCustom<import('@synnaxlabs/x').TimeSpan, import('@synnaxlabs/x').TimeSpan>, z.ZodTransform<TimeStamp, import('@synnaxlabs/x').TimeSpan>>, z.ZodPipe<z.ZodUnion<readonly [z.ZodTuple<[z.ZodInt], null>, z.ZodTuple<[z.ZodInt, z.ZodInt], null>, z.ZodTuple<[z.ZodInt, z.ZodInt, z.ZodInt], null>]>, z.ZodTransform<TimeStamp, [number, number] | [number] | [number, number, number]>>]>;
         }, z.core.$strip>, z.ZodTransform<TimeRange, {
             start: TimeStamp;
             end: TimeStamp;
         }>>, z.ZodCustom<TimeRange, TimeRange>]>>;
-        dataType: z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<import('@synnaxlabs/x').DataType, string>>, z.ZodCustom<import('@synnaxlabs/x').DataType, import('@synnaxlabs/x').DataType>]>;
+        dataType: z.ZodUnion<readonly [z.ZodCustom<import('@synnaxlabs/x').DataType, import('@synnaxlabs/x').DataType>, z.ZodPipe<z.ZodString, z.ZodTransform<import('@synnaxlabs/x').DataType, string>>, z.ZodPipe<z.ZodObject<{
+            value: z.ZodString;
+        }, z.core.$strip>, z.ZodTransform<import('@synnaxlabs/x').DataType, {
+            value: string;
+        }>>]>;
         alignment: z.ZodOptional<z.ZodCoercedBigInt<unknown>>;
         data: z.ZodDefault<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<ArrayBuffer, string>>, z.ZodPipe<z.ZodUnion<readonly [z.ZodNull, z.ZodUndefined]>, z.ZodTransform<ArrayBuffer, null | undefined>>, z.ZodCustom<ArrayBuffer, ArrayBuffer>, z.ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>]>>;
         glBufferUsage: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
@@ -209,7 +203,9 @@ export interface Payload extends z.infer<typeof frameZ> {
 }
 export interface CrudePayload extends z.input<typeof frameZ> {
 }
+/** Rebuilds a {@link Series} from its wire form. */
 export declare const seriesFromPayload: (series: SeriesPayload) => Series;
+/** Reduces a {@link Series} to its wire form. */
 export declare const seriesToPayload: (series: Series) => SeriesPayload;
 export {};
 //# sourceMappingURL=frame.d.ts.map

package/dist/src/framer/frame.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"frame.d.ts","sourceRoot":"","sources":["../../../src/framer/frame.ts"],"names":[],"mappings":"AASA,OAAO,EAEL,WAAW,EACX,MAAM,EACN,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,IAAI,EACJ,KAAK,UAAU,EACf,SAAS,EACT,SAAS,EAEV,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAGzC,KAAK,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;AAExC,MAAM,WAAW,MAAO,SAAQ,MAAM,CAAC,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;CAAG;AA2BrF,MAAM,MAAM,UAAU,GAClB,KAAK,GACL,YAAY,GACZ,GAAG,CAAC,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,GAClD,MAAM,CAAC,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,KAAK;IAChB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAM;IACtD,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,CAAM;gBAG7B,aAAa,GAAE,OAAO,CAAC,eAAe,GAAG,UAAe,EACxD,MAAM,GAAE,MAAM,GAAG,MAAM,EAAO;IAqDhC;;;OAGG;IACH,IAAI,OAAO,IAAI,UAAU,CAIxB;IAED;;;OAGG;IACH,IAAI,IAAI,IAAI,OAAO,CAAC,GAAG,EAAE,CAGxB;IAED;;;OAGG;IACH,IAAI,UAAU,IAAI,OAAO,CAAC,GAAG,EAAE,CAE9B;IAED;;;OAGG;IACH,IAAI,KAAK,IAAI,MAAM,EAAE,CAGpB;IAED;;;OAGG;IACH,IAAI,WAAW,IAAI,MAAM,EAAE,CAE1B;IAED;;OAEG;IACH,IAAI,aAAa,IAAI,OAAO,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAElD;IAED,SAAS,IAAI,OAAO;IAOpB;;;;OAIG;IACH,IAAI,UAAU,IAAI,OAAO,CAExB;IAED;;;;;OAKG;IACH,IAAI,YAAY,IAAI,OAAO,CAE1B;IAED;;;OAGG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED;;;;;OAKG;IACH,IAAI,eAAe,IAAI,OAAO,CAI7B;IAED,SAAS,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,GAAG,SAAS;IAYtD,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,SAAS,CAAC;IAIhD,IAAI,UAAU,IAAI,SAAS,EAAE,CAE5B;IAED;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,GAAG,WAAW;IAEjD;;;OAGG;IACH,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,GAAG,KAAK;IAQhD;;;;;OAKG;IACH,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI;IAE3D;;;;OAIG;IACH,IAAI,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAwBxB;;;OAGG;IACH,MAAM,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK;IAO3B;;;OAGG;IACH,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,GAAG,OAAO;IAMjD;;;;OAIG;IACH,GAAG,CACD,EAAE,EAAE,CACF,CAAC,EAAE,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAC7B,GAAG,EAAE,MAAM,EACX,CAAC,EAAE,MAAM,KACN,CAAC,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,GACxC,KAAK;IAMR,SAAS,CACP,EAAE,EAAE,CACF,CAAC,EAAE,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAC7B,GAAG,EAAE,MAAM,EACX,CAAC,EAAE,MAAM,KACN,CAAC,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,GACjD,KAAK;IASR;;;;OAIG;IACH,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAOlF;;;OAGG;IACH,aAAa,CACX,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC,EAAE,MAAM,KAAK,IAAI,GACtE,IAAI;IAIP,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,UAAU,CAAC;IAEjF,EAAE,CACA,KAAK,EAAE,MAAM,EACb,QAAQ,CAAC,EAAE,KAAK,GACf,MAAM,CAAC,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,UAAU,GAAG,SAAS,CAAC;IAa7D;;;;OAIG;IACH,MAAM,CACJ,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,KAAK,OAAO,GACrE,KAAK;IASR,uDAAuD;IACvD,IAAI,UAAU,IAAI,IAAI,CAErB;IAED;;;OAGG;IACH,IAAI,MAAM,IAAI,MAAM,CAQnB;IAED,yDAAyD;IACzD,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,QAAQ,IAAI,MAAM;CAUnB;AAED,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBASjB,CAAC;AAEH,MAAM,WAAW,OAAQ,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC;CAAG;AAE1D,MAAM,WAAW,YAAa,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC;CAAG;AAE/D,eAAO,MAAM,iBAAiB,GAAI,QAAQ,aAAa,KAAG,MAGzD,CAAC;AAEF,eAAO,MAAM,eAAe,GAAI,QAAQ,MAAM,KAAG,aAK/C,CAAC"}
+{"version":3,"file":"frame.d.ts","sourceRoot":"","sources":["../../../src/framer/frame.ts"],"names":[],"mappings":"AASA,OAAO,EAEL,WAAW,EACX,MAAM,EACN,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,IAAI,EACJ,KAAK,UAAU,EACf,SAAS,EACT,SAAS,EAEV,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAGzC,KAAK,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;AAExC,sEAAsE;AACtE,MAAM,WAAW,MAAO,SAAQ,MAAM,CAAC,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;CAAG;AA2BrF,oDAAoD;AACpD,MAAM,MAAM,UAAU,GAClB,KAAK,GACL,YAAY,GACZ,GAAG,CAAC,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,GAClD,MAAM,CAAC,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,KAAK;IAChB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAM;IACtD,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,CAAM;gBAG7B,aAAa,GAAE,OAAO,CAAC,eAAe,GAAG,UAAe,EACxD,MAAM,GAAE,MAAM,GAAG,MAAM,EAAO;IAmDhC;;;OAGG;IACH,IAAI,OAAO,IAAI,UAAU,CAIxB;IAED;;;OAGG;IACH,IAAI,IAAI,IAAI,OAAO,CAAC,GAAG,EAAE,CAGxB;IAED;;;OAGG;IACH,IAAI,UAAU,IAAI,OAAO,CAAC,GAAG,EAAE,CAE9B;IAED;;;OAGG;IACH,IAAI,KAAK,IAAI,MAAM,EAAE,CAGpB;IAED;;;OAGG;IACH,IAAI,WAAW,IAAI,MAAM,EAAE,CAE1B;IAED,gDAAgD;IAChD,IAAI,aAAa,IAAI,OAAO,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAElD;IAED,SAAS,IAAI,OAAO;IAOpB;;;;OAIG;IACH,IAAI,UAAU,IAAI,OAAO,CAExB;IAED;;;;;OAKG;IACH,IAAI,YAAY,IAAI,OAAO,CAE1B;IAED;;;OAGG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED;;;;;OAKG;IACH,IAAI,eAAe,IAAI,OAAO,CAI7B;IAED,SAAS,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,GAAG,SAAS;IAYtD,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,SAAS,CAAC;IAIhD,IAAI,UAAU,IAAI,SAAS,EAAE,CAE5B;IAED;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,GAAG,WAAW;IAEjD;;;OAGG;IACH,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,GAAG,KAAK;IAQhD,mEAAmE;IACnE,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI;IAE3D,+CAA+C;IAC/C,IAAI,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAwBxB;;;OAGG;IACH,MAAM,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK;IAO3B;;;OAGG;IACH,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,GAAG,OAAO;IAMjD;;;OAGG;IACH,GAAG,CACD,EAAE,EAAE,CACF,CAAC,EAAE,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAC7B,GAAG,EAAE,MAAM,EACX,CAAC,EAAE,MAAM,KACN,CAAC,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,GACxC,KAAK;IAMR,SAAS,CACP,EAAE,EAAE,CACF,CAAC,EAAE,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAC7B,GAAG,EAAE,MAAM,EACX,CAAC,EAAE,MAAM,KACN,CAAC,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,GACjD,KAAK;IASR;;;OAGG;IACH,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAOlF;;;OAGG;IACH,aAAa,CACX,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC,EAAE,MAAM,KAAK,IAAI,GACtE,IAAI;IAIP,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,UAAU,CAAC;IAEjF,EAAE,CACA,KAAK,EAAE,MAAM,EACb,QAAQ,CAAC,EAAE,KAAK,GACf,MAAM,CAAC,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,UAAU,GAAG,SAAS,CAAC;IAa7D;;;;OAIG;IACH,MAAM,CACJ,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,KAAK,OAAO,GACrE,KAAK;IASR,uDAAuD;IACvD,IAAI,UAAU,IAAI,IAAI,CAErB;IAED;;;OAGG;IACH,IAAI,MAAM,IAAI,MAAM,CAQnB;IAED,yDAAyD;IACzD,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,QAAQ,IAAI,MAAM;CAUnB;AAED,0CAA0C;AAC1C,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBASjB,CAAC;AAEH,MAAM,WAAW,OAAQ,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC;CAAG;AAE1D,MAAM,WAAW,YAAa,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC;CAAG;AAE/D,oDAAoD;AACpD,eAAO,MAAM,iBAAiB,GAAI,QAAQ,aAAa,KAAG,MAGzD,CAAC;AAEF,iDAAiD;AACjD,eAAO,MAAM,eAAe,GAAI,QAAQ,MAAM,KAAG,aAK/C,CAAC"}

package/dist/src/framer/hardened.d.ts

@@ -0,0 +1,70 @@
+import { breaker, observe } from '@synnaxlabs/x';
+import { channel } from '../channel';
+import { Frame } from './frame';
+import { Streamer, StreamerConfig, StreamOpener } from './streamer';
+/**
+ * A hardened streamer that automatically reconnects on failure.
+ * This streamer wraps a regular streamer and adds automatic reconnection
+ * logic when the connection is lost or errors occur.
+ */
+export declare class HardenedStreamer implements Streamer {
+    private current;
+    private readonly breaker;
+    private readonly opener;
+    private readonly config;
+    private readonly onReopen?;
+    private readonly onDrop?;
+    private readonly closeNotifier;
+    private readonly stableAfter;
+    private openedAt;
+    private closed;
+    private reconnecting;
+    constructor(opener: StreamOpener, config: StreamerConfig, breakerConfig?: breaker.Config, onReopen?: () => void, onDrop?: (error: Error) => void);
+    /**
+     * Opens a new hardened streamer with the given configuration.
+     * @param breakerConfig - Retry behavior for reconnect attempts. Defaults to retrying
+     * forever on capped, jittered exponential backoff.
+     * @param onReopen - Called after every successful reconnect (not the initial open).
+     * Frames may have been dropped between the failure and the reopen.
+     * @param onDrop - Called when the stream fails and reconnection begins.
+     * @returns A promise that resolves to a new hardened streamer
+     */
+    static open(opener: StreamOpener, config: StreamerConfig, breakerConfig?: breaker.Config, onReopen?: () => void, onDrop?: (error: Error) => void): Promise<HardenedStreamer>;
+    /**
+     * Opens the underlying stream, retrying connectivity failures under the breaker.
+     * Call once after construction; {@link open} does both.
+     * @throws the open failure when it is not retriable or the breaker is exhausted.
+     */
+    start(): Promise<void>;
+    private runStreamer;
+    private get wrapped();
+    private reconnect;
+    update(channels: channel.Params): Promise<void>;
+    next(): Promise<IteratorResult<Frame>>;
+    read(): Promise<Frame>;
+    /** Stops reconnecting and closes the stream. Idempotent; never throws. */
+    close(): void;
+    get keys(): channel.Key[];
+    [Symbol.asyncIterator](): AsyncIterator<Frame>;
+}
+/**
+ * Wraps a standard streamer to implement an observable interface for handling changes
+ * to channel values through an onChange handler.
+ */
+export declare class ObservableStreamer<V = Frame> extends observe.Observer<Frame, V> implements observe.ObservableAsyncCloseable<V> {
+    private readonly streamer;
+    private readonly closePromise;
+    private readonly onDead?;
+    private closeRequested;
+    /**
+     * Creates a new observable streamer.
+     * @param transform - An optional transform function to apply to each frame
+     * @param onDead - Called when the stream ends on a failure the wrapped streamer will
+     * not recover from. No frames follow.
+     */
+    constructor(streamer: Streamer, transform?: observe.Transform<Frame, V>, onDead?: (error: Error) => void);
+    update(channels: channel.Params): Promise<void>;
+    close(): Promise<void>;
+    private stream;
+}
+//# sourceMappingURL=hardened.d.ts.map

package/dist/src/framer/hardened.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hardened.d.ts","sourceRoot":"","sources":["../../../src/framer/hardened.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,OAAO,EAAU,OAAO,EAA6B,MAAM,eAAe,CAAC;AAEpF,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,cAAc,EACnB,KAAK,YAAY,EAClB,MAAM,mBAAmB,CAAC;AAW3B;;;;GAIG;AACH,qBAAa,gBAAiB,YAAW,QAAQ;IAC/C,OAAO,CAAC,OAAO,CAAyB;IACxC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAkB;IAC1C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;IACtC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA2B;IAClD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAa;IACvC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAyB;IACjD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAuB;IAGrD,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAW;IACvC,OAAO,CAAC,QAAQ,CAAmB;IACnC,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,YAAY,CAA8B;gBAGhD,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,cAAc,EACtB,aAAa,GAAE,OAAO,CAAC,MAAW,EAClC,QAAQ,CAAC,EAAE,MAAM,IAAI,EACrB,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI;IA8BjC;;;;;;;;OAQG;WACU,IAAI,CACf,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,cAAc,EACtB,aAAa,CAAC,EAAE,OAAO,CAAC,MAAM,EAC9B,QAAQ,CAAC,EAAE,MAAM,IAAI,EACrB,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAC9B,OAAO,CAAC,gBAAgB,CAAC;IAM5B;;;;OAIG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;YAId,WAAW;IA6CzB,OAAO,KAAK,OAAO,GAGlB;YAIa,SAAS;IAUjB,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAY/C,IAAI,IAAI,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAStC,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC;IAa5B,0EAA0E;IAC1E,KAAK,IAAI,IAAI;IAOb,IAAI,IAAI,IAAI,OAAO,CAAC,GAAG,EAAE,CAExB;IAED,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,KAAK,CAAC;CAG/C;AAED;;;GAGG;AACH,qBAAa,kBAAkB,CAAC,CAAC,GAAG,KAAK,CACvC,SAAQ,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CACjC,YAAW,OAAO,CAAC,wBAAwB,CAAC,CAAC,CAAC;IAE9C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAW;IACpC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAgB;IAC7C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAyB;IACjD,OAAO,CAAC,cAAc,CAAS;IAE/B;;;;;OAKG;gBAED,QAAQ,EAAE,QAAQ,EAClB,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC,EACvC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI;IAS3B,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/C,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;YAMd,MAAM;CASrB"}

package/dist/src/framer/iterator.d.ts

@@ -2,8 +2,10 @@ import { WebSocketClient } from '@synnaxlabs/freighter';
 import { CrudeTimeRange, CrudeTimeSpan, CrudeTimeStamp, TimeRange, TimeSpan, TimeStamp } from '@synnaxlabs/x';
 import { z } from 'zod';
 import { channel } from '../channel';
+import { ChannelRetriever } from './adapter';
 import { Frame } from './frame';
 import { IteratorCommand, IteratorResponseVariant } from './types.gen';
+/** Span that makes an iterator step by its chunk size instead of a fixed duration. */
 export declare const AUTO_SPAN: TimeSpan;
 export declare const iteratorReqZ: z.ZodObject<{
     command: z.ZodEnum<typeof IteratorCommand>;
@@ -17,12 +19,12 @@ export declare const iteratorReqZ: z.ZodObject<{
             value: z.ZodBigInt;
         }, z.core.$strip>, z.ZodTransform<TimeStamp, {
             value: bigint;
-        }>>, z.ZodPipe<z.ZodString, z.ZodTransform<TimeStamp, string>>, z.ZodPipe<z.ZodNumber, z.ZodTransform<TimeStamp, number>>, z.ZodPipe<z.ZodBigInt, z.ZodTransform<TimeStamp, bigint>>, z.ZodPipe<z.ZodDate, z.ZodTransform<TimeStamp, Date>>, z.ZodPipe<z.ZodCustom<TimeSpan, TimeSpan>, z.ZodTransform<TimeStamp, TimeSpan>>, z.ZodPipe<z.ZodUnion<readonly [z.ZodTuple<[z.ZodInt], null>, z.ZodTuple<[z.ZodInt, z.ZodInt], null>, z.ZodTuple<[z.ZodInt, z.ZodInt, z.ZodInt], null>]>, z.ZodTransform<TimeStamp, [number, number, number] | [number, number] | [number]>>]>;
+        }>>, z.ZodPipe<z.ZodString, z.ZodTransform<TimeStamp, string>>, z.ZodPipe<z.ZodNumber, z.ZodTransform<TimeStamp, number>>, z.ZodPipe<z.ZodBigInt, z.ZodTransform<TimeStamp, bigint>>, z.ZodPipe<z.ZodDate, z.ZodTransform<TimeStamp, Date>>, z.ZodPipe<z.ZodCustom<TimeSpan, TimeSpan>, z.ZodTransform<TimeStamp, TimeSpan>>, z.ZodPipe<z.ZodUnion<readonly [z.ZodTuple<[z.ZodInt], null>, z.ZodTuple<[z.ZodInt, z.ZodInt], null>, z.ZodTuple<[z.ZodInt, z.ZodInt, z.ZodInt], null>]>, z.ZodTransform<TimeStamp, [number, number] | [number] | [number, number, number]>>]>;
         end: z.ZodUnion<readonly [z.ZodCustom<TimeStamp, TimeStamp>, z.ZodPipe<z.ZodObject<{
             value: z.ZodBigInt;
         }, z.core.$strip>, z.ZodTransform<TimeStamp, {
             value: bigint;
-        }>>, z.ZodPipe<z.ZodString, z.ZodTransform<TimeStamp, string>>, z.ZodPipe<z.ZodNumber, z.ZodTransform<TimeStamp, number>>, z.ZodPipe<z.ZodBigInt, z.ZodTransform<TimeStamp, bigint>>, z.ZodPipe<z.ZodDate, z.ZodTransform<TimeStamp, Date>>, z.ZodPipe<z.ZodCustom<TimeSpan, TimeSpan>, z.ZodTransform<TimeStamp, TimeSpan>>, z.ZodPipe<z.ZodUnion<readonly [z.ZodTuple<[z.ZodInt], null>, z.ZodTuple<[z.ZodInt, z.ZodInt], null>, z.ZodTuple<[z.ZodInt, z.ZodInt, z.ZodInt], null>]>, z.ZodTransform<TimeStamp, [number, number, number] | [number, number] | [number]>>]>;
+        }>>, z.ZodPipe<z.ZodString, z.ZodTransform<TimeStamp, string>>, z.ZodPipe<z.ZodNumber, z.ZodTransform<TimeStamp, number>>, z.ZodPipe<z.ZodBigInt, z.ZodTransform<TimeStamp, bigint>>, z.ZodPipe<z.ZodDate, z.ZodTransform<TimeStamp, Date>>, z.ZodPipe<z.ZodCustom<TimeSpan, TimeSpan>, z.ZodTransform<TimeStamp, TimeSpan>>, z.ZodPipe<z.ZodUnion<readonly [z.ZodTuple<[z.ZodInt], null>, z.ZodTuple<[z.ZodInt, z.ZodInt], null>, z.ZodTuple<[z.ZodInt, z.ZodInt, z.ZodInt], null>]>, z.ZodTransform<TimeStamp, [number, number] | [number] | [number, number, number]>>]>;
     }, z.core.$strip>, z.ZodTransform<TimeRange, {
         start: TimeStamp;
         end: TimeStamp;
@@ -62,17 +64,21 @@ export declare const iteratorResZ: z.ZodObject<{
                     value: z.ZodBigInt;
                 }, z.core.$strip>, z.ZodTransform<TimeStamp, {
                     value: bigint;
-                }>>, z.ZodPipe<z.ZodString, z.ZodTransform<TimeStamp, string>>, z.ZodPipe<z.ZodNumber, z.ZodTransform<TimeStamp, number>>, z.ZodPipe<z.ZodBigInt, z.ZodTransform<TimeStamp, bigint>>, z.ZodPipe<z.ZodDate, z.ZodTransform<TimeStamp, Date>>, z.ZodPipe<z.ZodCustom<TimeSpan, TimeSpan>, z.ZodTransform<TimeStamp, TimeSpan>>, z.ZodPipe<z.ZodUnion<readonly [z.ZodTuple<[z.ZodInt], null>, z.ZodTuple<[z.ZodInt, z.ZodInt], null>, z.ZodTuple<[z.ZodInt, z.ZodInt, z.ZodInt], null>]>, z.ZodTransform<TimeStamp, [number, number, number] | [number, number] | [number]>>]>;
+                }>>, z.ZodPipe<z.ZodString, z.ZodTransform<TimeStamp, string>>, z.ZodPipe<z.ZodNumber, z.ZodTransform<TimeStamp, number>>, z.ZodPipe<z.ZodBigInt, z.ZodTransform<TimeStamp, bigint>>, z.ZodPipe<z.ZodDate, z.ZodTransform<TimeStamp, Date>>, z.ZodPipe<z.ZodCustom<TimeSpan, TimeSpan>, z.ZodTransform<TimeStamp, TimeSpan>>, z.ZodPipe<z.ZodUnion<readonly [z.ZodTuple<[z.ZodInt], null>, z.ZodTuple<[z.ZodInt, z.ZodInt], null>, z.ZodTuple<[z.ZodInt, z.ZodInt, z.ZodInt], null>]>, z.ZodTransform<TimeStamp, [number, number] | [number] | [number, number, number]>>]>;
                 end: z.ZodUnion<readonly [z.ZodCustom<TimeStamp, TimeStamp>, z.ZodPipe<z.ZodObject<{
                     value: z.ZodBigInt;
                 }, z.core.$strip>, z.ZodTransform<TimeStamp, {
                     value: bigint;
-                }>>, z.ZodPipe<z.ZodString, z.ZodTransform<TimeStamp, string>>, z.ZodPipe<z.ZodNumber, z.ZodTransform<TimeStamp, number>>, z.ZodPipe<z.ZodBigInt, z.ZodTransform<TimeStamp, bigint>>, z.ZodPipe<z.ZodDate, z.ZodTransform<TimeStamp, Date>>, z.ZodPipe<z.ZodCustom<TimeSpan, TimeSpan>, z.ZodTransform<TimeStamp, TimeSpan>>, z.ZodPipe<z.ZodUnion<readonly [z.ZodTuple<[z.ZodInt], null>, z.ZodTuple<[z.ZodInt, z.ZodInt], null>, z.ZodTuple<[z.ZodInt, z.ZodInt, z.ZodInt], null>]>, z.ZodTransform<TimeStamp, [number, number, number] | [number, number] | [number]>>]>;
+                }>>, z.ZodPipe<z.ZodString, z.ZodTransform<TimeStamp, string>>, z.ZodPipe<z.ZodNumber, z.ZodTransform<TimeStamp, number>>, z.ZodPipe<z.ZodBigInt, z.ZodTransform<TimeStamp, bigint>>, z.ZodPipe<z.ZodDate, z.ZodTransform<TimeStamp, Date>>, z.ZodPipe<z.ZodCustom<TimeSpan, TimeSpan>, z.ZodTransform<TimeStamp, TimeSpan>>, z.ZodPipe<z.ZodUnion<readonly [z.ZodTuple<[z.ZodInt], null>, z.ZodTuple<[z.ZodInt, z.ZodInt], null>, z.ZodTuple<[z.ZodInt, z.ZodInt, z.ZodInt], null>]>, z.ZodTransform<TimeStamp, [number, number] | [number] | [number, number, number]>>]>;
             }, z.core.$strip>, z.ZodTransform<TimeRange, {
                 start: TimeStamp;
                 end: TimeStamp;
             }>>, z.ZodCustom<TimeRange, TimeRange>]>>;
-            dataType: z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<import('@synnaxlabs/x').DataType, string>>, z.ZodCustom<import('@synnaxlabs/x').DataType, import('@synnaxlabs/x').DataType>]>;
+            dataType: z.ZodUnion<readonly [z.ZodCustom<import('@synnaxlabs/x').DataType, import('@synnaxlabs/x').DataType>, z.ZodPipe<z.ZodString, z.ZodTransform<import('@synnaxlabs/x').DataType, string>>, z.ZodPipe<z.ZodObject<{
+                value: z.ZodString;
+            }, z.core.$strip>, z.ZodTransform<import('@synnaxlabs/x').DataType, {
+                value: string;
+            }>>]>;
             alignment: z.ZodOptional<z.ZodCoercedBigInt<unknown>>;
             data: z.ZodDefault<z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<ArrayBuffer, string>>, z.ZodPipe<z.ZodUnion<readonly [z.ZodNull, z.ZodUndefined]>, z.ZodTransform<ArrayBuffer, null | undefined>>, z.ZodCustom<ArrayBuffer, ArrayBuffer>, z.ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>]>>;
             glBufferUsage: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
@@ -84,6 +90,7 @@ export declare const iteratorResZ: z.ZodObject<{
 }, z.core.$strip>;
 export interface IteratorResponse extends z.infer<typeof iteratorResZ> {
 }
+/** Config for an iterator. Pass it to `client.telem.openIterator`. */
 export interface IteratorConfig {
     /** chunkSize is the maximum number of samples contained per channel in the frame
      * resulting from a call to next with {@link AUTO_SPAN}.
@@ -96,12 +103,9 @@ export interface IteratorConfig {
     downsampleFactor?: number;
 }
 /**
- * Used to iterate over a clusters telemetry in time-order. It should not be
- * instantiated directly, and should instead be instantiated via the SegmentClient.
- *
- * Using an iterator is ideal when querying/processing large ranges of data, but
- * is relatively complex and difficult to use. If you're looking to retrieve
- *  telemetry between two timestamps, see the SegmentClient.read method.
+ * Iterates over a cluster's telemetry in time order. Open one through the segment
+ * client, never directly. Suited to large ranges; to read between two timestamps, use
+ * the segment client's read method instead.
  */
 export declare class Iterator {
     private readonly stream;
@@ -109,46 +113,37 @@ export declare class Iterator {
     value: Frame;
     private constructor();
     /**
-     * Opens the iterator, configuring it to iterate over the telemetry in the
-     * channels with the given keys within the provided time range.
-     *
-     * @param tr - The time range to iterate over.
-     * @param channels - The channels for the iterator to iterate over (can be provided
-     * in keys or names).
-     * @param retriever - Retriever used to retrieve channel keys from names.
+     * Opens the iterator, configuring it to iterate over the telemetry in the channels
+     * with the given keys within the provided time range.
+     * @param retrieveChannels - Resolves channel names to keys and data types.
      * @param client - The stream client allowing streaming of iterated data.
      * @param opts - See {@link IteratorConfig}.
      */
-    static _open(tr: CrudeTimeRange, channels: channel.Params, retriever: channel.Retriever, client: WebSocketClient, opts?: IteratorConfig): Promise<Iterator>;
+    static _open(tr: CrudeTimeRange, channels: channel.Params, retrieveChannels: ChannelRetriever, client: WebSocketClient, opts?: IteratorConfig): Promise<Iterator>;
     /**
      * Reads the next time span of telemetry for each channel in the iterator.
-     *
-     * @param span - The time span to read. A negative span is equivalent
-     * to calling prev with the absolute value of the span. If the span is
-     * AUTO_SPAN, the iterator will automatically determine the span to read.
-     * This is useful for iterating over an entire range efficiently.
-     *
-     * @returns false if a segment satisfying the request can't be found for a
-     * particular channel or the iterator has accumulated an error.
+     * @param span - The time span to read. A negative span is equivalent to calling prev
+     * with the absolute value of the span. If the span is AUTO_SPAN, the iterator will
+     * automatically determine the span to read. This is useful for iterating over an
+     * entire range efficiently.
+     * @returns false if a segment satisfying the request can't be found for a particular
+     * channel or the iterator has accumulated an error.
      */
     next(span?: CrudeTimeSpan): Promise<boolean>;
     /**
      * Reads the previous time span of telemetry for each channel in the iterator.
-     *
-     * @param span - The time span to read. A negative span is equivalent
-     * to calling next with the absolute value of the span. If the span is
-     * AUTO_SPAN, the iterator will automatically determine the span to read.
-     * This is useful for iterating over an entire range efficiently.
-     *
+     * @param span - The time span to read. A negative span is equivalent to calling next
+     * with the absolute value of the span. If the span is AUTO_SPAN, the iterator will
+     * automatically determine the span to read. This is useful for iterating over an
+     * entire range efficiently.
      * @returns false if a segment satisfying the request can't be found for a particular
      * channel or the iterator has accumulated an error.
      */
     prev(span?: CrudeTimeSpan): Promise<boolean>;
     /**
-     * Seeks the iterator to the first segment in the time range, but does not read
-     * it. Also invalidates the iterator. The iterator will not be considered valid
-     * until a call to next or prev.
-     *
+     * Seeks the iterator to the first segment in the time range, but does not read it.
+     * Also invalidates the iterator. The iterator will not be considered valid until a
+     * call to next or prev.
      * @returns false if the iterator is not pointing to a valid segment for a particular
      * channel or has accumulated an error.
      */
@@ -162,19 +157,17 @@ export declare class Iterator {
      */
     seekLast(): Promise<boolean>;
     /**
-     * Seeks the iterator to the first segment whose start is less than or equal to
-     * the provided timestamp. Also invalidates the iterator. The iterator will not be
+     * Seeks the iterator to the first segment whose start is less than or equal to the
+     * provided timestamp. Also invalidates the iterator. The iterator will not be
      * considered valid until a call to next or prev.
-     *
      * @returns false if the iterator is not pointing to a valid segment for a particular
      * channel or has accumulated an error.
      */
     seekLE(stamp: CrudeTimeStamp): Promise<boolean>;
     /**
-     * Seeks the iterator to the first segment whose start is greater than or equal to
-     * the provided timestamp. Also invalidates the iterator. The iterator will not be
+     * Seeks the iterator to the first segment whose start is greater than or equal to the
+     * provided timestamp. Also invalidates the iterator. The iterator will not be
      * considered valid until a call to next or prev.
-     *
      * @returns false if the iterator is not pointing to a valid segment for a particular
      * channel or has accumulated an error.
      */

package/dist/src/framer/iterator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"iterator.d.ts","sourceRoot":"","sources":["../../../src/framer/iterator.ts"],"names":[],"mappings":"AASA,OAAO,EAAe,KAAK,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC1E,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,cAAc,EAEnB,SAAS,EACT,QAAQ,EACR,SAAS,EACV,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAGpC,OAAO,EAAE,KAAK,EAAU,MAAM,gBAAgB,CAAC;AAE/C,OAAO,EAAE,eAAe,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAE9E,eAAO,MAAM,SAAS,UAAmB,CAAC;AAE1C,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAQvB,CAAC;AAEH,MAAM,WAAW,eAAgB,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC;CAAG;AAExE,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAMvB,CAAC;AAEH,MAAM,WAAW,gBAAiB,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC;CAAG;AAEzE,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;;;GAOG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAwD;IAC/E,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAc;IACtC,KAAK,EAAE,KAAK,CAAC;IAEb,OAAO;IASP;;;;;;;;;;OAUG;WACU,KAAK,CAChB,EAAE,EAAE,cAAc,EAClB,QAAQ,EAAE,OAAO,CAAC,MAAM,EACxB,SAAS,EAAE,OAAO,CAAC,SAAS,EAC5B,MAAM,EAAE,eAAe,EACvB,IAAI,GAAE,cAAmB,GACxB,OAAO,CAAC,QAAQ,CAAC;IAepB;;;;;;;;;;OAUG;IACG,IAAI,CAAC,IAAI,GAAE,aAAyB,GAAG,OAAO,CAAC,OAAO,CAAC;IAO7D;;;;;;;;;;OAUG;IACG,IAAI,CAAC,IAAI,GAAE,aAAyB,GAAG,OAAO,CAAC,OAAO,CAAC;IAO7D;;;;;;;OAOG;IACG,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC;IAInC;;;;;;OAMG;IACG,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC;IAIlC;;;;;;;OAOG;IACG,MAAM,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAOrD;;;;;;;OAOG;IACG,MAAM,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAOrD;;;;OAIG;IACG,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC;IAI/B;;;;OAIG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,CAAC;YAIhD,OAAO;CAStB"}
+{"version":3,"file":"iterator.d.ts","sourceRoot":"","sources":["../../../src/framer/iterator.ts"],"names":[],"mappings":"AASA,OAAO,EAAe,KAAK,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC1E,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,cAAc,EAEnB,SAAS,EACT,QAAQ,EACR,SAAS,EACV,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC,OAAO,EAAE,KAAK,gBAAgB,EAAe,MAAM,kBAAkB,CAAC;AAEtE,OAAO,EAAE,KAAK,EAAU,MAAM,gBAAgB,CAAC;AAE/C,OAAO,EAAE,eAAe,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAE9E,sFAAsF;AACtF,eAAO,MAAM,SAAS,UAAmB,CAAC;AAE1C,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAQvB,CAAC;AAEH,MAAM,WAAW,eAAgB,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC;CAAG;AAExE,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAMvB,CAAC;AAEH,MAAM,WAAW,gBAAiB,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC;CAAG;AAEzE,sEAAsE;AACtE,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;;GAIG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAwD;IAC/E,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAc;IACtC,KAAK,EAAE,KAAK,CAAC;IAEb,OAAO;IASP;;;;;;OAMG;WACU,KAAK,CAChB,EAAE,EAAE,cAAc,EAClB,QAAQ,EAAE,OAAO,CAAC,MAAM,EACxB,gBAAgB,EAAE,gBAAgB,EAClC,MAAM,EAAE,eAAe,EACvB,IAAI,GAAE,cAAmB,GACxB,OAAO,CAAC,QAAQ,CAAC;IAepB;;;;;;;;OAQG;IACG,IAAI,CAAC,IAAI,GAAE,aAAyB,GAAG,OAAO,CAAC,OAAO,CAAC;IAO7D;;;;;;;;OAQG;IACG,IAAI,CAAC,IAAI,GAAE,aAAyB,GAAG,OAAO,CAAC,OAAO,CAAC;IAO7D;;;;;;OAMG;IACG,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC;IAInC;;;;;;OAMG;IACG,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC;IAIlC;;;;;;OAMG;IACG,MAAM,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAOrD;;;;;;OAMG;IACG,MAAM,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAOrD;;;;OAIG;IACG,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC;IAI/B;;;;OAIG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,CAAC;YAIhD,OAAO;CAStB"}

package/dist/src/framer/reader.d.ts

@@ -1,6 +1,7 @@
 import { WebSocketClient } from '@synnaxlabs/freighter';
 import { CrudeTimeRange } from '@synnaxlabs/x';
 import { channel } from '../channel';
+import { ChannelRetriever } from './adapter';
 import { IteratorConfig } from './iterator';
 export interface ReadRequest {
     channels: channel.Params;
@@ -10,9 +11,9 @@ export interface ReadRequest {
     iteratorConfig?: IteratorConfig;
 }
 export declare class Reader {
-    private readonly retriever;
+    private readonly retrieveChannels;
     private readonly streamClient;
-    constructor(retriever: channel.Retriever, streamClient: WebSocketClient);
+    constructor(retrieveChannels: ChannelRetriever, streamClient: WebSocketClient);
     read(request: ReadRequest): Promise<ReadableStream<Uint8Array>>;
 }
 //# sourceMappingURL=reader.d.ts.map

package/dist/src/framer/reader.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reader.d.ts","sourceRoot":"","sources":["../../../src/framer/reader.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,KAAK,cAAc,EAAgB,MAAM,eAAe,CAAC;AAElE,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAGzC,OAAO,EAAY,KAAK,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAElE,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC;IACzB,SAAS,EAAE,cAAc,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC1D,YAAY,EAAE,KAAK,CAAC;IACpB,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC;AAED,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;IAC9C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAkB;gBAEnC,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,YAAY,EAAE,eAAe;IAKjE,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;CAiCtE"}
+{"version":3,"file":"reader.d.ts","sourceRoot":"","sources":["../../../src/framer/reader.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,KAAK,cAAc,EAAgB,MAAM,eAAe,CAAC;AAElE,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEzD,OAAO,EAAY,KAAK,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAElE,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC;IACzB,SAAS,EAAE,cAAc,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC1D,YAAY,EAAE,KAAK,CAAC;IACpB,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC;AAED,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAmB;IACpD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAkB;gBAEnC,gBAAgB,EAAE,gBAAgB,EAAE,YAAY,EAAE,eAAe;IAKvE,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;CAiCtE"}