dialog.service-model.ts

import {
  AboutDialogOptions,
  DialogTabTypes,
  DialogTypes,
  SelectProjectDialogOptions,
} from '@renderer/components/dialogs/dialog-definition.model';

/**
 * JSDOC SOURCE dialogService
 *
 * Prompt the user for responses with dialogs
 */
export interface DialogService {
  /**
   * Shows a dialog to the user and prompts the user to respond
   *
   * @type `TReturn` - The type of data the dialog responds with
   * @param dialogType The type of dialog to show the user
   * @param options Various options for configuring the dialog that shows
   * @returns Returns the user's response or `undefined` if the user cancels
   */
  showDialog<DialogTabType extends DialogTabTypes>(
    dialogType: DialogTabType,
    options?: DialogTypes[DialogTabType]['options'],
  ): Promise<DialogTypes[DialogTabType]['responseType'] | undefined>;
  /**
   * Shows a select project dialog to the user and prompts the user to select a dialog
   *
   * @param options Various options for configuring the dialog that shows
   * @returns Returns the user's selected project id or `undefined` if the user cancels
   */
  selectProject(options?: SelectProjectDialogOptions): Promise<string | undefined>;
  /**
   * Shows the about dialog
   *
   * @param options Various options for configuring the dialog that shows
   * @returns Returns the user's selected project id or `undefined` if the user cancels
   */
  showAboutDialog(options?: AboutDialogOptions): Promise<string | undefined>;
}

/** Prefix on requests that indicates that the request is related to dialog operations */
export const CATEGORY_DIALOG = 'dialog';