@itwin/appui-react 3.0.0-dev.100

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

@@ -0,0 +1,93 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+// cSpell:ignore DEVTOOLS
+import { combineReducers, createStore } from "redux";
+import { Logger } from "@itwin/core-bentley";
+import { UiError } from "@itwin/appui-abstract";
+import { FrameworkReducer } from "./FrameworkState";
+import { ReducerRegistryInstance } from "./ReducerRegistry";
+/**
+ * Centralized state management class using  Redux actions, reducers and store. This class monitors the ReducerRegistry and will
+ * automatically update the store when a new reducer is registered.  This allows the store to be incrementally constructed as modules
+ * and/or extensions are loaded.
+ * @public
+ */
+export 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: FrameworkReducer };
+        }
+        else {
+            this._defaultReducers = { frameworkState: FrameworkReducer };
+        }
+        const dynamicallyRegisteredReducers = ReducerRegistryInstance.getReducers();
+        let allReducers = this.combineDynamicAndDefaultReducers(dynamicallyRegisteredReducers, this._defaultReducers);
+        // create the Redux Store.
+        // istanbul ignore next
+        this._store = createStore(allReducers, window.__REDUX_DEVTOOLS_EXTENSION__ && window.__REDUX_DEVTOOLS_EXTENSION__());
+        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)
+                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 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 combineReducers(allReducers);
+    }
+    /** To be used only in unit test
+     * @internal
+     */
+    static clearStore() {
+        StateManager._singletonStore = undefined;
+    }
+}
+StateManager._LOG_CATEGORY = "StateManager";
+//# sourceMappingURL=StateManager.js.map

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

@@ -0,0 +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,OAAO,EAAE,eAAe,EAAE,WAAW,EAA4B,MAAM,OAAO,CAAC;AAC/E,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAkB,MAAM,kBAAkB,CAAC;AACpE,OAAO,EAAoB,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAU9E;;;;;GAKG;AACH,MAAM,OAAO,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,gBAAgB,EAAE,CAAC;SACpF;aAAM;YACL,IAAI,CAAC,gBAAgB,GAAG,EAAE,cAAc,EAAE,gBAAgB,EAAE,CAAC;SAC9D;QAED,MAAM,6BAA6B,GAAG,uBAAuB,CAAC,WAAW,EAAE,CAAC;QAC5E,IAAI,WAAW,GAAQ,IAAI,CAAC,gCAAgC,CAC1D,6BAA6B,EAC7B,IAAI,CAAC,gBAAgB,CACtB,CAAC;QAEF,0BAA0B;QAC1B,uBAAuB;QACvB,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,WAAW,EAAG,MAAc,CAAC,4BAA4B,IAAK,MAAc,CAAC,4BAA4B,EAAE,CAAC,CAAC;QAEvI,uBAAuB,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,MAAM,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,OAAO,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,eAAe,CAAC,WAAW,CAAC,CAAC;IACtC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,UAAU;QACtB,YAAY,CAAC,eAAe,GAAG,SAAS,CAAC;IAC3C,CAAC;;AAvFc,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 iModel.js 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    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/esm/appui-react/redux/connectIModel.d.ts

@@ -0,0 +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>;
+//# sourceMappingURL=connectIModel.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"connectIModel.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/redux/connectIModel.ts"],"names":[],"mappings":"AAuEA;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,qBAAsB,GAAG,uBAAuB,GAAG,wEAEtF,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,mCAAmC,qBAAsB,GAAG,uBAAuB,GAAG,wEAElG,CAAC"}

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

