@itwin/presentation-backend 3.0.0-dev.100

package/lib/cjs/presentation-backend/RulesetVariablesManager.js

@@ -0,0 +1,130 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Core
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RulesetVariablesManagerImpl = void 0;
+const presentation_common_1 = require("@itwin/presentation-common");
+/**
+ * Presentation ruleset variables registry implementation.
+ * @internal
+ */
+class RulesetVariablesManagerImpl {
+    constructor(getNativeAddon, rulesetId) {
+        this._getNativePlatform = getNativeAddon;
+        this._rulesetId = rulesetId;
+    }
+    setValueInternal(variableId, type, value) {
+        this._getNativePlatform().setRulesetVariableValue(this._rulesetId, variableId, type, value);
+    }
+    getValueInternal(variableId, type) {
+        return this._getNativePlatform().getRulesetVariableValue(this._rulesetId, variableId, type).result;
+    }
+    setValue(variableId, type, value) {
+        switch (type) {
+            case presentation_common_1.VariableValueTypes.Bool: return this.setBool(variableId, value);
+            case presentation_common_1.VariableValueTypes.Id64: return this.setId64(variableId, value);
+            case presentation_common_1.VariableValueTypes.Id64Array: return this.setId64s(variableId, value);
+            case presentation_common_1.VariableValueTypes.Int: return this.setInt(variableId, value);
+            case presentation_common_1.VariableValueTypes.IntArray: return this.setInts(variableId, value);
+            case presentation_common_1.VariableValueTypes.String: return this.setString(variableId, value);
+        }
+    }
+    unset(variableId) {
+        this._getNativePlatform().unsetRulesetVariableValue(this._rulesetId, variableId);
+    }
+    getValue(variableId, type) {
+        switch (type) {
+            case presentation_common_1.VariableValueTypes.Bool: return this.getBool(variableId);
+            case presentation_common_1.VariableValueTypes.Id64: return this.getId64(variableId);
+            case presentation_common_1.VariableValueTypes.Id64Array: return this.getId64s(variableId);
+            case presentation_common_1.VariableValueTypes.Int: return this.getInt(variableId);
+            case presentation_common_1.VariableValueTypes.IntArray: return this.getInts(variableId);
+            case presentation_common_1.VariableValueTypes.String: return this.getString(variableId);
+        }
+    }
+    /**
+     * Retrieves `string` variable value.
+     * Returns empty string if variable does not exist or does not convert to string.
+     */
+    getString(variableId) {
+        return (this.getValueInternal(variableId, presentation_common_1.VariableValueTypes.String));
+    }
+    /**
+     * Sets `string` variable value
+     */
+    setString(variableId, value) {
+        this.setValueInternal(variableId, presentation_common_1.VariableValueTypes.String, value);
+    }
+    /**
+     * Retrieves `boolean` variable value.
+     * Returns `false` if variable does not exist or does not convert to boolean.
+     */
+    getBool(variableId) {
+        return (this.getValueInternal(variableId, presentation_common_1.VariableValueTypes.Bool));
+    }
+    /**
+     * Sets `boolean` variable value
+     */
+    setBool(variableId, value) {
+        this.setValueInternal(variableId, presentation_common_1.VariableValueTypes.Bool, value);
+    }
+    /**
+     * Retrieves `number` variable value.
+     * Returns `0` if variable does not exist or does not convert to integer.
+     */
+    getInt(variableId) {
+        return (this.getValueInternal(variableId, presentation_common_1.VariableValueTypes.Int));
+    }
+    /**
+     * Sets `number` variable value
+     */
+    setInt(variableId, value) {
+        this.setValueInternal(variableId, presentation_common_1.VariableValueTypes.Int, value);
+    }
+    /**
+     * Retrieves `number[]` variable value.
+     * Returns empty array if variable does not exist or does not convert to integer array.
+     */
+    getInts(variableId) {
+        return (this.getValueInternal(variableId, presentation_common_1.VariableValueTypes.IntArray));
+    }
+    /**
+     * Sets `number[]` variable value
+     */
+    setInts(variableId, value) {
+        this.setValueInternal(variableId, presentation_common_1.VariableValueTypes.IntArray, value);
+    }
+    /**
+     * Retrieves `Id64String` variable value.
+     * Returns invalid Id64String if variable does not exist or does not convert to Id64String.
+     */
+    getId64(variableId) {
+        return (this.getValueInternal(variableId, presentation_common_1.VariableValueTypes.Id64));
+    }
+    /**
+     * Sets `Id64String` variable value
+     */
+    setId64(variableId, value) {
+        this.setValueInternal(variableId, presentation_common_1.VariableValueTypes.Id64, value);
+    }
+    /**
+     * Retrieves `Id64String[]` variable value.
+     * Returns empty array if variable does not exist or does not convert to Id64String array.
+     */
+    getId64s(variableId) {
+        return (this.getValueInternal(variableId, presentation_common_1.VariableValueTypes.Id64Array));
+    }
+    /**
+     * Sets `Id64String[]` variable value
+     */
+    setId64s(variableId, value) {
+        this.setValueInternal(variableId, presentation_common_1.VariableValueTypes.Id64Array, value);
+    }
+}
+exports.RulesetVariablesManagerImpl = RulesetVariablesManagerImpl;
+//# sourceMappingURL=RulesetVariablesManager.js.map

