mdt-client 31.3.39 → 31.3.41

package/types/_core/scripts/common/list/group/groupTypes.d.ts

@@ -0,0 +1,177 @@
+import { MdtRecord, RecordId } from "mdtScripts/common/Record";
+import { FieldPath } from "../../../helpers/types";
+import { QuerySortingObject } from "../../../services/api/QuerySorting";
+import { Field } from "mdtScripts/common/Field";
+import { ILayoutColumn } from "mdtScripts/views/list/ListViewOptions";
+export declare type GroupingItemPublic = Grouping.ListExtender.Options.Settings.GroupItem;
+export declare type GroupingItemDetails = Grouping.ListExtender.Options.Settings.ItemDetails;
+export declare type GroupingListExtenderPublicOptions = Grouping.ListExtender.Options;
+export interface GroupListExtenderOptions {
+    /**
+     * Группировочное поле
+     */
+    groupField: string;
+}
+export declare namespace Grouping {
+    interface Query {
+        groups?: Query.GroupItem[];
+        allParents?: boolean;
+        orphans?: boolean;
+        toggledValues?: string[][];
+        /** Только для APIv2.
+         * Если флаг указан, в ответе с группой API присылает пустая она или нет
+         */
+        calculateIsEmpty?: boolean;
+    }
+    namespace Query {
+        interface GroupItem {
+            fieldPath: FieldPath;
+            toggledValues?: any[];
+            withEmpty?: boolean;
+            /**
+             * @deprecated
+             * Направление сортировки группировочных записей (true - по убыванию, false - по возрастанию). Необходим для работы v1
+             */
+            sortDesc?: boolean;
+            collapsed?: boolean;
+            select?: string[];
+            sorting?: QuerySortingObject[];
+        }
+    }
+    type GroupLabel = {
+        title?: string;
+        icon?: string;
+        color?: string;
+        textColor?: string;
+    };
+    namespace Common { }
+    namespace ListExtender {
+        interface Options {
+            /** Настройки группировки */
+            settings?: Options.Settings;
+            /** Редактирование записей перетаскиванием */
+            dragDropEnabled?: boolean;
+            /** Дает пользователю возможность редактировать группировку */
+            userConfigurable?: boolean;
+        }
+        namespace Options {
+            interface Settings {
+                /** Настройки групп */
+                groups?: Omit<Settings.GroupItem, "sortDesc">[];
+                /** Отображать пустые группы */
+                allParents?: boolean;
+                /** Отображать записи без групп */
+                orphans?: boolean;
+                /** Обрабатывать группировочные строки как обычные записи, если их путь ссылается на FK поле на эту же таблицу */
+                treatSelfReferencingGroupsAsRecords?: boolean;
+                /** Если флаг включен, то у пустых групп будет скрыта иконка сворачивания.
+                 *  Работает только с APIv2
+                 */
+                calculateIsEmpty?: boolean;
+            }
+            namespace Settings {
+                interface GroupItem extends ItemDetails {
+                    /** Путь группировки */
+                    path: string;
+                    /** Схлопнута по умолчанию */
+                    collapsed?: boolean;
+                    /** Дополнительная информация по группе (только если путь ссылается на FK) */
+                    select?: string[];
+                    /** Настройки метки группы */
+                    label?: Grouping.GroupLabel | false;
+                    /** Иконка, отображаемая в заголовке столбца для данного уровня группировки */
+                    levelIcon?: string;
+                    /**
+                     * @deprecated
+                     * Направление сортировки группировочных записей (true - по убыванию, false - по возрастанию). Необходим для работы v1
+                     */
+                    sortDesc?: boolean;
+                    /**
+                     * Настройка сортировки группировочных записей.
+                     */
+                    sorting?: QuerySortingObject[];
+                    /**
+                     * Параметры отображения дополнительной информации, указанной в select.
+                     * Объект, где ключ - это путь к полю из массива select, а значение - объект с настройками отображения.
+                     *
+                     * @example
+                     * ```typescript
+                     * selectView: {
+                     *   "name": { title: "Название" },
+                     *   "description": { title: "Описание" }
+                     * }
+                     * ```
+                     *
+                     * Используется для настройки заголовков полей дополнительной информации,
+                     * которая отображается в группировочных строках для связанных записей.
+                     */
+                    selectView?: SelectView;
+                }
+                interface ItemDetails {
+                    /** Максимальная ширина дополнительной информации */
+                    detailsMaxWidth?: string;
+                    /** Отображение дополнительной информации в одну строку */
+                    detailsSingleLine?: boolean;
+                    /** Отображение значений полей дополнительной информации в одну строку */
+                    detailsValueSingleLine?: boolean;
+                }
+            }
+        }
+        type GroupItem = {
+            fieldPath: FieldPath;
+            fieldPathFull: string;
+            $field: Field;
+            $pathFields: Field[];
+            groupsForDrop: GroupItem[];
+        } & Options.Settings.GroupItem;
+        interface ApplyGroupingSettings {
+            groupSettings: Options.Settings.GroupItem[];
+            flagAllParents: boolean;
+            flagOrphans: boolean;
+        }
+        interface Column extends ILayoutColumn {
+            $grouping?: boolean;
+            $group?: Grouping.ListExtender.GroupItem;
+            $groupIndex?: number;
+        }
+    }
+}
+export declare type SelectView = {
+    [key: string]: {
+        title: string;
+    };
+};
+export interface GroupPayloadData {
+    Value: any;
+    Object?: MdtRecord;
+    Count: number;
+    Groups?: GroupData[];
+    /** Приходит только для APIv2 */
+    Empty?: boolean;
+}
+export interface GroupData extends GroupPayloadData {
+    Empty?: boolean;
+    $isLast?: boolean;
+}
+export interface GroupingRow {
+    $level: number;
+    $key: number | string;
+    $group: Grouping.ListExtender.GroupItem;
+    $groups: Grouping.ListExtender.GroupItem[];
+    $isLast?: boolean;
+    $data: GroupData;
+    $parentGroupsData: GroupData[];
+    $groupsDataFull: GroupData[];
+    $values: any[];
+    $pathValues: {
+        path: string;
+        value: any;
+    }[];
+    $groupingRow: boolean;
+    $system: boolean;
+    $attrs: any;
+    $expanded: boolean;
+    $hasChildGroups: boolean;
+    /** ID записи, если строка группировки соответствует записи этого же списка */
+    $id?: RecordId;
+}

