mdt-client 31.3.29 → 31.3.31

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "mdt-client",
-	"version": "31.3.29",
+	"version": "31.3.31",
 	"description": "",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",

package/types/common/FieldSettings.schema.d.ts

@@ -2,7 +2,7 @@ import IMask from "imask";
 export interface FieldSettings {
     /**
      * Маска отображает значение в заданном формате в списке и на форме. Например, число можно отобразить как "1 234,56" или "1234.56".
-     * [Подробнее о маске в документации](https://ics-it.gram.ax/mdt/content/list/dataView/formatMask).
+     * [Подробнее о маске в документации](https://ics-it.gram.ax/mdt/content/dataView/formatMask).
      */
     maskOptions?: IMask.AnyMaskedOptions;
 }

package/types/common/form/tabs/TabsFormExtenderOptions.d.ts

@@ -0,0 +1,12 @@
+export interface TabsFormExtenderPublicOptions {
+    tabs: FormTab[];
+}
+export interface FormTab {
+    code?: string;
+    icon?: string;
+    title: string;
+    layout?: any;
+    order?: number;
+    visible?: () => boolean;
+    onShow?: (init: boolean) => void;
+}

package/types/common/list/aggregation/AggregayionTypes.d.ts

@@ -0,0 +1,2 @@
+import { ApiV1 } from "mdtServices/api/ApiAccessor/apiV1Types";
+export declare type AggregationType = ApiV1.AggregationType;

package/types/common/list/cacheUpdateTime/CacheUpdateTimePublicOptions.d.ts

@@ -0,0 +1,6 @@
+export interface CacheUpdateTimePublicOptions {
+    /**
+     * Название параметра, содержащего дату
+     */
+    param: string;
+}

package/types/common/list/cellControlExtender/CellControlExtender.d.ts

@@ -0,0 +1 @@
+export declare type CellControlExtenderOptions = {};

package/types/common/list/columnMenu/ColumnMenuOptions.d.ts

@@ -0,0 +1,17 @@
+import { QuickFilterOptions } from "./QuickFilterOptions";
+import { ValuesFilterOptions } from "./ValuesFilterOptions";
+/**
+ * @title Настройки выпадающего меню в колонке
+ * @description Настройки задаются по пути в колонке. Например, `Title` или `ID_Department/Title`.
+ * @defaultSnippets [{ "label": "Настройка по умолчанию", "body": { "$1": { "valuesFilter": {} }}}]
+ */
+export interface ColumnMenuOptions {
+    [column: string]: ColumnMenuItemOptions;
+}
+export interface ColumnMenuItemOptions {
+    valuesFilter?: ValuesFilterOptions;
+    /**
+     * Настройки фильтра колоночного меню
+     */
+    quickFilter?: QuickFilterOptions;
+}

package/types/common/list/columnMenu/QuickFilterOptions.d.ts

@@ -0,0 +1,7 @@
+export interface QuickFilterOptions {
+    /**
+     * Задержка перед выполнением поиска (ms).
+     * @default 600
+     */
+    delayBeforeSearch?: number;
+}

package/types/common/list/columnMenu/ValuesFilterOptions.d.ts

@@ -0,0 +1,24 @@
+import { QuerySorting } from "mdtServices/api/QuerySorting";
+/**
+ * Настройки фильтра по значениям
+ * @defaultSnippets
+ * [
+ *  {
+ *   "label": "Пример настройки",
+ *   "body": { "sorting": [{ "path": "$1", "asc": true }], "mode": "show" }
+ *  }
+ * ]
+ */
+export interface ValuesFilterOptions {
+    /**
+     * Настройки сортировки
+     */
+    sorting?: QuerySorting[];
+    /**
+     * Режим отображения фильтра по значениям в меню колонки:
+     * - show - показать фильтр. Используется по умолчанию.
+     * - submenu - показать фильтр в подменю.
+     * - hide - скрыть фильтр.
+     */
+    mode?: "show" | "submenu" | "hide";
+}

package/types/common/list/form/FormListPublicOptions.d.ts

