@dxtmisha/functional-basic 1.1.0 → 1.1.6

package/dist/classes/Icons.d.ts

@@ -0,0 +1,128 @@
+export type IconsItem = string | Promise<string | any> | (() => Promise<string | any>);
+export type IconsConfig = {
+    /** URL to the icons storage / URL к хранилищу иконок */
+    url?: string;
+    /** List of custom icons / Список пользовательских иконок */
+    list?: Record<string, IconsItem>;
+};
+/**
+ * Class for managing icons.
+ *
+ * Класс для управления иконками.
+ */
+export declare class Icons {
+    protected static icons: Record<string, IconsItem>;
+    protected static url: string;
+    /**
+     * Checks if the given icon is in the list of connected icons.
+     *
+     * Проверяет, есть ли данная иконка в списке подключенных иконок.
+     * @param index icon name/ название иконки
+     */
+    static is(index: string): boolean;
+    /**
+     * Returns the icon by the name.
+     *
+     * Возвращает иконку по названию.
+     * @param index icon name/ название иконки
+     * @param url path to the storage location of the icon, if the icon does not exist/
+     * путь к месту хранения иконки, если иконка не существует
+     * @param wait waiting time for picture loading (ms)/
+     * время ожидания загрузки картинки (мс)
+     * @returns icon path or content/ путь к иконке или контент
+     */
+    static get(index: string, url?: string, wait?: number): Promise<string>;
+    /**
+     * Returns the icon if it is already loaded or is a string.
+     *
+     * Возвращает иконку, если она уже загружена или является строкой.
+     * @param index icon name/ название иконки
+     * @param url path to the storage location of the icon, if the icon does not exist/
+     * путь к месту хранения иконки, если иконка не существует
+     * @returns icon path or content/ путь к иконке или контент
+     */
+    static getAsync(index: string, url?: string): string;
+    /**
+     * Returns a list of names of all registered icons.
+     *
+     * Возвращает список названий всех зарегистрированных иконок.
+     * @returns list of icon names/ список названий иконок
+     */
+    static getNameList(): string[];
+    /**
+     * Returns a global link.
+     *
+     * Возвращает глобальную ссылку.
+     * @returns string global link/ глобальная ссылка
+     */
+    static getUrlGlobal(): string;
+    /**
+     * Adding custom icons.
+     *
+     * Добавление пользовательских иконок.
+     * @param index icon name/ название иконки
+     * @param file path to the file/ путь к файлу
+     */
+    static add(index: string, file: IconsItem): void;
+    /**
+     * Adding custom icons in loading mode.
+     *
+     * Добавление пользовательских иконок в режиме загрузки.
+     * @param index icon name/ название иконки
+     */
+    static addLoad(index: string): void;
+    /**
+     * Adding custom global icons.
+     *
+     * Добавление пользовательских глобальных иконок.
+     * @param index icon name/ название иконки
+     * @param file path to the file/ путь к файлу
+     */
+    static addGlobal(index: string, file: string): void;
+    /**
+     * Adding an icon by the list.
+     *
+     * Добавление иконки по списку.
+     * @param list list of icons/ список иконки
+     */
+    static addByList(list: Record<string, IconsItem>): void;
+    /**
+     * Changes the file path.
+     *
+     * Изменяет путь к файлу.
+     * @param url new file path/ новый путь к файлу
+     */
+    static setUrl(url: string): void;
+    /**
+     * Changes the configuration.
+     *
+     * Изменяет конфигурацию.
+     * @param config new configuration/ новая конфигурация
+     */
+    static setConfig(config: IconsConfig): void;
+    /**
+     * Returns the icon name with the prefix.
+     *
+     * Возвращает название иконки с префиксом.
+     * @param index icon name/ название иконки
+     * @returns icon name with prefix/ название иконки с префиксом
+     */
+    protected static getName(index: string): string;
+    /**
+     * Returns the raw icon data by the name.
+     *
+     * Возвращает исходные данные иконки по названию.
+     * @param index icon name/ название иконки
+     * @param url path to the storage location of the icon, if the icon does not exist/
+     * путь к месту хранения иконки, если иконка не существует
+     * @returns icon path or content/ путь к иконке или контент
+     */
+    protected static getRaw(index: string, url?: string): IconsItem;
+    /**
+     * Script execution delay.
+     *
+     * Задержка выполнения скрипта.
+     * @returns Promise<void> Promise for delay/ Promise для задержки
+     */
+    protected static wait(): Promise<void>;
+}

package/dist/classes/Loading.d.ts

