signalk-navico-routes 1.0.0

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,122 @@
+# Navico Route Sync (signalk-navico-routes)
+
+Sync the **routes** and **waypoints** from your Navico chartplotter — B&G
+Zeus, Simrad NSS/NSX, Lowrance HDS, etc to [SignalK](https://signalk.org/),
+and send routes from SignalK back to the chartplotter when you choose.
+
+The plugin talks to the chartplotter over your boat's regular Ethernet/Wi-Fi
+network using the MFD's built-in file service. No NMEA 2000 gateway or extra
+hardware is needed — just the MFD and the SignalK server on the same network.
+
+## Features
+
+- **Automatic MFD → SignalK mirror.** All routes and waypoints on the
+  chartplotter appear in SignalK's standard resources API
+  (`/signalk/v2/api/resources/routes` and `/waypoints`), refreshed on a
+  configurable schedule, so any SignalK app (Freeboard, etc.) can display them.
+- **Multi-MFD friendly.** Point the plugin at the master chartplotter; Navico's
+  own sync spreads uploads to the rest of the network.
+- **A webapp for sending routes the other way.** Pick routes from SignalK
+  and push them to the chartplotter, or download backups and GPX exports —
+  all from the SignalK admin UI. With [signalk-navico-embedder](http://npmjs.com/signalk-navico-embedder) you can manage the sync from the MFD itself.
+
+## Installation
+
+Install **Navico Route Sync** from the SignalK Appstore (or `npm install
+signalk-navico-routes` in your server directory), then enable it under
+**Server → Plugin Config**. Chartplotters on the network are discovered
+automatically; you can also pin one by IP address.
+
+## Configuration
+
+| Setting                 | Default | Description                                             |
+| ----------------------- | ------- | ------------------------------------------------------- |
+| `mfdAddress`            | —       | IP address or hostname of the chartplotter. Leave empty to auto-discover (see below) |
+| `syncFromMfd`           | `true`  | Enable the MFD → SignalK mirror                         |
+| `syncRoutes`            | `true`  | Mirror MFD routes into SignalK                          |
+| `syncVisibleRoutesOnly` | `true`  | Skip routes that are hidden on the MFD                  |
+| `syncWaypoints`         | `true`  | Mirror free-standing MFD waypoints                      |
+| `pollIntervalSeconds`   | `600`   | How often to refresh from the MFD, in seconds (min 30; 0 turns polling off) |
+
+### Auto-discovery
+
+Navico chartplotters announce themselves on the network (GoFree multicast)
+about once a second, and the plugin listens the whole time it runs. The
+config panel lists every discovered chartplotter with its role
+(master/slave) — click one to fill in the address field, or leave the field
+empty and the plugin syncs with whatever it finds: the master first, falling
+back to the others if it doesn't answer. Chartplotters that turn on or off
+while the plugin is running appear and disappear from the list on their own.
+
+With an empty address there is nothing to reconfigure when your boat
+network hands out new DHCP leases. If you do pin an address, give the
+chartplotter a static IP (or a DHCP reservation in your router) so it
+stays valid.
+
+**No chartplotters showing up?** Run `node scripts/gofree-watch.mjs` on the
+SignalK machine — it listens the same way the plugin does and prints every
+announcement it hears, so you can tell "nothing on the wire" apart from a
+receive problem. One known receive problem: the Raspberry Pi 4's onboard
+Ethernet can silently drop multicast even though everything is configured
+correctly. If the watch script hears nothing while
+`sudo tcpdump -i eth0 host 239.2.1.1` shows traffic, that's it — running
+tcpdump itself (or `sudo ifconfig eth0 allmulti`) resets the network
+interface's filter and discovery starts working.
+
+## How syncing works
+
+**The chartplotter is the source of truth.** The plugin periodically
+downloads the MFD's user database and mirrors it into SignalK — including
+deletions, so removing a route on the MFD removes it from SignalK too. The
+routes and waypoints it mirrors are read-only in SignalK; you can't edit
+them through the resources API.
+
+Going the other direction is deliberately manual: Navico chartplotters only
+ever **add** routes from an upload — they never overwrite or delete existing
+ones — so a fully automatic two-way sync isn't possible. Instead, you choose
+which routes to send using the webapp.
+
+## The webapp
+
+Open **Navico Routes** from the _Webapps_ screen in the SignalK admin UI. It
+lists every SignalK route that didn't come from the chartplotter (e.g.
+routes you planned in another app) in a sortable, searchable table, and lets
+you:
+
+- **Sync MFD → SignalK** — refresh from the chartplotter right now instead
+  of waiting for the next scheduled poll.
+- **Download MFD routes** — save the chartplotter's complete user database
+  as a `.usr` backup, or its routes and waypoints as a `.gpx` file.
+- **Download selected** — export the routes you've selected as a `.usr`
+  file (to import on another Navico chartplotter via SD card) or as GPX.
+- **Send selected to MFD** — upload the selected routes straight to the
+  chartplotter.
+
+A few things worth knowing:
+
+- **Uploads are additive.** Sending an edited route again creates a second
+  copy on the chartplotter rather than replacing the first — delete the
+  outdated copy on the MFD itself.
+- **Back up first.** Uploads can't be undone, so grab a `.usr` backup
+  before sending anything you're unsure about.
+- **Route names** are editable in the table and capped at 16 characters
+  (the MFD's on-screen keyboard limit). SignalK keeps the full name, and
+  GPX exports use it unless you renamed the route in the table.
+- The page has a day/night toggle and also follows your OS theme (or a
+  `?mode=day` / `?mode=night` URL parameter).
+
+## Known limitations
+
+1. Route and waypoint names longer than 32 characters are shortened when
+   sent to the chartplotter; SignalK keeps the full name.
+
+## For developers
+
+Build instructions, the plugin's HTTP API, protocol research notes, and the
+reverse-engineered USR v6 file format are documented in
+[docs/DEVELOPMENT.md](docs/DEVELOPMENT.md) and
+[docs/usr-v6-format.md](docs/usr-v6-format.md).
+
+## License
+
+See [LICENSE](LICENSE).

package/dist/discovery.d.ts

@@ -0,0 +1,64 @@
+/**
+ * GoFree multicast auto-discovery.
+ *
+ * Navico MFDs announce themselves about once a second as a JSON datagram on
+ * multicast 239.2.1.1:2052 (`IP`, `Model`, `Name`, `UDBMaster`,
+ * `NetworkMaster`, `Services[]`, …). This listener runs for the whole plugin
+ * lifetime — MFDs come and go while the plugin is running — and keeps a map
+ * of the devices currently announcing, expiring entries that have gone
+ * quiet.
+ *
+ * Only devices advertising an `http` service are kept: that is the GoFree
+ * file server (download.cgi / upload.cgi) the plugin talks to. Other Navico
+ * gear announces on the same group without it (e.g. an H5000 CPU) and is of
+ * no use here.
+ */
+import type { Logger } from './types';
+export declare const GOFREE_GROUP = "239.2.1.1";
+export declare const GOFREE_PORT = 2052;
+/** An MFD currently announcing itself on the GoFree multicast group. */
+export interface DiscoveredMfd {
+    /** Source address of the announcement — known to be reachable from here. */
+    address: string;
+    model: string;
+    name: string;
+    /** Owns the Unified DataBase (routes/waypoints) — the preferred sync peer. */
+    udbMaster: boolean;
+    networkMaster: boolean;
+    lastSeen: Date;
+}
+export interface MfdDiscoveryOptions {
+    /** Listen port; 0 picks an ephemeral port (tests). Default 2052. */
+    port?: number;
+    staleAfterMs?: number;
+    now?: () => Date;
+}
+export declare class MfdDiscovery {
+    private readonly log;
+    private readonly listenPort;
+    private readonly staleAfterMs;
+    private readonly now;
+    private readonly mfds;
+    private socket?;
+    private retryTimer?;
+    private stopped;
+    constructor(log: Logger, options?: MfdDiscoveryOptions);
+    start(): void;
+    stop(): void;
+    /** Bound UDP port, once listening (tests bind port 0). */
+    get port(): number | undefined;
+    /** MFDs announcing right now, UDB master first. */
+    list(): DiscoveredMfd[];
+    /** Addresses to try for MFD I/O, in preference order (master first). */
+    candidates(): string[];
+    /**
+     * Digest one announcement datagram. Public so tests can feed messages
+     * without a socket. Malformed or irrelevant datagrams are ignored.
+     */
+    handleAnnouncement(msg: Buffer, fromAddress: string): void;
+    private openSocket;
+    private joinGroup;
+    private closeSocket;
+    private scheduleRetry;
+    private prune;
+}

package/dist/discovery.js

@@ -0,0 +1,188 @@
+"use strict";
+/**
+ * GoFree multicast auto-discovery.
+ *
+ * Navico MFDs announce themselves about once a second as a JSON datagram on
+ * multicast 239.2.1.1:2052 (`IP`, `Model`, `Name`, `UDBMaster`,
+ * `NetworkMaster`, `Services[]`, …). This listener runs for the whole plugin
+ * lifetime — MFDs come and go while the plugin is running — and keeps a map
+ * of the devices currently announcing, expiring entries that have gone
+ * quiet.
+ *
+ * Only devices advertising an `http` service are kept: that is the GoFree
+ * file server (download.cgi / upload.cgi) the plugin talks to. Other Navico
+ * gear announces on the same group without it (e.g. an H5000 CPU) and is of
+ * no use here.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MfdDiscovery = exports.GOFREE_PORT = exports.GOFREE_GROUP = void 0;
+const node_dgram_1 = require("node:dgram");
+const node_os_1 = require("node:os");
+exports.GOFREE_GROUP = '239.2.1.1';
+exports.GOFREE_PORT = 2052;
+/** How long an MFD may stay silent before it is considered gone. */
+const DEFAULT_STALE_AFTER_MS = 60_000;
+/** Delay before re-opening the socket after an error. */
+const RETRY_AFTER_MS = 30_000;
+class MfdDiscovery {
+    log;
+    listenPort;
+    staleAfterMs;
+    now;
+    mfds = new Map();
+    socket;
+    retryTimer;
+    stopped = false;
+    constructor(log, options = {}) {
+        this.log = log;
+        this.listenPort = options.port ?? exports.GOFREE_PORT;
+        this.staleAfterMs = options.staleAfterMs ?? DEFAULT_STALE_AFTER_MS;
+        this.now = options.now ?? (() => new Date());
+    }
+    start() {
+        this.stopped = false;
+        this.openSocket();
+    }
+    stop() {
+        this.stopped = true;
+        if (this.retryTimer) {
+            clearTimeout(this.retryTimer);
+            this.retryTimer = undefined;
+        }
+        this.closeSocket();
+    }
+    /** Bound UDP port, once listening (tests bind port 0). */
+    get port() {
+        try {
+            return this.socket?.address().port;
+        }
+        catch {
+            return undefined; // not bound yet
+        }
+    }
+    /** MFDs announcing right now, UDB master first. */
+    list() {
+        this.prune();
+        return [...this.mfds.values()].sort((a, b) => Number(b.udbMaster) - Number(a.udbMaster) ||
+            Number(b.networkMaster) - Number(a.networkMaster) ||
+            a.address.localeCompare(b.address, undefined, { numeric: true }));
+    }
+    /** Addresses to try for MFD I/O, in preference order (master first). */
+    candidates() {
+        return this.list().map((m) => m.address);
+    }
+    /**
+     * Digest one announcement datagram. Public so tests can feed messages
+     * without a socket. Malformed or irrelevant datagrams are ignored.
+     */
+    handleAnnouncement(msg, fromAddress) {
+        let parsed;
+        try {
+            parsed = JSON.parse(msg.toString('utf8'));
+        }
+        catch {
+            return;
+        }
+        if (typeof parsed !== 'object' || parsed === null) {
+            return;
+        }
+        const ann = parsed;
+        // No http service → no GoFree file server → nothing to sync with.
+        const services = Array.isArray(ann.Services) ? ann.Services : [];
+        const hasHttp = services.some((s) => typeof s === 'object' && s !== null && s.Service === 'http');
+        if (!hasHttp) {
+            return;
+        }
+        const model = typeof ann.Model === 'string' ? ann.Model : '';
+        const mfd = {
+            address: fromAddress,
+            model,
+            name: typeof ann.Name === 'string' ? ann.Name : model,
+            udbMaster: ann.UDBMaster === true,
+            networkMaster: ann.NetworkMaster === true,
+            lastSeen: this.now(),
+        };
+        const known = this.mfds.get(fromAddress);
+        if (!known) {
+            this.log.debug(`discovered MFD ${mfd.name || fromAddress} at ${fromAddress}` +
+                (mfd.udbMaster ? ' (UDB master)' : ''));
+        }
+        else if (known.udbMaster !== mfd.udbMaster) {
+            this.log.debug(`MFD at ${fromAddress} is ${mfd.udbMaster ? 'now' : 'no longer'} the UDB master`);
+        }
+        this.mfds.set(fromAddress, mfd);
+    }
+    // ── Socket plumbing ──────────────────────────────────────────────────────
+    openSocket() {
+        // reuseAddr so we can share port 2052 with other GoFree-aware software.
+        const socket = (0, node_dgram_1.createSocket)({ type: 'udp4', reuseAddr: true });
+        this.socket = socket;
+        socket.on('error', (err) => {
+            this.log.error(`GoFree discovery socket error: ${err.message}`);
+            this.closeSocket();
+            this.scheduleRetry();
+        });
+        socket.on('message', (msg, rinfo) => this.handleAnnouncement(msg, rinfo.address));
+        socket.bind(this.listenPort, () => this.joinGroup(socket));
+    }
+    joinGroup(socket) {
+        // Join on the default interface and on every external IPv4 interface:
+        // the boat network is often not the default route. Duplicate or
+        // unsupported joins are fine to ignore.
+        const interfaces = new Set([undefined]);
+        for (const addrs of Object.values((0, node_os_1.networkInterfaces)())) {
+            for (const a of addrs ?? []) {
+                if (a.family === 'IPv4' && !a.internal) {
+                    interfaces.add(a.address);
+                }
+            }
+        }
+        let joined = 0;
+        for (const iface of interfaces) {
+            try {
+                socket.addMembership(exports.GOFREE_GROUP, iface);
+                joined++;
+            }
+            catch (err) {
+                this.log.debug(`could not join ${exports.GOFREE_GROUP} on ${iface ?? 'default interface'}: ${String(err)}`);
+            }
+        }
+        if (joined === 0) {
+            this.log.error(`could not join GoFree multicast group ${exports.GOFREE_GROUP} on any interface`);
+        }
+    }
+    closeSocket() {
+        const socket = this.socket;
+        this.socket = undefined;
+        if (socket) {
+            try {
+                socket.close();
+            }
+            catch {
+                // already closed
+            }
+        }
+    }
+    scheduleRetry() {
+        if (this.stopped || this.retryTimer) {
+            return;
+        }
+        this.retryTimer = setTimeout(() => {
+            this.retryTimer = undefined;
+            if (!this.stopped) {
+                this.openSocket();
+            }
+        }, RETRY_AFTER_MS);
+    }
+    prune() {
+        const cutoff = this.now().getTime() - this.staleAfterMs;
+        for (const [address, mfd] of this.mfds) {
+            if (mfd.lastSeen.getTime() < cutoff) {
+                this.mfds.delete(address);
+                this.log.debug(`MFD at ${address} stopped announcing; dropped from discovery`);
+            }
+        }
+    }
+}
+exports.MfdDiscovery = MfdDiscovery;
+//# sourceMappingURL=discovery.js.map

package/dist/discovery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"discovery.js","sourceRoot":"","sources":["../src/discovery.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,2CAA0C;AAC1C,qCAA4C;AAI/B,QAAA,YAAY,GAAG,WAAW,CAAC;AAC3B,QAAA,WAAW,GAAG,IAAI,CAAC;AAEhC,oEAAoE;AACpE,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAEtC,yDAAyD;AACzD,MAAM,cAAc,GAAG,MAAM,CAAC;AAqB9B,MAAa,YAAY;IAUJ;IATF,UAAU,CAAS;IACnB,YAAY,CAAS;IACrB,GAAG,CAAa;IAChB,IAAI,GAAG,IAAI,GAAG,EAAyB,CAAC;IACjD,MAAM,CAAU;IAChB,UAAU,CAAkB;IAC5B,OAAO,GAAG,KAAK,CAAC;IAExB,YACmB,GAAW,EAC5B,UAA+B,EAAE;QADhB,QAAG,GAAH,GAAG,CAAQ;QAG5B,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,mBAAW,CAAC;QAC9C,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,sBAAsB,CAAC;QACnE,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK;QACH,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAED,IAAI;QACF,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC9B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC9B,CAAC;QACD,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC;IAED,0DAA0D;IAC1D,IAAI,IAAI;QACN,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,IAAI,CAAC;QACrC,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,SAAS,CAAC,CAAC,gBAAgB;QACpC,CAAC;IACH,CAAC;IAED,mDAAmD;IACnD,IAAI;QACF,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,OAAO,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CACjC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACP,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YACzC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC;YACjD,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CACnE,CAAC;IACJ,CAAC;IAED,wEAAwE;IACxE,UAAU;QACR,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACH,kBAAkB,CAAC,GAAW,EAAE,WAAmB;QACjD,IAAI,MAAe,CAAC;QACpB,IAAI,CAAC;YACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;QAC5C,CAAC;QAAC,MAAM,CAAC;YACP,OAAO;QACT,CAAC;QACD,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YAClD,OAAO;QACT,CAAC;QACD,MAAM,GAAG,GAAG,MAMX,CAAC;QACF,kEAAkE;QAClE,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;QACjE,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAC3B,CAAC,CAAU,EAAE,EAAE,CACb,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,IAAK,CAA2B,CAAC,OAAO,KAAK,MAAM,CACzF,CAAC;QACF,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7D,MAAM,GAAG,GAAkB;YACzB,OAAO,EAAE,WAAW;YACpB,KAAK;YACL,IAAI,EAAE,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK;YACrD,SAAS,EAAE,GAAG,CAAC,SAAS,KAAK,IAAI;YACjC,aAAa,EAAE,GAAG,CAAC,aAAa,KAAK,IAAI;YACzC,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE;SACrB,CAAC;QAEF,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACzC,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,IAAI,CAAC,GAAG,CAAC,KAAK,CACZ,kBAAkB,GAAG,CAAC,IAAI,IAAI,WAAW,OAAO,WAAW,EAAE;gBAC3D,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CACzC,CAAC;QACJ,CAAC;aAAM,IAAI,KAAK,CAAC,SAAS,KAAK,GAAG,CAAC,SAAS,EAAE,CAAC;YAC7C,IAAI,CAAC,GAAG,CAAC,KAAK,CACZ,UAAU,WAAW,OAAO,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,iBAAiB,CACjF,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;IAClC,CAAC;IAED,4EAA4E;IAEpE,UAAU;QAChB,wEAAwE;QACxE,MAAM,MAAM,GAAG,IAAA,yBAAY,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/D,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YACzB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,kCAAkC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;YAChE,IAAI,CAAC,WAAW,EAAE,CAAC;YACnB,IAAI,CAAC,aAAa,EAAE,CAAC;QACvB,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QAClF,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7D,CAAC;IAEO,SAAS,CAAC,MAAc;QAC9B,sEAAsE;QACtE,gEAAgE;QAChE,wCAAwC;QACxC,MAAM,UAAU,GAAG,IAAI,GAAG,CAAqB,CAAC,SAAS,CAAC,CAAC,CAAC;QAC5D,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,IAAA,2BAAiB,GAAE,CAAC,EAAE,CAAC;YACvD,KAAK,MAAM,CAAC,IAAI,KAAK,IAAI,EAAE,EAAE,CAAC;gBAC5B,IAAI,CAAC,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;oBACvC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;gBAC5B,CAAC;YACH,CAAC;QACH,CAAC;QACD,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,KAAK,MAAM,KAAK,IAAI,UAAU,EAAE,CAAC;YAC/B,IAAI,CAAC;gBACH,MAAM,CAAC,aAAa,CAAC,oBAAY,EAAE,KAAK,CAAC,CAAC;gBAC1C,MAAM,EAAE,CAAC;YACX,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,CAAC,GAAG,CAAC,KAAK,CACZ,kBAAkB,oBAAY,OAAO,KAAK,IAAI,mBAAmB,KAAK,MAAM,CAAC,GAAG,CAAC,EAAE,CACpF,CAAC;YACJ,CAAC;QACH,CAAC;QACD,IAAI,MAAM,KAAK,CAAC,EAAE,CAAC;YACjB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,yCAAyC,oBAAY,mBAAmB,CAAC,CAAC;QAC3F,CAAC;IACH,CAAC;IAEO,WAAW;QACjB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC;gBACH,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,CAAC;YAAC,MAAM,CAAC;gBACP,iBAAiB;YACnB,CAAC;QACH,CAAC;IACH,CAAC;IAEO,aAAa;QACnB,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpC,OAAO;QACT,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,GAAG,EAAE;YAChC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;YAC5B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;gBAClB,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,CAAC;QACH,CAAC,EAAE,cAAc,CAAC,CAAC;IACrB,CAAC;IAEO,KAAK;QACX,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC;QACxD,KAAK,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACvC,IAAI,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,MAAM,EAAE,CAAC;gBACpC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBAC1B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,OAAO,6CAA6C,CAAC,CAAC;YACjF,CAAC;QACH,CAAC;IACH,CAAC;CACF;AA7LD,oCA6LC"}

package/dist/gpx.d.ts

@@ -0,0 +1,41 @@
+/**
+ * GPX 1.1 export: an alternative download format next to the native USR
+ * file. Two sources feed it — the parsed MFD database (backup download)
+ * and selected SignalK route resources (selection download). Output is
+ * plain XML built by hand; the document is small and flat enough that a
+ * dependency would be overkill.
+ */
+import type { UsrDatabase } from './usr/model';
+import type { RouteResource } from './types';
+export declare const GPX_CONTENT_TYPE = "application/gpx+xml";
+export interface GpxPoint {
+    /** Decimal degrees. */
+    lon: number;
+    lat: number;
+    name?: string;
+    description?: string;
+    /** ISO-8601 creation time. */
+    time?: string;
+}
+export interface GpxRoute {
+    name?: string;
+    description?: string;
+    points: GpxPoint[];
+}
+export interface GpxDocument {
+    waypoints: GpxPoint[];
+    routes: GpxRoute[];
+    /** ISO-8601 metadata time (file creation). */
+    time: string;
+}
+/**
+ * GPX for the MFD's user database: routes become <rte> with named <rtept>
+ * legs, and only free-standing waypoints become <wpt> — waypoints serving
+ * as route legs already appear inside their route, mirroring how the sync
+ * publishes resources. Legs referencing a missing waypoint record are
+ * skipped rather than failing the whole export.
+ */
+export declare function gpxFromUsrDatabase(db: UsrDatabase, now: Date): string;
+/** GPX for selected SignalK routes: one <rte> per route, unnamed <rtept>s. */
+export declare function gpxFromRouteResources(routes: Map<string, RouteResource>, now: Date): string;
+export declare function buildGpx(doc: GpxDocument): string;