electron-arduino.ts

import type {
  MessageBoxOptions as ElectronMessageBoxOptions,
  MessageBoxReturnValue as ElectronMessageBoxReturnValue,
  OpenDialogOptions as ElectronOpenDialogOptions,
  OpenDialogReturnValue as ElectronOpenDialogReturnValue,
  SaveDialogOptions as ElectronSaveDialogOptions,
  SaveDialogReturnValue as ElectronSaveDialogReturnValue,
} from '@theia/core/electron-shared/electron';
import type { Disposable } from '@theia/core/lib/common/disposable';
import type {
  InternalMenuDto as TheiaInternalMenuDto,
  MenuDto,
} from '@theia/core/lib/electron-common/electron-api';

export const appInfoPropertyLiterals = [
  'appVersion',
  'cliVersion',
  'buildDate',
] as const;
export type AppInfoProperty = (typeof appInfoPropertyLiterals)[number];
export type AppInfo = {
  readonly [P in AppInfoProperty]: string;
};

import type { Sketch } from '../common/protocol/sketches-service';
import type { StartupTasks } from './startup-task';

export interface InternalMenuDto
  extends Omit<TheiaInternalMenuDto, 'handlerId'> {
  // Theia handles the menus with a running-index handler ID. https://github.com/eclipse-theia/theia/issues/12493
  // IDE2 keeps the menu `nodeId` instead of the running-index.
  nodeId?: string;
}

export type MessageBoxOptions = Omit<
  ElectronMessageBoxOptions,
  'icon' | 'signal'
>;
export type MessageBoxReturnValue = ElectronMessageBoxReturnValue;
export type OpenDialogOptions = ElectronOpenDialogOptions;
export type OpenDialogReturnValue = ElectronOpenDialogReturnValue;
export type SaveDialogOptions = ElectronSaveDialogOptions;
export type SaveDialogReturnValue = ElectronSaveDialogReturnValue;

export interface ShowPlotterWindowParams {
  readonly url: string;
  readonly forceReload?: boolean;
}
export function isShowPlotterWindowParams(
  arg: unknown
): arg is ShowPlotterWindowParams {
  return (
    typeof arg === 'object' &&
    typeof (<ShowPlotterWindowParams>arg).url === 'string' &&
    ((<ShowPlotterWindowParams>arg).forceReload === undefined ||
      typeof (<ShowPlotterWindowParams>arg).forceReload === 'boolean')
  );
}

export interface ElectronArduino {
  showMessageBox(options: MessageBoxOptions): Promise<MessageBoxReturnValue>;
  showOpenDialog(options: OpenDialogOptions): Promise<OpenDialogReturnValue>;
  showSaveDialog(options: SaveDialogOptions): Promise<SaveDialogReturnValue>;
  appInfo(): Promise<AppInfo>;
  quitApp(): void;
  isFirstWindow(): Promise<boolean>;
  requestReload(tasks: StartupTasks): void;
  registerStartupTasksHandler(
    handler: (tasks: StartupTasks) => void
  ): Disposable;
  scheduleDeletion(sketch: Sketch): void;
  setRepresentedFilename(fsPath: string): void;
  showPlotterWindow(params: { url: string; forceReload?: boolean }): void;
  registerPlotterWindowCloseHandler(handler: () => void): Disposable;
  openPath(fsPath: string): void;
  // Unlike the Theia implementation, IDE2 uses the command IDs, and not the running-index handler IDs.
  // https://github.com/eclipse-theia/theia/issues/12493
  setMenu(menu: MenuDto[] | undefined): void;
}

declare global {
  interface Window {
    electronArduino: ElectronArduino;
  }
}

// renderer to main
export const CHANNEL_SHOW_MESSAGE_BOX = 'Arduino:ShowMessageBox';
export const CHANNEL_SHOW_OPEN_DIALOG = 'Arduino:ShowOpenDialog';
export const CHANNEL_SHOW_SAVE_DIALOG = 'Arduino:ShowSaveDialog';
export const CHANNEL_APP_INFO = 'Arduino:AppInfo';
export const CHANNEL_QUIT_APP = 'Arduino:QuitApp';
export const CHANNEL_IS_FIRST_WINDOW = 'Arduino:IsFirstWindow';
export const CHANNEL_SCHEDULE_DELETION = 'Arduino:ScheduleDeletion';
export const CHANNEL_SET_REPRESENTED_FILENAME =
  'Arduino:SetRepresentedFilename';
export const CHANNEL_SHOW_PLOTTER_WINDOW = 'Arduino:ShowPlotterWindow';
export const CHANNEL_OPEN_PATH = 'Arduino:OpenPath';
export const CHANNEL_SET_MENU_WITH_NODE_ID = 'Arduino:SetMenuWithNodeId';
// main to renderer
export const CHANNEL_SEND_STARTUP_TASKS = 'Arduino:SendStartupTasks';
export const CHANNEL_PLOTTER_WINDOW_DID_CLOSE = 'Arduino:PlotterWindowDidClose';
export const CHANNEL_MAIN_MENU_ITEM_DID_CLICK = 'Arduino:MainMenuItemDidClick';