@signalk/path-metadata 0.1.0

package/dist/performance.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.performanceMetadata = void 0;
+exports.performanceMetadata = {
+    '/vessels/*/performance': {
+        description: 'Performance Sailing data including VMG, Polar Speed, tack angle, etc.'
+    },
+    '/vessels/*/performance/polars': {
+        description: 'Polar objects'
+    },
+    '/vessels/*/performance/polars/RegExp': {
+        description: '[missing]'
+    },
+    '/vessels/*/performance/polars/RegExp/id': {
+        description: '[missing]'
+    },
+    '/vessels/*/performance/polars/RegExp/name': {
+        description: '[missing]'
+    },
+    '/vessels/*/performance/polars/RegExp/description': {
+        description: '[missing]'
+    },
+    '/vessels/*/performance/polars/RegExp/windData': {
+        description: '[missing]'
+    },
+    '/vessels/*/performance/activePolar': {
+        description: 'The UUID of the active polar table'
+    },
+    '/vessels/*/performance/activePolarData': {
+        description: "The 'polar' object belonging to the selected 'activePolar'"
+    },
+    '/vessels/*/performance/activePolarData/id': {
+        description: '[missing]'
+    },
+    '/vessels/*/performance/activePolarData/name': {
+        description: '[missing]'
+    },
+    '/vessels/*/performance/activePolarData/description': {
+        description: '[missing]'
+    },
+    '/vessels/*/performance/activePolarData/windData': {
+        description: '[missing]'
+    },
+    '/vessels/*/performance/polarSpeed': {
+        description: 'Data should be of type number.',
+        units: 'm/s'
+    },
+    '/vessels/*/performance/polarSpeedRatio': {
+        description: 'Data should be of type number.',
+        units: 'ratio'
+    },
+    '/vessels/*/performance/velocityMadeGood': {
+        description: 'Data should be of type number.',
+        units: 'm/s'
+    },
+    '/vessels/*/performance/velocityMadeGoodToWaypoint': {
+        description: 'Data should be of type number.',
+        units: 'm/s'
+    },
+    '/vessels/*/performance/beatAngle': {
+        description: 'Data should be of type number.',
+        units: 'rad'
+    },
+    '/vessels/*/performance/beatAngleVelocityMadeGood': {
+        description: 'Data should be of type number.',
+        units: 'm/s'
+    },
+    '/vessels/*/performance/beatAngleTargetSpeed': {
+        description: 'Data should be of type number.',
+        units: 'm/s'
+    },
+    '/vessels/*/performance/gybeAngle': {
+        description: 'Data should be of type number.',
+        units: 'rad'
+    },
+    '/vessels/*/performance/gybeAngleVelocityMadeGood': {
+        description: 'Data should be of type number.',
+        units: 'm/s'
+    },
+    '/vessels/*/performance/gybeAngleTargetSpeed': {
+        description: 'Data should be of type number.',
+        units: 'm/s'
+    },
+    '/vessels/*/performance/targetAngle': {
+        description: 'Data should be of type number.',
+        units: 'rad'
+    },
+    '/vessels/*/performance/targetSpeed': {
+        description: 'Data should be of type number.',
+        units: 'm/s'
+    },
+    '/vessels/*/performance/leeway': {
+        description: 'Data should be of type number.',
+        units: 'rad'
+    },
+    '/vessels/*/performance/tackMagnetic': {
+        description: 'Data should be of type number.',
+        units: 'rad'
+    },
+    '/vessels/*/performance/tackTrue': {
+        description: 'Data should be of type number.',
+        units: 'rad'
+    }
+};
+//# sourceMappingURL=performance.js.map

