@synnaxlabs/client 0.18.1 → 0.18.3

package/examples/node/package-lock.json

@@ -9,7 +9,7 @@
       "version": "1.0.0",
       "license": "ISC",
       "dependencies": {
-        "@synnaxlabs/client": "^0.18.0"
+        "@synnaxlabs/client": "^0.18.2"
       }
     },
     "node_modules/@grpc/grpc-js": {
@@ -3653,16 +3653,28 @@
       }
     },
     "node_modules/@synnaxlabs/client": {
-      "version": "0.18.0",
-      "resolved": "https://registry.npmjs.org/@synnaxlabs/client/-/client-0.18.0.tgz",
-      "integrity": "sha512-o53rR0awYUCcdSCENzo+6VjsEEt30ExHG0B1FLOk3+865eIJkvazS4RrRYpitrIxuzAGIK12v0vZ/qj8sGzlfA==",
+      "version": "0.18.2",
+      "resolved": "https://registry.npmjs.org/@synnaxlabs/client/-/client-0.18.2.tgz",
+      "integrity": "sha512-y/uetgJq4zeB+7HTqFZyMkLYe1cV4iU0gRc90V/kYvVwTtWt0F5aB2kpZi5ta4nJTFFczPSUwzHOQNVm0zUZOQ==",
       "dependencies": {
         "@synnaxlabs/freighter": "0.9.3",
-        "@synnaxlabs/x": "0.15.0",
+        "@synnaxlabs/x": "0.15.2",
         "async-mutex": "^0.4.0",
         "zod": "3.22.4"
       }
     },
+    "node_modules/@synnaxlabs/client/node_modules/@synnaxlabs/x": {
+      "version": "0.15.2",
+      "resolved": "https://registry.npmjs.org/@synnaxlabs/x/-/x-0.15.2.tgz",
+      "integrity": "sha512-d0XP4tk7dx7847aeXppAFVCKLmPSGIWRnsyDvTkbU9rEZdt1XLnQh1+PoWBmlYUNtliGhcgOKkbCv3Tj9Di38Q==",
+      "dependencies": {
+        "async-mutex": "^0.4.0",
+        "js-convert-case": "^4.2.0",
+        "nanoid": "^5.0.2",
+        "typescript": "^5.3.3",
+        "zod": "3.22.4"
+      }
+    },
     "node_modules/@synnaxlabs/freighter": {
       "version": "0.9.3",
       "resolved": "https://registry.npmjs.org/@synnaxlabs/freighter/-/freighter-0.9.3.tgz",

package/examples/node/package.json

@@ -11,6 +11,6 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@synnaxlabs/client": "^0.18.0"
+    "@synnaxlabs/client": "^0.18.2"
   }
 }

package/examples/node/seriesAndFrames.js

@@ -34,4 +34,130 @@ let v = series.at(0);
 series = new Series([1, 2, 3, 4, 5]);
 let easierSeries = series.as("number");
 // Now we have a guarantee that this is a series of numbers.
