@topvisor/ui 1.0.42-dev.2 → 1.0.42-policy.0

package/core/core/options.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Конфигурация UI
+ *
+ * Начальные значений устанавливаются при подключении Core во Vue приложение через app.use(PluginCore, options)
+ */
+declare const _default: {
+    /**
+     * Имя темы оформления
+     *
+     * В данный момент не используется для загрузки css
+     *
+     * @todo Реализовать загрузки и замену css темы на стороне UI
+     *
+     * @see https://ui.topvisor.com/?path=/docs/core-theme--docs
+     */
+    themeName: "light" | "dark" | string;
+    /**
+     * CSS-классы модификаторы для документа страницы
+     *
+     * Могут использоваться компонентами для включения необходимых режимов отображения страницы
+     *
+     * Разные компоненты могут добавлять один и тот же класс, чтобы не было конфликтов каждый компонент управляет только своим классом:
+     * - Ключ - уникальное имя компонента, например в setup: `const uid = Math.random();`
+     * - Значение - класс модификатора
+     */
+    documentClassModificators: Map<string | number, string>;
+    /**
+     * Базовая ширина страницы для отображения ПК / Мобильной версии сайта
+     *
+     * @see Core state isMobile
+     */
+    widthForMobile: number;
+    /**
+     * Формат даты, который будет использоваться по умолчанию для вывода даты, как правило, зависит от текущего пользователя
+     */
+    dateFormat: string;
+    /**
+     * Валюта, которая будет использоваться по умолчанию, как правило, зависит от текущего пользователя
+     */
+    currency: "RUB" | "USD" | "EUR";
+    /**
+     * Смещение timezone относительно UTC в минутах
+     * Для Москвы: -180
+     */
+    timezoneOffset: number;
+};
+export default _default;

package/core/core/preloaders.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Набор функцией, реализующих загрузку модулей системы, которые рекомендуется загружать в отложенном режиме
+ *
+ * Функции выполняют загрузку в память полный код модулей и компонентов
+ */
+export default class {
+    /**
+     * Загрузить в память полный функционал TopNotice
+     */
+    static TopNotice(): Promise<void>;
+    /**
+     * Загрузить в память полный функционал TopPopup
+     */
+    static TopPopup(): Promise<void>;
+    /**
+     * Загрузить в память полный функционал TopDialog
+     */
+    static TopDialog(): Promise<void>;
+}

package/core/core/state.d.ts

@@ -0,0 +1,49 @@
+/**
+ * State UI для взаимодейсвтиями с приложениями Vue
+ */
+declare const state: {
+    /**
+     * CSS-классы модификаторы для документа страницы
+     */
+    documentClassModificators: Map<string | number, string>;
+    dateFormat: string;
+    currency: "USD" | "RUB" | "EUR";
+    timezoneOffset: number;
+    /**
+     * Device by size
+     *
+     * @see Core widthForMobile
+     */
+    isMobile: boolean;
+    /**
+     * Device by user agent
+     */
+    isMobileUA: boolean;
+    /**
+     * true, если плотность пикселей экрана больше 1
+     */
+    isRetina: boolean;
+    /**
+     * true, елси это приложение
+     */
+    isApp: boolean;
+    /**
+     * true при горизонтальном расположении устройства
+     */
+    isLandscape: boolean;
+    /**
+     * true при вертикальном расположении устройства
+     */
+    isPortrait: boolean;
+    /**
+     * Максимальная сторона страницы
+     */
+    size: number;
+    /**
+     * true, если страница скрыта
+     *
+     * Не меняйте это значение вручную
+     */
+    isHidden: boolean;
+};
+export default state;

package/core/directives/data.d.ts

@@ -0,0 +1,10 @@
+import { DirectiveBinding } from 'vue';
+/**
+ * Сохранить данные в элементе
+ *
+ * Для доступа к данным можно воспользоваться ui/utils/dom storage()
+ */
+declare const data: {
+    mounted: (el: HTMLElement, binding: DirectiveBinding) => Promise<void>;
+};
+export default data;

package/core/directives/focus.d.ts

@@ -0,0 +1,10 @@
+import { DirectiveBinding } from 'vue';
+type Binding = DirectiveBinding<boolean, 'onupdate'>;
+/**
+ * Фокусировка на элементе сразу после его отображения
+ */
+declare const focus: {
+    mounted: (el: HTMLElement, binding: Binding) => void;
+    updated: (el: HTMLElement, binding: Binding) => void;
+};
+export default focus;

package/core/directives/preloader.d.ts

@@ -0,0 +1,8 @@
+import { DirectiveBinding } from 'vue';
+/**
+ * Сохранить данные в элементе
+ */
+declare const preloader: {
+    mounted: (el: HTMLElement, binding: DirectiveBinding) => Promise<void>;
+};
+export default preloader;