package/lib/cjs/presentation-backend/RulesetVariablesManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RulesetVariablesManager.js","sourceRoot":"","sources":["../../../src/presentation-backend/RulesetVariablesManager.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,oEAA+E;AA4E/E;;;GAGG;AACH,MAAa,2BAA2B;IAItC,YAAY,cAA8C,EAAE,SAAiB;QAC3E,IAAI,CAAC,kBAAkB,GAAG,cAAc,CAAC;QACzC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAEM,gBAAgB,CAAC,UAAkB,EAAE,IAAwB,EAAE,KAAoB;QACxF,IAAI,CAAC,kBAAkB,EAAE,CAAC,uBAAuB,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAC9F,CAAC;IAEM,gBAAgB,CAAC,UAAkB,EAAE,IAAwB;QAClE,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC,uBAAuB,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC;IACrG,CAAC;IAEM,QAAQ,CAAC,UAAkB,EAAE,IAAwB,EAAE,KAAoB;QAChF,QAAQ,IAAI,EAAE;YACZ,KAAK,wCAAkB,CAAC,IAAI,CAAC,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,KAAgB,CAAC,CAAC;YAChF,KAAK,wCAAkB,CAAC,IAAI,CAAC,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,KAAmB,CAAC,CAAC;YACnF,KAAK,wCAAkB,CAAC,SAAS,CAAC,CAAC,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,KAAqB,CAAC,CAAC;YAC3F,KAAK,wCAAkB,CAAC,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,KAAe,CAAC,CAAC;YAC7E,KAAK,wCAAkB,CAAC,QAAQ,CAAC,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,KAAiB,CAAC,CAAC;YACrF,KAAK,wCAAkB,CAAC,MAAM,CAAC,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,KAAe,CAAC,CAAC;SACpF;IACH,CAAC;IAEM,KAAK,CAAC,UAAkB;QAC7B,IAAI,CAAC,kBAAkB,EAAE,CAAC,yBAAyB,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IACnF,CAAC;IAEM,QAAQ,CAAC,UAAkB,EAAE,IAAwB;QAC1D,QAAQ,IAAI,EAAE;YACZ,KAAK,wCAAkB,CAAC,IAAI,CAAC,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAC9D,KAAK,wCAAkB,CAAC,IAAI,CAAC,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAC9D,KAAK,wCAAkB,CAAC,SAAS,CAAC,CAAC,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YACpE,KAAK,wCAAkB,CAAC,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC5D,KAAK,wCAAkB,CAAC,QAAQ,CAAC,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAClE,KAAK,wCAAkB,CAAC,MAAM,CAAC,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;SACnE;IACH,CAAC;IAED;;;OAGG;IACI,SAAS,CAAC,UAAkB;QACjC,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,wCAAkB,CAAC,MAAM,CAAC,CAAW,CAAC;IAClF,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,UAAkB,EAAE,KAAa;QAChD,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,wCAAkB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACtE,CAAC;IAED;;;OAGG;IACI,OAAO,CAAC,UAAkB;QAC/B,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,wCAAkB,CAAC,IAAI,CAAC,CAAY,CAAC;IACjF,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,UAAkB,EAAE,KAAc;QAC/C,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,wCAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,UAAkB;QAC9B,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,wCAAkB,CAAC,GAAG,CAAC,CAAW,CAAC;IAC/E,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,UAAkB,EAAE,KAAa;QAC7C,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,wCAAkB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACnE,CAAC;IAED;;;OAGG;IACI,OAAO,CAAC,UAAkB;QAC/B,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,wCAAkB,CAAC,QAAQ,CAAC,CAAa,CAAC;IACtF,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,UAAkB,EAAE,KAAe;QAChD,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,wCAAkB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACxE,CAAC;IAED;;;OAGG;IACI,OAAO,CAAC,UAAkB;QAC/B,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,wCAAkB,CAAC,IAAI,CAAC,CAAe,CAAC;IACpF,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,UAAkB,EAAE,KAAiB;QAClD,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,wCAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,UAAkB;QAChC,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,wCAAkB,CAAC,SAAS,CAAC,CAAiB,CAAC;IAC3F,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,UAAkB,EAAE,KAAmB;QACrD,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,wCAAkB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IACzE,CAAC;CACF;AApID,kEAoIC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Core\r\n */\r\n\r\nimport { Id64String } from \"@itwin/core-bentley\";\r\nimport { VariableValue, VariableValueTypes } from \"@itwin/presentation-common\";\r\nimport { NativePlatformDefinition } from \"./NativePlatform\";\r\n\r\n/**\r\n * Presentation ruleset variables registry.\r\n * @public\r\n */\r\nexport interface RulesetVariablesManager {\r\n  /** Gets a value of the specified type and ID */\r\n  getValue(variableId: string, type: VariableValueTypes): VariableValue;\r\n  /** Sets a value of the specified type */\r\n  setValue(variableId: string, type: VariableValueTypes, value: VariableValue): void;\r\n  /** Unsets variable with given id. */\r\n  unset(variableId: string): void;\r\n\r\n  /**\r\n   * Retrieves `string` variable value.\r\n   * Returns empty string if variable does not exist or does not convert to string.\r\n   */\r\n  getString(variableId: string): string;\r\n  /**\r\n   * Sets `string` variable value\r\n   */\r\n  setString(variableId: string, value: string): void;\r\n\r\n  /**\r\n   * Retrieves `boolean` variable value.\r\n   * Returns `false` if variable does not exist or does not convert to boolean.\r\n   */\r\n  getBool(variableId: string): boolean;\r\n  /**\r\n   * Sets `boolean` variable value\r\n   */\r\n  setBool(variableId: string, value: boolean): void;\r\n\r\n  /**\r\n   * Retrieves `number` variable value.\r\n   * Returns `0` if variable does not exist or does not convert to integer.\r\n   */\r\n  getInt(variableId: string): number;\r\n  /**\r\n   * Sets `number` variable value\r\n   */\r\n  setInt(variableId: string, value: number): void;\r\n\r\n  /**\r\n   * Retrieves `number[]` variable value.\r\n   * Returns empty array if variable does not exist or does not convert to integer array.\r\n   */\r\n  getInts(variableId: string): number[];\r\n  /**\r\n   * Sets `number[]` variable value\r\n   */\r\n  setInts(variableId: string, value: number[]): void;\r\n\r\n  /**\r\n   * Retrieves `Id64String` variable value.\r\n   * Returns invalid Id64String if variable does not exist or does not convert to Id64String.\r\n   */\r\n  getId64(variableId: string): Id64String;\r\n  /**\r\n   * Sets `Id64String` variable value\r\n   */\r\n  setId64(variableId: string, value: Id64String): void;\r\n\r\n  /**\r\n   * Retrieves `Id64String[]` variable value.\r\n   * Returns empty array if variable does not exist or does not convert to Id64String array.\r\n   */\r\n  getId64s(variableId: string): Id64String[];\r\n  /**\r\n   * Sets `Id64String[]` variable value\r\n   */\r\n  setId64s(variableId: string, value: Id64String[]): void;\r\n}\r\n\r\n/**\r\n * Presentation ruleset variables registry implementation.\r\n * @internal\r\n */\r\nexport class RulesetVariablesManagerImpl implements RulesetVariablesManager {\r\n  private _getNativePlatform: () => NativePlatformDefinition;\r\n  private _rulesetId: string;\r\n\r\n  constructor(getNativeAddon: () => NativePlatformDefinition, rulesetId: string) {\r\n    this._getNativePlatform = getNativeAddon;\r\n    this._rulesetId = rulesetId;\r\n  }\r\n\r\n  public setValueInternal(variableId: string, type: VariableValueTypes, value: VariableValue): void {\r\n    this._getNativePlatform().setRulesetVariableValue(this._rulesetId, variableId, type, value);\r\n  }\r\n\r\n  public getValueInternal(variableId: string, type: VariableValueTypes): VariableValue {\r\n    return this._getNativePlatform().getRulesetVariableValue(this._rulesetId, variableId, type).result;\r\n  }\r\n\r\n  public setValue(variableId: string, type: VariableValueTypes, value: VariableValue): void {\r\n    switch (type) {\r\n      case VariableValueTypes.Bool: return this.setBool(variableId, value as boolean);\r\n      case VariableValueTypes.Id64: return this.setId64(variableId, value as Id64String);\r\n      case VariableValueTypes.Id64Array: return this.setId64s(variableId, value as Id64String[]);\r\n      case VariableValueTypes.Int: return this.setInt(variableId, value as number);\r\n      case VariableValueTypes.IntArray: return this.setInts(variableId, value as number[]);\r\n      case VariableValueTypes.String: return this.setString(variableId, value as string);\r\n    }\r\n  }\r\n\r\n  public unset(variableId: string): void {\r\n    this._getNativePlatform().unsetRulesetVariableValue(this._rulesetId, variableId);\r\n  }\r\n\r\n  public getValue(variableId: string, type: VariableValueTypes): VariableValue {\r\n    switch (type) {\r\n      case VariableValueTypes.Bool: return this.getBool(variableId);\r\n      case VariableValueTypes.Id64: return this.getId64(variableId);\r\n      case VariableValueTypes.Id64Array: return this.getId64s(variableId);\r\n      case VariableValueTypes.Int: return this.getInt(variableId);\r\n      case VariableValueTypes.IntArray: return this.getInts(variableId);\r\n      case VariableValueTypes.String: return this.getString(variableId);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Retrieves `string` variable value.\r\n   * Returns empty string if variable does not exist or does not convert to string.\r\n   */\r\n  public getString(variableId: string): string {\r\n    return (this.getValueInternal(variableId, VariableValueTypes.String)) as string;\r\n  }\r\n\r\n  /**\r\n   * Sets `string` variable value\r\n   */\r\n  public setString(variableId: string, value: string): void {\r\n    this.setValueInternal(variableId, VariableValueTypes.String, value);\r\n  }\r\n\r\n  /**\r\n   * Retrieves `boolean` variable value.\r\n   * Returns `false` if variable does not exist or does not convert to boolean.\r\n   */\r\n  public getBool(variableId: string): boolean {\r\n    return (this.getValueInternal(variableId, VariableValueTypes.Bool)) as boolean;\r\n  }\r\n\r\n  /**\r\n   * Sets `boolean` variable value\r\n   */\r\n  public setBool(variableId: string, value: boolean): void {\r\n    this.setValueInternal(variableId, VariableValueTypes.Bool, value);\r\n  }\r\n\r\n  /**\r\n   * Retrieves `number` variable value.\r\n   * Returns `0` if variable does not exist or does not convert to integer.\r\n   */\r\n  public getInt(variableId: string): number {\r\n    return (this.getValueInternal(variableId, VariableValueTypes.Int)) as number;\r\n  }\r\n\r\n  /**\r\n   * Sets `number` variable value\r\n   */\r\n  public setInt(variableId: string, value: number): void {\r\n    this.setValueInternal(variableId, VariableValueTypes.Int, value);\r\n  }\r\n\r\n  /**\r\n   * Retrieves `number[]` variable value.\r\n   * Returns empty array if variable does not exist or does not convert to integer array.\r\n   */\r\n  public getInts(variableId: string): number[] {\r\n    return (this.getValueInternal(variableId, VariableValueTypes.IntArray)) as number[];\r\n  }\r\n\r\n  /**\r\n   * Sets `number[]` variable value\r\n   */\r\n  public setInts(variableId: string, value: number[]): void {\r\n    this.setValueInternal(variableId, VariableValueTypes.IntArray, value);\r\n  }\r\n\r\n  /**\r\n   * Retrieves `Id64String` variable value.\r\n   * Returns invalid Id64String if variable does not exist or does not convert to Id64String.\r\n   */\r\n  public getId64(variableId: string): Id64String {\r\n    return (this.getValueInternal(variableId, VariableValueTypes.Id64)) as Id64String;\r\n  }\r\n\r\n  /**\r\n   * Sets `Id64String` variable value\r\n   */\r\n  public setId64(variableId: string, value: Id64String): void {\r\n    this.setValueInternal(variableId, VariableValueTypes.Id64, value);\r\n  }\r\n\r\n  /**\r\n   * Retrieves `Id64String[]` variable value.\r\n   * Returns empty array if variable does not exist or does not convert to Id64String array.\r\n   */\r\n  public getId64s(variableId: string): Id64String[] {\r\n    return (this.getValueInternal(variableId, VariableValueTypes.Id64Array)) as Id64String[];\r\n  }\r\n\r\n  /**\r\n   * Sets `Id64String[]` variable value\r\n   */\r\n  public setId64s(variableId: string, value: Id64String[]): void {\r\n    this.setValueInternal(variableId, VariableValueTypes.Id64Array, value);\r\n  }\r\n}\r\n"]}

