@synnaxlabs/client 0.16.3 → 0.17.0

package/examples/{package.json → node/package.json}

@@ -1,16 +1,16 @@
 {
   "name": "examples",
-  "type":"module",
+  "type": "module",
   "version": "1.0.0",
   "description": "",
   "main": "index.js",
   "scripts": {
     "main": "node index.js"
   },
-  "dependencies": {
-    "@synnaxlabs/client": "workspace:*"
-  },
   "keywords": [],
   "author": "",
-  "license": "ISC"
+  "license": "ISC",
+  "dependencies": {
+    "@synnaxlabs/client": "^0.16.4"
+  }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@synnaxlabs/client",
   "private": false,
-  "version": "0.16.3",
+  "version": "0.17.0",
   "type": "module",
   "description": "The Client Library for Synnax",
   "repository": "https://github.com/synnaxlabs/synnax/tree/main/client/ts",
@@ -18,8 +18,8 @@
   "dependencies": {
     "async-mutex": "^0.4.0",
     "zod": "3.22.4",
-    "@synnaxlabs/freighter": "0.7.1",
-    "@synnaxlabs/x": "0.12.0"
+    "@synnaxlabs/freighter": "0.9.1",
+    "@synnaxlabs/x": "0.14.1"
   },
   "devDependencies": {
     "@types/node": "^20.10.5",
@@ -28,8 +28,8 @@
     "vite": "^5.1.2",
     "vitest": "^1.2.2",
     "@synnaxlabs/tsconfig": "0.0.2",
-    "@synnaxlabs/vite-plugin": "0.0.1",
-    "eslint-config-synnaxlabs": "0.0.1"
+    "eslint-config-synnaxlabs": "0.0.1",
+    "@synnaxlabs/vite-plugin": "0.0.1"
   },
   "main": "dist/client.cjs",
   "module": "dist/client.js",

package/src/auth/auth.ts

@@ -47,18 +47,19 @@ export class Client {
   authenticated: boolean;
   user: user.Payload | undefined;
 
-  constructor(client: UnaryClient, creds: InsecureCredentials) {
+  constructor(client: UnaryClient, credentials: InsecureCredentials) {
     this.client = client;
     this.authenticated = false;
-    this.authenticate(creds);
+    this.authenticate(credentials);
   }
 
-  authenticate(creds: InsecureCredentials): void {
+  authenticate(credentials: InsecureCredentials): void {
     this.authenticating = new Promise((resolve, reject) => {
       this.client
         .send<typeof insecureCredentialsZ, typeof tokenResponseZ>(
           LOGIN_ENDPOINT,
-          creds,
+          credentials,
+          insecureCredentialsZ,
           tokenResponseZ,
         )
         .then(([res, err]) => {

package/src/channel/client.ts

@@ -244,7 +244,6 @@ export class Client implements AsyncTermSearcher<string, Key, Channel> {
   async create(channels: NewPayload[]): Promise<Channel[]>;
 
   async create(channels: NewPayload | NewPayload[]): Promise<Channel | Channel[]> {
-    console.log("ABC");
     const single = !Array.isArray(channels);
     const payloads = await this.creator.create(toArray(channels));
     const res = this.sugar(payloads);

package/src/channel/creator.ts

@@ -35,6 +35,7 @@ export class Creator {
     const [res, err] = await this.client.send<typeof reqZ, typeof resZ>(
       Creator.ENDPOINT,
       req,
+      reqZ,
       resZ,
     );
     if (err != null) throw err;

package/src/channel/retriever.ts

@@ -33,7 +33,7 @@ const reqZ = z.object({
   offset: z.number().optional(),
 });
 
-type Request = z.infer<typeof reqZ>;
+type Request = z.input<typeof reqZ>;
 
 const resZ = z.object({
   channels: payload.array(),
@@ -67,7 +67,7 @@ export class ClusterRetriever implements Retriever {
   }
 
   private async execute(request: Request): Promise<Payload[]> {
-    const [res, err] = await this.client.send(ClusterRetriever.ENDPOINT, request, resZ);
+    const [res, err] = await this.client.send(ClusterRetriever.ENDPOINT, request, reqZ, resZ);
     if (err != null) throw err;
     return res.channels;
   }

package/src/client.ts

@@ -48,19 +48,19 @@ export type ParsedSynnaxProps = z.output<typeof synnaxPropsZ>;
  */
 // eslint-disable-next-line import/no-default-export
 export default class Synnax {
-  private readonly transport: Transport;
   readonly createdAt: TimeStamp;
+  readonly props: ParsedSynnaxProps;
   readonly telem: framer.Client;
   readonly ranges: ranger.Client;
   readonly channels: channel.Client;
   readonly auth: auth.Client | undefined;
   readonly connectivity: connection.Checker;
   readonly ontology: ontology.Client;
-  readonly props: ParsedSynnaxProps;
   readonly workspaces: workspace.Client;
   readonly labels: label.Client;
   readonly hardware: hardware.Client;
   static readonly connectivity = connection.Checker;
+  private readonly transport: Transport;
 
   /**
    * @param props.host - Hostname of a node in the cluster.

package/src/connection/checker.ts

@@ -52,7 +52,11 @@ export class Checker {
    * @param pollFreq - The frequency at which to poll the cluster for
    *   connectivity information.
    */
-  constructor(client: UnaryClient, pollFreq: TimeSpan = TimeSpan.seconds(30), name?: string) {
+  constructor(
+    client: UnaryClient,
+    pollFreq: TimeSpan = TimeSpan.seconds(30),
+    name?: string,
+  ) {
     this._state = { ...DEFAULT };
     this.client = client;
     this.pollFrequency = pollFreq;
@@ -73,7 +77,7 @@ export class Checker {
   async check(): Promise<State> {
     const prevStatus = this._state.status;
     try {
-      const [res, err] = await this.client.send(Checker.ENDPOINT, null, responseZ);
+      const [res, err] = await this.client.send(Checker.ENDPOINT, {}, z.object({}), responseZ);
       if (err != null) throw err;
       this._state.status = "connected";
       this._state.message = `Connected to ${this.name ?? "cluster"}`;

package/src/framer/client.ts

@@ -96,8 +96,8 @@ export class Client {
     });
     try {
       await w.write(to, data);
-      if (!(await w.commit())) throw (await w.error()) as Error;
-    } catch {
+      await w.commit();
+    } finally {
       await w.close();
     }
   }
@@ -116,7 +116,11 @@ export class Client {
   private async readFrame(tr: TimeRange, params: Params): Promise<Frame> {
     const i = await this.newIterator(tr, params);
     const frame = new Frame();
-    for await (const f of i) frame.push(f);
+    try {
+      for await (const f of i) frame.push(f);
+    } finally {
+      await i.close();
+    }
     return frame;
   }
 }

package/src/framer/frame.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 { Size, Series, TimeRange, toArray, DataType, unique } from "@synnaxlabs/x";
+import { Size, Series, TimeRange, toArray, DataType, unique, TimeStamp } from "@synnaxlabs/x";
 import { z } from "zod";
 
 import {
@@ -222,7 +222,7 @@ 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
-   * gaps betwen them.
+   * gaps between them.
    */
   get isWeaklyAligned(): boolean {
     if (this.columns.length <= 1) return true;
@@ -233,8 +233,8 @@ export class Frame {
   timeRange(col?: KeyOrName): TimeRange {
     if (col == null) {
       if (this.columns.length === 0) return TimeRange.ZERO;
-      const start = Math.min(...this.series.map((a) => a.timeRange.start.valueOf()));
-      const end = Math.max(...this.series.map((a) => a.timeRange.end.valueOf()));
+      const start = TimeStamp.min(...this.series.map((a) => a.timeRange.start));
+      const end = TimeStamp.max(...this.series.map((a) => a.timeRange.end));
       return new TimeRange(start, end);
     }
     const group = this.get(col);

package/src/hardware/device/retriever.ts

@@ -37,7 +37,7 @@ export class Retriever {
     const res = await sendRequired<
       typeof retrieveDeviceReqZ,
       typeof retrieveDeviceResZ
-    >(this.client, RETRIEVE_ENDPOINT, { keys: [term] }, retrieveDeviceResZ);
+    >(this.client, RETRIEVE_ENDPOINT, { keys: [term] }, retrieveDeviceReqZ, retrieveDeviceResZ);
     return res.devices;
   }
 
@@ -45,7 +45,7 @@ export class Retriever {
     const res = await sendRequired<
       typeof retrieveDeviceReqZ,
       typeof retrieveDeviceResZ
-    >(this.client, RETRIEVE_ENDPOINT, { offset, limit }, retrieveDeviceResZ);
+    >(this.client, RETRIEVE_ENDPOINT, { offset, limit }, retrieveDeviceReqZ, retrieveDeviceResZ);
     return res.devices;
   }
   
@@ -54,7 +54,7 @@ export class Retriever {
     const res = await sendRequired<
       typeof retrieveDeviceReqZ,
       typeof retrieveDeviceResZ
-    >(this.client, RETRIEVE_ENDPOINT, { keys }, retrieveDeviceResZ);
+    >(this.client, RETRIEVE_ENDPOINT, { keys }, retrieveDeviceReqZ, retrieveDeviceResZ);
     return res.devices;
   }
 }

package/src/hardware/device/writer.ts

@@ -40,7 +40,8 @@ export class Writer {
     const res = await sendRequired<typeof createReqZ, typeof createResZ>(
       this.client,
       CREATE_ENDPOINT,
-      createReqZ.parse({ devices }),
+      { devices },
+      createReqZ,
       createResZ,
     );
     return res.devices;
@@ -51,6 +52,7 @@ export class Writer {
       this.client,
       DELETE_ENDPOINT,
       { keys },
+      deleteReqZ,
       deleteResZ,
     );
   }

package/src/hardware/rack/client.ts

@@ -74,7 +74,7 @@ export class Rack {
   key: number;
   name: string;
   private readonly writer: TaskWriter;
-  private readonly retriever: TaskRetriever;
+  private readonly tasks: TaskRetriever;
 
   constructor(
     key: number,
@@ -85,11 +85,11 @@ export class Rack {
     this.key = key;
     this.name = name;
     this.writer = _writer;
-    this.retriever = _retriever;
+    this.tasks = _retriever;
   }
 
   async listTasks(): Promise<Task[]> {
-    return await this.retriever.retrieve({ rack: this.key });
+    return await this.tasks.retrieve({ rack: this.key });
   }
 
   async retrieveTasks(): Promise<Task[]> {
@@ -97,7 +97,6 @@ export class Rack {
   }
 
   async createTask(task: NewTask): Promise<Task> {
-    // @ts-expect-error
     task.key = (
       (BigInt(this.key) << 32n) +
       (BigInt(task.key ?? 0) & 0xffffffffn)

package/src/hardware/rack/retriever.ts

@@ -38,6 +38,7 @@ export class Retriever {
       this.client,
       RETRIEVE_ENDPOINT,
       { offset, limit },
+      retrieveRackReqZ,
       retrieveRackResZ,
     );
     return res.racks;
@@ -48,6 +49,7 @@ export class Retriever {
       this.client,
       RETRIEVE_ENDPOINT,
       { search: term },
+      retrieveRackReqZ,
       retrieveRackResZ,
     );
     return res.racks;
@@ -58,6 +60,7 @@ export class Retriever {
       this.client,
       RETRIEVE_ENDPOINT,
       { keys },
+      retrieveRackReqZ,
       retrieveRackResZ,
     );
     return res.racks;

package/src/hardware/rack/writer.ts

@@ -40,6 +40,7 @@ export class Writer {
             this.client,
             CREATE_RACK_ENDPOINT,
             { racks },
+            createReqZ,
             createResZ,
         );
         return res.racks;
@@ -50,6 +51,7 @@ export class Writer {
             this.client,
             DELETE_RACK_ENDPOINT,
             { keys },
+            deleteReqZ,
             deleteResZ,
         );
     }

package/src/hardware/task/payload.ts

@@ -10,10 +10,11 @@
 import { type UnknownRecord } from "@synnaxlabs/x";
 import { z } from "zod";
 
-export const taskKeyZ = z
-  .bigint()
-  .or(z.number())
-  .transform((k) => k.toString());
+export const taskKeyZ = z.union([
+  z.string(),
+  z.bigint().transform((k) => k.toString()),
+  z.number().transform((k) => k.toString()),
+])
 
 export type TaskKey = z.infer<typeof taskKeyZ>;
 

package/src/hardware/task/retriever.ts

@@ -20,7 +20,7 @@ const retrieveReqZ = z.object({
   limit: z.number().optional(),
 });
 
-const rerieveResS = z.object({
+const retrieveResZ = z.object({
   tasks: z.union([taskZ.array(), z.null().transform(() => [])]),
 });
 
@@ -36,31 +36,34 @@ export class Retriever {
   }
 
   async retrieve(params: RetrieveRequest): Promise<Task[]> {
-    const res = await sendRequired<typeof retrieveReqZ, typeof rerieveResS>(
+    const res = await sendRequired<typeof retrieveReqZ, typeof retrieveResZ>(
       this.client,
       RETRIEVE_ENDPOINT,
       params,
-      rerieveResS,
+      retrieveReqZ,
+      retrieveResZ,
     );
     return res.tasks;
   }
 
   async search(term: string): Promise<Task[]> {
-    const res = await sendRequired<typeof retrieveReqZ, typeof rerieveResS>(
+    const res = await sendRequired<typeof retrieveReqZ, typeof retrieveResZ>(
       this.client,
       RETRIEVE_ENDPOINT,
       { keys: [term] },
-      rerieveResS,
+      retrieveReqZ,
+      retrieveResZ,
     );
     return res.tasks;
   }
 
   async page(offset: number, limit: number): Promise<Task[]> {
-    const res = await sendRequired<typeof retrieveReqZ, typeof rerieveResS>(
+    const res = await sendRequired<typeof retrieveReqZ, typeof retrieveResZ>(
       this.client,
       RETRIEVE_ENDPOINT,
       { offset, limit },
-      rerieveResS,
+      retrieveReqZ,
+      retrieveResZ,
     );
     return res.tasks;
   }

package/src/hardware/task/writer.ts

@@ -46,7 +46,8 @@ export class Writer {
     const res = await sendRequired<typeof createReqZ, typeof createResZ>(
       this.client,
       CREATE_ENDPOINT,
-      { tasks: tasks.map((t) => ({ ...t, config: JSON.stringify(t.config) })) },
+      { tasks },
+      createReqZ,
       createResZ,
     );
     return res.tasks;
@@ -57,6 +58,7 @@ export class Writer {
       this.client,
       DELETE_ENDPOINT,
       { keys },
+      deleteReqZ,
       deleteResZ,
     );
   }

package/src/label/retriever.ts

@@ -57,6 +57,7 @@ export class Retriever {
     const [res, err] = await this.client.send<typeof reqZ, typeof resZ>(
       Retriever.ENDPOINT,
       req,
+      reqZ,
       resZ,
     );
     if (err != null) throw err;

package/src/label/writer.ts

@@ -56,6 +56,7 @@ export class Writer {
       this.client,
       CREATE_ENDPOINT,
       { labels: toArray(labels) },
+      createReqZ,
       createResZ,
     );
     return res.labels;
@@ -66,6 +67,7 @@ export class Writer {
       this.client,
       DELETE_ENDPOINT,
       { keys: toArray(keys) },
+      deleteReqZ,
       emptyResZ,
     );
   }
@@ -75,6 +77,7 @@ export class Writer {
       this.client,
       SET_ENDPOINT,
       { id, labels },
+      setReqZ,
       emptyResZ,
     );
   }
@@ -84,6 +87,7 @@ export class Writer {
       this.client,
       REMOVE_ENDPOINT,
       { id, labels },
+      removeReqZ,
       emptyResZ,
     );
   }

package/src/ontology/group/writer.ts

@@ -11,12 +11,26 @@ import { type UnaryClient } from "@synnaxlabs/freighter";
 import { z } from "zod";
 
 import { type Payload, payloadZ } from "@/ontology/group/payload";
-import { type ID } from "@/ontology/payload";
+import { idZ, type ID } from "@/ontology/payload";
 
 const resZ = z.object({
   group: payloadZ,
 });
 
+const createReqZ = z.object({
+  parent: idZ,
+  name: z.string(),
+});
+
+const renameReqZ = z.object({
+  key: z.string(),
+  name: z.string(),
+});
+
+const deleteReqZ = z.object({
+  keys: z.array(z.string()),
+});
+
 export class Writer {
   private static readonly ENDPOINT = "/ontology/create-group";
   private static readonly ENDPOINT_RENAME = "/ontology/rename-group";
@@ -28,21 +42,20 @@ export class Writer {
   }
 
   async create(parent: ID, name: string): Promise<Payload> {
-    const req = { parent, name };
-    const [res, err] = await this.client.send(Writer.ENDPOINT, req, resZ);
+    const [res, err] = await this.client.send(Writer.ENDPOINT, {parent, name},createReqZ, resZ);
     if (err != null) throw err;
     return res.group;
   }
 
   async rename(key: string, name: string): Promise<void> {
     const req = { key, name };
-    const [, err] = await this.client.send(Writer.ENDPOINT_RENAME, req, z.object({}));
+    const [, err] = await this.client.send(Writer.ENDPOINT_RENAME, req, renameReqZ, z.object({}));
     if (err != null) throw err;
   }
 
   async delete(keys: string[]): Promise<void> {
     const req = { keys };
-    const [, err] = await this.client.send(Writer.ENDPOINT_DELETE, req, z.object({}));
+    const [, err] = await this.client.send(Writer.ENDPOINT_DELETE, req, deleteReqZ, z.object({}));
     if (err != null) throw err;
   }
 }

package/src/ontology/retriever.ts

@@ -7,13 +7,13 @@
 // 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 { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
 import { toArray } from "@synnaxlabs/x";
 import { z } from "zod";
 
 import { ID, type Resource, idZ, resourceSchemaZ } from "@/ontology/payload";
 
-const requestSchema = z.object({
+const reqZ = z.object({
   ids: idZ.array().optional(),
   children: z.boolean().optional(),
   parents: z.boolean().optional(),
@@ -22,9 +22,9 @@ const requestSchema = z.object({
   term: z.string().optional(),
 });
 
-type Request = z.infer<typeof requestSchema>;
+type Request = z.infer<typeof reqZ>;
 
-const responseSchema = z.object({
+const resZ = z.object({
   resources: resourceSchemaZ.array(),
 });
 
@@ -80,12 +80,12 @@ export class Retriever {
   }
 
   private async execute(request: Request): Promise<Resource[]> {
-    const [res, err] = await this.client.send(
+    return (await sendRequired(
+      this.client,
       Retriever.ENDPOINT,
       request,
-      responseSchema,
-    );
-    if (err != null) throw err;
-    return res.resources;
+      reqZ,
+      resZ,
+    )).resources;
   }
 }

package/src/ontology/writer.ts

@@ -7,10 +7,10 @@
 // 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 { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
 import { z } from "zod";
 
-import { type ID } from "@/ontology/payload";
+import { idZ, type ID } from "@/ontology/payload";
 
 const ENDPOINTS = {
   ADD_CHILDREN: "/ontology/add-children",
@@ -18,6 +18,17 @@ const ENDPOINTS = {
   MOVE_CHILDREN: "/ontology/move-children",
 };
 
+const addRemoveChildrenReqZ = z.object({
+  id: idZ,
+  children: idZ.array(),
+});
+
+const moveChildrenReqZ = z.object({
+  from: idZ,
+  to: idZ,
+  children: idZ.array(),
+});
+
 export class Writer {
   client: UnaryClient;
 
@@ -26,24 +37,27 @@ export class Writer {
   }
 
   async addChildren(id: ID, ...children: ID[]): Promise<void> {
-    const req = { id, children };
-    const [, err] = await this.client.send(ENDPOINTS.ADD_CHILDREN, req, z.object({}));
-    if (err != null) throw err;
+    await sendRequired<typeof addRemoveChildrenReqZ, z.ZodTypeAny>(
+      this.client, 
+      ENDPOINTS.ADD_CHILDREN, 
+      { id, children },
+      addRemoveChildrenReqZ, 
+      z.object({})
+    );
   }
 
   async removeChildren(id: ID, ...children: ID[]): Promise<void> {
-    const req = { id, children };
-    const [, err] = await this.client.send(
+    await sendRequired<typeof addRemoveChildrenReqZ, z.ZodTypeAny>(
+      this.client,
       ENDPOINTS.REMOVE_CHILDREN,
-      req,
+      { id, children },
+      addRemoveChildrenReqZ,
       z.object({}),
     );
-    if (err != null) throw err;
   }
 
   async moveChildren(from: ID, to: ID, ...children: ID[]): Promise<void> {
     const req = { from, to, children };
-    const [, err] = await this.client.send(ENDPOINTS.MOVE_CHILDREN, req, z.object({}));
-    if (err != null) throw err;
+    await sendRequired(this.client, ENDPOINTS.MOVE_CHILDREN, req, moveChildrenReqZ, z.object({}));
   }
 }