@itwin/appui-react 3.0.0-dev.100

package/lib/esm/appui-react/UiFramework.d.ts

@@ -0,0 +1,197 @@
+/** @packageDocumentation
+ * @module Utilities
+ */
+import { Store } from "redux";
+import { GuidString } from "@itwin/core-bentley";
+import { Localization } from "@itwin/core-common";
+import { IModelConnection, SnapMode, ViewState } from "@itwin/core-frontend";
+import { SettingsManager, UiEvent, UiSettingsStorage } from "@itwin/core-react";
+import { BackstageManager } from "./backstage/BackstageManager";
+import { ChildWindowManager } from "./childwindow/ChildWindowManager";
+import { FrameworkState } from "./redux/FrameworkState";
+import { CursorMenuData, PresentationSelectionScope } from "./redux/SessionState";
+import { HideIsolateEmphasizeActionHandler } from "./selection/HideIsolateEmphasizeManager";
+import { UserInfo } from "./UserInfo";
+import { WidgetManager } from "./widgets/WidgetManager";
+/** Defined that available Ui Versions. It is recommended to always use the latest version available.
+ * @public
+ */
+export declare type FrameworkVersionId = "1" | "2";
+/** Interface to be implemented but any classes that wants to load their user settings when the UiSetting storage class is set.
+ * @public
+ */
+export interface UserSettingsProvider {
+    /** Unique provider Id */
+    providerId: string;
+    /** Function to load settings from settings storage */
+    loadUserSettings(storage: UiSettingsStorage): Promise<void>;
+}
+/** UiVisibility Event Args interface.
+ * @public
+ */
+export interface UiVisibilityEventArgs {
+    visible: boolean;
+}
+/** UiVisibility Event class.
+ * @public
+ */
+export declare class UiVisibilityChangedEvent extends UiEvent<UiVisibilityEventArgs> {
+}
+/** FrameworkVersion Changed Event Args interface.
+ * @internal
+ */
+export interface FrameworkVersionChangedEventArgs {
+    oldVersion: FrameworkVersionId;
+    version: FrameworkVersionId;
+}
+/** FrameworkVersion Changed Event class.
+ * @internal
+ */
+export declare class FrameworkVersionChangedEvent extends UiEvent<FrameworkVersionChangedEventArgs> {
+}
+/** TrackingTime time argument used by our feature tracking manager as an option argument to the TelemetryClient
+ * @internal
+ */
+export interface TrackingTime {
+    startTime: Date;
+    endTime: Date;
+}
+/**
+ * Manages the Redux store, localization service and iModel, Project and Login services for the ui-framework package.
+ * @public
+ */
+export declare class UiFramework {
+    private static _initialized;
+    private static _store?;
+    private static _complaint;
+    private static _frameworkStateKeyInStore;
+    private static _backstageManager?;
+    private static _widgetManager?;
+    private static _uiVersion;
+    private static _hideIsolateEmphasizeActionHandler?;
+    private static _uiSettingsStorage;
+    private static _settingsManager?;
+    private static _uiSettingsProviderRegistry;
+    private static _PopupWindowManager;
+    static useDefaultPopoutUrl: boolean;
+    /** @public */
+    static get childWindowManager(): ChildWindowManager;
+    /** Registers class that will be informed when the UserSettingsStorage location has been set or changed. This allows
+     * classes to load any previously saved settings from the new storage location. Common storage locations are the browser's
+     * local storage, or the iTwin Product Settings cloud storage available via the SettingsAdmin see `IModelApp.settingsAdmin`.
+     * @beta
+     */
+    static registerUserSettingsProvider(entry: UserSettingsProvider): boolean;
+    /** Get Show Ui event.
+     * @public
+     */
+    static readonly onUiVisibilityChanged: UiVisibilityChangedEvent;
+    /**
+     * Called by the application to initialize the UiFramework. Also initializes UIIModelComponents, UiComponents, UiCore.
+     * @param store The single Redux store created by the host application. If this is `undefined` then it is assumed that the [[StateManager]] is being used to provide the Redux store.
+     * @param frameworkStateKey The name of the key used by the app when adding the UiFramework state into the Redux store. If not defined "frameworkState" is assumed. This value is ignored if [[StateManager]] is being used. The StateManager use "frameworkState".
+     */
+    static initialize(store: Store<any> | undefined, frameworkStateKey?: string): Promise<void>;
+    /**
+     * Called by the application to initialize the UiFramework. Also initializes UIIModelComponents, UiComponents, UiCore.
+     * @param store The single Redux store created by the host application. If this is `undefined` then it is assumed that the [[StateManager]] is being used to provide the Redux store.
+     * @param frameworkStateKey The name of the key used by the app when adding the UiFramework state into the Redux store. If not defined "frameworkState" is assumed. This value is ignored if [[StateManager]] is being used. The StateManager use "frameworkState".
+     *
+     * @internal
+     */
+    static initializeEx(store: Store<any> | undefined, frameworkStateKey?: string): Promise<void>;
+    /** Un-registers the UiFramework internationalization service namespace */
+    static terminate(): void;
+    /** Determines if UiFramework has been initialized */
+    static get initialized(): boolean;
+    /** Property that returns the SettingManager used by AppUI-based applications.
+     *  @public */
+    static get settingsManager(): SettingsManager;
+    /** @public */
+    static get frameworkStateKey(): string;
+    /** The UiFramework state maintained by Redux
+     * @public
+     */
+    static get frameworkState(): FrameworkState | undefined;
+    /** The Redux store */
+    static get store(): Store<any>;
+    /** The internationalization service created by the app.
+     * @internal
+    */
+    static get localization(): Localization;
+    /** The internationalization service namespace. */
+    static get localizationNamespace(): string;
+    /** @public */
+    static get backstageManager(): BackstageManager;
+    /** @alpha */
+    static get hideIsolateEmphasizeActionHandler(): HideIsolateEmphasizeActionHandler;
+    /** @alpha */
+    static setHideIsolateEmphasizeActionHandler(handler: HideIsolateEmphasizeActionHandler | undefined): void;
+    /** @alpha */
+    static get widgetManager(): WidgetManager;
+    /** Calls localization.getLocalizedStringWithNamespace with the "UiFramework" namespace. Do NOT include the namespace in the key.
+     * @internal
+     */
+    static translate(key: string | string[]): string;
+    /** @internal */
+    static get packageName(): string;
+    /** @internal */
+    static loggerCategory(obj: any): string;
+    static dispatchActionToStore(type: string, payload: any, immediateSync?: boolean): void;
+    static setAccudrawSnapMode(snapMode: SnapMode): void;
+    static getAccudrawSnapMode(): SnapMode;
+    static getActiveSelectionScope(): string;
+    static setActiveSelectionScope(selectionScopeId: string): void;
+    /** @public */
+    static openCursorMenu(menuData: CursorMenuData | undefined): void;
+    /** @public */
+    static closeCursorMenu(): void;
+    /** @public */
+    static getCursorMenuData(): CursorMenuData | undefined;
+    static getActiveIModelId(): string;
+    static setActiveIModelId(iModelId: string): void;
+    static setIModelConnection(iModelConnection: IModelConnection | undefined, immediateSync?: boolean): void;
+    static getIModelConnection(): IModelConnection | undefined;
+    /** @public */
+    static setUiSettingsStorage(storage: UiSettingsStorage, immediateSync?: boolean): Promise<void>;
+    /** @public */
+    static getUiSettingsStorage(): UiSettingsStorage;
+    /** @public */
+    static setUserInfo(userInfo: UserInfo | undefined, immediateSync?: boolean): void;
+    /** @public */
+    static getUserInfo(): UserInfo | undefined;
+    static setDefaultIModelViewportControlId(iModelViewportControlId: string, immediateSync?: boolean): void;
+    static getDefaultIModelViewportControlId(): string | undefined;
+    static setDefaultViewId(viewId: string, immediateSync?: boolean): void;
+    static getDefaultViewId(): string | undefined;
+    static setDefaultViewState(viewState: ViewState, immediateSync?: boolean): void;
+    static getDefaultViewState(): ViewState | undefined;
+    /** @public */
+    static getAvailableSelectionScopes(): PresentationSelectionScope[];
+    static getIsUiVisible(): boolean;
+    static setIsUiVisible(visible: boolean): void;
+    static setColorTheme(theme: string): void;
+    static getColorTheme(): string;
+    static setWidgetOpacity(opacity: number): void;
+    static getWidgetOpacity(): number;
+    static isMobile(): boolean;
+    /** Returns the Ui Version.
+     * @public
+     */
+    static get uiVersion(): FrameworkVersionId;
+    static setUiVersion(version: FrameworkVersionId): void;
+    static get useDragInteraction(): boolean;
+    static setUseDragInteraction(useDragInteraction: boolean): void;
+    /** Send logging message to the telemetry system
+     * @internal
+     */
+    static postTelemetry(eventName: string, eventId?: GuidString, iTwinId?: GuidString, iModeId?: GuidString, changeSetId?: string, time?: TrackingTime, additionalProperties?: {
+        [key: string]: any;
+    }): Promise<void>;
+    private static _handleFrameworkVersionChangedEvent;
+    /** Determines whether a ContextMenu is open
+     * @alpha
+     * */
+    static get isContextMenuOpen(): boolean;
+}
+//# sourceMappingURL=UiFramework.d.ts.map

