@synnaxlabs/client 0.22.1 → 0.23.0

package/dist/workspace/schematic/writer.d.ts

@@ -1,4 +1,4 @@
-import { Schematic, Params, Key } from './payload';
+import { Key, Params, Schematic } from './payload';
 import { z } from 'zod';
 import { UnknownRecord } from '@synnaxlabs/x/record';
 import { UnaryClient } from '@synnaxlabs/freighter';
@@ -10,12 +10,12 @@ export declare const newSchematicZ: z.ZodEffects<z.ZodObject<{
     snapshot: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     name: string;
-    data: (UnknownRecord | Record<string | number | symbol, unknown>) & (UnknownRecord | Record<string | number | symbol, unknown> | undefined);
+    data: UnknownRecord | Record<string | number | symbol, unknown>;
     key?: string | undefined;
     snapshot?: boolean | undefined;
 }, {
     name: string;
-    data: (string | Record<string | number | symbol, unknown>) & (string | Record<string | number | symbol, unknown> | undefined);
+    data: string | Record<string | number | symbol, unknown>;
     key?: string | undefined;
     snapshot?: boolean | undefined;
 }>, {
@@ -25,7 +25,7 @@ export declare const newSchematicZ: z.ZodEffects<z.ZodObject<{
     snapshot?: boolean | undefined;
 }, {
     name: string;
-    data: (string | Record<string | number | symbol, unknown>) & (string | Record<string | number | symbol, unknown> | undefined);
+    data: string | Record<string | number | symbol, unknown>;
     key?: string | undefined;
     snapshot?: boolean | undefined;
 }>;

package/dist/workspace/schematic/writer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"writer.d.ts","sourceRoot":"","sources":["../../../src/workspace/schematic/writer.ts"],"names":[],"mappings":"AASA,OAAO,EAAgB,KAAK,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACvE,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAEL,KAAK,SAAS,EACd,KAAK,MAAM,EAEX,KAAK,GAAG,EAET,MAAM,+BAA+B,CAAC;AAEvC,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;EAGvB,CAAC;AAEJ,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AA+CzD,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;gBAEzB,MAAM,EAAE,WAAW;IAIzB,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,GAAG,OAAO,CAAC,SAAS,CAAC;IAatE,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;IAWnE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAWrC,MAAM,CAAC,SAAS,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAUnD,OAAO,CAAC,SAAS,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;CASlE"}
+{"version":3,"file":"writer.d.ts","sourceRoot":"","sources":["../../../src/workspace/schematic/writer.ts"],"names":[],"mappings":"AASA,OAAO,EAAgB,KAAK,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACvE,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EACL,KAAK,GAAG,EAER,KAAK,MAAM,EACX,KAAK,SAAS,EAGf,MAAM,+BAA+B,CAAC;AAEvC,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;EAGvB,CAAC;AAEJ,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AA+CzD,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;gBAEzB,MAAM,EAAE,WAAW;IAIzB,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,GAAG,OAAO,CAAC,SAAS,CAAC;IAatE,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC;IAWnE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAWrC,MAAM,CAAC,SAAS,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAUnD,OAAO,CAAC,SAAS,EAAE,GAAG,EAAE,IAAI,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;CASlE"}

package/dist/workspace/writer.d.ts

