@dxtmisha/functional-basic 0.1.0

package/dist/classes/MetaOg.d.ts

@@ -0,0 +1,101 @@
+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.
+     */
+    getTitle(): string;
+    /**
+     * Gets the Open Graph type.
+     *
+     * Получает тип Open Graph.
+     */
+    getType(): MetaOpenGraphType;
+    /**
+     * Gets the Open Graph URL.
+     *
+     * Получает URL Open Graph.
+     */
+    getUrl(): string;
+    /**
+     * Gets the Open Graph image URL.
+     *
+     * Получает URL изображения Open Graph.
+     */
+    getImage(): string;
+    /**
+     * Gets the Open Graph description.
+     *
+     * Получает описание Open Graph.
+     */
+    getDescription(): string;
+    /**
+     * Gets the Open Graph locale.
+     *
+     * Получает локаль Open Graph.
+     */
+    getLocale(): string;
+    /**
+     * Gets the Open Graph site name.
+     *
+     * Получает название сайта Open Graph.
+     */
+    getSiteName(): string;
+    /**
+     * Sets the Open Graph title.
+     *
+     * Устанавливает заголовок Open Graph.
+     * @param title title / заголовок
+     */
+    setTitle(title: string): this;
+    /**
+     * Sets the Open Graph type.
+     *
+     * Устанавливает тип Open Graph.
+     * @param type type / тип
+     */
+    setType(type: MetaOpenGraphType): this;
+    /**
+     * Sets the Open Graph URL.
+     *
+     * Устанавливает URL Open Graph.
+     * @param url URL / URL
+     */
+    setUrl(url: string): this;
+    /**
+     * Sets the Open Graph image URL.
+     *
+     * Устанавливает URL изображения Open Graph.
+     * @param url image URL / URL изображения
+     */
+    setImage(url: string): this;
+    /**
+     * Sets the Open Graph description.
+     *
+     * Устанавливает описание Open Graph.
+     * @param description description / описание
+     */
+    setDescription(description: string): this;
+    /**
+     * Sets the Open Graph locale.
+     *
+     * Устанавливает локаль Open Graph.
+     * @param locale locale (e.g. 'en_US', 'ru_RU') / локаль (например, 'en_US', 'ru_RU')
+     */
+    setLocale(locale: string): this;
+    /**
+     * Sets the Open Graph site name.
+     *
+     * Устанавливает название сайта Open Graph.
+     * @param siteName site name / название сайта
+     */
+    setSiteName(siteName: string): this;
+}

package/dist/classes/MetaTwitter.d.ts

@@ -0,0 +1,101 @@
+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.
+     */
+    getCard(): MetaTwitterCard;
+    /**
+     * Gets the website or brand @username.
+     *
+     * Получает аккаунт сайта или бренда (@username).
+     */
+    getSite(): string;
+    /**
+     * Gets the content creator @username.
+     *
+     * Получает автора контента (@username).
+     */
+    getCreator(): string;
+    /**
+     * Gets the page URL.
+     *
+     * Получает URL страницы.
+     */
+    getUrl(): string;
+    /**
+     * Gets the card title.
+     *
+     * Получает заголовок карточки.
+     */
+    getTitle(): string;
+    /**
+     * Gets the card description.
+     *
+     * Получает описание карточки.
+     */
+    getDescription(): string;
+    /**
+     * Gets the card image URL.
+     *
+     * Получает URL изображения карточки.
+     */
+    getImage(): string;
+    /**
+     * Sets the Twitter Card type.
+     *
+     * Устанавливает тип Twitter Card.
+     * @param card card type / тип карточки
+     */
+    setCard(card: MetaTwitterCard): this;
+    /**
+     * Sets the website or brand @username.
+     *
+     * Устанавливает аккаунт сайта или бренда (@username).
+     * @param site @username / аккаунт
+     */
+    setSite(site: string): this;
+    /**
+     * Sets the content creator @username.
+     *
+     * Устанавливает автора контента (@username).
+     * @param creator @username / аккаунт автора
+     */
+    setCreator(creator: string): this;
+    /**
+     * Sets the page URL.
+     *
+     * Устанавливает URL страницы.
+     * @param url URL / URL
+     */
+    setUrl(url: string): this;
+    /**
+     * Sets the card title.
+     *
+     * Устанавливает заголовок карточки.
+     * @param title title / заголовок
+     */
+    setTitle(title: string): this;
+    /**
+     * Sets the card description.
+     *
+     * Устанавливает описание карточки.
+     * @param description description / описание
+     */
+    setDescription(description: string): this;
+    /**
+     * Sets the card image URL.
+     *
+     * Устанавливает URL изображения карточки.
+     * @param image image URL / URL изображения
+     */
+    setImage(image: string): this;
+}

