@itwin/presentation-frontend 4.5.0-dev.16 → 4.5.0-dev.17

package/lib/esm/presentation-frontend/RulesetVariablesManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"RulesetVariablesManager.js","sourceRoot":"","sources":["../../../src/presentation-frontend/RulesetVariablesManager.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAc,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC7F,OAAO,EAAkC,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAkFhG,gBAAgB;AAChB,MAAM,OAAO,2BAA2B;IAMtC,YAAmB,SAAiB,EAAE,UAA+B;QAL7D,kBAAa,GAAG,IAAI,GAAG,EAA2B,CAAC;QAGpD,sBAAiB,GAAG,IAAI,OAAO,EAA4G,CAAC;QAGjJ,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAEM,eAAe;QACpB,MAAM,SAAS,GAAsB,EAAE,CAAC;QACxC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,aAAa,EAAE;YACtC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SAC1B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,eAAe,CAAC,QAAyB,EAAE,MAA0B;QAC3E,QAAQ,MAAM,EAAE;YACd,KAAK,kBAAkB,CAAC,IAAI;gBAC1B,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,kBAAkB,CAAC,GAAG;wBACzB,OAAO,CAAC,KAAK,QAAQ,CAAC,KAAK,CAAC;oBAC9B,KAAK,kBAAkB,CAAC,IAAI;wBAC1B,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;oBAC1C;wBACE,OAAO,SAAS,CAAC;iBACpB;YACH,KAAK,kBAAkB,CAAC,GAAG;gBACzB,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,kBAAkB,CAAC,IAAI;wBAC1B,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;oBAChC,KAAK,kBAAkB,CAAC,IAAI;wBAC1B,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;oBAC7C;wBACE,OAAO,SAAS,CAAC;iBACpB;YACH,KAAK,kBAAkB,CAAC,QAAQ;gBAC9B,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,kBAAkB,CAAC,SAAS;wBAC/B,OAAO,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC;oBAC7D;wBACE,OAAO,SAAS,CAAC;iBACpB;YACH,KAAK,kBAAkB,CAAC,IAAI;gBAC1B,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,kBAAkB,CAAC,IAAI;wBAC1B,OAAO,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;oBAClE,KAAK,kBAAkB,CAAC,GAAG;wBACzB,OAAO,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;oBAC1D;wBACE,OAAO,SAAS,CAAC;iBACpB;YACH,KAAK,kBAAkB,CAAC,SAAS;gBAC/B,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,kBAAkB,CAAC,QAAQ;wBAC9B,OAAO,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,wBAAwB,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;oBAC5E;wBACE,OAAO,SAAS,CAAC;iBACpB;YACH,KAAK,kBAAkB,CAAC,MAAM;gBAC5B,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,kBAAkB,CAAC,QAAQ,CAAC;oBACjC,KAAK,kBAAkB,CAAC,SAAS;wBAC/B,OAAO,SAAS,CAAC;oBACnB;wBACE,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;iBAC7B;SACJ;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,IAAwB;QACzD,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC5C,IAAI,CAAC,QAAQ,EAAE;YACb,OAAO,SAAS,CAAC;SAClB;QACD,IAAI,QAAQ,CAAC,IAAI,KAAK,IAAI,EAAE;YAC1B,OAAO,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;SAC7C;QACD,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAEO,KAAK,CAAC,QAAQ,CAAC,QAAyB;QAC9C,MAAM,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACxD,IAAI,WAAW,IAAI,cAAc,CAAC,WAAW,EAAE,QAAQ,CAAC,EAAE;YACxD,OAAO;SACR;QAED,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;QAC9C,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC;SACrF;QAED,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;IACrF,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,UAAkB;QACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACpD,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,OAAO;SACR;QAED,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACvC,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,IAAI,CAAC,WAAW,CAAC,oBAAoB,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,UAAU,EAAE,UAAU,EAAE,CAAC,CAAC;SACzF;QACD,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAC5E,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,SAAS,CAAC,UAAkB;QACvC,OAAQ,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAY,IAAI,EAAE,CAAC;IACxF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAS,CAAC,UAAkB,EAAE,KAAa;QACtD,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,kBAAkB,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO,CAAC,UAAkB;QACrC,OAAQ,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAa,IAAI,KAAK,CAAC;IAC1F,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO,CAAC,UAAkB,EAAE,KAAc;QACrD,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,kBAAkB,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM,CAAC,UAAkB;QACpC,OAAQ,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAY,IAAI,CAAC,CAAC;IACpF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,MAAM,CAAC,UAAkB,EAAE,KAAa;QACnD,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,kBAAkB,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO,CAAC,UAAkB;QACrC,OAAQ,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC,QAAQ,CAAC,CAAc,IAAI,EAAE,CAAC;IAC5F,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO,CAAC,UAAkB,EAAE,KAAe;QACtD,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,kBAAkB,CAAC,QAAQ,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO,CAAC,UAAkB;QACrC,OAAQ,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAgB,IAAI,IAAI,CAAC,OAAO,CAAC;IACpG,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO,CAAC,UAAkB,EAAE,KAAiB;QACxD,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,kBAAkB,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,QAAQ,CAAC,UAAkB;QACtC,OAAQ,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAkB,IAAI,EAAE,CAAC;IACjG,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,QAAQ,CAAC,UAAkB,EAAE,KAAmB;QAC3D,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,kBAAkB,CAAC,SAAS,EAAE,KAAK,EAAE,CAAC,GAAG,mBAAmB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;IAChI,CAAC;CACF;AAED,SAAS,cAAc,CAAC,GAAoB,EAAE,GAAoB;IAChE,IAAI,GAAG,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,EAAE;QACzB,OAAO,KAAK,CAAC;KACd;IAED,QAAQ,GAAG,CAAC,IAAI,EAAE;QAChB,KAAK,kBAAkB,CAAC,QAAQ,CAAC;QACjC,KAAK,kBAAkB,CAAC,SAAS;YAC/B,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC;YAC9B,OAAO,WAAW,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;QAE3C;YACE,OAAO,GAAG,CAAC,KAAK,KAAK,GAAG,CAAC,KAAK,CAAC;KAClC;AACH,CAAC;AAED,SAAS,WAAW,CAAC,GAAU,EAAE,GAAU;IACzC,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC,MAAM,EAAE;QAC7B,OAAO,KAAK,CAAC;KACd;IAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;QACnC,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE;YACrB,OAAO,KAAK,CAAC;SACd;KACF;IACD,OAAO,IAAI,CAAC;AACd,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 { assert, BeEvent, Id64, Id64String, OrderedId64Iterable } from \"@itwin/core-bentley\";\r\nimport { RulesetVariable, VariableValue, VariableValueTypes } from \"@itwin/presentation-common\";\r\nimport { IpcRequestsHandler } from \"./IpcRequestsHandler\";\r\n\r\n/**\r\n * Presentation ruleset variables' registry.\r\n * @public\r\n */\r\nexport interface RulesetVariablesManager {\r\n  /**\r\n   * An event that is raised when variable changes.\r\n   */\r\n  onVariableChanged: BeEvent<(variableId: string, prevValue: VariableValue | undefined, currValue: VariableValue | undefined) => 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): Promise<string>;\r\n  /**\r\n   * Sets `string` variable value\r\n   */\r\n  setString(variableId: string, value: string): Promise<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): Promise<boolean>;\r\n  /**\r\n   * Sets `boolean` variable value\r\n   */\r\n  setBool(variableId: string, value: boolean): Promise<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): Promise<number>;\r\n  /**\r\n   * Sets `number` variable value\r\n   */\r\n  setInt(variableId: string, value: number): Promise<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): Promise<number[]>;\r\n  /**\r\n   * Sets `number[]` variable value\r\n   */\r\n  setInts(variableId: string, value: number[]): Promise<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): Promise<Id64String>;\r\n  /**\r\n   * Sets `Id64String` variable value\r\n   */\r\n  setId64(variableId: string, value: Id64String): Promise<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): Promise<Id64String[]>;\r\n  /**\r\n   * Sets `Id64String[]` variable value\r\n   */\r\n  setId64s(variableId: string, value: Id64String[]): Promise<void>;\r\n\r\n  /** Unsets variable with given id. */\r\n  unset(variableId: string): Promise<void>;\r\n\r\n  /** Retrieves all variables.\r\n   * @internal\r\n   */\r\n  getAllVariables(): RulesetVariable[];\r\n}\r\n\r\n/** @internal */\r\nexport class RulesetVariablesManagerImpl implements RulesetVariablesManager {\r\n  private _clientValues = new Map<string, RulesetVariable>();\r\n  private _rulesetId: string;\r\n  private _ipcHandler?: IpcRequestsHandler;\r\n  public onVariableChanged = new BeEvent<(variableId: string, prevValue: VariableValue | undefined, currValue: VariableValue | undefined) => void>();\r\n\r\n  public constructor(rulesetId: string, ipcHandler?: IpcRequestsHandler) {\r\n    this._rulesetId = rulesetId;\r\n    this._ipcHandler = ipcHandler;\r\n  }\r\n\r\n  public getAllVariables(): RulesetVariable[] {\r\n    const variables: RulesetVariable[] = [];\r\n    for (const entry of this._clientValues) {\r\n      variables.push(entry[1]);\r\n    }\r\n    return variables;\r\n  }\r\n\r\n  private changeValueType(variable: RulesetVariable, toType: VariableValueTypes): VariableValue | undefined {\r\n    switch (toType) {\r\n      case VariableValueTypes.Bool:\r\n        switch (variable.type) {\r\n          case VariableValueTypes.Int:\r\n            return 0 !== variable.value;\r\n          case VariableValueTypes.Id64:\r\n            return Id64.isValidId64(variable.value);\r\n          default:\r\n            return undefined;\r\n        }\r\n      case VariableValueTypes.Int:\r\n        switch (variable.type) {\r\n          case VariableValueTypes.Bool:\r\n            return variable.value ? 1 : 0;\r\n          case VariableValueTypes.Id64:\r\n            return Id64.getUpperUint32(variable.value);\r\n          default:\r\n            return undefined;\r\n        }\r\n      case VariableValueTypes.IntArray:\r\n        switch (variable.type) {\r\n          case VariableValueTypes.Id64Array:\r\n            return variable.value.map((id) => Id64.getUpperUint32(id));\r\n          default:\r\n            return undefined;\r\n        }\r\n      case VariableValueTypes.Id64:\r\n        switch (variable.type) {\r\n          case VariableValueTypes.Bool:\r\n            return Id64.fromLocalAndBriefcaseIds(variable.value ? 1 : 0, 0);\r\n          case VariableValueTypes.Int:\r\n            return Id64.fromLocalAndBriefcaseIds(variable.value, 0);\r\n          default:\r\n            return undefined;\r\n        }\r\n      case VariableValueTypes.Id64Array:\r\n        switch (variable.type) {\r\n          case VariableValueTypes.IntArray:\r\n            return variable.value.map((int) => Id64.fromLocalAndBriefcaseIds(int, 0));\r\n          default:\r\n            return undefined;\r\n        }\r\n      case VariableValueTypes.String:\r\n        switch (variable.type) {\r\n          case VariableValueTypes.IntArray:\r\n          case VariableValueTypes.Id64Array:\r\n            return undefined;\r\n          default:\r\n            variable.value.toString();\r\n        }\r\n    }\r\n    return undefined;\r\n  }\r\n\r\n  private async getValue(id: string, type: VariableValueTypes): Promise<VariableValue | undefined> {\r\n    const variable = this._clientValues.get(id);\r\n    if (!variable) {\r\n      return undefined;\r\n    }\r\n    if (variable.type !== type) {\r\n      return this.changeValueType(variable, type);\r\n    }\r\n    return variable.value;\r\n  }\r\n\r\n  private async setValue(variable: RulesetVariable): Promise<void> {\r\n    const oldVariable = this._clientValues.get(variable.id);\r\n    if (oldVariable && variablesEqual(oldVariable, variable)) {\r\n      return;\r\n    }\r\n\r\n    this._clientValues.set(variable.id, variable);\r\n    if (this._ipcHandler) {\r\n      await this._ipcHandler.setRulesetVariable({ rulesetId: this._rulesetId, variable });\r\n    }\r\n\r\n    this.onVariableChanged.raiseEvent(variable.id, oldVariable?.value, variable.value);\r\n  }\r\n\r\n  public async unset(variableId: string): Promise<void> {\r\n    const variable = this._clientValues.get(variableId);\r\n    if (variable === undefined) {\r\n      return;\r\n    }\r\n\r\n    this._clientValues.delete(variable.id);\r\n    if (this._ipcHandler) {\r\n      await this._ipcHandler.unsetRulesetVariable({ rulesetId: this._rulesetId, variableId });\r\n    }\r\n    this.onVariableChanged.raiseEvent(variable.id, variable.value, undefined);\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 async getString(variableId: string): Promise<string> {\r\n    return ((await this.getValue(variableId, VariableValueTypes.String)) as string) || \"\";\r\n  }\r\n\r\n  /**\r\n   * Sets `string` variable value\r\n   */\r\n  public async setString(variableId: string, value: string): Promise<void> {\r\n    await this.setValue({ id: variableId, type: 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 async getBool(variableId: string): Promise<boolean> {\r\n    return ((await this.getValue(variableId, VariableValueTypes.Bool)) as boolean) || false;\r\n  }\r\n\r\n  /**\r\n   * Sets `boolean` variable value\r\n   */\r\n  public async setBool(variableId: string, value: boolean): Promise<void> {\r\n    await this.setValue({ id: variableId, type: 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 async getInt(variableId: string): Promise<number> {\r\n    return ((await this.getValue(variableId, VariableValueTypes.Int)) as number) || 0;\r\n  }\r\n\r\n  /**\r\n   * Sets `number` variable value\r\n   */\r\n  public async setInt(variableId: string, value: number): Promise<void> {\r\n    await this.setValue({ id: variableId, type: 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 async getInts(variableId: string): Promise<number[]> {\r\n    return ((await this.getValue(variableId, VariableValueTypes.IntArray)) as number[]) || [];\r\n  }\r\n\r\n  /**\r\n   * Sets `number[]` variable value\r\n   */\r\n  public async setInts(variableId: string, value: number[]): Promise<void> {\r\n    await this.setValue({ id: variableId, type: VariableValueTypes.IntArray, value: [...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 async getId64(variableId: string): Promise<Id64String> {\r\n    return ((await this.getValue(variableId, VariableValueTypes.Id64)) as Id64String) || Id64.invalid;\r\n  }\r\n\r\n  /**\r\n   * Sets `Id64String` variable value\r\n   */\r\n  public async setId64(variableId: string, value: Id64String): Promise<void> {\r\n    await this.setValue({ id: variableId, type: 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 async getId64s(variableId: string): Promise<Id64String[]> {\r\n    return ((await this.getValue(variableId, VariableValueTypes.Id64Array)) as Id64String[]) || [];\r\n  }\r\n\r\n  /**\r\n   * Sets `Id64String[]` variable value\r\n   */\r\n  public async setId64s(variableId: string, value: Id64String[]): Promise<void> {\r\n    await this.setValue({ id: variableId, type: VariableValueTypes.Id64Array, value: [...OrderedId64Iterable.sortArray(value)] });\r\n  }\r\n}\r\n\r\nfunction variablesEqual(lhs: RulesetVariable, rhs: RulesetVariable) {\r\n  if (lhs.type !== rhs.type) {\r\n    return false;\r\n  }\r\n\r\n  switch (lhs.type) {\r\n    case VariableValueTypes.IntArray:\r\n    case VariableValueTypes.Id64Array:\r\n      assert(rhs.type === lhs.type);\r\n      return arraysEqual(lhs.value, rhs.value);\r\n\r\n    default:\r\n      return lhs.value === rhs.value;\r\n  }\r\n}\r\n\r\nfunction arraysEqual(lhs: any[], rhs: any[]) {\r\n  if (lhs.length !== rhs.length) {\r\n    return false;\r\n  }\r\n\r\n  for (let i = 0; i < lhs.length; ++i) {\r\n    if (lhs[i] !== rhs[i]) {\r\n      return false;\r\n    }\r\n  }\r\n  return true;\r\n}\r\n"]}
+{"version":3,"file":"RulesetVariablesManager.js","sourceRoot":"","sources":["../../../src/presentation-frontend/RulesetVariablesManager.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAChG;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAc,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC7F,OAAO,EAAkC,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAkFhG,gBAAgB;AAChB,MAAM,OAAO,2BAA2B;IAMtC,YAAmB,SAAiB,EAAE,UAA+B;QAL7D,kBAAa,GAAG,IAAI,GAAG,EAA2B,CAAC;QAGpD,sBAAiB,GAAG,IAAI,OAAO,EAA4G,CAAC;QAGjJ,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAEM,eAAe;QACpB,MAAM,SAAS,GAAsB,EAAE,CAAC;QACxC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,aAAa,EAAE;YACtC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SAC1B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,eAAe,CAAC,QAAyB,EAAE,MAA0B;QAC3E,QAAQ,MAAM,EAAE;YACd,KAAK,kBAAkB,CAAC,IAAI;gBAC1B,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,kBAAkB,CAAC,GAAG;wBACzB,OAAO,CAAC,KAAK,QAAQ,CAAC,KAAK,CAAC;oBAC9B,KAAK,kBAAkB,CAAC,IAAI;wBAC1B,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;oBAC1C;wBACE,OAAO,SAAS,CAAC;iBACpB;YACH,KAAK,kBAAkB,CAAC,GAAG;gBACzB,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,kBAAkB,CAAC,IAAI;wBAC1B,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;oBAChC,KAAK,kBAAkB,CAAC,IAAI;wBAC1B,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;oBAC7C;wBACE,OAAO,SAAS,CAAC;iBACpB;YACH,KAAK,kBAAkB,CAAC,QAAQ;gBAC9B,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,kBAAkB,CAAC,SAAS;wBAC/B,OAAO,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC;oBAC7D;wBACE,OAAO,SAAS,CAAC;iBACpB;YACH,KAAK,kBAAkB,CAAC,IAAI;gBAC1B,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,kBAAkB,CAAC,IAAI;wBAC1B,OAAO,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;oBAClE,KAAK,kBAAkB,CAAC,GAAG;wBACzB,OAAO,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;oBAC1D;wBACE,OAAO,SAAS,CAAC;iBACpB;YACH,KAAK,kBAAkB,CAAC,SAAS;gBAC/B,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,kBAAkB,CAAC,QAAQ;wBAC9B,OAAO,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,wBAAwB,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;oBAC5E;wBACE,OAAO,SAAS,CAAC;iBACpB;YACH,KAAK,kBAAkB,CAAC,MAAM;gBAC5B,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,kBAAkB,CAAC,QAAQ,CAAC;oBACjC,KAAK,kBAAkB,CAAC,SAAS;wBAC/B,OAAO,SAAS,CAAC;oBACnB;wBACE,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;iBAC7B;SACJ;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,IAAwB;QACzD,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC5C,IAAI,CAAC,QAAQ,EAAE;YACb,OAAO,SAAS,CAAC;SAClB;QACD,IAAI,QAAQ,CAAC,IAAI,KAAK,IAAI,EAAE;YAC1B,OAAO,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;SAC7C;QACD,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;IAEO,KAAK,CAAC,QAAQ,CAAC,QAAyB;QAC9C,MAAM,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACxD,IAAI,WAAW,IAAI,cAAc,CAAC,WAAW,EAAE,QAAQ,CAAC,EAAE;YACxD,OAAO;SACR;QAED,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;QAC9C,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC;SACrF;QAED,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;IACrF,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,UAAkB;QACnC,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACpD,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,OAAO;SACR;QAED,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACvC,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,IAAI,CAAC,WAAW,CAAC,oBAAoB,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,UAAU,EAAE,UAAU,EAAE,CAAC,CAAC;SACzF;QACD,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAC5E,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,SAAS,CAAC,UAAkB;QACvC,OAAQ,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAY,IAAI,EAAE,CAAC;IACxF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAS,CAAC,UAAkB,EAAE,KAAa;QACtD,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,kBAAkB,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO,CAAC,UAAkB;QACrC,OAAQ,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAa,IAAI,KAAK,CAAC;IAC1F,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO,CAAC,UAAkB,EAAE,KAAc;QACrD,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,kBAAkB,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM,CAAC,UAAkB;QACpC,OAAQ,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAY,IAAI,CAAC,CAAC;IACpF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,MAAM,CAAC,UAAkB,EAAE,KAAa;QACnD,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,kBAAkB,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO,CAAC,UAAkB;QACrC,OAAQ,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC,QAAQ,CAAC,CAAc,IAAI,EAAE,CAAC;IAC5F,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO,CAAC,UAAkB,EAAE,KAAe;QACtD,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,kBAAkB,CAAC,QAAQ,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO,CAAC,UAAkB;QACrC,OAAQ,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAgB,IAAI,IAAI,CAAC,OAAO,CAAC;IACpG,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO,CAAC,UAAkB,EAAE,KAAiB;QACxD,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,kBAAkB,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,QAAQ,CAAC,UAAkB;QACtC,OAAQ,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAkB,IAAI,EAAE,CAAC;IACjG,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,QAAQ,CAAC,UAAkB,EAAE,KAAmB;QAC3D,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,kBAAkB,CAAC,SAAS,EAAE,KAAK,EAAE,CAAC,GAAG,mBAAmB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;IAChI,CAAC;CACF;AAED,SAAS,cAAc,CAAC,GAAoB,EAAE,GAAoB;IAChE,IAAI,GAAG,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,EAAE;QACzB,OAAO,KAAK,CAAC;KACd;IAED,QAAQ,GAAG,CAAC,IAAI,EAAE;QAChB,KAAK,kBAAkB,CAAC,QAAQ,CAAC;QACjC,KAAK,kBAAkB,CAAC,SAAS;YAC/B,MAAM,CAAC,GAAG,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC;YAC9B,OAAO,WAAW,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC;QAE3C;YACE,OAAO,GAAG,CAAC,KAAK,KAAK,GAAG,CAAC,KAAK,CAAC;KAClC;AACH,CAAC;AAED,SAAS,WAAW,CAAC,GAAU,EAAE,GAAU;IACzC,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC,MAAM,EAAE;QAC7B,OAAO,KAAK,CAAC;KACd;IAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;QACnC,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE;YACrB,OAAO,KAAK,CAAC;SACd;KACF;IACD,OAAO,IAAI,CAAC;AACd,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/** @packageDocumentation\n * @module Core\n */\n\nimport { assert, BeEvent, Id64, Id64String, OrderedId64Iterable } from \"@itwin/core-bentley\";\nimport { RulesetVariable, VariableValue, VariableValueTypes } from \"@itwin/presentation-common\";\nimport { IpcRequestsHandler } from \"./IpcRequestsHandler\";\n\n/**\n * Presentation ruleset variables' registry.\n * @public\n */\nexport interface RulesetVariablesManager {\n  /**\n   * An event that is raised when variable changes.\n   */\n  onVariableChanged: BeEvent<(variableId: string, prevValue: VariableValue | undefined, currValue: VariableValue | undefined) => void>;\n\n  /**\n   * Retrieves `string` variable value.\n   * Returns empty string if variable does not exist or does not convert to string.\n   */\n  getString(variableId: string): Promise<string>;\n  /**\n   * Sets `string` variable value\n   */\n  setString(variableId: string, value: string): Promise<void>;\n\n  /**\n   * Retrieves `boolean` variable value.\n   * Returns `false` if variable does not exist or does not convert to boolean.\n   */\n  getBool(variableId: string): Promise<boolean>;\n  /**\n   * Sets `boolean` variable value\n   */\n  setBool(variableId: string, value: boolean): Promise<void>;\n\n  /**\n   * Retrieves `number` variable value.\n   * Returns `0` if variable does not exist or does not convert to integer.\n   */\n  getInt(variableId: string): Promise<number>;\n  /**\n   * Sets `number` variable value\n   */\n  setInt(variableId: string, value: number): Promise<void>;\n\n  /**\n   * Retrieves `number[]` variable value.\n   * Returns empty array if variable does not exist or does not convert to integer array.\n   */\n  getInts(variableId: string): Promise<number[]>;\n  /**\n   * Sets `number[]` variable value\n   */\n  setInts(variableId: string, value: number[]): Promise<void>;\n\n  /**\n   * Retrieves `Id64String` variable value.\n   * Returns invalid Id64String if variable does not exist or does not convert to Id64String.\n   */\n  getId64(variableId: string): Promise<Id64String>;\n  /**\n   * Sets `Id64String` variable value\n   */\n  setId64(variableId: string, value: Id64String): Promise<void>;\n\n  /**\n   * Retrieves `Id64String[]` variable value.\n   * Returns empty array if variable does not exist or does not convert to Id64String array.\n   */\n  getId64s(variableId: string): Promise<Id64String[]>;\n  /**\n   * Sets `Id64String[]` variable value\n   */\n  setId64s(variableId: string, value: Id64String[]): Promise<void>;\n\n  /** Unsets variable with given id. */\n  unset(variableId: string): Promise<void>;\n\n  /** Retrieves all variables.\n   * @internal\n   */\n  getAllVariables(): RulesetVariable[];\n}\n\n/** @internal */\nexport class RulesetVariablesManagerImpl implements RulesetVariablesManager {\n  private _clientValues = new Map<string, RulesetVariable>();\n  private _rulesetId: string;\n  private _ipcHandler?: IpcRequestsHandler;\n  public onVariableChanged = new BeEvent<(variableId: string, prevValue: VariableValue | undefined, currValue: VariableValue | undefined) => void>();\n\n  public constructor(rulesetId: string, ipcHandler?: IpcRequestsHandler) {\n    this._rulesetId = rulesetId;\n    this._ipcHandler = ipcHandler;\n  }\n\n  public getAllVariables(): RulesetVariable[] {\n    const variables: RulesetVariable[] = [];\n    for (const entry of this._clientValues) {\n      variables.push(entry[1]);\n    }\n    return variables;\n  }\n\n  private changeValueType(variable: RulesetVariable, toType: VariableValueTypes): VariableValue | undefined {\n    switch (toType) {\n      case VariableValueTypes.Bool:\n        switch (variable.type) {\n          case VariableValueTypes.Int:\n            return 0 !== variable.value;\n          case VariableValueTypes.Id64:\n            return Id64.isValidId64(variable.value);\n          default:\n            return undefined;\n        }\n      case VariableValueTypes.Int:\n        switch (variable.type) {\n          case VariableValueTypes.Bool:\n            return variable.value ? 1 : 0;\n          case VariableValueTypes.Id64:\n            return Id64.getUpperUint32(variable.value);\n          default:\n            return undefined;\n        }\n      case VariableValueTypes.IntArray:\n        switch (variable.type) {\n          case VariableValueTypes.Id64Array:\n            return variable.value.map((id) => Id64.getUpperUint32(id));\n          default:\n            return undefined;\n        }\n      case VariableValueTypes.Id64:\n        switch (variable.type) {\n          case VariableValueTypes.Bool:\n            return Id64.fromLocalAndBriefcaseIds(variable.value ? 1 : 0, 0);\n          case VariableValueTypes.Int:\n            return Id64.fromLocalAndBriefcaseIds(variable.value, 0);\n          default:\n            return undefined;\n        }\n      case VariableValueTypes.Id64Array:\n        switch (variable.type) {\n          case VariableValueTypes.IntArray:\n            return variable.value.map((int) => Id64.fromLocalAndBriefcaseIds(int, 0));\n          default:\n            return undefined;\n        }\n      case VariableValueTypes.String:\n        switch (variable.type) {\n          case VariableValueTypes.IntArray:\n          case VariableValueTypes.Id64Array:\n            return undefined;\n          default:\n            variable.value.toString();\n        }\n    }\n    return undefined;\n  }\n\n  private async getValue(id: string, type: VariableValueTypes): Promise<VariableValue | undefined> {\n    const variable = this._clientValues.get(id);\n    if (!variable) {\n      return undefined;\n    }\n    if (variable.type !== type) {\n      return this.changeValueType(variable, type);\n    }\n    return variable.value;\n  }\n\n  private async setValue(variable: RulesetVariable): Promise<void> {\n    const oldVariable = this._clientValues.get(variable.id);\n    if (oldVariable && variablesEqual(oldVariable, variable)) {\n      return;\n    }\n\n    this._clientValues.set(variable.id, variable);\n    if (this._ipcHandler) {\n      await this._ipcHandler.setRulesetVariable({ rulesetId: this._rulesetId, variable });\n    }\n\n    this.onVariableChanged.raiseEvent(variable.id, oldVariable?.value, variable.value);\n  }\n\n  public async unset(variableId: string): Promise<void> {\n    const variable = this._clientValues.get(variableId);\n    if (variable === undefined) {\n      return;\n    }\n\n    this._clientValues.delete(variable.id);\n    if (this._ipcHandler) {\n      await this._ipcHandler.unsetRulesetVariable({ rulesetId: this._rulesetId, variableId });\n    }\n    this.onVariableChanged.raiseEvent(variable.id, variable.value, undefined);\n  }\n\n  /**\n   * Retrieves `string` variable value.\n   * Returns empty string if variable does not exist or does not convert to string.\n   */\n  public async getString(variableId: string): Promise<string> {\n    return ((await this.getValue(variableId, VariableValueTypes.String)) as string) || \"\";\n  }\n\n  /**\n   * Sets `string` variable value\n   */\n  public async setString(variableId: string, value: string): Promise<void> {\n    await this.setValue({ id: variableId, type: VariableValueTypes.String, value });\n  }\n\n  /**\n   * Retrieves `boolean` variable value.\n   * Returns `false` if variable does not exist or does not convert to boolean.\n   */\n  public async getBool(variableId: string): Promise<boolean> {\n    return ((await this.getValue(variableId, VariableValueTypes.Bool)) as boolean) || false;\n  }\n\n  /**\n   * Sets `boolean` variable value\n   */\n  public async setBool(variableId: string, value: boolean): Promise<void> {\n    await this.setValue({ id: variableId, type: VariableValueTypes.Bool, value });\n  }\n\n  /**\n   * Retrieves `number` variable value.\n   * Returns `0` if variable does not exist or does not convert to integer.\n   */\n  public async getInt(variableId: string): Promise<number> {\n    return ((await this.getValue(variableId, VariableValueTypes.Int)) as number) || 0;\n  }\n\n  /**\n   * Sets `number` variable value\n   */\n  public async setInt(variableId: string, value: number): Promise<void> {\n    await this.setValue({ id: variableId, type: VariableValueTypes.Int, value });\n  }\n\n  /**\n   * Retrieves `number[]` variable value.\n   * Returns empty array if variable does not exist or does not convert to integer array.\n   */\n  public async getInts(variableId: string): Promise<number[]> {\n    return ((await this.getValue(variableId, VariableValueTypes.IntArray)) as number[]) || [];\n  }\n\n  /**\n   * Sets `number[]` variable value\n   */\n  public async setInts(variableId: string, value: number[]): Promise<void> {\n    await this.setValue({ id: variableId, type: VariableValueTypes.IntArray, value: [...value] });\n  }\n\n  /**\n   * Retrieves `Id64String` variable value.\n   * Returns invalid Id64String if variable does not exist or does not convert to Id64String.\n   */\n  public async getId64(variableId: string): Promise<Id64String> {\n    return ((await this.getValue(variableId, VariableValueTypes.Id64)) as Id64String) || Id64.invalid;\n  }\n\n  /**\n   * Sets `Id64String` variable value\n   */\n  public async setId64(variableId: string, value: Id64String): Promise<void> {\n    await this.setValue({ id: variableId, type: VariableValueTypes.Id64, value });\n  }\n\n  /**\n   * Retrieves `Id64String[]` variable value.\n   * Returns empty array if variable does not exist or does not convert to Id64String array.\n   */\n  public async getId64s(variableId: string): Promise<Id64String[]> {\n    return ((await this.getValue(variableId, VariableValueTypes.Id64Array)) as Id64String[]) || [];\n  }\n\n  /**\n   * Sets `Id64String[]` variable value\n   */\n  public async setId64s(variableId: string, value: Id64String[]): Promise<void> {\n    await this.setValue({ id: variableId, type: VariableValueTypes.Id64Array, value: [...OrderedId64Iterable.sortArray(value)] });\n  }\n}\n\nfunction variablesEqual(lhs: RulesetVariable, rhs: RulesetVariable) {\n  if (lhs.type !== rhs.type) {\n    return false;\n  }\n\n  switch (lhs.type) {\n    case VariableValueTypes.IntArray:\n    case VariableValueTypes.Id64Array:\n      assert(rhs.type === lhs.type);\n      return arraysEqual(lhs.value, rhs.value);\n\n    default:\n      return lhs.value === rhs.value;\n  }\n}\n\nfunction arraysEqual(lhs: any[], rhs: any[]) {\n  if (lhs.length !== rhs.length) {\n    return false;\n  }\n\n  for (let i = 0; i < lhs.length; ++i) {\n    if (lhs[i] !== rhs[i]) {\n      return false;\n    }\n  }\n  return true;\n}\n"]}

