@itwin/core-frontend 5.0.0-dev.57 → 5.0.0-dev.59

package/lib/cjs/internal/tile/map/ArcGISTileMap.js

@@ -0,0 +1,236 @@
+"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 Tiles
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArcGISTileMap = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const internal_1 = require("../../../tile/internal");
+const loggerCategory = "ArcGISTileMap";
+const nonVisibleChildren = [false, false, false, false];
+class ArcGISTileMap {
+    // For similar reasons as the corner offset, we need to keep the tile map size not too big to avoid covering multiple bundles.
+    tileMapRequestSize = 8;
+    static maxLod = 30;
+    // We want to query a tile map that covers an area all around the top-lef missing tile, we offset the top-left corner position of the tilemap.
+    // We used to create a 32x32 tiles area around the missing tiles, but this was causing the tilemap top-left position
+    // to fall outside the dataset bundle of the remote server, thus giving invalid response.
+    get tileMapOffset() { return (this.tileMapRequestSize * 0.5); }
+    fallbackTileMapRequestSize = 2;
+    _callQueues;
+    _tilesCache = new core_bentley_1.Dictionary((lhs, rhs) => (0, core_bentley_1.compareStrings)(lhs, rhs));
+    _restBaseUrl;
+    _fetchFunc;
+    _settings;
+    constructor(restBaseUrl, settings, fetchFunc) {
+        this._restBaseUrl = restBaseUrl;
+        this._fetchFunc = fetchFunc;
+        this._settings = settings;
+        this._callQueues = new Array(ArcGISTileMap.maxLod).fill(Promise.resolve(nonVisibleChildren));
+    }
+    async fetchTileMapFromServer(level, row, column, width, height) {
+        const tmpUrl = `${this._restBaseUrl}/tilemap/${level}/${row}/${column}/${width}/${height}?f=json`;
+        const response = await this._fetchFunc(new URL(tmpUrl));
+        return response.json();
+    }
+    getAvailableTilesFromCache(tiles) {
+        let allTilesFound = true;
+        // Check children visibility from cache
+        const available = tiles.map((tileId) => {
+            const avail = this._tilesCache.get(tileId.contentId);
+            if (undefined === avail) {
+                allTilesFound = false;
+            }
+            return avail ?? false;
+        });
+        return { allTilesFound, available };
+    }
+    async getChildrenAvailability(childIds) {
+        if (!childIds.length)
+            return [];
+        // Before entering the queue for a backend request,
+        // let check if cache doesn't already contain what we are looking for.
+        const cacheInfo = this.getAvailableTilesFromCache(childIds);
+        if (cacheInfo.allTilesFound) {
+            if (cacheInfo.available.includes(false))
+                return cacheInfo.available;
+            return cacheInfo.available;
+        }
+        // If we never encountered this tile level before, then a tilemap request must be made to get tiles visibility.
+        // However, we dont want several overlapping large tilemap request being made simultaneously for tiles on the same level.
+        // To avoid this from happening, we 'serialize' async calls so that we wait until the first tilemap request has completed
+        // before making another one.
+        const childLevel = childIds[0].level + 1;
+        if (this._callQueues && childLevel < this._callQueues.length) {
+            const res = this._callQueues[childLevel].then(async () => {
+                return this.getChildrenAvailabilityFromServer(childIds);
+            });
+            this._callQueues[childLevel] = res.catch(() => nonVisibleChildren);
+            return res;
+        }
+        else {
+            // We should not be in this case, probably because server info is missing LODs in the capabilities?!
+            core_bentley_1.Logger.logWarning(loggerCategory, `Skipped request queue for child level ${childLevel}`);
+            return this.getChildrenAvailabilityFromServer(childIds);
+        }
+    }
+    isCacheMissingTile(level, startRow, startColumn, endRow, endColumn) {
+        let missingTileFound = false;
+        if (endRow <= startRow || endColumn <= startColumn)
+            return missingTileFound;
+        for (let j = startColumn; j <= endColumn && !missingTileFound; j++) {
+            for (let i = startRow; i <= endRow && !missingTileFound; i++) {
+                if (j >= 0 && i >= 0) {
+                    const contentId = internal_1.QuadId.getTileContentId(level, j, i);
+                    if (this._tilesCache.get(contentId) === undefined) {
+                        missingTileFound = true;
+                    }
+                }
+            }
+        }
+        return missingTileFound;
+    }
+    collectTilesMissingFromCache(missingQueryTiles) {
+        const missingTiles = [];
+        for (const quad of missingQueryTiles) {
+            const contentId = internal_1.QuadId.getTileContentId(quad.level, quad.column, quad.row);
+            const avail = this._tilesCache.get(contentId);
+            if (avail === undefined)
+                missingTiles.push(quad);
+        }
+        return missingTiles;
+    }
+    // Query tiles are tiles that we need to check availability
+    // The array is assumed to be in in row major orientation, i.e.: [TileRow0Col0, TileRow0Col1, TileRow1Col0, TileRow1Col1,]
+    async fetchAndReadTilemap(queryTiles, reqWidth, reqHeight) {
+        let available = queryTiles.map(() => false);
+        if (queryTiles.length === 0) {
+            return available;
+        }
+        // console.log(`queryTiles: ${queryTiles.map((quad) => quad.contentId)}`);
+        // Find the top-left most corner of the extent covering the query tiles.
+        const getTopLeftCorner = (tiles) => {
+            let row;
+            let column;
+            for (const quad of tiles) {
+                if (row === undefined || quad.row <= row)
+                    row = quad.row;
+                if (column === undefined || quad.column <= column) {
+                    column = quad.column;
+                }
+            }
+            return { row, column };
+        };
+        const level = queryTiles[0].level; // We assume all tiles to be on the same level
+        let missingQueryTiles = this.collectTilesMissingFromCache(queryTiles);
+        let gotAdjusted = false;
+        let nbAttempt = 0; // Safety: We should never be making more requests than the number of queries tiles (otherwise something is wrong)
+        while (missingQueryTiles.length > 0
+            && (nbAttempt++ < queryTiles.length)) {
+            const tileMapTopLeft = getTopLeftCorner(missingQueryTiles);
+            if (tileMapTopLeft.row === undefined || tileMapTopLeft.column === undefined)
+                return available; // Should not occurs since missingQueryTiles is non empty
+            let tileMapRow = tileMapTopLeft.row;
+            let tileMapColumn = tileMapTopLeft.column;
+            const logLocationOffset = (newRow, newCol) => `[Row:${newRow !== tileMapTopLeft.row ? `${tileMapTopLeft.row}->${newRow}` : `${newRow}`} Column:${newCol !== tileMapTopLeft.column ? `${tileMapTopLeft.column}->${newCol}` : `${newCol}`}]`;
+            // Position the top-left missing tile in the middle of the tilemap; minimizing requests if sibling tiles are requested right after
+            // If previous response got adjusted, don't try to optimize tile map location
+            if (queryTiles.length < this.tileMapRequestSize && !gotAdjusted) {
+                const tileMapOffset = this.tileMapOffset - Math.floor(Math.sqrt(queryTiles.length) * 0.5);
+                const missingTileBufferSize = Math.ceil(tileMapOffset * 0.5);
+                if (this.isCacheMissingTile(level, tileMapRow - missingTileBufferSize, tileMapColumn - missingTileBufferSize, tileMapRow - 1, tileMapColumn - 1)) {
+                    tileMapRow = Math.max(tileMapRow - tileMapOffset, 0);
+                    tileMapColumn = Math.max(tileMapColumn - tileMapOffset, 0);
+                    core_bentley_1.Logger.logTrace(loggerCategory, `Offset applied to location in top-left direction: ${logLocationOffset(tileMapRow, tileMapColumn)}`);
+                }
+                else {
+                    const leftMissingTiles = this.isCacheMissingTile(level, tileMapRow, tileMapColumn - missingTileBufferSize, tileMapRow + missingTileBufferSize, tileMapColumn - 1);
+                    const topMissingTiles = this.isCacheMissingTile(level, tileMapRow - missingTileBufferSize, tileMapColumn, tileMapRow - 1, tileMapColumn + missingTileBufferSize);
+                    if (leftMissingTiles && topMissingTiles) {
+                        tileMapRow = Math.max(tileMapRow - tileMapOffset, 0);
+                        tileMapColumn = Math.max(tileMapColumn - tileMapOffset, 0);
+                        core_bentley_1.Logger.logTrace(loggerCategory, `Offset applied to location in top-left direction. ${logLocationOffset(tileMapRow, tileMapColumn)}`);
+                    }
+                    else if (leftMissingTiles) {
+                        tileMapColumn = Math.max(tileMapColumn - tileMapOffset, 0);
+                        core_bentley_1.Logger.logTrace(loggerCategory, `Offset applied to location in left direction. ${logLocationOffset(tileMapRow, tileMapColumn)}`);
+                    }
+                    else if (topMissingTiles) {
+                        tileMapRow = Math.max(tileMapRow - tileMapOffset, 0);
+                        core_bentley_1.Logger.logTrace(loggerCategory, `Offset applied to location in top direction: ${logLocationOffset(tileMapRow, tileMapColumn)}`);
+                    }
+                    else
+                        core_bentley_1.Logger.logTrace(loggerCategory, `No offset applied to location: ${logLocationOffset(tileMapRow, tileMapColumn)}`);
+                }
+            }
+            const json = await this.fetchTileMapFromServer(level, tileMapRow, tileMapColumn, reqWidth, reqHeight);
+            let tileMapWidth = reqWidth;
+            let tileMapHeight = reqHeight;
+            if (Array.isArray(json.data)) {
+                // The response width and height might be different than the requested dimensions.
+                // Ref: https://developers.arcgis.com/rest/services-reference/enterprise/tile-map.htm
+                if (json.adjusted) {
+                    gotAdjusted = true;
+                    // If tilemap size got adjusted, I'm expecting to get adjusted size...
+                    // otherwise there is something really odd with this server.
+                    (0, core_bentley_1.assert)(json.location?.width !== undefined && json.location?.height !== undefined);
+                    if (json.location?.width !== undefined && json.location?.height !== undefined) {
+                        tileMapWidth = json.location?.width;
+                        tileMapHeight = json.location?.height;
+                    }
+                }
+                // Build cache from tile map response
+                for (let j = 0; j < tileMapHeight; j++) {
+                    for (let i = 0; i < tileMapWidth; i++) {
+                        const avail = json.data[(j * tileMapWidth) + i] !== 0;
+                        const curColumn = tileMapColumn + i;
+                        const curRow = tileMapRow + j;
+                        this._tilesCache.set(internal_1.QuadId.getTileContentId(level, curColumn, curRow), avail);
+                    }
+                }
+                // Collect tile missing from the cache
+                // There are 2 reasons why the tile map response would not cover all the missing tiles:
+                // 1. The requested tile map size is not large enough to cover all tiles
+                // 2. The tile map size has been adjusted by the server (i.e. data bundle limits)
+                missingQueryTiles = this.collectTilesMissingFromCache(missingQueryTiles);
+                if (missingQueryTiles.length > 0)
+                    core_bentley_1.Logger.logTrace(loggerCategory, `There are ${missingQueryTiles.length} missing tiles from previous request`);
+            }
+            else {
+                missingQueryTiles = [];
+                // Mark all tilemap tiles to non-available in the cache too.
+                for (let j = 0; j < tileMapWidth; j++) {
+                    for (let i = 0; i < tileMapHeight; i++) {
+                        this._tilesCache.set(internal_1.QuadId.getTileContentId(level, tileMapColumn + i, tileMapRow + j), false);
+                    }
+                }
+            }
+        } // end loop missing tiles
+        if (nbAttempt > queryTiles.length) {
+            core_bentley_1.Logger.logError(loggerCategory, `Request loop was terminated; unable to get missing tiles; `);
+        }
+        // Create final output array from cache
+        available = queryTiles.map((quad) => this._tilesCache.get(quad.contentId) ?? false);
+        if (available.includes(false))
+            return available;
+        return available;
+    }
+    async getChildrenAvailabilityFromServer(childIds) {
+        let available;
+        try {
+            available = await this.fetchAndReadTilemap(childIds, this.tileMapRequestSize, this.tileMapRequestSize);
+        }
+        catch (err) {
+            // if any error occurs, we assume tiles not to be visible
+            core_bentley_1.Logger.logError(loggerCategory, `Error while fetching tile map data : ${err}`);
+            available = childIds.map(() => false);
+        }
+        return available;
+    }
+}
+exports.ArcGISTileMap = ArcGISTileMap;
+//# sourceMappingURL=ArcGISTileMap.js.map