package/types/_core/scripts/common/list/hierarchy/hierarchyTypes.d.ts

@@ -0,0 +1,48 @@
+import { Table } from "../../../common/Table";
+import { FieldCode } from "../../../helpers/types";
+import { IFilter } from "../../../services/IFilter";
+export declare type HierarchyMode = "" | "-" | "+" | "#";
+export interface HierarchyQuery {
+    /** Поле с ID родительской записи */
+    parentField?: FieldCode;
+    /** Поле ID записи */
+    primaryField?: FieldCode;
+    /**
+     * Режим фильтрации иерархии.
+     * "-" - Отображать всех родителей отфильтрованной записи,
+     * "+" - Отображать все дочерние записи отфильтрованной записи,
+     * "#" - Оторбражать все родительские и дочерние записи
+     */
+    mode?: HierarchyMode;
+    /** Фильтр для дочерних и родительских записей, не попадающих под критерии основной фильтрации списка */
+    filter?: IFilter;
+    table?: Table;
+    /**
+     * @default false
+     */
+    legacy?: boolean;
+}
+export interface HierarchyListExtenderPublicOptions extends Exclude<HierarchyQuery, "table"> {
+    /**
+     * Ключи наборов фильтров, при которых фильтрация считается наложенной. Используется для отображения кнопок режима фильтрации.
+     * Например: "default", "extended"
+     */
+    defaultFilterKeys?: string[];
+    /**
+     * Изменение иерархии с помощью перетаскивания
+     */
+    dragDropEnabled?: boolean;
+    /** Расширение кнопки типа иерархии
+     * @ignore
+     */
+    buttonExtend?: any;
+    /**
+     * Уровень до которого будут раскрыты узлы
+     */
+    expandedLevel?: number;
+    /**
+     *
+     * @default false
+     */
+    legacy?: boolean;
+}

package/types/_core/scripts/common/list/historyType/HistoryTypeListExtenderOptions.d.ts

@@ -0,0 +1,3 @@
+export interface HistoryTypeListExtenderOptions {
+    enabled: boolean;
+}

