signalk-flags 1.0.0

package/.prettierrc.json

@@ -0,0 +1,5 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "none"
+}

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# CHANGELOG: Signal K Flag Resources - Signal K plugin 
+
+## v1.0.0-beta.1
+
+- Initial beta release.
+
+

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,60 @@
+# Signal K Flag Resources Plugin:
+
+
+## About
+
+Signal K server plugin that:
+1. Makes country flag images (svg) images available under `/signalk/v2/api/resources/flags`
+1. Populates both the `flag` and `port` attributes for a vessel based on the received MMSI value.
+
+
+### HTTP API endpoints
+
+Flag images (in svg format) can be retrieved by making HTTP requests to the available API endpoints, the definitions of which can be found in the **Signal K Admin Console** by clicking on **OpenAPI** and selecting **plugins/signalk-flags**.
+
+#### Using MMSI
+
+- `/signalk/v2/api/resources/flags/mmsi/{vessel_mmsi}`
+
+_Example: Return flag image for the MMSI = 211456789_
+```bash
+HTTP GET "/signalk/v2/api/resources/flags/mmsi/211456789
+```
+
+#### Using Country Code
+
+- `/signalk/v2/api/resources/flags/country/{country_code}` 
+
+_`country_code` = two-character country code_
+
+_Example: Return the New Zealand flag image_
+```bash
+HTTP GET "/signalk/v2/api/resources/flags/country/nz"
+```
+
+---
+
+### Vessel Schema Atttributes
+
+The plugin also populates both the `flag` and `port` attributes for a vessel based on the received MMSI value as follows:
+
+- `flag` = two letter country code _(e.g. "DE")_
+- `port` = name of the country _(e.g. "Germany")_
+
+The attributes are then available as part of the Signal K data model and can be retrieved along with other vessel data.
+
+_Example: Fetch vessel details via HTTP request to Signal K API_ 
+```bash
+HTTP GET "vessels.urn:mrn:signalk:uuid:eec3888d-5925-4e81-b6d4-3d2ff98edeeb"
+```
+
+_Example Response:_
+```JSON
+{
+    "mmsi": 211456789,
+    "name": "My Vessel",
+    "flag": "DE",
+    "port": "Germany"
+    ... // remainder of vessel data
+}
+```

package/package.json

@@ -0,0 +1,35 @@
+{
+    "name": "signalk-flags",
+    "version": "1.0.0",
+    "description": "Country Flags plugin for Signal K server.",
+    "main": "plugin/index.js",
+    "keywords": [
+        "signalk-node-server-plugin"
+    ],
+    "repository": "https://github.com/panaaj/signalk-icons",
+    "author": "AdrianP",
+    "contributors": [
+        {
+            "name": "panaaj@hotmail.com"
+        }
+    ],
+    "license": "Apache-20",
+    "scripts": {
+        "build": "tsc",
+        "build-declaration": "tsc --declaration --allowJs false",
+        "watch": "npm run build -- -w",
+        "test": "echo \"Error: no test specified\" && exit 1",
+        "start": "npm run build -- -w",
+        "format": "prettier --write src/*"
+    },
+    "dependencies": {
+        "@signalk/server-api": "^2.3.0",
+        "flag-icons": "^7.3.2"
+    },
+    "devDependencies": {
+        "@types/express": "^4.17.6",
+        "prettier": "^2.5.1",
+        "typescript": "^4.5.4"
+    },
+    "signalk-plugin-enabled-by-default": true
+}

package/plugin/index.d.ts

@@ -0,0 +1,15 @@
+import { Application } from 'express';
+import { Delta, ServerAPI } from '@signalk/server-api';
+interface SKDeltaSubscription {
+    context: string;
+    subscribe: Array<{
+        path: string;
+        period: number;
+    }>;
+}
+export interface FlagsApp extends ServerAPI, Application {
+    subscriptionmanager: {
+        subscribe: (subscribe: SKDeltaSubscription, unsubscribes: Array<any>, errorCallback: (error: any) => void, deltaCallback: (delta: Delta) => void) => void;
+    };
+}
+export {};

package/plugin/index.js

