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

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

@@ -1,131 +1,131 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module State
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SessionStateReducer = exports.sessionStateMapDispatchToProps = exports.SessionStateActions = exports.SessionStateActionId = void 0;
-const redux_ts_1 = require("./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.
- * @public
- */
-var SessionStateActionId;
-(function (SessionStateActionId) {
-    SessionStateActionId["SetNumItemsSelected"] = "sessionstate:set-num-items-selected";
-    SessionStateActionId["SetAvailableSelectionScopes"] = "sessionstate:set-available-selection-scopes";
-    SessionStateActionId["SetSelectionScope"] = "sessionstate:set-selection-scope";
-    SessionStateActionId["SetActiveIModelId"] = "sessionstate:set-active-imodelid";
-    SessionStateActionId["SetIModelConnection"] = "sessionstate:set-imodel-connection";
-    SessionStateActionId["SetDefaultIModelViewportControlId"] = "sessionstate:set-default-viewportid";
-    SessionStateActionId["SetDefaultViewId"] = "sessionstate:set-default-viewid";
-    SessionStateActionId["SetDefaultViewState"] = "sessionstate:set-default-view-state";
-    SessionStateActionId["UpdateCursorMenu"] = "sessionstate:update-cursor-menu";
-})(SessionStateActionId = exports.SessionStateActionId || (exports.SessionStateActionId = {}));
-const defaultSelectionScope = { id: "element", label: "Element" };
-/** used on first call of SessionStateReducer */
-const initialState = {
-    /** number of selected items in Presentation Selection */
-    numItemsSelected: 0,
-    /** initialize to only support "Element" scope, this will be overwritten when iModelConnection is established */
-    availableSelectionScopes: [defaultSelectionScope],
-    /** initialize to active selection scope to "Element", this will be overwritten when iModelConnection is established */
-    activeSelectionScope: defaultSelectionScope.id,
-    /** set to iModelId if an iModel is active else it is an empty string, so initialize to empty string */
-    iModelId: "",
-    defaultIModelViewportControlId: undefined,
-    defaultViewId: undefined,
-    defaultViewState: undefined,
-    iModelConnection: undefined,
-    cursorMenuData: undefined,
-};
-/** An object with a function that creates each SessionStateReducer that can be handled by our reducer.
- * @public
- */
-exports.SessionStateActions = {
-    setActiveIModelId: 
-    // istanbul ignore next
-    (iModelId) => (0, redux_ts_1.createAction)(SessionStateActionId.SetActiveIModelId, iModelId),
-    setAvailableSelectionScopes: 
-    // istanbul ignore next
-    (availableSelectionScopes) => (0, redux_ts_1.createAction)(SessionStateActionId.SetAvailableSelectionScopes, availableSelectionScopes),
-    setDefaultIModelViewportControlId: (iModelViewportControlId) => (0, redux_ts_1.createAction)(SessionStateActionId.SetDefaultIModelViewportControlId, iModelViewportControlId),
-    setDefaultViewId: (viewId) => (0, redux_ts_1.createAction)(SessionStateActionId.SetDefaultViewId, viewId),
-    setDefaultViewState: 
-    // istanbul ignore next
-    (viewState) => (0, redux_ts_1.createAction)(SessionStateActionId.SetDefaultViewState, viewState),
-    setNumItemsSelected: (numSelected) => (0, redux_ts_1.createAction)(SessionStateActionId.SetNumItemsSelected, numSelected),
-    setIModelConnection: 
-    // istanbul ignore next
-    (iModelConnection) => (0, redux_ts_1.createAction)(SessionStateActionId.SetIModelConnection, iModelConnection),
-    setSelectionScope: 
-    // istanbul ignore next
-    (activeSelectionScope) => (0, redux_ts_1.createAction)(SessionStateActionId.SetSelectionScope, activeSelectionScope),
-    updateCursorMenu: 
-    // istanbul ignore next
-    (cursorMenuData) => (0, redux_ts_1.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
- */
-// ...SessionStateActionsProps
-exports.sessionStateMapDispatchToProps = { ...exports.SessionStateActions };
-/** Handles actions to update SessionState.
- * @public
- */
-function SessionStateReducer(state = initialState, action) {
-    switch (action.type) {
-        case SessionStateActionId.SetNumItemsSelected: {
-            // istanbul ignore else
-            if (undefined !== action.payload)
-                return { ...state, numItemsSelected: action.payload };
-            else
-                return { ...state, numItemsSelected: 0 };
-        }
-        case SessionStateActionId.SetAvailableSelectionScopes: {
-            const payloadArray = [];
-            action.payload.forEach((scope) => payloadArray.push(scope));
-            // istanbul ignore else
-            if (undefined !== action.payload)
-                return { ...state, availableSelectionScopes: payloadArray };
-            else
-                return { ...state, availableSelectionScopes: [defaultSelectionScope] };
-        }
-        case SessionStateActionId.SetSelectionScope: {
-            // istanbul ignore else
-            if (undefined !== action.payload)
-                return { ...state, activeSelectionScope: action.payload };
-            else
-                return { ...state, activeSelectionScope: defaultSelectionScope.id };
-        }
-        case SessionStateActionId.SetActiveIModelId: {
-            // istanbul ignore else
-            if (undefined !== action.payload)
-                return { ...state, iModelId: action.payload };
-            else
-                return { ...state, iModelId: "" };
-        }
-        case SessionStateActionId.SetDefaultIModelViewportControlId: {
-            return { ...state, defaultIModelViewportControlId: action.payload };
-        }
-        case SessionStateActionId.SetDefaultViewId: {
-            return { ...state, defaultViewId: action.payload };
-        }
-        case SessionStateActionId.SetDefaultViewState: {
-            return { ...state, defaultViewState: action.payload };
-        }
-        case SessionStateActionId.SetIModelConnection: {
-            return { ...state, iModelConnection: action.payload };
-        }
-        case SessionStateActionId.UpdateCursorMenu: {
-            return { ...state, cursorMenuData: action.payload };
-        }
-    }
-    return state;
-}
-exports.SessionStateReducer = SessionStateReducer;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module State
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SessionStateReducer = exports.sessionStateMapDispatchToProps = exports.SessionStateActions = exports.SessionStateActionId = void 0;
+const redux_ts_1 = require("./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.
+ * @public
+ */
+var SessionStateActionId;
+(function (SessionStateActionId) {
+    SessionStateActionId["SetNumItemsSelected"] = "sessionstate:set-num-items-selected";
+    SessionStateActionId["SetAvailableSelectionScopes"] = "sessionstate:set-available-selection-scopes";
+    SessionStateActionId["SetSelectionScope"] = "sessionstate:set-selection-scope";
+    SessionStateActionId["SetActiveIModelId"] = "sessionstate:set-active-imodelid";
+    SessionStateActionId["SetIModelConnection"] = "sessionstate:set-imodel-connection";
+    SessionStateActionId["SetDefaultIModelViewportControlId"] = "sessionstate:set-default-viewportid";
+    SessionStateActionId["SetDefaultViewId"] = "sessionstate:set-default-viewid";
+    SessionStateActionId["SetDefaultViewState"] = "sessionstate:set-default-view-state";
+    SessionStateActionId["UpdateCursorMenu"] = "sessionstate:update-cursor-menu";
+})(SessionStateActionId = exports.SessionStateActionId || (exports.SessionStateActionId = {}));
+const defaultSelectionScope = { id: "element", label: "Element" };
+/** used on first call of SessionStateReducer */
+const initialState = {
+    /** number of selected items in Presentation Selection */
+    numItemsSelected: 0,
+    /** initialize to only support "Element" scope, this will be overwritten when iModelConnection is established */
+    availableSelectionScopes: [defaultSelectionScope],
+    /** initialize to active selection scope to "Element", this will be overwritten when iModelConnection is established */
+    activeSelectionScope: defaultSelectionScope.id,
+    /** set to iModelId if an iModel is active else it is an empty string, so initialize to empty string */
+    iModelId: "",
+    defaultIModelViewportControlId: undefined,
+    defaultViewId: undefined,
+    defaultViewState: undefined,
+    iModelConnection: undefined,
+    cursorMenuData: undefined,
+};
+/** An object with a function that creates each SessionStateReducer that can be handled by our reducer.
+ * @public
+ */
+exports.SessionStateActions = {
+    setActiveIModelId: 
+    // istanbul ignore next
+    (iModelId) => (0, redux_ts_1.createAction)(SessionStateActionId.SetActiveIModelId, iModelId),
+    setAvailableSelectionScopes: 
+    // istanbul ignore next
+    (availableSelectionScopes) => (0, redux_ts_1.createAction)(SessionStateActionId.SetAvailableSelectionScopes, availableSelectionScopes),
+    setDefaultIModelViewportControlId: (iModelViewportControlId) => (0, redux_ts_1.createAction)(SessionStateActionId.SetDefaultIModelViewportControlId, iModelViewportControlId),
+    setDefaultViewId: (viewId) => (0, redux_ts_1.createAction)(SessionStateActionId.SetDefaultViewId, viewId),
+    setDefaultViewState: 
+    // istanbul ignore next
+    (viewState) => (0, redux_ts_1.createAction)(SessionStateActionId.SetDefaultViewState, viewState),
+    setNumItemsSelected: (numSelected) => (0, redux_ts_1.createAction)(SessionStateActionId.SetNumItemsSelected, numSelected),
+    setIModelConnection: 
+    // istanbul ignore next
+    (iModelConnection) => (0, redux_ts_1.createAction)(SessionStateActionId.SetIModelConnection, iModelConnection),
+    setSelectionScope: 
+    // istanbul ignore next
+    (activeSelectionScope) => (0, redux_ts_1.createAction)(SessionStateActionId.SetSelectionScope, activeSelectionScope),
+    updateCursorMenu: 
+    // istanbul ignore next
+    (cursorMenuData) => (0, redux_ts_1.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
+ */
+// ...SessionStateActionsProps
+exports.sessionStateMapDispatchToProps = { ...exports.SessionStateActions };
+/** Handles actions to update SessionState.
+ * @public
+ */
+function SessionStateReducer(state = initialState, action) {
+    switch (action.type) {
+        case SessionStateActionId.SetNumItemsSelected: {
+            // istanbul ignore else
+            if (undefined !== action.payload)
+                return { ...state, numItemsSelected: action.payload };
+            else
+                return { ...state, numItemsSelected: 0 };
+        }
+        case SessionStateActionId.SetAvailableSelectionScopes: {
+            const payloadArray = [];
+            action.payload.forEach((scope) => payloadArray.push(scope));
+            // istanbul ignore else
+            if (undefined !== action.payload)
+                return { ...state, availableSelectionScopes: payloadArray };
+            else
+                return { ...state, availableSelectionScopes: [defaultSelectionScope] };
+        }
+        case SessionStateActionId.SetSelectionScope: {
+            // istanbul ignore else
+            if (undefined !== action.payload)
+                return { ...state, activeSelectionScope: action.payload };
+            else
+                return { ...state, activeSelectionScope: defaultSelectionScope.id };
+        }
+        case SessionStateActionId.SetActiveIModelId: {
+            // istanbul ignore else
+            if (undefined !== action.payload)
+                return { ...state, iModelId: action.payload };
+            else
+                return { ...state, iModelId: "" };
+        }
+        case SessionStateActionId.SetDefaultIModelViewportControlId: {
+            return { ...state, defaultIModelViewportControlId: action.payload };
+        }
+        case SessionStateActionId.SetDefaultViewId: {
+            return { ...state, defaultViewId: action.payload };
+        }
+        case SessionStateActionId.SetDefaultViewState: {
+            return { ...state, defaultViewState: action.payload };
+        }
+        case SessionStateActionId.SetIModelConnection: {
+            return { ...state, iModelConnection: action.payload };
+        }
+        case SessionStateActionId.UpdateCursorMenu: {
+            return { ...state, cursorMenuData: action.payload };
+        }
+    }
+    return state;
+}
+exports.SessionStateReducer = SessionStateReducer;
 //# sourceMappingURL=SessionState.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"SessionState.js","sourceRoot":"","sources":["../../../../src/appui-react/redux/SessionState.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAMH,yCAAsE;AAuBtE;;;GAGG;AACH,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,GAApB,4BAAoB,KAApB,4BAAoB,QAU/B;AAiBD,MAAM,qBAAqB,GAAG,EAAE,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAgC,CAAC;AAEhG,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;CAC1B,CAAC;AAiBF;;GAEG;AACU,QAAA,mBAAmB,GAAG;IACjC,iBAAiB;IACf,uBAAuB;IACvB,CAAC,QAAgB,EAAE,EAAE,CAAC,IAAA,uBAAY,EAAC,oBAAoB,CAAC,iBAAiB,EAAE,QAAQ,CAAC;IACtF,2BAA2B;IACzB,uBAAuB;IACvB,CAAC,wBAAsD,EAAE,EAAE,CAAC,IAAA,uBAAY,EAAC,oBAAoB,CAAC,2BAA2B,EAAE,wBAAwB,CAAC;IACtJ,iCAAiC,EAAE,CAAC,uBAA+B,EAAE,EAAE,CAAC,IAAA,uBAAY,EAAC,oBAAoB,CAAC,iCAAiC,EAAE,uBAAuB,CAAC;IACrK,gBAAgB,EAAE,CAAC,MAAc,EAAE,EAAE,CAAC,IAAA,uBAAY,EAAC,oBAAoB,CAAC,gBAAgB,EAAE,MAAM,CAAC;IACjG,mBAAmB;IACjB,uBAAuB;IACvB,CAAC,SAAc,EAAE,EAAE,CAAC,IAAA,uBAAY,EAAC,oBAAoB,CAAC,mBAAmB,EAAE,SAAS,CAAC;IACvF,mBAAmB,EAAE,CAAC,WAAmB,EAAE,EAAE,CAAC,IAAA,uBAAY,EAAC,oBAAoB,CAAC,mBAAmB,EAAE,WAAW,CAAC;IACjH,mBAAmB;IACjB,uBAAuB;IACvB,CAAC,gBAAqB,EAAE,EAAE,CAAC,IAAA,uBAAY,EAAC,oBAAoB,CAAC,mBAAmB,EAAE,gBAAgB,CAAC;IACrG,iBAAiB;IACf,uBAAuB;IACvB,CAAC,oBAA4B,EAAE,EAAE,CAAC,IAAA,uBAAY,EAAC,oBAAoB,CAAC,iBAAiB,EAAE,oBAAoB,CAAC;IAC9G,gBAAgB;IACd,uBAAuB;IACvB,CAAC,cAA8B,EAAE,EAAE,CAAC,IAAA,uBAAY,EAAC,oBAAoB,CAAC,gBAAgB,EAAE,cAAc,CAAC;CAC1G,CAAC;AAEF;;;GAGG;AACH,8BAA8B;AACjB,QAAA,8BAA8B,GAAG,EAAE,GAAG,2BAAmB,EAAE,CAAC;AAOzE;;GAEG;AACH,SAAgB,mBAAmB,CAAC,QAAsB,YAAY,EAAE,MAAgC;IACtG,QAAQ,MAAM,CAAC,IAAI,EAAE;QACnB,KAAK,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;YAC7C,uBAAuB;YACvB,IAAI,SAAS,KAAK,MAAM,CAAC,OAAO;gBAC9B,OAAO,EAAE,GAAG,KAAK,EAAE,gBAAgB,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;;gBAEtD,OAAO,EAAE,GAAG,KAAK,EAAE,gBAAgB,EAAE,CAAC,EAAE,CAAC;SAC5C;QACD,KAAK,oBAAoB,CAAC,2BAA2B,CAAC,CAAC;YACrD,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,uBAAuB;YACvB,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;SAC1E;QACD,KAAK,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;YAC3C,uBAAuB;YACvB,IAAI,SAAS,KAAK,MAAM,CAAC,OAAO;gBAC9B,OAAO,EAAE,GAAG,KAAK,EAAE,oBAAoB,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;;gBAE1D,OAAO,EAAE,GAAG,KAAK,EAAE,oBAAoB,EAAE,qBAAqB,CAAC,EAAE,EAAE,CAAC;SACvE;QACD,KAAK,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;YAC3C,uBAAuB;YACvB,IAAI,SAAS,KAAK,MAAM,CAAC,OAAO;gBAC9B,OAAO,EAAE,GAAG,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;;gBAE9C,OAAO,EAAE,GAAG,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;SACrC;QACD,KAAK,oBAAoB,CAAC,iCAAiC,CAAC,CAAC;YAC3D,OAAO,EAAE,GAAG,KAAK,EAAE,8BAA8B,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;SACrE;QACD,KAAK,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;YAC1C,OAAO,EAAE,GAAG,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;SACpD;QACD,KAAK,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;YAC7C,OAAO,EAAE,GAAG,KAAK,EAAE,gBAAgB,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;SACvD;QACD,KAAK,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;YAC7C,OAAO,EAAE,GAAG,KAAK,EAAE,gBAAgB,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;SACvD;QACD,KAAK,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;YAC1C,OAAO,EAAE,GAAG,KAAK,EAAE,cAAc,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;SACrD;KACF;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAlDD,kDAkDC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module State\r\n */\r\n\r\n// The following definitions are causing extract-api issues on linux so for now just using any until we can figure out the issue.\r\nimport { XAndY } from \"@itwin/core-geometry\";\r\n// import { IModelConnection, ViewState } from \"@itwin/core-frontend\";\r\nimport { MenuItemProps } from \"../shared/MenuItem\";\r\nimport { ActionsUnion, createAction, DeepReadonly } from \"./redux-ts\";\r\n\r\n// cSpell:ignore configurableui snapmode toolprompt sessionstate imodelid viewid viewportid rulesetid\r\n\r\n/** PresentationSelectionScope holds the id and the localized label for a selection scope supported for a specific iModel.\r\n * Added to avoid an api-extract error caused by using SelectionScope.\r\n * @public\r\n */\r\nexport interface PresentationSelectionScope {\r\n  id: string;\r\n  label: string;\r\n}\r\n\r\n/** Definition of data added to Redux store to define cursor menu.  If menuItems are empty the menu control is not displayed.\r\n * To close the menu clear the menuItems or pass in undefined as the CursorData.\r\n * @public\r\n */\r\nexport interface CursorMenuData {\r\n  items: MenuItemProps[];\r\n  position: XAndY;\r\n  childWindowId?: string;\r\n}\r\n\r\n/** Action Ids used by Redux and to send sync UI components. Typically used to refresh visibility or enable state of control.\r\n *  Since these are also used as sync ids they should be in lowercase.\r\n * @public\r\n */\r\nexport enum SessionStateActionId {\r\n  SetNumItemsSelected = \"sessionstate:set-num-items-selected\",\r\n  SetAvailableSelectionScopes = \"sessionstate:set-available-selection-scopes\",\r\n  SetSelectionScope = \"sessionstate:set-selection-scope\",\r\n  SetActiveIModelId = \"sessionstate:set-active-imodelid\",\r\n  SetIModelConnection = \"sessionstate:set-imodel-connection\",\r\n  SetDefaultIModelViewportControlId = \"sessionstate:set-default-viewportid\",\r\n  SetDefaultViewId = \"sessionstate:set-default-viewid\",\r\n  SetDefaultViewState = \"sessionstate:set-default-view-state\",\r\n  UpdateCursorMenu = \"sessionstate:update-cursor-menu\",\r\n}\r\n\r\n/** The portion of state managed by the SessionStateReducer.\r\n * @public\r\n */\r\nexport interface SessionState {\r\n  numItemsSelected: number;\r\n  availableSelectionScopes: PresentationSelectionScope[];\r\n  activeSelectionScope: string;\r\n  iModelId: string;\r\n  defaultIModelViewportControlId: string | undefined;\r\n  defaultViewId: string | undefined;\r\n  defaultViewState: any | undefined;\r\n  iModelConnection: any | undefined;\r\n  cursorMenuData: CursorMenuData | undefined;\r\n}\r\n\r\nconst defaultSelectionScope = { id: \"element\", label: \"Element\" } as PresentationSelectionScope;\r\n\r\n/** used on first call of SessionStateReducer */\r\nconst initialState: SessionState = {\r\n  /** number of selected items in Presentation Selection */\r\n  numItemsSelected: 0,\r\n  /** initialize to only support \"Element\" scope, this will be overwritten when iModelConnection is established */\r\n  availableSelectionScopes: [defaultSelectionScope],\r\n  /** initialize to active selection scope to \"Element\", this will be overwritten when iModelConnection is established */\r\n  activeSelectionScope: defaultSelectionScope.id,\r\n  /** set to iModelId if an iModel is active else it is an empty string, so initialize to empty string */\r\n  iModelId: \"\",\r\n  defaultIModelViewportControlId: undefined,\r\n  defaultViewId: undefined,\r\n  defaultViewState: undefined,\r\n  iModelConnection: undefined,\r\n  cursorMenuData: undefined,\r\n};\r\n\r\n/** An interface that allows redux connected object to dispatch changes to the SessionState reducer.\r\n * @beta\r\n */\r\nexport interface SessionStateActionsProps {\r\n  setActiveIModelId: (typeof SessionStateActions.setActiveIModelId);\r\n  setAvailableSelectionScopes: (typeof SessionStateActions.setAvailableSelectionScopes);\r\n  setDefaultIModelViewportControlId: (typeof SessionStateActions.setDefaultIModelViewportControlId);\r\n  setDefaultViewId: (typeof SessionStateActions.setDefaultViewId);\r\n  setDefaultViewState: (typeof SessionStateActions.setDefaultViewState);\r\n  setIModelConnection: (typeof SessionStateActions.setIModelConnection);\r\n  setNumItemsSelected: (typeof SessionStateActions.setNumItemsSelected);\r\n  setSelectionScope: (typeof SessionStateActions.setSelectionScope);\r\n  updateCursorMenu: (typeof SessionStateActions.updateCursorMenu);\r\n}\r\n\r\n/** An object with a function that creates each SessionStateReducer that can be handled by our reducer.\r\n * @public\r\n */\r\nexport const SessionStateActions = {  // eslint-disable-line @typescript-eslint/naming-convention\r\n  setActiveIModelId:\r\n    // istanbul ignore next\r\n    (iModelId: string) => createAction(SessionStateActionId.SetActiveIModelId, iModelId),\r\n  setAvailableSelectionScopes:\r\n    // istanbul ignore next\r\n    (availableSelectionScopes: PresentationSelectionScope[]) => createAction(SessionStateActionId.SetAvailableSelectionScopes, availableSelectionScopes),\r\n  setDefaultIModelViewportControlId: (iModelViewportControlId: string) => createAction(SessionStateActionId.SetDefaultIModelViewportControlId, iModelViewportControlId),\r\n  setDefaultViewId: (viewId: string) => createAction(SessionStateActionId.SetDefaultViewId, viewId),\r\n  setDefaultViewState:\r\n    // istanbul ignore next\r\n    (viewState: any) => createAction(SessionStateActionId.SetDefaultViewState, viewState),\r\n  setNumItemsSelected: (numSelected: number) => createAction(SessionStateActionId.SetNumItemsSelected, numSelected),\r\n  setIModelConnection:\r\n    // istanbul ignore next\r\n    (iModelConnection: any) => createAction(SessionStateActionId.SetIModelConnection, iModelConnection),\r\n  setSelectionScope:\r\n    // istanbul ignore next\r\n    (activeSelectionScope: string) => createAction(SessionStateActionId.SetSelectionScope, activeSelectionScope),\r\n  updateCursorMenu:\r\n    // istanbul ignore next\r\n    (cursorMenuData: CursorMenuData) => createAction(SessionStateActionId.UpdateCursorMenu, cursorMenuData),\r\n};\r\n\r\n/** Object that contains available actions that modify SessionState. Parent control's props should\r\n * extend from SessionStateActionsProps before using this in Redux 'connect' function.\r\n * @beta\r\n */\r\n// ...SessionStateActionsProps\r\nexport const sessionStateMapDispatchToProps = { ...SessionStateActions };\r\n\r\n/** Union of SessionState Redux actions\r\n * @public\r\n */\r\nexport type SessionStateActionsUnion = ActionsUnion<typeof SessionStateActions>;\r\n\r\n/** Handles actions to update SessionState.\r\n * @public\r\n */\r\nexport function SessionStateReducer(state: SessionState = initialState, action: SessionStateActionsUnion): DeepReadonly<SessionState> {\r\n  switch (action.type) {\r\n    case SessionStateActionId.SetNumItemsSelected: {\r\n      // istanbul ignore else\r\n      if (undefined !== action.payload)\r\n        return { ...state, numItemsSelected: action.payload };\r\n      else\r\n        return { ...state, numItemsSelected: 0 };\r\n    }\r\n    case SessionStateActionId.SetAvailableSelectionScopes: {\r\n      const payloadArray: PresentationSelectionScope[] = [];\r\n      action.payload.forEach((scope) => payloadArray.push(scope));\r\n      // istanbul ignore else\r\n      if (undefined !== action.payload)\r\n        return { ...state, availableSelectionScopes: payloadArray };\r\n      else\r\n        return { ...state, availableSelectionScopes: [defaultSelectionScope] };\r\n    }\r\n    case SessionStateActionId.SetSelectionScope: {\r\n      // istanbul ignore else\r\n      if (undefined !== action.payload)\r\n        return { ...state, activeSelectionScope: action.payload };\r\n      else\r\n        return { ...state, activeSelectionScope: defaultSelectionScope.id };\r\n    }\r\n    case SessionStateActionId.SetActiveIModelId: {\r\n      // istanbul ignore else\r\n      if (undefined !== action.payload)\r\n        return { ...state, iModelId: action.payload };\r\n      else\r\n        return { ...state, iModelId: \"\" };\r\n    }\r\n    case SessionStateActionId.SetDefaultIModelViewportControlId: {\r\n      return { ...state, defaultIModelViewportControlId: action.payload };\r\n    }\r\n    case SessionStateActionId.SetDefaultViewId: {\r\n      return { ...state, defaultViewId: action.payload };\r\n    }\r\n    case SessionStateActionId.SetDefaultViewState: {\r\n      return { ...state, defaultViewState: action.payload };\r\n    }\r\n    case SessionStateActionId.SetIModelConnection: {\r\n      return { ...state, iModelConnection: action.payload };\r\n    }\r\n    case SessionStateActionId.UpdateCursorMenu: {\r\n      return { ...state, cursorMenuData: action.payload };\r\n    }\r\n  }\r\n\r\n  return state;\r\n}\r\n"]}
+{"version":3,"file":"SessionState.js","sourceRoot":"","sources":["../../../../src/appui-react/redux/SessionState.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAMH,yCAAsE;AAuBtE;;;GAGG;AACH,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,GAApB,4BAAoB,KAApB,4BAAoB,QAU/B;AAiBD,MAAM,qBAAqB,GAAG,EAAE,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAgC,CAAC;AAEhG,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;CAC1B,CAAC;AAiBF;;GAEG;AACU,QAAA,mBAAmB,GAAG;IACjC,iBAAiB;IACf,uBAAuB;IACvB,CAAC,QAAgB,EAAE,EAAE,CAAC,IAAA,uBAAY,EAAC,oBAAoB,CAAC,iBAAiB,EAAE,QAAQ,CAAC;IACtF,2BAA2B;IACzB,uBAAuB;IACvB,CAAC,wBAAsD,EAAE,EAAE,CAAC,IAAA,uBAAY,EAAC,oBAAoB,CAAC,2BAA2B,EAAE,wBAAwB,CAAC;IACtJ,iCAAiC,EAAE,CAAC,uBAA+B,EAAE,EAAE,CAAC,IAAA,uBAAY,EAAC,oBAAoB,CAAC,iCAAiC,EAAE,uBAAuB,CAAC;IACrK,gBAAgB,EAAE,CAAC,MAAc,EAAE,EAAE,CAAC,IAAA,uBAAY,EAAC,oBAAoB,CAAC,gBAAgB,EAAE,MAAM,CAAC;IACjG,mBAAmB;IACjB,uBAAuB;IACvB,CAAC,SAAc,EAAE,EAAE,CAAC,IAAA,uBAAY,EAAC,oBAAoB,CAAC,mBAAmB,EAAE,SAAS,CAAC;IACvF,mBAAmB,EAAE,CAAC,WAAmB,EAAE,EAAE,CAAC,IAAA,uBAAY,EAAC,oBAAoB,CAAC,mBAAmB,EAAE,WAAW,CAAC;IACjH,mBAAmB;IACjB,uBAAuB;IACvB,CAAC,gBAAqB,EAAE,EAAE,CAAC,IAAA,uBAAY,EAAC,oBAAoB,CAAC,mBAAmB,EAAE,gBAAgB,CAAC;IACrG,iBAAiB;IACf,uBAAuB;IACvB,CAAC,oBAA4B,EAAE,EAAE,CAAC,IAAA,uBAAY,EAAC,oBAAoB,CAAC,iBAAiB,EAAE,oBAAoB,CAAC;IAC9G,gBAAgB;IACd,uBAAuB;IACvB,CAAC,cAA8B,EAAE,EAAE,CAAC,IAAA,uBAAY,EAAC,oBAAoB,CAAC,gBAAgB,EAAE,cAAc,CAAC;CAC1G,CAAC;AAEF;;;GAGG;AACH,8BAA8B;AACjB,QAAA,8BAA8B,GAAG,EAAE,GAAG,2BAAmB,EAAE,CAAC;AAOzE;;GAEG;AACH,SAAgB,mBAAmB,CAAC,QAAsB,YAAY,EAAE,MAAgC;IACtG,QAAQ,MAAM,CAAC,IAAI,EAAE;QACnB,KAAK,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;YAC7C,uBAAuB;YACvB,IAAI,SAAS,KAAK,MAAM,CAAC,OAAO;gBAC9B,OAAO,EAAE,GAAG,KAAK,EAAE,gBAAgB,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;;gBAEtD,OAAO,EAAE,GAAG,KAAK,EAAE,gBAAgB,EAAE,CAAC,EAAE,CAAC;SAC5C;QACD,KAAK,oBAAoB,CAAC,2BAA2B,CAAC,CAAC;YACrD,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,uBAAuB;YACvB,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;SAC1E;QACD,KAAK,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;YAC3C,uBAAuB;YACvB,IAAI,SAAS,KAAK,MAAM,CAAC,OAAO;gBAC9B,OAAO,EAAE,GAAG,KAAK,EAAE,oBAAoB,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;;gBAE1D,OAAO,EAAE,GAAG,KAAK,EAAE,oBAAoB,EAAE,qBAAqB,CAAC,EAAE,EAAE,CAAC;SACvE;QACD,KAAK,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;YAC3C,uBAAuB;YACvB,IAAI,SAAS,KAAK,MAAM,CAAC,OAAO;gBAC9B,OAAO,EAAE,GAAG,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;;gBAE9C,OAAO,EAAE,GAAG,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;SACrC;QACD,KAAK,oBAAoB,CAAC,iCAAiC,CAAC,CAAC;YAC3D,OAAO,EAAE,GAAG,KAAK,EAAE,8BAA8B,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;SACrE;QACD,KAAK,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;YAC1C,OAAO,EAAE,GAAG,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;SACpD;QACD,KAAK,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;YAC7C,OAAO,EAAE,GAAG,KAAK,EAAE,gBAAgB,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;SACvD;QACD,KAAK,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;YAC7C,OAAO,EAAE,GAAG,KAAK,EAAE,gBAAgB,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;SACvD;QACD,KAAK,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;YAC1C,OAAO,EAAE,GAAG,KAAK,EAAE,cAAc,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;SACrD;KACF;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAlDD,kDAkDC","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 { XAndY } from \"@itwin/core-geometry\";\n// import { IModelConnection, ViewState } from \"@itwin/core-frontend\";\nimport { MenuItemProps } from \"../shared/MenuItem\";\nimport { ActionsUnion, createAction, DeepReadonly } from \"./redux-ts\";\n\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 */\nexport interface CursorMenuData {\n  items: MenuItemProps[];\n  position: XAndY;\n  childWindowId?: string;\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 | undefined;\n  iModelConnection: any | undefined;\n  cursorMenuData: CursorMenuData | undefined;\n}\n\nconst defaultSelectionScope = { id: \"element\", label: \"Element\" } 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,\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 = {  // eslint-disable-line @typescript-eslint/naming-convention\n  setActiveIModelId:\n    // istanbul ignore next\n    (iModelId: string) => createAction(SessionStateActionId.SetActiveIModelId, iModelId),\n  setAvailableSelectionScopes:\n    // istanbul ignore next\n    (availableSelectionScopes: PresentationSelectionScope[]) => createAction(SessionStateActionId.SetAvailableSelectionScopes, availableSelectionScopes),\n  setDefaultIModelViewportControlId: (iModelViewportControlId: string) => createAction(SessionStateActionId.SetDefaultIModelViewportControlId, iModelViewportControlId),\n  setDefaultViewId: (viewId: string) => createAction(SessionStateActionId.SetDefaultViewId, viewId),\n  setDefaultViewState:\n    // istanbul ignore next\n    (viewState: any) => createAction(SessionStateActionId.SetDefaultViewState, viewState),\n  setNumItemsSelected: (numSelected: number) => createAction(SessionStateActionId.SetNumItemsSelected, numSelected),\n  setIModelConnection:\n    // istanbul ignore next\n    (iModelConnection: any) => createAction(SessionStateActionId.SetIModelConnection, iModelConnection),\n  setSelectionScope:\n    // istanbul ignore next\n    (activeSelectionScope: string) => createAction(SessionStateActionId.SetSelectionScope, activeSelectionScope),\n  updateCursorMenu:\n    // istanbul ignore next\n    (cursorMenuData: CursorMenuData) => 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(state: SessionState = initialState, action: SessionStateActionsUnion): DeepReadonly<SessionState> {\n  switch (action.type) {\n    case SessionStateActionId.SetNumItemsSelected: {\n      // istanbul ignore else\n      if (undefined !== action.payload)\n        return { ...state, numItemsSelected: action.payload };\n      else\n        return { ...state, numItemsSelected: 0 };\n    }\n    case SessionStateActionId.SetAvailableSelectionScopes: {\n      const payloadArray: PresentationSelectionScope[] = [];\n      action.payload.forEach((scope) => payloadArray.push(scope));\n      // istanbul ignore else\n      if (undefined !== action.payload)\n        return { ...state, availableSelectionScopes: payloadArray };\n      else\n        return { ...state, availableSelectionScopes: [defaultSelectionScope] };\n    }\n    case SessionStateActionId.SetSelectionScope: {\n      // istanbul ignore else\n      if (undefined !== action.payload)\n        return { ...state, activeSelectionScope: action.payload };\n      else\n        return { ...state, activeSelectionScope: defaultSelectionScope.id };\n    }\n    case SessionStateActionId.SetActiveIModelId: {\n      // istanbul ignore else\n      if (undefined !== action.payload)\n        return { ...state, iModelId: action.payload };\n      else\n        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 { ...state, cursorMenuData: action.payload };\n    }\n  }\n\n  return state;\n}\n"]}

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

@@ -1,44 +1,44 @@
-/** @packageDocumentation
- * @module State
- */
-import { Store } from "redux";
-import { FrameworkState } from "./FrameworkState";
-import { 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
- */
-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
- * and/or extensions are loaded.
- * @public
- */
-export declare class StateManager {
-    private static _LOG_CATEGORY;
-    private _store;
-    private _defaultReducers;
-    private static _singletonStore;
-    /**
-     * StateManager construct.
-     * @param defaultReducers Default set of Reducers used by the current application. If this object does not contain the [[FrameworkReducer]] it will automatically be added.
-     */
-    constructor(defaultReducers?: NameToReducerMap);
-    /** Method to test if the StateManager has been initialized.
-     * @param suppressErrorLog If true and the StateManager is not initialized a log message will be output.
-     */
-    static isInitialized(suppressErrorLog?: boolean): boolean;
-    /** Return the current Redux store. Useful when using connect method to connect a Ui Component to the store. */
-    static get store(): Store<any>;
-    /** Return the current state from the Redux store. */
-    static get state(): any;
-    private combineDynamicAndDefaultReducers;
-    /** To be used only in unit test
-     * @internal
-     */
-    static clearStore(): void;
-}
+/** @packageDocumentation
+ * @module State
+ */
+import { Store } from "redux";
+import { FrameworkState } from "./FrameworkState";
+import { 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
+ */
+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
+ * and/or extensions are loaded.
+ * @public
+ */
+export declare class StateManager {
+    private static _LOG_CATEGORY;
+    private _store;
+    private _defaultReducers;
+    private static _singletonStore;
+    /**
+     * StateManager construct.
+     * @param defaultReducers Default set of Reducers used by the current application. If this object does not contain the [[FrameworkReducer]] it will automatically be added.
+     */
+    constructor(defaultReducers?: NameToReducerMap);
+    /** Method to test if the StateManager has been initialized.
+     * @param suppressErrorLog If true and the StateManager is not initialized a log message will be output.
+     */
+    static isInitialized(suppressErrorLog?: boolean): boolean;
+    /** Return the current Redux store. Useful when using connect method to connect a Ui Component to the store. */
+    static get store(): Store<any>;
+    /** Return the current state from the Redux store. */
+    static get state(): any;
+    private combineDynamicAndDefaultReducers;
+    /** To be used only in unit test
+     * @internal
+     */
+    static clearStore(): void;
+}
 //# sourceMappingURL=StateManager.d.ts.map

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

@@ -1,98 +1,98 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module State
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StateManager = void 0;
-// cSpell:ignore DEVTOOLS
-const redux_1 = require("redux");
-const core_bentley_1 = require("@itwin/core-bentley");
-const appui_abstract_1 = require("@itwin/appui-abstract");
-const FrameworkState_1 = require("./FrameworkState");
-const ReducerRegistry_1 = require("./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
- * and/or extensions are loaded.
- * @public
- */
-class StateManager {
-    /**
-     * StateManager construct.
-     * @param defaultReducers Default set of Reducers used by the current application. If this object does not contain the [[FrameworkReducer]] it will automatically be added.
-     */
-    constructor(defaultReducers) {
-        if (defaultReducers) {
-            this._defaultReducers = defaultReducers;
-            const keys = (Object.keys(defaultReducers));
-            // ensure frameworkState is included in the set of defaultReducers
-            if (-1 === keys.findIndex((key) => key === "frameworkState"))
-                this._defaultReducers = { ...defaultReducers, frameworkState: FrameworkState_1.FrameworkReducer };
-        }
-        else {
-            this._defaultReducers = { frameworkState: FrameworkState_1.FrameworkReducer };
-        }
-        const dynamicallyRegisteredReducers = ReducerRegistry_1.ReducerRegistryInstance.getReducers();
-        let allReducers = this.combineDynamicAndDefaultReducers(dynamicallyRegisteredReducers, this._defaultReducers);
-        // create the Redux Store.
-        // istanbul ignore next
-        // eslint-disable-next-line deprecation/deprecation
-        this._store = (0, redux_1.createStore)(allReducers, window.__REDUX_DEVTOOLS_EXTENSION__ && window.__REDUX_DEVTOOLS_EXTENSION__());
-        ReducerRegistry_1.ReducerRegistryInstance.setChangeListener((newDynamicReducers) => {
-            allReducers = this.combineDynamicAndDefaultReducers(newDynamicReducers, this._defaultReducers);
-            this._store.replaceReducer(allReducers);
-        });
-        StateManager._singletonStore = this._store;
-    }
-    /** Method to test if the StateManager has been initialized.
-     * @param suppressErrorLog If true and the StateManager is not initialized a log message will be output.
-     */
-    static isInitialized(suppressErrorLog = false) {
-        if (!StateManager._singletonStore) {
-            if (!suppressErrorLog)
-                core_bentley_1.Logger.logError(StateManager._LOG_CATEGORY, "Accessing store before it is created.");
-            return false;
-        }
-        else {
-            return true;
-        }
-    }
-    /** Return the current Redux store. Useful when using connect method to connect a Ui Component to the store. */
-    static get store() {
-        if (StateManager.isInitialized()) {
-            return StateManager._singletonStore;
-        }
-        else {
-            throw new appui_abstract_1.UiError(StateManager._LOG_CATEGORY, `Redux Store has not been initialized`);
-        }
-    }
-    /** Return the current state from the Redux store. */
-    static get state() {
-        if (StateManager.isInitialized()) {
-            return StateManager._singletonStore.getState();
-        }
-        else {
-            return undefined;
-        }
-    }
-    combineDynamicAndDefaultReducers(dynamicallyRegisteredReducers, defaultReducers) {
-        const allReducers = {
-            ...defaultReducers,
-            ...dynamicallyRegisteredReducers,
-        };
-        return (0, redux_1.combineReducers)(allReducers);
-    }
-    /** To be used only in unit test
-     * @internal
-     */
-    static clearStore() {
-        StateManager._singletonStore = undefined;
-    }
-}
-exports.StateManager = StateManager;
-StateManager._LOG_CATEGORY = "StateManager";
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module State
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StateManager = void 0;
+// cSpell:ignore DEVTOOLS
+const redux_1 = require("redux");
+const core_bentley_1 = require("@itwin/core-bentley");
+const appui_abstract_1 = require("@itwin/appui-abstract");
+const FrameworkState_1 = require("./FrameworkState");
+const ReducerRegistry_1 = require("./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
+ * and/or extensions are loaded.
+ * @public
+ */
+class StateManager {
+    /**
+     * StateManager construct.
+     * @param defaultReducers Default set of Reducers used by the current application. If this object does not contain the [[FrameworkReducer]] it will automatically be added.
+     */
+    constructor(defaultReducers) {
+        if (defaultReducers) {
+            this._defaultReducers = defaultReducers;
+            const keys = (Object.keys(defaultReducers));
+            // ensure frameworkState is included in the set of defaultReducers
+            if (-1 === keys.findIndex((key) => key === "frameworkState"))
+                this._defaultReducers = { ...defaultReducers, frameworkState: FrameworkState_1.FrameworkReducer };
+        }
+        else {
+            this._defaultReducers = { frameworkState: FrameworkState_1.FrameworkReducer };
+        }
+        const dynamicallyRegisteredReducers = ReducerRegistry_1.ReducerRegistryInstance.getReducers();
+        let allReducers = this.combineDynamicAndDefaultReducers(dynamicallyRegisteredReducers, this._defaultReducers);
+        // create the Redux Store.
+        // istanbul ignore next
+        // eslint-disable-next-line deprecation/deprecation
+        this._store = (0, redux_1.createStore)(allReducers, window.__REDUX_DEVTOOLS_EXTENSION__ && window.__REDUX_DEVTOOLS_EXTENSION__());
+        ReducerRegistry_1.ReducerRegistryInstance.setChangeListener((newDynamicReducers) => {
+            allReducers = this.combineDynamicAndDefaultReducers(newDynamicReducers, this._defaultReducers);
+            this._store.replaceReducer(allReducers);
+        });
+        StateManager._singletonStore = this._store;
+    }
+    /** Method to test if the StateManager has been initialized.
+     * @param suppressErrorLog If true and the StateManager is not initialized a log message will be output.
+     */
+    static isInitialized(suppressErrorLog = false) {
+        if (!StateManager._singletonStore) {
+            if (!suppressErrorLog)
+                core_bentley_1.Logger.logError(StateManager._LOG_CATEGORY, "Accessing store before it is created.");
+            return false;
+        }
+        else {
+            return true;
+        }
+    }
+    /** Return the current Redux store. Useful when using connect method to connect a Ui Component to the store. */
+    static get store() {
+        if (StateManager.isInitialized()) {
+            return StateManager._singletonStore;
+        }
+        else {
+            throw new appui_abstract_1.UiError(StateManager._LOG_CATEGORY, `Redux Store has not been initialized`);
+        }
+    }
+    /** Return the current state from the Redux store. */
+    static get state() {
+        if (StateManager.isInitialized()) {
+            return StateManager._singletonStore.getState();
+        }
+        else {
+            return undefined;
+        }
+    }
+    combineDynamicAndDefaultReducers(dynamicallyRegisteredReducers, defaultReducers) {
+        const allReducers = {
+            ...defaultReducers,
+            ...dynamicallyRegisteredReducers,
+        };
+        return (0, redux_1.combineReducers)(allReducers);
+    }
+    /** To be used only in unit test
+     * @internal
+     */
+    static clearStore() {
+        StateManager._singletonStore = undefined;
+    }
+}
+exports.StateManager = StateManager;
+StateManager._LOG_CATEGORY = "StateManager";
 //# sourceMappingURL=StateManager.js.map