package/lib/cjs/presentation-backend/SelectionScopesHelper.d.ts

@@ -0,0 +1,38 @@
+/** @packageDocumentation
+ * @module Core
+ */
+import { Id64String } from "@itwin/core-bentley";
+import { IModelDb } from "@itwin/core-backend";
+import { KeySet, SelectionScope, SelectionScopeRequestOptions } from "@itwin/presentation-common";
+/**
+ * Contains helper methods for computing selection scopes. Will get removed
+ * once rules-driven scopes are implemented.
+ *
+ * @internal
+ */
+export declare class SelectionScopesHelper {
+    private constructor();
+    static getSelectionScopes(): SelectionScope[];
+    private static computeElementSelection;
+    private static getParentInstanceKey;
+    private static getAssemblyKey;
+    private static computeAssemblySelection;
+    private static getTopAssemblyKey;
+    private static computeTopAssemblySelection;
+    private static computeCategorySelection;
+    private static computeModelSelection;
+    private static getRelatedFunctionalElementKey;
+    private static findFirstRelatedFunctionalElementKey;
+    private static elementClassDerivesFrom;
+    private static computeFunctionalElementSelection;
+    private static computeFunctionalAssemblySelection;
+    private static computeFunctionalTopAssemblySelection;
+    /**
+     * Computes selection set based on provided selection scope.
+     * @param requestOptions Options for the request
+     * @param keys Keys of elements to get the content for.
+     * @param scopeId ID of selection scope to use for computing selection
+     */
+    static computeSelection(requestOptions: SelectionScopeRequestOptions<IModelDb>, ids: Id64String[], scopeId: string): Promise<KeySet>;
+}
+//# sourceMappingURL=SelectionScopesHelper.d.ts.map

package/lib/cjs/presentation-backend/SelectionScopesHelper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SelectionScopesHelper.d.ts","sourceRoot":"","sources":["../../../src/presentation-backend/SelectionScopesHelper.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAkB,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjE,OAAO,EAAwC,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACrF,OAAO,EACQ,MAAM,EAAyC,cAAc,EAAE,4BAA4B,EACzG,MAAM,4BAA4B,CAAC;AAGpC;;;;;GAKG;AACH,qBAAa,qBAAqB;IAGhC,OAAO;WAEO,kBAAkB,IAAI,cAAc,EAAE;IAgBpD,OAAO,CAAC,MAAM,CAAC,uBAAuB;IAUtC,OAAO,CAAC,MAAM,CAAC,oBAAoB;IAOnC,OAAO,CAAC,MAAM,CAAC,cAAc;IAO7B,OAAO,CAAC,MAAM,CAAC,wBAAwB;IAUvC,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAUhC,OAAO,CAAC,MAAM,CAAC,2BAA2B;IAU1C,OAAO,CAAC,MAAM,CAAC,wBAAwB;IAavC,OAAO,CAAC,MAAM,CAAC,qBAAqB;IAWpC,OAAO,CAAC,MAAM,CAAC,8BAA8B;IAuB7C,OAAO,CAAC,MAAM,CAAC,oCAAoC;IAWnD,OAAO,CAAC,MAAM,CAAC,uBAAuB;IAgBtC,OAAO,CAAC,MAAM,CAAC,iCAAiC;IAwBhD,OAAO,CAAC,MAAM,CAAC,kCAAkC;IAyBjD,OAAO,CAAC,MAAM,CAAC,qCAAqC;IAyBpD;;;;;OAKG;WACiB,gBAAgB,CAAC,cAAc,EAAE,4BAA4B,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAgBlJ"}

package/lib/cjs/presentation-backend/SelectionScopesHelper.js

