@itwin/unified-selection 1.4.3-alpha.0 → 1.5.0

package/CHANGELOG.md

@@ -1,18 +1,42 @@
 # @itwin/unified-selection
 
-## 1.4.3-alpha.0
+## 1.5.0
 
-### Patch Changes
+### Minor Changes
 
-- Updated dependencies:
-  - @itwin/presentation-shared@2.0.0-alpha.1
+- [#1018](https://github.com/iTwin/presentation/pull/1018): Fixed `enableUnifiedSelectionSyncWithIModel` not using (and not being able to use) the underlying hilite set provider of the given custom `CachingHiliteSetProvider`, causing selection synchronization to work incorrectly in cases when items were added or removed to iModel's selection set.
 
-## 1.4.2-alpha.0
+  - Introduced `IModelHiliteSetProvider` interface and a factory function `createIModelHiliteSetProvider` that creates an instance of it. Functionality-wise these are very similar to `CachingHiliteSetProvider` and `createCachingHiliteSetProvider` but the new type provides access to the underlying hilite set provider of the given iModel. And the naming better represents the purpose of the type.
+  - Deprecated `CachingHiliteSetProvider` and `createCachingHiliteSetProvider` in favor of the above.
+  - For the `enableUnifiedSelectionSyncWithIModel` function, deprecated the `cachingHiliteSetProvider` prop in favor of the newly added `imodelHiliteSetProvider`.
 
-### Patch Changes
+  The migration is straightforward:
 
-- Updated dependencies:
-  - @itwin/presentation-shared@2.0.0-alpha.0
+  ```typescript
+  // before:
+  enableUnifiedSelectionSyncWithIModel({
+    imodelAccess,
+    selectionStorage,
+    activeScopeProvider,
+    cachingHiliteSetProvider: createCachingHiliteSetProvider({
+      selectionStorage,
+      imodelProvider: () => imodelAccess,
+      createHiliteSetProvider: () => createMyCustomHiliteSetProvider({ imodelAccess }),
+    }),
+  });
+
+  // after:
+  enableUnifiedSelectionSyncWithIModel({
+    imodelAccess,
+    selectionStorage,
+    activeScopeProvider,
+    imodelHiliteSetProvider: createIModelHiliteSetProvider({
+      selectionStorage,
+      imodelProvider: () => imodelAccess,
+      createHiliteSetProvider: () => createMyCustomHiliteSetProvider({ imodelAccess }),
+    }),
+  });
+  ```
 
 ## 1.4.2
 

package/lib/cjs/unified-selection/CachingHiliteSetProvider.d.ts

@@ -5,6 +5,7 @@ import { SelectionStorage } from "./SelectionStorage.js";
 /**
  * Props for creating a `CachingHiliteSetProvider` instance.
  * @public
+ * @deprecated in 1.5. Use `IModelHiliteSetProviderProps` instead.
  */
 export interface CachingHiliteSetProviderProps {
     /** Selection storage to use for retrieving the hilite set. */
@@ -22,6 +23,7 @@ export interface CachingHiliteSetProviderProps {
  *
  * @see `createCachingHiliteSetProvider`
  * @public
+ * @deprecated in 1.5. Use `IModelHiliteSetProvider` instead.
  */
 export interface CachingHiliteSetProvider {
     /** Get the current hilite set iterator for the specified imodel */
@@ -46,6 +48,7 @@ export interface CachingHiliteSetProvider {
  * Creates a hilite set provider that caches hilite set for current selection for given iModel so any subsequent
  * hilite set requests for the same iModel don't cost until selection in given selection storage changes.
  * @public
+ * @deprecated in 1.5. Use `createIModelHiliteSetProvider` instead.
  */
 export declare function createCachingHiliteSetProvider(props: CachingHiliteSetProviderProps): CachingHiliteSetProvider & {
     [Symbol.dispose]: () => void;

package/lib/cjs/unified-selection/CachingHiliteSetProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CachingHiliteSetProvider.d.ts","sourceRoot":"","sources":["../../../src/unified-selection/CachingHiliteSetProvider.ts"],"names":[],"mappings":"AAKA,OAAO,sBAAsB,CAAC;AAG9B,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAC3F,OAAO,EAAE,uBAAuB,EAAE,SAAS,EAAqB,MAAM,wBAAwB,CAAC;AAE/F,OAAO,EAAuC,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAE9F;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC5C,8DAA8D;IAC9D,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC,iEAAiE;IACjE,cAAc,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,yBAAyB,GAAG,kBAAkB,CAAC;IAEtF,yHAAyH;IACzH,uBAAuB,CAAC,EAAE,OAAO,uBAAuB,CAAC;CAC1D;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,wBAAwB;IACvC,mEAAmE;IACnE,YAAY,CAAC,KAAK,EAAE;QAClB,mCAAmC;QACnC,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,qBAAqB,CAAC,SAAS,CAAC,CAAC;IAErC;;;;;OAKG;IACH,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,IAAI,CAAC;IAE9B;;;OAGG;IACH,OAAO,IAAI,IAAI,CAAC;CACjB;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,CAAC,KAAK,EAAE,6BAA6B,GAAG,wBAAwB,GAAG;IAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,IAAI,CAAA;CAAE,CAEhJ"}
+{"version":3,"file":"CachingHiliteSetProvider.d.ts","sourceRoot":"","sources":["../../../src/unified-selection/CachingHiliteSetProvider.ts"],"names":[],"mappings":"AAMA,OAAO,sBAAsB,CAAC;AAC9B,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAC3F,OAAO,EAAE,uBAAuB,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAE5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC5C,8DAA8D;IAC9D,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC,iEAAiE;IACjE,cAAc,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,yBAAyB,GAAG,kBAAkB,CAAC;IAEtF,yHAAyH;IACzH,uBAAuB,CAAC,EAAE,OAAO,uBAAuB,CAAC;CAC1D;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,wBAAwB;IACvC,mEAAmE;IACnE,YAAY,CAAC,KAAK,EAAE;QAClB,mCAAmC;QACnC,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,qBAAqB,CAAC,SAAS,CAAC,CAAC;IAErC;;;;;OAKG;IACH,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,IAAI,CAAC;IAE9B;;;OAGG;IACH,OAAO,IAAI,IAAI,CAAC;CACjB;AAED;;;;;GAKG;AAEH,wBAAgB,8BAA8B,CAAC,KAAK,EAAE,6BAA6B,GAAG,wBAAwB,GAAG;IAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,IAAI,CAAA;CAAE,CAOhJ"}

package/lib/cjs/unified-selection/CachingHiliteSetProvider.js

@@ -3,66 +3,25 @@
  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
+/* eslint-disable @typescript-eslint/no-deprecated */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createCachingHiliteSetProvider = createCachingHiliteSetProvider;
 require("./DisposePolyfill.js");
-const rxjs_1 = require("rxjs");
-const rxjs_for_await_1 = require("rxjs-for-await");
-const HiliteSetProvider_js_1 = require("./HiliteSetProvider.js");
-const SelectionStorage_js_1 = require("./SelectionStorage.js");
+const IModelHiliteSetProvider_js_1 = require("./IModelHiliteSetProvider.js");
 /**
  * Creates a hilite set provider that caches hilite set for current selection for given iModel so any subsequent
  * hilite set requests for the same iModel don't cost until selection in given selection storage changes.
  * @public
+ * @deprecated in 1.5. Use `createIModelHiliteSetProvider` instead.
  */
+/* c8 ignore start */
 function createCachingHiliteSetProvider(props) {
-    return new CachingHiliteSetProviderImpl(props);
-}
-class CachingHiliteSetProviderImpl {
-    _selectionStorage;
-    _hiliteSetProviders = new Map();
-    _cache = new Map();
-    _removeListener;
-    _imodelProvider;
-    _createHiliteSetProvider;
-    constructor(props) {
-        this._selectionStorage = props.selectionStorage;
-        this._imodelProvider = props.imodelProvider;
-        this._removeListener = this._selectionStorage.selectionChangeEvent.addListener((args) => {
-            this._cache.delete(args.imodelKey);
-            if (args.changeType === "clear" && args.source === SelectionStorage_js_1.IMODEL_CLOSE_SELECTION_CLEAR_SOURCE) {
-                this._hiliteSetProviders.delete(args.imodelKey);
-            }
-        });
-        this._createHiliteSetProvider = props.createHiliteSetProvider ?? /* c8 ignore next */ HiliteSetProvider_js_1.createHiliteSetProvider;
-    }
-    getHiliteSet({ imodelKey }) {
-        const imodelAccess = this._imodelProvider(imodelKey);
-        const provider = this.getHiliteSetProvider(imodelKey, imodelAccess);
-        let hiliteSet = this._cache.get(imodelKey);
-        if (!hiliteSet) {
-            const selectables = this._selectionStorage.getSelection({ imodelKey });
-            hiliteSet = (0, rxjs_1.from)(provider.getHiliteSet({ selectables })).pipe((0, rxjs_1.shareReplay)({ refCount: true }));
-            this._cache.set(imodelKey, hiliteSet);
-        }
-        return (0, rxjs_for_await_1.eachValueFrom)(hiliteSet);
-    }
-    [Symbol.dispose]() {
-        this._removeListener();
-        this._hiliteSetProviders = new Map();
-        this._cache = new Map();
-    }
-    /* c8 ignore next 3 */
-    dispose() {
-        this[Symbol.dispose]();
-    }
-    getHiliteSetProvider(imodelKey, imodelAccess) {
-        let provider = this._hiliteSetProviders.get(imodelKey);
-        if (!provider) {
-            provider = this._createHiliteSetProvider({ imodelAccess });
-            this._hiliteSetProviders.set(imodelKey, provider);
-        }
-        return provider;
-    }
+    const provider = (0, IModelHiliteSetProvider_js_1.createIModelHiliteSetProvider)(props);
+    return {
+        getHiliteSet: (hiliteSetProps) => provider.getCurrentHiliteSet(hiliteSetProps),
+        [Symbol.dispose]: () => provider[Symbol.dispose](),
+        dispose: () => provider[Symbol.dispose](),
+    };
 }
+/* c8 ignore end */
 //# sourceMappingURL=CachingHiliteSetProvider.js.map

package/lib/cjs/unified-selection/CachingHiliteSetProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"CachingHiliteSetProvider.js","sourceRoot":"","sources":["../../../src/unified-selection/CachingHiliteSetProvider.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;AA6DhG,wEAEC;AA7DD,gCAA8B;AAC9B,+BAAqD;AACrD,mDAA+C;AAE/C,iEAA+F;AAE/F,+DAA8F;AAgD9F;;;;GAIG;AACH,SAAgB,8BAA8B,CAAC,KAAoC;IACjF,OAAO,IAAI,4BAA4B,CAAC,KAAK,CAAC,CAAC;AACjD,CAAC;AAED,MAAM,4BAA4B;IACxB,iBAAiB,CAAmB;IACpC,mBAAmB,GAAG,IAAI,GAAG,EAA6B,CAAC;IAC3D,MAAM,GAAG,IAAI,GAAG,EAAiC,CAAC;IAClD,eAAe,CAAa;IAC5B,eAAe,CAAwE;IACvF,wBAAwB,CAAiC;IAEjE,YAAY,KAAoC;QAC9C,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAChD,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,cAAc,CAAC;QAC5C,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC,IAAqC,EAAE,EAAE;YACvH,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACnC,IAAI,IAAI,CAAC,UAAU,KAAK,OAAO,IAAI,IAAI,CAAC,MAAM,KAAK,yDAAmC,EAAE,CAAC;gBACvF,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAClD,CAAC;QACH,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,wBAAwB,GAAG,KAAK,CAAC,uBAAuB,IAAI,oBAAoB,CAAC,8CAAuB,CAAC;IAChH,CAAC;IAEM,YAAY,CAAC,EAAE,SAAS,EAAyB;QACtD,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;QACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,oBAAoB,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QACpE,IAAI,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAE3C,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,WAAW,GAAG,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;YACvE,SAAS,GAAG,IAAA,WAAI,EAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAA,kBAAW,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YAC/F,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACxC,CAAC;QAED,OAAO,IAAA,8BAAa,EAAC,SAAS,CAAC,CAAC;IAClC,CAAC;IAEM,CAAC,MAAM,CAAC,OAAO,CAAC;QACrB,IAAI,CAAC,eAAe,EAAE,CAAC;QACvB,IAAI,CAAC,mBAAmB,GAAG,IAAI,GAAG,EAAE,CAAC;QACrC,IAAI,CAAC,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;IAC1B,CAAC;IAED,sBAAsB;IACf,OAAO;QACZ,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IACzB,CAAC;IAEO,oBAAoB,CAAC,SAAiB,EAAE,YAA4D;QAC1G,IAAI,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACvD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,QAAQ,GAAG,IAAI,CAAC,wBAAwB,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;YAC3D,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,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\nimport \"./DisposePolyfill.js\";\nimport { from, Observable, shareReplay } from \"rxjs\";\nimport { eachValueFrom } from \"rxjs-for-await\";\nimport { ECClassHierarchyInspector, ECSqlQueryExecutor } from \"@itwin/presentation-shared\";\nimport { createHiliteSetProvider, HiliteSet, HiliteSetProvider } from \"./HiliteSetProvider.js\";\nimport { StorageSelectionChangeEventArgs } from \"./SelectionChangeEvent.js\";\nimport { IMODEL_CLOSE_SELECTION_CLEAR_SOURCE, SelectionStorage } from \"./SelectionStorage.js\";\n\n/**\n * Props for creating a `CachingHiliteSetProvider` instance.\n * @public\n */\nexport interface CachingHiliteSetProviderProps {\n  /** Selection storage to use for retrieving the hilite set. */\n  selectionStorage: SelectionStorage;\n\n  /** A callback that should return iModel access by iModel key. */\n  imodelProvider: (imodelKey: string) => ECClassHierarchyInspector & ECSqlQueryExecutor;\n\n  /** An optional hilite set provider factory. If not provided, defaults to `createHiliteSetProvider` from this package. */\n  createHiliteSetProvider?: typeof createHiliteSetProvider;\n}\n\n/**\n * Defines return value of `createCachingHiliteSetProvider`.\n *\n * **Warning:** Used in public API as a return value. Not expected to be created / extended by package\n * consumers, may be supplemented with required attributes any time.\n *\n * @see `createCachingHiliteSetProvider`\n * @public\n */\nexport interface CachingHiliteSetProvider {\n  /** Get the current hilite set iterator for the specified imodel */\n  getHiliteSet(props: {\n    /** iModel to get hilite set for */\n    imodelKey: string;\n  }): AsyncIterableIterator<HiliteSet>;\n\n  /**\n   * Disposes the cache.\n   *\n   * Optional to avoid breaking the API. Will be made required when the deprecated\n   * `dispose` is removed.\n   */\n  [Symbol.dispose]?: () => void;\n\n  /**\n   * Disposes the cache.\n   * @deprecated in 1.2. Use `[Symbol.dispose]` instead.\n   */\n  dispose(): void;\n}\n\n/**\n * Creates a hilite set provider that caches hilite set for current selection for given iModel so any subsequent\n * hilite set requests for the same iModel don't cost until selection in given selection storage changes.\n * @public\n */\nexport function createCachingHiliteSetProvider(props: CachingHiliteSetProviderProps): CachingHiliteSetProvider & { [Symbol.dispose]: () => void } {\n  return new CachingHiliteSetProviderImpl(props);\n}\n\nclass CachingHiliteSetProviderImpl implements CachingHiliteSetProvider {\n  private _selectionStorage: SelectionStorage;\n  private _hiliteSetProviders = new Map<string, HiliteSetProvider>();\n  private _cache = new Map<string, Observable<HiliteSet>>();\n  private _removeListener: () => void;\n  private _imodelProvider: (imodelKey: string) => ECClassHierarchyInspector & ECSqlQueryExecutor;\n  private _createHiliteSetProvider: typeof createHiliteSetProvider;\n\n  constructor(props: CachingHiliteSetProviderProps) {\n    this._selectionStorage = props.selectionStorage;\n    this._imodelProvider = props.imodelProvider;\n    this._removeListener = this._selectionStorage.selectionChangeEvent.addListener((args: StorageSelectionChangeEventArgs) => {\n      this._cache.delete(args.imodelKey);\n      if (args.changeType === \"clear\" && args.source === IMODEL_CLOSE_SELECTION_CLEAR_SOURCE) {\n        this._hiliteSetProviders.delete(args.imodelKey);\n      }\n    });\n    this._createHiliteSetProvider = props.createHiliteSetProvider ?? /* c8 ignore next */ createHiliteSetProvider;\n  }\n\n  public getHiliteSet({ imodelKey }: { imodelKey: string }): AsyncIterableIterator<HiliteSet> {\n    const imodelAccess = this._imodelProvider(imodelKey);\n    const provider = this.getHiliteSetProvider(imodelKey, imodelAccess);\n    let hiliteSet = this._cache.get(imodelKey);\n\n    if (!hiliteSet) {\n      const selectables = this._selectionStorage.getSelection({ imodelKey });\n      hiliteSet = from(provider.getHiliteSet({ selectables })).pipe(shareReplay({ refCount: true }));\n      this._cache.set(imodelKey, hiliteSet);\n    }\n\n    return eachValueFrom(hiliteSet);\n  }\n\n  public [Symbol.dispose](): void {\n    this._removeListener();\n    this._hiliteSetProviders = new Map();\n    this._cache = new Map();\n  }\n\n  /* c8 ignore next 3 */\n  public dispose(): void {\n    this[Symbol.dispose]();\n  }\n\n  private getHiliteSetProvider(imodelKey: string, imodelAccess: ECClassHierarchyInspector & ECSqlQueryExecutor) {\n    let provider = this._hiliteSetProviders.get(imodelKey);\n    if (!provider) {\n      provider = this._createHiliteSetProvider({ imodelAccess });\n      this._hiliteSetProviders.set(imodelKey, provider);\n    }\n    return provider;\n  }\n}\n"]}
+{"version":3,"file":"CachingHiliteSetProvider.js","sourceRoot":"","sources":["../../../src/unified-selection/CachingHiliteSetProvider.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAChG,qDAAqD;;AA+DrD,wEAOC;AApED,gCAA8B;AAG9B,6EAA6E;AAmD7E;;;;;GAKG;AACH,qBAAqB;AACrB,SAAgB,8BAA8B,CAAC,KAAoC;IACjF,MAAM,QAAQ,GAAG,IAAA,0DAA6B,EAAC,KAAK,CAAC,CAAC;IACtD,OAAO;QACL,YAAY,EAAE,CAAC,cAAqC,EAAE,EAAE,CAAC,QAAQ,CAAC,mBAAmB,CAAC,cAAc,CAAC;QACrG,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;QAClD,OAAO,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;KAC1C,CAAC;AACJ,CAAC;AACD,mBAAmB","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/* eslint-disable @typescript-eslint/no-deprecated */\n\nimport \"./DisposePolyfill.js\";\nimport { ECClassHierarchyInspector, ECSqlQueryExecutor } from \"@itwin/presentation-shared\";\nimport { createHiliteSetProvider, HiliteSet } from \"./HiliteSetProvider.js\";\nimport { createIModelHiliteSetProvider } from \"./IModelHiliteSetProvider.js\";\nimport { SelectionStorage } from \"./SelectionStorage.js\";\n\n/**\n * Props for creating a `CachingHiliteSetProvider` instance.\n * @public\n * @deprecated in 1.5. Use `IModelHiliteSetProviderProps` instead.\n */\nexport interface CachingHiliteSetProviderProps {\n  /** Selection storage to use for retrieving the hilite set. */\n  selectionStorage: SelectionStorage;\n\n  /** A callback that should return iModel access by iModel key. */\n  imodelProvider: (imodelKey: string) => ECClassHierarchyInspector & ECSqlQueryExecutor;\n\n  /** An optional hilite set provider factory. If not provided, defaults to `createHiliteSetProvider` from this package. */\n  createHiliteSetProvider?: typeof createHiliteSetProvider;\n}\n\n/**\n * Defines return value of `createCachingHiliteSetProvider`.\n *\n * **Warning:** Used in public API as a return value. Not expected to be created / extended by package\n * consumers, may be supplemented with required attributes any time.\n *\n * @see `createCachingHiliteSetProvider`\n * @public\n * @deprecated in 1.5. Use `IModelHiliteSetProvider` instead.\n */\nexport interface CachingHiliteSetProvider {\n  /** Get the current hilite set iterator for the specified imodel */\n  getHiliteSet(props: {\n    /** iModel to get hilite set for */\n    imodelKey: string;\n  }): AsyncIterableIterator<HiliteSet>;\n\n  /**\n   * Disposes the cache.\n   *\n   * Optional to avoid breaking the API. Will be made required when the deprecated\n   * `dispose` is removed.\n   */\n  [Symbol.dispose]?: () => void;\n\n  /**\n   * Disposes the cache.\n   * @deprecated in 1.2. Use `[Symbol.dispose]` instead.\n   */\n  dispose(): void;\n}\n\n/**\n * Creates a hilite set provider that caches hilite set for current selection for given iModel so any subsequent\n * hilite set requests for the same iModel don't cost until selection in given selection storage changes.\n * @public\n * @deprecated in 1.5. Use `createIModelHiliteSetProvider` instead.\n */\n/* c8 ignore start */\nexport function createCachingHiliteSetProvider(props: CachingHiliteSetProviderProps): CachingHiliteSetProvider & { [Symbol.dispose]: () => void } {\n  const provider = createIModelHiliteSetProvider(props);\n  return {\n    getHiliteSet: (hiliteSetProps: { imodelKey: string }) => provider.getCurrentHiliteSet(hiliteSetProps),\n    [Symbol.dispose]: () => provider[Symbol.dispose](),\n    dispose: () => provider[Symbol.dispose](),\n  };\n}\n/* c8 ignore end */\n"]}

package/lib/cjs/unified-selection/EnableUnifiedSelectionSyncWithIModel.d.ts

@@ -2,6 +2,7 @@ import "./DisposePolyfill.js";
 import { ECClassHierarchyInspector, ECSqlQueryExecutor } from "@itwin/presentation-shared";
 import { CachingHiliteSetProvider } from "./CachingHiliteSetProvider.js";
 import { HiliteSetProvider } from "./HiliteSetProvider.js";
+import { IModelHiliteSetProvider } from "./IModelHiliteSetProvider.js";
 import { SelectionScope } from "./SelectionScope.js";
 import { SelectionStorage } from "./SelectionStorage.js";
 import { CoreIModelHiliteSet, CoreIModelSelectionSet } from "./types/IModel.js";
@@ -47,6 +48,15 @@ export interface EnableUnifiedSelectionSyncWithIModelProps {
     selectionStorage: SelectionStorage;
     /** Active selection scope provider. */
     activeScopeProvider: () => SelectionScope;
+    /**
+     * An iModel hilite set provider used to retrieve hilite sets for different iModels. If not provided, a new `IModelHiliteSetProvider`
+     * will be created for the given iModel using the provided `imodelAccess`.
+     * If the consuming application already has a `IModelHiliteSetProvider` defined, it should be provided instead
+     * to reuse the cache and avoid creating new providers for each iModel.
+     *
+     * @see `createIModelHiliteSetProvider`
+     */
+    imodelHiliteSetProvider?: IModelHiliteSetProvider;
     /**
      * A caching hilite set provider used to retrieve hilite sets for an iModel. If not provided, a new `CachingHiliteSetProvider`
      * will be created for the given iModel using the provided `imodelAccess`.
@@ -55,6 +65,12 @@ export interface EnableUnifiedSelectionSyncWithIModelProps {
      *
      * The type is defined in a way that makes it required for provider to have either the deprecated `dispose` or the
      * new `Symbol.dispose` method.
+     *
+     * **Warning:** When the given `CachingHiliteSetProvider` internally uses a custom `HiliteSetProvider`, the synchronization has
+     * no access to it, and thus uses its own, default, `HiliteSetProvider`. As a result, the synchronization may not work as expected.
+     * To alleviate this, the `imodelHiliteSetProvider` prop should be used instead.
+     *
+     * @deprecated in 1.5. Use `imodelHiliteSetProvider` prop instead.
      */
     cachingHiliteSetProvider?: CachingHiliteSetProvider | (Omit<CachingHiliteSetProvider, "dispose"> & {
         [Symbol.dispose]: () => void;
@@ -76,14 +92,13 @@ export declare class IModelSelectionHandler {
     private _selectionSourceName;
     private _imodelAccess;
     private _selectionStorage;
-    private _hiliteSetProvider;
-    private _cachingHiliteSetProvider;
+    private _imodelHiliteSetProvider;
     private _activeScopeProvider;
     private _isSuspended;
     private _cancelOngoingChanges;
     private _unregisterUnifiedSelectionListener;
     private _unregisterIModelSelectionSetListener;
-    private _hasCustomCachingHiliteSetProvider;
+    private _disposeInternalHiliteSetProvider;
     constructor(props: EnableUnifiedSelectionSyncWithIModelProps & {
         hiliteSetProvider?: HiliteSetProvider;
     });

package/lib/cjs/unified-selection/EnableUnifiedSelectionSyncWithIModel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"EnableUnifiedSelectionSyncWithIModel.d.ts","sourceRoot":"","sources":["../../../src/unified-selection/EnableUnifiedSelectionSyncWithIModel.ts"],"names":[],"mappings":"AAKA,OAAO,sBAAsB,CAAC;AAG9B,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAC3F,OAAO,EAAE,wBAAwB,EAAkC,MAAM,+BAA+B,CAAC;AACzG,OAAO,EAAsC,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAG/F,OAAO,EAAoB,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,sBAAsB,EAA6E,MAAM,mBAAmB,CAAC;AAG3J;;;GAGG;AACH,MAAM,WAAW,yCAAyC;IACxD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,YAAY,EAAE,kBAAkB,GAC9B,yBAAyB,GAAG;QAC1B,sEAAsE;QACtE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;QACrB,mFAAmF;QACnF,QAAQ,CAAC,SAAS,EAAE,mBAAmB,CAAC;QACxC,yFAAyF;QACzF,QAAQ,CAAC,YAAY,EAAE,sBAAsB,CAAC;KAC/C,CAAC;IAEJ;;;OAGG;IACH,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC,uCAAuC;IACvC,mBAAmB,EAAE,MAAM,cAAc,CAAC;IAE1C;;;;;;;;OAQG;IACH,wBAAwB,CAAC,EAAE,wBAAwB,GAAG,CAAC,IAAI,CAAC,wBAAwB,EAAE,SAAS,CAAC,GAAG;QAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,IAAI,CAAA;KAAE,CAAC,CAAC;CACtI;AAED;;;;GAIG;AACH,wBAAgB,oCAAoC,CAAC,KAAK,EAAE,yCAAyC,GAAG,MAAM,IAAI,CAGjH;AAED;;;;;GAKG;AACH,qBAAa,sBAAsB;IACjC,OAAO,CAAC,oBAAoB,CAAU;IAEtC,OAAO,CAAC,aAAa,CAA4D;IACjF,OAAO,CAAC,iBAAiB,CAAmB;IAC5C,OAAO,CAAC,kBAAkB,CAAoB;IAC9C,OAAO,CAAC,yBAAyB,CAAqF;IACtH,OAAO,CAAC,oBAAoB,CAAuB;IAEnD,OAAO,CAAC,YAAY,CAAU;IAC9B,OAAO,CAAC,qBAAqB,CAAuB;IACpD,OAAO,CAAC,mCAAmC,CAAa;IACxD,OAAO,CAAC,qCAAqC,CAAa;IAC1D,OAAO,CAAC,kCAAkC,CAAU;gBAEjC,KAAK,EAAE,yCAAyC,GAAG;QAAE,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;KAAE;IA0BxG,CAAC,MAAM,CAAC,OAAO,CAAC;IAUvB,4GAA4G;IACrG,8BAA8B;;;IAUrC,OAAO,CAAC,4BAA4B;IAsCpC,OAAO,CAAC,yBAAyB,CAU/B;IAEF,OAAO,CAAC,qBAAqB;IAoB7B,OAAO,CAAC,YAAY;IAwBpB,OAAO,CAAC,eAAe;IAuBvB,OAAO,CAAC,wBAAwB,CAmB9B;YAEY,2BAA2B;IAiBzC,OAAO,CAAC,wBAAwB;CAcjC"}
+{"version":3,"file":"EnableUnifiedSelectionSyncWithIModel.d.ts","sourceRoot":"","sources":["../../../src/unified-selection/EnableUnifiedSelectionSyncWithIModel.ts"],"names":[],"mappings":"AAKA,OAAO,sBAAsB,CAAC;AAG9B,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAC3F,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAAsC,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC/F,OAAO,EAAiC,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAGtG,OAAO,EAAoB,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,sBAAsB,EAA6E,MAAM,mBAAmB,CAAC;AAG3J;;;GAGG;AACH,MAAM,WAAW,yCAAyC;IACxD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,YAAY,EAAE,kBAAkB,GAC9B,yBAAyB,GAAG;QAC1B,sEAAsE;QACtE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;QACrB,mFAAmF;QACnF,QAAQ,CAAC,SAAS,EAAE,mBAAmB,CAAC;QACxC,yFAAyF;QACzF,QAAQ,CAAC,YAAY,EAAE,sBAAsB,CAAC;KAC/C,CAAC;IAEJ;;;OAGG;IACH,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC,uCAAuC;IACvC,mBAAmB,EAAE,MAAM,cAAc,CAAC;IAE1C;;;;;;;OAOG;IACH,uBAAuB,CAAC,EAAE,uBAAuB,CAAC;IAElD;;;;;;;;;;;;;;OAcG;IAEH,wBAAwB,CAAC,EAAE,wBAAwB,GAAG,CAAC,IAAI,CAAC,wBAAwB,EAAE,SAAS,CAAC,GAAG;QAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,IAAI,CAAA;KAAE,CAAC,CAAC;CACtI;AAED;;;;GAIG;AACH,wBAAgB,oCAAoC,CAAC,KAAK,EAAE,yCAAyC,GAAG,MAAM,IAAI,CAGjH;AAED;;;;;GAKG;AACH,qBAAa,sBAAsB;IACjC,OAAO,CAAC,oBAAoB,CAAU;IAEtC,OAAO,CAAC,aAAa,CAA4D;IACjF,OAAO,CAAC,iBAAiB,CAAmB;IAC5C,OAAO,CAAC,wBAAwB,CAAoF;IACpH,OAAO,CAAC,oBAAoB,CAAuB;IAEnD,OAAO,CAAC,YAAY,CAAU;IAC9B,OAAO,CAAC,qBAAqB,CAAuB;IACpD,OAAO,CAAC,mCAAmC,CAAa;IACxD,OAAO,CAAC,qCAAqC,CAAa;IAC1D,OAAO,CAAC,iCAAiC,CAAa;gBAEnC,KAAK,EAAE,yCAAyC,GAAG;QAAE,iBAAiB,CAAC,EAAE,iBAAiB,CAAA;KAAE;IA4CxG,CAAC,MAAM,CAAC,OAAO,CAAC;IAOvB,4GAA4G;IACrG,8BAA8B;;;IAUrC,OAAO,CAAC,4BAA4B;IAsCpC,OAAO,CAAC,yBAAyB,CAU/B;IAEF,OAAO,CAAC,qBAAqB;IAoB7B,OAAO,CAAC,YAAY;IAwBpB,OAAO,CAAC,eAAe;IAuBvB,OAAO,CAAC,wBAAwB,CAmB9B;YAEY,2BAA2B;IAiBzC,OAAO,CAAC,wBAAwB;CAcjC"}

package/lib/cjs/unified-selection/EnableUnifiedSelectionSyncWithIModel.js

@@ -60,8 +60,8 @@ exports.IModelSelectionHandler = void 0;
 exports.enableUnifiedSelectionSyncWithIModel = enableUnifiedSelectionSyncWithIModel;
 require("./DisposePolyfill.js");
 const rxjs_1 = require("rxjs");
-const CachingHiliteSetProvider_js_1 = require("./CachingHiliteSetProvider.js");
 const HiliteSetProvider_js_1 = require("./HiliteSetProvider.js");
+const IModelHiliteSetProvider_js_1 = require("./IModelHiliteSetProvider.js");
 const SelectionScope_js_1 = require("./SelectionScope.js");
 const IModel_js_1 = require("./types/IModel.js");
 const Utils_js_1 = require("./Utils.js");
@@ -84,28 +84,42 @@ class IModelSelectionHandler {
     _selectionSourceName = "Tool";
     _imodelAccess;
     _selectionStorage;
-    _hiliteSetProvider;
-    _cachingHiliteSetProvider;
+    _imodelHiliteSetProvider;
     _activeScopeProvider;
     _isSuspended;
     _cancelOngoingChanges = new rxjs_1.Subject();
     _unregisterUnifiedSelectionListener;
     _unregisterIModelSelectionSetListener;
-    _hasCustomCachingHiliteSetProvider;
+    _disposeInternalHiliteSetProvider;
     constructor(props) {
         this._imodelAccess = props.imodelAccess;
         this._selectionStorage = props.selectionStorage;
         this._activeScopeProvider = props.activeScopeProvider;
         this._isSuspended = false;
-        this._hiliteSetProvider = props.hiliteSetProvider ?? (0, HiliteSetProvider_js_1.createHiliteSetProvider)({ imodelAccess: this._imodelAccess });
-        this._hasCustomCachingHiliteSetProvider = !!props.cachingHiliteSetProvider;
-        this._cachingHiliteSetProvider =
-            props.cachingHiliteSetProvider /* c8 ignore next */ ??
-                /* c8 ignore next 4 */ (0, CachingHiliteSetProvider_js_1.createCachingHiliteSetProvider)({
-                    selectionStorage: this._selectionStorage,
-                    imodelProvider: () => this._imodelAccess,
-                    createHiliteSetProvider: () => this._hiliteSetProvider,
-                });
+        [this._imodelHiliteSetProvider, this._disposeInternalHiliteSetProvider] = (() => {
+            if (props.imodelHiliteSetProvider) {
+                return [props.imodelHiliteSetProvider, () => { }];
+            }
+            // eslint-disable-next-line @typescript-eslint/no-deprecated
+            if (props.cachingHiliteSetProvider) {
+                return [
+                    createIModelHiliteSetProviderFromCachingProvider(
+                    // eslint-disable-next-line @typescript-eslint/no-deprecated
+                    props.cachingHiliteSetProvider, props.hiliteSetProvider ?? (0, HiliteSetProvider_js_1.createHiliteSetProvider)({ imodelAccess: props.imodelAccess })),
+                    // don't need to dispose anything, because our wrapper has no dispose logic, and `cachingHiliteSetProvider` should be disposed
+                    // by whoever owns it
+                    () => { },
+                ];
+            }
+            /* c8 ignore start */
+            const internalProvider = (0, IModelHiliteSetProvider_js_1.createIModelHiliteSetProvider)({
+                selectionStorage: this._selectionStorage,
+                imodelProvider: () => this._imodelAccess,
+                createHiliteSetProvider: () => props.hiliteSetProvider ?? (0, HiliteSetProvider_js_1.createHiliteSetProvider)({ imodelAccess: props.imodelAccess }),
+            });
+            return [internalProvider, () => (0, Utils_js_1.safeDispose)(internalProvider)];
+            /* c8 ignore end */
+        })();
         this._unregisterIModelSelectionSetListener = this._imodelAccess.selectionSet.onChanged.addListener(this.onIModelSelectionChanged);
         this._unregisterUnifiedSelectionListener = this._selectionStorage.selectionChangeEvent.addListener(this.onUnifiedSelectionChanged);
         if (!is5xSelectionSet(this._imodelAccess.selectionSet)) {
@@ -118,10 +132,7 @@ class IModelSelectionHandler {
         this._cancelOngoingChanges.next();
         this._unregisterIModelSelectionSetListener();
         this._unregisterUnifiedSelectionListener();
-        /* c8 ignore next 3 */
-        if (!this._hasCustomCachingHiliteSetProvider) {
-            (0, Utils_js_1.safeDispose)(this._cachingHiliteSetProvider);
-        }
+        this._disposeInternalHiliteSetProvider();
     }
     /** Temporarily suspends tool selection synchronization until the returned disposable object is disposed. */
     suspendIModelToolSelectionSync() {
@@ -149,7 +160,7 @@ class IModelSelectionHandler {
                             "clearAll",
                 });
             case "add":
-                return void (0, rxjs_1.from)(this._hiliteSetProvider.getHiliteSet({ selectables }))
+                return void (0, rxjs_1.from)(this._imodelHiliteSetProvider.getHiliteSetProvider({ imodelKey: this._imodelAccess.key }).getHiliteSet({ selectables }))
                     .pipe((0, rxjs_1.takeUntil)(this._cancelOngoingChanges))
                     .subscribe({
                     next: (set) => {
@@ -157,7 +168,7 @@ class IModelSelectionHandler {
                     },
                 });
             case "remove":
-                return void (0, rxjs_1.from)(this._hiliteSetProvider.getHiliteSet({ selectables }))
+                return void (0, rxjs_1.from)(this._imodelHiliteSetProvider.getHiliteSetProvider({ imodelKey: this._imodelAccess.key }).getHiliteSet({ selectables }))
                     .pipe((0, rxjs_1.takeUntil)(this._cancelOngoingChanges))
                     .subscribe({
                     next: (set) => {
@@ -199,7 +210,7 @@ class IModelSelectionHandler {
                 __disposeResources(env_1);
             }
         }
-        (0, rxjs_1.from)(this._cachingHiliteSetProvider.getHiliteSet({ imodelKey: this._imodelAccess.key }))
+        (0, rxjs_1.from)(this._imodelHiliteSetProvider.getCurrentHiliteSet({ imodelKey: this._imodelAccess.key }))
             .pipe((0, rxjs_1.takeUntil)(this._cancelOngoingChanges))
             .subscribe({
             next: (ids) => {
@@ -319,4 +330,13 @@ exports.IModelSelectionHandler = IModelSelectionHandler;
 function is5xSelectionSet(selectionSet) {
     return "active" in selectionSet;
 }
+/* c8 ignore start */
+function createIModelHiliteSetProviderFromCachingProvider(cachingHiliteSetProvider, hiliteSetProvider) {
+    return {
+        getHiliteSetProvider: () => hiliteSetProvider,
+        getCurrentHiliteSet: (props) => cachingHiliteSetProvider.getHiliteSet(props),
+        [Symbol.dispose]: () => { },
+    };
+}
+/* c8 ignore end */
 //# sourceMappingURL=EnableUnifiedSelectionSyncWithIModel.js.map

package/lib/cjs/unified-selection/EnableUnifiedSelectionSyncWithIModel.js.map

@@ -1 +1 @@
-{"version":3,"file":"EnableUnifiedSelectionSyncWithIModel.js","sourceRoot":"","sources":["../../../src/unified-selection/EnableUnifiedSelectionSyncWithIModel.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8EhG,oFAGC;AA/ED,gCAA8B;AAC9B,+BAAwG;AAGxG,+EAAyG;AACzG,iEAA+F;AAG/F,2DAAuE;AAEvE,iDAA2J;AAC3J,yCAAyC;AA4DzC;;;;GAIG;AACH,SAAgB,oCAAoC,CAAC,KAAgD;IACnG,MAAM,gBAAgB,GAAG,IAAI,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAC3D,OAAO,GAAG,EAAE,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;AAClD,CAAC;AAED;;;;;GAKG;AACH,MAAa,sBAAsB;IACzB,oBAAoB,GAAG,MAAM,CAAC;IAE9B,aAAa,CAA4D;IACzE,iBAAiB,CAAmB;IACpC,kBAAkB,CAAoB;IACtC,yBAAyB,CAAqF;IAC9G,oBAAoB,CAAuB;IAE3C,YAAY,CAAU;IACtB,qBAAqB,GAAG,IAAI,cAAO,EAAQ,CAAC;IAC5C,mCAAmC,CAAa;IAChD,qCAAqC,CAAa;IAClD,kCAAkC,CAAU;IAEpD,YAAmB,KAA4F;QAC7G,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAChD,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC,mBAAmB,CAAC;QACtD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAC1B,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,IAAI,IAAA,8CAAuB,EAAC,EAAE,YAAY,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QACnH,IAAI,CAAC,kCAAkC,GAAG,CAAC,CAAC,KAAK,CAAC,wBAAwB,CAAC;QAC3E,IAAI,CAAC,yBAAyB;YAC5B,KAAK,CAAC,wBAAwB,CAAC,oBAAoB;gBACnD,sBAAsB,CAAC,IAAA,4DAA8B,EAAC;oBACpD,gBAAgB,EAAE,IAAI,CAAC,iBAAiB;oBACxC,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,aAAa;oBACxC,uBAAuB,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,kBAAkB;iBACvD,CAAC,CAAC;QAEL,IAAI,CAAC,qCAAqC,GAAG,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;QAClI,IAAI,CAAC,mCAAmC,GAAG,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,WAAW,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;QAEnI,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,CAAC;YACvD,oHAAoH;YACpH,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,wBAAwB,GAAG,KAAK,CAAC;QAChE,CAAC;QAED,IAAI,CAAC,qBAAqB,CAAC,EAAE,qBAAqB,EAAE,UAAU,EAAE,CAAC,CAAC;IACpE,CAAC;IAEM,CAAC,MAAM,CAAC,OAAO,CAAC;QACrB,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,CAAC;QAClC,IAAI,CAAC,qCAAqC,EAAE,CAAC;QAC7C,IAAI,CAAC,mCAAmC,EAAE,CAAC;QAC3C,sBAAsB;QACtB,IAAI,CAAC,IAAI,CAAC,kCAAkC,EAAE,CAAC;YAC7C,IAAA,sBAAW,EAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IAED,4GAA4G;IACrG,8BAA8B;QACnC,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QACzB,OAAO;YACL,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE;gBACrB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;YACnC,CAAC;SACF,CAAC;IACJ,CAAC;IAEO,4BAA4B,CAAC,UAAsC,EAAE,WAAwB,EAAE,MAAc;QACnH,QAAQ,UAAU,EAAE,CAAC;YACnB,KAAK,OAAO;gBACV,OAAO,IAAI,CAAC,qBAAqB,CAAC,EAAE,qBAAqB,EAAE,UAAU,EAAE,CAAC,CAAC;YAC3E,KAAK,SAAS;gBACZ,OAAO,IAAI,CAAC,qBAAqB,CAAC;oBAChC,qBAAqB,EACnB,MAAM,KAAK,IAAI,CAAC,oBAAoB;wBAClC,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC;4BACjD,CAAC,CAAC,iIAAiI;gCACjI,MAAM;4BACR,CAAC,CAAC,uFAAuF;gCACvF,cAAc;wBAClB,CAAC,CAAC,qEAAqE;4BACrE,UAAU;iBACjB,CAAC,CAAC;YACL,KAAK,KAAK;gBACR,OAAO,KAAK,IAAA,WAAI,EAAC,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;qBACpE,IAAI,CAAC,IAAA,gBAAS,EAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;qBAC3C,SAAS,CAAC;oBACT,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE;wBACZ,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;oBACzB,CAAC;iBACF,CAAC,CAAC;YACP,KAAK,QAAQ;gBACX,OAAO,KAAK,IAAA,WAAI,EAAC,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;qBACpE,IAAI,CAAC,IAAA,gBAAS,EAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;qBAC3C,SAAS,CAAC;oBACT,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE;wBACZ,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;oBAC5B,CAAC;oBACD,QAAQ,EAAE,GAAG,EAAE;wBACb,IAAI,CAAC,qBAAqB,CAAC,EAAE,qBAAqB,EAAE,MAAM,EAAE,CAAC,CAAC;oBAChE,CAAC;iBACF,CAAC,CAAC;QACT,CAAC;IACH,CAAC;IAEO,yBAAyB,GAAG,CAAC,IAAqC,EAAE,EAAE;QAC5E,6DAA6D;QAC7D,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,aAAa,CAAC,GAAG,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC,EAAE,CAAC;YAClE,OAAO;QACT,CAAC;QAED,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,KAAK,OAAO,EAAE,CAAC;YACjE,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,CAAC;QACpC,CAAC;QACD,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACpF,CAAC,CAAC;IAEM,qBAAqB,CAAC,EAAE,qBAAqB,EAAmE;QACtH,IAAI,qBAAqB,KAAK,MAAM,EAAE,CAAC;;;gBACrC,MAAM,QAAQ,kCAAG,IAAI,CAAC,8BAA8B,EAAE,QAAA,CAAC;gBACvD,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,CAAC;oBACvD,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;gBACvC,CAAC;gBACD,IAAI,qBAAqB,KAAK,UAAU,EAAE,CAAC;oBACzC,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;gBAC7C,CAAC;;;;;;;;;SACF;QAED,IAAA,WAAI,EAAC,IAAI,CAAC,yBAAyB,CAAC,YAAY,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,CAAC;aACrF,IAAI,CAAC,IAAA,gBAAS,EAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;aAC3C,SAAS,CAAC;YACT,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE;gBACZ,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;YACzB,CAAC;SACF,CAAC,CAAC;IACP,CAAC;IAEO,YAAY,CAAC,GAAc;;;YACjC,MAAM,QAAQ,kCAAG,IAAI,CAAC,8BAA8B,EAAE,QAAA,CAAC;YACvD,IAAI,gBAAgB,CAAC,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,CAAC;gBACtD,qDAAqD;gBACrD,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,GAAG,CAAC;oBAClC,MAAM,EAAE,GAAG,CAAC,MAAM;oBAClB,aAAa,EAAE,GAAG,CAAC,aAAa;oBAChC,QAAQ,EAAE,GAAG,CAAC,QAAQ;iBACvB,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,iFAAiF;gBACjF,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;oBACtB,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACzD,CAAC;gBACD,IAAI,GAAG,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;oBAC7B,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;gBACvE,CAAC;gBACD,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;oBACxB,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;oBAC3D,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACpD,CAAC;YACH,CAAC;;;;;;;;;KACF;IAEO,eAAe,CAAC,GAAc;;;YACpC,MAAM,QAAQ,kCAAG,IAAI,CAAC,8BAA8B,EAAE,QAAA,CAAC;YACvD,IAAI,gBAAgB,CAAC,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,CAAC;gBACtD,wDAAwD;gBACxD,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,CAAC;oBACrC,MAAM,EAAE,GAAG,CAAC,MAAM;oBAClB,aAAa,EAAE,GAAG,CAAC,aAAa;oBAChC,QAAQ,EAAE,GAAG,CAAC,QAAQ;iBACvB,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;oBACtB,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBAC5D,CAAC;gBACD,IAAI,GAAG,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;oBAC7B,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;gBAC1E,CAAC;gBACD,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;oBACxB,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;oBAC9D,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACvD,CAAC;YACH,CAAC;;;;;;;;;KACF;IAEO,wBAAwB,GAAG,KAAK,EAAE,KAAkC,EAAiB,EAAE;QAC7F,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,OAAO;QACT,CAAC;QAED,IAAI,qCAAyB,CAAC,KAAK,KAAK,KAAK,CAAC,IAAI,EAAE,CAAC;YACnD,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,oBAAoB,EAAE,CAAC,CAAC;YAChH,OAAO;QACT,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;QACjD,MAAM,eAAe,GAAG,IAAA,YAAK,EAC3B,GAAG,CAAC,QAAQ;YACV,CAAC,CAAC,IAAA,WAAI,EAAC,IAAA,oCAAgB,EAAC,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,UAAU,EAAE,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAC;YAC7H,CAAC,CAAC,oBAAoB,CAAC,YAAK,EAC9B,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAA,UAAG,EAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,YAAK,EAClH,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,GAAG,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,IAAA,UAAG,EAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,qBAAqB,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,YAAK,CACvI,CAAC;QACF,MAAM,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;IACtE,CAAC,CAAC;IAEM,KAAK,CAAC,2BAA2B,CAAC,IAA+B,EAAE,IAAuC;QAChH,MAAM,WAAW,GAAG,MAAM,IAAA,qBAAc,EAAC,IAAI,CAAC,IAAI,CAAC,IAAA,cAAO,GAAE,CAAC,CAAC,CAAC;QAC/D,MAAM,KAAK,GAAG;YACZ,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,GAAG;YACjC,MAAM,EAAE,IAAI,CAAC,oBAAoB;YACjC,WAAW;SACZ,CAAC;QACF,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,qCAAyB,CAAC,GAAG;gBAChC,OAAO,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YACtD,KAAK,qCAAyB,CAAC,MAAM;gBACnC,OAAO,IAAI,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;YAC3D,KAAK,qCAAyB,CAAC,OAAO;gBACpC,OAAO,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;IAEO,wBAAwB,CAC9B,KAEC;QAED,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,qCAAyB,CAAC,GAAG;gBAChC,OAAO,KAAK,CAAC,SAAS,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC;YAChG,KAAK,qCAAyB,CAAC,MAAM;gBACnC,OAAO,KAAK,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC;YACnG,KAAK,qCAAyB,CAAC,OAAO;gBACpC,OAAO,QAAQ,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QACvF,CAAC;IACH,CAAC;CACF;AAvOD,wDAuOC;AAED,SAAS,gBAAgB,CAAC,YAAoC;IAK5D,OAAO,QAAQ,IAAI,YAAY,CAAC;AAClC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n\nimport \"./DisposePolyfill.js\";\nimport { EMPTY, firstValueFrom, from, map, merge, Observable, Subject, takeUntil, toArray } from \"rxjs\";\nimport { Id64Arg, Id64Set } from \"@itwin/core-bentley\";\nimport { ECClassHierarchyInspector, ECSqlQueryExecutor } from \"@itwin/presentation-shared\";\nimport { CachingHiliteSetProvider, createCachingHiliteSetProvider } from \"./CachingHiliteSetProvider.js\";\nimport { createHiliteSetProvider, HiliteSet, HiliteSetProvider } from \"./HiliteSetProvider.js\";\nimport { SelectableInstanceKey, Selectables } from \"./Selectable.js\";\nimport { StorageSelectionChangeEventArgs, StorageSelectionChangeType } from \"./SelectionChangeEvent.js\";\nimport { computeSelection, SelectionScope } from \"./SelectionScope.js\";\nimport { SelectionStorage } from \"./SelectionStorage.js\";\nimport { CoreIModelHiliteSet, CoreIModelSelectionSet, CoreSelectableIds, CoreSelectionSetEventType, CoreSelectionSetEventUnsafe } from \"./types/IModel.js\";\nimport { safeDispose } from \"./Utils.js\";\n\n/**\n * Props for `enableUnifiedSelectionSyncWithIModel`.\n * @public\n */\nexport interface EnableUnifiedSelectionSyncWithIModelProps {\n  /**\n   * Provides access to different iModel's features: query executing, class hierarchy, selection and hilite sets.\n   *\n   * It's recommended to use `@itwin/presentation-core-interop` to create `key`, `ECSqlQueryExecutor` and `ECSchemaProvider` from\n   * [IModelConnection](https://www.itwinjs.org/reference/core-frontend/imodelconnection/imodelconnection/), and map its\n   * `hilited` and `selectionSet` attributes like this:\n   *\n   * ```ts\n   * import { createECSqlQueryExecutor, createECSchemaProvider, createIModelKey } from \"@itwin/presentation-core-interop\";\n   * import { createCachingECClassHierarchyInspector } from \"@itwin/presentation-shared\";\n   * import { IModelConnection } from \"@itwin/core-frontend\";\n   *\n   * const imodel: IModelConnection = ...\n   * const imodelAccess = {\n   *   ...createECSqlQueryExecutor(imodel),\n   *   ...createCachingECClassHierarchyInspector({ schemaProvider: createECSchemaProvider(MyAppFrontend.getSchemaContext(imodel)) }),\n   *   key: createIModelKey(imodel),\n   *   hiliteSet: imodel.hilited,\n   *   selectionSet: imodel.selectionSet,\n   * };\n   * ```\n   */\n  imodelAccess: ECSqlQueryExecutor &\n    ECClassHierarchyInspector & {\n      /** Key of the iModel. Generally taken from `IModelConnection.key`. */\n      readonly key: string;\n      /** The set of currently hilited elements taken from `IModelConnection.hilited`. */\n      readonly hiliteSet: CoreIModelHiliteSet;\n      /** The set of currently selected elements taken from `IModelConnection.selectionSet`. */\n      readonly selectionSet: CoreIModelSelectionSet;\n    };\n\n  /**\n   * Unified selection storage to synchronize IModel's tool selection with. The storage should be shared\n   * across all components in the application to ensure unified selection experience.\n   */\n  selectionStorage: SelectionStorage;\n\n  /** Active selection scope provider. */\n  activeScopeProvider: () => SelectionScope;\n\n  /**\n   * A caching hilite set provider used to retrieve hilite sets for an iModel. If not provided, a new `CachingHiliteSetProvider`\n   * will be created for the given iModel using the provided `imodelAccess`.\n   * If the consuming application already has a `CachingHiliteSetProvider` defined, it should be provided instead\n   * to reuse the cache and avoid creating new providers for each iModel.\n   *\n   * The type is defined in a way that makes it required for provider to have either the deprecated `dispose` or the\n   * new `Symbol.dispose` method.\n   */\n  cachingHiliteSetProvider?: CachingHiliteSetProvider | (Omit<CachingHiliteSetProvider, \"dispose\"> & { [Symbol.dispose]: () => void });\n}\n\n/**\n * Enables synchronization between iModel selection and unified selection.\n * @returns function for disposing the synchronization.\n * @public\n */\nexport function enableUnifiedSelectionSyncWithIModel(props: EnableUnifiedSelectionSyncWithIModelProps): () => void {\n  const selectionHandler = new IModelSelectionHandler(props);\n  return () => selectionHandler[Symbol.dispose]();\n}\n\n/**\n * A handler that syncs selection between unified selection storage (`SelectionStorage`) and\n * an iModel (`iModel.selectionSet`, `iModel.hilited`).\n *\n * @internal\n */\nexport class IModelSelectionHandler {\n  private _selectionSourceName = \"Tool\";\n\n  private _imodelAccess: EnableUnifiedSelectionSyncWithIModelProps[\"imodelAccess\"];\n  private _selectionStorage: SelectionStorage;\n  private _hiliteSetProvider: HiliteSetProvider;\n  private _cachingHiliteSetProvider: NonNullable<EnableUnifiedSelectionSyncWithIModelProps[\"cachingHiliteSetProvider\"]>;\n  private _activeScopeProvider: () => SelectionScope;\n\n  private _isSuspended: boolean;\n  private _cancelOngoingChanges = new Subject<void>();\n  private _unregisterUnifiedSelectionListener: () => void;\n  private _unregisterIModelSelectionSetListener: () => void;\n  private _hasCustomCachingHiliteSetProvider: boolean;\n\n  public constructor(props: EnableUnifiedSelectionSyncWithIModelProps & { hiliteSetProvider?: HiliteSetProvider }) {\n    this._imodelAccess = props.imodelAccess;\n    this._selectionStorage = props.selectionStorage;\n    this._activeScopeProvider = props.activeScopeProvider;\n    this._isSuspended = false;\n    this._hiliteSetProvider = props.hiliteSetProvider ?? createHiliteSetProvider({ imodelAccess: this._imodelAccess });\n    this._hasCustomCachingHiliteSetProvider = !!props.cachingHiliteSetProvider;\n    this._cachingHiliteSetProvider =\n      props.cachingHiliteSetProvider /* c8 ignore next */ ??\n      /* c8 ignore next 4 */ createCachingHiliteSetProvider({\n        selectionStorage: this._selectionStorage,\n        imodelProvider: () => this._imodelAccess,\n        createHiliteSetProvider: () => this._hiliteSetProvider,\n      });\n\n    this._unregisterIModelSelectionSetListener = this._imodelAccess.selectionSet.onChanged.addListener(this.onIModelSelectionChanged);\n    this._unregisterUnifiedSelectionListener = this._selectionStorage.selectionChangeEvent.addListener(this.onUnifiedSelectionChanged);\n\n    if (!is5xSelectionSet(this._imodelAccess.selectionSet)) {\n      // itwinjs-core@4: stop imodel from syncing tool selection with hilited list - we want to manage that sync ourselves\n      this._imodelAccess.hiliteSet.wantSyncWithSelectionSet = false;\n    }\n\n    this.applyCurrentHiliteSet({ activeSelectionAction: \"clearAll\" });\n  }\n\n  public [Symbol.dispose]() {\n    this._cancelOngoingChanges.next();\n    this._unregisterIModelSelectionSetListener();\n    this._unregisterUnifiedSelectionListener();\n    /* c8 ignore next 3 */\n    if (!this._hasCustomCachingHiliteSetProvider) {\n      safeDispose(this._cachingHiliteSetProvider);\n    }\n  }\n\n  /** Temporarily suspends tool selection synchronization until the returned disposable object is disposed. */\n  public suspendIModelToolSelectionSync() {\n    const wasSuspended = this._isSuspended;\n    this._isSuspended = true;\n    return {\n      [Symbol.dispose]: () => {\n        this._isSuspended = wasSuspended;\n      },\n    };\n  }\n\n  private handleUnifiedSelectionChange(changeType: StorageSelectionChangeType, selectables: Selectables, source: string): void {\n    switch (changeType) {\n      case \"clear\":\n        return this.applyCurrentHiliteSet({ activeSelectionAction: \"clearAll\" });\n      case \"replace\":\n        return this.applyCurrentHiliteSet({\n          activeSelectionAction:\n            source === this._selectionSourceName\n              ? is5xSelectionSet(this._imodelAccess.selectionSet)\n                ? // with 5x core we don't need to clear anything when event is triggered by a Tool (hilite and selection sets are in sync already)\n                  \"keep\"\n                : // with 4x core we need to clear hilite set, because it's not synced with selection set\n                  \"clearHilited\"\n              : // when event is triggered not by a Tool, we need to clear everything\n                \"clearAll\",\n        });\n      case \"add\":\n        return void from(this._hiliteSetProvider.getHiliteSet({ selectables }))\n          .pipe(takeUntil(this._cancelOngoingChanges))\n          .subscribe({\n            next: (set) => {\n              this.addHiliteSet(set);\n            },\n          });\n      case \"remove\":\n        return void from(this._hiliteSetProvider.getHiliteSet({ selectables }))\n          .pipe(takeUntil(this._cancelOngoingChanges))\n          .subscribe({\n            next: (set) => {\n              this.removeHiliteSet(set);\n            },\n            complete: () => {\n              this.applyCurrentHiliteSet({ activeSelectionAction: \"keep\" });\n            },\n          });\n    }\n  }\n\n  private onUnifiedSelectionChanged = (args: StorageSelectionChangeEventArgs) => {\n    // iModels are only interested in top-level selection changes\n    if (args.imodelKey !== this._imodelAccess.key || args.level !== 0) {\n      return;\n    }\n\n    if (args.changeType === \"replace\" || args.changeType === \"clear\") {\n      this._cancelOngoingChanges.next();\n    }\n    this.handleUnifiedSelectionChange(args.changeType, args.selectables, args.source);\n  };\n\n  private applyCurrentHiliteSet({ activeSelectionAction }: { activeSelectionAction: \"clearAll\" | \"clearHilited\" | \"keep\" }) {\n    if (activeSelectionAction !== \"keep\") {\n      using _dispose = this.suspendIModelToolSelectionSync();\n      if (!is5xSelectionSet(this._imodelAccess.selectionSet)) {\n        this._imodelAccess.hiliteSet.clear();\n      }\n      if (activeSelectionAction === \"clearAll\") {\n        this._imodelAccess.selectionSet.emptyAll();\n      }\n    }\n\n    from(this._cachingHiliteSetProvider.getHiliteSet({ imodelKey: this._imodelAccess.key }))\n      .pipe(takeUntil(this._cancelOngoingChanges))\n      .subscribe({\n        next: (ids) => {\n          this.addHiliteSet(ids);\n        },\n      });\n  }\n\n  private addHiliteSet(set: HiliteSet) {\n    using _dispose = this.suspendIModelToolSelectionSync();\n    if (is5xSelectionSet(this._imodelAccess.selectionSet)) {\n      // with 5.x core we can simply add the set as a whole\n      this._imodelAccess.selectionSet.add({\n        models: set.models,\n        subcategories: set.subCategories,\n        elements: set.elements,\n      });\n    } else {\n      // pre-5.0 core requires adding models and subcategories to hilite set separately\n      if (set.models.length) {\n        this._imodelAccess.hiliteSet.models.addIds(set.models);\n      }\n      if (set.subCategories.length) {\n        this._imodelAccess.hiliteSet.subcategories.addIds(set.subCategories);\n      }\n      if (set.elements.length) {\n        this._imodelAccess.hiliteSet.elements.addIds(set.elements);\n        this._imodelAccess.selectionSet.add(set.elements);\n      }\n    }\n  }\n\n  private removeHiliteSet(set: HiliteSet) {\n    using _dispose = this.suspendIModelToolSelectionSync();\n    if (is5xSelectionSet(this._imodelAccess.selectionSet)) {\n      // with 5.x core we can simply remove the set as a whole\n      this._imodelAccess.selectionSet.remove({\n        models: set.models,\n        subcategories: set.subCategories,\n        elements: set.elements,\n      });\n    } else {\n      if (set.models.length) {\n        this._imodelAccess.hiliteSet.models.deleteIds(set.models);\n      }\n      if (set.subCategories.length) {\n        this._imodelAccess.hiliteSet.subcategories.deleteIds(set.subCategories);\n      }\n      if (set.elements.length) {\n        this._imodelAccess.hiliteSet.elements.deleteIds(set.elements);\n        this._imodelAccess.selectionSet.remove(set.elements);\n      }\n    }\n  }\n\n  private onIModelSelectionChanged = async (event: CoreSelectionSetEventUnsafe): Promise<void> => {\n    if (this._isSuspended) {\n      return;\n    }\n\n    if (CoreSelectionSetEventType.Clear === event.type) {\n      this._selectionStorage.clearSelection({ imodelKey: this._imodelAccess.key, source: this._selectionSourceName });\n      return;\n    }\n\n    const ids = this.getSelectionSetChangeIds(event);\n    const scopedSelection = merge(\n      ids.elements\n        ? from(computeSelection({ queryExecutor: this._imodelAccess, elementIds: ids.elements, scope: this._activeScopeProvider() }))\n        : /* c8 ignore next */ EMPTY,\n      ids.models ? from(ids.models).pipe(map((id) => ({ className: \"BisCore.Model\", id }))) : /* c8 ignore next */ EMPTY,\n      ids.subcategories ? from(ids.subcategories).pipe(map((id) => ({ className: \"BisCore.SubCategory\", id }))) : /* c8 ignore next */ EMPTY,\n    );\n    await this.handleIModelSelectionChange(event.type, scopedSelection);\n  };\n\n  private async handleIModelSelectionChange(type: CoreSelectionSetEventType, keys: Observable<SelectableInstanceKey>) {\n    const selectables = await firstValueFrom(keys.pipe(toArray()));\n    const props = {\n      imodelKey: this._imodelAccess.key,\n      source: this._selectionSourceName,\n      selectables,\n    };\n    switch (type) {\n      case CoreSelectionSetEventType.Add:\n        return this._selectionStorage.addToSelection(props);\n      case CoreSelectionSetEventType.Remove:\n        return this._selectionStorage.removeFromSelection(props);\n      case CoreSelectionSetEventType.Replace:\n        return this._selectionStorage.replaceSelection(props);\n    }\n  }\n\n  private getSelectionSetChangeIds(\n    event: Omit<CoreSelectionSetEventUnsafe, \"type\"> & {\n      type: CoreSelectionSetEventType.Add | CoreSelectionSetEventType.Remove | CoreSelectionSetEventType.Replace;\n    },\n  ): CoreSelectableIds {\n    switch (event.type) {\n      case CoreSelectionSetEventType.Add:\n        return event.additions ?? (event.added ? { elements: event.added } : /* c8 ignore next */ {});\n      case CoreSelectionSetEventType.Remove:\n        return event.removals ?? (event.removed ? { elements: event.removed } : /* c8 ignore next */ {});\n      case CoreSelectionSetEventType.Replace:\n        return \"active\" in event.set ? event.set.active : { elements: event.set.elements };\n    }\n  }\n}\n\nfunction is5xSelectionSet(selectionSet: CoreIModelSelectionSet): selectionSet is Omit<CoreIModelSelectionSet, \"add\" | \"remove\"> & {\n  readonly active: { [P in keyof CoreSelectableIds]-?: Id64Set };\n  add: (ids: Id64Arg | CoreSelectableIds) => boolean;\n  remove: (ids: Id64Arg | CoreSelectableIds) => boolean;\n} {\n  return \"active\" in selectionSet;\n}\n"]}
+{"version":3,"file":"EnableUnifiedSelectionSyncWithIModel.js","sourceRoot":"","sources":["../../../src/unified-selection/EnableUnifiedSelectionSyncWithIModel.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgGhG,oFAGC;AAjGD,gCAA8B;AAC9B,+BAAwG;AAIxG,iEAA+F;AAC/F,6EAAsG;AAGtG,2DAAuE;AAEvE,iDAA2J;AAC3J,yCAAyC;AA6EzC;;;;GAIG;AACH,SAAgB,oCAAoC,CAAC,KAAgD;IACnG,MAAM,gBAAgB,GAAG,IAAI,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAC3D,OAAO,GAAG,EAAE,CAAC,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;AAClD,CAAC;AAED;;;;;GAKG;AACH,MAAa,sBAAsB;IACzB,oBAAoB,GAAG,MAAM,CAAC;IAE9B,aAAa,CAA4D;IACzE,iBAAiB,CAAmB;IACpC,wBAAwB,CAAoF;IAC5G,oBAAoB,CAAuB;IAE3C,YAAY,CAAU;IACtB,qBAAqB,GAAG,IAAI,cAAO,EAAQ,CAAC;IAC5C,mCAAmC,CAAa;IAChD,qCAAqC,CAAa;IAClD,iCAAiC,CAAa;IAEtD,YAAmB,KAA4F;QAC7G,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC,gBAAgB,CAAC;QAChD,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC,mBAAmB,CAAC;QACtD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAE1B,CAAC,IAAI,CAAC,wBAAwB,EAAE,IAAI,CAAC,iCAAiC,CAAC,GAAG,CAAC,GAAG,EAAE;YAC9E,IAAI,KAAK,CAAC,uBAAuB,EAAE,CAAC;gBAClC,OAAO,CAAC,KAAK,CAAC,uBAAuB,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;YACnD,CAAC;YACD,4DAA4D;YAC5D,IAAI,KAAK,CAAC,wBAAwB,EAAE,CAAC;gBACnC,OAAO;oBACL,gDAAgD;oBAC9C,4DAA4D;oBAC5D,KAAK,CAAC,wBAAwB,EAC9B,KAAK,CAAC,iBAAiB,IAAI,IAAA,8CAAuB,EAAC,EAAE,YAAY,EAAE,KAAK,CAAC,YAAY,EAAE,CAAC,CACzF;oBACD,8HAA8H;oBAC9H,qBAAqB;oBACrB,GAAG,EAAE,GAAE,CAAC;iBACT,CAAC;YACJ,CAAC;YACD,qBAAqB;YACrB,MAAM,gBAAgB,GAAG,IAAA,0DAA6B,EAAC;gBACrD,gBAAgB,EAAE,IAAI,CAAC,iBAAiB;gBACxC,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,aAAa;gBACxC,uBAAuB,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,iBAAiB,IAAI,IAAA,8CAAuB,EAAC,EAAE,YAAY,EAAE,KAAK,CAAC,YAAY,EAAE,CAAC;aACxH,CAAC,CAAC;YACH,OAAO,CAAC,gBAAgB,EAAE,GAAG,EAAE,CAAC,IAAA,sBAAW,EAAC,gBAAgB,CAAC,CAAC,CAAC;YAC/D,mBAAmB;QACrB,CAAC,CAAC,EAAE,CAAC;QAEL,IAAI,CAAC,qCAAqC,GAAG,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;QAClI,IAAI,CAAC,mCAAmC,GAAG,IAAI,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,WAAW,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;QAEnI,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,CAAC;YACvD,oHAAoH;YACpH,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,wBAAwB,GAAG,KAAK,CAAC;QAChE,CAAC;QAED,IAAI,CAAC,qBAAqB,CAAC,EAAE,qBAAqB,EAAE,UAAU,EAAE,CAAC,CAAC;IACpE,CAAC;IAEM,CAAC,MAAM,CAAC,OAAO,CAAC;QACrB,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,CAAC;QAClC,IAAI,CAAC,qCAAqC,EAAE,CAAC;QAC7C,IAAI,CAAC,mCAAmC,EAAE,CAAC;QAC3C,IAAI,CAAC,iCAAiC,EAAE,CAAC;IAC3C,CAAC;IAED,4GAA4G;IACrG,8BAA8B;QACnC,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACvC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QACzB,OAAO;YACL,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE;gBACrB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;YACnC,CAAC;SACF,CAAC;IACJ,CAAC;IAEO,4BAA4B,CAAC,UAAsC,EAAE,WAAwB,EAAE,MAAc;QACnH,QAAQ,UAAU,EAAE,CAAC;YACnB,KAAK,OAAO;gBACV,OAAO,IAAI,CAAC,qBAAqB,CAAC,EAAE,qBAAqB,EAAE,UAAU,EAAE,CAAC,CAAC;YAC3E,KAAK,SAAS;gBACZ,OAAO,IAAI,CAAC,qBAAqB,CAAC;oBAChC,qBAAqB,EACnB,MAAM,KAAK,IAAI,CAAC,oBAAoB;wBAClC,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC;4BACjD,CAAC,CAAC,iIAAiI;gCACjI,MAAM;4BACR,CAAC,CAAC,uFAAuF;gCACvF,cAAc;wBAClB,CAAC,CAAC,qEAAqE;4BACrE,UAAU;iBACjB,CAAC,CAAC;YACL,KAAK,KAAK;gBACR,OAAO,KAAK,IAAA,WAAI,EAAC,IAAI,CAAC,wBAAwB,CAAC,oBAAoB,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;qBACtI,IAAI,CAAC,IAAA,gBAAS,EAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;qBAC3C,SAAS,CAAC;oBACT,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE;wBACZ,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;oBACzB,CAAC;iBACF,CAAC,CAAC;YACP,KAAK,QAAQ;gBACX,OAAO,KAAK,IAAA,WAAI,EAAC,IAAI,CAAC,wBAAwB,CAAC,oBAAoB,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;qBACtI,IAAI,CAAC,IAAA,gBAAS,EAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;qBAC3C,SAAS,CAAC;oBACT,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE;wBACZ,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;oBAC5B,CAAC;oBACD,QAAQ,EAAE,GAAG,EAAE;wBACb,IAAI,CAAC,qBAAqB,CAAC,EAAE,qBAAqB,EAAE,MAAM,EAAE,CAAC,CAAC;oBAChE,CAAC;iBACF,CAAC,CAAC;QACT,CAAC;IACH,CAAC;IAEO,yBAAyB,GAAG,CAAC,IAAqC,EAAE,EAAE;QAC5E,6DAA6D;QAC7D,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,aAAa,CAAC,GAAG,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC,EAAE,CAAC;YAClE,OAAO;QACT,CAAC;QAED,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,KAAK,OAAO,EAAE,CAAC;YACjE,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,CAAC;QACpC,CAAC;QACD,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACpF,CAAC,CAAC;IAEM,qBAAqB,CAAC,EAAE,qBAAqB,EAAmE;QACtH,IAAI,qBAAqB,KAAK,MAAM,EAAE,CAAC;;;gBACrC,MAAM,QAAQ,kCAAG,IAAI,CAAC,8BAA8B,EAAE,QAAA,CAAC;gBACvD,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,CAAC;oBACvD,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;gBACvC,CAAC;gBACD,IAAI,qBAAqB,KAAK,UAAU,EAAE,CAAC;oBACzC,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;gBAC7C,CAAC;;;;;;;;;SACF;QAED,IAAA,WAAI,EAAC,IAAI,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,CAAC;aAC3F,IAAI,CAAC,IAAA,gBAAS,EAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;aAC3C,SAAS,CAAC;YACT,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE;gBACZ,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;YACzB,CAAC;SACF,CAAC,CAAC;IACP,CAAC;IAEO,YAAY,CAAC,GAAc;;;YACjC,MAAM,QAAQ,kCAAG,IAAI,CAAC,8BAA8B,EAAE,QAAA,CAAC;YACvD,IAAI,gBAAgB,CAAC,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,CAAC;gBACtD,qDAAqD;gBACrD,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,GAAG,CAAC;oBAClC,MAAM,EAAE,GAAG,CAAC,MAAM;oBAClB,aAAa,EAAE,GAAG,CAAC,aAAa;oBAChC,QAAQ,EAAE,GAAG,CAAC,QAAQ;iBACvB,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,iFAAiF;gBACjF,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;oBACtB,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACzD,CAAC;gBACD,IAAI,GAAG,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;oBAC7B,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;gBACvE,CAAC;gBACD,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;oBACxB,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;oBAC3D,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACpD,CAAC;YACH,CAAC;;;;;;;;;KACF;IAEO,eAAe,CAAC,GAAc;;;YACpC,MAAM,QAAQ,kCAAG,IAAI,CAAC,8BAA8B,EAAE,QAAA,CAAC;YACvD,IAAI,gBAAgB,CAAC,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,EAAE,CAAC;gBACtD,wDAAwD;gBACxD,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,CAAC;oBACrC,MAAM,EAAE,GAAG,CAAC,MAAM;oBAClB,aAAa,EAAE,GAAG,CAAC,aAAa;oBAChC,QAAQ,EAAE,GAAG,CAAC,QAAQ;iBACvB,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;oBACtB,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBAC5D,CAAC;gBACD,IAAI,GAAG,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;oBAC7B,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,aAAa,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;gBAC1E,CAAC;gBACD,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;oBACxB,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;oBAC9D,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACvD,CAAC;YACH,CAAC;;;;;;;;;KACF;IAEO,wBAAwB,GAAG,KAAK,EAAE,KAAkC,EAAiB,EAAE;QAC7F,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,OAAO;QACT,CAAC;QAED,IAAI,qCAAyB,CAAC,KAAK,KAAK,KAAK,CAAC,IAAI,EAAE,CAAC;YACnD,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,oBAAoB,EAAE,CAAC,CAAC;YAChH,OAAO;QACT,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;QACjD,MAAM,eAAe,GAAG,IAAA,YAAK,EAC3B,GAAG,CAAC,QAAQ;YACV,CAAC,CAAC,IAAA,WAAI,EAAC,IAAA,oCAAgB,EAAC,EAAE,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,UAAU,EAAE,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,oBAAoB,EAAE,EAAE,CAAC,CAAC;YAC7H,CAAC,CAAC,oBAAoB,CAAC,YAAK,EAC9B,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAA,UAAG,EAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,YAAK,EAClH,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,GAAG,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,IAAA,UAAG,EAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,qBAAqB,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,YAAK,CACvI,CAAC;QACF,MAAM,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;IACtE,CAAC,CAAC;IAEM,KAAK,CAAC,2BAA2B,CAAC,IAA+B,EAAE,IAAuC;QAChH,MAAM,WAAW,GAAG,MAAM,IAAA,qBAAc,EAAC,IAAI,CAAC,IAAI,CAAC,IAAA,cAAO,GAAE,CAAC,CAAC,CAAC;QAC/D,MAAM,KAAK,GAAG;YACZ,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,GAAG;YACjC,MAAM,EAAE,IAAI,CAAC,oBAAoB;YACjC,WAAW;SACZ,CAAC;QACF,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,qCAAyB,CAAC,GAAG;gBAChC,OAAO,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YACtD,KAAK,qCAAyB,CAAC,MAAM;gBACnC,OAAO,IAAI,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;YAC3D,KAAK,qCAAyB,CAAC,OAAO;gBACpC,OAAO,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;IAEO,wBAAwB,CAC9B,KAEC;QAED,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,qCAAyB,CAAC,GAAG;gBAChC,OAAO,KAAK,CAAC,SAAS,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC;YAChG,KAAK,qCAAyB,CAAC,MAAM;gBACnC,OAAO,KAAK,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC;YACnG,KAAK,qCAAyB,CAAC,OAAO;gBACpC,OAAO,QAAQ,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;QACvF,CAAC;IACH,CAAC;CACF;AArPD,wDAqPC;AAED,SAAS,gBAAgB,CAAC,YAAoC;IAK5D,OAAO,QAAQ,IAAI,YAAY,CAAC;AAClC,CAAC;AAED,qBAAqB;AACrB,SAAS,gDAAgD,CACvD,wBAA4G,EAC5G,iBAAoC;IAEpC,OAAO;QACL,oBAAoB,EAAE,GAAG,EAAE,CAAC,iBAAiB;QAC7C,mBAAmB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,wBAAwB,CAAC,YAAY,CAAC,KAAK,CAAC;QAC5E,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,GAAE,CAAC;KAC3B,CAAC;AACJ,CAAC;AACD,mBAAmB","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\nimport \"./DisposePolyfill.js\";\nimport { EMPTY, firstValueFrom, from, map, merge, Observable, Subject, takeUntil, toArray } from \"rxjs\";\nimport { Id64Arg, Id64Set } from \"@itwin/core-bentley\";\nimport { ECClassHierarchyInspector, ECSqlQueryExecutor } from \"@itwin/presentation-shared\";\nimport { CachingHiliteSetProvider } from \"./CachingHiliteSetProvider.js\";\nimport { createHiliteSetProvider, HiliteSet, HiliteSetProvider } from \"./HiliteSetProvider.js\";\nimport { createIModelHiliteSetProvider, IModelHiliteSetProvider } from \"./IModelHiliteSetProvider.js\";\nimport { SelectableInstanceKey, Selectables } from \"./Selectable.js\";\nimport { StorageSelectionChangeEventArgs, StorageSelectionChangeType } from \"./SelectionChangeEvent.js\";\nimport { computeSelection, SelectionScope } from \"./SelectionScope.js\";\nimport { SelectionStorage } from \"./SelectionStorage.js\";\nimport { CoreIModelHiliteSet, CoreIModelSelectionSet, CoreSelectableIds, CoreSelectionSetEventType, CoreSelectionSetEventUnsafe } from \"./types/IModel.js\";\nimport { safeDispose } from \"./Utils.js\";\n\n/**\n * Props for `enableUnifiedSelectionSyncWithIModel`.\n * @public\n */\nexport interface EnableUnifiedSelectionSyncWithIModelProps {\n  /**\n   * Provides access to different iModel's features: query executing, class hierarchy, selection and hilite sets.\n   *\n   * It's recommended to use `@itwin/presentation-core-interop` to create `key`, `ECSqlQueryExecutor` and `ECSchemaProvider` from\n   * [IModelConnection](https://www.itwinjs.org/reference/core-frontend/imodelconnection/imodelconnection/), and map its\n   * `hilited` and `selectionSet` attributes like this:\n   *\n   * ```ts\n   * import { createECSqlQueryExecutor, createECSchemaProvider, createIModelKey } from \"@itwin/presentation-core-interop\";\n   * import { createCachingECClassHierarchyInspector } from \"@itwin/presentation-shared\";\n   * import { IModelConnection } from \"@itwin/core-frontend\";\n   *\n   * const imodel: IModelConnection = ...\n   * const imodelAccess = {\n   *   ...createECSqlQueryExecutor(imodel),\n   *   ...createCachingECClassHierarchyInspector({ schemaProvider: createECSchemaProvider(MyAppFrontend.getSchemaContext(imodel)) }),\n   *   key: createIModelKey(imodel),\n   *   hiliteSet: imodel.hilited,\n   *   selectionSet: imodel.selectionSet,\n   * };\n   * ```\n   */\n  imodelAccess: ECSqlQueryExecutor &\n    ECClassHierarchyInspector & {\n      /** Key of the iModel. Generally taken from `IModelConnection.key`. */\n      readonly key: string;\n      /** The set of currently hilited elements taken from `IModelConnection.hilited`. */\n      readonly hiliteSet: CoreIModelHiliteSet;\n      /** The set of currently selected elements taken from `IModelConnection.selectionSet`. */\n      readonly selectionSet: CoreIModelSelectionSet;\n    };\n\n  /**\n   * Unified selection storage to synchronize IModel's tool selection with. The storage should be shared\n   * across all components in the application to ensure unified selection experience.\n   */\n  selectionStorage: SelectionStorage;\n\n  /** Active selection scope provider. */\n  activeScopeProvider: () => SelectionScope;\n\n  /**\n   * An iModel hilite set provider used to retrieve hilite sets for different iModels. If not provided, a new `IModelHiliteSetProvider`\n   * will be created for the given iModel using the provided `imodelAccess`.\n   * If the consuming application already has a `IModelHiliteSetProvider` defined, it should be provided instead\n   * to reuse the cache and avoid creating new providers for each iModel.\n   *\n   * @see `createIModelHiliteSetProvider`\n   */\n  imodelHiliteSetProvider?: IModelHiliteSetProvider;\n\n  /**\n   * A caching hilite set provider used to retrieve hilite sets for an iModel. If not provided, a new `CachingHiliteSetProvider`\n   * will be created for the given iModel using the provided `imodelAccess`.\n   * If the consuming application already has a `CachingHiliteSetProvider` defined, it should be provided instead\n   * to reuse the cache and avoid creating new providers for each iModel.\n   *\n   * The type is defined in a way that makes it required for provider to have either the deprecated `dispose` or the\n   * new `Symbol.dispose` method.\n   *\n   * **Warning:** When the given `CachingHiliteSetProvider` internally uses a custom `HiliteSetProvider`, the synchronization has\n   * no access to it, and thus uses its own, default, `HiliteSetProvider`. As a result, the synchronization may not work as expected.\n   * To alleviate this, the `imodelHiliteSetProvider` prop should be used instead.\n   *\n   * @deprecated in 1.5. Use `imodelHiliteSetProvider` prop instead.\n   */\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  cachingHiliteSetProvider?: CachingHiliteSetProvider | (Omit<CachingHiliteSetProvider, \"dispose\"> & { [Symbol.dispose]: () => void });\n}\n\n/**\n * Enables synchronization between iModel selection and unified selection.\n * @returns function for disposing the synchronization.\n * @public\n */\nexport function enableUnifiedSelectionSyncWithIModel(props: EnableUnifiedSelectionSyncWithIModelProps): () => void {\n  const selectionHandler = new IModelSelectionHandler(props);\n  return () => selectionHandler[Symbol.dispose]();\n}\n\n/**\n * A handler that syncs selection between unified selection storage (`SelectionStorage`) and\n * an iModel (`iModel.selectionSet`, `iModel.hilited`).\n *\n * @internal\n */\nexport class IModelSelectionHandler {\n  private _selectionSourceName = \"Tool\";\n\n  private _imodelAccess: EnableUnifiedSelectionSyncWithIModelProps[\"imodelAccess\"];\n  private _selectionStorage: SelectionStorage;\n  private _imodelHiliteSetProvider: NonNullable<EnableUnifiedSelectionSyncWithIModelProps[\"imodelHiliteSetProvider\"]>;\n  private _activeScopeProvider: () => SelectionScope;\n\n  private _isSuspended: boolean;\n  private _cancelOngoingChanges = new Subject<void>();\n  private _unregisterUnifiedSelectionListener: () => void;\n  private _unregisterIModelSelectionSetListener: () => void;\n  private _disposeInternalHiliteSetProvider: () => void;\n\n  public constructor(props: EnableUnifiedSelectionSyncWithIModelProps & { hiliteSetProvider?: HiliteSetProvider }) {\n    this._imodelAccess = props.imodelAccess;\n    this._selectionStorage = props.selectionStorage;\n    this._activeScopeProvider = props.activeScopeProvider;\n    this._isSuspended = false;\n\n    [this._imodelHiliteSetProvider, this._disposeInternalHiliteSetProvider] = (() => {\n      if (props.imodelHiliteSetProvider) {\n        return [props.imodelHiliteSetProvider, () => {}];\n      }\n      // eslint-disable-next-line @typescript-eslint/no-deprecated\n      if (props.cachingHiliteSetProvider) {\n        return [\n          createIModelHiliteSetProviderFromCachingProvider(\n            // eslint-disable-next-line @typescript-eslint/no-deprecated\n            props.cachingHiliteSetProvider,\n            props.hiliteSetProvider ?? createHiliteSetProvider({ imodelAccess: props.imodelAccess }),\n          ),\n          // don't need to dispose anything, because our wrapper has no dispose logic, and `cachingHiliteSetProvider` should be disposed\n          // by whoever owns it\n          () => {},\n        ];\n      }\n      /* c8 ignore start */\n      const internalProvider = createIModelHiliteSetProvider({\n        selectionStorage: this._selectionStorage,\n        imodelProvider: () => this._imodelAccess,\n        createHiliteSetProvider: () => props.hiliteSetProvider ?? createHiliteSetProvider({ imodelAccess: props.imodelAccess }),\n      });\n      return [internalProvider, () => safeDispose(internalProvider)];\n      /* c8 ignore end */\n    })();\n\n    this._unregisterIModelSelectionSetListener = this._imodelAccess.selectionSet.onChanged.addListener(this.onIModelSelectionChanged);\n    this._unregisterUnifiedSelectionListener = this._selectionStorage.selectionChangeEvent.addListener(this.onUnifiedSelectionChanged);\n\n    if (!is5xSelectionSet(this._imodelAccess.selectionSet)) {\n      // itwinjs-core@4: stop imodel from syncing tool selection with hilited list - we want to manage that sync ourselves\n      this._imodelAccess.hiliteSet.wantSyncWithSelectionSet = false;\n    }\n\n    this.applyCurrentHiliteSet({ activeSelectionAction: \"clearAll\" });\n  }\n\n  public [Symbol.dispose]() {\n    this._cancelOngoingChanges.next();\n    this._unregisterIModelSelectionSetListener();\n    this._unregisterUnifiedSelectionListener();\n    this._disposeInternalHiliteSetProvider();\n  }\n\n  /** Temporarily suspends tool selection synchronization until the returned disposable object is disposed. */\n  public suspendIModelToolSelectionSync() {\n    const wasSuspended = this._isSuspended;\n    this._isSuspended = true;\n    return {\n      [Symbol.dispose]: () => {\n        this._isSuspended = wasSuspended;\n      },\n    };\n  }\n\n  private handleUnifiedSelectionChange(changeType: StorageSelectionChangeType, selectables: Selectables, source: string): void {\n    switch (changeType) {\n      case \"clear\":\n        return this.applyCurrentHiliteSet({ activeSelectionAction: \"clearAll\" });\n      case \"replace\":\n        return this.applyCurrentHiliteSet({\n          activeSelectionAction:\n            source === this._selectionSourceName\n              ? is5xSelectionSet(this._imodelAccess.selectionSet)\n                ? // with 5x core we don't need to clear anything when event is triggered by a Tool (hilite and selection sets are in sync already)\n                  \"keep\"\n                : // with 4x core we need to clear hilite set, because it's not synced with selection set\n                  \"clearHilited\"\n              : // when event is triggered not by a Tool, we need to clear everything\n                \"clearAll\",\n        });\n      case \"add\":\n        return void from(this._imodelHiliteSetProvider.getHiliteSetProvider({ imodelKey: this._imodelAccess.key }).getHiliteSet({ selectables }))\n          .pipe(takeUntil(this._cancelOngoingChanges))\n          .subscribe({\n            next: (set) => {\n              this.addHiliteSet(set);\n            },\n          });\n      case \"remove\":\n        return void from(this._imodelHiliteSetProvider.getHiliteSetProvider({ imodelKey: this._imodelAccess.key }).getHiliteSet({ selectables }))\n          .pipe(takeUntil(this._cancelOngoingChanges))\n          .subscribe({\n            next: (set) => {\n              this.removeHiliteSet(set);\n            },\n            complete: () => {\n              this.applyCurrentHiliteSet({ activeSelectionAction: \"keep\" });\n            },\n          });\n    }\n  }\n\n  private onUnifiedSelectionChanged = (args: StorageSelectionChangeEventArgs) => {\n    // iModels are only interested in top-level selection changes\n    if (args.imodelKey !== this._imodelAccess.key || args.level !== 0) {\n      return;\n    }\n\n    if (args.changeType === \"replace\" || args.changeType === \"clear\") {\n      this._cancelOngoingChanges.next();\n    }\n    this.handleUnifiedSelectionChange(args.changeType, args.selectables, args.source);\n  };\n\n  private applyCurrentHiliteSet({ activeSelectionAction }: { activeSelectionAction: \"clearAll\" | \"clearHilited\" | \"keep\" }) {\n    if (activeSelectionAction !== \"keep\") {\n      using _dispose = this.suspendIModelToolSelectionSync();\n      if (!is5xSelectionSet(this._imodelAccess.selectionSet)) {\n        this._imodelAccess.hiliteSet.clear();\n      }\n      if (activeSelectionAction === \"clearAll\") {\n        this._imodelAccess.selectionSet.emptyAll();\n      }\n    }\n\n    from(this._imodelHiliteSetProvider.getCurrentHiliteSet({ imodelKey: this._imodelAccess.key }))\n      .pipe(takeUntil(this._cancelOngoingChanges))\n      .subscribe({\n        next: (ids) => {\n          this.addHiliteSet(ids);\n        },\n      });\n  }\n\n  private addHiliteSet(set: HiliteSet) {\n    using _dispose = this.suspendIModelToolSelectionSync();\n    if (is5xSelectionSet(this._imodelAccess.selectionSet)) {\n      // with 5.x core we can simply add the set as a whole\n      this._imodelAccess.selectionSet.add({\n        models: set.models,\n        subcategories: set.subCategories,\n        elements: set.elements,\n      });\n    } else {\n      // pre-5.0 core requires adding models and subcategories to hilite set separately\n      if (set.models.length) {\n        this._imodelAccess.hiliteSet.models.addIds(set.models);\n      }\n      if (set.subCategories.length) {\n        this._imodelAccess.hiliteSet.subcategories.addIds(set.subCategories);\n      }\n      if (set.elements.length) {\n        this._imodelAccess.hiliteSet.elements.addIds(set.elements);\n        this._imodelAccess.selectionSet.add(set.elements);\n      }\n    }\n  }\n\n  private removeHiliteSet(set: HiliteSet) {\n    using _dispose = this.suspendIModelToolSelectionSync();\n    if (is5xSelectionSet(this._imodelAccess.selectionSet)) {\n      // with 5.x core we can simply remove the set as a whole\n      this._imodelAccess.selectionSet.remove({\n        models: set.models,\n        subcategories: set.subCategories,\n        elements: set.elements,\n      });\n    } else {\n      if (set.models.length) {\n        this._imodelAccess.hiliteSet.models.deleteIds(set.models);\n      }\n      if (set.subCategories.length) {\n        this._imodelAccess.hiliteSet.subcategories.deleteIds(set.subCategories);\n      }\n      if (set.elements.length) {\n        this._imodelAccess.hiliteSet.elements.deleteIds(set.elements);\n        this._imodelAccess.selectionSet.remove(set.elements);\n      }\n    }\n  }\n\n  private onIModelSelectionChanged = async (event: CoreSelectionSetEventUnsafe): Promise<void> => {\n    if (this._isSuspended) {\n      return;\n    }\n\n    if (CoreSelectionSetEventType.Clear === event.type) {\n      this._selectionStorage.clearSelection({ imodelKey: this._imodelAccess.key, source: this._selectionSourceName });\n      return;\n    }\n\n    const ids = this.getSelectionSetChangeIds(event);\n    const scopedSelection = merge(\n      ids.elements\n        ? from(computeSelection({ queryExecutor: this._imodelAccess, elementIds: ids.elements, scope: this._activeScopeProvider() }))\n        : /* c8 ignore next */ EMPTY,\n      ids.models ? from(ids.models).pipe(map((id) => ({ className: \"BisCore.Model\", id }))) : /* c8 ignore next */ EMPTY,\n      ids.subcategories ? from(ids.subcategories).pipe(map((id) => ({ className: \"BisCore.SubCategory\", id }))) : /* c8 ignore next */ EMPTY,\n    );\n    await this.handleIModelSelectionChange(event.type, scopedSelection);\n  };\n\n  private async handleIModelSelectionChange(type: CoreSelectionSetEventType, keys: Observable<SelectableInstanceKey>) {\n    const selectables = await firstValueFrom(keys.pipe(toArray()));\n    const props = {\n      imodelKey: this._imodelAccess.key,\n      source: this._selectionSourceName,\n      selectables,\n    };\n    switch (type) {\n      case CoreSelectionSetEventType.Add:\n        return this._selectionStorage.addToSelection(props);\n      case CoreSelectionSetEventType.Remove:\n        return this._selectionStorage.removeFromSelection(props);\n      case CoreSelectionSetEventType.Replace:\n        return this._selectionStorage.replaceSelection(props);\n    }\n  }\n\n  private getSelectionSetChangeIds(\n    event: Omit<CoreSelectionSetEventUnsafe, \"type\"> & {\n      type: CoreSelectionSetEventType.Add | CoreSelectionSetEventType.Remove | CoreSelectionSetEventType.Replace;\n    },\n  ): CoreSelectableIds {\n    switch (event.type) {\n      case CoreSelectionSetEventType.Add:\n        return event.additions ?? (event.added ? { elements: event.added } : /* c8 ignore next */ {});\n      case CoreSelectionSetEventType.Remove:\n        return event.removals ?? (event.removed ? { elements: event.removed } : /* c8 ignore next */ {});\n      case CoreSelectionSetEventType.Replace:\n        return \"active\" in event.set ? event.set.active : { elements: event.set.elements };\n    }\n  }\n}\n\nfunction is5xSelectionSet(selectionSet: CoreIModelSelectionSet): selectionSet is Omit<CoreIModelSelectionSet, \"add\" | \"remove\"> & {\n  readonly active: { [P in keyof CoreSelectableIds]-?: Id64Set };\n  add: (ids: Id64Arg | CoreSelectableIds) => boolean;\n  remove: (ids: Id64Arg | CoreSelectableIds) => boolean;\n} {\n  return \"active\" in selectionSet;\n}\n\n/* c8 ignore start */\nfunction createIModelHiliteSetProviderFromCachingProvider(\n  cachingHiliteSetProvider: NonNullable<EnableUnifiedSelectionSyncWithIModelProps[\"cachingHiliteSetProvider\"]>,\n  hiliteSetProvider: HiliteSetProvider,\n): IModelHiliteSetProvider {\n  return {\n    getHiliteSetProvider: () => hiliteSetProvider,\n    getCurrentHiliteSet: (props) => cachingHiliteSetProvider.getHiliteSet(props),\n    [Symbol.dispose]: () => {},\n  };\n}\n/* c8 ignore end */\n"]}

package/lib/cjs/unified-selection/IModelHiliteSetProvider.d.ts

@@ -0,0 +1,51 @@
+import "./DisposePolyfill.js";
+import { ECClassHierarchyInspector, ECSqlQueryExecutor } from "@itwin/presentation-shared";
+import { createHiliteSetProvider, HiliteSet, HiliteSetProvider } from "./HiliteSetProvider.js";
+import { SelectionStorage } from "./SelectionStorage.js";
+/**
+ * Props for creating an `IModelHiliteSetProvider` instance.
+ * @public
+ */
+export interface IModelHiliteSetProviderProps {
+    /** Selection storage to use for retrieving the hilite set. */
+    selectionStorage: SelectionStorage;
+    /** A callback that should return iModel access by iModel key. */
+    imodelProvider: (imodelKey: string) => ECClassHierarchyInspector & ECSqlQueryExecutor;
+    /** An optional hilite set provider factory. If not provided, defaults to `createHiliteSetProvider` from this package. */
+    createHiliteSetProvider?: typeof createHiliteSetProvider;
+}
+/**
+ * Defines return value of `createIModelHiliteSetProvider`.
+ *
+ * **Warning:** Used in public API as a return value. Not expected to be created / extended by package
+ * consumers, may be supplemented with required attributes any time.
+ *
+ * @see `createIModelHiliteSetProvider`
+ * @public
+ */
+export interface IModelHiliteSetProvider {
+    /** Get the hilite set provider for the specified iModel. */
+    getHiliteSetProvider(props: {
+        /** iModel to get hilite set provider for */
+        imodelKey: string;
+    }): HiliteSetProvider;
+    /** Get the hilite set iterator for active selection in the specified iModel. */
+    getCurrentHiliteSet(props: {
+        /** iModel to get hilite set for */
+        imodelKey: string;
+    }): AsyncIterableIterator<HiliteSet>;
+    /**
+     * Disposes the cache.
+     */
+    [Symbol.dispose]: () => void;
+}
+/**
+ * Creates a hilite set provider that can efficiently get a hilite set for the "active" selection in an iModel.
+ *
+ * This specific implementation caches the hilite set for the current selection, so subsequent hilite set
+ * requests for the same iModel, don't cost until selection changes.
+ *
+ * @public
+ */
+export declare function createIModelHiliteSetProvider(props: IModelHiliteSetProviderProps): IModelHiliteSetProvider;
+//# sourceMappingURL=IModelHiliteSetProvider.d.ts.map

package/lib/cjs/unified-selection/IModelHiliteSetProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModelHiliteSetProvider.d.ts","sourceRoot":"","sources":["../../../src/unified-selection/IModelHiliteSetProvider.ts"],"names":[],"mappings":"AAKA,OAAO,sBAAsB,CAAC;AAG9B,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAC3F,OAAO,EAAE,uBAAuB,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE/F,OAAO,EAAuC,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAE9F;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C,8DAA8D;IAC9D,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC,iEAAiE;IACjE,cAAc,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,yBAAyB,GAAG,kBAAkB,CAAC;IAEtF,yHAAyH;IACzH,uBAAuB,CAAC,EAAE,OAAO,uBAAuB,CAAC;CAC1D;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,uBAAuB;IACtC,4DAA4D;IAC5D,oBAAoB,CAAC,KAAK,EAAE;QAC1B,4CAA4C;QAC5C,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,iBAAiB,CAAC;IAEtB,gFAAgF;IAChF,mBAAmB,CAAC,KAAK,EAAE;QACzB,mCAAmC;QACnC,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,qBAAqB,CAAC,SAAS,CAAC,CAAC;IAErC;;OAEG;IACH,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;CAC9B;AAED;;;;;;;GAOG;AACH,wBAAgB,6BAA6B,CAAC,KAAK,EAAE,4BAA4B,GAAG,uBAAuB,CAE1G"}

package/lib/cjs/unified-selection/IModelHiliteSetProvider.js

@@ -0,0 +1,65 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createIModelHiliteSetProvider = createIModelHiliteSetProvider;
+require("./DisposePolyfill.js");
+const rxjs_1 = require("rxjs");
+const rxjs_for_await_1 = require("rxjs-for-await");
+const HiliteSetProvider_js_1 = require("./HiliteSetProvider.js");
+const SelectionStorage_js_1 = require("./SelectionStorage.js");
+/**
+ * Creates a hilite set provider that can efficiently get a hilite set for the "active" selection in an iModel.
+ *
+ * This specific implementation caches the hilite set for the current selection, so subsequent hilite set
+ * requests for the same iModel, don't cost until selection changes.
+ *
+ * @public
+ */
+function createIModelHiliteSetProvider(props) {
+    return new IModelHiliteSetProviderImpl(props);
+}
+class IModelHiliteSetProviderImpl {
+    _selectionStorage;
+    _hiliteSetProviders = new Map();
+    _cache = new Map();
+    _removeListener;
+    _imodelProvider;
+    _createHiliteSetProvider;
+    constructor(props) {
+        this._selectionStorage = props.selectionStorage;
+        this._imodelProvider = props.imodelProvider;
+        this._removeListener = this._selectionStorage.selectionChangeEvent.addListener((args) => {
+            this._cache.delete(args.imodelKey);
+            if (args.changeType === "clear" && args.source === SelectionStorage_js_1.IMODEL_CLOSE_SELECTION_CLEAR_SOURCE) {
+                this._hiliteSetProviders.delete(args.imodelKey);
+            }
+        });
+        this._createHiliteSetProvider = props.createHiliteSetProvider ?? /* c8 ignore next */ HiliteSetProvider_js_1.createHiliteSetProvider;
+    }
+    getHiliteSetProvider({ imodelKey }) {
+        let provider = this._hiliteSetProviders.get(imodelKey);
+        if (!provider) {
+            provider = this._createHiliteSetProvider({ imodelAccess: this._imodelProvider(imodelKey) });
+            this._hiliteSetProviders.set(imodelKey, provider);
+        }
+        return provider;
+    }
+    getCurrentHiliteSet({ imodelKey }) {
+        let hiliteSet = this._cache.get(imodelKey);
+        if (!hiliteSet) {
+            const selectables = this._selectionStorage.getSelection({ imodelKey });
+            hiliteSet = (0, rxjs_1.from)(this.getHiliteSetProvider({ imodelKey }).getHiliteSet({ selectables })).pipe((0, rxjs_1.shareReplay)({ refCount: true }));
+            this._cache.set(imodelKey, hiliteSet);
+        }
+        return (0, rxjs_for_await_1.eachValueFrom)(hiliteSet);
+    }
+    [Symbol.dispose]() {
+        this._removeListener();
+        this._hiliteSetProviders = new Map();
+        this._cache = new Map();
+    }
+}
+//# sourceMappingURL=IModelHiliteSetProvider.js.map