@signalk/tracks-plugin 3.3.0 → 3.4.0

package/dist/types.d.ts

@@ -55,6 +55,11 @@ export interface ImportedTrack {
     /** Segments as posted; a point is either timed throughout or not at all. */
     segments: ImportedPoint[][];
 }
+/** An imported track as a store gives it back. */
+export interface StoredImport extends ImportedTrack {
+    /** When the store kept it, in ms since the epoch. */
+    importedAt: number;
+}
 /** Which imported tracks a query can see. Every field narrows; none means all. */
 export interface ImportFilter {
     /** Only imports naming one of these contexts; contextless ones drop out. */

package/docs/history-and-storage.md

@@ -65,9 +65,11 @@ be stored fails alone and recording carries on. It is admitted outside the limit
 above, so a large import neither pauses recording nor is dropped. Once recording
 writes have failed, imports are refused too. Retention never removes an imported
 track: it stays until it is deleted. A timed track imported for the own vessel is
-the exception: it is written into the recording, in place of what was recorded
-over the same time, which goes to the recycle bin first, and from then on it is
-part of the recording like any position.
+the exception: it is written into the recording, by default only where the
+recording and the history provider have nothing for at least five minutes (an
+import that cannot read the provider is refused, since an outage would look like
+one long gap), or, when asked, in place of what was recorded over the same time, which goes to the
+recycle bin first. From then on it is part of the recording like any position.
 
 Deleting a track, or part of one, moves its points into recycle bin tables in the
 same database, and restoring moves them back; both are written as imports are.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalk/tracks-plugin",
-  "version": "3.3.0",
+  "version": "3.4.0",
   "description": "Plugin to keep track of tracks of vessels",
   "type": "module",
   "exports": {

package/public/import.js

@@ -10,12 +10,26 @@ import { refusal } from './bin.js'
 /** Relative, because the server mounts this page under /@signalk/tracks-plugin. */
 const IMPORT_URL = '../../plugins/tracks/imports'
 
+const points = (count) => `${count} point${count === 1 ? '' : 's'}`
+
 /** What an import came to, in words. */
-export function imported({ ids, skippedPoints }) {
-  const count = `Imported ${ids.length} track${ids.length === 1 ? '' : 's'}.`
-  return skippedPoints > 0
-    ? `${count} ${skippedPoints} point${skippedPoints === 1 ? '' : 's'} without a time left out.`
-    : count
+export function imported({ ids, skippedPoints, overlappingPoints = 0 }) {
+  return [
+    `Imported ${ids.length} track${ids.length === 1 ? '' : 's'}.`,
+    ...(skippedPoints > 0 ? [`${points(skippedPoints)} without a time left out.`] : []),
+    ...(overlappingPoints > 0 ? [`${points(overlappingPoints)} left out where your vessel already has a track.`] : []),
+  ].join(' ')
+}
+
+/**
+ * The upload's query. Only the own vessel's tracks go into a recording, so
+ * replacing is offered for those alone; the route keeps by default.
+ */
+export function importQuery({ self, replace }) {
+  if (!self) {
+    return ''
+  }
+  return replace ? '?self=true&onOverlap=replace' : '?self=true'
 }
 
 async function messageOf(response) {
@@ -31,6 +45,13 @@ export function start() {
   const form = document.getElementById('import-form')
   const status = document.getElementById('import-status')
   const button = form.querySelector('button[type="submit"]')
+  const { self, replace } = form.elements
+  // Only the own vessel has a recording to replace.
+  const allowReplace = () => {
+    replace.disabled = !self.checked
+  }
+  allowReplace()
+  self.addEventListener('change', allowReplace)
 
   function show(message, state) {
     // A failed upload can be tried again; a successful one reloads the page.
@@ -58,7 +79,7 @@ export function start() {
       show('Choose a GPX file first.', 'error')
       return
     }
-    const query = form.elements.self.checked ? '?self=true' : ''
+    const query = importQuery({ self: self.checked, replace: replace.checked })
     button.disabled = true
     show('Importing…')
     let response

package/public/index.html

@@ -31,6 +31,10 @@
         <form id="import-form">
           <label>GPX file <input type="file" name="file" accept=".gpx,application/gpx+xml" required /></label>
           <label><input type="checkbox" name="self" /> Tracks of my own vessel</label>
+          <label
+            ><input type="checkbox" name="replace" /> Replace what my vessel recorded over the same time (it goes to the
+            recycle bin)</label
+          >
           <button type="submit">Import</button>
         </form>
         <p id="import-status" role="status" hidden></p>