mdt-client 31.3.40 → 31.3.41

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

@@ -0,0 +1,29 @@
+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 ChartClearSelectionOptions {
+    /** @default true */
+    fireEvent?: boolean;
+}
+export interface IChartControlFacade extends ViewControl {
+    readonly on: EventEmitterSubscribeController<ChartEvents>["subscribe"];
+    refreshData(): void;
+    reCreate(newOptionsCreator?: () => ChartFormControlFacadeOptions): void;
+    init(): void;
+    clearSelection(options?: ChartClearSelectionOptions): void;
+}

package/types/_core/scripts/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/_core/scripts/views/page/charts/reportDashboard/config/filterConfig.d.ts

@@ -0,0 +1,56 @@
+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;
+    title?: 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;
+            proxyObjectOptions?: {
+                title?: string;
+            };
+        };
+    };
+}
+export interface ReportDashboardFetchFilter {
+    buildV2(): ApiV2.Filter.Multi | undefined;
+    buildV1(): IFilter | undefined;
+    getValues(): Record<string, any> | undefined;
+}

package/types/_core/scripts/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/_core/scripts/views/page/charts/reportDashboard/config/reportDashboardConfig.d.ts

@@ -0,0 +1,55 @@
+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";
+import { ButtonFacade } from "mdtServices/customModules/facades/Form/IFormFacade";
+import { Icon } from "mdtScripts/components/icon/iconOptions";
+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;
+            filterPanel: (width: number, options: {
+                items: AnyObject[];
+                header?: {
+                    title?: string;
+                    icon?: Icon;
+                    clearButton?: Partial<ButtonFacade>;
+                };
+            }) => 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/_core/scripts/views/page/charts/reportDashboard/controls/dynamicChart/dynamicChartControlPublicOptions.d.ts

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

package/types/_core/scripts/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/_core/scripts/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;

package/types/helpers/ui/toolbarItemTypes.d.ts

@@ -0,0 +1,30 @@
+import { Valued, ViewElement } from "../types";
+/**
+ * Кнопка с кастомным представлением для тулбара.
+ *
+ * @example
+ * // Пример с React-компонентом из UI Kit
+ * FormService.onCreated((form) => {
+ *   form.addCommand({
+ *     code: "test",
+ *     order: 100,
+ *     $view: () => {
+ *       return uiKitWrap(
+ *         MyComponent,
+ *         { onClose: () => form.close() },
+ *         {
+ *           // Рекомендуется всегда проставлять элементу ключ
+ *           key: "test",
+ *           style: { paddingLeft: "10px" }
+ *         }
+ *       );
+ *     }
+ *   });
+ * });
+ */
+export interface CustomViewButton {
+    code?: string;
+    order?: number;
+    visible?: Valued<boolean>;
+    $view: () => ViewElement;
+}

package/types/job/scripts/types.d.ts

@@ -0,0 +1,11 @@
+import { Field } from "mdtScripts/common/Field";
+import { ApiV1, ApiV2 } from "mdtServices/api/ApiAccessor/job/jobApiTypes";
+export declare type JobContextFacade = Omit<ApiV1.Request.JobTask, "ObjectId"> & {
+    objectId: number;
+    formContext?: ParentFormContextFacade;
+};
+export declare type JobExecutionResult = ApiV2.Response.Job.ExecTask;
+export interface ParentFormContextFacade<FormType = any, FieldType = Field> {
+    parentForm?: FormType;
+    parentField?: FieldType;
+}

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

@@ -4,7 +4,7 @@ import { IFieldFacade } from "../schema/IFieldFacade";
 import { IObjectFacade } from "../schema/IObjectFacade";
 import { RecordId } from "../../../../common/Record";
 import { ParentCtrl } from "../utils/IUiFacade";
