@signalk/server-api 2.6.1 → 2.7.0

package/dist/autopilotapi.d.ts

@@ -13,18 +13,247 @@ export interface AutopilotApi {
 }
 /** @see {isAutopilotProvider} ts-auto-guard:type-guard */
 export interface AutopilotProvider {
+    /**
+     * This method returns an AutopilotInfo object containing the current data values and valid options for the supplied autopilot device identifier.
+     *
+     * > [!NOTE]
+     * > It is the responsibility of the autopilot provider plugin to map the value of `engaged` to the current `state`.
+     *
+     * @example
+     * API request:
+     * ```
+     * GET /signalk/v2/api/vessels/self/autopilots/mypilot1
+     * ```
+     *
+     * AutopilotProvider method invocation:
+     * ```javascript
+     * getData('mypilot1');
+     *
+     * // Returns:
+     * {
+     *   options: {
+     *     states: [
+     *         {
+     *             name: 'auto' // autopilot state name
+     *             engaged: true // actively steering
+     *         },
+     *         {
+     *             name: 'standby' // autopilot state name
+     *             engaged: false // not actively steering
+     *         }
+     *     ]
+     *     modes: ['compass', 'gps', 'wind']
+     * },
+     *   target: 0.326
+     *   mode: 'compass'
+     *   state: 'auto'
+     *   engaged: true
+     * }
+     * ```
+     *
+     * @param deviceId - identifier of the autopilot device to query.
+     */
     getData(deviceId: string): Promise<AutopilotInfo>;
+    /**
+     * Returns the current state of the supplied autopilot device identifier. If the autopilot device is not connected or unreachable then `off-line` should be returned.
+     *
+     * @example
+     * API request
+     * ```
+     * GET /signalk/v2/api/vessels/self/autopilots/mypilot1/state
+     * ```
+     *
+     * AutopilotProvider method invocation
+     * ```javascript
+     * await getState('mypilot1'); // Returns: 'auto'
+     * ```
+     *
+     * @param deviceId - identifier of the autopilot device to query.
+     */
     getState(deviceId: string): Promise<string>;
+    /**
+     * Sets the autopilot device with the supplied identifier to the supplied state value.
+     *
+     * @example
+     * API request
+     * ```
+     * PUT /signalk/v2/api/vessels/self/autopilots/mypilot1/state {value: "standby"}
+     * ```
+     *
+     * AutopilotProvider method invocation
+     * ```javascript
+     * setState('standby', 'mypilot1');
+     * ```
+     *
+     * @param state - state value to set. Must be a valid state value.
+     * @param deviceId - identifier of the autopilot device to query.
+     * @throws if supplied state value is invalid.
+     */
     setState(state: string, deviceId: string): Promise<void>;
     getMode(deviceId: string): Promise<string>;
+    /**
+     * Sets the autopilot device with the supplied identifier to the supplied mode value.
+     *
+     * @example
+     * API request
+     * ```
+     * PUT /signalk/v2/api/vessels/self/autopilots/mypilot1/mode {value: "gps"}
+     * ```
+     * AutopilotProvider method invocation
+     * ```javascript   *
+     * setMode('gps', 'mypilot1');
+     * ```
+     *
+     * @param mode - Must be a valid mode value.
+     * @param deviceId - identifier of the autopilot device to query.
+     * @throws if supplied mode value is invalid.
+     */
     setMode(mode: string, deviceId: string): Promise<void>;
     getTarget(deviceId: string): Promise<number>;
+    /**
+     * Sets target for the autopilot device with the supplied identifier to the supplied value.
+     *
+     * @example
+     * API request
+     * ```
+     * PUT /signalk/v2/api/vessels/self/autopilots/mypilot1/target {value: 129}
+     * ```
+     *
+     * // AutopilotProvider method invocation
+     * ```javascript
+     * setTarget(129, 'mypilot1');
+     * ```
+     *
+     * @param value - target value in radians.
+     * @param deviceId - identifier of the autopilot device to query.
+     * @throws if supplied target value is outside the valid range.
+     */
     setTarget(value: number, deviceId: string): Promise<void>;
+    /**
+     * Adjusts target for the autopilot device with the supplied identifier by the supplied value.
+     *
+     * @example
+     * API request
+     * ```
+     * PUT /signalk/v2/api/vessels/self/autopilots/mypilot1/target {value: 2}
+     * ```
+     * AutopilotProvider method invocation
+     * ```javascript
+     * adjustTarget(2, 'mypilot1');
+     * ```
+     *
+     * @param value - value in radians to add to current target value.
+     * @param deviceId - identifier of the autopilot device to query.
+     * @throws if supplied target value is outside the valid range.
+     */
     adjustTarget(value: number, deviceId: string): Promise<void>;
+    /**
+     * Sets the state of the autopilot device with the supplied identifier to a state that is actively steering the vessel.
+     *
+     * @example
+     * API request
+     * ```
+     * POST /signalk/v2/api/vessels/self/autopilots/mypilot1/engage
+     * ```
+     * AutopilotProvider method invocation
+     * ```javascript
+     * engage('mypilot1');
+     * ```
+     *
+     * @param deviceId - identifier of the autopilot device to query.
+     * @throws on error.
+     */
     engage(deviceId: string): Promise<void>;
+    /**
+     * **`disengage(deviceId)`**: This method sets the state of the autopilot device with the supplied identifier to a state that is NOT actively steering the vessel.
+     *
+     * @example
+     * API request
+     * ```
+     * POST /signalk/v2/api/vessels/self/autopilots/mypilot1/disengage
+     * ```
+     * AutopilotProvider method invocation
+     * ```javascript
+     * disengage('mypilot1');
+     * ```
+     *
+     * @param deviceId - identifier of the autopilot device to query.
+     * @throws on error.
+     */
     disengage(deviceId: string): Promise<void>;
+    /**
+     * Instructs the autopilot device with the supplied identifier to perform a tack in the supplied direction.
+     *
+     * @example
+     * API request
+     * ```
+     * POST /signalk/v2/api/vessels/self/autopilots/mypilot1/tack/port
+     * ```
+     * AutopilotProvider method invocation
+     * ```javascript
+     * tack('port', 'mypilot1');
+     * ```
+     *
+     * @param direction - `port` or `starboard`
+     * @param deviceId - identifier of the autopilot device to query.
+     * @throws on error.
+     */
     tack(direction: TackGybeDirection, deviceId: string): Promise<void>;
+    /**
+     * **`gybe(direction, deviceId)`**: This method instructs the autopilot device with the supplied identifier to perform a gybe in the supplied direction.
+     *
+     * @example
+     * API request
+     * ```
+     * POST /signalk/v2/api/vessels/self/autopilots/mypilot1/gybe/starboard
+     * ```
+     * AutopilotProvider method invocation
+     * ```javascript
+     * gybe('starboard', 'mypilot1');
+     * ```
+     *
+     * @param direction - `port` or `starboard`
+     * @param deviceId - identifier of the autopilot device to query.
+     * @throws on error.
+     */
     gybe(direction: TackGybeDirection, deviceId: string): Promise<void>;
+    /**
+     * Instructs the autopilot device with the supplied identifier to enter / exit dodge mode and alter the current course by the supplied value (radians) direction.
+     *
+     * @example
+     * To address different pilot behaviour, the `dodge` function can be used in the following ways:
+     *
+     * **1. Enter dodge mode at the current course**
+     * ```javascript
+     * // API request
+     * POST /signalk/v2/api/vessels/self/autopilots/mypilot1/dodge
+     *
+     * // _AutopilotProvider method invocation
+     * dodge(0, 'mypilot1');
+     * ```
+     *
+     * **2. Enter dodge mode and change course**
+     * ```javascript
+     * // API request
+     * PUT /signalk/v2/api/vessels/self/autopilots/mypilot1/dodge {"value": 5}
+     *
+     * // AutopilotProvider method invocation
+     * dodge(5, 'mypilot1');
+     * ```
+     *
+     * **3. Cancel dodge mode**
+     * ```javascript
+     * // API request
+     * DELETE /signalk/v2/api/vessels/self/autopilots/mypilot1/dodge
+     *
+     * // AutopilotProvider method invocation
+     * dodge(null, 'mypilot1');
+     * ```
+     *
+     * @param value - +/- value in radians 'port (-ive)' or 'starboard' to change direction. _Setting the value to `null` indicates exit of dodge mode._
+     * @param deviceId - identifier of the autopilot device to query.
+     * @throws on error.
+     */
     dodge(value: number | null, deviceId: string): Promise<void>;
 }
 export interface AutopilotStateDef {
@@ -42,9 +271,21 @@ export interface AutopilotInfo {
     state: string | null;
     engaged: boolean;
 }
+/**
+ * @hidden visible through ServerAPI
+ */
 export interface AutopilotProviderRegistry {
+    /**
+     * @category Autopilot API
+     */
     registerAutopilotProvider(provider: AutopilotProvider, devices: string[]): void;
+    /**
+     * @category Autopilot API
+     * @param deviceId - the autopilot device identifier
+     * @param apInfo - object containing values keyed by {@link AutopilotInfo}
+     */
     autopilotUpdate(deviceId: string, apInfo: {
         [path: string]: Value;
     }): void;
 }
+//# sourceMappingURL=autopilotapi.d.ts.map

package/dist/autopilotapi.d.ts.map

@@ -0,0 +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"}

package/dist/autopilotapi.guard.d.ts

@@ -1,2 +1,3 @@
 import { AutopilotProvider } from "./autopilotapi";
 export declare function isAutopilotProvider(obj: unknown): obj is AutopilotProvider;
+//# sourceMappingURL=autopilotapi.guard.d.ts.map

package/dist/autopilotapi.guard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"autopilotapi.guard.d.ts","sourceRoot":"","sources":["../src/autopilotapi.guard.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAEnD,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,iBAAiB,CAoB1E"}

package/dist/autopilotapi.guard.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isAutopilotProvider = void 0;
+exports.isAutopilotProvider = isAutopilotProvider;
 function isAutopilotProvider(obj) {
-    var typedObj = obj;
+    const typedObj = obj;
     return ((typedObj !== null &&
         typeof typedObj === "object" ||
         typeof typedObj === "function") &&
@@ -20,4 +20,4 @@ function isAutopilotProvider(obj) {
         typeof typedObj["gybe"] === "function" &&
         typeof typedObj["dodge"] === "function");
 }
-exports.isAutopilotProvider = isAutopilotProvider;
+//# sourceMappingURL=autopilotapi.guard.js.map

package/dist/autopilotapi.guard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"autopilotapi.guard.js","sourceRoot":"","sources":["../src/autopilotapi.guard.ts"],"names":[],"mappings":";;AAMA,kDAoBC;AApBD,SAAgB,mBAAmB,CAAC,GAAY;IAC5C,MAAM,QAAQ,GAAG,GAAwB,CAAA;IACzC,OAAO,CACH,CAAC,QAAQ,KAAK,IAAI;QACd,OAAO,QAAQ,KAAK,QAAQ;QAC5B,OAAO,QAAQ,KAAK,UAAU,CAAC;QACnC,OAAO,QAAQ,CAAC,SAAS,CAAC,KAAK,UAAU;QACzC,OAAO,QAAQ,CAAC,UAAU,CAAC,KAAK,UAAU;QAC1C,OAAO,QAAQ,CAAC,UAAU,CAAC,KAAK,UAAU;QAC1C,OAAO,QAAQ,CAAC,SAAS,CAAC,KAAK,UAAU;QACzC,OAAO,QAAQ,CAAC,SAAS,CAAC,KAAK,UAAU;QACzC,OAAO,QAAQ,CAAC,WAAW,CAAC,KAAK,UAAU;QAC3C,OAAO,QAAQ,CAAC,WAAW,CAAC,KAAK,UAAU;QAC3C,OAAO,QAAQ,CAAC,cAAc,CAAC,KAAK,UAAU;QAC9C,OAAO,QAAQ,CAAC,QAAQ,CAAC,KAAK,UAAU;QACxC,OAAO,QAAQ,CAAC,WAAW,CAAC,KAAK,UAAU;QAC3C,OAAO,QAAQ,CAAC,MAAM,CAAC,KAAK,UAAU;QACtC,OAAO,QAAQ,CAAC,MAAM,CAAC,KAAK,UAAU;QACtC,OAAO,QAAQ,CAAC,OAAO,CAAC,KAAK,UAAU,CAC1C,CAAA;AACL,CAAC"}

package/dist/autopilotapi.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isAutopilotAlarm = exports.isAutopilotUpdateAttrib = void 0;
-var AUTOPILOTUPDATEATTRIBS = [
+const AUTOPILOTUPDATEATTRIBS = [
     'mode',
     'state',
     'target',
@@ -9,11 +9,9 @@ var AUTOPILOTUPDATEATTRIBS = [
     'options',
     'alarm'
 ];
-var isAutopilotUpdateAttrib = function (s) {
-    return AUTOPILOTUPDATEATTRIBS.includes(s);
-};
+const isAutopilotUpdateAttrib = (s) => AUTOPILOTUPDATEATTRIBS.includes(s);
 exports.isAutopilotUpdateAttrib = isAutopilotUpdateAttrib;
-var AUTOPILOTALARMS = [
+const AUTOPILOTALARMS = [
     'waypointAdvance',
     'waypointArrival',
     'routeComplete',
@@ -21,7 +19,6 @@ var AUTOPILOTALARMS = [
     'heading',
     'wind'
 ];
-var isAutopilotAlarm = function (s) {
-    return AUTOPILOTALARMS.includes(s);
-};
+const isAutopilotAlarm = (s) => AUTOPILOTALARMS.includes(s);
 exports.isAutopilotAlarm = isAutopilotAlarm;
+//# sourceMappingURL=autopilotapi.js.map

package/dist/autopilotapi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"autopilotapi.js","sourceRoot":"","sources":["../src/autopilotapi.ts"],"names":[],"mappings":";;;AAUA,MAAM,sBAAsB,GAA4B;IACtD,MAAM;IACN,OAAO;IACP,QAAQ;IACR,SAAS;IACT,SAAS;IACT,OAAO;CACR,CAAA;AAEM,MAAM,uBAAuB,GAAG,CAAC,CAAS,EAAE,EAAE,CACnD,sBAAsB,CAAC,QAAQ,CAAC,CAA0B,CAAC,CAAA;AADhD,QAAA,uBAAuB,2BACyB;AAU7D,MAAM,eAAe,GAAqB;IACxC,iBAAiB;IACjB,iBAAiB;IACjB,eAAe;IACf,KAAK;IACL,SAAS;IACT,MAAM;CACP,CAAA;AAEM,MAAM,gBAAgB,GAAG,CAAC,CAAS,EAAE,EAAE,CAC5C,eAAe,CAAC,QAAQ,CAAC,CAAmB,CAAC,CAAA;AADlC,QAAA,gBAAgB,oBACkB"}

package/dist/brand.d.ts

@@ -0,0 +1,24 @@
+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,
+ *
+ * @example
+ * ```ts
+ * type Path = Branded<string, "path">
+ *
+ * function getSelfPath(path: Path): Delta {
+ *   // ...
+ * }
+ * ```
+ *
+ * @see https://egghead.io/blog/using-branded-types-in-typescript
+ * @internal
+ * @typeParam Type - The real type to use (e.g. `string`, `boolean`, etc.)
+ * @typeParam Name - The name of this type (e.g. `path`, `sourceRef`, etc.)
+ */
+export type Brand<Type, Name> = Type & {
+    [__brand]: Name;
+};
+export {};
+//# sourceMappingURL=brand.d.ts.map

package/dist/brand.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"brand.d.ts","sourceRoot":"","sources":["../src/brand.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,OAAO,EAAE,OAAO,MAAM,CAAA;AAEpC;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,KAAK,CAAC,IAAI,EAAE,IAAI,IAAI,IAAI,GAAG;IAAE,CAAC,OAAO,CAAC,EAAE,IAAI,CAAA;CAAE,CAAA"}

package/dist/{types.js → brand.js}

@@ -1,3 +1,3 @@
 "use strict";
-/* eslint-disable @typescript-eslint/no-explicit-any */
 Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=brand.js.map

package/dist/brand.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"brand.js","sourceRoot":"","sources":["../src/brand.ts"],"names":[],"mappings":""}

package/dist/course.d.ts

@@ -0,0 +1,40 @@
+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.
+ */
+export interface CourseApi {
+    /**
+     * Retrieves the current course information.
+     *
+     * @category Course API
+     */
+    getCourse(): Promise<CourseInfo>;
+    /**
+     * Cancels navigation to the current point or route being followed.
+     *
+     * @category Course API
+     */
+    clearDestination(): Promise<void>;
+    /**
+     * Set course to a specified position / waypoint.
+     *
+     * @category Course API
+     *
+     * @param dest - Object containing destination position information.
+     *
+     */
+    setDestination(dest: (PointDestination & {
+        arrivalCircle?: number;
+    }) | null): Promise<void>;
+    /**
+     * Follow a route in the specified direction and starting at the specified point.
+     *
+     * @param dest - Object containing route information.
+     *
+     * - returns: Resolved Promise on success.
+     *
+     * @category Course API
+     */
+    activateRoute(dest: RouteDestination | null): Promise<void>;
+}
+//# sourceMappingURL=course.d.ts.map

package/dist/course.d.ts.map

@@ -0,0 +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"}

package/dist/course.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=course.js.map

package/dist/course.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"course.js","sourceRoot":"","sources":["../src/course.ts"],"names":[],"mappings":""}

package/dist/coursetypes.d.ts

@@ -1,4 +1,5 @@
-import { Brand, Position } from '.';
+import { Position } from '.';
+import { Brand } from './brand';
 export interface HrefDestination {
     href: string;
 }
@@ -19,6 +20,11 @@ export interface ActiveRoute {
     reverse: boolean;
     name: string;
 }
+export interface NextPreviousPoint {
+    href?: string;
+    type: CoursePointType;
+    position: Position;
+}
 export type CoursePointType = Brand<string, 'coursepointtype'>;
 export declare const COURSE_POINT_TYPES: {
     VesselPosition: CoursePointType;
@@ -30,14 +36,7 @@ export interface CourseInfo {
     targetArrivalTime: string | null;
     arrivalCircle: number;
     activeRoute: ActiveRoute | null;
-    nextPoint: {
-        href?: string;
-        type: CoursePointType;
-        position: Position;
-    } | null;
-    previousPoint: {
-        href?: string;
-        type: CoursePointType;
-        position: Position;
-    } | null;
+    nextPoint: NextPreviousPoint | null;
+    previousPoint: NextPreviousPoint | null;
 }
+//# sourceMappingURL=coursetypes.d.ts.map

package/dist/coursetypes.d.ts.map

@@ -0,0 +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"}

package/dist/coursetypes.js

@@ -6,3 +6,4 @@ exports.COURSE_POINT_TYPES = {
     RoutePoint: 'RoutePoint',
     Location: 'Location'
 };
+//# sourceMappingURL=coursetypes.js.map

package/dist/coursetypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"coursetypes.js","sourceRoot":"","sources":["../src/coursetypes.ts"],"names":[],"mappings":";;;AAoCa,QAAA,kBAAkB,GAAG;IAChC,cAAc,EAAE,gBAAmC;IACnD,UAAU,EAAE,YAA+B;IAC3C,QAAQ,EAAE,UAA6B;CACxC,CAAA"}

package/dist/deltas.d.ts

@@ -1,40 +1,42 @@
-import { Brand } from '.';
+import { Brand } from './brand';
 export interface WithContext {
     context: Context;
 }
-export interface NormalizedDelta extends WithContext {
+/** @inline - Not exported as part of the public API */
+type NormalizedBaseDelta = {
+    context: Context;
     $source: SourceRef;
     source: Source;
     path: Path;
+    timestamp: Timestamp;
+};
+export type NormalizedMetaDelta = NormalizedBaseDelta & {
+    value: MetaValue;
+    isMeta: true;
+};
+export type NormalizedValueDelta = NormalizedBaseDelta & {
     value: Value;
-    isMeta: boolean;
-}
+    isMeta: false;
+};
+export type NormalizedDelta = NormalizedValueDelta | NormalizedMetaDelta;
 export type SourceRef = Brand<string, 'sourceRef'>;
 export type Source = any;
 export type Path = Brand<string, 'path'>;
 export type Timestamp = Brand<string, 'timestamp'>;
 export type Context = Brand<string, 'context'>;
 export type Value = object | number | string | null | Notification | boolean;
-export interface DeltaSubscription {
-    context: Context;
-    subscribe: Array<{
-        path: Path;
-        period: number;
-        format: 'delta' | 'full';
-        policy: 'instant' | 'ideal' | 'fixed';
-        minPeriod: number;
-    }>;
-}
 export interface Delta {
     context?: Context;
     updates: Update[];
 }
 /**
  * @deprecated earlier mistake assumed ValuesDelta and MetaDelta were separate
+ * @hidden
  */
 export type ValuesDelta = Delta;
 /**
  * @deprecated earlier mistake assumed ValuesDelta and MetaDelta were separate
+ * @hidden
  */
 export type MetaDelta = Delta;
 export type Update = {
@@ -75,11 +77,8 @@ export interface MetaValue {
         lower: number;
         upper: number;
     };
-    zones?: {
-        upper: number;
-        lower: number;
-        state: string;
-    }[];
+    zones?: Zone[];
+    supportsPut?: boolean;
 }
 export declare enum ALARM_STATE {
     nominal = "nominal",
@@ -93,3 +92,11 @@ export declare enum ALARM_METHOD {
     visual = "visual",
     sound = "sound"
 }
+export interface Zone {
+    lower: number | undefined;
+    upper: number | undefined;
+    state: ALARM_STATE;
+    message: string;
+}
+export {};
+//# sourceMappingURL=deltas.d.ts.map

package/dist/deltas.d.ts.map

@@ -0,0 +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"}

package/dist/deltas.js

@@ -1,14 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ALARM_METHOD = exports.ALARM_STATE = exports.hasMeta = exports.hasValues = void 0;
+exports.ALARM_METHOD = exports.ALARM_STATE = void 0;
+exports.hasValues = hasValues;
+exports.hasMeta = hasMeta;
 function hasValues(u) {
     return 'values' in u && Array.isArray(u.values);
 }
-exports.hasValues = hasValues;
 function hasMeta(u) {
     return 'meta' in u && Array.isArray(u.meta);
 }
-exports.hasMeta = hasMeta;
 // Notification attribute types
 var ALARM_STATE;
 (function (ALARM_STATE) {
@@ -18,9 +18,10 @@ var ALARM_STATE;
     ALARM_STATE["warn"] = "warn";
     ALARM_STATE["alarm"] = "alarm";
     ALARM_STATE["emergency"] = "emergency";
-})(ALARM_STATE = exports.ALARM_STATE || (exports.ALARM_STATE = {}));
+})(ALARM_STATE || (exports.ALARM_STATE = ALARM_STATE = {}));
 var ALARM_METHOD;
 (function (ALARM_METHOD) {
     ALARM_METHOD["visual"] = "visual";
     ALARM_METHOD["sound"] = "sound";
-})(ALARM_METHOD = exports.ALARM_METHOD || (exports.ALARM_METHOD = {}));
+})(ALARM_METHOD || (exports.ALARM_METHOD = ALARM_METHOD = {}));
+//# sourceMappingURL=deltas.js.map

package/dist/deltas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deltas.js","sourceRoot":"","sources":["../src/deltas.ts"],"names":[],"mappings":";;;AA2DA,8BAEC;AAED,0BAEC;AAND,SAAgB,SAAS,CAAC,CAAS;IACjC,OAAO,QAAQ,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;AACjD,CAAC;AAED,SAAgB,OAAO,CAAC,CAAS;IAC/B,OAAO,MAAM,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;AAC7C,CAAC;AAoCD,+BAA+B;AAC/B,IAAY,WAOX;AAPD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,gCAAiB,CAAA;IACjB,8BAAe,CAAA;IACf,4BAAa,CAAA;IACb,8BAAe,CAAA;IACf,sCAAuB,CAAA;AACzB,CAAC,EAPW,WAAW,2BAAX,WAAW,QAOtB;AAED,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,iCAAiB,CAAA;IACjB,+BAAe,CAAA;AACjB,CAAC,EAHW,YAAY,4BAAZ,YAAY,QAGvB"}

package/dist/deltas.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=deltas.test.d.ts.map

package/dist/deltas.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deltas.test.d.ts","sourceRoot":"","sources":["../src/deltas.test.ts"],"names":[],"mappings":""}