@itwin/appui-react 4.0.0-dev.9 → 4.0.0

package/lib/esm/appui-react/backstage/BackstageItem.d.ts

@@ -1,29 +1,60 @@
-/** @packageDocumentation
- * @module Backstage
- */
-import { BackstageActionItem as UIA_BackstageActionItem, BackstageItem as UIA_BackstageItem, BackstageStageLauncher as UIA_BackstageStageLauncher, CommonBackstageItem as UIA_CommonBackstageItem } from "@itwin/appui-abstract";
-/** Describes the data needed to insert a button into the backstage menu.
- * @beta
- */
-export declare type CommonBackstageItem = UIA_CommonBackstageItem;
-/** Describes the data needed to insert an action button into the backstage menu.
- * @beta
- */
-export declare type BackstageActionItem = UIA_BackstageActionItem;
-/** Describes the data needed to insert an action button into the backstage menu.
- * @beta
- */
-export declare type BackstageStageLauncher = UIA_BackstageStageLauncher;
-/** Describes the data needed to insert a button into the backstage menu.
- * @public TODO: 4.x cleanup
- */
-export declare type BackstageItem = UIA_BackstageItem;
-/** BackstageActionItem type guard.
- * @beta
- */
-export declare function isBackstageActionItem(item: BackstageItem): item is UIA_BackstageActionItem;
-/** BackstageStageLauncher type guard.
- * @beta
- */
-export declare function isBackstageStageLauncher(item: BackstageItem): item is UIA_BackstageStageLauncher;
+/** @packageDocumentation
+ * @module Backstage
+ */
+import { BadgeType, ConditionalBooleanValue, ConditionalStringValue } from "@itwin/appui-abstract";
+import { IconSpec } from "@itwin/core-react";
+/** Describes the data needed to insert a button into the backstage menu.
+ * @public
+ */
+export interface CommonBackstageItem {
+    /** Required unique id of the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */
+    readonly id: string;
+    /** Describes badge. Renders no badge if not specified. */
+    readonly badge?: BadgeType;
+    /** Specifies the item's grouping value. Items are sorted by group and then item priority. When
+     * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This
+     * allows extensions enough gaps to insert their own groups.
+     */
+    readonly groupPriority: number;
+    /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id. */
+    readonly icon?: IconSpec;
+    /** Describes if the item is visible or hidden. The default is for the item to be visible. */
+    readonly isHidden?: boolean | ConditionalBooleanValue;
+    /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */
+    readonly isDisabled?: boolean | ConditionalBooleanValue;
+    /** Priority within a group (recommend using values 1 through 100). */
+    readonly itemPriority: number;
+    /** Label. */
+    readonly label: string | ConditionalStringValue;
+    /** Subtitle. */
+    readonly subtitle?: string | ConditionalStringValue;
+    /** Tooltip. */
+    readonly tooltip?: string | ConditionalStringValue;
+    /** Describes if the item is active. The default is for the item to be active if stageId matches activeFrontstageId */
+    readonly isActive?: boolean | ConditionalBooleanValue;
+}
+/** Describes the data needed to insert an action button into the backstage menu.
+ * @public
+ */
+export interface BackstageActionItem extends CommonBackstageItem {
+    readonly execute: () => void;
+}
+/** Describes the data needed to insert an action button into the backstage menu.
+ * @public
+ */
+export interface BackstageStageLauncher extends CommonBackstageItem {
+    readonly stageId: string;
+}
+/** Describes the data needed to insert a button into the backstage menu.
+ * @public
+ */
+export type BackstageItem = BackstageActionItem | BackstageStageLauncher;
+/** BackstageActionItem type guard.
+ * @public
+ */
+export declare function isBackstageActionItem(item: BackstageItem): item is BackstageActionItem;
+/** BackstageStageLauncher type guard.
+ * @public
+ */
+export declare function isBackstageStageLauncher(item: BackstageItem): item is BackstageStageLauncher;
 //# sourceMappingURL=BackstageItem.d.ts.map

package/lib/esm/appui-react/backstage/BackstageItem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BackstageItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAGL,mBAAmB,IAAI,uBAAuB,EAC9C,aAAa,IAAI,iBAAiB,EAClC,sBAAsB,IAAI,0BAA0B,EACpD,mBAAmB,IAAI,uBAAuB,EAC/C,MAAM,uBAAuB,CAAC;AAE/B;;GAEG;AACH,oBAAY,mBAAmB,GAAG,uBAAuB,CAAC;AAE1D;;GAEG;AACH,oBAAY,mBAAmB,GAAG,uBAAuB,CAAC;AAE1D;;GAEG;AACH,oBAAY,sBAAsB,GAAG,0BAA0B,CAAC;AAEhE;;GAEG;AACH,oBAAY,aAAa,GAAG,iBAAiB,CAAC;AAE9C;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI,IAAI,uBAAuB,CAE1F;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI,IAAI,0BAA0B,CAEhG"}
+{"version":3,"file":"BackstageItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AACnG,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,kIAAkI;IAClI,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,0DAA0D;IAC1D,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC;IAC3B;;;OAGG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,qHAAqH;IACrH,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC;IACzB,6FAA6F;IAC7F,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IACtD,+FAA+F;IAC/F,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IACxD,sEAAsE;IACtE,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,aAAa;IACb,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,gBAAgB;IAChB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACpD,eAAe;IACf,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACnD,sHAAsH;IACtH,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;CACvD;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;IACjE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,mBAAmB,GAAG,sBAAsB,CAAC;AAEzE;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI,IAAI,mBAAmB,CAEtF;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI,IAAI,sBAAsB,CAE5F"}