@@ -0,0 +1,40 @@
+import { Button as ButtonPub } from "mdtScripts/views/form/controls/monacoEditor/jsonSchemas/Button.schema";
+import { FormPageOptions } from "mdtScripts/views/form/schema/FormPageOptions.schema";
+import { FormPageExtOptions } from "mdtScripts/views/form/schema/FormPageExtOptions.schema";
+export interface FormListPublicOptions {
+    /**
+     * Открытие формы в модальном окне
+     */
+    modal?: boolean;
+    /**
+     * Открытие формы в боковой панели
+     */
+    sidebar?: boolean;
+    /** Настройки формы */
+    options?: FormPageOptions;
+    /** Настройки расширений формы */
+    extOptions?: FormPageExtOptions;
+    /**
+     * Отображение кнопки "удалить"
+     */
+    delete?: boolean;
+    /**
+     * Отображение кнопки "добавить"
+     */
+    add?: boolean;
+    /**
+     * Отображение кнопки "редактировать"
+     */
+    edit?: boolean;
+    /**
+     * Отображение колонки с кнопками "редактировать" для записей.
+     * По умолчанию колонка отображается.
+     */
+    editColumn?: boolean;
+    /**
+     * Иконка кнопки "редактировать"
+     */
+    editIcon?: string;
+    /** Расширение кнопки "добавить" */
+    addButton?: ButtonPub;
+}

package/types/common/list/gallery/GalleryListExtenderPublicOptions.d.ts

@@ -0,0 +1,11 @@
+import { ImageFetchOptions } from "mdtScripts/views/gallery/ImageFetchOptions";
+export interface GalleryListExtenderPublicOptions {
+    /** Отображение кнопки скачивания zip */
+    downloadZipButton?: boolean;
+    /** Отображение кнопки распечатки */
+    printButton?: boolean;
+    /** Настройка изображения предпросмотра */
+    thumb?: ImageFetchOptions;
+    /** Отображение кнопок поворота изображения */
+    showRotateButtons?: boolean;
+}

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

