@lobehub/chat/packages/electron-client-ipc/src/events/windows.ts

Lobe Chat - an open-source, high-performance chatbot framework that supports speech synthesis, multimodal, and extensible Function Call plugin system. Supports one-click free deployment of your private ChatGPT/LLM web application.

import { InterceptRouteParams, InterceptRouteResponse } from '../types/route';

export interface OpenSettingsWindowOptions {
  /**
   * Query parameters that should be appended to the settings URL.
   */
  searchParams?: Record<string, string | undefined>;
  /**
   * Settings page tab path or identifier.
   */
  tab?: string;
}

export interface CreateMultiInstanceWindowParams {
  path: string;
  templateId: string;
  uniqueId?: string;
}

export interface CreateMultiInstanceWindowResponse {
  error?: string;
  success: boolean;
  windowId?: string;
}

export interface GetWindowsByTemplateResponse {
  error?: string;
  success: boolean;
  windowIds?: string[];
}

export interface WindowsDispatchEvents {
  /**
   * Close all windows by template
   * @param templateId Template identifier
   * @returns Operation result
   */
  closeWindowsByTemplate: (templateId: string) => { error?: string; success: boolean };

  /**
   * Create a new multi-instance window
   * @param params Window creation parameters
   * @returns Creation result
   */
  createMultiInstanceWindow: (
    params: CreateMultiInstanceWindowParams,
  ) => CreateMultiInstanceWindowResponse;

  /**
   * Get all windows by template
   * @param templateId Template identifier
   * @returns List of window identifiers
   */
  getWindowsByTemplate: (templateId: string) => GetWindowsByTemplateResponse;

  /**
   * 拦截客户端路由导航请求
   * @param params 包含路径和来源信息的参数对象
   * @returns 路由拦截结果
   */
  interceptRoute: (params: InterceptRouteParams) => InterceptRouteResponse;

  /**
   * open the LobeHub Devtools
   */
  openDevtools: () => void;

  openSettingsWindow: (options?: OpenSettingsWindowOptions | string) => void;
}