@signalk/path-metadata 0.1.0

package/dist/sails.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sailsMetadata = void 0;
+exports.sailsMetadata = {
+    '/vessels/*/sails': {
+        description: 'Sails data'
+    },
+    '/vessels/*/sails/inventory': {
+        description: 'An object containing a description of each sail available to the vessel crew'
+    },
+    '/vessels/*/sails/inventory/RegExp': {
+        description: "'sail' data type."
+    },
+    '/vessels/*/sails/inventory/RegExp/name': {
+        description: 'A unique identifier by which the crew identifies a sail'
+    },
+    '/vessels/*/sails/inventory/RegExp/type': {
+        description: 'The type of sail'
+    },
+    '/vessels/*/sails/inventory/RegExp/material': {
+        description: 'The material the sail is made from (optional)'
+    },
+    '/vessels/*/sails/inventory/RegExp/brand': {
+        description: 'The brand of the sail (optional)'
+    },
+    '/vessels/*/sails/inventory/RegExp/active': {
+        description: 'Indicates whether this sail is currently in use or not'
+    },
+    '/vessels/*/sails/inventory/RegExp/area': {
+        description: 'The total area of this sail in square meters',
+        units: 'm2'
+    },
+    '/vessels/*/sails/inventory/RegExp/minimumWind': {
+        description: 'The minimum wind speed this sail can be used with',
+        units: 'm/s'
+    },
+    '/vessels/*/sails/inventory/RegExp/maximumWind': {
+        description: 'The maximum wind speed this sail can be used with',
+        units: 'm/s'
+    },
+    '/vessels/*/sails/inventory/RegExp/reducedState': {
+        description: 'An object describing reduction of sail area'
+    },
+    '/vessels/*/sails/inventory/RegExp/reducedState/reduced': {
+        description: 'describes whether the sail is reduced or not'
+    },
+    '/vessels/*/sails/inventory/RegExp/reducedState/reefs': {
+        description: 'Number of reefs set, 0 means full'
+    },
+    '/vessels/*/sails/inventory/RegExp/reducedState/furledRatio': {
+        description: 'Ratio of sail reduction, 0 means full and 1 is completely furled in'
+    },
+    '/vessels/*/sails/area': {
+        description: "An object containing information about the vessels' sails."
+    },
+    '/vessels/*/sails/area/total': {
+        description: 'Data should be of type number.',
+        units: 'm2'
+    },
+    '/vessels/*/sails/area/active': {
+        description: 'Data should be of type number.',
+        units: 'm2'
+    }
+};
+//# sourceMappingURL=sails.js.map

package/dist/sails.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sails.js","sourceRoot":"","sources":["../src/sails.ts"],"names":[],"mappings":";;;AAEa,QAAA,aAAa,GAAsC;IAC9D,kBAAkB,EAAE;QAClB,WAAW,EAAE,YAAY;KAC1B;IACD,4BAA4B,EAAE;QAC5B,WAAW,EACT,8EAA8E;KACjF;IACD,mCAAmC,EAAE;QACnC,WAAW,EAAE,mBAAmB;KACjC;IACD,wCAAwC,EAAE;QACxC,WAAW,EAAE,yDAAyD;KACvE;IACD,wCAAwC,EAAE;QACxC,WAAW,EAAE,kBAAkB;KAChC;IACD,4CAA4C,EAAE;QAC5C,WAAW,EAAE,+CAA+C;KAC7D;IACD,yCAAyC,EAAE;QACzC,WAAW,EAAE,kCAAkC;KAChD;IACD,0CAA0C,EAAE;QAC1C,WAAW,EAAE,wDAAwD;KACtE;IACD,wCAAwC,EAAE;QACxC,WAAW,EAAE,8CAA8C;QAC3D,KAAK,EAAE,IAAI;KACZ;IACD,+CAA+C,EAAE;QAC/C,WAAW,EAAE,mDAAmD;QAChE,KAAK,EAAE,KAAK;KACb;IACD,+CAA+C,EAAE;QAC/C,WAAW,EAAE,mDAAmD;QAChE,KAAK,EAAE,KAAK;KACb;IACD,gDAAgD,EAAE;QAChD,WAAW,EAAE,6CAA6C;KAC3D;IACD,wDAAwD,EAAE;QACxD,WAAW,EAAE,8CAA8C;KAC5D;IACD,sDAAsD,EAAE;QACtD,WAAW,EAAE,mCAAmC;KACjD;IACD,4DAA4D,EAAE;QAC5D,WAAW,EACT,qEAAqE;KACxE;IACD,uBAAuB,EAAE;QACvB,WAAW,EAAE,4DAA4D;KAC1E;IACD,6BAA6B,EAAE;QAC7B,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,8BAA8B,EAAE;QAC9B,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;CACF,CAAA"}

package/dist/sensors.d.ts

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

