@synnaxlabs/client 0.56.1 → 0.57.0

package/src/label/access.spec.ts

@@ -1,109 +0,0 @@
-// 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.
-
-import { describe, expect, it } from "vitest";
-
-import { AuthError, NotFoundError } from "@/errors";
-import { label } from "@/label";
-import { createTestClientWithPolicy } from "@/testutil/access";
-import { createTestClient } from "@/testutil/client";
-
-const client = createTestClient();
-
-describe("label", () => {
-  describe("access control", () => {
-    it("should deny access when no retrieve policy exists", async () => {
-      const userClient = await createTestClientWithPolicy(client, {
-        name: "test",
-        objects: [],
-        actions: [],
-      });
-      const randomLabel = await client.labels.create({
-        name: "test",
-        color: "#E774D0",
-      });
-      await expect(
-        userClient.labels.retrieve({ key: randomLabel.key }),
-      ).rejects.toThrow(AuthError);
-    });
-
-    it("should allow the caller to retrieve labels with the correct policy", async () => {
-      const userClient = await createTestClientWithPolicy(client, {
-        name: "test",
-        objects: [label.ontologyID("")],
-        actions: ["retrieve"],
-      });
-      const randomLabel = await client.labels.create({
-        name: "test",
-        color: "#E774D0",
-      });
-      const retrieved = await userClient.labels.retrieve({ key: randomLabel.key });
-      expect(retrieved.key).toBe(randomLabel.key);
-      expect(retrieved.name).toBe(randomLabel.name);
-      expect(retrieved.color).toEqual(randomLabel.color);
-    });
-
-    it("should allow the caller to create labels with the correct policy", async () => {
-      const userClient = await createTestClientWithPolicy(client, {
-        name: "test",
-        objects: [label.ontologyID("")],
-        actions: ["create"],
-      });
-      await userClient.labels.create({
-        name: "test",
-        color: "#E774D0",
-      });
-    });
-
-    it("should deny access when no create policy exists", async () => {
-      const userClient = await createTestClientWithPolicy(client, {
-        name: "test",
-        objects: [label.ontologyID("")],
-        actions: [],
-      });
-      await expect(
-        userClient.labels.create({
-          name: "test",
-          color: "#E774D0",
-        }),
-      ).rejects.toThrow(AuthError);
-    });
-
-    it("should allow the caller to delete labels with the correct policy", async () => {
-      const userClient = await createTestClientWithPolicy(client, {
-        name: "test",
-        objects: [label.ontologyID("")],
-        actions: ["delete"],
-      });
-      const randomLabel = await client.labels.create({
-        name: "test",
-        color: "#E774D0",
-      });
-      await userClient.labels.delete(randomLabel.key);
-      await expect(
-        userClient.labels.retrieve({ key: randomLabel.key }),
-      ).rejects.toThrow(NotFoundError);
-    });
-
-    it("should deny access when no delete policy exists", async () => {
-      const userClient = await createTestClientWithPolicy(client, {
-        name: "test",
-        objects: [label.ontologyID("")],
-        actions: [],
-      });
-      const randomLabel = await client.labels.create({
-        name: "test",
-        color: "#E774D0",
-      });
-      await expect(userClient.labels.delete(randomLabel.key)).rejects.toThrow(
-        AuthError,
-      );
-    });
-  });
-});

package/src/label/label.spec.ts

