@signalk/tracks-plugin 3.2.0 → 3.3.0

package/dist/sqliteStore.d.ts

@@ -132,6 +132,15 @@ export declare class SqliteTrackStore implements TrackStore {
      * same id fails rather than replacing the first.
      */
     storeImport(track: ImportedTrack): void;
+    /**
+     * Write a track imported for a vessel into its recording, in place of what
+     * was recorded over the same time. The positions within each segment's
+     * span go to the recycle bin first, one entry per segment, so a restore
+     * brings them back beside the import. Every span is binned before any point
+     * is written, so segments that overlap in time cannot bin each other.
+     * Resolves to the bin entries made.
+     */
+    recordTrack(context: Context, segments: TimedPosition[][], deletedAt: number, keepEmpty: boolean): number[];
     /**
      * Move a vessel's positions recorded within `[from, to]` into the recycle
      * bin, resolving to the entry's id and whether the store held the vessel at

package/dist/store.d.ts

@@ -113,6 +113,11 @@ export interface TrackStore {
         id?: number;
         known: boolean;
     }>;
+    /**
+     * Write a track imported for a vessel into its recording, binning what was
+     * recorded over the same time; resolves to the bin entries made.
+     */
+    recordTrack?(context: Context, segments: TimedPosition[][], deletedAt: number, keepEmpty: boolean): number[] | Promise<number[]>;
     binImport?(importId: string, span: {
         from?: number;
         to?: number;

package/dist/trackApi.d.ts

@@ -59,6 +59,8 @@ export interface TrackProperties {
     contextName?: string;
     /** The track's own name, as an imported GPX `<trk><name>` carries. */
     name?: string;
+    /** Set on a track a client stored, absent on a recorded one. */
+    imported?: true;
     /** Absent, with `to`, for a track whose points carry no times. */
     from?: string;
     to?: string;

package/dist/trackProvider.d.ts

@@ -1,6 +1,6 @@
 import { TrackStore } from './store.js';
 import { TrackApi } from './trackApi.js';
-import { TimedPosition, TimeWindow } from './types.js';
+import { ImportedTrack, TimedPosition, TimeWindow } from './types.js';
 /**
  * Serves the v2 Track API from this plugin's store.
  *
@@ -56,3 +56,20 @@ export interface TrackProviderDeps {
     reconcileWithHistory: (context: string, stored: TimedPosition[], window: TimeWindow | undefined, resolutionMs: number | undefined) => Promise<TimedPosition[]>;
 }
 export declare function createTrackProvider(deps: TrackProviderDeps): TrackApi;
+export interface KeepTrackDeps {
+    store: Required<Pick<TrackStore, 'storeImport' | 'recordTrack'>>;
+    selfContext: string;
+    historyKnows: (context: string) => Promise<boolean>;
+    deleted: () => void;
+}
+/**
+ * Keep a client's track, resolving to the id that addresses it.
+ *
+ * A timed track of the own vessel is the vessel's own passage, from before
+ * the plugin recorded it or from another plotter, so it is written into the
+ * recording in place of what was recorded over the same time and answers
+ * as `recorded:<context>`. Everything else is kept as an import: another
+ * vessel's track is not this boat's recording, and an untimed one cannot be
+ * placed in it.
+ */
+export declare function keepTrack(track: ImportedTrack, deps: KeepTrackDeps): Promise<string>;

package/dist/trackStoreProtocol.d.ts

@@ -1,5 +1,5 @@
 import { SqliteTrackStore } from './sqliteStore.js';
-export type StoreMethod = 'newPosition' | 'recordName' | 'initialTrack' | 'prune' | 'get' | 'getTimed' | 'getAllTracks' | 'getFilteredTracks' | 'getFilteredTimedTracks' | 'storeImport' | 'getImport' | 'findImports' | 'binRecorded' | 'binImport' | 'restoreFromBin' | 'purgeFromBin' | 'binEntries' | 'deletedSpans' | 'close';
+export type StoreMethod = 'newPosition' | 'recordName' | 'initialTrack' | 'prune' | 'get' | 'getTimed' | 'getAllTracks' | 'getFilteredTracks' | 'getFilteredTimedTracks' | 'storeImport' | 'getImport' | 'findImports' | 'binRecorded' | 'recordTrack' | 'binImport' | 'restoreFromBin' | 'purgeFromBin' | 'binEntries' | 'deletedSpans' | 'close';
 export type Operation = {
     [K in StoreMethod]: {
         id: number;

package/dist/trackStoreWorker.js

@@ -11712,6 +11712,26 @@ var SqliteTrackStore = class {
 		for (const [segment, segmentPoints] of track.segments.entries()) for (const { position, timestamp } of segmentPoints) insert.run(track.id, seq++, segment, timestamp ?? null, position[0], position[1]);
 	}
 	/**
+	* Write a track imported for a vessel into its recording, in place of what
+	* was recorded over the same time. The positions within each segment's
+	* span go to the recycle bin first, one entry per segment, so a restore
+	* brings them back beside the import. Every span is binned before any point
+	* is written, so segments that overlap in time cannot bin each other.
+	* Resolves to the bin entries made.
+	*/
+	recordTrack(context, segments, deletedAt, keepEmpty) {
+		const binned = [];
+		for (const points of segments) {
+			const first = points[0];
+			const last = points.at(-1);
+			if (first === void 0 || last === void 0) continue;
+			const { id } = this.binRecorded(context, first.timestamp, last.timestamp, deletedAt, keepEmpty);
+			if (id !== void 0) binned.push(id);
+		}
+		for (const points of segments) for (const { position, timestamp } of points) this.store(context, position, timestamp);
+		return binned;
+	}
+	/**
 	* Move a vessel's positions recorded within `[from, to]` into the recycle
 	* bin, resolving to the entry's id and whether the store held the vessel at
 	* all.
@@ -11999,6 +12019,7 @@ function mutate(operation, target) {
 var ACKNOWLEDGED = /* @__PURE__ */ new Set([
 	"storeImport",
 	"binRecorded",
+	"recordTrack",
 	"binImport",
 	"restoreFromBin",
 	"purgeFromBin"
@@ -12007,6 +12028,7 @@ function acknowledge(operation, target) {
 	switch (operation.method) {
 		case "storeImport": return target.storeImport(...operation.args);
 		case "binRecorded": return target.binRecorded(...operation.args);
+		case "recordTrack": return target.recordTrack(...operation.args);
 		case "binImport": return target.binImport(...operation.args);
 		case "restoreFromBin": return target.restoreFromBin(...operation.args);
 		case "purgeFromBin": return target.purgeFromBin(...operation.args);