package/dist/sensors.d.ts.map

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

package/dist/sensors.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sensorsMetadata = void 0;
+exports.sensorsMetadata = {
+    '/vessels/*/sensors': {
+        description: 'Sensors, their state, and data.'
+    },
+    '/vessels/*/sensors/RegExp': {
+        description: "This regex pattern is used for validating the sensor's UUID identifier."
+    },
+    '/vessels/*/sensors/RegExp/name': {
+        description: 'The common name of the sensor'
+    },
+    '/vessels/*/sensors/RegExp/sensorType': {
+        description: 'The datamodel definition of the sensor data. FIXME - need to create a definitions lib of sensor datamodel types'
+    },
+    '/vessels/*/sensors/RegExp/sensorData': {
+        description: 'The data of the sensor data. FIXME - need to ref the definitions of sensor types'
+    },
+    '/vessels/*/sensors/RegExp/fromBow': {
+        description: 'Distance of the sensor along the vessel axis from the bow',
+        units: 'm'
+    },
+    '/vessels/*/sensors/RegExp/fromCenter': {
+        description: 'Distance of the sensor across the vessel from the centreline, positive towards starboard',
+        units: 'm'
+    },
+    '/vessels/*/sensors/RegExp/class': {
+        description: 'Sensor class — for an AIS transponder, A or B.'
+    }
+};
+//# sourceMappingURL=sensors.js.map

package/dist/sensors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sensors.js","sourceRoot":"","sources":["../src/sensors.ts"],"names":[],"mappings":";;;AAEa,QAAA,eAAe,GAAsC;IAChE,oBAAoB,EAAE;QACpB,WAAW,EAAE,iCAAiC;KAC/C;IACD,2BAA2B,EAAE;QAC3B,WAAW,EACT,yEAAyE;KAC5E;IACD,gCAAgC,EAAE;QAChC,WAAW,EAAE,+BAA+B;KAC7C;IACD,sCAAsC,EAAE;QACtC,WAAW,EACT,iHAAiH;KACpH;IACD,sCAAsC,EAAE;QACtC,WAAW,EACT,kFAAkF;KACrF;IACD,mCAAmC,EAAE;QACnC,WAAW,EAAE,2DAA2D;QACxE,KAAK,EAAE,GAAG;KACX;IACD,sCAAsC,EAAE;QACtC,WAAW,EACT,0FAA0F;QAC5F,KAAK,EAAE,GAAG;KACX;IACD,iCAAiC,EAAE;QACjC,WAAW,EAAE,gDAAgD;KAC9D;CACF,CAAA"}

package/dist/steering.d.ts

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

package/dist/steering.d.ts.map

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

package/dist/steering.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.steeringMetadata = void 0;
+exports.steeringMetadata = {
+    '/vessels/*/steering': {
+        description: "Vessel steering data for steering controls (not Autopilot 'Nav Data')"
+    },
+    '/vessels/*/steering/rudderAngle': {
+        description: 'Data should be of type number.',
+        units: 'rad'
+    },
+    '/vessels/*/steering/rudderAngleTarget': {
+        description: 'Data should be of type number.',
+        units: 'rad'
+    },
+    '/vessels/*/steering/autopilot': {
+        description: 'Autopilot data'
+    },
+    '/vessels/*/steering/autopilot/state': {
+        description: 'Autopilot state'
+    },
+    '/vessels/*/steering/autopilot/mode': {
+        description: 'Operational mode'
+    },
+    '/vessels/*/steering/autopilot/target': {
+        description: 'Autopilot target'
+    },
+    '/vessels/*/steering/autopilot/target/windAngleApparent': {
+        description: 'Data should be of type number.',
+        units: 'rad'
+    },
+    '/vessels/*/steering/autopilot/target/windAngleTrue': {
+        description: 'Data should be of type number.',
+        units: 'rad'
+    },
+    '/vessels/*/steering/autopilot/target/headingTrue': {
+        description: 'Data should be of type number.',
+        units: 'rad'
+    },
+    '/vessels/*/steering/autopilot/target/headingMagnetic': {
+        description: 'Data should be of type number.',
+        units: 'rad'
+    },
+    '/vessels/*/steering/autopilot/deadZone': {
+        description: 'Data should be of type number.',
+        units: 'rad'
+    },
+    '/vessels/*/steering/autopilot/backlash': {
+        description: 'Data should be of type number.',
+        units: 'rad'
+    },
+    '/vessels/*/steering/autopilot/gain': {
+        description: 'Data should be of type number.'
+    },
+    '/vessels/*/steering/autopilot/maxDriveCurrent': {
+        description: 'Data should be of type number.',
+        units: 'A'
+    },
+    '/vessels/*/steering/autopilot/maxDriveRate': {
+        description: 'Data should be of type number.',
+        units: 'rad/s'
+    },
+    '/vessels/*/steering/autopilot/portLock': {
+        description: 'Data should be of type number.',
+        units: 'rad'
+    },
+    '/vessels/*/steering/autopilot/starboardLock': {
+        description: 'Data should be of type number.',
+        units: 'rad'
+    }
+};
+//# sourceMappingURL=steering.js.map

