@topvisor/ui 1.2.0 → 1.3.1-dev.2

package/src/core/utils/check.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Функции для проверки данных
+ * @packageDocumentation
+ */
+/**
+ * Получить строку с регулярным выражение для домена
+ */
+export declare const getDomainRegexp: () => string;
+/**
+ * Проверка валидности email
+ * @param email
+ * @param rus_allow - если true, русскоязычные адреса тоже будут валидны
+ */
+export declare const isEmail: (email: string, rus_allow?: boolean) => boolean;
+/**
+ * Проверка валидности URL-адреса
+ */
+export declare const validUrl: (url: string, allowIP?: boolean) => boolean;
+/**
+ * Проверка валидности домена
+ */
+export declare const isDomain: (domain: string) => boolean;
+/**
+ * Проверка валидности ip
+ */
+export declare const isIp: (ip: string) => boolean;

package/src/core/utils/clipboard.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Работа с буфером обмена
+ * @packageDocumentation
+ */
+/**
+ * Скопировать текст в буфер омбена
+ */
+export declare function setClipboard(text: string, isInfoShowing?: boolean): Promise<boolean>;
+/**
+ * Скопировать гостевую ссылку в буфер обмена
+ */
+export declare function guestLinkToClipboard(link: string): Promise<void>;

package/src/core/utils/date.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Работа с датами
+ * @packageDocumentation
+ */
+/**
+ * Уровень детализации времени
+ *
+ * - 0: только дата
+ * - 1: дата и часы
+ * - 2: дата и часы с минутами
+ * - 3: дата и часы с минутами и секундами
+ */
+type Time = 0 | 1 | 2 | 3;
+/**
+ * Получить день недели
+ */
+export declare const getDayOfWeek: (y: number, m: number, d: number) => string;
+/**
+ * Преобразовать дату в строку формата Y-m-d H:i:s
+ * @param dateObject - объект Date
+ * @param langFormat - если true, формат даты будет взят из Core.state.dateFormat
+ * @param timeFormat - уровень детализации времени
+ */
+export declare const dateToString: (dateObject: Date, langFormat?: boolean, timeFormat?: Time) => string;
+/**
+ * Получить объект Date из строки
+ * @param date - строка с датой
+ */
+export declare function stringToDate(date: string): Date;
+/**
+ * Генерация даты-строки из миллисекунд (UTC), в формате Y-m-d H:i:s с учётом часового пояса пользователя
+ *
+ * Для настройки часового пояса пользователя используется `Core.state.timezoneOffset`
+ *
+ * @see genDate()
+ */
+export declare const genUserDate: (timestamp?: number, useFormat?: boolean, time?: Time | "auto") => string;
+/**
+ * Генерация даты-строки из миллисекунд (UTC), в формате Y-m-d H:i:s
+ * @param timestamp - дата в мс, если не передана, берется дата на момент вызова функции
+ * @param useFormat - если true, формат даты будет взят из Core.state.dateFormat
+ * @param time - уровень детализации времени
+ * - auto: часы и минуты будут выводиться, только если они не равны нулю
+ * @param timezoneOffset - смещение часового пояса от UTC в минутах.
+ * Если не указано используется локальный часовой пояс пользователя
+ */
+export declare function genDate(timestamp?: number, useFormat?: boolean, time?: Time | 'auto', timezoneOffset?: number): string;
+/**
+ * Генерация даты-строки (время московское) из миллисекунд (UTC), в формате Y-m-d H:i:s
+ * @param ms - дата в мс, если не передана, берется дата на момент вызова функции
+ * @param langFormat - если true, формат даты будет взят из Core.state.dateFormat
+ */
+export declare function genDateMoscow(ms: number | undefined, useFormat?: boolean): string;
+/**
+ * Перевод даты в формат пользователя
+ * @param dateMixed - объект даты или строка в формате Y-m-d H:i:s
+ * @param time - уровень детализации времени
+ * @param dateFormat - формат даты, если не указан, будет взят из Core.state.dateFormat
+ * @param emptyValue - значение, которое надо вернуть, если дата не указана
+ *
+ * @todo Привести к единой логике обработку строк и дат
+ */
+export declare function dateFormat(dateMixed: string | Date, time?: Time, dateFormat?: string, emptyValue?: string): string;
+/**
+ * Перевод даты из формата пользователя в системный формат Y-m-d H:i:s
+ * @param date - строка с датой
+ * @param emptyValue - значение, которое надо вернуть, если дата не указана
+ */
+export declare function dateUnformat(date: string, emptyValue?: string): string;
+export {};

