@synnaxlabs/client 0.32.0 → 0.33.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@synnaxlabs/client",
-  "version": "0.32.0",
+  "version": "0.33.0",
   "description": "The Synnax Client Library",
   "keywords": [
     "synnax",
@@ -25,24 +25,23 @@
   },
   "dependencies": {
     "async-mutex": "^0.5.0",
-    "zod": "3.23.8",
-    "@synnaxlabs/freighter": "0.32.0",
-    "@synnaxlabs/x": "0.32.0"
+    "zod": "^3.23.8",
+    "@synnaxlabs/freighter": "0.33.0",
+    "@synnaxlabs/x": "0.33.0"
   },
   "devDependencies": {
-    "@types/node": "^22.5.4",
-    "@vitest/coverage-v8": "^2.1.0",
-    "eslint": "^9.10.0",
-    "typescript": "^5.6.2",
-    "vite": "5.4.4",
-    "vitest": "^2.1.0",
+    "@types/node": "^22.7.5",
+    "@vitest/coverage-v8": "^2.1.2",
+    "eslint": "^9.12.0",
+    "uuid": "^10.0.0",
+    "@types/uuid": "^10.0.0",
+    "typescript": "^5.6.3",
+    "vite": "^5.4.8",
+    "vitest": "^2.1.2",
     "@synnaxlabs/tsconfig": "0.0.2",
     "@synnaxlabs/vite-plugin": "0.0.1",
     "eslint-config-synnaxlabs": "0.0.1"
   },
-  "peerDependencies": {
-    "zod": "3.23.8"
-  },
   "type": "module",
   "types": "dist/index.d.ts",
   "module": "dist/client.js",

package/src/access/policy/policy.spec.ts

@@ -30,7 +30,7 @@ describe("Policy", () => {
           objects: [user.ONTOLOGY_TYPE, channel.ONTOLOGY_TYPE],
           actions: "delete",
         });
-        expect(policy.key).exist;
+        expect(policy.key).toBeDefined();
         expect(policy.subjects.length).toEqual(1);
         expect(policy.subjects[0].key).toEqual("");
         expect(policy.subjects[0].type).toEqual(user.ONTOLOGY_TYPE);
@@ -48,7 +48,7 @@ describe("Policy", () => {
           objects: [],
           actions: [],
         });
-        expect(policy.key).exist;
+        expect(policy.key).toBeDefined();
         expect(policy.subjects).toHaveLength(0);
         expect(policy.objects).toHaveLength(0);
         expect(policy.actions).toHaveLength(0);
@@ -61,7 +61,7 @@ describe("Policy", () => {
           objects: [],
           actions: [],
         });
-        expect(policy.key).exist;
+        expect(policy.key).toBeDefined();
         expect(policy.subjects.length).toEqual(1);
         expect(policy.subjects[0].key).toEqual("1");
         expect(policy.subjects[0].type).toEqual(user.ONTOLOGY_TYPE);
@@ -79,7 +79,7 @@ describe("Policy", () => {
           objects: { type: channel.ONTOLOGY_TYPE, key: "3" },
           actions: ["delete", "retrieve"],
         });
-        expect(policy.key).exist;
+        expect(policy.key).toBeDefined();
         expect(policy.subjects.length).toEqual(2);
         expect(policy.subjects[0].key).toEqual("1");
         expect(policy.subjects[0].type).toEqual(user.ONTOLOGY_TYPE);
@@ -134,7 +134,7 @@ describe("Policy", () => {
           },
         ]);
         expect(policies.length).toEqual(2);
-        expect(policies[0].key).exist;
+        expect(policies[0].key).toBeDefined();
         expect(policies[0].subjects.length).toEqual(1);
         expect(policies[0].subjects[0].key).toEqual("");
         expect(policies[0].subjects[0].type).toEqual(user.ONTOLOGY_TYPE);
