rethocker 0.0.2 → 0.1.1

package/src/keys.ts

@@ -0,0 +1,346 @@
+/**
+ * Key name constants — use these for autocomplete and safe string interpolation
+ * in rule `key` fields.
+ *
+ * Every value is the key's canonical name string, exactly as the parser accepts.
+ * This means you can safely interpolate them:
+ *
+ *   `${Key.brightnessDown} ${Key.playPause}`  →  "brightnessDown playPause"
+ *   `Cmd+${Key.v}`                             →  "Cmd+v"
+ *
+ * @example
+ * rethocker([
+ *   { key: Key.capsLock,                          remap: Key.escape },
+ *   { key: `${Key.brightnessDown}`,               execute: "..." },
+ *   { key: `${Key.mediaNext} ${Key.mediaPrevious}`, handler: () => {} },
+ * ])
+ */
+export const Key = {
+  // ── Letters ──────────────────────────────────────────────────────────────
+  a: "a",
+  s: "s",
+  d: "d",
+  f: "f",
+  h: "h",
+  g: "g",
+  z: "z",
+  x: "x",
+  c: "c",
+  v: "v",
+  b: "b",
+  q: "q",
+  w: "w",
+  e: "e",
+  r: "r",
+  y: "y",
+  t: "t",
+  o: "o",
+  u: "u",
+  i: "i",
+  p: "p",
+  l: "l",
+  j: "j",
+  k: "k",
+  n: "n",
+  m: "m",
+
+  // ── Number row ───────────────────────────────────────────────────────────
+  n0: "n0",
+  n1: "n1",
+  n2: "n2",
+  n3: "n3",
+  n4: "n4",
+  n5: "n5",
+  n6: "n6",
+  n7: "n7",
+  n8: "n8",
+  n9: "n9",
+
+  // ── Punctuation ──────────────────────────────────────────────────────────
+  minus: "minus",
+  equal: "equal",
+  leftBracket: "leftBracket",
+  rightBracket: "rightBracket",
+  backslash: "backslash",
+  semicolon: "semicolon",
+  quote: "quote",
+  grave: "grave",
+  comma: "comma",
+  period: "period",
+  slash: "slash",
+
+  // ── Special / control ────────────────────────────────────────────────────
+  return: "return",
+  tab: "tab",
+  space: "space",
+  delete: "delete",
+  forwardDelete: "forwardDelete",
+  escape: "escape",
+  capsLock: "capsLock",
+  fn: "fn",
+  help: "help",
+  contextualMenu: "contextualMenu",
+
+  // ── Modifier keys ────────────────────────────────────────────────────────
+  leftCmd: "leftCmd",
+  rightCmd: "rightCmd",
+  leftShift: "leftShift",
+  rightShift: "rightShift",
+  leftAlt: "leftAlt",
+  rightAlt: "rightAlt",
+  leftCtrl: "leftCtrl",
+  rightCtrl: "rightCtrl",
+
+  // ── Arrow keys ───────────────────────────────────────────────────────────
+  left: "left",
+  right: "right",
+  down: "down",
+  up: "up",
+
+  // ── Navigation ───────────────────────────────────────────────────────────
+  home: "home",
+  end: "end",
+  pageUp: "pageUp",
+  pageDown: "pageDown",
+
+  // ── Function keys ────────────────────────────────────────────────────────
+  f1: "f1",
+  f2: "f2",
+  f3: "f3",
+  f4: "f4",
+  f5: "f5",
+  f6: "f6",
+  f7: "f7",
+  f8: "f8",
+  f9: "f9",
+  f10: "f10",
+  f11: "f11",
+  f12: "f12",
+  f13: "f13",
+  f14: "f14",
+  f15: "f15",
+  f16: "f16",
+  f17: "f17",
+  f18: "f18",
+  f19: "f19",
+  f20: "f20",
+
+  // ── Media / system keys ──────────────────────────────────────────────────
+  volumeUp: "volumeUp",
+  volumeDown: "volumeDown",
+  brightnessUp: "brightnessUp",
+  brightnessDown: "brightnessDown",
+  mute: "mute",
+  eject: "eject",
+  playPause: "playPause",
+  mediaNext: "mediaNext",
+  mediaPrevious: "mediaPrevious",
+  mediaFastForward: "mediaFastForward",
+  mediaRewind: "mediaRewind",
+  illuminationUp: "illuminationUp",
+  illuminationDown: "illuminationDown",
+  illuminationToggle: "illuminationToggle",
+
+  // ── Numpad ───────────────────────────────────────────────────────────────
+  numpad0: "numpad0",
+  numpad1: "numpad1",
+  numpad2: "numpad2",
+  numpad3: "numpad3",
+  numpad4: "numpad4",
+  numpad5: "numpad5",
+  numpad6: "numpad6",
+  numpad7: "numpad7",
+  numpad8: "numpad8",
+  numpad9: "numpad9",
+  numpadDecimal: "numpadDecimal",
+  numpadMultiply: "numpadMultiply",
+  numpadAdd: "numpadAdd",
+  numpadClear: "numpadClear",
+  numpadDivide: "numpadDivide",
+  numpadEnter: "numpadEnter",
+  numpadSubtract: "numpadSubtract",
+  numpadEquals: "numpadEquals",
+
+  // ── International / non-ANSI ─────────────────────────────────────────────
+  isoSection: "isoSection",
+  jisYen: "jisYen",
+  jisUnderscore: "jisUnderscore",
+  jisKeypadComma: "jisKeypadComma",
+  jisEisu: "jisEisu",
+  jisKana: "jisKana",
+} as const satisfies Record<string, string>;
+
+export type KeyName = keyof typeof Key;
+
+// ─── Private: name → keyCode (used only by parse-key.ts) ─────────────────────
+
+/** @internal */
+export const KEY_CODE_MAP: Record<string, number> = {
+  // Letters
+  a: 0,
+  s: 1,
+  d: 2,
+  f: 3,
+  h: 4,
+  g: 5,
+  z: 6,
+  x: 7,
+  c: 8,
+  v: 9,
+  b: 11,
+  q: 12,
+  w: 13,
+  e: 14,
+  r: 15,
+  y: 16,
+  t: 17,
+  o: 31,
+  u: 32,
+  i: 34,
+  p: 35,
+  l: 37,
+  j: 38,
+  k: 40,
+  n: 45,
+  m: 46,
+  // Number row
+  n0: 29,
+  n1: 18,
+  n2: 19,
+  n3: 20,
+  n4: 21,
+  n5: 23,
+  n6: 22,
+  n7: 26,
+  n8: 28,
+  n9: 25,
+  // Punctuation
+  minus: 27,
+  equal: 24,
+  leftbracket: 33,
+  rightbracket: 30,
+  backslash: 42,
+  semicolon: 41,
+  quote: 39,
+  grave: 50,
+  comma: 43,
+  period: 47,
+  slash: 44,
+  // Special
+  return: 36,
+  tab: 48,
+  space: 49,
+  delete: 51,
+  forwarddelete: 117,
+  escape: 53,
+  capslock: 57,
+  fn: 63,
+  help: 114,
+  contextualmenu: 110,
+  // Modifiers
+  leftcmd: 55,
+  rightcmd: 54,
+  leftshift: 56,
+  rightshift: 60,
+  leftalt: 58,
+  rightalt: 61,
+  leftctrl: 59,
+  rightctrl: 62,
+  // Arrows
+  left: 123,
+  right: 124,
+  down: 125,
+  up: 126,
+  // Navigation
+  home: 115,
+  end: 119,
+  pageup: 116,
+  pagedown: 121,
+  // Function keys
+  f1: 122,
+  f2: 120,
+  f3: 99,
+  f4: 118,
+  f5: 96,
+  f6: 97,
+  f7: 98,
+  f8: 100,
+  f9: 101,
+  f10: 109,
+  f11: 103,
+  f12: 111,
+  f13: 105,
+  f14: 107,
+  f15: 113,
+  f16: 106,
+  f17: 64,
+  f18: 79,
+  f19: 80,
+  f20: 90,
+  // Media / system keys (NX_KEYTYPE_* + 1000 offset)
+  volumeup: 1000,
+  volumedown: 1001,
+  brightnessup: 1002,
+  brightnessdown: 1003,
+  mute: 1007,
+  eject: 1014,
+  playpause: 1016,
+  medianext: 1017,
+  mediaprevious: 1018,
+  mediafastforward: 1019,
+  mediarewind: 1020,
+  illuminationup: 1021,
+  illuminationdown: 1022,
+  illuminationtoggle: 1023,
+  // Numpad
+  numpad0: 82,
+  numpad1: 83,
+  numpad2: 84,
+  numpad3: 85,
+  numpad4: 86,
+  numpad5: 87,
+  numpad6: 88,
+  numpad7: 89,
+  numpad8: 91,
+  numpad9: 92,
+  numpaddecimal: 65,
+  numpadmultiply: 67,
+  numpadadd: 69,
+  numpadclear: 71,
+  numpaddivide: 75,
+  numpadenter: 76,
+  numpadsubtract: 78,
+  numpadequals: 81,
+  // International
+  isosection: 10,
+  jisyen: 93,
+  jisunderscore: 94,
+  jiskeypadcomma: 95,
+  jiseisu: 102,
+  jiskana: 104,
+};
+
+/**
+ * Modifier key constants for use in rule triggers and remap targets.
+ * Values match the Modifier string union type exactly.
+ *
+ * @example
+ * { key: `Cmd+${Key.a}`, modifiers: [KeyModifier.Cmd] }
+ */
+export const KeyModifier = {
+  // ── Side-agnostic (matches either left or right) ──────────────────────────
+  Cmd: "cmd",
+  Shift: "shift",
+  Alt: "alt",
+  Ctrl: "ctrl",
+  Fn: "fn",
+  // ── Side-specific ─────────────────────────────────────────────────────────
+  LeftCmd: "leftCmd",
+  RightCmd: "rightCmd",
+  LeftShift: "leftShift",
+  RightShift: "rightShift",
+  LeftAlt: "leftAlt",
+  RightAlt: "rightAlt",
+  LeftCtrl: "leftCtrl",
+  RightCtrl: "rightCtrl",
+} as const satisfies Record<string, import("./types.ts").Modifier>;

