@synnaxlabs/client 0.38.1 → 0.39.0

package/src/workspace/payload.ts

@@ -0,0 +1,36 @@
+// Copyright 2025 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 { unknownRecordZ } from "@synnaxlabs/x/record";
+import { z } from "zod";
+
+import { parseWithoutKeyConversion } from "@/util/parseWithoutKeyConversion";
+
+export const keyZ = z.string().uuid();
+export type Key = z.infer<typeof keyZ>;
+export type Params = Key | Key[];
+
+export const workspaceZ = z.object({
+  key: keyZ,
+  name: z.string(),
+  layout: unknownRecordZ.or(z.string().transform(parseWithoutKeyConversion)),
+});
+export interface Workspace extends z.infer<typeof workspaceZ> {}
+
+export const ONTOLOGY_TYPE = "workspace";
+export type OntologyType = typeof ONTOLOGY_TYPE;
+
+export const newZ = workspaceZ
+  .partial({ key: true })
+  .transform((p) => ({ ...p, layout: JSON.stringify(p.layout) }));
+export interface New extends z.input<typeof newZ> {}
+
+export const remoteZ = workspaceZ
+  .omit({ layout: true })
+  .extend({ layout: z.string().transform(parseWithoutKeyConversion) });

package/src/workspace/schematic/client.ts

@@ -9,36 +9,22 @@
 
 import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
 import { toArray, type UnknownRecord } from "@synnaxlabs/x";
-import { unknownRecordZ } from "@synnaxlabs/x/record";
 import { z } from "zod";
 
 import { ontology } from "@/ontology";
 import { nullableArrayZ } from "@/util/zod";
-
-export const keyZ = z.string().uuid();
-export type Key = z.infer<typeof keyZ>;
-export type Params = Key | Key[];
-
-export const schematicZ = z.object({
-  key: z.string(),
-  name: z.string(),
-  data: unknownRecordZ.or(z.string().transform((s) => JSON.parse(s) as UnknownRecord)),
-  snapshot: z.boolean(),
-});
-
-export const schematicRemoteZ = z.object({
-  key: z.string(),
-  name: z.string(),
-  snapshot: z.boolean(),
-  data: z.string().transform((s) => JSON.parse(s) as UnknownRecord),
-});
-
-export type Schematic = z.infer<typeof schematicZ>;
-
-export const ONTOLOGY_TYPE: ontology.ResourceType = "schematic";
-
-export const ontologyID = (key: Key): ontology.ID =>
-  new ontology.ID({ type: ONTOLOGY_TYPE, key });
+import { type Key as WorkspaceKey, keyZ as workspaceKeyZ } from "@/workspace/payload";
+import {
+  type Key,
+  keyZ,
+  type New,
+  newZ,
+  ONTOLOGY_TYPE,
+  type Params,
+  remoteZ,
+  type Schematic,
+  schematicZ,
+} from "@/workspace/schematic/payload";
 
 const RETRIEVE_ENDPOINT = "/workspace/schematic/retrieve";
 const CREATE_ENDPOINT = "/workspace/schematic/create";
@@ -47,27 +33,15 @@ const SET_DATA_ENDPOINT = "/workspace/schematic/set-data";
 const DELETE_ENDPOINT = "/workspace/schematic/delete";
 const COPY_ENDPOINT = "/workspace/schematic/copy";
 
-export const newSchematicZ = schematicZ
-  .partial({ key: true, snapshot: true })
-  .transform((p) => ({
-    ...p,
-    data: JSON.stringify(p.data),
-  }));
-
-export type NewSchematic = z.input<typeof newSchematicZ>;
-
-const retrieveReqZ = z.object({ keys: z.string().array() });
-const createReqZ = z.object({
-  workspace: z.string(),
-  schematics: newSchematicZ.array(),
-});
-const renameReqZ = z.object({ key: z.string(), name: z.string() });
-const setDataReqZ = z.object({ key: z.string(), data: z.string() });
-const deleteReqZ = z.object({ keys: z.string().array() });
-const copyReqZ = z.object({ key: z.string(), name: z.string(), snapshot: z.boolean() });
+const retrieveReqZ = z.object({ keys: keyZ.array() });
+const createReqZ = z.object({ workspace: workspaceKeyZ, schematics: newZ.array() });
+const renameReqZ = z.object({ key: keyZ, name: z.string() });
+const setDataReqZ = z.object({ key: keyZ, data: z.string() });
+const deleteReqZ = z.object({ keys: keyZ.array() });
+const copyReqZ = z.object({ key: keyZ, name: z.string(), snapshot: z.boolean() });
 
-const retrieveResZ = z.object({ schematics: nullableArrayZ(schematicRemoteZ) });
-const createResZ = z.object({ schematics: schematicRemoteZ.array() });
+const retrieveResZ = z.object({ schematics: nullableArrayZ(remoteZ) });
+const createResZ = z.object({ schematics: remoteZ.array() });
 const copyResZ = z.object({ schematic: schematicZ });
 const emptyResZ = z.object({});
 
