@gravity-ui/dashkit 6.6.1 → 6.7.1

package/build/esm/shared/modules/state-and-params.js

@@ -1,8 +1,6 @@
 import groupBy from 'lodash/groupBy';
-import intersection from 'lodash/intersection';
-import omit from 'lodash/omit';
 import { META_KEY } from '../constants';
-import { prerenderItems, formQueueData, getMapItemsIgnores, mergeParamsWithAliases, getCurrentVersion, pickActionParamsFromParams, hasActionParam, pickExceptActionParamsFromParams, transformParamsToActionParams, isItemWithTabs, resolveItemInnerId, getDefaultsActionParamsToClear, } from './helpers';
+import { prerenderItems, formQueueData, getMapItemsIgnores, mergeParamsWithAliases, getCurrentVersion, pickActionParamsFromParams, hasActionParam, pickExceptActionParamsFromParams, isItemWithTabs, resolveItemInnerId, } from './helpers';
 export function getItemsParams({ defaultGlobalParams = {}, globalParams = {}, config, itemsStateAndParams, plugins, }) {
     const { aliases, connections } = config;
     const items = prerenderItems({ items: config.items, plugins });
@@ -50,8 +48,7 @@ export function getItemsParams({ defaultGlobalParams = {}, globalParams = {}, co
         }
         else {
             // params according to queue of its applying
-            let prevQueueDataWithActionParams = {};
-            let queueDataItems = {};
+            let queueDataItemsParams = {};
             for (const data of Object.values(queueData)) {
                 if (data.namespace !== namespace || itemIgnores.includes(data.id)) {
                     continue;
@@ -64,24 +61,9 @@ export function getItemsParams({ defaultGlobalParams = {}, globalParams = {}, co
                     params = pickExceptActionParamsFromParams(data.params);
                 }
                 const mergedParams = getMergedParams(params, actionParams);
-                const actionParamKeyToClear = intersection(Object.keys(transformParamsToActionParams(mergedParams)), Object.keys(prevQueueDataWithActionParams));
-                let queueDataRes = Object.assign({}, queueDataItems);
-                if (actionParamKeyToClear.length) {
-                    queueDataRes = omit(queueDataItems, actionParamKeyToClear);
-                }
-                queueDataItems = Object.assign(Object.assign({}, queueDataRes), mergedParams);
-                prevQueueDataWithActionParams = hasActionParam(queueDataItems)
-                    ? pickActionParamsFromParams(data.params, true)
-                    : {};
-            }
-            const clearActionParams = getDefaultsActionParamsToClear({
-                defaultWidgetParams,
-                queueWidgetParams: queueDataItems,
-            });
-            if (clearActionParams.length) {
-                defaultWidgetParams = omit(defaultWidgetParams, clearActionParams);
+                queueDataItemsParams = Object.assign(Object.assign({}, queueDataItemsParams), mergedParams);
             }
-            itemParams = Object.assign(itemParams, queueDataItems);
+            itemParams = Object.assign(itemParams, queueDataItemsParams);
         }
         return Object.assign(Object.assign({}, itemsParams), { [id]: Object.assign(Object.assign({}, defaultWidgetParams), itemParams) });
     }, {});

package/build/esm/shared/types/state-and-params.d.ts

@@ -18,5 +18,8 @@ export type ItemStateAndParams = {
     params?: StringParams;
     state?: ItemState;
 };
+export type ItemStateAndParamsChangeOptions = {
+    action: 'setParams' | 'removeItem';
+};
 export type ItemsStateAndParamsBase = Record<string, ItemStateAndParams>;
 export type ItemsStateAndParams = ItemsStateAndParamsBase | StateAndParamsMeta;

package/build/esm/shared/units/__tests__/state-and-params.test.js

@@ -302,6 +302,7 @@ const stateAndParamsForAP2 = {
                 Country: 'Belgium',
                 Year: '',
                 'd079937f-6bc4-4133-9171-40092bb20d6f': 'Belgium',
+                _ap_Country: 'Italy',
             },
             state: {},
         },
@@ -330,6 +331,7 @@ const stateAndParamsForAP3 = {
                 Country: '',
                 Year: '',
                 'd079937f-6bc4-4133-9171-40092bb20d6f': '',
+                _ap_Country: 'Italy',
             },
             state: {},
         },
