@signalk/tracks-plugin 3.0.0-beta.3 → 3.0.0-beta.5

package/dist/sourceWatch.d.ts

@@ -1,35 +1,24 @@
 import { Context } from './types.js';
-/**
- * Watches which `$source` each context's positions arrive from.
- *
- * `navigation.position` is a rapid update — a GPS may report at 10Hz — and a
- * typical boat has several receivers: an internal GPS, an AIS transponder, a
- * chart plotter echoing its own fix.
- *
- * Signal K resolves which one wins through source priority, and the bus this
- * plugin listens on is the filtered one: the server applies `toPreferredDelta`
- * before emitting `delta`, which is what feeds `getBus()`. So with a priority
- * rule in place, only the winner arrives and there is nothing to warn about.
- *
- * The gap is when no rule *matches* the path. Then the engine passes every
- * source through, the fixes from receivers metres apart interleave, and the
- * track zigzags between them rather than following the boat. The fix is to
- * configure source priority for `navigation.position`; this watcher exists to
- * say so, because the symptom (a track that looks noisy) does not obviously
- * point at the cause.
- *
- * Detection is therefore empirical rather than reading the priority config:
- * seeing several sources here *is* the evidence that no rule is matching,
- * which a config that merely exists would not tell us.
- */
 export declare class SourceWatch {
+    /** Last time each source produced a position, per context. */
     private readonly seen;
+    /** Sources found competing, per context, with when each was last seen so. */
+    private readonly competing;
+    /** The current alternation per context: who is in it, and how long it is. */
+    private readonly lastSeen;
     /** Record that `context` produced a position from `$source`. */
-    add(context: Context, source: string | undefined): void;
-    /** Sources seen for a context, in the order they first appeared. */
+    add(context: Context, source: string | undefined, now?: number): void;
+    /** Every source seen for a context, in the order they first appeared. */
     sourcesFor(context: Context): string[];
-    /** Contexts receiving positions from more than one source. */
-    conflicted(): Context[];
+    /**
+     * The sources found live at the same time, which is what a warning names.
+     *
+     * Expired entries are dropped rather than merely hidden, so a conflict that
+     * has stopped recurring leaves nothing behind.
+     */
+    competingFor(context: Context, now?: number): string[];
+    /** Contexts that have received positions from two sources at once. */
+    conflicted(now?: number): Context[];
     /**
      * A status line naming the problem, or undefined when nothing is wrong.
      *
@@ -38,7 +27,7 @@ export declare class SourceWatch {
      * vessels are usually AIS, where multiple receivers are expected and less
      * worth nagging about — they are counted, not named.
      */
-    warning(selfContext?: Context): string | undefined;
+    warning(selfContext?: Context, now?: number): string | undefined;
     /** Forget everything seen; used when the plugin restarts. */
     clear(): void;
 }

package/dist/tracks.js

@@ -19,7 +19,11 @@
  * days covers the passage someone is looking for while keeping the query
  * something the store can serve.
  */
-const WINDOW = 'P30D'
+// The two APIs spell a duration differently: v2 takes ISO 8601, v1 takes a
+// number with a unit suffix. One constant for both sent `P30D` to the v1
+// export route, which rejected it and made every GPX download a 400.
+const WINDOW_V2 = 'P30D'
+const WINDOW_V1 = '30d'
 
 /**
  * Ceiling on the list request.
@@ -31,7 +35,7 @@ const WINDOW = 'P30D'
 const REQUEST_TIMEOUT_MS = 30_000
 
 /** Relative, because the server mounts this under /@signalk/tracks-plugin. */
-const TRACKS_URL = `../../signalk/v2/api/tracks?geometry=false&duration=${WINDOW}`
+const TRACKS_URL = `../../signalk/v2/api/tracks?geometry=false&duration=${WINDOW_V2}`
 
 const status = document.getElementById('status')
 const table = document.getElementById('tracks')
