pi-smart-voice-notify 0.3.5 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [0.5.0] - 2026-05-22
+
+### Added
+- Added `PI_SMART_NOTIFY_AGENT_ERROR_GRACE_MS` to delay agent-error notifications briefly so related idle/error state can settle before notifying.
+- Added webhook destination hardening with public HTTP(S)-only validation, private/reserved host rejection, DNS validation, and DNS-pinned dispatch.
+
+### Changed
+- Added request timeouts and a 10 MiB audio response cap for remote ElevenLabs/OpenAI-compatible TTS fetches.
+- Improved Linux focus detection and moved debug log writes onto asynchronous file logging with flush support.
+- Reorganized checked-in tests into the dedicated `test/` directory with webhook, TTS, Linux, sound-theme, and notification coverage.
+
+## [0.4.0] - 2026-04-30
+
+### Added
+- Detect agent turn failures reported at `agent_end` and send error notifications instead of completion alerts.
+
+### Changed
+- Renamed bundled notification sound assets to stable lowercase filenames and migrate legacy bundled sound paths automatically.
+- Updated `@mariozechner/pi-*` peer dependency ranges to `^0.70.6` and synchronized package lock metadata.
+
 ## [0.3.5] - 2026-04-27
 
 ### Fixed

package/README.md

@@ -16,6 +16,7 @@ Windows-optimized smart notification extension for the Pi coding agent.
   - **Voice** – auto-selectable TTS engines: Edge, espeak-ng, ElevenLabs, OpenAI-compatible, and Windows SAPI
   - **Desktop toasts** – cross-platform notifications via `node-notifier` (Windows/macOS/Linux)
   - **Webhook delivery** – optional Discord or generic HTTP webhook notifications
+    - Validates webhook targets as public HTTP(S) destinations and blocks localhost/private/reserved networks before dispatch
 
 - **Intelligent event detection**
   - Task completion (idle)
@@ -133,6 +134,9 @@ A starter template is provided in `config/config.example.json`. On startup, the
 | `enableErrorNotification` | boolean | `true` | Notify on errors |
 | `suppressIdleAfterError` | boolean | `true` | Skip idle notification if turn had errors |
 
+
+Error notifications are delayed briefly before delivery so Pi can settle related turn state and suppress a redundant idle alert. Override the default 10000 ms delay with `PI_SMART_NOTIFY_AGENT_ERROR_GRACE_MS` when you need faster or slower error alerts.
+
 *Question notifications only work when a custom `question` tool is loaded.
 
 Forwarded permission watcher notifications use privacy-safe text, require the request `targetSessionId` to match the active Pi session, and never include raw forwarded `message` content.
@@ -166,10 +170,10 @@ Forwarded permission watcher notifications use privacy-safe text, require the re
 
 | Option | Type | Default |
 |--------|------|---------|
-| `idleSoundFile` | string | `"assets/Soft-high-tech-notification-sound-effect.mp3"` |
-| `permissionSoundFile` | string | `"assets/Machine-alert-beep-sound-effect.mp3"` |
-| `questionSoundFile` | string | `"assets/Machine-alert-beep-sound-effect.mp3"` |
-| `errorSoundFile` | string | `"assets/Machine-alert-beep-sound-effect.mp3"` |
+| `idleSoundFile` | string | `"assets/soft-notification.mp3"` |
+| `permissionSoundFile` | string | `"assets/attention-alert.mp3"` |
+| `questionSoundFile` | string | `"assets/attention-alert.mp3"` |
+| `errorSoundFile` | string | `"assets/attention-alert.mp3"` |
 
 Paths can be absolute or relative to the extension directory.
 
@@ -188,6 +192,9 @@ Paths can be absolute or relative to the extension directory.
 | `minNotificationIntervalMs` | number | `1500` | Throttle interval between same-type notifications |
 | `debugLog` | boolean | `false` | Enable debug logging to file |
 
+
+Webhook dispatch only attempts public `http`/`https` URLs. The extension rejects localhost-style names, `.local`/`.internal`/`.lan`/`.home.arpa` hosts, private or reserved IP literals, and hostnames whose DNS results include private or reserved addresses; validated DNS results are pinned for the outbound request. Use `PI_SMART_NOTIFY_WEBHOOK_TIMEOUT_MS` to override the default 8000 ms webhook request timeout.
+
 ## Notification Modes
 
 | Mode | Behavior |

package/config/config.example.json

@@ -94,10 +94,10 @@
   "openaiTtsSpeed": 1,
 
   "_comment_sounds": "Direct sound file fallbacks.",
