mdt-client 31.3.20 → 31.3.22

package/package.json

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

package/types/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/data/periods/helpers/types.d.ts

@@ -0,0 +1,4 @@
+export declare enum PeriodBoundaryIcon {
+    BEGIN = "minus",
+    END = "plus"
+}

package/types/helpers/formatOptions.d.ts

@@ -1,4 +1,5 @@
 import { MaskOptions } from "mdtScripts/components/baseFormControls/maskedInput/MaskFormatter.types";
+import { PeriodBoundaryIcon } from "mdtScripts/data/periods/helpers/types";
 export interface FormatOptions {
     type?: string;
     title?: string;
@@ -11,4 +12,5 @@ export interface FormatOptions {
      * Настройки маски
      */
     maskOptions?: MaskOptions;
+    dateRangeIcon?: PeriodBoundaryIcon;
 }

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

@@ -1,11 +1,12 @@
+import { BindingExtData, BindingRowTypes } from "./binding/bindingApiTypes";
+import { MessageUiType, UiType } from "mdtScripts/helpers/IUi";
+import { PermissionLevelString } from "mdtScripts/security/PermissionLevel";
 import { HierarchicalRecord, MdtRecord, RecordId } from "../../../../scripts/common/Record";
 import { AnyObject, ColorStyle, FieldPath, LanguageId, Markdown, ModuleId, ObjectCode, ObjectId, ObjectTitle } from "../../../../scripts/helpers/types";
 import { FETCH_COUNT_ALIAS } from "../ApiAccessorRequestAdapter/handlers/fetch/helpers/count/count";
+import { WithExpandedIds } from "../ApiAccessorRequestAdapter/handlers/fetch/helpers/query/exts/hierarchy/hierarchyQueryHelpersTypes";
 import { DataExtraInformation } from "../ApiAccessorRequestAdapter/handlers/messageTypes";
 import { ApiV1 } from "./apiV1Types";
-import { WithExpandedIds } from "../ApiAccessorRequestAdapter/handlers/fetch/helpers/query/exts/hierarchy/hierarchyQueryHelpersTypes";
-import { PermissionLevelString } from "../../../../scripts/security/PermissionLevel";
-import { MessageUiType, UiType } from "../../../../scripts/helpers/IUi";
 export declare namespace ApiV2 {
     namespace Request {
         type Common = (Save | AnyObject) & WithMessageAction;
@@ -116,6 +117,7 @@ export declare namespace ApiV2 {
                 workflow?: Exts.Workflow;
                 workflowStage?: Exts.WorkflowStage;
                 mapping?: Exts.Mapping;
+                binding?: Exts.Binding;
                 [k: string]: AnyObject | undefined;
             }
             namespace Exts {
@@ -194,6 +196,7 @@ export declare namespace ApiV2 {
                 interface Mapping {
                     flagGetMappedFKs: boolean;
                 }
+                type Binding = BindingExtData;
             }
         }
     }
@@ -271,6 +274,9 @@ export declare namespace ApiV2 {
                     hasChildren: boolean;
                     children?: Row[];
                 };
+                binding?: {
+                    status: BindingRowTypes;
+                };
                 /**
                  * Ограничения на действия (CRUD) над записью и её полями, накладываемые функцией безопасности.
                  * [Документация](https://ics-it.gram.ax/mdt/security/objectSecurity/sqlFn?l=ru)

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

@@ -0,0 +1,37 @@
+import { MdtRecord, RecordId } from "../../../../common/Record";
+export interface BindingFormData {
+    ID_ObjectTarget: number;
+    ID_ObjectSource: number;
+    ID_TargetRecord: number;
+    ID_SourceRecords: RecordId[];
+    ID_DimensionRecords: MdtRecord[];
+    FlagTotalPeriod: boolean;
+    DateBegin?: Date;
+    DateEndFix?: Date;
+}
+export interface BindingRequestData {
+    TargetObjectId: RecordId;
+    SourceObjectId: RecordId;
+    TargetRecordId: RecordId;
+    SourceRecordIds: RecordId[];
+    FlagTotalPeriod: boolean;
+    DimensionRecordIds?: RecordId[];
+    DateBegin?: Date | unknown;
+    DateEnd?: Date | unknown;
+}
+export interface UnbindingRequestData {
+    ObjectId: RecordId;
+    Items: UnbindingDataItemTypes[];
+}
+export interface UnbindingDataItemTypes {
+    BindingId: RecordId;
+    DateEnd?: Date | unknown;
+}
+export declare type BindingRowTypes = "Bound" | "NotBound" | "BoundOutside";
+export interface BindingExtData {
+    BindingObjectId?: RecordId;
+    Date?: Date | unknown;
+    Filter?: {
+        Status?: BindingRowTypes;
+    };
+}

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

@@ -0,0 +1,12 @@
+export interface IFormLayout {
+    rows: IFormLayoutRow[];
+}
+interface IFormLayoutRow {
+    cols: IFormLayoutColType[];
+}
+export declare type IFormLayoutColType = {
+    type: string;
+    width: number;
+    options: any;
+};
+export {};

package/types/services/customModules/facades/ILegacyFacade.d.ts

@@ -112,6 +112,7 @@ export interface ILegacyFacade {
     isApiV2: () => boolean;
     ProgressBarCtrl: any;
     ProgressBarStateController: any;
+    getChartElByCode: (code: string) => Element;
 }
 export interface ModulesLegacyFacade {
     pbi?: {
@@ -121,6 +122,9 @@ export interface ModulesLegacyFacade {
         FormValueManager: any;
         EtlPanel: any;
     };
+    dm?: {
+        MergeHelper: any;
+    };
     mapping?: {
         MappingListExtender: any;
         MappingManager: any;

package/types/services/customModules/facades/List/IListControlFacade.d.ts

@@ -42,7 +42,7 @@ export interface IListControlFacade extends ParentCtrl {
     updateCommand(findCondition: (button: ButtonFacade) => boolean, command: Partial<ButtonFacade>): void;
     /** Открыть форму добавления записи */
     openNewRecordForm(): void;
-    /** Удалить выделенные строки */
+    /** Удалить из списка выделенные записи */
     removeSelectedRows(): void;
     /** Открыть конструктор списка */
     openDesigner(): Promise<void>;

package/types/services/customModules/facades/formDashboard/IFormDashboard.d.ts

@@ -1,4 +1,5 @@
 import { MithrilControl } from "mdtScripts/helpers/types";
+import { IFormLayout } from "../Form/IFormLayout";
 export interface IFormDashboard {
     /**
      * Настройка дашборда. Возвращает объект для управления дашбордом.
@@ -12,4 +13,8 @@ export interface IFormDashboardFacade {
      * Добавляет компонент на дашборд в указанную позицию
      */
     addComponent: (component: () => MithrilControl, position: ComponentPosition) => void;
+    /**
+     * Устанавливает настройки лейаута для дашборда
+     */
+    configureLayout: (layout: IFormLayout) => void;
 }

package/types/services/customModules/facades/schema/IFieldFacade.d.ts

@@ -2,6 +2,7 @@ import { FieldSettings } from "mdtScripts/common/FieldSettings.schema";
 export interface IFieldFacade {
     getCode(): string;
     getTitle(): string | undefined;
+    getDescription(): string | undefined;
     isPrimary(): boolean;
     getType(): string;
     isNullable(): boolean;

package/types/services/customModules/facades/utils/IApiFacade.d.ts

@@ -13,12 +13,12 @@ export interface IApiFacade {
      * Метод получает данные без переводов.
      * Для получения локализованных данных используйте {@link fetchWithExts}
      */
-    fetch<R = FetchResult>(objectCode: string, query?: BaseQuery): Promise<R>;
-    fetchWithExts<R = FetchResult>(objectCode: string, query?: BaseQuery): Promise<R>;
+    fetch<R = FetchResult>(objectCode: string, query?: BaseQuery, options?: QueryExecutionOptions): Promise<R>;
+    fetchWithExts<R = FetchResult>(objectCode: string, query?: BaseQuery, options?: QueryExecutionOptions): Promise<R>;
     /** Отправить запрос к функции */
     fetchFunction<R extends FetchResult = FetchResult>(objectCode: string, params?: AnyObject, query?: BaseQuery): Promise<R>;
     /** Отправить запрос на получение одной записи из объекта */
-    fetchRecord<R = MdtRecord>(objectCode: string, query?: BaseQuery): Promise<R>;
+    fetchRecord<R = MdtRecord>(objectCode: string, query?: BaseQuery, options?: QueryExecutionOptions): Promise<R>;
     /**
      * @deprecated
      * Отправить запрос к функции
@@ -54,7 +54,7 @@ export interface IApiFacade {
     downloadFile(fileUid: string): void;
     v2: IApiFacadeV2;
 }
-interface QueryExecutionOptions {
+export interface QueryExecutionOptions {
     /**
      * Определяет, должен ли запрос выполняться в фоновом режиме.
      * Если запрос выполняется в фоновом режиме, то он не блокирует интерфейс.
@@ -89,4 +89,3 @@ export interface MdtQueryResult {
 export interface ApiSaveOptions extends QueryExecutionOptions {
     messageAction: MessageMetaData;
 }
-export {};

package/types/services/customModules/facades/utils/IUiComponentsFacade.d.ts

@@ -17,6 +17,7 @@ import { ComponentConfigParams } from "mdtScripts/helpers/ui/elementModificators
 import { FormattedText } from "../../../../helpers/formattedText";
 import { ChartFormControlFacadeOptions, IChartControlFacade } from "../../../../views/page/charts/facade/IСhartControlFacade";
 import { IMultiPickerFacade, MultiPickerFacadeOptions, MultiPickerItem } from "../../../../views/form/controls/picker/multiPickerFacade/IMultiPickerFacade";
+import { HeaderSize } from "mdtScripts/components/form/header/types";
 export interface IUiComponentsFacade {
     button(button: ButtonFacade, translate?: boolean): ViewElement;
     topNavButton(options: TopNavButton): _mithril.MithrilVirtualElement;
@@ -54,7 +55,7 @@ export interface IUiComponentsFacade {
      * })
      * ```
      */
-    markdown(content: string): ViewElement;
+    markdown(content: string, options?: MarkdownOptions): ViewElement;
 }
 export interface IProcessFormBlockOptions {
     title: string;
@@ -79,3 +80,13 @@ export interface TopNavButton {
     execute?: () => void;
 }
 export declare type TooltipContent = (el: HTMLElement) => FormattedText;
+export interface MarkdownOptions {
+    type?: string;
+    title?: string;
+    icon?: string;
+    className?: string;
+    zones?: {
+        end?: ViewElement[];
+    };
+    headerSize?: HeaderSize;
+}

package/types/views/page/charts/ChartControlOptions.schema.d.ts

@@ -166,6 +166,8 @@ export interface Axes {
      * По умолчанию вертикальная.
      */
     orientation?: Orientation;
+    /** @title Общая настройка подписей осей */
+    labels?: BaseAxesLabelsOptions;
     /**
      * @title Параметры оси ключей
      */
@@ -204,30 +206,52 @@ export interface Axes {
     /**
      * @title Параметры оси значений
      */
-    value?: {
+    value?: BaseValueAxisOptions & {
         /**
          * @title Позиция оси значений
          * @description По умолчанию равна "start", если диаграмма вертикальная и "end" - если диаграмма горизонтальная
          */
         position?: AxisPosition;
-        /**
-         * @title Отображение оси
-         * @description По умолчанию не отображается только тогда, когда все диаграммы имеют встроенные лейблы, показывающие значения
-         */
-        visible?: boolean;
         /**
          * @title Отображение линий сетки оси
          * @description По умолчанию всегда отображается
          */
         gridLine?: boolean;
-        /** @title Функция форматирования значений */
-        formatValue?: string;
-        /** @title Размер отступа между подписями в px */
-        stepSize?: number;
         line?: {
             visible?: boolean;
         };
     };
+    valueSecondary?: BaseValueAxisOptions;
+}
+interface BaseValueAxisOptions {
+    /** @title Размер отступа между подписями в px */
+    stepSize?: number;
+    /**
+     * @title Настройка диапазона осей
+     * @param options Опции с данными диаграммы
+     * @returns Объект с диапазоном осей. Оставить -1 для автоматического определения диапазона
+     */
+    domain?: (options: {
+        data: MdtChartsDataRow[];
+    }) => {
+        start: number;
+        end: number;
+    };
+    /** @title Функция форматирования значений */
+    formatValue?: string;
+    /**
+     * @title Отображение оси
+     * @description По умолчанию не отображается только тогда, когда все диаграммы имеют встроенные лейблы, показывающие значения
+     */
+    visible?: boolean;
+}
+export interface BaseAxesLabelsOptions {
+    /**
+     * @title Максимальный размер подписи в px
+     * @description Для вертикальных осей этот параметр определяет максимальную ширину подписи, а для горизонтальных - максимальную высоту подписи (если подписи расположены вертикально).
+     * @default 80
+     */
+    maxSize?: number;
 }
 interface BaseChartBlockOptions {
     /**
@@ -236,6 +260,11 @@ interface BaseChartBlockOptions {
      * @default 510
      */
     height?: number;
+    /** @title Настройки стилей */
+    style?: {
+        /** @title Цвет фона */
+        backgroundColor?: string;
+    };
 }
 interface GraphicChartBlockOptions extends BaseChartBlockOptions {
     /**
@@ -318,6 +347,9 @@ export interface TwoDimensionalOptions extends GraphicChartBlockOptions {
     };
     valueLabels?: {
         style?: ValueLabelsStyleOptions;
+        collision?: {
+            otherValueLabels?: "hide" | "none";
+        };
     };
 }
 interface ValueLabelsStyleOptions {
@@ -373,7 +405,23 @@ interface TwoDimensionalChartOptions {
     /**
      * @title Отображение подписей значений на диаграмме
      */
-    valueLabels?: boolean;
+    valueLabels?: boolean | ValueLabelsChartOptions;
+}
+export declare type ValueLabelsPositionMode = "center" | "afterElement";
+export interface ValueLabelsChartOptions {
+    on?: boolean;
+    /** @default "afterElement" */
+    position?: ValueLabelsPositionMode;
+    rotation?: {
+        angle?: number;
+    };
+    handleElement?: (options: {
+        element: SVGElement;
+        value: number;
+    }) => void;
+    format?: (options: {
+        value: number;
+    }) => string | number;
 }
 /**
  * @title Гистограмма

package/types/views/page/charts/facade/IChartControlFacade.d.ts

@@ -0,0 +1,25 @@
+import { ChartControlOptions } from "../ChartControlOptions.schema";
+import { MdtRecord } from "../../../../services/customModules/facades/utils/IApiFacade";
+import { EventEmitterSubscribeController } from "../../../../helpers/events/EventEmitter";
+import { ViewControl } from "../../../../helpers/types";
+export interface ChartControlFacadeData {
+    refresh?: number;
+    fetch?: () => Promise<MdtRecord[]>;
+}
+export interface ChartFormControlFacadeOptions {
+    controlOptions: ChartControlOptions;
+    data?: ChartControlFacadeData;
+    code?: string;
+}
+export interface ChartEvents {
+    selected: {
+        records: MdtRecord[];
+    };
+}
+export interface IChartControlFacade extends ViewControl {
+    readonly on: EventEmitterSubscribeController<ChartEvents>["subscribe"];
+    refreshData(): void;
+    reCreate(newOptionsCreator?: () => ChartFormControlFacadeOptions): void;
+    init(): void;
+    clearSelection(): void;
+}

package/types/views/page/charts/facade/I/320/241hartControlFacade.d.ts

@@ -9,6 +9,7 @@ export interface ChartControlFacadeData {
 export interface ChartFormControlFacadeOptions {
     controlOptions: ChartControlOptions;
     data?: ChartControlFacadeData;
+    code?: string;
 }
 export interface ChartEvents {
     selected: {

package/types/views/page/charts/reportDashboard/config/chartConfig.d.ts

@@ -0,0 +1,31 @@
+import { ChartControlOptions } from "../../ChartControlOptions.schema";
+import { FilterableByFieldsElement, ReportDashboardFetchFilter } from "./filterConfig";
+export interface DashboardChartCrossFilter {
+    fieldPath?: string;
+    dependencies?: DashboardCrossFilterDependency[];
+}
+export interface DashboardCrossFilterDependency {
+    chartId: string;
+    fieldPath: string;
+}
+export interface DashboardChartConfig extends FilterableByFieldsElement {
+    fetch: (options: {
+        getEnvVar: (varName: string) => any;
+        filter: ReportDashboardFetchFilter;
+    }) => Promise<Record<string, any>[]>;
+    options: ChartControlOptions;
+    filterByCharts?: DashboardChartCrossFilter;
+}
+export interface DashboardDynamicChartConfig extends FilterableByFieldsElement {
+    defaultItem?: string;
+    items?: string[];
+    filterByCharts?: DashboardChartCrossFilter;
+    update: (options: {
+        type?: string;
+        filter?: ReportDashboardFetchFilter;
+    }, currentControlOptions?: ChartControlOptions) => Promise<{
+        data: Record<string, any>[];
+        controlOptions: ChartControlOptions;
+        reCreate?: boolean;
+    }>;
+}

package/types/views/page/charts/reportDashboard/config/filterConfig.d.ts

@@ -0,0 +1,52 @@
+import { AnyObject } from "mdtScripts/helpers/types";
+import { ApiV2 } from "mdtServices/api/ApiAccessor/apiV2Types";
+import { IFilter } from "mdtServices/IFilter";
+export interface FilterDependencyConfig {
+    fieldCode: string;
+    fieldPath?: string;
+    operation?: ApiV2.Filter.BinaryOp;
+    handleValue?: (value: any) => any;
+}
+export interface FilterableByFieldsElement {
+    filterByFields?: FilterDependencyConfig[];
+}
+export interface DashboardVirtualObject {
+    code: string;
+    fields: {
+        code: string;
+        primary?: boolean;
+        default?: boolean;
+    }[];
+    fetch: () => Promise<AnyObject[]>;
+}
+export interface DashboardFiltersPublicConfig {
+    code: string;
+    params: FilterFieldConfig[];
+}
+export interface FilterFieldConfig {
+    code: string;
+    type?: string;
+    title?: string;
+    defaultValue?: any;
+    reference?: FilterableByFieldsElement & {
+        type: "single" | "multi";
+        datasource: {
+            type: "dbObject";
+            code: string;
+        } | {
+            type: "virtualObject";
+            object: DashboardVirtualObject;
+        } | {
+            type: "proxyObject";
+            proxyObjectCode?: string;
+            originalObjectCode: string;
+            primaryFieldCode: string;
+            defaultFieldCode?: string;
+        };
+    };
+}
+export interface ReportDashboardFetchFilter {
+    buildV2(): ApiV2.Filter.Multi | undefined;
+    buildV1(): IFilter | undefined;
+    getValues(): Record<string, any> | undefined;
+}

package/types/views/page/charts/reportDashboard/config/listConfig.d.ts

@@ -0,0 +1,9 @@
+import { DashboardChartCrossFilter } from "./chartConfig";
+import { FilterableByFieldsElement } from "./filterConfig";
+export interface DashboardListConfig extends FilterableByFieldsElement {
+    id: string;
+    filterByCharts?: Omit<DashboardChartCrossFilter, "fieldPath">;
+    datasource: {
+        objectCode: string;
+    };
+}

package/types/views/page/charts/reportDashboard/config/reportDashboardConfig.d.ts

@@ -0,0 +1,45 @@
+import { AnyObject } from "mdtScripts/helpers/types";
+import { DashboardChartConfig, DashboardDynamicChartConfig } from "./chartConfig";
+import { JsonVarsMap } from "../utils/formJsonVarParser";
+import { DashboardFiltersPublicConfig, ReportDashboardFetchFilter } from "./filterConfig";
+import { DynamicChartCtrlPublicOptions } from "../controls/dynamicChart/dynamicChartControlPublicOptions";
+import { IChartControlFacade } from "../../facade/IChartControlFacade";
+import { DashboardListConfig } from "./listConfig";
+export interface ReportDashboardConfig<ChartId extends string, DynamicChartId extends string, ListId extends string> {
+    filters: DashboardFiltersPublicConfig;
+    defaultCharts?: Record<ChartId, DashboardChartConfig>;
+    dynamicCharts?: Record<DynamicChartId, DashboardDynamicChartConfig>;
+    lists?: DashboardListConfig[];
+    bindEnvVariables?: (dashboard: ReportDashboardInstance<ChartId>) => JsonVarsMap;
+    mdtLayout: (options: {
+        dashboard: ReportDashboardInstance<ChartId>;
+        items: {
+            field: (code: string, width: number, options?: AnyObject) => AnyObject;
+            defaultChart: (id: ChartId, width: number) => AnyObject;
+            dynamicChart: (id: DynamicChartId, width: number, options?: DynamicChartCtrlPublicOptions) => AnyObject;
+            list: (id: ListId, width: number, options?: AnyObject) => AnyObject;
+        };
+    }) => AnyObject;
+    events?: {
+        fieldUpdated?(event: {
+            fieldCode: string;
+            value: any;
+            dashboard: ReportDashboardInstance<ChartId>;
+        }): void | Promise<void>;
+        clearAllFilters?(): void | Promise<void>;
+        stateInited?(event: {
+            dashboard: ReportDashboardInstance<ChartId>;
+        }): void | Promise<void>;
+    };
+}
+export interface ReportDashboardInstance<ChartId extends string> {
+    clearAllFilters(): void;
+    fields: {
+        setValue(fieldCode: string, value: any, fireEvent?: boolean): void;
+        getValue(fieldPath: string): any;
+        getFilterBuilderForField(fieldCode: string): ReportDashboardFetchFilter | undefined;
+    };
+    charts: {
+        getDefaultChart(id: ChartId): IChartControlFacade | undefined;
+    };
+}

package/types/views/page/charts/reportDashboard/controls/dynamicChart/dynamicChartControlPublicOptions.d.ts

@@ -0,0 +1,3 @@
+export interface DynamicChartCtrlPublicOptions {
+    placeholderHeight?: number;
+}

package/types/views/page/charts/reportDashboard/index.d.ts

@@ -0,0 +1,5 @@
+import { CustomNavNode } from "mdtServices/customModules/facades/services/INavigationFacade";
+import { ReportDashboardConfig } from "./config/reportDashboardConfig";
+export interface ReportDashboard {
+    createNode<ChartId extends string, DynamicChartId extends string, ListId extends string>(node: CustomNavNode, config: ReportDashboardConfig<ChartId, DynamicChartId, ListId>): void;
+}

package/types/views/page/charts/reportDashboard/utils/formJsonVarParser.d.ts

@@ -0,0 +1,13 @@
+export interface IJsonVarParser {
+    getVarValue(varName: string): number | string;
+}
+export declare type JsonVarsMap = {
+    [key: string]: () => number | string;
+};
+export declare class JsonVarParser implements IJsonVarParser {
+    private readonly jsonVarsMap;
+    constructor(jsonVarsMap: JsonVarsMap);
+    getVarValue(varName: string): number | string;
+    private hasVarName;
+}
+export declare function replaceVariablesInJson<D = any>(data: D, jsonVarParser: IJsonVarParser): D;