@synnaxlabs/client 0.56.1 → 0.57.0

package/src/workspace/access.spec.ts

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

package/src/workspace/client.ts

@@ -1,112 +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 { type UnaryClient } from "@synnaxlabs/freighter";
-import { array, caseconv, record } from "@synnaxlabs/x";
-import { z } from "zod";
-
-import { keyZ as userKeyZ } from "@/user/types.gen";
-import {
-  type Key,
-  keyZ,
-  type New,
-  newZ,
-  type Workspace,
-  workspaceZ,
-} from "@/workspace/types.gen";
-
-const retrieveReqZ = z.object({
-  keys: keyZ.array().optional(),
-  searchTerm: z.string().optional(),
-  author: userKeyZ.optional(),
-  offset: z.int().optional(),
-  limit: z.int().optional(),
-});
-export interface RetrieveRequest extends z.infer<typeof retrieveReqZ> {}
-const createReqZ = z.object({ workspaces: newZ.array() });
-const renameReqZ = z.object({ key: keyZ, name: z.string() });
-const setLayoutReqZ = z.object({
-  key: keyZ,
-  layout: caseconv.preserveCase(record.unknownZ()),
-});
-const deleteReqZ = z.object({ keys: keyZ.array() });
-
-const retrieveResZ = z.object({ workspaces: array.nullishToEmpty(workspaceZ) });
-const createResZ = z.object({ workspaces: workspaceZ.array() });
-const emptyResZ = z.object({});
-
-export const SET_CHANNEL_NAME = "sy_workspace_set";
-export const DELETE_CHANNEL_NAME = "sy_workspace_delete";
-
-export interface SetLayoutArgs extends z.input<typeof setLayoutReqZ> {}
-
-export class Client {
-  private readonly client: UnaryClient;
-
-  constructor(client: UnaryClient) {
-    this.client = client;
-  }
-
-  async create(workspace: New): Promise<Workspace>;
-  async create(workspaces: New[]): Promise<Workspace[]>;
-  async create(workspaces: New | New[]): Promise<Workspace | Workspace[]> {
-    const isMany = Array.isArray(workspaces);
-    const res = await this.client.send(
-      "/workspace/create",
-      { workspaces: array.toArray(workspaces) },
-      createReqZ,
-      createResZ,
-    );
-    return isMany ? res.workspaces : res.workspaces[0];
-  }
-
-  async rename(key: Key, name: string): Promise<void> {
-    await this.client.send("/workspace/rename", { key, name }, renameReqZ, emptyResZ);
-  }
-
-  async setLayout(key: Key, layout: record.Unknown): Promise<void> {
-    await this.client.send(
-      "/workspace/set-layout",
-      { key, layout },
-      setLayoutReqZ,
-      emptyResZ,
-    );
-  }
-
-  async retrieve(key: Key): Promise<Workspace>;
-  async retrieve(keys: Key[]): Promise<Workspace[]>;
-  async retrieve(req: RetrieveRequest): Promise<Workspace[]>;
-  async retrieve(
-    keys: Key | Key[] | RetrieveRequest,
-  ): Promise<Workspace | Workspace[]> {
-    let req: RetrieveRequest;
-    const isMany: boolean = typeof keys !== "string";
-    if (typeof keys === "string" || Array.isArray(keys))
-      req = { keys: array.toArray(keys) };
-    else req = keys;
-    const res = await this.client.send(
-      "/workspace/retrieve",
-      req,
-      retrieveReqZ,
-      retrieveResZ,
-    );
-    return isMany ? res.workspaces : res.workspaces[0];
-  }
-
-  async delete(key: Key): Promise<void>;
-  async delete(keys: Key[]): Promise<void>;
-  async delete(keys: Key | Key[]): Promise<void> {
-    await this.client.send(
-      "/workspace/delete",
-      { keys: array.toArray(keys) },
-      deleteReqZ,
-      emptyResZ,
-    );
-  }
-}

package/src/workspace/types.gen.ts

@@ -1,46 +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.
-
-// Code generated by Oracle. DO NOT EDIT.
-
-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>;
-
-/**
- * Workspace is a named, persistable container that stores the layout and organization
- * of the Console application. Workspaces allow users to save and restore
- * custom arrangements of visualizations, tabs, and window configurations.
- */
-export const workspaceZ = z.object({
-  /** key is the unique identifier for this workspace. */
-  key: keyZ,
-  /** 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: user.keyZ.optional(),
-  /**
-   * layout is the mosaic tree structure that defines how visualizations are
-   * arranged. Contains tab layout, split configurations, and window
-   * positions.
-   */
-  layout: caseconv.preserveCase(record.nullishToEmpty()),
-});
-export interface Workspace extends z.infer<typeof workspaceZ> {}
-
-export const newZ = workspaceZ.omit({ author: true }).partial({ key: true });
-export interface New extends z.input<typeof newZ> {}
-
-export const ontologyID = ontology.createIDFactory<Key>("workspace");
-export const TYPE_ONTOLOGY_ID = ontologyID("");

