@signalk/path-metadata 0.1.0

package/dist/navigation.js

@@ -0,0 +1,474 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.navigationMetadata = void 0;
+exports.navigationMetadata = {
+    '/vessels/*/navigation': {
+        description: 'Navigation data including Position, Course to next WP information, etc.'
+    },
+    '/vessels/*/navigation/lights': {
+        description: 'Current state of the vessels navigation lights'
+    },
+    '/vessels/*/navigation/courseOverGroundMagnetic': {
+        description: 'Course over ground (magnetic)',
+        units: 'rad'
+    },
+    '/vessels/*/navigation/courseOverGroundTrue': {
+        description: 'Course over ground (true)',
+        units: 'rad'
+    },
+    '/vessels/*/navigation/courseRhumbline': {
+        description: 'Course information computed with Rhumbline'
+    },
+    '/vessels/*/navigation/courseRhumbline/crossTrackError': {
+        description: "The distance from the vessel's present position to the closest point on a line (track) between previousPoint and nextPoint. A negative number indicates that the vessel is currently to the left of this line (and thus must steer right to compensate), a positive number means the vessel is to the right of the line (steer left to compensate).",
+        units: 'm'
+    },
+    '/vessels/*/navigation/courseRhumbline/bearingTrackTrue': {
+        description: 'The bearing of a line between previousPoint and nextPoint, relative to true north.',
+        units: 'rad'
+    },
+    '/vessels/*/navigation/courseRhumbline/bearingTrackMagnetic': {
+        description: 'The bearing of a line between previousPoint and nextPoint, relative to magnetic north.',
+        units: 'rad'
+    },
+    '/vessels/*/navigation/courseRhumbline/activeRoute': {
+        description: 'Data required if sailing to an active route, defined in resources.'
+    },
+    '/vessels/*/navigation/courseRhumbline/activeRoute/href': {
+        description: 'A reference (URL) to the presently active route, in resources.'
+    },
+    '/vessels/*/navigation/courseRhumbline/activeRoute/estimatedTimeOfArrival': {
+        description: 'The estimated time of arrival at the end of the current route'
+    },
+    '/vessels/*/navigation/courseRhumbline/activeRoute/startTime': {
+        description: 'The time this route was activated'
+    },
+    '/vessels/*/navigation/courseRhumbline/nextPoint': {
+        description: "The point on earth the vessel's presently navigating towards"
+    },
+    '/vessels/*/navigation/courseRhumbline/previousPoint': {
+        description: "The point on earth the vessel's presently navigating from",
+        properties: {
+            type: {
+                description: 'The type of the previous point (e.g. Waypoint, POI, Race Mark, etc)',
+                type: 'string'
+            },
+            href: {
+                description: 'A reference (URL) to an object (under resources) this point is related to',
+                type: 'string'
+            }
+        }
+    },
+    '/vessels/*/navigation/courseRhumbline/previousPoint/distance': {
+        description: "The distance in meters between previousPoint and the vessel's present position",
+        units: 'm'
+    },
+    '/vessels/*/navigation/courseRhumbline/previousPoint/position': {
+        description: 'The position of previousPoint in two dimensions',
+        properties: {
+            longitude: {
+                type: 'number',
+                description: 'Longitude',
+                units: 'deg',
+                example: 4.98765245
+            },
+            latitude: {
+                type: 'number',
+                description: 'Latitude',
+                units: 'deg',
+                example: 52.0987654
+            },
+            altitude: {
+                type: 'number',
+                description: 'Altitude',
+                units: 'm'
+            }
+        }
+    },
+    '/vessels/*/navigation/courseGreatCircle': {
+        description: 'Course information computed with Great Circle'
+    },
+    '/vessels/*/navigation/courseGreatCircle/crossTrackError': {
+        description: "The distance from the vessel's present position to the closest point on a line (track) between previousPoint and nextPoint. A negative number indicates that the vessel is currently to the left of this line (and thus must steer right to compensate), a positive number means the vessel is to the right of the line (steer left to compensate).",
+        units: 'm'
+    },
+    '/vessels/*/navigation/courseGreatCircle/bearingTrackTrue': {
+        description: 'The bearing of a line between previousPoint and nextPoint, relative to true north.',
+        units: 'rad'
+    },
+    '/vessels/*/navigation/courseGreatCircle/bearingTrackMagnetic': {
+        description: 'The bearing of a line between previousPoint and nextPoint, relative to magnetic north.',
+        units: 'rad'
+    },
+    '/vessels/*/navigation/courseGreatCircle/activeRoute': {
+        description: 'Data required if sailing to an active route, defined in resources.'
+    },
+    '/vessels/*/navigation/courseGreatCircle/activeRoute/href': {
+        description: 'A reference (URL) to the presently active route, in resources.'
+    },
+    '/vessels/*/navigation/courseGreatCircle/activeRoute/estimatedTimeOfArrival': {
+        description: 'The estimated time of arrival at the end of the current route'
+    },
+    '/vessels/*/navigation/courseGreatCircle/activeRoute/startTime': {
+        description: 'The time this route was activated'
+    },
+    '/vessels/*/navigation/courseGreatCircle/nextPoint': {
+        description: "The point on earth the vessel's presently navigating towards"
+    },
+    '/vessels/*/navigation/courseGreatCircle/previousPoint': {
+        description: "The point on earth the vessel's presently navigating from",
+        properties: {
+            type: {
+                description: 'The type of the previous point (e.g. Waypoint, POI, Race Mark, etc)',
+                type: 'string'
+            },
+            href: {
+                description: 'A reference (URL) to an object (under resources) this point is related to',
+                type: 'string'
+            }
+        }
+    },
+    '/vessels/*/navigation/courseGreatCircle/previousPoint/distance': {
+        description: "The distance in meters between previousPoint and the vessel's present position",
+        units: 'm'
+    },
+    '/vessels/*/navigation/courseGreatCircle/previousPoint/position': {
+        description: 'The position of previousPoint in two dimensions',
+        properties: {
+            longitude: {
+                type: 'number',
+                description: 'Longitude',
+                units: 'deg',
+                example: 4.98765245
+            },
+            latitude: {
+                type: 'number',
+                description: 'Latitude',
+                units: 'deg',
+                example: 52.0987654
+            },
+            altitude: {
+                type: 'number',
+                description: 'Altitude',
+                units: 'm'
+            }
+        }
+    },
+    '/vessels/*/navigation/closestApproach': {
+        description: 'Calculated values for other vessels, e.g. from AIS',
+        properties: {
+            distance: {
+                description: 'Closest Point of Approach (CPA), distance between own vessel and other vessel, based on current speeds, headings and positions',
+                type: 'number',
+                units: 'm',
+                example: 31.2
+            },
+            timeTo: {
+                description: 'Time to Closest Point of Approach (TCPA), between own vessel and other vessel, based on current speeds, headings and positions',
+                type: 'number',
+                units: 's',
+                example: 312
+            }
+        }
+    },
+    '/vessels/*/navigation/racing': {
+        description: 'Specific navigational data related to yacht racing.'
+    },
+    '/vessels/*/navigation/racing/startLineStb': {
+        description: 'Position of starboard start mark',
+        properties: {
+            longitude: {
+                type: 'number',
+                description: 'Longitude',
+                units: 'deg',
+                example: 4.98765245
+            },
+            latitude: {
+                type: 'number',
+                description: 'Latitude',
+                units: 'deg',
+                example: 52.0987654
+            },
+            altitude: {
+                type: 'number',
+                description: 'Altitude',
+                units: 'm'
+            }
+        }
+    },
+    '/vessels/*/navigation/racing/startLinePort': {
+        description: 'Position of port start mark',
+        properties: {
+            longitude: {
+                type: 'number',
+                description: 'Longitude',
+                units: 'deg',
+                example: 4.98765245
+            },
+            latitude: {
+                type: 'number',
+                description: 'Latitude',
+                units: 'deg',
+                example: 52.0987654
+            },
+            altitude: {
+                type: 'number',
+                description: 'Altitude',
+                units: 'm'
+            }
+        }
+    },
+    '/vessels/*/navigation/racing/distanceStartline': {
+        description: 'The current distance to the start line',
+        units: 'm'
+    },
+    '/vessels/*/navigation/racing/timeToStart': {
+        description: 'Time left before start',
+        units: 's'
+    },
+    '/vessels/*/navigation/racing/timePortDown': {
+        description: 'Time to arrive at the start line on port, turning downwind',
+        units: 's'
+    },
+    '/vessels/*/navigation/racing/timePortUp': {
+        description: 'Time to arrive at the start line on port, turning upwind',
+        units: 's'
+    },
+    '/vessels/*/navigation/racing/timeStbdDown': {
+        description: 'Time to arrive at the start line on starboard, turning downwind',
+        units: 's'
+    },
+    '/vessels/*/navigation/racing/timeStbdUp': {
+        description: 'Time to arrive at the start line on starboard, turning upwind',
+        units: 's'
+    },
+    '/vessels/*/navigation/racing/layline': {
+        description: 'The layline crossing the current course'
+    },
+    '/vessels/*/navigation/racing/layline/distance': {
+        description: 'The current distance to the layline',
+        units: 'm'
+    },
+    '/vessels/*/navigation/racing/layline/time': {
+        description: 'The time to the layline at current speed and heading',
+        units: 's'
+    },
+    '/vessels/*/navigation/racing/oppositeLayline': {
+        description: 'The layline parallel to current course'
+    },
+    '/vessels/*/navigation/racing/oppositeLayline/distance': {
+        description: 'The current distance to the layline',
+        units: 'm'
+    },
+    '/vessels/*/navigation/racing/oppositeLayline/time': {
+        description: 'The time to the layline at current speed and heading',
+        units: 's'
+    },
+    '/vessels/*/navigation/magneticVariation': {
+        description: 'The magnetic variation (declination) at the current position that must be added to the magnetic heading to derive the true heading. Easterly variations are positive and Westerly variations are negative (in Radians).',
+        units: 'rad'
+    },
+    '/vessels/*/navigation/magneticVariationAgeOfService': {
+        description: 'Seconds since the 1st Jan 1970 that the variation calculation was made',
+        units: 's'
+    },
+    '/vessels/*/navigation/destination': {
+        description: 'The intended destination of this trip'
+    },
+    '/vessels/*/navigation/destination/commonName': {
+        description: "Common name of the Destination, eg 'Fiji', also used in ais messages"
+    },
+    '/vessels/*/navigation/destination/eta': {
+        description: 'Expected time of arrival at destination waypoint'
+    },
+    '/vessels/*/navigation/destination/waypoint': {
+        description: 'UUID of destination waypoint'
+    },
+    '/vessels/*/navigation/gnss': {
+        description: 'Global satellite navigation meta information'
+    },
+    '/vessels/*/navigation/gnss/type': {
+        description: 'Fix type'
+    },
+    '/vessels/*/navigation/gnss/methodQuality': {
+        description: 'Quality of the satellite fix'
+    },
+    '/vessels/*/navigation/gnss/integrity': {
+        description: 'Integrity of the satellite fix'
+    },
+    '/vessels/*/navigation/gnss/satellites': {
+        description: 'Number of satellites'
+    },
+    '/vessels/*/navigation/gnss/antennaAltitude': {
+        description: 'Altitude of antenna',
+        units: 'm'
+    },
+    '/vessels/*/navigation/gnss/horizontalDilution': {
+        description: 'Horizontal Dilution of Precision'
+    },
+    '/vessels/*/navigation/gnss/positionDilution': {
+        description: 'Positional Dilution of Precision'
+    },
+    '/vessels/*/navigation/gnss/geoidalSeparation': {
+        description: 'Difference between WGS84 earth ellipsoid and mean sea level'
+    },
+    '/vessels/*/navigation/gnss/differentialAge': {
+        description: 'Age of DGPS data',
+        units: 's'
+    },
+    '/vessels/*/navigation/gnss/differentialReference': {
+        description: 'ID of DGPS base station'
+    },
+    '/vessels/*/navigation/headingMagnetic': {
+        description: "Current magnetic heading of the vessel, equals 'headingCompass adjusted for magneticDeviation'",
+        units: 'rad'
+    },
+    '/vessels/*/navigation/magneticDeviation': {
+        description: 'Magnetic deviation of the compass at the current headingCompass',
+        units: 'rad'
+    },
+    '/vessels/*/navigation/headingCompass': {
+        description: 'Current magnetic heading received from the compass. This is not adjusted for magneticDeviation of the compass',
+        units: 'rad'
+    },
+    '/vessels/*/navigation/headingTrue': {
+        description: "The current true north heading of the vessel, equals 'headingMagnetic adjusted for magneticVariation'",
+        units: 'rad'
+    },
+    '/vessels/*/navigation/position': {
+        description: 'The position of the vessel in 2 or 3 dimensions (WGS84 datum)',
+        properties: {
+            longitude: {
+                type: 'number',
+                description: 'Longitude',
+                units: 'deg',
+                example: 4.98765245
+            },
+            latitude: {
+                type: 'number',
+                description: 'Latitude',
+                units: 'deg',
+                example: 52.0987654
+            },
+            altitude: {
+                type: 'number',
+                description: 'Altitude',
+                units: 'm'
+            }
+        }
+    },
+    '/vessels/*/navigation/attitude': {
+        description: 'Vessel attitude: roll, pitch and yaw',
+        properties: {
+            roll: {
+                type: 'number',
+                description: 'Vessel roll, +ve is list to starboard',
+                units: 'rad'
+            },
+            pitch: {
+                type: 'number',
+                description: 'Pitch, +ve is bow up',
+                units: 'rad'
+            },
+            yaw: {
+                type: 'number',
+                description: 'Yaw, +ve is heading change to starboard',
+                units: 'rad'
+            }
+        }
+    },
+    '/vessels/*/navigation/maneuver': {
+        description: 'Special maneuver such as regional passing arrangement. (from ais)'
+    },
+    '/vessels/*/navigation/rateOfTurn': {
+        description: 'Rate of turn (+ve is change to starboard). If the value is AIS RIGHT or LEFT, set to +-0.0206 rads and add warning in notifications',
+        units: 'rad/s'
+    },
+    '/vessels/*/navigation/speedOverGround': {
+        description: "Vessel speed over ground. If converting from AIS 'HIGH' value, set to 102.2 (Ais max value) and add warning in notifications",
+        units: 'm/s'
+    },
+    '/vessels/*/navigation/speedThroughWater': {
+        description: 'Vessel speed through the water',
+        units: 'm/s'
+    },
+    '/vessels/*/navigation/speedThroughWaterTransverse': {
+        description: 'Transverse speed through the water (Leeway)',
+        units: 'm/s'
+    },
+    '/vessels/*/navigation/speedThroughWaterLongitudinal': {
+        description: 'Longitudinal speed through the water',
+        units: 'm/s'
+    },
+    '/vessels/*/navigation/leewayAngle': {
+        description: 'Leeway Angle derived from the longitudinal and transverse speeds through the water',
+        units: 'rad'
+    },
+    '/vessels/*/navigation/log': {
+        description: 'Total distance traveled',
+        units: 'm'
+    },
+    '/vessels/*/navigation/trip': {
+        description: 'Trip data'
+    },
+    '/vessels/*/navigation/trip/log': {
+        description: 'Total distance traveled on this trip / since trip reset',
+        units: 'm'
+    },
+    '/vessels/*/navigation/trip/lastReset': {
+        description: 'Trip log reset time'
+    },
+    '/vessels/*/navigation/state': {
+        description: 'Current navigational state of the vessel'
+    },
+    '/vessels/*/navigation/anchor': {
+        description: 'The anchor data, for anchor watch etc'
+    },
+    '/vessels/*/navigation/anchor/maxRadius': {
+        description: 'Radius of anchor alarm boundary. The distance from anchor to the center of the boat',
+        units: 'm'
+    },
+    '/vessels/*/navigation/anchor/currentRadius': {
+        description: 'Current distance to anchor',
+        units: 'm'
+    },
+    '/vessels/*/navigation/anchor/position': {
+        description: 'The actual anchor position of the vessel in 3 dimensions, probably an estimate at best',
+        properties: {
+            longitude: {
+                type: 'number',
+                description: 'Longitude',
+                units: 'deg',
+                example: 4.98765245
+            },
+            latitude: {
+                type: 'number',
+                description: 'Latitude',
+                units: 'deg',
+                example: 52.0987654
+            },
+            altitude: {
+                type: 'number',
+                description: 'Altitude',
+                units: 'm'
+            }
+        }
+    },
+    '/vessels/*/navigation/datetime': {
+        description: 'Time and Date from the GNSS Positioning System'
+    },
+    '/vessels/*/navigation/datetime/gnssTimeSource': {
+        description: 'Source of GNSS Date and Time',
+        enum: [
+            'GPS',
+            'GLONASS',
+            'Galileo',
+            'Beidou',
+            'IRNSS',
+            'Radio Signal',
+            'Internet',
+            'Local clock'
+        ]
+    }
+};
+//# sourceMappingURL=navigation.js.map