package/lib/esm/appui-react/backstage/BackstageItem.js

@@ -1,21 +1,20 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Backstage
- */
-import { isActionItem, isStageLauncher, } from "@itwin/appui-abstract";
-/** BackstageActionItem type guard.
- * @beta
- */
-export function isBackstageActionItem(item) {
-    return isActionItem(item); // eslint-disable-line deprecation/deprecation
-}
-/** BackstageStageLauncher type guard.
- * @beta
- */
-export function isBackstageStageLauncher(item) {
-    return isStageLauncher(item); // eslint-disable-line deprecation/deprecation
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Backstage
+ */
+/** BackstageActionItem type guard.
+ * @public
+ */
+export function isBackstageActionItem(item) {
+    return "execute" in item;
+}
+/** BackstageStageLauncher type guard.
+ * @public
+ */
+export function isBackstageStageLauncher(item) {
+    return "stageId" in item;
+}
 //# sourceMappingURL=BackstageItem.js.map

package/lib/esm/appui-react/backstage/BackstageItem.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackstageItem.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EACL,YAAY,EACZ,eAAe,GAKhB,MAAM,uBAAuB,CAAC;AAsB/B;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,IAAmB;IACvD,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,8CAA8C;AAC3E,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,IAAmB;IAC1D,OAAO,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,8CAA8C;AAC9E,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Backstage\r\n */\r\n\r\nimport {\r\n  isActionItem,\r\n  isStageLauncher,\r\n  BackstageActionItem as UIA_BackstageActionItem,\r\n  BackstageItem as UIA_BackstageItem,\r\n  BackstageStageLauncher as UIA_BackstageStageLauncher,\r\n  CommonBackstageItem as UIA_CommonBackstageItem,\r\n} from \"@itwin/appui-abstract\";\r\n\r\n/** Describes the data needed to insert a button into the backstage menu.\r\n * @beta\r\n */\r\nexport type CommonBackstageItem = UIA_CommonBackstageItem; // eslint-disable-line deprecation/deprecation\r\n\r\n/** Describes the data needed to insert an action button into the backstage menu.\r\n * @beta\r\n */\r\nexport type BackstageActionItem = UIA_BackstageActionItem; // eslint-disable-line deprecation/deprecation\r\n\r\n/** Describes the data needed to insert an action button into the backstage menu.\r\n * @beta\r\n */\r\nexport type BackstageStageLauncher = UIA_BackstageStageLauncher; // eslint-disable-line deprecation/deprecation\r\n\r\n/** Describes the data needed to insert a button into the backstage menu.\r\n * @public TODO: 4.x cleanup\r\n */\r\nexport type BackstageItem = UIA_BackstageItem; // eslint-disable-line deprecation/deprecation\r\n\r\n/** BackstageActionItem type guard.\r\n * @beta\r\n */\r\nexport function isBackstageActionItem(item: BackstageItem): item is UIA_BackstageActionItem { // eslint-disable-line deprecation/deprecation\r\n  return isActionItem(item); // eslint-disable-line deprecation/deprecation\r\n}\r\n\r\n/** BackstageStageLauncher type guard.\r\n * @beta\r\n */\r\nexport function isBackstageStageLauncher(item: BackstageItem): item is UIA_BackstageStageLauncher { // eslint-disable-line deprecation/deprecation\r\n  return isStageLauncher(item); // eslint-disable-line deprecation/deprecation\r\n}\r\n"]}
+{"version":3,"file":"BackstageItem.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAuDH;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,IAAmB;IACvD,OAAO,SAAS,IAAI,IAAI,CAAC;AAC3B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,IAAmB;IAC1D,OAAO,SAAS,IAAI,IAAI,CAAC;AAC3B,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Backstage\r\n */\r\n\r\nimport { BadgeType, ConditionalBooleanValue, ConditionalStringValue } from \"@itwin/appui-abstract\";\r\nimport { IconSpec } from \"@itwin/core-react\";\r\n\r\n/** Describes the data needed to insert a button into the backstage menu.\r\n * @public\r\n */\r\nexport interface CommonBackstageItem {\r\n  /** Required unique id of the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */\r\n  readonly id: string;\r\n  /** Describes badge. Renders no badge if not specified. */\r\n  readonly badge?: BadgeType;\r\n  /** Specifies the item's grouping value. Items are sorted by group and then item priority. When\r\n   * group priority changes a separator is inserted. It is recommended using values 10 through 100, incrementing by 10. This\r\n   * allows extensions enough gaps to insert their own groups.\r\n   */\r\n  readonly groupPriority: number;\r\n  /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\r\n  readonly icon?: IconSpec;\r\n  /** Describes if the item is visible or hidden. The default is for the item to be visible. */\r\n  readonly isHidden?: boolean | ConditionalBooleanValue;\r\n  /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */\r\n  readonly isDisabled?: boolean | ConditionalBooleanValue;\r\n  /** Priority within a group (recommend using values 1 through 100). */\r\n  readonly itemPriority: number;\r\n  /** Label. */\r\n  readonly label: string | ConditionalStringValue;\r\n  /** Subtitle. */\r\n  readonly subtitle?: string | ConditionalStringValue;\r\n  /** Tooltip. */\r\n  readonly tooltip?: string | ConditionalStringValue;\r\n  /** Describes if the item is active. The default is for the item to be active if stageId matches activeFrontstageId */\r\n  readonly isActive?: boolean | ConditionalBooleanValue;\r\n}\r\n\r\n/** Describes the data needed to insert an action button into the backstage menu.\r\n * @public\r\n */\r\nexport interface BackstageActionItem extends CommonBackstageItem {\r\n  readonly execute: () => void;\r\n}\r\n\r\n/** Describes the data needed to insert an action button into the backstage menu.\r\n * @public\r\n */\r\nexport interface BackstageStageLauncher extends CommonBackstageItem {\r\n  readonly stageId: string;\r\n}\r\n\r\n/** Describes the data needed to insert a button into the backstage menu.\r\n * @public\r\n */\r\nexport type BackstageItem = BackstageActionItem | BackstageStageLauncher;\r\n\r\n/** BackstageActionItem type guard.\r\n * @public\r\n */\r\nexport function isBackstageActionItem(item: BackstageItem): item is BackstageActionItem {\r\n  return \"execute\" in item;\r\n}\r\n\r\n/** BackstageStageLauncher type guard.\r\n * @public\r\n */\r\nexport function isBackstageStageLauncher(item: BackstageItem): item is BackstageStageLauncher {\r\n  return \"stageId\" in item;\r\n}\r\n"]}