package/lib/esm/presentation-frontend/favorite-properties/FavoritePropertiesManager.d.ts

@@ -62,12 +62,14 @@ export declare class FavoritePropertiesManager implements IDisposable {
     private _iTwinProperties;
     private _imodelProperties;
     private _imodelBaseClassesByClass;
+    private _imodelInitializationPromises;
     /** Property order is saved only in iModel scope */
     private _propertiesOrder;
     constructor(props: FavoritePropertiesManagerProps);
     dispose(): void;
     /**
      * Initialize favorite properties for the provided IModelConnection.
+     * @deprecated in 4.5. Initialization is performed automatically by all async methods and only needed for deprecated [[FavoritePropertiesManager.has]] and [[FavoritePropertiesManager.sortFields]].
      */
     initializeConnection: (imodel: IModelConnection) => Promise<void>;
     /**
@@ -75,13 +77,27 @@ export declare class FavoritePropertiesManager implements IDisposable {
      * favorited and adds missing order information for favorited properties.
      */
     private _adjustPropertyOrderInfos;
+    private isInitialized;
+    /**
+     * Checks if [[FavoritePropertiesManager.initializeConnection]] has been called for a given imodel.
+     * Can be removed when [[FavoritePropertiesManager.has]] and [[FavoritePropertiesManager.sortFields]] are removed.
+     */
     private validateInitialization;
+    /**
+     * Calls [[FavoritePropertiesManager.initializeConnection]] and caches the promise which should be awaited by calling [[FavoritePropertiesManager.ensureInitialized]].
+     * @internal
+     */
+    startConnectionInitialization(imodel: IModelConnection): void;
+    /**
+     * Performs the initialization process or finishes the one that was started by [[FavoritePropertiesManager.startConnectionInitialization]].
+     * @internal
+     */
+    ensureInitialized(imodel: IModelConnection): Promise<void>;
     /**
      * Adds favorite properties into a certain scope.
      * @param field Field that contains properties. If field contains multiple properties, all of them will be favorited.
      * @param imodel IModelConnection.
      * @param scope FavoritePropertiesScope to put the favorite properties into.
-     * @note `initializeConnection` must be called with the `imodel` before calling this function.
      */
     add(field: Field, imodel: IModelConnection, scope: FavoritePropertiesScope): Promise<void>;
     /**
@@ -89,14 +105,12 @@ export declare class FavoritePropertiesManager implements IDisposable {
      * @param field Field that contains properties. If field contains multiple properties, all of them will be un-favorited.
      * @param imodel IModelConnection.
      * @param scope FavoritePropertiesScope to remove the favorite properties from. It also removes from more general scopes.
-     * @note `initializeConnection` must be called with the `imodel` before calling this function.
      */
     remove(field: Field, imodel: IModelConnection, scope: FavoritePropertiesScope): Promise<void>;
     /**
      * Removes all favorite properties from a certain scope.
      * @param imodel IModelConnection.
      * @param scope FavoritePropertiesScope to remove the favorite properties from.
-     * @note `initializeConnection` must be called with the `imodel` before calling this function.
      */
     clear(imodel: IModelConnection, scope: FavoritePropertiesScope): Promise<void>;
     /**
@@ -105,16 +119,32 @@ export declare class FavoritePropertiesManager implements IDisposable {
      * @param imodel IModelConnection.
      * @param scope FavoritePropertiesScope to check for favorite properties. It also checks the more general scopes.
      * @note `initializeConnection` must be called with the `imodel` before calling this function.
+     * @deprecated in 4.5. Use [[FavoritePropertiesManager.hasAsync]] instead. This method is not async, therefore it requires early initialization by calling [[FavoritePropertiesManager.initializeConnection]].
      */
     has(field: Field, imodel: IModelConnection, scope: FavoritePropertiesScope): boolean;
+    /**
+     * Check if field contains at least one favorite property.
+     * @param field Field that contains properties.
+     * @param imodel IModelConnection.
+     * @param scope FavoritePropertiesScope to check for favorite properties. It also checks the more general scopes.
+     */
+    hasAsync(field: Field, imodel: IModelConnection, scope: FavoritePropertiesScope): Promise<boolean>;
     /**
      * Sorts an array of fields with respect to favorite property order.
      * Non-favorited fields get sorted by their default priority and always have lower priority than favorited fields.
      * @param imodel IModelConnection.
      * @param fields Array of Field's that needs to be sorted.
      * @note `initializeConnection` must be called with the `imodel` before calling this function.
+     * @deprecated in 4.5. Use [[FavoritePropertiesManager.sortFieldsAsync]] instead. This method is not async, therefore it requires early initialization by calling [[FavoritePropertiesManager.initializeConnection]].
      */
     sortFields: (imodel: IModelConnection, fields: Field[]) => Field[];
+    /**
+     * Sorts an array of fields with respect to favorite property order.
+     * Non-favorited fields get sorted by their default priority and always have lower priority than favorited fields.
+     * @param imodel IModelConnection.
+     * @param fields Array of Field's that needs to be sorted.
+     */
+    sortFieldsAsync(imodel: IModelConnection, fields: Field[]): Promise<Field[]>;
     private getFieldPriority;
     private _getBaseClassesByClass;
     /** Changes field properties priorities to lower than another fields priority
@@ -122,7 +152,6 @@ export declare class FavoritePropertiesManager implements IDisposable {
      * @param field Field that priority is being changed.
      * @param afterField Field that goes before the moved field. If undefined the moving field is changed to the highest priority (to the top).
      * @param visibleFields Array of fields to move the field in.
-     * @note `initializeConnection` must be called with the `imodel` before calling this function.
      */
     changeFieldPriority(imodel: IModelConnection, field: Field, afterField: Field | undefined, visibleFields: Field[]): Promise<void>;
 }

