@gooddata/sdk-ui-dashboard 10.16.0-alpha.2 → 10.16.0-alpha.21

package/esm/model/commands/layout.js

@@ -1,4 +1,4 @@
-// (C) 2021-2023 GoodData Corporation
+// (C) 2021-2024 GoodData Corporation
 /**
  * Creates the AddLayoutSection command.
  *
@@ -8,8 +8,10 @@
  *
  * You may optionally specify the initial values of the section header and the items that will be in the new section.
  *
+ * This command operates only on the root layout. For nested layouts, use {@link addNestedLayoutSection}.
+ *
  * @param index - index to place the section at; -1 can be used as convenience to append a new section
- * @param initialHeader - specify specify header for the newly created section
+ * @param initialHeader - specify header for the newly created section
  * @param initialItems - specify one or more items that the newly created section should include from the get-go
  * @param autoResolveDateFilterDataset - specify whether dashboard should auto-resolve date dataset to use for date filtering of KPI
  *  and insight widgets; default is disabled meaning date filtering will be enabled only for those KPI or Insight widgets
@@ -31,10 +33,46 @@ export function addLayoutSection(index, initialHeader, initialItems, autoResolve
         },
     };
 }
+/**
+ * Creates the AddLayoutSection command.
+ *
+ * @remarks
+ * Dispatching this command will result in the addition of a new layout section.
+ * The new section will be placed at the desired index and will be empty by default.
+ *
+ * You may optionally specify the initial values of the section header and the items that will be in the new section.
+ *
+ * @param index - index to place the section at; -1 can be used as convenience to append a new section
+ * @param initialHeader - specify header for the newly created section
+ * @param initialItems - specify one or more items that the newly created section should include from the get-go
+ * @param autoResolveDateFilterDataset - specify whether dashboard should auto-resolve date dataset to use for date filtering of KPI
+ *  and insight widgets; default is disabled meaning date filtering will be enabled only for those KPI or Insight widgets
+ *  that already specify dateDataset.
+ * @param correlationId - specify correlation id to use for this command. this will be included in all
+ *  events that will be emitted during the command processing
+ *
+ * @alpha
+ */
+// eslint-disable-next-line sonarjs/no-identical-functions
+export function addNestedLayoutSection(index, initialHeader, initialItems, autoResolveDateFilterDataset, correlationId) {
+    return {
+        type: "GDC.DASH/CMD.FLUID_LAYOUT.ADD_SECTION",
+        correlationId,
+        payload: {
+            index,
+            initialHeader,
+            initialItems,
+            autoResolveDateFilterDataset,
+        },
+    };
+}
 /**
  * Creates the MoveLayoutSection command. Dispatching this command will result in move of the section located at `sectionIndex`
  * to a new place indicated by `toIndex`.
  *
+ * @remarks
+ * This command operates only on the root layout. For nested layouts, use {@link moveNestedLayoutSection}.
+ *
  * @param sectionIndex - index of section to move
  * @param toIndex - the new index for the section
  * @param correlationId - specify correlation id to use for this command. this will be included in all
@@ -52,6 +90,28 @@ export function moveLayoutSection(sectionIndex, toIndex, correlationId) {
         },
     };
 }
+/**
+ * Creates the MoveLayoutSection command. Dispatching this command will result in move of the section located at `sectionIndex`
+ * to a new place indicated by `toIndex`.
+ *
+ * @param sectionIndex - index of section to move
+ * @param toIndex - the new index for the section
+ * @param correlationId - specify correlation id to use for this command. this will be included in all
+ *  events that will be emitted during the command processing
+ *
+ * @alpha
+ */
+// eslint-disable-next-line sonarjs/no-identical-functions
+export function moveNestedLayoutSection(sectionIndex, toIndex, correlationId) {
+    return {
+        type: "GDC.DASH/CMD.FLUID_LAYOUT.MOVE_SECTION",
+        correlationId,
+        payload: {
+            sectionIndex,
+            toIndex,
+        },
+    };
+}
 /**
  * Creates the RemoveLayoutSection command.
  *
@@ -60,6 +120,8 @@ export function moveLayoutSection(sectionIndex, toIndex, correlationId) {
  * section. You can optionally specify that the items in the section should not be physically removed but instead be
  * stashed for later 'resurrection'.
  *
+ * This command operates only on the root layout. For nested layouts, use {@link removeNestedLayoutSection}.
+ *
  * @param index - index of section to remove
  * @param stashIdentifier - specify identifier to stash items under; if you do not specify this, then the dashboard items in the removed section will also be removed
  * @param correlationId - specify correlation id to use for this command. this will be included in all
@@ -77,12 +139,40 @@ export function removeLayoutSection(index, stashIdentifier, correlationId) {
         },
     };
 }
+/**
+ * Creates the RemoveLayoutSection command.
+ *
+ * @remarks
+ * Dispatching this command will result in removal of the entire dashboard
+ * section. You can optionally specify that the items in the section should not be physically removed but instead be
+ * stashed for later 'resurrection'.
+ *
+ * @param index - index of section to remove
+ * @param stashIdentifier - specify identifier to stash items under; if you do not specify this, then the dashboard items in the removed section will also be removed
+ * @param correlationId - specify correlation id to use for this command. this will be included in all
+ *  events that will be emitted during the command processing
+ *
+ * @alpha
+ */
+// eslint-disable-next-line sonarjs/no-identical-functions
+export function removeNestedLayoutSection(index, stashIdentifier, correlationId) {
+    return {
+        type: "GDC.DASH/CMD.FLUID_LAYOUT.REMOVE_SECTION",
+        correlationId,
+        payload: {
+            index,
+            stashIdentifier,
+        },
+    };
+}
 /**
  * Creates the ChangeLayoutSectionHeader command.
  *
  * @remarks
  * Dispatching this command will result in change of the section's title and/or description.
  *
+ * This command operates only on the root layout. For nested layouts, use {@link changeNestedLayoutSectionHeader}.
+ *
  * @param index - index of section to change
  * @param header - new header
  * @param merge - indicates whether the old header and the new header should be merged; default is no merging
@@ -102,6 +192,32 @@ export function changeLayoutSectionHeader(index, header, merge, correlationId) {
         },
     };
 }
+/**
+ * Creates the ChangeLayoutSectionHeader command.
+ *
+ * @remarks
+ * Dispatching this command will result in change of the section's title and/or description.
+ *
+ * @param index - index of section to change
+ * @param header - new header
+ * @param merge - indicates whether the old header and the new header should be merged; default is no merging
+ * @param correlationId - specify correlation id to use for this command. this will be included in all
+ *  events that will be emitted during the command processing
+ *
+ * @alpha
+ */
+// eslint-disable-next-line sonarjs/no-identical-functions
+export function changeNestedLayoutSectionHeader(index, header, merge, correlationId) {
+    return {
+        type: "GDC.DASH/CMD.FLUID_LAYOUT.CHANGE_SECTION_HEADER",
+        correlationId,
+        payload: {
+            index,
+            header,
+            merge,
+        },
+    };
+}
 /**
  * Creates the AddSectionItems command.
  *
@@ -110,6 +226,7 @@ export function changeLayoutSectionHeader(index, header, merge, correlationId) {
  * section. This item may be a placeholder for KPI or insight, an actual dashboard widget or a previously stashed
  * dashboard item.
  *
+ * This command operates only on the root layout. For nested layouts, use {@link addNestedLayoutSectionItem}.
  *
  * @param sectionIndex - index of section to which the new item should be added
  * @param itemIndex - index at which to insert the new item
@@ -129,6 +246,38 @@ export function addSectionItem(sectionIndex, itemIndex, item, autoResolveDateFil
         payload: {
             sectionIndex,
             itemIndex,
+            itemPath: undefined,
+            items: [item],
+            autoResolveDateFilterDataset,
+        },
+    };
+}
+/**
+ * Creates the AddSectionItems command.
+ *
+ * @remarks
+ * Dispatching this command will result in addition of a new item into the existing
+ * section. This item may be a placeholder for KPI or insight, an actual dashboard widget or a previously stashed
+ * dashboard item.
+ *
+ * @param itemPath - path to which the new item should be added
+ * @param item - definition of the new item.
+ * @param autoResolveDateFilterDataset - specify whether dashboard should auto-resolve date dataset to use for date filtering of KPI
+ *  and insight widgets; default is disabled meaning date filtering will be enabled only for those KPI or Insight widgets
+ *  that already specify dateDataset.
+ * @param correlationId - specify correlation id to use for this command. this will be included in all
+ *  events that will be emitted during the command processing
+ *
+ * @alpha
+ */
+export function addNestedLayoutSectionItem(itemPath, item, autoResolveDateFilterDataset, correlationId) {
+    return {
+        type: "GDC.DASH/CMD.FLUID_LAYOUT.ADD_ITEMS",
+        correlationId: correlationId,
+        payload: {
+            sectionIndex: -1,
+            itemIndex: -1,
+            itemPath: itemPath,
             items: [item],
             autoResolveDateFilterDataset,
         },
@@ -136,7 +285,10 @@ export function addSectionItem(sectionIndex, itemIndex, item, autoResolveDateFil
 }
 /**
  * Creates the ReplaceSectionItem command. Dispatching this command will result in replacement of particular dashboard
- * item with a new item. By default the old item will be discarded, however you may specify to stash it for later use.
+ * item with a new item. By default, the old item will be discarded, however you may specify to stash it for later use.
+ *
+ * @remarks
+ * This command operates only on the root layout. For nested layouts, use {@link replaceNestedLayoutSectionItem}.
  *
  * @param sectionIndex - index of section where the item to replace resides
  * @param itemIndex - index of item within the section
@@ -149,6 +301,8 @@ export function addSectionItem(sectionIndex, itemIndex, item, autoResolveDateFil
  *  events that will be emitted during the command processing
  *
  * @beta
+ *
+ * TODO LX-648: Consider removing this command variant and leave only a nested variant
  */
 export function replaceSectionItem(sectionIndex, itemIndex, item, stashIdentifier, autoResolveDateFilterDataset, correlationId) {
     return {
@@ -157,9 +311,39 @@ export function replaceSectionItem(sectionIndex, itemIndex, item, stashIdentifie
         payload: {
             sectionIndex,
             itemIndex,
+            itemPath: undefined,
             item,
+            stashIdentifier,
             autoResolveDateFilterDataset,
+        },
+    };
+}
+/**
+ * Creates the ReplaceSectionItem command. Dispatching this command will result in replacement of particular dashboard
+ * item with a new item. By default, the old item will be discarded, however you may specify to stash it for later use.
+ *
+ * @param itemPath - path where the item to replace resides
+ * @param item - new item definition
+ * @param stashIdentifier - specify identifier of stash where the old item should be stored
+ * @param autoResolveDateFilterDataset - specify whether dashboard should auto-resolve date dataset
+ *  to use for date filtering of KPI or insight widget that is replacing the existing item; default is disabled
+ *  meaning date filtering will be enabled only for those KPI or Insight widgets that already specify dateDataset.
+ * @param correlationId - specify correlation id to use for this command. this will be included in all
+ *  events that will be emitted during the command processing
+ *
+ * @alpha
+ */
+export function replaceNestedLayoutSectionItem(itemPath, item, stashIdentifier, autoResolveDateFilterDataset, correlationId) {
+    return {
+        type: "GDC.DASH/CMD.FLUID_LAYOUT.REPLACE_ITEM",
+        correlationId,
+        payload: {
+            sectionIndex: -1,
+            itemIndex: -1,
+            itemPath,
+            item,
             stashIdentifier,
+            autoResolveDateFilterDataset,
         },
     };
 }
@@ -170,6 +354,8 @@ export function replaceSectionItem(sectionIndex, itemIndex, item, stashIdentifie
  * Dispatching this command will result in move of single item within
  * section or from one section to another.
  *
+ * This command operates only on the root layout. For nested layouts, use {@link moveNestedLayoutSectionItem}.
+ *
  * @param sectionIndex - source section index
  * @param itemIndex - index of item to move
  * @param toSectionIndex - target section index; you may specify -1 to move to last section
@@ -178,6 +364,8 @@ export function replaceSectionItem(sectionIndex, itemIndex, item, stashIdentifie
  *  events that will be emitted during the command processing
  *
  * @beta
+ *
+ * TODO LX-648: Consider removing this command variant and leave only a nested variant
  */
 export function moveSectionItem(sectionIndex, itemIndex, toSectionIndex, toItemIndex, correlationId) {
     return {
@@ -187,7 +375,38 @@ export function moveSectionItem(sectionIndex, itemIndex, toSectionIndex, toItemI
             sectionIndex,
             itemIndex,
             toSectionIndex,
-            toItemIndex,
+            toItemIndex: toItemIndex,
+            fromPath: undefined,
+            toPath: undefined,
+            removeOriginalSectionIfEmpty: false,
+        },
+    };
+}
+/**
+ * Creates the MoveSectionItem command.
+ *
+ * @remarks
+ * Dispatching this command will result in move of single item within
+ * section or from one section to another.
+ *
+ * @param fromPath - source item path
+ * @param toPath - target path; you may specify -1 to move to last section/to be last item
+ * @param correlationId - specify correlation id to use for this command. this will be included in all
+ *  events that will be emitted during the command processing
+ *
+ * @alpha
+ */
+export function moveNestedLayoutSectionItem(fromPath, toPath, correlationId) {
+    return {
+        type: "GDC.DASH/CMD.FLUID_LAYOUT.MOVE_ITEM",
+        correlationId,
+        payload: {
+            sectionIndex: -1,
+            itemIndex: -1,
+            toSectionIndex: -1,
+            toItemIndex: -1,
+            fromPath,
+            toPath,
             removeOriginalSectionIfEmpty: false,
         },
     };
@@ -199,6 +418,8 @@ export function moveSectionItem(sectionIndex, itemIndex, toSectionIndex, toItemI
  * Dispatching this command will result in move of single item within
  * section or from one section to another. If original section stays empty after move, then it will be removed.
  *
+ * This command operates only on the root layout. For nested layouts, use {@link moveNestedLayoutSectionItemAndRemoveOriginalSectionIfEmpty}.
+ *
  * @param sectionIndex - source section index
  * @param itemIndex - index of item to move
  * @param toSectionIndex - target section index; you may specify -1 to move to last section
@@ -207,6 +428,8 @@ export function moveSectionItem(sectionIndex, itemIndex, toSectionIndex, toItemI
  *  events that will be emitted during the command processing
  *
  * @beta
+ *
+ * TODO LX-648: Consider removing this command variant and leave only a nested variant
  */
 export function moveSectionItemAndRemoveOriginalSectionIfEmpty(sectionIndex, itemIndex, toSectionIndex, toItemIndex, correlationId) {
     return {
@@ -216,7 +439,38 @@ export function moveSectionItemAndRemoveOriginalSectionIfEmpty(sectionIndex, ite
             sectionIndex,
             itemIndex,
             toSectionIndex,
-            toItemIndex,
+            toItemIndex: toItemIndex,
+            fromPath: undefined,
+            toPath: undefined,
+            removeOriginalSectionIfEmpty: true,
+        },
+    };
+}
+/**
+ * Creates the MoveSectionItem command.
+ *
+ * @remarks
+ * Dispatching this command will result in move of single item within
+ * section or from one section to another. If original section stays empty after move, then it will be removed.
+ *
+ * @param fromPath - source item path
+ * @param toPath - target path; you may specify -1 to move to last section/to be last item
+ * @param correlationId - specify correlation id to use for this command. this will be included in all
+ *  events that will be emitted during the command processing
+ *
+ * @alpha
+ */
+export function moveNestedLayoutSectionItemAndRemoveOriginalSectionIfEmpty(fromPath, toPath, correlationId) {
+    return {
+        type: "GDC.DASH/CMD.FLUID_LAYOUT.MOVE_ITEM",
+        correlationId,
+        payload: {
+            sectionIndex: -1,
+            itemIndex: -1,
+            toSectionIndex: -1,
+            toItemIndex: -1,
+            fromPath,
+            toPath,
             removeOriginalSectionIfEmpty: true,
         },
     };
@@ -228,6 +482,8 @@ export function moveSectionItemAndRemoveOriginalSectionIfEmpty(sectionIndex, ite
  * Dispatching this command will result in move of single item within
  * section or from one section to another.
  *
+ * This command operates only on the root layout. For nested layouts, use {@link moveNestedLayoutSectionItemToNewSection}.
+ *
  * @param sectionIndex - source section index
  * @param itemIndex - index of item to move
  * @param toSectionIndex - target section index; you may specify -1 to move to last section
@@ -235,6 +491,8 @@ export function moveSectionItemAndRemoveOriginalSectionIfEmpty(sectionIndex, ite
  *  events that will be emitted during the command processing
  *
  * @beta
+ *
+ * TODO LX-648: Consider removing this command variant and leave only a nested variant
  */
 export function moveSectionItemToNewSection(sectionIndex, itemIndex, toSectionIndex, correlationId) {
     return {
@@ -244,6 +502,36 @@ export function moveSectionItemToNewSection(sectionIndex, itemIndex, toSectionIn
             sectionIndex,
             itemIndex,
             toSectionIndex,
+            itemPath: undefined,
+            toSection: undefined,
+            removeOriginalSectionIfEmpty: false,
+        },
+    };
+}
+/**
+ * Creates the MoveSectionItemToNewSection command.
+ *
+ * @remarks
+ * Dispatching this command will result in move of single item within
+ * section or from one section to another.
+ *
+ * @param itemPath - source item path
+ * @param toSection - target section path; you may specify -1 to move to last section
+ * @param correlationId - specify correlation id to use for this command. this will be included in all
+ *  events that will be emitted during the command processing
+ *
+ * @alpha
+ */
+export function moveNestedLayoutSectionItemToNewSection(itemPath, toSection, correlationId) {
+    return {
+        type: "GDC.DASH/CMD.FLUID_LAYOUT.MOVE_ITEM_TO_NEW_SECTION",
+        correlationId,
+        payload: {
+            sectionIndex: -1,
+            itemIndex: -1,
+            toSectionIndex: -1,
+            itemPath,
+            toSection,
             removeOriginalSectionIfEmpty: false,
         },
     };
@@ -255,6 +543,8 @@ export function moveSectionItemToNewSection(sectionIndex, itemIndex, toSectionIn
  * Dispatching this command will result in move of single item within
  * section or from one section to another. If original section stays empty after move, then it will be removed.
  *
+ * This command operates only on the root layout. For nested layouts, use {@link moveNestedLayoutSectionItemToNewSectionAndRemoveOriginalSectionIfEmpty}.
+ *
  * @param sectionIndex - source section index
  * @param itemIndex - index of item to move
  * @param toSectionIndex - target section index; you may specify -1 to move to last section
@@ -262,6 +552,8 @@ export function moveSectionItemToNewSection(sectionIndex, itemIndex, toSectionIn
  *  events that will be emitted during the command processing
  *
  * @beta
+ *
+ * TODO LX-648: Consider removing this command variant and leave only a nested variant
  */
 export function moveSectionItemToNewSectionAndRemoveOriginalSectionIfEmpty(sectionIndex, itemIndex, toSectionIndex, correlationId) {
     return {
@@ -271,6 +563,36 @@ export function moveSectionItemToNewSectionAndRemoveOriginalSectionIfEmpty(secti
             sectionIndex,
             itemIndex,
             toSectionIndex,
+            itemPath: undefined,
+            toSection: undefined,
+            removeOriginalSectionIfEmpty: true,
+        },
+    };
+}
+/**
+ * Creates the MoveSectionItemToNewSection command.
+ *
+ * @remarks
+ * Dispatching this command will result in move of single item within
+ * section or from one section to another. If original section stays empty after move, then it will be removed.
+ *
+ * @param itemPath - source item index
+ * @param toSection - target section index; you may specify -1 to move to last section
+ * @param correlationId - specify correlation id to use for this command. this will be included in all
+ *  events that will be emitted during the command processing
+ *
+ * @alpha
+ */
+export function moveNestedLayoutSectionItemToNewSectionAndRemoveOriginalSectionIfEmpty(itemPath, toSection, correlationId) {
+    return {
+        type: "GDC.DASH/CMD.FLUID_LAYOUT.MOVE_ITEM_TO_NEW_SECTION",
+        correlationId,
+        payload: {
+            sectionIndex: -1,
+            itemIndex: -1,
+            toSectionIndex: -1,
+            itemPath,
+            toSection,
             removeOriginalSectionIfEmpty: true,
         },
     };
@@ -285,6 +607,8 @@ export function moveSectionItemToNewSectionAndRemoveOriginalSectionIfEmpty(secti
  *
  * You may optionally specify the stashIdentifier in order to stash the removed item for later resurrection.
  *
+ * This command operates only on the root layout. For nested layouts, use {@link removeNestedLayoutSectionItem}.
+ *
  * @param sectionIndex - index of section from which to remove the item
  * @param itemIndex - index of item to remove
  * @param stashIdentifier - stash identifier to store the removed item under; if not specified the item will be removed
@@ -292,6 +616,8 @@ export function moveSectionItemToNewSectionAndRemoveOriginalSectionIfEmpty(secti
  *  events that will be emitted during the command processing
  *
  * @beta
+ *
+ * TODO LX-648: Consider removing this command variant and leave only a nested variant
  */
 export function removeSectionItem(sectionIndex, itemIndex, stashIdentifier, correlationId) {
     return {
@@ -300,6 +626,37 @@ export function removeSectionItem(sectionIndex, itemIndex, stashIdentifier, corr
         payload: {
             sectionIndex,
             itemIndex,
+            itemPath: undefined,
+            stashIdentifier,
+            eager: false,
+        },
+    };
+}
+/**
+ * Creates the RemoveSectionItem command.
+ *
+ * @remarks
+ * Dispatching this command will result in removal
+ * of the item from a section. If the removed item was last in the section, the section will be left on the layout
+ * and will contain no items.
+ *
+ * You may optionally specify the stashIdentifier in order to stash the removed item for later resurrection.
+ *
+ * @param itemPath - index from which to remove the item
+ * @param stashIdentifier - stash identifier to store the removed item under; if not specified the item will be removed
+ * @param correlationId - specify correlation id to use for this command. this will be included in all
+ *  events that will be emitted during the command processing
+ *
+ * @alpha
+ */
+export function removeNestedLayoutSectionItem(itemPath, stashIdentifier, correlationId) {
+    return {
+        type: "GDC.DASH/CMD.FLUID_LAYOUT.REMOVE_ITEM",
+        correlationId,
+        payload: {
+            sectionIndex: -1,
+            itemIndex: -1,
+            itemPath,
             stashIdentifier,
             eager: false,
         },
@@ -314,6 +671,8 @@ export function removeSectionItem(sectionIndex, itemIndex, stashIdentifier, corr
  *
  * You may optionally specify the stashIdentifier in order to stash the removed item for later resurrection.
  *
+ * This command operates only on the root layout. For nested layouts, use {@link eagerRemoveNestedLayoutSectionItem}.
+ *
  * @param sectionIndex - index of section from which to remove the item
  * @param itemIndex - index of item to remove
  * @param stashIdentifier - stash identifier to store the removed item under; if not specified the item will be removed
@@ -321,6 +680,8 @@ export function removeSectionItem(sectionIndex, itemIndex, stashIdentifier, corr
  *  events that will be emitted during the command processing
  *
  * @beta
+ *
+ * TODO LX-648: Consider removing this command variant and leave only a nested variant
  */
 export function eagerRemoveSectionItem(sectionIndex, itemIndex, stashIdentifier, correlationId) {
     return {
@@ -329,6 +690,36 @@ export function eagerRemoveSectionItem(sectionIndex, itemIndex, stashIdentifier,
         payload: {
             sectionIndex,
             itemIndex,
+            itemPath: undefined,
+            stashIdentifier,
+            eager: true,
+        },
+    };
+}
+/**
+ * Creates the RemoveSectionItem configured to do eager remove of item.
+ *
+ * @remarks
+ * Dispatching this command will result in removal
+ * of the item from a section and if the section only contains that item then the whole section will be removed as well.
+ *
+ * You may optionally specify the stashIdentifier in order to stash the removed item for later resurrection.
+ *
+ * @param itemPath - path of section from which to remove the item
+ * @param stashIdentifier - stash identifier to store the removed item under; if not specified the item will be removed
+ * @param correlationId - specify correlation id to use for this command. this will be included in all
+ *  events that will be emitted during the command processing
+ *
+ * @alpha
+ */
+export function eagerRemoveNestedLayoutSectionItem(itemPath, stashIdentifier, correlationId) {
+    return {
+        type: "GDC.DASH/CMD.FLUID_LAYOUT.REMOVE_ITEM",
+        correlationId,
+        payload: {
+            sectionIndex: -1,
+            itemIndex: -1,
+            itemPath,
             stashIdentifier,
             eager: true,
         },
@@ -440,6 +831,9 @@ export function revertLastLayoutChange(correlationId) {
 /**
  * Creates the ResizeHeight command.
  *
+ * @remarks
+ * This command operates only on the root layout. For nested layouts, use {@link resizeNestedLayoutItemsHeight}.
+ *
  * @param sectionIndex - index of the section
  * @param itemIndexes - indexes of the items
  * @param height - height in Grid Rows (by default 1 Grid Row is 20px)
@@ -459,9 +853,35 @@ export function resizeHeight(sectionIndex, itemIndexes, height, correlationId) {
         },
     };
 }
+/**
+ * Creates the ResizeHeight command.
+ *
+ * @param sectionIndex - index of the section
+ * @param itemIndexes - indexes of the items
+ * @param height - height in Grid Rows (by default 1 Grid Row is 20px)
+ * @param correlationId - specify correlation id to use for this command. this will be included in all
+ *  events that will be emitted during the command processing
+ *
+ * @alpha
+ */
+// eslint-disable-next-line sonarjs/no-identical-functions
+export function resizeNestedLayoutItemsHeight(sectionIndex, itemIndexes, height, correlationId) {
+    return {
+        type: "GDC.DASH/CMD.FLUID_LAYOUT.RESIZE_HEIGHT",
+        correlationId,
+        payload: {
+            sectionIndex,
+            itemIndexes,
+            height,
+        },
+    };
+}
 /**
  * Creates the ResizeWidth command.
  *
+ * @remarks
+ * This command operates only on the root layout. For nested layouts, use {@link resizeNestedLayoutItemWidth}.
+ *
  * @param sectionIndex - index of the section
  * @param itemIndex - index of the item
  * @param width - width in Grid Rows (by default 1 Grid Row is 20px)
@@ -469,6 +889,8 @@ export function resizeHeight(sectionIndex, itemIndexes, height, correlationId) {
  *  events that will be emitted during the command processing
  *
  * @beta
+ *
+ * TODO LX-648: Consider removing this command variant and leave only a nested variant
  */
 export function resizeWidth(sectionIndex, itemIndex, width, correlationId) {
     return {
@@ -477,6 +899,29 @@ export function resizeWidth(sectionIndex, itemIndex, width, correlationId) {
         payload: {
             sectionIndex,
             itemIndex,
+            itemPath: undefined,
+            width,
+        },
+    };
+}
+/**
+ * Creates the ResizeWidth command.
+ *
+ * @param itemPath - index of the section
+ * @param width - width in Grid Rows (by default 1 Grid Row is 20px)
+ * @param correlationId - specify correlation id to use for this command. this will be included in all
+ *  events that will be emitted during the command processing
+ *
+ * @alpha
+ */
+export function resizeNestedLayoutItemWidth(itemPath, width, correlationId) {
+    return {
+        type: "GDC.DASH/CMD.FLUID_LAYOUT.RESIZE_WIDTH",
+        correlationId,
+        payload: {
+            sectionIndex: -1,
+            itemIndex: -1,
+            itemPath,
             width,
         },
     };