package/lib/esm/appui-react/backstage/BackstageItemUtilities.d.ts

@@ -1,14 +1,15 @@
-/** @packageDocumentation
- * @module Backstage
- */
-import { BackstageActionItem, BackstageStageLauncher } from "./BackstageItem";
-/** Utilities for creating and maintaining backstage items
- * @beta
- */
-export declare namespace BackstageItemUtilities {
-    /** Creates a stage launcher backstage item. */
-    function createStageLauncher(frontstageId: string, groupPriority: number, itemPriority: number, label: string, subtitle?: string, iconSpec?: string, overrides?: Partial<BackstageStageLauncher>): BackstageStageLauncher;
-    /** Creates an action backstage item. */
-    function createActionItem(itemId: string, groupPriority: number, itemPriority: number, execute: () => void, label: string, subtitle?: string, iconSpec?: string, overrides?: Partial<BackstageActionItem>): BackstageActionItem;
-}
+/** @packageDocumentation
+ * @module Backstage
+ */
+import { IconSpec } from "@itwin/core-react";
+import { BackstageActionItem, BackstageStageLauncher } from "./BackstageItem";
+/** Utilities for creating and maintaining backstage items
+ * @beta
+ */
+export declare namespace BackstageItemUtilities {
+    /** Creates a stage launcher backstage item. */
+    function createStageLauncher(frontstageId: string, groupPriority: number, itemPriority: number, label: string, subtitle?: string, icon?: IconSpec, overrides?: Partial<BackstageStageLauncher>): BackstageStageLauncher;
+    /** Creates an action backstage item. */
+    function createActionItem(itemId: string, groupPriority: number, itemPriority: number, execute: () => void, label: string, subtitle?: string, icon?: IconSpec, overrides?: Partial<BackstageActionItem>): BackstageActionItem;
+}
 //# sourceMappingURL=BackstageItemUtilities.d.ts.map

package/lib/esm/appui-react/backstage/BackstageItemUtilities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BackstageItemUtilities.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItemUtilities.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAE9E;;GAEG;AACH,yBAAiB,sBAAsB,CAAC;IACtC,+CAA+C;IAC/C,SAAgB,mBAAmB,CAAC,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GAAG,sBAAsB,CAW/N;IAED,wCAAwC;IACxC,SAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,mBAAmB,CAWrO;CACF"}
+{"version":3,"file":"BackstageItemUtilities.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItemUtilities.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAE9E;;GAEG;AACH,yBAAiB,sBAAsB,CAAC;IACtC,+CAA+C;IAC/C,SAAgB,mBAAmB,CAAC,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,GAAG,sBAAsB,CAW7N;IAED,wCAAwC;IACxC,SAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,mBAAmB,CAWnO;CACF"}

package/lib/esm/appui-react/backstage/BackstageItemUtilities.js

@@ -1,42 +1,42 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Backstage
- */
-/** Utilities for creating and maintaining backstage items
- * @beta
- */
-export var BackstageItemUtilities;
-(function (BackstageItemUtilities) {
-    /** Creates a stage launcher backstage item. */
-    function createStageLauncher(frontstageId, groupPriority, itemPriority, label, subtitle, iconSpec, overrides) {
-        return {
-            groupPriority,
-            icon: iconSpec,
-            id: frontstageId,
-            itemPriority,
-            label,
-            stageId: frontstageId,
-            subtitle,
-            ...overrides,
-        };
-    }
-    BackstageItemUtilities.createStageLauncher = createStageLauncher;
-    /** Creates an action backstage item. */
-    function createActionItem(itemId, groupPriority, itemPriority, execute, label, subtitle, iconSpec, overrides) {
-        return {
-            execute,
-            groupPriority,
-            icon: iconSpec,
-            id: itemId,
-            itemPriority,
-            label,
-            subtitle,
-            ...overrides,
-        };
-    }
-    BackstageItemUtilities.createActionItem = createActionItem;
-})(BackstageItemUtilities || (BackstageItemUtilities = {}));
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Backstage
+ */
+/** Utilities for creating and maintaining backstage items
+ * @beta
+ */
+export var BackstageItemUtilities;
+(function (BackstageItemUtilities) {
+    /** Creates a stage launcher backstage item. */
+    function createStageLauncher(frontstageId, groupPriority, itemPriority, label, subtitle, icon, overrides) {
+        return {
+            groupPriority,
+            icon,
+            id: frontstageId,
+            itemPriority,
+            label,
+            stageId: frontstageId,
+            subtitle,
+            ...overrides,
+        };
+    }
+    BackstageItemUtilities.createStageLauncher = createStageLauncher;
+    /** Creates an action backstage item. */
+    function createActionItem(itemId, groupPriority, itemPriority, execute, label, subtitle, icon, overrides) {
+        return {
+            execute,
+            groupPriority,
+            icon,
+            id: itemId,
+            itemPriority,
+            label,
+            subtitle,
+            ...overrides,
+        };
+    }
+    BackstageItemUtilities.createActionItem = createActionItem;
+})(BackstageItemUtilities || (BackstageItemUtilities = {}));
 //# sourceMappingURL=BackstageItemUtilities.js.map

