@synnaxlabs/client 0.30.0 → 0.31.0

package/src/user/writer.ts

@@ -0,0 +1,91 @@
+// 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 Key,
+  keyZ,
+  type NewUser,
+  newUserZ,
+  type User,
+  userZ,
+} from "@/user/payload";
+
+const createReqZ = z.object({ users: newUserZ.array() });
+const createResZ = z.object({ users: userZ.array() });
+
+const changeUsernameReqZ = z.object({ key: keyZ, username: z.string().min(1) });
+const changeUsernameResZ = z.object({});
+
+const renameReqZ = z.object({
+  key: keyZ,
+  firstName: z.string().optional(),
+  lastName: z.string().optional(),
+});
+const renameResZ = z.object({});
+
+const deleteReqZ = z.object({ keys: keyZ.array() });
+const deleteResZ = z.object({});
+
+const CREATE_ENDPOINT = "/user/create";
+const CHANGE_USERNAME_ENDPOINT = "/user/change-username";
+const RENAME_ENDPOINT = "/user/rename";
+const DELETE_ENDPOINT = "/user/delete";
+
+export class Writer {
+  private readonly client: UnaryClient;
+
+  constructor(client: UnaryClient) {
+    this.client = client;
+  }
+
+  async create(users: NewUser | NewUser[]): Promise<User[]> {
+    const res = await sendRequired<typeof createReqZ, typeof createResZ>(
+      this.client,
+      CREATE_ENDPOINT,
+      { users: toArray(users) },
+      createReqZ,
+      createResZ,
+    );
+    return res.users;
+  }
+
+  async changeUsername(key: Key, newUsername: string): Promise<void> {
+    await sendRequired<typeof changeUsernameReqZ, typeof changeUsernameResZ>(
+      this.client,
+      CHANGE_USERNAME_ENDPOINT,
+      { key, username: newUsername },
+      changeUsernameReqZ,
+      changeUsernameResZ,
+    );
+  }
+
+  async rename(key: Key, firstName?: string, lastName?: string): Promise<void> {
+    await sendRequired<typeof renameReqZ, typeof renameResZ>(
+      this.client,
+      RENAME_ENDPOINT,
+      { key, firstName, lastName },
+      renameReqZ,
+      renameResZ,
+    );
+  }
+
+  async delete(keys: Key | Key[]): Promise<void> {
+    await sendRequired<typeof deleteReqZ, typeof deleteResZ>(
+      this.client,
+      DELETE_ENDPOINT,
+      { keys: toArray(keys) },
+      deleteReqZ,
+      deleteResZ,
+    );
+  }
+}

package/src/workspace/lineplot/payload.ts

