@gravity-ui/dashkit 6.6.0-beta.0 → 6.6.1

package/README.md

@@ -120,21 +120,6 @@ 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,10 +18,6 @@ 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

@@ -50,48 +50,25 @@ class GridLayout extends react_1.default.PureComponent {
         document.addEventListener('visibilitychange', this.onVisibilityChange);
     }
     componentDidUpdate() {
-        this.forceReloadItems();
+        clearTimeout(this._timeout);
+        this.reloadItems();
     }
     componentWillUnmount() {
         clearTimeout(this._timeout);
         document.removeEventListener('visibilitychange', this.onVisibilityChange);
     }
-    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();
+        const { editMode, settings: { autoupdateInterval, silentLoading } = {}, reloadItems, } = this.context;
+        const { isPageHidden } = this.state;
+        const autoupdateIntervalMs = Number(autoupdateInterval) * 1000;
         if (autoupdateIntervalMs) {
-            this.startReloadItems();
-            this.startReloadItemsTimeout(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);
         }
     }
     render() {

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

@@ -38,7 +38,16 @@ interface OverlayControlsProps extends OverlayControlsDefaultProps {
     items?: OverlayControlItem[];
     overlayControls?: Record<string, OverlayControlItem[]>;
 }
+type PreparedCopyItemOptionsArg = Pick<ConfigItem, 'data' | 'type' | 'defaults' | 'namespace'> & {
+    timestamp: number;
+    layout: {
+        w: number;
+        h: number;
+    };
+};
+export type PreparedCopyItemOptions = PreparedCopyItemOptionsArg;
 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

@@ -56,10 +56,11 @@ 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;
             });
-            const options = {
+            let options = {
                 timestamp: Date.now(),
                 data: this.props.configItem.data,
                 type: this.props.configItem.type,
@@ -70,6 +71,9 @@ 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/components/index.d.ts

@@ -1,3 +1,3 @@
 export * from './DashKit';
-export type { OverlayControlItem } from './OverlayControls/OverlayControls';
+export type { OverlayControlItem, PreparedCopyItemOptions } from './OverlayControls/OverlayControls';
 export * from './ActionPanel/ActionPanel';

package/build/cjs/hocs/withContext.js

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

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

@@ -9,10 +9,8 @@ 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,10 +18,6 @@ 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

@@ -47,48 +47,25 @@ export default class GridLayout extends React.PureComponent {
         document.addEventListener('visibilitychange', this.onVisibilityChange);
     }
     componentDidUpdate() {
-        this.forceReloadItems();
+        clearTimeout(this._timeout);
+        this.reloadItems();
     }
     componentWillUnmount() {
         clearTimeout(this._timeout);
         document.removeEventListener('visibilitychange', this.onVisibilityChange);
     }
-    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();
+        const { editMode, settings: { autoupdateInterval, silentLoading } = {}, reloadItems, } = this.context;
+        const { isPageHidden } = this.state;
+        const autoupdateIntervalMs = Number(autoupdateInterval) * 1000;
         if (autoupdateIntervalMs) {
-            this.startReloadItems();
-            this.startReloadItemsTimeout(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);
         }
     }
     render() {

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

@@ -39,7 +39,16 @@ interface OverlayControlsProps extends OverlayControlsDefaultProps {
     items?: OverlayControlItem[];
     overlayControls?: Record<string, OverlayControlItem[]>;
 }
+type PreparedCopyItemOptionsArg = Pick<ConfigItem, 'data' | 'type' | 'defaults' | 'namespace'> & {
+    timestamp: number;
+    layout: {
+        w: number;
+        h: number;
+    };
+};
+export type PreparedCopyItemOptions = PreparedCopyItemOptionsArg;
 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

@@ -53,10 +53,11 @@ 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;
             });
-            const options = {
+            let options = {
                 timestamp: Date.now(),
                 data: this.props.configItem.data,
                 type: this.props.configItem.type,
@@ -67,6 +68,9 @@ 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/components/index.d.ts

@@ -1,3 +1,3 @@
 export * from './DashKit';
-export type { OverlayControlItem } from './OverlayControls/OverlayControls';
+export type { OverlayControlItem, PreparedCopyItemOptions } from './OverlayControls/OverlayControls';
 export * from './ActionPanel/ActionPanel';

package/build/esm/hocs/withContext.js

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

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

@@ -9,10 +9,8 @@ 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.6.0-beta.0",
+  "version": "6.6.1",
   "description": "Library for rendering dashboard grid layout",
   "license": "MIT",
   "repository": {