@itwin/core-backend 3.0.0-dev.100

package/lib/cjs/rpc-impl/IModelReadRpcImpl.js

@@ -0,0 +1,207 @@
+"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.IModelReadRpcImpl = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const core_geometry_1 = require("@itwin/core-geometry");
+const Category_1 = require("../Category");
+const ConcurrentQuery_1 = require("../ConcurrentQuery");
+const GeometrySummary_1 = require("../GeometrySummary");
+const RpcBriefcaseUtility_1 = require("./RpcBriefcaseUtility");
+const RpcBackend_1 = require("../RpcBackend");
+/** The backend implementation of IModelReadRpcInterface.
+ * @internal
+ */
+class IModelReadRpcImpl extends core_common_1.RpcInterface {
+    static register() { core_common_1.RpcManager.registerImpl(core_common_1.IModelReadRpcInterface, IModelReadRpcImpl); }
+    async getConnectionProps(tokenProps) {
+        return RpcBriefcaseUtility_1.RpcBriefcaseUtility.openWithTimeout(RpcBackend_1.RpcTrace.currentActivity, tokenProps, core_common_1.SyncMode.FixedVersion);
+    }
+    async queryRows(tokenProps, request) {
+        const iModelDb = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        return ConcurrentQuery_1.ConcurrentQuery.executeQueryRequest(iModelDb.nativeDb, request);
+    }
+    async queryBlob(tokenProps, request) {
+        const iModelDb = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        return ConcurrentQuery_1.ConcurrentQuery.executeBlobRequest(iModelDb.nativeDb, request);
+    }
+    async queryModelRanges(tokenProps, modelIdsList) {
+        const modelIds = new Set(modelIdsList);
+        const iModelDb = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        const ranges = [];
+        for (const id of modelIds) {
+            try {
+                ranges.push(iModelDb.nativeDb.queryModelExtents({ id }).modelExtents);
+            }
+            catch (err) {
+                if (err.errorNumber === core_bentley_1.IModelStatus.NoGeometry) { // if there was no geometry, just return null range
+                    ranges.push(new core_geometry_1.Range3d());
+                    continue;
+                }
+                if (modelIds.size === 1)
+                    throw err; // if they're asking for more than one model, don't throw on error.
+                continue;
+            }
+        }
+        return ranges;
+    }
+    async getModelProps(tokenProps, modelIdsList) {
+        const modelIds = new Set(modelIdsList);
+        const iModelDb = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        const modelJsonArray = [];
+        for (const id of modelIds) {
+            try {
+                const modelProps = iModelDb.models.getModelJson({ id });
+                modelJsonArray.push(modelProps);
+            }
+            catch (error) {
+                if (modelIds.size === 1)
+                    throw error; // if they're asking for more than one model, don't throw on error.
+            }
+        }
+        return modelJsonArray;
+    }
+    async queryModelProps(tokenProps, params) {
+        const ids = await this.queryEntityIds(tokenProps, params);
+        return this.getModelProps(tokenProps, [...ids]);
+    }
+    async getElementProps(tokenProps, elementIdsList) {
+        const elementIds = new Set(elementIdsList);
+        const iModelDb = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        const elementProps = [];
+        for (const id of elementIds) {
+            try {
+                elementProps.push(iModelDb.elements.getElementJson({ id }));
+            }
+            catch (error) {
+                if (elementIds.size === 1)
+                    throw error; // if they're asking for more than one element, don't throw on error.
+            }
+        }
+        return elementProps;
+    }
+    async loadElementProps(tokenProps, identifier, options) {
+        const props = options ? { ...options } : {};
+        if (typeof identifier === "string") {
+            if (core_bentley_1.Id64.isId64(identifier))
+                props.id = identifier;
+            else
+                props.federationGuid = identifier;
+        }
+        else {
+            props.code = core_common_1.Code.fromJSON(identifier);
+        }
+        const iModelDb = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        return iModelDb.elements.tryGetElementProps(props);
+    }
+    async getGeometrySummary(tokenProps, request) {
+        const iModel = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        return (0, GeometrySummary_1.generateGeometrySummaries)(request, iModel);
+    }
+    async queryElementProps(tokenProps, params) {
+        const ids = await this.queryEntityIds(tokenProps, params);
+        const res = this.getElementProps(tokenProps, [...ids]);
+        return res;
+    }
+    async queryEntityIds(tokenProps, params) {
+        const iModelDb = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        const res = iModelDb.queryEntityIds(params);
+        return [...res];
+    }
+    async getClassHierarchy(tokenProps, classFullName) {
+        const iModelDb = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        const classArray = [];
+        while (true) {
+            const classMetaData = iModelDb.getMetaData(classFullName);
+            classArray.push(classFullName);
+            if (!classMetaData.baseClasses || classMetaData.baseClasses.length === 0)
+                break;
+            classFullName = classMetaData.baseClasses[0];
+        }
+        return classArray;
+    }
+    async getAllCodeSpecs(tokenProps) {
+        const codeSpecs = [];
+        const iModelDb = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        iModelDb.withPreparedStatement("SELECT ECInstanceId AS id, name, jsonProperties FROM BisCore.CodeSpec", (statement) => {
+            for (const row of statement)
+                codeSpecs.push({ id: row.id, name: row.name, jsonProperties: JSON.parse(row.jsonProperties) });
+        });
+        return codeSpecs;
+    }
+    async getViewStateData(tokenProps, viewDefinitionId, options) {
+        const iModelDb = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        return iModelDb.views.getViewStateData(viewDefinitionId, options);
+    }
+    async readFontJson(tokenProps) {
+        const iModelDb = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        return iModelDb.nativeDb.readFontMap();
+    }
+    async requestSnap(tokenProps, sessionId, props) {
+        const iModelDb = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        return iModelDb.requestSnap(sessionId, props);
+    }
+    async cancelSnap(tokenProps, sessionId) {
+        const iModelDb = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        return iModelDb.cancelSnap(sessionId);
+    }
+    async getGeometryContainment(tokenProps, props) {
+        const iModelDb = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        return iModelDb.getGeometryContainment(props);
+    }
+    async getMassProperties(tokenProps, props) {
+        const iModelDb = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        return iModelDb.getMassProperties(props);
+    }
+    async getToolTipMessage(tokenProps, id) {
+        const iModelDb = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        const el = iModelDb.elements.getElement(id);
+        return (el === undefined) ? [] : el.getToolTipMessage();
+    }
+    /** Send a view thumbnail to the frontend. This is a binary transfer with the metadata in a 16-byte prefix header. */
+    async getViewThumbnail(tokenProps, viewId) {
+        const iModelDb = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        const thumbnail = iModelDb.views.getThumbnail(viewId);
+        if (undefined === thumbnail || 0 === thumbnail.image.length)
+            throw new core_common_1.NoContentError();
+        const val = new Uint8Array(thumbnail.image.length + 16); // allocate a new buffer 16 bytes larger than the image size
+        new Uint32Array(val.buffer, 0, 4).set([thumbnail.image.length, thumbnail.format === "jpeg" ? core_common_1.ImageSourceFormat.Jpeg : core_common_1.ImageSourceFormat.Png, thumbnail.width, thumbnail.height]); // Put the metadata in the first 16 bytes.
+        val.set(thumbnail.image, 16); // put the image data at offset 16 after metadata
+        return val;
+    }
+    async getDefaultViewId(tokenProps) {
+        const iModelDb = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        const spec = { namespace: "dgn_View", name: "DefaultView" };
+        const blob = iModelDb.queryFilePropertyBlob(spec);
+        if (undefined === blob || 8 !== blob.length)
+            return core_bentley_1.Id64.invalid;
+        const view = new Uint32Array(blob.buffer);
+        return core_bentley_1.Id64.fromUint32Pair(view[0], view[1]);
+    }
+    async getSpatialCategoryId(tokenProps, categoryName) {
+        const iModelDb = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        const dictionary = iModelDb.models.getModel(core_common_1.IModel.dictionaryId);
+        return Category_1.SpatialCategory.queryCategoryIdByName(iModelDb, dictionary.id, categoryName);
+    }
+    async getIModelCoordinatesFromGeoCoordinates(tokenProps, props) {
+        const iModelDb = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        return iModelDb.getIModelCoordinatesFromGeoCoordinates(props);
+    }
+    async getGeoCoordinatesFromIModelCoordinates(tokenProps, props) {
+        const iModelDb = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        return iModelDb.getGeoCoordinatesFromIModelCoordinates(props);
+    }
+    async queryTextureData(tokenProps, textureLoadProps) {
+        const db = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        return db.queryTextureData(textureLoadProps);
+    }
+}
+exports.IModelReadRpcImpl = IModelReadRpcImpl;
+//# sourceMappingURL=IModelReadRpcImpl.js.map

