@synnaxlabs/client 0.2.0 → 0.13.5

package/src/workspace/retriever.ts

@@ -0,0 +1,67 @@
+// 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 { toArray } from "@synnaxlabs/x";
+import { z } from "zod";
+
+import {
+  type Params,
+  type Workspace,
+  keyZ,
+  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: workspaceRemoteZ.array(),
+});
+
+export class Retriever {
+  private static readonly ENDPOINT = "/workspace/retrieve";
+
+  private readonly client: UnaryClient;
+
+  constructor(client: UnaryClient) {
+    this.client = client;
+  }
+
+  async retrieve(params: Params): Promise<Workspace[]> {
+    const normalized = toArray(params);
+    const res = await this.execute({ keys: normalized });
+    return res;
+  }
+
+  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, err] = await this.client.send(Retriever.ENDPOINT, request, resZ);
+    if (err != null) throw err;
+    return res.workspaces;
+  }
+}

package/src/workspace/workspace.spec.ts

@@ -0,0 +1,62 @@
+// 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 { describe, test, expect } 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 () => {
+      const pid = 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);
+    });
+  });
+  describe("rename", () => {
+    test("rename one", async () => {
+      const ws = await client.workspaces.create({
+        name: "PID",
+        layout: { one: 1 },
+      });
+      await client.workspaces.rename(ws.key, "PID2");
+      const res = await client.workspaces.retrieve(ws.key);
+      expect(res.name).toEqual("PID2");
+    });
+  });
+  describe("setLayout", () => {
+    test("set layout", async () => {
+      const ws = await client.workspaces.create({
+        name: "PID",
+        layout: { one: 1 },
+      });
+      await client.workspaces.setLayout(ws.key, { two: 2 });
+      const res = await client.workspaces.retrieve(ws.key);
+      expect(res.layout.two).toEqual(2);
+    });
+  });
+  describe("delete", () => {
+    test("delete one", async () => {
+      const ws = await client.workspaces.create({
+        name: "PID",
+        layout: { one: 1 },
+      });
+      await client.workspaces.delete(ws.key);
+      await expect(client.workspaces.retrieve(ws.key)).rejects.toThrow();
+    });
+  });
+});

package/src/workspace/writer.ts

@@ -0,0 +1,103 @@
+// 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 { toArray, type UnknownRecord } from "@synnaxlabs/x";
+import { z } from "zod";
+
+import { type Workspace, workspaceZ, keyZ, workspaceRemoteZ } from "./payload";
+
+const crudeWorkspaceZ = workspaceZ.partial({ key: true });
+const workspaceWriteZ = workspaceRemoteZ.partial({ key: true });
+
+export type CrudeWorkspace = z.infer<typeof crudeWorkspaceZ>;
+
+const createReqZ = z.object({
+  workspaces: workspaceWriteZ.partial({ key: true }).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 Response = 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: CrudeWorkspace | CrudeWorkspace[]): Promise<Workspace[]> {
+    const ws = toArray(workspaces).map((w) => ({
+      ...w,
+      layout: JSON.stringify(w.layout),
+    }));
+    const res = await sendRequired<typeof createReqZ, typeof createResZ>(
+      this.client,
+      CREATE_ENDPOINT,
+      { workspaces: ws },
+      createResZ,
+    );
+    return res.workspaces;
+  }
+
+  async delete(keys: string | string[]): Promise<void> {
+    await sendRequired<typeof deleteReqZ, typeof deleteResZ>(
+      this.client,
+      DELETE_ENDPOINT,
+      { keys: toArray(keys) },
+      deleteResZ,
+    );
+  }
+
+  async rename(key: string, name: string): Promise<void> {
+    await sendRequired<typeof renameReqZ, typeof renameResZ>(
+      this.client,
+      RENAME_ENDPOINT,
+      { key, name },
+      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) },
+      setLayoutResZ,
+    );
+  }
+}

package/tsconfig.json