package/dist/steering.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"steering.js","sourceRoot":"","sources":["../src/steering.ts"],"names":[],"mappings":";;;AAEa,QAAA,gBAAgB,GAAsC;IACjE,qBAAqB,EAAE;QACrB,WAAW,EACT,uEAAuE;KAC1E;IACD,iCAAiC,EAAE;QACjC,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;IACD,uCAAuC,EAAE;QACvC,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;IACD,+BAA+B,EAAE;QAC/B,WAAW,EAAE,gBAAgB;KAC9B;IACD,qCAAqC,EAAE;QACrC,WAAW,EAAE,iBAAiB;KAC/B;IACD,oCAAoC,EAAE;QACpC,WAAW,EAAE,kBAAkB;KAChC;IACD,sCAAsC,EAAE;QACtC,WAAW,EAAE,kBAAkB;KAChC;IACD,wDAAwD,EAAE;QACxD,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;IACD,oDAAoD,EAAE;QACpD,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;IACD,kDAAkD,EAAE;QAClD,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;IACD,sDAAsD,EAAE;QACtD,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;IACD,wCAAwC,EAAE;QACxC,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;IACD,wCAAwC,EAAE;QACxC,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;IACD,oCAAoC,EAAE;QACpC,WAAW,EAAE,gCAAgC;KAC9C;IACD,+CAA+C,EAAE;QAC/C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,GAAG;KACX;IACD,4CAA4C,EAAE;QAC5C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,OAAO;KACf;IACD,wCAAwC,EAAE;QACxC,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;IACD,6CAA6C,EAAE;QAC7C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;CACF,CAAA"}

package/dist/tanks.d.ts

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

package/dist/tanks.d.ts.map

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

package/dist/tanks.js