package/lib/cjs/rpc-impl/IModelReadRpcImpl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModelReadRpcImpl.js","sourceRoot":"","sources":["../../../src/rpc-impl/IModelReadRpcImpl.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAiF;AACjF,oDAO4B;AAC5B,wDAA6D;AAC7D,0CAA8C;AAC9C,wDAAqD;AACrD,wDAA+D;AAE/D,+DAA4D;AAC5D,8CAAyC;AAEzC;;GAEG;AACH,MAAa,iBAAkB,SAAQ,0BAAY;IAE1C,MAAM,CAAC,QAAQ,KAAK,wBAAU,CAAC,YAAY,CAAC,oCAAsB,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAEzF,KAAK,CAAC,kBAAkB,CAAC,UAA8B;QAC5D,OAAO,yCAAmB,CAAC,eAAe,CAAC,qBAAQ,CAAC,eAAgB,EAAE,UAAU,EAAE,sBAAQ,CAAC,YAAY,CAAC,CAAC;IAC3G,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,UAA0B,EAAE,OAAuB;QACxE,MAAM,QAAQ,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC7G,OAAO,iCAAe,CAAC,mBAAmB,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;IACM,KAAK,CAAC,SAAS,CAAC,UAA0B,EAAE,OAAsB;QACvE,MAAM,QAAQ,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC7G,OAAO,iCAAe,CAAC,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IACM,KAAK,CAAC,gBAAgB,CAAC,UAA0B,EAAE,YAA0B;QAClF,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC;QACvC,MAAM,QAAQ,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC7G,MAAM,MAAM,GAAmB,EAAE,CAAC;QAClC,KAAK,MAAM,EAAE,IAAI,QAAQ,EAAE;YACzB,IAAI;gBACF,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC;aACvE;YAAC,OAAO,GAAQ,EAAE;gBACjB,IAAK,GAAmB,CAAC,WAAW,KAAK,2BAAY,CAAC,UAAU,EAAE,EAAE,mDAAmD;oBACrH,MAAM,CAAC,IAAI,CAAC,IAAI,uBAAO,EAAE,CAAC,CAAC;oBAC3B,SAAS;iBACV;gBAED,IAAI,QAAQ,CAAC,IAAI,KAAK,CAAC;oBACrB,MAAM,GAAG,CAAC,CAAC,mEAAmE;gBAChF,SAAS;aACV;SACF;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,UAA0B,EAAE,YAA0B;QAC/E,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC;QACvC,MAAM,QAAQ,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC7G,MAAM,cAAc,GAAiB,EAAE,CAAC;QACxC,KAAK,MAAM,EAAE,IAAI,QAAQ,EAAE;YACzB,IAAI;gBACF,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;gBACxD,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;aACjC;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI,QAAQ,CAAC,IAAI,KAAK,CAAC;oBACrB,MAAM,KAAK,CAAC,CAAC,mEAAmE;aACnF;SACF;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,UAA0B,EAAE,MAAyB;QAChF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;IAClD,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,UAA0B,EAAE,cAA4B;QACnF,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,CAAC;QAC3C,MAAM,QAAQ,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC7G,MAAM,YAAY,GAAmB,EAAE,CAAC;QACxC,KAAK,MAAM,EAAE,IAAI,UAAU,EAAE;YAC3B,IAAI;gBACF,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;aAC7D;YAAC,OAAO,KAAK,EAAE;gBACd,IAAI,UAAU,CAAC,IAAI,KAAK,CAAC;oBACvB,MAAM,KAAK,CAAC,CAAC,qEAAqE;aACrF;SACF;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,UAA0B,EAAE,UAA+C,EAAE,OAA4B;QACrI,MAAM,KAAK,GAAqB,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9D,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;YAClC,IAAI,mBAAI,CAAC,MAAM,CAAC,UAAU,CAAC;gBACzB,KAAK,CAAC,EAAE,GAAG,UAAU,CAAC;;gBAEtB,KAAK,CAAC,cAAc,GAAG,UAAU,CAAC;SACrC;aAAM;YACL,KAAK,CAAC,IAAI,GAAG,kBAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;SACxC;QAED,MAAM,QAAQ,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC7G,OAAO,QAAQ,CAAC,QAAQ,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACrD,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,UAA0B,EAAE,OAAoC;QAC9F,MAAM,MAAM,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC3G,OAAO,IAAA,2CAAyB,EAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,UAA0B,EAAE,MAAyB;QAClF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QAC1D,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;QACvD,OAAO,GAAG,CAAC;IACb,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,UAA0B,EAAE,MAAyB;QAC/E,MAAM,QAAQ,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC7G,MAAM,GAAG,GAAG,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC5C,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC;IAClB,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,UAA0B,EAAE,aAAqB;QAC9E,MAAM,QAAQ,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC7G,MAAM,UAAU,GAAa,EAAE,CAAC;QAChC,OAAO,IAAI,EAAE;YACX,MAAM,aAAa,GAAmB,QAAQ,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;YAC1E,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAC/B,IAAI,CAAC,aAAa,CAAC,WAAW,IAAI,aAAa,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC;gBACtE,MAAM;YAER,aAAa,GAAG,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;SAC9C;QACD,OAAO,UAAU,CAAC;IACpB,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,UAA0B;QACrD,MAAM,SAAS,GAAU,EAAE,CAAC;QAC5B,MAAM,QAAQ,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC7G,QAAQ,CAAC,qBAAqB,CAAC,uEAAuE,EAAE,CAAC,SAAS,EAAE,EAAE;YACpH,KAAK,MAAM,GAAG,IAAI,SAAS;gBACzB,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;QACnG,CAAC,CAAC,CAAC;QACH,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,UAA0B,EAAE,gBAAwB,EAAE,OAA4B;QAC9G,MAAM,QAAQ,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC7G,OAAO,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,UAA0B;QAClD,MAAM,QAAQ,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC7G,OAAO,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;IACzC,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,UAA0B,EAAE,SAAiB,EAAE,KAAuB;QAC7F,MAAM,QAAQ,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC7G,OAAO,QAAQ,CAAC,WAAW,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAChD,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,UAA0B,EAAE,SAAiB;QACnE,MAAM,QAAQ,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC7G,OAAO,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IACxC,CAAC;IAEM,KAAK,CAAC,sBAAsB,CAAC,UAA0B,EAAE,KAAsC;QACpG,MAAM,QAAQ,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC7G,OAAO,QAAQ,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAChD,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,UAA0B,EAAE,KAAiC;QAC1F,MAAM,QAAQ,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC7G,OAAO,QAAQ,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,UAA0B,EAAE,EAAU;QACnE,MAAM,QAAQ,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC7G,MAAM,EAAE,GAAG,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QAC5C,OAAO,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,iBAAiB,EAAE,CAAC;IAC1D,CAAC;IAED,qHAAqH;IAC9G,KAAK,CAAC,gBAAgB,CAAC,UAA0B,EAAE,MAAc;QACtE,MAAM,QAAQ,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC7G,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QACtD,IAAI,SAAS,KAAK,SAAS,IAAI,CAAC,KAAK,SAAS,CAAC,KAAK,CAAC,MAAM;YACzD,MAAM,IAAI,4BAAc,EAAE,CAAC;QAE7B,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,CAAC,4DAA4D;QACrH,IAAI,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,+BAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,+BAAiB,CAAC,GAAG,EAAE,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAI,0CAA0C;QAC/N,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,iDAAiD;QAC/E,OAAO,GAAG,CAAC;IACb,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,UAA0B;QACtD,MAAM,QAAQ,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC7G,MAAM,IAAI,GAAG,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC;QAC5D,MAAM,IAAI,GAAG,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QAClD,IAAI,SAAS,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM;YACzC,OAAO,mBAAI,CAAC,OAAO,CAAC;QAEtB,MAAM,IAAI,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC1C,OAAO,mBAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/C,CAAC;IACM,KAAK,CAAC,oBAAoB,CAAC,UAA0B,EAAE,YAAoB;QAChF,MAAM,QAAQ,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC7G,MAAM,UAAU,GAAoB,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAkB,oBAAM,CAAC,YAAY,CAAC,CAAC;QACnG,OAAO,0BAAe,CAAC,qBAAqB,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC;IACtF,CAAC;IAEM,KAAK,CAAC,sCAAsC,CAAC,UAA0B,EAAE,KAAoC;QAClH,MAAM,QAAQ,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC7G,OAAO,QAAQ,CAAC,sCAAsC,CAAC,KAAK,CAAC,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,sCAAsC,CAAC,UAA0B,EAAE,KAAiC;QAC/G,MAAM,QAAQ,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAC7G,OAAO,QAAQ,CAAC,sCAAsC,CAAC,KAAK,CAAC,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,UAA0B,EAAE,gBAAkC;QAC1F,MAAM,EAAE,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QACvG,OAAO,EAAE,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;IAC/C,CAAC;CACF;AAhND,8CAgNC","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 { GuidString, Id64, Id64String, IModelStatus } from \"@itwin/core-bentley\";\r\nimport {\r\n  Code, CodeProps, DbBlobRequest, DbBlobResponse, DbQueryRequest, DbQueryResponse, ElementLoadOptions, ElementLoadProps, ElementProps, EntityMetaData,\r\n  EntityQueryParams, FontMapProps, GeoCoordinatesRequestProps, GeoCoordinatesResponseProps, GeometryContainmentRequestProps,\r\n  GeometryContainmentResponseProps, GeometrySummaryRequestProps, ImageSourceFormat, IModel, IModelConnectionProps, IModelCoordinatesRequestProps,\r\n  IModelCoordinatesResponseProps, IModelError, IModelReadRpcInterface, IModelRpcOpenProps, IModelRpcProps, MassPropertiesRequestProps,\r\n  MassPropertiesResponseProps, ModelProps, NoContentError, RpcInterface, RpcManager, SnapRequestProps, SnapResponseProps, SyncMode,\r\n  TextureData, TextureLoadProps, ViewStateLoadProps, ViewStateProps,\r\n} from \"@itwin/core-common\";\r\nimport { Range3d, Range3dProps } from \"@itwin/core-geometry\";\r\nimport { SpatialCategory } from \"../Category\";\r\nimport { ConcurrentQuery } from \"../ConcurrentQuery\";\r\nimport { generateGeometrySummaries } from \"../GeometrySummary\";\r\nimport { DictionaryModel } from \"../Model\";\r\nimport { RpcBriefcaseUtility } from \"./RpcBriefcaseUtility\";\r\nimport { RpcTrace } from \"../RpcBackend\";\r\n\r\n/** The backend implementation of IModelReadRpcInterface.\r\n * @internal\r\n */\r\nexport class IModelReadRpcImpl extends RpcInterface implements IModelReadRpcInterface {\r\n\r\n  public static register() { RpcManager.registerImpl(IModelReadRpcInterface, IModelReadRpcImpl); }\r\n\r\n  public async getConnectionProps(tokenProps: IModelRpcOpenProps): Promise<IModelConnectionProps> {\r\n    return RpcBriefcaseUtility.openWithTimeout(RpcTrace.currentActivity!, tokenProps, SyncMode.FixedVersion);\r\n  }\r\n\r\n  public async queryRows(tokenProps: IModelRpcProps, request: DbQueryRequest): Promise<DbQueryResponse> {\r\n    const iModelDb = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    return ConcurrentQuery.executeQueryRequest(iModelDb.nativeDb, request);\r\n  }\r\n  public async queryBlob(tokenProps: IModelRpcProps, request: DbBlobRequest): Promise<DbBlobResponse> {\r\n    const iModelDb = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    return ConcurrentQuery.executeBlobRequest(iModelDb.nativeDb, request);\r\n  }\r\n  public async queryModelRanges(tokenProps: IModelRpcProps, modelIdsList: Id64String[]): Promise<Range3dProps[]> {\r\n    const modelIds = new Set(modelIdsList);\r\n    const iModelDb = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    const ranges: Range3dProps[] = [];\r\n    for (const id of modelIds) {\r\n      try {\r\n        ranges.push(iModelDb.nativeDb.queryModelExtents({ id }).modelExtents);\r\n      } catch (err: any) {\r\n        if ((err as IModelError).errorNumber === IModelStatus.NoGeometry) { // if there was no geometry, just return null range\r\n          ranges.push(new Range3d());\r\n          continue;\r\n        }\r\n\r\n        if (modelIds.size === 1)\r\n          throw err; // if they're asking for more than one model, don't throw on error.\r\n        continue;\r\n      }\r\n    }\r\n    return ranges;\r\n  }\r\n\r\n  public async getModelProps(tokenProps: IModelRpcProps, modelIdsList: Id64String[]): Promise<ModelProps[]> {\r\n    const modelIds = new Set(modelIdsList);\r\n    const iModelDb = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    const modelJsonArray: ModelProps[] = [];\r\n    for (const id of modelIds) {\r\n      try {\r\n        const modelProps = iModelDb.models.getModelJson({ id });\r\n        modelJsonArray.push(modelProps);\r\n      } catch (error) {\r\n        if (modelIds.size === 1)\r\n          throw error; // if they're asking for more than one model, don't throw on error.\r\n      }\r\n    }\r\n    return modelJsonArray;\r\n  }\r\n\r\n  public async queryModelProps(tokenProps: IModelRpcProps, params: EntityQueryParams): Promise<ModelProps[]> {\r\n    const ids = await this.queryEntityIds(tokenProps, params);\r\n    return this.getModelProps(tokenProps, [...ids]);\r\n  }\r\n\r\n  public async getElementProps(tokenProps: IModelRpcProps, elementIdsList: Id64String[]): Promise<ElementProps[]> {\r\n    const elementIds = new Set(elementIdsList);\r\n    const iModelDb = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    const elementProps: ElementProps[] = [];\r\n    for (const id of elementIds) {\r\n      try {\r\n        elementProps.push(iModelDb.elements.getElementJson({ id }));\r\n      } catch (error) {\r\n        if (elementIds.size === 1)\r\n          throw error; // if they're asking for more than one element, don't throw on error.\r\n      }\r\n    }\r\n    return elementProps;\r\n  }\r\n\r\n  public async loadElementProps(tokenProps: IModelRpcProps, identifier: Id64String | GuidString | CodeProps, options?: ElementLoadOptions): Promise<ElementProps | undefined> {\r\n    const props: ElementLoadProps = options ? { ...options } : {};\r\n    if (typeof identifier === \"string\") {\r\n      if (Id64.isId64(identifier))\r\n        props.id = identifier;\r\n      else\r\n        props.federationGuid = identifier;\r\n    } else {\r\n      props.code = Code.fromJSON(identifier);\r\n    }\r\n\r\n    const iModelDb = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    return iModelDb.elements.tryGetElementProps(props);\r\n  }\r\n\r\n  public async getGeometrySummary(tokenProps: IModelRpcProps, request: GeometrySummaryRequestProps): Promise<string> {\r\n    const iModel = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    return generateGeometrySummaries(request, iModel);\r\n  }\r\n\r\n  public async queryElementProps(tokenProps: IModelRpcProps, params: EntityQueryParams): Promise<ElementProps[]> {\r\n    const ids = await this.queryEntityIds(tokenProps, params);\r\n    const res = this.getElementProps(tokenProps, [...ids]);\r\n    return res;\r\n  }\r\n\r\n  public async queryEntityIds(tokenProps: IModelRpcProps, params: EntityQueryParams): Promise<Id64String[]> {\r\n    const iModelDb = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    const res = iModelDb.queryEntityIds(params);\r\n    return [...res];\r\n  }\r\n\r\n  public async getClassHierarchy(tokenProps: IModelRpcProps, classFullName: string): Promise<string[]> {\r\n    const iModelDb = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    const classArray: string[] = [];\r\n    while (true) {\r\n      const classMetaData: EntityMetaData = iModelDb.getMetaData(classFullName);\r\n      classArray.push(classFullName);\r\n      if (!classMetaData.baseClasses || classMetaData.baseClasses.length === 0)\r\n        break;\r\n\r\n      classFullName = classMetaData.baseClasses[0];\r\n    }\r\n    return classArray;\r\n  }\r\n\r\n  public async getAllCodeSpecs(tokenProps: IModelRpcProps): Promise<any[]> {\r\n    const codeSpecs: any[] = [];\r\n    const iModelDb = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    iModelDb.withPreparedStatement(\"SELECT ECInstanceId AS id, name, jsonProperties FROM BisCore.CodeSpec\", (statement) => {\r\n      for (const row of statement)\r\n        codeSpecs.push({ id: row.id, name: row.name, jsonProperties: JSON.parse(row.jsonProperties) });\r\n    });\r\n    return codeSpecs;\r\n  }\r\n\r\n  public async getViewStateData(tokenProps: IModelRpcProps, viewDefinitionId: string, options?: ViewStateLoadProps): Promise<ViewStateProps> {\r\n    const iModelDb = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    return iModelDb.views.getViewStateData(viewDefinitionId, options);\r\n  }\r\n\r\n  public async readFontJson(tokenProps: IModelRpcProps): Promise<FontMapProps> {\r\n    const iModelDb = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    return iModelDb.nativeDb.readFontMap();\r\n  }\r\n\r\n  public async requestSnap(tokenProps: IModelRpcProps, sessionId: string, props: SnapRequestProps): Promise<SnapResponseProps> {\r\n    const iModelDb = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    return iModelDb.requestSnap(sessionId, props);\r\n  }\r\n\r\n  public async cancelSnap(tokenProps: IModelRpcProps, sessionId: string): Promise<void> {\r\n    const iModelDb = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    return iModelDb.cancelSnap(sessionId);\r\n  }\r\n\r\n  public async getGeometryContainment(tokenProps: IModelRpcProps, props: GeometryContainmentRequestProps): Promise<GeometryContainmentResponseProps> {\r\n    const iModelDb = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    return iModelDb.getGeometryContainment(props);\r\n  }\r\n\r\n  public async getMassProperties(tokenProps: IModelRpcProps, props: MassPropertiesRequestProps): Promise<MassPropertiesResponseProps> {\r\n    const iModelDb = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    return iModelDb.getMassProperties(props);\r\n  }\r\n\r\n  public async getToolTipMessage(tokenProps: IModelRpcProps, id: string): Promise<string[]> {\r\n    const iModelDb = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    const el = iModelDb.elements.getElement(id);\r\n    return (el === undefined) ? [] : el.getToolTipMessage();\r\n  }\r\n\r\n  /** Send a view thumbnail to the frontend. This is a binary transfer with the metadata in a 16-byte prefix header. */\r\n  public async getViewThumbnail(tokenProps: IModelRpcProps, viewId: string): Promise<Uint8Array> {\r\n    const iModelDb = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    const thumbnail = iModelDb.views.getThumbnail(viewId);\r\n    if (undefined === thumbnail || 0 === thumbnail.image.length)\r\n      throw new NoContentError();\r\n\r\n    const val = new Uint8Array(thumbnail.image.length + 16); // allocate a new buffer 16 bytes larger than the image size\r\n    new Uint32Array(val.buffer, 0, 4).set([thumbnail.image.length, thumbnail.format === \"jpeg\" ? ImageSourceFormat.Jpeg : ImageSourceFormat.Png, thumbnail.width, thumbnail.height]);    // Put the metadata in the first 16 bytes.\r\n    val.set(thumbnail.image, 16); // put the image data at offset 16 after metadata\r\n    return val;\r\n  }\r\n\r\n  public async getDefaultViewId(tokenProps: IModelRpcProps): Promise<Id64String> {\r\n    const iModelDb = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    const spec = { namespace: \"dgn_View\", name: \"DefaultView\" };\r\n    const blob = iModelDb.queryFilePropertyBlob(spec);\r\n    if (undefined === blob || 8 !== blob.length)\r\n      return Id64.invalid;\r\n\r\n    const view = new Uint32Array(blob.buffer);\r\n    return Id64.fromUint32Pair(view[0], view[1]);\r\n  }\r\n  public async getSpatialCategoryId(tokenProps: IModelRpcProps, categoryName: string): Promise<Id64String | undefined> {\r\n    const iModelDb = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    const dictionary: DictionaryModel = iModelDb.models.getModel<DictionaryModel>(IModel.dictionaryId);\r\n    return SpatialCategory.queryCategoryIdByName(iModelDb, dictionary.id, categoryName);\r\n  }\r\n\r\n  public async getIModelCoordinatesFromGeoCoordinates(tokenProps: IModelRpcProps, props: IModelCoordinatesRequestProps): Promise<IModelCoordinatesResponseProps> {\r\n    const iModelDb = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    return iModelDb.getIModelCoordinatesFromGeoCoordinates(props);\r\n  }\r\n\r\n  public async getGeoCoordinatesFromIModelCoordinates(tokenProps: IModelRpcProps, props: GeoCoordinatesRequestProps): Promise<GeoCoordinatesResponseProps> {\r\n    const iModelDb = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    return iModelDb.getGeoCoordinatesFromIModelCoordinates(props);\r\n  }\r\n\r\n  public async queryTextureData(tokenProps: IModelRpcProps, textureLoadProps: TextureLoadProps): Promise<TextureData | undefined> {\r\n    const db = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    return db.queryTextureData(textureLoadProps);\r\n  }\r\n}\r\n"]}

