markupr 2.1.8

package/src/renderer/types/electron.d.ts

@@ -0,0 +1,385 @@
+/**
+ * markupr - Electron Type Declarations for Renderer
+ *
+ * This file provides TypeScript type support for the window.markupr API
+ * exposed by the preload script via contextBridge.
+ */
+
+import type {
+  AppSettings,
+  CaptureSource,
+  AudioDevice,
+  PermissionType,
+  PermissionStatus,
+  SessionStatusPayload,
+  SessionPayload,
+  FeedbackItemPayload,
+  TranscriptChunkPayload,
+  ScreenshotCapturedPayload,
+  OutputReadyPayload,
+  SaveResult,
+  HotkeyConfig,
+  SessionState,
+  TranscriptionTier,
+  TranscriptionTierStatus,
+  UpdateStatusPayload,
+  WhisperDownloadProgressPayload,
+  WhisperModelInfoPayload,
+  WhisperModelCheckResult,
+  ApiKeyValidationResult,
+  ProcessingProgressPayload,
+} from '../../shared/types';
+
+type Unsubscribe = () => void;
+
+/**
+ * Session API
+ */
+interface SessionAPI {
+  start: (
+    sourceId?: string,
+    sourceName?: string
+  ) => Promise<{ success: boolean; sessionId?: string; error?: string }>;
+  stop: () => Promise<{ success: boolean; session?: SessionPayload; error?: string }>;
+  pause: () => Promise<{ success: boolean; error?: string }>;
+  resume: () => Promise<{ success: boolean; error?: string }>;
+  cancel: () => Promise<{ success: boolean }>;
+  getStatus: () => Promise<SessionStatusPayload>;
+  getCurrent: () => Promise<SessionPayload | null>;
+  onStateChange: (callback: (data: { state: SessionState; session: SessionPayload | null }) => void) => Unsubscribe;
+  onStatusUpdate: (callback: (data: SessionStatusPayload) => void) => Unsubscribe;
+  onComplete: (callback: (data: SessionPayload) => void) => Unsubscribe;
+  onFeedbackItem: (callback: (data: FeedbackItemPayload) => void) => Unsubscribe;
+  onVoiceActivity: (callback: (data: { active: boolean }) => void) => Unsubscribe;
+  onError: (callback: (data: { message: string }) => void) => Unsubscribe;
+}
+
+/**
+ * Capture API
+ */
+interface CaptureAPI {
+  getSources: () => Promise<CaptureSource[]>;
+  manualScreenshot: () => Promise<{ success: boolean; error?: string }>;
+  onScreenshot: (callback: (data: ScreenshotCapturedPayload) => void) => Unsubscribe;
+  onManualTrigger: (callback: (data: { timestamp: number }) => void) => Unsubscribe;
+}
+
+/**
+ * Audio API
+ */
+interface AudioAPI {
+  getDevices: () => Promise<AudioDevice[]>;
+  setDevice: (deviceId: string) => Promise<{ success: boolean }>;
+  onLevel: (callback: (level: number) => void) => Unsubscribe;
+  onVoiceActivity: (callback: (active: boolean) => void) => Unsubscribe;
+
+  // Audio capture bridge
+  onRequestDevices: (callback: () => void) => Unsubscribe;
+  sendDevices: (devices: AudioDevice[]) => void;
+  onStartCapture: (callback: (config: {
+    deviceId: string | null;
+    sampleRate: number;
+    channels: number;
+    chunkDurationMs: number;
+  }) => void) => Unsubscribe;
+  onStopCapture: (callback: () => void) => Unsubscribe;
+  onSetDevice: (callback: (deviceId: string) => void) => Unsubscribe;
+  sendAudioChunk: (data: {
+    timestamp: number;
+    duration: number;
+    samples?: number[];
+    encodedChunk?: Uint8Array;
+    mimeType?: string;
+    audioLevel?: number;
+    rms?: number;
+  }) => void;
+  notifyCaptureStarted: () => void;
+  notifyCaptureStopped: () => void;
+  sendCaptureError: (error: string) => void;
+}
+
+/**
+ * Screen recording persistence API
+ */
+interface ScreenRecordingAPI {
+  start: (
+    sessionId: string,
+    mimeType: string,
+    startTime?: number
+  ) => Promise<{ success: boolean; path?: string; error?: string }>;
+  appendChunk: (sessionId: string, chunk: Uint8Array) => Promise<{ success: boolean; error?: string }>;
+  stop: (
+    sessionId: string
+  ) => Promise<{ success: boolean; path?: string; bytes?: number; mimeType?: string; error?: string }>;
+}
+
+/**
+ * Transcript API
+ */
+interface TranscriptAPI {
+  onChunk: (callback: (data: TranscriptChunkPayload) => void) => Unsubscribe;
+  onFinal: (callback: (data: { text: string; confidence: number; timestamp: number }) => void) => Unsubscribe;
+}
+
+/**
+ * Transcription tier and model control API
+ */
+interface TranscriptionControlAPI {
+  getTierStatuses: () => Promise<TranscriptionTierStatus[]>;
+  getCurrentTier: () => Promise<TranscriptionTier | null>;
+  setTier: (tier: TranscriptionTier) => Promise<{ success: boolean; error?: string }>;
+  downloadModel: (model: string) => Promise<{ success: boolean; error?: string }>;
+  cancelDownload: (model: string) => Promise<{ success: boolean }>;
+  onModelProgress: (callback: (data: WhisperDownloadProgressPayload) => void) => Unsubscribe;
+}
+
+/**
+ * Processing Pipeline API (post-recording progress events)
+ */
+interface ProcessingAPI {
+  onProgress: (callback: (data: ProcessingProgressPayload) => void) => Unsubscribe;
+  onComplete: (callback: (data: OutputReadyPayload) => void) => Unsubscribe;
+}
+
+/**
+ * Settings API
+ */
+interface SettingsAPI {
+  get: <K extends keyof AppSettings>(key: K) => Promise<AppSettings[K]>;
+  getAll: () => Promise<AppSettings>;
+  set: <K extends keyof AppSettings>(key: K, value: AppSettings[K]) => Promise<AppSettings>;
+  getApiKey: (service: string) => Promise<string | null>;
+  setApiKey: (service: string, key: string) => Promise<boolean>;
+  deleteApiKey: (service: string) => Promise<boolean>;
+  hasApiKey: (service: string) => Promise<boolean>;
+  testApiKey: (service: 'openai' | 'anthropic', key: string) => Promise<ApiKeyValidationResult>;
+  selectDirectory: () => Promise<string | null>;
+  clearAllData: () => Promise<void>;
+  export: () => Promise<void>;
+  import: () => Promise<AppSettings | null>;
+}
+
+/**
+ * Hotkey API
+ */
+interface HotkeyAPI {
+  getConfig: () => Promise<HotkeyConfig>;
+  updateConfig: (config: Partial<HotkeyConfig>) => Promise<{ config: HotkeyConfig; results: unknown[] }>;
+  onTriggered: (callback: (data: { action: string; accelerator: string }) => void) => Unsubscribe;
+}
+
+/**
+ * Permissions API
+ */
+interface PermissionsAPI {
+  check: (type: PermissionType) => Promise<boolean>;
+  request: (type: PermissionType) => Promise<boolean>;
+  getAll: () => Promise<PermissionStatus>;
+}
+
+/**
+ * Session history metadata for display
+ */
+interface SessionHistoryItem {
+  id: string;
+  startTime: number;
+  endTime: number;
+  itemCount: number;
+  screenshotCount: number;
+  sourceName: string;
+  firstThumbnail?: string;
+  folder: string;
+  transcriptionPreview?: string;
+}
+
+/**
+ * Output API
+ */
+interface OutputAPI {
+  save: (session?: SessionPayload) => Promise<SaveResult>;
+  copyClipboard: () => Promise<boolean>;
+  openFolder: (sessionDir?: string) => Promise<{ success: boolean; error?: string }>;
+  onReady: (callback: (data: OutputReadyPayload) => void) => Unsubscribe;
+  onError: (callback: (data: { message: string }) => void) => Unsubscribe;
+
+  // Session History Browser API
+  listSessions: () => Promise<SessionHistoryItem[]>;
+  getSessionMetadata: (sessionId: string) => Promise<SessionHistoryItem | null>;
+  deleteSession: (sessionId: string) => Promise<{ success: boolean; error?: string }>;
+  deleteSessions: (sessionIds: string[]) => Promise<{ success: boolean; deleted: string[]; failed: string[] }>;
+  exportSession: (sessionId: string, format?: 'markdown' | 'json' | 'pdf') => Promise<{ success: boolean; path?: string; error?: string }>;
+  exportSessions: (sessionIds: string[], format?: 'markdown' | 'json' | 'pdf') => Promise<{ success: boolean; path?: string; error?: string }>;
+}
+
+/**
+ * Complete markupr API
+ */
+/**
+ * Navigation API (Main -> Renderer navigation events)
+ */
+interface NavigationAPI {
+  onShowSettings: (callback: () => void) => Unsubscribe;
+  onShowHistory: (callback: () => void) => Unsubscribe;
+  onShowShortcuts: (callback: () => void) => Unsubscribe;
+  onShowOnboarding: (callback: () => void) => Unsubscribe;
+  onShowExport: (callback: () => void) => Unsubscribe;
+  onShowWindowSelector: (callback: () => void) => Unsubscribe;
+}
+
+/**
+ * Window control API
+ */
+interface WindowAPI {
+  minimize: () => Promise<{ success: boolean }>;
+  hide: () => Promise<{ success: boolean }>;
+  close: () => Promise<{ success: boolean }>;
+}
+
+/**
+ * Popover control API
+ */
+interface PopoverAPI {
+  resize: (width: number, height: number) => Promise<{ success: boolean }>;
+  resizeToState: (state: string) => Promise<{ success: boolean }>;
+}
+
+/**
+ * Crash Recovery API
+ */
+interface CrashRecoveryAPI {
+  check: () => Promise<{
+    hasIncomplete: boolean;
+    session: {
+      id: string;
+      startTime: number;
+      lastSaveTime: number;
+      feedbackItems: Array<{
+        id: string;
+        timestamp: number;
+        text: string;
+        confidence: number;
+        hasScreenshot: boolean;
+        screenshotId?: string;
+      }>;
+      sourceName: string;
+      screenshotCount: number;
+      metadata?: { appVersion: string; platform: string; sessionDurationMs: number };
+    } | null;
+  }>;
+  recover: (sessionId: string) => Promise<{
+    success: boolean;
+    session?: {
+      id: string;
+      feedbackItems: Array<{
+        id: string;
+        timestamp: number;
+        text: string;
+        confidence: number;
+        hasScreenshot: boolean;
+      }>;
+    };
+    error?: string;
+  }>;
+  discard: () => Promise<{ success: boolean }>;
+  getLogs: (limit?: number) => Promise<Array<{
+    timestamp: string;
+    error: { name: string; message: string; stack?: string };
+    appVersion: string;
+    platform: string;
+    sessionId?: string;
+  }>>;
+  clearLogs: () => Promise<{ success: boolean }>;
+  updateSettings: (settings: {
+    enableAutoSave?: boolean;
+    autoSaveIntervalMs?: number;
+    enableCrashReporting?: boolean;
+    maxCrashLogs?: number;
+  }) => Promise<{ success: boolean }>;
+  onIncompleteFound: (callback: (data: {
+    session: {
+      id: string;
+      startTime: number;
+      lastSaveTime: number;
+      feedbackItems: Array<{
+        id: string;
+        timestamp: number;
+        text: string;
+        confidence: number;
+        hasScreenshot: boolean;
+      }>;
+      sourceName: string;
+      screenshotCount: number;
+    };
+  }) => void) => Unsubscribe;
+}
+
+/**
+ * Updates API
+ */
+interface UpdatesAPI {
+  check: () => Promise<unknown>;
+  download: () => Promise<void>;
+  install: () => Promise<void>;
+  onStatus: (callback: (status: UpdateStatusPayload) => void) => Unsubscribe;
+}
+
+/**
+ * Whisper Model API
+ */
+interface WhisperAPI {
+  checkModel: () => Promise<WhisperModelCheckResult>;
+  hasTranscriptionCapability: () => Promise<boolean>;
+  getAvailableModels: () => Promise<WhisperModelInfoPayload[]>;
+  downloadModel: (model: string) => Promise<{ success: boolean; error?: string }>;
+  cancelDownload: (model: string) => Promise<{ success: boolean }>;
+  onDownloadProgress: (callback: (data: WhisperDownloadProgressPayload) => void) => Unsubscribe;
+  onDownloadComplete: (callback: (data: { model: string; path: string }) => void) => Unsubscribe;
+  onDownloadError: (callback: (data: { model: string; error: string }) => void) => Unsubscribe;
+}
+
+/**
+ * Complete markupr API
+ */
+export interface MarkuprAPI {
+  // Domain APIs
+  session: SessionAPI;
+  capture: CaptureAPI;
+  audio: AudioAPI;
+  screenRecording: ScreenRecordingAPI;
+  transcript: TranscriptAPI;
+  transcription: TranscriptionControlAPI;
+  processing: ProcessingAPI;
+  settings: SettingsAPI;
+  hotkeys: HotkeyAPI;
+  permissions: PermissionsAPI;
+  output: OutputAPI;
+  navigation: NavigationAPI;
+  window: WindowAPI;
+  popover: PopoverAPI;
+  crashRecovery: CrashRecoveryAPI;
+  updates: UpdatesAPI;
+  whisper: WhisperAPI;
+
+  // App version
+  version: () => Promise<string>;
+
+  // Legacy API (backwards compatibility)
+  startSession: () => Promise<{ success: boolean; sessionId?: string }>;
+  stopSession: () => Promise<{ success: boolean }>;
+  getSettings: () => Promise<AppSettings>;
+  setSettings: (settings: Partial<AppSettings>) => Promise<AppSettings>;
+  copyToClipboard: (text: string) => Promise<{ success: boolean }>;
+  onSessionStatus: (callback: (status: { action: string; status?: SessionStatusPayload }) => void) => Unsubscribe;
+  onTranscriptionUpdate: (callback: (data: { text: string; isFinal: boolean }) => void) => Unsubscribe;
+  onScreenshotCaptured: (callback: (data: { id: string; timestamp: number }) => void) => Unsubscribe;
+  onOutputReady: (callback: (data: OutputReadyPayload) => void) => Unsubscribe;
+  onOutputError: (callback: (error: { message: string }) => void) => Unsubscribe;
+}
+
+declare global {
+  interface Window {
+    markupr: MarkuprAPI;
+  }
+}
+
+export {};

