@signalk/server-api 1.39.0 → 2.0.0-beta.2

package/dist/autopilot.d.ts

@@ -0,0 +1,28 @@
+export interface AutopilotApi {
+    register: (pluginId: string, provider: AutopilotProvider) => void;
+    unRegister: (pluginId: string) => void;
+    getStates: () => Promise<[string]>;
+    setState: (state: string) => Promise<void>;
+    getModes: () => Promise<[string]>;
+    setMode: (mode: string) => Promise<void>;
+    setTarget: (value: number) => Promise<void>;
+    adjustTarget: (value: number) => Promise<void>;
+    tack: (port: boolean) => Promise<void>;
+}
+export interface AutopilotProvider {
+    pilotType: string;
+    methods: AutopilotProviderMethods;
+}
+export interface AutopilotProviderMethods {
+    pluginId?: string;
+    getStates: () => Promise<[string]>;
+    setState: (state: string) => Promise<void>;
+    getModes: () => Promise<[string]>;
+    setMode: (mode: string) => Promise<void>;
+    setTarget: (value: number) => Promise<void>;
+    adjustTarget: (value: number) => Promise<void>;
+    tack: (port: boolean) => Promise<void>;
+}
+export interface AutopilotProviderRegistry {
+    registerAutopilotProvider: (provider: AutopilotProvider) => void;
+}

package/dist/autopilot.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -1,6 +1,75 @@
 import { IRouter } from 'express';
 import { PropertyValuesCallback } from './propertyvalues';
+export interface Position {
+    latitude: number;
+    longitude: number;
+    altitude?: number;
+}
 export { PropertyValue, PropertyValues, PropertyValuesCallback } from './propertyvalues';
