Keyboard Shortcuts

interface ShortcutAction {
  id: string;           // Unique identifier (e.g., "tabs.new")
  name: string;         // Display name (e.g., "New Tab")
  shortcut: string;     // Key combination (e.g., "CommandOrControl+T")
  category: string;     // Group name (e.g., "Tabs")
}

interface ModifiedShortcutData {
  newShortcut: string;  // The customized key combination
}

export const ShortcutsDataStore = getDatastore('shortcuts');

import { updateModifiedShortcut } from '@/saving/shortcuts';

const success = await updateModifiedShortcut('tabs.new', {
  newShortcut: 'CommandOrControl+Shift+T'
});

import { resetModifiedShortcut } from '@/saving/shortcuts';

const success = await resetModifiedShortcut('tabs.new');

import { resetAllModifiedShortcuts } from '@/saving/shortcuts';

const success = await resetAllModifiedShortcuts();

import { getShortcuts } from '@/modules/shortcuts';

const shortcuts = getShortcuts();
// Returns array with both original and modified shortcuts

interface ShortcutWithOriginal extends ShortcutAction {
  originalShortcut: string;  // Default shortcut
  shortcut: string;          // Current (possibly modified) shortcut
}

import { getShortcut, getCurrentShortcut } from '@/modules/shortcuts';

// Get full shortcut object
const shortcut = getShortcut('tabs.new');

// Get just the key combination
const keys = getCurrentShortcut('tabs.new');
// Returns: "CommandOrControl+T"

'CommandOrControl+T'           // Ctrl+T on Windows, Cmd+T on macOS
'Shift+CommandOrControl+R'     // Ctrl+Shift+R / Cmd+Shift+R
'F12'                          // Function key F12
'CommandOrControl+Left'        // Ctrl+Left Arrow / Cmd+Left Arrow

type ShortcutsEvents = {
  'shortcuts-changed': [];
}

export const shortcutsEmitter = new TypedEventEmitter<ShortcutsEvents>();

import { shortcutsEmitter } from '@/saving/shortcuts';

shortcutsEmitter.on('shortcuts-changed', () => {
  // Shortcuts have been modified, reload them
  const updated = getShortcuts();
});

type ShortcutId = 
  | 'tabs.new'
  | 'tab.copyUrl'
  | 'tab.reload'
  | 'tab.forceReload'
  | 'tab.close'
  | 'tab.toggleDevTools'
  | 'navigation.goBack'
  | 'navigation.goForward'
  | 'navigation.toggleCommandPalette'
  | 'browser.openSettings'
  | 'browser.newWindow'
  | 'browser.closeWindow'
  | 'browser.toggleSidebar'
  | 'tab.findInPage';

import { getShortcutByTypedId } from '@/modules/shortcuts';

const shortcut = getShortcutByTypedId('tabs.new');
// TypeScript ensures the ID is valid

async function loadShortcuts() {
  const rawModifiedShortcuts = await ShortcutsDataStore.getFullData();
  
  for (const key of Object.keys(rawModifiedShortcuts)) {
    const rawModifiedShortcutData = rawModifiedShortcuts[key];
    const parseResult = ModifiedShortcutData(rawModifiedShortcutData);
    if (!(parseResult instanceof type.errors)) {
      modifiedShortcuts.set(key, parseResult);
    }
  }
  
  shortcutsEmitter.emit('shortcuts-changed');
}

loadShortcuts();

const ModifiedShortcutData = type({
  newShortcut: 'string'
});

const parseResult = ModifiedShortcutData(rawModifiedShortcutData);
if (parseResult instanceof type.errors) {
  // Invalid data, reject the change
  return false;
}

const modifiedShortcuts: Map<string, ModifiedShortcutData> = new Map();

const updatedShortcuts = shortcuts.map((shortcut) => {
  const modifiedShortcutData = modifiedShortcutsData.find(
    ({ id }) => id === shortcut.id
  );
  return {
    ...shortcut,
    originalShortcut: shortcut.shortcut,
    shortcut: modifiedShortcutData?.newShortcut || shortcut.shortcut
  };
});