@signalk/server-api 2.10.1 → 2.20.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/dist/deltas.d.ts +19 -1
- package/dist/deltas.d.ts.map +1 -1
- package/dist/features.d.ts +1 -1
- package/dist/features.d.ts.map +1 -1
- package/dist/history.d.ts +7 -3
- package/dist/history.d.ts.map +1 -1
- package/dist/history.js +3 -2
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +4 -1
- package/dist/mmsi/mid.js +1 -1
- package/dist/notificationsapi.d.ts +57 -0
- package/dist/notificationsapi.d.ts.map +1 -0
- package/dist/notificationsapi.js +2 -0
- package/dist/propertyvalues.d.ts +15 -4
- package/dist/propertyvalues.d.ts.map +1 -1
- package/dist/radarapi.d.ts +719 -0
- package/dist/radarapi.d.ts.map +1 -0
- package/dist/radarapi.js +32 -0
- package/dist/resourcesapi.d.ts +8 -16
- package/dist/resourcesapi.d.ts.map +1 -1
- package/dist/serverapi.d.ts +44 -11
- package/dist/serverapi.d.ts.map +1 -1
- package/dist/subscriptionmanager.d.ts +7 -0
- package/dist/subscriptionmanager.d.ts.map +1 -1
- package/dist/weatherapi.d.ts +5 -2
- package/dist/weatherapi.d.ts.map +1 -1
- package/dist/weatherapi.js +18 -13
- package/package.json +1 -1
- package/tsconfig.json +8 -0
- package/tsconfig.tsbuildinfo +1 -1
- package/wit/signalk.wit +98 -0
package/dist/deltas.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { Position } from '.';
|
|
1
2
|
import { Brand } from './brand';
|
|
2
3
|
/** @hidden */
|
|
3
4
|
export interface WithContext {
|
|
@@ -7,7 +8,8 @@ export interface WithContext {
|
|
|
7
8
|
type NormalizedBaseDelta = {
|
|
8
9
|
context: Context;
|
|
9
10
|
$source: SourceRef;
|
|
10
|
-
source
|
|
11
|
+
/** @deprecated Use $source instead */
|
|
12
|
+
source?: Source;
|
|
11
13
|
path: Path;
|
|
12
14
|
timestamp: Timestamp;
|
|
13
15
|
};
|
|
@@ -34,6 +36,8 @@ export type Timestamp = Brand<string, 'timestamp'>;
|
|
|
34
36
|
/** @category Server API */
|
|
35
37
|
export type Context = Brand<string, 'context'>;
|
|
36
38
|
/** @category Server API */
|
|
39
|
+
export type NotificationId = Brand<string, 'notificationId'>;
|
|
40
|
+
/** @category Server API */
|
|
37
41
|
export type Value = object | number | string | null | Notification | boolean;
|
|
38
42
|
/** @category Server API */
|
|
39
43
|
export interface Delta {
|
|
@@ -53,8 +57,10 @@ export type MetaDelta = Delta;
|
|
|
53
57
|
/** @category Server API */
|
|
54
58
|
export type Update = {
|
|
55
59
|
timestamp?: Timestamp;
|
|
60
|
+
/** @deprecated Use $source (SourceRef) instead for more practical string-based referencing */
|
|
56
61
|
source?: Source;
|
|
57
62
|
$source?: SourceRef;
|
|
63
|
+
notificationId?: NotificationId;
|
|
58
64
|
} & ({
|
|
59
65
|
values: PathValue[];
|
|
60
66
|
} | {
|
|
@@ -78,6 +84,10 @@ export interface Notification {
|
|
|
78
84
|
state: ALARM_STATE;
|
|
79
85
|
method: ALARM_METHOD[];
|
|
80
86
|
message: string;
|
|
87
|
+
status?: AlarmStatus;
|
|
88
|
+
position?: Position;
|
|
89
|
+
createdAt?: Timestamp;
|
|
90
|
+
id?: string;
|
|
81
91
|
}
|
|
82
92
|
/** @category Server API */
|
|
83
93
|
export interface Meta {
|
|
@@ -113,6 +123,14 @@ export declare enum ALARM_METHOD {
|
|
|
113
123
|
sound = "sound"
|
|
114
124
|
}
|
|
115
125
|
/** @category Server API */
|
|
126
|
+
export interface AlarmStatus {
|
|
127
|
+
silenced: boolean;
|
|
128
|
+
acknowledged: boolean;
|
|
129
|
+
canSilence: boolean;
|
|
130
|
+
canAcknowledge: boolean;
|
|
131
|
+
canClear: boolean;
|
|
132
|
+
}
|
|
133
|
+
/** @category Server API */
|
|
116
134
|
export interface Zone {
|
|
117
135
|
lower: number | undefined;
|
|
118
136
|
upper: number | undefined;
|
package/dist/deltas.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"deltas.d.ts","sourceRoot":"","sources":["../src/deltas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAE/B,cAAc;AACd,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,uDAAuD;AACvD,KAAK,mBAAmB,GAAG;IACzB,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,SAAS,CAAA;IAClB,MAAM,EAAE,MAAM,CAAA;
|
|
1
|
+
{"version":3,"file":"deltas.d.ts","sourceRoot":"","sources":["../src/deltas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,CAAA;AAC5B,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAE/B,cAAc;AACd,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,uDAAuD;AACvD,KAAK,mBAAmB,GAAG;IACzB,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,SAAS,CAAA;IAClB,sCAAsC;IACtC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,IAAI,CAAA;IACV,SAAS,EAAE,SAAS,CAAA;CACrB,CAAA;AAED,cAAc;AACd,MAAM,MAAM,mBAAmB,GAAG,mBAAmB,GAAG;IACtD,KAAK,EAAE,SAAS,CAAA;IAChB,MAAM,EAAE,IAAI,CAAA;CACb,CAAA;AAED,cAAc;AACd,MAAM,MAAM,oBAAoB,GAAG,mBAAmB,GAAG;IACvD,KAAK,EAAE,KAAK,CAAA;IACZ,MAAM,EAAE,KAAK,CAAA;CACd,CAAA;AAED,cAAc;AACd,MAAM,MAAM,eAAe,GAAG,oBAAoB,GAAG,mBAAmB,CAAA;AAExE,2BAA2B;AAC3B,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;AAClD,2BAA2B;AAE3B,MAAM,MAAM,MAAM,GAAG,GAAG,CAAA;AAExB,2BAA2B;AAC3B,MAAM,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AACxC,2BAA2B;AAC3B,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;AAClD,2BAA2B;AAC3B,MAAM,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;AAC9C,2BAA2B;AAC3B,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;AAE5D,2BAA2B;AAC3B,MAAM,MAAM,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,YAAY,GAAG,OAAO,CAAA;AAE5E,2BAA2B;AAC3B,MAAM,WAAW,KAAK;IACpB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,CAAA;AAC/B;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,KAAK,CAAA;AAE7B,2BAA2B;AAC3B,MAAM,MAAM,MAAM,GAAG;IACnB,SAAS,CAAC,EAAE,SAAS,CAAA;IACrB,8FAA8F;IAC9F,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,SAAS,CAAA;IACnB,cAAc,CAAC,EAAE,cAAc,CAAA;CAChC,GAAG,CAAC;IAAE,MAAM,EAAE,SAAS,EAAE,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,IAAI,EAAE,CAAA;CAAE,CAAC,CAAA;AAEhD,2BAA2B;AAC3B,wBAAgB,SAAS,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,IAAI,MAAM,GAAG;IAAE,MAAM,EAAE,SAAS,EAAE,CAAA;CAAE,CAE1E;AAED,2BAA2B;AAC3B,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,IAAI,MAAM,GAAG;IAAE,IAAI,EAAE,IAAI,EAAE,CAAA;CAAE,CAEjE;AAGD,2BAA2B;AAC3B,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,IAAI,CAAA;IACV,KAAK,EAAE,KAAK,CAAA;CACb;AAGD,2BAA2B;AAC3B,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,WAAW,CAAA;IAClB,MAAM,EAAE,YAAY,EAAE,CAAA;IACtB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,SAAS,CAAC,EAAE,SAAS,CAAA;IACrB,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ;AAGD,2BAA2B;AAC3B,MAAM,WAAW,IAAI;IACnB,IAAI,EAAE,IAAI,CAAA;IACV,KAAK,EAAE,SAAS,CAAA;CACjB;AAGD,2BAA2B;AAC3B,MAAM,WAAW,SAAS;IACxB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE;QACb,KAAK,EAAE,MAAM,CAAA;QACb,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;IACD,KAAK,CAAC,EAAE,IAAI,EAAE,CAAA;IACd,WAAW,CAAC,EAAE,OAAO,CAAA;CACtB;AAGD,2BAA2B;AAC3B,oBAAY,WAAW;IACrB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,KAAK,UAAU;IACf,SAAS,cAAc;CACxB;AAED,2BAA2B;AAC3B,oBAAY,YAAY;IACtB,MAAM,WAAW;IACjB,KAAK,UAAU;CAChB;AAED,2BAA2B;AAC3B,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,OAAO,CAAA;IACjB,YAAY,EAAE,OAAO,CAAA;IACrB,UAAU,EAAE,OAAO,CAAA;IACnB,cAAc,EAAE,OAAO,CAAA;IACvB,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED,2BAA2B;AAC3B,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB,KAAK,EAAE,WAAW,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;CAChB"}
|
package/dist/features.d.ts
CHANGED
|
@@ -63,5 +63,5 @@ export interface FeatureInfo {
|
|
|
63
63
|
}>;
|
|
64
64
|
}
|
|
65
65
|
/** @category Server API */
|
|
66
|
-
export type SignalKApiId = 'weather' | 'course' | 'resources' | 'history' | 'autopilot' | 'anchor' | 'logbook' | 'historyplayback' | 'historysnapshot';
|
|
66
|
+
export type SignalKApiId = 'weather' | 'course' | 'resources' | 'history' | 'autopilot' | 'anchor' | 'logbook' | 'radar' | 'historyplayback' | 'historysnapshot' | 'notifications';
|
|
67
67
|
//# sourceMappingURL=features.d.ts.map
|
package/dist/features.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"features.d.ts","sourceRoot":"","sources":["../src/features.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;IACH,WAAW,CAAC,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;CACzD;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,YAAY,EAAE,CAAA;IACpB,OAAO,EAAE,KAAK,CAAC;QACb,EAAE,EAAE,MAAM,CAAA;QACV,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE,MAAM,CAAA;QACf,OAAO,EAAE,OAAO,CAAA;KACjB,CAAC,CAAA;CACH;AAED,4BAA4B;AAC5B,MAAM,MAAM,YAAY,GACpB,SAAS,GACT,QAAQ,GACR,WAAW,GACX,SAAS,GACT,WAAW,GACX,QAAQ,GACR,SAAS,GACT,iBAAiB,GACjB,iBAAiB,CAAA"}
|
|
1
|
+
{"version":3,"file":"features.d.ts","sourceRoot":"","sources":["../src/features.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;IACH,WAAW,CAAC,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;CACzD;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,YAAY,EAAE,CAAA;IACpB,OAAO,EAAE,KAAK,CAAC;QACb,EAAE,EAAE,MAAM,CAAA;QACV,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE,MAAM,CAAA;QACf,OAAO,EAAE,OAAO,CAAA;KACjB,CAAC,CAAA;CACH;AAED,4BAA4B;AAC5B,MAAM,MAAM,YAAY,GACpB,SAAS,GACT,QAAQ,GACR,WAAW,GACX,SAAS,GACT,WAAW,GACX,QAAQ,GACR,SAAS,GACT,OAAO,GACP,iBAAiB,GACjB,iBAAiB,GACjB,eAAe,CAAA"}
|
package/dist/history.d.ts
CHANGED
|
@@ -5,7 +5,11 @@ export type ValueList = {
|
|
|
5
5
|
path: Path;
|
|
6
6
|
method: AggregateMethod;
|
|
7
7
|
}[];
|
|
8
|
-
|
|
8
|
+
/**
|
|
9
|
+
* A row of historical data: first element is timestamp, followed by aggregated values.
|
|
10
|
+
* Values can be primitives, objects (like navigation.position), or null depending on the path.
|
|
11
|
+
*/
|
|
12
|
+
export type DataRow = [Timestamp, ...unknown[]];
|
|
9
13
|
export interface ValuesResponse {
|
|
10
14
|
context: Context;
|
|
11
15
|
range: {
|
|
@@ -32,7 +36,7 @@ export type TimeRangeQueryParams = {
|
|
|
32
36
|
from: string;
|
|
33
37
|
to?: never;
|
|
34
38
|
} | {
|
|
35
|
-
duration
|
|
39
|
+
duration?: never;
|
|
36
40
|
from: string;
|
|
37
41
|
to: string;
|
|
38
42
|
};
|
|
@@ -111,7 +115,7 @@ export type TimeRangeParams = {
|
|
|
111
115
|
from: Temporal.Instant;
|
|
112
116
|
to?: never;
|
|
113
117
|
} | {
|
|
114
|
-
duration
|
|
118
|
+
duration?: never;
|
|
115
119
|
from: Temporal.Instant;
|
|
116
120
|
to: Temporal.Instant;
|
|
117
121
|
};
|
package/dist/history.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"history.d.ts","sourceRoot":"","sources":["../src/history.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,GAAG,CAAA;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAEhD,MAAM,MAAM,eAAe,GACvB,SAAS,GACT,KAAK,GACL,KAAK,GACL,OAAO,GACP,MAAM,GACN,KAAK,GACL,cAAc,CAAA;AAElB,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,IAAI,CAAA;IACV,MAAM,EAAE,eAAe,CAAA;CACxB,EAAE,CAAA;
|
|
1
|
+
{"version":3,"file":"history.d.ts","sourceRoot":"","sources":["../src/history.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,GAAG,CAAA;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAEhD,MAAM,MAAM,eAAe,GACvB,SAAS,GACT,KAAK,GACL,KAAK,GACL,OAAO,GACP,MAAM,GACN,KAAK,GACL,cAAc,CAAA;AAElB,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,IAAI,CAAA;IACV,MAAM,EAAE,eAAe,CAAA;CACxB,EAAE,CAAA;AAEH;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,CAAC,SAAS,EAAE,GAAG,OAAO,EAAE,CAAC,CAAA;AAE/C,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,OAAO,CAAA;IAChB,KAAK,EAAE;QACL,IAAI,EAAE,SAAS,CAAA;QACf,EAAE,EAAE,SAAS,CAAA;KACd,CAAA;IACD,MAAM,EAAE,SAAS,CAAA;IAEjB,IAAI,EAAE,OAAO,EAAE,CAAA;CAChB;AAuBD,MAAM,MAAM,oBAAoB,GAC5B;IAEE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;IACzB,IAAI,CAAC,EAAE,KAAK,CAAA;IACZ,EAAE,CAAC,EAAE,KAAK,CAAA;CACX,GACD;IAEE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,CAAC,EAAE,KAAK,CAAA;CACX,GACD;IAEE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;IACzB,IAAI,CAAC,EAAE,KAAK,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;CACX,GACD;IAEE,QAAQ,CAAC,EAAE,KAAK,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,CAAC,EAAE,KAAK,CAAA;CACX,GACD;IAEE,QAAQ,CAAC,EAAE,KAAK,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAEL,MAAM,MAAM,wBAAwB,GAAG,oBAAoB,GAAG;IAC5D,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG,oBAAoB,CAAA;AAC1D,MAAM,MAAM,aAAa,GAAG,IAAI,EAAE,CAAA;AAElC,MAAM,MAAM,0BAA0B,GAAG,oBAAoB,CAAA;AAC7D,MAAM,MAAM,gBAAgB,GAAG,OAAO,EAAE,CAAA;AAExC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,0BAA0B,CAAC,QAAQ,EAAE,UAAU,GAAG,IAAI,CAAA;IACtD,4BAA4B,IAAI,IAAI,CAAA;CACrC,CAAA;AACD,6BAA6B;AAC7B,MAAM,MAAM,cAAc,GAAG;IAC3B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,CAAA;CAC1C,CAAA;AAED,6BAA6B;AAC7B,MAAM,WAAW,UAAU;IACzB;;;;;OAKG;IACH,SAAS,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;IAExD;;;;;OAKG;IACH,WAAW,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAE9D;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,aAAa,CAAC,CAAA;CACtD;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,UAAU,CAS5D;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,GAAG,MAAM,CAAA;AAEjD,MAAM,MAAM,eAAe,GACvB;IAEE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAA;IAC3B,IAAI,CAAC,EAAE,KAAK,CAAA;IACZ,EAAE,CAAC,EAAE,KAAK,CAAA;CACX,GACD;IAEE,QAAQ,EAAE,QAAQ,CAAA;IAClB,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAA;IACtB,EAAE,CAAC,EAAE,KAAK,CAAA;CACX,GACD;IAEE,QAAQ,EAAE,QAAQ,CAAA;IAClB,IAAI,CAAC,EAAE,KAAK,CAAA;IACZ,EAAE,EAAE,QAAQ,CAAC,OAAO,CAAA;CACrB,GACD;IAEE,QAAQ,CAAC,EAAE,KAAK,CAAA;IAChB,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAA;IACtB,EAAE,CAAC,EAAE,KAAK,CAAA;CACX,GACD;IAEE,QAAQ,CAAC,EAAE,KAAK,CAAA;IAChB,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAA;IACtB,EAAE,EAAE,QAAQ,CAAC,OAAO,CAAA;CACrB,CAAA;AAEL,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,IAAI,CAAA;IACV,SAAS,EAAE,eAAe,CAAA;CAC3B;AAED,MAAM,MAAM,aAAa,GAAG,eAAe,GAAG;IAC5C,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,QAAQ,EAAE,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,eAAe,CAAA;AAC1C,MAAM,MAAM,eAAe,GAAG,eAAe,CAAA"}
|
package/dist/history.js
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.isHistoryApi = isHistoryApi;
|
|
4
|
-
|
|
5
|
-
const
|
|
4
|
+
// Type-check test - verify ValuesResponse compiles correctly
|
|
5
|
+
const _exampleValuesResponse = {
|
|
6
6
|
context: 'vessels.urn:mrn:signalk:uuid:2ffee4a6-52f6-4d4e-8179-0fc9aaf22c87',
|
|
7
7
|
range: {
|
|
8
8
|
from: '2025-08-11T05:26:04.888Z',
|
|
@@ -19,6 +19,7 @@ const _example = {
|
|
|
19
19
|
['2025-08-11T05:26:10.000Z', 3.14]
|
|
20
20
|
]
|
|
21
21
|
};
|
|
22
|
+
void _exampleValuesResponse;
|
|
22
23
|
function isHistoryApi(obj) {
|
|
23
24
|
if (typeof obj !== 'object' || obj === null) {
|
|
24
25
|
return false;
|
package/dist/index.d.ts
CHANGED
|
@@ -11,10 +11,13 @@ export * from './mmsi/mmsi';
|
|
|
11
11
|
export * from './propertyvalues';
|
|
12
12
|
export * from './brand';
|
|
13
13
|
export * from './weatherapi';
|
|
14
|
+
export * as radar from './radarapi';
|
|
14
15
|
export * from './streambundle';
|
|
15
16
|
export * from './subscriptionmanager';
|
|
16
17
|
/** @category History API */
|
|
17
18
|
export * as history from './history';
|
|
19
|
+
/** @category Notifications API */
|
|
20
|
+
export * from './notificationsapi';
|
|
18
21
|
/** @category Server API */
|
|
19
22
|
export interface Position {
|
|
20
23
|
latitude: number;
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,UAAU,CAAA;AACxB,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,gBAAgB,CAAA;AAC9B,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA;AAChC,cAAc,SAAS,CAAA;AACvB,cAAc,cAAc,CAAA;AAC5B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,uBAAuB,CAAA;AACrC,4BAA4B;AAC5B,OAAO,KAAK,OAAO,MAAM,WAAW,CAAA;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,UAAU,CAAA;AACxB,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,gBAAgB,CAAA;AAC9B,cAAc,aAAa,CAAA;AAC3B,cAAc,kBAAkB,CAAA;AAChC,cAAc,SAAS,CAAA;AACvB,cAAc,cAAc,CAAA;AAC5B,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,uBAAuB,CAAA;AACrC,4BAA4B;AAC5B,OAAO,KAAK,OAAO,MAAM,WAAW,CAAA;AACpC,kCAAkC;AAClC,cAAc,oBAAoB,CAAA;AAElC,4BAA4B;AAC5B,MAAM,WAAW,QAAQ;IACvB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,4BAA4B;AAC5B,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,4BAA4B;AAC5B,oBAAY,SAAS;IACnB,EAAE,OAAO;IACT,EAAE,OAAO;CACV"}
|
package/dist/index.js
CHANGED
|
@@ -36,7 +36,7 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
36
36
|
};
|
|
37
37
|
})();
|
|
38
38
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
-
exports.SKVersion = exports.history = void 0;
|
|
39
|
+
exports.SKVersion = exports.history = exports.radar = void 0;
|
|
40
40
|
__exportStar(require("./plugin"), exports);
|
|
41
41
|
__exportStar(require("./serverapi"), exports);
|
|
42
42
|
__exportStar(require("./deltas"), exports);
|
|
@@ -50,10 +50,13 @@ __exportStar(require("./mmsi/mmsi"), exports);
|
|
|
50
50
|
__exportStar(require("./propertyvalues"), exports);
|
|
51
51
|
__exportStar(require("./brand"), exports);
|
|
52
52
|
__exportStar(require("./weatherapi"), exports);
|
|
53
|
+
exports.radar = __importStar(require("./radarapi"));
|
|
53
54
|
__exportStar(require("./streambundle"), exports);
|
|
54
55
|
__exportStar(require("./subscriptionmanager"), exports);
|
|
55
56
|
/** @category History API */
|
|
56
57
|
exports.history = __importStar(require("./history"));
|
|
58
|
+
/** @category Notifications API */
|
|
59
|
+
__exportStar(require("./notificationsapi"), exports);
|
|
57
60
|
/** @category Server API */
|
|
58
61
|
var SKVersion;
|
|
59
62
|
(function (SKVersion) {
|
package/dist/mmsi/mid.js
CHANGED
|
@@ -295,7 +295,7 @@ exports.MID = Object.entries({
|
|
|
295
295
|
'765': ['SR', 'SUR', '', 'Suriname'],
|
|
296
296
|
'770': ['UY', 'URY', '', 'Uruguay'],
|
|
297
297
|
'775': ['VE', 'VEN', '', 'Venezuela']
|
|
298
|
-
}).reduce((acc, [key, [alpha2, alpha3,
|
|
298
|
+
}).reduce((acc, [key, [alpha2, alpha3, , name]]) => {
|
|
299
299
|
acc[key] = { alpha2, alpha3, name };
|
|
300
300
|
return acc;
|
|
301
301
|
}, {});
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import { ALARM_STATE, Path } from '.';
|
|
2
|
+
/**
|
|
3
|
+
* @see [Notifications REST API](../../../docs/develop/rest-api/notifications_api.md) provides the following functions for use by plugins.
|
|
4
|
+
* @category Notifications API
|
|
5
|
+
*/
|
|
6
|
+
export interface NotificationsApi {
|
|
7
|
+
/**
|
|
8
|
+
* Silences the notification with the supplied identifier.
|
|
9
|
+
* Note: Calling this method on a Notifications with a status of `canSilence = false` will throw an Error
|
|
10
|
+
*
|
|
11
|
+
* @category Notifications API
|
|
12
|
+
*
|
|
13
|
+
* @param id - Notification identifier.
|
|
14
|
+
*
|
|
15
|
+
*/
|
|
16
|
+
silenceNotification(id: string): void;
|
|
17
|
+
/**
|
|
18
|
+
* Silences all notifications.
|
|
19
|
+
*
|
|
20
|
+
* @category Notifications API
|
|
21
|
+
*
|
|
22
|
+
*/
|
|
23
|
+
silenceAll(): void;
|
|
24
|
+
/**
|
|
25
|
+
* Acknowledges the notification with the supplied identifier.
|
|
26
|
+
* Note: Calling this method on a Notifications with a status of `canAcknowledge = false` will throw an Error
|
|
27
|
+
*
|
|
28
|
+
* @category Notifications API
|
|
29
|
+
*
|
|
30
|
+
* @param id - Notification identifier.
|
|
31
|
+
*
|
|
32
|
+
*/
|
|
33
|
+
acknowledgeNotification(id: string): void;
|
|
34
|
+
/**
|
|
35
|
+
* Acknowledges all notifications.
|
|
36
|
+
*
|
|
37
|
+
* @category Notifications API
|
|
38
|
+
*
|
|
39
|
+
*/
|
|
40
|
+
acknowledgeAll(): void;
|
|
41
|
+
}
|
|
42
|
+
/** @category Notifications API */
|
|
43
|
+
export interface WithNotificationsApi {
|
|
44
|
+
notificationsApi: NotificationsApi;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* @category Notifications API
|
|
48
|
+
*/
|
|
49
|
+
export interface AlarmOptions {
|
|
50
|
+
state: ALARM_STATE;
|
|
51
|
+
message: string;
|
|
52
|
+
path?: Path;
|
|
53
|
+
position?: boolean;
|
|
54
|
+
createdAt?: boolean;
|
|
55
|
+
appendId?: boolean;
|
|
56
|
+
}
|
|
57
|
+
//# sourceMappingURL=notificationsapi.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"notificationsapi.d.ts","sourceRoot":"","sources":["../src/notificationsapi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,GAAG,CAAA;AAErC;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;OAQG;IACH,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAA;IAErC;;;;;OAKG;IACH,UAAU,IAAI,IAAI,CAAA;IAElB;;;;;;;;OAQG;IACH,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzC;;;;;OAKG;IACH,cAAc,IAAI,IAAI,CAAA;CAWvB;AAED,mCAAmC;AACnC,MAAM,WAAW,oBAAoB;IACnC,gBAAgB,EAAE,gBAAgB,CAAA;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,WAAW,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAA;CAEnB"}
|
package/dist/propertyvalues.d.ts
CHANGED
|
@@ -35,9 +35,12 @@
|
|
|
35
35
|
*/
|
|
36
36
|
export interface PropertyValuesEmitter {
|
|
37
37
|
/**
|
|
38
|
+
* Emit a property value that can be received by listeners.
|
|
39
|
+
* @param name - The property name identifier
|
|
40
|
+
* @param value - The value to emit (can be any type including functions)
|
|
38
41
|
* @category Property Values
|
|
39
42
|
*/
|
|
40
|
-
emitPropertyValue(name: string, value:
|
|
43
|
+
emitPropertyValue(name: string, value: unknown): void;
|
|
41
44
|
/**
|
|
42
45
|
* @category Property Values
|
|
43
46
|
*/
|
|
@@ -45,13 +48,21 @@ export interface PropertyValuesEmitter {
|
|
|
45
48
|
}
|
|
46
49
|
/** @category Server API */
|
|
47
50
|
export interface PropertyValue {
|
|
51
|
+
/** Timestamp in milliseconds */
|
|
48
52
|
timestamp: number;
|
|
53
|
+
/** Source identifier (plugin id, server, provider id) */
|
|
49
54
|
setter: string;
|
|
55
|
+
/** Property name */
|
|
50
56
|
name: string;
|
|
51
|
-
value
|
|
57
|
+
/** The property value (can be any type including functions) */
|
|
58
|
+
value: unknown;
|
|
52
59
|
}
|
|
53
|
-
/**
|
|
54
|
-
|
|
60
|
+
/**
|
|
61
|
+
* Callback function for property value subscriptions.
|
|
62
|
+
* The history array starts with `undefined` as the initial value.
|
|
63
|
+
* @category Server API
|
|
64
|
+
*/
|
|
65
|
+
export type PropertyValuesCallback = (propValuesHistory: (PropertyValue | undefined)[]) => void;
|
|
55
66
|
/** @category Server API */
|
|
56
67
|
export declare class PropertyValues {
|
|
57
68
|
private streams;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"propertyvalues.d.ts","sourceRoot":"","sources":["../src/propertyvalues.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,WAAW,qBAAqB;IACpC
|
|
1
|
+
{"version":3,"file":"propertyvalues.d.ts","sourceRoot":"","sources":["../src/propertyvalues.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;OAKG;IACH,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAA;IAErD;;OAEG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,sBAAsB,GAAG,WAAW,CAAA;CACxE;AAED,2BAA2B;AAC3B,MAAM,WAAW,aAAa;IAC5B,gCAAgC;IAChC,SAAS,EAAE,MAAM,CAAA;IACjB,yDAAyD;IACzD,MAAM,EAAE,MAAM,CAAA;IACd,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,+DAA+D;IAC/D,KAAK,EAAE,OAAO,CAAA;CACf;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,CACnC,iBAAiB,EAAE,CAAC,aAAa,GAAG,SAAS,CAAC,EAAE,KAC7C,IAAI,CAAA;AAST,2BAA2B;AAC3B,qBAAa,cAAc;IACzB,OAAO,CAAC,OAAO,CAET;IACN,OAAO,CAAC,KAAK,CAAI;IAEjB,MAAM,CAAC,QAAQ,CAAC,gBAAgB,QAAO;IAEvC,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,sBAAsB,GAAG,MAAM,IAAI;IAI1E,iBAAiB,CAAC,EAAE,EAAE,aAAa;IAWnC,OAAO,CAAC,cAAc;CAsBvB;AAED;;;GAGG;AACH,KAAK,WAAW,GAAG,MAAM,IAAI,CAAA"}
|