@synnaxlabs/client 0.34.0 → 0.36.0

package/src/workspace/payload.ts

@@ -1,44 +0,0 @@
-// Copyright 2024 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 UnknownRecord, 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[];
-
-// --- VERY IMPORTANT ---
-// Synnax's encoders (in the binary package inside x) automatically convert the case
-// of keys in objects to snake_case and back to camelCase when encoding and decoding
-// respectively. This is done to ensure that the keys are consistent across all
-// languages and platforms. Sometimes workspaces have keys that are uuids, which have
-// dashes, and those get messed up. So we just use regular JSON for workspaces.
-const parse = (s: string): UnknownRecord => JSON.parse(s) as UnknownRecord;
-
-export const workspaceZ = z.object({
-  name: z.string(),
-  key: keyZ,
-  layout: unknownRecordZ.or(z.string().transform((s) => parse(s) as UnknownRecord)),
-});
-
-export const workspaceRemoteZ = workspaceZ.omit({ layout: true }).extend({
-  layout: z.string().transform((s) => parse(s) as UnknownRecord),
-});
-
-export type Workspace = z.infer<typeof workspaceZ>;
-
-export const ONTOLOGY_TYPE: ontology.ResourceType = "workspace";
-
-export const ontologyID = (key: Key): ontology.ID =>
-  new ontology.ID({ type: ONTOLOGY_TYPE, key });

package/src/workspace/retriever.ts

@@ -1,70 +0,0 @@
-// Copyright 2024 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 { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
-import { toArray } from "@synnaxlabs/x/toArray";
-import { z } from "zod";
-
-import { nullableArrayZ } from "@/util/zod";
-import {
-  keyZ,
-  type Params,
-  type Workspace,
-  workspaceRemoteZ,
-} from "@/workspace/payload";
-
-const reqZ = z.object({
-  keys: keyZ.array().optional(),
-  search: z.string().optional(),
-  author: z.string().uuid().optional(),
-  offset: z.number().optional(),
-  limit: z.number().optional(),
-});
-
-type Request = z.infer<typeof reqZ>;
-
-const resZ = z.object({ workspaces: nullableArrayZ(workspaceRemoteZ) });
-
-export class Retriever {
-  private static readonly ENDPOINT = "/workspace/retrieve";
-
-  private readonly client: UnaryClient;
-
-  constructor(client: UnaryClient) {
-    this.client = client;
-  }
-
-  async retrieve(workspaces: Params): Promise<Workspace[]> {
-    const normalized = toArray(workspaces);
-    return await this.execute({ keys: normalized });
-  }
-
-  async retrieveByAuthor(author: string): Promise<Workspace[]> {
-    return await this.execute({ author });
-  }
-
-  async search(term: string): Promise<Workspace[]> {
-    return await this.execute({ search: term });
-  }
-
-  async page(offset: number, limit: number): Promise<Workspace[]> {
-    return await this.execute({ offset, limit });
-  }
-
-  private async execute(request: Request): Promise<Workspace[]> {
-    const res = await sendRequired(
-      this.client,
-      Retriever.ENDPOINT,
-      request,
-      reqZ,
-      resZ,
-    );
-    return res.workspaces;
-  }
-}

package/src/workspace/schematic/external.ts

@@ -1,11 +0,0 @@
-// Copyright 2024 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/payload.ts

@@ -1,38 +0,0 @@
-// Copyright 2024 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 UnknownRecord, 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 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 });

package/src/workspace/schematic/retriever.ts

@@ -1,42 +0,0 @@
-// Copyright 2024 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 { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
-import { toArray } from "@synnaxlabs/x/toArray";
-import { z } from "zod";
-
-import {
-  type Params,
-  type Schematic,
-  schematicRemoteZ,
-} from "@/workspace/schematic/payload";
-
-const reqZ = z.object({ keys: z.string().array() });
-const resZ = z.object({ schematics: schematicRemoteZ.array() });
-
-export class Retriever {
-  private readonly ENDPOINT = "/workspace/schematic/retrieve";
-  private readonly client: UnaryClient;
-
-  constructor(client: UnaryClient) {
-    this.client = client;
-  }
-
-  async retrieve(schematics: Params): Promise<Schematic[]> {
-    return (
-      await sendRequired(
-        this.client,
-        this.ENDPOINT,
-        { keys: toArray(schematics) },
-        reqZ,
-        resZ,
-      )
-    ).schematics;
-  }
-}

package/src/workspace/schematic/writer.ts

