@signalk/path-metadata 0.1.0

package/dist/environment.js

@@ -0,0 +1,260 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.environmentMetadata = void 0;
+exports.environmentMetadata = {
+    '/vessels/*/environment': {
+        description: 'Environmental data measured locally including Depth, Wind, Temp, etc.'
+    },
+    '/vessels/*/environment/outside': {
+        description: "Environmental conditions outside of the vessel's hull"
+    },
+    '/vessels/*/environment/outside/temperature': {
+        description: 'Current outside air temperature',
+        units: 'K'
+    },
+    '/vessels/*/environment/outside/dewPointTemperature': {
+        description: 'Current outside dew point temperature',
+        units: 'K'
+    },
+    '/vessels/*/environment/outside/apparentWindChillTemperature': {
+        description: 'Current outside apparent wind chill temperature',
+        units: 'K'
+    },
+    '/vessels/*/environment/outside/theoreticalWindChillTemperature': {
+        description: 'Current outside theoretical wind chill temperature',
+        units: 'K'
+    },
+    '/vessels/*/environment/outside/heatIndexTemperature': {
+        description: 'Current outside heat index temperature',
+        units: 'K'
+    },
+    '/vessels/*/environment/outside/pressure': {
+        description: 'Current outside air ambient pressure',
+        units: 'Pa'
+    },
+    '/vessels/*/environment/outside/humidity': {
+        description: 'DEPRECATED: use relativeHumidity',
+        units: 'ratio'
+    },
+    '/vessels/*/environment/outside/relativeHumidity': {
+        description: 'Current outside air relative humidity',
+        units: 'ratio'
+    },
+    '/vessels/*/environment/outside/airDensity': {
+        description: 'Current outside air density',
+        units: 'kg/m3'
+    },
+    '/vessels/*/environment/outside/illuminance': {
+        description: 'Current outside ambient light flux.',
+        units: 'Lux'
+    },
+    '/vessels/*/environment/inside': {
+        description: "Environmental conditions inside the vessel's hull"
+    },
+    '/vessels/*/environment/inside/temperature': {
+        description: 'Temperature',
+        units: 'K'
+    },
+    '/vessels/*/environment/inside/heatIndexTemperature': {
+        description: 'Current heat index temperature in zone',
+        units: 'K'
+    },
+    '/vessels/*/environment/inside/pressure': {
+        description: 'Pressure in zone',
+        units: 'Pa'
+    },
+    '/vessels/*/environment/inside/relativeHumidity': {
+        description: 'Relative humidity in zone',
+        units: 'ratio'
+    },
+    '/vessels/*/environment/inside/dewPoint': {
+        description: 'DEPRECATED: use dewPointTemperature',
+        units: 'K'
+    },
+    '/vessels/*/environment/inside/dewPointTemperature': {
+        description: 'Dewpoint in zone',
+        units: 'K'
+    },
+    '/vessels/*/environment/inside/airDensity': {
+        description: 'Air density in zone',
+        units: 'kg/m3'
+    },
+    '/vessels/*/environment/inside/illuminance': {
+        description: 'Illuminance in zone',
+        units: 'Lux'
+    },
+    '/vessels/*/environment/inside/[A-Za-z0-9]+': {
+        description: 'This regex pattern is used for validation of the identifier for the environmental zone, eg. engineRoom, mainCabin, refrigerator'
+    },
+    '/vessels/*/environment/inside/[A-Za-z0-9]+/temperature': {
+        description: 'Temperature',
+        units: 'K'
+    },
+    '/vessels/*/environment/inside/[A-Za-z0-9]+/heatIndexTemperature': {
+        description: 'Current heat index temperature in zone',
+        units: 'K'
+    },
+    '/vessels/*/environment/inside/[A-Za-z0-9]+/pressure': {
+        description: 'Pressure in zone',
+        units: 'Pa'
+    },
+    '/vessels/*/environment/inside/[A-Za-z0-9]+/relativeHumidity': {
+        description: 'Relative humidity in zone',
+        units: 'ratio'
+    },
+    '/vessels/*/environment/inside/[A-Za-z0-9]+/dewPoint': {
+        description: 'DEPRECATED: use dewPointTemperature',
+        units: 'K'
+    },
+    '/vessels/*/environment/inside/[A-Za-z0-9]+/dewPointTemperature': {
+        description: 'Dewpoint in zone',
+        units: 'K'
+    },
+    '/vessels/*/environment/inside/[A-Za-z0-9]+/airDensity': {
+        description: 'Air density in zone',
+        units: 'kg/m3'
+    },
+    '/vessels/*/environment/inside/[A-Za-z0-9]+/illuminance': {
+        description: 'Illuminance in zone',
+        units: 'Lux'
+    },
+    '/vessels/*/environment/water': {
+        description: 'Environmental conditions of the water that the vessel is sailing in'
+    },
+    '/vessels/*/environment/water/temperature': {
+        description: 'Current water temperature',
+        units: 'K'
+    },
+    '/vessels/*/environment/water/salinity': {
+        description: 'Water salinity',
+        units: 'ratio'
+    },
+    '/vessels/*/environment/depth': {
+        description: 'Depth related data'
+    },
+    '/vessels/*/environment/depth/belowKeel': {
+        description: 'Depth below keel',
+        units: 'm'
+    },
+    '/vessels/*/environment/depth/belowTransducer': {
+        description: 'Depth below Transducer',
+        units: 'm'
+    },
+    '/vessels/*/environment/depth/belowSurface': {
+        description: 'Depth from surface',
+        units: 'm'
+    },
+    '/vessels/*/environment/depth/transducerToKeel': {
+        description: 'Depth from the transducer to the bottom of the keel',
+        units: 'm'
+    },
+    '/vessels/*/environment/depth/surfaceToTransducer': {
+        description: 'Depth transducer is below the water surface',
+        units: 'm'
+    },
+    '/vessels/*/environment/current': {
+        description: 'Direction and strength of current affecting the vessel',
+        properties: {
+            drift: {
+                type: 'number',
+                description: 'The speed component of the water current vector',
+                example: 3.12,
+                units: 'm/s'
+            },
+            setTrue: {
+                type: 'number',
+                description: 'The direction component of the water current vector referenced to true (geographic) north',
+                example: 2.155,
+                units: 'rad'
+            },
+            setMagnetic: {
+                type: 'number',
+                description: 'The direction component of the water current vector referenced to magnetic north',
+                example: 2.29,
+                units: 'rad'
+            }
+        }
+    },
+    '/vessels/*/environment/tide': {
+        description: 'Tide data'
+    },
+    '/vessels/*/environment/tide/heightHigh': {
+        description: 'Next high tide height  relative to lowest astronomical tide (LAT/Chart Datum)',
+        units: 'm'
+    },
+    '/vessels/*/environment/tide/heightNow': {
+        description: 'The current tide height  relative to lowest astronomical tide (LAT/Chart Datum)',
+        units: 'm'
+    },
+    '/vessels/*/environment/tide/heightLow': {
+        description: 'The next low tide height relative to lowest astronomical tide (LAT/Chart Datum)',
+        units: 'm'
+    },
+    '/vessels/*/environment/tide/timeLow': {
+        description: 'RFC 3339 (UTC only without local offset) string representing date and time.',
+        units: 'RFC 3339 (UTC)'
+    },
+    '/vessels/*/environment/tide/timeHigh': {
+        description: 'RFC 3339 (UTC only without local offset) string representing date and time.',
+        units: 'RFC 3339 (UTC)'
+    },
+    '/vessels/*/environment/heave': {
+        description: 'Vertical movement of the vessel due to waves',
+        units: 'm'
+    },
+    '/vessels/*/environment/wind': {
+        description: 'Wind data.'
+    },
+    '/vessels/*/environment/wind/angleApparent': {
+        description: 'Apparent wind angle, negative to port',
+        units: 'rad'
+    },
+    '/vessels/*/environment/wind/angleTrueGround': {
+        description: 'True wind angle based on speed over ground, negative to port',
+        units: 'rad'
+    },
+    '/vessels/*/environment/wind/angleTrueWater': {
+        description: 'True wind angle based on speed through water, negative to port',
+        units: 'rad'
+    },
+    '/vessels/*/environment/wind/directionChangeAlarm': {
+        description: 'The angle the wind needs to shift to raise an alarm',
+        units: 'rad'
+    },
+    '/vessels/*/environment/wind/directionTrue': {
+        description: 'The wind direction relative to true north',
+        units: 'rad'
+    },
+    '/vessels/*/environment/wind/directionMagnetic': {
+        description: 'The wind direction relative to magnetic north',
+        units: 'rad'
+    },
+    '/vessels/*/environment/wind/speedTrue': {
+        description: "Wind speed over water (as calculated from speedApparent and vessel's speed through water)",
+        units: 'm/s'
+    },
+    '/vessels/*/environment/wind/speedOverGround': {
+        description: "Wind speed over ground (as calculated from speedApparent and vessel's speed over ground)",
+        units: 'm/s'
+    },
+    '/vessels/*/environment/wind/speedApparent': {
+        description: 'Apparent wind speed',
+        units: 'm/s'
+    },
+    '/vessels/*/environment/time': {
+        description: 'A time reference for the vessel. All clocks on the vessel dispaying local time should use the timezone offset here. If a timezoneRegion is supplied the timezone must also be supplied. If timezoneRegion is supplied that should be displayed by UIs in preference to simply timezone. ie 12:05 (Europe/London) should be displayed in preference to 12:05 (UTC+01:00)'
+    },
+    '/vessels/*/environment/time/millis': {
+        description: 'Milliseconds since the UNIX epoch (1970-01-01 00:00:00)'
+    },
+    '/vessels/*/environment/time/timezoneOffset': {
+        description: 'Onboard timezone offset from UTC in hours and minutes (-)hhmm. +ve means east of Greenwich. For use by UIs'
+    },
+    '/vessels/*/environment/time/timezoneRegion': {
+        description: 'Onboard timezone offset as listed in the IANA timezone database (tz database)'
+    },
+    '/vessels/*/environment/mode': {
+        description: 'Mode of the vessel based on the current conditions. Can be combined with navigation.state to control vessel signals eg switch to night mode for instrumentation and lights, or make sound signals for fog.'
+    }
+};
+//# sourceMappingURL=environment.js.map