package/dist/performance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"performance.js","sourceRoot":"","sources":["../src/performance.ts"],"names":[],"mappings":";;;AAEa,QAAA,mBAAmB,GAAsC;IACpE,wBAAwB,EAAE;QACxB,WAAW,EACT,uEAAuE;KAC1E;IACD,+BAA+B,EAAE;QAC/B,WAAW,EAAE,eAAe;KAC7B;IACD,sCAAsC,EAAE;QACtC,WAAW,EAAE,WAAW;KACzB;IACD,yCAAyC,EAAE;QACzC,WAAW,EAAE,WAAW;KACzB;IACD,2CAA2C,EAAE;QAC3C,WAAW,EAAE,WAAW;KACzB;IACD,kDAAkD,EAAE;QAClD,WAAW,EAAE,WAAW;KACzB;IACD,+CAA+C,EAAE;QAC/C,WAAW,EAAE,WAAW;KACzB;IACD,oCAAoC,EAAE;QACpC,WAAW,EAAE,oCAAoC;KAClD;IACD,wCAAwC,EAAE;QACxC,WAAW,EAAE,4DAA4D;KAC1E;IACD,2CAA2C,EAAE;QAC3C,WAAW,EAAE,WAAW;KACzB;IACD,6CAA6C,EAAE;QAC7C,WAAW,EAAE,WAAW;KACzB;IACD,oDAAoD,EAAE;QACpD,WAAW,EAAE,WAAW;KACzB;IACD,iDAAiD,EAAE;QACjD,WAAW,EAAE,WAAW;KACzB;IACD,mCAAmC,EAAE;QACnC,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;IACD,wCAAwC,EAAE;QACxC,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,OAAO;KACf;IACD,yCAAyC,EAAE;QACzC,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;IACD,mDAAmD,EAAE;QACnD,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;IACD,kCAAkC,EAAE;QAClC,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;IACD,kDAAkD,EAAE;QAClD,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;IACD,6CAA6C,EAAE;QAC7C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;IACD,kCAAkC,EAAE;QAClC,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;IACD,kDAAkD,EAAE;QAClD,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;IACD,6CAA6C,EAAE;QAC7C,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;IACD,oCAAoC,EAAE;QACpC,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;IACD,oCAAoC,EAAE;QACpC,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;IACD,+BAA+B,EAAE;QAC/B,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;IACD,qCAAqC,EAAE;QACrC,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;IACD,iCAAiC,EAAE;QACjC,WAAW,EAAE,gCAAgC;QAC7C,KAAK,EAAE,KAAK;KACb;CACF,CAAA"}

package/dist/propulsion.d.ts

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

package/dist/propulsion.d.ts.map

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

package/dist/propulsion.js

@@ -0,0 +1,133 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.propulsionMetadata = void 0;
+exports.propulsionMetadata = {
+    '/vessels/*/propulsion': {
+        description: 'Engine data, each engine identified by a unique name i.e. Port_Engine'
+    },
+    '/vessels/*/propulsion/RegExp': {
+        description: 'This regex pattern is used for validation of the identifier for the propulsion unit'
+    },
+    '/vessels/*/propulsion/RegExp/label': {
+        description: 'Human readable label for the propulsion unit'
+    },
+    '/vessels/*/propulsion/RegExp/state': {
+        description: 'The current state of the engine'
+    },
+    '/vessels/*/propulsion/RegExp/revolutions': {
+        description: 'Engine revolutions (x60 for RPM)',
+        units: 'Hz'
+    },
+    '/vessels/*/propulsion/RegExp/temperature': {
+        description: 'Engine temperature',
+        units: 'K'
+    },
+    '/vessels/*/propulsion/RegExp/oilTemperature': {
+        description: 'Oil temperature',
+        units: 'K'
+    },
+    '/vessels/*/propulsion/RegExp/oilPressure': {
+        description: 'Oil pressure',
+        units: 'Pa'
+    },
+    '/vessels/*/propulsion/RegExp/alternatorVoltage': {
+        description: 'Alternator voltage',
+        units: 'V'
+    },
+    '/vessels/*/propulsion/RegExp/runTime': {
+        description: 'Total running time for engine (Engine Hours in seconds)',
+        units: 's'
+    },
+    '/vessels/*/propulsion/RegExp/coolantTemperature': {
+        description: 'Coolant temperature',
+        units: 'K'
+    },
+    '/vessels/*/propulsion/RegExp/coolantPressure': {
+        description: 'Coolant pressure',
+        units: 'Pa'
+    },
+    '/vessels/*/propulsion/RegExp/boostPressure': {
+        description: 'Engine boost (turbo, supercharger) pressure',
+        units: 'Pa'
+    },
+    '/vessels/*/propulsion/RegExp/intakeManifoldTemperature': {
+        description: 'Intake manifold temperature',
+        units: 'K'
+    },
+    '/vessels/*/propulsion/RegExp/engineLoad': {
+        description: 'Engine load ratio, 0<=ratio<=1, 1 is 100%',
+        units: 'ratio'
+    },
+    '/vessels/*/propulsion/RegExp/engineTorque': {
+        description: 'Engine torque ratio, 0<=ratio<=1, 1 is 100%',
+        units: 'ratio'
+    },
+    '/vessels/*/propulsion/RegExp/transmission': {
+        description: 'The transmission (gear box) of the named engine'
+    },
+    '/vessels/*/propulsion/RegExp/transmission/gear': {
+        description: 'Currently selected gear the engine is in i.e. Forward, Reverse, etc.'
+    },
+    '/vessels/*/propulsion/RegExp/transmission/gearRatio': {
+        description: 'Gear ratio, engine rotations per propeller shaft rotation',
+        units: 'ratio'
+    },
+    '/vessels/*/propulsion/RegExp/transmission/oilTemperature': {
+        description: 'Oil temperature',
+        units: 'K'
+    },
+    '/vessels/*/propulsion/RegExp/transmission/oilPressure': {
+        description: 'Oil pressure',
+        units: 'Pa'
+    },
+    '/vessels/*/propulsion/RegExp/drive': {
+        description: "Data about the engine's drive."
+    },
+    '/vessels/*/propulsion/RegExp/drive/type': {
+        description: 'The type of drive the boat has i.e Outboard, shaft, jet, etc.',
+        enum: ['saildrive', 'shaft', 'outboard', 'jet', 'pod', 'other']
+    },
+    '/vessels/*/propulsion/RegExp/drive/trimState': {
+        description: 'Trim/tilt state, 0<=ratio<=1, 1 is 100% up',
+        units: 'ratio'
+    },
+    '/vessels/*/propulsion/RegExp/drive/thrustAngle': {
+        description: 'Current thrust angle for steerable drives, +ve is thrust to Starboard',
+        units: 'rad'
+    },
+    '/vessels/*/propulsion/RegExp/drive/propeller': {
+        description: "Data about the drive's propeller (pitch and slip)"
+    },
+    '/vessels/*/propulsion/RegExp/fuel': {
+        description: "Data about the engine's Fuel Supply"
+    },
+    '/vessels/*/propulsion/RegExp/fuel/type': {
+        description: 'Fuel type',
+        enum: ['diesel', 'petrol', 'electric', 'coal/wood', 'other']
+    },
+    '/vessels/*/propulsion/RegExp/fuel/used': {
+        description: 'Used fuel since last reset. Resetting is at user discretion',
+        units: 'm3'
+    },
+    '/vessels/*/propulsion/RegExp/fuel/pressure': {
+        description: 'Fuel pressure',
+        units: 'Pa'
+    },
+    '/vessels/*/propulsion/RegExp/fuel/rate': {
+        description: 'Fuel rate of consumption',
+        units: 'm3/s'
+    },
+    '/vessels/*/propulsion/RegExp/fuel/economyRate': {
+        description: 'Economy fuel rate of consumption',
+        units: 'm3/s'
+    },
+    '/vessels/*/propulsion/RegExp/fuel/averageRate': {
+        description: 'Average fuel rate of consumption',
+        units: 'm3/s'
+    },
+    '/vessels/*/propulsion/RegExp/exhaustTemperature': {
+        description: 'Exhaust temperature',
+        units: 'K'
+    }
+};
+//# sourceMappingURL=propulsion.js.map