@@ -0,0 +1,90 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { connect } from "react-redux";
+import { UiFramework } from "../UiFramework";
+/** Private function that will map store's iModelConnection to the 'iModelConnection', 'iModel', and 'imodel' properties of props. This
+ * is not ideal but it is a result of not having standard prop name for an iModelConnection.
+ */
+const iModeMapStateToProps = (mapStateToProps) => {
+    return (state, ownProps) => {
+        const frameworkState = state[UiFramework.frameworkStateKey]; // since app sets up key, don't hard-code name
+        /* istanbul ignore next */
+        if (!frameworkState) {
+            if (mapStateToProps)
+                return mapStateToProps(state, ownProps);
+            return {};
+        }
+        const storeProps = {
+            iModelConnection: frameworkState.sessionState.iModelConnection,
+            imodel: frameworkState.sessionState.iModelConnection,
+            iModel: frameworkState.sessionState.iModelConnection,
+        };
+        // istanbul ignore else
+        if (mapStateToProps) {
+            return {
+                ...storeProps,
+                ...mapStateToProps(state, ownProps),
+            };
+        }
+        // istanbul ignore next
+        return storeProps;
+    };
+};
+/** Function that will map store's iModelConnection and defaultViewState to the props 'iModelConnection', 'iModel', 'imodel',
+ * and 'viewState' property of props
+ */
+const iModelAndViewMapStateToProps = (mapStateToProps) => {
+    // istanbul ignore next
+    return (state, ownProps) => {
+        const frameworkState = state[UiFramework.frameworkStateKey]; // since app sets up key, don't hard-code name
+        /* istanbul ignore next */
+        if (!frameworkState)
+            return {};
+        const props = {
+            ...ownProps,
+            iModelConnection: frameworkState.sessionState.iModelConnection,
+            iModel: frameworkState.sessionState.iModelConnection,
+            imodel: frameworkState.sessionState.iModelConnection,
+            viewState: frameworkState.sessionState.defaultViewState,
+        };
+        if (mapStateToProps)
+            return mapStateToProps(state, props);
+        return props;
+    };
+};
+/** 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 const connectIModelConnection = (mapStateToProps, mapDispatchToProps) => {
+    return connect(iModeMapStateToProps(mapStateToProps), mapDispatchToProps);
+};
+/** 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 const connectIModelConnectionAndViewState = (mapStateToProps, mapDispatchToProps) => {
+    return connect(iModelAndViewMapStateToProps(mapStateToProps), mapDispatchToProps);
+};
+//# sourceMappingURL=connectIModel.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"connectIModel.js","sourceRoot":"","sources":["../../../../src/appui-react/redux/connectIModel.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;GAEG;AACH,MAAM,oBAAoB,GAAG,CAAC,eAAoB,EAAE,EAAE;IACpD,OAAO,CAAC,KAAU,EAAE,QAAa,EAAE,EAAE;QACnC,MAAM,cAAc,GAAG,KAAK,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC,CAAE,8CAA8C;QAE5G,0BAA0B;QAC1B,IAAI,CAAC,cAAc,EAAE;YACnB,IAAI,eAAe;gBACjB,OAAO,eAAe,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YAC1C,OAAO,EAAE,CAAC;SACX;QAED,MAAM,UAAU,GAAG;YACjB,gBAAgB,EAAE,cAAc,CAAC,YAAY,CAAC,gBAAgB;YAC9D,MAAM,EAAE,cAAc,CAAC,YAAY,CAAC,gBAAgB;YACpD,MAAM,EAAE,cAAc,CAAC,YAAY,CAAC,gBAAgB;SACrD,CAAC;QAEF,uBAAuB;QACvB,IAAI,eAAe,EAAE;YACnB,OAAO;gBACL,GAAG,UAAU;gBACb,GAAG,eAAe,CAAC,KAAK,EAAE,QAAQ,CAAC;aACpC,CAAC;SACH;QAED,uBAAuB;QACvB,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,4BAA4B,GAAG,CAAC,eAAoB,EAAE,EAAE;IAC5D,uBAAuB;IACvB,OAAO,CAAC,KAAU,EAAE,QAAa,EAAE,EAAE;QACnC,MAAM,cAAc,GAAG,KAAK,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC,CAAE,8CAA8C;QAE5G,0BAA0B;QAC1B,IAAI,CAAC,cAAc;YACjB,OAAO,EAAE,CAAC;QAEZ,MAAM,KAAK,GAAG;YACZ,GAAG,QAAQ;YACX,gBAAgB,EAAE,cAAc,CAAC,YAAY,CAAC,gBAAgB;YAC9D,MAAM,EAAE,cAAc,CAAC,YAAY,CAAC,gBAAgB;YACpD,MAAM,EAAE,cAAc,CAAC,YAAY,CAAC,gBAAgB;YACpD,SAAS,EAAE,cAAc,CAAC,YAAY,CAAC,gBAAgB;SACxD,CAAC;QACF,IAAI,eAAe;YACjB,OAAO,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAEvC,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,eAAqB,EAAE,kBAAwB,EAAE,EAAE;IACzF,OAAO,OAAO,CAAC,oBAAoB,CAAC,eAAe,CAAC,EAAE,kBAAkB,CAAC,CAAC;AAC5E,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,mCAAmC,GAAG,CAAC,eAAqB,EAAE,kBAAwB,EAAE,EAAE;IACrG,OAAO,OAAO,CAAC,4BAA4B,CAAC,eAAe,CAAC,EAAE,kBAAkB,CAAC,CAAC;AACpF,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\r\n/** @packageDocumentation\r\n * @module State\r\n */\r\n\r\nimport { connect } from \"react-redux\";\r\nimport { UiFramework } from \"../UiFramework\";\r\n\r\n/** Private function that will map store's iModelConnection to the 'iModelConnection', 'iModel', and 'imodel' properties of props. This\r\n * is not ideal but it is a result of not having standard prop name for an iModelConnection.\r\n */\r\nconst iModeMapStateToProps = (mapStateToProps: any) => {\r\n  return (state: any, ownProps: any) => {\r\n    const frameworkState = state[UiFramework.frameworkStateKey];  // since app sets up key, don't hard-code name\r\n\r\n    /* istanbul ignore next */\r\n    if (!frameworkState) {\r\n      if (mapStateToProps)\r\n        return mapStateToProps(state, ownProps);\r\n      return {};\r\n    }\r\n\r\n    const storeProps = {\r\n      iModelConnection: frameworkState.sessionState.iModelConnection,\r\n      imodel: frameworkState.sessionState.iModelConnection,\r\n      iModel: frameworkState.sessionState.iModelConnection,\r\n    };\r\n\r\n    // istanbul ignore else\r\n    if (mapStateToProps) {\r\n      return {\r\n        ...storeProps,\r\n        ...mapStateToProps(state, ownProps),\r\n      };\r\n    }\r\n\r\n    // istanbul ignore next\r\n    return storeProps;\r\n  };\r\n};\r\n\r\n/** Function that will map store's iModelConnection and defaultViewState to the props 'iModelConnection', 'iModel', 'imodel',\r\n * and 'viewState' property of props\r\n */\r\nconst iModelAndViewMapStateToProps = (mapStateToProps: any) => {\r\n  // istanbul ignore next\r\n  return (state: any, ownProps: any) => {\r\n    const frameworkState = state[UiFramework.frameworkStateKey];  // since app sets up key, don't hard-code name\r\n\r\n    /* istanbul ignore next */\r\n    if (!frameworkState)\r\n      return {};\r\n\r\n    const props = {\r\n      ...ownProps,\r\n      iModelConnection: frameworkState.sessionState.iModelConnection,   // this prop is required by Unified Selection (TODO: standardize on use)\r\n      iModel: frameworkState.sessionState.iModelConnection,             // this prop is needed by many components\r\n      imodel: frameworkState.sessionState.iModelConnection,             // this prop is needed by ViewportProps\r\n      viewState: frameworkState.sessionState.defaultViewState,\r\n    };\r\n    if (mapStateToProps)\r\n      return mapStateToProps(state, props);\r\n\r\n    return props;\r\n  };\r\n};\r\n\r\n/** Function that will connect a component to the IModelConnection data in the Redux store.\r\n * @param mapStateToProps optional user function that, if defined, will be executed to provide additional properties from store.\r\n * @param mapDispatchToProps data passed to Redux connect function.\r\n * @public\r\n */\r\nexport const connectIModelConnection = (mapStateToProps?: any, mapDispatchToProps?: any) => {\r\n  return connect(iModeMapStateToProps(mapStateToProps), mapDispatchToProps);\r\n};\r\n\r\n/** Function that will connect a component to the IModelConnection data in the Redux store\r\n * @param mapStateToProps optional user function that, if defined, will be executed to provide additional properties from store.\r\n * @param mapDispatchToProps data passed to Redux connect function.\r\n * @beta\r\n *\r\n * @example\r\n *   // connect component for both getting and setting ImodelConnection data from Redux store.\r\n *  import { connectIModelConnection, sessionStateMapDispatchToProps, SessionStateActionsProps } from \"@itwin/appui-react\";\r\n *\r\n *  export interface ComponentProps extends SessionStateActionsProps {\r\n *    myData: string;\r\n *  }\r\n *\r\n *  export const ConnectControl = connectIModelConnection(null, sessionStateMapDispatchToProps)(ComponentClass); // eslint-disable-line @typescript-eslint/naming-convention\r\n *\r\n *  //  this then allows connected control to update the store using a call like shown below.\r\n *  this.props.setNumItemsSelected(30);\r\n *\r\n */\r\nexport const connectIModelConnectionAndViewState = (mapStateToProps?: any, mapDispatchToProps?: any) => {\r\n  return connect(iModelAndViewMapStateToProps(mapStateToProps), mapDispatchToProps);\r\n};\r\n"]}

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

