@synnaxlabs/client 0.46.1 → 0.47.0

package/src/arc/payload.ts

@@ -7,18 +7,16 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { xy } from "@synnaxlabs/x";
-import { record } from "@synnaxlabs/x/record";
+import { record, xy } from "@synnaxlabs/x";
 import { z } from "zod/v4";
 
-import { type Status } from "@/status/payload";
+import { statusZ as baseStatusZ } from "@/status/payload";
 import { parseWithoutKeyConversion } from "@/util/parseWithoutKeyConversion";
 
 export const irNodeZ = z.object({
   key: z.string(),
   type: z.string(),
   config: record.unknownZ.or(z.string().transform(parseWithoutKeyConversion)),
-  source: z.string().optional(),
 });
 
 export const graphNodeZ = irNodeZ.extend({
@@ -49,6 +47,14 @@ export const keyZ = z.uuid();
 export type Key = z.infer<typeof keyZ>;
 export type Params = Key | Key[];
 
+export const statusDetailsZ = z.object({
+  running: z.boolean(),
+});
+
+export const statusZ = baseStatusZ(statusDetailsZ);
+
+export type Status = z.infer<typeof statusZ>;
+
 export const arcZ = z.object({
   key: keyZ,
   name: z.string(),
@@ -56,13 +62,12 @@ export const arcZ = z.object({
   text: textZ,
   deploy: z.boolean(),
   version: z.string(),
+  status: statusZ.optional().nullable(),
 });
 
-export interface Arc extends z.infer<typeof arcZ> {
-  status?: Status;
-}
+export interface Arc extends z.infer<typeof arcZ> {}
 
-export const newZ = arcZ.partial({ key: true });
+export const newZ = arcZ.partial({ key: true }).omit({ status: true });
 export interface New extends z.input<typeof newZ> {}
 
 export const ONTOLOGY_TYPE = "arc";

package/src/auth/auth.spec.ts

@@ -8,7 +8,7 @@
 // included in the file licenses/APL.txt.
 
 import { type Context } from "@synnaxlabs/freighter";
-import { URL } from "@synnaxlabs/x/url";
+import { URL } from "@synnaxlabs/x";
 import { describe, expect, it, test } from "vitest";
 
 import { auth } from "@/auth";

package/src/channel/batchRetriever.spec.ts

@@ -7,8 +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 { errors } from "@synnaxlabs/x";
-import { DataType, Rate } from "@synnaxlabs/x/telem";
+import { DataType, errors, Rate } from "@synnaxlabs/x";
 import { describe, expect, it, vi } from "vitest";
 
 import { channel } from "@/channel";
@@ -55,6 +54,7 @@ describe("channelchannel.Retriever", () => {
         index: 0,
         virtual: false,
         expression: "",
+        operations: [],
         requires: [],
       }));
     });
@@ -84,6 +84,7 @@ describe("channelchannel.Retriever", () => {
         index: 0,
         virtual: false,
         expression: "",
+        operations: [],
         requires: [],
       }));
     });

package/src/channel/channel.spec.ts

@@ -7,8 +7,8 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { DataType, TimeStamp } from "@synnaxlabs/x/telem";
-import { beforeAll, describe, expect, it, test } from "vitest";
+import { DataType, id, TimeStamp } from "@synnaxlabs/x";
+import { describe, expect, it, test } from "vitest";
 
 import { Channel } from "@/channel/client";
 import { NotFoundError, PathError } from "@/errors";