@@ -0,0 +1,275 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = require("fs");
+const promises_1 = require("fs/promises");
+const path_1 = __importDefault(require("path"));
+const server_api_1 = require("@signalk/server-api");
+const openapi = __importStar(require("./openApi.json"));
+const mid_1 = require("./mid");
+const CONFIG_SCHEMA = {
+    properties: {}
+};
+const CONFIG_UISCHEMA = {};
+module.exports = (server) => {
+    let subscriptions = []; // stream subscriptions
+    const FLAGS_API_PATH = '/signalk/v2/api/resources/flags';
+    let IMG_BASE_PATH = '';
+    const plugin = {
+        id: 'signalk-flags',
+        name: 'Country Flag Resources',
+        schema: () => CONFIG_SCHEMA,
+        uiSchema: () => CONFIG_UISCHEMA,
+        start: (options, restart) => {
+            doStartup(options);
+        },
+        stop: () => {
+            doShutdown();
+        },
+        registerWithRouter: (router) => {
+            server.debug(`Required for OpenApi support.`);
+            return router;
+        },
+        getOpenApi: () => Object.assign({}, openapi)
+    };
+    let settings = {};
+    const doStartup = (options) => {
+        try {
+            server.debug(`${plugin.name} starting.......`);
+            if (options) {
+                settings = options;
+            }
+            else {
+                // save defaults if no options loaded
+                server.savePluginOptions(settings, () => {
+                    server.debug(`Default configuration applied...`);
+                });
+            }
+            server.debug(`Applied configuration: ${JSON.stringify(settings)}`);
+            server.setPluginStatus(`Started`);
+            // initialise plugin
+            initialise();
+        }
+        catch (error) {
+            const msg = `Started with errors!`;
+            server.setPluginError(msg);
+            server.error('error: ' + error);
+        }
+    };
+    const doShutdown = () => {
+        server.debug(`${plugin.name} stopping.......`);
+        server.debug('** Un-registering Update Handler(s) **');
+        subscriptions.forEach((b) => b());
+        subscriptions = [];
+        const msg = 'Stopped.';
+        server.setPluginStatus(msg);
+    };
+    /**
+     * initialise plugin
+     */
+    const initialise = () => {
+        server.debug('Initialising ....');
+        // setup subscriptions
+        initSubscriptions();
+        initFs();
+        initFlagsEndpoints();
+    };
+    // register DELTA stream message handler
+    const initSubscriptions = () => {
+        server.debug('Initialising Stream Subscription....');
+        const subscription = {
+            context: 'vessels.*',
+            subscribe: [
+                {
+                    path: '',
+                    period: 500
+                }
+            ]
+        };
+        server.subscriptionmanager.subscribe(subscription, subscriptions, (error) => {
+            server.error(`${plugin.id} Error: ${error}`);
+        }, (delta) => {
+            if (!delta.updates) {
+                return;
+            }
+            const context = delta.context;
+            delta.updates.forEach((u) => {
+                if (!(0, server_api_1.hasValues)(u)) {
+                    return;
+                }
+                u.values.forEach((v) => {
+                    if (v.path === '' && 'mmsi' in v.value) {
+                        const country = countryFromMmsi(v.value.mmsi);
+                        if (country) {
+                            server.handleMessage(plugin.id, {
+                                context: context,
+                                updates: [
+                                    {
+                                        values: [
+                                            {
+                                                path: 'flag',
+                                                value: country[0]
+                                            },
+                                            {
+                                                path: 'port',
+                                                value: country[3]
+                                            }
+                                        ]
+                                    }
+                                ]
+                            });
+                        }
+                    }
+                });
+            });
+        });
+    };
+    /**
+     * Check filesystem path(s)
+     */
+    const initFs = () => __awaiter(void 0, void 0, void 0, function* () {
+        const p = path_1.default.resolve(server.getDataDirPath()).split('/');
+        const sp = p.slice(0, p.indexOf('.signalk') + 1).join('/');
+        // dev env
+        const DEV_PATH = path_1.default.join(sp, 'node_modules', plugin.id, 'node_modules', 'flag-icons', 'flags');
+        // prod env
+        const PRD_PATH = path_1.default.join(sp, 'node_modules', 'flag-icons', 'flags');
+        try {
+            yield (0, promises_1.access)(PRD_PATH, fs_1.constants.W_OK | fs_1.constants.R_OK);
+            server.debug(`${PRD_PATH} - OK...Flag images found.`);
+            IMG_BASE_PATH = PRD_PATH;
+        }
+        catch (error) {
+            server.debug(`${PRD_PATH} does NOT exist!`);
+            server.debug(`Trying secondary path....${DEV_PATH}`);
+            try {
+                yield (0, promises_1.access)(DEV_PATH, fs_1.constants.W_OK | fs_1.constants.R_OK);
+                server.debug(`${DEV_PATH} - OK...Flag images found.`);
+                IMG_BASE_PATH = DEV_PATH;
+            }
+            catch (error) {
+                server.debug(`${DEV_PATH} does NOT exist either!`);
+            }
+        }
+    });
+    /**
+     * Initialise flag resource endpoints
+     */
+    const initFlagsEndpoints = () => {
+        server.debug(`** Registering Flag resources endpoint(s) **`);
+        server.get(`${FLAGS_API_PATH}/mmsi/:mmsi`, (req, res) => {
+            server.debug(`** ${req.method} ${req.path}`);
+            iconFromMmsi(req.params.mmsi, req.query.aspect, res);
+        });
+        server.get(`${FLAGS_API_PATH}/country/:code`, (req, res) => {
+            server.debug(`** ${req.method} ${req.path}`);
+            iconFromCountryCode(req.params.code, req.query.aspect, res);
+        });
+    };
+    /**
+     * Send flag for the supplied two letter country code
+     * @param aspect Aspect ratio default= '4x3'
+     * @returns svg file contents
+     */
+    const iconFromCountryCode = (code, aspect = '4x3', res) => __awaiter(void 0, void 0, void 0, function* () {
+        try {
+            const flag = `${IMG_BASE_PATH}/${aspect}/${code.toLowerCase()}.svg`;
+            // check flag file exists
+            yield (0, promises_1.access)(flag, fs_1.constants.R_OK);
+            res.sendFile(flag, (err) => {
+                if (err) {
+                    res.status(400).json({
+                        state: 'FAILED',
+                        statusCode: 400,
+                        message: err.message
+                    });
+                }
+            });
+        }
+        catch (error) {
+            res.status(400).json({
+                state: 'FAILED',
+                statusCode: 400,
+                message: `Flag for supplied country code (${code}) NOT found!`
+            });
+            return;
+        }
+    });
+    /**
+     * Send flag derived from the supplied MMSI
+     * @param aspect Flag icon aspect ratio '1x1' or '4x3'
+     * @returns svg file contents
+     */
+    const iconFromMmsi = (mmsi, aspect = '4x3', res) => __awaiter(void 0, void 0, void 0, function* () {
+        try {
+            const country = countryFromMmsi(mmsi);
+            const flag = `${IMG_BASE_PATH}/${aspect}/${country[0].toLowerCase()}.svg`;
+            // check flag file exists
+            yield (0, promises_1.access)(flag, fs_1.constants.R_OK);
+            res.sendFile(flag, (err) => {
+                if (err) {
+                    res.status(400).json({
+                        state: 'FAILED',
+                        statusCode: 400,
+                        message: err.message
+                    });
+                }
+            });
+        }
+        catch (error) {
+            res.status(400).json({
+                state: 'FAILED',
+                statusCode: 400,
+                message: `Flag for supplied MMSI (${mmsi}) not found!`
+            });
+            return;
+        }
+    });
+    /**
+     * Get country details from supplied MMSI
+     * @param mmsi Maritime mobile service identifier
+     * @returns Array containing country details
+     */
+    const countryFromMmsi = (mmsi) => {
+        if (typeof mmsi === 'number') {
+            mmsi = mmsi.toString();
+        }
+        const mid = mmsi.slice(0, 3);
+        return mid_1.MID[mid];
+    };
+    return plugin;
+};