package/lib/esm/presentation-frontend/favorite-properties/FavoritePropertiesManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FavoritePropertiesManager.d.ts","sourceRoot":"","sources":["../../../../src/presentation-frontend/favorite-properties/FavoritePropertiesManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,WAAW,EAAiB,MAAM,qBAAqB,CAAC;AAE1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAW,KAAK,EAAuC,MAAM,4BAA4B,CAAC;AACjG,OAAO,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAC;AAEzE;;;GAGG;AACH,oBAAY,uBAAuB;IACjC,MAAM,IAAA;IACN,KAAK,IAAA;IACL,MAAM,IAAA;CACP;AAED;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEtC;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,IAAI,EAAE,gBAAgB,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,EAAE,IAAI,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,OAAO,EAAE,0BAA0B,CAAC;CACrC;AAED;;;;;GAKG;AACH,qBAAa,yBAA0B,YAAW,WAAW;IAC3D;;;OAGG;IACH,OAAc,2BAA2B,SAAM;IAE/C,2DAA2D;IACpD,kBAAkB,gBAAqB,IAAI,EAAI;IAEtD,OAAO,CAAC,QAAQ,CAA6B;IAC7C,OAAO,CAAC,iBAAiB,CAAoC;IAC7D,OAAO,CAAC,gBAAgB,CAAqC;IAC7D,OAAO,CAAC,iBAAiB,CAAqC;IAC9D,OAAO,CAAC,yBAAyB,CAAiD;IAElF,mDAAmD;IACnD,OAAO,CAAC,gBAAgB,CAA6C;gBAElD,KAAK,EAAE,8BAA8B;IAQjD,OAAO;IAOd;;OAEG;IACI,oBAAoB,WAAkB,gBAAgB,mBAoB3D;IAEF;;;OAGG;IACH,OAAO,CAAC,yBAAyB,CA4B/B;IAEF,OAAO,CAAC,sBAAsB;IAU9B;;;;;;OAMG;IACU,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAqCvG;;;;;;OAMG;IACU,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IA8C1G;;;;;OAKG;IACU,KAAK,CAAC,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAiC3F;;;;;;OAMG;IACI,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,uBAAuB,GAAG,OAAO;IAa3F;;;;;;OAMG;IACI,UAAU,WAAY,gBAAgB,UAAU,KAAK,EAAE,KAAG,KAAK,EAAE,CAuBtE;IAEF,OAAO,CAAC,gBAAgB;IAUxB,OAAO,CAAC,sBAAsB,CAuC5B;IAEF;;;;;;OAMG;IACU,mBAAmB,CAAC,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,GAAG,SAAS,EAAE,aAAa,EAAE,KAAK,EAAE;CAgI/H;AAuDD,gBAAgB;AAChB,eAAO,MAAM,aAAa,UAAW,KAAK,KAAG,IAAI,gBAAgB,CAUhE,CAAC;AAiCF,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,UAAW,KAAK,KAAG,2BAA2B,EA4B/E,CAAC"}
+{"version":3,"file":"FavoritePropertiesManager.d.ts","sourceRoot":"","sources":["../../../../src/presentation-frontend/favorite-properties/FavoritePropertiesManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,WAAW,EAAiB,MAAM,qBAAqB,CAAC;AAE1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAW,KAAK,EAAuC,MAAM,4BAA4B,CAAC;AACjG,OAAO,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAC;AAEzE;;;GAGG;AACH,oBAAY,uBAAuB;IACjC,MAAM,IAAA;IACN,KAAK,IAAA;IACL,MAAM,IAAA;CACP;AAED;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEtC;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,IAAI,EAAE,gBAAgB,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,EAAE,IAAI,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,OAAO,EAAE,0BAA0B,CAAC;CACrC;AAED;;;;;GAKG;AACH,qBAAa,yBAA0B,YAAW,WAAW;IAC3D;;;OAGG;IACH,OAAc,2BAA2B,SAAM;IAE/C,2DAA2D;IACpD,kBAAkB,gBAAqB,IAAI,EAAI;IAEtD,OAAO,CAAC,QAAQ,CAA6B;IAC7C,OAAO,CAAC,iBAAiB,CAAoC;IAC7D,OAAO,CAAC,gBAAgB,CAAqC;IAC7D,OAAO,CAAC,iBAAiB,CAAqC;IAC9D,OAAO,CAAC,yBAAyB,CAAiD;IAClF,OAAO,CAAC,6BAA6B,CAAuC;IAE5E,mDAAmD;IACnD,OAAO,CAAC,gBAAgB,CAA6C;gBAElD,KAAK,EAAE,8BAA8B;IASjD,OAAO;IAOd;;;OAGG;IACI,oBAAoB,WAAkB,gBAAgB,mBAoB3D;IAEF;;;OAGG;IACH,OAAO,CAAC,yBAAyB,CA4B/B;IAEF,OAAO,CAAC,aAAa;IAMrB;;;OAGG;IACH,OAAO,CAAC,sBAAsB;IAU9B;;;OAGG;IACI,6BAA6B,CAAC,MAAM,EAAE,gBAAgB;IAO7D;;;OAGG;IACU,iBAAiB,CAAC,MAAM,EAAE,gBAAgB;IAoBvD;;;;;OAKG;IACU,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAqCvG;;;;;OAKG;IACU,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IA8C1G;;;;OAIG;IACU,KAAK,CAAC,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAiC3F;;;;;;;OAOG;IACI,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,uBAAuB,GAAG,OAAO;IAa3F;;;;;OAKG;IACU,QAAQ,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,OAAO,CAAC;IAM/G;;;;;;;OAOG;IACI,UAAU,WAAY,gBAAgB,UAAU,KAAK,EAAE,KAAG,KAAK,EAAE,CAuBtE;IAEF;;;;;OAKG;IACU,eAAe,CAAC,MAAM,EAAE,gBAAgB,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAMzF,OAAO,CAAC,gBAAgB;IAUxB,OAAO,CAAC,sBAAsB,CAuC5B;IAEF;;;;;OAKG;IACU,mBAAmB,CAAC,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,GAAG,SAAS,EAAE,aAAa,EAAE,KAAK,EAAE;CAgI/H;AAuDD,gBAAgB;AAChB,eAAO,MAAM,aAAa,UAAW,KAAK,KAAG,IAAI,gBAAgB,CAUhE,CAAC;AAiCF,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,UAAW,KAAK,KAAG,2BAA2B,EA4B/E,CAAC"}

package/lib/esm/presentation-frontend/favorite-properties/FavoritePropertiesManager.js

@@ -29,6 +29,7 @@ class FavoritePropertiesManager {
         this.onFavoritesChanged = new BeEvent();
         /**
          * Initialize favorite properties for the provided IModelConnection.
+         * @deprecated in 4.5. Initialization is performed automatically by all async methods and only needed for deprecated [[FavoritePropertiesManager.has]] and [[FavoritePropertiesManager.sortFields]].
          */
         this.initializeConnection = async (imodel) => {
             const imodelId = imodel.iModelId;
@@ -82,6 +83,7 @@ class FavoritePropertiesManager {
          * @param imodel IModelConnection.
          * @param fields Array of Field's that needs to be sorted.
          * @note `initializeConnection` must be called with the `imodel` before calling this function.
+         * @deprecated in 4.5. Use [[FavoritePropertiesManager.sortFieldsAsync]] instead. This method is not async, therefore it requires early initialization by calling [[FavoritePropertiesManager.initializeConnection]].
          */
         this.sortFields = (imodel, fields) => {
             this.validateInitialization(imodel);
@@ -124,13 +126,13 @@ class FavoritePropertiesManager {
             if (missingClasses.size === 0) {
                 return baseClasses;
             }
-            const query = `
-    SELECT (derivedSchema.Name || ':' || derivedClass.Name) AS "ClassFullName", (baseSchema.Name || ':' || baseClass.Name) AS "BaseClassFullName"
-    FROM ECDbMeta.ClassHasAllBaseClasses baseClassRels
-    INNER JOIN ECDbMeta.ECClassDef derivedClass ON derivedClass.ECInstanceId = baseClassRels.SourceECInstanceId
-    INNER JOIN ECDbMeta.ECSchemaDef derivedSchema ON derivedSchema.ECInstanceId = derivedClass.Schema.Id
-    INNER JOIN ECDbMeta.ECClassDef baseClass ON baseClass.ECInstanceId = baseClassRels.TargetECInstanceId
-    INNER JOIN ECDbMeta.ECSchemaDef baseSchema ON baseSchema.ECInstanceId = baseClass.Schema.Id
+            const query = `
+    SELECT (derivedSchema.Name || ':' || derivedClass.Name) AS "ClassFullName", (baseSchema.Name || ':' || baseClass.Name) AS "BaseClassFullName"
+    FROM ECDbMeta.ClassHasAllBaseClasses baseClassRels
+    INNER JOIN ECDbMeta.ECClassDef derivedClass ON derivedClass.ECInstanceId = baseClassRels.SourceECInstanceId
+    INNER JOIN ECDbMeta.ECSchemaDef derivedSchema ON derivedSchema.ECInstanceId = derivedClass.Schema.Id
+    INNER JOIN ECDbMeta.ECClassDef baseClass ON baseClass.ECInstanceId = baseClassRels.TargetECInstanceId
+    INNER JOIN ECDbMeta.ECSchemaDef baseSchema ON baseSchema.ECInstanceId = baseClass.Schema.Id
     WHERE (derivedSchema.Name || ':' || derivedClass.Name) IN (${[...missingClasses].map((className) => `'${className}'`).join(",")})`;
             const reader = imodel.createQueryReader(query, undefined, { rowFormat: QueryRowFormat.UseJsPropertyNames });
             while (await reader.step()) {
@@ -147,6 +149,7 @@ class FavoritePropertiesManager {
         this._imodelProperties = new Map();
         this._propertiesOrder = new Map();
         this._imodelBaseClassesByClass = new Map();
+        this._imodelInitializationPromises = new Map();
     }
     dispose() {
         // istanbul ignore else
@@ -154,22 +157,59 @@ class FavoritePropertiesManager {
             this._storage.dispose();
         }
     }
+    isInitialized(imodel) {
+        const iTwinId = imodel.iTwinId;
+        const imodelId = imodel.iModelId;
+        return this._imodelProperties.has(getiModelInfo(iTwinId, imodelId));
+    }
+    /**
+     * Checks if [[FavoritePropertiesManager.initializeConnection]] has been called for a given imodel.
+     * Can be removed when [[FavoritePropertiesManager.has]] and [[FavoritePropertiesManager.sortFields]] are removed.
+     */
     validateInitialization(imodel) {
         const iTwinId = imodel.iTwinId;
         const imodelId = imodel.iModelId;
-        if (!this._imodelProperties.has(getiModelInfo(iTwinId, imodelId))) {
+        if (!this.isInitialized(imodel)) {
             throw Error(`Favorite properties are not initialized for iModel: '${imodelId}', in iTwin: '${iTwinId}'. Call initializeConnection() with an IModelConnection to initialize.`);
         }
     }
+    /**
+     * Calls [[FavoritePropertiesManager.initializeConnection]] and caches the promise which should be awaited by calling [[FavoritePropertiesManager.ensureInitialized]].
+     * @internal
+     */
+    startConnectionInitialization(imodel) {
+        if (!this.isInitialized(imodel) && !this._imodelInitializationPromises.has(imodel)) {
+            // eslint-disable-next-line deprecation/deprecation
+            this._imodelInitializationPromises.set(imodel, this.initializeConnection(imodel));
+        }
+    }
+    /**
+     * Performs the initialization process or finishes the one that was started by [[FavoritePropertiesManager.startConnectionInitialization]].
+     * @internal
+     */
+    async ensureInitialized(imodel) {
+        if (this.isInitialized(imodel)) {
+            return;
+        }
+        let promise = this._imodelInitializationPromises.get(imodel);
+        if (!promise) {
+            // eslint-disable-next-line deprecation/deprecation
+            promise = this.initializeConnection(imodel);
+            // Put the promise in the map to avoid possible multiple initializations from different promises.
+            this._imodelInitializationPromises.set(imodel, promise);
+        }
+        await promise;
+        // Remove this promise from the map, because the next time this method is called, `this.isInitialized` should return true.
+        this._imodelInitializationPromises.delete(imodel);
+    }
     /**
      * Adds favorite properties into a certain scope.
      * @param field Field that contains properties. If field contains multiple properties, all of them will be favorited.
      * @param imodel IModelConnection.
      * @param scope FavoritePropertiesScope to put the favorite properties into.
-     * @note `initializeConnection` must be called with the `imodel` before calling this function.
      */
     async add(field, imodel, scope) {
-        this.validateInitialization(imodel);
+        await this.ensureInitialized(imodel);
         const iTwinId = imodel.iTwinId;
         const imodelId = imodel.iModelId;
         let favoriteProperties;
@@ -205,10 +245,9 @@ class FavoritePropertiesManager {
      * @param field Field that contains properties. If field contains multiple properties, all of them will be un-favorited.
      * @param imodel IModelConnection.
      * @param scope FavoritePropertiesScope to remove the favorite properties from. It also removes from more general scopes.
-     * @note `initializeConnection` must be called with the `imodel` before calling this function.
      */
     async remove(field, imodel, scope) {
-        this.validateInitialization(imodel);
+        await this.ensureInitialized(imodel);
         const iTwinId = imodel.iTwinId;
         const imodelId = imodel.iModelId;
         const fieldInfos = getFieldInfos(field);
@@ -252,10 +291,9 @@ class FavoritePropertiesManager {
      * Removes all favorite properties from a certain scope.
      * @param imodel IModelConnection.
      * @param scope FavoritePropertiesScope to remove the favorite properties from.
-     * @note `initializeConnection` must be called with the `imodel` before calling this function.
      */
     async clear(imodel, scope) {
-        this.validateInitialization(imodel);
+        await this.ensureInitialized(imodel);
         const iTwinId = imodel.iTwinId;
         const imodelId = imodel.iModelId;
         let favoriteProperties;
@@ -289,6 +327,7 @@ class FavoritePropertiesManager {
      * @param imodel IModelConnection.
      * @param scope FavoritePropertiesScope to check for favorite properties. It also checks the more general scopes.
      * @note `initializeConnection` must be called with the `imodel` before calling this function.
+     * @deprecated in 4.5. Use [[FavoritePropertiesManager.hasAsync]] instead. This method is not async, therefore it requires early initialization by calling [[FavoritePropertiesManager.initializeConnection]].
      */
     has(field, imodel, scope) {
         this.validateInitialization(imodel);
@@ -299,6 +338,28 @@ class FavoritePropertiesManager {
             (scope !== FavoritePropertiesScope.Global && setHasAny(this._iTwinProperties.get(iTwinId), fieldInfos)) ||
             (scope === FavoritePropertiesScope.IModel && setHasAny(this._imodelProperties.get(getiModelInfo(iTwinId, imodelId)), fieldInfos)));
     }
+    /**
+     * Check if field contains at least one favorite property.
+     * @param field Field that contains properties.
+     * @param imodel IModelConnection.
+     * @param scope FavoritePropertiesScope to check for favorite properties. It also checks the more general scopes.
+     */
+    async hasAsync(field, imodel, scope) {
+        await this.ensureInitialized(imodel);
+        // eslint-disable-next-line deprecation/deprecation
+        return this.has(field, imodel, scope);
+    }
+    /**
+     * Sorts an array of fields with respect to favorite property order.
+     * Non-favorited fields get sorted by their default priority and always have lower priority than favorited fields.
+     * @param imodel IModelConnection.
+     * @param fields Array of Field's that needs to be sorted.
+     */
+    async sortFieldsAsync(imodel, fields) {
+        await this.ensureInitialized(imodel);
+        // eslint-disable-next-line deprecation/deprecation
+        return this.sortFields(imodel, fields);
+    }
     getFieldPriority(field, iTwinId, imodelId) {
         const orderInfos = this._propertiesOrder.get(getiModelInfo(iTwinId, imodelId));
         const fieldOrderInfos = getFieldOrderInfos(field, orderInfos);
@@ -313,7 +374,6 @@ class FavoritePropertiesManager {
      * @param field Field that priority is being changed.
      * @param afterField Field that goes before the moved field. If undefined the moving field is changed to the highest priority (to the top).
      * @param visibleFields Array of fields to move the field in.
-     * @note `initializeConnection` must be called with the `imodel` before calling this function.
      */
     async changeFieldPriority(imodel, field, afterField, visibleFields) {
         /**
@@ -328,7 +388,7 @@ class FavoritePropertiesManager {
          * 4. Irrelevant orderInfos's get moved after `orderInfo` (depends on the direction)
          * 5. All `field` orderInfo's get moved after `afterOrderInfo`
          */
-        this.validateInitialization(imodel);
+        await this.ensureInitialized(imodel);
         const iTwinId = imodel.iTwinId;
         const imodelId = imodel.iModelId;
         if (field === afterField) {