@@ -0,0 +1,66 @@
+import { LoadingInstance, LoadingDetail } from './LoadingInstance';
+import { ElementOrString, EventListenerDetail } from '../types/basicTypes';
+/**
+ * Class for working with global loading.
+ *
+ * Класс для работы с глобальной загрузкой.
+ */
+export declare class Loading {
+    /**
+     * Check if the loader is active now.
+     *
+     * Проверить, активен ли сейчас загрузчик.
+     * @returns boolean/ логическое значение
+     */
+    static is(): boolean;
+    /**
+     * Get current loading value.
+     *
+     * Получить текущее значение загрузки.
+     * @returns current loading value/ текущее значение загрузки
+     */
+    static get(): number;
+    /**
+     * Returns a request-isolated instance of LoadingInstance.
+     *
+     * Возвращает изолированный в рамках запроса экземпляр LoadingInstance.
+     * @returns LoadingInstance instance / экземпляр LoadingInstance
+     */
+    static getItem(): LoadingInstance;
+    /**
+     * Shows the loader.
+     *
+     * Показывает загрузчик.
+     * @returns void
+     */
+    static show(): void;
+    /**
+     * Hides the loader.
+     *
+     * Скрывает загрузчик.
+     * @returns void
+     */
+    static hide(): void;
+    /**
+     * Event registration to listen for data changes.
+     *
+     * Регистрация события для прослушивания изменений данных.
+     * @param listener the object that receives a notification (an object that implements the
+     * Event interface) when an event of the specified type occurs/ объект, который принимает
+     * уведомление, когда событие указанного типа произошло
+     * @param element element/ элемент
+     * @returns void
+     */
+    static registrationEvent(listener: EventListenerDetail<CustomEvent, LoadingDetail>, element?: ElementOrString<HTMLElement>): void;
+    /**
+     * Unregistration of an event.
+     *
+     * Отмена регистрации события.
+     * @param listener the object that receives a notification (an object that implements the
+     * Event interface) when an event of the specified type occurs/ объект, который принимает
+     * уведомление, когда событие указанного типа произошло
+     * @param element element/ элемент
+     * @returns void
+     */
+    static unregistrationEvent(listener: EventListenerDetail<CustomEvent, LoadingDetail>, element?: ElementOrString<HTMLElement>): void;
+}

package/dist/classes/LoadingInstance.d.ts

@@ -0,0 +1,99 @@
+import { EventItem } from './EventItem';
+import { ElementOrString, EventListenerDetail } from '../types/basicTypes';
+/**
+ * Data for the loading event.
+ *
+ * Данные для события загрузки.
+ */
+export type LoadingDetail = {
+    /** Loading status / Статус загрузки */
+    loading: boolean;
+};
+/**
+ * Registration item for the loading event.
+ *
+ * Элемент регистрации для события загрузки.
+ */
+export type LoadingRegistrationItem = {
+    /** Event item / Элемент события */
+    item: EventItem<Window, CustomEvent, LoadingDetail>;
+    /** Event listener / Слушатель события */
+    listener: EventListenerDetail<CustomEvent, LoadingDetail>;
+    /** Element / Элемент */
+    element?: ElementOrString<HTMLElement>;
+};
+/**
+ * Class for working with global loading.
+ *
+ * Класс для работы с глобальной загрузкой.
+ */
+export declare class LoadingInstance {
+    protected eventName: string;
+    /** Current loading value / Текущее значение загрузки */
+    protected value: number;
+    /** Event item / Элемент события */
+    protected event?: EventItem<Window, CustomEvent>;
+    /** Registration list / Список регистрации */
+    protected registrationList: LoadingRegistrationItem[];
+    /**
+     * Constructor
+     * @param eventName name of the event for tracking loading/ название события для отслеживания загрузки
+     */
+    constructor(eventName?: string);
+    /**
+     * Check if the loader is active now.
+     *
+     * Проверить, активен ли сейчас загрузчик.
+     * @returns returns true if the loader is active/ возвращает true, если загрузчик активен
+     */
+    is(): boolean;
+    /**
+     * Get current loading value.
+     *
+     * Получить текущее значение загрузки.
+     * @returns returns the current loading value/ возвращает текущее значение загрузки
+     */
+    get(): number;
+    /**
+     * Shows the loader.
+     *
+     * Показывает загрузчик.
+     * @returns void
+     */
+    show(): void;
+    /**
+     * Hides the loader.
+     *
+     * Скрывает загрузчик.
+     * @returns void
+     */
+    hide(): void;
+    /**
+     * Event registration to listen for data changes.
+     *
+     * Регистрация события для прослушивания изменений данных.
+     * @param listener the object that receives a notification (an object that implements the
+     * Event interface) when an event of the specified type occurs/ объект, который принимает
+     * уведомление, когда событие указанного типа произошло
+     * @param element element/ элемент
+     * @returns void
+     */
+    registrationEvent(listener: EventListenerDetail<CustomEvent, LoadingDetail>, element?: ElementOrString<HTMLElement>): void;
+    /**
+     * Unregistration of an event.
+     *
+     * Отмена регистрации события.
+     * @param listener the object that receives a notification (an object that implements the
+     * Event interface) when an event of the specified type occurs/ объект, который принимает
+     * уведомление, когда событие указанного типа произошло
+     * @param element element/ элемент
+     * @returns void
+     */
+    unregistrationEvent(listener: EventListenerDetail<CustomEvent, LoadingDetail>, element?: ElementOrString<HTMLElement>): void;
+    /**
+     * Calls the event listener.
+     *
+     * Вызывает слушателя событий.
+     */
+    protected dispatch(): void;
+}