package/dist/navigation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"navigation.js","sourceRoot":"","sources":["../src/navigation.ts"],"names":[],"mappings":";;;AAEa,QAAA,kBAAkB,GAAsC;IACnE,uBAAuB,EAAE;QACvB,WAAW,EACT,yEAAyE;KAC5E;IACD,8BAA8B,EAAE;QAC9B,WAAW,EAAE,gDAAgD;KAC9D;IACD,gDAAgD,EAAE;QAChD,WAAW,EAAE,+BAA+B;QAC5C,KAAK,EAAE,KAAK;KACb;IACD,4CAA4C,EAAE;QAC5C,WAAW,EAAE,2BAA2B;QACxC,KAAK,EAAE,KAAK;KACb;IACD,uCAAuC,EAAE;QACvC,WAAW,EAAE,4CAA4C;KAC1D;IACD,uDAAuD,EAAE;QACvD,WAAW,EACT,qVAAqV;QACvV,KAAK,EAAE,GAAG;KACX;IACD,wDAAwD,EAAE;QACxD,WAAW,EACT,oFAAoF;QACtF,KAAK,EAAE,KAAK;KACb;IACD,4DAA4D,EAAE;QAC5D,WAAW,EACT,wFAAwF;QAC1F,KAAK,EAAE,KAAK;KACb;IACD,mDAAmD,EAAE;QACnD,WAAW,EACT,oEAAoE;KACvE;IACD,wDAAwD,EAAE;QACxD,WAAW,EACT,gEAAgE;KACnE;IACD,0EAA0E,EAAE;QAC1E,WAAW,EAAE,+DAA+D;KAC7E;IACD,6DAA6D,EAAE;QAC7D,WAAW,EAAE,mCAAmC;KACjD;IACD,iDAAiD,EAAE;QACjD,WAAW,EAAE,8DAA8D;KAC5E;IACD,qDAAqD,EAAE;QACrD,WAAW,EAAE,2DAA2D;QACxE,UAAU,EAAE;YACV,IAAI,EAAE;gBACJ,WAAW,EACT,qEAAqE;gBACvE,IAAI,EAAE,QAAQ;aACf;YACD,IAAI,EAAE;gBACJ,WAAW,EACT,2EAA2E;gBAC7E,IAAI,EAAE,QAAQ;aACf;SACF;KACF;IACD,8DAA8D,EAAE;QAC9D,WAAW,EACT,gFAAgF;QAClF,KAAK,EAAE,GAAG;KACX;IACD,8DAA8D,EAAE;QAC9D,WAAW,EAAE,iDAAiD;QAC9D,UAAU,EAAE;YACV,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,WAAW;gBACxB,KAAK,EAAE,KAAK;gBACZ,OAAO,EAAE,UAAU;aACpB;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,UAAU;gBACvB,KAAK,EAAE,KAAK;gBACZ,OAAO,EAAE,UAAU;aACpB;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,UAAU;gBACvB,KAAK,EAAE,GAAG;aACX;SACF;KACF;IACD,yCAAyC,EAAE;QACzC,WAAW,EAAE,+CAA+C;KAC7D;IACD,yDAAyD,EAAE;QACzD,WAAW,EACT,qVAAqV;QACvV,KAAK,EAAE,GAAG;KACX;IACD,0DAA0D,EAAE;QAC1D,WAAW,EACT,oFAAoF;QACtF,KAAK,EAAE,KAAK;KACb;IACD,8DAA8D,EAAE;QAC9D,WAAW,EACT,wFAAwF;QAC1F,KAAK,EAAE,KAAK;KACb;IACD,qDAAqD,EAAE;QACrD,WAAW,EACT,oEAAoE;KACvE;IACD,0DAA0D,EAAE;QAC1D,WAAW,EACT,gEAAgE;KACnE;IACD,4EAA4E,EAC1E;QACE,WAAW,EACT,+DAA+D;KAClE;IACH,+DAA+D,EAAE;QAC/D,WAAW,EAAE,mCAAmC;KACjD;IACD,mDAAmD,EAAE;QACnD,WAAW,EAAE,8DAA8D;KAC5E;IACD,uDAAuD,EAAE;QACvD,WAAW,EAAE,2DAA2D;QACxE,UAAU,EAAE;YACV,IAAI,EAAE;gBACJ,WAAW,EACT,qEAAqE;gBACvE,IAAI,EAAE,QAAQ;aACf;YACD,IAAI,EAAE;gBACJ,WAAW,EACT,2EAA2E;gBAC7E,IAAI,EAAE,QAAQ;aACf;SACF;KACF;IACD,gEAAgE,EAAE;QAChE,WAAW,EACT,gFAAgF;QAClF,KAAK,EAAE,GAAG;KACX;IACD,gEAAgE,EAAE;QAChE,WAAW,EAAE,iDAAiD;QAC9D,UAAU,EAAE;YACV,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,WAAW;gBACxB,KAAK,EAAE,KAAK;gBACZ,OAAO,EAAE,UAAU;aACpB;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,UAAU;gBACvB,KAAK,EAAE,KAAK;gBACZ,OAAO,EAAE,UAAU;aACpB;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,UAAU;gBACvB,KAAK,EAAE,GAAG;aACX;SACF;KACF;IACD,uCAAuC,EAAE;QACvC,WAAW,EAAE,oDAAoD;QACjE,UAAU,EAAE;YACV,QAAQ,EAAE;gBACR,WAAW,EACT,gIAAgI;gBAClI,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,GAAG;gBACV,OAAO,EAAE,IAAI;aACd;YACD,MAAM,EAAE;gBACN,WAAW,EACT,gIAAgI;gBAClI,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,GAAG;gBACV,OAAO,EAAE,GAAG;aACb;SACF;KACF;IACD,8BAA8B,EAAE;QAC9B,WAAW,EAAE,qDAAqD;KACnE;IACD,2CAA2C,EAAE;QAC3C,WAAW,EAAE,kCAAkC;QAC/C,UAAU,EAAE;YACV,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,WAAW;gBACxB,KAAK,EAAE,KAAK;gBACZ,OAAO,EAAE,UAAU;aACpB;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,UAAU;gBACvB,KAAK,EAAE,KAAK;gBACZ,OAAO,EAAE,UAAU;aACpB;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,UAAU;gBACvB,KAAK,EAAE,GAAG;aACX;SACF;KACF;IACD,4CAA4C,EAAE;QAC5C,WAAW,EAAE,6BAA6B;QAC1C,UAAU,EAAE;YACV,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,WAAW;gBACxB,KAAK,EAAE,KAAK;gBACZ,OAAO,EAAE,UAAU;aACpB;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,UAAU;gBACvB,KAAK,EAAE,KAAK;gBACZ,OAAO,EAAE,UAAU;aACpB;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,UAAU;gBACvB,KAAK,EAAE,GAAG;aACX;SACF;KACF;IACD,gDAAgD,EAAE;QAChD,WAAW,EAAE,wCAAwC;QACrD,KAAK,EAAE,GAAG;KACX;IACD,0CAA0C,EAAE;QAC1C,WAAW,EAAE,wBAAwB;QACrC,KAAK,EAAE,GAAG;KACX;IACD,2CAA2C,EAAE;QAC3C,WAAW,EAAE,4DAA4D;QACzE,KAAK,EAAE,GAAG;KACX;IACD,yCAAyC,EAAE;QACzC,WAAW,EAAE,0DAA0D;QACvE,KAAK,EAAE,GAAG;KACX;IACD,2CAA2C,EAAE;QAC3C,WAAW,EACT,iEAAiE;QACnE,KAAK,EAAE,GAAG;KACX;IACD,yCAAyC,EAAE;QACzC,WAAW,EACT,+DAA+D;QACjE,KAAK,EAAE,GAAG;KACX;IACD,sCAAsC,EAAE;QACtC,WAAW,EAAE,yCAAyC;KACvD;IACD,+CAA+C,EAAE;QAC/C,WAAW,EAAE,qCAAqC;QAClD,KAAK,EAAE,GAAG;KACX;IACD,2CAA2C,EAAE;QAC3C,WAAW,EAAE,sDAAsD;QACnE,KAAK,EAAE,GAAG;KACX;IACD,8CAA8C,EAAE;QAC9C,WAAW,EAAE,wCAAwC;KACtD;IACD,uDAAuD,EAAE;QACvD,WAAW,EAAE,qCAAqC;QAClD,KAAK,EAAE,GAAG;KACX;IACD,mDAAmD,EAAE;QACnD,WAAW,EAAE,sDAAsD;QACnE,KAAK,EAAE,GAAG;KACX;IACD,yCAAyC,EAAE;QACzC,WAAW,EACT,yNAAyN;QAC3N,KAAK,EAAE,KAAK;KACb;IACD,qDAAqD,EAAE;QACrD,WAAW,EACT,wEAAwE;QAC1E,KAAK,EAAE,GAAG;KACX;IACD,mCAAmC,EAAE;QACnC,WAAW,EAAE,uCAAuC;KACrD;IACD,8CAA8C,EAAE;QAC9C,WAAW,EACT,sEAAsE;KACzE;IACD,uCAAuC,EAAE;QACvC,WAAW,EAAE,kDAAkD;KAChE;IACD,4CAA4C,EAAE;QAC5C,WAAW,EAAE,8BAA8B;KAC5C;IACD,4BAA4B,EAAE;QAC5B,WAAW,EAAE,8CAA8C;KAC5D;IACD,iCAAiC,EAAE;QACjC,WAAW,EAAE,UAAU;KACxB;IACD,0CAA0C,EAAE;QAC1C,WAAW,EAAE,8BAA8B;KAC5C;IACD,sCAAsC,EAAE;QACtC,WAAW,EAAE,gCAAgC;KAC9C;IACD,uCAAuC,EAAE;QACvC,WAAW,EAAE,sBAAsB;KACpC;IACD,4CAA4C,EAAE;QAC5C,WAAW,EAAE,qBAAqB;QAClC,KAAK,EAAE,GAAG;KACX;IACD,+CAA+C,EAAE;QAC/C,WAAW,EAAE,kCAAkC;KAChD;IACD,6CAA6C,EAAE;QAC7C,WAAW,EAAE,kCAAkC;KAChD;IACD,8CAA8C,EAAE;QAC9C,WAAW,EAAE,6DAA6D;KAC3E;IACD,4CAA4C,EAAE;QAC5C,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,GAAG;KACX;IACD,kDAAkD,EAAE;QAClD,WAAW,EAAE,yBAAyB;KACvC;IACD,uCAAuC,EAAE;QACvC,WAAW,EACT,gGAAgG;QAClG,KAAK,EAAE,KAAK;KACb;IACD,yCAAyC,EAAE;QACzC,WAAW,EACT,iEAAiE;QACnE,KAAK,EAAE,KAAK;KACb;IACD,sCAAsC,EAAE;QACtC,WAAW,EACT,+GAA+G;QACjH,KAAK,EAAE,KAAK;KACb;IACD,mCAAmC,EAAE;QACnC,WAAW,EACT,uGAAuG;QACzG,KAAK,EAAE,KAAK;KACb;IACD,gCAAgC,EAAE;QAChC,WAAW,EACT,+DAA+D;QACjE,UAAU,EAAE;YACV,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,WAAW;gBACxB,KAAK,EAAE,KAAK;gBACZ,OAAO,EAAE,UAAU;aACpB;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,UAAU;gBACvB,KAAK,EAAE,KAAK;gBACZ,OAAO,EAAE,UAAU;aACpB;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,UAAU;gBACvB,KAAK,EAAE,GAAG;aACX;SACF;KACF;IACD,gCAAgC,EAAE;QAChC,WAAW,EAAE,sCAAsC;QACnD,UAAU,EAAE;YACV,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,uCAAuC;gBACpD,KAAK,EAAE,KAAK;aACb;YACD,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,sBAAsB;gBACnC,KAAK,EAAE,KAAK;aACb;YACD,GAAG,EAAE;gBACH,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,yCAAyC;gBACtD,KAAK,EAAE,KAAK;aACb;SACF;KACF;IACD,gCAAgC,EAAE;QAChC,WAAW,EACT,mEAAmE;KACtE;IACD,kCAAkC,EAAE;QAClC,WAAW,EACT,qIAAqI;QACvI,KAAK,EAAE,OAAO;KACf;IACD,uCAAuC,EAAE;QACvC,WAAW,EACT,8HAA8H;QAChI,KAAK,EAAE,KAAK;KACb;IACD,yCAAyC,EAAE;QACzC,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;IACD,mDAAmD,EAAE;QACnD,WAAW,EAAE,6CAA6C;QAC1D,KAAK,EAAE,KAAK;KACb;IACD,qDAAqD,EAAE;QACrD,WAAW,EAAE,sCAAsC;QACnD,KAAK,EAAE,KAAK;KACb;IACD,mCAAmC,EAAE;QACnC,WAAW,EACT,oFAAoF;QACtF,KAAK,EAAE,KAAK;KACb;IACD,2BAA2B,EAAE;QAC3B,WAAW,EAAE,yBAAyB;QACtC,KAAK,EAAE,GAAG;KACX;IACD,4BAA4B,EAAE;QAC5B,WAAW,EAAE,WAAW;KACzB;IACD,gCAAgC,EAAE;QAChC,WAAW,EAAE,yDAAyD;QACtE,KAAK,EAAE,GAAG;KACX;IACD,sCAAsC,EAAE;QACtC,WAAW,EAAE,qBAAqB;KACnC;IACD,6BAA6B,EAAE;QAC7B,WAAW,EAAE,0CAA0C;KACxD;IACD,8BAA8B,EAAE;QAC9B,WAAW,EAAE,uCAAuC;KACrD;IACD,wCAAwC,EAAE;QACxC,WAAW,EACT,qFAAqF;QACvF,KAAK,EAAE,GAAG;KACX;IACD,4CAA4C,EAAE;QAC5C,WAAW,EAAE,4BAA4B;QACzC,KAAK,EAAE,GAAG;KACX;IACD,uCAAuC,EAAE;QACvC,WAAW,EACT,wFAAwF;QAC1F,UAAU,EAAE;YACV,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,WAAW;gBACxB,KAAK,EAAE,KAAK;gBACZ,OAAO,EAAE,UAAU;aACpB;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,UAAU;gBACvB,KAAK,EAAE,KAAK;gBACZ,OAAO,EAAE,UAAU;aACpB;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,UAAU;gBACvB,KAAK,EAAE,GAAG;aACX;SACF;KACF;IACD,gCAAgC,EAAE;QAChC,WAAW,EAAE,gDAAgD;KAC9D;IACD,+CAA+C,EAAE;QAC/C,WAAW,EAAE,8BAA8B;QAC3C,IAAI,EAAE;YACJ,KAAK;YACL,SAAS;YACT,SAAS;YACT,QAAQ;YACR,OAAO;YACP,cAAc;YACd,UAAU;YACV,aAAa;SACd;KACF;CACF,CAAA"}

