@synnaxlabs/client 0.37.0 → 0.38.1

package/src/framer/adapter.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/framer/adapter.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/framer/client.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/framer/client.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/framer/deleter.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/framer/deleter.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/framer/external.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/framer/frame.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/framer/frame.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -7,6 +7,7 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
+import { toArray, unique } from "@synnaxlabs/x";
 import {
   MultiSeries,
   Series,
@@ -17,8 +18,6 @@ import {
   TimeRange,
   TimeStamp,
 } from "@synnaxlabs/x/telem";
-import { toArray } from "@synnaxlabs/x/toArray";
-import { unique } from "@synnaxlabs/x/unique";
 import { z } from "zod";
 
 import {
@@ -177,7 +176,7 @@ export class Frame {
    * error otherwise.
    */
   get uniqueKeys(): Keys {
-    return unique(this.keys);
+    return unique.unique(this.keys);
   }
 
   /**
@@ -194,7 +193,7 @@ export class Frame {
    * otherwise.
    */
   get uniqueNames(): Names {
-    return unique(this.names);
+    return unique.unique(this.names);
   }
 
   /**

package/src/framer/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/framer/iterator.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/framer/iterator.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/framer/streamProxy.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -35,7 +35,7 @@ export class StreamProxy<RQ extends z.ZodTypeAny, RS extends z.ZodTypeAny> {
       const [res, err] = await this.stream.receive();
       if (res != null)
         console.warn(
-          `${this.name} received unexpected response on closure. 
+          `${this.name} received unexpected response on closure.
         Please report this error to the Synnax team. ${JSON.stringify(res)}`,
         );
       if (err != null) {

package/src/framer/streamer.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -108,3 +108,181 @@ describe("Streamer", () => {
     expect(Array.from(d.get(ch.key))).toEqual([1]);
   });
 });
+
+describe("Streamer - Calculated Channels", () => {
+  test("basic calculated channel streaming", async () => {
+    // Create a timestamp index channel
+    const timeChannel = await client.channels.create({
+      name: "calc_test_time",
+      isIndex: true,
+      dataType: DataType.TIMESTAMP,
+    });
+
+    // Create source channels with the timestamp index
+    const [channelA, channelB] = await client.channels.create([
+      {
+        name: "test_a",
+        dataType: DataType.FLOAT64,
+        index: timeChannel.key,
+      },
+      {
+        name: "test_b",
+        dataType: DataType.FLOAT64,
+        index: timeChannel.key,
+      },
+    ]);
+
+    // Create calculated channel that adds the two source channels
+    const calcChannel = await client.channels.create({
+      name: "test_calc",
+      dataType: DataType.FLOAT64,
+      index: timeChannel.key,
+      virtual: true,
+      expression: "return test_a + test_b",
+      requires: [channelA.key, channelB.key],
+    });
+
+    // Set up streamer to listen for calculated results
+    const streamer = await client.openStreamer(calcChannel.key);
+
+    // Give streamer time to initialize
+    await new Promise((resolve) => setTimeout(resolve, 100));
+
+    // Write test data
+    const startTime = TimeStamp.now();
+    const writer = await client.openWriter({
+      start: startTime,
+      channels: [timeChannel.key, channelA.key, channelB.key],
+    });
+
+    try {
+      // Write test values - each source gets 2.5 so sum should be 5.0
+      await writer.write({
+        [timeChannel.key]: [startTime],
+        [channelA.key]: new Float64Array([2.5]),
+        [channelB.key]: new Float64Array([2.5]),
+      });
+
+      // Read from streamer
+      const frame = await streamer.read();
+
+      // Verify calculated results
+      const calcData = Array.from(frame.get(calcChannel.key));
+      expect(calcData).toEqual([5.0]);
+    } finally {
+      await writer.close();
+      streamer.close();
+    }
+  });
+  test("calculated channel with constant", async () => {
+    // Create an index channel for timestamps
+    const timeChannel = await client.channels.create({
+      name: "calc_const_time",
+      isIndex: true,
+      dataType: DataType.TIMESTAMP,
+    });
+
+    // Create base channel with index
+    const baseChannel = await client.channels.create({
+      name: "base_channel",
+      dataType: DataType.FLOAT64,
+      index: timeChannel.key,
+    });
+
+    // Create calculated channel that adds 5
+    const calcChannel = await client.channels.create({
+      name: "calc_const_channel",
+      dataType: DataType.FLOAT64,
+      index: timeChannel.key,
+      virtual: true,
+      expression: `return ${baseChannel.name} + 5`,
+      requires: [baseChannel.key],
+    });
+
+    const streamer = await client.openStreamer(calcChannel.key);
+    await new Promise((resolve) => setTimeout(resolve, 100));
+
+    const startTime = TimeStamp.now();
+    const writer = await client.openWriter({
+      start: startTime,
+      channels: [timeChannel.key, baseChannel.key],
+    });
+
+    try {
+      const timestamps = [
+        startTime,
+        new TimeStamp(startTime.valueOf() + BigInt(1000000000)),
+        new TimeStamp(startTime.valueOf() + BigInt(2000000000)),
+      ];
+
+      await writer.write({
+        [timeChannel.key]: timestamps,
+        [baseChannel.key]: new Float64Array([1, 2, 3]),
+      });
+
+      const frame = await streamer.read();
+      const calcData = Array.from(frame.get(calcChannel.key));
+      expect(calcData).toEqual([6, 7, 8]); // Original values + 5
+    } finally {
+      await writer.close();
+      streamer.close();
+    }
+  });
+
+  test("calculated channel with multiple operations", async () => {
+    // Create timestamp channel
+    const timeChannel = await client.channels.create({
+      name: "calc_multi_time",
+      isIndex: true,
+      dataType: DataType.TIMESTAMP,
+    });
+
+    // Create source channels
+    const [channelA, channelB] = await client.channels.create([
+      {
+        name: "multi_test_a",
+        dataType: DataType.FLOAT64,
+        index: timeChannel.key,
+      },
+      {
+        name: "multi_test_b",
+        dataType: DataType.FLOAT64,
+        index: timeChannel.key,
+      },
+    ]);
+
+    // Create calculated channel with multiple operations
+    const calcChannel = await client.channels.create({
+      name: "multi_calc",
+      dataType: DataType.FLOAT64,
+      index: timeChannel.key,
+      virtual: true,
+      expression: "return (multi_test_a * 2) + (multi_test_b / 2)",
+      requires: [channelA.key, channelB.key],
+    });
+
+    const streamer = await client.openStreamer(calcChannel.key);
+    await new Promise((resolve) => setTimeout(resolve, 100));
+
+    const startTime = TimeStamp.now();
+    const writer = await client.openWriter({
+      start: startTime,
+      channels: [timeChannel.key, channelA.key, channelB.key],
+    });
+
+    try {
+      await writer.write({
+        [timeChannel.key]: [startTime],
+        [channelA.key]: new Float64Array([2.0]), // Will be multiplied by 2 = 4.0
+        [channelB.key]: new Float64Array([4.0]), // Will be divided by 2 = 2.0
+      });
+
+      const frame = await streamer.read();
+      const calcData = Array.from(frame.get(calcChannel.key));
+      expect(calcData).toEqual([6.0]); // (2.0 * 2) + (4.0 / 2) = 4.0 + 2.0 = 6.0
+    } finally {
+      await writer.close();
+      streamer.close();
+    }
+  });
+});

package/src/framer/streamer.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/framer/writer.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/framer/writer.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/hardware/client.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/hardware/device/client.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/hardware/device/device.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/hardware/device/external.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/hardware/device/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/hardware/device/payload.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/hardware/external.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/hardware/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/hardware/rack/client.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/hardware/rack/external.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/hardware/rack/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/hardware/rack/payload.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/hardware/rack/rack.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/hardware/task/client.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -24,6 +24,7 @@ import {
   commandZ,
   type NewTask,
   newTaskZ,
+  ontologyID as payloadOntologyID,
   type Payload,
   type State,
   type StateObservable,
@@ -32,7 +33,7 @@ import {
   taskKeyZ,
   taskZ,
 } from "@/hardware/task/payload";
-import { ontology } from "@/ontology";
+import { type ontology } from "@/ontology";
 import { type ranger } from "@/ranger";
 import { signals } from "@/signals";
 import { analyzeParams, checkForMultipleOrNoResults } from "@/util/retrieve";
@@ -95,7 +96,7 @@ export class Task<
   }
 
   get ontologyID(): ontology.ID {
-    return new ontology.ID({ type: "task", key: this.key });
+    return payloadOntologyID(this.key);
   }
 
   async executeCommand(type: string, args?: UnknownRecord): Promise<string> {

package/src/hardware/task/external.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/hardware/task/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/hardware/task/payload.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/hardware/task/task.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -10,7 +10,7 @@
 export { access } from "@/access";
 export { policy } from "@/access/policy";
 export { channel } from "@/channel";
-export { Channel } from "@/channel/client";
+export { Channel, isCalculated } from "@/channel/client";
 export { default as Synnax, type SynnaxProps, synnaxPropsZ } from "@/client";
 export * from "@/connection";
 export { control } from "@/control";

package/src/label/client.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -12,7 +12,7 @@ import { observe } from "@synnaxlabs/x";
 import { type AsyncTermSearcher } from "@synnaxlabs/x/search";
 
 import { type framer } from "@/framer";
-import { type Key, type Label, labelZ } from "@/label/payload";
+import { type Key, type Label, labelZ, ontologyID } from "@/label/payload";
 import { Retriever } from "@/label/retriever";
 import { type NewLabelPayload, type SetOptions, Writer } from "@/label/writer";
 import { ontology } from "@/ontology";
@@ -105,7 +105,7 @@ export class Client implements AsyncTermSearcher<string, Key, Label> {
   ): Promise<observe.ObservableAsyncCloseable<Label[]>> {
     const wrapper = new observe.Observer<Label[]>();
     const initial = (await this.retrieveFor(id)).map((l) => ({
-      id: new ontology.ID({ key: l.key, type: "label" }),
+      id: ontologyID(l.key),
       key: l.key,
       name: l.name,
       data: l,

package/src/label/external.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/label/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/label/label.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/label/payload.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/label/retriever.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/label/writer.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ontology/client.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -8,7 +8,7 @@
 // included in the file licenses/APL.txt.
 
 import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
-import { observe, toArray } from "@synnaxlabs/x";
+import { observe, strings, toArray } from "@synnaxlabs/x";
 import { type AsyncTermSearcher } from "@synnaxlabs/x/search";
 import { z } from "zod";
 
@@ -123,7 +123,11 @@ export class Client implements AsyncTermSearcher<string, string, Resource> {
     const resources = await this.execRetrieve({ ids: parseIDs(ids), ...options });
     if (Array.isArray(ids)) return resources;
     if (resources.length === 0)
-      throw new QueryError(`No resource found with ID ${ids.toString()}`);
+      throw new QueryError(
+        `No resource found with ID ${strings.naturalLanguageJoin(
+          toArray(ids).map((id) => new ID(id).toString()),
+        )}`,
+      );
     return resources[0];
   }
 
@@ -458,10 +462,13 @@ export class DependentTracker
           c.key[oppositeDirection(this.relDir)].type === this.resourceType),
     );
     if (sets.length === 0) return this.notify(this.dependents);
-    this.client.retrieve(sets.map((s) => s.key.to)).then((resources) => {
-      this.dependents = this.dependents.concat(resources);
-      this.notify(this.dependents);
-    });
+    this.client
+      .retrieve(sets.map((s) => s.key.to))
+      .then((resources) => {
+        this.dependents = this.dependents.concat(resources);
+        this.notify(this.dependents);
+      })
+      .catch(console.error);
   };
 
   async close(): Promise<void> {

package/src/ontology/external.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ontology/group/client.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ontology/group/external.ts

@@ -1,4 +1,4 @@
-// Copyright 2024 Synnax Labs, Inc.
+// Copyright 2025 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.