@signalk/tracks-plugin 3.0.0-beta.0 → 3.0.0-beta.1

package/dist/timeWindow.d.ts

@@ -30,6 +30,24 @@ export declare function parseTrackQuery(query: Record<string, unknown>, now?: nu
  * the first and last so the track keeps its extent.
  */
 export declare function thin(points: TimedPosition[], resolution: number | undefined): TimedPosition[];
+/**
+ * Thin to at most `maxPoints`, widening the spacing until the budget fits.
+ *
+ * A budget, not a fidelity contract: the caller has said how many points it can
+ * afford to transfer and draw, whatever shape the track is. Returns the
+ * resolution actually applied so the response can report it — a client that is
+ * given 29 points instead of the 546 it would otherwise have received should be
+ * able to see the spacing that produced them.
+ *
+ * Widening by doubling from the span-derived estimate rather than binary
+ * searching: `thin` keeps the first point and the last unconditionally, so the
+ * count is not a clean function of the spacing and an exact solve would be
+ * false precision. Two or three passes settle it in practice.
+ */
+export declare function thinToBudget(points: TimedPosition[], maxPoints: number, resolution: number | undefined): {
+    points: TimedPosition[];
+    resolution: number | undefined;
+};
 /**
  * Split points into segments wherever recording stopped for longer than `gap`.
  *

package/dist/trackApi.d.ts

@@ -15,13 +15,15 @@ export type TrackBoundingBox = [number, number, number, number];
 /**
  * A request as the server hands it to a provider.
  *
- * Not every field is honoured here. `maxPoints`, `simplify`, `epsilon` and
- * `properties` are accepted by the API and ignored by this provider: it serves
- * positions, and has no co-recorded values to attach or geometry simplifier to
- * run. A caller gets the full, unsimplified track for the window it asked for,
- * which is a superset of what it requested rather than a wrong answer. The
- * response echoes `resolution` when one was requested, so a client can tell a
- * thinned track from a full one.
+ * Not every field is honoured here. `simplify`, `epsilon` and `properties` are
+ * accepted by the API and ignored by this provider: it serves positions, and
+ * has no co-recorded values to attach or geometry simplifier to run. Geometry
+ * comes back unsimplified, which is a superset of what such a request asked for
+ * rather than a wrong answer.
+ *
+ * `resolution` and `maxPoints` are both applied, and the response reports the
+ * spacing actually used — which is not always the one asked for, since a
+ * budget widens it.
  *
  * Simplification and co-recorded properties are tracked separately; see
  * SignalK/tracks.

package/dist/types.d.ts

@@ -48,6 +48,16 @@ export type QueryParameters = Record<string, unknown>;
 export interface TrackParams {
     bbox: GeoBounds | null;
     radius: number | null;
+    /**
+     * Match a track on *any* position rather than its last.
+     *
+     * The v1 routes answer "vessels near here now", so they match the last
+     * position — a vessel that has left is no longer near. The v2 Track API asks
+     * a different question, "tracks that passed through this box within the
+     * window", and its contract says a vessel that crossed an hour ago and has
+     * since left still matches. Same filter, two questions.
+     */
+    intersects?: boolean;
 }
 export interface Debug {
     (...args: unknown[]): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalk/tracks-plugin",
-  "version": "3.0.0-beta.0",
+  "version": "3.0.0-beta.1",
   "description": "Plugin to keep track of tracks of vessels",
   "type": "module",
   "exports": {
@@ -12,9 +12,15 @@
   "//main": "Signal K resolves an installed plugin by directory. Node's CJS directory resolution and the server's esm-resolve fallback both read `main`, not `exports`, so dropping this makes the plugin unloadable.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "//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"
+    "dist",
+    "app-icon.svg"
   ],
+  "signalk": {
+    "displayName": "Tracks",
+    "appIcon": "app-icon.svg"
+  },
   "keywords": [
     "signalk-node-server-plugin",
     "signalk-category-utility"