@itwin/unified-selection 0.1.0 → 0.3.0

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

@@ -1,31 +1,33 @@
-/** @packageDocumentation
- * @module UnifiedSelection
- */
 import { Selectable, Selectables } from "./Selectable";
 import { SelectionChangeEvent } from "./SelectionChangeEvent";
+type IModelKeyProp = {
+    /** Key of the iModel to get selection levels for. */
+    imodelKey: string;
+} | {
+    /**
+     * Key of the iModel to get selection levels for.
+     * @deprecated in 0.2. Use `imodelKey` instead.
+     */
+    iModelKey: string;
+};
 /**
- * Selection storage interface which provides main selection and sub-selection.
- * @beta
+ * Defines return value of `createStorage`.
+ *
+ * @beta 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.
  */
 export interface SelectionStorage {
     /** An event that is raised when selection changes. */
     selectionChangeEvent: SelectionChangeEvent;
     /** Get the selection levels currently stored for the specified iModel. */
-    getSelectionLevels(props: {
-        /** Key of the iModel to get selection levels for. */
-        iModelKey: string;
-    }): number[];
+    getSelectionLevels(props: IModelKeyProp): number[];
     /** Get the selection stored in the storage. */
-    getSelection(props: {
-        /** Key of the iModel to get selection for. */
-        iModelKey: string;
+    getSelection(props: IModelKeyProp & {
         /** Level of the selection. Defaults to `0`. */
         level?: number;
     }): Selectables;
     /** Add keys to the selection. */
-    addToSelection(props: {
-        /** Key of the iModel to change selection for. */
-        iModelKey: string;
+    addToSelection(props: IModelKeyProp & {
         /** Name of the selection source. Generally, this identifies the component that makes the selection change. */
         source: string;
         /** The selectables to add to selection. */
@@ -34,9 +36,7 @@ export interface SelectionStorage {
         level?: number;
     }): void;
     /** Remove keys from current selection. */
-    removeFromSelection(props: {
-        /** Key of the iModel to change selection for. */
-        iModelKey: string;
+    removeFromSelection(props: IModelKeyProp & {
         /** Name of the selection source. Generally, this identifies the component that makes the selection change. */
         source: string;
         /** The selectables to remove from selection. */
@@ -45,9 +45,7 @@ export interface SelectionStorage {
         level?: number;
     }): void;
     /** Replace current selection. */
-    replaceSelection(props: {
-        /** Key of the iModel to change selection for. */
-        iModelKey: string;
+    replaceSelection(props: IModelKeyProp & {
         /** Name of the selection source. Generally, this identifies the component that makes the selection change. */
         source: string;
         /** The selectables to add to selection. */
@@ -56,23 +54,30 @@ export interface SelectionStorage {
         level?: number;
     }): void;
     /** Clear current selection. */
-    clearSelection(props: {
-        /** Key of the iModel to change selection for. */
-        iModelKey: string;
+    clearSelection(props: IModelKeyProp & {
         /** Name of the selection source. Generally, this identifies the component that makes the selection change. */
         source: string;
         /** Level of the selection. Defaults to `0`. */
         level?: number;
     }): void;
     /** Clear storage for an iModel. This function should be called when iModel is closed. */
-    clearStorage(props: {
-        /** Key of the iModel to change selection for. */
-        iModelKey: string;
-    }): void;
+    clearStorage(props: IModelKeyProp): void;
 }
 /**
- * Creates a selection storage. When an iModel is closed `SelectionStorage.clearSelection` function should be called.
+ * Creates a selection storage which stores and allows managing application-level selection.
+ *
+ * **Note:** `clearSelection` should be called upon iModel close to free-up memory:
+ * ```ts
+ * import { IModelConnection } from "@itwin/core-frontend";
+ * IModelConnection.onClose.addListener((imodel) => {
+ *   storage.clearStorage(imodel.key);
+ * });
+ * ```
+ *
  * @beta
  */
 export declare function createStorage(): SelectionStorage;
+/** @internal */
+export declare const IMODEL_CLOSE_SELECTION_CLEAR_SOURCE = "Unified selection storage: clear";
+export {};
 //# sourceMappingURL=SelectionStorage.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"SelectionStorage.d.ts","sourceRoot":"","sources":["../../../src/unified-selection/SelectionStorage.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAyF,MAAM,wBAAwB,CAAC;AAErJ;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,sDAAsD;IACtD,oBAAoB,EAAE,oBAAoB,CAAC;IAE3C,0EAA0E;IAC1E,kBAAkB,CAAC,KAAK,EAAE;QACxB,qDAAqD;QACrD,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,MAAM,EAAE,CAAC;IAEb,+CAA+C;IAC/C,YAAY,CAAC,KAAK,EAAE;QAClB,8CAA8C;QAC9C,SAAS,EAAE,MAAM,CAAC;QAClB,+CAA+C;QAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GAAG,WAAW,CAAC;IAEhB,iCAAiC;IACjC,cAAc,CAAC,KAAK,EAAE;QACpB,iDAAiD;QACjD,SAAS,EAAE,MAAM,CAAC;QAClB,8GAA8G;QAC9G,MAAM,EAAE,MAAM,CAAC;QACf,2CAA2C;QAC3C,WAAW,EAAE,UAAU,EAAE,CAAC;QAC1B,+CAA+C;QAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GAAG,IAAI,CAAC;IAET,0CAA0C;IAC1C,mBAAmB,CAAC,KAAK,EAAE;QACzB,iDAAiD;QACjD,SAAS,EAAE,MAAM,CAAC;QAClB,8GAA8G;QAC9G,MAAM,EAAE,MAAM,CAAC;QACf,gDAAgD;QAChD,WAAW,EAAE,UAAU,EAAE,CAAC;QAC1B,+CAA+C;QAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GAAG,IAAI,CAAC;IAET,iCAAiC;IACjC,gBAAgB,CAAC,KAAK,EAAE;QACtB,iDAAiD;QACjD,SAAS,EAAE,MAAM,CAAC;QAClB,8GAA8G;QAC9G,MAAM,EAAE,MAAM,CAAC;QACf,2CAA2C;QAC3C,WAAW,EAAE,UAAU,EAAE,CAAC;QAC1B,+CAA+C;QAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GAAG,IAAI,CAAC;IAET,+BAA+B;IAC/B,cAAc,CAAC,KAAK,EAAE;QACpB,iDAAiD;QACjD,SAAS,EAAE,MAAM,CAAC;QAClB,8GAA8G;QAC9G,MAAM,EAAE,MAAM,CAAC;QACf,+CAA+C;QAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GAAG,IAAI,CAAC;IAET,yFAAyF;IACzF,YAAY,CAAC,KAAK,EAAE;QAClB,iDAAiD;QACjD,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,IAAI,CAAC;CACV;AAED;;;GAGG;AACH,wBAAgB,aAAa,IAAI,gBAAgB,CAEhD"}
+{"version":3,"file":"SelectionStorage.d.ts","sourceRoot":"","sources":["../../../src/unified-selection/SelectionStorage.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAyF,MAAM,wBAAwB,CAAC;AAErJ,KAAK,aAAa,GACd;IACE,qDAAqD;IACrD,SAAS,EAAE,MAAM,CAAC;CACnB,GACD;IACE;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEN;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,sDAAsD;IACtD,oBAAoB,EAAE,oBAAoB,CAAC;IAE3C,0EAA0E;IAC1E,kBAAkB,CAAC,KAAK,EAAE,aAAa,GAAG,MAAM,EAAE,CAAC;IAEnD,+CAA+C;IAC/C,YAAY,CACV,KAAK,EAAE,aAAa,GAAG;QACrB,+CAA+C;QAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GACA,WAAW,CAAC;IAEf,iCAAiC;IACjC,cAAc,CACZ,KAAK,EAAE,aAAa,GAAG;QACrB,8GAA8G;QAC9G,MAAM,EAAE,MAAM,CAAC;QACf,2CAA2C;QAC3C,WAAW,EAAE,UAAU,EAAE,CAAC;QAC1B,+CAA+C;QAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GACA,IAAI,CAAC;IAER,0CAA0C;IAC1C,mBAAmB,CACjB,KAAK,EAAE,aAAa,GAAG;QACrB,8GAA8G;QAC9G,MAAM,EAAE,MAAM,CAAC;QACf,gDAAgD;QAChD,WAAW,EAAE,UAAU,EAAE,CAAC;QAC1B,+CAA+C;QAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GACA,IAAI,CAAC;IAER,iCAAiC;IACjC,gBAAgB,CACd,KAAK,EAAE,aAAa,GAAG;QACrB,8GAA8G;QAC9G,MAAM,EAAE,MAAM,CAAC;QACf,2CAA2C;QAC3C,WAAW,EAAE,UAAU,EAAE,CAAC;QAC1B,+CAA+C;QAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GACA,IAAI,CAAC;IAER,+BAA+B;IAC/B,cAAc,CACZ,KAAK,EAAE,aAAa,GAAG;QACrB,8GAA8G;QAC9G,MAAM,EAAE,MAAM,CAAC;QACf,+CAA+C;QAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GACA,IAAI,CAAC;IAER,yFAAyF;IACzF,YAAY,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI,CAAC;CAC1C;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,IAAI,gBAAgB,CAEhD;AAED,gBAAgB;AAChB,eAAO,MAAM,mCAAmC,qCAAqC,CAAC"}

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

@@ -4,32 +4,39 @@
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createStorage = void 0;
-/** @packageDocumentation
- * @module UnifiedSelection
- */
+exports.IMODEL_CLOSE_SELECTION_CLEAR_SOURCE = exports.createStorage = void 0;
 const Selectable_1 = require("./Selectable");
 const SelectionChangeEvent_1 = require("./SelectionChangeEvent");
 /**
- * Creates a selection storage. When an iModel is closed `SelectionStorage.clearSelection` function should be called.
+ * Creates a selection storage which stores and allows managing application-level selection.
+ *
+ * **Note:** `clearSelection` should be called upon iModel close to free-up memory:
+ * ```ts
+ * import { IModelConnection } from "@itwin/core-frontend";
+ * IModelConnection.onClose.addListener((imodel) => {
+ *   storage.clearStorage(imodel.key);
+ * });
+ * ```
+ *
  * @beta
  */
 function createStorage() {
     return new SelectionStorageImpl();
 }
 exports.createStorage = createStorage;
+/** @internal */
+exports.IMODEL_CLOSE_SELECTION_CLEAR_SOURCE = "Unified selection storage: clear";
 class SelectionStorageImpl {
     _storage = new Map();
     selectionChangeEvent;
     constructor() {
         this.selectionChangeEvent = new SelectionChangeEvent_1.SelectionChangeEventImpl();
     }
-    getSelectionLevels({ iModelKey }) {
-        return this.getContainer(iModelKey).getSelectionLevels();
+    getSelectionLevels(props) {
+        return this.getContainer(getIModelKey(props)).getSelectionLevels();
     }
     getSelection(props) {
-        const { iModelKey, level } = props;
-        return this.getContainer(iModelKey).getSelection(level ?? 0);
+        return this.getContainer(getIModelKey(props)).getSelection(props.level ?? 0);
     }
     addToSelection(props) {
         this.handleChange({ ...props, changeType: "add" });
@@ -43,21 +50,23 @@ class SelectionStorageImpl {
     clearSelection(props) {
         this.handleChange({ ...props, changeType: "clear", selectables: [] });
     }
-    clearStorage({ iModelKey }) {
-        this.clearSelection({ source: "Clear iModel storage", iModelKey });
-        this._storage.delete(iModelKey);
+    clearStorage(props) {
+        const imodelKey = getIModelKey(props);
+        this.clearSelection({ source: exports.IMODEL_CLOSE_SELECTION_CLEAR_SOURCE, imodelKey });
+        this._storage.delete(imodelKey);
     }
-    getContainer(iModelKey) {
-        let selectionContainer = this._storage.get(iModelKey);
+    getContainer(imodelKey) {
+        let selectionContainer = this._storage.get(imodelKey);
         if (!selectionContainer) {
             selectionContainer = new MultiLevelSelectablesContainer();
-            this._storage.set(iModelKey, selectionContainer);
+            this._storage.set(imodelKey, selectionContainer);
         }
         return selectionContainer;
     }
     handleChange(props) {
-        const { iModelKey, source, level: inLevel, changeType, selectables: change } = props;
-        const container = this.getContainer(iModelKey);
+        const { source, level: inLevel, changeType, selectables: change } = props;
+        const imodelKey = getIModelKey(props);
+        const container = this.getContainer(imodelKey);
         const level = inLevel ?? 0;
         const selectables = container.getSelection(level);
         const selected = Selectable_1.Selectables.create(change);
@@ -89,7 +98,8 @@ class SelectionStorageImpl {
         const event = {
             source,
             level,
-            iModelKey,
+            imodelKey,
+            iModelKey: imodelKey,
             changeType,
             selectables: selected,
             timestamp: new Date(),
@@ -97,6 +107,10 @@ class SelectionStorageImpl {
         this.selectionChangeEvent.raiseEvent(event, this);
     }
 }
+function getIModelKey(props) {
+    // eslint-disable-next-line deprecation/deprecation
+    return "imodelKey" in props ? props.imodelKey : props.iModelKey;
+}
 class MultiLevelSelectablesContainer {
     _selectablesContainers;
     constructor() {

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

@@ -1 +1 @@
-{"version":3,"file":"SelectionStorage.js","sourceRoot":"","sources":["../../../src/unified-selection/SelectionStorage.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG;;GAEG;AAEH,6CAAuD;AACvD,iEAAqJ;AA6ErJ;;;GAGG;AACH,SAAgB,aAAa;IAC3B,OAAO,IAAI,oBAAoB,EAAE,CAAC;AACpC,CAAC;AAFD,sCAEC;AAED,MAAM,oBAAoB;IAChB,QAAQ,GAAG,IAAI,GAAG,EAA0C,CAAC;IAC9D,oBAAoB,CAA2B;IAEtD;QACE,IAAI,CAAC,oBAAoB,GAAG,IAAI,+CAAwB,EAAE,CAAC;IAC7D,CAAC;IAEM,kBAAkB,CAAC,EAAE,SAAS,EAAyB;QAC5D,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC3D,CAAC;IAEM,YAAY,CAAC,KAA4C;QAC9D,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;QACnC,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;IAC/D,CAAC;IAEM,cAAc,CAAC,KAAuF;QAC3G,IAAI,CAAC,YAAY,CAAC,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;IACrD,CAAC;IAEM,mBAAmB,CAAC,KAAuF;QAChH,IAAI,CAAC,YAAY,CAAC,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC;IACxD,CAAC;IAEM,gBAAgB,CAAC,KAAuF;QAC7G,IAAI,CAAC,YAAY,CAAC,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;IACzD,CAAC;IAEM,cAAc,CAAC,KAA4D;QAChF,IAAI,CAAC,YAAY,CAAC,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;IACxE,CAAC;IAEM,YAAY,CAAC,EAAE,SAAS,EAAyB;QACtD,IAAI,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,sBAAsB,EAAE,SAAS,EAAE,CAAC,CAAC;QACnE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAClC,CAAC;IAEO,YAAY,CAAC,SAAiB;QACpC,IAAI,kBAAkB,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACtD,IAAI,CAAC,kBAAkB,EAAE;YACvB,kBAAkB,GAAG,IAAI,8BAA8B,EAAE,CAAC;YAC1D,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;SAClD;QACD,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAEO,YAAY,CAAC,KAA+H;QAClJ,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC;QACrF,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAC/C,MAAM,KAAK,GAAG,OAAO,IAAI,CAAC,CAAC;QAC3B,MAAM,WAAW,GAAG,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,wBAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC5C,QAAQ,UAAU,EAAE;YAClB,KAAK,KAAK;gBACR,IAAI,CAAC,wBAAW,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE;oBACzC,OAAO;iBACR;gBACD,MAAM;YACR,KAAK,QAAQ;gBACX,IAAI,CAAC,wBAAW,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE;oBAC5C,OAAO;iBACR;gBACD,MAAM;YACR,KAAK,SAAS;gBACZ,IAAI,wBAAW,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,wBAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,wBAAW,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE;oBAC3G,OAAO;iBACR;gBACD,wBAAW,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;gBAC/B,wBAAW,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;gBACrC,MAAM;YACR,KAAK,OAAO;gBACV,IAAI,CAAC,wBAAW,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE;oBACnC,OAAO;iBACR;gBACD,MAAM;SACT;QACD,SAAS,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QAC3B,MAAM,KAAK,GAAoC;YAC7C,MAAM;YACN,KAAK;YACL,SAAS;YACT,UAAU;YACV,WAAW,EAAE,QAAQ;YACrB,SAAS,EAAE,IAAI,IAAI,EAAE;SACtB,CAAC;QACF,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;CACF;AAED,MAAM,8BAA8B;IACjB,sBAAsB,CAA2B;IAElE;QACE,IAAI,CAAC,sBAAsB,GAAG,IAAI,GAAG,EAAuB,CAAC;IAC/D,CAAC;IAEM,YAAY,CAAC,KAAa;QAC/B,IAAI,WAAW,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACzD,IAAI,CAAC,WAAW,EAAE;YAChB,WAAW,GAAG,wBAAW,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACrC,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;SACrD;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAEM,kBAAkB;QACvB,MAAM,MAAM,GAAG,IAAI,KAAK,EAAU,CAAC;QACnC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE,EAAE;YACzD,IAAI,CAAC,wBAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;gBAClC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;aACvB;SACF;QACD,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,KAAa;QACxB,MAAM,YAAY,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,EAAE,CAAC;QACxD,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;YACtC,IAAI,WAAW,IAAI,KAAK,EAAE;gBACxB,MAAM,WAAW,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,WAAW,CAAE,CAAC;gBAClE,wBAAW,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;aAChC;SACF;IACH,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\n/** @packageDocumentation\n * @module UnifiedSelection\n */\n\nimport { Selectable, Selectables } from \"./Selectable\";\nimport { SelectionChangeEvent, SelectionChangeEventImpl, StorageSelectionChangeEventArgs, StorageSelectionChangeType } from \"./SelectionChangeEvent\";\n\n/**\n * Selection storage interface which provides main selection and sub-selection.\n * @beta\n */\nexport interface SelectionStorage {\n  /** An event that is raised when selection changes. */\n  selectionChangeEvent: SelectionChangeEvent;\n\n  /** Get the selection levels currently stored for the specified iModel. */\n  getSelectionLevels(props: {\n    /** Key of the iModel to get selection levels for. */\n    iModelKey: string;\n  }): number[];\n\n  /** Get the selection stored in the storage. */\n  getSelection(props: {\n    /** Key of the iModel to get selection for. */\n    iModelKey: string;\n    /** Level of the selection. Defaults to `0`. */\n    level?: number;\n  }): Selectables;\n\n  /** Add keys to the selection. */\n  addToSelection(props: {\n    /** Key of the iModel to change selection for. */\n    iModelKey: string;\n    /** Name of the selection source. Generally, this identifies the component that makes the selection change. */\n    source: string;\n    /** The selectables to add to selection. */\n    selectables: Selectable[];\n    /** Level of the selection. Defaults to `0`. */\n    level?: number;\n  }): void;\n\n  /** Remove keys from current selection. */\n  removeFromSelection(props: {\n    /** Key of the iModel to change selection for. */\n    iModelKey: string;\n    /** Name of the selection source. Generally, this identifies the component that makes the selection change. */\n    source: string;\n    /** The selectables to remove from selection. */\n    selectables: Selectable[];\n    /** Level of the selection. Defaults to `0`. */\n    level?: number;\n  }): void;\n\n  /** Replace current selection. */\n  replaceSelection(props: {\n    /** Key of the iModel to change selection for. */\n    iModelKey: string;\n    /** Name of the selection source. Generally, this identifies the component that makes the selection change. */\n    source: string;\n    /** The selectables to add to selection. */\n    selectables: Selectable[];\n    /** Level of the selection. Defaults to `0`. */\n    level?: number;\n  }): void;\n\n  /** Clear current selection. */\n  clearSelection(props: {\n    /** Key of the iModel to change selection for. */\n    iModelKey: string;\n    /** Name of the selection source. Generally, this identifies the component that makes the selection change. */\n    source: string;\n    /** Level of the selection. Defaults to `0`. */\n    level?: number;\n  }): void;\n\n  /** Clear storage for an iModel. This function should be called when iModel is closed. */\n  clearStorage(props: {\n    /** Key of the iModel to change selection for. */\n    iModelKey: string;\n  }): void;\n}\n\n/**\n * Creates a selection storage. When an iModel is closed `SelectionStorage.clearSelection` function should be called.\n * @beta\n */\nexport function createStorage(): SelectionStorage {\n  return new SelectionStorageImpl();\n}\n\nclass SelectionStorageImpl implements SelectionStorage {\n  private _storage = new Map<string, MultiLevelSelectablesContainer>();\n  public selectionChangeEvent: SelectionChangeEventImpl;\n\n  constructor() {\n    this.selectionChangeEvent = new SelectionChangeEventImpl();\n  }\n\n  public getSelectionLevels({ iModelKey }: { iModelKey: string }): number[] {\n    return this.getContainer(iModelKey).getSelectionLevels();\n  }\n\n  public getSelection(props: { iModelKey: string; level?: number }): Selectables {\n    const { iModelKey, level } = props;\n    return this.getContainer(iModelKey).getSelection(level ?? 0);\n  }\n\n  public addToSelection(props: { source: string; iModelKey: string; selectables: Selectable[]; level?: number }): void {\n    this.handleChange({ ...props, changeType: \"add\" });\n  }\n\n  public removeFromSelection(props: { source: string; iModelKey: string; selectables: Selectable[]; level?: number }): void {\n    this.handleChange({ ...props, changeType: \"remove\" });\n  }\n\n  public replaceSelection(props: { source: string; iModelKey: string; selectables: Selectable[]; level?: number }): void {\n    this.handleChange({ ...props, changeType: \"replace\" });\n  }\n\n  public clearSelection(props: { source: string; iModelKey: string; level?: number }): void {\n    this.handleChange({ ...props, changeType: \"clear\", selectables: [] });\n  }\n\n  public clearStorage({ iModelKey }: { iModelKey: string }): void {\n    this.clearSelection({ source: \"Clear iModel storage\", iModelKey });\n    this._storage.delete(iModelKey);\n  }\n\n  private getContainer(iModelKey: string): MultiLevelSelectablesContainer {\n    let selectionContainer = this._storage.get(iModelKey);\n    if (!selectionContainer) {\n      selectionContainer = new MultiLevelSelectablesContainer();\n      this._storage.set(iModelKey, selectionContainer);\n    }\n    return selectionContainer;\n  }\n\n  private handleChange(props: { source: string; iModelKey: string; level?: number; changeType: StorageSelectionChangeType; selectables: Selectable[] }) {\n    const { iModelKey, source, level: inLevel, changeType, selectables: change } = props;\n    const container = this.getContainer(iModelKey);\n    const level = inLevel ?? 0;\n    const selectables = container.getSelection(level);\n    const selected = Selectables.create(change);\n    switch (changeType) {\n      case \"add\":\n        if (!Selectables.add(selectables, change)) {\n          return;\n        }\n        break;\n      case \"remove\":\n        if (!Selectables.remove(selectables, change)) {\n          return;\n        }\n        break;\n      case \"replace\":\n        if (Selectables.size(selectables) === Selectables.size(selected) && Selectables.hasAll(selectables, change)) {\n          return;\n        }\n        Selectables.clear(selectables);\n        Selectables.add(selectables, change);\n        break;\n      case \"clear\":\n        if (!Selectables.clear(selectables)) {\n          return;\n        }\n        break;\n    }\n    container.clear(level + 1);\n    const event: StorageSelectionChangeEventArgs = {\n      source,\n      level,\n      iModelKey,\n      changeType,\n      selectables: selected,\n      timestamp: new Date(),\n    };\n    this.selectionChangeEvent.raiseEvent(event, this);\n  }\n}\n\nclass MultiLevelSelectablesContainer {\n  private readonly _selectablesContainers: Map<number, Selectables>;\n\n  constructor() {\n    this._selectablesContainers = new Map<number, Selectables>();\n  }\n\n  public getSelection(level: number): Selectables {\n    let selectables = this._selectablesContainers.get(level);\n    if (!selectables) {\n      selectables = Selectables.create([]);\n      this._selectablesContainers.set(level, selectables);\n    }\n    return selectables;\n  }\n\n  public getSelectionLevels(): number[] {\n    const levels = new Array<number>();\n    for (const entry of this._selectablesContainers.entries()) {\n      if (!Selectables.isEmpty(entry[1])) {\n        levels.push(entry[0]);\n      }\n    }\n    return levels.sort();\n  }\n\n  public clear(level: number) {\n    const storedLevels = this._selectablesContainers.keys();\n    for (const storedLevel of storedLevels) {\n      if (storedLevel >= level) {\n        const selectables = this._selectablesContainers.get(storedLevel)!;\n        Selectables.clear(selectables);\n      }\n    }\n  }\n}\n"]}
+{"version":3,"file":"SelectionStorage.js","sourceRoot":"","sources":["../../../src/unified-selection/SelectionStorage.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAEhG,6CAAuD;AACvD,iEAAqJ;AAsFrJ;;;;;;;;;;;;GAYG;AACH,SAAgB,aAAa;IAC3B,OAAO,IAAI,oBAAoB,EAAE,CAAC;AACpC,CAAC;AAFD,sCAEC;AAED,gBAAgB;AACH,QAAA,mCAAmC,GAAG,kCAAkC,CAAC;AAEtF,MAAM,oBAAoB;IAChB,QAAQ,GAAG,IAAI,GAAG,EAA0C,CAAC;IAC9D,oBAAoB,CAA2B;IAEtD;QACE,IAAI,CAAC,oBAAoB,GAAG,IAAI,+CAAwB,EAAE,CAAC;IAC7D,CAAC;IAEM,kBAAkB,CAAC,KAAoB;QAC5C,OAAO,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,kBAAkB,EAAE,CAAC;IACrE,CAAC;IAEM,YAAY,CAAC,KAAyC;QAC3D,OAAO,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;IAC/E,CAAC;IAEM,cAAc,CAAC,KAAoF;QACxG,IAAI,CAAC,YAAY,CAAC,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;IACrD,CAAC;IAEM,mBAAmB,CAAC,KAAoF;QAC7G,IAAI,CAAC,YAAY,CAAC,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC;IACxD,CAAC;IAEM,gBAAgB,CAAC,KAAoF;QAC1G,IAAI,CAAC,YAAY,CAAC,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;IACzD,CAAC;IAEM,cAAc,CAAC,KAAyD;QAC7E,IAAI,CAAC,YAAY,CAAC,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;IACxE,CAAC;IAEM,YAAY,CAAC,KAAoB;QACtC,MAAM,SAAS,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QACtC,IAAI,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,2CAAmC,EAAE,SAAS,EAAE,CAAC,CAAC;QAChF,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAClC,CAAC;IAEO,YAAY,CAAC,SAAiB;QACpC,IAAI,kBAAkB,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACtD,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxB,kBAAkB,GAAG,IAAI,8BAA8B,EAAE,CAAC;YAC1D,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;QACnD,CAAC;QACD,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAEO,YAAY,CAAC,KAA4H;QAC/I,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC;QAC1E,MAAM,SAAS,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QACtC,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAC/C,MAAM,KAAK,GAAG,OAAO,IAAI,CAAC,CAAC;QAC3B,MAAM,WAAW,GAAG,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,wBAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC5C,QAAQ,UAAU,EAAE,CAAC;YACnB,KAAK,KAAK;gBACR,IAAI,CAAC,wBAAW,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,CAAC;oBAC1C,OAAO;gBACT,CAAC;gBACD,MAAM;YACR,KAAK,QAAQ;gBACX,IAAI,CAAC,wBAAW,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,CAAC;oBAC7C,OAAO;gBACT,CAAC;gBACD,MAAM;YACR,KAAK,SAAS;gBACZ,IAAI,wBAAW,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,wBAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,wBAAW,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,CAAC;oBAC5G,OAAO;gBACT,CAAC;gBACD,wBAAW,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;gBAC/B,wBAAW,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;gBACrC,MAAM;YACR,KAAK,OAAO;gBACV,IAAI,CAAC,wBAAW,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;oBACpC,OAAO;gBACT,CAAC;gBACD,MAAM;QACV,CAAC;QACD,SAAS,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QAC3B,MAAM,KAAK,GAAoC;YAC7C,MAAM;YACN,KAAK;YACL,SAAS;YACT,SAAS,EAAE,SAAS;YACpB,UAAU;YACV,WAAW,EAAE,QAAQ;YACrB,SAAS,EAAE,IAAI,IAAI,EAAE;SACtB,CAAC;QACF,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;CACF;AAED,SAAS,YAAY,CAAC,KAAoB;IACxC,mDAAmD;IACnD,OAAO,WAAW,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC;AAClE,CAAC;AAED,MAAM,8BAA8B;IACjB,sBAAsB,CAA2B;IAElE;QACE,IAAI,CAAC,sBAAsB,GAAG,IAAI,GAAG,EAAuB,CAAC;IAC/D,CAAC;IAEM,YAAY,CAAC,KAAa;QAC/B,IAAI,WAAW,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACzD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,WAAW,GAAG,wBAAW,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACrC,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;QACtD,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAEM,kBAAkB;QACvB,MAAM,MAAM,GAAG,IAAI,KAAK,EAAU,CAAC;QACnC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE,EAAE,CAAC;YAC1D,IAAI,CAAC,wBAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACnC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACxB,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,KAAa;QACxB,MAAM,YAAY,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,EAAE,CAAC;QACxD,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;YACvC,IAAI,WAAW,IAAI,KAAK,EAAE,CAAC;gBACzB,MAAM,WAAW,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,WAAW,CAAE,CAAC;gBAClE,wBAAW,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YACjC,CAAC;QACH,CAAC;IACH,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 { Selectable, Selectables } from \"./Selectable\";\nimport { SelectionChangeEvent, SelectionChangeEventImpl, StorageSelectionChangeEventArgs, StorageSelectionChangeType } from \"./SelectionChangeEvent\";\n\ntype IModelKeyProp =\n  | {\n      /** Key of the iModel to get selection levels for. */\n      imodelKey: string;\n    }\n  | {\n      /**\n       * Key of the iModel to get selection levels for.\n       * @deprecated in 0.2. Use `imodelKey` instead.\n       */\n      iModelKey: string;\n    };\n\n/**\n * Defines return value of `createStorage`.\n *\n * @beta 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 */\nexport interface SelectionStorage {\n  /** An event that is raised when selection changes. */\n  selectionChangeEvent: SelectionChangeEvent;\n\n  /** Get the selection levels currently stored for the specified iModel. */\n  getSelectionLevels(props: IModelKeyProp): number[];\n\n  /** Get the selection stored in the storage. */\n  getSelection(\n    props: IModelKeyProp & {\n      /** Level of the selection. Defaults to `0`. */\n      level?: number;\n    },\n  ): Selectables;\n\n  /** Add keys to the selection. */\n  addToSelection(\n    props: IModelKeyProp & {\n      /** Name of the selection source. Generally, this identifies the component that makes the selection change. */\n      source: string;\n      /** The selectables to add to selection. */\n      selectables: Selectable[];\n      /** Level of the selection. Defaults to `0`. */\n      level?: number;\n    },\n  ): void;\n\n  /** Remove keys from current selection. */\n  removeFromSelection(\n    props: IModelKeyProp & {\n      /** Name of the selection source. Generally, this identifies the component that makes the selection change. */\n      source: string;\n      /** The selectables to remove from selection. */\n      selectables: Selectable[];\n      /** Level of the selection. Defaults to `0`. */\n      level?: number;\n    },\n  ): void;\n\n  /** Replace current selection. */\n  replaceSelection(\n    props: IModelKeyProp & {\n      /** Name of the selection source. Generally, this identifies the component that makes the selection change. */\n      source: string;\n      /** The selectables to add to selection. */\n      selectables: Selectable[];\n      /** Level of the selection. Defaults to `0`. */\n      level?: number;\n    },\n  ): void;\n\n  /** Clear current selection. */\n  clearSelection(\n    props: IModelKeyProp & {\n      /** Name of the selection source. Generally, this identifies the component that makes the selection change. */\n      source: string;\n      /** Level of the selection. Defaults to `0`. */\n      level?: number;\n    },\n  ): void;\n\n  /** Clear storage for an iModel. This function should be called when iModel is closed. */\n  clearStorage(props: IModelKeyProp): void;\n}\n\n/**\n * Creates a selection storage which stores and allows managing application-level selection.\n *\n * **Note:** `clearSelection` should be called upon iModel close to free-up memory:\n * ```ts\n * import { IModelConnection } from \"@itwin/core-frontend\";\n * IModelConnection.onClose.addListener((imodel) => {\n *   storage.clearStorage(imodel.key);\n * });\n * ```\n *\n * @beta\n */\nexport function createStorage(): SelectionStorage {\n  return new SelectionStorageImpl();\n}\n\n/** @internal */\nexport const IMODEL_CLOSE_SELECTION_CLEAR_SOURCE = \"Unified selection storage: clear\";\n\nclass SelectionStorageImpl implements SelectionStorage {\n  private _storage = new Map<string, MultiLevelSelectablesContainer>();\n  public selectionChangeEvent: SelectionChangeEventImpl;\n\n  constructor() {\n    this.selectionChangeEvent = new SelectionChangeEventImpl();\n  }\n\n  public getSelectionLevels(props: IModelKeyProp): number[] {\n    return this.getContainer(getIModelKey(props)).getSelectionLevels();\n  }\n\n  public getSelection(props: IModelKeyProp & { level?: number }): Selectables {\n    return this.getContainer(getIModelKey(props)).getSelection(props.level ?? 0);\n  }\n\n  public addToSelection(props: IModelKeyProp & { source: string; selectables: Selectable[]; level?: number }): void {\n    this.handleChange({ ...props, changeType: \"add\" });\n  }\n\n  public removeFromSelection(props: IModelKeyProp & { source: string; selectables: Selectable[]; level?: number }): void {\n    this.handleChange({ ...props, changeType: \"remove\" });\n  }\n\n  public replaceSelection(props: IModelKeyProp & { source: string; selectables: Selectable[]; level?: number }): void {\n    this.handleChange({ ...props, changeType: \"replace\" });\n  }\n\n  public clearSelection(props: IModelKeyProp & { source: string; level?: number }): void {\n    this.handleChange({ ...props, changeType: \"clear\", selectables: [] });\n  }\n\n  public clearStorage(props: IModelKeyProp): void {\n    const imodelKey = getIModelKey(props);\n    this.clearSelection({ source: IMODEL_CLOSE_SELECTION_CLEAR_SOURCE, imodelKey });\n    this._storage.delete(imodelKey);\n  }\n\n  private getContainer(imodelKey: string): MultiLevelSelectablesContainer {\n    let selectionContainer = this._storage.get(imodelKey);\n    if (!selectionContainer) {\n      selectionContainer = new MultiLevelSelectablesContainer();\n      this._storage.set(imodelKey, selectionContainer);\n    }\n    return selectionContainer;\n  }\n\n  private handleChange(props: IModelKeyProp & { source: string; level?: number; changeType: StorageSelectionChangeType; selectables: Selectable[] }) {\n    const { source, level: inLevel, changeType, selectables: change } = props;\n    const imodelKey = getIModelKey(props);\n    const container = this.getContainer(imodelKey);\n    const level = inLevel ?? 0;\n    const selectables = container.getSelection(level);\n    const selected = Selectables.create(change);\n    switch (changeType) {\n      case \"add\":\n        if (!Selectables.add(selectables, change)) {\n          return;\n        }\n        break;\n      case \"remove\":\n        if (!Selectables.remove(selectables, change)) {\n          return;\n        }\n        break;\n      case \"replace\":\n        if (Selectables.size(selectables) === Selectables.size(selected) && Selectables.hasAll(selectables, change)) {\n          return;\n        }\n        Selectables.clear(selectables);\n        Selectables.add(selectables, change);\n        break;\n      case \"clear\":\n        if (!Selectables.clear(selectables)) {\n          return;\n        }\n        break;\n    }\n    container.clear(level + 1);\n    const event: StorageSelectionChangeEventArgs = {\n      source,\n      level,\n      imodelKey,\n      iModelKey: imodelKey,\n      changeType,\n      selectables: selected,\n      timestamp: new Date(),\n    };\n    this.selectionChangeEvent.raiseEvent(event, this);\n  }\n}\n\nfunction getIModelKey(props: IModelKeyProp): string {\n  // eslint-disable-next-line deprecation/deprecation\n  return \"imodelKey\" in props ? props.imodelKey : props.iModelKey;\n}\n\nclass MultiLevelSelectablesContainer {\n  private readonly _selectablesContainers: Map<number, Selectables>;\n\n  constructor() {\n    this._selectablesContainers = new Map<number, Selectables>();\n  }\n\n  public getSelection(level: number): Selectables {\n    let selectables = this._selectablesContainers.get(level);\n    if (!selectables) {\n      selectables = Selectables.create([]);\n      this._selectablesContainers.set(level, selectables);\n    }\n    return selectables;\n  }\n\n  public getSelectionLevels(): number[] {\n    const levels = new Array<number>();\n    for (const entry of this._selectablesContainers.entries()) {\n      if (!Selectables.isEmpty(entry[1])) {\n        levels.push(entry[0]);\n      }\n    }\n    return levels.sort();\n  }\n\n  public clear(level: number) {\n    const storedLevels = this._selectablesContainers.keys();\n    for (const storedLevel of storedLevels) {\n      if (storedLevel >= level) {\n        const selectables = this._selectablesContainers.get(storedLevel)!;\n        Selectables.clear(selectables);\n      }\n    }\n  }\n}\n"]}

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

@@ -0,0 +1,7 @@
+import { ECSqlBinding } from "@itwin/presentation-shared";
+/**
+ * Forms ECSql bindings from given ID's.
+ * @internal
+ */
+export declare function formIdBindings(property: string, ids: string[], bindings: ECSqlBinding[]): string;
+//# sourceMappingURL=Utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Utils.d.ts","sourceRoot":"","sources":["../../../src/unified-selection/Utils.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D;;;GAGG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,GAAG,MAAM,CAYhG"}

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

@@ -0,0 +1,24 @@
+"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.formIdBindings = void 0;
+/**
+ * Forms ECSql bindings from given ID's.
+ * @internal
+ */
+function formIdBindings(property, ids, bindings) {
+    if (ids.length > 1000) {
+        bindings.push({ type: "idset", value: ids });
+        return `InVirtualSet(?, ${property})`;
+    }
+    if (ids.length === 0) {
+        return `FALSE`;
+    }
+    ids.forEach((id) => bindings.push({ type: "id", value: id }));
+    return `${property} IN (${ids.map(() => "?").join(",")})`;
+}
+exports.formIdBindings = formIdBindings;
+//# sourceMappingURL=Utils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Utils.js","sourceRoot":"","sources":["../../../src/unified-selection/Utils.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAIhG;;;GAGG;AACH,SAAgB,cAAc,CAAC,QAAgB,EAAE,GAAa,EAAE,QAAwB;IACtF,IAAI,GAAG,CAAC,MAAM,GAAG,IAAI,EAAE,CAAC;QACtB,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;QAC7C,OAAO,mBAAmB,QAAQ,GAAG,CAAC;IACxC,CAAC;IAED,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IAC9D,OAAO,GAAG,QAAQ,QAAQ,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;AAC5D,CAAC;AAZD,wCAYC","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 { ECSqlBinding } from \"@itwin/presentation-shared\";\n\n/**\n * Forms ECSql bindings from given ID's.\n * @internal\n */\nexport function formIdBindings(property: string, ids: string[], bindings: ECSqlBinding[]): string {\n  if (ids.length > 1000) {\n    bindings.push({ type: \"idset\", value: ids });\n    return `InVirtualSet(?, ${property})`;\n  }\n\n  if (ids.length === 0) {\n    return `FALSE`;\n  }\n\n  ids.forEach((id) => bindings.push({ type: \"id\", value: id }));\n  return `${property} IN (${ids.map(() => \"?\").join(\",\")})`;\n}\n"]}

package/lib/cjs/unified-selection/types/IModel.d.ts

@@ -0,0 +1,84 @@
+import { Id64Arg } from "@itwin/core-bentley";
+import { Event } from "@itwin/presentation-shared";
+/**
+ * Identifies the type of changes made to the `CoreIModelSelectionSet` to produce a `CoreSelectionSetEvent`.
+ * @see https://www.itwinjs.org/reference/core-frontend/selectionset/selectionseteventtype/
+ * @internal
+ */
+export declare enum CoreSelectionSetEventType {
+    /** Elements have been added to the set. */
+    Add = 0,
+    /** Elements have been removed from the set. */
+    Remove = 1,
+    /** Some elements have been added to the set and others have been removed. */
+    Replace = 2,
+    /** All elements are about to be removed from the set. */
+    Clear = 3
+}
+/**
+ * Payload sent to `CoreIModelSelectionSet.onChanged` event listeners to describe how the contents of the set have changed.
+ * @see https://www.itwinjs.org/reference/core-frontend/selectionset/selectionsetevent/
+ * @internal
+ */
+export interface CoreSelectionSetEventUnsafe {
+    /**
+     * The type of operation that produced this event.
+     *
+     * Actually, this should be `CoreSelectionSetEventType`, however we can't use it here because in TS two identical enums with
+     * different names aren't equal, so [`SelectionSetEventType `](https://www.itwinjs.org/reference/core-frontend/selectionset/selectionseteventtype/)
+     * doesn't map to `CoreSelectionSetEventType` as far as TS is concerned. Due to this reason, this interface is marked as `unsafe`.
+     */
+    type: number;
+    /** The element Ids added to the set. */
+    added?: Id64Arg;
+    /** The element Ids removed from the set. */
+    removed?: Id64Arg;
+    /** The affected `CoreIModelSelectionSet`. */
+    set: CoreIModelSelectionSet;
+}
+/**
+ * A set of *currently selected* elements in an iModel.
+ * @see https://www.itwinjs.org/reference/core-frontend/selectionset/
+ * @internal
+ */
+export interface CoreIModelSelectionSet {
+    /** Event called whenever elements are added or removed from this SelectionSet. */
+    onChanged: Event<(ev: CoreSelectionSetEventUnsafe) => void>;
+    /** The IDs of the selected elements. */
+    readonly elements: Set<string>;
+    /** Clear current selection set. */
+    emptyAll(): void;
+    /** Add one or more Ids to the current selection set. */
+    add(elem: Id64Arg): boolean;
+    /** Remove one or more Ids from the current selection set. */
+    remove(elem: Id64Arg): boolean;
+}
+/**
+ * A set if ID's optimized for performance-critical code which represents large sets of ID's as pairs of 32-bit integers.
+ * @see https://www.itwinjs.org/reference/core-bentley/ids/id64/id64.uint32set/
+ */
+interface Uint32Set {
+    /** Add any number of Ids to the set. */
+    addIds(ids: Id64Arg): void;
+    /** Remove any number of Ids from the set. */
+    deleteIds(ids: Id64Arg): void;
+}
+/**
+ * A set of *hilited* elements in an iModel, by element id.
+ * @see https://www.itwinjs.org/reference/core-frontend/selectionset/hiliteset/
+ * @internal
+ */
+export interface CoreIModelHiliteSet {
+    /** Control whether the hilited elements should be synchronized with the contents of `CoreIModelSelectionSet`.*/
+    wantSyncWithSelectionSet: boolean;
+    /** The set of hilited elements. */
+    readonly elements: Uint32Set;
+    /** The set of hilited subcategories. */
+    readonly subcategories: Uint32Set;
+    /** The set of hilited models. */
+    readonly models: Uint32Set;
+    /** Remove all elements from the hilited set. */
+    clear(): void;
+}
+export {};
+//# sourceMappingURL=IModel.d.ts.map

package/lib/cjs/unified-selection/types/IModel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModel.d.ts","sourceRoot":"","sources":["../../../../src/unified-selection/types/IModel.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AAEnD;;;;GAIG;AACH,oBAAY,yBAAyB;IACnC,2CAA2C;IAC3C,GAAG,IAAA;IACH,+CAA+C;IAC/C,MAAM,IAAA;IACN,6EAA6E;IAC7E,OAAO,IAAA;IACP,yDAAyD;IACzD,KAAK,IAAA;CACN;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,wCAAwC;IACxC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,4CAA4C;IAC5C,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,6CAA6C;IAC7C,GAAG,EAAE,sBAAsB,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,kFAAkF;IAClF,SAAS,EAAE,KAAK,CAAC,CAAC,EAAE,EAAE,2BAA2B,KAAK,IAAI,CAAC,CAAC;IAC5D,wCAAwC;IACxC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC/B,mCAAmC;IACnC,QAAQ,IAAI,IAAI,CAAC;IACjB,wDAAwD;IACxD,GAAG,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC;IAC5B,6DAA6D;IAC7D,MAAM,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC;CAChC;AAED;;;GAGG;AACH,UAAU,SAAS;IACjB,wCAAwC;IACxC,MAAM,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI,CAAC;IAC3B,6CAA6C;IAC7C,SAAS,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI,CAAC;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,gHAAgH;IAChH,wBAAwB,EAAE,OAAO,CAAC;IAClC,mCAAmC;IACnC,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;IAC7B,wCAAwC;IACxC,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC;IAClC,iCAAiC;IACjC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAC3B,gDAAgD;IAChD,KAAK,IAAI,IAAI,CAAC;CACf"}

package/lib/cjs/unified-selection/types/IModel.js

@@ -0,0 +1,24 @@
+"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.CoreSelectionSetEventType = void 0;
+/**
+ * Identifies the type of changes made to the `CoreIModelSelectionSet` to produce a `CoreSelectionSetEvent`.
+ * @see https://www.itwinjs.org/reference/core-frontend/selectionset/selectionseteventtype/
+ * @internal
+ */
+var CoreSelectionSetEventType;
+(function (CoreSelectionSetEventType) {
+    /** Elements have been added to the set. */
+    CoreSelectionSetEventType[CoreSelectionSetEventType["Add"] = 0] = "Add";
+    /** Elements have been removed from the set. */
+    CoreSelectionSetEventType[CoreSelectionSetEventType["Remove"] = 1] = "Remove";
+    /** Some elements have been added to the set and others have been removed. */
+    CoreSelectionSetEventType[CoreSelectionSetEventType["Replace"] = 2] = "Replace";
+    /** All elements are about to be removed from the set. */
+    CoreSelectionSetEventType[CoreSelectionSetEventType["Clear"] = 3] = "Clear";
+})(CoreSelectionSetEventType || (exports.CoreSelectionSetEventType = CoreSelectionSetEventType = {}));
+//# sourceMappingURL=IModel.js.map

package/lib/cjs/unified-selection/types/IModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModel.js","sourceRoot":"","sources":["../../../../src/unified-selection/types/IModel.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAKhG;;;;GAIG;AACH,IAAY,yBASX;AATD,WAAY,yBAAyB;IACnC,2CAA2C;IAC3C,uEAAG,CAAA;IACH,+CAA+C;IAC/C,6EAAM,CAAA;IACN,6EAA6E;IAC7E,+EAAO,CAAA;IACP,yDAAyD;IACzD,2EAAK,CAAA;AACP,CAAC,EATW,yBAAyB,yCAAzB,yBAAyB,QASpC","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 { Id64Arg } from \"@itwin/core-bentley\";\nimport { Event } from \"@itwin/presentation-shared\";\n\n/**\n * Identifies the type of changes made to the `CoreIModelSelectionSet` to produce a `CoreSelectionSetEvent`.\n * @see https://www.itwinjs.org/reference/core-frontend/selectionset/selectionseteventtype/\n * @internal\n */\nexport enum CoreSelectionSetEventType {\n  /** Elements have been added to the set. */\n  Add,\n  /** Elements have been removed from the set. */\n  Remove,\n  /** Some elements have been added to the set and others have been removed. */\n  Replace,\n  /** All elements are about to be removed from the set. */\n  Clear,\n}\n\n/**\n * Payload sent to `CoreIModelSelectionSet.onChanged` event listeners to describe how the contents of the set have changed.\n * @see https://www.itwinjs.org/reference/core-frontend/selectionset/selectionsetevent/\n * @internal\n */\nexport interface CoreSelectionSetEventUnsafe {\n  /**\n   * The type of operation that produced this event.\n   *\n   * Actually, this should be `CoreSelectionSetEventType`, however we can't use it here because in TS two identical enums with\n   * different names aren't equal, so [`SelectionSetEventType `](https://www.itwinjs.org/reference/core-frontend/selectionset/selectionseteventtype/)\n   * doesn't map to `CoreSelectionSetEventType` as far as TS is concerned. Due to this reason, this interface is marked as `unsafe`.\n   */\n  type: number;\n  /** The element Ids added to the set. */\n  added?: Id64Arg;\n  /** The element Ids removed from the set. */\n  removed?: Id64Arg;\n  /** The affected `CoreIModelSelectionSet`. */\n  set: CoreIModelSelectionSet;\n}\n\n/**\n * A set of *currently selected* elements in an iModel.\n * @see https://www.itwinjs.org/reference/core-frontend/selectionset/\n * @internal\n */\nexport interface CoreIModelSelectionSet {\n  /** Event called whenever elements are added or removed from this SelectionSet. */\n  onChanged: Event<(ev: CoreSelectionSetEventUnsafe) => void>;\n  /** The IDs of the selected elements. */\n  readonly elements: Set<string>;\n  /** Clear current selection set. */\n  emptyAll(): void;\n  /** Add one or more Ids to the current selection set. */\n  add(elem: Id64Arg): boolean;\n  /** Remove one or more Ids from the current selection set. */\n  remove(elem: Id64Arg): boolean;\n}\n\n/**\n * A set if ID's optimized for performance-critical code which represents large sets of ID's as pairs of 32-bit integers.\n * @see https://www.itwinjs.org/reference/core-bentley/ids/id64/id64.uint32set/\n */\ninterface Uint32Set {\n  /** Add any number of Ids to the set. */\n  addIds(ids: Id64Arg): void;\n  /** Remove any number of Ids from the set. */\n  deleteIds(ids: Id64Arg): void;\n}\n\n/**\n * A set of *hilited* elements in an iModel, by element id.\n * @see https://www.itwinjs.org/reference/core-frontend/selectionset/hiliteset/\n * @internal\n */\nexport interface CoreIModelHiliteSet {\n  /** Control whether the hilited elements should be synchronized with the contents of `CoreIModelSelectionSet`.*/\n  wantSyncWithSelectionSet: boolean;\n  /** The set of hilited elements. */\n  readonly elements: Uint32Set;\n  /** The set of hilited subcategories. */\n  readonly subcategories: Uint32Set;\n  /** The set of hilited models. */\n  readonly models: Uint32Set;\n  /** Remove all elements from the hilited set. */\n  clear(): void;\n}\n"]}

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

@@ -1,10 +1,8 @@
-/**
- * @module UnifiedSelection
- *
- * @docs-group-description UnifiedSelection
- * API for working with unified selection.
- */
 export * from "./unified-selection/Selectable";
-export * from "./unified-selection/SelectionStorage";
+export { SelectionStorage, createStorage } from "./unified-selection/SelectionStorage";
+export { createHiliteSetProvider, HiliteSet, HiliteSetProvider } from "./unified-selection/HiliteSetProvider";
+export { createCachingHiliteSetProvider, CachingHiliteSetProvider } from "./unified-selection/CachingHiliteSetProvider";
+export { computeSelection } from "./unified-selection/SelectionScope";
+export { enableUnifiedSelectionSyncWithIModel } from "./unified-selection/EnableUnifiedSelectionSyncWithIModel";
 export { StorageSelectionChangeType, StorageSelectionChangeEventArgs, StorageSelectionChangesListener, SelectionChangeEvent, } from "./unified-selection/SelectionChangeEvent";
 //# sourceMappingURL=unified-selection.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"unified-selection.d.ts","sourceRoot":"","sources":["../../src/unified-selection.ts"],"names":[],"mappings":"AAKA;;;;;GAKG;AACH,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sCAAsC,CAAC;AACrD,OAAO,EACL,0BAA0B,EAC1B,+BAA+B,EAC/B,+BAA+B,EAC/B,oBAAoB,GACrB,MAAM,0CAA0C,CAAC"}
+{"version":3,"file":"unified-selection.d.ts","sourceRoot":"","sources":["../../src/unified-selection.ts"],"names":[],"mappings":"AAKA,cAAc,gCAAgC,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACvF,OAAO,EAAE,uBAAuB,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,uCAAuC,CAAC;AAC9G,OAAO,EAAE,8BAA8B,EAAE,wBAAwB,EAAE,MAAM,8CAA8C,CAAC;AACxH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,oCAAoC,EAAE,MAAM,0DAA0D,CAAC;AAChH,OAAO,EACL,0BAA0B,EAC1B,+BAA+B,EAC/B,+BAA+B,EAC/B,oBAAoB,GACrB,MAAM,0CAA0C,CAAC"}

package/lib/cjs/unified-selection.js

@@ -18,12 +18,16 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * @module UnifiedSelection
- *
- * @docs-group-description UnifiedSelection
- * API for working with unified selection.
- */
+exports.enableUnifiedSelectionSyncWithIModel = exports.computeSelection = exports.createCachingHiliteSetProvider = exports.createHiliteSetProvider = exports.createStorage = void 0;
 __exportStar(require("./unified-selection/Selectable"), exports);
-__exportStar(require("./unified-selection/SelectionStorage"), exports);
+var SelectionStorage_1 = require("./unified-selection/SelectionStorage");
+Object.defineProperty(exports, "createStorage", { enumerable: true, get: function () { return SelectionStorage_1.createStorage; } });
+var HiliteSetProvider_1 = require("./unified-selection/HiliteSetProvider");
+Object.defineProperty(exports, "createHiliteSetProvider", { enumerable: true, get: function () { return HiliteSetProvider_1.createHiliteSetProvider; } });
+var CachingHiliteSetProvider_1 = require("./unified-selection/CachingHiliteSetProvider");
+Object.defineProperty(exports, "createCachingHiliteSetProvider", { enumerable: true, get: function () { return CachingHiliteSetProvider_1.createCachingHiliteSetProvider; } });
+var SelectionScope_1 = require("./unified-selection/SelectionScope");
+Object.defineProperty(exports, "computeSelection", { enumerable: true, get: function () { return SelectionScope_1.computeSelection; } });
+var EnableUnifiedSelectionSyncWithIModel_1 = require("./unified-selection/EnableUnifiedSelectionSyncWithIModel");
+Object.defineProperty(exports, "enableUnifiedSelectionSyncWithIModel", { enumerable: true, get: function () { return EnableUnifiedSelectionSyncWithIModel_1.enableUnifiedSelectionSyncWithIModel; } });
 //# sourceMappingURL=unified-selection.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"unified-selection.js","sourceRoot":"","sources":["../../src/unified-selection.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;;;;;;;;;;;;;;AAEhG;;;;;GAKG;AACH,iEAA+C;AAC/C,uEAAqD","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 * @module UnifiedSelection\n *\n * @docs-group-description UnifiedSelection\n * API for working with unified selection.\n */\nexport * from \"./unified-selection/Selectable\";\nexport * from \"./unified-selection/SelectionStorage\";\nexport {\n  StorageSelectionChangeType,\n  StorageSelectionChangeEventArgs,\n  StorageSelectionChangesListener,\n  SelectionChangeEvent,\n} from \"./unified-selection/SelectionChangeEvent\";\n"]}
+{"version":3,"file":"unified-selection.js","sourceRoot":"","sources":["../../src/unified-selection.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;;;;;;;;;;;;;;;AAEhG,iEAA+C;AAC/C,yEAAuF;AAA5D,iHAAA,aAAa,OAAA;AACxC,2EAA8G;AAArG,4HAAA,uBAAuB,OAAA;AAChC,yFAAwH;AAA/G,0IAAA,8BAA8B,OAAA;AACvC,qEAAsE;AAA7D,kHAAA,gBAAgB,OAAA;AACzB,iHAAgH;AAAvG,4JAAA,oCAAoC,OAAA","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\nexport * from \"./unified-selection/Selectable\";\nexport { SelectionStorage, createStorage } from \"./unified-selection/SelectionStorage\";\nexport { createHiliteSetProvider, HiliteSet, HiliteSetProvider } from \"./unified-selection/HiliteSetProvider\";\nexport { createCachingHiliteSetProvider, CachingHiliteSetProvider } from \"./unified-selection/CachingHiliteSetProvider\";\nexport { computeSelection } from \"./unified-selection/SelectionScope\";\nexport { enableUnifiedSelectionSyncWithIModel } from \"./unified-selection/EnableUnifiedSelectionSyncWithIModel\";\nexport {\n  StorageSelectionChangeType,\n  StorageSelectionChangeEventArgs,\n  StorageSelectionChangesListener,\n  SelectionChangeEvent,\n} from \"./unified-selection/SelectionChangeEvent\";\n"]}

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

@@ -0,0 +1,33 @@
+import { ECSchemaProvider, ECSqlQueryExecutor } from "@itwin/presentation-shared";
+import { HiliteSet } from "./HiliteSetProvider";
+import { SelectionStorage } from "./SelectionStorage";
+/**
+ * Props for creating a `CachingHiliteSetProvider` instance.
+ * @internal Not exported through barrel, but used in public API as an argument. May be supplemented with optional attributes any time.
+ */
+export interface CachingHiliteSetProviderProps {
+    selectionStorage: SelectionStorage;
+    imodelProvider: (imodelKey: string) => ECSchemaProvider & ECSqlQueryExecutor;
+}
+/**
+ * Defines return value of `createCachingHiliteSetProvider`.
+ *
+ * @beta 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.
+ */
+export interface CachingHiliteSetProvider {
+    /** Get the current hilite set iterator for the specified imodel */
+    getHiliteSet(props: {
+        /** iModel to get hilite set for */
+        imodelKey: string;
+    }): AsyncIterableIterator<HiliteSet>;
+    /** Disposes the cache. */
+    dispose(): void;
+}
+/**
+ * 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.
+ * @beta
+ */
+export declare function createCachingHiliteSetProvider(props: CachingHiliteSetProviderProps): CachingHiliteSetProvider;
+//# sourceMappingURL=CachingHiliteSetProvider.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CachingHiliteSetProvider.d.ts","sourceRoot":"","sources":["../../../src/unified-selection/CachingHiliteSetProvider.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAClF,OAAO,EAA2B,SAAS,EAAqB,MAAM,qBAAqB,CAAC;AAE5F,OAAO,EAAuC,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3F;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC5C,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,cAAc,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,gBAAgB,GAAG,kBAAkB,CAAC;CAC9E;AAED;;;;;GAKG;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"}

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

@@ -0,0 +1,58 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+import { from, shareReplay } from "rxjs";
+import { eachValueFrom } from "rxjs-for-await";
+import { createHiliteSetProvider } from "./HiliteSetProvider";
+import { IMODEL_CLOSE_SELECTION_CLEAR_SOURCE } from "./SelectionStorage";
+/**
+ * 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.
+ * @beta
+ */
+export function createCachingHiliteSetProvider(props) {
+    return new CachingHiliteSetProviderImpl(props);
+}
+class CachingHiliteSetProviderImpl {
+    _selectionStorage;
+    _hiliteSetProviders = new Map();
+    _cache = new Map();
+    _removeListener;
+    _imodelProvider;
+    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 === IMODEL_CLOSE_SELECTION_CLEAR_SOURCE) {
+                this._hiliteSetProviders.delete(args.imodelKey);
+            }
+        });
+    }
+    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 = from(provider.getHiliteSet({ selectables })).pipe(shareReplay({ refCount: true }));
+            this._cache.set(imodelKey, hiliteSet);
+        }
+        return eachValueFrom(hiliteSet);
+    }
+    dispose() {
+        this._removeListener();
+        this._hiliteSetProviders = new Map();
+        this._cache = new Map();
+    }
+    getHiliteSetProvider(imodelKey, imodelAccess) {
+        let provider = this._hiliteSetProviders.get(imodelKey);
+        if (!provider) {
+            provider = createHiliteSetProvider({ imodelAccess });
+            this._hiliteSetProviders.set(imodelKey, provider);
+        }
+        return provider;
+    }
+}
+//# sourceMappingURL=CachingHiliteSetProvider.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CachingHiliteSetProvider.js","sourceRoot":"","sources":["../../../src/unified-selection/CachingHiliteSetProvider.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,IAAI,EAAc,WAAW,EAAE,MAAM,MAAM,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE/C,OAAO,EAAE,uBAAuB,EAAgC,MAAM,qBAAqB,CAAC;AAE5F,OAAO,EAAE,mCAAmC,EAAoB,MAAM,oBAAoB,CAAC;AA4B3F;;;;GAIG;AACH,MAAM,UAAU,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,CAA+D;IAEtF,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,mCAAmC,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,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,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,aAAa,CAAC,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,YAAmD;QACjG,IAAI,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACvD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,QAAQ,GAAG,uBAAuB,CAAC,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 { ECSchemaProvider, ECSqlQueryExecutor } from \"@itwin/presentation-shared\";\nimport { createHiliteSetProvider, HiliteSet, HiliteSetProvider } from \"./HiliteSetProvider\";\nimport { StorageSelectionChangeEventArgs } from \"./SelectionChangeEvent\";\nimport { IMODEL_CLOSE_SELECTION_CLEAR_SOURCE, SelectionStorage } from \"./SelectionStorage\";\n\n/**\n * Props for creating a `CachingHiliteSetProvider` instance.\n * @internal Not exported through barrel, but used in public API as an argument. May be supplemented with optional attributes any time.\n */\nexport interface CachingHiliteSetProviderProps {\n  selectionStorage: SelectionStorage;\n  imodelProvider: (imodelKey: string) => ECSchemaProvider & ECSqlQueryExecutor;\n}\n\n/**\n * Defines return value of `createCachingHiliteSetProvider`.\n *\n * @beta 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 */\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 * @beta\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) => ECSchemaProvider & 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: ECSchemaProvider & 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"]}