@itwin/appui-react 4.0.0-dev.12 → 4.0.0-dev.14

package/lib/esm/appui-react/ui-items-provider/UiItemsManager.d.ts

@@ -1,92 +1,92 @@
-/** @packageDocumentation
- * @module UiProvider
- */
-import { BeUiEvent, MarkRequired } from "@itwin/core-bentley";
-import { BackstageItem } from "../backstage/BackstageItem";
-import { StagePanelLocation } from "../stagepanels/StagePanelLocation";
-import { StagePanelSection } from "../stagepanels/StagePanelSection";
-import { StatusBarItem } from "../statusbar/StatusBarItem";
-import { ToolbarItem, ToolbarOrientation, ToolbarUsage } from "../toolbar/ToolbarItem";
-import { Widget } from "../widgets/Widget";
-import { ProviderItem } from "./ProviderItem";
-import { UiItemsProvider } from "./UiItemsProvider";
-/** UiItemsProvider register event args.
- * @beta
- */
-export interface UiItemsProviderRegisteredEventArgs {
-    providerId: string;
-}
-/** UiItemsProvider overrides allows the application that registers a provider to limit when it is allowed to provide items
- * @beta
- */
-export interface AllowedUiItemsProviderOverrides {
-    /** allows providerId to be overridden in the items manager for cases where the same provider needs to provide different content to different stages */
-    providerId?: string;
-    /** if specified then the current stage's Usage will be compared before allowing any items to be provided */
-    stageUsages?: string[];
-    /** if specified then the current stage's Id will be compared before allowing any items to be provided */
-    stageIds?: string[];
-}
-/** Allowed overrides applied to a UiItemsProvider the application that registers a provider to limit when it is allowed to provide items.
- * Note that if an override `providerId` is specified then either `stageIds` or `stageUsages` must be defined to limit when the provider's
- * items are allowed.
- * @beta
- */
-export declare type UiItemsProviderOverrides = MarkRequired<AllowedUiItemsProviderOverrides, "providerId" | "stageUsages"> | MarkRequired<AllowedUiItemsProviderOverrides, "providerId" | "stageIds"> | MarkRequired<AllowedUiItemsProviderOverrides, "stageIds"> | MarkRequired<AllowedUiItemsProviderOverrides, "stageUsages"> | MarkRequired<AllowedUiItemsProviderOverrides, "providerId" | "stageUsages" | "stageIds">;
-/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.
- * @beta
- */
-export declare class UiItemsManager {
-    private static _registeredUiItemsProviders;
-    /** For use in unit testing
-     * @internal */
-    static clearAllProviders(): void;
-    /** Event raised any time a UiProvider is registered or unregistered. */
-    static readonly onUiProviderRegisteredEvent: BeUiEvent<UiItemsProviderRegisteredEventArgs>;
-    /** Return number of registered UiProvider. */
-    static get registeredProviderIds(): string[];
-    /** Return true if there is any registered UiProvider. */
-    static get hasRegisteredProviders(): boolean;
-    /**
-     * Retrieves a previously loaded UiItemsProvider.
-     * @param providerId id of the UiItemsProvider to get
-     */
-    static getUiItemsProvider(providerId: string): UiItemsProvider | undefined;
-    private static sendRegisteredEvent;
-    /**
-     * Registers a UiItemsProvider with the UiItemsManager.
-     * @param uiProvider the UI items provider to register.
-     */
-    static register(uiProvider: UiItemsProvider, overrides?: UiItemsProviderOverrides): void;
-    /** Remove a specific UiItemsProvider from the list of available providers. */
-    static unregister(providerId: string): void;
-    private static allowItemsFromProvider;
-    /** 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: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation): ReadonlyArray<ProviderItem<ToolbarItem>>;
-    /** 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: string, stageUsage: string): ReadonlyArray<ProviderItem<StatusBarItem>>;
-    /** 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(): ReadonlyArray<ProviderItem<BackstageItem>>;
-    /** 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 widgets.
-     */
-    static getWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection): ReadonlyArray<ProviderItem<Widget>>;
-}
+/** @packageDocumentation
+ * @module UiProvider
+ */
+import { BeUiEvent, MarkRequired } from "@itwin/core-bentley";
+import { BackstageItem } from "../backstage/BackstageItem";
+import { StagePanelLocation } from "../stagepanels/StagePanelLocation";
+import { StagePanelSection } from "../stagepanels/StagePanelSection";
+import { StatusBarItem } from "../statusbar/StatusBarItem";
+import { ToolbarItem, ToolbarOrientation, ToolbarUsage } from "../toolbar/ToolbarItem";
+import { Widget } from "../widgets/Widget";
+import { ProviderItem } from "./ProviderItem";
+import { UiItemsProvider } from "./UiItemsProvider";
+/** UiItemsProvider register event args.
+ * @beta
+ */
+export interface UiItemsProviderRegisteredEventArgs {
+    providerId: string;
+}
+/** UiItemsProvider overrides allows the application that registers a provider to limit when it is allowed to provide items
+ * @beta
+ */
+export interface AllowedUiItemsProviderOverrides {
+    /** allows providerId to be overridden in the items manager for cases where the same provider needs to provide different content to different stages */
+    providerId?: string;
+    /** if specified then the current stage's Usage will be compared before allowing any items to be provided */
+    stageUsages?: string[];
+    /** if specified then the current stage's Id will be compared before allowing any items to be provided */
+    stageIds?: string[];
+}
+/** Allowed overrides applied to a UiItemsProvider the application that registers a provider to limit when it is allowed to provide items.
+ * Note that if an override `providerId` is specified then either `stageIds` or `stageUsages` must be defined to limit when the provider's
+ * items are allowed.
+ * @beta
+ */
+export type UiItemsProviderOverrides = MarkRequired<AllowedUiItemsProviderOverrides, "providerId" | "stageUsages"> | MarkRequired<AllowedUiItemsProviderOverrides, "providerId" | "stageIds"> | MarkRequired<AllowedUiItemsProviderOverrides, "stageIds"> | MarkRequired<AllowedUiItemsProviderOverrides, "stageUsages"> | MarkRequired<AllowedUiItemsProviderOverrides, "providerId" | "stageUsages" | "stageIds">;
+/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.
+ * @beta
+ */
+export declare class UiItemsManager {
+    private static _registeredUiItemsProviders;
+    /** For use in unit testing
+     * @internal */
+    static clearAllProviders(): void;
+    /** Event raised any time a UiProvider is registered or unregistered. */
+    static readonly onUiProviderRegisteredEvent: BeUiEvent<UiItemsProviderRegisteredEventArgs>;
+    /** Return number of registered UiProvider. */
+    static get registeredProviderIds(): string[];
+    /** Return true if there is any registered UiProvider. */
+    static get hasRegisteredProviders(): boolean;
+    /**
+     * Retrieves a previously loaded UiItemsProvider.
+     * @param providerId id of the UiItemsProvider to get
+     */
+    static getUiItemsProvider(providerId: string): UiItemsProvider | undefined;
+    private static sendRegisteredEvent;
+    /**
+     * Registers a UiItemsProvider with the UiItemsManager.
+     * @param uiProvider the UI items provider to register.
+     */
+    static register(uiProvider: UiItemsProvider, overrides?: UiItemsProviderOverrides): void;
+    /** Remove a specific UiItemsProvider from the list of available providers. */
+    static unregister(providerId: string): void;
+    private static allowItemsFromProvider;
+    /** 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: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation): ReadonlyArray<ProviderItem<ToolbarItem>>;
+    /** 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: string, stageUsage: string): ReadonlyArray<ProviderItem<StatusBarItem>>;
+    /** 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(): ReadonlyArray<ProviderItem<BackstageItem>>;
+    /** 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 widgets.
+     */
+    static getWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection): ReadonlyArray<ProviderItem<Widget>>;
+}
 //# sourceMappingURL=UiItemsManager.d.ts.map

