@openmeshtak/sdk 0.3.1 → 0.3.3
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/dist/generated/schema.d.ts +193 -4
- package/dist/generated/schema.d.ts.map +1 -1
- package/dist/sbom.cdx.json +4 -4
- package/dist/version.d.ts +3 -3
- package/dist/version.js +3 -3
- package/package.json +3 -3
|
@@ -826,6 +826,26 @@ export interface paths {
|
|
|
826
826
|
patch?: never;
|
|
827
827
|
trace?: never;
|
|
828
828
|
};
|
|
829
|
+
"/system-status": {
|
|
830
|
+
parameters: {
|
|
831
|
+
query?: never;
|
|
832
|
+
header?: never;
|
|
833
|
+
path?: never;
|
|
834
|
+
cookie?: never;
|
|
835
|
+
};
|
|
836
|
+
/**
|
|
837
|
+
* @description Health overview for operators: database, data disk, TAK server, its certificate and recent
|
|
838
|
+
* errors, with a few numbers. Requires instance-wide `server-logs.read`.
|
|
839
|
+
*/
|
|
840
|
+
get: operations["GetSystemStatus"];
|
|
841
|
+
put?: never;
|
|
842
|
+
post?: never;
|
|
843
|
+
delete?: never;
|
|
844
|
+
options?: never;
|
|
845
|
+
head?: never;
|
|
846
|
+
patch?: never;
|
|
847
|
+
trace?: never;
|
|
848
|
+
};
|
|
829
849
|
"/setup": {
|
|
830
850
|
parameters: {
|
|
831
851
|
query?: never;
|
|
@@ -3221,10 +3241,19 @@ export interface components {
|
|
|
3221
3241
|
certificateFile: string;
|
|
3222
3242
|
keyFile: string;
|
|
3223
3243
|
};
|
|
3244
|
+
/** @description An event group or role, as far as the live view needs it for grouping and filtering. */
|
|
3245
|
+
LiveTakAssignmentDto: {
|
|
3246
|
+
id: components["schemas"]["Uuid"];
|
|
3247
|
+
name: string;
|
|
3248
|
+
};
|
|
3224
3249
|
LiveTakConnectionDto: {
|
|
3225
3250
|
id: components["schemas"]["Uuid"];
|
|
3226
3251
|
userId: components["schemas"]["Uuid"];
|
|
3227
3252
|
userDisplayName: string;
|
|
3253
|
+
/** @description The user's group in this event, or null when they are not a member, e.g. an administrator. */
|
|
3254
|
+
eventGroup: components["schemas"]["LiveTakAssignmentDto"] | null;
|
|
3255
|
+
/** @description The user's role in this event, or null when they are not a member. */
|
|
3256
|
+
eventRole: components["schemas"]["LiveTakAssignmentDto"] | null;
|
|
3228
3257
|
/** @description The app's callsign once it reported its position. */
|
|
3229
3258
|
callsign: string | null;
|
|
3230
3259
|
/** Format: date-time */
|
|
@@ -3242,6 +3271,16 @@ export interface components {
|
|
|
3242
3271
|
lat: number;
|
|
3243
3272
|
/** Format: double */
|
|
3244
3273
|
lon: number;
|
|
3274
|
+
/**
|
|
3275
|
+
* Format: double
|
|
3276
|
+
* @description Direction of travel in degrees clockwise from true north (CoT `track/course`), or null when not sent.
|
|
3277
|
+
*/
|
|
3278
|
+
course: number | null;
|
|
3279
|
+
/**
|
|
3280
|
+
* Format: double
|
|
3281
|
+
* @description Ground speed in metres per second (CoT `track/speed`), or null when not sent.
|
|
3282
|
+
*/
|
|
3283
|
+
speed: number | null;
|
|
3245
3284
|
/** Format: date-time */
|
|
3246
3285
|
time: string;
|
|
3247
3286
|
/** Format: date-time */
|
|
@@ -3665,6 +3704,120 @@ export interface components {
|
|
|
3665
3704
|
key: string;
|
|
3666
3705
|
}[];
|
|
3667
3706
|
};
|
|
3707
|
+
/**
|
|
3708
|
+
* @description `off` marks a part that is switched off on purpose, such as a disabled TAK server.
|
|
3709
|
+
* @enum {string}
|
|
3710
|
+
*/
|
|
3711
|
+
SystemCheckState: "ok" | "warning" | "error" | "off";
|
|
3712
|
+
SystemCheckDto: {
|
|
3713
|
+
/** @enum {string} */
|
|
3714
|
+
id: "database" | "storage" | "tak-server" | "tak-certificate" | "errors";
|
|
3715
|
+
state: components["schemas"]["SystemCheckState"];
|
|
3716
|
+
/** @description One plain sentence for operators; never contains secrets. */
|
|
3717
|
+
detail: string;
|
|
3718
|
+
};
|
|
3719
|
+
/** @enum {string} */
|
|
3720
|
+
ServerLogLevel: "trace" | "debug" | "info" | "warn" | "error" | "fatal";
|
|
3721
|
+
/** @description A stored warning or error, sanitized like the server log. */
|
|
3722
|
+
LoggedProblemDto: {
|
|
3723
|
+
time: string | null;
|
|
3724
|
+
level: components["schemas"]["ServerLogLevel"];
|
|
3725
|
+
message: string;
|
|
3726
|
+
/** @description Structured fields as JSON, or null. */
|
|
3727
|
+
details: string | null;
|
|
3728
|
+
};
|
|
3729
|
+
/**
|
|
3730
|
+
* @description Whether system CPU and memory are the container's (cgroup) or the whole machine's.
|
|
3731
|
+
* @enum {string}
|
|
3732
|
+
*/
|
|
3733
|
+
MetricScope: "container" | "host";
|
|
3734
|
+
MetricSampleDto: {
|
|
3735
|
+
time: string;
|
|
3736
|
+
/**
|
|
3737
|
+
* Format: double
|
|
3738
|
+
* @description CPU used by the Core process, as a share of the CPUs it may use (0–100).
|
|
3739
|
+
*/
|
|
3740
|
+
coreCpuPercent: number;
|
|
3741
|
+
/**
|
|
3742
|
+
* Format: double
|
|
3743
|
+
* @description CPU used by the container (against its CPU limit) or the machine, 0–100; see `scope`.
|
|
3744
|
+
*/
|
|
3745
|
+
systemCpuPercent: number;
|
|
3746
|
+
/**
|
|
3747
|
+
* Format: double
|
|
3748
|
+
* @description Resident memory of the Core process.
|
|
3749
|
+
*/
|
|
3750
|
+
coreMemoryBytes: number;
|
|
3751
|
+
/**
|
|
3752
|
+
* Format: double
|
|
3753
|
+
* @description Memory in use by the container or the machine; see `scope`.
|
|
3754
|
+
*/
|
|
3755
|
+
systemMemoryUsedBytes: number;
|
|
3756
|
+
/**
|
|
3757
|
+
* Format: double
|
|
3758
|
+
* @description The container's memory limit (at most the machine's memory) or the machine's memory.
|
|
3759
|
+
*/
|
|
3760
|
+
systemMemoryTotalBytes: number;
|
|
3761
|
+
/** Format: double */
|
|
3762
|
+
takConnections: number;
|
|
3763
|
+
};
|
|
3764
|
+
SystemStatusDto: {
|
|
3765
|
+
/** @description Core release version. */
|
|
3766
|
+
version: string;
|
|
3767
|
+
startedAt: string;
|
|
3768
|
+
checks: components["schemas"]["SystemCheckDto"][];
|
|
3769
|
+
/**
|
|
3770
|
+
* Format: double
|
|
3771
|
+
* @description Database round trip of a trivial query in milliseconds; null when it failed.
|
|
3772
|
+
*/
|
|
3773
|
+
databaseLatencyMs: number | null;
|
|
3774
|
+
/**
|
|
3775
|
+
* Format: double
|
|
3776
|
+
* @description Size of the SQLite database file in bytes; null when unknown.
|
|
3777
|
+
*/
|
|
3778
|
+
databaseBytes: number | null;
|
|
3779
|
+
/**
|
|
3780
|
+
* Format: double
|
|
3781
|
+
* @description Bytes of stored files (Data Package content, icon sets).
|
|
3782
|
+
*/
|
|
3783
|
+
storedFileBytes: number;
|
|
3784
|
+
/**
|
|
3785
|
+
* Format: double
|
|
3786
|
+
* @description Free and total bytes on the disk that holds the data directory; null when unknown.
|
|
3787
|
+
*/
|
|
3788
|
+
diskFreeBytes: number | null;
|
|
3789
|
+
/** Format: double */
|
|
3790
|
+
diskTotalBytes: number | null;
|
|
3791
|
+
/**
|
|
3792
|
+
* Format: double
|
|
3793
|
+
* @description Resident memory of the Core process in bytes.
|
|
3794
|
+
*/
|
|
3795
|
+
memoryBytes: number;
|
|
3796
|
+
/**
|
|
3797
|
+
* Format: double
|
|
3798
|
+
* @description Open TAK connections (streaming) right now.
|
|
3799
|
+
*/
|
|
3800
|
+
takConnections: number;
|
|
3801
|
+
/** Format: double */
|
|
3802
|
+
activeEvents: number;
|
|
3803
|
+
/**
|
|
3804
|
+
* Format: double
|
|
3805
|
+
* @description Errors (including fatal) logged in the last 24 hours, also before a restart.
|
|
3806
|
+
*/
|
|
3807
|
+
recentErrors: number;
|
|
3808
|
+
/** Format: double */
|
|
3809
|
+
recentWarnings: number;
|
|
3810
|
+
/** @description Stored warnings and errors of the last seven days, newest first, at most 100. */
|
|
3811
|
+
problems: components["schemas"]["LoggedProblemDto"][];
|
|
3812
|
+
/**
|
|
3813
|
+
* Format: double
|
|
3814
|
+
* @description Seconds between two samples of `history`.
|
|
3815
|
+
*/
|
|
3816
|
+
sampleIntervalSeconds: number;
|
|
3817
|
+
metricScope: components["schemas"]["MetricScope"];
|
|
3818
|
+
/** @description CPU, memory and TAK connections of the last six hours since Core started, oldest first. */
|
|
3819
|
+
history: components["schemas"]["MetricSampleDto"][];
|
|
3820
|
+
};
|
|
3668
3821
|
SetupStatusResponse: {
|
|
3669
3822
|
/** @description `false` until the first administrator exists; the Web app then opens the setup flow. */
|
|
3670
3823
|
configured: boolean;
|
|
@@ -3977,8 +4130,6 @@ export interface components {
|
|
|
3977
4130
|
mappings: components["schemas"]["PresetTargetMappingDto"][];
|
|
3978
4131
|
confirmation: string;
|
|
3979
4132
|
};
|
|
3980
|
-
/** @enum {string} */
|
|
3981
|
-
ServerLogLevel: "trace" | "debug" | "info" | "warn" | "error" | "fatal";
|
|
3982
4133
|
ServerLogEntryDto: {
|
|
3983
4134
|
/**
|
|
3984
4135
|
* Format: double
|
|
@@ -6068,12 +6219,12 @@ export interface components {
|
|
|
6068
6219
|
/** Format: double */
|
|
6069
6220
|
tiles: number;
|
|
6070
6221
|
};
|
|
6071
|
-
/** @description Imported map content (exported unchanged), or an
|
|
6222
|
+
/** @description Imported map content and files from TAK apps (exported unchanged), or an editor-only icon library. */
|
|
6072
6223
|
PackageContentDto: {
|
|
6073
6224
|
id: components["schemas"]["Uuid"];
|
|
6074
6225
|
layerId: components["schemas"]["Uuid"];
|
|
6075
6226
|
/** @enum {string} */
|
|
6076
|
-
kind: "offline-map" | "nested-data-package" | "rubber-sheet" | "icon-library";
|
|
6227
|
+
kind: "offline-map" | "nested-data-package" | "rubber-sheet" | "icon-library" | "file";
|
|
6077
6228
|
name: string;
|
|
6078
6229
|
/**
|
|
6079
6230
|
* Format: double
|
|
@@ -9313,6 +9464,44 @@ export interface operations {
|
|
|
9313
9464
|
};
|
|
9314
9465
|
};
|
|
9315
9466
|
};
|
|
9467
|
+
GetSystemStatus: {
|
|
9468
|
+
parameters: {
|
|
9469
|
+
query?: never;
|
|
9470
|
+
header?: never;
|
|
9471
|
+
path?: never;
|
|
9472
|
+
cookie?: never;
|
|
9473
|
+
};
|
|
9474
|
+
requestBody?: never;
|
|
9475
|
+
responses: {
|
|
9476
|
+
/** @description System status */
|
|
9477
|
+
200: {
|
|
9478
|
+
headers: {
|
|
9479
|
+
[name: string]: unknown;
|
|
9480
|
+
};
|
|
9481
|
+
content: {
|
|
9482
|
+
"application/json": components["schemas"]["SystemStatusDto"];
|
|
9483
|
+
};
|
|
9484
|
+
};
|
|
9485
|
+
/** @description Authentication required */
|
|
9486
|
+
401: {
|
|
9487
|
+
headers: {
|
|
9488
|
+
[name: string]: unknown;
|
|
9489
|
+
};
|
|
9490
|
+
content: {
|
|
9491
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
9492
|
+
};
|
|
9493
|
+
};
|
|
9494
|
+
/** @description Access denied */
|
|
9495
|
+
403: {
|
|
9496
|
+
headers: {
|
|
9497
|
+
[name: string]: unknown;
|
|
9498
|
+
};
|
|
9499
|
+
content: {
|
|
9500
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
9501
|
+
};
|
|
9502
|
+
};
|
|
9503
|
+
};
|
|
9504
|
+
};
|
|
9316
9505
|
GetSetupStatus: {
|
|
9317
9506
|
parameters: {
|
|
9318
9507
|
query?: never;
|