mdt-client 31.3.45 → 31.3.46

package/types/services/customModules/facades/utils/IUiFacade.d.ts

@@ -1,84 +1,83 @@
-/// <reference types="../../../../mithril" />
-/// <reference types="mithril" />
-import { MithrilControl } from "../../../../helpers/types";
-import { DropdownOptions } from "../../../dropdown/IDropDownMenu";
-import { ButtonFacade } from "../Form/IFormFacade";
-import { DropdownTargetContext, IDropdownMenu } from "../../../dropdown/IDropDownMenu";
-import { IModalFacade } from "../components/ModalFacade";
-import { UiType } from "../../../../helpers/IUi";
-import { IPanelOptions } from "mdtScripts/views/controls/panels/panelOptions";
-export type onModalResizeCallback = (data: IModalSizingState) => void;
-export interface IType<T> {
-    new (...args: any[]): T;
-}
-export interface ParentCtrl {
-    getViewControl(): MithrilControl;
-}
-export type NotificationType = "default" | "info" | "success" | "warning" | "danger";
-export type UiContainerContent = MithrilControl | ParentCtrl | string;
-export interface CustomNotification {
-    /** Заголовок сообщения */
-    title: string;
-    /** Текст сообщения */
-    text: string;
-    /** Наименование иконки */
-    icon?: string;
-    /** Тип выводимого сообщения*/
-    type?: NotificationType;
-    /** Кнопки, отображаемые в сообщении*/
-    actions?: ButtonFacade[];
-}
-export interface IUiFacade {
-    /** Вызвать окно уведомления */
-    showNotification(msg: CustomNotification, duration?: number): void;
-    /** Вызвать модальное окно */
-    showModal(content: UiContainerContent, options?: IModalOptions): IModalFacade;
-    /** Вызвать боковую панель */
-    showSidebar(content: UiContainerContent, options?: ISidebarOptions): void;
-    /** Создать выпадающее меню */
-    createDropdown<I>(options: DropdownOptions<I>, el: Element, ctx: DropdownTargetContext<I>): IDropdownMenu<I>;
-    /** Создать компонент с пользовательской версткой */
-    createControl(view: () => _mithril.MithrilVirtualElement): MithrilControl;
-}
-export type ModalTypes = UiType;
-export interface IModalOptions {
-    /** CSS класс */
-    class?: string;
-    /** Подписка на инциализацию модального окна */
-    initContainer?: (container: any) => void;
-    /** Размер модального окна */
-    size?: "lg" | "sm" | "md";
-    /** Классы CSS для содержимого модального окна */
-    css?: string;
-    /** Заголовок модального окна */
-    title?: string;
-    /** Иконка для модального окна */
-    icon?: string;
-    /** Затемнение заднего фона */
-    backdrop?: boolean;
-    /** Параметры размеров модального окна */
-    initialSizingState?: IModalSizingState;
-    /** Тип модального окна */
-    type?: ModalTypes;
-    /** Дополнительные кнопки на окне */
-    buttons?: ButtonFacade[];
-    /** Настройки кнопки закрытия модального окна */
-    closeButton?: Partial<ButtonFacade>;
-    /**
-     * Возможность закрыть окно по кнопкам закрытия и с помощью клавиатуры
-     * @default true
-     */
-    closable?: boolean;
-    onClose?: (closeResult?: any) => void;
-    /** Содержит ли модальное окно какое-либо действие */
-    isAction?: boolean;
-}
-export type ISidebarOptions = IPanelOptions;
-export interface IModalSizingState {
-    /** Отображать окно в расширенном на весь экран виде */
-    full: boolean;
-    /** Ширина */
-    width: number;
-    /** Высота */
-    height: number;
-}
+/// <reference types="../../../../mithril" />
+import { MithrilControl } from "../../../../helpers/types";
+import { DropdownOptions } from "../../../dropdown/IDropDownMenu";
+import { ButtonFacade } from "../Form/IFormFacade";
+import { DropdownTargetContext, IDropdownMenu } from "../../../dropdown/IDropDownMenu";
+import { IModalFacade } from "../components/ModalFacade";
+import { UiType } from "../../../../helpers/IUi";
+import { IPanelOptions } from "mdtScripts/views/controls/panels/panelOptions";
+export type onModalResizeCallback = (data: IModalSizingState) => void;
+export interface IType<T> {
+    new (...args: any[]): T;
+}
+export interface ParentCtrl {
+    getViewControl(): MithrilControl;
+}
+export type NotificationType = "default" | "info" | "success" | "warning" | "danger";
+export type UiContainerContent = MithrilControl | ParentCtrl | string;
+export interface CustomNotification {
+    /** Заголовок сообщения */
+    title: string;
+    /** Текст сообщения */
+    text: string;
+    /** Наименование иконки */
+    icon?: string;
+    /** Тип выводимого сообщения*/
+    type?: NotificationType;
+    /** Кнопки, отображаемые в сообщении*/
+    actions?: ButtonFacade[];
+}
+export interface IUiFacade {
+    /** Вызвать окно уведомления */
+    showNotification(msg: CustomNotification, duration?: number): void;
+    /** Вызвать модальное окно */
+    showModal(content: UiContainerContent, options?: IModalOptions): IModalFacade;
+    /** Вызвать боковую панель */
+    showSidebar(content: UiContainerContent, options?: ISidebarOptions): void;
+    /** Создать выпадающее меню */
+    createDropdown<I>(options: DropdownOptions<I>, el: Element, ctx: DropdownTargetContext<I>): IDropdownMenu<I>;
+    /** Создать компонент с пользовательской версткой */
+    createControl(view: () => _mithril.MithrilVirtualElement): MithrilControl;
+}
+export type ModalTypes = UiType;
+export interface IModalOptions {
+    /** CSS класс */
+    class?: string;
+    /** Подписка на инциализацию модального окна */
+    initContainer?: (container: any) => void;
+    /** Размер модального окна */
+    size?: "lg" | "sm" | "md";
+    /** Классы CSS для содержимого модального окна */
+    css?: string;
+    /** Заголовок модального окна */
+    title?: string;
+    /** Иконка для модального окна */
+    icon?: string;
+    /** Затемнение заднего фона */
+    backdrop?: boolean;
+    /** Параметры размеров модального окна */
+    initialSizingState?: IModalSizingState;
+    /** Тип модального окна */
+    type?: ModalTypes;
+    /** Дополнительные кнопки на окне */
+    buttons?: ButtonFacade[];
+    /** Настройки кнопки закрытия модального окна */
+    closeButton?: Partial<ButtonFacade>;
+    /**
+     * Возможность закрыть окно по кнопкам закрытия и с помощью клавиатуры
+     * @default true
+     */
+    closable?: boolean;
+    onClose?: (closeResult?: any) => void;
+    /** Содержит ли модальное окно какое-либо действие */
+    isAction?: boolean;
+}
+export type ISidebarOptions = IPanelOptions;
+export interface IModalSizingState {
+    /** Отображать окно в расширенном на весь экран виде */
+    full: boolean;
+    /** Ширина */
+    width: number;
+    /** Высота */
+    height: number;
+}

