@crystaldesign/diva-backoffice 25.7.0-beta.29 → 25.7.0-beta.30

package/build/esm/index.js

@@ -13498,14 +13498,23 @@ function getIcon(icon) {
 }
 
 var DEFAULT_WIDTH = 500;
+
+/**
+ * Store for managing the toolbar state and tools in the application.
+ * Handles tool selection, visibility, loading states, and toolbar dimensions.
+ */
 var ToolBarStore = /*#__PURE__*/function () {
+  /**
+   * Creates a new ToolBarStore instance.
+   * @param defaultLanguage - The default language to use for tools
+   */
   function ToolBarStore(defaultLanguage) {
     _classCallCheck(this, ToolBarStore);
     this.defaultLanguage = defaultLanguage;
     _defineProperty(this, "_tools", []);
     _defineProperty(this, "_hidden", true);
     _defineProperty(this, "_pinned", false);
-    _defineProperty(this, "_openedToolId", void 0);
+    _defineProperty(this, "_selectedToolId", void 0);
     _defineProperty(this, "_loadingTools", new Map());
     _defineProperty(this, "_currentLanguage", void 0);
     _defineProperty(this, "_width", 0);
@@ -13515,6 +13524,10 @@ var ToolBarStore = /*#__PURE__*/function () {
       _toolbarElement: observable.ref
     });
   }
