mdt-client 31.3.21 → 31.3.22

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

@@ -1,24 +1,24 @@
-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;
-}
+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;
+}

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;