@itwin/core-common 4.0.0-dev.52 → 4.0.0-dev.55

package/lib/cjs/rpc/core/RpcOperation.js

@@ -1,135 +1,136 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module RpcInterface
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RpcOperation = exports.RpcOperationPolicy = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-const IModelError_1 = require("../../IModelError");
-const RpcConstants_1 = require("./RpcConstants");
-const RpcRegistry_1 = require("./RpcRegistry");
-/* eslint-disable deprecation/deprecation */
-/** The policy for an RPC operation.
- * @internal
- */
-class RpcOperationPolicy {
-    constructor() {
-        /** Supplies the IModelRpcProps for an operation request. */
-        this.token = (request) => request.findTokenPropsParameter();
-        /** Supplies the initial retry interval for an operation request. */
-        this.retryInterval = (configuration) => configuration.pendingOperationRetryInterval;
-        /** Called before every operation request on the frontend is sent. */
-        this.requestCallback = (_request) => { };
-        /** Called after every operation request on the frontend is sent. */
-        this.sentCallback = (_request) => { };
-        /**
-         * Determines if caching is permitted for an operation response.
-         * @note Not all RPC protocols support caching.
-         */
-        this.allowResponseCaching = (_request) => RpcConstants_1.RpcResponseCacheControl.None;
-        /** Forces RpcConfiguration.strictMode for this operation. */
-        this.forceStrictMode = false;
-        /** Whether the IModelRpcProps in the operation parameter list is allowed to differ from the token in the request URL. */
-        this.allowTokenMismatch = false;
-        /** Whether to compress the operation response with one of the client's supported encodings. */
-        this.allowResponseCompression = false;
-    }
-}
-exports.RpcOperationPolicy = RpcOperationPolicy;
-/** An RPC operation descriptor.
- * @internal
- */
-class RpcOperation {
-    /** @internal */
-    constructor(definition, operation, policy) {
-        this.interfaceDefinition = definition;
-        this.operationName = operation;
-        this.policy = policy;
-    }
-    /** Looks up an RPC operation by name. */
-    static lookup(target, operationName) {
-        const definition = typeof (target) === "string" ? RpcRegistry_1.RpcRegistry.instance.lookupInterfaceDefinition(target) : target;
-        const propertyName = RpcOperation.computeOperationName(operationName);
-        const proto = definition.prototype;
-        if (!proto.hasOwnProperty(propertyName))
-            throw new IModelError_1.IModelError(core_bentley_1.BentleyStatus.ERROR, `RPC interface class "${definition.interfaceName}" does not does not declare operation "${operationName}"`);
-        return proto[propertyName][RpcRegistry_1.OPERATION];
-    }
-    /** Iterates the operations of an RPC interface definition. */
-    static forEach(definition, callback) {
-        Object.getOwnPropertyNames(definition.prototype).forEach((operationName) => {
-            if (operationName === "constructor" || operationName === "configurationSupplier")
-                return;
-            const propertyName = RpcOperation.computeOperationName(operationName);
-            callback(definition.prototype[propertyName][RpcRegistry_1.OPERATION]);
-        });
-    }
-    /** The version of this operation. */
-    get interfaceVersion() { return this.interfaceDefinition.interfaceVersion; }
-    /** @internal */
-    static computeOperationName(identifier) {
-        const c = identifier.indexOf(":");
-        if (c === -1)
-            return identifier;
-        return identifier.substring(0, c + 1);
-    }
-}
-exports.RpcOperation = RpcOperation;
-/** A fallback token to use for RPC requests that do not semantically depend on an iModel. */
-RpcOperation.fallbackToken = undefined;
-/** @internal */
-(function (RpcOperation) {
-    function obtainInstance(obj) {
-        if (obj instanceof RpcOperationPolicy) {
-            return obj;
-        }
-        else {
-            const instance = new RpcOperationPolicy();
-            Object.assign(instance, obj);
-            return instance;
-        }
-    }
-    /** Decorator for setting the policy for an RPC operation function. */
-    function setPolicy(policy) {
-        return (target, propertyKey, descriptor) => {
-            descriptor.value[RpcRegistry_1.OPERATION] = new RpcOperation(target.constructor, propertyKey, obtainInstance(policy));
-        };
-    }
-    RpcOperation.setPolicy = setPolicy;
-    /** Convenience decorator for setting an RPC operation policy that allows response caching. */
-    function allowResponseCaching(control = RpcConstants_1.RpcResponseCacheControl.Immutable) {
-        return (target, propertyKey, descriptor) => {
-            descriptor.value[RpcRegistry_1.OPERATION] = new RpcOperation(target.constructor, propertyKey, new class extends RpcOperationPolicy {
-                constructor() {
-                    super(...arguments);
-                    this.allowResponseCaching = () => control;
-                }
-            }());
-        };
-    }
-    RpcOperation.allowResponseCaching = allowResponseCaching;
-    /** Convenience decorator for setting an RPC operation policy that supplies the IModelRpcProps for an operation. */
-    function setRoutingProps(handler) {
-        return (target, propertyKey, descriptor) => {
-            descriptor.value[RpcRegistry_1.OPERATION] = new RpcOperation(target.constructor, propertyKey, new class extends RpcOperationPolicy {
-                constructor() {
-                    super(...arguments);
-                    this.token = handler;
-                }
-            }());
-        };
-    }
-    RpcOperation.setRoutingProps = setRoutingProps;
-    /** Decorator for setting the default policy for an RPC interface definition class. */
-    function setDefaultPolicy(policy) {
-        return (definition) => {
-            definition[RpcRegistry_1.POLICY] = obtainInstance(policy);
-        };
-    }
-    RpcOperation.setDefaultPolicy = setDefaultPolicy;
-})(RpcOperation = exports.RpcOperation || (exports.RpcOperation = {}));
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RpcOperation = exports.RpcOperationPolicy = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const IModelError_1 = require("../../IModelError");
+const RpcConstants_1 = require("./RpcConstants");
+const RpcRegistry_1 = require("./RpcRegistry");
+/* eslint-disable deprecation/deprecation */
+/** The policy for an RPC operation.
+ * @internal
+ */
+class RpcOperationPolicy {
+    constructor() {
+        /** Supplies the IModelRpcProps for an operation request. */
+        this.token = (request) => request.findTokenPropsParameter();
+        /** Supplies the initial retry interval for an operation request. */
+        this.retryInterval = (configuration) => configuration.pendingOperationRetryInterval;
+        /** Called before every operation request on the frontend is sent. */
+        this.requestCallback = (_request) => { };
+        /** Called after every operation request on the frontend is sent. */
+        this.sentCallback = (_request) => { };
+        /**
+         * Determines if caching is permitted for an operation response.
+         * @note Not all RPC protocols support caching.
+         */
+        this.allowResponseCaching = (_request) => RpcConstants_1.RpcResponseCacheControl.None;
+        /** Forces RpcConfiguration.strictMode for this operation. */
+        this.forceStrictMode = false;
+        /** Whether the IModelRpcProps in the operation parameter list is allowed to differ from the token in the request URL. */
+        this.allowTokenMismatch = false;
+        /** Whether to compress the operation response with one of the client's supported encodings. */
+        this.allowResponseCompression = false;
+    }
+}
+exports.RpcOperationPolicy = RpcOperationPolicy;
+/** An RPC operation descriptor.
+ * @internal
+ */
+class RpcOperation {
+    /** Looks up an RPC operation by name. */
+    static lookup(target, operationName) {
+        const definition = typeof (target) === "string" ? RpcRegistry_1.RpcRegistry.instance.lookupInterfaceDefinition(target) : target;
+        const propertyName = RpcOperation.computeOperationName(operationName);
+        const proto = definition.prototype;
+        if (!proto.hasOwnProperty(propertyName))
+            throw new IModelError_1.IModelError(core_bentley_1.BentleyStatus.ERROR, `RPC interface class "${definition.interfaceName}" does not does not declare operation "${operationName}"`);
+        return proto[propertyName][RpcRegistry_1.OPERATION];
+    }
+    /** Iterates the operations of an RPC interface definition. */
+    static forEach(definition, callback) {
+        Object.getOwnPropertyNames(definition.prototype).forEach((operationName) => {
+            if (operationName === "constructor" || operationName === "configurationSupplier")
+                return;
+            const propertyName = RpcOperation.computeOperationName(operationName);
+            callback(definition.prototype[propertyName][RpcRegistry_1.OPERATION]);
+        });
+    }
+    /** The version of this operation. */
+    get interfaceVersion() { return this.interfaceDefinition.interfaceVersion; }
+    /** @internal */
+    constructor(definition, operation, policy) {
+        this.interfaceDefinition = definition;
+        this.operationName = operation;
+        this.policy = policy;
+    }
+    /** @internal */
+    static computeOperationName(identifier) {
+        const c = identifier.indexOf(":");
+        if (c === -1)
+            return identifier;
+        return identifier.substring(0, c + 1);
+    }
+}
+/** A fallback token to use for RPC requests that do not semantically depend on an iModel. */
+RpcOperation.fallbackToken = undefined;
+exports.RpcOperation = RpcOperation;
+/** @internal */
+(function (RpcOperation) {
+    function obtainInstance(obj) {
+        if (obj instanceof RpcOperationPolicy) {
+            return obj;
+        }
+        else {
+            const instance = new RpcOperationPolicy();
+            Object.assign(instance, obj);
+            return instance;
+        }
+    }
+    /** Decorator for setting the policy for an RPC operation function. */
+    function setPolicy(policy) {
+        return (target, propertyKey, descriptor) => {
+            descriptor.value[RpcRegistry_1.OPERATION] = new RpcOperation(target.constructor, propertyKey, obtainInstance(policy));
+        };
+    }
+    RpcOperation.setPolicy = setPolicy;
+    /** Convenience decorator for setting an RPC operation policy that allows response caching. */
+    function allowResponseCaching(control = RpcConstants_1.RpcResponseCacheControl.Immutable) {
+        return (target, propertyKey, descriptor) => {
+            descriptor.value[RpcRegistry_1.OPERATION] = new RpcOperation(target.constructor, propertyKey, new class extends RpcOperationPolicy {
+                constructor() {
+                    super(...arguments);
+                    this.allowResponseCaching = () => control;
+                }
+            }());
+        };
+    }
+    RpcOperation.allowResponseCaching = allowResponseCaching;
+    /** Convenience decorator for setting an RPC operation policy that supplies the IModelRpcProps for an operation. */
+    function setRoutingProps(handler) {
+        return (target, propertyKey, descriptor) => {
+            descriptor.value[RpcRegistry_1.OPERATION] = new RpcOperation(target.constructor, propertyKey, new class extends RpcOperationPolicy {
+                constructor() {
+                    super(...arguments);
+                    this.token = handler;
+                }
+            }());
+        };
+    }
+    RpcOperation.setRoutingProps = setRoutingProps;
+    /** Decorator for setting the default policy for an RPC interface definition class. */
+    function setDefaultPolicy(policy) {
+        return (definition) => {
+            definition[RpcRegistry_1.POLICY] = obtainInstance(policy);
+        };
+    }
+    RpcOperation.setDefaultPolicy = setDefaultPolicy;
+})(RpcOperation = exports.RpcOperation || (exports.RpcOperation = {}));
+exports.RpcOperation = RpcOperation;
 //# sourceMappingURL=RpcOperation.js.map