package/core/directives/scrollIntoView.d.ts

@@ -0,0 +1,3 @@
+import { ObjectDirective } from 'vue';
+declare const scrollIntoView: ObjectDirective;
+export default scrollIntoView;

package/core/directives/scrollShadow.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Добавить отображение тени при появлении скролла у элемента
+ *
+ * Будут добавлены события для усатновки модификаторов тени в зависимости от скролла элемента
+ *
+ * Модификаторы:
+ * - top-scrollShadow
+ * - top-scrollShadow-started
+ * - top-scrollShadow-finished
+ */
+declare const connectScrollShadow: {
+    mounted(el: any): Promise<void>;
+    unmounted(el: any): Promise<void>;
+};
+export default connectScrollShadow;

package/core/directives/sticky.d.ts

@@ -0,0 +1,10 @@
+import { DirectiveBinding, VNode } from 'vue';
+/**
+ * Добавление sticky
+ * К элементу добляется класс переданный как значение диррективы либо **'top-sticky'** по умолчанию
+ */
+declare const sticky: {
+    mounted(el: HTMLElement, binding: DirectiveBinding, _vnode: VNode): void;
+    unmounted(_el: HTMLElement, _binding: DirectiveBinding, _vnode: VNode): void;
+};
+export default sticky;

package/core/directives/swimUp.d.ts

@@ -0,0 +1,15 @@
+import { DirectiveBinding, VNode } from 'vue';
+interface HTMLElementWithSwimUpOptions extends HTMLElement {
+    directiveSwipUpOptions: {
+        distance: number;
+        percent: number;
+    };
+}
+/**
+ * Добавление анимации подплытия вверх для блока
+ */
+declare const swimUp: {
+    mounted(el: HTMLElementWithSwimUpOptions, binding: DirectiveBinding, _vnode: VNode): void;
+    unmounted(el: HTMLElementWithSwimUpOptions, _binding: DirectiveBinding, _vnode: VNode): void;
+};
+export default swimUp;

package/core/directives/tooltip.d.ts

@@ -0,0 +1,10 @@
+import { DirectiveBinding, VNode } from 'vue';
+/**
+ * Добавление всплывающей подсказки к элементу.
+ */
+declare const tooltip: {
+    mounted(el: VNode, binding: DirectiveBinding, vnode: VNode): void;
+    updated(el: VNode, binding: DirectiveBinding, vnode: VNode, _prevVnode: VNode): void;
+    unmounted(el: VNode, _binding: DirectiveBinding, _vnode: VNode): void;
+};
+export default tooltip;

package/core/plugins/core.d.ts

@@ -0,0 +1,60 @@
+import { PartialBy } from '../../components/types';
+import { default as Core } from '../core/core';
+import { default as coreDefaultOptions } from '../core/options';
+import { DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions, App } from 'vue';
+import { Props } from '../../components/core/notice/types';
+import { Options as TopPopupOptions } from '../../components/popup/lib/worker';
+import { default as TopDialogs } from '../../components/dialog/dialog/dialogs/dialogs.vue';
+import { TopDialogOptions } from '../../components/dialog/lib/types';
+import * as Forms from '../../components/forms/forms';
+declare const TopNotice: DefineComponent<Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly< Props> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+declare global {
+    const vd: typeof console.log;
+}
+declare module '@vue/runtime-core' {
+    interface ComponentCustomProperties {
+        /**
+         * Статический класс с текущим состоянимем UI
+         */
+        $core: typeof Core;
+        $vd: typeof console.log;
+    }
+    /**
+     * Обязательные компоненты UI
+     *
+     * Они подключаются через плагин и доступны без явного указания импорта
+     */
+    interface GlobalComponents {
+        TopAvatar: typeof Forms.TopAvatar;
+        TopButton: typeof Forms.TopButton;
+        TopCheckbox: typeof Forms.TopCheckbox;
+        TopControlLabel: typeof Forms.TopControlLabel;
+        TopHint: typeof Forms.TopHint;
+        TopInput: typeof Forms.TopInput;
+        TopInputDate: typeof Forms.TopInputDate;
+        TopInputRange: typeof Forms.TopInputRange;
+        TopRadio: typeof Forms.TopRadio;
+        TopSwitcher: typeof Forms.TopSwitcher;
+        TopTextarea: typeof Forms.TopTextarea;
+        TopSelect: typeof Forms.TopSelect;
+        TopLoadbar: typeof Forms.TopLoadbar;
+        TopNotice: typeof TopNotice;
+        TopDialogs: typeof TopDialogs;
+    }
+}
+type CoreOptions = PartialBy<typeof coreDefaultOptions, 'timezoneOffset' | 'documentClassModificators'>;
+type Options = CoreOptions & {
+    topPopupOptions?: TopPopupOptions;
+    topDialogOptions?: TopDialogOptions;
+};
+/**
+ * Плагин для интеграции UI во Vue приложение
+ *
+ * - В глобальную область видимости шаблонов будет добавлен объект $core
+ * - Будут зарегистрирвоаны директивы UI: https://ui.topvisor.com/?path=/docs/core-directives-focus--docs
+ * - Будут подключены базовые компоненты UI/Forms: https://ui.topvisor.com/?path=/docs/components-forms-readme--docs
+ */
+declare const _default: {
+    install: (app: App<any>, options: Options) => void;
+};
+export default _default;