package/types/_core/scripts/common/list/labelStyle/LabelStylePublicOptions.d.ts

@@ -0,0 +1,6 @@
+export interface LabelStylePublicOptions {
+    /**
+     * Тип отображения: default - простое отображение стиля, icon - отображение с иконкой
+     */
+    viewStyle?: "default" | "icon";
+}

package/types/_core/scripts/common/list/legend/LegendListExtenderOptions.d.ts

@@ -0,0 +1,8 @@
+import { IButton } from "mdtScripts/views/form/controls/monacoEditor/jsonSchemas/Button.schema";
+export interface LegendListExtenderOptions {
+    items?: LegendItem[];
+}
+export interface LegendItem extends IButton {
+    title: string;
+    cssClass: string;
+}

package/types/_core/scripts/common/list/listView/ListViewListExtenderOptions.d.ts

@@ -0,0 +1,25 @@
+import { IFilter } from "mdtServices/IFilter";
+export interface ListViewListExtenderPublicOptions {
+    /**
+     * ListView, который будет применен к списку по умолчанию
+     */
+    active?: string;
+    /**
+     * Позволять менять выбранное по умолчанию представление в интерфейсе
+     */
+    activeChangeable?: boolean;
+    /**
+     * @default { "op": "in", "p1": "Title", "p2": ["Название ListView"] }
+     * @description
+     * Фильтр для списка ListView
+     * Пример фильтрации по названию:
+     * ```
+     * {
+     * 	"op": "in",
+     * 	"p1": "Title",
+     * 	"p2": ["Название ListView"]
+     * }
+     * ```
+     */
+    filter?: IFilter;
+}

package/types/_core/scripts/common/list/namedFilter/InMemoryNamedFilterOptions.d.ts

@@ -0,0 +1,23 @@
+import { IFilter } from "mdtServices/IFilter";
+export interface InMemoryNamedFilterListExtenderPublicOptions {
+    /** Группы фильтров */
+    groups: InMemoryNamedFilterListExtenderItem[];
+}
+export declare type InMemoryNamedFilterListExtenderOptions = InMemoryNamedFilterListExtenderPublicOptions;
+export interface InMemoryNamedFilterListExtenderItem {
+    /** Код группы */
+    code: string;
+    icon?: string;
+    order?: number;
+    select?: any;
+    /** Подсказка при наведении */
+    tooltip?: string;
+    filters: Array<{
+        /** Выбран по умолчанию */
+        selected?: boolean;
+        /** Заголовок фильтра */
+        title?: string;
+        /** Фильтр */
+        filter?: IFilter;
+    }>;
+}

package/types/_core/scripts/common/list/namedFilter/NamedFilterListExtenderPublicOptions.d.ts

@@ -0,0 +1,29 @@
+import { IFilter } from "mdtServices/IFilter";
+export interface NamedFilterListExtenderPublicOptions {
+    /**
+     * Код фильтра по умолчанию
+     */
+    active?: string;
+    /**
+     * Позволяет менять фильтр по умолчанию
+     */
+    activeChangeable?: boolean;
+    /**
+     * @default { "op": "in", "p1": "Title", "p2": ["Название именованного фильтра"] }
+     * @description
+     * Фильтр для списка доступных фильтров
+     * Пример фильтрации по названию:
+     * ```
+     * {
+     * 	"op": "in",
+     * 	"p1": "Title",
+     * 	"p2": ["Название именованного фильтра"]
+     * }
+     * ```
+     */
+    filter?: IFilter;
+    /**
+     * Список полей, которые доступны для фильтрации
+     */
+    fieldFilter?: string[];
+}

package/types/_core/scripts/common/list/reorder/ReorderListExtenderPublicOptions.d.ts

@@ -0,0 +1,4 @@
+export interface ReorderListExtenderPublicOptions {
+    orderField?: string;
+    startNumber?: number;
+}

package/types/_core/scripts/common/list/select/SelectPublicOptions.d.ts