package/dist/notifications.d.ts

@@ -0,0 +1,3 @@
+import type { PathMetadataEntry } from './types';
+export declare const notificationsMetadata: Record<string, PathMetadataEntry>;
+//# sourceMappingURL=notifications.d.ts.map

package/dist/notifications.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notifications.d.ts","sourceRoot":"","sources":["../src/notifications.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AA0BhD,eAAO,MAAM,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAiDnE,CAAA"}

package/dist/notifications.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.notificationsMetadata = void 0;
+// Properties shared by every notification path (mob, fire, sinking, etc).
+// Kept in one place so a tweak to the alarm-state enum or the method
+// list lands in every notification at once.
+const NOTIFICATION_PROPERTIES = {
+    method: {
+        description: 'Method to use to raise notifications',
+        type: 'array',
+        items: {
+            enum: ['visual', 'sound']
+        }
+    },
+    state: {
+        type: 'string',
+        title: 'alarmState',
+        description: 'The alarm state when the value is in this zone.',
+        default: 'normal',
+        enum: ['nominal', 'normal', 'alert', 'warn', 'alarm', 'emergency']
+    },
+    message: {
+        description: 'Message to display or speak',
+        type: 'string'
+    }
+};
+exports.notificationsMetadata = {
+    '/vessels/*/notifications': {
+        description: 'Notifications currently raised. Major categories have well-defined names, but the tree can be extended by any hierarchical structure'
+    },
+    '/vessels/*/notifications/mob': {
+        description: 'Man overboard',
+        properties: NOTIFICATION_PROPERTIES
+    },
+    '/vessels/*/notifications/fire': {
+        description: 'Fire onboard',
+        properties: NOTIFICATION_PROPERTIES
+    },
+    '/vessels/*/notifications/sinking': {
+        description: 'Vessel is sinking',
+        properties: NOTIFICATION_PROPERTIES
+    },
+    '/vessels/*/notifications/flooding': {
+        description: 'Vessel is flooding',
+        properties: NOTIFICATION_PROPERTIES
+    },
+    '/vessels/*/notifications/collision': {
+        description: 'In collision with another vessel or object',
+        properties: NOTIFICATION_PROPERTIES
+    },
+    '/vessels/*/notifications/grounding': {
+        description: 'Vessel grounding',
+        properties: NOTIFICATION_PROPERTIES
+    },
+    '/vessels/*/notifications/listing': {
+        description: 'Vessel is listing',
+        properties: NOTIFICATION_PROPERTIES
+    },
+    '/vessels/*/notifications/adrift': {
+        description: 'Vessel is adrift',
+        properties: NOTIFICATION_PROPERTIES
+    },
+    '/vessels/*/notifications/piracy': {
+        description: 'Under attack or danger from pirates',
+        properties: NOTIFICATION_PROPERTIES
+    },
+    '/vessels/*/notifications/abandon': {
+        description: 'Abandon ship',
+        properties: NOTIFICATION_PROPERTIES
+    },
+    '/vessels/*/notifications/RegExp': {
+        description: 'This regex pattern is used for validation of the path of the alarm'
+    }
+};
+//# sourceMappingURL=notifications.js.map

