@here/olp-sdk-dataservice-read 2.0.0 → 3.1.0

package/lib/client/VersionedLayerClient.d.ts

@@ -1,6 +1,10 @@
 import { HRN, OlpClientSettings } from "@here/olp-sdk-core";
 import { MetadataApi, QueryApi } from "@here/olp-sdk-dataservice-api";
-import { DataRequest, PartitionsRequest, QuadKeyPartitionsRequest, TileRequest } from "@here/olp-sdk-dataservice-read";
+import { TileResponse } from "../utils/getTile";
+import { DataRequest } from "./DataRequest";
+import { PartitionsRequest } from "./PartitionsRequest";
+import { QuadKeyPartitionsRequest } from "./QuadKeyPartitionsRequest";
+import { TileRequest } from "./TileRequest";
 /**
  * Parameters for use to initialize VersionLayerClient.
  */
@@ -52,6 +56,46 @@ export declare class VersionedLayerClient {
      * @return Tile data (if it exists) or the nearest parent tile data
      */
     getAggregatedData(request: TileRequest, abortSignal?: AbortSignal): Promise<Response>;
+    /**
+     * @brief Fetches data of a tile or its closest ancestor.
+     * Use this API for tile-tree structures where children tile data is aggregated and stored in parent tiles.
+     *
+     * @param request The `TileRequest` instance that contains a complete set
+     * of request parameters.
+     * @param abortSignal A signal object that allows you to communicate with a request (such as the `fetch` request)
+     * and, if required, abort it using the `AbortController` object.
+     * @param options An optional object that can include the `includeTileKey` flag to indicate whether the parent tile key should be included in the response.
+     *
+     * For more information, see the [`AbortController` documentation](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
+     *
+     * @return Tile data (if it exists) or the nearest parent tile data including the parent tile key
+     */
+    getAggregatedData(request: TileRequest, abortSignal: AbortSignal | undefined, options: {
+        includeTileKey: true;
+    }): Promise<TileResponse>;
+    /**
+     * @brief Fetches data of a tile or its closest ancestor.
+     *
+     * Same as the two-argument `getAggregatedData`, for callers that pass an
+     * options object with `includeTileKey` disabled or omitted.
+     *
+     * @return Tile data (if it exists) or the nearest parent tile data
+     */
+    getAggregatedData(request: TileRequest, abortSignal: AbortSignal | undefined, options: {
+        includeTileKey?: false;
+    }): Promise<Response>;
+    /**
+     * @brief Fetches data of a tile or its closest ancestor.
+     *
+     * Same as the two-argument `getAggregatedData`, for an `includeTileKey`
+     * flag whose value is only known at run time. Narrow the result before
+     * using it.
+     *
+     * @return A `TileResponse` if the flag was `true`, otherwise the tile data
+     */
+    getAggregatedData(request: TileRequest, abortSignal: AbortSignal | undefined, options: {
+        includeTileKey?: boolean;
+    }): Promise<Response | TileResponse>;
     /**
      * Fetches partition data using one of the following methods: ID, quadkey, or data handle.
      *

package/lib/client/VersionedLayerClient.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Copyright (C) 2019-2021 HERE Europe B.V.
+ * Copyright (C) 2019-2026 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.
@@ -17,31 +17,41 @@
  * 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.VersionedLayerClient = 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");
+const MetadataCacheRepository_1 = require("../cache/MetadataCacheRepository");
+const getTile_1 = require("../utils/getTile");
+const PartitionsRequest_1 = require("./PartitionsRequest");
+const QuadKeyPartitionsRequest_1 = require("./QuadKeyPartitionsRequest");
+const QuadTreeIndexRequest_1 = require("./QuadTreeIndexRequest");
+const QueryClient_1 = require("./QueryClient");
 /**
  * Describes a versioned layer and provides the possibility to get partitions metadata and data.
  */
 class VersionedLayerClient {
+    apiVersion = "v1";
+    /**
+     * HRN of the catalog.
+     */
+    hrn;
+    /**
+     * The ID of the layer.
+     */
+    layerId;
+    /**
+     * The [[OlpClientSettings]] instance.
+     */
+    settings;
+    // Layer version.
+    version;
     /**
      * Creates the [[VersionedLayerClient]] instance with VersionedLayerClientParams.
      *
      * @param params parameters for use to initialize VersionLayerClient.
      */
     constructor(params) {
-        this.apiVersion = "v1";
         this.hrn = params.catalogHrn.toString();
         this.layerId = params.layerId;
         this.settings = params.settings;
@@ -49,34 +59,22 @@ class VersionedLayerClient {
             this.version = params.version;
         }
     }
-    /**
-     * @brief Fetches data of a tile or its closest ancestor.
-     * Use this API for tile-tree structures where children tile data is aggregated and stored in parent tiles.
-     *
-     * @param request The `TileRequest` instance that contains a complete set
-     * of request parameters.
-     * @param abortSignal A signal object that allows you to communicate with a request (such as the `fetch` request)
-     * and, if required, abort it using the `AbortController` object.
-     *
-     * For more information, see the [`AbortController` documentation](https://developer.mozilla.org/en-US/docs/Web/API/AbortController).
-     *
-     * @return Tile data (if it exists) or the nearest parent tile data
-     */
-    getAggregatedData(request, abortSignal) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let catalogVersion = this.version;
-            if (catalogVersion === undefined) {
-                catalogVersion = yield this.getLatestVersion(request.getBillingTag());
-            }
-            const params = {
-                catalogHrn: olp_sdk_core_1.HRN.fromString(this.hrn),
-                layerId: this.layerId,
-                layerType: "versioned",
-                settings: this.settings,
-                catalogVersion
-            };
-            return olp_sdk_dataservice_read_1.getTile(request, params, abortSignal);
+    async getAggregatedData(request, abortSignal, options) {
+        let catalogVersion = this.version;
+        if (catalogVersion === undefined) {
+            catalogVersion = await this.getLatestVersion(request.getBillingTag());
+        }
+        const params = {
+            catalogHrn: olp_sdk_core_1.HRN.fromString(this.hrn),
+            layerId: this.layerId,
+            layerType: "versioned",
+            settings: this.settings,
+            catalogVersion
+        };
+        const tileResponse = await (0, getTile_1.getTile)(request, params, abortSignal, {
+            includeTileKey: true
         });
+        return options?.includeTileKey ? tileResponse : tileResponse.response;
     }
     /**
      * Fetches partition data using one of the following methods: ID, quadkey, or data handle.
@@ -89,84 +87,80 @@ class VersionedLayerClient {
      *
      * @return The data from the requested partition.
      */
-    getData(dataRequest, abortSignal) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const dataHandle = dataRequest.getDataHandle();
-            if (dataHandle) {
-                return this.downloadPartition(dataHandle, abortSignal, dataRequest.getBillingTag());
-            }
-            const partitionId = dataRequest.getPartitionId();
-            if (this.version === undefined) {
-                // fetch the latest version and lock it to the instance.
-                this.version = yield this.getLatestVersion(dataRequest.getBillingTag()).catch(error => Promise.reject(error));
-            }
-            if (this.version === undefined) {
-                return Promise.reject(new Error(`Unable to retrieve latest version. Please provide version to the DataRequest or lock version in the constructor`));
-            }
-            if (partitionId) {
-                const partitionIdDataHandle = yield this.getDataHandleByPartitionId(partitionId, dataRequest.getFetchOption(), dataRequest.getBillingTag()).catch(error => Promise.reject(error));
-                return this.downloadPartition(partitionIdDataHandle, abortSignal, dataRequest.getBillingTag());
-            }
-            return Promise.reject(new Error(`No data provided. Add dataHandle, partitionId or quadKey to the DataRequest object`));
-        });
+    async getData(dataRequest, abortSignal) {
+        const dataHandle = dataRequest.getDataHandle();
+        if (dataHandle) {
+            return this.downloadPartition(dataHandle, abortSignal, dataRequest.getBillingTag());
+        }
+        const partitionId = dataRequest.getPartitionId();
+        if (this.version === undefined) {
+            // fetch the latest version and lock it to the instance.
+            this.version = await this.getLatestVersion(dataRequest.getBillingTag());
+        }
+        if (this.version === undefined) {
+            return Promise.reject(new Error(`Unable to retrieve latest version. Please provide version to the DataRequest or lock version in the constructor`));
+        }
+        if (partitionId) {
+            const partitionIdDataHandle = await this.getDataHandleByPartitionId(partitionId, dataRequest.getFetchOption(), dataRequest.getBillingTag());
+            return this.downloadPartition(partitionIdDataHandle, abortSignal, dataRequest.getBillingTag());
+        }
+        return Promise.reject(new Error(`No data provided. Add dataHandle, partitionId or quadKey to the DataRequest object`));
     }
