@itwin/core-common 4.0.0-dev.10 → 4.0.0-dev.101

package/lib/cjs/rpc/IModelTileRpcInterface.d.ts

@@ -1,62 +1,50 @@
-/** @packageDocumentation
- * @module RpcInterface
- */
-import type { TransferConfig } from "@itwin/object-storage-core/lib/common";
-import { Id64Array } from "@itwin/core-bentley";
-import { CloudStorageContainerDescriptor, CloudStorageContainerUrl } from "../CloudStorage";
-import { TileContentIdentifier } from "../CloudStorageTileCache";
-import { IModelRpcProps } from "../IModel";
-import { RpcInterface } from "../RpcInterface";
-import { ElementGraphicsRequestProps } from "../tile/ElementGraphics";
-import { IModelTileTreeProps, TileContentSource, TileVersionInfo } from "../TileProps";
-/** @public */
-export declare abstract class IModelTileRpcInterface extends RpcInterface {
-    static getClient(): IModelTileRpcInterface;
-    /** The immutable name of the interface. */
-    static readonly interfaceName = "IModelTileRpcInterface";
-    /** The semantic version of the interface. */
-    static interfaceVersion: string;
-    /**
-     * @returns undefined if the backend does not support caching
-     * @beta
-     */
-    getTileCacheConfig(_tokenProps: IModelRpcProps): Promise<TransferConfig | undefined>;
-    /**
-     * Returns connection information for external tile cache or an empty `CloudStorageContainerUrl` if no external tile cache is configured on the backend.
-     * @beta
-     * @deprecated in 3.x.
-     */
-    getTileCacheContainerUrl(_tokenProps: IModelRpcProps, _id: CloudStorageContainerDescriptor): Promise<CloudStorageContainerUrl>;
-    /** Returns true if an external tile cache is configured on the backend.
-     * @internal @deprecated in 3.x.
-     */
-    isUsingExternalTileCache(): Promise<boolean>;
-    /** @internal */
-    requestTileTreeProps(_tokenProps: IModelRpcProps, _id: string): Promise<IModelTileTreeProps>;
-    /** Ask the backend to generate content for the specified tile. This function, unlike the deprecated `requestTileContent`, does not check the cloud storage tile cache -
-     * Use `CloudStorageTileCache.retrieve` for that.
-     * @returns TileContentSource - if Backend, use retrieveTileContent. If ExternalCache, use TileAdmin.requestCachedTileContent
-     * @internal
-     */
-    generateTileContent(_rpcProps: IModelRpcProps, _treeId: string, _contentId: string, _guid: string | undefined): Promise<TileContentSource>;
-    /** Retrieves tile content from the backend once it's generated by generateTileContent.
-     *  @internal
-     */
-    retrieveTileContent(_rpcProps: IModelRpcProps, _key: TileContentIdentifier): Promise<Uint8Array>;
-    /** @internal */
-    queryVersionInfo(): Promise<TileVersionInfo>;
-    /** This is a temporary workaround for folks developing authoring applications, to be removed when proper support for such applications is introduced.
-     * Given a set of model Ids, it purges any associated tile tree state on the back-end so that the next request for the tile tree or content will recreate that state.
-     * Invoked after a modification is made to the model(s).
-     * If no array of model Ids is supplied, it purges *all* tile trees, which can be quite inefficient.
-     * @internal
-     */
-    purgeTileTrees(_tokenProps: IModelRpcProps, _modelIds: Id64Array | undefined): Promise<void>;
-    /** Requests graphics for a single element in "iMdl" format.
-     * @returns graphics in iMdl format, or `undefined` if the element's geometry produced no graphics or the request was canceled before completion.
-     * @throws IModelError on bad request (nonexistent element, duplicate request Id, etc).
-     * @internal
-     */
-    requestElementGraphics(_rpcProps: IModelRpcProps, _request: ElementGraphicsRequestProps): Promise<Uint8Array | undefined>;
-}
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import type { TransferConfig } from "@itwin/object-storage-core/lib/common";
+import { Id64Array } from "@itwin/core-bentley";
+import { IModelRpcProps } from "../IModel";
+import { RpcInterface } from "../RpcInterface";
+import { ElementGraphicsRequestProps } from "../tile/ElementGraphics";
+import { IModelTileTreeProps, TileContentIdentifier, TileContentSource, TileVersionInfo } from "../TileProps";
+/** @public */
+export declare abstract class IModelTileRpcInterface extends RpcInterface {
+    static getClient(): IModelTileRpcInterface;
+    /** The immutable name of the interface. */
+    static readonly interfaceName = "IModelTileRpcInterface";
+    /** The semantic version of the interface. */
+    static interfaceVersion: string;
+    /** Get storage config required to download tiles from the tile cache.
+     * @returns undefined if the backend does not support caching. In that case, tiles must be requested using [[generateTileContent]].
+     * @beta
+     */
+    getTileCacheConfig(_tokenProps: IModelRpcProps): Promise<TransferConfig | undefined>;
+    /** @internal */
+    requestTileTreeProps(_tokenProps: IModelRpcProps, _id: string): Promise<IModelTileTreeProps>;
+    /** Ask the backend to generate content for the specified tile. This function, unlike the deprecated `requestTileContent`, does not check the cloud storage tile cache -
+     * Use `CloudStorageTileCache.retrieve` for that.
+     * @returns TileContentSource - if Backend, use retrieveTileContent. If ExternalCache, use TileAdmin.requestCachedTileContent
+     * @internal
+     */
+    generateTileContent(_rpcProps: IModelRpcProps, _treeId: string, _contentId: string, _guid: string | undefined): Promise<TileContentSource>;
+    /** Retrieves tile content from the backend once it's generated by generateTileContent.
+     *  @internal
+     */
+    retrieveTileContent(_rpcProps: IModelRpcProps, _key: TileContentIdentifier): Promise<Uint8Array>;
+    /** @internal */
+    queryVersionInfo(): Promise<TileVersionInfo>;
+    /** This is a temporary workaround for folks developing authoring applications, to be removed when proper support for such applications is introduced.
+     * Given a set of model Ids, it purges any associated tile tree state on the back-end so that the next request for the tile tree or content will recreate that state.
+     * Invoked after a modification is made to the model(s).
+     * If no array of model Ids is supplied, it purges *all* tile trees, which can be quite inefficient.
+     * @internal
+     */
+    purgeTileTrees(_tokenProps: IModelRpcProps, _modelIds: Id64Array | undefined): Promise<void>;
+    /** Requests graphics for a single element in "iMdl" format.
+     * @returns graphics in iMdl format, or `undefined` if the element's geometry produced no graphics or the request was canceled before completion.
+     * @throws IModelError on bad request (nonexistent element, duplicate request Id, etc).
+     * @internal
+     */
+    requestElementGraphics(_rpcProps: IModelRpcProps, _request: ElementGraphicsRequestProps): Promise<Uint8Array | undefined>;
+}
 //# sourceMappingURL=IModelTileRpcInterface.d.ts.map