package/lib/esm/appui-react/UiFramework.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UiFramework.d.ts","sourceRoot":"","sources":["../../../src/appui-react/UiFramework.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAC9B,OAAO,EAAE,UAAU,EAA2B,MAAM,qBAAqB,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAe,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EAAa,gBAAgB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAIxF,OAAO,EAAwB,eAAe,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEtG,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AAGtE,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,0BAA0B,EAAwB,MAAM,sBAAsB,CAAC;AAExG,OAAO,EAAE,iCAAiC,EAA+B,MAAM,yCAAyC,CAAC;AAOzH,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAKxD;;GAEG;AACH,oBAAY,kBAAkB,GAAG,GAAG,GAAG,GAAG,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,yBAAyB;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,sDAAsD;IACtD,gBAAgB,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7D;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,OAAO,CAAC,qBAAqB,CAAC;CAAI;AAEhF;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C,UAAU,EAAE,kBAAkB,CAAC;IAC/B,OAAO,EAAE,kBAAkB,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,4BAA6B,SAAQ,OAAO,CAAC,gCAAgC,CAAC;CAAI;AAE/F;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,IAAI,CAAC;IAChB,OAAO,EAAE,IAAI,CAAC;CACf;AAED;;;GAGG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,MAAM,CAAC,YAAY,CAAS;IACpC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAa;IACnC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAiC;IAC1D,OAAO,CAAC,MAAM,CAAC,yBAAyB,CAA4B;IACpE,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAmB;IACpD,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAgB;IAC9C,OAAO,CAAC,MAAM,CAAC,UAAU,CAA2B;IACpD,OAAO,CAAC,MAAM,CAAC,kCAAkC,CAAC,CAAoC;IACtF,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAiD;IAClF,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAkB;IAClD,OAAO,CAAC,MAAM,CAAC,2BAA2B,CAA8E;IACxH,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAA4B;IAC9D,OAAc,mBAAmB,UAAS;IAE1C,cAAc;IACd,WAAkB,kBAAkB,IAAI,kBAAkB,CAEzD;IAED;;;;OAIG;WACW,4BAA4B,CAAC,KAAK,EAAE,oBAAoB;IAQtE;;OAEG;IACH,gBAAuB,qBAAqB,2BAAkC;IAE9E;;;;OAIG;WACiB,UAAU,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,SAAS,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxG;;;;;;OAMG;WACiB,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,SAAS,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiD1G,0EAA0E;WAC5D,SAAS;IAiBvB,qDAAqD;IACrD,WAAkB,WAAW,IAAI,OAAO,CAAqC;IAE7E;kBACc;IACd,WAAkB,eAAe,oBAIhC;IAED,cAAc;IACd,WAAkB,iBAAiB,IAAI,MAAM,CAE5C;IAED;;OAEG;IACH,WAAkB,cAAc,IAAI,cAAc,GAAG,SAAS,CAO7D;IAED,sBAAsB;IACtB,WAAkB,KAAK,IAAI,KAAK,CAAC,GAAG,CAAC,CAUpC;IAED;;MAEE;IACF,WAAkB,YAAY,IAAI,YAAY,CAK7C;IAED,kDAAkD;IAClD,WAAkB,qBAAqB,IAAI,MAAM,CAEhD;IAED,cAAc;IACd,WAAkB,gBAAgB,IAAI,gBAAgB,CAKrD;IAED,aAAa;IACb,WAAkB,iCAAiC,IAAI,iCAAiC,CAKvF;IAED,aAAa;WACC,oCAAoC,CAAC,OAAO,EAAE,iCAAiC,GAAG,SAAS;IAQzG,aAAa;IACb,WAAkB,aAAa,IAAI,aAAa,CAK/C;IAED;;OAEG;WACW,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM;IAIvD,gBAAgB;IAChB,WAAkB,WAAW,IAAI,MAAM,CAEtC;IAED,gBAAgB;WACF,cAAc,CAAC,GAAG,EAAE,GAAG,GAAG,MAAM;WAMhC,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,aAAa,UAAQ;WAQvE,mBAAmB,CAAC,QAAQ,EAAE,QAAQ;WAItC,mBAAmB,IAAI,QAAQ;WAI/B,uBAAuB,IAAI,MAAM;WAIjC,uBAAuB,CAAC,gBAAgB,EAAE,MAAM,GAAG,IAAI;IAYrE,cAAc;WACA,cAAc,CAAC,QAAQ,EAAE,cAAc,GAAG,SAAS,GAAG,IAAI;IAIxE,cAAc;WACA,eAAe,IAAI,IAAI;IAIrC,cAAc;WACA,iBAAiB,IAAI,cAAc,GAAG,SAAS;WAI/C,iBAAiB,IAAI,MAAM;WAI3B,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;WAIzC,mBAAmB,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,SAAS,EAAE,aAAa,UAAQ;WAYzF,mBAAmB,IAAI,gBAAgB,GAAG,SAAS;IAIjE,cAAc;WACM,oBAAoB,CAAC,OAAO,EAAE,iBAAiB,EAAE,aAAa,UAAQ;IAmB1F,cAAc;WACA,oBAAoB,IAAI,iBAAiB;IAIvD,cAAc;WACA,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,SAAS,EAAE,aAAa,UAAQ;IAI/E,cAAc;WACA,WAAW,IAAI,QAAQ,GAAG,SAAS;WAInC,iCAAiC,CAAC,uBAAuB,EAAE,MAAM,EAAE,aAAa,UAAQ;WAIxF,iCAAiC,IAAI,MAAM,GAAG,SAAS;WAIvD,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,UAAQ;WAItD,gBAAgB,IAAI,MAAM,GAAG,SAAS;WAItC,mBAAmB,CAAC,SAAS,EAAE,SAAS,EAAE,aAAa,UAAQ;WAG/D,mBAAmB,IAAI,SAAS,GAAG,SAAS;IAI1D,cAAc;WACA,2BAA2B,IAAI,0BAA0B,EAAE;WAO3D,cAAc;WAId,cAAc,CAAC,OAAO,EAAE,OAAO;WAO/B,aAAa,CAAC,KAAK,EAAE,MAAM;WAO3B,aAAa,IAAI,MAAM;WAIvB,gBAAgB,CAAC,OAAO,EAAE,MAAM;WAOhC,gBAAgB,IAAI,MAAM;WAI1B,QAAQ;IAItB;;OAEG;IACH,WAAkB,SAAS,IAAI,kBAAkB,CAEhD;WAEa,YAAY,CAAC,OAAO,EAAE,kBAAkB;IAOtD,WAAkB,kBAAkB,IAAI,OAAO,CAE9C;WAEa,qBAAqB,CAAC,kBAAkB,EAAE,OAAO;IAI/D;;OAEG;WAEiB,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,UAAU,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,YAAY,EAAE,oBAAoB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAgB/N,OAAO,CAAC,MAAM,CAAC,mCAAmC,CAMhD;IAEF;;SAEK;IACL,WAAkB,iBAAiB,IAAI,OAAO,CAG7C;CAEF"}