package/lib/esm/appui-react/backstage/BackstageItemUtilities.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackstageItemUtilities.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItemUtilities.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH;;GAEG;AACH,MAAM,KAAW,sBAAsB,CA4BtC;AA5BD,WAAiB,sBAAsB;IACrC,+CAA+C;IAC/C,SAAgB,mBAAmB,CAAC,YAAoB,EAAE,aAAqB,EAAE,YAAoB,EAAE,KAAa,EAAE,QAAiB,EAAE,QAAiB,EAAE,SAA2C;QACrM,OAAO;YACL,aAAa;YACb,IAAI,EAAE,QAAQ;YACd,EAAE,EAAE,YAAY;YAChB,YAAY;YACZ,KAAK;YACL,OAAO,EAAE,YAAY;YACrB,QAAQ;YACR,GAAG,SAAS;SACb,CAAC;IACJ,CAAC;IAXe,0CAAmB,sBAWlC,CAAA;IAED,wCAAwC;IACxC,SAAgB,gBAAgB,CAAC,MAAc,EAAE,aAAqB,EAAE,YAAoB,EAAE,OAAmB,EAAE,KAAa,EAAE,QAAiB,EAAE,QAAiB,EAAE,SAAwC;QAC9M,OAAO;YACL,OAAO;YACP,aAAa;YACb,IAAI,EAAE,QAAQ;YACd,EAAE,EAAE,MAAM;YACV,YAAY;YACZ,KAAK;YACL,QAAQ;YACR,GAAG,SAAS;SACb,CAAC;IACJ,CAAC;IAXe,uCAAgB,mBAW/B,CAAA;AACH,CAAC,EA5BgB,sBAAsB,KAAtB,sBAAsB,QA4BtC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Backstage\r\n */\r\n\r\nimport { BackstageActionItem, BackstageStageLauncher } from \"./BackstageItem\";\r\n\r\n/** Utilities for creating and maintaining backstage items\r\n * @beta\r\n */\r\nexport namespace BackstageItemUtilities {\r\n  /** Creates a stage launcher backstage item. */\r\n  export function createStageLauncher(frontstageId: string, groupPriority: number, itemPriority: number, label: string, subtitle?: string, iconSpec?: string, overrides?: Partial<BackstageStageLauncher>): BackstageStageLauncher {\r\n    return {\r\n      groupPriority,\r\n      icon: iconSpec,\r\n      id: frontstageId,\r\n      itemPriority,\r\n      label,\r\n      stageId: frontstageId,\r\n      subtitle,\r\n      ...overrides,\r\n    };\r\n  }\r\n\r\n  /** Creates an action backstage item. */\r\n  export function createActionItem(itemId: string, groupPriority: number, itemPriority: number, execute: () => void, label: string, subtitle?: string, iconSpec?: string, overrides?: Partial<BackstageActionItem>): BackstageActionItem {\r\n    return {\r\n      execute,\r\n      groupPriority,\r\n      icon: iconSpec,\r\n      id: itemId,\r\n      itemPriority,\r\n      label,\r\n      subtitle,\r\n      ...overrides,\r\n    };\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"BackstageItemUtilities.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItemUtilities.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAKH;;GAEG;AACH,MAAM,KAAW,sBAAsB,CA4BtC;AA5BD,WAAiB,sBAAsB;IACrC,+CAA+C;IAC/C,SAAgB,mBAAmB,CAAC,YAAoB,EAAE,aAAqB,EAAE,YAAoB,EAAE,KAAa,EAAE,QAAiB,EAAE,IAAe,EAAE,SAA2C;QACnM,OAAO;YACL,aAAa;YACb,IAAI;YACJ,EAAE,EAAE,YAAY;YAChB,YAAY;YACZ,KAAK;YACL,OAAO,EAAE,YAAY;YACrB,QAAQ;YACR,GAAG,SAAS;SACb,CAAC;IACJ,CAAC;IAXe,0CAAmB,sBAWlC,CAAA;IAED,wCAAwC;IACxC,SAAgB,gBAAgB,CAAC,MAAc,EAAE,aAAqB,EAAE,YAAoB,EAAE,OAAmB,EAAE,KAAa,EAAE,QAAiB,EAAE,IAAe,EAAE,SAAwC;QAC5M,OAAO;YACL,OAAO;YACP,aAAa;YACb,IAAI;YACJ,EAAE,EAAE,MAAM;YACV,YAAY;YACZ,KAAK;YACL,QAAQ;YACR,GAAG,SAAS;SACb,CAAC;IACJ,CAAC;IAXe,uCAAgB,mBAW/B,CAAA;AACH,CAAC,EA5BgB,sBAAsB,KAAtB,sBAAsB,QA4BtC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Backstage\r\n */\r\n\r\nimport { IconSpec } from \"@itwin/core-react\";\r\nimport { BackstageActionItem, BackstageStageLauncher } from \"./BackstageItem\";\r\n\r\n/** Utilities for creating and maintaining backstage items\r\n * @beta\r\n */\r\nexport namespace BackstageItemUtilities {\r\n  /** Creates a stage launcher backstage item. */\r\n  export function createStageLauncher(frontstageId: string, groupPriority: number, itemPriority: number, label: string, subtitle?: string, icon?: IconSpec, overrides?: Partial<BackstageStageLauncher>): BackstageStageLauncher {\r\n    return {\r\n      groupPriority,\r\n      icon,\r\n      id: frontstageId,\r\n      itemPriority,\r\n      label,\r\n      stageId: frontstageId,\r\n      subtitle,\r\n      ...overrides,\r\n    };\r\n  }\r\n\r\n  /** Creates an action backstage item. */\r\n  export function createActionItem(itemId: string, groupPriority: number, itemPriority: number, execute: () => void, label: string, subtitle?: string, icon?: IconSpec, overrides?: Partial<BackstageActionItem>): BackstageActionItem {\r\n    return {\r\n      execute,\r\n      groupPriority,\r\n      icon,\r\n      id: itemId,\r\n      itemPriority,\r\n      label,\r\n      subtitle,\r\n      ...overrides,\r\n    };\r\n  }\r\n}\r\n"]}

