@itwin/appui-abstract 4.1.0-dev.6 → 4.1.0-dev.8

package/lib/esm/appui-abstract/UiItemsManager.js

@@ -0,0 +1,191 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/* eslint-disable deprecation/deprecation */
+/** @packageDocumentation
+ * @module UiItemsProvider
+ */
+import { BeEvent, Logger } from "@itwin/core-bentley";
+import { loggerCategory } from "./utils/misc";
+/** Action taken by the application on item provided by a UiItemsProvider
+ * @public @deprecated in 3.2. This was only used by the previously removed UiItemsArbiter.
+ */
+export var UiItemsApplicationAction;
+(function (UiItemsApplicationAction) {
+    /** Allow the change to the item */
+    UiItemsApplicationAction[UiItemsApplicationAction["Allow"] = 0] = "Allow";
+    /** Disallow the change to the item */
+    UiItemsApplicationAction[UiItemsApplicationAction["Disallow"] = 1] = "Disallow";
+    /** Update the item during the change */
+    UiItemsApplicationAction[UiItemsApplicationAction["Update"] = 2] = "Update";
+})(UiItemsApplicationAction || (UiItemsApplicationAction = {}));
+/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.
+ * @deprecated in 3.6. Use [UiItemsManager]($appui-react) instead.
+ * @public
+ */
+class UiItemsManager {
+    /** For use in unit testing
+     * @internal */
+    static clearAllProviders() {
+        UiItemsManager._registeredUiItemsProviders.clear();
+    }
+    /** Return number of registered UiProvider. */
+    static get registeredProviderIds() {
+        const ids = [...UiItemsManager._registeredUiItemsProviders.keys()];
+        return ids;
+    }
+    /** Return true if there is any registered UiProvider. */
+    static get hasRegisteredProviders() {
+        return this._registeredUiItemsProviders.size > 0;
+    }
+    /**
+     * Retrieves a previously loaded UiItemsProvider.
+     * @param providerId id of the UiItemsProvider to get
+     */
+    static getUiItemsProvider(providerId) {
+        return UiItemsManager._registeredUiItemsProviders.get(providerId)?.provider;
+    }
+    static sendRegisteredEvent(ev) {
+        UiItemsManager.onUiProviderRegisteredEvent.raiseEvent(ev);
+    }
+    /**
+     * Registers a UiItemsProvider with the UiItemsManager.
+     * @param uiProvider the UI items provider to register.
+     */
+    static register(uiProvider, overrides) {
+        const providerId = overrides?.providerId ?? uiProvider.id;
+        if (UiItemsManager.getUiItemsProvider(providerId)) {
+            Logger.logInfo(loggerCategory(this), `UiItemsProvider (${providerId}) is already loaded`);
+        }
+        else {
+            UiItemsManager._registeredUiItemsProviders.set(providerId, { provider: uiProvider, overrides });
+            Logger.logInfo(loggerCategory(this), `UiItemsProvider ${uiProvider.id} registered as ${providerId} `);
+            UiItemsManager.sendRegisteredEvent({ providerId });
+        }
+    }
+    /** Remove a specific UiItemsProvider from the list of available providers. */
+    static unregister(uiProviderId) {
+        const provider = UiItemsManager.getUiItemsProvider(uiProviderId);
+        if (!provider)
+            return;
+        provider.onUnregister && provider.onUnregister();
+        UiItemsManager._registeredUiItemsProviders.delete(uiProviderId);
+        Logger.logInfo(loggerCategory(this), `UiItemsProvider (${uiProviderId}) unloaded`);
+        // trigger a refresh of the ui
+        UiItemsManager.sendRegisteredEvent({ providerId: uiProviderId });
+    }
+    static allowItemsFromProvider(entry, stageId, stageUsage) {
+        // istanbul ignore else
+        const overrides = entry.overrides;
+        if (undefined !== stageId && overrides?.stageIds && !(overrides.stageIds.some((value) => value === stageId)))
+            return false;
+        if (undefined !== stageUsage && overrides?.stageUsages && !(overrides.stageUsages.some((value) => value === stageUsage)))
+            return false;
+        return true;
+    }
+    /** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute
+     * an action or specify a registered ToolId into toolbar.
+     * @param stageId a string identifier the active stage.
+     * @param stageUsage the StageUsage of the active stage.
+     * @param toolbarUsage usage of the toolbar
+     * @param toolbarOrientation orientation of the toolbar
+     * @returns an array of error messages. The array will be empty if the load is successful, otherwise it is a list of one or more problems.
+     */
+    static getToolbarButtonItems(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData) {
+        const buttonItems = [];
+        if (0 === UiItemsManager._registeredUiItemsProviders.size)
+            return buttonItems;
+        UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
+            const uiProvider = entry.provider;
+            const providerId = entry.overrides?.providerId ?? uiProvider.id;
+            // istanbul ignore else
+            if (uiProvider.provideToolbarButtonItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {
+                uiProvider.provideToolbarButtonItems(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData)
+                    .forEach((spec) => {
+                    // ignore duplicate ids
+                    if (-1 === buttonItems.findIndex((existingItem) => spec.id === existingItem.id))
+                        buttonItems.push({ ...spec, providerId });
+                });
+            }
+        });
+        return buttonItems;
+    }
+    /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields
+     * @param stageId a string identifier the active stage.
+     * @param stageUsage the StageUsage of the active stage.
+     * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.
+     */
+    static getStatusBarItems(stageId, stageUsage, stageAppData) {
+        const statusBarItems = [];
+        if (0 === UiItemsManager._registeredUiItemsProviders.size)
+            return statusBarItems;
+        UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
+            const uiProvider = entry.provider;
+            const providerId = entry.overrides?.providerId ?? uiProvider.id;
+            // istanbul ignore else
+            if (uiProvider.provideStatusBarItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {
+                uiProvider.provideStatusBarItems(stageId, stageUsage, stageAppData)
+                    .forEach((item) => {
+                    // ignore duplicate ids
+                    if (-1 === statusBarItems.findIndex((existingItem) => item.id === existingItem.id))
+                        statusBarItems.push({ ...item, providerId });
+                });
+            }
+        });
+        return statusBarItems;
+    }
+    /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields
+     * @returns An array of BackstageItem that will be used to create controls for the backstage menu.
+     */
+    static getBackstageItems() {
+        const backstageItems = [];
+        if (0 === UiItemsManager._registeredUiItemsProviders.size)
+            return backstageItems;
+        UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
+            const uiProvider = entry.provider;
+            const providerId = entry.overrides?.providerId ?? uiProvider.id;
+            // istanbul ignore else
+            if (uiProvider.provideBackstageItems) { // Note: We do not call this.allowItemsFromProvider here as backstage items
+                uiProvider.provideBackstageItems() //       should not be considered stage specific. If they need to be hidden
+                    .forEach((item) => {
+                    // ignore duplicate ids
+                    if (-1 === backstageItems.findIndex((existingItem) => item.id === existingItem.id))
+                        backstageItems.push({ ...item, providerId });
+                });
+            }
+        });
+        return backstageItems;
+    }
+    /** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets
+     * @param stageId a string identifier the active stage.
+     * @param stageUsage the StageUsage of the active stage.
+     * @param location the location within the stage.
+     * @param section the section within location.
+     * @returns An array of AbstractWidgetProps that will be used to create widgets.
+     */
+    static getWidgets(stageId, stageUsage, location, section, zoneLocation, stageAppData) {
+        const widgets = [];
+        if (0 === UiItemsManager._registeredUiItemsProviders.size)
+            return widgets;
+        UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
+            const uiProvider = entry.provider;
+            const providerId = entry.overrides?.providerId ?? uiProvider.id;
+            // istanbul ignore else
+            if (uiProvider.provideWidgets && this.allowItemsFromProvider(entry, stageId, stageUsage)) {
+                uiProvider.provideWidgets(stageId, stageUsage, location, section, zoneLocation, stageAppData)
+                    .forEach((widget) => {
+                    // ignore duplicate ids
+                    if (-1 === widgets.findIndex((existingItem) => widget.id === existingItem.id))
+                        widgets.push({ ...widget, providerId });
+                });
+            }
+        });
+        return widgets;
+    }
+}
+UiItemsManager._registeredUiItemsProviders = new Map();
+/** Event raised any time a UiProvider is registered or unregistered. */
+UiItemsManager.onUiProviderRegisteredEvent = new BeEvent();
+export { UiItemsManager };
+//# sourceMappingURL=UiItemsManager.js.map

