@gravity-ui/dashkit 6.5.1-beta.1 → 6.6.0-beta.0

package/README.md

@@ -120,6 +120,21 @@ Before using `DashKit` as a react component, it must be configured.
   });
   ```
 
+## Settings
+
+### Autoupdate
+
+This functionality allows you to automatically update the items of the Dash. All items that should participate in the auto-update cycle must have the `reload` method.
+There are two auto-update scenarios available, the first - the classic interval to enable which is enough to pass the `autoupdateInterval` parameter and the second - the so-called `realtimeMode`.
+`realtimeMode` is useful in cases where dash items are updated at different rates and you cannot guarantee data consistency at a given time. `realtimeMode` is based on `Promise.allSettled`.
+
+| Name                | Description                                                                            |    Type   | Default |
+|:--------------------|:---------------------------------------------------------------------------------------|:---------:|:-------:|
+| autoupdateInterval  | The time, in **seconds**, the dash should delay in between executions auto-update      |  `number` |         |
+| realtimeMode        | Enable realtime mode                                                                   | `boolean` |         |
+| realtimeModeDelayMs | The time, in **milliseconds**, the dash should delay after all items have been updated |  `number` |   5000  |
+| silentLoading       | Items update status indicator. It will be passed into the Item `reload` method         | `boolean` |  false  |
+
 ### Config
 
 ```ts

package/build/cjs/components/GridLayout/GridLayout.d.ts

@@ -18,6 +18,10 @@ export default class GridLayout extends React.PureComponent<any, any, any> {
         adjustedWidgetLayout: any;
     }) => void;
     getItemsMeta: () => any;
+    getAutoupdateIntervalMs(): number;
+    startReloadItems(): any;
+    startReloadItemsTimeout(timeoutMs: any): void;
+    forceReloadItems(): void;
     reloadItems(): void;
     _onStart: () => void;
     _onStop: (newLayout: any) => void;

package/build/cjs/components/GridLayout/GridLayout.js

@@ -5,6 +5,7 @@ const react_1 = tslib_1.__importDefault(require("react"));
 const react_grid_layout_1 = tslib_1.__importStar(require("react-grid-layout"));
 const GridItem_1 = tslib_1.__importDefault(require("../GridItem/GridItem"));
 const DashKitContext_1 = require("../../context/DashKitContext");
