@signalk/server-api 2.8.0 → 2.9.0

package/dist/mmsi/mid.js

@@ -0,0 +1,301 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MID = exports.mid2Country = void 0;
+const mid2Country = (mid) => exports.MID[mid];
+exports.mid2Country = mid2Country;
+// source: https://github.com/michaeljfazio/MIDs/blob/master/mids.json
+exports.MID = Object.entries({
+    '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']
+}).reduce((acc, [key, [alpha2, alpha3, _unused, name]]) => {
+    acc[key] = { alpha2, alpha3, name };
+    return acc;
+}, {});

package/dist/mmsi/mmsi.d.ts

@@ -0,0 +1,75 @@
+import { FlagCountry } from './mid';
+export { FlagCountry } from './mid';
+export type MMSISourceType = 'ship' | 'coastalStation' | 'group' | 'aton' | 'auxiliaryCraft' | 'sart' | 'sarAircraft' | 'mobDevice' | 'epirb' | 'diverRadio';
+/** @category MMSI */
+export interface MMSIInfo {
+    /** Maritime identifier */
+    mid: number;
+    /** Mobile station identifier */
+    msi: number;
+    /** Source type */
+    type?: MMSISourceType;
+    /** Two character country code */
+    flagCountry?: FlagCountry;
+}
+/**
+ * Parse the supplied MMSI value into object containing mid, msi, type and flagCountry.
+ *
+ * @example
+ * ```javascript
+ * app.parseMmsi('201456789')
+ *
+ * returns: {
+ *   mid: 201,
+ *   msi: 456789,
+ *   type: 'ship',
+ *   flagCountry: {
+ *     alpha2: 'AL',
+ *     alpha3: 'ALB',
+ *     name: 'Albania'
+ *   }
+ * }
+ * ```
+ *
+ * @param mmsi - MMSI.
+ *
+ * @category MMSI
+ */
+export declare const parseMmsi: (mmsi: string) => MMSIInfo | null;
+/**
+ * Return the two letter country code for the MID from the supplied MMSI.
+ *
+ * @example
+ * ```javascript
+ * app.getFlag('201456789')
+
+* returns: 'AL'
+* ```
+*
+* @param mmsi - MMSI.
+* @returns Two letter country code.
+*
+* @category MMSI
+*/
+export declare const getFlag: (mmsi: string) => string | null;
+/**
+ * Return the flag country information for the MID from the supplied MMSI.
+ *
+ * @example
+ * ```javascript
+ * app.getFlagCountry('201456789')
+ *
+ * returns: {
+ *   alpha2: 'AL',
+ *   alpha3: 'ALB',
+ *   name: 'Albania'
+ * }
+ * ```
+ *
+ * @param mmsi - MMSI.
+ * @returns Flag country information with ISO codes and name, or null if not found.
+ *
+ * @category MMSI
+ */
+export declare const getFlagCountry: (mmsi: string) => FlagCountry | null;
+//# sourceMappingURL=mmsi.d.ts.map

package/dist/mmsi/mmsi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mmsi.d.ts","sourceRoot":"","sources":["../../src/mmsi/mmsi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAe,MAAM,OAAO,CAAA;AAEhD,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAA;AAEnC,MAAM,MAAM,cAAc,GACtB,MAAM,GACN,gBAAgB,GAChB,OAAO,GACP,MAAM,GACN,gBAAgB,GAChB,MAAM,GACN,aAAa,GACb,WAAW,GACX,OAAO,GACP,YAAY,CAAA;AAEhB,qBAAqB;AACrB,MAAM,WAAW,QAAQ;IACvB,0BAA0B;IAC1B,GAAG,EAAE,MAAM,CAAA;IACX,gCAAgC;IAChC,GAAG,EAAE,MAAM,CAAA;IACX,kBAAkB;IAClB,IAAI,CAAC,EAAE,cAAc,CAAA;IACrB,iCAAiC;IACjC,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,SAAS,GAAI,MAAM,MAAM,KAAG,QAAQ,GAAG,IAkFnD,CAAA;AAED;;;;;;;;;;;;;;EAcE;AACF,eAAO,MAAM,OAAO,GAAI,MAAM,MAAM,KAAG,MAAM,GAAG,IAG/C,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,cAAc,GAAI,MAAM,MAAM,KAAG,WAAW,GAAG,IAG3D,CAAA"}

