@itwin/presentation-common 4.0.0-dev.22 → 4.0.0-dev.23

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

@@ -1,168 +1,168 @@
-/*---------------------------------------------------------------------------------------------
-* 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 { 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;
+}
 //# sourceMappingURL=RpcRequestsHandler.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"RpcRequestsHandler.js","sourceRoot":"","sources":["../../../src/presentation-common/RpcRequestsHandler.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAe,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAkB,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,EAAE,gCAAgC,EAAE,MAAM,wBAAwB,CAAC;AAO1E,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAYhE,OAAO,EACoB,wBAAwB,GAClD,MAAM,4BAA4B,CAAC;AAoBpC;;;;;;GAMG;AACH,MAAM,OAAO,kBAAkB;IAM7B,YAAmB,KAA+B;QALlC,0BAAqB,GAAW,CAAC,CAAC;QAMhD,IAAI,CAAC,QAAQ,GAAG,CAAC,KAAK,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;IAClF,CAAC;IAEM,OAAO;IACd,CAAC;IAED,gEAAgE;IAChE,IAAY,SAAS,KAA+B,OAAO,UAAU,CAAC,qBAAqB,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC;IAEhH,KAAK,CAAC,iBAAiB,CAAU,IAA4C,EAAE,kBAA6C,EAAE,cAAsB,CAAC;QAC3J,IAAI,WAA0C,CAAC;QAC/C,IAAI,KAA0B,CAAC;QAC/B,IAAI,YAAY,GAAG,KAAK,CAAC;QACzB,IAAI;YACF,MAAM,QAAQ,GAAG,MAAM,IAAI,EAAE,CAAC;YAC9B,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;YAEnC,IAAI,QAAQ,CAAC,UAAU,KAAK,kBAAkB,CAAC,OAAO;gBACpD,OAAO,QAAQ,CAAC,MAAO,CAAC;YAE1B,IAAI,QAAQ,CAAC,UAAU,KAAK,kBAAkB,CAAC,cAAc,IAAI,WAAW,GAAG,IAAI,CAAC,qBAAqB;gBACvG,YAAY,GAAG,IAAI,CAAC;;gBAEpB,KAAK,GAAG,IAAI,iBAAiB,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;SAE7E;QAAC,OAAO,CAAC,EAAE;YACV,KAAK,GAAG,CAAC,CAAC;YACV,IAAI,WAAW,GAAG,IAAI,CAAC,qBAAqB;gBAC1C,YAAY,GAAG,IAAI,CAAC;SAEvB;gBAAS;YACR,kBAAkB,IAAI,WAAW,IAAI,kBAAkB,CAAC,WAAW,CAAC,CAAC;SACtE;QAED,IAAI,YAAY,EAAE;YAChB,EAAE,WAAW,CAAC;YACd,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,kBAAkB,EAAE,WAAW,CAAC,CAAC;SACtE;QAED,MAAM,KAAK,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,OAAO,CAClB,IAAoI,EACpI,OAAiB,EACjB,GAAG,iBAAyB;QAE5B,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAE,GAAG,OAAO,CAAC;QAC5D,MAAM,EAAE,OAAO,EAAE,kBAAkB,EAAE,GAAG,kBAAkB,EAAE,GAAG,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,EAAE,CAAC;QACjF,IAAI,oBAAoB,CAAC,eAAe,CAAC;YACvC,eAAe,CAAC,WAAW,GAAG,cAAc,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;QAC5E,MAAM,UAAU,GAA4C;YAC1D,GAAG,eAAe;YAClB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;QACF,IAAI,WAAW;YACb,UAAU,CAAC,WAAW,GAAG,kBAAkB,CAAC;QAC9C,MAAM,SAAS,GAAG,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,iBAAiB,CAAC,CAAC;QAC7E,OAAO,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;IAC/D,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,OAA2G;QACpI,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IACD,mDAAmD;IAC5C,KAAK,CAAC,aAAa,CAAC,OAAkH;QAC3I,mDAAmD;QACnD,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,OAA0H;QACxJ,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;QACnE,IAAI,OAAO,QAAQ,KAAK,QAAQ;YAC9B,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,mDAAmD;IAC5C,KAAK,CAAC,YAAY,CAAC,OAAuH;QAC/I,mDAAmD;QACnD,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IACD,mDAAmD;IAC5C,KAAK,CAAC,oBAAoB,CAAC,OAA8G;QAC9I,mDAAmD;QACnD,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,OAAkF;QAC/G,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IACM,KAAK,CAAC,oBAAoB,CAAC,OAAsH;QACtJ,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IACM,KAAK,CAAC,iBAAiB,CAAC,OAAiI;QAC9J,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IACM,KAAK,CAAC,eAAe,CAAC,OAAwI;QACnK,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IACM,KAAK,CAAC,kBAAkB,CAAC,OAAwI;QACtK,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED,mDAAmD;IAC5C,KAAK,CAAC,sBAAsB,CAAC,OAAwI;QAC1K,mDAAmD;QACnD,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,OAA2F;QAC3H,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAEM,KAAK,CAAC,sBAAsB,CAAC,OAAwH;QAC1J,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,OAA6F;QAClI,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IACM,KAAK,CAAC,+BAA+B,CAAC,OAA8F;QACzI,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,+BAA+B,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,OAAkF;QAChH,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IACM,KAAK,CAAC,gBAAgB,CAAC,OAAoF;QAChH,OAAO,IAAI,CAAC,OAAO;QACjB,mDAAmD;QACnD,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF;AAED,SAAS,oBAAoB,CAAC,OAAe;IAC3C,OAAO,CAAC,OAAQ,OAA+C,CAAC,WAAW,KAAK,QAAQ,CAAC,CAAC;AAC5F,CAAC;AAMD,MAAM,gCAAgC,GAAkC;IACtE,EAAE,EAAE,IAAI;IACR,KAAK,EAAE,IAAI;IACX,OAAO,EAAE,IAAI;IACb,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;IACzB,IAAI,EAAE,IAAI;CACX,CAAC;AAEF,SAAS,cAAc,CAAC,OAAgB;IACtC,MAAM,gBAAgB,GAAY,EAAE,GAAG,OAAO,EAAE,CAAC;IAEjD,KAAK,MAAM,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE;QACvD,IAAI,CAAC,gCAAgC,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE;YACjE,IAAI,WAAW,KAAK,SAAS;gBAC3B,OAAQ,gBAAwB,CAAC,WAAW,CAAC,CAAC;;gBAE9C,MAAM,CAAC,UAAU,CAAC,gCAAgC,CAAC,OAAO,EAAE,qDAAqD,WAAW,2DAA2D,CAAC,CAAC;SAC5L;KACF;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module RPC\r\n */\r\n\r\nimport { Guid, IDisposable, Logger } from \"@itwin/core-bentley\";\r\nimport { IModelRpcProps, RpcManager } from \"@itwin/core-common\";\r\nimport { PresentationCommonLoggerCategory } from \"./CommonLoggerCategory\";\r\nimport { DescriptorJSON, DescriptorOverrides } from \"./content/Descriptor\";\r\nimport { ItemJSON } from \"./content/Item\";\r\nimport { DisplayValueGroupJSON } from \"./content/Value\";\r\nimport { ClientDiagnostics, ClientDiagnosticsAttribute, ClientDiagnosticsHandler } from \"./Diagnostics\";\r\nimport { InstanceKey } from \"./EC\";\r\nimport { ElementProperties } from \"./ElementProperties\";\r\nimport { PresentationError, PresentationStatus } from \"./Error\";\r\nimport { NodeKey } from \"./hierarchy/Key\";\r\nimport { NodeJSON } from \"./hierarchy/Node\";\r\nimport { NodePathElementJSON } from \"./hierarchy/NodePathElement\";\r\nimport { KeySetJSON } from \"./KeySet\";\r\nimport { LabelDefinition } from \"./LabelDefinition\";\r\nimport {\r\n  ComputeSelectionRequestOptions, ContentDescriptorRequestOptions, ContentInstanceKeysRequestOptions, ContentRequestOptions,\r\n  ContentSourcesRequestOptions, DisplayLabelRequestOptions, DisplayLabelsRequestOptions, DistinctValuesRequestOptions,\r\n  FilterByInstancePathsHierarchyRequestOptions, FilterByTextHierarchyRequestOptions, HierarchyLevelDescriptorRequestOptions, HierarchyRequestOptions,\r\n  Paged, RequestOptions, RequestOptionsWithRuleset, SelectionScopeRequestOptions, SingleElementPropertiesRequestOptions,\r\n} from \"./PresentationManagerOptions\";\r\nimport {\r\n  ContentSourcesRpcResult, PresentationRpcInterface, PresentationRpcRequestOptions, PresentationRpcResponse,\r\n} from \"./PresentationRpcInterface\";\r\nimport { Ruleset } from \"./rules/Ruleset\";\r\nimport { RulesetVariableJSON } from \"./RulesetVariables\";\r\nimport { SelectionScope } from \"./selection/SelectionScope\";\r\nimport { PagedResponse } from \"./Utils\";\r\n\r\n/**\r\n * Configuration parameters for [[RpcRequestsHandler]].\r\n *\r\n * @internal\r\n */\r\nexport interface RpcRequestsHandlerProps {\r\n  /**\r\n   * Optional ID used to identify client that requests data. If not specified,\r\n   * the handler creates a unique GUID as a client id.\r\n   * @internal\r\n   */\r\n  clientId?: string;\r\n}\r\n\r\n/**\r\n * RPC requests handler that wraps [[PresentationRpcInterface]] and\r\n * adds handling for cases when backend needs to be synced with client\r\n * state.\r\n *\r\n * @internal\r\n */\r\nexport class RpcRequestsHandler implements IDisposable {\r\n  public readonly maxRequestRepeatCount: number = 5;\r\n\r\n  /** ID that identifies this handler as a client */\r\n  public readonly clientId: string;\r\n\r\n  public constructor(props?: RpcRequestsHandlerProps) {\r\n    this.clientId = (props && props.clientId) ? props.clientId : Guid.createValue();\r\n  }\r\n\r\n  public dispose() {\r\n  }\r\n\r\n  // eslint-disable-next-line @typescript-eslint/naming-convention\r\n  private get rpcClient(): PresentationRpcInterface { return RpcManager.getClientForInterface(PresentationRpcInterface); }\r\n\r\n  private async requestRepeatedly<TResult>(func: () => PresentationRpcResponse<TResult>, diagnosticsHandler?: ClientDiagnosticsHandler, repeatCount: number = 1): Promise<TResult> {\r\n    let diagnostics: ClientDiagnostics | undefined;\r\n    let error: unknown | undefined;\r\n    let shouldRepeat = false;\r\n    try {\r\n      const response = await func();\r\n      diagnostics = response.diagnostics;\r\n\r\n      if (response.statusCode === PresentationStatus.Success)\r\n        return response.result!;\r\n\r\n      if (response.statusCode === PresentationStatus.BackendTimeout && repeatCount < this.maxRequestRepeatCount)\r\n        shouldRepeat = true;\r\n      else\r\n        error = new PresentationError(response.statusCode, response.errorMessage);\r\n\r\n    } catch (e) {\r\n      error = e;\r\n      if (repeatCount < this.maxRequestRepeatCount)\r\n        shouldRepeat = true;\r\n\r\n    } finally {\r\n      diagnosticsHandler && diagnostics && diagnosticsHandler(diagnostics);\r\n    }\r\n\r\n    if (shouldRepeat) {\r\n      ++repeatCount;\r\n      return this.requestRepeatedly(func, diagnosticsHandler, repeatCount);\r\n    }\r\n\r\n    throw error;\r\n  }\r\n\r\n  /**\r\n   * Send the request to backend.\r\n   *\r\n   * If the backend responds with [[PresentationStatus.BackendTimeout]] or there's an RPC-related error,\r\n   * the request is repeated up to `this._maxRequestRepeatCount` times. If we fail to get a valid success or error\r\n   * response from the backend, throw the last encountered error.\r\n   *\r\n   * @internal\r\n   */\r\n  public async request<TResult, TOptions extends (RequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute), TArg = any>(\r\n    func: (token: IModelRpcProps, options: PresentationRpcRequestOptions<TOptions>, ...args: TArg[]) => PresentationRpcResponse<TResult>,\r\n    options: TOptions,\r\n    ...additionalOptions: TArg[]\r\n  ): Promise<TResult> {\r\n    const { imodel, diagnostics, ...optionsNoIModel } = options;\r\n    const { handler: diagnosticsHandler, ...diagnosticsOptions } = diagnostics ?? {};\r\n    if (isOptionsWithRuleset(optionsNoIModel))\r\n      optionsNoIModel.rulesetOrId = cleanupRuleset(optionsNoIModel.rulesetOrId);\r\n    const rpcOptions: PresentationRpcRequestOptions<TOptions> = {\r\n      ...optionsNoIModel,\r\n      clientId: this.clientId,\r\n    };\r\n    if (diagnostics)\r\n      rpcOptions.diagnostics = diagnosticsOptions;\r\n    const doRequest = async () => func(imodel, rpcOptions, ...additionalOptions);\r\n    return this.requestRepeatedly(doRequest, diagnosticsHandler);\r\n  }\r\n\r\n  public async getNodesCount(options: HierarchyRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<number> {\r\n    return this.request<number, typeof options>(\r\n      this.rpcClient.getNodesCount.bind(this.rpcClient), options);\r\n  }\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  public async getPagedNodes(options: Paged<HierarchyRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON>> & ClientDiagnosticsAttribute): Promise<PagedResponse<NodeJSON>> {\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    return this.request<PagedResponse<NodeJSON>, typeof options>(\r\n      this.rpcClient.getPagedNodes.bind(this.rpcClient), options);\r\n  }\r\n\r\n  public async getNodesDescriptor(options: HierarchyLevelDescriptorRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<DescriptorJSON | undefined> {\r\n    const response = await this.request<string | DescriptorJSON | undefined, typeof options>(\r\n      this.rpcClient.getNodesDescriptor.bind(this.rpcClient), options);\r\n    if (typeof response === \"string\")\r\n      return JSON.parse(response);\r\n    return response;\r\n  }\r\n\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  public async getNodePaths(options: FilterByInstancePathsHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<NodePathElementJSON[]> {\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    return this.request<NodePathElementJSON[], typeof options>(\r\n      this.rpcClient.getNodePaths.bind(this.rpcClient), options);\r\n  }\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  public async getFilteredNodePaths(options: FilterByTextHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<NodePathElementJSON[]> {\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    return this.request<NodePathElementJSON[], typeof options>(\r\n      this.rpcClient.getFilteredNodePaths.bind(this.rpcClient), options);\r\n  }\r\n\r\n  public async getContentSources(options: ContentSourcesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ContentSourcesRpcResult> {\r\n    return this.request<ContentSourcesRpcResult, typeof options>(\r\n      this.rpcClient.getContentSources.bind(this.rpcClient), options);\r\n  }\r\n  public async getContentDescriptor(options: ContentDescriptorRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<DescriptorJSON | undefined> {\r\n    return this.request<DescriptorJSON | undefined, typeof options>(\r\n      this.rpcClient.getContentDescriptor.bind(this.rpcClient), options);\r\n  }\r\n  public async getContentSetSize(options: ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<number> {\r\n    return this.request<number, typeof options>(\r\n      this.rpcClient.getContentSetSize.bind(this.rpcClient), options);\r\n  }\r\n  public async getPagedContent(options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>) {\r\n    return this.request<{ descriptor: DescriptorJSON, contentSet: PagedResponse<ItemJSON> } | undefined, typeof options>(\r\n      this.rpcClient.getPagedContent.bind(this.rpcClient), options);\r\n  }\r\n  public async getPagedContentSet(options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>) {\r\n    return this.request<PagedResponse<ItemJSON>, typeof options>(\r\n      this.rpcClient.getPagedContentSet.bind(this.rpcClient), options);\r\n  }\r\n\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  public async getPagedDistinctValues(options: DistinctValuesRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<PagedResponse<DisplayValueGroupJSON>> {\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    return this.request<PagedResponse<DisplayValueGroupJSON>, typeof options>(\r\n      this.rpcClient.getPagedDistinctValues.bind(this.rpcClient), options);\r\n  }\r\n\r\n  public async getElementProperties(options: SingleElementPropertiesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ElementProperties | undefined> {\r\n    return this.request<ElementProperties | undefined, typeof options>(\r\n      this.rpcClient.getElementProperties.bind(this.rpcClient), options);\r\n  }\r\n\r\n  public async getContentInstanceKeys(options: ContentInstanceKeysRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<{ total: number, items: KeySetJSON }> {\r\n    return this.request<{ total: number, items: KeySetJSON }, typeof options>(\r\n      this.rpcClient.getContentInstanceKeys.bind(this.rpcClient), options);\r\n  }\r\n\r\n  public async getDisplayLabelDefinition(options: DisplayLabelRequestOptions<IModelRpcProps, InstanceKey> & ClientDiagnosticsAttribute): Promise<LabelDefinition> {\r\n    return this.request<LabelDefinition, typeof options>(\r\n      this.rpcClient.getDisplayLabelDefinition.bind(this.rpcClient), options);\r\n  }\r\n  public async getPagedDisplayLabelDefinitions(options: DisplayLabelsRequestOptions<IModelRpcProps, InstanceKey> & ClientDiagnosticsAttribute): Promise<PagedResponse<LabelDefinition>> {\r\n    return this.request<PagedResponse<LabelDefinition>, typeof options>(\r\n      this.rpcClient.getPagedDisplayLabelDefinitions.bind(this.rpcClient), options);\r\n  }\r\n\r\n  public async getSelectionScopes(options: SelectionScopeRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<SelectionScope[]> {\r\n    return this.request<SelectionScope[], typeof options>(\r\n      this.rpcClient.getSelectionScopes.bind(this.rpcClient), options);\r\n  }\r\n  public async computeSelection(options: ComputeSelectionRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<KeySetJSON> {\r\n    return this.request<KeySetJSON, typeof options>(\r\n      // eslint-disable-next-line deprecation/deprecation\r\n      this.rpcClient.computeSelection.bind(this.rpcClient), options);\r\n  }\r\n}\r\n\r\nfunction isOptionsWithRuleset(options: Object): options is { rulesetOrId: Ruleset } {\r\n  return (typeof (options as RequestOptionsWithRuleset<any, any>).rulesetOrId === \"object\");\r\n}\r\n\r\ntype RulesetWithRequiredProperties = {\r\n  [key in keyof Ruleset]-?: true;\r\n};\r\n\r\nconst RULESET_SUPPORTED_PROPERTIES_OBJ: RulesetWithRequiredProperties = {\r\n  id: true,\r\n  rules: true,\r\n  version: true,\r\n  requiredSchemas: true,\r\n  supplementationInfo: true,\r\n  vars: true,\r\n};\r\n\r\nfunction cleanupRuleset(ruleset: Ruleset): Ruleset {\r\n  const cleanedUpRuleset: Ruleset = { ...ruleset };\r\n\r\n  for (const propertyKey of Object.keys(cleanedUpRuleset)) {\r\n    if (!RULESET_SUPPORTED_PROPERTIES_OBJ.hasOwnProperty(propertyKey)) {\r\n      if (propertyKey === \"$schema\")\r\n        delete (cleanedUpRuleset as any)[propertyKey];\r\n      else\r\n        Logger.logWarning(PresentationCommonLoggerCategory.Package, `Provided ruleset contains unrecognized attribute '${propertyKey}'. It either doesn't exist or may be no longer supported.`);\r\n    }\r\n  }\r\n\r\n  return cleanedUpRuleset;\r\n}\r\n"]}