package/src/core/utils/device.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Получение информации об устройстве
+ * @packageDocumentation
+ */
+/**
+ * Определить, увеличинная ли плотность пикселей у экрана (DPR > 1)
+ */
+export declare function isRetina(): boolean;
+/**
+ * Определить, является ли устройство мобильным
+ */
+export declare function isMobile(): boolean;
+/**
+ * Определить, открыт ли сайт в приложении
+ */
+export declare function isApp(): boolean;
+/**
+ * Определить, является ли OS пользователя macOS
+ */
+export declare function isMacOS(): boolean;
+/**
+ * Определить, является ли текущий браузер пользователя Safari
+ */
+export declare function isSafari(): boolean;
+/**
+ * Вернуть текст для обозначения клавиши Ctrl / Command в зависимости от OS
+ */
+export declare function getCommandKeyLabel(): 'Ctrl' | '⌘';
+/**
+ * Вернуть скролл с учетом устройства
+ */
+export declare const getScrollTop: () => number | undefined;
+/**
+ * Вернуть контейнеры со скроллом (требует jquery)
+ */
+export declare const get$scroll: () => JQuery<Document>;
+/**
+ * Вернуть контейнеры со скроллом (без jquery)
+ */
+export declare const getElsScroll: () => Document[];
+/**
+ * Получить операционную систему пользователя
+ *
+ * Не определяет Windows 11, см. getOSAsync()
+ */
+export declare const getOS: () => string;
+/**
+ * Получить операционную систему пользователя, в том числе Windows 11
+ */
+export declare const getOSAsync: () => Promise<string>;

package/src/core/utils/dom.d.ts