package/lib/cjs/internal/tile/map/ArcGISTileMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArcGISTileMap.js","sourceRoot":"","sources":["../../../../../src/internal/tile/map/ArcGISTileMap.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAiF;AACjF,qDAAgD;AAEhD,MAAM,cAAc,GAAG,eAAe,CAAC;AAIvC,MAAM,kBAAkB,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;AAExD,MAAa,aAAa;IAExB,8HAA8H;IACvH,kBAAkB,GAAG,CAAC,CAAC;IACtB,MAAM,CAAC,MAAM,GAAG,EAAE,CAAC;IAE3B,8IAA8I;IAC9I,oHAAoH;IACpH,yFAAyF;IACzF,IAAW,aAAa,KAAI,OAAO,CAAC,IAAI,CAAC,kBAAkB,GAAG,GAAG,CAAC,CAAC,CAAA,CAAC;IAE5D,0BAA0B,GAAG,CAAC,CAAC;IAE/B,WAAW,CAAwC;IACnD,WAAW,GAAG,IAAI,yBAAU,CAAkB,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,IAAA,6BAAc,EAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;IACtF,YAAY,CAAS;IACrB,UAAU,CAAgB;IAC1B,SAAS,CAAwB;IAEzC,YAAY,WAAmB,EAAE,QAA+B,EAAE,SAAwB;QACxF,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,WAAW,GAAG,IAAI,KAAK,CAAqB,aAAa,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAY,kBAAkB,CAAC,CAAC,CAAC;IAE9H,CAAC;IACS,KAAK,CAAC,sBAAsB,CAAC,KAAa,EAAE,GAAW,EAAE,MAAc,EAAE,KAAa,EAAE,MAAc;QAC9G,MAAM,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,YAAY,KAAK,IAAI,GAAG,IAAI,MAAM,IAAI,KAAK,IAAI,MAAM,SAAS,CAAC;QAClG,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;QACxD,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC;IAES,0BAA0B,CAAC,KAAe;QAClD,IAAI,aAAa,GAAG,IAAI,CAAC;QAEzB,uCAAuC;QACvC,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YACrC,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YACrD,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;gBACxB,aAAa,GAAG,KAAK,CAAC;YACxB,CAAC;YACD,OAAO,KAAK,IAAI,KAAK,CAAC;QACxB,CAAC,CAAC,CAAC;QAEH,OAAO,EAAC,aAAa,EAAE,SAAS,EAAC,CAAC;IACpC,CAAC;IAEM,KAAK,CAAC,uBAAuB,CAAC,QAAkB;QACrD,IAAI,CAAC,QAAQ,CAAC,MAAM;YAClB,OAAO,EAAE,CAAC;QAEZ,mDAAmD;QACnD,sEAAsE;QACtE,MAAM,SAAS,GAAG,IAAI,CAAC,0BAA0B,CAAC,QAAQ,CAAC,CAAC;QAC5D,IAAI,SAAS,CAAC,aAAa,EAAE,CAAC;YAE5B,IAAI,SAAS,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC;gBACrC,OAAO,SAAS,CAAC,SAAS,CAAC;YAE7B,OAAO,SAAS,CAAC,SAAS,CAAC;QAC7B,CAAC;QAED,+GAA+G;QAC/G,yHAAyH;QACzH,yHAAyH;QACzH,6BAA6B;QAC7B,MAAM,UAAU,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,GAAC,CAAC,CAAC;QACvC,IAAI,IAAI,CAAC,WAAW,IAAI,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAG,CAAC;YAC9D,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE;gBACvD,OAAO,IAAI,CAAC,iCAAiC,CAAC,QAAQ,CAAC,CAAC;YAC1D,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,CAAC;YACnE,OAAO,GAAG,CAAC;QACb,CAAC;aAAM,CAAC;YACN,oGAAoG;YACpG,qBAAM,CAAC,UAAU,CAAC,cAAc,EAAE,yCAAyC,UAAU,EAAE,CAAC,CAAC;YACzF,OAAO,IAAI,CAAC,iCAAiC,CAAC,QAAQ,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;IAEO,kBAAkB,CAAC,KAAa,EAAE,QAAgB,EAAE,WAAmB,EAAE,MAAc,EAAE,SAAiB;QAChH,IAAI,gBAAgB,GAAG,KAAK,CAAC;QAE7B,IAAI,MAAM,IAAI,QAAQ,IAAI,SAAS,IAAI,WAAW;YAChD,OAAO,gBAAgB,CAAC;QAE1B,KAAK,IAAI,CAAC,GAAG,WAAW,EAAE,CAAC,IAAI,SAAS,IAAI,CAAC,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC;YACnE,KAAK,IAAI,CAAC,GAAG,QAAQ,EAAE,CAAC,IAAE,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC3D,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;oBACrB,MAAM,SAAS,GAAG,iBAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;oBACvD,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,SAAS,EAAE,CAAC;wBAClD,gBAAgB,GAAG,IAAI,CAAC;oBAC1B,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAEO,4BAA4B,CAAE,iBAA2B;QAC/D,MAAM,YAAY,GAAc,EAAE,CAAC;QACnC,KAAK,MAAM,IAAI,IAAI,iBAAiB,EAAE,CAAC;YACrC,MAAM,SAAS,GAAG,iBAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;YAC7E,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YAC9C,IAAI,KAAK,KAAK,SAAS;gBACrB,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE5B,CAAC;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,2DAA2D;IAC3D,0HAA0H;IACnH,KAAK,CAAC,mBAAmB,CAAC,UAAoB,EAAE,QAAgB,EAAE,SAAiB;QACxF,IAAI,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,GAAE,EAAE,CAAA,KAAK,CAAC,CAAC;QAC1C,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAG,CAAC;YAC7B,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,0EAA0E;QAE1E,wEAAwE;QACxE,MAAM,gBAAgB,GAAG,CAAC,KAAe,EAAqD,EAAE;YAC9F,IAAI,GAAqB,CAAC;YAC1B,IAAI,MAAwB,CAAC;YAC7B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,IAAI,GAAG,KAAK,SAAS,IAAI,IAAI,CAAC,GAAG,IAAI,GAAG;oBACtC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;gBACjB,IAAI,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,IAAI,MAAM,EAAE,CAAC;oBAClD,MAAM,GAAG,IAAI,CAAC,MAAM,CAAE;gBACxB,CAAC;YACH,CAAC;YACD,OAAO,EAAC,GAAG,EAAE,MAAM,EAAC,CAAC;QACvB,CAAC,CAAC;QAEF,MAAM,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,8CAA8C;QAEjF,IAAI,iBAAiB,GAAG,IAAI,CAAC,4BAA4B,CAAC,UAAU,CAAC,CAAC;QACtE,IAAI,WAAW,GAAG,KAAK,CAAC;QACxB,IAAI,SAAS,GAAG,CAAC,CAAC,CAAC,kHAAkH;QACrI,OAAO,iBAAiB,CAAC,MAAM,GAAG,CAAC;eAC9B,CAAC,SAAS,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC,EAAG,CAAC;YACxC,MAAM,cAAc,GAAG,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;YAC3D,IAAI,cAAc,CAAC,GAAG,KAAK,SAAS,IAAI,cAAc,CAAC,MAAM,KAAK,SAAS;gBACzE,OAAO,SAAS,CAAC,CAAG,yDAAyD;YAE/E,IAAI,UAAU,GAAG,cAAc,CAAC,GAAG,CAAC;YACpC,IAAI,aAAa,GAAG,cAAc,CAAC,MAAM,CAAC;YAE1C,MAAM,iBAAiB,GAAG,CAAC,MAAc,EAAE,MAAc,EAAE,EAAE,CAAE,QAAQ,MAAM,KAAK,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,GAAG,KAAK,MAAM,EAAE,CAAC,CAAC,CAAC,GAAG,MAAM,EAAE,WAAW,MAAM,KAAK,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC,CAAC,CAAC,GAAG,MAAM,EAAE,GAAG,CAAC;YAE5P,kIAAkI;YAClI,6EAA6E;YAC7E,IAAI,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,kBAAkB,IAAI,CAAC,WAAW,EAAE,CAAC;gBAChE,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC;gBAC1F,MAAM,qBAAqB,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,GAAG,GAAG,CAAC,CAAC;gBAC7D,IAAI,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,UAAU,GAAC,qBAAqB,EAAE,aAAa,GAAC,qBAAqB,EAAE,UAAU,GAAC,CAAC,EAAE,aAAa,GAAC,CAAC,CAAC,EAAE,CAAC;oBACzI,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,aAAa,EAAE,CAAC,CAAC,CAAC;oBACrD,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,GAAG,aAAa,EAAE,CAAC,CAAC,CAAC;oBAC3D,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,qDAAqD,iBAAiB,CAAC,UAAU,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC;gBACvI,CAAC;qBAAM,CAAC;oBACN,MAAM,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,UAAU,EAAE,aAAa,GAAC,qBAAqB,EAAE,UAAU,GAAC,qBAAqB,EAAE,aAAa,GAAC,CAAC,CAAC,CAAC;oBAC5J,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,UAAU,GAAC,qBAAqB,EAAE,aAAa,EAAE,UAAU,GAAC,CAAC,EAAE,aAAa,GAAC,qBAAqB,CAAC,CAAC;oBAC3J,IAAI,gBAAgB,IAAI,eAAe,EAAE,CAAC;wBACxC,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,aAAa,EAAE,CAAC,CAAC,CAAC;wBACrD,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,GAAE,aAAa,EAAE,CAAC,CAAC,CAAC;wBAC1D,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,qDAAqD,iBAAiB,CAAC,UAAU,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC;oBACvI,CAAC;yBAAM,IAAI,gBAAgB,EAAE,CAAC;wBAC5B,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,GAAG,aAAa,EAAE,CAAC,CAAC,CAAC;wBAC3D,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,iDAAiD,iBAAiB,CAAC,UAAU,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC;oBACnI,CAAC;yBAAM,IAAI,eAAe,EAAG,CAAC;wBAC5B,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,aAAa,EAAE,CAAC,CAAC,CAAC;wBACrD,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,gDAAgD,iBAAiB,CAAC,UAAU,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC;oBAClI,CAAC;;wBACC,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,kCAAkC,iBAAiB,CAAC,UAAU,EAAE,aAAa,CAAC,EAAE,CAAC,CAAC;gBACtH,CAAC;YACH,CAAC;YAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,UAAU,EAAE,aAAa,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;YACtG,IAAI,YAAY,GAAG,QAAQ,CAAC;YAC5B,IAAI,aAAa,GAAG,SAAS,CAAC;YAC9B,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC7B,kFAAkF;gBAClF,qFAAqF;gBACrF,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;oBAClB,WAAW,GAAG,IAAI,CAAC;oBACnB,sEAAsE;oBACtE,4DAA4D;oBAC5D,IAAA,qBAAM,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,EAAE,MAAM,KAAK,SAAS,CAAC,CAAC;oBAClF,IAAI,IAAI,CAAC,QAAQ,EAAE,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,EAAE,MAAM,KAAK,SAAS,EAAE,CAAC;wBAC9E,YAAY,GAAG,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC;wBACpC,aAAa,GAAG,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC;oBACxC,CAAC;gBACH,CAAC;gBACD,qCAAqC;gBACrC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,EAAE,CAAC,EAAE,EAAE,CAAC;oBACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,EAAE,CAAC,EAAE,EAAE,CAAC;wBACtC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAC,YAAY,CAAC,GAAC,CAAC,CAAC,KAAK,CAAC,CAAC;wBAClD,MAAM,SAAS,GAAG,aAAa,GAAG,CAAC,CAAC;wBACpC,MAAM,MAAM,GAAG,UAAU,GAAG,CAAC,CAAC;wBAC9B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,iBAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC;oBACjF,CAAC;gBACH,CAAC;gBAED,sCAAsC;gBACtC,uFAAuF;gBACvF,wEAAwE;gBACxE,iFAAiF;gBACjF,iBAAiB,GAAG,IAAI,CAAC,4BAA4B,CAAC,iBAAiB,CAAC,CAAC;gBACzE,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC;oBAC9B,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,aAAa,iBAAiB,CAAC,MAAM,sCAAsC,CAAC,CAAC;YACjH,CAAC;iBAAM,CAAC;gBACN,iBAAiB,GAAG,EAAE,CAAC;gBACvB,4DAA4D;gBAC5D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,EAAE,CAAC,EAAE,EAAE,CAAC;oBACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,EAAE,CAAC,EAAE,EAAE,CAAC;wBACvC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,iBAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,aAAa,GAAG,CAAC,EAAE,UAAU,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;oBACjG,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC,CAAE,yBAAyB;QAE5B,IAAI,SAAS,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;YAClC,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,4DAA4D,CAAC,CAAC;QAChG,CAAC;QACD,uCAAuC;QACvC,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,EAAC,EAAE,CAAA,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,CAAC,CAAC;QAElF,IAAI,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC;YAC3B,OAAO,SAAS,CAAC;QAEnB,OAAO,SAAS,CAAC;IACnB,CAAC;IAES,KAAK,CAAC,iCAAiC,CAAC,QAAkB;QAElE,IAAI,SAAS,CAAC;QACd,IAAI,CAAC;YACH,SAAS,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,IAAI,CAAC,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACzG,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,yDAAyD;YACzD,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,wCAAwC,GAAG,EAAE,CAAC,CAAC;YAC/E,SAAS,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAE,EAAE,CAAA,KAAK,CAAC,CAAC;QACtC,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;;AAtPH,sCAuPC","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 Tiles\n */\n\nimport { assert, compareStrings, Dictionary, Logger } from \"@itwin/core-bentley\";\nimport { QuadId } from \"../../../tile/internal\";\nimport { ImageMapLayerSettings } from \"@itwin/core-common\";\nconst loggerCategory = \"ArcGISTileMap\";\n\nexport type FetchFunction = (url: URL, options?: RequestInit) => Promise<Response>;\n\nconst nonVisibleChildren = [false, false, false, false];\n\nexport class ArcGISTileMap {\n\n  // For similar reasons as the corner offset, we need to keep the tile map size not too big to avoid covering multiple bundles.\n  public tileMapRequestSize = 8;\n  private static maxLod = 30;\n\n  // We want to query a tile map that covers an area all around the top-lef missing tile, we offset the top-left corner position of the tilemap.\n  // We used to create a 32x32 tiles area around the missing tiles, but this was causing the tilemap top-left position\n  // to fall outside the dataset bundle of the remote server, thus giving invalid response.\n  public get tileMapOffset() {return (this.tileMapRequestSize * 0.5);}\n\n  public  fallbackTileMapRequestSize = 2;\n\n  private _callQueues: Array<Promise<boolean[]>> | undefined;\n  private _tilesCache = new Dictionary<string, boolean>((lhs, rhs) => compareStrings(lhs, rhs));\n  private _restBaseUrl: string;\n  private _fetchFunc: FetchFunction;\n  private _settings: ImageMapLayerSettings;\n\n  constructor(restBaseUrl: string, settings: ImageMapLayerSettings, fetchFunc: FetchFunction ){\n    this._restBaseUrl = restBaseUrl;\n    this._fetchFunc = fetchFunc;\n    this._settings = settings;\n    this._callQueues = new Array<Promise<boolean[]>>(ArcGISTileMap.maxLod).fill(Promise.resolve<boolean[]>(nonVisibleChildren));\n\n  }\n  protected async fetchTileMapFromServer(level: number, row: number, column: number, width: number, height: number): Promise<any> {\n    const tmpUrl = `${this._restBaseUrl}/tilemap/${level}/${row}/${column}/${width}/${height}?f=json`;\n    const response = await this._fetchFunc(new URL(tmpUrl));\n    return response.json();\n  }\n\n  protected getAvailableTilesFromCache(tiles: QuadId[]): {allTilesFound: boolean, available: boolean[]} {\n    let allTilesFound = true;\n\n    // Check children visibility from cache\n    const available = tiles.map((tileId) => {\n      const avail = this._tilesCache.get(tileId.contentId);\n      if (undefined === avail) {\n        allTilesFound = false;\n      }\n      return avail ?? false;\n    });\n\n    return {allTilesFound, available};\n  }\n\n  public async getChildrenAvailability(childIds: QuadId[]): Promise<boolean[]> {\n    if (!childIds.length)\n      return [];\n\n    // Before entering the queue for a backend request,\n    // let check if cache doesn't already contain what we are looking for.\n    const cacheInfo = this.getAvailableTilesFromCache(childIds);\n    if (cacheInfo.allTilesFound) {\n\n      if (cacheInfo.available.includes(false))\n        return cacheInfo.available;\n\n      return cacheInfo.available;\n    }\n\n    // If we never encountered this tile level before, then a tilemap request must be made to get tiles visibility.\n    // However, we dont want several overlapping large tilemap request being made simultaneously for tiles on the same level.\n    // To avoid this from happening, we 'serialize' async calls so that we wait until the first tilemap request has completed\n    // before making another one.\n    const childLevel = childIds[0].level+1;\n    if (this._callQueues && childLevel < this._callQueues.length ) {\n      const res = this._callQueues[childLevel].then(async () => {\n        return this.getChildrenAvailabilityFromServer(childIds);\n      });\n      this._callQueues[childLevel] = res.catch(() => nonVisibleChildren);\n      return res;\n    } else {\n      // We should not be in this case, probably because server info is missing LODs in the capabilities?!\n      Logger.logWarning(loggerCategory, `Skipped request queue for child level ${childLevel}`);\n      return this.getChildrenAvailabilityFromServer(childIds);\n    }\n  }\n\n  private isCacheMissingTile(level: number, startRow: number, startColumn: number, endRow: number, endColumn: number) {\n    let missingTileFound = false;\n\n    if (endRow <= startRow || endColumn <= startColumn)\n      return missingTileFound;\n\n    for (let j = startColumn; j <= endColumn && !missingTileFound; j++) {\n      for (let i = startRow; i<=endRow && !missingTileFound; i++) {\n        if (j >= 0 && i >= 0) {\n          const contentId = QuadId.getTileContentId(level, j, i);\n          if (this._tilesCache.get(contentId) === undefined) {\n            missingTileFound = true;\n          }\n        }\n      }\n    }\n    return missingTileFound;\n  }\n\n  private collectTilesMissingFromCache( missingQueryTiles: QuadId[]) {\n    const missingTiles: QuadId[]  = [];\n    for (const quad of missingQueryTiles) {\n      const contentId = QuadId.getTileContentId(quad.level, quad.column, quad.row);\n      const avail = this._tilesCache.get(contentId);\n      if (avail === undefined)\n        missingTiles.push(quad);\n\n    }\n    return missingTiles;\n  }\n\n  // Query tiles are tiles that we need to check availability\n  // The array is assumed to be in in row major orientation, i.e.: [TileRow0Col0, TileRow0Col1, TileRow1Col0, TileRow1Col1,]\n  public async fetchAndReadTilemap(queryTiles: QuadId[], reqWidth: number, reqHeight: number) {\n    let available = queryTiles.map(()=>false);\n    if (queryTiles.length === 0 ) {\n      return available;\n    }\n\n    // console.log(`queryTiles: ${queryTiles.map((quad) => quad.contentId)}`);\n\n    // Find the top-left most corner of the extent covering the query tiles.\n    const getTopLeftCorner = (tiles: QuadId[]): {row: number|undefined, column: number|undefined} => {\n      let row: number|undefined;\n      let column: number|undefined;\n      for (const quad of tiles) {\n        if (row === undefined || quad.row <= row )\n          row = quad.row;\n        if (column === undefined || quad.column <= column) {\n          column = quad.column ;\n        }\n      }\n      return {row, column};\n    };\n\n    const level = queryTiles[0].level; // We assume all tiles to be on the same level\n\n    let missingQueryTiles = this.collectTilesMissingFromCache(queryTiles);\n    let gotAdjusted = false;\n    let nbAttempt = 0; // Safety: We should never be making more requests than the number of queries tiles (otherwise something is wrong)\n    while (missingQueryTiles.length > 0\n      && (nbAttempt++ < queryTiles.length) ) {\n      const tileMapTopLeft = getTopLeftCorner(missingQueryTiles);\n      if (tileMapTopLeft.row === undefined || tileMapTopLeft.column === undefined)\n        return available;   // Should not occurs since missingQueryTiles is non empty\n\n      let tileMapRow = tileMapTopLeft.row;\n      let tileMapColumn = tileMapTopLeft.column;\n\n      const logLocationOffset = (newRow: number, newCol: number) =>  `[Row:${newRow !== tileMapTopLeft.row ? `${tileMapTopLeft.row}->${newRow}` : `${newRow}`} Column:${newCol !== tileMapTopLeft.column ? `${tileMapTopLeft.column}->${newCol}` : `${newCol}`}]`;\n\n      // Position the top-left missing tile in the middle of the tilemap; minimizing requests if sibling tiles are requested right after\n      // If previous response got adjusted, don't try to optimize tile map location\n      if (queryTiles.length < this.tileMapRequestSize && !gotAdjusted) {\n        const tileMapOffset = this.tileMapOffset - Math.floor(Math.sqrt(queryTiles.length) * 0.5);\n        const missingTileBufferSize = Math.ceil(tileMapOffset * 0.5);\n        if (this.isCacheMissingTile(level, tileMapRow-missingTileBufferSize, tileMapColumn-missingTileBufferSize, tileMapRow-1, tileMapColumn-1)) {\n          tileMapRow = Math.max(tileMapRow - tileMapOffset, 0);\n          tileMapColumn = Math.max(tileMapColumn - tileMapOffset, 0);\n          Logger.logTrace(loggerCategory, `Offset applied to location in top-left direction: ${logLocationOffset(tileMapRow, tileMapColumn)}`);\n        } else {\n          const leftMissingTiles = this.isCacheMissingTile(level, tileMapRow, tileMapColumn-missingTileBufferSize, tileMapRow+missingTileBufferSize, tileMapColumn-1);\n          const topMissingTiles = this.isCacheMissingTile(level, tileMapRow-missingTileBufferSize, tileMapColumn, tileMapRow-1, tileMapColumn+missingTileBufferSize);\n          if (leftMissingTiles && topMissingTiles) {\n            tileMapRow = Math.max(tileMapRow - tileMapOffset, 0);\n            tileMapColumn = Math.max(tileMapColumn- tileMapOffset, 0);\n            Logger.logTrace(loggerCategory, `Offset applied to location in top-left direction. ${logLocationOffset(tileMapRow, tileMapColumn)}`);\n          } else if (leftMissingTiles) {\n            tileMapColumn = Math.max(tileMapColumn - tileMapOffset, 0);\n            Logger.logTrace(loggerCategory, `Offset applied to location in left direction. ${logLocationOffset(tileMapRow, tileMapColumn)}`);\n          } else if (topMissingTiles)  {\n            tileMapRow = Math.max(tileMapRow - tileMapOffset, 0);\n            Logger.logTrace(loggerCategory, `Offset applied to location in top direction: ${logLocationOffset(tileMapRow, tileMapColumn)}`);\n          } else\n            Logger.logTrace(loggerCategory, `No offset applied to location: ${logLocationOffset(tileMapRow, tileMapColumn)}`);\n        }\n      }\n\n      const json = await this.fetchTileMapFromServer(level, tileMapRow, tileMapColumn, reqWidth, reqHeight);\n      let tileMapWidth = reqWidth;\n      let tileMapHeight = reqHeight;\n      if (Array.isArray(json.data)) {\n        // The response width and height might be different than the requested dimensions.\n        // Ref: https://developers.arcgis.com/rest/services-reference/enterprise/tile-map.htm\n        if (json.adjusted) {\n          gotAdjusted = true;\n          // If tilemap size got adjusted, I'm expecting to get adjusted size...\n          // otherwise there is something really odd with this server.\n          assert(json.location?.width !== undefined && json.location?.height !== undefined);\n          if (json.location?.width !== undefined && json.location?.height !== undefined) {\n            tileMapWidth = json.location?.width;\n            tileMapHeight = json.location?.height;\n          }\n        }\n        // Build cache from tile map response\n        for (let j = 0; j < tileMapHeight; j++) {\n          for (let i = 0; i < tileMapWidth; i++) {\n            const avail = json.data[(j*tileMapWidth)+i] !== 0;\n            const curColumn = tileMapColumn + i;\n            const curRow = tileMapRow + j;\n            this._tilesCache.set(QuadId.getTileContentId(level, curColumn, curRow), avail);\n          }\n        }\n\n        // Collect tile missing from the cache\n        // There are 2 reasons why the tile map response would not cover all the missing tiles:\n        // 1. The requested tile map size is not large enough to cover all tiles\n        // 2. The tile map size has been adjusted by the server (i.e. data bundle limits)\n        missingQueryTiles = this.collectTilesMissingFromCache(missingQueryTiles);\n        if (missingQueryTiles.length > 0)\n          Logger.logTrace(loggerCategory, `There are ${missingQueryTiles.length} missing tiles from previous request`);\n      } else {\n        missingQueryTiles = [];\n        // Mark all tilemap tiles to non-available in the cache too.\n        for (let j = 0; j < tileMapWidth; j++) {\n          for (let i = 0; i < tileMapHeight; i++) {\n            this._tilesCache.set(QuadId.getTileContentId(level, tileMapColumn + i, tileMapRow + j), false);\n          }\n        }\n      }\n    }  // end loop missing tiles\n\n    if (nbAttempt > queryTiles.length) {\n      Logger.logError(loggerCategory, `Request loop was terminated; unable to get missing tiles; `);\n    }\n    // Create final output array from cache\n    available = queryTiles.map((quad)=>this._tilesCache.get(quad.contentId) ?? false);\n\n    if (available.includes(false))\n      return available;\n\n    return available;\n  }\n\n  protected async getChildrenAvailabilityFromServer(childIds: QuadId[]): Promise<boolean[]> {\n\n    let available;\n    try {\n      available = await this.fetchAndReadTilemap(childIds, this.tileMapRequestSize, this.tileMapRequestSize);\n    } catch (err) {\n      // if any error occurs, we assume tiles not to be visible\n      Logger.logError(loggerCategory, `Error while fetching tile map data : ${err}`);\n      available = childIds.map(()=>false);\n    }\n\n    return available;\n  }\n}\n"]}