package/src/parse-key.ts

@@ -0,0 +1,169 @@
+/**
+ * Parses the key string syntax used in the high-level rethocker() API.
+ *
+ * Single key / combo:   "escape"  |  "Cmd+A"  |  "Cmd+Shift+K"
+ * Sequence (space-sep): "Cmd+R T" |  "Ctrl+J Ctrl+K"
+ *
+ * Modifier names are case-insensitive. Key names match the Key constant
+ * object (also case-insensitive). Modifier aliases: "opt" = "alt",
+ * "option" = "alt", "command" = "cmd", "control" = "ctrl", "win" = "ctrl".
+ */
+
+import { KEY_CODE_MAP } from "./keys.ts";
+import type { KeyCombo, Modifier } from "./types.ts";
+
+// Helper: look up a guaranteed-present key from KEY_CODE_MAP
+function kc(name: string): number {
+  return KEY_CODE_MAP[name] as number;
+}
+
+// ─── Modifier aliases ─────────────────────────────────────────────────────────
+
+const MODIFIER_MAP: Record<string, Modifier> = {
+  cmd: "cmd",
+  command: "cmd",
+  shift: "shift",
+  alt: "alt",
+  opt: "alt",
+  option: "alt",
+  ctrl: "ctrl",
+  control: "ctrl",
+  win: "ctrl",
+  fn: "fn",
+  leftcmd: "leftCmd",
+  rightcmd: "rightCmd",
+  leftshift: "leftShift",
+  rightshift: "rightShift",
+  leftalt: "leftAlt",
+  leftopt: "leftAlt",
+  righttalt: "rightAlt",
+  rightopt: "rightAlt",
+  leftctrl: "leftCtrl",
+  rightctrl: "rightCtrl",
+};
+
+// ─── Key name → key code lookup (case-insensitive) ───────────────────────────
+//
+// Primary lookup: KEY_CODE_MAP (all canonical names, lowercased).
+// Aliases: common alternate names for the same key.
+
+const KEY_ALIASES: Record<string, number> = {
+  esc: kc("escape"),
+  enter: kc("return"),
+  backspace: kc("delete"),
+  back: kc("delete"),
+  del: kc("forwarddelete"),
+  caps: kc("capslock"),
+  arrowleft: kc("left"),
+  arrowright: kc("right"),
+  arrowup: kc("up"),
+  arrowdown: kc("down"),
+
+  // Short "num" prefix aliases for numpad keys
+  num0: kc("numpad0"),
+  num1: kc("numpad1"),
+  num2: kc("numpad2"),
+  num3: kc("numpad3"),
+  num4: kc("numpad4"),
+  num5: kc("numpad5"),
+  num6: kc("numpad6"),
+  num7: kc("numpad7"),
+  num8: kc("numpad8"),
+  num9: kc("numpad9"),
+  numenter: kc("numpadenter"),
+  numdecimal: kc("numpaddecimal"),
+  numpadperiod: kc("numpaddecimal"),
+  numadd: kc("numpadadd"),
+  numpadplus: kc("numpadadd"),
+  numplus: kc("numpadadd"),
+  numsubtract: kc("numpadsubtract"),
+  numpadminus: kc("numpadsubtract"),
+  numminus: kc("numpadsubtract"),
+  nummultiply: kc("numpadmultiply"),
+  numpadstar: kc("numpadmultiply"),
+  numdivide: kc("numpaddivide"),
+  numpadslash: kc("numpaddivide"),
+  numequals: kc("numpadequals"),
+  numclear: kc("numpadclear"),
+
+  // Numpad with "Numpad" prefix (VSCode style) — also auto-resolved via KEY_CODE_MAP
+  // since numpad* keys are already in there lowercased.
+
+  // Media / system key aliases
+  "volume up": kc("volumeup"),
+  "volume down": kc("volumedown"),
+  "brightness up": kc("brightnessup"),
+  "brightness down": kc("brightnessdown"),
+  playpause: kc("playpause"),
+  "play/pause": kc("playpause"),
+  play: kc("playpause"),
+  pause: kc("playpause"),
+  nextrack: kc("medianext"),
+  nexttrack: kc("medianext"),
+  "media next": kc("medianext"),
+  prevtrack: kc("mediaprevious"),
+  previoustrack: kc("mediaprevious"),
+  "media previous": kc("mediaprevious"),
+  "media prev": kc("mediaprevious"),
+  fastforward: kc("mediafastforward"),
+  "fast forward": kc("mediafastforward"),
+  rewind: kc("mediarewind"),
+  "keyboard brightness up": kc("illuminationup"),
+  "keyboard brightness down": kc("illuminationdown"),
+  "keyboard brightness toggle": kc("illuminationtoggle"),
+};
+
+function resolveKeyCode(name: string): number {
+  const lower = name.toLowerCase();
+  const code = KEY_CODE_MAP[lower] ?? KEY_ALIASES[lower];
+  if (code !== undefined) return code;
+
+  throw new Error(
+    `Unknown key name: "${name}". Use Key.* constants or check the Key reference.`,
+  );
+}
+
+// ─── Parse a single combo token, e.g. "Cmd+Shift+A" ─────────────────────────
+
+function parseCombo(token: string): KeyCombo {
+  const parts = token.split("+");
+  const keyPart = parts[parts.length - 1];
+  const modParts = parts.slice(0, parts.length - 1);
+
+  if (!keyPart) {
+    throw new Error(`Invalid key combo: "${token}"`);
+  }
+
+  const modifiers: Modifier[] = [];
+  for (const mod of modParts) {
+    const resolved = MODIFIER_MAP[mod.toLowerCase()];
+    if (!resolved) {
+      throw new Error(
+        `Unknown modifier: "${mod}" in "${token}". Valid modifiers: Cmd, Shift, Alt, Ctrl, Fn (and Left/Right variants).`,
+      );
+    }
+    modifiers.push(resolved);
+  }
+
+  return {
+    keyCode: resolveKeyCode(keyPart),
+    ...(modifiers.length > 0 ? { modifiers } : {}),
+  };
+}
+
+// ─── Public: parse a full key string ─────────────────────────────────────────
+
+export type ParsedKey =
+  | { kind: "single"; combo: KeyCombo }
+  | { kind: "sequence"; steps: KeyCombo[] };
+
+export function parseKey(keyString: string): ParsedKey {
+  const tokens = keyString.trim().split(/\s+/);
+  if (tokens.length === 0 || (tokens.length === 1 && tokens[0] === "")) {
+    throw new Error(`Empty key string`);
+  }
+  if (tokens.length === 1) {
+    return { kind: "single", combo: parseCombo(tokens[0] ?? "") };
+  }
+  return { kind: "sequence", steps: tokens.map((t) => parseCombo(t)) };
+}