@@ -0,0 +1,257 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Core
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SelectionScopesHelper = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_backend_1 = require("@itwin/core-backend");
+const presentation_common_1 = require("@itwin/presentation-common");
+const Utils_1 = require("./Utils");
+/**
+ * Contains helper methods for computing selection scopes. Will get removed
+ * once rules-driven scopes are implemented.
+ *
+ * @internal
+ */
+class SelectionScopesHelper {
+    // istanbul ignore next
+    constructor() { }
+    static getSelectionScopes() {
+        const createSelectionScope = (scopeId, label, description) => ({
+            id: scopeId,
+            label,
+            description,
+        });
+        return [
+            createSelectionScope("element", "Element", "Select the picked element"),
+            createSelectionScope("assembly", "Assembly", "Select parent of the picked element"),
+            createSelectionScope("top-assembly", "Top Assembly", "Select the topmost parent of the picked element"),
+            // WIP: temporarily comment-out "category" and "model" scopes since we can't hilite contents of them fast enough
+            // createSelectionScope("category", "Category", "Select all elements in the picked element's category"),
+            // createSelectionScope("model", "Model", "Select all elements in the picked element's model"),
+        ];
+    }
+    static computeElementSelection(requestOptions, ids) {
+        const keys = new presentation_common_1.KeySet();
+        ids.forEach(skipTransients((id) => {
+            const key = (0, Utils_1.getElementKey)(requestOptions.imodel, id);
+            if (key)
+                keys.add(key);
+        }));
+        return keys;
+    }
+    static getParentInstanceKey(imodel, id) {
+        const elementProps = imodel.elements.tryGetElementProps(id);
+        if (!(elementProps === null || elementProps === void 0 ? void 0 : elementProps.parent))
+            return undefined;
+        return (0, Utils_1.getElementKey)(imodel, elementProps.parent.id);
+    }
+    static getAssemblyKey(imodel, id) {
+        const parentKey = this.getParentInstanceKey(imodel, id);
+        if (parentKey)
+            return parentKey;
+        return (0, Utils_1.getElementKey)(imodel, id);
+    }
+    static computeAssemblySelection(requestOptions, ids) {
+        const parentKeys = new presentation_common_1.KeySet();
+        ids.forEach(skipTransients((id) => {
+            const key = this.getAssemblyKey(requestOptions.imodel, id);
+            if (key)
+                parentKeys.add(key);
+        }));
+        return parentKeys;
+    }
+    static getTopAssemblyKey(imodel, id) {
+        let currKey;
+        let parentKey = this.getParentInstanceKey(imodel, id);
+        while (parentKey) {
+            currKey = parentKey;
+            parentKey = this.getParentInstanceKey(imodel, currKey.id);
+        }
+        return currKey !== null && currKey !== void 0 ? currKey : (0, Utils_1.getElementKey)(imodel, id);
+    }
+    static computeTopAssemblySelection(requestOptions, ids) {
+        const parentKeys = new presentation_common_1.KeySet();
+        ids.forEach(skipTransients((id) => {
+            const key = this.getTopAssemblyKey(requestOptions.imodel, id);
+            if (key)
+                parentKeys.add(key);
+        }));
+        return parentKeys;
+    }
+    static computeCategorySelection(requestOptions, ids) {
+        const categoryKeys = new presentation_common_1.KeySet();
+        ids.forEach(skipTransients((id) => {
+            const el = requestOptions.imodel.elements.tryGetElement(id);
+            if (el instanceof core_backend_1.GeometricElement) {
+                const category = requestOptions.imodel.elements.tryGetElementProps(el.category);
+                if (category)
+                    categoryKeys.add({ className: category.classFullName, id: category.id });
+            }
+        }));
+        return categoryKeys;
+    }
+    static computeModelSelection(requestOptions, ids) {
+        const modelKeys = new presentation_common_1.KeySet();
+        ids.forEach(skipTransients((id) => {
+            const el = requestOptions.imodel.elements.tryGetElementProps(id);
+            const model = el ? requestOptions.imodel.models.tryGetModelProps(el.model) : undefined;
+            if (model)
+                modelKeys.add({ className: model.classFullName, id: model.id });
+        }));
+        return modelKeys;
+    }
+    static getRelatedFunctionalElementKey(imodel, graphicalElementId) {
+        const query = `
+      SELECT funcSchemaDef.Name || '.' || funcClassDef.Name funcElClassName, fe.ECInstanceId funcElId
+        FROM bis.Element e
+        LEFT JOIN func.PhysicalElementFulfillsFunction rel1 ON rel1.SourceECInstanceId = e.ECInstanceId
+        LEFT JOIN func.DrawingGraphicRepresentsFunctionalElement rel2 ON rel2.SourceECInstanceId = e.ECInstanceId
+        LEFT JOIN func.FunctionalElement fe ON fe.ECInstanceId IN (rel1.TargetECInstanceId, rel2.TargetECInstanceId)
+        INNER JOIN meta.ECClassDef funcClassDef ON funcClassDef.ECInstanceId = fe.ECClassId
+        INNER JOIN meta.ECSchemaDef funcSchemaDef ON funcSchemaDef.ECInstanceId = funcClassDef.Schema.Id
+       WHERE e.ECInstanceId = ?
+      `;
+        return imodel.withPreparedStatement(query, (stmt) => {
+            stmt.bindId(1, graphicalElementId);
+            // istanbul ignore else
+            if (core_bentley_1.DbResult.BE_SQLITE_ROW === stmt.step()) {
+                const row = stmt.getRow();
+                if (row.funcElClassName && row.funcElId)
+                    return { className: row.funcElClassName.replace(".", ":"), id: row.funcElId };
+            }
+            return undefined;
+        });
+    }
+    static findFirstRelatedFunctionalElementKey(imodel, graphicalElementId) {
+        var _a;
+        let currId = graphicalElementId;
+        while (currId) {
+            const relatedFunctionalKey = this.getRelatedFunctionalElementKey(imodel, currId);
+            if (relatedFunctionalKey)
+                return relatedFunctionalKey;
+            currId = (_a = this.getParentInstanceKey(imodel, currId)) === null || _a === void 0 ? void 0 : _a.id;
+        }
+        return undefined;
+    }
+    static elementClassDerivesFrom(imodel, elementId, baseClassFullName) {
+        const query = `
+      SELECT 1
+        FROM bis.Element e
+        INNER JOIN meta.ClassHasAllBaseClasses baseClassRels ON baseClassRels.SourceECInstanceId = e.ECClassId
+        INNER JOIN meta.ECClassDef baseClass ON baseClass.ECInstanceId = baseClassRels.TargetECInstanceId
+        INNER JOIN meta.ECSchemaDef baseSchema ON baseSchema.ECInstanceId = baseClass.Schema.Id
+       WHERE e.ECInstanceId = ? AND (baseSchema.Name || ':' || baseClass.Name) = ?
+      `;
+        return imodel.withPreparedStatement(query, (stmt) => {
+            stmt.bindId(1, elementId);
+            stmt.bindString(2, baseClassFullName);
+            return (core_bentley_1.DbResult.BE_SQLITE_ROW === stmt.step());
+        });
+    }
+    static computeFunctionalElementSelection(requestOptions, ids) {
+        const keys = new presentation_common_1.KeySet();
+        ids.forEach(skipTransients((id) => {
+            const is3d = this.elementClassDerivesFrom(requestOptions.imodel, id, core_backend_1.GeometricElement3d.classFullName);
+            if (!is3d) {
+                // if the input is not a 3d element, we try to find the first related functional element
+                const firstFunctionalKey = this.findFirstRelatedFunctionalElementKey(requestOptions.imodel, id);
+                if (firstFunctionalKey) {
+                    keys.add(firstFunctionalKey);
+                    return;
+                }
+            }
+            let keyToAdd;
+            if (is3d) {
+                // if we're computing scope for a 3d element, try to switch to its related functional element
+                keyToAdd = this.getRelatedFunctionalElementKey(requestOptions.imodel, id);
+            }
+            if (!keyToAdd)
+                keyToAdd = (0, Utils_1.getElementKey)(requestOptions.imodel, id);
+            keyToAdd && keys.add(keyToAdd);
+        }));
+        return keys;
+    }
+    static computeFunctionalAssemblySelection(requestOptions, ids) {
+        const keys = new presentation_common_1.KeySet();
+        ids.forEach(skipTransients((id) => {
+            let idToGetAssemblyFor = id;
+            const is3d = this.elementClassDerivesFrom(requestOptions.imodel, id, core_backend_1.GeometricElement3d.classFullName);
+            if (!is3d) {
+                // if the input is not a 3d element, we try to find the first related functional element
+                const firstFunctionalKey = this.findFirstRelatedFunctionalElementKey(requestOptions.imodel, id);
+                if (firstFunctionalKey)
+                    idToGetAssemblyFor = firstFunctionalKey.id;
+            }
+            // find the assembly of either the given element or the functional element
+            const assemblyKey = this.getAssemblyKey(requestOptions.imodel, idToGetAssemblyFor);
+            let keyToAdd = assemblyKey;
+            if (is3d && keyToAdd) {
+                // if we're computing scope for a 3d element, try to switch to its related functional element
+                const relatedFunctionalKey = this.getRelatedFunctionalElementKey(requestOptions.imodel, keyToAdd.id);
+                if (relatedFunctionalKey)
+                    keyToAdd = relatedFunctionalKey;
+            }
+            keyToAdd && keys.add(keyToAdd);
+        }));
+        return keys;
+    }
+    static computeFunctionalTopAssemblySelection(requestOptions, ids) {
+        const keys = new presentation_common_1.KeySet();
+        ids.forEach(skipTransients((id) => {
+            let idToGetAssemblyFor = id;
+            const is3d = this.elementClassDerivesFrom(requestOptions.imodel, id, core_backend_1.GeometricElement3d.classFullName);
+            if (!is3d) {
+                // if the input is not a 3d element, we try to find the first related functional element
+                const firstFunctionalKey = this.findFirstRelatedFunctionalElementKey(requestOptions.imodel, id);
+                if (firstFunctionalKey)
+                    idToGetAssemblyFor = firstFunctionalKey.id;
+            }
+            // find the top assembly of either the given element or the functional element
+            const topAssemblyKey = this.getTopAssemblyKey(requestOptions.imodel, idToGetAssemblyFor);
+            let keyToAdd = topAssemblyKey;
+            if (is3d && keyToAdd) {
+                // if we're computing scope for a 3d element, try to switch to its related functional element
+                const relatedFunctionalKey = this.getRelatedFunctionalElementKey(requestOptions.imodel, keyToAdd.id);
+                if (relatedFunctionalKey)
+                    keyToAdd = relatedFunctionalKey;
+            }
+            keyToAdd && keys.add(keyToAdd);
+        }));
+        return keys;
+    }
+    /**
+     * Computes selection set based on provided selection scope.
+     * @param requestOptions Options for the request
+     * @param keys Keys of elements to get the content for.
+     * @param scopeId ID of selection scope to use for computing selection
+     */
+    static async computeSelection(requestOptions, ids, scopeId) {
+        switch (scopeId) {
+            case "element": return this.computeElementSelection(requestOptions, ids);
+            case "assembly": return this.computeAssemblySelection(requestOptions, ids);
+            case "top-assembly": return this.computeTopAssemblySelection(requestOptions, ids);
+            case "category": return this.computeCategorySelection(requestOptions, ids);
+            case "model": return this.computeModelSelection(requestOptions, ids);
+            case "functional":
+            case "functional-element":
+                return this.computeFunctionalElementSelection(requestOptions, ids);
+            case "functional-assembly": return this.computeFunctionalAssemblySelection(requestOptions, ids);
+            case "functional-top-assembly": return this.computeFunctionalTopAssemblySelection(requestOptions, ids);
+        }
+        throw new presentation_common_1.PresentationError(presentation_common_1.PresentationStatus.InvalidArgument, "scopeId");
+    }
+}
+exports.SelectionScopesHelper = SelectionScopesHelper;
+const skipTransients = (callback) => {
+    return (id) => {
+        if (!core_bentley_1.Id64.isTransient(id))
+            callback(id);
+    };
+};
+//# sourceMappingURL=SelectionScopesHelper.js.map

