@dxtmisha/functional-basic 1.1.0 → 1.1.6

package/dist/classes/MetaOg.d.ts

@@ -0,0 +1,115 @@
+import { MetaManager } from './MetaManager';
+import { MetaOpenGraphTag, MetaOpenGraphType } from '../types/metaTypes';
+/**
+ * Class for working with Open Graph meta tags.
+ *
+ * Класс для управления мета-тегами Open Graph.
+ */
+export declare class MetaOg extends MetaManager<MetaOpenGraphTag[]> {
+    constructor();
+    /**
+     * Gets the Open Graph title.
+     *
+     * Получает заголовок Open Graph.
+     * @returns title / заголовок
+     */
+    getTitle(): string;
+    /**
+     * Gets the Open Graph type.
+     *
+     * Получает тип Open Graph.
+     * @returns type / тип
+     */
+    getType(): MetaOpenGraphType;
+    /**
+     * Gets the Open Graph URL.
+     *
+     * Получает URL Open Graph.
+     * @returns URL / URL
+     */
+    getUrl(): string;
+    /**
+     * Gets the Open Graph image URL.
+     *
+     * Получает URL изображения Open Graph.
+     * @returns image URL / URL изображения
+     */
+    getImage(): string;
+    /**
+     * Gets the Open Graph description.
+     *
+     * Получает описание Open Graph.
+     * @returns description / описание
+     */
+    getDescription(): string;
+    /**
+     * Gets the Open Graph locale.
+     *
+     * Получает локаль Open Graph.
+     * @returns locale / локаль
+     */
+    getLocale(): string;
+    /**
+     * Gets the Open Graph site name.
+     *
+     * Получает название сайта Open Graph.
+     * @returns site name / название сайта
+     */
+    getSiteName(): string;
+    /**
+     * Sets the Open Graph title.
+     *
+     * Устанавливает заголовок Open Graph.
+     * @param title title / заголовок
+     * @returns current instance / текущий экземпляр
+     */
+    setTitle(title: string): this;
+    /**
+     * Sets the Open Graph type.
+     *
+     * Устанавливает тип Open Graph.
+     * @param type type / тип
+     * @returns current instance / текущий экземпляр
+     */
+    setType(type: MetaOpenGraphType): this;
+    /**
+     * Sets the Open Graph URL.
+     *
+     * Устанавливает URL Open Graph.
+     * @param url URL / URL
+     * @returns current instance / текущий экземпляр
+     */
+    setUrl(url: string): this;
+    /**
+     * Sets the Open Graph image URL.
+     *
+     * Устанавливает URL изображения Open Graph.
+     * @param url image URL / URL изображения
+     * @returns current instance / текущий экземпляр
+     */
+    setImage(url: string): this;
+    /**
+     * Sets the Open Graph description.
+     *
+     * Устанавливает описание Open Graph.
+     * @param description description / описание
+     * @returns current instance / текущий экземпляр
+     */
+    setDescription(description: string): this;
+    /**
+     * Sets the Open Graph locale.
+     *
+     * Устанавливает локаль Open Graph.
+     * @param locale locale (e.g. 'en_US', 'ru_RU') / локаль (например, 'en_US', 'ru_RU')
+     * @returns current instance / текущий экземпляр
+     */
+    setLocale(locale: string): this;
+    /**
+     * Sets the Open Graph site name.
+     *
+     * Устанавливает название сайта Open Graph.
+     * @param siteName site name / название сайта
+     * @returns current instance / текущий экземпляр
+     */
+    setSiteName(siteName: string): this;
+}

package/dist/classes/MetaStatic.d.ts

