@itwin/presentation-frontend 4.5.0-dev.23 → 4.5.0-dev.24

package/lib/esm/presentation-frontend/PresentationManager.d.ts

@@ -5,7 +5,7 @@ import { BeEvent, IDisposable } from "@itwin/core-bentley";
 import { IModelConnection } from "@itwin/core-frontend";
 import { UnitSystemKey } from "@itwin/core-quantity";
 import { SchemaContext } from "@itwin/ecschema-metadata";
-import { ClientDiagnosticsAttribute, Content, ContentDescriptorRequestOptions, ContentInstanceKeysRequestOptions, ContentRequestOptions, ContentSourcesRequestOptions, ContentUpdateInfo, Descriptor, DescriptorOverrides, DisplayLabelRequestOptions, DisplayLabelsRequestOptions, DisplayValueGroup, DistinctValuesRequestOptions, ElementProperties, FilterByInstancePathsHierarchyRequestOptions, FilterByTextHierarchyRequestOptions, FormatsMap, HierarchyLevelDescriptorRequestOptions, HierarchyRequestOptions, HierarchyUpdateInfo, InstanceKey, KeySet, LabelDefinition, Node, NodeKey, NodePathElement, Paged, PagedResponse, PageOptions, RpcRequestsHandler, RulesetVariable, SelectClassInfo, SingleElementPropertiesRequestOptions } from "@itwin/presentation-common";
+import { ClientDiagnosticsAttribute, Content, ContentDescriptorRequestOptions, ContentInstanceKeysRequestOptions, ContentRequestOptions, ContentSourcesRequestOptions, ContentUpdateInfo, Descriptor, DescriptorOverrides, DisplayLabelRequestOptions, DisplayLabelsRequestOptions, DisplayValueGroup, DistinctValuesRequestOptions, ElementProperties, FilterByInstancePathsHierarchyRequestOptions, FilterByTextHierarchyRequestOptions, FormatsMap, HierarchyLevelDescriptorRequestOptions, HierarchyRequestOptions, HierarchyUpdateInfo, InstanceKey, Item, KeySet, LabelDefinition, Node, NodeKey, NodePathElement, Paged, PagedResponse, RpcRequestsHandler, RulesetVariable, SelectClassInfo, SingleElementPropertiesRequestOptions } from "@itwin/presentation-common";
 import { IpcRequestsHandler } from "./IpcRequestsHandler";
 import { RulesetManager } from "./RulesetManager";
 import { RulesetVariablesManager } from "./RulesetVariablesManager";
@@ -33,6 +33,28 @@ export interface IModelContentChangeEventArgs {
     /** Key of iModel that was used to create content. It matches [[IModelConnection.key]] property. */
     imodelKey: string;
 }
+/**
+ * Options for requests that can return multiple pages of items concurrently.
+ * @public
+ */
+export type MultipleValuesRequestOptions = Paged<{
+    maxParallelRequests?: number;
+}>;
+/**
+ * Options for requests that retrieve nodes.
+ * @public
+ */
+export type GetNodesRequestOptions = HierarchyRequestOptions<IModelConnection, NodeKey, RulesetVariable> & ClientDiagnosticsAttribute;
+/**
+ * Options for requests that retrieve content.
+ * @public
+ */
+export type GetContentRequestOptions = ContentRequestOptions<IModelConnection, Descriptor | DescriptorOverrides, KeySet, RulesetVariable> & ClientDiagnosticsAttribute;
+/**
+ * Options for requests that retrieve distinct values.
+ * @public
+ */
+export type GetDistinctValuesRequestOptions = DistinctValuesRequestOptions<IModelConnection, Descriptor | DescriptorOverrides, KeySet, RulesetVariable> & ClientDiagnosticsAttribute;
 /**
  * Properties used to configure [[PresentationManager]]
  * @public
@@ -160,12 +182,23 @@ export declare class PresentationManager implements IDisposable {
     vars(rulesetId: string): RulesetVariablesManager;
     private toRpcTokenOptions;
     private addRulesetAndVariablesToOptions;
-    /** Retrieves nodes */
-    getNodes(requestOptions: Paged<HierarchyRequestOptions<IModelConnection, NodeKey, RulesetVariable>> & ClientDiagnosticsAttribute): Promise<Node[]>;
+    /** Returns an iterator that polls nodes asynchronously. */
+    getNodesIterator(requestOptions: GetNodesRequestOptions & MultipleValuesRequestOptions): Promise<{
+        total: number;
+        items: AsyncIterableIterator<Node>;
+    }>;
+    /**
+     * Retrieves nodes
+     * @deprecated in 4.5. Use [[getNodesIterator]] instead.
+     */
+    getNodes(requestOptions: GetNodesRequestOptions & MultipleValuesRequestOptions): Promise<Node[]>;
     /** Retrieves nodes count. */