@@ -1,83 +0,0 @@
-// 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.
-
-import { id } from "@synnaxlabs/x";
-import { describe, expect, it } from "vitest";
-
-import { label } from "@/label";
-import { createTestClient } from "@/testutil/client";
-
-const client = createTestClient();
-
-describe("Label", () => {
-  describe("create", () => {
-    it("should create a label", async () => {
-      const v = await client.labels.create({
-        name: "Label",
-        color: "#E774D0",
-      });
-      expect(v.key).not.toHaveLength(0);
-    });
-  });
-
-  describe("retrieve", () => {
-    it("should retrieve a label by its key", async () => {
-      const v = await client.labels.create({
-        name: "Label",
-        color: "#E774D0",
-      });
-      const retrieved = await client.labels.retrieve({ key: v.key });
-      expect(retrieved).toEqual(v);
-    });
-    it("should retrieve labels by search term", async () => {
-      const prefix = `searchable-label-${id.create()}`;
-      const names = [`${prefix}-1`, `${prefix}-2`];
-      await client.labels.create(names.map((name) => ({ name, color: "#E774D0" })));
-      await expect
-        .poll(async () => {
-          const results = await client.labels.retrieve({ searchTerm: prefix });
-          return results.map((l) => l.name).sort();
-        })
-        .toEqual(names);
-    });
-  });
-
-  describe("delete", () => {
-    it("should delete a label by its key", async () => {
-      const v = await client.labels.create({
-        name: "Label",
-        color: "#E774D0",
-      });
-      await client.labels.delete(v.key);
-      await expect(
-        async () => await client.labels.retrieve({ key: v.key }),
-      ).rejects.toThrow();
-    });
-  });
-
-  describe("label", () => {
-    it("should set a label on an item", async () => {
-      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: "#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) });
-      expect(labels).toHaveLength(1);
-      expect(labels[0].key).toEqual(l1.key);
-    });
-  });
-});

package/src/lineplot/access.spec.ts

@@ -1,134 +0,0 @@
-// 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.
-
-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";
-
-const client = createTestClient();
-
-describe("lineplot", () => {
-  describe("access control", () => {
-    it("should deny access when no retrieve policy exists", async () => {
-      const userClient = await createTestClientWithPolicy(client, {
-        name: "test",
-        objects: [],
-        actions: [],
-      });
-      const ws = await client.workspaces.create({
-        name: "test",
-        layout: {},
-      });
-      const randomLinePlot = await client.lineplots.create(ws.key, {
-        name: "test",
-        data: {},
-      });
-      await expect(
-        userClient.lineplots.retrieve({ key: randomLinePlot.key }),
-      ).rejects.toThrow(AuthError);
-    });
-
-    it("should allow the caller to retrieve lineplots with the correct policy", async () => {
-      const userClient = await createTestClientWithPolicy(client, {
-        name: "test",
-        objects: [lineplot.ontologyID("")],
-        actions: ["retrieve"],
-      });
-      const ws = await client.workspaces.create({
-        name: "test",
-        layout: {},
-      });
-      const randomLinePlot = await client.lineplots.create(ws.key, {
-        name: "test",
-        data: {},
-      });
-      const retrieved = await userClient.lineplots.retrieve({
-        key: randomLinePlot.key,
-      });
-      expect(retrieved.key).toBe(randomLinePlot.key);
-      expect(retrieved.name).toBe(randomLinePlot.name);
-    });
-
-    it("should allow the caller to create lineplots with the correct policy", async () => {
-      const userClient = await createTestClientWithPolicy(client, {
-        name: "test",
-        objects: [lineplot.ontologyID("")],
-        actions: ["create"],
-      });
-      const ws = await client.workspaces.create({
-        name: "test",
-        layout: {},
-      });
-      await userClient.lineplots.create(ws.key, {
-        name: "test",
-        data: {},
-      });
-    });
-
-    it("should deny access when no create policy exists", async () => {
-      const userClient = await createTestClientWithPolicy(client, {
-        name: "test",
-        objects: [lineplot.ontologyID("")],
-        actions: [],
-      });
-      const ws = await client.workspaces.create({
-        name: "test",
-        layout: {},
-      });
-      await expect(
-        userClient.lineplots.create(ws.key, {
-          name: "test",
-          data: {},
-        }),
-      ).rejects.toThrow(AuthError);
-    });
-
-    it("should allow the caller to delete lineplots with the correct policy", async () => {
-      const userClient = await createTestClientWithPolicy(client, {
-        name: "test",
-        objects: [lineplot.ontologyID("")],
-        actions: ["delete", "retrieve"],
-      });
-      const ws = await client.workspaces.create({
-        name: "test",
-        layout: {},
-      });
-      const randomLinePlot = await client.lineplots.create(ws.key, {
-        name: "test",
-        data: {},
-      });
-      await userClient.lineplots.delete(randomLinePlot.key);
-      await expect(
-        userClient.lineplots.retrieve({ key: randomLinePlot.key }),
-      ).rejects.toThrow(NotFoundError);
-    });
-
-    it("should deny access when no delete policy exists", async () => {
-      const userClient = await createTestClientWithPolicy(client, {
-        name: "test",
-        objects: [lineplot.ontologyID("")],
-        actions: [],
-      });
-      const ws = await client.workspaces.create({
-        name: "test",
-        layout: {},
-      });
-      const randomLinePlot = await client.lineplots.create(ws.key, {
-        name: "test",
-        data: {},
-      });
-      await expect(userClient.lineplots.delete(randomLinePlot.key)).rejects.toThrow(
-        AuthError,
-      );
-    });
-  });
-});