package/dist/propulsion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"propulsion.js","sourceRoot":"","sources":["../src/propulsion.ts"],"names":[],"mappings":";;;AAEa,QAAA,kBAAkB,GAAsC;IACnE,uBAAuB,EAAE;QACvB,WAAW,EACT,uEAAuE;KAC1E;IACD,8BAA8B,EAAE;QAC9B,WAAW,EACT,qFAAqF;KACxF;IACD,oCAAoC,EAAE;QACpC,WAAW,EAAE,8CAA8C;KAC5D;IACD,oCAAoC,EAAE;QACpC,WAAW,EAAE,iCAAiC;KAC/C;IACD,0CAA0C,EAAE;QAC1C,WAAW,EAAE,kCAAkC;QAC/C,KAAK,EAAE,IAAI;KACZ;IACD,0CAA0C,EAAE;QAC1C,WAAW,EAAE,oBAAoB;QACjC,KAAK,EAAE,GAAG;KACX;IACD,6CAA6C,EAAE;QAC7C,WAAW,EAAE,iBAAiB;QAC9B,KAAK,EAAE,GAAG;KACX;IACD,0CAA0C,EAAE;QAC1C,WAAW,EAAE,cAAc;QAC3B,KAAK,EAAE,IAAI;KACZ;IACD,gDAAgD,EAAE;QAChD,WAAW,EAAE,oBAAoB;QACjC,KAAK,EAAE,GAAG;KACX;IACD,sCAAsC,EAAE;QACtC,WAAW,EAAE,yDAAyD;QACtE,KAAK,EAAE,GAAG;KACX;IACD,iDAAiD,EAAE;QACjD,WAAW,EAAE,qBAAqB;QAClC,KAAK,EAAE,GAAG;KACX;IACD,8CAA8C,EAAE;QAC9C,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,IAAI;KACZ;IACD,4CAA4C,EAAE;QAC5C,WAAW,EAAE,6CAA6C;QAC1D,KAAK,EAAE,IAAI;KACZ;IACD,wDAAwD,EAAE;QACxD,WAAW,EAAE,6BAA6B;QAC1C,KAAK,EAAE,GAAG;KACX;IACD,yCAAyC,EAAE;QACzC,WAAW,EAAE,2CAA2C;QACxD,KAAK,EAAE,OAAO;KACf;IACD,2CAA2C,EAAE;QAC3C,WAAW,EAAE,6CAA6C;QAC1D,KAAK,EAAE,OAAO;KACf;IACD,2CAA2C,EAAE;QAC3C,WAAW,EAAE,iDAAiD;KAC/D;IACD,gDAAgD,EAAE;QAChD,WAAW,EACT,sEAAsE;KACzE;IACD,qDAAqD,EAAE;QACrD,WAAW,EAAE,2DAA2D;QACxE,KAAK,EAAE,OAAO;KACf;IACD,0DAA0D,EAAE;QAC1D,WAAW,EAAE,iBAAiB;QAC9B,KAAK,EAAE,GAAG;KACX;IACD,uDAAuD,EAAE;QACvD,WAAW,EAAE,cAAc;QAC3B,KAAK,EAAE,IAAI;KACZ;IACD,oCAAoC,EAAE;QACpC,WAAW,EAAE,gCAAgC;KAC9C;IACD,yCAAyC,EAAE;QACzC,WAAW,EACT,+DAA+D;QACjE,IAAI,EAAE,CAAC,WAAW,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC;KAChE;IACD,8CAA8C,EAAE;QAC9C,WAAW,EAAE,4CAA4C;QACzD,KAAK,EAAE,OAAO;KACf;IACD,gDAAgD,EAAE;QAChD,WAAW,EACT,uEAAuE;QACzE,KAAK,EAAE,KAAK;KACb;IACD,8CAA8C,EAAE;QAC9C,WAAW,EAAE,mDAAmD;KACjE;IACD,mCAAmC,EAAE;QACnC,WAAW,EAAE,qCAAqC;KACnD;IACD,wCAAwC,EAAE;QACxC,WAAW,EAAE,WAAW;QACxB,IAAI,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,WAAW,EAAE,OAAO,CAAC;KAC7D;IACD,wCAAwC,EAAE;QACxC,WAAW,EAAE,6DAA6D;QAC1E,KAAK,EAAE,IAAI;KACZ;IACD,4CAA4C,EAAE;QAC5C,WAAW,EAAE,eAAe;QAC5B,KAAK,EAAE,IAAI;KACZ;IACD,wCAAwC,EAAE;QACxC,WAAW,EAAE,0BAA0B;QACvC,KAAK,EAAE,MAAM;KACd;IACD,+CAA+C,EAAE;QAC/C,WAAW,EAAE,kCAAkC;QAC/C,KAAK,EAAE,MAAM;KACd;IACD,+CAA+C,EAAE;QAC/C,WAAW,EAAE,kCAAkC;QAC/C,KAAK,EAAE,MAAM;KACd;IACD,iDAAiD,EAAE;QACjD,WAAW,EAAE,qBAAqB;QAClC,KAAK,EAAE,GAAG;KACX;CACF,CAAA"}

