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

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/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;
+    }
+}
+StateManager._LOG_CATEGORY = "StateManager";
+exports.StateManager = StateManager;
 //# sourceMappingURL=StateManager.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"StateManager.js","sourceRoot":"","sources":["../../../../src/appui-react/redux/StateManager.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,yBAAyB;AAEzB,iCAA+E;AAC/E,sDAA6C;AAC7C,0DAAgD;AAChD,qDAAoE;AACpE,uDAA8E;AAU9E;;;;;GAKG;AACH,MAAa,YAAY;IAOvB;;;OAGG;IACH,YAAY,eAAkC;QAC5C,IAAI,eAAe,EAAE;YACnB,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;YACxC,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;YAC5C,kEAAkE;YAClE,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,gBAAgB,CAAC;gBAC1D,IAAI,CAAC,gBAAgB,GAAG,EAAE,GAAG,eAAe,EAAE,cAAc,EAAE,iCAAgB,EAAE,CAAC;SACpF;aAAM;YACL,IAAI,CAAC,gBAAgB,GAAG,EAAE,cAAc,EAAE,iCAAgB,EAAE,CAAC;SAC9D;QAED,MAAM,6BAA6B,GAAG,yCAAuB,CAAC,WAAW,EAAE,CAAC;QAC5E,IAAI,WAAW,GAAQ,IAAI,CAAC,gCAAgC,CAC1D,6BAA6B,EAC7B,IAAI,CAAC,gBAAgB,CACtB,CAAC;QAEF,0BAA0B;QAC1B,uBAAuB;QACvB,mDAAmD;QACnD,IAAI,CAAC,MAAM,GAAG,IAAA,mBAAW,EAAC,WAAW,EAAG,MAAc,CAAC,4BAA4B,IAAK,MAAc,CAAC,4BAA4B,EAAE,CAAC,CAAC;QAEvI,yCAAuB,CAAC,iBAAiB,CAAC,CAAC,kBAAkB,EAAE,EAAE;YAC/D,WAAW,GAAG,IAAI,CAAC,gCAAgC,CAAC,kBAAkB,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAC/F,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;YACjC,IAAI,CAAC,gBAAgB;gBACnB,qBAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,aAAa,EAAE,uCAAuC,CAAC,CAAC;YACvF,OAAO,KAAK,CAAC;SACd;aAAM;YACL,OAAO,IAAI,CAAC;SACb;IACH,CAAC;IAED,+GAA+G;IACxG,MAAM,KAAK,KAAK;QACrB,IAAI,YAAY,CAAC,aAAa,EAAE,EAAE;YAChC,OAAO,YAAY,CAAC,eAAgB,CAAC;SACtC;aAAM;YACL,MAAM,IAAI,wBAAO,CAAC,YAAY,CAAC,aAAa,EAAE,sCAAsC,CAAC,CAAC;SACvF;IACH,CAAC;IAED,qDAAqD;IAC9C,MAAM,KAAK,KAAK;QACrB,IAAI,YAAY,CAAC,aAAa,EAAE,EAAE;YAChC,OAAO,YAAY,CAAC,eAAgB,CAAC,QAAQ,EAAE,CAAC;SACjD;aAAM;YACL,OAAO,SAAS,CAAC;SAClB;IACH,CAAC;IAEO,gCAAgC,CACtC,6BAAgD,EAChD,eAAkC;QAElC,MAAM,WAAW,GAAG;YAClB,GAAG,eAAe;YAClB,GAAG,6BAA6B;SACjC,CAAC;QAEF,OAAO,IAAA,uBAAe,EAAC,WAAW,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,UAAU;QACtB,YAAY,CAAC,eAAe,GAAG,SAAS,CAAC;IAC3C,CAAC;;AAzFH,oCA2FC;AA1FgB,0BAAa,GAAG,cAAc,CAAC","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// cSpell:ignore DEVTOOLS\r\n\r\nimport { combineReducers, createStore, ReducersMapObject, Store } from \"redux\";\r\nimport { Logger } from \"@itwin/core-bentley\";\r\nimport { UiError } from \"@itwin/appui-abstract\";\r\nimport { FrameworkReducer, FrameworkState } from \"./FrameworkState\";\r\nimport { NameToReducerMap, ReducerRegistryInstance } from \"./ReducerRegistry\";\r\n\r\n/** Generic 'root' state for the appui-react package. Since this state contains common values needed by many applications\r\n * it is automatically added to the Redux store when using [[StateManager]].\r\n * @beta\r\n */\r\nexport interface FrameworkRootState {\r\n  frameworkState: FrameworkState;\r\n}\r\n\r\n/**\r\n * Centralized state management class using  Redux actions, reducers and store. This class monitors the ReducerRegistry and will\r\n * automatically update the store when a new reducer is registered.  This allows the store to be incrementally constructed as modules\r\n * and/or extensions are loaded.\r\n * @public\r\n */\r\nexport class StateManager {\r\n  private static _LOG_CATEGORY = \"StateManager\";\r\n  private _store: Store<any>;\r\n  private _defaultReducers: NameToReducerMap;\r\n\r\n  private static _singletonStore: Store<any> | undefined;\r\n\r\n  /**\r\n   * StateManager construct.\r\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.\r\n   */\r\n  constructor(defaultReducers?: NameToReducerMap) {\r\n    if (defaultReducers) {\r\n      this._defaultReducers = defaultReducers;\r\n      const keys = (Object.keys(defaultReducers));\r\n      // ensure frameworkState is included in the set of defaultReducers\r\n      if (-1 === keys.findIndex((key) => key === \"frameworkState\"))\r\n        this._defaultReducers = { ...defaultReducers, frameworkState: FrameworkReducer };\r\n    } else {\r\n      this._defaultReducers = { frameworkState: FrameworkReducer };\r\n    }\r\n\r\n    const dynamicallyRegisteredReducers = ReducerRegistryInstance.getReducers();\r\n    let allReducers: any = this.combineDynamicAndDefaultReducers(\r\n      dynamicallyRegisteredReducers,\r\n      this._defaultReducers,\r\n    );\r\n\r\n    // create the Redux Store.\r\n    // istanbul ignore next\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    this._store = createStore(allReducers, (window as any).__REDUX_DEVTOOLS_EXTENSION__ && (window as any).__REDUX_DEVTOOLS_EXTENSION__());\r\n\r\n    ReducerRegistryInstance.setChangeListener((newDynamicReducers) => {\r\n      allReducers = this.combineDynamicAndDefaultReducers(newDynamicReducers, this._defaultReducers);\r\n      this._store.replaceReducer(allReducers);\r\n    });\r\n    StateManager._singletonStore = this._store;\r\n  }\r\n\r\n  /** Method to test if the StateManager has been initialized.\r\n   * @param suppressErrorLog If true and the StateManager is not initialized a log message will be output.\r\n   */\r\n\r\n  public static isInitialized(suppressErrorLog = false): boolean {\r\n    if (!StateManager._singletonStore) {\r\n      if (!suppressErrorLog)\r\n        Logger.logError(StateManager._LOG_CATEGORY, \"Accessing store before it is created.\");\r\n      return false;\r\n    } else {\r\n      return true;\r\n    }\r\n  }\r\n\r\n  /** Return the current Redux store. Useful when using connect method to connect a Ui Component to the store. */\r\n  public static get store(): Store<any> {\r\n    if (StateManager.isInitialized()) {\r\n      return StateManager._singletonStore!;\r\n    } else {\r\n      throw new UiError(StateManager._LOG_CATEGORY, `Redux Store has not been initialized`);\r\n    }\r\n  }\r\n\r\n  /** Return the current state from the Redux store. */\r\n  public static get state(): any {\r\n    if (StateManager.isInitialized()) {\r\n      return StateManager._singletonStore!.getState();\r\n    } else {\r\n      return undefined;\r\n    }\r\n  }\r\n\r\n  private combineDynamicAndDefaultReducers(\r\n    dynamicallyRegisteredReducers: ReducersMapObject,\r\n    defaultReducers: ReducersMapObject,\r\n  ) {\r\n    const allReducers = {\r\n      ...defaultReducers,\r\n      ...dynamicallyRegisteredReducers,\r\n    };\r\n\r\n    return combineReducers(allReducers);\r\n  }\r\n\r\n  /** To be used only in unit test\r\n   * @internal\r\n   */\r\n  public static clearStore() {\r\n    StateManager._singletonStore = undefined;\r\n  }\r\n\r\n}\r\n"]}
