@openmeshtak/sdk 0.3.1 → 0.3.2
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 +184 -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;
|
|
@@ -3242,6 +3262,16 @@ export interface components {
|
|
|
3242
3262
|
lat: number;
|
|
3243
3263
|
/** Format: double */
|
|
3244
3264
|
lon: number;
|
|
3265
|
+
/**
|
|
3266
|
+
* Format: double
|
|
3267
|
+
* @description Direction of travel in degrees clockwise from true north (CoT `track/course`), or null when not sent.
|
|
3268
|
+
*/
|
|
3269
|
+
course: number | null;
|
|
3270
|
+
/**
|
|
3271
|
+
* Format: double
|
|
3272
|
+
* @description Ground speed in metres per second (CoT `track/speed`), or null when not sent.
|
|
3273
|
+
*/
|
|
3274
|
+
speed: number | null;
|
|
3245
3275
|
/** Format: date-time */
|
|
3246
3276
|
time: string;
|
|
3247
3277
|
/** Format: date-time */
|
|
@@ -3665,6 +3695,120 @@ export interface components {
|
|
|
3665
3695
|
key: string;
|
|
3666
3696
|
}[];
|
|
3667
3697
|
};
|
|
3698
|
+
/**
|
|
3699
|
+
* @description `off` marks a part that is switched off on purpose, such as a disabled TAK server.
|
|
3700
|
+
* @enum {string}
|
|
3701
|
+
*/
|
|
3702
|
+
SystemCheckState: "ok" | "warning" | "error" | "off";
|
|
3703
|
+
SystemCheckDto: {
|
|
3704
|
+
/** @enum {string} */
|
|
3705
|
+
id: "database" | "storage" | "tak-server" | "tak-certificate" | "errors";
|
|
3706
|
+
state: components["schemas"]["SystemCheckState"];
|
|
3707
|
+
/** @description One plain sentence for operators; never contains secrets. */
|
|
3708
|
+
detail: string;
|
|
3709
|
+
};
|
|
3710
|
+
/** @enum {string} */
|
|
3711
|
+
ServerLogLevel: "trace" | "debug" | "info" | "warn" | "error" | "fatal";
|
|
3712
|
+
/** @description A stored warning or error, sanitized like the server log. */
|
|
3713
|
+
LoggedProblemDto: {
|
|
3714
|
+
time: string | null;
|
|
3715
|
+
level: components["schemas"]["ServerLogLevel"];
|
|
3716
|
+
message: string;
|
|
3717
|
+
/** @description Structured fields as JSON, or null. */
|
|
3718
|
+
details: string | null;
|
|
3719
|
+
};
|
|
3720
|
+
/**
|
|
3721
|
+
* @description Whether system CPU and memory are the container's (cgroup) or the whole machine's.
|
|
3722
|
+
* @enum {string}
|
|
3723
|
+
*/
|
|
3724
|
+
MetricScope: "container" | "host";
|
|
3725
|
+
MetricSampleDto: {
|
|
3726
|
+
time: string;
|
|
3727
|
+
/**
|
|
3728
|
+
* Format: double
|
|
3729
|
+
* @description CPU used by the Core process, as a share of the CPUs it may use (0–100).
|
|
3730
|
+
*/
|
|
3731
|
+
coreCpuPercent: number;
|
|
3732
|
+
/**
|
|
3733
|
+
* Format: double
|
|
3734
|
+
* @description CPU used by the container (against its CPU limit) or the machine, 0–100; see `scope`.
|
|
3735
|
+
*/
|
|
3736
|
+
systemCpuPercent: number;
|
|
3737
|
+
/**
|
|
3738
|
+
* Format: double
|
|
3739
|
+
* @description Resident memory of the Core process.
|
|
3740
|
+
*/
|
|
3741
|
+
coreMemoryBytes: number;
|
|
3742
|
+
/**
|
|
3743
|
+
* Format: double
|
|
3744
|
+
* @description Memory in use by the container or the machine; see `scope`.
|
|
3745
|
+
*/
|
|
3746
|
+
systemMemoryUsedBytes: number;
|
|
3747
|
+
/**
|
|
3748
|
+
* Format: double
|
|
3749
|
+
* @description The container's memory limit (at most the machine's memory) or the machine's memory.
|
|
3750
|
+
*/
|
|
3751
|
+
systemMemoryTotalBytes: number;
|
|
3752
|
+
/** Format: double */
|
|
3753
|
+
takConnections: number;
|
|
3754
|
+
};
|
|
3755
|
+
SystemStatusDto: {
|
|
3756
|
+
/** @description Core release version. */
|
|
3757
|
+
version: string;
|
|
3758
|
+
startedAt: string;
|
|
3759
|
+
checks: components["schemas"]["SystemCheckDto"][];
|
|
3760
|
+
/**
|
|
3761
|
+
* Format: double
|
|
3762
|
+
* @description Database round trip of a trivial query in milliseconds; null when it failed.
|
|
3763
|
+
*/
|
|
3764
|
+
databaseLatencyMs: number | null;
|
|
3765
|
+
/**
|
|
3766
|
+
* Format: double
|
|
3767
|
+
* @description Size of the SQLite database file in bytes; null when unknown.
|
|
3768
|
+
*/
|
|
3769
|
+
databaseBytes: number | null;
|
|
3770
|
+
/**
|
|
3771
|
+
* Format: double
|
|
3772
|
+
* @description Bytes of stored files (Data Package content, icon sets).
|
|
3773
|
+
*/
|
|
3774
|
+
storedFileBytes: number;
|
|
3775
|
+
/**
|
|
3776
|
+
* Format: double
|
|
3777
|
+
* @description Free and total bytes on the disk that holds the data directory; null when unknown.
|
|
3778
|
+
*/
|
|
3779
|
+
diskFreeBytes: number | null;
|
|
3780
|
+
/** Format: double */
|
|
3781
|
+
diskTotalBytes: number | null;
|
|
3782
|
+
/**
|
|
3783
|
+
* Format: double
|
|
3784
|
+
* @description Resident memory of the Core process in bytes.
|
|
3785
|
+
*/
|
|
3786
|
+
memoryBytes: number;
|
|
3787
|
+
/**
|
|
3788
|
+
* Format: double
|
|
3789
|
+
* @description Open TAK connections (streaming) right now.
|
|
3790
|
+
*/
|
|
3791
|
+
takConnections: number;
|
|
3792
|
+
/** Format: double */
|
|
3793
|
+
activeEvents: number;
|
|
3794
|
+
/**
|
|
3795
|
+
* Format: double
|
|
3796
|
+
* @description Errors (including fatal) logged in the last 24 hours, also before a restart.
|
|
3797
|
+
*/
|
|
3798
|
+
recentErrors: number;
|
|
3799
|
+
/** Format: double */
|
|
3800
|
+
recentWarnings: number;
|
|
3801
|
+
/** @description Stored warnings and errors of the last seven days, newest first, at most 100. */
|
|
3802
|
+
problems: components["schemas"]["LoggedProblemDto"][];
|
|
3803
|
+
/**
|
|
3804
|
+
* Format: double
|
|
3805
|
+
* @description Seconds between two samples of `history`.
|
|
3806
|
+
*/
|
|
3807
|
+
sampleIntervalSeconds: number;
|
|
3808
|
+
metricScope: components["schemas"]["MetricScope"];
|
|
3809
|
+
/** @description CPU, memory and TAK connections of the last six hours since Core started, oldest first. */
|
|
3810
|
+
history: components["schemas"]["MetricSampleDto"][];
|
|
3811
|
+
};
|
|
3668
3812
|
SetupStatusResponse: {
|
|
3669
3813
|
/** @description `false` until the first administrator exists; the Web app then opens the setup flow. */
|
|
3670
3814
|
configured: boolean;
|
|
@@ -3977,8 +4121,6 @@ export interface components {
|
|
|
3977
4121
|
mappings: components["schemas"]["PresetTargetMappingDto"][];
|
|
3978
4122
|
confirmation: string;
|
|
3979
4123
|
};
|
|
3980
|
-
/** @enum {string} */
|
|
3981
|
-
ServerLogLevel: "trace" | "debug" | "info" | "warn" | "error" | "fatal";
|
|
3982
4124
|
ServerLogEntryDto: {
|
|
3983
4125
|
/**
|
|
3984
4126
|
* Format: double
|
|
@@ -6068,12 +6210,12 @@ export interface components {
|
|
|
6068
6210
|
/** Format: double */
|
|
6069
6211
|
tiles: number;
|
|
6070
6212
|
};
|
|
6071
|
-
/** @description Imported map content (exported unchanged), or an
|
|
6213
|
+
/** @description Imported map content and files from TAK apps (exported unchanged), or an editor-only icon library. */
|
|
6072
6214
|
PackageContentDto: {
|
|
6073
6215
|
id: components["schemas"]["Uuid"];
|
|
6074
6216
|
layerId: components["schemas"]["Uuid"];
|
|
6075
6217
|
/** @enum {string} */
|
|
6076
|
-
kind: "offline-map" | "nested-data-package" | "rubber-sheet" | "icon-library";
|
|
6218
|
+
kind: "offline-map" | "nested-data-package" | "rubber-sheet" | "icon-library" | "file";
|
|
6077
6219
|
name: string;
|
|
6078
6220
|
/**
|
|
6079
6221
|
* Format: double
|
|
@@ -9313,6 +9455,44 @@ export interface operations {
|
|
|
9313
9455
|
};
|
|
9314
9456
|
};
|
|
9315
9457
|
};
|
|
9458
|
+
GetSystemStatus: {
|
|
9459
|
+
parameters: {
|
|
9460
|
+
query?: never;
|
|
9461
|
+
header?: never;
|
|
9462
|
+
path?: never;
|
|
9463
|
+
cookie?: never;
|
|
9464
|
+
};
|
|
9465
|
+
requestBody?: never;
|
|
9466
|
+
responses: {
|
|
9467
|
+
/** @description System status */
|
|
9468
|
+
200: {
|
|
9469
|
+
headers: {
|
|
9470
|
+
[name: string]: unknown;
|
|
9471
|
+
};
|
|
9472
|
+
content: {
|
|
9473
|
+
"application/json": components["schemas"]["SystemStatusDto"];
|
|
9474
|
+
};
|
|
9475
|
+
};
|
|
9476
|
+
/** @description Authentication required */
|
|
9477
|
+
401: {
|
|
9478
|
+
headers: {
|
|
9479
|
+
[name: string]: unknown;
|
|
9480
|
+
};
|
|
9481
|
+
content: {
|
|
9482
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
9483
|
+
};
|
|
9484
|
+
};
|
|
9485
|
+
/** @description Access denied */
|
|
9486
|
+
403: {
|
|
9487
|
+
headers: {
|
|
9488
|
+
[name: string]: unknown;
|
|
9489
|
+
};
|
|
9490
|
+
content: {
|
|
9491
|
+
"application/json": components["schemas"]["ProblemDetails"];
|
|
9492
|
+
};
|
|
9493
|
+
};
|
|
9494
|
+
};
|
|
9495
|
+
};
|
|
9316
9496
|
GetSetupStatus: {
|
|
9317
9497
|
parameters: {
|
|
9318
9498
|
query?: never;
|