package/dist/registrations.d.ts

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

package/dist/registrations.d.ts.map

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

package/dist/registrations.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registrationsMetadata = void 0;
+exports.registrationsMetadata = {
+    '/vessels/*/registrations': {
+        description: 'The various registrations of the vessel.'
+    },
+    '/vessels/*/registrations/imo': {
+        description: 'The IMO number of the vessel.'
+    },
+    '/vessels/*/registrations/national': {
+        description: 'The national registration number of the vessel.'
+    },
+    '/vessels/*/registrations/national/RegExp': {
+        description: 'This regex pattern is used for validating the identifier for the registration'
+    },
+    '/vessels/*/registrations/national/RegExp/country': {
+        description: 'The ISO 3166-2 country code.'
+    },
+    '/vessels/*/registrations/national/RegExp/registration': {
+        description: 'The registration code'
+    },
+    '/vessels/*/registrations/national/RegExp/description': {
+        description: 'The registration description'
+    },
+    '/vessels/*/registrations/local': {
+        description: 'A local or state registration number of the vessel.'
+    },
+    '/vessels/*/registrations/local/RegExp': {
+        description: 'This regex pattern is used for validating the identifier for the registration'
+    },
+    '/vessels/*/registrations/local/RegExp/registration': {
+        description: 'The registration code'
+    },
+    '/vessels/*/registrations/local/RegExp/description': {
+        description: 'The registration description'
+    },
+    '/vessels/*/registrations/other': {
+        description: 'Other registration or permits for the vessel.'
+    },
+    '/vessels/*/registrations/other/RegExp': {
+        description: 'This regex pattern is used for validating the identifier for the registration'
+    },
+    '/vessels/*/registrations/other/RegExp/registration': {
+        description: 'The registration code'
+    },
+    '/vessels/*/registrations/other/RegExp/description': {
+        description: 'The registration description'
+    }
+};
+//# sourceMappingURL=registrations.js.map

