@here/olp-sdk-dataservice-read 1.12.2 → 1.13.0

package/lib/utils/getTile.js

@@ -1,166 +0,0 @@
-"use strict";
-/*
- * Copyright (C) 2020-2021 HERE Europe B.V.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- * SPDX-License-Identifier: Apache-2.0
- * License-Filename: LICENSE
- */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetchQuadTreeIndex = exports.getTile = void 0;
-const olp_sdk_core_1 = require("@here/olp-sdk-core");
-const olp_sdk_dataservice_api_1 = require("@here/olp-sdk-dataservice-api");
-const olp_sdk_dataservice_read_1 = require("@here/olp-sdk-dataservice-read");
-/**
- * Fetches asynchronously data from a tile or from its nearest ancestor if not found.
- *
- * The tile is a geometric area represented as a HERE tile.
- * The quad tree metadata fetches the blob of needed tile from the HERE Query Service,
- * then caches it, and returns to the user.
- * To disable caching of metadata use `request.withFetchOption(FetchOptions.OnlineOnly)`.
- *
- * @param request Requests the [[TileRequest]] instance with the configured parameters.
- * @see [[TileRequest]]
- *
- * @param abortSignal The signal object that allows you to communicate with a request (such as the `fetch` request)
- * and, if required, abort it using the `AbortController` object.
- * @see the [`AbortController` documentation](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
- *
- * @example
- *
- * ```
- *  const params: GetTileParams = {
- *       settings: "% your `OlpClientSettings` instance % ",
- *       catalogHrn: "% the HRN instance of your catalog %",
- *       layerId: "% your layer ID %",
- *       layerType: "% versioned or volatile %",
- *   }
- *
- *  const request = new TileRequest();
- *
- *  const tile1 = await getTile(request.withTileKey(yourTileKey1), params);
- *  const tile2 = await getTile(request.withTileKey(yourTileKey2), params);
- *
- * ```
- *
- * @returns The blob of the requested tile or the blob of the closest parent Tile.
- */
-function getTile(request, params, abortSignal) {
-    return __awaiter(this, void 0, void 0, function* () {
-        let catalogVersion;
-        const quadKey = request.getTileKey();
-        if (!quadKey) {
-            return Promise.reject(new Error("Please provide correct QuadKey"));
-        }
-        if (params.layerType === "versioned") {
-            catalogVersion = params.catalogVersion;
-        }
-        const blobType = params.layerType === "versioned" ? "blob" : "volatile-blob";
-        const blobRequestBuilder = yield olp_sdk_core_1.RequestFactory.create(blobType, "v1", params.settings, params.catalogHrn, abortSignal).catch(error => Promise.reject(error));
-        const delta = 4;
-        const requestedTileKey = olp_sdk_core_1.TileKey.fromRowColumnLevel(quadKey.row, quadKey.column, quadKey.level);
-        let quadTreeIndex = null;
-        if (request.getFetchOption() !== olp_sdk_core_1.FetchOptions.OnlineOnly) {
-            const cache = new olp_sdk_dataservice_read_1.QuadTreeIndexCacheRepository(params.settings.cache);
-            for (let i = 1; i <= delta; i++) {
-                const parentInCache = requestedTileKey.changedLevelBy(-i);
-                const cachedTree = cache.get({
-                    hrn: params.catalogHrn.toString(),
-                    layerId: params.layerId,
-                    depth: delta,
-                    root: parentInCache,
-                    version: catalogVersion
-                });
-                if (cachedTree) {
-                    quadTreeIndex = cachedTree;
-                }
-            }
-        }
-        const parentTileKey = requestedTileKey.changedLevelBy(-delta);
-        if (!quadTreeIndex) {
-            quadTreeIndex = yield fetchQuadTreeIndex(Object.assign(Object.assign({}, params), { catalogVersion, depth: delta, fetchOptions: request.getFetchOption(), tileKey: parentTileKey, abortSignal, billingTag: request.getBillingTag() })).catch(e => Promise.reject(e));
-        }
-        if (!quadTreeIndex.subQuads || !quadTreeIndex.subQuads.length) {
-            return Promise.resolve(new Response("No Content", {
-                status: 204,
-                statusText: "No Content"
-            }));
-        }
-        // Return the data for the requested QuadKey or for the closest parent
-        const subQuads = quadTreeIndex.subQuads;
-        let currentTileKey = requestedTileKey;
-        let currentDelta = delta;
-        for (let level = currentTileKey.level; level >= parentTileKey.level; --level) {
-            const metadata = subQuads.find(item => item.subQuadKey === currentTileKey.getSubHereTile(currentDelta));
-            if (metadata) {
-                return olp_sdk_dataservice_api_1.BlobApi.getBlob(blobRequestBuilder, {
-                    dataHandle: metadata.dataHandle,
-                    layerId: params.layerId,
-                    billingTag: request.getBillingTag()
-                });
-            }
-            try {
-                currentTileKey = currentTileKey.parent();
-                currentDelta = parentTileKey.level - currentTileKey.level;
-            }
-            catch (error) {
-                continue;
-            }
-        }
-        return Promise.reject(new Error(`Error getting blob for Tile: ${JSON.stringify(quadKey)}`));
-    });
-}
-exports.getTile = getTile;
-/**
- * The function should request quad tree index for the parent tile with delta 4
- * and cache the responses in cache for later calls.
- * @hidden
- */
-function fetchQuadTreeIndex(params) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const cache = new olp_sdk_dataservice_read_1.QuadTreeIndexCacheRepository(params.settings.cache);
-        const queryClient = new olp_sdk_dataservice_read_1.QueryClient(params.settings);
-        const quadTreeIndexRequest = new olp_sdk_dataservice_read_1.QuadTreeIndexRequest(params.catalogHrn, params.layerId, params.layerType)
-            .withQuadKey(params.tileKey)
-            .withDepth(params.depth);
-        if (params.layerType === "versioned") {
-            quadTreeIndexRequest.withVersion(params.catalogVersion);
-        }
-        const quadTreeIndex = yield queryClient
-            .fetchQuadTreeIndex(quadTreeIndexRequest, params.abortSignal)
-            .catch(err => Promise.reject(err));
-        if (params.fetchOptions !== olp_sdk_core_1.FetchOptions.OnlineOnly &&
-            quadTreeIndex.subQuads) {
-            cache.put({
-                hrn: params.catalogHrn.toString(),
-                layerId: params.layerId,
-                depth: params.depth,
-                root: params.tileKey,
-                tree: quadTreeIndex,
-                version: params.catalogVersion
-            });
-        }
-        return Promise.resolve(quadTreeIndex);
-    });
-}
-exports.fetchQuadTreeIndex = fetchQuadTreeIndex;