@@ -0,0 +1,198 @@
+/** @packageDocumentation
+ * @module State
+ */
+/** Shorthand for "any function".  TSLint doesn't like the built-in `Function` type for some reason.
+ * @public
+ */
+export declare type FunctionType = (...args: any[]) => any;
+/**
+ * Similar to the built-in [Readonly](https://www.typescriptlang.org/docs/handbook/advanced-types.html#mapped-types), type alias but applied recursively.
+ * This basically makes all nested properties/members of an object/array immutable.
+ * @public
+ */
+export declare type DeepReadonly<T> = T extends ReadonlyArray<infer R> ? (R extends object ? DeepReadonlyArray<R> : ReadonlyArray<R>) : T extends FunctionType ? T : T extends object ? DeepReadonlyObject<T> : T;
+/** TypeScript doesn't actually allow recursive type aliases, so these are just sort of a hack to make DeepReadonly work
+ * @public
+ */
+export interface DeepReadonlyArray<T> extends ReadonlyArray<DeepReadonly<T>> {
+}
+/** TypeScript doesn't actually allow recursive type aliases, so these are just sort of a hack to make DeepReadonly work
+ * @public
+ */
+export declare type DeepReadonlyObject<T> = {
+    readonly [P in keyof T]: DeepReadonly<T[P]>;
+};
+/**
+ * A basic Redux [Action](https://redux.js.org/basics/actions).
+ * Technically, redux only requires actions to have a `type` property.
+ *
+ * We use a TypeScript [Generic](https://www.typescriptlang.org/docs/handbook/generics.html) interface here to preserve the "literal-ness" of the `type` property.
+ * In other words, `Action<"FOO">` will be of type `{ type: "FOO" }`; it won't be simplified to `{ type: string }`.
+ *
+ * See the [TS Handbook](https://www.typescriptlang.org/docs/handbook/advanced-types.html#string-literal-types) for more info on TypeScript string literal types.
+ * @public
+ */
+export interface Action<T extends string> {
+    type: T;
+}
+/**
+ * A Redux [Action](https://redux.js.org/basics/actions), with additional "payload" information.
+ * Technically, Redux allows actions to take any shape, provided they specify a `type` property.
+ *
+ * However, in order to simplify TypeScript typings, we follow this [Flux Standard Actions](https://github.com/redux-utilities/flux-standard-action)-like
+ * convention, where all additional action information goes into a `payload` property.
+ * @public
+ */
+export interface ActionWithPayload<T extends string, P> extends Action<T> {
+    payload: P;
+}
+/**
+ * Creates a basic Redux Redux [Action](https://redux.js.org/basics/actions) without a payload.
+ * **This is meant to be used as a shortcut for defining Action Creators.**
+ *
+ * For example,
+ * ```
+ *   () => createAction("FOO", ids)
+ * ```
+ * defines an action creator of type:
+ * ```
+ *   () => { type: "FOO" }
+ *   // which is equivalent to:
+ *   () => Action<"FOO">
+ * ```
+ *
+ * Note that the generic type parameters can always be omitted - TypeScript will be able to infer them.
+ * @param type The string to use as the action's type property. Should have a [string literal type](https://www.typescriptlang.org/docs/handbook/advanced-types.html#string-literal-types).
+ * @public
+ */
+export declare function createAction<T extends string>(type: T): Action<T>;
+/**
+ * Creates a basic Redux Redux [Action](https://redux.js.org/basics/actions) _with_ a payload value.
+ * **This is meant to be used as a shortcut for defining Action Creators.**
+ *
+ * For example,
+ * ```
+ *   (ids: number[]) => createAction("FOO", ids)
+ * ```
+ * defines an action creator of type:
+ * ```
+ *   (ids: number[]) => { type: "FOO", payload: ReadonlyArray<number> }
+ *   // which is equivalent to:
+ *   (ids: number[]) => ActionWithPayload<"FOO", ReadonlyArray<number>>
+ * ```
+ *
+ * Note that the generic type parameters can always be omitted - TypeScript will be able to infer them.
+ * @param type The string to use as the action's type property. Should have a [string literal type](https://www.typescriptlang.org/docs/handbook/advanced-types.html#string-literal-types).
+ * @param payload The value to use as the action's payload property. May be of any type.
+ * @public
+ */
+export declare function createAction<T extends string, P>(type: T, payload: P): ActionWithPayload<T, DeepReadonly<P>>;
+/**
+ * Just an object where every property is a Redux [Action Creator](https://redux.js.org/basics/actions#action-creators).
+ * @public
+ */
+export declare type ActionCreatorsObject = {
+    [actionCreatorName: string]: FunctionType;
+};
+/**
+ * A TypeScript type alias that represents the [Union Type](https://www.typescriptlang.org/docs/handbook/advanced-types.html#union-types) of all actions
+ * possibly created by _any_ of the action creators in a given `ActionCreatorsObject`.
+ *
+ * For example,
+ * ```
+ *   // given:
+ *   const MyActionCreators = {
+ *     createBanana: () => createAction("BANANA"),
+ *     createApple:  () => createAction("APPLE", true),
+ *     createOrange: (n: number) => createAction("BANANA", n),
+ *   }
+ *   // then:
+ *   type X = ActionsUnion<typeof MyActionCreators>;
+ *   // is equivalent to:
+ *   type X = Action<"BANANA">
+ *            | ActionWithPayload<"APPLE", boolean>
+ *            | ActionWithPayload<"ORANGE", number>;
+ * ```
+ * @public
+ */
+export declare type ActionsUnion<A extends ActionCreatorsObject> = ReturnType<A[keyof A]>;
+/**
+ * A TypeScript type alias that uses [conditional types](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html) (read: magic)
+ * to represent the _exact_ (literal) type of an action's `type` property.
+ *
+ * More importantly, this can be used to determine a union type which represents the `type` string literal types for _any_ action in a given `ActionsUnion`.
+ *
+ * For example,
+ * ```
+ *   // given:
+ *   type MyActions = Action<"BANANA">
+ *                    | ActionWithPayload<"APPLE", boolean>
+ *                    | ActionWithPayload<"ORANGE", number>;
+ *   // then:
+ *   type X = ActionTypes<MyActions>;
+ *   // is equivalent to:
+ *   type X = "BANANA" | "APPLE" | "ORANGE";
+ * ```
+ * @public
+ */
+export declare type ActionTypes<A extends Action<any>> = A["type"] extends infer X ? (X extends string ? X : never) : never;
+/**
+ * A Redux [Reducer](https://redux.js.org/basics/reducers).
+ * @public
+ */
+export declare type Reducer<S, A> = (state: S, action: A) => S;
+/**
+ * A TypeScript type alias that represents a union of all action types handled by a Redux [Reducer](https://redux.js.org/basics/reducers).
+ *
+ * If you have created a type-safe reducer function using `combineReducers`, you can use this to infer your actions union type instead of having to define it manually.
+ * @public
+ */
+export declare type ReducerActions<R> = R extends Reducer<any, infer X> ? (X extends ActionWithPayload<infer T, infer P> ? DeepReadonly<ActionWithPayload<T, P>> : X extends Action<infer T2> ? DeepReadonly<Action<T2>> : X) : R;
+/**
+ * A TypeScript type alias that represents the return type of a Redux [Reducer](https://redux.js.org/basics/reducers).
+ *
+ * If you have created a type-safe reducer function using `combineReducers`, you can use this to infer your state type instead of having to define it manually.
+ * @public
+ */
+export declare type StateType<R extends Reducer<any, any>> = DeepReadonly<ReturnType<R>>;
+/**
+ * So we don't actually need to implement our own version of combineReducers, but we are going to cast it
+ * to this type, which will do a better job of preserving/deducing the Action and State types.
+ * @public
+ */
+export declare type CombineReducersFunction = <A>(reducers: A) => (state: CombinedReducerState<A>, action: ReducerMapActions<A>) => CombinedReducerState<A>;
+/**
+ * A type alias which represents the state created by the reducer returned by combineReducers for a given `reducers` argument.
+ * Used above by `CombineReducersFunction`, our custom type definition for combineReducers.
+ * @public
+ */
+export declare type CombinedReducerState<R> = {
+    readonly [K in keyof R]: R[K] extends FunctionType ? StateType<R[K]> : never;
+};
+/**
+ * A type alias which represents the union type of all actions handled by the reducer returned by combineReducers for a given `reducers` argument.
+ * Used above by `CombineReducersFunction`, our custom type definition for combineReducers.
+ * @public
+ */
+export declare type ReducerMapActions<R> = ReducerActions<R[keyof R]>;
+/**
+ * Turns an object whose values are different reducer functions, into a single
+ * reducer function. It will call every child reducer, and gather their results
+ * into a single state object, whose keys correspond to the keys of the passed
+ * reducer functions.
+ *
+ * //@template S Combined state object type.
+ *
+ * @param reducers An object whose values correspond to different reducer
+ *   functions that need to be combined into one. One handy way to obtain it
+ *   is to use ES6 `import * as reducers` syntax. The reducers may never
+ *   return undefined for any action. Instead, they should return their
+ *   initial state if the state passed to them was undefined, and the current
+ *   state for any unrecognized action.
+ *
+ * Returns: A reducer function that invokes every reducer inside the passed
+ *   object, and builds a state object with the same shape.
+ * @public
+ */
+export declare const combineReducers: CombineReducersFunction;
+//# sourceMappingURL=redux-ts.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"redux-ts.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/redux/redux-ts.ts"],"names":[],"mappings":"AAIA;;GAEG;AAMH;;GAEG;AACH,oBAAY,YAAY,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;AAEnD;;;;GAIG;AACH,oBAAY,YAAY,CAAC,CAAC,IACxB,CAAC,SAAS,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,SAAS,MAAM,GAAG,iBAAiB,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,GAC/F,CAAC,SAAS,YAAY,GAAG,CAAC,GAC1B,CAAC,SAAS,MAAM,GAAG,kBAAkB,CAAC,CAAC,CAAC,GACxC,CAAC,CAAC;AAEJ;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,CAAC,CAAE,SAAQ,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;CAAI;AAChF;;GAEG;AACH,oBAAY,kBAAkB,CAAC,CAAC,IAAI;IAClC,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC5C,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,WAAW,MAAM,CAAC,CAAC,SAAS,MAAM;IACtC,IAAI,EAAE,CAAC,CAAC;CACT;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,iBAAiB,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,CAAE,SAAQ,MAAM,CAAC,CAAC,CAAC;IACvE,OAAO,EAAE,CAAC,CAAC;CACZ;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;AACnE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,iBAAiB,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;AAK9G;;;GAGG;AACH,oBAAY,oBAAoB,GAAG;IAAE,CAAC,iBAAiB,EAAE,MAAM,GAAG,YAAY,CAAC;CAAE,CAAC;AAElF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,oBAAY,YAAY,CAAC,CAAC,SAAS,oBAAoB,IAAI,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAElF;;;;;;;;;;;;;;;;;;GAkBG;AACH,oBAAY,WAAW,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,MAAM,CAAC,GAAG,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,KAAK,CAAC;AAEpH;;;GAGG;AACH,oBAAY,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC;AAEvD;;;;;GAKG;AACH,oBAAY,cAAc,CAAC,CAAC,IAC1B,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,GAAG,CAChC,CAAC,SAAS,iBAAiB,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,YAAY,CAAC,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GACrF,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,GACrD,CAAC,CACF,GAAG,CAAC,CAAC;AAER;;;;;GAKG;AACH,oBAAY,SAAS,CAAC,CAAC,SAAS,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;AAGjF;;;;GAIG;AACH,oBAAY,uBAAuB,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,KACnD,CAAC,KAAK,EAAE,oBAAoB,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,oBAAoB,CAAC,CAAC,CAAC,CAAC;AAE5F;;;;GAIG;AACH,oBAAY,oBAAoB,CAAC,CAAC,IAAI;IAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK;CAAE,CAAC;AAEvH;;;;GAIG;AACH,oBAAY,iBAAiB,CAAC,CAAC,IAAI,cAAc,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;AAI9D;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,eAAe,EAAE,uBAAoD,CAAC"}

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

