mirror of
https://github.com/kilyabin/psysonic.git
synced 2026-07-22 06:25:41 +00:00
refactor(orbit + shortcuts): unify host/guest heartbeat, document shortcut contract (Phase I) (#693)
* refactor(orbit): unify host/guest outbox heartbeat into a shared hook (Phase I) The outbox-heartbeat effect was duplicated near-verbatim in useOrbitHost and useOrbitGuest — same 10 s interval, same writeOrbitHeartbeat call, same cleanup; the only difference is whose name owns the outbox (OrbitState.host vs the active-server username). Extract it into useOrbitOutboxHeartbeat(active, outboxPlaylistId, sessionId, ownName). Host and guest each pass their own name source. The push/pull state-tick logic stays untouched — that asymmetry is the real host/guest difference, not duplication. Behaviour-preserving: the owner name is now a reactive hook arg instead of a getState() read inside the effect, so the heartbeat starts as soon as the name is available rather than waiting for an unrelated dep to change — a strict improvement, unreachable in practice since host name and username are fixed per session. * docs(shortcuts): document the shortcut-actions contract (Phase I) Add a contract reference block to the shortcutActions barrel — the three independent trigger surfaces (inApp / global / runInMiniWindow), the surface-independent cli + run fields, the dispatch entry points — and per-field doc comments on ShortcutActionMeta / ShortcutSlot / ActionContext / CliContext in shortcutTypes.ts. Pure documentation, no code change.
This commit is contained in:
committed by
GitHub
parent
4b1dd3c29f
commit
946528350c
@@ -1,9 +1,46 @@
|
||||
// Barrel for the shortcut-action subsystem. Split into:
|
||||
// ─── Shortcut-action subsystem ───────────────────────────────────────────────
|
||||
//
|
||||
// Barrel + contract reference. Split into:
|
||||
// shortcutTypes.ts — shared types
|
||||
// shortcutActionRegistry.ts — SHORTCUT_ACTION_REGISTRY + action id types
|
||||
// shortcutDispatch.ts — runtime + CLI dispatch
|
||||
// shortcutBindings.ts — derived in-app / global binding tables
|
||||
// Existing call sites import from this module unchanged.
|
||||
//
|
||||
// ── The contract ─────────────────────────────────────────────────────────────
|
||||
//
|
||||
// Every shortcut action is one entry in `SHORTCUT_ACTION_REGISTRY`, keyed by a
|
||||
// stable id (`ShortcutAction`). Its `ShortcutActionMeta` declares which of three
|
||||
// independent *trigger surfaces* the action is exposed on — an action may opt
|
||||
// into any combination:
|
||||
//
|
||||
// • inApp? — bindable to a keyboard chord while the MAIN window is focused.
|
||||
// Presence of the `inApp` slot makes the id a `KeyAction`; the
|
||||
// slot's `defaultBinding` is the out-of-box chord (or null =
|
||||
// unbound), `hidden` keeps it out of the Settings UI list.
|
||||
// Surfaced via IN_APP_SHORTCUT_ACTIONS / DEFAULT_IN_APP_BINDINGS;
|
||||
// matched at runtime by `shortcuts/runtime.ts`.
|
||||
// • global? — registrable as an OS-LEVEL global hotkey (fires even when the
|
||||
// app is unfocused). Presence makes the id a `GlobalAction`;
|
||||
// surfaced via GLOBAL_SHORTCUT_ACTIONS / DEFAULT_GLOBAL_SHORTCUTS.
|
||||
// `isGlobalShortcutActionId` is the runtime guard.
|
||||
// • runInMiniWindow — whether the action may run when triggered FROM the
|
||||
// mini-player window. `canRunShortcutActionInMiniWindow` gates
|
||||
// cross-window `shortcut:run-action` events.
|
||||
//
|
||||
// Two extra, surface-independent fields:
|
||||
// • cli? — exposes the action to `psysonic --player <verb>`. No-arg CLI
|
||||
// verbs are auto-collected and dispatched by
|
||||
// `executeCliPlayerCommand`; arg-carrying commands (play-id,
|
||||
// seek-relative, set-volume, set-repeat, set-rating-current)
|
||||
// are handled explicitly there.
|
||||
// • run(ctx) — the handler. `ctx.previewPolicy` ('stop' | 'ignore') decides
|
||||
// whether an active track-preview is interrupted: media keys
|
||||
// pass 'ignore', explicit UI / in-app keys pass 'stop'.
|
||||
//
|
||||
// Dispatch entry points: `executeRuntimeAction` (any trigger surface) and
|
||||
// `executeCliPlayerCommand` (CLI). `isShortcutAction` validates an arbitrary
|
||||
// string against the registry.
|
||||
|
||||
export type {
|
||||
TranslateLike,
|
||||
|
||||
Reference in New Issue
Block a user