@@ -0,0 +1,386 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tanksMetadata = void 0;
+// Allowed liquid types across every tank category. Keeping a single
+// constant means a future protocol change to the list can't drift between
+// freshWater / wasteWater / blackWater / fuel / lubrication / liveWell /
+// baitWell / gas / ballast.
+const TANK_TYPE_ENUM = [
+    'petrol',
+    'fresh water',
+    'greywater',
+    'blackwater',
+    'holding',
+    'lpg',
+    'diesel',
+    'liveWell',
+    'baitWell',
+    'ballast',
+    'rum'
+];
+exports.tanksMetadata = {
+    '/vessels/*/tanks': {
+        description: 'Tank data, each tank identified by a unique name i.e. FreshWater_2'
+    },
+    '/vessels/*/tanks/freshWater': {
+        description: 'Fresh water tank (drinking)'
+    },
+    '/vessels/*/tanks/freshWater/RegExp': {
+        description: 'Tank, one or many, within the vessel'
+    },
+    '/vessels/*/tanks/freshWater/RegExp/name': {
+        description: 'The name of the tank. Useful if multiple tanks of a certain type are on board'
+    },
+    '/vessels/*/tanks/freshWater/RegExp/type': {
+        description: 'The type of tank',
+        enum: [...TANK_TYPE_ENUM]
+    },
+    '/vessels/*/tanks/freshWater/RegExp/capacity': {
+        description: 'Data should be of type number.',
+        units: 'm3'
+    },
+    '/vessels/*/tanks/freshWater/RegExp/currentLevel': {
+        description: 'Data should be of type number.',
+        units: 'ratio'
+    },
+    '/vessels/*/tanks/freshWater/RegExp/currentVolume': {
+        description: 'Data should be of type number.',
+        units: 'm3'
+    },
+    '/vessels/*/tanks/freshWater/RegExp/pressure': {
+        description: 'Data should be of type number.',
+        units: 'Pa'
+    },
+    '/vessels/*/tanks/freshWater/RegExp/temperature': {
+        description: 'Data should be of type number.',
+        units: 'K'
+    },
+    '/vessels/*/tanks/freshWater/RegExp/viscosity': {
+        description: 'Data should be of type number.',
+        units: 'Pa.s'
+    },
+    '/vessels/*/tanks/freshWater/RegExp/extinguishant': {
+        description: 'The preferred extinguishant to douse a fire in this tank'
+    },
+    '/vessels/*/tanks/wasteWater': {
+        description: 'Waste water tank (grey water)'
+    },
+    '/vessels/*/tanks/wasteWater/RegExp': {
+        description: 'Tank, one or many, within the vessel'
+    },
+    '/vessels/*/tanks/wasteWater/RegExp/name': {
+        description: 'The name of the tank. Useful if multiple tanks of a certain type are on board'
+    },
+    '/vessels/*/tanks/wasteWater/RegExp/type': {
+        description: 'The type of tank',
+        enum: [...TANK_TYPE_ENUM]
+    },
+    '/vessels/*/tanks/wasteWater/RegExp/capacity': {
+        description: 'Data should be of type number.',
+        units: 'm3'
+    },
+    '/vessels/*/tanks/wasteWater/RegExp/currentLevel': {
+        description: 'Data should be of type number.',
+        units: 'ratio'
+    },
+    '/vessels/*/tanks/wasteWater/RegExp/currentVolume': {
+        description: 'Data should be of type number.',
+        units: 'm3'
+    },
+    '/vessels/*/tanks/wasteWater/RegExp/pressure': {
+        description: 'Data should be of type number.',
+        units: 'Pa'
+    },
+    '/vessels/*/tanks/wasteWater/RegExp/temperature': {
+        description: 'Data should be of type number.',
+        units: 'K'
+    },
+    '/vessels/*/tanks/wasteWater/RegExp/viscosity': {
+        description: 'Data should be of type number.',
+        units: 'Pa.s'
+    },
+    '/vessels/*/tanks/wasteWater/RegExp/extinguishant': {
+        description: 'The preferred extinguishant to douse a fire in this tank'
+    },
+    '/vessels/*/tanks/blackWater': {
+        description: 'Black water tank (sewage)'
+    },
+    '/vessels/*/tanks/blackWater/RegExp': {
+        description: 'Tank, one or many, within the vessel'
+    },
+    '/vessels/*/tanks/blackWater/RegExp/name': {
+        description: 'The name of the tank. Useful if multiple tanks of a certain type are on board'
+    },
+    '/vessels/*/tanks/blackWater/RegExp/type': {
+        description: 'The type of tank',
+        enum: [...TANK_TYPE_ENUM]
+    },
+    '/vessels/*/tanks/blackWater/RegExp/capacity': {
+        description: 'Data should be of type number.',
+        units: 'm3'
+    },
+    '/vessels/*/tanks/blackWater/RegExp/currentLevel': {
+        description: 'Data should be of type number.',
+        units: 'ratio'
+    },
+    '/vessels/*/tanks/blackWater/RegExp/currentVolume': {
+        description: 'Data should be of type number.',
+        units: 'm3'
+    },
+    '/vessels/*/tanks/blackWater/RegExp/pressure': {
+        description: 'Data should be of type number.',
+        units: 'Pa'
+    },
+    '/vessels/*/tanks/blackWater/RegExp/temperature': {
+        description: 'Data should be of type number.',
+        units: 'K'
+    },
+    '/vessels/*/tanks/blackWater/RegExp/viscosity': {
+        description: 'Data should be of type number.',
+        units: 'Pa.s'
+    },
+    '/vessels/*/tanks/blackWater/RegExp/extinguishant': {
+        description: 'The preferred extinguishant to douse a fire in this tank'
+    },
+    '/vessels/*/tanks/fuel': {
+        description: 'Fuel tank (petrol or diesel)'
+    },
+    '/vessels/*/tanks/fuel/RegExp': {
+        description: 'Tank, one or many, within the vessel'
+    },
+    '/vessels/*/tanks/fuel/RegExp/name': {
+        description: 'The name of the tank. Useful if multiple tanks of a certain type are on board'
+    },
+    '/vessels/*/tanks/fuel/RegExp/type': {
+        description: 'The type of tank',
+        enum: [...TANK_TYPE_ENUM]
+    },
+    '/vessels/*/tanks/fuel/RegExp/capacity': {
+        description: 'Data should be of type number.',
+        units: 'm3'
+    },
+    '/vessels/*/tanks/fuel/RegExp/currentLevel': {
+        description: 'Data should be of type number.',
+        units: 'ratio'
+    },
+    '/vessels/*/tanks/fuel/RegExp/currentVolume': {
+        description: 'Data should be of type number.',
+        units: 'm3'
+    },
+    '/vessels/*/tanks/fuel/RegExp/pressure': {
+        description: 'Data should be of type number.',
+        units: 'Pa'
+    },
+    '/vessels/*/tanks/fuel/RegExp/temperature': {
+        description: 'Data should be of type number.',
+        units: 'K'
+    },
+    '/vessels/*/tanks/fuel/RegExp/viscosity': {
+        description: 'Data should be of type number.',
+        units: 'Pa.s'
+    },
+    '/vessels/*/tanks/fuel/RegExp/extinguishant': {
+        description: 'The preferred extinguishant to douse a fire in this tank'
+    },
+    '/vessels/*/tanks/lubrication': {
+        description: 'Lubrication tank (oil or grease)'
+    },
+    '/vessels/*/tanks/lubrication/RegExp': {
+        description: 'Tank, one or many, within the vessel'
+    },
+    '/vessels/*/tanks/lubrication/RegExp/name': {
+        description: 'The name of the tank. Useful if multiple tanks of a certain type are on board'
+    },
+    '/vessels/*/tanks/lubrication/RegExp/type': {
+        description: 'The type of tank',
+        enum: [...TANK_TYPE_ENUM]
+    },
+    '/vessels/*/tanks/lubrication/RegExp/capacity': {
+        description: 'Data should be of type number.',
+        units: 'm3'
+    },
+    '/vessels/*/tanks/lubrication/RegExp/currentLevel': {
+        description: 'Data should be of type number.',
+        units: 'ratio'
+    },
+    '/vessels/*/tanks/lubrication/RegExp/currentVolume': {
+        description: 'Data should be of type number.',
+        units: 'm3'
+    },
+    '/vessels/*/tanks/lubrication/RegExp/pressure': {
+        description: 'Data should be of type number.',
+        units: 'Pa'
+    },
+    '/vessels/*/tanks/lubrication/RegExp/temperature': {
+        description: 'Data should be of type number.',
+        units: 'K'
+    },
+    '/vessels/*/tanks/lubrication/RegExp/viscosity': {
+        description: 'Data should be of type number.',
+        units: 'Pa.s'
+    },
+    '/vessels/*/tanks/lubrication/RegExp/extinguishant': {
+        description: 'The preferred extinguishant to douse a fire in this tank'
+    },
+    '/vessels/*/tanks/liveWell': {
+        description: 'Live tank (fish)'
+    },
+    '/vessels/*/tanks/liveWell/RegExp': {
+        description: 'Tank, one or many, within the vessel'
+    },
+    '/vessels/*/tanks/liveWell/RegExp/name': {
+        description: 'The name of the tank. Useful if multiple tanks of a certain type are on board'
+    },
+    '/vessels/*/tanks/liveWell/RegExp/type': {
+        description: 'The type of tank',
+        enum: [...TANK_TYPE_ENUM]
+    },
+    '/vessels/*/tanks/liveWell/RegExp/capacity': {
+        description: 'Data should be of type number.',
+        units: 'm3'
+    },
+    '/vessels/*/tanks/liveWell/RegExp/currentLevel': {
+        description: 'Data should be of type number.',
+        units: 'ratio'
+    },
+    '/vessels/*/tanks/liveWell/RegExp/currentVolume': {
+        description: 'Data should be of type number.',
+        units: 'm3'
+    },
+    '/vessels/*/tanks/liveWell/RegExp/pressure': {
+        description: 'Data should be of type number.',
+        units: 'Pa'
+    },
+    '/vessels/*/tanks/liveWell/RegExp/temperature': {
+        description: 'Data should be of type number.',
+        units: 'K'
+    },
+    '/vessels/*/tanks/liveWell/RegExp/viscosity': {
+        description: 'Data should be of type number.',
+        units: 'Pa.s'
+    },
+    '/vessels/*/tanks/liveWell/RegExp/extinguishant': {
+        description: 'The preferred extinguishant to douse a fire in this tank'
+    },
+    '/vessels/*/tanks/baitWell': {
+        description: 'Bait tank'
+    },
+    '/vessels/*/tanks/baitWell/RegExp': {
+        description: 'Tank, one or many, within the vessel'
+    },
+    '/vessels/*/tanks/baitWell/RegExp/name': {
+        description: 'The name of the tank. Useful if multiple tanks of a certain type are on board'
+    },
+    '/vessels/*/tanks/baitWell/RegExp/type': {
+        description: 'The type of tank',
+        enum: [...TANK_TYPE_ENUM]
+    },
+    '/vessels/*/tanks/baitWell/RegExp/capacity': {
+        description: 'Data should be of type number.',
+        units: 'm3'
+    },
+    '/vessels/*/tanks/baitWell/RegExp/currentLevel': {
+        description: 'Data should be of type number.',
+        units: 'ratio'
+    },
+    '/vessels/*/tanks/baitWell/RegExp/currentVolume': {
+        description: 'Data should be of type number.',
+        units: 'm3'
+    },
+    '/vessels/*/tanks/baitWell/RegExp/pressure': {
+        description: 'Data should be of type number.',
+        units: 'Pa'
+    },
+    '/vessels/*/tanks/baitWell/RegExp/temperature': {
+        description: 'Data should be of type number.',
+        units: 'K'
+    },
+    '/vessels/*/tanks/baitWell/RegExp/viscosity': {
+        description: 'Data should be of type number.',
+        units: 'Pa.s'
+    },
+    '/vessels/*/tanks/baitWell/RegExp/extinguishant': {
+        description: 'The preferred extinguishant to douse a fire in this tank'
+    },
+    '/vessels/*/tanks/gas': {
+        description: 'Lpg/propane and other gases'
+    },
+    '/vessels/*/tanks/gas/RegExp': {
+        description: 'Tank, one or many, within the vessel'
+    },
+    '/vessels/*/tanks/gas/RegExp/name': {
+        description: 'The name of the tank. Useful if multiple tanks of a certain type are on board'
+    },
+    '/vessels/*/tanks/gas/RegExp/type': {
+        description: 'The type of tank',
+        enum: [...TANK_TYPE_ENUM]
+    },
+    '/vessels/*/tanks/gas/RegExp/capacity': {
+        description: 'Data should be of type number.',
+        units: 'm3'
+    },
+    '/vessels/*/tanks/gas/RegExp/currentLevel': {
+        description: 'Data should be of type number.',
+        units: 'ratio'
+    },
+    '/vessels/*/tanks/gas/RegExp/currentVolume': {
+        description: 'Data should be of type number.',
+        units: 'm3'
+    },
+    '/vessels/*/tanks/gas/RegExp/pressure': {
+        description: 'Data should be of type number.',
+        units: 'Pa'
+    },
+    '/vessels/*/tanks/gas/RegExp/temperature': {
+        description: 'Data should be of type number.',
+        units: 'K'
+    },
+    '/vessels/*/tanks/gas/RegExp/viscosity': {
+        description: 'Data should be of type number.',
+        units: 'Pa.s'
+    },
+    '/vessels/*/tanks/gas/RegExp/extinguishant': {
+        description: 'The preferred extinguishant to douse a fire in this tank'
+    },
+    '/vessels/*/tanks/ballast': {
+        description: 'Ballast tanks'
+    },
+    '/vessels/*/tanks/ballast/RegExp': {
+        description: 'Tank, one or many, within the vessel'
+    },
+    '/vessels/*/tanks/ballast/RegExp/name': {
+        description: 'The name of the tank. Useful if multiple tanks of a certain type are on board'
+    },
+    '/vessels/*/tanks/ballast/RegExp/type': {
+        description: 'The type of tank',
+        enum: [...TANK_TYPE_ENUM]
+    },
+    '/vessels/*/tanks/ballast/RegExp/capacity': {
+        description: 'Data should be of type number.',
+        units: 'm3'
+    },
+    '/vessels/*/tanks/ballast/RegExp/currentLevel': {
+        description: 'Data should be of type number.',
+        units: 'ratio'
+    },
+    '/vessels/*/tanks/ballast/RegExp/currentVolume': {
+        description: 'Data should be of type number.',
+        units: 'm3'
+    },
+    '/vessels/*/tanks/ballast/RegExp/pressure': {
+        description: 'Data should be of type number.',
+        units: 'Pa'
+    },
+    '/vessels/*/tanks/ballast/RegExp/temperature': {
+        description: 'Data should be of type number.',
+        units: 'K'
+    },
+    '/vessels/*/tanks/ballast/RegExp/viscosity': {
+        description: 'Data should be of type number.',
+        units: 'Pa.s'
+    },
+    '/vessels/*/tanks/ballast/RegExp/extinguishant': {
+        description: 'The preferred extinguishant to douse a fire in this tank'
+    }
+};
+//# sourceMappingURL=tanks.js.map

