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

package/esm/model/commands/layout.d.ts

@@ -1,6 +1,7 @@
-import { IDashboardCommand } from "./base.js";
-import { DashboardItemDefinition, RelativeIndex, StashedDashboardItemsId } from "../types/layoutTypes.js";
 import { IDashboardLayoutSectionHeader, ObjRef } from "@gooddata/sdk-model";
+import { DashboardItemDefinition, RelativeIndex, StashedDashboardItemsId } from "../types/layoutTypes.js";
+import { ILayoutItemPath, ILayoutSectionPath } from "../../types.js";
+import { IDashboardCommand } from "./base.js";
 /**
  * Payload of the {@link AddLayoutSection} command.
  * @beta
@@ -12,8 +13,12 @@ export interface AddLayoutSectionPayload {
      * @remarks
      * Index is zero-based and for convenience index -1 means place new section at the end. 0 means place new
      * section at the beginning. Both 0 and -1 and can be used when inserting the first section into and empty layout.
+     *
+     * {@link RelativeIndex} support will be removed in the next major SDK version. Use {@link ILayoutSectionPath} instead.
+     *
+     * TODO LX-648: Remove RelativeIndex type in the next major version.
      */
-    readonly index: RelativeIndex;
+    readonly index: RelativeIndex | ILayoutSectionPath;
     /**
      * Specify the section header.
      */