@@ -9,11 +9,11 @@ declare const newWorkspaceZ: z.ZodEffects<z.ZodObject<{
     layout: z.ZodUnion<[z.ZodRecord<z.ZodUnion<[z.ZodNumber, z.ZodString, z.ZodSymbol]>, z.ZodUnknown>, z.ZodEffects<z.ZodString, UnknownRecord, string>]>;
 }, "strip", z.ZodTypeAny, {
     name: string;
-    layout: (UnknownRecord | Record<string | number | symbol, unknown>) & (UnknownRecord | Record<string | number | symbol, unknown> | undefined);
+    layout: UnknownRecord | Record<string | number | symbol, unknown>;
     key?: string | undefined;
 }, {
     name: string;
-    layout: (string | Record<string | number | symbol, unknown>) & (string | Record<string | number | symbol, unknown> | undefined);
+    layout: string | Record<string | number | symbol, unknown>;
     key?: string | undefined;
 }>, {
     layout: string;
@@ -21,16 +21,18 @@ declare const newWorkspaceZ: z.ZodEffects<z.ZodObject<{
     key?: string | undefined;
 }, {
     name: string;
-    layout: (string | Record<string | number | symbol, unknown>) & (string | Record<string | number | symbol, unknown> | undefined);
+    layout: string | Record<string | number | symbol, unknown>;
     key?: string | undefined;
 }>;
 export type NewWorkspace = z.input<typeof newWorkspaceZ>;
 declare const createResZ: z.ZodObject<{
-    workspaces: z.ZodArray<z.ZodObject<{
+    workspaces: z.ZodArray<z.ZodObject<z.objectUtil.extendShape<Omit<{
         name: z.ZodString;
         key: z.ZodString;
+        layout: z.ZodUnion<[z.ZodRecord<z.ZodUnion<[z.ZodNumber, z.ZodString, z.ZodSymbol]>, z.ZodUnknown>, z.ZodEffects<z.ZodString, UnknownRecord, string>]>;
+    }, "layout">, {
         layout: z.ZodEffects<z.ZodString, UnknownRecord, string>;
-    }, "strip", z.ZodTypeAny, {
+    }>, "strip", z.ZodTypeAny, {
         name: string;
         key: string;
         layout: UnknownRecord;

package/dist/workspace/writer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"writer.d.ts","sourceRoot":"","sources":["../../src/workspace/writer.ts"],"names":[],"mappings":"AASA,OAAO,EAAgB,KAAK,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACvE,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EACL,KAAK,SAAS,EAIf,MAAM,qBAAqB,CAAC;AAE7B,QAAA,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;EAGhB,CAAC;AAEJ,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAMzD,QAAA,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;EAEd,CAAC;AAsBH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAOxD,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;gBAEzB,MAAM,EAAE,WAAW;IAIzB,MAAM,CAAC,UAAU,EAAE,YAAY,GAAG,YAAY,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAWvE,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAU9C,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAUhD,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;CASnE"}
+{"version":3,"file":"writer.d.ts","sourceRoot":"","sources":["../../src/workspace/writer.ts"],"names":[],"mappings":"AASA,OAAO,EAAgB,KAAK,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACvE,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAEL,KAAK,SAAS,EAGf,MAAM,qBAAqB,CAAC;AAE7B,QAAA,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;EAGhB,CAAC;AAEJ,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;AAMzD,QAAA,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEd,CAAC;AAsBH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAOxD,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;gBAEzB,MAAM,EAAE,WAAW;IAIzB,MAAM,CAAC,UAAU,EAAE,YAAY,GAAG,YAAY,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAWvE,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAU9C,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAUhD,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;CASnE"}

package/eslint.config.js

@@ -0,0 +1,12 @@
+// 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 synnaxConfig from "eslint-config-synnaxlabs";
+
+export default synnaxConfig;

package/examples/node/basicReadWrite.js

@@ -1,3 +1,12 @@
+// 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, Synnax, TimeRange, TimeSpan, TimeStamp } from "@synnaxlabs/client";
 
 // This example demonstrates the basics of reading and writing data from an index and data
@@ -32,7 +41,7 @@ const indexChannel = await client.channels.create({
 
 const N_SAMPLES = 5000;
 
-// We'll start our write at the current time. This timestamp should be the same as or 
+// We'll start our write at the current time. This timestamp should be the same as or
 // just before the first timestamp we write.
 const start = TimeStamp.now();
 
@@ -64,4 +73,4 @@ console.log({
 });
 
 // Make sure to close the client when you're done.
-client.close();
+client.close();

package/examples/node/liveStream.js

@@ -1,3 +1,12 @@
+// 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 { Synnax, TimeStamp } from "@synnaxlabs/client";
 
 // This example demonstrates how to stream live data from a channel in Synnax.
@@ -19,18 +28,18 @@ const client = new Synnax({
 
 // We can just specify the names of the channels we'd like to stream from.
 const read_from = [
-    "stream_write_example_time", 
-    "stream_write_example_data_1", 
+    "stream_write_example_time",
+    "stream_write_example_data_1",
     "stream_write_example_data_2"
 ]
 
 const streamer = await client.openStreamer(read_from);
 
-// It's very important that we close the streamer when we're done with it to release 
+// It's very important that we close the streamer when we're done with it to release
 // network connections and other resources, so we wrap the streaming loop in a try-finally
 // block.
 try {
-    // Loop through the frames in the streamer. Each iteration will block until a new 
+    // Loop through the frames in the streamer. Each iteration will block until a new
     // frame is available, and then we'll just print out the last sample for each
     // channel in the frame.
     for await (const frame of streamer) console.log(frame.at(-1));

package/examples/node/seriesAndFrames.js

@@ -1,6 +1,15 @@
+// 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 { Series } from "@synnaxlabs/client";
 
-// Construct a series from an array of numbers. In this case, the series will 
+// Construct a series from an array of numbers. In this case, the series will
 // automatically be of type float64.
 let series = new Series([1, 2, 3, 4, 5]);
 
@@ -159,5 +168,5 @@ frame = new Frame({
 try {
   obj = frame.at(3, true); // Throws an error
 } catch (e) {
-  console.log(e.message); // no value at index 
-}
+  console.log(e.message); // no value at index
+}

package/examples/node/streamWrite.js

@@ -1,3 +1,12 @@
+// 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.
+
 // This example demonstrates how to write data to an index channel and its corresponding
 // data channel in Synnax in a streaming fashion. Streaming data is ideal for live
 // applications (such as data acquisition from a sensor) or for very large datasets that
@@ -35,20 +44,20 @@ const dataChannel2 = await client.channels.create({
 }, { retrieveIfNameExists: true });
 
 
-// We'll start our write at the current time. This timestamps should be the same as or 
+// We'll start our write at the current time. This timestamps should be the same as or
 // just before the first timestamp we write.
 const start = TimeStamp.now();
 
-// Set a rough rate of 20 Hz. This won't be exact because we're sleeping for a fixed 
+// Set a rough rate of 20 Hz. This won't be exact because we're sleeping for a fixed
 // amount of time, but it's close enough for demonstration purposes.
 const roughRate = Rate.hz(25);
 
-// Make the writer commit every 500 samples. This will make the data available for 
+// Make the writer commit every 500 samples. This will make the data available for
 // historical reads every 500 samples.
 const commitInterval = 500;
 
 const writer = await client.openWriter({
-    start, 
+    start,
     channels: [timeChannel.key, dataChannel1.key, dataChannel2.key],
 });
 
@@ -66,9 +75,9 @@ try {
             [dataChannel2.key]: data2,
         });
 
-        if (i % 60 == 0) 
+        if (i % 60 == 0)
             console.log(`Writing sample ${i} at ${timestamp.toISOString()}`)
-        
+
         // Commit the writer. This method will return false if the commit fails i.e.
         // we've mad an invalid write or someone has already written to this region.
         if (i % commitInterval == 0 && !await writer.commit()) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@synnaxlabs/client",
   "private": false,
-  "version": "0.22.1",
+  "version": "0.23.0",
   "type": "module",
   "description": "The Client Library for Synnax",
   "repository": "https://github.com/synnaxlabs/synnax/tree/main/client/ts",
@@ -17,21 +17,24 @@
   ],
   "dependencies": {
     "async-mutex": "^0.5.0",
-    "nanoid": "^5.0.7",
-    "zod": "3.22.4",
-    "@synnaxlabs/x": "0.16.0",
-    "@synnaxlabs/freighter": "0.10.0"
+    "nanoid": "^3.0.0",
+    "zod": "3.23.8",
+    "@synnaxlabs/freighter": "0.23.0",
+    "@synnaxlabs/x": "0.23.0"
   },
   "devDependencies": {
     "@types/node": "^20.12.7",
     "@vitest/coverage-v8": "^1.5.0",
     "eslint": "^9.0.0",
     "typescript": "^5.4.5",
-    "vite": "5.2.8",
+    "vite": "5.2.11",
     "vitest": "^1.5.0",
     "@synnaxlabs/tsconfig": "0.0.2",
-    "eslint-config-synnaxlabs": "0.0.1",
-    "@synnaxlabs/vite-plugin": "0.0.1"
+    "@synnaxlabs/vite-plugin": "0.0.1",
+    "eslint-config-synnaxlabs": "0.0.1"
+  },
+  "peerDependencies": {
+    "zod": "^3.23.8"
   },
   "main": "dist/client.cjs",
   "module": "dist/client.js",

package/src/auth/auth.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -7,6 +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 { Context } from "@synnaxlabs/freighter";
 import { URL } from "@synnaxlabs/x/url";
 import { describe, expect, it, test } from "vitest";
 
@@ -14,7 +15,6 @@ import { auth } from "@/auth";
 import { AuthError, InvalidTokenError } from "@/errors";
 import { HOST, PORT } from "@/setupspecs";
 import { Transport } from "@/transport";
-import { Context } from "@synnaxlabs/freighter";
 
 const DUMMY_CTX: Context = {
   target: "test",
@@ -57,7 +57,7 @@ describe("auth", () => {
       let isFirst = true;
       let tkOne: string | undefined;
       let tkTwo: string | undefined;
-      const [, err] = await mw(DUMMY_CTX, async (ctx) => {
+      const [, err] = await mw(DUMMY_CTX, async () => {
         if (isFirst) {
           isFirst = false;
           tkOne = client.token;
@@ -77,9 +77,10 @@ describe("auth", () => {
         password: "seldon",
       });
       const mw = client.middleware();
-      const [, err] = await mw(DUMMY_CTX, async () => 
-          [DUMMY_CTX, new InvalidTokenError()]
-      );
+      const [, err] = await mw(DUMMY_CTX, async () => [
+        DUMMY_CTX,
+        new InvalidTokenError(),
+      ]);
       expect(err).toBeInstanceOf(InvalidTokenError);
     });
   });

package/src/auth/auth.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -50,19 +50,23 @@ export class Client {
     const mw: Middleware = async (reqCtx, next) => {
       if (!this.authenticated && !reqCtx.target.endsWith(LOGIN_ENDPOINT)) {
         if (this.authenticating == null)
-          this.authenticating = new Promise(async (resolve) => {
-            const [res, err] = await this.client.send(
-              LOGIN_ENDPOINT,
+          this.authenticating = new Promise((resolve, reject) => {
+            this.client
+              .send(
+                LOGIN_ENDPOINT,
 
-              this.credentials,
-              insecureCredentialsZ,
-              tokenResponseZ,
-            );
-            if (err != null) return resolve(err);
-            this.token = res?.token;
-            this.user = res?.user;
-            this.authenticated = true;
-            resolve(null);
+                this.credentials,
+                insecureCredentialsZ,
+                tokenResponseZ,
+              )
+              .then(([res, err]) => {
+                if (err != null) return resolve(err);
+                this.token = res?.token;
+                this.user = res?.user;
+                this.authenticated = true;
+                resolve(null);
+              })
+              .catch(reject);
           });
         const err = await this.authenticating;
         if (err != null) return [reqCtx, err];

package/src/auth/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/channel/batchRetriever.spec.ts

@@ -1,12 +1,21 @@
+// 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, Rate } from "@synnaxlabs/x/telem";
 import { describe, expect, it, vi } from "vitest";
 
 import { type Params, type Payload } from "@/channel/payload";
 import {
+  analyzeChannelParams,
   DebouncedBatchRetriever,
-  type Retriever,
   type RetrieveOptions,
-  analyzeChannelParams,
+  type Retriever,
 } from "@/channel/retriever";
 
 class MockRetriever implements Retriever {
@@ -18,11 +27,11 @@ class MockRetriever implements Retriever {
     this.func = func;
   }
 
-  async search(term: string): Promise<Payload[]> {
+  async search(): Promise<Payload[]> {
     throw new Error("Method not implemented.");
   }
 
-  async page(offset: number, limit: number): Promise<Payload[]> {
+  async page(): Promise<Payload[]> {
     throw new Error("Method not implemented.");
   }
 
@@ -41,6 +50,7 @@ describe("channelRetriever", () => {
         key: key as number,
         name: `channel-${key}`,
         dataType: DataType.FLOAT32,
+        internal: false,
         isIndex: false,
         rate: Rate.hz(1),
         leaseholder: 1,
@@ -66,6 +76,7 @@ describe("channelRetriever", () => {
         key: key as number,
         name: `channel-${key}`,
         dataType: DataType.FLOAT32,
+        internal: false,
         isIndex: false,
         rate: Rate.hz(1),
         leaseholder: 1,
@@ -83,7 +94,7 @@ describe("channelRetriever", () => {
     expect(res.map((r) => r.map((c) => c.key))).toEqual([[1], [2], [1, 2]]);
   });
   it("should throw an error if the fetch fails", async () => {
-    const base = new MockRetriever(async (batch): Promise<Payload[]> => {
+    const base = new MockRetriever(async (): Promise<Payload[]> => {
       throw new Error("failed to fetch");
     });
     const retriever = new DebouncedBatchRetriever(base, 10);

package/src/channel/channel.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -8,7 +8,7 @@
 // included in the file licenses/APL.txt.
 
 import { DataType, Rate, TimeStamp } from "@synnaxlabs/x/telem";
-import { describe, expect, test, it } from "vitest";
+import { describe, expect, it, test } from "vitest";
 
 import { Channel } from "@/channel/client";
 import { NotFoundError, QueryError } from "@/errors";
@@ -87,8 +87,7 @@ describe("Channel", () => {
         dataType: DataType.FLOAT32,
         index: timeIndexChannel.key,
       });
-
-      const sensors = await client.channels.create([sensorOne, sensorTwo, sensorThree]);
+      await client.channels.create([sensorOne, sensorTwo, sensorThree]);
     });
     describe("retrieveIfNameExists", () => {
       it("should retrieve the existing channel when it exists", async () => {
@@ -220,4 +219,43 @@ describe("Channel", () => {
       ).rejects.toThrow(QueryError);
     });
   });
+  describe("rename", async () => {
+    test("single rename", async () => {
+      const channel = await client.channels.create({
+        name: "test",
+        leaseholder: 1,
+        rate: Rate.hz(1),
+        dataType: DataType.FLOAT32,
+      });
+      await client.channels.rename(channel.key, "test2");
+      const renamed = await client.channels.retrieve(channel.key);
+      expect(renamed.name).toEqual("test2");
+    });
+    test("multiple rename", async () => {
+      const channels = await client.channels.create([
+        {
+          name: "test1",
+          leaseholder: 1,
+          rate: Rate.hz(1),
+          dataType: DataType.FLOAT32,
+        },
+        {
+          name: "test2",
+          leaseholder: 1,
+          rate: Rate.hz(1),
+          dataType: DataType.FLOAT32,
+        },
+      ]);
+      await client.channels.rename(
+        [channels[0].key, channels[1].key],
+        ["test3", "test4"],
+      );
+      const renamed = await client.channels.retrieve([
+        channels[0].key,
+        channels[1].key,
+      ]);
+      expect(renamed[0].name).toEqual("test3");
+      expect(renamed[1].name).toEqual("test4");
+    });
+  });
 });

package/src/channel/client.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -10,35 +10,34 @@
 import { type UnaryClient } from "@synnaxlabs/freighter";
 import { type AsyncTermSearcher } from "@synnaxlabs/x/search";
 import {
-  DataType,
-  Rate,
-  type TypedArray,
   type CrudeDensity,
-  type TimeRange,
   type CrudeTimeStamp,
+  DataType,
   type MultiSeries,
+  Rate,
+  type TimeRange,
+  type TypedArray,
 } from "@synnaxlabs/x/telem";
 import { toArray } from "@synnaxlabs/x/toArray";
 
 import {
   type Key,
   type KeyOrName,
+  type NewPayload,
   type Params,
   type Payload,
   payload,
-  type NewPayload,
 } from "@/channel/payload";
 import {
   analyzeChannelParams,
   CacheRetriever,
   ClusterRetriever,
   DebouncedBatchRetriever,
-  type Retriever,
-  type PageOptions,
   type RetrieveOptions,
+  type Retriever,
 } from "@/channel/retriever";
 import { type Writer } from "@/channel/writer";
-import { MultipleFoundError, ValidationError } from "@/errors";
+import { ValidationError } from "@/errors";
 import { type framer } from "@/framer";
 import { checkForMultipleOrNoResults } from "@/util/retrieve";
 
@@ -90,6 +89,10 @@ export class Channel {
    * This is set to true if the channel is an index channel, and false otherwise.
    */
   readonly isIndex: boolean;
+  /**
+   * This is set to true if the channel is an internal channel, and false otherwise.
+   */
+  readonly internal: boolean;
   /**
    * An alias for the channel under a specific range. This parameter is unstable and
    * should not be relied upon in the current version of Synnax.
@@ -104,6 +107,7 @@ export class Channel {
     key = 0,
     isIndex = false,
     index = 0,
+    internal = false,
     frameClient,
     alias,
   }: NewPayload & {
@@ -117,6 +121,7 @@ export class Channel {
     this.leaseholder = leaseholder;
     this.index = index;
     this.isIndex = isIndex;
+    this.internal = internal;
     this.alias = alias;
     this._frameClient = frameClient ?? null;
   }
@@ -141,6 +146,7 @@ export class Channel {
       leaseholder: this.leaseholder,
       index: this.index,
       isIndex: this.isIndex,
+      internal: this.internal,
     });
   }
 
@@ -328,6 +334,10 @@ export class Client implements AsyncTermSearcher<string, Key, Channel> {
     return this.sugar(await this.retriever.search(term, options));
   }
 
+  /***
+   * Deletes channels from the database using the given keys or names.
+   * @param channels - The keys or names of the channels to delete.
+   */
   async delete(channels: Params): Promise<void> {
     const { normalized, variant } = analyzeChannelParams(channels);
     if (variant === "keys")
@@ -335,6 +345,13 @@ export class Client implements AsyncTermSearcher<string, Key, Channel> {
     return await this.writer.delete({ names: normalized as string[] });
   }
 
+  async rename(key: Key, name: string): Promise<void>;
+  async rename(keys: Key[], names: string[]): Promise<void>;
+
+  async rename(keys: Key | Key[], names: string | string[]): Promise<void> {
+    return await this.writer.rename(toArray(keys), toArray(names));
+  }
+
   newSearcherWithOptions(
     options: RetrieveOptions,
   ): AsyncTermSearcher<string, Key, Channel> {

package/src/channel/creator.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -10,7 +10,7 @@
 import type { UnaryClient } from "@synnaxlabs/freighter";
 import { z } from "zod";
 
-import { type Payload, payload, newPayload, type NewPayload } from "@/channel/payload";
+import { type NewPayload,newPayload, type Payload, payload } from "@/channel/payload";
 
 const reqZ = z.object({ channels: newPayload.array() });
 

package/src/channel/external.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -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/writer";
 export * from "@/channel/client";
 export * from "@/channel/payload";
 export * from "@/channel/retriever";
+export * from "@/channel/writer";

package/src/channel/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.