@synnaxlabs/client 0.49.0 → 0.49.2

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

@@ -3,6 +3,7 @@ import { CrudeSeries, CrudeTimeRange, CrudeTimeStamp, MultiSeries } from '@synna
 import { channel } from '../channel';
 import { Frame } from './frame';
 import { Iterator, IteratorConfig } from './iterator';
+import { ReadRequest } from './reader';
 import { Streamer, StreamerConfig } from './streamer';
 import { Writer, WriterConfig } from './writer';
 import { ontology } from '../ontology';
@@ -18,6 +19,7 @@ export declare class Client {
     private readonly streamClient;
     private readonly retriever;
     private readonly deleter;
+    private readonly reader;
     constructor(stream: WebSocketClient, unary: UnaryClient, retriever: channel.Retriever);
     /**
      * Opens a new iterator over the given channels within the provided time range.
@@ -53,6 +55,7 @@ export declare class Client {
     write(start: CrudeTimeStamp, data: Record<channel.KeyOrName, CrudeSeries>): Promise<void>;
     read(tr: CrudeTimeRange, channel: channel.KeyOrName): Promise<MultiSeries>;
     read(tr: CrudeTimeRange, channels: channel.Params): Promise<Frame>;
+    read(request: ReadRequest): Promise<ReadableStream<Uint8Array>>;
     private readFrame;
     readLatest(channel: channel.KeyOrName, n: number): Promise<MultiSeries>;
     readLatest(channels: channel.Params, n: number): Promise<Frame>;

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

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/framer/client.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC/E,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,KAAK,WAAW,EAGjB,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAa,QAAQ,EAAE,KAAK,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAC7E,OAAO,EAAgB,KAAK,QAAQ,EAAE,KAAK,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACrF,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,EAAc,MAAM,iBAAiB,CAAC;AACxE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,eAAO,MAAM,UAAU,2BAA6C,CAAC;AACrE,eAAO,MAAM,gBAAgB;;;;;;CAAiB,CAAC;AAE/C,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAkB;IAC/C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;IAC9C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAU;gBAGhC,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,WAAW,EAClB,SAAS,EAAE,OAAO,CAAC,SAAS;IAO9B;;;;;;;OAOG;IACG,YAAY,CAChB,EAAE,EAAE,cAAc,EAClB,QAAQ,EAAE,OAAO,CAAC,MAAM,EACxB,IAAI,CAAC,EAAE,cAAc,GACpB,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;OAMG;IACG,UAAU,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAIvD;;;;;;;;;;OAUG;IACG,YAAY,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIvD,KAAK,CACT,KAAK,EAAE,cAAc,EACrB,OAAO,EAAE,OAAO,CAAC,SAAS,EAC1B,IAAI,EAAE,WAAW,GAChB,OAAO,CAAC,IAAI,CAAC;IAEV,KAAK,CACT,KAAK,EAAE,cAAc,EACrB,QAAQ,EAAE,OAAO,CAAC,WAAW,EAC7B,IAAI,EAAE,WAAW,EAAE,GAClB,OAAO,CAAC,IAAI,CAAC;IAEV,KAAK,CACT,KAAK,EAAE,cAAc,EACrB,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,WAAW,CAAC,GAC3C,OAAO,CAAC,IAAI,CAAC;IAuCV,IAAI,CAAC,EAAE,EAAE,cAAc,EAAE,OAAO,EAAE,OAAO,CAAC,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC;IAE1E,IAAI,CAAC,EAAE,EAAE,cAAc,EAAE,QAAQ,EAAE,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;YAY1D,SAAS;IAcjB,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAEvE,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;YAYvD,gBAAgB;IAcxB,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,EAAE,SAAS,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAajF"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/framer/client.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC/E,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,KAAK,WAAW,EAGjB,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAa,QAAQ,EAAE,KAAK,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAC7E,OAAO,EAAU,KAAK,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAgB,KAAK,QAAQ,EAAE,KAAK,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACrF,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,EAAc,MAAM,iBAAiB,CAAC;AACxE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,eAAO,MAAM,UAAU,2BAA6C,CAAC;AACrE,eAAO,MAAM,gBAAgB;;;;;;CAAiB,CAAC;AAE/C,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAkB;IAC/C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;IAC9C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAU;IAClC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;gBAG9B,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,WAAW,EAClB,SAAS,EAAE,OAAO,CAAC,SAAS;IAQ9B;;;;;;;OAOG;IACG,YAAY,CAChB,EAAE,EAAE,cAAc,EAClB,QAAQ,EAAE,OAAO,CAAC,MAAM,EACxB,IAAI,CAAC,EAAE,cAAc,GACpB,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;OAMG;IACG,UAAU,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IAIvD;;;;;;;;;;OAUG;IACG,YAAY,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIvD,KAAK,CACT,KAAK,EAAE,cAAc,EACrB,OAAO,EAAE,OAAO,CAAC,SAAS,EAC1B,IAAI,EAAE,WAAW,GAChB,OAAO,CAAC,IAAI,CAAC;IAEV,KAAK,CACT,KAAK,EAAE,cAAc,EACrB,QAAQ,EAAE,OAAO,CAAC,WAAW,EAC7B,IAAI,EAAE,WAAW,EAAE,GAClB,OAAO,CAAC,IAAI,CAAC;IAEV,KAAK,CACT,KAAK,EAAE,cAAc,EACrB,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,WAAW,CAAC,GAC3C,OAAO,CAAC,IAAI,CAAC;IAuCV,IAAI,CAAC,EAAE,EAAE,cAAc,EAAE,OAAO,EAAE,OAAO,CAAC,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC;IAC1E,IAAI,CAAC,EAAE,EAAE,cAAc,EAAE,QAAQ,EAAE,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAClE,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;YAYvD,SAAS;IAcjB,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAEvE,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;YAYvD,gBAAgB;IAcxB,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,EAAE,SAAS,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAOjF"}

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

@@ -0,0 +1,16 @@
+import { WebSocketClient } from '@synnaxlabs/freighter';
+import { CrudeTimeRange } from '@synnaxlabs/x';
+import { channel } from '../channel';
+export interface ReadRequest {
+    channels: channel.Params;
+    timeRange: CrudeTimeRange;
+    channelNames?: Map<channel.KeyOrName, string>;
+    responseType: "csv";
+}
+export declare class Reader {
+    private readonly retriever;
+    private readonly streamClient;
+    constructor(retriever: channel.Retriever, streamClient: WebSocketClient);
+    read(request: ReadRequest): Promise<ReadableStream<Uint8Array>>;
+}
+//# sourceMappingURL=reader.d.ts.map

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

@@ -0,0 +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;AAKzC,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC;IACzB,SAAS,EAAE,cAAc,CAAC;IAC1B,YAAY,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAC9C,YAAY,EAAE,KAAK,CAAC;CACrB;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;CA2BtE"}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=reader.spec.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"reader.spec.d.ts","sourceRoot":"","sources":["../../../src/framer/reader.spec.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@synnaxlabs/client",
-  "version": "0.49.0",
+  "version": "0.49.2",
   "description": "The Synnax Client Library",
   "keywords": [
     "synnax",
@@ -27,7 +27,7 @@
     "async-mutex": "^0.5.0",
     "zod": "^4.1.12",
     "@synnaxlabs/freighter": "^0.49.0",
-    "@synnaxlabs/x": "^0.49.0"
+    "@synnaxlabs/x": "^0.49.2"
   },
   "devDependencies": {
     "@vitest/coverage-v8": "^3.2.4",

package/src/framer/client.ts

@@ -21,6 +21,7 @@ import { channel } from "@/channel";
 import { Deleter } from "@/framer/deleter";
 import { Frame } from "@/framer/frame";
 import { AUTO_SPAN, Iterator, type IteratorConfig } from "@/framer/iterator";
+import { Reader, type ReadRequest } from "@/framer/reader";
 import { openStreamer, type Streamer, type StreamerConfig } from "@/framer/streamer";
 import { Writer, type WriterConfig, WriterMode } from "@/framer/writer";
 import { ontology } from "@/ontology";
@@ -32,6 +33,7 @@ export class Client {
   private readonly streamClient: WebSocketClient;
   private readonly retriever: channel.Retriever;
   private readonly deleter: Deleter;
+  private readonly reader: Reader;
 
   constructor(
     stream: WebSocketClient,
@@ -41,6 +43,7 @@ export class Client {
     this.streamClient = stream;
     this.retriever = retriever;
     this.deleter = new Deleter(unary);
+    this.reader = new Reader(retriever, stream);
   }
 
   /**
@@ -140,15 +143,15 @@ export class Client {
   }
 
   async read(tr: CrudeTimeRange, channel: channel.KeyOrName): Promise<MultiSeries>;
-
   async read(tr: CrudeTimeRange, channels: channel.Params): Promise<Frame>;
-
+  async read(request: ReadRequest): Promise<ReadableStream<Uint8Array>>;
   async read(
-    tr: CrudeTimeRange,
-    channels: channel.Params,
-  ): Promise<MultiSeries | Frame> {
-    const { single } = channel.analyzeParams(channels);
-    const fr = await this.readFrame(tr, channels);
+    tr: CrudeTimeRange | ReadRequest,
+    channels?: channel.Params,
+  ): Promise<MultiSeries | Frame | ReadableStream<Uint8Array>> {
+    if (!("start" in tr)) return this.reader.read(tr);
+    const { single } = channel.analyzeParams(channels!);
+    const fr = await this.readFrame(tr, channels!);
     if (single) return fr.get(channels as channel.KeyOrName);
     return fr;
   }
@@ -199,13 +202,7 @@ export class Client {
     const { normalized, variant } = channel.analyzeParams(channels);
     const bounds = new TimeRange(timeRange);
     if (variant === "keys")
-      return await this.deleter.delete({
-        keys: normalized as channel.Key[],
-        bounds,
-      });
-    return await this.deleter.delete({
-      names: normalized as string[],
-      bounds,
-    });
+      return await this.deleter.delete({ keys: normalized as channel.Key[], bounds });
+    return await this.deleter.delete({ names: normalized as string[], bounds });
   }
 }