@meshwhisper/push-service 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,27 @@
+# @meshwhisper/push-service
+
+Push-notification dispatcher for [MeshWhisper](https://github.com/twotwoonethree/meshwhisper). When a message arrives at a `@meshwhisper/node` for an offline device, the node calls this service's webhook and it fires a **silent, content-free wake signal** via Web Push (VAPID), APNs, or FCM. The device wakes, the SDK pulls the encrypted blobs, the app displays the message. No message content ever touches the push provider.
+
+## Run
+
+```bash
+npm install -g @meshwhisper/push-service
+PUSH_PORT=4000 VAPID_PUBLIC_KEY=... VAPID_PRIVATE_KEY=... VAPID_SUBJECT=mailto:you@example.com meshwhisper-push
+```
+
+Point your node at it: `PUSH_WEBHOOK_URL=http://localhost:4000/notify`.
+
+`npx @meshwhisper/cli init` scaffolds this as a Compose service with generated VAPID keys — you rarely need to set it up by hand.
+
+## Environment
+
+| Variable | Purpose |
+|---|---|
+| `PUSH_PORT` | Listen port (default 4000) |
+| `VAPID_PUBLIC_KEY` / `VAPID_PRIVATE_KEY` / `VAPID_SUBJECT` | Web Push (generate with `npx @meshwhisper/cli vapid`) |
+| `APNS_KEY_ID` / `APNS_TEAM_ID` / `APNS_KEY_PATH` / `APNS_BUNDLE_ID` | iOS (optional) |
+| `FCM_SERVICE_ACCOUNT_PATH` / `FCM_PROJECT_ID` | Android (optional) |
+
+Push tokens are the most sensitive metadata in a MeshWhisper deployment — this service is the only component that holds them, and you run it yourself.
+
+MIT

package/package.json

@@ -1,14 +1,18 @@
 {
   "name": "@meshwhisper/push-service",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "MeshWhisper push notification service — dispatches APNs and FCM wake signals",
   "type": "module",
   "main": "dist/index.js",
   "bin": {
     "meshwhisper-push": "dist/index.js"
   },
-  "files": ["dist"],
-  "publishConfig": { "access": "public" },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "prepublishOnly": "npm run build",
     "build": "tsc",