-    getPartitions(request, abortSignal) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.version === undefined) {
-                // fetch the latest version and lock it to the instance.
-                this.version = yield this.getLatestVersion(request.getBillingTag()).catch(error => Promise.reject(error));
-            }
-            if (this.version === undefined) {
-                return Promise.reject(new Error(`Unable to retrieve latest version. Please provide version to the Request or lock version in the constructor`));
+    async getPartitions(request, abortSignal) {
+        if (this.version === undefined) {
+            // fetch the latest version and lock it to the instance.
+            this.version = await this.getLatestVersion(request.getBillingTag());
+        }
+        if (this.version === undefined) {
+            return Promise.reject(new Error(`Unable to retrieve latest version. Please provide version to the Request or lock version in the constructor`));
+        }
+        if (request instanceof QuadKeyPartitionsRequest_1.QuadKeyPartitionsRequest) {
+            const quadKey = request.getQuadKey();
+            if (!quadKey) {
+                return Promise.reject(new Error("Please provide correct QuadKey"));
             }
-            if (request instanceof olp_sdk_dataservice_read_1.QuadKeyPartitionsRequest) {
-                const quadKey = request.getQuadKey();
-                if (!quadKey) {
-                    return Promise.reject(new Error("Please provide correct QuadKey"));
+            const queryClient = new QueryClient_1.QueryClient(this.settings);
+            const quadTreeIndexRequest = new QuadTreeIndexRequest_1.QuadTreeIndexRequest(olp_sdk_core_1.HRN.fromString(this.hrn), this.layerId, "versioned")
+                .withQuadKey(quadKey)
+                .withVersion(this.version)
+                .withDepth(request.getDepth())
+                .withAdditionalFields(request.getAdditionalFields());
+            return queryClient.fetchQuadTreeIndex(quadTreeIndexRequest, abortSignal);
+        }
+        if (request.getPartitionIds()) {
+            const queryClient = new QueryClient_1.QueryClient(this.settings);
+            return queryClient.getPartitionsById(request, this.layerId, olp_sdk_core_1.HRN.fromString(this.hrn), abortSignal, this.version);
+        }
+        const cache = new MetadataCacheRepository_1.MetadataCacheRepository(this.settings.cache);
+        if (request.getFetchOption() !== olp_sdk_core_1.FetchOptions.OnlineOnly) {
+            const partitions = cache.get(request, this.hrn.toString(), this.layerId, this.version);
+            if (partitions) {
+                const additionalFields = request.getAdditionalFields();
+                let existFields;
+                if (additionalFields) {
+                    existFields = additionalFields.filter((field) => {
+                        return partitions.every((partition) => partition[field] !== undefined);
+                    });
                 }
-                const queryClient = new olp_sdk_dataservice_read_1.QueryClient(this.settings);
-                const quadTreeIndexRequest = new olp_sdk_dataservice_read_1.QuadTreeIndexRequest(olp_sdk_core_1.HRN.fromString(this.hrn), this.layerId, "versioned")
-                    .withQuadKey(quadKey)
-                    .withVersion(this.version)
-                    .withDepth(request.getDepth())
-                    .withAdditionalFields(request.getAdditionalFields());
-                return queryClient.fetchQuadTreeIndex(quadTreeIndexRequest, abortSignal);
-            }
-            if (request.getPartitionIds()) {
-                const queryClient = new olp_sdk_dataservice_read_1.QueryClient(this.settings);
-                return queryClient.getPartitionsById(request, this.layerId, olp_sdk_core_1.HRN.fromString(this.hrn), abortSignal, this.version);
-            }
-            const cache = new olp_sdk_dataservice_read_1.MetadataCacheRepository(this.settings.cache);
-            if (request.getFetchOption() !== olp_sdk_core_1.FetchOptions.OnlineOnly) {
-                const partitions = cache.get(request, this.hrn.toString(), this.layerId, this.version);
-                if (partitions) {
-                    const additionalFields = request.getAdditionalFields();
-                    let existFields;
-                    if (additionalFields) {
-                        existFields = additionalFields.filter((field) => {
-                            return partitions.every(partition => partition[field] !== undefined);
-                        });
-                    }
-                    if (!additionalFields ||
-                        !existFields ||
-                        additionalFields.length === existFields.length) {
-                        return Promise.resolve({ partitions });
-                    }
+                if (!additionalFields ||
+                    !existFields ||
+                    additionalFields.length === existFields.length) {
+                    return Promise.resolve({ partitions });
                 }
             }
-            const metaRequestBilder = yield this.getRequestBuilder("metadata", olp_sdk_core_1.HRN.fromString(this.hrn), abortSignal).catch(error => Promise.reject(error));
-            const metadata = yield olp_sdk_dataservice_api_1.MetadataApi.getPartitions(metaRequestBilder, {
-                version: this.version,
-                layerId: this.layerId,
-                additionalFields: request.getAdditionalFields(),
-                billingTag: request.getBillingTag()
-            }).catch(error => Promise.reject(error));
-            if (request.getFetchOption() !== olp_sdk_core_1.FetchOptions.OnlineOnly &&
-                metadata.partitions.length) {
-                cache.put(request, this.hrn.toString(), this.layerId, metadata.partitions, this.version);
-            }
-            return Promise.resolve(metadata);
+        }
+        const metaRequestBilder = await this.getRequestBuilder("metadata", olp_sdk_core_1.HRN.fromString(this.hrn), abortSignal);
+        const metadata = await olp_sdk_dataservice_api_1.MetadataApi.getPartitions(metaRequestBilder, {
+            version: this.version,
+            layerId: this.layerId,
+            additionalFields: request.getAdditionalFields(),
+            billingTag: request.getBillingTag()
         });
+        if (request.getFetchOption() !== olp_sdk_core_1.FetchOptions.OnlineOnly &&
+            metadata.partitions.length) {
+            cache.put(request, this.hrn.toString(), this.layerId, metadata.partitions, this.version);
+        }
+        return Promise.resolve(metadata);
     }
     /**
      * Fetch and returns partition metadata
@@ -175,44 +169,38 @@ class VersionedLayerClient {
      * @param fetchOption The option of caching (online only or return from cache if exist)
      * @returns A promise of partition metadata which used to get partition data
      */
-    getDataHandleByPartitionId(partitionId, fetchOption, billingTag) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const queryClient = new olp_sdk_dataservice_read_1.QueryClient(this.settings);
-            const partitionsRequest = new olp_sdk_dataservice_read_1.PartitionsRequest()
-                .withPartitionIds([partitionId])
-                .withFetchOption(fetchOption);
-            if (billingTag) {
-                partitionsRequest.withBillingTag(billingTag);
-            }
-            const metadata = yield queryClient.getPartitionsById(partitionsRequest, this.layerId, olp_sdk_core_1.HRN.fromString(this.hrn), undefined, this.version);
-            return metadata.partitions &&
-                metadata.partitions[0] &&
-                metadata.partitions[0].dataHandle
-                ? metadata.partitions[0].dataHandle
-                : Promise.reject(new olp_sdk_core_1.HttpError(olp_sdk_core_1.STATUS_CODES.NOT_FOUND, `No partition dataHandle for partition ${partitionId}. HRN: ${this.hrn}`));
-        });
+    async getDataHandleByPartitionId(partitionId, fetchOption, billingTag) {
+        const queryClient = new QueryClient_1.QueryClient(this.settings);
+        const partitionsRequest = new PartitionsRequest_1.PartitionsRequest()
+            .withPartitionIds([partitionId])
+            .withFetchOption(fetchOption);
+        if (billingTag) {
+            partitionsRequest.withBillingTag(billingTag);
+        }
+        const metadata = await queryClient.getPartitionsById(partitionsRequest, this.layerId, olp_sdk_core_1.HRN.fromString(this.hrn), undefined, this.version);
+        return metadata.partitions &&
+            metadata.partitions[0] &&
+            metadata.partitions[0].dataHandle
+            ? metadata.partitions[0].dataHandle
+            : Promise.reject(new olp_sdk_core_1.HttpError(olp_sdk_core_1.STATUS_CODES.NOT_FOUND, `No partition dataHandle for partition ${partitionId}. HRN: ${this.hrn}`));
     }
     /**
      * Gets the latest available catalog version what can be used as latest layer version
      */
-    getLatestVersion(billingTag) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const builder = yield this.getRequestBuilder("metadata", olp_sdk_core_1.HRN.fromString(this.hrn)).catch(error => Promise.reject(error));
-            const latestVersion = yield olp_sdk_dataservice_api_1.MetadataApi.latestVersion(builder, {
-                startVersion: -1,
-                billingTag
-            }).catch(error => Promise.reject(error));
-            return Promise.resolve(latestVersion.version);
+    async getLatestVersion(billingTag) {
+        const builder = await this.getRequestBuilder("metadata", olp_sdk_core_1.HRN.fromString(this.hrn));
+        const latestVersion = await olp_sdk_dataservice_api_1.MetadataApi.latestVersion(builder, {
+            startVersion: -1,
+            billingTag
         });
+        return Promise.resolve(latestVersion.version);
     }
-    downloadPartition(dataHandle, abortSignal, billingTag) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const builder = yield this.getRequestBuilder("blob", olp_sdk_core_1.HRN.fromString(this.hrn), abortSignal).catch(error => Promise.reject(error));
-            return olp_sdk_dataservice_api_1.BlobApi.getBlob(builder, {
-                dataHandle,
-                layerId: this.layerId,
-                billingTag
-            });
+    async downloadPartition(dataHandle, abortSignal, billingTag) {
+        const builder = await this.getRequestBuilder("blob", olp_sdk_core_1.HRN.fromString(this.hrn), abortSignal);
+        return olp_sdk_dataservice_api_1.BlobApi.getBlob(builder, {
+            dataHandle,
+            layerId: this.layerId,
+            billingTag
         });
     }
     /**
@@ -221,10 +209,8 @@ class VersionedLayerClient {
      *
      * @returns requestBuilder
      */
-    getRequestBuilder(builderType, hrn, abortSignal) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return olp_sdk_core_1.RequestFactory.create(builderType, this.apiVersion, this.settings, hrn, abortSignal);
-        });
+    async getRequestBuilder(builderType, hrn, abortSignal) {
+        return olp_sdk_core_1.RequestFactory.create(builderType, this.apiVersion, this.settings, hrn, abortSignal);
     }
 }
 exports.VersionedLayerClient = VersionedLayerClient;

package/lib/client/VolatileLayerClient.d.ts

@@ -1,6 +1,9 @@
 import { HRN, OlpClientSettings } from "@here/olp-sdk-core";
 import { MetadataApi, QueryApi } from "@here/olp-sdk-dataservice-api";
-import { DataRequest, PartitionsRequest, QuadKeyPartitionsRequest, TileRequest } from "@here/olp-sdk-dataservice-read";
+import { DataRequest } from "./DataRequest";
+import { PartitionsRequest } from "./PartitionsRequest";
+import { QuadKeyPartitionsRequest } from "./QuadKeyPartitionsRequest";
+import { TileRequest } from "./TileRequest";
 /**
  * Parameters for use to initialize VolatileLayerClient.
  */