package/lib/esm/appui-abstract/UiItemsManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UiItemsManager.js","sourceRoot":"","sources":["../../../src/appui-abstract/UiItemsManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,EAAgB,MAAM,qBAAqB,CAAC;AAMpE,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAG9C;;GAEG;AACH,MAAM,CAAN,IAAY,wBAOX;AAPD,WAAY,wBAAwB;IAClC,mCAAmC;IACnC,yEAAK,CAAA;IACL,sCAAsC;IACtC,+EAAQ,CAAA;IACR,wCAAwC;IACxC,2EAAM,CAAA;AACR,CAAC,EAPW,wBAAwB,KAAxB,wBAAwB,QAOnC;AA+CD;;;GAGG;AACH,MAAa,cAAc;IAGzB;mBACe;IACR,MAAM,CAAC,iBAAiB;QAC7B,cAAc,CAAC,2BAA2B,CAAC,KAAK,EAAE,CAAC;IACrD,CAAC;IAKD,8CAA8C;IACvC,MAAM,KAAK,qBAAqB;QACrC,MAAM,GAAG,GAAG,CAAC,GAAG,cAAc,CAAC,2BAA2B,CAAC,IAAI,EAAE,CAAC,CAAC;QACnE,OAAO,GAAG,CAAC;IACb,CAAC;IAED,yDAAyD;IAClD,MAAM,KAAK,sBAAsB;QACtC,OAAO,IAAI,CAAC,2BAA2B,CAAC,IAAI,GAAG,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,kBAAkB,CAAC,UAAkB;QACjD,OAAO,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC;IAC9E,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,EAAqC;QACtE,cAAc,CAAC,2BAA2B,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAQ,CAAC,UAA2B,EAAE,SAAmC;QACrF,MAAM,UAAU,GAAG,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;QAE1D,IAAI,cAAc,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE;YACjD,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,oBAAoB,UAAU,qBAAqB,CAAC,CAAC;SAC3F;aAAM;YACL,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;YAChG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,mBAAmB,UAAU,CAAC,EAAE,kBAAkB,UAAU,GAAG,CAAC,CAAC;YAEtG,cAAc,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAuC,CAAC,CAAC;SACzF;IACH,CAAC;IAED,8EAA8E;IACvE,MAAM,CAAC,UAAU,CAAC,YAAoB;QAC3C,MAAM,QAAQ,GAAG,cAAc,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QACjE,IAAI,CAAC,QAAQ;YACX,OAAO;QAET,QAAQ,CAAC,YAAY,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC;QAEjD,cAAc,CAAC,2BAA2B,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAChE,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,oBAAoB,YAAY,YAAY,CAAC,CAAC;QAEnF,8BAA8B;QAC9B,cAAc,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,YAAY,EAAuC,CAAC,CAAC;IACxG,CAAC;IAEO,MAAM,CAAC,sBAAsB,CAAC,KAA0B,EAAE,OAAgB,EAAE,UAAmB;QACrG,uBAAuB;QACvB,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QAClC,IAAI,SAAS,KAAK,OAAO,IAAI,SAAS,EAAE,QAAQ,IAAI,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,KAAK,OAAO,CAAC,CAAC;YAClH,OAAO,KAAK,CAAC;QACf,IAAI,SAAS,KAAK,UAAU,IAAI,SAAS,EAAE,WAAW,IAAI,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,KAAK,UAAU,CAAC,CAAC;YAC9H,OAAO,KAAK,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,qBAAqB,CAAC,OAAe,EAAE,UAAkB,EAAE,YAA0B,EACjG,kBAAsC,EAAE,YAAkB;QAC1D,MAAM,WAAW,GAAwB,EAAE,CAAC;QAC5C,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,WAAW,CAAC;QAErB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAChE,uBAAuB;YACvB,IAAI,UAAU,CAAC,yBAAyB,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE;gBACnG,UAAU,CAAC,yBAAyB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,kBAAkB,EAAE,YAAY,CAAC;qBACtG,OAAO,CAAC,CAAC,IAAuB,EAAE,EAAE;oBACnC,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,WAAW,CAAC,SAAS,CAAC,CAAC,YAAY,EAAC,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAE;wBAC7E,WAAW,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC9C,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,OAAe,EAAE,UAAkB,EAAE,YAAkB;QACrF,MAAM,cAAc,GAA0B,EAAE,CAAC;QAEjD,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,cAAc,CAAC;QAExB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,qBAAqB,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE;gBAC/F,UAAU,CAAC,qBAAqB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,CAAC;qBAChE,OAAO,CAAC,CAAC,IAAyB,EAAE,EAAE;oBACrC,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,cAAc,CAAC,SAAS,CAAC,CAAC,YAAY,EAAC,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAE;wBAChF,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBACjD,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB;QAC7B,MAAM,cAAc,GAAoB,EAAE,CAAC;QAE3C,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,cAAc,CAAC;QAExB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,qBAAqB,EAAE,EAAE,2EAA2E;gBACjH,UAAU,CAAC,qBAAqB,EAAE,CAAI,2EAA2E;qBAC9G,OAAO,CAAC,CAAC,IAAmB,EAAE,EAAE;oBAC/B,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,cAAc,CAAC,SAAS,CAAC,CAAC,YAAY,EAAC,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAE;wBAChF,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBACjD,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QACH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,UAAU,CAAC,OAAe,EAAE,UAAkB,EAAE,QAA4B,EAAE,OAA2B,EAAE,YAAmC,EAAE,YAAkB;QAC9K,MAAM,OAAO,GAA0B,EAAE,CAAC;QAE1C,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,OAAO,CAAC;QAEjB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,cAAc,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE;gBACxF,UAAU,CAAC,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,EAAE,YAAY,CAAC;qBAC1F,OAAO,CAAC,CAAC,MAA2B,EAAE,EAAE;oBACvC,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC,YAAY,EAAC,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAE;wBAC3E,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC5C,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IACjB,CAAC;;AA9Lc,0CAA2B,GAAqC,IAAI,GAAG,EAA+B,CAAC;AAQtH,wEAAwE;AACjD,0CAA2B,GAAG,IAAI,OAAO,EAAmD,CAAC;SAVzG,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/* eslint-disable deprecation/deprecation */\r\n/** @packageDocumentation\r\n * @module UiItemsProvider\r\n */\r\n\r\nimport { BeEvent, Logger, MarkRequired } from \"@itwin/core-bentley\";\r\nimport { BackstageItem } from \"./backstage/BackstageItem\";\r\nimport { CommonStatusBarItem } from \"./statusbar/StatusBarItem\";\r\nimport { CommonToolbarItem, ToolbarOrientation, ToolbarUsage } from \"./toolbars/ToolbarItem\";\r\nimport { AbstractWidgetProps } from \"./widget/AbstractWidgetProps\";\r\nimport { AbstractZoneLocation, StagePanelLocation, StagePanelSection } from \"./widget/StagePanel\";\r\nimport { loggerCategory } from \"./utils/misc\";\r\nimport { UiItemsProvider } from \"./UiItemsProvider\";\r\n\r\n/** Action taken by the application on item provided by a UiItemsProvider\r\n * @public @deprecated in 3.2. This was only used by the previously removed UiItemsArbiter.\r\n */\r\nexport enum UiItemsApplicationAction {\r\n  /** Allow the change to the item */\r\n  Allow,\r\n  /** Disallow the change to the item */\r\n  Disallow,\r\n  /** Update the item during the change */\r\n  Update,\r\n}\r\n\r\n/** UIProvider Registered Event Args interface.\r\n * @deprecated in 3.6. Use [UiItemsProviderRegisteredEventArgs]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface UiItemProviderRegisteredEventArgs {\r\n  providerId: string;\r\n}\r\n\r\n/** UiItemProviderOverrides allows the application that registers a provider to limit when it is allowed to provide items\r\n * @deprecated in 3.6. Use [AllowedUiItemsProviderOverrides]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface AllowedUiItemProviderOverrides {\r\n  /** allows providerId to be overridden in the items manager for cases where the same provider needs to provide different content to different stages\r\n   * @beta\r\n   */\r\n  providerId?: string;\r\n  /** if specified then the current stage's Usage will be compared before allowing any items to be provided\r\n   * @beta\r\n   */\r\n  stageUsages?: string[];\r\n  /** if specified then the current stage's Id will be compared before allowing any items to be provided\r\n   * @beta\r\n  */\r\n  stageIds?: string[];\r\n}\r\n\r\n/** Allowed overrides applied to a UiItemsProvider the application that registers a provider to limit when it is allowed to provide items.\r\n * Note that if an override `providerId` is specified then either `stageIds` or `stageUsages` must be defined to limit when the provider's\r\n * items are allowed.\r\n * @deprecated in 3.6. Use [UiItemsProviderOverrides]($appui-react) instead.\r\n * @public\r\n */\r\nexport type UiItemProviderOverrides = MarkRequired<AllowedUiItemProviderOverrides, \"providerId\" | \"stageUsages\"> |\r\n  MarkRequired<AllowedUiItemProviderOverrides, \"providerId\" | \"stageIds\"> |                                 // eslint-disable-line @typescript-eslint/indent\r\n  MarkRequired<AllowedUiItemProviderOverrides, \"stageIds\"> |                                                // eslint-disable-line @typescript-eslint/indent\r\n  MarkRequired<AllowedUiItemProviderOverrides, \"stageUsages\"> |                                             // eslint-disable-line @typescript-eslint/indent\r\n  MarkRequired<AllowedUiItemProviderOverrides, \"providerId\" | \"stageUsages\" | \"stageIds\">;                  // eslint-disable-line @typescript-eslint/indent\r\n\r\n/** Interface that defines an instance of a UiItemsProvider and its application specified overrides. */\r\ninterface UiItemProviderEntry {\r\n  provider: UiItemsProvider;\r\n  overrides?: UiItemProviderOverrides;\r\n}\r\n\r\n/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.\r\n * @deprecated in 3.6. Use [UiItemsManager]($appui-react) instead.\r\n * @public\r\n */\r\nexport class UiItemsManager {\r\n  private static _registeredUiItemsProviders: Map<string, UiItemProviderEntry> = new Map<string, UiItemProviderEntry>();\r\n\r\n  /** For use in unit testing\r\n   * @internal */\r\n  public static clearAllProviders() {\r\n    UiItemsManager._registeredUiItemsProviders.clear();\r\n  }\r\n\r\n  /** Event raised any time a UiProvider is registered or unregistered. */\r\n  public static readonly onUiProviderRegisteredEvent = new BeEvent<(ev: UiItemProviderRegisteredEventArgs) => void>();\r\n\r\n  /** Return number of registered UiProvider. */\r\n  public static get registeredProviderIds() {\r\n    const ids = [...UiItemsManager._registeredUiItemsProviders.keys()];\r\n    return ids;\r\n  }\r\n\r\n  /** Return true if there is any registered UiProvider. */\r\n  public static get hasRegisteredProviders(): boolean {\r\n    return this._registeredUiItemsProviders.size > 0;\r\n  }\r\n\r\n  /**\r\n   * Retrieves a previously loaded UiItemsProvider.\r\n   * @param providerId id of the UiItemsProvider to get\r\n   */\r\n  public static getUiItemsProvider(providerId: string): UiItemsProvider | undefined {\r\n    return UiItemsManager._registeredUiItemsProviders.get(providerId)?.provider;\r\n  }\r\n\r\n  private static sendRegisteredEvent(ev: UiItemProviderRegisteredEventArgs) {\r\n    UiItemsManager.onUiProviderRegisteredEvent.raiseEvent(ev);\r\n  }\r\n\r\n  /**\r\n   * Registers a UiItemsProvider with the UiItemsManager.\r\n   * @param uiProvider the UI items provider to register.\r\n   */\r\n  public static register(uiProvider: UiItemsProvider, overrides?: UiItemProviderOverrides): void {\r\n    const providerId = overrides?.providerId ?? uiProvider.id;\r\n\r\n    if (UiItemsManager.getUiItemsProvider(providerId)) {\r\n      Logger.logInfo(loggerCategory(this), `UiItemsProvider (${providerId}) is already loaded`);\r\n    } else {\r\n      UiItemsManager._registeredUiItemsProviders.set(providerId, { provider: uiProvider, overrides });\r\n      Logger.logInfo(loggerCategory(this), `UiItemsProvider ${uiProvider.id} registered as ${providerId} `);\r\n\r\n      UiItemsManager.sendRegisteredEvent({ providerId } as UiItemProviderRegisteredEventArgs);\r\n    }\r\n  }\r\n\r\n  /** Remove a specific UiItemsProvider from the list of available providers. */\r\n  public static unregister(uiProviderId: string): void {\r\n    const provider = UiItemsManager.getUiItemsProvider(uiProviderId);\r\n    if (!provider)\r\n      return;\r\n\r\n    provider.onUnregister && provider.onUnregister();\r\n\r\n    UiItemsManager._registeredUiItemsProviders.delete(uiProviderId);\r\n    Logger.logInfo(loggerCategory(this), `UiItemsProvider (${uiProviderId}) unloaded`);\r\n\r\n    // trigger a refresh of the ui\r\n    UiItemsManager.sendRegisteredEvent({ providerId: uiProviderId } as UiItemProviderRegisteredEventArgs);\r\n  }\r\n\r\n  private static allowItemsFromProvider(entry: UiItemProviderEntry, stageId?: string, stageUsage?: string) {\r\n    // istanbul ignore else\r\n    const overrides = entry.overrides;\r\n    if (undefined !== stageId && overrides?.stageIds && !(overrides.stageIds.some((value: string) => value === stageId)))\r\n      return false;\r\n    if (undefined !== stageUsage && overrides?.stageUsages && !(overrides.stageUsages.some((value: string) => value === stageUsage)))\r\n      return false;\r\n    return true;\r\n  }\r\n\r\n  /** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute\r\n   * an action or specify a registered ToolId into toolbar.\r\n   * @param stageId a string identifier the active stage.\r\n   * @param stageUsage the StageUsage of the active stage.\r\n   * @param toolbarUsage usage of the toolbar\r\n   * @param toolbarOrientation orientation of the toolbar\r\n   * @returns an array of error messages. The array will be empty if the load is successful, otherwise it is a list of one or more problems.\r\n   */\r\n  public static getToolbarButtonItems(stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage,\r\n    toolbarOrientation: ToolbarOrientation, stageAppData?: any): CommonToolbarItem[] {\r\n    const buttonItems: CommonToolbarItem[] = [];\r\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\r\n      return buttonItems;\r\n\r\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\r\n      const uiProvider = entry.provider;\r\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\r\n      // istanbul ignore else\r\n      if (uiProvider.provideToolbarButtonItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\r\n        uiProvider.provideToolbarButtonItems(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData)\r\n          .forEach((spec: CommonToolbarItem) => {\r\n            // ignore duplicate ids\r\n            if (-1 === buttonItems.findIndex((existingItem)=> spec.id === existingItem.id ))\r\n              buttonItems.push({ ...spec, providerId });\r\n          });\r\n      }\r\n    });\r\n\r\n    return buttonItems;\r\n  }\r\n\r\n  /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\r\n   * @param stageId a string identifier the active stage.\r\n   * @param stageUsage the StageUsage of the active stage.\r\n   * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.\r\n   */\r\n  public static getStatusBarItems(stageId: string, stageUsage: string, stageAppData?: any): CommonStatusBarItem[] {\r\n    const statusBarItems: CommonStatusBarItem[] = [];\r\n\r\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\r\n      return statusBarItems;\r\n\r\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\r\n      const uiProvider = entry.provider;\r\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\r\n\r\n      // istanbul ignore else\r\n      if (uiProvider.provideStatusBarItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\r\n        uiProvider.provideStatusBarItems(stageId, stageUsage, stageAppData)\r\n          .forEach((item: CommonStatusBarItem) => {\r\n            // ignore duplicate ids\r\n            if (-1 === statusBarItems.findIndex((existingItem)=> item.id === existingItem.id ))\r\n              statusBarItems.push({ ...item, providerId });\r\n          });\r\n      }\r\n    });\r\n\r\n    return statusBarItems;\r\n  }\r\n\r\n  /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\r\n   * @returns An array of BackstageItem that will be used to create controls for the backstage menu.\r\n   */\r\n  public static getBackstageItems(): BackstageItem[] {\r\n    const backstageItems: BackstageItem[] = [];\r\n\r\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\r\n      return backstageItems;\r\n\r\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\r\n      const uiProvider = entry.provider;\r\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\r\n\r\n      // istanbul ignore else\r\n      if (uiProvider.provideBackstageItems) { // Note: We do not call this.allowItemsFromProvider here as backstage items\r\n        uiProvider.provideBackstageItems()    //       should not be considered stage specific. If they need to be hidden\r\n          .forEach((item: BackstageItem) => { //       the isHidden property should be set to a ConditionalBooleanValue\r\n            // ignore duplicate ids\r\n            if (-1 === backstageItems.findIndex((existingItem)=> item.id === existingItem.id ))\r\n              backstageItems.push({ ...item, providerId });\r\n          });\r\n      }\r\n    });\r\n    return backstageItems;\r\n  }\r\n\r\n  /** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets\r\n   * @param stageId a string identifier the active stage.\r\n   * @param stageUsage the StageUsage of the active stage.\r\n   * @param location the location within the stage.\r\n   * @param section the section within location.\r\n   * @returns An array of AbstractWidgetProps that will be used to create widgets.\r\n   */\r\n  public static getWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection, zoneLocation?: AbstractZoneLocation, stageAppData?: any): ReadonlyArray<AbstractWidgetProps> {\r\n    const widgets: AbstractWidgetProps[] = [];\r\n\r\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\r\n      return widgets;\r\n\r\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\r\n      const uiProvider = entry.provider;\r\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\r\n\r\n      // istanbul ignore else\r\n      if (uiProvider.provideWidgets && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\r\n        uiProvider.provideWidgets(stageId, stageUsage, location, section, zoneLocation, stageAppData)\r\n          .forEach((widget: AbstractWidgetProps) => {\r\n            // ignore duplicate ids\r\n            if (-1 === widgets.findIndex((existingItem)=> widget.id === existingItem.id ))\r\n              widgets.push({ ...widget, providerId });\r\n          });\r\n      }\r\n    });\r\n    return widgets;\r\n  }\r\n\r\n}\r\n"]}