package/lib/cjs/rpc-impl/IModelTileRpcImpl.d.ts

@@ -0,0 +1,21 @@
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import { Id64Array } from "@itwin/core-bentley";
+import { CloudStorageContainerDescriptor, CloudStorageContainerUrl, ElementGraphicsRequestProps, IModelRpcProps, IModelTileRpcInterface, IModelTileTreeProps, RpcInterface, TileContentIdentifier, TileContentSource, TileTreeContentIds, TileVersionInfo } from "@itwin/core-common";
+/** @internal */
+export declare class IModelTileRpcImpl extends RpcInterface implements IModelTileRpcInterface {
+    static register(): void;
+    requestTileTreeProps(tokenProps: IModelRpcProps, treeId: string): Promise<IModelTileTreeProps>;
+    purgeTileTrees(tokenProps: IModelRpcProps, modelIds: Id64Array | undefined): Promise<void>;
+    generateTileContent(tokenProps: IModelRpcProps, treeId: string, contentId: string, guid: string | undefined): Promise<TileContentSource>;
+    retrieveTileContent(tokenProps: IModelRpcProps, key: TileContentIdentifier): Promise<Uint8Array>;
+    getTileCacheContainerUrl(_tokenProps: IModelRpcProps, id: CloudStorageContainerDescriptor): Promise<CloudStorageContainerUrl>;
+    isUsingExternalTileCache(): Promise<boolean>;
+    queryVersionInfo(): Promise<TileVersionInfo>;
+    /** @internal */
+    requestElementGraphics(rpcProps: IModelRpcProps, request: ElementGraphicsRequestProps): Promise<Uint8Array | undefined>;
+}
+/** @internal */
+export declare function cancelTileContentRequests(tokenProps: IModelRpcProps, contentIds: TileTreeContentIds[]): Promise<void>;
+//# sourceMappingURL=IModelTileRpcImpl.d.ts.map

