@gravity-ui/dashkit 6.7.2 → 6.9.0

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

@@ -1,6 +1,6 @@
 "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.hasActionParams = exports.hasActionParam = exports.transformParamsToActionParams = exports.pickExceptActionParamsFromParams = exports.pickActionParamsFromParams = exports.deleteFromQueue = exports.addGroupToQueue = exports.addToQueue = exports.getInitialItemsStateAndParamsMeta = exports.mergeParamsWithAliases = exports.getMapItemsIgnores = exports.resolveItemInnerId = exports.formQueueData = exports.isItemWithGroup = 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"));
@@ -44,31 +44,56 @@ function getCurrentVersion(itemsStateAndParams) {
     return meta.version;
 }
 exports.getCurrentVersion = getCurrentVersion;
-function nonNullable(value) {
-    return value !== null && value !== undefined;
+function isConfigData(item) {
+    return 'data' in item && 'type' in item;
 }
 function isItemWithTabs(item) {
     var _a;
-    return Array.isArray((_a = item === null || item === void 0 ? void 0 : item.data) === null || _a === void 0 ? void 0 : _a.tabs);
+    return isConfigData(item) && Array.isArray((_a = item === null || item === void 0 ? void 0 : item.data) === null || _a === void 0 ? void 0 : _a.tabs);
 }
 exports.isItemWithTabs = isItemWithTabs;
+function isItemWithGroup(item) {
+    var _a;
+    return Array.isArray((_a = item === null || item === void 0 ? void 0 : item.data) === null || _a === void 0 ? void 0 : _a.group);
+}
+exports.isItemWithGroup = isItemWithGroup;
 // Array of parameters from widgets according to queue
 function formQueueData({ items, itemsStateAndParams, }) {
     var _a;
     const queue = ((_a = getItemsStateAndParamsMeta(itemsStateAndParams)) === null || _a === void 0 ? void 0 : _a.queue) || [];
     const keyById = (0, keyBy_1.default)(items, 'id');
-    return queue
-        .map((queueItem) => {
+    return queue.reduce((queueArray, queueItem) => {
         var _a;
-        const { id: queueId, tabId } = queueItem;
+        const { id: queueId, tabId, groupItemId } = queueItem;
         const item = keyById[queueId];
-        if (!item) {
-            return null;
+        const isGroup = isItemWithGroup(item);
+        if (!item || (isGroup && !groupItemId)) {
+            return queueArray;
+        }
+        if (isGroup && groupItemId) {
+            const itemQueueParams = (0, get_1.default)(itemsStateAndParams, [item.id, 'params'], {});
+            const groupItem = item.data.group.find(({ id }) => id === groupItemId);
+            if (!groupItem) {
+                return queueArray;
+            }
+            const groupItemQueueParams = itemQueueParams[groupItemId];
+            const filteredParamsByDefaults = (0, pick_1.default)(groupItemQueueParams, Object.keys(groupItem.defaults || {}));
+            /**
+             * merging filtered params and filtered actionParams with prefixes
+             */
+            const params = Object.assign(Object.assign({}, filteredParamsByDefaults), (pickActionParamsFromParams(groupItemQueueParams, true) || {}));
+            queueArray.push({
+                id: groupItem.id,
+                namespace: groupItem.namespace,
+                params,
+            });
+            return queueArray;
         }
+        const itemQueueParams = (0, get_1.default)(itemsStateAndParams, [item.id, 'params'], {});
         let itemDefaultParams;
         if (isItemWithTabs(item)) {
             if (!tabId || resolveItemInnerId({ item, itemsStateAndParams }) !== tabId) {
-                return null;
+                return queueArray;
             }
             itemDefaultParams =
                 ((_a = item.data.tabs.find((tabData) => tabData.id === tabId)) === null || _a === void 0 ? void 0 : _a.params) || {};
@@ -76,19 +101,18 @@ function formQueueData({ items, itemsStateAndParams, }) {
         else {
             itemDefaultParams = item.defaults || {};
         }
-        const itemQueueParams = (0, get_1.default)(itemsStateAndParams, [item.id, 'params'], {});
         const filteredParamsByDefaults = (0, pick_1.default)(itemQueueParams, Object.keys(itemDefaultParams));
         /**
          * merging filtered params and filtered actionParams with prefixes
          */
         const params = Object.assign(Object.assign({}, filteredParamsByDefaults), (pickActionParamsFromParams(itemQueueParams, true) || {}));
-        return {
+        queueArray.push({
             id: item.id,
             namespace: item.namespace,
             params,
-        };
-    })
-        .filter(nonNullable);
+        });
+        return queueArray;
+    }, []);
 }
 exports.formQueueData = formQueueData;
 function resolveItemInnerId({ item, itemsStateAndParams, }) {
@@ -151,6 +175,17 @@ function getInitialItemsStateAndParamsMeta() {
     };
 }
 exports.getInitialItemsStateAndParamsMeta = getInitialItemsStateAndParamsMeta;
+function getActualItemsIds(items) {
+    return items.reduce((ids, item) => {
+        if (isItemWithGroup(item)) {
+            item.data.group.forEach((groupItem) => {
+                ids.push(groupItem.id);
+            });
+        }
+        ids.push(item.id);
+        return ids;
+    }, []);
+}
 function addToQueue({ id, tabId, config, itemsStateAndParams, }) {
     const queueItem = { id };
     if (tabId) {
@@ -160,17 +195,47 @@ function addToQueue({ id, tabId, config, itemsStateAndParams, }) {
     if (!meta) {
         return { queue: [queueItem], version: constants_1.CURRENT_VERSION };
     }
-    const { items } = config;
-    const actualIds = items.map((item) => item.id);
+    const actualIds = getActualItemsIds(config.items);
     const metaQueue = meta.queue || [];
+    const notCurrent = (item) => {
+        if (item.groupItemId) {
+            return actualIds.includes(item.groupItemId);
+        }
+        return item.id !== id;
+    };
     return {
         queue: metaQueue
-            .filter((item) => actualIds.includes(item.id) && item.id !== id)
+            .filter((item) => actualIds.includes(item.id) && notCurrent(item))
             .concat(queueItem),
         version: meta.version || constants_1.CURRENT_VERSION,
     };
 }
 exports.addToQueue = addToQueue;
+function addGroupToQueue({ id, groupItemIds, config, itemsStateAndParams, }) {
+    const queueItems = groupItemIds.map((groupItemId) => ({
+        id,
+        groupItemId,
+    }));
+    const meta = getItemsStateAndParamsMeta(itemsStateAndParams);
+    if (!meta) {
+        return { queue: queueItems, version: constants_1.CURRENT_VERSION };
+    }
+    const actualIds = getActualItemsIds(config.items);
+    const metaQueue = meta.queue || [];
+    const notCurrent = (item) => {
+        if (item.groupItemId) {
+            return actualIds.includes(item.groupItemId) && !groupItemIds.includes(item.groupItemId);
+        }
+        return true;
+    };
+    return {
+        queue: metaQueue
+            .filter((item) => actualIds.includes(item.id) && notCurrent(item))
+            .concat(queueItems),
+        version: meta.version || constants_1.CURRENT_VERSION,
+    };
+}
+exports.addGroupToQueue = addGroupToQueue;
 function deleteFromQueue(data) {
     const meta = addToQueue(data);
     return Object.assign(Object.assign({}, meta), { queue: meta.queue.slice(0, -1) });
@@ -236,7 +301,12 @@ exports.transformParamsToActionParams = transformParamsToActionParams;
  * @param conf
  */
 function hasActionParam(conf) {
-    return Object.keys(conf || {}).some((key) => key.startsWith(constants_1.ACTION_PARAM_PREFIX));
+    return Object.keys(conf || {}).some((key) => {
+        if (conf && typeof conf[key] === 'object' && !Array.isArray(conf[key])) {
+            return Object.keys(conf[key]).some((subkey) => subkey.startsWith(constants_1.ACTION_PARAM_PREFIX));
+        }
+        return key.startsWith(constants_1.ACTION_PARAM_PREFIX);
+    });
 }
 exports.hasActionParam = hasActionParam;
 /**

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

@@ -1,4 +1,4 @@
-import { GlobalParams, Config, ItemsStateAndParams, PluginBase, StringParams, ItemState } from '../types';
+import { Config, GlobalParams, ItemState, ItemsStateAndParams, PluginBase, StringParams } from '../types';
 export interface GetItemsParamsArg {
     defaultGlobalParams: GlobalParams;
     globalParams: GlobalParams;
@@ -6,7 +6,7 @@ export interface GetItemsParamsArg {
     itemsStateAndParams: ItemsStateAndParams;
     plugins: PluginBase[];
 }
-type GetItemsParamsReturn = Record<string, StringParams>;
+type GetItemsParamsReturn = Record<string, StringParams | Record<string, StringParams>>;
 export declare function getItemsParams({ defaultGlobalParams, globalParams, config, itemsStateAndParams, plugins, }: GetItemsParamsArg): GetItemsParamsReturn;
 export declare function getItemsState({ config, itemsStateAndParams, }: {
     config: Config;

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

@@ -5,21 +5,75 @@ 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, }) {
+    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 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, ((_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
+        let queueDataItemsParams = {};
+        for (const data of queueData) {
+            if (data.namespace !== namespace || itemIgnores.includes(data.id)) {
+                continue;
+            }
+            let actionParams;
+            let params = data.params;
+            const needAliasesForActionParams = data.id !== id && (0, helpers_1.hasActionParam)(data.params);
+            if (needAliasesForActionParams) {
+                actionParams = (0, helpers_1.pickActionParamsFromParams)(data.params);
+                params = (0, helpers_1.pickExceptActionParamsFromParams)(data.params);
+            }
+            const mergedParams = getMergedParams(params, actionParams);
+            queueDataItemsParams = Object.assign(Object.assign({}, queueDataItemsParams), mergedParams);
+        }
+        itemParams = Object.assign(itemParams, queueDataItemsParams);
+    }
+    return Object.assign(Object.assign({}, defaultWidgetParams), itemParams);
+}
 function getItemsParams({ defaultGlobalParams = {}, globalParams = {}, config, itemsStateAndParams, plugins, }) {
     const { aliases, connections } = config;
     const items = (0, helpers_1.prerenderItems)({ items: config.items, plugins });
     const isFirstVersion = (0, helpers_1.getCurrentVersion)(itemsStateAndParams) === 1;
+    const allItems = items.reduce((paramsItems, item) => {
+        if ((0, helpers_1.isItemWithGroup)(item)) {
+            item.data.group.forEach((groupItem) => {
+                paramsItems.push(groupItem);
+            });
+            return paramsItems;
+        }
+        paramsItems.push(item);
+        return paramsItems;
+    }, []);
     const queueData = isFirstVersion
         ? []
         : (0, helpers_1.formQueueData)({ items, itemsStateAndParams });
     // to consider other kind types in future (not only ignore)
     const mapItemsIgnores = (0, helpers_1.getMapItemsIgnores)({
-        items,
+        items: allItems,
         ignores: connections.filter(({ kind }) => kind === 'ignore'),
         itemsStateAndParams,
         isFirstVersion,
     });
-    const groupByNamespace = (0, groupBy_1.default)(items, 'namespace');
+    const groupByNamespace = (0, groupBy_1.default)(allItems, 'namespace');
     const itemsWithDefaultsByNamespace = Object.keys(groupByNamespace).reduce((acc, namespace) => {
         return Object.assign(Object.assign({}, acc), { 
             // there are defaults only in selectors by now, need to get them from item.data.tabs[].defaults for widgets
@@ -27,49 +81,26 @@ function getItemsParams({ defaultGlobalParams = {}, globalParams = {}, config, i
             [namespace]: groupByNamespace[namespace].filter((item) => item.defaults) });
     }, {});
     return items.reduce((itemsParams, item) => {
-        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, ((_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
-            let queueDataItemsParams = {};
-            for (const data of Object.values(queueData)) {
-                if (data.namespace !== namespace || itemIgnores.includes(data.id)) {
-                    continue;
-                }
-                let actionParams;
-                let params = data.params;
-                const needAliasesForActionParams = data.id !== id && (0, helpers_1.hasActionParam)(data.params);
-                if (needAliasesForActionParams) {
-                    actionParams = (0, helpers_1.pickActionParamsFromParams)(data.params);
-                    params = (0, helpers_1.pickExceptActionParamsFromParams)(data.params);
-                }
-                const mergedParams = getMergedParams(params, actionParams);
-                queueDataItemsParams = Object.assign(Object.assign({}, queueDataItemsParams), mergedParams);
-            }
-            itemParams = Object.assign(itemParams, queueDataItemsParams);
+        const paramsOptions = {
+            itemsStateAndParams,
+            mapItemsIgnores,
+            itemsWithDefaultsByNamespace,
+            getMergedParams,
+            defaultGlobalParams,
+            globalParams,
+            isFirstVersion,
+            queueData,
+        };
+        if ((0, helpers_1.isItemWithGroup)(item)) {
+            const groupParams = item.data.group.reduce((groupItemParams, groupItem) => {
+                groupItemParams[groupItem.id] = getItemParams(Object.assign({ item: groupItem }, paramsOptions));
+                return groupItemParams;
+            }, {});
+            return Object.assign(Object.assign({}, itemsParams), { [id]: groupParams });
         }
-        return Object.assign(Object.assign({}, itemsParams), { [id]: Object.assign(Object.assign({}, defaultWidgetParams), itemParams) });
+        return Object.assign(Object.assign({}, itemsParams), { [id]: getItemParams(Object.assign({ item }, paramsOptions)) });
     }, {});
 }
 exports.getItemsParams = getItemsParams;

package/build/cjs/shared/modules/uniq-id.js

@@ -14,6 +14,9 @@ function extractIdsFromConfig(config) {
         if ((0, helpers_1.isItemWithTabs)(item)) {
             item.data.tabs.forEach((tabItem) => ids.push(tabItem.id));
         }
+        if ((0, helpers_1.isItemWithGroup)(item)) {
+            item.data.group.forEach((groupItem) => ids.push(groupItem.id));
+        }
     });
     connections.forEach(({ from, to }) => ids.push(from, to));
     layout.forEach(({ i }) => ids.push(i));

package/build/cjs/shared/types/config.d.ts

@@ -6,6 +6,12 @@ export interface ConfigLayout {
     x: number;
     y: number;
 }
+export type ConfigItemGroup = {
+    id: string;
+    defaults?: StringParams;
+    namespace: string;
+    [key: string]: unknown;
+};
 export interface ConfigItemData {
     _editActive?: boolean;
     tabs?: {
@@ -14,11 +20,15 @@ export interface ConfigItemData {
         params?: StringParams;
         [key: string]: unknown;
     }[];
+    group?: ConfigItemGroup[];
     [key: string]: unknown;
 }
 export interface ConfigItemDataWithTabs extends Omit<ConfigItemData, 'tabs'> {
     tabs: NonNullable<ConfigItemData['tabs']>;
 }
+export interface ConfigItemDataWithGroup extends Omit<ConfigItemData, 'group'> {
+    group: NonNullable<ConfigItemData['group']>;
+}
 export interface ConfigItem {
     id: string;
     data: ConfigItemData;
@@ -31,6 +41,9 @@ export interface ConfigItem {
 export interface ConfigItemWithTabs extends Omit<ConfigItem, 'data'> {
     data: ConfigItemDataWithTabs;
 }
+export interface ConfigItemWithGroup extends Omit<ConfigItem, 'data'> {
+    data: ConfigItemDataWithGroup;
+}
 export interface ConfigAliases {
     [namespace: string]: string[][];
 }

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

@@ -6,6 +6,7 @@ export interface ItemState {
 export interface QueueItem {
     id: string;
     tabId?: string;
+    groupItemId?: string;
 }
 export type StateAndParamsMetaData = {
     queue: QueueItem[];
@@ -15,11 +16,12 @@ export type StateAndParamsMeta = {
     [META_KEY]: StateAndParamsMetaData;
 };
 export type ItemStateAndParams = {
-    params?: StringParams;
+    params?: StringParams | Record<string, StringParams>;
     state?: ItemState;
 };
 export type ItemStateAndParamsChangeOptions = {
-    action: 'setParams' | 'removeItem';
+    action?: 'setParams' | 'removeItem';
+    groupItemIds?: string[];
 };
 export type ItemsStateAndParamsBase = Record<string, ItemStateAndParams>;
 export type ItemsStateAndParams = ItemsStateAndParamsBase | StateAndParamsMeta;

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

@@ -1,11 +1,11 @@
 import React from 'react';
 import { ContextProps, SettingsProps, WidgetLayout } from './common';
-import { StringParams, ConfigItem, ItemState, ItemStateAndParams, PluginBase, ItemStateAndParamsChangeOptions } from '../shared';
+import { ConfigItem, ItemState, ItemStateAndParams, ItemStateAndParamsChangeOptions, PluginBase, StringParams } from '../shared';
 import type { ReactGridLayoutProps } from 'react-grid-layout';
-export interface PluginWidgetProps {
+export interface PluginWidgetProps<T = StringParams> {
     id: string;
     editMode: boolean;
-    params: StringParams;
+    params: T;
     state: ItemState;
     onStateAndParamsChange: (stateAndParams: ItemStateAndParams, options?: ItemStateAndParamsChangeOptions) => void;
     width: number;
@@ -33,7 +33,7 @@ export interface PluginDefaultLayout {
     minH?: number;
     maxH?: number;
 }
-export interface Plugin<P extends PluginWidgetProps = any> extends PluginBase {
+export interface Plugin<P extends PluginWidgetProps<T> = any, T = StringParams> extends PluginBase {
     defaultLayout?: PluginDefaultLayout;
     renderer: (props: P, forwardedRef: React.RefObject<any>) => React.ReactNode;
 }