package/dist/environment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"environment.js","sourceRoot":"","sources":["../src/environment.ts"],"names":[],"mappings":";;;AAEa,QAAA,mBAAmB,GAAsC;IACpE,wBAAwB,EAAE;QACxB,WAAW,EACT,uEAAuE;KAC1E;IACD,gCAAgC,EAAE;QAChC,WAAW,EAAE,uDAAuD;KACrE;IACD,4CAA4C,EAAE;QAC5C,WAAW,EAAE,iCAAiC;QAC9C,KAAK,EAAE,GAAG;KACX;IACD,oDAAoD,EAAE;QACpD,WAAW,EAAE,uCAAuC;QACpD,KAAK,EAAE,GAAG;KACX;IACD,6DAA6D,EAAE;QAC7D,WAAW,EAAE,iDAAiD;QAC9D,KAAK,EAAE,GAAG;KACX;IACD,gEAAgE,EAAE;QAChE,WAAW,EAAE,oDAAoD;QACjE,KAAK,EAAE,GAAG;KACX;IACD,qDAAqD,EAAE;QACrD,WAAW,EAAE,wCAAwC;QACrD,KAAK,EAAE,GAAG;KACX;IACD,yCAAyC,EAAE;QACzC,WAAW,EAAE,sCAAsC;QACnD,KAAK,EAAE,IAAI;KACZ;IACD,yCAAyC,EAAE;QACzC,WAAW,EAAE,kCAAkC;QAC/C,KAAK,EAAE,OAAO;KACf;IACD,iDAAiD,EAAE;QACjD,WAAW,EAAE,uCAAuC;QACpD,KAAK,EAAE,OAAO;KACf;IACD,2CAA2C,EAAE;QAC3C,WAAW,EAAE,6BAA6B;QAC1C,KAAK,EAAE,OAAO;KACf;IACD,4CAA4C,EAAE;QAC5C,WAAW,EAAE,qCAAqC;QAClD,KAAK,EAAE,KAAK;KACb;IACD,+BAA+B,EAAE;QAC/B,WAAW,EAAE,mDAAmD;KACjE;IACD,2CAA2C,EAAE;QAC3C,WAAW,EAAE,aAAa;QAC1B,KAAK,EAAE,GAAG;KACX;IACD,oDAAoD,EAAE;QACpD,WAAW,EAAE,wCAAwC;QACrD,KAAK,EAAE,GAAG;KACX;IACD,wCAAwC,EAAE;QACxC,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,IAAI;KACZ;IACD,gDAAgD,EAAE;QAChD,WAAW,EAAE,2BAA2B;QACxC,KAAK,EAAE,OAAO;KACf;IACD,wCAAwC,EAAE;QACxC,WAAW,EAAE,qCAAqC;QAClD,KAAK,EAAE,GAAG;KACX;IACD,mDAAmD,EAAE;QACnD,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,GAAG;KACX;IACD,0CAA0C,EAAE;QAC1C,WAAW,EAAE,qBAAqB;QAClC,KAAK,EAAE,OAAO;KACf;IACD,2CAA2C,EAAE;QAC3C,WAAW,EAAE,qBAAqB;QAClC,KAAK,EAAE,KAAK;KACb;IACD,4CAA4C,EAAE;QAC5C,WAAW,EACT,iIAAiI;KACpI;IACD,wDAAwD,EAAE;QACxD,WAAW,EAAE,aAAa;QAC1B,KAAK,EAAE,GAAG;KACX;IACD,iEAAiE,EAAE;QACjE,WAAW,EAAE,wCAAwC;QACrD,KAAK,EAAE,GAAG;KACX;IACD,qDAAqD,EAAE;QACrD,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,IAAI;KACZ;IACD,6DAA6D,EAAE;QAC7D,WAAW,EAAE,2BAA2B;QACxC,KAAK,EAAE,OAAO;KACf;IACD,qDAAqD,EAAE;QACrD,WAAW,EAAE,qCAAqC;QAClD,KAAK,EAAE,GAAG;KACX;IACD,gEAAgE,EAAE;QAChE,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,GAAG;KACX;IACD,uDAAuD,EAAE;QACvD,WAAW,EAAE,qBAAqB;QAClC,KAAK,EAAE,OAAO;KACf;IACD,wDAAwD,EAAE;QACxD,WAAW,EAAE,qBAAqB;QAClC,KAAK,EAAE,KAAK;KACb;IACD,8BAA8B,EAAE;QAC9B,WAAW,EACT,qEAAqE;KACxE;IACD,0CAA0C,EAAE;QAC1C,WAAW,EAAE,2BAA2B;QACxC,KAAK,EAAE,GAAG;KACX;IACD,uCAAuC,EAAE;QACvC,WAAW,EAAE,gBAAgB;QAC7B,KAAK,EAAE,OAAO;KACf;IACD,8BAA8B,EAAE;QAC9B,WAAW,EAAE,oBAAoB;KAClC;IACD,wCAAwC,EAAE;QACxC,WAAW,EAAE,kBAAkB;QAC/B,KAAK,EAAE,GAAG;KACX;IACD,8CAA8C,EAAE;QAC9C,WAAW,EAAE,wBAAwB;QACrC,KAAK,EAAE,GAAG;KACX;IACD,2CAA2C,EAAE;QAC3C,WAAW,EAAE,oBAAoB;QACjC,KAAK,EAAE,GAAG;KACX;IACD,+CAA+C,EAAE;QAC/C,WAAW,EAAE,qDAAqD;QAClE,KAAK,EAAE,GAAG;KACX;IACD,kDAAkD,EAAE;QAClD,WAAW,EAAE,6CAA6C;QAC1D,KAAK,EAAE,GAAG;KACX;IACD,gCAAgC,EAAE;QAChC,WAAW,EAAE,wDAAwD;QACrE,UAAU,EAAE;YACV,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,iDAAiD;gBAC9D,OAAO,EAAE,IAAI;gBACb,KAAK,EAAE,KAAK;aACb;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,2FAA2F;gBAC7F,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,KAAK;aACb;YACD,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,kFAAkF;gBACpF,OAAO,EAAE,IAAI;gBACb,KAAK,EAAE,KAAK;aACb;SACF;KACF;IACD,6BAA6B,EAAE;QAC7B,WAAW,EAAE,WAAW;KACzB;IACD,wCAAwC,EAAE;QACxC,WAAW,EACT,+EAA+E;QACjF,KAAK,EAAE,GAAG;KACX;IACD,uCAAuC,EAAE;QACvC,WAAW,EACT,iFAAiF;QACnF,KAAK,EAAE,GAAG;KACX;IACD,uCAAuC,EAAE;QACvC,WAAW,EACT,iFAAiF;QACnF,KAAK,EAAE,GAAG;KACX;IACD,qCAAqC,EAAE;QACrC,WAAW,EACT,6EAA6E;QAC/E,KAAK,EAAE,gBAAgB;KACxB;IACD,sCAAsC,EAAE;QACtC,WAAW,EACT,6EAA6E;QAC/E,KAAK,EAAE,gBAAgB;KACxB;IACD,8BAA8B,EAAE;QAC9B,WAAW,EAAE,8CAA8C;QAC3D,KAAK,EAAE,GAAG;KACX;IACD,6BAA6B,EAAE;QAC7B,WAAW,EAAE,YAAY;KAC1B;IACD,2CAA2C,EAAE;QAC3C,WAAW,EAAE,uCAAuC;QACpD,KAAK,EAAE,KAAK;KACb;IACD,6CAA6C,EAAE;QAC7C,WAAW,EAAE,8DAA8D;QAC3E,KAAK,EAAE,KAAK;KACb;IACD,4CAA4C,EAAE;QAC5C,WAAW,EACT,gEAAgE;QAClE,KAAK,EAAE,KAAK;KACb;IACD,kDAAkD,EAAE;QAClD,WAAW,EAAE,qDAAqD;QAClE,KAAK,EAAE,KAAK;KACb;IACD,2CAA2C,EAAE;QAC3C,WAAW,EAAE,2CAA2C;QACxD,KAAK,EAAE,KAAK;KACb;IACD,+CAA+C,EAAE;QAC/C,WAAW,EAAE,+CAA+C;QAC5D,KAAK,EAAE,KAAK;KACb;IACD,uCAAuC,EAAE;QACvC,WAAW,EACT,2FAA2F;QAC7F,KAAK,EAAE,KAAK;KACb;IACD,6CAA6C,EAAE;QAC7C,WAAW,EACT,0FAA0F;QAC5F,KAAK,EAAE,KAAK;KACb;IACD,2CAA2C,EAAE;QAC3C,WAAW,EAAE,qBAAqB;QAClC,KAAK,EAAE,KAAK;KACb;IACD,6BAA6B,EAAE;QAC7B,WAAW,EACT,yWAAyW;KAC5W;IACD,oCAAoC,EAAE;QACpC,WAAW,EAAE,yDAAyD;KACvE;IACD,4CAA4C,EAAE;QAC5C,WAAW,EACT,4GAA4G;KAC/G;IACD,4CAA4C,EAAE;QAC5C,WAAW,EACT,+EAA+E;KAClF;IACD,6BAA6B,EAAE;QAC7B,WAAW,EACT,4MAA4M;KAC/M;CACF,CAAA"}