package/src/lineplot/lineplot.spec.ts

@@ -1,120 +0,0 @@
-// 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.
-
-import { uuid } from "@synnaxlabs/x";
-import { describe, expect, test } from "vitest";
-
-import { NotFoundError } from "@/errors";
-import { createTestClient } from "@/testutil/client";
-
-const client = createTestClient();
-
-describe("LinePlot", () => {
-  describe("create", () => {
-    test("create one", async () => {
-      const ws = await client.workspaces.create({
-        name: "Line Plot",
-        layout: { one: 1 },
-      });
-      const linePlot = await client.lineplots.create(ws.key, {
-        name: "Line Plot",
-        data: { one: 1 },
-      });
-      expect(linePlot.name).toEqual("Line Plot");
-      expect(linePlot.key).not.toEqual(uuid.ZERO);
-      expect(linePlot.data.one).toEqual(1);
-    });
-  });
-  describe("rename", () => {
-    test("rename one", async () => {
-      const ws = await client.workspaces.create({
-        name: "Line Plot",
-        layout: { one: 1 },
-      });
-      const linePlot = await client.lineplots.create(ws.key, {
-        name: "Line Plot",
-        data: { one: 1 },
-      });
-      await client.lineplots.rename(linePlot.key, "Line Plot2");
-      const res = await client.lineplots.retrieve({ key: linePlot.key });
-      expect(res.name).toEqual("Line Plot2");
-    });
-  });
-  describe("setData", () => {
-    test("set data", async () => {
-      const ws = await client.workspaces.create({
-        name: "Line Plot",
-        layout: { one: 1 },
-      });
-      const linePlot = await client.lineplots.create(ws.key, {
-        name: "Line Plot",
-        data: { one: 1 },
-      });
-      await client.lineplots.setData(linePlot.key, { two: 2 });
-      const res = await client.lineplots.retrieve({ key: linePlot.key });
-      expect(res.data.two).toEqual(2);
-    });
-  });
-  describe("delete", () => {
-    test("delete one", async () => {
-      const ws = await client.workspaces.create({
-        name: "Line Plot",
-        layout: { one: 1 },
-      });
-      const linePlot = await client.lineplots.create(ws.key, {
-        name: "Line Plot",
-        data: { one: 1 },
-      });
-      await client.lineplots.delete(linePlot.key);
-      await expect(client.lineplots.retrieve({ key: linePlot.key })).rejects.toThrow(
-        NotFoundError,
-      );
-    });
-  });
-  describe("case preservation", () => {
-    test("should preserve key casing in data field on create/retrieve cycle", async () => {
-      const ws = await client.workspaces.create({ name: "CaseTest", layout: {} });
-      const linePlot = await client.lineplots.create(ws.key, {
-        name: "CaseTest",
-        data: {
-          camelCaseKey: "value1",
-          PascalCaseKey: "value2",
-          snake_case_key: "value3",
-          nested: {
-            innerCamelCase: 123,
-            InnerPascalCase: { deepKey: true },
-          },
-        },
-      });
-
-      const retrieved = await client.lineplots.retrieve({
-        key: linePlot.key,
-      });
-
-      const data = retrieved.data as Record<string, unknown>;
-      expect(data.camelCaseKey).toEqual("value1");
-      expect(data.PascalCaseKey).toEqual("value2");
-      expect(data.snake_case_key).toEqual("value3");
-      expect((data.nested as Record<string, unknown>).innerCamelCase).toEqual(123);
-      expect(
-        (
-          (data.nested as Record<string, unknown>).InnerPascalCase as Record<
-            string,
-            unknown
-          >
-        ).deepKey,
-      ).toEqual(true);
-      expect(Object.keys(data)).toContain("camelCaseKey");
-      expect(Object.keys(data)).toContain("PascalCaseKey");
-      expect(Object.keys(data)).toContain("snake_case_key");
-      expect(Object.keys(data)).not.toContain("camel_case_key");
-      expect(Object.keys(data)).not.toContain("pascal_case_key");
-    });
-  });
-});