@@ -0,0 +1,104 @@
+/**
+ * Работа с Document Object Model (DOM)
+ * @packageDocumentation
+ */
+/**
+ * Создать элемент
+ * @param tagName
+ * @param attrs - атрибуты
+ * @param elsChildrens
+ * @returns - созданный элемент
+ */
+export declare function genEl(tagName: string, attrs?: Record<string, string>, ...elsChildrens: HTMLElement[] | string[]): HTMLElement;
+/**
+ * Проверить видимость элемента
+ * @param el
+ * @returns - вернет true, если элемент считается видимым
+ */
+export declare function isVisible(el?: HTMLElement): boolean;
+/**
+ * Получить координаты элемента относительно документа
+ * @param el
+ * @returns - координаты элемента относительно документа
+ */
+export declare function offset(el: HTMLElement): {
+    top: number;
+    left: number;
+};
+/**
+ * Получить значение css свойства элемента
+ *
+ * @param el
+ * @param property - имя свойства
+ * @return - значение css стиля
+ */
+export declare function css(el: HTMLElement, property: string): string;
+/**
+ * Получить значение css свойства целочисленного типа
+ *
+ * @param el
+ * @param property - имя свойства
+ * @return - значение css стиля
+ */
+export declare function cssNumber(el: HTMLElement, property: string): number;
+/**
+ * Обернуть элемент и вернуть только что созданный элемент
+ * @param el - элемент, который требуется обернуть
+ * @param tagName - имя тега элемента, в который треубется обернуть элемент
+ */
+export declare function wrap(el: HTMLElement, tagName: string): HTMLElement;
+/**
+ * Найти и вернуть первый видимый элемент
+ * @param el - корневой элемент поиска
+ * @param selectors - см. параметр selectors в Document.querySelectorAll()
+ */
+export declare function querySelectorVisible(el: HTMLElement, selectors: string): HTMLElement | null;
+/**
+ * Найти и вернуть последний видимый элемент
+ * @param el - корневой элемент поиска
+ * @param selectors - см. параметр selectors в Document.querySelectorAll()
+ */
+export declare function querySelectorVisibleLast(el: HTMLElement, selectors: string): HTMLElement | null;
+/**
+ * Найти видимые элементы
+ * @param el - корневой элемент поиска
+ * @param selectors - см. параметр selectors в Document.querySelectorAll()
+ */
+export declare function querySelectorAllVisible(el: HTMLElement | Document, selectors: string): HTMLElement[];
+/**
+ * Найти элементы и вернуть в виде массива
+ * @param el - корневой элемент поиска
+ * @param selectors - см. параметр selectors в Document.querySelectorAll()
+ */
+export declare function querySelectorAllArray<El extends HTMLElement = HTMLElement>(el: HTMLElement | Document, selectors: string): El[];
+/**
+ * Хранилище данных элемента
+ * @param el
+ * @param contextName - контекст, обычно используется имя компонента
+ * @param contextData - установить объект с данными, предыдущие данные будут заменены, установите null для удаления данных
+ * @returns - вернет объект контекста или undefined, если данные контекста не найдены
+ */
+export declare function storage(el?: HTMLElement & {
+    topData?: any;
+}, contextName?: string, contextData?: object | null | undefined): any | undefined;
+/**
+ * Очистить хранилище элемента
+ */
+export declare function storageClear(el?: HTMLElement & {
+    topData?: any;
+}): void;
+declare const _default: {
+    genEl: typeof genEl;
+    isVisible: typeof isVisible;
+    offset: typeof offset;
+    css: typeof css;
+    cssNumber: typeof cssNumber;
+    wrap: typeof wrap;
+    querySelectorVisible: typeof querySelectorVisible;
+    querySelectorVisibleLast: typeof querySelectorVisibleLast;
+    querySelectorAllVisible: typeof querySelectorAllVisible;
+    querySelectorAllArray: typeof querySelectorAllArray;
+    storage: typeof storage;
+    storageClear: typeof storageClear;
+};
+export default _default;

package/src/core/utils/image.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Работа с изображениями
+ * @packageDocumentation
+ */
+/**
+ * Скачать изображение, переданное в виде строки
+ * @param imageStr - адресс картинки
+ * @param imageName - имя файла при загрузке, по умолчанию download
+ */
+export declare const downloadImageFromString: (imageStr: string, imageName?: string) => void;
+/**
+ * Сгенерировать html картинку с фавиконкой сайта
+ * @param url - адрес сайта
+ * @param isBig - если true, картинка будет 120px, иначе 32px
+ */
+export declare const genFaviconImgHtml: (url: string, isBig: boolean) => string;

package/src/core/utils/keyboard.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Утилиты для работы с устройствами ввода
+ * @packageDocumentation
+ */
+/**
+ * Перевод строки в другую раскладку
+ */
+export declare const invertKeyboardLayout: (string: string) => string;

package/src/core/utils/lodash.d.ts

@@ -0,0 +1,6 @@
+import { default as debounce } from 'lodash-es/debounce.js';
+import { default as cloneDeep } from 'lodash-es/cloneDeep.js';
+import { default as memoize } from 'lodash-es/memoize.js';
+import { default as throttle } from 'lodash-es/throttle.js';
+import { default as merge } from 'lodash-es/merge.js';
+export { debounce, cloneDeep, memoize, throttle, merge, };

package/src/core/utils/number.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Работа с числами
+ * @packageDocumentation
+ */
+/**
+ * Посчитать процент от числа (сколько процентов составляет part от full)
+ * @param part - первое число
+ * @param full - второе число
+ * @param precision - точность (колличество знаков после запятой)
+ */
+export declare const percentOfNumber: (part: "--" | number, full?: number, precision?: number) => "--" | number;
+/**
+ * Генерация псевдорандомного числа
+ *
+ * Детерменированная функция по параметру seed
+ */
+export declare const randomBySeed: (seed: number) => number;

package/src/core/utils/price.d.ts

