@synnaxlabs/client 0.18.3 → 0.19.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@synnaxlabs/client",
   "private": false,
-  "version": "0.18.3",
+  "version": "0.19.0",
   "type": "module",
   "description": "The Client Library for Synnax",
   "repository": "https://github.com/synnaxlabs/synnax/tree/main/client/ts",
@@ -18,8 +18,8 @@
   "dependencies": {
     "async-mutex": "^0.4.0",
     "zod": "3.22.4",
-    "@synnaxlabs/freighter": "0.9.4",
-    "@synnaxlabs/x": "0.15.3"
+    "@synnaxlabs/x": "0.15.4",
+    "@synnaxlabs/freighter": "0.9.4"
   },
   "devDependencies": {
     "@types/node": "^20.10.5",
@@ -28,9 +28,9 @@
     "typescript": "^5.3.3",
     "vite": "^5.1.2",
     "vitest": "^1.2.2",
-    "@synnaxlabs/tsconfig": "0.0.2",
     "eslint-config-synnaxlabs": "0.0.1",
-    "@synnaxlabs/vite-plugin": "0.0.1"
+    "@synnaxlabs/vite-plugin": "0.0.1",
+    "@synnaxlabs/tsconfig": "0.0.2"
   },
   "main": "dist/client.cjs",
   "module": "dist/client.js",

package/src/channel/channel.spec.ts

@@ -193,4 +193,31 @@ describe("Channel", () => {
     expect(retrieved.length).toBeGreaterThan(0);
     retrieved.forEach((ch) => expect(ch.name).toEqual("test"));
   });
+
+  describe("delete", async () => {
+    test("delete by key", async () => {
+      const channel = await client.channels.create({
+        name: "test",
+        leaseholder: 1,
+        rate: Rate.hz(1),
+        dataType: DataType.FLOAT32,
+      });
+      await client.channels.delete(channel.key);
+      await expect(
+        async () => await client.channels.retrieve(channel.key),
+      ).rejects.toThrow(QueryError);
+    });
+    test("delete by name", async () => {
+      const channel = await client.channels.create({
+        name: "test",
+        leaseholder: 1,
+        rate: Rate.hz(1),
+        dataType: DataType.FLOAT32,
+      });
+      await client.channels.delete(["test"]);
+      await expect(
+        async () => await client.channels.retrieve(channel.key),
+      ).rejects.toThrow(QueryError);
+    });
+  });
 });

package/src/channel/client.ts

@@ -20,7 +20,6 @@ import {
   type CrudeTimeStamp,
 } from "@synnaxlabs/x";
 
