@signalk/server-api 2.8.0 → 2.10.0

package/dist/autopilotapi.d.ts

@@ -1,17 +1,60 @@
 import { Value } from './deltas';
-export type AutopilotUpdateAttrib = 'mode' | 'state' | 'target' | 'engaged' | 'options' | 'alarm';
-export declare const isAutopilotUpdateAttrib: (s: string) => boolean;
+/**
+ * Valid autopilot delta path names.
+ * @category  Autopilot API
+ */
+export type AutopilotUpdateAttrib = 'mode' | 'state' | 'target' | 'engaged' | 'options' | 'actions' | 'alarm';
+/**
+ * This method returns true if the supplied value represents a valid autopilot delta path.
+ * @category  Autopilot API
+ */
+export declare const isAutopilotUpdateAttrib: (value: string) => boolean;
+/**
+ * Valid autopilot alarm delta path names.
+ * @category  Autopilot API
+ */
 export type AutopilotAlarm = 'waypointAdvance' | 'waypointArrival' | 'routeComplete' | 'xte' | 'heading' | 'wind';
-export declare const isAutopilotAlarm: (s: string) => boolean;
+/**
+ * This method returns true if the supplied value represents a valid autopilot alarm delta path.
+ * @category  Autopilot API
+ */
+export declare const isAutopilotAlarm: (value: string) => boolean;
+/**
+ * Valid tack / gybe action direction values.
+ * @category  Autopilot API
+ */
 export type TackGybeDirection = 'port' | 'starboard';
+/**
+ * This method returns true if the supplied object is a valid AutopilotProvider.
+ * @category  Autopilot API
+ */
+export declare const isAutopilotProvider: (obj: unknown) => boolean;
+/** @category  Autopilot API  */
 export interface AutopilotApi {
     register(pluginId: string, provider: AutopilotProvider): void;
     unRegister(pluginId: string): void;
+    /**
+     * This method instructs the server to send deltas for the provided paths.
+     *
+     * > [!NOTE]
+     * > Valid `apInfo` paths are defined in {@link AutopilotUpdateAttrib}
+     * > `apInfo.actions` value (like `options.actions`) must contain an Array<{@link AutopilotActionDef}>
+     
+    @example
+     * ```javascript
+     * apUpdate({
+     *  'mode': 'gps',
+     *  'actions': [{id: 'tack', name: 'Tack', available: true}]
+     * });
+     * ```
+    
+    
+    */
     apUpdate(pluginId: string, deviceId: string, apInfo: {
         [path: string]: Value;
     }): void;
 }