package/dist/notifications.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notifications.js","sourceRoot":"","sources":["../src/notifications.ts"],"names":[],"mappings":";;;AAEA,0EAA0E;AAC1E,qEAAqE;AACrE,4CAA4C;AAC5C,MAAM,uBAAuB,GAAG;IAC9B,MAAM,EAAE;QACN,WAAW,EAAE,sCAAsC;QACnD,IAAI,EAAE,OAAO;QACb,KAAK,EAAE;YACL,IAAI,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC;SAC1B;KACF;IACD,KAAK,EAAE;QACL,IAAI,EAAE,QAAQ;QACd,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,iDAAiD;QAC9D,OAAO,EAAE,QAAQ;QACjB,IAAI,EAAE,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC;KACnE;IACD,OAAO,EAAE;QACP,WAAW,EAAE,6BAA6B;QAC1C,IAAI,EAAE,QAAQ;KACf;CACF,CAAA;AAEY,QAAA,qBAAqB,GAAsC;IACtE,0BAA0B,EAAE;QAC1B,WAAW,EACT,sIAAsI;KACzI;IACD,8BAA8B,EAAE;QAC9B,WAAW,EAAE,eAAe;QAC5B,UAAU,EAAE,uBAAuB;KACpC;IACD,+BAA+B,EAAE;QAC/B,WAAW,EAAE,cAAc;QAC3B,UAAU,EAAE,uBAAuB;KACpC;IACD,kCAAkC,EAAE;QAClC,WAAW,EAAE,mBAAmB;QAChC,UAAU,EAAE,uBAAuB;KACpC;IACD,mCAAmC,EAAE;QACnC,WAAW,EAAE,oBAAoB;QACjC,UAAU,EAAE,uBAAuB;KACpC;IACD,oCAAoC,EAAE;QACpC,WAAW,EAAE,4CAA4C;QACzD,UAAU,EAAE,uBAAuB;KACpC;IACD,oCAAoC,EAAE;QACpC,WAAW,EAAE,kBAAkB;QAC/B,UAAU,EAAE,uBAAuB;KACpC;IACD,kCAAkC,EAAE;QAClC,WAAW,EAAE,mBAAmB;QAChC,UAAU,EAAE,uBAAuB;KACpC;IACD,iCAAiC,EAAE;QACjC,WAAW,EAAE,kBAAkB;QAC/B,UAAU,EAAE,uBAAuB;KACpC;IACD,iCAAiC,EAAE;QACjC,WAAW,EAAE,qCAAqC;QAClD,UAAU,EAAE,uBAAuB;KACpC;IACD,kCAAkC,EAAE;QAClC,WAAW,EAAE,cAAc;QAC3B,UAAU,EAAE,uBAAuB;KACpC;IACD,iCAAiC,EAAE;QACjC,WAAW,EACT,oEAAoE;KACvE;CACF,CAAA"}

package/dist/performance.d.ts

@@ -0,0 +1,3 @@
+import type { PathMetadataEntry } from './types';
+export declare const performanceMetadata: Record<string, PathMetadataEntry>;
+//# sourceMappingURL=performance.d.ts.map

package/dist/performance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"performance.d.ts","sourceRoot":"","sources":["../src/performance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAEhD,eAAO,MAAM,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAqGjE,CAAA"}