@itwin/core-frontend 3.0.0-dev.102 → 3.0.0-dev.106

package/lib/esm/tile/RealityModelTileTree.js

@@ -5,17 +5,15 @@
 /** @packageDocumentation
  * @module Utils
  */
-import { getJson, request } from "@bentley/itwin-client";
-import { assert, BentleyStatus, compareNumbers, compareStringsOrUndefined, CompressedId64Set, } from "@itwin/core-bentley";
-import { Cartographic, GeoCoordStatus, IModelError, PlanarClipMaskPriority, RealityDataProvider, } from "@itwin/core-common";
+import { assert, compareNumbers, compareStringsOrUndefined, CompressedId64Set, } from "@itwin/core-bentley";
+import { Cartographic, GeoCoordStatus, PlanarClipMaskPriority, RealityDataProvider, } from "@itwin/core-common";
 import { Angle, Constant, Ellipsoid, Matrix3d, Point3d, Range3d, Ray3d, Transform, Vector3d } from "@itwin/core-geometry";
 import { calculateEcefToDbTransformAtLocation } from "../BackgroundMapGeometry";
 import { IModelApp } from "../IModelApp";
 import { PlanarClipMaskState } from "../PlanarClipMaskState";
 import { DefaultSupportedTypes } from "../RealityDataAccessProps";
-import { RealityDataConnection } from "../RealityDataConnection";
 import { RealityDataSource } from "../RealityDataSource";
-import { BatchedTileIdMap, createClassifierTileTreeReference, createDefaultViewFlagOverrides, getCesiumAccessTokenAndEndpointUrl, getCesiumOSMBuildingsUrl, getGcsConverterAvailable, RealityTileLoader, RealityTileTree, TileLoadPriority, TileTreeReference, } from "./internal";
+import { BatchedTileIdMap, CesiumIonAssetProvider, createClassifierTileTreeReference, createDefaultViewFlagOverrides, getCesiumOSMBuildingsUrl, getGcsConverterAvailable, RealityTileLoader, RealityTileTree, TileLoadPriority, TileTreeReference, } from "./internal";
 function getUrl(content) {
     return content ? (content.url ? content.url : content.uri) : undefined;
 }
