signalk-backup 0.1.0

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 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 Support. 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 support.
+
+   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 2026 Dirk Wahrheit
+
+   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,71 @@
+# signalk-backup
+
+Scheduled deduplicated backups of your SignalK config (and optionally history) to local storage and Google Drive.
+
+The plugin is a thin shell: it asks [signalk-container](https://github.com/dirkwa/signalk-container) to run the backup engine in a container ([signalk-backup-server](https://github.com/dirkwa/signalk-backup-server)) and presents a redirect to the engine's UI as a SignalK webapp. All backup work — Kopia snapshots, rclone Google Drive sync, scheduling, restore-with-rollback — happens inside the container.
+
+## Features
+
+- **Content-addressable deduplication** — Kopia stores file blobs once across all snapshots; identical config files between hourly/daily/weekly retention tiers cost nothing
+- **Cloud sync to Google Drive** — optional, opt-in. Uses rclone with `drive.file` scope (the app only sees files it created)
+- **Scheduled backups** — hourly / daily / weekly / on-startup tiers, each with independent retention
+- **Restore with safety backup** — every restore creates a snapshot of the current state first, so a botched restore can be rolled back automatically
+- **First-run safe default** — installs with a daily local-only schedule already seeded; no surprise data egress
+- **Update detection** — checks ghcr.io for new container images via signalk-container's centralized update service
+
+## Requirements
+
+- SignalK Server ≥ 2.24.0
+- Node 22 or newer (24 recommended)
+- [signalk-container](https://github.com/dirkwa/signalk-container) ≥ 0.1.6 (provides the container runtime)
+- Podman or Docker on the host
+
+## Install
+
+```bash
+# Via the SignalK Admin UI: Server → Appstore → "signalk-backup"
+# (auto-enables on install — first-run schedules a daily local backup)
+```
+
+The plugin pulls `ghcr.io/dirkwa/signalk-backup-server:latest` on first run. The container is small (~80 MB compressed). Subsequent updates are detected and surfaced in the signalk-container config panel.
+
+## How it works
+
+```
+Your browser
+  └── /plugins/signalk-backup/                 ← redirect HTML
+       └── plugin proxies /api/gui-url
+            └── backup-server container UI
+                 (snapshots, restore wizard, cloud sync, settings)
+```
+
+When you visit `/plugins/signalk-backup/` in the SignalK Admin UI, the plugin's redirect HTML asks `/plugins/signalk-backup/api/gui-url` for the current backup-server location and bounces your browser there. This means the UI version is always in sync with the running container.
+
+## Configuration
+
+Most configuration lives in the **Backup Console** (open it from the redirect, or from the SignalK Admin UI plugin config: "Open Backup Console"). The Console handles:
+
+- Backup schedule (hourly / daily / weekly / startup) and retention tiers
+- Backup excludes (paths to skip — default: `node_modules/`, `charts*/`)
+- Repository password (Kopia encryption key)
+- Cloud sync mode (off / manual / daily / weekly)
+- Google Drive connection (one-click OAuth via `rclone authorize drive`)
+- Snapshot browser, restore wizard
+
+The SignalK Admin UI plugin panel (small) handles only deployment-level settings:
+
+- `managedContainer` — whether to manage the container yourself or point at an external backup-server
+- `imageTag` — pin a specific version or use a floating tag like `latest`
+- `externalUrl` — only used when `managedContainer: false`
+- `logLevel` — forwarded to the container
+
+## License
+
+Apache-2.0
+
+## See also
+
+- [signalk-backup-server](https://github.com/dirkwa/signalk-backup-server) — the container image
+- [signalk-container](https://github.com/dirkwa/signalk-container) — runtime substrate
+- [Kopia](https://kopia.io/) — backup engine
+- [rclone](https://rclone.org/) — cloud transport

package/assets/icon.svg

@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 256 256" width="256" height="256">
+  <!--
+    signalk-backup icon
+    A shield (backup, protection) over a SignalK-blue wave field with a
+    checkmark at center (snapshot completed). Two-tone, scales cleanly to
+    16px favicon size — kept simple geometry, no fine detail.
+  -->
+  <defs>
+    <linearGradient id="seaGrad" x1="0" x2="0" y1="0" y2="1">
+      <stop offset="0%" stop-color="#1a73c4"/>
+      <stop offset="100%" stop-color="#0d4d8a"/>
+    </linearGradient>
+    <linearGradient id="shieldGrad" x1="0" x2="0" y1="0" y2="1">
+      <stop offset="0%" stop-color="#fafbfc"/>
+      <stop offset="100%" stop-color="#e6ebf0"/>
+    </linearGradient>
+  </defs>
+
+  <!-- background disc -->
+  <circle cx="128" cy="128" r="120" fill="url(#seaGrad)"/>
+
+  <!-- waves -->
+  <path d="M 28 168 Q 64 152, 100 168 T 172 168 T 228 168 V 200 H 28 Z"
+        fill="#ffffff" fill-opacity="0.18"/>
+  <path d="M 28 188 Q 64 174, 100 188 T 172 188 T 228 188 V 220 H 28 Z"
+        fill="#ffffff" fill-opacity="0.12"/>
+
+  <!-- shield body -->
+  <path d="M 128 40
+           L 196 64
+           L 196 124
+           Q 196 168, 128 200
+           Q 60 168, 60 124
+           L 60 64 Z"
+        fill="url(#shieldGrad)"
+        stroke="#0d4d8a" stroke-width="6" stroke-linejoin="round"/>
+
+  <!-- checkmark -->
+  <path d="M 90 128 L 118 156 L 170 96"
+        fill="none"
+        stroke="#10b981"
+        stroke-width="16"
+        stroke-linecap="round"
+        stroke-linejoin="round"/>
+</svg>

package/package.json

@@ -0,0 +1,91 @@
+{
+  "name": "signalk-backup",
+  "version": "0.1.0",
+  "description": "Scheduled deduplicated backups of SignalK config to local storage and Google Drive (via Kopia + rclone)",
+  "main": "plugin/index.js",
+  "type": "module",
+  "signalk-plugin-enabled-by-default": true,
+  "scripts": {
+    "format": "prettier --write 'src/**/*.ts' 'test/**/*.ts' 'webapp/**/*.{ts,tsx,html}' && eslint --fix 'src/**/*.ts' 'test/**/*.ts' 'webapp/**/*.{ts,tsx}'",
+    "lint": "eslint 'src/**/*.ts' 'test/**/*.ts' 'webapp/**/*.{ts,tsx}'",
+    "typecheck:webapp": "tsc -p tsconfig.webapp.json",
+    "build:plugin": "tsc",
+    "build:webapp": "vite build",
+    "build": "npm run build:plugin && npm run typecheck:webapp && npm run build:webapp",
+    "build:all": "npm run lint && npm run build && npm run test",
+    "dev": "vite",
+    "test": "vitest run",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "signalk-node-server-plugin",
+    "signalk-webapp",
+    "signalk-category-utility",
+    "backup",
+    "kopia",
+    "rclone",
+    "google-drive"
+  ],
+  "signalk": {
+    "displayName": "Backup",
+    "appIcon": "assets/icon.png",
+    "webapp": {
+      "name": "Backup",
+      "description": "Scheduled deduplicated backups to local storage and Google Drive"
+    },
+    "requires": [
+      "signalk-container"
+    ]
+  },
+  "files": [
+    "plugin/**/*",
+    "public/**/*",
+    "assets/**/*",
+    "docs/**/*"
+  ],
+  "engines": {
+    "node": ">=22.5.0",
+    "signalk": ">=2.24.0"
+  },
+  "dependencies": {
+    "@sinclair/typebox": "^0.34.0"
+  },
+  "peerDependencies": {
+    "signalk-container": ">=0.1.6"
+  },
+  "peerDependenciesMeta": {
+    "signalk-container": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@signalk/server-admin-ui-dependencies": "^2.23.0",
+    "@signalk/server-api": "^2.24.0",
+    "@types/express": "^5.0.0",
+    "@types/node": "^22.0.0",
+    "@types/react": "^19.2.14",
+    "@types/react-dom": "^19.2.3",
+    "@types/supertest": "^7.2.0",
+    "@vitejs/plugin-react": "^6.0.1",
+    "bootstrap": "^5.3.8",
+    "eslint": "^10.3.0",
+    "eslint-config-prettier": "^10.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "express": "^5.2.1",
+    "prettier": "^3.0.0",
+    "react": "^19.2.6",
+    "react-dom": "^19.2.6",
+    "reactstrap": "^9.2.3",
+    "supertest": "^7.2.2",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.0.0",
+    "vite": "^8.0.11",
+    "vitest": "^4.1.5"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dirkwa/signalk-backup.git"
+  },
+  "license": "Apache-2.0"
+}

package/plugin/backup-client.d.ts

@@ -0,0 +1,60 @@
+/**
+ * HTTP client for talking to the backup-server container's API.
+ *
+ * Uses Node's built-in fetch (Node 22+). The plugin discovers the actual
+ * base URL via signalk-container's resolveContainerAddress() after
+ * ensureRunning(), then constructs this client.
+ *
+ * Methods used by the plugin's first-run logic:
+ *   - waitForReady() — poll /api/health until 200 or timeout
+ *   - getSettings()  — GET  /api/settings (read scheduler/cloud config)
+ *   - putSettings()  — PUT  /api/settings (seed default schedule on first run)
+ *   - getGuiUrl()    — GET  /api/gui-url (used by the redirect HTML's proxy)
+ *
+ * The full API surface (backups list/create/restore, cloud sync, etc.) is
+ * exercised by the container's own UI. The plugin doesn't need to wrap it.
+ */
+export interface BackupServerSettings {
+    scheduler?: {
+        configured?: boolean;
+        daily?: {
+            enabled: boolean;
+            retain: number;
+        };
+        hourly?: {
+            enabled: boolean;
+            retain: number;
+        };
+        weekly?: {
+            enabled: boolean;
+            retain: number;
+        };
+        startup?: {
+            enabled: boolean;
+            retain: number;
+        };
+    };
+    cloud?: {
+        mode?: 'off' | 'manual' | 'daily' | 'weekly';
+    };
+    excludes?: string[];
+    [key: string]: unknown;
+}
+export interface BackupServerHealth {
+    status: string;
+    uptime?: number;
+    version?: string;
+}
+export declare class BackupClient {
+    private readonly baseUrl;
+    constructor(baseUrl: string);
+    private request;
+    waitForReady(maxMs?: number, intervalMs?: number): Promise<void>;
+    getSettings(): Promise<BackupServerSettings>;
+    putSettings(patch: Partial<BackupServerSettings>): Promise<BackupServerSettings>;
+    getGuiUrl(): Promise<{
+        url: string;
+    }>;
+    get base(): string;
+}
+//# sourceMappingURL=backup-client.d.ts.map

package/plugin/backup-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"backup-client.d.ts","sourceRoot":"","sources":["../src/backup-client.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,MAAM,WAAW,oBAAoB;IACnC,SAAS,CAAC,EAAE;QACV,UAAU,CAAC,EAAE,OAAO,CAAA;QACpB,KAAK,CAAC,EAAE;YAAE,OAAO,EAAE,OAAO,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,CAAA;QAC5C,MAAM,CAAC,EAAE;YAAE,OAAO,EAAE,OAAO,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,CAAA;QAC7C,MAAM,CAAC,EAAE;YAAE,OAAO,EAAE,OAAO,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,CAAA;QAC7C,OAAO,CAAC,EAAE;YAAE,OAAO,EAAE,OAAO,CAAC;YAAC,MAAM,EAAE,MAAM,CAAA;SAAE,CAAA;KAC/C,CAAA;IACD,KAAK,CAAC,EAAE;QACN,IAAI,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAA;KAC7C,CAAA;IACD,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,qBAAa,YAAY;IACX,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAAP,OAAO,EAAE,MAAM;YAE9B,OAAO;IAqCf,YAAY,CAAC,KAAK,SAAS,EAAE,UAAU,SAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAmB9D,WAAW,IAAI,OAAO,CAAC,oBAAoB,CAAC;IAI5C,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAOhF,SAAS,IAAI,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IAI3C,IAAI,IAAI,IAAI,MAAM,CAEjB;CACF"}

package/plugin/backup-client.js

@@ -0,0 +1,87 @@
+/**
+ * HTTP client for talking to the backup-server container's API.
+ *
+ * Uses Node's built-in fetch (Node 22+). The plugin discovers the actual
+ * base URL via signalk-container's resolveContainerAddress() after
+ * ensureRunning(), then constructs this client.
+ *
+ * Methods used by the plugin's first-run logic:
+ *   - waitForReady() — poll /api/health until 200 or timeout
+ *   - getSettings()  — GET  /api/settings (read scheduler/cloud config)
+ *   - putSettings()  — PUT  /api/settings (seed default schedule on first run)
+ *   - getGuiUrl()    — GET  /api/gui-url (used by the redirect HTML's proxy)
+ *
+ * The full API surface (backups list/create/restore, cloud sync, etc.) is
+ * exercised by the container's own UI. The plugin doesn't need to wrap it.
+ */
+export class BackupClient {
+    baseUrl;
+    constructor(baseUrl) {
+        this.baseUrl = baseUrl;
+    }
+    async request(path, init = {}) {
+        const controller = new AbortController();
+        const timeoutMs = init.timeoutMs ?? 10_000;
+        const timer = setTimeout(() => {
+            controller.abort();
+        }, timeoutMs);
+        try {
+            const headers = {
+                'Content-Type': 'application/json',
+                ...(init.headers ?? {})
+            };
+            const res = await fetch(`${this.baseUrl}${path}`, {
+                ...init,
+                signal: controller.signal,
+                headers
+            });
+            if (!res.ok) {
+                const body = await res.text();
+                throw new Error(`backup-server ${path} ${res.status}: ${body.slice(0, 200)}`);
+            }
+            const raw = await res.json();
+            if (raw !== null && typeof raw === 'object' && 'success' in raw) {
+                const wrapped = raw;
+                if (!wrapped.success) {
+                    throw new Error(`backup-server ${path} not-ok: ${JSON.stringify(wrapped.error)}`);
+                }
+                return wrapped.data;
+            }
+            return raw;
+        }
+        finally {
+            clearTimeout(timer);
+        }
+    }
+    async waitForReady(maxMs = 30_000, intervalMs = 1000) {
+        const deadline = Date.now() + maxMs;
+        let lastErr;
+        while (Date.now() < deadline) {
+            try {
+                await this.request('/api/health', { timeoutMs: 2000 });
+                return;
+            }
+            catch (err) {
+                lastErr = err;
+                await new Promise((r) => setTimeout(r, intervalMs));
+            }
+        }
+        throw new Error(`backup-server did not become ready within ${maxMs}ms: ${lastErr instanceof Error ? lastErr.message : String(lastErr)}`);
+    }
+    async getSettings() {
+        return this.request('/api/settings');
+    }
+    async putSettings(patch) {
+        return this.request('/api/settings', {
+            method: 'PUT',
+            body: JSON.stringify(patch)
+        });
+    }
+    async getGuiUrl() {
+        return this.request('/api/gui-url');
+    }
+    get base() {
+        return this.baseUrl;
+    }
+}
+//# sourceMappingURL=backup-client.js.map

package/plugin/backup-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"backup-client.js","sourceRoot":"","sources":["../src/backup-client.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAuBH,MAAM,OAAO,YAAY;IACM;IAA7B,YAA6B,OAAe;QAAf,YAAO,GAAP,OAAO,CAAQ;IAAG,CAAC;IAExC,KAAK,CAAC,OAAO,CACnB,IAAY,EACZ,OAA6C,EAAE;QAE/C,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAA;QACxC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,IAAI,MAAM,CAAA;QAC1C,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;YAC5B,UAAU,CAAC,KAAK,EAAE,CAAA;QACpB,CAAC,EAAE,SAAS,CAAC,CAAA;QACb,IAAI,CAAC;YACH,MAAM,OAAO,GAA2B;gBACtC,cAAc,EAAE,kBAAkB;gBAClC,GAAG,CAAE,IAAI,CAAC,OAA8C,IAAI,EAAE,CAAC;aAChE,CAAA;YACD,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,EAAE;gBAChD,GAAG,IAAI;gBACP,MAAM,EAAE,UAAU,CAAC,MAAM;gBACzB,OAAO;aACR,CAAC,CAAA;YACF,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBACZ,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAA;gBAC7B,MAAM,IAAI,KAAK,CAAC,iBAAiB,IAAI,IAAI,GAAG,CAAC,MAAM,KAAK,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAA;YAC/E,CAAC;YACD,MAAM,GAAG,GAAY,MAAM,GAAG,CAAC,IAAI,EAAE,CAAA;YACrC,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,SAAS,IAAI,GAAG,EAAE,CAAC;gBAChE,MAAM,OAAO,GAAG,GAAuD,CAAA;gBACvE,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;oBACrB,MAAM,IAAI,KAAK,CAAC,iBAAiB,IAAI,YAAY,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;gBACnF,CAAC;gBACD,OAAO,OAAO,CAAC,IAAS,CAAA;YAC1B,CAAC;YACD,OAAO,GAAQ,CAAA;QACjB,CAAC;gBAAS,CAAC;YACT,YAAY,CAAC,KAAK,CAAC,CAAA;QACrB,CAAC;IACH,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,KAAK,GAAG,MAAM,EAAE,UAAU,GAAG,IAAI;QAClD,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAA;QACnC,IAAI,OAAgB,CAAA;QACpB,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,QAAQ,EAAE,CAAC;YAC7B,IAAI,CAAC;gBACH,MAAM,IAAI,CAAC,OAAO,CAAqB,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;gBAC1E,OAAM;YACR,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,GAAG,GAAG,CAAA;gBACb,MAAM,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC,CAAA;YACrD,CAAC;QACH,CAAC;QACD,MAAM,IAAI,KAAK,CACb,6CAA6C,KAAK,OAChD,OAAO,YAAY,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAC7D,EAAE,CACH,CAAA;IACH,CAAC;IAED,KAAK,CAAC,WAAW;QACf,OAAO,IAAI,CAAC,OAAO,CAAuB,eAAe,CAAC,CAAA;IAC5D,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,KAAoC;QACpD,OAAO,IAAI,CAAC,OAAO,CAAuB,eAAe,EAAE;YACzD,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;SAC5B,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,SAAS;QACb,OAAO,IAAI,CAAC,OAAO,CAAkB,cAAc,CAAC,CAAA;IACtD,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;CACF"}

package/plugin/config/schema.d.ts

@@ -0,0 +1,32 @@
+import { Static } from '@sinclair/typebox';
+/**
+ * Schema for the SignalK Admin UI plugin config form.
+ *
+ * Most user-facing settings (schedule, retention, cloud sync, exclusions)
+ * live inside the backup-server container's own UI — open it via the
+ * "Open Backup Console" link from /plugins/signalk-backup/. The fields
+ * below are only the per-deployment knobs the SignalK admin needs.
+ */
+export declare const ConfigSchema: import("@sinclair/typebox").TObject<{
+    managedContainer: import("@sinclair/typebox").TBoolean;
+    imageTag: import("@sinclair/typebox").TString;
+    externalUrl: import("@sinclair/typebox").TString;
+    logLevel: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"trace">, import("@sinclair/typebox").TLiteral<"debug">, import("@sinclair/typebox").TLiteral<"info">, import("@sinclair/typebox").TLiteral<"warn">, import("@sinclair/typebox").TLiteral<"error">, import("@sinclair/typebox").TLiteral<"fatal">]>;
+    databaseExport: import("@sinclair/typebox").TObject<{
+        questdb: import("@sinclair/typebox").TBoolean;
+        intervalMinutes: import("@sinclair/typebox").TNumber;
+    }>;
+}>;
+export type Config = Static<typeof ConfigSchema>;
+/**
+ * Materialised defaults — Signal K only uses the schema's `default` fields
+ * to seed the Admin UI form, NOT to inject defaults into the runtime config
+ * object passed to `plugin.start()`. When the plugin is auto-enabled
+ * (signalk-plugin-enabled-by-default) or enabled without saving the form,
+ * start() receives `{}`. Spread SCHEMA_DEFAULTS in start() so every field
+ * is present at runtime.
+ *
+ * See AGENTS.md §"Plugin-specific gotchas".
+ */
+export declare const SCHEMA_DEFAULTS: Config;
+//# sourceMappingURL=schema.d.ts.map

package/plugin/config/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/config/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAEhD;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY;;;;;;;;;EA8DvB,CAAA;AAEF,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,YAAY,CAAC,CAAA;AAEhD;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe,EAAE,MAS7B,CAAA"}