mdt-client 31.3.21 → 31.3.23

package/types/services/commands/CommandManager.d.ts

@@ -1,77 +1,77 @@
-import { Icon } from "../../components/icon/iconOptions";
-import { FormattedText } from "../../helpers/formattedText";
-import { AnyObject, CommandEvent, Valued } from "../../helpers/types";
-import { IFormControlFacade } from "../customModules/facades/Form/IFormControlFacade";
-import { IListControlFacade } from "../customModules/facades/List/IListControlFacade";
-import { Command } from "./Command";
-import { CommandGroup } from "./CommandGroup";
-export interface CommandGroupProps {
-    /** Уникальный код группы команд */
-    code: string;
-    /** Наименование группы команд */
-    title: string;
-    /** Описание группы команд */
-    description?: string;
-    /** Иконка группы команд */
-    icon?: Icon;
-}
-export declare type Hotkey = string;
-export interface CommandProps {
-    /** Уникальный код команды */
-    code: string;
-    /** Наименование команды */
-    title: string;
-    /** Описание команды */
-    description?: Valued<FormattedText>;
-    /** Иконка команды */
-    icon?: Valued<Icon>;
-    /**
-     * Горячие клавиши для вызова команды.
-     *
-     * Комбинаций клавиш для команды может быть несколько.
-     *
-     * Комбинация клавиш задается строкой и указывается в следующем порядке `Ctrl/Cmd + Alt + Shift + Любая другая клавиша`.
-     *
-     * Клавиши разделяются двумя пробелами и символом "+" между ними.
-     *
-     * Например `Alt + Shift + Y`.
-     */
-    hotkeys?: Hotkey[];
-    /** Группа которой принадлежит команда */
-    group?: CommandGroupProps;
-}
-export interface CommandBase<Context = AnyObject> extends CommandProps {
-    /** Функция которая будет вызвана при выполнении команды */
-    execute: (context: Context) => void;
-    /** Условие активности команды */
-    enabled?: (context: Context) => boolean;
-    /** Условие видимости команды в быстрых командах */
-    visible?: (context: Context) => boolean;
-}
-export declare type HotkeyCommands = {
-    [hotkey: string]: () => void;
-};
-export interface CommandManagerContext {
-    list?: IListControlFacade;
-    form?: IFormControlFacade;
-    [contextProp: string]: any;
-}
-export declare class CommandManagerClass<Context> {
-    private groups;
-    private commands;
-    private hotkeyCommands;
-    private context;
-    addGroup(group: CommandGroupProps, commands?: CommandBase<Context>[]): CommandGroup<Context>;
-    addCommands(commands: CommandBase<Context>[], groupCode?: string): void;
-    getCommand(code: string): Command<Context>;
-    getCommandList(): Command<Context>[];
-    execByEvent(event: CommandEvent): void;
-    setContext(key: keyof Context, value: Context[keyof Context]): void;
-    removeContext(key: keyof Context): void;
-    private createGroup;
-    private validateGroup;
-    private findGroup;
-    private validateCommand;
-    private pushCommands;
-}
-export declare const CommandManager: CommandManagerClass<CommandManagerContext>;
+import { Icon } from "../../components/icon/iconOptions";
+import { FormattedText } from "../../helpers/formattedText";
+import { AnyObject, CommandEvent, Valued } from "../../helpers/types";
+import { IFormControlFacade } from "../customModules/facades/Form/IFormControlFacade";
+import { IListControlFacade } from "../customModules/facades/List/IListControlFacade";
+import { Command } from "./Command";
+import { CommandGroup } from "./CommandGroup";
+export interface CommandGroupProps {
+    /** Уникальный код группы команд */
+    code: string;
+    /** Наименование группы команд */
+    title: string;
+    /** Описание группы команд */
+    description?: string;
+    /** Иконка группы команд */
+    icon?: Icon;
+}
+export declare type Hotkey = string;
+export interface CommandProps {
+    /** Уникальный код команды */
+    code: string;
+    /** Наименование команды */
+    title: string;
+    /** Описание команды */
+    description?: Valued<FormattedText>;
+    /** Иконка команды */
+    icon?: Valued<Icon>;
+    /**
+     * Горячие клавиши для вызова команды.
+     *
+     * Комбинаций клавиш для команды может быть несколько.
+     *
+     * Комбинация клавиш задается строкой и указывается в следующем порядке `Ctrl/Cmd + Alt + Shift + Любая другая клавиша`.
+     *
+     * Клавиши разделяются двумя пробелами и символом "+" между ними.
+     *
+     * Например `Alt + Shift + Y`.
+     */
+    hotkeys?: Hotkey[];
+    /** Группа которой принадлежит команда */
+    group?: CommandGroupProps;
+}
+export interface CommandBase<Context = AnyObject> extends CommandProps {
+    /** Функция которая будет вызвана при выполнении команды */
+    execute: (context: Context) => void;
+    /** Условие активности команды */
+    enabled?: (context: Context) => boolean;
+    /** Условие видимости команды в быстрых командах */
+    visible?: (context: Context) => boolean;
+}
+export declare type HotkeyCommands = {
+    [hotkey: string]: () => void;
+};
+export interface CommandManagerContext {
+    list?: IListControlFacade;
+    form?: IFormControlFacade;
+    [contextProp: string]: any;
+}
+export declare class CommandManagerClass<Context> {
+    private groups;
+    private commands;
+    private hotkeyCommands;
+    private context;
+    addGroup(group: CommandGroupProps, commands?: CommandBase<Context>[]): CommandGroup<Context>;
+    addCommands(commands: CommandBase<Context>[], groupCode?: string): void;
+    getCommand(code: string): Command<Context>;
+    getCommandList(): Command<Context>[];
+    execByEvent(event: CommandEvent): void;
+    setContext(key: keyof Context, value: Context[keyof Context]): void;
+    removeContext(key: keyof Context): void;
+    private createGroup;
+    private validateGroup;
+    private findGroup;
+    private validateCommand;
+    private pushCommands;
+}
+export declare const CommandManager: CommandManagerClass<CommandManagerContext>;