package/dist/index.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Signal K Path Metadata Registry
+ *
+ * Provides lookup of well-known path metadata (units, description, enum)
+ * via regex-based matching. Supports runtime additions from meta deltas.
+ */
+import type { PathMetadataEntry } from './types';
+export type { PathMetadataEntry } from './types';
+export { getAISShipTypeName } from './ais-ship-types';
+export { getAtonTypeName } from './aton-types';
+export declare class MetadataRegistry {
+    private allMetadata;
+    private regexEntries;
+    private readonly seedEntries;
+    constructor(entries: Record<string, PathMetadataEntry>);
+    /**
+     * Restore the registry to its construction-time state, dropping any
+     * runtime additions made via addMetaData / internalGetMetadata. Intended
+     * for test isolation; production code should not call this.
+     */
+    reset(): void;
+    /**
+     * Look up metadata for a dot-separated Signal K path.
+     * Returns the metadata entry or undefined if no match.
+     */
+    getMetadata(path: string): PathMetadataEntry | undefined;
+    /**
+     * Get or create a metadata entry for a specific context+path combination.
+     * Used internally by FullSignalK to attach metadata to first-seen values.
+     * If an exact entry doesn't exist, clones the matched pattern entry
+     * so runtime metadata additions don't pollute the template.
+     */
+    internalGetMetadata(path: string): PathMetadataEntry | undefined;
+    /**
+     * Merge runtime metadata into the registry for a specific context+path.
+     * Called when meta deltas are received. Mirrors the @signalk/signalk-schema
+     * v2.25 semantics:
+     *  - If the exact per-path key already exists, merge the new fields in.
+     *  - If it doesn't, seed the new entry from any matching spec (RegExp)
+     *    template so untouched fields (units, enum, etc.) stay intact, then
+     *    merge the plugin's fields on top. The per-path regex goes to the
+     *    FRONT of the lookup array so getMetadata() finds it before the
+     *    generic spec wildcard.
+     */
+    addMetaData(context: string, path: string, meta: Record<string, unknown>): void;
+    /** Return all registered metadata entries (for the /paths endpoint). */
+    getAllMetadata(): Record<string, PathMetadataEntry>;
+}
+export declare const metadataRegistry: MetadataRegistry;
+/** Look up metadata for a dot-separated Signal K path. */
+export declare function getMetadata(path: string): PathMetadataEntry | undefined;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAiBhD,YAAY,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAChD,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAA;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAmF9C,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,WAAW,CAAmC;IACtD,OAAO,CAAC,YAAY,CAAc;IAClC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAmC;gBAEnD,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC;IAMtD;;;;OAIG;IACH,KAAK,IAAI,IAAI;IAKb;;;OAGG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS;IAUxD;;;;;OAKG;IACH,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS;IA0ChE;;;;;;;;;;OAUG;IACH,WAAW,CACT,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,IAAI;IAgCP,wEAAwE;IACxE,cAAc,IAAI,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC;CAGpD;AAOD,eAAO,MAAM,gBAAgB,kBAAmC,CAAA;AAEhE,0DAA0D;AAC1D,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAEvE"}