@@ -0,0 +1,33 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import { combineReducers as baseCombineReducers } from "redux";
+export function createAction(type, payload) {
+    return (payload === undefined) ? /* istanbul ignore next */ { type } : { type, payload };
+}
+// Since the implementation is copied from redux, we'll copy the docs as well:
+/**
+ * Turns an object whose values are different reducer functions, into a single
+ * reducer function. It will call every child reducer, and gather their results
+ * into a single state object, whose keys correspond to the keys of the passed
+ * reducer functions.
+ *
+ * //@template S Combined state object type.
+ *
+ * @param reducers An object whose values correspond to different reducer
+ *   functions that need to be combined into one. One handy way to obtain it
+ *   is to use ES6 `import * as reducers` syntax. The reducers may never
+ *   return undefined for any action. Instead, they should return their
+ *   initial state if the state passed to them was undefined, and the current
+ *   state for any unrecognized action.
+ *
+ * Returns: A reducer function that invokes every reducer inside the passed
+ *   object, and builds a state object with the same shape.
+ * @public
+ */
+export const combineReducers = baseCombineReducers;
+//# sourceMappingURL=redux-ts.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"redux-ts.js","sourceRoot":"","sources":["../../../../src/appui-react/redux/redux-ts.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,eAAe,IAAI,mBAAmB,EAAE,MAAM,OAAO,CAAC;AAkG/D,MAAM,UAAU,YAAY,CAAsB,IAAO,EAAE,OAAW;IACpE,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,0BAA0B,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;AAC3F,CAAC;AAuGD,8EAA8E;AAC9E;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,eAAe,GAA4B,mBAA0B,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\nimport { combineReducers as baseCombineReducers } from \"redux\";\r\n\r\n/* eslint-disable */\r\n\r\n/** Shorthand for \"any function\".  TSLint doesn't like the built-in `Function` type for some reason.\r\n * @public\r\n */\r\nexport type FunctionType = (...args: any[]) => any;\r\n\r\n/**\r\n * Similar to the built-in [Readonly](https://www.typescriptlang.org/docs/handbook/advanced-types.html#mapped-types), type alias but applied recursively.\r\n * This basically makes all nested properties/members of an object/array immutable.\r\n * @public\r\n */\r\nexport type DeepReadonly<T> =\r\n  T extends ReadonlyArray<infer R> ? (R extends object ? DeepReadonlyArray<R> : ReadonlyArray<R>) :\r\n  T extends FunctionType ? T :\r\n  T extends object ? DeepReadonlyObject<T> :\r\n  T;\r\n\r\n/** TypeScript doesn't actually allow recursive type aliases, so these are just sort of a hack to make DeepReadonly work\r\n * @public\r\n */\r\nexport interface DeepReadonlyArray<T> extends ReadonlyArray<DeepReadonly<T>> { }\r\n/** TypeScript doesn't actually allow recursive type aliases, so these are just sort of a hack to make DeepReadonly work\r\n * @public\r\n */\r\nexport type DeepReadonlyObject<T> = {\r\n  readonly [P in keyof T]: DeepReadonly<T[P]>;\r\n};\r\n\r\n/**\r\n * A basic Redux [Action](https://redux.js.org/basics/actions).\r\n * Technically, redux only requires actions to have a `type` property.\r\n *\r\n * We use a TypeScript [Generic](https://www.typescriptlang.org/docs/handbook/generics.html) interface here to preserve the \"literal-ness\" of the `type` property.\r\n * In other words, `Action<\"FOO\">` will be of type `{ type: \"FOO\" }`; it won't be simplified to `{ type: string }`.\r\n *\r\n * See the [TS Handbook](https://www.typescriptlang.org/docs/handbook/advanced-types.html#string-literal-types) for more info on TypeScript string literal types.\r\n * @public\r\n */\r\nexport interface Action<T extends string> {\r\n  type: T;\r\n}\r\n\r\n/**\r\n * A Redux [Action](https://redux.js.org/basics/actions), with additional \"payload\" information.\r\n * Technically, Redux allows actions to take any shape, provided they specify a `type` property.\r\n *\r\n * However, in order to simplify TypeScript typings, we follow this [Flux Standard Actions](https://github.com/redux-utilities/flux-standard-action)-like\r\n * convention, where all additional action information goes into a `payload` property.\r\n * @public\r\n */\r\nexport interface ActionWithPayload<T extends string, P> extends Action<T> {\r\n  payload: P;\r\n}\r\n\r\n/**\r\n * Creates a basic Redux Redux [Action](https://redux.js.org/basics/actions) without a payload.\r\n * **This is meant to be used as a shortcut for defining Action Creators.**\r\n *\r\n * For example,\r\n * ```\r\n *   () => createAction(\"FOO\", ids)\r\n * ```\r\n * defines an action creator of type:\r\n * ```\r\n *   () => { type: \"FOO\" }\r\n *   // which is equivalent to:\r\n *   () => Action<\"FOO\">\r\n * ```\r\n *\r\n * Note that the generic type parameters can always be omitted - TypeScript will be able to infer them.\r\n * @param type The string to use as the action's type property. Should have a [string literal type](https://www.typescriptlang.org/docs/handbook/advanced-types.html#string-literal-types).\r\n * @public\r\n */\r\nexport function createAction<T extends string>(type: T): Action<T>;\r\n/**\r\n * Creates a basic Redux Redux [Action](https://redux.js.org/basics/actions) _with_ a payload value.\r\n * **This is meant to be used as a shortcut for defining Action Creators.**\r\n *\r\n * For example,\r\n * ```\r\n *   (ids: number[]) => createAction(\"FOO\", ids)\r\n * ```\r\n * defines an action creator of type:\r\n * ```\r\n *   (ids: number[]) => { type: \"FOO\", payload: ReadonlyArray<number> }\r\n *   // which is equivalent to:\r\n *   (ids: number[]) => ActionWithPayload<\"FOO\", ReadonlyArray<number>>\r\n * ```\r\n *\r\n * Note that the generic type parameters can always be omitted - TypeScript will be able to infer them.\r\n * @param type The string to use as the action's type property. Should have a [string literal type](https://www.typescriptlang.org/docs/handbook/advanced-types.html#string-literal-types).\r\n * @param payload The value to use as the action's payload property. May be of any type.\r\n * @public\r\n */\r\nexport function createAction<T extends string, P>(type: T, payload: P): ActionWithPayload<T, DeepReadonly<P>>;\r\nexport function createAction<T extends string, P>(type: T, payload?: P) {\r\n  return (payload === undefined) ? /* istanbul ignore next */ { type } : { type, payload };\r\n}\r\n\r\n/**\r\n * Just an object where every property is a Redux [Action Creator](https://redux.js.org/basics/actions#action-creators).\r\n * @public\r\n */\r\nexport type ActionCreatorsObject = { [actionCreatorName: string]: FunctionType; };\r\n\r\n/**\r\n * A TypeScript type alias that represents the [Union Type](https://www.typescriptlang.org/docs/handbook/advanced-types.html#union-types) of all actions\r\n * possibly created by _any_ of the action creators in a given `ActionCreatorsObject`.\r\n *\r\n * For example,\r\n * ```\r\n *   // given:\r\n *   const MyActionCreators = {\r\n *     createBanana: () => createAction(\"BANANA\"),\r\n *     createApple:  () => createAction(\"APPLE\", true),\r\n *     createOrange: (n: number) => createAction(\"BANANA\", n),\r\n *   }\r\n *   // then:\r\n *   type X = ActionsUnion<typeof MyActionCreators>;\r\n *   // is equivalent to:\r\n *   type X = Action<\"BANANA\">\r\n *            | ActionWithPayload<\"APPLE\", boolean>\r\n *            | ActionWithPayload<\"ORANGE\", number>;\r\n * ```\r\n * @public\r\n */\r\nexport type ActionsUnion<A extends ActionCreatorsObject> = ReturnType<A[keyof A]>;\r\n\r\n/**\r\n * A TypeScript type alias that uses [conditional types](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html) (read: magic)\r\n * to represent the _exact_ (literal) type of an action's `type` property.\r\n *\r\n * More importantly, this can be used to determine a union type which represents the `type` string literal types for _any_ action in a given `ActionsUnion`.\r\n *\r\n * For example,\r\n * ```\r\n *   // given:\r\n *   type MyActions = Action<\"BANANA\">\r\n *                    | ActionWithPayload<\"APPLE\", boolean>\r\n *                    | ActionWithPayload<\"ORANGE\", number>;\r\n *   // then:\r\n *   type X = ActionTypes<MyActions>;\r\n *   // is equivalent to:\r\n *   type X = \"BANANA\" | \"APPLE\" | \"ORANGE\";\r\n * ```\r\n * @public\r\n */\r\nexport type ActionTypes<A extends Action<any>> = A[\"type\"] extends infer X ? (X extends string ? X : never) : never;\r\n\r\n/**\r\n * A Redux [Reducer](https://redux.js.org/basics/reducers).\r\n * @public\r\n */\r\nexport type Reducer<S, A> = (state: S, action: A) => S;\r\n\r\n/**\r\n * A TypeScript type alias that represents a union of all action types handled by a Redux [Reducer](https://redux.js.org/basics/reducers).\r\n *\r\n * If you have created a type-safe reducer function using `combineReducers`, you can use this to infer your actions union type instead of having to define it manually.\r\n * @public\r\n */\r\nexport type ReducerActions<R> =\r\n  R extends Reducer<any, infer X> ? (\r\n    X extends ActionWithPayload<infer T, infer P> ? DeepReadonly<ActionWithPayload<T, P>> :\r\n    X extends Action<infer T2> ? DeepReadonly<Action<T2>> :\r\n    X\r\n  ) : R;\r\n\r\n/**\r\n * A TypeScript type alias that represents the return type of a Redux [Reducer](https://redux.js.org/basics/reducers).\r\n *\r\n * If you have created a type-safe reducer function using `combineReducers`, you can use this to infer your state type instead of having to define it manually.\r\n * @public\r\n */\r\nexport type StateType<R extends Reducer<any, any>> = DeepReadonly<ReturnType<R>>;\r\n\r\n\r\n/**\r\n * So we don't actually need to implement our own version of combineReducers, but we are going to cast it\r\n * to this type, which will do a better job of preserving/deducing the Action and State types.\r\n * @public\r\n */\r\nexport type CombineReducersFunction = <A>(reducers: A) =>\r\n  (state: CombinedReducerState<A>, action: ReducerMapActions<A>) => CombinedReducerState<A>;\r\n\r\n/**\r\n * A type alias which represents the state created by the reducer returned by combineReducers for a given `reducers` argument.\r\n * Used above by `CombineReducersFunction`, our custom type definition for combineReducers.\r\n * @public\r\n */\r\nexport type CombinedReducerState<R> = { readonly [K in keyof R]: R[K] extends FunctionType ? StateType<R[K]> : never };\r\n\r\n/**\r\n * A type alias which represents the union type of all actions handled by the reducer returned by combineReducers for a given `reducers` argument.\r\n * Used above by `CombineReducersFunction`, our custom type definition for combineReducers.\r\n * @public\r\n */\r\nexport type ReducerMapActions<R> = ReducerActions<R[keyof R]>;\r\n\r\n\r\n// Since the implementation is copied from redux, we'll copy the docs as well:\r\n/**\r\n * Turns an object whose values are different reducer functions, into a single\r\n * reducer function. It will call every child reducer, and gather their results\r\n * into a single state object, whose keys correspond to the keys of the passed\r\n * reducer functions.\r\n *\r\n * //@template S Combined state object type.\r\n *\r\n * @param reducers An object whose values correspond to different reducer\r\n *   functions that need to be combined into one. One handy way to obtain it\r\n *   is to use ES6 `import * as reducers` syntax. The reducers may never\r\n *   return undefined for any action. Instead, they should return their\r\n *   initial state if the state passed to them was undefined, and the current\r\n *   state for any unrecognized action.\r\n *\r\n * Returns: A reducer function that invokes every reducer inside the passed\r\n *   object, and builds a state object with the same shape.\r\n * @public\r\n */\r\nexport const combineReducers: CombineReducersFunction = baseCombineReducers as any;\r\n"]}

