Skip to content

Edge-Drop is a clipboard shelf on the edge of your screen. Hover to open it. Drag files and images into any app, click to copy text and links. Free and open-source for Windows.

5.0 KB
Raw Blame
/**
 * Type definition for the preload bridge API surface.
 *
 * Both the preload (implements) and renderer (consumes) import this so the
 * contract lives in one place. The actual implementation lives in the preload;
 * the renderer only ever sees `window.edge` typed as this interface.
 */
import type { Settings } from './types'
import type { DragRequest } from './types'

export interface EdgeApi {
  /* Renderer -> Main */
  loadState: () => Promise<{
    items: import('./types').ClipboardItemDto[]
    settings: Settings
    version: string
    isStoreBuild?: boolean
    updateInfo?: {
      hasUpdate: boolean
      latestVersion: string
      downloaded: boolean
      downloadProgress?: { percent: number; bytesPerSecond?: number; transferred?: number; total?: number }
    } | null
  }>
  setPinned: (id: string, pinned: boolean) => Promise<import('./types').ClipboardItemDto[]>
  deleteItem: (id: string) => Promise<import('./types').ClipboardItemDto[]>
  deleteBatchItems: (ids: string[]) => Promise<import('./types').ClipboardItemDto[]>
  clearItems: () => Promise<import('./types').ClipboardItemDto[]>
  getFullText: (id: string) => Promise<string>
  removeSubitem: (req: DragRequest) => Promise<boolean>
  copyItem: (id: string) => Promise<boolean>
  copySubitem: (req: DragRequest) => Promise<boolean>
  pasteItem: (id: string, opts?: { plain?: boolean }) => Promise<boolean>
  setItemMeta: (id: string, meta: import('./itemMeta').ItemMetaPatch) => Promise<import('./types').ClipboardItemDto[]>
  copyText: (text: string) => Promise<boolean>
  saveImages: (id: string) => Promise<string[]>
  pasteSubitem: (req: DragRequest) => Promise<boolean>
  pasteEmoji: (text: string) => Promise<boolean>
  emojiGlyphs: (files: string[]) => Promise<Record<string, string>>
  /** A file-kind folder icon's SVG source, or null (see ipc 'icon:svg'). */
  iconSvg: (kind: string) => Promise<string | null>
  installUpdate: () => Promise<void>
  checkForUpdatesManual: () => Promise<{ status: string; version?: string; error?: string }>
  startUpdateDownload: () => Promise<void>
  getUpdateState: () => Promise<{
    hasUpdate: boolean
    latestVersion: string
    downloaded: boolean
    downloadProgress?: { percent: number; bytesPerSecond?: number; transferred?: number; total?: number }
  } | null>
  quitApp: () => Promise<void>
  /**
   * Begin a native OS drag-out. Fire-and-forget: must be called synchronously
   * from the DOM `dragstart` event, and main calls `event.sender.startDrag`.
   */
  startDrag: (req: DragRequest) => void
  /**
   * Pre-stage a drag request in the background (e.g. on hover or pointerdown)
   * so drag initiation is 0ms.
   */
  prestageDrag: (req: DragRequest) => void
  addFiles: (paths: string[]) => Promise<import('./types').ClipboardItemDto[]>
  addItemData: (data: import('./types').ItemData) => Promise<import('./types').ClipboardItemDto[]>
  mergeItems: (sourceId: string, targetId: string) => Promise<import('./types').MergeResult>
  splitItem: (req: import('./types').DragRequest) => Promise<boolean>
  updateSettings: (patch: Partial<Settings>) => Promise<Settings>
  refreshLaunchAtLogin: () => Promise<Settings>
  setInteractive: (value: boolean) => Promise<void>
  /** Re-check what the pointer is over after the cards moved under it (ipc 'window:resync-hover'). */
  resyncHover: () => void
  setPreviewMode: (active: boolean) => Promise<void>
  pauseHotkey: (paused: boolean) => Promise<void>
  revealFile: (path: string) => Promise<boolean>
  minimizeWindow: () => Promise<void>
  focusWindow: (focusable?: boolean) => Promise<void>
  getDisplays: () => Promise<import('./types').DisplayInfo[]>
  setInternalDrag: (active: boolean) => void
  broadcastTutorialStep: (step: number) => void

  /* Main -> Renderer */
  onItems: (cb: (items: import('./types').ClipboardItemDto[], meta?: { reason?: 'usage' | 'capture' }) => void) => () => void
  onSettings: (cb: (settings: Settings) => void) => () => void
  onToggle: (cb: (open?: boolean) => void) => () => void
  onOpenSettings: (cb: () => void) => () => void
  onDragEnd: (cb: () => void) => () => void
  onInternalDrop: (cb: (pos: { x: number; y: number }) => void) => () => void
  onCursorEdge: (cb: (data: {
    x: number
    y: number
    inEdge: boolean
    inZone: boolean
    stickPosition: import('./types').StickPosition
    displayWidth: number
    displayHeight: number
    /** A drag from another app is in progress anywhere on screen (see electron/main/externalDrag.ts). */
    drag?: boolean
  }) => void) => () => void
  onToast: (cb: (toast: { id: string; message: string; tone: 'info' | 'error'; params?: Record<string, string | number> }) => void) => () => void
  onCopyFlare: (cb: () => void) => () => void
  onTutorialStep: (cb: (step: number) => void) => () => void
  onUpdateAvailable: (cb: (info: { version: string }) => void) => () => void
  onUpdateProgress: (cb: (progress: { percent: number; bytesPerSecond?: number; transferred?: number; total?: number }) => void) => () => void
  onUpdateDownloaded: (cb: (info: { version: string }) => void) => () => void
}