@@ -1,8 +1,20 @@
+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 Group {
-        groups?: GroupItem[];
+    interface Query {
+        groups?: Query.GroupItem[];
         allParents?: boolean;
         orphans?: boolean;
         toggledValues?: string[][];
@@ -11,16 +23,20 @@ export declare namespace Grouping {
          */
         calculateIsEmpty?: boolean;
     }
-    interface GroupItem {
-        fieldPath: FieldPath;
-        collapsed?: boolean;
-        select?: FieldPath[];
-        sorting?: QuerySortingObject[];
-        label?: GroupLabel | false;
-        levelIcon?: string;
-        toggledValues?: any[];
-        withEmpty?: boolean;
-        sortDesc?: 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;
@@ -28,4 +44,134 @@ export declare namespace Grouping {
         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/common/list/historyType/HistoryTypeListExtenderOptions.d.ts

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

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

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

package/types/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/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/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/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/common/list/reorder/ReorderListExtenderPublicOptions.d.ts

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

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

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

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

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

package/types/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/common/list/virtualScroll/VIrtualScrollPublicOptions.d.ts

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

package/types/components/textWithIcon/textWithIconOptions.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="../../../../mithril" />
+/// <reference types="mithril" />
+import { ViewElement } from "mdtScripts/helpers/types";
+import { IconOptions } from "../icon/iconOptions";
+export interface TextWithIconOptions {
+    icon?: BeforeTextIconOptions;
+    textContent: TextContentOptions;
+}
+export interface BeforeTextIconOptions {
+    name: string;
+    options?: IconOptions;
+}
+export interface TextContentOptions {
+    text: ViewElement | string[];
+    className?: string;
+    attrs?: _mithril.MithrilAttributes;
+}

package/types/data/fieldFilter/ToolbarFieldFilterOptions.d.ts

@@ -0,0 +1,21 @@
+import { FieldPath } from "mdtScripts/helpers/types";
+import { BaseQuery } from "mdtServices/api/BaseQuery";
+import { IFilter } from "mdtServices/IFilter";
+/**
+ * @defaultSnippets [[{ "label": "Настройка по умолчанию", "body": { "query": { "filter": { "op": "eq", "p1": "$1", "p2": "$2" } }}}]
+ */
+export interface ToolbarAutopickOptions {
+    query: {
+        filter: IFilter;
+    };
+}
+export interface ToolbarFieldFilterListExtenderOptions {
+    /** Путь до поля по которому будет фильтроваться список */
+    fieldPath: FieldPath;
+    /** Наименование кнопки в тулбаре */
+    title?: string;
+    /** Дополнительные настройки для запроса значений фильтра */
+    query?: Omit<BaseQuery, "select">;
+    /** Настройки автоматического выбора фильтра по заданному условию */
+    autopick?: ToolbarAutopickOptions;
+}

package/types/helpers/dateUtils.d.ts

@@ -0,0 +1,23 @@
+export declare const regexIso8601DateOnly: RegExp;
+export declare function toISOString(date: Date, dateOnly?: boolean): string;
+export declare function toISO8601DateString(date: Date): ISO8601DateString;
+export declare function toUiDateString(date: Date): string;
+export declare function toTimeString(date: Date): string;
+export declare function toDateTimeNotZApiFormat(date: Date): string;
+export declare function dateTimeModelFromUiDateString(dateString: MdtDateStringFormat): DateTimeModel;
+export declare function dateFromUiDateString(dateString: MdtDateStringFormat): Date;
+export interface DateTimeModel {
+    day: number;
+    monthIndex: number;
+    year: number;
+    time?: {
+        hours: number;
+        minutes: number;
+        seconds: number;
+    };
+}
+/**
+ * Строка с датой в формате "dd.mm.yyyy hh:mm:ss" или "dd.mm.yyyy"
+ */
+export declare type MdtDateStringFormat = string;
+export declare type ISO8601DateString = string;

package/types/services/api/ApiAccessor/apiV1Types.d.ts

@@ -139,7 +139,7 @@ export declare namespace ApiV1 {
                     ticket: string;
                     list: RecordId[];
                 };
-                $audit: {
+                $audit?: {
                     ticket: string;
                 };
                 /**

package/types/services/api/ApiAccessor/apiV2Types.d.ts

@@ -270,10 +270,7 @@ export declare namespace ApiV2 {
                     ticket: string;
                 };
                 dependency?: FetchDependencyTypes.RecordExtResponse;
-                hierarchy?: {
-                    hasChildren: boolean;
-                    children?: Row[];
-                };
+                hierarchy?: Exts.Hierarchy;
                 binding?: {
                     status: BindingRowTypes;
                 };
@@ -301,12 +298,17 @@ export declare namespace ApiV2 {
             }
             interface Exts {
                 hierarchyLegacy?: Exts.HierarchyLegacy;
+                hierarchy?: Exts.Hierarchy;
                 group?: Exts.GroupQuery;
             }
             namespace Exts {
                 interface HierarchyLegacy {
                     rows: HierarchicalRecord[];
                 }
+                interface Hierarchy {
+                    hasChildren: boolean;
+                    children?: Fetch.Row[];
+                }
                 interface GroupQuery {
                     groups: OutputGroup[];
                     skippedRowsCount?: number;

package/types/services/api/ApiAccessor/binding/bindingApiTypes.d.ts

@@ -28,10 +28,15 @@ export interface UnbindingDataItemTypes {
     DateEnd?: Date | unknown;
 }
 export declare type BindingRowTypes = "Bound" | "NotBound" | "BoundOutside";
+export interface BindingFilterParams {
+    targetRecordIds?: RecordId[];
+    dimensionId?: RecordId;
+    customFilterId?: RecordId;
+}
 export interface BindingExtData {
-    BindingObjectId?: RecordId;
-    Date?: Date | unknown;
-    Filter?: {
-        Status?: BindingRowTypes;
-    };
+    bindingObjectId?: RecordId;
+    date?: Date | unknown;
+    filter?: {
+        status?: BindingRowTypes;
+    } & BindingFilterParams;
 }

package/types/services/api/BaseQuery.d.ts

@@ -19,5 +19,7 @@ export interface BaseQuery {
      * { "search": "Some value" }
      */
     functionParams?: Record<string, any>;
+    /** Получение уникальных записей */
+    distinct?: boolean;
 }
 export declare type QuerySelect = string[];