-v = easierSeries.at(0);
+v = easierSeries.at(0);
+console.log(v);
+
+series = new Series({ data: [1, 2, 3, 4, 5], dataType: "int8" });
+const ta = series.data;
+console.log(ta); // Int8Array [ 1, 2, 3, 4, 5 ]
+
+series = new Series([1, 2, 3, 4, 5]);
+let jsArray = [...series];
+console.log(jsArray); // [ 1, 2, 3, 4, 5 ]
+const jsArray2 = Array.from(series);
+console.log(jsArray2); // [ 1, 2, 3, 4, 5 ]
+
+series = new Series([{ red: "cherry", yellow: "banana", orange: "orange" }]);
+jsArray = [...series];
+console.log(jsArray); // [ { red: 'cherry', yellow: 'banana', orange: 'orange' } ]
+
+import { TimeRange, TimeStamp, TimeSpan } from "@synnaxlabs/client";
+
+const start = TimeStamp.now();
+
+const tr = new TimeRange(start, start.add(TimeSpan.seconds(5)));
+
+series = new Series({
+  data: [1, 2, 3, 4, 5],
+  dataType: "float64",
+  timeRange: new TimeRange(start, start.add(TimeSpan.seconds(6)))
+});
+
+series = new Series([1, 2, 3, 4, 5]);
+console.log(series.length); // 5
+
+const stringSeries = new Series(["apple", "banana", "cherry"]);
+console.log(stringSeries.length); // 3
+
+import { DataType } from "@synnaxlabs/client";
+
+series = new Series([1, 2, 3, 4, 5]);
+console.log(series.dataType.toString()); // "float64"
+console.log(series.dataType.equals(DataType.STRING)); // true
+
+series = new Series([1, 2, 3, 4, 5]);
+console.log(series.max); // 5
+console.log(series.min); // 1
+console.log(series.bounds); // { lower: 1, upper: 5 }
+
+import { Frame } from "@synnaxlabs/client";
+
+// Construct a frame for the given channel names.
+let frame = new Frame({
+  "channel1": new Series([1, 2, 3, 4, 5]),
+  "channel2": new Series([5, 4, 3, 2, 1]),
+  "channel3": new Series([1, 1, 1, 1, 1]),
+});
+
+// Construct a frame for the given channel keys
+frame = new Frame({
+  1: new Series([1, 2, 3, 4, 5]),
+  2: new Series([5, 4, 3, 2, 1]),
+  // Notice that series do not need to be the same length.
+  3: new Series([1, 1, 1]),
+});
+
+// Construct a frame from a map
+frame = new Frame(new Map([
+  ["channel1", new Series([1, 2, 3, 4, 5])],
+  ["channel2", new Series([5, 4, 3, 2, 1])],
+  ["channel3", new Series([1, 1, 1, 1, 1])],
+]));
+
+// Or from an array of keys and series
+frame = new Frame(["channel1", "channel2", "channel3"], [
+  new Series([1, 2, 3, 4, 5]),
+  new Series([5, 4, 3, 2, 1]),
+  new Series([1, 1, 1, 1, 1]),
+]);
+
+// Or construct a frame with multiple series for a single channel
+frame = new Frame({
+  "channel1": [
+    new Series([1, 2, 3, 4, 5]),
+    new Series([5, 4, 3, 2, 1]),
+    new Series([1, 1, 1, 1, 1]),
+  ],
+  "channel2": [
+    new Series([1, 2, 3, 4, 5]),
+  ],
+});
+
+import { MultiSeries } from "@synnaxlabs/client";
+
+frame = new Frame({
+  "channel1": [new Series([1, 2]), new Series([3, 4, 5])],
+  "channel2": new Series([5, 4, 3, 2, 1]),
+  "channel3": new Series([1, 1, 1, 1, 1]),
+});
+
+const multiSeries = frame.get("channel1");
+// Access a value
+console.log(multiSeries.at(0)); // 1
+
+// Access a value from a specific series
+console.log(multiSeries.series[0].at(0)); // 1
+
+// Construct a Javascript array from the MultiSeries
+jsArray = [...multiSeries];
+console.log(jsArray); // [ 1, 2, 3, 4, 5 ]
+
+frame = new Frame({
+  "channel1": new Series([1, 2, 3, 4, 5]),
+  "channel2": new Series([5, 4, 3, 2, 1]),
+  "channel3": new Series([1, 1]),
+});
+
+let obj = frame.at(3);
+console.log(obj); // { channel1: 1, channel2: 5, channel3: undefined }
+
+frame = new Frame({
+  "channel1": new Series([1, 2, 3, 4, 5]),
+  "channel2": new Series([5, 4, 3, 2, 1]),
+  "channel3": new Series([1, 1]),
+});
+try {
+  obj = frame.at(3, true); // Throws an error
+} catch (e) {
+  console.log(e.message); // no value at index 
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@synnaxlabs/client",
   "private": false,
-  "version": "0.18.1",
+  "version": "0.18.3",
   "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.3",
-    "@synnaxlabs/x": "0.15.1"
+    "@synnaxlabs/freighter": "0.9.4",
+    "@synnaxlabs/x": "0.15.3"
   },
   "devDependencies": {
     "@types/node": "^20.10.5",

package/src/channel/channel.spec.ts

@@ -10,6 +10,7 @@
 import { DataType, Rate, TimeStamp } from "@synnaxlabs/x";
 import { describe, test, expect, it } from "vitest";
 
+import { Channel } from "@/channel/client";
 import { QueryError } from "@/errors";
 import { newClient } from "@/setupspecs";
 
@@ -62,72 +63,102 @@ describe("Channel", () => {
       expect(channels[0].name).toEqual("test1");
       expect(channels[1].name).toEqual("test2");
     });
+    test("create instances of channels", async () => {
+      const timeIndexChannel = await client.channels.create({
+        name: "time",
+        dataType: DataType.TIMESTAMP,
+        isIndex: true,
+      });
+
+      const sensorOne = new Channel({
+        name: "sensor_one",
+        dataType: DataType.FLOAT32,
+        index: timeIndexChannel.key,
+      });
+
+      const sensorTwo = new Channel({
+        name: "sensor_two",
+        dataType: DataType.FLOAT32,
+        index: timeIndexChannel.key,
+      });
+
+      const sensorThree = new Channel({
+        name: "sensor_three",
+        dataType: DataType.FLOAT32,
+        index: timeIndexChannel.key,
+      });
+
+      const sensors = await client.channels.create([sensorOne, sensorTwo, sensorThree]);
+    });
     describe("retrieveIfNameExists", () => {
       it("should retrieve the existing channel when it exists", async () => {
-        const name = `test-${Math.random()}-${TimeStamp.now().valueOf()}`
+        const name = `test-${Math.random()}-${TimeStamp.now().valueOf()}`;
         const channel = await client.channels.create({
           name,
           leaseholder: 1,
           rate: Rate.hz(1),
           dataType: DataType.FLOAT32,
         });
-        const channelTwo = await client.channels.create({
-          name,
-          leaseholder: 1,
-          rate: Rate.hz(1),
-          dataType: DataType.FLOAT32,
-        },
-        {retrieveIfNameExists: true}
+        const channelTwo = await client.channels.create(
+          {
+            name,
+            leaseholder: 1,
+            rate: Rate.hz(1),
+            dataType: DataType.FLOAT32,
+          },
+          { retrieveIfNameExists: true },
         );
         expect(channelTwo.key).toEqual(channel.key);
       });
       it("should create a new channel when it does not exist", async () => {
-        const name = `test-${Math.random()}-${TimeStamp.now().valueOf()}`
+        const name = `test-${Math.random()}-${TimeStamp.now().valueOf()}`;
         const channel = await client.channels.create({
           name,
           leaseholder: 1,
           rate: Rate.hz(1),
           dataType: DataType.FLOAT32,
         });
-        const channelTwo = await client.channels.create({
-          name: `${name}-2`,
-          leaseholder: 1,
-          rate: Rate.hz(1),
-          dataType: DataType.FLOAT32,
-        },
-        {retrieveIfNameExists: true}
+        const channelTwo = await client.channels.create(
+          {
+            name: `${name}-2`,
+            leaseholder: 1,
+            rate: Rate.hz(1),
+            dataType: DataType.FLOAT32,
+          },
+          { retrieveIfNameExists: true },
         );
         expect(channelTwo.key).not.toEqual(channel.key);
       });
       it("should retrieve and create the correct channels when creating many", async () => {
-        const name = `test-${Math.random()}-${TimeStamp.now().valueOf()}`
+        const name = `test-${Math.random()}-${TimeStamp.now().valueOf()}`;
         const channel = await client.channels.create({
           name,
           leaseholder: 1,
           rate: Rate.hz(1),
           dataType: DataType.FLOAT32,
         });
-        const channelTwo = await client.channels.create([
-          {
-            name,
-            leaseholder: 1,
-            rate: Rate.hz(1),
-            dataType: DataType.FLOAT32,
-          },
-          {
-            name: `${name}-2`,
-            leaseholder: 1,
-            rate: Rate.hz(1),
-            dataType: DataType.FLOAT32,
-          },
-        ],
-        {retrieveIfNameExists: true}
+        const channelTwo = await client.channels.create(
+          [
+            {
+              name,
+              leaseholder: 1,
+              rate: Rate.hz(1),
+              dataType: DataType.FLOAT32,
+            },
+            {
+              name: `${name}-2`,
+              leaseholder: 1,
+              rate: Rate.hz(1),
+              dataType: DataType.FLOAT32,
+            },
+          ],
+          { retrieveIfNameExists: true },
         );
         expect(channelTwo.length).toEqual(2);
         expect(channelTwo[0].key).toEqual(channel.key);
         expect(channelTwo[1].key).not.toEqual(channel.key);
       });
-    })
+    });
   });
   test("retrieve by key", async () => {
     const channel = await client.channels.create({

package/src/framer/adapter.spec.ts

@@ -41,7 +41,7 @@ describe("WriteFrameAdapter", () => {
     expect(res.series).toHaveLength(2);
     expect(res.get(timeCh.key)).toHaveLength(1);
     expect(res.get(dataCh.key)).toHaveLength(1);
-    expect(res.get(timeCh.key).at(0)).toEqual(Number(ts));
+    expect(res.get(timeCh.key).at(0)).toEqual(ts);
     expect(res.get(dataCh.key).at(0)).toEqual(1);
   });
 
@@ -55,7 +55,7 @@ describe("WriteFrameAdapter", () => {
     expect(res2.series).toHaveLength(2);
     expect(res2.get(timeCh.key)).toHaveLength(1);
     expect(res2.get(dataCh.key)).toHaveLength(1);
-    expect(res2.get(timeCh.key).at(0)).toEqual(Number(ts));
+    expect(res2.get(timeCh.key).at(0)).toEqual(ts);
     expect(res2.get(dataCh.key).at(0)).toEqual(1);
   });
 
@@ -75,7 +75,7 @@ describe("WriteFrameAdapter", () => {
     );
     expect(res4.get(timeCh.key)).toHaveLength(1);
     expect(res4.get(dataCh.key)).toHaveLength(1);
-    expect(res4.get(timeCh.key).at(0)).toEqual(Number(ts));
+    expect(res4.get(timeCh.key).at(0)).toEqual(ts);
     expect(res4.get(dataCh.key).at(0)).toEqual(1);
   });
 
@@ -88,7 +88,7 @@ describe("WriteFrameAdapter", () => {
     const res = await adapter.adapt(fr);
     expect(res.columns).toHaveLength(2);
     expect(res.series).toHaveLength(2);
-    expect(res.get(timeCh.key).at(0)).toEqual(Number(ts));
+    expect(res.get(timeCh.key).at(0)).toEqual(ts);
     expect(res.get(dataCh.key).at(0)).toEqual(1);
   });
 
@@ -101,7 +101,7 @@ describe("WriteFrameAdapter", () => {
     const res = await adapter.adapt(fr);
     expect(res.columns).toHaveLength(2);
     expect(res.series).toHaveLength(2);
-    expect(res.get(timeCh.key).at(0)).toEqual(Number(ts));
+    expect(res.get(timeCh.key).at(0)).toEqual(ts);
     expect(res.get(dataCh.key).at(0)).toEqual(1);
   });
 
@@ -113,6 +113,6 @@ describe("WriteFrameAdapter", () => {
     expect(res.columns).toHaveLength(1);
     expect(res.series).toHaveLength(1);
     expect(res.get(timeCh.key)).toHaveLength(1);
-    expect(res.get(timeCh.key).at(0)).toEqual(Number(ts));
+    expect(res.get(timeCh.key).at(0)).toEqual(ts);
   });
 });