@@ -0,0 +1,18 @@
+export interface SelectListPublicOptions {
+    /**
+     * Множественный выбор
+     */
+    multi?: boolean;
+    /**
+     * Выбор по нажатию на всю строку
+     */
+    wholeRow?: boolean;
+    /**
+     * Игнорирование отсутствия Primary-поля
+     */
+    ignorePrimaryFieldCheck?: boolean;
+    /**
+     * Максимальное количество одновременно выбранных записей
+     */
+    limit?: number;
+}

package/types/_core/scripts/common/list/styleField/StyleFieldListExtenderPublicOptions.d.ts

@@ -0,0 +1,3 @@
+export interface StyleFieldListExtenderPublicOptions {
+    styleField?: string;
+}

package/types/_core/scripts/common/list/toolbar/ToolbarPublicOptions.d.ts

@@ -0,0 +1,22 @@
+import { ViewElement } from "mdtScripts/helpers/types";
+export interface ToolbarPublicOptions {
+    /**
+     * Отображать количество записей
+     */
+    count?: boolean;
+    /**
+     * Отображать кнопку обновления
+     */
+    refresh?: boolean;
+    /**
+     * Добавление пользовательских элементов в левую область тулбара
+     */
+    zones?: {
+        left?: ViewElement[];
+    };
+    /**
+     * Скрыть меню расширенных кнопок
+     * @default true
+     */
+    hideMore?: boolean;
+}

package/types/_core/scripts/common/list/virtualScroll/VIrtualScrollPublicOptions.d.ts

@@ -0,0 +1,7 @@
+export interface VirtualScrollListPublicOptions {
+    /**
+     * Количество подгружаемых элементов
+     * @default 50
+     */
+    pageSize?: number;
+}

package/types/_core/scripts/common/serverMessage/ServerMessageTypes.d.ts

@@ -0,0 +1,17 @@
+import { MessageMetaData } from "mdtServices/api/ApiAccessorRequestAdapter/message/apiV2MessageTypes";
+import { ApiRequestOptions } from "mdtServices/api/ApiRequestOptions";
+declare type ServerMessageHandlerArg = {
+    param: string;
+    value: any;
+    paramObjId?: number;
+    messageAction: MessageMetaData;
+    requestContext: ServerMessageRequestContext<any>;
+};
+export interface ServerMessageRequestContext<T = unknown> {
+    url?: string;
+    requestData?: any;
+    responseData: T;
+    options?: ApiRequestOptions;
+}
+export declare type ServerMessageHandler = (arg: ServerMessageHandlerArg) => boolean | void;
+export {};

package/types/_core/scripts/components/baseFormControls/input/inputOptions.d.ts

@@ -0,0 +1,30 @@
+/// <reference types="../../../../mithril" />
+import { CSSClassName } from "../../../helpers/types";
+import { KeyboardActions } from "../../../helpers/ui/elementModificators/focusableComponent";
+import { ComponentSize } from "../../../helpers/utils/stringifyControlSize";
+export interface InputOptions {
+    id?: string;
+    /**
+     * Ожидать автозаполнения полей авторизации браузером.
+     * Если компонент используется на форме авторизации (например, в качестве поля логина или пароля), следует включить опцию для правильной обработки стиля автозаполнения.
+     * */
+    waitAutofill?: boolean;
+    value?: string | number;
+    type?: string;
+    placeholder?: string;
+    autofocus?: boolean;
+    autocomplete?: "on" | "off";
+    min?: number;
+    max?: number;
+    size?: ComponentSize;
+    readonly?: boolean;
+    hasError?: boolean;
+    keyboardActions?: KeyboardActions;
+    className?: CSSClassName;
+    onCreated?: (el: HTMLInputElement) => void;
+    /**
+     *
+     * @deprecated
+     */
+    attrs?: _mithril.MithrilAttributes;
+}

package/types/_core/scripts/components/baseFormControls/maskedInput/MaskFormatter.types.d.ts

@@ -0,0 +1,2 @@
+import IMask from "imask";
+export declare type MaskOptions = IMask.AnyMaskedOptions;

package/types/_core/scripts/components/button/baseButton/buttonOptions.d.ts

@@ -0,0 +1,12 @@
+import { ViewElement } from "mdtScripts/helpers/types";
+import { ComponentSize } from "mdtScripts/helpers/utils/stringifyControlSize";
+export interface ButtonOptions {
+    title?: string;
+    command?: () => void;
+    className?: string;
+    tooltip?: string;
+    enabled?: boolean;
+    icon?: string;
+    endElement?: ViewElement;
+    size?: ComponentSize;
+}