-/** @see {isAutopilotProvider} ts-auto-guard:type-guard */
+/** @category  Autopilot API  */
 export interface AutopilotProvider {
     /**
      * This method returns an AutopilotInfo object containing the current data values and valid options for the supplied autopilot device identifier.
@@ -19,6 +62,9 @@ export interface AutopilotProvider {
      * > [!NOTE]
      * > It is the responsibility of the autopilot provider plugin to map the value of `engaged` to the current `state`.
      *
+     * Additionally, the plugin can maintain a list of `availableActions` that can be taken in the current
+     * operational state.
+     *
      * @example
      * API request:
      * ```
@@ -31,7 +77,7 @@ export interface AutopilotProvider {
      *
      * // Returns:
      * {
-     *   options: {
+     *    options: {
      *     states: [
      *         {
      *             name: 'auto' // autopilot state name
@@ -42,7 +88,19 @@ export interface AutopilotProvider {
      *             engaged: false // not actively steering
      *         }
      *     ]
-     *     modes: ['compass', 'gps', 'wind']
+     *     modes: ['compass', 'gps', 'wind'],  // supported modes of operation
+     *     actions: [
+     *     {
+     *        id: 'tack',
+     *        name: 'Tack',
+     *        available: true
+     *     },
+     *     {
+     *        id: 'gybe',
+     *        name: 'Gybe',
+     *        available: false
+     *     }
+     *      ]  // actions the autopilot supports
      * },
      *   target: 0.326
      *   mode: 'compass'
@@ -70,7 +128,7 @@ export interface AutopilotProvider {
      *
      * @param deviceId - identifier of the autopilot device to query.
      */
-    getState(deviceId: string): Promise<string>;
+    getState(deviceId: string): Promise<string | null>;
     /**
      * Sets the autopilot device with the supplied identifier to the supplied state value.
      *
@@ -90,7 +148,7 @@ export interface AutopilotProvider {
      * @throws if supplied state value is invalid.
      */
     setState(state: string, deviceId: string): Promise<void>;
-    getMode(deviceId: string): Promise<string>;
+    getMode(deviceId: string): Promise<string | null>;
     /**
      * Sets the autopilot device with the supplied identifier to the supplied mode value.
      *
@@ -109,7 +167,7 @@ export interface AutopilotProvider {
      * @throws if supplied mode value is invalid.
      */
     setMode(mode: string, deviceId: string): Promise<void>;
-    getTarget(deviceId: string): Promise<number>;
+    getTarget(deviceId: string): Promise<number | null>;
     /**
      * Sets target for the autopilot device with the supplied identifier to the supplied value.
      *
@@ -181,6 +239,45 @@ export interface AutopilotProvider {
      * @throws on error.
      */
     disengage(deviceId: string): Promise<void>;
+    /**
+     * Instructs the autopilot device to steer for the currently set destination position.
+     *
+     * It is assumed that a destination has been set prior to invoking this action.
+     *
+     * The intended result of this action is that the autopilot device be engaged in the
+     * appropriate mode to steer to the active waypoint / position.
+     *
+     * @example
+     * API request
+     * ```
+     * POST /signalk/v2/api/vessels/self/autopilots/mypilot1/courseCurrentPoint
+     * ```
+     * AutopilotProvider method invocation
+     * ```javascript
+     * courseCurrentPoint('mypilot1');
+     * ```
+     *
+     * @param deviceId - identifier of the autopilot device to query.
+     * @throws on error.
+     */
+    courseCurrentPoint(deviceId: string): Promise<void>;
+    /**
+     * Instructs the autopilot device to advance to the next waypoint on the route.
+     *
+     * @example
+     * API request
+     * ```
+     * POST /signalk/v2/api/vessels/self/autopilots/mypilot1/courseNextPoint
+     * ```
+     * AutopilotProvider method invocation
+     * ```javascript
+     * courseNextPoint('mypilot1');
+     * ```
+     *
+     * @param deviceId - identifier of the autopilot device to query.
+     * @throws on error.
+     */
+    courseNextPoint(deviceId: string): Promise<void>;
     /**
      * Instructs the autopilot device with the supplied identifier to perform a tack in the supplied direction.
      *
@@ -256,14 +353,24 @@ export interface AutopilotProvider {
      */
     dodge(value: number | null, deviceId: string): Promise<void>;
 }
+/** @category  Autopilot API  */
 export interface AutopilotStateDef {
     name: string;
     engaged: boolean;
 }
+/** @category  Autopilot API  */
+export interface AutopilotActionDef {
+    id: 'dodge' | 'tack' | 'gybe' | 'courseCurrentPoint' | 'courseNextPoint';
+    name: string;
+    available: boolean;
+}
+/** @category  Autopilot API  */
 export interface AutopilotOptions {
     states: AutopilotStateDef[];
     modes: string[];
+    actions: AutopilotActionDef[];
 }
