@signalk/server-api 2.8.0 → 2.10.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.
Files changed (52) hide show
  1. package/dist/autopilotapi.d.ts +116 -9
  2. package/dist/autopilotapi.d.ts.map +1 -1
  3. package/dist/autopilotapi.js +41 -3
  4. package/dist/brand.d.ts +1 -1
  5. package/dist/course.d.ts +1 -0
  6. package/dist/course.d.ts.map +1 -1
  7. package/dist/coursetypes.d.ts +9 -0
  8. package/dist/coursetypes.d.ts.map +1 -1
  9. package/dist/coursetypes.js +1 -0
  10. package/dist/deltas.d.ts +21 -0
  11. package/dist/deltas.d.ts.map +1 -1
  12. package/dist/deltas.js +4 -0
  13. package/dist/features.d.ts +2 -0
  14. package/dist/features.d.ts.map +1 -1
  15. package/dist/history.d.ts +83 -0
  16. package/dist/history.d.ts.map +1 -1
  17. package/dist/history.js +10 -0
  18. package/dist/index.d.ts +5 -1
  19. package/dist/index.d.ts.map +1 -1
  20. package/dist/index.js +3 -1
  21. package/dist/mmsi/mid.d.ts +21 -0
  22. package/dist/mmsi/mid.d.ts.map +1 -0
  23. package/dist/mmsi/mid.js +301 -0
  24. package/dist/mmsi/mmsi.d.ts +76 -0
  25. package/dist/mmsi/mmsi.d.ts.map +1 -0
  26. package/dist/mmsi/mmsi.js +165 -0
  27. package/dist/mmsi/mmsi.test.d.ts +2 -0
  28. package/dist/mmsi/mmsi.test.d.ts.map +1 -0
  29. package/dist/plugin.d.ts +2 -0
  30. package/dist/plugin.d.ts.map +1 -1
  31. package/dist/propertyvalues.d.ts +5 -0
  32. package/dist/propertyvalues.d.ts.map +1 -1
  33. package/dist/propertyvalues.js +1 -0
  34. package/dist/resourcesapi.d.ts +10 -0
  35. package/dist/resourcesapi.d.ts.map +1 -1
  36. package/dist/resourcesapi.js +4 -0
  37. package/dist/resourcetypes.d.ts +14 -1
  38. package/dist/resourcetypes.d.ts.map +1 -1
  39. package/dist/serverapi.d.ts +10 -1
  40. package/dist/serverapi.d.ts.map +1 -1
  41. package/dist/streambundle.d.ts +1 -0
  42. package/dist/streambundle.d.ts.map +1 -1
  43. package/dist/subscriptionmanager.d.ts +10 -2
  44. package/dist/subscriptionmanager.d.ts.map +1 -1
  45. package/dist/weatherapi.d.ts +115 -6
  46. package/dist/weatherapi.d.ts.map +1 -1
  47. package/dist/weatherapi.js +1 -0
  48. package/package.json +3 -2
  49. package/tsconfig.tsbuildinfo +1 -1
  50. package/dist/autopilotapi.guard.d.ts +0 -3
  51. package/dist/autopilotapi.guard.d.ts.map +0 -1
  52. package/dist/autopilotapi.guard.js +0 -22
@@ -1 +1 @@
1
- {"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,GAAG,EAAE,SAAS,KAAK,MAAM,CAAA;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAM,WAAW,MAAM;IACrB;;;;;OAKG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,gBAAgB,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,CAAA;IAExE;;;;;;;OAOG;IACH,IAAI,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE5B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAE1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,MAAM,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAA;IAE/B;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAA;IAElC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,kBAAkB,CAAC,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAAA;IAE1C,UAAU,CAAC,EAAE,MAAM,MAAM,CAAA;IAEzB,aAAa,CAAC,EAAE,MAAM,MAAM,GAAG,IAAI,CAAA;IAEnC,gBAAgB,CAAC,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAA;CAC5C"}
1
+ {"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,GAAG,EAAE,SAAS,KAAK,MAAM,CAAA;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,MAAM,WAAW,MAAM;IACrB;;;;;OAKG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,gBAAgB,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,CAAA;IAExE;;;;;;;OAOG;IACH,IAAI,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE5B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAE1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,MAAM,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAA;IAE/B;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAA;IAElC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,kBAAkB,CAAC,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAAA;IAE1C,UAAU,CAAC,EAAE,MAAM,MAAM,CAAA;IAEzB,aAAa,CAAC,EAAE,MAAM,MAAM,GAAG,IAAI,CAAA;IAEnC,gBAAgB,CAAC,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAA;CAC5C"}
@@ -31,6 +31,7 @@
31
31
  * **Note: The _PropertyValues_ mechanism is not intended to be used for data passing on a regular basis, as the total history makes it a potential memory leak.**
32
32
  *
33
33
  * To safeguard against a component accidentally emitting regularly, via a fixed upper bound is enforced for the value array per _property name_. New values will be ignored if the upper bound is reached and are logged as errors.
34
+ * @category Server API
34
35
  */
35
36
  export interface PropertyValuesEmitter {
36
37
  /**
@@ -42,13 +43,16 @@ export interface PropertyValuesEmitter {
42
43
  */
43
44
  onPropertyValues(name: string, cb: PropertyValuesCallback): Unsubscribe;
44
45
  }
46
+ /** @category Server API */
45
47
  export interface PropertyValue {
46
48
  timestamp: number;
47
49
  setter: string;
48
50
  name: string;
49
51
  value: any;
50
52
  }
53
+ /** @category Server API */
51
54
  export type PropertyValuesCallback = (propValuesHistory: PropertyValue[]) => void;
