signalk-watch-schedule 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,24 @@
+# v0.1.0
+
+Initial release.
+
+## ✨ Features
+
+- ⚓ Crew watch schedule for offshore and overnight sailing — a SignalK plugin plus an embedded webapp
+- 🔄 Rotation library of clock-anchored systems (including 2.5h watches and dog-watch rotations), filtered by team count
+- 🎛️ Watch control for authenticated users: pick the rotation, start time (±12h of whole hours), and team order, with a live preview
+- 📡 Authoritative watch state published as `watch.*` SignalK deltas, plus a small REST API for the webapp
+
+## 🎨 Webapp
+
+- 🟢 Live schedule view: current shift highlighted with countdowns to upcoming and elapsed shifts, and a full start date-time for multi-day watches
+- ☰ Draggable team-order list with ▲/▼ controls for nav-station touch screens
+- 🌓 Light/dark theme toggle (session-only)
+- 📱 PWA: favicons, app icons, and an installable home-screen app generated from the logo at build
+- 🖥️ Renders on Chromium 69 (Navico MFDs)
+
+## 🔧 Under the hood
+
+- 🧩 Shared scheduling core (`src/core`) used by both the server and the webapp
+- 🧹 ESLint (with @stylistic) + Prettier formatting, enforced on pre-commit and in CI
+- 🚀 GitHub Actions CI (SignalK plugin workflow + unit tests) and automated npm release/publish via OIDC trusted publishing

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,101 @@
+# signalk-watch-schedule
+
+A [SignalK](https://signalk.org) plugin + webapp for running a crew **watch schedule**
+on offshore or overnight passages. The captain defines watch teams and picks a
+rotation; the plugin tracks whether the boat is on watch, when it started, and shows a clean,
+color-coded, responsive schedule on any device.
+
+![status: alpha](https://img.shields.io/badge/status-alpha-orange)
+
+## Features
+
+- **Watch teams** configured in the plugin settings — name each for the watch or the crew standing it.
+- **Built-in rotation systems**: 4-on/4-off, 3-on/3-off, 6-on/6-off, and Royal Navy dog watches.
+- **Whole-hour starts** — the schedule always begins on a clean clock hour, with a start-time
+  picker covering ±12 hours so you can log a watch that began earlier or schedule one ahead.
+- **Pick who's first** — drag (or nudge with ▲/▼) the watch teams into order; the team on top
+  starts at the chosen time, the rest follow.
+- **Live, color-coded schedule** starting with the active shift, highlighted and counting down.
+- **Auth-aware UI** — anyone can view the schedule; logged-in users get start/stop control.
+- **Everything published under `watch.*`** so other SignalK consumers can use it too.
+
+## How it works
+
+```
+src/core/    Shared, dependency-free schedule logic — the single source of truth.
+             Imported unchanged by both the server plugin and the webapp.
+index.js     Plugin: holds state, publishes watch.*, exposes the REST API.
+webapp/      React + Vite UI, builds into public/.
+```
+
+The core module turns a **time-agnostic** rotation definition (segments as minute offsets +
+durations) plus an absolute start time into concrete shifts. The server publishes the inputs
+(`watch.state.*`, `watch.system`, `watch.teams`) and the webapp re-runs the *same* core
+function each second, so the displayed schedule, countdowns, and the server's published
+`watch.schedule` can never disagree.
+
+## Install
+
+From the SignalK **App Store**, search for `signalk-watch-schedule`. Or manually:
+
+```bash
+cd ~/.signalk/node_modules
+git clone https://github.com/hoeken/signalk-watch-schedule.git
+cd signalk-watch-schedule && npm install && npm run build:webapp
+```
+
+Then enable the plugin in **Server → Plugin Config** and open it from **Webapps**.
+
+## Configuration
+
+| Setting | Description |
+|---|---|
+| **Watch Teams** | One entry per watch, in rotation order. Name it for the watch (e.g. Port Watch) or the crew member(s) standing it. |
+| **Default Watch System** | Rotation pre-selected when starting a watch. |
+| **Start-time rounding** | How the start snaps to the hour: `nearest` / `up` / `down`. |
+| **Shifts to publish** | How many upcoming shifts to publish and show. |
+
+Only systems whose required team count fits your configured teams are offered (e.g. a
+three-team rotation appears once you have three teams).
+
+## SignalK paths
+
+| Path | Description |
+|---|---|
+| `watch.state.onWatch` | Watch active flag. |
+| `watch.state.startedAt` | Epoch ms the watch began (whole hour). |
+| `watch.state.systemId` | Active rotation id. |
+| `watch.system` | Full active system definition. |
+| `watch.teams` | Configured watch teams, in rotation order. |
+| `watch.current` / `watch.next` | Active and upcoming shift. |
+| `watch.schedule` | Ordered upcoming shifts, current first. |
+
+## REST API
+
+Base: `/plugins/signalk-watch-schedule/api`
+
+| Method | Path | Auth | Description |
+|---|---|---|---|
+| GET | `/state` | read | Current state + resolved schedule. |
+| GET | `/config` | read | Teams + defaults. |
+| GET | `/systems` | read | Available watch systems. |
+| POST | `/watch/start` | write | Body `{ systemId, startAt?, teamOrder? }`. `startAt` (epoch ms) snaps to the hour and defaults to now; `teamOrder` is a permutation of team indices putting one team first. |
+| POST | `/watch/stop` | write | Stops the watch. |
+
+Write endpoints require an authenticated SignalK user when server security is enabled.
+
+## Development
+
+```bash
+npm install
+npm test                 # core + server unit tests (node:test)
+npm run dev:webapp       # Vite dev server, proxies to SignalK on :3000
+npm run build:webapp     # build the UI into public/
+```
+
+The dev server proxies `/plugins`, `/skServer`, and `/signalk` (incl. WebSocket) to a SignalK
+server on `localhost:3000`.
+
+## License
+
+Apache-2.0 © Zach Hoeken

package/index.js

@@ -0,0 +1,105 @@
+/**
+ * signalk-watch-schedule — plugin entry point.
+ *
+ * Holds authoritative watch state, publishes the watch.* view as SignalK
+ * deltas, and exposes a small REST API for the webapp to read state and
+ * start/stop the watch.
+ */
+
+import { BUILTIN_SYSTEMS } from "./src/core/index.js";
+import { createStateStore } from "./src/server/state.js";
+import { buildWatchData, publish, publishMeta } from "./src/server/publisher.js";
+import { registerRoutes } from "./src/server/api.js";
+
+const PUBLISH_INTERVAL_MS = 30_000;
+
+export default function (app) {
+  const plugin = {
+    id: "signalk-watch-schedule",
+    name: "Watch Schedule",
+    description: "Crew watch schedule for offshore and overnight sailing.",
+  };
+
+  let options = {};
+  let store = null;
+  let timer = null;
+
+  const publishNow = () => {
+    if (!store)
+      return;
+    publish(app, plugin.id, buildWatchData(store.get(), options, Date.now()));
+  };
+
+  plugin.schema = () => ({
+    type: "object",
+    properties: {
+      teams: {
+        type: "array",
+        title: "Watch Teams",
+        description:
+          "One entry per watch, in rotation order. Name it whatever you like — a watch name (e.g. Port Watch) or, if you prefer, the crew member(s) standing it (e.g. Alice & Bob).",
+        default: [
+          { name: "Watch 1" },
+          { name: "Watch 2" },
+        ],
+        items: {
+          type: "object",
+          required: ["name"],
+          properties: {
+            name: { type: "string", title: "Name", description: "e.g. Port Watch, or a crew member's name" },
+          },
+        },
+      },
+      defaultSystemId: {
+        type: "string",
+        title: "Default Watch System",
+        description: "Pre-selected rotation when starting a watch.",
+        enum: BUILTIN_SYSTEMS.map((s) => s.id),
+        enumNames: BUILTIN_SYSTEMS.map((s) => `${s.name} — ${s.description}`),
+        default: "fixed-4-4",
+      },
+      snapMode: {
+        type: "string",
+        title: "Start-time rounding",
+        description: "How the watch start is snapped to a whole hour.",
+        enum: ["nearest", "up", "down"],
+        default: "nearest",
+      },
+      publishHorizon: {
+        type: "number",
+        title: "Shifts to publish",
+        description: "How many upcoming shifts to publish and show in the UI.",
+        default: 8,
+        minimum: 1,
+      },
+    },
+  });
+
+  plugin.start = (opts) => {
+    options = opts || {};
+    store = createStateStore(app);
+    publishMeta(app, plugin.id);
+    publishNow();
+    timer = setInterval(publishNow, PUBLISH_INTERVAL_MS);
+    const s = store.get();
+    app.setPluginStatus(s.onWatch ? `On watch (${s.systemId})` : "Idle — no watch in progress");
+  };
+
+  plugin.stop = () => {
+    if (timer)
+      clearInterval(timer);
+    timer = null;
+    store = null;
+  };
+
+  plugin.registerWithRouter = (router) => {
+    registerRoutes(router, {
+      app,
+      getOptions: () => options,
+      getStore: () => store,
+      publishNow,
+    });
+  };
+
+  return plugin;
+}

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "signalk-watch-schedule",
+  "version": "0.1.0",
+  "description": "Crew watch schedule for offshore and overnight sailing",
+  "type": "module",
+  "main": "index.js",
+  "scripts": {
+    "build:webapp": "vite build --config webapp/vite.config.js",
+    "dev:webapp": "vite --config webapp/vite.config.js",
+    "test": "node --test",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix .",
+    "format": "eslint --fix . && prettier --write .",
+    "format:check": "eslint . && prettier --check .",
+    "prepare": "husky || true",
+    "release": "git tag -d v$npm_package_version; git tag v$npm_package_version && git push && git push origin v$npm_package_version",
+    "prepack": "npm run build:webapp",
+    "prepublishOnly": "npm test"
+  },
+  "lint-staged": {
+    "*.{js,jsx}": "eslint --fix",
+    "*.{json,css,html}": "prettier --write"
+  },
+  "keywords": [
+    "signalk-node-server-plugin",
+    "signalk-webapp",
+    "signalk-category-utility",
+    "watch",
+    "schedule",
+    "sailing",
+    "offshore"
+  ],
+  "signalk": {
+    "appIcon": "icon-512.png",
+    "displayName": "Watch Schedule",
+    "screenshots": [
+      "./docs/screenshots/setup.png",
+      "./docs/screenshots/started.png",
+      "./docs/screenshots/dark_mode.png",
+      "./docs/screenshots/mobile.png"
+    ]
+  },
+  "author": "Zach Hoeken",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hoeken/signalk-watch-schedule.git"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "files": [
+    "index.js",
+    "src/",
+    "public/",
+    "docs/screenshots/",
+    "CHANGELOG.md"
+  ],
+  "devDependencies": {
+    "@eslint/js": "^9.39.4",
+    "@stylistic/eslint-plugin": "^5.10.0",
+    "@vitejs/plugin-react": "^4.3.4",
+    "eslint": "^9.39.4",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-react-hooks": "^7.1.1",
+    "globals": "^17.7.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.4.0",
+    "prettier": "^3.9.1",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "sharp": "^0.35.2",
+    "vite": "^6.0.7"
+  }
+}