package/lib/cjs/rpc/core/RpcOperation.js.map

@@ -1 +1 @@
-{"version":3,"file":"RpcOperation.js","sourceRoot":"","sources":["../../../../src/rpc/core/RpcOperation.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAoD;AAEpD,mDAAgD;AAEhD,iDAAyD;AACzD,+CAA+D;AAK/D,4CAA4C;AAE5C;;GAEG;AACH,MAAa,kBAAkB;IAA/B;QACE,4DAA4D;QACrD,UAAK,GAA8B,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,uBAAuB,EAAE,CAAC;QAEzF,oEAAoE;QAC7D,kBAAa,GAA6C,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,CAAC,6BAA6B,CAAC;QAEhI,qEAAqE;QAC9D,oBAAe,GAAyB,CAAC,QAAQ,EAAE,EAAE,GAAG,CAAC,CAAC;QAEjE,oEAAoE;QAC7D,iBAAY,GAAyB,CAAC,QAAQ,EAAE,EAAE,GAAG,CAAC,CAAC;QAE9D;;;WAGG;QACI,yBAAoB,GAAiC,CAAC,QAAQ,EAAE,EAAE,CAAC,sCAAuB,CAAC,IAAI,CAAC;QAEvG,6DAA6D;QACtD,oBAAe,GAAY,KAAK,CAAC;QAExC,yHAAyH;QAClH,uBAAkB,GAAY,KAAK,CAAC;QAE3C,+FAA+F;QACxF,6BAAwB,GAAY,KAAK,CAAC;IACnD,CAAC;CAAA;AA3BD,gDA2BC;AAED;;GAEG;AACH,MAAa,YAAY;IAuCvB,gBAAgB;IAChB,YAAmB,UAAkC,EAAE,SAAiB,EAAE,MAA0B;QAClG,IAAI,CAAC,mBAAmB,GAAG,UAAU,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAxCD,yCAAyC;IAClC,MAAM,CAAC,MAAM,CAAC,MAAuC,EAAE,aAAqB;QACjF,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,yBAAW,CAAC,QAAQ,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QAClH,MAAM,YAAY,GAAoB,YAAY,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC;QAEvF,MAAM,KAAK,GAAI,UAAU,CAAC,SAAiB,CAAC;QAC5C,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,YAAY,CAAC;YACrC,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,wBAAwB,UAAU,CAAC,aAAa,0CAA0C,aAAa,GAAG,CAAC,CAAC;QAEzJ,OAAO,KAAK,CAAC,YAAY,CAAC,CAAC,uBAAS,CAAC,CAAC;IACxC,CAAC;IAED,8DAA8D;IACvD,MAAM,CAAC,OAAO,CAAC,UAAkC,EAAE,QAA2C;QACnG,MAAM,CAAC,mBAAmB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;YACzE,IAAI,aAAa,KAAK,aAAa,IAAI,aAAa,KAAK,uBAAuB;gBAC9E,OAAO;YAET,MAAM,YAAY,GAAG,YAAY,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC;YACtE,QAAQ,CAAE,UAAU,CAAC,SAAiB,CAAC,YAAY,CAAC,CAAC,uBAAS,CAAC,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC;IAQD,qCAAqC;IACrC,IAAW,gBAAgB,KAAa,OAAO,IAAI,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAY3F,gBAAgB;IACT,MAAM,CAAC,oBAAoB,CAAC,UAAkB;QACnD,MAAM,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,CAAC,KAAK,CAAC,CAAC;YACV,OAAO,UAAU,CAAC;QAEpB,OAAO,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACxC,CAAC;;AArDH,oCAsDC;AArDC,6FAA6F;AAC/E,0BAAa,GAA+B,SAAS,CAAC;AAyDtE,gBAAgB;AAChB,WAAiB,YAAY;IAC3B,SAAS,cAAc,CAAC,GAAiD;QACvE,IAAI,GAAG,YAAY,kBAAkB,EAAE;YACrC,OAAO,GAAG,CAAC;SACZ;aAAM;YACL,MAAM,QAAQ,GAAG,IAAI,kBAAkB,EAAE,CAAC;YAC1C,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;YAC7B,OAAO,QAAQ,CAAC;SACjB;IACH,CAAC;IAED,sEAAsE;IACtE,SAAgB,SAAS,CAAC,MAAoD;QAC5E,OAAO,CAAyB,MAAS,EAAE,WAAmB,EAAE,UAA8B,EAAE,EAAE;YAChG,UAAU,CAAC,KAAK,CAAC,uBAAS,CAAC,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,WAAkB,EAAE,WAAW,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;QACjH,CAAC,CAAC;IACJ,CAAC;IAJe,sBAAS,YAIxB,CAAA;IAED,8FAA8F;IAC9F,SAAgB,oBAAoB,CAAC,UAAmC,sCAAuB,CAAC,SAAS;QACvG,OAAO,CAAyB,MAAS,EAAE,WAAmB,EAAE,UAA8B,EAAE,EAAE;YAChG,UAAU,CAAC,KAAK,CAAC,uBAAS,CAAC,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,WAAkB,EAAE,WAAW,EAAE,IAAI,KAAM,SAAQ,kBAAkB;gBAAhC;;oBACzE,yBAAoB,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC;gBACvD,CAAC;aAAA,EAAE,CAAC,CAAC;QACP,CAAC,CAAC;IACJ,CAAC;IANe,iCAAoB,uBAMnC,CAAA;IAED,mHAAmH;IACnH,SAAgB,eAAe,CAAC,OAAkC;QAChE,OAAO,CAAyB,MAAS,EAAE,WAAmB,EAAE,UAA8B,EAAE,EAAE;YAChG,UAAU,CAAC,KAAK,CAAC,uBAAS,CAAC,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,WAAkB,EAAE,WAAW,EAAE,IAAI,KAAM,SAAQ,kBAAkB;gBAAhC;;oBACzE,UAAK,GAAG,OAAO,CAAC;gBAClC,CAAC;aAAA,EAAE,CAAC,CAAC;QACP,CAAC,CAAC;IACJ,CAAC;IANe,4BAAe,kBAM9B,CAAA;IAED,sFAAsF;IACtF,SAAgB,gBAAgB,CAAC,MAAoD;QACnF,OAAO,CAAyB,UAAqC,EAAE,EAAE;YACtE,UAAkB,CAAC,oBAAM,CAAC,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;QACvD,CAAC,CAAC;IACJ,CAAC;IAJe,6BAAgB,mBAI/B,CAAA;AACH,CAAC,EA1CgB,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QA0C5B","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 RpcInterface\r\n */\r\n\r\nimport { BentleyStatus } from \"@itwin/core-bentley\";\r\nimport { IModelRpcProps } from \"../../IModel\";\r\nimport { IModelError } from \"../../IModelError\";\r\nimport { RpcInterface, RpcInterfaceDefinition } from \"../../RpcInterface\";\r\nimport { RpcResponseCacheControl } from \"./RpcConstants\";\r\nimport { OPERATION, POLICY, RpcRegistry } from \"./RpcRegistry\";\r\nimport {\r\n  RpcRequestCallback_T, RpcRequestInitialRetryIntervalSupplier_T, RpcRequestTokenSupplier_T, RpcResponseCachingCallback_T,\r\n} from \"./RpcRequest\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/** The policy for an RPC operation.\r\n * @internal\r\n */\r\nexport class RpcOperationPolicy {\r\n  /** Supplies the IModelRpcProps for an operation request. */\r\n  public token: RpcRequestTokenSupplier_T = (request) => request.findTokenPropsParameter();\r\n\r\n  /** Supplies the initial retry interval for an operation request. */\r\n  public retryInterval: RpcRequestInitialRetryIntervalSupplier_T = (configuration) => configuration.pendingOperationRetryInterval;\r\n\r\n  /** Called before every operation request on the frontend is sent. */\r\n  public requestCallback: RpcRequestCallback_T = (_request) => { };\r\n\r\n  /** Called after every operation request on the frontend is sent. */\r\n  public sentCallback: RpcRequestCallback_T = (_request) => { };\r\n\r\n  /**\r\n   * Determines if caching is permitted for an operation response.\r\n   * @note Not all RPC protocols support caching.\r\n   */\r\n  public allowResponseCaching: RpcResponseCachingCallback_T = (_request) => RpcResponseCacheControl.None;\r\n\r\n  /** Forces RpcConfiguration.strictMode for this operation. */\r\n  public forceStrictMode: boolean = false;\r\n\r\n  /** Whether the IModelRpcProps in the operation parameter list is allowed to differ from the token in the request URL. */\r\n  public allowTokenMismatch: boolean = false;\r\n\r\n  /** Whether to compress the operation response with one of the client's supported encodings. */\r\n  public allowResponseCompression: boolean = false;\r\n}\r\n\r\n/** An RPC operation descriptor.\r\n * @internal\r\n */\r\nexport class RpcOperation {\r\n  /** A fallback token to use for RPC requests that do not semantically depend on an iModel. */\r\n  public static fallbackToken: IModelRpcProps | undefined = undefined;\r\n\r\n  /** Looks up an RPC operation by name. */\r\n  public static lookup(target: string | RpcInterfaceDefinition, operationName: string): RpcOperation {\r\n    const definition = typeof (target) === \"string\" ? RpcRegistry.instance.lookupInterfaceDefinition(target) : target;\r\n    const propertyName: string | symbol = RpcOperation.computeOperationName(operationName);\r\n\r\n    const proto = (definition.prototype as any);\r\n    if (!proto.hasOwnProperty(propertyName))\r\n      throw new IModelError(BentleyStatus.ERROR, `RPC interface class \"${definition.interfaceName}\" does not does not declare operation \"${operationName}\"`);\r\n\r\n    return proto[propertyName][OPERATION];\r\n  }\r\n\r\n  /** Iterates the operations of an RPC interface definition. */\r\n  public static forEach(definition: RpcInterfaceDefinition, callback: (operation: RpcOperation) => void): void {\r\n    Object.getOwnPropertyNames(definition.prototype).forEach((operationName) => {\r\n      if (operationName === \"constructor\" || operationName === \"configurationSupplier\")\r\n        return;\r\n\r\n      const propertyName = RpcOperation.computeOperationName(operationName);\r\n      callback((definition.prototype as any)[propertyName][OPERATION]);\r\n    });\r\n  }\r\n\r\n  /** The RPC interface definition for this operation. */\r\n  public readonly interfaceDefinition: RpcInterfaceDefinition;\r\n\r\n  /** The name of this operation. */\r\n  public readonly operationName: string;\r\n\r\n  /** The version of this operation. */\r\n  public get interfaceVersion(): string { return this.interfaceDefinition.interfaceVersion; }\r\n\r\n  /** The policy for this operation. */\r\n  public policy: RpcOperationPolicy;\r\n\r\n  /** @internal */\r\n  public constructor(definition: RpcInterfaceDefinition, operation: string, policy: RpcOperationPolicy) {\r\n    this.interfaceDefinition = definition;\r\n    this.operationName = operation;\r\n    this.policy = policy;\r\n  }\r\n\r\n  /** @internal */\r\n  public static computeOperationName(identifier: string): string {\r\n    const c = identifier.indexOf(\":\");\r\n    if (c === -1)\r\n      return identifier;\r\n\r\n    return identifier.substring(0, c + 1);\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport type RpcOperationPolicyProps = Partial<RpcOperationPolicy>;\r\n\r\n/** @internal */\r\nexport namespace RpcOperation { // eslint-disable-line no-redeclare\r\n  function obtainInstance(obj: RpcOperationPolicy | RpcOperationPolicyProps) {\r\n    if (obj instanceof RpcOperationPolicy) {\r\n      return obj;\r\n    } else {\r\n      const instance = new RpcOperationPolicy();\r\n      Object.assign(instance, obj);\r\n      return instance;\r\n    }\r\n  }\r\n\r\n  /** Decorator for setting the policy for an RPC operation function. */\r\n  export function setPolicy(policy: RpcOperationPolicy | RpcOperationPolicyProps) {\r\n    return <T extends RpcInterface>(target: T, propertyKey: string, descriptor: PropertyDescriptor) => {\r\n      descriptor.value[OPERATION] = new RpcOperation(target.constructor as any, propertyKey, obtainInstance(policy));\r\n    };\r\n  }\r\n\r\n  /** Convenience decorator for setting an RPC operation policy that allows response caching. */\r\n  export function allowResponseCaching(control: RpcResponseCacheControl = RpcResponseCacheControl.Immutable) {\r\n    return <T extends RpcInterface>(target: T, propertyKey: string, descriptor: PropertyDescriptor) => {\r\n      descriptor.value[OPERATION] = new RpcOperation(target.constructor as any, propertyKey, new class extends RpcOperationPolicy {\r\n        public override allowResponseCaching = () => control;\r\n      }());\r\n    };\r\n  }\r\n\r\n  /** Convenience decorator for setting an RPC operation policy that supplies the IModelRpcProps for an operation. */\r\n  export function setRoutingProps(handler: RpcRequestTokenSupplier_T) {\r\n    return <T extends RpcInterface>(target: T, propertyKey: string, descriptor: PropertyDescriptor) => {\r\n      descriptor.value[OPERATION] = new RpcOperation(target.constructor as any, propertyKey, new class extends RpcOperationPolicy {\r\n        public override token = handler;\r\n      }());\r\n    };\r\n  }\r\n\r\n  /** Decorator for setting the default policy for an RPC interface definition class. */\r\n  export function setDefaultPolicy(policy: RpcOperationPolicy | RpcOperationPolicyProps) {\r\n    return <T extends RpcInterface>(definition: RpcInterfaceDefinition<T>) => {\r\n      (definition as any)[POLICY] = obtainInstance(policy);\r\n    };\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"RpcOperation.js","sourceRoot":"","sources":["../../../../src/rpc/core/RpcOperation.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAoD;AAEpD,mDAAgD;AAEhD,iDAAyD;AACzD,+CAA+D;AAK/D,4CAA4C;AAE5C;;GAEG;AACH,MAAa,kBAAkB;IAA/B;QACE,4DAA4D;QACrD,UAAK,GAA8B,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,uBAAuB,EAAE,CAAC;QAEzF,oEAAoE;QAC7D,kBAAa,GAA6C,CAAC,aAAa,EAAE,EAAE,CAAC,aAAa,CAAC,6BAA6B,CAAC;QAEhI,qEAAqE;QAC9D,oBAAe,GAAyB,CAAC,QAAQ,EAAE,EAAE,GAAG,CAAC,CAAC;QAEjE,oEAAoE;QAC7D,iBAAY,GAAyB,CAAC,QAAQ,EAAE,EAAE,GAAG,CAAC,CAAC;QAE9D;;;WAGG;QACI,yBAAoB,GAAiC,CAAC,QAAQ,EAAE,EAAE,CAAC,sCAAuB,CAAC,IAAI,CAAC;QAEvG,6DAA6D;QACtD,oBAAe,GAAY,KAAK,CAAC;QAExC,yHAAyH;QAClH,uBAAkB,GAAY,KAAK,CAAC;QAE3C,+FAA+F;QACxF,6BAAwB,GAAY,KAAK,CAAC;IACnD,CAAC;CAAA;AA3BD,gDA2BC;AAED;;GAEG;AACH,MAAa,YAAY;IAIvB,yCAAyC;IAClC,MAAM,CAAC,MAAM,CAAC,MAAuC,EAAE,aAAqB;QACjF,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,yBAAW,CAAC,QAAQ,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QAClH,MAAM,YAAY,GAAoB,YAAY,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC;QAEvF,MAAM,KAAK,GAAI,UAAU,CAAC,SAAiB,CAAC;QAC5C,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,YAAY,CAAC;YACrC,MAAM,IAAI,yBAAW,CAAC,4BAAa,CAAC,KAAK,EAAE,wBAAwB,UAAU,CAAC,aAAa,0CAA0C,aAAa,GAAG,CAAC,CAAC;QAEzJ,OAAO,KAAK,CAAC,YAAY,CAAC,CAAC,uBAAS,CAAC,CAAC;IACxC,CAAC;IAED,8DAA8D;IACvD,MAAM,CAAC,OAAO,CAAC,UAAkC,EAAE,QAA2C;QACnG,MAAM,CAAC,mBAAmB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;YACzE,IAAI,aAAa,KAAK,aAAa,IAAI,aAAa,KAAK,uBAAuB;gBAC9E,OAAO;YAET,MAAM,YAAY,GAAG,YAAY,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC;YACtE,QAAQ,CAAE,UAAU,CAAC,SAAiB,CAAC,YAAY,CAAC,CAAC,uBAAS,CAAC,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC;IAQD,qCAAqC;IACrC,IAAW,gBAAgB,KAAa,OAAO,IAAI,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAK3F,gBAAgB;IAChB,YAAmB,UAAkC,EAAE,SAAiB,EAAE,MAA0B;QAClG,IAAI,CAAC,mBAAmB,GAAG,UAAU,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC;QAC/B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,oBAAoB,CAAC,UAAkB;QACnD,MAAM,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,CAAC,KAAK,CAAC,CAAC;YACV,OAAO,UAAU,CAAC;QAEpB,OAAO,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACxC,CAAC;;AApDD,6FAA6F;AAC/E,0BAAa,GAA+B,SAAS,CAAC;AAFzD,oCAAY;AA2DzB,gBAAgB;AAChB,WAAiB,YAAY;IAC3B,SAAS,cAAc,CAAC,GAAiD;QACvE,IAAI,GAAG,YAAY,kBAAkB,EAAE;YACrC,OAAO,GAAG,CAAC;SACZ;aAAM;YACL,MAAM,QAAQ,GAAG,IAAI,kBAAkB,EAAE,CAAC;YAC1C,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;YAC7B,OAAO,QAAQ,CAAC;SACjB;IACH,CAAC;IAED,sEAAsE;IACtE,SAAgB,SAAS,CAAC,MAAoD;QAC5E,OAAO,CAAyB,MAAS,EAAE,WAAmB,EAAE,UAA8B,EAAE,EAAE;YAChG,UAAU,CAAC,KAAK,CAAC,uBAAS,CAAC,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,WAAkB,EAAE,WAAW,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;QACjH,CAAC,CAAC;IACJ,CAAC;IAJe,sBAAS,YAIxB,CAAA;IAED,8FAA8F;IAC9F,SAAgB,oBAAoB,CAAC,UAAmC,sCAAuB,CAAC,SAAS;QACvG,OAAO,CAAyB,MAAS,EAAE,WAAmB,EAAE,UAA8B,EAAE,EAAE;YAChG,UAAU,CAAC,KAAK,CAAC,uBAAS,CAAC,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,WAAkB,EAAE,WAAW,EAAE,IAAI,KAAM,SAAQ,kBAAkB;gBAAhC;;oBACzE,yBAAoB,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC;gBACvD,CAAC;aAAA,EAAE,CAAC,CAAC;QACP,CAAC,CAAC;IACJ,CAAC;IANe,iCAAoB,uBAMnC,CAAA;IAED,mHAAmH;IACnH,SAAgB,eAAe,CAAC,OAAkC;QAChE,OAAO,CAAyB,MAAS,EAAE,WAAmB,EAAE,UAA8B,EAAE,EAAE;YAChG,UAAU,CAAC,KAAK,CAAC,uBAAS,CAAC,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,WAAkB,EAAE,WAAW,EAAE,IAAI,KAAM,SAAQ,kBAAkB;gBAAhC;;oBACzE,UAAK,GAAG,OAAO,CAAC;gBAClC,CAAC;aAAA,EAAE,CAAC,CAAC;QACP,CAAC,CAAC;IACJ,CAAC;IANe,4BAAe,kBAM9B,CAAA;IAED,sFAAsF;IACtF,SAAgB,gBAAgB,CAAC,MAAoD;QACnF,OAAO,CAAyB,UAAqC,EAAE,EAAE;YACtE,UAAkB,CAAC,oBAAM,CAAC,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;QACvD,CAAC,CAAC;IACJ,CAAC;IAJe,6BAAgB,mBAI/B,CAAA;AACH,CAAC,EA1CgB,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QA0C5B;AAtGY,oCAAY","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 RpcInterface\r\n */\r\n\r\nimport { BentleyStatus } from \"@itwin/core-bentley\";\r\nimport { IModelRpcProps } from \"../../IModel\";\r\nimport { IModelError } from \"../../IModelError\";\r\nimport { RpcInterface, RpcInterfaceDefinition } from \"../../RpcInterface\";\r\nimport { RpcResponseCacheControl } from \"./RpcConstants\";\r\nimport { OPERATION, POLICY, RpcRegistry } from \"./RpcRegistry\";\r\nimport {\r\n  RpcRequestCallback_T, RpcRequestInitialRetryIntervalSupplier_T, RpcRequestTokenSupplier_T, RpcResponseCachingCallback_T,\r\n} from \"./RpcRequest\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/** The policy for an RPC operation.\r\n * @internal\r\n */\r\nexport class RpcOperationPolicy {\r\n  /** Supplies the IModelRpcProps for an operation request. */\r\n  public token: RpcRequestTokenSupplier_T = (request) => request.findTokenPropsParameter();\r\n\r\n  /** Supplies the initial retry interval for an operation request. */\r\n  public retryInterval: RpcRequestInitialRetryIntervalSupplier_T = (configuration) => configuration.pendingOperationRetryInterval;\r\n\r\n  /** Called before every operation request on the frontend is sent. */\r\n  public requestCallback: RpcRequestCallback_T = (_request) => { };\r\n\r\n  /** Called after every operation request on the frontend is sent. */\r\n  public sentCallback: RpcRequestCallback_T = (_request) => { };\r\n\r\n  /**\r\n   * Determines if caching is permitted for an operation response.\r\n   * @note Not all RPC protocols support caching.\r\n   */\r\n  public allowResponseCaching: RpcResponseCachingCallback_T = (_request) => RpcResponseCacheControl.None;\r\n\r\n  /** Forces RpcConfiguration.strictMode for this operation. */\r\n  public forceStrictMode: boolean = false;\r\n\r\n  /** Whether the IModelRpcProps in the operation parameter list is allowed to differ from the token in the request URL. */\r\n  public allowTokenMismatch: boolean = false;\r\n\r\n  /** Whether to compress the operation response with one of the client's supported encodings. */\r\n  public allowResponseCompression: boolean = false;\r\n}\r\n\r\n/** An RPC operation descriptor.\r\n * @internal\r\n */\r\nexport class RpcOperation {\r\n  /** A fallback token to use for RPC requests that do not semantically depend on an iModel. */\r\n  public static fallbackToken: IModelRpcProps | undefined = undefined;\r\n\r\n  /** Looks up an RPC operation by name. */\r\n  public static lookup(target: string | RpcInterfaceDefinition, operationName: string): RpcOperation {\r\n    const definition = typeof (target) === \"string\" ? RpcRegistry.instance.lookupInterfaceDefinition(target) : target;\r\n    const propertyName: string | symbol = RpcOperation.computeOperationName(operationName);\r\n\r\n    const proto = (definition.prototype as any);\r\n    if (!proto.hasOwnProperty(propertyName))\r\n      throw new IModelError(BentleyStatus.ERROR, `RPC interface class \"${definition.interfaceName}\" does not does not declare operation \"${operationName}\"`);\r\n\r\n    return proto[propertyName][OPERATION];\r\n  }\r\n\r\n  /** Iterates the operations of an RPC interface definition. */\r\n  public static forEach(definition: RpcInterfaceDefinition, callback: (operation: RpcOperation) => void): void {\r\n    Object.getOwnPropertyNames(definition.prototype).forEach((operationName) => {\r\n      if (operationName === \"constructor\" || operationName === \"configurationSupplier\")\r\n        return;\r\n\r\n      const propertyName = RpcOperation.computeOperationName(operationName);\r\n      callback((definition.prototype as any)[propertyName][OPERATION]);\r\n    });\r\n  }\r\n\r\n  /** The RPC interface definition for this operation. */\r\n  public readonly interfaceDefinition: RpcInterfaceDefinition;\r\n\r\n  /** The name of this operation. */\r\n  public readonly operationName: string;\r\n\r\n  /** The version of this operation. */\r\n  public get interfaceVersion(): string { return this.interfaceDefinition.interfaceVersion; }\r\n\r\n  /** The policy for this operation. */\r\n  public policy: RpcOperationPolicy;\r\n\r\n  /** @internal */\r\n  public constructor(definition: RpcInterfaceDefinition, operation: string, policy: RpcOperationPolicy) {\r\n    this.interfaceDefinition = definition;\r\n    this.operationName = operation;\r\n    this.policy = policy;\r\n  }\r\n\r\n  /** @internal */\r\n  public static computeOperationName(identifier: string): string {\r\n    const c = identifier.indexOf(\":\");\r\n    if (c === -1)\r\n      return identifier;\r\n\r\n    return identifier.substring(0, c + 1);\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport type RpcOperationPolicyProps = Partial<RpcOperationPolicy>;\r\n\r\n/** @internal */\r\nexport namespace RpcOperation { // eslint-disable-line no-redeclare\r\n  function obtainInstance(obj: RpcOperationPolicy | RpcOperationPolicyProps) {\r\n    if (obj instanceof RpcOperationPolicy) {\r\n      return obj;\r\n    } else {\r\n      const instance = new RpcOperationPolicy();\r\n      Object.assign(instance, obj);\r\n      return instance;\r\n    }\r\n  }\r\n\r\n  /** Decorator for setting the policy for an RPC operation function. */\r\n  export function setPolicy(policy: RpcOperationPolicy | RpcOperationPolicyProps) {\r\n    return <T extends RpcInterface>(target: T, propertyKey: string, descriptor: PropertyDescriptor) => {\r\n      descriptor.value[OPERATION] = new RpcOperation(target.constructor as any, propertyKey, obtainInstance(policy));\r\n    };\r\n  }\r\n\r\n  /** Convenience decorator for setting an RPC operation policy that allows response caching. */\r\n  export function allowResponseCaching(control: RpcResponseCacheControl = RpcResponseCacheControl.Immutable) {\r\n    return <T extends RpcInterface>(target: T, propertyKey: string, descriptor: PropertyDescriptor) => {\r\n      descriptor.value[OPERATION] = new RpcOperation(target.constructor as any, propertyKey, new class extends RpcOperationPolicy {\r\n        public override allowResponseCaching = () => control;\r\n      }());\r\n    };\r\n  }\r\n\r\n  /** Convenience decorator for setting an RPC operation policy that supplies the IModelRpcProps for an operation. */\r\n  export function setRoutingProps(handler: RpcRequestTokenSupplier_T) {\r\n    return <T extends RpcInterface>(target: T, propertyKey: string, descriptor: PropertyDescriptor) => {\r\n      descriptor.value[OPERATION] = new RpcOperation(target.constructor as any, propertyKey, new class extends RpcOperationPolicy {\r\n        public override token = handler;\r\n      }());\r\n    };\r\n  }\r\n\r\n  /** Decorator for setting the default policy for an RPC interface definition class. */\r\n  export function setDefaultPolicy(policy: RpcOperationPolicy | RpcOperationPolicyProps) {\r\n    return <T extends RpcInterface>(definition: RpcInterfaceDefinition<T>) => {\r\n      (definition as any)[POLICY] = obtainInstance(policy);\r\n    };\r\n  }\r\n}\r\n"]}