package/dist/registrations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registrations.js","sourceRoot":"","sources":["../src/registrations.ts"],"names":[],"mappings":";;;AAEa,QAAA,qBAAqB,GAAsC;IACtE,0BAA0B,EAAE;QAC1B,WAAW,EAAE,0CAA0C;KACxD;IACD,8BAA8B,EAAE;QAC9B,WAAW,EAAE,+BAA+B;KAC7C;IACD,mCAAmC,EAAE;QACnC,WAAW,EAAE,iDAAiD;KAC/D;IACD,0CAA0C,EAAE;QAC1C,WAAW,EACT,+EAA+E;KAClF;IACD,kDAAkD,EAAE;QAClD,WAAW,EAAE,8BAA8B;KAC5C;IACD,uDAAuD,EAAE;QACvD,WAAW,EAAE,uBAAuB;KACrC;IACD,sDAAsD,EAAE;QACtD,WAAW,EAAE,8BAA8B;KAC5C;IACD,gCAAgC,EAAE;QAChC,WAAW,EAAE,qDAAqD;KACnE;IACD,uCAAuC,EAAE;QACvC,WAAW,EACT,+EAA+E;KAClF;IACD,oDAAoD,EAAE;QACpD,WAAW,EAAE,uBAAuB;KACrC;IACD,mDAAmD,EAAE;QACnD,WAAW,EAAE,8BAA8B;KAC5C;IACD,gCAAgC,EAAE;QAChC,WAAW,EAAE,+CAA+C;KAC7D;IACD,uCAAuC,EAAE;QACvC,WAAW,EACT,+EAA+E;KAClF;IACD,oDAAoD,EAAE;QACpD,WAAW,EAAE,uBAAuB;KACrC;IACD,mDAAmD,EAAE;QACnD,WAAW,EAAE,8BAA8B;KAC5C;CACF,CAAA"}

package/dist/root.d.ts

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

package/dist/root.d.ts.map

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

package/dist/root.js