package/lib/utils/index.js

@@ -1,33 +0,0 @@
-"use strict";
-/*
- * Copyright (C) 2019-2021 HERE Europe B.V.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- * SPDX-License-Identifier: Apache-2.0
- * License-Filename: LICENSE
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./validateBillingTag"), exports);
-__exportStar(require("./validatePartitionsIdsList"), exports);
-__exportStar(require("./getTile"), exports);

package/lib/utils/validateBillingTag.js

@@ -1,37 +0,0 @@
-"use strict";
-/*
- * Copyright (C) 2019 HERE Europe B.V.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- * SPDX-License-Identifier: Apache-2.0
- * License-Filename: LICENSE
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateBillingTag = void 0;
-/**
- * Validates the billinig tag.
- *
- * It must be 4–16 characters long and contain only alphanumeric ASCII characters [A-Za-z0-9].
- *
- * @param tag The string that represents the billing tag.
- * @return The billing tag if it's valid. Otherwise, throws an error.
- */
-function validateBillingTag(tag) {
-    const pattern = /^[A-Za-z0-9_-]{4,16}$/;
-    if (!pattern.test(tag)) {
-        throw new Error("The billing tag must be between 4 - 16 characters, contain only alpha/numeric ASCII characters [A-Za-z0-9]");
-    }
-    return tag;
-}
-exports.validateBillingTag = validateBillingTag;

package/lib/utils/validatePartitionsIdsList.js

@@ -1,38 +0,0 @@
-"use strict";
-/*
- * Copyright (C) 2019 HERE Europe B.V.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- * SPDX-License-Identifier: Apache-2.0
- * License-Filename: LICENSE
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validatePartitionsIdsList = void 0;
-/**
- * Validates a list of partitions IDs.
- *
- * It must be between 1–100 items.
- *
- * @param list The lists of strings that represent the partitions IDs.
- * @returns The list of strings if it's valid. Otherwise, throws an error.
- */
-function validatePartitionsIdsList(list) {
-    const LIST_MAX_LENGTH = 100;
-    const length = list.length;
-    if (length < 1 || length > LIST_MAX_LENGTH) {
-        throw new Error("The partition ids quantity must be between 1 - 100");
-    }
-    return list;
-}
-exports.validatePartitionsIdsList = validatePartitionsIdsList;