package/src/register-rule.ts

@@ -0,0 +1,186 @@
+/**
+ * Translates high-level RethockerRule objects into low-level rule-engine calls.
+ *
+ * This is the "compiler" layer: it parses key strings, resolves rule variants,
+ * and dispatches to addRule / addSequence / intercept accordingly.
+ */
+
+import type { TypedEmitter } from "./daemon.ts";
+import { parseKey } from "./parse-key.ts";
+import { addRule, addSequence, genID, intercept } from "./rule-engine.ts";
+import type {
+  HandlerRule,
+  RemapRule,
+  RethockerRule,
+  ShellRule,
+} from "./rule-types.ts";
+import type {
+  AppCondition,
+  KeyEvent,
+  RuleConditions,
+  RuleHandle,
+  SequenceHandle,
+} from "./types.ts";
+
+// ─── Condition builder ────────────────────────────────────────────────────────
+// Merges the ergonomic `app` shorthand field into a RuleConditions object,
+// combined with any explicitly passed `conditions`.
+//
+// Prefix a value with "!" to negate (invert) the match:
+//   app: "!VSCode"  → fire when VSCode is NOT frontmost
+//   app: ["!Chrome", "!Safari"]  → fire in any app except Chrome and Safari
+
+function toAppCondition(value: string): AppCondition {
+  const invert = value.startsWith("!");
+  const name = invert ? value.slice(1) : value;
+  // Bundle IDs contain dots (e.g. "com.apple.Terminal"); display names don't
+  return name.includes(".") ? { bundleID: name, invert } : { name, invert };
+}
+
+function buildConditions(rule: {
+  app?: string | string[];
+  conditions?: RuleConditions;
+}): RuleConditions | undefined {
+  const base = rule.conditions ?? {};
+
+  // app → activeApp conditions (supports "!" prefix for negation)
+  const activeApp =
+    rule.app !== undefined
+      ? [...(base.activeApp ?? []), ...[rule.app].flat().map(toAppCondition)]
+      : base.activeApp;
+
+  const merged: RuleConditions = { ...base, activeApp };
+
+  const hasAny =
+    merged.activeApp !== undefined || merged.runningApps !== undefined;
+
+  return hasAny ? merged : undefined;
+}
+
+// ─── Rule registration ────────────────────────────────────────────────────────
+
+function registerRemap(
+  send: (obj: Record<string, unknown>) => void,
+  rule: RemapRule,
+): RuleHandle {
+  const parsed = parseKey(rule.key);
+  const target = parseKey(rule.remap);
+  const action =
+    target.kind === "sequence"
+      ? ({ type: "remap_sequence", steps: target.steps } as const)
+      : ({
+          type: "remap",
+          keyCode: target.combo.keyCode,
+          modifiers: target.combo.modifiers,
+        } as const);
+
+  if (parsed.kind === "single") {
+    return addRule(send, parsed.combo, action, {
+      id: rule.id,
+      conditions: buildConditions(rule),
+      disabled: rule.disabled,
+    });
+  }
+
+  // Sequence trigger: intercept the full sequence then post the remap target
+  return addSequence(send, parsed.steps, action, {
+    id: rule.id,
+    conditions: rule.conditions,
+    disabled: rule.disabled,
+    consume: true, // always consume — we're replacing the sequence
+  });
+}
+
+function resolveExecute(execute: string | string[]): string {
+  return Array.isArray(execute) ? execute.join(" && ") : execute;
+}
+
+function registerShell(
+  send: (obj: Record<string, unknown>) => void,
+  rule: ShellRule,
+): RuleHandle | SequenceHandle {
+  const parsed = parseKey(rule.key);
+  const conditions = buildConditions(rule);
+  const command = resolveExecute(rule.execute);
+  if (parsed.kind === "single") {
+    return addRule(
+      send,
+      parsed.combo,
+      { type: "run", command },
+      { id: rule.id, conditions, disabled: rule.disabled },
+    );
+  }
+  return addSequence(
+    send,
+    parsed.steps,
+    { type: "run", command },
+    {
+      id: rule.id,
+      conditions,
+      disabled: rule.disabled,
+      consume: rule.consume,
+      timeoutMs: rule.sequenceTimeoutMs,
+    },
+  );
+}
+
+function registerHandler(
+  send: (obj: Record<string, unknown>) => void,
+  emitter: TypedEmitter,
+  rule: HandlerRule,
+): RuleHandle | SequenceHandle {
+  const parsed = parseKey(rule.key);
+  const conditions = buildConditions(rule);
+
+  if (parsed.kind === "single") {
+    return intercept(send, emitter, parsed.combo, rule.handler, {
+      id: rule.id,
+      conditions,
+      disabled: rule.disabled,
+    });
+  }
+
+  // Sequence + handler: register as emit, wire up listener internally
+  const ruleID = rule.id ?? genID("seq");
+  const eventID = `${ruleID}_event`;
+  const lastStep = parsed.steps.at(-1);
+
+  const handle = addSequence(
+    send,
+    parsed.steps,
+    { type: "emit", eventID },
+    {
+      id: ruleID,
+      conditions,
+      disabled: rule.disabled,
+      consume: rule.consume,
+      timeoutMs: rule.sequenceTimeoutMs,
+    },
+  );
+
+  emitter.on("sequence", (seqRuleID, eid) => {
+    if (eid === eventID) {
+      const event: KeyEvent = {
+        type: "keydown",
+        keyCode: lastStep?.keyCode ?? 0,
+        modifiers: lastStep?.modifiers ?? [],
+        ruleID: seqRuleID,
+        eventID,
+        suppressed: true,
+      };
+      rule.handler(event);
+    }
+  });
+
+  return handle;
+}
+
+export function registerRule(
+  send: (obj: Record<string, unknown>) => void,
+  emitter: TypedEmitter,
+  rule: RethockerRule,
+): RuleHandle | SequenceHandle {
+  if (rule.remap !== undefined) return registerRemap(send, rule);
+  if (rule.execute !== undefined) return registerShell(send, rule);
+  return registerHandler(send, emitter, rule);
+}