@@ -0,0 +1,179 @@
+import { Meta } from './Meta';
+import { MetaOg } from './MetaOg';
+import { MetaTwitter } from './MetaTwitter';
+import { MetaRobots } from '../types/metaTypes';
+/**
+ * Static class for managing meta tags.
+ *
+ * Статичный класс для управления мета-тегами.
+ */
+export declare class MetaStatic {
+    /**
+     * Returns the singleton instance of the Meta class.
+     *
+     * Возвращает синглтон-экземпляр класса Meta.
+     * @returns Meta singleton / синглтон Meta
+     */
+    static getItem(): Meta;
+    /**
+     * Gets the MetaOg instance for advanced Open Graph operations.
+     *
+     * Получает экземпляр MetaOg для расширенных операций с Open Graph.
+     * @returns MetaOg instance / экземпляр MetaOg
+     */
+    static getOg(): MetaOg;
+    /**
+     * Gets the MetaTwitter instance for advanced Twitter Card operations.
+     *
+     * Получает экземпляр MetaTwitter для расширенных операций с Twitter Card.
+     * @returns MetaTwitter instance / экземпляр MetaTwitter
+     */
+    static getTwitter(): MetaTwitter;
+    /**
+     * Gets the page title without suffix.
+     *
+     * Получает заголовок страницы без суффикса.
+     * @returns title without suffix / заголовок без суффикса
+     */
+    static getTitle(): string;
+    /**
+     * Gets the keywords meta tag.
+     *
+     * Получает мета-тег keywords.
+     * @returns keywords content / содержимое keywords
+     */
+    static getKeywords(): string;
+    /**
+     * Gets the description meta tag.
+     *
+     * Получает мета-тег description.
+     * @returns description content / содержимое description
+     */
+    static getDescription(): string;
+    /**
+     * Gets the Open Graph image URL.
+     *
+     * Получает URL изображения Open Graph.
+     * @returns image URL / URL изображения
+     */
+    static getImage(): string;
+    /**
+     * Gets the canonical URL.
+     *
+     * Получает канонический URL.
+     * @returns canonical URL / канонический URL
+     */
+    static getCanonical(): string;
+    /**
+     * Gets the robots meta tag value.
+     *
+     * Получает значение мета-тега robots.
+     * @returns robots directive / директива robots
+     */
+    static getRobots(): MetaRobots;
+    /**
+     * Gets the author meta tag.
+     *
+     * Получает мета-тег author.
+     * @returns author name / имя автора
+     */
+    static getAuthor(): string;
+    /**
+     * Gets the Open Graph site name.
+     *
+     * Получает название сайта Open Graph.
+     * @returns site name / название сайта
+     */
+    static getSiteName(): string;
+    /**
+     * Gets the Open Graph locale.
+     *
+     * Получает локаль Open Graph.
+     * @returns locale / локаль
+     */
+    static getLocale(): string;
+    /**
+     * Sets the page title (with suffix) and updates Open Graph and Twitter Card titles.
+     *
+     * Устанавливает заголовок страницы (с суффиксом) и обновляет заголовки Open Graph и Twitter Card.
+     * @param title page title / заголовок страницы
+     */
+    static setTitle(title: string): typeof MetaStatic;
+    /**
+     * Sets the keywords meta tag.
+     *
+     * Устанавливает мета-тег keywords.
+     * @param keywords keywords as string or array / ключевые слова в виде строки или массива
+     */
+    static setKeywords(keywords: string | string[]): typeof MetaStatic;
+    /**
+     * Sets the description meta tag.
+     *
+     * Устанавливает мета-тег description.
+     * @param description page description / описание страницы
+     */
+    static setDescription(description: string): typeof MetaStatic;
+    /**
+     * Sets the image for Open Graph and Twitter Card.
+     *
+     * Устанавливает изображение для Open Graph и Twitter Card.
+     * @param image image URL / URL изображения
+     */
+    static setImage(image: string): typeof MetaStatic;
+    /**
+     * Sets the canonical URL and updates Open Graph and Twitter Card URLs.
+     *
+     * Устанавливает канонический URL и обновляет URL для Open Graph и Twitter Card.
+     * @param canonical canonical URL / канонический URL
+     */
+    static setCanonical(canonical: string): typeof MetaStatic;
+    /**
+     * Sets the robots meta tag.
+     *
+     * Устанавливает мета-тег robots.
+     * @param robots robots directive / директива robots
+     */
+    static setRobots(robots: MetaRobots): typeof MetaStatic;
+    /**
+     * Sets the author meta tag.
+     *
+     * Устанавливает мета-тег author.
+     * @param author author name / имя автора
+     */
+    static setAuthor(author: string): typeof MetaStatic;
+    /**
+     * Sets the site name for Open Graph and Twitter Card.
+     *
+     * Устанавливает название сайта для Open Graph и Twitter Card.
+     * @param siteName site name / название сайта
+     */
+    static setSiteName(siteName: string): typeof MetaStatic;
+    /**
+     * Sets the locale for Open Graph.
+     *
+     * Устанавливает локаль для Open Graph.
+     * @param locale locale (e.g. 'en_US', 'ru_RU') / локаль (например, 'en_US', 'ru_RU')
+     */
+    static setLocale(locale: string): typeof MetaStatic;
+    /**
+     * Sets the suffix to append to page title.
+     *
+     * Устанавливает суффикс для добавления к заголовку страницы.
+     * @param suffix title suffix (e.g. 'My Site') / суффикс заголовка (например, 'Мой Сайт')
+     */
+    static setSuffix(suffix?: string): typeof MetaStatic;
+    /**
+     * Generates the complete HTML for all meta-tags including Open Graph and Twitter Card.
+     *
+     * Генерирует полный HTML для всех мета-тегов, включая Open Graph и Twitter Card.
+     * @returns complete HTML string / полная HTML-строка
+     */
+    static html(): string;
+    /**
+     * Generates the title as an HTML-safe string.
+     *
+     * Генерирует заголовок в виде HTML-безопасной строки.
+     * @returns title HTML-safe string / HTML-безопасная строка заголовка
+     */
+    static htmlTitle(): string;
+}