-import { ButtonFacade } from "./IFormFacade";
+import { ButtonFacade, CommandFacade } from "./IFormFacade";
 import { FieldCode } from "mdtScripts/helpers/types";
 import { IFieldStateFacade } from "./IFieldStateFacade";
 export type IFormFieldOptionsConfig = {
@@ -53,7 +53,7 @@ export interface IFormControlFacade extends ParentCtrl {
     /** Подписаться на событие создания макета формы */
     onLayoutCreated(callback: () => void): void;
     /** Установить команду на форму */
-    addCommand(command: ButtonFacade, isExtended?: boolean): void;
+    addCommand(command: CommandFacade, isExtended?: boolean): void;
     /** Установить настройки для полей формы */
     setFieldOptions(options: IFormFieldOptionsConfig): void;
     /** Установить настройки для компонента формы */

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

@@ -7,6 +7,7 @@ import { IObjectFacade } from "../schema/IObjectFacade";
 import { IFormControlFacade } from "./IFormControlFacade";
 import { FieldPhysicalType } from "../schema/ISchemaFacade";
 import { IBaseFieldBuilder } from "../schema/fieldBuilder/fieldBuilder/IFieldBuilder";
+import { CustomViewButton } from "mdtScripts/helpers/ui/toolbarItemTypes";
 export type ActionButton = IButton & {
     /** Всплывающая подсказка */
     description?: Valued<FormattedText>;
@@ -23,6 +24,7 @@ export interface ButtonFacade extends ActionButton {
     /** Дочерние элементы кнопки */
     items?: ButtonFacade[];
 }
+export type CommandFacade = ButtonFacade | CustomViewButton;
 export interface IFormInitOptions {
     /** Уникальный код списка */
     code?: string;
@@ -51,6 +53,8 @@ export interface IFormOptions {
     /** Описание лэйаута формы */
     layout?: CustomFormLayout;
     viewSettings?: FormViewSettings;
+    /** Контекст формы */
+    context?: Record<string, any>;
 }
 export interface FormViewSettings {
     hideSubTitle?: boolean;

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

@@ -1,5 +1,5 @@
 import { FilterSetterOptions, IFilter } from "../../../../services/IFilter";
-import { ButtonFacade } from "../Form/IFormFacade";
+import { ButtonFacade, CommandFacade } from "../Form/IFormFacade";
 import { ParentCtrl } from "../utils/IUiFacade";
 import { IListRowFacade } from "./IListRowFacade";
 import { IListCellFacade } from "./IListCellFacade";
@@ -23,7 +23,7 @@ export interface IListControlFacade extends ParentCtrl {
     /** Получить выделенные строки списка */
     getSelectedRows(): any[];
     /** Добавить команду на список */
-    addCommand(command: ButtonFacade, extend?: boolean): void;
+    addCommand(command: CommandFacade, extend?: boolean): void;
     /** Установить фильтр на список */
     setFilter(filter: IFilter | null, options?: FilterSetterOptions, key?: string): void;
     /** Подписаться на событие обновления фильтра */

package/types/ui-kit/UiKitFacade.d.ts

@@ -43,6 +43,7 @@ import * as tooltip from "ics-ui-kit/dist/components/tooltip";
 import * as reactHookForm from "ics-ui-kit/dist/vendors/react-hook-form";
 import * as reactTable from "ics-ui-kit/dist/vendors/tanstack/react-table";
 import * as zod from "ics-ui-kit/dist/vendors/zod";
+import { cn } from "ics-ui-kit/dist/lib/utils";
 /**
  * Фасад для ре-экспорта компонентов из UI Kit.
  * В этом классе должны быть только ре-экспорты из UI Kit с сохранением структуры.
@@ -103,4 +104,17 @@ export declare class UiKitFacade {
         zod: typeof zod;
         "react-hook-form": typeof reactHookForm;
     };
+    hooks: {
+        useIsSm: () => boolean;
+        useIsMd: () => boolean;
+        useIsLg: () => boolean;
+        useIsXl: () => boolean;
+        useIs2Xl: () => boolean;
+        useIsMobile: () => boolean;
+        useBreakpoint: (breakpoint: "lg" | "sm" | "md" | "xl" | "2xl") => boolean;
+        useActiveBreakpoint: () => "lg" | "sm" | "md" | "xl" | "2xl";
+    };
+    lib: {
+        cn: typeof cn;
+    };
 }

package/types/services/customModules/facades/ui-kit/UiKitFacade.d.ts

@@ -1,8 +0,0 @@
-import * as Dropdown from "ics-ui-kit/dist/components/dropdown";
-import * as Modal from "ics-ui-kit/dist/components/modal";
-export declare class UiKitFacade {
-    components: {
-        readonly dropdown: typeof Dropdown;
-        readonly modal: typeof Modal;
-    };
-}