oc-sounds 0.1.1 → 0.1.2

package/README.md

@@ -95,7 +95,8 @@ hooks. The built-in tool palette is:
 | --- | --- |
 | Read files | `page` |
 | Glob and grep | `release` |
-| Web search and fetch | `arrival` |
+| Web search | `arrival` |
+| Web fetch | `loading` |
 | Write and edit | `toggle` |
 | Patch a file | `arrival` |
 | Shell / code execution | `tick` |
@@ -104,6 +105,7 @@ hooks. The built-in tool palette is:
 | Ask the user a question | `chime` |
 | Other tools | `tick` |
 | Tool succeeds / fails | `release` / `error` |
+| Web fetch succeeds | `ready` |
 
 Session actions also have cues. The option keys are listed below:
 
@@ -147,9 +149,9 @@ lifecycle cues.
 ## Customize
 
 **Every action's sound is configurable.** Use `cues` for session actions such as
-thinking, replying, and completion, and `tools` for individual tool-start sounds
-such as read, edit, and web fetch. Set a value to any Cuelume sound name, or `false`
-to mute it. Omitted settings keep their defaults.
+thinking, replying, and completion, `tools` for individual tool-start sounds,
+and `returns` for successful per-tool return sounds. Set a value to any Cuelume
+sound name, or `false` to mute it. Omitted settings keep their defaults.
 
 Edit the existing plugin entry in `~/.config/opencode/opencode.jsonc` (global)
 or your project's `opencode.jsonc`. Merge it with your other settings. If you use
@@ -180,9 +182,12 @@ a local checkout, keep its directory path in `package`:
           "read": "tick",
           "edit": "toggle",
           "shell": "pulse",
-          "webfetch": "arrival",
+          "webfetch": "loading",
           "websearch": "arrival",
           "my_mcp_tool": "sparkle"
+        },
+        "returns": {
+          "webfetch": "ready"
         }
       }
     }
@@ -215,6 +220,10 @@ does not require rebuilding or reinstalling the plugin.
   name (`read` also matches `functions.read` / `functions_read`). Exact names
   take precedence. `false` mutes that tool's starting cue; completion and error
   cues are controlled separately. Tool overrides take precedence over `cues.tool`.
+- `returns`: override successful return cues by exact effective tool name or
+  built-in short name. The default `webfetch` return is `ready`; other successful
+  tools fall back to `cues.toolComplete`. Set a value to `false` to mute that
+  tool's successful return without muting its starting cue.
 
 All 17 Cuelume sounds are available:
 `chime`, `sparkle`, `droplet`, `bloom`, `whisper`, `tick`, `press`, `release`,

package/dist/config.d.ts

@@ -23,6 +23,7 @@ export declare const defaultCues: {
 };
 export type Action = keyof typeof defaultCues;
 export declare const defaultToolCues: Record<string, SoundName>;
