keycode-ts2 0.1.0

package/README.md

@@ -0,0 +1,36 @@
+# keycode-ts
+
+TypeScript package for Chromium-style keycode mappings generated from [`keycode_converter_data.inc`](./keycode_converter_data.inc).
+
+## Workflow
+
+Generate the raw TypeScript objects:
+
+```bash
+bun run generate
+```
+
+Build the npm package into `dist/`:
+
+```bash
+bun run build
+```
+
+Run the smoke-test script:
+
+```bash
+bun run demo
+```
+
+Import the package from `dist/` after building. The generated runtime data lives in `src/generated.ts`; generator code lives under `scripts/` and is not published.
+
+## Source Data
+
+- Repo: <https://chromium.googlesource.com/chromium/src.git>
+- File: <https://chromium.googlesource.com/chromium/src.git/+/master/ui/events/keycodes/dom/keycode_converter_data.inc>
+
+Update the source file with:
+
+```bash
+curl -sL 'https://chromium.googlesource.com/chromium/src/+/master/ui/events/keycodes/dom/keycode_converter_data.inc?format=TEXT' | base64 --decode > keycode_converter_data.inc
+```

package/dist/generated.d.ts

@@ -0,0 +1,495 @@
+export declare const KeyModifiers: {
+    readonly ControlLeft: 1;
+    readonly ShiftLeft: 2;
+    readonly AltLeft: 4;
+    readonly MetaLeft: 8;
+    readonly ControlRight: 16;
+    readonly ShiftRight: 32;
+    readonly AltRight: 64;
+    readonly MetaRight: 128;
+};
+export type KeyModifierFlag = (typeof KeyModifiers)[keyof typeof KeyModifiers];
+export declare const KeyMappingCode: {
+    readonly Hyper: "Hyper";
+    readonly Super: "Super";
+    readonly Fn: "Fn";
+    readonly FnLock: "FnLock";
+    readonly Suspend: "Suspend";
+    readonly Resume: "Resume";
+    readonly Turbo: "Turbo";
+    readonly Sleep: "Sleep";
+    readonly WakeUp: "WakeUp";
+    readonly DisplayToggleIntExt: "DisplayToggleIntExt";
+    readonly KeyA: "KeyA";
+    readonly KeyB: "KeyB";
+    readonly KeyC: "KeyC";
+    readonly KeyD: "KeyD";
+    readonly KeyE: "KeyE";
+    readonly KeyF: "KeyF";
+    readonly KeyG: "KeyG";
+    readonly KeyH: "KeyH";
+    readonly KeyI: "KeyI";
+    readonly KeyJ: "KeyJ";
+    readonly KeyK: "KeyK";
+    readonly KeyL: "KeyL";
+    readonly KeyM: "KeyM";
+    readonly KeyN: "KeyN";
+    readonly KeyO: "KeyO";
+    readonly KeyP: "KeyP";
+    readonly KeyQ: "KeyQ";
+    readonly KeyR: "KeyR";
+    readonly KeyS: "KeyS";
+    readonly KeyT: "KeyT";
+    readonly KeyU: "KeyU";
+    readonly KeyV: "KeyV";
+    readonly KeyW: "KeyW";
+    readonly KeyX: "KeyX";
+    readonly KeyY: "KeyY";
+    readonly KeyZ: "KeyZ";
+    readonly Digit1: "Digit1";
+    readonly Digit2: "Digit2";
+    readonly Digit3: "Digit3";
+    readonly Digit4: "Digit4";
+    readonly Digit5: "Digit5";
+    readonly Digit6: "Digit6";
+    readonly Digit7: "Digit7";
+    readonly Digit8: "Digit8";
+    readonly Digit9: "Digit9";
+    readonly Digit0: "Digit0";
+    readonly Enter: "Enter";
+    readonly Escape: "Escape";
+    readonly Backspace: "Backspace";
+    readonly Tab: "Tab";
+    readonly Space: "Space";
+    readonly Minus: "Minus";
+    readonly Equal: "Equal";
+    readonly BracketLeft: "BracketLeft";
+    readonly BracketRight: "BracketRight";
+    readonly Backslash: "Backslash";
+    readonly IntlHash: "IntlHash";
+    readonly Semicolon: "Semicolon";
+    readonly Quote: "Quote";
+    readonly Backquote: "Backquote";
+    readonly Comma: "Comma";
+    readonly Period: "Period";
+    readonly Slash: "Slash";
+    readonly CapsLock: "CapsLock";
+    readonly F1: "F1";
+    readonly F2: "F2";
+    readonly F3: "F3";
+    readonly F4: "F4";
+    readonly F5: "F5";
+    readonly F6: "F6";
+    readonly F7: "F7";
+    readonly F8: "F8";
+    readonly F9: "F9";
+    readonly F10: "F10";
+    readonly F11: "F11";
+    readonly F12: "F12";
+    readonly PrintScreen: "PrintScreen";
+    readonly ScrollLock: "ScrollLock";
+    readonly Pause: "Pause";
+    readonly Insert: "Insert";
+    readonly Home: "Home";
+    readonly PageUp: "PageUp";
+    readonly Delete: "Delete";
+    readonly End: "End";
+    readonly PageDown: "PageDown";
+    readonly ArrowRight: "ArrowRight";
+    readonly ArrowLeft: "ArrowLeft";
+    readonly ArrowDown: "ArrowDown";
+    readonly ArrowUp: "ArrowUp";
+    readonly NumLock: "NumLock";
+    readonly NumpadDivide: "NumpadDivide";
+    readonly NumpadMultiply: "NumpadMultiply";
+    readonly NumpadSubtract: "NumpadSubtract";
+    readonly NumpadAdd: "NumpadAdd";
+    readonly NumpadEnter: "NumpadEnter";
+    readonly Numpad1: "Numpad1";
+    readonly Numpad2: "Numpad2";
+    readonly Numpad3: "Numpad3";
+    readonly Numpad4: "Numpad4";
+    readonly Numpad5: "Numpad5";
+    readonly Numpad6: "Numpad6";
+    readonly Numpad7: "Numpad7";
+    readonly Numpad8: "Numpad8";
+    readonly Numpad9: "Numpad9";
+    readonly Numpad0: "Numpad0";
+    readonly NumpadDecimal: "NumpadDecimal";
+    readonly IntlBackslash: "IntlBackslash";
+    readonly ContextMenu: "ContextMenu";
+    readonly Power: "Power";
+    readonly NumpadEqual: "NumpadEqual";
+    readonly F13: "F13";
+    readonly F14: "F14";
+    readonly F15: "F15";
+    readonly F16: "F16";
+    readonly F17: "F17";
+    readonly F18: "F18";
+    readonly F19: "F19";
+    readonly F20: "F20";
+    readonly F21: "F21";
+    readonly F22: "F22";
+    readonly F23: "F23";
+    readonly F24: "F24";
+    readonly Open: "Open";
+    readonly Help: "Help";
+    readonly Select: "Select";
+    readonly Again: "Again";
+    readonly Undo: "Undo";
+    readonly Cut: "Cut";
+    readonly Copy: "Copy";
+    readonly Paste: "Paste";
+    readonly Find: "Find";
+    readonly AudioVolumeMute: "AudioVolumeMute";
+    readonly AudioVolumeUp: "AudioVolumeUp";
+    readonly AudioVolumeDown: "AudioVolumeDown";
+    readonly NumpadComma: "NumpadComma";
+    readonly IntlRo: "IntlRo";
+    readonly KanaMode: "KanaMode";
+    readonly IntlYen: "IntlYen";
+    readonly Convert: "Convert";
+    readonly NonConvert: "NonConvert";
+    readonly Lang1: "Lang1";
+    readonly Lang2: "Lang2";
+    readonly Lang3: "Lang3";
+    readonly Lang4: "Lang4";
+    readonly Lang5: "Lang5";
+    readonly Abort: "Abort";
+    readonly Props: "Props";
+    readonly NumpadParenLeft: "NumpadParenLeft";
+    readonly NumpadParenRight: "NumpadParenRight";
+    readonly NumpadBackspace: "NumpadBackspace";
+    readonly NumpadMemoryStore: "NumpadMemoryStore";
+    readonly NumpadMemoryRecall: "NumpadMemoryRecall";
+    readonly NumpadMemoryClear: "NumpadMemoryClear";
+    readonly NumpadMemoryAdd: "NumpadMemoryAdd";
+    readonly NumpadMemorySubtract: "NumpadMemorySubtract";
+    readonly NumpadClear: "NumpadClear";
+    readonly NumpadClearEntry: "NumpadClearEntry";
+    readonly ControlLeft: "ControlLeft";
+    readonly ShiftLeft: "ShiftLeft";
+    readonly AltLeft: "AltLeft";
+    readonly MetaLeft: "MetaLeft";
+    readonly ControlRight: "ControlRight";
+    readonly ShiftRight: "ShiftRight";
+    readonly AltRight: "AltRight";
+    readonly MetaRight: "MetaRight";
+    readonly BrightnessUp: "BrightnessUp";
+    readonly BrightnessDown: "BrightnessDown";
+    readonly MediaPlay: "MediaPlay";
+    readonly MediaRecord: "MediaRecord";
+    readonly MediaFastForward: "MediaFastForward";
+    readonly MediaRewind: "MediaRewind";
+    readonly MediaTrackNext: "MediaTrackNext";
+    readonly MediaTrackPrevious: "MediaTrackPrevious";
+    readonly MediaStop: "MediaStop";
+    readonly Eject: "Eject";
+    readonly MediaPlayPause: "MediaPlayPause";
+    readonly MediaSelect: "MediaSelect";
+    readonly LaunchMail: "LaunchMail";
+    readonly LaunchApp2: "LaunchApp2";
+    readonly LaunchApp1: "LaunchApp1";
+    readonly LaunchControlPanel: "LaunchControlPanel";
+    readonly SelectTask: "SelectTask";
+    readonly LaunchScreenSaver: "LaunchScreenSaver";
+    readonly LaunchAssistant: "LaunchAssistant";
+    readonly BrowserSearch: "BrowserSearch";
+    readonly BrowserHome: "BrowserHome";
+    readonly BrowserBack: "BrowserBack";
+    readonly BrowserForward: "BrowserForward";
+    readonly BrowserStop: "BrowserStop";
+    readonly BrowserRefresh: "BrowserRefresh";
+    readonly BrowserFavorites: "BrowserFavorites";
+    readonly ZoomToggle: "ZoomToggle";
+    readonly MailReply: "MailReply";
+    readonly MailForward: "MailForward";
+    readonly MailSend: "MailSend";
+    readonly KeyboardLayoutSelect: "KeyboardLayoutSelect";
+    readonly ShowAllWindows: "ShowAllWindows";
+};
+export type KeyMappingCode = (typeof KeyMappingCode)[keyof typeof KeyMappingCode];
+export declare const KeyMappingId: {
+    readonly None: "None";
+    readonly Hyper: "Hyper";
+    readonly Super: "Super";
+    readonly Fn: "Fn";
+    readonly FnLock: "FnLock";
+    readonly Suspend: "Suspend";
+    readonly Resume: "Resume";
+    readonly Turbo: "Turbo";
+    readonly Sleep: "Sleep";
+    readonly WakeUp: "WakeUp";
+    readonly DisplayToggleIntExt: "DisplayToggleIntExt";
+    readonly UsbReserved: "UsbReserved";
+    readonly UsbErrorRollOver: "UsbErrorRollOver";
+    readonly UsbPostFail: "UsbPostFail";
+    readonly UsbErrorUndefined: "UsbErrorUndefined";
+    readonly UsA: "UsA";
+    readonly UsB: "UsB";
+    readonly UsC: "UsC";
+    readonly UsD: "UsD";
+    readonly UsE: "UsE";
+    readonly UsF: "UsF";
+    readonly UsG: "UsG";
+    readonly UsH: "UsH";
+    readonly UsI: "UsI";
+    readonly UsJ: "UsJ";
+    readonly UsK: "UsK";
+    readonly UsL: "UsL";
+    readonly UsM: "UsM";
+    readonly UsN: "UsN";
+    readonly UsO: "UsO";
+    readonly UsP: "UsP";
+    readonly UsQ: "UsQ";
+    readonly UsR: "UsR";
+    readonly UsS: "UsS";
+    readonly UsT: "UsT";
+    readonly UsU: "UsU";
+    readonly UsV: "UsV";
+    readonly UsW: "UsW";
+    readonly UsX: "UsX";
+    readonly UsY: "UsY";
+    readonly UsZ: "UsZ";
+    readonly Digit1: "Digit1";
+    readonly Digit2: "Digit2";
+    readonly Digit3: "Digit3";
+    readonly Digit4: "Digit4";
+    readonly Digit5: "Digit5";
+    readonly Digit6: "Digit6";
+    readonly Digit7: "Digit7";
+    readonly Digit8: "Digit8";
+    readonly Digit9: "Digit9";
+    readonly Digit0: "Digit0";
+    readonly Enter: "Enter";
+    readonly Escape: "Escape";
+    readonly Backspace: "Backspace";
+    readonly Tab: "Tab";
+    readonly Space: "Space";
+    readonly Minus: "Minus";
+    readonly Equal: "Equal";
+    readonly BracketLeft: "BracketLeft";
+    readonly BracketRight: "BracketRight";
+    readonly Backslash: "Backslash";
+    readonly IntlHash: "IntlHash";
+    readonly Semicolon: "Semicolon";
+    readonly Quote: "Quote";
+    readonly Backquote: "Backquote";
+    readonly Comma: "Comma";
+    readonly Period: "Period";
+    readonly Slash: "Slash";
+    readonly CapsLock: "CapsLock";
+    readonly F1: "F1";
+    readonly F2: "F2";
+    readonly F3: "F3";
+    readonly F4: "F4";
+    readonly F5: "F5";
+    readonly F6: "F6";
+    readonly F7: "F7";
+    readonly F8: "F8";
+    readonly F9: "F9";
+    readonly F10: "F10";
+    readonly F11: "F11";
+    readonly F12: "F12";
+    readonly PrintScreen: "PrintScreen";
+    readonly ScrollLock: "ScrollLock";
+    readonly Pause: "Pause";
+    readonly Insert: "Insert";
+    readonly Home: "Home";
+    readonly PageUp: "PageUp";
+    readonly Del: "Del";
+    readonly End: "End";
+    readonly PageDown: "PageDown";
+    readonly ArrowRight: "ArrowRight";
+    readonly ArrowLeft: "ArrowLeft";
+    readonly ArrowDown: "ArrowDown";
+    readonly ArrowUp: "ArrowUp";
+    readonly NumLock: "NumLock";
+    readonly NumpadDivide: "NumpadDivide";
+    readonly NumpadMultiply: "NumpadMultiply";
+    readonly NumpadSubtract: "NumpadSubtract";
+    readonly NumpadAdd: "NumpadAdd";
+    readonly NumpadEnter: "NumpadEnter";
+    readonly Numpad1: "Numpad1";
+    readonly Numpad2: "Numpad2";
+    readonly Numpad3: "Numpad3";
+    readonly Numpad4: "Numpad4";
+    readonly Numpad5: "Numpad5";
+    readonly Numpad6: "Numpad6";
+    readonly Numpad7: "Numpad7";
+    readonly Numpad8: "Numpad8";
+    readonly Numpad9: "Numpad9";
+    readonly Numpad0: "Numpad0";
+    readonly NumpadDecimal: "NumpadDecimal";
+    readonly IntlBackslash: "IntlBackslash";
+    readonly ContextMenu: "ContextMenu";
+    readonly Power: "Power";
+    readonly NumpadEqual: "NumpadEqual";
+    readonly F13: "F13";
+    readonly F14: "F14";
+    readonly F15: "F15";
+    readonly F16: "F16";
+    readonly F17: "F17";
+    readonly F18: "F18";
+    readonly F19: "F19";
+    readonly F20: "F20";
+    readonly F21: "F21";
+    readonly F22: "F22";
+    readonly F23: "F23";
+    readonly F24: "F24";
+    readonly Open: "Open";
+    readonly Help: "Help";
+    readonly Select: "Select";
+    readonly Again: "Again";
+    readonly Undo: "Undo";
+    readonly Cut: "Cut";
+    readonly Copy: "Copy";
+    readonly Paste: "Paste";
+    readonly Find: "Find";
+    readonly VolumeMute: "VolumeMute";
+    readonly VolumeUp: "VolumeUp";
+    readonly VolumeDown: "VolumeDown";
+    readonly NumpadComma: "NumpadComma";
+    readonly IntlRo: "IntlRo";
+    readonly KanaMode: "KanaMode";
+    readonly IntlYen: "IntlYen";
+    readonly Convert: "Convert";
+    readonly NonConvert: "NonConvert";
+    readonly Lang1: "Lang1";
+    readonly Lang2: "Lang2";
+    readonly Lang3: "Lang3";
+    readonly Lang4: "Lang4";
+    readonly Lang5: "Lang5";
+    readonly Abort: "Abort";
+    readonly Props: "Props";
+    readonly NumpadParenLeft: "NumpadParenLeft";
+    readonly NumpadParenRight: "NumpadParenRight";
+    readonly NumpadBackspace: "NumpadBackspace";
+    readonly NumpadMemoryStore: "NumpadMemoryStore";
+    readonly NumpadMemoryRecall: "NumpadMemoryRecall";
+    readonly NumpadMemoryClear: "NumpadMemoryClear";
+    readonly NumpadMemoryAdd: "NumpadMemoryAdd";
+    readonly NumpadMemorySubtract: "NumpadMemorySubtract";
+    readonly NumpadSignChange: "NumpadSignChange";
+    readonly NumpadClear: "NumpadClear";
+    readonly NumpadClearEntry: "NumpadClearEntry";
+    readonly ControlLeft: "ControlLeft";
+    readonly ShiftLeft: "ShiftLeft";
+    readonly AltLeft: "AltLeft";
+    readonly MetaLeft: "MetaLeft";
+    readonly ControlRight: "ControlRight";
+    readonly ShiftRight: "ShiftRight";
+    readonly AltRight: "AltRight";
+    readonly MetaRight: "MetaRight";
+    readonly Info: "Info";
+    readonly ClosedCaptionToggle: "ClosedCaptionToggle";
+    readonly BrightnessUp: "BrightnessUp";
+    readonly BrightnessDown: "BrightnessDown";
+    readonly BrightnessToggle: "BrightnessToggle";
+    readonly BrightnessMinimium: "BrightnessMinimium";
+    readonly BrightnessMaximum: "BrightnessMaximum";
+    readonly BrightnessAuto: "BrightnessAuto";
+    readonly MediaLast: "MediaLast";
+    readonly LaunchPhone: "LaunchPhone";
+    readonly ProgramGuide: "ProgramGuide";
+    readonly Exit: "Exit";
+    readonly ChannelUp: "ChannelUp";
+    readonly ChannelDown: "ChannelDown";
+    readonly MediaPlay: "MediaPlay";
+    readonly MediaRecord: "MediaRecord";
+    readonly MediaFastForward: "MediaFastForward";
+    readonly MediaRewind: "MediaRewind";
+    readonly MediaTrackNext: "MediaTrackNext";
+    readonly MediaTrackPrevious: "MediaTrackPrevious";
+    readonly MediaStop: "MediaStop";
+    readonly Eject: "Eject";
+    readonly MediaPlayPause: "MediaPlayPause";
+    readonly SpeechInputToggle: "SpeechInputToggle";
+    readonly BassBoost: "BassBoost";
+    readonly MediaSelect: "MediaSelect";
+    readonly LaunchWordProcessor: "LaunchWordProcessor";
+    readonly LaunchSpreadsheet: "LaunchSpreadsheet";
+    readonly LaunchMail: "LaunchMail";
+    readonly LaunchContacts: "LaunchContacts";
+    readonly LaunchCalendar: "LaunchCalendar";
+    readonly LaunchApp2: "LaunchApp2";
+    readonly LaunchApp1: "LaunchApp1";
+    readonly LaunchInternetBrowser: "LaunchInternetBrowser";
+    readonly LogOff: "LogOff";
+    readonly LockScreen: "LockScreen";
+    readonly LaunchControlPanel: "LaunchControlPanel";
+    readonly SelectTask: "SelectTask";
+    readonly LaunchDocuments: "LaunchDocuments";
+    readonly SpellCheck: "SpellCheck";
+    readonly LaunchKeyboardLayout: "LaunchKeyboardLayout";
+    readonly LaunchScreenSaver: "LaunchScreenSaver";
+    readonly LaunchAssistant: "LaunchAssistant";
+    readonly LaunchAudioBrowser: "LaunchAudioBrowser";
+    readonly New: "New";
+    readonly Close: "Close";
+    readonly Save: "Save";
+    readonly Print: "Print";
+    readonly BrowserSearch: "BrowserSearch";
+    readonly BrowserHome: "BrowserHome";
+    readonly BrowserBack: "BrowserBack";
+    readonly BrowserForward: "BrowserForward";
+    readonly BrowserStop: "BrowserStop";
+    readonly BrowserRefresh: "BrowserRefresh";
+    readonly BrowserFavorites: "BrowserFavorites";
+    readonly ZoomIn: "ZoomIn";
+    readonly ZoomOut: "ZoomOut";
+    readonly ZoomToggle: "ZoomToggle";
+    readonly Redo: "Redo";
+    readonly MailReply: "MailReply";
+    readonly MailForward: "MailForward";
+    readonly MailSend: "MailSend";
+    readonly KeyboardLayoutSelect: "KeyboardLayoutSelect";
+    readonly ShowAllWindows: "ShowAllWindows";
+};
+export type KeyMappingId = (typeof KeyMappingId)[keyof typeof KeyMappingId];
+export interface KeyMap {
+    usbPage: number;
+    usb: number;
+    evdev: number;
+    xkb: number;
+    win: number;
+    mac: number;
+    code: KeyMappingCode | null;
+    id: KeyMappingId;
+    modifier: KeyModifierFlag | null;
+}
+export type KeyMapping = {
+    kind: "usb";
+    page: number;
+    code: number;
+} | {
+    kind: "evdev";
+    code: number;
+} | {
+    kind: "xkb";
+    code: number;
+} | {
+    kind: "win";
+    code: number;
+} | {
+    kind: "mac";
+    code: number;
+} | {
+    kind: "code";
+    code: KeyMappingCode;
+} | {
+    kind: "id";
+    id: KeyMappingId;
+};
+export declare const keyMaps: Readonly<Record<KeyMappingId, KeyMap>>;
+export declare const keyMapsByUsb: Readonly<Record<string, KeyMap>>;
+export declare const keyMapsByEvdev: Readonly<Record<string, KeyMap>>;
+export declare const keyMapsByXkb: Readonly<Record<string, KeyMap>>;
+export declare const keyMapsByWin: Readonly<Record<string, KeyMap>>;
+export declare const keyMapsByMac: Readonly<Record<string, KeyMap>>;
+export declare const keyMapsByCode: Readonly<Record<KeyMappingCode, KeyMap>>;
+export declare const allKeyMaps: readonly KeyMap[];
+export declare function getUsbCode(page: number, code: number): KeyMap | undefined;
+export declare function getKeyMapById(id: KeyMappingId): KeyMap;
+export declare function getKeyMapByCode(code: KeyMappingCode): KeyMap | undefined;
+export declare function getKeyMap(mapping: KeyMapping): KeyMap | undefined;