package/dist/tanks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tanks.js","sourceRoot":"","sources":["../src/tanks.ts"],"names":[],"mappings":";;;AAEA,oEAAoE;AACpE,0EAA0E;AAC1E,yEAAyE;AACzE,4BAA4B;AAC5B,MAAM,cAAc,GAAG;IACrB,QAAQ;IACR,aAAa;IACb,WAAW;IACX,YAAY;IACZ,SAAS;IACT,KAAK;IACL,QAAQ;IACR,UAAU;IACV,UAAU;IACV,SAAS;IACT,KAAK;CACG,CAAA;AAEG,QAAA,aAAa,GAAsC;IAC9D,kBAAkB,EAAE;QAClB,WAAW,EACT,oEAAoE;KACvE;IACD,6BAA6B,EAAE;QAC7B,WAAW,EAAE,6BAA6B;KAC3C;IACD,oCAAoC,EAAE;QACpC,WAAW,EAAE,sCAAsC;KACpD;IACD,yCAAyC,EAAE;QACzC,WAAW,EACT,+EAA+E;KAClF;IACD,yCAAyC,EAAE;QACzC,WAAW,EAAE,kBAAkB;QAC/B,IAAI,EAAE,CAAC,GAAG,cAAc,CAAC;KAC1B;IACD,6CAA6C,EAAE;QAC7C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,iDAAiD,EAAE;QACjD,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,OAAO;KACf;IACD,kDAAkD,EAAE;QAClD,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,6CAA6C,EAAE;QAC7C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,gDAAgD,EAAE;QAChD,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,GAAG;KACX;IACD,8CAA8C,EAAE;QAC9C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,MAAM;KACd;IACD,kDAAkD,EAAE;QAClD,WAAW,EAAE,0DAA0D;KACxE;IACD,6BAA6B,EAAE;QAC7B,WAAW,EAAE,+BAA+B;KAC7C;IACD,oCAAoC,EAAE;QACpC,WAAW,EAAE,sCAAsC;KACpD;IACD,yCAAyC,EAAE;QACzC,WAAW,EACT,+EAA+E;KAClF;IACD,yCAAyC,EAAE;QACzC,WAAW,EAAE,kBAAkB;QAC/B,IAAI,EAAE,CAAC,GAAG,cAAc,CAAC;KAC1B;IACD,6CAA6C,EAAE;QAC7C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,iDAAiD,EAAE;QACjD,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,OAAO;KACf;IACD,kDAAkD,EAAE;QAClD,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,6CAA6C,EAAE;QAC7C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,gDAAgD,EAAE;QAChD,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,GAAG;KACX;IACD,8CAA8C,EAAE;QAC9C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,MAAM;KACd;IACD,kDAAkD,EAAE;QAClD,WAAW,EAAE,0DAA0D;KACxE;IACD,6BAA6B,EAAE;QAC7B,WAAW,EAAE,2BAA2B;KACzC;IACD,oCAAoC,EAAE;QACpC,WAAW,EAAE,sCAAsC;KACpD;IACD,yCAAyC,EAAE;QACzC,WAAW,EACT,+EAA+E;KAClF;IACD,yCAAyC,EAAE;QACzC,WAAW,EAAE,kBAAkB;QAC/B,IAAI,EAAE,CAAC,GAAG,cAAc,CAAC;KAC1B;IACD,6CAA6C,EAAE;QAC7C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,iDAAiD,EAAE;QACjD,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,OAAO;KACf;IACD,kDAAkD,EAAE;QAClD,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,6CAA6C,EAAE;QAC7C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,gDAAgD,EAAE;QAChD,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,GAAG;KACX;IACD,8CAA8C,EAAE;QAC9C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,MAAM;KACd;IACD,kDAAkD,EAAE;QAClD,WAAW,EAAE,0DAA0D;KACxE;IACD,uBAAuB,EAAE;QACvB,WAAW,EAAE,8BAA8B;KAC5C;IACD,8BAA8B,EAAE;QAC9B,WAAW,EAAE,sCAAsC;KACpD;IACD,mCAAmC,EAAE;QACnC,WAAW,EACT,+EAA+E;KAClF;IACD,mCAAmC,EAAE;QACnC,WAAW,EAAE,kBAAkB;QAC/B,IAAI,EAAE,CAAC,GAAG,cAAc,CAAC;KAC1B;IACD,uCAAuC,EAAE;QACvC,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,2CAA2C,EAAE;QAC3C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,OAAO;KACf;IACD,4CAA4C,EAAE;QAC5C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,uCAAuC,EAAE;QACvC,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,0CAA0C,EAAE;QAC1C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,GAAG;KACX;IACD,wCAAwC,EAAE;QACxC,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,MAAM;KACd;IACD,4CAA4C,EAAE;QAC5C,WAAW,EAAE,0DAA0D;KACxE;IACD,8BAA8B,EAAE;QAC9B,WAAW,EAAE,kCAAkC;KAChD;IACD,qCAAqC,EAAE;QACrC,WAAW,EAAE,sCAAsC;KACpD;IACD,0CAA0C,EAAE;QAC1C,WAAW,EACT,+EAA+E;KAClF;IACD,0CAA0C,EAAE;QAC1C,WAAW,EAAE,kBAAkB;QAC/B,IAAI,EAAE,CAAC,GAAG,cAAc,CAAC;KAC1B;IACD,8CAA8C,EAAE;QAC9C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,kDAAkD,EAAE;QAClD,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,OAAO;KACf;IACD,mDAAmD,EAAE;QACnD,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,8CAA8C,EAAE;QAC9C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,iDAAiD,EAAE;QACjD,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,GAAG;KACX;IACD,+CAA+C,EAAE;QAC/C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,MAAM;KACd;IACD,mDAAmD,EAAE;QACnD,WAAW,EAAE,0DAA0D;KACxE;IACD,2BAA2B,EAAE;QAC3B,WAAW,EAAE,kBAAkB;KAChC;IACD,kCAAkC,EAAE;QAClC,WAAW,EAAE,sCAAsC;KACpD;IACD,uCAAuC,EAAE;QACvC,WAAW,EACT,+EAA+E;KAClF;IACD,uCAAuC,EAAE;QACvC,WAAW,EAAE,kBAAkB;QAC/B,IAAI,EAAE,CAAC,GAAG,cAAc,CAAC;KAC1B;IACD,2CAA2C,EAAE;QAC3C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,+CAA+C,EAAE;QAC/C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,OAAO;KACf;IACD,gDAAgD,EAAE;QAChD,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,2CAA2C,EAAE;QAC3C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,8CAA8C,EAAE;QAC9C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,GAAG;KACX;IACD,4CAA4C,EAAE;QAC5C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,MAAM;KACd;IACD,gDAAgD,EAAE;QAChD,WAAW,EAAE,0DAA0D;KACxE;IACD,2BAA2B,EAAE;QAC3B,WAAW,EAAE,WAAW;KACzB;IACD,kCAAkC,EAAE;QAClC,WAAW,EAAE,sCAAsC;KACpD;IACD,uCAAuC,EAAE;QACvC,WAAW,EACT,+EAA+E;KAClF;IACD,uCAAuC,EAAE;QACvC,WAAW,EAAE,kBAAkB;QAC/B,IAAI,EAAE,CAAC,GAAG,cAAc,CAAC;KAC1B;IACD,2CAA2C,EAAE;QAC3C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,+CAA+C,EAAE;QAC/C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,OAAO;KACf;IACD,gDAAgD,EAAE;QAChD,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,2CAA2C,EAAE;QAC3C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,8CAA8C,EAAE;QAC9C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,GAAG;KACX;IACD,4CAA4C,EAAE;QAC5C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,MAAM;KACd;IACD,gDAAgD,EAAE;QAChD,WAAW,EAAE,0DAA0D;KACxE;IACD,sBAAsB,EAAE;QACtB,WAAW,EAAE,6BAA6B;KAC3C;IACD,6BAA6B,EAAE;QAC7B,WAAW,EAAE,sCAAsC;KACpD;IACD,kCAAkC,EAAE;QAClC,WAAW,EACT,+EAA+E;KAClF;IACD,kCAAkC,EAAE;QAClC,WAAW,EAAE,kBAAkB;QAC/B,IAAI,EAAE,CAAC,GAAG,cAAc,CAAC;KAC1B;IACD,sCAAsC,EAAE;QACtC,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,0CAA0C,EAAE;QAC1C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,OAAO;KACf;IACD,2CAA2C,EAAE;QAC3C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,sCAAsC,EAAE;QACtC,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,yCAAyC,EAAE;QACzC,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,GAAG;KACX;IACD,uCAAuC,EAAE;QACvC,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,MAAM;KACd;IACD,2CAA2C,EAAE;QAC3C,WAAW,EAAE,0DAA0D;KACxE;IACD,0BAA0B,EAAE;QAC1B,WAAW,EAAE,eAAe;KAC7B;IACD,iCAAiC,EAAE;QACjC,WAAW,EAAE,sCAAsC;KACpD;IACD,sCAAsC,EAAE;QACtC,WAAW,EACT,+EAA+E;KAClF;IACD,sCAAsC,EAAE;QACtC,WAAW,EAAE,kBAAkB;QAC/B,IAAI,EAAE,CAAC,GAAG,cAAc,CAAC;KAC1B;IACD,0CAA0C,EAAE;QAC1C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,8CAA8C,EAAE;QAC9C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,OAAO;KACf;IACD,+CAA+C,EAAE;QAC/C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,0CAA0C,EAAE;QAC1C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,IAAI;KACZ;IACD,6CAA6C,EAAE;QAC7C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,GAAG;KACX;IACD,2CAA2C,EAAE;QAC3C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,MAAM;KACd;IACD,+CAA+C,EAAE;QAC/C,WAAW,EAAE,0DAA0D;KACxE;CACF,CAAA"}

