@signalk/server-api 2.6.1 → 2.7.0

package/dist/features.d.ts

@@ -0,0 +1,65 @@
+/**
+ * @ignore this is extended by {@link ServerAPI}, no need to document separately
+ */
+export interface Features {
+    /**
+     * Returns the available APIs and Plugins.
+     *
+     * _Example:_
+     * ```javascript
+     * let features = app.getFeatures();
+     *
+     * {
+     *   "apis": [
+     *     "resources","course"
+     *   ],
+     *   "plugins": [
+     *     {
+     *       "id": "anchoralarm",
+     *       "name": "Anchor Alarm",
+     *       "version": "1.13.0",
+     *       "enabled": true
+     *     },
+     *     {
+     *       "id": "autopilot",
+     *       "name": "Autopilot Control",
+     *       "version": "1.4.0",
+     *       "enabled": false
+     *     },
+     *     {
+     *       "id": "sk-to-nmea2000",
+     *       "name": "Signal K to NMEA 2000",
+     *       "version": "2.17.0",
+     *       "enabled": false
+     *     },
+     *     {
+     *       "id": "udp-nmea-sender",
+     *       "name": "UDP NMEA0183 Sender",
+     *       "version": "2.0.0",
+     *       "enabled": false
+     *     }
+     *   ]
+     * }
+     * ```
+     *
+     * @param onlyEnabled
+     * - `undefined` (not provided): list all features
+     * - `true`: list only enabled features
+     * - `false`: list only disabled features
+     */
+    getFeatures(onlyEnabled?: boolean): FeatureInfo;
+}
+/**
+ * Information about the available APIs and Plugins.
+ */
+export interface FeatureInfo {
+    apis: SignalKApiId[];
+    plugins: Array<{
+        id: string;
+        name: string;
+        version: string;
+        enabled: boolean;
+    }>;
+}
+export type SignalKApiId = 'resources' | 'course' | 'history' | 'autopilot' | 'anchor' | 'logbook' | 'historyplayback' | 'historysnapshot';
+//# sourceMappingURL=features.d.ts.map

package/dist/features.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"features.d.ts","sourceRoot":"","sources":["../src/features.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;IACH,WAAW,CAAC,WAAW,CAAC,EAAE,OAAO,GAAG,WAAW,CAAA;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,YAAY,EAAE,CAAA;IACpB,OAAO,EAAE,KAAK,CAAC;QACb,EAAE,EAAE,MAAM,CAAA;QACV,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE,MAAM,CAAA;QACf,OAAO,EAAE,OAAO,CAAA;KACjB,CAAC,CAAA;CACH;AAED,MAAM,MAAM,YAAY,GACpB,WAAW,GACX,QAAQ,GACR,SAAS,GACT,WAAW,GACX,QAAQ,GACR,SAAS,GACT,iBAAiB,GACjB,iBAAiB,CAAA"}

package/dist/features.js

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

package/dist/features.js.map

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

package/dist/index.d.ts

@@ -1,11 +1,26 @@
-/// <reference types="node" />
-import { IRouter } from 'express';
-import { PropertyValuesCallback } from './propertyvalues';
+export * from './plugin';
+export * from './serverapi';
+export * from './deltas';
+export * from './coursetypes';
+export * from './resourcetypes';
+export * from './resourcesapi';
+export * from './features';
+export * from './course';
+export * from './autopilotapi';
+export * from './autopilotapi.guard';
+export * from './propertyvalues';
+export * from './brand';
+export * from './streambundle';
+export * from './subscriptionmanager';
 export interface Position {
     latitude: number;
     longitude: number;
     altitude?: number;
 }