package/dist/classes/MetaTwitter.d.ts

@@ -0,0 +1,115 @@
+import { MetaManager } from './MetaManager';
+import { MetaTwitterCard, MetaTwitterTag } from '../types/metaTypes';
+/**
+ * Class for working with Twitter Card meta tags.
+ *
+ * Класс для управления мета-тегами Twitter Card.
+ */
+export declare class MetaTwitter extends MetaManager<MetaTwitterTag[]> {
+    constructor();
+    /**
+     * Gets the Twitter Card type.
+     *
+     * Получает тип Twitter Card.
+     * @returns card type / тип карточки
+     */
+    getCard(): MetaTwitterCard;
+    /**
+     * Gets the website or brand @username.
+     *
+     * Получает аккаунт сайта или бренда (@username).
+     * @returns @username / аккаунт
+     */
+    getSite(): string;
+    /**
+     * Gets the content creator @username.
+     *
+     * Получает автора контента (@username).
+     * @returns @username / аккаунт автора
+     */
+    getCreator(): string;
+    /**
+     * Gets the page URL.
+     *
+     * Получает URL страницы.
+     * @returns URL / URL
+     */
+    getUrl(): string;
+    /**
+     * Gets the card title.
+     *
+     * Получает заголовок карточки.
+     * @returns title / заголовок
+     */
+    getTitle(): string;
+    /**
+     * Gets the card description.
+     *
+     * Получает описание карточки.
+     * @returns description / описание
+     */
+    getDescription(): string;
+    /**
+     * Gets the card image URL.
+     *
+     * Получает URL изображения карточки.
+     * @returns image URL / URL изображения
+     */
+    getImage(): string;
+    /**
+     * Sets the Twitter Card type.
+     *
+     * Устанавливает тип Twitter Card.
+     * @param card card type / тип карточки
+     * @returns current instance / текущий экземпляр
+     */
+    setCard(card: MetaTwitterCard): this;
+    /**
+     * Sets the website or brand @username.
+     *
+     * Устанавливает аккаунт сайта или бренда (@username).
+     * @param site @username / аккаунт
+     * @returns current instance / текущий экземпляр
+     */
+    setSite(site: string): this;
+    /**
+     * Sets the content creator @username.
+     *
+     * Устанавливает автора контента (@username).
+     * @param creator @username / аккаунт автора
+     * @returns current instance / текущий экземпляр
+     */
+    setCreator(creator: string): this;
+    /**
+     * Sets the page URL.
+     *
+     * Устанавливает URL страницы.
+     * @param url URL / URL
+     * @returns current instance / текущий экземпляр
+     */
+    setUrl(url: string): this;
+    /**
+     * Sets the card title.
+     *
+     * Устанавливает заголовок карточки.
+     * @param title title / заголовок
+     * @returns current instance / текущий экземпляр
+     */
+    setTitle(title: string): this;
+    /**
+     * Sets the card description.
+     *
+     * Устанавливает описание карточки.
+     * @param description description / описание
+     * @returns current instance / текущий экземпляр
+     */
+    setDescription(description: string): this;
+    /**
+     * Sets the card image URL.
+     *
+     * Устанавливает URL изображения карточки.
+     * @param image image URL / URL изображения
+     * @returns current instance / текущий экземпляр
+     */
+    setImage(image: string): this;
+}

package/dist/classes/ResumableTimer.d.ts