package/src/workspace/workspace.spec.ts

@@ -1,111 +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, uuid } from "@synnaxlabs/x";
-import { describe, expect, test } from "vitest";
-
-import { createTestClient } from "@/testutil/client";
-
-const client = createTestClient();
-
-describe("Workspace", () => {
-  describe("create", () => {
-    test("create one", async () => {
-      const ws = await client.workspaces.create({
-        name: "Schematic",
-        layout: { one: 1 },
-      });
-      expect(ws.name).toEqual("Schematic");
-      expect(ws.key).not.toEqual(uuid.ZERO);
-      expect(ws.layout.one).toEqual(1);
-    });
-  });
-  describe("rename", () => {
-    test("rename one", async () => {
-      const ws = await client.workspaces.create({
-        name: "Schematic",
-        layout: { one: 1 },
-      });
-      await client.workspaces.rename(ws.key, "Schematic2");
-      const res = await client.workspaces.retrieve(ws.key);
-      expect(res.name).toEqual("Schematic2");
-    });
-  });
-  describe("setLayout", () => {
-    test("set layout", async () => {
-      const ws = await client.workspaces.create({
-        name: "Schematic",
-        layout: { one: 1 },
-      });
-      await client.workspaces.setLayout(ws.key, { two: 2 });
-      const res = await client.workspaces.retrieve(ws.key);
-      expect(res.layout.two).toEqual(2);
-    });
-  });
-  describe("delete", () => {
-    test("delete one", async () => {
-      const ws = await client.workspaces.create({
-        name: "Schematic",
-        layout: { one: 1 },
-      });
-      await client.workspaces.delete(ws.key);
-      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({
-        name: "CaseTest",
-        layout: {
-          camelCaseKey: "value1",
-          PascalCaseKey: "value2",
-          snake_case_key: "value3",
-          nested: {
-            innerCamelCase: 123,
-            InnerPascalCase: { deepKey: true },
-          },
-        },
-      });
-
-      const retrieved = await client.workspaces.retrieve(ws.key);
-
-      const layout = retrieved.layout as Record<string, unknown>;
-      expect(layout.camelCaseKey).toEqual("value1");
-      expect(layout.PascalCaseKey).toEqual("value2");
-      expect(layout.snake_case_key).toEqual("value3");
-      expect((layout.nested as Record<string, unknown>).innerCamelCase).toEqual(123);
-      expect(
-        (
-          (layout.nested as Record<string, unknown>).InnerPascalCase as Record<
-            string,
-            unknown
-          >
-        ).deepKey,
-      ).toEqual(true);
-      expect(Object.keys(layout)).toContain("camelCaseKey");
-      expect(Object.keys(layout)).toContain("PascalCaseKey");
-      expect(Object.keys(layout)).toContain("snake_case_key");
-      expect(Object.keys(layout)).not.toContain("camel_case_key");
-      expect(Object.keys(layout)).not.toContain("pascal_case_key");
-    });
-  });
-});

package/tsconfig.json

@@ -1,5 +0,0 @@
-{
-  "extends": "@synnaxlabs/tsconfig/base.json",
-  "compilerOptions": { "types": ["node"], "paths": { "@/*": ["./src/*"] } },
-  "include": ["src/**/*", "eslint.config.ts"]
-}

package/tsconfig.vite.json

@@ -1,4 +0,0 @@
-{
-  "extends": "@synnaxlabs/tsconfig/vite.json",
-  "include": ["vite.config.ts"]
-}

package/vite.config.ts

@@ -1,29 +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.
-
-/// <reference types="vitest/config" />
-
-import { lib } from "@synnaxlabs/vite-plugin";
-import { defineConfig } from "vite";
-
-import packageJSON from "./package.json";
-
-export default defineConfig({
-  define: { __VERSION__: JSON.stringify(packageJSON.version) },
-  plugins: [lib({ name: "client" })],
-  build: { rolldownOptions: { external: ["zod"] } },
-  test: {
-    globals: true,
-    exclude: ["**/node_modules/**", "**/dist/**"],
-    coverage: {
-      include: ["src/**/*.ts", "src/**/*.tsx"],
-      exclude: ["src/**/*.spec.ts", "src/**/*.spec.tsx", "src/**/*.bench.ts"],
-    },
-  },
-});