@@ -0,0 +1,10 @@
+import { Lang } from '../plugins/i18n';
+import { default as Core } from '../core/core';
+/**
+ * Сгенерировать строку с суммой и валютой
+ * @param sum - сумма
+ * @param lang - язык, берётся из профиля, если не задано
+ * @param currency - валюта, берётся из профиля, если не задано
+ * @returns строка с языкозависимым представлением числа sum и знаком валюты
+ */
+export declare const genPrice: (sum: number, lang?: Lang, currency?: typeof Core.state.currency) => string;

package/src/core/utils/route.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Управление навигацией страницы, работа с hash параметрами страницы
+ * @packageDocumentation
+ */
+/**
+ * Получить значение хэш параметра страницы
+ */
+export declare const getHash: (name: string, locationHash?: string) => string;
+/**
+ * Установить значение в хэш параметр страницы
+ */
+export declare const setHash: (name: string, value: string | number | null, replaceState?: boolean) => void;
+/**
+ * Удалить значение из хэш параметра страницы
+ */
+export declare const delHash: (name: string, value: string, replaceState?: boolean) => void;
+/**
+ * Сгенерировать новое значение для хэш параметра страницы с указанным параметром
+ */
+export declare const genHash: (name: string, value: string | number | null, locationHash?: string) => string;
+/**
+ * Установить значения в хэш параметр страницы
+ */
+export declare const setHashs: (data: Map<string, string> | object | any, replaceState: boolean) => void;
+/**
+ * Установть позицию в истории вкладки браузера
+ *
+ * @see history.replaceState
+ * @see history.pushState
+ *
+ * @todo Объединить с historyPushState() из @/component/vue/app/spa
+ */
+export declare const historySetState: (replace: boolean | undefined, hash: string) => void;

package/src/core/utils/scroll.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Информация о скролле, фичи для скролла
+ * @packageDocumentation
+ */
+/**
+ * Добавить классы модификаторов тени в зависимости от скролла элемента
+ *
+ * @todo Сделать приватной
+ */
+export declare const genHasScroll: (el: HTMLElement) => void;
+/**
+ * Добавить отображение тени при появлении скролла у элемента
+ *
+ * Будут добавлены события для усатновки модификаторов тени в зависимости от скролла элемента
+ *
+ * Модификаторы:
+ * - top-scrollShadow
+ * - top-scrollShadow-started
+ * - top-scrollShadow-finished
+ */
+export declare const connectScrollShadow: (els: HTMLElement | HTMLElement[]) => void;
+export declare const unconnectScrollShadow: (el: HTMLElement) => void;
+/**
+ * Посчитать глубину скролла (процент на сколько проскроллена страница)
+ *
+ * @deprecated
+ */
+export declare const amountScrolled: () => number;
+/**
+ * Получить прогресс скролла в процентах
+ */
+export declare const getScrollPercent: (el?: HTMLElement) => number;

package/src/core/utils/searchers.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Вспомогательный класс для работы с разными Поисковиками
+ */
+export declare const searchersNames: {
+    0: string;
+    20: string;
+    21: string;
+    1: string;
+    4: string;
+    5: string;
+    7: string;
+    8: string;
+    9: string;
+    101: string;
+    102: string;
+    103: string;
+};
+/**
+ * Получить иконку ПС
+ * @param searcherKey - цифра или строка с цифрой обозначающая ПС. Если null вернется иконка с глобусом
+ */
+export declare const getSearcherGIcon: (searcherKey: number | string | undefined) => string;
+/**
+ * Получить иконку устройства (ПК, планшет, смартфон)
+ */
+export declare const getDeviceGIcon: (device: number | string) => string;
+/**
+ * Получить иконку языка
+ */
+export declare const getLangLabel: (searcherKey: number | string, lang: string) => string;
+/**
+ * Сгенерировать заголовок типа частоты
+ */
+export declare const genVolumeLabel: (label: string, searcherKey: 0 | 1, volumeType: 1 | 2 | 3 | 5 | 6) => string;
+/**
+ * Проверить значение частоты, вернуть правильное значение частоты
+ */
+export declare const prepareVolumeType: (searcherKey: number, volumeType: number) => number;

