@gravity-ui/dashkit 8.2.0 → 8.3.0

package/build/cjs/shared/modules/state-and-params.d.ts

@@ -5,9 +5,10 @@ export interface GetItemsParamsArg {
     config: Config;
     itemsStateAndParams: ItemsStateAndParams;
     plugins: PluginBase[];
+    useStateAsInitial?: boolean;
 }
 type GetItemsParamsReturn = Record<string, StringParams | Record<string, StringParams>>;
-export declare function getItemsParams({ defaultGlobalParams, globalParams, config, itemsStateAndParams, plugins, }: GetItemsParamsArg): GetItemsParamsReturn;
+export declare function getItemsParams({ defaultGlobalParams, globalParams, config, itemsStateAndParams, plugins, useStateAsInitial, }: GetItemsParamsArg): GetItemsParamsReturn;
 export declare function getItemsState({ config, itemsStateAndParams, }: {
     config: Config;
     itemsStateAndParams: ItemsStateAndParams;

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

@@ -5,7 +5,18 @@ const tslib_1 = require("tslib");
 const groupBy_1 = tslib_1.__importDefault(require("lodash/groupBy"));
 const constants_1 = require("../constants");
 const helpers_1 = require("./helpers");
-function getItemParams({ item, itemsStateAndParams, mapItemsIgnores, itemsWithDefaultsByNamespace, getMergedParams, defaultGlobalParams, globalParams, isFirstVersion, queueData, }) {
+const getParamsFromStateAndParams = ({ itemsStateAndParams, parentItemId, item, }) => {
+    const widgetId = parentItemId || item.id;
+    if (!(widgetId in itemsStateAndParams)) {
+        return {};
+    }
+    const stateAndParams = itemsStateAndParams;
+    const itemParams = parentItemId
+        ? Object.assign({}, stateAndParams[widgetId].params[item.id])
+        : Object.assign({}, stateAndParams[widgetId].params);
+    return itemParams;
+};
+function getItemParams({ item, itemsStateAndParams, mapItemsIgnores, itemsWithDefaultsByNamespace, getMergedParams, defaultGlobalParams, globalParams, isFirstVersion, queueData, parentItemId, useStateAsInitial, }) {
     var _a, _b;
     const { id, namespace } = item;
     let defaultWidgetParams = {};
@@ -24,7 +35,9 @@ function getItemParams({ item, itemsStateAndParams, mapItemsIgnores, itemsWithDe
     // default parameters to begin with
     affectingItemsWithDefaults.reduceRight((defaultParams, itemWithDefaults) => {
         return Object.assign(Object.assign({}, defaultParams), getMergedParams(itemWithDefaults.defaults || {}));
-    }, {}), getMergedParams(globalParams));
+    }, {}), getMergedParams(globalParams), useStateAsInitial
+        ? getParamsFromStateAndParams({ parentItemId, item, itemsStateAndParams })
+        : {});
     if (isFirstVersion) {
         itemParams = Object.assign(itemParams, ((_b = itemsStateAndParams === null || itemsStateAndParams === void 0 ? void 0 : itemsStateAndParams[id]) === null || _b === void 0 ? void 0 : _b.params) || {});
     }
@@ -49,7 +62,7 @@ function getItemParams({ item, itemsStateAndParams, mapItemsIgnores, itemsWithDe
     }
     return Object.assign(Object.assign({}, defaultWidgetParams), itemParams);
 }
-function getItemsParams({ defaultGlobalParams = {}, globalParams = {}, config, itemsStateAndParams, plugins, }) {
+function getItemsParams({ defaultGlobalParams = {}, globalParams = {}, config, itemsStateAndParams, plugins, useStateAsInitial, }) {
     const { aliases, connections } = config;
     const items = (0, helpers_1.prerenderItems)({ items: config.items, plugins });
     const isFirstVersion = (0, helpers_1.getCurrentVersion)(itemsStateAndParams) === 1;
@@ -92,10 +105,11 @@ function getItemsParams({ defaultGlobalParams = {}, globalParams = {}, config, i
             globalParams,
             isFirstVersion,
             queueData,
+            useStateAsInitial,
         };
         if ((0, helpers_1.isItemWithGroup)(item)) {
             const groupParams = item.data.group.reduce((groupItemParams, groupItem) => {
-                groupItemParams[groupItem.id] = getItemParams(Object.assign({ item: groupItem }, paramsOptions));
+                groupItemParams[groupItem.id] = getItemParams(Object.assign({ item: groupItem, parentItemId: item.id }, paramsOptions));
                 return groupItemParams;
             }, {});
             return Object.assign(Object.assign({}, itemsParams), { [id]: groupParams });

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

@@ -1,4 +1,4 @@
-import type { Config, ConfigItem, ItemStateAndParams, ItemStateAndParamsChangeOptions, ItemsStateAndParams } from '../shared';
+import type { Config, ConfigItem, ConfigItemGroup, ItemStateAndParams, ItemStateAndParamsChangeOptions, ItemsStateAndParams } from '../shared';
 import type { AddConfigItem, SetItemOptions, SetNewItemOptions, WidgetLayout } from '../typings';
 import { RegisterManagerPluginLayout } from './register-manager';
 interface RemoveItemArg {
@@ -13,6 +13,13 @@ interface ChangeStateAndParamsArg {
     stateAndParams: ItemStateAndParams;
     options?: ItemStateAndParamsChangeOptions;
 }
+export declare const getChangedParams: ({ initiatorItem, stateAndParams, itemsStateAndParams, }: {
+    initiatorItem: ConfigItem | ConfigItemGroup;
+    stateAndParams: ItemStateAndParams;
+    itemsStateAndParams: ItemsStateAndParams;
+}) => {
+    [x: string]: string | string[];
+};
 export declare class UpdateManager {
     static addItem({ item, namespace, layout, config, options, }: {
         item: AddConfigItem;

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UpdateManager = void 0;
+exports.UpdateManager = exports.getChangedParams = void 0;
 const tslib_1 = require("tslib");
 const immutability_helper_1 = tslib_1.__importStar(require("immutability-helper"));
 const omit_1 = tslib_1.__importDefault(require("lodash/omit"));
@@ -78,6 +78,12 @@ function getAllowableChangedParams(item, stateAndParams, itemsStateAndParams, pa
             : allowedParams;
     }
     const stateParamsConf = stateAndParams.params;
+    // check if structure is StringParams or Record<string, StringParams>
+    // if it's Record<string, StringParams>, then this is a group application of params
+    // and checking for comparison of allowedParams and stateParamsConf is not necessary
+    const isGroupParamsApply = typeof (stateParamsConf === null || stateParamsConf === void 0 ? void 0 : stateParamsConf[item.id]) === 'object' &&
+        (stateParamsConf === null || stateParamsConf === void 0 ? void 0 : stateParamsConf[item.id]) !== null &&
+        !Array.isArray(stateParamsConf === null || stateParamsConf === void 0 ? void 0 : stateParamsConf[item.id]);
     if ((0, shared_1.isItemWithTabs)(item)) {
         let tab;
         if ('state' in stateAndParams && ((_a = stateAndParams.state) === null || _a === void 0 ? void 0 : _a.tabId)) {
@@ -90,14 +96,11 @@ function getAllowableChangedParams(item, stateAndParams, itemsStateAndParams, pa
         allowedParams = (0, pick_1.default)(stateParamsConf, Object.keys((tab === null || tab === void 0 ? void 0 : tab.params) || {}));
     }
     else {
-        // check if structure is StringParams or Record<string, StringParams>
-        const paramsConf = typeof (stateParamsConf === null || stateParamsConf === void 0 ? void 0 : stateParamsConf[item.id]) === 'object' &&
-            !Array.isArray(stateParamsConf === null || stateParamsConf === void 0 ? void 0 : stateParamsConf[item.id])
-            ? stateParamsConf[item.id]
-            : stateParamsConf;
+        const paramsConf = isGroupParamsApply ? stateParamsConf[item.id] : stateParamsConf;
         allowedParams = (0, pick_1.default)(paramsConf, Object.keys(item.defaults || {}));
     }
-    if (Object.keys(allowedParams || {}).length !== Object.keys(stateParamsConf || {}).length) {
+    if (!isGroupParamsApply &&
+        Object.keys(allowedParams || {}).length !== Object.keys(stateParamsConf || {}).length) {
         console.warn('Параметры, которых нет в defaults, будут проигнорированы!');
     }
     return allowedParams;
@@ -180,6 +183,12 @@ function getNewItemData({ item, config, counter: argsCounter, salt, options }) {
     }
     return { data, counter, excludeIds };
 }
+const getChangedParams = ({ initiatorItem, stateAndParams, itemsStateAndParams, }) => {
+    const allowableParams = getAllowableChangedParams(initiatorItem, stateAndParams, itemsStateAndParams);
+    const allowableActionParams = getAllowableChangedParams(initiatorItem, stateAndParams, itemsStateAndParams, { type: 'actionParams', returnPrefix: true });
+    return Object.assign(Object.assign({}, allowableParams), allowableActionParams);
+};
+exports.getChangedParams = getChangedParams;
 function changeGroupParams({ groupItemIds, initiatorId, initiatorItem, itemsStateAndParams, stateAndParams, config, unusedIds, }) {
     var _a;
     const meta = (0, shared_1.addGroupToQueue)({
@@ -192,9 +201,12 @@ function changeGroupParams({ groupItemIds, initiatorId, initiatorItem, itemsStat
     const currentItemParams = (_a = itemsStateAndParams[initiatorId]) === null || _a === void 0 ? void 0 : _a.params;
     for (const groupItem of initiatorItem.data.group) {
         if (groupItemIds.includes(groupItem.id)) {
-            const allowableParams = getAllowableChangedParams(groupItem, stateAndParams, itemsStateAndParams);
-            const allowableActionParams = getAllowableChangedParams(groupItem, stateAndParams, itemsStateAndParams, { type: 'actionParams', returnPrefix: true });
-            updatedItems[groupItem.id] = Object.assign(Object.assign({}, allowableParams), allowableActionParams);
+            const changedParams = (0, exports.getChangedParams)({
+                initiatorItem: groupItem,
+                stateAndParams,
+                itemsStateAndParams,
+            });
+            updatedItems[groupItem.id] = changedParams;
             continue;
         }
         if (currentItemParams && currentItemParams[groupItem.id]) {
@@ -354,8 +366,11 @@ class UpdateManager {
             });
         }
         if ('params' in stateAndParams) {
-            const allowableParams = getAllowableChangedParams(initiatorItem, stateAndParams, itemsStateAndParams);
-            const allowableActionParams = getAllowableChangedParams(initiatorItem, stateAndParams, itemsStateAndParams, { type: 'actionParams', returnPrefix: true });
+            const changedParams = (0, exports.getChangedParams)({
+                initiatorItem,
+                stateAndParams,
+                itemsStateAndParams,
+            });
             const tabId = (0, shared_1.isItemWithTabs)(initiatorItem)
                 ? newTabId || (0, shared_1.resolveItemInnerId)({ item: initiatorItem, itemsStateAndParams })
                 : undefined;
@@ -370,7 +385,7 @@ class UpdateManager {
                 $unset: unusedIds,
                 [initiatorId]: {
                     $auto: Object.assign({ params: {
-                            [commandUpdateParams]: Object.assign(Object.assign({}, allowableParams), allowableActionParams),
+                            [commandUpdateParams]: changedParams,
                         } }, (hasState ? { state: { $set: stateAndParams.state } } : {})),
                 },
                 [shared_1.META_KEY]: { $set: meta },

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

@@ -5,9 +5,10 @@ export interface GetItemsParamsArg {
     config: Config;
     itemsStateAndParams: ItemsStateAndParams;
     plugins: PluginBase[];
+    useStateAsInitial?: boolean;
 }
 type GetItemsParamsReturn = Record<string, StringParams | Record<string, StringParams>>;
-export declare function getItemsParams({ defaultGlobalParams, globalParams, config, itemsStateAndParams, plugins, }: GetItemsParamsArg): GetItemsParamsReturn;
+export declare function getItemsParams({ defaultGlobalParams, globalParams, config, itemsStateAndParams, plugins, useStateAsInitial, }: GetItemsParamsArg): GetItemsParamsReturn;
 export declare function getItemsState({ config, itemsStateAndParams, }: {
     config: Config;
     itemsStateAndParams: ItemsStateAndParams;

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

@@ -1,7 +1,18 @@
 import groupBy from 'lodash/groupBy';
 import { META_KEY } from '../constants';
 import { formQueueData, getCurrentVersion, getMapItemsIgnores, hasActionParam, isItemWithGroup, isItemWithTabs, mergeParamsWithAliases, pickActionParamsFromParams, pickExceptActionParamsFromParams, prerenderItems, resolveItemInnerId, } from './helpers';
-function getItemParams({ item, itemsStateAndParams, mapItemsIgnores, itemsWithDefaultsByNamespace, getMergedParams, defaultGlobalParams, globalParams, isFirstVersion, queueData, }) {
+const getParamsFromStateAndParams = ({ itemsStateAndParams, parentItemId, item, }) => {
+    const widgetId = parentItemId || item.id;
+    if (!(widgetId in itemsStateAndParams)) {
+        return {};
+    }
+    const stateAndParams = itemsStateAndParams;
+    const itemParams = parentItemId
+        ? Object.assign({}, stateAndParams[widgetId].params[item.id])
+        : Object.assign({}, stateAndParams[widgetId].params);
+    return itemParams;
+};
+function getItemParams({ item, itemsStateAndParams, mapItemsIgnores, itemsWithDefaultsByNamespace, getMergedParams, defaultGlobalParams, globalParams, isFirstVersion, queueData, parentItemId, useStateAsInitial, }) {
     var _a, _b;
     const { id, namespace } = item;
     let defaultWidgetParams = {};
@@ -20,7 +31,9 @@ function getItemParams({ item, itemsStateAndParams, mapItemsIgnores, itemsWithDe
     // default parameters to begin with
     affectingItemsWithDefaults.reduceRight((defaultParams, itemWithDefaults) => {
         return Object.assign(Object.assign({}, defaultParams), getMergedParams(itemWithDefaults.defaults || {}));
-    }, {}), getMergedParams(globalParams));
+    }, {}), getMergedParams(globalParams), useStateAsInitial
+        ? getParamsFromStateAndParams({ parentItemId, item, itemsStateAndParams })
+        : {});
     if (isFirstVersion) {
         itemParams = Object.assign(itemParams, ((_b = itemsStateAndParams === null || itemsStateAndParams === void 0 ? void 0 : itemsStateAndParams[id]) === null || _b === void 0 ? void 0 : _b.params) || {});
     }
@@ -45,7 +58,7 @@ function getItemParams({ item, itemsStateAndParams, mapItemsIgnores, itemsWithDe
     }
     return Object.assign(Object.assign({}, defaultWidgetParams), itemParams);
 }
-export function getItemsParams({ defaultGlobalParams = {}, globalParams = {}, config, itemsStateAndParams, plugins, }) {
+export function getItemsParams({ defaultGlobalParams = {}, globalParams = {}, config, itemsStateAndParams, plugins, useStateAsInitial, }) {
     const { aliases, connections } = config;
     const items = prerenderItems({ items: config.items, plugins });
     const isFirstVersion = getCurrentVersion(itemsStateAndParams) === 1;
@@ -88,10 +101,11 @@ export function getItemsParams({ defaultGlobalParams = {}, globalParams = {}, co
             globalParams,
             isFirstVersion,
             queueData,
+            useStateAsInitial,
         };
         if (isItemWithGroup(item)) {
             const groupParams = item.data.group.reduce((groupItemParams, groupItem) => {
-                groupItemParams[groupItem.id] = getItemParams(Object.assign({ item: groupItem }, paramsOptions));
+                groupItemParams[groupItem.id] = getItemParams(Object.assign({ item: groupItem, parentItemId: item.id }, paramsOptions));
                 return groupItemParams;
             }, {});
             return Object.assign(Object.assign({}, itemsParams), { [id]: groupParams });

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

@@ -1,4 +1,4 @@
-import type { Config, ConfigItem, ItemStateAndParams, ItemStateAndParamsChangeOptions, ItemsStateAndParams } from '../shared';
+import type { Config, ConfigItem, ConfigItemGroup, ItemStateAndParams, ItemStateAndParamsChangeOptions, ItemsStateAndParams } from '../shared';
 import type { AddConfigItem, SetItemOptions, SetNewItemOptions, WidgetLayout } from '../typings';
 import { RegisterManagerPluginLayout } from './register-manager';
 interface RemoveItemArg {
@@ -13,6 +13,13 @@ interface ChangeStateAndParamsArg {
     stateAndParams: ItemStateAndParams;
     options?: ItemStateAndParamsChangeOptions;
 }
+export declare const getChangedParams: ({ initiatorItem, stateAndParams, itemsStateAndParams, }: {
+    initiatorItem: ConfigItem | ConfigItemGroup;
+    stateAndParams: ItemStateAndParams;
+    itemsStateAndParams: ItemsStateAndParams;
+}) => {
+    [x: string]: string | string[];
+};
 export declare class UpdateManager {
     static addItem({ item, namespace, layout, config, options, }: {
         item: AddConfigItem;

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

@@ -74,6 +74,12 @@ function getAllowableChangedParams(item, stateAndParams, itemsStateAndParams, pa
             : allowedParams;
     }
     const stateParamsConf = stateAndParams.params;
+    // check if structure is StringParams or Record<string, StringParams>
+    // if it's Record<string, StringParams>, then this is a group application of params
+    // and checking for comparison of allowedParams and stateParamsConf is not necessary
+    const isGroupParamsApply = typeof (stateParamsConf === null || stateParamsConf === void 0 ? void 0 : stateParamsConf[item.id]) === 'object' &&
+        (stateParamsConf === null || stateParamsConf === void 0 ? void 0 : stateParamsConf[item.id]) !== null &&
+        !Array.isArray(stateParamsConf === null || stateParamsConf === void 0 ? void 0 : stateParamsConf[item.id]);
     if (isItemWithTabs(item)) {
         let tab;
         if ('state' in stateAndParams && ((_a = stateAndParams.state) === null || _a === void 0 ? void 0 : _a.tabId)) {
@@ -86,14 +92,11 @@ function getAllowableChangedParams(item, stateAndParams, itemsStateAndParams, pa
         allowedParams = pick(stateParamsConf, Object.keys((tab === null || tab === void 0 ? void 0 : tab.params) || {}));
     }
     else {
-        // check if structure is StringParams or Record<string, StringParams>
-        const paramsConf = typeof (stateParamsConf === null || stateParamsConf === void 0 ? void 0 : stateParamsConf[item.id]) === 'object' &&
-            !Array.isArray(stateParamsConf === null || stateParamsConf === void 0 ? void 0 : stateParamsConf[item.id])
-            ? stateParamsConf[item.id]
-            : stateParamsConf;
+        const paramsConf = isGroupParamsApply ? stateParamsConf[item.id] : stateParamsConf;
         allowedParams = pick(paramsConf, Object.keys(item.defaults || {}));
     }
-    if (Object.keys(allowedParams || {}).length !== Object.keys(stateParamsConf || {}).length) {
+    if (!isGroupParamsApply &&
+        Object.keys(allowedParams || {}).length !== Object.keys(stateParamsConf || {}).length) {
         console.warn('Параметры, которых нет в defaults, будут проигнорированы!');
     }
     return allowedParams;
@@ -176,6 +179,11 @@ function getNewItemData({ item, config, counter: argsCounter, salt, options }) {
     }
     return { data, counter, excludeIds };
 }
+export const getChangedParams = ({ initiatorItem, stateAndParams, itemsStateAndParams, }) => {
+    const allowableParams = getAllowableChangedParams(initiatorItem, stateAndParams, itemsStateAndParams);
+    const allowableActionParams = getAllowableChangedParams(initiatorItem, stateAndParams, itemsStateAndParams, { type: 'actionParams', returnPrefix: true });
+    return Object.assign(Object.assign({}, allowableParams), allowableActionParams);
+};
 function changeGroupParams({ groupItemIds, initiatorId, initiatorItem, itemsStateAndParams, stateAndParams, config, unusedIds, }) {
     var _a;
     const meta = addGroupToQueue({
@@ -188,9 +196,12 @@ function changeGroupParams({ groupItemIds, initiatorId, initiatorItem, itemsStat
     const currentItemParams = (_a = itemsStateAndParams[initiatorId]) === null || _a === void 0 ? void 0 : _a.params;
     for (const groupItem of initiatorItem.data.group) {
         if (groupItemIds.includes(groupItem.id)) {
-            const allowableParams = getAllowableChangedParams(groupItem, stateAndParams, itemsStateAndParams);
-            const allowableActionParams = getAllowableChangedParams(groupItem, stateAndParams, itemsStateAndParams, { type: 'actionParams', returnPrefix: true });
-            updatedItems[groupItem.id] = Object.assign(Object.assign({}, allowableParams), allowableActionParams);
+            const changedParams = getChangedParams({
+                initiatorItem: groupItem,
+                stateAndParams,
+                itemsStateAndParams,
+            });
+            updatedItems[groupItem.id] = changedParams;
             continue;
         }
         if (currentItemParams && currentItemParams[groupItem.id]) {
@@ -350,8 +361,11 @@ export class UpdateManager {
             });
         }
         if ('params' in stateAndParams) {
-            const allowableParams = getAllowableChangedParams(initiatorItem, stateAndParams, itemsStateAndParams);
-            const allowableActionParams = getAllowableChangedParams(initiatorItem, stateAndParams, itemsStateAndParams, { type: 'actionParams', returnPrefix: true });
+            const changedParams = getChangedParams({
+                initiatorItem,
+                stateAndParams,
+                itemsStateAndParams,
+            });
             const tabId = isItemWithTabs(initiatorItem)
                 ? newTabId || resolveItemInnerId({ item: initiatorItem, itemsStateAndParams })
                 : undefined;
@@ -366,7 +380,7 @@ export class UpdateManager {
                 $unset: unusedIds,
                 [initiatorId]: {
                     $auto: Object.assign({ params: {
-                            [commandUpdateParams]: Object.assign(Object.assign({}, allowableParams), allowableActionParams),
+                            [commandUpdateParams]: changedParams,
                         } }, (hasState ? { state: { $set: stateAndParams.state } } : {})),
                 },
                 [META_KEY]: { $set: meta },

package/package.json

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