package/lib/esm/appui-react/UiFramework.js

@@ -0,0 +1,430 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Utilities
+ */
+import { Logger, ProcessDetector } from "@itwin/core-bentley";
+import { IModelApp, SnapMode } from "@itwin/core-frontend";
+import { Presentation } from "@itwin/presentation-frontend";
+import { TelemetryEvent } from "@bentley/telemetry-client";
+import { getClassName, UiAdmin, UiError } from "@itwin/appui-abstract";
+import { LocalSettingsStorage, SettingsManager, UiEvent } from "@itwin/core-react";
+import { UiIModelComponents } from "@itwin/imodel-components-react";
+import { BackstageManager } from "./backstage/BackstageManager";
+import { ChildWindowManager } from "./childwindow/ChildWindowManager";
+import { ConfigurableUiManager } from "./configurableui/ConfigurableUiManager";
+import { ConfigurableUiActionId } from "./configurableui/state";
+import { SessionStateActionId } from "./redux/SessionState";
+import { StateManager } from "./redux/StateManager";
+import { HideIsolateEmphasizeManager } from "./selection/HideIsolateEmphasizeManager";
+import { SyncUiEventDispatcher, SyncUiEventId } from "./syncui/SyncUiEventDispatcher";
+import { SYSTEM_PREFERRED_COLOR_THEME, WIDGET_OPACITY_DEFAULT } from "./theme/ThemeManager";
+import * as keyinPaletteTools from "./tools/KeyinPaletteTools";
+import * as openSettingTools from "./tools/OpenSettingsTool";
+import * as restoreLayoutTools from "./tools/RestoreLayoutTool";
+import * as toolSettingTools from "./tools/ToolSettingsTools";
+import { UiShowHideManager, UiShowHideSettingsProvider } from "./utils/UiShowHideManager";
+import { WidgetManager } from "./widgets/WidgetManager";
+import { FrontstageManager } from "./frontstage/FrontstageManager";
+/** UiVisibility Event class.
+ * @public
+ */
+export class UiVisibilityChangedEvent extends UiEvent {
+}
+/** FrameworkVersion Changed Event class.
+ * @internal
+ */
+export class FrameworkVersionChangedEvent extends UiEvent {
+}
+/**
+ * Manages the Redux store, localization service and iModel, Project and Login services for the ui-framework package.
+ * @public
+ */
+export class UiFramework {
+    /** @public */
+    static get childWindowManager() {
+        return UiFramework._PopupWindowManager;
+    }
+    /** Registers class that will be informed when the UserSettingsStorage location has been set or changed. This allows
+     * classes to load any previously saved settings from the new storage location. Common storage locations are the browser's
+     * local storage, or the iTwin Product Settings cloud storage available via the SettingsAdmin see `IModelApp.settingsAdmin`.
+     * @beta
+     */
+    static registerUserSettingsProvider(entry) {
+        if (this._uiSettingsProviderRegistry.has(entry.providerId))
+            return false;
+        this._uiSettingsProviderRegistry.set(entry.providerId, entry);
+        return true;
+    }
+    /**
+     * Called by the application to initialize the UiFramework. Also initializes UIIModelComponents, UiComponents, UiCore.
+     * @param store The single Redux store created by the host application. If this is `undefined` then it is assumed that the [[StateManager]] is being used to provide the Redux store.
+     * @param frameworkStateKey The name of the key used by the app when adding the UiFramework state into the Redux store. If not defined "frameworkState" is assumed. This value is ignored if [[StateManager]] is being used. The StateManager use "frameworkState".
+     */
+    static async initialize(store, frameworkStateKey) {
+        return this.initializeEx(store, frameworkStateKey);
+    }
+    /**
+     * Called by the application to initialize the UiFramework. Also initializes UIIModelComponents, UiComponents, UiCore.
+     * @param store The single Redux store created by the host application. If this is `undefined` then it is assumed that the [[StateManager]] is being used to provide the Redux store.
+     * @param frameworkStateKey The name of the key used by the app when adding the UiFramework state into the Redux store. If not defined "frameworkState" is assumed. This value is ignored if [[StateManager]] is being used. The StateManager use "frameworkState".
+     *
+     * @internal
+     */
+    static async initializeEx(store, frameworkStateKey) {
+        var _a;
+        if (UiFramework._initialized) {
+            Logger.logInfo(UiFramework.loggerCategory(UiFramework), `UiFramework.initialize already called`);
+            return;
+        }
+        /* if store is undefined then the StateManager class should have been initialized by parent app and the apps default set of reducers registered with it.
+          If the app has no reducers to add and does not initialize a StateManager then just initialize the StateManager with the default framework reducer now */
+        if (undefined === store && !StateManager.isInitialized(true))
+            new StateManager();
+        UiFramework._store = store;
+        // ignore setting _frameworkStateKeyInStore if not using store
+        if (frameworkStateKey && store)
+            UiFramework._frameworkStateKeyInStore = frameworkStateKey;
+        // set up namespace and register all tools from package
+        const frameworkNamespace = (_a = IModelApp.localization) === null || _a === void 0 ? void 0 : _a.registerNamespace(UiFramework.localizationNamespace);
+        [
+            restoreLayoutTools,
+            keyinPaletteTools,
+            openSettingTools,
+            toolSettingTools,
+        ].forEach((tool) => IModelApp.tools.registerModule(tool, this.localizationNamespace));
+        UiFramework._backstageManager = new BackstageManager();
+        UiFramework._hideIsolateEmphasizeActionHandler = new HideIsolateEmphasizeManager(); // this allows user to override the default HideIsolateEmphasizeManager implementation.
+        UiFramework._widgetManager = new WidgetManager();
+        // Initialize ui-imodel-components, ui-components, ui-core & ui-abstract
+        await UiIModelComponents.initialize();
+        UiFramework.settingsManager.onSettingsProvidersChanged.addListener(() => {
+            SyncUiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.SettingsProvidersChanged);
+        });
+        // Initialize the MessagePresenter interface in UiAdmin for Editor notifications
+        UiAdmin.messagePresenter = IModelApp.notifications;
+        UiFramework._initialized = true;
+        // initialize any standalone settings providers that don't need to have defaults set by iModelApp
+        UiShowHideSettingsProvider.initialize();
+        ConfigurableUiManager.initialize();
+        return frameworkNamespace;
+    }
+    /** Un-registers the UiFramework internationalization service namespace */
+    static terminate() {
+        var _a;
+        UiFramework._store = undefined;
+        UiFramework._frameworkStateKeyInStore = "frameworkState";
+        if (StateManager.isInitialized(true))
+            StateManager.clearStore();
+        // istanbul ignore next
+        (_a = IModelApp.localization) === null || _a === void 0 ? void 0 : _a.unregisterNamespace(UiFramework.localizationNamespace);
+        UiFramework._backstageManager = undefined;
+        UiFramework._widgetManager = undefined;
+        UiFramework._hideIsolateEmphasizeActionHandler = undefined;
+        UiFramework._settingsManager = undefined;
+        UiIModelComponents.terminate();
+        UiShowHideManager.terminate();
+        UiFramework._initialized = false;
+    }
+    /** Determines if UiFramework has been initialized */
+    static get initialized() { return UiFramework._initialized; }
+    /** Property that returns the SettingManager used by AppUI-based applications.
+     *  @public */
+    static get settingsManager() {
+        if (undefined === UiFramework._settingsManager)
+            UiFramework._settingsManager = new SettingsManager();
+        return UiFramework._settingsManager;
+    }
+    /** @public */
+    static get frameworkStateKey() {
+        return UiFramework._frameworkStateKeyInStore;
+    }
+    /** The UiFramework state maintained by Redux
+     * @public
+     */
+    static get frameworkState() {
+        try {
+            // eslint-disable-next-line dot-notation
+            return UiFramework.store.getState()[UiFramework.frameworkStateKey];
+        }
+        catch (_e) {
+            return undefined;
+        }
+    }
+    /** The Redux store */
+    static get store() {
+        if (UiFramework._store)
+            return UiFramework._store;
+        // istanbul ignore else
+        if (!StateManager.isInitialized(true))
+            throw new UiError(UiFramework.loggerCategory(this), `Error trying to access redux store before either store or StateManager has been initialized.`);
+        // istanbul ignore next
+        return StateManager.store;
+    }
+    /** The internationalization service created by the app.
+     * @internal
+    */
+    static get localization() {
+        // istanbul ignore next
+        if (!IModelApp.localization)
+            throw new UiError(UiFramework.loggerCategory(this), `IModelApp.localization has not been defined.`);
+        return IModelApp.localization;
+    }
+    /** The internationalization service namespace. */
+    static get localizationNamespace() {
+        return "UiFramework";
+    }
+    /** @public */
+    static get backstageManager() {
+        // istanbul ignore next
+        if (!UiFramework._backstageManager)
+            throw new UiError(UiFramework.loggerCategory(this), UiFramework._complaint);
+        return UiFramework._backstageManager;
+    }
+    /** @alpha */
+    static get hideIsolateEmphasizeActionHandler() {
+        // istanbul ignore next
+        if (!UiFramework._hideIsolateEmphasizeActionHandler)
+            throw new UiError(UiFramework.loggerCategory(this), UiFramework._complaint);
+        return UiFramework._hideIsolateEmphasizeActionHandler;
+    }
+    /** @alpha */
+    static setHideIsolateEmphasizeActionHandler(handler) {
+        // istanbul ignore else
+        if (handler)
+            UiFramework._hideIsolateEmphasizeActionHandler = handler;
+        else
+            UiFramework._hideIsolateEmphasizeActionHandler = new HideIsolateEmphasizeManager();
+    }
+    /** @alpha */
+    static get widgetManager() {
+        // istanbul ignore next
+        if (!UiFramework._widgetManager)
+            throw new UiError(UiFramework.loggerCategory(this), UiFramework._complaint);
+        return UiFramework._widgetManager;
+    }
+    /** Calls localization.getLocalizedStringWithNamespace with the "UiFramework" namespace. Do NOT include the namespace in the key.
+     * @internal
+     */
+    static translate(key) {
+        return IModelApp.localization.getLocalizedStringWithNamespace(UiFramework.localizationNamespace, key);
+    }
+    /** @internal */
+    static get packageName() {
+        return "appui-react";
+    }
+    /** @internal */
+    static loggerCategory(obj) {
+        const className = getClassName(obj);
+        const category = UiFramework.packageName + (className ? `.${className}` : "");
+        return category;
+    }
+    static dispatchActionToStore(type, payload, immediateSync = false) {
+        UiFramework.store.dispatch({ type, payload });
+        if (immediateSync)
+            SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(type);
+        else
+            SyncUiEventDispatcher.dispatchSyncUiEvent(type);
+    }
+    static setAccudrawSnapMode(snapMode) {
+        UiFramework.dispatchActionToStore(ConfigurableUiActionId.SetSnapMode, snapMode, true);
+    }
+    static getAccudrawSnapMode() {
+        return UiFramework.frameworkState ? UiFramework.frameworkState.configurableUiState.snapMode : /* istanbul ignore next */ SnapMode.NearestKeypoint;
+    }
+    static getActiveSelectionScope() {
+        return UiFramework.frameworkState ? UiFramework.frameworkState.sessionState.activeSelectionScope : /* istanbul ignore next */ "element";
+    }
+    static setActiveSelectionScope(selectionScopeId) {
+        // istanbul ignore else
+        if (UiFramework.frameworkState) {
+            const foundIndex = UiFramework.frameworkState.sessionState.availableSelectionScopes.findIndex((selectionScope) => selectionScope.id === selectionScopeId);
+            if (-1 !== foundIndex) {
+                const scope = UiFramework.frameworkState.sessionState.availableSelectionScopes[foundIndex];
+                UiFramework.dispatchActionToStore(SessionStateActionId.SetSelectionScope, scope.id);
+                Presentation.selection.scopes.activeScope = scope.id;
+            }
+        }
+    }
+    /** @public */
+    static openCursorMenu(menuData) {
+        UiFramework.dispatchActionToStore(SessionStateActionId.UpdateCursorMenu, menuData);
+    }
+    /** @public */
+    static closeCursorMenu() {
+        UiFramework.dispatchActionToStore(SessionStateActionId.UpdateCursorMenu, undefined);
+    }
+    /** @public */
+    static getCursorMenuData() {
+        return UiFramework.frameworkState ? UiFramework.frameworkState.sessionState.cursorMenuData : /* istanbul ignore next */ undefined;
+    }
+    static getActiveIModelId() {
+        return UiFramework.frameworkState ? UiFramework.frameworkState.sessionState.iModelId : /* istanbul ignore next */ "";
+    }
+    static setActiveIModelId(iModelId) {
+        UiFramework.dispatchActionToStore(SessionStateActionId.SetActiveIModelId, iModelId);
+    }
+    static setIModelConnection(iModelConnection, immediateSync = false) {
+        var _a;
+        const oldConnection = UiFramework.getIModelConnection();
+        if (oldConnection !== iModelConnection) {
+            if (oldConnection === null || oldConnection === void 0 ? void 0 : oldConnection.iModelId)
+                FrontstageManager.clearFrontstageDefsForIModelId(oldConnection.iModelId);
+            oldConnection && undefined === iModelConnection && SyncUiEventDispatcher.clearConnectionEvents(oldConnection);
+            iModelConnection && SyncUiEventDispatcher.initializeConnectionEvents(iModelConnection);
+            UiFramework.dispatchActionToStore(SessionStateActionId.SetIModelConnection, iModelConnection, immediateSync);
+        }
+        UiFramework.setActiveIModelId((_a = iModelConnection === null || iModelConnection === void 0 ? void 0 : iModelConnection.iModelId) !== null && _a !== void 0 ? _a : "");
+    }
+    static getIModelConnection() {
+        return UiFramework.frameworkState ? UiFramework.frameworkState.sessionState.iModelConnection : /* istanbul ignore next */ undefined;
+    }
+    /** @public */
+    static async setUiSettingsStorage(storage, immediateSync = false) {
+        if (UiFramework._uiSettingsStorage === storage)
+            return;
+        UiFramework._uiSettingsStorage = storage;
+        // let any registered providers to load values from the new storage location
+        const providerKeys = [...this._uiSettingsProviderRegistry.keys()];
+        for await (const key of providerKeys) {
+            await this._uiSettingsProviderRegistry.get(key).loadUserSettings(storage);
+        }
+        // istanbul ignore next
+        if (immediateSync)
+            SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventId.UiSettingsChanged);
+        else
+            SyncUiEventDispatcher.dispatchSyncUiEvent(SyncUiEventId.UiSettingsChanged);
+    }
+    /** @public */
+    static getUiSettingsStorage() {
+        return UiFramework._uiSettingsStorage;
+    }
+    /** @public */
+    static setUserInfo(userInfo, immediateSync = false) {
+        UiFramework.dispatchActionToStore(SessionStateActionId.SetUserInfo, userInfo, immediateSync);
+    }
+    /** @public */
+    static getUserInfo() {
+        return UiFramework.frameworkState ? UiFramework.frameworkState.sessionState.userInfo : /* istanbul ignore next */ undefined;
+    }
+    static setDefaultIModelViewportControlId(iModelViewportControlId, immediateSync = false) {
+        UiFramework.dispatchActionToStore(SessionStateActionId.SetDefaultIModelViewportControlId, iModelViewportControlId, immediateSync);
+    }
+    static getDefaultIModelViewportControlId() {
+        return UiFramework.frameworkState ? UiFramework.frameworkState.sessionState.defaultIModelViewportControlId : /* istanbul ignore next */ undefined;
+    }
+    static setDefaultViewId(viewId, immediateSync = false) {
+        UiFramework.dispatchActionToStore(SessionStateActionId.SetDefaultViewId, viewId, immediateSync);
+    }
+    static getDefaultViewId() {
+        return UiFramework.frameworkState ? UiFramework.frameworkState.sessionState.defaultViewId : /* istanbul ignore next */ undefined;
+    }
+    static setDefaultViewState(viewState, immediateSync = false) {
+        UiFramework.dispatchActionToStore(SessionStateActionId.SetDefaultViewState, viewState, immediateSync);
+    }
+    static getDefaultViewState() {
+        return UiFramework.frameworkState ? UiFramework.frameworkState.sessionState.defaultViewState : /* istanbul ignore next */ undefined;
+    }
+    /** @public */
+    static getAvailableSelectionScopes() {
+        return UiFramework.frameworkState ?
+            UiFramework.frameworkState.sessionState.availableSelectionScopes :
+            /* istanbul ignore next */
+            [{ id: "element", label: "Element" }];
+    }
+    static getIsUiVisible() {
+        return UiShowHideManager.isUiVisible;
+    }
+    static setIsUiVisible(visible) {
+        if (UiShowHideManager.isUiVisible !== visible) {
+            UiShowHideManager.isUiVisible = visible;
+            UiFramework.onUiVisibilityChanged.emit({ visible });
+        }
+    }
+    static setColorTheme(theme) {
+        if (UiFramework.getColorTheme() === theme)
+            return;
+        UiFramework.dispatchActionToStore(ConfigurableUiActionId.SetTheme, theme, true);
+    }
+    static getColorTheme() {
+        return UiFramework.frameworkState ? UiFramework.frameworkState.configurableUiState.theme : /* istanbul ignore next */ SYSTEM_PREFERRED_COLOR_THEME;
+    }
+    static setWidgetOpacity(opacity) {
+        if (UiFramework.getWidgetOpacity() === opacity)
+            return;
+        UiFramework.dispatchActionToStore(ConfigurableUiActionId.SetWidgetOpacity, opacity, true);
+    }
+    static getWidgetOpacity() {
+        return UiFramework.frameworkState ? UiFramework.frameworkState.configurableUiState.widgetOpacity : /* istanbul ignore next */ WIDGET_OPACITY_DEFAULT;
+    }
+    static isMobile() {
+        return ProcessDetector.isMobileBrowser;
+    }
+    /** Returns the Ui Version.
+     * @public
+     */
+    static get uiVersion() {
+        return UiFramework.frameworkState ? UiFramework.frameworkState.configurableUiState.frameworkVersion : this._uiVersion;
+    }
+    static setUiVersion(version) {
+        if (UiFramework.uiVersion === version)
+            return;
+        UiFramework.dispatchActionToStore(ConfigurableUiActionId.SetFrameworkVersion, version === "1" ? "1" : "2", true);
+    }
+    static get useDragInteraction() {
+        return UiFramework.frameworkState ? UiFramework.frameworkState.configurableUiState.useDragInteraction : false;
+    }
+    static setUseDragInteraction(useDragInteraction) {
+        UiFramework.dispatchActionToStore(ConfigurableUiActionId.SetDragInteraction, useDragInteraction, true);
+    }
+    /** Send logging message to the telemetry system
+     * @internal
+     */
+    // istanbul ignore next
+    static async postTelemetry(eventName, eventId, iTwinId, iModeId, changeSetId, time, additionalProperties) {
+        var _a;
+        if (!IModelApp.authorizationClient)
+            return;
+        try {
+            const activity = {
+                sessionId: IModelApp.sessionId,
+                activityId: "",
+                applicationId: IModelApp.applicationId,
+                applicationVersion: IModelApp.applicationVersion,
+                accessToken: (_a = (await IModelApp.authorizationClient.getAccessToken())) !== null && _a !== void 0 ? _a : "",
+            };
+            const telemetryEvent = new TelemetryEvent(eventName, eventId, iTwinId, iModeId, changeSetId, time, additionalProperties);
+            await IModelApp.telemetry.postTelemetry(activity, telemetryEvent);
+        }
+        catch { }
+    }
+    /** Determines whether a ContextMenu is open
+     * @alpha
+     * */
+    static get isContextMenuOpen() {
+        const contextMenu = document.querySelector("div.core-context-menu-opened");
+        return contextMenu !== null && contextMenu !== undefined;
+    }
+}
+UiFramework._initialized = false;
+UiFramework._complaint = "UiFramework not initialized";
+UiFramework._frameworkStateKeyInStore = "frameworkState"; // default name
+UiFramework._uiVersion = "2";
+UiFramework._uiSettingsStorage = new LocalSettingsStorage(); // this provides a default storage location for settings
+UiFramework._uiSettingsProviderRegistry = new Map();
+UiFramework._PopupWindowManager = new ChildWindowManager();
+UiFramework.useDefaultPopoutUrl = false;
+/** Get Show Ui event.
+ * @public
+ */
+UiFramework.onUiVisibilityChanged = new UiVisibilityChangedEvent();
+UiFramework._handleFrameworkVersionChangedEvent = (args) => {
+    // Log Ui Version used
+    Logger.logInfo(UiFramework.loggerCategory(UiFramework), `Ui Version changed to ${args.version} `);
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    UiFramework.postTelemetry(`Ui Version changed to ${args.version} `, "F2772C81-962D-4755-807C-2D675A5FF399");
+    UiFramework.setUiVersion(args.version);
+};
+//# sourceMappingURL=UiFramework.js.map