55
+ /** @category Server API */
52
56
  export declare class PropertyValues {
53
57
  private streams;
54
58
  private count;
@@ -59,6 +63,7 @@ export declare class PropertyValues {
59
63
  }
60
64
  /**
61
65
  * @inline
66
+ * @category Server API
62
67
  */
63
68
  type Unsubscribe = () => void;
64
69
  export {};
@@ -1 +1 @@
1
- {"version":3,"file":"propertyvalues.d.ts","sourceRoot":"","sources":["../src/propertyvalues.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IAEH,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAA;IAEjD;;OAEG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,sBAAsB,GAAG,WAAW,CAAA;CACxE;AAED,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IAEZ,KAAK,EAAE,GAAG,CAAA;CACX;AAED,MAAM,MAAM,sBAAsB,GAAG,CACnC,iBAAiB,EAAE,aAAa,EAAE,KAC/B,IAAI,CAAA;AAQT,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;;GAEG;AACH,KAAK,WAAW,GAAG,MAAM,IAAI,CAAA"}
1
+ {"version":3,"file":"propertyvalues.d.ts","sourceRoot":"","sources":["../src/propertyvalues.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IAEH,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAA;IAEjD;;OAEG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,sBAAsB,GAAG,WAAW,CAAA;CACxE;AAED,2BAA2B;AAC3B,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IAEZ,KAAK,EAAE,GAAG,CAAA;CACX;AAED,2BAA2B;AAC3B,MAAM,MAAM,sBAAsB,GAAG,CACnC,iBAAiB,EAAE,aAAa,EAAE,KAC/B,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"}
@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
6
  exports.PropertyValues = void 0;
7
7
  const baconjs_1 = __importDefault(require("baconjs"));
8
+ /** @category Server API */
8
9
  class PropertyValues {
9
10
  streams = {};
10
11
  count = 0;
@@ -1,7 +1,14 @@
1
+ /** @category Resources API */
1
2
  export type SignalKResourceType = 'routes' | 'waypoints' | 'notes' | 'regions' | 'charts';
3
+ /**
4
+ * @hidden
5
+ * @category Resources API */
2
6
  export declare const SIGNALKRESOURCETYPES: SignalKResourceType[];
7
+ /** @category Resources API */
3
8
  export declare const isSignalKResourceType: (s: string) => boolean;
9
+ /** @category Resources API */
4
10
  export type ResourceType = SignalKResourceType | string;
11
+ /** @category Resources API */
5
12
  export interface ResourcesApi {
6
13
  register(pluginId: string, provider: ResourceProvider): void;
7
14
  unRegister(pluginId: string): void;
@@ -128,6 +135,7 @@ export interface ResourcesApi {
128
135
  */
129
136
  deleteResource(resType: SignalKResourceType, resId: string, providerId?: string): Promise<void>;
130
137
  }
138
+ /** @category Resources API */
131
139
  export interface ResourceProvider {
132
140
  /**
133
141
  * The resource type provided for by the plugin.These can be either __Standard__ _(Signal K defined)_ types defined in {@link SignalKResourceType}, or __Custom__ _(user defined)_ resource types _(e.g. `'fishingZones'`)_
@@ -138,6 +146,7 @@ export interface ResourceProvider {
138
146
  */
139
147
  methods: ResourceProviderMethods;
140
148
  }
149
+ /** @category Resources API */
141
150
  export interface ResourceProviderMethods {
142
151
  /**
143
152
  * This method is called when a request is made for resource entries that match a specific criteria.
@@ -340,6 +349,7 @@ export interface ResourceProviderMethods {
340
349
  */
341
350
  deleteResource(id: string): Promise<void>;
342
351
  }
352
+ /** @category Resources API */
343
353
  export interface ResourceProviderRegistry {
344
354
  /**
345
355
  * Used by _Resource Provider plugins_ to register each resource type it handles.
@@ -1 +1 @@
1
- {"version":3,"file":"resourcesapi.d.ts","sourceRoot":"","sources":["../src/resourcesapi.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mBAAmB,GAC3B,QAAQ,GACR,WAAW,GACX,OAAO,GACP,SAAS,GACT,QAAQ,CAAA;AAEZ,eAAO,MAAM,oBAAoB,EAAE,mBAAmB,EAMrD,CAAA;AACD,eAAO,MAAM,qBAAqB,GAAI,GAAG,MAAM,YACU,CAAA;AAEzD,MAAM,MAAM,YAAY,GAAG,mBAAmB,GAAG,MAAM,CAAA;AAEvD,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAAA;IAC5D,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,aAAa,CACX,OAAO,EAAE,mBAAmB,EAE5B,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EAC9B,UAAU,CAAC,EAAE,MAAM,GAElB,OAAO,CAAC;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC,CAAA;IAEjC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,WAAW,CACT,OAAO,EAAE,YAAY,EACrB,KAAK,EAAE,MAAM,EACb,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,MAAM,CAAC,CAAA;IAElB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,WAAW,CACT,OAAO,EAAE,mBAAmB,EAC5B,KAAK,EAAE,MAAM,EAEb,IAAI,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EAC5B,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,cAAc,CACZ,OAAO,EAAE,mBAAmB,EAC5B,KAAK,EAAE,MAAM,EACb,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,IAAI,CAAC,CAAA;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,YAAY,CAAA;IAElB;;OAEG;IACH,OAAO,EAAE,uBAAuB,CAAA;CACjC;AAED,MAAM,WAAW,uBAAuB;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyDG;IACH,aAAa,CAAC,KAAK,EAAE;QAEnB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAEnB,GAAG,OAAO,CAAC;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC,CAAA;IAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAE3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACH,WAAW,CACT,EAAE,EAAE,MAAM,EAEV,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAC5B,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;;;;;;;OAiBG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC1C;AAED,MAAM,WAAW,wBAAwB;IACvC;;;;;OAKG;IACH,wBAAwB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAAA;IAE1D;;;;OAIG;IACH,YAAY,EAAE,YAAY,CAAA;CAC3B"}
1
+ {"version":3,"file":"resourcesapi.d.ts","sourceRoot":"","sources":["../src/resourcesapi.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,MAAM,MAAM,mBAAmB,GAC3B,QAAQ,GACR,WAAW,GACX,OAAO,GACP,SAAS,GACT,QAAQ,CAAA;AAEZ;;8BAE8B;AAC9B,eAAO,MAAM,oBAAoB,EAAE,mBAAmB,EAMrD,CAAA;AACD,+BAA+B;AAC/B,eAAO,MAAM,qBAAqB,GAAI,GAAG,MAAM,YACU,CAAA;AAEzD,+BAA+B;AAC/B,MAAM,MAAM,YAAY,GAAG,mBAAmB,GAAG,MAAM,CAAA;AAEvD,+BAA+B;AAC/B,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAAA;IAC5D,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,aAAa,CACX,OAAO,EAAE,mBAAmB,EAE5B,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EAC9B,UAAU,CAAC,EAAE,MAAM,GAElB,OAAO,CAAC;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC,CAAA;IAEjC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,WAAW,CACT,OAAO,EAAE,YAAY,EACrB,KAAK,EAAE,MAAM,EACb,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,MAAM,CAAC,CAAA;IAElB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,WAAW,CACT,OAAO,EAAE,mBAAmB,EAC5B,KAAK,EAAE,MAAM,EAEb,IAAI,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,EAC5B,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,cAAc,CACZ,OAAO,EAAE,mBAAmB,EAC5B,KAAK,EAAE,MAAM,EACb,UAAU,CAAC,EAAE,MAAM,GAClB,OAAO,CAAC,IAAI,CAAC,CAAA;CACjB;AAED,+BAA+B;AAC/B,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,YAAY,CAAA;IAElB;;OAEG;IACH,OAAO,EAAE,uBAAuB,CAAA;CACjC;AAED,+BAA+B;AAC/B,MAAM,WAAW,uBAAuB;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyDG;IACH,aAAa,CAAC,KAAK,EAAE;QAEnB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAEnB,GAAG,OAAO,CAAC;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC,CAAA;IAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0DG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAE3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACH,WAAW,CACT,EAAE,EAAE,MAAM,EAEV,KAAK,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAC5B,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;;;;;;;;;;OAiBG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC1C;AAED,+BAA+B;AAC/B,MAAM,WAAW,wBAAwB;IACvC;;;;;OAKG;IACH,wBAAwB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAAA;IAE1D;;;;OAIG;IACH,YAAY,EAAE,YAAY,CAAA;CAC3B"}
@@ -1,6 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.isSignalKResourceType = exports.SIGNALKRESOURCETYPES = void 0;
4
+ /**
5
+ * @hidden
6
+ * @category Resources API */
4
7
  exports.SIGNALKRESOURCETYPES = [
5
8
  'routes',
6
9
  'waypoints',
@@ -8,5 +11,6 @@ exports.SIGNALKRESOURCETYPES = [
8
11
  'regions',
9
12
  'charts'
10
13
  ];
14
+ /** @category Resources API */
11
15
  const isSignalKResourceType = (s) => exports.SIGNALKRESOURCETYPES.includes(s);
12
16
  exports.isSignalKResourceType = isSignalKResourceType;
@@ -1,9 +1,12 @@
1
1
  import { Position } from '.';
2
- /** A resource returned from the API will always have these fields */
2
+ /** A resource returned from the API will always have these fields
3
+ * @hidden
4
+ */
3
5
  export type Resource<T> = T & {
4
6
  timestamp: string;
5
7
  $source: string;
6
8
  };
9
+ /** @category Resources API */
7
10
  export interface Route {
8
11
  name?: string;
9
12
  description?: string;
@@ -20,6 +23,7 @@ export interface Route {
20
23
  id?: string;
21
24
  };
22
25
  }
26
+ /** @category Resources API */
23
27
  export interface Waypoint {
24
28
  name?: string;
25
29
  description?: string;
@@ -34,6 +38,7 @@ export interface Waypoint {
34
38
  id?: string;
35
39
  };
36
40
  }
41
+ /** @category Resources API */
37
42
  export interface Note {
38
43
  name?: string;
39
44
  description?: string;
@@ -43,11 +48,13 @@ export interface Note {
43
48
  mimeType?: string;
44
49
  url?: string;
45
50
  }
51
+ /** @category Resources API */
46
52
  export interface Region {
47
53
  name?: string;
48
54
  description?: string;
49
55
  feature: Polygon | MultiPolygon;
50
56
  }
57
+ /** @category Resources API */
51
58
  export interface Chart {
52
59
  name: string;
53
60
  identifier: string;
@@ -61,10 +68,15 @@ export interface Chart {
61
68
  bounds?: [[number, number], [number, number]];
62
69
  chartFormat: string;
63
70
  }
71
+ /** @hidden */
64
72
  export type GeoJsonPoint = [number, number, number?];
73
+ /** @hidden */
65
74
  export type GeoJsonLinestring = GeoJsonPoint[];
75
+ /** @hidden */
66
76
  export type GeoJsonPolygon = GeoJsonLinestring[];
77
+ /** @hidden */
67
78
  export type GeoJsonMultiPolygon = GeoJsonPolygon[];
79
+ /** @hidden */
68
80
  export interface Polygon {
69
81
  type: 'Feature';
70
82
  geometry: {
@@ -74,6 +86,7 @@ export interface Polygon {
74
86
  properties?: object;
75
87
  id?: string;
76
88
  }
89
+ /** @hidden */
77
90
  export interface MultiPolygon {
78
91
  type: 'Feature';
79
92
  geometry: {
@@ -1 +1 @@
1
- {"version":3,"file":"resourcetypes.d.ts","sourceRoot":"","sources":["../src/resourcetypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,CAAA;AAE5B,qEAAqE;AACrE,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG;IAC5B,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,WAAW,KAAK;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE;QACP,IAAI,EAAE,SAAS,CAAA;QACf,QAAQ,EAAE;YACR,IAAI,EAAE,YAAY,CAAA;YAClB,WAAW,EAAE,iBAAiB,CAAA;SAC/B,CAAA;QACD,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,EAAE,CAAC,EAAE,MAAM,CAAA;KACZ,CAAA;CACF;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,EAAE;QACP,IAAI,EAAE,SAAS,CAAA;QACf,QAAQ,EAAE;YACR,IAAI,EAAE,OAAO,CAAA;YACb,WAAW,EAAE,YAAY,CAAA;SAC1B,CAAA;QACD,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,EAAE,CAAC,EAAE,MAAM,CAAA;KACZ,CAAA;CACF;AAED,MAAM,WAAW,IAAI;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,MAAM;IACrB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,OAAO,GAAG,YAAY,CAAA;CAChC;AAED,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;IAC7C,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;AACpD,MAAM,MAAM,iBAAiB,GAAG,YAAY,EAAE,CAAA;AAC9C,MAAM,MAAM,cAAc,GAAG,iBAAiB,EAAE,CAAA;AAChD,MAAM,MAAM,mBAAmB,GAAG,cAAc,EAAE,CAAA;AAElD,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,SAAS,CAAA;IACf,QAAQ,EAAE;QACR,IAAI,EAAE,SAAS,CAAA;QACf,WAAW,EAAE,cAAc,CAAA;KAC5B,CAAA;IACD,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,SAAS,CAAA;IACf,QAAQ,EAAE;QACR,IAAI,EAAE,cAAc,CAAA;QACpB,WAAW,EAAE,mBAAmB,CAAA;KACjC,CAAA;IACD,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ"}
1
+ {"version":3,"file":"resourcetypes.d.ts","sourceRoot":"","sources":["../src/resourcetypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,CAAA;AAE5B;;GAEG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG;IAC5B,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,+BAA+B;AAC/B,MAAM,WAAW,KAAK;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE;QACP,IAAI,EAAE,SAAS,CAAA;QACf,QAAQ,EAAE;YACR,IAAI,EAAE,YAAY,CAAA;YAClB,WAAW,EAAE,iBAAiB,CAAA;SAC/B,CAAA;QACD,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,EAAE,CAAC,EAAE,MAAM,CAAA;KACZ,CAAA;CACF;AAED,+BAA+B;AAC/B,MAAM,WAAW,QAAQ;IACvB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,EAAE;QACP,IAAI,EAAE,SAAS,CAAA;QACf,QAAQ,EAAE;YACR,IAAI,EAAE,OAAO,CAAA;YACb,WAAW,EAAE,YAAY,CAAA;SAC1B,CAAA;QACD,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,EAAE,CAAC,EAAE,MAAM,CAAA;KACZ,CAAA;CACF;AAED,+BAA+B;AAC/B,MAAM,WAAW,IAAI;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,+BAA+B;AAC/B,MAAM,WAAW,MAAM;IACrB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,OAAO,GAAG,YAAY,CAAA;CAChC;AAED,+BAA+B;AAC/B,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IACtB,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;IAC7C,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,cAAc;AACd,MAAM,MAAM,YAAY,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;AACpD,cAAc;AACd,MAAM,MAAM,iBAAiB,GAAG,YAAY,EAAE,CAAA;AAC9C,cAAc;AACd,MAAM,MAAM,cAAc,GAAG,iBAAiB,EAAE,CAAA;AAChD,cAAc;AACd,MAAM,MAAM,mBAAmB,GAAG,cAAc,EAAE,CAAA;AAElD,cAAc;AACd,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,SAAS,CAAA;IACf,QAAQ,EAAE;QACR,IAAI,EAAE,SAAS,CAAA;QACf,WAAW,EAAE,cAAc,CAAA;KAC5B,CAAA;IACD,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ;AAED,cAAc;AACd,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,SAAS,CAAA;IACf,QAAQ,EAAE;QACR,IAAI,EAAE,cAAc,CAAA;QACpB,WAAW,EAAE,mBAAmB,CAAA;KACjC,CAAA;IACD,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ"}
@@ -1,5 +1,6 @@
1
1
  import { SKVersion, AutopilotProviderRegistry, WithFeatures, PropertyValuesEmitter, ResourceProviderRegistry, WeatherProviderRegistry, Delta } from '.';
2
2
  import { CourseApi } from './course';
3
+ import { HistoryApiRegistry, WithHistoryApi } from './history';
3
4
  import { StreamBundle } from './streambundle';
4
5
  import { SubscriptionManager } from './subscriptionmanager';
5
6
  /**
@@ -15,8 +16,9 @@ import { SubscriptionManager } from './subscriptionmanager';
15
16
  *
16
17
  * > [!WARNING]
17
18
  * > Typing is incomplete. If you find a missing or inaccurate type, please [report it](https://github.com/SignalK/signalk-server/issues/1917).
19
+ * @category Server API
18
20
  */
19
- export interface ServerAPI extends PropertyValuesEmitter, ResourceProviderRegistry, AutopilotProviderRegistry, WeatherProviderRegistry, WithFeatures, CourseApi, SelfIdentity {
21
+ export interface ServerAPI extends PropertyValuesEmitter, ResourceProviderRegistry, AutopilotProviderRegistry, WeatherProviderRegistry, WithHistoryApi, HistoryApiRegistry, WithFeatures, CourseApi, SelfIdentity {
20
22
  /**
21
23
  * Returns the entry for the provided path starting from `vessels.self` in the full data model.
22
24
  *
@@ -348,25 +350,32 @@ export interface ServerAPI extends PropertyValuesEmitter, ResourceProviderRegist
348
350
  }
349
351
  /**
350
352
  * @deprecated Use {@link ServerAPI} instead.
353
+ * @category Server API
351
354
  */
352
355
  export type PluginServerApp = ServerAPI;
356
+ /** @category Server API */
353
357
  export type DeltaInputHandler = (delta: Delta, next: (delta: Delta) => void) => void;
358
+ /** @category Server API */
354
359
  export interface Ports {
355
360
  byId: string[];
356
361
  byPath: string[];
357
362
  byOpenPlotter: string[];
358
363
  serialports: any;
359
364
  }
365
+ /** @category Server API */
360
366
  export interface SelfIdentity {
361
367
  selfType: string;
362
368
  selfId: string;
363
369
  selfContext: string;
364
370
  }
371
+ /** @category Server API */
365
372
  export interface Metadata {
366
373
  units?: string;
367
374
  description?: string;
368
375
  }
376
+ /** @category Server API */
369
377
  export type ActionHandler = (context: string, path: string, value: any, callback: (result: ActionResult) => void) => ActionResult;
378
+ /** @category Server API */
370
379
  export interface ActionResult {
371
380
  state: 'COMPLETED' | 'PENDING' | 'FAILED';
372
381
  statusCode?: number;
@@ -1 +1 @@
1
- {"version":3,"file":"serverapi.d.ts","sourceRoot":"","sources":["../src/serverapi.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,yBAAyB,EACzB,YAAY,EACZ,qBAAqB,EACrB,wBAAwB,EACxB,uBAAuB,EACvB,KAAK,EACN,MAAM,GAAG,CAAA;AACV,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAE3D;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,SACf,SAAQ,qBAAqB,EAC3B,wBAAwB,EACxB,yBAAyB,EACzB,uBAAuB,EACvB,YAAY,EACZ,SAAS,EACT,YAAY;IACd;;;;;;;;;;;;;OAaG;IAEH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAA;IAE9B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IAEH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAA;IAE1B;;OAEG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAA;IAE/C;;OAEG;IAEH,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;IAE1E;;OAEG;IACH,OAAO,CACL,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,EACzC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,KAAK,IAAI,EAC/B,MAAM,EAAE,MAAM,GAEb,OAAO,CAAC,GAAG,CAAC,CAAA;IAEf;;OAEG;IACH,YAAY,EAAE,YAAY,CAAA;IAE1B;;;OAGG;IACH,mBAAmB,EAAE,mBAAmB,CAAA;IAIxC,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;IAE7C;;OAEG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB;;;;;;;;;;;;OAYG;IAEH,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,yBAAyB,CAAC,OAAO,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAE3D;;;;;;;;;;;;;;;OAeG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAElC;;;;;;;;;;;;;OAaG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI,CAAA;IAE3E;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CACf,aAAa,EAAE,MAAM,EACrB,EAAE,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,cAAc,GAAG,IAAI,KAAK,IAAI,GAC9C,IAAI,CAAA;IAEP;;;;;;;;;OASG;IACH,iBAAiB,IAAI,MAAM,CAAA;IAE3B;;;;;;;;OAQG;IACH,cAAc,IAAI,MAAM,CAAA;IAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuFG;IACH,kBAAkB,CAChB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,aAAa,EACvB,MAAM,CAAC,EAAE,MAAM,GACd,IAAI,CAAA;IAEP,qBAAqB,CACnB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,aAAa,EACvB,MAAM,CAAC,EAAE,MAAM,GACd,IAAI,CAAA;IAEP,uBAAuB,CAAC,QAAQ,EAAE;QAChC,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,UAAU,EAAE,OAAO,KAAK,IAAI,KAAK,IAAI,CAAA;QACxE,UAAU,EAAE,CACV,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,IAAI,KAC3B,IAAI,CAAA;QACT,aAAa,EAAE,CAGb,KAAK,EAAE,GAAG,EACV,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,KAC7B,IAAI,CAAA;KACV,GAAG,IAAI,CAAA;IAER;;;;OAIG;IACH,cAAc,IAAI,OAAO,CAAC,KAAK,CAAC,CAAA;IAEhC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,oBAAoB,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3C;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,SAAS,CAAA;AAEvC,MAAM,MAAM,iBAAiB,GAAG,CAC9B,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,KACzB,IAAI,CAAA;AAET,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,aAAa,EAAE,MAAM,EAAE,CAAA;IAEvB,WAAW,EAAE,GAAG,CAAA;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,QAAQ;IACvB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,MAAM,aAAa,GAAG,CAC1B,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EAEZ,KAAK,EAAE,GAAG,EACV,QAAQ,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,KACrC,YAAY,CAAA;AAEjB,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAA;IACzC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB"}
1
+ {"version":3,"file":"serverapi.d.ts","sourceRoot":"","sources":["../src/serverapi.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,yBAAyB,EACzB,YAAY,EACZ,qBAAqB,EACrB,wBAAwB,EACxB,uBAAuB,EACvB,KAAK,EACN,MAAM,GAAG,CAAA;AACV,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AACpC,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAE3D;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,SACf,SACE,qBAAqB,EACrB,wBAAwB,EACxB,yBAAyB,EACzB,uBAAuB,EACvB,cAAc,EACd,kBAAkB,EAClB,YAAY,EACZ,SAAS,EACT,YAAY;IACd;;;;;;;;;;;;;OAaG;IAEH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAA;IAE9B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IAEH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAA;IAE1B;;OAEG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAA;IAE/C;;OAEG;IAEH,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;IAE1E;;OAEG;IACH,OAAO,CACL,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,EACzC,QAAQ,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,KAAK,IAAI,EAC/B,MAAM,EAAE,MAAM,GAEb,OAAO,CAAC,GAAG,CAAC,CAAA;IAEf;;OAEG;IACH,YAAY,EAAE,YAAY,CAAA;IAE1B;;;OAGG;IACH,mBAAmB,EAAE,mBAAmB,CAAA;IAIxC,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAA;IAE7C;;OAEG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB;;;;;;;;;;;;OAYG;IAEH,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA;IAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,yBAAyB,CAAC,OAAO,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAE3D;;;;;;;;;;;;;;;OAeG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAElC;;;;;;;;;;;;;OAaG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAA;IAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,IAAI,CAAA;IAE3E;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CACf,aAAa,EAAE,MAAM,EACrB,EAAE,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,cAAc,GAAG,IAAI,KAAK,IAAI,GAC9C,IAAI,CAAA;IAEP;;;;;;;;;OASG;IACH,iBAAiB,IAAI,MAAM,CAAA;IAE3B;;;;;;;;OAQG;IACH,cAAc,IAAI,MAAM,CAAA;IAExB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuFG;IACH,kBAAkB,CAChB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,aAAa,EACvB,MAAM,CAAC,EAAE,MAAM,GACd,IAAI,CAAA;IAEP,qBAAqB,CACnB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,aAAa,EACvB,MAAM,CAAC,EAAE,MAAM,GACd,IAAI,CAAA;IAEP,uBAAuB,CAAC,QAAQ,EAAE;QAChC,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,UAAU,EAAE,OAAO,KAAK,IAAI,KAAK,IAAI,CAAA;QACxE,UAAU,EAAE,CACV,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,IAAI,KAC3B,IAAI,CAAA;QACT,aAAa,EAAE,CAGb,KAAK,EAAE,GAAG,EACV,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,KAC7B,IAAI,CAAA;KACV,GAAG,IAAI,CAAA;IAER;;;;OAIG;IACH,cAAc,IAAI,OAAO,CAAC,KAAK,CAAC,CAAA;IAEhC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,oBAAoB,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3C;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,SAAS,CAAA;AAEvC,2BAA2B;AAC3B,MAAM,MAAM,iBAAiB,GAAG,CAC9B,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,KACzB,IAAI,CAAA;AAET,2BAA2B;AAC3B,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,aAAa,EAAE,MAAM,EAAE,CAAA;IAEvB,WAAW,EAAE,GAAG,CAAA;CACjB;AAED,2BAA2B;AAC3B,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,2BAA2B;AAC3B,MAAM,WAAW,QAAQ;IACvB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,2BAA2B;AAC3B,MAAM,MAAM,aAAa,GAAG,CAC1B,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EAEZ,KAAK,EAAE,GAAG,EACV,QAAQ,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,KACrC,YAAY,CAAA;AAEjB,2BAA2B;AAC3B,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAA;IACzC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB"}
@@ -1,5 +1,6 @@
1
1
  import { NormalizedDelta, Path, Value } from './deltas';
2
2
  import * as Bacon from 'baconjs';
3
+ /** @category Server API */
3
4
  export interface StreamBundle {
4
5
  /**
5
6
  * Get a [Bacon JS 1.0](https://baconjs.github.io/api.html) stream for a Signal K path that will stream values from any context.
@@ -1 +1 @@
1
- {"version":3,"file":"streambundle.d.ts","sourceRoot":"","sources":["../src/streambundle.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,UAAU,CAAA;AACvD,OAAO,KAAK,KAAK,MAAM,SAAS,CAAA;AAEhC,MAAM,WAAW,YAAY;IAC3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACH,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,eAAe,CAAC,CAAA;IAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,eAAe,CAAC,CAAA;IAE3D;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,aAAa,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;IAErD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,iBAAiB,IAAI,IAAI,EAAE,CAAA;CAC5B"}
1
+ {"version":3,"file":"streambundle.d.ts","sourceRoot":"","sources":["../src/streambundle.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,UAAU,CAAA;AACvD,OAAO,KAAK,KAAK,MAAM,SAAS,CAAA;AAEhC,2BAA2B;AAC3B,MAAM,WAAW,YAAY;IAC3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACH,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,eAAe,CAAC,CAAA;IAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,eAAe,CAAC,CAAA;IAE3D;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,aAAa,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;IAErD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,iBAAiB,IAAI,IAAI,EAAE,CAAA;CAC5B"}
@@ -1,15 +1,19 @@
1
1
  import { RelativePositionOrigin } from '.';
2
2
  import { Context, Delta, Path } from './deltas';
3
+ /** @category Server API */
3
4
  export interface SubscriptionManager {
4
5
  subscribe(command: SubscribeMessage, unsubscribes: Unsubscribes, errorCallback: (err: unknown) => void, callback: SubscribeCallback, user?: string): void;
5
6
  unsubscribe(msg: UnsubscribeMessage, unsubscribes: Unsubscribes): void;
6
7
  }
8
+ /** @category Server API */
7
9
  export type SubscribeCallback = (delta: Delta) => void;
10
+ /** @category Server API */
8
11
  export type Unsubscribes = Array<() => void>;
9
12
  /**
10
13
  * A message to allow a client to subscribe for data updates from a signalk server
11
14
  *
12
15
  * @see [SignalK Specification: Subscription Protocol](https://signalk.org/specification/1.7.0/doc/subscription_protocol.html?highlight=subscribe#introduction)
16
+ * @category Server API
13
17
  */
14
18
  export interface SubscribeMessage {
15
19
  /**
@@ -21,7 +25,8 @@ export interface SubscribeMessage {
21
25
  */
22
26
  subscribe: SubscriptionOptions[];
23
27
  }
24
- /** @inline */
28
+ /** @inline
29
+ */
25
30
  type FixedPolicyOptions = {
26
31
  /**
27
32
  * - `fixed` - Send the last known values every `period`.
@@ -37,7 +42,8 @@ type FixedPolicyOptions = {
37
42
  */
38
43
  minPeriod?: never;
39
44
  };
40
- /** @inline docs inherited from above */
45
+ /** @inline docs inherited from above
46
+ */
41
47
  type InstantPolicyOptions = {
42
48
  policy?: 'instant';
43
49
  minPeriod?: number;
@@ -46,6 +52,7 @@ type InstantPolicyOptions = {
46
52
  /**
47
53
  * A path object with optional criteria to control output
48
54
  * @inline
55
+ * @category Server API
49
56
  */
50
57
  export type SubscriptionOptions = (FixedPolicyOptions | InstantPolicyOptions) & {
51
58
  /**
@@ -59,6 +66,7 @@ export type SubscriptionOptions = (FixedPolicyOptions | InstantPolicyOptions) &
59
66
  };
60
67
  /**
61
68
  * A message to allow a client to unsubscribe from data updates from a signalk server
69
+ * @category Server API
62
70
  */
63
71
  export interface UnsubscribeMessage {
64
72
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"subscriptionmanager.d.ts","sourceRoot":"","sources":["../src/subscriptionmanager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,GAAG,CAAA;AAC1C,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,UAAU,CAAA;AAE/C,MAAM,WAAW,mBAAmB;IAClC,SAAS,CACP,OAAO,EAAE,gBAAgB,EACzB,YAAY,EAAE,YAAY,EAC1B,aAAa,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,EACrC,QAAQ,EAAE,iBAAiB,EAC3B,IAAI,CAAC,EAAE,MAAM,GACZ,IAAI,CAAA;IAEP,WAAW,CAAC,GAAG,EAAE,kBAAkB,EAAE,YAAY,EAAE,YAAY,GAAG,IAAI,CAAA;CACvE;AAED,MAAM,MAAM,iBAAiB,GAAG,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;AAEtD,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,IAAI,CAAC,CAAA;AAE5C;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,OAAO,EAAE,OAAO,GAAG,sBAAsB,CAAA;IAEzC;;OAEG;IACH,SAAS,EAAE,mBAAmB,EAAE,CAAA;CACjC;AAED,cAAc;AACd,KAAK,kBAAkB,GAAG;IACxB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAA;CAClB,CAAA;AAED,wCAAwC;AACxC,KAAK,oBAAoB,GAAG;IAC1B,MAAM,CAAC,EAAE,SAAS,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,KAAK,CAAA;CACf,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAC9B,kBAAkB,GAClB,oBAAoB,CACvB,GAAG;IACF;;OAEG;IACH,IAAI,CAAC,EAAE,IAAI,CAAA;IAEX;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,OAAO,EAAE,GAAG,CAAA;IAEZ;;;;;OAKG;IACH,WAAW,EAAE;QACX;YACE,IAAI,EAAE,GAAG,CAAA;SACV;KACF,CAAA;CACF"}
1
+ {"version":3,"file":"subscriptionmanager.d.ts","sourceRoot":"","sources":["../src/subscriptionmanager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,GAAG,CAAA;AAC1C,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,UAAU,CAAA;AAE/C,4BAA4B;AAC5B,MAAM,WAAW,mBAAmB;IAClC,SAAS,CACP,OAAO,EAAE,gBAAgB,EACzB,YAAY,EAAE,YAAY,EAC1B,aAAa,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,EACrC,QAAQ,EAAE,iBAAiB,EAC3B,IAAI,CAAC,EAAE,MAAM,GACZ,IAAI,CAAA;IAEP,WAAW,CAAC,GAAG,EAAE,kBAAkB,EAAE,YAAY,EAAE,YAAY,GAAG,IAAI,CAAA;CACvE;AAED,4BAA4B;AAC5B,MAAM,MAAM,iBAAiB,GAAG,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;AAEtD,4BAA4B;AAC5B,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,MAAM,IAAI,CAAC,CAAA;AAE5C;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,OAAO,EAAE,OAAO,GAAG,sBAAsB,CAAA;IAEzC;;OAEG;IACH,SAAS,EAAE,mBAAmB,EAAE,CAAA;CACjC;AAED;GACG;AACH,KAAK,kBAAkB,GAAG;IACxB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAA;CAClB,CAAA;AAED;GACG;AACH,KAAK,oBAAoB,GAAG;IAC1B,MAAM,CAAC,EAAE,SAAS,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,KAAK,CAAA;CACf,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAC9B,kBAAkB,GAClB,oBAAoB,CACvB,GAAG;IACF;;OAEG;IACH,IAAI,CAAC,EAAE,IAAI,CAAA;IAEX;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,OAAO,EAAE,GAAG,CAAA;IAEZ;;;;;OAKG;IACH,WAAW,EAAE;QACX;YACE,IAAI,EAAE,GAAG,CAAA;SACV;KACF,CAAA;CACF"}
@@ -1,8 +1,102 @@
1
1
  import { Position } from '.';
2
+ /** @category Weather API */
2
3
  export interface WeatherApi {
3
4
  register: (pluginId: string, provider: WeatherProvider) => void;
4
5
  unRegister: (pluginId: string) => void;
6
+ /**
7
+ * Retrieves observation data from the weather provider for the supplied position.
8
+ * The returned array of observations should be ordered in descending date order.
9
+ *
10
+ * @category Weather API
11
+ *
12
+ * @param position Location of interest
13
+ * @param options Options
14
+ *
15
+ * @example
16
+ ```javascript
17
+ getObservations({latitude: 16.34765, longitude: 12.5432}, {maxCount: 1});
18
+ ```
19
+
20
+ ```JSON
21
+ [
22
+ {
23
+ "date": "2024-05-03T06:00:00.259Z",
24
+ "type": "observation",
25
+ "outside": { ... }
26
+ },
27
+ {
28
+ "date": "2024-05-03T05:00:00.259Z",
29
+ "type": "observation",
30
+ "outside": { ... }
31
+ }
32
+ ]
33
+ ```
34
+ */
35
+ getObservations: (position: Position, options?: WeatherReqParams) => Promise<WeatherData[]>;
36
+ /**
37
+ * Retrieves forecast data from the weather provider for the supplied position, forecast type and number of intervals.
38
+ * The returned array of forecasts should be ordered in ascending date order.
39
+ *
40
+ * @category Weather API
41
+ *
42
+ * @param position Location of interest
43
+ * @param type Type of forecast point | daily
44
+ * @param options Options
45
+ *
46
+ * @example
47
+ * Retrieve point forecast data for the next eight point intervalss
48
+ ```javascript
49
+ getForecasts(
50
+ {latitude: 16.34765, longitude: 12.5432},
51
+ 'point',
52
+ {maxCount: 8}
53
+ );
54
+ ```
55
+
56
+ ```JSON
57
+ [
58
+ {
59
+ "date": "2024-05-03T06:00:00.259Z",
60
+ "type": "point",
61
+ "outside": { ... }
62
+ },
63
+ {
64
+ "date": "2024-05-03T05:00:00.259Z",
65
+ "type": "point",
66
+ "outside": { ... }
67
+ }
68
+ ]
69
+ ```
70
+ */
71
+ getForecasts: (position: Position, type: WeatherForecastType, options?: WeatherReqParams) => Promise<WeatherData[]>;
72
+ /**
73
+ * Retrieves warning data from the weather provider for the supplied position.
74
+ * The returned array of warnings should be ordered in ascending date order.
75
+ *
76
+ * @category Weather API
77
+ *
78
+ * @param position Location of interest
79
+ *
80
+ * @example
81
+ ```javascript
82
+ getWarnings({latitude: 16.34765, longitude: 12.5432});
83
+ ```
84
+
85
+ ```JSON
86
+ [
87
+ {
88
+ "startTime": "2024-05-03T05:00:00.259Z",
89
+ "endTime": "2024-05-03T08:00:00.702Z",
90
+ "details": "Strong wind warning.",
91
+ "source": "MyWeatherService",
92
+ "type": "Warning"
93
+ }
94
+ ]
95
+ ```
96
+ */
97
+ getWarnings: (position: Position) => Promise<WeatherWarning[]>;
5
98
  }
99
+ /** @category Weather API */
6
100
  export interface WeatherProviderRegistry {
7
101
  /**
8
102
  * Used by _Weather Provider plugins_ to register the weather service from which the data is sourced.
@@ -11,9 +105,16 @@ export interface WeatherProviderRegistry {
11
105
  * @category Weather API
12
106
  */
13
107
  registerWeatherProvider: (provider: WeatherProvider) => void;
108
+ /**
109
+ * Access the Weather API to get observations, forcasts and warnings.
110
+ *
111
+ * @category Weather API
112
+ */
113
+ weatherApi: WeatherApi;
14
114
  }
15
115
  /**
16
116
  * @hidden visible through ServerAPI
117
+ * @category Weather API
17
118
  */
18
119
  export interface WeatherProviders {
19
120
  [id: string]: {
@@ -21,11 +122,14 @@ export interface WeatherProviders {
21
122
  isDefault: boolean;
22
123
  };
23
124
  }
125
+ /**@category Weather API */
24
126
  export declare const isWeatherProvider: (obj: any) => boolean;
127
+ /** @category Weather API */
25
128
  export interface WeatherProvider {
26
129
  name: string;
27
130
  methods: WeatherProviderMethods;
28
131
  }
132
+ /** @category Weather API */
29
133
  export interface WeatherProviderMethods {
30
134
  pluginId?: string;
31
135
  /**
@@ -122,7 +226,7 @@ export interface WeatherProviderMethods {
122
226
  getWarnings: (position: Position) => Promise<WeatherWarning[]>;
123
227
  }
124
228
  /**
125
- * @hidden visible through ServerAPI
229
+ * @category Weather API
126
230
  */
127
231
  export interface WeatherWarning {
128
232
  startTime: string;
@@ -136,21 +240,26 @@ export interface WeatherWarning {
136
240
  *
137
241
  * @prop maxCount Maximum number of records to return
138
242
  * @prop startDate Start date of forecast / observation data (format: YYYY-MM-DD)
243
+ * @prop custom Additional query parameters in the API request
244
+ * @category Weather API
139
245
  */
140
246
  export interface WeatherReqParams {
141
247
  maxCount?: number;
142
248
  startDate?: string;
249
+ custom?: {
250
+ [key: string]: string | number | boolean | object | null;
251
+ };
143
252
  }
144
253
  /**
145
- * @hidden visible through ServerAPI
254
+ * @category Weather API
146
255
  */
147
256
  export type WeatherForecastType = 'daily' | 'point';
148
257
  /**
149
- * @hidden visible through ServerAPI
258
+ * @category Weather API
150
259
  */
151
260
  export type WeatherDataType = WeatherForecastType | 'observation';
152
261
  /**
153
- * @hidden visible through ServerAPI
262
+ * @category Weather API
154
263
  */
155
264
  export interface WeatherData {
156
265
  description?: string;
@@ -198,11 +307,11 @@ export interface WeatherData {
198
307
  };
199
308
  }
200
309
  /**
201
- * @hidden visible through ServerAPI
310
+ * @category Weather API
202
311
  */
203
312
  export type TendencyKind = 'steady' | 'decreasing' | 'increasing' | 'not available';
204
313
  /**
205
- * @hidden visible through ServerAPI
314
+ * @category Weather API
206
315
  */
207
316
  export type PrecipitationKind = 'reserved' | 'rain' | 'thunderstorm' | 'freezing rain' | 'mixed/ice' | 'snow' | 'reserved' | 'not available';
208
317
  //# sourceMappingURL=weatherapi.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"weatherapi.d.ts","sourceRoot":"","sources":["../src/weatherapi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,CAAA;AAE5B,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,eAAe,KAAK,IAAI,CAAA;IAC/D,UAAU,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;CACvC;AAED,MAAM,WAAW,uBAAuB;IACtC;;;;;OAKG;IACH,uBAAuB,EAAE,CAAC,QAAQ,EAAE,eAAe,KAAK,IAAI,CAAA;CAC7D;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,CAAC,EAAE,EAAE,MAAM,GAAG;QACZ,IAAI,EAAE,MAAM,CAAA;QACZ,SAAS,EAAE,OAAO,CAAA;KACnB,CAAA;CACF;AAGD,eAAO,MAAM,iBAAiB,GAAI,KAAK,GAAG,YAezC,CAAA;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,sBAAsB,CAAA;CAChC;AAED,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;MA4BE;IACF,eAAe,EAAE,CACf,QAAQ,EAAE,QAAQ,EAClB,OAAO,CAAC,EAAE,gBAAgB,KACvB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAkCE;IACF,YAAY,EAAE,CACZ,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,gBAAgB,KACvB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;MAwBE;IACF,WAAW,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC,cAAc,EAAE,CAAC,CAAA;CAC/D;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,GAAG,OAAO,CAAA;AACnD;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,mBAAmB,GAAG,aAAa,CAAA;AAGjE;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,eAAe,CAAA;IACrB,OAAO,CAAC,EAAE;QACR,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB,oBAAoB,CAAC,EAAE,MAAM,CAAA;QAC7B,mBAAmB,CAAC,EAAE,MAAM,CAAA;QAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAA;QACzB,oBAAoB,CAAC,EAAE,MAAM,CAAA;QAC7B,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,mBAAmB,CAAC,EAAE,MAAM,CAAA;QAC5B,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,gBAAgB,CAAC,EAAE,YAAY,CAAA;QAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAA;QACzB,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;KACtC,CAAA;IACD,KAAK,CAAC,EAAE;QACN,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,aAAa,CAAC,EAAE,YAAY,CAAA;QAC5B,mBAAmB,CAAC,EAAE,MAAM,CAAA;QAC5B,uBAAuB,CAAC,EAAE,MAAM,CAAA;QAChC,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,qBAAqB,CAAC,EAAE,MAAM,CAAA;QAC9B,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,aAAa,CAAC,EAAE,MAAM,CAAA;QACtB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,cAAc,CAAC,EAAE,MAAM,CAAA;KACxB,CAAA;IACD,IAAI,CAAC,EAAE;QACL,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,aAAa,CAAC,EAAE,MAAM,CAAA;QACtB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,aAAa,CAAC,EAAE,MAAM,CAAA;KACvB,CAAA;IACD,GAAG,CAAC,EAAE;QACJ,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,CAAA;CACF;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GACpB,QAAQ,GACR,YAAY,GACZ,YAAY,GACZ,eAAe,CAAA;AAEnB;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,UAAU,GACV,MAAM,GACN,cAAc,GACd,eAAe,GACf,WAAW,GACX,MAAM,GACN,UAAU,GACV,eAAe,CAAA"}
1
+ {"version":3,"file":"weatherapi.d.ts","sourceRoot":"","sources":["../src/weatherapi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,CAAA;AAE5B,8BAA8B;AAC9B,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,eAAe,KAAK,IAAI,CAAA;IAC/D,UAAU,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;IAEtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;MA4BE;IACF,eAAe,EAAE,CACf,QAAQ,EAAE,QAAQ,EAClB,OAAO,CAAC,EAAE,gBAAgB,KACvB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAkCE;IACF,YAAY,EAAE,CACZ,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,gBAAgB,KACvB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;MAwBE;IACF,WAAW,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC,cAAc,EAAE,CAAC,CAAA;CAC/D;AAED,6BAA6B;AAC7B,MAAM,WAAW,uBAAuB;IACtC;;;;;OAKG;IACH,uBAAuB,EAAE,CAAC,QAAQ,EAAE,eAAe,KAAK,IAAI,CAAA;IAC5D;;;;OAIG;IACH,UAAU,EAAE,UAAU,CAAA;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,CAAC,EAAE,EAAE,MAAM,GAAG;QACZ,IAAI,EAAE,MAAM,CAAA;QACZ,SAAS,EAAE,OAAO,CAAA;KACnB,CAAA;CACF;AAED,4BAA4B;AAE5B,eAAO,MAAM,iBAAiB,GAAI,KAAK,GAAG,YAezC,CAAA;AAED,6BAA6B;AAC7B,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,sBAAsB,CAAA;CAChC;AAED,6BAA6B;AAC7B,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;MA4BE;IACF,eAAe,EAAE,CACf,QAAQ,EAAE,QAAQ,EAClB,OAAO,CAAC,EAAE,gBAAgB,KACvB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MAkCE;IACF,YAAY,EAAE,CACZ,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,gBAAgB,KACvB,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;MAwBE;IACF,WAAW,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,OAAO,CAAC,cAAc,EAAE,CAAC,CAAA;CAC/D;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,CAAA;KAAE,CAAA;CACtE;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,GAAG,OAAO,CAAA;AACnD;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,mBAAmB,GAAG,aAAa,CAAA;AAGjE;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,eAAe,CAAA;IACrB,OAAO,CAAC,EAAE;QACR,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB,oBAAoB,CAAC,EAAE,MAAM,CAAA;QAC7B,mBAAmB,CAAC,EAAE,MAAM,CAAA;QAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAA;QACzB,oBAAoB,CAAC,EAAE,MAAM,CAAA;QAC7B,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,mBAAmB,CAAC,EAAE,MAAM,CAAA;QAC5B,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,gBAAgB,CAAC,EAAE,YAAY,CAAA;QAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAA;QACzB,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;KACtC,CAAA;IACD,KAAK,CAAC,EAAE;QACN,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,aAAa,CAAC,EAAE,YAAY,CAAA;QAC5B,mBAAmB,CAAC,EAAE,MAAM,CAAA;QAC5B,uBAAuB,CAAC,EAAE,MAAM,CAAA;QAChC,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,qBAAqB,CAAC,EAAE,MAAM,CAAA;QAC9B,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,aAAa,CAAC,EAAE,MAAM,CAAA;QACtB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,cAAc,CAAC,EAAE,MAAM,CAAA;KACxB,CAAA;IACD,IAAI,CAAC,EAAE;QACL,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB,aAAa,CAAC,EAAE,MAAM,CAAA;QACtB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,aAAa,CAAC,EAAE,MAAM,CAAA;KACvB,CAAA;IACD,GAAG,CAAC,EAAE;QACJ,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,CAAA;CACF;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GACpB,QAAQ,GACR,YAAY,GACZ,YAAY,GACZ,eAAe,CAAA;AAEnB;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,UAAU,GACV,MAAM,GACN,cAAc,GACd,eAAe,GACf,WAAW,GACX,MAAM,GACN,UAAU,GACV,eAAe,CAAA"}
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.isWeatherProvider = void 0;
4
+ /**@category Weather API */
4
5
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
5
6
  const isWeatherProvider = (obj) => {
6
7
  const typedObj = obj;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@signalk/server-api",
3
- "version": "2.8.0",
3
+ "version": "2.10.0",
4
4
  "description": "signalk-server Typescript API for plugins etc with relevant implementation classes",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -21,7 +21,8 @@
21
21
  "author": "teppo.kurki@iki.fi",
22
22
  "license": "Apache-2.0",
23
23
  "devDependencies": {
24
- "ts-auto-guard": "^5.0.1"
24
+ "ts-auto-guard": "^5.0.1",
25
+ "@js-temporal/polyfill": "^0.5.1"
25
26
  },
26
27
  "peerDependencies": {
27
28
  "baconjs": "^1.0.1"