package/src/log/access.spec.ts

@@ -1,132 +0,0 @@
-// 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.
-
-import { describe, expect, it } from "vitest";
-
-import { AuthError, NotFoundError } from "@/errors";
-import { log } from "@/log";
-import { createTestClientWithPolicy } from "@/testutil/access";
-import { createTestClient } from "@/testutil/client";
-
-const client = createTestClient();
-
-describe("log", () => {
-  describe("access control", () => {
-    it("should deny access when no retrieve policy exists", async () => {
-      const userClient = await createTestClientWithPolicy(client, {
-        name: "test",
-        objects: [],
-        actions: [],
-      });
-      const ws = await client.workspaces.create({
-        name: "test",
-        layout: {},
-      });
-      const randomLog = await client.logs.create(ws.key, {
-        name: "test",
-        data: {},
-      });
-      await expect(userClient.logs.retrieve({ key: randomLog.key })).rejects.toThrow(
-        AuthError,
-      );
-    });
-
-    it("should allow the caller to retrieve logs with the correct policy", async () => {
-      const userClient = await createTestClientWithPolicy(client, {
-        name: "test",
-        objects: [log.ontologyID("")],
-        actions: ["retrieve"],
-      });
-      const ws = await client.workspaces.create({
-        name: "test",
-        layout: {},
-      });
-      const randomLog = await client.logs.create(ws.key, {
-        name: "test",
-        data: {},
-      });
-      const retrieved = await userClient.logs.retrieve({
-        key: randomLog.key,
-      });
-      expect(retrieved.key).toBe(randomLog.key);
-      expect(retrieved.name).toBe(randomLog.name);
-    });
-
-    it("should allow the caller to create logs with the correct policy", async () => {
-      const userClient = await createTestClientWithPolicy(client, {
-        name: "test",
-        objects: [log.ontologyID("")],
-        actions: ["create"],
-      });
-      const ws = await client.workspaces.create({
-        name: "test",
-        layout: {},
-      });
-      await userClient.logs.create(ws.key, {
-        name: "test",
-        data: {},
-      });
-    });
-
-    it("should deny access when no create policy exists", async () => {
-      const userClient = await createTestClientWithPolicy(client, {
-        name: "test",
-        objects: [log.ontologyID("")],
-        actions: [],
-      });
-      const ws = await client.workspaces.create({
-        name: "test",
-        layout: {},
-      });
-      await expect(
-        userClient.logs.create(ws.key, {
-          name: "test",
-          data: {},
-        }),
-      ).rejects.toThrow(AuthError);
-    });
-
-    it("should allow the caller to delete logs with the correct policy", async () => {
-      const userClient = await createTestClientWithPolicy(client, {
-        name: "test",
-        objects: [log.ontologyID("")],
-        actions: ["delete", "retrieve"],
-      });
-      const ws = await client.workspaces.create({
-        name: "test",
-        layout: {},
-      });
-      const randomLog = await client.logs.create(ws.key, {
-        name: "test",
-        data: {},
-      });
-      await userClient.logs.delete(randomLog.key);
-      await expect(userClient.logs.retrieve({ key: randomLog.key })).rejects.toThrow(
-        NotFoundError,
-      );
-    });
-
-    it("should deny access when no delete policy exists", async () => {
-      const userClient = await createTestClientWithPolicy(client, {
-        name: "test",
-        objects: [log.ontologyID("")],
-        actions: [],
-      });
-      const ws = await client.workspaces.create({
-        name: "test",
-        layout: {},
-      });
-      const randomLog = await client.logs.create(ws.key, {
-        name: "test",
-        data: {},
-      });
-      await expect(userClient.logs.delete(randomLog.key)).rejects.toThrow(AuthError);
-    });
-  });
-});