@@ -406,6 +408,64 @@ const stateAndParamsForAP5 = {
         },
     },
 };
+const stateAndParamsForAP6 = {
+    in: {
+        Q8: {
+            params: {
+                _ap_Year: '2021',
+                _ap_Country: 'Russia',
+            },
+        },
+        L5: {
+            params: {
+                _ap_Country: 'Russia',
+                _ap_Name: 'Alex',
+                _ap_Price: '1000',
+            },
+        },
+        __meta__: {
+            queue: [
+                { id: 'Q8', tabId: 'K0' },
+                { id: 'L5', tabId: 'K1' },
+            ],
+            version: 2,
+        },
+    },
+    out: {
+        L5: {
+            params: {
+                Name: '',
+                Price: '',
+                Year: '2021',
+                Country: 'Russia',
+                _ap_Country: 'Russia',
+                _ap_Name: 'Alex',
+                _ap_Price: '1000',
+            },
+            state: {},
+        },
+        Q8: {
+            params: {
+                Year: '',
+                Country: 'Russia',
+                Name: 'Alex',
+                Price: '1000',
+                _ap_Year: '2021',
+                _ap_Country: 'Russia',
+            },
+            state: {},
+        },
+        al: {
+            params: {
+                Country: 'Russia',
+                Name: 'Alex',
+                Price: '1000',
+                Year: '2021',
+            },
+            state: {},
+        },
+    },
+};
 const configs = mockConfigs.configs;
 describe('getItemsStateAndParamsDL', () => {
     describe('old version fallback', () => {
@@ -498,4 +558,15 @@ describe('getItemsStateAndParams actionParams variants check', () => {
             expect(resultItemsStateAndParams).toEqual(omit(stateAndParamsForAP5.out, META_KEY));
         });
     });
+    describe('action and params state 6', () => {
+        const resultItemsStateAndParams = getItemsStateAndParamsDL({
+            defaultGlobalParams: {},
+            globalParams: {},
+            config: configs[4],
+            itemsStateAndParams: stateAndParamsForAP6.in,
+        });
+        it('return stateAndParamsForAP6.out', () => {
+            expect(resultItemsStateAndParams).toEqual(omit(stateAndParamsForAP6.out, META_KEY));
+        });
+    });
 });

package/build/esm/typings/plugin.d.ts

@@ -1,13 +1,13 @@
 import React from 'react';
 import { ContextProps, SettingsProps, WidgetLayout } from './common';