+{"version":3,"file":"StateManager.js","sourceRoot":"","sources":["../../../../src/appui-react/redux/StateManager.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,yBAAyB;AAEzB,iCAA+E;AAC/E,sDAA6C;AAC7C,0DAAgD;AAChD,qDAAoE;AACpE,uDAA8E;AAU9E;;;;;GAKG;AACH,MAAa,YAAY;IAOvB;;;OAGG;IACH,YAAY,eAAkC;QAC5C,IAAI,eAAe,EAAE;YACnB,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;YACxC,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;YAC5C,kEAAkE;YAClE,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,gBAAgB,CAAC;gBAC1D,IAAI,CAAC,gBAAgB,GAAG,EAAE,GAAG,eAAe,EAAE,cAAc,EAAE,iCAAgB,EAAE,CAAC;SACpF;aAAM;YACL,IAAI,CAAC,gBAAgB,GAAG,EAAE,cAAc,EAAE,iCAAgB,EAAE,CAAC;SAC9D;QAED,MAAM,6BAA6B,GAAG,yCAAuB,CAAC,WAAW,EAAE,CAAC;QAC5E,IAAI,WAAW,GAAQ,IAAI,CAAC,gCAAgC,CAC1D,6BAA6B,EAC7B,IAAI,CAAC,gBAAgB,CACtB,CAAC;QAEF,0BAA0B;QAC1B,uBAAuB;QACvB,mDAAmD;QACnD,IAAI,CAAC,MAAM,GAAG,IAAA,mBAAW,EAAC,WAAW,EAAG,MAAc,CAAC,4BAA4B,IAAK,MAAc,CAAC,4BAA4B,EAAE,CAAC,CAAC;QAEvI,yCAAuB,CAAC,iBAAiB,CAAC,CAAC,kBAAkB,EAAE,EAAE;YAC/D,WAAW,GAAG,IAAI,CAAC,gCAAgC,CAAC,kBAAkB,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAC/F,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;YACjC,IAAI,CAAC,gBAAgB;gBACnB,qBAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,aAAa,EAAE,uCAAuC,CAAC,CAAC;YACvF,OAAO,KAAK,CAAC;SACd;aAAM;YACL,OAAO,IAAI,CAAC;SACb;IACH,CAAC;IAED,+GAA+G;IACxG,MAAM,KAAK,KAAK;QACrB,IAAI,YAAY,CAAC,aAAa,EAAE,EAAE;YAChC,OAAO,YAAY,CAAC,eAAgB,CAAC;SACtC;aAAM;YACL,MAAM,IAAI,wBAAO,CAAC,YAAY,CAAC,aAAa,EAAE,sCAAsC,CAAC,CAAC;SACvF;IACH,CAAC;IAED,qDAAqD;IAC9C,MAAM,KAAK,KAAK;QACrB,IAAI,YAAY,CAAC,aAAa,EAAE,EAAE;YAChC,OAAO,YAAY,CAAC,eAAgB,CAAC,QAAQ,EAAE,CAAC;SACjD;aAAM;YACL,OAAO,SAAS,CAAC;SAClB;IACH,CAAC;IAEO,gCAAgC,CACtC,6BAAgD,EAChD,eAAkC;QAElC,MAAM,WAAW,GAAG;YAClB,GAAG,eAAe;YAClB,GAAG,6BAA6B;SACjC,CAAC;QAEF,OAAO,IAAA,uBAAe,EAAC,WAAW,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,UAAU;QACtB,YAAY,CAAC,eAAe,GAAG,SAAS,CAAC;IAC3C,CAAC;;AAxFc,0BAAa,GAAG,cAAc,CAAC;AADnC,oCAAY","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// cSpell:ignore DEVTOOLS\r\n\r\nimport { combineReducers, createStore, ReducersMapObject, Store } from \"redux\";\r\nimport { Logger } from \"@itwin/core-bentley\";\r\nimport { UiError } from \"@itwin/appui-abstract\";\r\nimport { FrameworkReducer, FrameworkState } from \"./FrameworkState\";\r\nimport { NameToReducerMap, ReducerRegistryInstance } from \"./ReducerRegistry\";\r\n\r\n/** Generic 'root' state for the appui-react package. Since this state contains common values needed by many applications\r\n * it is automatically added to the Redux store when using [[StateManager]].\r\n * @beta\r\n */\r\nexport interface FrameworkRootState {\r\n  frameworkState: FrameworkState;\r\n}\r\n\r\n/**\r\n * Centralized state management class using  Redux actions, reducers and store. This class monitors the ReducerRegistry and will\r\n * automatically update the store when a new reducer is registered.  This allows the store to be incrementally constructed as modules\r\n * and/or extensions are loaded.\r\n * @public\r\n */\r\nexport class StateManager {\r\n  private static _LOG_CATEGORY = \"StateManager\";\r\n  private _store: Store<any>;\r\n  private _defaultReducers: NameToReducerMap;\r\n\r\n  private static _singletonStore: Store<any> | undefined;\r\n\r\n  /**\r\n   * StateManager construct.\r\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.\r\n   */\r\n  constructor(defaultReducers?: NameToReducerMap) {\r\n    if (defaultReducers) {\r\n      this._defaultReducers = defaultReducers;\r\n      const keys = (Object.keys(defaultReducers));\r\n      // ensure frameworkState is included in the set of defaultReducers\r\n      if (-1 === keys.findIndex((key) => key === \"frameworkState\"))\r\n        this._defaultReducers = { ...defaultReducers, frameworkState: FrameworkReducer };\r\n    } else {\r\n      this._defaultReducers = { frameworkState: FrameworkReducer };\r\n    }\r\n\r\n    const dynamicallyRegisteredReducers = ReducerRegistryInstance.getReducers();\r\n    let allReducers: any = this.combineDynamicAndDefaultReducers(\r\n      dynamicallyRegisteredReducers,\r\n      this._defaultReducers,\r\n    );\r\n\r\n    // create the Redux Store.\r\n    // istanbul ignore next\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    this._store = createStore(allReducers, (window as any).__REDUX_DEVTOOLS_EXTENSION__ && (window as any).__REDUX_DEVTOOLS_EXTENSION__());\r\n\r\n    ReducerRegistryInstance.setChangeListener((newDynamicReducers) => {\r\n      allReducers = this.combineDynamicAndDefaultReducers(newDynamicReducers, this._defaultReducers);\r\n      this._store.replaceReducer(allReducers);\r\n    });\r\n    StateManager._singletonStore = this._store;\r\n  }\r\n\r\n  /** Method to test if the StateManager has been initialized.\r\n   * @param suppressErrorLog If true and the StateManager is not initialized a log message will be output.\r\n   */\r\n\r\n  public static isInitialized(suppressErrorLog = false): boolean {\r\n    if (!StateManager._singletonStore) {\r\n      if (!suppressErrorLog)\r\n        Logger.logError(StateManager._LOG_CATEGORY, \"Accessing store before it is created.\");\r\n      return false;\r\n    } else {\r\n      return true;\r\n    }\r\n  }\r\n\r\n  /** Return the current Redux store. Useful when using connect method to connect a Ui Component to the store. */\r\n  public static get store(): Store<any> {\r\n    if (StateManager.isInitialized()) {\r\n      return StateManager._singletonStore!;\r\n    } else {\r\n      throw new UiError(StateManager._LOG_CATEGORY, `Redux Store has not been initialized`);\r\n    }\r\n  }\r\n\r\n  /** Return the current state from the Redux store. */\r\n  public static get state(): any {\r\n    if (StateManager.isInitialized()) {\r\n      return StateManager._singletonStore!.getState();\r\n    } else {\r\n      return undefined;\r\n    }\r\n  }\r\n\r\n  private combineDynamicAndDefaultReducers(\r\n    dynamicallyRegisteredReducers: ReducersMapObject,\r\n    defaultReducers: ReducersMapObject,\r\n  ) {\r\n    const allReducers = {\r\n      ...defaultReducers,\r\n      ...dynamicallyRegisteredReducers,\r\n    };\r\n\r\n    return combineReducers(allReducers);\r\n  }\r\n\r\n  /** To be used only in unit test\r\n   * @internal\r\n   */\r\n  public static clearStore() {\r\n    StateManager._singletonStore = undefined;\r\n  }\r\n\r\n}\r\n"]}

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