+const constants_1 = require("../../constants");
 const Layout = (0, react_grid_layout_1.WidthProvider)(react_grid_layout_1.default); // eslint-disable-line new-cap
 class GridLayout extends react_1.default.PureComponent {
     constructor(props, context) {
@@ -49,25 +50,48 @@ class GridLayout extends react_1.default.PureComponent {
         document.addEventListener('visibilitychange', this.onVisibilityChange);
     }
     componentDidUpdate() {
-        clearTimeout(this._timeout);
-        this.reloadItems();
+        this.forceReloadItems();
     }
     componentWillUnmount() {
         clearTimeout(this._timeout);
         document.removeEventListener('visibilitychange', this.onVisibilityChange);
     }
-    reloadItems() {
-        const { editMode, settings: { autoupdateInterval, silentLoading } = {}, reloadItems, } = this.context;
-        const { isPageHidden } = this.state;
+    getAutoupdateIntervalMs() {
+        const { settings: { autoupdateInterval } = {} } = this.context;
         const autoupdateIntervalMs = Number(autoupdateInterval) * 1000;
+        return autoupdateIntervalMs;
+    }
+    startReloadItems() {
+        const { editMode, settings: { silentLoading } = {}, reloadItems } = this.context;
+        const { isPageHidden } = this.state;
+        if (!isPageHidden && !editMode) {
+            this._lastReloadAt = new Date().getTime();
+            return reloadItems(this.pluginsRefs, { silentLoading, noVeil: true });
+        }
+        return Promise.resolve();
+    }
+    startReloadItemsTimeout(timeoutMs) {
+        this._timeout = setTimeout(() => this.forceReloadItems(), timeoutMs);
+    }
+    forceReloadItems() {
+        clearTimeout(this._timeout);
+        this._timeout = undefined;
+        this.reloadItems();
+    }
+    reloadItems() {
+        if (this._timeout)
+            return;
+        const { settings: { realtimeMode, realtimeModeDelayMs = 5000 } = {} } = this.context;
+        if (realtimeMode) {
+            this.startReloadItems().then(() => {
+                this.startReloadItemsTimeout(realtimeModeDelayMs);
+            });
+            return;
+        }
+        const autoupdateIntervalMs = this.getAutoupdateIntervalMs();
         if (autoupdateIntervalMs) {
-            const timeSinceLastReload = new Date().getTime() - (this._lastReloadAt || 0);
-            const reloadIntervalRemains = autoupdateIntervalMs - timeSinceLastReload;
-            if (!isPageHidden && !editMode && reloadIntervalRemains <= 0) {
-                this._lastReloadAt = new Date().getTime();
-                reloadItems(this.pluginsRefs, { silentLoading, noVeil: true });
-            }
-            this._timeout = setTimeout(() => this.reloadItems(), reloadIntervalRemains <= 0 ? autoupdateIntervalMs : reloadIntervalRemains);
+            this.startReloadItems();
+            this.startReloadItemsTimeout(autoupdateIntervalMs);
         }
     }
     render() {
@@ -75,7 +99,7 @@ class GridLayout extends react_1.default.PureComponent {
         this.pluginsRefs.length = config.items.length;
         return (react_1.default.createElement(Layout, Object.assign({}, registerManager.gridLayout, { layout: layout, isDraggable: editMode, isResizable: editMode, onDragStart: this._onStart, onDragStop: this._onStop, onResizeStart: this._onStart, onResizeStop: this._onStop }, (draggableHandleClassName
             ? { draggableHandle: `.${draggableHandleClassName}` }
-            : null)), config.items.map((item, i) => {
+            : null), { draggableCancel: `.${constants_1.OVERLAY_CONTROLS_CLASS_NAME}` }), config.items.map((item, i) => {
             return (react_1.default.createElement(GridItem_1.default, { forwardedPluginRef: (pluginRef) => {
                     this.pluginsRefs[i] = pluginRef;
                 }, key: item.id, id: item.id, item: item, layout: layout, adjustWidgetLayout: this.adjustWidgetLayout, isDragging: this.state.isDragging, noOverlay: noOverlay, withCustomHandle: Boolean(draggableHandleClassName), overlayControls: this.props.overlayControls }));

package/build/cjs/components/OverlayControls/OverlayControls.d.ts

@@ -39,7 +39,6 @@ interface OverlayControlsProps extends OverlayControlsDefaultProps {
     overlayControls?: Record<string, OverlayControlItem[]>;
 }
 type DashKitCtx = React.Context<{
-    context: Record<string, any>;
     registerManager: RegisterManager;
     itemsParams: Record<string, StringParams>;
     itemsState: Record<string, ItemState>;

package/build/cjs/components/OverlayControls/OverlayControls.js

@@ -12,7 +12,7 @@ const DotsIcon_1 = require("../../icons/DotsIcon");
 const CogIcon_1 = require("../../icons/CogIcon");
 const CloseIcon_1 = require("../../icons/CloseIcon");
 const cn_1 = require("../../utils/cn");
-const b = (0, cn_1.cn)('dashkit-overlay-controls');
+const b = (0, cn_1.cn)(constants_1.OVERLAY_CONTROLS_CLASS_NAME);
 var OverlayControlsPosition;
 (function (OverlayControlsPosition) {
     OverlayControlsPosition["TopRight"] = "top_right";
@@ -56,11 +56,10 @@ class OverlayControls extends react_1.default.Component {
             return controls;
         };
         this.onCopyItem = () => {
-            var _a;
             const correspondedItemLayout = this.context.config.layout.find((item) => {
                 return item.i === this.props.configItem.id;
             });
-            let options = {
+            const options = {
                 timestamp: Date.now(),
                 data: this.props.configItem.data,
                 type: this.props.configItem.type,
@@ -71,9 +70,6 @@ class OverlayControls extends react_1.default.Component {
                     h: correspondedItemLayout.h,
                 },
             };
-            if (typeof ((_a = this.context.context) === null || _a === void 0 ? void 0 : _a.getPreparedCopyItemOptions) === 'function') {
-                options = this.context.context.getPreparedCopyItemOptions(options);
-            }
             localStorage.setItem(constants_1.COPIED_WIDGET_STORE_KEY, JSON.stringify(options));
             // https://stackoverflow.com/questions/35865481/storage-event-not-firing
             window.dispatchEvent(new Event('storage'));

package/build/cjs/constants/common.d.ts

@@ -1,5 +1,6 @@
 export declare const COPIED_WIDGET_STORE_KEY = "dashCopiedItem";
 export declare const DEFAULT_NAMESPACE = "default";
+export declare const OVERLAY_CONTROLS_CLASS_NAME = "dashkit-overlay-controls";
 export declare const MenuItems: {
     readonly Copy: "copy";
     readonly Delete: "delete";

package/build/cjs/constants/common.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MenuItems = exports.DEFAULT_NAMESPACE = exports.COPIED_WIDGET_STORE_KEY = void 0;
+exports.MenuItems = exports.OVERLAY_CONTROLS_CLASS_NAME = exports.DEFAULT_NAMESPACE = exports.COPIED_WIDGET_STORE_KEY = void 0;
 exports.COPIED_WIDGET_STORE_KEY = 'dashCopiedItem';
 exports.DEFAULT_NAMESPACE = 'default';
+exports.OVERLAY_CONTROLS_CLASS_NAME = 'dashkit-overlay-controls';
 exports.MenuItems = {
     Copy: 'copy',
     Delete: 'delete',

package/build/cjs/hocs/withContext.js

@@ -121,7 +121,8 @@ function useMemoStateContext(props) {
         });
     }, [props.layout, layoutUpdateCounter]);
     const reloadItems = react_1.default.useCallback((pluginsRefs, data) => {
-        pluginsRefs.forEach((ref) => ref && ref.reload && ref.reload(data));
+        const promises = pluginsRefs.map((ref) => ref && ref.reload && ref.reload(data));
+        return Promise.allSettled(promises);
     }, []);
     return react_1.default.useMemo(() => ({
         layout: resultLayout,

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

@@ -9,8 +9,10 @@ export interface Settings {
 }
 export type MenuItem = (typeof MenuItems)[keyof typeof MenuItems] | OverlayCustomControlItem;
 export interface SettingsProps {
-    autoupdateInterval: number;
+    autoupdateInterval?: number;
     silentLoading: boolean;
+    realtimeMode?: boolean;
+    realtimeModeDelayMs?: number;
 }
 export interface ContextProps {
     [key: string]: any;

package/build/esm/components/GridLayout/GridLayout.d.ts

@@ -18,6 +18,10 @@ export default class GridLayout extends React.PureComponent<any, any, any> {
         adjustedWidgetLayout: any;
     }) => void;
     getItemsMeta: () => any;
+    getAutoupdateIntervalMs(): number;
+    startReloadItems(): any;
+    startReloadItemsTimeout(timeoutMs: any): void;
+    forceReloadItems(): void;
     reloadItems(): void;
     _onStart: () => void;
     _onStop: (newLayout: any) => void;

package/build/esm/components/GridLayout/GridLayout.js

@@ -2,6 +2,7 @@ import React from 'react';
 import ReactGridLayout, { WidthProvider } from 'react-grid-layout';
 import GridItem from '../GridItem/GridItem';
 import { DashKitContext } from '../../context/DashKitContext';
+import { OVERLAY_CONTROLS_CLASS_NAME } from '../../constants';
 const Layout = WidthProvider(ReactGridLayout); // eslint-disable-line new-cap
 export default class GridLayout extends React.PureComponent {
     constructor(props, context) {
@@ -46,25 +47,48 @@ export default class GridLayout extends React.PureComponent {
         document.addEventListener('visibilitychange', this.onVisibilityChange);
     }
     componentDidUpdate() {
-        clearTimeout(this._timeout);
-        this.reloadItems();
+        this.forceReloadItems();
     }
     componentWillUnmount() {
         clearTimeout(this._timeout);
         document.removeEventListener('visibilitychange', this.onVisibilityChange);
     }
-    reloadItems() {
-        const { editMode, settings: { autoupdateInterval, silentLoading } = {}, reloadItems, } = this.context;
-        const { isPageHidden } = this.state;
+    getAutoupdateIntervalMs() {
+        const { settings: { autoupdateInterval } = {} } = this.context;
         const autoupdateIntervalMs = Number(autoupdateInterval) * 1000;
+        return autoupdateIntervalMs;
+    }
+    startReloadItems() {
+        const { editMode, settings: { silentLoading } = {}, reloadItems } = this.context;
+        const { isPageHidden } = this.state;
+        if (!isPageHidden && !editMode) {
+            this._lastReloadAt = new Date().getTime();
+            return reloadItems(this.pluginsRefs, { silentLoading, noVeil: true });
+        }
+        return Promise.resolve();
+    }
+    startReloadItemsTimeout(timeoutMs) {
+        this._timeout = setTimeout(() => this.forceReloadItems(), timeoutMs);
+    }
+    forceReloadItems() {
+        clearTimeout(this._timeout);
+        this._timeout = undefined;
+        this.reloadItems();
+    }
+    reloadItems() {
+        if (this._timeout)
+            return;
+        const { settings: { realtimeMode, realtimeModeDelayMs = 5000 } = {} } = this.context;
+        if (realtimeMode) {
+            this.startReloadItems().then(() => {
+                this.startReloadItemsTimeout(realtimeModeDelayMs);
+            });
+            return;
+        }
+        const autoupdateIntervalMs = this.getAutoupdateIntervalMs();
         if (autoupdateIntervalMs) {
-            const timeSinceLastReload = new Date().getTime() - (this._lastReloadAt || 0);
-            const reloadIntervalRemains = autoupdateIntervalMs - timeSinceLastReload;
-            if (!isPageHidden && !editMode && reloadIntervalRemains <= 0) {
-                this._lastReloadAt = new Date().getTime();
-                reloadItems(this.pluginsRefs, { silentLoading, noVeil: true });
-            }
-            this._timeout = setTimeout(() => this.reloadItems(), reloadIntervalRemains <= 0 ? autoupdateIntervalMs : reloadIntervalRemains);
+            this.startReloadItems();
+            this.startReloadItemsTimeout(autoupdateIntervalMs);
         }
     }
     render() {
@@ -72,7 +96,7 @@ export default class GridLayout extends React.PureComponent {
         this.pluginsRefs.length = config.items.length;
         return (React.createElement(Layout, Object.assign({}, registerManager.gridLayout, { layout: layout, isDraggable: editMode, isResizable: editMode, onDragStart: this._onStart, onDragStop: this._onStop, onResizeStart: this._onStart, onResizeStop: this._onStop }, (draggableHandleClassName
             ? { draggableHandle: `.${draggableHandleClassName}` }
-            : null)), config.items.map((item, i) => {
+            : null), { draggableCancel: `.${OVERLAY_CONTROLS_CLASS_NAME}` }), config.items.map((item, i) => {
             return (React.createElement(GridItem, { forwardedPluginRef: (pluginRef) => {
                     this.pluginsRefs[i] = pluginRef;
                 }, key: item.id, id: item.id, item: item, layout: layout, adjustWidgetLayout: this.adjustWidgetLayout, isDragging: this.state.isDragging, noOverlay: noOverlay, withCustomHandle: Boolean(draggableHandleClassName), overlayControls: this.props.overlayControls }));

package/build/esm/components/OverlayControls/OverlayControls.d.ts

@@ -40,7 +40,6 @@ interface OverlayControlsProps extends OverlayControlsDefaultProps {
     overlayControls?: Record<string, OverlayControlItem[]>;
 }
 type DashKitCtx = React.Context<{
-    context: Record<string, any>;
     registerManager: RegisterManager;
     itemsParams: Record<string, StringParams>;
     itemsState: Record<string, ItemState>;

package/build/esm/components/OverlayControls/OverlayControls.js

@@ -3,13 +3,13 @@ import i18n from '../../i18n';
 import noop from 'lodash/noop';
 import { DashKitContext } from '../../context/DashKitContext';
 import { Icon, DropdownMenu, Button, } from '@gravity-ui/uikit';
-import { COPIED_WIDGET_STORE_KEY, MenuItems } from '../../constants';
+import { COPIED_WIDGET_STORE_KEY, OVERLAY_CONTROLS_CLASS_NAME, MenuItems } from '../../constants';
 import { DotsIcon } from '../../icons/DotsIcon';
 import { CogIcon } from '../../icons/CogIcon';
 import { CloseIcon } from '../../icons/CloseIcon';
 import { cn } from '../../utils/cn';
 import './OverlayControls.css';
-const b = cn('dashkit-overlay-controls');
+const b = cn(OVERLAY_CONTROLS_CLASS_NAME);
 export var OverlayControlsPosition;
 (function (OverlayControlsPosition) {
     OverlayControlsPosition["TopRight"] = "top_right";
@@ -53,11 +53,10 @@ class OverlayControls extends React.Component {
             return controls;
         };
         this.onCopyItem = () => {
-            var _a;
             const correspondedItemLayout = this.context.config.layout.find((item) => {
                 return item.i === this.props.configItem.id;
             });
-            let options = {
+            const options = {
                 timestamp: Date.now(),
                 data: this.props.configItem.data,
                 type: this.props.configItem.type,
@@ -68,9 +67,6 @@ class OverlayControls extends React.Component {
                     h: correspondedItemLayout.h,
                 },
             };
-            if (typeof ((_a = this.context.context) === null || _a === void 0 ? void 0 : _a.getPreparedCopyItemOptions) === 'function') {
-                options = this.context.context.getPreparedCopyItemOptions(options);
-            }
             localStorage.setItem(COPIED_WIDGET_STORE_KEY, JSON.stringify(options));
             // https://stackoverflow.com/questions/35865481/storage-event-not-firing
             window.dispatchEvent(new Event('storage'));

package/build/esm/constants/common.d.ts

@@ -1,5 +1,6 @@
 export declare const COPIED_WIDGET_STORE_KEY = "dashCopiedItem";
 export declare const DEFAULT_NAMESPACE = "default";
+export declare const OVERLAY_CONTROLS_CLASS_NAME = "dashkit-overlay-controls";
 export declare const MenuItems: {
     readonly Copy: "copy";
     readonly Delete: "delete";

package/build/esm/constants/common.js

@@ -1,5 +1,6 @@
 export const COPIED_WIDGET_STORE_KEY = 'dashCopiedItem';
 export const DEFAULT_NAMESPACE = 'default';
+export const OVERLAY_CONTROLS_CLASS_NAME = 'dashkit-overlay-controls';
 export const MenuItems = {
     Copy: 'copy',
     Delete: 'delete',

package/build/esm/hocs/withContext.js

@@ -117,7 +117,8 @@ function useMemoStateContext(props) {
         });
     }, [props.layout, layoutUpdateCounter]);
     const reloadItems = React.useCallback((pluginsRefs, data) => {
-        pluginsRefs.forEach((ref) => ref && ref.reload && ref.reload(data));
+        const promises = pluginsRefs.map((ref) => ref && ref.reload && ref.reload(data));
+        return Promise.allSettled(promises);
     }, []);
     return React.useMemo(() => ({
         layout: resultLayout,

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

@@ -9,8 +9,10 @@ export interface Settings {
 }
 export type MenuItem = (typeof MenuItems)[keyof typeof MenuItems] | OverlayCustomControlItem;
 export interface SettingsProps {
-    autoupdateInterval: number;
+    autoupdateInterval?: number;
     silentLoading: boolean;
+    realtimeMode?: boolean;
+    realtimeModeDelayMs?: number;
 }
 export interface ContextProps {
     [key: string]: any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravity-ui/dashkit",
-  "version": "6.5.1-beta.1",
+  "version": "6.6.0-beta.0",
   "description": "Library for rendering dashboard grid layout",
   "license": "MIT",
   "repository": {