package/lib/cjs/rpc-impl/IModelTileRpcImpl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModelTileRpcImpl.d.ts","sourceRoot":"","sources":["../../../src/rpc-impl/IModelTileRpcImpl.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAmC,SAAS,EAAU,MAAM,qBAAqB,CAAC;AACzF,OAAO,EACL,+BAA+B,EAAE,wBAAwB,EAAyB,2BAA2B,EAAE,cAAc,EAC7H,sBAAsB,EAAE,mBAAmB,EAAE,YAAY,EAAiD,qBAAqB,EAC/H,iBAAiB,EAAE,kBAAkB,EAAE,eAAe,EACvD,MAAM,oBAAoB,CAAC;AA6K5B,gBAAgB;AAChB,qBAAa,iBAAkB,SAAQ,YAAa,YAAW,sBAAsB;WACrE,QAAQ;IAET,oBAAoB,CAAC,UAAU,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAI9F,cAAc,CAAC,UAAU,EAAE,cAAc,EAAE,QAAQ,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAS1F,mBAAmB,CAAC,UAAU,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIxI,mBAAmB,CAAC,UAAU,EAAE,cAAc,EAAE,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAAC,UAAU,CAAC;IAKhG,wBAAwB,CAAC,WAAW,EAAE,cAAc,EAAE,EAAE,EAAE,+BAA+B,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAY7H,wBAAwB,IAAI,OAAO,CAAC,OAAO,CAAC;IAI5C,gBAAgB,IAAI,OAAO,CAAC,eAAe,CAAC;IAIzD,gBAAgB;IACH,sBAAsB,CAAC,QAAQ,EAAE,cAAc,EAAE,OAAO,EAAE,2BAA2B,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;CAIrI;AAED,gBAAgB;AAChB,wBAAsB,yBAAyB,CAAC,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAa3H"}

