TidGi-Desktop/src/services/windows/WindowProperties.ts

import type { CreateWorkspaceTabs } from '@/windows/AddWorkspace/constants';
import type { PreferenceSections } from '@services/preferences/interface';
import { IWorkspace } from '@services/workspaces/interface';

export enum WindowNames {
  about = 'about',
  addWorkspace = 'addWorkspace',
  /**
   * Open any website URL, this is a popup window that user can open a help resource.
   */
  any = 'any',
  auth = 'auth',
  editWorkspace = 'editWorkspace',
  /**
   * Git history viewer window
   */
  gitHistory = 'gitHistory',
  /**
   * Window with workspace list and new wiki button on left side bar
   * We only have a single instance of main window, that is the app window.
   */
  main = 'main',
  tidgiMiniWindow = 'tidgiMiniWindow',
  notifications = 'notifications',
  preferences = 'preferences',
  /**
   * Second wiki window in a popup window.
   */
  secondary = 'secondary',
  spellcheck = 'spellcheck',
  /**
   * browserView that loads the wiki webpage
   * We will have multiple view window, each main workspace will have one.
   */
  view = 'view',
}

/**
 * Width height of windows
 */
export const windowDimension: Record<WindowNames, { height?: number; width?: number }> = {
  [WindowNames.main]: {
    width: 1200,
    height: 768,
  },
  [WindowNames.secondary]: {
    width: 961,
    height: 768,
  },
  [WindowNames.any]: {
    width: 1200,
    height: 768,
  },
  [WindowNames.tidgiMiniWindow]: {
    width: 500,
    height: 600,
  },
  [WindowNames.about]: {
    width: 400,
    height: 420,
  },
  [WindowNames.auth]: {
    width: 400,
    height: 220,
  },
  [WindowNames.view]: {
    width: undefined,
    height: undefined,
  },
  [WindowNames.addWorkspace]: {
    width: 690,
    height: 800,
  },
  [WindowNames.editWorkspace]: {
    width: 420,
    height: 600,
  },
  [WindowNames.gitHistory]: {
    width: 1600,
    height: 800,
  },
  [WindowNames.preferences]: {
    width: 840,
    height: 700,
  },
  [WindowNames.notifications]: {
    width: 400,
    height: 585,
  },
  [WindowNames.spellcheck]: {
    width: 400,
    height: 590,
  },
};

export interface IPreferenceWindowMeta {
  preferenceGotoTab?: PreferenceSections;
  preventClosingWindow?: boolean;
}

/**
 * metadata that send to window when create them.
 * Please make all property partial (?:), so wo can always assign {} as default metadata without type warning
 */
export interface WindowMeta {
  [WindowNames.about]: undefined;
  [WindowNames.addWorkspace]: { addWorkspaceTab?: CreateWorkspaceTabs };
  [WindowNames.any]: { uri?: string };
  [WindowNames.auth]: undefined;
  [WindowNames.editWorkspace]: { workspaceID?: string };
  [WindowNames.gitHistory]: { workspaceID?: string };
  [WindowNames.main]: { forceClose?: boolean };
  [WindowNames.tidgiMiniWindow]: undefined;
  [WindowNames.notifications]: undefined;
  [WindowNames.preferences]: IPreferenceWindowMeta;
  [WindowNames.spellcheck]: undefined;
  [WindowNames.secondary]: undefined;
  [WindowNames.view]: IBrowserViewMetaData;
}
export type IPossibleWindowMeta<M extends WindowMeta[WindowNames] = WindowMeta[WindowNames.main]> = {
  windowName: WindowNames;
} & M;

/**
 * Similar to WindowMeta, but is for WebContentsView (workspace web content) and popup window from the WebContentsView
 */
export interface IBrowserViewMetaData {
  isPopup?: boolean;
  workspace?: IWorkspace;
}