@itwin/presentation-frontend 4.5.0-dev.9 → 4.5.1

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

@@ -1 +1 @@
-{"version":3,"file":"RulesetVariablesManager.js","sourceRoot":"","sources":["../../../src/presentation-frontend/RulesetVariablesManager.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6F;AAC7F,oEAAgG;AAmFhG,gBAAgB;AAChB,MAAa,2BAA2B;IAOtC,YAAmB,SAAiB,EAAE,UAA+B;QAL7D,kBAAa,GAAG,IAAI,GAAG,EAA2B,CAAC;QAGpD,sBAAiB,GAAG,IAAI,sBAAO,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;YACpC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3B,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,eAAe,CAAC,QAAyB,EAAE,MAA0B;QAC3E,QAAQ,MAAM,EAAE;YACd,KAAK,wCAAkB,CAAC,IAAI;gBAC1B,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,wCAAkB,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,QAAQ,CAAC,KAAK,CAAC,CAAC;oBAC3D,KAAK,wCAAkB,CAAC,IAAI,CAAC,CAAC,OAAO,mBAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;oBACtE,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;iBAC3B;YACH,KAAK,wCAAkB,CAAC,GAAG;gBACzB,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,wCAAkB,CAAC,IAAI,CAAC,CAAC,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC5D,KAAK,wCAAkB,CAAC,IAAI,CAAC,CAAC,OAAO,mBAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;oBACzE,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;iBAC3B;YACH,KAAK,wCAAkB,CAAC,QAAQ;gBAC9B,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,wCAAkB,CAAC,SAAS,CAAC,CAAC,OAAO,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,mBAAI,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC;oBAC9F,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;iBAC3B;YACH,KAAK,wCAAkB,CAAC,IAAI;gBAC1B,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,wCAAkB,CAAC,IAAI,CAAC,CAAC,OAAO,mBAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;oBAC9F,KAAK,wCAAkB,CAAC,GAAG,CAAC,CAAC,OAAO,mBAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;oBACrF,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;iBAC3B;YACH,KAAK,wCAAkB,CAAC,SAAS;gBAC/B,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,wCAAkB,CAAC,QAAQ,CAAC,CAAC,OAAO,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,mBAAI,CAAC,wBAAwB,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;oBAC5G,OAAO,CAAC,CAAC,OAAO,SAAS,CAAC;iBAC3B;YACH,KAAK,wCAAkB,CAAC,MAAM;gBAC5B,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,wCAAkB,CAAC,QAAQ,CAAC;oBACjC,KAAK,wCAAkB,CAAC,SAAS;wBAC/B,OAAO,SAAS,CAAC;oBACnB,OAAO,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;iBACpC;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;YACX,OAAO,SAAS,CAAC;QACnB,IAAI,QAAQ,CAAC,IAAI,KAAK,IAAI;YACxB,OAAO,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC9C,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;YACtD,OAAO;QAET,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;YACxB,OAAO;QAET,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,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,wCAAkB,CAAC,MAAM,CAAY,IAAI,EAAE,CAAC;IACtF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,SAAS,CAAC,UAAkB,EAAE,KAAa;QACtD,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,wCAAkB,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO,CAAC,UAAkB;QACrC,OAAQ,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,wCAAkB,CAAC,IAAI,CAAa,IAAI,KAAK,CAAC;IACxF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO,CAAC,UAAkB,EAAE,KAAc;QACrD,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,wCAAkB,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM,CAAC,UAAkB;QACpC,OAAQ,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,wCAAkB,CAAC,GAAG,CAAY,IAAI,CAAC,CAAC;IAClF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,MAAM,CAAC,UAAkB,EAAE,KAAa;QACnD,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,wCAAkB,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO,CAAC,UAAkB;QACrC,OAAQ,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,wCAAkB,CAAC,QAAQ,CAAc,IAAI,EAAE,CAAC;IAC1F,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO,CAAC,UAAkB,EAAE,KAAe;QACtD,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,wCAAkB,CAAC,QAAQ,EAAE,KAAK,EAAE,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO,CAAC,UAAkB;QACrC,OAAQ,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,wCAAkB,CAAC,IAAI,CAAgB,IAAI,mBAAI,CAAC,OAAO,CAAC;IAClG,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO,CAAC,UAAkB,EAAE,KAAiB;QACxD,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,wCAAkB,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,QAAQ,CAAC,UAAkB;QACtC,OAAQ,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,wCAAkB,CAAC,SAAS,CAAkB,IAAI,EAAE,CAAC;IAC/F,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,QAAQ,CAAC,UAAkB,EAAE,KAAmB;QAC3D,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,wCAAkB,CAAC,SAAS,EAAE,KAAK,EAAE,CAAC,GAAG,kCAAmB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;IAChI,CAAC;CACF;AAvLD,kEAuLC;AAED,SAAS,cAAc,CAAC,GAAoB,EAAE,GAAoB;IAChE,IAAI,GAAG,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI;QACvB,OAAO,KAAK,CAAC;IAEf,QAAQ,GAAG,CAAC,IAAI,EAAE;QAChB,KAAK,wCAAkB,CAAC,QAAQ,CAAC;QACjC,KAAK,wCAAkB,CAAC,SAAS;YAC/B,IAAA,qBAAM,EAAC,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;QAC3B,OAAO,KAAK,CAAC;IAEf,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;YACnB,OAAO,KAAK,CAAC;KAChB;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  /**\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\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    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: return (0 !== variable.value);\r\n          case VariableValueTypes.Id64: return Id64.isValidId64(variable.value);\r\n          default: return undefined;\r\n        }\r\n      case VariableValueTypes.Int:\r\n        switch (variable.type) {\r\n          case VariableValueTypes.Bool: return variable.value ? 1 : 0;\r\n          case VariableValueTypes.Id64: return Id64.getUpperUint32(variable.value);\r\n          default: return undefined;\r\n        }\r\n      case VariableValueTypes.IntArray:\r\n        switch (variable.type) {\r\n          case VariableValueTypes.Id64Array: return variable.value.map((id) => Id64.getUpperUint32(id));\r\n          default: return undefined;\r\n        }\r\n      case VariableValueTypes.Id64:\r\n        switch (variable.type) {\r\n          case VariableValueTypes.Bool: return Id64.fromLocalAndBriefcaseIds(variable.value ? 1 : 0, 0);\r\n          case VariableValueTypes.Int: return Id64.fromLocalAndBriefcaseIds(variable.value, 0);\r\n          default: return undefined;\r\n        }\r\n      case VariableValueTypes.Id64Array:\r\n        switch (variable.type) {\r\n          case VariableValueTypes.IntArray: return variable.value.map((int) => Id64.fromLocalAndBriefcaseIds(int, 0));\r\n          default: 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: 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    if (variable.type !== type)\r\n      return this.changeValueType(variable, type);\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    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    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  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  for (let i = 0; i < lhs.length; ++i) {\r\n    if (lhs[i] !== rhs[i])\r\n      return false;\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,sDAA6F;AAC7F,oEAAgG;AAkFhG,gBAAgB;AAChB,MAAa,2BAA2B;IAMtC,YAAmB,SAAiB,EAAE,UAA+B;QAL7D,kBAAa,GAAG,IAAI,GAAG,EAA2B,CAAC;QAGpD,sBAAiB,GAAG,IAAI,sBAAO,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,wCAAkB,CAAC,IAAI;gBAC1B,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,wCAAkB,CAAC,GAAG;wBACzB,OAAO,CAAC,KAAK,QAAQ,CAAC,KAAK,CAAC;oBAC9B,KAAK,wCAAkB,CAAC,IAAI;wBAC1B,OAAO,mBAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;oBAC1C;wBACE,OAAO,SAAS,CAAC;iBACpB;YACH,KAAK,wCAAkB,CAAC,GAAG;gBACzB,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,wCAAkB,CAAC,IAAI;wBAC1B,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;oBAChC,KAAK,wCAAkB,CAAC,IAAI;wBAC1B,OAAO,mBAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;oBAC7C;wBACE,OAAO,SAAS,CAAC;iBACpB;YACH,KAAK,wCAAkB,CAAC,QAAQ;gBAC9B,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,wCAAkB,CAAC,SAAS;wBAC/B,OAAO,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,mBAAI,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,CAAC;oBAC7D;wBACE,OAAO,SAAS,CAAC;iBACpB;YACH,KAAK,wCAAkB,CAAC,IAAI;gBAC1B,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,wCAAkB,CAAC,IAAI;wBAC1B,OAAO,mBAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;oBAClE,KAAK,wCAAkB,CAAC,GAAG;wBACzB,OAAO,mBAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;oBAC1D;wBACE,OAAO,SAAS,CAAC;iBACpB;YACH,KAAK,wCAAkB,CAAC,SAAS;gBAC/B,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,wCAAkB,CAAC,QAAQ;wBAC9B,OAAO,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,mBAAI,CAAC,wBAAwB,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;oBAC5E;wBACE,OAAO,SAAS,CAAC;iBACpB;YACH,KAAK,wCAAkB,CAAC,MAAM;gBAC5B,QAAQ,QAAQ,CAAC,IAAI,EAAE;oBACrB,KAAK,wCAAkB,CAAC,QAAQ,CAAC;oBACjC,KAAK,wCAAkB,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,wCAAkB,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,wCAAkB,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,wCAAkB,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,wCAAkB,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,wCAAkB,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,wCAAkB,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,wCAAkB,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,wCAAkB,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,wCAAkB,CAAC,IAAI,CAAC,CAAgB,IAAI,mBAAI,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,wCAAkB,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,wCAAkB,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,wCAAkB,CAAC,SAAS,EAAE,KAAK,EAAE,CAAC,GAAG,kCAAmB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;IAChI,CAAC;CACF;AAzMD,kEAyMC;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,wCAAkB,CAAC,QAAQ,CAAC;QACjC,KAAK,wCAAkB,CAAC,SAAS;YAC/B,IAAA,qBAAM,EAAC,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/cjs/presentation-frontend/StreamedResponseGenerator.d.ts

@@ -0,0 +1,30 @@
+import { PagedResponse, PageOptions } from "@itwin/presentation-common";
+import { MultipleValuesRequestOptions } from "./PresentationManager";
+/**
+ * Properties for streaming the results.
+ * @internal
+ */
+export type StreamedResponseGeneratorProps<TItem> = MultipleValuesRequestOptions & {
+    getBatch(page: Required<PageOptions>, requestIdx: number): Promise<PagedResponse<TItem>>;
+};
+/**
+ * This class allows loading values in multiple parallel batches and return them either as an array or an async iterator.
+ * Pages are prefetched in advanced according to the `parallelism` argument.
+ * @internal
+ */
+export declare class StreamedResponseGenerator<TPagedResponseItem> {
+    private readonly _props;
+    constructor(_props: StreamedResponseGeneratorProps<TPagedResponseItem>);
+    /** Creates a response with the total item count and an async iterator. */
+    createAsyncIteratorResponse(): Promise<{
+        total: number;
+        items: AsyncIterableIterator<TPagedResponseItem>;
+    }>;
+    /**
+     * Fetches the first page.
+     * This function has to be called in order to retrieve the total items count.
+     */
+    private fetchFirstPage;
+    private getRemainingPages;
+}
+//# sourceMappingURL=StreamedResponseGenerator.d.ts.map

package/lib/cjs/presentation-frontend/StreamedResponseGenerator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StreamedResponseGenerator.d.ts","sourceRoot":"","sources":["../../../src/presentation-frontend/StreamedResponseGenerator.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAExE,OAAO,EAAE,4BAA4B,EAAE,MAAM,uBAAuB,CAAC;AAErE;;;GAGG;AACH,MAAM,MAAM,8BAA8B,CAAC,KAAK,IAAI,4BAA4B,GAAG;IACjF,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,WAAW,CAAC,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;CAC1F,CAAC;AAEF;;;;GAIG;AACH,qBAAa,yBAAyB,CAAC,kBAAkB;IAC3C,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,8BAA8B,CAAC,kBAAkB,CAAC;IAEvF,0EAA0E;IAC7D,2BAA2B,IAAI,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,CAAA;KAAE,CAAC;IAQxH;;;OAGG;YACW,cAAc;IAM5B,OAAO,CAAC,iBAAiB;CA2F1B"}

package/lib/cjs/presentation-frontend/StreamedResponseGenerator.js

@@ -0,0 +1,117 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamedResponseGenerator = void 0;
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+const rxjs_1 = require("rxjs");
+const rxjs_for_await_1 = require("rxjs-for-await");
+const core_bentley_1 = require("@itwin/core-bentley");
+/**
+ * This class allows loading values in multiple parallel batches and return them either as an array or an async iterator.
+ * Pages are prefetched in advanced according to the `parallelism` argument.
+ * @internal
+ */
+class StreamedResponseGenerator {
+    constructor(_props) {
+        this._props = _props;
+    }
+    /** Creates a response with the total item count and an async iterator. */
+    async createAsyncIteratorResponse() {
+        const firstPage = await this.fetchFirstPage();
+        return {
+            total: firstPage.total,
+            items: (0, rxjs_for_await_1.eachValueFrom)(this.getRemainingPages(firstPage).pipe((0, rxjs_1.concatAll)())),
+        };
+    }
+    /**
+     * Fetches the first page.
+     * This function has to be called in order to retrieve the total items count.
+     */
+    async fetchFirstPage() {
+        const start = this._props.paging?.start ?? 0;
+        const batchSize = this._props.paging?.size ?? 0;
+        return this._props.getBatch({ start, size: batchSize }, 0);
+    }
+    getRemainingPages(firstPage) {
+        const pageStart = this._props.paging?.start ?? 0;
+        const maxParallelRequests = this._props.maxParallelRequests;
+        const pageSize = this._props.paging?.size;
+        const { total, items: firstPageItems } = firstPage;
+        // If there are no items, return a single empty page.
+        if (total === 0) {
+            return (0, rxjs_1.of)([]);
+        }
+        // If the response is empty, something went wrong.
+        const receivedItemsLength = firstPage.items.length;
+        if (!receivedItemsLength) {
+            handleEmptyPageResult(pageStart, total);
+        }
+        const totalItemsToFetch = total - pageStart;
+        if (receivedItemsLength === totalItemsToFetch) {
+            return (0, rxjs_1.of)(firstPageItems);
+        }
+        let itemsToFetch;
+        let batchSize;
+        if (pageSize) {
+            itemsToFetch = Math.min(totalItemsToFetch, pageSize) - receivedItemsLength;
+            batchSize = Math.min(pageSize, receivedItemsLength);
+        }
+        else {
+            itemsToFetch = totalItemsToFetch - receivedItemsLength;
+            batchSize = receivedItemsLength;
+        }
+        const remainingBatches = Math.ceil(itemsToFetch / batchSize);
+        // Return the first page and then stream the remaining ones.
+        return (0, rxjs_1.concat)((0, rxjs_1.of)(firstPage.items), (0, rxjs_1.range)(1, remainingBatches).pipe((0, rxjs_1.mergeMap)(async (idx) => {
+            const start = pageStart + idx * batchSize;
+            const size = Math.min(total - start, batchSize);
+            const page = await this._props.getBatch({ start, size }, idx);
+            if (!page.items.length) {
+                handleEmptyPageResult(start, total);
+            }
+            // Pass along the index, so that the items could be sorted.
+            return { idx, items: page.items };
+        }, maxParallelRequests), (0, rxjs_1.scan)(
+        // Collect the emitted pages an emit them in the correct order.
+        (acc, value) => {
+            let { lastEmitted } = acc;
+            const { accumulatedBatches } = acc;
+            const { idx } = value;
+            // If current batch is not in order, put it in the accumulator
+            if (idx - 1 !== lastEmitted) {
+                accumulatedBatches.insert(value);
+                return { lastEmitted, accumulatedBatches, itemsToEmit: [] };
+            }
+            // Collect all batches to emit in order.
+            lastEmitted = idx;
+            const batchesToEmit = [value];
+            for (const batch of accumulatedBatches) {
+                if (batch.idx - 1 !== lastEmitted) {
+                    break;
+                }
+                lastEmitted = batch.idx;
+                batchesToEmit.push(batch);
+            }
+            // Remove batches to emit from the accumulator.
+            for (const batch of batchesToEmit) {
+                accumulatedBatches.remove(batch);
+            }
+            const itemsToEmit = batchesToEmit.flatMap((x) => x.items);
+            return { lastEmitted, accumulatedBatches, itemsToEmit };
+        }, {
+            lastEmitted: 0,
+            accumulatedBatches: new core_bentley_1.SortedArray((a, b) => a.idx - b.idx),
+            itemsToEmit: new Array(),
+        }), (0, rxjs_1.map)(({ itemsToEmit }) => itemsToEmit)));
+    }
+}
+exports.StreamedResponseGenerator = StreamedResponseGenerator;
+function handleEmptyPageResult(pageStart, total) {
+    if (pageStart >= total) {
+        throw new Error(`Requested page with start index ${pageStart} is out of bounds. Total number of items: ${total}`);
+    }
+    throw new Error("Paged request returned non zero total count but no items");
+}
+//# sourceMappingURL=StreamedResponseGenerator.js.map

package/lib/cjs/presentation-frontend/StreamedResponseGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StreamedResponseGenerator.js","sourceRoot":"","sources":["../../../src/presentation-frontend/StreamedResponseGenerator.ts"],"names":[],"mappings":";;;AAAA;;;gGAGgG;AAChG,+BAAqF;AACrF,mDAA+C;AAE/C,sDAAkD;AAWlD;;;;GAIG;AACH,MAAa,yBAAyB;IACpC,YAA6B,MAA0D;QAA1D,WAAM,GAAN,MAAM,CAAoD;IAAG,CAAC;IAE3F,0EAA0E;IACnE,KAAK,CAAC,2BAA2B;QACtC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC9C,OAAO;YACL,KAAK,EAAE,SAAS,CAAC,KAAK;YACtB,KAAK,EAAE,IAAA,8BAAa,EAAC,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAA,gBAAS,GAAE,CAAC,CAAC;SAC1E,CAAC;IACJ,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,cAAc;QAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,CAAC;QAC7C,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC;IAC7D,CAAC;IAEO,iBAAiB,CAAC,SAA4C;QACpE,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,CAAC;QACjD,MAAM,mBAAmB,GAAG,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC;QAC5D,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC;QAC1C,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,cAAc,EAAE,GAAG,SAAS,CAAC;QAEnD,qDAAqD;QACrD,IAAI,KAAK,KAAK,CAAC,EAAE;YACf,OAAO,IAAA,SAAE,EAAC,EAAE,CAAC,CAAC;SACf;QAED,kDAAkD;QAClD,MAAM,mBAAmB,GAAG,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC;QACnD,IAAI,CAAC,mBAAmB,EAAE;YACxB,qBAAqB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;SACzC;QAED,MAAM,iBAAiB,GAAG,KAAK,GAAG,SAAS,CAAC;QAC5C,IAAI,mBAAmB,KAAK,iBAAiB,EAAE;YAC7C,OAAO,IAAA,SAAE,EAAC,cAAc,CAAC,CAAC;SAC3B;QAED,IAAI,YAAoB,CAAC;QACzB,IAAI,SAAiB,CAAC;QACtB,IAAI,QAAQ,EAAE;YACZ,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE,QAAQ,CAAC,GAAG,mBAAmB,CAAC;YAC3E,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAAC;SACrD;aAAM;YACL,YAAY,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;YACvD,SAAS,GAAG,mBAAmB,CAAC;SACjC;QAED,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC;QAE7D,4DAA4D;QAC5D,OAAO,IAAA,aAAM,EACX,IAAA,SAAE,EAAC,SAAS,CAAC,KAAK,CAAC,EACnB,IAAA,YAAK,EAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC,IAAI,CAC7B,IAAA,eAAQ,EAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YACrB,MAAM,KAAK,GAAG,SAAS,GAAG,GAAG,GAAG,SAAS,CAAC;YAC1C,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,KAAK,EAAE,SAAS,CAAC,CAAC;YAChD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,GAAG,CAAC,CAAC;YAC9D,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;gBACtB,qBAAqB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;aACrC;YAED,2DAA2D;YAC3D,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;QACpC,CAAC,EAAE,mBAAmB,CAAC,EACvB,IAAA,WAAI;QACF,+DAA+D;QAC/D,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YACb,IAAI,EAAE,WAAW,EAAE,GAAG,GAAG,CAAC;YAC1B,MAAM,EAAE,kBAAkB,EAAE,GAAG,GAAG,CAAC;YACnC,MAAM,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC;YAEtB,8DAA8D;YAC9D,IAAI,GAAG,GAAG,CAAC,KAAK,WAAW,EAAE;gBAC3B,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACjC,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC;aAC7D;YAED,wCAAwC;YACxC,WAAW,GAAG,GAAG,CAAC;YAClB,MAAM,aAAa,GAAG,CAAC,KAAK,CAAC,CAAC;YAC9B,KAAK,MAAM,KAAK,IAAI,kBAAkB,EAAE;gBACtC,IAAI,KAAK,CAAC,GAAG,GAAG,CAAC,KAAK,WAAW,EAAE;oBACjC,MAAM;iBACP;gBACD,WAAW,GAAG,KAAK,CAAC,GAAG,CAAC;gBACxB,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aAC3B;YAED,+CAA+C;YAC/C,KAAK,MAAM,KAAK,IAAI,aAAa,EAAE;gBACjC,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;aAClC;YAED,MAAM,WAAW,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YAC1D,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,WAAW,EAAE,CAAC;QAC1D,CAAC,EACD;YACE,WAAW,EAAE,CAAC;YACd,kBAAkB,EAAE,IAAI,0BAAW,CAA+C,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC;YAC1G,WAAW,EAAE,IAAI,KAAK,EAAsB;SAC7C,CACF,EACD,IAAA,UAAG,EAAC,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,WAAW,CAAC,CACtC,CACF,CAAC;IACJ,CAAC;CACF;AAjHD,8DAiHC;AAED,SAAS,qBAAqB,CAAC,SAAiB,EAAE,KAAa;IAC7D,IAAI,SAAS,IAAI,KAAK,EAAE;QACtB,MAAM,IAAI,KAAK,CAAC,mCAAmC,SAAS,6CAA6C,KAAK,EAAE,CAAC,CAAC;KACnH;IACD,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;AAC9E,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 *--------------------------------------------------------------------------------------------*/\nimport { concat, concatAll, map, mergeMap, Observable, of, range, scan } from \"rxjs\";\nimport { eachValueFrom } from \"rxjs-for-await\";\nimport { PagedResponse, PageOptions } from \"@itwin/presentation-common\";\nimport { SortedArray } from \"@itwin/core-bentley\";\nimport { MultipleValuesRequestOptions } from \"./PresentationManager\";\n\n/**\n * Properties for streaming the results.\n * @internal\n */\nexport type StreamedResponseGeneratorProps<TItem> = MultipleValuesRequestOptions & {\n  getBatch(page: Required<PageOptions>, requestIdx: number): Promise<PagedResponse<TItem>>;\n};\n\n/**\n * This class allows loading values in multiple parallel batches and return them either as an array or an async iterator.\n * Pages are prefetched in advanced according to the `parallelism` argument.\n * @internal\n */\nexport class StreamedResponseGenerator<TPagedResponseItem> {\n  constructor(private readonly _props: StreamedResponseGeneratorProps<TPagedResponseItem>) {}\n\n  /** Creates a response with the total item count and an async iterator. */\n  public async createAsyncIteratorResponse(): Promise<{ total: number; items: AsyncIterableIterator<TPagedResponseItem> }> {\n    const firstPage = await this.fetchFirstPage();\n    return {\n      total: firstPage.total,\n      items: eachValueFrom(this.getRemainingPages(firstPage).pipe(concatAll())),\n    };\n  }\n\n  /**\n   * Fetches the first page.\n   * This function has to be called in order to retrieve the total items count.\n   */\n  private async fetchFirstPage(): Promise<PagedResponse<TPagedResponseItem>> {\n    const start = this._props.paging?.start ?? 0;\n    const batchSize = this._props.paging?.size ?? 0;\n    return this._props.getBatch({ start, size: batchSize }, 0);\n  }\n\n  private getRemainingPages(firstPage: PagedResponse<TPagedResponseItem>): Observable<TPagedResponseItem[]> {\n    const pageStart = this._props.paging?.start ?? 0;\n    const maxParallelRequests = this._props.maxParallelRequests;\n    const pageSize = this._props.paging?.size;\n    const { total, items: firstPageItems } = firstPage;\n\n    // If there are no items, return a single empty page.\n    if (total === 0) {\n      return of([]);\n    }\n\n    // If the response is empty, something went wrong.\n    const receivedItemsLength = firstPage.items.length;\n    if (!receivedItemsLength) {\n      handleEmptyPageResult(pageStart, total);\n    }\n\n    const totalItemsToFetch = total - pageStart;\n    if (receivedItemsLength === totalItemsToFetch) {\n      return of(firstPageItems);\n    }\n\n    let itemsToFetch: number;\n    let batchSize: number;\n    if (pageSize) {\n      itemsToFetch = Math.min(totalItemsToFetch, pageSize) - receivedItemsLength;\n      batchSize = Math.min(pageSize, receivedItemsLength);\n    } else {\n      itemsToFetch = totalItemsToFetch - receivedItemsLength;\n      batchSize = receivedItemsLength;\n    }\n\n    const remainingBatches = Math.ceil(itemsToFetch / batchSize);\n\n    // Return the first page and then stream the remaining ones.\n    return concat(\n      of(firstPage.items),\n      range(1, remainingBatches).pipe(\n        mergeMap(async (idx) => {\n          const start = pageStart + idx * batchSize;\n          const size = Math.min(total - start, batchSize);\n          const page = await this._props.getBatch({ start, size }, idx);\n          if (!page.items.length) {\n            handleEmptyPageResult(start, total);\n          }\n\n          // Pass along the index, so that the items could be sorted.\n          return { idx, items: page.items };\n        }, maxParallelRequests),\n        scan(\n          // Collect the emitted pages an emit them in the correct order.\n          (acc, value) => {\n            let { lastEmitted } = acc;\n            const { accumulatedBatches } = acc;\n            const { idx } = value;\n\n            // If current batch is not in order, put it in the accumulator\n            if (idx - 1 !== lastEmitted) {\n              accumulatedBatches.insert(value);\n              return { lastEmitted, accumulatedBatches, itemsToEmit: [] };\n            }\n\n            // Collect all batches to emit in order.\n            lastEmitted = idx;\n            const batchesToEmit = [value];\n            for (const batch of accumulatedBatches) {\n              if (batch.idx - 1 !== lastEmitted) {\n                break;\n              }\n              lastEmitted = batch.idx;\n              batchesToEmit.push(batch);\n            }\n\n            // Remove batches to emit from the accumulator.\n            for (const batch of batchesToEmit) {\n              accumulatedBatches.remove(batch);\n            }\n\n            const itemsToEmit = batchesToEmit.flatMap((x) => x.items);\n            return { lastEmitted, accumulatedBatches, itemsToEmit };\n          },\n          {\n            lastEmitted: 0,\n            accumulatedBatches: new SortedArray<{ idx: number; items: TPagedResponseItem[] }>((a, b) => a.idx - b.idx),\n            itemsToEmit: new Array<TPagedResponseItem>(),\n          },\n        ),\n        map(({ itemsToEmit }) => itemsToEmit),\n      ),\n    );\n  }\n}\n\nfunction handleEmptyPageResult(pageStart: number, total: number) {\n  if (pageStart >= total) {\n    throw new Error(`Requested page with start index ${pageStart} is out of bounds. Total number of items: ${total}`);\n  }\n  throw new Error(\"Paged request returned non zero total count but no items\");\n}\n"]}