+export * from './resourcetypes';
+export declare type SignalKResourceType = 'routes' | 'waypoints' | 'notes' | 'regions' | 'charts';
+export declare const SIGNALKRESOURCETYPES: SignalKResourceType[];
+export declare const isSignalKResourceType: (s: string) => boolean;
+export declare type ResourceType = SignalKResourceType | string;
+export interface ResourcesApi {
+    register: (pluginId: string, provider: ResourceProvider) => void;
+    unRegister: (pluginId: string) => void;
+    listResources: (resType: SignalKResourceType, params: {
+        [key: string]: any;
+    }) => Promise<{
+        [id: string]: any;
+    }>;
+    getResource: (resType: SignalKResourceType, resId: string) => Promise<object>;
+    setResource: (resType: SignalKResourceType, resId: string, data: {
+        [key: string]: any;
+    }) => Promise<void>;
+    deleteResource: (resType: SignalKResourceType, resId: string) => Promise<void>;
+}
+export interface ResourceProvider {
+    type: ResourceType;
+    methods: ResourceProviderMethods;
+}
+export interface ResourceProviderMethods {
+    pluginId?: string;
+    listResources: (query: {
+        [key: string]: any;
+    }) => Promise<{
+        [id: string]: any;
+    }>;
+    getResource: (id: string) => Promise<object>;
+    setResource: (id: string, value: {
+        [key: string]: any;
+    }) => Promise<void>;
+    deleteResource: (id: string) => Promise<void>;
+}
+export interface ResourceProviderRegistry {
+    registerResourceProvider: (provider: ResourceProvider) => void;
+}
+export interface AutopilotApi {
+    register: (pluginId: string, provider: AutopilotProvider) => void;
+    unRegister: (pluginId: string) => void;
+}
+export interface AutopilotProvider {
+    pilotType: string;
+    methods: AutopilotProviderMethods;
+}
+export interface AutopilotProviderMethods {
+    pluginId?: string;
+    engage: (enable: boolean) => Promise<void>;
+    getConfig: () => Promise<{
+        [key: string]: any;
+    }>;
+    getState: () => Promise<string>;
+    setState: (state: string) => Promise<void>;
+    getMode: () => Promise<string>;
+    setMode: (mode: string) => Promise<void>;
+    setTarget: (value: number) => Promise<void>;
+    adjustTarget: (value: number) => Promise<void>;
+    tack: (port: boolean) => Promise<void>;
+}
+export interface AutopilotProviderRegistry {
+    registerAutopilotProvider: (provider: AutopilotProvider) => void;
+}
 declare type Unsubscribe = () => {};
 export interface PropertyValuesEmitter {
     emitPropertyValue: (name: string, value: any) => void;
@@ -12,7 +81,7 @@ export interface PropertyValuesEmitter {
  *
  * INCOMPLETE, work in progress.
  */
-export interface PluginServerApp extends PropertyValuesEmitter {
+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.

package/dist/index.js

@@ -1,5 +1,25 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 = void 0;
+exports.isSignalKResourceType = exports.SIGNALKRESOURCETYPES = exports.PropertyValues = void 0;
 var propertyvalues_1 = require("./propertyvalues");
 Object.defineProperty(exports, "PropertyValues", { enumerable: true, get: function () { return propertyvalues_1.PropertyValues; } });
+__exportStar(require("./resourcetypes"), exports);
+exports.SIGNALKRESOURCETYPES = [
+    'routes',
+    'waypoints',
+    'notes',
+    'regions',
+    'charts'
+];
+var isSignalKResourceType = function (s) { return exports.SIGNALKRESOURCETYPES.includes(s); };
+exports.isSignalKResourceType = isSignalKResourceType;

package/dist/propertyvalues.test.js

@@ -1,10 +1,8 @@
 "use strict";
-var __spreadArrays = (this && this.__spreadArrays) || function () {
-    for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;
-    for (var r = Array(s), k = 0, i = 0; i < il; i++)
-        for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)
-            r[k] = a[j];
-    return r;
+var __spreadArray = (this && this.__spreadArray) || function (to, from) {
+    for (var i = 0, il = from.length, j = to.length; i < il; i++, j++)
+        to[j] = from[i];
+    return to;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 var chai_1 = require("chai");
@@ -21,7 +19,7 @@ var setupTest = function (done, startAt) {
     var pv = new propertyvalues_1.PropertyValues();
     var cbCount = 0;
     var cb = function (values) {
-        chai_1.expect(values).to.deep.equal(__spreadArrays([
+        chai_1.expect(values).to.deep.equal(__spreadArray([
             undefined
         ], testValues.slice(0, startAt + cbCount++)));
         if (cbCount === testValues.length) {

package/dist/resourcetypes.d.ts

@@ -0,0 +1,80 @@
+import { Position } from '.';
+export interface Route {
+    name?: string;
+    description?: string;
+    distance?: number;
+    start?: string;
+    end?: string;
+    feature: {
+        type: 'Feature';
+        geometry: {
+            type: 'LineString';
+            coordinates: GeoJsonLinestring;
+        };
+        properties?: object;
+        id?: string;
+    };
+}
+export interface Waypoint {
+    name?: string;
+    description?: string;
+    feature: {
+        type: 'Feature';
+        geometry: {
+            type: 'Point';
+            coordinates: GeoJsonPoint;
+        };
+        properties?: object;
+        id?: string;
+    };
+}
+export interface Note {
+    name?: string;
+    description?: string;
+    href?: string;
+    position?: Position;
+    geohash?: string;
+    mimeType?: string;
+    url?: string;
+}
+export interface Region {
+    name?: string;
+    description?: string;
+    feature: Polygon | MultiPolygon;
+}
+export interface Chart {
+    name: string;
+    identifier: string;
+    description?: string;
+    tilemapUrl?: string;
+    chartUrl?: string;
+    geohash?: string;
+    region?: string;
+    scale?: number;
+    chartLayers?: string[];
+    bounds?: [[number, number], [number, number]];
+    chartFormat: string;
+}
+export declare type GeoJsonPoint = [number, number, number?];
+export declare type GeoJsonLinestring = GeoJsonPoint[];
+export declare type GeoJsonPolygon = GeoJsonLinestring[];
+export declare type GeoJsonMultiPolygon = GeoJsonPolygon[];
+interface Polygon {
+    type: 'Feature';
+    geometry: {
+        type: 'Polygon';
+        coordinates: GeoJsonPolygon;
+    };
+    properties?: object;
+    id?: string;
+}
+interface MultiPolygon {
+    type: 'Feature';
+    geometry: {
+        type: 'MultiPolygon';
+        coordinates: GeoJsonMultiPolygon;
+    };
+    properties?: object;
+    id?: string;
+}
+export {};

package/dist/resourcetypes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@signalk/server-api",
-  "version": "1.39.0",
+  "version": "2.0.0-beta.2",
   "description": "signalk-server Typescript API for plugins etc with relevant implementation classes",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsc --declaration",
-    "watch": "tsc --watch",
+    "watch": "tsc --declaration --watch",
     "prepublishOnly": "npm run build",
     "typedoc": "typedoc --out docs src",
     "test": "mocha --require ts-node/register src/**/*.test.ts"
@@ -18,7 +18,9 @@
   "author": "teppo.kurki@iki.fi",
   "license": "Apache-2.0",
   "devDependencies": {
+    "express": "^4.10.4",
     "@types/chai": "^4.2.15",
+    "@types/express": "^4.17.1",
     "@types/mocha": "^8.2.0",
     "chai": "^4.3.0",
     "mocha": "^8.3.0",

package/tsconfig.json

@@ -15,8 +15,8 @@
     // "sourceMap": true,                     /* Generates corresponding '.map' file. */
     // "outFile": "./",                       /* Concatenate and emit output to single file. */
     "outDir": "./dist",                        /* Redirect output structure to the directory. */
-    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-    // "composite": true,                     /* Enable project compilation */
+    "rootDir": "src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    "composite": true,                     /* Enable project compilation */
     // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
     // "removeComments": true,                /* Do not emit comments to output. */
     // "noEmit": true,                        /* Do not emit outputs. */