@itwin/presentation-frontend 5.0.0-dev.9 → 5.0.0-dev.92

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

@@ -1 +1 @@
-{"version":3,"file":"StreamedResponseGenerator.d.ts","sourceRoot":"","sources":["../../../src/presentation-frontend/StreamedResponseGenerator.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACxE,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"}
+{"version":3,"file":"StreamedResponseGenerator.d.ts","sourceRoot":"","sources":["../../../src/presentation-frontend/StreamedResponseGenerator.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,EAAE,4BAA4B,EAAE,MAAM,0BAA0B,CAAC;AAExE;;;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/esm/presentation-frontend/StreamedResponseGenerator.js

@@ -11,6 +11,7 @@ import { SortedArray } from "@itwin/core-bentley";
  * @internal
  */
 export class StreamedResponseGenerator {
+    _props;
     constructor(_props) {
         this._props = _props;
     }

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

@@ -1 +1 @@
-{"version":3,"file":"StreamedResponseGenerator.js","sourceRoot":"","sources":["../../../src/presentation-frontend/StreamedResponseGenerator.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,EAAE,QAAQ,EAAc,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AACrF,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAYlD;;;;GAIG;AACH,MAAM,OAAO,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,aAAa,CAAC,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,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,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,CAAC;QACzE,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,CAAC;YAChB,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;QAChB,CAAC;QAED,kDAAkD;QAClD,MAAM,mBAAmB,GAAG,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC;QACnD,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACzB,qBAAqB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAC1C,CAAC;QAED,MAAM,iBAAiB,GAAG,KAAK,GAAG,SAAS,CAAC;QAC5C,IAAI,mBAAmB,KAAK,iBAAiB,EAAE,CAAC;YAC9C,OAAO,EAAE,CAAC,cAAc,CAAC,CAAC;QAC5B,CAAC;QAED,IAAI,YAAoB,CAAC;QACzB,IAAI,SAAiB,CAAC;QACtB,IAAI,QAAQ,EAAE,CAAC;YACb,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE,QAAQ,CAAC,GAAG,mBAAmB,CAAC;YAC3E,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,gBAAgB,EAAE,QAAQ,EAAE,mBAAmB,CAAC,CAAC;QACxG,CAAC;aAAM,CAAC;YACN,YAAY,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;YACvD,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,CAAC;QAC9F,CAAC;QAED,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC;QAE7D,4DAA4D;QAC5D,OAAO,MAAM,CACX,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,EACnB,KAAK,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC,IAAI,CAC7B,QAAQ,CAAC,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,CAAC;gBACvB,qBAAqB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YACtC,CAAC;YAED,2DAA2D;YAC3D,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;QACpC,CAAC,EAAE,mBAAmB,CAAC,EACvB,IAAI;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,CAAC;gBAC5B,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACjC,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC;YAC9D,CAAC;YAED,wCAAwC;YACxC,WAAW,GAAG,GAAG,CAAC;YAClB,MAAM,aAAa,GAAG,CAAC,KAAK,CAAC,CAAC;YAC9B,KAAK,MAAM,KAAK,IAAI,kBAAkB,EAAE,CAAC;gBACvC,IAAI,KAAK,CAAC,GAAG,GAAG,CAAC,KAAK,WAAW,EAAE,CAAC;oBAClC,MAAM;gBACR,CAAC;gBACD,WAAW,GAAG,KAAK,CAAC,GAAG,CAAC;gBACxB,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC5B,CAAC;YAED,+CAA+C;YAC/C,KAAK,MAAM,KAAK,IAAI,aAAa,EAAE,CAAC;gBAClC,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACnC,CAAC;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,WAAW,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,GAAG,CAAC,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,WAAW,CAAC,CACtC,CACF,CAAC;IACJ,CAAC;CACF;AAED,SAAS,qBAAqB,CAAC,SAAiB,EAAE,KAAa;IAC7D,IAAI,SAAS,IAAI,KAAK,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CAAC,mCAAmC,SAAS,6CAA6C,KAAK,EAAE,CAAC,CAAC;IACpH,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;AAC9E,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\r\nimport { concat, concatAll, map, mergeMap, Observable, of, range, scan } from \"rxjs\";\r\nimport { eachValueFrom } from \"rxjs-for-await\";\r\nimport { SortedArray } from \"@itwin/core-bentley\";\r\nimport { PagedResponse, PageOptions } from \"@itwin/presentation-common\";\r\nimport { MultipleValuesRequestOptions } from \"./PresentationManager\";\r\n\r\n/**\r\n * Properties for streaming the results.\r\n * @internal\r\n */\r\nexport type StreamedResponseGeneratorProps<TItem> = MultipleValuesRequestOptions & {\r\n  getBatch(page: Required<PageOptions>, requestIdx: number): Promise<PagedResponse<TItem>>;\r\n};\r\n\r\n/**\r\n * This class allows loading values in multiple parallel batches and return them either as an array or an async iterator.\r\n * Pages are prefetched in advanced according to the `parallelism` argument.\r\n * @internal\r\n */\r\nexport class StreamedResponseGenerator<TPagedResponseItem> {\r\n  constructor(private readonly _props: StreamedResponseGeneratorProps<TPagedResponseItem>) {}\r\n\r\n  /** Creates a response with the total item count and an async iterator. */\r\n  public async createAsyncIteratorResponse(): Promise<{ total: number; items: AsyncIterableIterator<TPagedResponseItem> }> {\r\n    const firstPage = await this.fetchFirstPage();\r\n    return {\r\n      total: firstPage.total,\r\n      items: eachValueFrom(this.getRemainingPages(firstPage).pipe(concatAll())),\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Fetches the first page.\r\n   * This function has to be called in order to retrieve the total items count.\r\n   */\r\n  private async fetchFirstPage(): Promise<PagedResponse<TPagedResponseItem>> {\r\n    const start = this._props.paging?.start ?? 0;\r\n    const batchSize = this._props.batchSize ?? this._props.paging?.size ?? 0;\r\n    return this._props.getBatch({ start, size: batchSize }, 0);\r\n  }\r\n\r\n  private getRemainingPages(firstPage: PagedResponse<TPagedResponseItem>): Observable<TPagedResponseItem[]> {\r\n    const pageStart = this._props.paging?.start ?? 0;\r\n    const maxParallelRequests = this._props.maxParallelRequests;\r\n    const pageSize = this._props.paging?.size;\r\n    const { total, items: firstPageItems } = firstPage;\r\n\r\n    // If there are no items, return a single empty page.\r\n    if (total === 0) {\r\n      return of([]);\r\n    }\r\n\r\n    // If the response is empty, something went wrong.\r\n    const receivedItemsLength = firstPage.items.length;\r\n    if (!receivedItemsLength) {\r\n      handleEmptyPageResult(pageStart, total);\r\n    }\r\n\r\n    const totalItemsToFetch = total - pageStart;\r\n    if (receivedItemsLength === totalItemsToFetch) {\r\n      return of(firstPageItems);\r\n    }\r\n\r\n    let itemsToFetch: number;\r\n    let batchSize: number;\r\n    if (pageSize) {\r\n      itemsToFetch = Math.min(totalItemsToFetch, pageSize) - receivedItemsLength;\r\n      batchSize = Math.min(this._props.batchSize ?? Number.MAX_SAFE_INTEGER, pageSize, receivedItemsLength);\r\n    } else {\r\n      itemsToFetch = totalItemsToFetch - receivedItemsLength;\r\n      batchSize = Math.min(this._props.batchSize ?? Number.MAX_SAFE_INTEGER, receivedItemsLength);\r\n    }\r\n\r\n    const remainingBatches = Math.ceil(itemsToFetch / batchSize);\r\n\r\n    // Return the first page and then stream the remaining ones.\r\n    return concat(\r\n      of(firstPage.items),\r\n      range(1, remainingBatches).pipe(\r\n        mergeMap(async (idx) => {\r\n          const start = pageStart + idx * batchSize;\r\n          const size = Math.min(total - start, batchSize);\r\n          const page = await this._props.getBatch({ start, size }, idx);\r\n          if (!page.items.length) {\r\n            handleEmptyPageResult(start, total);\r\n          }\r\n\r\n          // Pass along the index, so that the items could be sorted.\r\n          return { idx, items: page.items };\r\n        }, maxParallelRequests),\r\n        scan(\r\n          // Collect the emitted pages an emit them in the correct order.\r\n          (acc, value) => {\r\n            let { lastEmitted } = acc;\r\n            const { accumulatedBatches } = acc;\r\n            const { idx } = value;\r\n\r\n            // If current batch is not in order, put it in the accumulator\r\n            if (idx - 1 !== lastEmitted) {\r\n              accumulatedBatches.insert(value);\r\n              return { lastEmitted, accumulatedBatches, itemsToEmit: [] };\r\n            }\r\n\r\n            // Collect all batches to emit in order.\r\n            lastEmitted = idx;\r\n            const batchesToEmit = [value];\r\n            for (const batch of accumulatedBatches) {\r\n              if (batch.idx - 1 !== lastEmitted) {\r\n                break;\r\n              }\r\n              lastEmitted = batch.idx;\r\n              batchesToEmit.push(batch);\r\n            }\r\n\r\n            // Remove batches to emit from the accumulator.\r\n            for (const batch of batchesToEmit) {\r\n              accumulatedBatches.remove(batch);\r\n            }\r\n\r\n            const itemsToEmit = batchesToEmit.flatMap((x) => x.items);\r\n            return { lastEmitted, accumulatedBatches, itemsToEmit };\r\n          },\r\n          {\r\n            lastEmitted: 0,\r\n            accumulatedBatches: new SortedArray<{ idx: number; items: TPagedResponseItem[] }>((a, b) => a.idx - b.idx),\r\n            itemsToEmit: new Array<TPagedResponseItem>(),\r\n          },\r\n        ),\r\n        map(({ itemsToEmit }) => itemsToEmit),\r\n      ),\r\n    );\r\n  }\r\n}\r\n\r\nfunction handleEmptyPageResult(pageStart: number, total: number) {\r\n  if (pageStart >= total) {\r\n    throw new Error(`Requested page with start index ${pageStart} is out of bounds. Total number of items: ${total}`);\r\n  }\r\n  throw new Error(\"Paged request returned non zero total count but no items\");\r\n}\r\n"]}
+{"version":3,"file":"StreamedResponseGenerator.js","sourceRoot":"","sources":["../../../src/presentation-frontend/StreamedResponseGenerator.ts"],"names":[],"mappings":"AAAA;;;gGAGgG;AAEhG,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,EAAE,QAAQ,EAAc,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AACrF,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAYlD;;;;GAIG;AACH,MAAM,OAAO,yBAAyB;IACP;IAA7B,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,aAAa,CAAC,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,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,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,CAAC;QACzE,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,CAAC;YAChB,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC;QAChB,CAAC;QAED,kDAAkD;QAClD,MAAM,mBAAmB,GAAG,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC;QACnD,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACzB,qBAAqB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QAC1C,CAAC;QAED,MAAM,iBAAiB,GAAG,KAAK,GAAG,SAAS,CAAC;QAC5C,IAAI,mBAAmB,KAAK,iBAAiB,EAAE,CAAC;YAC9C,OAAO,EAAE,CAAC,cAAc,CAAC,CAAC;QAC5B,CAAC;QAED,IAAI,YAAoB,CAAC;QACzB,IAAI,SAAiB,CAAC;QACtB,IAAI,QAAQ,EAAE,CAAC;YACb,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE,QAAQ,CAAC,GAAG,mBAAmB,CAAC;YAC3E,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,gBAAgB,EAAE,QAAQ,EAAE,mBAAmB,CAAC,CAAC;QACxG,CAAC;aAAM,CAAC;YACN,YAAY,GAAG,iBAAiB,GAAG,mBAAmB,CAAC;YACvD,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,gBAAgB,EAAE,mBAAmB,CAAC,CAAC;QAC9F,CAAC;QAED,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC;QAE7D,4DAA4D;QAC5D,OAAO,MAAM,CACX,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,EACnB,KAAK,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC,IAAI,CAC7B,QAAQ,CAAC,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,CAAC;gBACvB,qBAAqB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YACtC,CAAC;YAED,2DAA2D;YAC3D,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;QACpC,CAAC,EAAE,mBAAmB,CAAC,EACvB,IAAI;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,CAAC;gBAC5B,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACjC,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC;YAC9D,CAAC;YAED,wCAAwC;YACxC,WAAW,GAAG,GAAG,CAAC;YAClB,MAAM,aAAa,GAAG,CAAC,KAAK,CAAC,CAAC;YAC9B,KAAK,MAAM,KAAK,IAAI,kBAAkB,EAAE,CAAC;gBACvC,IAAI,KAAK,CAAC,GAAG,GAAG,CAAC,KAAK,WAAW,EAAE,CAAC;oBAClC,MAAM;gBACR,CAAC;gBACD,WAAW,GAAG,KAAK,CAAC,GAAG,CAAC;gBACxB,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC5B,CAAC;YAED,+CAA+C;YAC/C,KAAK,MAAM,KAAK,IAAI,aAAa,EAAE,CAAC;gBAClC,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACnC,CAAC;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,WAAW,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,GAAG,CAAC,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,WAAW,CAAC,CACtC,CACF,CAAC;IACJ,CAAC;CACF;AAED,SAAS,qBAAqB,CAAC,SAAiB,EAAE,KAAa;IAC7D,IAAI,SAAS,IAAI,KAAK,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CAAC,mCAAmC,SAAS,6CAA6C,KAAK,EAAE,CAAC,CAAC;IACpH,CAAC;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 *--------------------------------------------------------------------------------------------*/\n\nimport { concat, concatAll, map, mergeMap, Observable, of, range, scan } from \"rxjs\";\nimport { eachValueFrom } from \"rxjs-for-await\";\nimport { SortedArray } from \"@itwin/core-bentley\";\nimport { PagedResponse, PageOptions } from \"@itwin/presentation-common\";\nimport { MultipleValuesRequestOptions } from \"./PresentationManager.js\";\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.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(this._props.batchSize ?? Number.MAX_SAFE_INTEGER, pageSize, receivedItemsLength);\n    } else {\n      itemsToFetch = totalItemsToFetch - receivedItemsLength;\n      batchSize = Math.min(this._props.batchSize ?? Number.MAX_SAFE_INTEGER, 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/esm/presentation-frontend/favorite-properties/FavoritePropertiesManager.d.ts

@@ -1,10 +1,10 @@
 /** @packageDocumentation
  * @module Core
  */
-import { BeEvent, IDisposable } from "@itwin/core-bentley";
+import { BeEvent } from "@itwin/core-bentley";
 import { IModelConnection } from "@itwin/core-frontend";
 import { Field } from "@itwin/presentation-common";
-import { IFavoritePropertiesStorage } from "./FavoritePropertiesStorage";
+import { IFavoritePropertiesStorage } from "./FavoritePropertiesStorage.js";
 /**
  * Scopes that favorite properties can be stored in.
  * @public
@@ -49,7 +49,7 @@ export interface FavoritePropertiesManagerProps {
  *
  * @public
  */
-export declare class FavoritePropertiesManager implements IDisposable {
+export declare class FavoritePropertiesManager implements Disposable {
     /**
      * Used in tests to avoid collisions between multiple runs using the same storage
      * @internal
@@ -57,7 +57,7 @@ export declare class FavoritePropertiesManager implements IDisposable {
     static FAVORITES_IDENTIFIER_PREFIX: string;
     /** Event raised after favorite properties have changed. */
     onFavoritesChanged: BeEvent<() => void>;
-    private _storage;
+    readonly storage: IFavoritePropertiesStorage;
     private _globalProperties;
     private _iTwinProperties;
     private _imodelProperties;
@@ -66,6 +66,8 @@ export declare class FavoritePropertiesManager implements IDisposable {
     /** Property order is saved only in iModel scope */
     private _propertiesOrder;
     constructor(props: FavoritePropertiesManagerProps);
+    [Symbol.dispose](): void;
+    /** @deprecated in 5.0 Use [Symbol.dispose] instead. */
     dispose(): void;
     /**
      * Initialize favorite properties for the provided IModelConnection.

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;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,GAAG,CAAC,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,EAA+B,MAAM,qBAAqB,CAAC;AAE3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAW,KAAK,EAAuC,MAAM,4BAA4B,CAAC;AACjG,OAAO,EAAE,0BAA0B,EAAE,MAAM,gCAAgC,CAAC;AAE5E;;;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,UAAU;IAC1D;;;OAGG;IACH,OAAc,2BAA2B,SAAM;IAE/C,2DAA2D;IACpD,kBAAkB,gBAAqB,IAAI,EAAI;IAEtD,SAAgB,OAAO,EAAE,0BAA0B,CAAC;IAEpD,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,CAAC,MAAM,CAAC,OAAO,CAAC;IASvB,uDAAuD;IAEhD,OAAO;IAId;;;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,GAAG,CAAC,gBAAgB,CAUhE,CAAC;AAgCF,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,UAAW,KAAK,KAAG,2BAA2B,EA4B/E,CAAC"}

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

@@ -5,7 +5,7 @@
 /** @packageDocumentation
  * @module Core
  */
-import { BeEvent, isIDisposable } from "@itwin/core-bentley";
+import { BeEvent, isDisposable, isIDisposable } from "@itwin/core-bentley";
 import { QueryRowFormat } from "@itwin/core-common";
 /**
  * Scopes that favorite properties can be stored in.
@@ -24,139 +24,93 @@ export var FavoritePropertiesScope;
  * @public
  */
 export class FavoritePropertiesManager {
+    /**
+     * Used in tests to avoid collisions between multiple runs using the same storage
+     * @internal
+     */
+    static FAVORITES_IDENTIFIER_PREFIX = "";
+    /** Event raised after favorite properties have changed. */
+    onFavoritesChanged = new BeEvent();
+    storage;
+    _globalProperties;
+    _iTwinProperties;
+    _imodelProperties;
+    _imodelBaseClassesByClass;
+    _imodelInitializationPromises;
+    /** Property order is saved only in iModel scope */
+    _propertiesOrder;
     constructor(props) {
-        /** Event raised after favorite properties have changed. */
-        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;
-            const iTwinId = imodel.iTwinId;
-            if (this._globalProperties === undefined) {
-                this._globalProperties = (await this._storage.loadProperties()) || new Set();
-            }
-            if (!this._iTwinProperties.has(iTwinId)) {
-                const iTwinProperties = (await this._storage.loadProperties(iTwinId)) || new Set();
-                this._iTwinProperties.set(iTwinId, iTwinProperties);
-            }
-            if (!this._imodelProperties.has(getiModelInfo(iTwinId, imodelId))) {
-                const imodelProperties = (await this._storage.loadProperties(iTwinId, imodelId)) || new Set();
-                this._imodelProperties.set(getiModelInfo(iTwinId, imodelId), imodelProperties);
-            }
-            const propertiesOrder = (await this._storage.loadPropertiesOrder(iTwinId, imodelId)) || [];
-            this._propertiesOrder.set(getiModelInfo(iTwinId, imodelId), propertiesOrder);
-            await this._adjustPropertyOrderInfos(iTwinId, imodelId);
-        };
-        /**
-         * Function that removes order information of properties that are no longer
-         * favorited and adds missing order information for favorited properties.
-         */
-        this._adjustPropertyOrderInfos = async (iTwinId, imodelId) => {
-            const propertiesOrder = this._propertiesOrder.get(getiModelInfo(iTwinId, imodelId));
-            const globalProperties = this._globalProperties;
-            const iTwinProperties = this._iTwinProperties.get(iTwinId);
-            const imodelProperties = this._imodelProperties.get(getiModelInfo(iTwinId, imodelId));
-            // favorite property infos that need to be added to the propertiesOrder array
-            const infosToAdd = new Set([...globalProperties, ...iTwinProperties, ...imodelProperties]);
-            for (let i = propertiesOrder.length - 1; i >= 0; i--) {
-                if (infosToAdd.has(propertiesOrder[i].name)) {
-                    infosToAdd.delete(propertiesOrder[i].name);
-                }
-                else {
-                    propertiesOrder.splice(i, 1);
-                }
-            }
-            infosToAdd.forEach((info) => propertiesOrder.push({
-                name: info,
-                parentClassName: getPropertyClassName(info),
-                orderedTimestamp: new Date(),
-                priority: 0,
-            }));
-            let priority = propertiesOrder.length;
-            propertiesOrder.forEach((oi) => (oi.priority = priority--));
-        };
-        /**
-         * 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]].
-         */
-        this.sortFields = (imodel, fields) => {
-            this.validateInitialization(imodel);
-            const iTwinId = imodel.iTwinId;
-            const imodelId = imodel.iModelId;
-            const fieldPriority = new Map();
-            fields.forEach((field) => fieldPriority.set(field, this.getFieldPriority(field, iTwinId, imodelId)));
-            const sortFunction = (left, right) => {
-                const lp = fieldPriority.get(left);
-                const rp = fieldPriority.get(right);
-                return lp < rp
-                    ? 1
-                    : lp > rp
-                        ? -1
-                        : left.priority < right.priority
-                            ? 1 // if favorite fields have equal priorities, sort by field priority
-                            : left.priority > right.priority
-                                ? -1
-                                : left.name.localeCompare(right.name);
-            };
-            return fields.sort(sortFunction);
-        };
-        this._getBaseClassesByClass = async (imodel, neededClasses) => {
-            const iTwinId = imodel.iTwinId;
-            const imodelId = imodel.iModelId;
-            const imodelInfo = getiModelInfo(iTwinId, imodelId);
-            let baseClasses;
-            if (this._imodelBaseClassesByClass.has(imodelInfo)) {
-                baseClasses = this._imodelBaseClassesByClass.get(imodelInfo);
-            }
-            else {
-                this._imodelBaseClassesByClass.set(imodelInfo, (baseClasses = {}));
-            }
-            const missingClasses = new Set();
-            neededClasses.forEach((className) => {
-                if (!baseClasses.hasOwnProperty(className)) {
-                    missingClasses.add(className);
-                }
-            });
-            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
-    WHERE (derivedSchema.Name || ':' || derivedClass.Name) IN (${[...missingClasses].map((className) => `'${className}'`).join(",")})`;
-            const reader = imodel.createQueryReader(query, undefined, { rowFormat: QueryRowFormat.UseJsPropertyNames });
-            while (await reader.step()) {
-                const row = reader.current.toRow();
-                if (!(row.classFullName in baseClasses)) {
-                    baseClasses[row.classFullName] = [];
-                }
-                baseClasses[row.classFullName].push(row.baseClassFullName);
-            }
-            return baseClasses;
-        };
-        this._storage = props.storage;
+        this.storage = props.storage;
         this._iTwinProperties = new Map();
         this._imodelProperties = new Map();
         this._propertiesOrder = new Map();
         this._imodelBaseClassesByClass = new Map();
         this._imodelInitializationPromises = new Map();
     }
-    dispose() {
-        // istanbul ignore else
-        if (isIDisposable(this._storage)) {
-            this._storage.dispose();
+    [Symbol.dispose]() {
+        if (isDisposable(this.storage)) {
+            this.storage[Symbol.dispose]();
+            /* c8 ignore next 3 */
+        }
+        else if (isIDisposable(this.storage)) { /* eslint-disable-line @typescript-eslint/no-deprecated */
+            this.storage.dispose();
         }
     }
+    /** @deprecated in 5.0 Use [Symbol.dispose] instead. */
+    /* c8 ignore next 3 */
+    dispose() {
+        this[Symbol.dispose]();
+    }
+    /**
+     * 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 = async (imodel) => {
+        const imodelId = imodel.iModelId;
+        const iTwinId = imodel.iTwinId;
+        if (this._globalProperties === undefined) {
+            this._globalProperties = (await this.storage.loadProperties()) || new Set();
+        }
+        if (!this._iTwinProperties.has(iTwinId)) {
+            const iTwinProperties = (await this.storage.loadProperties(iTwinId)) || new Set();
+            this._iTwinProperties.set(iTwinId, iTwinProperties);
+        }
+        if (!this._imodelProperties.has(getiModelInfo(iTwinId, imodelId))) {
+            const imodelProperties = (await this.storage.loadProperties(iTwinId, imodelId)) || new Set();
+            this._imodelProperties.set(getiModelInfo(iTwinId, imodelId), imodelProperties);
+        }
+        const propertiesOrder = (await this.storage.loadPropertiesOrder(iTwinId, imodelId)) || [];
+        this._propertiesOrder.set(getiModelInfo(iTwinId, imodelId), propertiesOrder);
+        await this._adjustPropertyOrderInfos(iTwinId, imodelId);
+    };
+    /**
+     * Function that removes order information of properties that are no longer
+     * favorited and adds missing order information for favorited properties.
+     */
+    _adjustPropertyOrderInfos = async (iTwinId, imodelId) => {
+        const propertiesOrder = this._propertiesOrder.get(getiModelInfo(iTwinId, imodelId));
+        const globalProperties = this._globalProperties;
+        const iTwinProperties = this._iTwinProperties.get(iTwinId);
+        const imodelProperties = this._imodelProperties.get(getiModelInfo(iTwinId, imodelId));
+        // favorite property infos that need to be added to the propertiesOrder array
+        const infosToAdd = new Set([...globalProperties, ...iTwinProperties, ...imodelProperties]);
+        for (let i = propertiesOrder.length - 1; i >= 0; i--) {
+            if (infosToAdd.has(propertiesOrder[i].name)) {
+                infosToAdd.delete(propertiesOrder[i].name);
+            }
+            else {
+                propertiesOrder.splice(i, 1);
+            }
+        }
+        infosToAdd.forEach((info) => propertiesOrder.push({
+            name: info,
+            parentClassName: getPropertyClassName(info),
+            orderedTimestamp: new Date(),
+            priority: 0,
+        }));
+        let priority = propertiesOrder.length;
+        propertiesOrder.forEach((oi) => (oi.priority = priority--));
+    };
     isInitialized(imodel) {
         const iTwinId = imodel.iTwinId;
         const imodelId = imodel.iModelId;
@@ -217,15 +171,15 @@ export class FavoritePropertiesManager {
         switch (scope) {
             case FavoritePropertiesScope.Global:
                 favoriteProperties = this._globalProperties;
-                saveProperties = async (properties) => this._storage.saveProperties(properties);
+                saveProperties = async (properties) => this.storage.saveProperties(properties);
                 break;
             case FavoritePropertiesScope.ITwin:
                 favoriteProperties = this._iTwinProperties.get(iTwinId);
-                saveProperties = async (properties) => this._storage.saveProperties(properties, iTwinId);
+                saveProperties = async (properties) => this.storage.saveProperties(properties, iTwinId);
                 break;
             default:
                 favoriteProperties = this._imodelProperties.get(getiModelInfo(iTwinId, imodelId));
-                saveProperties = async (properties) => this._storage.saveProperties(properties, iTwinId, imodelId);
+                saveProperties = async (properties) => this.storage.saveProperties(properties, iTwinId, imodelId);
         }
         const countBefore = favoriteProperties.size;
         const fieldInfos = getFieldInfos(field);
@@ -235,7 +189,7 @@ export class FavoritePropertiesManager {
             saves.push(saveProperties(favoriteProperties));
             const propertiesOrder = this._propertiesOrder.get(getiModelInfo(iTwinId, imodelId));
             addOrderInfos(propertiesOrder, createFieldOrderInfos(field));
-            saves.push(this._storage.savePropertiesOrder(propertiesOrder, iTwinId, imodelId));
+            saves.push(this.storage.savePropertiesOrder(propertiesOrder, iTwinId, imodelId));
             await Promise.all(saves);
             this.onFavoritesChanged.raiseEvent();
         }
@@ -254,18 +208,18 @@ export class FavoritePropertiesManager {
         const workingScopes = [];
         workingScopes.push({
             properties: this._globalProperties,
-            save: async (properties) => this._storage.saveProperties(properties),
+            save: async (properties) => this.storage.saveProperties(properties),
         });
         if (scope === FavoritePropertiesScope.ITwin || scope === FavoritePropertiesScope.IModel) {
             workingScopes.push({
                 properties: this._iTwinProperties.get(iTwinId),
-                save: async (properties) => this._storage.saveProperties(properties, iTwinId),
+                save: async (properties) => this.storage.saveProperties(properties, iTwinId),
             });
         }
         if (scope === FavoritePropertiesScope.IModel) {
             workingScopes.push({
                 properties: this._imodelProperties.get(getiModelInfo(iTwinId, imodelId)),
-                save: async (properties) => this._storage.saveProperties(properties, iTwinId, imodelId),
+                save: async (properties) => this.storage.saveProperties(properties, iTwinId, imodelId),
             });
         }
         const saves = [];
@@ -283,7 +237,7 @@ export class FavoritePropertiesManager {
         }
         const propertiesOrder = this._propertiesOrder.get(getiModelInfo(iTwinId, imodelId));
         removeOrderInfos(propertiesOrder, createFieldOrderInfos(field));
-        saves.push(this._storage.savePropertiesOrder(propertiesOrder, iTwinId, imodelId));
+        saves.push(this.storage.savePropertiesOrder(propertiesOrder, iTwinId, imodelId));
         await Promise.all(saves);
         this.onFavoritesChanged.raiseEvent();
     }
@@ -301,15 +255,15 @@ export class FavoritePropertiesManager {
         switch (scope) {
             case FavoritePropertiesScope.Global:
                 favoriteProperties = this._globalProperties;
-                saveProperties = async () => this._storage.saveProperties(new Set());
+                saveProperties = async () => this.storage.saveProperties(new Set());
                 break;
             case FavoritePropertiesScope.ITwin:
                 favoriteProperties = this._iTwinProperties.get(iTwinId);
-                saveProperties = async () => this._storage.saveProperties(new Set(), iTwinId);
+                saveProperties = async () => this.storage.saveProperties(new Set(), iTwinId);
                 break;
             default:
                 favoriteProperties = this._imodelProperties.get(getiModelInfo(iTwinId, imodelId));
-                saveProperties = async () => this._storage.saveProperties(new Set(), iTwinId, imodelId);
+                saveProperties = async () => this.storage.saveProperties(new Set(), iTwinId, imodelId);
         }
         if (favoriteProperties.size === 0) {
             return;
@@ -349,6 +303,35 @@ export class FavoritePropertiesManager {
         // eslint-disable-next-line @typescript-eslint/no-deprecated
         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.
+     * @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, fields) => {
+        this.validateInitialization(imodel);
+        const iTwinId = imodel.iTwinId;
+        const imodelId = imodel.iModelId;
+        const fieldPriority = new Map();
+        fields.forEach((field) => fieldPriority.set(field, this.getFieldPriority(field, iTwinId, imodelId)));
+        const sortFunction = (left, right) => {
+            const lp = fieldPriority.get(left);
+            const rp = fieldPriority.get(right);
+            return lp < rp
+                ? 1
+                : lp > rp
+                    ? -1
+                    : left.priority < right.priority
+                        ? 1 // if favorite fields have equal priorities, sort by field priority
+                        : left.priority > right.priority
+                            ? -1
+                            : left.name.localeCompare(right.name);
+        };
+        return fields.sort(sortFunction);
+    };
     /**
      * 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.
@@ -369,6 +352,44 @@ export class FavoritePropertiesManager {
         const mostRecent = getMostRecentOrderInfo(fieldOrderInfos);
         return mostRecent.priority;
     }
+    _getBaseClassesByClass = async (imodel, neededClasses) => {
+        const iTwinId = imodel.iTwinId;
+        const imodelId = imodel.iModelId;
+        const imodelInfo = getiModelInfo(iTwinId, imodelId);
+        let baseClasses;
+        if (this._imodelBaseClassesByClass.has(imodelInfo)) {
+            baseClasses = this._imodelBaseClassesByClass.get(imodelInfo);
+        }
+        else {
+            this._imodelBaseClassesByClass.set(imodelInfo, (baseClasses = {}));
+        }
+        const missingClasses = new Set();
+        neededClasses.forEach((className) => {
+            if (!baseClasses.hasOwnProperty(className)) {
+                missingClasses.add(className);
+            }
+        });
+        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
+    WHERE (derivedSchema.Name || ':' || derivedClass.Name) IN (${[...missingClasses].map((className) => `'${className}'`).join(",")})`;
+        const reader = imodel.createQueryReader(query, undefined, { rowFormat: QueryRowFormat.UseJsPropertyNames });
+        while (await reader.step()) {
+            const row = reader.current.toRow();
+            if (!(row.classFullName in baseClasses)) {
+                baseClasses[row.classFullName] = [];
+            }
+            baseClasses[row.classFullName].push(row.baseClassFullName);
+        }
+        return baseClasses;
+    };
     /** Changes field properties priorities to lower than another fields priority
      * @param imodel IModelConnection.
      * @param field Field that priority is being changed.
@@ -478,15 +499,10 @@ export class FavoritePropertiesManager {
         // reassign priority numbers
         let priority = allOrderInfos.length;
         allOrderInfos.forEach((oi) => (oi.priority = priority--));
-        await this._storage.savePropertiesOrder(allOrderInfos, iTwinId, imodelId);
+        await this.storage.savePropertiesOrder(allOrderInfos, iTwinId, imodelId);
         this.onFavoritesChanged.raiseEvent();
     }
 }
-/**
- * Used in tests to avoid collisions between multiple runs using the same storage
- * @internal
- */
-FavoritePropertiesManager.FAVORITES_IDENTIFIER_PREFIX = "";
 var Direction;
 (function (Direction) {
     Direction[Direction["Up"] = -1] = "Up";
@@ -568,7 +584,6 @@ const addOrderInfos = (dest, source) => {
 const removeOrderInfos = (container, toRemove) => {
     toRemove.forEach((roi) => {
         const index = container.findIndex((oi) => oi.name === roi.name);
-        /* istanbul ignore else */
         if (index >= 0) {
             container.splice(index, 1);
         }