Interface ElectronAPI

packages/desktop-app/src/renderer/global.d.ts:21–86

Electron APIs exposed to the renderer via the preload contextBridge

/** Electron APIs exposed to the renderer via the preload contextBridge */
interface ElectronAPI {
  platform: string;

  windowControls: {
    minimize(): void;
    maximize(): void;
    close(): void;
    isMaximized(): Promise<boolean>;
    onMaximizedChange(cb: (isMaximized: boolean) => void): () => void;
  };

  shortcuts: {
    onCloseTab(cb: () => void): () => void;
    onKeydown(
      cb: (info: { key: string; shiftKey: boolean; altKey?: boolean }) => void,
    ): () => void;
  };

  setActiveApp(appId: string): void;
  setActiveWebview(target: { appId: string; webContentsId?: number }): void;

  interApp: {
    send(targetAppId: string, event: string, data: unknown): void;
    on(cb: (from: string, event: string, data: unknown) => void): () => void;
  };

  frame: {
    load(): Promise<{
      enabled: boolean;
      mode: "dev" | "prod";
      prodUrl?: string;
    }>;
    update(settings: {
      enabled?: boolean;
      mode?: "dev" | "prod";
      prodUrl?: string;
    }): Promise<{
      enabled: boolean;
      mode: "dev" | "prod";
      prodUrl?: string;
    }>;
  };

  updater: {
    check(): Promise<UpdateStatus>;
    download(): Promise<UpdateStatus>;
    install(): void;
    getStatus(): Promise<UpdateStatus>;
    onStatusChange(cb: (status: UpdateStatus) => void): () => void;
  };

  appConfig: {
    load(): Promise<import("@agent-native/shared-app-config").AppConfig[]>;
    add(
      app: import("@agent-native/shared-app-config").AppConfig,
    ): Promise<import("@agent-native/shared-app-config").AppConfig[]>;
    remove(
      id: string,