@tenorlab/react-dashboard 1.5.26 → 1.5.42

package/README.md

@@ -373,3 +373,10 @@ This project is dual-licensed:
 2. **Commercial Use:** Requires a **Tenorlab Commercial License**.
 
 If you are using this library to build a revenue-generating product or within a commercial entity, please visit [https://payhip.com/b/gPBpo](https://payhip.com/b/gPBpo) to purchase a license.
+
+------
+
+## Links
+[Official Website](https://www.tenorlab.com)
+[Buy a icense](https://payhip.com/b/gPBpo)
+[BlueSky](https://bsky.app/profile/tenorlab.bsky.social)

package/dist/core.d.ts

@@ -70,6 +70,65 @@ export declare const dashboardSettingsUtils: {
     incrementOrDecrementValue: (item: IDashboardSettingEntry, direction: -1 | 1) => IDashboardSettingEntry;
 };
 
+/**
+ * @name dashboardStoreUtils
+ * @description
+ * Framework-agnostic helpers for managing dashboard state. These utilities
+ * are designed to be consumed by specific store implementations.
+ * @see {@link https://www.npmjs.com/package/@tenorlab/react-dashboard | @tenorlab/react-dashboard}
+ * @see {@link https://www.npmjs.com/package/@tenorlab/vue-dashboard | @tenorlab/vue-dashboard}
+ */
+export declare const dashboardStoreUtils: {
+    /**
+     * @name getNextContainerName
+     * @description Generates the next container name based on existing containers in the dashboard configuration
+     * @param dashboardConfig
+     * @returns {string} The next container name in the format 'containerX', where X is the next available number
+     */
+    getNextContainerName: (dashboardConfig: IDashboardConfig) => string;
+    /**
+     * @name getNextContainerKey
+     * @description Generates the next container widget key based on the dashboard configuration and a given container widget key
+     * @param dashboardConfig
+     * @param containerWidgetKey
+     * @returns {TDashboardWidgetKey} The next container widget key
+     */
+    getNextContainerKey: (dashboardConfig: IDashboardConfig, containerWidgetKey: TDashboardWidgetKey) => TDashboardWidgetKey;
+    /**
+     * @description Adds a widget to the configuration. Supports root-level and nested containers.
+     * @param params - Configuration object for adding a widget.
+     * @param params.dashboardConfig - The current {@link IDashboardConfig}.
+     * @param params.widgetKey - The {@link TDashboardWidgetKey} to add.
+     * @param params.parentWidgetKey - Optional parent container key.
+     * @param params.noDuplicatedWidgets - If true, prevents adding the same key twice.
+     * @returns A {@link TCoreResponse} containing the success status and updated config.
+     */
+    addWidget: (params: {
+        dashboardConfig: IDashboardConfig;
+        widgetKey: TDashboardWidgetKey;
+        parentWidgetKey?: TDashboardWidgetKey;
+        noDuplicatedWidgets?: boolean;
+    }) => TCoreResponse<TAddWidgetResponse>;
+    /**
+     * @name removeWidget
+     * @description Removes a widget from the dashboard configuration, either from the root level or from a specified parent container
+     * @param dashboardConfig
+     * @param widgetKey
+     * @param parentWidgetKey
+     * @returns {TCoreResponse<TRemoveWidgetResponse>} The response indicating success or failure and the updated dashboard configuration
+     */
+    removeWidget: (dashboardConfig: IDashboardConfig, widgetKey: TDashboardWidgetKey, parentWidgetKey?: TDashboardWidgetKey) => TCoreResponse<TRemoveWidgetResponse>;
+    /**
+     * @description Moves a widget's position within its current depth (root or container).
+     * @param dashboardConfig - The current {@link IDashboardConfig}.
+     * @param direction - Use `1` for forward/down and `-1` for backward/up.
+     * @param widgetKey - The {@link TDashboardWidgetKey} to move.
+     * @param parentWidgetKey - The container key if the widget is nested.
+     * @returns A {@link TCoreResponse} with the new array order.
+     */
+    moveWidget: (dashboardConfig: IDashboardConfig, direction: -1 | 1, widgetKey: TDashboardWidgetKey, parentWidgetKey?: TDashboardWidgetKey) => TCoreResponse<TMoveWidgetResponse>;
+};
+
 export declare const DashboardZoomStep: 0.05;
 
 /**
@@ -294,6 +353,23 @@ export declare const removeEmptyContainers: (dashboardConfig: IDashboardConfig)
  */
 export declare const resolveColorFromClass: (classNames: string | string[], property?: "color" | "backgroundColor") => string;
 
+/**
+ * @name TAddWidgetResponse
+ * @description Type for the response of the addWidget mutation
+ * @property {boolean} success - Indicates if the widget was added successfully
+ * @property {string} [message] - Optional message providing additional information
+ * @property {IDashboardConfig} updatedDashboardConfig - The updated dashboard configuration after adding the widget
+ * @property {IDashboardConfig[]} allUpdatedDashboardConfigs - All updated dashboard configurations
+ */
+export declare type TAddWidgetResponse = {
+    success: boolean;
+    message?: string;
+    updatedDashboardConfig: IDashboardConfig;
+    allUpdatedDashboardConfigs: IDashboardConfig[];
+};
+
+declare type TCoreResponse<T> = Omit<T, 'allUpdatedDashboardConfigs'>;
+
 /**
  * @name TDashboardUndoStatus
  * @description Type for the dashboard undo/redo status
@@ -372,6 +448,10 @@ export declare type TManifestEntry = {
     meta: TWidgetMetaInfoBase;
 };
 
+export declare type TMoveWidgetResponse = TAddWidgetResponse;
+
+export declare type TRemoveWidgetResponse = TAddWidgetResponse;
+
 /**
  * @name TSaveDashboards
  * @description Function type to save dashboards for a user