mdt-client 31.3.39 → 31.3.41

package/types/_core/scripts/views/list/schema/ListPageOptions.schema.d.ts

@@ -0,0 +1,145 @@
+import { ActivationListAdapterOptions } from "../../../data/active/ActivationListAdapterTypes";
+import { FormPageOptions } from "../../../views/form/schema/FormPageOptions.schema";
+import { QuerySorting } from "../../../services/api/QuerySorting";
+import { BaseQuery } from "../../../services/api/BaseQuery";
+import { IFilter } from "../../../services/IFilter";
+declare type WhiteSpaceType = "normal" | "nowrap" | "pre" | "pre-line" | "pre-wrap" | "inherit";
+export interface ListPageOptions {
+    /** Настройки получения данных */
+    paging?: {
+        /** Количество записей, подгружаемых в память при прокрутке списка */
+        size?: number;
+        /** Настройка сортировки по-умолчанию */
+        sorting?: {
+            list: QuerySorting[];
+        };
+        /** Добавлять информацию об общем количестве записей в запрос */
+        withCount?: boolean;
+    };
+    /** Выполнять запросы списка в фоновом режиме */
+    background?: boolean;
+    /** Код макет списка */
+    layout?: string;
+    /** Код списка */
+    code?: string;
+    /** Контейнер для дочерних пользовательских интерфейсов */
+    container?: "modal" | "sidebar";
+    /**
+     * @title Высота списка
+     * @description Если задать число, то высота будет в "px"
+     */
+    maxHeight?: number | string;
+    /** Фильтр по-умолчанию на таблицу */
+    filter?: IFilter | (() => IFilter | undefined);
+    /** Скрыть скелетон загрузки */
+    hideLoading?: boolean;
+    /** Скрыть полосу загрузки */
+    hideProgressBar?: boolean;
+    /** Показывать ссылки на внешние таблицы в виде сылок */
+    fkLinks?: boolean;
+    /** Разрешить редактирование форм, открытых по нажатию на ссылки на внешние таблицы */
+    fkLinksEditable?: boolean;
+    /** Установить опции для формы, открывающейся по нажатию на ссылку у FK */
+    fkLinksFormOptions?: {
+        [k: string]: FormPageOptions;
+    };
+    /** Запретить редактирование списка */
+    readonly?: any;
+    /** Запрашивать дополнительную информацию по путям, не отображающимся в списке */
+    addSelect?: string[];
+    /** Дополнительные параметры запроса к данным */
+    query?: BaseQuery;
+    /** Автообновление данных в списке (в миллисекундах) */
+    autoRefresh?: number;
+    /**
+     * Отображать чередующиеся цвета строк
+     * @default true
+     */
+    striped?: boolean;
+    /**
+     * Определяет как будут отображаться пробелы в данных:
+     *
+     * normal - текст в окне браузера выводится как обычно, переносы строк устанавливаются автоматически
+     *
+     * nowrap - пробелы не учитываются, переносы строк игнорируются, весь текст отображается одной строкой
+     *
+     * pre - текст показывается с учетом всех пробелов и переносов
+     *
+     * pre-line - в тексте пробелы не учитываются, текст автоматически переносится на следующую строку, если он не помещается в заданную область
+     *
+     * pre-wrap - в тексте сохраняются все пробелы и переносы, однако если строка по ширине не помещается в заданную область, то текст автоматически будет перенесен на следующую строку.
+     *
+     * inherit - наследует значение родителя
+     * */
+    whiteSpace?: WhiteSpaceType;
+    /**
+     * Определяет как будут отображаться пробелы в заголовке:
+     *
+     * normal - текст в окне браузера выводится как обычно, переносы строк устанавливаются автоматически
+     *
+     * nowrap - пробелы не учитываются, переносы строк игнорируются, весь заголовок отображается одной строкой
+     *
+     * pre - заголовок показывается с учетом всех пробелов и переносов
+     *
+     * pre-line - в заголовке пробелы не учитываются, текст автоматически переносится на следующую строку, если он не помещается в заданную область
+     *
+     * pre-wrap - в заголовке сохраняются все пробелы и переносы, однако если строка по ширине не помещается в заданную область, то текст автоматически будет перенесен на следующую строку.
+     *
+     * inherit - наследует значение родителя
+     * */
+    whiteSpaceHeader?: WhiteSpaceType;
+    /**
+     * Управление активностью записей
+     */
+    activation?: ActivationListAdapterOptions | false;
+    /**
+     * @title Настройка заголовка колонки
+     * @description default - заголовок поля с переводом, code - код поля без перевода
+     * @default default
+     */
+    columnTitle?: "default" | "code";
+    /**
+     * Отключить фиксацию таблицы при прокрутке
+     * @TJS-type boolean
+     * @TJS-enum [true]
+     */
+    disableFixOnScroll?: boolean;
+    /**
+     * Включение/отключение фиксации колонок. По умолчанию true.
+     */
+    fixedColumns?: boolean | {
+        /**
+         * Максимальное количество фиксированных колонок. По умолчанию 3.
+         */
+        maxColumns?: number;
+        /**
+         * Изначальное количество фиксированных колонок (без системных). Применяется если пользователь ранее не выбирал количество фиксированных колонок.
+         */
+        initialFixedColumns?: number | "none";
+    };
+    /**
+     * Настройки агрегации
+     */
+    aggregation?: {
+        /**
+         * Подключение агрегации к списку. По умолчанию `true`.
+         */
+        enabled?: boolean;
+    };
+    /**
+     * @title Ограничение количества строк в ячейках
+     * @description Настройка начального значения количества отображаемых строк в ячейках списка по умолчанию. Используется только если пользователь ранее не выбирал значение.
+     */
+    rowClamp?: number;
+    /**
+     * Настройки списка из иконки "ещё" для o2m колонок
+     * @defaultSnippets [{ "label": "Настройки списка из иконки `ещё`", "body": { "$1": { "listOptions": {} } } }]
+     */
+    showMoreOptions?: ShowMoreOptions;
+}
+export interface ShowMoreOptions {
+    [column: string]: {
+        listOptions?: ListPageOptions;
+    };
+}
+export {};

