@itwin/unified-selection 1.0.1 → 1.1.1

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

@@ -1 +1 @@
-{"version":3,"file":"Selectable.js","sourceRoot":"","sources":["../../../src/unified-selection/Selectable.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAGhG,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AA6CpE,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,CA2L3B;AA3LD,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,CAAC;YACpC,MAAM,mBAAmB,GAAG,sBAAsB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACpE,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;QACtC,CAAC;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,CAAC;YAClD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,KAAK,MAAM,UAAU,IAAI,MAAM,EAAE,CAAC;YAChC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,CAAC,EAAE,CAAC;gBAC9C,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;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,CAAC;YAChC,IAAI,WAAW,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,CAAC,EAAE,CAAC;gBAC7C,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;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,CAAC;YAChC,IAAI,UAAU,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;gBACzC,MAAM,mBAAmB,GAAG,sBAAsB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;gBACzE,IAAI,GAAG,GAAG,WAAW,CAAC,YAAY,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;gBAC5D,IAAI,CAAC,GAAG,EAAE,CAAC;oBACT,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC;gBAC1B,CAAC;gBACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC;oBAC5B,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;gBACpB,CAAC;YACH,CAAC;iBAAM,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC1D,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;gBAC1D,UAAU,GAAG,IAAI,CAAC;YACpB,CAAC;QACH,CAAC;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,CAAC;YAChC,IAAI,UAAU,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;gBACzC,MAAM,mBAAmB,GAAG,sBAAsB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;gBACzE,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,CAAC;oBAClC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;oBAC1B,UAAU,GAAG,IAAI,CAAC;oBAClB,IAAI,GAAG,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;wBACnB,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;oBACvD,CAAC;gBACH,CAAC;YACH,CAAC;iBAAM,IAAI,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;gBACzD,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;gBACjD,UAAU,GAAG,IAAI,CAAC;YACpB,CAAC;QACH,CAAC;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,CAAC;YACxC,OAAO,KAAK,CAAC;QACf,CAAC;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,CAAC;YAC7C,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5B,IAAI,QAAQ,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;oBAChD,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC;QACH,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;YACvC,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACvB,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;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;AACH,CAAC,EA3LgB,WAAW,KAAX,WAAW,QA2L3B","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 { Id64String } from \"@itwin/core-bentley\";\nimport { normalizeFullClassName } from \"@itwin/presentation-shared\";\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, which has an identifier, knows how to loads its associated selectable instance keys\n * and has custom data associated with it.\n *\n * An example of such selectable could be an instance grouping node:\n * - `identifier` could be a GUID, associated with the node,\n * - `loadInstanceKeys` would know how to load grouped instance keys from the node,\n * - `data` could be set to the node itself.\n *\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 that can be selected in an iTwin.js application.\n * @beta\n */\nexport type Selectable = SelectableInstanceKey | CustomSelectable;\n\n/**\n * A type of identifier that can be used to identify a selectable in selection 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   * A map between `SelectableInstanceKey.className` and a set of selected instance IDs.\n   */\n  instanceKeys: Map<string, Set<Id64String>>;\n  /**\n   * A map between `CustomSelectable.identifier` 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 = normalizeFullClassName(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 = normalizeFullClassName(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 = normalizeFullClassName(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"]}
+{"version":3,"file":"Selectable.js","sourceRoot":"","sources":["../../../src/unified-selection/Selectable.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAGhG,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AA6CpE,cAAc;AACd,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;;;GAGG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,YAAY,CAAC;AAExD,cAAc;AACd,MAAM,KAAW,WAAW,CA2L3B;AA3LD,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,CAAC;YACpC,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;QACtC,CAAC;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,CAAC;YAClD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,KAAK,MAAM,UAAU,IAAI,MAAM,EAAE,CAAC;YAChC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,CAAC,EAAE,CAAC;gBAC9C,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;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,CAAC;YAChC,IAAI,WAAW,CAAC,GAAG,CAAC,WAAW,EAAE,UAAU,CAAC,EAAE,CAAC;gBAC7C,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;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,CAAC;YAChC,IAAI,UAAU,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;gBACzC,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,CAAC;oBACT,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC;gBAC1B,CAAC;gBACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC;oBAC5B,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;gBACpB,CAAC;YACH,CAAC;iBAAM,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC1D,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;gBAC1D,UAAU,GAAG,IAAI,CAAC;YACpB,CAAC;QACH,CAAC;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,CAAC;YAChC,IAAI,UAAU,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,CAAC;gBACzC,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,CAAC;oBAClC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;oBAC1B,UAAU,GAAG,IAAI,CAAC;oBAClB,IAAI,GAAG,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;wBACnB,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC;oBACvD,CAAC;gBACH,CAAC;YACH,CAAC;iBAAM,IAAI,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;gBACzD,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;gBACjD,UAAU,GAAG,IAAI,CAAC;YACpB,CAAC;QACH,CAAC;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,CAAC;YACxC,OAAO,KAAK,CAAC;QACf,CAAC;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,CAAC;YAC7C,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5B,IAAI,QAAQ,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;oBAChD,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC;QACH,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;YACvC,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACvB,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;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;AACH,CAAC,EA3LgB,WAAW,KAAX,WAAW,QA2L3B;AAED,SAAS,kBAAkB,CAAC,aAAqB;IAC/C,OAAO,aAAa,KAAK,2BAA2B,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC;AAC/G,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\nimport { Id64String } from \"@itwin/core-bentley\";\nimport { normalizeFullClassName } from \"@itwin/presentation-shared\";\n\n/**\n * ECInstance selectable\n * @public\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, which has an identifier, knows how to loads its associated selectable instance keys\n * and has custom data associated with it.\n *\n * An example of such selectable could be an instance grouping node:\n * - `identifier` could be a GUID, associated with the node,\n * - `loadInstanceKeys` would know how to load grouped instance keys from the node,\n * - `data` could be set to the node itself.\n *\n * @public\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 that can be selected in an iTwin.js application.\n * @public\n */\nexport type Selectable = SelectableInstanceKey | CustomSelectable;\n\n/**\n * A type of identifier that can be used to identify a selectable in selection storage.\n * @public\n */\nexport type SelectableIdentifier = SelectableInstanceKey | Pick<CustomSelectable, \"identifier\">;\n\n/** @public */\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 * @public\n */\nexport interface Selectables {\n  /**\n   * A map between `SelectableInstanceKey.className` and a set of selected instance IDs.\n   */\n  instanceKeys: Map<string, Set<Id64String>>;\n  /**\n   * A map between `CustomSelectable.identifier` and the selectable itself.\n   */\n  custom: Map<string, CustomSelectable>;\n}\n\n/**\n * Class name used to create `SelectableInstanceKey` for transient elements.\n * @public\n */\nexport const TRANSIENT_ELEMENT_CLASSNAME = \"/TRANSIENT\";\n\n/** @public */\nexport namespace Selectables {\n  /**\n   * Creates `Selectables` from array of selectable\n   * @param source Source to create selectables from\n   * @public\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   * @public\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   * @public\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   * @public\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   * @public\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   * @public\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   * @public\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   * @public\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   * @public\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   * @public\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   * @public\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\nfunction normalizeClassName(fullClassName: string) {\n  return fullClassName === TRANSIENT_ELEMENT_CLASSNAME ? fullClassName : normalizeFullClassName(fullClassName);\n}\n"]}

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

@@ -1,8 +1,8 @@
-import { Selectables } from "./Selectable";
-import { SelectionStorage } from "./SelectionStorage";
+import { Selectables } from "./Selectable.js";
+import { SelectionStorage } from "./SelectionStorage.js";
 /**
  * The type of selection change.
- * @beta
+ * @public
  */
 export type StorageSelectionChangeType = 
 /** Added to selection. */
@@ -20,7 +20,7 @@ export type StorageSelectionChangeType =
  * by package consumers, may be supplemented with required attributes any time.
  *
  * @see `StorageSelectionChangesListener`