-  "idleSoundFile": "assets/Soft-high-tech-notification-sound-effect.mp3",
-  "permissionSoundFile": "assets/Machine-alert-beep-sound-effect.mp3",
-  "questionSoundFile": "assets/Machine-alert-beep-sound-effect.mp3",
-  "errorSoundFile": "assets/Machine-alert-beep-sound-effect.mp3",
+  "idleSoundFile": "assets/soft-notification.mp3",
+  "permissionSoundFile": "assets/attention-alert.mp3",
+  "questionSoundFile": "assets/attention-alert.mp3",
+  "errorSoundFile": "assets/attention-alert.mp3",
 
   "_comment_sound_theme": "Sound theme settings.",
   "themePath": "",

package/package.json

@@ -1,70 +1,74 @@
-{
-  "name": "pi-smart-voice-notify",
-  "version": "0.3.5",
-  "description": "Windows-optimized smart voice, sound, and desktop notifications for Pi coding agent.",
-  "type": "module",
-  "main": "./index.ts",
-  "exports": {
-    ".": "./index.ts"
-  },
-  "files": [
-    "index.ts",
-    "src",
-    "config/config.example.json",
-    "assets",
-    "README.md",
-    "CHANGELOG.md",
-    "LICENSE"
-  ],
-  "scripts": {
-    "build": "npx --yes -p typescript@5.7.3 -p @types/node@20.17.57 tsc -p tsconfig.json --noEmit",
-    "lint": "npm run build",
-    "test": "node --experimental-strip-types --test src/abortable-command.test.ts src/reminder-playback.test.ts src/permission-forwarding-watcher.test.ts src/index.test.ts",
-    "check": "npm run build && npm run test"
-  },
-  "keywords": [
-    "pi-package",
-    "pi",
-    "pi-extension",
-    "pi-coding-agent",
-    "coding-agent",
-    "voice-notify",
-    "desktop-notification",
-    "notifications",
-    "voice",
-    "audio",
-    "text-to-speech",
-    "tts",
-    "windows",
-    "linux",
-    "macos"
-  ],
-  "author": "MasuRii",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/MasuRii/pi-smart-voice-notify.git"
-  },
-  "homepage": "https://github.com/MasuRii/pi-smart-voice-notify#readme",
-  "bugs": {
-    "url": "https://github.com/MasuRii/pi-smart-voice-notify/issues"
-  },
-  "engines": {
-    "node": ">=24"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "pi": {
-    "extensions": [
-      "./index.ts"
-    ]
-  },
-  "peerDependencies": {
-    "@mariozechner/pi-coding-agent": "^0.70.2",
-    "@mariozechner/pi-tui": "^0.70.2"
-  },
-  "dependencies": {
-    "node-notifier": "^10.0.1"
-  }
-}
+{
+  "name": "pi-smart-voice-notify",
+  "version": "0.5.0",
+  "description": "Windows-optimized smart voice, sound, and desktop notifications for Pi coding agent.",
+  "type": "module",
+  "main": "./index.ts",
+  "exports": {
+    ".": "./index.ts"
+  },
+  "files": [
+    "index.ts",
+    "src",
+    "config/config.example.json",
+    "assets",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "npx --yes -p typescript@5.7.3 -p @types/node@20.17.57 tsc -p tsconfig.json --noEmit",
+    "lint": "npm run build",
+    "test": "node --experimental-strip-types --test test/abortable-command.test.ts test/reminder-playback.test.ts test/permission-forwarding-watcher.test.ts test/sound-theme.test.ts test/webhook.test.ts test/linux.test.ts test/index.test.ts test/tts.test.ts",
+    "check": "npm run build && npm run test"
+  },
+  "keywords": [
+    "pi-package",
+    "pi",
+    "pi-extension",
+    "pi-coding-agent",
+    "coding-agent",
+    "voice-notify",
+    "desktop-notification",
+    "notifications",
+    "voice",
+    "audio",
+    "text-to-speech",
+    "tts",
+    "windows",
+    "linux",
+    "macos"
+  ],
+  "author": "MasuRii",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MasuRii/pi-smart-voice-notify.git"
+  },
+  "homepage": "https://github.com/MasuRii/pi-smart-voice-notify#readme",
+  "bugs": {
+    "url": "https://github.com/MasuRii/pi-smart-voice-notify/issues"
+  },
+  "engines": {
+    "node": ">=24"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "pi": {
+    "extensions": [
+      "./index.ts"
+    ]
+  },
+  "peerDependencies": {
+    "@earendil-works/pi-coding-agent": "^0.75.4",
+    "@earendil-works/pi-tui": "^0.75.4"
+  },
+  "dependencies": {
+    "node-notifier": "^10.0.1",
+    "undici": "^8.3.0"
+  },
+  "devDependencies": {
+    "@types/node": "20.17.57"
+  }
+}

package/src/config-store.ts