package/dist/classes/ScrollbarWidth.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Class for getting the scroll width.
+ *
+ * Класс для получения ширины скролла.
+ */
+export declare class ScrollbarWidth {
+    private static storage;
+    private static calculate;
+    /**
+     * Checks whether to enable scroll hiding.
+     *
+     * Проверяет, надо ли включить скрытие скролла.
+     */
+    static is(): Promise<boolean>;
+    /**
+     * Returns the width of the scroll.
+     *
+     * Возвращает ширину скролла.
+     */
+    static get(): Promise<number>;
+    /**
+     * Creates elements to check the width of the scroll.
+     *
+     * Создает элементы для проверки ширины скролла.
+     */
+    private static createElement;
+    /**
+     * Initialization of data to check the width of the scroll.
+     *
+     * Инициализация данных для проверки ширины скролла.
+     */
+    private static init;
+}

package/dist/classes/Translate.d.ts

@@ -0,0 +1,116 @@
+export type TranslateCode = string | string[];
+export type TranslateList<T extends TranslateCode[]> = {
+    [K in T[number] as K extends readonly string[] ? K[0] : K]: string;
+};
+export type TranslateItemOrList<T extends TranslateCode> = T extends string[] ? TranslateList<T> : string;
+/**
+ * Class for getting the translated text.
+ *
+ * Класс для получения переведенного текста.
+ */
+export declare class Translate {
+    protected static url: string;
+    protected static propsName: string;
+    protected static readonly data: Record<string, string>;
+    protected static cache: string[];
+    protected static resolveList: (() => void)[];
+    protected static timeout?: any;
+    /**
+     * Getting the translation text by its code.
+     *
+     * Получение текста перевода по его коду.
+     * @param name code name/ название кода
+     * @param replacement If set, replaces the text with the specified values/ если установлено, заменяет текст на указанные значения
+     */
+    static get(name: string, replacement?: string[] | Record<string, string | number>): Promise<string>;
+    /**
+     * Getting the translation text by its code (Sync).
+     *
+     * Получение текста перевода по его коду (Sync).
+     * @param name code name/ название кода
+     * @param first If set to false, returns an empty string if there is no text/
+     * если установлено false, возвращает пустую строку, если нет текста
+     * @param replacement If set, replaces the text with the specified values/
+     * если установлено, заменяет текст на указанные значения
+     */
+    static getSync(name: string, first?: boolean, replacement?: string[] | Record<string, string | number>): string;
+    /**
+     * Getting a list of translations by an array of text codes.
+     *
+     * Получение списка переводов по массиву кодов текста.
+     * @param names list of codes to get translations/ список кодов для получения переводов
+     */
+    static getList<T extends TranslateCode[]>(names: T): Promise<TranslateList<T>>;
+    /**
+     * Getting a list of translations by an array of text codes.
+     *
+     * Получение списка переводов по массиву кодов текста.
+     * @param names list of codes to get translations/ список кодов для получения переводов
+     * @param first If set to false, returns an empty string if there is no text/
+     * если установлено false, возвращает пустую строку, если нет текста
+     */
+    static getListSync<T extends TranslateCode[]>(names: T, first?: boolean): TranslateList<T>;
+    /**
+     * Added a list of translated texts.
+     *
+     * Добавлен список переведенных текстов.
+     * @param names list of codes to get translations/ список кодов для получения переводов
+     */
+    static add(names: string | string[]): Promise<void>;
+    /**
+     * Adds texts in sync mode.
+     *
+     * Добавляет тексты в режиме синхронизации.
+     * @param data list of texts in the form of key-value/ список текстов в виде ключ-значение
+     */
+    static addSync(data: Record<string, string>): void;
+    /**
+     * Adding data in the form of a query or directly, depending on the execution environment.
+     *
+     * Добавление данных в виде запроса или напрямую, в зависимости от среды выполнения.
+     * @param data list of texts in the form of key-value/ список текстов в виде ключ-значение
+     */
+    static addNormalOrSync(data: Record<string, string>): Promise<void>;
+    /**
+     * Change the path to the script for obtaining the translation.
+     *
+     * Изменить путь к скрипту для получения перевода.
+     * @param url path to the script/ путь к скрипту
+     */
+    static setUrl(url: string): Translate;
+    static setPropsName(name: string): Translate;
+    /**
+     * Getting the full title for translation.
+     *
+     * Получение полного названия для перевода.
+     * @param name code name/ название кода
+     */
+    protected static getName(name: string): string;
+    /**
+     * Returns a list of names that are not yet in the list.
+     *
+     * Возвращает список имен, которых еще нет в списке.
+     * @param names list of codes to get translations/ список кодов для получения переводов
+     */
+    protected static getNamesNone(names: string | string[]): string[];
+    /**
+     * Getting the list of translations from the server.
+     *
+     * Получение списка переводов с сервера.
+     */
+    protected static getResponse(): Promise<Record<string, string>>;
+    /**
+     * Replaces the text with the specified values.
+     *
+     * Заменяет текст на указанные значения.
+     * @param text text to replace/ текст для замены
+     * @param replacement values for replacement/ значения для замены
+     */
+    protected static replacement(text: string, replacement?: string[] | Record<string, string | number>): any;
+    /**
+     * Adding translation data from the server.
+     *
+     * Добавление данных по переводу с сервера.
+     */
+    protected static make(): Promise<void>;
+}