@@ -144,7 +144,7 @@ describe("Policy", () => {
         expect(policies[0].objects[0].type).toEqual(user.ONTOLOGY_TYPE);
         expect(policies[0].objects[1].type).toEqual(schematic.ONTOLOGY_TYPE);
         expect(policies[0].actions).toEqual(["retrieve"]);
-        expect(policies[1].key).exist;
+        expect(policies[1].key).toBeDefined();
         expect(policies[1].subjects.length).toEqual(2);
         expect(policies[1].subjects[0].key).toEqual("");
         expect(policies[1].subjects[1].key).toEqual("");

package/src/channel/client.ts

@@ -237,7 +237,7 @@ export class Client implements AsyncTermSearcher<string, Key, Channel> {
    * channel. If this value is specified, the 'rate' parameter will be ignored.
    * @param isIndex - Set to true if the channel is an index channel, and false
    * otherwise. Index channels must have a data type of `DataType.TIMESTAMP`.
-   * @returns the created channel. {@see Channel}
+   * @returns the created channel. {@link Channel}
    * @throws {ValidationError} if any of the parameters for creating the channel are
    * invalid.
    *

package/src/control/state.ts

@@ -47,7 +47,7 @@ export class StateTracker
 
   constructor(streamer: FrameStreamer) {
     super(streamer, (frame) => {
-      const update: Update = this.codec.decode(frame.series[0].buffer);
+      const update: Update = this.codec.decode(frame.series[0].data);
       this.merge(update);
       return [update.transfers, true];
     });

package/src/errors.spec.ts

@@ -8,6 +8,8 @@
 // included in the file licenses/APL.txt.
 
 import { MatchableErrorType } from "@synnaxlabs/freighter/src/errors";
+import { id } from "@synnaxlabs/x";
+import { v4 as uuid } from "uuid";
 import { describe, expect, test } from "vitest";
 
 import {
@@ -24,6 +26,7 @@ import {
   UnexpectedError,
   ValidationError,
 } from "@/errors";
+import { newClient } from "@/setupspecs";
 
 describe("error", () => {
   describe("type matching", () => {
@@ -46,3 +49,19 @@ describe("error", () => {
     );
   });
 });
+
+const client = newClient();
+
+test("client", async () => {
+  expect.assertions(2);
+  try {
+    await client.channels.retrieve(id.id());
+  } catch (e) {
+    expect(NotFoundError.matches(e)).toBe(true);
+  }
+  try {
+    await client.workspaces.schematic.retrieve(uuid());
+  } catch (e) {
+    expect(NotFoundError.matches(e)).toBe(true);
+  }
+});

package/src/hardware/task/ni/types.ts

@@ -259,7 +259,7 @@ export const ZERO_AI_ACCEL_CHAN: AIAccelChan = {
 };
 
 // 2 - https://www.ni.com/docs/en-US/bundle/ni-daqmx-c-api-ref/page/daqmxcfunc/daqmxcreateaiaccel4wiredcvoltagechan.html
-const aiAccel4WireDCVoltageChanZ = baseAiAccelChanZ.extend({
+export const aiAccel4WireDCVoltageChanZ = baseAiAccelChanZ.extend({
   type: z.literal("ai_accel_4_wire_dc_voltage"),
   units: accelerationUnitsZ,
   voltageExcitSource: excitSourceZ,
@@ -290,7 +290,7 @@ export const ZERO_AI_ACCEL_4WIRE_DC_VOLTAGE_CHAN: AIAccel4WireDCVoltageChan = {
 };
 
 // 3 - https://www.ni.com/docs/en-US/bundle/ni-daqmx-c-api-ref/page/daqmxcfunc/daqmxcreateaiaccelchargechan.html
-const aiAccelChargeChanZ = baseAiAccelChanZ.extend({
+export const aiAccelChargeChanZ = baseAiAccelChanZ.extend({
   type: z.literal("ai_accel_charge"),
   units: accelerationUnitsZ,
   customScale: scaleZ,
@@ -354,7 +354,7 @@ export const ZERO_AI_BRIDGE_CHAN: AIBridgeChan = {
 };
 
 // 5 - https://www.ni.com/docs/en-US/bundle/ni-daqmx-c-api-ref/page/daqmxcfunc/daqmxcreateaichargechan.html
-const aiChargeChan = baseAIChanZ.extend({
+export const aiChargeChan = baseAIChanZ.extend({
   type: z.literal("ai_charge"),
   terminalConfig: terminalConfigZ,
   minVal: z.number(),
@@ -420,7 +420,7 @@ export const ZERO_AI_CURRENT_CHAN: AICurrentChan = {
 };
 
 // 7 - https://www.ni.com/docs/en-US/bundle/ni-daqmx-c-api-ref/page/daqmxcfunc/daqmxcreateaicurrentrmschan.html
-const aiCurrentRMSChanZ = baseAIChanZ.extend({
+export const aiCurrentRMSChanZ = baseAIChanZ.extend({
   type: z.literal("ai_current_rms"),
   terminalConfig: terminalConfigZ,
   minVal: z.number(),
@@ -450,7 +450,7 @@ export const ZERO_AI_CURRENT_RMS_CHAN: AICurrentRMSChan = {
 };
 
 // 8 - https://www.ni.com/docs/en-US/bundle/ni-daqmx-c-api-ref/page/daqmxcfunc/daqmxcreateaiforcebridgepolynomialchan.html
-const aiForceBridgePolynomialChanZ = baseAIChanZ.extend({
+export const aiForceBridgePolynomialChanZ = baseAIChanZ.extend({
   type: z.literal("ai_force_bridge_polynomial"),
   terminalConfig: terminalConfigZ,
   minVal: z.number(),
@@ -612,7 +612,7 @@ export const ZERO_AI_FORCE_IEPE_CHAN: AIForceEPEChan = {
 };
 
 // 12 - https://www.ni.com/docs/en-US/bundle/ni-daqmx-c-api-ref/page/daqmxcfunc/daqmxcreateaifreqvoltagechan.html
-const aiFreqVoltageChanZ = baseAIChanZ.extend({
+export const aiFreqVoltageChanZ = baseAIChanZ.extend({
   type: z.literal("ai_freq_voltage"),
   minVal: z.number(),
   maxVal: z.number(),
@@ -673,7 +673,7 @@ export const pressureUnitsZ = z.enum(["PoundsPerSquareInch", "Pascals", "Bar"]);
 export type PressureUnits = z.infer<typeof pressureUnitsZ>;
 
 // 14 - https://www.ni.com/docs/en-US/bundle/ni-daqmx-c-api-ref/page/daqmxcfunc/daqmxcreateaipressurebridgepolynomialchan.html
-const aiPressureBridgePolynomialChanZ = baseAIChanZ.extend({
+export const aiPressureBridgePolynomialChanZ = baseAIChanZ.extend({
   type: z.literal("ai_pressure_bridge_polynomial"),
   minVal: z.number(),
   maxVal: z.number(),
@@ -839,7 +839,7 @@ export const ZERO_AI_RESISTANCE_CHAN: AIResistanceChan = {
 };
 
 // 18 -  https://www.ni.com/docs/en-US/bundle/ni-daqmx-c-api-ref/page/daqmxcfunc/daqmxcreateairosettestraingagechan.html
-const aiRosetteStrainGageChanZ = baseAIChanZ.extend({
+export const aiRosetteStrainGageChanZ = baseAIChanZ.extend({
   type: z.literal("ai_rosette_strain_gage"),
   terminalConfig: terminalConfigZ,
   minVal: z.number(),
@@ -1065,7 +1065,7 @@ export const ZERO_AI_THERMOCOUPLE_CHAN: AIThermocoupleChan = {
 };
 
 // 23 - https://www.ni.com/docs/en-US/bundle/ni-daqmx-c-api-ref/page/daqmxcfunc/daqmxcreateaithrmstrchaniex.html
-const aiThermistorChanIex = baseAIChanZ.extend({
+export const aiThermistorChanIex = baseAIChanZ.extend({
   key: z.string(),
   type: z.literal("ai_thermistor_iex"),
   minVal: z.number(),
@@ -1100,7 +1100,7 @@ export const ZERO_AI_THERMISTOR_CHAN_IEX: AIThermistorChanIex = {
 };
 
 // 24 - https://www.ni.com/docs/en-US/bundle/ni-daqmx-c-api-ref/page/daqmxcfunc/daqmxcreateaitorquebridgepolynomialchan.html
-const aiThermistorChanVex = baseAIChanZ.extend({
+export const aiThermistorChanVex = baseAIChanZ.extend({
   key: z.string(),
   type: z.literal("ai_thermistor_vex"),
   minVal: z.number(),
@@ -1140,7 +1140,7 @@ export const torqueUnitsZ = z.enum(["NewtonMeters", "InchOunces", "FootPounds"])
 export type TorqueUnits = z.infer<typeof torqueUnitsZ>;
 
 // 25 - https://www.ni.com/docs/en-US/bundle/ni-daqmx-c-api-ref/page/daqmxcfunc/daqmxcreateaitorquebridgepolynomialchan.html
-const aiTorqueBridgePolynomialChanZ = baseAIChanZ.extend({
+export const aiTorqueBridgePolynomialChanZ = baseAIChanZ.extend({
   key: z.string(),
   type: z.literal("ai_torque_bridge_polynomial"),
   minVal: z.number(),
@@ -1345,7 +1345,7 @@ export const ZERO_AI_VOLTAGE_CHAN: AIVoltageChan = {
 };
 
 // 30 - https://www.ni.com/docs/en-US/bundle/ni-daqmx-c-api-ref/page/daqmxcfunc/daqmxcreateaivoltagermschan.html
-const aiVoltageRMSChanZ = baseAIChanZ.extend({
+export const aiVoltageRMSChanZ = baseAIChanZ.extend({
   key: z.string(),
   type: z.literal("ai_voltage_rms"),
   terminalConfig: terminalConfigZ,
@@ -1372,7 +1372,7 @@ export const ZERO_AI_VOLTAGE_RMS_CHAN: AIVoltageRMSChan = {
 };
 
 // 31 - https://www.ni.com/docs/en-US/bundle/ni-daqmx-c-api-ref/page/daqmxcfunc/daqmxcreateaivoltagechanwithexcit.html
-const aiVoltageChanWithExcitZ = baseAIChanZ.extend({
+export const aiVoltageChanWithExcitZ = baseAIChanZ.extend({
   type: z.literal("ai_voltage_with_excit"),
   terminalConfig: terminalConfigZ,
   minVal: z.number(),

package/src/index.ts

@@ -9,7 +9,7 @@
 
 export { access } from "@/access";
 export { policy } from "@/access/policy";
-export * from "@/channel";
+export { channel } from "@/channel";
 export { Channel } from "@/channel/client";
 export { default as Synnax, type SynnaxProps, synnaxPropsZ } from "@/client";
 export * from "@/connection";
@@ -37,6 +37,7 @@ export { signals } from "@/signals";
 export { user } from "@/user";
 export { workspace } from "@/workspace";
 export { linePlot } from "@/workspace/lineplot";
+export { log } from "@/workspace/log";
 export { schematic } from "@/workspace/schematic";
 export {
   type CrudeDataType,
@@ -48,7 +49,6 @@ export {
   DataType,
   Density,
   MultiSeries,
-  type NumericTelemValue,
   Rate,
   Series,
   type TelemValue,

package/src/ontology/client.ts

@@ -214,7 +214,7 @@ export class Client implements AsyncTermSearcher<string, string, Resource> {
   /**
    * Opens an observable that can be used to subscribe to changes in both the ontology's
    * resources and relationships.
-   * @see ChangeTracker for more information.
+   * @link ChangeTracker for more information.
    * @returns An observable that emits changes to the ontology's resources and relationships.
    */
   async openChangeTracker(): Promise<ChangeTracker> {

package/src/ontology/payload.ts

@@ -19,6 +19,7 @@ export type RelationshipDelete = change.Delete<Relationship, undefined>;
 
 export const resourceTypeZ = z.union([
   z.literal("label"),
+  z.literal("log"),
   z.literal("allow_all"),
   z.literal("builtin"),
   z.literal("cluster"),

package/src/workspace/client.ts

@@ -12,6 +12,7 @@ import { type UnknownRecord } from "@synnaxlabs/x/record";
 import { type AsyncTermSearcher } from "@synnaxlabs/x/search";
 
 import { linePlot } from "@/workspace/lineplot";
+import { log } from "@/workspace/log";
 import { type Key, type Workspace } from "@/workspace/payload";
 import { Retriever } from "@/workspace/retriever";
 import { schematic } from "@/workspace/schematic";
@@ -21,6 +22,7 @@ export class Client implements AsyncTermSearcher<string, Key, Workspace> {
   readonly type = "workspace";
   readonly schematic: schematic.Client;
   readonly linePlot: linePlot.Client;
+  readonly log: log.Client;
   private readonly retriever: Retriever;
   private readonly writer: Writer;
 
@@ -28,6 +30,7 @@ export class Client implements AsyncTermSearcher<string, Key, Workspace> {
     this.schematic = new schematic.Client(client);
     this.linePlot = new linePlot.Client(client);
     this.retriever = new Retriever(client);
+    this.log = new log.Client(client);
     this.writer = new Writer(client);
   }
 

package/src/workspace/log/client.ts

@@ -0,0 +1,51 @@
+// 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 { type UnaryClient } from "@synnaxlabs/freighter";
+import { type UnknownRecord } from "@synnaxlabs/x/record";
+
+import { type Key, type Log, type Params } from "@/workspace/log/payload";
+import { Retriever } from "@/workspace/log/retriever";
+import { type NewLog, Writer } from "@/workspace/log/writer";
+
+export class Client {
+  private readonly writer: Writer;
+  private readonly retriever: Retriever;
+
+  constructor(client: UnaryClient) {
+    this.writer = new Writer(client);
+    this.retriever = new Retriever(client);
+  }
+
+  async create(workspace: string, log: NewLog): Promise<Log> {
+    return await this.writer.create(workspace, log);
+  }
+
+  async rename(key: Key, name: string): Promise<void> {
+    await this.writer.rename(key, name);
+  }
+
+  async setData(key: Key, data: UnknownRecord): Promise<void> {
+    await this.writer.setData(key, data);
+  }
+
+  async retrieve(key: Key): Promise<Log>;
+
+  async retrieve(keys: Key[]): Promise<Log[]>;
+
+  async retrieve(keys: Params): Promise<Log | Log[]> {
+    const isMany = Array.isArray(keys);
+    const res = await this.retriever.retrieve(keys);
+    return isMany ? res : res[0];
+  }
+
+  async delete(keys: Params): Promise<void> {
+    await this.writer.delete(keys);
+  }
+}

package/src/workspace/log/external.ts

@@ -0,0 +1,11 @@
+// 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.
+
+export * from "@/workspace/log/client";
+export * from "@/workspace/log/payload";

package/src/workspace/log/index.ts

@@ -0,0 +1,10 @@
+// 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.
+
+export * as log from "@/workspace/log/external";

package/src/workspace/log/log.spec.ts

@@ -0,0 +1,78 @@
+// 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 { describe, expect, test } from "vitest";
+
+import { newClient } from "@/setupspecs";
+
+const client = newClient();
+
+const ZERO_UUID = "00000000-0000-0000-0000-000000000000";
+
+describe("Log", () => {
+  describe("create", () => {
+    test("create one", async () => {
+      const ws = await client.workspaces.create({
+        name: "Log",
+        layout: { one: 1 },
+      });
+      const log = await client.workspaces.log.create(ws.key, {
+        name: "Log",
+        data: { one: 1 },
+      });
+      expect(log.name).toEqual("Log");
+      expect(log.key).not.toEqual(ZERO_UUID);
+      expect(log.data.one).toEqual(1);
+    });
+  });
+  describe("rename", () => {
+    test("rename one", async () => {
+      const ws = await client.workspaces.create({
+        name: "Log",
+        layout: { one: 1 },
+      });
+      const log = await client.workspaces.log.create(ws.key, {
+        name: "Log",
+        data: { one: 1 },
+      });
+      await client.workspaces.log.rename(log.key, "Log2");
+      const res = await client.workspaces.log.retrieve(log.key);
+      expect(res.name).toEqual("Log2");
+    });
+  });
+  describe("setData", () => {
+    test("set data", async () => {
+      const ws = await client.workspaces.create({
+        name: "Log",
+        layout: { one: 1 },
+      });
+      const log = await client.workspaces.log.create(ws.key, {
+        name: "Log",
+        data: { one: 1 },
+      });
+      await client.workspaces.log.setData(log.key, { two: 2 });
+      const res = await client.workspaces.log.retrieve(log.key);
+      expect(res.data.two).toEqual(2);
+    });
+  });
+  describe("delete", () => {
+    test("delete one", async () => {
+      const ws = await client.workspaces.create({
+        name: "Log",
+        layout: { one: 1 },
+      });
+      const log = await client.workspaces.log.create(ws.key, {
+        name: "Log",
+        data: { one: 1 },
+      });
+      await client.workspaces.log.delete(log.key);
+      await expect(client.workspaces.log.retrieve(log.key)).rejects.toThrow();
+    });
+  });
+});

package/src/workspace/log/payload.ts

@@ -0,0 +1,36 @@
+// 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 { type UnknownRecord, unknownRecordZ } from "@synnaxlabs/x/record";
+import { z } from "zod";
+
+import { ontology } from "@/ontology";
+
+export const keyZ = z.string().uuid();
+export type Key = z.infer<typeof keyZ>;
+export type Params = Key | Key[];
+
+export const logZ = z.object({
+  key: z.string(),
+  name: z.string(),
+  data: unknownRecordZ.or(z.string().transform((s) => JSON.parse(s) as UnknownRecord)),
+});
+
+export const logRemoteZ = z.object({
+  key: z.string(),
+  name: z.string(),
+  data: z.string().transform((s) => JSON.parse(s) as UnknownRecord),
+});
+
+export type Log = z.infer<typeof logZ>;
+
+export const ONTOLOGY_TYPE: ontology.ResourceType = "log";
+
+export const ontologyID = (key: Key): ontology.ID =>
+  new ontology.ID({ type: ONTOLOGY_TYPE, key: key });

package/src/workspace/log/retriever.ts

@@ -0,0 +1,38 @@
+// 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 { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
+import { toArray } from "@synnaxlabs/x/toArray";
+import { z } from "zod";
+
+import { type Log, logRemoteZ, type Params } from "@/workspace/log/payload";
+
+const reqZ = z.object({ keys: z.string().array() });
+const resZ = z.object({ logs: logRemoteZ.array() });
+
+export class Retriever {
+  private readonly ENDPOINT = "/workspace/log/retrieve";
+  private readonly client: UnaryClient;
+
+  constructor(client: UnaryClient) {
+    this.client = client;
+  }
+
+  async retrieve(logs: Params): Promise<Log[]> {
+    return (
+      await sendRequired(
+        this.client,
+        this.ENDPOINT,
+        { keys: toArray(logs) },
+        reqZ,
+        resZ,
+      )
+    ).logs;
+  }
+}