signalk-polar-management 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+## 1.0.0 - 2026-09-09
+
+Initial release.
+
+### Added
+
+- Initial extraction from `signalk-polar-performance-plugin`: polar storage, selection, import
+  (Jieter/ORC matrix text, Expedition text, ORC active certificates), export (JSON, Jieter, Expedition),
+  and a management webapp. Registers as a Signal K Resource Provider for type `polars` and publishes
+  `vessels.self.polars.activePolar`.
+- Added a webapp-adjustable polar performance factor published at
+  `vessels.self.polars.performanceFactor`, with metadata for both plugin-owned Signal K output paths.
+- Added `GET /polars/:id/curves`, which uses `polar-math` to sample each TWS curve at a fixed angular
+  step (5° by default) across the full valid TWA range, so the webapp draws complete polar lines
+  including pinch and run extrapolation.
+- Added polar validation and copy endpoints, offline-aware external import handling,
+  and a reorganized management webapp with separate active, management, and import pages.
+- Added the Polar Management icon to Signal K plugin metadata and the published package.
+- Added sortable polar tables to the active-polar and management views.
+- Added optional performance-factor scaling to sampled polar curves, including beat, run,
+  and maximum-speed targets.
+
+### Fixed
+
+- Made the Polar Management icon available in both the Signal K AppStore and the webapp header.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,41 @@
+# Polar management
+
+This plugin helps you keep your boat's sailing polar data organised in Signal K.
+
+If you are not sure what a polar is, think of it as the speed your boat should make in different wind conditions. It is used by sailing apps to estimate performance, compare routes, and help with decisions on the water.
+
+This plugin makes it easy to store more than one polar, pick the one you want to use, and manage it from a simple interface.
+
+## Install from the Signal K AppStore
+
+1. Open your Signal K admin UI.
+2. Go to the AppStore.
+3. Search for "Polar Management".
+4. Click Install.
+5. Follow any normal Signal K prompts to finish the install.
+
+No manual command-line installation is needed for the normal AppStore workflow.
+
+## Find a polar for your boat
+
+Once the plugin is installed, the next step is to load a polar for your boat.
+
+1. Open the Polar Management page in Signal K.
+2. Choose the import option.
+3. Use the ORC import.
+4. Search by your boat model or hull type.
+5. Pick the closest match and import it.
+
+This is the easiest way to get a suitable polar for your boat before using other sailing apps that depend on it.
+
+## What this plugin does
+
+- Keeps your polar data in one place.
+- Lets you save and name different polars.
+- Lets you choose which polar is the active one.
+- Makes it easier to import a polar from a file or an external source.
+- Helps other sailing tools use the correct polar without having to edit raw files by hand.
+
+## Why this is useful
+
+This plugin is most useful when used together with other sailing apps in Signal K. Those apps can do the actual performance calculations, routing help, or sailing analysis, but they need a good polar to work with.

package/index.js