package/lib/cjs/internal/tile/map/ArcGisUtilities.d.ts

@@ -0,0 +1,122 @@
+import { MapCartoRectangle, MapLayerAccessClient, MapLayerAccessToken, MapLayerAccessTokenParams, MapLayerSource, MapLayerSourceStatus, MapLayerSourceValidation, ValidateSourceArgs } from "../../../tile/internal";
+/** @packageDocumentation
+ * @module Tiles
+ */
+/**
+ * Class representing an ArcGIS error code.
+ * @internal
+ */
+export declare enum ArcGisErrorCode {
+    InvalidCredentials = 401,
+    MissingPermissions = 403,
+    InvalidToken = 498,
+    TokenRequired = 499,
+    UnknownError = 1000,
+    NoTokenService = 1001
+}
+/**
+ * Class representing an ArcGIS service metadata.
+ * @internal
+ */
+export interface ArcGISServiceMetadata {
+    /** JSON content from the service */
+    content: any;
+    /** Indicates if an access token is required to access the service */
+    accessTokenRequired: boolean;
+}
+/** Arguments for validating ArcGIS sources * @internal
+ */
+export interface ArcGisValidateSourceArgs extends ValidateSourceArgs {
+    /** List of capabilities 'keyword' that needs to be advertised in the service's metadata in order to be valid.  For example: 'Map', 'Query', etc*/
+    capabilitiesFilter: string[];
+}
+/** Arguments for fetching service metadata * @internal
+ */
+export interface ArcGisGetServiceJsonArgs {
+    url: string;
+    formatId: string;
+    userName?: string;
+    password?: string;
+    queryParams?: {
+        [key: string]: string;
+    };
+    ignoreCache?: boolean;
+    requireToken?: boolean;
+}
+/**
+ * Class containing utilities relating to ArcGIS services and coordinate systems.
+ * @internal
+ */
+export declare class ArcGisUtilities {
+    private static getBBoxString;
+    static getNationalMapSources(): Promise<MapLayerSource[]>;
+    static getServiceDirectorySources(url: string, baseUrl?: string): Promise<MapLayerSource[]>;
+    /**
+     * Get map layer sources from an ArcGIS query.
+     * @param range Range for the query.
+     * @param url URL for the query.
+     * @returns List of map layer sources.
+     */
+    static getSourcesFromQuery(range?: MapCartoRectangle, url?: string): Promise<MapLayerSource[]>;
+    /**
+     * Parse the URL to check if it represents a valid ArcGIS service
+     * @param url URL to validate.
+     * @param serviceType Service type to validate (i.e FeatureServer, MapServer)
+     * @return Validation Status.
+     */
+    static validateUrl(url: string, serviceType: string): MapLayerSourceStatus;
+    /**
+     * Attempt to access an ArcGIS service, and validate its service metadata.
+     * @param source Source to validate.
+     * @param opts Validation options
+    */
+    static validateSource(args: ArcGisValidateSourceArgs): Promise<MapLayerSourceValidation>;
+    /** Validate MapService tiling metadata and checks if the tile tree is 'Google Maps' compatible. */
+    static isEpsg3857Compatible(tileInfo: any): boolean;
+    private static _serviceCache;
+    /**
+     * Fetches an ArcGIS service metadata, and returns its JSON representation.
+     * If an access client has been configured for the specified formatId,
+     * it will be used to apply required security token.
+     * By default, response for each URL are cached.
+     * @param url URL of the ArcGIS service
+     * @param formatId Format ID of the service
+     * @param userName Username to use for legacy token based security
+     * @param password Password to use for legacy token based security
+     * @param ignoreCache Flag to skip cache lookup (i.e. force a new server request)
+     * @param requireToken Flag to indicate if a token is required
+     */
+    static getServiceJson(args: ArcGisGetServiceJsonArgs): Promise<ArcGISServiceMetadata | undefined>;
+    /** Read a response from ArcGIS server and check for error code in the response. */
+    static checkForResponseErrorCode(response: Response): Promise<number | undefined>;
+    static appendSecurityToken(url: URL, accessClient: MapLayerAccessClient, accessTokenParams: MapLayerAccessTokenParams): Promise<MapLayerAccessToken | undefined>;
+    /**
+     * Compute scale, resolution values for requested zoom levels (WSG 84)
+     * Use a scale of 96 dpi for Google Maps scales
+     * Based on this article: https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames#Resolution_and_Scale
+     * @param startZoom Zoom level where scales begins to be computed
+     * @param endZoom Zoom level where scales ends to be computed
+     * @param latitude Latitude in degrees to use to compute scales (i.e 0 for Equator)
+     * @param tileSize Size of a tile in pixels (i.e 256)
+     * @param screenDpi Monitor resolution in dots per inch (i.e. typically 96dpi is used by Google Maps)
+     * @returns An array containing resolution and scale values for each requested zoom level
+     */
+    static computeZoomLevelsScales(startZoom?: number, endZoom?: number, latitude?: number, tileSize?: number, screenDpi?: number): {
+        zoom: number;
+        resolution: number;
+        scale: number;
+    }[];
+    /**
+     * Match the provided minScale, maxScale values to corresponding wgs84 zoom levels
+     * @param defaultMaxLod Value of the last LOD (i.e 22)
+     * @param tileSize Size of a tile in pixels (i.e 256)
+     * @param minScale Minimum scale value that needs to be matched to a LOD level
+     * @param maxScale Maximum  scale value that needs to be matched to a LOD level
+     * @returns minLod: LOD value matching minScale,  maxLod: LOD value matching maxScale
+     */
+    static getZoomLevelsScales(defaultMaxLod: number, tileSize: number, minScale?: number, maxScale?: number, tolerance?: number): {
+        minLod?: number;
+        maxLod?: number;
+    };
+}
+//# sourceMappingURL=ArcGisUtilities.d.ts.map

