@calebcall/camera-ui-notify 0.4.0 → 0.4.2

package/CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to **Notify** are documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.2] - 2026-07-25
+
+### Updated
+
+- **README** - Updated README.md to fix broken lines and fix incorrect statements.
+
+## [0.4.1] - 2026-07-25
+
+### Changed
+
+- Verification of the automated GitHub Actions publish pipeline (npm Trusted Publishing / OIDC). No functional changes since 0.4.0.
+
 ## [0.4.0] - 2026-07-25
 
 ### Added

package/README.md

@@ -3,69 +3,36 @@
 <p align="center">
   A fully-local, multi-backend <a href="https://github.com/seydx/camera.ui">camera.ui</a> notifier
   plugin — delivers notifications to a service you control (<a href="https://ntfy.sh">ntfy</a>,
-  <a href="https://gotify.net">Gotify</a>, Pushover, Telegram, Discord, or a generic webhook),
-  entirely on your own hardware, with no cloud dependency and no license check.
+  <a href="https://gotify.net">Gotify</a>, Pushover, Telegram, Discord, or a generic webhook).
 </p>
 
 ---
 
 ## Why this exists
 
-camera.ui separates two notification roles:
 
-- **Publishers** (capability `PublishNotifications`) emit events. Our open-source NVR plugin
-  (`@calebcall/camera-ui-nvr-local`) is a publisher — it calls `NotificationManager.Publish` for
-  object-detection events.
-- **Notifiers** (interface `Notifier`) own delivery *devices* and actually deliver notifications.
-  The host's `NotificationManager.notify()` fans every notification out to **all** running plugins
-  implementing `Notifier`.
+There is intentionally no notifier in the open ecosystem: the closed, official NVR bundles a notifier that pushed to the camera.ui mobile app through camera.ui's proprietary FCM/APNs cloud relay. This plugin takes the only fully-local road to real background push instead: delivering to a push/webhook service *you* run or control.
 
-There is intentionally no notifier in the open ecosystem: the closed, official NVR bundled a
-notifier that pushed to the camera.ui mobile app through camera.ui's proprietary FCM/APNs cloud
-relay — a license-gated path we neither have credentials for nor can replicate. This plugin takes
-the only fully-local road to real background push instead: delivering to a push/webhook service
-*you* run or control.
-
-This plugin is a pure **notifier**. It is decoupled from any single publisher — it delivers
-notifications from **any** publisher, including our NVR plugin's detection events and camera.ui's
-own system notifications, not just one plugin's output.
+This plugin is a pure **notifier**. It is decoupled from any single publisher — it delivers notifications from **any** publisher, including our NVR plugin's detection events and camera.ui's own system notifications, not just one plugin's output.
 
 ## How it works
 
 One plugin, contract `interfaces: [Notifier]`, built around a pluggable-backend (strategy) pattern:
 
-- A `Backend` interface abstracts one delivery service (id, label, config schema, target
-  validation, and delivery).
-- A package-level registry maps each backend's stable id to its implementation; every backend
-  self-registers from its own `init()`.
-- The plugin holds **one active target** in its own persisted config (`StorageSchema`): which
-  service is selected, plus that service's validated fields. `getDevices` synthesizes a single
-  `sdk.NotifierDevice` from this config on every call — there is no device registry.
-- `sendNotification` dispatches the synthesized device to its backend's `Send`. A backend failure
-  is logged and returned to the host.
+- A `Backend` interface abstracts one delivery service (id, label, config schema, target validation, and delivery).
+- A package-level registry maps each backend's stable id to its implementation; every backend self-registers from its own `init()`.
+- The plugin holds **one active target** in its own persisted config (`StorageSchema`): which service is selected, plus that service's validated fields. `getDevices` synthesizes a single `sdk.NotifierDevice` from this config on every call — there is no device registry.
+- `sendNotification` dispatches the synthesized device to its backend's `Send`. A backend failure is logged and returned to the host.
 
 ### Why config, not device registration
 