@@ -92,7 +96,7 @@ function exportCell({ context, isSelf }) {
   // `self` resolves server-side; using it keeps the URL short and avoids
   // guessing how the own vessel's context should be spelled.
   const vessel = isSelf ? 'self/track.gpx' : `vessels/${encodeURIComponent(context)}/track.gpx`
-  link.href = `../../signalk/v1/api/${vessel}?duration=${WINDOW}`
+  link.href = `../../signalk/v1/api/${vessel}?duration=${WINDOW_V1}`
   link.textContent = 'GPX'
   link.rel = 'nofollow'
   td.append(link)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalk/tracks-plugin",
-  "version": "3.0.0-beta.3",
+  "version": "3.0.0-beta.5",
   "description": "Plugin to keep track of tracks of vessels",
   "type": "module",
   "exports": {
@@ -15,17 +15,15 @@
   "//files": "app-icon.svg ships alongside dist because `files` is an allowlist: the app store probes the declared signalk.appIcon path inside the published tarball, so an icon left out here 404s and the plugin falls back to a placeholder.",
   "files": [
     "dist",
-    "public",
-    "app-icon.svg"
+    "public"
   ],
   "signalk": {
     "displayName": "Tracks",
-    "appIcon": "app-icon.svg"
+    "appIcon": "./app-icon.svg"
   },
   "keywords": [
     "signalk-node-server-plugin",
     "signalk-webapp",
-    "signalk-embeddable-webapp",
     "signalk-category-utility"
   ],
   "author": "Teppo Kurki <teppo.kurki@iki.fi>",

package/public/app-icon.svg

@@ -0,0 +1,42 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128" role="img" aria-label="Tracks">
+  <defs>
+    <linearGradient id="sea" x1="0" y1="0" x2="0" y2="1">
+      <stop offset="0" stop-color="#1b6ea8"/>
+      <stop offset="1" stop-color="#0b3a5e"/>
+    </linearGradient>
+    <clipPath id="card">
+      <rect x="0" y="0" width="128" height="128" rx="22"/>
+    </clipPath>
+  </defs>
+
+  <g clip-path="url(#card)">
+    <rect width="128" height="128" fill="url(#sea)"/>
+
+    <!-- Chart grid, as on the sibling plugins' icons. -->
+    <g stroke="#bee3f4" stroke-opacity="0.28" stroke-width="1" fill="none">
+      <path d="M0 32 H128 M0 64 H128 M0 96 H128"/>
+      <path d="M32 0 V128 M64 0 V128 M96 0 V128"/>
+    </g>
+
+    <!-- The track itself: the recorded path, drawn through its own points. -->
+    <path d="M24 102 C 40 94, 42 72, 58 64 S 84 58, 94 44"
+          fill="none" stroke="#0b3a5e" stroke-opacity="0.45"
+          stroke-width="9" stroke-linecap="round"/>
+    <path d="M24 102 C 40 94, 42 72, 58 64 S 84 58, 94 44"
+          fill="none" stroke="#ffd76a" stroke-width="5"
+          stroke-linecap="round" stroke-linejoin="round"/>
+
+    <!-- Position fixes. The track is a series of recorded points, not a
+         drawn line, and the icon should read that way at 32px too. -->
+    <g fill="#fffaf0" stroke="#0b3a5e" stroke-opacity="0.5" stroke-width="1.5">
+      <circle cx="24" cy="102" r="4.5"/>
+      <circle cx="49" cy="74" r="4"/>
+      <circle cx="72" cy="61" r="4"/>
+    </g>
+
+    <!-- The vessel, at the newest fix, heading along the track. -->
+    <path d="M94 34 L102 52 L94 47 L86 52 Z" fill="#fffaf0"
+          stroke="#0b3a5e" stroke-opacity="0.5" stroke-width="1.5"
+          stroke-linejoin="round"/>
+  </g>
+</svg>

package/public/index.html

@@ -4,6 +4,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <title>Tracks</title>
+    <link rel="icon" href="./app-icon.svg" type="image/svg+xml" />
     <link rel="stylesheet" href="./style.css" />
   </head>
   <body>

package/public/tracks.js

@@ -19,7 +19,11 @@
  * days covers the passage someone is looking for while keeping the query
  * something the store can serve.
  */
-const WINDOW = 'P30D'
+// The two APIs spell a duration differently: v2 takes ISO 8601, v1 takes a
+// number with a unit suffix. One constant for both sent `P30D` to the v1
+// export route, which rejected it and made every GPX download a 400.
+const WINDOW_V2 = 'P30D'
+const WINDOW_V1 = '30d'
 
 /**
  * Ceiling on the list request.
@@ -31,7 +35,7 @@ const WINDOW = 'P30D'
 const REQUEST_TIMEOUT_MS = 30_000
 
 /** Relative, because the server mounts this under /@signalk/tracks-plugin. */
-const TRACKS_URL = `../../signalk/v2/api/tracks?geometry=false&duration=${WINDOW}`
+const TRACKS_URL = `../../signalk/v2/api/tracks?geometry=false&duration=${WINDOW_V2}`
 
 const status = document.getElementById('status')
 const table = document.getElementById('tracks')
@@ -92,7 +96,7 @@ function exportCell({ context, isSelf }) {
   // `self` resolves server-side; using it keeps the URL short and avoids
   // guessing how the own vessel's context should be spelled.
   const vessel = isSelf ? 'self/track.gpx' : `vessels/${encodeURIComponent(context)}/track.gpx`
-  link.href = `../../signalk/v1/api/${vessel}?duration=${WINDOW}`
+  link.href = `../../signalk/v1/api/${vessel}?duration=${WINDOW_V1}`
   link.textContent = 'GPX'
   link.rel = 'nofollow'
   td.append(link)