package/types/services/customModules/facades/Form/IFieldControlFacade.d.ts

@@ -1,26 +1,26 @@
-export declare type FieldValue = any;
-export interface ErrorInfo {
-    /** Текст ошибки */
-    message: string;
-    /** Код ошибки */
-    key?: string;
-}
-export interface IFieldControlFacadeContstructor<T = FieldValue> {
-    new (options: any, fieldCtrl: any): IFieldControlFacade<T>;
-}
-export interface IFieldControlFacade<T = FieldValue> {
-    /** Получить значение поля */
-    getValue: () => T;
-    /** Установить значение поля */
-    setValue: (val: T) => void;
-    /** Проверка, является ли поле редактируемым */
-    isEditable: () => boolean;
-    /** Установить ошибку валидации для поля */
-    setErrors: (errors: ErrorInfo[]) => void;
-    /** Очистить ошибки валидации */
-    clearErrors: (errorKey?: string) => void;
-    /** Подписаться на событие обновления значения поля */
-    onUpdated: (callback: (val: T) => void) => () => void;
-    /** Заголовок поля */
-    title: () => string;
-}
+export declare type FieldValue = any;
+export interface ErrorInfo {
+    /** Текст ошибки */
+    message: string;
+    /** Код ошибки */
+    key?: string;
+}
+export interface IFieldControlFacadeContstructor<T = FieldValue> {
+    new (options: any, fieldCtrl: any): IFieldControlFacade<T>;
+}
+export interface IFieldControlFacade<T = FieldValue> {
+    /** Получить значение поля */
+    getValue: () => T;
+    /** Установить значение поля */
+    setValue: (val: T) => void;
+    /** Проверка, является ли поле редактируемым */
+    isEditable: () => boolean;
+    /** Установить ошибку валидации для поля */
+    setErrors: (errors: ErrorInfo[]) => void;
+    /** Очистить ошибки валидации */
+    clearErrors: (errorKey?: string) => void;
+    /** Подписаться на событие обновления значения поля */
+    onUpdated: (callback: (val: T) => void) => () => void;
+    /** Заголовок поля */
+    title: () => string;
+}