package/lib/esm/appui-react/ui-items-provider/UiItemsManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UiItemsManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/UiItemsManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAU,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAEvF,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,uJAAuJ;IACvJ,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4GAA4G;IAC5G,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,yGAAyG;IACzG,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED;;;;GAIG;AACH,oBAAY,wBAAwB,GAClC,YAAY,CAAC,+BAA+B,EAAE,YAAY,GAAG,aAAa,CAAC,GAC3E,YAAY,CAAC,+BAA+B,EAAE,YAAY,GAAG,UAAU,CAAC,GACxE,YAAY,CAAC,+BAA+B,EAAE,UAAU,CAAC,GACzD,YAAY,CAAC,+BAA+B,EAAE,aAAa,CAAC,GAC5D,YAAY,CAAC,+BAA+B,EAAE,YAAY,GAAG,aAAa,GAAG,UAAU,CAAC,CAAC;AAQ3F;;GAEG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAC,2BAA2B,CAA4E;IAEtH;mBACe;WACD,iBAAiB;IAI/B,wEAAwE;IACxE,gBAAuB,2BAA2B,gDAAuD;IAEzG,8CAA8C;IAC9C,WAAkB,qBAAqB,aAGtC;IAED,yDAAyD;IACzD,WAAkB,sBAAsB,IAAI,OAAO,CAElD;IAED;;;OAGG;WACW,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAIjF,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAIlC;;;OAGG;WACW,QAAQ,CAAC,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,EAAE,wBAAwB,GAAG,IAAI;IAa/F,8EAA8E;WAChE,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAclD,OAAO,CAAC,MAAM,CAAC,sBAAsB;IAUrC;;;;;;;OAOG;WACW,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,GAAG,aAAa,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;IAoBtL;;;;OAIG;WACW,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,aAAa,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;IAqBhH;;OAEG;WACW,iBAAiB,IAAI,aAAa,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;IAqB7E;;;;;;OAMG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,aAAa,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;CAqB9J"}
+{"version":3,"file":"UiItemsManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/ui-items-provider/UiItemsManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAU,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,mCAAmC,CAAC;AACvE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAEvF,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,uJAAuJ;IACvJ,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4GAA4G;IAC5G,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,yGAAyG;IACzG,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAClC,YAAY,CAAC,+BAA+B,EAAE,YAAY,GAAG,aAAa,CAAC,GAC3E,YAAY,CAAC,+BAA+B,EAAE,YAAY,GAAG,UAAU,CAAC,GACxE,YAAY,CAAC,+BAA+B,EAAE,UAAU,CAAC,GACzD,YAAY,CAAC,+BAA+B,EAAE,aAAa,CAAC,GAC5D,YAAY,CAAC,+BAA+B,EAAE,YAAY,GAAG,aAAa,GAAG,UAAU,CAAC,CAAC;AAQ3F;;GAEG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAC,2BAA2B,CAA4E;IAEtH;mBACe;WACD,iBAAiB;IAI/B,wEAAwE;IACxE,gBAAuB,2BAA2B,gDAAuD;IAEzG,8CAA8C;IAC9C,WAAkB,qBAAqB,aAGtC;IAED,yDAAyD;IACzD,WAAkB,sBAAsB,IAAI,OAAO,CAElD;IAED;;;OAGG;WACW,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS;IAIjF,OAAO,CAAC,MAAM,CAAC,mBAAmB;IAIlC;;;OAGG;WACW,QAAQ,CAAC,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,EAAE,wBAAwB,GAAG,IAAI;IAa/F,8EAA8E;WAChE,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAclD,OAAO,CAAC,MAAM,CAAC,sBAAsB;IAUrC;;;;;;;OAOG;WACW,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,GAAG,aAAa,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;IAoBtL;;;;OAIG;WACW,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,aAAa,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;IAqBhH;;OAEG;WACW,iBAAiB,IAAI,aAAa,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;IAqB7E;;;;;;OAMG;WACW,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,aAAa,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;CAqB9J"}