package/src/core/utils/store/localStorage.d.ts

@@ -0,0 +1,6 @@
+import { Store } from './store';
+declare const _default: {
+    loadLocalStorge: <T extends Store>(stateName: keyof T, store: T) => void;
+    addSaverLocalStorge: <T extends Store>(stateName: keyof T, store: T) => void;
+};
+export default _default;

package/src/core/utils/store/plugin.d.ts

@@ -0,0 +1,24 @@
+import { Store } from './store';
+import { App } from 'vue';
+type Options = {
+    onInit: (context: Context) => void;
+};
+type Context = {
+    store: Store;
+    options: object;
+};
+/**
+ * Плагин tpa (Third-party access) для pinia
+ *
+ * Сейчас не используется
+ *
+ * TODO: Должен реализовывать возмоэности piniaTPAPlugin
+ */
+declare const _default: {
+    install: (app: App<any>, options: Options) => void;
+};
+export default _default;
+/**
+ * Применить плагины к store
+ */
+export declare const usePlugins: (store: Store, options?: object) => void;

package/src/core/utils/store/store.d.ts

@@ -0,0 +1,34 @@
+import { InjectionKey, UnwrapNestedRefs } from 'vue';
+/**
+ * Определить Store
+ *
+ * Следует определять на уровне корневого компонента, использующего Store
+ * @param injectionKey - InjectionKey для provide / inject в области компонента
+ * @param setup - Нстройки Store, см. https://pinia.vuejs.org/core-concepts/#Setup-Stores
+ * @param $id - строковой id Store, используется в плагинах
+ * @param options - настройки Store, используются в плагинах
+ */
+export declare const defineStore: <T extends object>(injectionKey: InjectionKey<UnwrapNestedRefs<T>>, setup: () => T | object, $id?: string, options?: object) => UnwrapNestedRefs<T> & Store;
+/**
+ * Получить State компонента
+ * @param injectionKey - InjectionKey для provide / inject в области компонента
+ * @return - State компонента
+ */
+export declare const useStore: <T>(injectionKey: InjectionKey<T>) => T & Store;
+/**
+ * Легковесный аналог объекта Store Pinia для совместимости с плагинами Pinia
+ */
+export interface Store {
+    /**
+     * Строковой идентификатор Store
+     *
+     * Не уникален в рамках приложения
+     */
+    $id?: string;
+    $subscribe?: Function;
+}
+declare const _default: {
+    defineStore: <T extends object>(injectionKey: InjectionKey<UnwrapNestedRefs<T>>, setup: () => T | object, $id?: string, options?: object) => UnwrapNestedRefs<T> & Store;
+    useStore: <T>(injectionKey: InjectionKey<T>) => T & Store;
+};
+export default _default;

package/src/core/utils/store.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Локальное храналище компонента, альтернатива глобальному Pinia
+ * @packageDocumentation
+ */
+export { defineStore, useStore } from './store/store';
+export { default as plugin, type Store } from './store/store';

package/src/core/utils/string.d.ts

