mattermostest/src/types/window.ts

// Copyright (c) 2016-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.

import type {ipcRenderer, Rectangle} from 'electron/renderer';

import type {CombinedConfig, LocalConfiguration, UniqueView, UniqueServer} from './config';
import type {DownloadedItem, DownloadedItems, DownloadsMenuOpenEventPayload} from './downloads';
import type {URLValidationResult} from './server';
import type {SaveQueueItem} from './settings';

import type {Language} from '../../i18n/i18n';

declare global {
    interface Window {
        ipcRenderer: {
            send: typeof ipcRenderer.send;
            on: (channel: string, listener: (...args: any[]) => void) => void;
            invoke: typeof ipcRenderer.invoke;
        };
        process: {
            platform: NodeJS.Platform;
            env: {
                user?: string;
                username?: string;
            };
        };
        timers: {
            setImmediate: typeof setImmediate;
        };
        desktop: {
            quit: (reason: string, stack: string) => void;
            openAppMenu: () => void;
            closeServersDropdown: () => void;
            openServersDropdown: () => void;
            switchTab: (viewId: string) => void;
            closeView: (viewId: string) => void;
            exitFullScreen: () => void;
            doubleClickOnWindow: (windowName?: string) => void;
            focusCurrentView: () => void;
            openServerExternally: () => void;
            openServerUpgradeLink: () => void;
            closeDownloadsDropdown: () => void;
            closeDownloadsDropdownMenu: () => void;
            openDownloadsDropdown: () => void;
            goBack: () => void;
            checkForUpdates: () => void;
            updateConfiguration: (saveQueueItems: SaveQueueItem[]) => void;
            getNonce: () => Promise<string | undefined>;
            isDeveloperModeEnabled: () => Promise<boolean>;

            updateServerOrder: (serverOrder: string[]) => Promise<void>;
            updateTabOrder: (serverId: string, viewOrder: string[]) => Promise<void>;
            getLastActive: () => Promise<{server: string; view: string}>;
            getOrderedServers: () => Promise<UniqueServer[]>;
            getOrderedTabsForServer: (serverId: string) => Promise<UniqueView[]>;
            onUpdateServers: (listener: () => void) => void;
            validateServerURL: (url: string, currentId?: string) => Promise<URLValidationResult>;

            getConfiguration: () => Promise<CombinedConfig[keyof CombinedConfig] | CombinedConfig>;
            getVersion: () => Promise<{name: string; version: string}>;
            getDarkMode: () => Promise<boolean>;
            requestHasDownloads: () => Promise<boolean>;
            getFullScreenStatus: () => Promise<boolean>;
            getAvailableSpellCheckerLanguages: () => Promise<string[]>;
            getAvailableLanguages: () => Promise<string[]>;
            getLocalConfiguration: () => Promise<LocalConfiguration[keyof LocalConfiguration] | Partial<LocalConfiguration>>;
            getDownloadLocation: (downloadLocation?: string) => Promise<string>;
            getLanguageInformation: () => Promise<Language>;

            onSynchronizeConfig: (listener: () => void) => void;
            onReloadConfiguration: (listener: () => void) => void;
            onDarkModeChange: (listener: (darkMode: boolean) => void) => void;
            onLoadRetry: (listener: (viewId: string, retry: Date, err: string, loadUrl: string) => void) => void;
            onLoadSuccess: (listener: (viewId: string) => void) => void;
            onLoadFailed: (listener: (viewId: string, err: string, loadUrl: string) => void) => void;
            onLoadIncompatibleServer: (listener: (viewId: string, loadUrl: string) => void) => void;
            onSetActiveView: (listener: (serverId: string, viewId: string) => void) => void;
            onMaximizeChange: (listener: (maximize: boolean) => void) => void;
            onEnterFullScreen: (listener: () => void) => void;
            onLeaveFullScreen: (listener: () => void) => void;
            onPlaySound: (listener: (soundName: string) => void) => void;
            onModalOpen: (listener: () => void) => void;
            onModalClose: (listener: () => void) => void;
            onUpdateMentions: (listener: (view: string, mentions: number, unreads: boolean, isExpired: boolean) => void) => void;
            onCloseServersDropdown: (listener: () => void) => void;
            onOpenServersDropdown: (listener: () => void) => void;
            onCloseDownloadsDropdown: (listener: () => void) => void;
            onOpenDownloadsDropdown: (listener: () => void) => void;
            onShowDownloadsDropdownButtonBadge: (listener: () => void) => void;
            onHideDownloadsDropdownButtonBadge: (listener: () => void) => void;
            onUpdateDownloadsDropdown: (listener: (downloads: DownloadedItems, darkMode: boolean, windowBounds: Rectangle, item: DownloadedItem) => void) => void;
            onAppMenuWillClose: (listener: () => void) => void;
            onFocusThreeDotMenu: (listener: () => void) => void;

            updateURLViewWidth: (width?: number) => void;
            openNotificationPreferences: () => void;
            openWindowsCameraPreferences: () => void;
            openWindowsMicrophonePreferences: () => void;
            getMediaAccessStatus: (mediaType: 'microphone' | 'camera' | 'screen') => Promise<'not-determined' | 'granted' | 'denied' | 'restricted' | 'unknown'>;

            modals: {
                cancelModal: <T>(data?: T) => void;
                finishModal: <T>(data?: T) => void;
                getModalInfo: <T>() => Promise<T>;
                isModalUncloseable: () => Promise<boolean>;
                confirmProtocol: (protocol: string, url: string) => void;
                pingDomain: (url: string) => Promise<string>;
            };

            loadingScreen: {
                loadingScreenAnimationFinished: () => void;
                onToggleLoadingScreenVisibility: (listener: (toggle: boolean) => void) => void;
            };

            downloadsDropdown: {
                requestInfo: () => void;
                sendSize: (width: number, height: number) => void;
                openFile: (item: DownloadedItem) => void;
                startUpdateDownload: () => void;
                startUpgrade: () => void;
                requestClearDownloadsDropdown: () => void;
                toggleDownloadsDropdownMenu: (payload: DownloadsMenuOpenEventPayload) => void;
                focus: () => void;
            };

            downloadsDropdownMenu: {
                requestInfo: () => void;
                showInFolder: (item: DownloadedItem) => void;
                cancelDownload: (item: DownloadedItem) => void;
                clearFile: (item: DownloadedItem) => void;
                openFile: (item: DownloadedItem) => void;

                onUpdateDownloadsDropdownMenu: (listener: (item: DownloadedItem, darkMode: boolean) => void) => void;
            };

            serverDropdown: {
                requestInfo: () => void;
                sendSize: (width: number, height: number) => void;
                switchServer: (serverId: string) => void;
                showNewServerModal: () => void;
                showEditServerModal: (serverId: string) => void;
                showRemoveServerModal: (serverId: string) => void;

                onUpdateServerDropdown: (listener: (
                    servers: UniqueServer[],
                    darkMode: boolean,
                    windowBounds: Rectangle,
                    activeServer?: string,
                    enableServerManagement?: boolean,
                    hasGPOServers?: boolean,
                    expired?: Map<string, boolean>,
                    mentions?: Map<string, number>,
                    unreads?: Map<string, boolean>,
                ) => void) => void;
            };
        };
    }

    interface Navigator {
        windowControlsOverlay?: {
            getTitlebarAreaRect: () => DOMRect;
        };
    }
}