@@ -78,18 +52,17 @@ export class Client {
     this.client = client;
   }
 
-  async create(workspace: string, schematic: NewSchematic): Promise<Schematic>;
-  async create(workspace: string, schematics: NewSchematic[]): Promise<Schematic[]>;
+  async create(workspace: WorkspaceKey, schematic: New): Promise<Schematic>;
+  async create(workspace: WorkspaceKey, schematics: New[]): Promise<Schematic[]>;
   async create(
-    workspace: string,
-    schematics: NewSchematic | NewSchematic[],
+    workspace: WorkspaceKey,
+    schematics: New | New[],
   ): Promise<Schematic | Schematic[]> {
     const isMany = Array.isArray(schematics);
-    const normalized = toArray(schematics);
     const res = await sendRequired(
       this.client,
       CREATE_ENDPOINT,
-      { workspace, schematics: normalized },
+      { workspace, schematics: toArray(schematics) },
       createReqZ,
       createResZ,
     );
@@ -120,11 +93,10 @@ export class Client {
   async retrieve(keys: Key[]): Promise<Schematic[]>;
   async retrieve(keys: Params): Promise<Schematic | Schematic[]> {
     const isMany = Array.isArray(keys);
-    const normalized = toArray(keys);
     const res = await sendRequired(
       this.client,
       RETRIEVE_ENDPOINT,
-      { keys: normalized },
+      { keys: toArray(keys) },
       retrieveReqZ,
       retrieveResZ,
     );
@@ -134,11 +106,10 @@ export class Client {
   async delete(key: Key): Promise<void>;
   async delete(keys: Key[]): Promise<void>;
   async delete(keys: Params): Promise<void> {
-    const normalized = toArray(keys);
     await sendRequired(
       this.client,
       DELETE_ENDPOINT,
-      { keys: normalized },
+      { keys: toArray(keys) },
       deleteReqZ,
       emptyResZ,
     );
@@ -155,3 +126,6 @@ export class Client {
     return res.schematic;
   }
 }
+
+export const ontologyID = (key: Key): ontology.ID =>
+  new ontology.ID({ type: ONTOLOGY_TYPE, key });

package/src/workspace/schematic/external.ts

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

package/src/workspace/schematic/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 schematic from "@/workspace/schematic/client";
+export * as schematic from "@/workspace/schematic/external";

package/src/workspace/schematic/payload.ts

@@ -0,0 +1,37 @@
+// Copyright 2025 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 { unknownRecordZ } from "@synnaxlabs/x/record";
+import { z } from "zod";
+
+import { parseWithoutKeyConversion } from "@/util/parseWithoutKeyConversion";
+
+export const keyZ = z.string().uuid();
+export type Key = z.infer<typeof keyZ>;
+export type Params = Key | Key[];
+
+export const schematicZ = z.object({
+  key: keyZ,
+  name: z.string(),
+  data: unknownRecordZ.or(z.string().transform(parseWithoutKeyConversion)),
+  snapshot: z.boolean(),
+});
+export interface Schematic extends z.infer<typeof schematicZ> {}
+
+export const newZ = schematicZ
+  .partial({ key: true, snapshot: true })
+  .transform((p) => ({ ...p, data: JSON.stringify(p.data) }));
+export interface New extends z.input<typeof newZ> {}
+
+export const remoteZ = schematicZ.extend({
+  data: z.string().transform(parseWithoutKeyConversion),
+});
+
+export const ONTOLOGY_TYPE = "schematic";
+export type OntologyType = typeof ONTOLOGY_TYPE;

package/src/workspace/schematic/schematic.spec.ts

@@ -7,15 +7,14 @@
 // 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,test } from "vitest";
+import { NIL as ZERO_UUID } from "uuid";
+import { describe, expect, it, test } from "vitest";
 
 import { ValidationError } from "@/errors";
 import { newClient } from "@/setupspecs";
 
 const client = newClient();
 
-const ZERO_UUID = "00000000-0000-0000-0000-000000000000";
-
 describe("Schematic", () => {
   describe("create", () => {
     test("create one", async () => {
@@ -73,7 +72,9 @@ describe("Schematic", () => {
         data: { one: 1 },
       });
       await client.workspaces.schematic.delete(schematic.key);
-      await expect(client.workspaces.schematic.retrieve(schematic.key)).rejects.toThrow();
+      await expect(
+        client.workspaces.schematic.retrieve(schematic.key),
+      ).rejects.toThrow();
     });
   });
   describe("copy", () => {
@@ -86,7 +87,11 @@ describe("Schematic", () => {
         name: "Schematic",
         data: { one: 1 },
       });
-      const schematic2 = await client.workspaces.schematic.copy(schematic.key, "Schematic2", false);
+      const schematic2 = await client.workspaces.schematic.copy(
+        schematic.key,
+        "Schematic2",
+        false,
+      );
       expect(schematic2.name).toEqual("Schematic2");
       expect(schematic2.key).not.toEqual(ZERO_UUID);
       expect(schematic2.data.one).toEqual(1);
@@ -101,7 +106,11 @@ describe("Schematic", () => {
           name: "Schematic",
           data: { one: 1 },
         });
-        const schematic2 = await client.workspaces.schematic.copy(schematic.key, "Schematic2", true);
+        const schematic2 = await client.workspaces.schematic.copy(
+          schematic.key,
+          "Schematic2",
+          true,
+        );
         await expect(
           client.workspaces.schematic.setData(schematic2.key, { two: 2 }),
         ).rejects.toThrow(ValidationError);

package/src/workspace/table/client.ts

@@ -9,27 +9,20 @@
 
 import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
 import { toArray, type UnknownRecord } from "@synnaxlabs/x";
-import { unknownRecordZ } from "@synnaxlabs/x/record";
 import { z } from "zod";
 
 import { ontology } from "@/ontology";
-
-export const keyZ = z.string().uuid();
-export type Key = z.infer<typeof keyZ>;
-export type Params = Key | Key[];
-
-export const tableZ = z.object({
-  key: z.string(),
-  name: z.string(),
-  data: unknownRecordZ.or(z.string().transform((s) => JSON.parse(s) as UnknownRecord)),
-});
-
-export type Table = z.infer<typeof tableZ>;
-
-export const ONTOLOGY_TYPE: ontology.ResourceType = "table";
-
-export const ontologyID = (key: Key): ontology.ID =>
-  new ontology.ID({ type: ONTOLOGY_TYPE, key });
+import { type Key as WorkspaceKey, keyZ as workspaceKeyZ } from "@/workspace/payload";
+import {
+  type Key,
+  keyZ,
+  type New,
+  newZ,
+  ONTOLOGY_TYPE,
+  type Params,
+  remoteZ,
+  type Table,
+} from "@/workspace/table/payload";
 
 const RETRIEVE_ENDPOINT = "/workspace/table/retrieve";
 const CREATE_ENDPOINT = "/workspace/table/create";
@@ -37,27 +30,14 @@ const RENAME_ENDPOINT = "/workspace/table/rename";
 const SET_DATA_ENDPOINT = "/workspace/table/set-data";
 const DELETE_ENDPOINT = "/workspace/table/delete";
 
-export const newTableZ = tableZ.partial({ key: true }).transform((p) => ({
-  ...p,
-  data: JSON.stringify(p.data),
-}));
+const retrieveReqZ = z.object({ keys: keyZ.array() });
+const createReqZ = z.object({ workspace: workspaceKeyZ, tables: newZ.array() });
+const renameReqZ = z.object({ key: keyZ, name: z.string() });
+const setDataReqZ = z.object({ key: keyZ, data: z.string() });
+const deleteReqZ = z.object({ keys: keyZ.array() });
 
-export type NewTable = z.input<typeof newTableZ>;
-
-export const tableRemoteZ = z.object({
-  key: z.string(),
-  name: z.string(),
-  data: z.string().transform((s) => JSON.parse(s) as UnknownRecord),
-});
-
-const retrieveReqZ = z.object({ keys: z.string().array() });
-const createReqZ = z.object({ workspace: z.string(), tables: newTableZ.array() });
-const renameReqZ = z.object({ key: z.string(), name: z.string() });
-const setDataReqZ = z.object({ key: z.string(), data: z.string() });
-const deleteReqZ = z.object({ keys: z.string().array() });
-
-const retrieveResZ = z.object({ tables: tableRemoteZ.array() });
-const createResZ = z.object({ tables: tableRemoteZ.array() });
+const retrieveResZ = z.object({ tables: remoteZ.array() });
+const createResZ = z.object({ tables: remoteZ.array() });
 const emptyResZ = z.object({});
 
 export class Client {
@@ -67,18 +47,14 @@ export class Client {
     this.client = client;
   }
 
-  async create(workspace: string, table: NewTable): Promise<Table>;
-  async create(workspace: string, tables: NewTable[]): Promise<Table[]>;
-  async create(
-    workspace: string,
-    tables: NewTable | NewTable[],
-  ): Promise<Table | Table[]> {
+  async create(workspace: WorkspaceKey, table: New): Promise<Table>;
+  async create(workspace: WorkspaceKey, tables: New[]): Promise<Table[]>;
+  async create(workspace: WorkspaceKey, tables: New | New[]): Promise<Table | Table[]> {
     const isMany = Array.isArray(tables);
-    const normalized = toArray(tables);
     const res = await sendRequired(
       this.client,
       CREATE_ENDPOINT,
-      { workspace, tables: normalized },
+      { workspace, tables: toArray(tables) },
       createReqZ,
       createResZ,
     );
@@ -109,11 +85,10 @@ export class Client {
   async retrieve(keys: Key[]): Promise<Table[]>;
   async retrieve(keys: Params): Promise<Table | Table[]> {
     const isMany = Array.isArray(keys);
-    const normalized = toArray(keys);
     const res = await sendRequired(
       this.client,
       RETRIEVE_ENDPOINT,
-      { keys: normalized },
+      { keys: toArray(keys) },
       retrieveReqZ,
       retrieveResZ,
     );
@@ -123,13 +98,15 @@ export class Client {
   async delete(key: Key): Promise<void>;
   async delete(keys: Key[]): Promise<void>;
   async delete(keys: Params): Promise<void> {
-    const normalized = toArray(keys);
     await sendRequired(
       this.client,
       DELETE_ENDPOINT,
-      { keys: normalized },
+      { keys: toArray(keys) },
       deleteReqZ,
       emptyResZ,
     );
   }
 }
+
+export const ontologyID = (key: Key): ontology.ID =>
+  new ontology.ID({ type: ONTOLOGY_TYPE, key });

package/src/workspace/table/external.ts

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

package/src/workspace/table/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 table from "@/workspace/table/client";
+export * as table from "@/workspace/table/external";

package/src/workspace/table/payload.ts

@@ -0,0 +1,36 @@
+// Copyright 2025 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 { unknownRecordZ } from "@synnaxlabs/x/record";
+import { z } from "zod";
+
+import { parseWithoutKeyConversion } from "@/util/parseWithoutKeyConversion";
+
+export const keyZ = z.string().uuid();
+export type Key = z.infer<typeof keyZ>;
+export type Params = Key | Key[];
+
+export const tableZ = z.object({
+  key: keyZ,
+  name: z.string(),
+  data: unknownRecordZ.or(z.string().transform(parseWithoutKeyConversion)),
+});
+export interface Table extends z.infer<typeof tableZ> {}
+
+export const newZ = tableZ
+  .partial({ key: true })
+  .transform((p) => ({ ...p, data: JSON.stringify(p.data) }));
+export interface New extends z.input<typeof newZ> {}
+
+export const remoteZ = tableZ.extend({
+  data: z.string().transform(parseWithoutKeyConversion),
+});
+
+export const ONTOLOGY_TYPE = "table";
+export type OntologyType = typeof ONTOLOGY_TYPE;

package/src/workspace/workspace.spec.ts

@@ -7,14 +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 { NIL as ZERO_UUID } from "uuid";
 import { describe, expect, test } from "vitest";
 
 import { newClient } from "@/setupspecs";
 
 const client = newClient();
 
-const ZERO_UUID = "00000000-0000-0000-0000-000000000000";
-
 describe("Workspace", () => {
   describe("create", () => {
     test("create one", async () => {

package/dist/channel/creator.d.ts

@@ -1,9 +0,0 @@
-import { UnaryClient } from '@synnaxlabs/freighter';
-import { NewPayload, Payload } from './payload';
-export declare class Creator {
-    private static readonly ENDPOINT;
-    private readonly client;
-    constructor(client: UnaryClient);
-    create(channels: NewPayload[]): Promise<Payload[]>;
-}
-//# sourceMappingURL=creator.d.ts.map

package/dist/channel/creator.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"creator.d.ts","sourceRoot":"","sources":["../../src/channel/creator.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAGzD,OAAO,EAAE,KAAK,UAAU,EAAa,KAAK,OAAO,EAAW,MAAM,mBAAmB,CAAC;AAMtF,qBAAa,OAAO;IAClB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAqB;IACrD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;gBAEzB,MAAM,EAAE,WAAW;IAIzB,MAAM,CAAC,QAAQ,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;CAUzD"}

package/src/channel/creator.ts

@@ -1,37 +0,0 @@
-// Copyright 2025 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 { z } from "zod";
-
-import { type NewPayload,newPayload, type Payload, payload } from "@/channel/payload";
-
-const reqZ = z.object({ channels: newPayload.array() });
-
-const resZ = z.object({ channels: payload.array() });
-
-export class Creator {
-  private static readonly ENDPOINT = "/channel/create";
-  private readonly client: UnaryClient;
-
-  constructor(client: UnaryClient) {
-    this.client = client;
-  }
-
-  async create(channels: NewPayload[]): Promise<Payload[]> {
-    const [res, err] = await this.client.send<typeof reqZ, typeof resZ>(
-      Creator.ENDPOINT,
-      { channels },
-      reqZ,
-      resZ,
-    );
-    if (err != null) throw err;
-    return res.channels;
-  }
-}