+{"version":3,"file":"RpcRequestsHandler.js","sourceRoot":"","sources":["../../../src/presentation-common/RpcRequestsHandler.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAe,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAkB,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,EAAE,gCAAgC,EAAE,MAAM,wBAAwB,CAAC;AAO1E,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAYhE,OAAO,EACoB,wBAAwB,GAClD,MAAM,4BAA4B,CAAC;AAoBpC;;;;;;GAMG;AACH,MAAM,OAAO,kBAAkB;IAM7B,YAAmB,KAA+B;QALlC,0BAAqB,GAAW,CAAC,CAAC;QAMhD,IAAI,CAAC,QAAQ,GAAG,CAAC,KAAK,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;IAClF,CAAC;IAEM,OAAO;IACd,CAAC;IAED,gEAAgE;IAChE,IAAY,SAAS,KAA+B,OAAO,UAAU,CAAC,qBAAqB,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC;IAEhH,KAAK,CAAC,iBAAiB,CAAU,IAA4C,EAAE,kBAA6C,EAAE,cAAsB,CAAC;QAC3J,IAAI,WAA0C,CAAC;QAC/C,IAAI,KAA0B,CAAC;QAC/B,IAAI,YAAY,GAAG,KAAK,CAAC;QACzB,IAAI;YACF,MAAM,QAAQ,GAAG,MAAM,IAAI,EAAE,CAAC;YAC9B,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;YAEnC,IAAI,QAAQ,CAAC,UAAU,KAAK,kBAAkB,CAAC,OAAO;gBACpD,OAAO,QAAQ,CAAC,MAAO,CAAC;YAE1B,IAAI,QAAQ,CAAC,UAAU,KAAK,kBAAkB,CAAC,cAAc,IAAI,WAAW,GAAG,IAAI,CAAC,qBAAqB;gBACvG,YAAY,GAAG,IAAI,CAAC;;gBAEpB,KAAK,GAAG,IAAI,iBAAiB,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;SAE7E;QAAC,OAAO,CAAC,EAAE;YACV,KAAK,GAAG,CAAC,CAAC;YACV,IAAI,WAAW,GAAG,IAAI,CAAC,qBAAqB;gBAC1C,YAAY,GAAG,IAAI,CAAC;SAEvB;gBAAS;YACR,kBAAkB,IAAI,WAAW,IAAI,kBAAkB,CAAC,WAAW,CAAC,CAAC;SACtE;QAED,IAAI,YAAY,EAAE;YAChB,EAAE,WAAW,CAAC;YACd,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,kBAAkB,EAAE,WAAW,CAAC,CAAC;SACtE;QAED,MAAM,KAAK,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,OAAO,CAClB,IAAoI,EACpI,OAAiB,EACjB,GAAG,iBAAyB;QAE5B,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,EAAE,GAAG,OAAO,CAAC;QAC5D,MAAM,EAAE,OAAO,EAAE,kBAAkB,EAAE,GAAG,kBAAkB,EAAE,GAAG,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,EAAE,CAAC;QACjF,IAAI,oBAAoB,CAAC,eAAe,CAAC;YACvC,eAAe,CAAC,WAAW,GAAG,cAAc,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;QAC5E,MAAM,UAAU,GAA4C;YAC1D,GAAG,eAAe;YAClB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;QACF,IAAI,WAAW;YACb,UAAU,CAAC,WAAW,GAAG,kBAAkB,CAAC;QAC9C,MAAM,SAAS,GAAG,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,iBAAiB,CAAC,CAAC;QAC7E,OAAO,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;IAC/D,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,OAA2G;QACpI,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IACD,mDAAmD;IAC5C,KAAK,CAAC,aAAa,CAAC,OAAkH;QAC3I,mDAAmD;QACnD,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,OAA0H;QACxJ,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CACjC,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;QACnE,IAAI,OAAO,QAAQ,KAAK,QAAQ;YAC9B,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC9B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,mDAAmD;IAC5C,KAAK,CAAC,YAAY,CAAC,OAAuH;QAC/I,mDAAmD;QACnD,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IACD,mDAAmD;IAC5C,KAAK,CAAC,oBAAoB,CAAC,OAA8G;QAC9I,mDAAmD;QACnD,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,OAAkF;QAC/G,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IACM,KAAK,CAAC,oBAAoB,CAAC,OAAsH;QACtJ,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IACM,KAAK,CAAC,iBAAiB,CAAC,OAAiI;QAC9J,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IACM,KAAK,CAAC,eAAe,CAAC,OAAwI;QACnK,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IACM,KAAK,CAAC,kBAAkB,CAAC,OAAwI;QACtK,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED,mDAAmD;IAC5C,KAAK,CAAC,sBAAsB,CAAC,OAAwI;QAC1K,mDAAmD;QACnD,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,OAA2F;QAC3H,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAEM,KAAK,CAAC,sBAAsB,CAAC,OAAwH;QAC1J,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,OAA6F;QAClI,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAC5E,CAAC;IACM,KAAK,CAAC,+BAA+B,CAAC,OAA8F;QACzI,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,+BAA+B,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,OAAkF;QAChH,OAAO,IAAI,CAAC,OAAO,CACjB,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IACM,KAAK,CAAC,gBAAgB,CAAC,OAAoF;QAChH,OAAO,IAAI,CAAC,OAAO;QACjB,mDAAmD;QACnD,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF;AAED,SAAS,oBAAoB,CAAC,OAAe;IAC3C,OAAO,CAAC,OAAQ,OAA+C,CAAC,WAAW,KAAK,QAAQ,CAAC,CAAC;AAC5F,CAAC;AAMD,MAAM,gCAAgC,GAAkC;IACtE,EAAE,EAAE,IAAI;IACR,KAAK,EAAE,IAAI;IACX,OAAO,EAAE,IAAI;IACb,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;IACzB,IAAI,EAAE,IAAI;CACX,CAAC;AAEF,SAAS,cAAc,CAAC,OAAgB;IACtC,MAAM,gBAAgB,GAAY,EAAE,GAAG,OAAO,EAAE,CAAC;IAEjD,KAAK,MAAM,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE;QACvD,IAAI,CAAC,gCAAgC,CAAC,cAAc,CAAC,WAAW,CAAC,EAAE;YACjE,IAAI,WAAW,KAAK,SAAS;gBAC3B,OAAQ,gBAAwB,CAAC,WAAW,CAAC,CAAC;;gBAE9C,MAAM,CAAC,UAAU,CAAC,gCAAgC,CAAC,OAAO,EAAE,qDAAqD,WAAW,2DAA2D,CAAC,CAAC;SAC5L;KACF;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module RPC\n */\n\nimport { Guid, IDisposable, Logger } from \"@itwin/core-bentley\";\nimport { IModelRpcProps, RpcManager } from \"@itwin/core-common\";\nimport { PresentationCommonLoggerCategory } from \"./CommonLoggerCategory\";\nimport { DescriptorJSON, DescriptorOverrides } from \"./content/Descriptor\";\nimport { ItemJSON } from \"./content/Item\";\nimport { DisplayValueGroupJSON } from \"./content/Value\";\nimport { ClientDiagnostics, ClientDiagnosticsAttribute, ClientDiagnosticsHandler } from \"./Diagnostics\";\nimport { InstanceKey } from \"./EC\";\nimport { ElementProperties } from \"./ElementProperties\";\nimport { PresentationError, PresentationStatus } from \"./Error\";\nimport { NodeKey } from \"./hierarchy/Key\";\nimport { NodeJSON } from \"./hierarchy/Node\";\nimport { NodePathElementJSON } from \"./hierarchy/NodePathElement\";\nimport { KeySetJSON } from \"./KeySet\";\nimport { LabelDefinition } from \"./LabelDefinition\";\nimport {\n  ComputeSelectionRequestOptions, ContentDescriptorRequestOptions, ContentInstanceKeysRequestOptions, ContentRequestOptions,\n  ContentSourcesRequestOptions, DisplayLabelRequestOptions, DisplayLabelsRequestOptions, DistinctValuesRequestOptions,\n  FilterByInstancePathsHierarchyRequestOptions, FilterByTextHierarchyRequestOptions, HierarchyLevelDescriptorRequestOptions, HierarchyRequestOptions,\n  Paged, RequestOptions, RequestOptionsWithRuleset, SelectionScopeRequestOptions, SingleElementPropertiesRequestOptions,\n} from \"./PresentationManagerOptions\";\nimport {\n  ContentSourcesRpcResult, PresentationRpcInterface, PresentationRpcRequestOptions, PresentationRpcResponse,\n} from \"./PresentationRpcInterface\";\nimport { Ruleset } from \"./rules/Ruleset\";\nimport { RulesetVariableJSON } from \"./RulesetVariables\";\nimport { SelectionScope } from \"./selection/SelectionScope\";\nimport { PagedResponse } from \"./Utils\";\n\n/**\n * Configuration parameters for [[RpcRequestsHandler]].\n *\n * @internal\n */\nexport interface RpcRequestsHandlerProps {\n  /**\n   * Optional ID used to identify client that requests data. If not specified,\n   * the handler creates a unique GUID as a client id.\n   * @internal\n   */\n  clientId?: string;\n}\n\n/**\n * RPC requests handler that wraps [[PresentationRpcInterface]] and\n * adds handling for cases when backend needs to be synced with client\n * state.\n *\n * @internal\n */\nexport class RpcRequestsHandler implements IDisposable {\n  public readonly maxRequestRepeatCount: number = 5;\n\n  /** ID that identifies this handler as a client */\n  public readonly clientId: string;\n\n  public constructor(props?: RpcRequestsHandlerProps) {\n    this.clientId = (props && props.clientId) ? props.clientId : Guid.createValue();\n  }\n\n  public dispose() {\n  }\n\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  private get rpcClient(): PresentationRpcInterface { return RpcManager.getClientForInterface(PresentationRpcInterface); }\n\n  private async requestRepeatedly<TResult>(func: () => PresentationRpcResponse<TResult>, diagnosticsHandler?: ClientDiagnosticsHandler, repeatCount: number = 1): Promise<TResult> {\n    let diagnostics: ClientDiagnostics | undefined;\n    let error: unknown | undefined;\n    let shouldRepeat = false;\n    try {\n      const response = await func();\n      diagnostics = response.diagnostics;\n\n      if (response.statusCode === PresentationStatus.Success)\n        return response.result!;\n\n      if (response.statusCode === PresentationStatus.BackendTimeout && repeatCount < this.maxRequestRepeatCount)\n        shouldRepeat = true;\n      else\n        error = new PresentationError(response.statusCode, response.errorMessage);\n\n    } catch (e) {\n      error = e;\n      if (repeatCount < this.maxRequestRepeatCount)\n        shouldRepeat = true;\n\n    } finally {\n      diagnosticsHandler && diagnostics && diagnosticsHandler(diagnostics);\n    }\n\n    if (shouldRepeat) {\n      ++repeatCount;\n      return this.requestRepeatedly(func, diagnosticsHandler, repeatCount);\n    }\n\n    throw error;\n  }\n\n  /**\n   * Send the request to backend.\n   *\n   * If the backend responds with [[PresentationStatus.BackendTimeout]] or there's an RPC-related error,\n   * the request is repeated up to `this._maxRequestRepeatCount` times. If we fail to get a valid success or error\n   * response from the backend, throw the last encountered error.\n   *\n   * @internal\n   */\n  public async request<TResult, TOptions extends (RequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute), TArg = any>(\n    func: (token: IModelRpcProps, options: PresentationRpcRequestOptions<TOptions>, ...args: TArg[]) => PresentationRpcResponse<TResult>,\n    options: TOptions,\n    ...additionalOptions: TArg[]\n  ): Promise<TResult> {\n    const { imodel, diagnostics, ...optionsNoIModel } = options;\n    const { handler: diagnosticsHandler, ...diagnosticsOptions } = diagnostics ?? {};\n    if (isOptionsWithRuleset(optionsNoIModel))\n      optionsNoIModel.rulesetOrId = cleanupRuleset(optionsNoIModel.rulesetOrId);\n    const rpcOptions: PresentationRpcRequestOptions<TOptions> = {\n      ...optionsNoIModel,\n      clientId: this.clientId,\n    };\n    if (diagnostics)\n      rpcOptions.diagnostics = diagnosticsOptions;\n    const doRequest = async () => func(imodel, rpcOptions, ...additionalOptions);\n    return this.requestRepeatedly(doRequest, diagnosticsHandler);\n  }\n\n  public async getNodesCount(options: HierarchyRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<number> {\n    return this.request<number, typeof options>(\n      this.rpcClient.getNodesCount.bind(this.rpcClient), options);\n  }\n  // eslint-disable-next-line deprecation/deprecation\n  public async getPagedNodes(options: Paged<HierarchyRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON>> & ClientDiagnosticsAttribute): Promise<PagedResponse<NodeJSON>> {\n    // eslint-disable-next-line deprecation/deprecation\n    return this.request<PagedResponse<NodeJSON>, typeof options>(\n      this.rpcClient.getPagedNodes.bind(this.rpcClient), options);\n  }\n\n  public async getNodesDescriptor(options: HierarchyLevelDescriptorRequestOptions<IModelRpcProps, NodeKey, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<DescriptorJSON | undefined> {\n    const response = await this.request<string | DescriptorJSON | undefined, typeof options>(\n      this.rpcClient.getNodesDescriptor.bind(this.rpcClient), options);\n    if (typeof response === \"string\")\n      return JSON.parse(response);\n    return response;\n  }\n\n  // eslint-disable-next-line deprecation/deprecation\n  public async getNodePaths(options: FilterByInstancePathsHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<NodePathElementJSON[]> {\n    // eslint-disable-next-line deprecation/deprecation\n    return this.request<NodePathElementJSON[], typeof options>(\n      this.rpcClient.getNodePaths.bind(this.rpcClient), options);\n  }\n  // eslint-disable-next-line deprecation/deprecation\n  public async getFilteredNodePaths(options: FilterByTextHierarchyRequestOptions<IModelRpcProps, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<NodePathElementJSON[]> {\n    // eslint-disable-next-line deprecation/deprecation\n    return this.request<NodePathElementJSON[], typeof options>(\n      this.rpcClient.getFilteredNodePaths.bind(this.rpcClient), options);\n  }\n\n  public async getContentSources(options: ContentSourcesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ContentSourcesRpcResult> {\n    return this.request<ContentSourcesRpcResult, typeof options>(\n      this.rpcClient.getContentSources.bind(this.rpcClient), options);\n  }\n  public async getContentDescriptor(options: ContentDescriptorRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<DescriptorJSON | undefined> {\n    return this.request<DescriptorJSON | undefined, typeof options>(\n      this.rpcClient.getContentDescriptor.bind(this.rpcClient), options);\n  }\n  public async getContentSetSize(options: ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<number> {\n    return this.request<number, typeof options>(\n      this.rpcClient.getContentSetSize.bind(this.rpcClient), options);\n  }\n  public async getPagedContent(options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>) {\n    return this.request<{ descriptor: DescriptorJSON, contentSet: PagedResponse<ItemJSON> } | undefined, typeof options>(\n      this.rpcClient.getPagedContent.bind(this.rpcClient), options);\n  }\n  public async getPagedContentSet(options: Paged<ContentRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute>) {\n    return this.request<PagedResponse<ItemJSON>, typeof options>(\n      this.rpcClient.getPagedContentSet.bind(this.rpcClient), options);\n  }\n\n  // eslint-disable-next-line deprecation/deprecation\n  public async getPagedDistinctValues(options: DistinctValuesRequestOptions<IModelRpcProps, DescriptorOverrides, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<PagedResponse<DisplayValueGroupJSON>> {\n    // eslint-disable-next-line deprecation/deprecation\n    return this.request<PagedResponse<DisplayValueGroupJSON>, typeof options>(\n      this.rpcClient.getPagedDistinctValues.bind(this.rpcClient), options);\n  }\n\n  public async getElementProperties(options: SingleElementPropertiesRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<ElementProperties | undefined> {\n    return this.request<ElementProperties | undefined, typeof options>(\n      this.rpcClient.getElementProperties.bind(this.rpcClient), options);\n  }\n\n  public async getContentInstanceKeys(options: ContentInstanceKeysRequestOptions<IModelRpcProps, KeySetJSON, RulesetVariableJSON> & ClientDiagnosticsAttribute): Promise<{ total: number, items: KeySetJSON }> {\n    return this.request<{ total: number, items: KeySetJSON }, typeof options>(\n      this.rpcClient.getContentInstanceKeys.bind(this.rpcClient), options);\n  }\n\n  public async getDisplayLabelDefinition(options: DisplayLabelRequestOptions<IModelRpcProps, InstanceKey> & ClientDiagnosticsAttribute): Promise<LabelDefinition> {\n    return this.request<LabelDefinition, typeof options>(\n      this.rpcClient.getDisplayLabelDefinition.bind(this.rpcClient), options);\n  }\n  public async getPagedDisplayLabelDefinitions(options: DisplayLabelsRequestOptions<IModelRpcProps, InstanceKey> & ClientDiagnosticsAttribute): Promise<PagedResponse<LabelDefinition>> {\n    return this.request<PagedResponse<LabelDefinition>, typeof options>(\n      this.rpcClient.getPagedDisplayLabelDefinitions.bind(this.rpcClient), options);\n  }\n\n  public async getSelectionScopes(options: SelectionScopeRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<SelectionScope[]> {\n    return this.request<SelectionScope[], typeof options>(\n      this.rpcClient.getSelectionScopes.bind(this.rpcClient), options);\n  }\n  public async computeSelection(options: ComputeSelectionRequestOptions<IModelRpcProps> & ClientDiagnosticsAttribute): Promise<KeySetJSON> {\n    return this.request<KeySetJSON, typeof options>(\n      // eslint-disable-next-line deprecation/deprecation\n      this.rpcClient.computeSelection.bind(this.rpcClient), options);\n  }\n}\n\nfunction isOptionsWithRuleset(options: Object): options is { rulesetOrId: Ruleset } {\n  return (typeof (options as RequestOptionsWithRuleset<any, any>).rulesetOrId === \"object\");\n}\n\ntype RulesetWithRequiredProperties = {\n  [key in keyof Ruleset]-?: true;\n};\n\nconst RULESET_SUPPORTED_PROPERTIES_OBJ: RulesetWithRequiredProperties = {\n  id: true,\n  rules: true,\n  version: true,\n  requiredSchemas: true,\n  supplementationInfo: true,\n  vars: true,\n};\n\nfunction cleanupRuleset(ruleset: Ruleset): Ruleset {\n  const cleanedUpRuleset: Ruleset = { ...ruleset };\n\n  for (const propertyKey of Object.keys(cleanedUpRuleset)) {\n    if (!RULESET_SUPPORTED_PROPERTIES_OBJ.hasOwnProperty(propertyKey)) {\n      if (propertyKey === \"$schema\")\n        delete (cleanedUpRuleset as any)[propertyKey];\n      else\n        Logger.logWarning(PresentationCommonLoggerCategory.Package, `Provided ruleset contains unrecognized attribute '${propertyKey}'. It either doesn't exist or may be no longer supported.`);\n    }\n  }\n\n  return cleanedUpRuleset;\n}\n"]}