package/lib/cjs/internal/tile/map/ArcGisUtilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArcGisUtilities.d.ts","sourceRoot":"","sources":["../../../../../src/internal/tile/map/ArcGisUtilities.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,cAAc,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,kBAAkB,EAAC,MAAM,wBAAwB,CAAC;AAIpN;;GAEG;AAEH;;;GAGG;AACH,oBAAY,eAAe;IACzB,kBAAkB,MAAM;IACxB,kBAAkB,MAAM;IACxB,YAAY,MAAM;IAClB,aAAa,MAAM;IACnB,YAAY,OAAO;IACnB,cAAc,OAAO;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,oCAAoC;IACpC,OAAO,EAAE,GAAG,CAAC;IAEb,qEAAqE;IACrE,mBAAmB,EAAE,OAAO,CAAC;CAC9B;AAED;GACG;AACH,MAAM,WAAW,wBAAyB,SAAQ,kBAAkB;IAClE,kJAAkJ;IAClJ,kBAAkB,EAAE,MAAM,EAAE,CAAC;CAC9B;AAED;GACG;AACH,MAAM,WAAW,wBAAwB;IACvC,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAC,CAAC;IACtC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;GAGG;AACH,qBAAa,eAAe;IAE1B,OAAO,CAAC,MAAM,CAAC,aAAa;WAOR,qBAAqB,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;WA4BlD,0BAA0B,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IA4BxG;;;;;OAKG;WACiB,mBAAmB,CAAC,KAAK,CAAC,EAAE,iBAAiB,EAAE,GAAG,SAAqD,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAqBvJ;;;;;OAKG;WACW,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,oBAAoB;IAcjF;;;;MAIE;WACkB,cAAc,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAoDrG,mGAAmG;WACrF,oBAAoB,CAAC,QAAQ,EAAE,GAAG;IAQhD,OAAO,CAAC,MAAM,CAAC,aAAa,CAAsD;IAElF;;;;;;;;;;;OAWG;WAEiB,cAAc,CAAC,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,qBAAqB,GAAC,SAAS,CAAC;IAoE5G,mFAAmF;WAC/D,yBAAyB,CAAC,QAAQ,EAAE,QAAQ;WAoB5C,mBAAmB,CAAC,GAAG,EAAE,GAAG,EAAE,YAAY,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,yBAAyB,GAAG,OAAO,CAAC,mBAAmB,GAAC,SAAS,CAAC;IAgB3K;;;;;;;;;;OAUG;WACW,uBAAuB,CAAC,SAAS,GAAE,MAAU,EAAE,OAAO,GAAE,MAAW,EAAE,QAAQ,GAAE,MAAU,EAAE,QAAQ,GAAE,MAAY,EAAE,SAAS,SAAK,GAAG;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAC,EAAE;IAoBrM;;;;;;;OAOG;WACW,mBAAmB,CAAE,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,SAAS,GAAE,MAAU,GAAG;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAC;CA0B7K"}