package/lib/cjs/rpc-impl/IModelTileRpcImpl.js

@@ -0,0 +1,193 @@
+"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.cancelTileContentRequests = exports.IModelTileRpcImpl = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+const BackendLoggerCategory_1 = require("../BackendLoggerCategory");
+const IModelDb_1 = require("../IModelDb");
+const IModelHost_1 = require("../IModelHost");
+const PromiseMemoizer_1 = require("../PromiseMemoizer");
+const RpcBackend_1 = require("../RpcBackend");
+const RpcBriefcaseUtility_1 = require("./RpcBriefcaseUtility");
+function generateTileRequestKey(props) {
+    var _a;
+    const token = props.tokenProps;
+    return `${JSON.stringify({
+        key: token.key,
+        iTwinId: token.iTwinId,
+        iModelId: token.iModelId,
+        changesetId: (_a = token.changeset) === null || _a === void 0 ? void 0 : _a.id,
+    })}:${props.treeId}`;
+}
+class TileRequestMemoizer extends PromiseMemoizer_1.PromiseMemoizer {
+    constructor(memoizeFn, generateKeyFn) {
+        super(memoizeFn, generateKeyFn);
+        this._loggerCategory = BackendLoggerCategory_1.BackendLoggerCategory.IModelTileRequestRpc;
+        this._superMemoize = this.memoize;
+        this.memoize = (props) => {
+            return this._superMemoize(props);
+        };
+        this._superDeleteMemoized = this.deleteMemoized;
+        this.deleteMemoized = (props) => {
+            this._superDeleteMemoized(props);
+        };
+    }
+    makeMetadata(props) {
+        const meta = { ...props.tokenProps };
+        this.addMetadata(meta, props);
+        return meta;
+    }
+    log(status, props) {
+        const descr = `${this._operationName}(${this.stringify(props)})`;
+        core_bentley_1.Logger.logTrace(this._loggerCategory, `Backend ${status} ${descr}`, () => this.makeMetadata(props));
+    }
+    async perform(props) {
+        this.log("received", props);
+        const tileQP = this.memoize(props);
+        await core_bentley_1.BeDuration.race(this._timeoutMilliseconds, tileQP.promise).catch(() => { });
+        // Note: Rejections must be caught so that the memoization entry can be deleted
+        if (tileQP.isPending) {
+            this.log("issuing pending status for", props);
+            throw new core_common_1.RpcPendingResponse();
+        }
+        this.deleteMemoized(props);
+        if (tileQP.isFulfilled) {
+            this.log("completed", props);
+            return tileQP.result;
+        }
+        (0, core_bentley_1.assert)(tileQP.isRejected);
+        this.log("rejected", props);
+        throw tileQP.error; // eslint-disable-line no-throw-literal
+    }
+}
+async function getTileTreeProps(props) {
+    (0, core_bentley_1.assert)(undefined !== props.accessToken);
+    const db = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(props.accessToken, props.tokenProps);
+    return db.tiles.requestTileTreeProps(props.treeId);
+}
+class RequestTileTreePropsMemoizer extends TileRequestMemoizer {
+    constructor() {
+        super(getTileTreeProps, generateTileRequestKey);
+        IModelHost_1.IModelHost.onBeforeShutdown.addOnce(() => {
+            this.dispose();
+            RequestTileTreePropsMemoizer._instance = undefined;
+        });
+    }
+    get _timeoutMilliseconds() { return IModelHost_1.IModelHost.tileTreeRequestTimeout; }
+    get _operationName() { return "requestTileTreeProps"; }
+    stringify(props) { return props.treeId; }
+    addMetadata(meta, props) {
+        meta.treeId = props.treeId;
+    }
+    static async perform(props) {
+        if (undefined === this._instance)
+            this._instance = new RequestTileTreePropsMemoizer();
+        return this._instance.perform(props);
+    }
+}
+async function getTileContent(props) {
+    (0, core_bentley_1.assert)(undefined !== props.accessToken);
+    const db = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(props.accessToken, props.tokenProps);
+    const tile = await db.tiles.requestTileContent(props.treeId, props.contentId);
+    // ###TODO: Verify the guid supplied by the front-end matches the guid stored in the model?
+    if (IModelHost_1.IModelHost.usingExternalTileCache) {
+        await IModelHost_1.IModelHost.tileUploader.cacheTile(props.tokenProps, props.treeId, props.contentId, tile.content, props.guid, {
+            backendName: IModelHost_1.IModelHost.applicationId,
+            tileGenerationTime: tile.elapsedSeconds.toString(),
+            tileSize: tile.content.byteLength.toString(),
+        });
+        return core_common_1.TileContentSource.ExternalCache;
+    }
+    return core_common_1.TileContentSource.Backend;
+}
+function generateTileContentKey(props) {
+    return `${generateTileRequestKey(props)}:${props.contentId}`;
+}
+class RequestTileContentMemoizer extends TileRequestMemoizer {
+    constructor() {
+        super(getTileContent, generateTileContentKey);
+        IModelHost_1.IModelHost.onBeforeShutdown.addOnce(() => {
+            this.dispose();
+            RequestTileContentMemoizer._instance = undefined;
+        });
+    }
+    get _timeoutMilliseconds() { return IModelHost_1.IModelHost.tileContentRequestTimeout; }
+    get _operationName() { return "requestTileContent"; }
+    stringify(props) { return `${props.treeId}:${props.contentId}`; }
+    addMetadata(meta, props) {
+        meta.treeId = props.treeId;
+        meta.contentId = props.contentId;
+    }
+    static get instance() {
+        if (undefined === this._instance)
+            this._instance = new RequestTileContentMemoizer();
+        return this._instance;
+    }
+    static async perform(props) {
+        return this.instance.perform(props);
+    }
+}
+/** @internal */
+class IModelTileRpcImpl extends core_common_1.RpcInterface {
+    static register() { core_common_1.RpcManager.registerImpl(core_common_1.IModelTileRpcInterface, IModelTileRpcImpl); }
+    async requestTileTreeProps(tokenProps, treeId) {
+        return RequestTileTreePropsMemoizer.perform({ accessToken: RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps, treeId });
+    }
+    async purgeTileTrees(tokenProps, modelIds) {
+        // `undefined` gets forwarded as `null`...
+        if (null === modelIds)
+            modelIds = undefined;
+        const db = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        return db.nativeDb.purgeTileTrees(modelIds);
+    }
+    async generateTileContent(tokenProps, treeId, contentId, guid) {
+        return RequestTileContentMemoizer.perform({ accessToken: RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps, treeId, contentId, guid });
+    }
+    async retrieveTileContent(tokenProps, key) {
+        const db = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, tokenProps);
+        return db.tiles.getTileContent(key.treeId, key.contentId);
+    }
+    async getTileCacheContainerUrl(_tokenProps, id) {
+        const invocation = core_common_1.RpcInvocation.current(this);
+        if (!IModelHost_1.IModelHost.usingExternalTileCache) {
+            return core_common_1.CloudStorageContainerUrl.empty();
+        }
+        const expiry = core_common_1.CloudStorageTileCache.getCache().supplyExpiryForContainerUrl(id);
+        const clientIp = (IModelHost_1.IModelHost.restrictTileUrlsByClientIp && invocation.request.ip) ? invocation.request.ip : undefined;
+        return IModelHost_1.IModelHost.tileCacheService.obtainContainerUrl(id, expiry, clientIp);
+    }
+    async isUsingExternalTileCache() {
+        return IModelHost_1.IModelHost.usingExternalTileCache;
+    }
+    async queryVersionInfo() {
+        return IModelHost_1.IModelHost.platform.getTileVersionInfo();
+    }
+    /** @internal */
+    async requestElementGraphics(rpcProps, request) {
+        const iModel = await RpcBriefcaseUtility_1.RpcBriefcaseUtility.findOpenIModel(RpcBackend_1.RpcTrace.currentActivity.accessToken, rpcProps);
+        return iModel.generateElementGraphics(request);
+    }
+}
+exports.IModelTileRpcImpl = IModelTileRpcImpl;
+/** @internal */
+async function cancelTileContentRequests(tokenProps, contentIds) {
+    const iModel = IModelDb_1.IModelDb.findByKey(tokenProps.key);
+    const props = { tokenProps, treeId: "", contentId: "" };
+    for (const entry of contentIds) {
+        props.treeId = entry.treeId;
+        for (const contentId of entry.contentIds) {
+            props.contentId = contentId;
+            RequestTileContentMemoizer.instance.deleteMemoized(props);
+        }
+        iModel.nativeDb.cancelTileContentRequests(entry.treeId, entry.contentIds);
+    }
+}
+exports.cancelTileContentRequests = cancelTileContentRequests;
+//# sourceMappingURL=IModelTileRpcImpl.js.map