@@ -0,0 +1,284 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rootMetadata = void 0;
+exports.rootMetadata = {
+    '/self': {
+        description: "This holds the context (prefix + UUID, MMSI or URL in dot notation) of the server's self object."
+    },
+    '/vessels': {
+        description: 'A wrapper object for vessel objects, each describing vessels in range, including this vessel.'
+    },
+    '/vessels/*': {
+        description: 'This regex pattern is used for validation of an MMSI or Signal K UUID identifier for the vessel. Examples: urn:mrn:imo:mmsi:230099999 urn:mrn:signalk:uuid:c0d79334-4e25-4245-8892-54e8ccc8021d'
+    },
+    '/vessels/*/url': {
+        description: 'URL based identity of the vessel, if available.'
+    },
+    '/vessels/*/mmsi': {
+        description: 'MMSI number of the vessel, if available.'
+    },
+    '/vessels/*/mothershipMmsi': {
+        description: 'MMSI number of the mothership of this vessel, if available.'
+    },
+    '/vessels/*/uuid': {
+        description: 'A unique Signal K flavoured maritime resource identifier, assigned by the server.'
+    },
+    '/vessels/*/name': {
+        description: 'The common name of the vessel'
+    },
+    '/vessels/*/flag': {
+        description: 'The country of ship registration, or flag state of the vessel'
+    },
+    '/vessels/*/port': {
+        description: 'The home port of the vessel'
+    },
+    '/aircraft': {
+        description: 'A wrapper object for aircraft, primarily intended for SAR aircraft in relation to marine search and rescue. For clarity about seaplanes etc, if it CAN fly, its an aircraft.'
+    },
+    '/aircraft/*': {
+        description: 'This regex pattern is used for validation of an MMSI or Signal K UUID identifier for the aircraft. Examples: urn:mrn:imo:mmsi:111099999 urn:mrn:signalk:uuid:c0d79334-4e25-4245-8892-54e8ccc8021d'
+    },
+    '/aton': {
+        description: "A wrapper object for Aids to Navigation (aton's)"
+    },
+    '/aton/*': {
+        description: 'This regex pattern is used for validation of an MMSI or Signal K UUID identifier for the aid to navigation. Examples: urn:mrn:imo:mmsi:991099999 urn:mrn:signalk:uuid:c0d79334-4e25-4245-8892-54e8ccc8021d'
+    },
+    '/sar': {
+        description: "A wrapper object for Search And Rescue (SAR) MMSI's used in transponders. MOB, EPIRBS etc"
+    },
+    '/sar/*': {
+        description: 'This regex pattern is used for validation of an MMSI or Signal K UUID identifier for SAR transponders. Examples: urn:mrn:imo:mmsi:972099999 urn:mrn:signalk:uuid:c0d79334-4e25-4245-8892-54e8ccc8021d'
+    },
+    '/resources': {
+        description: 'Resources to aid in navigation and operation of the vessel including waypoints, routes, notes, etc.'
+    },
+    '/resources/charts': {
+        description: 'A holder for charts, each named with their chart code'
+    },
+    '/resources/charts/*': {
+        description: 'A chart'
+    },
+    '/resources/charts/*/name': {
+        description: 'Chart common name'
+    },
+    '/resources/charts/*/identifier': {
+        description: 'Chart number'
+    },
+    '/resources/charts/*/description': {
+        description: 'A description of the chart'
+    },
+    '/resources/charts/*/tilemapUrl': {
+        description: 'A url to the tilemap of the chart for use in TMS chartplotting apps'
+    },
+    '/resources/charts/*/region': {
+        description: 'Region related to note. A pointer to a region UUID. Alternative to geohash'
+    },
+    '/resources/charts/*/geohash': {
+        description: 'Position related to chart. Alternative to region'
+    },
+    '/resources/charts/*/chartUrl': {
+        description: "A url to the chart file's storage location"
+    },
+    '/resources/charts/*/scale': {
+        description: 'The scale of the chart, the larger number from 1:200000'
+    },
+    '/resources/charts/*/chartLayers': {
+        description: 'If the chart format is WMS, the layers enabled for the chart.'
+    },
+    '/resources/charts/*/bounds': {
+        description: "The bounds of the chart. An array containing the position of the upper left corner, and the lower right corner. Useful when the chart isn't inherently geo-referenced."
+    },
+    '/resources/charts/*/chartFormat': {
+        description: 'The format of the chart',
+        enum: [
+            'gif',
+            'geotiff',
+            'kap',
+            'png',
+            'jpg',
+            'kml',
+            'wkt',
+            'topojson',
+            'geojson',
+            'gpx',
+            'tms',
+            'wms',
+            'S-57',
+            'S-63',
+            'svg',
+            'other'
+        ]
+    },
+    '/resources/routes': {
+        description: 'A holder for routes, each named with a UUID'
+    },
+    '/resources/routes/*': {
+        description: 'A route, named with a UUID'
+    },
+    '/resources/routes/*/name': {
+        description: "Route's common name"
+    },
+    '/resources/routes/*/description': {
+        description: 'A description of the route'
+    },
+    '/resources/routes/*/distance': {
+        description: 'Total distance from start to end',
+        units: 'm'
+    },
+    '/resources/routes/*/start': {
+        description: 'The waypoint UUID at the start of the route'
+    },
+    '/resources/routes/*/end': {
+        description: 'The waypoint UUID at the end of the route'
+    },
+    '/resources/routes/*/feature': {
+        description: 'A Geo JSON feature object which describes the route between the waypoints'
+    },
+    '/resources/routes/*/feature/type': {
+        description: '[missing]',
+        enum: ['Feature']
+    },
+    '/resources/routes/*/feature/geometry': {
+        description: '[missing]'
+    },
+    '/resources/routes/*/feature/geometry/type': {
+        description: '[missing]',
+        enum: ['LineString']
+    },
+    '/resources/routes/*/feature/geometry/coordinates': {
+        description: 'An array of two or more positions'
+    },
+    '/resources/routes/*/feature/properties': {
+        description: 'Additional data of any type'
+    },
+    '/resources/routes/*/feature/id': {
+        description: '[missing]'
+    },
+    '/resources/notes': {
+        description: 'A holder for notes about regions, each named with a UUID. Notes might include navigation or cruising info, images, or anything'
+    },
+    '/resources/notes/*': {
+        description: 'A note about a region, named with a UUID. Notes might include navigation or cruising info, images, or anything'
+    },
+    '/resources/notes/*/title': {
+        description: "Note's common name"
+    },
+    '/resources/notes/*/description': {
+        description: 'A textual description of the note'
+    },
+    '/resources/notes/*/region': {
+        description: 'Region related to note. A pointer to a region UUID. Alternative to position or geohash'
+    },
+    '/resources/notes/*/position': {
+        description: 'Position related to note. Alternative to region or geohash',
+        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'
+            }
+        }
+    },
+    '/resources/notes/*/geohash': {
+        description: 'Position related to note. Alternative to region or position'
+    },
+    '/resources/notes/*/mimeType': {
+        description: 'MIME type of the note'
+    },
+    '/resources/notes/*/url': {
+        description: 'Location of the note'
+    },
+    '/resources/regions': {
+        description: 'A holder for regions, each named with UUID'
+    },
+    '/resources/regions/*': {
+        description: 'A region of interest, each named with a UUID'
+    },
+    '/resources/regions/*/geohash': {
+        description: 'geohash of the approximate boundary of this region'
+    },
+    '/resources/regions/*/feature': {
+        description: 'A Geo JSON feature object which describes the regions boundary'
+    },
+    '/resources/regions/*/feature/type': {
+        description: '[missing]',
+        enum: ['Feature']
+    },
+    '/resources/regions/*/feature/geometry': {
+        description: '[missing]'
+    },
+    '/resources/regions/*/feature/properties': {
+        description: 'Additional data of any type'
+    },
+    '/resources/regions/*/feature/id': {
+        description: '[missing]'
+    },
+    '/resources/waypoints': {
+        description: 'A holder for waypoints, each named with a UUID'
+    },
+    '/resources/waypoints/*': {
+        description: 'A waypoint, named with a UUID'
+    },
+    '/resources/waypoints/*/position': {
+        description: 'The position in 3 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'
+            }
+        }
+    },
+    '/resources/waypoints/*/feature': {
+        description: 'A Geo JSON feature object'
+    },
+    '/resources/waypoints/*/feature/type': {
+        description: '[missing]',
+        enum: ['Feature']
+    },
+    '/resources/waypoints/*/feature/geometry': {
+        description: '[missing]'
+    },
+    '/resources/waypoints/*/feature/geometry/type': {
+        description: '[missing]',
+        enum: ['Point']
+    },
+    '/resources/waypoints/*/feature/geometry/coordinates': {
+        description: 'A single position, in x,y order (Lon, Lat)'
+    },
+    '/resources/waypoints/*/feature/properties': {
+        description: 'Additional data of any type'
+    },
+    '/resources/waypoints/*/feature/id': {
+        description: '[missing]'
+    },
+    '/version': {
+        description: 'Version of the schema and APIs that this data is using in Canonical format i.e. V1.5.0.'
+    }
+};
+//# sourceMappingURL=root.js.map