package/lib/cjs/presentation-backend/SelectionScopesHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SelectionScopesHelper.js","sourceRoot":"","sources":["../../../src/presentation-backend/SelectionScopesHelper.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAiE;AACjE,sDAAqF;AACrF,oEAEoC;AACpC,mCAAwC;AAExC;;;;;GAKG;AACH,MAAa,qBAAqB;IAEhC,uBAAuB;IACvB,gBAAwB,CAAC;IAElB,MAAM,CAAC,kBAAkB;QAC9B,MAAM,oBAAoB,GAAG,CAAC,OAAe,EAAE,KAAa,EAAE,WAAmB,EAAkB,EAAE,CAAC,CAAC;YACrG,EAAE,EAAE,OAAO;YACX,KAAK;YACL,WAAW;SACZ,CAAC,CAAC;QACH,OAAO;YACL,oBAAoB,CAAC,SAAS,EAAE,SAAS,EAAE,2BAA2B,CAAC;YACvE,oBAAoB,CAAC,UAAU,EAAE,UAAU,EAAE,qCAAqC,CAAC;YACnF,oBAAoB,CAAC,cAAc,EAAE,cAAc,EAAE,iDAAiD,CAAC;YACvG,gHAAgH;YAChH,wGAAwG;YACxG,+FAA+F;SAChG,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,uBAAuB,CAAC,cAAsD,EAAE,GAAiB;QAC9G,MAAM,IAAI,GAAG,IAAI,4BAAM,EAAE,CAAC;QAC1B,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,EAAE,EAAE,EAAE;YAChC,MAAM,GAAG,GAAG,IAAA,qBAAa,EAAC,cAAc,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YACrD,IAAI,GAAG;gBACL,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAClB,CAAC,CAAC,CAAC,CAAC;QACJ,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,MAAM,CAAC,oBAAoB,CAAC,MAAgB,EAAE,EAAc;QAClE,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;QAC5D,IAAI,CAAC,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,MAAM,CAAA;YACvB,OAAO,SAAS,CAAC;QACnB,OAAO,IAAA,qBAAa,EAAC,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACvD,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,MAAgB,EAAE,EAAc;QAC5D,MAAM,SAAS,GAAG,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACxD,IAAI,SAAS;YACX,OAAO,SAAS,CAAC;QACnB,OAAO,IAAA,qBAAa,EAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACnC,CAAC;IAEO,MAAM,CAAC,wBAAwB,CAAC,cAAsD,EAAE,GAAiB;QAC/G,MAAM,UAAU,GAAG,IAAI,4BAAM,EAAE,CAAC;QAChC,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,EAAE,EAAE,EAAE;YAChC,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAC3D,IAAI,GAAG;gBACL,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC,CAAC,CAAC,CAAC;QACJ,OAAO,UAAU,CAAC;IACpB,CAAC;IAEO,MAAM,CAAC,iBAAiB,CAAC,MAAgB,EAAE,EAAc;QAC/D,IAAI,OAAgC,CAAC;QACrC,IAAI,SAAS,GAAG,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACtD,OAAO,SAAS,EAAE;YAChB,OAAO,GAAG,SAAS,CAAC;YACpB,SAAS,GAAG,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC;SAC3D;QACD,OAAO,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAA,qBAAa,EAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC9C,CAAC;IAEO,MAAM,CAAC,2BAA2B,CAAC,cAAsD,EAAE,GAAiB;QAClH,MAAM,UAAU,GAAG,IAAI,4BAAM,EAAE,CAAC;QAChC,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,EAAE,EAAE,EAAE;YAChC,MAAM,GAAG,GAAG,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAC9D,IAAI,GAAG;gBACL,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACxB,CAAC,CAAC,CAAC,CAAC;QACJ,OAAO,UAAU,CAAC;IACpB,CAAC;IAEO,MAAM,CAAC,wBAAwB,CAAC,cAAsD,EAAE,GAAiB;QAC/G,MAAM,YAAY,GAAG,IAAI,4BAAM,EAAE,CAAC;QAClC,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,EAAE,EAAE,EAAE;YAChC,MAAM,EAAE,GAAG,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;YAC5D,IAAI,EAAE,YAAY,+BAAgB,EAAE;gBAClC,MAAM,QAAQ,GAAG,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;gBAChF,IAAI,QAAQ;oBACV,YAAY,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,QAAQ,CAAC,aAAa,EAAE,EAAE,EAAE,QAAQ,CAAC,EAAG,EAAE,CAAC,CAAC;aAC7E;QACH,CAAC,CAAC,CAAC,CAAC;QACJ,OAAO,YAAY,CAAC;IACtB,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,cAAsD,EAAE,GAAiB;QAC5G,MAAM,SAAS,GAAG,IAAI,4BAAM,EAAE,CAAC;QAC/B,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,EAAE,EAAE,EAAE;YAChC,MAAM,EAAE,GAAG,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;YACjE,MAAM,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACvF,IAAI,KAAK;gBACP,SAAS,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,aAAa,EAAE,EAAE,EAAE,KAAK,CAAC,EAAG,EAAE,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC,CAAC;QACJ,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,MAAM,CAAC,8BAA8B,CAAC,MAAgB,EAAE,kBAA8B;QAC5F,MAAM,KAAK,GAAG;;;;;;;;;OASX,CAAC;QACJ,OAAO,MAAM,CAAC,qBAAqB,CAAC,KAAK,EAAE,CAAC,IAAI,EAA2B,EAAE;YAC3E,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,kBAAkB,CAAC,CAAC;YACnC,uBAAuB;YACvB,IAAI,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,EAAE;gBAC1C,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;gBAC1B,IAAI,GAAG,CAAC,eAAe,IAAI,GAAG,CAAC,QAAQ;oBACrC,OAAO,EAAE,SAAS,EAAE,GAAG,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC;aACjF;YACD,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,oCAAoC,CAAC,MAAgB,EAAE,kBAA8B;;QAClG,IAAI,MAAM,GAA2B,kBAAkB,CAAC;QACxD,OAAO,MAAM,EAAE;YACb,MAAM,oBAAoB,GAAG,IAAI,CAAC,8BAA8B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YACjF,IAAI,oBAAoB;gBACtB,OAAO,oBAAoB,CAAC;YAC9B,MAAM,GAAG,MAAA,IAAI,CAAC,oBAAoB,CAAC,MAAM,EAAE,MAAM,CAAC,0CAAE,EAAE,CAAC;SACxD;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,MAAM,CAAC,uBAAuB,CAAC,MAAgB,EAAE,SAAqB,EAAE,iBAAyB;QACvG,MAAM,KAAK,GAAG;;;;;;;OAOX,CAAC;QACJ,OAAO,MAAM,CAAC,qBAAqB,CAAC,KAAK,EAAE,CAAC,IAAI,EAAW,EAAE;YAC3D,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;YAC1B,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC;YACtC,OAAO,CAAC,uBAAQ,CAAC,aAAa,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,iCAAiC,CAAC,cAAsD,EAAE,GAAiB;QACxH,MAAM,IAAI,GAAG,IAAI,4BAAM,EAAE,CAAC;QAC1B,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,EAAE,EAAQ,EAAE;YACtC,MAAM,IAAI,GAAG,IAAI,CAAC,uBAAuB,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE,EAAE,iCAAkB,CAAC,aAAa,CAAC,CAAC;YACvG,IAAI,CAAC,IAAI,EAAE;gBACT,wFAAwF;gBACxF,MAAM,kBAAkB,GAAG,IAAI,CAAC,oCAAoC,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBAChG,IAAI,kBAAkB,EAAE;oBACtB,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;oBAC7B,OAAO;iBACR;aACF;YACD,IAAI,QAAiC,CAAC;YACtC,IAAI,IAAI,EAAE;gBACR,6FAA6F;gBAC7F,QAAQ,GAAG,IAAI,CAAC,8BAA8B,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;aAC3E;YACD,IAAI,CAAC,QAAQ;gBACX,QAAQ,GAAG,IAAA,qBAAa,EAAC,cAAc,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YACtD,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC,CAAC;QACJ,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,MAAM,CAAC,kCAAkC,CAAC,cAAsD,EAAE,GAAiB;QACzH,MAAM,IAAI,GAAG,IAAI,4BAAM,EAAE,CAAC;QAC1B,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,EAAE,EAAQ,EAAE;YACtC,IAAI,kBAAkB,GAAG,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,uBAAuB,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE,EAAE,iCAAkB,CAAC,aAAa,CAAC,CAAC;YACvG,IAAI,CAAC,IAAI,EAAE;gBACT,wFAAwF;gBACxF,MAAM,kBAAkB,GAAG,IAAI,CAAC,oCAAoC,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBAChG,IAAI,kBAAkB;oBACpB,kBAAkB,GAAG,kBAAkB,CAAC,EAAE,CAAC;aAC9C;YACD,0EAA0E;YAC1E,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;YACnF,IAAI,QAAQ,GAAG,WAAW,CAAC;YAC3B,IAAI,IAAI,IAAI,QAAQ,EAAE;gBACpB,6FAA6F;gBAC7F,MAAM,oBAAoB,GAAG,IAAI,CAAC,8BAA8B,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;gBACrG,IAAI,oBAAoB;oBACtB,QAAQ,GAAG,oBAAoB,CAAC;aACnC;YACD,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC,CAAC;QACJ,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,MAAM,CAAC,qCAAqC,CAAC,cAAsD,EAAE,GAAiB;QAC5H,MAAM,IAAI,GAAG,IAAI,4BAAM,EAAE,CAAC;QAC1B,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,EAAE,EAAQ,EAAE;YACtC,IAAI,kBAAkB,GAAG,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,uBAAuB,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE,EAAE,iCAAkB,CAAC,aAAa,CAAC,CAAC;YACvG,IAAI,CAAC,IAAI,EAAE;gBACT,wFAAwF;gBACxF,MAAM,kBAAkB,GAAG,IAAI,CAAC,oCAAoC,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBAChG,IAAI,kBAAkB;oBACpB,kBAAkB,GAAG,kBAAkB,CAAC,EAAE,CAAC;aAC9C;YACD,8EAA8E;YAC9E,MAAM,cAAc,GAAG,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;YACzF,IAAI,QAAQ,GAAG,cAAc,CAAC;YAC9B,IAAI,IAAI,IAAI,QAAQ,EAAE;gBACpB,6FAA6F;gBAC7F,MAAM,oBAAoB,GAAG,IAAI,CAAC,8BAA8B,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;gBACrG,IAAI,oBAAoB;oBACtB,QAAQ,GAAG,oBAAoB,CAAC;aACnC;YACD,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC,CAAC;QACJ,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,cAAsD,EAAE,GAAiB,EAAE,OAAe;QAC7H,QAAQ,OAAO,EAAE;YACf,KAAK,SAAS,CAAC,CAAC,OAAO,IAAI,CAAC,uBAAuB,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;YACzE,KAAK,UAAU,CAAC,CAAC,OAAO,IAAI,CAAC,wBAAwB,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;YAC3E,KAAK,cAAc,CAAC,CAAC,OAAO,IAAI,CAAC,2BAA2B,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;YAClF,KAAK,UAAU,CAAC,CAAC,OAAO,IAAI,CAAC,wBAAwB,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;YAC3E,KAAK,OAAO,CAAC,CAAC,OAAO,IAAI,CAAC,qBAAqB,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;YACrE,KAAK,YAAY,CAAC;YAClB,KAAK,oBAAoB;gBACvB,OAAO,IAAI,CAAC,iCAAiC,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;YACrE,KAAK,qBAAqB,CAAC,CAAC,OAAO,IAAI,CAAC,kCAAkC,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;YAChG,KAAK,yBAAyB,CAAC,CAAC,OAAO,IAAI,CAAC,qCAAqC,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;SACxG;QACD,MAAM,IAAI,uCAAiB,CAAC,wCAAkB,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;IAC7E,CAAC;CAEF;AArPD,sDAqPC;AAED,MAAM,cAAc,GAAG,CAAC,QAAkC,EAAE,EAAE;IAC5D,OAAO,CAAC,EAAc,EAAE,EAAE;QACxB,IAAI,CAAC,mBAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YACvB,QAAQ,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC,CAAC;AACJ,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Core\r\n */\r\n\r\nimport { DbResult, Id64, Id64String } from \"@itwin/core-bentley\";\r\nimport { GeometricElement, GeometricElement3d, IModelDb } from \"@itwin/core-backend\";\r\nimport {\r\n  InstanceKey, KeySet, PresentationError, PresentationStatus, SelectionScope, SelectionScopeRequestOptions,\r\n} from \"@itwin/presentation-common\";\r\nimport { getElementKey } from \"./Utils\";\r\n\r\n/**\r\n * Contains helper methods for computing selection scopes. Will get removed\r\n * once rules-driven scopes are implemented.\r\n *\r\n * @internal\r\n */\r\nexport class SelectionScopesHelper {\r\n\r\n  // istanbul ignore next\r\n  private constructor() { }\r\n\r\n  public static getSelectionScopes(): SelectionScope[] {\r\n    const createSelectionScope = (scopeId: string, label: string, description: string): SelectionScope => ({\r\n      id: scopeId,\r\n      label,\r\n      description,\r\n    });\r\n    return [\r\n      createSelectionScope(\"element\", \"Element\", \"Select the picked element\"),\r\n      createSelectionScope(\"assembly\", \"Assembly\", \"Select parent of the picked element\"),\r\n      createSelectionScope(\"top-assembly\", \"Top Assembly\", \"Select the topmost parent of the picked element\"),\r\n      // WIP: temporarily comment-out \"category\" and \"model\" scopes since we can't hilite contents of them fast enough\r\n      // createSelectionScope(\"category\", \"Category\", \"Select all elements in the picked element's category\"),\r\n      // createSelectionScope(\"model\", \"Model\", \"Select all elements in the picked element's model\"),\r\n    ];\r\n  }\r\n\r\n  private static computeElementSelection(requestOptions: SelectionScopeRequestOptions<IModelDb>, ids: Id64String[]) {\r\n    const keys = new KeySet();\r\n    ids.forEach(skipTransients((id) => {\r\n      const key = getElementKey(requestOptions.imodel, id);\r\n      if (key)\r\n        keys.add(key);\r\n    }));\r\n    return keys;\r\n  }\r\n\r\n  private static getParentInstanceKey(imodel: IModelDb, id: Id64String): InstanceKey | undefined {\r\n    const elementProps = imodel.elements.tryGetElementProps(id);\r\n    if (!elementProps?.parent)\r\n      return undefined;\r\n    return getElementKey(imodel, elementProps.parent.id);\r\n  }\r\n\r\n  private static getAssemblyKey(imodel: IModelDb, id: Id64String) {\r\n    const parentKey = this.getParentInstanceKey(imodel, id);\r\n    if (parentKey)\r\n      return parentKey;\r\n    return getElementKey(imodel, id);\r\n  }\r\n\r\n  private static computeAssemblySelection(requestOptions: SelectionScopeRequestOptions<IModelDb>, ids: Id64String[]) {\r\n    const parentKeys = new KeySet();\r\n    ids.forEach(skipTransients((id) => {\r\n      const key = this.getAssemblyKey(requestOptions.imodel, id);\r\n      if (key)\r\n        parentKeys.add(key);\r\n    }));\r\n    return parentKeys;\r\n  }\r\n\r\n  private static getTopAssemblyKey(imodel: IModelDb, id: Id64String) {\r\n    let currKey: InstanceKey | undefined;\r\n    let parentKey = this.getParentInstanceKey(imodel, id);\r\n    while (parentKey) {\r\n      currKey = parentKey;\r\n      parentKey = this.getParentInstanceKey(imodel, currKey.id);\r\n    }\r\n    return currKey ?? getElementKey(imodel, id);\r\n  }\r\n\r\n  private static computeTopAssemblySelection(requestOptions: SelectionScopeRequestOptions<IModelDb>, ids: Id64String[]) {\r\n    const parentKeys = new KeySet();\r\n    ids.forEach(skipTransients((id) => {\r\n      const key = this.getTopAssemblyKey(requestOptions.imodel, id);\r\n      if (key)\r\n        parentKeys.add(key);\r\n    }));\r\n    return parentKeys;\r\n  }\r\n\r\n  private static computeCategorySelection(requestOptions: SelectionScopeRequestOptions<IModelDb>, ids: Id64String[]) {\r\n    const categoryKeys = new KeySet();\r\n    ids.forEach(skipTransients((id) => {\r\n      const el = requestOptions.imodel.elements.tryGetElement(id);\r\n      if (el instanceof GeometricElement) {\r\n        const category = requestOptions.imodel.elements.tryGetElementProps(el.category);\r\n        if (category)\r\n          categoryKeys.add({ className: category.classFullName, id: category.id! });\r\n      }\r\n    }));\r\n    return categoryKeys;\r\n  }\r\n\r\n  private static computeModelSelection(requestOptions: SelectionScopeRequestOptions<IModelDb>, ids: Id64String[]) {\r\n    const modelKeys = new KeySet();\r\n    ids.forEach(skipTransients((id) => {\r\n      const el = requestOptions.imodel.elements.tryGetElementProps(id);\r\n      const model = el ? requestOptions.imodel.models.tryGetModelProps(el.model) : undefined;\r\n      if (model)\r\n        modelKeys.add({ className: model.classFullName, id: model.id! });\r\n    }));\r\n    return modelKeys;\r\n  }\r\n\r\n  private static getRelatedFunctionalElementKey(imodel: IModelDb, graphicalElementId: Id64String): InstanceKey | undefined {\r\n    const query = `\r\n      SELECT funcSchemaDef.Name || '.' || funcClassDef.Name funcElClassName, fe.ECInstanceId funcElId\r\n        FROM bis.Element e\r\n        LEFT JOIN func.PhysicalElementFulfillsFunction rel1 ON rel1.SourceECInstanceId = e.ECInstanceId\r\n        LEFT JOIN func.DrawingGraphicRepresentsFunctionalElement rel2 ON rel2.SourceECInstanceId = e.ECInstanceId\r\n        LEFT JOIN func.FunctionalElement fe ON fe.ECInstanceId IN (rel1.TargetECInstanceId, rel2.TargetECInstanceId)\r\n        INNER JOIN meta.ECClassDef funcClassDef ON funcClassDef.ECInstanceId = fe.ECClassId\r\n        INNER JOIN meta.ECSchemaDef funcSchemaDef ON funcSchemaDef.ECInstanceId = funcClassDef.Schema.Id\r\n       WHERE e.ECInstanceId = ?\r\n      `;\r\n    return imodel.withPreparedStatement(query, (stmt): InstanceKey | undefined => {\r\n      stmt.bindId(1, graphicalElementId);\r\n      // istanbul ignore else\r\n      if (DbResult.BE_SQLITE_ROW === stmt.step()) {\r\n        const row = stmt.getRow();\r\n        if (row.funcElClassName && row.funcElId)\r\n          return { className: row.funcElClassName.replace(\".\", \":\"), id: row.funcElId };\r\n      }\r\n      return undefined;\r\n    });\r\n  }\r\n\r\n  private static findFirstRelatedFunctionalElementKey(imodel: IModelDb, graphicalElementId: Id64String): InstanceKey | undefined {\r\n    let currId: Id64String | undefined = graphicalElementId;\r\n    while (currId) {\r\n      const relatedFunctionalKey = this.getRelatedFunctionalElementKey(imodel, currId);\r\n      if (relatedFunctionalKey)\r\n        return relatedFunctionalKey;\r\n      currId = this.getParentInstanceKey(imodel, currId)?.id;\r\n    }\r\n    return undefined;\r\n  }\r\n\r\n  private static elementClassDerivesFrom(imodel: IModelDb, elementId: Id64String, baseClassFullName: string): boolean {\r\n    const query = `\r\n      SELECT 1\r\n        FROM bis.Element e\r\n        INNER JOIN meta.ClassHasAllBaseClasses baseClassRels ON baseClassRels.SourceECInstanceId = e.ECClassId\r\n        INNER JOIN meta.ECClassDef baseClass ON baseClass.ECInstanceId = baseClassRels.TargetECInstanceId\r\n        INNER JOIN meta.ECSchemaDef baseSchema ON baseSchema.ECInstanceId = baseClass.Schema.Id\r\n       WHERE e.ECInstanceId = ? AND (baseSchema.Name || ':' || baseClass.Name) = ?\r\n      `;\r\n    return imodel.withPreparedStatement(query, (stmt): boolean => {\r\n      stmt.bindId(1, elementId);\r\n      stmt.bindString(2, baseClassFullName);\r\n      return (DbResult.BE_SQLITE_ROW === stmt.step());\r\n    });\r\n  }\r\n\r\n  private static computeFunctionalElementSelection(requestOptions: SelectionScopeRequestOptions<IModelDb>, ids: Id64String[]) {\r\n    const keys = new KeySet();\r\n    ids.forEach(skipTransients((id): void => {\r\n      const is3d = this.elementClassDerivesFrom(requestOptions.imodel, id, GeometricElement3d.classFullName);\r\n      if (!is3d) {\r\n        // if the input is not a 3d element, we try to find the first related functional element\r\n        const firstFunctionalKey = this.findFirstRelatedFunctionalElementKey(requestOptions.imodel, id);\r\n        if (firstFunctionalKey) {\r\n          keys.add(firstFunctionalKey);\r\n          return;\r\n        }\r\n      }\r\n      let keyToAdd: InstanceKey | undefined;\r\n      if (is3d) {\r\n        // if we're computing scope for a 3d element, try to switch to its related functional element\r\n        keyToAdd = this.getRelatedFunctionalElementKey(requestOptions.imodel, id);\r\n      }\r\n      if (!keyToAdd)\r\n        keyToAdd = getElementKey(requestOptions.imodel, id);\r\n      keyToAdd && keys.add(keyToAdd);\r\n    }));\r\n    return keys;\r\n  }\r\n\r\n  private static computeFunctionalAssemblySelection(requestOptions: SelectionScopeRequestOptions<IModelDb>, ids: Id64String[]) {\r\n    const keys = new KeySet();\r\n    ids.forEach(skipTransients((id): void => {\r\n      let idToGetAssemblyFor = id;\r\n      const is3d = this.elementClassDerivesFrom(requestOptions.imodel, id, GeometricElement3d.classFullName);\r\n      if (!is3d) {\r\n        // if the input is not a 3d element, we try to find the first related functional element\r\n        const firstFunctionalKey = this.findFirstRelatedFunctionalElementKey(requestOptions.imodel, id);\r\n        if (firstFunctionalKey)\r\n          idToGetAssemblyFor = firstFunctionalKey.id;\r\n      }\r\n      // find the assembly of either the given element or the functional element\r\n      const assemblyKey = this.getAssemblyKey(requestOptions.imodel, idToGetAssemblyFor);\r\n      let keyToAdd = assemblyKey;\r\n      if (is3d && keyToAdd) {\r\n        // if we're computing scope for a 3d element, try to switch to its related functional element\r\n        const relatedFunctionalKey = this.getRelatedFunctionalElementKey(requestOptions.imodel, keyToAdd.id);\r\n        if (relatedFunctionalKey)\r\n          keyToAdd = relatedFunctionalKey;\r\n      }\r\n      keyToAdd && keys.add(keyToAdd);\r\n    }));\r\n    return keys;\r\n  }\r\n\r\n  private static computeFunctionalTopAssemblySelection(requestOptions: SelectionScopeRequestOptions<IModelDb>, ids: Id64String[]) {\r\n    const keys = new KeySet();\r\n    ids.forEach(skipTransients((id): void => {\r\n      let idToGetAssemblyFor = id;\r\n      const is3d = this.elementClassDerivesFrom(requestOptions.imodel, id, GeometricElement3d.classFullName);\r\n      if (!is3d) {\r\n        // if the input is not a 3d element, we try to find the first related functional element\r\n        const firstFunctionalKey = this.findFirstRelatedFunctionalElementKey(requestOptions.imodel, id);\r\n        if (firstFunctionalKey)\r\n          idToGetAssemblyFor = firstFunctionalKey.id;\r\n      }\r\n      // find the top assembly of either the given element or the functional element\r\n      const topAssemblyKey = this.getTopAssemblyKey(requestOptions.imodel, idToGetAssemblyFor);\r\n      let keyToAdd = topAssemblyKey;\r\n      if (is3d && keyToAdd) {\r\n        // if we're computing scope for a 3d element, try to switch to its related functional element\r\n        const relatedFunctionalKey = this.getRelatedFunctionalElementKey(requestOptions.imodel, keyToAdd.id);\r\n        if (relatedFunctionalKey)\r\n          keyToAdd = relatedFunctionalKey;\r\n      }\r\n      keyToAdd && keys.add(keyToAdd);\r\n    }));\r\n    return keys;\r\n  }\r\n\r\n  /**\r\n   * Computes selection set based on provided selection scope.\r\n   * @param requestOptions Options for the request\r\n   * @param keys Keys of elements to get the content for.\r\n   * @param scopeId ID of selection scope to use for computing selection\r\n   */\r\n  public static async computeSelection(requestOptions: SelectionScopeRequestOptions<IModelDb>, ids: Id64String[], scopeId: string): Promise<KeySet> {\r\n    switch (scopeId) {\r\n      case \"element\": return this.computeElementSelection(requestOptions, ids);\r\n      case \"assembly\": return this.computeAssemblySelection(requestOptions, ids);\r\n      case \"top-assembly\": return this.computeTopAssemblySelection(requestOptions, ids);\r\n      case \"category\": return this.computeCategorySelection(requestOptions, ids);\r\n      case \"model\": return this.computeModelSelection(requestOptions, ids);\r\n      case \"functional\":\r\n      case \"functional-element\":\r\n        return this.computeFunctionalElementSelection(requestOptions, ids);\r\n      case \"functional-assembly\": return this.computeFunctionalAssemblySelection(requestOptions, ids);\r\n      case \"functional-top-assembly\": return this.computeFunctionalTopAssemblySelection(requestOptions, ids);\r\n    }\r\n    throw new PresentationError(PresentationStatus.InvalidArgument, \"scopeId\");\r\n  }\r\n\r\n}\r\n\r\nconst skipTransients = (callback: (id: Id64String) => void) => {\r\n  return (id: Id64String) => {\r\n    if (!Id64.isTransient(id))\r\n      callback(id);\r\n  };\r\n};\r\n"]}

