@synnaxlabs/client 0.16.3 → 0.17.0

package/src/ranger/active.ts

@@ -7,12 +7,11 @@
 // 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 { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
 import { z } from "zod";
 
-import { QueryError } from "..";
-
-import { type Payload, payloadZ, type Key } from "./payload";
+import { QueryError } from "@/errors";
+import { type Payload, payloadZ, type Key, keyZ } from "@/ranger/payload";
 
 const setActiveResZ = z.object({});
 
@@ -20,6 +19,14 @@ const retrieveActiveResZ = z.object({
   range: payloadZ,
 });
 
+const setActiveReqZ = z.object({
+  range: keyZ,
+});
+
+const clearActiveReqZ = z.object({
+  range: keyZ,
+});
+
 const clearActiveResZ = z.object({});
 
 const SET_ENDPOINT = "/range/set-active";
@@ -34,14 +41,20 @@ export class Active {
   }
 
   async setActive(range: Key): Promise<void> {
-    const [, err] = await this.client.send(SET_ENDPOINT, { range }, setActiveResZ);
-    if (err != null) throw err;
+    await sendRequired<typeof setActiveReqZ, typeof setActiveResZ>(
+      this.client,
+      SET_ENDPOINT, 
+      { range }, 
+      setActiveReqZ, 
+      setActiveResZ,
+    );
   }
 
   async retrieveActive(): Promise<Payload | null> {
     const [res, err] = await this.client.send(
       RETRIEVE_ENDPOINT,
       {},
+      z.object({}),
       retrieveActiveResZ,
     );
     if (err instanceof QueryError) return null;
@@ -50,7 +63,12 @@ export class Active {
   }
 
   async clearActive(range: Key): Promise<void> {
-    const [, err] = await this.client.send(CLEAR_ENDPOINT, { range }, clearActiveResZ);
-    if (err != null) throw err;
+    await sendRequired<typeof clearActiveReqZ, typeof clearActiveResZ>(
+      this.client,
+      CLEAR_ENDPOINT, 
+      { range }, 
+      clearActiveReqZ,
+      clearActiveResZ,
+    );
   }
 }

package/src/ranger/alias.ts