package/lib/esm/appui-abstract/UiItemsProvider.d.ts

@@ -0,0 +1,30 @@
+/** @packageDocumentation
+ * @module UiItemsProvider
+ */
+import { BackstageItem } from "./backstage/BackstageItem";
+import { CommonStatusBarItem } from "./statusbar/StatusBarItem";
+import { CommonToolbarItem, ToolbarOrientation, ToolbarUsage } from "./toolbars/ToolbarItem";
+import { AbstractWidgetProps } from "./widget/AbstractWidgetProps";
+import { AbstractZoneLocation, StagePanelLocation, StagePanelSection } from "./widget/StagePanel";
+/** Describes interface of objects that want to provide UI component to the running IModelApp.
+ * @deprecated in 3.6. Use [UiItemsProvider]($appui-react) instead.
+ * @public
+ */
+export interface UiItemsProvider {
+    /** id of provider */
+    readonly id: string;
+    /** UiItemsManager calls following method to get items to populate specific toolbars */
+    provideToolbarButtonItems?: (stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation, stageAppData?: any) => CommonToolbarItem[];
+    /** UiItemsManager calls following method to augment base statusbar for stages that allow it. */
+    provideStatusBarItems?: (stageId: string, stageUsage: string, stageAppData?: any) => CommonStatusBarItem[];
+    /** UiItemsManager calls following method to augment backstage items. */
+    provideBackstageItems?: () => BackstageItem[];
+    /** UiItemsManager calls following method to augment Widget lists.
+     * @note Returned widgets must provide unique `AbstractWidgetProps["id"]` to correctly save/restore App layout.
+     */
+    provideWidgets?: (stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection, // eslint-disable-line deprecation/deprecation
+    zoneLocation?: AbstractZoneLocation, stageAppData?: any) => ReadonlyArray<AbstractWidgetProps>;
+    /** Function called when the provider is unregistered via `ItemsManager.unregister` to allow provider to do cleanup. */
+    onUnregister?: () => void;
+}
+//# sourceMappingURL=UiItemsProvider.d.ts.map

