@synnaxlabs/client 0.17.1 → 0.17.3

package/examples/node/liveStream.js

@@ -0,0 +1,41 @@
+import { Synnax, TimeStamp } from "@synnaxlabs/client";
+
+// This example demonstrates how to stream live data from a channel in Synnax.
+// Live-streaming is useful for real-time data processing and analysis, and is an
+// integral part of Synnax's control sequence and data streaming capabilities.
+
+// This example is meant to be used in conjunction with the stream_write.py example, and
+// assumes that example is running in a separate terminal.
+
+// Connect to a locally running, insecure Synnax cluster. If your connection parameters
+// are different, enter them here.
+const client = new Synnax({
+    host: "localhost",
+    port: 9090,
+    username: "synnax",
+    password: "seldon",
+    secure: false
+});
+
+// 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"]
+
+const streamer = await client.telem.newStreamer(read_from);
+
+// 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 
+    // frame is available, and then we'll just print it out.
+    for await (const frame of streamer) 
+        console.log({
+            time: new TimeStamp(frame.get("stream_write_example_time")[0].at(0)).toString(),
+            data: frame.get("stream_write_example_data")[0].at(0)
+        })
+} finally {
+    streamer.close();
+    // Close the client when we're done with it.
+    client.close();
+}
+

package/examples/node/package-lock.json

@@ -9,7 +9,7 @@
       "version": "1.0.0",
       "license": "ISC",
       "dependencies": {
-        "@synnaxlabs/client": "^0.17.0"
+        "@synnaxlabs/client": "^0.17.2"
       }
     },
     "node_modules/@grpc/grpc-js": {
@@ -3653,9 +3653,9 @@
       }
     },
     "node_modules/@synnaxlabs/client": {
-      "version": "0.17.0",
-      "resolved": "https://registry.npmjs.org/@synnaxlabs/client/-/client-0.17.0.tgz",
-      "integrity": "sha512-ydQpLQ0MUpkvJ/TqHidWNSRSdz6DoSctSbaCu/+TuDy74bIamDWBMQu5fmsTcA5NeQzzmFZgiOMRaFOa9fG1gg==",
+      "version": "0.17.2",
+      "resolved": "https://registry.npmjs.org/@synnaxlabs/client/-/client-0.17.2.tgz",
+      "integrity": "sha512-9r8C7KbWBHluBRnu8qw34hf+u8JW1CkM6VmAT+51N+m0z2AZA0pbK01MNNIjLQAZ1bAdKpzc57BxqSzCwIceGQ==",
       "dependencies": {
         "@synnaxlabs/freighter": "0.9.1",
         "@synnaxlabs/x": "0.14.1",

package/examples/node/package.json

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

package/examples/node/streamWrite.js

@@ -3,7 +3,7 @@
 // applications (such as data acquisition from a sensor) or for very large datasets that
 // cannot be written all at once.
 
-import { Synnax } from "@synnaxlabs/client";
+import { Rate, Series, Synnax, TimeStamp, framer } from "@synnaxlabs/client";
 
 // Connect to a locally running, insecure Synnax cluster. If your connection parameters
 // are different, enter them here.
@@ -20,4 +20,59 @@ const timeChannel = await client.channels.create({
     name: "stream_write_example_time",
     isIndex: true,
     dataType: "timestamp"
-});
+}, { retrieveIfNameExists: true });
+
+// Create a data channel that will be used to store our fake sensor data.
+const dataChannel = await client.channels.create({
+    name: "stream_write_example_data",
+    dataType: "float32",
+    index: timeChannel.key,
+}, { retrieveIfNameExists: true });
+
+
+// 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 
+// amount of time, but it's close enough for demonstration purposes.
+const roughRate = Rate.hz(40);
+
+// 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.telem.newWriter({
+    start, 
+    channels: [timeChannel.key, dataChannel.key]
+});
+
+try {
+    let i = 0;
+    while (true) {
+        await new Promise(resolve => setTimeout(resolve, roughRate.period.milliseconds));
+        i++;
+        const timestamp = TimeStamp.now();
+        const data = Math.sin(i / 10);
+        const fr = new framer.Frame({
+            [timeChannel.key]: new Series({ data: new timeChannel.dataType.Array([timestamp]) }),
+            [dataChannel.key]: new Series({ data: new dataChannel.dataType.Array([data]) })
+        });
+        await writer.write(fr);
+
+        if (i % 60 == 0) 
+            console.log(`Writing sample ${i} at ${timestamp.toISOString()}`)
+
+        if (i % commitInterval == 0) {
+            // 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 (!await writer.commit()) {
+                console.error("Failed to commit data");
+                break;
+            };
+        }
+    }
+} finally {
+    await writer.close();
+}
+

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@synnaxlabs/client",
   "private": false,
-  "version": "0.17.1",
+  "version": "0.17.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/x": "0.14.1",
-    "@synnaxlabs/freighter": "0.9.1"
+    "@synnaxlabs/freighter": "0.9.1",
+    "@synnaxlabs/x": "0.14.1"
   },
   "devDependencies": {
     "@types/node": "^20.10.5",
@@ -27,8 +27,8 @@
     "typescript": "^5.3.3",
     "vite": "^5.1.2",
     "vitest": "^1.2.2",
-    "@synnaxlabs/vite-plugin": "0.0.1",
     "@synnaxlabs/tsconfig": "0.0.2",
+    "@synnaxlabs/vite-plugin": "0.0.1",
     "eslint-config-synnaxlabs": "0.0.1"
   },
   "main": "dist/client.cjs",

package/src/framer/frame.ts

@@ -110,7 +110,11 @@ export class Frame {
         validateMatchedColsAndArrays(data_.keys, arrays);
         data_.keys.forEach((key, i) => this.push(key, arrays[i]));
       } else
-        Object.entries(columnsOrData).forEach(([k, v]) => this.push(k, ...toArray(v)));
+        Object.entries(columnsOrData).forEach(([k, v]) => {
+          const key = parseInt(k);
+          if (!isNaN(key)) return this.push(key, ...toArray(v));
+          else this.push(k, ...toArray(v))
+        });
       return;
     }