@@ -0,0 +1,81 @@
+import { FunctionVoid } from '../types/basicTypes';
+/**
+ * Class for creating a timer that can be paused and resumed.
+ *
+ * Класс для создания таймера, который можно приостанавливать и возобновлять.
+ */
+export declare class ResumableTimer {
+    protected callback: FunctionVoid;
+    protected delay: number;
+    protected timerId?: ReturnType<typeof setTimeout>;
+    protected startTime?: number;
+    protected remaining?: number;
+    protected completed: boolean;
+    /**
+     * Constructor
+     * @param callback function to be called after the delay / функция, которая будет вызвана после задержки
+     * @param delay delay in milliseconds / задержка в миллисекундах
+     * @param blockStart if true, the timer will not start immediately / если true, таймер не запустится сразу
+     */
+    constructor(callback: FunctionVoid, delay?: number, blockStart?: boolean);
+    /**
+     * Resumes the timer if it was paused or starts it for the first time.
+     *
+     * Возобновляет таймер, если он был приостановлен, или запускает его впервые.
+     */
+    resume(): this;
+    /**
+     * Pauses the timer and calculates the remaining time.
+     *
+     * Приостанавливает таймер и вычисляет оставшееся время.
+     */
+    pause(): this;
+    /**
+     * Resets and restarts the timer with the original delay.
+     *
+     * Сбрасывает и перезапускает таймер с исходной задержкой.
+     */
+    reset(): this;
+    /**
+     * Completely clears the timer and resets its state.
+     *
+     * Полностью очищает таймер и сбрасывает его состояние.
+     */
+    clear(): this;
+    /**
+     * Returns the remaining time or the initial delay.
+     *
+     * Возвращает оставшееся время или начальную задержку.
+     */
+    protected getRemaining(): number;
+    /**
+     * Returns the time when the timer was started or the current time.
+     *
+     * Возвращает время запуска таймера или текущее время.
+     */
+    protected getStartTime(): number;
+    /**
+     * Executes the callback and marks the timer as completed.
+     *
+     * Выполняет колбэк и отмечает таймер как завершенный.
+     */
+    protected go(): this;
+    /**
+     * Updates the remaining time based on the elapsed time.
+     *
+     * Обновляет оставшееся время на основе прошедшего времени.
+     */
+    protected updateRemaining(): this;
+    /**
+     * Sets the current time as the start time.
+     *
+     * Устанавливает текущее время как время начала.
+     */
+    protected updateStartTime(): this;
+    /**
+     * Stops the timer and clears the timeout ID.
+     *
+     * Останавливает таймер и очищает идентификатор таймаута.
+     */
+    protected stop(): this;
+}

package/dist/classes/ScrollbarWidth.d.ts

@@ -0,0 +1,51 @@
+import { DataStorage } from './DataStorage';
+/**
+ * Class for getting the scroll width.
+ *
+ * Класс для получения ширины скролла.
+ */
+export declare class ScrollbarWidth {
+    private static calculate;
+    /**
+     * Checks whether to enable scroll hiding.
+     *
+     * Проверяет, надо ли включить скрытие скролла.
+     * @returns boolean indicating if scroll hiding is enabled/ логическое значение, указывающее, включено ли скрытие скролла
+     */
+    static is(): Promise<boolean>;
+    /**
+     * Returns the width of the scroll.
+     *
+     * Возвращает ширину скролла.
+     * @returns scrollbar width in pixels/ ширина скролла в пикселях
+     */
+    static get(): Promise<number>;
+    /**
+     * Returns the storage for scroll width.
+     *
+     * Возвращает хранилище для ширины скролла.
+     * @returns DataStorage instance/ экземпляр DataStorage
+     */
+    static getStorage(): DataStorage<number>;
+    /**
+     * Returns the calculate flag, indicating if width calculation is in progress.
+     *
+     * Возвращает флаг вычисления, указывающий, идет ли расчет ширины.
+     * @returns calculation flag/ флаг вычисления
+     */
+    static getCalculate(): boolean;
+    /**
+     * Creates elements to check the width of the scroll.
+     *
+     * Создает элементы для проверки ширины скролла.
+     * @returns created element / созданный элемент
+     */
+    private static createElement;
+    /**
+     * Initialization of data to check the width of the scroll.
+     *
+     * Инициализация данных для проверки ширины скролла.
+     * @returns a promise that resolves with the scrollbar width / промис, который разрешается шириной скролла
+     */
+    private static init;
+}

package/dist/classes/SearchList.d.ts

