@itwin/appui-abstract 3.6.0-dev.7 → 4.0.0-dev.2

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

@@ -1,196 +1,195 @@
-/*---------------------------------------------------------------------------------------------
-* 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 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.
- * @public
- */
-export 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) {
-        var _a;
-        return (_a = UiItemsManager._registeredUiItemsProviders.get(providerId)) === null || _a === void 0 ? void 0 : _a.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) {
-        var _a;
-        const providerId = (_a = overrides === null || overrides === void 0 ? void 0 : overrides.providerId) !== null && _a !== void 0 ? _a : 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 === null || overrides === void 0 ? void 0 : overrides.stageIds) && !(overrides.stageIds.some((value) => value === stageId)))
-            return false;
-        if (undefined !== stageUsage && (overrides === null || overrides === void 0 ? void 0 : 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) => {
-            var _a, _b;
-            const uiProvider = entry.provider;
-            const providerId = (_b = (_a = entry.overrides) === null || _a === void 0 ? void 0 : _a.providerId) !== null && _b !== void 0 ? _b : 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) => {
-            var _a, _b;
-            const uiProvider = entry.provider;
-            const providerId = (_b = (_a = entry.overrides) === null || _a === void 0 ? void 0 : _a.providerId) !== null && _b !== void 0 ? _b : 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) => {
-            var _a, _b;
-            const uiProvider = entry.provider;
-            const providerId = (_b = (_a = entry.overrides) === null || _a === void 0 ? void 0 : _a.providerId) !== null && _b !== void 0 ? _b : 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) => {
-            var _a, _b;
-            const uiProvider = entry.provider;
-            const providerId = (_b = (_a = entry.overrides) === null || _a === void 0 ? void 0 : _a.providerId) !== null && _b !== void 0 ? _b : 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();
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+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 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.
+ * @public
+ */
+export 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) {
+        var _a;
+        return (_a = UiItemsManager._registeredUiItemsProviders.get(providerId)) === null || _a === void 0 ? void 0 : _a.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) {
+        var _a;
+        const providerId = (_a = overrides === null || overrides === void 0 ? void 0 : overrides.providerId) !== null && _a !== void 0 ? _a : 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 === null || overrides === void 0 ? void 0 : overrides.stageIds) && !(overrides.stageIds.some((value) => value === stageId)))
+            return false;
+        if (undefined !== stageUsage && (overrides === null || overrides === void 0 ? void 0 : 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) {
+        const buttonItems = [];
+        if (0 === UiItemsManager._registeredUiItemsProviders.size)
+            return buttonItems;
+        UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
+            var _a, _b;
+            const uiProvider = entry.provider;
+            const providerId = (_b = (_a = entry.overrides) === null || _a === void 0 ? void 0 : _a.providerId) !== null && _b !== void 0 ? _b : uiProvider.id;
+            // istanbul ignore else
+            if (uiProvider.provideToolbarButtonItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {
+                uiProvider.provideToolbarButtonItems(stageId, stageUsage, toolbarUsage, toolbarOrientation)
+                    .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) {
+        const statusBarItems = [];
+        if (0 === UiItemsManager._registeredUiItemsProviders.size)
+            return statusBarItems;
+        UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
+            var _a, _b;
+            const uiProvider = entry.provider;
+            const providerId = (_b = (_a = entry.overrides) === null || _a === void 0 ? void 0 : _a.providerId) !== null && _b !== void 0 ? _b : uiProvider.id;
+            // istanbul ignore else
+            if (uiProvider.provideStatusBarItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {
+                uiProvider.provideStatusBarItems(stageId, stageUsage)
+                    .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) => {
+            var _a, _b;
+            const uiProvider = entry.provider;
+            const providerId = (_b = (_a = entry.overrides) === null || _a === void 0 ? void 0 : _a.providerId) !== null && _b !== void 0 ? _b : 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) {
+        const widgets = [];
+        if (0 === UiItemsManager._registeredUiItemsProviders.size)
+            return widgets;
+        UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
+            var _a, _b;
+            const uiProvider = entry.provider;
+            const providerId = (_b = (_a = entry.overrides) === null || _a === void 0 ? void 0 : _a.providerId) !== null && _b !== void 0 ? _b : uiProvider.id;
+            // istanbul ignore else
+            if (uiProvider.provideWidgets && this.allowItemsFromProvider(entry, stageId, stageUsage)) {
+                uiProvider.provideWidgets(stageId, stageUsage, location, section)
+                    .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();
 //# sourceMappingURL=UiItemsManager.js.map

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

@@ -1 +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;AA8CD;;;GAGG;AACH,MAAM,OAAO,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,MAAA,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,CAAC,0CAAE,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,MAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,UAAU,mCAAI,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,KAAI,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,QAAQ,CAAA,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,KAAI,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,WAAW,CAAA,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,MAAA,MAAA,KAAK,CAAC,SAAS,0CAAE,UAAU,mCAAI,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,MAAA,MAAA,KAAK,CAAC,SAAS,0CAAE,UAAU,mCAAI,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,MAAA,MAAA,KAAK,CAAC,SAAS,0CAAE,UAAU,mCAAI,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,MAAA,MAAA,KAAK,CAAC,SAAS,0CAAE,UAAU,mCAAI,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","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 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 * @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 *  @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 *  @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\n *  @beta\r\n */\r\ninterface UiItemProviderEntry {\r\n  provider: UiItemsProvider;\r\n  overrides?: UiItemProviderOverrides;\r\n}\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 * @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"]}
+{"version":3,"file":"UiItemsManager.js","sourceRoot":"","sources":["../../../src/appui-abstract/UiItemsManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;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;AA8CD;;;GAGG;AACH,MAAM,OAAO,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,MAAA,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,CAAC,0CAAE,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,MAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,UAAU,mCAAI,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,KAAI,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,QAAQ,CAAA,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,KAAI,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,WAAW,CAAA,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;QACtC,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,MAAA,MAAA,KAAK,CAAC,SAAS,0CAAE,UAAU,mCAAI,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,CAAC;qBACxF,OAAO,CAAC,CAAC,IAAuB,EAAE,EAAE;oBACnC,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,WAAW,CAAC,SAAS,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC;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;QACjE,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,MAAA,MAAA,KAAK,CAAC,SAAS,0CAAE,UAAU,mCAAI,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,CAAC;qBAClD,OAAO,CAAC,CAAC,IAAyB,EAAE,EAAE;oBACrC,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,cAAc,CAAC,SAAS,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC;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,MAAA,MAAA,KAAK,CAAC,SAAS,0CAAE,UAAU,mCAAI,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,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC;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;QACrH,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,MAAA,MAAA,KAAK,CAAC,SAAS,0CAAE,UAAU,mCAAI,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,CAAC;qBAC9D,OAAO,CAAC,CAAC,MAA2B,EAAE,EAAE;oBACvC,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC;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","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module UiItemsProvider\n */\n\nimport { BeEvent, Logger, MarkRequired } from \"@itwin/core-bentley\";\nimport { BackstageItem } from \"./backstage/BackstageItem\";\nimport { CommonStatusBarItem } from \"./statusbar/StatusBarItem\";\nimport { CommonToolbarItem, ToolbarOrientation, ToolbarUsage } from \"./toolbars/ToolbarItem\";\nimport { AbstractWidgetProps } from \"./widget/AbstractWidgetProps\";\nimport { StagePanelLocation, StagePanelSection } from \"./widget/StagePanel\";\nimport { loggerCategory } from \"./utils/misc\";\nimport { UiItemsProvider } from \"./UiItemsProvider\";\n\n/** Action taken by the application on item provided by a UiItemsProvider\n * @public @deprecated this was only used by the previously removed UiItemsArbiter.\n */\nexport enum UiItemsApplicationAction {\n  /** Allow the change to the item */\n  Allow,\n  /** Disallow the change to the item */\n  Disallow,\n  /** Update the item during the change */\n  Update,\n}\n\n/** UIProvider Registered Event Args interface.\n * @public\n */\nexport interface UiItemProviderRegisteredEventArgs {\n  providerId: string;\n}\n\n/** UiItemProviderOverrides allows the application that registers a provider to limit when it is allowed to provide items\n *  @public\n */\nexport interface AllowedUiItemProviderOverrides {\n  /** allows providerId to be overridden in the items manager for cases where the same provider needs to provide different content to different stages\n   * @beta\n   */\n  providerId?: string;\n  /** if specified then the current stage's Usage will be compared before allowing any items to be provided\n   * @beta\n   */\n  stageUsages?: string[];\n  /** if specified then the current stage's Id will be compared before allowing any items to be provided\n   * @beta\n  */\n  stageIds?: string[];\n}\n\n/** Allowed overrides applied to a UiItemsProvider the application that registers a provider to limit when it is allowed to provide items.\n * Note that if an override `providerId` is specified then either `stageIds` or `stageUsages` must be defined to limit when the provider's\n * items are allowed.\n *  @public\n */\nexport type UiItemProviderOverrides = MarkRequired<AllowedUiItemProviderOverrides, \"providerId\" | \"stageUsages\"> |\n  MarkRequired<AllowedUiItemProviderOverrides, \"providerId\" | \"stageIds\"> |                                 // eslint-disable-line @typescript-eslint/indent\n  MarkRequired<AllowedUiItemProviderOverrides, \"stageIds\"> |                                                // eslint-disable-line @typescript-eslint/indent\n  MarkRequired<AllowedUiItemProviderOverrides, \"stageUsages\"> |                                             // eslint-disable-line @typescript-eslint/indent\n  MarkRequired<AllowedUiItemProviderOverrides, \"providerId\" | \"stageUsages\" | \"stageIds\">;                  // eslint-disable-line @typescript-eslint/indent\n\n/** Interface that defines an instance of a UiItemsProvider and its application specified overrides.\n *  @beta\n */\ninterface UiItemProviderEntry {\n  provider: UiItemsProvider;\n  overrides?: UiItemProviderOverrides;\n}\n\n/**\n * Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.\n * @public\n */\nexport class UiItemsManager {\n  private static _registeredUiItemsProviders: Map<string, UiItemProviderEntry> = new Map<string, UiItemProviderEntry>();\n\n  /** For use in unit testing\n   * @internal */\n  public static clearAllProviders() {\n    UiItemsManager._registeredUiItemsProviders.clear();\n  }\n\n  /** Event raised any time a UiProvider is registered or unregistered. */\n  public static readonly onUiProviderRegisteredEvent = new BeEvent<(ev: UiItemProviderRegisteredEventArgs) => void>();\n\n  /** Return number of registered UiProvider. */\n  public static get registeredProviderIds() {\n    const ids = [...UiItemsManager._registeredUiItemsProviders.keys()];\n    return ids;\n  }\n\n  /** Return true if there is any registered UiProvider. */\n  public static get hasRegisteredProviders(): boolean {\n    return this._registeredUiItemsProviders.size > 0;\n  }\n\n  /**\n   * Retrieves a previously loaded UiItemsProvider.\n   * @param providerId id of the UiItemsProvider to get\n   */\n  public static getUiItemsProvider(providerId: string): UiItemsProvider | undefined {\n    return UiItemsManager._registeredUiItemsProviders.get(providerId)?.provider;\n  }\n\n  private static sendRegisteredEvent(ev: UiItemProviderRegisteredEventArgs) {\n    UiItemsManager.onUiProviderRegisteredEvent.raiseEvent(ev);\n  }\n\n  /**\n   * Registers a UiItemsProvider with the UiItemsManager.\n   * @param uiProvider the UI items provider to register.\n   */\n  public static register(uiProvider: UiItemsProvider, overrides?: UiItemProviderOverrides): void {\n    const providerId = overrides?.providerId ?? uiProvider.id;\n\n    if (UiItemsManager.getUiItemsProvider(providerId)) {\n      Logger.logInfo(loggerCategory(this), `UiItemsProvider (${providerId}) is already loaded`);\n    } else {\n      UiItemsManager._registeredUiItemsProviders.set(providerId, { provider: uiProvider, overrides });\n      Logger.logInfo(loggerCategory(this), `UiItemsProvider ${uiProvider.id} registered as ${providerId} `);\n\n      UiItemsManager.sendRegisteredEvent({ providerId } as UiItemProviderRegisteredEventArgs);\n    }\n  }\n\n  /** Remove a specific UiItemsProvider from the list of available providers. */\n  public static unregister(uiProviderId: string): void {\n    const provider = UiItemsManager.getUiItemsProvider(uiProviderId);\n    if (!provider)\n      return;\n\n    provider.onUnregister && provider.onUnregister();\n\n    UiItemsManager._registeredUiItemsProviders.delete(uiProviderId);\n    Logger.logInfo(loggerCategory(this), `UiItemsProvider (${uiProviderId}) unloaded`);\n\n    // trigger a refresh of the ui\n    UiItemsManager.sendRegisteredEvent({ providerId: uiProviderId } as UiItemProviderRegisteredEventArgs);\n  }\n\n  private static allowItemsFromProvider(entry: UiItemProviderEntry, stageId?: string, stageUsage?: string) {\n    // istanbul ignore else\n    const overrides = entry.overrides;\n    if (undefined !== stageId && overrides?.stageIds && !(overrides.stageIds.some((value: string) => value === stageId)))\n      return false;\n    if (undefined !== stageUsage && overrides?.stageUsages && !(overrides.stageUsages.some((value: string) => value === stageUsage)))\n      return false;\n    return true;\n  }\n\n  /** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute\n   * an action or specify a registered ToolId into toolbar.\n   * @param stageId a string identifier the active stage.\n   * @param stageUsage the StageUsage of the active stage.\n   * @param toolbarUsage usage of the toolbar\n   * @param toolbarOrientation orientation of the toolbar\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.\n   */\n  public static getToolbarButtonItems(stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage,\n    toolbarOrientation: ToolbarOrientation): CommonToolbarItem[] {\n    const buttonItems: CommonToolbarItem[] = [];\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\n      return buttonItems;\n\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\n      const uiProvider = entry.provider;\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\n      // istanbul ignore else\n      if (uiProvider.provideToolbarButtonItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\n        uiProvider.provideToolbarButtonItems(stageId, stageUsage, toolbarUsage, toolbarOrientation)\n          .forEach((spec: CommonToolbarItem) => {\n            // ignore duplicate ids\n            if (-1 === buttonItems.findIndex((existingItem) => spec.id === existingItem.id))\n              buttonItems.push({ ...spec, providerId });\n          });\n      }\n    });\n\n    return buttonItems;\n  }\n\n  /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\n   * @param stageId a string identifier the active stage.\n   * @param stageUsage the StageUsage of the active stage.\n   * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.\n   */\n  public static getStatusBarItems(stageId: string, stageUsage: string): CommonStatusBarItem[] {\n    const statusBarItems: CommonStatusBarItem[] = [];\n\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\n      return statusBarItems;\n\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\n      const uiProvider = entry.provider;\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\n\n      // istanbul ignore else\n      if (uiProvider.provideStatusBarItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\n        uiProvider.provideStatusBarItems(stageId, stageUsage)\n          .forEach((item: CommonStatusBarItem) => {\n            // ignore duplicate ids\n            if (-1 === statusBarItems.findIndex((existingItem) => item.id === existingItem.id))\n              statusBarItems.push({ ...item, providerId });\n          });\n      }\n    });\n\n    return statusBarItems;\n  }\n\n  /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\n   * @returns An array of BackstageItem that will be used to create controls for the backstage menu.\n   */\n  public static getBackstageItems(): BackstageItem[] {\n    const backstageItems: BackstageItem[] = [];\n\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\n      return backstageItems;\n\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\n      const uiProvider = entry.provider;\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\n\n      // istanbul ignore else\n      if (uiProvider.provideBackstageItems) { // Note: We do not call this.allowItemsFromProvider here as backstage items\n        uiProvider.provideBackstageItems()    //       should not be considered stage specific. If they need to be hidden\n          .forEach((item: BackstageItem) => { //       the isHidden property should be set to a ConditionalBooleanValue\n            // ignore duplicate ids\n            if (-1 === backstageItems.findIndex((existingItem) => item.id === existingItem.id))\n              backstageItems.push({ ...item, providerId });\n          });\n      }\n    });\n    return backstageItems;\n  }\n\n  /** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets\n   * @param stageId a string identifier the active stage.\n   * @param stageUsage the StageUsage of the active stage.\n   * @param location the location within the stage.\n   * @param section the section within location.\n   * @returns An array of AbstractWidgetProps that will be used to create widgets.\n   */\n  public static getWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection): ReadonlyArray<AbstractWidgetProps> {\n    const widgets: AbstractWidgetProps[] = [];\n\n    if (0 === UiItemsManager._registeredUiItemsProviders.size)\n      return widgets;\n\n    UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\n      const uiProvider = entry.provider;\n      const providerId = entry.overrides?.providerId ?? uiProvider.id;\n\n      // istanbul ignore else\n      if (uiProvider.provideWidgets && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\n        uiProvider.provideWidgets(stageId, stageUsage, location, section)\n          .forEach((widget: AbstractWidgetProps) => {\n            // ignore duplicate ids\n            if (-1 === widgets.findIndex((existingItem) => widget.id === existingItem.id))\n              widgets.push({ ...widget, providerId });\n          });\n      }\n    });\n    return widgets;\n  }\n\n}\n"]}

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

@@ -1,28 +1,28 @@
-/** @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.
- * @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, zoneLocation?: AbstractZoneLocation, stageAppData?: any) => ReadonlyArray<AbstractWidgetProps>;
-    /** Function called when the provider is unregistered via `ItemsManager.unregister` to allow provider to do cleanup. */
-    onUnregister?: () => void;
-}
+/** @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 { StagePanelLocation, StagePanelSection } from "./widget/StagePanel";
+/** Describes interface of objects that want to provide UI component to the running IModelApp.
+ * @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) => CommonToolbarItem[];
+    /** UiItemsManager calls following method to augment base statusbar for stages that allow it. */
+    provideStatusBarItems?: (stageId: string, stageUsage: string) => 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) => 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

@@ -1 +1 @@
-{"version":3,"file":"UiItemsProvider.d.ts","sourceRoot":"","sources":["../../../src/appui-abstract/UiItemsProvider.ts"],"names":[],"mappings":"AAKA;;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;;GAEG;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,EAC9G,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"}
+{"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,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE5E;;GAEG;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,KAAK,iBAAiB,EAAE,CAAC;IAC7J,gGAAgG;IAChG,qBAAqB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,KAAK,mBAAmB,EAAE,CAAC;IACvF,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,KAAK,aAAa,CAAC,mBAAmB,CAAC,CAAC;IACxJ,uHAAuH;IACvH,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;CAC3B"}

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

@@ -1,10 +1,9 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-export {};
+/*---------------------------------------------------------------------------------------------
+* 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

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