package/lib/cjs/presentation-backend/TemporaryStorage.d.ts

@@ -0,0 +1,73 @@
+/** @packageDocumentation
+ * @module Core
+ */
+import { IDisposable } from "@itwin/core-bentley";
+/**
+ * Configuration properties for [[TemporaryStorage]].
+ * @internal
+ */
+export interface TemporaryStorageProps<T> {
+    /** A factory method that creates a stored value given it's identifier */
+    factory: (id: string) => T;
+    /** A method that's called for every value before it's removed from storage */
+    cleanupHandler?: (value: T) => void;
+    onCreated?: (id: string) => void;
+    onDisposedSingle?: (id: string) => void;
+    onDisposedAll?: () => void;
+    /**
+     * An interval at which the storage attempts to clean up its values.
+     * When `0` or `undefined` is specified, values are not cleaned up
+     * automatically and cleanup has to be initiated manually by calling
+     * [[TemporaryStorage.disposeOutdatedValues]].
+     */
+    cleanupInterval?: number;
+    /**
+     * Shortest period of time which the value should be kept in storage
+     * unused before it's cleaned up. `0` or `undefined` means values
+     * are removed from the storage on every cleanup (either manual call to
+     * [[TemporaryStorage.disposeOutdatedValues]] or scheduled (controlled
+     * by [[cleanupInterval]]))
+     */
+    valueLifetime?: number;
+}
+/**
+ * Storage for values that get removed from it after being unused (not-requested
+ * for a specified amount of time).
+ *
+ * @internal
+ */
+export declare class TemporaryStorage<T> implements IDisposable {
+    private _values;
+    private _timer?;
+    readonly props: TemporaryStorageProps<T>;
+    /**
+     * Constructor. Creates the storage using supplied params.
+     */
+    constructor(props: TemporaryStorageProps<T>);
+    /**
+     * Destructor. Must be called to clean up the stored values
+     * and other resources
+     */
+    dispose(): void;
+    /**
+     * Cleans up values that are currently outdated (based
+     * on their lifetime specified through [[Props]]).
+     */
+    disposeOutdatedValues: () => void;
+    /**
+     * Get a value from the storage. If the value with the
+     * specified id doesn't exist, it gets created.
+     *
+     * **Note:** requesting a value with this method updates
+     * it's last used time.
+     */
+    getValue(id: string): T;
+    /**
+     * Get all values currently in this storage.
+     *
+     * **Note:** requesting values with this method **doesn't**
+     * update their last used times.
+     */
+    get values(): T[];
+}
+//# sourceMappingURL=TemporaryStorage.d.ts.map

