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

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

@@ -1,68 +1,68 @@
-/** @packageDocumentation
- * @module RpcInterface
- */
-import { IModelRpcProps } from "../../IModel";
-import { RpcInterface, RpcInterfaceDefinition } from "../../RpcInterface";
-import { RpcResponseCacheControl } from "./RpcConstants";
-import { RpcRequestCallback_T, RpcRequestInitialRetryIntervalSupplier_T, RpcRequestTokenSupplier_T, RpcResponseCachingCallback_T } from "./RpcRequest";
-/** The policy for an RPC operation.
- * @internal
- */
-export declare class RpcOperationPolicy {
-    /** Supplies the IModelRpcProps for an operation request. */
-    token: RpcRequestTokenSupplier_T;
-    /** Supplies the initial retry interval for an operation request. */
-    retryInterval: RpcRequestInitialRetryIntervalSupplier_T;
-    /** Called before every operation request on the frontend is sent. */
-    requestCallback: RpcRequestCallback_T;
-    /** Called after every operation request on the frontend is sent. */
-    sentCallback: RpcRequestCallback_T;
-    /**
-     * Determines if caching is permitted for an operation response.
-     * @note Not all RPC protocols support caching.
-     */
-    allowResponseCaching: RpcResponseCachingCallback_T;
-    /** Forces RpcConfiguration.strictMode for this operation. */
-    forceStrictMode: boolean;
-    /** Whether the IModelRpcProps in the operation parameter list is allowed to differ from the token in the request URL. */
-    allowTokenMismatch: boolean;
-    /** Whether to compress the operation response with one of the client's supported encodings. */
-    allowResponseCompression: boolean;
-}
-/** An RPC operation descriptor.
- * @internal
- */
-export declare class RpcOperation {
-    /** A fallback token to use for RPC requests that do not semantically depend on an iModel. */
-    static fallbackToken: IModelRpcProps | undefined;
-    /** Looks up an RPC operation by name. */
-    static lookup(target: string | RpcInterfaceDefinition, operationName: string): RpcOperation;
-    /** Iterates the operations of an RPC interface definition. */
-    static forEach(definition: RpcInterfaceDefinition, callback: (operation: RpcOperation) => void): void;
-    /** The RPC interface definition for this operation. */
-    readonly interfaceDefinition: RpcInterfaceDefinition;
-    /** The name of this operation. */
-    readonly operationName: string;
-    /** The version of this operation. */
-    get interfaceVersion(): string;
-    /** The policy for this operation. */
-    policy: RpcOperationPolicy;
-    /** @internal */
-    constructor(definition: RpcInterfaceDefinition, operation: string, policy: RpcOperationPolicy);
-    /** @internal */
-    static computeOperationName(identifier: string): string;
-}
-/** @internal */
-export declare type RpcOperationPolicyProps = Partial<RpcOperationPolicy>;
-/** @internal */
-export declare namespace RpcOperation {
-    /** Decorator for setting the policy for an RPC operation function. */
-    function setPolicy(policy: RpcOperationPolicy | RpcOperationPolicyProps): <T extends RpcInterface>(target: T, propertyKey: string, descriptor: PropertyDescriptor) => void;
-    /** Convenience decorator for setting an RPC operation policy that allows response caching. */
-    function allowResponseCaching(control?: RpcResponseCacheControl): <T extends RpcInterface>(target: T, propertyKey: string, descriptor: PropertyDescriptor) => void;
-    /** Convenience decorator for setting an RPC operation policy that supplies the IModelRpcProps for an operation. */
-    function setRoutingProps(handler: RpcRequestTokenSupplier_T): <T extends RpcInterface>(target: T, propertyKey: string, descriptor: PropertyDescriptor) => void;
-    /** Decorator for setting the default policy for an RPC interface definition class. */
-    function setDefaultPolicy(policy: RpcOperationPolicy | RpcOperationPolicyProps): <T extends RpcInterface>(definition: RpcInterfaceDefinition<T>) => void;
-}
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import { IModelRpcProps } from "../../IModel";
+import { RpcInterface, RpcInterfaceDefinition } from "../../RpcInterface";
+import { RpcResponseCacheControl } from "./RpcConstants";
+import { RpcRequestCallback_T, RpcRequestInitialRetryIntervalSupplier_T, RpcRequestTokenSupplier_T, RpcResponseCachingCallback_T } from "./RpcRequest";
+/** The policy for an RPC operation.
+ * @internal
+ */
+export declare class RpcOperationPolicy {
+    /** Supplies the IModelRpcProps for an operation request. */
+    token: RpcRequestTokenSupplier_T;
+    /** Supplies the initial retry interval for an operation request. */
+    retryInterval: RpcRequestInitialRetryIntervalSupplier_T;
+    /** Called before every operation request on the frontend is sent. */
+    requestCallback: RpcRequestCallback_T;
+    /** Called after every operation request on the frontend is sent. */
+    sentCallback: RpcRequestCallback_T;
+    /**
+     * Determines if caching is permitted for an operation response.
+     * @note Not all RPC protocols support caching.
+     */
+    allowResponseCaching: RpcResponseCachingCallback_T;
+    /** Forces RpcConfiguration.strictMode for this operation. */
+    forceStrictMode: boolean;
+    /** Whether the IModelRpcProps in the operation parameter list is allowed to differ from the token in the request URL. */
+    allowTokenMismatch: boolean;
+    /** Whether to compress the operation response with one of the client's supported encodings. */
+    allowResponseCompression: boolean;
+}
+/** An RPC operation descriptor.
+ * @internal
+ */
+export declare class RpcOperation {
+    /** A fallback token to use for RPC requests that do not semantically depend on an iModel. */
+    static fallbackToken: IModelRpcProps | undefined;
+    /** Looks up an RPC operation by name. */
+    static lookup(target: string | RpcInterfaceDefinition, operationName: string): RpcOperation;
+    /** Iterates the operations of an RPC interface definition. */
+    static forEach(definition: RpcInterfaceDefinition, callback: (operation: RpcOperation) => void): void;
+    /** The RPC interface definition for this operation. */
+    readonly interfaceDefinition: RpcInterfaceDefinition;
+    /** The name of this operation. */
+    readonly operationName: string;
+    /** The version of this operation. */
+    get interfaceVersion(): string;
+    /** The policy for this operation. */
+    policy: RpcOperationPolicy;
+    /** @internal */
+    constructor(definition: RpcInterfaceDefinition, operation: string, policy: RpcOperationPolicy);
+    /** @internal */
+    static computeOperationName(identifier: string): string;
+}
+/** @internal */
+export type RpcOperationPolicyProps = Partial<RpcOperationPolicy>;
+/** @internal */
+export declare namespace RpcOperation {
+    /** Decorator for setting the policy for an RPC operation function. */
+    function setPolicy(policy: RpcOperationPolicy | RpcOperationPolicyProps): <T extends RpcInterface>(target: T, propertyKey: string, descriptor: PropertyDescriptor) => void;
+    /** Convenience decorator for setting an RPC operation policy that allows response caching. */
+    function allowResponseCaching(control?: RpcResponseCacheControl): <T extends RpcInterface>(target: T, propertyKey: string, descriptor: PropertyDescriptor) => void;
+    /** Convenience decorator for setting an RPC operation policy that supplies the IModelRpcProps for an operation. */
+    function setRoutingProps(handler: RpcRequestTokenSupplier_T): <T extends RpcInterface>(target: T, propertyKey: string, descriptor: PropertyDescriptor) => void;
+    /** Decorator for setting the default policy for an RPC interface definition class. */
+    function setDefaultPolicy(policy: RpcOperationPolicy | RpcOperationPolicyProps): <T extends RpcInterface>(definition: RpcInterfaceDefinition<T>) => void;
+}
 //# sourceMappingURL=RpcOperation.d.ts.map