package/lib/esm/appui-abstract/UiItemsProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UiItemsProvider.d.ts","sourceRoot":"","sources":["../../../src/appui-abstract/UiItemsProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC7F,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAElG;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,qBAAqB;IACrB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,uFAAuF;IACvF,yBAAyB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,YAAY,CAAC,EAAE,GAAG,KAAK,iBAAiB,EAAE,CAAC;IACjL,gGAAgG;IAChG,qBAAqB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,GAAG,KAAK,mBAAmB,EAAE,CAAC;IAC3G,wEAAwE;IACxE,qBAAqB,CAAC,EAAE,MAAM,aAAa,EAAE,CAAC;IAC9C;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,iBAAiB,EAAE,8CAA8C;IAC9J,YAAY,CAAC,EAAE,oBAAoB,EAAE,YAAY,CAAC,EAAE,GAAG,KAAK,aAAa,CAAC,mBAAmB,CAAC,CAAC;IACjG,uHAAuH;IACvH,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;CAC3B"}

package/lib/esm/appui-abstract/UiItemsProvider.js

@@ -0,0 +1,9 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module UiItemsProvider
+ */
+export {};
+//# sourceMappingURL=UiItemsProvider.js.map

package/lib/esm/appui-abstract/UiItemsProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UiItemsProvider.js","sourceRoot":"","sources":["../../../src/appui-abstract/UiItemsProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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 UiItemsProvider\r\n */\r\n\r\nimport { BackstageItem } from \"./backstage/BackstageItem\";\r\nimport { CommonStatusBarItem } from \"./statusbar/StatusBarItem\";\r\nimport { CommonToolbarItem, ToolbarOrientation, ToolbarUsage } from \"./toolbars/ToolbarItem\";\r\nimport { AbstractWidgetProps } from \"./widget/AbstractWidgetProps\";\r\nimport { AbstractZoneLocation, StagePanelLocation, StagePanelSection } from \"./widget/StagePanel\";\r\n\r\n/** Describes interface of objects that want to provide UI component to the running IModelApp.\r\n * @deprecated in 3.6. Use [UiItemsProvider]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface UiItemsProvider {\r\n  /** id of provider */\r\n  readonly id: string;\r\n\r\n  /** UiItemsManager calls following method to get items to populate specific toolbars */\r\n  provideToolbarButtonItems?: (stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation, stageAppData?: any) => CommonToolbarItem[]; // eslint-disable-line deprecation/deprecation\r\n  /** UiItemsManager calls following method to augment base statusbar for stages that allow it. */\r\n  provideStatusBarItems?: (stageId: string, stageUsage: string, stageAppData?: any) => CommonStatusBarItem[]; // eslint-disable-line deprecation/deprecation\r\n  /** UiItemsManager calls following method to augment backstage items. */\r\n  provideBackstageItems?: () => BackstageItem[]; // eslint-disable-line deprecation/deprecation\r\n  /** UiItemsManager calls following method to augment Widget lists.\r\n   * @note Returned widgets must provide unique `AbstractWidgetProps[\"id\"]` to correctly save/restore App layout.\r\n   */\r\n  provideWidgets?: (stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection, // eslint-disable-line deprecation/deprecation\r\n    zoneLocation?: AbstractZoneLocation, stageAppData?: any) => ReadonlyArray<AbstractWidgetProps>; // eslint-disable-line deprecation/deprecation\r\n  /** Function called when the provider is unregistered via `ItemsManager.unregister` to allow provider to do cleanup. */\r\n  onUnregister?: () => void;\r\n}\r\n"]}

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

