@itwin/presentation-common 4.0.0-dev.6 → 4.0.0-dev.60

package/lib/esm/presentation-common/RegisteredRuleset.js

@@ -1,30 +1,30 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Core
- */
-/**
- * A ruleset that is registered in a ruleset manager.
- * @public
- */
-export class RegisteredRuleset {
-    /** Create a registered ruleset */
-    constructor(ruleset, uniqueIdentifier, disposeFunc) {
-        this._disposeFunc = disposeFunc;
-        this._ruleset = ruleset;
-        this._uniqueIdentifier = uniqueIdentifier;
-    }
-    /** Dispose registered ruleset. */
-    dispose() {
-        this._disposeFunc(this);
-    }
-    get uniqueIdentifier() { return this._uniqueIdentifier; }
-    get id() { return this._ruleset.id; }
-    get supplementationInfo() { return this._ruleset.supplementationInfo; }
-    get rules() { return this._ruleset.rules; }
-    get vars() { return this._ruleset.vars; }
-    toJSON() { return this._ruleset; }
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Core
+ */
+/**
+ * A ruleset that is registered in a ruleset manager.
+ * @public
+ */
+export class RegisteredRuleset {
+    /** Create a registered ruleset */
+    constructor(ruleset, uniqueIdentifier, disposeFunc) {
+        this._disposeFunc = disposeFunc;
+        this._ruleset = ruleset;
+        this._uniqueIdentifier = uniqueIdentifier;
+    }
+    /** Dispose registered ruleset. */
+    dispose() {
+        this._disposeFunc(this);
+    }
+    get uniqueIdentifier() { return this._uniqueIdentifier; }
+    get id() { return this._ruleset.id; }
+    get supplementationInfo() { return this._ruleset.supplementationInfo; }
+    get rules() { return this._ruleset.rules; }
+    get vars() { return this._ruleset.vars; }
+    toJSON() { return this._ruleset; }
+}
 //# sourceMappingURL=RegisteredRuleset.js.map

package/lib/esm/presentation-common/RpcRequestsHandler.d.ts

@@ -1,84 +1,83 @@
-/** @packageDocumentation
- * @module RPC
- */
-import { IDisposable } from "@itwin/core-bentley";
-import { IModelRpcProps } from "@itwin/core-common";
-import { DescriptorJSON, DescriptorOverrides } from "./content/Descriptor";
-import { ItemJSON } from "./content/Item";
-import { DisplayValueGroupJSON } from "./content/Value";
-import { ClientDiagnosticsAttribute } from "./Diagnostics";
-import { InstanceKey } from "./EC";
-import { ElementProperties } from "./ElementProperties";
-import { NodeKey } from "./hierarchy/Key";
-import { NodeJSON } from "./hierarchy/Node";
-import { NodePathElementJSON } from "./hierarchy/NodePathElement";
-import { KeySetJSON } from "./KeySet";
-import { LabelDefinition } from "./LabelDefinition";
-import { ComputeSelectionRequestOptions, ContentDescriptorRequestOptions, ContentInstanceKeysRequestOptions, ContentRequestOptions, ContentSourcesRequestOptions, DisplayLabelRequestOptions, DisplayLabelsRequestOptions, DistinctValuesRequestOptions, FilterByInstancePathsHierarchyRequestOptions, FilterByTextHierarchyRequestOptions, HierarchyLevelDescriptorRequestOptions, HierarchyRequestOptions, Paged, RequestOptions, SelectionScopeRequestOptions, SingleElementPropertiesRequestOptions } from "./PresentationManagerOptions";
-import { ContentSourcesRpcResult, PresentationRpcRequestOptions, PresentationRpcResponse } from "./PresentationRpcInterface";
-import { RulesetVariableJSON } from "./RulesetVariables";
-import { SelectionScope } from "./selection/SelectionScope";
-import { PagedResponse } from "./Utils";
-/**
- * Configuration parameters for [[RpcRequestsHandler]].
- *
- * @internal
- */
-export interface RpcRequestsHandlerProps {
-    /**
-     * Optional ID used to identify client that requests data. If not specified,
-     * the handler creates a unique GUID as a client id.
-     * @internal
-     */
-    clientId?: string;
-}
-/**
- * RPC requests handler that wraps [[PresentationRpcInterface]] and
- * adds handling for cases when backend needs to be synced with client
- * state.
- *
- * @internal
- */
-export declare class RpcRequestsHandler implements IDisposable {
-    readonly maxRequestRepeatCount: number;
-    /** ID that identifies this handler as a client */
-    readonly clientId: string;
-    constructor(props?: RpcRequestsHandlerProps);
-    dispose(): void;
-    private get rpcClient();
-    private requestRepeatedly;
-    /**
-     * Send the request to backend.
-     *
-     * If the backend responds with [[PresentationStatus.BackendTimeout]] or there's an RPC-related error,
-     * the request is repeated up to `this._maxRequestRepeatCount` times. If we fail to get a valid success or error
-     * response from the backend, throw the last encountered error.
-     *
-     * @internal
-     */
-    request<TResult, TOptions extends (RequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute), TArg = any>(func: (token: IModelRpcProps, options: PresentationRpcRequestOptions<TOptions>, ...args: TArg[]) => PresentationRpcResponse<TResult>, options: TOptions, ...additionalOptions: TArg[]): Promise<TResult>;
-    getNodesCount(options: HierarchyRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<number>;
-    getPagedNodes(options: Paged<HierarchyRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON>> & ClientDiagnosticsAttribute): Promise<PagedResponse<NodeJSON>>;
-    getNodesDescriptor(options: HierarchyLevelDescriptorRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<DescriptorJSON | undefined>;
-    getNodePaths(options: FilterByInstancePathsHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<NodePathElementJSON[]>;
-    getFilteredNodePaths(options: FilterByTextHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<NodePathElementJSON[]>;
-    getContentSources(options: ContentSourcesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ContentSourcesRpcResult>;
-    getContentDescriptor(options: ContentDescriptorRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<DescriptorJSON | undefined>;
-    getContentSetSize(options: ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<number>;
-    getPagedContent(options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>): Promise<{
-        descriptor: DescriptorJSON;
-        contentSet: PagedResponse<ItemJSON>;
-    } | undefined>;
-    getPagedContentSet(options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>): Promise<PagedResponse<ItemJSON>>;
-    getPagedDistinctValues(options: DistinctValuesRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<PagedResponse<DisplayValueGroupJSON>>;
-    getElementProperties(options: SingleElementPropertiesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ElementProperties | undefined>;
-    getContentInstanceKeys(options: ContentInstanceKeysRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<{
-        total: number;
-        items: KeySetJSON;
-    }>;
-    getDisplayLabelDefinition(options: DisplayLabelRequestOptions<IModelRpcProps, InstanceKey> & ClientDiagnosticsAttribute): Promise<LabelDefinition>;
-    getPagedDisplayLabelDefinitions(options: DisplayLabelsRequestOptions<IModelRpcProps, InstanceKey> & ClientDiagnosticsAttribute): Promise<PagedResponse<LabelDefinition>>;
-    getSelectionScopes(options: SelectionScopeRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<SelectionScope[]>;
-    computeSelection(options: ComputeSelectionRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<KeySetJSON>;
-}
+/** @packageDocumentation
+ * @module RPC
+ */
+import { IModelRpcProps } from "@itwin/core-common";
+import { DescriptorJSON, DescriptorOverrides } from "./content/Descriptor";
+import { ItemJSON } from "./content/Item";
+import { DisplayValueGroupJSON } from "./content/Value";
+import { ClientDiagnosticsAttribute } from "./Diagnostics";
+import { InstanceKey } from "./EC";
+import { ElementProperties } from "./ElementProperties";
+import { NodeKey } from "./hierarchy/Key";
+import { NodeJSON } from "./hierarchy/Node";
+import { NodePathElementJSON } from "./hierarchy/NodePathElement";
+import { KeySetJSON } from "./KeySet";
+import { LabelDefinition } from "./LabelDefinition";
+import { ComputeSelectionRequestOptions, ContentDescriptorRequestOptions, ContentInstanceKeysRequestOptions, ContentRequestOptions, ContentSourcesRequestOptions, DisplayLabelRequestOptions, DisplayLabelsRequestOptions, DistinctValuesRequestOptions, FilterByInstancePathsHierarchyRequestOptions, FilterByTextHierarchyRequestOptions, HierarchyLevelDescriptorRequestOptions, HierarchyRequestOptions, Paged, RequestOptions, SelectionScopeRequestOptions, SingleElementPropertiesRequestOptions } from "./PresentationManagerOptions";
+import { ContentSourcesRpcResult, PresentationRpcRequestOptions, PresentationRpcResponse } from "./PresentationRpcInterface";
+import { RulesetVariableJSON } from "./RulesetVariables";
+import { SelectionScope } from "./selection/SelectionScope";
+import { PagedResponse } from "./Utils";
+/**
+ * Configuration parameters for [[RpcRequestsHandler]].
+ *
+ * @internal
+ */
+export interface RpcRequestsHandlerProps {
+    /**
+     * Optional ID used to identify client that requests data. If not specified,
+     * the handler creates a unique GUID as a client id.
+     * @internal
+     */
+    clientId?: string;
+    /** @internal */
+    timeout?: number;
+}
+/**
+ * RPC requests handler that wraps [[PresentationRpcInterface]] and
+ * adds handling for cases when backend needs to be synced with client
+ * state.
+ *
+ * @internal
+ */
+export declare class RpcRequestsHandler {
+    /** Timeout for how long the handler going to wait for RPC request to be fulfilled before throwing a timeout error. */
+    readonly timeout: number;
+    /** ID that identifies this handler as a client */
+    readonly clientId: string;
+    constructor(props?: RpcRequestsHandlerProps);
+    private get rpcClient();
+    private requestWithTimeout;
+    /**
+     * Send the request to backend.
+     *
+     * If the backend responds with [[PresentationStatus.BackendTimeout]], the request is repeated until we hit `timeout` or get
+     * a response. If the response is other than [[PresentationStatus.BackendTimeout]] or [[PresentationStatus.Success]], a [[PresentationError]]
+     * is thrown with the details from the response.
+     */
+    request<TResult, TOptions extends (RequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute), TArg = any>(func: (token: IModelRpcProps, options: PresentationRpcRequestOptions<TOptions>, ...args: TArg[]) => PresentationRpcResponse<TResult>, options: TOptions, ...additionalOptions: TArg[]): Promise<TResult>;
+    getNodesCount(options: HierarchyRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<number>;
+    getPagedNodes(options: Paged<HierarchyRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON>> & ClientDiagnosticsAttribute): Promise<PagedResponse<NodeJSON>>;
+    getNodesDescriptor(options: HierarchyLevelDescriptorRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<DescriptorJSON | undefined>;
+    getNodePaths(options: FilterByInstancePathsHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<NodePathElementJSON[]>;
+    getFilteredNodePaths(options: FilterByTextHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<NodePathElementJSON[]>;
+    getContentSources(options: ContentSourcesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ContentSourcesRpcResult>;
+    getContentDescriptor(options: ContentDescriptorRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<DescriptorJSON | undefined>;
+    getContentSetSize(options: ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<number>;
+    getPagedContent(options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>): Promise<{
+        descriptor: DescriptorJSON;
+        contentSet: PagedResponse<ItemJSON>;
+    } | undefined>;
+    getPagedContentSet(options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>): Promise<PagedResponse<ItemJSON>>;
+    getPagedDistinctValues(options: DistinctValuesRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<PagedResponse<DisplayValueGroupJSON>>;
+    getElementProperties(options: SingleElementPropertiesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ElementProperties | undefined>;
+    getContentInstanceKeys(options: ContentInstanceKeysRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<{
+        total: number;
+        items: KeySetJSON;
+    }>;
+    getDisplayLabelDefinition(options: DisplayLabelRequestOptions<IModelRpcProps, InstanceKey> & ClientDiagnosticsAttribute): Promise<LabelDefinition>;
+    getPagedDisplayLabelDefinitions(options: DisplayLabelsRequestOptions<IModelRpcProps, InstanceKey> & ClientDiagnosticsAttribute): Promise<PagedResponse<LabelDefinition>>;
+    getSelectionScopes(options: SelectionScopeRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<SelectionScope[]>;
+    computeSelection(options: ComputeSelectionRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<KeySetJSON>;
+}
 //# sourceMappingURL=RpcRequestsHandler.d.ts.map

package/lib/esm/presentation-common/RpcRequestsHandler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RpcRequestsHandler.d.ts","sourceRoot":"","sources":["../../../src/presentation-common/RpcRequestsHandler.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAQ,WAAW,EAAU,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,cAAc,EAAc,MAAM,oBAAoB,CAAC;AAEhE,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAC3E,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAqB,0BAA0B,EAA4B,MAAM,eAAe,CAAC;AACxG,OAAO,EAAE,WAAW,EAAE,MAAM,MAAM,CAAC;AACnC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EACL,8BAA8B,EAAE,+BAA+B,EAAE,iCAAiC,EAAE,qBAAqB,EACzH,4BAA4B,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,4BAA4B,EACnH,4CAA4C,EAAE,mCAAmC,EAAE,sCAAsC,EAAE,uBAAuB,EAClJ,KAAK,EAAE,cAAc,EAA6B,4BAA4B,EAAE,qCAAqC,EACtH,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,uBAAuB,EAA4B,6BAA6B,EAAE,uBAAuB,EAC1G,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;GAMG;AACH,qBAAa,kBAAmB,YAAW,WAAW;IACpD,SAAgB,qBAAqB,EAAE,MAAM,CAAK;IAElD,kDAAkD;IAClD,SAAgB,QAAQ,EAAE,MAAM,CAAC;gBAEd,KAAK,CAAC,EAAE,uBAAuB;IAI3C,OAAO;IAId,OAAO,KAAK,SAAS,GAAmG;YAE1G,iBAAiB;IAiC/B;;;;;;;;OAQG;IACU,OAAO,CAAC,OAAO,EAAE,QAAQ,SAAS,CAAC,cAAc,CAAC,cAAc,CAAC,GAAG,0BAA0B,CAAC,EAAE,IAAI,GAAG,GAAG,EACtH,IAAI,EAAE,CAAC,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,6BAA6B,CAAC,QAAQ,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,KAAK,uBAAuB,CAAC,OAAO,CAAC,EACpI,OAAO,EAAE,QAAQ,EACjB,GAAG,iBAAiB,EAAE,IAAI,EAAE,GAC3B,OAAO,CAAC,OAAO,CAAC;IAeN,aAAa,CAAC,OAAO,EAAE,uBAAuB,CAAC,cAAc,EAAE,OAAO,EAAE,mBAAmB,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,MAAM,CAAC;IAK3I,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,uBAAuB,CAAC,cAAc,EAAE,OAAO,EAAE,mBAAmB,CAAC,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAMnK,kBAAkB,CAAC,OAAO,EAAE,sCAAsC,CAAC,cAAc,EAAE,OAAO,EAAE,mBAAmB,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IASnL,YAAY,CAAC,OAAO,EAAE,4CAA4C,CAAC,cAAc,EAAE,mBAAmB,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAMrK,oBAAoB,CAAC,OAAO,EAAE,mCAAmC,CAAC,cAAc,EAAE,mBAAmB,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAMpK,iBAAiB,CAAC,OAAO,EAAE,4BAA4B,CAAC,cAAc,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAIvI,oBAAoB,CAAC,OAAO,EAAE,+BAA+B,CAAC,cAAc,EAAE,UAAU,EAAE,mBAAmB,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IAIjL,iBAAiB,CAAC,OAAO,EAAE,qBAAqB,CAAC,cAAc,EAAE,mBAAmB,EAAE,UAAU,EAAE,mBAAmB,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,MAAM,CAAC;IAIrK,eAAe,CAAC,OAAO,EAAE,KAAK,CAAC,qBAAqB,CAAC,cAAc,EAAE,mBAAmB,EAAE,UAAU,EAAE,mBAAmB,CAAC,GAAG,0BAA0B,CAAC;oBACjI,cAAc;oBAAc,cAAc,QAAQ,CAAC;;IAG1E,kBAAkB,CAAC,OAAO,EAAE,KAAK,CAAC,qBAAqB,CAAC,cAAc,EAAE,mBAAmB,EAAE,UAAU,EAAE,mBAAmB,CAAC,GAAG,0BAA0B,CAAC;IAM3J,sBAAsB,CAAC,OAAO,EAAE,4BAA4B,CAAC,cAAc,EAAE,mBAAmB,EAAE,UAAU,EAAE,mBAAmB,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC;IAM/M,oBAAoB,CAAC,OAAO,EAAE,qCAAqC,CAAC,cAAc,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAKzJ,sBAAsB,CAAC,OAAO,EAAE,iCAAiC,CAAC,cAAc,EAAE,UAAU,EAAE,mBAAmB,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,UAAU,CAAA;KAAE,CAAC;IAK/L,yBAAyB,CAAC,OAAO,EAAE,0BAA0B,CAAC,cAAc,EAAE,WAAW,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,eAAe,CAAC;IAIlJ,+BAA+B,CAAC,OAAO,EAAE,2BAA2B,CAAC,cAAc,EAAE,WAAW,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;IAKxK,kBAAkB,CAAC,OAAO,EAAE,4BAA4B,CAAC,cAAc,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAIjI,gBAAgB,CAAC,OAAO,EAAE,8BAA8B,CAAC,cAAc,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,UAAU,CAAC;CAKzI"}
+{"version":3,"file":"RpcRequestsHandler.d.ts","sourceRoot":"","sources":["../../../src/presentation-common/RpcRequestsHandler.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,cAAc,EAAc,MAAM,oBAAoB,CAAC;AAEhE,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAC3E,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAqB,0BAA0B,EAA4B,MAAM,eAAe,CAAC;AACxG,OAAO,EAAE,WAAW,EAAE,MAAM,MAAM,CAAC;AACnC,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EACL,8BAA8B,EAAE,+BAA+B,EAAE,iCAAiC,EAAE,qBAAqB,EACzH,4BAA4B,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,4BAA4B,EACnH,4CAA4C,EAAE,mCAAmC,EAAE,sCAAsC,EAAE,uBAAuB,EAClJ,KAAK,EAAE,cAAc,EAA6B,4BAA4B,EAAE,qCAAqC,EACtH,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,uBAAuB,EAA4B,6BAA6B,EAAE,uBAAuB,EAC1G,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAQxC;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,gBAAgB;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;GAMG;AACH,qBAAa,kBAAkB;IAC7B,sHAAsH;IACtH,SAAgB,OAAO,EAAE,MAAM,CAAC;IAEhC,kDAAkD;IAClD,SAAgB,QAAQ,EAAE,MAAM,CAAC;gBAEd,KAAK,CAAC,EAAE,uBAAuB;IAMlD,OAAO,KAAK,SAAS,GAAmG;YAE1G,kBAAkB;IAoBhC;;;;;;OAMG;IACU,OAAO,CAAC,OAAO,EAAE,QAAQ,SAAS,CAAC,cAAc,CAAC,cAAc,CAAC,GAAG,0BAA0B,CAAC,EAAE,IAAI,GAAG,GAAG,EACtH,IAAI,EAAE,CAAC,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,6BAA6B,CAAC,QAAQ,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,KAAK,uBAAuB,CAAC,OAAO,CAAC,EACpI,OAAO,EAAE,QAAQ,EACjB,GAAG,iBAAiB,EAAE,IAAI,EAAE,GAC3B,OAAO,CAAC,OAAO,CAAC;IAiBN,aAAa,CAAC,OAAO,EAAE,uBAAuB,CAAC,cAAc,EAAE,OAAO,EAAE,mBAAmB,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,MAAM,CAAC;IAK3I,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,uBAAuB,CAAC,cAAc,EAAE,OAAO,EAAE,mBAAmB,CAAC,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAMnK,kBAAkB,CAAC,OAAO,EAAE,sCAAsC,CAAC,cAAc,EAAE,OAAO,EAAE,mBAAmB,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IASnL,YAAY,CAAC,OAAO,EAAE,4CAA4C,CAAC,cAAc,EAAE,mBAAmB,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAMrK,oBAAoB,CAAC,OAAO,EAAE,mCAAmC,CAAC,cAAc,EAAE,mBAAmB,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAMpK,iBAAiB,CAAC,OAAO,EAAE,4BAA4B,CAAC,cAAc,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAIvI,oBAAoB,CAAC,OAAO,EAAE,+BAA+B,CAAC,cAAc,EAAE,UAAU,EAAE,mBAAmB,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IAIjL,iBAAiB,CAAC,OAAO,EAAE,qBAAqB,CAAC,cAAc,EAAE,mBAAmB,EAAE,UAAU,EAAE,mBAAmB,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,MAAM,CAAC;IAIrK,eAAe,CAAC,OAAO,EAAE,KAAK,CAAC,qBAAqB,CAAC,cAAc,EAAE,mBAAmB,EAAE,UAAU,EAAE,mBAAmB,CAAC,GAAG,0BAA0B,CAAC;oBACjI,cAAc;oBAAc,cAAc,QAAQ,CAAC;;IAG1E,kBAAkB,CAAC,OAAO,EAAE,KAAK,CAAC,qBAAqB,CAAC,cAAc,EAAE,mBAAmB,EAAE,UAAU,EAAE,mBAAmB,CAAC,GAAG,0BAA0B,CAAC;IAM3J,sBAAsB,CAAC,OAAO,EAAE,4BAA4B,CAAC,cAAc,EAAE,mBAAmB,EAAE,UAAU,EAAE,mBAAmB,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAC;IAM/M,oBAAoB,CAAC,OAAO,EAAE,qCAAqC,CAAC,cAAc,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC;IAKzJ,sBAAsB,CAAC,OAAO,EAAE,iCAAiC,CAAC,cAAc,EAAE,UAAU,EAAE,mBAAmB,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,UAAU,CAAA;KAAE,CAAC;IAK/L,yBAAyB,CAAC,OAAO,EAAE,0BAA0B,CAAC,cAAc,EAAE,WAAW,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,eAAe,CAAC;IAIlJ,+BAA+B,CAAC,OAAO,EAAE,2BAA2B,CAAC,cAAc,EAAE,WAAW,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;IAKxK,kBAAkB,CAAC,OAAO,EAAE,4BAA4B,CAAC,cAAc,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAIjI,gBAAgB,CAAC,OAAO,EAAE,8BAA8B,CAAC,cAAc,CAAC,GAAG,0BAA0B,GAAG,OAAO,CAAC,UAAU,CAAC;CAKzI"}

package/lib/esm/presentation-common/RpcRequestsHandler.js

@@ -1,168 +1,163 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module RPC
- */
-import { Guid, Logger } from "@itwin/core-bentley";
-import { RpcManager } from "@itwin/core-common";
-import { PresentationCommonLoggerCategory } from "./CommonLoggerCategory";
-import { PresentationError, PresentationStatus } from "./Error";
-import { PresentationRpcInterface, } from "./PresentationRpcInterface";
-/**
- * RPC requests handler that wraps [[PresentationRpcInterface]] and
- * adds handling for cases when backend needs to be synced with client
- * state.
- *
- * @internal
- */
-export class RpcRequestsHandler {
-    constructor(props) {
-        this.maxRequestRepeatCount = 5;
-        this.clientId = (props && props.clientId) ? props.clientId : Guid.createValue();
-    }
-    dispose() {
-    }
-    // eslint-disable-next-line @typescript-eslint/naming-convention
-    get rpcClient() { return RpcManager.getClientForInterface(PresentationRpcInterface); }
-    async requestRepeatedly(func, diagnosticsHandler, repeatCount = 1) {
-        let diagnostics;
-        let error;
-        let shouldRepeat = false;
-        try {
-            const response = await func();
-            diagnostics = response.diagnostics;
-            if (response.statusCode === PresentationStatus.Success)
-                return response.result;
-            if (response.statusCode === PresentationStatus.BackendTimeout && repeatCount < this.maxRequestRepeatCount)
-                shouldRepeat = true;
-            else
-                error = new PresentationError(response.statusCode, response.errorMessage);
-        }
-        catch (e) {
-            error = e;
-            if (repeatCount < this.maxRequestRepeatCount)
-                shouldRepeat = true;
-        }
-        finally {
-            diagnosticsHandler && diagnostics && diagnosticsHandler(diagnostics);
-        }
-        if (shouldRepeat) {
-            ++repeatCount;
-            return this.requestRepeatedly(func, diagnosticsHandler, repeatCount);
-        }
-        throw error;
-    }
-    /**
-     * Send the request to backend.
-     *
-     * If the backend responds with [[PresentationStatus.BackendTimeout]] or there's an RPC-related error,
-     * the request is repeated up to `this._maxRequestRepeatCount` times. If we fail to get a valid success or error
-     * response from the backend, throw the last encountered error.
-     *
-     * @internal
-     */
-    async request(func, options, ...additionalOptions) {
-        const { imodel, diagnostics, ...optionsNoIModel } = options;
-        const { handler: diagnosticsHandler, ...diagnosticsOptions } = diagnostics !== null && diagnostics !== void 0 ? diagnostics : {};
-        if (isOptionsWithRuleset(optionsNoIModel))
-            optionsNoIModel.rulesetOrId = cleanupRuleset(optionsNoIModel.rulesetOrId);
-        const rpcOptions = {
-            ...optionsNoIModel,
-            clientId: this.clientId,
-        };
-        if (diagnostics)
-            rpcOptions.diagnostics = diagnosticsOptions;
-        const doRequest = async () => func(imodel, rpcOptions, ...additionalOptions);
-        return this.requestRepeatedly(doRequest, diagnosticsHandler);
-    }
-    async getNodesCount(options) {
-        return this.request(this.rpcClient.getNodesCount.bind(this.rpcClient), options);
-    }
-    // eslint-disable-next-line deprecation/deprecation
-    async getPagedNodes(options) {
-        // eslint-disable-next-line deprecation/deprecation
-        return this.request(this.rpcClient.getPagedNodes.bind(this.rpcClient), options);
-    }
-    async getNodesDescriptor(options) {
-        const response = await this.request(this.rpcClient.getNodesDescriptor.bind(this.rpcClient), options);
-        if (typeof response === "string")
-            return JSON.parse(response);
-        return response;
-    }
-    // eslint-disable-next-line deprecation/deprecation
-    async getNodePaths(options) {
-        // eslint-disable-next-line deprecation/deprecation
-        return this.request(this.rpcClient.getNodePaths.bind(this.rpcClient), options);
-    }
-    // eslint-disable-next-line deprecation/deprecation
-    async getFilteredNodePaths(options) {
-        // eslint-disable-next-line deprecation/deprecation
-        return this.request(this.rpcClient.getFilteredNodePaths.bind(this.rpcClient), options);
-    }
-    async getContentSources(options) {
-        return this.request(this.rpcClient.getContentSources.bind(this.rpcClient), options);
-    }
-    async getContentDescriptor(options) {
-        return this.request(this.rpcClient.getContentDescriptor.bind(this.rpcClient), options);
-    }
-    async getContentSetSize(options) {
-        return this.request(this.rpcClient.getContentSetSize.bind(this.rpcClient), options);
-    }
-    async getPagedContent(options) {
-        return this.request(this.rpcClient.getPagedContent.bind(this.rpcClient), options);
-    }
-    async getPagedContentSet(options) {
-        return this.request(this.rpcClient.getPagedContentSet.bind(this.rpcClient), options);
-    }
-    // eslint-disable-next-line deprecation/deprecation
-    async getPagedDistinctValues(options) {
-        // eslint-disable-next-line deprecation/deprecation
-        return this.request(this.rpcClient.getPagedDistinctValues.bind(this.rpcClient), options);
-    }
-    async getElementProperties(options) {
-        return this.request(this.rpcClient.getElementProperties.bind(this.rpcClient), options);
-    }
-    async getContentInstanceKeys(options) {
-        return this.request(this.rpcClient.getContentInstanceKeys.bind(this.rpcClient), options);
-    }
-    async getDisplayLabelDefinition(options) {
-        return this.request(this.rpcClient.getDisplayLabelDefinition.bind(this.rpcClient), options);
-    }
-    async getPagedDisplayLabelDefinitions(options) {
-        return this.request(this.rpcClient.getPagedDisplayLabelDefinitions.bind(this.rpcClient), options);
-    }
-    async getSelectionScopes(options) {
-        return this.request(this.rpcClient.getSelectionScopes.bind(this.rpcClient), options);
-    }
-    async computeSelection(options) {
-        return this.request(
-        // eslint-disable-next-line deprecation/deprecation
-        this.rpcClient.computeSelection.bind(this.rpcClient), options);
-    }
-}
-function isOptionsWithRuleset(options) {
-    return (typeof options.rulesetOrId === "object");
-}
-const RULESET_SUPPORTED_PROPERTIES_OBJ = {
-    id: true,
-    rules: true,
-    version: true,
-    requiredSchemas: true,
-    supplementationInfo: true,
-    vars: true,
-};
-function cleanupRuleset(ruleset) {
-    const cleanedUpRuleset = { ...ruleset };
-    for (const propertyKey of Object.keys(cleanedUpRuleset)) {
-        if (!RULESET_SUPPORTED_PROPERTIES_OBJ.hasOwnProperty(propertyKey)) {
-            if (propertyKey === "$schema")
-                delete cleanedUpRuleset[propertyKey];
-            else
-                Logger.logWarning(PresentationCommonLoggerCategory.Package, `Provided ruleset contains unrecognized attribute '${propertyKey}'. It either doesn't exist or may be no longer supported.`);
-        }
-    }
-    return cleanedUpRuleset;
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module RPC
+ */
+import { BeDuration, BeTimePoint, Guid, Logger } from "@itwin/core-bentley";
+import { RpcManager } from "@itwin/core-common";
+import { PresentationCommonLoggerCategory } from "./CommonLoggerCategory";
+import { PresentationError, PresentationStatus } from "./Error";
+import { PresentationRpcInterface, } from "./PresentationRpcInterface";
+/**
+ * Default timeout for how long we're going to wait for RPC request to be fulfilled before throwing
+ * a timeout error.
+ */
+const DEFAULT_REQUEST_TIMEOUT = 10 * 60 * 1000; // 10 minutes
+/**
+ * RPC requests handler that wraps [[PresentationRpcInterface]] and
+ * adds handling for cases when backend needs to be synced with client
+ * state.
+ *
+ * @internal
+ */
+export class RpcRequestsHandler {
+    constructor(props) {
+        this.clientId = props?.clientId ?? Guid.createValue();
+        this.timeout = props?.timeout ?? DEFAULT_REQUEST_TIMEOUT;
+    }
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    get rpcClient() { return RpcManager.getClientForInterface(PresentationRpcInterface); }
+    async requestWithTimeout(func, diagnosticsHandler) {
+        const start = BeTimePoint.now();
+        const timeout = BeDuration.fromMilliseconds(this.timeout);
+        let diagnostics;
+        while (start.plus(timeout).isInFuture) {
+            try {
+                const response = await func();
+                diagnostics = response.diagnostics;
+                switch (response.statusCode) {
+                    case PresentationStatus.Success: return response.result;
+                    case PresentationStatus.BackendTimeout: break;
+                    default: throw new PresentationError(response.statusCode, response.errorMessage);
+                }
+            }
+            finally {
+                diagnosticsHandler && diagnostics && diagnosticsHandler(diagnostics);
+            }
+        }
+        throw new PresentationError(PresentationStatus.BackendTimeout);
+    }
+    /**
+     * Send the request to backend.
+     *
+     * If the backend responds with [[PresentationStatus.BackendTimeout]], the request is repeated until we hit `timeout` or get
+     * a response. If the response is other than [[PresentationStatus.BackendTimeout]] or [[PresentationStatus.Success]], a [[PresentationError]]
+     * is thrown with the details from the response.
+     */
+    async request(func, options, ...additionalOptions) {
+        const { imodel, diagnostics, ...optionsNoIModel } = options;
+        const { handler: diagnosticsHandler, ...diagnosticsOptions } = diagnostics ?? {};
+        if (isOptionsWithRuleset(optionsNoIModel)) {
+            optionsNoIModel.rulesetOrId = cleanupRuleset(optionsNoIModel.rulesetOrId);
+        }
+        const rpcOptions = {
+            ...optionsNoIModel,
+            clientId: this.clientId,
+        };
+        if (diagnostics) {
+            rpcOptions.diagnostics = diagnosticsOptions;
+        }
+        const doRequest = async () => func(imodel, rpcOptions, ...additionalOptions);
+        return this.requestWithTimeout(doRequest, diagnosticsHandler);
+    }
+    async getNodesCount(options) {
+        return this.request(this.rpcClient.getNodesCount.bind(this.rpcClient), options);
+    }
+    // eslint-disable-next-line deprecation/deprecation
+    async getPagedNodes(options) {
+        // eslint-disable-next-line deprecation/deprecation
+        return this.request(this.rpcClient.getPagedNodes.bind(this.rpcClient), options);
+    }
+    async getNodesDescriptor(options) {
+        const response = await this.request(this.rpcClient.getNodesDescriptor.bind(this.rpcClient), options);
+        if (typeof response === "string")
+            return JSON.parse(response);
+        return response;
+    }
+    // eslint-disable-next-line deprecation/deprecation
+    async getNodePaths(options) {
+        // eslint-disable-next-line deprecation/deprecation
+        return this.request(this.rpcClient.getNodePaths.bind(this.rpcClient), options);
+    }
+    // eslint-disable-next-line deprecation/deprecation
+    async getFilteredNodePaths(options) {
+        // eslint-disable-next-line deprecation/deprecation
+        return this.request(this.rpcClient.getFilteredNodePaths.bind(this.rpcClient), options);
+    }
+    async getContentSources(options) {
+        return this.request(this.rpcClient.getContentSources.bind(this.rpcClient), options);
+    }
+    async getContentDescriptor(options) {
+        return this.request(this.rpcClient.getContentDescriptor.bind(this.rpcClient), options);
+    }
+    async getContentSetSize(options) {
+        return this.request(this.rpcClient.getContentSetSize.bind(this.rpcClient), options);
+    }
+    async getPagedContent(options) {
+        return this.request(this.rpcClient.getPagedContent.bind(this.rpcClient), options);
+    }
+    async getPagedContentSet(options) {
+        return this.request(this.rpcClient.getPagedContentSet.bind(this.rpcClient), options);
+    }
+    // eslint-disable-next-line deprecation/deprecation
+    async getPagedDistinctValues(options) {
+        // eslint-disable-next-line deprecation/deprecation
+        return this.request(this.rpcClient.getPagedDistinctValues.bind(this.rpcClient), options);
+    }
+    async getElementProperties(options) {
+        return this.request(this.rpcClient.getElementProperties.bind(this.rpcClient), options);
+    }
+    async getContentInstanceKeys(options) {
+        return this.request(this.rpcClient.getContentInstanceKeys.bind(this.rpcClient), options);
+    }
+    async getDisplayLabelDefinition(options) {
+        return this.request(this.rpcClient.getDisplayLabelDefinition.bind(this.rpcClient), options);
+    }
+    async getPagedDisplayLabelDefinitions(options) {
+        return this.request(this.rpcClient.getPagedDisplayLabelDefinitions.bind(this.rpcClient), options);
+    }
+    async getSelectionScopes(options) {
+        return this.request(this.rpcClient.getSelectionScopes.bind(this.rpcClient), options);
+    }
+    async computeSelection(options) {
+        return this.request(
+        // eslint-disable-next-line deprecation/deprecation
+        this.rpcClient.computeSelection.bind(this.rpcClient), options);
+    }
+}
+function isOptionsWithRuleset(options) {
+    return (typeof options.rulesetOrId === "object");
+}
+const RULESET_SUPPORTED_PROPERTIES_OBJ = {
+    id: true,
+    rules: true,
+    version: true,
+    requiredSchemas: true,
+    supplementationInfo: true,
+    vars: true,
+};
+function cleanupRuleset(ruleset) {
+    const cleanedUpRuleset = { ...ruleset };
+    for (const propertyKey of Object.keys(cleanedUpRuleset)) {
+        if (!RULESET_SUPPORTED_PROPERTIES_OBJ.hasOwnProperty(propertyKey)) {
+            if (propertyKey === "$schema")
+                delete cleanedUpRuleset[propertyKey];
+            else
+                Logger.logWarning(PresentationCommonLoggerCategory.Package, `Provided ruleset contains unrecognized attribute '${propertyKey}'. It either doesn't exist or may be no longer supported.`);
+        }
+    }
+    return cleanedUpRuleset;
+}
 //# sourceMappingURL=RpcRequestsHandler.js.map