- * @beta
+ * @public
  */
 export interface StorageSelectionChangeEventArgs {
     /** The name of the selection source which caused the selection change. */
@@ -45,7 +45,7 @@ export interface StorageSelectionChangeEventArgs {
 }
 /**
  * An interface for selection change listeners.
- * @beta
+ * @public
  */
 export type StorageSelectionChangesListener = (
 /** Arguments for the selection change event */

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

@@ -1 +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;;;GAGG;AACH,MAAM,MAAM,0BAA0B;AACpC,0BAA0B;AACxB,KAAK;AACP,8BAA8B;GAC5B,QAAQ;AACV,8BAA8B;GAC5B,SAAS;AACX,6BAA6B;GAC3B,OAAO,CAAC;AAEZ;;;;;;;;GAQG;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;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,2DAA2D;IAC3D,SAAS,EAAE,IAAI,CAAC;IAChB,sDAAsD;IACtD,OAAO,EAAE,gBAAgB,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG;AAC5C,+CAA+C;AAC/C,IAAI,EAAE,+BAA+B;AACrC,2DAA2D;AAC3D,CAAC,CAAC,EAAE,GAAG,KACJ,IAAI,CAAC"}
+{"version":3,"file":"SelectionChangeEvent.d.ts","sourceRoot":"","sources":["../../../src/unified-selection/SelectionChangeEvent.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD;;;GAGG;AACH,MAAM,MAAM,0BAA0B;AACpC,0BAA0B;AACxB,KAAK;AACP,8BAA8B;GAC5B,QAAQ;AACV,8BAA8B;GAC5B,SAAS;AACX,6BAA6B;GAC3B,OAAO,CAAC;AAEZ;;;;;;;;GAQG;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;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,2DAA2D;IAC3D,SAAS,EAAE,IAAI,CAAC;IAChB,sDAAsD;IACtD,OAAO,EAAE,gBAAgB,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG;AAC5C,+CAA+C;AAC/C,IAAI,EAAE,+BAA+B;AACrC,2DAA2D;AAC3D,CAAC,CAAC,EAAE,GAAG,KACJ,IAAI,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"SelectionChangeEvent.js","sourceRoot":"","sources":["../../../src/unified-selection/SelectionChangeEvent.ts"],"names":[],"mappings":"AAAA;;;gGAGgG","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/**\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 *\n * **Warning:** Used in public API as an input to consumer-supplied callback. Not expected to be created / extended\n * by package consumers, may be supplemented with required attributes any time.\n *\n * @see `StorageSelectionChangesListener`\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  /**\n   * iModel key with which the selection is associated with.\n   * @deprecated in 0.2. Use `imodelKey` instead.\n   */\n  iModelKey: string;\n  /** The timestamp of when the selection change happened. */\n  timestamp: Date;\n  /** The selection storage where the event happened. */\n  storage: SelectionStorage;\n}\n\n/**\n * An interface for selection change listeners.\n * @beta\n */\nexport type StorageSelectionChangesListener = (\n  /** Arguments for the selection change event */\n  args: StorageSelectionChangeEventArgs,\n  /** Unused. Temporarily left to avoid a breaking change. */\n  _?: any,\n) => void;\n"]}
+{"version":3,"file":"SelectionChangeEvent.js","sourceRoot":"","sources":["../../../src/unified-selection/SelectionChangeEvent.ts"],"names":[],"mappings":"AAAA;;;gGAGgG","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.js\";\nimport { SelectionStorage } from \"./SelectionStorage.js\";\n\n/**\n * The type of selection change.\n * @public\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 *\n * **Warning:** Used in public API as an input to consumer-supplied callback. Not expected to be created / extended\n * by package consumers, may be supplemented with required attributes any time.\n *\n * @see `StorageSelectionChangesListener`\n * @public\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  /**\n   * iModel key with which the selection is associated with.\n   * @deprecated in 0.2. Use `imodelKey` instead.\n   */\n  iModelKey: string;\n  /** The timestamp of when the selection change happened. */\n  timestamp: Date;\n  /** The selection storage where the event happened. */\n  storage: SelectionStorage;\n}\n\n/**\n * An interface for selection change listeners.\n * @public\n */\nexport type StorageSelectionChangesListener = (\n  /** Arguments for the selection change event */\n  args: StorageSelectionChangeEventArgs,\n  /** Unused. Temporarily left to avoid a breaking change. */\n  _?: any,\n) => void;\n"]}

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

@@ -1,13 +1,13 @@
 import { ECSqlQueryExecutor } from "@itwin/presentation-shared";
-import { SelectableInstanceKey } from "./Selectable";
+import { SelectableInstanceKey } from "./Selectable.js";
 /**
  * Available selection scopes.
- * @beta
+ * @public
  */
 export type SelectionScope = "element" | "model" | "category" | "functional";
 /**
  * Props for computing element selection.
- * @beta
+ * @public
  */
 export interface ElementSelectionScopeProps {
     /** Identifies this as either "element" or "functional" selection scope */
@@ -24,7 +24,7 @@ export interface ElementSelectionScopeProps {
 }
 /**
  * Props for `computeSelection`.
- * @beta
+ * @public
  */
 export interface ComputeSelectionProps {
     /** iModel query executor. */
@@ -38,7 +38,7 @@ export interface ComputeSelectionProps {
 }
 /**
  * Computes selection from given element IDs.
- * @beta
+ * @public
  */
 export declare function computeSelection(props: ComputeSelectionProps): AsyncIterableIterator<SelectableInstanceKey>;
 //# sourceMappingURL=SelectionScope.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"SelectionScope.d.ts","sourceRoot":"","sources":["../../../src/unified-selection/SelectionScope.ts"],"names":[],"mappings":"AAMA,OAAO,EAA+B,kBAAkB,EAAiB,MAAM,4BAA4B,CAAC;AAC5G,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAGrD;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,OAAO,GAAG,UAAU,GAAG,YAAY,CAAC;AAE7E;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,0EAA0E;IAC1E,EAAE,EAAE,SAAS,GAAG,YAAY,CAAC;IAC7B;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,6BAA6B;IAC7B,aAAa,EAAE,kBAAkB,CAAC;IAClC,gDAAgD;IAChD,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,iDAAiD;IACjD,KAAK,EAAE,0BAA0B,GAAG;QAAE,EAAE,EAAE,cAAc,CAAA;KAAE,GAAG,cAAc,CAAC;CAC7E;AAED;;;GAGG;AACH,wBAAuB,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,GAAG,qBAAqB,CAAC,qBAAqB,CAAC,CAwBlH"}
+{"version":3,"file":"SelectionScope.d.ts","sourceRoot":"","sources":["../../../src/unified-selection/SelectionScope.ts"],"names":[],"mappings":"AAMA,OAAO,EAA+B,kBAAkB,EAAiB,MAAM,4BAA4B,CAAC;AAC5G,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAGxD;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,OAAO,GAAG,UAAU,GAAG,YAAY,CAAC;AAE7E;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,0EAA0E;IAC1E,EAAE,EAAE,SAAS,GAAG,YAAY,CAAC;IAC7B;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,6BAA6B;IAC7B,aAAa,EAAE,kBAAkB,CAAC;IAClC,gDAAgD;IAChD,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,iDAAiD;IACjD,KAAK,EAAE,0BAA0B,GAAG;QAAE,EAAE,EAAE,cAAc,CAAA;KAAE,GAAG,cAAc,CAAC;CAC7E;AAED;;;GAGG;AACH,wBAAuB,gBAAgB,CAAC,KAAK,EAAE,qBAAqB,GAAG,qBAAqB,CAAC,qBAAqB,CAAC,CAwBlH"}

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

@@ -3,10 +3,10 @@
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
 import { Id64 } from "@itwin/core-bentley";
-import { formIdBindings, genericExecuteQuery } from "./Utils";
+import { formIdBindings, genericExecuteQuery } from "./Utils.js";
 /**
  * Computes selection from given element IDs.
- * @beta
+ * @public
  */
 export async function* computeSelection(props) {
     const { queryExecutor, elementIds, scope } = props;

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

@@ -1 +1 @@
-{"version":3,"file":"SelectionScope.js","sourceRoot":"","sources":["../../../src/unified-selection/SelectionScope.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAG3C,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAuC9D;;;GAGG;AACH,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC,gBAAgB,CAAC,KAA4B;IAClE,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;IAEnD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,KAAK,CAAC,CAAC,gBAAgB,CAAC,EAAE,aAAa,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QAC7E,OAAO;IACT,CAAC;IAED,MAAM,gBAAgB,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;IAE5E,QAAQ,KAAK,CAAC,EAAE,EAAE,CAAC;QACjB,KAAK,SAAS;YACZ,KAAK,CAAC,CAAC,uBAAuB,CAAC,aAAa,EAAE,gBAAgB,EAAG,KAAoC,CAAC,aAAa,IAAI,CAAC,CAAC,CAAC;YAC1H,OAAO;QACT,KAAK,UAAU;YACb,KAAK,CAAC,CAAC,wBAAwB,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;YACjE,OAAO;QACT,KAAK,OAAO;YACV,KAAK,CAAC,CAAC,qBAAqB,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;YAC9D,OAAO;QACT,KAAK,YAAY;YACf,KAAK,CAAC,CAAC,iCAAiC,CAAC,aAAa,EAAE,gBAAgB,EAAG,KAAoC,CAAC,aAAa,IAAI,CAAC,CAAC,CAAC;YACpI,OAAO;IACX,CAAC;AACH,CAAC;AAED,KAAK,SAAS,CAAC,CAAC,uBAAuB,CACrC,aAAiC,EACjC,UAAoB,EACpB,aAAqB;IAErB,MAAM,QAAQ,GAAmB,EAAE,CAAC;IACpC,MAAM,gBAAgB,GAAG,aAAa,GAAG,CAAC,CAAC;IAC3C,MAAM,IAAI,GAAG;QACX;;0CAEsC,wBAAwB,CAAC,aAAa,EAAE,QAAQ,CAAC;;gBAE3E,cAAc,CAAC,cAAc,EAAE,UAAU,EAAE,QAAQ,CAAC;;;;;gBAKpD,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,eAAe;;KAElD;KACF,CAAC;IACF,MAAM,KAAK,GAAG;;;YAGJ,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc;GAC/C,CAAC;IACF,KAAK,CAAC,CAAC,YAAY,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;AAChE,CAAC;AAED,KAAK,SAAS,CAAC,CAAC,wBAAwB,CAAC,aAAiC,EAAE,GAAa;IACvF,MAAM,QAAQ,GAAmB,EAAE,CAAC;IACpC,MAAM,KAAK,GAAG;QACZ;;;;cAIU,cAAc,CAAC,iBAAiB,EAAE,GAAG,EAAE,QAAQ,CAAC;KACzD;QACD;;;;cAIU,cAAc,CAAC,iBAAiB,EAAE,GAAG,EAAE,QAAQ,CAAC;KACzD;KACF,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACtB,KAAK,CAAC,CAAC,YAAY,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;AAC1D,CAAC;AAED,KAAK,SAAS,CAAC,CAAC,qBAAqB,CAAC,aAAiC,EAAE,GAAa;IACpF,MAAM,QAAQ,GAAmB,EAAE,CAAC;IACpC,MAAM,KAAK,GAAG;;;;YAIJ,cAAc,CAAC,gBAAgB,EAAE,GAAG,EAAE,QAAQ,CAAC;GACxD,CAAC;IACF,KAAK,CAAC,CAAC,YAAY,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;AAC1D,CAAC;AAED,KAAK,SAAS,CAAC,CAAC,iCAAiC,CAC/C,aAAiC,EACjC,GAAa,EACb,aAAqB;IAErB,MAAM,QAAQ,GAAmB,EAAE,CAAC;IACpC,MAAM,gBAAgB,GAAG,aAAa,GAAG,CAAC,CAAC;IAC3C,MAAM,IAAI,GAAG;QACX;;;;gBAIY,cAAc,CAAC,cAAc,EAAE,GAAG,EAAE,QAAQ,CAAC;;;;;;;;;;;;;KAaxD;QACD;;;;;;KAMC;QACD;;;;;;;KAOC;QACD;;;;;;KAMC;QACD;;8CAE0C,wBAAwB,CAAC,aAAa,EAAE,QAAQ,CAAC;;;;;;;gBAO/E,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,eAAe;;KAElD;QACD;;gDAE4C,wBAAwB,CAAC,aAAa,EAAE,QAAQ,CAAC;;gBAEjF,cAAc,CAAC,iBAAiB,EAAE,GAAG,EAAE,QAAQ,CAAC;;;;;gBAKhD,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,eAAe;;KAElD;QACD;;;;;;;gBAOY,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,mBAAmB;;KAEtD;KACF,CAAC;IACF,MAAM,KAAK,GAAG;QACZ;;;eAGW,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc;KAChD;QACD;;KAEC;KACF,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAClB,KAAK,CAAC,CAAC,YAAY,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;AAChE,CAAC;AAED,SAAS,wBAAwB,CAAC,aAAqB,EAAE,QAAwB;IAC/E,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,CAAC;IACrD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,KAAK,SAAS,CAAC,CAAC,YAAY,CAAC,aAAiC,EAAE,KAAoB;IAClF,KAAK,CAAC,CAAC,mBAAmB,CAAC,aAAa,EAAE,KAAK,EAAE,CAAC,GAAkB,EAAE,EAAE,CAAC,CAAC;QACxE,SAAS,EAAE,GAAG,CAAC,SAAS;QACxB,EAAE,EAAE,GAAG,CAAC,YAAY;KACrB,CAAC,CAAC,CAAC;AACN,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\nimport { Id64 } from \"@itwin/core-bentley\";\nimport { ECSqlBinding, ECSqlQueryDef, ECSqlQueryExecutor, ECSqlQueryRow } from \"@itwin/presentation-shared\";\nimport { SelectableInstanceKey } from \"./Selectable\";\nimport { formIdBindings, genericExecuteQuery } from \"./Utils\";\n\n/**\n * Available selection scopes.\n * @beta\n */\nexport type SelectionScope = \"element\" | \"model\" | \"category\" | \"functional\";\n\n/**\n * Props for computing element selection.\n * @beta\n */\nexport interface ElementSelectionScopeProps {\n  /** Identifies this as either \"element\" or \"functional\" selection scope */\n  id: \"element\" | \"functional\";\n  /**\n   * Specifies how far \"up\" we should walk to find the target element. When not specified or `0`,\n   * the target element matches the request element. When set to `1`, the target element matches the direct parent element.\n   * When set to `2`, the target element is parent of the parent element and so on. In all situations when this is `> 0`,\n   * we're not walking further than the last existing element, for example when `ancestorLevel = 1` (direct parent\n   * element is requested), but the request element doesn't have a parent, the request element is returned as the result.\n   * A negative value would result in the top-most element to be returned.\n   */\n  ancestorLevel?: number;\n}\n\n/**\n * Props for `computeSelection`.\n * @beta\n */\nexport interface ComputeSelectionProps {\n  /** iModel query executor. */\n  queryExecutor: ECSqlQueryExecutor;\n  /** IDs of elements to compute selection for. */\n  elementIds: string[];\n  /** Selection scope to compute selection with. */\n  scope: ElementSelectionScopeProps | { id: SelectionScope } | SelectionScope;\n}\n\n/**\n * Computes selection from given element IDs.\n * @beta\n */\nexport async function* computeSelection(props: ComputeSelectionProps): AsyncIterableIterator<SelectableInstanceKey> {\n  const { queryExecutor, elementIds, scope } = props;\n\n  if (typeof scope === \"string\") {\n    yield* computeSelection({ queryExecutor, elementIds, scope: { id: scope } });\n    return;\n  }\n\n  const nonTransientKeys = elementIds.filter((key) => !Id64.isTransient(key));\n\n  switch (scope.id) {\n    case \"element\":\n      yield* computeElementSelection(queryExecutor, nonTransientKeys, (scope as ElementSelectionScopeProps).ancestorLevel ?? 0);\n      return;\n    case \"category\":\n      yield* computeCategorySelection(queryExecutor, nonTransientKeys);\n      return;\n    case \"model\":\n      yield* computeModelSelection(queryExecutor, nonTransientKeys);\n      return;\n    case \"functional\":\n      yield* computeFunctionalElementSelection(queryExecutor, nonTransientKeys, (scope as ElementSelectionScopeProps).ancestorLevel ?? 0);\n      return;\n  }\n}\n\nasync function* computeElementSelection(\n  queryExecutor: ECSqlQueryExecutor,\n  elementIds: string[],\n  ancestorLevel: number,\n): AsyncIterableIterator<SelectableInstanceKey> {\n  const bindings: ECSqlBinding[] = [];\n  const recurseUntilRoot = ancestorLevel < 0;\n  const ctes = [\n    `\n      AncestorElements(ECInstanceId, ECClassId, Depth, ParentId) AS (\n        SELECT ECInstanceId, ECClassId, ${formAncestorLevelBinding(ancestorLevel, bindings)}, Parent.Id\n        FROM BisCore.Element\n        WHERE ${formIdBindings(\"ECInstanceId\", elementIds, bindings)}\n        UNION ALL\n        SELECT pe.ECInstanceId, pe.ECClassId, a.Depth - 1, pe.Parent.Id\n        FROM AncestorElements a\n        JOIN BisCore.Element pe ON pe.ECInstanceId = a.ParentId\n        WHERE ${recurseUntilRoot ? \"\" : \"Depth > 0 AND\"} ParentId IS NOT NULL\n      )\n    `,\n  ];\n  const ecsql = `\n    SELECT DISTINCT ECInstanceId, ec_classname(ECClassId, 's.c') AS ClassName\n    FROM AncestorElements\n    WHERE ${recurseUntilRoot ? \"\" : \"Depth = 0 OR\"} ParentId IS NULL\n  `;\n  yield* executeQuery(queryExecutor, { ctes, ecsql, bindings });\n}\n\nasync function* computeCategorySelection(queryExecutor: ECSqlQueryExecutor, ids: string[]): AsyncIterableIterator<SelectableInstanceKey> {\n  const bindings: ECSqlBinding[] = [];\n  const ecsql = [\n    `\n      SELECT DISTINCT c.ECInstanceId, ec_classname(c.ECClassId, 's.c') AS ClassName\n      FROM BisCore.Category c\n      JOIN BisCore.GeometricElement2d ge ON ge.Category.Id = c.ECInstanceId\n      WHERE ${formIdBindings(\"ge.ECInstanceId\", ids, bindings)}\n    `,\n    `\n      SELECT DISTINCT c.ECInstanceId, ec_classname(c.ECClassId, 's.c') AS ClassName\n      FROM BisCore.Category c\n      JOIN BisCore.GeometricElement3d ge ON ge.Category.Id = c.ECInstanceId\n      WHERE ${formIdBindings(\"ge.ECInstanceId\", ids, bindings)}\n    `,\n  ].join(\" UNION ALL \");\n  yield* executeQuery(queryExecutor, { ecsql, bindings });\n}\n\nasync function* computeModelSelection(queryExecutor: ECSqlQueryExecutor, ids: string[]): AsyncIterableIterator<SelectableInstanceKey> {\n  const bindings: ECSqlBinding[] = [];\n  const ecsql = `\n    SELECT DISTINCT m.ECInstanceId, ec_classname(m.ECClassId, 's.c') AS ClassName\n    FROM BisCore.Model m\n    JOIN BisCore.Element e ON e.Model.Id = m.ECInstanceId\n    WHERE ${formIdBindings(\"e.ECInstanceId\", ids, bindings)}\n  `;\n  yield* executeQuery(queryExecutor, { ecsql, bindings });\n}\n\nasync function* computeFunctionalElementSelection(\n  queryExecutor: ECSqlQueryExecutor,\n  ids: string[],\n  ancestorLevel: number,\n): AsyncIterableIterator<SelectableInstanceKey> {\n  const bindings: ECSqlBinding[] = [];\n  const recurseUntilRoot = ancestorLevel < 0;\n  const ctes = [\n    `\n      Elements2dOrNearestFunctionalElements(OriginalECInstanceId, OriginalECClassId, ECInstanceId, ECClassId, ParentId) AS (\n        SELECT ECInstanceId, ECClassId, ECInstanceId, ECClassId, Parent.Id\n        FROM BisCore.Element\n        WHERE ${formIdBindings(\"ECInstanceId\", ids, bindings)} AND ECClassId IS NOT (BisCore.GeometricElement3d)\n        UNION ALL\n        SELECT\n          e2onfe.OriginalECInstanceId,\n          e2onfe.OriginalECClassId,\n          COALESCE(dgrfe.TargetECInstanceId, pe.ECInstanceId),\n          COALESCE(dgrfe.TargetECClassId, pe.ECClassId),\n          pe.Parent.Id\n        FROM Elements2dOrNearestFunctionalElements e2onfe\n        LEFT JOIN BisCore.Element pe ON pe.ECInstanceId = e2onfe.ParentId\n        LEFT JOIN Functional.DrawingGraphicRepresentsFunctionalElement dgrfe ON dgrfe.SourceECInstanceId = e2onfe.ECInstanceId\n        WHERE e2onfe.ECClassId IS NOT (Functional.FunctionalElement) AND (e2onfe.ParentId IS NOT NULL OR dgrfe.TargetECInstanceId IS NOT NULL)\n      )\n    `,\n    `\n      Element2dNearestFunctionalElements(OriginalECInstanceId, ECInstanceId, ECClassId) AS (\n        SELECT OriginalECInstanceId, ECInstanceId, ECClassId\n        FROM Elements2dOrNearestFunctionalElements\n        WHERE ECClassId IS (Functional.FunctionalElement)\n      )\n    `,\n    `\n      Elements2dWithoutFunctionalElement(ECInstanceId, ECClassId) AS (\n        SELECT e2wfe.OriginalECInstanceId, OriginalECClassId\n        FROM Elements2dOrNearestFunctionalElements e2wfe\n        LEFT JOIN Element2dNearestFunctionalElements e2nfe ON e2nfe.OriginalECInstanceId = e2wfe.OriginalECInstanceId\n        WHERE e2wfe.ParentId IS NULL AND e2nfe.ECInstanceId IS NULL\n      )\n    `,\n    `\n      Elements2d(ECInstanceId, ECClassId) AS (\n        SELECT ECInstanceId, ECClassId FROM Element2dNearestFunctionalElements\n        UNION\n        SELECT ECInstanceId, ECClassId FROM Elements2dWithoutFunctionalElement\n      )\n    `,\n    `\n      Element2dAncestorElements(ECInstanceId, ECClassId, Depth, ParentId) AS (\n        SELECT e.ECInstanceId, e.ECClassId, ${formAncestorLevelBinding(ancestorLevel, bindings)}, e.Parent.Id\n        FROM BisCore.Element e\n        JOIN Elements2d e2d ON e2d.ECInstanceId = e.ECInstanceId\n        UNION ALL\n        SELECT pe.ECInstanceId, pe.ECClassId, e2ae.Depth - 1, pe.Parent.Id\n        FROM Element2dAncestorElements e2ae\n        JOIN BisCore.Element pe ON pe.ECInstanceId = e2ae.ParentId\n        WHERE ${recurseUntilRoot ? \"\" : \"Depth > 0 AND\"} ParentId IS NOT NULL\n      )\n    `,\n    `\n      Element3dAncestorElements(ECInstanceId, ECClassId, Depth, ParentId) AS (\n        SELECT ge.ECInstanceId, ge.ECClassId, ${formAncestorLevelBinding(ancestorLevel, bindings)}, ge.Parent.Id\n        FROM BisCore.GeometricElement3d ge\n        WHERE ${formIdBindings(\"ge.ECInstanceId\", ids, bindings)}\n        UNION ALL\n        SELECT pe.ECInstanceId, pe.ECClassId, e3ae.Depth - 1, pe.Parent.Id\n        FROM Element3dAncestorElements e3ae\n        JOIN BisCore.Element pe ON pe.ECInstanceId = e3ae.ParentId\n        WHERE ${recurseUntilRoot ? \"\" : \"Depth > 0 AND\"} ParentId IS NOT NULL\n      )\n    `,\n    `\n      Element3dAncestorRelatedFunctionalElement(ECInstanceId, ClassName) AS (\n        SELECT\n          COALESCE(peff.TargetECInstanceId, e3ae.ECInstanceId),\n          ec_classname(COALESCE(peff.TargetECClassId, e3ae.ECClassId), 's.c')\n        FROM Element3dAncestorElements e3ae\n        LEFT JOIN Functional.PhysicalElementFulfillsFunction peff ON peff.SourceECInstanceId = e3ae.ECInstanceId\n        WHERE ${recurseUntilRoot ? \"\" : \"e3ae.Depth = 0 OR\"} e3ae.ParentId IS NULL\n      )\n    `,\n  ];\n  const ecsql = [\n    `\n      SELECT DISTINCT ECInstanceId, ec_classname(ECClassId, 's.c') AS ClassName\n        FROM Element2dAncestorElements\n       WHERE ${recurseUntilRoot ? \"\" : \"Depth = 0 OR\"} ParentId IS NULL\n    `,\n    `\n      SELECT DISTINCT ECInstanceId, ClassName FROM Element3dAncestorRelatedFunctionalElement\n    `,\n  ].join(\" UNION \");\n  yield* executeQuery(queryExecutor, { ctes, ecsql, bindings });\n}\n\nfunction formAncestorLevelBinding(ancestorLevel: number, bindings: ECSqlBinding[]) {\n  bindings.push({ type: \"int\", value: ancestorLevel });\n  return \"?\";\n}\n\nasync function* executeQuery(queryExecutor: ECSqlQueryExecutor, query: ECSqlQueryDef): AsyncIterableIterator<SelectableInstanceKey> {\n  yield* genericExecuteQuery(queryExecutor, query, (row: ECSqlQueryRow) => ({\n    className: row.ClassName,\n    id: row.ECInstanceId,\n  }));\n}\n"]}
+{"version":3,"file":"SelectionScope.js","sourceRoot":"","sources":["../../../src/unified-selection/SelectionScope.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAG3C,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAuCjE;;;GAGG;AACH,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC,gBAAgB,CAAC,KAA4B;IAClE,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;IAEnD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,KAAK,CAAC,CAAC,gBAAgB,CAAC,EAAE,aAAa,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QAC7E,OAAO;IACT,CAAC;IAED,MAAM,gBAAgB,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;IAE5E,QAAQ,KAAK,CAAC,EAAE,EAAE,CAAC;QACjB,KAAK,SAAS;YACZ,KAAK,CAAC,CAAC,uBAAuB,CAAC,aAAa,EAAE,gBAAgB,EAAG,KAAoC,CAAC,aAAa,IAAI,CAAC,CAAC,CAAC;YAC1H,OAAO;QACT,KAAK,UAAU;YACb,KAAK,CAAC,CAAC,wBAAwB,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;YACjE,OAAO;QACT,KAAK,OAAO;YACV,KAAK,CAAC,CAAC,qBAAqB,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;YAC9D,OAAO;QACT,KAAK,YAAY;YACf,KAAK,CAAC,CAAC,iCAAiC,CAAC,aAAa,EAAE,gBAAgB,EAAG,KAAoC,CAAC,aAAa,IAAI,CAAC,CAAC,CAAC;YACpI,OAAO;IACX,CAAC;AACH,CAAC;AAED,KAAK,SAAS,CAAC,CAAC,uBAAuB,CACrC,aAAiC,EACjC,UAAoB,EACpB,aAAqB;IAErB,MAAM,QAAQ,GAAmB,EAAE,CAAC;IACpC,MAAM,gBAAgB,GAAG,aAAa,GAAG,CAAC,CAAC;IAC3C,MAAM,IAAI,GAAG;QACX;;0CAEsC,wBAAwB,CAAC,aAAa,EAAE,QAAQ,CAAC;;gBAE3E,cAAc,CAAC,cAAc,EAAE,UAAU,EAAE,QAAQ,CAAC;;;;;gBAKpD,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,eAAe;;KAElD;KACF,CAAC;IACF,MAAM,KAAK,GAAG;;;YAGJ,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc;GAC/C,CAAC;IACF,KAAK,CAAC,CAAC,YAAY,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;AAChE,CAAC;AAED,KAAK,SAAS,CAAC,CAAC,wBAAwB,CAAC,aAAiC,EAAE,GAAa;IACvF,MAAM,QAAQ,GAAmB,EAAE,CAAC;IACpC,MAAM,KAAK,GAAG;QACZ;;;;cAIU,cAAc,CAAC,iBAAiB,EAAE,GAAG,EAAE,QAAQ,CAAC;KACzD;QACD;;;;cAIU,cAAc,CAAC,iBAAiB,EAAE,GAAG,EAAE,QAAQ,CAAC;KACzD;KACF,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACtB,KAAK,CAAC,CAAC,YAAY,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;AAC1D,CAAC;AAED,KAAK,SAAS,CAAC,CAAC,qBAAqB,CAAC,aAAiC,EAAE,GAAa;IACpF,MAAM,QAAQ,GAAmB,EAAE,CAAC;IACpC,MAAM,KAAK,GAAG;;;;YAIJ,cAAc,CAAC,gBAAgB,EAAE,GAAG,EAAE,QAAQ,CAAC;GACxD,CAAC;IACF,KAAK,CAAC,CAAC,YAAY,CAAC,aAAa,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;AAC1D,CAAC;AAED,KAAK,SAAS,CAAC,CAAC,iCAAiC,CAC/C,aAAiC,EACjC,GAAa,EACb,aAAqB;IAErB,MAAM,QAAQ,GAAmB,EAAE,CAAC;IACpC,MAAM,gBAAgB,GAAG,aAAa,GAAG,CAAC,CAAC;IAC3C,MAAM,IAAI,GAAG;QACX;;;;gBAIY,cAAc,CAAC,cAAc,EAAE,GAAG,EAAE,QAAQ,CAAC;;;;;;;;;;;;;KAaxD;QACD;;;;;;KAMC;QACD;;;;;;;KAOC;QACD;;;;;;KAMC;QACD;;8CAE0C,wBAAwB,CAAC,aAAa,EAAE,QAAQ,CAAC;;;;;;;gBAO/E,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,eAAe;;KAElD;QACD;;gDAE4C,wBAAwB,CAAC,aAAa,EAAE,QAAQ,CAAC;;gBAEjF,cAAc,CAAC,iBAAiB,EAAE,GAAG,EAAE,QAAQ,CAAC;;;;;gBAKhD,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,eAAe;;KAElD;QACD;;;;;;;gBAOY,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,mBAAmB;;KAEtD;KACF,CAAC;IACF,MAAM,KAAK,GAAG;QACZ;;;eAGW,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc;KAChD;QACD;;KAEC;KACF,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAClB,KAAK,CAAC,CAAC,YAAY,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;AAChE,CAAC;AAED,SAAS,wBAAwB,CAAC,aAAqB,EAAE,QAAwB;IAC/E,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,CAAC;IACrD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,KAAK,SAAS,CAAC,CAAC,YAAY,CAAC,aAAiC,EAAE,KAAoB;IAClF,KAAK,CAAC,CAAC,mBAAmB,CAAC,aAAa,EAAE,KAAK,EAAE,CAAC,GAAkB,EAAE,EAAE,CAAC,CAAC;QACxE,SAAS,EAAE,GAAG,CAAC,SAAS;QACxB,EAAE,EAAE,GAAG,CAAC,YAAY;KACrB,CAAC,CAAC,CAAC;AACN,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\nimport { Id64 } from \"@itwin/core-bentley\";\nimport { ECSqlBinding, ECSqlQueryDef, ECSqlQueryExecutor, ECSqlQueryRow } from \"@itwin/presentation-shared\";\nimport { SelectableInstanceKey } from \"./Selectable.js\";\nimport { formIdBindings, genericExecuteQuery } from \"./Utils.js\";\n\n/**\n * Available selection scopes.\n * @public\n */\nexport type SelectionScope = \"element\" | \"model\" | \"category\" | \"functional\";\n\n/**\n * Props for computing element selection.\n * @public\n */\nexport interface ElementSelectionScopeProps {\n  /** Identifies this as either \"element\" or \"functional\" selection scope */\n  id: \"element\" | \"functional\";\n  /**\n   * Specifies how far \"up\" we should walk to find the target element. When not specified or `0`,\n   * the target element matches the request element. When set to `1`, the target element matches the direct parent element.\n   * When set to `2`, the target element is parent of the parent element and so on. In all situations when this is `> 0`,\n   * we're not walking further than the last existing element, for example when `ancestorLevel = 1` (direct parent\n   * element is requested), but the request element doesn't have a parent, the request element is returned as the result.\n   * A negative value would result in the top-most element to be returned.\n   */\n  ancestorLevel?: number;\n}\n\n/**\n * Props for `computeSelection`.\n * @public\n */\nexport interface ComputeSelectionProps {\n  /** iModel query executor. */\n  queryExecutor: ECSqlQueryExecutor;\n  /** IDs of elements to compute selection for. */\n  elementIds: string[];\n  /** Selection scope to compute selection with. */\n  scope: ElementSelectionScopeProps | { id: SelectionScope } | SelectionScope;\n}\n\n/**\n * Computes selection from given element IDs.\n * @public\n */\nexport async function* computeSelection(props: ComputeSelectionProps): AsyncIterableIterator<SelectableInstanceKey> {\n  const { queryExecutor, elementIds, scope } = props;\n\n  if (typeof scope === \"string\") {\n    yield* computeSelection({ queryExecutor, elementIds, scope: { id: scope } });\n    return;\n  }\n\n  const nonTransientKeys = elementIds.filter((key) => !Id64.isTransient(key));\n\n  switch (scope.id) {\n    case \"element\":\n      yield* computeElementSelection(queryExecutor, nonTransientKeys, (scope as ElementSelectionScopeProps).ancestorLevel ?? 0);\n      return;\n    case \"category\":\n      yield* computeCategorySelection(queryExecutor, nonTransientKeys);\n      return;\n    case \"model\":\n      yield* computeModelSelection(queryExecutor, nonTransientKeys);\n      return;\n    case \"functional\":\n      yield* computeFunctionalElementSelection(queryExecutor, nonTransientKeys, (scope as ElementSelectionScopeProps).ancestorLevel ?? 0);\n      return;\n  }\n}\n\nasync function* computeElementSelection(\n  queryExecutor: ECSqlQueryExecutor,\n  elementIds: string[],\n  ancestorLevel: number,\n): AsyncIterableIterator<SelectableInstanceKey> {\n  const bindings: ECSqlBinding[] = [];\n  const recurseUntilRoot = ancestorLevel < 0;\n  const ctes = [\n    `\n      AncestorElements(ECInstanceId, ECClassId, Depth, ParentId) AS (\n        SELECT ECInstanceId, ECClassId, ${formAncestorLevelBinding(ancestorLevel, bindings)}, Parent.Id\n        FROM BisCore.Element\n        WHERE ${formIdBindings(\"ECInstanceId\", elementIds, bindings)}\n        UNION ALL\n        SELECT pe.ECInstanceId, pe.ECClassId, a.Depth - 1, pe.Parent.Id\n        FROM AncestorElements a\n        JOIN BisCore.Element pe ON pe.ECInstanceId = a.ParentId\n        WHERE ${recurseUntilRoot ? \"\" : \"Depth > 0 AND\"} ParentId IS NOT NULL\n      )\n    `,\n  ];\n  const ecsql = `\n    SELECT DISTINCT ECInstanceId, ec_classname(ECClassId, 's.c') AS ClassName\n    FROM AncestorElements\n    WHERE ${recurseUntilRoot ? \"\" : \"Depth = 0 OR\"} ParentId IS NULL\n  `;\n  yield* executeQuery(queryExecutor, { ctes, ecsql, bindings });\n}\n\nasync function* computeCategorySelection(queryExecutor: ECSqlQueryExecutor, ids: string[]): AsyncIterableIterator<SelectableInstanceKey> {\n  const bindings: ECSqlBinding[] = [];\n  const ecsql = [\n    `\n      SELECT DISTINCT c.ECInstanceId, ec_classname(c.ECClassId, 's.c') AS ClassName\n      FROM BisCore.Category c\n      JOIN BisCore.GeometricElement2d ge ON ge.Category.Id = c.ECInstanceId\n      WHERE ${formIdBindings(\"ge.ECInstanceId\", ids, bindings)}\n    `,\n    `\n      SELECT DISTINCT c.ECInstanceId, ec_classname(c.ECClassId, 's.c') AS ClassName\n      FROM BisCore.Category c\n      JOIN BisCore.GeometricElement3d ge ON ge.Category.Id = c.ECInstanceId\n      WHERE ${formIdBindings(\"ge.ECInstanceId\", ids, bindings)}\n    `,\n  ].join(\" UNION ALL \");\n  yield* executeQuery(queryExecutor, { ecsql, bindings });\n}\n\nasync function* computeModelSelection(queryExecutor: ECSqlQueryExecutor, ids: string[]): AsyncIterableIterator<SelectableInstanceKey> {\n  const bindings: ECSqlBinding[] = [];\n  const ecsql = `\n    SELECT DISTINCT m.ECInstanceId, ec_classname(m.ECClassId, 's.c') AS ClassName\n    FROM BisCore.Model m\n    JOIN BisCore.Element e ON e.Model.Id = m.ECInstanceId\n    WHERE ${formIdBindings(\"e.ECInstanceId\", ids, bindings)}\n  `;\n  yield* executeQuery(queryExecutor, { ecsql, bindings });\n}\n\nasync function* computeFunctionalElementSelection(\n  queryExecutor: ECSqlQueryExecutor,\n  ids: string[],\n  ancestorLevel: number,\n): AsyncIterableIterator<SelectableInstanceKey> {\n  const bindings: ECSqlBinding[] = [];\n  const recurseUntilRoot = ancestorLevel < 0;\n  const ctes = [\n    `\n      Elements2dOrNearestFunctionalElements(OriginalECInstanceId, OriginalECClassId, ECInstanceId, ECClassId, ParentId) AS (\n        SELECT ECInstanceId, ECClassId, ECInstanceId, ECClassId, Parent.Id\n        FROM BisCore.Element\n        WHERE ${formIdBindings(\"ECInstanceId\", ids, bindings)} AND ECClassId IS NOT (BisCore.GeometricElement3d)\n        UNION ALL\n        SELECT\n          e2onfe.OriginalECInstanceId,\n          e2onfe.OriginalECClassId,\n          COALESCE(dgrfe.TargetECInstanceId, pe.ECInstanceId),\n          COALESCE(dgrfe.TargetECClassId, pe.ECClassId),\n          pe.Parent.Id\n        FROM Elements2dOrNearestFunctionalElements e2onfe\n        LEFT JOIN BisCore.Element pe ON pe.ECInstanceId = e2onfe.ParentId\n        LEFT JOIN Functional.DrawingGraphicRepresentsFunctionalElement dgrfe ON dgrfe.SourceECInstanceId = e2onfe.ECInstanceId\n        WHERE e2onfe.ECClassId IS NOT (Functional.FunctionalElement) AND (e2onfe.ParentId IS NOT NULL OR dgrfe.TargetECInstanceId IS NOT NULL)\n      )\n    `,\n    `\n      Element2dNearestFunctionalElements(OriginalECInstanceId, ECInstanceId, ECClassId) AS (\n        SELECT OriginalECInstanceId, ECInstanceId, ECClassId\n        FROM Elements2dOrNearestFunctionalElements\n        WHERE ECClassId IS (Functional.FunctionalElement)\n      )\n    `,\n    `\n      Elements2dWithoutFunctionalElement(ECInstanceId, ECClassId) AS (\n        SELECT e2wfe.OriginalECInstanceId, OriginalECClassId\n        FROM Elements2dOrNearestFunctionalElements e2wfe\n        LEFT JOIN Element2dNearestFunctionalElements e2nfe ON e2nfe.OriginalECInstanceId = e2wfe.OriginalECInstanceId\n        WHERE e2wfe.ParentId IS NULL AND e2nfe.ECInstanceId IS NULL\n      )\n    `,\n    `\n      Elements2d(ECInstanceId, ECClassId) AS (\n        SELECT ECInstanceId, ECClassId FROM Element2dNearestFunctionalElements\n        UNION\n        SELECT ECInstanceId, ECClassId FROM Elements2dWithoutFunctionalElement\n      )\n    `,\n    `\n      Element2dAncestorElements(ECInstanceId, ECClassId, Depth, ParentId) AS (\n        SELECT e.ECInstanceId, e.ECClassId, ${formAncestorLevelBinding(ancestorLevel, bindings)}, e.Parent.Id\n        FROM BisCore.Element e\n        JOIN Elements2d e2d ON e2d.ECInstanceId = e.ECInstanceId\n        UNION ALL\n        SELECT pe.ECInstanceId, pe.ECClassId, e2ae.Depth - 1, pe.Parent.Id\n        FROM Element2dAncestorElements e2ae\n        JOIN BisCore.Element pe ON pe.ECInstanceId = e2ae.ParentId\n        WHERE ${recurseUntilRoot ? \"\" : \"Depth > 0 AND\"} ParentId IS NOT NULL\n      )\n    `,\n    `\n      Element3dAncestorElements(ECInstanceId, ECClassId, Depth, ParentId) AS (\n        SELECT ge.ECInstanceId, ge.ECClassId, ${formAncestorLevelBinding(ancestorLevel, bindings)}, ge.Parent.Id\n        FROM BisCore.GeometricElement3d ge\n        WHERE ${formIdBindings(\"ge.ECInstanceId\", ids, bindings)}\n        UNION ALL\n        SELECT pe.ECInstanceId, pe.ECClassId, e3ae.Depth - 1, pe.Parent.Id\n        FROM Element3dAncestorElements e3ae\n        JOIN BisCore.Element pe ON pe.ECInstanceId = e3ae.ParentId\n        WHERE ${recurseUntilRoot ? \"\" : \"Depth > 0 AND\"} ParentId IS NOT NULL\n      )\n    `,\n    `\n      Element3dAncestorRelatedFunctionalElement(ECInstanceId, ClassName) AS (\n        SELECT\n          COALESCE(peff.TargetECInstanceId, e3ae.ECInstanceId),\n          ec_classname(COALESCE(peff.TargetECClassId, e3ae.ECClassId), 's.c')\n        FROM Element3dAncestorElements e3ae\n        LEFT JOIN Functional.PhysicalElementFulfillsFunction peff ON peff.SourceECInstanceId = e3ae.ECInstanceId\n        WHERE ${recurseUntilRoot ? \"\" : \"e3ae.Depth = 0 OR\"} e3ae.ParentId IS NULL\n      )\n    `,\n  ];\n  const ecsql = [\n    `\n      SELECT DISTINCT ECInstanceId, ec_classname(ECClassId, 's.c') AS ClassName\n        FROM Element2dAncestorElements\n       WHERE ${recurseUntilRoot ? \"\" : \"Depth = 0 OR\"} ParentId IS NULL\n    `,\n    `\n      SELECT DISTINCT ECInstanceId, ClassName FROM Element3dAncestorRelatedFunctionalElement\n    `,\n  ].join(\" UNION \");\n  yield* executeQuery(queryExecutor, { ctes, ecsql, bindings });\n}\n\nfunction formAncestorLevelBinding(ancestorLevel: number, bindings: ECSqlBinding[]) {\n  bindings.push({ type: \"int\", value: ancestorLevel });\n  return \"?\";\n}\n\nasync function* executeQuery(queryExecutor: ECSqlQueryExecutor, query: ECSqlQueryDef): AsyncIterableIterator<SelectableInstanceKey> {\n  yield* genericExecuteQuery(queryExecutor, query, (row: ECSqlQueryRow) => ({\n    className: row.ClassName,\n    id: row.ECInstanceId,\n  }));\n}\n"]}

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

@@ -1,7 +1,7 @@
 import { Event } from "@itwin/presentation-shared";
-import { Selectable, Selectables } from "./Selectable";
-import { StorageSelectionChangesListener } from "./SelectionChangeEvent";
-/** @beta */
+import { Selectable, Selectables } from "./Selectable.js";
+import { StorageSelectionChangesListener } from "./SelectionChangeEvent.js";
+/** @public */
 type IModelKeyProp = {
     /** Key of the iModel to get selection levels for. */
     imodelKey: string;
@@ -19,7 +19,7 @@ type IModelKeyProp = {
  * consumers, may be supplemented with required attributes any time.
  *
  * @see `createStorage`
- * @beta
+ * @public
  */
 export interface SelectionStorage {
     /** An event that is raised when selection changes. */
@@ -80,7 +80,7 @@ export interface SelectionStorage {
  * });
  * ```
  *
- * @beta
+ * @public
  */
 export declare function createStorage(): SelectionStorage;
 /** @internal */

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

@@ -1 +1 @@
-{"version":3,"file":"SelectionStorage.d.ts","sourceRoot":"","sources":["../../../src/unified-selection/SelectionStorage.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AACvD,OAAO,EAAmC,+BAA+B,EAA8B,MAAM,wBAAwB,CAAC;AAEtI,YAAY;AACZ,KAAK,aAAa,GACd;IACE,qDAAqD;IACrD,SAAS,EAAE,MAAM,CAAC;CACnB,GACD;IACE;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEN;;;;;;;;GAQG;AACH,MAAM,WAAW,gBAAgB;IAC/B,sDAAsD;IACtD,oBAAoB,EAAE,KAAK,CAAC,+BAA+B,CAAC,CAAC;IAE7D,0EAA0E;IAC1E,kBAAkB,CAAC,KAAK,EAAE,aAAa,GAAG,MAAM,EAAE,CAAC;IAEnD,+CAA+C;IAC/C,YAAY,CACV,KAAK,EAAE,aAAa,GAAG;QACrB,+CAA+C;QAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GACA,WAAW,CAAC;IAEf,iCAAiC;IACjC,cAAc,CACZ,KAAK,EAAE,aAAa,GAAG;QACrB,8GAA8G;QAC9G,MAAM,EAAE,MAAM,CAAC;QACf,2CAA2C;QAC3C,WAAW,EAAE,UAAU,EAAE,CAAC;QAC1B,+CAA+C;QAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GACA,IAAI,CAAC;IAER,0CAA0C;IAC1C,mBAAmB,CACjB,KAAK,EAAE,aAAa,GAAG;QACrB,8GAA8G;QAC9G,MAAM,EAAE,MAAM,CAAC;QACf,gDAAgD;QAChD,WAAW,EAAE,UAAU,EAAE,CAAC;QAC1B,+CAA+C;QAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GACA,IAAI,CAAC;IAER,iCAAiC;IACjC,gBAAgB,CACd,KAAK,EAAE,aAAa,GAAG;QACrB,8GAA8G;QAC9G,MAAM,EAAE,MAAM,CAAC;QACf,2CAA2C;QAC3C,WAAW,EAAE,UAAU,EAAE,CAAC;QAC1B,+CAA+C;QAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GACA,IAAI,CAAC;IAER,+BAA+B;IAC/B,cAAc,CACZ,KAAK,EAAE,aAAa,GAAG;QACrB,8GAA8G;QAC9G,MAAM,EAAE,MAAM,CAAC;QACf,+CAA+C;QAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GACA,IAAI,CAAC;IAER,yFAAyF;IACzF,YAAY,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI,CAAC;CAC1C;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,aAAa,IAAI,gBAAgB,CAEhD;AAED,gBAAgB;AAChB,eAAO,MAAM,mCAAmC,qCAAqC,CAAC"}
+{"version":3,"file":"SelectionStorage.d.ts","sourceRoot":"","sources":["../../../src/unified-selection/SelectionStorage.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC1D,OAAO,EAAmC,+BAA+B,EAA8B,MAAM,2BAA2B,CAAC;AAEzI,cAAc;AACd,KAAK,aAAa,GACd;IACE,qDAAqD;IACrD,SAAS,EAAE,MAAM,CAAC;CACnB,GACD;IACE;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEN;;;;;;;;GAQG;AACH,MAAM,WAAW,gBAAgB;IAC/B,sDAAsD;IACtD,oBAAoB,EAAE,KAAK,CAAC,+BAA+B,CAAC,CAAC;IAE7D,0EAA0E;IAC1E,kBAAkB,CAAC,KAAK,EAAE,aAAa,GAAG,MAAM,EAAE,CAAC;IAEnD,+CAA+C;IAC/C,YAAY,CACV,KAAK,EAAE,aAAa,GAAG;QACrB,+CAA+C;QAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GACA,WAAW,CAAC;IAEf,iCAAiC;IACjC,cAAc,CACZ,KAAK,EAAE,aAAa,GAAG;QACrB,8GAA8G;QAC9G,MAAM,EAAE,MAAM,CAAC;QACf,2CAA2C;QAC3C,WAAW,EAAE,UAAU,EAAE,CAAC;QAC1B,+CAA+C;QAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GACA,IAAI,CAAC;IAER,0CAA0C;IAC1C,mBAAmB,CACjB,KAAK,EAAE,aAAa,GAAG;QACrB,8GAA8G;QAC9G,MAAM,EAAE,MAAM,CAAC;QACf,gDAAgD;QAChD,WAAW,EAAE,UAAU,EAAE,CAAC;QAC1B,+CAA+C;QAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GACA,IAAI,CAAC;IAER,iCAAiC;IACjC,gBAAgB,CACd,KAAK,EAAE,aAAa,GAAG;QACrB,8GAA8G;QAC9G,MAAM,EAAE,MAAM,CAAC;QACf,2CAA2C;QAC3C,WAAW,EAAE,UAAU,EAAE,CAAC;QAC1B,+CAA+C;QAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GACA,IAAI,CAAC;IAER,+BAA+B;IAC/B,cAAc,CACZ,KAAK,EAAE,aAAa,GAAG;QACrB,8GAA8G;QAC9G,MAAM,EAAE,MAAM,CAAC;QACf,+CAA+C;QAC/C,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GACA,IAAI,CAAC;IAER,yFAAyF;IACzF,YAAY,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI,CAAC;CAC1C;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,aAAa,IAAI,gBAAgB,CAEhD;AAED,gBAAgB;AAChB,eAAO,MAAM,mCAAmC,qCAAqC,CAAC"}

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

@@ -3,7 +3,7 @@
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
 import { BeEvent } from "@itwin/core-bentley";
-import { Selectables } from "./Selectable";
+import { Selectables } from "./Selectable.js";
 /**
  * Creates a selection storage which stores and allows managing application-level selection.
  *
@@ -16,7 +16,7 @@ import { Selectables } from "./Selectable";
  * });
  * ```
  *
- * @beta
+ * @public
  */
 export function createStorage() {
     return new SelectionStorageImpl();
@@ -106,7 +106,7 @@ class SelectionStorageImpl {
     }
 }
 function getIModelKey(props) {
-    // eslint-disable-next-line deprecation/deprecation
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
     return "imodelKey" in props ? props.imodelKey : props.iModelKey;
 }
 class MultiLevelSelectablesContainer {

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

@@ -1 +1 @@
-{"version":3,"file":"SelectionStorage.js","sourceRoot":"","sources":["../../../src/unified-selection/SelectionStorage.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C,OAAO,EAAc,WAAW,EAAE,MAAM,cAAc,CAAC;AA2FvD;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,aAAa;IAC3B,OAAO,IAAI,oBAAoB,EAAE,CAAC;AACpC,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,mCAAmC,GAAG,kCAAkC,CAAC;AAEtF,MAAM,oBAAoB;IAChB,QAAQ,GAAG,IAAI,GAAG,EAA0C,CAAC;IAC9D,oBAAoB,CAA2C;IAEtE;QACE,IAAI,CAAC,oBAAoB,GAAG,IAAI,OAAO,EAAE,CAAC;IAC5C,CAAC;IAEM,kBAAkB,CAAC,KAAoB;QAC5C,OAAO,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,kBAAkB,EAAE,CAAC;IACrE,CAAC;IAEM,YAAY,CAAC,KAAyC;QAC3D,OAAO,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;IAC/E,CAAC;IAEM,cAAc,CAAC,KAAoF;QACxG,IAAI,CAAC,YAAY,CAAC,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;IACrD,CAAC;IAEM,mBAAmB,CAAC,KAAoF;QAC7G,IAAI,CAAC,YAAY,CAAC,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC;IACxD,CAAC;IAEM,gBAAgB,CAAC,KAAoF;QAC1G,IAAI,CAAC,YAAY,CAAC,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;IACzD,CAAC;IAEM,cAAc,CAAC,KAAyD;QAC7E,IAAI,CAAC,YAAY,CAAC,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;IACxE,CAAC;IAEM,YAAY,CAAC,KAAoB;QACtC,MAAM,SAAS,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QACtC,IAAI,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,mCAAmC,EAAE,SAAS,EAAE,CAAC,CAAC;QAChF,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAClC,CAAC;IAEO,YAAY,CAAC,SAAiB;QACpC,IAAI,kBAAkB,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACtD,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxB,kBAAkB,GAAG,IAAI,8BAA8B,EAAE,CAAC;YAC1D,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;QACnD,CAAC;QACD,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAEO,YAAY,CAAC,KAA4H;QAC/I,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC;QAC1E,MAAM,SAAS,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QACtC,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAC/C,MAAM,KAAK,GAAG,OAAO,IAAI,CAAC,CAAC;QAC3B,MAAM,WAAW,GAAG,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC5C,QAAQ,UAAU,EAAE,CAAC;YACnB,KAAK,KAAK;gBACR,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,CAAC;oBAC1C,OAAO;gBACT,CAAC;gBACD,MAAM;YACR,KAAK,QAAQ;gBACX,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,CAAC;oBAC7C,OAAO;gBACT,CAAC;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,CAAC;oBAC5G,OAAO;gBACT,CAAC;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,CAAC;oBACpC,OAAO;gBACT,CAAC;gBACD,MAAM;QACV,CAAC;QACD,SAAS,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QAC3B,MAAM,KAAK,GAAoC;YAC7C,MAAM;YACN,KAAK;YACL,SAAS;YACT,SAAS,EAAE,SAAS;YACpB,UAAU;YACV,WAAW,EAAE,QAAQ;YACrB,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,OAAO,EAAE,IAAI;SACd,CAAC;QACF,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;CACF;AAED,SAAS,YAAY,CAAC,KAAoB;IACxC,mDAAmD;IACnD,OAAO,WAAW,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC;AAClE,CAAC;AAED,MAAM,8BAA8B;IACjB,sBAAsB,CAA2B;IAElE;QACE,IAAI,CAAC,sBAAsB,GAAG,IAAI,GAAG,EAAuB,CAAC;IAC/D,CAAC;IAEM,YAAY,CAAC,KAAa;QAC/B,IAAI,WAAW,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACzD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,WAAW,GAAG,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACrC,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;QACtD,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAEM,kBAAkB;QACvB,MAAM,MAAM,GAAG,IAAI,KAAK,EAAU,CAAC;QACnC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE,EAAE,CAAC;YAC1D,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACnC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACxB,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,KAAa;QACxB,MAAM,YAAY,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,EAAE,CAAC;QACxD,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;YACvC,IAAI,WAAW,IAAI,KAAK,EAAE,CAAC;gBACzB,MAAM,WAAW,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,WAAW,CAAE,CAAC;gBAClE,WAAW,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YACjC,CAAC;QACH,CAAC;IACH,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n\nimport { BeEvent } from \"@itwin/core-bentley\";\nimport { Event } from \"@itwin/presentation-shared\";\nimport { Selectable, Selectables } from \"./Selectable\";\nimport { StorageSelectionChangeEventArgs, StorageSelectionChangesListener, StorageSelectionChangeType } from \"./SelectionChangeEvent\";\n\n/** @beta */\ntype IModelKeyProp =\n  | {\n      /** Key of the iModel to get selection levels for. */\n      imodelKey: string;\n    }\n  | {\n      /**\n       * Key of the iModel to get selection levels for.\n       * @deprecated in 0.2. Use `imodelKey` instead.\n       */\n      iModelKey: string;\n    };\n\n/**\n * Defines return value of `createStorage`.\n *\n * **Warning:** Used in public API as a return value. Not expected to be created / extended by package\n * consumers, may be supplemented with required attributes any time.\n *\n * @see `createStorage`\n * @beta\n */\nexport interface SelectionStorage {\n  /** An event that is raised when selection changes. */\n  selectionChangeEvent: Event<StorageSelectionChangesListener>;\n\n  /** Get the selection levels currently stored for the specified iModel. */\n  getSelectionLevels(props: IModelKeyProp): number[];\n\n  /** Get the selection stored in the storage. */\n  getSelection(\n    props: IModelKeyProp & {\n      /** Level of the selection. Defaults to `0`. */\n      level?: number;\n    },\n  ): Selectables;\n\n  /** Add keys to the selection. */\n  addToSelection(\n    props: IModelKeyProp & {\n      /** Name of the selection source. Generally, this identifies the component that makes the selection change. */\n      source: string;\n      /** The selectables to add to selection. */\n      selectables: Selectable[];\n      /** Level of the selection. Defaults to `0`. */\n      level?: number;\n    },\n  ): void;\n\n  /** Remove keys from current selection. */\n  removeFromSelection(\n    props: IModelKeyProp & {\n      /** Name of the selection source. Generally, this identifies the component that makes the selection change. */\n      source: string;\n      /** The selectables to remove from selection. */\n      selectables: Selectable[];\n      /** Level of the selection. Defaults to `0`. */\n      level?: number;\n    },\n  ): void;\n\n  /** Replace current selection. */\n  replaceSelection(\n    props: IModelKeyProp & {\n      /** Name of the selection source. Generally, this identifies the component that makes the selection change. */\n      source: string;\n      /** The selectables to add to selection. */\n      selectables: Selectable[];\n      /** Level of the selection. Defaults to `0`. */\n      level?: number;\n    },\n  ): void;\n\n  /** Clear current selection. */\n  clearSelection(\n    props: IModelKeyProp & {\n      /** Name of the selection source. Generally, this identifies the component that makes the selection change. */\n      source: string;\n      /** Level of the selection. Defaults to `0`. */\n      level?: number;\n    },\n  ): void;\n\n  /** Clear storage for an iModel. This function should be called when iModel is closed. */\n  clearStorage(props: IModelKeyProp): void;\n}\n\n/**\n * Creates a selection storage which stores and allows managing application-level selection.\n *\n * **Note:** `clearSelection` should be called upon iModel close to free-up memory:\n *\n * ```ts\n * import { IModelConnection } from \"@itwin/core-frontend\";\n * IModelConnection.onClose.addListener((imodel) => {\n *   storage.clearStorage(imodel.key);\n * });\n * ```\n *\n * @beta\n */\nexport function createStorage(): SelectionStorage {\n  return new SelectionStorageImpl();\n}\n\n/** @internal */\nexport const IMODEL_CLOSE_SELECTION_CLEAR_SOURCE = \"Unified selection storage: clear\";\n\nclass SelectionStorageImpl implements SelectionStorage {\n  private _storage = new Map<string, MultiLevelSelectablesContainer>();\n  public selectionChangeEvent: BeEvent<StorageSelectionChangesListener>;\n\n  constructor() {\n    this.selectionChangeEvent = new BeEvent();\n  }\n\n  public getSelectionLevels(props: IModelKeyProp): number[] {\n    return this.getContainer(getIModelKey(props)).getSelectionLevels();\n  }\n\n  public getSelection(props: IModelKeyProp & { level?: number }): Selectables {\n    return this.getContainer(getIModelKey(props)).getSelection(props.level ?? 0);\n  }\n\n  public addToSelection(props: IModelKeyProp & { source: string; selectables: Selectable[]; level?: number }): void {\n    this.handleChange({ ...props, changeType: \"add\" });\n  }\n\n  public removeFromSelection(props: IModelKeyProp & { source: string; selectables: Selectable[]; level?: number }): void {\n    this.handleChange({ ...props, changeType: \"remove\" });\n  }\n\n  public replaceSelection(props: IModelKeyProp & { source: string; selectables: Selectable[]; level?: number }): void {\n    this.handleChange({ ...props, changeType: \"replace\" });\n  }\n\n  public clearSelection(props: IModelKeyProp & { source: string; level?: number }): void {\n    this.handleChange({ ...props, changeType: \"clear\", selectables: [] });\n  }\n\n  public clearStorage(props: IModelKeyProp): void {\n    const imodelKey = getIModelKey(props);\n    this.clearSelection({ source: IMODEL_CLOSE_SELECTION_CLEAR_SOURCE, imodelKey });\n    this._storage.delete(imodelKey);\n  }\n\n  private getContainer(imodelKey: string): MultiLevelSelectablesContainer {\n    let selectionContainer = this._storage.get(imodelKey);\n    if (!selectionContainer) {\n      selectionContainer = new MultiLevelSelectablesContainer();\n      this._storage.set(imodelKey, selectionContainer);\n    }\n    return selectionContainer;\n  }\n\n  private handleChange(props: IModelKeyProp & { source: string; level?: number; changeType: StorageSelectionChangeType; selectables: Selectable[] }) {\n    const { source, level: inLevel, changeType, selectables: change } = props;\n    const imodelKey = getIModelKey(props);\n    const container = this.getContainer(imodelKey);\n    const level = inLevel ?? 0;\n    const selectables = container.getSelection(level);\n    const selected = Selectables.create(change);\n    switch (changeType) {\n      case \"add\":\n        if (!Selectables.add(selectables, change)) {\n          return;\n        }\n        break;\n      case \"remove\":\n        if (!Selectables.remove(selectables, change)) {\n          return;\n        }\n        break;\n      case \"replace\":\n        if (Selectables.size(selectables) === Selectables.size(selected) && Selectables.hasAll(selectables, change)) {\n          return;\n        }\n        Selectables.clear(selectables);\n        Selectables.add(selectables, change);\n        break;\n      case \"clear\":\n        if (!Selectables.clear(selectables)) {\n          return;\n        }\n        break;\n    }\n    container.clear(level + 1);\n    const event: StorageSelectionChangeEventArgs = {\n      source,\n      level,\n      imodelKey,\n      iModelKey: imodelKey,\n      changeType,\n      selectables: selected,\n      timestamp: new Date(),\n      storage: this,\n    };\n    this.selectionChangeEvent.raiseEvent(event, this);\n  }\n}\n\nfunction getIModelKey(props: IModelKeyProp): string {\n  // eslint-disable-next-line deprecation/deprecation\n  return \"imodelKey\" in props ? props.imodelKey : props.iModelKey;\n}\n\nclass MultiLevelSelectablesContainer {\n  private readonly _selectablesContainers: Map<number, Selectables>;\n\n  constructor() {\n    this._selectablesContainers = new Map<number, Selectables>();\n  }\n\n  public getSelection(level: number): Selectables {\n    let selectables = this._selectablesContainers.get(level);\n    if (!selectables) {\n      selectables = Selectables.create([]);\n      this._selectablesContainers.set(level, selectables);\n    }\n    return selectables;\n  }\n\n  public getSelectionLevels(): number[] {\n    const levels = new Array<number>();\n    for (const entry of this._selectablesContainers.entries()) {\n      if (!Selectables.isEmpty(entry[1])) {\n        levels.push(entry[0]);\n      }\n    }\n    return levels.sort();\n  }\n\n  public clear(level: number) {\n    const storedLevels = this._selectablesContainers.keys();\n    for (const storedLevel of storedLevels) {\n      if (storedLevel >= level) {\n        const selectables = this._selectablesContainers.get(storedLevel)!;\n        Selectables.clear(selectables);\n      }\n    }\n  }\n}\n"]}
+{"version":3,"file":"SelectionStorage.js","sourceRoot":"","sources":["../../../src/unified-selection/SelectionStorage.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C,OAAO,EAAc,WAAW,EAAE,MAAM,iBAAiB,CAAC;AA2F1D;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,aAAa;IAC3B,OAAO,IAAI,oBAAoB,EAAE,CAAC;AACpC,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,mCAAmC,GAAG,kCAAkC,CAAC;AAEtF,MAAM,oBAAoB;IAChB,QAAQ,GAAG,IAAI,GAAG,EAA0C,CAAC;IAC9D,oBAAoB,CAA2C;IAEtE;QACE,IAAI,CAAC,oBAAoB,GAAG,IAAI,OAAO,EAAE,CAAC;IAC5C,CAAC;IAEM,kBAAkB,CAAC,KAAoB;QAC5C,OAAO,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,kBAAkB,EAAE,CAAC;IACrE,CAAC;IAEM,YAAY,CAAC,KAAyC;QAC3D,OAAO,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;IAC/E,CAAC;IAEM,cAAc,CAAC,KAAoF;QACxG,IAAI,CAAC,YAAY,CAAC,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;IACrD,CAAC;IAEM,mBAAmB,CAAC,KAAoF;QAC7G,IAAI,CAAC,YAAY,CAAC,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC;IACxD,CAAC;IAEM,gBAAgB,CAAC,KAAoF;QAC1G,IAAI,CAAC,YAAY,CAAC,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;IACzD,CAAC;IAEM,cAAc,CAAC,KAAyD;QAC7E,IAAI,CAAC,YAAY,CAAC,EAAE,GAAG,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;IACxE,CAAC;IAEM,YAAY,CAAC,KAAoB;QACtC,MAAM,SAAS,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QACtC,IAAI,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,mCAAmC,EAAE,SAAS,EAAE,CAAC,CAAC;QAChF,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAClC,CAAC;IAEO,YAAY,CAAC,SAAiB;QACpC,IAAI,kBAAkB,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACtD,IAAI,CAAC,kBAAkB,EAAE,CAAC;YACxB,kBAAkB,GAAG,IAAI,8BAA8B,EAAE,CAAC;YAC1D,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;QACnD,CAAC;QACD,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAEO,YAAY,CAAC,KAA4H;QAC/I,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC;QAC1E,MAAM,SAAS,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QACtC,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAC/C,MAAM,KAAK,GAAG,OAAO,IAAI,CAAC,CAAC;QAC3B,MAAM,WAAW,GAAG,SAAS,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAClD,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC5C,QAAQ,UAAU,EAAE,CAAC;YACnB,KAAK,KAAK;gBACR,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,CAAC;oBAC1C,OAAO;gBACT,CAAC;gBACD,MAAM;YACR,KAAK,QAAQ;gBACX,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,EAAE,CAAC;oBAC7C,OAAO;gBACT,CAAC;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,CAAC;oBAC5G,OAAO;gBACT,CAAC;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,CAAC;oBACpC,OAAO;gBACT,CAAC;gBACD,MAAM;QACV,CAAC;QACD,SAAS,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QAC3B,MAAM,KAAK,GAAoC;YAC7C,MAAM;YACN,KAAK;YACL,SAAS;YACT,SAAS,EAAE,SAAS;YACpB,UAAU;YACV,WAAW,EAAE,QAAQ;YACrB,SAAS,EAAE,IAAI,IAAI,EAAE;YACrB,OAAO,EAAE,IAAI;SACd,CAAC;QACF,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;CACF;AAED,SAAS,YAAY,CAAC,KAAoB;IACxC,4DAA4D;IAC5D,OAAO,WAAW,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC;AAClE,CAAC;AAED,MAAM,8BAA8B;IACjB,sBAAsB,CAA2B;IAElE;QACE,IAAI,CAAC,sBAAsB,GAAG,IAAI,GAAG,EAAuB,CAAC;IAC/D,CAAC;IAEM,YAAY,CAAC,KAAa;QAC/B,IAAI,WAAW,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACzD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,WAAW,GAAG,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YACrC,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;QACtD,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAEM,kBAAkB;QACvB,MAAM,MAAM,GAAG,IAAI,KAAK,EAAU,CAAC;QACnC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,sBAAsB,CAAC,OAAO,EAAE,EAAE,CAAC;YAC1D,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBACnC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YACxB,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,KAAa;QACxB,MAAM,YAAY,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,EAAE,CAAC;QACxD,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;YACvC,IAAI,WAAW,IAAI,KAAK,EAAE,CAAC;gBACzB,MAAM,WAAW,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,WAAW,CAAE,CAAC;gBAClE,WAAW,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YACjC,CAAC;QACH,CAAC;IACH,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n * Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n * See LICENSE.md in the project root for license terms and full copyright notice.\n *--------------------------------------------------------------------------------------------*/\n\nimport { BeEvent } from \"@itwin/core-bentley\";\nimport { Event } from \"@itwin/presentation-shared\";\nimport { Selectable, Selectables } from \"./Selectable.js\";\nimport { StorageSelectionChangeEventArgs, StorageSelectionChangesListener, StorageSelectionChangeType } from \"./SelectionChangeEvent.js\";\n\n/** @public */\ntype IModelKeyProp =\n  | {\n      /** Key of the iModel to get selection levels for. */\n      imodelKey: string;\n    }\n  | {\n      /**\n       * Key of the iModel to get selection levels for.\n       * @deprecated in 0.2. Use `imodelKey` instead.\n       */\n      iModelKey: string;\n    };\n\n/**\n * Defines return value of `createStorage`.\n *\n * **Warning:** Used in public API as a return value. Not expected to be created / extended by package\n * consumers, may be supplemented with required attributes any time.\n *\n * @see `createStorage`\n * @public\n */\nexport interface SelectionStorage {\n  /** An event that is raised when selection changes. */\n  selectionChangeEvent: Event<StorageSelectionChangesListener>;\n\n  /** Get the selection levels currently stored for the specified iModel. */\n  getSelectionLevels(props: IModelKeyProp): number[];\n\n  /** Get the selection stored in the storage. */\n  getSelection(\n    props: IModelKeyProp & {\n      /** Level of the selection. Defaults to `0`. */\n      level?: number;\n    },\n  ): Selectables;\n\n  /** Add keys to the selection. */\n  addToSelection(\n    props: IModelKeyProp & {\n      /** Name of the selection source. Generally, this identifies the component that makes the selection change. */\n      source: string;\n      /** The selectables to add to selection. */\n      selectables: Selectable[];\n      /** Level of the selection. Defaults to `0`. */\n      level?: number;\n    },\n  ): void;\n\n  /** Remove keys from current selection. */\n  removeFromSelection(\n    props: IModelKeyProp & {\n      /** Name of the selection source. Generally, this identifies the component that makes the selection change. */\n      source: string;\n      /** The selectables to remove from selection. */\n      selectables: Selectable[];\n      /** Level of the selection. Defaults to `0`. */\n      level?: number;\n    },\n  ): void;\n\n  /** Replace current selection. */\n  replaceSelection(\n    props: IModelKeyProp & {\n      /** Name of the selection source. Generally, this identifies the component that makes the selection change. */\n      source: string;\n      /** The selectables to add to selection. */\n      selectables: Selectable[];\n      /** Level of the selection. Defaults to `0`. */\n      level?: number;\n    },\n  ): void;\n\n  /** Clear current selection. */\n  clearSelection(\n    props: IModelKeyProp & {\n      /** Name of the selection source. Generally, this identifies the component that makes the selection change. */\n      source: string;\n      /** Level of the selection. Defaults to `0`. */\n      level?: number;\n    },\n  ): void;\n\n  /** Clear storage for an iModel. This function should be called when iModel is closed. */\n  clearStorage(props: IModelKeyProp): void;\n}\n\n/**\n * Creates a selection storage which stores and allows managing application-level selection.\n *\n * **Note:** `clearSelection` should be called upon iModel close to free-up memory:\n *\n * ```ts\n * import { IModelConnection } from \"@itwin/core-frontend\";\n * IModelConnection.onClose.addListener((imodel) => {\n *   storage.clearStorage(imodel.key);\n * });\n * ```\n *\n * @public\n */\nexport function createStorage(): SelectionStorage {\n  return new SelectionStorageImpl();\n}\n\n/** @internal */\nexport const IMODEL_CLOSE_SELECTION_CLEAR_SOURCE = \"Unified selection storage: clear\";\n\nclass SelectionStorageImpl implements SelectionStorage {\n  private _storage = new Map<string, MultiLevelSelectablesContainer>();\n  public selectionChangeEvent: BeEvent<StorageSelectionChangesListener>;\n\n  constructor() {\n    this.selectionChangeEvent = new BeEvent();\n  }\n\n  public getSelectionLevels(props: IModelKeyProp): number[] {\n    return this.getContainer(getIModelKey(props)).getSelectionLevels();\n  }\n\n  public getSelection(props: IModelKeyProp & { level?: number }): Selectables {\n    return this.getContainer(getIModelKey(props)).getSelection(props.level ?? 0);\n  }\n\n  public addToSelection(props: IModelKeyProp & { source: string; selectables: Selectable[]; level?: number }): void {\n    this.handleChange({ ...props, changeType: \"add\" });\n  }\n\n  public removeFromSelection(props: IModelKeyProp & { source: string; selectables: Selectable[]; level?: number }): void {\n    this.handleChange({ ...props, changeType: \"remove\" });\n  }\n\n  public replaceSelection(props: IModelKeyProp & { source: string; selectables: Selectable[]; level?: number }): void {\n    this.handleChange({ ...props, changeType: \"replace\" });\n  }\n\n  public clearSelection(props: IModelKeyProp & { source: string; level?: number }): void {\n    this.handleChange({ ...props, changeType: \"clear\", selectables: [] });\n  }\n\n  public clearStorage(props: IModelKeyProp): void {\n    const imodelKey = getIModelKey(props);\n    this.clearSelection({ source: IMODEL_CLOSE_SELECTION_CLEAR_SOURCE, imodelKey });\n    this._storage.delete(imodelKey);\n  }\n\n  private getContainer(imodelKey: string): MultiLevelSelectablesContainer {\n    let selectionContainer = this._storage.get(imodelKey);\n    if (!selectionContainer) {\n      selectionContainer = new MultiLevelSelectablesContainer();\n      this._storage.set(imodelKey, selectionContainer);\n    }\n    return selectionContainer;\n  }\n\n  private handleChange(props: IModelKeyProp & { source: string; level?: number; changeType: StorageSelectionChangeType; selectables: Selectable[] }) {\n    const { source, level: inLevel, changeType, selectables: change } = props;\n    const imodelKey = getIModelKey(props);\n    const container = this.getContainer(imodelKey);\n    const level = inLevel ?? 0;\n    const selectables = container.getSelection(level);\n    const selected = Selectables.create(change);\n    switch (changeType) {\n      case \"add\":\n        if (!Selectables.add(selectables, change)) {\n          return;\n        }\n        break;\n      case \"remove\":\n        if (!Selectables.remove(selectables, change)) {\n          return;\n        }\n        break;\n      case \"replace\":\n        if (Selectables.size(selectables) === Selectables.size(selected) && Selectables.hasAll(selectables, change)) {\n          return;\n        }\n        Selectables.clear(selectables);\n        Selectables.add(selectables, change);\n        break;\n      case \"clear\":\n        if (!Selectables.clear(selectables)) {\n          return;\n        }\n        break;\n    }\n    container.clear(level + 1);\n    const event: StorageSelectionChangeEventArgs = {\n      source,\n      level,\n      imodelKey,\n      iModelKey: imodelKey,\n      changeType,\n      selectables: selected,\n      timestamp: new Date(),\n      storage: this,\n    };\n    this.selectionChangeEvent.raiseEvent(event, this);\n  }\n}\n\nfunction getIModelKey(props: IModelKeyProp): string {\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\n  return \"imodelKey\" in props ? props.imodelKey : props.iModelKey;\n}\n\nclass MultiLevelSelectablesContainer {\n  private readonly _selectablesContainers: Map<number, Selectables>;\n\n  constructor() {\n    this._selectablesContainers = new Map<number, Selectables>();\n  }\n\n  public getSelection(level: number): Selectables {\n    let selectables = this._selectablesContainers.get(level);\n    if (!selectables) {\n      selectables = Selectables.create([]);\n      this._selectablesContainers.set(level, selectables);\n    }\n    return selectables;\n  }\n\n  public getSelectionLevels(): number[] {\n    const levels = new Array<number>();\n    for (const entry of this._selectablesContainers.entries()) {\n      if (!Selectables.isEmpty(entry[1])) {\n        levels.push(entry[0]);\n      }\n    }\n    return levels.sort();\n  }\n\n  public clear(level: number) {\n    const storedLevels = this._selectablesContainers.keys();\n    for (const storedLevel of storedLevels) {\n      if (storedLevel >= level) {\n        const selectables = this._selectablesContainers.get(storedLevel)!;\n        Selectables.clear(selectables);\n      }\n    }\n  }\n}\n"]}

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

@@ -18,7 +18,7 @@ export declare enum CoreSelectionSetEventType {
 /**
  * Payload sent to `CoreIModelSelectionSet.onChanged` event listeners to describe how the contents of the set have changed.
  * @see https://www.itwinjs.org/reference/core-frontend/selectionset/selectionsetevent/
- * @beta
+ * @public
  */
 export interface CoreSelectionSetEventUnsafe {
     /**
@@ -39,7 +39,7 @@ export interface CoreSelectionSetEventUnsafe {
 /**
  * A set of *currently selected* elements in an iModel.
  * @see https://www.itwinjs.org/reference/core-frontend/selectionset/
- * @beta
+ * @public
  */
 export interface CoreIModelSelectionSet {
     /** Event called whenever elements are added or removed from this SelectionSet. */
@@ -56,7 +56,7 @@ export interface CoreIModelSelectionSet {
 /**
  * A set if ID's optimized for performance-critical code which represents large sets of ID's as pairs of 32-bit integers.
  * @see https://www.itwinjs.org/reference/core-bentley/ids/id64/id64.uint32set/
- * @beta
+ * @public
  */
 interface Uint32Set {
     /** Add any number of Ids to the set. */
@@ -67,7 +67,7 @@ interface Uint32Set {
 /**
  * A set of *hilited* elements in an iModel, by element id.
  * @see https://www.itwinjs.org/reference/core-frontend/selectionset/hiliteset/
- * @beta
+ * @public
  */
 export interface CoreIModelHiliteSet {
     /** Control whether the hilited elements should be synchronized with the contents of `CoreIModelSelectionSet`.*/

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

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

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

@@ -1,8 +1,8 @@
-export * from "./unified-selection/Selectable";
-export { SelectionStorage, createStorage } from "./unified-selection/SelectionStorage";
-export { createHiliteSetProvider, HiliteSet, HiliteSetProvider } from "./unified-selection/HiliteSetProvider";
-export { createCachingHiliteSetProvider, CachingHiliteSetProvider } from "./unified-selection/CachingHiliteSetProvider";
-export { computeSelection } from "./unified-selection/SelectionScope";
-export { enableUnifiedSelectionSyncWithIModel } from "./unified-selection/EnableUnifiedSelectionSyncWithIModel";
-export { StorageSelectionChangeType, StorageSelectionChangeEventArgs, StorageSelectionChangesListener } from "./unified-selection/SelectionChangeEvent";
+export { TRANSIENT_ELEMENT_CLASSNAME, CustomSelectable, Selectable, SelectableIdentifier, SelectableInstanceKey, Selectables, } from "./unified-selection/Selectable.js";
+export { SelectionStorage, createStorage } from "./unified-selection/SelectionStorage.js";
+export { createHiliteSetProvider, HiliteSet, HiliteSetProvider } from "./unified-selection/HiliteSetProvider.js";
+export { createCachingHiliteSetProvider, CachingHiliteSetProvider } from "./unified-selection/CachingHiliteSetProvider.js";
+export { computeSelection } from "./unified-selection/SelectionScope.js";
+export { enableUnifiedSelectionSyncWithIModel } from "./unified-selection/EnableUnifiedSelectionSyncWithIModel.js";
+export { StorageSelectionChangeType, StorageSelectionChangeEventArgs, StorageSelectionChangesListener } from "./unified-selection/SelectionChangeEvent.js";
 //# sourceMappingURL=unified-selection.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"unified-selection.d.ts","sourceRoot":"","sources":["../../src/unified-selection.ts"],"names":[],"mappings":"AAKA,cAAc,gCAAgC,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACvF,OAAO,EAAE,uBAAuB,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,uCAAuC,CAAC;AAC9G,OAAO,EAAE,8BAA8B,EAAE,wBAAwB,EAAE,MAAM,8CAA8C,CAAC;AACxH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,oCAAoC,EAAE,MAAM,0DAA0D,CAAC;AAChH,OAAO,EAAE,0BAA0B,EAAE,+BAA+B,EAAE,+BAA+B,EAAE,MAAM,0CAA0C,CAAC"}
+{"version":3,"file":"unified-selection.d.ts","sourceRoot":"","sources":["../../src/unified-selection.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,2BAA2B,EAC3B,gBAAgB,EAChB,UAAU,EACV,oBAAoB,EACpB,qBAAqB,EACrB,WAAW,GACZ,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AAC1F,OAAO,EAAE,uBAAuB,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,0CAA0C,CAAC;AACjH,OAAO,EAAE,8BAA8B,EAAE,wBAAwB,EAAE,MAAM,iDAAiD,CAAC;AAC3H,OAAO,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAC;AACzE,OAAO,EAAE,oCAAoC,EAAE,MAAM,6DAA6D,CAAC;AACnH,OAAO,EAAE,0BAA0B,EAAE,+BAA+B,EAAE,+BAA+B,EAAE,MAAM,6CAA6C,CAAC"}

package/lib/esm/unified-selection.js

@@ -2,10 +2,10 @@
  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
-export * from "./unified-selection/Selectable";
-export { createStorage } from "./unified-selection/SelectionStorage";
-export { createHiliteSetProvider } from "./unified-selection/HiliteSetProvider";
-export { createCachingHiliteSetProvider } from "./unified-selection/CachingHiliteSetProvider";
-export { computeSelection } from "./unified-selection/SelectionScope";
-export { enableUnifiedSelectionSyncWithIModel } from "./unified-selection/EnableUnifiedSelectionSyncWithIModel";
+export { TRANSIENT_ELEMENT_CLASSNAME, Selectable, Selectables, } from "./unified-selection/Selectable.js";
+export { createStorage } from "./unified-selection/SelectionStorage.js";
+export { createHiliteSetProvider } from "./unified-selection/HiliteSetProvider.js";
+export { createCachingHiliteSetProvider } from "./unified-selection/CachingHiliteSetProvider.js";
+export { computeSelection } from "./unified-selection/SelectionScope.js";
+export { enableUnifiedSelectionSyncWithIModel } from "./unified-selection/EnableUnifiedSelectionSyncWithIModel.js";
 //# sourceMappingURL=unified-selection.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"unified-selection.js","sourceRoot":"","sources":["../../src/unified-selection.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,cAAc,gCAAgC,CAAC;AAC/C,OAAO,EAAoB,aAAa,EAAE,MAAM,sCAAsC,CAAC;AACvF,OAAO,EAAE,uBAAuB,EAAgC,MAAM,uCAAuC,CAAC;AAC9G,OAAO,EAAE,8BAA8B,EAA4B,MAAM,8CAA8C,CAAC;AACxH,OAAO,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACtE,OAAO,EAAE,oCAAoC,EAAE,MAAM,0DAA0D,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\nexport * from \"./unified-selection/Selectable\";\nexport { SelectionStorage, createStorage } from \"./unified-selection/SelectionStorage\";\nexport { createHiliteSetProvider, HiliteSet, HiliteSetProvider } from \"./unified-selection/HiliteSetProvider\";\nexport { createCachingHiliteSetProvider, CachingHiliteSetProvider } from \"./unified-selection/CachingHiliteSetProvider\";\nexport { computeSelection } from \"./unified-selection/SelectionScope\";\nexport { enableUnifiedSelectionSyncWithIModel } from \"./unified-selection/EnableUnifiedSelectionSyncWithIModel\";\nexport { StorageSelectionChangeType, StorageSelectionChangeEventArgs, StorageSelectionChangesListener } from \"./unified-selection/SelectionChangeEvent\";\n"]}
+{"version":3,"file":"unified-selection.js","sourceRoot":"","sources":["../../src/unified-selection.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EACL,2BAA2B,EAE3B,UAAU,EAGV,WAAW,GACZ,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAoB,aAAa,EAAE,MAAM,yCAAyC,CAAC;AAC1F,OAAO,EAAE,uBAAuB,EAAgC,MAAM,0CAA0C,CAAC;AACjH,OAAO,EAAE,8BAA8B,EAA4B,MAAM,iDAAiD,CAAC;AAC3H,OAAO,EAAE,gBAAgB,EAAE,MAAM,uCAAuC,CAAC;AACzE,OAAO,EAAE,oCAAoC,EAAE,MAAM,6DAA6D,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\nexport {\n  TRANSIENT_ELEMENT_CLASSNAME,\n  CustomSelectable,\n  Selectable,\n  SelectableIdentifier,\n  SelectableInstanceKey,\n  Selectables,\n} from \"./unified-selection/Selectable.js\";\nexport { SelectionStorage, createStorage } from \"./unified-selection/SelectionStorage.js\";\nexport { createHiliteSetProvider, HiliteSet, HiliteSetProvider } from \"./unified-selection/HiliteSetProvider.js\";\nexport { createCachingHiliteSetProvider, CachingHiliteSetProvider } from \"./unified-selection/CachingHiliteSetProvider.js\";\nexport { computeSelection } from \"./unified-selection/SelectionScope.js\";\nexport { enableUnifiedSelectionSyncWithIModel } from \"./unified-selection/EnableUnifiedSelectionSyncWithIModel.js\";\nexport { StorageSelectionChangeType, StorageSelectionChangeEventArgs, StorageSelectionChangesListener } from \"./unified-selection/SelectionChangeEvent.js\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/unified-selection",
-  "version": "1.0.1",
+  "version": "1.1.1",
   "description": "Package for managing unified selection in iTwin.js applications.",
   "license": "MIT",
   "repository": {
@@ -24,48 +24,55 @@
     "name": "Bentley Systems, Inc.",
     "url": "http://www.bentley.com"
   },
+  "type": "module",
   "main": "lib/cjs/unified-selection.js",
+  "types": "lib/cjs/unified-selection",
   "module": "lib/esm/unified-selection.js",
-  "types": "lib/cjs/unified-selection.d.ts",
+  "exports": {
+    ".": {
+      "import": "./lib/esm/unified-selection.js",
+      "require": "./lib/cjs/unified-selection.js"
+    },
+    "./package.json": "./package.json"
+  },
   "dependencies": {
     "@itwin/core-bentley": "^4.9.0",
     "rxjs": "^7.8.1",
     "rxjs-for-await": "^1.0.0",
-    "@itwin/presentation-shared": "^1.0.0"
+    "@itwin/presentation-shared": "^1.1.0"
   },
   "devDependencies": {
-    "@itwin/build-tools": "^4.9.0",
-    "@itwin/eslint-plugin": "^4.1.1",
+    "@itwin/build-tools": "^4.10.0-dev.33",
+    "@itwin/eslint-plugin": "5.0.0-dev.1",
     "@types/chai": "^4.3.16",
     "@types/chai-as-promised": "^7.1.8",
     "@types/mocha": "^10.0.7",
     "@types/node": "^20.12.12",
     "@types/sinon": "^17.0.3",
     "@types/sinon-chai": "^3.2.12",
+    "c8": "^10.1.2",
     "chai": "^4.4.1",
     "chai-as-promised": "^7.1.2",
     "cpx2": "^7.0.1",
-    "eslint": "^8.57.0",
-    "mocha": "^10.6.0",
-    "nyc": "^17.0.0",
+    "eslint": "^9.13.0",
+    "mocha": "^10.7.3",
     "rimraf": "^6.0.1",
     "sinon": "^18.0.0",
     "sinon-chai": "^3.7.0",
-    "typescript": "~5.5.3",
-    "presentation-build-tools": "^0.0.0",
-    "presentation-test-utilities": "^0.0.0"
+    "testdouble": "^3.20.2",
+    "typescript": "~5.6.3",
+    "presentation-test-utilities": "^0.0.0",
+    "presentation-build-tools": "^0.0.0"
   },
   "scripts": {
     "build": "npm run -s build:cjs && npm run -s build:esm",
-    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:cjs": "node ../../scripts/package-cjs.mjs ./lib/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",
+    "cover": "c8 npm -s test",
     "lint": "eslint ./src/**/*.ts",
-    "test": "mocha --enable-source-maps --config ./.mocharc.json",
     "test:dev": "mocha --enable-source-maps --config ./.mocharc.json",
-    "test:watch": "npm -s test -- --reporter min --watch-extensions ts --watch",
+    "test": "npm run test:dev",
     "extract-api": "extract-api --entry=unified-selection --apiReportFolder=./api --apiReportTempFolder=./api/temp --apiSummaryFolder=./api",
     "check-internal": "node ../../scripts/checkInternal.js --apiSummary ./api/unified-selection.api.md",
     "validate-markdowns": "node ../../scripts/validateMarkdowns.js README.md"