package/lib/cjs/rpc/core/RpcOperation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RpcOperation.d.ts","sourceRoot":"","sources":["../../../../src/rpc/core/RpcOperation.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,YAAY,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AAEzD,OAAO,EACL,oBAAoB,EAAE,wCAAwC,EAAE,yBAAyB,EAAE,4BAA4B,EACxH,MAAM,cAAc,CAAC;AAItB;;GAEG;AACH,qBAAa,kBAAkB;IAC7B,4DAA4D;IACrD,KAAK,EAAE,yBAAyB,CAAkD;IAEzF,oEAAoE;IAC7D,aAAa,EAAE,wCAAwC,CAAkE;IAEhI,qEAAqE;IAC9D,eAAe,EAAE,oBAAoB,CAAqB;IAEjE,oEAAoE;IAC7D,YAAY,EAAE,oBAAoB,CAAqB;IAE9D;;;OAGG;IACI,oBAAoB,EAAE,4BAA4B,CAA8C;IAEvG,6DAA6D;IACtD,eAAe,EAAE,OAAO,CAAS;IAExC,yHAAyH;IAClH,kBAAkB,EAAE,OAAO,CAAS;IAE3C,+FAA+F;IACxF,wBAAwB,EAAE,OAAO,CAAS;CAClD;AAED;;GAEG;AACH,qBAAa,YAAY;IACvB,6FAA6F;IAC7F,OAAc,aAAa,EAAE,cAAc,GAAG,SAAS,CAAa;IAEpE,yCAAyC;WAC3B,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,sBAAsB,EAAE,aAAa,EAAE,MAAM,GAAG,YAAY;IAWlG,8DAA8D;WAChD,OAAO,CAAC,UAAU,EAAE,sBAAsB,EAAE,QAAQ,EAAE,CAAC,SAAS,EAAE,YAAY,KAAK,IAAI,GAAG,IAAI;IAU5G,uDAAuD;IACvD,SAAgB,mBAAmB,EAAE,sBAAsB,CAAC;IAE5D,kCAAkC;IAClC,SAAgB,aAAa,EAAE,MAAM,CAAC;IAEtC,qCAAqC;IACrC,IAAW,gBAAgB,IAAI,MAAM,CAAsD;IAE3F,qCAAqC;IAC9B,MAAM,EAAE,kBAAkB,CAAC;IAElC,gBAAgB;gBACG,UAAU,EAAE,sBAAsB,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB;IAMpG,gBAAgB;WACF,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;CAO/D;AAED,gBAAgB;AAChB,oBAAY,uBAAuB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAElE,gBAAgB;AAChB,yBAAiB,YAAY,CAAC;IAW5B,sEAAsE;IACtE,SAAgB,SAAS,CAAC,MAAM,EAAE,kBAAkB,GAAG,uBAAuB,oDACpB,MAAM,cAAc,kBAAkB,UAG/F;IAED,8FAA8F;IAC9F,SAAgB,oBAAoB,CAAC,OAAO,GAAE,uBAA2D,oDAC/C,MAAM,cAAc,kBAAkB,UAK/F;IAED,mHAAmH;IACnH,SAAgB,eAAe,CAAC,OAAO,EAAE,yBAAyB,oDACR,MAAM,cAAc,kBAAkB,UAK/F;IAED,sFAAsF;IACtF,SAAgB,gBAAgB,CAAC,MAAM,EAAE,kBAAkB,GAAG,uBAAuB,2EAIpF;CACF"}
+{"version":3,"file":"RpcOperation.d.ts","sourceRoot":"","sources":["../../../../src/rpc/core/RpcOperation.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,YAAY,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AAEzD,OAAO,EACL,oBAAoB,EAAE,wCAAwC,EAAE,yBAAyB,EAAE,4BAA4B,EACxH,MAAM,cAAc,CAAC;AAItB;;GAEG;AACH,qBAAa,kBAAkB;IAC7B,4DAA4D;IACrD,KAAK,EAAE,yBAAyB,CAAkD;IAEzF,oEAAoE;IAC7D,aAAa,EAAE,wCAAwC,CAAkE;IAEhI,qEAAqE;IAC9D,eAAe,EAAE,oBAAoB,CAAqB;IAEjE,oEAAoE;IAC7D,YAAY,EAAE,oBAAoB,CAAqB;IAE9D;;;OAGG;IACI,oBAAoB,EAAE,4BAA4B,CAA8C;IAEvG,6DAA6D;IACtD,eAAe,EAAE,OAAO,CAAS;IAExC,yHAAyH;IAClH,kBAAkB,EAAE,OAAO,CAAS;IAE3C,+FAA+F;IACxF,wBAAwB,EAAE,OAAO,CAAS;CAClD;AAED;;GAEG;AACH,qBAAa,YAAY;IACvB,6FAA6F;IAC7F,OAAc,aAAa,EAAE,cAAc,GAAG,SAAS,CAAa;IAEpE,yCAAyC;WAC3B,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,sBAAsB,EAAE,aAAa,EAAE,MAAM,GAAG,YAAY;IAWlG,8DAA8D;WAChD,OAAO,CAAC,UAAU,EAAE,sBAAsB,EAAE,QAAQ,EAAE,CAAC,SAAS,EAAE,YAAY,KAAK,IAAI,GAAG,IAAI;IAU5G,uDAAuD;IACvD,SAAgB,mBAAmB,EAAE,sBAAsB,CAAC;IAE5D,kCAAkC;IAClC,SAAgB,aAAa,EAAE,MAAM,CAAC;IAEtC,qCAAqC;IACrC,IAAW,gBAAgB,IAAI,MAAM,CAAsD;IAE3F,qCAAqC;IAC9B,MAAM,EAAE,kBAAkB,CAAC;IAElC,gBAAgB;gBACG,UAAU,EAAE,sBAAsB,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB;IAMpG,gBAAgB;WACF,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;CAO/D;AAED,gBAAgB;AAChB,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAElE,gBAAgB;AAChB,yBAAiB,YAAY,CAAC;IAW5B,sEAAsE;IACtE,SAAgB,SAAS,CAAC,MAAM,EAAE,kBAAkB,GAAG,uBAAuB,oDACpB,MAAM,cAAc,kBAAkB,UAG/F;IAED,8FAA8F;IAC9F,SAAgB,oBAAoB,CAAC,OAAO,GAAE,uBAA2D,oDAC/C,MAAM,cAAc,kBAAkB,UAK/F;IAED,mHAAmH;IACnH,SAAgB,eAAe,CAAC,OAAO,EAAE,yBAAyB,oDACR,MAAM,cAAc,kBAAkB,UAK/F;IAED,sFAAsF;IACtF,SAAgB,gBAAgB,CAAC,MAAM,EAAE,kBAAkB,GAAG,uBAAuB,2EAIpF;CACF"}

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":["/*---------------------------------------------------------------------------------------------\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 RpcInterface\n */\n\nimport { BentleyStatus } from \"@itwin/core-bentley\";\nimport { IModelRpcProps } from \"../../IModel\";\nimport { IModelError } from \"../../IModelError\";\nimport { RpcInterface, RpcInterfaceDefinition } from \"../../RpcInterface\";\nimport { RpcResponseCacheControl } from \"./RpcConstants\";\nimport { OPERATION, POLICY, RpcRegistry } from \"./RpcRegistry\";\nimport {\n  RpcRequestCallback_T, RpcRequestInitialRetryIntervalSupplier_T, RpcRequestTokenSupplier_T, RpcResponseCachingCallback_T,\n} from \"./RpcRequest\";\n\n/* eslint-disable deprecation/deprecation */\n\n/** The policy for an RPC operation.\n * @internal\n */\nexport class RpcOperationPolicy {\n  /** Supplies the IModelRpcProps for an operation request. */\n  public token: RpcRequestTokenSupplier_T = (request) => request.findTokenPropsParameter();\n\n  /** Supplies the initial retry interval for an operation request. */\n  public retryInterval: RpcRequestInitialRetryIntervalSupplier_T = (configuration) => configuration.pendingOperationRetryInterval;\n\n  /** Called before every operation request on the frontend is sent. */\n  public requestCallback: RpcRequestCallback_T = (_request) => { };\n\n  /** Called after every operation request on the frontend is sent. */\n  public sentCallback: RpcRequestCallback_T = (_request) => { };\n\n  /**\n   * Determines if caching is permitted for an operation response.\n   * @note Not all RPC protocols support caching.\n   */\n  public allowResponseCaching: RpcResponseCachingCallback_T = (_request) => RpcResponseCacheControl.None;\n\n  /** Forces RpcConfiguration.strictMode for this operation. */\n  public forceStrictMode: boolean = false;\n\n  /** Whether the IModelRpcProps in the operation parameter list is allowed to differ from the token in the request URL. */\n  public allowTokenMismatch: boolean = false;\n\n  /** Whether to compress the operation response with one of the client's supported encodings. */\n  public allowResponseCompression: boolean = false;\n}\n\n/** An RPC operation descriptor.\n * @internal\n */\nexport class RpcOperation {\n  /** A fallback token to use for RPC requests that do not semantically depend on an iModel. */\n  public static fallbackToken: IModelRpcProps | undefined = undefined;\n\n  /** Looks up an RPC operation by name. */\n  public static lookup(target: string | RpcInterfaceDefinition, operationName: string): RpcOperation {\n    const definition = typeof (target) === \"string\" ? RpcRegistry.instance.lookupInterfaceDefinition(target) : target;\n    const propertyName: string | symbol = RpcOperation.computeOperationName(operationName);\n\n    const proto = (definition.prototype as any);\n    if (!proto.hasOwnProperty(propertyName))\n      throw new IModelError(BentleyStatus.ERROR, `RPC interface class \"${definition.interfaceName}\" does not does not declare operation \"${operationName}\"`);\n\n    return proto[propertyName][OPERATION];\n  }\n\n  /** Iterates the operations of an RPC interface definition. */\n  public static forEach(definition: RpcInterfaceDefinition, callback: (operation: RpcOperation) => void): void {\n    Object.getOwnPropertyNames(definition.prototype).forEach((operationName) => {\n      if (operationName === \"constructor\" || operationName === \"configurationSupplier\")\n        return;\n\n      const propertyName = RpcOperation.computeOperationName(operationName);\n      callback((definition.prototype as any)[propertyName][OPERATION]);\n    });\n  }\n\n  /** The RPC interface definition for this operation. */\n  public readonly interfaceDefinition: RpcInterfaceDefinition;\n\n  /** The name of this operation. */\n  public readonly operationName: string;\n\n  /** The version of this operation. */\n  public get interfaceVersion(): string { return this.interfaceDefinition.interfaceVersion; }\n\n  /** The policy for this operation. */\n  public policy: RpcOperationPolicy;\n\n  /** @internal */\n  public constructor(definition: RpcInterfaceDefinition, operation: string, policy: RpcOperationPolicy) {\n    this.interfaceDefinition = definition;\n    this.operationName = operation;\n    this.policy = policy;\n  }\n\n  /** @internal */\n  public static computeOperationName(identifier: string): string {\n    const c = identifier.indexOf(\":\");\n    if (c === -1)\n      return identifier;\n\n    return identifier.substring(0, c + 1);\n  }\n}\n\n/** @internal */\nexport type RpcOperationPolicyProps = Partial<RpcOperationPolicy>;\n\n/** @internal */\nexport namespace RpcOperation { // eslint-disable-line no-redeclare\n  function obtainInstance(obj: RpcOperationPolicy | RpcOperationPolicyProps) {\n    if (obj instanceof RpcOperationPolicy) {\n      return obj;\n    } else {\n      const instance = new RpcOperationPolicy();\n      Object.assign(instance, obj);\n      return instance;\n    }\n  }\n\n  /** Decorator for setting the policy for an RPC operation function. */\n  export function setPolicy(policy: RpcOperationPolicy | RpcOperationPolicyProps) {\n    return <T extends RpcInterface>(target: T, propertyKey: string, descriptor: PropertyDescriptor) => {\n      descriptor.value[OPERATION] = new RpcOperation(target.constructor as any, propertyKey, obtainInstance(policy));\n    };\n  }\n\n  /** Convenience decorator for setting an RPC operation policy that allows response caching. */\n  export function allowResponseCaching(control: RpcResponseCacheControl = RpcResponseCacheControl.Immutable) {\n    return <T extends RpcInterface>(target: T, propertyKey: string, descriptor: PropertyDescriptor) => {\n      descriptor.value[OPERATION] = new RpcOperation(target.constructor as any, propertyKey, new class extends RpcOperationPolicy {\n        public override allowResponseCaching = () => control;\n      }());\n    };\n  }\n\n  /** Convenience decorator for setting an RPC operation policy that supplies the IModelRpcProps for an operation. */\n  export function setRoutingProps(handler: RpcRequestTokenSupplier_T) {\n    return <T extends RpcInterface>(target: T, propertyKey: string, descriptor: PropertyDescriptor) => {\n      descriptor.value[OPERATION] = new RpcOperation(target.constructor as any, propertyKey, new class extends RpcOperationPolicy {\n        public override token = handler;\n      }());\n    };\n  }\n\n  /** Decorator for setting the default policy for an RPC interface definition class. */\n  export function setDefaultPolicy(policy: RpcOperationPolicy | RpcOperationPolicyProps) {\n    return <T extends RpcInterface>(definition: RpcInterfaceDefinition<T>) => {\n      (definition as any)[POLICY] = obtainInstance(policy);\n    };\n  }\n}\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