@synnaxlabs/client 0.26.7 → 0.27.0

package/dist/workspace/retriever.d.ts

@@ -1,6 +1,5 @@
 import { UnaryClient } from '@synnaxlabs/freighter';
 import { Params, Workspace } from './payload';
-
 export declare class Retriever {
     private static readonly ENDPOINT;
     private readonly client;

package/dist/workspace/schematic/client.d.ts

@@ -2,7 +2,6 @@ import { UnaryClient } from '@synnaxlabs/freighter';
 import { UnknownRecord } from '@synnaxlabs/x/record';
 import { Key, Params, Schematic } from './payload';
 import { NewSchematic } from './writer';
-
 export declare class Client {
     private readonly writer;
     private readonly retriever;

package/dist/workspace/schematic/payload.d.ts

@@ -1,7 +1,6 @@
 import { UnknownRecord } from '@synnaxlabs/x/record';
 import { z } from 'zod';
 import { ontology } from '../../ontology';
-
 export declare const keyZ: z.ZodString;
 export type Key = z.infer<typeof keyZ>;
 export type Params = Key | Key[];

package/dist/workspace/schematic/retriever.d.ts

@@ -1,6 +1,5 @@
 import { UnaryClient } from '@synnaxlabs/freighter';
 import { Params, Schematic } from './payload';
-
 export declare class Retriever {
     private readonly ENDPOINT;
     private readonly client;

package/dist/workspace/schematic/writer.d.ts

@@ -2,7 +2,6 @@ import { UnaryClient } from '@synnaxlabs/freighter';
 import { UnknownRecord } from '@synnaxlabs/x/record';
 import { z } from 'zod';
 import { Key, Params, Schematic } from './payload';
-
 export declare const newSchematicZ: z.ZodEffects<z.ZodObject<{
     name: z.ZodString;
     key: z.ZodOptional<z.ZodString>;

package/dist/workspace/writer.d.ts

@@ -2,7 +2,6 @@ import { UnaryClient } from '@synnaxlabs/freighter';
 import { UnknownRecord } from '@synnaxlabs/x/record';
 import { z } from 'zod';
 import { Workspace } from './payload';
-
 declare const newWorkspaceZ: z.ZodEffects<z.ZodObject<{
     name: z.ZodString;
     key: z.ZodOptional<z.ZodString>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@synnaxlabs/client",
   "private": false,
-  "version": "0.26.7",
+  "version": "0.27.0",
   "type": "module",
   "description": "The Client Library for Synnax",
   "repository": "https://github.com/synnaxlabs/synnax/tree/main/client/ts",
@@ -18,19 +18,19 @@
   "dependencies": {
     "async-mutex": "^0.5.0",
     "zod": "3.23.8",
-    "@synnaxlabs/freighter": "0.26.7",
-    "@synnaxlabs/x": "0.26.7"
+    "@synnaxlabs/freighter": "0.27.0",
+    "@synnaxlabs/x": "0.27.0"
   },
   "devDependencies": {
-    "@types/node": "^20.14.9",
-    "@vitest/coverage-v8": "^1.6.0",
-    "eslint": "^9.6.0",
-    "typescript": "^5.5.3",
-    "vite": "5.3.3",
-    "vitest": "^1.6.0",
+    "@types/node": "^22.2.0",
+    "@vitest/coverage-v8": "^2.0.5",
+    "eslint": "^9.9.0",
+    "typescript": "^5.5.4",
+    "vite": "5.4.0",
+    "vitest": "^2.0.5",
     "@synnaxlabs/tsconfig": "0.0.2",
-    "eslint-config-synnaxlabs": "0.0.1",
-    "@synnaxlabs/vite-plugin": "0.0.1"
+    "@synnaxlabs/vite-plugin": "0.0.1",
+    "eslint-config-synnaxlabs": "0.0.1"
   },
   "peerDependencies": {
     "zod": "^3.23.8"
@@ -44,6 +44,8 @@
     "test": "vitest",
     "cov": "vitest --coverage",
     "lint": "eslint \"src/**/*.ts*\"",
-    "fix": "eslint \"src/**/*.ts*\" --fix"
+    "fix": "eslint \"src/**/*.ts*\" --fix",
+    "genApi": "tsc --noEmit && vite build && npx api-extractor run --local",
+    "checkApi": "tsc --noEmit && vite build && npx api-extractor run"
   }
 }

package/src/access/access.spec.ts

@@ -23,7 +23,7 @@ const client = newClient();
 
 describe("Policy", () => {
   describe("create", () => {
-    test("create one", async () => {
+    test.skip("create one", async () => {
       const policy = await client.access.create({
         subjects: [{ type: UserOntologyType, key: "1" }],
         objects: [
@@ -40,7 +40,7 @@ describe("Policy", () => {
       ]);
       expect(policy.actions).toEqual(["update"]);
     });
-    test("create many", async () => {
+    test.skip("create many", async () => {
       const policies = await client.access.create([
         {
           subjects: [{ type: UserOntologyType, key: "10" }],
@@ -62,11 +62,11 @@ describe("Policy", () => {
           actions: ["update"],
         },
       ]);
-      expect(policies.length).toEqual(2);
+      expect(policies.length).toEqual(3);
       expect(policies[0].subjects[0].key).toEqual("10");
       expect(policies[1].subjects[1].key).toEqual("21");
     });
-    test("create instances of policies", async () => {
+    test.skip("create instances of policies", async () => {
       const policy = {
         key: undefined,
         subjects: [
@@ -85,7 +85,7 @@ describe("Policy", () => {
       expect(p.key).not.toEqual(policy.key);
     });
   });
-  test("retrieve by subject", async () => {
+  test.skip("retrieve by subject", async () => {
     const key1 = id.id();
     const policies = [
       {
@@ -120,13 +120,13 @@ describe("Policy", () => {
     expect(p).toHaveLength(2);
     expect([p[0].actions, p[1].actions].sort()).toEqual([["delete"], ["update"]]);
   });
-  test("retrieve by subject - not found", async () => {
+  test.skip("retrieve by subject - not found", async () => {
     const res = await client.access.retrieve({ type: UserOntologyType, key: "999" });
     expect(res).toHaveLength(0);
   });
 
   describe("delete", async () => {
-    test("delete one", async () => {
+    test.skip("delete one", async () => {
       const id1 = id.id();
       const id2 = id.id();
       const id3 = id.id();
@@ -163,7 +163,7 @@ describe("Policy", () => {
       expect(res).toHaveLength(1);
       expect(res[0].actions).toEqual(["delete"]);
     });
-    test("delete many", async () => {
+    test.skip("delete many", async () => {
       const id1 = id.id();
       const id2 = id.id();
       const id3 = id.id();
@@ -203,7 +203,7 @@ describe("Policy", () => {
     });
   });
   describe("registration", async () => {
-    test("register a user", async () => {
+    test.skip("register a user", async () => {
       const username = id.id();
       await client.user.register(username, "pwd1");
       new Synnax({
@@ -213,14 +213,14 @@ describe("Policy", () => {
         password: "pwd1",
       });
     });
-    test("duplicate username", async () => {
+    test.skip("duplicate username", async () => {
       const username = id.id();
       await client.user.register(username, "pwd1");
       await expect(client.user.register(username, "pwd1")).rejects.toThrow(AuthError);
     });
   });
   describe("privilege", async () => {
-    test("new user", async () => {
+    test.skip("new user", async () => {
       const username = id.id();
       const user2 = await client.user.register(username, "pwd1");
       expect(user2).toBeDefined();

package/src/channel/batchRetriever.spec.ts

@@ -55,6 +55,7 @@ describe("channelRetriever", () => {
         rate: Rate.hz(1),
         leaseholder: 1,
         index: 0,
+        virtual: false,
       }));
     });
     const retriever = new DebouncedBatchRetriever(base, 10);
@@ -81,6 +82,7 @@ describe("channelRetriever", () => {
         rate: Rate.hz(1),
         leaseholder: 1,
         index: 0,
+        virtual: false,
       }));
     });
     const retriever = new DebouncedBatchRetriever(base, 10);

package/src/channel/channel.spec.ts

@@ -30,6 +30,7 @@ describe("Channel", () => {
       expect(channel.rate).toEqual(Rate.hz(1));
       expect(channel.dataType).toEqual(DataType.FLOAT32);
     });
+
     test("create index and indexed pair", async () => {
       const one = await client.channels.create({
         name: "Time",
@@ -44,6 +45,7 @@ describe("Channel", () => {
       });
       expect(two.key).not.toEqual(0);
     });
+
     test("create many", async () => {
       const channels = await client.channels.create([
         {
@@ -63,6 +65,7 @@ describe("Channel", () => {
       expect(channels[0].name).toEqual("test1");
       expect(channels[1].name).toEqual("test2");
     });
+
     test("create instances of channels", async () => {
       const timeIndexChannel = await client.channels.create({
         name: "time",
@@ -89,6 +92,20 @@ describe("Channel", () => {
       });
       await client.channels.create([sensorOne, sensorTwo, sensorThree]);
     });
+
+    describe("virtual", () => {
+      it("should create a virtual channel", async () => {
+        const channel = await client.channels.create({
+          name: "test",
+          dataType: DataType.JSON,
+          virtual: true,
+        });
+        expect(channel.virtual).toEqual(true);
+        const retrieved = await client.channels.retrieve(channel.key);
+        expect(retrieved.virtual).toBeTruthy();
+      });
+    });
+
     describe("retrieveIfNameExists", () => {
       it("should retrieve the existing channel when it exists", async () => {
         const name = `test-${Math.random()}-${TimeStamp.now().valueOf()}`;
@@ -159,38 +176,41 @@ describe("Channel", () => {
       });
     });
   });
-  test("retrieve by key", async () => {
-    const channel = await client.channels.create({
-      name: "test",
-      leaseholder: 1,
-      rate: Rate.hz(1),
-      dataType: DataType.FLOAT32,
+
+  describe("retrieve", () => {
+    test("retrieve by key", async () => {
+      const channel = await client.channels.create({
+        name: "test",
+        leaseholder: 1,
+        rate: Rate.hz(1),
+        dataType: DataType.FLOAT32,
+      });
+      const retrieved = await client.channels.retrieve(channel.key);
+      expect(retrieved.name).toEqual("test");
+      expect(retrieved.leaseholder).toEqual(1);
+      expect(retrieved.rate).toEqual(Rate.hz(1));
+      expect(retrieved.dataType).toEqual(DataType.FLOAT32);
+    });
+    test("retrieve by key - not found", async () => {
+      await expect(
+        async () => await client.channels.retrieve("1-1000"),
+      ).rejects.toThrow(QueryError);
+    });
+    test("retrieve by name", async () => {
+      const retrieved = await client.channels.retrieve(["test"]);
+      expect(retrieved.length).toBeGreaterThan(0);
+      retrieved.forEach((ch) => expect(ch.name).toEqual("test"));
+    });
+    test("retrieve by key - not found", async () => {
+      await expect(
+        async () => await client.channels.retrieve("1-1000"),
+      ).rejects.toThrow(NotFoundError);
+    });
+    test("retrieve by name", async () => {
+      const retrieved = await client.channels.retrieve(["test"]);
+      expect(retrieved.length).toBeGreaterThan(0);
+      retrieved.forEach((ch) => expect(ch.name).toEqual("test"));
     });
-    const retrieved = await client.channels.retrieve(channel.key);
-    expect(retrieved.name).toEqual("test");
-    expect(retrieved.leaseholder).toEqual(1);
-    expect(retrieved.rate).toEqual(Rate.hz(1));
-    expect(retrieved.dataType).toEqual(DataType.FLOAT32);
-  });
-  test("retrieve by key - not found", async () => {
-    await expect(async () => await client.channels.retrieve("1-1000")).rejects.toThrow(
-      QueryError,
-    );
-  });
-  test("retrieve by name", async () => {
-    const retrieved = await client.channels.retrieve(["test"]);
-    expect(retrieved.length).toBeGreaterThan(0);
-    retrieved.forEach((ch) => expect(ch.name).toEqual("test"));
-  });
-  test("retrieve by key - not found", async () => {
-    await expect(async () => await client.channels.retrieve("1-1000")).rejects.toThrow(
-      NotFoundError,
-    );
-  });
-  test("retrieve by name", async () => {
-    const retrieved = await client.channels.retrieve(["test"]);
-    expect(retrieved.length).toBeGreaterThan(0);
-    retrieved.forEach((ch) => expect(ch.name).toEqual("test"));
   });
 
   describe("delete", async () => {

package/src/channel/client.ts

@@ -101,6 +101,11 @@ export class Channel {
    * should not be relied upon in the current version of Synnax.
    */
   readonly alias: string | undefined;
+  /**
+   * Whether the channel is virtual. Virtual channels do not store any data in the
+   * database, but can still be used for streaming purposes.
+   */
+  readonly virtual: boolean;
 
   constructor({
     dataType,
@@ -111,6 +116,7 @@ export class Channel {
     isIndex = false,
     index = 0,
     internal = false,
+    virtual = false,
     frameClient,
     alias,
   }: NewPayload & {
@@ -126,6 +132,7 @@ export class Channel {
     this.isIndex = isIndex;
     this.internal = internal;
     this.alias = alias;
+    this.virtual = virtual;
     this._frameClient = frameClient ?? null;
   }
 

package/src/channel/payload.ts

@@ -30,6 +30,7 @@ export const payload = z.object({
   index: z.number(),
   isIndex: z.boolean(),
   internal: z.boolean(),
+  virtual: z.boolean(),
   alias: z.string().optional(),
 });
 

package/src/client.ts

@@ -44,8 +44,8 @@ export const synnaxPropsZ = z.object({
         required_error: "Port is required",
       }),
     ),
-  username: z.string().optional(),
-  password: z.string().optional(),
+  username: z.string().min(1, "Username is required"),
+  password: z.string().min(1, "Password is required"),
   connectivityPollFrequency: TimeSpan.z.default(TimeSpan.seconds(30)),
   secure: z.boolean().optional().default(false),
   name: z.string().optional(),
@@ -125,13 +125,14 @@ export default class Synnax extends framer.Client {
     this.control = new control.Client(this);
     this.ontology = new ontology.Client(transport.unary, this);
     const rangeWriter = new ranger.Writer(this.transport.unary);
-    this.labels = new label.Client(this.transport.unary, this);
+    this.labels = new label.Client(this.transport.unary, this, this.ontology);
     this.ranges = new ranger.Client(
       this,
       rangeWriter,
       this.transport.unary,
       chRetriever,
       this.labels,
+      this.ontology,
     );
     this.access = new access.Client(this.transport.unary);
     this.user = new user.Client(this.transport.unary);

package/src/control/client.ts

@@ -1,3 +1,12 @@
+// Copyright 2024 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 { StateTracker } from "@/control/state";
 import { framer } from "@/framer";
 

package/src/errors.spec.ts

@@ -1,3 +1,12 @@
+// Copyright 2024 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 { MatchableErrorType } from "@synnaxlabs/freighter/src/errors";
 import { describe, expect, test } from "vitest";
 

package/src/framer/frame.spec.ts

@@ -156,7 +156,7 @@ describe("framer.Frame", () => {
   });
 
   describe("weaklyAligned", () => {
-    it("should return true if all keys have the same timerange", () => {
+    it("should return true if all keys have the same time range", () => {
       const f = new framer.Frame(
         new Map([
           [
@@ -182,7 +182,7 @@ describe("framer.Frame", () => {
       expect(f.isWeaklyAligned).toEqual(true);
     });
 
-    it("should return false if any key has a different timerange", () => {
+    it("should return false if any key has a different time range", () => {
       const f = new framer.Frame(
         new Map([
           [

package/src/framer/frame.ts

@@ -39,17 +39,17 @@ const columnType = (columns: Params): ColumnType => {
   return "name";
 };
 
-const validateMatchedColsAndArrays = (columns: Params, arrays: Series[]): void => {
+const validateMatchedColsAndSeries = (columns: Params, series: Series[]): void => {
   const colsArr = toArray(columns);
-  if (colsArr.length === arrays.length) return;
+  if (colsArr.length === series.length) return;
   const colType = columnType(columns);
   if (columnType === null)
     throw new ValidationError(
       "[Frame] - channel keys or names must be provided when constructing a frame.",
     );
   throw new ValidationError(
-    `[Frame] - ${colType as string}s and arrays must be the same length.
-    Got ${colsArr.length} ${colType as string}s and ${arrays.length} arrays.`,
+    `[Frame] - ${colType as string}s and series must be the same length.
+    Got ${colsArr.length} ${colType as string}s and ${series.length} series.`,
   );
 };
 
@@ -65,15 +65,15 @@ export type CrudeFrame =
  *
  * Frames have two important characteristics: alignment and orientation.
  *
- * A frame's alignment defines how correlated the arrays for different channels in the
+ * A frame's alignment defines how correlated the series for different channels in the
  * frame are:
  *
- * - A frame is weakly aligned if it meets the time range occupied by all arrays of a
+ * - A frame is weakly aligned if the time range occupied by all series of a
  * particular channel is the same for all channels in the frame. This means that the
- * arrays for a particular channel can have gaps between them.
+ * series for a particular channel can have gaps between them.
  *
  * - A strongly aligned frame means that all channels share the same rate/index and
- * there are no gaps in time between arrays. Strongly aligned frames are natural
+ * there are no gaps in time between series. Strongly aligned frames are natural
  * to interpret, as the values in a particular 'row' of the frame share the same
  * timestamp. All frames written to Synnax must be strongly aligned.
  *
@@ -85,7 +85,7 @@ export type CrudeFrame =
  *
  * - 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 arrays if all the arrays are continuous in time.
+ * although it can have multiple series if all the series are continuous in time.
  *
  * - Vertical frames are strongly aligned and have on or more channels, but ONLY a single
  * array per channel. Synnax requires that all frames written to the database are
@@ -98,7 +98,7 @@ export class Frame {
   readonly columns: Keys | Names = [];
   readonly series: Series[] = [];
 
-  constructor(columnsOrData: Params | CrudeFrame = [], arrays: Series | Series[] = []) {
+  constructor(columnsOrData: Params | CrudeFrame = [], series: Series | Series[] = []) {
     if (columnsOrData instanceof Frame) {
       this.columns = columnsOrData.columns;
       this.series = columnsOrData.series;
@@ -117,9 +117,9 @@ export class Frame {
     if (isObject) {
       if ("keys" in columnsOrData && "series" in columnsOrData) {
         const data_ = columnsOrData as FramePayload;
-        const arrays = data_.series.map((a) => seriesFromPayload(a));
-        validateMatchedColsAndArrays(data_.keys, arrays);
-        data_.keys.forEach((key, i) => this.push(key, arrays[i]));
+        const series = data_.series.map((a) => seriesFromPayload(a));
+        validateMatchedColsAndSeries(data_.keys, series);
+        data_.keys.forEach((key, i) => this.push(key, series[i]));
       } else
         Object.entries(columnsOrData).forEach(([k, v]) => {
           const key = parseInt(k);
@@ -129,21 +129,21 @@ export class Frame {
       return;
     }
 
-    // Construction from a set of arrays and columns.
+    // Construction from a set of series and columns.
     if (
       Array.isArray(columnsOrData) ||
       ["string", "number"].includes(typeof columnsOrData)
     ) {
-      const data_ = toArray(arrays);
+      const data_ = toArray(series);
       const cols = toArray(columnsOrData) as Keys | Names;
-      validateMatchedColsAndArrays(cols, data_);
+      validateMatchedColsAndSeries(cols, data_);
       data_.forEach((d, i) => this.push(cols[i], d));
       return;
     }
 
     throw new ValidationError(
       `[Frame] - invalid frame construction parameters. data parameter ust be a frame
-    payload, a list of lazy arrays, a lazy array, a map, or a record keyed by channel
+    payload, a list of lazy series, a lazy array, a map, or a record keyed by channel
     name. keys parameter must be a set of channel keys or channel names.`,
     );
   }
@@ -218,8 +218,8 @@ 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 arrays if all
-   * the arrays are continuous in time.
+   * (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;
@@ -235,8 +235,8 @@ export class Frame {
 
   /**
    * @returns true if the frame is weakly aligned. A frame is weakly aligned if it meets
-   * the time range occupied by all arrays of a particular channel is the same for all
-   * channels in the frame. This means that the arrays for a particular channel can have
+   * the time range occupied by all series of a particular channel is the same for all
+   * channels in the frame. This means that the series for a particular channel can have
    * gaps between them.
    */
   get isWeaklyAligned(): boolean {
@@ -266,7 +266,7 @@ export class Frame {
   }
 
   /**
-   * @returns lazy arrays matching the given channel key or name.
+   * @returns lazy series matching the given channel key or name.
    * @param key the channel key or name.
    */
   get(key: KeyOrName): MultiSeries;

package/src/framer/writer.ts

@@ -54,7 +54,8 @@ const constructWriterMode = (mode: CrudeWriterMode): WriterMode => {
     case "persistStream":
       return WriterMode.PersistStream;
     default:
-      return mode;
+      if (typeof mode === "number" && mode in WriterMode) return mode;
+      throw new Error(`invalid writer mode: ${mode}`);
   }
 };
 

package/src/hardware/device/payload.ts

@@ -1,3 +1,12 @@
+// Copyright 2024 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 { binary, UnknownRecord } from "@synnaxlabs/x";
 import { z } from "zod";
 

package/src/hardware/rack/payload.ts

@@ -1,3 +1,12 @@
+// Copyright 2024 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 { z } from "zod";
 
 import { ontology } from "@/ontology";

package/src/hardware/task/payload.ts

@@ -1,3 +1,12 @@
+// Copyright 2024 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 { binary, observe, UnknownRecord } from "@synnaxlabs/x";
 import { z } from "zod";