@@ -1,140 +0,0 @@
-// Copyright 2024 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 { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
-import { type UnknownRecord } from "@synnaxlabs/x/record";
-import { toArray } from "@synnaxlabs/x/toArray";
-import { z } from "zod";
-
-import { keyZ as workspaceKeyZ } from "@/workspace/payload";
-import {
-  type Key,
-  keyZ,
-  type Params,
-  type Schematic,
-  schematicRemoteZ,
-  schematicZ,
-} from "@/workspace/schematic/payload";
-
-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 createReqZ = z.object({
-  workspace: workspaceKeyZ,
-  schematics: newSchematicZ.array(),
-});
-
-const createResZ = z.object({
-  schematics: schematicRemoteZ.array(),
-});
-
-const deleteReqZ = z.object({
-  keys: keyZ.array(),
-});
-
-const deleteResZ = z.object({});
-
-const renameReqZ = z.object({
-  key: keyZ,
-  name: z.string(),
-});
-
-const renameResZ = z.object({});
-
-const setDataReqZ = z.object({
-  key: keyZ,
-  data: z.string(),
-});
-
-const setDataResZ = z.object({});
-
-const copyReqZ = z.object({
-  key: keyZ,
-  name: z.string(),
-  snapshot: z.boolean(),
-});
-
-const copyResZ = z.object({
-  schematic: schematicRemoteZ,
-});
-
-const CREATE_ENDPOINT = "/workspace/schematic/create";
-const DELETE_ENDPOINT = "/workspace/schematic/delete";
-const RENAME_ENDPOINT = "/workspace/schematic/rename";
-const SET_DATA_ENDPOINT = "/workspace/schematic/set-data";
-const COPY_ENDPOINT = "/workspace/schematic/copy";
-
-export class Writer {
-  private readonly client: UnaryClient;
-
-  constructor(client: UnaryClient) {
-    this.client = client;
-  }
-
-  async create(workspace: string, schematic: NewSchematic): Promise<Schematic> {
-    const schematic_ = { ...schematic, data: JSON.stringify(schematic.data) };
-    const res = await sendRequired<typeof createReqZ, typeof createResZ>(
-      this.client,
-      CREATE_ENDPOINT,
-      { workspace, schematics: [schematic_] },
-      createReqZ,
-      createResZ,
-    );
-
-    return res.schematics[0];
-  }
-
-  async copy(key: Key, name: string, snapshot: boolean): Promise<Schematic> {
-    const res = await sendRequired<typeof copyReqZ, typeof copyResZ>(
-      this.client,
-      COPY_ENDPOINT,
-      { key, name, snapshot },
-      copyReqZ,
-      copyResZ,
-    );
-    return res.schematic;
-  }
-
-  async delete(schematics: Params): Promise<void> {
-    const normalized = toArray(schematics);
-    await sendRequired<typeof deleteReqZ, typeof deleteResZ>(
-      this.client,
-      DELETE_ENDPOINT,
-      { keys: normalized },
-      deleteReqZ,
-      deleteResZ,
-    );
-  }
-
-  async rename(schematic: Key, name: string): Promise<void> {
-    await sendRequired<typeof renameReqZ, typeof renameResZ>(
-      this.client,
-      RENAME_ENDPOINT,
-      { key: schematic, name },
-      renameReqZ,
-      renameResZ,
-    );
-  }
-
-  async setData(schematic: Key, data: UnknownRecord): Promise<void> {
-    await sendRequired<typeof setDataReqZ, typeof setDataResZ>(
-      this.client,
-      SET_DATA_ENDPOINT,
-      { key: schematic, data: JSON.stringify(data) },
-      setDataReqZ,
-      setDataResZ,
-    );
-  }
-}

package/src/workspace/writer.ts

@@ -1,111 +0,0 @@
-// Copyright 2024 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 { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
-import { type UnknownRecord } from "@synnaxlabs/x/record";
-import { toArray } from "@synnaxlabs/x/toArray";
-import { z } from "zod";
-
-import {
-  keyZ,
-  type Workspace,
-  workspaceRemoteZ,
-  workspaceZ,
-} from "@/workspace/payload";
-
-const newWorkspaceZ = workspaceZ.partial({ key: true }).transform((w) => ({
-  ...w,
-  layout: JSON.stringify(w.layout),
-}));
-
-export type NewWorkspace = z.input<typeof newWorkspaceZ>;
-
-const createReqZ = z.object({
-  workspaces: newWorkspaceZ.array(),
-});
-
-const createResZ = z.object({
-  workspaces: workspaceRemoteZ.array(),
-});
-
-const deleteReqZ = z.object({
-  keys: keyZ.array(),
-});
-
-const deleteResZ = z.object({});
-
-const renameReqZ = z.object({
-  key: keyZ,
-  name: z.string(),
-});
-
-const renameResZ = z.object({});
-
-const setLayoutReqZ = z.object({
-  key: keyZ,
-  layout: z.string(),
-});
-
-const setLayoutResZ = z.object({});
-
-export type CreateResponse = z.infer<typeof createResZ>;
-
-const CREATE_ENDPOINT = "/workspace/create";
-const DELETE_ENDPOINT = "/workspace/delete";
-const RENAME_ENDPOINT = "/workspace/rename";
-const SET_LAYOUT_ENDPOINT = "/workspace/set-layout";
-
-export class Writer {
-  private readonly client: UnaryClient;
-
-  constructor(client: UnaryClient) {
-    this.client = client;
-  }
-
-  async create(workspaces: NewWorkspace | NewWorkspace[]): Promise<Workspace[]> {
-    const res = await sendRequired<typeof createReqZ, typeof createResZ>(
-      this.client,
-      CREATE_ENDPOINT,
-      { workspaces: toArray(workspaces) },
-      createReqZ,
-      createResZ,
-    );
-    return res.workspaces;
-  }
-
-  async delete(keys: string | string[]): Promise<void> {
-    await sendRequired<typeof deleteReqZ, typeof deleteResZ>(
-      this.client,
-      DELETE_ENDPOINT,
-      { keys: toArray(keys) },
-      deleteReqZ,
-      deleteResZ,
-    );
-  }
-
-  async rename(key: string, name: string): Promise<void> {
-    await sendRequired<typeof renameReqZ, typeof renameResZ>(
-      this.client,
-      RENAME_ENDPOINT,
-      { key, name },
-      renameReqZ,
-      renameResZ,
-    );
-  }
-
-  async setLayout(key: string, layout: UnknownRecord): Promise<void> {
-    await sendRequired<typeof setLayoutReqZ, typeof setLayoutResZ>(
-      this.client,
-      SET_LAYOUT_ENDPOINT,
-      { key, layout: JSON.stringify(layout) },
-      setLayoutReqZ,
-      setLayoutResZ,
-    );
-  }
-}