@@ -31,24 +31,23 @@ describe("Channel", () => {
     }, 80000);
 
     test("create calculated", async () => {
+      const chOneName = id.create();
       let chOne = new Channel({
-        name: "test",
-        isIndex: true,
-        dataType: DataType.TIMESTAMP,
+        name: chOneName,
+        virtual: true,
+        dataType: DataType.FLOAT32,
       });
       chOne = await client.channels.create(chOne);
       let calculatedCH = new Channel({
         name: "test2",
         virtual: true,
         dataType: DataType.FLOAT32,
-        expression: "test * 2",
-        requires: [chOne.key],
+        expression: `return ${chOne.name} * 2`,
       });
       calculatedCH = await client.channels.create(calculatedCH);
       expect(calculatedCH.key).not.toEqual(0);
       expect(calculatedCH.virtual).toEqual(true);
-      expect(calculatedCH.expression).toEqual("test * 2");
-      expect(calculatedCH.requires).toEqual([chOne.key]);
+      expect(calculatedCH.expression).toEqual(`return ${chOneName} * 2`);
     });
 
     test("create calculated, missing required channel", async () => {
@@ -58,7 +57,6 @@ describe("Channel", () => {
           virtual: true,
           dataType: DataType.FLOAT32,
           expression: "test * 2",
-          requires: [],
         });
       } catch (e) {
         expect(PathError.matches(e)).toBe(true);
@@ -289,21 +287,12 @@ describe("Channel", () => {
   });
 
   describe("update calculations", () => {
-    let idxCH: Channel;
-    beforeAll(async () => {
-      idxCH = await client.channels.create({
-        name: "idx",
-        dataType: DataType.TIMESTAMP,
-        isIndex: true,
-      });
-    });
     test("update virtual channel expression", async () => {
       const channel = await client.channels.create({
         name: "virtual-calc",
         dataType: DataType.FLOAT32,
         virtual: true,
         expression: "return 1",
-        requires: [idxCH.key],
       });
 
       const updated = await client.channels.create({
@@ -312,7 +301,6 @@ describe("Channel", () => {
         dataType: channel.dataType,
         virtual: true,
         expression: "return 2",
-        requires: [idxCH.key],
       });
 
       const channelsWithName = await client.channels.retrieve(["virtual-calc"]);
@@ -330,7 +318,6 @@ describe("Channel", () => {
         dataType: DataType.FLOAT32,
         virtual: true,
         expression: "return 1",
-        requires: [idxCH.key],
       });
 
       const updated = await client.channels.create({
@@ -339,7 +326,6 @@ describe("Channel", () => {
         dataType: channel.dataType,
         virtual: true,
         expression: channel.expression,
-        requires: [idxCH.key],
       });
       expect(updated.name).toEqual("new-name");
 

package/src/channel/client.ts

@@ -8,15 +8,16 @@
 // included in the file licenses/APL.txt.
 
 import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
-import { array, status } from "@synnaxlabs/x";
 import {
+  array,
   type CrudeDensity,
   type CrudeTimeRange,
   type CrudeTimeStamp,
   DataType,
   type MultiSeries,
+  status,
   type TypedArray,
-} from "@synnaxlabs/x/telem";
+} from "@synnaxlabs/x";
 import { z } from "zod";
 
 import {
@@ -25,6 +26,7 @@ import {
   keyZ,
   type Name,
   type New,
+  type Operation,
   type Params,
   type Payload,
   payloadZ,
@@ -112,9 +114,7 @@ export class Channel {
    * the calculated value
    */
   readonly expression: string;
-  /**
-   * Only used for calculated channels. Specifies the channels required for calculation
-   */
+  readonly operations: Operation[];
   readonly requires: Key[];
   /**
    * The status of the channel.
@@ -134,12 +134,15 @@ export class Channel {
     alias,
     status: argsStatus,
     expression = "",
+    operations = [],
     requires = [],
   }: New & {
     internal?: boolean;
     frameClient?: framer.Client;
     density?: CrudeDensity;
     status?: status.Crude;
+    operations?: Operation[];
+    requires?: Key[];
   }) {
     this.key = keyZ.parse(key);
     this.name = name;
@@ -151,7 +154,8 @@ export class Channel {
     this.alias = alias;
     this.virtual = virtual;
     this.expression = expression;
-    this.requires = keyZ.array().parse(requires ?? []);
+    this.operations = operations;
+    this.requires = requires;
     if (argsStatus != null) this.status = status.create(argsStatus);
     this._frameClient = frameClient ?? null;
   }
@@ -177,9 +181,10 @@ export class Channel {
       isIndex: this.isIndex,
       internal: this.internal,
       virtual: this.virtual,
-      expression: this.expression,
       requires: this.requires,
+      expression: this.expression,
       status: this.status,
+      operations: this.operations,
     });
   }
 
@@ -434,7 +439,15 @@ export class Client {
 export const isCalculated = ({ virtual, expression }: Payload): boolean =>
   virtual && expression !== "";
 
-export const resolveCalculatedIndex = async (
+export const isLegacyCalculated = (pld: Payload): boolean =>
+  isCalculated(pld) && pld.requires.length > 0;
+
+export const ontologyID = (key: Key): ontology.ID => ({
+  type: "channel",
+  key: key.toString(),
+});
+
+export const resolveLegacyCalculatedIndex = async (
   retrieve: (key: Key) => Promise<Payload | null>,
   channel: Payload,
 ): Promise<Key | null> => {
@@ -448,14 +461,9 @@ export const resolveCalculatedIndex = async (
     const requiredChannel = await retrieve(required);
     if (requiredChannel == null) return null;
     if (isCalculated(requiredChannel)) {
-      const index = await resolveCalculatedIndex(retrieve, requiredChannel);
+      const index = await resolveLegacyCalculatedIndex(retrieve, requiredChannel);
       if (index != null) return index;
     }
   }
   return null;
 };
-
-export const ontologyID = (key: Key): ontology.ID => ({
-  type: "channel",
-  key: key.toString(),
-});

package/src/channel/payload.ts

@@ -7,7 +7,15 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { array, type CrudeDataType, DataType, math, status, zod } from "@synnaxlabs/x";
+import {
+  array,
+  type CrudeDataType,
+  DataType,
+  math,
+  status,
+  TimeSpan,
+  zod,
+} from "@synnaxlabs/x";
 import { z } from "zod";
 
 const errorMessage = "Channel key must be a valid uint32.";
@@ -27,6 +35,18 @@ export type KeyOrName = Key | Name;
 export type KeysOrNames = Keys | Names;
 export type PrimitiveParams = Key | Name | Keys | Names;
 
+export const OPERATION_TYPES = ["min", "max", "avg", "none"] as const;
+export const operationType = z.enum(OPERATION_TYPES);
+export type OperationType = z.infer<typeof operationType>;
+
+export const operationZ = z.object({
+  type: operationType,
+  resetChannel: keyZ.optional(),
+  duration: TimeSpan.z.optional(),
+});
+
+export type Operation = z.infer<typeof operationZ>;
+
 export const statusZ = status.statusZ();
 export type Status = z.infer<typeof statusZ>;
 export const payloadZ = z.object({
@@ -40,12 +60,13 @@ export const payloadZ = z.object({
   virtual: z.boolean(),
   alias: z.string().optional(),
   expression: z.string().default(""),
-  requires: array.nullableZ(keyZ),
   status: statusZ.optional(),
+  operations: array.nullableZ(operationZ),
+  requires: array.nullableZ(keyZ),
 });
 export interface Payload extends z.infer<typeof payloadZ> {}
 
-export const newZ = payloadZ.extend({
+export const newZ = payloadZ.omit({ requires: true }).extend({
   key: keyZ.optional(),
   leaseholder: z.number().optional(),
   index: keyZ.optional(),
@@ -53,7 +74,7 @@ export const newZ = payloadZ.extend({
   internal: z.boolean().optional().default(false),
   virtual: z.boolean().optional().default(false),
   expression: z.string().optional().default(""),
-  requires: array.nullableZ(keyZ).optional().default([]),
+  operations: array.nullableZ(operationZ).optional(),
 });
 
 export interface New

package/src/channel/retriever.ts

@@ -8,9 +8,7 @@
 // included in the file licenses/APL.txt.
 
 import { type UnaryClient } from "@synnaxlabs/freighter";
-import { array } from "@synnaxlabs/x/array";
-import { debounce } from "@synnaxlabs/x/debounce";
-import { DataType } from "@synnaxlabs/x/telem";
+import { array, DataType, debounce } from "@synnaxlabs/x";
 import { Mutex } from "async-mutex";
 import { z } from "zod";
 
@@ -46,6 +44,7 @@ const reqZ = z.object({
   isIndex: z.boolean().optional(),
   internal: z.boolean().optional(),
   calculated: z.boolean().optional(),
+  legacyCalculated: z.boolean().optional(),
 });
 export interface RetrieveRequest extends z.input<typeof reqZ> {}
 

package/src/client.ts

@@ -7,9 +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 { breaker } from "@synnaxlabs/x";
-import { TimeSpan, TimeStamp } from "@synnaxlabs/x/telem";
-import { URL } from "@synnaxlabs/x/url";
+import { breaker, TimeSpan, TimeStamp, URL } from "@synnaxlabs/x";
 import { z } from "zod";
 
 import { access } from "@/access";
@@ -158,7 +156,7 @@ export default class Synnax extends framer.Client {
     );
     const racks = new rack.Client(this.transport.unary, tasks);
     this.hardware = new hardware.Client(tasks, racks, devices);
-    this.arcs = new arc.Client(this.transport.unary);
+    this.arcs = new arc.Client(this.transport.unary, this.transport.stream);
   }
 
   get key(): string {

package/src/connection/checker.ts

@@ -8,8 +8,7 @@
 // included in the file licenses/APL.txt.
 
 import type { UnaryClient } from "@synnaxlabs/freighter";
-import { migrate } from "@synnaxlabs/x";
-import { TimeSpan } from "@synnaxlabs/x/telem";
+import { migrate, TimeSpan } from "@synnaxlabs/x";
 import { z } from "zod";
 
 export const statusZ = z.enum(["disconnected", "connecting", "connected", "failed"]);
@@ -45,8 +44,8 @@ const createWarning = (
   clientVersion: string,
   clientIsNewer: boolean,
 ): string => {
-  const toUpgrade = clientIsNewer ? "cluster" : "client";
-  return `Synnax cluster node version ${nodeVersion != null ? `${nodeVersion} ` : ""}is too ${clientIsNewer ? "old" : "new"} for client version ${clientVersion}.
+  const toUpgrade = clientIsNewer ? "Core" : "client";
+  return `Synnax Core version ${nodeVersion != null ? `${nodeVersion} ` : ""}is too ${clientIsNewer ? "old" : "new"} for client version ${clientVersion}.
   This may cause compatibility issues. We recommend updating the ${toUpgrade}. For more information, see
   https://docs.synnaxlabs.com/reference/typescript-client/troubleshooting#old-${toUpgrade}-version`;
 };

package/src/connection/connection.spec.ts

@@ -7,7 +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 { URL } from "@synnaxlabs/x/url";
+import { URL } from "@synnaxlabs/x";
 import { describe, expect, it } from "vitest";
 import { z } from "zod";
 

package/src/control/state.ts

@@ -7,9 +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 { control } from "@synnaxlabs/x";
-import { binary } from "@synnaxlabs/x/binary";
-import { type observe } from "@synnaxlabs/x/observe";
+import { binary, control, type observe } from "@synnaxlabs/x";
 import { z } from "zod";
 
 import { type channel } from "@/channel";

package/src/errors.ts

@@ -92,7 +92,7 @@ export class ControlError extends SynnaxError.sub("control") {}
 export class UnauthorizedError extends ControlError.sub("unauthorized") {}
 
 export class DisconnectedError extends SynnaxError.sub("disconnected") {
-  constructor(message: string = "Operation failed because no cluster is connected.") {
+  constructor(message: string = "Operation failed because no Core is connected.") {
     super(message);
   }
 }
@@ -161,7 +161,7 @@ export const errorsMiddleware: Middleware = async (ctx, next) => {
     return [
       res,
       new Unreachable({
-        message: `Cannot reach cluster at ${err.url.host}:${err.url.port}`,
+        message: `Cannot reach Core at ${err.url.host}:${err.url.port}`,
         url: err.url,
       }),
     ];

package/src/framer/adapter.spec.ts

@@ -7,7 +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 { DataType, Series, TimeStamp } from "@synnaxlabs/x/telem";
+import { DataType, Series, TimeStamp } from "@synnaxlabs/x";
 import { beforeAll, describe, expect, it } from "vitest";
 
 import { type channel } from "@/channel";

package/src/framer/adapter.ts

@@ -7,8 +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 { compare } from "@synnaxlabs/x";
-import { type CrudeSeries, Series } from "@synnaxlabs/x/telem";
+import { compare, type CrudeSeries, Series } from "@synnaxlabs/x";
 
 import { channel } from "@/channel";
 import { ValidationError } from "@/errors";

package/src/framer/client.ts

@@ -125,7 +125,6 @@ export class Client {
         channels: Object.keys(data_),
         mode: WriterMode.Persist,
         errOnUnauthorized: true,
-        enableAutoCommit: true,
         autoIndexPersistInterval: TimeSpan.MAX,
       });
       await w.write(data_);
@@ -136,7 +135,6 @@ export class Client {
       channels: channels as channel.Params,
       mode: WriterMode.Persist,
       errOnUnauthorized: true,
-      enableAutoCommit: true,
       autoIndexPersistInterval: TimeSpan.MAX,
     });
     await w.write(channels as channel.Params, data);

package/src/framer/codec.spec.ts

@@ -1,3 +1,12 @@
+// Copyright 2025 Synnax Labs, Inc.
+//
+// Use of this software is governed by the Business Source License included in the file
+// licenses/BSL.txt.
+//
+// As of the Change Date specified in that file, in accordance with the Business Source
+// License, use of this software will be governed by the Apache License, Version 2.0,
+// included in the file licenses/APL.txt.
+
 import { type WebsocketMessage } from "@synnaxlabs/freighter";
 import { DataType, Series, TimeStamp } from "@synnaxlabs/x";
 import { describe, expect, it } from "vitest";
@@ -12,7 +21,8 @@ import {
   WSWriterCodec,
 } from "@/framer/codec";
 import { Frame } from "@/framer/frame";
-import { WriterCommand, type WriteRequest } from "@/framer/writer";
+import { WriterCommand } from "@/framer/payload";
+import { type WriteRequest } from "@/framer/writer";
 
 describe("encoder", () => {
   describe("base codec", () => {

package/src/framer/codec.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.
@@ -20,8 +20,9 @@ import { type z } from "zod";
 import { type channel } from "@/channel";
 import { ValidationError } from "@/errors";
 import { type Frame, type Payload } from "@/framer/frame";
+import { WriterCommand } from "@/framer/payload";
 import { type StreamerResponse } from "@/framer/streamer";
-import { WriterCommand, type WriteRequest } from "@/framer/writer";
+import { type WriteRequest } from "@/framer/writer";
 
 const seriesPldLength = (series: SeriesPayload): number =>
   series.data.byteLength / series.dataType.density.valueOf();

package/src/framer/deleter.spec.ts

@@ -7,7 +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 { TimeRange, TimeStamp } from "@synnaxlabs/x/telem";
+import { TimeRange, TimeStamp } from "@synnaxlabs/x";
 import { describe, expect, test } from "vitest";
 
 import { NotFoundError, UnauthorizedError } from "@/errors";

package/src/framer/deleter.ts

@@ -22,8 +22,6 @@ interface Request extends z.infer<typeof reqZ> {}
 
 const resZ = z.object({});
 
-const ENDPOINT = "/frame/delete";
-
 export class Deleter {
   /*
   Deleter is used to delete a time range of telemetry from the data engine.
@@ -37,7 +35,7 @@ export class Deleter {
   async delete(props: Request): Promise<void> {
     await sendRequired<typeof reqZ, typeof resZ>(
       this.client,
-      ENDPOINT,
+      "/frame/delete",
       props,
       reqZ,
       resZ,

package/src/framer/external.ts

@@ -10,5 +10,6 @@
 export * from "@/framer/client";
 export * from "@/framer/frame";
 export * from "@/framer/iterator";
+export * from "@/framer/payload";
 export * from "@/framer/streamer";
 export * from "@/framer/writer";

package/src/framer/frame.spec.ts

@@ -7,7 +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 { DataType, Series, TimeRange } from "@synnaxlabs/x/telem";
+import { DataType, Series, TimeRange } from "@synnaxlabs/x";
 import { describe, expect, it, test } from "vitest";
 
 import { framer } from "@/framer";

package/src/framer/frame.ts

@@ -7,8 +7,8 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { array, unique } from "@synnaxlabs/x";
 import {
+  array,
   MultiSeries,
   Series,
   type SeriesDigest,
@@ -17,7 +17,8 @@ import {
   type TelemValue,
   TimeRange,
   TimeStamp,
-} from "@synnaxlabs/x/telem";
+  unique,
+} from "@synnaxlabs/x";
 import { z } from "zod";
 
 import { type channel } from "@/channel";
@@ -221,9 +222,9 @@ export class Frame {
 
   /**
    * @returns true if the frame is horizontal. Horizontal frames have a single channel,
-   * and are strongly aligned by default.A horizontal frame typically has a single array
-   * (in which case, it's also 'square'), although it can have multiple series if all
-   * the series are continuous in time.
+   * and are strongly aligned by default. A horizontal frame typically has a single
+   * array (in which case, it's also 'square'), although it can have multiple series if
+   * all the series are continuous in time.
    */
   get isHorizontal(): boolean {
     return this.uniqueColumns.length === 1;

package/src/framer/iterator.spec.ts

@@ -7,7 +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 { TimeRange, TimeSpan, TimeStamp } from "@synnaxlabs/x/telem";
+import { TimeRange, TimeSpan, TimeStamp } from "@synnaxlabs/x";
 import { describe, expect, test } from "vitest";
 
 import { AUTO_SPAN } from "@/framer/iterator";
@@ -68,7 +68,6 @@ describe("Iterator", () => {
     const writer = await client.openWriter({
       start: TimeStamp.SECOND,
       channels,
-      enableAutoCommit: true,
     });
     await writer.write({
       [idx_ch.key]: secondsLinspace(1, 10),

package/src/framer/iterator.ts

@@ -8,15 +8,15 @@
 // included in the file licenses/APL.txt.
 
 import { type Stream, type StreamClient } from "@synnaxlabs/freighter";
-import { errors } from "@synnaxlabs/x";
 import {
   type CrudeTimeRange,
   type CrudeTimeSpan,
   type CrudeTimeStamp,
+  errors,
   TimeRange,
   TimeSpan,
   TimeStamp,
-} from "@synnaxlabs/x/telem";
+} from "@synnaxlabs/x";
 import { z } from "zod";
 
 import { channel } from "@/channel";
@@ -78,7 +78,6 @@ export interface IteratorConfig {
  *  telemetry between two timestamps, see the SegmentClient.read method.
  */
 export class Iterator {
-  private static readonly ENDPOINT = "/frame/iterate";
   private readonly stream: StreamProxy<typeof reqZ, typeof resZ>;
   private readonly adapter: ReadAdapter;
   value: Frame;
@@ -108,7 +107,7 @@ export class Iterator {
     opts: IteratorConfig = {},
   ): Promise<Iterator> {
     const adapter = await ReadAdapter.open(retriever, channels);
-    const stream = await client.stream(Iterator.ENDPOINT, reqZ, resZ);
+    const stream = await client.stream("/frame/iterate", reqZ, resZ);
     const iter = new Iterator(stream, adapter);
     await iter.execute({
       command: Command.Open,