@signalk/tracks-plugin 3.0.0 → 3.0.2

package/README.md

@@ -217,10 +217,13 @@ npm run format     # prettier --write
 
 `npm run test:e2e` packs the plugin, installs it into a throwaway config directory, boots a real
 Signal K server against it and feeds positions as deltas — so it covers plugin loading, route
-mounting and the delta path, none of which the unit suite can. It needs a built server checkout;
-set `SIGNALK_SERVER_DIR` if yours is not at `~/dev/xxx_signalk-server`. A second tier installs a
-real history provider (signalk-questdb) into that server and exercises the reconciliation through
-it; it skips itself if no QuestDB is reachable at `QUESTDB_URL`. Neither tier runs in CI.
+mounting and the delta path, none of which the unit suite can. It needs a server to boot: a built
+checkout, by default at `~/dev/xxx_signalk-server`, or an installed package's
+`node_modules/signalk-server`, named with `SIGNALK_SERVER_DIR`. A second tier installs a real
+history provider (signalk-questdb) into that server and exercises the reconciliation through it; it
+skips itself if no QuestDB is reachable at `QUESTDB_URL`, unless `QUESTDB_REQUIRED` is set. CI runs
+both tiers against the oldest supported signalk-server release and the latest, with QuestDB as a
+service container.
 
 The package is ESM only and targets Node >= 22.5.0, the release that added `node:sqlite`. ESM alone
 would only need 20.19, the first release in which the Signal K server's `require()`-based plugin

package/dist/asyncTrackStore.d.ts

@@ -0,0 +1,62 @@
+import { TrackStore } from './store.js';
+import { SqliteStoreConfig } from './sqliteStore.js';
+import { Debug, Context, LatLngTuple, TimeWindow, TrackParams } from './types.js';
+import { TrackQuery } from './timeWindow.js';
+interface Limits {
+    maxItems?: number;
+    maxBytes?: number;
+}
+/** One database owner; the server never waits synchronously for storage. */
+export declare class AsyncTrackStore implements TrackStore {
+    private queue;
+    private active;
+    private names;
+    private sequence;
+    private pendingBytes;
+    private maxItems;
+    private maxBytes;
+    private onError;
+    private debug;
+    private initialized;
+    private closing;
+    private failed;
+    private statusError;
+    private overloaded;
+    private dropped;
+    private gapStarted;
+    private writeFailed;
+    private readonly admitted;
+    private readonly resolution;
+    private readonly onResume;
+    readonly ready: Promise<void>;
+    private resolveReady;
+    private rejectReady;
+    private worker;
+    private exited;
+    private closeAcknowledged;
+    private scheduled;
+    private closePromise;
+    constructor(config: SqliteStoreConfig, debug: Debug, onError?: (error: Error) => void, limits?: Limits, onResume?: (message: string) => void);
+    private report;
+    private resumeIfDrained;
+    private fail;
+    private enqueue;
+    private schedule;
+    private pump;
+    private receive;
+    newPosition(context: Context, position: LatLngTuple, timestamp?: number): void;
+    recordName(context: Context, name: string, timestamp?: number): void;
+    nameFor(context: Context): string | undefined;
+    initialTrack(context: Context, track: LatLngTuple[], timestamps?: number[]): void;
+    prune(maxAge: number, keep?: Context): void;
+    get(context: Context, window?: TimeWindow): Promise<LatLngTuple[]>;
+    getTimed(context: Context, window?: TimeWindow): Promise<import('./types.js').TimedPosition[]>;
+    getAllTracks(query?: TrackQuery): Promise<{
+        context: string;
+        track: LatLngTuple[];
+    }[]>;
+    getFilteredTracks(params: TrackParams, selfPosition?: LatLngTuple, _debug?: Debug, query?: TrackQuery): Promise<import('./types.js').TrackCollection>;
+    getFilteredTimedTracks(params: TrackParams, selfPosition?: LatLngTuple, _debug?: Debug, query?: TrackQuery): Promise<import('./types.js').TimedTrackCollection>;
+    close(): Promise<void>;
+}
+export {};

package/dist/asyncTrackStore.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/harness.test-utils.d.ts

@@ -33,7 +33,7 @@ export interface TestHarness {
     setSelfPosition: (position: LatLngTuple | undefined) => void;
     /** The own vessel's navigation.state, as reported by `getSelfPath`. */
     setSelfState: (state: string | undefined) => void;
-    stop: () => void;
+    stop: () => Promise<void>;
     /**
      * Start the same plugin instance again, with the config it was built with.
      *

package/dist/index.d.ts

@@ -94,10 +94,10 @@ interface App {
     };
 }
 interface Plugin {
-    start: (c: TracksPluginConfig) => void;
+    start: (c: TracksPluginConfig) => void | Promise<void>;
     /** Enable on install, without waiting for a visit to the plugin config page. */
     enabledByDefault: boolean;
-    stop: () => void;
+    stop: () => Promise<void>;
     signalKApiRoutes: (r: Router) => Router;
     id: string;
     name: string;