@@ -1,27 +1,27 @@
-/** 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
- */
-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
- * @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.
- * @beta
- *
- * @example
- *   // connect component for both getting and setting ImodelConnection data from Redux store.
- *  import { connectIModelConnection, sessionStateMapDispatchToProps, SessionStateActionsProps } from "@itwin/appui-react";
- *
- *  export interface ComponentProps extends SessionStateActionsProps {
- *    myData: string;
- *  }
- *
- *  export const ConnectControl = connectIModelConnection(null, sessionStateMapDispatchToProps)(ComponentClass); // eslint-disable-line @typescript-eslint/naming-convention
- *
- *  //  this then allows connected control to update the store using a call like shown below.
- *  this.props.setNumItemsSelected(30);
- *
- */
-export declare const connectIModelConnectionAndViewState: (mapStateToProps?: any, mapDispatchToProps?: any) => import("react-redux").InferableComponentEnhancerWithProps<any, any>;
+/** 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
+ */
+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
+ * @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.
+ * @beta
+ *
+ * @example
+ *   // connect component for both getting and setting ImodelConnection data from Redux store.
+ *  import { connectIModelConnection, sessionStateMapDispatchToProps, SessionStateActionsProps } from "@itwin/appui-react";
+ *
+ *  export interface ComponentProps extends SessionStateActionsProps {
+ *    myData: string;
+ *  }
+ *
+ *  export const ConnectControl = connectIModelConnection(null, sessionStateMapDispatchToProps)(ComponentClass); // eslint-disable-line @typescript-eslint/naming-convention
+ *
+ *  //  this then allows connected control to update the store using a call like shown below.
+ *  this.props.setNumItemsSelected(30);
+ *
+ */
+export declare const connectIModelConnectionAndViewState: (mapStateToProps?: any, mapDispatchToProps?: any) => import("react-redux").InferableComponentEnhancerWithProps<any, any>;
 //# sourceMappingURL=connectIModel.d.ts.map