+
+  /**
+   * The list of available tools in the toolbar
+   */
   return _createClass(ToolBarStore, [{
     key: "tools",
     get: function get() {
@@ -13524,6 +13537,13 @@ var ToolBarStore = /*#__PURE__*/function () {
       this._tools = tools;
       this.updateToolState();
     }
+
+    /**
+     * Adds or updates tools in the toolbar.
+     *
+     * If a tool with the same id already exists, it will be updated.
+     * @param {...Tool} tools - Variable number of Tool objects to add
+     */
   }, {
     key: "addTools",
     value: function addTools() {
@@ -13543,6 +13563,11 @@ var ToolBarStore = /*#__PURE__*/function () {
       });
       this.updateToolState();
     }
+
+    /**
+     * Removes tools from the toolbar by their IDs.
+     * @param {...string} toolIds - Variable number of tool IDs to remove
+     */
   }, {
     key: "removeTools",
     value: function removeTools() {
@@ -13554,6 +13579,11 @@ var ToolBarStore = /*#__PURE__*/function () {
       });
       this.updateToolState();
     }
+
+    /**
+     * Updates the internal tool state based on available tools.
+     * Sets default values for selected tool, pinned state, visibility and width.
+     */
   }, {
     key: "updateToolState",
     value: function updateToolState() {
@@ -13566,17 +13596,23 @@ var ToolBarStore = /*#__PURE__*/function () {
         _this$_tools$4;
       if (this._tools.length === 0) return;
       var newToolState = this._tools.find(function (t) {
-        return t.id === _this2._openedToolId;
+        return t.id === _this2._selectedToolId;
       });
       if (newToolState || this._tools.length === 0) {
         //if current tool is in the new list or the list is empty, don't change the current state
         return;
       }
-      this._openedToolId = (_this$_tools$ = this._tools[0]) === null || _this$_tools$ === void 0 ? void 0 : _this$_tools$.id;
+      this._selectedToolId = (_this$_tools$ = this._tools[0]) === null || _this$_tools$ === void 0 ? void 0 : _this$_tools$.id;
       this._pinned = (_this$_tools$0$defaul = (_this$_tools$2 = this._tools[0]) === null || _this$_tools$2 === void 0 ? void 0 : _this$_tools$2.defaultPinned) !== null && _this$_tools$0$defaul !== void 0 ? _this$_tools$0$defaul : this._pinned;
       this._hidden = ((_this$_tools$3 = this._tools[0]) === null || _this$_tools$3 === void 0 ? void 0 : _this$_tools$3.defaultOpen) !== undefined ? !this._tools[0].defaultOpen : this._hidden;
       this._width = (_this$_tools$0$startW = (_this$_tools$4 = this._tools[0]) === null || _this$_tools$4 === void 0 ? void 0 : _this$_tools$4.startWidth) !== null && _this$_tools$0$startW !== void 0 ? _this$_tools$0$startW : this._width;
     }
+
+    /**
+     * Controls the visibility state of the toolbar
+     *
+     * If toolbar becomes visible and no width is set, sets also default width.
+     */
   }, {
     key: "hidden",
     get: function get() {
@@ -13589,6 +13625,10 @@ var ToolBarStore = /*#__PURE__*/function () {
         this._width = (_this$currentOpenTool = (_this$currentOpenTool2 = this.currentOpenTool) === null || _this$currentOpenTool2 === void 0 ? void 0 : _this$currentOpenTool2.startWidth) !== null && _this$currentOpenTool !== void 0 ? _this$currentOpenTool : DEFAULT_WIDTH;
       }
     }
+
+    /**
+     * Controls whether the toolbar is pinned in place
+     */
   }, {
     key: "pinned",
     get: function get() {
@@ -13597,6 +13637,10 @@ var ToolBarStore = /*#__PURE__*/function () {
     set: function set(pinned) {
       this._pinned = pinned;
     }
+
+    /**
+     * The current language setting for tools
+     */
   }, {
     key: "currentLanguage",
     get: function get() {
@@ -13605,14 +13649,24 @@ var ToolBarStore = /*#__PURE__*/function () {
     set: function set(language) {
       this._currentLanguage = language;
     }
+
+    /**
+     * The currently selected and open tool
+     */
   }, {
     key: "currentOpenTool",
     get: function get() {
       var _this3 = this;
       return this._tools.find(function (t) {
-        return t.id === _this3._openedToolId;
+        return t.id === _this3._selectedToolId;
       });
     }
+
+    /**
+     * Controls the current width of the toolbar in pixels
+     *
+     * If toolbar is hidden, it is always 0.
+     */
   }, {
     key: "width",
     get: function get() {
@@ -13628,6 +13682,10 @@ var ToolBarStore = /*#__PURE__*/function () {
         this._hidden = true;
       }
     }
+
+    /**
+     * Controls the DOM element representing the toolbar
+     */
   }, {
     key: "toolbarElement",
     get: function get() {
@@ -13636,11 +13694,17 @@ var ToolBarStore = /*#__PURE__*/function () {
     set: function set(element) {
       this._toolbarElement = element;
     }
+
+    /**
+     * Selects a tool by its ID.
+     * Updates toolbar state based on tool's default settings.
+     * @param {string|undefined} toolId - ID of the tool to select, or undefined to deselect
+     */
   }, {
-    key: "openTool",
-    value: function openTool(toolId) {
+    key: "selectTool",
+    value: function selectTool(toolId) {
       // If the tool is already open, do nothing
-      if (toolId === this._openedToolId) {
+      if (toolId === this._selectedToolId) {
         return;
       }
       // Only allow opening enabled tools
@@ -13650,7 +13714,7 @@ var ToolBarStore = /*#__PURE__*/function () {
       if (tool !== null && tool !== void 0 && tool.disabled) {
         return;
       }
-      this._openedToolId = toolId;
+      this._selectedToolId = toolId;
       this._currentLanguage = this.defaultLanguage;
       if (tool) {
         var _tool$startWidth, _tool$defaultPinned;
@@ -13659,12 +13723,25 @@ var ToolBarStore = /*#__PURE__*/function () {
         this._pinned = (_tool$defaultPinned = tool.defaultPinned) !== null && _tool$defaultPinned !== void 0 ? _tool$defaultPinned : this._pinned;
       }
     }
+
+    /**
+     * Checks if a tool is currently in a loading state.
+     * @param {string} toolId - ID of the tool to check
+     * @returns {boolean} True if tool is loading, false otherwise
+     */
   }, {
     key: "isLoading",
     value: function isLoading(toolId) {
       var loading = this._loadingTools.get(toolId);
       return loading !== undefined && loading.length > 0;
     }
+
+    /**
+     * Toggles or sets the loading state for a tool or its sub-components.
+     * @param {string} toolId - ID of the tool to update
+     * @param {string} [subId] - Optional ID of sub-component to update
+     * @param {boolean} [toggle] - Optional boolean to explicitly set loading state
+     */
   }, {
     key: "toggleLoading",
     value: function toggleLoading(toolId, subId, toggle) {
@@ -31395,7 +31472,8 @@ var useTools = function useTools(_ref) {
       defaultOpen: open
     });
     if (open) {
-      root.contentStore.rightToolBar.openTool('info');
+      root.contentStore.rightToolBar.selectTool('info');
+      root.contentStore.rightToolBar.hidden = false;
     }
   }, [root.contentStore.rightToolBar]);
   var addSecondaryTables = useCallback(function () {
@@ -39622,7 +39700,7 @@ var TablePriceFeatureGroups = observer(function () {
         disabled: isPercentage === false
       });
       var openTool = (_root$contentStore$bo = root.contentStore.bottomToolBar.currentOpenTool) === null || _root$contentStore$bo === void 0 ? void 0 : _root$contentStore$bo.id;
-      root.contentStore.bottomToolBar.openTool(isPercentage === true ? 'priceFeatureGroupPercentageSurcharge' : isPercentage === false ? 'priceFeatureGroupFinishes' : openTool !== null && openTool !== void 0 ? openTool : 'priceFeatureGroupFinishes');
+      root.contentStore.bottomToolBar.selectTool(isPercentage === true ? 'priceFeatureGroupPercentageSurcharge' : isPercentage === false ? 'priceFeatureGroupFinishes' : openTool !== null && openTool !== void 0 ? openTool : 'priceFeatureGroupFinishes');
     } else {
       removeSecondaryTables('priceFeatureGroupFinishes', 'priceFeatureGroupPercentageSurcharge');
     }
@@ -42003,7 +42081,7 @@ var Toolbar = function Toolbar(_ref) {
             var _toolBar$currentOpenT2;
             if (t.disabled) return;
             if (((_toolBar$currentOpenT2 = toolBar.currentOpenTool) === null || _toolBar$currentOpenT2 === void 0 ? void 0 : _toolBar$currentOpenT2.id) != t.id) {
-              toolBar.openTool(t.id);
+              toolBar.selectTool(t.id);
               toolBar.hidden = false;
             } else {
               toolBar.hidden = !toolBar.hidden;

package/build/types/backoffice/src/store/ToolBarStore.d.ts

@@ -1,33 +1,96 @@
 import { Tool } from '../layout/Navigation/types';
+/**
+ * Store for managing the toolbar state and tools in the application.
+ * Handles tool selection, visibility, loading states, and toolbar dimensions.
+ */
 export default class ToolBarStore {
     private defaultLanguage;
     private _tools;
     private _hidden;
     private _pinned;
-    private _openedToolId;
+    private _selectedToolId;
     private _loadingTools;
     private _currentLanguage;
     private _width;
     private _toolbarElement;
+    /**
+     * Creates a new ToolBarStore instance.
+     * @param defaultLanguage - The default language to use for tools
+     */
     constructor(defaultLanguage: string);
+    /**
+     * The list of available tools in the toolbar
+     */
     get tools(): Tool[];
     set tools(tools: Tool[]);
+    /**
+     * Adds or updates tools in the toolbar.
+     *
+     * If a tool with the same id already exists, it will be updated.
+     * @param {...Tool} tools - Variable number of Tool objects to add
+     */
     addTools(...tools: Tool[]): void;
+    /**
+     * Removes tools from the toolbar by their IDs.
+     * @param {...string} toolIds - Variable number of tool IDs to remove
+     */
     removeTools(...toolIds: string[]): void;
+    /**
+     * Updates the internal tool state based on available tools.
+     * Sets default values for selected tool, pinned state, visibility and width.
+     */
     private updateToolState;
+    /**
+     * Controls the visibility state of the toolbar
+     *
+     * If toolbar becomes visible and no width is set, sets also default width.
+     */
     get hidden(): boolean;
     set hidden(hidden: boolean);
+    /**
+     * Controls whether the toolbar is pinned in place
+     */
     get pinned(): boolean;
     set pinned(pinned: boolean);
+    /**
+     * The current language setting for tools
+     */
     get currentLanguage(): string;
     set currentLanguage(language: string);
-    get currentOpenTool(): Tool<any> | undefined;
+    /**
+     * The currently selected and open tool
+     */
+    get currentOpenTool(): Tool | undefined;
+    /**
+     * Controls the current width of the toolbar in pixels
+     *
+     * If toolbar is hidden, it is always 0.
+     */
     get width(): number;
     set width(width: number);
+    /**
+     * Controls the DOM element representing the toolbar
+     */
     get toolbarElement(): HTMLDivElement | null;
     set toolbarElement(element: HTMLDivElement | null);
-    openTool(toolId: string | undefined): void;
+    /**
+     * Selects a tool by its ID.
+     * Updates toolbar state based on tool's default settings.
+     * @param {string|undefined} toolId - ID of the tool to select, or undefined to deselect
+     */
+    selectTool(toolId: string | undefined): void;
+    /**
+     * Checks if a tool is currently in a loading state.
+     * @param {string} toolId - ID of the tool to check
+     * @returns {boolean} True if tool is loading, false otherwise
+     */
     isLoading(toolId: string): boolean;
+    /**
+     * Toggles or sets the loading state for a tool or its sub-components.
+     * @param {string} toolId - ID of the tool to update
+     * @param {string} [subId] - Optional ID of sub-component to update
+     * @param {boolean} [toggle] - Optional boolean to explicitly set loading state
+     */
     toggleLoading(toolId: string, subId?: string, toggle?: boolean): void;
 }
 //# sourceMappingURL=ToolBarStore.d.ts.map

package/build/types/backoffice/src/store/ToolBarStore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ToolBarStore.d.ts","sourceRoot":"","sources":["../../../../../src/store/ToolBarStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,4BAA4B,CAAC;AAKlD,MAAM,CAAC,OAAO,OAAO,YAAY;IAUnB,OAAO,CAAC,eAAe;IATnC,OAAO,CAAC,MAAM,CAAc;IAC5B,OAAO,CAAC,OAAO,CAAiB;IAChC,OAAO,CAAC,OAAO,CAAkB;IACjC,OAAO,CAAC,aAAa,CAAqB;IAC1C,OAAO,CAAC,aAAa,CAAoC;IACzD,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,MAAM,CAAa;IAC3B,OAAO,CAAC,eAAe,CAA+B;gBAElC,eAAe,EAAE,MAAM;IAO3C,IAAI,KAAK,IAIQ,IAAI,EAAE,CAFtB;IAED,IAAI,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,EAGtB;IAED,QAAQ,CAAC,GAAG,KAAK,EAAE,IAAI,EAAE;IAYzB,WAAW,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE;IAKhC,OAAO,CAAC,eAAe;IAavB,IAAI,MAAM,IAIS,OAAO,CAFzB;IAED,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,EAKzB;IAED,IAAI,MAAM,IAIS,OAAO,CAFzB;IAED,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,EAEzB;IAED,IAAI,eAAe,IAIW,MAAM,CAFnC;IAED,IAAI,eAAe,CAAC,QAAQ,EAAE,MAAM,EAEnC;IAED,IAAI,eAAe,0BAElB;IAED,IAAI,KAAK,IAIQ,MAAM,CAFtB;IAED,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,EAStB;IAED,IAAI,cAAc,IAIU,cAAc,GAAG,IAAI,CAFhD;IAED,IAAI,cAAc,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI,EAEhD;IAED,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS;IAmBnC,SAAS,CAAC,MAAM,EAAE,MAAM;IAKxB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO;CAsD/D"}
+{"version":3,"file":"ToolBarStore.d.ts","sourceRoot":"","sources":["../../../../../src/store/ToolBarStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,4BAA4B,CAAC;AAMlD;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,YAAY;IAcnB,OAAO,CAAC,eAAe;IAbnC,OAAO,CAAC,MAAM,CAAc;IAC5B,OAAO,CAAC,OAAO,CAAiB;IAChC,OAAO,CAAC,OAAO,CAAkB;IACjC,OAAO,CAAC,eAAe,CAAqB;IAC5C,OAAO,CAAC,aAAa,CAAoC;IACzD,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,MAAM,CAAa;IAC3B,OAAO,CAAC,eAAe,CAA+B;IAEtD;;;OAGG;gBACiB,eAAe,EAAE,MAAM;IAO3C;;OAEG;IACH,IAAI,KAAK,IAAI,IAAI,EAAE,CAElB;IAED,IAAI,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,EAGtB;IAED;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,KAAK,EAAE,IAAI,EAAE;IAYzB;;;OAGG;IACH,WAAW,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE;IAKhC;;;OAGG;IACH,OAAO,CAAC,eAAe;IAavB;;;;OAIG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,EAKzB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,EAEzB;IAED;;OAEG;IACH,IAAI,eAAe,IAAI,MAAM,CAE5B;IAED,IAAI,eAAe,CAAC,QAAQ,EAAE,MAAM,EAEnC;IAED;;OAEG;IACH,IAAI,eAAe,IAAI,IAAI,GAAG,SAAS,CAEtC;IAED;;;;OAIG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,EAStB;IAED;;OAEG;IACH,IAAI,cAAc,IAAI,cAAc,GAAG,IAAI,CAE1C;IAED,IAAI,cAAc,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI,EAEhD;IAED;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS;IAmBrC;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAKlC;;;;;OAKG;IACH,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO;CAsD/D"}

package/build/types/backoffice/src/ui/IDMCommonComponents/useTools.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useTools.d.ts","sourceRoot":"","sources":["../../../../../../src/ui/IDMCommonComponents/useTools.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,MAAM,+BAA+B,CAAC;AAErD,MAAM,MAAM,aAAa,GAAG;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC,CAAC;AAEF,eAAO,MAAM,QAAQ,iEAAkE,aAAa;mCAKxF,MAAM,QAAQ,OAAO;mCAkBlB,IAAI,EAAE;oCASR,MAAM,EAAE;CA4DpB,CAAC"}
+{"version":3,"file":"useTools.d.ts","sourceRoot":"","sources":["../../../../../../src/ui/IDMCommonComponents/useTools.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,IAAI,EAAE,MAAM,+BAA+B,CAAC;AAErD,MAAM,MAAM,aAAa,GAAG;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC,CAAC;AAEF,eAAO,MAAM,QAAQ,iEAAkE,aAAa;mCAKxF,MAAM,QAAQ,OAAO;mCAmBlB,IAAI,EAAE;oCASR,MAAM,EAAE;CA4DpB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crystaldesign/diva-backoffice",
-  "version": "25.7.0-beta.29",
+  "version": "25.7.0-beta.30",
   "license": "COMMERCIAL",
   "devDependencies": {
     "@testing-library/jest-dom": "^6.5.0",
@@ -15,13 +15,13 @@
   "dependencies": {
     "@ant-design/icons": "5.4.0",
     "@babel/runtime": "7.24.7",
-    "@crystaldesign/content-box": "25.7.0-beta.29",
-    "@crystaldesign/content-item": "25.7.0-beta.29",
-    "@crystaldesign/diva-core": "25.7.0-beta.29",
-    "@crystaldesign/diva-utils": "25.7.0-beta.29",
-    "@crystaldesign/media-upload": "25.7.0-beta.29",
-    "@crystaldesign/rtf-editor": "25.7.0-beta.29",
-    "@crystaldesign/spreadsheet": "25.7.0-beta.29",
+    "@crystaldesign/content-box": "25.7.0-beta.30",
+    "@crystaldesign/content-item": "25.7.0-beta.30",
+    "@crystaldesign/diva-core": "25.7.0-beta.30",
+    "@crystaldesign/diva-utils": "25.7.0-beta.30",
+    "@crystaldesign/media-upload": "25.7.0-beta.30",
+    "@crystaldesign/rtf-editor": "25.7.0-beta.30",
+    "@crystaldesign/spreadsheet": "25.7.0-beta.30",
     "@google/model-viewer": "3.5.0",
     "ag-charts-community": "^10.1.0",
     "ag-charts-react": "^10.1.0",
@@ -51,5 +51,5 @@
   },
   "module": "build/esm/index.js",
   "types": "./build/types/backoffice/src/index.d.ts",
-  "gitHead": "ed678c2522788906647d63dd1deb35afcc5fcd28"
+  "gitHead": "b0f9e05c577bbcbc2cadebce8cc473d2d71f0f5d"
 }