@itwin/unified-selection 1.1.2 → 1.2.1

package/CHANGELOG.md

@@ -1,5 +1,42 @@
 # @itwin/unified-selection
 
+## 1.2.1
+
+### Patch Changes
+
+- [#828](https://github.com/iTwin/presentation/pull/828): Polyfill `Symbol.dispose` and `Symbol.asyncDispose` to make sure that code using the upcoming JS recource management API works in all environments.
+
+## 1.2.0
+
+### Minor Changes
+
+- [#800](https://github.com/iTwin/presentation/pull/800): Add support for Models and SubCategories selection that's going to be available in `@itwin/core-frontend` version `5`.
+
+  The changes in `@itwin/core-frontend` allow us to stop manually syncing `HiliteSet` with `SelectionSet` and rely on automatic syncing instead.
+
+- [#800](https://github.com/iTwin/presentation/pull/800): `computeSelection`: Broadened the type of `elementIds` prop from `Id64String[]` to `Id64Arg`.
+- [#802](https://github.com/iTwin/presentation/pull/802): Prefer `Symbol.dispose` over `dispose` for disposable objects.
+
+  The package contained a number of types for disposable objects, that had a requirement of `dispose` method being called on them after they are no longer needed. In conjunction with the `using` utility from `@itwin/core-bentley`, usage of such objects looked like this:
+
+  ```ts
+  class MyDisposable() {
+    dispose() {
+      // do some cleanup
+    }
+  }
+  using(new MyDisposable(), (obj) => {
+    // do something with obj, it'll get disposed when the callback returns
+  });
+  ```
+
+  In version `5.2`, TypeScript [introduced](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-2.html#using-declarations-and-explicit-resource-management) `Disposable` type and `using` declarations (from the upcoming [Explicit Resource Management](https://github.com/tc39/proposal-explicit-resource-management) feature in ECMAScript). Now we're making use of those new utilities in this package (while still supporting the old `dispose` method), which allows using `MyDisposable` from the above snippet like this:
+
+  ```ts
+  using obj = new MyDisposable();
+  // do something with obj, it'll get disposed when it goes out of scope
+  ```
+
 ## 1.1.2
 
 ### Patch Changes

package/README.md

@@ -32,8 +32,9 @@ const unifiedSelection = createStore();
 
 // the store should to be cleaned up when iModels are closed to free up memory, e.g.:
 import { IModelConnection } from "@itwin/core-frontend";
+import { createIModelKey } from "@itwin/presentation-core-interop";
 IModelConnection.onClose.addListener((imodel) => {
-  unifiedSelection.clearStorage(imodel.key);
+  unifiedSelection.clearStorage(createIModelKey(imodel));
 });
 
 // add a demo selection listener
@@ -59,7 +60,7 @@ unifiedSelection.selectionChangeEvent.addListener(({ imodelKey, source, changeTy
 
 // in some component
 MyComponent.onECInstanceSelected((imodel: IModelConnection, key: { className: string; id: Id64String }) => {
-  unifiedSelection.addToSelection({ imodelKey: imodel.key, source: "MyComponent", selectables: [key] });
+  unifiedSelection.addToSelection({ imodelKey: createIModelKey(imodel), source: "MyComponent", selectables: [key] });
 });
 ```
 
@@ -111,6 +112,8 @@ The `@itwin/unified-selection` package delivers APIs for creating a `HiliteSet`
 import { IModelConnection } from "@itwin/core-frontend";
 import { createECSqlQueryExecutor, createECSchemaProvider } from "@itwin/presentation-core-interop";
 import { createHiliteSetProvider } from "@itwin/unified-selection";
+
+const imodel: IModelConnection; // initialized elsewhere
 const hiliteProvider = createHiliteSetProvider({
   imodelAccess: {
     ...createECSchemaProvider(imodel),
@@ -119,17 +122,20 @@ const hiliteProvider = createHiliteSetProvider({
 });
 const hiliteSet = await hiliteProvider.getHiliteSet({ selectables });
 
-// Some others may want to get a hilite set for _current_ selection in storage - use `createCachingHiliteSetProvider` for that. It's
-// recommended to keep a single instance of this provider per application as it caches hilite sets per each iModel's selection.
+// Some others may want to get a hilite set for _current_ selection for specific iModel in storage - use `createCachingHiliteSetProvider`
+// for that. It's recommended to keep a single instance of this provider per application as it caches hilite sets per each iModel's selection.
 import { createCachingHiliteSetProvider } from "@itwin/unified-selection";
-const selectionHiliteProvider = createCachingHiliteSetProvider({
+import { createIModelKey } from "@itwin/presentation-core-interop";
+
+// Note the use of `using` keyword here. The caching provider registers a selection change listener and should be disposed, in case
+// its lifetime is shorter than that of `SelectionStorage`, to unregister the listener. The `using` keyword ensures that the provider
+// is disposed when it goes out of scope.
+using selectionHiliteProvider = createCachingHiliteSetProvider({
   selectionStorage,
-  imodelProvider: (imodelKey: string) => getIModelByKey(imodelKey),
+  // this is called to get iModel access based on the iModel key, used to get hilite set for that iModel (see below)
+  imodelProvider: (imodelKey) => getIModelByKey(imodelKey),
 });
-const selectionHiliteSet = await selectionHiliteProvider.getHiliteSet({ imodel.key });
-// The caching provider registers a selection change listener and should be disposed, in case its lifetime
-// is shorter than that of `SelectionStorage`, to unregister the listener.
-selectionHiliteProvider.dispose();
+const selectionHiliteSet = await selectionHiliteProvider.getHiliteSet({ imodelKey: createIModelKey(imodel) });
 ```
 
 ### Selection scopes
@@ -171,13 +177,13 @@ const selection = computeSelection({ queryExecutor, elementIds, scope: { id: "el
 The `@itwin/unified-selection` package delivers a `enableUnifiedSelectionSyncWithIModel` function to enable selection synchronization between an iModel and a `SelectionStorage`. When called, it returns a cleanup function that should be used to disable the synchronization. There should only be one active synchronization between a single iModel and a `SelectionStorage` at a given time. For example, this function could be used inside a `useEffect` hook in a component that holds an iModel:
 
 ```ts
-import { createECSqlQueryExecutor, createECSchemaProvider } from "@itwin/presentation-core-interop";
+import { createECSqlQueryExecutor, createECSchemaProvider, createIModelKey } from "@itwin/presentation-core-interop";
 useEffect(() => {
   return enableUnifiedSelectionSyncWithIModel({
     imodelAccess: {
       ...createECSqlQueryExecutor(imodel),
       ...createECSchemaProvider(imodel),
-      key: imodel.key,
+      key: createIModelKey(imodel),
       hiliteSet: imodel.hilited,
       selectionSet: imodel.selectionSet,
     },

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

@@ -1,3 +1,4 @@
+import "./DisposePolyfill.js";
 import { ECClassHierarchyInspector, ECSqlQueryExecutor } from "@itwin/presentation-shared";
 import { HiliteSet } from "./HiliteSetProvider.js";
 import { SelectionStorage } from "./SelectionStorage.js";
@@ -26,7 +27,17 @@ export interface CachingHiliteSetProvider {
         /** iModel to get hilite set for */
         imodelKey: string;
     }): AsyncIterableIterator<HiliteSet>;
-    /** Disposes the cache. */
+    /**
+     * Disposes the cache.
+     *
+     * Optional to avoid breaking the API. Will be made required when the deprecated
+     * `dispose` is removed.
+     */
+    [Symbol.dispose]?: () => void;
+    /**
+     * Disposes the cache.
+     * @deprecated in 1.2. Use `[Symbol.dispose]` instead.
+     */
     dispose(): void;
 }
 /**
@@ -34,5 +45,7 @@ export interface CachingHiliteSetProvider {
  * hilite set requests for the same iModel don't cost until selection in given selection storage changes.
  * @public
  */
-export declare function createCachingHiliteSetProvider(props: CachingHiliteSetProviderProps): CachingHiliteSetProvider;
+export declare function createCachingHiliteSetProvider(props: CachingHiliteSetProviderProps): CachingHiliteSetProvider & {
+    [Symbol.dispose]: () => void;
+};
 //# sourceMappingURL=CachingHiliteSetProvider.d.ts.map

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":"AAOA,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAC3F,OAAO,EAA2B,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;IACnC,iEAAiE;IACjE,cAAc,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,yBAAyB,GAAG,kBAAkB,CAAC;CACvF;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,0BAA0B;IAC1B,OAAO,IAAI,IAAI,CAAC;CACjB;AAED;;;;GAIG;AACH,wBAAgB,8BAA8B,CAAC,KAAK,EAAE,6BAA6B,GAAG,wBAAwB,CAE7G"}
+{"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,EAA2B,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;IACnC,iEAAiE;IACjE,cAAc,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,yBAAyB,GAAG,kBAAkB,CAAC;CACvF;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"}

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

@@ -5,6 +5,7 @@
  *--------------------------------------------------------------------------------------------*/
 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");
@@ -44,11 +45,15 @@ class CachingHiliteSetProviderImpl {
         }
         return (0, rxjs_for_await_1.eachValueFrom)(hiliteSet);
     }
-    dispose() {
+    [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) {

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;;AA6ChG,wEAEC;AA7CD,+BAAqD;AACrD,mDAA+C;AAE/C,iEAA+F;AAE/F,+DAA8F;AAiC9F;;;;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;IAE/F,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;IACL,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,OAAO;QACZ,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;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,IAAA,8CAAuB,EAAC,EAAE,YAAY,EAAE,CAAC,CAAC;YACrD,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 { 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  /** A callback that should return iModel access by iModel key. */\n  imodelProvider: (imodelKey: string) => ECClassHierarchyInspector & ECSqlQueryExecutor;\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  /** Disposes the cache. */\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 {\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\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  }\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 dispose(): void {\n    this._removeListener();\n    this._hiliteSetProviders = new Map();\n    this._cache = new Map();\n  }\n\n  private getHiliteSetProvider(imodelKey: string, imodelAccess: ECClassHierarchyInspector & ECSqlQueryExecutor) {\n    let provider = this._hiliteSetProviders.get(imodelKey);\n    if (!provider) {\n      provider = 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;;AAyDhG,wEAEC;AAzDD,gCAA8B;AAC9B,+BAAqD;AACrD,mDAA+C;AAE/C,iEAA+F;AAE/F,+DAA8F;AA4C9F;;;;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;IAE/F,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;IACL,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,IAAA,8CAAuB,EAAC,EAAE,YAAY,EAAE,CAAC,CAAC;YACrD,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  /** A callback that should return iModel access by iModel key. */\n  imodelProvider: (imodelKey: string) => ECClassHierarchyInspector & ECSqlQueryExecutor;\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\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  }\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 = createHiliteSetProvider({ imodelAccess });\n      this._hiliteSetProviders.set(imodelKey, provider);\n    }\n    return provider;\n  }\n}\n"]}

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

@@ -0,0 +1 @@
+//# sourceMappingURL=DisposePolyfill.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DisposePolyfill.d.ts","sourceRoot":"","sources":["../../../src/unified-selection/DisposePolyfill.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,11 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/**
+ * Polyfill for upcoming resource management feature: https://github.com/tc39/proposal-explicit-resource-management
+ */
+Symbol.dispose ??= Symbol("Symbol.dispose");
+Symbol.asyncDispose ??= Symbol("Symbol.asyncDispose");
+//# sourceMappingURL=DisposePolyfill.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DisposePolyfill.js","sourceRoot":"","sources":["../../../src/unified-selection/DisposePolyfill.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;AAEhG;;GAEG;AACF,MAAc,CAAC,OAAO,KAAK,MAAM,CAAC,gBAAgB,CAAC,CAAC;AACpD,MAAc,CAAC,YAAY,KAAK,MAAM,CAAC,qBAAqB,CAAC,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\n/**\n * Polyfill for upcoming resource management feature: https://github.com/tc39/proposal-explicit-resource-management\n */\n(Symbol as any).dispose ??= Symbol(\"Symbol.dispose\");\n(Symbol as any).asyncDispose ??= Symbol(\"Symbol.asyncDispose\");\n"]}

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

@@ -1,3 +1,4 @@
+import "./DisposePolyfill.js";
 import { ECClassHierarchyInspector, ECSqlQueryExecutor } from "@itwin/presentation-shared";
 import { CachingHiliteSetProvider } from "./CachingHiliteSetProvider.js";
 import { ComputeSelectionProps } from "./SelectionScope.js";
@@ -15,7 +16,7 @@ export interface EnableUnifiedSelectionSyncWithIModelProps {
      * `hilited` and `selectionSet` attributes like this:
      *
      * ```ts
-     * import { createECSqlQueryExecutor, createECSchemaProvider } from "@itwin/presentation-core-interop";
+     * import { createECSqlQueryExecutor, createECSchemaProvider, createIModelKey } from "@itwin/presentation-core-interop";
      * import { createCachingECClassHierarchyInspector } from "@itwin/presentation-shared";
      * import { IModelConnection } from "@itwin/core-frontend";
      *
@@ -23,7 +24,7 @@ export interface EnableUnifiedSelectionSyncWithIModelProps {
      * const imodelAccess = {
      *   ...createECSqlQueryExecutor(imodel),
      *   ...createCachingECClassHierarchyInspector({ schemaProvider: createECSchemaProvider(MyAppFrontend.getSchemaContext(imodel)) }),
-     *   key: imodel.key,
+     *   key: createIModelKey(imodel),
      *   hiliteSet: imodel.hilited,
      *   selectionSet: imodel.selectionSet,
      * };
@@ -46,8 +47,13 @@ export interface EnableUnifiedSelectionSyncWithIModelProps {
      * will be created for the given iModel using the provided `imodelAccess`.
      * If the consuming application already has a `CachingHiliteSetProvider` defined, it should be provided instead
      * to reuse the cache and avoid creating new providers for each iModel.
+     *
+     * 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.
      */
-    cachingHiliteSetProvider?: CachingHiliteSetProvider;
+    cachingHiliteSetProvider?: CachingHiliteSetProvider | (Omit<CachingHiliteSetProvider, "dispose"> & {
+        [Symbol.dispose]: () => void;
+    });
 }
 /**
  * Enables synchronization between iModel selection and unified selection.
@@ -69,14 +75,14 @@ export declare class IModelSelectionHandler {
     private _activeScopeProvider;
     private _isSuspended;
     private _cancelOngoingChanges;
-    private _unifiedSelectionListenerDisposeFunc;
-    private _imodelListenerDisposeFunc;
+    private _unregisterUnifiedSelectionListener;
+    private _unregisterIModelSelectionSetListener;
     private _hasCustomCachingHiliteSetProvider;
     constructor(props: EnableUnifiedSelectionSyncWithIModelProps);
-    dispose(): void;
-    /** Temporarily suspends tool selection synchronization until the returned `IDisposable` is disposed. */
+    [Symbol.dispose](): void;
+    /** Temporarily suspends tool selection synchronization until the returned disposable object is disposed. */
     suspendIModelToolSelectionSync(): {
-        dispose: () => boolean;
+        [Symbol.dispose]: () => void;
     };
     private handleUnifiedSelectionChange;
     private onUnifiedSelectionChanged;
@@ -86,6 +92,5 @@ export declare class IModelSelectionHandler {
     private onIModelSelectionChanged;
     private handleIModelSelectionChange;
     private getSelectionSetChangeIds;
-    private idArgToIds;
 }
 //# sourceMappingURL=EnableUnifiedSelectionSyncWithIModel.d.ts.map

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":"AAOA,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAC3F,OAAO,EAAE,wBAAwB,EAAkC,MAAM,+BAA+B,CAAC;AAIzG,OAAO,EAAoB,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,sBAAsB,EAA0D,MAAM,mBAAmB,CAAC;AAExI;;;GAGG;AACH,MAAM,WAAW,yCAAyC;IACxD;;;;;;;;;;;;;;;;;;;;OAoBG;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,qEAAqE;IACrE,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC,6BAA6B;IAC7B,mBAAmB,EAAE,MAAM,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAE1D;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,wBAAwB,CAAC;CACrD;AAED;;;;GAIG;AACH,wBAAgB,oCAAoC,CAAC,KAAK,EAAE,yCAAyC,GAAG,MAAM,IAAI,CAGjH;AAED;;;;GAIG;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,CAA2B;IAC5D,OAAO,CAAC,oBAAoB,CAAuC;IAEnE,OAAO,CAAC,YAAY,CAAU;IAC9B,OAAO,CAAC,qBAAqB,CAAuB;IACpD,OAAO,CAAC,oCAAoC,CAAa;IACzD,OAAO,CAAC,0BAA0B,CAAa;IAC/C,OAAO,CAAC,kCAAkC,CAAU;gBAEjC,KAAK,EAAE,yCAAyC;IAuB5D,OAAO;IASd,wGAAwG;IACjG,8BAA8B;;;IAQrC,OAAO,CAAC,4BAA4B;IA6BpC,OAAO,CAAC,yBAAyB,CAU/B;IAEF,OAAO,CAAC,qBAAqB;IAmB7B,OAAO,CAAC,YAAY;IAepB,OAAO,CAAC,eAAe;IAevB,OAAO,CAAC,wBAAwB,CAa9B;YAEY,2BAA2B;IAoBzC,OAAO,CAAC,wBAAwB;IAYhC,OAAO,CAAC,UAAU;CASnB"}
+{"version":3,"file":"EnableUnifiedSelectionSyncWithIModel.d.ts","sourceRoot":"","sources":["../../../src/unified-selection/EnableUnifiedSelectionSyncWithIModel.ts"],"names":[],"mappings":"AAKA,OAAO,sBAAsB,CAAC;AAE9B,OAAO,EAAE,yBAAyB,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAC3F,OAAO,EAAE,wBAAwB,EAAkC,MAAM,+BAA+B,CAAC;AAIzG,OAAO,EAAoB,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,sBAAsB,EAA6E,MAAM,mBAAmB,CAAC;AAG3J;;;GAGG;AACH,MAAM,WAAW,yCAAyC;IACxD;;;;;;;;;;;;;;;;;;;;OAoBG;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,qEAAqE;IACrE,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC,6BAA6B;IAC7B,mBAAmB,EAAE,MAAM,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAE1D;;;;;;;;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;;;;GAIG;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,CAAuC;IAEnE,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;IAqB5D,CAAC,MAAM,CAAC,OAAO,CAAC;IASvB,4GAA4G;IACrG,8BAA8B;;;IAUrC,OAAO,CAAC,4BAA4B;IA2BpC,OAAO,CAAC,yBAAyB,CAU/B;IAEF,OAAO,CAAC,qBAAqB;IAgB7B,OAAO,CAAC,YAAY;IAwBpB,OAAO,CAAC,eAAe;IAuBvB,OAAO,CAAC,wBAAwB,CAmB9B;YAEY,2BAA2B;IAiBzC,OAAO,CAAC,wBAAwB;CAcjC"}