package/dist/index.js

@@ -0,0 +1,223 @@
+"use strict";
+/**
+ * Signal K Path Metadata Registry
+ *
+ * Provides lookup of well-known path metadata (units, description, enum)
+ * via regex-based matching. Supports runtime additions from meta deltas.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.metadataRegistry = exports.MetadataRegistry = exports.getAtonTypeName = exports.getAISShipTypeName = void 0;
+exports.getMetadata = getMetadata;
+const root_1 = require("./root");
+const navigation_1 = require("./navigation");
+const environment_1 = require("./environment");
+const electrical_1 = require("./electrical");
+const tanks_1 = require("./tanks");
+const propulsion_1 = require("./propulsion");
+const performance_1 = require("./performance");
+const sails_1 = require("./sails");
+const steering_1 = require("./steering");
+const design_1 = require("./design");
+const registrations_1 = require("./registrations");
+const communication_1 = require("./communication");
+const sensors_1 = require("./sensors");
+const notifications_1 = require("./notifications");
+var ais_ship_types_1 = require("./ais-ship-types");
+Object.defineProperty(exports, "getAISShipTypeName", { enumerable: true, get: function () { return ais_ship_types_1.getAISShipTypeName; } });
+var aton_types_1 = require("./aton-types");
+Object.defineProperty(exports, "getAtonTypeName", { enumerable: true, get: function () { return aton_types_1.getAtonTypeName; } });
+const vesselMetadata = {
+    ...navigation_1.navigationMetadata,
+    ...environment_1.environmentMetadata,
+    ...electrical_1.electricalMetadata,
+    ...tanks_1.tanksMetadata,
+    ...propulsion_1.propulsionMetadata,
+    ...performance_1.performanceMetadata,
+    ...sails_1.sailsMetadata,
+    ...steering_1.steeringMetadata,
+    ...design_1.designMetadata,
+    ...registrations_1.registrationsMetadata,
+    ...communication_1.communicationMetadata,
+    ...sensors_1.sensorsMetadata,
+    ...notifications_1.notificationsMetadata
+};
+/**
+ * Expand /vessels/* paths to also cover /aircraft/*, /aton/*, /sar/*
+ * since they share the same data model structure.
+ */
+function expandContextPrefixes(entries) {
+    const expanded = {};
+    for (const [key, value] of Object.entries(entries)) {
+        expanded[key] = value;
+        if (key.startsWith('/vessels/*/')) {
+            const suffix = key.slice('/vessels/*/'.length);
+            expanded[`/aircraft/*/${suffix}`] = value;
+            expanded[`/aton/*/${suffix}`] = value;
+            expanded[`/sar/*/${suffix}`] = value;
+        }
+    }
+    return expanded;
+}
+function buildRegexArray(allEntries) {
+    const result = [];
+    for (const [key, metadata] of Object.entries(allEntries)) {
+        // Convert path wildcards to regex: * → [^/]+ and RegExp → [^/]+
+        const pattern = key
+            .replace(/\*/g, '[^/]+')
+            .replace(/RegExp/g, '[^/]+')
+            .replace(/\(([^)]+)\)/g, '($1)'); // preserve regex groups like (single)|([A-C])
+        // Skip entries whose key ends in a bare wildcard. These are container
+        // shapes (e.g. /vessels/*/electrical/ac/RegExp defines "an AC bus",
+        // not "any child of electrical.ac"). Letting them match would attach
+        // the container description to plugin-invented siblings — matches the
+        // old @signalk/signalk-schema behaviour.
+        if (key.endsWith('/*') || key.endsWith('/RegExp')) {
+            continue;
+        }
+        try {
+            result.push({
+                pattern: new RegExp(`^${pattern}$`),
+                key,
+                metadata
+            });
+        }
+        catch (e) {
+            // A bad metadata key shouldn't take the whole registry down, but
+            // it must be visible so the typo or unescaped regex special
+            // character can be tracked down. The check runs once at module
+            // load over a static set of keys, so warning in production is
+            // both cheap and the only way to catch a bug introduced by a
+            // future schema sync.
+            console.warn(`path-metadata: skipping invalid pattern for key "${key}": ${e.message}`);
+        }
+    }
+    return result;
+}
+class MetadataRegistry {
+    allMetadata;
+    regexEntries;
+    seedEntries;
+    constructor(entries) {
+        this.seedEntries = entries;
+        this.allMetadata = { ...entries };
+        this.regexEntries = buildRegexArray(this.allMetadata);
+    }
+    /**
+     * Restore the registry to its construction-time state, dropping any
+     * runtime additions made via addMetaData / internalGetMetadata. Intended
+     * for test isolation; production code should not call this.
+     */
+    reset() {
+        this.allMetadata = { ...this.seedEntries };
+        this.regexEntries = buildRegexArray(this.allMetadata);
+    }
+    /**
+     * Look up metadata for a dot-separated Signal K path.
+     * Returns the metadata entry or undefined if no match.
+     */
+    getMetadata(path) {
+        const slashPath = '/' + path.replace(/\./g, '/');
+        const result = this.regexEntries.find((entry) => entry.pattern.test(slashPath));
+        return result && result.metadata && Object.keys(result.metadata).length > 0
+            ? result.metadata
+            : undefined;
+    }
+    /**
+     * Get or create a metadata entry for a specific context+path combination.
+     * Used internally by FullSignalK to attach metadata to first-seen values.
+     * If an exact entry doesn't exist, clones the matched pattern entry
+     * so runtime metadata additions don't pollute the template.
+     */
+    internalGetMetadata(path) {
+        const slashPath = '/' + path.replace(/\./g, '/');
+        const parts = path.split('.');
+        // Need at least context root + identity + one path segment to
+        // produce a meaningful per-path key. Anything shorter would yield
+        // keys like "/vessels/*/" that match nothing.
+        if (parts.length < 3) {
+            return undefined;
+        }
+        // Use wildcard key so all identities share the same cloned entry
+        const key = `/${parts[0]}/*/${parts.slice(2).join('/')}`;
+        // Check for existing wildcard entry first
+        if (this.allMetadata[key]) {
+            return this.allMetadata[key];
+        }
+        // Find via regex against the full path
+        const result = this.regexEntries.find((entry) => entry.pattern.test(slashPath));
+        if (!result || Object.keys(result.metadata).length === 0) {
+            return undefined;
+        }
+        // Deep clone the matched entry so runtime additions are per-path.
+        // Spec entries can carry nested objects (displayScale, zones, *Method
+        // arrays) — a shallow clone would share those nested references with
+        // the template, so a plugin tweaking displayScale on one path would
+        // silently change every other path that matches the same wildcard.
+        const cloned = structuredClone(result.metadata);
+        this.allMetadata[key] = cloned;
+        // Escape special chars first, then replace wildcard
+        const escaped = key.replace(/[.+?^${}()|[\]\\]/g, '\\$&');
+        this.regexEntries.push({
+            pattern: new RegExp(`^${escaped.replace(/\*/g, '[^/]+')}$`),
+            key,
+            metadata: cloned
+        });
+        return cloned;
+    }
+    /**
+     * Merge runtime metadata into the registry for a specific context+path.
+     * Called when meta deltas are received. Mirrors the @signalk/signalk-schema
+     * v2.25 semantics:
+     *  - If the exact per-path key already exists, merge the new fields in.
+     *  - If it doesn't, seed the new entry from any matching spec (RegExp)
+     *    template so untouched fields (units, enum, etc.) stay intact, then
+     *    merge the plugin's fields on top. The per-path regex goes to the
+     *    FRONT of the lookup array so getMetadata() finds it before the
+     *    generic spec wildcard.
+     */
+    addMetaData(context, path, meta) {
+        // An empty path would key the entry at "/vessels/*/" (no tail) and
+        // mask every per-vessel entry under the same context root.
+        if (!path) {
+            return;
+        }
+        // Use wildcard key pattern so lookups with any identity match
+        const root = context.split('.')[0];
+        const key = `/${root}/*/${path.replace(/\./g, '/')}`;
+        const existing = this.allMetadata[key];
+        if (existing) {
+            Object.assign(existing, meta);
+            return;
+        }
+        // Seed from the matching spec template, if any, so untouched fields
+        // like units / enum survive when a plugin only updates description.
+        const seed = this.getMetadata(`${context}.${path}`);
+        const entry = { description: '' };
+        if (seed)
+            Object.assign(entry, seed);
+        Object.assign(entry, meta);
+        this.allMetadata[key] = entry;
+        // Escape special chars first, then replace wildcard
+        const escaped = key.replace(/[.+?^${}()|[\]\\]/g, '\\$&');
+        this.regexEntries.unshift({
+            pattern: new RegExp(`^${escaped.replace(/\*/g, '[^/]+')}$`),
+            key,
+            metadata: entry
+        });
+    }
+    /** Return all registered metadata entries (for the /paths endpoint). */
+    getAllMetadata() {
+        return this.allMetadata;
+    }
+}
+exports.MetadataRegistry = MetadataRegistry;
+const allEntries = expandContextPrefixes({
+    ...root_1.rootMetadata,
+    ...vesselMetadata
+});
+exports.metadataRegistry = new MetadataRegistry(allEntries);
+/** Look up metadata for a dot-separated Signal K path. */
+function getMetadata(path) {
+    return exports.metadataRegistry.getMetadata(path);
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAwPH,kCAEC;AAtPD,iCAAqC;AACrC,6CAAiD;AACjD,+CAAmD;AACnD,6CAAiD;AACjD,mCAAuC;AACvC,6CAAiD;AACjD,+CAAmD;AACnD,mCAAuC;AACvC,yCAA6C;AAC7C,qCAAyC;AACzC,mDAAuD;AACvD,mDAAuD;AACvD,uCAA2C;AAC3C,mDAAuD;AAGvD,mDAAqD;AAA5C,oHAAA,kBAAkB,OAAA;AAC3B,2CAA8C;AAArC,6GAAA,eAAe,OAAA;AAExB,MAAM,cAAc,GAAsC;IACxD,GAAG,+BAAkB;IACrB,GAAG,iCAAmB;IACtB,GAAG,+BAAkB;IACrB,GAAG,qBAAa;IAChB,GAAG,+BAAkB;IACrB,GAAG,iCAAmB;IACtB,GAAG,qBAAa;IAChB,GAAG,2BAAgB;IACnB,GAAG,uBAAc;IACjB,GAAG,qCAAqB;IACxB,GAAG,qCAAqB;IACxB,GAAG,yBAAe;IAClB,GAAG,qCAAqB;CACzB,CAAA;AAED;;;GAGG;AACH,SAAS,qBAAqB,CAC5B,OAA0C;IAE1C,MAAM,QAAQ,GAAsC,EAAE,CAAA;IACtD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACnD,QAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;QACrB,IAAI,GAAG,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;YAClC,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAA;YAC9C,QAAQ,CAAC,eAAe,MAAM,EAAE,CAAC,GAAG,KAAK,CAAA;YACzC,QAAQ,CAAC,WAAW,MAAM,EAAE,CAAC,GAAG,KAAK,CAAA;YACrC,QAAQ,CAAC,UAAU,MAAM,EAAE,CAAC,GAAG,KAAK,CAAA;QACtC,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAA;AACjB,CAAC;AAQD,SAAS,eAAe,CACtB,UAA6C;IAE7C,MAAM,MAAM,GAAiB,EAAE,CAAA;IAC/B,KAAK,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QACzD,gEAAgE;QAChE,MAAM,OAAO,GAAG,GAAG;aAChB,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC;aACvB,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC;aAC3B,OAAO,CAAC,cAAc,EAAE,MAAM,CAAC,CAAA,CAAC,8CAA8C;QACjF,sEAAsE;QACtE,oEAAoE;QACpE,qEAAqE;QACrE,sEAAsE;QACtE,yCAAyC;QACzC,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YAClD,SAAQ;QACV,CAAC;QACD,IAAI,CAAC;YACH,MAAM,CAAC,IAAI,CAAC;gBACV,OAAO,EAAE,IAAI,MAAM,CAAC,IAAI,OAAO,GAAG,CAAC;gBACnC,GAAG;gBACH,QAAQ;aACT,CAAC,CAAA;QACJ,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,iEAAiE;YACjE,4DAA4D;YAC5D,+DAA+D;YAC/D,8DAA8D;YAC9D,6DAA6D;YAC7D,sBAAsB;YACtB,OAAO,CAAC,IAAI,CACV,oDAAoD,GAAG,MAAO,CAAW,CAAC,OAAO,EAAE,CACpF,CAAA;QACH,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAED,MAAa,gBAAgB;IACnB,WAAW,CAAmC;IAC9C,YAAY,CAAc;IACjB,WAAW,CAAmC;IAE/D,YAAY,OAA0C;QACpD,IAAI,CAAC,WAAW,GAAG,OAAO,CAAA;QAC1B,IAAI,CAAC,WAAW,GAAG,EAAE,GAAG,OAAO,EAAE,CAAA;QACjC,IAAI,CAAC,YAAY,GAAG,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IACvD,CAAC;IAED;;;;OAIG;IACH,KAAK;QACH,IAAI,CAAC,WAAW,GAAG,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE,CAAA;QAC1C,IAAI,CAAC,YAAY,GAAG,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IACvD,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,IAAY;QACtB,MAAM,SAAS,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;QAChD,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAC9C,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAC9B,CAAA;QACD,OAAO,MAAM,IAAI,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC;YACzE,CAAC,CAAC,MAAM,CAAC,QAAQ;YACjB,CAAC,CAAC,SAAS,CAAA;IACf,CAAC;IAED;;;;;OAKG;IACH,mBAAmB,CAAC,IAAY;QAC9B,MAAM,SAAS,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;QAChD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAC7B,8DAA8D;QAC9D,kEAAkE;QAClE,8CAA8C;QAC9C,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,OAAO,SAAS,CAAA;QAClB,CAAC;QACD,iEAAiE;QACjE,MAAM,GAAG,GAAG,IAAI,KAAK,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAA;QAExD,0CAA0C;QAC1C,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;QAC9B,CAAC;QAED,uCAAuC;QACvC,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAC9C,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAC9B,CAAA;QACD,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzD,OAAO,SAAS,CAAA;QAClB,CAAC;QAED,kEAAkE;QAClE,sEAAsE;QACtE,qEAAqE;QACrE,oEAAoE;QACpE,mEAAmE;QACnE,MAAM,MAAM,GAAsB,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QAClE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,MAAM,CAAA;QAC9B,oDAAoD;QACpD,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAA;QACzD,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;YACrB,OAAO,EAAE,IAAI,MAAM,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC;YAC3D,GAAG;YACH,QAAQ,EAAE,MAAM;SACjB,CAAC,CAAA;QACF,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CACT,OAAe,EACf,IAAY,EACZ,IAA6B;QAE7B,mEAAmE;QACnE,2DAA2D;QAC3D,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAM;QACR,CAAC;QACD,8DAA8D;QAC9D,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;QAClC,MAAM,GAAG,GAAG,IAAI,IAAI,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAA;QACpD,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;QACtC,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;YAC7B,OAAM;QACR,CAAC;QAED,oEAAoE;QACpE,oEAAoE;QACpE,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,OAAO,IAAI,IAAI,EAAE,CAAC,CAAA;QACnD,MAAM,KAAK,GAAsB,EAAE,WAAW,EAAE,EAAE,EAAE,CAAA;QACpD,IAAI,IAAI;YAAE,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;QACpC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;QAC1B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;QAE7B,oDAAoD;QACpD,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAA;QACzD,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC;YACxB,OAAO,EAAE,IAAI,MAAM,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC;YAC3D,GAAG;YACH,QAAQ,EAAE,KAAK;SAChB,CAAC,CAAA;IACJ,CAAC;IAED,wEAAwE;IACxE,cAAc;QACZ,OAAO,IAAI,CAAC,WAAW,CAAA;IACzB,CAAC;CACF;AAtID,4CAsIC;AAED,MAAM,UAAU,GAAG,qBAAqB,CAAC;IACvC,GAAG,mBAAY;IACf,GAAG,cAAc;CAClB,CAAC,CAAA;AAEW,QAAA,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,UAAU,CAAC,CAAA;AAEhE,0DAA0D;AAC1D,SAAgB,WAAW,CAAC,IAAY;IACtC,OAAO,wBAAgB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;AAC3C,CAAC"}

package/dist/navigation.d.ts

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

package/dist/navigation.d.ts.map

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