@synnaxlabs/client 0.1.0 → 0.1.1
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/build/main/index.d.ts +4 -0
- package/build/main/index.js +35 -0
- package/build/main/lib/channel/channel.spec.d.ts +1 -0
- package/build/main/lib/channel/channel.spec.js +35 -0
- package/build/main/lib/channel/client.d.ts +94 -0
- package/build/main/lib/channel/client.js +131 -0
- package/build/main/lib/channel/creator.d.ts +19 -0
- package/build/main/lib/channel/creator.js +44 -0
- package/build/main/lib/channel/payload.d.ts +25 -0
- package/build/main/lib/channel/payload.js +18 -0
- package/build/main/lib/channel/registry.d.ts +9 -0
- package/build/main/lib/channel/registry.js +37 -0
- package/build/main/lib/channel/retriever.d.ts +11 -0
- package/build/main/lib/channel/retriever.js +39 -0
- package/build/main/lib/client.d.ts +23 -0
- package/build/main/lib/client.js +34 -0
- package/build/main/lib/errors.d.ts +53 -0
- package/build/main/lib/errors.js +122 -0
- package/build/main/lib/segment/client.d.ts +62 -0
- package/build/main/lib/segment/client.js +95 -0
- package/build/main/lib/segment/iterator.d.ts +134 -0
- package/build/main/lib/segment/iterator.js +253 -0
- package/build/main/lib/segment/iterator.spec.d.ts +1 -0
- package/build/main/lib/segment/iterator.spec.js +62 -0
- package/build/main/lib/segment/payload.d.ts +16 -0
- package/build/main/lib/segment/payload.js +13 -0
- package/build/main/lib/segment/splitter.d.ts +7 -0
- package/build/main/lib/segment/splitter.js +25 -0
- package/build/main/lib/segment/typed.d.ts +15 -0
- package/build/main/lib/segment/typed.js +49 -0
- package/build/main/lib/segment/validator.d.ts +22 -0
- package/build/main/lib/segment/validator.js +64 -0
- package/build/main/lib/segment/writer.d.ts +98 -0
- package/build/main/lib/segment/writer.js +183 -0
- package/build/main/lib/segment/writer.spec.d.ts +1 -0
- package/build/main/lib/segment/writer.spec.js +76 -0
- package/build/main/lib/telem.d.ts +395 -0
- package/build/main/lib/telem.js +553 -0
- package/build/main/lib/telem.spec.d.ts +1 -0
- package/build/main/lib/telem.spec.js +150 -0
- package/build/main/lib/transport.d.ts +9 -0
- package/build/main/lib/transport.js +18 -0
- package/build/main/lib/util/telem.d.ts +2 -0
- package/build/main/lib/util/telem.js +13 -0
- package/build/module/index.d.ts +4 -0
- package/build/module/index.js +5 -0
- package/build/module/lib/channel/channel.spec.d.ts +1 -0
- package/build/module/lib/channel/channel.spec.js +30 -0
- package/build/module/lib/channel/client.d.ts +94 -0
- package/build/module/lib/channel/client.js +131 -0
- package/build/module/lib/channel/creator.d.ts +19 -0
- package/build/module/lib/channel/creator.js +42 -0
- package/build/module/lib/channel/payload.d.ts +25 -0
- package/build/module/lib/channel/payload.js +15 -0
- package/build/module/lib/channel/registry.d.ts +9 -0
- package/build/module/lib/channel/registry.js +36 -0
- package/build/module/lib/channel/retriever.d.ts +11 -0
- package/build/module/lib/channel/retriever.js +37 -0
- package/build/module/lib/client.d.ts +23 -0
- package/build/module/lib/client.js +31 -0
- package/build/module/lib/errors.d.ts +53 -0
- package/build/module/lib/errors.js +113 -0
- package/build/module/lib/segment/client.d.ts +62 -0
- package/build/module/lib/segment/client.js +94 -0
- package/build/module/lib/segment/iterator.d.ts +134 -0
- package/build/module/lib/segment/iterator.js +248 -0
- package/build/module/lib/segment/iterator.spec.d.ts +1 -0
- package/build/module/lib/segment/iterator.spec.js +57 -0
- package/build/module/lib/segment/payload.d.ts +16 -0
- package/build/module/lib/segment/payload.js +10 -0
- package/build/module/lib/segment/splitter.d.ts +7 -0
- package/build/module/lib/segment/splitter.js +26 -0
- package/build/module/lib/segment/typed.d.ts +15 -0
- package/build/module/lib/segment/typed.js +49 -0
- package/build/module/lib/segment/validator.d.ts +22 -0
- package/build/module/lib/segment/validator.js +60 -0
- package/build/module/lib/segment/writer.d.ts +98 -0
- package/build/module/lib/segment/writer.js +183 -0
- package/build/module/lib/segment/writer.spec.d.ts +1 -0
- package/build/module/lib/segment/writer.spec.js +71 -0
- package/build/module/lib/telem.d.ts +395 -0
- package/build/module/lib/telem.js +545 -0
- package/build/module/lib/telem.spec.d.ts +1 -0
- package/build/module/lib/telem.spec.js +145 -0
- package/build/module/lib/transport.d.ts +9 -0
- package/build/module/lib/transport.js +18 -0
- package/build/module/lib/util/telem.d.ts +2 -0
- package/build/module/lib/util/telem.js +9 -0
- package/package.json +2 -2
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export { default as Synnax } from './lib/client';
|
|
2
|
+
export * from './lib/telem';
|
|
3
|
+
export { AuthError, ContiguityError, GeneralError, ParseError, QueryError, RouteError, UnexpectedError, ValidationError, } from './lib/errors';
|
|
4
|
+
export { Channel } from './lib/channel/client';
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
17
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
18
|
+
};
|
|
19
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
20
|
+
exports.Channel = exports.ValidationError = exports.UnexpectedError = exports.RouteError = exports.QueryError = exports.ParseError = exports.GeneralError = exports.ContiguityError = exports.AuthError = exports.Synnax = void 0;
|
|
21
|
+
var client_1 = require("./lib/client");
|
|
22
|
+
Object.defineProperty(exports, "Synnax", { enumerable: true, get: function () { return __importDefault(client_1).default; } });
|
|
23
|
+
__exportStar(require("./lib/telem"), exports);
|
|
24
|
+
var errors_1 = require("./lib/errors");
|
|
25
|
+
Object.defineProperty(exports, "AuthError", { enumerable: true, get: function () { return errors_1.AuthError; } });
|
|
26
|
+
Object.defineProperty(exports, "ContiguityError", { enumerable: true, get: function () { return errors_1.ContiguityError; } });
|
|
27
|
+
Object.defineProperty(exports, "GeneralError", { enumerable: true, get: function () { return errors_1.GeneralError; } });
|
|
28
|
+
Object.defineProperty(exports, "ParseError", { enumerable: true, get: function () { return errors_1.ParseError; } });
|
|
29
|
+
Object.defineProperty(exports, "QueryError", { enumerable: true, get: function () { return errors_1.QueryError; } });
|
|
30
|
+
Object.defineProperty(exports, "RouteError", { enumerable: true, get: function () { return errors_1.RouteError; } });
|
|
31
|
+
Object.defineProperty(exports, "UnexpectedError", { enumerable: true, get: function () { return errors_1.UnexpectedError; } });
|
|
32
|
+
Object.defineProperty(exports, "ValidationError", { enumerable: true, get: function () { return errors_1.ValidationError; } });
|
|
33
|
+
var client_2 = require("./lib/channel/client");
|
|
34
|
+
Object.defineProperty(exports, "Channel", { enumerable: true, get: function () { return client_2.Channel; } });
|
|
35
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSx1Q0FBaUQ7QUFBeEMsaUhBQUEsT0FBTyxPQUFVO0FBQzFCLDhDQUE0QjtBQUM1Qix1Q0FTc0I7QUFScEIsbUdBQUEsU0FBUyxPQUFBO0FBQ1QseUdBQUEsZUFBZSxPQUFBO0FBQ2Ysc0dBQUEsWUFBWSxPQUFBO0FBQ1osb0dBQUEsVUFBVSxPQUFBO0FBQ1Ysb0dBQUEsVUFBVSxPQUFBO0FBQ1Ysb0dBQUEsVUFBVSxPQUFBO0FBQ1YseUdBQUEsZUFBZSxPQUFBO0FBQ2YseUdBQUEsZUFBZSxPQUFBO0FBRWpCLCtDQUErQztBQUF0QyxpR0FBQSxPQUFPLE9BQUEifQ==
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
const ava_1 = __importDefault(require("ava"));
|
|
7
|
+
const client_1 = __importDefault(require("../client"));
|
|
8
|
+
const telem_1 = require("../telem");
|
|
9
|
+
const client = new client_1.default({ host: 'localhost', port: 8080 });
|
|
10
|
+
(0, ava_1.default)('Channel - create', async (t) => {
|
|
11
|
+
const channel = await client.channel.create({
|
|
12
|
+
name: 'test',
|
|
13
|
+
nodeId: 1,
|
|
14
|
+
rate: telem_1.Rate.Hz(1),
|
|
15
|
+
dataType: telem_1.DataType.Float32,
|
|
16
|
+
});
|
|
17
|
+
t.is(channel.name, 'test');
|
|
18
|
+
t.is(channel.nodeId, 1);
|
|
19
|
+
t.deepEqual(channel.rate, telem_1.Rate.Hz(1));
|
|
20
|
+
t.deepEqual(channel.dataType, telem_1.DataType.Float32);
|
|
21
|
+
});
|
|
22
|
+
(0, ava_1.default)('Channel - retrieve by key', async (t) => {
|
|
23
|
+
const channel = await client.channel.create({
|
|
24
|
+
name: 'test',
|
|
25
|
+
nodeId: 1,
|
|
26
|
+
rate: telem_1.Rate.Hz(1),
|
|
27
|
+
dataType: telem_1.DataType.Float32,
|
|
28
|
+
});
|
|
29
|
+
const retrieved = (await client.channel.retrieveByKeys(channel.key))[0];
|
|
30
|
+
t.is(retrieved.name, 'test');
|
|
31
|
+
t.is(retrieved.nodeId, 1);
|
|
32
|
+
t.deepEqual(retrieved.rate, telem_1.Rate.Hz(1));
|
|
33
|
+
t.deepEqual(retrieved.dataType, telem_1.DataType.Float32);
|
|
34
|
+
});
|
|
35
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2hhbm5lbC5zcGVjLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2xpYi9jaGFubmVsL2NoYW5uZWwuc3BlYy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUFBLDhDQUF1QjtBQUV2Qix1REFBK0I7QUFDL0Isb0NBQTBDO0FBRTFDLE1BQU0sTUFBTSxHQUFHLElBQUksZ0JBQU0sQ0FBQyxFQUFFLElBQUksRUFBRSxXQUFXLEVBQUUsSUFBSSxFQUFFLElBQUksRUFBRSxDQUFDLENBQUM7QUFFN0QsSUFBQSxhQUFJLEVBQUMsa0JBQWtCLEVBQUUsS0FBSyxFQUFFLENBQUMsRUFBRSxFQUFFO0lBQ25DLE1BQU0sT0FBTyxHQUFHLE1BQU0sTUFBTSxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUM7UUFDMUMsSUFBSSxFQUFFLE1BQU07UUFDWixNQUFNLEVBQUUsQ0FBQztRQUNULElBQUksRUFBRSxZQUFJLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQztRQUNoQixRQUFRLEVBQUUsZ0JBQVEsQ0FBQyxPQUFPO0tBQzNCLENBQUMsQ0FBQztJQUNILENBQUMsQ0FBQyxFQUFFLENBQUMsT0FBTyxDQUFDLElBQUksRUFBRSxNQUFNLENBQUMsQ0FBQztJQUMzQixDQUFDLENBQUMsRUFBRSxDQUFDLE9BQU8sQ0FBQyxNQUFNLEVBQUUsQ0FBQyxDQUFDLENBQUM7SUFDeEIsQ0FBQyxDQUFDLFNBQVMsQ0FBQyxPQUFPLENBQUMsSUFBSSxFQUFFLFlBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUN0QyxDQUFDLENBQUMsU0FBUyxDQUFDLE9BQU8sQ0FBQyxRQUFRLEVBQUUsZ0JBQVEsQ0FBQyxPQUFPLENBQUMsQ0FBQztBQUNsRCxDQUFDLENBQUMsQ0FBQztBQUVILElBQUEsYUFBSSxFQUFDLDJCQUEyQixFQUFFLEtBQUssRUFBRSxDQUFDLEVBQUUsRUFBRTtJQUM1QyxNQUFNLE9BQU8sR0FBRyxNQUFNLE1BQU0sQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDO1FBQzFDLElBQUksRUFBRSxNQUFNO1FBQ1osTUFBTSxFQUFFLENBQUM7UUFDVCxJQUFJLEVBQUUsWUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUM7UUFDaEIsUUFBUSxFQUFFLGdCQUFRLENBQUMsT0FBTztLQUMzQixDQUFDLENBQUM7SUFDSCxNQUFNLFNBQVMsR0FBRyxDQUFDLE1BQU0sTUFBTSxDQUFDLE9BQU8sQ0FBQyxjQUFjLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFDeEUsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxTQUFTLENBQUMsSUFBSSxFQUFFLE1BQU0sQ0FBQyxDQUFDO0lBQzdCLENBQUMsQ0FBQyxFQUFFLENBQUMsU0FBUyxDQUFDLE1BQU0sRUFBRSxDQUFDLENBQUMsQ0FBQztJQUMxQixDQUFDLENBQUMsU0FBUyxDQUFDLFNBQVMsQ0FBQyxJQUFJLEVBQUUsWUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQ3hDLENBQUMsQ0FBQyxTQUFTLENBQUMsU0FBUyxDQUFDLFFBQVEsRUFBRSxnQkFBUSxDQUFDLE9BQU8sQ0FBQyxDQUFDO0FBQ3BELENBQUMsQ0FBQyxDQUFDIn0=
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
import SegmentClient from '../segment/client';
|
|
2
|
+
import { DataType, Density, Rate, TypedArray, UnparsedTimeStamp } from '../telem';
|
|
3
|
+
import ChannelCreator from './creator';
|
|
4
|
+
import { CreateChannelProps } from './creator';
|
|
5
|
+
import { ChannelPayload } from './payload';
|
|
6
|
+
import ChannelRetriever from './retriever';
|
|
7
|
+
/**
|
|
8
|
+
* Represents a Channel in a Synnax database. It should not be instantiated
|
|
9
|
+
* directly, but rather created or retrieved from a {@link ChannelClient}.
|
|
10
|
+
*/
|
|
11
|
+
export declare class Channel {
|
|
12
|
+
private readonly segmentClient;
|
|
13
|
+
private payload;
|
|
14
|
+
constructor(payload: ChannelPayload, segmentClient: SegmentClient);
|
|
15
|
+
get key(): string;
|
|
16
|
+
get name(): string;
|
|
17
|
+
get nodeId(): number;
|
|
18
|
+
get rate(): Rate;
|
|
19
|
+
get dataType(): DataType;
|
|
20
|
+
get density(): Density | undefined;
|
|
21
|
+
/**
|
|
22
|
+
* Reads telemetry from the channel between the two timestamps.
|
|
23
|
+
*
|
|
24
|
+
* @param start - The starting timestamp of the range to read from.
|
|
25
|
+
* @param end - The ending timestamp of the range to read from.
|
|
26
|
+
* @returns a typed array containing the retrieved
|
|
27
|
+
*/
|
|
28
|
+
read(start: UnparsedTimeStamp, end: UnparsedTimeStamp): Promise<TypedArray>;
|
|
29
|
+
/**
|
|
30
|
+
* Writes telemetry to the channel starting at the given timestamp.
|
|
31
|
+
*
|
|
32
|
+
* @param start - The starting timestamp of the first sample in data.
|
|
33
|
+
* @param data - THe telemetry to write to the channel.
|
|
34
|
+
*/
|
|
35
|
+
write(start: UnparsedTimeStamp, data: TypedArray): Promise<boolean>;
|
|
36
|
+
}
|
|
37
|
+
/** The core client class for executing channel operations against a Synnax
|
|
38
|
+
* database .
|
|
39
|
+
* */
|
|
40
|
+
export default class ChannelClient {
|
|
41
|
+
private readonly segmentClient;
|
|
42
|
+
private readonly retriever;
|
|
43
|
+
private readonly creator;
|
|
44
|
+
constructor(segmentClient: SegmentClient, retriever: ChannelRetriever, creator: ChannelCreator);
|
|
45
|
+
/**
|
|
46
|
+
* Creates a new channel with the given properties.
|
|
47
|
+
*
|
|
48
|
+
* @param props.rate - The rate of the channel.
|
|
49
|
+
* @param props.dataType - The data type of the channel.
|
|
50
|
+
* @param props.name - The name of the channel. Optional.
|
|
51
|
+
* @param props.nodeId - The ID of the node that holds the lease on the channel.
|
|
52
|
+
* If you don't know what this is, don't worry about it.
|
|
53
|
+
* @returns the created channel.
|
|
54
|
+
*/
|
|
55
|
+
create(props: CreateChannelProps): Promise<Channel>;
|
|
56
|
+
/**
|
|
57
|
+
* creates N channels using the given parameters as a template.
|
|
58
|
+
*
|
|
59
|
+
* @param props.rate - The rate of the channel.
|
|
60
|
+
* @param props.dataType - The data type of the channel.
|
|
61
|
+
* @param props.name - The name of the channel. Optional.
|
|
62
|
+
* @param props.nodeId - The ID of the node that holds the lease on the channel.
|
|
63
|
+
* If you don't know what this is, don't worry about it.
|
|
64
|
+
* @param props.count - The number of channels to create.
|
|
65
|
+
* @returns the created channels.
|
|
66
|
+
*/
|
|
67
|
+
createMany(props: CreateChannelProps & {
|
|
68
|
+
count: number;
|
|
69
|
+
}): Promise<Channel[]>;
|
|
70
|
+
/**
|
|
71
|
+
* Retrieves channels with the given keys.
|
|
72
|
+
*
|
|
73
|
+
* @param keys - The keys of the channels to retrieve.
|
|
74
|
+
* @throws QueryError if any of the channels can't be found.
|
|
75
|
+
* @returns the retrieved channels.
|
|
76
|
+
*/
|
|
77
|
+
retrieveByKeys(...keys: string[]): Promise<Channel[]>;
|
|
78
|
+
/**
|
|
79
|
+
* Retrieves channels with the given names.
|
|
80
|
+
*
|
|
81
|
+
* @param names - The list of names to retrieve channels for.
|
|
82
|
+
* @returns A list of retrieved channels matching the given names. If a channel
|
|
83
|
+
* with a given name can't be found, it will be omitted from the list.
|
|
84
|
+
*/
|
|
85
|
+
retrieveByNames(...names: string[]): Promise<Channel[]>;
|
|
86
|
+
/**
|
|
87
|
+
* Retrieves channels whose lease node is the given ID.
|
|
88
|
+
*
|
|
89
|
+
* @param nodeId - The ID of the node to retrieve channels for.
|
|
90
|
+
* @returns A list of retrieved channels matching the given node ID.
|
|
91
|
+
*/
|
|
92
|
+
retrieveByNodeID(nodeId: number): Promise<Channel[]>;
|
|
93
|
+
private sugar;
|
|
94
|
+
}
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Channel = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Represents a Channel in a Synnax database. It should not be instantiated
|
|
6
|
+
* directly, but rather created or retrieved from a {@link ChannelClient}.
|
|
7
|
+
*/
|
|
8
|
+
class Channel {
|
|
9
|
+
constructor(payload, segmentClient) {
|
|
10
|
+
this.payload = payload;
|
|
11
|
+
this.segmentClient = segmentClient;
|
|
12
|
+
}
|
|
13
|
+
get key() {
|
|
14
|
+
if (!this.payload.key) {
|
|
15
|
+
throw new Error('Channel key is not set');
|
|
16
|
+
}
|
|
17
|
+
return this.payload.key;
|
|
18
|
+
}
|
|
19
|
+
get name() {
|
|
20
|
+
if (!this.payload.name) {
|
|
21
|
+
throw new Error('Channel name is not set');
|
|
22
|
+
}
|
|
23
|
+
return this.payload.name;
|
|
24
|
+
}
|
|
25
|
+
get nodeId() {
|
|
26
|
+
if (this.payload.nodeId === undefined) {
|
|
27
|
+
throw new Error('Channel nodeId is not set');
|
|
28
|
+
}
|
|
29
|
+
return this.payload.nodeId;
|
|
30
|
+
}
|
|
31
|
+
get rate() {
|
|
32
|
+
return this.payload.rate;
|
|
33
|
+
}
|
|
34
|
+
get dataType() {
|
|
35
|
+
return this.payload.dataType;
|
|
36
|
+
}
|
|
37
|
+
get density() {
|
|
38
|
+
return this.payload.density;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Reads telemetry from the channel between the two timestamps.
|
|
42
|
+
*
|
|
43
|
+
* @param start - The starting timestamp of the range to read from.
|
|
44
|
+
* @param end - The ending timestamp of the range to read from.
|
|
45
|
+
* @returns a typed array containing the retrieved
|
|
46
|
+
*/
|
|
47
|
+
async read(start, end) {
|
|
48
|
+
return await this.segmentClient.read(this.key, start, end);
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Writes telemetry to the channel starting at the given timestamp.
|
|
52
|
+
*
|
|
53
|
+
* @param start - The starting timestamp of the first sample in data.
|
|
54
|
+
* @param data - THe telemetry to write to the channel.
|
|
55
|
+
*/
|
|
56
|
+
async write(start, data) {
|
|
57
|
+
return await this.segmentClient.write(this.key, start, data);
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
exports.Channel = Channel;
|
|
61
|
+
/** The core client class for executing channel operations against a Synnax
|
|
62
|
+
* database .
|
|
63
|
+
* */
|
|
64
|
+
class ChannelClient {
|
|
65
|
+
constructor(segmentClient, retriever, creator) {
|
|
66
|
+
this.segmentClient = segmentClient;
|
|
67
|
+
this.retriever = retriever;
|
|
68
|
+
this.creator = creator;
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* Creates a new channel with the given properties.
|
|
72
|
+
*
|
|
73
|
+
* @param props.rate - The rate of the channel.
|
|
74
|
+
* @param props.dataType - The data type of the channel.
|
|
75
|
+
* @param props.name - The name of the channel. Optional.
|
|
76
|
+
* @param props.nodeId - The ID of the node that holds the lease on the channel.
|
|
77
|
+
* If you don't know what this is, don't worry about it.
|
|
78
|
+
* @returns the created channel.
|
|
79
|
+
*/
|
|
80
|
+
async create(props) {
|
|
81
|
+
return this.sugar(await this.creator.create(props))[0];
|
|
82
|
+
}
|
|
83
|
+
/**
|
|
84
|
+
* creates N channels using the given parameters as a template.
|
|
85
|
+
*
|
|
86
|
+
* @param props.rate - The rate of the channel.
|
|
87
|
+
* @param props.dataType - The data type of the channel.
|
|
88
|
+
* @param props.name - The name of the channel. Optional.
|
|
89
|
+
* @param props.nodeId - The ID of the node that holds the lease on the channel.
|
|
90
|
+
* If you don't know what this is, don't worry about it.
|
|
91
|
+
* @param props.count - The number of channels to create.
|
|
92
|
+
* @returns the created channels.
|
|
93
|
+
*/
|
|
94
|
+
async createMany(props) {
|
|
95
|
+
return this.sugar(...(await this.creator.createMany(props)));
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
* Retrieves channels with the given keys.
|
|
99
|
+
*
|
|
100
|
+
* @param keys - The keys of the channels to retrieve.
|
|
101
|
+
* @throws QueryError if any of the channels can't be found.
|
|
102
|
+
* @returns the retrieved channels.
|
|
103
|
+
*/
|
|
104
|
+
async retrieveByKeys(...keys) {
|
|
105
|
+
return this.sugar(...(await this.retriever.retrieveByKeys(...keys)));
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* Retrieves channels with the given names.
|
|
109
|
+
*
|
|
110
|
+
* @param names - The list of names to retrieve channels for.
|
|
111
|
+
* @returns A list of retrieved channels matching the given names. If a channel
|
|
112
|
+
* with a given name can't be found, it will be omitted from the list.
|
|
113
|
+
*/
|
|
114
|
+
async retrieveByNames(...names) {
|
|
115
|
+
return this.sugar(...(await this.retriever.retrieveByNames(...names)));
|
|
116
|
+
}
|
|
117
|
+
/**
|
|
118
|
+
* Retrieves channels whose lease node is the given ID.
|
|
119
|
+
*
|
|
120
|
+
* @param nodeId - The ID of the node to retrieve channels for.
|
|
121
|
+
* @returns A list of retrieved channels matching the given node ID.
|
|
122
|
+
*/
|
|
123
|
+
async retrieveByNodeID(nodeId) {
|
|
124
|
+
return this.sugar(...(await this.retriever.retrieveByNodeID(nodeId)));
|
|
125
|
+
}
|
|
126
|
+
sugar(...payloads) {
|
|
127
|
+
return payloads.map((p) => new Channel(p, this.segmentClient));
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
exports.default = ChannelClient;
|
|
131
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpZW50LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2xpYi9jaGFubmVsL2NsaWVudC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFjQTs7O0dBR0c7QUFDSCxNQUFhLE9BQU87SUFJbEIsWUFBWSxPQUF1QixFQUFFLGFBQTRCO1FBQy9ELElBQUksQ0FBQyxPQUFPLEdBQUcsT0FBTyxDQUFDO1FBQ3ZCLElBQUksQ0FBQyxhQUFhLEdBQUcsYUFBYSxDQUFDO0lBQ3JDLENBQUM7SUFFRCxJQUFJLEdBQUc7UUFDTCxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUU7WUFDckIsTUFBTSxJQUFJLEtBQUssQ0FBQyx3QkFBd0IsQ0FBQyxDQUFDO1NBQzNDO1FBQ0QsT0FBTyxJQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQztJQUMxQixDQUFDO0lBRUQsSUFBSSxJQUFJO1FBQ04sSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsSUFBSSxFQUFFO1lBQ3RCLE1BQU0sSUFBSSxLQUFLLENBQUMseUJBQXlCLENBQUMsQ0FBQztTQUM1QztRQUNELE9BQU8sSUFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUM7SUFDM0IsQ0FBQztJQUVELElBQUksTUFBTTtRQUNSLElBQUksSUFBSSxDQUFDLE9BQU8sQ0FBQyxNQUFNLEtBQUssU0FBUyxFQUFFO1lBQ3JDLE1BQU0sSUFBSSxLQUFLLENBQUMsMkJBQTJCLENBQUMsQ0FBQztTQUM5QztRQUNELE9BQU8sSUFBSSxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUM7SUFDN0IsQ0FBQztJQUVELElBQUksSUFBSTtRQUNOLE9BQU8sSUFBSSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUM7SUFDM0IsQ0FBQztJQUVELElBQUksUUFBUTtRQUNWLE9BQU8sSUFBSSxDQUFDLE9BQU8sQ0FBQyxRQUFRLENBQUM7SUFDL0IsQ0FBQztJQUVELElBQUksT0FBTztRQUNULE9BQU8sSUFBSSxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUM7SUFDOUIsQ0FBQztJQUVEOzs7Ozs7T0FNRztJQUNILEtBQUssQ0FBQyxJQUFJLENBQ1IsS0FBd0IsRUFDeEIsR0FBc0I7UUFFdEIsT0FBTyxNQUFNLElBQUksQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUUsS0FBSyxFQUFFLEdBQUcsQ0FBQyxDQUFDO0lBQzdELENBQUM7SUFFRDs7Ozs7T0FLRztJQUNILEtBQUssQ0FBQyxLQUFLLENBQUMsS0FBd0IsRUFBRSxJQUFnQjtRQUNwRCxPQUFPLE1BQU0sSUFBSSxDQUFDLGFBQWEsQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRSxLQUFLLEVBQUUsSUFBSSxDQUFDLENBQUM7SUFDL0QsQ0FBQztDQUNGO0FBakVELDBCQWlFQztBQUVEOztLQUVLO0FBQ0wsTUFBcUIsYUFBYTtJQUtoQyxZQUNFLGFBQTRCLEVBQzVCLFNBQTJCLEVBQzNCLE9BQXVCO1FBRXZCLElBQUksQ0FBQyxhQUFhLEdBQUcsYUFBYSxDQUFDO1FBQ25DLElBQUksQ0FBQyxTQUFTLEdBQUcsU0FBUyxDQUFDO1FBQzNCLElBQUksQ0FBQyxPQUFPLEdBQUcsT0FBTyxDQUFDO0lBQ3pCLENBQUM7SUFFRDs7Ozs7Ozs7O09BU0c7SUFDSCxLQUFLLENBQUMsTUFBTSxDQUFDLEtBQXlCO1FBQ3BDLE9BQU8sSUFBSSxDQUFDLEtBQUssQ0FBQyxNQUFNLElBQUksQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFDekQsQ0FBQztJQUVEOzs7Ozs7Ozs7O09BVUc7SUFDSCxLQUFLLENBQUMsVUFBVSxDQUNkLEtBQTZDO1FBRTdDLE9BQU8sSUFBSSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsTUFBTSxJQUFJLENBQUMsT0FBTyxDQUFDLFVBQVUsQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFDL0QsQ0FBQztJQUVEOzs7Ozs7T0FNRztJQUNILEtBQUssQ0FBQyxjQUFjLENBQUMsR0FBRyxJQUFjO1FBQ3BDLE9BQU8sSUFBSSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsTUFBTSxJQUFJLENBQUMsU0FBUyxDQUFDLGNBQWMsQ0FBQyxHQUFHLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUN2RSxDQUFDO0lBRUQ7Ozs7OztPQU1HO0lBQ0gsS0FBSyxDQUFDLGVBQWUsQ0FBQyxHQUFHLEtBQWU7UUFDdEMsT0FBTyxJQUFJLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxNQUFNLElBQUksQ0FBQyxTQUFTLENBQUMsZUFBZSxDQUFDLEdBQUcsS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQ3pFLENBQUM7SUFFRDs7Ozs7T0FLRztJQUNILEtBQUssQ0FBQyxnQkFBZ0IsQ0FBQyxNQUFjO1FBQ25DLE9BQU8sSUFBSSxDQUFDLEtBQUssQ0FBQyxHQUFHLENBQUMsTUFBTSxJQUFJLENBQUMsU0FBUyxDQUFDLGdCQUFnQixDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUN4RSxDQUFDO0lBRU8sS0FBSyxDQUFDLEdBQUcsUUFBMEI7UUFDekMsT0FBTyxRQUFRLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxJQUFJLE9BQU8sQ0FBQyxDQUFDLEVBQUUsSUFBSSxDQUFDLGFBQWEsQ0FBQyxDQUFDLENBQUM7SUFDakUsQ0FBQztDQUNGO0FBakZELGdDQWlGQyJ9
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { UnparsedDataType, UnparsedRate } from '../telem';
|
|
2
|
+
import Transport from '../transport';
|
|
3
|
+
import { ChannelPayload } from './payload';
|
|
4
|
+
export declare type CreateChannelProps = {
|
|
5
|
+
rate: UnparsedRate;
|
|
6
|
+
dataType: UnparsedDataType;
|
|
7
|
+
name?: string;
|
|
8
|
+
nodeId?: number;
|
|
9
|
+
};
|
|
10
|
+
export default class Creator {
|
|
11
|
+
private static ENDPOINT;
|
|
12
|
+
private client;
|
|
13
|
+
constructor(transport: Transport);
|
|
14
|
+
create(props: CreateChannelProps): Promise<ChannelPayload>;
|
|
15
|
+
createMany({ rate, dataType, name, nodeId, count, }: CreateChannelProps & {
|
|
16
|
+
count: number;
|
|
17
|
+
}): Promise<ChannelPayload[]>;
|
|
18
|
+
private execute;
|
|
19
|
+
}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const zod_1 = require("zod");
|
|
4
|
+
const telem_1 = require("../telem");
|
|
5
|
+
const payload_1 = require("./payload");
|
|
6
|
+
const RequestSchema = zod_1.z.object({
|
|
7
|
+
channel: payload_1.ChannelPayloadSchema,
|
|
8
|
+
count: zod_1.z.number(),
|
|
9
|
+
});
|
|
10
|
+
const ResponseSchema = zod_1.z.object({
|
|
11
|
+
channels: payload_1.ChannelPayloadSchema.array(),
|
|
12
|
+
});
|
|
13
|
+
class Creator {
|
|
14
|
+
constructor(transport) {
|
|
15
|
+
this.client = transport.postClient();
|
|
16
|
+
}
|
|
17
|
+
async create(props) {
|
|
18
|
+
const [channel] = await this.createMany(Object.assign(Object.assign({}, props), { count: 1 }));
|
|
19
|
+
return channel;
|
|
20
|
+
}
|
|
21
|
+
async createMany({ rate, dataType, name = '', nodeId = 0, count = 1, }) {
|
|
22
|
+
return (await this.execute({
|
|
23
|
+
channel: {
|
|
24
|
+
name,
|
|
25
|
+
nodeId,
|
|
26
|
+
rate: new telem_1.Rate(rate),
|
|
27
|
+
dataType: new telem_1.DataType(dataType),
|
|
28
|
+
},
|
|
29
|
+
count,
|
|
30
|
+
})).channels;
|
|
31
|
+
}
|
|
32
|
+
async execute(request) {
|
|
33
|
+
const [res, err] = await this.client.send(Creator.ENDPOINT, request,
|
|
34
|
+
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
35
|
+
// @ts-ignore
|
|
36
|
+
ResponseSchema);
|
|
37
|
+
if (err)
|
|
38
|
+
throw err;
|
|
39
|
+
return res;
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
exports.default = Creator;
|
|
43
|
+
Creator.ENDPOINT = '/channel/create';
|
|
44
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY3JlYXRvci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9saWIvY2hhbm5lbC9jcmVhdG9yLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQ0EsNkJBQXdCO0FBRXhCLG9DQUEwRTtBQUcxRSx1Q0FBaUU7QUFFakUsTUFBTSxhQUFhLEdBQUcsT0FBQyxDQUFDLE1BQU0sQ0FBQztJQUM3QixPQUFPLEVBQUUsOEJBQW9CO0lBQzdCLEtBQUssRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO0NBQ2xCLENBQUMsQ0FBQztBQUlILE1BQU0sY0FBYyxHQUFHLE9BQUMsQ0FBQyxNQUFNLENBQUM7SUFDOUIsUUFBUSxFQUFFLDhCQUFvQixDQUFDLEtBQUssRUFBRTtDQUN2QyxDQUFDLENBQUM7QUFXSCxNQUFxQixPQUFPO0lBSTFCLFlBQVksU0FBb0I7UUFDOUIsSUFBSSxDQUFDLE1BQU0sR0FBRyxTQUFTLENBQUMsVUFBVSxFQUFFLENBQUM7SUFDdkMsQ0FBQztJQUVELEtBQUssQ0FBQyxNQUFNLENBQUMsS0FBeUI7UUFDcEMsTUFBTSxDQUFDLE9BQU8sQ0FBQyxHQUFHLE1BQU0sSUFBSSxDQUFDLFVBQVUsaUNBQU0sS0FBSyxLQUFFLEtBQUssRUFBRSxDQUFDLElBQUcsQ0FBQztRQUNoRSxPQUFPLE9BQU8sQ0FBQztJQUNqQixDQUFDO0lBRUQsS0FBSyxDQUFDLFVBQVUsQ0FBQyxFQUNmLElBQUksRUFDSixRQUFRLEVBQ1IsSUFBSSxHQUFHLEVBQUUsRUFDVCxNQUFNLEdBQUcsQ0FBQyxFQUNWLEtBQUssR0FBRyxDQUFDLEdBQzhCO1FBQ3ZDLE9BQU8sQ0FDTCxNQUFNLElBQUksQ0FBQyxPQUFPLENBQUM7WUFDakIsT0FBTyxFQUFFO2dCQUNQLElBQUk7Z0JBQ0osTUFBTTtnQkFDTixJQUFJLEVBQUUsSUFBSSxZQUFJLENBQUMsSUFBSSxDQUFDO2dCQUNwQixRQUFRLEVBQUUsSUFBSSxnQkFBUSxDQUFDLFFBQVEsQ0FBQzthQUNqQztZQUNELEtBQUs7U0FDTixDQUFDLENBQ0gsQ0FBQyxRQUFRLENBQUM7SUFDYixDQUFDO0lBRU8sS0FBSyxDQUFDLE9BQU8sQ0FBQyxPQUFnQjtRQUNwQyxNQUFNLENBQUMsR0FBRyxFQUFFLEdBQUcsQ0FBQyxHQUFHLE1BQU0sSUFBSSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQ3ZDLE9BQU8sQ0FBQyxRQUFRLEVBQ2hCLE9BQU87UUFDUCw2REFBNkQ7UUFDN0QsYUFBYTtRQUNiLGNBQWMsQ0FDZixDQUFDO1FBQ0YsSUFBSSxHQUFHO1lBQUUsTUFBTSxHQUFHLENBQUM7UUFDbkIsT0FBTyxHQUFlLENBQUM7SUFDekIsQ0FBQzs7QUEzQ0gsMEJBNENDO0FBM0NnQixnQkFBUSxHQUFHLGlCQUFpQixDQUFDIn0=
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { DataType, Density, Rate } from '../telem';
|
|
3
|
+
export declare const ChannelPayloadSchema: z.ZodObject<{
|
|
4
|
+
rate: z.ZodEffects<z.ZodNumber, Rate, number>;
|
|
5
|
+
dataType: z.ZodEffects<z.ZodString, DataType, string>;
|
|
6
|
+
key: z.ZodOptional<z.ZodDefault<z.ZodString>>;
|
|
7
|
+
name: z.ZodOptional<z.ZodDefault<z.ZodString>>;
|
|
8
|
+
nodeId: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
|
|
9
|
+
density: z.ZodOptional<z.ZodEffects<z.ZodDefault<z.ZodNumber>, Density, number | undefined>>;
|
|
10
|
+
}, "strip", z.ZodTypeAny, {
|
|
11
|
+
density?: Density | undefined;
|
|
12
|
+
key?: string | undefined;
|
|
13
|
+
name?: string | undefined;
|
|
14
|
+
nodeId?: number | undefined;
|
|
15
|
+
rate: Rate;
|
|
16
|
+
dataType: DataType;
|
|
17
|
+
}, {
|
|
18
|
+
density?: number | undefined;
|
|
19
|
+
key?: string | undefined;
|
|
20
|
+
name?: string | undefined;
|
|
21
|
+
nodeId?: number | undefined;
|
|
22
|
+
rate: number;
|
|
23
|
+
dataType: string;
|
|
24
|
+
}>;
|
|
25
|
+
export declare type ChannelPayload = z.infer<typeof ChannelPayloadSchema>;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ChannelPayloadSchema = void 0;
|
|
4
|
+
const zod_1 = require("zod");
|
|
5
|
+
const telem_1 = require("../telem");
|
|
6
|
+
exports.ChannelPayloadSchema = zod_1.z.object({
|
|
7
|
+
rate: zod_1.z.number().transform((n) => new telem_1.Rate(n)),
|
|
8
|
+
dataType: zod_1.z.string().transform((s) => new telem_1.DataType(s)),
|
|
9
|
+
key: zod_1.z.string().default('').optional(),
|
|
10
|
+
name: zod_1.z.string().default('').optional(),
|
|
11
|
+
nodeId: zod_1.z.number().default(0).optional(),
|
|
12
|
+
density: zod_1.z
|
|
13
|
+
.number()
|
|
14
|
+
.default(0)
|
|
15
|
+
.transform((n) => new telem_1.Density(n))
|
|
16
|
+
.optional(),
|
|
17
|
+
});
|
|
18
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicGF5bG9hZC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9saWIvY2hhbm5lbC9wYXlsb2FkLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLDZCQUF3QjtBQUV4QixvQ0FBbUQ7QUFFdEMsUUFBQSxvQkFBb0IsR0FBRyxPQUFDLENBQUMsTUFBTSxDQUFDO0lBQzNDLElBQUksRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFLENBQUMsU0FBUyxDQUFDLENBQUMsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxJQUFJLFlBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUM5QyxRQUFRLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBQUMsRUFBRSxFQUFFLENBQUMsSUFBSSxnQkFBUSxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQ3RELEdBQUcsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFLENBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQyxDQUFDLFFBQVEsRUFBRTtJQUN0QyxJQUFJLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLE9BQU8sQ0FBQyxFQUFFLENBQUMsQ0FBQyxRQUFRLEVBQUU7SUFDdkMsTUFBTSxFQUFFLE9BQUMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLENBQUMsUUFBUSxFQUFFO0lBQ3hDLE9BQU8sRUFBRSxPQUFDO1NBQ1AsTUFBTSxFQUFFO1NBQ1IsT0FBTyxDQUFDLENBQUMsQ0FBQztTQUNWLFNBQVMsQ0FBQyxDQUFDLENBQUMsRUFBRSxFQUFFLENBQUMsSUFBSSxlQUFPLENBQUMsQ0FBQyxDQUFDLENBQUM7U0FDaEMsUUFBUSxFQUFFO0NBQ2QsQ0FBQyxDQUFDIn0=
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { ChannelPayload } from './payload';
|
|
2
|
+
import Retriever from './retriever';
|
|
3
|
+
export default class Registry {
|
|
4
|
+
private retriever;
|
|
5
|
+
private channels;
|
|
6
|
+
constructor(retriever: Retriever);
|
|
7
|
+
get(key: string): Promise<ChannelPayload>;
|
|
8
|
+
getN(...keys: string[]): Promise<ChannelPayload[]>;
|
|
9
|
+
}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
class Registry {
|
|
4
|
+
constructor(retriever) {
|
|
5
|
+
this.retriever = retriever;
|
|
6
|
+
this.channels = new Map();
|
|
7
|
+
}
|
|
8
|
+
async get(key) {
|
|
9
|
+
let channel = this.channels.get(key);
|
|
10
|
+
if (channel === undefined) {
|
|
11
|
+
channel = (await this.retriever.retrieveByKeys(key))[0];
|
|
12
|
+
this.channels.set(key, channel);
|
|
13
|
+
}
|
|
14
|
+
return channel;
|
|
15
|
+
}
|
|
16
|
+
async getN(...keys) {
|
|
17
|
+
const results = [];
|
|
18
|
+
const retrieveKeys = [];
|
|
19
|
+
keys.forEach((key) => {
|
|
20
|
+
const channel = this.channels.get(key);
|
|
21
|
+
if (channel === undefined)
|
|
22
|
+
retrieveKeys.push(key);
|
|
23
|
+
else
|
|
24
|
+
results.push(channel);
|
|
25
|
+
});
|
|
26
|
+
if (retrieveKeys.length > 0) {
|
|
27
|
+
const channels = await this.retriever.retrieveByKeys(...retrieveKeys);
|
|
28
|
+
channels.forEach((channel) => {
|
|
29
|
+
this.channels.set(channel.key, channel);
|
|
30
|
+
results.push(channel);
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
return results;
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
exports.default = Registry;
|
|
37
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVnaXN0cnkuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvbGliL2NoYW5uZWwvcmVnaXN0cnkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFHQSxNQUFxQixRQUFRO0lBSTNCLFlBQVksU0FBb0I7UUFDOUIsSUFBSSxDQUFDLFNBQVMsR0FBRyxTQUFTLENBQUM7UUFDM0IsSUFBSSxDQUFDLFFBQVEsR0FBRyxJQUFJLEdBQUcsRUFBRSxDQUFDO0lBQzVCLENBQUM7SUFFRCxLQUFLLENBQUMsR0FBRyxDQUFDLEdBQVc7UUFDbkIsSUFBSSxPQUFPLEdBQUcsSUFBSSxDQUFDLFFBQVEsQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDLENBQUM7UUFDckMsSUFBSSxPQUFPLEtBQUssU0FBUyxFQUFFO1lBQ3pCLE9BQU8sR0FBRyxDQUFDLE1BQU0sSUFBSSxDQUFDLFNBQVMsQ0FBQyxjQUFjLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztZQUN4RCxJQUFJLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyxHQUFHLEVBQUUsT0FBTyxDQUFDLENBQUM7U0FDakM7UUFDRCxPQUFPLE9BQU8sQ0FBQztJQUNqQixDQUFDO0lBRUQsS0FBSyxDQUFDLElBQUksQ0FBQyxHQUFHLElBQWM7UUFDMUIsTUFBTSxPQUFPLEdBQXFCLEVBQUUsQ0FBQztRQUNyQyxNQUFNLFlBQVksR0FBYSxFQUFFLENBQUM7UUFDbEMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDLEdBQUcsRUFBRSxFQUFFO1lBQ25CLE1BQU0sT0FBTyxHQUFHLElBQUksQ0FBQyxRQUFRLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxDQUFDO1lBQ3ZDLElBQUksT0FBTyxLQUFLLFNBQVM7Z0JBQUUsWUFBWSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQzs7Z0JBQzdDLE9BQU8sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUM7UUFDN0IsQ0FBQyxDQUFDLENBQUM7UUFDSCxJQUFJLFlBQVksQ0FBQyxNQUFNLEdBQUcsQ0FBQyxFQUFFO1lBQzNCLE1BQU0sUUFBUSxHQUFHLE1BQU0sSUFBSSxDQUFDLFNBQVMsQ0FBQyxjQUFjLENBQUMsR0FBRyxZQUFZLENBQUMsQ0FBQztZQUN0RSxRQUFRLENBQUMsT0FBTyxDQUFDLENBQUMsT0FBTyxFQUFFLEVBQUU7Z0JBQzNCLElBQUksQ0FBQyxRQUFRLENBQUMsR0FBRyxDQUFDLE9BQU8sQ0FBQyxHQUFhLEVBQUUsT0FBTyxDQUFDLENBQUM7Z0JBQ2xELE9BQU8sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUM7WUFDeEIsQ0FBQyxDQUFDLENBQUM7U0FDSjtRQUNELE9BQU8sT0FBTyxDQUFDO0lBQ2pCLENBQUM7Q0FDRjtBQW5DRCwyQkFtQ0MifQ==
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import Transport from '../transport';
|
|
2
|
+
import { ChannelPayload } from './payload';
|
|
3
|
+
export default class Retriever {
|
|
4
|
+
private static ENDPOINT;
|
|
5
|
+
private client;
|
|
6
|
+
constructor(transport: Transport);
|
|
7
|
+
private execute;
|
|
8
|
+
retrieveByKeys(...keys: string[]): Promise<ChannelPayload[]>;
|
|
9
|
+
retrieveByNames(...names: string[]): Promise<ChannelPayload[]>;
|
|
10
|
+
retrieveByNodeID(nodeId: number): Promise<ChannelPayload[]>;
|
|
11
|
+
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const zod_1 = require("zod");
|
|
4
|
+
const payload_1 = require("./payload");
|
|
5
|
+
const RequestSchema = zod_1.z.object({
|
|
6
|
+
keys: zod_1.z.string().array().optional(),
|
|
7
|
+
nodeId: zod_1.z.number().optional(),
|
|
8
|
+
names: zod_1.z.string().array().optional(),
|
|
9
|
+
});
|
|
10
|
+
const ResponseSchema = zod_1.z.object({
|
|
11
|
+
channels: payload_1.ChannelPayloadSchema.array(),
|
|
12
|
+
});
|
|
13
|
+
class Retriever {
|
|
14
|
+
constructor(transport) {
|
|
15
|
+
this.client = transport.getClient();
|
|
16
|
+
}
|
|
17
|
+
async execute(request) {
|
|
18
|
+
const [res, err] = await this.client.send(Retriever.ENDPOINT, request,
|
|
19
|
+
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
20
|
+
// @ts-ignore
|
|
21
|
+
ResponseSchema);
|
|
22
|
+
if (err) {
|
|
23
|
+
throw err;
|
|
24
|
+
}
|
|
25
|
+
return res === null || res === void 0 ? void 0 : res.channels;
|
|
26
|
+
}
|
|
27
|
+
async retrieveByKeys(...keys) {
|
|
28
|
+
return await this.execute({ keys });
|
|
29
|
+
}
|
|
30
|
+
async retrieveByNames(...names) {
|
|
31
|
+
return await this.execute({ names });
|
|
32
|
+
}
|
|
33
|
+
async retrieveByNodeID(nodeId) {
|
|
34
|
+
return await this.execute({ nodeId: nodeId });
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
exports.default = Retriever;
|
|
38
|
+
Retriever.ENDPOINT = '/channel/retrieve';
|
|
39
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmV0cmlldmVyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2xpYi9jaGFubmVsL3JldHJpZXZlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUNBLDZCQUF3QjtBQUl4Qix1Q0FBaUU7QUFFakUsTUFBTSxhQUFhLEdBQUcsT0FBQyxDQUFDLE1BQU0sQ0FBQztJQUM3QixJQUFJLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLEtBQUssRUFBRSxDQUFDLFFBQVEsRUFBRTtJQUNuQyxNQUFNLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLFFBQVEsRUFBRTtJQUM3QixLQUFLLEVBQUUsT0FBQyxDQUFDLE1BQU0sRUFBRSxDQUFDLEtBQUssRUFBRSxDQUFDLFFBQVEsRUFBRTtDQUNyQyxDQUFDLENBQUM7QUFJSCxNQUFNLGNBQWMsR0FBRyxPQUFDLENBQUMsTUFBTSxDQUFDO0lBQzlCLFFBQVEsRUFBRSw4QkFBb0IsQ0FBQyxLQUFLLEVBQUU7Q0FDdkMsQ0FBQyxDQUFDO0FBRUgsTUFBcUIsU0FBUztJQUk1QixZQUFZLFNBQW9CO1FBQzlCLElBQUksQ0FBQyxNQUFNLEdBQUcsU0FBUyxDQUFDLFNBQVMsRUFBRSxDQUFDO0lBQ3RDLENBQUM7SUFFTyxLQUFLLENBQUMsT0FBTyxDQUFDLE9BQWdCO1FBQ3BDLE1BQU0sQ0FBQyxHQUFHLEVBQUUsR0FBRyxDQUFDLEdBQUcsTUFBTSxJQUFJLENBQUMsTUFBTSxDQUFDLElBQUksQ0FDdkMsU0FBUyxDQUFDLFFBQVEsRUFDbEIsT0FBTztRQUNQLDZEQUE2RDtRQUM3RCxhQUFhO1FBQ2IsY0FBYyxDQUNmLENBQUM7UUFDRixJQUFJLEdBQUcsRUFBRTtZQUNQLE1BQU0sR0FBRyxDQUFDO1NBQ1g7UUFDRCxPQUFPLEdBQUcsYUFBSCxHQUFHLHVCQUFILEdBQUcsQ0FBRSxRQUE0QixDQUFDO0lBQzNDLENBQUM7SUFFRCxLQUFLLENBQUMsY0FBYyxDQUFDLEdBQUcsSUFBYztRQUNwQyxPQUFPLE1BQU0sSUFBSSxDQUFDLE9BQU8sQ0FBQyxFQUFFLElBQUksRUFBRSxDQUFDLENBQUM7SUFDdEMsQ0FBQztJQUVELEtBQUssQ0FBQyxlQUFlLENBQUMsR0FBRyxLQUFlO1FBQ3RDLE9BQU8sTUFBTSxJQUFJLENBQUMsT0FBTyxDQUFDLEVBQUUsS0FBSyxFQUFFLENBQUMsQ0FBQztJQUN2QyxDQUFDO0lBRUQsS0FBSyxDQUFDLGdCQUFnQixDQUFDLE1BQWM7UUFDbkMsT0FBTyxNQUFNLElBQUksQ0FBQyxPQUFPLENBQUMsRUFBRSxNQUFNLEVBQUUsTUFBTSxFQUFFLENBQUMsQ0FBQztJQUNoRCxDQUFDOztBQWhDSCw0QkFpQ0M7QUFoQ2dCLGtCQUFRLEdBQUcsbUJBQW1CLENBQUMifQ==
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import ChannelClient from './channel/client';
|
|
2
|
+
import SegmentClient from './segment/client';
|
|
3
|
+
import Transport from './transport';
|
|
4
|
+
export declare type ClientProps = {
|
|
5
|
+
host: string;
|
|
6
|
+
port: number;
|
|
7
|
+
};
|
|
8
|
+
/**
|
|
9
|
+
* Client to perform operations against a Synnax cluster.
|
|
10
|
+
*
|
|
11
|
+
* @property channel - Channel client for creating and retrieving channels.
|
|
12
|
+
* @property data - Data client for reading and writing telemetry.
|
|
13
|
+
*/
|
|
14
|
+
export default class Synnax {
|
|
15
|
+
transport: Transport;
|
|
16
|
+
data: SegmentClient;
|
|
17
|
+
channel: ChannelClient;
|
|
18
|
+
/**
|
|
19
|
+
* @param host - Hostname of a node in the cluster.
|
|
20
|
+
* @param port - Port of the node in the cluster.
|
|
21
|
+
*/
|
|
22
|
+
constructor({ host, port }: ClientProps);
|
|
23
|
+
}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
const freighter_1 = require("@synnaxlabs/freighter");
|
|
7
|
+
const client_1 = __importDefault(require("./channel/client"));
|
|
8
|
+
const creator_1 = __importDefault(require("./channel/creator"));
|
|
9
|
+
const registry_1 = __importDefault(require("./channel/registry"));
|
|
10
|
+
const retriever_1 = __importDefault(require("./channel/retriever"));
|
|
11
|
+
const client_2 = __importDefault(require("./segment/client"));
|
|
12
|
+
const transport_1 = __importDefault(require("./transport"));
|
|
13
|
+
/**
|
|
14
|
+
* Client to perform operations against a Synnax cluster.
|
|
15
|
+
*
|
|
16
|
+
* @property channel - Channel client for creating and retrieving channels.
|
|
17
|
+
* @property data - Data client for reading and writing telemetry.
|
|
18
|
+
*/
|
|
19
|
+
class Synnax {
|
|
20
|
+
/**
|
|
21
|
+
* @param host - Hostname of a node in the cluster.
|
|
22
|
+
* @param port - Port of the node in the cluster.
|
|
23
|
+
*/
|
|
24
|
+
constructor({ host, port }) {
|
|
25
|
+
this.transport = new transport_1.default(new freighter_1.URL({ host, port }));
|
|
26
|
+
const chRetriever = new retriever_1.default(this.transport);
|
|
27
|
+
const chCreator = new creator_1.default(this.transport);
|
|
28
|
+
const chRegistry = new registry_1.default(chRetriever);
|
|
29
|
+
this.data = new client_2.default(this.transport, chRegistry);
|
|
30
|
+
this.channel = new client_1.default(this.data, chRetriever, chCreator);
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
exports.default = Synnax;
|
|
34
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpZW50LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2xpYi9jbGllbnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSxxREFBNEM7QUFFNUMsOERBQTZDO0FBQzdDLGdFQUErQztBQUMvQyxrRUFBMEM7QUFDMUMsb0VBQW1EO0FBQ25ELDhEQUE2QztBQUM3Qyw0REFBb0M7QUFPcEM7Ozs7O0dBS0c7QUFDSCxNQUFxQixNQUFNO0lBS3pCOzs7T0FHRztJQUNILFlBQVksRUFBRSxJQUFJLEVBQUUsSUFBSSxFQUFlO1FBQ3JDLElBQUksQ0FBQyxTQUFTLEdBQUcsSUFBSSxtQkFBUyxDQUFDLElBQUksZUFBRyxDQUFDLEVBQUUsSUFBSSxFQUFFLElBQUksRUFBRSxDQUFDLENBQUMsQ0FBQztRQUN4RCxNQUFNLFdBQVcsR0FBRyxJQUFJLG1CQUFnQixDQUFDLElBQUksQ0FBQyxTQUFTLENBQUMsQ0FBQztRQUN6RCxNQUFNLFNBQVMsR0FBRyxJQUFJLGlCQUFjLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxDQUFDO1FBQ3JELE1BQU0sVUFBVSxHQUFHLElBQUksa0JBQVEsQ0FBQyxXQUFXLENBQUMsQ0FBQztRQUM3QyxJQUFJLENBQUMsSUFBSSxHQUFHLElBQUksZ0JBQWEsQ0FBQyxJQUFJLENBQUMsU0FBUyxFQUFFLFVBQVUsQ0FBQyxDQUFDO1FBQzFELElBQUksQ0FBQyxPQUFPLEdBQUcsSUFBSSxnQkFBYSxDQUFDLElBQUksQ0FBQyxJQUFJLEVBQUUsV0FBVyxFQUFFLFNBQVMsQ0FBQyxDQUFDO0lBQ3RFLENBQUM7Q0FDRjtBQWpCRCx5QkFpQkMifQ==
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import { BaseTypedError } from '@synnaxlabs/freighter';
|
|
2
|
+
export declare type Field = {
|
|
3
|
+
field: string;
|
|
4
|
+
message: string;
|
|
5
|
+
};
|
|
6
|
+
declare class BaseError extends BaseTypedError {
|
|
7
|
+
constructor(message: string);
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* Raised when a validation error occurs.
|
|
11
|
+
*/
|
|
12
|
+
export declare class ValidationError extends BaseError {
|
|
13
|
+
fields: Field[];
|
|
14
|
+
constructor(fieldsOrMessage: string | Field[] | Field);
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* GeneralError is raised when a general error occurs.
|
|
18
|
+
*/
|
|
19
|
+
export declare class GeneralError extends BaseError {
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* ParseError is raised when a parse error occurs.
|
|
23
|
+
*/
|
|
24
|
+
export declare class ParseError extends BaseError {
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* AuthError is raised when an authentication error occurs.
|
|
28
|
+
*/
|
|
29
|
+
export declare class AuthError extends BaseError {
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* UnexpectedError is raised when an unexpected error occurs.
|
|
33
|
+
*/
|
|
34
|
+
export declare class UnexpectedError extends BaseError {
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* QueryError is raised when a query error occurs.
|
|
38
|
+
*/
|
|
39
|
+
export declare class QueryError extends BaseError {
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* RouteError is raised when a routing error occurs.
|
|
43
|
+
*/
|
|
44
|
+
export declare class RouteError extends BaseError {
|
|
45
|
+
path: string;
|
|
46
|
+
constructor(message: string, path: string);
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Raised when time-series data is not contiguous.
|
|
50
|
+
*/
|
|
51
|
+
export declare class ContiguityError extends BaseError {
|
|
52
|
+
}
|
|
53
|
+
export {};
|