package/lib/cjs/rpc/IModelTileRpcInterface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IModelTileRpcInterface.d.ts","sourceRoot":"","sources":["../../../src/rpc/IModelTileRpcInterface.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AAC5E,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,+BAA+B,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAC5F,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAGjE,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAEvF,cAAc;AACd,8BAAsB,sBAAuB,SAAQ,YAAY;WACjD,SAAS,IAAI,sBAAsB;IAEjD,2CAA2C;IAC3C,gBAAuB,aAAa,4BAA4B;IAEhE,6CAA6C;IAC7C,OAAc,gBAAgB,SAAW;IAOzC;;;OAGG;IACU,kBAAkB,CAAC,WAAW,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IAKjG;;;;OAIG;IAGU,wBAAwB,CAAC,WAAW,EAAE,cAAc,EAAE,GAAG,EAAE,+BAA+B,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAI3I;;OAEG;IACU,wBAAwB,IAAI,OAAO,CAAC,OAAO,CAAC;IAIzD,gBAAgB;IAEH,oBAAoB,CAAC,WAAW,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAEzG;;;;OAIG;IACU,mBAAmB,CAAC,SAAS,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIvJ;;OAEG;IACU,mBAAmB,CAAC,SAAS,EAAE,cAAc,EAAE,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,CAAC;IAI7G,gBAAgB;IACH,gBAAgB,IAAI,OAAO,CAAC,eAAe,CAAC;IAIzD;;;;;OAKG;IACU,cAAc,CAAC,WAAW,EAAE,cAAc,EAAE,SAAS,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAEzG;;;;OAIG;IACU,sBAAsB,CAAC,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAE,2BAA2B,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;CAGvI"}
+{"version":3,"file":"IModelTileRpcInterface.d.ts","sourceRoot":"","sources":["../../../src/rpc/IModelTileRpcInterface.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AAC5E,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAGhD,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE9G,cAAc;AACd,8BAAsB,sBAAuB,SAAQ,YAAY;WACjD,SAAS,IAAI,sBAAsB;IAEjD,2CAA2C;IAC3C,gBAAuB,aAAa,4BAA4B;IAEhE,6CAA6C;IAC7C,OAAc,gBAAgB,SAAW;IAOzC;;;OAGG;IACU,kBAAkB,CAAC,WAAW,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IAKjG,gBAAgB;IAEH,oBAAoB,CAAC,WAAW,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAEzG;;;;OAIG;IACU,mBAAmB,CAAC,SAAS,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIvJ;;OAEG;IACU,mBAAmB,CAAC,SAAS,EAAE,cAAc,EAAE,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,CAAC;IAI7G,gBAAgB;IACH,gBAAgB,IAAI,OAAO,CAAC,eAAe,CAAC;IAIzD;;;;;OAKG;IACU,cAAc,CAAC,WAAW,EAAE,cAAc,EAAE,SAAS,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAEzG;;;;OAIG;IACU,sBAAsB,CAAC,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAE,2BAA2B,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;CAGvI"}

package/lib/cjs/rpc/IModelTileRpcInterface.js

@@ -1,97 +1,80 @@
-"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
- */
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IModelTileRpcInterface = void 0;
-const RpcConstants_1 = require("./core/RpcConstants");
-const RpcOperation_1 = require("./core/RpcOperation");
-const RpcInterface_1 = require("../RpcInterface");
-const RpcManager_1 = require("../RpcManager");
-/** @public */
-class IModelTileRpcInterface extends RpcInterface_1.RpcInterface {
-    static getClient() { return RpcManager_1.RpcManager.getClientForInterface(IModelTileRpcInterface); }
-    /*===========================================================================================
-      NOTE: Any add/remove/change to the methods below requires an update of the interface version.
-      NOTE: Please consult the README in this folder for the semantic versioning rules.
-    ===========================================================================================*/
-    /**
-     * @returns undefined if the backend does not support caching
-     * @beta
-     */
-    async getTileCacheConfig(_tokenProps) {
-        const response = await this.forward(arguments);
-        return response && { ...response, expiration: new Date(response.expiration) };
-    }
-    /**
-     * Returns connection information for external tile cache or an empty `CloudStorageContainerUrl` if no external tile cache is configured on the backend.
-     * @beta
-     * @deprecated in 3.x.
-     */
-    async getTileCacheContainerUrl(_tokenProps, _id) {
-        return this.forward(arguments);
-    }
-    /** Returns true if an external tile cache is configured on the backend.
-     * @internal @deprecated in 3.x.
-     */
-    async isUsingExternalTileCache() {
-        return this.forward(arguments);
-    }
-    /** @internal */
-    async requestTileTreeProps(_tokenProps, _id) { return this.forward(arguments); }
-    /** Ask the backend to generate content for the specified tile. This function, unlike the deprecated `requestTileContent`, does not check the cloud storage tile cache -
-     * Use `CloudStorageTileCache.retrieve` for that.
-     * @returns TileContentSource - if Backend, use retrieveTileContent. If ExternalCache, use TileAdmin.requestCachedTileContent
-     * @internal
-     */
-    async generateTileContent(_rpcProps, _treeId, _contentId, _guid) {
-        return this.forward(arguments);
-    }
-    /** Retrieves tile content from the backend once it's generated by generateTileContent.
-     *  @internal
-     */
-    async retrieveTileContent(_rpcProps, _key) {
-        return this.forward(arguments);
-    }
-    /** @internal */
-    async queryVersionInfo() {
-        return this.forward(arguments);
-    }
-    /** This is a temporary workaround for folks developing authoring applications, to be removed when proper support for such applications is introduced.
-     * Given a set of model Ids, it purges any associated tile tree state on the back-end so that the next request for the tile tree or content will recreate that state.
-     * Invoked after a modification is made to the model(s).
-     * If no array of model Ids is supplied, it purges *all* tile trees, which can be quite inefficient.
-     * @internal
-     */
-    async purgeTileTrees(_tokenProps, _modelIds) { return this.forward(arguments); }
-    /** Requests graphics for a single element in "iMdl" format.
-     * @returns graphics in iMdl format, or `undefined` if the element's geometry produced no graphics or the request was canceled before completion.
-     * @throws IModelError on bad request (nonexistent element, duplicate request Id, etc).
-     * @internal
-     */
-    async requestElementGraphics(_rpcProps, _request) {
-        return this.forward(arguments);
-    }
-}
-/** The immutable name of the interface. */
-IModelTileRpcInterface.interfaceName = "IModelTileRpcInterface";
-/** The semantic version of the interface. */
-IModelTileRpcInterface.interfaceVersion = "3.2.0";
-__decorate([
-    RpcOperation_1.RpcOperation.allowResponseCaching(RpcConstants_1.RpcResponseCacheControl.Immutable) // eslint-disable-line deprecation/deprecation
-], IModelTileRpcInterface.prototype, "getTileCacheContainerUrl", null);
-__decorate([
-    RpcOperation_1.RpcOperation.allowResponseCaching(RpcConstants_1.RpcResponseCacheControl.Immutable) // eslint-disable-line deprecation/deprecation
-], IModelTileRpcInterface.prototype, "requestTileTreeProps", null);
-exports.IModelTileRpcInterface = IModelTileRpcInterface;
+"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
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IModelTileRpcInterface = void 0;
+const RpcConstants_1 = require("./core/RpcConstants");
+const RpcOperation_1 = require("./core/RpcOperation");
+const RpcInterface_1 = require("../RpcInterface");
+const RpcManager_1 = require("../RpcManager");
+/** @public */
+class IModelTileRpcInterface extends RpcInterface_1.RpcInterface {
+    static getClient() { return RpcManager_1.RpcManager.getClientForInterface(IModelTileRpcInterface); }
+    /*===========================================================================================
+      NOTE: Any add/remove/change to the methods below requires an update of the interface version.
+      NOTE: Please consult the README in this folder for the semantic versioning rules.
+    ===========================================================================================*/
+    /** Get storage config required to download tiles from the tile cache.
+     * @returns undefined if the backend does not support caching. In that case, tiles must be requested using [[generateTileContent]].
+     * @beta
+     */
+    async getTileCacheConfig(_tokenProps) {
+        const response = await this.forward(arguments);
+        return response && { ...response, expiration: new Date(response.expiration) };
+    }
+    /** @internal */
+    async requestTileTreeProps(_tokenProps, _id) { return this.forward(arguments); }
+    /** Ask the backend to generate content for the specified tile. This function, unlike the deprecated `requestTileContent`, does not check the cloud storage tile cache -
+     * Use `CloudStorageTileCache.retrieve` for that.
+     * @returns TileContentSource - if Backend, use retrieveTileContent. If ExternalCache, use TileAdmin.requestCachedTileContent
+     * @internal
+     */
+    async generateTileContent(_rpcProps, _treeId, _contentId, _guid) {
+        return this.forward(arguments);
+    }
+    /** Retrieves tile content from the backend once it's generated by generateTileContent.
+     *  @internal
+     */
+    async retrieveTileContent(_rpcProps, _key) {
+        return this.forward(arguments);
+    }
+    /** @internal */
+    async queryVersionInfo() {
+        return this.forward(arguments);
+    }
+    /** This is a temporary workaround for folks developing authoring applications, to be removed when proper support for such applications is introduced.
+     * Given a set of model Ids, it purges any associated tile tree state on the back-end so that the next request for the tile tree or content will recreate that state.
+     * Invoked after a modification is made to the model(s).
+     * If no array of model Ids is supplied, it purges *all* tile trees, which can be quite inefficient.
+     * @internal
+     */
+    async purgeTileTrees(_tokenProps, _modelIds) { return this.forward(arguments); }
+    /** Requests graphics for a single element in "iMdl" format.
+     * @returns graphics in iMdl format, or `undefined` if the element's geometry produced no graphics or the request was canceled before completion.
+     * @throws IModelError on bad request (nonexistent element, duplicate request Id, etc).
+     * @internal
+     */
+    async requestElementGraphics(_rpcProps, _request) {
+        return this.forward(arguments);
+    }
+}
+/** The immutable name of the interface. */
+IModelTileRpcInterface.interfaceName = "IModelTileRpcInterface";
+/** The semantic version of the interface. */
+IModelTileRpcInterface.interfaceVersion = "3.2.0";
+__decorate([
+    RpcOperation_1.RpcOperation.allowResponseCaching(RpcConstants_1.RpcResponseCacheControl.Immutable) // eslint-disable-line deprecation/deprecation
+], IModelTileRpcInterface.prototype, "requestTileTreeProps", null);
+exports.IModelTileRpcInterface = IModelTileRpcInterface;
 //# sourceMappingURL=IModelTileRpcInterface.js.map

package/lib/cjs/rpc/IModelTileRpcInterface.js.map

@@ -1 +1 @@
-{"version":3,"file":"IModelTileRpcInterface.js","sourceRoot":"","sources":["../../../src/rpc/IModelTileRpcInterface.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;;;;;;;AAMH,sDAA8D;AAC9D,sDAAmD;AAEnD,kDAA+C;AAC/C,8CAA2C;AAI3C,cAAc;AACd,MAAsB,sBAAuB,SAAQ,2BAAY;IACxD,MAAM,CAAC,SAAS,KAA6B,OAAO,uBAAU,CAAC,qBAAqB,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAQtH;;;iGAG6F;IAE7F;;;OAGG;IACI,KAAK,CAAC,kBAAkB,CAAC,WAA2B;QACzD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC/C,OAAO,QAAQ,IAAI,EAAE,GAAG,QAAQ,EAAE,UAAU,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;IAChF,CAAC;IAED;;;;OAIG;IAGI,KAAK,CAAC,wBAAwB,CAAC,WAA2B,EAAE,GAAoC;QACrG,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,wBAAwB;QACnC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,gBAAgB;IAET,KAAK,CAAC,oBAAoB,CAAC,WAA2B,EAAE,GAAW,IAAkC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAE7I;;;;OAIG;IACI,KAAK,CAAC,mBAAmB,CAAC,SAAyB,EAAE,OAAe,EAAE,UAAkB,EAAE,KAAyB;QACxH,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,mBAAmB,CAAC,SAAyB,EAAE,IAA2B;QACrF,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,gBAAgB;IACT,KAAK,CAAC,gBAAgB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,cAAc,CAAC,WAA2B,EAAE,SAAgC,IAAmB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAE7I;;;;OAIG;IACI,KAAK,CAAC,sBAAsB,CAAC,SAAyB,EAAE,QAAqC;QAClG,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;;AA9ED,2CAA2C;AACpB,oCAAa,GAAG,wBAAwB,CAAC;AAEhE,6CAA6C;AAC/B,uCAAgB,GAAG,OAAO,CAAC;AAuBzC;IAFC,2BAAY,CAAC,oBAAoB,CAAC,sCAAuB,CAAC,SAAS,CAAC,CAAC,8CAA8C;sEAInH;AAWD;IADC,2BAAY,CAAC,oBAAoB,CAAC,sCAAuB,CAAC,SAAS,CAAC,CAAC,8CAA8C;kEACyB;AA3C/I,wDAkFC","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 type { TransferConfig } from \"@itwin/object-storage-core/lib/common\";\r\nimport { Id64Array } from \"@itwin/core-bentley\";\r\nimport { CloudStorageContainerDescriptor, CloudStorageContainerUrl } from \"../CloudStorage\";\r\nimport { TileContentIdentifier } from \"../CloudStorageTileCache\";\r\nimport { RpcResponseCacheControl } from \"./core/RpcConstants\";\r\nimport { RpcOperation } from \"./core/RpcOperation\";\r\nimport { IModelRpcProps } from \"../IModel\";\r\nimport { RpcInterface } from \"../RpcInterface\";\r\nimport { RpcManager } from \"../RpcManager\";\r\nimport { ElementGraphicsRequestProps } from \"../tile/ElementGraphics\";\r\nimport { IModelTileTreeProps, TileContentSource, TileVersionInfo } from \"../TileProps\";\r\n\r\n/** @public */\r\nexport abstract class IModelTileRpcInterface extends RpcInterface { // eslint-disable-line deprecation/deprecation\r\n  public static getClient(): IModelTileRpcInterface { return RpcManager.getClientForInterface(IModelTileRpcInterface); }\r\n\r\n  /** The immutable name of the interface. */\r\n  public static readonly interfaceName = \"IModelTileRpcInterface\";\r\n\r\n  /** The semantic version of the interface. */\r\n  public static interfaceVersion = \"3.2.0\";\r\n\r\n  /*===========================================================================================\r\n    NOTE: Any add/remove/change to the methods below requires an update of the interface version.\r\n    NOTE: Please consult the README in this folder for the semantic versioning rules.\r\n  ===========================================================================================*/\r\n\r\n  /**\r\n   * @returns undefined if the backend does not support caching\r\n   * @beta\r\n   */\r\n  public async getTileCacheConfig(_tokenProps: IModelRpcProps): Promise<TransferConfig | undefined> {\r\n    const response = await this.forward(arguments);\r\n    return response && { ...response, expiration: new Date(response.expiration) };\r\n  }\r\n\r\n  /**\r\n   * Returns connection information for external tile cache or an empty `CloudStorageContainerUrl` if no external tile cache is configured on the backend.\r\n   * @beta\r\n   * @deprecated in 3.x.\r\n   */\r\n  @RpcOperation.allowResponseCaching(RpcResponseCacheControl.Immutable) // eslint-disable-line deprecation/deprecation\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  public async getTileCacheContainerUrl(_tokenProps: IModelRpcProps, _id: CloudStorageContainerDescriptor): Promise<CloudStorageContainerUrl> {\r\n    return this.forward(arguments);\r\n  }\r\n\r\n  /** Returns true if an external tile cache is configured on the backend.\r\n   * @internal @deprecated in 3.x.\r\n   */\r\n  public async isUsingExternalTileCache(): Promise<boolean> { // eslint-disable-line @itwin/prefer-get\r\n    return this.forward(arguments);\r\n  }\r\n\r\n  /** @internal */\r\n  @RpcOperation.allowResponseCaching(RpcResponseCacheControl.Immutable) // eslint-disable-line deprecation/deprecation\r\n  public async requestTileTreeProps(_tokenProps: IModelRpcProps, _id: string): Promise<IModelTileTreeProps> { return this.forward(arguments); }\r\n\r\n  /** Ask the backend to generate content for the specified tile. This function, unlike the deprecated `requestTileContent`, does not check the cloud storage tile cache -\r\n   * Use `CloudStorageTileCache.retrieve` for that.\r\n   * @returns TileContentSource - if Backend, use retrieveTileContent. If ExternalCache, use TileAdmin.requestCachedTileContent\r\n   * @internal\r\n   */\r\n  public async generateTileContent(_rpcProps: IModelRpcProps, _treeId: string, _contentId: string, _guid: string | undefined): Promise<TileContentSource> {\r\n    return this.forward(arguments);\r\n  }\r\n\r\n  /** Retrieves tile content from the backend once it's generated by generateTileContent.\r\n   *  @internal\r\n   */\r\n  public async retrieveTileContent(_rpcProps: IModelRpcProps, _key: TileContentIdentifier): Promise<Uint8Array> {\r\n    return this.forward(arguments);\r\n  }\r\n\r\n  /** @internal */\r\n  public async queryVersionInfo(): Promise<TileVersionInfo> {\r\n    return this.forward(arguments);\r\n  }\r\n\r\n  /** This is a temporary workaround for folks developing authoring applications, to be removed when proper support for such applications is introduced.\r\n   * Given a set of model Ids, it purges any associated tile tree state on the back-end so that the next request for the tile tree or content will recreate that state.\r\n   * Invoked after a modification is made to the model(s).\r\n   * If no array of model Ids is supplied, it purges *all* tile trees, which can be quite inefficient.\r\n   * @internal\r\n   */\r\n  public async purgeTileTrees(_tokenProps: IModelRpcProps, _modelIds: Id64Array | undefined): Promise<void> { return this.forward(arguments); }\r\n\r\n  /** Requests graphics for a single element in \"iMdl\" format.\r\n   * @returns graphics in iMdl format, or `undefined` if the element's geometry produced no graphics or the request was canceled before completion.\r\n   * @throws IModelError on bad request (nonexistent element, duplicate request Id, etc).\r\n   * @internal\r\n   */\r\n  public async requestElementGraphics(_rpcProps: IModelRpcProps, _request: ElementGraphicsRequestProps): Promise<Uint8Array | undefined> {\r\n    return this.forward(arguments);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"IModelTileRpcInterface.js","sourceRoot":"","sources":["../../../src/rpc/IModelTileRpcInterface.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;;;;;;;AAIH,sDAA8D;AAC9D,sDAAmD;AAEnD,kDAA+C;AAC/C,8CAA2C;AAI3C,cAAc;AACd,MAAsB,sBAAuB,SAAQ,2BAAY;IACxD,MAAM,CAAC,SAAS,KAA6B,OAAO,uBAAU,CAAC,qBAAqB,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAQtH;;;iGAG6F;IAE7F;;;OAGG;IACI,KAAK,CAAC,kBAAkB,CAAC,WAA2B;QACzD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC/C,OAAO,QAAQ,IAAI,EAAE,GAAG,QAAQ,EAAE,UAAU,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;IAChF,CAAC;IAED,gBAAgB;IAEH,AAAN,KAAK,CAAC,oBAAoB,CAAC,WAA2B,EAAE,GAAW,IAAkC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAE7I;;;;OAIG;IACI,KAAK,CAAC,mBAAmB,CAAC,SAAyB,EAAE,OAAe,EAAE,UAAkB,EAAE,KAAyB;QACxH,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,mBAAmB,CAAC,SAAyB,EAAE,IAA2B;QACrF,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED,gBAAgB;IACT,KAAK,CAAC,gBAAgB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,cAAc,CAAC,WAA2B,EAAE,SAAgC,IAAmB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAE7I;;;;OAIG;IACI,KAAK,CAAC,sBAAsB,CAAC,SAAyB,EAAE,QAAqC;QAClG,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;;AA5DD,2CAA2C;AACpB,oCAAa,GAAG,wBAAwB,CAAC;AAEhE,6CAA6C;AAC/B,uCAAgB,GAAG,OAAO,CAAC;AAkB5B;IADZ,2BAAY,CAAC,oBAAoB,CAAC,sCAAuB,CAAC,SAAS,CAAC,CAAC,8CAA8C;kEACyB;AAzBzH,wDAAsB","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 type { TransferConfig } from \"@itwin/object-storage-core/lib/common\";\nimport { Id64Array } from \"@itwin/core-bentley\";\nimport { RpcResponseCacheControl } from \"./core/RpcConstants\";\nimport { RpcOperation } from \"./core/RpcOperation\";\nimport { IModelRpcProps } from \"../IModel\";\nimport { RpcInterface } from \"../RpcInterface\";\nimport { RpcManager } from \"../RpcManager\";\nimport { ElementGraphicsRequestProps } from \"../tile/ElementGraphics\";\nimport { IModelTileTreeProps, TileContentIdentifier, TileContentSource, TileVersionInfo } from \"../TileProps\";\n\n/** @public */\nexport abstract class IModelTileRpcInterface extends RpcInterface { // eslint-disable-line deprecation/deprecation\n  public static getClient(): IModelTileRpcInterface { return RpcManager.getClientForInterface(IModelTileRpcInterface); }\n\n  /** The immutable name of the interface. */\n  public static readonly interfaceName = \"IModelTileRpcInterface\";\n\n  /** The semantic version of the interface. */\n  public static interfaceVersion = \"3.2.0\";\n\n  /*===========================================================================================\n    NOTE: Any add/remove/change to the methods below requires an update of the interface version.\n    NOTE: Please consult the README in this folder for the semantic versioning rules.\n  ===========================================================================================*/\n\n  /** Get storage config required to download tiles from the tile cache.\n   * @returns undefined if the backend does not support caching. In that case, tiles must be requested using [[generateTileContent]].\n   * @beta\n   */\n  public async getTileCacheConfig(_tokenProps: IModelRpcProps): Promise<TransferConfig | undefined> {\n    const response = await this.forward(arguments);\n    return response && { ...response, expiration: new Date(response.expiration) };\n  }\n\n  /** @internal */\n  @RpcOperation.allowResponseCaching(RpcResponseCacheControl.Immutable) // eslint-disable-line deprecation/deprecation\n  public async requestTileTreeProps(_tokenProps: IModelRpcProps, _id: string): Promise<IModelTileTreeProps> { return this.forward(arguments); }\n\n  /** Ask the backend to generate content for the specified tile. This function, unlike the deprecated `requestTileContent`, does not check the cloud storage tile cache -\n   * Use `CloudStorageTileCache.retrieve` for that.\n   * @returns TileContentSource - if Backend, use retrieveTileContent. If ExternalCache, use TileAdmin.requestCachedTileContent\n   * @internal\n   */\n  public async generateTileContent(_rpcProps: IModelRpcProps, _treeId: string, _contentId: string, _guid: string | undefined): Promise<TileContentSource> {\n    return this.forward(arguments);\n  }\n\n  /** Retrieves tile content from the backend once it's generated by generateTileContent.\n   *  @internal\n   */\n  public async retrieveTileContent(_rpcProps: IModelRpcProps, _key: TileContentIdentifier): Promise<Uint8Array> {\n    return this.forward(arguments);\n  }\n\n  /** @internal */\n  public async queryVersionInfo(): Promise<TileVersionInfo> {\n    return this.forward(arguments);\n  }\n\n  /** This is a temporary workaround for folks developing authoring applications, to be removed when proper support for such applications is introduced.\n   * Given a set of model Ids, it purges any associated tile tree state on the back-end so that the next request for the tile tree or content will recreate that state.\n   * Invoked after a modification is made to the model(s).\n   * If no array of model Ids is supplied, it purges *all* tile trees, which can be quite inefficient.\n   * @internal\n   */\n  public async purgeTileTrees(_tokenProps: IModelRpcProps, _modelIds: Id64Array | undefined): Promise<void> { return this.forward(arguments); }\n\n  /** Requests graphics for a single element in \"iMdl\" format.\n   * @returns graphics in iMdl format, or `undefined` if the element's geometry produced no graphics or the request was canceled before completion.\n   * @throws IModelError on bad request (nonexistent element, duplicate request Id, etc).\n   * @internal\n   */\n  public async requestElementGraphics(_rpcProps: IModelRpcProps, _request: ElementGraphicsRequestProps): Promise<Uint8Array | undefined> {\n    return this.forward(arguments);\n  }\n}\n"]}

package/lib/cjs/rpc/SnapshotIModelRpcInterface.d.ts

@@ -1,24 +1,24 @@
-/** @packageDocumentation
- * @module RpcInterface
- */
-import { IModelConnectionProps, IModelRpcProps, SnapshotOpenOptions } from "../IModel";
-import { RpcInterface } from "../RpcInterface";
-import { RpcRoutingToken } from "./core/RpcRoutingToken";
-/** The RPC interface for working with *snapshot* iModels.
- * This interface is intended for desktop and mobile products. Web products are discouraged from registering this interface.
- * @internal
- */
-export declare abstract class SnapshotIModelRpcInterface extends RpcInterface {
-    /** Returns the SnapshotIModelRpcInterface client instance for the frontend. */
-    static getClient(): SnapshotIModelRpcInterface;
-    /** Returns the SnapshotIModelRpcInterface client instance for a custom RPC routing configuration. */
-    static getClientForRouting(token: RpcRoutingToken): SnapshotIModelRpcInterface;
-    /** The immutable name of the interface. */
-    static readonly interfaceName = "SnapshotIModelRpcInterface";
-    /** The version of the interface. */
-    static interfaceVersion: string;
-    openFile(_filePath: string, _opts?: SnapshotOpenOptions): Promise<IModelConnectionProps>;
-    openRemote(_key: string, _opts?: SnapshotOpenOptions): Promise<IModelConnectionProps>;
-    close(_iModelRpcProps: IModelRpcProps): Promise<boolean>;
-}
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import { IModelConnectionProps, IModelRpcProps, SnapshotOpenOptions } from "../IModel";
+import { RpcInterface } from "../RpcInterface";
+import { RpcRoutingToken } from "./core/RpcRoutingToken";
+/** The RPC interface for working with *snapshot* iModels.
+ * This interface is intended for desktop and mobile products. Web products are discouraged from registering this interface.
+ * @internal
+ */
+export declare abstract class SnapshotIModelRpcInterface extends RpcInterface {
+    /** Returns the SnapshotIModelRpcInterface client instance for the frontend. */
+    static getClient(): SnapshotIModelRpcInterface;
+    /** Returns the SnapshotIModelRpcInterface client instance for a custom RPC routing configuration. */
+    static getClientForRouting(token: RpcRoutingToken): SnapshotIModelRpcInterface;
+    /** The immutable name of the interface. */
+    static readonly interfaceName = "SnapshotIModelRpcInterface";
+    /** The version of the interface. */
+    static interfaceVersion: string;
+    openFile(_filePath: string, _opts?: SnapshotOpenOptions): Promise<IModelConnectionProps>;
+    openRemote(_key: string, _opts?: SnapshotOpenOptions): Promise<IModelConnectionProps>;
+    close(_iModelRpcProps: IModelRpcProps): Promise<boolean>;
+}
 //# sourceMappingURL=SnapshotIModelRpcInterface.d.ts.map

package/lib/cjs/rpc/SnapshotIModelRpcInterface.js

@@ -1,49 +1,49 @@
-"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
- */
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SnapshotIModelRpcInterface = void 0;
-const RpcInterface_1 = require("../RpcInterface");
-const RpcManager_1 = require("../RpcManager");
-const RpcOperation_1 = require("./core/RpcOperation");
-const unknownIModelId = (req) => ({ iModelId: "undefined", key: req.parameters[0] });
-/** The RPC interface for working with *snapshot* iModels.
- * This interface is intended for desktop and mobile products. Web products are discouraged from registering this interface.
- * @internal
- */
-class SnapshotIModelRpcInterface extends RpcInterface_1.RpcInterface {
-    /** Returns the SnapshotIModelRpcInterface client instance for the frontend. */
-    static getClient() { return RpcManager_1.RpcManager.getClientForInterface(SnapshotIModelRpcInterface); }
-    /** Returns the SnapshotIModelRpcInterface client instance for a custom RPC routing configuration. */
-    static getClientForRouting(token) { return RpcManager_1.RpcManager.getClientForInterface(SnapshotIModelRpcInterface, token); }
-    /*===========================================================================================
-      NOTE: Any add/remove/change to the methods below requires an update of the interface version.
-      NOTE: Please consult the README in this folder for the semantic versioning rules.
-    ===========================================================================================*/
-    async openFile(_filePath, _opts) { return this.forward(arguments); }
-    async openRemote(_key, _opts) { return this.forward(arguments); }
-    async close(_iModelRpcProps) { return this.forward(arguments); }
-}
-/** The immutable name of the interface. */
-SnapshotIModelRpcInterface.interfaceName = "SnapshotIModelRpcInterface";
-/** The version of the interface. */
-SnapshotIModelRpcInterface.interfaceVersion = "2.0.0";
-__decorate([
-    RpcOperation_1.RpcOperation.setRoutingProps(unknownIModelId)
-], SnapshotIModelRpcInterface.prototype, "openFile", null);
-__decorate([
-    RpcOperation_1.RpcOperation.setRoutingProps(unknownIModelId)
-], SnapshotIModelRpcInterface.prototype, "openRemote", null);
-exports.SnapshotIModelRpcInterface = SnapshotIModelRpcInterface;
+"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
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SnapshotIModelRpcInterface = void 0;
+const RpcInterface_1 = require("../RpcInterface");
+const RpcManager_1 = require("../RpcManager");
+const RpcOperation_1 = require("./core/RpcOperation");
+const unknownIModelId = (req) => ({ iModelId: "undefined", key: req.parameters[0] });
+/** The RPC interface for working with *snapshot* iModels.
+ * This interface is intended for desktop and mobile products. Web products are discouraged from registering this interface.
+ * @internal
+ */
+class SnapshotIModelRpcInterface extends RpcInterface_1.RpcInterface {
+    /** Returns the SnapshotIModelRpcInterface client instance for the frontend. */
+    static getClient() { return RpcManager_1.RpcManager.getClientForInterface(SnapshotIModelRpcInterface); }
+    /** Returns the SnapshotIModelRpcInterface client instance for a custom RPC routing configuration. */
+    static getClientForRouting(token) { return RpcManager_1.RpcManager.getClientForInterface(SnapshotIModelRpcInterface, token); }
+    /*===========================================================================================
+      NOTE: Any add/remove/change to the methods below requires an update of the interface version.
+      NOTE: Please consult the README in this folder for the semantic versioning rules.
+    ===========================================================================================*/
+    async openFile(_filePath, _opts) { return this.forward(arguments); }
+    async openRemote(_key, _opts) { return this.forward(arguments); }
+    async close(_iModelRpcProps) { return this.forward(arguments); }
+}
+/** The immutable name of the interface. */
+SnapshotIModelRpcInterface.interfaceName = "SnapshotIModelRpcInterface";
+/** The version of the interface. */
+SnapshotIModelRpcInterface.interfaceVersion = "2.0.0";
+__decorate([
+    RpcOperation_1.RpcOperation.setRoutingProps(unknownIModelId)
+], SnapshotIModelRpcInterface.prototype, "openFile", null);
+__decorate([
+    RpcOperation_1.RpcOperation.setRoutingProps(unknownIModelId)
+], SnapshotIModelRpcInterface.prototype, "openRemote", null);
+exports.SnapshotIModelRpcInterface = SnapshotIModelRpcInterface;
 //# sourceMappingURL=SnapshotIModelRpcInterface.js.map

package/lib/cjs/rpc/SnapshotIModelRpcInterface.js.map

@@ -1 +1 @@
-{"version":3,"file":"SnapshotIModelRpcInterface.js","sourceRoot":"","sources":["../../../src/rpc/SnapshotIModelRpcInterface.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;;;;;;;AAGH,kDAA+C;AAC/C,8CAA2C;AAC3C,sDAAmD;AAInD,MAAM,eAAe,GAA8B,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AAEhH;;;GAGG;AACH,MAAsB,0BAA2B,SAAQ,2BAAY;IACnE,+EAA+E;IACxE,MAAM,CAAC,SAAS,KAAiC,OAAO,uBAAU,CAAC,qBAAqB,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC;IAE9H,qGAAqG;IAC9F,MAAM,CAAC,mBAAmB,CAAC,KAAsB,IAAgC,OAAO,uBAAU,CAAC,qBAAqB,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAQrK;;;iGAG6F;IAGtF,KAAK,CAAC,QAAQ,CAAC,SAAiB,EAAE,KAA2B,IAAoC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAGlI,KAAK,CAAC,UAAU,CAAC,IAAY,EAAE,KAA2B,IAAoC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAE/H,KAAK,CAAC,KAAK,CAAC,eAA+B,IAAsB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;;AAjBzG,2CAA2C;AACpB,wCAAa,GAAG,4BAA4B,CAAC;AAEpE,oCAAoC;AACtB,2CAAgB,GAAG,OAAO,CAAC;AAQzC;IADC,2BAAY,CAAC,eAAe,CAAC,eAAe,CAAC;0DAC2F;AAGzI;IADC,2BAAY,CAAC,eAAe,CAAC,eAAe,CAAC;4DACwF;AAtBxI,gEAyBC","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 { IModelConnectionProps, IModelRpcProps, SnapshotOpenOptions } from \"../IModel\";\r\nimport { RpcInterface } from \"../RpcInterface\";\r\nimport { RpcManager } from \"../RpcManager\";\r\nimport { RpcOperation } from \"./core/RpcOperation\";\r\nimport { RpcRequestTokenSupplier_T } from \"./core/RpcRequest\";\r\nimport { RpcRoutingToken } from \"./core/RpcRoutingToken\";\r\n\r\nconst unknownIModelId: RpcRequestTokenSupplier_T = (req) => ({ iModelId: \"undefined\", key: req.parameters[0] });\r\n\r\n/** The RPC interface for working with *snapshot* iModels.\r\n * This interface is intended for desktop and mobile products. Web products are discouraged from registering this interface.\r\n * @internal\r\n */\r\nexport abstract class SnapshotIModelRpcInterface extends RpcInterface { // eslint-disable-line deprecation/deprecation\r\n  /** Returns the SnapshotIModelRpcInterface client instance for the frontend. */\r\n  public static getClient(): SnapshotIModelRpcInterface { return RpcManager.getClientForInterface(SnapshotIModelRpcInterface); }\r\n\r\n  /** Returns the SnapshotIModelRpcInterface client instance for a custom RPC routing configuration. */\r\n  public static getClientForRouting(token: RpcRoutingToken): SnapshotIModelRpcInterface { return RpcManager.getClientForInterface(SnapshotIModelRpcInterface, token); }\r\n\r\n  /** The immutable name of the interface. */\r\n  public static readonly interfaceName = \"SnapshotIModelRpcInterface\";\r\n\r\n  /** The version of the interface. */\r\n  public static interfaceVersion = \"2.0.0\";\r\n\r\n  /*===========================================================================================\r\n    NOTE: Any add/remove/change to the methods below requires an update of the interface version.\r\n    NOTE: Please consult the README in this folder for the semantic versioning rules.\r\n  ===========================================================================================*/\r\n\r\n  @RpcOperation.setRoutingProps(unknownIModelId)\r\n  public async openFile(_filePath: string, _opts?: SnapshotOpenOptions): Promise<IModelConnectionProps> { return this.forward(arguments); }\r\n\r\n  @RpcOperation.setRoutingProps(unknownIModelId)\r\n  public async openRemote(_key: string, _opts?: SnapshotOpenOptions): Promise<IModelConnectionProps> { return this.forward(arguments); }\r\n\r\n  public async close(_iModelRpcProps: IModelRpcProps): Promise<boolean> { return this.forward(arguments); }\r\n}\r\n"]}
+{"version":3,"file":"SnapshotIModelRpcInterface.js","sourceRoot":"","sources":["../../../src/rpc/SnapshotIModelRpcInterface.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;;;;;;;AAGH,kDAA+C;AAC/C,8CAA2C;AAC3C,sDAAmD;AAInD,MAAM,eAAe,GAA8B,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AAEhH;;;GAGG;AACH,MAAsB,0BAA2B,SAAQ,2BAAY;IACnE,+EAA+E;IACxE,MAAM,CAAC,SAAS,KAAiC,OAAO,uBAAU,CAAC,qBAAqB,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC;IAE9H,qGAAqG;IAC9F,MAAM,CAAC,mBAAmB,CAAC,KAAsB,IAAgC,OAAO,uBAAU,CAAC,qBAAqB,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAQrK;;;iGAG6F;IAGhF,AAAN,KAAK,CAAC,QAAQ,CAAC,SAAiB,EAAE,KAA2B,IAAoC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAG5H,AAAN,KAAK,CAAC,UAAU,CAAC,IAAY,EAAE,KAA2B,IAAoC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAE/H,KAAK,CAAC,KAAK,CAAC,eAA+B,IAAsB,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;;AAjBzG,2CAA2C;AACpB,wCAAa,GAAG,4BAA4B,CAAC;AAEpE,oCAAoC;AACtB,2CAAgB,GAAG,OAAO,CAAC;AAQ5B;IADZ,2BAAY,CAAC,eAAe,CAAC,eAAe,CAAC;0DAC2F;AAG5H;IADZ,2BAAY,CAAC,eAAe,CAAC,eAAe,CAAC;4DACwF;AAtBlH,gEAA0B","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 { IModelConnectionProps, IModelRpcProps, SnapshotOpenOptions } from \"../IModel\";\nimport { RpcInterface } from \"../RpcInterface\";\nimport { RpcManager } from \"../RpcManager\";\nimport { RpcOperation } from \"./core/RpcOperation\";\nimport { RpcRequestTokenSupplier_T } from \"./core/RpcRequest\";\nimport { RpcRoutingToken } from \"./core/RpcRoutingToken\";\n\nconst unknownIModelId: RpcRequestTokenSupplier_T = (req) => ({ iModelId: \"undefined\", key: req.parameters[0] });\n\n/** The RPC interface for working with *snapshot* iModels.\n * This interface is intended for desktop and mobile products. Web products are discouraged from registering this interface.\n * @internal\n */\nexport abstract class SnapshotIModelRpcInterface extends RpcInterface { // eslint-disable-line deprecation/deprecation\n  /** Returns the SnapshotIModelRpcInterface client instance for the frontend. */\n  public static getClient(): SnapshotIModelRpcInterface { return RpcManager.getClientForInterface(SnapshotIModelRpcInterface); }\n\n  /** Returns the SnapshotIModelRpcInterface client instance for a custom RPC routing configuration. */\n  public static getClientForRouting(token: RpcRoutingToken): SnapshotIModelRpcInterface { return RpcManager.getClientForInterface(SnapshotIModelRpcInterface, token); }\n\n  /** The immutable name of the interface. */\n  public static readonly interfaceName = \"SnapshotIModelRpcInterface\";\n\n  /** The version of the interface. */\n  public static interfaceVersion = \"2.0.0\";\n\n  /*===========================================================================================\n    NOTE: Any add/remove/change to the methods below requires an update of the interface version.\n    NOTE: Please consult the README in this folder for the semantic versioning rules.\n  ===========================================================================================*/\n\n  @RpcOperation.setRoutingProps(unknownIModelId)\n  public async openFile(_filePath: string, _opts?: SnapshotOpenOptions): Promise<IModelConnectionProps> { return this.forward(arguments); }\n\n  @RpcOperation.setRoutingProps(unknownIModelId)\n  public async openRemote(_key: string, _opts?: SnapshotOpenOptions): Promise<IModelConnectionProps> { return this.forward(arguments); }\n\n  public async close(_iModelRpcProps: IModelRpcProps): Promise<boolean> { return this.forward(arguments); }\n}\n"]}

package/lib/cjs/rpc/TestRpcManager.d.ts

@@ -1,21 +1,21 @@
-/** @packageDocumentation
- * @module RpcInterface
- */
-import { RpcInterfaceDefinition } from "../RpcInterface";
-/** An RpcManager that uses RpcDefaultConfiguration/RpcDirectProtocol to make client stubs invoke
- * registered server impls as direct method calls within the same JavaScript context. In other words,
- * TestRpcManager sets up a protocol that uses our remoting mechanism but cuts out the communication
- * part of it. (No IPC or XHR is used or required.)
- * Nevertheless, all of the rest of the call marshalling and operation monitoring mechanism is used.
- * That makes TestRpcManager a way to write simple, single-process integration tests for frontends
- * and backends that actually use RpcInterfaces. Note that to write such a single-process integration
- * test, you must make *both* client and server use TestRpcManager to configure their RpcInterfaces.
- * It will not work if one side uses TestRpcManager and the other uses some other protocol (say, cloud).
- * That means that you must actually program the backend to know when it is running in direct test
- * mode and to employ TestRpcManager in that case.
- * @internal
- */
-export declare class TestRpcManager {
-    static initialize(interfaces: RpcInterfaceDefinition[]): void;
-}
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import { RpcInterfaceDefinition } from "../RpcInterface";
+/** An RpcManager that uses RpcDefaultConfiguration/RpcDirectProtocol to make client stubs invoke
+ * registered server impls as direct method calls within the same JavaScript context. In other words,
+ * TestRpcManager sets up a protocol that uses our remoting mechanism but cuts out the communication
+ * part of it. (No IPC or XHR is used or required.)
+ * Nevertheless, all of the rest of the call marshalling and operation monitoring mechanism is used.
+ * That makes TestRpcManager a way to write simple, single-process integration tests for frontends
+ * and backends that actually use RpcInterfaces. Note that to write such a single-process integration
+ * test, you must make *both* client and server use TestRpcManager to configure their RpcInterfaces.
+ * It will not work if one side uses TestRpcManager and the other uses some other protocol (say, cloud).
+ * That means that you must actually program the backend to know when it is running in direct test
+ * mode and to employ TestRpcManager in that case.
+ * @internal
+ */
+export declare class TestRpcManager {
+    static initialize(interfaces: RpcInterfaceDefinition[]): void;
+}
 //# sourceMappingURL=TestRpcManager.d.ts.map