@synnaxlabs/client 0.18.0 → 0.18.1

package/examples/node/liveStream.js

@@ -24,15 +24,16 @@ const read_from = [
     "stream_write_example_data_2"
 ]
 
-const streamer = await client.telem.newStreamer(read_from);
+const streamer = await client.telem.openStreamer(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(frame.latest());
+    // 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));
 } finally {
     streamer.close();
     // Close the client when we're done with it.

package/examples/node/package-lock.json

@@ -9,7 +9,7 @@
       "version": "1.0.0",
       "license": "ISC",
       "dependencies": {
-        "@synnaxlabs/client": "^0.17.5"
+        "@synnaxlabs/client": "^0.18.0"
       }
     },
     "node_modules/@grpc/grpc-js": {
@@ -3653,23 +3653,23 @@
       }
     },
     "node_modules/@synnaxlabs/client": {
-      "version": "0.17.5",
-      "resolved": "https://registry.npmjs.org/@synnaxlabs/client/-/client-0.17.5.tgz",
-      "integrity": "sha512-HyQ/lzX4lekh5pg84A59tNjMHAYact3uvV+DUUJma+C3w4fgl4hT0U1DZ3IABiI02pNJEaiahMszg+2E9g358A==",
+      "version": "0.18.0",
+      "resolved": "https://registry.npmjs.org/@synnaxlabs/client/-/client-0.18.0.tgz",
+      "integrity": "sha512-o53rR0awYUCcdSCENzo+6VjsEEt30ExHG0B1FLOk3+865eIJkvazS4RrRYpitrIxuzAGIK12v0vZ/qj8sGzlfA==",
       "dependencies": {
-        "@synnaxlabs/freighter": "0.9.2",
-        "@synnaxlabs/x": "0.14.2",
+        "@synnaxlabs/freighter": "0.9.3",
+        "@synnaxlabs/x": "0.15.0",
         "async-mutex": "^0.4.0",
         "zod": "3.22.4"
       }
     },
     "node_modules/@synnaxlabs/freighter": {
-      "version": "0.9.2",
-      "resolved": "https://registry.npmjs.org/@synnaxlabs/freighter/-/freighter-0.9.2.tgz",
-      "integrity": "sha512-GJ63tGtSKlqiDLI+82keEIKwKmCsMI7y5ibI1DGKS/cXgeYJFUmG4BjJFM4HfVQxt56o94UP+qP4acZcLDZwGg==",
+      "version": "0.9.3",
+      "resolved": "https://registry.npmjs.org/@synnaxlabs/freighter/-/freighter-0.9.3.tgz",
+      "integrity": "sha512-H8a4HePVykwlkQMw8yClJ/BpydMDieBD2HHC2bBcvfJKZ3w32uiAqvhqezy14aU2XgNG92hU65IBi2FT6esBng==",
       "dependencies": {
         "@synnaxlabs/alamos": "0.3.0",
-        "@synnaxlabs/x": "0.14.2",
+        "@synnaxlabs/x": "0.15.0",
         "js-convert-case": "^4.2.0",
         "node-fetch": "2.6.11",
         "ws": "^8.15.1",
@@ -3680,9 +3680,9 @@
       }
     },
     "node_modules/@synnaxlabs/x": {
-      "version": "0.14.2",
-      "resolved": "https://registry.npmjs.org/@synnaxlabs/x/-/x-0.14.2.tgz",
-      "integrity": "sha512-Js5czEi7oMhaQkDe3xGuGLbho7xBMoNIWJmrXI20lu+VbB/FyO1wVtfcdIIIZOLc3tUAdNw9ceuZXMOieRoH1g==",
+      "version": "0.15.0",
+      "resolved": "https://registry.npmjs.org/@synnaxlabs/x/-/x-0.15.0.tgz",
+      "integrity": "sha512-baowvPsc0oKeMscKHh/5u0WVRB7J3ylIYzkx8feyP67QkjE8PCQpf0gmdThMGg6r0HwUbubzTcD0N64TNvahWw==",
       "dependencies": {
         "async-mutex": "^0.4.0",
         "js-convert-case": "^4.2.0",
@@ -3886,9 +3886,9 @@
       }
     },
     "node_modules/@types/node": {
-      "version": "20.12.3",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.12.3.tgz",
-      "integrity": "sha512-sD+ia2ubTeWrOu+YMF+MTAB7E+O7qsMqAbMfW7DG3K1URwhZ5hN1pLlRVGbf4wDFzSfikL05M17EyorS86jShw==",
+      "version": "20.12.4",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.12.4.tgz",
+      "integrity": "sha512-E+Fa9z3wSQpzgYQdYmme5X3OTuejnnTx88A6p6vkkJosR3KBz+HpE3kqNm98VE6cfLFcISx7zW7MsJkH6KwbTw==",
       "dependencies": {
         "undici-types": "~5.26.4"
       }

package/examples/node/package.json

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

package/examples/node/seriesAndFrames.js

@@ -0,0 +1,37 @@
+import { Series } from "@synnaxlabs/client";
+
+// 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]);
+
+// Construct a series from an array of numbers, but this time we specify the type
+// explicitly.
+series = new Series({ data: [1, 2, 3, 4, 5], dataType: "float32" });
+
+// Construct a series from an array of strings. In this case, the series will
+// automatically be of type string.
+series = new Series(["apple", "banana", "cherry"]);
+
+// Construct a series from a Float32Array. This is the most efficient way to
+// construct a series from a large amount of data.
+series = new Series(new Float32Array([1, 2, 3, 4, 5]));
+
+// Construct a series from a JSON object. This is useful when you have a series
+// that has been serialized to JSON.
+series = new Series([{ red: "cherry" }, { yellow: "banana" }, {orange: "orange" }]);
+
+series = new Series([1, "a", 3, "b", 5]);
+
+series = new Series([1, 2, 3, 4, 5]);
+
+console.log(series.at(0)); // 1
+console.log(series.at(-1)); // 5
+
+series = new Series([1, 2, 3, 4, 5]);
+// Is it a number? Is it a string? Who knows?
+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);

package/examples/node/streamWrite.js

@@ -48,7 +48,7 @@ const roughRate = Rate.hz(40);
 // historical reads every 500 samples.
 const commitInterval = 500;
 
-const writer = await client.telem.newWriter({
+const writer = await client.telem.openWriter({
     start, 
     channels: [timeChannel.key, dataChannel1.key, dataChannel2.key]
 });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@synnaxlabs/client",
   "private": false,
-  "version": "0.18.0",
+  "version": "0.18.1",
   "type": "module",
   "description": "The Client Library for Synnax",
   "repository": "https://github.com/synnaxlabs/synnax/tree/main/client/ts",
@@ -19,7 +19,7 @@
     "async-mutex": "^0.4.0",
     "zod": "3.22.4",
     "@synnaxlabs/freighter": "0.9.3",
-    "@synnaxlabs/x": "0.15.0"
+    "@synnaxlabs/x": "0.15.1"
   },
   "devDependencies": {
     "@types/node": "^20.10.5",