package/lib/cjs/rpc-impl/IModelTileRpcImpl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IModelTileRpcImpl.js","sourceRoot":"","sources":["../../../src/rpc-impl/IModelTileRpcImpl.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAyF;AACzF,oDAI4B;AAC5B,oEAAiE;AACjE,0CAAuC;AACvC,8CAA2C;AAC3C,wDAAuE;AACvE,8CAAyC;AACzC,+DAA4D;AAQ5D,SAAS,sBAAsB,CAAC,KAAuB;;IACrD,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC;IAC/B,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC;QACvB,GAAG,EAAE,KAAK,CAAC,GAAG;QACd,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,WAAW,EAAE,MAAA,KAAK,CAAC,SAAS,0CAAE,EAAE;KACjC,CAAC,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;AACvB,CAAC;AAED,MAAe,mBAA4D,SAAQ,iCAAuB;IAaxG,YAAsB,SAA4C,EAAE,aAAuC;QACzG,KAAK,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QAbjB,oBAAe,GAAG,6CAAqB,CAAC,oBAAoB,CAAC;QAgBtE,kBAAa,GAAG,IAAI,CAAC,OAAO,CAAC;QACrB,YAAO,GAAG,CAAC,KAAY,EAA4B,EAAE;YACnE,OAAO,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QACnC,CAAC,CAAC;QAEM,yBAAoB,GAAG,IAAI,CAAC,cAAc,CAAC;QACnC,mBAAc,GAAG,CAAC,KAAY,EAAE,EAAE;YAChD,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;QACnC,CAAC,CAAC;IAVF,CAAC;IARO,YAAY,CAAC,KAAY;QAC/B,MAAM,IAAI,GAAG,EAAE,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC;QACrC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IAgBO,GAAG,CAAC,MAAc,EAAE,KAAY;QACtC,MAAM,KAAK,GAAG,GAAG,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC;QACjE,qBAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,eAAe,EAAE,WAAW,MAAM,IAAI,KAAK,EAAE,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;IACtG,CAAC;IAES,KAAK,CAAC,OAAO,CAAC,KAAY;QAClC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;QAE5B,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAEnC,MAAM,yBAAU,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;QAClF,+EAA+E;QAE/E,IAAI,MAAM,CAAC,SAAS,EAAE;YACpB,IAAI,CAAC,GAAG,CAAC,4BAA4B,EAAE,KAAK,CAAC,CAAC;YAC9C,MAAM,IAAI,gCAAkB,EAAE,CAAC;SAChC;QAED,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAE3B,IAAI,MAAM,CAAC,WAAW,EAAE;YACtB,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;YAC7B,OAAO,MAAM,CAAC,MAAO,CAAC;SACvB;QAED,IAAA,qBAAM,EAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAC1B,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;QAC5B,MAAM,MAAM,CAAC,KAAK,CAAC,CAAC,uCAAuC;IAC7D,CAAC;CACF;AAED,KAAK,UAAU,gBAAgB,CAAC,KAAuB;IACrD,IAAA,qBAAM,EAAC,SAAS,KAAK,KAAK,CAAC,WAAW,CAAC,CAAC;IACxC,MAAM,EAAE,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IACzF,OAAO,EAAE,CAAC,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,4BAA6B,SAAQ,mBAA0D;IAUnG;QACE,KAAK,CAAC,gBAAgB,EAAE,sBAAsB,CAAC,CAAC;QAChD,uBAAU,CAAC,gBAAgB,CAAC,OAAO,CAAC,GAAG,EAAE;YACvC,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,4BAA4B,CAAC,SAAS,GAAG,SAAS,CAAC;QACrD,CAAC,CAAC,CAAC;IACL,CAAC;IAfD,IAAc,oBAAoB,KAAK,OAAO,uBAAU,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAClF,IAAc,cAAc,KAAK,OAAO,sBAAsB,CAAC,CAAC,CAAC;IACvD,SAAS,CAAC,KAAuB,IAAY,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACnE,WAAW,CAAC,IAAS,EAAE,KAAuB;QACtD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;IAC7B,CAAC;IAYM,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,KAAuB;QACjD,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,IAAI,CAAC,SAAS,GAAG,IAAI,4BAA4B,EAAE,CAAC;QAEtD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC;CACF;AAOD,KAAK,UAAU,cAAc,CAAC,KAA8B;IAC1D,IAAA,qBAAM,EAAC,SAAS,KAAK,KAAK,CAAC,WAAW,CAAC,CAAC;IACxC,MAAM,EAAE,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IACzF,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,KAAK,CAAC,kBAAkB,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAE9E,2FAA2F;IAC3F,IAAI,uBAAU,CAAC,sBAAsB,EAAE;QACrC,MAAM,uBAAU,CAAC,YAAY,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,EAAE;YACjH,WAAW,EAAE,uBAAU,CAAC,aAAa;YACrC,kBAAkB,EAAE,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE;YAClD,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,EAAE;SAC7C,CAAC,CAAC;QAEH,OAAO,+BAAiB,CAAC,aAAa,CAAC;KACxC;IAED,OAAO,+BAAiB,CAAC,OAAO,CAAC;AACnC,CAAC;AAED,SAAS,sBAAsB,CAAC,KAA8B;IAC5D,OAAO,GAAG,sBAAsB,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;AAC/D,CAAC;AAED,MAAM,0BAA2B,SAAQ,mBAA+D;IAWtG;QACE,KAAK,CAAC,cAAc,EAAE,sBAAsB,CAAC,CAAC;QAC9C,uBAAU,CAAC,gBAAgB,CAAC,OAAO,CAAC,GAAG,EAAE;YACvC,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,0BAA0B,CAAC,SAAS,GAAG,SAAS,CAAC;QACnD,CAAC,CAAC,CAAC;IACL,CAAC;IAhBD,IAAc,oBAAoB,KAAK,OAAO,uBAAU,CAAC,yBAAyB,CAAC,CAAC,CAAC;IACrF,IAAc,cAAc,KAAK,OAAO,oBAAoB,CAAC,CAAC,CAAC;IACrD,SAAS,CAAC,KAA8B,IAAY,OAAO,GAAG,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;IAClG,WAAW,CAAC,IAAS,EAAE,KAA8B;QAC7D,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;IACnC,CAAC;IAYM,MAAM,KAAK,QAAQ;QACxB,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS;YAC9B,IAAI,CAAC,SAAS,GAAG,IAAI,0BAA0B,EAAE,CAAC;QAEpD,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,KAA8B;QACxD,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;CACF;AAED,gBAAgB;AAChB,MAAa,iBAAkB,SAAQ,0BAAY;IAC1C,MAAM,CAAC,QAAQ,KAAK,wBAAU,CAAC,YAAY,CAAC,oCAAsB,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAEzF,KAAK,CAAC,oBAAoB,CAAC,UAA0B,EAAE,MAAc;QAC1E,OAAO,4BAA4B,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAC;IAC1H,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,UAA0B,EAAE,QAA+B;QACrF,0CAA0C;QAC1C,IAAI,IAAI,KAAK,QAAQ;YACnB,QAAQ,GAAG,SAAS,CAAC;QAEvB,MAAM,EAAE,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QACvG,OAAO,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC9C,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,UAA0B,EAAE,MAAc,EAAE,SAAiB,EAAE,IAAwB;QACtH,OAAO,0BAA0B,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACzI,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,UAA0B,EAAE,GAA0B;QACrF,MAAM,EAAE,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QACvG,OAAO,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC;IAC5D,CAAC;IAEM,KAAK,CAAC,wBAAwB,CAAC,WAA2B,EAAE,EAAmC;QACpG,MAAM,UAAU,GAAG,2BAAa,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAE/C,IAAI,CAAC,uBAAU,CAAC,sBAAsB,EAAE;YACtC,OAAO,sCAAwB,CAAC,KAAK,EAAE,CAAC;SACzC;QAED,MAAM,MAAM,GAAG,mCAAqB,CAAC,QAAQ,EAAE,CAAC,2BAA2B,CAAC,EAAE,CAAC,CAAC;QAChF,MAAM,QAAQ,GAAG,CAAC,uBAAU,CAAC,0BAA0B,IAAI,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACtH,OAAO,uBAAU,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC9E,CAAC;IAEM,KAAK,CAAC,wBAAwB;QACnC,OAAO,uBAAU,CAAC,sBAAsB,CAAC;IAC3C,CAAC;IAEM,KAAK,CAAC,gBAAgB;QAC3B,OAAO,uBAAU,CAAC,QAAQ,CAAC,kBAAkB,EAAE,CAAC;IAClD,CAAC;IAED,gBAAgB;IACT,KAAK,CAAC,sBAAsB,CAAC,QAAwB,EAAE,OAAoC;QAChG,MAAM,MAAM,GAAG,MAAM,yCAAmB,CAAC,cAAc,CAAC,qBAAQ,CAAC,eAAgB,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QACzG,OAAO,MAAM,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;IACjD,CAAC;CACF;AAlDD,8CAkDC;AAED,gBAAgB;AACT,KAAK,UAAU,yBAAyB,CAAC,UAA0B,EAAE,UAAgC;IAC1G,MAAM,MAAM,GAAG,mBAAQ,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAClD,MAAM,KAAK,GAA4B,EAAE,UAAU,EAAE,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;IAEjF,KAAK,MAAM,KAAK,IAAI,UAAU,EAAE;QAC9B,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC5B,KAAK,MAAM,SAAS,IAAI,KAAK,CAAC,UAAU,EAAE;YACxC,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;YAC5B,0BAA0B,CAAC,QAAQ,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;SAC3D;QAED,MAAM,CAAC,QAAQ,CAAC,yBAAyB,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;KAC3E;AACH,CAAC;AAbD,8DAaC","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 { AccessToken, assert, BeDuration, Id64Array, Logger } from \"@itwin/core-bentley\";\r\nimport {\r\n  CloudStorageContainerDescriptor, CloudStorageContainerUrl, CloudStorageTileCache, ElementGraphicsRequestProps, IModelRpcProps,\r\n  IModelTileRpcInterface, IModelTileTreeProps, RpcInterface, RpcInvocation, RpcManager, RpcPendingResponse, TileContentIdentifier,\r\n  TileContentSource, TileTreeContentIds, TileVersionInfo,\r\n} from \"@itwin/core-common\";\r\nimport { BackendLoggerCategory } from \"../BackendLoggerCategory\";\r\nimport { IModelDb } from \"../IModelDb\";\r\nimport { IModelHost } from \"../IModelHost\";\r\nimport { PromiseMemoizer, QueryablePromise } from \"../PromiseMemoizer\";\r\nimport { RpcTrace } from \"../RpcBackend\";\r\nimport { RpcBriefcaseUtility } from \"./RpcBriefcaseUtility\";\r\n\r\ninterface TileRequestProps {\r\n  accessToken?: AccessToken;\r\n  tokenProps: IModelRpcProps;\r\n  treeId: string;\r\n}\r\n\r\nfunction generateTileRequestKey(props: TileRequestProps): string {\r\n  const token = props.tokenProps;\r\n  return `${JSON.stringify({\r\n    key: token.key,\r\n    iTwinId: token.iTwinId,\r\n    iModelId: token.iModelId,\r\n    changesetId: token.changeset?.id,\r\n  })}:${props.treeId}`;\r\n}\r\n\r\nabstract class TileRequestMemoizer<Result, Props extends TileRequestProps> extends PromiseMemoizer<Result> {\r\n  private readonly _loggerCategory = BackendLoggerCategory.IModelTileRequestRpc;\r\n  protected abstract get _operationName(): string;\r\n  protected abstract addMetadata(metadata: any, props: Props): void;\r\n  protected abstract stringify(props: Props): string;\r\n  protected abstract get _timeoutMilliseconds(): number;\r\n\r\n  private makeMetadata(props: Props): any {\r\n    const meta = { ...props.tokenProps };\r\n    this.addMetadata(meta, props);\r\n    return meta;\r\n  }\r\n\r\n  protected constructor(memoizeFn: (props: Props) => Promise<Result>, generateKeyFn: (props: Props) => string) {\r\n    super(memoizeFn, generateKeyFn);\r\n  }\r\n\r\n  private _superMemoize = this.memoize;\r\n  public override memoize = (props: Props): QueryablePromise<Result> => {\r\n    return this._superMemoize(props);\r\n  };\r\n\r\n  private _superDeleteMemoized = this.deleteMemoized;\r\n  public override deleteMemoized = (props: Props) => {\r\n    this._superDeleteMemoized(props);\r\n  };\r\n\r\n  private log(status: string, props: Props): void {\r\n    const descr = `${this._operationName}(${this.stringify(props)})`;\r\n    Logger.logTrace(this._loggerCategory, `Backend ${status} ${descr}`, () => this.makeMetadata(props));\r\n  }\r\n\r\n  protected async perform(props: Props): Promise<Result> {\r\n    this.log(\"received\", props);\r\n\r\n    const tileQP = this.memoize(props);\r\n\r\n    await BeDuration.race(this._timeoutMilliseconds, tileQP.promise).catch(() => { });\r\n    // Note: Rejections must be caught so that the memoization entry can be deleted\r\n\r\n    if (tileQP.isPending) {\r\n      this.log(\"issuing pending status for\", props);\r\n      throw new RpcPendingResponse();\r\n    }\r\n\r\n    this.deleteMemoized(props);\r\n\r\n    if (tileQP.isFulfilled) {\r\n      this.log(\"completed\", props);\r\n      return tileQP.result!;\r\n    }\r\n\r\n    assert(tileQP.isRejected);\r\n    this.log(\"rejected\", props);\r\n    throw tileQP.error; // eslint-disable-line no-throw-literal\r\n  }\r\n}\r\n\r\nasync function getTileTreeProps(props: TileRequestProps): Promise<IModelTileTreeProps> {\r\n  assert(undefined !== props.accessToken);\r\n  const db = await RpcBriefcaseUtility.findOpenIModel(props.accessToken, props.tokenProps);\r\n  return db.tiles.requestTileTreeProps(props.treeId);\r\n}\r\n\r\nclass RequestTileTreePropsMemoizer extends TileRequestMemoizer<IModelTileTreeProps, TileRequestProps> {\r\n  protected get _timeoutMilliseconds() { return IModelHost.tileTreeRequestTimeout; }\r\n  protected get _operationName() { return \"requestTileTreeProps\"; }\r\n  protected stringify(props: TileRequestProps): string { return props.treeId; }\r\n  protected addMetadata(meta: any, props: TileRequestProps): void {\r\n    meta.treeId = props.treeId;\r\n  }\r\n\r\n  private static _instance?: RequestTileTreePropsMemoizer;\r\n\r\n  private constructor() {\r\n    super(getTileTreeProps, generateTileRequestKey);\r\n    IModelHost.onBeforeShutdown.addOnce(() => {\r\n      this.dispose();\r\n      RequestTileTreePropsMemoizer._instance = undefined;\r\n    });\r\n  }\r\n\r\n  public static async perform(props: TileRequestProps): Promise<IModelTileTreeProps> {\r\n    if (undefined === this._instance)\r\n      this._instance = new RequestTileTreePropsMemoizer();\r\n\r\n    return this._instance.perform(props);\r\n  }\r\n}\r\n\r\ninterface TileContentRequestProps extends TileRequestProps {\r\n  contentId: string;\r\n  guid?: string;\r\n}\r\n\r\nasync function getTileContent(props: TileContentRequestProps): Promise<TileContentSource> {\r\n  assert(undefined !== props.accessToken);\r\n  const db = await RpcBriefcaseUtility.findOpenIModel(props.accessToken, props.tokenProps);\r\n  const tile = await db.tiles.requestTileContent(props.treeId, props.contentId);\r\n\r\n  // ###TODO: Verify the guid supplied by the front-end matches the guid stored in the model?\r\n  if (IModelHost.usingExternalTileCache) {\r\n    await IModelHost.tileUploader.cacheTile(props.tokenProps, props.treeId, props.contentId, tile.content, props.guid, {\r\n      backendName: IModelHost.applicationId,\r\n      tileGenerationTime: tile.elapsedSeconds.toString(),\r\n      tileSize: tile.content.byteLength.toString(),\r\n    });\r\n\r\n    return TileContentSource.ExternalCache;\r\n  }\r\n\r\n  return TileContentSource.Backend;\r\n}\r\n\r\nfunction generateTileContentKey(props: TileContentRequestProps): string {\r\n  return `${generateTileRequestKey(props)}:${props.contentId}`;\r\n}\r\n\r\nclass RequestTileContentMemoizer extends TileRequestMemoizer<TileContentSource, TileContentRequestProps> {\r\n  protected get _timeoutMilliseconds() { return IModelHost.tileContentRequestTimeout; }\r\n  protected get _operationName() { return \"requestTileContent\"; }\r\n  protected stringify(props: TileContentRequestProps): string { return `${props.treeId}:${props.contentId}`; }\r\n  protected addMetadata(meta: any, props: TileContentRequestProps): void {\r\n    meta.treeId = props.treeId;\r\n    meta.contentId = props.contentId;\r\n  }\r\n\r\n  private static _instance?: RequestTileContentMemoizer;\r\n\r\n  private constructor() {\r\n    super(getTileContent, generateTileContentKey);\r\n    IModelHost.onBeforeShutdown.addOnce(() => {\r\n      this.dispose();\r\n      RequestTileContentMemoizer._instance = undefined;\r\n    });\r\n  }\r\n\r\n  public static get instance() {\r\n    if (undefined === this._instance)\r\n      this._instance = new RequestTileContentMemoizer();\r\n\r\n    return this._instance;\r\n  }\r\n\r\n  public static async perform(props: TileContentRequestProps): Promise<TileContentSource> {\r\n    return this.instance.perform(props);\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport class IModelTileRpcImpl extends RpcInterface implements IModelTileRpcInterface {\r\n  public static register() { RpcManager.registerImpl(IModelTileRpcInterface, IModelTileRpcImpl); }\r\n\r\n  public async requestTileTreeProps(tokenProps: IModelRpcProps, treeId: string): Promise<IModelTileTreeProps> {\r\n    return RequestTileTreePropsMemoizer.perform({ accessToken: RpcTrace.currentActivity!.accessToken, tokenProps, treeId });\r\n  }\r\n\r\n  public async purgeTileTrees(tokenProps: IModelRpcProps, modelIds: Id64Array | undefined): Promise<void> {\r\n    // `undefined` gets forwarded as `null`...\r\n    if (null === modelIds)\r\n      modelIds = undefined;\r\n\r\n    const db = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    return db.nativeDb.purgeTileTrees(modelIds);\r\n  }\r\n\r\n  public async generateTileContent(tokenProps: IModelRpcProps, treeId: string, contentId: string, guid: string | undefined): Promise<TileContentSource> {\r\n    return RequestTileContentMemoizer.perform({ accessToken: RpcTrace.currentActivity!.accessToken, tokenProps, treeId, contentId, guid });\r\n  }\r\n\r\n  public async retrieveTileContent(tokenProps: IModelRpcProps, key: TileContentIdentifier): Promise<Uint8Array> {\r\n    const db = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, tokenProps);\r\n    return db.tiles.getTileContent(key.treeId, key.contentId);\r\n  }\r\n\r\n  public async getTileCacheContainerUrl(_tokenProps: IModelRpcProps, id: CloudStorageContainerDescriptor): Promise<CloudStorageContainerUrl> {\r\n    const invocation = RpcInvocation.current(this);\r\n\r\n    if (!IModelHost.usingExternalTileCache) {\r\n      return CloudStorageContainerUrl.empty();\r\n    }\r\n\r\n    const expiry = CloudStorageTileCache.getCache().supplyExpiryForContainerUrl(id);\r\n    const clientIp = (IModelHost.restrictTileUrlsByClientIp && invocation.request.ip) ? invocation.request.ip : undefined;\r\n    return IModelHost.tileCacheService.obtainContainerUrl(id, expiry, clientIp);\r\n  }\r\n\r\n  public async isUsingExternalTileCache(): Promise<boolean> { // eslint-disable-line @itwin/prefer-get\r\n    return IModelHost.usingExternalTileCache;\r\n  }\r\n\r\n  public async queryVersionInfo(): Promise<TileVersionInfo> {\r\n    return IModelHost.platform.getTileVersionInfo();\r\n  }\r\n\r\n  /** @internal */\r\n  public async requestElementGraphics(rpcProps: IModelRpcProps, request: ElementGraphicsRequestProps): Promise<Uint8Array | undefined> {\r\n    const iModel = await RpcBriefcaseUtility.findOpenIModel(RpcTrace.currentActivity!.accessToken, rpcProps);\r\n    return iModel.generateElementGraphics(request);\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport async function cancelTileContentRequests(tokenProps: IModelRpcProps, contentIds: TileTreeContentIds[]): Promise<void> {\r\n  const iModel = IModelDb.findByKey(tokenProps.key);\r\n  const props: TileContentRequestProps = { tokenProps, treeId: \"\", contentId: \"\" };\r\n\r\n  for (const entry of contentIds) {\r\n    props.treeId = entry.treeId;\r\n    for (const contentId of entry.contentIds) {\r\n      props.contentId = contentId;\r\n      RequestTileContentMemoizer.instance.deleteMemoized(props);\r\n    }\r\n\r\n    iModel.nativeDb.cancelTileContentRequests(entry.treeId, entry.contentIds);\r\n  }\r\n}\r\n"]}