package/core/plugins/i18n.d.ts

@@ -0,0 +1,97 @@
+import { ComponentCustomProperties, Reactive, Ref, App } from 'vue';
+import { components as I18nComponents } from 'topvisor-openapi/src/ts/I18n';
+export type Lang = 'ru' | 'en';
+type Options = {
+    /**
+     * Предзагруженные словари
+     *
+     * Для загрузки нужного словаря используйте @r/i18n.esm.js
+     *
+     * ```js
+     * import '@r/i18n.esm.js?Projects';
+     * ```
+     */
+    i18n: I18nComponents['schemas'];
+    /**
+     * Текущий язык
+     */
+    lang: Lang;
+};
+/**
+ * Загруженные словари
+ *
+ * Для загрузки нужного словаря используйте @r/i18n.esm.js
+ *
+ * ```js
+ * import '@r/i18n.esm.js?Projects';
+ * ```
+ */
+type I18n = Reactive<Options['i18n']>;
+type I18nRender = <T extends keyof I18n>(categoryName: T, key: keyof I18n[T], props: Record<string, number | string>) => string;
+declare module '@vue/runtime-core' {
+    interface ComponentCustomProperties {
+        /**
+         * Загруженные словари
+         *
+         * Можно использовать как функцию для подстановки значений в формате: `Текст {{ propName }}`
+         *
+         * @see I18n
+         * @see I18nRender
+         */
+        $i18n: I18n & I18nRender;
+        /**
+         * Текущий язык
+         */
+        $i18nLang: Ref<Lang>;
+    }
+}
+/**
+ * Плагин работает в сваязке с плагином requirejs('i18n')
+ *
+ * При инициализации необходимо указать в $i18n объект с предзагруежнными словарями, остальные словари можно импортировать диномически вместе с
+ * компонентами
+ *
+ * Внутри UI дозагрузка словарей недоступна и требует предзагрузки необходимых словарей
+ *
+ * Добавляет глобальные свойства:
+ * - \$i18n
+ * - \$i18nLang
+ * - \$i18nL
+ *
+ * Для загрузки необходимого словаря указывайте его в зависимостях компонента:
+ *
+ * ```js
+ * import '@r/i18n.esm.js?Projects';
+ * ```
+ *
+ * В setup():
+ *
+ * ```js
+ * useI18n().Projects.Site; // выполнит inject('$i18n').Projects.Site, не испоьзуйте inject('$i18n') напрямую, так как он не типизирован
+ * ```
+ *
+ * В template:
+ *
+ * ```html
+ * {{ $i18n.Projects.Site }}
+ * ```
+ *
+ * С подстановкой значений:
+ * ```html
+ * 	{{ $i18n('Projects', 'Site', {name: value}) }}
+ * 	```
+ */
+declare const _default: {
+    install: (app: App<any>, options: Options) => void;
+};
+export default _default;
+/**
+ * Получить доступ к загруженным словарям
+ *
+ * @see I18n
+ */
+export declare const useI18n: () => ComponentCustomProperties["$i18n"];
+/**
+ * Текущий язык
+ */
+export declare const useI18nLang: () => Ref<Lang>;

package/core/plugins/piniaTPA.d.ts

@@ -0,0 +1,17 @@
+import { PiniaPluginContext } from 'pinia';
+/**
+ * Плагин tpa (Third-party access) для pinia
+ *
+ * Добавляет возможность сохранять и загружать данные в/из:
+ * 	- URL hash в адресе страницы
+ * 	- localStorage
+ * 	- гостевая ссылка
+ *
+ * Для подключения плагина нужно указань одну или несколько опций при определении defineStore():
+ * - tpaNamesUrlHash
+ * - tpaNamesStorage
+ * - tpaNamesStorageLocal
+ * - tpaNamesGuestLink
+ */
+declare const _default: (contextPinia: PiniaPluginContext) => void;
+export default _default;

package/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/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/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/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/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;