+export interface RelativePositionOrigin {
+    radius: number;
+    position: Position;
+}
 export interface ActionResult {
     state: 'COMPLETED' | 'PENDING' | 'FAILED';
     statusCode: number;
@@ -16,134 +31,4 @@ export declare enum SKVersion {
     v1 = "v1",
     v2 = "v2"
 }
-export type Brand<K, T> = K & {
-    __brand: T;
-};
-export * from './deltas';
-export * from './coursetypes';
-export * from './resourcetypes';
-export * from './resourcesapi';
-export { ResourceProviderRegistry } from './resourcesapi';
-import { ResourceProviderRegistry } from './resourcesapi';
-export * from './autopilotapi';
-import { AutopilotProviderRegistry } from './autopilotapi';
-export { AutopilotProviderRegistry } from './autopilotapi';
-export * from './autopilotapi.guard';
-import { PointDestination, RouteDestination, CourseInfo } from './coursetypes';
-export type SignalKApiId = 'resources' | 'course' | 'history' | 'autopilot' | 'anchor' | 'logbook' | 'historyplayback' | 'historysnapshot';
-export { PropertyValue, PropertyValues, PropertyValuesCallback } from './propertyvalues';
-type Unsubscribe = () => void;
-export interface PropertyValuesEmitter {
-    emitPropertyValue: (name: string, value: any) => void;
-    onPropertyValues: (name: string, cb: PropertyValuesCallback) => Unsubscribe;
-}
-/**
- * This is the API that the server exposes in the app object that
- * is passed in Plugin "constructor" call.
- *
- * INCOMPLETE, work in progress.
- */
-export interface PluginServerApp extends PropertyValuesEmitter, ResourceProviderRegistry, AutopilotProviderRegistry {
-}
-/**
- * This is the API that a [server plugin](https://github.com/SignalK/signalk-server/blob/master/SERVERPLUGINS.md) must implement.
- *
- * Typing is INCOMPLETE.
- */
-export interface Plugin {
-    /**
-     * Used to identify the plugin in the server, for example
-     * when storing the plugin's configuration and in http endpoints.
-     */
-    id: string;
-    /**
-     * Human oriented name for the plugin. This is used in the
-     * server's plugin configuration user interface.
-     */
-    name: string;
-    /**
-     * Called to start the plugin with latest saved configuration. Called
-     * - for enabled (by configuration or by default) plugins during server startup
-     * - after stop() when the configuration of an enabled plugin has been updated
-     * in the admin UI
-     * - when a plugin is Enabled in the admin UI
-     */
-    start: (config: object, restart: (newConfiguration: object) => void) => void;
-    /**
-     * Called to stop the plugin. Called when the user disables the plugin in the admin UI.
-     */
-    stop: () => void;
-    schema: () => object | object;
-    uiSchema?: () => object | object;
-    registerWithRouter?: (router: IRouter) => void;
-    signalKApiRoutes?: (router: IRouter) => IRouter;
-    enabledByDefault?: boolean;
-    getOpenApi?: () => any;
-}
-export type DeltaInputHandler = (delta: object, next: (delta: object) => void) => void;
-export interface Ports {
-    byId: string[];
-    byPath: string[];
-    byOpenPlotter: string[];
-    serialports: any;
-}
-export interface Metadata {
-    units?: string;
-    description?: string;
-}
-export interface FeatureInfo {
-    apis: SignalKApiId[];
-    plugins: Array<{
-        id: string;
-        name: string;
-        version: string;
-        enabled: boolean;
-    }>;
-}
-export interface ServerAPI extends PluginServerApp {
-    getSelfPath: (path: string) => any;
-    getPath: (path: string) => any;
-    getMetadata: (path: string) => Metadata | undefined;
-    putSelfPath: (aPath: string, value: any, updateCb: () => void) => Promise<any>;
-    putPath: (aPath: string, value: number | string | object | boolean, updateCb: (err?: Error) => void, source: string) => Promise<any>;
-    queryRequest: (requestId: string) => Promise<any>;
-    error: (msg: string) => void;
-    debug: (msg: string) => void;
-    registerDeltaInputHandler: (handler: DeltaInputHandler) => void;
-    setPluginStatus: (msg: string) => void;
-    setPluginError: (msg: string) => void;
-    handleMessage: (id: string, msg: any, skVersion?: SKVersion) => void;
-    savePluginOptions: (configuration: object, cb: (err: NodeJS.ErrnoException | null) => void) => void;
-    readPluginOptions: () => object;
-    getDataDirPath: () => string;
-    registerPutHandler: (context: string, path: string, callback: () => void, source: string) => void;
-    registerActionHandler: (context: string, path: string, callback: () => void, source: string) => void;
-    registerHistoryProvider: (provider: {
-        hasAnydata: (options: object, cb: (hasResults: boolean) => void) => void;
-        getHistory: (date: Date, path: string, cb: (deltas: object[]) => void) => void;
-        streamHistory: (spark: any, options: object, onDelta: (delta: object) => void) => void;
-    }) => void;
-    getSerialPorts: () => Promise<Ports>;
-    getFeatures: () => FeatureInfo;
-    getCourse: () => Promise<CourseInfo>;
-    clearDestination: () => Promise<void>;
-    setDestination: (dest: (PointDestination & {
-        arrivalCircle?: number;
-    }) | null) => Promise<void>;
-    activateRoute: (dest: RouteDestination | null) => Promise<void>;
-    /**
-     * A plugin can report that it has handled output messages. This will
-     * update the output message rate and icon in the Dashboard.
-     *
-     * This is for traffic that the plugin is sending outside the server,
-     * for example network packets, http calls or messages sent to
-     * a broker. This should NOT be used for deltas that the plugin
-     * sends with handleMessage, they are reported as input from the
-     * server's perspective.
-     *
-     * @param count optional count of handled messages between the last
-     * call and this one. If omitted the call will count as one output
-     * message.
-     */
-    reportOutputMessages: (count?: number) => void;
-}
+//# 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,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,UAAU,CAAA;AACxB,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,gBAAgB,CAAA;AAC9B,cAAc,sBAAsB,CAAA;AACpC,cAAc,kBAAkB,CAAA;AAChC,cAAc,SAAS,CAAA;AACvB,cAAc,gBAAgB,CAAA;AAC9B,cAAc,uBAAuB,CAAA;AAErC,MAAM,WAAW,QAAQ;IACvB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAA;IACzC,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,oBAAY,SAAS;IACnB,EAAE,OAAO;IACT,EAAE,OAAO;CACV"}

package/dist/index.js

@@ -14,17 +14,24 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PropertyValues = exports.SKVersion = void 0;
-var SKVersion;
-(function (SKVersion) {
-    SKVersion["v1"] = "v1";
-    SKVersion["v2"] = "v2";
-})(SKVersion = exports.SKVersion || (exports.SKVersion = {}));
+exports.SKVersion = void 0;
+__exportStar(require("./plugin"), exports);
+__exportStar(require("./serverapi"), exports);
 __exportStar(require("./deltas"), exports);
 __exportStar(require("./coursetypes"), exports);
 __exportStar(require("./resourcetypes"), exports);
 __exportStar(require("./resourcesapi"), exports);
+__exportStar(require("./features"), exports);
+__exportStar(require("./course"), exports);
 __exportStar(require("./autopilotapi"), exports);
 __exportStar(require("./autopilotapi.guard"), exports);
-var propertyvalues_1 = require("./propertyvalues");
-Object.defineProperty(exports, "PropertyValues", { enumerable: true, get: function () { return propertyvalues_1.PropertyValues; } });
+__exportStar(require("./propertyvalues"), exports);
+__exportStar(require("./brand"), exports);
+__exportStar(require("./streambundle"), exports);
+__exportStar(require("./subscriptionmanager"), exports);
+var SKVersion;
+(function (SKVersion) {
+    SKVersion["v1"] = "v1";
+    SKVersion["v2"] = "v2";
+})(SKVersion || (exports.SKVersion = SKVersion = {}));
+//# 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,2CAAwB;AACxB,8CAA2B;AAC3B,2CAAwB;AACxB,gDAA6B;AAC7B,kDAA+B;AAC/B,iDAA8B;AAC9B,6CAA0B;AAC1B,2CAAwB;AACxB,iDAA8B;AAC9B,uDAAoC;AACpC,mDAAgC;AAChC,0CAAuB;AACvB,iDAA8B;AAC9B,wDAAqC;AAoBrC,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,sBAAS,CAAA;IACT,sBAAS,CAAA;AACX,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB"}

package/dist/plugin.d.ts

@@ -0,0 +1,171 @@
+import { IRouter } from 'express';
+import { ServerAPI } from './serverapi';
+/**
+ * A plugin constructor is the interface that all plugins must export.
+ * It is called by the server when the server is starting up.
+ */
+export type PluginConstructor = (app: ServerAPI) => Plugin;
+/**
+ * Plugins are components that extend functionality of the server and can be installed via the Signal K AppStore.
+ *
+ * A plugin can:
+ * - Interact with the {@link ServerAPI}, including the full data model.
+ * - Provide a [webapp interface](../../../docs/develop/webapps.md).
+ * - Provide access to resources such as `route,` `waypoint`,`POI`, or `charts` via the _[Resources API](../../../docs/develop/rest-api/resources_api.md)_ by operating as a _[Resources Provider Plugin](../../../docs/develop/plugins/resource_provider_plugins.md)_.
+ * - Perform common autopilot operations by acting as an [Autopilot Provider Plugin](../../../docs/develop/plugins/autopilot_provider_plugins.md)
+ * - Perform course calculations by integrating with the [Course API](../../../docs/develop/rest-api/course_api.md).
+ * - process requests
+ *
+ * > [!WARNING]
+ * > Typing is incomplete. If you find a missing or inaccurate type, please [report it](https://github.com/SignalK/signalk-server/issues/1917).
+ *
+ * @example
+ *
+ * Signal K server plugins are NodeJs `javascript` or `typescript` projects that return an object that implements this interface.
+ *
+ * ```typescript
+ * import { Plugin, ServerAPI } from '@signalk/server-api';
+ *
+ * module.exports = (app: ServerAPI): Plugin => {
+ *   const plugin: Plugin = {
+ *     id: 'my-signalk-plugin',
+ *     name: 'My Great Plugin',
+ *     start: (settings, restartPlugin) => {
+ *       // start up code goes here.
+ *     },
+ *     stop: () => {
+ *       // shutdown code goes here.
+ *     },
+ *     schema: () => {
+ *       properties: {
+ *         // plugin configuration goes here
+ *       }
+ *     }
+ *   };
+ *
+ *   return plugin;
+ * }
+ * ```
+ * @see [Developing Server Plugins](../../../docs/develop/plugins/README.md)
+ */
+export interface Plugin {
+    /**
+     * Used to identify the plugin in the server, for example
+     * when storing the plugin's configuration and in http endpoints.
+     *
+     * @category Identification
+     */
+    id: string;
+    /**
+     * Human oriented name for the plugin. This is used in the server's plugin configuration UI.
+     * @category Identification
+     */
+    name: string;
+    description?: string;
+    /**
+     * This function is called to start the plugin.
+     *
+     * It is called:
+     * - during server startup for enabled plugins (by configuration or by default)
+     * - when a plugin is enabled in the admin UI
+     * - after {@link stop} when the configuration of an enabled plugin has been updated in the admin UI
+     *
+     * @category Lifecycle
+     *
+     * @param config - the configuration data entered via the Plugin Config screen
+     * @param restart - a function that can be called by the plugin to restart itself
+     */
+    start(config: object, restart: (newConfiguration: object) => void): void;
+    /**
+     * This function is called when the plugin is disabled or after configuration changes. Use this function to "clean up"
+     * the resources consumed by the plugin i.e. unsubscribe from streams, stop timers / loops and close devices. If there
+     * are asynchronous operations in your plugin's stop implementation you should return a Promise that resolves when
+     * stopping is complete.
+     *
+     * @category Lifecycle
+     */
+    stop(): void | Promise<void>;
+    /**
+     * @category Configuration
+     */
+    enabledByDefault?: boolean;
+    /**
+     * A [JSON Schema](http://json-schema.org/) object describing the structure of the configuration data.
+     *
+     * This is used by the server to render the plugin's configuration screen in the Admin UI.
+     * The configuration data is stored by the server in `$SIGNALK_NODE_CONFIG_DIR/plugin-config-data/<plugin-name>.json`. _(Default value of `SIGNALK_NODE_CONFIG_DIR` is `$HOME/.signalk`.)_
+     *
+     * @example
+     * ```javascript
+     *   plugin.schema = {
+     *     type: 'object',
+     *     required: ['some_string', 'some_other_number'],
+     *     properties: {
+     *       some_string: {
+     *         type: 'string',
+     *         title: 'Some string that the plugin needs'
+     *       },
+     *       some_number: {
+     *         type: 'number',
+     *         title: 'Some number that the plugin needs',
+     *         default: 60
+     *       },
+     *       some_other_number: {
+     *         type: 'number',
+     *         title: 'Some other number that the plugin needs',
+     *         default: 5
+     *       }
+     *     }
+     *   };
+     * ```
+     *
+     * @category Configuration
+     */
+    schema: object | (() => object);
+    /**
+     * A [uiSchema object](https://github.com/mozilla-services/react-jsonschema-form#the-uischema-object) which is used to control how the user interface is rendered in the Admin UI.
+     *
+     * For more information, see [react-jsonschema-form-extras](https://github.com/RxNT/react-jsonschema-form-extras#collapsible-fields-collapsible)
+     *
+     * @example
+     * Make all data in an object called 'myObject' collapsible:
+     * ```javascript
+     * uiSchema['myObject'] = {
+     *   'ui:field': 'collapsible',
+     *   collapse: {
+     *     field: 'ObjectField',
+     *     wrapClassName: 'panel-group'
+     *   }
+     * }
+     * ```
+     *
+     * @category Configuration
+     */
+    uiSchema?: object | (() => object);
+    /**
+     * Plugins can implement this method to provide an API. Like {@link start} and {@link stop}, this function will be
+     * called during plugin startup with an [Express](https://expressjs.com/) router as the parameter.
+     *
+     * The router will be mounted at `/plugins/<pluginId>` and you can use standard _Express_ _(`.get()` `.post()` `.use()`, etc)_ methods to add HTTP path handlers.
+     *
+     * > [!note]
+     * > `GET /plugins/<pluginid>` and `POST /plugins/<pluginid>/configure` are reserved by server (see below).
+     *
+     * It should be noted that _Express_ does not have a public API for deregistering subrouters, so {@link stop} does not do anything to the router.
+     *
+     * If a plugin does provide an API, it is strongly recommended that it implement {@link getOpenApi} to document its
+     * operation. Doing so promotes interoperability with other plugins / webapps by making it easy to find and use the
+     * functionality built into plugins. It is also a means to avoid duplication, promote reuse and the possibility of
+     * including them in the Signal K specification.
+     *
+     * @category Rest API
+     *
+     * @param router
+     * @returns
+     */
+    registerWithRouter?(router: IRouter): void;
+    getOpenApi?: () => object;
+    statusMessage?: () => string | void;
+    signalKApiRoutes?(router: IRouter): IRouter;
+}
+//# sourceMappingURL=plugin.d.ts.map

package/dist/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,GAAG,EAAE,SAAS,KAAK,MAAM,CAAA;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAM,WAAW,MAAM;IACrB;;;;;OAKG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,gBAAgB,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,CAAA;IAExE;;;;;;;OAOG;IACH,IAAI,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE5B;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAE1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,MAAM,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAA;IAE/B;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAA;IAElC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,kBAAkB,CAAC,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAAA;IAE1C,UAAU,CAAC,EAAE,MAAM,MAAM,CAAA;IAEzB,aAAa,CAAC,EAAE,MAAM,MAAM,GAAG,IAAI,CAAA;IAEnC,gBAAgB,CAAC,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAA;CAC5C"}

package/dist/plugin.js

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

package/dist/plugin.js.map

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

package/dist/propertyvalues.d.ts

@@ -1,3 +1,47 @@
+/**
+ * The _PropertyValues_ mechanism provides a means for passing configuration type values between different components running in the server process such as plugins and input connections.
+ *
+ * A plugin can both *emit* values and *listen* for values emitted by others.
+ *
+ * The difference between the _PropertyValues_ mechanism and _Event Emitters_ in NodeJs is that when  `onPropertyValues` is called, the `callback()` function will be invoked and passed an array containing all of the previous values for that _property name_, starting with the initial value of `undefined`. If no values have been emitted for that _property name_ the callback will be invoked with a value of `undefined`.
+ * *
+ * **PropertyValue** has the following structure:
+ * ```typescript
+ * interface PropertyValue {
+ *   timestamp: number // millis
+ *   setter: string // plugin id, server, provider id
+ *   name: string
+ *   value: any
+ * }
+ * ```
+ *
+ * _Note that the value can be also a function._
+ *
+ * This mechanism allows plugins to _offer_ extensions via _"Well Known Properties"_, for example
+ * - additional [NMEA0183 sentence parsers for custom sentences](https://github.com/SignalK/nmea0183-signalk/pull/193) via `nmea0183sentenceParser`
+ * - additional PGN definitions for propietary or custom PGNs
+ *
+ * Code handling incoming _PropertyValues_ should be fully reactive due to:
+ * - Plugins being able to emit _PropertyValues_ when they activated and / or started
+ * - There being no defined load / startup order for plugins / connections.
+ *
+ * So even if all plugins / connections emit during their startup, you cannot depend on a specific _PropertyValue_ being available. It may be present when your code starts or it may arrive after your code has started.
+ *
+ *
+ * **Note: The _PropertyValues_ mechanism is not intended to be used for data passing on a regular basis, as the total history makes it a potential memory leak.**
+ *
+ * To safeguard against a component accidentally emitting regularly, via a fixed upper bound is enforced for the value array per _property name_. New values will be ignored if the upper bound is reached and are logged as errors.
+ */
+export interface PropertyValuesEmitter {
+    /**
+     * @category Property Values
+     */
+    emitPropertyValue(name: string, value: any): void;
+    /**
+     * @category Property Values
+     */
+    onPropertyValues(name: string, cb: PropertyValuesCallback): Unsubscribe;
+}
 export interface PropertyValue {
     timestamp: number;
     setter: string;
@@ -13,3 +57,9 @@ export declare class PropertyValues {
     emitPropertyValue(pv: PropertyValue): void;
     private getStreamTuple;
 }
+/**
+ * @inline
+ */
+type Unsubscribe = () => void;
+export {};
+//# sourceMappingURL=propertyvalues.d.ts.map

package/dist/propertyvalues.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"propertyvalues.d.ts","sourceRoot":"","sources":["../src/propertyvalues.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IAEH,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAA;IAEjD;;OAEG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,sBAAsB,GAAG,WAAW,CAAA;CACxE;AAED,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IAEZ,KAAK,EAAE,GAAG,CAAA;CACX;AAED,MAAM,MAAM,sBAAsB,GAAG,CACnC,iBAAiB,EAAE,aAAa,EAAE,KAC/B,IAAI,CAAA;AAQT,qBAAa,cAAc;IACzB,OAAO,CAAC,OAAO,CAET;IACN,OAAO,CAAC,KAAK,CAAI;IAEjB,MAAM,CAAC,QAAQ,CAAC,gBAAgB,QAAO;IAEvC,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,sBAAsB,GAAG,MAAM,IAAI;IAI1E,iBAAiB,CAAC,EAAE,EAAE,aAAa;IAWnC,OAAO,CAAC,cAAc;CAsBvB;AAED;;GAEG;AACH,KAAK,WAAW,GAAG,MAAM,IAAI,CAAA"}

package/dist/propertyvalues.js

@@ -4,44 +4,39 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PropertyValues = void 0;
-var baconjs_1 = __importDefault(require("baconjs"));
-var PropertyValues = /** @class */ (function () {
-    function PropertyValues() {
-        this.streams = {};
-        this.count = 0;
-    }
-    PropertyValues.prototype.onPropertyValues = function (propName, cb) {
+const baconjs_1 = __importDefault(require("baconjs"));
+class PropertyValues {
+    streams = {};
+    count = 0;
+    static MAX_VALUES_COUNT = 1000;
+    onPropertyValues(propName, cb) {
         return this.getStreamTuple(propName).stream.onValue(cb);
-    };
-    PropertyValues.prototype.emitPropertyValue = function (pv) {
+    }
+    emitPropertyValue(pv) {
         if (this.count >= PropertyValues.MAX_VALUES_COUNT) {
-            throw new Error("Max PropertyValues count ".concat(PropertyValues.MAX_VALUES_COUNT, " exceeded trying to emit ").concat(JSON.stringify(pv)));
+            throw new Error(`Max PropertyValues count ${PropertyValues.MAX_VALUES_COUNT} exceeded trying to emit ${JSON.stringify(pv)}`);
         }
         this.getStreamTuple(pv.name).bus.push(pv);
-    };
-    PropertyValues.prototype.getStreamTuple = function (propName) {
-        var _this = this;
-        var streamTuple = this.streams[propName];
+    }
+    getStreamTuple(propName) {
+        let streamTuple = this.streams[propName];
         if (!streamTuple) {
-            var bus = new baconjs_1.default.Bus();
-            var stream = bus
-                .scan([], function (acc, v) {
+            const bus = new baconjs_1.default.Bus();
+            const stream = bus.scan([], (acc, v) => {
                 acc.push(v);
-                _this.count++;
+                this.count++;
                 return acc;
-            })
-                .toProperty();
+            });
             streamTuple = {
-                bus: bus,
-                stream: stream
+                bus,
+                stream
             };
-            streamTuple.stream.subscribe(function () { return ({}); }); // start the stream eagerly
+            streamTuple.stream.subscribe(() => ({})); // start the stream eagerly
             streamTuple.bus.push(undefined);
             this.streams[propName] = streamTuple;
         }
         return streamTuple;
-    };
-    PropertyValues.MAX_VALUES_COUNT = 1000;
-    return PropertyValues;
-}());
+    }
+}
 exports.PropertyValues = PropertyValues;
+//# sourceMappingURL=propertyvalues.js.map

package/dist/propertyvalues.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"propertyvalues.js","sourceRoot":"","sources":["../src/propertyvalues.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA2B;AAmE3B,MAAa,cAAc;IACjB,OAAO,GAEX,EAAE,CAAA;IACE,KAAK,GAAG,CAAC,CAAA;IAEjB,MAAM,CAAU,gBAAgB,GAAG,IAAI,CAAA;IAEvC,gBAAgB,CAAC,QAAgB,EAAE,EAA0B;QAC3D,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IACzD,CAAC;IAED,iBAAiB,CAAC,EAAiB;QACjC,IAAI,IAAI,CAAC,KAAK,IAAI,cAAc,CAAC,gBAAgB,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CACb,4BACE,cAAc,CAAC,gBACjB,4BAA4B,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CACjD,CAAA;QACH,CAAC;QACD,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IAC3C,CAAC;IAEO,cAAc,CAAC,QAAgB;QACrC,IAAI,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;QACxC,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,GAAG,GAAG,IAAI,iBAAK,CAAC,GAAG,EAAsC,CAAA;YAC/D,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,CACrB,EAAE,EACF,CAAC,GAAkC,EAAE,CAA4B,EAAE,EAAE;gBACnE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;gBACX,IAAI,CAAC,KAAK,EAAE,CAAA;gBACZ,OAAO,GAAG,CAAA;YACZ,CAAC,CACF,CAAA;YACD,WAAW,GAAG;gBACZ,GAAG;gBACH,MAAM;aACP,CAAA;YACD,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA,CAAC,2BAA2B;YACpE,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YAC/B,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,WAAW,CAAA;QACtC,CAAC;QACD,OAAO,WAAW,CAAA;IACpB,CAAC;;AA5CH,wCA6CC"}

package/dist/propertyvalues.test.d.ts

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

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

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