@synnaxlabs/client 0.42.1 → 0.43.0
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.
- package/.turbo/turbo-build.log +7 -7
- package/.vscode/settings.json +2 -2
- package/CONTRIBUTING.md +6 -5
- package/README.md +7 -8
- package/dist/access/payload.d.ts +1 -1
- package/dist/access/payload.d.ts.map +1 -1
- package/dist/access/policy/payload.d.ts +9 -9
- package/dist/access/policy/payload.d.ts.map +1 -1
- package/dist/access/policy/retriever.d.ts +3 -3
- package/dist/access/policy/retriever.d.ts.map +1 -1
- package/dist/auth/auth.d.ts +2 -2
- package/dist/auth/auth.d.ts.map +1 -1
- package/dist/channel/client.d.ts +1 -0
- package/dist/channel/client.d.ts.map +1 -1
- package/dist/channel/payload.d.ts +21 -8
- package/dist/channel/payload.d.ts.map +1 -1
- package/dist/channel/retriever.d.ts +5 -5
- package/dist/channel/retriever.d.ts.map +1 -1
- package/dist/channel/writer.d.ts +3 -3
- package/dist/channel/writer.d.ts.map +1 -1
- package/dist/client.cjs +135 -39
- package/dist/client.d.ts +8 -8
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +28502 -9339
- package/dist/connection/checker.d.ts +5 -5
- package/dist/connection/checker.d.ts.map +1 -1
- package/dist/control/state.d.ts +46 -3
- package/dist/control/state.d.ts.map +1 -1
- package/dist/framer/adapter.d.ts +2 -2
- package/dist/framer/adapter.d.ts.map +1 -1
- package/dist/framer/client.d.ts +2 -0
- package/dist/framer/client.d.ts.map +1 -1
- package/dist/framer/codec.d.ts +3 -3
- package/dist/framer/codec.d.ts.map +1 -1
- package/dist/framer/deleter.d.ts +8 -8
- package/dist/framer/deleter.d.ts.map +1 -1
- package/dist/framer/frame.d.ts +17 -17
- package/dist/framer/frame.d.ts.map +1 -1
- package/dist/framer/streamProxy.d.ts +3 -3
- package/dist/framer/streamProxy.d.ts.map +1 -1
- package/dist/framer/streamer.d.ts +103 -22
- package/dist/framer/streamer.d.ts.map +1 -1
- package/dist/framer/writer.d.ts +25 -25
- package/dist/framer/writer.d.ts.map +1 -1
- package/dist/hardware/device/client.d.ts +3 -3
- package/dist/hardware/device/client.d.ts.map +1 -1
- package/dist/hardware/device/payload.d.ts +65 -18
- package/dist/hardware/device/payload.d.ts.map +1 -1
- package/dist/hardware/rack/client.d.ts.map +1 -1
- package/dist/hardware/rack/payload.d.ts +87 -30
- package/dist/hardware/rack/payload.d.ts.map +1 -1
- package/dist/hardware/task/client.d.ts +3 -3
- package/dist/hardware/task/client.d.ts.map +1 -1
- package/dist/hardware/task/payload.d.ts +14 -15
- package/dist/hardware/task/payload.d.ts.map +1 -1
- package/dist/label/payload.d.ts +2 -2
- package/dist/label/payload.d.ts.map +1 -1
- package/dist/label/writer.d.ts +4 -4
- package/dist/label/writer.d.ts.map +1 -1
- package/dist/ontology/client.d.ts +3 -3
- package/dist/ontology/client.d.ts.map +1 -1
- package/dist/ontology/group/payload.d.ts +2 -2
- package/dist/ontology/group/payload.d.ts.map +1 -1
- package/dist/ontology/payload.d.ts +25 -25
- package/dist/ontology/payload.d.ts.map +1 -1
- package/dist/ranger/client.d.ts +8 -8
- package/dist/ranger/client.d.ts.map +1 -1
- package/dist/ranger/kv.d.ts +6 -6
- package/dist/ranger/kv.d.ts.map +1 -1
- package/dist/ranger/payload.d.ts +15 -15
- package/dist/ranger/payload.d.ts.map +1 -1
- package/dist/ranger/writer.d.ts +10 -10
- package/dist/ranger/writer.d.ts.map +1 -1
- package/dist/testutil/{indexedPair.d.ts → channels.d.ts} +1 -1
- package/dist/testutil/channels.d.ts.map +1 -0
- package/dist/user/payload.d.ts +3 -3
- package/dist/user/payload.d.ts.map +1 -1
- package/dist/user/retriever.d.ts +2 -2
- package/dist/user/retriever.d.ts.map +1 -1
- package/dist/util/retrieve.d.ts +6 -6
- package/dist/util/retrieve.d.ts.map +1 -1
- package/dist/util/zod.d.ts +2 -2
- package/dist/util/zod.d.ts.map +1 -1
- package/dist/workspace/client.d.ts.map +1 -1
- package/dist/workspace/lineplot/client.d.ts.map +1 -1
- package/dist/workspace/lineplot/lineplot.spec.d.ts +2 -0
- package/dist/workspace/lineplot/lineplot.spec.d.ts.map +1 -0
- package/dist/workspace/lineplot/payload.d.ts +5 -5
- package/dist/workspace/lineplot/payload.d.ts.map +1 -1
- package/dist/workspace/log/client.d.ts.map +1 -1
- package/dist/workspace/log/payload.d.ts +5 -5
- package/dist/workspace/log/payload.d.ts.map +1 -1
- package/dist/workspace/payload.d.ts +6 -6
- package/dist/workspace/payload.d.ts.map +1 -1
- package/dist/workspace/schematic/client.d.ts.map +1 -1
- package/dist/workspace/schematic/payload.d.ts +7 -7
- package/dist/workspace/schematic/payload.d.ts.map +1 -1
- package/dist/workspace/table/client.d.ts.map +1 -1
- package/dist/workspace/table/payload.d.ts +6 -6
- package/dist/workspace/table/payload.d.ts.map +1 -1
- package/package.json +12 -13
- package/src/access/payload.ts +1 -1
- package/src/access/policy/client.ts +3 -3
- package/src/access/policy/payload.ts +1 -1
- package/src/access/policy/retriever.ts +1 -1
- package/src/access/policy/writer.ts +7 -7
- package/src/auth/auth.ts +1 -1
- package/src/channel/client.ts +6 -4
- package/src/channel/payload.ts +10 -18
- package/src/channel/retriever.ts +2 -2
- package/src/channel/writer.ts +11 -2
- package/src/client.ts +3 -3
- package/src/connection/checker.ts +1 -1
- package/src/connection/connection.spec.ts +1 -1
- package/src/control/client.ts +1 -1
- package/src/control/state.ts +4 -5
- package/src/errors.spec.ts +2 -3
- package/src/errors.ts +2 -2
- package/src/framer/adapter.ts +2 -2
- package/src/framer/client.ts +4 -3
- package/src/framer/codec.spec.ts +2 -2
- package/src/framer/codec.ts +5 -9
- package/src/framer/deleter.spec.ts +1 -1
- package/src/framer/deleter.ts +1 -1
- package/src/framer/frame.ts +15 -15
- package/src/framer/iterator.spec.ts +1 -1
- package/src/framer/iterator.ts +1 -1
- package/src/framer/streamProxy.ts +4 -4
- package/src/framer/streamer.spec.ts +420 -215
- package/src/framer/streamer.ts +119 -21
- package/src/framer/writer.spec.ts +1 -1
- package/src/framer/writer.ts +15 -8
- package/src/hardware/device/client.ts +5 -5
- package/src/hardware/device/device.spec.ts +28 -30
- package/src/hardware/device/payload.ts +5 -5
- package/src/hardware/rack/client.ts +4 -4
- package/src/hardware/rack/payload.ts +6 -6
- package/src/hardware/rack/rack.spec.ts +1 -1
- package/src/hardware/task/client.ts +21 -19
- package/src/hardware/task/payload.ts +8 -6
- package/src/label/payload.ts +1 -1
- package/src/label/retriever.ts +3 -3
- package/src/label/writer.ts +4 -4
- package/src/ontology/client.ts +4 -4
- package/src/ontology/group/payload.ts +3 -3
- package/src/ontology/group/writer.ts +1 -1
- package/src/ontology/payload.ts +2 -2
- package/src/ontology/writer.ts +1 -1
- package/src/ranger/alias.ts +1 -1
- package/src/ranger/client.ts +6 -4
- package/src/ranger/kv.ts +4 -4
- package/src/ranger/payload.ts +3 -3
- package/src/ranger/writer.ts +1 -1
- package/src/user/client.ts +3 -3
- package/src/user/payload.ts +1 -1
- package/src/user/retriever.ts +1 -1
- package/src/user/writer.ts +4 -4
- package/src/util/retrieve.spec.ts +7 -4
- package/src/util/retrieve.ts +10 -10
- package/src/util/zod.ts +3 -3
- package/src/workspace/client.ts +5 -5
- package/src/workspace/lineplot/client.ts +5 -5
- package/src/workspace/lineplot/{linePlot.spec.ts → lineplot.spec.ts} +2 -2
- package/src/workspace/lineplot/payload.ts +1 -1
- package/src/workspace/log/client.ts +5 -5
- package/src/workspace/log/log.spec.ts +2 -2
- package/src/workspace/log/payload.ts +1 -1
- package/src/workspace/payload.ts +1 -1
- package/src/workspace/schematic/client.ts +5 -5
- package/src/workspace/schematic/payload.ts +1 -1
- package/src/workspace/schematic/schematic.spec.ts +3 -3
- package/src/workspace/table/client.ts +5 -5
- package/src/workspace/table/payload.ts +1 -1
- package/src/workspace/table/table.spec.ts +2 -2
- package/src/workspace/workspace.spec.ts +2 -2
- package/tsconfig.json +3 -5
- package/dist/testutil/indexedPair.d.ts.map +0 -1
- package/dist/workspace/lineplot/linePlot.spec.d.ts +0 -2
- package/dist/workspace/lineplot/linePlot.spec.d.ts.map +0 -1
- /package/src/testutil/{indexedPair.ts → channels.ts} +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { UnaryClient } from '@synnaxlabs/freighter';
|
|
2
2
|
import { TimeSpan } from '@synnaxlabs/x/telem';
|
|
3
|
-
import { z } from 'zod';
|
|
3
|
+
import { z } from 'zod/v4';
|
|
4
4
|
export declare const statusZ: z.ZodEnum<{
|
|
5
5
|
disconnected: "disconnected";
|
|
6
6
|
connecting: "connecting";
|
|
@@ -15,13 +15,13 @@ export declare const stateZ: z.ZodObject<{
|
|
|
15
15
|
connected: "connected";
|
|
16
16
|
failed: "failed";
|
|
17
17
|
}>;
|
|
18
|
-
error: z.ZodOptional<z.ZodCustom<Error,
|
|
18
|
+
error: z.ZodOptional<z.ZodCustom<Error, Error>>;
|
|
19
19
|
message: z.ZodOptional<z.ZodString>;
|
|
20
20
|
clusterKey: z.ZodString;
|
|
21
21
|
clientVersion: z.ZodString;
|
|
22
22
|
clientServerCompatible: z.ZodBoolean;
|
|
23
23
|
nodeVersion: z.ZodOptional<z.ZodString>;
|
|
24
|
-
},
|
|
24
|
+
}, z.core.$strip>;
|
|
25
25
|
export interface State extends z.infer<typeof stateZ> {
|
|
26
26
|
}
|
|
27
27
|
/** Polls a synnax cluster for connectivity information. */
|
|
@@ -42,13 +42,13 @@ export declare class Checker {
|
|
|
42
42
|
connected: "connected";
|
|
43
43
|
failed: "failed";
|
|
44
44
|
}>;
|
|
45
|
-
error: z.ZodOptional<z.ZodCustom<Error,
|
|
45
|
+
error: z.ZodOptional<z.ZodCustom<Error, Error>>;
|
|
46
46
|
message: z.ZodOptional<z.ZodString>;
|
|
47
47
|
clusterKey: z.ZodString;
|
|
48
48
|
clientVersion: z.ZodString;
|
|
49
49
|
clientServerCompatible: z.ZodBoolean;
|
|
50
50
|
nodeVersion: z.ZodOptional<z.ZodString>;
|
|
51
|
-
},
|
|
51
|
+
}, z.core.$strip>;
|
|
52
52
|
private versionWarned;
|
|
53
53
|
/**
|
|
54
54
|
* @param client - The transport client to use for connectivity checks.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"checker.d.ts","sourceRoot":"","sources":["../../src/connection/checker.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,CAAC,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"checker.d.ts","sourceRoot":"","sources":["../../src/connection/checker.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAE3B,eAAO,MAAM,OAAO;;;;;EAAgE,CAAC;AACrF,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC,CAAC;AAE7C,eAAO,MAAM,MAAM;;;;;;;;;;;;;iBAQjB,CAAC;AACH,MAAM,WAAW,KAAM,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC;CAAG;AA2BxD,2DAA2D;AAC3D,qBAAa,OAAO;IAClB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAyB;IACzD,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAW;IACzC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAC/B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAwB;IACtD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IACrC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,CAAiB;IAClC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IACvC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAqC;IACtE,MAAM,CAAC,QAAQ,CAAC,gBAAgB;;;;;;;;;;;;;sBAAU;IAC1C,OAAO,CAAC,aAAa,CAAS;IAE9B;;;;OAIG;gBAED,MAAM,EAAE,WAAW,EACnB,QAAQ,EAAE,QAAQ,YAAuB,EACzC,aAAa,EAAE,MAAM,EACrB,IAAI,CAAC,EAAE,MAAM;IAWf,8EAA8E;IAC9E,YAAY,IAAI,IAAI;IAIpB;;;OAGG;IACG,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC;IAqD7B,mDAAmD;IACnD,IAAI,KAAK,IAAI,KAAK,CAEjB;IAED,6EAA6E;IAC7E,QAAQ,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,IAAI;IAIhD,OAAO,CAAC,aAAa;CAKtB"}
|
package/dist/control/state.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { control } from '@synnaxlabs/x';
|
|
2
2
|
import { observe } from '@synnaxlabs/x/observe';
|
|
3
|
-
import { z } from 'zod';
|
|
3
|
+
import { z } from 'zod/v4';
|
|
4
4
|
import { channel } from '../channel';
|
|
5
5
|
import { framer } from '../framer';
|
|
6
6
|
export type Authority = control.Authority;
|
|
@@ -15,11 +15,53 @@ export declare const stateZ: z.ZodObject<{
|
|
|
15
15
|
subject: z.ZodObject<{
|
|
16
16
|
name: z.ZodString;
|
|
17
17
|
key: z.ZodString;
|
|
18
|
-
},
|
|
18
|
+
}, z.core.$strip>;
|
|
19
19
|
resource: z.ZodNumber;
|
|
20
20
|
authority: z.ZodNumber;
|
|
21
|
-
},
|
|
21
|
+
}, z.core.$strip>;
|
|
22
22
|
export declare const transferString: (t: Transfer) => string;
|
|
23
|
+
declare const updateZ: z.ZodObject<{
|
|
24
|
+
transfers: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
|
|
25
|
+
from: z.ZodObject<{
|
|
26
|
+
subject: z.ZodObject<{
|
|
27
|
+
name: z.ZodString;
|
|
28
|
+
key: z.ZodString;
|
|
29
|
+
}, z.core.$strip>;
|
|
30
|
+
resource: z.ZodNumber;
|
|
31
|
+
authority: z.ZodNumber;
|
|
32
|
+
}, z.core.$strip>;
|
|
33
|
+
to: z.ZodNull;
|
|
34
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
35
|
+
from: z.ZodNull;
|
|
36
|
+
to: z.ZodObject<{
|
|
37
|
+
subject: z.ZodObject<{
|
|
38
|
+
name: z.ZodString;
|
|
39
|
+
key: z.ZodString;
|
|
40
|
+
}, z.core.$strip>;
|
|
41
|
+
resource: z.ZodNumber;
|
|
42
|
+
authority: z.ZodNumber;
|
|
43
|
+
}, z.core.$strip>;
|
|
44
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
45
|
+
from: z.ZodObject<{
|
|
46
|
+
subject: z.ZodObject<{
|
|
47
|
+
name: z.ZodString;
|
|
48
|
+
key: z.ZodString;
|
|
49
|
+
}, z.core.$strip>;
|
|
50
|
+
resource: z.ZodNumber;
|
|
51
|
+
authority: z.ZodNumber;
|
|
52
|
+
}, z.core.$strip>;
|
|
53
|
+
to: z.ZodObject<{
|
|
54
|
+
subject: z.ZodObject<{
|
|
55
|
+
name: z.ZodString;
|
|
56
|
+
key: z.ZodString;
|
|
57
|
+
}, z.core.$strip>;
|
|
58
|
+
resource: z.ZodNumber;
|
|
59
|
+
authority: z.ZodNumber;
|
|
60
|
+
}, z.core.$strip>;
|
|
61
|
+
}, z.core.$strip>]>>;
|
|
62
|
+
}, z.core.$strip>;
|
|
63
|
+
export interface Update extends z.infer<typeof updateZ> {
|
|
64
|
+
}
|
|
23
65
|
export declare class StateTracker extends framer.ObservableStreamer<Transfer[]> implements observe.ObservableAsyncCloseable<Transfer[]> {
|
|
24
66
|
readonly states: Map<channel.Key, State>;
|
|
25
67
|
private readonly codec;
|
|
@@ -27,4 +69,5 @@ export declare class StateTracker extends framer.ObservableStreamer<Transfer[]>
|
|
|
27
69
|
subjects(): Subject[];
|
|
28
70
|
private merge;
|
|
29
71
|
}
|
|
72
|
+
export {};
|
|
30
73
|
//# sourceMappingURL=state.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../../src/control/state.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,CAAC,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"state.d.ts","sourceRoot":"","sources":["../../src/control/state.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAE3B,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC,MAAM,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;AAC1C,eAAO,MAAM,kBAAkB,QAA6B,CAAC;AAC7D,eAAO,MAAM,cAAc,QAAyB,CAAC;AACrD,MAAM,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;AACrD,MAAM,WAAW,KAAM,SAAQ,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;CAAG;AAC5D,MAAM,WAAW,OAAQ,SAAQ,OAAO,CAAC,OAAO;CAAG;AACnD,eAAO,MAAM,MAAM;;;;;;;iBAA6B,CAAC;AAEjD,eAAO,MAAM,cAAc,GAAI,GAAG,QAAQ,KAAG,MAS5C,CAAC;AAEF,QAAA,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAEX,CAAC;AAEH,MAAM,WAAW,MAAO,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,OAAO,CAAC;CAAG;AAE1D,qBAAa,YACX,SAAQ,MAAM,CAAC,kBAAkB,CAAC,QAAQ,EAAE,CAC5C,YAAW,OAAO,CAAC,wBAAwB,CAAC,QAAQ,EAAE,CAAC;IAEvD,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACzC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAe;gBAEzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;IAUrC,QAAQ,IAAI,OAAO,EAAE;IAMrB,OAAO,CAAC,KAAK;CAOd"}
|
package/dist/framer/adapter.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { CrudeSeries } from '@synnaxlabs/x/telem';
|
|
2
2
|
import { channel } from '../channel';
|
|
3
3
|
import { Codec } from './codec';
|
|
4
|
-
import {
|
|
4
|
+
import { CrudeFrame, Frame } from './frame';
|
|
5
5
|
export declare class ReadAdapter {
|
|
6
6
|
private adapter;
|
|
7
7
|
retriever: channel.Retriever;
|
|
@@ -24,6 +24,6 @@ export declare class WriteAdapter {
|
|
|
24
24
|
private fetchChannel;
|
|
25
25
|
private adaptToKey;
|
|
26
26
|
encode(frame: Frame): Uint8Array;
|
|
27
|
-
adapt(columnsOrData: channel.Params | Record<channel.KeyOrName, CrudeSeries> |
|
|
27
|
+
adapt(columnsOrData: channel.Params | Record<channel.KeyOrName, CrudeSeries> | CrudeFrame, series?: CrudeSeries | CrudeSeries[]): Promise<Frame>;
|
|
28
28
|
}
|
|
29
29
|
//# sourceMappingURL=adapter.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../src/framer/adapter.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,WAAW,EAAU,MAAM,qBAAqB,CAAC;AAE/D,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,KAAK,
|
|
1
|
+
{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../src/framer/adapter.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,WAAW,EAAU,MAAM,qBAAqB,CAAC;AAE/D,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACvC,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAExD,qBAAa,WAAW;IACtB,OAAO,CAAC,OAAO,CAAwC;IACvD,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC;IAC7B,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;IACpB,KAAK,EAAE,KAAK,CAAC;IAEb,OAAO;WAOM,IAAI,CACf,SAAS,EAAE,OAAO,CAAC,SAAS,EAC5B,QAAQ,EAAE,OAAO,CAAC,MAAM,GACvB,OAAO,CAAC,WAAW,CAAC;IAMjB,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBrD,KAAK,CAAC,aAAa,EAAE,KAAK,GAAG,KAAK;CAYnC;AAED,qBAAa,YAAY;IACvB,OAAO,CAAC,OAAO,CAAwC;IACvD,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC;IAC7B,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;IACpB,KAAK,EAAE,KAAK,CAAC;IAEb,OAAO;WAOM,IAAI,CACf,SAAS,EAAE,OAAO,CAAC,SAAS,EAC5B,QAAQ,EAAE,OAAO,CAAC,MAAM,GACvB,OAAO,CAAC,YAAY,CAAC;IAMlB,eAAe,CAAC,CAAC,EACrB,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC,GACjC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAM5B,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;YAYvC,YAAY;YAQZ,UAAU;IAMxB,MAAM,CAAC,KAAK,EAAE,KAAK,GAAG,UAAU;IAI1B,KAAK,CACT,aAAa,EAAE,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG,UAAU,EACnF,MAAM,CAAC,EAAE,WAAW,GAAG,WAAW,EAAE,GACnC,OAAO,CAAC,KAAK,CAAC;CA0ElB"}
|
package/dist/framer/client.d.ts
CHANGED
|
@@ -50,6 +50,8 @@ export declare class Client {
|
|
|
50
50
|
* and then will start reading new values.
|
|
51
51
|
*
|
|
52
52
|
*/
|
|
53
|
+
openStreamer(config: StreamerConfig): Promise<Streamer>;
|
|
54
|
+
/** Overload to provide interface compatibility with @see StreamOpener */
|
|
53
55
|
openStreamer(config: StreamerConfig | channel.Params): Promise<Streamer>;
|
|
54
56
|
write(start: CrudeTimeStamp, channel: channel.KeyOrName, data: CrudeSeries): Promise<void>;
|
|
55
57
|
write(start: CrudeTimeStamp, channels: channel.KeysOrNames, data: CrudeSeries[]): Promise<void>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/framer/client.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC/E,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,KAAK,SAAS,EAEf,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,KAAK,EAAiB,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,KAAK,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAClE,OAAO,EAAgB,KAAK,QAAQ,EAAE,KAAK,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACrF,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,EAAc,MAAM,iBAAiB,CAAC;AACxE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,eAAO,MAAM,UAAU,GAAI,KAAK,OAAO,CAAC,GAAG,KAAG,QAAQ,CAAC,EACQ,CAAC;AAchE,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAkB;IAC/C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;IAC9C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAU;gBAGhC,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,WAAW,EAClB,SAAS,EAAE,OAAO,CAAC,SAAS;IAO9B;;;;;;;OAOG;IACG,YAAY,CAChB,EAAE,EAAE,cAAc,EAClB,QAAQ,EAAE,OAAO,CAAC,MAAM,EACxB,IAAI,CAAC,EAAE,cAAc,GACpB,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;OAMG;IACG,UAAU,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAQxE;;;;;;;;OAQG;IACG,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAE/D;;;;;;;;;;OAUG;IACG,YAAY,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAUxE,KAAK,CACT,KAAK,EAAE,cAAc,EACrB,OAAO,EAAE,OAAO,CAAC,SAAS,EAC1B,IAAI,EAAE,WAAW,GAChB,OAAO,CAAC,IAAI,CAAC;IAEV,KAAK,CACT,KAAK,EAAE,cAAc,EACrB,QAAQ,EAAE,OAAO,CAAC,WAAW,EAC7B,IAAI,EAAE,WAAW,EAAE,GAClB,OAAO,CAAC,IAAI,CAAC;IAEV,KAAK,CACT,KAAK,EAAE,cAAc,EACrB,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,WAAW,CAAC,GAC3C,OAAO,CAAC,IAAI,CAAC;
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/framer/client.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC/E,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,KAAK,SAAS,EAEf,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,KAAK,EAAiB,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,KAAK,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAClE,OAAO,EAAgB,KAAK,QAAQ,EAAE,KAAK,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACrF,OAAO,EAAE,MAAM,EAAE,KAAK,YAAY,EAAc,MAAM,iBAAiB,CAAC;AACxE,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,eAAO,MAAM,UAAU,GAAI,KAAK,OAAO,CAAC,GAAG,KAAG,QAAQ,CAAC,EACQ,CAAC;AAchE,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAkB;IAC/C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;IAC9C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAU;gBAGhC,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,WAAW,EAClB,SAAS,EAAE,OAAO,CAAC,SAAS;IAO9B;;;;;;;OAOG;IACG,YAAY,CAChB,EAAE,EAAE,cAAc,EAClB,QAAQ,EAAE,OAAO,CAAC,MAAM,EACxB,IAAI,CAAC,EAAE,cAAc,GACpB,OAAO,CAAC,QAAQ,CAAC;IAIpB;;;;;;OAMG;IACG,UAAU,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAQxE;;;;;;;;OAQG;IACG,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAE/D;;;;;;;;;;OAUG;IACG,YAAY,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAE7D,yEAAyE;IACnE,YAAY,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAUxE,KAAK,CACT,KAAK,EAAE,cAAc,EACrB,OAAO,EAAE,OAAO,CAAC,SAAS,EAC1B,IAAI,EAAE,WAAW,GAChB,OAAO,CAAC,IAAI,CAAC;IAEV,KAAK,CACT,KAAK,EAAE,cAAc,EACrB,QAAQ,EAAE,OAAO,CAAC,WAAW,EAC7B,IAAI,EAAE,WAAW,EAAE,GAClB,OAAO,CAAC,IAAI,CAAC;IAEV,KAAK,CACT,KAAK,EAAE,cAAc,EACrB,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,WAAW,CAAC,GAC3C,OAAO,CAAC,IAAI,CAAC;IAyCV,IAAI,CAAC,EAAE,EAAE,cAAc,EAAE,OAAO,EAAE,OAAO,CAAC,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC;IAE1E,IAAI,CAAC,EAAE,EAAE,cAAc,EAAE,QAAQ,EAAE,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;YAY1D,SAAS;IAcjB,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,EAAE,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;CAY5E"}
|
package/dist/framer/codec.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { binary, DataType } from '@synnaxlabs/x';
|
|
2
|
-
import {
|
|
2
|
+
import { z } from 'zod/v4';
|
|
3
3
|
import { channel } from '../channel';
|
|
4
4
|
import { Payload } from './frame';
|
|
5
5
|
export declare class Codec {
|
|
@@ -21,7 +21,7 @@ export declare class WSWriterCodec implements binary.Codec {
|
|
|
21
21
|
private lowPerfCodec;
|
|
22
22
|
constructor(base: Codec);
|
|
23
23
|
encode(payload: unknown): Uint8Array;
|
|
24
|
-
decode<P>(data: Uint8Array | ArrayBuffer, schema?:
|
|
24
|
+
decode<P extends z.ZodType>(data: Uint8Array | ArrayBuffer, schema?: P): z.infer<P>;
|
|
25
25
|
}
|
|
26
26
|
export declare class WSStreamerCodec implements binary.Codec {
|
|
27
27
|
contentType: string;
|
|
@@ -29,6 +29,6 @@ export declare class WSStreamerCodec implements binary.Codec {
|
|
|
29
29
|
private lowPerfCodec;
|
|
30
30
|
constructor(base: Codec);
|
|
31
31
|
encode(payload: unknown): Uint8Array;
|
|
32
|
-
decode<P>(data: Uint8Array | ArrayBuffer, schema?:
|
|
32
|
+
decode<P extends z.ZodType>(data: Uint8Array | ArrayBuffer, schema?: P): z.infer<P>;
|
|
33
33
|
}
|
|
34
34
|
//# sourceMappingURL=codec.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"codec.d.ts","sourceRoot":"","sources":["../../src/framer/codec.ts"],"names":[],"mappings":"AAUA,OAAO,EACL,MAAM,EACN,QAAQ,EAIT,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,KAAK,
|
|
1
|
+
{"version":3,"file":"codec.d.ts","sourceRoot":"","sources":["../../src/framer/codec.ts"],"names":[],"mappings":"AAUA,OAAO,EACL,MAAM,EACN,QAAQ,EAIT,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC,OAAO,EAAc,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAC;AA0C1D,qBAAa,KAAK;IAChB,WAAW,EAAE,MAAM,CAA2B;IAC9C,OAAO,CAAC,MAAM,CAAsC;IACpD,OAAO,CAAC,SAAS,CAAyB;IAC1C,OAAO,CAAC,MAAM,CAAa;gBAEf,IAAI,GAAE,OAAO,CAAC,IAAS,EAAE,SAAS,GAAE,QAAQ,EAAO;IAI/D,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,IAAI;IAiBvD,OAAO,CAAC,iBAAiB;IAQzB,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,GAAE,MAAU,GAAG,UAAU;IA6H7D,MAAM,CAAC,IAAI,EAAE,UAAU,GAAG,WAAW,EAAE,MAAM,GAAE,MAAU,GAAG,OAAO;CAmGpE;AAED,eAAO,MAAM,oBAAoB,MAAM,CAAC;AAExC,eAAO,MAAM,sBAAsB,MAAM,CAAC;AAI1C,qBAAa,aAAc,YAAW,MAAM,CAAC,KAAK;IAChD,WAAW,SAAgB;IAC3B,OAAO,CAAC,IAAI,CAAQ;IACpB,OAAO,CAAC,YAAY,CAAe;gBAEvB,IAAI,EAAE,KAAK;IAKvB,MAAM,CAAC,OAAO,EAAE,OAAO,GAAG,UAAU;IAcpC,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,IAAI,EAAE,UAAU,GAAG,WAAW,EAAE,MAAM,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;CAUpF;AAED,qBAAa,eAAgB,YAAW,MAAM,CAAC,KAAK;IAClD,WAAW,SAAgB;IAC3B,OAAO,CAAC,IAAI,CAAQ;IACpB,OAAO,CAAC,YAAY,CAAe;gBAEvB,IAAI,EAAE,KAAK;IAKvB,MAAM,CAAC,OAAO,EAAE,OAAO,GAAG,UAAU;IAIpC,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,IAAI,EAAE,UAAU,GAAG,WAAW,EAAE,MAAM,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;CAWpF"}
|
package/dist/framer/deleter.d.ts
CHANGED
|
@@ -1,25 +1,25 @@
|
|
|
1
1
|
import { UnaryClient } from '@synnaxlabs/freighter';
|
|
2
2
|
import { TimeRange } from '@synnaxlabs/x';
|
|
3
|
-
import { z } from 'zod';
|
|
3
|
+
import { z } from 'zod/v4';
|
|
4
4
|
declare const reqZ: z.ZodObject<{
|
|
5
5
|
keys: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
|
|
6
6
|
bounds: z.ZodUnion<readonly [z.ZodPipe<z.ZodObject<{
|
|
7
7
|
start: z.ZodUnion<readonly [z.ZodPipe<z.ZodObject<{
|
|
8
8
|
value: z.ZodBigInt;
|
|
9
|
-
},
|
|
9
|
+
}, z.core.$strip>, z.ZodTransform<import('@synnaxlabs/x').TimeStamp, {
|
|
10
10
|
value: bigint;
|
|
11
|
-
}>>, z.ZodPipe<z.ZodString, z.ZodTransform<import('@synnaxlabs/x').TimeStamp, string>>, z.ZodPipe<z.ZodCustom<Number,
|
|
11
|
+
}>>, z.ZodPipe<z.ZodString, z.ZodTransform<import('@synnaxlabs/x').TimeStamp, string>>, z.ZodPipe<z.ZodCustom<Number, Number>, z.ZodTransform<import('@synnaxlabs/x').TimeStamp, Number>>, z.ZodPipe<z.ZodNumber, z.ZodTransform<import('@synnaxlabs/x').TimeStamp, number>>, z.ZodCustom<import('@synnaxlabs/x').TimeStamp, import('@synnaxlabs/x').TimeStamp>]>;
|
|
12
12
|
end: z.ZodUnion<readonly [z.ZodPipe<z.ZodObject<{
|
|
13
13
|
value: z.ZodBigInt;
|
|
14
|
-
},
|
|
14
|
+
}, z.core.$strip>, z.ZodTransform<import('@synnaxlabs/x').TimeStamp, {
|
|
15
15
|
value: bigint;
|
|
16
|
-
}>>, z.ZodPipe<z.ZodString, z.ZodTransform<import('@synnaxlabs/x').TimeStamp, string>>, z.ZodPipe<z.ZodCustom<Number,
|
|
17
|
-
},
|
|
16
|
+
}>>, z.ZodPipe<z.ZodString, z.ZodTransform<import('@synnaxlabs/x').TimeStamp, string>>, z.ZodPipe<z.ZodCustom<Number, Number>, z.ZodTransform<import('@synnaxlabs/x').TimeStamp, Number>>, z.ZodPipe<z.ZodNumber, z.ZodTransform<import('@synnaxlabs/x').TimeStamp, number>>, z.ZodCustom<import('@synnaxlabs/x').TimeStamp, import('@synnaxlabs/x').TimeStamp>]>;
|
|
17
|
+
}, z.core.$strip>, z.ZodTransform<TimeRange, {
|
|
18
18
|
start: import('@synnaxlabs/x').TimeStamp;
|
|
19
19
|
end: import('@synnaxlabs/x').TimeStamp;
|
|
20
|
-
}>>, z.ZodCustom<TimeRange,
|
|
20
|
+
}>>, z.ZodCustom<TimeRange, TimeRange>]>;
|
|
21
21
|
names: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
22
|
-
},
|
|
22
|
+
}, z.core.$strip>;
|
|
23
23
|
interface Request extends z.infer<typeof reqZ> {
|
|
24
24
|
}
|
|
25
25
|
export declare class Deleter {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"deleter.d.ts","sourceRoot":"","sources":["../../src/framer/deleter.ts"],"names":[],"mappings":"AASA,OAAO,EAAgB,KAAK,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,CAAC,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"deleter.d.ts","sourceRoot":"","sources":["../../src/framer/deleter.ts"],"names":[],"mappings":"AASA,OAAO,EAAgB,KAAK,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAI3B,QAAA,MAAM,IAAI;;;;;;;;;;;;;;;;;;iBAIR,CAAC;AACH,UAAU,OAAQ,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC;CAAG;AAMjD,qBAAa,OAAO;IAIlB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;gBAEzB,MAAM,EAAE,WAAW;IAIzB,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAS5C"}
|
package/dist/framer/frame.d.ts
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import { MultiSeries, Series, SeriesDigest, SeriesPayload, Size, TelemValue, TimeRange, TimeStamp } from '@synnaxlabs/x/telem';
|
|
2
|
-
import { z } from 'zod';
|
|
2
|
+
import { z } from 'zod/v4';
|
|
3
3
|
import { channel } from '../channel';
|
|
4
4
|
export declare const ONTOLOGY_TYPE = "framer";
|
|
5
5
|
export type OntologyType = typeof ONTOLOGY_TYPE;
|
|
6
6
|
type ColumnType = "key" | "name" | null;
|
|
7
7
|
export interface Digest extends Record<channel.KeyOrName, SeriesDigest[]> {
|
|
8
8
|
}
|
|
9
|
-
export type
|
|
9
|
+
export type CrudeFrame = Frame | CrudePayload | Map<channel.KeyOrName, Series[] | Series> | Record<channel.KeyOrName, Series[] | Series>;
|
|
10
10
|
/**
|
|
11
11
|
* A frame is a collection of series mapped to a particular channel. Frames
|
|
12
12
|
* can be keyed by channel name or channel key, but not both.
|
|
@@ -45,7 +45,7 @@ export type Crude = Frame | CrudePayload | Map<channel.KeyOrName, Series[] | Ser
|
|
|
45
45
|
export declare class Frame {
|
|
46
46
|
readonly columns: channel.Keys | channel.Names;
|
|
47
47
|
readonly series: Series[];
|
|
48
|
-
constructor(columnsOrData?: channel.PrimitiveParams |
|
|
48
|
+
constructor(columnsOrData?: channel.PrimitiveParams | CrudeFrame, series?: Series | Series[]);
|
|
49
49
|
/**
|
|
50
50
|
* @returns "key" if the frame columns are channel keys, "name" if the columns are
|
|
51
51
|
* channel names, and null if the frame has no columns.
|
|
@@ -171,37 +171,37 @@ export declare class Frame {
|
|
|
171
171
|
export declare const frameZ: z.ZodObject<{
|
|
172
172
|
keys: z.ZodUnion<readonly [z.ZodPipe<z.ZodNull, z.ZodTransform<number[], null>>, z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodNumber>>>]>;
|
|
173
173
|
series: z.ZodUnion<readonly [z.ZodPipe<z.ZodNull, z.ZodTransform<{
|
|
174
|
+
dataType: import('@synnaxlabs/x').DataType;
|
|
175
|
+
data: ArrayBuffer | Uint8Array<ArrayBuffer>;
|
|
174
176
|
timeRange?: TimeRange | undefined;
|
|
175
177
|
alignment?: bigint | undefined;
|
|
176
178
|
glBufferUsage?: "static" | "dynamic" | undefined;
|
|
177
|
-
dataType: import('@synnaxlabs/x').DataType;
|
|
178
|
-
data: ArrayBuffer | Uint8Array<ArrayBuffer>;
|
|
179
179
|
}[], null>>, z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
180
180
|
timeRange: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodObject<{
|
|
181
181
|
start: z.ZodUnion<readonly [z.ZodPipe<z.ZodObject<{
|
|
182
182
|
value: z.ZodBigInt;
|
|
183
|
-
},
|
|
183
|
+
}, z.core.$strip>, z.ZodTransform<TimeStamp, {
|
|
184
184
|
value: bigint;
|
|
185
|
-
}>>, z.ZodPipe<z.ZodString, z.ZodTransform<TimeStamp, string>>, z.ZodPipe<z.ZodCustom<Number,
|
|
185
|
+
}>>, z.ZodPipe<z.ZodString, z.ZodTransform<TimeStamp, string>>, z.ZodPipe<z.ZodCustom<Number, Number>, z.ZodTransform<TimeStamp, Number>>, z.ZodPipe<z.ZodNumber, z.ZodTransform<TimeStamp, number>>, z.ZodCustom<TimeStamp, TimeStamp>]>;
|
|
186
186
|
end: z.ZodUnion<readonly [z.ZodPipe<z.ZodObject<{
|
|
187
187
|
value: z.ZodBigInt;
|
|
188
|
-
},
|
|
188
|
+
}, z.core.$strip>, z.ZodTransform<TimeStamp, {
|
|
189
189
|
value: bigint;
|
|
190
|
-
}>>, z.ZodPipe<z.ZodString, z.ZodTransform<TimeStamp, string>>, z.ZodPipe<z.ZodCustom<Number,
|
|
191
|
-
},
|
|
190
|
+
}>>, z.ZodPipe<z.ZodString, z.ZodTransform<TimeStamp, string>>, z.ZodPipe<z.ZodCustom<Number, Number>, z.ZodTransform<TimeStamp, Number>>, z.ZodPipe<z.ZodNumber, z.ZodTransform<TimeStamp, number>>, z.ZodCustom<TimeStamp, TimeStamp>]>;
|
|
191
|
+
}, z.core.$strip>, z.ZodTransform<TimeRange, {
|
|
192
192
|
start: TimeStamp;
|
|
193
193
|
end: TimeStamp;
|
|
194
|
-
}>>, z.ZodCustom<TimeRange,
|
|
195
|
-
dataType: z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<import('@synnaxlabs/x').DataType, string>>, z.ZodCustom<import('@synnaxlabs/x').DataType,
|
|
196
|
-
alignment: z.ZodOptional<z.
|
|
197
|
-
data: z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<ArrayBuffer, string>>, z.ZodPipe<z.ZodUnion<readonly [z.ZodNull, z.ZodUndefined]>, z.ZodTransform<ArrayBuffer, null | undefined>>, z.ZodCustom<ArrayBuffer,
|
|
194
|
+
}>>, z.ZodCustom<TimeRange, TimeRange>]>>;
|
|
195
|
+
dataType: z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<import('@synnaxlabs/x').DataType, string>>, z.ZodCustom<import('@synnaxlabs/x').DataType, import('@synnaxlabs/x').DataType>]>;
|
|
196
|
+
alignment: z.ZodOptional<z.ZodCoercedBigInt<unknown>>;
|
|
197
|
+
data: z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<ArrayBuffer, string>>, z.ZodPipe<z.ZodUnion<readonly [z.ZodNull, z.ZodUndefined]>, z.ZodTransform<ArrayBuffer, null | undefined>>, z.ZodCustom<ArrayBuffer, ArrayBuffer>, z.ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>]>;
|
|
198
198
|
glBufferUsage: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
|
|
199
199
|
static: "static";
|
|
200
200
|
dynamic: "dynamic";
|
|
201
201
|
}>>>>;
|
|
202
|
-
},
|
|
203
|
-
},
|
|
204
|
-
export interface Payload extends z.
|
|
202
|
+
}, z.core.$strip>>>>]>;
|
|
203
|
+
}, z.core.$strip>;
|
|
204
|
+
export interface Payload extends z.infer<typeof frameZ> {
|
|
205
205
|
}
|
|
206
206
|
export interface CrudePayload extends z.input<typeof frameZ> {
|
|
207
207
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"frame.d.ts","sourceRoot":"","sources":["../../src/framer/frame.ts"],"names":[],"mappings":"AAUA,OAAO,EACL,WAAW,EACX,MAAM,EACN,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,IAAI,EACJ,KAAK,UAAU,EACf,SAAS,EACT,SAAS,EACV,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,CAAC,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"frame.d.ts","sourceRoot":"","sources":["../../src/framer/frame.ts"],"names":[],"mappings":"AAUA,OAAO,EACL,WAAW,EACX,MAAM,EACN,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,IAAI,EACJ,KAAK,UAAU,EACf,SAAS,EACT,SAAS,EACV,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAE3B,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAGzC,eAAO,MAAM,aAAa,WAAW,CAAC;AACtC,MAAM,MAAM,YAAY,GAAG,OAAO,aAAa,CAAC;AAEhD,KAAK,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,IAAI,CAAC;AAExC,MAAM,WAAW,MAAO,SAAQ,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,YAAY,EAAE,CAAC;CAAG;AA2B5E,MAAM,MAAM,UAAU,GAClB,KAAK,GACL,YAAY,GACZ,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,GACzC,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,KAAK;IAChB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,KAAK,CAAM;IACpD,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,CAAM;gBAG7B,aAAa,GAAE,OAAO,CAAC,eAAe,GAAG,UAAe,EACxD,MAAM,GAAE,MAAM,GAAG,MAAM,EAAO;IAqDhC;;;OAGG;IACH,IAAI,OAAO,IAAI,UAAU,CAIxB;IAED;;;OAGG;IACH,IAAI,IAAI,IAAI,OAAO,CAAC,IAAI,CAGvB;IAED;;;OAGG;IACH,IAAI,UAAU,IAAI,OAAO,CAAC,IAAI,CAE7B;IAED;;;OAGG;IACH,IAAI,KAAK,IAAI,OAAO,CAAC,KAAK,CAGzB;IAED;;;OAGG;IACH,IAAI,WAAW,IAAI,OAAO,CAAC,KAAK,CAE/B;IAED;;OAEG;IACH,IAAI,aAAa,IAAI,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,KAAK,CAEhD;IAED,SAAS,IAAI,OAAO;IAOpB;;;;OAIG;IACH,IAAI,UAAU,IAAI,OAAO,CAExB;IAED;;;;;OAKG;IACH,IAAI,YAAY,IAAI,OAAO,CAE1B;IAED;;;OAGG;IACH,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED;;;;;OAKG;IACH,IAAI,eAAe,IAAI,OAAO,CAI7B;IAED,SAAS,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,SAAS,GAAG,SAAS;IAY7C,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,SAAS,CAAC;IAIhD,IAAI,UAAU,IAAI,SAAS,EAAE,CAE5B;IAED;;;OAGG;IACH,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,SAAS,GAAG,WAAW;IAExC;;;OAGG;IACH,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,KAAK,GAAG,KAAK;IAQ9C;;;;;OAKG;IACH,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI;IAElD;;;;OAIG;IACH,IAAI,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI;IAoBxB;;;OAGG;IACH,MAAM,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK;IAO3B;;;OAGG;IACH,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,SAAS,GAAG,OAAO;IAMxC;;;;OAIG;IACH,GAAG,CACD,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,GAChF,KAAK;IAMR;;;;OAIG;IACH,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAOzE,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC;IAExE,EAAE,CACA,KAAK,EAAE,MAAM,EACb,QAAQ,CAAC,EAAE,KAAK,GACf,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,UAAU,GAAG,SAAS,CAAC;IAapD;;;;OAIG;IACH,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,KAAK,OAAO,GAAG,KAAK;IAS5E,uDAAuD;IACvD,IAAI,UAAU,IAAI,IAAI,CAErB;IAED;;;OAGG;IACH,IAAI,MAAM,IAAI,MAAM,CAQnB;IAED,yDAAyD;IACzD,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,QAAQ,IAAI,MAAM;CAUnB;AAED,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBASjB,CAAC;AAEH,MAAM,WAAW,OAAQ,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC;CAAG;AAE1D,MAAM,WAAW,YAAa,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC;CAAG;AAE/D,eAAO,MAAM,iBAAiB,GAAI,QAAQ,aAAa,KAAG,MAGzD,CAAC;AAEF,eAAO,MAAM,eAAe,GAAI,QAAQ,MAAM,KAAG,aAK/C,CAAC"}
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import { Stream } from '@synnaxlabs/freighter';
|
|
2
|
-
import { z } from 'zod';
|
|
3
|
-
export declare class StreamProxy<RQ extends z.
|
|
2
|
+
import { z } from 'zod/v4';
|
|
3
|
+
export declare class StreamProxy<RQ extends z.ZodType, RS extends z.ZodType> {
|
|
4
4
|
readonly name: string;
|
|
5
5
|
private readonly stream;
|
|
6
6
|
constructor(name: string, stream: Stream<RQ, RS>);
|
|
7
|
-
receive(): Promise<z.
|
|
7
|
+
receive(): Promise<z.infer<RS>>;
|
|
8
8
|
received(): boolean;
|
|
9
9
|
closeAndAck(): Promise<void>;
|
|
10
10
|
closeSend(): void;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"streamProxy.d.ts","sourceRoot":"","sources":["../../src/framer/streamProxy.ts"],"names":[],"mappings":"AASA,OAAO,EAAO,KAAK,MAAM,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"streamProxy.d.ts","sourceRoot":"","sources":["../../src/framer/streamProxy.ts"],"names":[],"mappings":"AASA,OAAO,EAAO,KAAK,MAAM,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,QAAQ,CAAC;AAEhC,qBAAa,WAAW,CAAC,EAAE,SAAS,CAAC,CAAC,OAAO,EAAE,EAAE,SAAS,CAAC,CAAC,OAAO;IACjE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;gBAE5B,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC;IAK1C,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAMrC,QAAQ,IAAI,OAAO;IAIb,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAgBlC,SAAS,IAAI,IAAI;IAIjB,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,IAAI;CAI7B"}
|
|
@@ -1,72 +1,142 @@
|
|
|
1
1
|
import { WebSocketClient } from '@synnaxlabs/freighter';
|
|
2
|
-
import { observe } from '@synnaxlabs/x';
|
|
3
|
-
import { z } from 'zod';
|
|
2
|
+
import { breaker, observe } from '@synnaxlabs/x';
|
|
3
|
+
import { z } from 'zod/v4';
|
|
4
4
|
import { channel } from '../channel';
|
|
5
5
|
import { Frame } from './frame';
|
|
6
6
|
declare const reqZ: z.ZodObject<{
|
|
7
7
|
keys: z.ZodArray<z.ZodNumber>;
|
|
8
|
-
|
|
9
|
-
},
|
|
10
|
-
|
|
8
|
+
downsampleFactor: z.ZodNumber;
|
|
9
|
+
}, z.core.$strip>;
|
|
10
|
+
/**
|
|
11
|
+
* Request interface for streaming frames from a Synnax cluster.
|
|
12
|
+
* Contains the keys of channels to stream from and a downsample factor.
|
|
13
|
+
*/
|
|
14
|
+
export interface StreamerRequest extends z.infer<typeof reqZ> {
|
|
15
|
+
}
|
|
11
16
|
declare const resZ: z.ZodObject<{
|
|
12
17
|
frame: z.ZodObject<{
|
|
13
18
|
keys: z.ZodUnion<readonly [z.ZodPipe<z.ZodNull, z.ZodTransform<number[], null>>, z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodNumber>>>]>;
|
|
14
19
|
series: z.ZodUnion<readonly [z.ZodPipe<z.ZodNull, z.ZodTransform<{
|
|
20
|
+
dataType: import('@synnaxlabs/x').DataType;
|
|
21
|
+
data: ArrayBuffer | Uint8Array<ArrayBuffer>;
|
|
15
22
|
timeRange?: import('@synnaxlabs/x').TimeRange | undefined;
|
|
16
23
|
alignment?: bigint | undefined;
|
|
17
24
|
glBufferUsage?: "static" | "dynamic" | undefined;
|
|
18
|
-
dataType: import('@synnaxlabs/x').DataType;
|
|
19
|
-
data: ArrayBuffer | Uint8Array<ArrayBuffer>;
|
|
20
25
|
}[], null>>, z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
21
26
|
timeRange: z.ZodOptional<z.ZodUnion<readonly [z.ZodPipe<z.ZodObject<{
|
|
22
27
|
start: z.ZodUnion<readonly [z.ZodPipe<z.ZodObject<{
|
|
23
28
|
value: z.ZodBigInt;
|
|
24
|
-
},
|
|
29
|
+
}, z.core.$strip>, z.ZodTransform<import('@synnaxlabs/x').TimeStamp, {
|
|
25
30
|
value: bigint;
|
|
26
|
-
}>>, z.ZodPipe<z.ZodString, z.ZodTransform<import('@synnaxlabs/x').TimeStamp, string>>, z.ZodPipe<z.ZodCustom<Number,
|
|
31
|
+
}>>, z.ZodPipe<z.ZodString, z.ZodTransform<import('@synnaxlabs/x').TimeStamp, string>>, z.ZodPipe<z.ZodCustom<Number, Number>, z.ZodTransform<import('@synnaxlabs/x').TimeStamp, Number>>, z.ZodPipe<z.ZodNumber, z.ZodTransform<import('@synnaxlabs/x').TimeStamp, number>>, z.ZodCustom<import('@synnaxlabs/x').TimeStamp, import('@synnaxlabs/x').TimeStamp>]>;
|
|
27
32
|
end: z.ZodUnion<readonly [z.ZodPipe<z.ZodObject<{
|
|
28
33
|
value: z.ZodBigInt;
|
|
29
|
-
},
|
|
34
|
+
}, z.core.$strip>, z.ZodTransform<import('@synnaxlabs/x').TimeStamp, {
|
|
30
35
|
value: bigint;
|
|
31
|
-
}>>, z.ZodPipe<z.ZodString, z.ZodTransform<import('@synnaxlabs/x').TimeStamp, string>>, z.ZodPipe<z.ZodCustom<Number,
|
|
32
|
-
},
|
|
36
|
+
}>>, z.ZodPipe<z.ZodString, z.ZodTransform<import('@synnaxlabs/x').TimeStamp, string>>, z.ZodPipe<z.ZodCustom<Number, Number>, z.ZodTransform<import('@synnaxlabs/x').TimeStamp, Number>>, z.ZodPipe<z.ZodNumber, z.ZodTransform<import('@synnaxlabs/x').TimeStamp, number>>, z.ZodCustom<import('@synnaxlabs/x').TimeStamp, import('@synnaxlabs/x').TimeStamp>]>;
|
|
37
|
+
}, z.core.$strip>, z.ZodTransform<import('@synnaxlabs/x').TimeRange, {
|
|
33
38
|
start: import('@synnaxlabs/x').TimeStamp;
|
|
34
39
|
end: import('@synnaxlabs/x').TimeStamp;
|
|
35
|
-
}>>, z.ZodCustom<import('@synnaxlabs/x').TimeRange,
|
|
36
|
-
dataType: z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<import('@synnaxlabs/x').DataType, string>>, z.ZodCustom<import('@synnaxlabs/x').DataType,
|
|
37
|
-
alignment: z.ZodOptional<z.
|
|
38
|
-
data: z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<ArrayBuffer, string>>, z.ZodPipe<z.ZodUnion<readonly [z.ZodNull, z.ZodUndefined]>, z.ZodTransform<ArrayBuffer, null | undefined>>, z.ZodCustom<ArrayBuffer,
|
|
40
|
+
}>>, z.ZodCustom<import('@synnaxlabs/x').TimeRange, import('@synnaxlabs/x').TimeRange>]>>;
|
|
41
|
+
dataType: z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<import('@synnaxlabs/x').DataType, string>>, z.ZodCustom<import('@synnaxlabs/x').DataType, import('@synnaxlabs/x').DataType>]>;
|
|
42
|
+
alignment: z.ZodOptional<z.ZodCoercedBigInt<unknown>>;
|
|
43
|
+
data: z.ZodUnion<readonly [z.ZodPipe<z.ZodString, z.ZodTransform<ArrayBuffer, string>>, z.ZodPipe<z.ZodUnion<readonly [z.ZodNull, z.ZodUndefined]>, z.ZodTransform<ArrayBuffer, null | undefined>>, z.ZodCustom<ArrayBuffer, ArrayBuffer>, z.ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>]>;
|
|
39
44
|
glBufferUsage: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
|
|
40
45
|
static: "static";
|
|
41
46
|
dynamic: "dynamic";
|
|
42
47
|
}>>>>;
|
|
43
|
-
},
|
|
44
|
-
},
|
|
45
|
-
},
|
|
46
|
-
|
|
48
|
+
}, z.core.$strip>>>>]>;
|
|
49
|
+
}, z.core.$strip>;
|
|
50
|
+
}, z.core.$strip>;
|
|
51
|
+
/**
|
|
52
|
+
* Response interface for streaming frames from a Synnax cluster.
|
|
53
|
+
* Contains a frame of telemetry data.
|
|
54
|
+
*/
|
|
55
|
+
export interface StreamerResponse extends z.infer<typeof resZ> {
|
|
56
|
+
}
|
|
57
|
+
/**
|
|
58
|
+
* Configuration options for creating a new streamer.
|
|
59
|
+
*/
|
|
47
60
|
export interface StreamerConfig {
|
|
61
|
+
/** The channels to stream data from. Can be channel keys, names, or payloads. */
|
|
48
62
|
channels: channel.Params;
|
|
49
|
-
|
|
63
|
+
/** Optional factor to downsample the data by. Defaults to 1 (no downsampling). */
|
|
64
|
+
downsampleFactor?: number;
|
|
65
|
+
/** Whether to use the experimental codec for streaming. Defaults to false. */
|
|
50
66
|
useExperimentalCodec?: boolean;
|
|
51
67
|
}
|
|
68
|
+
/**
|
|
69
|
+
* A streamer is used to stream frames of telemetry in real-time from a Synnax cluster.
|
|
70
|
+
* It should not be constructed directly, and should instead be created using the
|
|
71
|
+
* client's openStreamer method.
|
|
72
|
+
*
|
|
73
|
+
* To open a streamer, use the openStreamer method on the client and pass it in the list
|
|
74
|
+
* of channels you'd like to receive data from. Once the streamer has been opened, call
|
|
75
|
+
* the `read` method to read the next frame of telemetry, or use the streamer as an
|
|
76
|
+
* async iterator to iterate over the frames of telemetry as they are received.
|
|
77
|
+
*
|
|
78
|
+
* The list of channels being streamed can be updated at any time by using the `update`
|
|
79
|
+
* method.
|
|
80
|
+
*
|
|
81
|
+
* Once done, call the `close` method to close the streamer and free all associated
|
|
82
|
+
* resources. We recommend using the streamer within a try-finally block to ensure
|
|
83
|
+
* that it is closed properly in the event of an error.
|
|
84
|
+
*
|
|
85
|
+
* For details documentation, see https://docs.synnaxlabs.com/reference/typescript-client/stream-data
|
|
86
|
+
*/
|
|
52
87
|
export interface Streamer extends AsyncIterator<Frame>, AsyncIterable<Frame> {
|
|
88
|
+
/** The keys of the channels currently being streamed from. */
|
|
53
89
|
keys: channel.Key[];
|
|
90
|
+
/**
|
|
91
|
+
* Update the list of channels being streamed from. This replaces the list of channels
|
|
92
|
+
* being streamed from with the new list of channels.
|
|
93
|
+
*/
|
|
54
94
|
update: (channels: channel.Params) => Promise<void>;
|
|
95
|
+
/** Close the streamer and free all associated resources. */
|
|
55
96
|
close: () => void;
|
|
97
|
+
/** Read the next frame of telemetry. */
|
|
56
98
|
read: () => Promise<Frame>;
|
|
57
99
|
}
|
|
100
|
+
/**
|
|
101
|
+
* A function that opens a streamer.
|
|
102
|
+
*/
|
|
58
103
|
export interface StreamOpener {
|
|
59
104
|
(config: StreamerConfig | channel.Params): Promise<Streamer>;
|
|
60
105
|
}
|
|
106
|
+
export declare const parseStreamerConfig: (config: StreamerConfig | channel.Params) => StreamerConfig;
|
|
107
|
+
/**
|
|
108
|
+
* Creates a function that opens streamers with the given retriever and client.
|
|
109
|
+
* @param retriever - The channel retriever to use for resolving channel information
|
|
110
|
+
* @param client - The WebSocket client to use for streaming
|
|
111
|
+
* @returns A function that opens streamers with the given configuration
|
|
112
|
+
*/
|
|
61
113
|
export declare const createStreamOpener: (retriever: channel.Retriever, client: WebSocketClient) => StreamOpener;
|
|
114
|
+
/**
|
|
115
|
+
* Opens a new streamer with the given configuration.
|
|
116
|
+
* @param retriever - The channel retriever to use for resolving channel information
|
|
117
|
+
* @param client - The WebSocket client to use for streaming
|
|
118
|
+
* @param config - The configuration for the streamer
|
|
119
|
+
* @returns A promise that resolves to a new streamer
|
|
120
|
+
*/
|
|
62
121
|
export declare const openStreamer: (retriever: channel.Retriever, client: WebSocketClient, config: StreamerConfig) => Promise<Streamer>;
|
|
122
|
+
/**
|
|
123
|
+
* A hardened streamer that automatically reconnects on failure.
|
|
124
|
+
* This streamer wraps a regular streamer and adds automatic reconnection
|
|
125
|
+
* logic when the connection is lost or errors occur.
|
|
126
|
+
*/
|
|
63
127
|
export declare class HardenedStreamer implements Streamer {
|
|
64
128
|
private wrapped_;
|
|
65
129
|
private readonly breaker;
|
|
66
130
|
private readonly opener;
|
|
67
131
|
private readonly config;
|
|
68
132
|
private constructor();
|
|
69
|
-
|
|
133
|
+
/**
|
|
134
|
+
* Opens a new hardened streamer with the given configuration.
|
|
135
|
+
* @param opener - The function to use for opening streamers
|
|
136
|
+
* @param config - The configuration for the streamer
|
|
137
|
+
* @returns A promise that resolves to a new hardened streamer
|
|
138
|
+
*/
|
|
139
|
+
static open(opener: StreamOpener, config: StreamerConfig | channel.Params, breakerConfig?: breaker.Config): Promise<HardenedStreamer>;
|
|
70
140
|
private runStreamer;
|
|
71
141
|
private get wrapped();
|
|
72
142
|
update(channels: channel.Params): Promise<void>;
|
|
@@ -76,9 +146,20 @@ export declare class HardenedStreamer implements Streamer {
|
|
|
76
146
|
get keys(): channel.Key[];
|
|
77
147
|
[Symbol.asyncIterator](): AsyncIterator<Frame>;
|
|
78
148
|
}
|
|
149
|
+
/**
|
|
150
|
+
* Wraps a standard streamer to implement an observable interface for handling changes
|
|
151
|
+
* to channel values through an onChange handler.
|
|
152
|
+
*/
|
|
79
153
|
export declare class ObservableStreamer<V = Frame> extends observe.Observer<Frame, V> implements observe.ObservableAsyncCloseable<V> {
|
|
80
154
|
private readonly streamer;
|
|
81
155
|
private readonly closePromise;
|
|
156
|
+
/**
|
|
157
|
+
* Creates a new observable streamer.
|
|
158
|
+
* @param streamer - The streamer to wrap
|
|
159
|
+
* @param transform - An optional transform function to apply to each frame
|
|
160
|
+
* @template V - The type of the transformed value. Only relevant if transform is
|
|
161
|
+
* provided. Defaults to Frame.
|
|
162
|
+
*/
|
|
82
163
|
constructor(streamer: Streamer, transform?: observe.Transform<Frame, V>);
|
|
83
164
|
close(): Promise<void>;
|
|
84
165
|
private stream;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"streamer.d.ts","sourceRoot":"","sources":["../../src/framer/streamer.ts"],"names":[],"mappings":"AASA,OAAO,EAAoB,KAAK,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC/E,OAAO,
|
|
1
|
+
{"version":3,"file":"streamer.d.ts","sourceRoot":"","sources":["../../src/framer/streamer.ts"],"names":[],"mappings":"AASA,OAAO,EAAoB,KAAK,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC/E,OAAO,EAAE,OAAO,EAAE,OAAO,EAAY,MAAM,eAAe,CAAC;AAC3D,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAE3B,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAGzC,OAAO,EAAE,KAAK,EAAU,MAAM,gBAAgB,CAAC;AAI/C,QAAA,MAAM,IAAI;;;iBAAuE,CAAC;AAElF;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC;CAAG;AAEhE,QAAA,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAA8B,CAAC;AAEzC;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,CAAC,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC;CAAG;AAIjE;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,iFAAiF;IACjF,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC;IACzB,kFAAkF;IAClF,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,8EAA8E;IAC9E,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,QAAS,SAAQ,aAAa,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC,KAAK,CAAC;IAC1E,8DAA8D;IAC9D,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;IACpB;;;OAGG;IACH,MAAM,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACpD,4DAA4D;IAC5D,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,wCAAwC;IACxC,IAAI,EAAE,MAAM,OAAO,CAAC,KAAK,CAAC,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CAC9D;AAED,eAAO,MAAM,mBAAmB,GAC9B,QAAQ,cAAc,GAAG,OAAO,CAAC,MAAM,KACtC,cAYF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,GAC5B,WAAW,OAAO,CAAC,SAAS,EAAE,QAAQ,eAAe,KAAG,YAYxD,CAAC;AAEJ;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,GACvB,WAAW,OAAO,CAAC,SAAS,EAC5B,QAAQ,eAAe,EACvB,QAAQ,cAAc,KACrB,OAAO,CAAC,QAAQ,CAAwD,CAAC;AAgD5E;;;;GAIG;AACH,qBAAa,gBAAiB,YAAW,QAAQ;IAC/C,OAAO,CAAC,QAAQ,CAAyB;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAkB;IAC1C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;IACtC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;IAExC,OAAO;IAeP;;;;;OAKG;WACU,IAAI,CACf,MAAM,EAAE,YAAY,EACpB,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,EACvC,aAAa,CAAC,EAAE,OAAO,CAAC,MAAM,GAC7B,OAAO,CAAC,gBAAgB,CAAC;YAOd,WAAW;IAezB,OAAO,KAAK,OAAO,GAGlB;IAEK,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAU/C,IAAI,IAAI,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAStC,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC;IAW5B,KAAK,IAAI,IAAI;IAIb,IAAI,IAAI,IAAI,OAAO,CAAC,GAAG,EAAE,CAExB;IAED,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,KAAK,CAAC;CAG/C;AAED;;;GAGG;AACH,qBAAa,kBAAkB,CAAC,CAAC,GAAG,KAAK,CACvC,SAAQ,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CACjC,YAAW,OAAO,CAAC,wBAAwB,CAAC,CAAC,CAAC;IAE9C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAW;IACpC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAgB;IAE7C;;;;;;OAMG;gBACS,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,CAAC;IAMjE,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;YAKd,MAAM;CAGrB"}
|