@synnaxlabs/client 0.54.2 → 0.56.0

package/src/table/types.gen.ts

@@ -9,14 +9,56 @@
 
 // Code generated by Oracle. DO NOT EDIT.
 
-import { caseconv, record } from "@synnaxlabs/x";
+import { array, caseconv, record } from "@synnaxlabs/x";
 import { z } from "zod";
 
 import { ontology } from "@/ontology";
 
+/** Cell is a single cell in a table, identified by key and variant. */
+export const cellZ = z.object({
+  /** key is the unique identifier for this cell within the table. */
+  key: z.string(),
+  /**
+   * variant is the cell variant identifier (e.g. "text", "value"). The variant
+   * determines the shape of props and which Pluto cell component renders
+   * the cell.
+   */
+  variant: z.string(),
+  /**
+   * props is the variant-specific cell configuration. The shape is determined
+   * by the variant; the wire format intentionally stores it as an
+   * opaque record so new variants can be added without a schema
+   * migration.
+   */
+  props: caseconv.preserveCase(record.nullishToEmpty()),
+});
+export interface Cell extends z.infer<typeof cellZ> {}
+
+/** Row is a single row in a table, with height and ordered cell keys. */
+export const rowZ = z.object({
+  /** size is the height of the row in pixels. */
+  size: z.number(),
+  /**
+   * cells is the ordered list of cell keys in this row from left to right.
+   * Each key points at an entry in the table's cells map.
+   */
+  cells: array.nullishToEmpty(z.string()),
+});
+export interface Row extends z.infer<typeof rowZ> {}
+
+/** Column is a single column in a table, with width. */
+export const columnZ = z.object({
+  /** size is the width of the column in pixels. */
+  size: z.number(),
+});
+export interface Column extends z.infer<typeof columnZ> {}
+
 export const keyZ = z.uuid();
 export type Key = z.infer<typeof keyZ>;
 
+export const cellTemplateZ = cellZ.omit({ key: true });
+export interface CellTemplate extends z.infer<typeof cellTemplateZ> {}
+
 /**
  * Table is a tabular data display component for viewing structured telemetry
  * data. Tables support multiple columns, channel data sources, and
@@ -27,15 +69,26 @@ export const tableZ = z.object({
   key: keyZ,
   /** name is a human-readable name for the table. */
   name: z.string(),
+  /** rows are the table rows in display order, top to bottom. */
+  rows: array.nullishToEmpty(rowZ),
+  /** columns are the table columns in display order, left to right. */
+  columns: array.nullishToEmpty(columnZ),
   /**
-   * data is the table configuration including column definitions, channel
-   * references, and formatting options.
+   * cells contains all cells in the table, keyed by cell key. Cell positions
+   * are derived from rows[*].cells[*] references; cells not referenced
+   * by any row are orphaned and will be pruned on the next structural
+   * edit.
    */
-  data: caseconv.preserveCase(record.nullishToEmpty()),
+  cells: caseconv.preserveCase(record.nullishToEmpty(z.string(), cellZ)),
 });
 export interface Table extends z.infer<typeof tableZ> {}
 
-export const newZ = tableZ.partial({ key: true });
+export const newZ = tableZ.partial({
+  key: true,
+  rows: true,
+  columns: true,
+  cells: true,
+});
 export interface New extends z.input<typeof newZ> {}
 
 export const ontologyID = ontology.createIDFactory<Key>("table");