@@ -1,4 +1,4 @@
-import { getAgentDir } from "@mariozechner/pi-coding-agent";
+import { getAgentDir } from "@earendil-works/pi-coding-agent";
 import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
 import { isAbsolute, join } from "node:path";
 
@@ -174,10 +174,10 @@ export const DEFAULT_CONFIG: VoiceNotifyConfig = {
 	openaiTtsFormat: "mp3",
 	openaiTtsSpeed: 1,
 
-	idleSoundFile: "assets/Soft-high-tech-notification-sound-effect.mp3",
-	permissionSoundFile: "assets/Machine-alert-beep-sound-effect.mp3",
-	questionSoundFile: "assets/Machine-alert-beep-sound-effect.mp3",
-	errorSoundFile: "assets/Machine-alert-beep-sound-effect.mp3",
+	idleSoundFile: "assets/soft-notification.mp3",
+	permissionSoundFile: "assets/attention-alert.mp3",
+	questionSoundFile: "assets/attention-alert.mp3",
+	errorSoundFile: "assets/attention-alert.mp3",
 	themePath: "",
 	themeName: "default",
 	themesRootPath: "",
@@ -344,6 +344,34 @@ function stringOrDefault(value: unknown, fallback: string): string {
 	return fallback;
 }
 
+const LEGACY_BUNDLED_SOUND_FILES: Record<string, string> = {
+	"assets/machine-alert-beep-sound-effect.mp3": "assets/attention-alert.mp3",
+	"assets/soft-high-tech-notification-sound-effect.mp3": "assets/soft-notification.mp3",
+};
+
+function normalizeSoundFileLookup(value: string): string {
+	return value.replaceAll("\\", "/").replace(/^\.\//, "").toLowerCase();
+}
+
+function soundFileExists(value: string): boolean {
+	return existsSync(isAbsolute(value) ? value : join(CONFIG_DIR, value));
+}
+
+function normalizeSoundFile(value: unknown, fallback: string): string {
+	const selected = stringOrDefault(value, fallback);
+	const lookup = normalizeSoundFileLookup(selected);
+	const migrated = LEGACY_BUNDLED_SOUND_FILES[lookup];
+	if (migrated) {
+		return migrated;
+	}
+
+	if (lookup.startsWith("assets/") && !soundFileExists(selected) && soundFileExists(fallback)) {
+		return fallback;
+	}
+
+	return selected;
+}
+
 function stringOrEmpty(value: unknown): string {
 	if (typeof value === "string") {
 		return value.trim();
@@ -746,13 +774,13 @@ export function normalizeConfig(raw: unknown): VoiceNotifyConfig {
 		openaiTtsFormat: stringOrDefault(record.openaiTtsFormat, DEFAULT_CONFIG.openaiTtsFormat),
 		openaiTtsSpeed: clampNumber(record.openaiTtsSpeed, DEFAULT_CONFIG.openaiTtsSpeed, 0.25, 4),
 
-		idleSoundFile: stringOrDefault(record.idleSoundFile ?? record.idleSound, DEFAULT_CONFIG.idleSoundFile),
-		permissionSoundFile: stringOrDefault(
+		idleSoundFile: normalizeSoundFile(record.idleSoundFile ?? record.idleSound, DEFAULT_CONFIG.idleSoundFile),
+		permissionSoundFile: normalizeSoundFile(
 			record.permissionSoundFile ?? record.permissionSound,
 			DEFAULT_CONFIG.permissionSoundFile,
 		),
-		questionSoundFile: stringOrDefault(record.questionSoundFile ?? record.questionSound, DEFAULT_CONFIG.questionSoundFile),
-		errorSoundFile: stringOrDefault(record.errorSoundFile ?? record.errorSound, DEFAULT_CONFIG.errorSoundFile),
+		questionSoundFile: normalizeSoundFile(record.questionSoundFile ?? record.questionSound, DEFAULT_CONFIG.questionSoundFile),
+		errorSoundFile: normalizeSoundFile(record.errorSoundFile ?? record.errorSound, DEFAULT_CONFIG.errorSoundFile),
 		themePath: stringOrEmpty(record.themePath ?? record.soundThemeDir ?? record.themeDirectory),
 		themeName: stringOrDefault(record.themeName, DEFAULT_CONFIG.themeName),
 		themesRootPath: stringOrEmpty(record.themesRootPath ?? record.themesRootDirectory),
@@ -989,7 +1017,7 @@ export function isWindows(): boolean {
 
 export function resolveSoundFile(config: VoiceNotifyConfig, type: NotificationType): string | null {
 	const field = SOUND_FILE_FIELD[type];
-	const value = config[field];
+	const value = normalizeSoundFile(config[field], DEFAULT_CONFIG[field]);
 	if (!value.trim()) {
 		return null;
 	}