@@ -24,7 +24,7 @@ export const linePlotZ = z.object({
 
 export type LinePlot = z.infer<typeof linePlotZ>;
 
-export const LineplotOntologyType = "lineplot" as ontology.ResourceType;
+export const ONTOLOGY_TYPE: ontology.ResourceType = "lineplot";
 
 export const ontologyID = (key: Key): ontology.ID =>
-  new ontology.ID({ type: LineplotOntologyType, key: key });
+  new ontology.ID({ type: ONTOLOGY_TYPE, key: key });

package/src/workspace/payload.ts

@@ -38,7 +38,7 @@ export const workspaceRemoteZ = workspaceZ.omit({ layout: true }).extend({
 
 export type Workspace = z.infer<typeof workspaceZ>;
 
-export const WorkspaceOntologyType = "workspace" as ontology.ResourceType;
+export const ONTOLOGY_TYPE: ontology.ResourceType = "workspace";
 
 export const ontologyID = (key: Key): ontology.ID =>
-  new ontology.ID({ type: WorkspaceOntologyType, key: key });
+  new ontology.ID({ type: ONTOLOGY_TYPE, key: key });

package/src/workspace/schematic/client.ts

@@ -12,7 +12,7 @@ import { type UnknownRecord } from "@synnaxlabs/x/record";
 
 import { type Key, type Params, type Schematic } from "@/workspace/schematic/payload";
 import { Retriever } from "@/workspace/schematic/retriever";
-import { type NewSchematic,Writer } from "@/workspace/schematic/writer";
+import { type NewSchematic, Writer } from "@/workspace/schematic/writer";
 
 export class Client {
   private readonly writer: Writer;

package/src/workspace/schematic/payload.ts

@@ -32,7 +32,7 @@ export const schematicRemoteZ = z.object({
 
 export type Schematic = z.infer<typeof schematicZ>;
 
-export const SchematicOntologyType = "schematic" as ontology.ResourceType;
+export const ONTOLOGY_TYPE: ontology.ResourceType = "schematic";
 
 export const ontologyID = (key: Key): ontology.ID =>
-  new ontology.ID({ type: SchematicOntologyType, key: key });
+  new ontology.ID({ type: ONTOLOGY_TYPE, key: key });

package/src/workspace/workspace.spec.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 { describe, expect,test } from "vitest";
+import { describe, expect, test } from "vitest";
 
 import { newClient } from "@/setupspecs";
 

package/dist/access/access.spec.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=access.spec.d.ts.map

package/dist/access/access.spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"access.spec.d.ts","sourceRoot":"","sources":["../../src/access/access.spec.ts"],"names":[],"mappings":""}

package/src/access/access.spec.ts

@@ -1,276 +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 { DataType, id, Rate } from "@synnaxlabs/x";
-import { describe, expect, test } from "vitest";
-
-import { Policy } from "@/access/payload";
-import { Channel } from "@/channel/client";
-import { ChannelOntologyType } from "@/channel/payload";
-import Synnax from "@/client";
-import { AuthError } from "@/errors";
-import { LabelOntologyType } from "@/label/payload";
-import { HOST, newClient, PORT } from "@/setupspecs";
-import { UserOntologyType } from "@/user/payload";
-
-const client = newClient();
-
-describe("Policy", () => {
-  describe("create", () => {
-    test.skip("create one", async () => {
-      const policy = await client.access.create({
-        subjects: [{ type: UserOntologyType, key: "1" }],
-        objects: [
-          { type: UserOntologyType, key: "2" },
-          { type: ChannelOntologyType, key: "3" },
-        ],
-        actions: ["update"],
-      });
-      expect(policy.key).not.toEqual("");
-      expect(policy.subjects).toEqual([{ type: UserOntologyType, key: "1" }]);
-      expect(policy.objects).toEqual([
-        { type: UserOntologyType, key: "2" },
-        { type: ChannelOntologyType, key: "3" },
-      ]);
-      expect(policy.actions).toEqual(["update"]);
-    });
-    test.skip("create many", async () => {
-      const policies = await client.access.create([
-        {
-          subjects: [{ type: UserOntologyType, key: "10" }],
-          objects: [
-            { type: UserOntologyType, key: "20" },
-            { type: UserOntologyType, key: "21" },
-          ],
-          actions: ["update"],
-        },
-        {
-          subjects: [
-            { type: UserOntologyType, key: "20" },
-            { type: UserOntologyType, key: "21" },
-          ],
-          objects: [
-            { type: UserOntologyType, key: "20" },
-            { type: ChannelOntologyType, key: "30" },
-          ],
-          actions: ["update"],
-        },
-      ]);
-      expect(policies.length).toEqual(3);
-      expect(policies[0].subjects[0].key).toEqual("10");
-      expect(policies[1].subjects[1].key).toEqual("21");
-    });
-    test.skip("create instances of policies", async () => {
-      const policy = {
-        key: undefined,
-        subjects: [
-          { type: UserOntologyType, key: "20" },
-          { type: UserOntologyType, key: "21" },
-        ],
-        objects: [
-          { type: UserOntologyType, key: "20" },
-          { type: ChannelOntologyType, key: "30" },
-        ],
-        actions: ["update"],
-      };
-
-      const p = await client.access.create(policy);
-      expect(p.subjects).toEqual(policy.subjects);
-      expect(p.key).not.toEqual(policy.key);
-    });
-  });
-  test.skip("retrieve by subject", async () => {
-    const key1 = id.id();
-    const policies = [
-      {
-        key: undefined,
-        subjects: [
-          { type: UserOntologyType, key: key1 },
-          { type: UserOntologyType, key: "21" },
-        ],
-        objects: [
-          { type: UserOntologyType, key: "234" },
-          { type: ChannelOntologyType, key: "30" },
-        ],
-        actions: ["update"],
-      },
-      {
-        key: undefined,
-        subjects: [
-          { type: UserOntologyType, key: key1 },
-          { type: UserOntologyType, key: "22" },
-        ],
-        objects: [
-          { type: LabelOntologyType, key: "23123" },
-          { type: ChannelOntologyType, key: "30" },
-        ],
-        actions: ["delete"],
-      },
-    ];
-
-    await client.access.create(policies);
-
-    const p = (await client.access.retrieve(policies[0].subjects[0])) as Policy[];
-    expect(p).toHaveLength(2);
-    expect([p[0].actions, p[1].actions].sort()).toEqual([["delete"], ["update"]]);
-  });
-  test.skip("retrieve by subject - not found", async () => {
-    const res = await client.access.retrieve({ type: UserOntologyType, key: "999" });
-    expect(res).toHaveLength(0);
-  });
-
-  describe("delete", async () => {
-    test.skip("delete one", async () => {
-      const id1 = id.id();
-      const id2 = id.id();
-      const id3 = id.id();
-      const policies = [
-        {
-          key: undefined,
-          subjects: [
-            { type: UserOntologyType, key: id1 },
-            { type: UserOntologyType, key: id2 },
-          ],
-          objects: [
-            { type: UserOntologyType, key: "20" },
-            { type: ChannelOntologyType, key: "30" },
-          ],
-          actions: ["update"],
-        },
-        {
-          key: undefined,
-          subjects: [
-            { type: UserOntologyType, key: id1 },
-            { type: UserOntologyType, key: id3 },
-          ],
-          objects: [
-            { type: LabelOntologyType, key: "20" },
-            { type: ChannelOntologyType, key: "30" },
-          ],
-          actions: ["delete"],
-        },
-      ];
-
-      const created = await client.access.create(policies);
-      await client.access.delete(created[0].key);
-      const res = await client.access.retrieve(created[0].subjects[0]);
-      expect(res).toHaveLength(1);
-      expect(res[0].actions).toEqual(["delete"]);
-    });
-    test.skip("delete many", async () => {
-      const id1 = id.id();
-      const id2 = id.id();
-      const id3 = id.id();
-      const policies = [
-        {
-          subjects: [
-            { type: UserOntologyType, key: id1 },
-            { type: UserOntologyType, key: id2 },
-          ],
-          objects: [
-            { type: UserOntologyType, key: "20" },
-            { type: ChannelOntologyType, key: "30" },
-          ],
-          actions: ["update"],
-        },
-        {
-          subjects: [
-            { type: UserOntologyType, key: id1 },
-            { type: UserOntologyType, key: id3 },
-          ],
-          objects: [
-            { type: LabelOntologyType, key: "20" },
-            { type: ChannelOntologyType, key: "30" },
-          ],
-          actions: ["delete"],
-        },
-      ];
-
-      const created = await client.access.create(policies);
-      await client.access.delete([created[0].key, created[1].key]);
-      let res = await client.access.retrieve({ type: UserOntologyType, key: id1 });
-      expect(res).toHaveLength(0);
-      res = await client.access.retrieve({ type: UserOntologyType, key: id2 });
-      expect(res).toHaveLength(0);
-      res = await client.access.retrieve({ type: UserOntologyType, key: id3 });
-      expect(res).toHaveLength(0);
-    });
-  });
-  describe("registration", async () => {
-    test.skip("register a user", async () => {
-      const username = id.id();
-      await client.user.register(username, "pwd1");
-      new Synnax({
-        host: HOST,
-        port: PORT,
-        username: username,
-        password: "pwd1",
-      });
-    });
-    test.skip("duplicate username", async () => {
-      const username = id.id();
-      await client.user.register(username, "pwd1");
-      await expect(client.user.register(username, "pwd1")).rejects.toThrow(AuthError);
-    });
-  });
-  describe("privilege", async () => {
-    test.skip("new user", async () => {
-      const username = id.id();
-      const user2 = await client.user.register(username, "pwd1");
-      expect(user2).toBeDefined();
-      const client2 = new Synnax({
-        host: HOST,
-        port: PORT,
-        username: username,
-        password: "pwd1",
-      });
-
-      await expect(
-        client2.user.register(id.id(), "pwd3")
-      ).rejects.toThrow(AuthError);
-
-      await expect(
-        client2.channels.create(
-          new Channel({
-            dataType: DataType.FLOAT64,
-            rate: Rate.hz(1),
-            name: "my_channel",
-          }),
-        ),
-      ).rejects.toThrow(AuthError);
-
-      const p = await client.access.create({
-        subjects: [{ type: UserOntologyType, key: user2.key }],
-        objects: [{ type: ChannelOntologyType, key: "" }],
-        actions: ["create"],
-      });
-
-      await client2.channels.create(
-        new Channel({
-          dataType: DataType.FLOAT64,
-          rate: Rate.hz(1),
-          name: "my_channel",
-        }),
-      );
-
-      // Remove privileges
-      await client.access.delete(p.key);
-
-      await expect(
-        client2.channels.create(
-          new Channel({
-            dataType: DataType.FLOAT64,
-            rate: Rate.hz(1),
-            name: "my_channel",
-          }),
-        ),
-      ).rejects.toThrow(AuthError);
-    });
-  });
-});