-    getNodesCount(requestOptions: HierarchyRequestOptions<IModelConnection, NodeKey, RulesetVariable> & ClientDiagnosticsAttribute): Promise<number>;
-    /** Retrieves total nodes count and a single page of nodes. */
-    getNodesAndCount(requestOptions: Paged<HierarchyRequestOptions<IModelConnection, NodeKey, RulesetVariable>> & ClientDiagnosticsAttribute): Promise<{
+    getNodesCount(requestOptions: GetNodesRequestOptions): Promise<number>;
+    /**
+     * Retrieves total nodes count and a single page of nodes.
+     * @deprecated in 4.5. Use [[getNodesIterator]] instead.
+     */
+    getNodesAndCount(requestOptions: GetNodesRequestOptions & MultipleValuesRequestOptions): Promise<{
         count: number;
         nodes: Node[];
     }>;
@@ -187,16 +220,37 @@ export declare class PresentationManager implements IDisposable {
     /** Retrieves the content descriptor which describes the content and can be used to customize it. */
     getContentDescriptor(requestOptions: ContentDescriptorRequestOptions<IModelConnection, KeySet, RulesetVariable> & ClientDiagnosticsAttribute): Promise<Descriptor | undefined>;
     /** Retrieves overall content set size. */
-    getContentSetSize(requestOptions: ContentRequestOptions<IModelConnection, Descriptor | DescriptorOverrides, KeySet, RulesetVariable> & ClientDiagnosticsAttribute): Promise<number>;
-    /** Retrieves content which consists of a content descriptor and a page of records. */
-    getContent(requestOptions: Paged<ContentRequestOptions<IModelConnection, Descriptor | DescriptorOverrides, KeySet, RulesetVariable>> & ClientDiagnosticsAttribute): Promise<Content | undefined>;
-    /** Retrieves content set size and content which consists of a content descriptor and a page of records. */
-    getContentAndSize(requestOptions: Paged<ContentRequestOptions<IModelConnection, Descriptor | DescriptorOverrides, KeySet, RulesetVariable>> & ClientDiagnosticsAttribute): Promise<{
+    getContentSetSize(requestOptions: GetContentRequestOptions): Promise<number>;
+    private getContentIteratorInternal;
+    /** Retrieves a content descriptor, item count and async generator for the items themselves. */
+    getContentIterator(requestOptions: GetContentRequestOptions & MultipleValuesRequestOptions): Promise<{
+        descriptor: Descriptor;
+        total: number;
+        items: AsyncIterableIterator<Item>;
+    } | undefined>;
+    /**
+     * Retrieves content which consists of a content descriptor and a page of records.
+     * @deprecated in 4.5. Use [[getContentIterator]] instead.
+     */
+    getContent(requestOptions: GetContentRequestOptions & MultipleValuesRequestOptions): Promise<Content | undefined>;
+    /**
+     * Retrieves content set size and content which consists of a content descriptor and a page of records.
+     * @deprecated in 4.5. Use [[getContentIterator]] instead.
+     */
+    getContentAndSize(requestOptions: GetContentRequestOptions & MultipleValuesRequestOptions): Promise<{
         content: Content;
         size: number;
     } | undefined>;
-    /** Retrieves distinct values of specific field from the content. */
-    getPagedDistinctValues(requestOptions: DistinctValuesRequestOptions<IModelConnection, Descriptor | DescriptorOverrides, KeySet, RulesetVariable> & ClientDiagnosticsAttribute): Promise<PagedResponse<DisplayValueGroup>>;
+    /** Returns an iterator that asynchronously polls distinct values of specific field from the content. */
+    getDistinctValuesIterator(requestOptions: GetDistinctValuesRequestOptions & MultipleValuesRequestOptions): Promise<{
+        total: number;
+        items: AsyncIterableIterator<DisplayValueGroup>;
+    }>;
+    /**
+     * Retrieves distinct values of specific field from the content.
+     * @deprecated in 4.5. Use [[getDistinctValuesIterator]] instead.
+     */
+    getPagedDistinctValues(requestOptions: GetDistinctValuesRequestOptions & MultipleValuesRequestOptions): Promise<PagedResponse<DisplayValueGroup>>;
     /**
      * Retrieves property data in a simplified format for a single element specified by ID.
      * @public
@@ -206,15 +260,21 @@ export declare class PresentationManager implements IDisposable {
      * Retrieves content item instance keys.
      * @public
      */
-    getContentInstanceKeys(requestOptions: ContentInstanceKeysRequestOptions<IModelConnection, KeySet, RulesetVariable> & ClientDiagnosticsAttribute): Promise<{
+    getContentInstanceKeys(requestOptions: ContentInstanceKeysRequestOptions<IModelConnection, KeySet, RulesetVariable> & ClientDiagnosticsAttribute & MultipleValuesRequestOptions): Promise<{
         total: number;
         items: () => AsyncGenerator<InstanceKey>;
     }>;
     /** Retrieves display label definition of specific item. */
     getDisplayLabelDefinition(requestOptions: DisplayLabelRequestOptions<IModelConnection, InstanceKey> & ClientDiagnosticsAttribute): Promise<LabelDefinition>;
     /** Retrieves display label definition of specific items. */
-    getDisplayLabelDefinitions(requestOptions: DisplayLabelsRequestOptions<IModelConnection, InstanceKey> & ClientDiagnosticsAttribute): Promise<LabelDefinition[]>;
+    getDisplayLabelDefinitionsIterator(requestOptions: DisplayLabelsRequestOptions<IModelConnection, InstanceKey> & ClientDiagnosticsAttribute & MultipleValuesRequestOptions): Promise<{
+        total: number;
+        items: AsyncIterableIterator<LabelDefinition>;
+    }>;
+    /**
+     * Retrieves display label definition of specific items.
+     * @deprecated in 4.5. Use [[getDisplayLabelDefinitionsIterator]] instead.
+     */
+    getDisplayLabelDefinitions(requestOptions: DisplayLabelsRequestOptions<IModelConnection, InstanceKey> & ClientDiagnosticsAttribute & MultipleValuesRequestOptions): Promise<LabelDefinition[]>;
 }
-/** @internal */
-export declare const buildPagedArrayResponse: <TItem>(requestedPage: PageOptions | undefined, getter: (page: Required<PageOptions>, requestIndex: number) => Promise<PagedResponse<TItem>>) => Promise<PagedResponse<TItem>>;
 //# sourceMappingURL=PresentationManager.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"PresentationManager.d.ts","sourceRoot":"","sources":["../../../src/presentation-frontend/PresentationManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAqB,WAAW,EAAuB,MAAM,qBAAqB,CAAC;AACnG,OAAO,EAAa,gBAAgB,EAAU,MAAM,sBAAsB,CAAC;AAC3E,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EACL,0BAA0B,EAC1B,OAAO,EACP,+BAA+B,EAE/B,iCAAiC,EAEjC,qBAAqB,EACrB,4BAA4B,EAC5B,iBAAiB,EACjB,UAAU,EACV,mBAAmB,EACnB,0BAA0B,EAC1B,2BAA2B,EAC3B,iBAAiB,EACjB,4BAA4B,EAC5B,iBAAiB,EACjB,4CAA4C,EAC5C,mCAAmC,EACnC,UAAU,EACV,sCAAsC,EACtC,uBAAuB,EACvB,mBAAmB,EACnB,WAAW,EAGX,MAAM,EAEN,eAAe,EACf,IAAI,EACJ,OAAO,EACP,eAAe,EACf,KAAK,EACL,aAAa,EACb,WAAW,EAEX,kBAAkB,EAElB,eAAe,EACf,eAAe,EACf,qCAAqC,EAGtC,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAE,cAAc,EAAsB,MAAM,kBAAkB,CAAC;AACtE,OAAO,EAAE,uBAAuB,EAA+B,MAAM,2BAA2B,CAAC;AAGjG;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C,uDAAuD;IACvD,SAAS,EAAE,MAAM,CAAC;IAClB,8BAA8B;IAC9B,UAAU,EAAE,mBAAmB,CAAC;IAChC,qGAAqG;IACrG,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C,qDAAqD;IACrD,SAAS,EAAE,MAAM,CAAC;IAClB,4BAA4B;IAC5B,UAAU,EAAE,iBAAiB,CAAC;IAC9B,mGAAmG;IACnG,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,aAAa,CAAC;IAEjC;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,aAAa,CAAC;IAEpE;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,UAAU,CAAC;IAE5B,gBAAgB;IAChB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IAExC,gBAAgB;IAChB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CACzC;AAED;;;;;GAKG;AACH,qBAAa,mBAAoB,YAAW,WAAW;IACrD,OAAO,CAAC,gBAAgB,CAAqB;IAC7C,OAAO,CAAC,SAAS,CAAiB;IAClC,OAAO,CAAC,mBAAmB,CAA6B;IACxD,OAAO,CAAC,yBAAyB,CAA4B;IAC7D,OAAO,CAAC,YAAY,CAAuC;IAC3D,OAAO,CAAC,mBAAmB,CAAC,CAAa;IACzC,OAAO,CAAC,sBAAsB,CAAC,CAA8C;IAC7E,OAAO,CAAC,eAAe,CAAC,CAAa;IACrC,OAAO,CAAC,mBAAmB,CAAC,CAAqB;IAEjD;;;OAGG;IACI,wBAAwB,iBAAsB,8BAA8B,KAAK,IAAI,EAAI;IAEhG;;;OAGG;IACI,sBAAsB,iBAAsB,4BAA4B,KAAK,IAAI,EAAI;IAE5F;;;;;;OAMG;IACH,IAAW,gBAAgB,IAAI,aAAa,CAE3C;IACD,IAAW,gBAAgB,CAAC,KAAK,EAAE,aAAa,GAAG,SAAS,EAE3D;IAED,OAAO;IAqBP,oEAAoE;IACpE,IAAW,YAAY,IAAI,MAAM,GAAG,SAAS,CAE5C;IACD,IAAW,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,EAEjD;IAEM,OAAO;IAQd,OAAO,CAAC,QAAQ,CAGd;IAEF,wEAAwE;YAC1D,iBAAiB;IAyB/B;;;OAGG;IACI,yBAAyB,CAAC,CAAC,EAAE,gBAAgB;IAEpD;;;;OAIG;IACU,uBAAuB,CAAC,CAAC,EAAE,gBAAgB;IAExD;;;OAGG;WACW,MAAM,CAAC,KAAK,CAAC,EAAE,wBAAwB;IAIrD,gBAAgB;IAChB,IAAW,kBAAkB,uBAE5B;IAED,gBAAgB;IAChB,IAAW,kBAAkB,mCAE5B;IAED;;OAEG;IACI,QAAQ;IAIf;;;OAGG;IACI,IAAI,CAAC,SAAS,EAAE,MAAM;IAQ7B,OAAO,CAAC,iBAAiB;YAqBX,+BAA+B;IA6B7C,sBAAsB;IACT,QAAQ,CACnB,cAAc,EAAE,KAAK,CAAC,uBAAuB,CAAC,gBAAgB,EAAE,OAAO,EAAE,eAAe,CAAC,CAAC,GAAG,0BAA0B,GACtH,OAAO,CAAC,IAAI,EAAE,CAAC;IAWlB,6BAA6B;IAChB,aAAa,CACxB,cAAc,EAAE,uBAAuB,CAAC,gBAAgB,EAAE,OAAO,EAAE,eAAe,CAAC,GAAG,0BAA0B,GAC/G,OAAO,CAAC,MAAM,CAAC;IAOlB,8DAA8D;IACjD,gBAAgB,CAC3B,cAAc,EAAE,KAAK,CAAC,uBAAuB,CAAC,gBAAgB,EAAE,OAAO,EAAE,eAAe,CAAC,CAAC,GAAG,0BAA0B,GACtH,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,IAAI,EAAE,CAAA;KAAE,CAAC;IAc5C;;;OAGG;IACU,kBAAkB,CAC7B,cAAc,EAAE,sCAAsC,CAAC,gBAAgB,EAAE,OAAO,EAAE,eAAe,CAAC,GAAG,0BAA0B,GAC9H,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAalC,wHAAwH;IAC3G,YAAY,CACvB,cAAc,EAAE,4CAA4C,CAAC,gBAAgB,EAAE,eAAe,CAAC,GAAG,0BAA0B,GAC3H,OAAO,CAAC,eAAe,EAAE,CAAC;IAS7B,sFAAsF;IACzE,oBAAoB,CAC/B,cAAc,EAAE,mCAAmC,CAAC,gBAAgB,EAAE,eAAe,CAAC,GAAG,0BAA0B,GAClH,OAAO,CAAC,eAAe,EAAE,CAAC;IAQ7B;;;;OAIG;IACU,iBAAiB,CAAC,cAAc,EAAE,4BAA4B,CAAC,gBAAgB,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAOvJ,oGAAoG;IACvF,oBAAoB,CAC/B,cAAc,EAAE,+BAA+B,CAAC,gBAAgB,EAAE,MAAM,EAAE,eAAe,CAAC,GAAG,0BAA0B,GACtH,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAgBlC,0CAA0C;IAC7B,iBAAiB,CAC5B,cAAc,EAAE,qBAAqB,CAAC,gBAAgB,EAAE,UAAU,GAAG,mBAAmB,EAAE,MAAM,EAAE,eAAe,CAAC,GAAG,0BAA0B,GAC9I,OAAO,CAAC,MAAM,CAAC;IAWlB,sFAAsF;IACzE,UAAU,CACrB,cAAc,EAAE,KAAK,CAAC,qBAAqB,CAAC,gBAAgB,EAAE,UAAU,GAAG,mBAAmB,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC,GAAG,0BAA0B,GACrJ,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;IAI/B,2GAA2G;IAC9F,iBAAiB,CAC5B,cAAc,EAAE,KAAK,CAAC,qBAAqB,CAAC,gBAAgB,EAAE,UAAU,GAAG,mBAAmB,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC,GAAG,0BAA0B,GACrJ,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC;IA8C1D,oEAAoE;IACvD,sBAAsB,CACjC,cAAc,EAAE,4BAA4B,CAAC,gBAAgB,EAAE,UAAU,GAAG,mBAAmB,EAAE,MAAM,EAAE,eAAe,CAAC,GAAG,0BAA0B,GACrJ,OAAO,CAAC,aAAa,CAAC,iBAAiB,CAAC,CAAC;IAkB5C;;;OAGG;IACU,oBAAoB,CAC/B,cAAc,EAAE,qCAAqC,CAAC,gBAAgB,CAAC,GAAG,0BAA0B,GACnG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAUzC;;;OAGG;IACU,sBAAsB,CACjC,cAAc,EAAE,iCAAiC,CAAC,gBAAgB,EAAE,MAAM,EAAE,eAAe,CAAC,GAAG,0BAA0B,GACxH,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,cAAc,CAAC,WAAW,CAAC,CAAA;KAAE,CAAC;IA0BvE,2DAA2D;IAC9C,yBAAyB,CACpC,cAAc,EAAE,0BAA0B,CAAC,gBAAgB,EAAE,WAAW,CAAC,GAAG,0BAA0B,GACrG,OAAO,CAAC,eAAe,CAAC;IAO3B,4DAA4D;IAC/C,0BAA0B,CACrC,cAAc,EAAE,2BAA2B,CAAC,gBAAgB,EAAE,WAAW,CAAC,GAAG,0BAA0B,GACtG,OAAO,CAAC,eAAe,EAAE,CAAC;CAS9B;AAmDD,gBAAgB;AAChB,eAAO,MAAM,uBAAuB,yBACnB,WAAW,GAAG,SAAS,iBACvB,SAAS,WAAW,CAAC,gBAAgB,MAAM,oEAQ3D,CAAC"}
+{"version":3,"file":"PresentationManager.d.ts","sourceRoot":"","sources":["../../../src/presentation-frontend/PresentationManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAqB,WAAW,EAAuB,MAAM,qBAAqB,CAAC;AACnG,OAAO,EAAa,gBAAgB,EAAU,MAAM,sBAAsB,CAAC;AAC3E,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EACL,0BAA0B,EAC1B,OAAO,EACP,+BAA+B,EAE/B,iCAAiC,EAEjC,qBAAqB,EACrB,4BAA4B,EAC5B,iBAAiB,EACjB,UAAU,EACV,mBAAmB,EACnB,0BAA0B,EAC1B,2BAA2B,EAC3B,iBAAiB,EACjB,4BAA4B,EAC5B,iBAAiB,EACjB,4CAA4C,EAC5C,mCAAmC,EACnC,UAAU,EACV,sCAAsC,EACtC,uBAAuB,EACvB,mBAAmB,EACnB,WAAW,EACX,IAAI,EAGJ,MAAM,EAEN,eAAe,EACf,IAAI,EACJ,OAAO,EACP,eAAe,EACf,KAAK,EACL,aAAa,EAGb,kBAAkB,EAElB,eAAe,EACf,eAAe,EACf,qCAAqC,EAGtC,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAE,cAAc,EAAsB,MAAM,kBAAkB,CAAC;AACtE,OAAO,EAAE,uBAAuB,EAA+B,MAAM,2BAA2B,CAAC;AAIjG;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C,uDAAuD;IACvD,SAAS,EAAE,MAAM,CAAC;IAClB,8BAA8B;IAC9B,UAAU,EAAE,mBAAmB,CAAC;IAChC,qGAAqG;IACrG,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C,qDAAqD;IACrD,SAAS,EAAE,MAAM,CAAC;IAClB,4BAA4B;IAC5B,UAAU,EAAE,iBAAiB,CAAC;IAC9B,mGAAmG;IACnG,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,4BAA4B,GAAG,KAAK,CAAC;IAC/C,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,uBAAuB,CAAC,gBAAgB,EAAE,OAAO,EAAE,eAAe,CAAC,GAAG,0BAA0B,CAAC;AAEtI;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,qBAAqB,CAAC,gBAAgB,EAAE,UAAU,GAAG,mBAAmB,EAAE,MAAM,EAAE,eAAe,CAAC,GACvI,0BAA0B,CAAC;AAE7B;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG,4BAA4B,CAAC,gBAAgB,EAAE,UAAU,GAAG,mBAAmB,EAAE,MAAM,EAAE,eAAe,CAAC,GACrJ,0BAA0B,CAAC;AAE7B;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;;OAOG;IACH,gBAAgB,CAAC,EAAE,aAAa,CAAC;IAEjC;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,aAAa,CAAC;IAEpE;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,UAAU,CAAC;IAE5B,gBAAgB;IAChB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IAExC,gBAAgB;IAChB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CACzC;AAED;;;;;GAKG;AACH,qBAAa,mBAAoB,YAAW,WAAW;IACrD,OAAO,CAAC,gBAAgB,CAAqB;IAC7C,OAAO,CAAC,SAAS,CAAiB;IAClC,OAAO,CAAC,mBAAmB,CAA6B;IACxD,OAAO,CAAC,yBAAyB,CAA4B;IAC7D,OAAO,CAAC,YAAY,CAAuC;IAC3D,OAAO,CAAC,mBAAmB,CAAC,CAAa;IACzC,OAAO,CAAC,sBAAsB,CAAC,CAA8C;IAC7E,OAAO,CAAC,eAAe,CAAC,CAAa;IACrC,OAAO,CAAC,mBAAmB,CAAC,CAAqB;IAEjD;;;OAGG;IACI,wBAAwB,iBAAsB,8BAA8B,KAAK,IAAI,EAAI;IAEhG;;;OAGG;IACI,sBAAsB,iBAAsB,4BAA4B,KAAK,IAAI,EAAI;IAE5F;;;;;;OAMG;IACH,IAAW,gBAAgB,IAAI,aAAa,CAE3C;IACD,IAAW,gBAAgB,CAAC,KAAK,EAAE,aAAa,GAAG,SAAS,EAE3D;IAED,OAAO;IAqBP,oEAAoE;IACpE,IAAW,YAAY,IAAI,MAAM,GAAG,SAAS,CAE5C;IACD,IAAW,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,EAEjD;IAEM,OAAO;IAQd,OAAO,CAAC,QAAQ,CAGd;IAEF,wEAAwE;YAC1D,iBAAiB;IAyB/B;;;OAGG;IACI,yBAAyB,CAAC,CAAC,EAAE,gBAAgB;IAEpD;;;;OAIG;IACU,uBAAuB,CAAC,CAAC,EAAE,gBAAgB;IAExD;;;OAGG;WACW,MAAM,CAAC,KAAK,CAAC,EAAE,wBAAwB;IAIrD,gBAAgB;IAChB,IAAW,kBAAkB,uBAE5B;IAED,gBAAgB;IAChB,IAAW,kBAAkB,mCAE5B;IAED;;OAEG;IACI,QAAQ;IAIf;;;OAGG;IACI,IAAI,CAAC,SAAS,EAAE,MAAM;IAQ7B,OAAO,CAAC,iBAAiB;YAqBX,+BAA+B;IA6B7C,2DAA2D;IAC9C,gBAAgB,CAC3B,cAAc,EAAE,sBAAsB,GAAG,4BAA4B,GACpE,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,qBAAqB,CAAC,IAAI,CAAC,CAAA;KAAE,CAAC;IAoBjE;;;OAGG;IACU,QAAQ,CAAC,cAAc,EAAE,sBAAsB,GAAG,4BAA4B,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAK7G,6BAA6B;IAChB,aAAa,CAAC,cAAc,EAAE,sBAAsB,GAAG,OAAO,CAAC,MAAM,CAAC;IAOnF;;;OAGG;IACU,gBAAgB,CAAC,cAAc,EAAE,sBAAsB,GAAG,4BAA4B,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,IAAI,EAAE,CAAA;KAAE,CAAC;IAQ/I;;;OAGG;IACU,kBAAkB,CAC7B,cAAc,EAAE,sCAAsC,CAAC,gBAAgB,EAAE,OAAO,EAAE,eAAe,CAAC,GAAG,0BAA0B,GAC9H,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAalC,wHAAwH;IAC3G,YAAY,CACvB,cAAc,EAAE,4CAA4C,CAAC,gBAAgB,EAAE,eAAe,CAAC,GAAG,0BAA0B,GAC3H,OAAO,CAAC,eAAe,EAAE,CAAC;IAS7B,sFAAsF;IACzE,oBAAoB,CAC/B,cAAc,EAAE,mCAAmC,CAAC,gBAAgB,EAAE,eAAe,CAAC,GAAG,0BAA0B,GAClH,OAAO,CAAC,eAAe,EAAE,CAAC;IAQ7B;;;;OAIG;IACU,iBAAiB,CAAC,cAAc,EAAE,4BAA4B,CAAC,gBAAgB,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAOvJ,oGAAoG;IACvF,oBAAoB,CAC/B,cAAc,EAAE,+BAA+B,CAAC,gBAAgB,EAAE,MAAM,EAAE,eAAe,CAAC,GAAG,0BAA0B,GACtH,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAgBlC,0CAA0C;IAC7B,iBAAiB,CAAC,cAAc,EAAE,wBAAwB,GAAG,OAAO,CAAC,MAAM,CAAC;YAW3E,0BAA0B;IAiExC,+FAA+F;IAClF,kBAAkB,CAC7B,cAAc,EAAE,wBAAwB,GAAG,4BAA4B,GACtE,OAAO,CAAC;QAAE,UAAU,EAAE,UAAU,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,qBAAqB,CAAC,IAAI,CAAC,CAAA;KAAE,GAAG,SAAS,CAAC;IAWrG;;;OAGG;IACU,UAAU,CAAC,cAAc,EAAE,wBAAwB,GAAG,4BAA4B,GAAG,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;IAK9H;;;OAGG;IACU,iBAAiB,CAC5B,cAAc,EAAE,wBAAwB,GAAG,4BAA4B,GACtE,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC;IAc1D,wGAAwG;IAC3F,yBAAyB,CACpC,cAAc,EAAE,+BAA+B,GAAG,4BAA4B,GAC7E,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,qBAAqB,CAAC,iBAAiB,CAAC,CAAA;KAAE,CAAC;IAwB9E;;;OAGG;IACU,sBAAsB,CACjC,cAAc,EAAE,+BAA+B,GAAG,4BAA4B,GAC7E,OAAO,CAAC,aAAa,CAAC,iBAAiB,CAAC,CAAC;IAQ5C;;;OAGG;IACU,oBAAoB,CAC/B,cAAc,EAAE,qCAAqC,CAAC,gBAAgB,CAAC,GAAG,0BAA0B,GACnG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAUzC;;;OAGG;IACU,sBAAsB,CACjC,cAAc,EAAE,iCAAiC,CAAC,gBAAgB,EAAE,MAAM,EAAE,eAAe,CAAC,GAAG,0BAA0B,GAAG,4BAA4B,GACvJ,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,cAAc,CAAC,WAAW,CAAC,CAAA;KAAE,CAAC;IAiCvE,2DAA2D;IAC9C,yBAAyB,CACpC,cAAc,EAAE,0BAA0B,CAAC,gBAAgB,EAAE,WAAW,CAAC,GAAG,0BAA0B,GACrG,OAAO,CAAC,eAAe,CAAC;IAO3B,4DAA4D;IAC/C,kCAAkC,CAC7C,cAAc,EAAE,2BAA2B,CAAC,gBAAgB,EAAE,WAAW,CAAC,GAAG,0BAA0B,GAAG,4BAA4B,GACrI,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,qBAAqB,CAAC,eAAe,CAAC,CAAA;KAAE,CAAC;IAgB5E;;;OAGG;IACU,0BAA0B,CACrC,cAAc,EAAE,2BAA2B,CAAC,gBAAgB,EAAE,WAAW,CAAC,GAAG,0BAA0B,GAAG,4BAA4B,GACrI,OAAO,CAAC,eAAe,EAAE,CAAC;CAI9B"}

package/lib/esm/presentation-frontend/PresentationManager.js

@@ -13,6 +13,7 @@ import { FrontendLocalizationHelper } from "./LocalizationHelper";
 import { RulesetManagerImpl } from "./RulesetManager";
 import { RulesetVariablesManagerImpl } from "./RulesetVariablesManager";
 import { TRANSIENT_ELEMENT_CLASSNAME } from "./selection/SelectionManager";
+import { StreamedResponseGenerator } from "./StreamedResponseGenerator";
 /**
  * Frontend Presentation manager which basically just forwards all calls to
  * the backend implementation.
@@ -189,14 +190,31 @@ export class PresentationManager {
         }
         return { ...options, rulesetOrId: foundRulesetOrId, rulesetVariables: variables };
     }
-    /** Retrieves nodes */
-    async getNodes(requestOptions) {
+    /** Returns an iterator that polls nodes asynchronously. */
+    async getNodesIterator(requestOptions) {
         this.startIModelInitialization(requestOptions.imodel);
         const options = await this.addRulesetAndVariablesToOptions(requestOptions);
         const rpcOptions = this.toRpcTokenOptions({ ...options });
-        const result = await buildPagedArrayResponse(options.paging, async (partialPageOptions) => this._requestsHandler.getPagedNodes({ ...rpcOptions, paging: partialPageOptions }));
-        // eslint-disable-next-line deprecation/deprecation
-        return this._localizationHelper.getLocalizedNodes(result.items.map(Node.fromJSON));
+        const generator = new StreamedResponseGenerator({
+            ...requestOptions,
+            getBatch: async (paging) => {
+                const result = await this._requestsHandler.getPagedNodes({ ...rpcOptions, paging });
+                return {
+                    total: result.total,
+                    // eslint-disable-next-line deprecation/deprecation
+                    items: this._localizationHelper.getLocalizedNodes(result.items.map(Node.fromJSON)),
+                };
+            },
+        });
+        return generator.createAsyncIteratorResponse();
+    }
+    /**
+     * Retrieves nodes
+     * @deprecated in 4.5. Use [[getNodesIterator]] instead.
+     */
+    async getNodes(requestOptions) {
+        const result = await this.getNodesIterator(requestOptions);
+        return collect(result.items);
     }
     /** Retrieves nodes count. */
     async getNodesCount(requestOptions) {
@@ -205,16 +223,15 @@ export class PresentationManager {
         const rpcOptions = this.toRpcTokenOptions({ ...options });
         return this._requestsHandler.getNodesCount(rpcOptions);
     }
-    /** Retrieves total nodes count and a single page of nodes. */
+    /**
+     * Retrieves total nodes count and a single page of nodes.
+     * @deprecated in 4.5. Use [[getNodesIterator]] instead.
+     */
     async getNodesAndCount(requestOptions) {
-        this.startIModelInitialization(requestOptions.imodel);
-        const options = await this.addRulesetAndVariablesToOptions(requestOptions);
-        const rpcOptions = this.toRpcTokenOptions({ ...options });
-        const result = await buildPagedArrayResponse(options.paging, async (partialPageOptions) => this._requestsHandler.getPagedNodes({ ...rpcOptions, paging: partialPageOptions }));
+        const result = await this.getNodesIterator(requestOptions);
         return {
             count: result.total,
-            // eslint-disable-next-line deprecation/deprecation
-            nodes: this._localizationHelper.getLocalizedNodes(result.items.map(Node.fromJSON)),
+            nodes: await collect(result.items),
         };
     }
     /**
@@ -290,54 +307,92 @@ export class PresentationManager {
         });
         return this._requestsHandler.getContentSetSize(rpcOptions);
     }
-    /** Retrieves content which consists of a content descriptor and a page of records. */
-    async getContent(requestOptions) {
-        return (await this.getContentAndSize(requestOptions))?.content;
-    }
-    /** Retrieves content set size and content which consists of a content descriptor and a page of records. */
-    async getContentAndSize(requestOptions) {
-        this.startIModelInitialization(requestOptions.imodel);
-        try {
-            const options = await this.addRulesetAndVariablesToOptions(requestOptions);
-            const rpcOptions = this.toRpcTokenOptions({
-                ...options,
-                descriptor: getDescriptorOverrides(requestOptions.descriptor),
-                keys: stripTransientElementKeys(requestOptions.keys).toJSON(),
-                ...(!requestOptions.omitFormattedValues && this._schemaContextProvider !== undefined ? { omitFormattedValues: true } : undefined),
-            });
-            let descriptor = requestOptions.descriptor instanceof Descriptor ? requestOptions.descriptor : undefined;
-            const result = await buildPagedArrayResponse(options.paging, async (partialPageOptions, requestIndex) => {
-                if (0 === requestIndex && !descriptor) {
-                    const content = await this._requestsHandler.getPagedContent({ ...rpcOptions, paging: partialPageOptions });
-                    if (content) {
-                        descriptor = Descriptor.fromJSON(content.descriptor);
-                        return content.contentSet;
-                    }
-                    return { total: 0, items: [] };
-                }
-                return this._requestsHandler.getPagedContentSet({ ...rpcOptions, paging: partialPageOptions });
-            });
-            if (!descriptor) {
+    async getContentIteratorInternal(requestOptions) {
+        const options = await this.addRulesetAndVariablesToOptions(requestOptions);
+        const rpcOptions = this.toRpcTokenOptions({
+            ...options,
+            descriptor: getDescriptorOverrides(requestOptions.descriptor),
+            keys: stripTransientElementKeys(requestOptions.keys).toJSON(),
+            ...(!requestOptions.omitFormattedValues && this._schemaContextProvider !== undefined ? { omitFormattedValues: true } : undefined),
+        });
+        let contentFormatter;
+        if (!requestOptions.omitFormattedValues && this._schemaContextProvider) {
+            const koqPropertyFormatter = new KoqPropertyValueFormatter(this._schemaContextProvider(requestOptions.imodel), this._defaultFormats);
+            contentFormatter = new ContentFormatter(new ContentPropertyValueFormatter(koqPropertyFormatter), requestOptions.unitSystem ?? this._explicitActiveUnitSystem ?? IModelApp.quantityFormatter.activeUnitSystem);
+        }
+        let descriptor = requestOptions.descriptor instanceof Descriptor ? requestOptions.descriptor : undefined;
+        let firstPage;
+        if (!descriptor) {
+            const firstPageResponse = await this._requestsHandler.getPagedContent(rpcOptions);
+            if (!firstPageResponse?.descriptor || !firstPageResponse.contentSet) {
                 return undefined;
             }
-            const items = result.items.map((itemJson) => Item.fromJSON(itemJson)).filter((item) => item !== undefined);
-            const resultContent = new Content(descriptor, items);
-            if (!requestOptions.omitFormattedValues && this._schemaContextProvider) {
-                const koqPropertyFormatter = new KoqPropertyValueFormatter(this._schemaContextProvider(requestOptions.imodel), this._defaultFormats);
-                const contentFormatter = new ContentFormatter(new ContentPropertyValueFormatter(koqPropertyFormatter), requestOptions.unitSystem ?? this._explicitActiveUnitSystem ?? IModelApp.quantityFormatter.activeUnitSystem);
-                await contentFormatter.formatContent(resultContent);
+            descriptor = Descriptor.fromJSON(firstPageResponse?.descriptor);
+            firstPage = firstPageResponse?.contentSet;
+        }
+        // istanbul ignore if
+        if (!descriptor) {
+            return undefined;
+        }
+        descriptor = this._localizationHelper.getLocalizedContentDescriptor(descriptor);
+        const getPage = async (paging, requestIndex) => {
+            let contentSet = requestIndex === 0 ? firstPage : undefined;
+            contentSet ??= await this._requestsHandler.getPagedContentSet({ ...rpcOptions, paging });
+            let items = contentSet.items.map((x) => Item.fromJSON(x)).filter((x) => x !== undefined);
+            if (contentFormatter) {
+                items = await contentFormatter.formatContentItems(items, descriptor);
             }
+            items = this._localizationHelper.getLocalizedContentItems(items);
             return {
-                size: result.total,
-                content: this._localizationHelper.getLocalizedContent(resultContent),
+                total: contentSet.total,
+                items,
             };
+        };
+        const generator = new StreamedResponseGenerator({
+            ...requestOptions,
+            getBatch: getPage,
+        });
+        return {
+            ...(await generator.createAsyncIteratorResponse()),
+            descriptor,
+        };
+    }
+    /** Retrieves a content descriptor, item count and async generator for the items themselves. */
+    async getContentIterator(requestOptions) {
+        this.startIModelInitialization(requestOptions.imodel);
+        const response = await this.getContentIteratorInternal(requestOptions);
+        if (!response) {
+            return undefined;
         }
-        finally {
-            await this.ensureIModelInitialized(requestOptions.imodel);
+        await this.ensureIModelInitialized(requestOptions.imodel);
+        return response;
+    }
+    /**
+     * Retrieves content which consists of a content descriptor and a page of records.
+     * @deprecated in 4.5. Use [[getContentIterator]] instead.
+     */
+    async getContent(requestOptions) {
+        // eslint-disable-next-line deprecation/deprecation
+        return (await this.getContentAndSize(requestOptions))?.content;
+    }
+    /**
+     * Retrieves content set size and content which consists of a content descriptor and a page of records.
+     * @deprecated in 4.5. Use [[getContentIterator]] instead.
+     */
+    async getContentAndSize(requestOptions) {
+        const response = await this.getContentIterator(requestOptions);
+        if (!response) {
+            return undefined;
         }
+        const { descriptor, total } = response;
+        const items = await collect(response.items);
+        return {
+            content: new Content(descriptor, items),
+            size: total,
+        };
     }
-    /** Retrieves distinct values of specific field from the content. */
-    async getPagedDistinctValues(requestOptions) {
+    /** Returns an iterator that asynchronously polls distinct values of specific field from the content. */
+    async getDistinctValuesIterator(requestOptions) {
         this.startIModelInitialization(requestOptions.imodel);
         const options = await this.addRulesetAndVariablesToOptions(requestOptions);
         const rpcOptions = {
@@ -345,11 +400,28 @@ export class PresentationManager {
             descriptor: getDescriptorOverrides(options.descriptor),
             keys: stripTransientElementKeys(options.keys).toJSON(),
         };
-        const result = await buildPagedArrayResponse(requestOptions.paging, async (partialPageOptions) => this._requestsHandler.getPagedDistinctValues({ ...rpcOptions, paging: partialPageOptions }));
+        const generator = new StreamedResponseGenerator({
+            ...requestOptions,
+            getBatch: async (paging) => {
+                const response = await this._requestsHandler.getPagedDistinctValues({ ...rpcOptions, paging });
+                return {
+                    total: response.total,
+                    // eslint-disable-next-line deprecation/deprecation
+                    items: response.items.map((x) => this._localizationHelper.getLocalizedDisplayValueGroup(DisplayValueGroup.fromJSON(x))),
+                };
+            },
+        });
+        return generator.createAsyncIteratorResponse();
+    }
+    /**
+     * Retrieves distinct values of specific field from the content.
+     * @deprecated in 4.5. Use [[getDistinctValuesIterator]] instead.
+     */
+    async getPagedDistinctValues(requestOptions) {
+        const result = await this.getDistinctValuesIterator(requestOptions);
         return {
-            ...result,
-            // eslint-disable-next-line deprecation/deprecation
-            items: result.items.map(DisplayValueGroup.fromJSON).map((g) => this._localizationHelper.getLocalizedDisplayValueGroup(g)),
+            total: result.total,
+            items: await collect(result.items),
         };
     }
     /**
@@ -376,9 +448,9 @@ export class PresentationManager {
             ...this.toRpcTokenOptions(options),
             keys: stripTransientElementKeys(options.keys).toJSON(),
         };
-        const props = {
-            page: requestOptions.paging,
-            get: async (page) => {
+        const generator = new StreamedResponseGenerator({
+            ...requestOptions,
+            getBatch: async (page) => {
                 const keys = await this._requestsHandler.getContentInstanceKeys({ ...rpcOptions, paging: page });
                 return {
                     total: keys.total,
@@ -390,8 +462,14 @@ export class PresentationManager {
                     }, new Array()),
                 };
             },
+        });
+        const { total, items } = await generator.createAsyncIteratorResponse();
+        return {
+            total,
+            async *items() {
+                yield* items;
+            },
         };
-        return createPagedGeneratorResponse(props);
     }
     /** Retrieves display label definition of specific item. */
     async getDisplayLabelDefinition(requestOptions) {
@@ -401,14 +479,27 @@ export class PresentationManager {
         return this._localizationHelper.getLocalizedLabelDefinition(result);
     }
     /** Retrieves display label definition of specific items. */
-    async getDisplayLabelDefinitions(requestOptions) {
+    async getDisplayLabelDefinitionsIterator(requestOptions) {
         this.startIModelInitialization(requestOptions.imodel);
         const rpcOptions = this.toRpcTokenOptions({ ...requestOptions });
-        const result = await buildPagedArrayResponse(undefined, async (partialPageOptions) => {
-            const partialKeys = !partialPageOptions.start ? rpcOptions.keys : rpcOptions.keys.slice(partialPageOptions.start);
-            return this._requestsHandler.getPagedDisplayLabelDefinitions({ ...rpcOptions, keys: partialKeys });
+        const generator = new StreamedResponseGenerator({
+            ...requestOptions,
+            getBatch: async (page) => {
+                const partialKeys = !page.start ? rpcOptions.keys : rpcOptions.keys.slice(page.start);
+                const result = await this._requestsHandler.getPagedDisplayLabelDefinitions({ ...rpcOptions, keys: partialKeys });
+                result.items = this._localizationHelper.getLocalizedLabelDefinitions(result.items);
+                return result;
+            },
         });
-        return this._localizationHelper.getLocalizedLabelDefinitions(result.items);
+        return generator.createAsyncIteratorResponse();
+    }
+    /**
+     * Retrieves display label definition of specific items.
+     * @deprecated in 4.5. Use [[getDisplayLabelDefinitionsIterator]] instead.
+     */
+    async getDisplayLabelDefinitions(requestOptions) {
+        const { items } = await this.getDisplayLabelDefinitionsIterator(requestOptions);
+        return collect(items);
     }
 }
 const getDescriptorOverrides = (descriptorOrOverrides) => {
@@ -417,47 +508,6 @@ const getDescriptorOverrides = (descriptorOrOverrides) => {
     }
     return descriptorOrOverrides;
 };
-async function createPagedGeneratorResponse(props) {
-    let pageStart = props.page?.start ?? 0;
-    let pageSize = props.page?.size ?? 0;
-    let requestIndex = 0;
-    const firstPage = await props.get({ start: pageStart, size: pageSize }, requestIndex++);
-    return {
-        total: firstPage.total,
-        async *items() {
-            let partialResult = firstPage;
-            while (true) {
-                for (const item of partialResult.items) {
-                    yield item;
-                }
-                const receivedItemsCount = partialResult.items.length;
-                if (partialResult.total !== 0 && receivedItemsCount === 0) {
-                    if (pageStart >= partialResult.total) {
-                        throw new Error(`Requested page with start index ${pageStart} is out of bounds. Total number of items: ${partialResult.total}`);
-                    }
-                    throw new Error("Paged request returned non zero total count but no items");
-                }
-                if ((pageSize !== 0 && receivedItemsCount >= pageSize) || receivedItemsCount >= partialResult.total - pageStart) {
-                    break;
-                }
-                if (pageSize !== 0) {
-                    pageSize -= receivedItemsCount;
-                }
-                pageStart += receivedItemsCount;
-                partialResult = await props.get({ start: pageStart, size: pageSize }, requestIndex++);
-            }
-        },
-    };
-}
-/** @internal */
-export const buildPagedArrayResponse = async (requestedPage, getter) => {
-    const items = new Array();
-    const gen = await createPagedGeneratorResponse({ page: requestedPage, get: getter });
-    for await (const item of gen.items()) {
-        items.push(item);
-    }
-    return { total: gen.total, items };
-};
 const stripTransientElementKeys = (keys) => {
     if (!keys.some((key) => Key.isInstanceKey(key) && key.className === TRANSIENT_ELEMENT_CLASSNAME)) {
         return keys;
@@ -473,4 +523,11 @@ const stripTransientElementKeys = (keys) => {
     });
     return copy;
 };
+async function collect(iter) {
+    const result = new Array();
+    for await (const value of iter) {
+        result.push(value);
+    }
+    return result;
+}
 //# sourceMappingURL=PresentationManager.js.map