@@ -1,47 +1,7 @@
 {
+  "extends": "@synnaxlabs/tsconfig/base.json",
   "compilerOptions": {
-    "incremental": true,
-    "target": "es2017",
-    "outDir": "build/main",
-    "rootDir": "src",
-    "moduleResolution": "node",
-    "module": "commonjs",
-    "declaration": true,
-    "inlineSourceMap": true,
-    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
-    "resolveJsonModule": true /* Include modules imported with .json extension. */,
-
-    "strict": true /* Enable all strict type-checking options. */,
-
-    /* Strict Type-Checking Options */
-    // "noImplicitAny": true /* Raise error on expressions and declarations with an implied 'any' type. */,
-    // "strictNullChecks": true /* Enable strict null checks. */,
-    // "strictFunctionTypes": true /* Enable strict checking of function types. */,
-    // "strictPropertyInitialization": true /* Enable strict checking of property initialization in classes. */,
-    // "noImplicitThis": true /* Raise error on 'this' expressions with an implied 'any' type. */,
-    // "alwaysStrict": true /* Parse in strict mode and emit "use strict" for each source file. */,
-
-    /* Additional Checks */
-    "noUnusedLocals": true /* Report errors on unused locals. */,
-    "noUnusedParameters": true /* Report errors on unused parameters. */,
-    "noImplicitReturns": true /* Report error when not all code paths in function return a value. */,
-    "noFallthroughCasesInSwitch": true /* Report errors for fallthrough cases in switch statement. */,
-
-    /* Debugging Options */
-    "traceResolution": false /* Report module resolution log messages. */,
-    "listEmittedFiles": false /* Print names of generated files part of the compilation. */,
-    "listFiles": false /* Print names of files part of the compilation. */,
-    "pretty": true /* Stylize errors and messages using color and context. */,
-
-    /* Experimental Options */
-    // "experimentalDecorators": true /* Enables experimental support for ES7 decorators. */,
-    // "emitDecoratorMetadata": true /* Enables experimental support for emitting type metadata for decorators. */,
-
-    "lib": ["es2017", "dom"],
-    "types": ["node"],
-    "typeRoots": ["node_modules/@types", "src/types"]
+    "baseUrl": ".",
   },
-  "include": ["src/**/*.ts"],
-  "exclude": ["node_modules/**"],
-  "compileOnSave": false
+  "include": ["src/**/*"]
 }

package/tsconfig.vite.json

@@ -0,0 +1,4 @@
+{
+  "extends": "@synnaxlabs/tsconfig/vite.json",
+  "include": ["vite.config.ts"]
+}

package/vite.config.ts

@@ -0,0 +1,25 @@
+// 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 { lib } from "@synnaxlabs/vite-plugin";
+import { defineConfig } from "vite";
+
+export default defineConfig({
+  plugins: [lib({ name: "client" })],
+  build: {
+    minify: false,
+    rollupOptions: {
+      external: "zod",
+    },
+  },
+  test: {
+    globals: true,
+    environment: "jsdom",
+  },
+});

package/.editorconfig

@@ -1,15 +0,0 @@
-# http://editorconfig.org
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-indent_size = 2
-indent_style = space
-insert_final_newline = true
-max_line_length = 80
-trim_trailing_whitespace = true
-
-[*.md]
-max_line_length = 0
-trim_trailing_whitespace = false

package/.eslintrc.json

@@ -1,33 +0,0 @@
-{
-  "root": true,
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": { "project": "./tsconfig.json" },
-  "env": { "es6": true },
-  "ignorePatterns": ["node_modules", "build", "coverage"],
-  "plugins": ["import", "eslint-comments"],
-  "extends": [
-    "eslint:recommended",
-    "plugin:eslint-comments/recommended",
-    "plugin:@typescript-eslint/recommended",
-    "plugin:import/typescript",
-    "prettier",
-    "prettier/@typescript-eslint"
-  ],
-  "globals": { "BigInt": true, "console": true, "WebAssembly": true },
-  "rules": {
-    "@typescript-eslint/explicit-module-boundary-types": "off",
-    "eslint-comments/disable-enable-pair": [
-      "error",
-      { "allowWholeFile": true }
-    ],
-    "eslint-comments/no-unused-disable": "error",
-    "import/order": [
-      "error",
-      { "newlines-between": "always", "alphabetize": { "order": "asc" } }
-    ],
-    "sort-imports": [
-      "error",
-      { "ignoreDeclarationSort": true, "ignoreCase": true }
-    ]
-  }
-}

package/.gitignore

@@ -1,9 +0,0 @@
-.idea/*
-.nyc_output
-build
-node_modules
-test
-src/**.js
-coverage
-*.log
-package-lock.json