package/dist/root.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"root.js","sourceRoot":"","sources":["../src/root.ts"],"names":[],"mappings":";;;AAEa,QAAA,YAAY,GAAsC;IAC7D,OAAO,EAAE;QACP,WAAW,EACT,kGAAkG;KACrG;IACD,UAAU,EAAE;QACV,WAAW,EACT,+FAA+F;KAClG;IACD,YAAY,EAAE;QACZ,WAAW,EACT,iMAAiM;KACpM;IACD,gBAAgB,EAAE;QAChB,WAAW,EAAE,iDAAiD;KAC/D;IACD,iBAAiB,EAAE;QACjB,WAAW,EAAE,0CAA0C;KACxD;IACD,2BAA2B,EAAE;QAC3B,WAAW,EAAE,6DAA6D;KAC3E;IACD,iBAAiB,EAAE;QACjB,WAAW,EACT,mFAAmF;KACtF;IACD,iBAAiB,EAAE;QACjB,WAAW,EAAE,+BAA+B;KAC7C;IACD,iBAAiB,EAAE;QACjB,WAAW,EAAE,+DAA+D;KAC7E;IACD,iBAAiB,EAAE;QACjB,WAAW,EAAE,6BAA6B;KAC3C;IACD,WAAW,EAAE;QACX,WAAW,EACT,8KAA8K;KACjL;IACD,aAAa,EAAE;QACb,WAAW,EACT,mMAAmM;KACtM;IACD,OAAO,EAAE;QACP,WAAW,EAAE,kDAAkD;KAChE;IACD,SAAS,EAAE;QACT,WAAW,EACT,4MAA4M;KAC/M;IACD,MAAM,EAAE;QACN,WAAW,EACT,2FAA2F;KAC9F;IACD,QAAQ,EAAE;QACR,WAAW,EACT,uMAAuM;KAC1M;IACD,YAAY,EAAE;QACZ,WAAW,EACT,qGAAqG;KACxG;IACD,mBAAmB,EAAE;QACnB,WAAW,EAAE,uDAAuD;KACrE;IACD,qBAAqB,EAAE;QACrB,WAAW,EAAE,SAAS;KACvB;IACD,0BAA0B,EAAE;QAC1B,WAAW,EAAE,mBAAmB;KACjC;IACD,gCAAgC,EAAE;QAChC,WAAW,EAAE,cAAc;KAC5B;IACD,iCAAiC,EAAE;QACjC,WAAW,EAAE,4BAA4B;KAC1C;IACD,gCAAgC,EAAE;QAChC,WAAW,EACT,qEAAqE;KACxE;IACD,4BAA4B,EAAE;QAC5B,WAAW,EACT,4EAA4E;KAC/E;IACD,6BAA6B,EAAE;QAC7B,WAAW,EAAE,kDAAkD;KAChE;IACD,8BAA8B,EAAE;QAC9B,WAAW,EAAE,4CAA4C;KAC1D;IACD,2BAA2B,EAAE;QAC3B,WAAW,EAAE,yDAAyD;KACvE;IACD,iCAAiC,EAAE;QACjC,WAAW,EAAE,+DAA+D;KAC7E;IACD,4BAA4B,EAAE;QAC5B,WAAW,EACT,wKAAwK;KAC3K;IACD,iCAAiC,EAAE;QACjC,WAAW,EAAE,yBAAyB;QACtC,IAAI,EAAE;YACJ,KAAK;YACL,SAAS;YACT,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,KAAK;YACL,UAAU;YACV,SAAS;YACT,KAAK;YACL,KAAK;YACL,KAAK;YACL,MAAM;YACN,MAAM;YACN,KAAK;YACL,OAAO;SACR;KACF;IACD,mBAAmB,EAAE;QACnB,WAAW,EAAE,6CAA6C;KAC3D;IACD,qBAAqB,EAAE;QACrB,WAAW,EAAE,4BAA4B;KAC1C;IACD,0BAA0B,EAAE;QAC1B,WAAW,EAAE,qBAAqB;KACnC;IACD,iCAAiC,EAAE;QACjC,WAAW,EAAE,4BAA4B;KAC1C;IACD,8BAA8B,EAAE;QAC9B,WAAW,EAAE,kCAAkC;QAC/C,KAAK,EAAE,GAAG;KACX;IACD,2BAA2B,EAAE;QAC3B,WAAW,EAAE,6CAA6C;KAC3D;IACD,yBAAyB,EAAE;QACzB,WAAW,EAAE,2CAA2C;KACzD;IACD,6BAA6B,EAAE;QAC7B,WAAW,EACT,2EAA2E;KAC9E;IACD,kCAAkC,EAAE;QAClC,WAAW,EAAE,WAAW;QACxB,IAAI,EAAE,CAAC,SAAS,CAAC;KAClB;IACD,sCAAsC,EAAE;QACtC,WAAW,EAAE,WAAW;KACzB;IACD,2CAA2C,EAAE;QAC3C,WAAW,EAAE,WAAW;QACxB,IAAI,EAAE,CAAC,YAAY,CAAC;KACrB;IACD,kDAAkD,EAAE;QAClD,WAAW,EAAE,mCAAmC;KACjD;IACD,wCAAwC,EAAE;QACxC,WAAW,EAAE,6BAA6B;KAC3C;IACD,gCAAgC,EAAE;QAChC,WAAW,EAAE,WAAW;KACzB;IACD,kBAAkB,EAAE;QAClB,WAAW,EACT,gIAAgI;KACnI;IACD,oBAAoB,EAAE;QACpB,WAAW,EACT,gHAAgH;KACnH;IACD,0BAA0B,EAAE;QAC1B,WAAW,EAAE,oBAAoB;KAClC;IACD,gCAAgC,EAAE;QAChC,WAAW,EAAE,mCAAmC;KACjD;IACD,2BAA2B,EAAE;QAC3B,WAAW,EACT,wFAAwF;KAC3F;IACD,6BAA6B,EAAE;QAC7B,WAAW,EAAE,4DAA4D;QACzE,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,4BAA4B,EAAE;QAC5B,WAAW,EAAE,6DAA6D;KAC3E;IACD,6BAA6B,EAAE;QAC7B,WAAW,EAAE,uBAAuB;KACrC;IACD,wBAAwB,EAAE;QACxB,WAAW,EAAE,sBAAsB;KACpC;IACD,oBAAoB,EAAE;QACpB,WAAW,EAAE,4CAA4C;KAC1D;IACD,sBAAsB,EAAE;QACtB,WAAW,EAAE,8CAA8C;KAC5D;IACD,8BAA8B,EAAE;QAC9B,WAAW,EAAE,oDAAoD;KAClE;IACD,8BAA8B,EAAE;QAC9B,WAAW,EACT,gEAAgE;KACnE;IACD,mCAAmC,EAAE;QACnC,WAAW,EAAE,WAAW;QACxB,IAAI,EAAE,CAAC,SAAS,CAAC;KAClB;IACD,uCAAuC,EAAE;QACvC,WAAW,EAAE,WAAW;KACzB;IACD,yCAAyC,EAAE;QACzC,WAAW,EAAE,6BAA6B;KAC3C;IACD,iCAAiC,EAAE;QACjC,WAAW,EAAE,WAAW;KACzB;IACD,sBAAsB,EAAE;QACtB,WAAW,EAAE,gDAAgD;KAC9D;IACD,wBAAwB,EAAE;QACxB,WAAW,EAAE,+BAA+B;KAC7C;IACD,iCAAiC,EAAE;QACjC,WAAW,EAAE,8BAA8B;QAC3C,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,2BAA2B;KACzC;IACD,qCAAqC,EAAE;QACrC,WAAW,EAAE,WAAW;QACxB,IAAI,EAAE,CAAC,SAAS,CAAC;KAClB;IACD,yCAAyC,EAAE;QACzC,WAAW,EAAE,WAAW;KACzB;IACD,8CAA8C,EAAE;QAC9C,WAAW,EAAE,WAAW;QACxB,IAAI,EAAE,CAAC,OAAO,CAAC;KAChB;IACD,qDAAqD,EAAE;QACrD,WAAW,EAAE,4CAA4C;KAC1D;IACD,2CAA2C,EAAE;QAC3C,WAAW,EAAE,6BAA6B;KAC3C;IACD,mCAAmC,EAAE;QACnC,WAAW,EAAE,WAAW;KACzB;IACD,UAAU,EAAE;QACV,WAAW,EACT,yFAAyF;KAC5F;CACF,CAAA"}

package/dist/sails.d.ts

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

package/dist/sails.d.ts.map

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