@synnaxlabs/client 0.17.2 → 0.17.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/.turbo/turbo-build.log +5 -5
  2. package/README.md +1 -1
  3. package/dist/channel/client.d.ts +3 -3
  4. package/dist/channel/retriever.d.ts +1 -0
  5. package/dist/client.cjs +26 -10
  6. package/dist/client.cjs.map +1 -1
  7. package/dist/client.js +4225 -4103
  8. package/dist/client.js.map +1 -1
  9. package/dist/framer/adapter.d.ts +10 -8
  10. package/dist/framer/adapter.spec.d.ts +1 -0
  11. package/dist/framer/client.d.ts +2 -2
  12. package/dist/framer/frame.d.ts +1 -1
  13. package/dist/framer/writer.d.ts +4 -3
  14. package/dist/index.d.ts +1 -1
  15. package/dist/util/telem.d.ts +2 -2
  16. package/examples/node/liveStream.js +41 -0
  17. package/examples/node/package-lock.json +4 -4
  18. package/examples/node/package.json +1 -1
  19. package/examples/node/streamWrite.js +0 -1
  20. package/package.json +4 -3
  21. package/src/channel/client.ts +7 -4
  22. package/src/channel/retriever.ts +35 -8
  23. package/src/framer/adapter.spec.ts +118 -0
  24. package/src/framer/adapter.ts +104 -45
  25. package/src/framer/client.ts +2 -6
  26. package/src/framer/frame.ts +12 -4
  27. package/src/framer/iterator.ts +4 -4
  28. package/src/framer/streamer.ts +4 -4
  29. package/src/framer/writer.spec.ts +1 -1
  30. package/src/framer/writer.ts +19 -16
  31. package/src/index.ts +1 -1
  32. package/src/util/telem.ts +2 -2
package/.turbo/turbo-build.log CHANGED
@@ -1,5 +1,5 @@
1
1
 
2
- > @synnaxlabs/client@0.17.2 build /home/runner/work/synnax/synnax/client/ts
2
+ > @synnaxlabs/client@0.17.4 build /home/runner/work/synnax/synnax/client/ts
3
3
  > tsc --noEmit && vite build
4
4
 
5
5
  vite v5.1.2 building for production...
@@ -9,8 +9,8 @@ rendering chunks...
9
9
  
10
10
  [vite:dts] Start generate declaration files...
11
11
  computing gzip size...
12
- dist/client.js 531.80 kB │ gzip: 116.94 kB │ map: 1,195.62 kB
13
- [vite:dts] Declaration files built in 3744ms.
12
+ dist/client.js 536.81 kB │ gzip: 118.15 kB │ map: 1,205.72 kB
13
+ [vite:dts] Declaration files built in 3718ms.
14
14
  
15
- dist/client.cjs 350.76 kB │ gzip: 92.53 kB │ map: 1,140.70 kB
16
- ✓ built in 5.29s
15
+ dist/client.cjs 354.56 kB │ gzip: 93.44 kB │ map: 1,150.60 kB
16
+ ✓ built in 5.24s
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  A client library for interacting with a Synnax cluster. It supports Typescript and can be used in both node and browser environments.
4
4
 
5
- Detailed documentation is available [here](https://docs.synnaxlabs.com/typescript-client/get-started]).
5
+ Detailed documentation is available [here](https://docs.synnaxlabs.com/typescript-client/get-started).
6
6
 
7
7
  ## Installation
8
8
 
package/dist/channel/client.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { type UnaryClient } from "@synnaxlabs/freighter";
2
- import { DataType, Rate, type NativeTypedArray, type CrudeDensity, type Series, type TimeRange, type AsyncTermSearcher, type CrudeTimeStamp } from "@synnaxlabs/x";
2
+ import { DataType, Rate, type TypedArray, type CrudeDensity, type Series, type TimeRange, type AsyncTermSearcher, type CrudeTimeStamp } from "@synnaxlabs/x";
3
3
  import { type Creator } from './creator';
4
4
  import { type Key, type KeyOrName, type Params, type Payload, type NewPayload } from './payload';
5
5
  import { type Retriever } from './retriever';
@@ -81,7 +81,7 @@ export declare class Channel {
81
81
  * @param start - The starting timestamp of the first sample in data.
82
82
  * @param data - THe telemetry to write to the channel.
83
83
  */
84
- write(start: CrudeTimeStamp, data: NativeTypedArray): Promise<void>;
84
+ write(start: CrudeTimeStamp, data: TypedArray): Promise<void>;
85
85
  }
86
86
  /**
87
87
  * The core client class for executing channel operations against a Synnax
@@ -90,7 +90,7 @@ export declare class Channel {
90
90
  */
91
91
  export declare class Client implements AsyncTermSearcher<string, Key, Channel> {
92
92
  private readonly frameClient;
93
- private readonly retriever;
93
+ readonly retriever: Retriever;
94
94
  private readonly creator;
95
95
  private readonly client;
96
96
  constructor(frameClient: framer.Client, retriever: Retriever, client: UnaryClient, creator: Creator);
package/dist/channel/retriever.d.ts CHANGED
@@ -62,3 +62,4 @@ export declare class DebouncedBatchRetriever implements Retriever {
62
62
  retrieve(channels: Params): Promise<Payload[]>;
63
63
  run(): Promise<void>;
64
64
  }
65
+ export declare const retrieveRequired: (r: Retriever, params: Params) => Promise<Payload[]>;