-import { type Creator } from "@/channel/creator";
 import {
   type Key,
   type KeyOrName,
@@ -36,6 +35,7 @@ import {
   DebouncedBatchRetriever,
   type Retriever,
 } from "@/channel/retriever";
+import { type Writer } from "@/channel/writer";
 import { MultipleResultsError, NoResultsError, ValidationError } from "@/errors";
 import { type framer } from "@/framer";
 
@@ -170,20 +170,20 @@ export class Channel {
  */
 export class Client implements AsyncTermSearcher<string, Key, Channel> {
   private readonly frameClient: framer.Client;
-  readonly retriever: Retriever;
-  private readonly creator: Creator;
   private readonly client: UnaryClient;
+  readonly retriever: Retriever;
+  readonly writer: Writer;
 
   constructor(
     frameClient: framer.Client,
     retriever: Retriever,
     client: UnaryClient,
-    creator: Creator,
+    writer: Writer,
   ) {
     this.frameClient = frameClient;
     this.retriever = retriever;
     this.client = client;
-    this.creator = creator;
+    this.writer = writer;
   }
 
   /**
@@ -261,7 +261,7 @@ export class Client implements AsyncTermSearcher<string, Key, Channel> {
       toCreate = toCreate.filter((c) => !existingNames.has(c.name));
       created = this.sugar(res);
     }
-    created = created.concat(this.sugar(await this.creator.create(toCreate)));
+    created = created.concat(this.sugar(await this.writer.create(toCreate)));
     return single ? created[0] : created;
   }
 
@@ -322,6 +322,12 @@ export class Client implements AsyncTermSearcher<string, Key, Channel> {
     return res[0];
   }
 
+  async delete(channels: Params): Promise<void> {
+    const { normalized, variant } = analyzeParams(channels);
+    if (variant === "keys") return await this.writer.delete({ keys: normalized });
+    return await this.writer.delete({ names: normalized });
+  }
+
   async search(term: string, rangeKey?: string): Promise<Channel[]> {
     return this.sugar(await this.retriever.search(term, rangeKey));
   }

package/src/channel/external.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.
 
-export * from "@/channel/creator";
+export * from "@/channel/writer";
 export * from "@/channel/client";
 export * from "@/channel/payload";
 export * from "@/channel/retriever";

package/src/channel/payload.ts

@@ -36,18 +36,8 @@ export const newPayload = payload.extend({
   key: z.number().optional(),
   leaseholder: z.number().optional(),
   index: z.number().optional(),
-  rate: Rate.z.optional(),
+  rate: Rate.z.optional().default(0),
   isIndex: z.boolean().optional(),
 });
 
 export type NewPayload = z.input<typeof newPayload>;
-
-export const parseChannels = (channels: NewPayload[]): NewPayload[] =>
-  channels.map((channel) => ({
-    name: channel.name,
-    dataType: channel.dataType,
-    rate: channel.rate ?? 0,
-    leaseholder: channel.leaseholder,
-    index: channel.index,
-    isIndex: channel.isIndex,
-  }));

package/src/channel/retriever.ts

@@ -22,7 +22,7 @@ import {
   type Payload,
   payload,
 } from "@/channel/payload";
-import { QueryError, ValidationError } from "@/errors";
+import { QueryError } from "@/errors";
 
 const reqZ = z.object({
   leaseholder: z.number().optional(),

package/src/channel/writer.ts

@@ -0,0 +1,63 @@
+// Copyright 2023 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 { z } from "zod";
+
+import {
+  type Payload,
+  payload,
+  newPayload,
+  type NewPayload,
+  keyZ,
+} from "@/channel/payload";
+
+const createReqZ = z.object({ channels: newPayload.array() });
+const createResZ = z.object({ channels: payload.array() });
+
+const deleteReqZ = z.object({
+  keys: keyZ.array().optional(),
+  names: z.string().array().optional(),
+});
+const deleteResZ = z.object({});
+
+const CREATE_ENDPOINT = "/channel/create";
+const DELETE_ENDPOINT = "/channel/delete";
+
+export type DeleteProps = z.input<typeof deleteReqZ>;
+
+export class Writer {
+  private readonly client: UnaryClient;
+
+  constructor(client: UnaryClient) {
+    this.client = client;
+  }
+
+  async create(channels: NewPayload[]): Promise<Payload[]> {
+    return (
+      await sendRequired<typeof createReqZ, typeof createResZ>(
+        this.client,
+        CREATE_ENDPOINT,
+        { channels },
+        createReqZ,
+        createResZ,
+      )
+    ).channels;
+  }
+
+  async delete(props: DeleteProps): Promise<void> {
+    await sendRequired<typeof deleteReqZ, typeof deleteResZ>(
+      this.client,
+      DELETE_ENDPOINT,
+      props,
+      deleteReqZ,
+      deleteResZ,
+    );
+  }
+}

package/src/client.ts

@@ -94,7 +94,7 @@ export default class Synnax {
     const chRetriever = new channel.CacheRetriever(
       new channel.ClusterRetriever(this.transport.unary),
     );
-    const chCreator = new channel.Creator(this.transport.unary);
+    const chCreator = new channel.Writer(this.transport.unary);
     this.telem = new framer.Client(this.transport.stream, chRetriever);
     this.channels = new channel.Client(
       this.telem,

package/dist/channel/creator.d.ts

@@ -1,8 +0,0 @@
-import type { UnaryClient } from "@synnaxlabs/freighter";
-import { type Payload, type NewPayload } from './payload';
-export declare class Creator {
-    private static readonly ENDPOINT;
-    private readonly client;
-    constructor(client: UnaryClient);
-    create(channels: NewPayload[]): Promise<Payload[]>;
-}

package/src/channel/creator.ts

@@ -1,44 +0,0 @@
-// Copyright 2023 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 Payload,
-  payload,
-  parseChannels,
-  newPayload,
-  type NewPayload,
-} 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 req = { channels: parseChannels(channels) };
-    const [res, err] = await this.client.send<typeof reqZ, typeof resZ>(
-      Creator.ENDPOINT,
-      req,
-      reqZ,
-      resZ,
-    );
-    if (err != null) throw err;
-    return res.channels;
-  }
-}