@itwin/presentation-common 4.0.0-dev.48 → 4.0.0-dev.51

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

@@ -1,27 +1,27 @@
-/** @packageDocumentation
- * @module Core
- */
-import { IDisposable } from "@itwin/core-bentley";
-import { Rule } from "./rules/Rule";
-import { Ruleset, SupplementationInfo } from "./rules/Ruleset";
-import { VariablesGroup } from "./rules/Variables";
-/**
- * A ruleset that is registered in a ruleset manager.
- * @public
- */
-export declare class RegisteredRuleset implements IDisposable, Ruleset {
-    private _ruleset;
-    private _uniqueIdentifier;
-    private _disposeFunc;
-    /** Create a registered ruleset */
-    constructor(ruleset: Ruleset, uniqueIdentifier: string, disposeFunc: (ruleset: RegisteredRuleset) => void);
-    /** Dispose registered ruleset. */
-    dispose(): void;
-    get uniqueIdentifier(): string;
-    get id(): string;
-    get supplementationInfo(): SupplementationInfo | undefined;
-    get rules(): Rule[];
-    get vars(): VariablesGroup[] | undefined;
-    toJSON(): Ruleset;
-}
+/** @packageDocumentation
+ * @module Core
+ */
+import { IDisposable } from "@itwin/core-bentley";
+import { Rule } from "./rules/Rule";
+import { Ruleset, SupplementationInfo } from "./rules/Ruleset";
+import { VariablesGroup } from "./rules/Variables";
+/**
+ * A ruleset that is registered in a ruleset manager.
+ * @public
+ */
+export declare class RegisteredRuleset implements IDisposable, Ruleset {
+    private _ruleset;
+    private _uniqueIdentifier;
+    private _disposeFunc;
+    /** Create a registered ruleset */
+    constructor(ruleset: Ruleset, uniqueIdentifier: string, disposeFunc: (ruleset: RegisteredRuleset) => void);
+    /** Dispose registered ruleset. */
+    dispose(): void;
+    get uniqueIdentifier(): string;
+    get id(): string;
+    get supplementationInfo(): SupplementationInfo | undefined;
+    get rules(): Rule[];
+    get vars(): VariablesGroup[] | undefined;
+    toJSON(): Ruleset;
+}
 //# sourceMappingURL=RegisteredRuleset.d.ts.map

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/RegisteredRuleset.js.map

@@ -1 +1 @@
-{"version":3,"file":"RegisteredRuleset.js","sourceRoot":"","sources":["../../../src/presentation-common/RegisteredRuleset.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAOH;;;GAGG;AACH,MAAM,OAAO,iBAAiB;IAK5B,kCAAkC;IAClC,YAAmB,OAAgB,EAAE,gBAAwB,EAAE,WAAiD;QAC9G,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;IAC5C,CAAC;IAED,kCAAkC;IAC3B,OAAO;QACZ,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,IAAW,gBAAgB,KAAK,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAChE,IAAW,EAAE,KAAa,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;IACpD,IAAW,mBAAmB,KAAsC,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAC/G,IAAW,KAAK,KAAa,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1D,IAAW,IAAI,KAAmC,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IACvE,MAAM,KAAc,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;CACnD","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Core\n */\n\nimport { IDisposable } from \"@itwin/core-bentley\";\nimport { Rule } from \"./rules/Rule\";\nimport { Ruleset, SupplementationInfo } from \"./rules/Ruleset\";\nimport { VariablesGroup } from \"./rules/Variables\";\n\n/**\n * A ruleset that is registered in a ruleset manager.\n * @public\n */\nexport class RegisteredRuleset implements IDisposable, Ruleset {\n  private _ruleset: Ruleset;\n  private _uniqueIdentifier: string;\n  private _disposeFunc: (ruleset: RegisteredRuleset) => void;\n\n  /** Create a registered ruleset */\n  public constructor(ruleset: Ruleset, uniqueIdentifier: string, disposeFunc: (ruleset: RegisteredRuleset) => void) {\n    this._disposeFunc = disposeFunc;\n    this._ruleset = ruleset;\n    this._uniqueIdentifier = uniqueIdentifier;\n  }\n\n  /** Dispose registered ruleset. */\n  public dispose() {\n    this._disposeFunc(this);\n  }\n\n  public get uniqueIdentifier() { return this._uniqueIdentifier; }\n  public get id(): string { return this._ruleset.id; }\n  public get supplementationInfo(): SupplementationInfo | undefined { return this._ruleset.supplementationInfo; }\n  public get rules(): Rule[] { return this._ruleset.rules; }\n  public get vars(): VariablesGroup[] | undefined { return this._ruleset.vars; }\n  public toJSON(): Ruleset { return this._ruleset; }\n}\n"]}
+{"version":3,"file":"RegisteredRuleset.js","sourceRoot":"","sources":["../../../src/presentation-common/RegisteredRuleset.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAOH;;;GAGG;AACH,MAAM,OAAO,iBAAiB;IAK5B,kCAAkC;IAClC,YAAmB,OAAgB,EAAE,gBAAwB,EAAE,WAAiD;QAC9G,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;IAC5C,CAAC;IAED,kCAAkC;IAC3B,OAAO;QACZ,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,IAAW,gBAAgB,KAAK,OAAO,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAChE,IAAW,EAAE,KAAa,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;IACpD,IAAW,mBAAmB,KAAsC,OAAO,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAC/G,IAAW,KAAK,KAAa,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1D,IAAW,IAAI,KAAmC,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IACvE,MAAM,KAAc,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;CACnD","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Core\r\n */\r\n\r\nimport { IDisposable } from \"@itwin/core-bentley\";\r\nimport { Rule } from \"./rules/Rule\";\r\nimport { Ruleset, SupplementationInfo } from \"./rules/Ruleset\";\r\nimport { VariablesGroup } from \"./rules/Variables\";\r\n\r\n/**\r\n * A ruleset that is registered in a ruleset manager.\r\n * @public\r\n */\r\nexport class RegisteredRuleset implements IDisposable, Ruleset {\r\n  private _ruleset: Ruleset;\r\n  private _uniqueIdentifier: string;\r\n  private _disposeFunc: (ruleset: RegisteredRuleset) => void;\r\n\r\n  /** Create a registered ruleset */\r\n  public constructor(ruleset: Ruleset, uniqueIdentifier: string, disposeFunc: (ruleset: RegisteredRuleset) => void) {\r\n    this._disposeFunc = disposeFunc;\r\n    this._ruleset = ruleset;\r\n    this._uniqueIdentifier = uniqueIdentifier;\r\n  }\r\n\r\n  /** Dispose registered ruleset. */\r\n  public dispose() {\r\n    this._disposeFunc(this);\r\n  }\r\n\r\n  public get uniqueIdentifier() { return this._uniqueIdentifier; }\r\n  public get id(): string { return this._ruleset.id; }\r\n  public get supplementationInfo(): SupplementationInfo | undefined { return this._ruleset.supplementationInfo; }\r\n  public get rules(): Rule[] { return this._ruleset.rules; }\r\n  public get vars(): VariablesGroup[] | undefined { return this._ruleset.vars; }\r\n  public toJSON(): Ruleset { return this._ruleset; }\r\n}\r\n"]}

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

@@ -1,83 +1,83 @@
-/** @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>;
-}
+/** @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.js

@@ -1,163 +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 { 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;
-}
+/*---------------------------------------------------------------------------------------------
+* 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