chime

1import type { EngineInterface, PluginOptions, Register } from "claude-code";
2
3import type { ChimeSettings } from "../types";
4
5const DEFAULT_THRESHOLD_SEC = 45;
6const DONE = "assets/done.wav";
7const WAITING = "assets/waiting.wav";
8
9// Waits the engine announces through the Notification hook that mean "Claude needs you".
10const WAIT_TYPES = /permission|idle|elicitation|input/i;
11
12// The configured defaults; `/chime` choices in the store override them per user.
13type Defaults = Omit<ChimeSettings, "isOn">;
14
15export const defaultsFrom = (options: PluginOptions | undefined): Defaults => {
16  const o = options ?? {};
17  const threshold = o.thresholdSeconds;
18  return {
19    thresholdSec:
20      typeof threshold === "number" && threshold > 0
21        ? threshold
22        : DEFAULT_THRESHOLD_SEC,
23    notify: o.notify !== false,
24    waitingSound: o.waitingSound !== false,
25  };
26};
27
28async function settings(
29  $: EngineInterface,
30  defaults: Defaults,
31): Promise<ChimeSettings> {
32  const isOn = (await $.store.get("isOn")) !== false;
33  const raw = await $.store.get("thresholdSec");
34  return {
35    ...defaults,
36    isOn,
37    thresholdSec:
38      typeof raw === "number" && raw > 0 ? raw : defaults.thresholdSec,
39  };
40}
41
42async function ring(
43  $: EngineInterface,
44  asset: string,
45  gain: number,
46): Promise<void> {
47  try {
48    await $.audio.play({ asset }, { gain });
49  } catch {
50    // No player on this machine: the notification still goes out.
51  }
52}
53
54export const register: Register = (on, options) => {
55  const defaults = defaultsFrom(options);
56
57  on("session.start", async ($, e, next) => {
58    await $.command.register({
59      name: "chime",
60      description:
61        "Chime: /chime on | off | test | <seconds> (long-turn threshold)",
62    });
63    return next(e);
64  });
65
66  on("command.run", { command: "chime" }, async ($, e) => {
67    const arg = e.args.trim().toLowerCase();
68    if (arg === "on" || arg === "off") {
69      await $.store.set("isOn", arg === "on");
70      return { text: `Chime ${arg}.` };
71    }
72    if (arg === "test") {
73      await ring($, DONE, 1);
74      await $.clock.sleep(700);
75      await ring($, WAITING, 0.6);
76      return { text: "🔔 done chime, then the waiting chime." };
77    }
78    const seconds = Number(arg);
79    if (arg !== "" && Number.isFinite(seconds) && seconds > 0) {
80      await $.store.set("thresholdSec", Math.round(seconds));
81      return {
82        text: `Chime after turns of ${Math.round(seconds)}s or longer.`,
83      };
84    }
85    const s = await settings($, defaults);
86    return {
87      text: `Chime is ${s.isOn ? "on" : "off"}; rings after turns of ${s.thresholdSec}s+${s.notify ? " with a notification" : ""}${s.waitingSound ? " and when Claude waits on you" : ""}.`,
88    };
89  });
90
91  on("turn.complete", async ($, e, next) => {
92    if (e.agentId === undefined && !e.isAborted) {
93      const s = await settings($, defaults);
94      if (s.isOn && e.durationMs >= s.thresholdSec * 1000) {
95        await ring($, DONE, 1);
96        if (s.notify) {
97          const secs = Math.round(e.durationMs / 1000);
98          await $.ui.notify(`Done in ${secs}s`, { title: "Claude Code" });
99        }
100      }
101    }
102    return next(e);
103  });
104
105  on("classic.Notification", async ($, e, next) => {
106    if (WAIT_TYPES.test(e.notification_type)) {
107      const s = await settings($, defaults);
108      if (s.isOn && s.waitingSound) await ring($, WAITING, 0.6);
109    }
110    return next(e);
111  }).catch(($, e, next) => next(e));
112};
113

1export type ChimeSettings = {
2  isOn: boolean;
3  thresholdSec: number;
4  notify: boolean;
5  waitingSound: boolean;
6};
7