@itwin/appui-react 3.0.0-dev.98 → 3.1.0-dev.0

package/CHANGELOG.md

@@ -1,6 +1,85 @@
 # Change Log - @itwin/appui-react
 
-This log was last generated on Tue, 21 Sep 2021 21:06:40 GMT and should not be manually modified.
+This log was last generated on Wed, 12 Jan 2022 14:52:38 GMT and should not be manually modified.
+
+## 2.19.28
+Wed, 12 Jan 2022 14:52:38 GMT
+
+_Version update only_
+
+## 2.19.27
+Wed, 05 Jan 2022 20:07:20 GMT
+
+_Version update only_
+
+## 2.19.26
+Wed, 08 Dec 2021 20:54:53 GMT
+
+_Version update only_
+
+## 2.19.25
+Fri, 03 Dec 2021 20:05:49 GMT
+
+_Version update only_
+
+## 2.19.24
+Mon, 29 Nov 2021 18:44:31 GMT
+
+_Version update only_
+
+## 2.19.23
+Mon, 22 Nov 2021 20:41:40 GMT
+
+_Version update only_
+
+## 2.19.22
+Wed, 17 Nov 2021 01:23:26 GMT
+
+_Version update only_
+
+## 2.19.21
+Wed, 10 Nov 2021 10:58:24 GMT
+
+_Version update only_
+
+## 2.19.20
+Fri, 29 Oct 2021 16:14:22 GMT
+
+_Version update only_
+
+## 2.19.19
+Mon, 25 Oct 2021 16:16:25 GMT
+
+### Updates
+
+- Drop unnecessary dep on @bentley/react-scripts; add a *.d.ts file for svg?sprite loader syntax
+
+## 2.19.18
+Thu, 21 Oct 2021 20:59:44 GMT
+
+_Version update only_
+
+## 2.19.17
+Thu, 14 Oct 2021 21:19:43 GMT
+
+_Version update only_
+
+## 2.19.16
+Mon, 11 Oct 2021 17:37:46 GMT
+
+_Version update only_
+
+## 2.19.15
+Fri, 08 Oct 2021 16:44:23 GMT
+
+_Version update only_
+
+## 2.19.14
+Fri, 01 Oct 2021 13:07:03 GMT
+
+### Updates
+
+- Force Tool Settings to render when the active tool is reloaded.
 
 ## 2.19.13
 Tue, 21 Sep 2021 21:06:40 GMT

package/LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright © 2017-2021 Bentley Systems, Incorporated. All rights reserved.
+Copyright © 2017-2022 Bentley Systems, Incorporated. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/README.md

@@ -6,11 +6,11 @@ Copyright © Bentley Systems, Incorporated. All rights reserved. See LICENSE.md
 
 The __@itwin/appui-react__ package contains application fragments for Login, Project, iModel and View selection, and configuration of the application UI including the Backstage, Frontstages, Widgets, etc.
 
-The ui-framework package is a portion of the iTwin.js User Interface library. It consists of major fragments of code that combine the
-functionality from the imodeljs-frontend and imodeljs client packages with the ui-core, ui-components and ui-ninezone packages to implement substantial
+The AppUI React package is a portion of the iTwin.js User Interface library. It consists of major fragments of code that combine the
+functionality from the `@itwin/core-frontend` with the core-react, imodel-components and appui-layout-react packages to implement substantial
 functionality that can be used within an iTwin.js application.
 
-The ui-framework package makes use of React for rendering of the user interface, and uses react-redux and its concept of the state store for
+The package makes use of React for rendering of the user interface, and uses react-redux and its concept of the state store for
 actions using reducers.
 
 There are a number of sub-frameworks, each which has a set of components, actions, and reducers, and contributes to the overall State. Each such

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

