@synnaxlabs/client 0.41.0 → 0.42.0

package/src/hardware/device/payload.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 { binary, type UnknownRecord } from "@synnaxlabs/x";
+import { binary, type UnknownRecord, unknownRecordZ } from "@synnaxlabs/x";
 import { z } from "zod";
 
 import { keyZ as rackKeyZ } from "@/hardware/rack/payload";
@@ -19,7 +19,7 @@ export type Key = z.infer<typeof keyZ>;
 export const stateZ = z.object({
   key: keyZ,
   variant: z.string(),
-  details: z.record(z.unknown()).or(z.string().transform(decodeJSONString)),
+  details: unknownRecordZ.or(z.string().transform(decodeJSONString)),
 });
 
 export interface State<Details extends {} = UnknownRecord>
@@ -35,7 +35,7 @@ export const deviceZ = z.object({
   model: z.string(),
   location: z.string(),
   configured: z.boolean().optional(),
-  properties: z.record(z.unknown()).or(z.string().transform(decodeJSONString)),
+  properties: unknownRecordZ.or(z.string().transform(decodeJSONString)),
   state: stateZ.optional(),
 });
 

package/src/hardware/task/payload.ts

@@ -7,7 +7,12 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { binary, type observe, type UnknownRecord } from "@synnaxlabs/x";
+import {
+  binary,
+  type observe,
+  type UnknownRecord,
+  unknownRecordZ,
+} from "@synnaxlabs/x";
 import { z } from "zod";
 
 import { type Key as RackKey } from "@/hardware/rack/payload";
@@ -28,8 +33,7 @@ export const stateZ = z.object({
   task: keyZ,
   variant: statusZ,
   key: z.string().optional(),
-  details: z
-    .record(z.unknown())
+  details: unknownRecordZ
     .or(z.string().transform(parseWithoutKeyConversion))
     .or(z.array(z.unknown()))
     .or(z.null()) as z.ZodType<UnknownRecord | undefined>,
@@ -44,7 +48,7 @@ export const taskZ = z.object({
   name: z.string(),
   type: z.string(),
   internal: z.boolean().optional(),
-  config: z.record(z.unknown()).or(z.string().transform(decodeJSONString)),
+  config: unknownRecordZ.or(z.string().transform(decodeJSONString)),
   state: stateZ.optional().nullable(),
   snapshot: z.boolean().optional(),
 });
@@ -74,8 +78,7 @@ export const commandZ = z.object({
   task: keyZ,
   type: z.string(),
   key: z.string(),
-  args: z
-    .record(z.unknown())
+  args: unknownRecordZ
     .or(z.string().transform(parseWithoutKeyConversion))
     .or(z.array(z.unknown()))
     .or(z.null())

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

@@ -98,7 +98,7 @@ describe("Task", async () => {
           task: t.key,
           variant: "success",
         };
-        expect(await w.write("sy_task_state", [state])).toBeTruthy();
+        await w.write("sy_task_state", [state]);
         await w.close();
         await expect
           .poll(async () => {

package/src/index.ts

@@ -61,5 +61,3 @@ export {
   type TypedArray,
   type TZInfo,
 } from "@synnaxlabs/x/telem";
-import { control } from "@synnaxlabs/x";
-export const Authority = control.Authority;

package/src/ontology/group/group.spec.ts

@@ -9,7 +9,7 @@
 
 import { describe, expect, it } from "vitest";
 
-import { QueryError } from "@/errors";
+import { NotFoundError } from "@/errors";
 import { ontology } from "@/ontology";
 import { newClient } from "@/setupspecs";
 
@@ -40,7 +40,7 @@ describe("Group", () => {
       await client.ontology.groups.delete(g.key);
       await expect(
         async () => await client.ontology.retrieve(g.ontologyID),
-      ).rejects.toThrow(QueryError);
+      ).rejects.toThrowError(NotFoundError);
     });
   });
 });

package/src/ontology/payload.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 { type change, type UnknownRecord } from "@synnaxlabs/x";
+import { type change, type UnknownRecord, unknownRecordZ } from "@synnaxlabs/x";
 import { z } from "zod";
 
 import {
@@ -124,7 +124,7 @@ export interface SchemaField extends z.infer<typeof schemaFieldZ> {}
 
 export const schemaZ = z.object({
   type: resourceTypeZ,
-  fields: z.record(schemaFieldZ),
+  fields: z.record(z.string(), schemaFieldZ),
 });
 export interface Schema extends z.infer<typeof schemaZ> {}
 
@@ -133,7 +133,7 @@ export const resourceZ = z
     id: ID.z,
     name: z.string(),
     schema: schemaZ.optional().nullable(),
-    data: z.record(z.unknown()).optional().nullable(),
+    data: unknownRecordZ.optional().nullable(),
   })
   .transform((resource) => ({ key: resource.id.toString(), ...resource }));
 export interface Resource<T extends UnknownRecord = UnknownRecord>

package/src/ranger/ranger.spec.ts

@@ -8,10 +8,10 @@
 // included in the file licenses/APL.txt.
 
 import { type change } from "@synnaxlabs/x";
-import { DataType, Rate, TimeSpan, TimeStamp } from "@synnaxlabs/x/telem";
+import { DataType, TimeSpan, TimeStamp } from "@synnaxlabs/x/telem";
 import { describe, expect, it } from "vitest";
 
-import { QueryError } from "@/errors";
+import { NotFoundError } from "@/errors";
 import { type ranger } from "@/ranger";
 import { newClient } from "@/setupspecs";
 
@@ -74,7 +74,7 @@ describe("Ranger", () => {
       });
       await client.ranges.delete(range.key);
       await expect(async () => await client.ranges.retrieve(range.key)).rejects.toThrow(
-        QueryError,
+        NotFoundError,
       );
     });
   });