package/dist/classes/__tests__/Api.test.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @vitest-environment jsdom
+ */
+export {};

package/dist/classes/__tests__/ApiDefault.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/classes/__tests__/ApiHeaders.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/classes/__tests__/ApiPreparation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/classes/__tests__/ApiResponse.test.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @vitest-environment jsdom
+ */
+export {};

package/dist/classes/__tests__/ApiStatus.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/classes/__tests__/Meta.test.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @vitest-environment jsdom
+ */
+export {};

package/dist/classes/__tests__/MetaManager.test.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @vitest-environment jsdom
+ */
+export {};

package/dist/classes/__tests__/MetaOg.test.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @vitest-environment jsdom
+ */
+export {};

package/dist/classes/__tests__/MetaTwitter.test.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @vitest-environment jsdom
+ */
+export {};

package/dist/functions/anyToString.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Conversion of a value to a string.
+ *
+ * Преобразование значения в строку.
+ * @param value values for conversion/ значения для преобразования
+ */
+export declare function anyToString<V>(value: V): string;

package/dist/functions/applyTemplate.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Applies a template to the text, replacing keys with values from the replacement object
+ *
+ * Применяет шаблон к тексту, заменяя ключи на значения из объекта замены
+ * @param text text with a template containing keys in square brackets, for example "[key]"/
+ * текст с шаблоном, содержащим ключи в квадратных скобках, например "[key]"
+ * @param replacement an object containing key-value pairs for replacement/
+ * объект, содержащий пары ключ-значение для замены
+ */
+export declare const applyTemplate: (text: string, replacement?: Record<string, string | number> | string[]) => string;

package/dist/functions/arrFill.d.ts

@@ -0,0 +1,8 @@
+/**
+ * The method creates an array of "count" elements with values equal to `value`.
+ *
+ * Метод создает массив из "count" элементов со значениями равными `value`.
+ * @param value value to fill the array with/ значение, заполняющее массив
+ * @param count the number of elements in that array/ число элементов этого массива
+ */
+export declare function arrFill<T>(value: T, count: number): T[];

package/dist/functions/copyObject.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Создает копию простого объекта.
+ *
+ * Creates a copy of a simple object.
+ * @param value объект для копирования/ object for copying
+ * @returns возвращает новую копию объекта/ returns a new copy of the object
+ */
+export declare function copyObject<T>(value: T): T;

package/dist/functions/createElement.d.ts

@@ -0,0 +1,13 @@
+/**
+ * In HTML documents, creates an element with the tag that is specified in the argument.
+ *
+ * В HTML-документах создаёт элемент с тегом, который указан в аргументе.
+ * @param parentElement the DOM node's parent Element/ родитель для нового элемента
+ * @param tagName A string that specifies the type of element to be created/ строка,
+ * указывающая элемент какого типа должен быть создан
+ * @param options an object with attributes or a function for processing an element/ объект
+ * с атрибутами или функция для обработки элемента
+ * @param referenceElement the node before which newNode is inserted/ элемент,
+ * перед которым будет вставлен newElement
+ */
+export declare function createElement<T extends HTMLElement>(parentElement?: HTMLElement, tagName?: string, options?: Partial<T> | Record<keyof T, T[keyof T]> | ((element: T) => void), referenceElement?: HTMLElement): T | undefined;