package/lib/cjs/rpc/core/RpcPendingQueue.d.ts

@@ -1,22 +1,22 @@
-/** @packageDocumentation
- * @module RpcInterface
- */
-/** Manages pending RPC requests and responses.
- * @internal
- */
-export declare class RpcPendingQueue {
-    static instance: RpcPendingQueue;
-    static initialize(): void;
-    private _pendingInterval;
-    private _pending;
-    private _pendingLock;
-    private constructor();
-    private requestEventHandler;
-    private enqueuePending;
-    private dequeuePending;
-    private _pendingIntervalHandler;
-    private cleanupPendingQueue;
-    private setPendingInterval;
-    private clearPendingInterval;
-}
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+/** Manages pending RPC requests and responses.
+ * @internal
+ */
+export declare class RpcPendingQueue {
+    static instance: RpcPendingQueue;
+    static initialize(): void;
+    private _pendingInterval;
+    private _pending;
+    private _pendingLock;
+    private constructor();
+    private requestEventHandler;
+    private enqueuePending;
+    private dequeuePending;
+    private _pendingIntervalHandler;
+    private cleanupPendingQueue;
+    private setPendingInterval;
+    private clearPendingInterval;
+}
 //# sourceMappingURL=RpcPendingQueue.d.ts.map

package/lib/cjs/rpc/core/RpcPendingQueue.js