package/dist/types.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Path metadata types for the Signal K data model.
+ */
+/** Metadata associated with a Signal K well-known path. */
+export interface PathMetadataEntry {
+    description: string;
+    units?: string;
+    enum?: ReadonlyArray<{
+        id: number;
+        name: string;
+    } | string>;
+    properties?: Record<string, {
+        type?: string;
+        description?: string;
+        units?: string;
+        example?: number | string;
+        title?: string;
+        default?: string | number | boolean;
+        enum?: ReadonlyArray<{
+            id: number;
+            name: string;
+        } | string>;
+        items?: Record<string, any>;
+    }>;
+    /** Runtime metadata (zones, displayUnits, etc.) added via meta deltas or PUT. */
+    [key: string]: unknown;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,2DAA2D;AAC3D,MAAM,WAAW,iBAAiB;IAChC,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,aAAa,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM,CAAC,CAAA;IAC3D,UAAU,CAAC,EAAE,MAAM,CACjB,MAAM,EACN;QACE,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;QACzB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;QACnC,IAAI,CAAC,EAAE,aAAa,CAAC;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,GAAG,MAAM,CAAC,CAAA;QAE3D,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAC5B,CACF,CAAA;IACD,iFAAiF;IACjF,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB"}

package/dist/types.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * Path metadata types for the Signal K data model.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

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