@@ -0,0 +1,128 @@
+import { SearchListData } from './SearchListData';
+import { SearchListItem } from './SearchListItem';
+import { SearchListMatcher } from './SearchListMatcher';
+import { SearchListOptions } from './SearchListOptions';
+import { SearchCacheItem, SearchColumns, SearchFormatItem, SearchFormatList, SearchItem, SearchListValue, SearchOptions } from '../types/searchTypes';
+/**
+ * Main class for managing a searchable list.
+ * Coordinates between options, item state, matching logic, and data storage.
+ *
+ * Основной класс для управления списком с возможностью поиска.
+ * Координирует работу опций, состояния элементов, логики сопоставления и хранения данных.
+ */
+export declare class SearchList<T extends SearchItem, K extends SearchColumns<T>> {
+    protected options: SearchListOptions;
+    protected item: SearchListItem;
+    protected matcher: SearchListMatcher;
+    protected data: SearchListData<T, K>;
+    /**
+     * Constructor for SearchList.
+     *
+     * Конструктор для SearchList.
+     * @param list initial list of items/ исходный список элементов
+     * @param columns columns to perform search on/ столбцы для выполнения поиска
+     * @param value initial search value/ начальное значение поиска
+     * @param options search options/ опции поиска
+     */
+    constructor(list: SearchListValue<T>, columns?: K, value?: string, options?: SearchOptions);
+    /**
+     * Returns the search data management instance.
+     *
+     * Возвращает экземпляр управления данными поиска.
+     * @returns SearchListData instance/ экземпляр SearchListData
+     */
+    getData(): SearchListData<T, K>;
+    /**
+     * Returns the current list of items.
+     *
+     * Возвращает текущий список элементов.
+     * @returns list of items/ список элементов
+     */
+    getList(): SearchListValue<T>;
+    /**
+     * Returns the current search columns.
+     *
+     * Возвращает текущие столбцы поиска.
+     * @returns columns or undefined/ столбцы или undefined
+     */
+    getColumns(): K | undefined;
+    /**
+     * Returns the search item instance.
+     *
+     * Возвращает экземпляр элемента поиска.
+     * @returns SearchListItem instance/ экземпляр SearchListItem
+     */
+    getItem(): SearchListItem;
+    /**
+     * Returns the current search value.
+     *
+     * Возвращает текущее значение поиска.
+     * @returns search value string or undefined/ строка значения поиска или undefined
+     */
+    getValue(): string | undefined;
+    /**
+     * Returns the search options instance.
+     *
+     * Возвращает экземпляр опций поиска.
+     * @returns SearchListOptions instance/ экземпляр SearchListOptions
+     */
+    getOptions(): SearchListOptions;
+    /**
+     * Sets a new list of items and resets the cache.
+     *
+     * Устанавливает новый список элементов и сбрасывает кэш.
+     * @param list new list/ новый список
+     * @returns this instance/ данный экземпляр
+     */
+    setList(list: SearchListValue<T>): this;
+    /**
+     * Sets new search columns and resets the cache.
+     *
+     * Устанавливает новые столбцы поиска и сбрасывает кэш.
+     * @param columns new columns/ новые столбцы
+     * @returns this instance/ данный экземпляр
+     */
+    setColumns(columns?: K): this;
+    /**
+     * Sets a new search value and updates the matcher.
+     *
+     * Устанавливает новое значение поиска и обновляет сопоставитель.
+     * @param value new search value/ новое значение поиска
+     * @returns this instance/ данный экземпляр
+     */
+    setValue(value?: string): this;
+    /**
+     * Sets new search options and updates the matcher.
+     *
+     * Устанавливает новые опции поиска и обновляет сопоставитель.
+     * @param options new options/ новые опции
+     * @returns this instance/ данный экземпляр
+     */
+    setOptions(options: SearchOptions): this;
+    /**
+     * Processes the list and returns a formatted list of items based on the current search state.
+     *
+     * Обрабатывает список и возвращает отформатированный список элементов на основе текущего состояния поиска.
+     * @returns formatted list of items/ отформатированный список элементов
+     */
+    to(): SearchFormatList<T, K>;
+    /**
+     * Callback for processing items when a search is active.
+     * Checks for selection and handles "return everything" option.
+     *
+     * Обратный вызов для обработки элементов при активном поиске.
+     * Проверяет выбор и обрабатывает опцию "возвращать всё".
+     * @param item item / элемент
+     * @param value search value / значение поиска
+     * @returns formatted item or undefined / отформатированный элемент или undefined
+     */
+    protected readonly callbackToSelection: (item: SearchCacheItem<T>["item"], value: SearchCacheItem<T>["value"]) => SearchFormatItem<T, K> | undefined;
+    /**
+     * Callback for processing items when no search is active.
+     *
+     * Обратный вызов для обработки элементов, когда поиск не активен.
+     * @param item item / элемент
+     * @returns formatted item / отформатированный элемент
+     */
+    protected readonly callbackToNone: (item: SearchCacheItem<T>["item"]) => SearchFormatItem<T, K>;
+}