package/dist/mmsi/mmsi.js

@@ -0,0 +1,165 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFlagCountry = exports.getFlag = exports.parseMmsi = void 0;
+const mid_1 = require("./mid");
+/**
+ * Parse the supplied MMSI value into object containing mid, msi, type and flagCountry.
+ *
+ * @example
+ * ```javascript
+ * app.parseMmsi('201456789')
+ *
+ * returns: {
+ *   mid: 201,
+ *   msi: 456789,
+ *   type: 'ship',
+ *   flagCountry: {
+ *     alpha2: 'AL',
+ *     alpha3: 'ALB',
+ *     name: 'Albania'
+ *   }
+ * }
+ * ```
+ *
+ * @param mmsi - MMSI.
+ *
+ * @category MMSI
+ */
+const parseMmsi = (mmsi) => {
+    if (typeof mmsi !== 'string') {
+        return null;
+    }
+    let info;
+    try {
+        if (mmsi.startsWith('00')) {
+            // coast station
+            info = {
+                mid: parseInt(mmsi.slice(2, 5)),
+                msi: parseInt(mmsi.slice(5)),
+                type: 'coastalStation'
+            };
+        }
+        else if (mmsi.startsWith('0')) {
+            // Group of ships
+            info = {
+                mid: parseInt(mmsi.slice(1, 4)),
+                msi: parseInt(mmsi.slice(4)),
+                type: 'group'
+            };
+        }
+        else if (mmsi.startsWith('99')) {
+            // AtoN
+            info = {
+                mid: parseInt(mmsi.slice(2, 5)),
+                msi: parseInt(mmsi.slice(5)),
+                type: 'aton'
+            };
+        }
+        else if (mmsi.startsWith('98')) {
+            // Aux craft associated with parent ship
+            info = {
+                mid: parseInt(mmsi.slice(2, 5)),
+                msi: parseInt(mmsi.slice(5)),
+                type: 'auxiliaryCraft'
+            };
+        }
+        else if (mmsi.startsWith('970')) {
+            // SART transmitter
+            info = {
+                mid: parseInt(mmsi.slice(3, 6)),
+                msi: parseInt(mmsi.slice(6)),
+                type: 'sart'
+            };
+        }
+        else if (mmsi.startsWith('972')) {
+            // MOB device
+            info = {
+                mid: parseInt(mmsi.slice(3, 6)),
+                msi: parseInt(mmsi.slice(6)),
+                type: 'mobDevice'
+            };
+        }
+        else if (mmsi.startsWith('974')) {
+            // EPIRB
+            info = {
+                mid: parseInt(mmsi.slice(3, 6)),
+                msi: parseInt(mmsi.slice(6)),
+                type: 'epirb'
+            };
+        }
+        else if (mmsi.startsWith('8')) {
+            // diver
+            info = {
+                mid: parseInt(mmsi.slice(1, 4)),
+                msi: parseInt(mmsi.slice(4)),
+                type: 'diverRadio'
+            };
+        }
+        else if (mmsi.startsWith('111')) {
+            // SaR
+            info = {
+                mid: parseInt(mmsi.slice(3, 6)),
+                msi: parseInt(mmsi.slice(6)),
+                type: 'sarAircraft'
+            };
+        }
+        else {
+            // ship
+            info = {
+                mid: parseInt(mmsi.slice(0, 3)),
+                msi: parseInt(mmsi.slice(3)),
+                type: 'ship'
+            };
+        }
+        info.flagCountry = (0, mid_1.mid2Country)(info.mid.toString()) ?? undefined;
+        return info;
+    }
+    catch {
+        return null;
+    }
+};
+exports.parseMmsi = parseMmsi;
+/**
+ * Return the two letter country code for the MID from the supplied MMSI.
+ *
+ * @example
+ * ```javascript
+ * app.getFlag('201456789')
+
+* returns: 'AL'
+* ```
+*
+* @param mmsi - MMSI.
+* @returns Two letter country code.
+*
+* @category MMSI
+*/
+const getFlag = (mmsi) => {
+    const m = (0, exports.parseMmsi)(mmsi);
+    return m?.flagCountry?.alpha2 ?? null;
+};
+exports.getFlag = getFlag;
+/**
+ * Return the flag country information for the MID from the supplied MMSI.
+ *
+ * @example
+ * ```javascript
+ * app.getFlagCountry('201456789')
+ *
+ * returns: {
+ *   alpha2: 'AL',
+ *   alpha3: 'ALB',
+ *   name: 'Albania'
+ * }
+ * ```
+ *
+ * @param mmsi - MMSI.
+ * @returns Flag country information with ISO codes and name, or null if not found.
+ *
+ * @category MMSI
+ */
+const getFlagCountry = (mmsi) => {
+    const m = (0, exports.parseMmsi)(mmsi);
+    return m?.flagCountry ?? null;
+};
+exports.getFlagCountry = getFlagCountry;