@@ -1,95 +1,95 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module RpcInterface
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RpcPendingQueue = void 0;
-const RpcConstants_1 = require("./RpcConstants");
-const RpcRequest_1 = require("./RpcRequest");
-/* eslint-disable deprecation/deprecation */
-/** Manages pending RPC requests and responses.
- * @internal
- */
-class RpcPendingQueue {
-    constructor() {
-        this._pendingInterval = undefined;
-        this._pending = [];
-        this._pendingLock = 0;
-        this._pendingIntervalHandler = function () {
-            const now = new Date().getTime();
-            ++this._pendingLock;
-            for (const request of this._pending) {
-                const retry = request.retryAfter ?? request.retryInterval;
-                if (request.connecting || (request.lastSubmitted + retry) > now) {
-                    continue;
-                }
-                request.submit(); // eslint-disable-line @typescript-eslint/no-floating-promises
-            }
-            --this._pendingLock;
-            this.cleanupPendingQueue();
-        }.bind(this);
-        // eslint-disable-next-line @typescript-eslint/unbound-method
-        RpcRequest_1.RpcRequest.events.addListener(this.requestEventHandler, this);
-    }
-    static initialize() {
-        if (!RpcPendingQueue.instance) {
-            RpcPendingQueue.instance = new RpcPendingQueue();
-        }
-    }
-    requestEventHandler(type, request) {
-        if (type !== RpcConstants_1.RpcRequestEvent.StatusChanged)
-            return;
-        switch (request.status) {
-            case RpcConstants_1.RpcRequestStatus.Submitted: {
-                this.enqueuePending(request);
-                break;
-            }
-            case RpcConstants_1.RpcRequestStatus.Resolved:
-            case RpcConstants_1.RpcRequestStatus.Rejected:
-            case RpcConstants_1.RpcRequestStatus.NotFound:
-            case RpcConstants_1.RpcRequestStatus.Cancelled: {
-                this.dequeuePending(request);
-                break;
-            }
-        }
-    }
-    enqueuePending(request) {
-        this._pending.push(request);
-        this.setPendingInterval();
-    }
-    dequeuePending(request) {
-        if (this._pendingLock)
-            return;
-        const i = this._pending.indexOf(request);
-        this._pending.splice(i, 1);
-        this.clearPendingInterval();
-    }
-    cleanupPendingQueue() {
-        if (this._pendingLock)
-            return;
-        let i = this._pending.length;
-        while (i--) {
-            if (!this._pending[i].pending && !RpcConstants_1.RpcRequestStatus.isTransientError(this._pending[i].status)) {
-                this._pending.splice(i, 1);
-            }
-        }
-        this.clearPendingInterval();
-    }
-    setPendingInterval() {
-        if (this._pendingInterval)
-            return;
-        this._pendingInterval = setInterval(this._pendingIntervalHandler, 0);
-    }
-    clearPendingInterval() {
-        if (!this._pending.length) {
-            clearInterval(this._pendingInterval);
-            this._pendingInterval = undefined;
-        }
-    }
-}
-exports.RpcPendingQueue = RpcPendingQueue;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RpcPendingQueue = void 0;
+const RpcConstants_1 = require("./RpcConstants");
+const RpcRequest_1 = require("./RpcRequest");
+/* eslint-disable deprecation/deprecation */
+/** Manages pending RPC requests and responses.
+ * @internal
+ */
+class RpcPendingQueue {
+    static initialize() {
+        if (!RpcPendingQueue.instance) {
+            RpcPendingQueue.instance = new RpcPendingQueue();
+        }
+    }
+    constructor() {
+        this._pendingInterval = undefined;
+        this._pending = [];
+        this._pendingLock = 0;
+        this._pendingIntervalHandler = function () {
+            const now = new Date().getTime();
+            ++this._pendingLock;
+            for (const request of this._pending) {
+                const retry = request.retryAfter ?? request.retryInterval;
+                if (request.connecting || (request.lastSubmitted + retry) > now) {
+                    continue;
+                }
+                request.submit(); // eslint-disable-line @typescript-eslint/no-floating-promises
+            }
+            --this._pendingLock;
+            this.cleanupPendingQueue();
+        }.bind(this);
+        // eslint-disable-next-line @typescript-eslint/unbound-method
+        RpcRequest_1.RpcRequest.events.addListener(this.requestEventHandler, this);
+    }
+    requestEventHandler(type, request) {
+        if (type !== RpcConstants_1.RpcRequestEvent.StatusChanged)
+            return;
+        switch (request.status) {
+            case RpcConstants_1.RpcRequestStatus.Submitted: {
+                this.enqueuePending(request);
+                break;
+            }
+            case RpcConstants_1.RpcRequestStatus.Resolved:
+            case RpcConstants_1.RpcRequestStatus.Rejected:
+            case RpcConstants_1.RpcRequestStatus.NotFound:
+            case RpcConstants_1.RpcRequestStatus.Cancelled: {
+                this.dequeuePending(request);
+                break;
+            }
+        }
+    }
+    enqueuePending(request) {
+        this._pending.push(request);
+        this.setPendingInterval();
+    }
+    dequeuePending(request) {
+        if (this._pendingLock)
+            return;
+        const i = this._pending.indexOf(request);
+        this._pending.splice(i, 1);
+        this.clearPendingInterval();
+    }
+    cleanupPendingQueue() {
+        if (this._pendingLock)
+            return;
+        let i = this._pending.length;
+        while (i--) {
+            if (!this._pending[i].pending && !RpcConstants_1.RpcRequestStatus.isTransientError(this._pending[i].status)) {
+                this._pending.splice(i, 1);
+            }
+        }
+        this.clearPendingInterval();
+    }
+    setPendingInterval() {
+        if (this._pendingInterval)
+            return;
+        this._pendingInterval = setInterval(this._pendingIntervalHandler, 0);
+    }
+    clearPendingInterval() {
+        if (!this._pending.length) {
+            clearInterval(this._pendingInterval);
+            this._pendingInterval = undefined;
+        }
+    }
+}
+exports.RpcPendingQueue = RpcPendingQueue;
 //# sourceMappingURL=RpcPendingQueue.js.map