-Earlier versions of this plugin modeled targets as registrable `NotifierDevice`s, the way
-camera.ui's own mobile-push notifier does. That model turned out to be unreachable from the stock
-UI: `registerDevice` is only ever called by the camera.ui mobile app's push-registration flow,
-which is hardcoded to the official NVR's plugin name. The generic notification settings panel
-renders `notificationSettings()` read-only — it has no "add a device" affordance for third-party
-plugins. The one part of the stock UI that **does** render an editable, savable form for a
-third-party plugin is its own settings page, which renders whatever `StorageSchema` the plugin
-declares. So Notify now models its target as plugin config instead of a device: you configure it
-once, in the plugin's own settings, and `getDevices` synthesizes the device the host's
-`Notifier` interface expects from that config.
-
-Adding a new backend later is **one new file** — `src/backend/<name>.go` implementing `Backend`
-plus `Register(...)` in its `init()` — and a version bump. No new plugin, no core change, no
-changes to `plugin.go`.
+Earlier versions of this plugin modeled targets as registrable `NotifierDevice`s, the way camera.ui's own mobile-push notifier does. That model turned out to be unreachable from the stock UI: `registerDevice` is only ever called by the camera.ui mobile app's push-registration flow, which is hardcoded to the official NVR's plugin name. The generic notification settings panel renders `notificationSettings()` read-only — it has no "add a device" affordance for third-party plugins. The one part of the stock UI that **does** render an editable, savable form for a third-party plugin is its own settings page, which renders whatever `StorageSchema` the plugin declares. So Notify now models its target as plugin config instead of a device: you configure it once, in the plugin's own settings, and `getDevices` synthesizes the device the host's `Notifier` interface expects from that config.
+
+Adding a new backend later is **one new file** — `src/backend/<name>.go` implementing `Backend` plus `Register(...)` in its `init()` — and a version bump. No new plugin, no core change, no changes to `plugin.go`.
 
 ## Backends (v1)
 
-Severity is mapped consistently across backends via `backend.PriorityScale`, which spreads
-camera.ui's four severity levels (`info` → `warn` → `error` → `critical`) evenly across each
-backend's native priority range, `info` at the low end and `critical` at the high end.
+Severity is mapped consistently across backends via `backend.PriorityScale`, which spreads camera.ui's four severity levels (`info` → `warn` → `error` → `critical`) evenly across each backend's native priority range, `info` at the low end and `critical` at the high end.
 
 ### ntfy
 
