@itwin/appui-react 4.14.1 → 4.15.0

package/lib/esm/appui-react/redux/SessionState.d.ts

@@ -4,9 +4,18 @@
 import type { XAndY } from "@itwin/core-geometry";
 import type { CursorMenuItemProps, MenuItemProps } from "../shared/MenuItem";
 import type { ActionsUnion, DeepReadonly } from "./redux-ts";
+/** Definition of a cursor menu. If menuItems are empty the menu control is not displayed.
+ * @public
+ */
+export interface CursorMenuPayload {
+    position: XAndY;
+    childWindowId?: string;
+    items: CursorMenuItemProps[];
+}
 /** PresentationSelectionScope holds the id and the localized label for a selection scope supported for a specific iModel.
  * Added to avoid an api-extract error caused by using SelectionScope.
  * @public
+ * @deprecated in 4.15.0. Use `selectionScopes` prop of {@link SelectionScopeField} component.
  */
 export interface PresentationSelectionScope {
     id: string;
@@ -15,26 +24,18 @@ export interface PresentationSelectionScope {
 /** Definition of data added to Redux store to define cursor menu.  If menuItems are empty the menu control is not displayed.
  * To close the menu clear the menuItems or pass in undefined as the CursorData.
  * @public
- * @deprecated in 4.11.x use {@link CursorMenuPayload} instead.
+ * @deprecated in 4.11.0. Use {@link CursorMenuPayload} instead.
  */
 export interface CursorMenuData {
     position: XAndY;
     childWindowId?: string;
     items: MenuItemProps[];
 }
-/**
- * Definition of data added to Redux store to define cursor menu.  If menuItems are empty the menu control is not displayed.
- * To close the menu clear the menuItems or pass in undefined as the CursorData.
- * @public
- */
-export interface CursorMenuPayload {
-    position: XAndY;
-    childWindowId?: string;
-    items: CursorMenuItemProps[];
-}
 /** Action Ids used by Redux and to send sync UI components. Typically used to refresh visibility or enable state of control.
- *  Since these are also used as sync ids they should be in lowercase.
+ * Since these are also used as sync ids they should be in lowercase.
+ * @note This is used by sync UI event APIs.
  * @public
+ * @deprecated in 4.15.0. Use your preferred state management library instead.
  */
 export declare enum SessionStateActionId {
     SetNumItemsSelected = "sessionstate:set-num-items-selected",
@@ -49,21 +50,33 @@ export declare enum SessionStateActionId {
 }
 /** The portion of state managed by the SessionStateReducer.
  * @public
+ * @deprecated in 4.15.0. Use your preferred state management library instead.
  */
 export interface SessionState {
+    /** @deprecated in 4.15.0. Use {@link UiFramework.getNumItemsSelected} instead. */
     numItemsSelected: number;
+    /** @deprecated in 4.15.0. Use `selectionScopes` prop of {@link SelectionScopeField} instead. */
     availableSelectionScopes: PresentationSelectionScope[];
+    /** @deprecated in 4.15.0. Use `activeScope` prop of {@link SelectionScopeField} instead. */
     activeSelectionScope: string;
+    /** @deprecated in 4.15.0. Not used by AppUI components. */
     iModelId: string;
+    /** @deprecated in 4.15.0. Not used by AppUI components. */
     defaultIModelViewportControlId: string | undefined;
+    /** @deprecated in 4.15.0. Not used by AppUI components. */
     defaultViewId: string | undefined;
+    /** @deprecated in 4.15.0. Use {@link UiFramework.getDefaultViewState} or {@link useActiveIModelConnection} instead. */
     defaultViewState: any;
+    /** @deprecated in 4.15.0. Use {@link UiFramework.getIModelConnection} or {@link useActiveIModelConnection} instead. */
     iModelConnection: any;
+    /** @deprecated in 4.11.0. Use {@link CursorMenuPayload} instead */
     cursorMenuData: CursorMenuData | undefined;
+    /** @deprecated in 4.15.0. Use cursor APIs of {@link UiFramework}. */
     cursorMenuPayload: CursorMenuPayload | undefined;
 }
 /** An interface that allows redux connected object to dispatch changes to the SessionState reducer.
  * @beta
+ * @deprecated in 4.15.0. Use your preferred state management library instead.
  */
 export interface SessionStateActionsProps {
     setActiveIModelId: typeof SessionStateActions.setActiveIModelId;
@@ -78,6 +91,7 @@ export interface SessionStateActionsProps {
 }
 /** An object with a function that creates each SessionStateReducer that can be handled by our reducer.
  * @public
+ * @deprecated in 4.15.0. Use your preferred state management library instead.
  */
 export declare const SessionStateActions: {
     setActiveIModelId: (iModelId: string) => import("./redux-ts").ActionWithPayload<SessionStateActionId.SetActiveIModelId, string>;
@@ -93,6 +107,7 @@ export declare const SessionStateActions: {
 /** Object that contains available actions that modify SessionState. Parent control's props should
  * extend from SessionStateActionsProps before using this in Redux 'connect' function.
  * @beta
+ * @deprecated in 4.15.0. Use your preferred state management library instead.
  */
 export declare const sessionStateMapDispatchToProps: {
     setActiveIModelId: (iModelId: string) => import("./redux-ts").ActionWithPayload<SessionStateActionId.SetActiveIModelId, string>;
@@ -107,10 +122,12 @@ export declare const sessionStateMapDispatchToProps: {
 };
 /** Union of SessionState Redux actions
  * @public
+ * @deprecated in 4.15.0. Use your preferred state management library instead.
  */
 export type SessionStateActionsUnion = ActionsUnion<typeof SessionStateActions>;
 /** Handles actions to update SessionState.
  * @public
+ * @deprecated in 4.15.0. Use your preferred state management library instead.
  */
 export declare function SessionStateReducer(state: SessionState | undefined, action: SessionStateActionsUnion): DeepReadonly<SessionState>;
 //# sourceMappingURL=SessionState.d.ts.map

package/lib/esm/appui-react/redux/SessionState.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SessionState.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/redux/SessionState.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAElD,OAAO,KAAK,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC7E,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAI7D;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,KAAK,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,KAAK,EAAE,aAAa,EAAE,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,KAAK,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,mBAAmB,EAAE,CAAC;CAC9B;AAED;;;GAGG;AACH,oBAAY,oBAAoB;IAC9B,mBAAmB,wCAAwC;IAC3D,2BAA2B,gDAAgD;IAC3E,iBAAiB,qCAAqC;IACtD,iBAAiB,qCAAqC;IACtD,mBAAmB,uCAAuC;IAC1D,iCAAiC,wCAAwC;IACzE,gBAAgB,oCAAoC;IACpD,mBAAmB,wCAAwC;IAC3D,gBAAgB,oCAAoC;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,gBAAgB,EAAE,MAAM,CAAC;IACzB,wBAAwB,EAAE,0BAA0B,EAAE,CAAC;IACvD,oBAAoB,EAAE,MAAM,CAAC;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,8BAA8B,EAAE,MAAM,GAAG,SAAS,CAAC;IACnD,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,gBAAgB,EAAE,GAAG,CAAC;IACtB,gBAAgB,EAAE,GAAG,CAAC;IAEtB,cAAc,EAAE,cAAc,GAAG,SAAS,CAAC;IAC3C,iBAAiB,EAAE,iBAAiB,GAAG,SAAS,CAAC;CAClD;AAyBD;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,iBAAiB,EAAE,OAAO,mBAAmB,CAAC,iBAAiB,CAAC;IAChE,2BAA2B,EAAE,OAAO,mBAAmB,CAAC,2BAA2B,CAAC;IACpF,iCAAiC,EAAE,OAAO,mBAAmB,CAAC,iCAAiC,CAAC;IAChG,gBAAgB,EAAE,OAAO,mBAAmB,CAAC,gBAAgB,CAAC;IAC9D,mBAAmB,EAAE,OAAO,mBAAmB,CAAC,mBAAmB,CAAC;IACpE,mBAAmB,EAAE,OAAO,mBAAmB,CAAC,mBAAmB,CAAC;IACpE,mBAAmB,EAAE,OAAO,mBAAmB,CAAC,mBAAmB,CAAC;IACpE,iBAAiB,EAAE,OAAO,mBAAmB,CAAC,iBAAiB,CAAC;IAChE,gBAAgB,EAAE,OAAO,mBAAmB,CAAC,gBAAgB,CAAC;CAC/D;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB;kCACA,MAAM;4DAGR,0BAA0B,EAAE;iEAMK,MAAM;+BAKxC,MAAM;qCAEA,GAAG;uCAED,MAAM;4CAED,GAAG;8CAED,MAAM;uCAI7B,cAAc,GAAG,iBAAiB;CAEtD,CAAC;AAEF;;;GAGG;AAEH,eAAO,MAAM,8BAA8B;kCAnCX,MAAM;4DAGR,0BAA0B,EAAE;iEAMK,MAAM;+BAKxC,MAAM;qCAEA,GAAG;uCAED,MAAM;4CAED,GAAG;8CAED,MAAM;uCAI7B,cAAc,GAAG,iBAAiB;CASiB,CAAC;AAEzE;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,YAAY,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhF;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,0BAA6B,EAClC,MAAM,EAAE,wBAAwB,GAC/B,YAAY,CAAC,YAAY,CAAC,CAgD5B"}
+{"version":3,"file":"SessionState.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/redux/SessionState.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,KAAK,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC7E,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAM7D;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,KAAK,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,mBAAmB,EAAE,CAAC;CAC9B;AAID;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,KAAK,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,aAAa,EAAE,CAAC;CACxB;AAED;;;;;GAKG;AACH,oBAAY,oBAAoB;IAC9B,mBAAmB,wCAAwC;IAC3D,2BAA2B,gDAAgD;IAC3E,iBAAiB,qCAAqC;IACtD,iBAAiB,qCAAqC;IACtD,mBAAmB,uCAAuC;IAC1D,iCAAiC,wCAAwC;IACzE,gBAAgB,oCAAoC;IACpD,mBAAmB,wCAAwC;IAC3D,gBAAgB,oCAAoC;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,kFAAkF;IAClF,gBAAgB,EAAE,MAAM,CAAC;IACzB,gGAAgG;IAChG,wBAAwB,EAAE,0BAA0B,EAAE,CAAC;IACvD,4FAA4F;IAC5F,oBAAoB,EAAE,MAAM,CAAC;IAC7B,2DAA2D;IAC3D,QAAQ,EAAE,MAAM,CAAC;IACjB,2DAA2D;IAC3D,8BAA8B,EAAE,MAAM,GAAG,SAAS,CAAC;IACnD,2DAA2D;IAC3D,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,uHAAuH;IACvH,gBAAgB,EAAE,GAAG,CAAC;IACtB,uHAAuH;IACvH,gBAAgB,EAAE,GAAG,CAAC;IACtB,mEAAmE;IACnE,cAAc,EAAE,cAAc,GAAG,SAAS,CAAC;IAC3C,qEAAqE;IACrE,iBAAiB,EAAE,iBAAiB,GAAG,SAAS,CAAC;CAClD;AAyBD;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,iBAAiB,EAAE,OAAO,mBAAmB,CAAC,iBAAiB,CAAC;IAChE,2BAA2B,EAAE,OAAO,mBAAmB,CAAC,2BAA2B,CAAC;IACpF,iCAAiC,EAAE,OAAO,mBAAmB,CAAC,iCAAiC,CAAC;IAChG,gBAAgB,EAAE,OAAO,mBAAmB,CAAC,gBAAgB,CAAC;IAC9D,mBAAmB,EAAE,OAAO,mBAAmB,CAAC,mBAAmB,CAAC;IACpE,mBAAmB,EAAE,OAAO,mBAAmB,CAAC,mBAAmB,CAAC;IACpE,mBAAmB,EAAE,OAAO,mBAAmB,CAAC,mBAAmB,CAAC;IACpE,iBAAiB,EAAE,OAAO,mBAAmB,CAAC,iBAAiB,CAAC;IAChE,gBAAgB,EAAE,OAAO,mBAAmB,CAAC,gBAAgB,CAAC;CAC/D;AAED;;;GAGG;AACH,eAAO,MAAM,mBAAmB;kCACA,MAAM;4DAGR,0BAA0B,EAAE;iEAMK,MAAM;+BAKxC,MAAM;qCAEA,GAAG;uCAED,MAAM;4CAED,GAAG;8CAED,MAAM;uCAEb,cAAc,GAAG,iBAAiB;CAEtE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,8BAA8B;kCAjCX,MAAM;4DAGR,0BAA0B,EAAE;iEAMK,MAAM;+BAKxC,MAAM;qCAEA,GAAG;uCAED,MAAM;4CAED,GAAG;8CAED,MAAM;uCAEb,cAAc,GAAG,iBAAiB;CASC,CAAC;AAEzE;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,YAAY,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhF;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,0BAAoC,EACzC,MAAM,EAAE,wBAAwB,GAC/B,YAAY,CAAC,YAAY,CAAC,CA+C5B"}

package/lib/esm/appui-react/redux/SessionState.js

@@ -7,8 +7,10 @@
  */
 import { createAction } from "./redux-ts";
 /** Action Ids used by Redux and to send sync UI components. Typically used to refresh visibility or enable state of control.
- *  Since these are also used as sync ids they should be in lowercase.
+ * Since these are also used as sync ids they should be in lowercase.
+ * @note This is used by sync UI event APIs.
  * @public
+ * @deprecated in 4.15.0. Use your preferred state management library instead.
  */
 export var SessionStateActionId;
 (function (SessionStateActionId) {
@@ -26,8 +28,8 @@ const defaultSelectionScope = {
     id: "element",
     label: "Element",
 };
-/** used on first call of SessionStateReducer */
-const initialState = {
+/** Used on first call of SessionStateReducer. */
+const initialSessionState = {
     /** number of selected items in Presentation Selection */
     numItemsSelected: 0,
     /** initialize to only support "Element" scope, this will be overwritten when iModelConnection is established */
@@ -40,11 +42,12 @@ const initialState = {
     defaultViewId: undefined,
     defaultViewState: undefined,
     iModelConnection: undefined,
-    cursorMenuData: undefined, // @deprecated in 4.11.x use {@link SessionState.cursorMenuPayload} instead
+    cursorMenuData: undefined, // @deprecated in 4.11.0. Use {@link SessionState.cursorMenuPayload} instead
     cursorMenuPayload: undefined,
 };
 /** An object with a function that creates each SessionStateReducer that can be handled by our reducer.
  * @public
+ * @deprecated in 4.15.0. Use your preferred state management library instead.
  */
 export const SessionStateActions = {
     setActiveIModelId: (iModelId) => createAction(SessionStateActionId.SetActiveIModelId, iModelId),
@@ -55,20 +58,19 @@ export const SessionStateActions = {
     setNumItemsSelected: (numSelected) => createAction(SessionStateActionId.SetNumItemsSelected, numSelected),
     setIModelConnection: (iModelConnection) => createAction(SessionStateActionId.SetIModelConnection, iModelConnection),
     setSelectionScope: (activeSelectionScope) => createAction(SessionStateActionId.SetSelectionScope, activeSelectionScope),
-    updateCursorMenu: 
-    // eslint-disable-next-line deprecation/deprecation
-    (cursorMenuData) => createAction(SessionStateActionId.UpdateCursorMenu, cursorMenuData),
+    updateCursorMenu: (cursorMenuData) => createAction(SessionStateActionId.UpdateCursorMenu, cursorMenuData),
 };
 /** Object that contains available actions that modify SessionState. Parent control's props should
  * extend from SessionStateActionsProps before using this in Redux 'connect' function.
  * @beta
+ * @deprecated in 4.15.0. Use your preferred state management library instead.
  */
-// ...SessionStateActionsProps
 export const sessionStateMapDispatchToProps = { ...SessionStateActions };
 /** Handles actions to update SessionState.
  * @public
+ * @deprecated in 4.15.0. Use your preferred state management library instead.
  */
-export function SessionStateReducer(state = initialState, action) {
+export function SessionStateReducer(state = initialSessionState, action) {
     switch (action.type) {
         case SessionStateActionId.SetNumItemsSelected: {
             if (undefined !== action.payload)
@@ -112,7 +114,6 @@ export function SessionStateReducer(state = initialState, action) {
             return {
                 ...state,
                 cursorMenuPayload: action.payload,
-                // eslint-disable-next-line deprecation/deprecation
                 cursorMenuData: action.payload,
             };
         }

package/lib/esm/appui-react/redux/SessionState.js.map

@@ -1 +1 @@
-{"version":3,"file":"SessionState.js","sourceRoot":"","sources":["../../../../src/appui-react/redux/SessionState.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAOH,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAmC1C;;;GAGG;AACH,MAAM,CAAN,IAAY,oBAUX;AAVD,WAAY,oBAAoB;IAC9B,mFAA2D,CAAA;IAC3D,mGAA2E,CAAA;IAC3E,8EAAsD,CAAA;IACtD,8EAAsD,CAAA;IACtD,kFAA0D,CAAA;IAC1D,iGAAyE,CAAA;IACzE,4EAAoD,CAAA;IACpD,mFAA2D,CAAA;IAC3D,4EAAoD,CAAA;AACtD,CAAC,EAVW,oBAAoB,KAApB,oBAAoB,QAU/B;AAmBD,MAAM,qBAAqB,GAAG;IAC5B,EAAE,EAAE,SAAS;IACb,KAAK,EAAE,SAAS;CACa,CAAC;AAEhC,gDAAgD;AAChD,MAAM,YAAY,GAAiB;IACjC,yDAAyD;IACzD,gBAAgB,EAAE,CAAC;IACnB,gHAAgH;IAChH,wBAAwB,EAAE,CAAC,qBAAqB,CAAC;IACjD,uHAAuH;IACvH,oBAAoB,EAAE,qBAAqB,CAAC,EAAE;IAC9C,uGAAuG;IACvG,QAAQ,EAAE,EAAE;IACZ,8BAA8B,EAAE,SAAS;IACzC,aAAa,EAAE,SAAS;IACxB,gBAAgB,EAAE,SAAS;IAC3B,gBAAgB,EAAE,SAAS;IAC3B,cAAc,EAAE,SAAS,EAAE,2EAA2E;IACtG,iBAAiB,EAAE,SAAS;CAC7B,CAAC;AAiBF;;GAEG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,iBAAiB,EAAE,CAAC,QAAgB,EAAE,EAAE,CACtC,YAAY,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,QAAQ,CAAC;IAChE,2BAA2B,EAAE,CAC3B,wBAAsD,EACtD,EAAE,CACF,YAAY,CACV,oBAAoB,CAAC,2BAA2B,EAChD,wBAAwB,CACzB;IACH,iCAAiC,EAAE,CAAC,uBAA+B,EAAE,EAAE,CACrE,YAAY,CACV,oBAAoB,CAAC,iCAAiC,EACtD,uBAAuB,CACxB;IACH,gBAAgB,EAAE,CAAC,MAAc,EAAE,EAAE,CACnC,YAAY,CAAC,oBAAoB,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAC7D,mBAAmB,EAAE,CAAC,SAAc,EAAE,EAAE,CACtC,YAAY,CAAC,oBAAoB,CAAC,mBAAmB,EAAE,SAAS,CAAC;IACnE,mBAAmB,EAAE,CAAC,WAAmB,EAAE,EAAE,CAC3C,YAAY,CAAC,oBAAoB,CAAC,mBAAmB,EAAE,WAAW,CAAC;IACrE,mBAAmB,EAAE,CAAC,gBAAqB,EAAE,EAAE,CAC7C,YAAY,CAAC,oBAAoB,CAAC,mBAAmB,EAAE,gBAAgB,CAAC;IAC1E,iBAAiB,EAAE,CAAC,oBAA4B,EAAE,EAAE,CAClD,YAAY,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,oBAAoB,CAAC;IAC5E,gBAAgB;IACd,mDAAmD;IACnD,CAAC,cAAkD,EAAE,EAAE,CACrD,YAAY,CAAC,oBAAoB,CAAC,gBAAgB,EAAE,cAAc,CAAC;CACxE,CAAC;AAEF;;;GAGG;AACH,8BAA8B;AAC9B,MAAM,CAAC,MAAM,8BAA8B,GAAG,EAAE,GAAG,mBAAmB,EAAE,CAAC;AAOzE;;GAEG;AACH,MAAM,UAAU,mBAAmB,CACjC,QAAsB,YAAY,EAClC,MAAgC;IAEhC,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;QACpB,KAAK,oBAAoB,CAAC,mBAAmB,CAAC,CAAC,CAAC;YAC9C,IAAI,SAAS,KAAK,MAAM,CAAC,OAAO;gBAC9B,OAAO,EAAE,GAAG,KAAK,EAAE,gBAAgB,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;;gBACnD,OAAO,EAAE,GAAG,KAAK,EAAE,gBAAgB,EAAE,CAAC,EAAE,CAAC;QAChD,CAAC;QACD,KAAK,oBAAoB,CAAC,2BAA2B,CAAC,CAAC,CAAC;YACtD,MAAM,YAAY,GAAiC,EAAE,CAAC;YACtD,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;YAC5D,IAAI,SAAS,KAAK,MAAM,CAAC,OAAO;gBAC9B,OAAO,EAAE,GAAG,KAAK,EAAE,wBAAwB,EAAE,YAAY,EAAE,CAAC;;gBAE5D,OAAO,EAAE,GAAG,KAAK,EAAE,wBAAwB,EAAE,CAAC,qBAAqB,CAAC,EAAE,CAAC;QAC3E,CAAC;QACD,KAAK,oBAAoB,CAAC,iBAAiB,CAAC,CAAC,CAAC;YAC5C,IAAI,SAAS,KAAK,MAAM,CAAC,OAAO;gBAC9B,OAAO,EAAE,GAAG,KAAK,EAAE,oBAAoB,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;;gBACvD,OAAO,EAAE,GAAG,KAAK,EAAE,oBAAoB,EAAE,qBAAqB,CAAC,EAAE,EAAE,CAAC;QAC3E,CAAC;QACD,KAAK,oBAAoB,CAAC,iBAAiB,CAAC,CAAC,CAAC;YAC5C,IAAI,SAAS,KAAK,MAAM,CAAC,OAAO;gBAC9B,OAAO,EAAE,GAAG,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;;gBAC3C,OAAO,EAAE,GAAG,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;QACzC,CAAC;QACD,KAAK,oBAAoB,CAAC,iCAAiC,CAAC,CAAC,CAAC;YAC5D,OAAO,EAAE,GAAG,KAAK,EAAE,8BAA8B,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;QACtE,CAAC;QACD,KAAK,oBAAoB,CAAC,gBAAgB,CAAC,CAAC,CAAC;YAC3C,OAAO,EAAE,GAAG,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;QACrD,CAAC;QACD,KAAK,oBAAoB,CAAC,mBAAmB,CAAC,CAAC,CAAC;YAC9C,OAAO,EAAE,GAAG,KAAK,EAAE,gBAAgB,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;QACxD,CAAC;QACD,KAAK,oBAAoB,CAAC,mBAAmB,CAAC,CAAC,CAAC;YAC9C,OAAO,EAAE,GAAG,KAAK,EAAE,gBAAgB,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;QACxD,CAAC;QACD,KAAK,oBAAoB,CAAC,gBAAgB,CAAC,CAAC,CAAC;YAC3C,OAAO;gBACL,GAAG,KAAK;gBACR,iBAAiB,EAAE,MAAM,CAAC,OAA4B;gBACtD,mDAAmD;gBACnD,cAAc,EAAE,MAAM,CAAC,OAAyB;aACjD,CAAC;QACJ,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module State\n */\n\n// The following definitions are causing extract-api issues on linux so for now just using any until we can figure out the issue.\nimport type { XAndY } from \"@itwin/core-geometry\";\n// import { IModelConnection, ViewState } from \"@itwin/core-frontend\";\nimport type { CursorMenuItemProps, MenuItemProps } from \"../shared/MenuItem\";\nimport type { ActionsUnion, DeepReadonly } from \"./redux-ts\";\nimport { createAction } from \"./redux-ts\";\n// cSpell:ignore configurableui snapmode toolprompt sessionstate imodelid viewid viewportid rulesetid\n\n/** PresentationSelectionScope holds the id and the localized label for a selection scope supported for a specific iModel.\n * Added to avoid an api-extract error caused by using SelectionScope.\n * @public\n */\nexport interface PresentationSelectionScope {\n  id: string;\n  label: string;\n}\n\n/** Definition of data added to Redux store to define cursor menu.  If menuItems are empty the menu control is not displayed.\n * To close the menu clear the menuItems or pass in undefined as the CursorData.\n * @public\n * @deprecated in 4.11.x use {@link CursorMenuPayload} instead.\n */\nexport interface CursorMenuData {\n  position: XAndY;\n  childWindowId?: string;\n  // eslint-disable-next-line deprecation/deprecation\n  items: MenuItemProps[];\n}\n\n/**\n * Definition of data added to Redux store to define cursor menu.  If menuItems are empty the menu control is not displayed.\n * To close the menu clear the menuItems or pass in undefined as the CursorData.\n * @public\n */\nexport interface CursorMenuPayload {\n  position: XAndY;\n  childWindowId?: string;\n  items: CursorMenuItemProps[];\n}\n\n/** Action Ids used by Redux and to send sync UI components. Typically used to refresh visibility or enable state of control.\n *  Since these are also used as sync ids they should be in lowercase.\n * @public\n */\nexport enum SessionStateActionId {\n  SetNumItemsSelected = \"sessionstate:set-num-items-selected\",\n  SetAvailableSelectionScopes = \"sessionstate:set-available-selection-scopes\",\n  SetSelectionScope = \"sessionstate:set-selection-scope\",\n  SetActiveIModelId = \"sessionstate:set-active-imodelid\",\n  SetIModelConnection = \"sessionstate:set-imodel-connection\",\n  SetDefaultIModelViewportControlId = \"sessionstate:set-default-viewportid\",\n  SetDefaultViewId = \"sessionstate:set-default-viewid\",\n  SetDefaultViewState = \"sessionstate:set-default-view-state\",\n  UpdateCursorMenu = \"sessionstate:update-cursor-menu\",\n}\n\n/** The portion of state managed by the SessionStateReducer.\n * @public\n */\nexport interface SessionState {\n  numItemsSelected: number;\n  availableSelectionScopes: PresentationSelectionScope[];\n  activeSelectionScope: string;\n  iModelId: string;\n  defaultIModelViewportControlId: string | undefined;\n  defaultViewId: string | undefined;\n  defaultViewState: any;\n  iModelConnection: any;\n  // eslint-disable-next-line deprecation/deprecation\n  cursorMenuData: CursorMenuData | undefined; // @deprecated in 4.11.x use {@link CursorMenuPayload} instead\n  cursorMenuPayload: CursorMenuPayload | undefined;\n}\n\nconst defaultSelectionScope = {\n  id: \"element\",\n  label: \"Element\",\n} as PresentationSelectionScope;\n\n/** used on first call of SessionStateReducer */\nconst initialState: SessionState = {\n  /** number of selected items in Presentation Selection */\n  numItemsSelected: 0,\n  /** initialize to only support \"Element\" scope, this will be overwritten when iModelConnection is established */\n  availableSelectionScopes: [defaultSelectionScope],\n  /** initialize to active selection scope to \"Element\", this will be overwritten when iModelConnection is established */\n  activeSelectionScope: defaultSelectionScope.id,\n  /** set to iModelId if an iModel is active else it is an empty string, so initialize to empty string */\n  iModelId: \"\",\n  defaultIModelViewportControlId: undefined,\n  defaultViewId: undefined,\n  defaultViewState: undefined,\n  iModelConnection: undefined,\n  cursorMenuData: undefined, // @deprecated in 4.11.x use {@link SessionState.cursorMenuPayload} instead\n  cursorMenuPayload: undefined,\n};\n\n/** An interface that allows redux connected object to dispatch changes to the SessionState reducer.\n * @beta\n */\nexport interface SessionStateActionsProps {\n  setActiveIModelId: typeof SessionStateActions.setActiveIModelId;\n  setAvailableSelectionScopes: typeof SessionStateActions.setAvailableSelectionScopes;\n  setDefaultIModelViewportControlId: typeof SessionStateActions.setDefaultIModelViewportControlId;\n  setDefaultViewId: typeof SessionStateActions.setDefaultViewId;\n  setDefaultViewState: typeof SessionStateActions.setDefaultViewState;\n  setIModelConnection: typeof SessionStateActions.setIModelConnection;\n  setNumItemsSelected: typeof SessionStateActions.setNumItemsSelected;\n  setSelectionScope: typeof SessionStateActions.setSelectionScope;\n  updateCursorMenu: typeof SessionStateActions.updateCursorMenu;\n}\n\n/** An object with a function that creates each SessionStateReducer that can be handled by our reducer.\n * @public\n */\nexport const SessionStateActions = {\n  setActiveIModelId: (iModelId: string) =>\n    createAction(SessionStateActionId.SetActiveIModelId, iModelId),\n  setAvailableSelectionScopes: (\n    availableSelectionScopes: PresentationSelectionScope[]\n  ) =>\n    createAction(\n      SessionStateActionId.SetAvailableSelectionScopes,\n      availableSelectionScopes\n    ),\n  setDefaultIModelViewportControlId: (iModelViewportControlId: string) =>\n    createAction(\n      SessionStateActionId.SetDefaultIModelViewportControlId,\n      iModelViewportControlId\n    ),\n  setDefaultViewId: (viewId: string) =>\n    createAction(SessionStateActionId.SetDefaultViewId, viewId),\n  setDefaultViewState: (viewState: any) =>\n    createAction(SessionStateActionId.SetDefaultViewState, viewState),\n  setNumItemsSelected: (numSelected: number) =>\n    createAction(SessionStateActionId.SetNumItemsSelected, numSelected),\n  setIModelConnection: (iModelConnection: any) =>\n    createAction(SessionStateActionId.SetIModelConnection, iModelConnection),\n  setSelectionScope: (activeSelectionScope: string) =>\n    createAction(SessionStateActionId.SetSelectionScope, activeSelectionScope),\n  updateCursorMenu:\n    // eslint-disable-next-line deprecation/deprecation\n    (cursorMenuData: CursorMenuData | CursorMenuPayload) =>\n      createAction(SessionStateActionId.UpdateCursorMenu, cursorMenuData),\n};\n\n/** Object that contains available actions that modify SessionState. Parent control's props should\n * extend from SessionStateActionsProps before using this in Redux 'connect' function.\n * @beta\n */\n// ...SessionStateActionsProps\nexport const sessionStateMapDispatchToProps = { ...SessionStateActions };\n\n/** Union of SessionState Redux actions\n * @public\n */\nexport type SessionStateActionsUnion = ActionsUnion<typeof SessionStateActions>;\n\n/** Handles actions to update SessionState.\n * @public\n */\nexport function SessionStateReducer(\n  state: SessionState = initialState,\n  action: SessionStateActionsUnion\n): DeepReadonly<SessionState> {\n  switch (action.type) {\n    case SessionStateActionId.SetNumItemsSelected: {\n      if (undefined !== action.payload)\n        return { ...state, numItemsSelected: action.payload };\n      else return { ...state, numItemsSelected: 0 };\n    }\n    case SessionStateActionId.SetAvailableSelectionScopes: {\n      const payloadArray: PresentationSelectionScope[] = [];\n      action.payload.forEach((scope) => payloadArray.push(scope));\n      if (undefined !== action.payload)\n        return { ...state, availableSelectionScopes: payloadArray };\n      else\n        return { ...state, availableSelectionScopes: [defaultSelectionScope] };\n    }\n    case SessionStateActionId.SetSelectionScope: {\n      if (undefined !== action.payload)\n        return { ...state, activeSelectionScope: action.payload };\n      else return { ...state, activeSelectionScope: defaultSelectionScope.id };\n    }\n    case SessionStateActionId.SetActiveIModelId: {\n      if (undefined !== action.payload)\n        return { ...state, iModelId: action.payload };\n      else return { ...state, iModelId: \"\" };\n    }\n    case SessionStateActionId.SetDefaultIModelViewportControlId: {\n      return { ...state, defaultIModelViewportControlId: action.payload };\n    }\n    case SessionStateActionId.SetDefaultViewId: {\n      return { ...state, defaultViewId: action.payload };\n    }\n    case SessionStateActionId.SetDefaultViewState: {\n      return { ...state, defaultViewState: action.payload };\n    }\n    case SessionStateActionId.SetIModelConnection: {\n      return { ...state, iModelConnection: action.payload };\n    }\n    case SessionStateActionId.UpdateCursorMenu: {\n      return {\n        ...state,\n        cursorMenuPayload: action.payload as CursorMenuPayload,\n        // eslint-disable-next-line deprecation/deprecation\n        cursorMenuData: action.payload as CursorMenuData,\n      };\n    }\n  }\n\n  return state;\n}\n"]}
+{"version":3,"file":"SessionState.js","sourceRoot":"","sources":["../../../../src/appui-react/redux/SessionState.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAMH,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAoC1C;;;;;GAKG;AACH,MAAM,CAAN,IAAY,oBAUX;AAVD,WAAY,oBAAoB;IAC9B,mFAA2D,CAAA;IAC3D,mGAA2E,CAAA;IAC3E,8EAAsD,CAAA;IACtD,8EAAsD,CAAA;IACtD,kFAA0D,CAAA;IAC1D,iGAAyE,CAAA;IACzE,4EAAoD,CAAA;IACpD,mFAA2D,CAAA;IAC3D,4EAAoD,CAAA;AACtD,CAAC,EAVW,oBAAoB,KAApB,oBAAoB,QAU/B;AA6BD,MAAM,qBAAqB,GAAG;IAC5B,EAAE,EAAE,SAAS;IACb,KAAK,EAAE,SAAS;CAC6B,CAAC;AAEhD,iDAAiD;AACjD,MAAM,mBAAmB,GAAiB;IACxC,yDAAyD;IACzD,gBAAgB,EAAE,CAAC;IACnB,gHAAgH;IAChH,wBAAwB,EAAE,CAAC,qBAAqB,CAAC;IACjD,uHAAuH;IACvH,oBAAoB,EAAE,qBAAqB,CAAC,EAAE;IAC9C,uGAAuG;IACvG,QAAQ,EAAE,EAAE;IACZ,8BAA8B,EAAE,SAAS;IACzC,aAAa,EAAE,SAAS;IACxB,gBAAgB,EAAE,SAAS;IAC3B,gBAAgB,EAAE,SAAS;IAC3B,cAAc,EAAE,SAAS,EAAE,4EAA4E;IACvG,iBAAiB,EAAE,SAAS;CAC7B,CAAC;AAkBF;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,iBAAiB,EAAE,CAAC,QAAgB,EAAE,EAAE,CACtC,YAAY,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,QAAQ,CAAC;IAChE,2BAA2B,EAAE,CAC3B,wBAAsD,EACtD,EAAE,CACF,YAAY,CACV,oBAAoB,CAAC,2BAA2B,EAChD,wBAAwB,CACzB;IACH,iCAAiC,EAAE,CAAC,uBAA+B,EAAE,EAAE,CACrE,YAAY,CACV,oBAAoB,CAAC,iCAAiC,EACtD,uBAAuB,CACxB;IACH,gBAAgB,EAAE,CAAC,MAAc,EAAE,EAAE,CACnC,YAAY,CAAC,oBAAoB,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAC7D,mBAAmB,EAAE,CAAC,SAAc,EAAE,EAAE,CACtC,YAAY,CAAC,oBAAoB,CAAC,mBAAmB,EAAE,SAAS,CAAC;IACnE,mBAAmB,EAAE,CAAC,WAAmB,EAAE,EAAE,CAC3C,YAAY,CAAC,oBAAoB,CAAC,mBAAmB,EAAE,WAAW,CAAC;IACrE,mBAAmB,EAAE,CAAC,gBAAqB,EAAE,EAAE,CAC7C,YAAY,CAAC,oBAAoB,CAAC,mBAAmB,EAAE,gBAAgB,CAAC;IAC1E,iBAAiB,EAAE,CAAC,oBAA4B,EAAE,EAAE,CAClD,YAAY,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,oBAAoB,CAAC;IAC5E,gBAAgB,EAAE,CAAC,cAAkD,EAAE,EAAE,CACvE,YAAY,CAAC,oBAAoB,CAAC,gBAAgB,EAAE,cAAc,CAAC;CACtE,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,EAAE,GAAG,mBAAmB,EAAE,CAAC;AAQzE;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CACjC,QAAsB,mBAAmB,EACzC,MAAgC;IAEhC,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;QACpB,KAAK,oBAAoB,CAAC,mBAAmB,CAAC,CAAC,CAAC;YAC9C,IAAI,SAAS,KAAK,MAAM,CAAC,OAAO;gBAC9B,OAAO,EAAE,GAAG,KAAK,EAAE,gBAAgB,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;;gBACnD,OAAO,EAAE,GAAG,KAAK,EAAE,gBAAgB,EAAE,CAAC,EAAE,CAAC;QAChD,CAAC;QACD,KAAK,oBAAoB,CAAC,2BAA2B,CAAC,CAAC,CAAC;YACtD,MAAM,YAAY,GAAiC,EAAE,CAAC;YACtD,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;YAC5D,IAAI,SAAS,KAAK,MAAM,CAAC,OAAO;gBAC9B,OAAO,EAAE,GAAG,KAAK,EAAE,wBAAwB,EAAE,YAAY,EAAE,CAAC;;gBAE5D,OAAO,EAAE,GAAG,KAAK,EAAE,wBAAwB,EAAE,CAAC,qBAAqB,CAAC,EAAE,CAAC;QAC3E,CAAC;QACD,KAAK,oBAAoB,CAAC,iBAAiB,CAAC,CAAC,CAAC;YAC5C,IAAI,SAAS,KAAK,MAAM,CAAC,OAAO;gBAC9B,OAAO,EAAE,GAAG,KAAK,EAAE,oBAAoB,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;;gBACvD,OAAO,EAAE,GAAG,KAAK,EAAE,oBAAoB,EAAE,qBAAqB,CAAC,EAAE,EAAE,CAAC;QAC3E,CAAC;QACD,KAAK,oBAAoB,CAAC,iBAAiB,CAAC,CAAC,CAAC;YAC5C,IAAI,SAAS,KAAK,MAAM,CAAC,OAAO;gBAC9B,OAAO,EAAE,GAAG,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;;gBAC3C,OAAO,EAAE,GAAG,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;QACzC,CAAC;QACD,KAAK,oBAAoB,CAAC,iCAAiC,CAAC,CAAC,CAAC;YAC5D,OAAO,EAAE,GAAG,KAAK,EAAE,8BAA8B,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;QACtE,CAAC;QACD,KAAK,oBAAoB,CAAC,gBAAgB,CAAC,CAAC,CAAC;YAC3C,OAAO,EAAE,GAAG,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;QACrD,CAAC;QACD,KAAK,oBAAoB,CAAC,mBAAmB,CAAC,CAAC,CAAC;YAC9C,OAAO,EAAE,GAAG,KAAK,EAAE,gBAAgB,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;QACxD,CAAC;QACD,KAAK,oBAAoB,CAAC,mBAAmB,CAAC,CAAC,CAAC;YAC9C,OAAO,EAAE,GAAG,KAAK,EAAE,gBAAgB,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;QACxD,CAAC;QACD,KAAK,oBAAoB,CAAC,gBAAgB,CAAC,CAAC,CAAC;YAC3C,OAAO;gBACL,GAAG,KAAK;gBACR,iBAAiB,EAAE,MAAM,CAAC,OAA4B;gBACtD,cAAc,EAAE,MAAM,CAAC,OAAyB;aACjD,CAAC;QACJ,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module State\n */\n\nimport type { XAndY } from \"@itwin/core-geometry\";\nimport type { CursorMenuItemProps, MenuItemProps } from \"../shared/MenuItem\";\nimport type { ActionsUnion, DeepReadonly } from \"./redux-ts\";\nimport type { UiFramework } from \"../UiFramework\";\nimport { createAction } from \"./redux-ts\";\nimport type { useActiveIModelConnection } from \"../hooks/useActiveIModelConnection\";\nimport { SelectionScopeField } from \"../statusfields/SelectionScope\";\n\n/** Definition of a cursor menu. If menuItems are empty the menu control is not displayed.\n * @public\n */\nexport interface CursorMenuPayload {\n  position: XAndY;\n  childWindowId?: string;\n  items: CursorMenuItemProps[];\n}\n\n/* eslint-disable deprecation/deprecation */\n\n/** PresentationSelectionScope holds the id and the localized label for a selection scope supported for a specific iModel.\n * Added to avoid an api-extract error caused by using SelectionScope.\n * @public\n * @deprecated in 4.15.0. Use `selectionScopes` prop of {@link SelectionScopeField} component.\n */\nexport interface PresentationSelectionScope {\n  id: string;\n  label: string;\n}\n\n/** Definition of data added to Redux store to define cursor menu.  If menuItems are empty the menu control is not displayed.\n * To close the menu clear the menuItems or pass in undefined as the CursorData.\n * @public\n * @deprecated in 4.11.0. Use {@link CursorMenuPayload} instead.\n */\nexport interface CursorMenuData {\n  position: XAndY;\n  childWindowId?: string;\n  items: MenuItemProps[];\n}\n\n/** Action Ids used by Redux and to send sync UI components. Typically used to refresh visibility or enable state of control.\n * Since these are also used as sync ids they should be in lowercase.\n * @note This is used by sync UI event APIs.\n * @public\n * @deprecated in 4.15.0. Use your preferred state management library instead.\n */\nexport enum SessionStateActionId {\n  SetNumItemsSelected = \"sessionstate:set-num-items-selected\",\n  SetAvailableSelectionScopes = \"sessionstate:set-available-selection-scopes\",\n  SetSelectionScope = \"sessionstate:set-selection-scope\",\n  SetActiveIModelId = \"sessionstate:set-active-imodelid\",\n  SetIModelConnection = \"sessionstate:set-imodel-connection\",\n  SetDefaultIModelViewportControlId = \"sessionstate:set-default-viewportid\",\n  SetDefaultViewId = \"sessionstate:set-default-viewid\",\n  SetDefaultViewState = \"sessionstate:set-default-view-state\",\n  UpdateCursorMenu = \"sessionstate:update-cursor-menu\",\n}\n\n/** The portion of state managed by the SessionStateReducer.\n * @public\n * @deprecated in 4.15.0. Use your preferred state management library instead.\n */\nexport interface SessionState {\n  /** @deprecated in 4.15.0. Use {@link UiFramework.getNumItemsSelected} instead. */\n  numItemsSelected: number;\n  /** @deprecated in 4.15.0. Use `selectionScopes` prop of {@link SelectionScopeField} instead. */\n  availableSelectionScopes: PresentationSelectionScope[];\n  /** @deprecated in 4.15.0. Use `activeScope` prop of {@link SelectionScopeField} instead. */\n  activeSelectionScope: string;\n  /** @deprecated in 4.15.0. Not used by AppUI components. */\n  iModelId: string;\n  /** @deprecated in 4.15.0. Not used by AppUI components. */\n  defaultIModelViewportControlId: string | undefined;\n  /** @deprecated in 4.15.0. Not used by AppUI components. */\n  defaultViewId: string | undefined;\n  /** @deprecated in 4.15.0. Use {@link UiFramework.getDefaultViewState} or {@link useActiveIModelConnection} instead. */\n  defaultViewState: any;\n  /** @deprecated in 4.15.0. Use {@link UiFramework.getIModelConnection} or {@link useActiveIModelConnection} instead. */\n  iModelConnection: any;\n  /** @deprecated in 4.11.0. Use {@link CursorMenuPayload} instead */\n  cursorMenuData: CursorMenuData | undefined;\n  /** @deprecated in 4.15.0. Use cursor APIs of {@link UiFramework}. */\n  cursorMenuPayload: CursorMenuPayload | undefined;\n}\n\nconst defaultSelectionScope = {\n  id: \"element\",\n  label: \"Element\",\n} as const satisfies PresentationSelectionScope;\n\n/** Used on first call of SessionStateReducer. */\nconst initialSessionState: SessionState = {\n  /** number of selected items in Presentation Selection */\n  numItemsSelected: 0,\n  /** initialize to only support \"Element\" scope, this will be overwritten when iModelConnection is established */\n  availableSelectionScopes: [defaultSelectionScope],\n  /** initialize to active selection scope to \"Element\", this will be overwritten when iModelConnection is established */\n  activeSelectionScope: defaultSelectionScope.id,\n  /** set to iModelId if an iModel is active else it is an empty string, so initialize to empty string */\n  iModelId: \"\",\n  defaultIModelViewportControlId: undefined,\n  defaultViewId: undefined,\n  defaultViewState: undefined,\n  iModelConnection: undefined,\n  cursorMenuData: undefined, // @deprecated in 4.11.0. Use {@link SessionState.cursorMenuPayload} instead\n  cursorMenuPayload: undefined,\n};\n\n/** An interface that allows redux connected object to dispatch changes to the SessionState reducer.\n * @beta\n * @deprecated in 4.15.0. Use your preferred state management library instead.\n */\nexport interface SessionStateActionsProps {\n  setActiveIModelId: typeof SessionStateActions.setActiveIModelId;\n  setAvailableSelectionScopes: typeof SessionStateActions.setAvailableSelectionScopes;\n  setDefaultIModelViewportControlId: typeof SessionStateActions.setDefaultIModelViewportControlId;\n  setDefaultViewId: typeof SessionStateActions.setDefaultViewId;\n  setDefaultViewState: typeof SessionStateActions.setDefaultViewState;\n  setIModelConnection: typeof SessionStateActions.setIModelConnection;\n  setNumItemsSelected: typeof SessionStateActions.setNumItemsSelected;\n  setSelectionScope: typeof SessionStateActions.setSelectionScope;\n  updateCursorMenu: typeof SessionStateActions.updateCursorMenu;\n}\n\n/** An object with a function that creates each SessionStateReducer that can be handled by our reducer.\n * @public\n * @deprecated in 4.15.0. Use your preferred state management library instead.\n */\nexport const SessionStateActions = {\n  setActiveIModelId: (iModelId: string) =>\n    createAction(SessionStateActionId.SetActiveIModelId, iModelId),\n  setAvailableSelectionScopes: (\n    availableSelectionScopes: PresentationSelectionScope[]\n  ) =>\n    createAction(\n      SessionStateActionId.SetAvailableSelectionScopes,\n      availableSelectionScopes\n    ),\n  setDefaultIModelViewportControlId: (iModelViewportControlId: string) =>\n    createAction(\n      SessionStateActionId.SetDefaultIModelViewportControlId,\n      iModelViewportControlId\n    ),\n  setDefaultViewId: (viewId: string) =>\n    createAction(SessionStateActionId.SetDefaultViewId, viewId),\n  setDefaultViewState: (viewState: any) =>\n    createAction(SessionStateActionId.SetDefaultViewState, viewState),\n  setNumItemsSelected: (numSelected: number) =>\n    createAction(SessionStateActionId.SetNumItemsSelected, numSelected),\n  setIModelConnection: (iModelConnection: any) =>\n    createAction(SessionStateActionId.SetIModelConnection, iModelConnection),\n  setSelectionScope: (activeSelectionScope: string) =>\n    createAction(SessionStateActionId.SetSelectionScope, activeSelectionScope),\n  updateCursorMenu: (cursorMenuData: CursorMenuData | CursorMenuPayload) =>\n    createAction(SessionStateActionId.UpdateCursorMenu, cursorMenuData),\n};\n\n/** Object that contains available actions that modify SessionState. Parent control's props should\n * extend from SessionStateActionsProps before using this in Redux 'connect' function.\n * @beta\n * @deprecated in 4.15.0. Use your preferred state management library instead.\n */\nexport const sessionStateMapDispatchToProps = { ...SessionStateActions };\n\n/** Union of SessionState Redux actions\n * @public\n * @deprecated in 4.15.0. Use your preferred state management library instead.\n */\nexport type SessionStateActionsUnion = ActionsUnion<typeof SessionStateActions>;\n\n/** Handles actions to update SessionState.\n * @public\n * @deprecated in 4.15.0. Use your preferred state management library instead.\n */\nexport function SessionStateReducer(\n  state: SessionState = initialSessionState,\n  action: SessionStateActionsUnion\n): DeepReadonly<SessionState> {\n  switch (action.type) {\n    case SessionStateActionId.SetNumItemsSelected: {\n      if (undefined !== action.payload)\n        return { ...state, numItemsSelected: action.payload };\n      else return { ...state, numItemsSelected: 0 };\n    }\n    case SessionStateActionId.SetAvailableSelectionScopes: {\n      const payloadArray: PresentationSelectionScope[] = [];\n      action.payload.forEach((scope) => payloadArray.push(scope));\n      if (undefined !== action.payload)\n        return { ...state, availableSelectionScopes: payloadArray };\n      else\n        return { ...state, availableSelectionScopes: [defaultSelectionScope] };\n    }\n    case SessionStateActionId.SetSelectionScope: {\n      if (undefined !== action.payload)\n        return { ...state, activeSelectionScope: action.payload };\n      else return { ...state, activeSelectionScope: defaultSelectionScope.id };\n    }\n    case SessionStateActionId.SetActiveIModelId: {\n      if (undefined !== action.payload)\n        return { ...state, iModelId: action.payload };\n      else return { ...state, iModelId: \"\" };\n    }\n    case SessionStateActionId.SetDefaultIModelViewportControlId: {\n      return { ...state, defaultIModelViewportControlId: action.payload };\n    }\n    case SessionStateActionId.SetDefaultViewId: {\n      return { ...state, defaultViewId: action.payload };\n    }\n    case SessionStateActionId.SetDefaultViewState: {\n      return { ...state, defaultViewState: action.payload };\n    }\n    case SessionStateActionId.SetIModelConnection: {\n      return { ...state, iModelConnection: action.payload };\n    }\n    case SessionStateActionId.UpdateCursorMenu: {\n      return {\n        ...state,\n        cursorMenuPayload: action.payload as CursorMenuPayload,\n        cursorMenuData: action.payload as CursorMenuData,\n      };\n    }\n  }\n\n  return state;\n}\n"]}

package/lib/esm/appui-react/redux/StateManager.d.ts

@@ -2,20 +2,21 @@
  * @module State
  */
 import type { Store } from "redux";
-import type { FrameworkState } from "./FrameworkState";
+import { type FrameworkState } from "./FrameworkState";
 import type { NameToReducerMap } from "./ReducerRegistry";
 /** Generic 'root' state for the appui-react package. Since this state contains common values needed by many applications
  * it is automatically added to the Redux store when using [[StateManager]].
  * @beta
+ * @deprecated in 4.15.0. Use your preferred state management library instead.
  */
 export interface FrameworkRootState {
     frameworkState: FrameworkState;
 }
-/**
- * Centralized state management class using  Redux actions, reducers and store. This class monitors the ReducerRegistry and will
- * automatically update the store when a new reducer is registered.  This allows the store to be incrementally constructed as modules
+/** Centralized state management class using Redux actions, reducers and store. This class monitors the ReducerRegistry and will
+ * automatically update the store when a new reducer is registered. This allows the store to be incrementally constructed as modules
  * and/or extensions are loaded.
  * @public
+ * @deprecated in 4.15.0. Use your preferred state management library instead.
  */
 export declare class StateManager {
     private static _LOG_CATEGORY;

package/lib/esm/appui-react/redux/StateManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StateManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/redux/StateManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,KAAK,EAAqB,KAAK,EAAE,MAAM,OAAO,CAAC;AAItD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAG1D;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,cAAc,EAAE,cAAc,CAAC;CAChC;AAED;;;;;GAKG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,MAAM,CAAC,aAAa,CAAkB;IAC9C,OAAO,CAAC,MAAM,CAAa;IAC3B,OAAO,CAAC,gBAAgB,CAAmB;IAE3C,OAAO,CAAC,MAAM,CAAC,eAAe,CAAyB;IAEvD;;;OAGG;gBACS,eAAe,CAAC,EAAE,gBAAgB;IAsC9C;;OAEG;WAEW,aAAa,CAAC,gBAAgB,UAAQ,GAAG,OAAO;IAa9D,+GAA+G;IAC/G,WAAkB,KAAK,IAAI,KAAK,CAAC,GAAG,CAAC,CAUpC;IAED,qDAAqD;IACrD,WAAkB,KAAK,IAAI,GAAG,CAM7B;IAED,OAAO,CAAC,gCAAgC;IAYxC;;OAEG;WACW,UAAU;CAGzB"}
+{"version":3,"file":"StateManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/redux/StateManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAqB,KAAK,EAAE,MAAM,OAAO,CAAC;AAItD,OAAO,EAAoB,KAAK,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACzE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAK1D;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,cAAc,EAAE,cAAc,CAAC;CAChC;AAED;;;;;GAKG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,MAAM,CAAC,aAAa,CAAkB;IAC9C,OAAO,CAAC,MAAM,CAAa;IAC3B,OAAO,CAAC,gBAAgB,CAAmB;IAE3C,OAAO,CAAC,MAAM,CAAC,eAAe,CAAyB;IAEvD;;;OAGG;gBACS,eAAe,CAAC,EAAE,gBAAgB;IAsC9C;;OAEG;WAEW,aAAa,CAAC,gBAAgB,UAAQ,GAAG,OAAO;IAa9D,+GAA+G;IAC/G,WAAkB,KAAK,IAAI,KAAK,CAAC,GAAG,CAAC,CAUpC;IAED,qDAAqD;IACrD,WAAkB,KAAK,IAAI,GAAG,CAM7B;IAED,OAAO,CAAC,gCAAgC;IAYxC;;OAEG;WACW,UAAU;CAGzB"}

package/lib/esm/appui-react/redux/StateManager.js

@@ -10,11 +10,11 @@ import { Logger } from "@itwin/core-bentley";
 import { UiError } from "@itwin/appui-abstract";
 import { FrameworkReducer } from "./FrameworkState";
 import { ReducerRegistryInstance } from "./ReducerRegistry";
-/**
- * Centralized state management class using  Redux actions, reducers and store. This class monitors the ReducerRegistry and will
- * automatically update the store when a new reducer is registered.  This allows the store to be incrementally constructed as modules
+/** Centralized state management class using Redux actions, reducers and store. This class monitors the ReducerRegistry and will
+ * automatically update the store when a new reducer is registered. This allows the store to be incrementally constructed as modules
  * and/or extensions are loaded.
  * @public
+ * @deprecated in 4.15.0. Use your preferred state management library instead.
  */
 export class StateManager {
     /**

package/lib/esm/appui-react/redux/StateManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"StateManager.js","sourceRoot":"","sources":["../../../../src/appui-react/redux/StateManager.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAKH,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAEhD,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAU5D;;;;;GAKG;AACH,MAAM,OAAO,YAAY;IAOvB;;;OAGG;IACH,YAAY,eAAkC;QAC5C,IAAI,eAAe,EAAE,CAAC;YACpB,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;YACxC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YAC1C,kEAAkE;YAClE,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,gBAAgB,CAAC;gBAC1D,IAAI,CAAC,gBAAgB,GAAG;oBACtB,GAAG,eAAe;oBAClB,cAAc,EAAE,gBAAgB;iBACjC,CAAC;QACN,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,gBAAgB,GAAG,EAAE,cAAc,EAAE,gBAAgB,EAAE,CAAC;QAC/D,CAAC;QAED,MAAM,6BAA6B,GAAG,uBAAuB,CAAC,WAAW,EAAE,CAAC;QAC5E,IAAI,WAAW,GAAQ,IAAI,CAAC,gCAAgC,CAC1D,6BAA6B,EAC7B,IAAI,CAAC,gBAAgB,CACtB,CAAC;QAEF,0BAA0B;QAC1B,mDAAmD;QACnD,IAAI,CAAC,MAAM,GAAG,WAAW,CACvB,WAAW,EACV,MAAc,CAAC,4BAA4B;YACzC,MAAc,CAAC,4BAA4B,EAAE,CACjD,CAAC;QAEF,uBAAuB,CAAC,iBAAiB,CAAC,CAAC,kBAAkB,EAAE,EAAE;YAC/D,WAAW,GAAG,IAAI,CAAC,gCAAgC,CACjD,kBAAkB,EAClB,IAAI,CAAC,gBAAgB,CACtB,CAAC;YACF,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QACH,YAAY,CAAC,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC;IAC7C,CAAC;IAED;;OAEG;IAEI,MAAM,CAAC,aAAa,CAAC,gBAAgB,GAAG,KAAK;QAClD,IAAI,CAAC,YAAY,CAAC,eAAe,EAAE,CAAC;YAClC,IAAI,CAAC,gBAAgB;gBACnB,MAAM,CAAC,QAAQ,CACb,YAAY,CAAC,aAAa,EAC1B,uCAAuC,CACxC,CAAC;YACJ,OAAO,KAAK,CAAC;QACf,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,+GAA+G;IACxG,MAAM,KAAK,KAAK;QACrB,IAAI,YAAY,CAAC,aAAa,EAAE,EAAE,CAAC;YACjC,OAAO,YAAY,CAAC,eAAgB,CAAC;QACvC,CAAC;aAAM,CAAC;YACN,mDAAmD;YACnD,MAAM,IAAI,OAAO,CACf,YAAY,CAAC,aAAa,EAC1B,sCAAsC,CACvC,CAAC;QACJ,CAAC;IACH,CAAC;IAED,qDAAqD;IAC9C,MAAM,KAAK,KAAK;QACrB,IAAI,YAAY,CAAC,aAAa,EAAE,EAAE,CAAC;YACjC,OAAO,YAAY,CAAC,eAAgB,CAAC,QAAQ,EAAE,CAAC;QAClD,CAAC;aAAM,CAAC;YACN,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAEO,gCAAgC,CACtC,6BAAgD,EAChD,eAAkC;QAElC,MAAM,WAAW,GAAG;YAClB,GAAG,eAAe;YAClB,GAAG,6BAA6B;SACjC,CAAC;QAEF,OAAO,eAAe,CAAC,WAAW,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,UAAU;QACtB,YAAY,CAAC,eAAe,GAAG,SAAS,CAAC;IAC3C,CAAC;;AAxGc,0BAAa,GAAG,cAAc,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module State\n */\n\n// cSpell:ignore DEVTOOLS\n\nimport type { ReducersMapObject, Store } from \"redux\";\nimport { combineReducers, createStore } from \"redux\";\nimport { Logger } from \"@itwin/core-bentley\";\nimport { UiError } from \"@itwin/appui-abstract\";\nimport type { FrameworkState } from \"./FrameworkState\";\nimport { FrameworkReducer } from \"./FrameworkState\";\nimport type { NameToReducerMap } from \"./ReducerRegistry\";\nimport { ReducerRegistryInstance } from \"./ReducerRegistry\";\n\n/** Generic 'root' state for the appui-react package. Since this state contains common values needed by many applications\n * it is automatically added to the Redux store when using [[StateManager]].\n * @beta\n */\nexport interface FrameworkRootState {\n  frameworkState: FrameworkState;\n}\n\n/**\n * Centralized state management class using  Redux actions, reducers and store. This class monitors the ReducerRegistry and will\n * automatically update the store when a new reducer is registered.  This allows the store to be incrementally constructed as modules\n * and/or extensions are loaded.\n * @public\n */\nexport class StateManager {\n  private static _LOG_CATEGORY = \"StateManager\";\n  private _store: Store<any>;\n  private _defaultReducers: NameToReducerMap;\n\n  private static _singletonStore: Store<any> | undefined;\n\n  /**\n   * StateManager construct.\n   * @param defaultReducers Default set of Reducers used by the current application. If this object does not contain the [[FrameworkReducer]] it will automatically be added.\n   */\n  constructor(defaultReducers?: NameToReducerMap) {\n    if (defaultReducers) {\n      this._defaultReducers = defaultReducers;\n      const keys = Object.keys(defaultReducers);\n      // ensure frameworkState is included in the set of defaultReducers\n      if (-1 === keys.findIndex((key) => key === \"frameworkState\"))\n        this._defaultReducers = {\n          ...defaultReducers,\n          frameworkState: FrameworkReducer,\n        };\n    } else {\n      this._defaultReducers = { frameworkState: FrameworkReducer };\n    }\n\n    const dynamicallyRegisteredReducers = ReducerRegistryInstance.getReducers();\n    let allReducers: any = this.combineDynamicAndDefaultReducers(\n      dynamicallyRegisteredReducers,\n      this._defaultReducers\n    );\n\n    // create the Redux Store.\n    // eslint-disable-next-line deprecation/deprecation\n    this._store = createStore(\n      allReducers,\n      (window as any).__REDUX_DEVTOOLS_EXTENSION__ &&\n        (window as any).__REDUX_DEVTOOLS_EXTENSION__()\n    );\n\n    ReducerRegistryInstance.setChangeListener((newDynamicReducers) => {\n      allReducers = this.combineDynamicAndDefaultReducers(\n        newDynamicReducers,\n        this._defaultReducers\n      );\n      this._store.replaceReducer(allReducers);\n    });\n    StateManager._singletonStore = this._store;\n  }\n\n  /** Method to test if the StateManager has been initialized.\n   * @param suppressErrorLog If true and the StateManager is not initialized a log message will be output.\n   */\n\n  public static isInitialized(suppressErrorLog = false): boolean {\n    if (!StateManager._singletonStore) {\n      if (!suppressErrorLog)\n        Logger.logError(\n          StateManager._LOG_CATEGORY,\n          \"Accessing store before it is created.\"\n        );\n      return false;\n    } else {\n      return true;\n    }\n  }\n\n  /** Return the current Redux store. Useful when using connect method to connect a Ui Component to the store. */\n  public static get store(): Store<any> {\n    if (StateManager.isInitialized()) {\n      return StateManager._singletonStore!;\n    } else {\n      // eslint-disable-next-line deprecation/deprecation\n      throw new UiError(\n        StateManager._LOG_CATEGORY,\n        `Redux Store has not been initialized`\n      );\n    }\n  }\n\n  /** Return the current state from the Redux store. */\n  public static get state(): any {\n    if (StateManager.isInitialized()) {\n      return StateManager._singletonStore!.getState();\n    } else {\n      return undefined;\n    }\n  }\n\n  private combineDynamicAndDefaultReducers(\n    dynamicallyRegisteredReducers: ReducersMapObject,\n    defaultReducers: ReducersMapObject\n  ) {\n    const allReducers = {\n      ...defaultReducers,\n      ...dynamicallyRegisteredReducers,\n    };\n\n    return combineReducers(allReducers);\n  }\n\n  /** To be used only in unit test\n   * @internal\n   */\n  public static clearStore() {\n    StateManager._singletonStore = undefined;\n  }\n}\n"]}
+{"version":3,"file":"StateManager.js","sourceRoot":"","sources":["../../../../src/appui-react/redux/StateManager.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAGH,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAuB,MAAM,kBAAkB,CAAC;AAEzE,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAa5D;;;;;GAKG;AACH,MAAM,OAAO,YAAY;IAOvB;;;OAGG;IACH,YAAY,eAAkC;QAC5C,IAAI,eAAe,EAAE,CAAC;YACpB,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;YACxC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YAC1C,kEAAkE;YAClE,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,gBAAgB,CAAC;gBAC1D,IAAI,CAAC,gBAAgB,GAAG;oBACtB,GAAG,eAAe;oBAClB,cAAc,EAAE,gBAAgB;iBACjC,CAAC;QACN,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,gBAAgB,GAAG,EAAE,cAAc,EAAE,gBAAgB,EAAE,CAAC;QAC/D,CAAC;QAED,MAAM,6BAA6B,GAAG,uBAAuB,CAAC,WAAW,EAAE,CAAC;QAC5E,IAAI,WAAW,GAAQ,IAAI,CAAC,gCAAgC,CAC1D,6BAA6B,EAC7B,IAAI,CAAC,gBAAgB,CACtB,CAAC;QAEF,0BAA0B;QAC1B,mDAAmD;QACnD,IAAI,CAAC,MAAM,GAAG,WAAW,CACvB,WAAW,EACV,MAAc,CAAC,4BAA4B;YACzC,MAAc,CAAC,4BAA4B,EAAE,CACjD,CAAC;QAEF,uBAAuB,CAAC,iBAAiB,CAAC,CAAC,kBAAkB,EAAE,EAAE;YAC/D,WAAW,GAAG,IAAI,CAAC,gCAAgC,CACjD,kBAAkB,EAClB,IAAI,CAAC,gBAAgB,CACtB,CAAC;YACF,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QACH,YAAY,CAAC,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC;IAC7C,CAAC;IAED;;OAEG;IAEI,MAAM,CAAC,aAAa,CAAC,gBAAgB,GAAG,KAAK;QAClD,IAAI,CAAC,YAAY,CAAC,eAAe,EAAE,CAAC;YAClC,IAAI,CAAC,gBAAgB;gBACnB,MAAM,CAAC,QAAQ,CACb,YAAY,CAAC,aAAa,EAC1B,uCAAuC,CACxC,CAAC;YACJ,OAAO,KAAK,CAAC;QACf,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,+GAA+G;IACxG,MAAM,KAAK,KAAK;QACrB,IAAI,YAAY,CAAC,aAAa,EAAE,EAAE,CAAC;YACjC,OAAO,YAAY,CAAC,eAAgB,CAAC;QACvC,CAAC;aAAM,CAAC;YACN,mDAAmD;YACnD,MAAM,IAAI,OAAO,CACf,YAAY,CAAC,aAAa,EAC1B,sCAAsC,CACvC,CAAC;QACJ,CAAC;IACH,CAAC;IAED,qDAAqD;IAC9C,MAAM,KAAK,KAAK;QACrB,IAAI,YAAY,CAAC,aAAa,EAAE,EAAE,CAAC;YACjC,OAAO,YAAY,CAAC,eAAgB,CAAC,QAAQ,EAAE,CAAC;QAClD,CAAC;aAAM,CAAC;YACN,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAEO,gCAAgC,CACtC,6BAAgD,EAChD,eAAkC;QAElC,MAAM,WAAW,GAAG;YAClB,GAAG,eAAe;YAClB,GAAG,6BAA6B;SACjC,CAAC;QAEF,OAAO,eAAe,CAAC,WAAW,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,UAAU;QACtB,YAAY,CAAC,eAAe,GAAG,SAAS,CAAC;IAC3C,CAAC;;AAxGc,0BAAa,GAAG,cAAc,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module State\n */\n\nimport type { ReducersMapObject, Store } from \"redux\";\nimport { combineReducers, createStore } from \"redux\";\nimport { Logger } from \"@itwin/core-bentley\";\nimport { UiError } from \"@itwin/appui-abstract\";\nimport { FrameworkReducer, type FrameworkState } from \"./FrameworkState\";\nimport type { NameToReducerMap } from \"./ReducerRegistry\";\nimport { ReducerRegistryInstance } from \"./ReducerRegistry\";\n\n/* eslint-disable deprecation/deprecation */\n\n/** Generic 'root' state for the appui-react package. Since this state contains common values needed by many applications\n * it is automatically added to the Redux store when using [[StateManager]].\n * @beta\n * @deprecated in 4.15.0. Use your preferred state management library instead.\n */\nexport interface FrameworkRootState {\n  frameworkState: FrameworkState;\n}\n\n/** Centralized state management class using Redux actions, reducers and store. This class monitors the ReducerRegistry and will\n * automatically update the store when a new reducer is registered. This allows the store to be incrementally constructed as modules\n * and/or extensions are loaded.\n * @public\n * @deprecated in 4.15.0. Use your preferred state management library instead.\n */\nexport class StateManager {\n  private static _LOG_CATEGORY = \"StateManager\";\n  private _store: Store<any>;\n  private _defaultReducers: NameToReducerMap;\n\n  private static _singletonStore: Store<any> | undefined;\n\n  /**\n   * StateManager construct.\n   * @param defaultReducers Default set of Reducers used by the current application. If this object does not contain the [[FrameworkReducer]] it will automatically be added.\n   */\n  constructor(defaultReducers?: NameToReducerMap) {\n    if (defaultReducers) {\n      this._defaultReducers = defaultReducers;\n      const keys = Object.keys(defaultReducers);\n      // ensure frameworkState is included in the set of defaultReducers\n      if (-1 === keys.findIndex((key) => key === \"frameworkState\"))\n        this._defaultReducers = {\n          ...defaultReducers,\n          frameworkState: FrameworkReducer,\n        };\n    } else {\n      this._defaultReducers = { frameworkState: FrameworkReducer };\n    }\n\n    const dynamicallyRegisteredReducers = ReducerRegistryInstance.getReducers();\n    let allReducers: any = this.combineDynamicAndDefaultReducers(\n      dynamicallyRegisteredReducers,\n      this._defaultReducers\n    );\n\n    // create the Redux Store.\n    // eslint-disable-next-line deprecation/deprecation\n    this._store = createStore(\n      allReducers,\n      (window as any).__REDUX_DEVTOOLS_EXTENSION__ &&\n        (window as any).__REDUX_DEVTOOLS_EXTENSION__()\n    );\n\n    ReducerRegistryInstance.setChangeListener((newDynamicReducers) => {\n      allReducers = this.combineDynamicAndDefaultReducers(\n        newDynamicReducers,\n        this._defaultReducers\n      );\n      this._store.replaceReducer(allReducers);\n    });\n    StateManager._singletonStore = this._store;\n  }\n\n  /** Method to test if the StateManager has been initialized.\n   * @param suppressErrorLog If true and the StateManager is not initialized a log message will be output.\n   */\n\n  public static isInitialized(suppressErrorLog = false): boolean {\n    if (!StateManager._singletonStore) {\n      if (!suppressErrorLog)\n        Logger.logError(\n          StateManager._LOG_CATEGORY,\n          \"Accessing store before it is created.\"\n        );\n      return false;\n    } else {\n      return true;\n    }\n  }\n\n  /** Return the current Redux store. Useful when using connect method to connect a Ui Component to the store. */\n  public static get store(): Store<any> {\n    if (StateManager.isInitialized()) {\n      return StateManager._singletonStore!;\n    } else {\n      // eslint-disable-next-line deprecation/deprecation\n      throw new UiError(\n        StateManager._LOG_CATEGORY,\n        `Redux Store has not been initialized`\n      );\n    }\n  }\n\n  /** Return the current state from the Redux store. */\n  public static get state(): any {\n    if (StateManager.isInitialized()) {\n      return StateManager._singletonStore!.getState();\n    } else {\n      return undefined;\n    }\n  }\n\n  private combineDynamicAndDefaultReducers(\n    dynamicallyRegisteredReducers: ReducersMapObject,\n    defaultReducers: ReducersMapObject\n  ) {\n    const allReducers = {\n      ...defaultReducers,\n      ...dynamicallyRegisteredReducers,\n    };\n\n    return combineReducers(allReducers);\n  }\n\n  /** To be used only in unit test\n   * @internal\n   */\n  public static clearStore() {\n    StateManager._singletonStore = undefined;\n  }\n}\n"]}

package/lib/esm/appui-react/redux/connectIModel.d.ts

@@ -1,7 +1,11 @@
+/** @packageDocumentation
+ * @module State
+ */
 /** Function that will connect a component to the IModelConnection data in the Redux store.
  * @param mapStateToProps optional user function that, if defined, will be executed to provide additional properties from store.
  * @param mapDispatchToProps data passed to Redux connect function.
  * @public
+ * @deprecated in 4.15.0. Components should take iModel connection as props.
  */
 export declare const connectIModelConnection: (mapStateToProps?: any, mapDispatchToProps?: any) => import("react-redux").InferableComponentEnhancerWithProps<any, any>;
 /** Function that will connect a component to the IModelConnection data in the Redux store
@@ -21,7 +25,7 @@ export declare const connectIModelConnection: (mapStateToProps?: any, mapDispatc
  *
  *  //  this then allows connected control to update the store using a call like shown below.
  *  this.props.setNumItemsSelected(30);
- *
+ * @deprecated in 4.15.0. Components should take iModel connection and view state as props.
  */
 export declare const connectIModelConnectionAndViewState: (mapStateToProps?: any, mapDispatchToProps?: any) => import("react-redux").InferableComponentEnhancerWithProps<any, any>;
 //# sourceMappingURL=connectIModel.d.ts.map

package/lib/esm/appui-react/redux/connectIModel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"connectIModel.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/redux/connectIModel.ts"],"names":[],"mappings":"AA+DA;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,qBAChB,GAAG,uBACA,GAAG,wEAGzB,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,mCAAmC,qBAC5B,GAAG,uBACA,GAAG,wEAMzB,CAAC"}
+{"version":3,"file":"connectIModel.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/redux/connectIModel.ts"],"names":[],"mappings":"AAIA;;GAEG;AA0DH;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,qBAChB,GAAG,uBACA,GAAG,wEAGzB,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,mCAAmC,qBAC5B,GAAG,uBACA,GAAG,wEAMzB,CAAC"}

package/lib/esm/appui-react/redux/connectIModel.js

@@ -7,6 +7,7 @@
  */
 import { connect } from "react-redux";
 import { UiFramework } from "../UiFramework";
+/* eslint-disable deprecation/deprecation */
 /** Private function that will map store's iModelConnection to the 'iModelConnection', 'iModel', and 'imodel' properties of props. This
  * is not ideal but it is a result of not having standard prop name for an iModelConnection.
  */
@@ -56,6 +57,7 @@ const iModelAndViewMapStateToProps = (mapStateToProps) => {
  * @param mapStateToProps optional user function that, if defined, will be executed to provide additional properties from store.
  * @param mapDispatchToProps data passed to Redux connect function.
  * @public
+ * @deprecated in 4.15.0. Components should take iModel connection as props.
  */
 export const connectIModelConnection = (mapStateToProps, mapDispatchToProps) => {
     return connect(iModeMapStateToProps(mapStateToProps), mapDispatchToProps);
@@ -77,7 +79,7 @@ export const connectIModelConnection = (mapStateToProps, mapDispatchToProps) =>
  *
  *  //  this then allows connected control to update the store using a call like shown below.
  *  this.props.setNumItemsSelected(30);
- *
+ * @deprecated in 4.15.0. Components should take iModel connection and view state as props.
  */
 export const connectIModelConnectionAndViewState = (mapStateToProps, mapDispatchToProps) => {
     return connect(iModelAndViewMapStateToProps(mapStateToProps), mapDispatchToProps);

package/lib/esm/appui-react/redux/connectIModel.js.map

@@ -1 +1 @@
-{"version":3,"file":"connectIModel.js","sourceRoot":"","sources":["../../../../src/appui-react/redux/connectIModel.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;GAEG;AACH,MAAM,oBAAoB,GAAG,CAAC,eAAoB,EAAE,EAAE;IACpD,OAAO,CAAC,KAAU,EAAE,QAAa,EAAE,EAAE;QACnC,MAAM,cAAc,GAAG,KAAK,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC,CAAC,8CAA8C;QAE3G,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,IAAI,eAAe;gBAAE,OAAO,eAAe,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YAC7D,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,UAAU,GAAG;YACjB,gBAAgB,EAAE,cAAc,CAAC,YAAY,CAAC,gBAAgB;YAC9D,MAAM,EAAE,cAAc,CAAC,YAAY,CAAC,gBAAgB;YACpD,MAAM,EAAE,cAAc,CAAC,YAAY,CAAC,gBAAgB;SACrD,CAAC;QAEF,IAAI,eAAe,EAAE,CAAC;YACpB,OAAO;gBACL,GAAG,UAAU;gBACb,GAAG,eAAe,CAAC,KAAK,EAAE,QAAQ,CAAC;aACpC,CAAC;QACJ,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,4BAA4B,GAAG,CAAC,eAAoB,EAAE,EAAE;IAC5D,OAAO,CAAC,KAAU,EAAE,QAAa,EAAE,EAAE;QACnC,MAAM,cAAc,GAAG,KAAK,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC,CAAC,8CAA8C;QAE3G,IAAI,CAAC,cAAc;YAAE,OAAO,EAAE,CAAC;QAE/B,MAAM,KAAK,GAAG;YACZ,GAAG,QAAQ;YACX,gBAAgB,EAAE,cAAc,CAAC,YAAY,CAAC,gBAAgB,EAAE,wEAAwE;YACxI,MAAM,EAAE,cAAc,CAAC,YAAY,CAAC,gBAAgB,EAAE,yCAAyC;YAC/F,MAAM,EAAE,cAAc,CAAC,YAAY,CAAC,gBAAgB,EAAE,uCAAuC;YAC7F,SAAS,EAAE,cAAc,CAAC,YAAY,CAAC,gBAAgB;SACxD,CAAC;QACF,IAAI,eAAe;YAAE,OAAO,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAE1D,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,eAAqB,EACrB,kBAAwB,EACxB,EAAE;IACF,OAAO,OAAO,CAAC,oBAAoB,CAAC,eAAe,CAAC,EAAE,kBAAkB,CAAC,CAAC;AAC5E,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,mCAAmC,GAAG,CACjD,eAAqB,EACrB,kBAAwB,EACxB,EAAE;IACF,OAAO,OAAO,CACZ,4BAA4B,CAAC,eAAe,CAAC,EAC7C,kBAAkB,CACnB,CAAC;AACJ,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n\n/** @packageDocumentation\n * @module State\n */\n\nimport { connect } from \"react-redux\";\nimport { UiFramework } from \"../UiFramework\";\n\n/** Private function that will map store's iModelConnection to the 'iModelConnection', 'iModel', and 'imodel' properties of props. This\n * is not ideal but it is a result of not having standard prop name for an iModelConnection.\n */\nconst iModeMapStateToProps = (mapStateToProps: any) => {\n  return (state: any, ownProps: any) => {\n    const frameworkState = state[UiFramework.frameworkStateKey]; // since app sets up key, don't hard-code name\n\n    if (!frameworkState) {\n      if (mapStateToProps) return mapStateToProps(state, ownProps);\n      return {};\n    }\n\n    const storeProps = {\n      iModelConnection: frameworkState.sessionState.iModelConnection,\n      imodel: frameworkState.sessionState.iModelConnection,\n      iModel: frameworkState.sessionState.iModelConnection,\n    };\n\n    if (mapStateToProps) {\n      return {\n        ...storeProps,\n        ...mapStateToProps(state, ownProps),\n      };\n    }\n\n    return storeProps;\n  };\n};\n\n/** Function that will map store's iModelConnection and defaultViewState to the props 'iModelConnection', 'iModel', 'imodel',\n * and 'viewState' property of props\n */\nconst iModelAndViewMapStateToProps = (mapStateToProps: any) => {\n  return (state: any, ownProps: any) => {\n    const frameworkState = state[UiFramework.frameworkStateKey]; // since app sets up key, don't hard-code name\n\n    if (!frameworkState) return {};\n\n    const props = {\n      ...ownProps,\n      iModelConnection: frameworkState.sessionState.iModelConnection, // this prop is required by Unified Selection (TODO: standardize on use)\n      iModel: frameworkState.sessionState.iModelConnection, // this prop is needed by many components\n      imodel: frameworkState.sessionState.iModelConnection, // this prop is needed by ViewportProps\n      viewState: frameworkState.sessionState.defaultViewState,\n    };\n    if (mapStateToProps) return mapStateToProps(state, props);\n\n    return props;\n  };\n};\n\n/** Function that will connect a component to the IModelConnection data in the Redux store.\n * @param mapStateToProps optional user function that, if defined, will be executed to provide additional properties from store.\n * @param mapDispatchToProps data passed to Redux connect function.\n * @public\n */\nexport const connectIModelConnection = (\n  mapStateToProps?: any,\n  mapDispatchToProps?: any\n) => {\n  return connect(iModeMapStateToProps(mapStateToProps), mapDispatchToProps);\n};\n\n/** Function that will connect a component to the IModelConnection data in the Redux store\n * @param mapStateToProps optional user function that, if defined, will be executed to provide additional properties from store.\n * @param mapDispatchToProps data passed to Redux connect function.\n * @beta\n *\n * @example\n *   // connect component for both getting and setting ImodelConnection data from Redux store.\n *  import { connectIModelConnection, sessionStateMapDispatchToProps, SessionStateActionsProps } from \"@itwin/appui-react\";\n *\n *  export interface ComponentProps extends SessionStateActionsProps {\n *    myData: string;\n *  }\n *\n *  export const ConnectControl = connectIModelConnection(null, sessionStateMapDispatchToProps)(ComponentClass);\n *\n *  //  this then allows connected control to update the store using a call like shown below.\n *  this.props.setNumItemsSelected(30);\n *\n */\nexport const connectIModelConnectionAndViewState = (\n  mapStateToProps?: any,\n  mapDispatchToProps?: any\n) => {\n  return connect(\n    iModelAndViewMapStateToProps(mapStateToProps),\n    mapDispatchToProps\n  );\n};\n"]}
+{"version":3,"file":"connectIModel.js","sourceRoot":"","sources":["../../../../src/appui-react/redux/connectIModel.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,4CAA4C;AAE5C;;GAEG;AACH,MAAM,oBAAoB,GAAG,CAAC,eAAoB,EAAE,EAAE;IACpD,OAAO,CAAC,KAAU,EAAE,QAAa,EAAE,EAAE;QACnC,MAAM,cAAc,GAAG,KAAK,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC,CAAC,8CAA8C;QAE3G,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,IAAI,eAAe;gBAAE,OAAO,eAAe,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YAC7D,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,UAAU,GAAG;YACjB,gBAAgB,EAAE,cAAc,CAAC,YAAY,CAAC,gBAAgB;YAC9D,MAAM,EAAE,cAAc,CAAC,YAAY,CAAC,gBAAgB;YACpD,MAAM,EAAE,cAAc,CAAC,YAAY,CAAC,gBAAgB;SACrD,CAAC;QAEF,IAAI,eAAe,EAAE,CAAC;YACpB,OAAO;gBACL,GAAG,UAAU;gBACb,GAAG,eAAe,CAAC,KAAK,EAAE,QAAQ,CAAC;aACpC,CAAC;QACJ,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,4BAA4B,GAAG,CAAC,eAAoB,EAAE,EAAE;IAC5D,OAAO,CAAC,KAAU,EAAE,QAAa,EAAE,EAAE;QACnC,MAAM,cAAc,GAAG,KAAK,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC,CAAC,8CAA8C;QAE3G,IAAI,CAAC,cAAc;YAAE,OAAO,EAAE,CAAC;QAE/B,MAAM,KAAK,GAAG;YACZ,GAAG,QAAQ;YACX,gBAAgB,EAAE,cAAc,CAAC,YAAY,CAAC,gBAAgB,EAAE,wEAAwE;YACxI,MAAM,EAAE,cAAc,CAAC,YAAY,CAAC,gBAAgB,EAAE,yCAAyC;YAC/F,MAAM,EAAE,cAAc,CAAC,YAAY,CAAC,gBAAgB,EAAE,uCAAuC;YAC7F,SAAS,EAAE,cAAc,CAAC,YAAY,CAAC,gBAAgB;SACxD,CAAC;QACF,IAAI,eAAe;YAAE,OAAO,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAE1D,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,eAAqB,EACrB,kBAAwB,EACxB,EAAE;IACF,OAAO,OAAO,CAAC,oBAAoB,CAAC,eAAe,CAAC,EAAE,kBAAkB,CAAC,CAAC;AAC5E,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,mCAAmC,GAAG,CACjD,eAAqB,EACrB,kBAAwB,EACxB,EAAE;IACF,OAAO,OAAO,CACZ,4BAA4B,CAAC,eAAe,CAAC,EAC7C,kBAAkB,CACnB,CAAC;AACJ,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module State\n */\n\nimport { connect } from \"react-redux\";\nimport { UiFramework } from \"../UiFramework\";\n\n/* eslint-disable deprecation/deprecation */\n\n/** Private function that will map store's iModelConnection to the 'iModelConnection', 'iModel', and 'imodel' properties of props. This\n * is not ideal but it is a result of not having standard prop name for an iModelConnection.\n */\nconst iModeMapStateToProps = (mapStateToProps: any) => {\n  return (state: any, ownProps: any) => {\n    const frameworkState = state[UiFramework.frameworkStateKey]; // since app sets up key, don't hard-code name\n\n    if (!frameworkState) {\n      if (mapStateToProps) return mapStateToProps(state, ownProps);\n      return {};\n    }\n\n    const storeProps = {\n      iModelConnection: frameworkState.sessionState.iModelConnection,\n      imodel: frameworkState.sessionState.iModelConnection,\n      iModel: frameworkState.sessionState.iModelConnection,\n    };\n\n    if (mapStateToProps) {\n      return {\n        ...storeProps,\n        ...mapStateToProps(state, ownProps),\n      };\n    }\n\n    return storeProps;\n  };\n};\n\n/** Function that will map store's iModelConnection and defaultViewState to the props 'iModelConnection', 'iModel', 'imodel',\n * and 'viewState' property of props\n */\nconst iModelAndViewMapStateToProps = (mapStateToProps: any) => {\n  return (state: any, ownProps: any) => {\n    const frameworkState = state[UiFramework.frameworkStateKey]; // since app sets up key, don't hard-code name\n\n    if (!frameworkState) return {};\n\n    const props = {\n      ...ownProps,\n      iModelConnection: frameworkState.sessionState.iModelConnection, // this prop is required by Unified Selection (TODO: standardize on use)\n      iModel: frameworkState.sessionState.iModelConnection, // this prop is needed by many components\n      imodel: frameworkState.sessionState.iModelConnection, // this prop is needed by ViewportProps\n      viewState: frameworkState.sessionState.defaultViewState,\n    };\n    if (mapStateToProps) return mapStateToProps(state, props);\n\n    return props;\n  };\n};\n\n/** Function that will connect a component to the IModelConnection data in the Redux store.\n * @param mapStateToProps optional user function that, if defined, will be executed to provide additional properties from store.\n * @param mapDispatchToProps data passed to Redux connect function.\n * @public\n * @deprecated in 4.15.0. Components should take iModel connection as props.\n */\nexport const connectIModelConnection = (\n  mapStateToProps?: any,\n  mapDispatchToProps?: any\n) => {\n  return connect(iModeMapStateToProps(mapStateToProps), mapDispatchToProps);\n};\n\n/** Function that will connect a component to the IModelConnection data in the Redux store\n * @param mapStateToProps optional user function that, if defined, will be executed to provide additional properties from store.\n * @param mapDispatchToProps data passed to Redux connect function.\n * @beta\n *\n * @example\n *   // connect component for both getting and setting ImodelConnection data from Redux store.\n *  import { connectIModelConnection, sessionStateMapDispatchToProps, SessionStateActionsProps } from \"@itwin/appui-react\";\n *\n *  export interface ComponentProps extends SessionStateActionsProps {\n *    myData: string;\n *  }\n *\n *  export const ConnectControl = connectIModelConnection(null, sessionStateMapDispatchToProps)(ComponentClass);\n *\n *  //  this then allows connected control to update the store using a call like shown below.\n *  this.props.setNumItemsSelected(30);\n * @deprecated in 4.15.0. Components should take iModel connection and view state as props.\n */\nexport const connectIModelConnectionAndViewState = (\n  mapStateToProps?: any,\n  mapDispatchToProps?: any\n) => {\n  return connect(\n    iModelAndViewMapStateToProps(mapStateToProps),\n    mapDispatchToProps\n  );\n};\n"]}

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

@@ -3,27 +3,28 @@
  */
 /** Shorthand for "any function".  TSLint doesn't like the built-in `Function` type for some reason.
  * @public
+ * @deprecated in 4.15.0. Use `(...args: any[]) => any` instead.
  */
 export type FunctionType = (...args: any[]) => any;
-/**
- * Similar to the built-in [Readonly](https://www.typescriptlang.org/docs/handbook/advanced-types.html#mapped-types), type alias but applied recursively.
+/** Similar to the built-in [Readonly](https://www.typescriptlang.org/docs/handbook/advanced-types.html#mapped-types), type alias but applied recursively.
  * This basically makes all nested properties/members of an object/array immutable.
  * @public
+ * @deprecated in 4.15.0. Use your state management types instead.
  */
 export type DeepReadonly<T> = T extends ReadonlyArray<infer R> ? R extends object ? DeepReadonlyArray<R> : ReadonlyArray<R> : T extends FunctionType ? T : T extends object ? DeepReadonlyObject<T> : T;
 /** TypeScript doesn't actually allow recursive type aliases, so these are just sort of a hack to make DeepReadonly work
  * @public
+ * @deprecated in 4.15.0. Use your state management types instead.
  */
-export interface DeepReadonlyArray<T> extends ReadonlyArray<DeepReadonly<T>> {
-}
+export type DeepReadonlyArray<T> = ReadonlyArray<DeepReadonly<T>>;
 /** TypeScript doesn't actually allow recursive type aliases, so these are just sort of a hack to make DeepReadonly work
  * @public
+ * @deprecated in 4.15.0. Use your state management types instead.
  */
 export type DeepReadonlyObject<T> = {
     readonly [P in keyof T]: DeepReadonly<T[P]>;
 };
-/**
- * A basic Redux [Action](https://redux.js.org/basics/actions).
+/** A basic Redux [Action](https://redux.js.org/basics/actions).
  * Technically, redux only requires actions to have a `type` property.
  *
  * We use a TypeScript [Generic](https://www.typescriptlang.org/docs/handbook/generics.html) interface here to preserve the "literal-ness" of the `type` property.
@@ -31,23 +32,23 @@ export type DeepReadonlyObject<T> = {
  *
  * See the [TS Handbook](https://www.typescriptlang.org/docs/handbook/advanced-types.html#string-literal-types) for more info on TypeScript string literal types.
  * @public
+ * @deprecated in 4.15.0. Use your state management types instead.
  */
 export interface Action<T extends string> {
     type: T;
 }
-/**
- * A Redux [Action](https://redux.js.org/basics/actions), with additional "payload" information.
+/** A Redux [Action](https://redux.js.org/basics/actions), with additional "payload" information.
  * Technically, Redux allows actions to take any shape, provided they specify a `type` property.
  *
  * However, in order to simplify TypeScript typings, we follow this [Flux Standard Actions](https://github.com/redux-utilities/flux-standard-action)-like
  * convention, where all additional action information goes into a `payload` property.
  * @public
+ * @deprecated in 4.15.0. Use your state management types instead.
  */
 export interface ActionWithPayload<T extends string, P> extends Action<T> {
     payload: P;
 }
-/**
- * Creates a basic Redux Redux [Action](https://redux.js.org/basics/actions) without a payload.
+/** Creates a basic Redux Redux [Action](https://redux.js.org/basics/actions) without a payload.
  * **This is meant to be used as a shortcut for defining Action Creators.**
  *
  * For example,
@@ -64,6 +65,7 @@ export interface ActionWithPayload<T extends string, P> extends Action<T> {
  * Note that the generic type parameters can always be omitted - TypeScript will be able to infer them.
  * @param type The string to use as the action's type property. Should have a [string literal type](https://www.typescriptlang.org/docs/handbook/advanced-types.html#string-literal-types).
  * @public
+ * @deprecated in 4.15.0. Use your state management types instead, i.e. {@link https://redux-toolkit.js.org/api/createAction createAction} from `@reduxjs/toolkit` instead.
  */
 export declare function createAction<T extends string>(type: T): Action<T>;
 /**
@@ -85,17 +87,17 @@ export declare function createAction<T extends string>(type: T): Action<T>;
  * @param type The string to use as the action's type property. Should have a [string literal type](https://www.typescriptlang.org/docs/handbook/advanced-types.html#string-literal-types).
  * @param payload The value to use as the action's payload property. May be of any type.
  * @public
+ * @deprecated in 4.15.0. Use {@link https://redux-toolkit.js.org/api/createAction createAction} from `@reduxjs/toolkit` instead.
  */
 export declare function createAction<T extends string, P>(type: T, payload: P): ActionWithPayload<T, DeepReadonly<P>>;
-/**
- * Just an object where every property is a Redux [Action Creator](https://redux.js.org/basics/actions#action-creators).
+/** Just an object where every property is a Redux [Action Creator](https://redux.js.org/basics/actions#action-creators).
  * @public
+ * @deprecated in 4.15.0. Use your state management types instead.
  */
-export type ActionCreatorsObject = {
+export interface ActionCreatorsObject {
     [actionCreatorName: string]: FunctionType;
-};
-/**
- * A TypeScript type alias that represents the [Union Type](https://www.typescriptlang.org/docs/handbook/advanced-types.html#union-types) of all actions
+}
+/** A TypeScript type alias that represents the [Union Type](https://www.typescriptlang.org/docs/handbook/advanced-types.html#union-types) of all actions
  * possibly created by _any_ of the action creators in a given `ActionCreatorsObject`.
  *
  * For example,
@@ -114,10 +116,10 @@ export type ActionCreatorsObject = {
  *            | ActionWithPayload<"ORANGE", number>;
  * ```
  * @public
+ * @deprecated in 4.15.0. Use your state management types instead.
  */
 export type ActionsUnion<A extends ActionCreatorsObject> = ReturnType<A[keyof A]>;
-/**
- * A TypeScript type alias that uses [conditional types](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html) (read: magic)
+/** A TypeScript type alias that uses [conditional types](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html) (read: magic)
  * to represent the _exact_ (literal) type of an action's `type` property.
  *
  * More importantly, this can be used to determine a union type which represents the `type` string literal types for _any_ action in a given `ActionsUnion`.
@@ -134,49 +136,49 @@ export type ActionsUnion<A extends ActionCreatorsObject> = ReturnType<A[keyof A]
  *   type X = "BANANA" | "APPLE" | "ORANGE";
  * ```
  * @public
+ * @deprecated in 4.15.0. Use your state management types instead.
  */
 export type ActionTypes<A extends Action<any>> = A["type"] extends infer X ? X extends string ? X : never : never;
-/**
- * A Redux [Reducer](https://redux.js.org/basics/reducers).
+/** A Redux [Reducer](https://redux.js.org/basics/reducers).
  * @public
+ * @deprecated in 4.15.0. Use your state management types instead.
  */
 export type Reducer<S, A> = (state: S, action: A) => S;
-/**
- * A TypeScript type alias that represents a union of all action types handled by a Redux [Reducer](https://redux.js.org/basics/reducers).
+/** A TypeScript type alias that represents a union of all action types handled by a Redux [Reducer](https://redux.js.org/basics/reducers).
  *
  * If you have created a type-safe reducer function using `combineReducers`, you can use this to infer your actions union type instead of having to define it manually.
  * @public
+ * @deprecated in 4.15.0. Use your state management types instead.
  */
 export type ReducerActions<R> = R extends Reducer<any, infer X> ? X extends ActionWithPayload<infer T, infer P> ? DeepReadonly<ActionWithPayload<T, P>> : X extends Action<infer T2> ? DeepReadonly<Action<T2>> : X : R;
-/**
- * A TypeScript type alias that represents the return type of a Redux [Reducer](https://redux.js.org/basics/reducers).
+/** A TypeScript type alias that represents the return type of a Redux [Reducer](https://redux.js.org/basics/reducers).
  *
  * If you have created a type-safe reducer function using `combineReducers`, you can use this to infer your state type instead of having to define it manually.
  * @public
+ * @deprecated in 4.15.0. Use your state management types instead.
  */
 export type StateType<R extends Reducer<any, any>> = DeepReadonly<ReturnType<R>>;
-/**
- * So we don't actually need to implement our own version of combineReducers, but we are going to cast it
+/** So we don't actually need to implement our own version of combineReducers, but we are going to cast it
  * to this type, which will do a better job of preserving/deducing the Action and State types.
  * @public
+ * @deprecated in 4.15.0. Use your state management types instead.
  */
 export type CombineReducersFunction = <A>(reducers: A) => (state: CombinedReducerState<A>, action: ReducerMapActions<A>) => CombinedReducerState<A>;
-/**
- * A type alias which represents the state created by the reducer returned by combineReducers for a given `reducers` argument.
+/** A type alias which represents the state created by the reducer returned by combineReducers for a given `reducers` argument.
  * Used above by `CombineReducersFunction`, our custom type definition for combineReducers.
  * @public
+ * @deprecated in 4.15.0. Use your state management types instead.
  */
 export type CombinedReducerState<R> = {
     readonly [K in keyof R]: R[K] extends FunctionType ? StateType<R[K]> : never;
 };
-/**
- * A type alias which represents the union type of all actions handled by the reducer returned by combineReducers for a given `reducers` argument.
+/** A type alias which represents the union type of all actions handled by the reducer returned by combineReducers for a given `reducers` argument.
  * Used above by `CombineReducersFunction`, our custom type definition for combineReducers.
  * @public
+ * @deprecated in 4.15.0. Use your state management types instead.
  */
 export type ReducerMapActions<R> = ReducerActions<R[keyof R]>;
-/**
- * Turns an object whose values are different reducer functions, into a single
+/** Turns an object whose values are different reducer functions, into a single
  * reducer function. It will call every child reducer, and gather their results
  * into a single state object, whose keys correspond to the keys of the passed
  * reducer functions.
@@ -193,6 +195,7 @@ export type ReducerMapActions<R> = ReducerActions<R[keyof R]>;
  * Returns: A reducer function that invokes every reducer inside the passed
  *   object, and builds a state object with the same shape.
  * @public
+ * @deprecated in 4.15.0. Use your state management APIs instead.
  */
 export declare const combineReducers: CombineReducersFunction;
 //# sourceMappingURL=redux-ts.d.ts.map