package/src/log/log.spec.ts

@@ -1,106 +0,0 @@
-// 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.
-
-import { uuid } from "@synnaxlabs/x";
-import { describe, expect, test } from "vitest";
-
-import { NotFoundError } from "@/errors";
-import { createTestClient } from "@/testutil/client";
-
-const client = createTestClient();
-
-describe("Log", () => {
-  describe("create", () => {
-    test("create one", async () => {
-      const ws = await client.workspaces.create({ name: "Log", layout: { one: 1 } });
-      const log = await client.logs.create(ws.key, {
-        name: "Log",
-        data: { one: 1 },
-      });
-      expect(log.name).toEqual("Log");
-      expect(log.key).not.toEqual(uuid.ZERO);
-      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.logs.create(ws.key, {
-        name: "Log",
-        data: { one: 1 },
-      });
-      await client.logs.rename(log.key, "Log2");
-      const res = await client.logs.retrieve({ key: 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.logs.create(ws.key, {
-        name: "Log",
-        data: { one: 1 },
-      });
-      await client.logs.setData(log.key, { two: 2 });
-      const res = await client.logs.retrieve({ key: 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.logs.create(ws.key, {
-        name: "Log",
-        data: { one: 1 },
-      });
-      await client.logs.delete(log.key);
-      await expect(client.logs.retrieve({ key: log.key })).rejects.toThrow(
-        NotFoundError,
-      );
-    });
-  });
-  describe("case preservation", () => {
-    test("should preserve key casing in data field on create/retrieve cycle", async () => {
-      const ws = await client.workspaces.create({ name: "CaseTest", layout: {} });
-      const log = await client.logs.create(ws.key, {
-        name: "CaseTest",
-        data: {
-          camelCaseKey: "value1",
-          PascalCaseKey: "value2",
-          snake_case_key: "value3",
-          nested: {
-            innerCamelCase: 123,
-            InnerPascalCase: { deepKey: true },
-          },
-        },
-      });
-
-      const retrieved = await client.logs.retrieve({ key: log.key });
-
-      const data = retrieved.data as Record<string, unknown>;
-      expect(data.camelCaseKey).toEqual("value1");
-      expect(data.PascalCaseKey).toEqual("value2");
-      expect(data.snake_case_key).toEqual("value3");
-      expect((data.nested as Record<string, unknown>).innerCamelCase).toEqual(123);
-      expect(
-        (
-          (data.nested as Record<string, unknown>).InnerPascalCase as Record<
-            string,
-            unknown
-          >
-        ).deepKey,
-      ).toEqual(true);
-      expect(Object.keys(data)).toContain("camelCaseKey");
-      expect(Object.keys(data)).toContain("PascalCaseKey");
-      expect(Object.keys(data)).toContain("snake_case_key");
-      expect(Object.keys(data)).not.toContain("camel_case_key");
-      expect(Object.keys(data)).not.toContain("pascal_case_key");
-    });
-  });
-});