package/lib/cjs/presentation-backend/TemporaryStorage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TemporaryStorage.d.ts","sourceRoot":"","sources":["../../../src/presentation-backend/TemporaryStorage.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAElD;;;GAGG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,yEAAyE;IACzE,OAAO,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,CAAC,CAAC;IAE3B,8EAA8E;IAC9E,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;IAEpC,SAAS,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IACjC,gBAAgB,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IACxC,aAAa,CAAC,EAAE,MAAM,IAAI,CAAC;IAE3B;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAQD;;;;;GAKG;AACH,qBAAa,gBAAgB,CAAC,CAAC,CAAE,YAAW,WAAW;IAErD,OAAO,CAAC,OAAO,CAAiC;IAChD,OAAO,CAAC,MAAM,CAAC,CAAe;IAC9B,SAAgB,KAAK,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAEhD;;OAEG;gBACS,KAAK,EAAE,qBAAqB,CAAC,CAAC,CAAC;IAO3C;;;OAGG;IACI,OAAO;IAad;;;OAGG;IACI,qBAAqB,aAa1B;IAEF;;;;;;OAMG;IACI,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,CAAC;IAa9B;;;;;OAKG;IACH,IAAW,MAAM,IAAI,CAAC,EAAE,CAKvB;CAEF"}