@synnaxlabs/client 0.17.2 → 0.17.3

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @synnaxlabs/client@0.17.2 build /home/runner/work/synnax/synnax/client/ts
+> @synnaxlabs/client@0.17.3 build /home/runner/work/synnax/synnax/client/ts
 > tsc --noEmit && vite build
 
 vite v5.1.2 building for production...
@@ -10,7 +10,7 @@ rendering chunks...
 [vite:dts] Start generate declaration files...
 computing gzip size...
 dist/client.js  531.80 kB │ gzip: 116.94 kB │ map: 1,195.62 kB
-[vite:dts] Declaration files built in 3744ms.
+[vite:dts] Declaration files built in 3656ms.
 
 dist/client.cjs  350.76 kB │ gzip: 92.53 kB │ map: 1,140.70 kB
-✓ built in 5.29s
+✓ built in 5.18s

package/README.md

@@ -2,7 +2,7 @@
 
 A client library for interacting with a Synnax cluster. It supports Typescript and can be used in both node and browser environments.
 
-Detailed documentation is available [here](https://docs.synnaxlabs.com/typescript-client/get-started]).
+Detailed documentation is available [here](https://docs.synnaxlabs.com/typescript-client/get-started).
 
 ## Installation
 

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.1"
+        "@synnaxlabs/client": "^0.17.2"
       }
     },
     "node_modules/@grpc/grpc-js": {
@@ -3653,9 +3653,9 @@
       }
     },
     "node_modules/@synnaxlabs/client": {
-      "version": "0.17.1",
-      "resolved": "https://registry.npmjs.org/@synnaxlabs/client/-/client-0.17.1.tgz",
-      "integrity": "sha512-8LONAhvloau3ErXMMieLeyDXqA8fPmW1tloE+VRVjUVwHI+K5lnortnN9uddWzZ+re1cgnVEoIpgw/y88hOdpw==",
+      "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.1"
+    "@synnaxlabs/client": "^0.17.2"
   }
 }

package/examples/node/streamWrite.js

@@ -58,7 +58,6 @@ try {
             [timeChannel.key]: new Series({ data: new timeChannel.dataType.Array([timestamp]) }),
             [dataChannel.key]: new Series({ data: new dataChannel.dataType.Array([data]) })
         });
-        console.log(fr.columns);
         await writer.write(fr);
 
         if (i % 60 == 0) 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@synnaxlabs/client",
   "private": false,
-  "version": "0.17.2",
+  "version": "0.17.3",
   "type": "module",
   "description": "The Client Library for Synnax",
   "repository": "https://github.com/synnaxlabs/synnax/tree/main/client/ts",