package/types/_core/scripts/components/buttonGroup/buttonGroupOptions.d.ts

@@ -0,0 +1,7 @@
+import { ButtonOptions } from "../button/baseButton/buttonOptions";
+export declare type GroupButtonOptions = ButtonOptions & {
+    selected: boolean;
+};
+export interface ButtonGroupOptions {
+    buttons: GroupButtonOptions[];
+}

package/types/_core/scripts/components/dropdown/menu/item/dropdownInputItemOptions.d.ts

@@ -0,0 +1,5 @@
+export interface DropdownInputItemOptions {
+    value: string;
+    onChange?: (value: string) => void;
+    config?: (el: HTMLElement, inited: boolean) => void;
+}

package/types/_core/scripts/components/dropdown/menu/item/dropdownItemWrapOptions.d.ts

@@ -0,0 +1,19 @@
+import { ViewElement } from "../../../../helpers/types";
+import { DropdownMenuItemBaseOptions, DropdownMenuItemOptions, DropdownMenuItemWithChildrenOptions } from "../../menuActionItem/dropdownMenuItemOptions";
+export interface DropdownItemBaseOptions {
+    className?: string;
+    idx?: number;
+}
+export interface DropdownItemOptions<T extends DropdownMenuItemBaseOptions = DropdownMenuItemBaseOptions> extends DropdownItemBaseOptions {
+    focused?: boolean;
+    actionItemOptions: T;
+}
+export declare type DropdownBaseItemOptions = DropdownItemOptions<DropdownMenuItemOptions>;
+export declare type DropdownItemWithMoreOptions = DropdownItemOptions<DropdownMenuItemWithChildrenOptions>;
+export interface DropdownItemWithCustomContentOptions extends DropdownItemBaseOptions {
+    content: ViewElement;
+}
+export interface DropdownMenuItemBaseFocusable {
+    focused?: boolean;
+}
+export declare type DropdownItemViewOptions = DropdownMenuItemOptions & DropdownMenuItemBaseFocusable;

package/types/_core/scripts/components/dropdown/menuActionItem/dropdownMenuItemOptions.d.ts

@@ -0,0 +1,32 @@
+import { Icon } from "../../../components/icon/iconOptions";
+import { FormattedText } from "../../../helpers/formattedText";
+import { CSSClassName, ViewElement, Valued } from "../../../helpers/types";
+export interface DropdownMenuItemBaseOptions {
+    icon?: Valued<Icon>;
+    title: Valued<ViewElement>;
+    additionalTitle?: string;
+    tooltip?: Valued<FormattedText>;
+    execute?: (e?: Event) => void;
+    visible?: () => boolean;
+    enabled?: () => boolean;
+    selected?: Valued<boolean>;
+    className?: CSSClassName;
+    zone?: DropdownMenuItemZones;
+    expanded?: boolean;
+    itemsShowOnHover?: boolean;
+}
+interface DropdownMenuItemZones {
+    right: () => ViewElement;
+}
+export interface DropdownMenuItemOptions extends DropdownMenuItemBaseOptions {
+    rightCaret?: boolean;
+    hrefTargetBlank?: boolean;
+    href?: Valued<string>;
+}
+export interface DropdownMenuItemWithChildrenOptions extends DropdownMenuItemBaseOptions {
+    moreBtn?: MoreButton;
+}
+interface MoreButton {
+    execute: (e?: Event) => void;
+}
+export {};

package/types/_core/scripts/components/form/fieldView/fieldViewOptions.d.ts

@@ -0,0 +1,13 @@
+import { ViewElement, LabelType } from "mdtScripts/helpers/types";
+import { LabelViewOptions } from "../label/labelOptions";
+export declare type FieldViewLabelMode = LabelType;
+export interface FieldLabelViewOptions extends LabelViewOptions {
+    labelMode?: FieldViewLabelMode;
+    handleLabelView?: (label: ViewElement) => ViewElement;
+    id?: string;
+}
+export interface FieldViewOptions extends FieldLabelViewOptions {
+    id?: string;
+    isLocked?: () => boolean;
+    control: ViewElement;
+}