package/dist/functions/domQuerySelector.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Selects the first element that matches the specified selectors.
+ *
+ * Выбирает первый элемент, который соответствует указанным селекторам.
+ * @param selectors selectors/ селекторы
+ */
+export declare function domQuerySelector<E extends Element = Element>(selectors: string): E | undefined;

package/dist/functions/domQuerySelectorAll.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Selects all elements that match the specified selectors.
+ *
+ * Выбирает все элементы, которые соответствуют указанным селекторам.
+ * @param selectors selectors/ селекторы
+ */
+export declare function domQuerySelectorAll<E extends Element = Element>(selectors: string): NodeListOf<E> | undefined;

package/dist/functions/encodeAttribute.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Encodes special characters in a string for safe use in HTML attributes.
+ *
+ * Кодирует специальные символы в строке для безопасного использования в HTML-атрибутах.
+ * @param text text to encode / текст для кодирования
+ */
+export declare function encodeAttribute(text: string): string;

package/dist/functions/eventStopPropagation.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Stop listening to events in depth.
+ *
+ * Остановить прослушивания события в глубину.
+ * @param event event instance/ экземпляр события
+ */
+export declare function eventStopPropagation(event: Event): void;

package/dist/functions/executeFunction.d.ts

@@ -0,0 +1,8 @@
+import { FunctionArgs } from '../types/basicTypes';
+/**
+ * The function is executed and returns its result. Or returns the input data, if it is not a function.
+ *
+ * Выполняется функция и возвращает ее результат. Или возвращает входные данные, если это не функция
+ * @param callback function or any value/ функция или любое значение
+ */
+export declare function executeFunction<T>(callback: T | FunctionArgs<any, T>): T;

package/dist/functions/executePromise.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Returns the execution result of an asynchronous function.
+ *
+ * Возвращает выполнение асинхронной функции.
+ * @param callback function or any value/ функция или любое значение
+ */
+export declare function executePromise<T>(callback: (() => Promise<T>) | (() => T) | T): Promise<T>;

package/dist/functions/forEach.d.ts

@@ -0,0 +1,11 @@
+/**
+ * The function performs the specified function once for each element in the object.
+ * And returns an array with the results of executing the function.
+ *
+ * Функция выполняет указанную функцию один раз для каждого элемента в объекте.
+ * И возвращает массив с результатами выполнения функции.
+ * @param data object for iteration/ объект для перебора
+ * @param callback a function to execute for each element in the array/
+ * функция, которая будет вызвана для каждого элемента
+ */
+export declare function forEach<T, R, D extends T[] | Record<string, T> | Map<string, T> = T[] | Record<string, T> | Map<string, T>, K = D extends T[] ? number : string>(data: D & (T[] | Record<string, T> | Map<string, T>), callback: (item: T, key: K, dataMain: typeof data) => R): R[];

package/dist/functions/frame.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Cyclically calls requestAnimationFrame until next returns true
+ * The window.requestAnimationFrame() method tells the browser that you wish to perform
+ * an animation and requests that the browser calls a specified function to update an
+ * animation right before the next repaint.
+ *
+ * Циклически вызывает requestAnimationFrame, пока next возвращает true
+ * window.requestAnimationFrame указывает браузеру на то, что вы хотите произвести
+ * анимацию, и просит его запланировать перерисовку на следующем кадре анимации.
+ * @param callback the function to call when it's time to update your animation for the next repaint/ функция,
+ * которая будет вызвана, когда придёт время обновить вашу анимацию на следующей перерисовке
+ * @param next function that determines repetition/ функция, которая определяет повторность
+ * @param end function that is executed if the animation stops/ функция,
+ * которая выполняется, если останавливается анимация
+ */
+export declare function frame(callback: () => void, next?: () => boolean, end?: () => void): void;

package/dist/functions/getAttributes.d.ts

@@ -0,0 +1,8 @@
+import { ElementOrString, ElementOrWindow } from '../types/basicTypes';
+/**
+ * Gets a list of attributes of an element.
+ *
+ * Получает список атрибутов у элемента.
+ * @param element selectors for matching or an Element/ селекторов для сопоставления или Element
+ */
+export declare function getAttributes<E extends ElementOrWindow>(element?: ElementOrString<E>): Record<string, string | undefined>;

package/dist/functions/getClipboardData.d.ts