package/src/task/client.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 { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
+import { type UnaryClient } from "@synnaxlabs/freighter";
 import {
   array,
   caseconv,
@@ -44,8 +44,6 @@ export const COMMAND_CHANNEL_NAME = "sy_task_cmd";
 export const SET_CHANNEL_NAME = "sy_task_set";
 export const DELETE_CHANNEL_NAME = "sy_task_delete";
 
-const NOT_CREATED_ERROR = new Error("Task not created");
-
 export const rackKey = (key: Key): RackKey => Number(BigInt(key) >> 32n);
 
 export const newKey = (rackKey: RackKey, taskKey: number = 0): Key =>
@@ -99,17 +97,17 @@ export class Task<S extends Schemas = Schemas> {
   private readonly rangeClient_?: ranger.Client;
 
   get frameClient(): framer.Client {
-    if (this.frameClient_ == null) throw NOT_CREATED_ERROR;
+    if (this.frameClient_ == null) throw new Error("Task not created");
     return this.frameClient_;
   }
 
   get ontologyClient(): ontology.Client {
-    if (this.ontologyClient_ == null) throw NOT_CREATED_ERROR;
+    if (this.ontologyClient_ == null) throw new Error("Task not created");
     return this.ontologyClient_;
   }
 
   get rangeClient(): ranger.Client {
-    if (this.rangeClient_ == null) throw NOT_CREATED_ERROR;
+    if (this.rangeClient_ == null) throw new Error("Task not created");
     return this.rangeClient_;
   }
 
@@ -129,7 +127,7 @@ export class Task<S extends Schemas = Schemas> {
       ({
         type: z.string(),
         config: z.unknown(),
-        statusData: z.unknown(),
+        statusData: z.unknown().optional(),
       } as unknown as S);
     this.internal = internal;
     this.snapshot = snapshot;
@@ -193,7 +191,7 @@ export class Task<S extends Schemas = Schemas> {
 
   async snapshottedTo(): Promise<ontology.Resource | null> {
     if (this.ontologyClient == null || this.rangeClient == null)
-      throw NOT_CREATED_ERROR;
+      throw new Error("Task not created");
     if (!this.snapshot) return null;
     return await retrieveSnapshottedTo(this.key, this.ontologyClient);
   }
@@ -281,10 +279,9 @@ export class Client {
     const isSingle = !Array.isArray(task);
     const createReq = createReqZ(schemas);
     const createRes = createResZ(schemas);
-    const res = await sendRequired(
-      this.client,
+    const res = await this.client.send(
       "/task/create",
-      { tasks: array.toArray(task) } as z.infer<typeof createReq>,
+      { tasks: array.toArray(task) },
       createReq,
       createRes,
     );
@@ -293,8 +290,7 @@ export class Client {
   }
 
   async delete(keys: Key | Key[]): Promise<void> {
-    await sendRequired<typeof deleteReqZ, typeof deleteResZ>(
-      this.client,
+    await this.client.send(
       "/task/delete",
       { keys: array.toArray(keys) },
       deleteReqZ,
@@ -315,8 +311,7 @@ export class Client {
     ...args
   }: RetrieveArgs & RetrieveSchemas<S>): Promise<Task<S> | Task<S>[]> {
     const isSingle = singleRetrieveArgsZ.safeParse(args).success;
-    const res = await sendRequired(
-      this.client,
+    const res = await this.client.send(
       "/task/retrieve",
       args,
       retrieveArgsZ,
@@ -330,8 +325,7 @@ export class Client {
 
   async copy(key: Key, name: string, snapshot: boolean): Promise<Task> {
     const copyRes = copyResZ();
-    const response = await sendRequired(
-      this.client,
+    const response = await this.client.send(
       "/task/copy",
       { key, name, snapshot },
       copyReqZ,
@@ -347,7 +341,7 @@ export class Client {
   }
 
   async retrieveSnapshottedTo(taskKey: Key): Promise<ontology.Resource | null> {
-    if (this.ontologyClient == null) throw NOT_CREATED_ERROR;
+    if (this.ontologyClient == null) throw new Error("Task not created");
     return await retrieveSnapshottedTo(taskKey, this.ontologyClient);
   }
 
@@ -463,7 +457,7 @@ const executeCommands = async ({
   frameClient,
   commands,
 }: ExecuteCommandsInternalParams): Promise<string[]> => {
-  if (frameClient == null) throw NOT_CREATED_ERROR;
+  if (frameClient == null) throw new Error("Task not created");
   const w = await frameClient.openWriter(COMMAND_CHANNEL_NAME);
   const cmds = commands.map((c) => ({ ...c, key: id.create() }));
   await w.write(COMMAND_CHANNEL_NAME, cmds);
@@ -512,7 +506,7 @@ const executeCommandsSync = async <StatusData extends z.ZodType = z.ZodNever>({
   statusDataZ,
   name: taskName,
 }: ExecuteCommandsSyncInternalParams<StatusData>): Promise<Status<StatusData>[]> => {
-  if (frameClient == null) throw NOT_CREATED_ERROR;
+  if (frameClient == null) throw new Error("Task not created");
   const streamer = await frameClient.openStreamer(status.SET_CHANNEL_NAME);
   const cmdKeys = await executeCommands({ frameClient, commands });
   const parsedTimeout = new TimeSpan(timeout);

package/src/task/task.spec.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 { TimeStamp } from "@synnaxlabs/x";
+import { id, TimeStamp } from "@synnaxlabs/x";
 import { beforeAll, describe, expect, it } from "vitest";
 import { z } from "zod";
 
@@ -114,6 +114,20 @@ describe("Task", async () => {
       expect(retrieved.key).toBe(m.key);
     });
 
+    it("should retrieve tasks by search term", async () => {
+      const prefix = `searchable-task-${id.create()}`;
+      const names = [`${prefix}-1`, `${prefix}-2`];
+      await Promise.all(
+        names.map((name) => testRack.createTask({ name, config: {}, type: "ni" })),
+      );
+      await expect
+        .poll(async () => {
+          const results = await client.tasks.retrieve({ searchTerm: prefix });
+          return results.map((t) => t.name).sort();
+        })
+        .toEqual(names);
+    });
+
     describe("status", () => {
       it("should include task status when requested", async () => {
         const t = await testRack.createTask({

package/src/task/types.gen.ts

@@ -23,7 +23,7 @@ export type StatusDetailsZodObject<Data extends z.ZodType = z.ZodNever> = z.ZodO
   task: typeof keyZ;
   running: z.ZodBoolean;
   cmd: z.ZodOptional<z.ZodString>;
-  data: [Data] extends [z.ZodNever] ? z.ZodOptional<z.ZodUnknown> : Data;
+  data: [Data] extends [z.ZodNever] ? z.ZodOptional<z.ZodUnknown> : z.ZodOptional<Data>;
 }>;
 
 export interface StatusDetailsZFunction {
@@ -38,20 +38,22 @@ export const statusDetailsZ: StatusDetailsZFunction = <Data extends z.ZodType>(
     task: keyZ,
     running: z.boolean(),
     cmd: z.string().optional(),
-    data: data ?? z.unknown().optional(),
+    data: (data ?? z.unknown()).optional(),
   });
 export type StatusDetails<Data extends z.ZodType = z.ZodNever> = {
   task: Key;
   running: boolean;
   cmd?: string;
-} & ([Data] extends [z.ZodNever] ? {} : { data: z.infer<Data> });
+} & ([Data] extends [z.ZodNever] ? {} : { data?: z.infer<Data> });
 
 export type NewStatusDetailsZodObject<Data extends z.ZodType = z.ZodNever> =
   z.ZodObject<{
     task: z.ZodOptional<typeof keyZ>;
     running: z.ZodBoolean;
     cmd: z.ZodOptional<z.ZodString>;
-    data: [Data] extends [z.ZodNever] ? z.ZodOptional<z.ZodUnknown> : Data;
+    data: [Data] extends [z.ZodNever]
+      ? z.ZodOptional<z.ZodUnknown>
+      : z.ZodOptional<Data>;
   }>;
 
 export interface NewStatusDetailsZFunction {
@@ -66,13 +68,13 @@ export const newStatusDetailsZ: NewStatusDetailsZFunction = <Data extends z.ZodT
     task: keyZ.optional(),
     running: z.boolean(),
     cmd: z.string().optional(),
-    data: data ?? z.unknown().optional(),
+    data: (data ?? z.unknown()).optional(),
   });
 export type NewStatusDetails<Data extends z.ZodType = z.ZodNever> = {
   task?: Key;
   running: boolean;
   cmd?: string;
-} & ([Data] extends [z.ZodNever] ? {} : { data: z.infer<Data> });
+} & ([Data] extends [z.ZodNever] ? {} : { data?: z.infer<Data> });
 
 /** Command is a command to execute on a task in the Driver system. */
 export const commandZ = z.object({

package/src/user/client.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 { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
+import { type UnaryClient } from "@synnaxlabs/freighter";
 import { array } from "@synnaxlabs/x";
 import { z } from "zod";
 
@@ -82,8 +82,7 @@ export class Client {
   async create(users: New[]): Promise<User[]>;
   async create(users: New | New[]): Promise<User | User[]> {
     const isMany = Array.isArray(users);
-    const res = await sendRequired<typeof createReqZ, typeof createResZ>(
-      this.client,
+    const res = await this.client.send(
       "/user/create",
       { users: array.toArray(users) },
       createReqZ,
@@ -93,8 +92,7 @@ export class Client {
   }
 
   async changeUsername(key: Key, newUsername: string): Promise<void> {
-    await sendRequired<typeof changeUsernameReqZ, typeof changeUsernameResZ>(
-      this.client,
+    await this.client.send(
       "/user/change-username",
       { key, username: newUsername },
       changeUsernameReqZ,
@@ -107,8 +105,7 @@ export class Client {
   async retrieve(args: RetrieveArgs): Promise<User[]>;
   async retrieve(args: RetrieveArgs): Promise<User | User[]> {
     const isSingle = "key" in args || "username" in args;
-    const res = await sendRequired<typeof retrieveArgsZ, typeof retrieveResZ>(
-      this.client,
+    const res = await this.client.send(
       "/user/retrieve",
       args,
       retrieveArgsZ,
@@ -131,8 +128,7 @@ export class Client {
   }
 
   async rename(key: Key, firstName?: string, lastName?: string): Promise<void> {
-    await sendRequired<typeof renameReqZ, typeof renameResZ>(
-      this.client,
+    await this.client.send(
       "/user/rename",
       { key, firstName, lastName },
       renameReqZ,
@@ -143,8 +139,7 @@ export class Client {
   async delete(key: Key): Promise<void>;
   async delete(keys: Key[]): Promise<void>;
   async delete(keys: Key | Key[]): Promise<void> {
-    await sendRequired<typeof deleteReqZ, typeof deleteResZ>(
-      this.client,
+    await this.client.send(
       "/user/delete",
       { keys: array.toArray(keys) },
       deleteReqZ,

package/src/view/client.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 { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
+import { type UnaryClient } from "@synnaxlabs/freighter";
 import { array } from "@synnaxlabs/x";
 import { z } from "zod";
 
@@ -54,8 +54,7 @@ export class Client {
     args: RetrieveSingleParams | RetrieveMultipleParams,
   ): Promise<View | View[]> {
     const isSingle = "key" in args;
-    const res = await sendRequired(
-      this.client,
+    const res = await this.client.send(
       "/view/retrieve",
       args,
       retrieveArgsZ,
@@ -69,8 +68,7 @@ export class Client {
   async create(views: New[]): Promise<View[]>;
   async create(views: New | New[]): Promise<View | View[]> {
     const isMany = Array.isArray(views);
-    const res = await sendRequired<typeof createReqZ, typeof createResZ>(
-      this.client,
+    const res = await this.client.send(
       "/view/create",
       { views: array.toArray(views) },
       createReqZ,
@@ -80,8 +78,7 @@ export class Client {
   }
 
   async delete(keys: Key | Key[]): Promise<void> {
-    await sendRequired<typeof deleteReqZ, typeof emptyResZ>(
-      this.client,
+    await this.client.send(
       "/view/delete",
       { keys: array.toArray(keys) },
       deleteReqZ,

package/src/view/view.spec.ts

@@ -113,15 +113,19 @@ describe("View", () => {
 
     it("should search for views by name", async () => {
       const client = createTestClient();
+      const prefix = id.create();
+      const name = `${prefix} View`;
       await client.views.create({
-        name: "Searchable View",
+        name,
         type: "lineplot",
         query: { channels: ["search"] },
       });
-      const results = await client.views.retrieve({ searchTerm: "Searchable" });
-      expect(results.length).toBeGreaterThan(0);
-      expect(results[0].name).toContain("Searchable");
-      expect(results[0].query).toEqual({ channels: ["search"] });
+      await expect
+        .poll(async () => {
+          const results = await client.views.retrieve({ searchTerm: prefix });
+          return results.find((v) => v.name === name);
+        })
+        .toMatchObject({ query: { channels: ["search"] } });
     });
   });
 

package/src/workspace/client.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 { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
+import { type UnaryClient } from "@synnaxlabs/freighter";
 import { array, caseconv, record } from "@synnaxlabs/x";
 import { z } from "zod";
 
@@ -57,8 +57,7 @@ export class Client {
   async create(workspaces: New[]): Promise<Workspace[]>;
   async create(workspaces: New | New[]): Promise<Workspace | Workspace[]> {
     const isMany = Array.isArray(workspaces);
-    const res = await sendRequired(
-      this.client,
+    const res = await this.client.send(
       "/workspace/create",
       { workspaces: array.toArray(workspaces) },
       createReqZ,
@@ -68,18 +67,11 @@ export class Client {
   }
 
   async rename(key: Key, name: string): Promise<void> {
-    await sendRequired(
-      this.client,
-      "/workspace/rename",
-      { key, name },
-      renameReqZ,
-      emptyResZ,
-    );
+    await this.client.send("/workspace/rename", { key, name }, renameReqZ, emptyResZ);
   }
 
   async setLayout(key: Key, layout: record.Unknown): Promise<void> {
-    await sendRequired(
-      this.client,
+    await this.client.send(
       "/workspace/set-layout",
       { key, layout },
       setLayoutReqZ,
@@ -98,8 +90,7 @@ export class Client {
     if (typeof keys === "string" || Array.isArray(keys))
       req = { keys: array.toArray(keys) };
     else req = keys;
-    const res = await sendRequired(
-      this.client,
+    const res = await this.client.send(
       "/workspace/retrieve",
       req,
       retrieveReqZ,
@@ -111,8 +102,7 @@ export class Client {
   async delete(key: Key): Promise<void>;
   async delete(keys: Key[]): Promise<void>;
   async delete(keys: Key | Key[]): Promise<void> {
-    await sendRequired(
-      this.client,
+    await this.client.send(
       "/workspace/delete",
       { keys: array.toArray(keys) },
       deleteReqZ,

package/src/workspace/types.gen.ts

@@ -13,6 +13,7 @@ import { caseconv, record } from "@synnaxlabs/x";
 import { z } from "zod";
 
 import { ontology } from "@/ontology";
+import { user } from "@/user";
 
 export const keyZ = z.uuid();
 export type Key = z.infer<typeof keyZ>;
@@ -28,7 +29,7 @@ export const workspaceZ = z.object({
   /** name is a human-readable name for the workspace. */
   name: z.string().min(1, "Name is required"),
   /** author is the UUID of the user who created this workspace. */
-  author: z.uuid().optional(),
+  author: user.keyZ.optional(),
   /**
    * layout is the mosaic tree structure that defines how visualizations are
    * arranged. Contains tab layout, split configurations, and window

package/src/workspace/workspace.spec.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 { uuid } from "@synnaxlabs/x";
+import { id, uuid } from "@synnaxlabs/x";
 import { describe, expect, test } from "vitest";
 
 import { createTestClient } from "@/testutil/client";
@@ -58,6 +58,19 @@ describe("Workspace", () => {
       await expect(client.workspaces.retrieve(ws.key)).rejects.toThrow();
     });
   });
+  describe("retrieve", () => {
+    test("retrieve workspaces by search term", async () => {
+      const prefix = `searchable-workspace-${id.create()}`;
+      const names = [`${prefix}-1`, `${prefix}-2`];
+      await client.workspaces.create(names.map((name) => ({ name, layout: {} })));
+      await expect
+        .poll(async () => {
+          const results = await client.workspaces.retrieve({ searchTerm: prefix });
+          return results.map((w) => w.name).sort();
+        })
+        .toEqual(names);
+    });
+  });
   describe("case preservation", () => {
     test("should preserve key casing in layout field on create/retrieve cycle", async () => {
       const ws = await client.workspaces.create({