package/lib/esm/appui-react/safearea/SafeAreaContext.d.ts

@@ -0,0 +1,72 @@
+/** @packageDocumentation
+ * @module State
+ */
+import * as React from "react";
+import { Subtract } from "@itwin/presentation-common";
+import { SafeAreaInsets } from "@itwin/appui-layout-react";
+/**
+ * Context used to manage safe area (feature used by devices with non-rectangular screens).
+ * @public
+ */
+export declare const SafeAreaContext: React.Context<SafeAreaInsets>;
+interface InjectedWithSafeAreaProps {
+    readonly safeAreaInsets?: SafeAreaInsets;
+}
+/** HOC that injects SafeAreaInsets.
+ * @public
+ */
+export declare const withSafeArea: <P extends InjectedWithSafeAreaProps, C>(Component: React.JSXElementConstructor<P> & C) => {
+    new (props: JSX.LibraryManagedAttributes<C, Subtract<P, InjectedWithSafeAreaProps>> | Readonly<JSX.LibraryManagedAttributes<C, Subtract<P, InjectedWithSafeAreaProps>>>): {
+        render(): JSX.Element;
+        context: any;
+        setState<K extends never>(state: {} | ((prevState: Readonly<{}>, props: Readonly<JSX.LibraryManagedAttributes<C, Subtract<P, InjectedWithSafeAreaProps>>>) => {} | Pick<{}, K> | null) | Pick<{}, K> | null, callback?: (() => void) | undefined): void;
+        forceUpdate(callback?: (() => void) | undefined): void;
+        readonly props: Readonly<JSX.LibraryManagedAttributes<C, Subtract<P, InjectedWithSafeAreaProps>>> & Readonly<{
+            children?: React.ReactNode;
+        }>;
+        state: Readonly<{}>;
+        refs: {
+            [key: string]: React.ReactInstance;
+        };
+        componentDidMount?(): void;
+        shouldComponentUpdate?(nextProps: Readonly<JSX.LibraryManagedAttributes<C, Subtract<P, InjectedWithSafeAreaProps>>>, nextState: Readonly<{}>, nextContext: any): boolean;
+        componentWillUnmount?(): void;
+        componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
+        getSnapshotBeforeUpdate?(prevProps: Readonly<JSX.LibraryManagedAttributes<C, Subtract<P, InjectedWithSafeAreaProps>>>, prevState: Readonly<{}>): any;
+        componentDidUpdate?(prevProps: Readonly<JSX.LibraryManagedAttributes<C, Subtract<P, InjectedWithSafeAreaProps>>>, prevState: Readonly<{}>, snapshot?: any): void;
+        componentWillMount?(): void;
+        UNSAFE_componentWillMount?(): void;
+        componentWillReceiveProps?(nextProps: Readonly<JSX.LibraryManagedAttributes<C, Subtract<P, InjectedWithSafeAreaProps>>>, nextContext: any): void;
+        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<JSX.LibraryManagedAttributes<C, Subtract<P, InjectedWithSafeAreaProps>>>, nextContext: any): void;
+        componentWillUpdate?(nextProps: Readonly<JSX.LibraryManagedAttributes<C, Subtract<P, InjectedWithSafeAreaProps>>>, nextState: Readonly<{}>, nextContext: any): void;
+        UNSAFE_componentWillUpdate?(nextProps: Readonly<JSX.LibraryManagedAttributes<C, Subtract<P, InjectedWithSafeAreaProps>>>, nextState: Readonly<{}>, nextContext: any): void;
+    };
+    new (props: JSX.LibraryManagedAttributes<C, Subtract<P, InjectedWithSafeAreaProps>>, context: any): {
+        render(): JSX.Element;
+        context: any;
+        setState<K extends never>(state: {} | ((prevState: Readonly<{}>, props: Readonly<JSX.LibraryManagedAttributes<C, Subtract<P, InjectedWithSafeAreaProps>>>) => {} | Pick<{}, K> | null) | Pick<{}, K> | null, callback?: (() => void) | undefined): void;
+        forceUpdate(callback?: (() => void) | undefined): void;
+        readonly props: Readonly<JSX.LibraryManagedAttributes<C, Subtract<P, InjectedWithSafeAreaProps>>> & Readonly<{
+            children?: React.ReactNode;
+        }>;
+        state: Readonly<{}>;
+        refs: {
+            [key: string]: React.ReactInstance;
+        };
+        componentDidMount?(): void;
+        shouldComponentUpdate?(nextProps: Readonly<JSX.LibraryManagedAttributes<C, Subtract<P, InjectedWithSafeAreaProps>>>, nextState: Readonly<{}>, nextContext: any): boolean;
+        componentWillUnmount?(): void;
+        componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
+        getSnapshotBeforeUpdate?(prevProps: Readonly<JSX.LibraryManagedAttributes<C, Subtract<P, InjectedWithSafeAreaProps>>>, prevState: Readonly<{}>): any;
+        componentDidUpdate?(prevProps: Readonly<JSX.LibraryManagedAttributes<C, Subtract<P, InjectedWithSafeAreaProps>>>, prevState: Readonly<{}>, snapshot?: any): void;
+        componentWillMount?(): void;
+        UNSAFE_componentWillMount?(): void;
+        componentWillReceiveProps?(nextProps: Readonly<JSX.LibraryManagedAttributes<C, Subtract<P, InjectedWithSafeAreaProps>>>, nextContext: any): void;
+        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<JSX.LibraryManagedAttributes<C, Subtract<P, InjectedWithSafeAreaProps>>>, nextContext: any): void;
+        componentWillUpdate?(nextProps: Readonly<JSX.LibraryManagedAttributes<C, Subtract<P, InjectedWithSafeAreaProps>>>, nextState: Readonly<{}>, nextContext: any): void;
+        UNSAFE_componentWillUpdate?(nextProps: Readonly<JSX.LibraryManagedAttributes<C, Subtract<P, InjectedWithSafeAreaProps>>>, nextState: Readonly<{}>, nextContext: any): void;
+    };
+    contextType?: React.Context<any> | undefined;
+};
+export {};
+//# sourceMappingURL=SafeAreaContext.d.ts.map

