@synnaxlabs/client 0.50.0 → 0.52.3

package/src/framer/adapter.ts

@@ -15,7 +15,7 @@ import { Codec } from "@/framer/codec";
 import { type CrudeFrame, Frame } from "@/framer/frame";
 
 export class ReadAdapter {
-  private adapter: Map<channel.Key, channel.Name> | null;
+  private adapter: Map<channel.Key, string> | null;
   retriever: channel.Retriever;
   keys: Set<channel.Key>;
   codec: Codec;
@@ -54,7 +54,7 @@ export class ReadAdapter {
       this.keys = new Set(normalized as channel.Key[]);
       return true;
     }
-    const a = new Map<channel.Key, channel.Name>();
+    const a = new Map<channel.Key, string>();
     this.adapter = a;
     normalized.forEach((name) => {
       const channel = fetched.find((channel) => channel.name === name);
@@ -87,7 +87,7 @@ export class ReadAdapter {
 }
 
 export class WriteAdapter {
-  private adapter: Map<channel.Name, channel.Key> | null;
+  private adapter: Map<string, channel.Key> | null;
   retriever: channel.Retriever;
   keys: channel.Key[];
   codec: Codec;
@@ -125,9 +125,7 @@ export class WriteAdapter {
     const hasRemovedKeys = !previousKeySet.isSubsetOf(newKeySet);
     const hasChanged = hasAddedKeys || hasRemovedKeys;
     if (!hasChanged) return false;
-    this.adapter = new Map<channel.Name, channel.Key>(
-      results.map((c) => [c.name, c.key]),
-    );
+    this.adapter = new Map<string, channel.Key>(results.map((c) => [c.name, c.key]));
     this.keys = newKeys;
     this.codec.update(
       this.keys,
@@ -137,7 +135,7 @@ export class WriteAdapter {
   }
 
   private async fetchChannel(
-    ch: channel.Key | channel.Name | channel.Payload,
+    ch: channel.KeyOrName | channel.Payload,
   ): Promise<channel.Payload> {
     const res = await this.retriever.retrieve(ch);
     if (res.length === 0) throw new Error(`Channel ${JSON.stringify(ch)} not found`);

package/src/framer/frame.ts

@@ -95,7 +95,7 @@ export type CrudeFrame =
  * and array can be square.
  */
 export class Frame {
-  readonly columns: channel.Keys | channel.Names = [];
+  readonly columns: channel.KeysOrNames = [];
   readonly series: Series[] = [];
 
   constructor(
@@ -140,7 +140,7 @@ export class Frame {
       ["string", "number"].includes(typeof columnsOrData)
     ) {
       const data_ = array.toArray(series);
-      const cols = array.toArray(columnsOrData) as channel.Keys | channel.Names;
+      const cols = array.toArray(columnsOrData) as channel.KeysOrNames;
       validateMatchedColsAndSeries(cols, data_);
       data_.forEach((d, i) => this.push(cols[i], d));
       return;
@@ -184,23 +184,23 @@ export class Frame {
    * @returns the channel names if the frame is keyed by channel name, and throws an error
    * otherwise.
    */
-  get names(): channel.Names {
+  get names(): string[] {
     if (this.colType === "key") throw new UnexpectedError("colType is not name");
-    return (this.columns as channel.Names) ?? [];
+    return (this.columns as string[]) ?? [];
   }
 
   /**
    * @returns the unique channel names if the frame is keyed by channel name, and throws an
    * otherwise.
    */
-  get uniqueNames(): channel.Names {
+  get uniqueNames(): string[] {
     return unique.unique(this.names);
   }
 
   /**
    * @returns the unique columns in the frame.
    */
-  get uniqueColumns(): channel.Keys | channel.Names {
+  get uniqueColumns(): channel.KeysOrNames {
     return this.colType === "key" ? this.uniqueKeys : this.uniqueNames;
   }
 
@@ -280,9 +280,9 @@ export class Frame {
    * @returns a frame with the given channel keys or names.
    * @param keys the channel keys or names.
    */
-  get(keys: channel.Keys | channel.Names): Frame;
+  get(keys: channel.KeysOrNames): Frame;
 
-  get(key: channel.KeyOrName | channel.Keys | channel.Names): MultiSeries | Frame {
+  get(key: channel.PrimitiveParams): MultiSeries | Frame {
     if (Array.isArray(key))
       return this.filter((k) => (key as channel.Keys).includes(k as channel.Key));
     return new MultiSeries(this.series.filter((_, i) => this.columns[i] === key));

package/src/{ontology/group → group}/access.spec.ts

@@ -11,8 +11,8 @@ import { id } from "@synnaxlabs/x";
 import { describe, expect, it } from "vitest";
 
 import { AuthError } from "@/errors";
+import { group } from "@/group";
 import { ontology } from "@/ontology";
-import { group } from "@/ontology/group";
 import { createTestClientWithPolicy } from "@/testutil/access";
 import { createTestClient } from "@/testutil/client";
 
@@ -26,7 +26,7 @@ describe("group", () => {
         objects: [group.ontologyID("")],
         actions: ["create"],
       });
-      await userClient.ontology.groups.create({
+      await userClient.groups.create({
         parent: ontology.ROOT_ID,
         name: `test-${id.create()}`,
       });
@@ -39,7 +39,7 @@ describe("group", () => {
         actions: [],
       });
       await expect(
-        userClient.ontology.groups.create({
+        userClient.groups.create({
           parent: ontology.ROOT_ID,
           name: `test-${id.create()}`,
         }),
@@ -52,11 +52,11 @@ describe("group", () => {
         objects: [group.ontologyID("")],
         actions: ["delete", "retrieve"],
       });
-      const randomGroup = await client.ontology.groups.create({
+      const randomGroup = await client.groups.create({
         parent: ontology.ROOT_ID,
         name: `test-${id.create()}`,
       });
-      await userClient.ontology.groups.delete(randomGroup.key);
+      await userClient.groups.delete(randomGroup.key);
     });
 
     it("should deny access when no delete policy exists", async () => {
@@ -65,11 +65,11 @@ describe("group", () => {
         objects: [group.ontologyID("")],
         actions: [],
       });
-      const randomGroup = await client.ontology.groups.create({
+      const randomGroup = await client.groups.create({
         parent: ontology.ROOT_ID,
         name: `test-${id.create()}`,
       });
-      await expect(userClient.ontology.groups.delete(randomGroup.key)).rejects.toThrow(
+      await expect(userClient.groups.delete(randomGroup.key)).rejects.toThrow(
         AuthError,
       );
     });

package/src/{ontology/group → group}/client.ts

@@ -11,7 +11,7 @@ import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
 import { array } from "@synnaxlabs/x";
 import z from "zod";
 
-import { type Group, groupZ, type Key, keyZ } from "@/ontology/group/payload";
+import { type Group, groupZ, type Key, keyZ } from "@/group/payload";
 import { idZ as ontologyIDZ } from "@/ontology/payload";
 
 export const SET_CHANNEL_NAME = "sy_group_set";

package/src/group/external.ts

@@ -0,0 +1,11 @@
+// Copyright 2026 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 "@/group/client";
+export * from "@/group/payload";

package/src/{ontology/group → group}/group.spec.ts

@@ -11,8 +11,8 @@ import { id } from "@synnaxlabs/x";
 import { describe, expect, it } from "vitest";
 
 import { NotFoundError } from "@/errors";
+import { group } from "@/group";
 import { ontology } from "@/ontology";
-import { group } from "@/ontology/group";
 import { createTestClient } from "@/testutil/client";
 
 const client = createTestClient();
@@ -21,19 +21,19 @@ describe("Group", () => {
   describe("create", () => {
     it("should correctly create a group", async () => {
       const name = `group-${Math.random()}`;
-      const g = await client.ontology.groups.create({ parent: ontology.ROOT_ID, name });
+      const g = await client.groups.create({ parent: ontology.ROOT_ID, name });
       expect(g.name).toEqual(name);
     });
     it("should update an existing group", async () => {
-      const parent = await client.ontology.groups.create({
+      const parent = await client.groups.create({
         parent: ontology.ROOT_ID,
         name: `test-parent-key${id.create()}`,
       });
-      const g = await client.ontology.groups.create({
+      const g = await client.groups.create({
         parent: group.ontologyID(parent.key),
         name: `original-name-${id.create()}`,
       });
-      await client.ontology.groups.create({
+      await client.groups.create({
         parent: group.ontologyID(parent.key),
         key: g.key,
         name: "updated-name",
@@ -45,9 +45,9 @@ describe("Group", () => {
   describe("rename", () => {
     it("should correctly rename a group", async () => {
       const name = `group-${Math.random()}`;
-      const g = await client.ontology.groups.create({ parent: ontology.ROOT_ID, name });
+      const g = await client.groups.create({ parent: ontology.ROOT_ID, name });
       const newName = `group-${Math.random()}`;
-      await client.ontology.groups.rename(g.key, newName);
+      await client.groups.rename(g.key, newName);
       const g2 = await client.ontology.retrieve(group.ontologyID(g.key));
       expect(g2.name).toEqual(newName);
     });
@@ -55,8 +55,8 @@ describe("Group", () => {
   describe("delete", () => {
     it("should correctly delete the group", async () => {
       const name = `group-${Math.random()}`;
-      const g = await client.ontology.groups.create({ parent: ontology.ROOT_ID, name });
-      await client.ontology.groups.delete(g.key);
+      const g = await client.groups.create({ parent: ontology.ROOT_ID, name });
+      await client.groups.delete(g.key);
       await expect(
         async () => await client.ontology.retrieve(group.ontologyID(g.key)),
       ).rejects.toThrowError(NotFoundError);

package/src/{workspace/log → group}/index.ts

@@ -7,4 +7,4 @@
 // 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";
+export * as group from "@/group/external";

package/src/index.ts

@@ -35,22 +35,22 @@ export {
 } from "@/errors";
 export { framer } from "@/framer";
 export { Frame } from "@/framer/frame";
+export { group } from "@/group";
 export { label } from "@/label";
+export { lineplot } from "@/lineplot";
+export { log } from "@/log";
 export { ontology } from "@/ontology";
-export { group } from "@/ontology/group";
 export { rack } from "@/rack";
 export { ranger } from "@/ranger";
+export { schematic } from "@/schematic";
 export { status } from "@/status";
+export { table } from "@/table";
 export { task } from "@/task";
 export { createTestClientWithPolicy } from "@/testutil/access";
 export { createTestClient, TEST_CLIENT_PARAMS } from "@/testutil/client";
 export { user } from "@/user";
 export { view } from "@/view";
 export { workspace } from "@/workspace";
-export { lineplot } from "@/workspace/lineplot";
-export { log } from "@/workspace/log";
-export { schematic } from "@/workspace/schematic";
-export { table } from "@/workspace/table";
 export {
   type CrudeDataType,
   type CrudeDensity,

package/src/label/access.spec.ts

@@ -46,7 +46,7 @@ describe("label", () => {
       const retrieved = await userClient.labels.retrieve({ key: randomLabel.key });
       expect(retrieved.key).toBe(randomLabel.key);
       expect(retrieved.name).toBe(randomLabel.name);
-      expect(retrieved.color).toBe(randomLabel.color);
+      expect(retrieved.color).toEqual(randomLabel.color);
     });
 
     it("should allow the caller to create labels with the correct policy", async () => {

package/src/label/client.ts

@@ -19,7 +19,7 @@ export const SET_CHANNEL_NAME = "sy_label_set";
 export const DELETE_CHANNEL_NAME = "sy_label_delete";
 
 export const newZ = labelZ.extend({ key: keyZ.optional() });
-export interface New extends z.infer<typeof newZ> {}
+export interface New extends z.input<typeof newZ> {}
 
 const createReqZ = z.object({ labels: newZ.array() });
 const createResZ = z.object({ labels: labelZ.array() });

package/src/label/label.spec.ts

@@ -42,16 +42,16 @@ describe("Label", () => {
 
   describe("label", () => {
     it("should set a label on an item", async () => {
-      const l1 = await client.labels.create({ name: "Label One", color: "#E774D)" });
-      const l2 = await client.labels.create({ name: "Label Two", color: "#E774D)" });
+      const l1 = await client.labels.create({ name: "Label One", color: "#E774D0" });
+      const l2 = await client.labels.create({ name: "Label Two", color: "#E774D0" });
       await client.labels.label(label.ontologyID(l1.key), [l2.key]);
       const labels = await client.labels.retrieve({ for: label.ontologyID(l1.key) });
       expect(labels).toHaveLength(1);
       expect(labels[0].key).toEqual(l2.key);
     });
     it("should replace the labels on an item", async () => {
-      const l1 = await client.labels.create({ name: "Label One", color: "#E774D)" });
-      const l2 = await client.labels.create({ name: "Label Two", color: "#E774D)" });
+      const l1 = await client.labels.create({ name: "Label One", color: "#E774D0" });
+      const l2 = await client.labels.create({ name: "Label Two", color: "#E774D0" });
       await client.labels.label(label.ontologyID(l1.key), [l2.key]);
       await client.labels.label(label.ontologyID(l1.key), [l1.key], { replace: true });
       const labels = await client.labels.retrieve({ for: label.ontologyID(l1.key) });

package/src/{workspace/lineplot → lineplot}/access.spec.ts

@@ -10,9 +10,9 @@
 import { describe, expect, it } from "vitest";
 
 import { AuthError, NotFoundError } from "@/errors";
+import { lineplot } from "@/lineplot";
 import { createTestClientWithPolicy } from "@/testutil/access";
 import { createTestClient } from "@/testutil/client";
-import { lineplot } from "@/workspace/lineplot";
 
 const client = createTestClient();
 
@@ -28,12 +28,12 @@ describe("lineplot", () => {
         name: "test",
         layout: {},
       });
-      const randomLinePlot = await client.workspaces.lineplots.create(ws.key, {
+      const randomLinePlot = await client.lineplots.create(ws.key, {
         name: "test",
         data: {},
       });
       await expect(
-        userClient.workspaces.lineplots.retrieve({ key: randomLinePlot.key }),
+        userClient.lineplots.retrieve({ key: randomLinePlot.key }),
       ).rejects.toThrow(AuthError);
     });
 
@@ -47,11 +47,11 @@ describe("lineplot", () => {
         name: "test",
         layout: {},
       });
-      const randomLinePlot = await client.workspaces.lineplots.create(ws.key, {
+      const randomLinePlot = await client.lineplots.create(ws.key, {
         name: "test",
         data: {},
       });
-      const retrieved = await userClient.workspaces.lineplots.retrieve({
+      const retrieved = await userClient.lineplots.retrieve({
         key: randomLinePlot.key,
       });
       expect(retrieved.key).toBe(randomLinePlot.key);
@@ -68,7 +68,7 @@ describe("lineplot", () => {
         name: "test",
         layout: {},
       });
-      await userClient.workspaces.lineplots.create(ws.key, {
+      await userClient.lineplots.create(ws.key, {
         name: "test",
         data: {},
       });
@@ -85,7 +85,7 @@ describe("lineplot", () => {
         layout: {},
       });
       await expect(
-        userClient.workspaces.lineplots.create(ws.key, {
+        userClient.lineplots.create(ws.key, {
           name: "test",
           data: {},
         }),
@@ -102,13 +102,13 @@ describe("lineplot", () => {
         name: "test",
         layout: {},
       });
-      const randomLinePlot = await client.workspaces.lineplots.create(ws.key, {
+      const randomLinePlot = await client.lineplots.create(ws.key, {
         name: "test",
         data: {},
       });
-      await userClient.workspaces.lineplots.delete(randomLinePlot.key);
+      await userClient.lineplots.delete(randomLinePlot.key);
       await expect(
-        userClient.workspaces.lineplots.retrieve({ key: randomLinePlot.key }),
+        userClient.lineplots.retrieve({ key: randomLinePlot.key }),
       ).rejects.toThrow(NotFoundError);
     });
 
@@ -122,13 +122,13 @@ describe("lineplot", () => {
         name: "test",
         layout: {},
       });
-      const randomLinePlot = await client.workspaces.lineplots.create(ws.key, {
+      const randomLinePlot = await client.lineplots.create(ws.key, {
         name: "test",
         data: {},
       });
-      await expect(
-        userClient.workspaces.lineplots.delete(randomLinePlot.key),
-      ).rejects.toThrow(AuthError);
+      await expect(userClient.lineplots.delete(randomLinePlot.key)).rejects.toThrow(
+        AuthError,
+      );
     });
   });
 });

package/src/{workspace/lineplot → lineplot}/client.ts

@@ -11,8 +11,6 @@ import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
 import { array, type record } from "@synnaxlabs/x";
 import { z } from "zod";
 
-import { ontology } from "@/ontology";
-import { checkForMultipleOrNoResults } from "@/util/retrieve";
 import {
   type Key,
   keyZ,
@@ -21,8 +19,10 @@ import {
   type New,
   newZ,
   type Params,
-} from "@/workspace/lineplot/payload";
-import { type Key as WorkspaceKey, keyZ as workspaceKeyZ } from "@/workspace/payload";
+} from "@/lineplot/payload";
+import { ontology } from "@/ontology";
+import { checkForMultipleOrNoResults } from "@/util/retrieve";
+import { workspace } from "@/workspace";
 
 const renameReqZ = z.object({ key: keyZ, name: z.string() });
 
@@ -41,7 +41,7 @@ export type RetrieveMultipleParams = z.input<typeof retrieveReqZ>;
 
 const retrieveResZ = z.object({ linePlots: array.nullableZ(linePlotZ) });
 
-const createReqZ = z.object({ workspace: workspaceKeyZ, linePlots: newZ.array() });
+const createReqZ = z.object({ workspace: workspace.keyZ, linePlots: newZ.array() });
 const createResZ = z.object({ linePlots: linePlotZ.array() });
 
 const emptyResZ = z.object({});
@@ -53,16 +53,16 @@ export class Client {
     this.client = client;
   }
 
-  async create(workspace: WorkspaceKey, linePlot: New): Promise<LinePlot>;
-  async create(workspace: WorkspaceKey, linePlots: New[]): Promise<LinePlot[]>;
+  async create(workspace: workspace.Key, linePlot: New): Promise<LinePlot>;
+  async create(workspace: workspace.Key, linePlots: New[]): Promise<LinePlot[]>;
   async create(
-    workspace: WorkspaceKey,
+    workspace: workspace.Key,
     linePlots: New | New[],
   ): Promise<LinePlot | LinePlot[]> {
     const isMany = Array.isArray(linePlots);
     const res = await sendRequired(
       this.client,
-      "/workspace/lineplot/create",
+      "/lineplot/create",
       { workspace, linePlots: array.toArray(linePlots) },
       createReqZ,
       createResZ,
@@ -73,7 +73,7 @@ export class Client {
   async rename(key: Key, name: string): Promise<void> {
     await sendRequired(
       this.client,
-      "/workspace/lineplot/rename",
+      "/lineplot/rename",
       { key, name },
       renameReqZ,
       emptyResZ,
@@ -83,7 +83,7 @@ export class Client {
   async setData(key: Key, data: record.Unknown): Promise<void> {
     await sendRequired(
       this.client,
-      "/workspace/lineplot/set-data",
+      "/lineplot/set-data",
       { key, data: JSON.stringify(data) },
       setDataReqZ,
       emptyResZ,
@@ -98,7 +98,7 @@ export class Client {
     const isSingle = singleRetrieveArgsZ.safeParse(args).success;
     const res = await sendRequired(
       this.client,
-      "/workspace/lineplot/retrieve",
+      "/lineplot/retrieve",
       args,
       retrieveArgsZ,
       retrieveResZ,
@@ -110,7 +110,7 @@ export class Client {
   async delete(keys: Params): Promise<void> {
     await sendRequired(
       this.client,
-      "/workspace/lineplot/delete",
+      "/lineplot/delete",
       { keys: array.toArray(keys) },
       deleteReqZ,
       emptyResZ,

package/src/lineplot/external.ts

@@ -0,0 +1,11 @@
+// Copyright 2026 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 "@/lineplot/client";
+export * from "@/lineplot/payload";

package/src/{ontology/group → lineplot}/index.ts

@@ -7,4 +7,4 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-export * as group from "@/ontology/group/external";
+export * as lineplot from "@/lineplot/external";

package/src/{workspace/lineplot → lineplot}/lineplot.spec.ts

@@ -22,7 +22,7 @@ describe("LinePlot", () => {
         name: "Line Plot",
         layout: { one: 1 },
       });
-      const linePlot = await client.workspaces.lineplots.create(ws.key, {
+      const linePlot = await client.lineplots.create(ws.key, {
         name: "Line Plot",
         data: { one: 1 },
       });
@@ -37,12 +37,12 @@ describe("LinePlot", () => {
         name: "Line Plot",
         layout: { one: 1 },
       });
-      const linePlot = await client.workspaces.lineplots.create(ws.key, {
+      const linePlot = await client.lineplots.create(ws.key, {
         name: "Line Plot",
         data: { one: 1 },
       });
-      await client.workspaces.lineplots.rename(linePlot.key, "Line Plot2");
-      const res = await client.workspaces.lineplots.retrieve({ key: linePlot.key });
+      await client.lineplots.rename(linePlot.key, "Line Plot2");
+      const res = await client.lineplots.retrieve({ key: linePlot.key });
       expect(res.name).toEqual("Line Plot2");
     });
   });
@@ -52,12 +52,12 @@ describe("LinePlot", () => {
         name: "Line Plot",
         layout: { one: 1 },
       });
-      const linePlot = await client.workspaces.lineplots.create(ws.key, {
+      const linePlot = await client.lineplots.create(ws.key, {
         name: "Line Plot",
         data: { one: 1 },
       });
-      await client.workspaces.lineplots.setData(linePlot.key, { two: 2 });
-      const res = await client.workspaces.lineplots.retrieve({ key: linePlot.key });
+      await client.lineplots.setData(linePlot.key, { two: 2 });
+      const res = await client.lineplots.retrieve({ key: linePlot.key });
       expect(res.data.two).toEqual(2);
     });
   });
@@ -67,14 +67,14 @@ describe("LinePlot", () => {
         name: "Line Plot",
         layout: { one: 1 },
       });
-      const linePlot = await client.workspaces.lineplots.create(ws.key, {
+      const linePlot = await client.lineplots.create(ws.key, {
         name: "Line Plot",
         data: { one: 1 },
       });
-      await client.workspaces.lineplots.delete(linePlot.key);
-      await expect(
-        client.workspaces.lineplots.retrieve({ key: linePlot.key }),
-      ).rejects.toThrow(NotFoundError);
+      await client.lineplots.delete(linePlot.key);
+      await expect(client.lineplots.retrieve({ key: linePlot.key })).rejects.toThrow(
+        NotFoundError,
+      );
     });
   });
 });