@itwin/unified-selection 0.1.0

package/lib/esm/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,MAAM,KAAW,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,KAAV,UAAU,QAW1B;AAiBD,YAAY;AACZ,2DAA2D;AAC3D,MAAM,KAAW,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,KAAX,WAAW,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/esm/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/esm/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/esm/unified-selection/SelectionChangeEvent.js

@@ -0,0 +1,39 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/**
+ * An event broadcasted on selection changes
+ * @internal
+ */
+export 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));
+    }
+}
+//# sourceMappingURL=SelectionChangeEvent.js.map

package/lib/esm/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,MAAM,OAAO,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","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"]}

package/lib/esm/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/esm/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/esm/unified-selection/SelectionStorage.js

@@ -0,0 +1,128 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module UnifiedSelection
+ */
+import { Selectables } from "./Selectable";
+import { SelectionChangeEventImpl } from "./SelectionChangeEvent";
+/**
+ * Creates a selection storage. When an iModel is closed `SelectionStorage.clearSelection` function should be called.
+ * @beta
+ */
+export function createStorage() {
+    return new SelectionStorageImpl();
+}
+class SelectionStorageImpl {
+    _storage = new Map();
+    selectionChangeEvent;
+    constructor() {
+        this.selectionChangeEvent = new 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 = Selectables.create(change);
+        switch (changeType) {
+            case "add":
+                if (!Selectables.add(selectables, change)) {
+                    return;
+                }
+                break;
+            case "remove":
+                if (!Selectables.remove(selectables, change)) {
+                    return;
+                }
+                break;
+            case "replace":
+                if (Selectables.size(selectables) === Selectables.size(selected) && Selectables.hasAll(selectables, change)) {
+                    return;
+                }
+                Selectables.clear(selectables);
+                Selectables.add(selectables, change);
+                break;
+            case "clear":
+                if (!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 = Selectables.create([]);
+            this._selectablesContainers.set(level, selectables);
+        }
+        return selectables;
+    }
+    getSelectionLevels() {
+        const levels = new Array();
+        for (const entry of this._selectablesContainers.entries()) {
+            if (!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);
+                Selectables.clear(selectables);
+            }
+        }
+    }
+}
+//# sourceMappingURL=SelectionStorage.js.map

package/lib/esm/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,OAAO,EAAc,WAAW,EAAE,MAAM,cAAc,CAAC;AACvD,OAAO,EAAwB,wBAAwB,EAA+D,MAAM,wBAAwB,CAAC;AA6ErJ;;;GAGG;AACH,MAAM,UAAU,aAAa;IAC3B,OAAO,IAAI,oBAAoB,EAAE,CAAC;AACpC,CAAC;AAED,MAAM,oBAAoB;IAChB,QAAQ,GAAG,IAAI,GAAG,EAA0C,CAAC;IAC9D,oBAAoB,CAA2B;IAEtD;QACE,IAAI,CAAC,oBAAoB,GAAG,IAAI,wBAAwB,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,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC5C,QAAQ,UAAU,EAAE;YAClB,KAAK,KAAK;gBACR,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE;oBACzC,OAAO;iBACR;gBACD,MAAM;YACR,KAAK,QAAQ;gBACX,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE;oBAC5C,OAAO;iBACR;gBACD,MAAM;YACR,KAAK,SAAS;gBACZ,IAAI,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,WAAW,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE;oBAC3G,OAAO;iBACR;gBACD,WAAW,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;gBAC/B,WAAW,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;gBACrC,MAAM;YACR,KAAK,OAAO;gBACV,IAAI,CAAC,WAAW,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,WAAW,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,WAAW,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,WAAW,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/esm/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/esm/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/esm/unified-selection.js

@@ -0,0 +1,13 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+/**
+ * @module UnifiedSelection
+ *
+ * @docs-group-description UnifiedSelection
+ * API for working with unified selection.
+ */
+export * from "./unified-selection/Selectable";
+export * from "./unified-selection/SelectionStorage";
+//# sourceMappingURL=unified-selection.js.map

package/lib/esm/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,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sCAAsC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n\n/**\n * @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/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@itwin/unified-selection",
+  "version": "0.1.0",
+  "description": "Package for managing unified selection",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/iTwin/presentation.git",
+    "directory": "packages/unified-selection"
+  },
+  "keywords": [
+    "Bentley",
+    "EC",
+    "Unified selection",
+    "iTwin.js"
+  ],
+  "author": {
+    "name": "Bentley Systems, Inc.",
+    "url": "http://www.bentley.com"
+  },
+  "main": "lib/cjs/unified-selection.js",
+  "module": "lib/esm/unified-selection.js",
+  "types": "lib/cjs/unified-selection.d.ts",
+  "dependencies": {},
+  "devDependencies": {
+    "@itwin/build-tools": "^4.4.0",
+    "@itwin/eslint-plugin": "4.0.0-dev.48",
+    "@types/chai": "^4.3.11",
+    "@types/chai-as-promised": "^7.1.8",
+    "@types/mocha": "^10.0.6",
+    "@types/node": "^18.17.7",
+    "@types/sinon": "^17.0.3",
+    "@types/sinon-chai": "^3.2.12",
+    "chai": "^4.4.1",
+    "chai-as-promised": "^7.1.1",
+    "cpx2": "^7.0.1",
+    "eslint": "^8.56.0",
+    "mocha": "^10.3.0",
+    "nyc": "^15.1.0",
+    "sinon": "^17.0.1",
+    "sinon-chai": "^3.7.0",
+    "source-map-support": "^0.5.21",
+    "typescript": "~5.0.4"
+  },
+  "scripts": {
+    "build": "npm run -s build:cjs && npm run -s build:esm",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:watch": "npm run -s build:cjs -- -w",
+    "clean": "rimraf lib build",
+    "cover": "nyc npm -s test",
+    "lint": "eslint ./src/**/*.ts",
+    "test": "mocha --config ./.mocharc.json \"./lib/cjs/test/**/*.test.js\"",
+    "test:watch": "npm -s test -- --reporter min --watch-extensions ts --watch",
+    "extract-api": "betools extract-api --entry=unified-selection --apiReportFolder=./api --apiReportTempFolder=./api/temp --apiSummaryFolder=./api",
+    "check-internal": "node ../../scripts/checkInternal.js --apiSummary ./api/unified-selection.api.md"
+  }
+}