package/lib/esm/appui-react/backstage/BackstageItemsManager.d.ts

@@ -0,0 +1,39 @@
+/** @packageDocumentation
+ * @module Backstage
+ */
+import { BeEvent } from "@itwin/core-bentley";
+import { BackstageItem } from "./BackstageItem";
+/** Arguments of [[BackstageItemsManager.onChanged]] event.
+ * @internal
+ */
+export interface BackstageItemsChangedArgs {
+    readonly items: ReadonlyArray<BackstageItem>;
+}
+/**
+ * Controls backstage items.
+ * @internal
+ */
+export declare class BackstageItemsManager {
+    private _items;
+    constructor(items?: ReadonlyArray<BackstageItem>);
+    private loadItemsInternal;
+    /** load items but do not fire onItemsChanged
+     * @internal
+     */
+    loadItems(items: ReadonlyArray<BackstageItem>): void;
+    /** Event raised when backstage items are changed.
+     * @internal
+     */
+    readonly onItemsChanged: BeEvent<(args: BackstageItemsChangedArgs) => void>;
+    get items(): ReadonlyArray<BackstageItem>;
+    set items(items: ReadonlyArray<BackstageItem>);
+    /** @internal */
+    add(itemOrItems: BackstageItem | ReadonlyArray<BackstageItem>): void;
+    /** @internal */
+    remove(itemIdOrItemIds: BackstageItem["id"] | ReadonlyArray<BackstageItem["id"]>): void;
+    /** @internal */
+    static getSyncIdsOfInterest(items: readonly BackstageItem[]): string[];
+    private internalRefreshAffectedItems;
+    refreshAffectedItems(eventIds: Set<string>): void;
+}
+//# sourceMappingURL=BackstageItemsManager.d.ts.map

package/lib/esm/appui-react/backstage/BackstageItemsManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BackstageItemsManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItemsManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC;CAC9C;AAED;;;GAGG;AACH,qBAAa,qBAAqB;IAChC,OAAO,CAAC,MAAM,CAAoC;gBAEtC,KAAK,CAAC,EAAE,aAAa,CAAC,aAAa,CAAC;IAMhD,OAAO,CAAC,iBAAiB;IAiBzB;;OAEG;IACI,SAAS,CAAC,KAAK,EAAE,aAAa,CAAC,aAAa,CAAC;IAIpD;;OAEG;IACH,SAAgB,cAAc,iBAAsB,yBAAyB,KAAK,IAAI,EAAI;IAE1F,IAAW,KAAK,IAAI,aAAa,CAAC,aAAa,CAAC,CAE/C;IAED,IAAW,KAAK,CAAC,KAAK,EAAE,aAAa,CAAC,aAAa,CAAC,EAInD;IAED,gBAAgB;IACT,GAAG,CAAC,WAAW,EAAE,aAAa,GAAG,aAAa,CAAC,aAAa,CAAC;IAiBpE,gBAAgB;IACT,MAAM,CAAC,eAAe,EAAE,aAAa,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAOvF,gBAAgB;WACF,oBAAoB,CAAC,KAAK,EAAE,SAAS,aAAa,EAAE,GAAG,MAAM,EAAE;IAc7E,OAAO,CAAC,4BAA4B;IA6B7B,oBAAoB,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC;CAWlD"}

package/lib/esm/appui-react/backstage/BackstageItemsManager.js