package/types/services/customModules/facades/utils/IUtilsFacade.d.ts

@@ -1,225 +1,225 @@
-import { KeyStorage } from "../../../../helpers/utils/keyStorage/KeyStorage";
-import { FormatOptions } from "../../../../helpers/formatOptions";
-import { IListButtonExtendPipelineService } from "../services/IListButtonExtendPipelineService";
-import { getValued } from "../../../../helpers/utils/valued/getValued";
-import { AnyObject } from "../../../../helpers/types";
-import { EventEmitter } from "../../../../helpers/events/EventEmitter";
-import { Pipeline, PipelineSync } from "../../../../helpers/pipeline/Pipeline";
-import { ImmutableArgPipeline } from "../../../../helpers/pipeline/ImmutableArgPipeline";
-import { MdtDateStringFormat } from "mdtScripts/helpers/dateUtils";
-export interface IUtilsFacade {
-    ListButtonExtendPipelineService: IListButtonExtendPipelineService;
-    /**
-     * Переводит текст по ключу из таблицы с локализацией
-     *
-     * @example Примеры
-     *
-     * ```js
-     * const text = Utils.getText("Save");
-     * // text: "Сохранить" (в зависимости от языка)
-     *
-     * // Допустим есть ключ "Поле {field} отсутствует в таблице {table}"
-     * const field = "MDT_FlagActive";
-     * const table = "md.Customer"
-     * const text = Utils.getText("Field `{field}` is missing in table `{table}`", { field, table });
-     * // text: "Поле `MDT_FlagActive` отсутствует в таблице `md.Customer`"
-     * ```
-     */
-    getText(textCode: string, args?: AnyObject, complex?: true): string;
-    /**
-     * Форматирует значение
-     * - type: "number" - форматирует как число
-     * - type: "date" - форматирует как дату
-     *
-     * @param value Значение
-     * @param options Опции форматирования
-     *
-     * @example Примеры
-     *
-     * ```js
-     * // форматирование даты
-     * const today = new Date();
-     * const formattedValue = Utils.format(today, { type: "date" });
-     * // formattedValue: "01.01.2024"
-     *
-     * // форматирование числа
-     * const formattedValue = Utils.format(123456.789, { type: "number" });
-     * // formattedValue: "123 456,79"
-     * ```
-     */
-    format(value: any, options?: FormatOptions): any;
-    /**
-     * Генерирует GUID
-     *
-     * @example Примеры
-     *
-     * ```js
-     * const guid = Utils.guid();
-     * ```
-     */
-    guid(): string;
-    /**
-     * Получает значение из localStorage
-     *
-     * @param key Ключ
-     * @param defaultValue Значение по умолчанию
-     *
-     * @example Примеры
-     *
-     * ```js
-     * const storage = Utils.getStorageItem("feature-name", "default");
-     *
-     * // Если не было ранее значения
-     * const v = storage.get(); // "default"
-     *
-     * // Если было ранее значение
-     * storage.set("value");
-     * const v = storage.get(); // "value"
-     *
-     * // Очистка значения
-     * storage.clear();
-     * ```
-     */
-    getStorageItem<T>(key: string, defaultValue?: T): KeyStorage<T>;
-    /**
-     * Скачать файл по url
-     * Ошибки загрузки не выводятся.
-     * Увеличить лимит времени загрузки можно с помощью глобальной переменной mdt.file.download.timeLimit
-     */
-    downloadFile(url: string): void;
-    /**
-     *
-     * @example Примеры
-     *
-     * ```js
-     * 	const value1 = getValued(123), // 123
-     * 	const value2 = getValued(() => 123), // 123
-     * ```
-     */
-    getValued: typeof getValued;
-    /**
-     * Объединяет два объекта в один. Не мутирует исходные объекты.
-     *
-     * @param object1 Первый объект
-     * @param object2 Второй объект
-     *
-     * @example Примеры
-     *
-     * ```js
-     * const object1 = { a: 1, b: 2 };
-     * const object2 = { b: 3, c: 4 };
-     * const result = Utils.mergeDeep(object1, object2);
-     * // result: { a: 1, b: 3, c: 4 }
-     * ```
-     */
-    mergeDeep<T = AnyObject>(object1: T, object2: T): AnyObject;
-    /**
-     * Удаляет элемент из массива (первое вхождение).
-     *
-     * @param array Массив, из которого нужно удалить элемент
-     * @param item Элемент, который нужно удалить
-     * @example Примеры
-
-     * ```js
-     * const array = [1, 2, 3, 2];
-     * Utils.deleteFromArray(array, 2);
-     * // array теперь: [1, 3, 2]
-     * ```
-     */
-    deleteFromArray<T>(array: T[], item: T): void;
-    /**
-     * Проверяет, является ли примитивное значение пустым (null, undefined).
-     *
-     * @param value Проверяемое значение
-     *
-     * @example Примеры
-     *
-     * ```js
-     * Utils.isEmpty(""); // true
-     * Utils.isEmpty(null); // true
-     * Utils.isEmpty(0); // false
-     * Utils.isEmpty("текст"); // false
-     * Utils.isEmpty([1,2]); // false
-     * ```
-     */
-    isEmpty(value: unknown): boolean;
-    date: {
-        /**
-         * Преобразует строку даты из строкового формата в объект Date.
-         *
-         * @param dateString Строка даты в формате "дд.мм.гггг" или "дд.мм.гггг чч:мм:сс"
-         *
-         * @example Примеры
-         *
-         * ```js
-         * const date = Utils.date.stringDateToDate("01.02.2024");
-         * ```
-         */
-        stringDateToDate(dateString: MdtDateStringFormat): Date;
-        /**
-         * Преобразует объект Date в строку формата "дд.мм.гггг" или "дд.мм.гггг чч:мм:сс".
-         *
-         * @param date Объект Date
-         *
-         * @example Примеры
-         *
-         * ```js
-         * Utils.date.dateToStringDate(new Date(2024, 0, 2)); // "02.01.2024"
-         * Utils.date.dateToStringDate(new Date(2024, 0, 2, 10, 30, 0)); // "02.01.2024 10:30:00"
-         * ```
-         */
-        dateToStringDate(date: Date, withTime: boolean): string;
-        /**
-         * Преобразует объект Date в строку формата ISO8601 ("гггг-мм-дд").
-         *
-         * @param date Объект Date
-         *
-         * @example Примеры
-         *
-         * ```js
-         * Utils.date.dateToISO8601(new Date(2024, 0, 2)); // "2024-01-02"
-         * ```
-         */
-        dateToISO8601(date: Date): string;
-        /**
-         * Проверяет, равны ли две даты.
-         *
-         * @param date1 Первая дата
-         * @param date2 Вторая дата
-         * @param options Опции сравнения (например, ignoreTime — игнорировать время)
-         *
-         * @example Примеры
-         *
-         * ```js
-         * Utils.date.isDateEqual(new Date(2024, 0, 2), new Date(2024, 0, 2)); // true
-         * Utils.date.isDateEqual(new Date(2024, 0, 2, 10), new Date(2024, 0, 2, 15), { ignoreTime: true }); // true
-         * ```
-         */
-        isDateEqual(date1: Date, date2: Date, options?: IsDateEqualOptions): boolean;
-    };
-    /**
-     * Позволяет определять события, подписываться на них и вызывать
-     *
-     * @example Примеры
-     *
-     * ```typescript
-     * interface Events {
-     *   "custom-event": { data: string }
-     * }
-     *
-     * const eventEmitter = new EventEmitter<Events>();
-     * // Подписка на событие
-     * eventEmitter.on("custom-event", (data) => console.log(data));
-     * // Вызов события
-     * eventEmitter.emit("custom-event", { data: "data" }); // выведет "data"
-     *
-     * ```
-     */
-    EventEmitter: typeof EventEmitter;
-    Pipeline: typeof Pipeline;
-    PipelineSync: typeof PipelineSync;
-    ImmutableArgPipeline: typeof ImmutableArgPipeline;
-}
-export type IsDateEqualOptions = {
-    ignoreTime?: boolean;
-};
+import { KeyStorage } from "../../../../helpers/utils/keyStorage/KeyStorage";
+import { FormatOptions } from "../../../../helpers/formatOptions";
+import { IListButtonExtendPipelineService } from "../services/IListButtonExtendPipelineService";
+import { getValued } from "../../../../helpers/utils/valued/getValued";
+import { AnyObject } from "../../../../helpers/types";
+import { EventEmitter } from "../../../../helpers/events/EventEmitter";
+import { Pipeline, PipelineSync } from "../../../../helpers/pipeline/Pipeline";
+import { ImmutableArgPipeline } from "../../../../helpers/pipeline/ImmutableArgPipeline";
+import { MdtDateStringFormat } from "mdtScripts/helpers/dateUtils";
+export interface IUtilsFacade {
+    ListButtonExtendPipelineService: IListButtonExtendPipelineService;
+    /**
+     * Переводит текст по ключу из таблицы с локализацией
+     *
+     * @example Примеры
+     *
+     * ```js
+     * const text = Utils.getText("Save");
+     * // text: "Сохранить" (в зависимости от языка)
+     *
+     * // Допустим есть ключ "Поле {field} отсутствует в таблице {table}"
+     * const field = "MDT_FlagActive";
+     * const table = "md.Customer"
+     * const text = Utils.getText("Field `{field}` is missing in table `{table}`", { field, table });
+     * // text: "Поле `MDT_FlagActive` отсутствует в таблице `md.Customer`"
+     * ```
+     */
+    getText(textCode: string, args?: AnyObject, complex?: true): string;
+    /**
+     * Форматирует значение
+     * - type: "number" - форматирует как число
+     * - type: "date" - форматирует как дату
+     *
+     * @param value Значение
+     * @param options Опции форматирования
+     *
+     * @example Примеры
+     *
+     * ```js
+     * // форматирование даты
+     * const today = new Date();
+     * const formattedValue = Utils.format(today, { type: "date" });
+     * // formattedValue: "01.01.2024"
+     *
+     * // форматирование числа
+     * const formattedValue = Utils.format(123456.789, { type: "number" });
+     * // formattedValue: "123 456,79"
+     * ```
+     */
+    format(value: any, options?: FormatOptions): any;
+    /**
+     * Генерирует GUID
+     *
+     * @example Примеры
+     *
+     * ```js
+     * const guid = Utils.guid();
+     * ```
+     */
+    guid(): string;
+    /**
+     * Получает значение из localStorage
+     *
+     * @param key Ключ
+     * @param defaultValue Значение по умолчанию
+     *
+     * @example Примеры
+     *
+     * ```js
+     * const storage = Utils.getStorageItem("feature-name", "default");
+     *
+     * // Если не было ранее значения
+     * const v = storage.get(); // "default"
+     *
+     * // Если было ранее значение
+     * storage.set("value");
+     * const v = storage.get(); // "value"
+     *
+     * // Очистка значения
+     * storage.clear();
+     * ```
+     */
+    getStorageItem<T>(key: string, defaultValue?: T): KeyStorage<T>;
+    /**
+     * Скачать файл по url
+     * Ошибки загрузки не выводятся.
+     * Увеличить лимит времени загрузки можно с помощью глобальной переменной mdt.file.download.timeLimit
+     */
+    downloadFile(url: string): void;
+    /**
+     *
+     * @example Примеры
+     *
+     * ```js
+     * 	const value1 = getValued(123), // 123
+     * 	const value2 = getValued(() => 123), // 123
+     * ```
+     */
+    getValued: typeof getValued;
+    /**
+     * Объединяет два объекта в один. Не мутирует исходные объекты.
+     *
+     * @param object1 Первый объект
+     * @param object2 Второй объект
+     *
+     * @example Примеры
+     *
+     * ```js
+     * const object1 = { a: 1, b: 2 };
+     * const object2 = { b: 3, c: 4 };
+     * const result = Utils.mergeDeep(object1, object2);
+     * // result: { a: 1, b: 3, c: 4 }
+     * ```
+     */
+    mergeDeep<T = AnyObject>(object1: T, object2: T): AnyObject;
+    /**
+     * Удаляет элемент из массива (первое вхождение).
+     *
+     * @param array Массив, из которого нужно удалить элемент
+     * @param item Элемент, который нужно удалить
+     * @example Примеры
+
+     * ```js
+     * const array = [1, 2, 3, 2];
+     * Utils.deleteFromArray(array, 2);
+     * // array теперь: [1, 3, 2]
+     * ```
+     */
+    deleteFromArray<T>(array: T[], item: T): void;
+    /**
+     * Проверяет, является ли примитивное значение пустым (null, undefined).
+     *
+     * @param value Проверяемое значение
+     *
+     * @example Примеры
+     *
+     * ```js
+     * Utils.isEmpty(""); // true
+     * Utils.isEmpty(null); // true
+     * Utils.isEmpty(0); // false
+     * Utils.isEmpty("текст"); // false
+     * Utils.isEmpty([1,2]); // false
+     * ```
+     */
+    isEmpty(value: unknown): boolean;
+    date: {
+        /**
+         * Преобразует строку даты из строкового формата в объект Date.
+         *
+         * @param dateString Строка даты в формате "дд.мм.гггг" или "дд.мм.гггг чч:мм:сс"
+         *
+         * @example Примеры
+         *
+         * ```js
+         * const date = Utils.date.stringDateToDate("01.02.2024");
+         * ```
+         */
+        stringDateToDate(dateString: MdtDateStringFormat): Date;
+        /**
+         * Преобразует объект Date в строку формата "дд.мм.гггг" или "дд.мм.гггг чч:мм:сс".
+         *
+         * @param date Объект Date
+         *
+         * @example Примеры
+         *
+         * ```js
+         * Utils.date.dateToStringDate(new Date(2024, 0, 2)); // "02.01.2024"
+         * Utils.date.dateToStringDate(new Date(2024, 0, 2, 10, 30, 0)); // "02.01.2024 10:30:00"
+         * ```
+         */
+        dateToStringDate(date: Date, withTime: boolean): string;
+        /**
+         * Преобразует объект Date в строку формата ISO8601 ("гггг-мм-дд").
+         *
+         * @param date Объект Date
+         *
+         * @example Примеры
+         *
+         * ```js
+         * Utils.date.dateToISO8601(new Date(2024, 0, 2)); // "2024-01-02"
+         * ```
+         */
+        dateToISO8601(date: Date): string;
+        /**
+         * Проверяет, равны ли две даты.
+         *
+         * @param date1 Первая дата
+         * @param date2 Вторая дата
+         * @param options Опции сравнения (например, ignoreTime — игнорировать время)
+         *
+         * @example Примеры
+         *
+         * ```js
+         * Utils.date.isDateEqual(new Date(2024, 0, 2), new Date(2024, 0, 2)); // true
+         * Utils.date.isDateEqual(new Date(2024, 0, 2, 10), new Date(2024, 0, 2, 15), { ignoreTime: true }); // true
+         * ```
+         */
+        isDateEqual(date1: Date, date2: Date, options?: IsDateEqualOptions): boolean;
+    };
+    /**
+     * Позволяет определять события, подписываться на них и вызывать
+     *
+     * @example Примеры
+     *
+     * ```typescript
+     * interface Events {
+     *   "custom-event": { data: string }
+     * }
+     *
+     * const eventEmitter = new EventEmitter<Events>();
+     * // Подписка на событие
+     * eventEmitter.on("custom-event", (data) => console.log(data));
+     * // Вызов события
+     * eventEmitter.emit("custom-event", { data: "data" }); // выведет "data"
+     *
+     * ```
+     */
+    EventEmitter: typeof EventEmitter;
+    Pipeline: typeof Pipeline;
+    PipelineSync: typeof PipelineSync;
+    ImmutableArgPipeline: typeof ImmutableArgPipeline;
+}
+export type IsDateEqualOptions = {
+    ignoreTime?: boolean;
+};