mdt-client 31.3.36 → 31.3.38

package/package.json

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

package/types/_core/scripts/common/Datasource.d.ts

@@ -0,0 +1,9 @@
+import { Table } from "./Table";
+import { Query } from "../services/api/Query";
+import { ApiRequestOptions } from "../services/api/ApiRequestOptions";
+export interface Datasource {
+    fetch(query: Query, table: Table, options?: ApiRequestOptions, batch?: boolean, meta?: any): any;
+    save?(data: any, params?: any, options?: ApiRequestOptions): PromiseLike<any>;
+    delete?(ids: any[], table: Table): any;
+    table?: Table;
+}

package/types/_core/scripts/common/Field.d.ts

@@ -0,0 +1,51 @@
+import { FieldCode, FieldKind, Valued } from "../helpers/types";
+import { IFilter } from "../services/IFilter";
+import { Record } from "./Record";
+import { Table } from "./Table";
+export interface Field extends Record {
+    id?: any;
+    code?: FieldCode;
+    title?: string;
+    type?: string;
+    codeLowered?: string;
+    code$?: string;
+    code$Lowered?: string;
+    refTableCode?: string;
+    description?: string;
+    table?: Table;
+    nullable?: boolean;
+    identity?: boolean;
+    primary?: boolean;
+    hidden?: boolean;
+    id_RefObject?: number;
+    id_RefObjectField?: number;
+    kind?: FieldKind;
+    length?: number;
+    hasDefault?: boolean;
+    extended?: boolean;
+    isFixedLength?: boolean;
+    defaultValue?: string | number | boolean | Date;
+    formatMask?: string;
+    computed?: boolean;
+    fulltext?: boolean;
+    refTable?: Table;
+    readonly?: boolean;
+    multiple?: boolean;
+    refFilter?: Valued<IFilter>;
+    validate?: Function;
+    /**
+     * Флаг, указывающий, что поле скрыто по умолчанию в списке и на форме
+     */
+    flagHiddenByDefault?: boolean;
+    min?: number;
+    max?: number;
+    /**
+     * `FieldSettings` {@link module ui/_core/scripts/common/FieldSettings.schema} в JSON формате.
+     * Задается через форму редактирования поля в пользовательском интерфейсе, приходит с API в виде строки.
+     * Не следует использовать напрямую, вместо этого используйте SchemaManager.getFieldSettings.
+     */
+    settings?: string;
+    dynamicFkObjectPath?: string;
+    id_DynamicFkRecordObjectField?: number;
+    dynamicFkRecordObjectFieldCode?: string;
+}

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

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

package/types/_core/scripts/common/MdtField.d.ts

@@ -0,0 +1,9 @@
+import { MdtObject } from "./MdtObject";
+import { Record } from "./Record";
+export interface MdtField extends Record {
+    ID?: number;
+    ID_Object?: number;
+    ID_Object$?: MdtObject;
+    Deleted?: number;
+    Code?: string;
+}

package/types/_core/scripts/common/MdtObject.d.ts

@@ -0,0 +1,7 @@
+import { Record } from "./Record";
+export interface MdtObject extends Record {
+    ID?: number;
+    OBJECT_ID?: number;
+    Deleted?: boolean;
+    Code?: string;
+}

package/types/_core/scripts/common/Record.d.ts

@@ -0,0 +1,27 @@
+import { Table } from "./Table";
+export declare type RecordId = number | string;
+declare type PrimitiveTypes = string | number | boolean;
+export declare type RecordValue = PrimitiveTypes | Record | Array<RecordValue> | null | undefined;
+/**
+ * @deprecated use MdtRecord
+ */
+export interface Record {
+    $id?: RecordId;
+    $table?: Table;
+    $diff?: Record;
+    $new?: boolean;
+    $dirty?: boolean;
+    $destroy?: boolean;
+    $dep?: boolean;
+    $fk?: string;
+    [field: string]: any;
+}
+export declare type MdtRecord = Record;
+export declare type ApiRecordForSave = Omit<MdtRecord, "$table"> & {
+    $table: string;
+};
+export declare type HierarchicalRecord<R = MdtRecord> = R & {
+    $hierarchy?: HierarchicalRecord<R>[];
+    $matched?: boolean;
+};
+export {};

package/types/_core/scripts/common/Table.d.ts

@@ -0,0 +1,66 @@
+import { Icon } from "../components/icon/iconOptions";
+import { ModuleId, ObjectCode, ObjectId, ObjectTitle } from "../helpers/types";
+import { PermissionLevel } from "../security/PermissionLevel";
+import { Datasource } from "./Datasource";
+import { Field } from "./Field";
+import { Record } from "./Record";
+export interface Table extends Record, StoredProcedure {
+    $id?: ObjectId;
+    id?: ObjectId;
+    object_id?: number;
+    title?: ObjectTitle;
+    titlePlural?: string;
+    description?: string;
+    code?: ObjectCode;
+    abstract?: boolean;
+    defaultFieldCode?: string;
+    defaultField?: Field;
+    fields?: Field[];
+    primaryField?: Field;
+    map?: {
+        [k: string]: Field;
+    };
+    mapLowered?: any;
+    $datasource?: Datasource;
+    id_ObjectType?: string;
+    tag_Enabled?: any;
+    accessLevel?: PermissionLevel;
+    children?: Array<string>;
+    readonly?: boolean;
+    icon?: Icon;
+    id_ver_Module?: ModuleId;
+    audit_Enabled?: boolean;
+    inline_AddInRow?: boolean;
+    inline_Enabled?: boolean;
+    hierarchyParentField?: string;
+    hierarchyIDField?: string;
+    flagHierarchy?: boolean;
+    $original?: Table;
+    $system?: boolean;
+    /**
+     * Признак того, что объект присутствует в базе данных и получен из схемы API
+     */
+    $dbObject?: boolean;
+}
+export interface StoredProcedure {
+    parameters?: ObjectParam[];
+}
+export interface ObjectParam {
+    code?: string;
+    dataType?: string;
+}
+export interface ApiObjectData {
+    code: string;
+    title: string;
+    fields: ApiObjectField[];
+    description?: string;
+}
+export interface ApiObjectField {
+    code: string;
+    type: string;
+    nullable?: boolean;
+    refTableCode: ObjectCode;
+    /** title и description можно задать кодом в C# */
+    title?: string;
+    description?: string;
+}

package/types/_core/scripts/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/_core/scripts/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/_core/scripts/common/list/cacheUpdateTime/CacheUpdateTimePublicOptions.d.ts

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

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

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

package/types/_core/scripts/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/_core/scripts/common/list/columnMenu/QuickFilterOptions.d.ts

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

package/types/_core/scripts/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/_core/scripts/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/_core/scripts/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/_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[];
+}