package/dist/classes/Meta.d.ts

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

package/dist/classes/MetaManager.d.ts

@@ -0,0 +1,121 @@
+type MetaList<T extends readonly string[]> = {
+    [K in T[number]]?: string;
+};
+/**
+ * Class for working with meta tags.
+ *
+ * Класс для управления мета-тегами.
+ */
+export declare class MetaManager<T extends readonly string[], Key extends keyof MetaList<T> = keyof MetaList<T>> {
+    protected readonly listMeta: T;
+    protected readonly isProperty: boolean;
+    protected readonly items: MetaList<T>;
+    /**
+     * Creates an instance of MetaManager.
+     *
+     * Создает экземпляр MetaManager.
+     * @param listMeta list of meta-tag names to manage / список имен мета-тегов для управления
+     * @param isProperty use 'property' attribute instead of 'name' / использовать атрибут 'property' вместо 'name'
+     */
+    constructor(listMeta: T, isProperty?: boolean);
+    /**
+     * Returns the list of meta tag names.
+     *
+     * Возвращает список имен мета-тегов.
+     * @returns list of meta tag names/ список имен мета-тегов
+     */
+    getListMeta(): T;
+    /**
+     * Get the content of a meta tag by name.
+     *
+     * Получает содержимое мета-тега по имени.
+     * @param name meta tag name / имя мета-тега
+     * @returns meta tag content/ содержимое мета-тега
+     */
+    get(name: Key): string;
+    /**
+     * Returns all meta tags.
+     *
+     * Возвращает все мета-теги.
+     * @returns object with all meta tags/ объект со всеми мета-тегами
+     */
+    getItems(): MetaList<T>;
+    /**
+     * Returns all meta tags as HTML string.
+     *
+     * Возвращает все мета-теги в виде HTML-строки.
+     * @returns HTML string/ HTML-строка
+     */
+    html(): string;
+    /**
+     * Sets the content of a meta tag.
+     *
+     * Устанавливает содержимое мета-тега.
+     * @param name meta tag name / имя мета-тега
+     * @param content meta tag content / содержимое мета-тега
+     */
+    set(name: Key, content: string): this;
+    /**
+     * Sets multiple meta tags from an object.
+     *
+     * Устанавливает несколько мета-тегов из объекта.
+     * @param metaList object with meta tag names and content / объект с именами и содержимым мета-тегов
+     */
+    setByList(metaList: MetaList<T>): this;
+    /**
+     * Returns the attribute name for meta tags.
+     *
+     * Возвращает имя атрибута для мета-тегов.
+     * @returns attribute name / имя атрибута
+     */
+    protected getAttributeName(): string;
+    /**
+     * Finds a meta element in the DOM.
+     *
+     * Находит мета-элемент в DOM.
+     * @param name meta tag name / имя мета-тега
+     * @returns meta element if found, or undefined / мета-элемент, если найден, иначе undefined
+     */
+    protected findMetaElement(name: string): HTMLMetaElement | undefined;
+    /**
+     * Sets the content of a meta tag in internal storage.
+     *
+     * Устанавливает содержимое мета-тега во внутреннем хранилище.
+     * @param name meta tag name / имя мета-тега
+     * @param content meta tag content / содержимое мета-тега
+     * @returns current instance / текущий экземпляр
+     */
+    protected setItem(name: Key, content: string): this;
+    /**
+     * Sets or creates a meta tag in the DOM.
+     *
+     * Устанавливает или создает мета-тег в DOM.
+     * @param name meta tag name / имя мета-тега
+     * @returns current instance / текущий экземпляр
+     */
+    protected setMeta(name: Key): this;
+    /**
+     * Converts meta tag to HTML string.
+     *
+     * Преобразует мета-тег в HTML-строку.
+     * @param name meta tag name / имя мета-тега
+     * @returns HTML string / HTML-строка
+     */
+    protected toHtmlString(name: Key): string;
+    /**
+     * Converts the title to an HTML-safe string.
+     *
+     * Преобразует заголовок в HTML-безопасную строку.
+     * @param title page title / заголовок страницы
+     * @returns encoded title string / закодированная строка заголовка
+     */
+    protected toHtmlTitle(title: string): string;
+    /**
+     * Updates meta tags data from the DOM.
+     *
+     * Обновляет данные мета-тегов из DOM.
+     * @returns current instance / текущий экземпляр
+     */
+    protected update(): this;
+}
+export {};