-import { StringParams, ConfigItem, ItemState, ItemStateAndParams, PluginBase } from '../shared';
+import { StringParams, ConfigItem, ItemState, ItemStateAndParams, PluginBase, ItemStateAndParamsChangeOptions } from '../shared';
 import type { ReactGridLayoutProps } from 'react-grid-layout';
 export interface PluginWidgetProps {
     id: string;
     editMode: boolean;
     params: StringParams;
     state: ItemState;
-    onStateAndParamsChange: (stateAndParams: ItemStateAndParams) => void;
+    onStateAndParamsChange: (stateAndParams: ItemStateAndParams, options?: ItemStateAndParamsChangeOptions) => void;
     width: number;
     height: number;
     data: ConfigItem['data'];

package/build/esm/utils/__tests__/update-manager.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/esm/utils/__tests__/update-manager.test.js

@@ -0,0 +1,474 @@
+import { UpdateManager } from '../update-manager';
+const config = {
+    salt: '0.09852189776033704',
+    counter: 14,
+    items: [
+        {
+            id: 'al',
+            data: {
+                tabs: [
+                    {
+                        id: 'Jn',
+                        title: 'tab 1',
+                        params: {
+                            Country: 'Germany',
+                        },
+                        chartId: 'h8hfbffyo3dg8',
+                        isDefault: true,
+                        autoHeight: false,
+                    },
+                    {
+                        id: 'Pf',
+                        title: 'tab 2',
+                        params: {},
+                        chartId: 'f5hfbl3yo3dh7',
+                        isDefault: false,
+                        autoHeight: false,
+                    },
+                ],
+                hideTitle: true,
+            },
+            type: 'widget',
+            namespace: 'default',
+        },
+        {
+            id: 'Q8',
+            data: {
+                tabs: [
+                    {
+                        id: 'K0',
+                        title: 'filtering_charts_table (charteditor)',
+                        params: {
+                            Year: '',
+                            Country: '',
+                            _ap_Country: 'Belgium',
+                        },
+                        chartId: '245z37u4ylvet',
+                        isDefault: true,
+                        autoHeight: false,
+                    },
+                ],
+                hideTitle: false,
+            },
+            type: 'widget',
+            namespace: 'default',
+        },
+        {
+            id: 'L5',
+            data: {
+                title: 'Country',
+                source: {
+                    datasetId: 'gyrnhj945gum9',
+                    fieldType: 'string',
+                    showTitle: true,
+                    innerTitle: 'Inner title',
+                    elementType: 'select',
+                    datasetFieldId: 'd079',
+                    showInnerTitle: false,
+                    datasetFieldType: 'DIMENSION',
+                },
+                sourceType: 'dataset',
+            },
+            type: 'control',
+            defaults: {
+                d079: ['Italy', 'France'],
+            },
+            namespace: 'default',
+        },
+        {
+            id: 'C8',
+            data: {
+                title: 'Client',
+                source: {
+                    datasetId: 'rfvnhj345gugf',
+                    fieldType: 'string',
+                    showTitle: true,
+                    innerTitle: 'Inner title',
+                    elementType: 'select',
+                    datasetFieldId: 'g129',
+                    showInnerTitle: false,
+                    datasetFieldType: 'DIMENSION',
+                },
+                sourceType: 'dataset',
+            },
+            type: 'control',
+            defaults: {
+                g129: ['Alex'],
+            },
+            namespace: 'default',
+        },
+        {
+            id: 'lko',
+            data: {
+                title: 'External control',
+                source: {
+                    chartId: 'deuaclrdakbc4',
+                },
+                autoHeight: true,
+                sourceType: 'external',
+            },
+            type: 'control',
+            defaults: {
+                Name: '',
+                Brand: '',
+                Label: '',
+            },
+            namespace: 'default',
+        },
+    ],
+    layout: [
+        { h: 4, i: 'al', w: 4, x: 8, y: 0 },
+        { h: 16, i: 'Q8', w: 12, x: 12, y: 0 },
+        { h: 2, i: 'L5', w: 8, x: 0, y: 2 },
+        { h: 2, i: 'C8', w: 8, x: 10, y: 30 },
+        { h: 2, i: 'lko', w: 8, x: 0, y: 12 },
+    ],
+    aliases: {},
+    connections: [],
+};
+beforeEach(() => {
+    jest.spyOn(console, 'warn').mockImplementation(jest.fn());
+});
+describe('UpdateManager', () => {
+    describe('changeStateAndParams', () => {
+        it('control adds params to empty itemsStateAndParams', () => {
+            expect(UpdateManager.changeStateAndParams({
+                id: 'L5',
+                config,
+                itemsStateAndParams: {},
+                stateAndParams: {
+                    params: {
+                        d079: ['Russia'],
+                    },
+                },
+            })).toEqual({
+                L5: {
+                    params: {
+                        d079: ['Russia'],
+                    },
+                },
+                __meta__: { queue: [{ id: 'L5' }], version: 2 },
+            });
+        });
+        it('state changes only do not push into the queue', () => {
+            expect(UpdateManager.changeStateAndParams({
+                id: 'al',
+                config,
+                itemsStateAndParams: {
+                    L5: {
+                        params: {
+                            d079: ['Russia'],
+                        },
+                    },
+                    __meta__: { queue: [{ id: 'L5' }, { id: 'Unk' }], version: 2 },
+                },
+                stateAndParams: {
+                    state: { tabId: 'Pf' },
+                },
+            })).toEqual({
+                L5: {
+                    params: {
+                        d079: ['Russia'],
+                    },
+                },
+                al: {
+                    state: {
+                        tabId: 'Pf',
+                    },
+                },
+                __meta__: { queue: [{ id: 'L5' }], version: 2 },
+            });
+        });
+        it('tab changes clear previous tab params', () => {
+            expect(UpdateManager.changeStateAndParams({
+                id: 'al',
+                config,
+                itemsStateAndParams: {
+                    al: {
+                        state: {
+                            tabId: 'Jn',
+                        },
+                        params: {
+                            Country: 'USA',
+                        },
+                    },
+                    __meta__: { queue: [{ id: 'al', tabId: 'Jn' }], version: 2 },
+                },
+                stateAndParams: {
+                    state: { tabId: 'Pf' },
+                },
+            })).toEqual({
+                al: {
+                    state: {
+                        tabId: 'Pf',
+                    },
+                },
+                __meta__: { queue: [], version: 2 },
+            });
+        });
+        it('control changes rearrange position in the queue', () => {
+            expect(UpdateManager.changeStateAndParams({
+                id: 'L5',
+                config,
+                itemsStateAndParams: {
+                    al: {
+                        state: {
+                            tabId: 'Jn',
+                        },
+                        params: {
+                            Country: 'USA',
+                        },
+                    },
+                    L5: {
+                        params: {
+                            d079: ['Russia'],
+                        },
+                    },
+                    C8: {
+                        params: {
+                            g129: ['Anton'],
+                        },
+                    },
+                    __meta__: {
+                        queue: [{ id: 'L5' }, { id: 'C8' }, { id: 'al', tabId: 'Jn' }, { id: 'Unk' }],
+                        version: 2,
+                    },
+                },
+                stateAndParams: {
+                    params: {
+                        d079: ['Oman'],
+                    },
+                },
+            })).toEqual({
+                al: {
+                    state: {
+                        tabId: 'Jn',
+                    },
+                    params: {
+                        Country: 'USA',
+                    },
+                },
+                L5: {
+                    params: {
+                        d079: ['Oman'],
+                    },
+                },
+                C8: {
+                    params: {
+                        g129: ['Anton'],
+                    },
+                },
+                __meta__: {
+                    queue: [{ id: 'C8' }, { id: 'al', tabId: 'Jn' }, { id: 'L5' }],
+                    version: 2,
+                },
+            });
+        });
+        it('control params should merge', () => {
+            expect(UpdateManager.changeStateAndParams({
+                id: 'lko',
+                config,
+                itemsStateAndParams: {
+                    L5: {
+                        params: {
+                            d079: ['Russia'],
+                        },
+                    },
+                    lko: {
+                        params: {
+                            Brand: ['Nuke'],
+                            Label: ['pin'],
+                        },
+                    },
+                    __meta__: {
+                        queue: [{ id: 'lko' }, { id: 'L5' }],
+                        version: 2,
+                    },
+                },
+                stateAndParams: {
+                    params: {
+                        Name: ['Jack'],
+                        Label: ['clone'],
+                    },
+                },
+            })).toEqual({
+                L5: {
+                    params: {
+                        d079: ['Russia'],
+                    },
+                },
+                lko: {
+                    params: {
+                        Brand: ['Nuke'],
+                        Name: ['Jack'],
+                        Label: ['clone'],
+                    },
+                },
+                __meta__: { queue: [{ id: 'L5' }, { id: 'lko' }], version: 2 },
+            });
+        });
+        it('control cannot set params not from defaults', () => {
+            expect(UpdateManager.changeStateAndParams({
+                id: 'lko',
+                config,
+                itemsStateAndParams: {},
+                stateAndParams: {
+                    params: {
+                        Brand: ['Nuke'],
+                        UnknownParam: ['Value'],
+                    },
+                },
+            })).toEqual({
+                lko: {
+                    params: {
+                        Brand: ['Nuke'],
+                    },
+                },
+                __meta__: { queue: [{ id: 'lko' }], version: 2 },
+            });
+        });
+        it('filtering_charts_table can set action params not from defaults', () => {
+            expect(UpdateManager.changeStateAndParams({
+                id: 'Q8',
+                config,
+                itemsStateAndParams: {},
+                stateAndParams: {
+                    params: {
+                        _ap_Country: 'Germany',
+                        _ap_Brand: 'Pule',
+                        _ap_Year: '2020',
+                    },
+                    state: {
+                        tabId: 'K0',
+                    },
+                },
+            })).toEqual({
+                Q8: {
+                    state: {
+                        tabId: 'K0',
+                    },
+                    params: {
+                        _ap_Country: 'Germany',
+                        _ap_Brand: 'Pule',
+                        _ap_Year: '2020',
+                    },
+                },
+                __meta__: { queue: [{ id: 'Q8', tabId: 'K0' }], version: 2 },
+            });
+        });
+        it('the item is correctly removed from the queue', () => {
+            expect(UpdateManager.changeStateAndParams({
+                id: 'Q8',
+                config,
+                itemsStateAndParams: {
+                    L5: {
+                        params: {
+                            d079: ['Russia'],
+                        },
+                    },
+                    Q8: {
+                        state: {
+                            tabId: 'K0',
+                        },
+                        params: {
+                            _ap_Country: 'Germany',
+                            _ap_Year: '2020',
+                        },
+                    },
+                    Unk: {
+                        params: {
+                            Country: 'Unknown',
+                        },
+                    },
+                    __meta__: {
+                        queue: [{ id: 'Q8', tabId: 'K0' }, { id: 'Unk' }, { id: 'L5' }],
+                        version: 2,
+                    },
+                },
+                stateAndParams: {},
+                options: { action: 'removeItem' },
+            })).toEqual({
+                L5: {
+                    params: {
+                        d079: ['Russia'],
+                    },
+                },
+                __meta__: { queue: [{ id: 'L5' }], version: 2 },
+            });
+            expect(UpdateManager.changeStateAndParams({
+                id: 'Q8',
+                config,
+                itemsStateAndParams: {
+                    L5: {
+                        params: {
+                            d079: ['Russia'],
+                        },
+                    },
+                    __meta__: {
+                        queue: [{ id: 'L5' }],
+                        version: 2,
+                    },
+                },
+                stateAndParams: {},
+                options: { action: 'removeItem' },
+            })).toEqual({
+                L5: {
+                    params: {
+                        d079: ['Russia'],
+                    },
+                },
+                __meta__: { queue: [{ id: 'L5' }], version: 2 },
+            });
+        });
+        it('the item is correctly setParams using additional options', () => {
+            expect(UpdateManager.changeStateAndParams({
+                id: 'Q8',
+                config,
+                itemsStateAndParams: {
+                    L5: {
+                        params: {
+                            d079: ['Russia'],
+                        },
+                    },
+                    Q8: {
+                        state: {
+                            tabId: 'K0',
+                        },
+                        params: {
+                            _ap_Country: 'Germany',
+                            _ap_Year: '2020',
+                        },
+                    },
+                    __meta__: {
+                        queue: [{ id: 'Q8', tabId: 'K0' }, { id: 'L5' }],
+                        version: 2,
+                    },
+                },
+                stateAndParams: {
+                    state: {
+                        tabId: 'K0',
+                    },
+                    params: {
+                        _ap_Country: 'Russia',
+                    },
+                },
+                options: { action: 'setParams' },
+            })).toEqual({
+                L5: {
+                    params: {
+                        d079: ['Russia'],
+                    },
+                },
+                Q8: {
+                    state: {
+                        tabId: 'K0',
+                    },
+                    params: {
+                        _ap_Country: 'Russia',
+                    },
+                },
+                __meta__: { queue: [{ id: 'L5' }, { id: 'Q8', tabId: 'K0' }], version: 2 },
+            });
+        });
+    });
+});

package/build/esm/utils/update-manager.d.ts

@@ -1,4 +1,4 @@
-import { Config, ConfigItem, ItemsStateAndParams, ItemStateAndParams } from '../shared';
+import { Config, ConfigItem, ItemsStateAndParams, ItemStateAndParams, ItemStateAndParamsChangeOptions } from '../shared';
 import { AddConfigItem, WidgetLayout, SetItemOptions } from '../typings';
 import { RegisterManagerPluginLayout } from './register-manager';
 interface RemoveItemArg {
@@ -11,6 +11,7 @@ interface ChangeStateAndParamsArg {
     config: Config;
     itemsStateAndParams: ItemsStateAndParams;
     stateAndParams: ItemStateAndParams;
+    options?: ItemStateAndParamsChangeOptions;
 }
 export declare class UpdateManager {
     static addItem({ item, namespace, layout, config, options, }: {
@@ -34,6 +35,6 @@ export declare class UpdateManager {
         layout: WidgetLayout[];
         config: Config;
     }): Config;
-    static changeStateAndParams({ id: initiatorId, config, stateAndParams, itemsStateAndParams, }: ChangeStateAndParamsArg): ItemsStateAndParams;
+    static changeStateAndParams({ id: initiatorId, config, stateAndParams, itemsStateAndParams, options, }: ChangeStateAndParamsArg): ItemsStateAndParams;
 }
 export {};