@@ -0,0 +1,126 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Backstage
+ */
+import { ConditionalBooleanValue, ConditionalStringValue } from "@itwin/appui-abstract";
+import { BeEvent } from "@itwin/core-bentley";
+/**
+ * Controls backstage items.
+ * @internal
+ */
+export class BackstageItemsManager {
+    constructor(items) {
+        this._items = [];
+        /** Event raised when backstage items are changed.
+         * @internal
+         */
+        this.onItemsChanged = new BeEvent();
+        // istanbul ignore else
+        if (items)
+            this.loadItemsInternal(items, true, false);
+    }
+    loadItemsInternal(items, processConditions, sendItemChanged) {
+        if (processConditions && items) {
+            const eventIds = BackstageItemsManager.getSyncIdsOfInterest(items);
+            if (0 !== eventIds.length) {
+                const { itemsUpdated, updatedItems } = this.internalRefreshAffectedItems(items, new Set(eventIds));
+                // istanbul ignore else
+                if (itemsUpdated)
+                    items = updatedItems;
+            }
+        }
+        this._items = items;
+        if (sendItemChanged)
+            this.onItemsChanged.raiseEvent({ items });
+    }
+    /** load items but do not fire onItemsChanged
+     * @internal
+     */
+    loadItems(items) {
+        this.loadItemsInternal(items, true, false);
+    }
+    get items() {
+        return this._items;
+    }
+    set items(items) {
+        // istanbul ignore else
+        if (items !== this._items)
+            this.loadItemsInternal(items, true, true);
+    }
+    /** @internal */
+    add(itemOrItems) {
+        let itemsToAdd;
+        if (!Array.isArray(itemOrItems))
+            itemsToAdd = [itemOrItems];
+        else {
+            itemsToAdd = itemOrItems.filter((itemToAdd, index) => itemOrItems.findIndex((item) => item.id === itemToAdd.id) === index);
+        }
+        itemsToAdd = itemsToAdd.filter((itemToAdd) => this._items.find((item) => item.id === itemToAdd.id) === undefined);
+        if (itemsToAdd.length === 0)
+            return;
+        const items = [
+            ...this._items,
+            ...itemsToAdd,
+        ];
+        this.items = items;
+    }
+    /** @internal */
+    remove(itemIdOrItemIds) {
+        const items = this._items.filter((item) => {
+            return Array.isArray(itemIdOrItemIds) ? !itemIdOrItemIds.find((itemId) => itemId === item.id) : item.id !== itemIdOrItemIds;
+        });
+        this.items = items;
+    }
+    /** @internal */
+    static getSyncIdsOfInterest(items) {
+        const eventIds = new Set();
+        items.forEach((item) => {
+            for (const [, entry] of Object.entries(item)) {
+                if (entry instanceof ConditionalBooleanValue) {
+                    entry.syncEventIds.forEach((eventId) => eventIds.add(eventId.toLowerCase()));
+                }
+                else /* istanbul ignore else */ if (entry instanceof ConditionalStringValue) {
+                    entry.syncEventIds.forEach((eventId) => eventIds.add(eventId.toLowerCase()));
+                }
+            }
+        });
+        return [...eventIds.values()];
+    }
+    internalRefreshAffectedItems(items, eventIds) {
+        // istanbul ignore next
+        if (0 === eventIds.size)
+            return { itemsUpdated: false, updatedItems: [] };
+        let updateRequired = false;
+        const newItems = [];
+        for (const item of items) {
+            const updatedItem = { ...item };
+            for (const [, entry] of Object.entries(updatedItem)) {
+                if (entry instanceof ConditionalBooleanValue) {
+                    // istanbul ignore else
+                    if (ConditionalBooleanValue.refreshValue(entry, eventIds))
+                        updateRequired = true;
+                }
+                else /* istanbul ignore else */ if (entry instanceof ConditionalStringValue) {
+                    // istanbul ignore else
+                    if (ConditionalStringValue.refreshValue(entry, eventIds))
+                        updateRequired = true;
+                }
+            }
+            newItems.push(updatedItem);
+        }
+        return { itemsUpdated: updateRequired, updatedItems: newItems };
+    }
+    refreshAffectedItems(eventIds) {
+        // istanbul ignore next
+        if (0 === eventIds.size)
+            return;
+        const { itemsUpdated, updatedItems } = this.internalRefreshAffectedItems(this.items, eventIds);
+        // istanbul ignore else
+        if (itemsUpdated)
+            this.loadItemsInternal(updatedItems, false, true);
+    }
+}
+//# sourceMappingURL=BackstageItemsManager.js.map

