@gravity-ui/dashkit 6.6.1 → 6.7.0

package/build/esm/hocs/prepareItem.d.ts

@@ -1,7 +1,7 @@
 export function prepareItem(Component: any): {
     new (props: any): {
         shouldComponentUpdate(nextProps: any): boolean;
-        _onStateAndParamsChange: (stateAndParams: any) => void;
+        _onStateAndParamsChange: (stateAndParams: any, options: any) => void;
         render(): JSX.Element;
         context: unknown;
         setState<K extends string | number | symbol>(state: any, callback?: (() => void) | undefined): void;
@@ -25,7 +25,7 @@ export function prepareItem(Component: any): {
     };
     new (props: any, context: any): {
         shouldComponentUpdate(nextProps: any): boolean;
-        _onStateAndParamsChange: (stateAndParams: any) => void;
+        _onStateAndParamsChange: (stateAndParams: any, options: any) => void;
         render(): JSX.Element;
         context: unknown;
         setState<K extends string | number | symbol>(state: any, callback?: (() => void) | undefined): void;

package/build/esm/hocs/prepareItem.js

@@ -6,8 +6,8 @@ export function prepareItem(Component) {
     return _a = class PrepareItem extends React.Component {
             constructor() {
                 super(...arguments);
-                this._onStateAndParamsChange = (stateAndParams) => {
-                    this.context.onItemStateAndParamsChange(this.props.id, stateAndParams);
+                this._onStateAndParamsChange = (stateAndParams, options) => {
+                    this.context.onItemStateAndParamsChange(this.props.id, stateAndParams, options);
                 };
             }
             shouldComponentUpdate(nextProps) {

package/build/esm/hocs/withContext.js

@@ -47,13 +47,14 @@ function useMemoStateContext(props) {
             itemsStateAndParams: props.itemsStateAndParams,
         }));
     }, [props.config, props.itemsStateAndParams, onChange]);
-    const onItemStateAndParamsChange = React.useCallback((id, stateAndParams) => {
+    const onItemStateAndParamsChange = React.useCallback((id, stateAndParams, options) => {
         onChange({
             itemsStateAndParams: UpdateManager.changeStateAndParams({
                 id,
                 config: props.config,
                 stateAndParams,
                 itemsStateAndParams: props.itemsStateAndParams,
+                options,
             }),
         });
     }, [props.config, props.itemsStateAndParams, onChange]);

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/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 {};

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

@@ -65,9 +65,13 @@ function getAllowableChangedParams(item, stateAndParams, itemsStateAndParams, pa
     const paramsTypeName = (paramsSettings === null || paramsSettings === void 0 ? void 0 : paramsSettings.type) || 'params';
     const isActionParamsMode = paramsTypeName === 'actionParams';
     let allowedParams = {};
-    const stateParamsConf = isActionParamsMode
-        ? pickActionParamsFromParams(stateAndParams.params, false)
-        : stateAndParams.params;
+    if (isActionParamsMode) {
+        allowedParams = pickActionParamsFromParams(stateAndParams.params, false);
+        return (paramsSettings === null || paramsSettings === void 0 ? void 0 : paramsSettings.returnPrefix)
+            ? transformParamsToActionParams(allowedParams)
+            : allowedParams;
+    }
+    const stateParamsConf = stateAndParams.params;
     if (isItemWithTabs(item)) {
         let tab;
         if ('state' in stateAndParams && ((_a = stateAndParams.state) === null || _a === void 0 ? void 0 : _a.tabId)) {
@@ -85,11 +89,6 @@ function getAllowableChangedParams(item, stateAndParams, itemsStateAndParams, pa
     if (Object.keys(allowedParams || {}).length !== Object.keys(stateParamsConf || {}).length) {
         console.warn('Параметры, которых нет в defaults, будут проигнорированы!');
     }
-    if (isActionParamsMode) {
-        return (paramsSettings === null || paramsSettings === void 0 ? void 0 : paramsSettings.returnPrefix)
-            ? transformParamsToActionParams(allowedParams)
-            : allowedParams;
-    }
     return allowedParams;
 }
 function changeStateAndParamsVersion1({ id: initiatorId, config, stateAndParams, itemsStateAndParams, }) {
@@ -229,7 +228,7 @@ export class UpdateManager {
             },
         });
     }
-    static changeStateAndParams({ id: initiatorId, config, stateAndParams, itemsStateAndParams, }) {
+    static changeStateAndParams({ id: initiatorId, config, stateAndParams, itemsStateAndParams, options, }) {
         var _a, _b;
         if (getCurrentVersion(itemsStateAndParams) === 1) {
             return changeStateAndParamsVersion1({
@@ -239,6 +238,7 @@ export class UpdateManager {
                 itemsStateAndParams,
             });
         }
+        const action = options === null || options === void 0 ? void 0 : options.action;
         const hasState = 'state' in stateAndParams;
         const { items } = config;
         const itemsIds = items.map(({ id: itemId }) => itemId);
@@ -248,6 +248,20 @@ export class UpdateManager {
         const newTabId = (_a = stateAndParams.state) === null || _a === void 0 ? void 0 : _a.tabId;
         const isTabSwitched = isItemWithTabs(initiatorItem) && Boolean(newTabId);
         const currentMeta = getItemsStateAndParamsMeta(itemsStateAndParams);
+        if (action === 'removeItem') {
+            return update(itemsStateAndParams, {
+                $unset: [...unusedIds, initiatorId],
+                [META_KEY]: {
+                    $set: currentMeta
+                        ? deleteFromQueue({
+                            id: initiatorId,
+                            itemsStateAndParams,
+                            config,
+                        })
+                        : getInitialItemsStateAndParamsMeta(),
+                },
+            });
+        }
         if ('params' in stateAndParams) {
             const allowableParams = getAllowableChangedParams(initiatorItem, stateAndParams, itemsStateAndParams);
             const allowableActionParams = getAllowableChangedParams(initiatorItem, stateAndParams, itemsStateAndParams, { type: 'actionParams', returnPrefix: true });
@@ -258,7 +272,7 @@ export class UpdateManager {
             let commandUpdateParams = ((_b = itemsStateAndParams[initiatorId]) === null || _b === void 0 ? void 0 : _b.params)
                 ? '$merge'
                 : '$set';
-            if (isTabSwitched) {
+            if (isTabSwitched || action === 'setParams') {
                 commandUpdateParams = '$set';
             }
             const obj = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravity-ui/dashkit",
-  "version": "6.6.1",
+  "version": "6.7.0",
   "description": "Library for rendering dashboard grid layout",
   "license": "MIT",
   "repository": {

package/build/cjs/utils/__tests__/mock.test.d.ts

@@ -1 +0,0 @@
-

package/build/cjs/utils/__tests__/mock.test.js

@@ -1,8 +0,0 @@
-"use strict";
-describe('test: mock', () => {
-    describe('mock', () => {
-        test('adds 1 + 2 to equal 3', () => {
-            expect(1 + 2).toBe(3);
-        });
-    });
-});

package/build/esm/utils/__tests__/mock.test.d.ts

@@ -1 +0,0 @@
-

package/build/esm/utils/__tests__/mock.test.js

@@ -1,8 +0,0 @@
-"use strict";
-describe('test: mock', () => {
-    describe('mock', () => {
-        test('adds 1 + 2 to equal 3', () => {
-            expect(1 + 2).toBe(3);
-        });
-    });
-});