package/src/shared/hotkeys.ts

@@ -0,0 +1,283 @@
+/**
+ * Platform-aware hotkey definitions for markupr
+ *
+ * Provides consistent hotkey handling across macOS, Windows, and Linux.
+ * Uses Electron's accelerator format internally but converts to
+ * platform-appropriate display formats.
+ */
+
+// ============================================================================
+// Types
+// ============================================================================
+
+export interface HotkeyDefinition {
+  id: string;
+  label: string;
+  description: string;
+  macAccelerator: string;
+  winLinuxAccelerator: string;
+}
+
+export interface DisplayKey {
+  key: string;
+  symbol: string;
+}
+
+// ============================================================================
+// Platform Detection
+// ============================================================================
+
+/**
+ * Detect if running on macOS
+ * Works in both main process (process.platform) and renderer (navigator.platform)
+ */
+export function isMacOS(): boolean {
+  const nodeProcess = (globalThis as { process?: { platform?: string } }).process;
+  if (nodeProcess?.platform) {
+    return nodeProcess.platform === 'darwin';
+  }
+  if (typeof navigator !== 'undefined' && navigator.platform) {
+    return navigator.platform.toUpperCase().includes('MAC');
+  }
+  return false;
+}
+
+/**
+ * Detect if running on Windows
+ */
+export function isWindows(): boolean {
+  const nodeProcess = (globalThis as { process?: { platform?: string } }).process;
+  if (nodeProcess?.platform) {
+    return nodeProcess.platform === 'win32';
+  }
+  if (typeof navigator !== 'undefined' && navigator.platform) {
+    return navigator.platform.toUpperCase().includes('WIN');
+  }
+  return false;
+}
+
+// ============================================================================
+// Hotkey Definitions
+// ============================================================================
+
+/**
+ * All hotkey definitions for markupr
+ * Uses Electron accelerator format (CommandOrControl, Shift, Alt, etc.)
+ */
+export const HOTKEYS: HotkeyDefinition[] = [
+  {
+    id: 'toggleRecording',
+    label: 'Toggle Recording',
+    description: 'Start or stop recording',
+    macAccelerator: 'Command+Shift+F',
+    winLinuxAccelerator: 'Ctrl+Shift+F',
+  },
+  {
+    id: 'manualScreenshot',
+    label: 'Manual Screenshot',
+    description: 'Capture screenshot immediately',
+    macAccelerator: 'Command+Shift+S',
+    winLinuxAccelerator: 'Ctrl+Shift+S',
+  },
+  {
+    id: 'pauseResume',
+    label: 'Pause/Resume',
+    description: 'Pause or resume recording',
+    macAccelerator: 'Command+Shift+P',
+    winLinuxAccelerator: 'Ctrl+Shift+P',
+  },
+  {
+    id: 'openSettings',
+    label: 'Open Settings',
+    description: 'Open settings panel',
+    macAccelerator: 'Command+,',
+    winLinuxAccelerator: 'Ctrl+,',
+  },
+  {
+    id: 'showHelp',
+    label: 'Show Help',
+    description: 'Show keyboard shortcuts',
+    macAccelerator: 'Command+?',
+    winLinuxAccelerator: 'Ctrl+Shift+/',
+  },
+  {
+    id: 'quit',
+    label: 'Quit',
+    description: 'Quit markupr',
+    macAccelerator: 'Command+Q',
+    winLinuxAccelerator: 'Alt+F4',
+  },
+];
+
+// ============================================================================
+// Key Display Mappings
+// ============================================================================
+
+/**
+ * macOS key display names (plain text for maximum rendering stability)
+ */
+const MAC_SYMBOLS: Record<string, string> = {
+  command: 'Cmd',
+  cmd: 'Cmd',
+  control: 'Ctrl',
+  ctrl: 'Ctrl',
+  option: 'Option',
+  alt: 'Option',
+  shift: 'Shift',
+  enter: 'Enter',
+  return: 'Return',
+  delete: 'Delete',
+  backspace: 'Delete',
+  escape: 'Esc',
+  esc: 'Esc',
+  tab: 'Tab',
+  space: 'Space',
+  up: 'Up',
+  down: 'Down',
+  left: 'Left',
+  right: 'Right',
+  pageup: 'Page Up',
+  pagedown: 'Page Down',
+  home: 'Home',
+  end: 'End',
+  fn: 'Fn',
+};
+
+/**
+ * Windows/Linux key display names
+ */
+const WIN_LINUX_NAMES: Record<string, string> = {
+  command: 'Ctrl',
+  cmd: 'Ctrl',
+  control: 'Ctrl',
+  ctrl: 'Ctrl',
+  option: 'Alt',
+  alt: 'Alt',
+  shift: 'Shift',
+  enter: 'Enter',
+  return: 'Enter',
+  delete: 'Del',
+  backspace: 'Backspace',
+  escape: 'Esc',
+  esc: 'Esc',
+  tab: 'Tab',
+  space: 'Space',
+  up: 'Up',
+  down: 'Down',
+  left: 'Left',
+  right: 'Right',
+  pageup: 'Page Up',
+  pagedown: 'Page Down',
+  home: 'Home',
+  end: 'End',
+  fn: 'Fn',
+};
+
+// ============================================================================
+// Utility Functions
+// ============================================================================
+
+/**
+ * Get a hotkey definition by ID
+ */
+export function getHotkeyById(id: string): HotkeyDefinition | undefined {
+  return HOTKEYS.find(h => h.id === id);
+}
+
+/**
+ * Get the Electron accelerator string for a hotkey
+ * Returns platform-appropriate accelerator
+ */
+export function getAccelerator(hotkeyId: string): string {
+  const hotkey = getHotkeyById(hotkeyId);
+  if (!hotkey) return '';
+
+  return isMacOS() ? hotkey.macAccelerator : hotkey.winLinuxAccelerator;
+}
+
+/**
+ * Get the Electron accelerator from a custom hotkey string
+ * Handles both platform-specific and generic formats
+ */
+export function normalizeAccelerator(accelerator: string): string {
+  // Replace CommandOrControl with platform-specific
+  if (isMacOS()) {
+    return accelerator
+      .replace(/CommandOrControl/gi, 'Command')
+      .replace(/CmdOrCtrl/gi, 'Cmd');
+  } else {
+    return accelerator
+      .replace(/CommandOrControl/gi, 'Control')
+      .replace(/CmdOrCtrl/gi, 'Ctrl')
+      .replace(/Command/gi, 'Control')
+      .replace(/Cmd/gi, 'Ctrl');
+  }
+}
+
+/**
+ * Parse an accelerator string into individual keys
+ */
+export function parseAccelerator(accelerator: string): string[] {
+  return accelerator.split('+').map(k => k.trim());
+}
+
+/**
+ * Get display keys for an accelerator (for UI rendering)
+ * Returns keys formatted appropriately for the current platform
+ */
+export function getDisplayKeys(accelerator: string): string[] {
+  const keys = parseAccelerator(accelerator);
+  const platform = isMacOS();
+
+  return keys.map(key => {
+    const lowerKey = key.toLowerCase();
+
+    if (platform) {
+      // macOS: Use symbols
+      return MAC_SYMBOLS[lowerKey] || key.toUpperCase();
+    } else {
+      // Windows/Linux: Use readable names
+      return WIN_LINUX_NAMES[lowerKey] || key.toUpperCase();
+    }
+  });
+}
+
+/**
+ * Get display keys for a hotkey by ID
+ */
+export function getDisplayKeysById(hotkeyId: string): string[] {
+  const accelerator = getAccelerator(hotkeyId);
+  return getDisplayKeys(accelerator);
+}
+
+/**
+ * Format an accelerator for display
+ * Returns a single string like "Cmd+Shift+F" or "Ctrl+Shift+F"
+ */
+export function formatAcceleratorForDisplay(accelerator: string): string {
+  const keys = getDisplayKeys(accelerator);
+  return keys.join('+');
+}
+
+/**
+ * Format a hotkey for display by ID
+ */
+export function formatHotkeyForDisplay(hotkeyId: string): string {
+  const accelerator = getAccelerator(hotkeyId);
+  return formatAcceleratorForDisplay(accelerator);
+}
+
+/**
+ * Convert a HotkeyConfig-style accelerator to display format
+ * Handles "CommandOrControl" and other generic formats
+ */
+export function formatHotkeyConfigForDisplay(accelerator: string): string {
+  const normalized = normalizeAccelerator(accelerator);
+  return formatAcceleratorForDisplay(normalized);
+}
+
+// ============================================================================
+// Exports for types compatibility
+// ============================================================================
+
+export type HotkeyId = (typeof HOTKEYS)[number]['id'];