@synnaxlabs/client 0.2.1 → 0.13.5

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

@@ -0,0 +1,7 @@
+{
+  "extends": "@synnaxlabs/tsconfig/base.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+  },
+  "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/CHANGELOG.md

@@ -1,5 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
-
-### 0.2.1 (2022-10-04)

package/build/main/index.d.ts

@@ -1,4 +0,0 @@
-export { default as Synnax } from './lib/client';
-export * from './lib/telem';
-export { AuthError, ContiguityError, GeneralError, ParseError, QueryError, RouteError, UnexpectedError, ValidationError, } from './lib/errors';
-export { Channel } from './lib/channel/client';

package/build/main/index.js

@@ -1,35 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Channel = exports.ValidationError = exports.UnexpectedError = exports.RouteError = exports.QueryError = exports.ParseError = exports.GeneralError = exports.ContiguityError = exports.AuthError = exports.Synnax = void 0;
-var client_1 = require("./lib/client");
-Object.defineProperty(exports, "Synnax", { enumerable: true, get: function () { return __importDefault(client_1).default; } });
-__exportStar(require("./lib/telem"), exports);
-var errors_1 = require("./lib/errors");
-Object.defineProperty(exports, "AuthError", { enumerable: true, get: function () { return errors_1.AuthError; } });
-Object.defineProperty(exports, "ContiguityError", { enumerable: true, get: function () { return errors_1.ContiguityError; } });
-Object.defineProperty(exports, "GeneralError", { enumerable: true, get: function () { return errors_1.GeneralError; } });
-Object.defineProperty(exports, "ParseError", { enumerable: true, get: function () { return errors_1.ParseError; } });
-Object.defineProperty(exports, "QueryError", { enumerable: true, get: function () { return errors_1.QueryError; } });
-Object.defineProperty(exports, "RouteError", { enumerable: true, get: function () { return errors_1.RouteError; } });
-Object.defineProperty(exports, "UnexpectedError", { enumerable: true, get: function () { return errors_1.UnexpectedError; } });
-Object.defineProperty(exports, "ValidationError", { enumerable: true, get: function () { return errors_1.ValidationError; } });
-var client_2 = require("./lib/channel/client");
-Object.defineProperty(exports, "Channel", { enumerable: true, get: function () { return client_2.Channel; } });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSx1Q0FBaUQ7QUFBeEMsaUhBQUEsT0FBTyxPQUFVO0FBQzFCLDhDQUE0QjtBQUM1Qix1Q0FTc0I7QUFScEIsbUdBQUEsU0FBUyxPQUFBO0FBQ1QseUdBQUEsZUFBZSxPQUFBO0FBQ2Ysc0dBQUEsWUFBWSxPQUFBO0FBQ1osb0dBQUEsVUFBVSxPQUFBO0FBQ1Ysb0dBQUEsVUFBVSxPQUFBO0FBQ1Ysb0dBQUEsVUFBVSxPQUFBO0FBQ1YseUdBQUEsZUFBZSxPQUFBO0FBQ2YseUdBQUEsZUFBZSxPQUFBO0FBRWpCLCtDQUErQztBQUF0QyxpR0FBQSxPQUFPLE9BQUEifQ==

package/build/main/lib/auth.d.ts

@@ -1,54 +0,0 @@
-import { HTTPClientFactory, Middleware } from '@synnaxlabs/freighter';
-import { z } from 'zod';
-import { UserPayload } from './user/payload';
-export declare const tokenMiddleware: (token: () => Promise<string>) => Middleware;
-export declare const InsecureCredentialsSchema: z.ZodObject<{
-    username: z.ZodString;
-    password: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    username: string;
-    password: string;
-}, {
-    username: string;
-    password: string;
-}>;
-export declare type InsecureCredentials = z.infer<typeof InsecureCredentialsSchema>;
-export declare const TokenResponseSchema: z.ZodObject<{
-    token: z.ZodString;
-    user: z.ZodObject<{
-        key: z.ZodString;
-        username: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        username: string;
-        key: string;
-    }, {
-        username: string;
-        key: string;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    token: string;
-    user: {
-        username: string;
-        key: string;
-    };
-}, {
-    token: string;
-    user: {
-        username: string;
-        key: string;
-    };
-}>;
-export declare type TokenResponse = z.infer<typeof TokenResponseSchema>;
-export default class AuthenticationClient {
-    private static ENDPOINT;
-    private token;
-    private client;
-    private credentials;
-    authenticating: Promise<void> | undefined;
-    authenticated: boolean;
-    user: UserPayload | undefined;
-    constructor(factory: HTTPClientFactory, creds: InsecureCredentials);
-    authenticate(): void;
-    private maybeWaitAuthenticated;
-    middleware(): Middleware;
-}

package/build/main/lib/auth.js

@@ -1,62 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TokenResponseSchema = exports.InsecureCredentialsSchema = exports.tokenMiddleware = void 0;
-const zod_1 = require("zod");
-const errors_1 = require("./errors");
-const payload_1 = require("./user/payload");
-const tokenMiddleware = (token) => {
-    return async (md, next) => {
-        md.params['Authorization'] = `Bearer ${await token()}`;
-        return await next(md);
-    };
-};
-exports.tokenMiddleware = tokenMiddleware;
-exports.InsecureCredentialsSchema = zod_1.z.object({
-    username: zod_1.z.string(),
-    password: zod_1.z.string(),
-});
-exports.TokenResponseSchema = zod_1.z.object({
-    token: zod_1.z.string(),
-    user: payload_1.UserPayloadSchema,
-});
-class AuthenticationClient {
-    constructor(factory, creds) {
-        this.client = factory.postClient();
-        this.credentials = creds;
-        this.authenticated = false;
-        this.authenticate();
-    }
-    authenticate() {
-        this.authenticating = new Promise((resolve, reject) => {
-            this.client
-                .send(AuthenticationClient.ENDPOINT, this.credentials, exports.TokenResponseSchema)
-                .then(([res, err]) => {
-                if (err) {
-                    reject(err);
-                    return;
-                }
-                this.token = res === null || res === void 0 ? void 0 : res.token;
-                this.user = res === null || res === void 0 ? void 0 : res.user;
-                this.authenticated = true;
-                resolve();
-            });
-        });
-    }
-    async maybeWaitAuthenticated() {
-        if (this.authenticating)
-            await this.authenticating;
-        this.authenticating = undefined;
-    }
-    middleware() {
-        return (0, exports.tokenMiddleware)(async () => {
-            await this.maybeWaitAuthenticated();
-            if (!this.token) {
-                throw new errors_1.AuthError('[auth] - attempting to authenticate without a token');
-            }
-            return this.token;
-        });
-    }
-}
-exports.default = AuthenticationClient;
-AuthenticationClient.ENDPOINT = '/auth/login';
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXV0aC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvYXV0aC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFLQSw2QkFBd0I7QUFFeEIscUNBQXFDO0FBQ3JDLDRDQUFnRTtBQUV6RCxNQUFNLGVBQWUsR0FBRyxDQUFDLEtBQTRCLEVBQWMsRUFBRTtJQUMxRSxPQUFPLEtBQUssRUFBRSxFQUFFLEVBQUUsSUFBSSxFQUFFLEVBQUU7UUFDeEIsRUFBRSxDQUFDLE1BQU0sQ0FBQyxlQUFlLENBQUMsR0FBRyxVQUFVLE1BQU0sS0FBSyxFQUFFLEVBQUUsQ0FBQztRQUN2RCxPQUFPLE1BQU0sSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDO0lBQ3hCLENBQUMsQ0FBQztBQUNKLENBQUMsQ0FBQztBQUxXLFFBQUEsZUFBZSxtQkFLMUI7QUFFVyxRQUFBLHlCQUF5QixHQUFHLE9BQUMsQ0FBQyxNQUFNLENBQUM7SUFDaEQsUUFBUSxFQUFFLE9BQUMsQ0FBQyxNQUFNLEVBQUU7SUFDcEIsUUFBUSxFQUFFLE9BQUMsQ0FBQyxNQUFNLEVBQUU7Q0FDckIsQ0FBQyxDQUFDO0FBSVUsUUFBQSxtQkFBbUIsR0FBRyxPQUFDLENBQUMsTUFBTSxDQUFDO0lBQzFDLEtBQUssRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO0lBQ2pCLElBQUksRUFBRSwyQkFBaUI7Q0FDeEIsQ0FBQyxDQUFDO0FBSUgsTUFBcUIsb0JBQW9CO0lBU3ZDLFlBQVksT0FBMEIsRUFBRSxLQUEwQjtRQUNoRSxJQUFJLENBQUMsTUFBTSxHQUFHLE9BQU8sQ0FBQyxVQUFVLEVBQUUsQ0FBQztRQUNuQyxJQUFJLENBQUMsV0FBVyxHQUFHLEtBQUssQ0FBQztRQUN6QixJQUFJLENBQUMsYUFBYSxHQUFHLEtBQUssQ0FBQztRQUMzQixJQUFJLENBQUMsWUFBWSxFQUFFLENBQUM7SUFDdEIsQ0FBQztJQUVELFlBQVk7UUFDVixJQUFJLENBQUMsY0FBYyxHQUFHLElBQUksT0FBTyxDQUFDLENBQUMsT0FBTyxFQUFFLE1BQU0sRUFBRSxFQUFFO1lBQ3BELElBQUksQ0FBQyxNQUFNO2lCQUNSLElBQUksQ0FDSCxvQkFBb0IsQ0FBQyxRQUFRLEVBQzdCLElBQUksQ0FBQyxXQUFXLEVBQ2hCLDJCQUFtQixDQUNwQjtpQkFDQSxJQUFJLENBQUMsQ0FBQyxDQUFDLEdBQUcsRUFBRSxHQUFHLENBQUMsRUFBRSxFQUFFO2dCQUNuQixJQUFJLEdBQUcsRUFBRTtvQkFDUCxNQUFNLENBQUMsR0FBRyxDQUFDLENBQUM7b0JBQ1osT0FBTztpQkFDUjtnQkFDRCxJQUFJLENBQUMsS0FBSyxHQUFHLEdBQUcsYUFBSCxHQUFHLHVCQUFILEdBQUcsQ0FBRSxLQUFLLENBQUM7Z0JBQ3hCLElBQUksQ0FBQyxJQUFJLEdBQUcsR0FBRyxhQUFILEdBQUcsdUJBQUgsR0FBRyxDQUFFLElBQUksQ0FBQztnQkFDdEIsSUFBSSxDQUFDLGFBQWEsR0FBRyxJQUFJLENBQUM7Z0JBQzFCLE9BQU8sRUFBRSxDQUFDO1lBQ1osQ0FBQyxDQUFDLENBQUM7UUFDUCxDQUFDLENBQUMsQ0FBQztJQUNMLENBQUM7SUFFTyxLQUFLLENBQUMsc0JBQXNCO1FBQ2xDLElBQUksSUFBSSxDQUFDLGNBQWM7WUFBRSxNQUFNLElBQUksQ0FBQyxjQUFjLENBQUM7UUFDbkQsSUFBSSxDQUFDLGNBQWMsR0FBRyxTQUFTLENBQUM7SUFDbEMsQ0FBQztJQUVELFVBQVU7UUFDUixPQUFPLElBQUEsdUJBQWUsRUFBQyxLQUFLLElBQUksRUFBRTtZQUNoQyxNQUFNLElBQUksQ0FBQyxzQkFBc0IsRUFBRSxDQUFDO1lBQ3BDLElBQUksQ0FBQyxJQUFJLENBQUMsS0FBSyxFQUFFO2dCQUNmLE1BQU0sSUFBSSxrQkFBUyxDQUNqQixxREFBcUQsQ0FDdEQsQ0FBQzthQUNIO1lBQ0QsT0FBTyxJQUFJLENBQUMsS0FBSyxDQUFDO1FBQ3BCLENBQUMsQ0FBQyxDQUFDO0lBQ0wsQ0FBQzs7QUFwREgsdUNBcURDO0FBcERnQiw2QkFBUSxHQUFHLGFBQWEsQ0FBQyJ9

package/build/main/lib/auth.spec.js

@@ -1,39 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const freighter_1 = require("@synnaxlabs/freighter");
-const ava_1 = __importDefault(require("ava"));
-const setupspecs_1 = require("../setupspecs");
-const auth_1 = __importDefault(require("./auth"));
-const errors_1 = require("./errors");
-const transport_1 = __importDefault(require("./transport"));
-(0, ava_1.default)('[auth] - valid credentials', async (t) => {
-    const transport = new transport_1.default(new freighter_1.URL({ host: setupspecs_1.HOST, port: setupspecs_1.PORT }));
-    const client = new auth_1.default(transport.httpFactory, {
-        username: 'synnax',
-        password: 'seldon',
-    });
-    await client.authenticating;
-    t.assert(client.authenticated);
-});
-(0, ava_1.default)('[auth] - invalid credentials', async (t) => {
-    const transport = new transport_1.default(new freighter_1.URL({ host: setupspecs_1.HOST, port: setupspecs_1.PORT }));
-    const client = new auth_1.default(transport.httpFactory, {
-        username: 'synnax',
-        password: 'wrong',
-    });
-    try {
-        await client.authenticating;
-        t.assert(false);
-    }
-    catch (e) {
-        t.assert(!client.authenticated);
-        t.assert(e instanceof errors_1.AuthError);
-        if (e instanceof errors_1.AuthError) {
-            t.is(e.message, '[synnax] - invalid credentials');
-        }
-    }
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXV0aC5zcGVjLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2xpYi9hdXRoLnNwZWMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSxxREFBNEM7QUFDNUMsOENBQXVCO0FBRXZCLDhDQUEyQztBQUUzQyxrREFBMEM7QUFDMUMscUNBQXFDO0FBQ3JDLDREQUFvQztBQUVwQyxJQUFBLGFBQUksRUFBQyw0QkFBNEIsRUFBRSxLQUFLLEVBQUUsQ0FBQyxFQUFFLEVBQUU7SUFDN0MsTUFBTSxTQUFTLEdBQUcsSUFBSSxtQkFBUyxDQUFDLElBQUksZUFBRyxDQUFDLEVBQUUsSUFBSSxFQUFFLGlCQUFJLEVBQUUsSUFBSSxFQUFFLGlCQUFJLEVBQUUsQ0FBQyxDQUFDLENBQUM7SUFDckUsTUFBTSxNQUFNLEdBQUcsSUFBSSxjQUFvQixDQUFDLFNBQVMsQ0FBQyxXQUFXLEVBQUU7UUFDN0QsUUFBUSxFQUFFLFFBQVE7UUFDbEIsUUFBUSxFQUFFLFFBQVE7S0FDbkIsQ0FBQyxDQUFDO0lBQ0gsTUFBTSxNQUFNLENBQUMsY0FBYyxDQUFDO0lBQzVCLENBQUMsQ0FBQyxNQUFNLENBQUMsTUFBTSxDQUFDLGFBQWEsQ0FBQyxDQUFDO0FBQ2pDLENBQUMsQ0FBQyxDQUFDO0FBRUgsSUFBQSxhQUFJLEVBQUMsOEJBQThCLEVBQUUsS0FBSyxFQUFFLENBQUMsRUFBRSxFQUFFO0lBQy9DLE1BQU0sU0FBUyxHQUFHLElBQUksbUJBQVMsQ0FBQyxJQUFJLGVBQUcsQ0FBQyxFQUFFLElBQUksRUFBRSxpQkFBSSxFQUFFLElBQUksRUFBRSxpQkFBSSxFQUFFLENBQUMsQ0FBQyxDQUFDO0lBQ3JFLE1BQU0sTUFBTSxHQUFHLElBQUksY0FBb0IsQ0FBQyxTQUFTLENBQUMsV0FBVyxFQUFFO1FBQzdELFFBQVEsRUFBRSxRQUFRO1FBQ2xCLFFBQVEsRUFBRSxPQUFPO0tBQ2xCLENBQUMsQ0FBQztJQUNILElBQUk7UUFDRixNQUFNLE1BQU0sQ0FBQyxjQUFjLENBQUM7UUFDNUIsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQztLQUNqQjtJQUFDLE9BQU8sQ0FBQyxFQUFFO1FBQ1YsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxDQUFDLE1BQU0sQ0FBQyxhQUFhLENBQUMsQ0FBQztRQUNoQyxDQUFDLENBQUMsTUFBTSxDQUFDLENBQUMsWUFBWSxrQkFBUyxDQUFDLENBQUM7UUFDakMsSUFBSSxDQUFDLFlBQVksa0JBQVMsRUFBRTtZQUMxQixDQUFDLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxPQUFPLEVBQUUsZ0NBQWdDLENBQUMsQ0FBQztTQUNuRDtLQUNGO0FBQ0gsQ0FBQyxDQUFDLENBQUMifQ==

package/build/main/lib/channel/channel.spec.js

@@ -1,49 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const ava_1 = __importDefault(require("ava"));
-const setupspecs_1 = require("../../setupspecs");
-const errors_1 = require("../errors");
-const telem_1 = require("../telem");
-const client = (0, setupspecs_1.newClient)();
-(0, ava_1.default)('Channel - create', async (t) => {
-    const channel = await client.channel.create({
-        name: 'test',
-        nodeId: 1,
-        rate: telem_1.Rate.Hz(1),
-        dataType: telem_1.DataType.Float32,
-    });
-    t.is(channel.name, 'test');
-    t.is(channel.nodeId, 1);
-    t.deepEqual(channel.rate, telem_1.Rate.Hz(1));
-    t.deepEqual(channel.dataType, telem_1.DataType.Float32);
-});
-(0, ava_1.default)('Channel - retrieve by key', async (t) => {
-    const channel = await client.channel.create({
-        name: 'test',
-        nodeId: 1,
-        rate: telem_1.Rate.Hz(1),
-        dataType: telem_1.DataType.Float32,
-    });
-    const retrieved = (await client.channel.retrieveByKeys(channel.key))[0];
-    t.is(retrieved.name, 'test');
-    t.is(retrieved.nodeId, 1);
-    t.deepEqual(retrieved.rate, telem_1.Rate.Hz(1));
-    t.deepEqual(retrieved.dataType, telem_1.DataType.Float32);
-});
-(0, ava_1.default)('Channel - retrieve by key - not found', async (t) => {
-    const err = await t.throwsAsync(async () => {
-        await client.channel.retrieveByKeys('1-1000');
-    });
-    t.true(err instanceof errors_1.QueryError);
-});
-(0, ava_1.default)('Channel - retrieve by node id', async (t) => {
-    const retrieved = await client.channel.retrieveByNodeId(1);
-    t.true(retrieved.length > 0);
-    retrieved.forEach((ch) => {
-        t.is(ch.nodeId, 1);
-    });
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2hhbm5lbC5zcGVjLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2xpYi9jaGFubmVsL2NoYW5uZWwuc3BlYy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUFBLDhDQUF1QjtBQUV2QixpREFBNkM7QUFDN0Msc0NBQXVDO0FBQ3ZDLG9DQUEwQztBQUUxQyxNQUFNLE1BQU0sR0FBRyxJQUFBLHNCQUFTLEdBQUUsQ0FBQztBQUUzQixJQUFBLGFBQUksRUFBQyxrQkFBa0IsRUFBRSxLQUFLLEVBQUUsQ0FBQyxFQUFFLEVBQUU7SUFDbkMsTUFBTSxPQUFPLEdBQUcsTUFBTSxNQUFNLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQztRQUMxQyxJQUFJLEVBQUUsTUFBTTtRQUNaLE1BQU0sRUFBRSxDQUFDO1FBQ1QsSUFBSSxFQUFFLFlBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQyxDQUFDO1FBQ2hCLFFBQVEsRUFBRSxnQkFBUSxDQUFDLE9BQU87S0FDM0IsQ0FBQyxDQUFDO0lBQ0gsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxPQUFPLENBQUMsSUFBSSxFQUFFLE1BQU0sQ0FBQyxDQUFDO0lBQzNCLENBQUMsQ0FBQyxFQUFFLENBQUMsT0FBTyxDQUFDLE1BQU0sRUFBRSxDQUFDLENBQUMsQ0FBQztJQUN4QixDQUFDLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQyxJQUFJLEVBQUUsWUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQ3RDLENBQUMsQ0FBQyxTQUFTLENBQUMsT0FBTyxDQUFDLFFBQVEsRUFBRSxnQkFBUSxDQUFDLE9BQU8sQ0FBQyxDQUFDO0FBQ2xELENBQUMsQ0FBQyxDQUFDO0FBRUgsSUFBQSxhQUFJLEVBQUMsMkJBQTJCLEVBQUUsS0FBSyxFQUFFLENBQUMsRUFBRSxFQUFFO0lBQzVDLE1BQU0sT0FBTyxHQUFHLE1BQU0sTUFBTSxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUM7UUFDMUMsSUFBSSxFQUFFLE1BQU07UUFDWixNQUFNLEVBQUUsQ0FBQztRQUNULElBQUksRUFBRSxZQUFJLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQztRQUNoQixRQUFRLEVBQUUsZ0JBQVEsQ0FBQyxPQUFPO0tBQzNCLENBQUMsQ0FBQztJQUNILE1BQU0sU0FBUyxHQUFHLENBQUMsTUFBTSxNQUFNLENBQUMsT0FBTyxDQUFDLGNBQWMsQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUN4RSxDQUFDLENBQUMsRUFBRSxDQUFDLFNBQVMsQ0FBQyxJQUFJLEVBQUUsTUFBTSxDQUFDLENBQUM7SUFDN0IsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxTQUFTLENBQUMsTUFBTSxFQUFFLENBQUMsQ0FBQyxDQUFDO0lBQzFCLENBQUMsQ0FBQyxTQUFTLENBQUMsU0FBUyxDQUFDLElBQUksRUFBRSxZQUFJLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFDeEMsQ0FBQyxDQUFDLFNBQVMsQ0FBQyxTQUFTLENBQUMsUUFBUSxFQUFFLGdCQUFRLENBQUMsT0FBTyxDQUFDLENBQUM7QUFDcEQsQ0FBQyxDQUFDLENBQUM7QUFFSCxJQUFBLGFBQUksRUFBQyx1Q0FBdUMsRUFBRSxLQUFLLEVBQUUsQ0FBQyxFQUFFLEVBQUU7SUFDeEQsTUFBTSxHQUFHLEdBQUcsTUFBTSxDQUFDLENBQUMsV0FBVyxDQUFDLEtBQUssSUFBSSxFQUFFO1FBQ3pDLE1BQU0sTUFBTSxDQUFDLE9BQU8sQ0FBQyxjQUFjLENBQUMsUUFBUSxDQUFDLENBQUM7SUFDaEQsQ0FBQyxDQUFDLENBQUM7SUFDSCxDQUFDLENBQUMsSUFBSSxDQUFDLEdBQUcsWUFBWSxtQkFBVSxDQUFDLENBQUM7QUFDcEMsQ0FBQyxDQUFDLENBQUM7QUFFSCxJQUFBLGFBQUksRUFBQywrQkFBK0IsRUFBRSxLQUFLLEVBQUUsQ0FBQyxFQUFFLEVBQUU7SUFDaEQsTUFBTSxTQUFTLEdBQUcsTUFBTSxNQUFNLENBQUMsT0FBTyxDQUFDLGdCQUFnQixDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQzNELENBQUMsQ0FBQyxJQUFJLENBQUMsU0FBUyxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUMsQ0FBQztJQUM3QixTQUFTLENBQUMsT0FBTyxDQUFDLENBQUMsRUFBRSxFQUFFLEVBQUU7UUFDdkIsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxFQUFFLENBQUMsTUFBTSxFQUFFLENBQUMsQ0FBQyxDQUFDO0lBQ3JCLENBQUMsQ0FBQyxDQUFDO0FBQ0wsQ0FBQyxDQUFDLENBQUMifQ==

package/build/main/lib/channel/client.d.ts

@@ -1,94 +0,0 @@
-import SegmentClient from '../segment/client';
-import { DataType, Density, Rate, TypedArray, UnparsedTimeStamp } from '../telem';
-import ChannelCreator from './creator';
-import { CreateChannelProps } from './creator';
-import { ChannelPayload } from './payload';
-import ChannelRetriever from './retriever';
-/**
- * Represents a Channel in a Synnax database. It should not be instantiated
- * directly, but rather created or retrieved from a {@link ChannelClient}.
- */
-export declare class Channel {
-    private readonly segmentClient;
-    private payload;
-    constructor(payload: ChannelPayload, segmentClient: SegmentClient);
-    get key(): string;
-    get name(): string;
-    get nodeId(): number;
-    get rate(): Rate;
-    get dataType(): DataType;
-    get density(): Density;
-    /**
-     * Reads telemetry from the channel between the two timestamps.
-     *
-     * @param start - The starting timestamp of the range to read from.
-     * @param end - The ending timestamp of the range to read from.
-     * @returns a typed array containing the retrieved
-     */
-    read(start: UnparsedTimeStamp, end: UnparsedTimeStamp): Promise<TypedArray>;
-    /**
-     * Writes telemetry to the channel starting at the given timestamp.
-     *
-     * @param start - The starting timestamp of the first sample in data.
-     * @param data - THe telemetry to write to the channel.
-     */
-    write(start: UnparsedTimeStamp, data: TypedArray): Promise<boolean>;
-}
-/** The core client class for executing channel operations against a Synnax
- * database .
- * */
-export default class ChannelClient {
-    private readonly segmentClient;
-    private readonly retriever;
-    private readonly creator;
-    constructor(segmentClient: SegmentClient, retriever: ChannelRetriever, creator: ChannelCreator);
-    /**
-     * Creates a new channel with the given properties.
-     *
-     * @param props.rate - The rate of the channel.
-     * @param props.dataType - The data type of the channel.
-     * @param props.name - The name of the channel. Optional.
-     * @param props.nodeId - The ID of the node that holds the lease on the channel.
-     * If you don't know what this is, don't worry about it.
-     * @returns the created channel.
-     */
-    create(props: CreateChannelProps): Promise<Channel>;
-    /**
-     * creates N channels using the given parameters as a template.
-     *
-     * @param props.rate - The rate of the channel.
-     * @param props.dataType - The data type of the channel.
-     * @param props.name - The name of the channel. Optional.
-     * @param props.nodeId - The ID of the node that holds the lease on the channel.
-     * If you don't know what this is, don't worry about it.
-     * @param props.count - The number of channels to create.
-     * @returns the created channels.
-     */
-    createMany(props: CreateChannelProps & {
-        count: number;
-    }): Promise<Channel[]>;
-    /**
-     * Retrieves channels with the given keys.
-     *
-     * @param keys - The keys of the channels to retrieve.
-     * @throws QueryError if any of the channels can't be found.
-     * @returns the retrieved channels.
-     */
-    retrieveByKeys(...keys: string[]): Promise<Channel[]>;
-    /**
-     * Retrieves channels with the given names.
-     *
-     * @param names - The list of names to retrieve channels for.
-     * @returns A list of retrieved channels matching the given names. If a channel
-     * with a given name can't be found, it will be omitted from the list.
-     */
-    retrieveByNames(...names: string[]): Promise<Channel[]>;
-    /**
-     * Retrieves channels whose lease node is the given ID.
-     *
-     * @param nodeId - The ID of the node to retrieve channels for.
-     * @returns A list of retrieved channels matching the given node ID.
-     */
-    retrieveByNodeId(nodeId: number): Promise<Channel[]>;
-    private sugar;
-}