+export declare const defaultToolReturnCues: Record<string, SoundName>;
 export type PlayerName = "auto" | "paplay" | "pw-play" | "afplay" | "ffplay";
 export declare const defaultPlayback: {
     minIntervalMs: number;
@@ -39,5 +40,6 @@ export interface Options {
     playback: PlaybackOptions;
     cues: Record<Action, SoundName | false>;
     tools: Record<string, SoundName | false>;
+    returns: Record<string, SoundName | false>;
 }
 export declare function parseOptions(input: unknown): Options;

package/dist/config.js

@@ -29,7 +29,7 @@ export const defaultToolCues = {
     glob: "release",
     grep: "release",
     websearch: "arrival",
-    webfetch: "arrival",
+    webfetch: "loading",
     write: "toggle",
     edit: "toggle",
     patch: "arrival",
@@ -41,6 +41,9 @@ export const defaultToolCues = {
     task: "arrival",
     skill: "sparkle",
 };
+export const defaultToolReturnCues = {
+    webfetch: "ready",
+};
 export const defaultPlayback = { minIntervalMs: 180, dedupeWindowMs: 300 };
 function object(value) {
     if (value && typeof value === "object" && !Array.isArray(value)) {
@@ -56,7 +59,7 @@ function cue(value) {
 export function parseOptions(input) {
     const raw = object(input);
     for (const key of Object.keys(raw)) {
-        if (!["enabled", "volume", "player", "playback", "cues", "tools"].includes(key)) {
+        if (!["enabled", "volume", "player", "playback", "cues", "tools", "returns"].includes(key)) {
             throw new Error(`oc-sounds: unknown option ${key}`);
         }
     }
@@ -80,6 +83,9 @@ export function parseOptions(input) {
     const tools = Object.create(null);
     for (const [key, value] of Object.entries(object(raw.tools ?? {})))
         tools[key] = cue(value);
+    const returns = Object.create(null);
+    for (const [key, value] of Object.entries(object(raw.returns ?? {})))
+        returns[key] = cue(value);
     const playback = { ...defaultPlayback };
     for (const [key, value] of Object.entries(object(raw.playback ?? {}))) {
         if (!Object.hasOwn(playback, key))
@@ -89,5 +95,5 @@ export function parseOptions(input) {
         }
         playback[key] = value;
     }
-    return { enabled, volume, player: player, playback, cues, tools };
+    return { enabled, volume, player: player, playback, cues, tools, returns };
 }

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { Plugin } from "@opencode/plugin";
 import { type Action, type Options } from "./config.js";
 import { type Player } from "./player.js";
-export { defaultCues, defaultToolCues, defaultPlayback, sounds } from "./config.js";
+export { defaultCues, defaultToolCues, defaultToolReturnCues, defaultPlayback, sounds } from "./config.js";
 export type { Action, Options, PlaybackOptions, SoundName } from "./config.js";
 type Event = ReturnType<Plugin.Context["event"]["subscribe"]> extends AsyncIterable<infer E> ? E : never;
 export declare function actionForEvent(event: Event): Action | undefined;

package/dist/index.js

@@ -1,10 +1,10 @@
 import { Plugin } from "@opencode/plugin";
 import { resolve } from "node:path";
 import { setTimeout as delay } from "node:timers/promises";
-import { defaultToolCues, parseOptions } from "./config.js";
+import { defaultToolCues, defaultToolReturnCues, parseOptions } from "./config.js";
 import { createPlayer } from "./player.js";
 import { schedulePlayer } from "./scheduler.js";
-export { defaultCues, defaultToolCues, defaultPlayback, sounds } from "./config.js";
+export { defaultCues, defaultToolCues, defaultToolReturnCues, defaultPlayback, sounds } from "./config.js";
 const eventActions = {
     "session.inbox.enqueued": "prompt",
     "session.execution.started": "start",
@@ -26,6 +26,9 @@ const eventActions = {
 export function actionForEvent(event) {
     return eventActions[event.type];
 }
+function shortToolName(tool) {
+    return tool.split(".").at(-1).replace(/^(functions|tools)_/, "");
+}
 const importantActions = new Set([
     "complete", "error", "toolError", "permission", "question", "interrupt",
 ]);
@@ -37,21 +40,31 @@ export async function setup(ctx, makePlayer = createPlayer) {
     const player = schedulePlayer(makePlayer(options.player, options.volume), options.playback);
     const controller = new AbortController();
     const registrations = [];
+    const calls = new Map();
     const emit = (action, tool) => {
         if (controller.signal.aborted)
             return;
         let sound = options.cues[action];
         if (tool !== undefined) {
-            const name = tool.split(".").at(-1);
-            const short = name.replace(/^(functions|tools)_/, "");
-            if (Object.hasOwn(options.tools, tool))
-                sound = options.tools[tool];
-            else if (Object.hasOwn(options.tools, short))
-                sound = options.tools[short];
-            // An explicit tool cue replaces the built-in palette for all tools.
-            else if (action === "tool" && !Object.hasOwn(ctx.options.cues ?? {}, "tool")) {
-                if (Object.hasOwn(defaultToolCues, short))
-                    sound = defaultToolCues[short];
+            const short = shortToolName(tool);
+            if (action === "tool") {
+                if (Object.hasOwn(options.tools, tool))
+                    sound = options.tools[tool];
+                else if (Object.hasOwn(options.tools, short))
+                    sound = options.tools[short];
+                // An explicit general cue replaces the built-in palette for all tools.
+                else if (!Object.hasOwn(ctx.options.cues ?? {}, "tool")) {
+                    if (Object.hasOwn(defaultToolCues, short))
+                        sound = defaultToolCues[short];
+                }
+            }
+            else if (action === "toolComplete") {
+                if (Object.hasOwn(options.returns, tool))
+                    sound = options.returns[tool];
+                else if (Object.hasOwn(options.returns, short))
+                    sound = options.returns[short];
+                else if (Object.hasOwn(defaultToolReturnCues, short))
+                    sound = defaultToolReturnCues[short];
             }
         }
         if (sound)
@@ -64,11 +77,14 @@ export async function setup(ctx, makePlayer = createPlayer) {
     };
     try {
         registrations.push(await ctx.tool.hook("execute.before", (event) => {
-            const name = event.tool.split(/[._]/).at(-1);
+            const name = shortToolName(event.tool);
+            calls.set(event.id, event.tool);
             emit(name === "question" ? "question" : "tool", event.tool);
         }));
         registrations.push(await ctx.tool.hook("execute.after", (event) => {
-            emit(event.status === "error" ? "toolError" : "toolComplete");
+            const tool = calls.get(event.id) ?? event.tool;
+            calls.delete(event.id);
+            emit(event.status === "error" ? "toolError" : "toolComplete", typeof tool === "string" ? tool : undefined);
         }));
     }
     catch (error) {

package/examples/opencode.json

@@ -37,7 +37,7 @@
           "glob": "release",
           "grep": "release",
           "websearch": "arrival",
-          "webfetch": "arrival",
+          "webfetch": "loading",
           "write": "toggle",
           "edit": "toggle",
           "patch": "arrival",
@@ -48,6 +48,9 @@
           "subagent": "arrival",
           "task": "arrival",
           "skill": "sparkle"
+        },
+        "returns": {
+          "webfetch": "ready"
         }
       }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oc-sounds",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Cuelume sound feedback for OpenCode V2 agent actions",
   "type": "module",
   "license": "MIT",