@itwin/unified-selection 0.1.0

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

@@ -0,0 +1,78 @@
+/** @packageDocumentation
+ * @module UnifiedSelection
+ */
+import { Selectable, Selectables } from "./Selectable";
+import { SelectionChangeEvent } from "./SelectionChangeEvent";
+/**
+ * Selection storage interface which provides main selection and sub-selection.
+ * @beta
+ */
+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[];
+    /** Get the selection stored in the storage. */
+    getSelection(props: {
+        /** Key of the iModel to get selection for. */
+        iModelKey: string;
+        /** 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;
+        /** Name of the selection source. Generally, this identifies the component that makes the selection change. */
+        source: string;
+        /** The selectables to add to selection. */
+        selectables: Selectable[];
+        /** Level of the selection. Defaults to `0`. */
+        level?: number;
+    }): void;
+    /** Remove keys from current selection. */
+    removeFromSelection(props: {
+        /** Key of the iModel to change selection for. */
+        iModelKey: string;
+        /** Name of the selection source. Generally, this identifies the component that makes the selection change. */
+        source: string;
+        /** The selectables to remove from selection. */
+        selectables: Selectable[];
+        /** Level of the selection. Defaults to `0`. */
+        level?: number;
+    }): void;
+    /** Replace current selection. */
+    replaceSelection(props: {
+        /** Key of the iModel to change selection for. */
+        iModelKey: string;
+        /** Name of the selection source. Generally, this identifies the component that makes the selection change. */
+        source: string;
+        /** The selectables to add to selection. */
+        selectables: Selectable[];
+        /** Level of the selection. Defaults to `0`. */
+        level?: number;
+    }): void;
+    /** Clear current selection. */
+    clearSelection(props: {
+        /** Key of the iModel to change selection for. */
+        iModelKey: string;
+        /** 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;
+}
+/**
+ * Creates a selection storage. When an iModel is closed `SelectionStorage.clearSelection` function should be called.
+ * @beta
+ */
+export declare function createStorage(): SelectionStorage;
+//# sourceMappingURL=SelectionStorage.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,132 @@
+"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.createStorage = void 0;
+/** @packageDocumentation
+ * @module UnifiedSelection
+ */
+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.
+ * @beta
+ */
+function createStorage() {
+    return new SelectionStorageImpl();
+}
+exports.createStorage = createStorage;
+class SelectionStorageImpl {
+    _storage = new Map();
+    selectionChangeEvent;
+    constructor() {
+        this.selectionChangeEvent = new SelectionChangeEvent_1.SelectionChangeEventImpl();
+    }
+    getSelectionLevels({ iModelKey }) {
+        return this.getContainer(iModelKey).getSelectionLevels();
+    }
+    getSelection(props) {
+        const { iModelKey, level } = props;
+        return this.getContainer(iModelKey).getSelection(level ?? 0);
+    }
+    addToSelection(props) {
+        this.handleChange({ ...props, changeType: "add" });
+    }
+    removeFromSelection(props) {
+        this.handleChange({ ...props, changeType: "remove" });
+    }
+    replaceSelection(props) {
+        this.handleChange({ ...props, changeType: "replace" });
+    }
+    clearSelection(props) {
+        this.handleChange({ ...props, changeType: "clear", selectables: [] });
+    }
+    clearStorage({ iModelKey }) {
+        this.clearSelection({ source: "Clear iModel storage", iModelKey });
+        this._storage.delete(iModelKey);
+    }
+    getContainer(iModelKey) {
+        let selectionContainer = this._storage.get(iModelKey);
+        if (!selectionContainer) {
+            selectionContainer = new MultiLevelSelectablesContainer();
+            this._storage.set(iModelKey, selectionContainer);
+        }
+        return selectionContainer;
+    }
+    handleChange(props) {
+        const { iModelKey, source, level: inLevel, changeType, selectables: change } = props;
+        const container = this.getContainer(iModelKey);
+        const level = inLevel ?? 0;
+        const selectables = container.getSelection(level);
+        const selected = Selectable_1.Selectables.create(change);
+        switch (changeType) {
+            case "add":
+                if (!Selectable_1.Selectables.add(selectables, change)) {
+                    return;
+                }
+                break;
+            case "remove":
+                if (!Selectable_1.Selectables.remove(selectables, change)) {
+                    return;
+                }
+                break;
+            case "replace":
+                if (Selectable_1.Selectables.size(selectables) === Selectable_1.Selectables.size(selected) && Selectable_1.Selectables.hasAll(selectables, change)) {
+                    return;
+                }
+                Selectable_1.Selectables.clear(selectables);
+                Selectable_1.Selectables.add(selectables, change);
+                break;
+            case "clear":
+                if (!Selectable_1.Selectables.clear(selectables)) {
+                    return;
+                }
+                break;
+        }
+        container.clear(level + 1);
+        const event = {
+            source,
+            level,
+            iModelKey,
+            changeType,
+            selectables: selected,
+            timestamp: new Date(),
+        };
+        this.selectionChangeEvent.raiseEvent(event, this);
+    }
+}
+class MultiLevelSelectablesContainer {
+    _selectablesContainers;
+    constructor() {
+        this._selectablesContainers = new Map();
+    }
+    getSelection(level) {
+        let selectables = this._selectablesContainers.get(level);
+        if (!selectables) {
+            selectables = Selectable_1.Selectables.create([]);
+            this._selectablesContainers.set(level, selectables);
+        }
+        return selectables;
+    }
+    getSelectionLevels() {
+        const levels = new Array();
+        for (const entry of this._selectablesContainers.entries()) {
+            if (!Selectable_1.Selectables.isEmpty(entry[1])) {
+                levels.push(entry[0]);
+            }
+        }
+        return levels.sort();
+    }
+    clear(level) {
+        const storedLevels = this._selectablesContainers.keys();
+        for (const storedLevel of storedLevels) {
+            if (storedLevel >= level) {
+                const selectables = this._selectablesContainers.get(storedLevel);
+                Selectable_1.Selectables.clear(selectables);
+            }
+        }
+    }
+}
+//# sourceMappingURL=SelectionStorage.js.map

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

@@ -0,0 +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"]}

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

@@ -0,0 +1,10 @@
+/**
+ * @module UnifiedSelection
+ *
+ * @docs-group-description UnifiedSelection
+ * API for working with unified selection.
+ */
+export * from "./unified-selection/Selectable";
+export * from "./unified-selection/SelectionStorage";
+export { StorageSelectionChangeType, StorageSelectionChangeEventArgs, StorageSelectionChangesListener, SelectionChangeEvent, } from "./unified-selection/SelectionChangeEvent";
+//# sourceMappingURL=unified-selection.d.ts.map

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

@@ -0,0 +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"}

package/lib/cjs/unified-selection.js

@@ -0,0 +1,29 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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.
+ */
+__exportStar(require("./unified-selection/Selectable"), exports);
+__exportStar(require("./unified-selection/SelectionStorage"), exports);
+//# sourceMappingURL=unified-selection.js.map

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

@@ -0,0 +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"]}

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

@@ -0,0 +1,131 @@
+/** @packageDocumentation
+ * @module UnifiedSelection
+ */
+/**
+ * ECInstance selectable
+ * @beta
+ */
+export interface SelectableInstanceKey {
+    /** Full class name in format `SchemaName:ClassName` or `SchemaName.ClassName`. */
+    className: string;
+    /** ECInstance ID */
+    id: string;
+}
+/**
+ * A custom selectable
+ * @beta
+ */
+export interface CustomSelectable {
+    /** Unique identifier of the selectable. */
+    identifier: string;
+    /** Asynchronous function for loading instance keys associated with this selectable. */
+    loadInstanceKeys: () => AsyncIterableIterator<SelectableInstanceKey>;
+    /** Custom data associated with the selectable. */
+    data: unknown;
+}
+/**
+ * A single selectable that identifies something in an iTwin.js application
+ * @beta
+ */
+export type Selectable = SelectableInstanceKey | CustomSelectable;
+/**
+ * Type of identifier that can be used to identify selectable in storage.
+ * @beta
+ */
+export type SelectableIdentifier = SelectableInstanceKey | Pick<CustomSelectable, "identifier">;
+/** @beta */
+export declare namespace Selectable {
+    /** Check if the supplied selectable is a `SelectableInstanceKey` */
+    function isInstanceKey(selectable: Selectable | SelectableIdentifier): selectable is SelectableInstanceKey;
+    /** Check if the supplied selectable is a `CustomSelectable` */
+    function isCustom(selectable: Selectable): selectable is CustomSelectable;
+}
+/**
+ * A collection of selectables that identify something that can be selected in an iTwin.js application
+ * @beta
+ */
+export interface Selectables {
+    /**
+     * Map between `SelectableInstanceKey.className` and a set of selected element IDs.
+     */
+    instanceKeys: Map<string, Set<string>>;
+    /**
+     * Map between unique identifier of `CustomSelectable` and the selectable itself.
+     */
+    custom: Map<string, CustomSelectable>;
+}
+/** @beta */
+export declare namespace Selectables {
+    /**
+     * Creates `Selectables` from array of selectable
+     * @param source Source to create selectables from
+     * @beta
+     */
+    function create(source: Selectable[]): Selectables;
+    /**
+     * Get the number of selectables stored in a `Selectables` object.
+     * @param selectables `Selectables` object to get size for
+     * @beta
+     */
+    function size(selectables: Selectables): number;
+    /**
+     * Is a `Selectables` object currently empty.
+     * @param selectables `Selectables` object to check
+     * @beta
+     */
+    function isEmpty(selectables: Selectables): boolean;
+    /**
+     * Check if a `Selectables` object contains the specified selectable.
+     * @param selectables `Selectables` object to check
+     * @param value The selectable to check for.
+     * @beta
+     */
+    function has(selectables: Selectables, value: SelectableIdentifier): boolean;
+    /**
+     * Check if a `Selectables` object contains all the specified selectables.
+     * @param selectables `Selectables` object to check
+     * @param values The selectables to check for.
+     * @beta
+     */
+    function hasAll(selectables: Selectables, values: SelectableIdentifier[]): boolean;
+    /**
+     * Check if a `Selectables` object contains any of the specified selectables.
+     * @param selectables `Selectables` object to check
+     * @param values The selectables to check for.
+     * @beta
+     */
+    function hasAny(selectables: Selectables, values: SelectableIdentifier[]): boolean;
+    /**
+     * Add a one or more selectables to a `Selectables`
+     * @param selectables `Selectables` object to add selectables for
+     * @param values Selectables to add.
+     * @beta
+     */
+    function add(selectables: Selectables, values: Selectable[]): boolean;
+    /**
+     * Removes one or more selectables from a `Selectables` object.
+     * @param selectables `Selectables` object to remove selectables for
+     * @param values Selectables to remove.
+     * @beta
+     */
+    function remove(selectables: Selectables, values: Selectable[]): boolean;
+    /**
+     * Clear a `Selectables` object.
+     * @param selectables `Selectables` object to clear selectables for
+     * @beta
+     */
+    function clear(selectables: Selectables): boolean;
+    /**
+     * Check whether at least one selectable passes a condition in a `Selectables` object.
+     * @param selectables `Selectables` object to check
+     * @beta
+     */
+    function some(selectables: Selectables, callback: (selectable: Selectable) => boolean): boolean;
+    /**
+     * Iterate over all keys in a `Selectables` object.
+     * @param selectables `Selectables` object to iterate over
+     * @beta
+     */
+    function forEach(selectables: Selectables, callback: (selectable: Selectable, index: number) => void): void;
+}
+//# sourceMappingURL=Selectable.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Selectable.d.ts","sourceRoot":"","sources":["../../../src/unified-selection/Selectable.ts"],"names":[],"mappings":"AAKA;;GAEG;AAEH;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,kFAAkF;IAClF,SAAS,EAAE,MAAM,CAAC;IAClB,oBAAoB;IACpB,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,2CAA2C;IAC3C,UAAU,EAAE,MAAM,CAAC;IACnB,uFAAuF;IACvF,gBAAgB,EAAE,MAAM,qBAAqB,CAAC,qBAAqB,CAAC,CAAC;IACrE,kDAAkD;IAClD,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,qBAAqB,GAAG,gBAAgB,CAAC;AAElE;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,qBAAqB,GAAG,IAAI,CAAC,gBAAgB,EAAE,YAAY,CAAC,CAAC;AAEhG,YAAY;AAEZ,yBAAiB,UAAU,CAAC;IAC1B,oEAAoE;IACpE,SAAgB,aAAa,CAAC,UAAU,EAAE,UAAU,GAAG,oBAAoB,GAAG,UAAU,IAAI,qBAAqB,CAGhH;IAED,+DAA+D;IAC/D,SAAgB,QAAQ,CAAC,UAAU,EAAE,UAAU,GAAG,UAAU,IAAI,gBAAgB,CAE/E;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;IACvC;;OAEG;IACH,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;CACvC;AAED,YAAY;AAEZ,yBAAiB,WAAW,CAAC;IAC3B;;;;OAIG;IACH,SAAgB,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,WAAW,CAOxD;IAED;;;;OAIG;IACH,SAAgB,IAAI,CAAC,WAAW,EAAE,WAAW,GAAG,MAAM,CAIrD;IAED;;;;OAIG;IACH,SAAgB,OAAO,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAEzD;IAED;;;;;OAKG;IACH,SAAgB,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,KAAK,EAAE,oBAAoB,GAAG,OAAO,CAOlF;IAED;;;;;OAKG;IACH,SAAgB,MAAM,CAAC,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,oBAAoB,EAAE,GAAG,OAAO,CAUxF;IAED;;;;;OAKG;IACH,SAAgB,MAAM,CAAC,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,oBAAoB,EAAE,GAAG,OAAO,CAOxF;IAED;;;;;OAKG;IACH,SAAgB,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAoB3E;IAED;;;;;OAKG;IACH,SAAgB,MAAM,CAAC,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAmB9E;IAED;;;;OAIG;IACH,SAAgB,KAAK,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAOvD;IAED;;;;OAIG;IACH,SAAgB,IAAI,CAAC,WAAW,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,UAAU,KAAK,OAAO,WAc3F;IAED;;;;OAIG;IACH,SAAgB,OAAO,CAAC,WAAW,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,QAQ1G;CAKF"}

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

@@ -0,0 +1,218 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @beta */
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export var Selectable;
+(function (Selectable) {
+    /** Check if the supplied selectable is a `SelectableInstanceKey` */
+    function isInstanceKey(selectable) {
+        const instanceKey = selectable;
+        return !!instanceKey.className && !!instanceKey.id;
+    }
+    Selectable.isInstanceKey = isInstanceKey;
+    /** Check if the supplied selectable is a `CustomSelectable` */
+    function isCustom(selectable) {
+        return !!selectable.identifier;
+    }
+    Selectable.isCustom = isCustom;
+})(Selectable || (Selectable = {}));
+/** @beta */
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export var Selectables;
+(function (Selectables) {
+    /**
+     * Creates `Selectables` from array of selectable
+     * @param source Source to create selectables from
+     * @beta
+     */
+    function create(source) {
+        const newSelectables = {
+            instanceKeys: new Map(),
+            custom: new Map(),
+        };
+        Selectables.add(newSelectables, source);
+        return newSelectables;
+    }
+    Selectables.create = create;
+    /**
+     * Get the number of selectables stored in a `Selectables` object.
+     * @param selectables `Selectables` object to get size for
+     * @beta
+     */
+    function size(selectables) {
+        let insatanceCount = 0;
+        selectables.instanceKeys.forEach((set) => (insatanceCount += set.size));
+        return insatanceCount + selectables.custom.size;
+    }
+    Selectables.size = size;
+    /**
+     * Is a `Selectables` object currently empty.
+     * @param selectables `Selectables` object to check
+     * @beta
+     */
+    function isEmpty(selectables) {
+        return Selectables.size(selectables) === 0;
+    }
+    Selectables.isEmpty = isEmpty;
+    /**
+     * Check if a `Selectables` object contains the specified selectable.
+     * @param selectables `Selectables` object to check
+     * @param value The selectable to check for.
+     * @beta
+     */
+    function has(selectables, value) {
+        if (Selectable.isInstanceKey(value)) {
+            const normalizedClassName = normalizeClassName(value.className);
+            const set = selectables.instanceKeys.get(normalizedClassName);
+            return !!(set && set.has(value.id));
+        }
+        return selectables.custom.has(value.identifier);
+    }
+    Selectables.has = has;
+    /**
+     * Check if a `Selectables` object contains all the specified selectables.
+     * @param selectables `Selectables` object to check
+     * @param values The selectables to check for.
+     * @beta
+     */
+    function hasAll(selectables, values) {
+        if (Selectables.size(selectables) < values.length) {
+            return false;
+        }
+        for (const selectable of values) {
+            if (!Selectables.has(selectables, selectable)) {
+                return false;
+            }
+        }
+        return true;
+    }
+    Selectables.hasAll = hasAll;
+    /**
+     * Check if a `Selectables` object contains any of the specified selectables.
+     * @param selectables `Selectables` object to check
+     * @param values The selectables to check for.
+     * @beta
+     */
+    function hasAny(selectables, values) {
+        for (const selectable of values) {
+            if (Selectables.has(selectables, selectable)) {
+                return true;
+            }
+        }
+        return false;
+    }
+    Selectables.hasAny = hasAny;
+    /**
+     * Add a one or more selectables to a `Selectables`
+     * @param selectables `Selectables` object to add selectables for
+     * @param values Selectables to add.
+     * @beta
+     */
+    function add(selectables, values) {
+        let hasChanged = false;
+        for (const selectable of values) {
+            if (Selectable.isInstanceKey(selectable)) {
+                const normalizedClassName = normalizeClassName(selectable.className);
+                let set = selectables.instanceKeys.get(normalizedClassName);
+                if (!set) {
+                    set = new Set();
+                }
+                if (!set.has(selectable.id)) {
+                    set.add(selectable.id);
+                    selectables.instanceKeys.set(normalizedClassName, set);
+                    hasChanged = true;
+                }
+            }
+            else if (!selectables.custom.has(selectable.identifier)) {
+                selectables.custom.set(selectable.identifier, selectable);
+                hasChanged = true;
+            }
+        }
+        return hasChanged;
+    }
+    Selectables.add = add;
+    /**
+     * Removes one or more selectables from a `Selectables` object.
+     * @param selectables `Selectables` object to remove selectables for
+     * @param values Selectables to remove.
+     * @beta
+     */
+    function remove(selectables, values) {
+        let hasChanged = false;
+        for (const selectable of values) {
+            if (Selectable.isInstanceKey(selectable)) {
+                const normalizedClassName = normalizeClassName(selectable.className);
+                const set = selectables.instanceKeys.get(normalizedClassName);
+                if (set && set.has(selectable.id)) {
+                    set.delete(selectable.id);
+                    hasChanged = true;
+                    if (set.size === 0) {
+                        selectables.instanceKeys.delete(normalizedClassName);
+                    }
+                }
+            }
+            else if (selectables.custom.has(selectable.identifier)) {
+                selectables.custom.delete(selectable.identifier);
+                hasChanged = true;
+            }
+        }
+        return hasChanged;
+    }
+    Selectables.remove = remove;
+    /**
+     * Clear a `Selectables` object.
+     * @param selectables `Selectables` object to clear selectables for
+     * @beta
+     */
+    function clear(selectables) {
+        if (Selectables.size(selectables) === 0) {
+            return false;
+        }
+        selectables.instanceKeys = new Map();
+        selectables.custom = new Map();
+        return true;
+    }
+    Selectables.clear = clear;
+    /**
+     * Check whether at least one selectable passes a condition in a `Selectables` object.
+     * @param selectables `Selectables` object to check
+     * @beta
+     */
+    function some(selectables, callback) {
+        for (const entry of selectables.instanceKeys) {
+            for (const item of entry[1]) {
+                if (callback({ className: entry[0], id: item })) {
+                    return true;
+                }
+            }
+        }
+        for (const entry of selectables.custom) {
+            if (callback(entry[1])) {
+                return true;
+            }
+        }
+        return false;
+    }
+    Selectables.some = some;
+    /**
+     * Iterate over all keys in a `Selectables` object.
+     * @param selectables `Selectables` object to iterate over
+     * @beta
+     */
+    function forEach(selectables, callback) {
+        let index = 0;
+        selectables.instanceKeys.forEach((ids, className) => {
+            ids.forEach((id) => callback({ className, id }, index++));
+        });
+        selectables.custom.forEach((data) => {
+            callback(data, index++);
+        });
+    }
+    Selectables.forEach = forEach;
+    function normalizeClassName(className) {
+        return className.replace(".", ":");
+    }
+})(Selectables || (Selectables = {}));
+//# sourceMappingURL=Selectable.js.map