@@ -172,7 +172,9 @@ describe("Ranger", () => {
       const val = await rng.kv.get("foo");
       expect(val).toEqual("bar");
       await rng.kv.delete("foo");
-      await expect(async () => await rng.kv.get("foo")).rejects.toThrow(QueryError);
+      await expect(async () => await rng.kv.get("foo")).rejects.toThrowError(
+        NotFoundError,
+      );
     });
 
     it("should set and get multiple keys", async () => {
@@ -240,7 +242,7 @@ describe("Ranger", () => {
         const ch = await client.channels.create({
           name: "My New Channel",
           dataType: DataType.FLOAT32,
-          rate: Rate.hz(1),
+          virtual: true,
         });
         const rng = await client.ranges.create({
           name: "My New One Second Range",
@@ -256,7 +258,7 @@ describe("Ranger", () => {
         const ch = await client.channels.create({
           name: "My New Channel",
           dataType: DataType.FLOAT32,
-          rate: Rate.hz(1),
+          virtual: true,
         });
         const rng = await client.ranges.create({
           name: "My New One Second Range",
@@ -272,7 +274,7 @@ describe("Ranger", () => {
         const ch = await client.channels.create({
           name: "My New Channel",
           dataType: DataType.FLOAT32,
-          rate: Rate.hz(1),
+          virtual: true,
         });
         const rng = await client.ranges.create({
           name: "My New One Second Range",

package/src/testutil/indexedPair.ts

@@ -0,0 +1,40 @@
+// 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 { DataType, id } from "@synnaxlabs/x";
+
+import { type channel } from "@/channel";
+import type Synnax from "@/client";
+
+export const newIndexedPair = async (
+  client: Synnax,
+): Promise<[channel.Channel, channel.Channel]> => {
+  const index = await client.channels.create({
+    leaseholder: 1,
+    name: `test-${id.create()}`,
+    dataType: DataType.TIMESTAMP,
+    isIndex: true,
+  });
+  const data = await client.channels.create({
+    leaseholder: 1,
+    name: `test-${id.create()}`,
+    dataType: DataType.FLOAT64,
+    index: index.key,
+  });
+  return [index, data];
+};
+
+export const newVirtualChannel = async (client: Synnax): Promise<channel.Channel> => {
+  const ch = await client.channels.create({
+    name: `test-${id.create()}`,
+    dataType: DataType.FLOAT64,
+    virtual: true,
+  });
+  return ch;
+};

package/src/testutil/telem.ts

@@ -0,0 +1,13 @@
+// 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 { TimeStamp } from "@synnaxlabs/x";
+
+export const secondsLinspace = (start: number, n: number): TimeStamp[] =>
+  Array.from({ length: n }, (_, i) => start + i).map((n) => TimeStamp.seconds(n));

package/src/transport.ts

@@ -10,7 +10,6 @@
 import {
   HTTPClient,
   type Middleware,
-  type StreamClient,
   type UnaryClient,
   unaryWithBreaker,
   WebSocketClient,
@@ -24,7 +23,7 @@ const baseAPIEndpoint = "/api/v1/";
 export class Transport {
   readonly url: URL;
   readonly unary: UnaryClient;
-  readonly stream: StreamClient;
+  readonly stream: WebSocketClient;
   readonly secure: boolean;
 
   constructor(url: URL, breakerCfg: breaker.Config = {}, secure: boolean = false) {

package/src/util/decodeJSONString.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 { binary, type UnknownRecord } from "@synnaxlabs/x";
+import { binary, type UnknownRecord, unknownRecordZ } from "@synnaxlabs/x";
 
 export const decodeJSONString = (s: string): UnknownRecord =>
-  s ? binary.JSON_CODEC.decodeString(s) : {};
+  s ? binary.JSON_CODEC.decodeString(s, unknownRecordZ) : {};

package/src/util/retrieve.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 { type Primitive } from "@synnaxlabs/x";
 import { describe, expect, it } from "vitest";
-import { type Primitive } from "zod";
 
 import {
   analyzeParams,