package/lib/cjs/rpc-impl/RpcBriefcaseUtility.d.ts

@@ -0,0 +1,37 @@
+/** @packageDocumentation
+ * @module RpcInterface
+ */
+import { AccessToken } from "@itwin/core-bentley";
+import { BriefcaseProps, IModelConnectionProps, IModelRpcOpenProps, IModelRpcProps, RpcActivity, SyncMode } from "@itwin/core-common";
+import { IModelDb } from "../IModelDb";
+/** @internal */
+export interface DownloadAndOpenArgs {
+    activity: RpcActivity;
+    tokenProps: IModelRpcOpenProps;
+    syncMode: SyncMode;
+    fileNameResolvers?: ((arg: BriefcaseProps) => string)[];
+    timeout?: number;
+    forceDownload?: boolean;
+}
+/**
+ * Utility to open the iModel for Read/Write RPC interfaces
+ * @internal
+ */
+export declare class RpcBriefcaseUtility {
+    private static downloadAndOpen;
+    private static _briefcasePromise;
+    private static openBriefcase;
+    /** find a previously opened iModel for RPC.
+     * @param accessToken necessary (only) for V2 checkpoints to refresh access token in daemon if it has expired. We use the accessToken of the current RPC request
+     * to refresh the daemon, even though it will be used for all authorized users.
+     * @param the IModelRpcProps to locate the opened iModel.
+     */
+    static findOpenIModel(accessToken: AccessToken, iModel: IModelRpcProps): Promise<IModelDb>;
+    /**
+     * Download and open a checkpoint or briefcase, ensuring the operation completes within a default timeout. If the time to open exceeds the timeout period,
+     * a RpcPendingResponse exception is thrown
+     */
+    static open(args: DownloadAndOpenArgs): Promise<IModelDb>;
+    static openWithTimeout(activity: RpcActivity, tokenProps: IModelRpcOpenProps, syncMode: SyncMode, timeout?: number): Promise<IModelConnectionProps>;
+}
+//# sourceMappingURL=RpcBriefcaseUtility.d.ts.map