package/lib/esm/appui-react/ui-items-provider/UiItemsManager.js

@@ -1,174 +1,169 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module UiProvider
- */
-import { BeUiEvent, Logger } from "@itwin/core-bentley";
-import { UiFramework } from "../UiFramework";
-/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.
- * @beta
- */
-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(args) {
-        UiItemsManager.onUiProviderRegisteredEvent.raiseEvent(args);
-    }
-    /**
-     * 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(UiFramework.loggerCategory(this), `UiItemsProvider (${providerId}) is already loaded`);
-        }
-        else {
-            UiItemsManager._registeredUiItemsProviders.set(providerId, { provider: uiProvider, overrides });
-            Logger.logInfo(UiFramework.loggerCategory(this), `UiItemsProvider ${uiProvider.id} registered as ${providerId} `);
-            UiItemsManager.sendRegisteredEvent({ providerId });
-        }
-    }
-    /** Remove a specific UiItemsProvider from the list of available providers. */
-    static unregister(providerId) {
-        const provider = UiItemsManager.getUiItemsProvider(providerId);
-        if (!provider)
-            return;
-        provider.onUnregister && provider.onUnregister();
-        UiItemsManager._registeredUiItemsProviders.delete(providerId);
-        Logger.logInfo(UiFramework.loggerCategory(this), `UiItemsProvider (${providerId}) unloaded`);
-        // trigger a refresh of the ui
-        UiItemsManager.sendRegisteredEvent({ providerId });
-    }
-    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 = [];
-        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.provideToolbarItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {
-                uiProvider.provideToolbarItems(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 = [];
-        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 = [];
-        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 widgets.
-     */
-    static getWidgets(stageId, stageUsage, location, section) {
-        const 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 BeUiEvent();
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module UiProvider
+ */
+import { BeUiEvent, Logger } from "@itwin/core-bentley";
+import { UiFramework } from "../UiFramework";
+/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.
+ * @beta
+ */
+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(args) {
+        UiItemsManager.onUiProviderRegisteredEvent.raiseEvent(args);
+    }
+    /**
+     * 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(UiFramework.loggerCategory(this), `UiItemsProvider (${providerId}) is already loaded`);
+        }
+        else {
+            UiItemsManager._registeredUiItemsProviders.set(providerId, { provider: uiProvider, overrides });
+            Logger.logInfo(UiFramework.loggerCategory(this), `UiItemsProvider ${uiProvider.id} registered as ${providerId} `);
+            UiItemsManager.sendRegisteredEvent({ providerId });
+        }
+    }
+    /** Remove a specific UiItemsProvider from the list of available providers. */
+    static unregister(providerId) {
+        const provider = UiItemsManager.getUiItemsProvider(providerId);
+        if (!provider)
+            return;
+        provider.onUnregister && provider.onUnregister();
+        UiItemsManager._registeredUiItemsProviders.delete(providerId);
+        Logger.logInfo(UiFramework.loggerCategory(this), `UiItemsProvider (${providerId}) unloaded`);
+        // trigger a refresh of the ui
+        UiItemsManager.sendRegisteredEvent({ providerId });
+    }
+    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) {
+        const buttonItems = [];
+        UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
+            const uiProvider = entry.provider;
+            const providerId = entry.overrides?.providerId ?? uiProvider.id;
+            // istanbul ignore else
+            if (uiProvider.provideToolbarItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {
+                uiProvider.provideToolbarItems(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 = [];
+        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)
+                    .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 = [];
+        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 widgets.
+     */
+    static getWidgets(stageId, stageUsage, location, section) {
+        const 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)
+                    .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 BeUiEvent();
+export { UiItemsManager };
 //# sourceMappingURL=UiItemsManager.js.map