package/dist/mmsi/mmsi.test.d.ts

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

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

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

package/dist/plugin.d.ts

@@ -3,6 +3,7 @@ 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.
+ *  @category Server API
  */
 export type PluginConstructor = (app: ServerAPI) => Plugin;
 /**
@@ -46,6 +47,7 @@ export type PluginConstructor = (app: ServerAPI) => Plugin;
  *   return plugin;
  * }
  * ```
+ * @category Server API
  * @see [Developing Server Plugins](../../../docs/develop/plugins/README.md)
  */
 export interface Plugin {

package/dist/plugin.d.ts.map

@@ -1 +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"}
+{"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;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,GAAG,EAAE,SAAS,KAAK,MAAM,CAAA;AAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;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/propertyvalues.d.ts

@@ -31,6 +31,7 @@
  * **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.
+ * @category Server API
  */
 export interface PropertyValuesEmitter {
     /**
@@ -42,13 +43,16 @@ export interface PropertyValuesEmitter {
      */
     onPropertyValues(name: string, cb: PropertyValuesCallback): Unsubscribe;
 }
+/** @category Server API */
 export interface PropertyValue {
     timestamp: number;
     setter: string;
     name: string;
     value: any;
 }
+/** @category Server API */
 export type PropertyValuesCallback = (propValuesHistory: PropertyValue[]) => void;
+/** @category Server API */
 export declare class PropertyValues {
     private streams;
     private count;
@@ -59,6 +63,7 @@ export declare class PropertyValues {
 }
 /**
  * @inline
+ * @category Server API
  */
 type Unsubscribe = () => void;
 export {};

package/dist/propertyvalues.d.ts.map

@@ -1 +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"}
+{"version":3,"file":"propertyvalues.d.ts","sourceRoot":"","sources":["../src/propertyvalues.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;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,2BAA2B;AAC3B,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,2BAA2B;AAC3B,MAAM,MAAM,sBAAsB,GAAG,CACnC,iBAAiB,EAAE,aAAa,EAAE,KAC/B,IAAI,CAAA;AAST,2BAA2B;AAC3B,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;;;GAGG;AACH,KAAK,WAAW,GAAG,MAAM,IAAI,CAAA"}

package/dist/propertyvalues.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PropertyValues = void 0;
 const baconjs_1 = __importDefault(require("baconjs"));
+/** @category Server API */
 class PropertyValues {
     streams = {};
     count = 0;