package/plugin/mid.d.ts

@@ -0,0 +1,3 @@
+export declare const MID: {
+    [mid: string]: string[];
+};

package/plugin/mid.js

@@ -0,0 +1,296 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MID = void 0;
+// source: https://github.com/michaeljfazio/MIDs/blob/master/mids.json
+exports.MID = {
+    '201': ['AL', 'ALB', '', 'Albania'],
+    '202': ['AD', 'AND', '', 'Andorra'],
+    '203': ['AT', 'AUT', '', 'Austria'],
+    '204': ['PT', 'PRT', 'PT-20', 'Azores'],
+    '205': ['BE', 'BEL', '', 'Belgium'],
+    '206': ['BY', 'BLR', '', 'Belarus'],
+    '207': ['BG', 'BGR', '', 'Bulgaria'],
+    '208': ['VA', 'VAT', '', 'Vatican City State'],
+    '209': ['CY', 'CYP', '', 'Cyprus'],
+    '210': ['CY', 'CYP', '', 'Cyprus'],
+    '211': ['DE', 'DEU', '', 'Germany'],
+    '212': ['CY', 'CYP', '', 'Cyprus'],
+    '213': ['GE', 'GEO', '', 'Georgia'],
+    '214': ['MD', 'MDA', '', 'Moldova'],
+    '215': ['MT', 'MLT', '', 'Malta'],
+    '216': ['AM', 'ARM', '', 'Armenia'],
+    '218': ['DE', 'DEU', '', 'Germany'],
+    '219': ['DK', 'DNK', '', 'Denmark'],
+    '220': ['DK', 'DNK', '', 'Denmark'],
+    '224': ['ES', 'ESP', '', 'Spain'],
+    '225': ['ES', 'ESP', '', 'Spain'],
+    '226': ['FR', 'FRA', '', 'France'],
+    '227': ['FR', 'FRA', '', 'France'],
+    '228': ['FR', 'FRA', '', 'France'],
+    '229': ['MT', 'MLT', '', 'Malta'],
+    '230': ['FI', 'FIN', '', 'Finland'],
+    '231': ['FO', 'FRO', '', 'Faroe Islands'],
+    '232': ['GB', 'GBR', '', 'United Kingdom'],
+    '233': ['GB', 'GBR', '', 'United Kingdom'],
+    '234': ['GB', 'GBR', '', 'United Kingdom'],
+    '235': ['GB', 'GBR', '', 'United Kingdom'],
+    '236': ['GI', 'GIB', '', 'Gibraltar'],
+    '237': ['GR', 'GRC', '', 'Greece'],
+    '238': ['HR', 'HRV', '', 'Croatia'],
+    '239': ['GR', 'GRC', '', 'Greece'],
+    '240': ['GR', 'GRC', '', 'Greece'],
+    '241': ['GR', 'GRC', '', 'Greece'],
+    '242': ['MA', 'MAR', '', 'Morocco'],
+    '243': ['HU', 'HUN', '', 'Hungary'],
+    '244': ['NL', 'NLD', '', 'Netherlands'],
+    '245': ['NL', 'NLD', '', 'Netherlands'],
+    '246': ['NL', 'NLD', '', 'Netherlands'],
+    '247': ['IT', 'ITA', '', 'Italy'],
+    '248': ['MT', 'MLT', '', 'Malta'],
+    '249': ['MT', 'MLT', '', 'Malta'],
+    '250': ['IE', 'IRL', '', 'Ireland'],
+    '251': ['IS', 'ISL', '', 'Iceland'],
+    '252': ['LI', 'LIE', '', 'Liechtenstein'],
+    '253': ['LU', 'LUX', '', 'Luxembourg'],
+    '254': ['MC', 'MCO', '', 'Monaco'],
+    '255': ['PT', 'PRT', 'PT-30', 'Madeira'],
+    '256': ['MT', 'MLT', '', 'Malta'],
+    '257': ['NO', 'NOR', '', 'Norway'],
+    '258': ['NO', 'NOR', '', 'Norway'],
+    '259': ['NO', 'NOR', '', 'Norway'],
+    '261': ['PL', 'POL', '', 'Poland'],
+    '262': ['ME', 'MNE', '', 'Montenegro'],
+    '263': ['PT', 'PRT', '', 'Portugal'],
+    '264': ['RO', 'ROU', '', 'Romania'],
+    '265': ['SE', 'SWE', '', 'Sweden'],
+    '266': ['SE', 'SWE', '', 'Sweden'],
+    '267': ['SK', 'SVK', '', 'Slovak Republic'],
+    '268': ['SM', 'SMR', '', 'San Marino'],
+    '269': ['CH', 'CHE', '', 'Switzerland'],
+    '270': ['CZ', 'CZE', '', 'Czech Republic'],
+    '271': ['TR', 'TUR', '', 'Turkey'],
+    '272': ['UA', 'UKR', '', 'Ukraine'],
+    '273': ['RU', 'RUS', '', 'Russia'],
+    '274': ['MK', 'MKD', '', 'Macedonia'],
+    '275': ['LV', 'LVA', '', 'Latvia'],
+    '276': ['EE', 'EST', '', 'Estonia'],
+    '277': ['LT', 'LTU', '', 'Lithuania'],
+    '278': ['SI', 'SVN', '', 'Slovenia'],
+    '279': ['RS', 'SRB', '', 'Serbia'],
+    '301': ['AI', 'AIA', '', 'Anguilla'],
+    '303': ['US', 'USA', 'US-AK', 'Alaska'],
+    '304': ['AG', 'ATG', '', 'Antigua and Barbuda'],
+    '305': ['AG', 'ATG', '', 'Antigua and Barbuda'],
+    '306': ['CW', 'CUW', '', 'Antilles'],
+    '307': ['AW', 'ABW', '', 'Aruba'],
+    '308': ['BS', 'BHS', '', 'Bahamas'],
+    '309': ['BS', 'BHS', '', 'Bahamas'],
+    '310': ['BM', 'BMU', '', 'Bermuda'],
+    '311': ['BS', 'BMU', '', 'Bahamas'],
+    '312': ['BZ', 'BLZ', '', 'Belize'],
+    '314': ['BB', 'BRB', '', 'Barbados'],
+    '316': ['CA', 'CAN', '', 'Canada'],
+    '319': ['KY', 'CYM', '', 'Cayman Islands'],
+    '321': ['CR', 'CRI', '', 'Costa Rica'],
+    '323': ['CU', 'CUB', '', 'Cuba'],
+    '325': ['DM', 'DMA', '', 'Dominica'],
+    '327': ['DO', 'DOM', '', 'Dominican Republic'],
+    '329': ['GP', 'GLP', '', 'Guadeloupe'],
+    '330': ['GD', 'GRD', '', 'Grenada'],
+    '331': ['GL', 'GRL', '', 'Greenland'],
+    '332': ['GT', 'GTM', '', 'Guatemala'],
+    '335': ['HN', 'HND', '', 'Honduras'],
+    '336': ['HT', 'HTI', '', 'Haiti'],
+    '338': ['US', 'USA', '', 'United States of America'],
+    '339': ['JM', 'JAM', '', 'Jamaica'],
+    '341': ['KN', 'KNA', '', 'Saint Kitts and Nevis'],
+    '343': ['LC', 'LCA', '', 'Saint Lucia'],
+    '345': ['MX', 'MEX', '', 'Mexico'],
+    '347': ['MQ', 'MTQ', '', 'Martinique'],
+    '348': ['MS', 'MSR', '', 'Montserrat'],
+    '350': ['NI', 'NIC', '', 'Nicaragua'],
+    '351': ['PA', 'PAN', '', 'Panama'],
+    '352': ['PA', 'PAN', '', 'Panama'],
+    '353': ['PA', 'PAN', '', 'Panama'],
+    '354': ['PA', 'PAN', '', 'Panama'],
+    '355': ['PA', 'PAN', '', 'Panama'],
+    '356': ['PA', 'PAN', '', 'Panama'],
+    '357': ['PA', 'PAN', '', 'Panama'],
+    '358': ['PR', 'PRI', '', 'Puerto Rico'],
+    '359': ['SV', 'SLV', '', 'El Salvador'],
+    '361': ['PM', 'SPM', '', 'Saint Pierre and Miquelon'],
+    '362': ['TT', 'TTO', '', 'Trinidad and Tobago'],
+    '364': ['TC', 'TCA', '', 'Turks and Caicos Islands'],
+    '366': ['US', 'USA', '', 'United States of America'],
+    '367': ['US', 'USA', '', 'United States of America'],
+    '368': ['US', 'USA', '', 'United States of America'],
+    '369': ['US', 'USA', '', 'United States of America'],
+    '370': ['PA', 'PAN', '', 'Panama'],
+    '371': ['PA', 'PAN', '', 'Panama'],
+    '372': ['PA', 'PAN', '', 'Panama'],
+    '373': ['PA', 'PAN', '', 'Panama'],
+    '374': ['PA', 'PAN', '', 'Panama'],
+    '375': ['VC', 'VCT', '', 'Saint Vincent and the Grenadines'],
+    '376': ['VC', 'VCT', '', 'Saint Vincent and the Grenadines'],
+    '377': ['VC', 'VCT', '', 'Saint Vincent and the Grenadines'],
+    '378': ['VG', 'VGB', '', 'British Virgin Islands'],
+    '379': ['VI', 'VIR', '', 'United States Virgin Islands'],
+    '401': ['AF', 'AFG', '', 'Afghanistan'],
+    '403': ['SA', 'SAU', '', 'Saudi Arabia'],
+    '405': ['BD', 'BGD', '', 'Bangladesh'],
+    '408': ['BH', 'BHR', '', 'Bahrain'],
+    '410': ['BT', 'BTN', '', 'Bhutan'],
+    '412': ['CN', 'CHN', '', 'China'],
+    '413': ['CN', 'CHN', '', 'China'],
+    '414': ['CN', 'CHN', '', 'China'],
+    '416': ['TW', 'TWN', '', 'Taiwan'],
+    '417': ['LK', 'LKA', '', 'Sri Lanka'],
+    '419': ['IN', 'IND', '', 'India'],
+    '422': ['IR', 'IRN', '', 'Iran'],
+    '423': ['AZ', 'AZE', '', 'Azerbaijan'],
+    '425': ['IQ', 'IRQ', '', 'Iraq'],
+    '428': ['IL', 'ISR', '', 'Israel'],
+    '431': ['JP', 'JPN', '', 'Japan'],
+    '432': ['JP', 'JPN', '', 'Japan'],
+    '434': ['TM', 'TKM', '', 'Turkmenistan'],
+    '436': ['KZ', 'KAZ', '', 'Kazakhstan'],
+    '437': ['UZ', 'UZB', '', 'Uzbekistan'],
+    '438': ['JO', 'JOR', '', 'Jordan'],
+    '440': ['KR', 'KOR', '', 'Korea'],
+    '441': ['KR', 'KOR', '', 'Korea'],
+    '443': ['PS', 'PSE', '', 'State of Palestine'],
+    '445': ['KP', 'PRK', '', "Democratic People's Republic of Korea"],
+    '447': ['KW', 'KWT', '', 'Kuwait'],
+    '450': ['LB', 'LBN', '', 'Lebanon'],
+    '451': ['KG', 'KGZ', '', 'Kyrgyz Republic'],
+    '453': ['MO', 'MAC', '', 'Macao'],
+    '455': ['MV', 'MDV', '', 'Maldives'],
+    '457': ['MN', 'MNG', '', 'Mongolia'],
+    '459': ['NP', 'NPL', '', 'Nepal'],
+    '461': ['OM', 'OMN', '', 'Oman'],
+    '463': ['PK', 'PAK', '', 'Pakistan'],
+    '466': ['QA', 'QAT', '', 'Qatar (State of)'],
+    '468': ['SY', 'SYR', '', 'Syrian Arab Republic'],
+    '470': ['AE', 'ARE', '', 'United Arab Emirates'],
+    '472': ['TJ', 'TJK', '', 'Tajikistan'],
+    '473': ['YE', 'YEM', '', 'Yemen'],
+    '475': ['YE', 'YEM', '', 'Yemen'],
+    '477': ['HK', 'HKG', '', 'Hong Kong'],
+    '478': ['BA', 'BIH', '', 'Bosnia and Herzegovina'],
+    '501': ['FR', 'FRA', 'AQ', 'Adelie Land'],
+    '503': ['AU', 'AUS', '', 'Australia'],
+    '506': ['MM', 'MMR', '', 'Myanmar'],
+    '508': ['BN', 'BRN', '', 'Brunei Darussalam'],
+    '510': ['FM', 'FSM', '', 'Micronesia'],
+    '511': ['PW', 'PLW', '', 'Palau'],
+    '512': ['NZ', 'NZL', '', 'New Zealand'],
+    '514': ['KH', 'KHM', '', 'Cambodia'],
+    '515': ['KH', 'KHM', '', 'Cambodia'],
+    '516': ['CX', 'CXR', '', 'Christmas Island'],
+    '518': ['CK', 'COK', '', 'Cook Islands'],
+    '520': ['FJ', 'FJI', '', 'Fiji'],
+    '523': ['CC', 'CCK', '', 'Cocos (Keeling) Islands'],
+    '525': ['ID', 'IDN', '', 'Indonesia'],
+    '529': ['KI', 'KIR', '', 'Kiribati'],
+    '531': ['LA', 'LAO', '', "Lao People's Democratic Republic"],
+    '533': ['MY', 'MYS', '', 'Malaysia'],
+    '536': ['MP', 'MNP', '', 'Northern Mariana Islands'],
+    '538': ['MH', 'MHL', '', 'Marshall Islands'],
+    '540': ['NC', 'NCL', '', 'New Caledonia'],
+    '542': ['NU', 'NIU', '', 'Niue'],
+    '544': ['NR', 'NRU', '', 'Nauru'],
+    '546': ['PF', 'PYF', '', 'French Polynesia'],
+    '548': ['PH', 'PHL', '', 'Philippines'],
+    '553': ['PG', 'PNG', '', 'Papua New Guinea'],
+    '555': ['PN', 'PCN', '', 'Pitcairn Island'],
+    '557': ['SB', 'SLB', '', 'Solomon Islands'],
+    '559': ['AS', 'ASM', '', 'American Samoa'],
+    '561': ['WS', 'WSM', '', 'Samoa'],
+    '563': ['SG', 'SGP', '', 'Singapore'],
+    '564': ['SG', 'SGP', '', 'Singapore'],
+    '565': ['SG', 'SGP', '', 'Singapore'],
+    '566': ['SG', 'SGP', '', 'Singapore'],
+    '567': ['TH', 'THA', '', 'Thailand'],
+    '570': ['TO', 'TON', '', 'Tonga'],
+    '572': ['TV', 'TUV', '', 'Tuvalu'],
+    '574': ['VN', 'VNM', '', 'Viet Nam'],
+    '576': ['VU', 'VUT', '', 'Vanuatu'],
+    '577': ['VU', 'VUT', '', 'Vanuatu'],
+    '578': ['WF', 'WLF', '', 'Wallis and Futuna Islands'],
+    '601': ['ZA', 'ZAF', '', 'South Africa'],
+    '603': ['AO', 'AGO', '', 'Angola'],
+    '605': ['DZ', 'DZA', '', 'Algeria'],
+    '607': ['FR', 'FRA', 'TF', 'Saint Paul and Amsterdam Islands'],
+    '608': ['GB', 'GBR', 'AC', 'Ascension Island'],
+    '609': ['BI', 'BDI', '', 'Burundi'],
+    '610': ['BJ', 'BEN', '', 'Benin'],
+    '611': ['BW', 'BWA', '', 'Botswana'],
+    '612': ['CF', 'CAF', '', 'Central African Republic'],
+    '613': ['CM', 'CMR', '', 'Cameroon'],
+    '615': ['CG', 'COG', '', 'Congo'],
+    '616': ['KM', 'COM', '', 'Comoros'],
+    '617': ['CV', 'CPV', '', 'Cabo Verde'],
+    '618': ['FR', 'FRA', 'TF', 'Crozet Archipelago'],
+    '619': ['CI', 'CIV', '', 'Ivory Coast'],
+    '620': ['KM', 'COM', '', 'Comoros'],
+    '621': ['DJ', 'DJI', '', 'Djibouti'],
+    '622': ['EG', 'EGY', '', 'Egypt'],
+    '624': ['ET', 'ETH', '', 'Ethiopia'],
+    '625': ['ER', 'ERI', '', 'Eritrea'],
+    '626': ['GA', 'GAB', '', 'Gabonese Republic'],
+    '627': ['GH', 'GHA', '', 'Ghana'],
+    '629': ['GM', 'GMB', '', 'Gambia'],
+    '630': ['GW', 'GNB', '', 'Guinea-Bissau'],
+    '631': ['GQ', 'GNQ', '', 'Equatorial Guinea'],
+    '632': ['GN', 'GIN', '', 'Guinea'],
+    '633': ['BF', 'BFA', '', 'Burkina Faso'],
+    '634': ['KE', 'KEN', '', 'Kenya'],
+    '635': ['FR', 'FRA', 'TF', 'Kerguelen Islands'],
+    '636': ['LR', 'LBR', '', 'Liberia'],
+    '637': ['LR', 'LBR', '', 'Liberia'],
+    '638': ['SS', 'SSD', '', 'South Sudan'],
+    '642': ['LY', 'LBY', '', 'Libya'],
+    '644': ['LS', 'LSO', '', 'Lesotho'],
+    '645': ['MU', 'MUS', '', 'Mauritius'],
+    '647': ['MG', 'MDG', '', 'Madagascar'],
+    '649': ['ML', 'MLI', '', 'Mali'],
+    '650': ['MZ', 'MOZ', '', 'Mozambique'],
+    '654': ['MR', 'MRT', '', 'Mauritania'],
+    '655': ['MW', 'MWI', '', 'Malawi'],
+    '656': ['NE', 'NER', '', 'Niger'],
+    '657': ['NG', 'NGA', '', 'Nigeria'],
+    '659': ['NA', 'NAM', '', 'Namibia'],
+    '660': ['RE', 'REU', '', 'Reunion'],
+    '661': ['RW', 'RWA', '', 'Rwanda'],
+    '662': ['SD', 'SDN', '', 'Sudan'],
+    '663': ['SN', 'SEN', '', 'Senegal'],
+    '664': ['SC', 'SYC', '', 'Seychelles'],
+    '665': ['SH', 'SHN', '', 'Saint Helena'],
+    '666': ['SO', 'SOM', '', 'Somali Democratic Republic'],
+    '667': ['SL', 'SLE', '', 'Sierra Leone'],
+    '668': ['ST', 'STP', '', 'Sao Tome and Principe'],
+    '669': ['SZ', 'SWZ', '', 'Swaziland'],
+    '670': ['TD', 'TCD', '', 'Chad'],
+    '671': ['TG', 'TGO', '', 'Togolese Republic'],
+    '672': ['TN', 'TUN', '', 'Tunisian Republic'],
+    '674': ['TZ', 'TZA', '', 'Tanzania'],
+    '675': ['UG', 'UGA', '', 'Uganda'],
+    '676': ['CD', 'COD', '', 'Democratic Republic of the Congo'],
+    '677': ['TZ', 'TZA', '', 'Tanzania'],
+    '678': ['ZM', 'ZMB', '', 'Zambia'],
+    '679': ['ZW', 'ZWE', '', 'Zimbabwe'],
+    '701': ['AR', 'ARG', '', 'Argentine Republic'],
+    '710': ['BR', 'BRA', '', 'Brazil'],
+    '720': ['BO', 'BOL', '', 'Bolivia'],
+    '725': ['CL', 'CHL', '', 'Chile'],
+    '730': ['CO', 'COL', '', 'Colombia'],
+    '735': ['EC', 'ECU', '', 'Ecuador'],
+    '740': ['FK', 'FLK', '', 'Falkland Islands'],
+    '745': ['GF', 'GUF', '', 'Guiana'],
+    '750': ['GY', 'GUY', '', 'Guyana'],
+    '755': ['PY', 'PRY', '', 'Paraguay'],
+    '760': ['PE', 'PER', '', 'Peru'],
+    '765': ['SR', 'SUR', '', 'Suriname'],
+    '770': ['UY', 'URY', '', 'Uruguay'],
+    '775': ['VE', 'VEN', '', 'Venezuela']
+};