@@ -5,22 +5,26 @@ 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 { UiEvent } from "@itwin/appui-abstract";
+import { SettingsManager, UiStateStorage } 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";
-/** Interface to be implemented but any classes that wants to load their user settings when the UiSetting storage class is set.
+/** 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 UiStateEntry 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>;
+    loadUserSettings(storage: UiStateStorage): Promise<void>;
 }
 /** UiVisibility Event Args interface.
  * @public
@@ -37,8 +41,8 @@ export declare class UiVisibilityChangedEvent extends UiEvent<UiVisibilityEventA
  * @internal
  */
 export interface FrameworkVersionChangedEventArgs {
-    oldVersion: string;
-    version: string;
+    oldVersion: FrameworkVersionId;
+    version: FrameworkVersionId;
 }
 /** FrameworkVersion Changed Event class.
  * @internal
@@ -65,7 +69,8 @@ export declare class UiFramework {
     private static _widgetManager?;
     private static _uiVersion;
     private static _hideIsolateEmphasizeActionHandler?;
-    private static _uiSettingsStorage;
+    /** this provides a default state storage handler */
+    private static _uiStateStorage;
     private static _settingsManager?;
     private static _uiSettingsProviderRegistry;
     private static _PopupWindowManager;
@@ -82,10 +87,6 @@ export declare class UiFramework {
      * @public
      */
     static readonly onUiVisibilityChanged: UiVisibilityChangedEvent;
-    /** Get FrameworkVersion Changed event.
-     * @internal
-     */
-    static readonly onFrameworkVersionChangedEvent: FrameworkVersionChangedEvent;
     /**
      * 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.
@@ -105,7 +106,8 @@ export declare class UiFramework {
     /** Determines if UiFramework has been initialized */
     static get initialized(): boolean;
     /** Property that returns the SettingManager used by AppUI-based applications.
-     *  @public */
+     * @public
+     */
     static get settingsManager(): SettingsManager;
     /** @public */
     static get frameworkStateKey(): string;
@@ -152,14 +154,18 @@ export declare class UiFramework {
     static setActiveIModelId(iModelId: string): void;
     static setIModelConnection(iModelConnection: IModelConnection | undefined, immediateSync?: boolean): void;
     static getIModelConnection(): IModelConnection | undefined;
+    /** Called by iModelApp to initialize saved UI state from registered UseSettingsProviders
+     * @public
+     */
+    static initializeStateFromUserSettingsProviders(immediateSync?: boolean): Promise<void>;
     /** @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 setUiStateStorage(storage: UiStateStorage, immediateSync?: boolean): Promise<void>;
+    /** The UI Settings Storage is a convenient wrapper around Local Storage to assist in caching state information across user sessions.
+     * It was previously used to conflate both the state information across session and the information driven directly from user explicit action,
+     * which are now handled with user preferences.
+     * @public
+     */
+    static getUiStateStorage(): UiStateStorage;
     static setDefaultIModelViewportControlId(iModelViewportControlId: string, immediateSync?: boolean): void;
     static getDefaultIModelViewportControlId(): string | undefined;
     static setDefaultViewId(viewId: string, immediateSync?: boolean): void;
@@ -178,17 +184,26 @@ export declare class UiFramework {
     /** Returns the Ui Version.
      * @public
      */
-    static get uiVersion(): string;
-    static setUiVersion(version: string): void;
+    static get uiVersion(): FrameworkVersionId;
+    static setUiVersion(version: FrameworkVersionId): void;
+    static get showWidgetIcon(): boolean;
+    static setShowWidgetIcon(value: boolean): void;
     static get useDragInteraction(): boolean;
     static setUseDragInteraction(useDragInteraction: boolean): void;
+    /** Returns the variable controlling whether the overlay is displayed in a Viewport
+     * @public
+     */
+    static get viewOverlayDisplay(): boolean;
+    /** Set the variable that controls display of the view overlay. Applies to all viewports in the app
+   * @public
+   */
+    static setViewOverlayDisplay(display: 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
      * */

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

@@ -1 +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,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,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;CACjB;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,CAAM;IAC/B,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;;OAEG;IACH,gBAAuB,8BAA8B,+BAAsC;IAE3F;;;;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;IAmD1G,0EAA0E;WAC5D,SAAS;IAkBvB,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,MAAM,CAEpC;WAEa,YAAY,CAAC,OAAO,EAAE,MAAM;IAO1C,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"}
+{"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;AAGxF,OAAO,EAAkC,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChF,OAAO,EAAqB,eAAe,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEvF,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;AAQzH,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,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1D;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,oDAAoD;IACpD,OAAO,CAAC,MAAM,CAAC,eAAe,CAA2C;IACzE,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;;OAEG;IACH,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;;OAEG;WACiB,wCAAwC,CAAC,aAAa,UAAQ;IAclF,cAAc;WACM,iBAAiB,CAAC,OAAO,EAAE,cAAc,EAAE,aAAa,UAAQ;IAQpF;;;;OAIG;WACW,iBAAiB,IAAI,cAAc;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,cAAc,IAAI,OAAO,CAE1C;WAEa,iBAAiB,CAAC,KAAK,EAAE,OAAO;IAO9C,WAAkB,kBAAkB,IAAI,OAAO,CAE9C;WAEa,qBAAqB,CAAC,kBAAkB,EAAE,OAAO;IAI/D;;OAEG;IACH,WAAkB,kBAAkB,YAEnC;IACD;;KAEC;WACa,qBAAqB,CAAC,OAAO,EAAE,OAAO;IAKpD;;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;;SAEK;IACL,WAAkB,iBAAiB,IAAI,OAAO,CAG7C;CACF"}

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

@@ -11,7 +11,7 @@ exports.UiFramework = exports.FrameworkVersionChangedEvent = exports.UiVisibilit
 const core_bentley_1 = require("@itwin/core-bentley");
 const core_frontend_1 = require("@itwin/core-frontend");
 const presentation_frontend_1 = require("@itwin/presentation-frontend");
-const telemetry_client_1 = require("@bentley/telemetry-client");
+const core_telemetry_1 = require("@itwin/core-telemetry");
 const appui_abstract_1 = require("@itwin/appui-abstract");
 const core_react_1 = require("@itwin/core-react");
 const imodel_components_react_1 = require("@itwin/imodel-components-react");
@@ -34,13 +34,13 @@ const FrontstageManager_1 = require("./frontstage/FrontstageManager");
 /** UiVisibility Event class.
  * @public
  */
-class UiVisibilityChangedEvent extends core_react_1.UiEvent {
+class UiVisibilityChangedEvent extends appui_abstract_1.UiEvent {
 }
 exports.UiVisibilityChangedEvent = UiVisibilityChangedEvent;
 /** FrameworkVersion Changed Event class.
  * @internal
  */
-class FrameworkVersionChangedEvent extends core_react_1.UiEvent {
+class FrameworkVersionChangedEvent extends appui_abstract_1.UiEvent {
 }
 exports.FrameworkVersionChangedEvent = FrameworkVersionChangedEvent;
 /**
@@ -103,7 +103,6 @@ class UiFramework {
         UiFramework._backstageManager = new BackstageManager_1.BackstageManager();
         UiFramework._hideIsolateEmphasizeActionHandler = new HideIsolateEmphasizeManager_1.HideIsolateEmphasizeManager(); // this allows user to override the default HideIsolateEmphasizeManager implementation.
         UiFramework._widgetManager = new WidgetManager_1.WidgetManager();
-        UiFramework.onFrameworkVersionChangedEvent.addListener(UiFramework._handleFrameworkVersionChangedEvent);
         // Initialize ui-imodel-components, ui-components, ui-core & ui-abstract
         await imodel_components_react_1.UiIModelComponents.initialize();
         UiFramework.settingsManager.onSettingsProvidersChanged.addListener(() => {
@@ -119,16 +118,17 @@ class UiFramework {
     }
     /** Un-registers the UiFramework internationalization service namespace */
     static terminate() {
+        var _a;
         UiFramework._store = undefined;
         UiFramework._frameworkStateKeyInStore = "frameworkState";
         if (StateManager_1.StateManager.isInitialized(true))
             StateManager_1.StateManager.clearStore();
-        core_frontend_1.IModelApp.localization.unregisterNamespace(UiFramework.localizationNamespace);
+        // istanbul ignore next
+        (_a = core_frontend_1.IModelApp.localization) === null || _a === void 0 ? void 0 : _a.unregisterNamespace(UiFramework.localizationNamespace);
         UiFramework._backstageManager = undefined;
         UiFramework._widgetManager = undefined;
         UiFramework._hideIsolateEmphasizeActionHandler = undefined;
         UiFramework._settingsManager = undefined;
-        UiFramework.onFrameworkVersionChangedEvent.removeListener(UiFramework._handleFrameworkVersionChangedEvent);
         imodel_components_react_1.UiIModelComponents.terminate();
         UiShowHideManager_1.UiShowHideManager.terminate();
         UiFramework._initialized = false;
@@ -136,7 +136,8 @@ class UiFramework {
     /** Determines if UiFramework has been initialized */
     static get initialized() { return UiFramework._initialized; }
     /** Property that returns the SettingManager used by AppUI-based applications.
-     *  @public */
+     * @public
+     */
     static get settingsManager() {
         if (undefined === UiFramework._settingsManager)
             UiFramework._settingsManager = new core_react_1.SettingsManager();
@@ -286,33 +287,35 @@ class UiFramework {
     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;
+    /** Called by iModelApp to initialize saved UI state from registered UseSettingsProviders
+     * @public
+     */
+    static async initializeStateFromUserSettingsProviders(immediateSync = false) {
         // 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);
+            await this._uiSettingsProviderRegistry.get(key).loadUserSettings(UiFramework._uiStateStorage);
         }
         // istanbul ignore next
         if (immediateSync)
-            SyncUiEventDispatcher_1.SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventDispatcher_1.SyncUiEventId.UiSettingsChanged);
+            SyncUiEventDispatcher_1.SyncUiEventDispatcher.dispatchImmediateSyncUiEvent(SyncUiEventDispatcher_1.SyncUiEventId.UiStateStorageChanged);
         else
-            SyncUiEventDispatcher_1.SyncUiEventDispatcher.dispatchSyncUiEvent(SyncUiEventDispatcher_1.SyncUiEventId.UiSettingsChanged);
-    }
-    /** @public */
-    static getUiSettingsStorage() {
-        return UiFramework._uiSettingsStorage;
+            SyncUiEventDispatcher_1.SyncUiEventDispatcher.dispatchSyncUiEvent(SyncUiEventDispatcher_1.SyncUiEventId.UiStateStorageChanged);
     }
     /** @public */
-    static setUserInfo(userInfo, immediateSync = false) {
-        UiFramework.dispatchActionToStore(SessionState_1.SessionStateActionId.SetUserInfo, userInfo, immediateSync);
+    static async setUiStateStorage(storage, immediateSync = false) {
+        if (UiFramework._uiStateStorage === storage)
+            return;
+        UiFramework._uiStateStorage = storage;
+        await this.initializeStateFromUserSettingsProviders(immediateSync);
     }
-    /** @public */
-    static getUserInfo() {
-        return UiFramework.frameworkState ? UiFramework.frameworkState.sessionState.userInfo : /* istanbul ignore next */ undefined;
+    /** The UI Settings Storage is a convenient wrapper around Local Storage to assist in caching state information across user sessions.
+     * It was previously used to conflate both the state information across session and the information driven directly from user explicit action,
+     * which are now handled with user preferences.
+     * @public
+     */
+    static getUiStateStorage() {
+        return UiFramework._uiStateStorage;
     }
     static setDefaultIModelViewportControlId(iModelViewportControlId, immediateSync = false) {
         UiFramework.dispatchActionToStore(SessionState_1.SessionStateActionId.SetDefaultIModelViewportControlId, iModelViewportControlId, immediateSync);
@@ -378,12 +381,34 @@ class UiFramework {
             return;
         UiFramework.dispatchActionToStore(state_1.ConfigurableUiActionId.SetFrameworkVersion, version === "1" ? "1" : "2", true);
     }
+    static get showWidgetIcon() {
+        return UiFramework.frameworkState ? UiFramework.frameworkState.configurableUiState.showWidgetIcon : /* istanbul ignore next */ false;
+    }
+    static setShowWidgetIcon(value) {
+        if (UiFramework.showWidgetIcon === value)
+            return;
+        UiFramework.dispatchActionToStore(state_1.ConfigurableUiActionId.SetShowWidgetIcon, value, true);
+    }
     static get useDragInteraction() {
         return UiFramework.frameworkState ? UiFramework.frameworkState.configurableUiState.useDragInteraction : false;
     }
     static setUseDragInteraction(useDragInteraction) {
         UiFramework.dispatchActionToStore(state_1.ConfigurableUiActionId.SetDragInteraction, useDragInteraction, true);
     }
+    /** Returns the variable controlling whether the overlay is displayed in a Viewport
+     * @public
+     */
+    static get viewOverlayDisplay() {
+        return UiFramework.frameworkState ? UiFramework.frameworkState.configurableUiState.viewOverlayDisplay : /* istanbul ignore next */ true;
+    }
+    /** Set the variable that controls display of the view overlay. Applies to all viewports in the app
+   * @public
+   */
+    static setViewOverlayDisplay(display) {
+        if (UiFramework.viewOverlayDisplay === display)
+            return;
+        UiFramework.dispatchActionToStore(state_1.ConfigurableUiActionId.SetViewOverlayDisplay, display);
+    }
     /** Send logging message to the telemetry system
      * @internal
      */
@@ -400,7 +425,7 @@ class UiFramework {
                 applicationVersion: core_frontend_1.IModelApp.applicationVersion,
                 accessToken: (_a = (await core_frontend_1.IModelApp.authorizationClient.getAccessToken())) !== null && _a !== void 0 ? _a : "",
             };
-            const telemetryEvent = new telemetry_client_1.TelemetryEvent(eventName, eventId, iTwinId, iModeId, changeSetId, time, additionalProperties);
+            const telemetryEvent = new core_telemetry_1.TelemetryEvent(eventName, eventId, iTwinId, iModeId, changeSetId, time, additionalProperties);
             await core_frontend_1.IModelApp.telemetry.postTelemetry(activity, telemetryEvent);
         }
         catch { }
@@ -417,8 +442,9 @@ exports.UiFramework = UiFramework;
 UiFramework._initialized = false;
 UiFramework._complaint = "UiFramework not initialized";
 UiFramework._frameworkStateKeyInStore = "frameworkState"; // default name
-UiFramework._uiVersion = "";
-UiFramework._uiSettingsStorage = new core_react_1.LocalSettingsStorage(); // this provides a default storage location for settings
+UiFramework._uiVersion = "2";
+/** this provides a default state storage handler */
+UiFramework._uiStateStorage = new core_react_1.LocalStateStorage();
 UiFramework._uiSettingsProviderRegistry = new Map();
 UiFramework._PopupWindowManager = new ChildWindowManager_1.ChildWindowManager();
 UiFramework.useDefaultPopoutUrl = false;
@@ -426,15 +452,4 @@ UiFramework.useDefaultPopoutUrl = false;
  * @public
  */
 UiFramework.onUiVisibilityChanged = new UiVisibilityChangedEvent();
-/** Get FrameworkVersion Changed event.
- * @internal
- */
-UiFramework.onFrameworkVersionChangedEvent = new FrameworkVersionChangedEvent();
-UiFramework._handleFrameworkVersionChangedEvent = (args) => {
-    // Log Ui Version used
-    core_bentley_1.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