@synnaxlabs/client 0.48.0 → 0.49.2

package/src/framer/frame.spec.ts

@@ -544,6 +544,137 @@ describe("framer.Frame", () => {
     });
   });
 
+  describe("forEachUnique", () => {
+    it("should iterate over all unique columns in the frame", () => {
+      const f = new framer.Frame(
+        new Map([
+          [
+            12,
+            [
+              new Series({
+                data: new Float32Array([1, 2, 3]),
+                timeRange: new TimeRange(1, 2),
+              }),
+            ],
+          ],
+          [
+            13,
+            [
+              new Series({
+                data: new Float32Array([4, 5, 6]),
+                timeRange: new TimeRange(4, 6),
+              }),
+            ],
+          ],
+          [
+            14,
+            [
+              new Series({
+                data: new Float32Array([7, 8, 9]),
+                timeRange: new TimeRange(7, 9),
+              }),
+            ],
+          ],
+        ]),
+      );
+      f.push(
+        12,
+        new Series({
+          data: new Float32Array([10, 11, 12]),
+          timeRange: new TimeRange(10, 12),
+        }),
+      );
+      f.push(
+        13,
+        new Series({
+          data: new Float32Array([13, 14, 15]),
+          timeRange: new TimeRange(13, 15),
+        }),
+      );
+      f.push(
+        14,
+        new Series({
+          data: new Float32Array([7, 8, 9]),
+          timeRange: new TimeRange(7, 9),
+        }),
+      );
+      const firstValues = new Set<number>();
+      f.forEachUnique((_, ms) => {
+        firstValues.add(ms.at(0) as number);
+      });
+      expect(firstValues).toEqual(new Set([1, 4, 7]));
+    });
+    it("should get all data from the frame", () => {
+      const f = new framer.Frame(
+        new Map([
+          [
+            12,
+            [
+              new Series({
+                data: new Float32Array([1, 2, 3]),
+                timeRange: new TimeRange(1, 2),
+              }),
+            ],
+          ],
+        ]),
+      );
+      f.push(
+        12,
+        new Series({
+          data: new Float32Array([10, 11, 12]),
+          timeRange: new TimeRange(10, 12),
+        }),
+      );
+      f.push(
+        13,
+        new Series({
+          data: new Float32Array([13, 14, 15]),
+          timeRange: new TimeRange(13, 15),
+        }),
+      );
+      const data: number[] = [];
+      f.forEachUnique((key, ms) => {
+        if (key !== 12) return;
+        for (let i = 0; i < ms.length; i++) data.push(ms.at(i, true) as number);
+      });
+      expect(data).toEqual([1, 2, 3, 10, 11, 12]);
+    });
+    it("should allow use of an index parameter", () => {
+      const f = new framer.Frame(
+        new Map([
+          [
+            12,
+            [
+              new Series({
+                data: new Float32Array([1, 2, 3]),
+                timeRange: new TimeRange(1, 2),
+              }),
+            ],
+          ],
+        ]),
+      );
+      f.push(
+        12,
+        new Series({
+          data: new Float32Array([10, 11, 12]),
+          timeRange: new TimeRange(10, 12),
+        }),
+      );
+      f.push(
+        13,
+        new Series({
+          data: new Float32Array([13, 14, 15]),
+          timeRange: new TimeRange(13, 15),
+        }),
+      );
+      let currentIndex = 0;
+      f.forEachUnique((_, __, i) => {
+        expect(i).toEqual(currentIndex);
+        currentIndex++;
+      });
+      expect(currentIndex).toEqual(2);
+    });
+  });
   describe("mapFilter", () => {
     it("should filter out items based on the keep boolean", () => {
       const f = new framer.Frame(

package/src/framer/frame.ts

@@ -386,6 +386,14 @@ export class Frame {
     });
   }
 
+  /**
+   * Iterates over all unique columns in the frame.
+   * @param fn a function that takes a channel key, multi-series, and index.
+   */
+  forEachUnique(fn: (k: channel.KeyOrName, ms: MultiSeries, i: number) => void): void {
+    this.uniqueColumns.forEach((k, i) => fn(k, this.get(k), i));
+  }
+
   at(index: number, required: true): Record<channel.KeyOrName, TelemValue>;
 
   at(
@@ -457,11 +465,11 @@ export class Frame {
 export const frameZ = z.object({
   keys: z.union([
     z.null().transform<number[]>(() => []),
-    z.number().array().optional().default([]),
+    z.number().array().default([]),
   ]),
   series: z.union([
     z.null().transform<z.infer<typeof Series.crudeZ>[]>(() => []),
-    Series.crudeZ.array().optional().default([]),
+    Series.crudeZ.array().default([]),
   ]),
 });
 

package/src/framer/iterator.ts

@@ -196,9 +196,9 @@ export class Iterator {
   }
 
   /**
-   * @returns true if the iterator value contains a valid segment, and fale otherwise.
-   * valid most commonly returns false when the iterator is exhausted or has
-   * accumulated an error.
+   * @returns true if the iterator value contains a valid segment, and false otherwise.
+   * valid most commonly returns false when the iterator is exhausted or has accumulated
+   * an error.
    */
   async valid(): Promise<boolean> {
     return await this.execute({ command: Command.Valid });