@@ -31,7 +31,7 @@ const resolveResZ = z.object({
 
 const setReqZ = z.object({
   range: keyZ,
-  aliases: z.record(channelKeyZ, z.string()),
+  aliases: z.record(channelKeyZ.or(z.string()), z.string()),
 });
 
 const setResZ = z.unknown();
@@ -93,6 +93,7 @@ export class Aliaser {
       this.client,
       Aliaser.RESOLVE_ENDPOINT,
       { range: this.rangeKey, aliases: toFetch },
+      resolveReqZ,
       resolveResZ,
     );
     Object.entries(res.aliases).forEach(([alias, key]) => this.cache.set(alias, key));
@@ -103,11 +104,9 @@ export class Aliaser {
     await sendRequired<typeof setReqZ, typeof setResZ>(
       this.client,
       Aliaser.SET_ENDPOINT,
-      {
-        range: this.rangeKey,
-        aliases,
-      },
-      z.unknown(),
+      { range: this.rangeKey, aliases },
+      setReqZ,
+      setResZ,
     );
   }
 
@@ -116,9 +115,8 @@ export class Aliaser {
       await sendRequired<typeof listReqZ, typeof listResZ>(
         this.client,
         Aliaser.LIST_ENDPOINT,
-        {
-          range: this.rangeKey,
-        },
+        { range: this.rangeKey },
+        listReqZ,
         listResZ,
       )
     ).aliases;
@@ -128,10 +126,8 @@ export class Aliaser {
     await sendRequired<typeof deleteReqZ, typeof deleteResZ>(
       this.client,
       Aliaser.DELETE_ENDPOINT,
-      {
-        range: this.rangeKey,
-        channels: aliases,
-      },
+      { range: this.rangeKey, channels: aliases },
+      deleteReqZ,
       deleteResZ,
     );
   }

package/src/ranger/client.ts

@@ -14,7 +14,6 @@ import { type Retriever as ChannelRetriever } from "@/channel/retriever";
 import { QueryError } from "@/errors";
 import { type framer } from "@/framer";
 import { type label } from "@/label";
-import { type ontology } from "@/ontology";
 import { Active } from "@/ranger/active";
 import { Aliaser } from "@/ranger/alias";
 import { KV } from "@/ranger/kv";

package/src/ranger/kv.ts

@@ -58,6 +58,7 @@ export class KV {
     const [res, err] = await this.client.send(
       KV.GET_ENDPOINT,
       { range: this.rangeKey, keys: toArray(keys) },
+      getReqZ,
       getResZ,
     );
     if (err != null) throw err;
@@ -68,7 +69,7 @@ export class KV {
 
   async set(kv: Record<string, string>): Promise<void>;
 
-  async set(key: string | Record<string, string>, value?: string): Promise<void> {
+  async set(key: string | Record<string, string>, value: string = ""): Promise<void> {
     await sendRequired(
       this.client,
       KV.SET_ENDPOINT,
@@ -76,6 +77,7 @@ export class KV {
         range: this.rangeKey,
         pairs: isObject(key) ? key : { [key]: value },
       },
+      setReqZ,
       z.unknown(),
     );
   }
@@ -85,6 +87,7 @@ export class KV {
       this.client,
       KV.DELETE_ENDPOINT,
       { range: this.rangeKey, keys: toArray(key) },
+      deleteReqZ,
       z.unknown(),
     );
   }

package/src/ranger/retriever.ts

@@ -43,7 +43,7 @@ export class Retriever {
   }
 
   private async execute(request: Request): Promise<Payload[]> {
-    const [res, err] = await this.client.send(this.ENDPOINT, request, resZ);
+    const [res, err] = await this.client.send(this.ENDPOINT, request, reqZ, resZ);
     if (err != null) throw err;
     return res.ranges;
   }

package/src/ranger/writer.ts

@@ -55,6 +55,7 @@ export class Writer {
       this.client,
       RENAME_ENDPOINT,
       { key, name },
+      renameReqZ,
       renameResZ,
     );
   }
@@ -64,6 +65,7 @@ export class Writer {
       this.client,
       CREATE_ENDPOINT,
       { ranges },
+      createReqZ,
       createResZ,
     );
     return res.ranges;
@@ -74,6 +76,7 @@ export class Writer {
       this.client,
       DELETE_ENDPOINT,
       { keys },
+      deleteReqZ,
       deleteResZ,
     );
   }

package/src/workspace/client.ts

@@ -14,7 +14,7 @@ import { linePlot } from "@/workspace/lineplot";
 import { type Key, type Workspace } from "@/workspace/payload";
 import { pid } from "@/workspace/pid";
 import { Retriever } from "@/workspace/retriever";
-import { type CrudeWorkspace, Writer } from "@/workspace/writer";
+import { type NewWorkspace, Writer } from "@/workspace/writer";
 
 export class Client implements AsyncTermSearcher<string, Key, Workspace> {
   readonly pid: pid.Client;
@@ -51,10 +51,10 @@ export class Client implements AsyncTermSearcher<string, Key, Workspace> {
     return await this.retriever.page(offset, limit);
   }
 
-  async create(workspace: CrudeWorkspace): Promise<Workspace>;
+  async create(workspace: NewWorkspace): Promise<Workspace>;
 
   async create(
-    workspaces: CrudeWorkspace | CrudeWorkspace[],
+    workspaces: NewWorkspace | NewWorkspace[],
   ): Promise<Workspace | Workspace[]> {
     const isMany = Array.isArray(workspaces);
     const res = await this.writer.create(workspaces);

package/src/workspace/lineplot/client.ts

@@ -12,7 +12,7 @@ import { type UnknownRecord } from "@synnaxlabs/x";
 
 import { type LinePlot, type Key, type Params } from "@/workspace/lineplot/payload";
 import { Retriever } from "@/workspace/lineplot/retriever";
-import { type CrudeLinePlot, Writer } from "@/workspace/lineplot/writer";
+import { type NewLinePlot, Writer } from "@/workspace/lineplot/writer";
 
 export class Client {
   private readonly writer: Writer;
@@ -23,7 +23,7 @@ export class Client {
     this.retriever = new Retriever(client);
   }
 
-  async create(workspace: string, pid: CrudeLinePlot): Promise<LinePlot> {
+  async create(workspace: string, pid: NewLinePlot): Promise<LinePlot> {
     return await this.writer.create(workspace, pid);
   }
 

package/src/workspace/lineplot/payload.ts

@@ -17,13 +17,7 @@ export type Params = Key | Key[];
 export const linePlotZ = z.object({
   key: z.string(),
   name: z.string(),
-  data: unknownRecordZ,
-});
-
-export const linePlotRemoteZ = z.object({
-  key: z.string(),
-  name: z.string(),
-  data: z.string().transform((s) => JSON.parse(s) as UnknownRecord),
+  data: unknownRecordZ.or(z.string().transform((s) => JSON.parse(s) as UnknownRecord)),
 });
 
 export type LinePlot = z.infer<typeof linePlotZ>;

package/src/workspace/lineplot/retriever.ts

@@ -7,14 +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 { type UnaryClient } from "@synnaxlabs/freighter";
+import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
 import { toArray } from "@synnaxlabs/x";
 import { z } from "zod";
 
 import {
   type LinePlot,
   type Params,
-  linePlotRemoteZ,
+  linePlotZ,
 } from "@/workspace/lineplot/payload";
 
 const reqZ = z.object({
@@ -24,7 +24,7 @@ const reqZ = z.object({
 type Request = z.infer<typeof reqZ>;
 
 const resZ = z.object({
-  linePlots: linePlotRemoteZ.array(),
+  linePlots: linePlotZ.array(),
 });
 
 export class Retriever {
@@ -37,13 +37,12 @@ export class Retriever {
 
   async retrieve(params: Params): Promise<LinePlot[]> {
     const normalized = toArray(params);
-    const res = await this.execute({ keys: normalized });
-    return res;
-  }
-
-  private async execute(request: Request): Promise<LinePlot[]> {
-    const [res, err] = await this.client.send(this.ENDPOINT, request, resZ);
-    if (err != null) throw err;
-    return res.linePlots;
+    return (await sendRequired(
+      this.client, 
+      this.ENDPOINT, 
+      { keys: normalized }, 
+      reqZ, 
+      resZ
+    )).linePlots;
   }
 }

package/src/workspace/lineplot/writer.ts

@@ -17,22 +17,23 @@ import {
   type Params,
   keyZ,
   type Key,
-  linePlotRemoteZ,
 } from "@/workspace/lineplot/payload";
 import { keyZ as workspaceKeyZ } from "@/workspace/payload";
 
-export const crudeLinePlotZ = linePlotZ.partial({ key: true });
-export const linePlotWriteZ = linePlotRemoteZ.partial({ key: true });
+export const newLinePlotZ = linePlotZ.partial({ key: true }).transform((p) => ({
+  ...p,
+  data: JSON.stringify(p.data),
+}));
 
-export type CrudeLinePlot = z.infer<typeof crudeLinePlotZ>;
+export type NewLinePlot = z.input<typeof newLinePlotZ>;
 
 const createReqZ = z.object({
   workspace: workspaceKeyZ,
-  linePlots: linePlotWriteZ.array(),
+  linePlots: newLinePlotZ.array(),
 });
 
 const createResZ = z.object({
-  linePlots: linePlotRemoteZ.array(),
+  linePlots: linePlotZ.array(),
 });
 
 const deleteReqZ = z.object({
@@ -67,12 +68,13 @@ export class Writer {
     this.client = client;
   }
 
-  async create(workspace: string, plot: CrudeLinePlot): Promise<LinePlot> {
+  async create(workspace: string, plot: NewLinePlot): Promise<LinePlot> {
     const pid_ = { ...plot, data: JSON.stringify(plot.data) };
     const res = await sendRequired<typeof createReqZ, typeof createResZ>(
       this.client,
       CREATE_ENDPOINT,
       { workspace, linePlots: [pid_] },
+      createReqZ,
       createResZ,
     );
 
@@ -85,6 +87,7 @@ export class Writer {
       this.client,
       DELETE_ENDPOINT,
       { keys: normalized },
+      deleteReqZ,
       deleteResZ,
     );
   }
@@ -94,6 +97,7 @@ export class Writer {
       this.client,
       RENAME_ENDPOINT,
       { key: pid, name },
+      renameReqZ,
       renameResZ,
     );
   }
@@ -103,7 +107,8 @@ export class Writer {
       this.client,
       SET_DATA_ENDPOINT,
       { key: pid, data: JSON.stringify(data) },
-      renameResZ,
+      setDataReqZ,
+      setDataResZ,
     );
   }
 }

package/src/workspace/payload.ts

@@ -19,7 +19,7 @@ export type Params = Key | Key[];
 export const workspaceZ = z.object({
   name: z.string(),
   key: keyZ,
-  layout: unknownRecordZ,
+  layout: unknownRecordZ.or(z.string().transform((s) => JSON.parse(s) as UnknownRecord)),
 });
 
 export const workspaceRemoteZ = workspaceZ.omit({ layout: true }).extend({

package/src/workspace/pid/client.ts

@@ -12,7 +12,7 @@ import { type UnknownRecord } from "@synnaxlabs/x";
 
 import { type Key, type Params, type PID } from "@/workspace/pid/payload";
 import { Retriever } from "@/workspace/pid/retriever";
-import { Writer, type UncreatedPID } from "@/workspace/pid/writer";
+import { Writer, type NewPID } from "@/workspace/pid/writer";
 
 export class Client {
   private readonly writer: Writer;
@@ -23,7 +23,7 @@ export class Client {
     this.retriever = new Retriever(client);
   }
 
-  async create(workspace: string, pid: UncreatedPID): Promise<PID> {
+  async create(workspace: string, pid: NewPID): Promise<PID> {
     return await this.writer.create(workspace, pid);
   }
 

package/src/workspace/pid/payload.ts

@@ -17,7 +17,7 @@ export type Params = Key | Key[];
 export const pidZ = z.object({
   key: z.string(),
   name: z.string(),
-  data: unknownRecordZ,
+  data: unknownRecordZ.or(z.string().transform((s) => JSON.parse(s) as UnknownRecord)),
   snapshot: z.boolean(),
 });
 

package/src/workspace/pid/retriever.ts

@@ -7,7 +7,7 @@
 // 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 { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
 import { toArray } from "@synnaxlabs/x";
 import { z } from "zod";
 
@@ -32,14 +32,12 @@ export class Retriever {
   }
 
   async retrieve(params: Params): Promise<PID[]> {
-    const normalized = toArray(params);
-    const res = await this.execute({ keys: normalized });
-    return res;
-  }
-
-  private async execute(request: Request): Promise<PID[]> {
-    const [res, err] = await this.client.send(this.ENDPOINT, request, resZ);
-    if (err != null) throw err;
-    return res.pids;
+    return (await sendRequired(
+      this.client, 
+      this.ENDPOINT, 
+      { keys: toArray(params) }, 
+      reqZ, 
+      resZ,
+    )).pids;
   }
 }

package/src/workspace/pid/writer.ts

@@ -21,14 +21,16 @@ import {
   pidRemoteZ,
 } from "@/workspace/pid/payload";
 
-export const crudePIDz = pidZ.partial({ key: true });
-export const pidWriteZ = pidRemoteZ.partial({ key: true, snapshot: true });
+export const newPIDZ = pidZ.partial({ key: true, snapshot: true }).transform((p) => ({
+  ...p,
+  data: JSON.stringify(p.data),
+}));
 
-export type UncreatedPID = z.infer<typeof pidWriteZ>;
+export type NewPID = z.input<typeof newPIDZ>;
 
 const createReqZ = z.object({
   workspace: workspaceKeyZ,
-  pids: pidWriteZ.array(),
+  pids: newPIDZ.array(),
 });
 
 const createResZ = z.object({
@@ -78,12 +80,13 @@ export class Writer {
     this.client = client;
   }
 
-  async create(workspace: string, pid: UncreatedPID): Promise<PID> {
+  async create(workspace: string, pid: NewPID): Promise<PID> {
     const pid_ = { ...pid, data: JSON.stringify(pid.data) };
     const res = await sendRequired<typeof createReqZ, typeof createResZ>(
       this.client,
       CREATE_ENDPOINT,
       { workspace, pids: [pid_] },
+      createReqZ,
       createResZ,
     );
 
@@ -95,6 +98,7 @@ export class Writer {
       this.client,
       COPY_ENDPOINT,
       { key, name, snapshot },
+      copyReqZ,
       copyResZ,
     );
     return res.pid;
@@ -106,6 +110,7 @@ export class Writer {
       this.client,
       DELETE_ENDPOINT,
       { keys: normalized },
+      deleteReqZ,
       deleteResZ,
     );
   }
@@ -115,6 +120,7 @@ export class Writer {
       this.client,
       RENAME_ENDPOINT,
       { key: pid, name },
+      renameReqZ,
       renameResZ,
     );
   }
@@ -124,6 +130,7 @@ export class Writer {
       this.client,
       SET_DATA_ENDPOINT,
       { key: pid, data: JSON.stringify(data) },
+      setDataReqZ,
       renameResZ,
     );
   }

package/src/workspace/retriever.ts

@@ -7,7 +7,7 @@
 // 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 { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
 import { toArray } from "@synnaxlabs/x";
 import { z } from "zod";
 
@@ -59,8 +59,6 @@ export class Retriever {
   }
 
   private async execute(request: Request): Promise<Workspace[]> {
-    const [res, err] = await this.client.send(Retriever.ENDPOINT, request, resZ);
-    if (err != null) throw err;
-    return res.workspaces;
+    return (await sendRequired(this.client, Retriever.ENDPOINT, request, reqZ, resZ)).workspaces;
   }
 }

package/src/workspace/workspace.spec.ts

@@ -18,13 +18,13 @@ const ZERO_UUID = "00000000-0000-0000-0000-000000000000";
 describe("Workspace", () => {
   describe("create", () => {
     test("create one", async () => {
-      const pid = await client.workspaces.create({
+      const ws = await client.workspaces.create({
         name: "PID",
         layout: { one: 1 },
       });
-      expect(pid.name).toEqual("PID");
-      expect(pid.key).not.toEqual(ZERO_UUID);
-      expect(pid.layout.one).toEqual(1);
+      expect(ws.name).toEqual("PID");
+      expect(ws.key).not.toEqual(ZERO_UUID);
+      expect(ws.layout.one).toEqual(1);
     });
   });
   describe("rename", () => {

package/src/workspace/writer.ts

@@ -13,13 +13,15 @@ import { z } from "zod";
 
 import { type Workspace, workspaceZ, keyZ, workspaceRemoteZ } from "./payload";
 
-const crudeWorkspaceZ = workspaceZ.partial({ key: true });
-const workspaceWriteZ = workspaceRemoteZ.partial({ key: true });
+const newWorkspaceZ = workspaceZ.partial({ key: true }).transform((w) => ({
+  ...w,
+  layout: JSON.stringify(w.layout),
+}));
 
-export type CrudeWorkspace = z.infer<typeof crudeWorkspaceZ>;
+export type NewWorkspace = z.input<typeof newWorkspaceZ>;
 
 const createReqZ = z.object({
-  workspaces: workspaceWriteZ.partial({ key: true }).array(),
+  workspaces: newWorkspaceZ.array(),
 });
 
 const createResZ = z.object({
@@ -60,15 +62,12 @@ export class Writer {
     this.client = client;
   }
 
-  async create(workspaces: CrudeWorkspace | CrudeWorkspace[]): Promise<Workspace[]> {
-    const ws = toArray(workspaces).map((w) => ({
-      ...w,
-      layout: JSON.stringify(w.layout),
-    }));
+  async create(workspaces: NewWorkspace | NewWorkspace[]): Promise<Workspace[]> {
     const res = await sendRequired<typeof createReqZ, typeof createResZ>(
       this.client,
       CREATE_ENDPOINT,
-      { workspaces: ws },
+      { workspaces: toArray(workspaces) },
+      createReqZ,
       createResZ,
     );
     return res.workspaces;
@@ -79,6 +78,7 @@ export class Writer {
       this.client,
       DELETE_ENDPOINT,
       { keys: toArray(keys) },
+      deleteReqZ,
       deleteResZ,
     );
   }
@@ -88,6 +88,7 @@ export class Writer {
       this.client,
       RENAME_ENDPOINT,
       { key, name },
+      renameReqZ,
       renameResZ,
     );
   }
@@ -97,6 +98,7 @@ export class Writer {
       this.client,
       SET_LAYOUT_ENDPOINT,
       { key, layout: JSON.stringify(layout) },
+      setLayoutReqZ,
       setLayoutResZ,
     );
   }

package/.pytest_cache/README.md

@@ -1,8 +0,0 @@
-# pytest cache directory #
-
-This directory contains data from the pytest's cache plugin,
-which provides the `--lf` and `--ff` options, as well as the `cache` fixture.
-
-**Do not** commit this to version control.
-
-See [the docs](https://docs.pytest.org/en/stable/how-to/cache.html) for more information.

package/examples/index.js

@@ -1 +0,0 @@
-import {Synnax} from "@synnaxlabs/client";