package/lib/esm/appui-react/backstage/BackstageItemsManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BackstageItemsManager.js","sourceRoot":"","sources":["../../../../src/appui-react/backstage/BackstageItemsManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,uBAAuB,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AACxF,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAU9C;;;GAGG;AACH,MAAM,OAAO,qBAAqB;IAGhC,YAAY,KAAoC;QAFxC,WAAM,GAAiC,EAAE,CAAC;QAgClD;;WAEG;QACa,mBAAc,GAAG,IAAI,OAAO,EAA6C,CAAC;QAhCxF,uBAAuB;QACvB,IAAI,KAAK;YACP,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAC/C,CAAC;IAEO,iBAAiB,CAAC,KAAmC,EAAE,iBAA0B,EAAE,eAAwB;QACjH,IAAI,iBAAiB,IAAI,KAAK,EAAE;YAC9B,MAAM,QAAQ,GAAG,qBAAqB,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;YACnE,IAAI,CAAC,KAAK,QAAQ,CAAC,MAAM,EAAE;gBACzB,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,4BAA4B,CAAC,KAAK,EAAE,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAEnG,uBAAuB;gBACvB,IAAI,YAAY;oBACd,KAAK,GAAG,YAAY,CAAC;aACxB;SACF;QAED,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,eAAe;YACjB,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,KAAmC;QAClD,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;IAOD,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAW,KAAK,CAAC,KAAmC;QAClD,uBAAuB;QACvB,IAAI,KAAK,KAAK,IAAI,CAAC,MAAM;YACvB,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC9C,CAAC;IAED,gBAAgB;IACT,GAAG,CAAC,WAAyD;QAClE,IAAI,UAAU,CAAC;QACf,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC;YAC7B,UAAU,GAAG,CAAC,WAAW,CAAC,CAAC;aACxB;YACH,UAAU,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,SAAS,CAAC,EAAE,CAAC,KAAK,KAAK,CAAC,CAAC;SAC5H;QACD,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,SAAS,CAAC,EAAE,CAAC,KAAK,SAAS,CAAC,CAAC;QAClH,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YACzB,OAAO;QACT,MAAM,KAAK,GAAG;YACZ,GAAG,IAAI,CAAC,MAAM;YACd,GAAG,UAAU;SACd,CAAC;QACF,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,eAAyE;QACrF,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;YACxC,OAAO,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,eAAe,CAAC;QAC9H,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,oBAAoB,CAAC,KAA+B;QAChE,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;QACnC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACrB,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;gBAC5C,IAAI,KAAK,YAAY,uBAAuB,EAAE;oBAC5C,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,OAAe,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;iBACtF;qBAAM,0BAA0B,CAAC,IAAI,KAAK,YAAY,sBAAsB,EAAE;oBAC7E,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,OAAe,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;iBACtF;aACF;QACH,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAChC,CAAC;IAEO,4BAA4B,CAAC,KAA+B,EAAE,QAAqB;QACzF,uBAAuB;QACvB,IAAI,CAAC,KAAK,QAAQ,CAAC,IAAI;YACrB,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;QAEnD,IAAI,cAAc,GAAG,KAAK,CAAC;QAE3B,MAAM,QAAQ,GAAoB,EAAE,CAAC;QACrC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,MAAM,WAAW,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;YAEhC,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;gBACnD,IAAI,KAAK,YAAY,uBAAuB,EAAE;oBAC5C,uBAAuB;oBACvB,IAAI,uBAAuB,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,CAAC;wBACvD,cAAc,GAAG,IAAI,CAAC;iBACzB;qBAAM,0BAA0B,CAAC,IAAI,KAAK,YAAY,sBAAsB,EAAE;oBAC7E,uBAAuB;oBACvB,IAAI,sBAAsB,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,CAAC;wBACtD,cAAc,GAAG,IAAI,CAAC;iBACzB;aACF;YAED,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SAC5B;QAED,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC;IAClE,CAAC;IAEM,oBAAoB,CAAC,QAAqB;QAC/C,uBAAuB;QACvB,IAAI,CAAC,KAAK,QAAQ,CAAC,IAAI;YACrB,OAAO;QAET,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAE/F,uBAAuB;QACvB,IAAI,YAAY;YACd,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACtD,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Backstage\r\n */\r\n\r\nimport { ConditionalBooleanValue, ConditionalStringValue } from \"@itwin/appui-abstract\";\r\nimport { BeEvent } from \"@itwin/core-bentley\";\r\nimport { BackstageItem } from \"./BackstageItem\";\r\n\r\n/** Arguments of [[BackstageItemsManager.onChanged]] event.\r\n * @internal\r\n */\r\nexport interface BackstageItemsChangedArgs {\r\n  readonly items: ReadonlyArray<BackstageItem>;\r\n}\r\n\r\n/**\r\n * Controls backstage items.\r\n * @internal\r\n */\r\nexport class BackstageItemsManager {\r\n  private _items: ReadonlyArray<BackstageItem> = [];\r\n\r\n  constructor(items?: ReadonlyArray<BackstageItem>) {\r\n    // istanbul ignore else\r\n    if (items)\r\n      this.loadItemsInternal(items, true, false);\r\n  }\r\n\r\n  private loadItemsInternal(items: ReadonlyArray<BackstageItem>, processConditions: boolean, sendItemChanged: boolean) {\r\n    if (processConditions && items) {\r\n      const eventIds = BackstageItemsManager.getSyncIdsOfInterest(items);\r\n      if (0 !== eventIds.length) {\r\n        const { itemsUpdated, updatedItems } = this.internalRefreshAffectedItems(items, new Set(eventIds));\r\n\r\n        // istanbul ignore else\r\n        if (itemsUpdated)\r\n          items = updatedItems;\r\n      }\r\n    }\r\n\r\n    this._items = items;\r\n    if (sendItemChanged)\r\n      this.onItemsChanged.raiseEvent({ items });\r\n  }\r\n\r\n  /** load items but do not fire onItemsChanged\r\n   * @internal\r\n   */\r\n  public loadItems(items: ReadonlyArray<BackstageItem>) {\r\n    this.loadItemsInternal(items, true, false);\r\n  }\r\n\r\n  /** Event raised when backstage items are changed.\r\n   * @internal\r\n   */\r\n  public readonly onItemsChanged = new BeEvent<(args: BackstageItemsChangedArgs) => void>();\r\n\r\n  public get items(): ReadonlyArray<BackstageItem> {\r\n    return this._items;\r\n  }\r\n\r\n  public set items(items: ReadonlyArray<BackstageItem>) {\r\n    // istanbul ignore else\r\n    if (items !== this._items)\r\n      this.loadItemsInternal(items, true, true);\r\n  }\r\n\r\n  /** @internal */\r\n  public add(itemOrItems: BackstageItem | ReadonlyArray<BackstageItem>) {\r\n    let itemsToAdd;\r\n    if (!Array.isArray(itemOrItems))\r\n      itemsToAdd = [itemOrItems];\r\n    else {\r\n      itemsToAdd = itemOrItems.filter((itemToAdd, index) => itemOrItems.findIndex((item) => item.id === itemToAdd.id) === index);\r\n    }\r\n    itemsToAdd = itemsToAdd.filter((itemToAdd) => this._items.find((item) => item.id === itemToAdd.id) === undefined);\r\n    if (itemsToAdd.length === 0)\r\n      return;\r\n    const items = [\r\n      ...this._items,\r\n      ...itemsToAdd,\r\n    ];\r\n    this.items = items;\r\n  }\r\n\r\n  /** @internal */\r\n  public remove(itemIdOrItemIds: BackstageItem[\"id\"] | ReadonlyArray<BackstageItem[\"id\"]>) {\r\n    const items = this._items.filter((item) => {\r\n      return Array.isArray(itemIdOrItemIds) ? !itemIdOrItemIds.find((itemId) => itemId === item.id) : item.id !== itemIdOrItemIds;\r\n    });\r\n    this.items = items;\r\n  }\r\n\r\n  /** @internal */\r\n  public static getSyncIdsOfInterest(items: readonly BackstageItem[]): string[] {\r\n    const eventIds = new Set<string>();\r\n    items.forEach((item) => {\r\n      for (const [, entry] of Object.entries(item)) {\r\n        if (entry instanceof ConditionalBooleanValue) {\r\n          entry.syncEventIds.forEach((eventId: string) => eventIds.add(eventId.toLowerCase()));\r\n        } else /* istanbul ignore else */ if (entry instanceof ConditionalStringValue) {\r\n          entry.syncEventIds.forEach((eventId: string) => eventIds.add(eventId.toLowerCase()));\r\n        }\r\n      }\r\n    });\r\n    return [...eventIds.values()];\r\n  }\r\n\r\n  private internalRefreshAffectedItems(items: readonly BackstageItem[], eventIds: Set<string>): { itemsUpdated: boolean, updatedItems: BackstageItem[] } {\r\n    // istanbul ignore next\r\n    if (0 === eventIds.size)\r\n      return { itemsUpdated: false, updatedItems: [] };\r\n\r\n    let updateRequired = false;\r\n\r\n    const newItems: BackstageItem[] = [];\r\n    for (const item of items) {\r\n      const updatedItem = { ...item };\r\n\r\n      for (const [, entry] of Object.entries(updatedItem)) {\r\n        if (entry instanceof ConditionalBooleanValue) {\r\n          // istanbul ignore else\r\n          if (ConditionalBooleanValue.refreshValue(entry, eventIds))\r\n            updateRequired = true;\r\n        } else /* istanbul ignore else */ if (entry instanceof ConditionalStringValue) {\r\n          // istanbul ignore else\r\n          if (ConditionalStringValue.refreshValue(entry, eventIds))\r\n            updateRequired = true;\r\n        }\r\n      }\r\n\r\n      newItems.push(updatedItem);\r\n    }\r\n\r\n    return { itemsUpdated: updateRequired, updatedItems: newItems };\r\n  }\r\n\r\n  public refreshAffectedItems(eventIds: Set<string>) {\r\n    // istanbul ignore next\r\n    if (0 === eventIds.size)\r\n      return;\r\n\r\n    const { itemsUpdated, updatedItems } = this.internalRefreshAffectedItems(this.items, eventIds);\r\n\r\n    // istanbul ignore else\r\n    if (itemsUpdated)\r\n      this.loadItemsInternal(updatedItems, false, true);\r\n  }\r\n}\r\n"]}