package/lib/cjs/rpc/core/RpcPendingQueue.js.map

@@ -1 +1 @@
-{"version":3,"file":"RpcPendingQueue.js","sourceRoot":"","sources":["../../../../src/rpc/core/RpcPendingQueue.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,iDAAmE;AACnE,6CAA0C;AAE1C,4CAA4C;AAE5C;;GAEG;AACH,MAAa,eAAe;IAa1B;QAJQ,qBAAgB,GAAQ,SAAS,CAAC;QAClC,aAAQ,GAAiB,EAAE,CAAC;QAC5B,iBAAY,GAAW,CAAC,CAAC;QAyCzB,4BAAuB,GAAG;YAChC,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;YAEjC,EAAE,IAAI,CAAC,YAAY,CAAC;YAEpB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE;gBACnC,MAAM,KAAK,GAAG,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,aAAa,CAAC;gBAC1D,IAAI,OAAO,CAAC,UAAU,IAAI,CAAC,OAAO,CAAC,aAAa,GAAG,KAAK,CAAC,GAAG,GAAG,EAAE;oBAC/D,SAAS;iBACV;gBAED,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,8DAA8D;aACjF;YAED,EAAE,IAAI,CAAC,YAAY,CAAC;YAEpB,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC7B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAvDX,6DAA6D;QAC7D,uBAAU,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;IAChE,CAAC;IAbM,MAAM,CAAC,UAAU;QACtB,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE;YAC7B,eAAe,CAAC,QAAQ,GAAG,IAAI,eAAe,EAAE,CAAC;SAClD;IACH,CAAC;IAWO,mBAAmB,CAAC,IAAqB,EAAE,OAAmB;QACpE,IAAI,IAAI,KAAK,8BAAe,CAAC,aAAa;YACxC,OAAO;QAET,QAAQ,OAAO,CAAC,MAAM,EAAE;YACtB,KAAK,+BAAgB,CAAC,SAAS,CAAC,CAAC;gBAC/B,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;gBAC7B,MAAM;aACP;YAED,KAAK,+BAAgB,CAAC,QAAQ,CAAC;YAC/B,KAAK,+BAAgB,CAAC,QAAQ,CAAC;YAC/B,KAAK,+BAAgB,CAAC,QAAQ,CAAC;YAC/B,KAAK,+BAAgB,CAAC,SAAS,CAAC,CAAC;gBAC/B,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;gBAC7B,MAAM;aACP;SACF;IACH,CAAC;IAEO,cAAc,CAAC,OAAmB;QACxC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5B,IAAI,CAAC,kBAAkB,EAAE,CAAC;IAC5B,CAAC;IAEO,cAAc,CAAC,OAAmB;QACxC,IAAI,IAAI,CAAC,YAAY;YACnB,OAAO;QAET,MAAM,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACzC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC3B,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC9B,CAAC;IAqBO,mBAAmB;QACzB,IAAI,IAAI,CAAC,YAAY;YACnB,OAAO;QAET,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC7B,OAAO,CAAC,EAAE,EAAE;YACV,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,+BAAgB,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE;gBAC5F,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;aAC5B;SACF;QAED,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC9B,CAAC;IAEO,kBAAkB;QACxB,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO;QAET,IAAI,CAAC,gBAAgB,GAAG,WAAW,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAAC;IACvE,CAAC;IAEO,oBAAoB;QAC1B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YACzB,aAAa,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;YACrC,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC;SACnC;IACH,CAAC;CACF;AAlGD,0CAkGC","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 RpcInterface\r\n */\r\n\r\nimport { RpcRequestEvent, RpcRequestStatus } from \"./RpcConstants\";\r\nimport { RpcRequest } from \"./RpcRequest\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/** Manages pending RPC requests and responses.\r\n * @internal\r\n */\r\nexport class RpcPendingQueue {\r\n  public static instance: RpcPendingQueue;\r\n\r\n  public static initialize() {\r\n    if (!RpcPendingQueue.instance) {\r\n      RpcPendingQueue.instance = new RpcPendingQueue();\r\n    }\r\n  }\r\n\r\n  private _pendingInterval: any = undefined;\r\n  private _pending: RpcRequest[] = [];\r\n  private _pendingLock: number = 0;\r\n\r\n  private constructor() {\r\n    // eslint-disable-next-line @typescript-eslint/unbound-method\r\n    RpcRequest.events.addListener(this.requestEventHandler, this);\r\n  }\r\n\r\n  private requestEventHandler(type: RpcRequestEvent, request: RpcRequest): void {\r\n    if (type !== RpcRequestEvent.StatusChanged)\r\n      return;\r\n\r\n    switch (request.status) {\r\n      case RpcRequestStatus.Submitted: {\r\n        this.enqueuePending(request);\r\n        break;\r\n      }\r\n\r\n      case RpcRequestStatus.Resolved:\r\n      case RpcRequestStatus.Rejected:\r\n      case RpcRequestStatus.NotFound:\r\n      case RpcRequestStatus.Cancelled: {\r\n        this.dequeuePending(request);\r\n        break;\r\n      }\r\n    }\r\n  }\r\n\r\n  private enqueuePending(request: RpcRequest) {\r\n    this._pending.push(request);\r\n    this.setPendingInterval();\r\n  }\r\n\r\n  private dequeuePending(request: RpcRequest) {\r\n    if (this._pendingLock)\r\n      return;\r\n\r\n    const i = this._pending.indexOf(request);\r\n    this._pending.splice(i, 1);\r\n    this.clearPendingInterval();\r\n  }\r\n\r\n  private _pendingIntervalHandler = function (this: RpcPendingQueue) {\r\n    const now = new Date().getTime();\r\n\r\n    ++this._pendingLock;\r\n\r\n    for (const request of this._pending) {\r\n      const retry = request.retryAfter ?? request.retryInterval;\r\n      if (request.connecting || (request.lastSubmitted + retry) > now) {\r\n        continue;\r\n      }\r\n\r\n      request.submit(); // eslint-disable-line @typescript-eslint/no-floating-promises\r\n    }\r\n\r\n    --this._pendingLock;\r\n\r\n    this.cleanupPendingQueue();\r\n  }.bind(this);\r\n\r\n  private cleanupPendingQueue() {\r\n    if (this._pendingLock)\r\n      return;\r\n\r\n    let i = this._pending.length;\r\n    while (i--) {\r\n      if (!this._pending[i].pending && !RpcRequestStatus.isTransientError(this._pending[i].status)) {\r\n        this._pending.splice(i, 1);\r\n      }\r\n    }\r\n\r\n    this.clearPendingInterval();\r\n  }\r\n\r\n  private setPendingInterval() {\r\n    if (this._pendingInterval)\r\n      return;\r\n\r\n    this._pendingInterval = setInterval(this._pendingIntervalHandler, 0);\r\n  }\r\n\r\n  private clearPendingInterval() {\r\n    if (!this._pending.length) {\r\n      clearInterval(this._pendingInterval);\r\n      this._pendingInterval = undefined;\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"RpcPendingQueue.js","sourceRoot":"","sources":["../../../../src/rpc/core/RpcPendingQueue.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,iDAAmE;AACnE,6CAA0C;AAE1C,4CAA4C;AAE5C;;GAEG;AACH,MAAa,eAAe;IAGnB,MAAM,CAAC,UAAU;QACtB,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE;YAC7B,eAAe,CAAC,QAAQ,GAAG,IAAI,eAAe,EAAE,CAAC;SAClD;IACH,CAAC;IAMD;QAJQ,qBAAgB,GAAQ,SAAS,CAAC;QAClC,aAAQ,GAAiB,EAAE,CAAC;QAC5B,iBAAY,GAAW,CAAC,CAAC;QAyCzB,4BAAuB,GAAG;YAChC,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;YAEjC,EAAE,IAAI,CAAC,YAAY,CAAC;YAEpB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE;gBACnC,MAAM,KAAK,GAAG,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,aAAa,CAAC;gBAC1D,IAAI,OAAO,CAAC,UAAU,IAAI,CAAC,OAAO,CAAC,aAAa,GAAG,KAAK,CAAC,GAAG,GAAG,EAAE;oBAC/D,SAAS;iBACV;gBAED,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,8DAA8D;aACjF;YAED,EAAE,IAAI,CAAC,YAAY,CAAC;YAEpB,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC7B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAvDX,6DAA6D;QAC7D,uBAAU,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;IAChE,CAAC;IAEO,mBAAmB,CAAC,IAAqB,EAAE,OAAmB;QACpE,IAAI,IAAI,KAAK,8BAAe,CAAC,aAAa;YACxC,OAAO;QAET,QAAQ,OAAO,CAAC,MAAM,EAAE;YACtB,KAAK,+BAAgB,CAAC,SAAS,CAAC,CAAC;gBAC/B,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;gBAC7B,MAAM;aACP;YAED,KAAK,+BAAgB,CAAC,QAAQ,CAAC;YAC/B,KAAK,+BAAgB,CAAC,QAAQ,CAAC;YAC/B,KAAK,+BAAgB,CAAC,QAAQ,CAAC;YAC/B,KAAK,+BAAgB,CAAC,SAAS,CAAC,CAAC;gBAC/B,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;gBAC7B,MAAM;aACP;SACF;IACH,CAAC;IAEO,cAAc,CAAC,OAAmB;QACxC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5B,IAAI,CAAC,kBAAkB,EAAE,CAAC;IAC5B,CAAC;IAEO,cAAc,CAAC,OAAmB;QACxC,IAAI,IAAI,CAAC,YAAY;YACnB,OAAO;QAET,MAAM,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACzC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC3B,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC9B,CAAC;IAqBO,mBAAmB;QACzB,IAAI,IAAI,CAAC,YAAY;YACnB,OAAO;QAET,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC7B,OAAO,CAAC,EAAE,EAAE;YACV,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,+BAAgB,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE;gBAC5F,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;aAC5B;SACF;QAED,IAAI,CAAC,oBAAoB,EAAE,CAAC;IAC9B,CAAC;IAEO,kBAAkB;QACxB,IAAI,IAAI,CAAC,gBAAgB;YACvB,OAAO;QAET,IAAI,CAAC,gBAAgB,GAAG,WAAW,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC,CAAC,CAAC;IACvE,CAAC;IAEO,oBAAoB;QAC1B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YACzB,aAAa,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;YACrC,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC;SACnC;IACH,CAAC;CACF;AAlGD,0CAkGC","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 RpcInterface\r\n */\r\n\r\nimport { RpcRequestEvent, RpcRequestStatus } from \"./RpcConstants\";\r\nimport { RpcRequest } from \"./RpcRequest\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/** Manages pending RPC requests and responses.\r\n * @internal\r\n */\r\nexport class RpcPendingQueue {\r\n  public static instance: RpcPendingQueue;\r\n\r\n  public static initialize() {\r\n    if (!RpcPendingQueue.instance) {\r\n      RpcPendingQueue.instance = new RpcPendingQueue();\r\n    }\r\n  }\r\n\r\n  private _pendingInterval: any = undefined;\r\n  private _pending: RpcRequest[] = [];\r\n  private _pendingLock: number = 0;\r\n\r\n  private constructor() {\r\n    // eslint-disable-next-line @typescript-eslint/unbound-method\r\n    RpcRequest.events.addListener(this.requestEventHandler, this);\r\n  }\r\n\r\n  private requestEventHandler(type: RpcRequestEvent, request: RpcRequest): void {\r\n    if (type !== RpcRequestEvent.StatusChanged)\r\n      return;\r\n\r\n    switch (request.status) {\r\n      case RpcRequestStatus.Submitted: {\r\n        this.enqueuePending(request);\r\n        break;\r\n      }\r\n\r\n      case RpcRequestStatus.Resolved:\r\n      case RpcRequestStatus.Rejected:\r\n      case RpcRequestStatus.NotFound:\r\n      case RpcRequestStatus.Cancelled: {\r\n        this.dequeuePending(request);\r\n        break;\r\n      }\r\n    }\r\n  }\r\n\r\n  private enqueuePending(request: RpcRequest) {\r\n    this._pending.push(request);\r\n    this.setPendingInterval();\r\n  }\r\n\r\n  private dequeuePending(request: RpcRequest) {\r\n    if (this._pendingLock)\r\n      return;\r\n\r\n    const i = this._pending.indexOf(request);\r\n    this._pending.splice(i, 1);\r\n    this.clearPendingInterval();\r\n  }\r\n\r\n  private _pendingIntervalHandler = function (this: RpcPendingQueue) {\r\n    const now = new Date().getTime();\r\n\r\n    ++this._pendingLock;\r\n\r\n    for (const request of this._pending) {\r\n      const retry = request.retryAfter ?? request.retryInterval;\r\n      if (request.connecting || (request.lastSubmitted + retry) > now) {\r\n        continue;\r\n      }\r\n\r\n      request.submit(); // eslint-disable-line @typescript-eslint/no-floating-promises\r\n    }\r\n\r\n    --this._pendingLock;\r\n\r\n    this.cleanupPendingQueue();\r\n  }.bind(this);\r\n\r\n  private cleanupPendingQueue() {\r\n    if (this._pendingLock)\r\n      return;\r\n\r\n    let i = this._pending.length;\r\n    while (i--) {\r\n      if (!this._pending[i].pending && !RpcRequestStatus.isTransientError(this._pending[i].status)) {\r\n        this._pending.splice(i, 1);\r\n      }\r\n    }\r\n\r\n    this.clearPendingInterval();\r\n  }\r\n\r\n  private setPendingInterval() {\r\n    if (this._pendingInterval)\r\n      return;\r\n\r\n    this._pendingInterval = setInterval(this._pendingIntervalHandler, 0);\r\n  }\r\n\r\n  private clearPendingInterval() {\r\n    if (!this._pending.length) {\r\n      clearInterval(this._pendingInterval);\r\n      this._pendingInterval = undefined;\r\n    }\r\n  }\r\n}\r\n"]}