@@ -77,9 +44,7 @@ Publishes to [ntfy.sh](https://ntfy.sh) or a self-hosted ntfy server.
 | `topic`  | yes      | —                     | The ntfy topic to publish to.                      |
 | `token`  | no       | —                     | Access token for a protected/self-hosted topic, sent as `Authorization: Bearer <token>`. |
 
-Delivery: `POST {server}/{topic}` with the notification body as the request body, plus `Title`,
-`Priority` (1–5, from severity), `Click` (deep link, if set), and `Attach`/`Icon` (image URL, if
-set) headers.
+Delivery: `POST {server}/{topic}` with the notification body as the request body, plus `Title`, `Priority` (1–5, from severity), `Click` (deep link, if set), and `Attach`/`Icon` (image URL, if set) headers.
 
 ### Gotify
 
@@ -90,9 +55,7 @@ Publishes to a self-hosted [Gotify](https://gotify.net) server.
 | `server` | yes      | Base URL of the Gotify server. Trailing `/` trimmed. |
 | `token`  | yes      | Gotify application token, used to authenticate published messages. |
 
-Delivery: `POST {server}/message?token={token}` with a JSON body `{title, message, priority}`
-(priority 0–10, from severity), plus a `client::notification.click` extra for the deep link and a
-`bigImageUrl` extra when an image URL is set.
+Delivery: `POST {server}/message?token={token}` with a JSON body `{title, message, priority}` (priority 0–10, from severity), plus a `client::notification.click` extra for the deep link and a `bigImageUrl` extra when an image URL is set.
 
 ### Generic webhook
 
@@ -105,9 +68,7 @@ Delivers to any HTTP endpoint you provide — the fallback for anything without
 | `headerName`  | no       | —       | Optional custom header name (e.g. for a shared secret). Requires `headerValue` if set. |
 | `headerValue` | no       | —       | Value of the custom header. Requires `headerName` if set.       |
 
-Delivery: `{method} {url}` with `Content-Type: application/json` and (if configured) the custom
-header, carrying a JSON body of `{title, subtitle, body, severity, tag, imageUrl, deepLink, data,
-createdAt, thumbnailBase64}`.
+Delivery: `{method} {url}` with `Content-Type: application/json` and (if configured) the custom header, carrying a JSON body of `{title, subtitle, body, severity, tag, imageUrl, deepLink, data, createdAt, thumbnailBase64}`.
 
 ### Pushover
 
@@ -118,9 +79,7 @@ Hosted push to the [Pushover](https://pushover.net) app.
 | `token`  | yes      | Pushover application API token/key.            |
 | `user`   | yes      | Your Pushover user or group key.               |
 
-Delivery: `POST https://api.pushover.net/1/messages.json` with title/message and a priority
-(Info→0 normal, everything higher→1 high; never emergency). The snapshot **image** is sent as an
-`attachment`, and an absolute deep link becomes a supplementary `url`.
+Delivery: `POST https://api.pushover.net/1/messages.json` with title/message and a priority (Info→0 normal, everything higher→1 high; never emergency). The snapshot **image** is sent as an `attachment`, and an absolute deep link becomes a supplementary `url`.
 
 ### Telegram
 
@@ -131,8 +90,7 @@ Delivers to a chat via a [Telegram bot](https://core.telegram.org/bots).
 | `token` | yes      | Bot token from @BotFather.                               |
 | `chat`  | yes      | Chat ID to deliver to.                                   |
 
-Delivery: `sendPhoto` (with the snapshot **image** + caption) when a thumbnail is present, otherwise
-`sendMessage`. An absolute deep link is added as an inline "Open camera" button.
+Delivery: `sendPhoto` (with the snapshot **image** + caption) when a thumbnail is present, otherwise `sendMessage`. An absolute deep link is added as an inline "Open camera" button.
 
 ### Discord
 
@@ -142,8 +100,7 @@ Delivers to a channel via a Discord [webhook](https://support.discord.com/hc/en-
 | --------- | -------- | --------------------------------------- |
 | `webhook` | yes      | Channel webhook URL.                    |
 
-Delivery: a rich embed (title, body, severity color — blue/yellow/red) with the snapshot **image**
-attached; an absolute deep link makes the title a link.
+Delivery: a rich embed (title, body, severity color — blue/yellow/red) with the snapshot **image** attached; an absolute deep link makes the title a link.
 
 > **Images:** ntfy, Pushover, Telegram, and Discord all render the detection snapshot. Gotify is
 > text + link only (it needs a hosted image URL, which this fully-local plugin doesn't provide).
@@ -156,39 +113,28 @@ attached; an absolute deep link makes the title a link.
 There is no "add device" flow. Instead, configure the plugin itself:
 
 1. Open the **Notify** plugin's page in camera.ui (Plugins → Notify).
-2. In its settings, pick a **Service** (`ntfy`, `Gotify`, `Generic webhook`, `Pushover`, `Telegram`,
-   or `Discord`) from the dropdown built from the registered backends.
-3. Fill in that service's fields — only the selected service's fields are shown; the rest are
-   condition-gated out.
-4. Save. The config is validated (`ParseTarget`) the next time a notification is dispatched;
-   `getDevices` then synthesizes one delivery target from it, and notifications from any publisher
-   are delivered there.
-
-This is a **single, instance-wide target** in v1 — there's no way to register several devices at
-once. Changing the config replaces the previous target rather than adding to it. Delivery for that
-one target is a single request per notification (no fan-out to worry about, since there's only one
-device).
+2. In its settings, pick a **Service** (`ntfy`, `Gotify`, `Generic webhook`, `Pushover`, `Telegram`, or `Discord`) from the dropdown built from the registered backends.
+3. Fill in that service's fields — only the selected service's fields are shown; the rest are condition-gated out.
+4. Save. The config is validated (`ParseTarget`) the next time a notification is dispatched; `getDevices` then synthesizes one delivery target from it, and notifications from any publisher are delivered there.
+
+This is a **single, instance-wide target** in v1 — there's no way to register several devices at once. Changing the config replaces the previous target rather than adding to it. Delivery for that one target is a single request per notification (no fan-out to worry about, since there's only one device).
 
 ## Tech stack
 
 - **Go** (matches the NVR plugin; same build/deploy toolchain).
 - **camera.ui SDK (Go)** for the plugin runtime, the `Notifier` RPC surface, and device storage.
-- Delivery via each backend's plain HTTP API using the Go stdlib `net/http` — no third-party HTTP
-  client libraries.
-- Config persistence via the plugin's own `DeviceStorage`, holding the selected service and its
-  fields as declared by `StorageSchema()` — no SQLite; it's a handful of scalar values.
+- Delivery via each backend's plain HTTP API using the Go stdlib `net/http` — no third-party HTTP client libraries.
+- Config persistence via the plugin's own `DeviceStorage`, holding the selected service and its fields as declared by `StorageSchema()` — no SQLite; it's a handful of scalar values.
 
 ## Prerequisites
 
 - **Go 1.26+** (to build the plugin binary).
-- **Node.js 22+** and the plugin's dev dependencies (`npm install`) to produce the `contract.cjs`
-  bundle via the camera.ui CLI.
+- **Node.js 22+** and the plugin's dev dependencies (`npm install`) to produce the `contract.cjs` bundle via the camera.ui CLI.
 - A running camera.ui instance you control (the host where the plugin gets installed).
 
 ## Build & deploy locally
 
-camera.ui loads the **built artifact**, not source — a `git pull` alone does nothing. You must
-build the bundle (`contract.cjs` + the platform binary) and copy it into the install slot.
+camera.ui loads the **built artifact**, not source — a `git pull` alone does nothing. You must build the bundle (`contract.cjs` + the platform binary) and copy it into the install slot.
 
 The install slot is:
 
@@ -196,9 +142,7 @@ The install slot is:
 <camera.ui-install>/plugins/@calebcall/camera-ui-notify/
 ```
 
-and the plugin's config (the selected service and its fields) lives under
-`<camera.ui-install>/volume/plugins/storage/@calebcall/camera-ui-notify/` — reinstalling the code
-does not touch it.
+and the plugin's config (the selected service and its fields) lives under `<camera.ui-install>/volume/plugins/storage/@calebcall/camera-ui-notify/` — reinstalling the code does not touch it.
 
 > **Unlike the NVR plugin**, there is no hardcoded-package-id requirement here: the camera.ui host
 > discovers notifiers by the `Notifier` **interface** declared in the plugin's contract, not by a
@@ -221,10 +165,7 @@ npm run bundle:dev
 D=<camera.ui-install>/plugins/@calebcall/camera-ui-notify
 mkdir -p "$D" && rm -rf "$D"/* && cp -a bundle/. "$D/"
 
-# 4. First time only: enable it — remove the "@calebcall/camera-ui-notify" line
-#    from disabledPlugins in <camera.ui-install>/volume/camera.ui.yaml
-
-# 5. Restart camera.ui
+# 4. Restart camera.ui
 systemctl restart cameraui   # or however your instance is managed
 ```
 
@@ -240,8 +181,7 @@ npm install
 npm run bundle:dev
 
 # 2. Cross-compile the Linux binary into the bundle's dev path
-GOOS=linux GOARCH=amd64 CGO_ENABLED=0 \
-  go build -ldflags "-s -w" -o bundle/dist/bin/plugin ./src/
+GOOS=linux GOARCH=amd64 CGO_ENABLED=0 \ go build -ldflags "-s -w" -o bundle/dist/bin/plugin ./src/
 chmod 755 bundle/dist/bin/plugin
 
 # 3. Ship it (strip macOS junk so the server dir stays clean)
@@ -249,15 +189,10 @@ COPYFILE_DISABLE=1 tar czf /tmp/notify-install.tgz -C bundle .
 scp /tmp/notify-install.tgz root@YOUR_SERVER:/tmp/
 
 # 4. On the server: install into the slot, enable (first time), restart
-ssh root@YOUR_SERVER '
-  D=<camera.ui-install>/plugins/@calebcall/camera-ui-notify
-  mkdir -p "$D" && rm -rf "$D"/* && tar xzf /tmp/notify-install.tgz -C "$D"
-  systemctl restart cameraui
-'
+ssh root@YOUR_SERVER 'D=<camera.ui-install>/plugins/@calebcall/camera-ui-notify mkdir -p "$D" && rm -rf "$D"/* && tar xzf /tmp/notify-install.tgz -C "$D"; systemctl restart cameraui'
 ```
 
-Set `GOARCH=arm64` for ARM hosts. The binary is resolved from the dev path
-`<slot>/dist/bin/plugin` before any platform `node_modules` package, so no npm publish is involved.
+Set `GOARCH=arm64` for ARM hosts. The binary is resolved from the dev path `<slot>/dist/bin/plugin` before any platform `node_modules` package, so no npm publish is involved.
 
 ### Verify it loaded and is being used
 
@@ -267,16 +202,12 @@ Tail the camera.ui log after restart:
 grep -iE "Notify|Spawning Go|notify: rpc" <camera.ui-install>/volume/camera.ui.log | tail
 ```
 
-You want to see the plugin spawn (`Spawning Go plugin ... dist/bin/plugin`) **and** the host
-actually calling into it — e.g. `notify: rpc getDevices` / `notificationSettings` /
-`sendNotification`.
+You want to see the plugin spawn (`Spawning Go plugin ... dist/bin/plugin`) **and** the host actually calling into it — e.g. `notify: rpc getDevices` / `notificationSettings` / `sendNotification`.
 
 ## Adding a new backend
 
-1. Create `src/backend/<name>.go` implementing the `Backend` interface (`ID`, `Label`, `Schema`,
-   `ParseTarget`, `Send`) — see `ntfy.go`, `gotify.go`, or `webhook.go` for the shape.
-2. Gate every schema field with `Condition: []sdk.SchemaCondition{{Key: "service", Value: ID()}}`
-   so it only renders when the new backend is selected.
+1. Create `src/backend/<name>.go` implementing the `Backend` interface (`ID`, `Label`, `Schema`, `ParseTarget`, `Send`) — see `ntfy.go`, `gotify.go`, or `webhook.go` for the shape.
+2. Gate every schema field with `Condition: []sdk.SchemaCondition{{Key: "service", Value: ID()}}` so it only renders when the new backend is selected.
 3. Call `backend.Register(new<Name>())` from an `init()` function in the same file.
 4. Bump the version in `package.json`.
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "displayName": "Notify",
   "name": "@calebcall/camera-ui-notify",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "A fully-local, multi-backend camera.ui notifier plugin: delivers notifications to ntfy, Gotify, or a generic webhook, entirely on your own hardware with no cloud dependency.",
   "author": "calebcall (https://github.com/calebcall/camera-ui-notify)",
   "main": "./main.go",
@@ -45,14 +45,14 @@
   "os": [],
   "cpu": [],
   "optionalDependencies": {
-    "@calebcall/camera-ui-notify-darwin-arm64": "0.4.0",
-    "@calebcall/camera-ui-notify-darwin-amd64": "0.4.0",
-    "@calebcall/camera-ui-notify-linux-amd64": "0.4.0",
-    "@calebcall/camera-ui-notify-linux-arm64": "0.4.0",
-    "@calebcall/camera-ui-notify-windows-amd64": "0.4.0",
-    "@calebcall/camera-ui-notify-windows-arm64": "0.4.0",
-    "@calebcall/camera-ui-notify-linux-amd64-musl": "0.4.0",
-    "@calebcall/camera-ui-notify-linux-arm64-musl": "0.4.0"
+    "@calebcall/camera-ui-notify-darwin-arm64": "0.4.2",
+    "@calebcall/camera-ui-notify-darwin-amd64": "0.4.2",
+    "@calebcall/camera-ui-notify-linux-amd64": "0.4.2",
+    "@calebcall/camera-ui-notify-linux-arm64": "0.4.2",
+    "@calebcall/camera-ui-notify-windows-amd64": "0.4.2",
+    "@calebcall/camera-ui-notify-windows-arm64": "0.4.2",
+    "@calebcall/camera-ui-notify-linux-amd64-musl": "0.4.2",
+    "@calebcall/camera-ui-notify-linux-arm64-musl": "0.4.2"
   },
   "files": [
     "bundle.zip",