/**
 * **Типы для urlManager**
 *
 * _Определяет все типы данных, используемые в модуле управления URL параметрами._
 *
 * @module urlManager-types
 *
 */

/**
 * **Параметры поиска в URL**
 *
 * _Структура параметров, которые сохраняются в URL._
 *
 * @group URL Parameters
 *
 */
export interface UrlSearchParams {
  /**
   * Поисковый запрос
   *
   * @defaultValue undefined
   */
  query?: string;

  /**
   * Параметр сортировки
   *
   * @defaultValue undefined
   */
  sort?: string;

  /**
   * Номер страницы
   *
   * @defaultValue undefined
   */
  page?: string;

  /**
   * JSON строка с фильтрами
   *
   * @defaultValue undefined
   */
  filters?: string;
}

/**
 * **Конфигурация менеджера URL**
 *
 * _Настройки для кастомизации поведения URL менеджера._
 *
 * @group Configuration
 *
 */
export interface UrlManagerConfig {
  /**
   * Включить/выключить работу с URL
   *
   * @defaultValue true
   */
  enabled?: boolean;

  /**
   * Ключи для параметров в URL
   *
   * @defaultValue { query: "q", sort: "sort", page: "page", filters: "filters" }
   */
  paramKeys?: {
    /** Ключ для поискового запроса */
    query: string;

    /** Ключ для параметра сортировки */
    sort: string;

    /** Ключ для номера страницы */
    page: string;

    /** Ключ для фильтров */
    filters: string;
  };

  /**
   * Задержка перед обновлением URL (мс)
   *
   * @defaultValue 300
   */
  debounceMs?: number;
}