@@ -0,0 +1,92 @@
+/** @packageDocumentation
+ * @module Backstage
+ */
+import { BadgeType } from "../items/BadgeType";
+import { ConditionalBooleanValue } from "../items/ConditionalBooleanValue";
+import { ConditionalStringValue } from "../items/ConditionalStringValue";
+import { ProvidedItem } from "../items/ProvidedItem";
+/** Used to specify the item type added to the backstage menu.
+ * @deprecated in 3.6. Use type guards instead.
+ * @public
+ */
+export declare enum BackstageItemType {
+    /** Item that executes an action function */
+    ActionItem = 1,
+    /** Item that activate a stage. */
+    StageLauncher = 2
+}
+/** Describes the data needed to insert a button into the backstage menu.
+ * @deprecated in 3.6. Use [CommonBackstageItem]($appui-react) instead.
+ * @public
+ */
+export interface CommonBackstageItem extends ProvidedItem {
+    /** can be used by application to store miscellaneous data. */
+    applicationData?: any;
+    /** Describes badge. Renders no badge if not specified. */
+    readonly badgeType?: 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?: string | ConditionalStringValue;
+    /** 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;
+    /** optional data to be used by item implementor. */
+    readonly internalData?: Map<string, any>;
+    /** 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.
+ * @deprecated in 3.6. Use [BackstageActionItem]($appui-react) instead.
+ * @public
+ */
+export interface BackstageActionItem extends CommonBackstageItem {
+    readonly execute: () => void;
+}
+/** Describes the data needed to insert an action button into the backstage menu.
+ * @deprecated in 3.6. Use [BackstageActionItem]($appui-react) instead.
+ * @public
+ */
+export interface BackstageStageLauncher extends CommonBackstageItem {
+    readonly stageId: string;
+}
+/** Describes the data needed to insert a button into the backstage menu.
+ * @deprecated in 3.6. Use [BackstageItem]($appui-react) instead.
+ * @public
+ */
+export type BackstageItem = BackstageActionItem | BackstageStageLauncher;
+/** BackstageActionItem type guard.
+ * @deprecated in 3.6. Use [isBackstageActionItem]($appui-react) instead.
+ * @public
+ */
+export declare const isActionItem: (item: BackstageItem) => item is BackstageActionItem;
+/** BackstageStageLauncher type guard.
+ * @deprecated in 3.6. Use [isBackstageStageLauncher]($appui-react) instead.
+ * @public
+ */
+export declare const isStageLauncher: (item: BackstageItem) => item is BackstageStageLauncher;
+/** Utilities for creating and maintaining backstage items
+ * @deprecated in 3.6. Use [BackstageItemUtilities]($appui-react) instead.
+ * @public
+ */
+export declare class BackstageItemUtilities {
+    /** Creates a stage launcher backstage item */
+    static createStageLauncher: (frontstageId: string, groupPriority: number, itemPriority: number, label: string | ConditionalStringValue, subtitle?: string | ConditionalStringValue, icon?: string | ConditionalStringValue, overrides?: Partial<BackstageStageLauncher>) => BackstageStageLauncher;
+    /** Creates an action backstage item */
+    static createActionItem: (itemId: string, groupPriority: number, itemPriority: number, execute: () => void, label: string | ConditionalStringValue, subtitle?: string | ConditionalStringValue, icon?: string | ConditionalStringValue, overrides?: Partial<BackstageActionItem>) => BackstageActionItem;
+}
+//# sourceMappingURL=BackstageItem.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BackstageItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/backstage/BackstageItem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,4CAA4C;IAC5C,UAAU,IAAI;IACd,kCAAkC;IAClC,aAAa,IAAI;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,8DAA8D;IAC9D,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,0DAA0D;IAC1D,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B;;;OAGG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,qHAAqH;IACrH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,kIAAkI;IAClI,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,oDAAoD;IACpD,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACzC,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;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;IACjE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,mBAAmB,GAAG,sBAAsB,CAAC;AAEzE;;;GAGG;AACH,eAAO,MAAM,YAAY,SAAU,aAAa,gCAE/C,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,eAAe,SAAU,aAAa,mCAElD,CAAC;AAEF;;;GAGG;AACH,qBAAa,sBAAsB;IACjC,8CAA8C;IAC9C,OAAc,mBAAmB,iBACjB,MAAM,iBAAiB,MAAM,gBAAgB,MAAM,SAAS,MAAM,GAAG,sBAAsB,aAC9F,MAAM,GAAG,sBAAsB,SAAS,MAAM,GAAG,sBAAsB,cAAc,QAAQ,sBAAsB,CAAC,KAC9H,sBAAsB,CAUtB;IAEH,uCAAuC;IACvC,OAAc,gBAAgB,WACpB,MAAM,iBAAiB,MAAM,gBAAgB,MAAM,WAAW,MAAM,IAAI,SAAS,MAAM,GAAG,sBAAsB,aAC7G,MAAM,GAAG,sBAAsB,SAAS,MAAM,GAAG,sBAAsB,cAAc,QAAQ,mBAAmB,CAAC,KAC3H,mBAAmB,CAUnB;CACJ"}

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

@@ -0,0 +1,66 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+/** Used to specify the item type added to the backstage menu.
+ * @deprecated in 3.6. Use type guards instead.
+ * @public
+ */
+export var BackstageItemType;
+(function (BackstageItemType) {
+    /** Item that executes an action function */
+    BackstageItemType[BackstageItemType["ActionItem"] = 1] = "ActionItem";
+    /** Item that activate a stage. */
+    BackstageItemType[BackstageItemType["StageLauncher"] = 2] = "StageLauncher";
+})(BackstageItemType || (BackstageItemType = {}));
+/** BackstageActionItem type guard.
+ * @deprecated in 3.6. Use [isBackstageActionItem]($appui-react) instead.
+ * @public
+ */
+export const isActionItem = (item) => {
+    return item.execute !== undefined; // eslint-disable-line deprecation/deprecation
+};
+/** BackstageStageLauncher type guard.
+ * @deprecated in 3.6. Use [isBackstageStageLauncher]($appui-react) instead.
+ * @public
+ */
+export const isStageLauncher = (item) => {
+    return item.stageId !== undefined; // eslint-disable-line deprecation/deprecation
+};
+/** Utilities for creating and maintaining backstage items
+ * @deprecated in 3.6. Use [BackstageItemUtilities]($appui-react) instead.
+ * @public
+ */
+class BackstageItemUtilities {
+}
+/** Creates a stage launcher backstage item */
+BackstageItemUtilities.createStageLauncher = (frontstageId, groupPriority, itemPriority, label, subtitle, icon, overrides // eslint-disable-line deprecation/deprecation
+) => ({
+    groupPriority,
+    icon,
+    internalData: overrides?.internalData,
+    id: frontstageId,
+    itemPriority,
+    label,
+    stageId: frontstageId,
+    subtitle,
+    ...overrides,
+});
+/** Creates an action backstage item */
+BackstageItemUtilities.createActionItem = (itemId, groupPriority, itemPriority, execute, label, subtitle, icon, overrides // eslint-disable-line deprecation/deprecation
+) => ({
+    execute,
+    groupPriority,
+    icon,
+    internalData: overrides?.internalData,
+    id: itemId,
+    itemPriority,
+    label,
+    subtitle,
+    ...overrides,
+});
+export { BackstageItemUtilities };
+//# sourceMappingURL=BackstageItem.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BackstageItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/backstage/BackstageItem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAOH;;;GAGG;AACH,MAAM,CAAN,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,4CAA4C;IAC5C,qEAAc,CAAA;IACd,kCAAkC;IAClC,2EAAiB,CAAA;AACnB,CAAC,EALW,iBAAiB,KAAjB,iBAAiB,QAK5B;AA4DD;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAmB,EAA+B,EAAE;IAC/E,OAAQ,IAA4B,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,8CAA8C;AAC5G,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,IAAmB,EAAkC,EAAE;IACrF,OAAQ,IAA+B,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,8CAA8C;AAC/G,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAa,sBAAsB;;AACjC,8CAA8C;AAChC,0CAAmB,GAAG,CAClC,YAAoB,EAAE,aAAqB,EAAE,YAAoB,EAAE,KAAsC,EACzG,QAA0C,EAAE,IAAsC,EAAE,SAA2C,CAAC,8CAA8C;EACtJ,EAAE,CAAC,CAAC;IAC5B,aAAa;IACb,IAAI;IACJ,YAAY,EAAE,SAAS,EAAE,YAAY;IACrC,EAAE,EAAE,YAAY;IAChB,YAAY;IACZ,KAAK;IACL,OAAO,EAAE,YAAY;IACrB,QAAQ;IACR,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,uCAAuC;AACzB,uCAAgB,GAAG,CAC/B,MAAc,EAAE,aAAqB,EAAE,YAAoB,EAAE,OAAmB,EAAE,KAAsC,EACxH,QAA0C,EAAE,IAAsC,EAAE,SAAwC,CAAC,8CAA8C;EACtJ,EAAE,CAAC,CAAC;IACzB,OAAO;IACP,aAAa;IACb,IAAI;IACJ,YAAY,EAAE,SAAS,EAAE,YAAY;IACrC,EAAE,EAAE,MAAM;IACV,YAAY;IACZ,KAAK;IACL,QAAQ;IACR,GAAG,SAAS;CACb,CAAC,CAAC;SA/BQ,sBAAsB","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 } from \"../items/BadgeType\";\r\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\r\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\r\nimport { ProvidedItem } from \"../items/ProvidedItem\";\r\n\r\n/** Used to specify the item type added to the backstage menu.\r\n * @deprecated in 3.6. Use type guards instead.\r\n * @public\r\n */\r\nexport enum BackstageItemType {\r\n  /** Item that executes an action function */\r\n  ActionItem = 1,\r\n  /** Item that activate a stage. */\r\n  StageLauncher = 2,\r\n}\r\n\r\n/** Describes the data needed to insert a button into the backstage menu.\r\n * @deprecated in 3.6. Use [CommonBackstageItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface CommonBackstageItem extends ProvidedItem { // eslint-disable-line deprecation/deprecation\r\n  /** can be used by application to store miscellaneous data. */\r\n  applicationData?: any;\r\n  /** Describes badge. Renders no badge if not specified. */\r\n  readonly badgeType?: 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?: string | ConditionalStringValue;\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  /** optional data to be used by item implementor. */\r\n  readonly internalData?: Map<string, any>;\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 * @deprecated in 3.6. Use [BackstageActionItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface BackstageActionItem extends CommonBackstageItem { // eslint-disable-line deprecation/deprecation\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 * @deprecated in 3.6. Use [BackstageActionItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface BackstageStageLauncher extends CommonBackstageItem { // eslint-disable-line deprecation/deprecation\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 * @deprecated in 3.6. Use [BackstageItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport type BackstageItem = BackstageActionItem | BackstageStageLauncher; // eslint-disable-line deprecation/deprecation\r\n\r\n/** BackstageActionItem type guard.\r\n * @deprecated in 3.6. Use [isBackstageActionItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport const isActionItem = (item: BackstageItem): item is BackstageActionItem => { // eslint-disable-line deprecation/deprecation\r\n  return (item as BackstageActionItem).execute !== undefined; // eslint-disable-line deprecation/deprecation\r\n};\r\n\r\n/** BackstageStageLauncher type guard.\r\n * @deprecated in 3.6. Use [isBackstageStageLauncher]($appui-react) instead.\r\n * @public\r\n */\r\nexport const isStageLauncher = (item: BackstageItem): item is BackstageStageLauncher => { // eslint-disable-line deprecation/deprecation\r\n  return (item as BackstageStageLauncher).stageId !== undefined; // eslint-disable-line deprecation/deprecation\r\n};\r\n\r\n/** Utilities for creating and maintaining backstage items\r\n * @deprecated in 3.6. Use [BackstageItemUtilities]($appui-react) instead.\r\n * @public\r\n */\r\nexport class BackstageItemUtilities {\r\n  /** Creates a stage launcher backstage item */\r\n  public static createStageLauncher = (\r\n    frontstageId: string, groupPriority: number, itemPriority: number, label: string | ConditionalStringValue,\r\n    subtitle?: string | ConditionalStringValue, icon?: string | ConditionalStringValue, overrides?: Partial<BackstageStageLauncher> // eslint-disable-line deprecation/deprecation\r\n  ): BackstageStageLauncher => ({ // eslint-disable-line deprecation/deprecation\r\n    groupPriority,\r\n    icon,\r\n    internalData: overrides?.internalData,\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  /** Creates an action backstage item */\r\n  public static createActionItem = (\r\n    itemId: string, groupPriority: number, itemPriority: number, execute: () => void, label: string | ConditionalStringValue,\r\n    subtitle?: string | ConditionalStringValue, icon?: string | ConditionalStringValue, overrides?: Partial<BackstageActionItem> // eslint-disable-line deprecation/deprecation\r\n  ): BackstageActionItem => ({ // eslint-disable-line deprecation/deprecation\r\n    execute,\r\n    groupPriority,\r\n    icon,\r\n    internalData: overrides?.internalData,\r\n    id: itemId,\r\n    itemPriority,\r\n    label,\r\n    subtitle,\r\n    ...overrides,\r\n  });\r\n}\r\n"]}

package/lib/esm/appui-abstract/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-abstract/backstage/BackstageItemsManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BackstageItemsManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/backstage/BackstageItemsManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAG9C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAIhD;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC;CAC9C;AAQD;;;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;CAYlD"}