+/** @category  Autopilot API  */
 export interface AutopilotInfo {
     options: AutopilotOptions;
     target: number | null;

package/dist/autopilotapi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"autopilotapi.d.ts","sourceRoot":"","sources":["../src/autopilotapi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAA;AAEhC,MAAM,MAAM,qBAAqB,GAC7B,MAAM,GACN,OAAO,GACP,QAAQ,GACR,SAAS,GACT,SAAS,GACT,OAAO,CAAA;AAWX,eAAO,MAAM,uBAAuB,GAAI,GAAG,MAAM,YACY,CAAA;AAE7D,MAAM,MAAM,cAAc,GACtB,iBAAiB,GACjB,iBAAiB,GACjB,eAAe,GACf,KAAK,GACL,SAAS,GACT,MAAM,CAAA;AAWV,eAAO,MAAM,gBAAgB,GAAI,GAAG,MAAM,YACK,CAAA;AAE/C,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,WAAW,CAAA;AAEpD,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAC7D,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,QAAQ,CACN,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAA;KAAE,GAChC,IAAI,CAAA;CACR;AAED,0DAA0D;AAC1D,MAAM,WAAW,iBAAiB;IAChC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAA;IAEjD;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAE3C;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAExD,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAC1C;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACtD,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAE5C;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEzD;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE5D;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEvC;;;;;;;;;;;;;;;OAeG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE1C;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CAAC,SAAS,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEnE;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CAAC,SAAS,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC7D;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,iBAAiB,EAAE,CAAA;IAC3B,KAAK,EAAE,MAAM,EAAE,CAAA;CAChB;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,gBAAgB,CAAA;IACzB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,OAAO,EAAE,OAAO,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,yBAAyB,CACvB,QAAQ,EAAE,iBAAiB,EAC3B,OAAO,EAAE,MAAM,EAAE,GAChB,IAAI,CAAA;IAEP;;;;OAIG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAA;KAAE,GAAG,IAAI,CAAA;CAC3E"}
+{"version":3,"file":"autopilotapi.d.ts","sourceRoot":"","sources":["../src/autopilotapi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAA;AAEhC;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAC7B,MAAM,GACN,OAAO,GACP,QAAQ,GACR,SAAS,GACT,SAAS,GACT,SAAS,GACT,OAAO,CAAA;AAeX;;;GAGG;AACH,eAAO,MAAM,uBAAuB,GAAI,OAAO,MAAM,YACY,CAAA;AAEjE;;;GAGG;AACH,MAAM,MAAM,cAAc,GACtB,iBAAiB,GACjB,iBAAiB,GACjB,eAAe,GACf,KAAK,GACL,SAAS,GACT,MAAM,CAAA;AAcV;;;GAGG;AACH,eAAO,MAAM,gBAAgB,GAAI,OAAO,MAAM,YACK,CAAA;AAEnD;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,WAAW,CAAA;AAEpD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,GAAI,KAAK,OAAO,YAmB/C,CAAA;AAED,gCAAgC;AAChC,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAC7D,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC;;;;;;;;;;;;;;;;MAgBE;IACF,QAAQ,CACN,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAA;KAAE,GAChC,IAAI,CAAA;CACR;AAED,gCAAgC;AAChC,MAAM,WAAW,iBAAiB;IAChC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsDG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAA;IAEjD;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA;IAElD;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAExD,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA;IACjD;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACtD,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA;IAEnD;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEzD;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE5D;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEvC;;;;;;;;;;;;;;;OAeG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE1C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEnD;;;;;;;;;;;;;;;OAeG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhD;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CAAC,SAAS,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEnE;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CAAC,SAAS,EAAE,iBAAiB,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC7D;AAED,gCAAgC;AAChC,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,gCAAgC;AAChC,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,oBAAoB,GAAG,iBAAiB,CAAA;IACxE,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,OAAO,CAAA;CACnB;AAED,gCAAgC;AAChC,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,iBAAiB,EAAE,CAAA;IAC3B,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,OAAO,EAAE,kBAAkB,EAAE,CAAA;CAC9B;AAED,gCAAgC;AAChC,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,gBAAgB,CAAA;IACzB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,OAAO,EAAE,OAAO,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,yBAAyB,CACvB,QAAQ,EAAE,iBAAiB,EAC3B,OAAO,EAAE,MAAM,EAAE,GAChB,IAAI,CAAA;IAEP;;;;OAIG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAA;KAAE,GAAG,IAAI,CAAA;CAC3E"}

package/dist/autopilotapi.js

@@ -1,16 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isAutopilotAlarm = exports.isAutopilotUpdateAttrib = void 0;
+exports.isAutopilotProvider = exports.isAutopilotAlarm = exports.isAutopilotUpdateAttrib = void 0;
+/**@hidden
+ * @category  Autopilot API
+ */
 const AUTOPILOTUPDATEATTRIBS = [
     'mode',
     'state',
     'target',
     'engaged',
     'options',
+    'actions',
     'alarm'
 ];
-const isAutopilotUpdateAttrib = (s) => AUTOPILOTUPDATEATTRIBS.includes(s);
+/**
+ * This method returns true if the supplied value represents a valid autopilot delta path.
+ * @category  Autopilot API
+ */
+const isAutopilotUpdateAttrib = (value) => AUTOPILOTUPDATEATTRIBS.includes(value);
 exports.isAutopilotUpdateAttrib = isAutopilotUpdateAttrib;
+/** @hidden
+ * @category  Autopilot API
+ */
 const AUTOPILOTALARMS = [
     'waypointAdvance',
     'waypointArrival',
@@ -19,5 +30,32 @@ const AUTOPILOTALARMS = [
     'heading',
     'wind'
 ];
-const isAutopilotAlarm = (s) => AUTOPILOTALARMS.includes(s);
+/**
+ * This method returns true if the supplied value represents a valid autopilot alarm delta path.
+ * @category  Autopilot API
+ */
+const isAutopilotAlarm = (value) => AUTOPILOTALARMS.includes(value);
 exports.isAutopilotAlarm = isAutopilotAlarm;
+/**
+ * This method returns true if the supplied object is a valid AutopilotProvider.
+ * @category  Autopilot API
+ */
+const isAutopilotProvider = (obj) => {
+    const typedObj = obj;
+    return (((typedObj !== null && typeof typedObj === 'object') ||
+        typeof typedObj === 'function') &&
+        typeof typedObj['getData'] === 'function' &&
+        typeof typedObj['getState'] === 'function' &&
+        typeof typedObj['setState'] === 'function' &&
+        typeof typedObj['getMode'] === 'function' &&
+        typeof typedObj['setMode'] === 'function' &&
+        typeof typedObj['getTarget'] === 'function' &&
+        typeof typedObj['setTarget'] === 'function' &&
+        typeof typedObj['adjustTarget'] === 'function' &&
+        typeof typedObj['engage'] === 'function' &&
+        typeof typedObj['disengage'] === 'function' &&
+        typeof typedObj['tack'] === 'function' &&
+        typeof typedObj['gybe'] === 'function' &&
+        typeof typedObj['dodge'] === 'function');
+};
+exports.isAutopilotProvider = isAutopilotProvider;

package/dist/brand.d.ts

@@ -2,7 +2,7 @@ declare const __brand: unique symbol;
 /**
  * An interface for creating branded types, which create a more specific and unique data type
  * with greater clarity and specificity,
- *
+ * @hidden
  * @example
  * ```ts
  * type Path = Branded<string, "path">

package/dist/course.d.ts

@@ -1,6 +1,7 @@
 import { PointDestination, RouteDestination, CourseInfo } from './coursetypes';
 /**
  * @see [Course REST API](../../../docs/develop/rest-api/course_api.md) provides the following functions for use by plugins.
+ * @category  Course API
  */
 export interface CourseApi {
     /**

package/dist/course.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"course.d.ts","sourceRoot":"","sources":["../src/course.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAE9E;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;;;OAIG;IACH,SAAS,IAAI,OAAO,CAAC,UAAU,CAAC,CAAA;IAEhC;;;;OAIG;IACH,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAEjC;;;;;;;OAOG;IACH,cAAc,CACZ,IAAI,EAAE,CAAC,gBAAgB,GAAG;QAAE,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,GAAG,IAAI,GAC3D,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;OAQG;IACH,aAAa,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC5D"}
+{"version":3,"file":"course.d.ts","sourceRoot":"","sources":["../src/course.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAE9E;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB;;;;OAIG;IACH,SAAS,IAAI,OAAO,CAAC,UAAU,CAAC,CAAA;IAEhC;;;;OAIG;IACH,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IAEjC;;;;;;;OAOG;IACH,cAAc,CACZ,IAAI,EAAE,CAAC,gBAAgB,GAAG;QAAE,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,GAAG,IAAI,GAC3D,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhB;;;;;;;;OAQG;IACH,aAAa,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC5D"}

package/dist/coursetypes.d.ts

@@ -1,18 +1,23 @@
 import { Position } from '.';
 import { Brand } from './brand';
+/** @category Course API */
 export interface HrefDestination {
     href: string;
 }
+/** @category Course API */
 export interface PositionDestination {
     position: Position;
 }
+/** @category Course API */
 export type PointDestination = HrefDestination | PositionDestination;
+/** @category Course API */
 export interface RouteDestination {
     href: string;
     reverse?: boolean;
     pointIndex?: number;
     arrivalCircle?: number;
 }
+/** @category Course API */
 export interface ActiveRoute {
     href: string;
     pointIndex: number;
@@ -20,17 +25,21 @@ export interface ActiveRoute {
     reverse: boolean;
     name: string;
 }
+/** @category Course API */
 export interface NextPreviousPoint {
     href?: string;
     type: CoursePointType;
     position: Position;
 }
+/** @category Course API */
 export type CoursePointType = Brand<string, 'coursepointtype'>;
+/** @category  Course API */
 export declare const COURSE_POINT_TYPES: {
     VesselPosition: CoursePointType;
     RoutePoint: CoursePointType;
     Location: CoursePointType;
 };
+/** @category Course API */
 export interface CourseInfo {
     startTime: string | null;
     targetArrivalTime: string | null;

package/dist/coursetypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"coursetypes.d.ts","sourceRoot":"","sources":["../src/coursetypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,CAAA;AAC5B,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAE/B,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,MAAM,MAAM,gBAAgB,GAAG,eAAe,GAAG,mBAAmB,CAAA;AAEpE,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,eAAe,CAAA;IACrB,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;AAE9D,eAAO,MAAM,kBAAkB;oBACO,eAAe;gBACvB,eAAe;cACnB,eAAe;CACxC,CAAA;AAED,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC,aAAa,EAAE,MAAM,CAAA;IACrB,WAAW,EAAE,WAAW,GAAG,IAAI,CAAA;IAC/B,SAAS,EAAE,iBAAiB,GAAG,IAAI,CAAA;IACnC,aAAa,EAAE,iBAAiB,GAAG,IAAI,CAAA;CACxC"}
+{"version":3,"file":"coursetypes.d.ts","sourceRoot":"","sources":["../src/coursetypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,CAAA;AAC5B,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAE/B,2BAA2B;AAC3B,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAA;CACb;AAED,2BAA2B;AAC3B,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,2BAA2B;AAC3B,MAAM,MAAM,gBAAgB,GAAG,eAAe,GAAG,mBAAmB,CAAA;AAEpE,2BAA2B;AAC3B,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,2BAA2B;AAC3B,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;CACb;AAED,2BAA2B;AAC3B,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,eAAe,CAAA;IACrB,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,2BAA2B;AAC3B,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;AAE9D,4BAA4B;AAC5B,eAAO,MAAM,kBAAkB;oBACO,eAAe;gBACvB,eAAe;cACnB,eAAe;CACxC,CAAA;AAED,2BAA2B;AAC3B,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC,aAAa,EAAE,MAAM,CAAA;IACrB,WAAW,EAAE,WAAW,GAAG,IAAI,CAAA;IAC/B,SAAS,EAAE,iBAAiB,GAAG,IAAI,CAAA;IACnC,aAAa,EAAE,iBAAiB,GAAG,IAAI,CAAA;CACxC"}

package/dist/coursetypes.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.COURSE_POINT_TYPES = void 0;
+/** @category  Course API */
 exports.COURSE_POINT_TYPES = {
     VesselPosition: 'VesselPosition',
     RoutePoint: 'RoutePoint',

package/dist/deltas.d.ts

@@ -1,4 +1,5 @@
 import { Brand } from './brand';
+/** @hidden */
 export interface WithContext {
     context: Context;
 }
@@ -10,21 +11,31 @@ type NormalizedBaseDelta = {
     path: Path;
     timestamp: Timestamp;
 };
+/** @hidden */
 export type NormalizedMetaDelta = NormalizedBaseDelta & {
     value: MetaValue;
     isMeta: true;
 };
+/** @hidden */
 export type NormalizedValueDelta = NormalizedBaseDelta & {
     value: Value;
     isMeta: false;
 };
+/** @hidden */
 export type NormalizedDelta = NormalizedValueDelta | NormalizedMetaDelta;
+/** @category Server API */
 export type SourceRef = Brand<string, 'sourceRef'>;
+/** @category Server API */
 export type Source = any;
+/** @category Server API */
 export type Path = Brand<string, 'path'>;
+/** @category Server API */
 export type Timestamp = Brand<string, 'timestamp'>;
+/** @category Server API */
 export type Context = Brand<string, 'context'>;
+/** @category Server API */
 export type Value = object | number | string | null | Notification | boolean;
+/** @category Server API */
 export interface Delta {
     context?: Context;
     updates: Update[];
@@ -39,6 +50,7 @@ export type ValuesDelta = Delta;
  * @hidden
  */
 export type MetaDelta = Delta;
+/** @category Server API */
 export type Update = {
     timestamp?: Timestamp;
     source?: Source;
@@ -48,25 +60,31 @@ export type Update = {
 } | {
     meta: Meta[];
 });
+/** @category Server API */
 export declare function hasValues(u: Update): u is Update & {
     values: PathValue[];
 };
+/** @category Server API */
 export declare function hasMeta(u: Update): u is Update & {
     meta: Meta[];
 };
+/** @category Server API */
 export interface PathValue {
     path: Path;
     value: Value;
 }
+/** @category Server API */
 export interface Notification {
     state: ALARM_STATE;
     method: ALARM_METHOD[];
     message: string;
 }
+/** @category Server API */
 export interface Meta {
     path: Path;
     value: MetaValue;
 }
+/** @category Server API */
 export interface MetaValue {
     description?: string;
     units?: string;
@@ -80,6 +98,7 @@ export interface MetaValue {
     zones?: Zone[];
     supportsPut?: boolean;
 }
+/** @category Server API */
 export declare enum ALARM_STATE {
     nominal = "nominal",
     normal = "normal",
@@ -88,10 +107,12 @@ export declare enum ALARM_STATE {
     alarm = "alarm",
     emergency = "emergency"
 }
+/** @category Server API */
 export declare enum ALARM_METHOD {
     visual = "visual",
     sound = "sound"
 }
+/** @category Server API */
 export interface Zone {
     lower: number | undefined;
     upper: number | undefined;

package/dist/deltas.d.ts.map

@@ -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,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;IACd,IAAI,EAAE,IAAI,CAAA;IACV,SAAS,EAAE,SAAS,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,mBAAmB,GAAG;IACtD,KAAK,EAAE,SAAS,CAAA;IAChB,MAAM,EAAE,IAAI,CAAA;CACb,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,mBAAmB,GAAG;IACvD,KAAK,EAAE,KAAK,CAAA;IACZ,MAAM,EAAE,KAAK,CAAA;CACd,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,oBAAoB,GAAG,mBAAmB,CAAA;AAExE,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;AAElD,MAAM,MAAM,MAAM,GAAG,GAAG,CAAA;AAExB,MAAM,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AACxC,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;AAClD,MAAM,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;AAE9C,MAAM,MAAM,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,YAAY,GAAG,OAAO,CAAA;AAE5E,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,MAAM,MAAM,MAAM,GAAG;IACnB,SAAS,CAAC,EAAE,SAAS,CAAA;IACrB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,SAAS,CAAA;CACpB,GAAG,CAAC;IAAE,MAAM,EAAE,SAAS,EAAE,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,IAAI,EAAE,CAAA;CAAE,CAAC,CAAA;AAEhD,wBAAgB,SAAS,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,IAAI,MAAM,GAAG;IAAE,MAAM,EAAE,SAAS,EAAE,CAAA;CAAE,CAE1E;AAED,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,IAAI,MAAM,GAAG;IAAE,IAAI,EAAE,IAAI,EAAE,CAAA;CAAE,CAEjE;AAGD,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,IAAI,CAAA;IACV,KAAK,EAAE,KAAK,CAAA;CACb;AAGD,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,WAAW,CAAA;IAClB,MAAM,EAAE,YAAY,EAAE,CAAA;IACtB,OAAO,EAAE,MAAM,CAAA;CAChB;AAGD,MAAM,WAAW,IAAI;IACnB,IAAI,EAAE,IAAI,CAAA;IACV,KAAK,EAAE,SAAS,CAAA;CACjB;AAGD,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,oBAAY,WAAW;IACrB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,KAAK,UAAU;IACf,SAAS,cAAc;CACxB;AAED,oBAAY,YAAY;IACtB,MAAM,WAAW;IACjB,KAAK,UAAU;CAChB;AAED,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"}
+{"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;IACd,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;AAE9C,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,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,SAAS,CAAA;CACpB,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;CAChB;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,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/deltas.js

@@ -3,13 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ALARM_METHOD = exports.ALARM_STATE = void 0;
 exports.hasValues = hasValues;
 exports.hasMeta = hasMeta;
+/** @category Server API */
 function hasValues(u) {
     return 'values' in u && Array.isArray(u.values);
 }
+/** @category Server API */
 function hasMeta(u) {
     return 'meta' in u && Array.isArray(u.meta);
 }
 // Notification attribute types
+/** @category Server API */
 var ALARM_STATE;
 (function (ALARM_STATE) {
     ALARM_STATE["nominal"] = "nominal";
@@ -19,6 +22,7 @@ var ALARM_STATE;
     ALARM_STATE["alarm"] = "alarm";
     ALARM_STATE["emergency"] = "emergency";
 })(ALARM_STATE || (exports.ALARM_STATE = ALARM_STATE = {}));
+/** @category Server API */
 var ALARM_METHOD;
 (function (ALARM_METHOD) {
     ALARM_METHOD["visual"] = "visual";

package/dist/features.d.ts

@@ -51,6 +51,7 @@ export interface WithFeatures {
 }
 /**
  * Information about the available APIs and Plugins.
+ * @category Server API
  */
 export interface FeatureInfo {
     apis: SignalKApiId[];
@@ -61,5 +62,6 @@ export interface FeatureInfo {
         enabled: boolean;
     }>;
 }
+/** @category Server API  */
 export type SignalKApiId = 'weather' | 'course' | 'resources' | 'history' | 'autopilot' | 'anchor' | 'logbook' | 'historyplayback' | 'historysnapshot';
 //# sourceMappingURL=features.d.ts.map

package/dist/features.d.ts.map

@@ -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;;GAEG;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,MAAM,MAAM,YAAY,GACpB,SAAS,GACT,QAAQ,GACR,WAAW,GACX,SAAS,GACT,WAAW,GACX,QAAQ,GACR,SAAS,GACT,iBAAiB,GACjB,iBAAiB,CAAA"}
+{"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"}

package/dist/history.d.ts

@@ -1,4 +1,5 @@
 import { Context, Path, Timestamp } from '.';
+import { Temporal } from '@js-temporal/polyfill';
 export type AggregateMethod = 'average' | 'min' | 'max' | 'first' | 'last' | 'mid' | 'middle_index';
 export type ValueList = {
     path: Path;
@@ -43,4 +44,86 @@ export type PathsRequestQueryParams = TimeRangeQueryParams;
 export type PathsResponse = Path[];
 export type ContextsRequestQueryParams = TimeRangeQueryParams;
 export type ContextsResponse = Context[];
+export type HistoryApiRegistry = {
+    registerHistoryApiProvider(provider: HistoryApi): void;
+    unregisterHistoryApiProvider(): void;
+};
+/** @category  History API */
+export type WithHistoryApi = {
+    /**
+     * Returns a promise for the active History API implementation, or rejects if unavailable.
+     * The property is optional to support explicitly older servers that do not have a history api provider.
+     *
+     * @returns Promise that resolves to a {@link HistoryApi} instance if available, or rejects with an error if not.
+     */
+    getHistoryApi?: () => Promise<HistoryApi>;
+};
+/** @category  History API */
+export interface HistoryApi {
+    /**
+     * Retrieves historical values for the specified query parameters.
+     *
+     * @param query - The {@link ValuesRequest} containing context, time range, resolution, and path specifications.
+     * @returns A promise that resolves to a {@link ValuesResponse} containing the requested historical data.
+     */
+    getValues(query: ValuesRequest): Promise<ValuesResponse>;
+    /**
+     * Lists available contexts for which historical data can be queried.
+     *
+     * @param query - The {@link ContextsRequest} specifying time range and filters.
+     * @returns A promise that resolves to a {@link ContextsResponse} array of available contexts.
+     */
+    getContexts(query: ContextsRequest): Promise<ContextsResponse>;
+    /**
+     * Lists available paths for historical data queries.
+     *
+     * @param query - The {@link PathsRequest} specifying time range and filters.
+     * @returns A promise that resolves to a {@link PathsResponse} array of available paths.
+     */
+    getPaths(query: PathsRequest): Promise<PathsResponse>;
+}
+export declare function isHistoryApi(obj: unknown): obj is HistoryApi;
+/**
+ * Represents a time duration, either as a {@link Temporal.Duration} object or a number (milliseconds).
+ *
+ * @example
+ * // Using Temporal.Duration
+ * const duration: Duration = Temporal.Duration.from({ minutes: 5 });
+ *
+ * // Using milliseconds
+ * const duration: Duration = 300000; // 5 minutes in milliseconds
+ */
+export type Duration = Temporal.Duration | number;
+export type TimeRangeParams = {
+    duration: Temporal.Duration;
+    from?: never;
+    to?: never;
+} | {
+    duration: Duration;
+    from: Temporal.Instant;
+    to?: never;
+} | {
+    duration: Duration;
+    from?: never;
+    to: Temporal.Instant;
+} | {
+    duration?: never;
+    from: Temporal.Instant;
+    to?: never;
+} | {
+    duration: never;
+    from: Temporal.Instant;
+    to: Temporal.Instant;
+};
+export interface PathSpec {
+    path: Path;
+    aggregate: AggregateMethod;
+}
+export type ValuesRequest = TimeRangeParams & {
+    context?: Context;
+    resolution?: number;
+    pathSpecs: PathSpec[];
+};
+export type PathsRequest = TimeRangeParams;
+export type ContextsRequest = TimeRangeParams;
 //# sourceMappingURL=history.d.ts.map

package/dist/history.d.ts.map

@@ -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;AAE5C,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;AAGH,MAAM,MAAM,OAAO,GAAG,CAAC,SAAS,EAAE,GAAG,GAAG,EAAE,CAAC,CAAA;AAE3C,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;AAqBD,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,EAAE,KAAK,CAAA;IACf,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"}
+{"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;AAGH,MAAM,MAAM,OAAO,GAAG,CAAC,SAAS,EAAE,GAAG,GAAG,EAAE,CAAC,CAAA;AAE3C,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;AAsBD,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,EAAE,KAAK,CAAA;IACf,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,EAAE,KAAK,CAAA;IACf,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

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isHistoryApi = isHistoryApi;
+/** @ignore */
 const _example = {
     context: 'vessels.urn:mrn:signalk:uuid:2ffee4a6-52f6-4d4e-8179-0fc9aaf22c87',
     range: {
@@ -17,3 +19,11 @@ const _example = {
         ['2025-08-11T05:26:10.000Z', 3.14]
     ]
 };
+function isHistoryApi(obj) {
+    if (typeof obj !== 'object' || obj === null) {
+        return false;
+    }
+    return (typeof obj.getValues === 'function' &&
+        typeof obj.getContexts === 'function' &&
+        typeof obj.getPaths === 'function');
+}