package/lib/esm/appui-react/safearea/SafeAreaContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SafeAreaContext.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/safearea/SafeAreaContext.tsx"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D;;;GAGG;AAEH,eAAO,MAAM,eAAe,+BAA2D,CAAC;AAExF,UAAU,yBAAyB;IACjC,QAAQ,CAAC,cAAc,CAAC,EAAE,cAAc,CAAC;CAC1C;AAED;;GAEG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqBxB,CAAC"}

package/lib/esm/appui-react/safearea/SafeAreaContext.js

@@ -0,0 +1,29 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import * as React from "react";
+import { SafeAreaInsets } from "@itwin/appui-layout-react";
+/**
+ * Context used to manage safe area (feature used by devices with non-rectangular screens).
+ * @public
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const SafeAreaContext = React.createContext(SafeAreaInsets.None);
+/** HOC that injects SafeAreaInsets.
+ * @public
+ */
+export const withSafeArea = (
+// eslint-disable-next-line @typescript-eslint/naming-convention
+Component) => {
+    return class WithSafeArea extends React.PureComponent {
+        render() {
+            const { ...props } = this.props;
+            return (React.createElement(SafeAreaContext.Consumer, null, (safeAreaInsets) => (React.createElement(Component, { ...props, safeAreaInsets: safeAreaInsets }))));
+        }
+    };
+};
+//# sourceMappingURL=SafeAreaContext.js.map