@@ -0,0 +1,11 @@
+/**
+ * The method retrieves drag data (as a string) for the specified type.
+ * If the drag operation does not include data, this method returns an empty string.
+ *
+ * Метод извлекает данные перетаскивания (в виде строки) для указанного типа.
+ * @param event the ClipboardEvent interface represents events providing information
+ * related to modification of the clipboard, that is cut, copy, and paste events/ интерфейс
+ * ClipboardEvent представляет события, предоставляющие информацию, связанную с изменением буфера обмена,
+ * этими события являются cut, copy и paste.
+ */
+export declare function getClipboardData(event?: ClipboardEvent): Promise<string>;

package/dist/functions/getColumn.d.ts

@@ -0,0 +1,10 @@
+import { ObjectOrArray } from '../types/basicTypes';
+/**
+ * Returns an array of values for a specific column in the input array.
+ *
+ * Возвращает массив значений для определенного столбца входного массива.
+ * @param array a one array or an array of objects from which to pull a column of values from/
+ * многомерный массив или массив объектов, из которого будет производиться выборка значений
+ * @param column the column of values to return/ ключ столбца, значения которого нужно вернуть
+ */
+export declare function getColumn<T, K extends keyof T>(array: ObjectOrArray<T>, column: K): (T[K] | undefined)[];

package/dist/functions/getElement.d.ts

@@ -0,0 +1,8 @@
+import { ElementOrString, ElementOrWindow } from '../types/basicTypes';
+/**
+ * Returns the first Element in the document that matches the specified selector or the element.
+ *
+ * Возвращает первый Element документа, который соответствует указанному селектору или саму element.
+ * @param element selectors for matching or an Element/ селекторов для сопоставления или Element
+ */
+export declare function getElement<E extends ElementOrWindow, R extends Exclude<E, Window>>(element?: ElementOrString<E>): R | undefined;

package/dist/functions/getElementId.d.ts

@@ -0,0 +1,9 @@
+import { ElementOrString, ElementOrWindow } from '../types/basicTypes';
+/**
+ * Returns the identifier (ID) of the element or creates it if the element has no ID.
+ *
+ * Возвращает идентификатор (ID) элемента или создает его, если у элемента нет ID.
+ * @param element element from which you obtain an ID/ элемент, с которого получаете ID
+ * @param selector selectors for matching/ селекторов для сопоставления
+ */
+export declare function getElementId<E extends ElementOrWindow>(element?: ElementOrString<E>, selector?: string): string;

package/dist/functions/getElementItem.d.ts

@@ -0,0 +1,11 @@
+import { ElementOrString, ElementOrWindow } from '../types/basicTypes';
+/**
+ * Returns the value of an element by its key.
+ *
+ * Возвращает значение элемента по его ключу.
+ * @param element checked element/ проверяемый элемент
+ * @param index index at which we retrieve values/ индекс, по которому получаем значения
+ * @param defaultValue returns this parameter if the value is missing/ возвращает этот параметр,
+ * если значение отсутствует
+ */
+export declare function getElementItem<T extends ElementOrWindow, K extends keyof T, D>(element: ElementOrString<T>, index: K | string, defaultValue?: D): T[K] | D | undefined;

package/dist/functions/getElementOrWindow.d.ts

@@ -0,0 +1,8 @@
+import { ElementOrString, ElementOrWindow } from '../types/basicTypes';
+/**
+ * Returns window or element.
+ *
+ * Возвращает окно или элемент.
+ * @param element selectors for matching or an Element/ селекторов для сопоставления или Element
+ */
+export declare function getElementOrWindow<E extends ElementOrWindow>(element?: ElementOrString<E>): E | undefined;

package/dist/functions/getExp.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The object is used for matching text with a pattern.
+ *
+ * Конструктор создаёт объект регулярного выражения для сопоставления текста с шаблоном.
+ * @param value test for replacement/ тест для замены
+ * @param flags если определён, может принимать любую комбинацию нижеследующих значений:
+ * g - глобальное сопоставление,
+ * i - игнорирование регистра при сопоставлении
+ * m - сопоставление по нескольким строкам.
+ * @param pattern Regular expression text in which the value :value will be replaced with the optimized value of value/
+ * Текст регулярного выражения, в котором значение :value заменится на оптимизированное значение value
+ */
+export declare function getExp(value: string, flags?: string, pattern?: string): RegExp;

package/dist/functions/getItemByPath.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Returns data by their path.
+ *
+ * Возвращает данные по их пути.
+ * @param item object for work/ объект для работы
+ * @param path data path/ путь к данным
+ */
+export declare function getItemByPath<T extends Record<string, any>>(item: T, path: string): string;