package/lib/cjs/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/cjs/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;IAMd;;OAEG;IACI,oBAAoB,WAAkB,gBAAgB,mBAmB3D;IAEF;;;OAGG;IACH,OAAO,CAAC,yBAAyB,CAyB/B;IAEF,OAAO,CAAC,sBAAsB;IAO9B;;;;;;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;IA6C1G;;;;;OAKG;IACU,KAAK,CAAC,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAgC3F;;;;;;OAMG;IACI,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,uBAAuB,GAAG,OAAO;IAW3F;;;;;;OAMG;IACI,UAAU,WAAY,gBAAgB,UAAU,KAAK,EAAE,KAAG,KAAK,EAAE,CAmBtE;IAEF,OAAO,CAAC,gBAAgB;IASxB,OAAO,CAAC,sBAAsB,CAmC5B;IAEF;;;;;;OAMG;IACU,mBAAmB,CAAC,MAAM,EAAE,gBAAgB,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,GAAG,SAAS,EAAE,aAAa,EAAE,KAAK,EAAE;CAiH/H;AAgDD,gBAAgB;AAChB,eAAO,MAAM,aAAa,UAAW,KAAK,KAAG,IAAI,gBAAgB,CAShE,CAAC;AA+BF,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,UAAW,KAAK,KAAG,2BAA2B,EAwB/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"}