package/types/_core/scripts/views/list/tabular/TabularListTypes.d.ts

@@ -0,0 +1,53 @@
+import { ApiV2 } from "../../../services/api/ApiAccessor/apiV2Types";
+export declare type TabularListSettings = {
+    columns: TabularListColumn[];
+    query?: Partial<TabularFetch.Request>;
+};
+export declare type TabularListColumn = {
+    name: string;
+    table: string;
+    /**
+     * Алиас для колонки. Должен быть уникальным.
+     */
+    alias?: string;
+};
+export declare namespace TabularFetch {
+    type Request = Pick<ApiV2.Request.Fetch, "skip" | "take" | "distinct"> & {
+        select: Request.Select;
+        orderBy?: Request.OrderBy;
+        filter?: Request.Filter;
+        groupBy?: Request.GroupBy;
+        table?: string;
+    };
+    namespace Request {
+        export type Select = SelectItem[];
+        export type SelectItem = PathToColumn<ApiV2.Request.Fetch.SelectItem>;
+        export type OrderBy = OrderByItem[];
+        export type OrderByItem = PathToColumn<ApiV2.Request.Fetch.OrderByItem>;
+        export type Filter = PathToColumn<ApiV2.Filter.Simple> | PathToColumn<ApiV2.Filter.List> | FilterSubQuery | Group;
+        export type FilterSubQuery = Omit<ApiV2.Filter.SubQuery, "query" | "path"> & WithColumn & {
+            query: FilterSubQueryExpression;
+        };
+        export type FilterSubQueryExpression = Omit<ApiV2.Filter.SubQueryExpression, "filter"> & {
+            filter: Filter;
+        };
+        type Group = Omit<ApiV2.Filter.Multi, "groups"> & {
+            groups: Filter[];
+        };
+        export type GroupBy = WithColumn[];
+        export {};
+    }
+    type Response = ApiV2.Response.Fetch;
+}
+declare type ColumnData = {
+    table: string;
+    name: string;
+};
+declare type WithColumn = {
+    column: ColumnData;
+};
+/**
+ * Преобразует тип, убирая поле строковой path и добавляя поле column с таблицей и именем колонки
+ */
+declare type PathToColumn<T> = Omit<T, "path"> & WithColumn;
+export {};

package/types/_core/scripts/views/page/PageZoneTypes.d.ts

@@ -0,0 +1 @@
+export declare const PageZoneCodes: readonly ["top.left", "nav.left", "nav.right"];