package/types/services/customModules/facades/Form/IFieldControlManagerFacade.d.ts

@@ -1,36 +1,36 @@
-import { IFieldControlFacade } from "./IFieldControlFacade";
-export interface MountContext<V> {
-    /** Родительский DOM-элемент контрола */
-    el: HTMLElement;
-    /** Поле, к которому привязан контрол */
-    field: IFieldControlFacade<V>;
-    /** Опции контрола */
-    options: any;
-    /** Подписка на событие удаления контрола */
-    onUnmount: (onUnmountCallback?: () => void) => void;
-    /** Mithril класс контрола */
-    control: any;
-}
-export interface IMithrilCustomControl<V> {
-    new (options: any, field: IFieldControlFacade<V>): any;
-}
-export interface RegisterArgs<V> {
-    /** Наименование контрола */
-    title: string;
-    /** Код контрола */
-    code: string;
-    /** Mithril класс контрола */
-    control?: IMithrilCustomControl<V>;
-    /** Типы полей, для которых предназначен контрол */
-    types?: string | string[];
-    /** Используется ли контрол для полей с внешним ключом */
-    ref?: boolean;
-    /** Скрыть контрол из списка в конструкторе форм */
-    hidden?: boolean;
-    /** Подписка на событие рендера контрола */
-    onMount?: (params: MountContext<V>) => void;
-}
-export interface IFieldControlManagerFacade<V = any> {
-    /** Зарегистрировать новый контрол */
-    register: <T = V>(args: RegisterArgs<T>) => void;
-}
+import { IFieldControlFacade } from "./IFieldControlFacade";
+export interface MountContext<V> {
+    /** Родительский DOM-элемент контрола */
+    el: HTMLElement;
+    /** Поле, к которому привязан контрол */
+    field: IFieldControlFacade<V>;
+    /** Опции контрола */
+    options: any;
+    /** Подписка на событие удаления контрола */
+    onUnmount: (onUnmountCallback?: () => void) => void;
+    /** Mithril класс контрола */
+    control: any;
+}
+export interface IMithrilCustomControl<V> {
+    new (options: any, field: IFieldControlFacade<V>): any;
+}
+export interface RegisterArgs<V> {
+    /** Наименование контрола */
+    title: string;
+    /** Код контрола */
+    code: string;
+    /** Mithril класс контрола */
+    control?: IMithrilCustomControl<V>;
+    /** Типы полей, для которых предназначен контрол */
+    types?: string | string[];
+    /** Используется ли контрол для полей с внешним ключом */
+    ref?: boolean;
+    /** Скрыть контрол из списка в конструкторе форм */
+    hidden?: boolean;
+    /** Подписка на событие рендера контрола */
+    onMount?: (params: MountContext<V>) => void;
+}
+export interface IFieldControlManagerFacade<V = any> {
+    /** Зарегистрировать новый контрол */
+    register: <T = V>(args: RegisterArgs<T>) => void;
+}

package/types/services/customModules/facades/Form/IFieldStateFacade.d.ts

@@ -1,13 +1,13 @@
-import { IFilter } from "../../../IFilter";
-export interface IFieldStateFacade {
-    /** Сделать поле недоступным для редактирования */
-    setReadonly(readonly: boolean): void;
-    /** Настроить фильтр для поля */
-    setFilter(filter: IFilter): void;
-    /** Скрыть/Показать поле */
-    setVisible(isVisible: boolean): void;
-    /** Добавить ошибку валидации для поля */
-    addError(message: string, key: string): void;
-    /** Убрать ранее добавленную ошибку валидации */
-    removeError(key: string): void;
-}
+import { IFilter } from "../../../IFilter";
+export interface IFieldStateFacade {
+    /** Сделать поле недоступным для редактирования */
+    setReadonly(readonly: boolean): void;
+    /** Настроить фильтр для поля */
+    setFilter(filter: IFilter): void;
+    /** Скрыть/Показать поле */
+    setVisible(isVisible: boolean): void;
+    /** Добавить ошибку валидации для поля */
+    addError(message: string, key: string): void;
+    /** Убрать ранее добавленную ошибку валидации */
+    removeError(key: string): void;
+}