package/lib/esm/appui-react/safearea/SafeAreaContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SafeAreaContext.js","sourceRoot":"","sources":["../../../../src/appui-react/safearea/SafeAreaContext.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3D;;;GAGG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,CAAC,aAAa,CAAiB,cAAc,CAAC,IAAI,CAAC,CAAC;AAMxF;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;AAC1B,gEAAgE;AAChE,SAA6C,EAC7C,EAAE;IAGF,OAAO,MAAM,YAAa,SAAQ,KAAK,CAAC,aAAoB;QAC1C,MAAM;YACpB,MAAM,EAAE,GAAG,KAAK,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;YAChC,OAAO,CACL,oBAAC,eAAe,CAAC,QAAQ,QACtB,CAAC,cAAc,EAAE,EAAE,CAAC,CACnB,oBAAC,SAAS,OACJ,KAAY,EAChB,cAAc,EAAE,cAAc,GAC9B,CACH,CACwB,CAC5B,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,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\nimport * as React from \"react\";\r\nimport { Subtract } from \"@itwin/presentation-common\";\r\nimport { SafeAreaInsets } from \"@itwin/appui-layout-react\";\r\n\r\n/**\r\n * Context used to manage safe area (feature used by devices with non-rectangular screens).\r\n * @public\r\n */\r\n// eslint-disable-next-line @typescript-eslint/naming-convention\r\nexport const SafeAreaContext = React.createContext<SafeAreaInsets>(SafeAreaInsets.None);\r\n\r\ninterface InjectedWithSafeAreaProps {\r\n  readonly safeAreaInsets?: SafeAreaInsets;\r\n}\r\n\r\n/** HOC that injects SafeAreaInsets.\r\n * @public\r\n */\r\nexport const withSafeArea = <P extends InjectedWithSafeAreaProps, C>(\r\n  // eslint-disable-next-line @typescript-eslint/naming-convention\r\n  Component: React.JSXElementConstructor<P> & C,\r\n) => {\r\n  type Props = JSX.LibraryManagedAttributes<C, Subtract<P, InjectedWithSafeAreaProps>>;\r\n\r\n  return class WithSafeArea extends React.PureComponent<Props> {\r\n    public override render() {\r\n      const { ...props } = this.props;\r\n      return (\r\n        <SafeAreaContext.Consumer>\r\n          {(safeAreaInsets) => (\r\n            <Component\r\n              {...props as any}\r\n              safeAreaInsets={safeAreaInsets}\r\n            />\r\n          )}\r\n        </SafeAreaContext.Consumer>\r\n      );\r\n    }\r\n  };\r\n};\r\n"]}