package/lib/cjs/rpc-impl/RpcBriefcaseUtility.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RpcBriefcaseUtility.d.ts","sourceRoot":"","sources":["../../../src/rpc-impl/RpcBriefcaseUtility.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAoC,MAAM,qBAAqB,CAAC;AACpF,OAAO,EACL,cAAc,EAAE,qBAAqB,EAAe,kBAAkB,EAAE,cAAc,EAAiB,WAAW,EAAsB,QAAQ,EACjJ,MAAM,oBAAoB,CAAC;AAI5B,OAAO,EAAe,QAAQ,EAAc,MAAM,aAAa,CAAC;AAMhE,gBAAgB;AAChB,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,WAAW,CAAC;IACtB,UAAU,EAAE,kBAAkB,CAAC;IAC/B,QAAQ,EAAE,QAAQ,CAAC;IACnB,iBAAiB,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,cAAc,KAAK,MAAM,CAAC,EAAE,CAAC;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AACD;;;GAGG;AACH,qBAAa,mBAAmB;mBAET,eAAe;IAuDpC,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAmC;mBAC9C,aAAa;IAYlC;;;;OAIG;WACiB,cAAc,CAAC,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc;IAUnF;;;OAGG;WACiB,IAAI,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,QAAQ,CAAC;WA2DlD,eAAe,CAAC,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,kBAAkB,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,GAAE,MAAa,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAIvK"}