@itwin/unified-selection 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @itwin/unified-selection
+
+## 0.1.0
+
+### Minor Changes
+
+- [#491](https://github.com/iTwin/presentation/pull/491): Initial package release.

package/LICENSE.md

@@ -0,0 +1,9 @@
+# MIT License
+
+Copyright © 2017-2024 Bentley Systems, Incorporated. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,90 @@
+# @itwin/unified-selection
+
+Copyright © Bentley Systems, Incorporated. All rights reserved. See LICENSE.md for license terms and full copyright notice.
+
+The `@itwin/unified-selection` package provides API for managing [unified selection](https://www.itwinjs.org/presentation/unified-selection/).
+
+## Basic concepts
+
+The API consists of a few very basic concepts:
+
+- A `Selectable` is something that can be selected and is associated with an [EC](https://www.itwinjs.org/bis/ec/) instance. There are 2 types of selectables:
+
+  - `SelectableInstanceKey` uniquely identifies a single EC instance through a full class name and [ECInstanceId](https://www.itwinjs.org/learning/ecsql/#ecinstanceid-and-ecclassid).
+  - `CustomSelectable` is identified by an arbitrary `identifier` string and knows how to get any number of `SelectableInstanceKey` associated with it.
+
+- `Selectables` is a container for multiple `Selectable` instances. The container is structured in a way that allows to quickly find specific selectables by their identifier.
+
+- `SelectionStorage` is an interface that manages `Selectables` for different [iModels](https://www.itwinjs.org/learning/imodels/). It allows:
+
+  - Changing the selection (add, remove, replace, clear).
+  - Get active selection.
+  - Listen to selection changes.
+
+  The package delivers the `createStorage()` function to create an instance of `SelectionStorage`. Consumers are also expected to call `SelectionStorage.clearStorage` whenever an iModel is closed to free up memory.
+
+## Basic usage
+
+```ts
+// create a global selection store (generally, somewhere in main.ts or similar)
+import { createStore } from "@itwin/unified-selection";
+const unifiedSelection = createStore();
+
+// the store should to be cleaned up when iModels are closed to free up memory, e.g.:
+import { IModelConnection } from "@itwin/core-frontend";
+IModelConnection.onClose.addListener((iModel) => {
+  unifiedSelection.clearStorage(iModel.key);
+});
+
+// add a demo selection listener
+import { Selectables } from "@itwin/unified-selection";
+unifiedSelection.selectionChangeEvent.addListener(({ iModelKey, source, changeType, selectables }) => {
+  const suffix = `in ${iModelKey} iModel from ${source} component`;
+  const numSelectables = Selectables.size(selectables);
+  switch (changeType) {
+    case "add":
+      console.log(`Added ${numSelectables} items to selection ${suffix}.`);
+      break;
+    case "remove":
+      console.log(`Removed ${numSelectables} items from selection ${suffix}.`);
+      break;
+    case "replace":
+      console.log(`Replaced selection with ${numSelectables} items ${suffix}.`);
+      break;
+    case "clear":
+      console.log(`Cleared selection ${suffix}.`);
+      break;
+  }
+});
+
+// in some component
+MyComponent.onECInstanceSelected((iModel: IModelConnection, key: { className: string; id: Id64String }) => {
+  unifiedSelection.addToSelection({ iModelKey: iModel.key, source: "MyComponent", selectables: [key] });
+});
+```
+
+## Details
+
+### Selection levels
+
+By default, whenever a component changes unified selection, that happens at 0th (top) selection level. And similarly, whenever a component requests current selection from the storage, by default the top selection level is used. However, there are cases when we want to have multiple levels of selection.
+
+For example, let's say there're 3 components: _A_, _B_ and _C_:
+
+- _Component A_ shows a list of elements and allows selecting them.
+- _Component B_ shows a list of elements selected in _Component A_ and allows selecting them individually. Selecting an individual element should not change selection in _Component A_ or content in _Component B_ itself.
+- _Component C_ shows properties of elements selected either in _Component A_ or _Component B_.
+
+The behavior described above can't be achieved using just one level of selection, because as soon as selection is made in _Component B_, that selection would get represented in _Component A_, and _Component B_ would change what it's displaying to the individual element.
+
+That can be fixed by introducing another selection level, but before the components can be configured, here are a few key facts about selection levels:
+
+- Higher level selection has lower index. So top level selection is 0, lower level is 1, and so on.
+- Changing higher level selection clears all lower level selections.
+- Lower level selection doesn't have to be a sub-set of higher level selection.
+
+With that in mind, the above components _A_, _B_ and _C_ can be configured as follows:
+
+- _Component A_ only cares about top level selection. Whenever something is selected in the component, unified selection is updated at the top level. Similarly, whenever unified selection changes, the component only reacts if that happened at the top level.
+- _Component B_ reloads its content if the selection changes at the top level. Row selection is handled using lower level, so selecting a row doesn't affect _Component A's_ selection or _Component B's_ content.
+- _Component C_ reloads its content no matter the selection level.

package/lib/cjs/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/cjs/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/cjs/unified-selection/Selectable.js

@@ -0,0 +1,221 @@
+"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.Selectables = exports.Selectable = void 0;
+/** @beta */
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+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 = exports.Selectable || (exports.Selectable = {}));
+/** @beta */
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+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 = exports.Selectables || (exports.Selectables = {}));
+//# sourceMappingURL=Selectable.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Selectable.js","sourceRoot":"","sources":["../../../src/unified-selection/Selectable.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AA0ChG,YAAY;AACZ,2DAA2D;AAC3D,IAAiB,UAAU,CAW1B;AAXD,WAAiB,UAAU;IACzB,oEAAoE;IACpE,SAAgB,aAAa,CAAC,UAA6C;QACzE,MAAM,WAAW,GAAG,UAAmC,CAAC;QACxD,OAAO,CAAC,CAAC,WAAW,CAAC,SAAS,IAAI,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC;IACrD,CAAC;IAHe,wBAAa,gBAG5B,CAAA;IAED,+DAA+D;IAC/D,SAAgB,QAAQ,CAAC,UAAsB;QAC7C,OAAO,CAAC,CAAE,UAA+B,CAAC,UAAU,CAAC;IACvD,CAAC;IAFe,mBAAQ,WAEvB,CAAA;AACH,CAAC,EAXgB,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAW1B;AAiBD,YAAY;AACZ,2DAA2D;AAC3D,IAAiB,WAAW,CA+L3B;AA/LD,WAAiB,WAAW;IAC1B;;;;OAIG;IACH,SAAgB,MAAM,CAAC,MAAoB;QACzC,MAAM,cAAc,GAAG;YACrB,YAAY,EAAE,IAAI,GAAG,EAAuB;YAC5C,MAAM,EAAE,IAAI,GAAG,EAA4B;SAC5C,CAAC;QACF,WAAW,CAAC,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;QACxC,OAAO,cAAc,CAAC;IACxB,CAAC;IAPe,kBAAM,SAOrB,CAAA;IAED;;;;OAIG;IACH,SAAgB,IAAI,CAAC,WAAwB;QAC3C,IAAI,cAAc,GAAG,CAAC,CAAC;QACvB,WAAW,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,GAAgB,EAAE,EAAE,CAAC,CAAC,cAAc,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QACrF,OAAO,cAAc,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC;IAClD,CAAC;IAJe,gBAAI,OAInB,CAAA;IAED;;;;OAIG;IACH,SAAgB,OAAO,CAAC,WAAwB;QAC9C,OAAO,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAC7C,CAAC;IAFe,mBAAO,UAEtB,CAAA;IAED;;;;;OAKG;IACH,SAAgB,GAAG,CAAC,WAAwB,EAAE,KAA2B;QACvE,IAAI,UAAU,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE;YACnC,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YAChE,MAAM,GAAG,GAAG,WAAW,CAAC,YAAY,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;YAC9D,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;SACrC;QACD,OAAO,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAClD,CAAC;IAPe,eAAG,MAOlB,CAAA;IAED;;;;;OAKG;IACH,SAAgB,MAAM,CAAC,WAAwB,EAAE,MAA8B;QAC7E,IAAI,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE;YACjD,OAAO,KAAK,CAAC;SACd;QACD,KAAK,MAAM,UAAU,IAAI,MAAM,EAAE;YAC/B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,CAAC,EAAE;gBAC7C,OAAO,KAAK,CAAC;aACd;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAVe,kBAAM,SAUrB,CAAA;IAED;;;;;OAKG;IACH,SAAgB,MAAM,CAAC,WAAwB,EAAE,MAA8B;QAC7E,KAAK,MAAM,UAAU,IAAI,MAAM,EAAE;YAC/B,IAAI,WAAW,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,CAAC,EAAE;gBAC5C,OAAO,IAAI,CAAC;aACb;SACF;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAPe,kBAAM,SAOrB,CAAA;IAED;;;;;OAKG;IACH,SAAgB,GAAG,CAAC,WAAwB,EAAE,MAAoB;QAChE,IAAI,UAAU,GAAG,KAAK,CAAC;QACvB,KAAK,MAAM,UAAU,IAAI,MAAM,EAAE;YAC/B,IAAI,UAAU,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE;gBACxC,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;gBACrE,IAAI,GAAG,GAAG,WAAW,CAAC,YAAY,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;gBAC5D,IAAI,CAAC,GAAG,EAAE;oBACR,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC;iBACzB;gBACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE;oBAC3B,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;oBACvB,WAAW,CAAC,YAAY,CAAC,GAAG,CAAC,mBAAmB,EAAE,GAAG,CAAC,CAAC;oBACvD,UAAU,GAAG,IAAI,CAAC;iBACnB;aACF;iBAAM,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;gBACzD,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;gBAC1D,UAAU,GAAG,IAAI,CAAC;aACnB;SACF;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IApBe,eAAG,MAoBlB,CAAA;IAED;;;;;OAKG;IACH,SAAgB,MAAM,CAAC,WAAwB,EAAE,MAAoB;QACnE,IAAI,UAAU,GAAG,KAAK,CAAC;QACvB,KAAK,MAAM,UAAU,IAAI,MAAM,EAAE;YAC/B,IAAI,UAAU,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE;gBACxC,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;gBACrE,MAAM,GAAG,GAAG,WAAW,CAAC,YAAY,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;gBAC9D,IAAI,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE;oBACjC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;oBAC1B,UAAU,GAAG,IAAI,CAAC;oBAClB,IAAI,GAAG,CAAC,IAAI,KAAK,CAAC,EAAE;wBAClB,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;qBACtD;iBACF;aACF;iBAAM,IAAI,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;gBACxD,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;gBACjD,UAAU,GAAG,IAAI,CAAC;aACnB;SACF;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAnBe,kBAAM,SAmBrB,CAAA;IAED;;;;OAIG;IACH,SAAgB,KAAK,CAAC,WAAwB;QAC5C,IAAI,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE;YACvC,OAAO,KAAK,CAAC;SACd;QACD,WAAW,CAAC,YAAY,GAAG,IAAI,GAAG,EAAuB,CAAC;QAC1D,WAAW,CAAC,MAAM,GAAG,IAAI,GAAG,EAA4B,CAAC;QACzD,OAAO,IAAI,CAAC;IACd,CAAC;IAPe,iBAAK,QAOpB,CAAA;IAED;;;;OAIG;IACH,SAAgB,IAAI,CAAC,WAAwB,EAAE,QAA6C;QAC1F,KAAK,MAAM,KAAK,IAAI,WAAW,CAAC,YAAY,EAAE;YAC5C,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE;gBAC3B,IAAI,QAAQ,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE;oBAC/C,OAAO,IAAI,CAAC;iBACb;aACF;SACF;QACD,KAAK,MAAM,KAAK,IAAI,WAAW,CAAC,MAAM,EAAE;YACtC,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;gBACtB,OAAO,IAAI,CAAC;aACb;SACF;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAde,gBAAI,OAcnB,CAAA;IAED;;;;OAIG;IACH,SAAgB,OAAO,CAAC,WAAwB,EAAE,QAAyD;QACzG,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,WAAW,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,GAAgB,EAAE,SAAiB,EAAE,EAAE;YACvE,GAAG,CAAC,OAAO,CAAC,CAAC,EAAU,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;QACH,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAClC,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC;IARe,mBAAO,UAQtB,CAAA;IAED,SAAS,kBAAkB,CAAC,SAAiB;QAC3C,OAAO,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACrC,CAAC;AACH,CAAC,EA/LgB,WAAW,GAAX,mBAAW,KAAX,mBAAW,QA+L3B","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\n/**\n * ECInstance selectable\n * @beta\n */\nexport interface SelectableInstanceKey {\n  /** Full class name in format `SchemaName:ClassName` or `SchemaName.ClassName`. */\n  className: string;\n  /** ECInstance ID */\n  id: string;\n}\n\n/**\n * A custom selectable\n * @beta\n */\nexport interface CustomSelectable {\n  /** Unique identifier of the selectable. */\n  identifier: string;\n  /** Asynchronous function for loading instance keys associated with this selectable. */\n  loadInstanceKeys: () => AsyncIterableIterator<SelectableInstanceKey>;\n  /** Custom data associated with the selectable. */\n  data: unknown;\n}\n\n/**\n * A single selectable that identifies something in an iTwin.js application\n * @beta\n */\nexport type Selectable = SelectableInstanceKey | CustomSelectable;\n\n/**\n * Type of identifier that can be used to identify selectable in storage.\n * @beta\n */\nexport type SelectableIdentifier = SelectableInstanceKey | Pick<CustomSelectable, \"identifier\">;\n\n/** @beta */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport namespace Selectable {\n  /** Check if the supplied selectable is a `SelectableInstanceKey` */\n  export function isInstanceKey(selectable: Selectable | SelectableIdentifier): selectable is SelectableInstanceKey {\n    const instanceKey = selectable as SelectableInstanceKey;\n    return !!instanceKey.className && !!instanceKey.id;\n  }\n\n  /** Check if the supplied selectable is a `CustomSelectable` */\n  export function isCustom(selectable: Selectable): selectable is CustomSelectable {\n    return !!(selectable as CustomSelectable).identifier;\n  }\n}\n\n/**\n * A collection of selectables that identify something that can be selected in an iTwin.js application\n * @beta\n */\nexport interface Selectables {\n  /**\n   * Map between `SelectableInstanceKey.className` and a set of selected element IDs.\n   */\n  instanceKeys: Map<string, Set<string>>;\n  /**\n   * Map between unique identifier of `CustomSelectable` and the selectable itself.\n   */\n  custom: Map<string, CustomSelectable>;\n}\n\n/** @beta */\n// eslint-disable-next-line @typescript-eslint/no-redeclare\nexport namespace Selectables {\n  /**\n   * Creates `Selectables` from array of selectable\n   * @param source Source to create selectables from\n   * @beta\n   */\n  export function create(source: Selectable[]): Selectables {\n    const newSelectables = {\n      instanceKeys: new Map<string, Set<string>>(),\n      custom: new Map<string, CustomSelectable>(),\n    };\n    Selectables.add(newSelectables, source);\n    return newSelectables;\n  }\n\n  /**\n   * Get the number of selectables stored in a `Selectables` object.\n   * @param selectables `Selectables` object to get size for\n   * @beta\n   */\n  export function size(selectables: Selectables): number {\n    let insatanceCount = 0;\n    selectables.instanceKeys.forEach((set: Set<string>) => (insatanceCount += set.size));\n    return insatanceCount + selectables.custom.size;\n  }\n\n  /**\n   * Is a `Selectables` object currently empty.\n   * @param selectables `Selectables` object to check\n   * @beta\n   */\n  export function isEmpty(selectables: Selectables): boolean {\n    return Selectables.size(selectables) === 0;\n  }\n\n  /**\n   * Check if a `Selectables` object contains the specified selectable.\n   * @param selectables `Selectables` object to check\n   * @param value The selectable to check for.\n   * @beta\n   */\n  export function has(selectables: Selectables, value: SelectableIdentifier): boolean {\n    if (Selectable.isInstanceKey(value)) {\n      const normalizedClassName = normalizeClassName(value.className);\n      const set = selectables.instanceKeys.get(normalizedClassName);\n      return !!(set && set.has(value.id));\n    }\n    return selectables.custom.has(value.identifier);\n  }\n\n  /**\n   * Check if a `Selectables` object contains all the specified selectables.\n   * @param selectables `Selectables` object to check\n   * @param values The selectables to check for.\n   * @beta\n   */\n  export function hasAll(selectables: Selectables, values: SelectableIdentifier[]): boolean {\n    if (Selectables.size(selectables) < values.length) {\n      return false;\n    }\n    for (const selectable of values) {\n      if (!Selectables.has(selectables, selectable)) {\n        return false;\n      }\n    }\n    return true;\n  }\n\n  /**\n   * Check if a `Selectables` object contains any of the specified selectables.\n   * @param selectables `Selectables` object to check\n   * @param values The selectables to check for.\n   * @beta\n   */\n  export function hasAny(selectables: Selectables, values: SelectableIdentifier[]): boolean {\n    for (const selectable of values) {\n      if (Selectables.has(selectables, selectable)) {\n        return true;\n      }\n    }\n    return false;\n  }\n\n  /**\n   * Add a one or more selectables to a `Selectables`\n   * @param selectables `Selectables` object to add selectables for\n   * @param values Selectables to add.\n   * @beta\n   */\n  export function add(selectables: Selectables, values: Selectable[]): boolean {\n    let hasChanged = false;\n    for (const selectable of values) {\n      if (Selectable.isInstanceKey(selectable)) {\n        const normalizedClassName = normalizeClassName(selectable.className);\n        let set = selectables.instanceKeys.get(normalizedClassName);\n        if (!set) {\n          set = new Set<string>();\n        }\n        if (!set.has(selectable.id)) {\n          set.add(selectable.id);\n          selectables.instanceKeys.set(normalizedClassName, set);\n          hasChanged = true;\n        }\n      } else if (!selectables.custom.has(selectable.identifier)) {\n        selectables.custom.set(selectable.identifier, selectable);\n        hasChanged = true;\n      }\n    }\n    return hasChanged;\n  }\n\n  /**\n   * Removes one or more selectables from a `Selectables` object.\n   * @param selectables `Selectables` object to remove selectables for\n   * @param values Selectables to remove.\n   * @beta\n   */\n  export function remove(selectables: Selectables, values: Selectable[]): boolean {\n    let hasChanged = false;\n    for (const selectable of values) {\n      if (Selectable.isInstanceKey(selectable)) {\n        const normalizedClassName = normalizeClassName(selectable.className);\n        const set = selectables.instanceKeys.get(normalizedClassName);\n        if (set && set.has(selectable.id)) {\n          set.delete(selectable.id);\n          hasChanged = true;\n          if (set.size === 0) {\n            selectables.instanceKeys.delete(normalizedClassName);\n          }\n        }\n      } else if (selectables.custom.has(selectable.identifier)) {\n        selectables.custom.delete(selectable.identifier);\n        hasChanged = true;\n      }\n    }\n    return hasChanged;\n  }\n\n  /**\n   * Clear a `Selectables` object.\n   * @param selectables `Selectables` object to clear selectables for\n   * @beta\n   */\n  export function clear(selectables: Selectables): boolean {\n    if (Selectables.size(selectables) === 0) {\n      return false;\n    }\n    selectables.instanceKeys = new Map<string, Set<string>>();\n    selectables.custom = new Map<string, CustomSelectable>();\n    return true;\n  }\n\n  /**\n   * Check whether at least one selectable passes a condition in a `Selectables` object.\n   * @param selectables `Selectables` object to check\n   * @beta\n   */\n  export function some(selectables: Selectables, callback: (selectable: Selectable) => boolean) {\n    for (const entry of selectables.instanceKeys) {\n      for (const item of entry[1]) {\n        if (callback({ className: entry[0], id: item })) {\n          return true;\n        }\n      }\n    }\n    for (const entry of selectables.custom) {\n      if (callback(entry[1])) {\n        return true;\n      }\n    }\n    return false;\n  }\n\n  /**\n   * Iterate over all keys in a `Selectables` object.\n   * @param selectables `Selectables` object to iterate over\n   * @beta\n   */\n  export function forEach(selectables: Selectables, callback: (selectable: Selectable, index: number) => void) {\n    let index = 0;\n    selectables.instanceKeys.forEach((ids: Set<string>, className: string) => {\n      ids.forEach((id: string) => callback({ className, id }, index++));\n    });\n    selectables.custom.forEach((data) => {\n      callback(data, index++);\n    });\n  }\n\n  function normalizeClassName(className: string): string {\n    return className.replace(\".\", \":\");\n  }\n}\n"]}

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

@@ -0,0 +1,89 @@
+import { Selectables } from "./Selectable";
+import { SelectionStorage } from "./SelectionStorage";
+/** @packageDocumentation
+ * @module UnifiedSelection
+ */
+/**
+ * The type of selection change
+ * @beta
+ */
+export type StorageSelectionChangeType = 
+/** Added to selection. */
+"add"
+/** Removed from selection. */
+ | "remove"
+/** Selection was replaced. */
+ | "replace"
+/** Selection was cleared. */
+ | "clear";
+/**
+ * The event object that is sent when the selection changes.
+ * @beta
+ */
+export interface StorageSelectionChangeEventArgs {
+    /** The name of the selection source which caused the selection change. */
+    source: string;
+    /** Level of the selection. */
+    level: number;
+    /** The selection change type. */
+    changeType: StorageSelectionChangeType;
+    /** Selectables affected by this selection change event. */
+    selectables: Selectables;
+    /** iModel key with which the selection is associated with. */
+    iModelKey: string;
+    /** The timestamp of when the selection change happened */
+    timestamp: Date;
+}
+/**
+ * An interface for selection change listeners
+ * @beta
+ */
+export declare type StorageSelectionChangesListener = (args: StorageSelectionChangeEventArgs, storage: SelectionStorage) => void;
+/**
+ * An interface that allows subscribing and unsubscribing listeners that
+ * are called when a selection has changed.
+ * @beta
+ */
+export interface SelectionChangeEvent {
+    /**
+     * Registers a Listener to be executed whenever this event is raised
+     * @param listener The function to be executed when the event is raised
+     * @returns A function that will remove this event listener
+     * @beta
+     */
+    addListener(listener: StorageSelectionChangesListener): () => void;
+    /**
+     * Un-register a previously registered listener
+     * @param listener The listener to be unregistered
+     * @beta
+     */
+    removeListener(listener: StorageSelectionChangesListener): void;
+}
+/**
+ * An event broadcasted on selection changes
+ * @internal
+ */
+export declare class SelectionChangeEventImpl implements SelectionChangeEvent {
+    private _listeners;
+    /**
+     * Registers a Listener to be executed whenever this event is raised
+     * @param listener The function to be executed when the event is raised
+     * @returns A function that will remove this event listener
+     * @beta
+     */
+    addListener(listener: StorageSelectionChangesListener): () => void;
+    /**
+     * Un-register a previously registered listener
+     * @param listener The listener to be unregistered
+     * @beta
+     */
+    removeListener(listener: StorageSelectionChangesListener): void;
+    /**
+     * Raises the event by calling each registered listener with the supplied arguments
+     * @param args Event arguments
+     * @param storage Storage that the selection changed in
+     * @beta
+     */
+    raiseEvent(args: StorageSelectionChangeEventArgs, storage: SelectionStorage): void;
+}
+//# sourceMappingURL=SelectionChangeEvent.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SelectionChangeEvent.d.ts","sourceRoot":"","sources":["../../../src/unified-selection/SelectionChangeEvent.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD;;GAEG;AAEH;;;GAGG;AACH,MAAM,MAAM,0BAA0B;AACpC,0BAA0B;AACxB,KAAK;AACP,8BAA8B;GAC5B,QAAQ;AACV,8BAA8B;GAC5B,SAAS;AACX,6BAA6B;GAC3B,OAAO,CAAC;AAEZ;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C,0EAA0E;IAC1E,MAAM,EAAE,MAAM,CAAC;IACf,8BAA8B;IAC9B,KAAK,EAAE,MAAM,CAAC;IACd,iCAAiC;IACjC,UAAU,EAAE,0BAA0B,CAAC;IACvC,2DAA2D;IAC3D,WAAW,EAAE,WAAW,CAAC;IACzB,8DAA8D;IAC9D,SAAS,EAAE,MAAM,CAAC;IAClB,0DAA0D;IAC1D,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,MAAM,+BAA+B,GAAG,CAAC,IAAI,EAAE,+BAA+B,EAAE,OAAO,EAAE,gBAAgB,KAAK,IAAI,CAAC;AAEjI;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,WAAW,CAAC,QAAQ,EAAE,+BAA+B,GAAG,MAAM,IAAI,CAAC;IACnE;;;;OAIG;IACH,cAAc,CAAC,QAAQ,EAAE,+BAA+B,GAAG,IAAI,CAAC;CACjE;AAED;;;GAGG;AACH,qBAAa,wBAAyB,YAAW,oBAAoB;IACnE,OAAO,CAAC,UAAU,CAAyC;IAE3D;;;;;OAKG;IACI,WAAW,CAAC,QAAQ,EAAE,+BAA+B,GAAG,MAAM,IAAI;IAKzE;;;;OAIG;IACI,cAAc,CAAC,QAAQ,EAAE,+BAA+B,GAAG,IAAI;IAItE;;;;;OAKG;IACI,UAAU,CAAC,IAAI,EAAE,+BAA+B,EAAE,OAAO,EAAE,gBAAgB;CAGnF"}

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

@@ -0,0 +1,43 @@
+"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.SelectionChangeEventImpl = void 0;
+/**
+ * An event broadcasted on selection changes
+ * @internal
+ */
+class SelectionChangeEventImpl {
+    _listeners = [];
+    /**
+     * Registers a Listener to be executed whenever this event is raised
+     * @param listener The function to be executed when the event is raised
+     * @returns A function that will remove this event listener
+     * @beta
+     */
+    addListener(listener) {
+        this._listeners.push(listener);
+        return () => this.removeListener(listener);
+    }
+    /**
+     * Un-register a previously registered listener
+     * @param listener The listener to be unregistered
+     * @beta
+     */
+    removeListener(listener) {
+        this._listeners = this._listeners.filter((x) => x !== listener);
+    }
+    /**
+     * Raises the event by calling each registered listener with the supplied arguments
+     * @param args Event arguments
+     * @param storage Storage that the selection changed in
+     * @beta
+     */
+    raiseEvent(args, storage) {
+        this._listeners.forEach((listener) => listener(args, storage));
+    }
+}
+exports.SelectionChangeEventImpl = SelectionChangeEventImpl;
+//# sourceMappingURL=SelectionChangeEvent.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SelectionChangeEvent.js","sourceRoot":"","sources":["../../../src/unified-selection/SelectionChangeEvent.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;AAqEhG;;;GAGG;AACH,MAAa,wBAAwB;IAC3B,UAAU,GAAsC,EAAE,CAAC;IAE3D;;;;;OAKG;IACI,WAAW,CAAC,QAAyC;QAC1D,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC/B,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,QAAyC;QAC7D,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC;IAClE,CAAC;IAED;;;;;OAKG;IACI,UAAU,CAAC,IAAqC,EAAE,OAAyB;QAChF,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;IACjE,CAAC;CACF;AAhCD,4DAgCC","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 { Selectables } from \"./Selectable\";\nimport { SelectionStorage } from \"./SelectionStorage\";\n\n/** @packageDocumentation\n * @module UnifiedSelection\n */\n\n/**\n * The type of selection change\n * @beta\n */\nexport type StorageSelectionChangeType =\n  /** Added to selection. */\n  | \"add\"\n  /** Removed from selection. */\n  | \"remove\"\n  /** Selection was replaced. */\n  | \"replace\"\n  /** Selection was cleared. */\n  | \"clear\";\n\n/**\n * The event object that is sent when the selection changes.\n * @beta\n */\nexport interface StorageSelectionChangeEventArgs {\n  /** The name of the selection source which caused the selection change. */\n  source: string;\n  /** Level of the selection. */\n  level: number;\n  /** The selection change type. */\n  changeType: StorageSelectionChangeType;\n  /** Selectables affected by this selection change event. */\n  selectables: Selectables;\n  /** iModel key with which the selection is associated with. */\n  iModelKey: string;\n  /** The timestamp of when the selection change happened */\n  timestamp: Date;\n}\n\n/**\n * An interface for selection change listeners\n * @beta\n */\nexport declare type StorageSelectionChangesListener = (args: StorageSelectionChangeEventArgs, storage: SelectionStorage) => void;\n\n/**\n * An interface that allows subscribing and unsubscribing listeners that\n * are called when a selection has changed.\n * @beta\n */\nexport interface SelectionChangeEvent {\n  /**\n   * Registers a Listener to be executed whenever this event is raised\n   * @param listener The function to be executed when the event is raised\n   * @returns A function that will remove this event listener\n   * @beta\n   */\n  addListener(listener: StorageSelectionChangesListener): () => void;\n  /**\n   * Un-register a previously registered listener\n   * @param listener The listener to be unregistered\n   * @beta\n   */\n  removeListener(listener: StorageSelectionChangesListener): void;\n}\n\n/**\n * An event broadcasted on selection changes\n * @internal\n */\nexport class SelectionChangeEventImpl implements SelectionChangeEvent {\n  private _listeners: StorageSelectionChangesListener[] = [];\n\n  /**\n   * Registers a Listener to be executed whenever this event is raised\n   * @param listener The function to be executed when the event is raised\n   * @returns A function that will remove this event listener\n   * @beta\n   */\n  public addListener(listener: StorageSelectionChangesListener): () => void {\n    this._listeners.push(listener);\n    return () => this.removeListener(listener);\n  }\n\n  /**\n   * Un-register a previously registered listener\n   * @param listener The listener to be unregistered\n   * @beta\n   */\n  public removeListener(listener: StorageSelectionChangesListener): void {\n    this._listeners = this._listeners.filter((x) => x !== listener);\n  }\n\n  /**\n   * Raises the event by calling each registered listener with the supplied arguments\n   * @param args Event arguments\n   * @param storage Storage that the selection changed in\n   * @beta\n   */\n  public raiseEvent(args: StorageSelectionChangeEventArgs, storage: SelectionStorage) {\n    this._listeners.forEach((listener) => listener(args, storage));\n  }\n}\n"]}