package/lib/esm/appui-react/backstage/BackstageManager.d.ts

@@ -1,36 +1,36 @@
-/** @packageDocumentation
- * @module Backstage
- */
-import { IconSpec } from "@itwin/core-react";
-import { BackstageToggledArgs, FrameworkBackstage } from "../framework/FrameworkBackstage";
-import { InternalBackstageManager } from "./InternalBackstageManager";
-/** Controls backstage.
- * @public
- */
-export declare class BackstageManager {
-    private internal;
-    /**
-     * Override internal implementation for a mock
-     * @internal For tests only.
-     */
-    mockInternal(internal: InternalBackstageManager): void;
-    /** Event raised when backstage is opened or closed. */
-    get onToggled(): import("@itwin/core-bentley").BeEvent<(args: BackstageToggledArgs) => void>;
-    get isOpen(): boolean;
-    open(): void;
-    close(): void;
-    toggle(): void;
-    getBackstageToggleCommand(overrideIconSpec?: IconSpec): import("../shared/CommandItemDef").CommandItemDef;
-    /** Get CommandItemDef that will toggle display of Backstage and allow iconSpec to be overridden
-    */
-    static getBackstageToggleCommand(overrideIconSpec?: IconSpec): import("../shared/CommandItemDef").CommandItemDef;
-}
-/** Hook that returns isOpen flag of the backstage.
- * @public
- */
-export declare const useIsBackstageOpen: (manager: FrameworkBackstage) => boolean;
-/** Hook that returns backstage manager.
- * @public
- */
-export declare const useBackstageManager: () => FrameworkBackstage;
+/** @packageDocumentation
+ * @module Backstage
+ */
+import { IconSpec } from "@itwin/core-react";
+import { BackstageToggledArgs, FrameworkBackstage } from "../framework/FrameworkBackstage";
+import { InternalBackstageManager } from "./InternalBackstageManager";
+/** Controls backstage.
+ * @public
+ */
+export declare class BackstageManager {
+    private internal;
+    /**
+     * Override internal implementation for a mock
+     * @internal For tests only.
+     */
+    mockInternal(internal: InternalBackstageManager): void;
+    /** Event raised when backstage is opened or closed. */
+    get onToggled(): import("@itwin/core-bentley").BeEvent<(args: BackstageToggledArgs) => void>;
+    get isOpen(): boolean;
+    open(): void;
+    close(): void;
+    toggle(): void;
+    getBackstageToggleCommand(overrideIconSpec?: IconSpec): import("../shared/CommandItemDef").CommandItemDef;
+    /** Get CommandItemDef that will toggle display of Backstage and allow iconSpec to be overridden
+    */
+    static getBackstageToggleCommand(overrideIconSpec?: IconSpec): import("../shared/CommandItemDef").CommandItemDef;
+}
+/** Hook that returns isOpen flag of the backstage.
+ * @public
+ */
+export declare const useIsBackstageOpen: (manager: FrameworkBackstage) => boolean;
+/** Hook that returns backstage manager.
+ * @public
+ */
+export declare const useBackstageManager: () => FrameworkBackstage;
 //# sourceMappingURL=BackstageManager.d.ts.map