@@ -188,12 +186,12 @@ var SMTextureType;
 })(SMTextureType || (SMTextureType = {}));
 /** @internal */
 class RealityModelTileTreeProps {
-    constructor(json, root, client, tilesetToDbTransform, tilesetToEcef) {
+    constructor(json, root, rdSource, tilesetToDbTransform, tilesetToEcef) {
         this.tilesetToEcef = tilesetToEcef;
         this.doDrapeBackgroundMap = false;
         this.yAxisUp = false;
         this.tilesetJson = root;
-        this.client = client;
+        this.rdSource = rdSource;
         this.location = tilesetToDbTransform;
         this.doDrapeBackgroundMap = (json.root && json.root.SMMasterHeader && SMTextureType.Streaming === json.root.SMMasterHeader.IsTextured);
         if (json.asset.gltfUpAxis === undefined || json.asset.gltfUpAxis === "y" || json.asset.gltfUpAxis === "Y")
@@ -201,12 +199,12 @@ class RealityModelTileTreeProps {
     }
 }
 class RealityModelTileTreeParams {
-    constructor(url, iModel, modelId, loader, gcsConverterAvailable, rootToEcef) {
+    constructor(tileTreeId, iModel, modelId, loader, gcsConverterAvailable, rootToEcef) {
         this.gcsConverterAvailable = gcsConverterAvailable;
         this.rootToEcef = rootToEcef;
         this.is3d = true;
         this.loader = loader;
-        this.id = url;
+        this.id = tileTreeId;
         this.modelId = modelId;
         this.iModel = iModel;
         this.rootTile = new RealityModelTileProps(loader.tree.tilesetJson, undefined, "", undefined, undefined === loader.tree.tilesetJson.refine ? undefined : loader.tree.tilesetJson.refine === "ADD");
@@ -286,10 +284,10 @@ function addUrlPrefix(subTree, prefix) {
             addUrlPrefix(child, prefix);
 }
 /** @internal */
-async function expandSubTree(root, client) {
+async function expandSubTree(root, rdsource) {
     const childUrl = getUrl(root.content);
     if (undefined !== childUrl && childUrl.endsWith("json")) { // A child may contain a subTree...
-        const subTree = await client.getTileJson(childUrl);
+        const subTree = await rdsource.getTileJson(childUrl);
         const prefixIndex = childUrl.lastIndexOf("/");
         if (prefixIndex > 0)
             addUrlPrefix(subTree.root, childUrl.substring(0, prefixIndex + 1));
@@ -352,7 +350,7 @@ class RealityModelTileLoader extends RealityTileLoader {
         const foundChild = await this.findTileInJson(this.tree.tilesetJson, tile.contentId, "");
         if (undefined === foundChild || undefined === foundChild.json.content || isCanceled())
             return undefined;
-        return this.tree.client.getTileContent(getUrl(foundChild.json.content));
+        return this.tree.rdSource.getTileContent(getUrl(foundChild.json.content));
     }
     async findTileInJson(tilesetJson, id, parentId, transformToRoot) {
         if (id.length === 0)
@@ -373,7 +371,7 @@ class RealityModelTileLoader extends RealityTileLoader {
         if (separatorIndex >= 0) {
             return this.findTileInJson(foundChild, id.substring(separatorIndex + 1), thisParentId, transformToRoot);
         }
-        tilesetJson.children[childIndex] = await expandSubTree(foundChild, this.tree.client);
+        tilesetJson.children[childIndex] = await expandSubTree(foundChild, this.tree.rdSource);
         return new FindChildResult(thisParentId, tilesetJson.children[childIndex], transformToRoot);
     }
 }
@@ -474,28 +472,25 @@ export class RealityModelTileTree extends RealityTileTree {
     }
     RealityModelTileTree.Reference = Reference;
     async function createRealityModelTileTree(rdSourceKey, iModel, modelId, tilesetToDb) {
-        const rdConnection = await RealityDataConnection.fromSourceKey(rdSourceKey, iModel.iTwinId);
+        const rdSource = await RealityDataSource.fromKey(rdSourceKey, iModel.iTwinId);
         // If we can get a valid connection from sourceKey, returns the tile tree
-        if (rdConnection) {
-            const url = await rdConnection.getServiceUrl(iModel.iTwinId);
-            if (url === undefined)
+        if (rdSource) {
+            // Serialize the reality data source key into a string to uniquely identify this tile tree
+            const tileTreeId = RealityDataSource.keyToString(rdSource.key);
+            if (tileTreeId === undefined)
                 return undefined;
-            const props = await getTileTreeProps(rdConnection, tilesetToDb, iModel);
+            const props = await getTileTreeProps(rdSource, tilesetToDb, iModel);
             const loader = new RealityModelTileLoader(props, new BatchedTileIdMap(iModel));
             const gcsConverterAvailable = await getGcsConverterAvailable(iModel);
-            const params = new RealityModelTileTreeParams(url, iModel, modelId, loader, gcsConverterAvailable, props.tilesetToEcef);
+            const params = new RealityModelTileTreeParams(tileTreeId, iModel, modelId, loader, gcsConverterAvailable, props.tilesetToEcef);
             return new RealityModelTileTree(params);
         }
         return undefined;
     }
     RealityModelTileTree.createRealityModelTileTree = createRealityModelTileTree;
-    async function getTileTreeProps(rdConnection, tilesetToDbJson, iModel) {
+    async function getTileTreeProps(rdSource, tilesetToDbJson, iModel) {
         var _a, _b;
-        const url = await rdConnection.getServiceUrl(iModel.iTwinId);
-        if (!url)
-            throw new IModelError(BentleyStatus.ERROR, "Unable to read reality data");
-        const tileClient = new RealityModelTileClient(rdConnection, iModel.iTwinId);
-        const json = await tileClient.getRootDocument(url);
+        const json = await rdSource.getRootDocument(iModel.iTwinId);
         let rootTransform = iModel.ecefLocation ? iModel.getMapEcefToDb(0) : Transform.createIdentity();
         const geoConverter = iModel.noGcsDefined ? undefined : iModel.geoServices.getConverter("WGS84");
         if (geoConverter !== undefined) {
@@ -537,8 +532,8 @@ export class RealityModelTileTree extends RealityTileTree {
         }
         if (undefined !== tilesetToDbJson)
             rootTransform = Transform.fromJSON(tilesetToDbJson).multiplyTransformTransform(rootTransform);
-        const root = await expandSubTree(json.root, tileClient);
-        return new RealityModelTileTreeProps(json, root, tileClient, rootTransform, tilesetToEcef);
+        const root = await expandSubTree(json.root, rdSource);
+        return new RealityModelTileTreeProps(json, root, rdSource, rootTransform, tilesetToEcef);
     }
 })(RealityModelTileTree || (RealityModelTileTree = {}));
 /** Supplies a reality data [[TileTree]] from a URL. May be associated with a persistent [[GeometricModelState]], or attached at run-time via a [[ContextRealityModelState]].
@@ -548,8 +543,8 @@ class RealityTreeReference extends RealityModelTileTree.Reference {
     constructor(props) {
         super(props);
         // Maybe we should throw if both props.rdSourceKey && props.url are undefined
-        this._rdSourceKey = props.rdSourceKey ? props.rdSourceKey : props.url ? RealityDataSource.createRealityDataSourceKeyFromUrl(props.url, RealityDataProvider.ContextShare) :
-            RealityDataSource.createRealityDataSourceKeyFromUrl("", RealityDataProvider.ContextShare);
+        this._rdSourceKey = props.rdSourceKey ? props.rdSourceKey : props.url ? RealityDataSource.createKeyFromUrl(props.url, RealityDataProvider.ContextShare) :
+            RealityDataSource.createKeyFromUrl("", RealityDataProvider.ContextShare);
     }
     get treeOwner() {
         const treeId = { rdSourceKey: this._rdSourceKey, transform: this._transform, modelId: this.modelId, maskModelIds: this.maskModelIds };
@@ -595,7 +590,7 @@ class RealityTreeReference extends RealityModelTileTree.Reference {
             return undefined;
         const strings = [];
         const loader = tree.loader;
-        const type = await loader.tree.client.getRealityDataType();
+        const type = loader.tree.rdSource.realityDataType;
         // If a type is specified, display it
         if (type !== undefined) {
             // Case insensitive
@@ -615,7 +610,7 @@ class RealityTreeReference extends RealityModelTileTree.Reference {
             strings.push(`${IModelApp.localization.getLocalizedString("iModelJs:TooltipInfo.Name")} ${this._name}`);
         }
         else {
-            const cesiumAsset = this._rdSourceKey.provider === RealityDataProvider.CesiumIonAsset ? parseCesiumUrl(this._rdSourceKey.id) : undefined;
+            const cesiumAsset = this._rdSourceKey.provider === RealityDataProvider.CesiumIonAsset ? CesiumIonAssetProvider.parseCesiumUrl(this._rdSourceKey.id) : undefined;
             strings.push(cesiumAsset ? `Cesium Asset: ${cesiumAsset.id}` : this._rdSourceKey.id);
         }
         if (batch !== undefined)
@@ -632,191 +627,4 @@ class RealityTreeReference extends RealityModelTileTree.Reference {
         }
     }
 }
-// TBD - Allow an object to override the URL and provide its own authentication.
-function parseCesiumUrl(url) {
-    const cesiumSuffix = "$CesiumIonAsset=";
-    const cesiumIndex = url.indexOf(cesiumSuffix);
-    if (cesiumIndex < 0)
-        return undefined;
-    const cesiumIonString = url.slice(cesiumIndex + cesiumSuffix.length);
-    const cesiumParts = cesiumIonString.split(":");
-    if (cesiumParts.length !== 2)
-        return undefined;
-    const id = parseInt(cesiumParts[0], 10);
-    if (id === undefined)
-        return undefined;
-    return { id, key: cesiumParts[1] };
-}
-/**
- * ###TODO temporarily here for testing, needs to be moved to the clients repo
- * @internal
- * This class encapsulates access to a reality data wether it be from local access, http or RDS
- * The url provided at the creation is parsed to determine if this is a RDS (ProjectWise Context Share) reference.
- * If not then it is considered local (ex: C:\temp\TileRoot.json) or plain http access (http://someserver.com/data/TileRoot.json)
- * There is a one to one relationship between a reality data and the instances of present class.
- */
-export class RealityModelTileClient {
-    // ###TODO we should be able to pass the iTwinId / tileId directly, instead of parsing the url
-    // But if the present can also be used by non PW Context Share stored data then the url is required and token is not. Possibly two classes inheriting from common interface.
-    constructor(rdConnection, iTwinId) {
-        this._baseUrl = ""; // For use by all Reality Data. For RD stored on PW Context Share, represents the portion from the root of the Azure Blob Container
-        this._rdConnection = rdConnection;
-        const rdSource = this._rdConnection.source;
-        if (rdSource.isContextShare)
-            this.rdsProps = this.getRDSClientPropsFromSource(rdSource); // Note that returned is undefined if url does not refer to a PW Context Share reality data.
-        if (iTwinId && this.rdsProps)
-            this.rdsProps.iTwinId = iTwinId;
-    }
-    initializeRDSRealityData() {
-        var _a;
-        if (undefined !== this.rdsProps) {
-            if (!this._realityData) {
-                this._realityData = this._rdConnection.realityData;
-                if (!this._realityData)
-                    throw new IModelError(BentleyStatus.ERROR, "Unable to read reality data");
-                // A reality data that has not root document set should not be considered.
-                const rootDocument = (_a = this._realityData.rootDocument) !== null && _a !== void 0 ? _a : "";
-                this.setBaseUrl(rootDocument);
-            }
-        }
-    }
-    // ###TODO temporary means of extracting the tileId and projectId from the given url
-    // This is the method that determines if the url refers to Reality Data stored on PW Context Share. If not then undefined is returned.
-    // ###TODO This method should be replaced by realityDataServiceClient.getRealityDataIdFromUrl()
-    // We obtain the projectId from URL but it should be used normally. The iModel context should be used everywhere: verify!
-    getRDSClientPropsFromSource(rdSource, iTwinIdFromApp) {
-        // We have URLs with incorrect slashes that must be supported. The ~2F are WSG encoded slashes and may prevent parsing out the reality data id.
-        const tilesId = rdSource.realityDataId;
-        const iTwinIdFromSrc = rdSource.iTwinId;
-        let props;
-        if (undefined !== tilesId) {
-            const iTwinId = iTwinIdFromSrc ? iTwinIdFromSrc : iTwinIdFromApp ? iTwinIdFromApp : "server";
-            props = { iTwinId, tilesId };
-        }
-        return props;
-    }
-    // This is to set the root url from the provided root document path.
-    // If the root document is stored on PW Context Share then the root document property of the Reality Data is provided,
-    // otherwise the full path to root document is given.
-    // The base URL contains the base URL from which tile relative path are constructed.
-    // The tile's path root will need to be reinserted for child tiles to return a 200
-    setBaseUrl(url) {
-        const urlParts = url.split("/");
-        urlParts.pop();
-        if (urlParts.length === 0)
-            this._baseUrl = "";
-        else
-            this._baseUrl = `${urlParts.join("/")}/`;
-    }
-    async _doRequest(url, responseType) {
-        let options = {
-            method: "GET",
-            responseType,
-        };
-        const authToken = this._requestAuthorization;
-        if (authToken) {
-            options = {
-                ...options,
-                headers: {
-                    authorization: authToken,
-                },
-            };
-        }
-        const data = await request(url, options);
-        return data.body;
-    }
-    /**
-     * Gets a tileset's app data json
-     * @param name name or path of tile
-     * @returns app data json object
-     * @internal
-     */
-    async getRealityDataTileJson(accessToken, name, realityData) {
-        const url = await realityData.getBlobUrl(accessToken, name);
-        const data = await getJson(url.toString());
-        return data;
-    }
-    // ### TODO. Technically the url should not be required. If the reality data encapsulated is stored on PW Context Share then
-    // the relative path to root document is extracted from the reality data. Otherwise the full url to root document should have been provided at
-    // the construction of the instance.
-    async getRootDocument(url) {
-        const token = await IModelApp.getAccessToken();
-        if (this.rdsProps && token) {
-            this.initializeRDSRealityData(); // Only needed for PW Context Share data ... return immediately otherwise.
-            const realityData = this._realityData;
-            if (!realityData)
-                throw new Error(`Reality Data not defined`);
-            if (!realityData.rootDocument)
-                throw new Error(`Root document not defined for reality data: ${realityData.id}`);
-            return this.getRealityDataTileJson(token, realityData.rootDocument, realityData);
-        }
-        // The following is only if the reality data is not stored on PW Context Share.
-        const cesiumAsset = parseCesiumUrl(url);
-        if (cesiumAsset) {
-            const tokenAndUrl = await getCesiumAccessTokenAndEndpointUrl(cesiumAsset.id, cesiumAsset.key);
-            if (tokenAndUrl.url && tokenAndUrl.token) {
-                url = tokenAndUrl.url;
-                this._requestAuthorization = `Bearer ${tokenAndUrl.token}`;
-            }
-        }
-        // The following is only if the reality data is not stored on PW Context Share.
-        this.setBaseUrl(url);
-        return this._doRequest(url, "json");
-    }
-    /**
-     * Gets tile content
-     * @param name name or path of tile
-     * @returns array buffer of tile content
-     */
-    async getRealityDataTileContent(accessToken, name, realityData) {
-        const url = await realityData.getBlobUrl(accessToken, name);
-        const options = {
-            method: "GET",
-            responseType: "arraybuffer",
-        };
-        const data = await request(url.toString(), options);
-        return data.body;
-    }
-    /**
-     * Returns the tile content. The path to the tile is relative to the base url of present reality data whatever the type.
-     */
-    async getTileContent(url) {
-        assert(url !== undefined);
-        const token = await IModelApp.getAccessToken();
-        const useRds = this.rdsProps !== undefined && token !== undefined;
-        if (useRds) {
-            this.initializeRDSRealityData(); // Only needed for PW Context Share data ... return immediately otherwise.
-        }
-        const tileUrl = this._baseUrl + url;
-        if (useRds && this._realityData)
-            return this.getRealityDataTileContent(token, tileUrl, this._realityData);
-        return this._doRequest(tileUrl, "arraybuffer");
-    }
-    /**
-     * Returns the tile content in json format. The path to the tile is relative to the base url of present reality data whatever the type.
-     */
-    async getTileJson(url) {
-        assert(url !== undefined);
-        const token = await IModelApp.getAccessToken();
-        if (this.rdsProps && token) {
-            this.initializeRDSRealityData(); // Only needed for PW Context Share data ... return immediately otherwise.
-        }
-        const tileUrl = this._baseUrl + url;
-        if (undefined !== this.rdsProps && undefined !== token && this._realityData)
-            return this.getRealityDataTileJson(token, tileUrl, this._realityData);
-        return this._doRequest(tileUrl, "json");
-    }
-    /**
-     * Returns Reality Data type if available
-     */
-    async getRealityDataType() {
-        const token = await IModelApp.getAccessToken();
-        if (this.rdsProps && token) {
-            this.initializeRDSRealityData(); // Only needed for PW Context Share data
-            return this._realityData.type;
-        }
-        // The reality data type is not available if not stored on PW Context Share.
-        return undefined;
-    }
-}
 //# sourceMappingURL=RealityModelTileTree.js.map