@synnaxlabs/client 0.46.1 → 0.48.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,12 +8,12 @@
 // 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";
 import { AuthError, ExpiredTokenError, InvalidTokenError } from "@/errors";
-import { TEST_CLIENT_PROPS } from "@/testutil/client";
+import { TEST_CLIENT_PARAMS } from "@/testutil/client";
 import { Transport } from "@/transport";
 
 const DUMMY_CTX: Context = {
@@ -27,11 +27,11 @@ describe("auth", () => {
   test("valid credentials", async () => {
     const transport = new Transport(
       new URL({
-        host: TEST_CLIENT_PROPS.host,
-        port: Number(TEST_CLIENT_PROPS.port),
+        host: TEST_CLIENT_PARAMS.host,
+        port: Number(TEST_CLIENT_PARAMS.port),
       }),
     );
-    const client = new auth.Client(transport.unary, TEST_CLIENT_PROPS);
+    const client = new auth.Client(transport.unary, TEST_CLIENT_PARAMS);
     const mw = client.middleware();
     const res = await mw(DUMMY_CTX, async () => [DUMMY_CTX, null]);
     expect(res).toEqual([DUMMY_CTX, null]);
@@ -40,12 +40,12 @@ describe("auth", () => {
   test("invalid credentials", async () => {
     const transport = new Transport(
       new URL({
-        host: TEST_CLIENT_PROPS.host,
-        port: Number(TEST_CLIENT_PROPS.port),
+        host: TEST_CLIENT_PARAMS.host,
+        port: Number(TEST_CLIENT_PARAMS.port),
       }),
     );
     const client = new auth.Client(transport.unary, {
-      ...TEST_CLIENT_PROPS,
+      ...TEST_CLIENT_PARAMS,
       password: "wrong",
     });
     const mw = client.middleware();
@@ -59,11 +59,11 @@ describe("auth", () => {
       it(`should re-authenticate and retry the request for ${ErrorType.name}`, async () => {
         const transport = new Transport(
           new URL({
-            host: TEST_CLIENT_PROPS.host,
-            port: Number(TEST_CLIENT_PROPS.port),
+            host: TEST_CLIENT_PARAMS.host,
+            port: Number(TEST_CLIENT_PARAMS.port),
           }),
         );
-        const client = new auth.Client(transport.unary, TEST_CLIENT_PROPS);
+        const client = new auth.Client(transport.unary, TEST_CLIENT_PARAMS);
         const mw = client.middleware();
         let isFirst = true;
         let tkOne: string | undefined;
@@ -86,11 +86,11 @@ describe("auth", () => {
     it("should fail after MAX_RETRIES", async () => {
       const transport = new Transport(
         new URL({
-          host: TEST_CLIENT_PROPS.host,
-          port: Number(TEST_CLIENT_PROPS.port),
+          host: TEST_CLIENT_PARAMS.host,
+          port: Number(TEST_CLIENT_PARAMS.port),
         }),
       );
-      const client = new auth.Client(transport.unary, TEST_CLIENT_PROPS);
+      const client = new auth.Client(transport.unary, TEST_CLIENT_PARAMS);
       const mw = client.middleware();
       const [, err] = await mw(DUMMY_CTX, async () => [
         DUMMY_CTX,

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,8 +60,9 @@ 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> {}
 
@@ -53,7 +74,8 @@ 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(),
+  requires: array.nullableZ(keyZ).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";
@@ -32,7 +30,7 @@ import { Transport } from "@/transport";
 import { user } from "@/user";
 import { workspace } from "@/workspace";
 
-export const synnaxPropsZ = z.object({
+export const synnaxParamsZ = z.object({
   host: z.string({ error: "Host is required" }).min(1, "Host is required"),
   port: z
     .number({ error: "Port is required" })
@@ -45,8 +43,8 @@ export const synnaxPropsZ = z.object({
   retry: breaker.breakerConfigZ.optional(),
 });
 
-export interface SynnaxProps extends z.input<typeof synnaxPropsZ> {}
-export interface ParsedSynnaxProps extends z.infer<typeof synnaxPropsZ> {}
+export interface SynnaxParams extends z.input<typeof synnaxParamsZ> {}
+export interface ParsedSynnaxParams extends z.infer<typeof synnaxParamsZ> {}
 
 /**
  * Client to perform operations against a Synnax cluster.
@@ -58,7 +56,7 @@ export interface ParsedSynnaxProps extends z.infer<typeof synnaxPropsZ> {}
  */
 export default class Synnax extends framer.Client {
   readonly createdAt: TimeStamp;
-  readonly props: ParsedSynnaxProps;
+  readonly params: ParsedSynnaxParams;
   readonly ranges: ranger.Client;
   readonly channels: channel.Client;
   readonly auth: auth.Client | undefined;
@@ -95,8 +93,8 @@ export default class Synnax extends framer.Client {
    * A Synnax client must be closed when it is no longer needed. This will stop
    * the client from polling the cluster for connectivity information.
    */
-  constructor(props_: SynnaxProps) {
-    const props = synnaxPropsZ.parse(props_);
+  constructor(params: SynnaxParams) {
+    const parsedParams = synnaxParamsZ.parse(params);
     const {
       host,
       port,
@@ -105,7 +103,7 @@ export default class Synnax extends framer.Client {
       connectivityPollFrequency,
       secure,
       retry: breaker,
-    } = props;
+    } = parsedParams;
     const transport = new Transport(
       new URL({ host, port: Number(port) }),
       breaker,
@@ -123,7 +121,7 @@ export default class Synnax extends framer.Client {
     const chCreator = new channel.Writer(transport.unary, chRetriever);
     super(transport.stream, transport.unary, chRetriever);
     this.createdAt = TimeStamp.now();
-    this.props = props;
+    this.params = parsedParams;
     this.auth = auth_;
     this.transport = transport;
     this.channels = new channel.Client(this, chRetriever, transport.unary, chCreator);
@@ -131,7 +129,7 @@ export default class Synnax extends framer.Client {
       transport.unary,
       connectivityPollFrequency,
       this.clientVersion,
-      props.name,
+      parsedParams.name,
     );
     this.control = new control.Client(this);
     this.ontology = new ontology.Client(transport.unary, this);
@@ -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 {
@@ -166,6 +164,20 @@ export default class Synnax extends framer.Client {
   }
 
   close(): void {
-    this.connectivity.stopChecking();
+    this.connectivity.stop();
   }
 }
+
+export interface CheckConnectionParams
+  extends Pick<SynnaxParams, "host" | "port" | "secure" | "retry" | "name"> {}
+
+export const checkConnection = async (params: CheckConnectionParams) =>
+  await newConnectionChecker(params).check();
+
+export const newConnectionChecker = (params: CheckConnectionParams) => {
+  const { host, port, secure, name, retry } = params;
+  const retryConfig = breaker.breakerConfigZ.optional().parse(retry);
+  const url = new URL({ host, port: Number(port) });
+  const transport = new Transport(url, retryConfig, secure);
+  return new connection.Checker(transport.unary, undefined, __VERSION__, name);
+};

package/src/connection/checker.ts

@@ -7,9 +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 type { UnaryClient } from "@synnaxlabs/freighter";
-import { migrate } from "@synnaxlabs/x";
-import { TimeSpan } from "@synnaxlabs/x/telem";
+import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
+import { migrate, TimeSpan } from "@synnaxlabs/x";
 import { z } from "zod";
 
 export const statusZ = z.enum(["disconnected", "connecting", "connected", "failed"]);
@@ -30,6 +29,7 @@ const responseZ = z.object({
   clusterKey: z.string(),
   nodeVersion: z.string().optional(),
 });
+const requestZ = z.void();
 
 const DEFAULT: State = {
   clusterKey: "",
@@ -45,15 +45,14 @@ 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`;
 };
 
 /** Polls a synnax cluster for connectivity information. */
 export class Checker {
-  private static readonly ENDPOINT = "/connectivity/check";
   static readonly DEFAULT: State = DEFAULT;
   private readonly _state: State;
   private readonly pollFrequency = TimeSpan.seconds(30);
@@ -82,11 +81,11 @@ export class Checker {
     this.clientVersion = clientVersion;
     this.name = name;
     void this.check();
-    this.startChecking();
+    this.start();
   }
 
   /** Stops the connectivity client from polling the cluster for connectivity */
-  stopChecking(): void {
+  stop(): void {
     if (this.interval != null) clearInterval(this.interval);
   }
 
@@ -97,13 +96,13 @@ export class Checker {
   async check(): Promise<State> {
     const prevStatus = this._state.status;
     try {
-      const [res, err] = await this.client.send(
-        Checker.ENDPOINT,
-        {},
-        z.object({}),
+      const res = await sendRequired(
+        this.client,
+        "/connectivity/check",
+        undefined,
+        requestZ,
         responseZ,
       );
-      if (err != null) throw err;
       const nodeVersion = res.nodeVersion;
       const clientVersion = this.clientVersion;
       const warned = this.versionWarned;
@@ -157,7 +156,7 @@ export class Checker {
     this.onChangeHandlers.push(callback);
   }
 
-  private startChecking(): void {
+  private start(): void {
     this.interval = setInterval(() => {
       void this.check();
     }, this.pollFrequency.milliseconds);