@@ -52,8 +57,10 @@ export interface AddLayoutSection extends IDashboardCommand {
  *
  * 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
@@ -64,6 +71,27 @@ export interface AddLayoutSection extends IDashboardCommand {
  * @beta
  */
 export declare function addLayoutSection(index: number, initialHeader?: IDashboardLayoutSectionHeader, initialItems?: DashboardItemDefinition[], autoResolveDateFilterDataset?: boolean, correlationId?: string): AddLayoutSection;
+/**
+ * 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
+ */
+export declare function addNestedLayoutSection(index: ILayoutSectionPath, initialHeader?: IDashboardLayoutSectionHeader, initialItems?: DashboardItemDefinition[], autoResolveDateFilterDataset?: boolean, correlationId?: string): AddLayoutSection;
 /**
  * Payload of the {@link MoveLayoutSection} command.
  * @beta
@@ -73,14 +101,24 @@ export interface MoveLayoutSectionPayload {
      * Index of the section to move.
      *
      * Index is zero-based.
+     *
+     * @remarks
+     * "number" support will be removed in the next major SDK version. Use {@link ILayoutSectionPath} instead.
+     *
+     * TODO LX-648: Remove number type in the next major version.
      */
-    readonly sectionIndex: number;
+    readonly sectionIndex: number | ILayoutSectionPath;
     /**
      * Index where the section should be moved.
      *
      * Index is zero-based. For convenience index of -1 means moving the item to the end of the section list.
+     *
+     * @remarks
+     * "number" support will be removed in the next major SDK version. Use {@link ILayoutSectionPath} instead.
+     *
+     * TODO LX-648: Remove number type in the next major version.
      */
-    readonly toIndex: RelativeIndex;
+    readonly toIndex: number | ILayoutSectionPath;
 }
 /**
  * @beta
@@ -93,6 +131,9 @@ export interface MoveLayoutSection extends IDashboardCommand {
  * 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
@@ -101,6 +142,18 @@ export interface MoveLayoutSection extends IDashboardCommand {
  * @beta
  */
 export declare function moveLayoutSection(sectionIndex: number, toIndex: number, correlationId?: string): MoveLayoutSection;
+/**
+ * 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
+ */
+export declare function moveNestedLayoutSection(sectionIndex: ILayoutSectionPath, toIndex: ILayoutSectionPath, correlationId?: string): MoveLayoutSection;
 /**
  * Payload of the {@link RemoveLayoutSection} command.
  * @beta
@@ -110,8 +163,13 @@ export interface RemoveLayoutSectionPayload {
      * Index of section to remove.
      *
      * Zero based. For convenience -1 can be used to remove the last section.
+     *
+     * @remarks
+     * {@link RelativeIndex} support will be removed in the next major SDK version. Use {@link ILayoutSectionPath} instead.
+     *
+     * TODO LX-648: Remove RelativeIndex type in the next major version.
      */
-    readonly index: RelativeIndex;
+    readonly index: RelativeIndex | ILayoutSectionPath;
     /**
      * Specify stash identifier.
      *
@@ -139,6 +197,8 @@ export interface RemoveLayoutSection extends IDashboardCommand {
  * 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
@@ -147,6 +207,22 @@ export interface RemoveLayoutSection extends IDashboardCommand {
  * @beta
  */
 export declare function removeLayoutSection(index: number, stashIdentifier?: StashedDashboardItemsId, correlationId?: string): RemoveLayoutSection;
+/**
+ * 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
+ */
+export declare function removeNestedLayoutSection(index: ILayoutSectionPath, stashIdentifier?: StashedDashboardItemsId, correlationId?: string): RemoveLayoutSection;
 /**
  * Payload of the {@link ChangeLayoutSectionHeader} command.
  * @public
@@ -157,8 +233,12 @@ export interface ChangeLayoutSectionHeaderPayload {
      *
      * @remarks
      * Index is zero based. Exact index must be provided.
+     *
+     * "number" support will be removed in the next major SDK version. Use {@link ILayoutSectionPath} instead.
+     *
+     * TODO LX-648: Remove number type in the next major version.
      */
-    readonly index: number;
+    readonly index: number | ILayoutSectionPath;
     /**
      * New value of the header.
      */
@@ -184,6 +264,8 @@ export interface ChangeLayoutSectionHeader extends IDashboardCommand {
  * @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
@@ -193,6 +275,21 @@ export interface ChangeLayoutSectionHeader extends IDashboardCommand {
  * @public
  */
 export declare function changeLayoutSectionHeader(index: number, header: IDashboardLayoutSectionHeader, merge?: boolean, correlationId?: string): ChangeLayoutSectionHeader;
+/**
+ * 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
+ */
+export declare function changeNestedLayoutSectionHeader(index: ILayoutSectionPath, header: IDashboardLayoutSectionHeader, merge?: boolean, correlationId?: string): ChangeLayoutSectionHeader;
 /**
  * Payload of the {@link AddSectionItems} command.
  * @beta
@@ -203,6 +300,10 @@ export interface AddSectionItemsPayload {
      *
      * @remarks
      * Index is zero-based.
+     *
+     * {@link AddSectionItemsPayload.sectionIndex} support will be removed in the next major SDK version. Use {@link AddSectionItemsPayload.itemPath} instead.
+     *
+     * TODO LX-648: Remove sectionIndex in the next major version.
      */
     readonly sectionIndex: number;
     /**
@@ -210,8 +311,21 @@ export interface AddSectionItemsPayload {
      *
      * @remarks
      * Index is zero-based. For convenience, you may specify -1 to append the new item.
+     *
+     * {@link AddSectionItemsPayload.itemIndex} support will be removed in the next major SDK version. Use {@link AddSectionItemsPayload.itemPath} instead.
+     *
+     * TODO LX-648: Remove itemIndex in the next major version.
      */
     readonly itemIndex: RelativeIndex;
+    /**
+     * Path to which the item should be added.
+     *
+     * @remarks
+     * Index is zero-based.
+     *
+     * TODO LX-648: make the prop required
+     */
+    readonly itemPath?: ILayoutItemPath;
     /**
      * Items to add. This item may be a placeholder for KPI or insight, an actual dashboard widget or a previously
      * stashed dashboard item.
@@ -250,6 +364,7 @@ export interface AddSectionItems extends IDashboardCommand {
  * 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
@@ -263,6 +378,25 @@ export interface AddSectionItems extends IDashboardCommand {
  * @beta
  */
 export declare function addSectionItem(sectionIndex: number, itemIndex: number, item: DashboardItemDefinition, autoResolveDateFilterDataset?: boolean, correlationId?: string): AddSectionItems;
+/**
+ * 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 declare function addNestedLayoutSectionItem(itemPath: ILayoutItemPath, item: DashboardItemDefinition, autoResolveDateFilterDataset?: boolean, correlationId?: string): AddSectionItems;
 /**
  * Payload of the {@link ReplaceSectionItem} command.
  * @beta
@@ -270,12 +404,28 @@ export declare function addSectionItem(sectionIndex: number, itemIndex: number,
 export interface ReplaceSectionItemPayload {
     /**
      * Index of section where the item to modify resides.
+     *
+     * @remarks
+     * {@link ReplaceSectionItemPayload.sectionIndex} support will be removed in the next major SDK version. Use {@link ReplaceSectionItemPayload.itemPath} instead.
+     *
+     * TODO LX-648: Remove sectionIndex in the next major version.
      */
     readonly sectionIndex: number;
     /**
      * Index of item within section that should be modified.
+     *
+     * @remarks
+     * {@link ReplaceSectionItemPayload.itemIndex} support will be removed in the next major SDK version. Use {@link ReplaceSectionItemPayload.itemPath} instead.
+     *
+     * TODO LX-648: Remove itemIndex in the next major version.
      */
     readonly itemIndex: number;
+    /**
+     * Index where the item to modify resides.
+     *
+     * TODO LX-648: make the prop required
+     */
+    readonly itemPath?: ILayoutItemPath;
     /**
      * New item definition.
      */
@@ -310,7 +460,10 @@ export interface ReplaceSectionItem extends IDashboardCommand {
 }
 /**
  * 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
@@ -323,8 +476,26 @@ export interface ReplaceSectionItem extends IDashboardCommand {
  *  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 declare function replaceSectionItem(sectionIndex: number, itemIndex: number, item: DashboardItemDefinition, stashIdentifier?: StashedDashboardItemsId, autoResolveDateFilterDataset?: boolean, correlationId?: string): ReplaceSectionItem;
+/**
+ * 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 declare function replaceNestedLayoutSectionItem(itemPath: ILayoutItemPath, item: DashboardItemDefinition, stashIdentifier?: StashedDashboardItemsId, autoResolveDateFilterDataset?: boolean, correlationId?: string): ReplaceSectionItem;
 /**
  * Payload of the {@link MoveSectionItem} command.
  * @beta
@@ -334,18 +505,33 @@ export interface MoveSectionItemPayload {
      * Index of the section where the item to move is located.
      *
      * Index is zero-based.
+     *
+     * @remarks
+     * {@link MoveSectionItemPayload.sectionIndex} support will be removed in the next major SDK version. Use {@link MoveSectionItemPayload.fromPath} instead.
+     *
+     * TODO LX-648: Remove sectionIndex in the next major version.
      */
     readonly sectionIndex: number;
     /**
      * Index of section item that should be moved.
      *
      * Index is zero-based.
+     *
+     * @remarks
+     * {@link MoveSectionItemPayload.itemIndex} support will be removed in the next major SDK version. Use {@link MoveSectionItemPayload.fromPath} instead.
+     *
+     * TODO LX-648: Remove itemIndex in the next major version.
      */
     readonly itemIndex: number;
     /**
      * Index of section to which the item should be moved.
      *
      * Index is zero-based. For convenience you may specify -1 to move to last section.
+     *
+     * @remarks
+     * {@link MoveSectionItemPayload.toSectionIndex} support will be removed in the next major SDK version. Use {@link MoveSectionItemPayload.toPath} instead.
+     *
+     * TODO LX-648: Remove toSectionIndex in the next major version.
      */
     readonly toSectionIndex: RelativeIndex;
     /**
@@ -353,8 +539,29 @@ export interface MoveSectionItemPayload {
      *
      * Index is zero-based. For convenience you may specify -1 to append the item at the end of the target section's
      * items.
+     *
+     * @remarks
+     * {@link MoveSectionItemPayload.toItemIndex} support will be removed in the next major SDK version. Use {@link MoveSectionItemPayload.toPath} instead.
+     *
+     * TODO LX-648: Remove toItemIndex in the next major version.
      */
     readonly toItemIndex: RelativeIndex;
+    /**
+     * Path where the item to move is located.
+     *
+     * Index is zero-based.
+     *
+     * TODO LX-648: make the prop required
+     */
+    readonly fromPath?: ILayoutItemPath;
+    /**
+     * Path to which the item should be moved.
+     *
+     * Index is zero-based. For convenience, you may specify -1 to move to last section.
+     *
+     * TODO LX-648: make the prop required
+     */
+    readonly toPath?: ILayoutItemPath;
     /**
      * If true and original section stays empty after move, then it will be removed.
      */
@@ -374,6 +581,8 @@ export interface MoveSectionItem extends IDashboardCommand {
  * 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
@@ -382,8 +591,25 @@ export interface MoveSectionItem extends IDashboardCommand {
  *  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 declare function moveSectionItem(sectionIndex: number, itemIndex: number, toSectionIndex: number, toItemIndex: number, correlationId?: string): MoveSectionItem;
+/**
+ * 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 declare function moveNestedLayoutSectionItem(fromPath: ILayoutItemPath, toPath: ILayoutItemPath, correlationId?: string): MoveSectionItem;
 /**
  * Creates the MoveSectionItem command.
  *
@@ -391,6 +617,8 @@ export declare function moveSectionItem(sectionIndex: number, itemIndex: number,
  * 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
@@ -399,8 +627,25 @@ export declare function moveSectionItem(sectionIndex: number, itemIndex: number,
  *  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 declare function moveSectionItemAndRemoveOriginalSectionIfEmpty(sectionIndex: number, itemIndex: number, toSectionIndex: number, toItemIndex: number, correlationId?: string): MoveSectionItem;
+/**
+ * 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 declare function moveNestedLayoutSectionItemAndRemoveOriginalSectionIfEmpty(fromPath: ILayoutItemPath, toPath: ILayoutItemPath, correlationId?: string): MoveSectionItem;
 /**
  * Payload of the {@link MoveSectionItemToNewSection} command.
  * @beta
@@ -410,20 +655,49 @@ export interface MoveSectionItemToNewSectionPayload {
      * Index of the section where the item to move is located.
      *
      * Index is zero-based.
+     *
+     * @remarks
+     * {@link MoveSectionItemToNewSectionPayload.sectionIndex} support will be removed in the next major SDK version. Use {@link MoveSectionItemToNewSectionPayload.itemPath} instead.
+     *
+     * TODO LX-648: Remove sectionIndex in the next major version.
      */
     readonly sectionIndex: number;
     /**
      * Index of section item that should be moved.
      *
      * Index is zero-based.
+     *
+     * @remarks
+     * {@link MoveSectionItemToNewSectionPayload.itemIndex} support will be removed in the next major SDK version. Use {@link MoveSectionItemToNewSectionPayload.itemPath} instead.
+     *
+     * TODO LX-648: Remove itemIndex in the next major version.
      */
     readonly itemIndex: number;
     /**
      * Index of section to which should be created and the item should be moved into.
      *
      * Index is zero-based. For convenience you may specify -1 to move to last section.
+     *
+     * @remarks
+     * {@link MoveSectionItemToNewSectionPayload.toSectionIndex} support will be removed in the next major SDK version. Use {@link MoveSectionItemToNewSectionPayload.itemPath} instead.
+     *
+     * TODO LX-648: Remove toSectionIndex in the next major version.
      */
     readonly toSectionIndex: RelativeIndex;
+    /**
+     * Index where the item to move is located.
+     *
+     * TODO LX-648: make the prop required
+     */
+    readonly itemPath?: ILayoutItemPath;
+    /**
+     * Path of section that should be created and the item should be moved into.
+     *
+     * Index is zero-based. For convenience, you may specify -1 to move to last section.
+     *
+     * TODO LX-648: make the prop required
+     */
+    readonly toSection?: ILayoutSectionPath;
     /**
      * If true and original section stays empty after move, then it will be removed.
      */
@@ -443,6 +717,8 @@ export interface MoveSectionItemToNewSection extends IDashboardCommand {
  * 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
@@ -450,8 +726,25 @@ export interface MoveSectionItemToNewSection extends IDashboardCommand {
  *  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 declare function moveSectionItemToNewSection(sectionIndex: number, itemIndex: number, toSectionIndex: number, correlationId?: string): MoveSectionItemToNewSection;
+/**
+ * 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 declare function moveNestedLayoutSectionItemToNewSection(itemPath: ILayoutItemPath, toSection: ILayoutSectionPath, correlationId?: string): MoveSectionItemToNewSection;
 /**
  * Creates the MoveSectionItemToNewSection command.
  *
@@ -459,6 +752,8 @@ export declare function moveSectionItemToNewSection(sectionIndex: number, itemIn
  * 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
@@ -466,8 +761,25 @@ export declare function moveSectionItemToNewSection(sectionIndex: number, itemIn
  *  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 declare function moveSectionItemToNewSectionAndRemoveOriginalSectionIfEmpty(sectionIndex: number, itemIndex: number, toSectionIndex: number, correlationId?: string): MoveSectionItemToNewSection;
+/**
+ * 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 declare function moveNestedLayoutSectionItemToNewSectionAndRemoveOriginalSectionIfEmpty(itemPath: ILayoutItemPath, toSection: ILayoutSectionPath, correlationId?: string): MoveSectionItemToNewSection;
 /**
  * Payload of the {@link RemoveSectionItem} command.
  * @beta
@@ -478,6 +790,10 @@ export interface RemoveSectionItemPayload {
      *
      * @remarks
      * Index is zero-based.
+     *
+     * {@link RemoveSectionItemPayload.sectionIndex} support will be removed in the next major SDK version. Use {@link RemoveSectionItemPayload.itemPath} instead.
+     *
+     * TODO LX-648: Remove sectionIndex in the next major version.
      */
     readonly sectionIndex: number;
     /**
@@ -485,8 +801,21 @@ export interface RemoveSectionItemPayload {
      *
      * @remarks
      * Index is zero-based. For convenience you may use index of -1 to remove last item from section.
+     *
+     * {@link RemoveSectionItemPayload.itemIndex} support will be removed in the next major SDK version. Use {@link RemoveSectionItemPayload.itemPath} instead.
+     *
+     * TODO LX-648: Remove itemIndex in the next major version.
      */
     readonly itemIndex: RelativeIndex;
+    /**
+     * Index where the item to remove is located.
+     *
+     * @remarks
+     * Index is zero-based.
+     *
+     * TODO LX-648: make the prop required
+     */
+    readonly itemPath?: ILayoutItemPath;
     /**
      * Specify stash identifier.
      *
@@ -524,6 +853,8 @@ export interface RemoveSectionItem extends IDashboardCommand {
  *
  * 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
@@ -531,8 +862,28 @@ export interface RemoveSectionItem extends IDashboardCommand {
  *  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 declare function removeSectionItem(sectionIndex: number, itemIndex: number, stashIdentifier?: StashedDashboardItemsId, correlationId?: string): RemoveSectionItem;
+/**
+ * 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 declare function removeNestedLayoutSectionItem(itemPath: ILayoutItemPath, stashIdentifier?: StashedDashboardItemsId, correlationId?: string): RemoveSectionItem;
 /**
  * Creates the RemoveSectionItem configured to do eager remove of item.
  *
@@ -542,6 +893,8 @@ export declare function removeSectionItem(sectionIndex: number, itemIndex: numbe
  *
  * 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
@@ -549,8 +902,27 @@ export declare function removeSectionItem(sectionIndex: number, itemIndex: numbe
  *  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 declare function eagerRemoveSectionItem(sectionIndex: number, itemIndex: number, stashIdentifier?: StashedDashboardItemsId, correlationId?: string): RemoveSectionItem;
+/**
+ * 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 declare function eagerRemoveNestedLayoutSectionItem(itemPath: ILayoutItemPath, stashIdentifier?: StashedDashboardItemsId, correlationId?: string): RemoveSectionItem;
 /**
  * Payload of the {@link RemoveSectionItemByWidgetRef} command.
  * @beta
@@ -717,8 +1089,13 @@ export interface ResizeHeightPayload {
      * Index of the section to resize.
      *
      * Index is zero-based.
+     *
+     * @remarks
+     * "number" support will be removed in the next major SDK version. Use {@link ILayoutSectionPath} instead.
+     *
+     * TODO LX-648: Remove number type in the next major version.
      */
-    readonly sectionIndex: number;
+    readonly sectionIndex: number | ILayoutSectionPath;
     /**
      * Indexes of the items to resize.
      *
@@ -740,6 +1117,9 @@ export interface ResizeHeight extends IDashboardCommand {
 /**
  * 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)
@@ -749,6 +1129,18 @@ export interface ResizeHeight extends IDashboardCommand {
  * @beta
  */
 export declare function resizeHeight(sectionIndex: number, itemIndexes: number[], height: number, correlationId?: string): ResizeHeight;
+/**
+ * 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
+ */
+export declare function resizeNestedLayoutItemsHeight(sectionIndex: ILayoutSectionPath, itemIndexes: number[], height: number, correlationId?: string): ResizeHeight;
 /**
  * Payload of the {@link ResizeWidth} command.
  * @beta
@@ -758,14 +1150,32 @@ export interface ResizeWidthPayload {
      * Index of the section to resize.
      *
      * Index is zero-based.
+     *
+     * @remarks
+     * {@link ResizeWidthPayload.sectionIndex} support will be removed in the next major SDK version. Use {@link ResizeWidthPayload.itemPath} instead.
+     *
+     * TODO LX-648: Remove sectionIndex in the next major version.
      */
     readonly sectionIndex: number;
     /**
      * Indexes of the item to resize.
      *
      * Index is zero-based.
+     *
+     * @remarks
+     * {@link ResizeWidthPayload.itemIndex} support will be removed in the next major SDK version. Use {@link ResizeWidthPayload.itemPath} instead.
+     *
+     * TODO LX-648: Remove itemIndex in the next major version.
      */
     readonly itemIndex: number;
+    /**
+     * Index of the item to resize.
+     *
+     * Index is zero-based.
+     *
+     * TODO LX-648: make the prop required
+     */
+    readonly itemPath?: ILayoutItemPath;
     /**
      * width to resize.
      */
@@ -781,6 +1191,9 @@ export interface ResizeWidth extends IDashboardCommand {
 /**
  * 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)
@@ -788,6 +1201,19 @@ export interface ResizeWidth extends IDashboardCommand {
  *  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 declare function resizeWidth(sectionIndex: number, itemIndex: number, width: number, correlationId?: string): ResizeWidth;
+/**
+ * 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 declare function resizeNestedLayoutItemWidth(itemPath: ILayoutItemPath, width: number, correlationId?: string): ResizeWidth;
 //# sourceMappingURL=layout.d.ts.map