package/types/_core/scripts/components/form/header/types.d.ts

@@ -0,0 +1,14 @@
+import { ViewElement } from "mdtScripts/helpers/types";
+export declare type HeaderSize = "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
+export interface HeaderViewOptions {
+    title: string;
+    description?: string;
+    icon?: string;
+    subtitle?: string;
+    size?: HeaderSize;
+    class?: string;
+    zones?: {
+        end?: ViewElement[];
+    };
+    onclick?: () => void;
+}

package/types/_core/scripts/components/form/label/labelOptions.d.ts

@@ -0,0 +1,22 @@
+import { IconButtonOptions } from "mdtScripts/components/iconButton/iconButtonOptions";
+import { FormattedText } from "mdtScripts/helpers/formattedText";
+import { CSSClassName, Valued } from "mdtScripts/helpers/types";
+export interface LabelIconButton {
+    name: string;
+    options: IconButtonOptions;
+}
+export interface LabelIconButtonOptions {
+    description?: string;
+    error?: string;
+    iconButtons?: Valued<LabelIconButton | undefined>[];
+}
+export interface LabelOptions extends LabelIconButtonOptions {
+    title: string;
+    required?: boolean;
+    tooltip?: Valued<FormattedText>;
+}
+export interface LabelViewOptions extends LabelOptions {
+    for?: string;
+    onClick?: () => void;
+    className?: CSSClassName;
+}

package/types/_core/scripts/components/icon/iconOptions.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="../../../../mithril" />
+import { CSSClassName } from "../../helpers/types";
+import { FormattedText } from "../../helpers/formattedText";
+export declare type Icon = string;
+export interface BaseIconOptions {
+    className?: CSSClassName;
+}
+export interface IconOptions extends BaseIconOptions {
+    fixedWidth?: boolean;
+    rotate?: "90" | "180" | "270";
+    flip?: "horizontal" | "vertical" | "both";
+    animate?: "spin" | "beat" | "fade" | "flash";
+    /** @deprecated */
+    attrs?: _mithril.MithrilAttributes;
+    title?: string;
+    tooltip?: FormattedText;
+    onmousedown?: () => void;
+    onclick?: (e?: MouseEvent) => void;
+    isDuoTone?: boolean;
+}
+export declare type IconElOptions = BaseIconOptions;

package/types/_core/scripts/components/iconButton/iconButtonOptions.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="../../../../mithril" />
+import { UiType } from "../../helpers/IUi";
+import { CommandEvent } from "../../helpers/types";
+import { IconOptions } from "../icon/iconOptions";
+export interface IconButtonOptions extends IconOptions {
+    command?: (e: CommandEvent) => void;
+    type?: UiType;
+    additionalIconElement?: _mithril.MithrilVirtualElement;
+}

package/types/_core/scripts/components/processPrincipalsList/ProcessPrincipalsListItem.d.ts

@@ -0,0 +1,5 @@
+import { RecordId } from "../../common/Record";
+export interface ProcessPrincipalsListItem {
+    id: RecordId;
+    title: string;
+}

package/types/_core/scripts/components/resizablePanels/panelTitle/panelTitleOptions.d.ts

@@ -0,0 +1,16 @@
+import { LabelIconButton } from "../../../components/form/label/labelOptions";
+import { FormattedText } from "../../../helpers/formattedText";
+import { CSSClassName, Valued, ViewElement } from "../../../helpers/types";
+export declare type PanelTitleTextContent = string;
+export interface PanelTitleOptions {
+    text: Valued<PanelTitleTextContent>;
+    tooltip?: Valued<FormattedText>;
+    endZone?: PanelTitleEndZone;
+    error?: Valued<string | undefined>;
+    icons?: Valued<LabelIconButton | undefined>[];
+    className?: Valued<CSSClassName>;
+    wrapperClassName?: string;
+}
+export interface PanelTitleEndZone {
+    view: () => ViewElement;
+}

package/types/_core/scripts/components/resizablePanels/panelToolbar/panelToolbarOptions.d.ts

@@ -0,0 +1,4 @@
+import { ButtonGroupOptions } from "mdtScripts/components/buttonGroup/buttonGroupOptions";
+export interface PanelToolbarOptions {
+    buttonGroup: ButtonGroupOptions;
+}