@itwin/presentation-frontend 4.0.0-dev.21 → 4.0.0-dev.23

package/lib/esm/presentation-frontend/StateTracker.js

@@ -1,126 +1,126 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Core
- */
-import { using } from "@itwin/core-bentley";
-/**
- * The tracker stores up-to-date UI state of the hierarchies on the frontend and reports
- * just the state changes to the backend as soon as component sends in a new hierarchy state.
- *
- * @internal
- */
-export class StateTracker {
-    constructor(ipcRequestsHandler) {
-        this._ipcRequestsHandler = ipcRequestsHandler;
-        this._hierarchyStates = new Map();
-    }
-    async updateHierarchyStateIfNeeded(imodelKey, rulesetId, stateChanges) {
-        if (stateChanges.length === 0)
-            return;
-        await this._ipcRequestsHandler.updateHierarchyState({ imodelKey, rulesetId, stateChanges });
-    }
-    async onHierarchyClosed(imodel, rulesetId, sourceId) {
-        const hierarchyState = this._hierarchyStates.get(rulesetId);
-        if (!hierarchyState)
-            return;
-        const stateChanges = [];
-        hierarchyState.forEach((entry) => {
-            if (!entry.states.has(sourceId)) {
-                // the node has no state for this source - nothing to do
-                return;
-            }
-            using(new MergedNodeStateChangeReporter(entry, stateChanges), (_) => {
-                entry.states.delete(sourceId);
-            });
-        });
-        await this.updateHierarchyStateIfNeeded(imodel.key, rulesetId, stateChanges);
-    }
-    async onHierarchyStateChanged(imodel, rulesetId, sourceId, newHierarchyState) {
-        let hierarchyState = this._hierarchyStates.get(rulesetId);
-        if (!hierarchyState) {
-            if (newHierarchyState.length === 0)
-                return;
-            hierarchyState = new Map();
-            this._hierarchyStates.set(rulesetId, hierarchyState);
-        }
-        const handledNodeIds = new Set();
-        const stateChanges = [];
-        // step 1: walk over new state and report all changes
-        newHierarchyState.forEach(({ node, state }) => {
-            const nodeId = node === null || node === void 0 ? void 0 : node.id;
-            const nodeKey = node === null || node === void 0 ? void 0 : node.key;
-            const existingNodeEntry = hierarchyState.get(nodeId);
-            if (existingNodeEntry) {
-                using(new MergedNodeStateChangeReporter(existingNodeEntry, stateChanges), (_) => {
-                    existingNodeEntry.states.set(sourceId, state);
-                });
-            }
-            else {
-                hierarchyState.set(nodeId, { key: nodeKey, states: new Map([[sourceId, state]]) });
-                stateChanges.push({ ...calculateMergedNodeState([state].values()), nodeKey });
-            }
-            handledNodeIds.add(nodeId);
-        });
-        // step 2: walk over old state and remove all state that's not in the new state
-        const erasedNodeIds = new Set();
-        hierarchyState.forEach((entry, nodeId) => {
-            if (handledNodeIds.has(nodeId)) {
-                // the node was handled with the new state - nothing to do here
-                return;
-            }
-            if (!entry.states.has(sourceId)) {
-                // the node had no state for this source, so it's not affected by this report
-                return;
-            }
-            using(new MergedNodeStateChangeReporter(entry, stateChanges), (_) => {
-                entry.states.delete(sourceId);
-            });
-            // istanbul ignore next
-            if (entry.states.size === 0) {
-                // there are no more components holding state for this node
-                erasedNodeIds.add(nodeId);
-            }
-        });
-        // step 3: cleanup erased node ids and possibly the whole hierarchy state
-        for (const nodeId of erasedNodeIds) {
-            hierarchyState.delete(nodeId);
-        }
-        if (hierarchyState.size === 0)
-            this._hierarchyStates.delete(rulesetId);
-        // finally, report
-        await this.updateHierarchyStateIfNeeded(imodel.key, rulesetId, stateChanges);
-    }
-}
-function calculateMergedNodeState(perComponentStates) {
-    const merged = {};
-    for (const state of perComponentStates) {
-        if (state.isExpanded)
-            merged.isExpanded = true;
-        if (state.instanceFilter) {
-            if (!merged.instanceFilters)
-                merged.instanceFilters = [state.instanceFilter];
-            else if (!merged.instanceFilters.includes(state.instanceFilter))
-                merged.instanceFilters.push(state.instanceFilter);
-        }
-    }
-    return merged;
-}
-class MergedNodeStateChangeReporter {
-    constructor(entry, outStateChanges) {
-        this._entry = entry;
-        this._stateBefore = calculateMergedNodeState(this._entry.states.values());
-        this._outStateChanges = outStateChanges;
-    }
-    dispose() {
-        var _a, _b, _c, _d;
-        const stateAfter = calculateMergedNodeState(this._entry.states.values());
-        const expandedFlagsDiffer = !!stateAfter.isExpanded !== !!this._stateBefore.isExpanded;
-        const instanceFiltersDiffer = ((_b = (_a = stateAfter.instanceFilters) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0) !== ((_d = (_c = this._stateBefore.instanceFilters) === null || _c === void 0 ? void 0 : _c.length) !== null && _d !== void 0 ? _d : 0);
-        if (expandedFlagsDiffer || instanceFiltersDiffer)
-            this._outStateChanges.push({ ...stateAfter, nodeKey: this._entry.key });
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Core
+ */
+import { using } from "@itwin/core-bentley";
+/**
+ * The tracker stores up-to-date UI state of the hierarchies on the frontend and reports
+ * just the state changes to the backend as soon as component sends in a new hierarchy state.
+ *
+ * @internal
+ */
+export class StateTracker {
+    constructor(ipcRequestsHandler) {
+        this._ipcRequestsHandler = ipcRequestsHandler;
+        this._hierarchyStates = new Map();
+    }
+    async updateHierarchyStateIfNeeded(imodelKey, rulesetId, stateChanges) {
+        if (stateChanges.length === 0)
+            return;
+        await this._ipcRequestsHandler.updateHierarchyState({ imodelKey, rulesetId, stateChanges });
+    }
+    async onHierarchyClosed(imodel, rulesetId, sourceId) {
+        const hierarchyState = this._hierarchyStates.get(rulesetId);
+        if (!hierarchyState)
+            return;
+        const stateChanges = [];
+        hierarchyState.forEach((entry) => {
+            if (!entry.states.has(sourceId)) {
+                // the node has no state for this source - nothing to do
+                return;
+            }
+            using(new MergedNodeStateChangeReporter(entry, stateChanges), (_) => {
+                entry.states.delete(sourceId);
+            });
+        });
+        await this.updateHierarchyStateIfNeeded(imodel.key, rulesetId, stateChanges);
+    }
+    async onHierarchyStateChanged(imodel, rulesetId, sourceId, newHierarchyState) {
+        let hierarchyState = this._hierarchyStates.get(rulesetId);
+        if (!hierarchyState) {
+            if (newHierarchyState.length === 0)
+                return;
+            hierarchyState = new Map();
+            this._hierarchyStates.set(rulesetId, hierarchyState);
+        }
+        const handledNodeIds = new Set();
+        const stateChanges = [];
+        // step 1: walk over new state and report all changes
+        newHierarchyState.forEach(({ node, state }) => {
+            const nodeId = node === null || node === void 0 ? void 0 : node.id;
+            const nodeKey = node === null || node === void 0 ? void 0 : node.key;
+            const existingNodeEntry = hierarchyState.get(nodeId);
+            if (existingNodeEntry) {
+                using(new MergedNodeStateChangeReporter(existingNodeEntry, stateChanges), (_) => {
+                    existingNodeEntry.states.set(sourceId, state);
+                });
+            }
+            else {
+                hierarchyState.set(nodeId, { key: nodeKey, states: new Map([[sourceId, state]]) });
+                stateChanges.push({ ...calculateMergedNodeState([state].values()), nodeKey });
+            }
+            handledNodeIds.add(nodeId);
+        });
+        // step 2: walk over old state and remove all state that's not in the new state
+        const erasedNodeIds = new Set();
+        hierarchyState.forEach((entry, nodeId) => {
+            if (handledNodeIds.has(nodeId)) {
+                // the node was handled with the new state - nothing to do here
+                return;
+            }
+            if (!entry.states.has(sourceId)) {
+                // the node had no state for this source, so it's not affected by this report
+                return;
+            }
+            using(new MergedNodeStateChangeReporter(entry, stateChanges), (_) => {
+                entry.states.delete(sourceId);
+            });
+            // istanbul ignore next
+            if (entry.states.size === 0) {
+                // there are no more components holding state for this node
+                erasedNodeIds.add(nodeId);
+            }
+        });
+        // step 3: cleanup erased node ids and possibly the whole hierarchy state
+        for (const nodeId of erasedNodeIds) {
+            hierarchyState.delete(nodeId);
+        }
+        if (hierarchyState.size === 0)
+            this._hierarchyStates.delete(rulesetId);
+        // finally, report
+        await this.updateHierarchyStateIfNeeded(imodel.key, rulesetId, stateChanges);
+    }
+}
+function calculateMergedNodeState(perComponentStates) {
+    const merged = {};
+    for (const state of perComponentStates) {
+        if (state.isExpanded)
+            merged.isExpanded = true;
+        if (state.instanceFilter) {
+            if (!merged.instanceFilters)
+                merged.instanceFilters = [state.instanceFilter];
+            else if (!merged.instanceFilters.includes(state.instanceFilter))
+                merged.instanceFilters.push(state.instanceFilter);
+        }
+    }
+    return merged;
+}
+class MergedNodeStateChangeReporter {
+    constructor(entry, outStateChanges) {
+        this._entry = entry;
+        this._stateBefore = calculateMergedNodeState(this._entry.states.values());
+        this._outStateChanges = outStateChanges;
+    }
+    dispose() {
+        var _a, _b, _c, _d;
+        const stateAfter = calculateMergedNodeState(this._entry.states.values());
+        const expandedFlagsDiffer = !!stateAfter.isExpanded !== !!this._stateBefore.isExpanded;
+        const instanceFiltersDiffer = ((_b = (_a = stateAfter.instanceFilters) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0) !== ((_d = (_c = this._stateBefore.instanceFilters) === null || _c === void 0 ? void 0 : _c.length) !== null && _d !== void 0 ? _d : 0);
+        if (expandedFlagsDiffer || instanceFiltersDiffer)
+            this._outStateChanges.push({ ...stateAfter, nodeKey: this._entry.key });
+    }
+}
 //# sourceMappingURL=StateTracker.js.map

package/lib/esm/presentation-frontend/StateTracker.js.map

@@ -1 +1 @@
-{"version":3,"file":"StateTracker.js","sourceRoot":"","sources":["../../../src/presentation-frontend/StateTracker.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAe,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAoCzD;;;;;GAKG;AACH,MAAM,OAAO,YAAY;IAKvB,YAAY,kBAAsC;QAChD,IAAI,CAAC,mBAAmB,GAAG,kBAAkB,CAAC;QAC9C,IAAI,CAAC,gBAAgB,GAAG,IAAI,GAAG,EAAE,CAAC;IACpC,CAAC;IAEO,KAAK,CAAC,4BAA4B,CAAC,SAAiB,EAAE,SAAiB,EAAE,YAAiC;QAChH,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC;YAC3B,OAAO;QACT,MAAM,IAAI,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC,CAAC;IAC9F,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,MAAwB,EAAE,SAAiB,EAAE,QAAgB;QAC1F,MAAM,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC5D,IAAI,CAAC,cAAc;YACjB,OAAO;QAET,MAAM,YAAY,GAAwB,EAAE,CAAC;QAC7C,cAAc,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC/B,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;gBAC/B,wDAAwD;gBACxD,OAAO;aACR;YACD,KAAK,CAAC,IAAI,6BAA6B,CAAC,KAAK,EAAE,YAAY,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;gBAClE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,IAAI,CAAC,4BAA4B,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC;IAC/E,CAAC;IAEM,KAAK,CAAC,uBAAuB,CAAC,MAAwB,EAAE,SAAiB,EAAE,QAAgB,EAAE,iBAAgF;QAClL,IAAI,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC1D,IAAI,CAAC,cAAc,EAAE;YACnB,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC;gBAChC,OAAO;YAET,cAAc,GAAG,IAAI,GAAG,EAAE,CAAC;YAC3B,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;SACtD;QAED,MAAM,cAAc,GAAG,IAAI,GAAG,EAAsB,CAAC;QACrD,MAAM,YAAY,GAAwB,EAAE,CAAC;QAE7C,qDAAqD;QACrD,iBAAiB,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE;YAC5C,MAAM,MAAM,GAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,EAAE,CAAC;YACxB,MAAM,OAAO,GAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,GAAG,CAAC;YAC1B,MAAM,iBAAiB,GAAG,cAAe,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACtD,IAAI,iBAAiB,EAAE;gBACrB,KAAK,CAAC,IAAI,6BAA6B,CAAC,iBAAiB,EAAE,YAAY,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;oBAC9E,iBAAiB,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;gBAChD,CAAC,CAAC,CAAC;aACJ;iBAAM;gBACL,cAAe,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;gBACpF,YAAY,CAAC,IAAI,CAAC,EAAE,GAAG,wBAAwB,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;aAC/E;YACD,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;QAEH,+EAA+E;QAC/E,MAAM,aAAa,GAAG,IAAI,GAAG,EAAsB,CAAC;QACpD,cAAc,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YACvC,IAAI,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;gBAC9B,+DAA+D;gBAC/D,OAAO;aACR;YAED,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;gBAC/B,6EAA6E;gBAC7E,OAAO;aACR;YAED,KAAK,CAAC,IAAI,6BAA6B,CAAC,KAAK,EAAE,YAAY,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;gBAClE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;YAEH,uBAAuB;YACvB,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,EAAE;gBAC3B,2DAA2D;gBAC3D,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;aAC3B;QACH,CAAC,CAAC,CAAC;QAEH,yEAAyE;QACzE,KAAK,MAAM,MAAM,IAAI,aAAa,EAAE;YAClC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;SAC/B;QACD,IAAI,cAAc,CAAC,IAAI,KAAK,CAAC;YAC3B,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAE1C,kBAAkB;QAClB,MAAM,IAAI,CAAC,4BAA4B,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC;IAC/E,CAAC;CACF;AAED,SAAS,wBAAwB,CAAC,kBAA+C;IAC/E,MAAM,MAAM,GAAoB,EAAE,CAAC;IACnC,KAAK,MAAM,KAAK,IAAI,kBAAkB,EAAE;QACtC,IAAI,KAAK,CAAC,UAAU;YAClB,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;QAC3B,IAAI,KAAK,CAAC,cAAc,EAAE;YACxB,IAAI,CAAC,MAAM,CAAC,eAAe;gBACzB,MAAM,CAAC,eAAe,GAAG,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;iBAC7C,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC;gBAC7D,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;SACrD;KACF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,6BAA6B;IAIjC,YAAmB,KAAsB,EAAE,eAAoC;QAC7E,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,YAAY,GAAG,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1E,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;IAC1C,CAAC;IACM,OAAO;;QACZ,MAAM,UAAU,GAAG,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QACzE,MAAM,mBAAmB,GAAG,CAAC,CAAC,UAAU,CAAC,UAAU,KAAK,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC;QACvF,MAAM,qBAAqB,GAAG,CAAC,MAAA,MAAA,UAAU,CAAC,eAAe,0CAAE,MAAM,mCAAI,CAAC,CAAC,KAAK,CAAC,MAAA,MAAA,IAAI,CAAC,YAAY,CAAC,eAAe,0CAAE,MAAM,mCAAI,CAAC,CAAC,CAAC;QAC7H,IAAI,mBAAmB,IAAI,qBAAqB;YAC9C,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,GAAG,UAAU,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC;IAC5E,CAAC;CACF","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 Core\r\n */\r\n\r\nimport { IDisposable, using } from \"@itwin/core-bentley\";\r\nimport { IModelConnection } from \"@itwin/core-frontend\";\r\nimport { NodeKey } from \"@itwin/presentation-common\";\r\nimport { IpcRequestsHandler } from \"./IpcRequestsHandler\";\r\n\r\n/**\r\n * Data structure that describes information used by [[StateTracker]] to identify node.\r\n * @internal\r\n */\r\nexport interface NodeIdentifier {\r\n  id: string;\r\n  key: NodeKey;\r\n}\r\n\r\n/**\r\n * @internal\r\n */\r\nexport interface NodeState {\r\n  isExpanded?: boolean;\r\n  instanceFilter?: string;\r\n}\r\n\r\ninterface MergedNodeState {\r\n  isExpanded?: boolean;\r\n  instanceFilters?: string[];\r\n}\r\n\r\ninterface ReportedNodeState extends MergedNodeState {\r\n  nodeKey: NodeKey | undefined;\r\n}\r\n\r\ninterface NodeStatesEntry {\r\n  key: NodeKey | undefined;\r\n  states: Map<string, NodeState>; // per-component node state\r\n}\r\n\r\n/**\r\n * The tracker stores up-to-date UI state of the hierarchies on the frontend and reports\r\n * just the state changes to the backend as soon as component sends in a new hierarchy state.\r\n *\r\n * @internal\r\n */\r\nexport class StateTracker {\r\n  // Ruleset ID => Node ID => Node state info\r\n  private _hierarchyStates: Map<string, Map<string | undefined, NodeStatesEntry>>;\r\n  private _ipcRequestsHandler: IpcRequestsHandler;\r\n\r\n  constructor(ipcRequestsHandler: IpcRequestsHandler) {\r\n    this._ipcRequestsHandler = ipcRequestsHandler;\r\n    this._hierarchyStates = new Map();\r\n  }\r\n\r\n  private async updateHierarchyStateIfNeeded(imodelKey: string, rulesetId: string, stateChanges: ReportedNodeState[]) {\r\n    if (stateChanges.length === 0)\r\n      return;\r\n    await this._ipcRequestsHandler.updateHierarchyState({ imodelKey, rulesetId, stateChanges });\r\n  }\r\n\r\n  public async onHierarchyClosed(imodel: IModelConnection, rulesetId: string, sourceId: string) {\r\n    const hierarchyState = this._hierarchyStates.get(rulesetId);\r\n    if (!hierarchyState)\r\n      return;\r\n\r\n    const stateChanges: ReportedNodeState[] = [];\r\n    hierarchyState.forEach((entry) => {\r\n      if (!entry.states.has(sourceId)) {\r\n        // the node has no state for this source - nothing to do\r\n        return;\r\n      }\r\n      using(new MergedNodeStateChangeReporter(entry, stateChanges), (_) => {\r\n        entry.states.delete(sourceId);\r\n      });\r\n    });\r\n\r\n    await this.updateHierarchyStateIfNeeded(imodel.key, rulesetId, stateChanges);\r\n  }\r\n\r\n  public async onHierarchyStateChanged(imodel: IModelConnection, rulesetId: string, sourceId: string, newHierarchyState: Array<{ node: NodeIdentifier | undefined, state: NodeState }>) {\r\n    let hierarchyState = this._hierarchyStates.get(rulesetId);\r\n    if (!hierarchyState) {\r\n      if (newHierarchyState.length === 0)\r\n        return;\r\n\r\n      hierarchyState = new Map();\r\n      this._hierarchyStates.set(rulesetId, hierarchyState);\r\n    }\r\n\r\n    const handledNodeIds = new Set<string | undefined>();\r\n    const stateChanges: ReportedNodeState[] = [];\r\n\r\n    // step 1: walk over new state and report all changes\r\n    newHierarchyState.forEach(({ node, state }) => {\r\n      const nodeId = node?.id;\r\n      const nodeKey = node?.key;\r\n      const existingNodeEntry = hierarchyState!.get(nodeId);\r\n      if (existingNodeEntry) {\r\n        using(new MergedNodeStateChangeReporter(existingNodeEntry, stateChanges), (_) => {\r\n          existingNodeEntry.states.set(sourceId, state);\r\n        });\r\n      } else {\r\n        hierarchyState!.set(nodeId, { key: nodeKey, states: new Map([[sourceId, state]]) });\r\n        stateChanges.push({ ...calculateMergedNodeState([state].values()), nodeKey });\r\n      }\r\n      handledNodeIds.add(nodeId);\r\n    });\r\n\r\n    // step 2: walk over old state and remove all state that's not in the new state\r\n    const erasedNodeIds = new Set<string | undefined>();\r\n    hierarchyState.forEach((entry, nodeId) => {\r\n      if (handledNodeIds.has(nodeId)) {\r\n        // the node was handled with the new state - nothing to do here\r\n        return;\r\n      }\r\n\r\n      if (!entry.states.has(sourceId)) {\r\n        // the node had no state for this source, so it's not affected by this report\r\n        return;\r\n      }\r\n\r\n      using(new MergedNodeStateChangeReporter(entry, stateChanges), (_) => {\r\n        entry.states.delete(sourceId);\r\n      });\r\n\r\n      // istanbul ignore next\r\n      if (entry.states.size === 0) {\r\n        // there are no more components holding state for this node\r\n        erasedNodeIds.add(nodeId);\r\n      }\r\n    });\r\n\r\n    // step 3: cleanup erased node ids and possibly the whole hierarchy state\r\n    for (const nodeId of erasedNodeIds) {\r\n      hierarchyState.delete(nodeId);\r\n    }\r\n    if (hierarchyState.size === 0)\r\n      this._hierarchyStates.delete(rulesetId);\r\n\r\n    // finally, report\r\n    await this.updateHierarchyStateIfNeeded(imodel.key, rulesetId, stateChanges);\r\n  }\r\n}\r\n\r\nfunction calculateMergedNodeState(perComponentStates: IterableIterator<NodeState>): MergedNodeState {\r\n  const merged: MergedNodeState = {};\r\n  for (const state of perComponentStates) {\r\n    if (state.isExpanded)\r\n      merged.isExpanded = true;\r\n    if (state.instanceFilter) {\r\n      if (!merged.instanceFilters)\r\n        merged.instanceFilters = [state.instanceFilter];\r\n      else if (!merged.instanceFilters.includes(state.instanceFilter))\r\n        merged.instanceFilters.push(state.instanceFilter);\r\n    }\r\n  }\r\n  return merged;\r\n}\r\n\r\nclass MergedNodeStateChangeReporter implements IDisposable {\r\n  private _entry: NodeStatesEntry;\r\n  private _stateBefore: MergedNodeState;\r\n  private _outStateChanges: ReportedNodeState[];\r\n  public constructor(entry: NodeStatesEntry, outStateChanges: ReportedNodeState[]) {\r\n    this._entry = entry;\r\n    this._stateBefore = calculateMergedNodeState(this._entry.states.values());\r\n    this._outStateChanges = outStateChanges;\r\n  }\r\n  public dispose() {\r\n    const stateAfter = calculateMergedNodeState(this._entry.states.values());\r\n    const expandedFlagsDiffer = !!stateAfter.isExpanded !== !!this._stateBefore.isExpanded;\r\n    const instanceFiltersDiffer = (stateAfter.instanceFilters?.length ?? 0) !== (this._stateBefore.instanceFilters?.length ?? 0);\r\n    if (expandedFlagsDiffer || instanceFiltersDiffer)\r\n      this._outStateChanges.push({ ...stateAfter, nodeKey: this._entry.key });\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"StateTracker.js","sourceRoot":"","sources":["../../../src/presentation-frontend/StateTracker.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAe,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAoCzD;;;;;GAKG;AACH,MAAM,OAAO,YAAY;IAKvB,YAAY,kBAAsC;QAChD,IAAI,CAAC,mBAAmB,GAAG,kBAAkB,CAAC;QAC9C,IAAI,CAAC,gBAAgB,GAAG,IAAI,GAAG,EAAE,CAAC;IACpC,CAAC;IAEO,KAAK,CAAC,4BAA4B,CAAC,SAAiB,EAAE,SAAiB,EAAE,YAAiC;QAChH,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC;YAC3B,OAAO;QACT,MAAM,IAAI,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC,CAAC;IAC9F,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,MAAwB,EAAE,SAAiB,EAAE,QAAgB;QAC1F,MAAM,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC5D,IAAI,CAAC,cAAc;YACjB,OAAO;QAET,MAAM,YAAY,GAAwB,EAAE,CAAC;QAC7C,cAAc,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC/B,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;gBAC/B,wDAAwD;gBACxD,OAAO;aACR;YACD,KAAK,CAAC,IAAI,6BAA6B,CAAC,KAAK,EAAE,YAAY,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;gBAClE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,IAAI,CAAC,4BAA4B,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC;IAC/E,CAAC;IAEM,KAAK,CAAC,uBAAuB,CAAC,MAAwB,EAAE,SAAiB,EAAE,QAAgB,EAAE,iBAAgF;QAClL,IAAI,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC1D,IAAI,CAAC,cAAc,EAAE;YACnB,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC;gBAChC,OAAO;YAET,cAAc,GAAG,IAAI,GAAG,EAAE,CAAC;YAC3B,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;SACtD;QAED,MAAM,cAAc,GAAG,IAAI,GAAG,EAAsB,CAAC;QACrD,MAAM,YAAY,GAAwB,EAAE,CAAC;QAE7C,qDAAqD;QACrD,iBAAiB,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE;YAC5C,MAAM,MAAM,GAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,EAAE,CAAC;YACxB,MAAM,OAAO,GAAG,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,GAAG,CAAC;YAC1B,MAAM,iBAAiB,GAAG,cAAe,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACtD,IAAI,iBAAiB,EAAE;gBACrB,KAAK,CAAC,IAAI,6BAA6B,CAAC,iBAAiB,EAAE,YAAY,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;oBAC9E,iBAAiB,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;gBAChD,CAAC,CAAC,CAAC;aACJ;iBAAM;gBACL,cAAe,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;gBACpF,YAAY,CAAC,IAAI,CAAC,EAAE,GAAG,wBAAwB,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;aAC/E;YACD,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;QAEH,+EAA+E;QAC/E,MAAM,aAAa,GAAG,IAAI,GAAG,EAAsB,CAAC;QACpD,cAAc,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YACvC,IAAI,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;gBAC9B,+DAA+D;gBAC/D,OAAO;aACR;YAED,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;gBAC/B,6EAA6E;gBAC7E,OAAO;aACR;YAED,KAAK,CAAC,IAAI,6BAA6B,CAAC,KAAK,EAAE,YAAY,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;gBAClE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;YAEH,uBAAuB;YACvB,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,EAAE;gBAC3B,2DAA2D;gBAC3D,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;aAC3B;QACH,CAAC,CAAC,CAAC;QAEH,yEAAyE;QACzE,KAAK,MAAM,MAAM,IAAI,aAAa,EAAE;YAClC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;SAC/B;QACD,IAAI,cAAc,CAAC,IAAI,KAAK,CAAC;YAC3B,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAE1C,kBAAkB;QAClB,MAAM,IAAI,CAAC,4BAA4B,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC;IAC/E,CAAC;CACF;AAED,SAAS,wBAAwB,CAAC,kBAA+C;IAC/E,MAAM,MAAM,GAAoB,EAAE,CAAC;IACnC,KAAK,MAAM,KAAK,IAAI,kBAAkB,EAAE;QACtC,IAAI,KAAK,CAAC,UAAU;YAClB,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;QAC3B,IAAI,KAAK,CAAC,cAAc,EAAE;YACxB,IAAI,CAAC,MAAM,CAAC,eAAe;gBACzB,MAAM,CAAC,eAAe,GAAG,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;iBAC7C,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC;gBAC7D,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;SACrD;KACF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,6BAA6B;IAIjC,YAAmB,KAAsB,EAAE,eAAoC;QAC7E,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,YAAY,GAAG,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1E,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;IAC1C,CAAC;IACM,OAAO;;QACZ,MAAM,UAAU,GAAG,wBAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QACzE,MAAM,mBAAmB,GAAG,CAAC,CAAC,UAAU,CAAC,UAAU,KAAK,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC;QACvF,MAAM,qBAAqB,GAAG,CAAC,MAAA,MAAA,UAAU,CAAC,eAAe,0CAAE,MAAM,mCAAI,CAAC,CAAC,KAAK,CAAC,MAAA,MAAA,IAAI,CAAC,YAAY,CAAC,eAAe,0CAAE,MAAM,mCAAI,CAAC,CAAC,CAAC;QAC7H,IAAI,mBAAmB,IAAI,qBAAqB;YAC9C,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,GAAG,UAAU,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC;IAC5E,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Core\n */\n\nimport { IDisposable, using } from \"@itwin/core-bentley\";\nimport { IModelConnection } from \"@itwin/core-frontend\";\nimport { NodeKey } from \"@itwin/presentation-common\";\nimport { IpcRequestsHandler } from \"./IpcRequestsHandler\";\n\n/**\n * Data structure that describes information used by [[StateTracker]] to identify node.\n * @internal\n */\nexport interface NodeIdentifier {\n  id: string;\n  key: NodeKey;\n}\n\n/**\n * @internal\n */\nexport interface NodeState {\n  isExpanded?: boolean;\n  instanceFilter?: string;\n}\n\ninterface MergedNodeState {\n  isExpanded?: boolean;\n  instanceFilters?: string[];\n}\n\ninterface ReportedNodeState extends MergedNodeState {\n  nodeKey: NodeKey | undefined;\n}\n\ninterface NodeStatesEntry {\n  key: NodeKey | undefined;\n  states: Map<string, NodeState>; // per-component node state\n}\n\n/**\n * The tracker stores up-to-date UI state of the hierarchies on the frontend and reports\n * just the state changes to the backend as soon as component sends in a new hierarchy state.\n *\n * @internal\n */\nexport class StateTracker {\n  // Ruleset ID => Node ID => Node state info\n  private _hierarchyStates: Map<string, Map<string | undefined, NodeStatesEntry>>;\n  private _ipcRequestsHandler: IpcRequestsHandler;\n\n  constructor(ipcRequestsHandler: IpcRequestsHandler) {\n    this._ipcRequestsHandler = ipcRequestsHandler;\n    this._hierarchyStates = new Map();\n  }\n\n  private async updateHierarchyStateIfNeeded(imodelKey: string, rulesetId: string, stateChanges: ReportedNodeState[]) {\n    if (stateChanges.length === 0)\n      return;\n    await this._ipcRequestsHandler.updateHierarchyState({ imodelKey, rulesetId, stateChanges });\n  }\n\n  public async onHierarchyClosed(imodel: IModelConnection, rulesetId: string, sourceId: string) {\n    const hierarchyState = this._hierarchyStates.get(rulesetId);\n    if (!hierarchyState)\n      return;\n\n    const stateChanges: ReportedNodeState[] = [];\n    hierarchyState.forEach((entry) => {\n      if (!entry.states.has(sourceId)) {\n        // the node has no state for this source - nothing to do\n        return;\n      }\n      using(new MergedNodeStateChangeReporter(entry, stateChanges), (_) => {\n        entry.states.delete(sourceId);\n      });\n    });\n\n    await this.updateHierarchyStateIfNeeded(imodel.key, rulesetId, stateChanges);\n  }\n\n  public async onHierarchyStateChanged(imodel: IModelConnection, rulesetId: string, sourceId: string, newHierarchyState: Array<{ node: NodeIdentifier | undefined, state: NodeState }>) {\n    let hierarchyState = this._hierarchyStates.get(rulesetId);\n    if (!hierarchyState) {\n      if (newHierarchyState.length === 0)\n        return;\n\n      hierarchyState = new Map();\n      this._hierarchyStates.set(rulesetId, hierarchyState);\n    }\n\n    const handledNodeIds = new Set<string | undefined>();\n    const stateChanges: ReportedNodeState[] = [];\n\n    // step 1: walk over new state and report all changes\n    newHierarchyState.forEach(({ node, state }) => {\n      const nodeId = node?.id;\n      const nodeKey = node?.key;\n      const existingNodeEntry = hierarchyState!.get(nodeId);\n      if (existingNodeEntry) {\n        using(new MergedNodeStateChangeReporter(existingNodeEntry, stateChanges), (_) => {\n          existingNodeEntry.states.set(sourceId, state);\n        });\n      } else {\n        hierarchyState!.set(nodeId, { key: nodeKey, states: new Map([[sourceId, state]]) });\n        stateChanges.push({ ...calculateMergedNodeState([state].values()), nodeKey });\n      }\n      handledNodeIds.add(nodeId);\n    });\n\n    // step 2: walk over old state and remove all state that's not in the new state\n    const erasedNodeIds = new Set<string | undefined>();\n    hierarchyState.forEach((entry, nodeId) => {\n      if (handledNodeIds.has(nodeId)) {\n        // the node was handled with the new state - nothing to do here\n        return;\n      }\n\n      if (!entry.states.has(sourceId)) {\n        // the node had no state for this source, so it's not affected by this report\n        return;\n      }\n\n      using(new MergedNodeStateChangeReporter(entry, stateChanges), (_) => {\n        entry.states.delete(sourceId);\n      });\n\n      // istanbul ignore next\n      if (entry.states.size === 0) {\n        // there are no more components holding state for this node\n        erasedNodeIds.add(nodeId);\n      }\n    });\n\n    // step 3: cleanup erased node ids and possibly the whole hierarchy state\n    for (const nodeId of erasedNodeIds) {\n      hierarchyState.delete(nodeId);\n    }\n    if (hierarchyState.size === 0)\n      this._hierarchyStates.delete(rulesetId);\n\n    // finally, report\n    await this.updateHierarchyStateIfNeeded(imodel.key, rulesetId, stateChanges);\n  }\n}\n\nfunction calculateMergedNodeState(perComponentStates: IterableIterator<NodeState>): MergedNodeState {\n  const merged: MergedNodeState = {};\n  for (const state of perComponentStates) {\n    if (state.isExpanded)\n      merged.isExpanded = true;\n    if (state.instanceFilter) {\n      if (!merged.instanceFilters)\n        merged.instanceFilters = [state.instanceFilter];\n      else if (!merged.instanceFilters.includes(state.instanceFilter))\n        merged.instanceFilters.push(state.instanceFilter);\n    }\n  }\n  return merged;\n}\n\nclass MergedNodeStateChangeReporter implements IDisposable {\n  private _entry: NodeStatesEntry;\n  private _stateBefore: MergedNodeState;\n  private _outStateChanges: ReportedNodeState[];\n  public constructor(entry: NodeStatesEntry, outStateChanges: ReportedNodeState[]) {\n    this._entry = entry;\n    this._stateBefore = calculateMergedNodeState(this._entry.states.values());\n    this._outStateChanges = outStateChanges;\n  }\n  public dispose() {\n    const stateAfter = calculateMergedNodeState(this._entry.states.values());\n    const expandedFlagsDiffer = !!stateAfter.isExpanded !== !!this._stateBefore.isExpanded;\n    const instanceFiltersDiffer = (stateAfter.instanceFilters?.length ?? 0) !== (this._stateBefore.instanceFilters?.length ?? 0);\n    if (expandedFlagsDiffer || instanceFiltersDiffer)\n      this._outStateChanges.push({ ...stateAfter, nodeKey: this._entry.key });\n  }\n}\n"]}

package/lib/esm/presentation-frontend/favorite-properties/FavoritePropertiesManager.d.ts

@@ -1,133 +1,133 @@
-/** @packageDocumentation
- * @module Core
- */
-import { BeEvent, IDisposable } from "@itwin/core-bentley";
-import { IModelConnection } from "@itwin/core-frontend";
-import { Field } from "@itwin/presentation-common";
-import { IFavoritePropertiesStorage } from "./FavoritePropertiesStorage";
-/**
- * Scopes that favorite properties can be stored in.
- * @public
- */
-export declare enum FavoritePropertiesScope {
-    Global = 0,
-    ITwin = 1,
-    IModel = 2
-}
-/**
- * Format:
- * Regular property - [{path from parent class}-]{schema name}:{class name}:{property name}.
- * Nested property - [{path from parent class}-]{content class schema name}:{content class name}.
- * Primitive property - {field name}.
- * @public
- */
-export declare type PropertyFullName = string;
-/**
- * Holds the information of favorite properties ordering.
- * @public
- */
-export interface FavoritePropertiesOrderInfo {
-    parentClassName: string | undefined;
-    name: PropertyFullName;
-    priority: number;
-    orderedTimestamp: Date;
-}
-/**
- * Properties for initializing [[FavoritePropertiesManager]]
- * @public
- */
-export interface FavoritePropertiesManagerProps {
-    /**
-     * Implementation of a persistence layer for storing favorite properties and their order.
-     * @public
-     */
-    storage: IFavoritePropertiesStorage;
-}
-/**
- * The favorite property manager which lets to store favorite properties
- * and check if field contains favorite properties.
- *
- * @public
- */
-export declare class FavoritePropertiesManager implements IDisposable {
-    /**
-     * Used in tests to avoid collisions between multiple runs using the same storage
-     * @internal
-     */
-    static FAVORITES_IDENTIFIER_PREFIX: string;
-    /** Event raised after favorite properties have changed. */
-    onFavoritesChanged: BeEvent<() => void>;
-    private _storage;
-    private _globalProperties;
-    private _iTwinProperties;
-    private _imodelProperties;
-    private _imodelBaseClassesByClass;
-    /** Property order is saved only in iModel scope */
-    private _propertiesOrder;
-    constructor(props: FavoritePropertiesManagerProps);
-    dispose(): void;
-    /**
-     * Initialize favorite properties for the provided IModelConnection.
-     */
-    initializeConnection: (imodel: IModelConnection) => Promise<void>;
-    /**
-     * Function that removes order information of properties that are no longer
-     * favorited and adds missing order information for favorited properties.
-     */
-    private _adjustPropertyOrderInfos;
-    private validateInitialization;
-    /**
-     * Adds favorite properties into a certain scope.
-     * @param field Field that contains properties. If field contains multiple properties, all of them will be favorited.
-     * @param imodel IModelConnection.
-     * @param scope FavoritePropertiesScope to put the favorite properties into.
-     * @note `initializeConnection` must be called with the `imodel` before calling this function.
-     */
-    add(field: Field, imodel: IModelConnection, scope: FavoritePropertiesScope): Promise<void>;
-    /**
-     * Removes favorite properties from a scope specified and all the more general scopes.
-     * @param field Field that contains properties. If field contains multiple properties, all of them will be un-favorited.
-     * @param imodel IModelConnection.
-     * @param scope FavoritePropertiesScope to remove the favorite properties from. It also removes from more general scopes.
-     * @note `initializeConnection` must be called with the `imodel` before calling this function.
-     */
-    remove(field: Field, imodel: IModelConnection, scope: FavoritePropertiesScope): Promise<void>;
-    /**
-     * Removes all favorite properties from a certain scope.
-     * @param imodel IModelConnection.
-     * @param scope FavoritePropertiesScope to remove the favorite properties from.
-     * @note `initializeConnection` must be called with the `imodel` before calling this function.
-     */
-    clear(imodel: IModelConnection, scope: FavoritePropertiesScope): Promise<void>;
-    /**
-     * Check if field contains at least one favorite property.
-     * @param field Field that contains properties.
-     * @param imodel IModelConnection.
-     * @param scope FavoritePropertiesScope to check for favorite properties. It also checks the more general scopes.
-     * @note `initializeConnection` must be called with the `imodel` before calling this function.
-     */
-    has(field: Field, imodel: IModelConnection, scope: FavoritePropertiesScope): boolean;
-    /**
-     * Sorts an array of fields with respect to favorite property order.
-     * Non-favorited fields get sorted by their default priority and always have lower priority than favorited fields.
-     * @param imodel IModelConnection.
-     * @param fields Array of Field's that needs to be sorted.
-     * @note `initializeConnection` must be called with the `imodel` before calling this function.
-     */
-    sortFields: (imodel: IModelConnection, fields: Field[]) => Field[];
-    private getFieldPriority;
-    private _getBaseClassesByClass;
-    /** Changes field properties priorities to lower than another fields priority
-     * @param imodel IModelConnection.
-     * @param field Field that priority is being changed.
-     * @param afterField Field that goes before the moved field. If undefined the moving field is changed to the highest priority (to the top).
-     * @param visibleFields Array of fields to move the field in.
-     * @note `initializeConnection` must be called with the `imodel` before calling this function.
-     */
-    changeFieldPriority(imodel: IModelConnection, field: Field, afterField: Field | undefined, visibleFields: Field[]): Promise<void>;
-}
-/** @internal */
-export declare const getFieldInfos: (field: Field) => Set<PropertyFullName>;
-/** @internal */
-export declare const createFieldOrderInfos: (field: Field) => FavoritePropertiesOrderInfo[];
+/** @packageDocumentation
+ * @module Core
+ */
+import { BeEvent, IDisposable } from "@itwin/core-bentley";
+import { IModelConnection } from "@itwin/core-frontend";
+import { Field } from "@itwin/presentation-common";
+import { IFavoritePropertiesStorage } from "./FavoritePropertiesStorage";
+/**
+ * Scopes that favorite properties can be stored in.
+ * @public
+ */
+export declare enum FavoritePropertiesScope {
+    Global = 0,
+    ITwin = 1,
+    IModel = 2
+}
+/**
+ * Format:
+ * Regular property - [{path from parent class}-]{schema name}:{class name}:{property name}.
+ * Nested property - [{path from parent class}-]{content class schema name}:{content class name}.
+ * Primitive property - {field name}.
+ * @public
+ */
+export declare type PropertyFullName = string;
+/**
+ * Holds the information of favorite properties ordering.
+ * @public
+ */
+export interface FavoritePropertiesOrderInfo {
+    parentClassName: string | undefined;
+    name: PropertyFullName;
+    priority: number;
+    orderedTimestamp: Date;
+}
+/**
+ * Properties for initializing [[FavoritePropertiesManager]]
+ * @public
+ */
+export interface FavoritePropertiesManagerProps {
+    /**
+     * Implementation of a persistence layer for storing favorite properties and their order.
+     * @public
+     */
+    storage: IFavoritePropertiesStorage;
+}
+/**
+ * The favorite property manager which lets to store favorite properties
+ * and check if field contains favorite properties.
+ *
+ * @public
+ */
+export declare class FavoritePropertiesManager implements IDisposable {
+    /**
+     * Used in tests to avoid collisions between multiple runs using the same storage
+     * @internal
+     */
+    static FAVORITES_IDENTIFIER_PREFIX: string;
+    /** Event raised after favorite properties have changed. */
+    onFavoritesChanged: BeEvent<() => void>;
+    private _storage;
+    private _globalProperties;
+    private _iTwinProperties;
+    private _imodelProperties;
+    private _imodelBaseClassesByClass;
+    /** Property order is saved only in iModel scope */
+    private _propertiesOrder;
+    constructor(props: FavoritePropertiesManagerProps);
+    dispose(): void;
+    /**
+     * Initialize favorite properties for the provided IModelConnection.
+     */
+    initializeConnection: (imodel: IModelConnection) => Promise<void>;
+    /**
+     * Function that removes order information of properties that are no longer
+     * favorited and adds missing order information for favorited properties.
+     */
+    private _adjustPropertyOrderInfos;
+    private validateInitialization;
+    /**
+     * Adds favorite properties into a certain scope.
+     * @param field Field that contains properties. If field contains multiple properties, all of them will be favorited.
+     * @param imodel IModelConnection.
+     * @param scope FavoritePropertiesScope to put the favorite properties into.
+     * @note `initializeConnection` must be called with the `imodel` before calling this function.
+     */
+    add(field: Field, imodel: IModelConnection, scope: FavoritePropertiesScope): Promise<void>;
+    /**
+     * Removes favorite properties from a scope specified and all the more general scopes.
+     * @param field Field that contains properties. If field contains multiple properties, all of them will be un-favorited.
+     * @param imodel IModelConnection.
+     * @param scope FavoritePropertiesScope to remove the favorite properties from. It also removes from more general scopes.
+     * @note `initializeConnection` must be called with the `imodel` before calling this function.
+     */
+    remove(field: Field, imodel: IModelConnection, scope: FavoritePropertiesScope): Promise<void>;
+    /**
+     * Removes all favorite properties from a certain scope.
+     * @param imodel IModelConnection.
+     * @param scope FavoritePropertiesScope to remove the favorite properties from.
+     * @note `initializeConnection` must be called with the `imodel` before calling this function.
+     */
+    clear(imodel: IModelConnection, scope: FavoritePropertiesScope): Promise<void>;
+    /**
+     * Check if field contains at least one favorite property.
+     * @param field Field that contains properties.
+     * @param imodel IModelConnection.
+     * @param scope FavoritePropertiesScope to check for favorite properties. It also checks the more general scopes.
+     * @note `initializeConnection` must be called with the `imodel` before calling this function.
+     */
+    has(field: Field, imodel: IModelConnection, scope: FavoritePropertiesScope): boolean;
+    /**
+     * Sorts an array of fields with respect to favorite property order.
+     * Non-favorited fields get sorted by their default priority and always have lower priority than favorited fields.
+     * @param imodel IModelConnection.
+     * @param fields Array of Field's that needs to be sorted.
+     * @note `initializeConnection` must be called with the `imodel` before calling this function.
+     */
+    sortFields: (imodel: IModelConnection, fields: Field[]) => Field[];
+    private getFieldPriority;
+    private _getBaseClassesByClass;
+    /** Changes field properties priorities to lower than another fields priority
+     * @param imodel IModelConnection.
+     * @param field Field that priority is being changed.
+     * @param afterField Field that goes before the moved field. If undefined the moving field is changed to the highest priority (to the top).
+     * @param visibleFields Array of fields to move the field in.
+     * @note `initializeConnection` must be called with the `imodel` before calling this function.
+     */
+    changeFieldPriority(imodel: IModelConnection, field: Field, afterField: Field | undefined, visibleFields: Field[]): Promise<void>;
+}
+/** @internal */
+export declare const getFieldInfos: (field: Field) => Set<PropertyFullName>;
+/** @internal */
+export declare const createFieldOrderInfos: (field: Field) => FavoritePropertiesOrderInfo[];
 //# sourceMappingURL=FavoritePropertiesManager.d.ts.map