package/types/services/customModules/facades/Form/IFormControlFacade.d.ts

@@ -1,133 +1,133 @@
-import { EventEmitter } from "../../../../helpers/events/EventEmitter";
-import { FormZones } from "../../../../views/form/formTypes";
-import { IFieldFacade } from "../schema/IFieldFacade";
-import { IObjectFacade } from "../schema/IObjectFacade";
-import { RecordId } from "../../../../common/Record";
-import { ParentCtrl } from "../utils/IUiFacade";
-import { ButtonFacade } from "./IFormFacade";
-import { FieldCode } from "mdtScripts/helpers/types";
-import { IFieldStateFacade } from "./IFieldStateFacade";
-export declare type IFormFieldOptionsConfig = {
-    [fieldCode: string]: any;
-};
-export interface IFormControlFacadeContstructor {
-    new (formCtrl: any): IFormControlFacade;
-}
-export interface FormControlFacadeEvents {
-    saved: {
-        recordId: RecordId;
-    };
-}
-export interface IFormControlFacade extends ParentCtrl {
-    eventEmitter: EventEmitter<FormControlFacadeEvents>;
-    /** Получить оригинальный контрол формы */
-    getFormCtrl(): any;
-    /** Получить объект, к которому приязана форма */
-    getObject(): IObjectFacade;
-    /** Получить код формы */
-    getCode(): string | undefined;
-    /** Получить контекстный параметр формы */
-    getContext(key: string): any;
-    /** Установить контекстный параметр формы */
-    setContext(key: string, value: any): void;
-    /** Получить запись */
-    getRecord(): Record<string, any>;
-    /** Получить ID записи */
-    getRecordId(): RecordId;
-    /** Проверка, что запись в форме новая */
-    isNewRecord(): boolean;
-    /** Получить или установить значение для поля формы */
-    value(field: string, val?: any, val$?: any, fireEvent?: boolean, setDirty?: boolean, updateData?: {}): any;
-    /** Получение значения по пути */
-    valueByPath(path: string): any;
-    /** Добавить зависимость для запроса записи*/
-    addRecordInitDependence(dependence: () => Promise<unknown>): void;
-    /** Подписаться на событие инициализации записи формы */
-    onBound(callback: () => void): void;
-    /** Подписаться на событие сохранения записи */
-    onSave<T = {
-        [field: string]: any;
-    }>(callback: (record: T) => void): void;
-    /** Подписаться на событие закрытия формы */
-    onClose(callback: () => void): void;
-    /** Подписаться на событие создания макета формы */
-    onLayoutCreated(callback: () => void): void;
-    /** Установить команду на форму */
-    addCommand(command: ButtonFacade, isExtended?: boolean): void;
-    /** Установить настройки для полей формы */
-    setFieldOptions(options: IFormFieldOptionsConfig): void;
-    /** Установить настройки для компонента формы */
-    setControlOptions(findControl: (col: any) => boolean, controlOptions: any): any;
-    /** Установить флаг доступности редактирования формы */
-    setReadonly(readonly: boolean): void;
-    /** Проверка, доступна ли форма для редактирования */
-    isReadonly(): boolean;
-    /** Изменить свойства существующей кнопки */
-    updateCommand(findCondition: (button: ButtonFacade) => boolean, command: Partial<ButtonFacade>): void;
-    /** Повторно инициализировать форму */
-    reinit(): void;
-    /** Сохранить форму */
-    save(): void;
-    /** Открыть конструктор формы */
-    openDesigner(): void;
-    /** Получить зоны */
-    getZones(): FormZones;
-    /** Подписаться на событие обновление значения поля формы */
-    onUpdated<V = string>(callback: (field: IFieldFacade, value: V) => void): void;
-    /** Закрыть форму */
-    close(): void;
-    /** Сообщить подписчикам формы о внесении изменений в данные
-     *  Например, при вызове функции обновиться связанный список
-     */
-    notifyDataUpdated(): void;
-    /**
-     * Подписаться на обновление поля и выполнить запрос, проверку, настройку формы или другое действие
-     *
-     * **Примеры**
-     *
-     * Когда обновляется поле "Сотрудник", автоматически заполняется поле "Позиция":
-     * ```js
-     *	 form.onFieldsUpdated({
-     *	 // Поля при изменении которых будет выполнено действие
-     *		fields: ["ID_Employee"],
-     *		// Действие, бизнес логика или вызов хранимой процедуры
-     *		execute: async () => {
-     *			const idEmployee = form.value("ID_Employee");
-     *			if (!idEmployee) return null;
-     *      // Допустим fetchPositionByEmployee выполняет запрос к базе и возвращает id позиции у сотрудника
-     *			const idPosition = await fetchPositionByEmployee(idEmployee);
-     *			return idPosition;
-     *		},
-     *		 // Функция, которая будет выполнена после выполнения `execute`
-     *		onComplete: (idPosition) => {
-     *			form.value("ID_Position", idPosition);
-     *		},
-     *		 // Поля, которые будут недоступны для редактирования, пока выполняются execute и onComplete
-     *		lock: ["ID_Position"]
-     *	});
-     *  ```
-     */
-    onFieldsUpdated<T = any>(options: OnFieldsUpdatedOptions<T>): void;
-    /**
-     * Состояние поля формы
-     *
-     * **Примеры**
-     *
-     * ```js
-     * 	form.getFieldState("ID_Employee").setFilter(Filter.eq("MDT_FlagActive", true);
-     * 	form.getFieldState("ID_Position").setReadonly(true);
-     * 	form.getFieldState("ID_EmployeeType").setVisible(false);
-     *  ```
-     */
-    getFieldState(fieldCode: FieldCode): IFieldStateFacade | undefined;
-}
-export interface OnFieldsUpdatedOptions<T = any> {
-    /** Поля при изменении которых будет выполнено действие */
-    fields: FieldCode[];
-    /** Действие, бизнес логика или вызов хранимой процедуры */
-    execute: () => Promise<T> | T;
-    /** Функция, которая будет выполнена после выполнения `execute` */
-    onComplete: (value: T) => void;
-    /** Поля, которые будут недоступны для редактирования, пока выполняются execute и onComplete */
-    lock?: FieldCode[];
-}
+import { EventEmitter } from "../../../../helpers/events/EventEmitter";
+import { FormZones } from "../../../../views/form/formTypes";
+import { IFieldFacade } from "../schema/IFieldFacade";
+import { IObjectFacade } from "../schema/IObjectFacade";
+import { RecordId } from "../../../../common/Record";
+import { ParentCtrl } from "../utils/IUiFacade";
+import { ButtonFacade } from "./IFormFacade";
+import { FieldCode } from "mdtScripts/helpers/types";
+import { IFieldStateFacade } from "./IFieldStateFacade";
+export declare type IFormFieldOptionsConfig = {
+    [fieldCode: string]: any;
+};
+export interface IFormControlFacadeContstructor {
+    new (formCtrl: any): IFormControlFacade;
+}
+export interface FormControlFacadeEvents {
+    saved: {
+        recordId: RecordId;
+    };
+}
+export interface IFormControlFacade extends ParentCtrl {
+    eventEmitter: EventEmitter<FormControlFacadeEvents>;
+    /** Получить оригинальный контрол формы */
+    getFormCtrl(): any;
+    /** Получить объект, к которому приязана форма */
+    getObject(): IObjectFacade;
+    /** Получить код формы */
+    getCode(): string | undefined;
+    /** Получить контекстный параметр формы */
+    getContext(key: string): any;
+    /** Установить контекстный параметр формы */
+    setContext(key: string, value: any): void;
+    /** Получить запись */
+    getRecord(): Record<string, any>;
+    /** Получить ID записи */
+    getRecordId(): RecordId;
+    /** Проверка, что запись в форме новая */
+    isNewRecord(): boolean;
+    /** Получить или установить значение для поля формы */
+    value(field: string, val?: any, val$?: any, fireEvent?: boolean, setDirty?: boolean, updateData?: {}): any;
+    /** Получение значения по пути */
+    valueByPath(path: string): any;
+    /** Добавить зависимость для запроса записи*/
+    addRecordInitDependence(dependence: () => Promise<unknown>): void;
+    /** Подписаться на событие инициализации записи формы */
+    onBound(callback: () => void): void;
+    /** Подписаться на событие сохранения записи */
+    onSave<T = {
+        [field: string]: any;
+    }>(callback: (record: T) => void): void;
+    /** Подписаться на событие закрытия формы */
+    onClose(callback: () => void): void;
+    /** Подписаться на событие создания макета формы */
+    onLayoutCreated(callback: () => void): void;
+    /** Установить команду на форму */
+    addCommand(command: ButtonFacade, isExtended?: boolean): void;
+    /** Установить настройки для полей формы */
+    setFieldOptions(options: IFormFieldOptionsConfig): void;
+    /** Установить настройки для компонента формы */
+    setControlOptions(findControl: (col: any) => boolean, controlOptions: any): any;
+    /** Установить флаг доступности редактирования формы */
+    setReadonly(readonly: boolean): void;
+    /** Проверка, доступна ли форма для редактирования */
+    isReadonly(): boolean;
+    /** Изменить свойства существующей кнопки */
+    updateCommand(findCondition: (button: ButtonFacade) => boolean, command: Partial<ButtonFacade>): void;
+    /** Повторно инициализировать форму */
+    reinit(): void;
+    /** Сохранить форму */
+    save(): void;
+    /** Открыть конструктор формы */
+    openDesigner(): void;
+    /** Получить зоны */
+    getZones(): FormZones;
+    /** Подписаться на событие обновление значения поля формы */
+    onUpdated<V = string>(callback: (field: IFieldFacade, value: V) => void): void;
+    /** Закрыть форму */
+    close(): void;
+    /** Сообщить подписчикам формы о внесении изменений в данные
+     *  Например, при вызове функции обновиться связанный список
+     */
+    notifyDataUpdated(): void;
+    /**
+     * Подписаться на обновление поля и выполнить запрос, проверку, настройку формы или другое действие
+     *
+     * **Примеры**
+     *
+     * Когда обновляется поле "Сотрудник", автоматически заполняется поле "Позиция":
+     * ```js
+     *	 form.onFieldsUpdated({
+     *	 // Поля при изменении которых будет выполнено действие
+     *		fields: ["ID_Employee"],
+     *		// Действие, бизнес логика или вызов хранимой процедуры
+     *		execute: async () => {
+     *			const idEmployee = form.value("ID_Employee");
+     *			if (!idEmployee) return null;
+     *      // Допустим fetchPositionByEmployee выполняет запрос к базе и возвращает id позиции у сотрудника
+     *			const idPosition = await fetchPositionByEmployee(idEmployee);
+     *			return idPosition;
+     *		},
+     *		 // Функция, которая будет выполнена после выполнения `execute`
+     *		onComplete: (idPosition) => {
+     *			form.value("ID_Position", idPosition);
+     *		},
+     *		 // Поля, которые будут недоступны для редактирования, пока выполняются execute и onComplete
+     *		lock: ["ID_Position"]
+     *	});
+     *  ```
+     */
+    onFieldsUpdated<T = any>(options: OnFieldsUpdatedOptions<T>): void;
+    /**
+     * Состояние поля формы
+     *
+     * **Примеры**
+     *
+     * ```js
+     * 	form.getFieldState("ID_Employee").setFilter(Filter.eq("MDT_FlagActive", true);
+     * 	form.getFieldState("ID_Position").setReadonly(true);
+     * 	form.getFieldState("ID_EmployeeType").setVisible(false);
+     *  ```
+     */
+    getFieldState(fieldCode: FieldCode): IFieldStateFacade | undefined;
+}
+export interface OnFieldsUpdatedOptions<T = any> {
+    /** Поля при изменении которых будет выполнено действие */
+    fields: FieldCode[];
+    /** Действие, бизнес логика или вызов хранимой процедуры */
+    execute: () => Promise<T> | T;
+    /** Функция, которая будет выполнена после выполнения `execute` */
+    onComplete: (value: T) => void;
+    /** Поля, которые будут недоступны для редактирования, пока выполняются execute и onComplete */
+    lock?: FieldCode[];
+}