package/plugin/openApi.json

@@ -0,0 +1,175 @@
+{
+    "openapi": "3.0.0",
+    "info": {
+        "version": "2.5.0",
+        "title": "Signal K Flags API",
+        "description": "API endpoints exposed by `signalk-flags` plugin for displaying flags based on MMSI or country code.",
+        "termsOfService": "http://signalk.org/terms/",
+        "license": {
+            "name": "Apache 2.0",
+            "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
+        }
+    },
+    "externalDocs": {
+        "url": "http://signalk.org/specification/",
+        "description": "Signal K specification."
+    },
+    "servers": [
+        {
+            "url": "/"
+        }
+    ],
+    "tags": [
+        {
+            "name": "Flags",
+            "description": "Endpoints for retrieving country flags."
+        }
+    ],
+    "components": {
+        "schemas": {},
+        "responses": {
+            "200OKResponse": {
+                "description": "Successful operation",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "type": "object",
+                            "description": "Request success response",
+                            "properties": {
+                                "state": {
+                                    "type": "string",
+                                    "enum": ["COMPLETED"]
+                                },
+                                "statusCode": {
+                                    "type": "number",
+                                    "enum": [200]
+                                }
+                            },
+                            "required": ["state", "statusCode"]
+                        }
+                    }
+                }
+            },
+            "ErrorResponse": {
+                "description": "Failed operation",
+                "content": {
+                    "application/json": {
+                        "schema": {
+                            "type": "object",
+                            "description": "Request error response",
+                            "properties": {
+                                "state": {
+                                    "type": "string",
+                                    "enum": ["FAILED"]
+                                },
+                                "statusCode": {
+                                    "type": "number",
+                                    "enum": [404]
+                                },
+                                "message": {
+                                    "type": "string"
+                                }
+                            },
+                            "required": ["state", "statusCode", "message"]
+                        }
+                    }
+                }
+            }
+        },
+        "parameters": {
+            "mmsi": {
+                "in": "path",
+                "required": true,
+                "name": "mmsi",
+                "description": "Maritime Mobile Service Identity (MMSI).",
+                "schema": {
+                    "type": "number",
+                    "minLength": 9,
+                    "maxLength": 9,
+                    "example": 520345561
+                }
+            },
+            "countryCode": {
+                "in": "path",
+                "required": true,
+                "name": "code",
+                "description": "Two letter country code.",
+                "schema": {
+                    "type": "string",
+                    "minLength": 2,
+                    "maxLength": 2,
+                    "example": "al"
+                }
+            },
+            "aspect": {
+                "in": "query",
+                "required": false,
+                "name": "aspect",
+                "description": "Aspect of flag image to return. 4x3 (default)",
+                "schema": {
+                    "type": "string",
+                    "enum": ["4x3", "1x1"]
+                }
+            }
+        },
+        "securitySchemes": {
+            "bearerAuth": {
+                "type": "http",
+                "scheme": "bearer",
+                "bearerFormat": "JWT"
+            },
+            "cookieAuth": {
+                "type": "apiKey",
+                "in": "cookie",
+                "name": "JAUTHENTICATION"
+            }
+        }
+    },
+    "security": [{ "cookieAuth": [] }, { "bearerAuth": [] }],
+    "paths": {
+        "/signalk/v2/api/resources/flags/mmsi/{mmsi}": {
+            "parameters": [
+                {
+                    "$ref": "#/components/parameters/mmsi"
+                },
+                {
+                    "$ref": "#/components/parameters/aspect"
+                }
+            ],
+            "get": {
+                "tags": ["Flags"],
+                "summary": "Returns flag for supplied MMSI.",
+                "responses": {
+                    "default": {
+                        "description": "Return SVG content for flag derived from the supplied MMSI.",
+                        "content": {
+                            "image/svg+xml": {}
+                        }
+                    }
+                }
+            }
+        },
+        "/signalk/v2/api/resources/flags/country/{code}": {
+            "parameters": [
+                {
+                    "$ref": "#/components/parameters/countryCode"
+                },
+                {
+                    "$ref": "#/components/parameters/aspect"
+                }
+            ],
+            "get": {
+                "tags": ["Flags"],
+                "summary": "Returns flag for supplied country code.",
+                "responses": {
+                    "default": {
+                        "description": "Return SVG content for flag derived from the supplied country code.",
+                        "content": {
+                            "image/svg+xml": {}
+                        }
+                    }
+                }
+            }
+        }
+    }
+}