@@ -0,0 +1,100 @@
+/**
+ * Работа со строками
+ * @packageDocumentation
+ */
+export declare const REGEXP_START_SYMBOL_ICON: RegExp;
+/**
+ * Извлекает иконку и оставшийся контент из строки
+ *
+ * Возвращает объект со свойствами:
+ * - `icon`: содержит символ иконки, если он присутствует, иначе `null`
+ * - `content`: содержит оставшийся текст без символа иконки, если он был извлечен, или всю строку
+ */
+export declare const extractIconAndContent: (content: string) => {
+    icon: string | null;
+    content: string;
+};
+/**
+ * Сгенерировать числовой хэш от строки для идентификатора
+ */
+export declare const genIntHash: (string: string) => number;
+/**
+ * Проверить что переданная строка является URL
+ */
+export declare const isUrl: (url: string) => boolean;
+/**
+ * Добавляет пробелы между разрядами если требуется
+ * @param nStr строка с числом
+ */
+export declare const addCommasWhite: (n: number | string) => string;
+/**
+ * Вставляет HTML-код разрыва строки перед каждым переводом строки
+ */
+export declare const nl2br: (str: string) => string;
+/**
+ * Перевести число без деситичной приставки в число с деситичной приставкой степеней тысячи (с параметрами по умолчанию 1255 -> '1.26 K')
+ * @param number
+ * @param precision - точность, количество знаков после запятой
+ * @param dimension - размерность, по умолчанию 1000
+ * @param suffix - суффикс к десятичной приставке (по умолчанию выводится латинская заглавная буква)
+ */
+export declare const numberWithWord: (number: number | string, precision?: number, dimension?: number, suffix?: string) => string;
+/**
+ * Обрезать текст под три точки
+ * @param string
+ * @param max_length - максимальное количество символов текста, остальное обрежеться
+ * @param pos - область обрезки 0-начало | 1-середина | 2-конец строки
+ */
+export declare const ellipsis: (string: string, max_length: number, pos?: 0 | 1 | 2) => string;
+/**
+ * Сгенерировать строку текста для вывода количества в разном склонении
+ * @param num
+ * @param ending0 - родительный падеж, множ. число (10 модулей)
+ * @param ending1 - именительный падеж, ед. число (1 модуль)
+ * @param ending2 - винительный падеж, множ. число (3 модуля)
+ */
+export declare const numberEnding: (num: number, ending0: string, ending1: string, ending2: string) => string;
+/**
+ * Перевести строку в родительный падеж
+ */
+export declare const toRoditPadej: (str: string) => string;
+/**
+ * Транслитерация текста
+ */
+export declare const rusToLatin: (str: string) => string;
+/**
+ * Замена html-символов (`&`, `<`, `>`, `"`, `'`) на имена литер (`&` -> `&amp;`)
+ */
+export declare const htmlspecialchars: (str: string) => string;
+/**
+ * Выделить нужное в тексте желтым цветом
+ * поиск происходит по строке fieldFilter.values[0]
+ */
+export declare const highlightHtml: (text: string, fieldFilter: {
+    operator: "CONTAINS" | "REGEXP";
+    values: string[];
+}) => string;
+/**
+ * Пример: logHTTPCodesHundreds => log_http_codes_hundreds
+ */
+export declare const camelToSnakeCase: (str: string) => string | undefined;
+/**
+ * Получить url изображения флага, по коду страны по стандарту ISO 3166-1 alpha-2
+ *
+ * @todo Опубликовать в CDN или брать c публичного CDN
+ */
+export declare const genFlagLinkByCountryCode: (countryCode: string) => string;
+/**
+ * Обернуть все ссылки и email в тексте в html-тег `<a>`.
+ *
+ * Для email ставиться префикс `mailto:`
+ */
+export declare const addLinkTags: (text: string) => string;
+/**
+ * Перевести первую букву строки в верхний регистр
+ */
+export declare const toCapitalize: (str: string) => string;
+/**
+ * Получить случайную строку
+ */
+export declare const getRandomHash: (length?: number) => string;

package/src/core/utils/system.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Системные утилиты
+ * @packageDocumentation
+ */
+/**
+ * Ждать, пока условие истинно
+ *
+ * @param condition - функция, вычисляющая значение
+ * @param period - период в мс между выполнениями condition()
+ * @param timeout - максмальное время ожидания в мс
+ */
+export declare const waitWhile: (condition: Function, period?: number, timeout?: number) => Promise<void> | undefined;
+/**
+ * Приостановить выполнение кода
+ *
+ * @param delay - длительность паузы в мс
+ */
+export declare const sleep: (delay: number) => Promise<void>;
+/**
+ * Приостановить выполнение кода пока условие истинно
+ * @param condition - функция, вычисляющая значение
+ * @param delay - время задержки в мс
+ * @param period - период в мс между выполнениями condition()
+ */
+export declare const sleepWhile: (condition: Function, delay?: number, period?: number) => Promise<void> | undefined;