@@ -0,0 +1,373 @@
+'use strict'
+
+const path = require('path')
+const { validatePolarTable } = require('polar-format')
+const PolarStore = require('./lib/PolarStore')
+const { ImportService, ImportError } = require('./lib/import/ImportService')
+const { ExportService, ExportError } = require('./lib/export/ExportService')
+const { buildCurves, DEFAULT_STEP_DEG } = require('./lib/CurveService')
+
+const ACTIVE_POLAR_PATH = 'polars.activePolar'
+const PERFORMANCE_FACTOR_PATH = 'polars.performanceFactor'
+const DEFAULT_PERFORMANCE_FACTOR = 1
+const RESOURCE_TYPE = 'polars'
+
+module.exports = (app) => {
+  let settings = {}
+  let store = null
+  let importService = null
+  let exportService = null
+  let activePolarPublished = false
+  let performanceFactorPublished = false
+
+  const plugin = {
+    id: 'signalk-polar-management',
+    name: 'Polar Management'
+  }
+
+  function sanitizePerformanceFactor(value) {
+    const factor = Number(value)
+    if (!Number.isFinite(factor)) return DEFAULT_PERFORMANCE_FACTOR
+    return Math.min(1, Math.max(0, factor))
+  }
+
+  function isValidPerformanceFactor(value) {
+    const factor = Number(value)
+    return Number.isFinite(factor) && factor >= 0 && factor <= 1
+  }
+
+  // Lightweight internet connectivity probe (mirrors signalk-polar-performance-plugin).
+  // Attempts a HEAD request to Cloudflare's public DNS (1.1.1.1) with a 3s timeout.
+  async function checkInternet() {
+    const TIMEOUT_MS = 3000
+    try {
+      const controller = new AbortController()
+      const timer = setTimeout(() => controller.abort(), TIMEOUT_MS)
+      const response = await fetch('https://1.1.1.1', { method: 'HEAD', signal: controller.signal })
+        .finally(() => clearTimeout(timer))
+      return response.status < 600
+    } catch (_) {
+      return false
+    }
+  }
+
+  function publishMetadata() {
+    app.handleMessage(plugin.id, {
+      updates: [{
+        meta: [
+          {
+            path: ACTIVE_POLAR_PATH,
+            value: {
+              type: 'object',
+              displayName: 'Active polar',
+              description: 'Pointer to the selected polar resource.'
+            }
+          },
+          {
+            path: PERFORMANCE_FACTOR_PATH,
+            value: {
+              type: 'number',
+              units: 'ratio',
+              displayName: 'Polar performance factor',
+              description: 'Multiplier applied by polar consumers to reduce polar speed values.'
+            }
+          }
+        ]
+      }]
+    })
+  }
+
+  function publishActivePolar(id) {
+    const value = id ? { href: `/resources/${RESOURCE_TYPE}/${id}` } : null
+    app.handleMessage(plugin.id, {
+      updates: [{ values: [{ path: ACTIVE_POLAR_PATH, value }] }]
+    })
+    activePolarPublished = !!id
+  }
+
+  function clearActivePolar() {
+    if (!activePolarPublished) return
+    app.handleMessage(plugin.id, {
+      updates: [{ values: [{ path: ACTIVE_POLAR_PATH, value: null }] }]
+    })
+    activePolarPublished = false
+  }
+
+  function publishPerformanceFactor(value) {
+    app.handleMessage(plugin.id, {
+      updates: [{ values: [{ path: PERFORMANCE_FACTOR_PATH, value }] }]
+    })
+    performanceFactorPublished = true
+  }
+
+  function clearPerformanceFactor() {
+    if (!performanceFactorPublished) return
+    app.handleMessage(plugin.id, {
+      updates: [{ values: [{ path: PERFORMANCE_FACTOR_PATH, value: null }] }]
+    })
+    performanceFactorPublished = false
+  }
+
+  plugin.start = (options) => {
+    settings = { activePolar: '', performanceFactor: DEFAULT_PERFORMANCE_FACTOR, ...options }
+    settings.performanceFactor = sanitizePerformanceFactor(settings.performanceFactor)
+    store = new PolarStore(path.join(app.getDataDirPath(), 'polars'))
+    importService = new ImportService(store)
+    exportService = new ExportService()
+
+    publishMetadata()
+    publishPerformanceFactor(settings.performanceFactor)
+
+    if (settings.activePolar && store.exists(settings.activePolar)) {
+      publishActivePolar(settings.activePolar)
+    } else if (settings.activePolar) {
+      app.setPluginError(`Configured active polar '${settings.activePolar}' was not found`)
+    }
+
+    app.registerResourceProvider({
+      type: RESOURCE_TYPE,
+      methods: {
+        listResources: async () => {
+          const result = {}
+          for (const meta of store.listWithMeta()) {
+            const { id, ...rest } = meta
+            result[id] = rest
+          }
+          return result
+        },
+        getResource: async (id) => {
+          if (!store.exists(id)) throw new Error(`Polar not found: ${id}`)
+          return store.get(id)
+        },
+        setResource: async (id, value) => {
+          store.save(id, value)
+        },
+        deleteResource: async (id) => {
+          if (settings.activePolar === id) {
+            throw new Error(`Cannot delete '${id}': it is the active polar`)
+          }
+          store.delete(id)
+        }
+      }
+    })
+
+    app.setPluginStatus(`Managing ${store.list().length} polar(s)`)
+  }
+
+  plugin.stop = () => {
+    clearActivePolar()
+    clearPerformanceFactor()
+    store = null
+    importService = null
+    exportService = null
+  }
+
+  plugin.schema = () => ({ type: 'object', properties: {} })
+
+  plugin.registerWithRouter = (router) => {
+    router.get('/polars', (req, res) => {
+      res.json(store.listWithMeta())
+    })
+
+    router.get('/polars/:id', (req, res) => {
+      try {
+        res.json({ id: req.params.id, ...store.get(req.params.id) })
+      } catch (e) {
+        res.status(404).json({ error: e.message })
+      }
+    })
+
+    router.get('/polars/:id/curves', (req, res) => {
+      const step = req.query.step === undefined ? DEFAULT_STEP_DEG : Number(req.query.step)
+      let table
+      try {
+        table = store.get(req.params.id)
+      } catch (e) {
+        return res.status(404).json({ error: e.message })
+      }
+      const performanceFactor = req.query.corrected === 'true' ? settings.performanceFactor : 1
+      try {
+        res.json({ id: req.params.id, ...buildCurves(table, step, performanceFactor) })
+      } catch (e) {
+        res.status(400).json({ error: e.message })
+      }
+    })
+
+    router.get('/polars/:id/validate', (req, res) => {
+      let table
+      try {
+        table = store.get(req.params.id)
+      } catch (e) {
+        return res.status(404).json({ error: e.message })
+      }
+      const result = validatePolarTable(table)
+      res.json({
+        valid: result.valid,
+        errors: result.valid ? [] : result.errors.map(e => `${e.path}: ${e.message}`)
+      })
+    })
+
+    router.post('/polars/:id/copy', (req, res) => {
+      const newId = req.body?.id
+      if (typeof newId !== 'string' || !newId.trim()) {
+        return res.status(400).json({ error: "'id' is required" })
+      }
+      try {
+        store.copy(req.params.id, newId)
+        res.json({ id: newId })
+      } catch (e) {
+        res.status(400).json({ error: e.message })
+      }
+    })
+
+    router.put('/polars/:id', (req, res) => {
+      try {
+        store.save(req.params.id, req.body)
+        res.json({ id: req.params.id })
+      } catch (e) {
+        res.status(400).json({ error: e.message })
+      }
+    })
+
+    router.delete('/polars/:id', (req, res) => {
+      if (settings.activePolar === req.params.id) {
+        return res.status(409).json({ error: `Cannot delete '${req.params.id}': it is the active polar` })
+      }
+      try {
+        store.delete(req.params.id)
+        res.status(204).end()
+      } catch (e) {
+        res.status(404).json({ error: e.message })
+      }
+    })
+
+    router.post('/polars/:id/rename', (req, res) => {
+      const newId = req.body?.id
+      if (typeof newId !== 'string' || !newId.trim()) {
+        return res.status(400).json({ error: "'id' is required" })
+      }
+      try {
+        store.rename(req.params.id, newId)
+        if (settings.activePolar === req.params.id) {
+          settings.activePolar = newId
+          app.savePluginOptions(settings, () => {})
+          publishActivePolar(newId)
+        }
+        res.json({ id: newId })
+      } catch (e) {
+        res.status(400).json({ error: e.message })
+      }
+    })
+
+    router.get('/internet', async (req, res) => {
+      res.json({ online: await checkInternet() })
+    })
+
+    router.get('/activePolar', (req, res) => {
+      const id = settings.activePolar || null
+      if (!id) {
+        return res.json({ id: null, exists: false, valid: false, errors: [] })
+      }
+      if (!store.exists(id)) {
+        return res.json({ id, exists: false, valid: false, errors: [`Configured active polar '${id}' was not found`] })
+      }
+      const result = validatePolarTable(store.get(id))
+      res.json({
+        id,
+        exists: true,
+        valid: result.valid,
+        errors: result.valid ? [] : result.errors.map(e => `${e.path}: ${e.message}`)
+      })
+    })
+
+    router.put('/activePolar', (req, res) => {
+      const id = req.body?.id
+      if (id && !store.exists(id)) {
+        return res.status(404).json({ error: `Polar not found: ${id}` })
+      }
+      settings.activePolar = id || ''
+      app.savePluginOptions(settings, (err) => {
+        if (err) return res.status(500).json({ error: err.message })
+        if (id) publishActivePolar(id)
+        else clearActivePolar()
+        res.json({ id: settings.activePolar || null })
+      })
+    })
+
+    router.get('/performanceFactor', (req, res) => {
+      res.json({ value: settings.performanceFactor })
+    })
+
+    router.put('/performanceFactor', (req, res) => {
+      if (!isValidPerformanceFactor(req.body?.value)) {
+        return res.status(400).json({ error: 'Performance factor must be between 0 and 1' })
+      }
+      settings.performanceFactor = sanitizePerformanceFactor(req.body?.value)
+      app.savePluginOptions(settings, (err) => {
+        if (err) return res.status(500).json({ error: err.message })
+        publishPerformanceFactor(settings.performanceFactor)
+        res.json({ value: settings.performanceFactor })
+      })
+    })
+
+    router.get('/imports/formats', (req, res) => {
+      res.json(importService.listFormats())
+    })
+
+    router.post('/imports/text/:format', (req, res) => {
+      try {
+        res.json(importService.importText(req.params.format, req.body))
+      } catch (e) {
+        res.status(e instanceof ImportError ? e.status : 500).json({ error: e.message })
+      }
+    })
+
+    router.get('/imports/sources', (req, res) => {
+      res.json(importService.listSources())
+    })
+
+    router.get('/imports/sources/:source/search', async (req, res) => {
+      if (!await checkInternet()) {
+        return res.status(503).json({ error: 'No internet connection — external source imports are unavailable' })
+      }
+      try {
+        res.json(await importService.searchSource(req.params.source, req.query.q))
+      } catch (e) {
+        res.status(e instanceof ImportError ? e.status : 500).json({ error: e.message })
+      }
+    })
+
+    router.post('/imports/sources/:source/items/:externalId', async (req, res) => {
+      if (!await checkInternet()) {
+        return res.status(503).json({ error: 'No internet connection — external source imports are unavailable' })
+      }
+      try {
+        res.json(await importService.importSource(req.params.source, req.params.externalId, req.body))
+      } catch (e) {
+        res.status(e instanceof ImportError ? e.status : 500).json({ error: e.message })
+      }
+    })
+
+    router.get('/exports/formats', (req, res) => {
+      res.json([{ id: 'json', name: 'Canonical JSON', description: 'polar-format canonical document' }, ...exportService.listFormats()])
+    })
+
+    router.get('/polars/:id/export/:format', (req, res) => {
+      try {
+        const resource = store.get(req.params.id)
+        const text = exportService.exportText(req.params.format, resource)
+        const contentType = req.params.format === 'json' ? 'application/json' : 'text/plain'
+        const ext = req.params.format === 'json' ? 'json' : 'txt'
+        res.set('Content-Type', contentType)
+        res.set('Content-Disposition', `attachment; filename="${req.params.id}.${ext}"`)
+        res.send(text)
+      } catch (e) {
+        res.status(e instanceof ExportError ? e.status : 404).json({ error: e.message })
+      }
+    })
+  }
+
+  plugin.getOpenApi = () => require('./openApi.json')
+
+  return plugin
+}