@gravity-ui/dashkit 5.3.0 → 5.4.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [5.4.0](https://github.com/gravity-ui/dashkit/compare/v5.3.0...v5.4.0) (2023-04-13)
+
+
+### Features
+
+* add widget defaults ([#52](https://github.com/gravity-ui/dashkit/issues/52)) ([a6e512d](https://github.com/gravity-ui/dashkit/commit/a6e512d132e6c9f0fc93d63527f233656863831e))
+* clear default actionParams ([#55](https://github.com/gravity-ui/dashkit/issues/55)) ([4184b82](https://github.com/gravity-ui/dashkit/commit/4184b828228c6faae21a9c9731fee544f7dd5362))
+
 ## [5.3.0](https://github.com/gravity-ui/dashkit/compare/v5.2.0...v5.3.0) (2023-04-06)
 
 

package/build/cjs/shared/modules/helpers.d.ts

@@ -69,4 +69,13 @@ export declare function hasActionParam(conf?: StringParams): boolean;
  * @param stateAndParams
  */
 export declare function hasActionParams(stateAndParams: ItemStateAndParams): boolean;
+/**
+ * Collect array of actionParams keys with prefix (_ap_) that must be cleared from widget defaults
+ * @param defaultWidgetParams
+ * @param queueWidgetParams
+ */
+export declare function getDefaultsActionParamsToClear({ defaultWidgetParams, queueWidgetParams, }: {
+    defaultWidgetParams: StringParams;
+    queueWidgetParams: StringParams;
+}): string[];
 export {};

package/build/cjs/shared/modules/helpers.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasActionParams = exports.hasActionParam = exports.transformParamsToActionParams = exports.pickExceptActionParamsFromParams = exports.pickActionParamsFromParams = exports.deleteFromQueue = exports.addToQueue = exports.getInitialItemsStateAndParamsMeta = exports.mergeParamsWithAliases = exports.getMapItemsIgnores = exports.resolveItemInnerId = exports.formQueueData = exports.isItemWithTabs = exports.getCurrentVersion = exports.getItemsStateAndParamsMeta = exports.prerenderItems = void 0;
+exports.getDefaultsActionParamsToClear = exports.hasActionParams = exports.hasActionParam = exports.transformParamsToActionParams = exports.pickExceptActionParamsFromParams = exports.pickActionParamsFromParams = exports.deleteFromQueue = exports.addToQueue = exports.getInitialItemsStateAndParamsMeta = exports.mergeParamsWithAliases = exports.getMapItemsIgnores = exports.resolveItemInnerId = exports.formQueueData = exports.isItemWithTabs = exports.getCurrentVersion = exports.getItemsStateAndParamsMeta = exports.prerenderItems = void 0;
 const tslib_1 = require("tslib");
 const keyBy_1 = tslib_1.__importDefault(require("lodash/keyBy"));
 const get_1 = tslib_1.__importDefault(require("lodash/get"));
 const invert_1 = tslib_1.__importDefault(require("lodash/invert"));
 const isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
 const pick_1 = tslib_1.__importDefault(require("lodash/pick"));
+const intersection_1 = tslib_1.__importDefault(require("lodash/intersection"));
 const constants_1 = require("../constants");
 function getNormalizedPlugins(plugins) {
     return (0, keyBy_1.default)(plugins, 'type');
@@ -259,3 +260,23 @@ function hasActionParams(stateAndParams) {
     return hasActionParam(stateAndParams.params);
 }
 exports.hasActionParams = hasActionParams;
+/**
+ * Collect array of actionParams keys with prefix (_ap_) that must be cleared from widget defaults
+ * @param defaultWidgetParams
+ * @param queueWidgetParams
+ */
+function getDefaultsActionParamsToClear({ defaultWidgetParams, queueWidgetParams, }) {
+    const widgetDefaultsWithActionParams = hasActionParam(defaultWidgetParams)
+        ? pickActionParamsFromParams(defaultWidgetParams)
+        : null;
+    if (!widgetDefaultsWithActionParams) {
+        return [];
+    }
+    // clear default actionParams if some param with the same name without prefix affected on current widget
+    // ex.: queueWidgetParams contain {Year: 1970} and default actionParams contain {_ap_Year: 2000}
+    const actionParamKeyToClear = (0, intersection_1.default)(Object.keys(queueWidgetParams), Object.keys(widgetDefaultsWithActionParams));
+    return actionParamKeyToClear.length
+        ? actionParamKeyToClear.map((key) => `${constants_1.ACTION_PARAM_PREFIX}${key}`)
+        : [];
+}
+exports.getDefaultsActionParamsToClear = getDefaultsActionParamsToClear;

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

@@ -14,7 +14,7 @@ function getItemsParams({ defaultGlobalParams = {}, globalParams = {}, config, i
     const queueData = isFirstVersion
         ? []
         : (0, helpers_1.formQueueData)({ items, itemsStateAndParams });
-    // В будущем учитывать не только игноры, когда такой kind появится
+    // to consider other kind types in future (not only ignore)
     const mapItemsIgnores = (0, helpers_1.getMapItemsIgnores)({
         items,
         ignores: connections.filter(({ kind }) => kind === 'ignore'),
@@ -24,23 +24,33 @@ function getItemsParams({ defaultGlobalParams = {}, globalParams = {}, config, i
     const groupByNamespace = (0, groupBy_1.default)(items, 'namespace');
     const itemsWithDefaultsByNamespace = Object.keys(groupByNamespace).reduce((acc, namespace) => {
         return Object.assign(Object.assign({}, acc), { 
-            // Сейчас дефолты только у Селектов, затем для виджетов нужно доставать из item.data.tabs[].defaults
-            // но определиться с порядком их применения
+            // there are defaults only in selectors by now, need to get them from item.data.tabs[].defaults for widgets
+            // but make a decision about there's order first
             [namespace]: groupByNamespace[namespace].filter((item) => item.defaults) });
     }, {});
     return items.reduce((itemsParams, item) => {
-        var _a;
+        var _a, _b;
         const { id, namespace } = item;
+        let defaultWidgetParams = {};
+        if ((0, helpers_1.isItemWithTabs)(item)) {
+            const currentWidgetTabId = (0, helpers_1.resolveItemInnerId)({ item, itemsStateAndParams });
+            const itemTabs = item.data.tabs;
+            defaultWidgetParams =
+                ((_a = itemTabs.find((tabItem) => (tabItem === null || tabItem === void 0 ? void 0 : tabItem.id) === currentWidgetTabId)) === null || _a === void 0 ? void 0 : _a.params) || {};
+        }
+        else {
+            defaultWidgetParams = item.defaults || {};
+        }
         const getMergedParams = (params, actionParams) => (0, helpers_1.mergeParamsWithAliases)({ aliases, namespace, params: params || {}, actionParams });
         const itemIgnores = mapItemsIgnores[id];
         const affectingItemsWithDefaults = itemsWithDefaultsByNamespace[namespace].filter((itemWithDefaults) => !itemIgnores.includes(itemWithDefaults.id));
         let itemParams = Object.assign({}, getMergedParams(defaultGlobalParams), 
-        // Стартовые дефолтные параметры
+        // default parameters to begin with
         affectingItemsWithDefaults.reduceRight((defaultParams, itemWithDefaults) => {
             return Object.assign(Object.assign({}, defaultParams), getMergedParams(itemWithDefaults.defaults || {}));
         }, {}), getMergedParams(globalParams));
         if (isFirstVersion) {
-            itemParams = Object.assign(itemParams, ((_a = itemsStateAndParams === null || itemsStateAndParams === void 0 ? void 0 : itemsStateAndParams[id]) === null || _a === void 0 ? void 0 : _a.params) || {});
+            itemParams = Object.assign(itemParams, ((_b = itemsStateAndParams === null || itemsStateAndParams === void 0 ? void 0 : itemsStateAndParams[id]) === null || _b === void 0 ? void 0 : _b.params) || {});
         }
         else {
             // params according to queue of its applying
@@ -68,9 +78,16 @@ function getItemsParams({ defaultGlobalParams = {}, globalParams = {}, config, i
                     ? (0, helpers_1.pickActionParamsFromParams)(data.params, true)
                     : {};
             }
+            const clearActionParams = (0, helpers_1.getDefaultsActionParamsToClear)({
+                defaultWidgetParams,
+                queueWidgetParams: queueDataItems,
+            });
+            if (clearActionParams.length) {
+                defaultWidgetParams = (0, omit_1.default)(defaultWidgetParams, clearActionParams);
+            }
             itemParams = Object.assign(itemParams, queueDataItems);
         }
-        return Object.assign(Object.assign({}, itemsParams), { [id]: itemParams });
+        return Object.assign(Object.assign({}, itemsParams), { [id]: Object.assign(Object.assign({}, defaultWidgetParams), itemParams) });
     }, {});
 }
 exports.getItemsParams = getItemsParams;

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

@@ -274,6 +274,7 @@ const stateAndParamsForAP1 = {
         Q8: {
             params: {
                 Country: '',
+                Year: '',
                 _ap_Country: 'Italy',
                 'd079937f-6bc4-4133-9171-40092bb20d6f': '',
             },
@@ -301,7 +302,11 @@ const stateAndParamsForAP2 = {
             state: {},
         },
         Q8: {
-            params: { Country: 'Belgium', 'd079937f-6bc4-4133-9171-40092bb20d6f': 'Belgium' },
+            params: {
+                Country: 'Belgium',
+                Year: '',
+                'd079937f-6bc4-4133-9171-40092bb20d6f': 'Belgium',
+            },
             state: {},
         },
         al: {
@@ -327,6 +332,7 @@ const stateAndParamsForAP3 = {
         Q8: {
             params: {
                 Country: '',
+                Year: '',
                 'd079937f-6bc4-4133-9171-40092bb20d6f': '',
             },
             state: {},
@@ -357,6 +363,7 @@ const stateAndParamsForAP4 = {
         Q8: {
             params: {
                 Country: '',
+                Year: '',
                 _ap_Country: '',
                 'd079937f-6bc4-4133-9171-40092bb20d6f': '',
             },
@@ -371,6 +378,38 @@ const stateAndParamsForAP4 = {
         },
     },
 };
+const stateAndParamsForAP5 = {
+    in: {
+        Q8: { params: {} },
+        L5: { params: {} },
+        __meta__: { queue: [], version: 2 },
+    },
+    out: {
+        L5: {
+            params: {
+                Country: ['Italy', 'France'],
+                'd079937f-6bc4-4133-9171-40092bb20d6f': ['Italy', 'France'],
+            },
+            state: {},
+        },
+        Q8: {
+            params: {
+                Country: ['Italy', 'France'],
+                Year: '',
+                _ap_Country: 'Belgium',
+                'd079937f-6bc4-4133-9171-40092bb20d6f': ['Italy', 'France'],
+            },
+            state: {},
+        },
+        al: {
+            params: {
+                Country: ['Italy', 'France'],
+                'd079937f-6bc4-4133-9171-40092bb20d6f': ['Italy', 'France'],
+            },
+            state: {},
+        },
+    },
+};
 const configs = configs_json_1.default.configs;
 describe('getItemsStateAndParamsDL', () => {
     describe('old version fallback', () => {
@@ -452,4 +491,15 @@ describe('getItemsStateAndParams actionParams variants check', () => {
             expect(resultItemsStateAndParams).toEqual((0, omit_1.default)(stateAndParamsForAP4.out, constants_1.META_KEY));
         });
     });
+    describe('action and params state 5', () => {
+        const resultItemsStateAndParams = (0, datalens_1.getItemsStateAndParamsDL)({
+            defaultGlobalParams: {},
+            globalParams: {},
+            config: configs[3],
+            itemsStateAndParams: stateAndParamsForAP5.in,
+        });
+        it('return stateAndParamsForAP5.out', () => {
+            expect(resultItemsStateAndParams).toEqual((0, omit_1.default)(stateAndParamsForAP5.out, constants_1.META_KEY));
+        });
+    });
 });

package/build/esm/shared/modules/helpers.d.ts

@@ -69,4 +69,13 @@ export declare function hasActionParam(conf?: StringParams): boolean;
  * @param stateAndParams
  */
 export declare function hasActionParams(stateAndParams: ItemStateAndParams): boolean;
+/**
+ * Collect array of actionParams keys with prefix (_ap_) that must be cleared from widget defaults
+ * @param defaultWidgetParams
+ * @param queueWidgetParams
+ */
+export declare function getDefaultsActionParamsToClear({ defaultWidgetParams, queueWidgetParams, }: {
+    defaultWidgetParams: StringParams;
+    queueWidgetParams: StringParams;
+}): string[];
 export {};

package/build/esm/shared/modules/helpers.js

@@ -3,6 +3,7 @@ import get from 'lodash/get';
 import invert from 'lodash/invert';
 import isEmpty from 'lodash/isEmpty';
 import pick from 'lodash/pick';
+import intersection from 'lodash/intersection';
 import { META_KEY, CURRENT_VERSION, ACTION_PARAM_PREFIX } from '../constants';
 function getNormalizedPlugins(plugins) {
     return keyBy(plugins, 'type');
@@ -239,3 +240,22 @@ export function hasActionParams(stateAndParams) {
     }
     return hasActionParam(stateAndParams.params);
 }
+/**
+ * Collect array of actionParams keys with prefix (_ap_) that must be cleared from widget defaults
+ * @param defaultWidgetParams
+ * @param queueWidgetParams
+ */
+export function getDefaultsActionParamsToClear({ defaultWidgetParams, queueWidgetParams, }) {
+    const widgetDefaultsWithActionParams = hasActionParam(defaultWidgetParams)
+        ? pickActionParamsFromParams(defaultWidgetParams)
+        : null;
+    if (!widgetDefaultsWithActionParams) {
+        return [];
+    }
+    // clear default actionParams if some param with the same name without prefix affected on current widget
+    // ex.: queueWidgetParams contain {Year: 1970} and default actionParams contain {_ap_Year: 2000}
+    const actionParamKeyToClear = intersection(Object.keys(queueWidgetParams), Object.keys(widgetDefaultsWithActionParams));
+    return actionParamKeyToClear.length
+        ? actionParamKeyToClear.map((key) => `${ACTION_PARAM_PREFIX}${key}`)
+        : [];
+}

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

@@ -2,7 +2,7 @@ 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, } from './helpers';
+import { prerenderItems, formQueueData, getMapItemsIgnores, mergeParamsWithAliases, getCurrentVersion, pickActionParamsFromParams, hasActionParam, pickExceptActionParamsFromParams, transformParamsToActionParams, isItemWithTabs, resolveItemInnerId, getDefaultsActionParamsToClear, } from './helpers';
 export function getItemsParams({ defaultGlobalParams = {}, globalParams = {}, config, itemsStateAndParams, plugins, }) {
     const { aliases, connections } = config;
     const items = prerenderItems({ items: config.items, plugins });
@@ -10,7 +10,7 @@ export function getItemsParams({ defaultGlobalParams = {}, globalParams = {}, co
     const queueData = isFirstVersion
         ? []
         : formQueueData({ items, itemsStateAndParams });
-    // В будущем учитывать не только игноры, когда такой kind появится
+    // to consider other kind types in future (not only ignore)
     const mapItemsIgnores = getMapItemsIgnores({
         items,
         ignores: connections.filter(({ kind }) => kind === 'ignore'),
@@ -20,23 +20,33 @@ export function getItemsParams({ defaultGlobalParams = {}, globalParams = {}, co
     const groupByNamespace = groupBy(items, 'namespace');
     const itemsWithDefaultsByNamespace = Object.keys(groupByNamespace).reduce((acc, namespace) => {
         return Object.assign(Object.assign({}, acc), { 
-            // Сейчас дефолты только у Селектов, затем для виджетов нужно доставать из item.data.tabs[].defaults
-            // но определиться с порядком их применения
+            // there are defaults only in selectors by now, need to get them from item.data.tabs[].defaults for widgets
+            // but make a decision about there's order first
             [namespace]: groupByNamespace[namespace].filter((item) => item.defaults) });
     }, {});
     return items.reduce((itemsParams, item) => {
-        var _a;
+        var _a, _b;
         const { id, namespace } = item;
+        let defaultWidgetParams = {};
+        if (isItemWithTabs(item)) {
+            const currentWidgetTabId = resolveItemInnerId({ item, itemsStateAndParams });
+            const itemTabs = item.data.tabs;
+            defaultWidgetParams =
+                ((_a = itemTabs.find((tabItem) => (tabItem === null || tabItem === void 0 ? void 0 : tabItem.id) === currentWidgetTabId)) === null || _a === void 0 ? void 0 : _a.params) || {};
+        }
+        else {
+            defaultWidgetParams = item.defaults || {};
+        }
         const getMergedParams = (params, actionParams) => mergeParamsWithAliases({ aliases, namespace, params: params || {}, actionParams });
         const itemIgnores = mapItemsIgnores[id];
         const affectingItemsWithDefaults = itemsWithDefaultsByNamespace[namespace].filter((itemWithDefaults) => !itemIgnores.includes(itemWithDefaults.id));
         let itemParams = Object.assign({}, getMergedParams(defaultGlobalParams), 
-        // Стартовые дефолтные параметры
+        // default parameters to begin with
         affectingItemsWithDefaults.reduceRight((defaultParams, itemWithDefaults) => {
             return Object.assign(Object.assign({}, defaultParams), getMergedParams(itemWithDefaults.defaults || {}));
         }, {}), getMergedParams(globalParams));
         if (isFirstVersion) {
-            itemParams = Object.assign(itemParams, ((_a = itemsStateAndParams === null || itemsStateAndParams === void 0 ? void 0 : itemsStateAndParams[id]) === null || _a === void 0 ? void 0 : _a.params) || {});
+            itemParams = Object.assign(itemParams, ((_b = itemsStateAndParams === null || itemsStateAndParams === void 0 ? void 0 : itemsStateAndParams[id]) === null || _b === void 0 ? void 0 : _b.params) || {});
         }
         else {
             // params according to queue of its applying
@@ -64,9 +74,16 @@ export function getItemsParams({ defaultGlobalParams = {}, globalParams = {}, co
                     ? pickActionParamsFromParams(data.params, true)
                     : {};
             }
+            const clearActionParams = getDefaultsActionParamsToClear({
+                defaultWidgetParams,
+                queueWidgetParams: queueDataItems,
+            });
+            if (clearActionParams.length) {
+                defaultWidgetParams = omit(defaultWidgetParams, clearActionParams);
+            }
             itemParams = Object.assign(itemParams, queueDataItems);
         }
-        return Object.assign(Object.assign({}, itemsParams), { [id]: itemParams });
+        return Object.assign(Object.assign({}, itemsParams), { [id]: Object.assign(Object.assign({}, defaultWidgetParams), itemParams) });
     }, {});
 }
 export function getItemsState({ config, itemsStateAndParams, }) {

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

@@ -270,6 +270,7 @@ const stateAndParamsForAP1 = {
         Q8: {
             params: {
                 Country: '',
+                Year: '',
                 _ap_Country: 'Italy',
                 'd079937f-6bc4-4133-9171-40092bb20d6f': '',
             },
@@ -297,7 +298,11 @@ const stateAndParamsForAP2 = {
             state: {},
         },
         Q8: {
-            params: { Country: 'Belgium', 'd079937f-6bc4-4133-9171-40092bb20d6f': 'Belgium' },
+            params: {
+                Country: 'Belgium',
+                Year: '',
+                'd079937f-6bc4-4133-9171-40092bb20d6f': 'Belgium',
+            },
             state: {},
         },
         al: {
@@ -323,6 +328,7 @@ const stateAndParamsForAP3 = {
         Q8: {
             params: {
                 Country: '',
+                Year: '',
                 'd079937f-6bc4-4133-9171-40092bb20d6f': '',
             },
             state: {},
@@ -353,6 +359,7 @@ const stateAndParamsForAP4 = {
         Q8: {
             params: {
                 Country: '',
+                Year: '',
                 _ap_Country: '',
                 'd079937f-6bc4-4133-9171-40092bb20d6f': '',
             },
@@ -367,6 +374,38 @@ const stateAndParamsForAP4 = {
         },
     },
 };
+const stateAndParamsForAP5 = {
+    in: {
+        Q8: { params: {} },
+        L5: { params: {} },
+        __meta__: { queue: [], version: 2 },
+    },
+    out: {
+        L5: {
+            params: {
+                Country: ['Italy', 'France'],
+                'd079937f-6bc4-4133-9171-40092bb20d6f': ['Italy', 'France'],
+            },
+            state: {},
+        },
+        Q8: {
+            params: {
+                Country: ['Italy', 'France'],
+                Year: '',
+                _ap_Country: 'Belgium',
+                'd079937f-6bc4-4133-9171-40092bb20d6f': ['Italy', 'France'],
+            },
+            state: {},
+        },
+        al: {
+            params: {
+                Country: ['Italy', 'France'],
+                'd079937f-6bc4-4133-9171-40092bb20d6f': ['Italy', 'France'],
+            },
+            state: {},
+        },
+    },
+};
 const configs = mockConfigs.configs;
 describe('getItemsStateAndParamsDL', () => {
     describe('old version fallback', () => {
@@ -448,4 +487,15 @@ describe('getItemsStateAndParams actionParams variants check', () => {
             expect(resultItemsStateAndParams).toEqual(omit(stateAndParamsForAP4.out, META_KEY));
         });
     });
+    describe('action and params state 5', () => {
+        const resultItemsStateAndParams = getItemsStateAndParamsDL({
+            defaultGlobalParams: {},
+            globalParams: {},
+            config: configs[3],
+            itemsStateAndParams: stateAndParamsForAP5.in,
+        });
+        it('return stateAndParamsForAP5.out', () => {
+            expect(resultItemsStateAndParams).toEqual(omit(stateAndParamsForAP5.out, META_KEY));
+        });
+    });
 });

package/package.json

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