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

package/lib/cache/MetadataCacheRepository.d.ts

@@ -13,28 +13,12 @@ export declare class MetadataCacheRepository {
      * @return The [[MetadataCacheRepository]] instance.
      */
     constructor(cache: KeyValueCache);
-    /**
-     * @deprecated This signature will be removed by 05.2021. Please set the version as the last argument.
-     * Stores a key-value pair in the cache.
-     *
-     * @return True if the operation is successful, false otherwise.
-     */
-    put(rq: PartitionsRequest, hrn: string, layerId: string, partitions: MetadataApi.Partition[]): boolean;
     /**
      * Stores a key-value pair in the cache.
      *
      * @return True if the operation is successful, false otherwise.
      */
     put(rq: PartitionsRequest, hrn: string, layerId: string, partitions: MetadataApi.Partition[], version?: number): boolean;
-    /**
-     * @deprecated This signature will be removed by 05.2021. Please set the version as the last argument.
-     * Gets a metadata from the cache.
-     *
-     * @param service The name of the API service for which you want to get the base URL.
-     * @param serviceVersion The service version.
-     * @return The base URL of the service, or undefined if the base URL does not exist.
-     */
-    get(rq: PartitionsRequest, hrn: string, layerId: string): MetadataApi.Partition[] | undefined;
     /**
      * Gets a metadata from the cache.
      *

package/lib/cache/MetadataCacheRepository.js

@@ -32,6 +32,11 @@ class MetadataCacheRepository {
     constructor(cache) {
         this.cache = cache;
     }
+    /**
+     * Stores a key-value pair in the cache.
+     *
+     * @return True if the operation is successful, false otherwise.
+     */
     put(rq, hrn, layerId, partitions, version) {
         const partitionsIds = rq.getPartitionIds();
         let key;
@@ -40,7 +45,7 @@ class MetadataCacheRepository {
                 key = this.createKey({
                     hrn,
                     layerId,
-                    version: version !== undefined ? version : rq.getVersion(),
+                    version,
                     partitionId: metadata.partition
                 });
                 this.cache.put(key, JSON.stringify(metadata));
@@ -50,7 +55,7 @@ class MetadataCacheRepository {
         key = this.createKey({
             hrn,
             layerId,
-            version: version !== undefined ? version : rq.getVersion()
+            version
         });
         return this.cache.put(key, JSON.stringify(partitions));
     }
@@ -63,7 +68,7 @@ class MetadataCacheRepository {
                 key = this.createKey({
                     hrn,
                     layerId,
-                    version: version !== undefined ? version : rq.getVersion(),
+                    version,
                     partitionId
                 });
                 const serializedPartition = this.cache.get(key);
@@ -85,7 +90,7 @@ class MetadataCacheRepository {
         key = this.createKey({
             hrn,
             layerId,
-            version: version !== undefined ? version : rq.getVersion()
+            version
         });
         const serializedPartitions = this.cache.get(key);
         return serializedPartitions

package/lib/client/ArtifactClient.d.ts

@@ -20,7 +20,7 @@ export declare class ArtifactClient {
      * @param schemaDetailsRequest The [[SchemaDetailsRequest]] instance.
      * @return An object with the schema metadata.
      */
-    getSchemaDetails(schemaDetailsRequest: SchemaDetailsRequest): Promise<ArtifactApi.GetSchemaResponse>;
+    getSchemaDetails(schemaDetailsRequest: SchemaDetailsRequest): Promise<ArtifactApi.GetSchemaResponse | ArtifactApi.GetSchemaResponseObj>;
     /**
      * Gets schema data.
      *

package/lib/client/PartitionsRequest.d.ts

@@ -9,26 +9,6 @@ export declare class PartitionsRequest {
     private partitionIds?;
     private additionalFields?;
     private fetchOption;
-    /**
-     * This method is @deprecated and will be removed by 04.2021. If you need to set the version,
-     * initialize the version client with the new constructor. Otherwise, the latest version will be used.
-     *
-     * Gets a layer version for the request.
-     *
-     * @return The layer version number.
-     */
-    getVersion(): number | undefined;
-    /**
-     * This method is @deprecated and will be removed by 04.2021. If you need to set the version,
-     * initialize the version client with the new constructor. Otherwise, the latest version will be used.
-     *
-     * An optional method that sets the provided layer version.
-     * If the layer version is not specified, the last layer version is used.
-     *
-     * @param version Specify the layer version or, if you want to use the latest layer version, set to undefined.
-     * @returns The updated [[PartitionsRequest]] instance that you can use to chain methods.
-     */
-    withVersion(version?: number): PartitionsRequest;
     /**
      * An optional free-form tag that is used for grouping billing records together.
      *

package/lib/client/PartitionsRequest.js

@@ -28,31 +28,6 @@ class PartitionsRequest {
     constructor() {
         this.fetchOption = olp_sdk_core_1.FetchOptions.OnlineIfNotFound;
     }
-    /**
-     * This method is @deprecated and will be removed by 04.2021. If you need to set the version,
-     * initialize the version client with the new constructor. Otherwise, the latest version will be used.
-     *
-     * Gets a layer version for the request.
-     *
-     * @return The layer version number.
-     */
-    getVersion() {
-        return this.version;
-    }
-    /**
-     * This method is @deprecated and will be removed by 04.2021. If you need to set the version,
-     * initialize the version client with the new constructor. Otherwise, the latest version will be used.
-     *
-     * An optional method that sets the provided layer version.
-     * If the layer version is not specified, the last layer version is used.
-     *
-     * @param version Specify the layer version or, if you want to use the latest layer version, set to undefined.
-     * @returns The updated [[PartitionsRequest]] instance that you can use to chain methods.
-     */
-    withVersion(version) {
-        this.version = version;
-        return this;
-    }
     /**
      * An optional free-form tag that is used for grouping billing records together.
      *

package/lib/client/QueryClient.d.ts

@@ -29,7 +29,6 @@ export declare class QueryClient {
      */
     fetchQuadTreeIndex(request: QuadTreeIndexRequest, abortSignal?: AbortSignal): Promise<QueryApi.Index>;
     /**
-     * @deprecated This signature will be removed by 04.2021. Please set the version as the last argument.
      * Gets partitions using their IDs.
      *
      * @param request The `PartitionsRequest` instance.
@@ -42,21 +41,7 @@ export declare class QueryClient {
      *
      * @return The requested partitions.
      */
-    getPartitionsById(request: PartitionsRequest, layerId: string, hrn: HRN, abortSignal?: AbortSignal): Promise<QueryApi.Partitions>;
-    /**
-     * Gets partitions using their IDs.
-     *
-     * @param request The `PartitionsRequest` instance.
-     * @param layerId The ID of the layer from which you want to get partitions.
-     * @param hrn The HERE Resource Name (HRN) of the layer.
-     * @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 The requested partitions.
-     */
-    getPartitionsById(request: PartitionsRequest, layerId: string, hrn: HRN, abortSignal?: AbortSignal, version?: number): Promise<QueryApi.Partitions>;
+    getPartitionsById(request: PartitionsRequest, layerId: string, hrn: HRN, abortSignal?: AbortSignal, catalogVersion?: number): Promise<QueryApi.Partitions>;
     /**
      * Gets the latest available catalog version
      */

package/lib/client/QueryClient.js

@@ -100,18 +100,28 @@ class QueryClient {
             return fetchingQuadTreeIndexFunction(requestBuilder, paramsForFetchQuadTreeIndex);
         });
     }
+    /**
+     * Gets partitions using their IDs.
+     *
+     * @param request The `PartitionsRequest` instance.
+     * @param layerId The ID of the layer from which you want to get partitions.
+     * @param hrn The HERE Resource Name (HRN) of the layer.
+     * @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 The requested partitions.
+     */
     getPartitionsById(request, layerId, hrn, abortSignal, catalogVersion) {
         return __awaiter(this, void 0, void 0, function* () {
             const idsList = request.getPartitionIds();
-            const version = catalogVersion !== undefined
-                ? catalogVersion
-                : request.getVersion();
             if (!idsList) {
                 return Promise.reject("Please provide correct partitionIds list");
             }
             const cache = new olp_sdk_dataservice_read_1.MetadataCacheRepository(this.settings.cache);
             if (request.getFetchOption() !== olp_sdk_core_1.FetchOptions.OnlineOnly) {
-                const cachedPartitions = cache.get(request, hrn.toString(), layerId, version);
+                const cachedPartitions = cache.get(request, hrn.toString(), layerId, catalogVersion);
                 if (cachedPartitions) {
                     return Promise.resolve({
                         partitions: cachedPartitions
@@ -123,7 +133,7 @@ class QueryClient {
                 layerId,
                 partition: idsList,
                 additionalFields: request.getAdditionalFields(),
-                version: version !== undefined ? `${version}` : undefined
+                version: catalogVersion !== undefined ? `${catalogVersion}` : undefined
             }).catch(err => Promise.reject(err));
             if (request.getFetchOption() !== olp_sdk_core_1.FetchOptions.OnlineOnly &&
                 medatada &&
@@ -137,7 +147,7 @@ class QueryClient {
                     partition: partition.partition,
                     version: partition.version
                 }));
-                cache.put(request, hrn.toString(), layerId, partitions, version);
+                cache.put(request, hrn.toString(), layerId, partitions, catalogVersion);
             }
             return Promise.resolve(medatada);
         });

package/lib/client/StreamLayerClient.js

@@ -125,30 +125,32 @@ class StreamLayerClient {
                 .catch(error => Promise.reject(error));
             // Update xCorrelationId
             this.xCorrelationId = consumeResponse.xCorrelationId;
-            // Commit offsets
-            const latestOffsets = consumeResponse.data
-                .map(msg => msg.offset)
-                .reduce((acc, curr) => {
-                acc[curr.partition] =
-                    acc[curr.partition] > curr.offset
-                        ? acc[curr.partition]
-                        : curr.offset;
-                return acc;
-            }, {});
-            yield olp_sdk_dataservice_api_1.StreamApi.doCommitOffsets(requestBuilder, {
-                commitOffsets: {
-                    offsets: Object.keys(latestOffsets).map(key => ({
-                        partition: +key,
-                        offset: latestOffsets[key]
-                    }))
-                },
-                subscriptionId: request.getSubscriptionId(),
-                mode: request.getMode(),
-                layerId: this.layerId,
-                xCorrelationId: this.xCorrelationId
-            }).catch((error) => __awaiter(this, void 0, void 0, function* () {
-                console.log(`Commit offsets unsuccessful, error=${error.message}`);
-            }));
+            if (consumeResponse.data.length > 0) {
+                // Commit offsets
+                const latestOffsets = consumeResponse.data
+                    .map(msg => msg.offset)
+                    .reduce((acc, curr) => {
+                    acc[curr.partition] =
+                        acc[curr.partition] > curr.offset
+                            ? acc[curr.partition]
+                            : curr.offset;
+                    return acc;
+                }, {});
+                yield olp_sdk_dataservice_api_1.StreamApi.doCommitOffsets(requestBuilder, {
+                    commitOffsets: {
+                        offsets: Object.keys(latestOffsets).map(key => ({
+                            partition: +key,
+                            offset: latestOffsets[key]
+                        }))
+                    },
+                    subscriptionId: request.getSubscriptionId(),
+                    mode: request.getMode(),
+                    layerId: this.layerId,
+                    xCorrelationId: this.xCorrelationId
+                }).catch((error) => __awaiter(this, void 0, void 0, function* () {
+                    console.log(`Commit offsets unsuccessful, error=${error.message}`);
+                }));
+            }
             return Promise.resolve(consumeResponse.data);
         });
     }

package/lib/utils/getTile.js

@@ -101,7 +101,10 @@ function getTile(request, params, abortSignal) {
             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.reject(new Error("Error fetching QuadTreeIndex"));
+            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;

package/lib/utils/index.d.ts

@@ -1,4 +1,3 @@
-export * from "./QuadKeyUtils";
 export * from "./validateBillingTag";
 export * from "./validatePartitionsIdsList";
 export * from "./getTile";

package/lib/utils/index.js

@@ -28,7 +28,6 @@ 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("./QuadKeyUtils"), exports);
 __exportStar(require("./validateBillingTag"), exports);
 __exportStar(require("./validatePartitionsIdsList"), exports);
 __exportStar(require("./getTile"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@here/olp-sdk-dataservice-read",
-  "version": "1.9.0",
+  "version": "1.12.2",
   "description": "Wrapper around a subset of the HERE Open Location Platform Data REST API related to reading data from OLP catalogs",
   "main": "index.js",
   "browser": "index.web.js",
@@ -49,8 +49,8 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@here/olp-sdk-core": "^1.4.0",
-    "@here/olp-sdk-dataservice-api": "^1.9.0",
+    "@here/olp-sdk-core": "^1.7.1",
+    "@here/olp-sdk-dataservice-api": "^1.12.2",
     "@here/olp-sdk-fetch": "^1.9.0"
   },
   "devDependencies": {
@@ -72,10 +72,10 @@
     "ts-node": "^8.5.4",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
-    "typedoc": "^0.19.2",
+    "typedoc": "^0.20.25",
     "typescript": "4.0.3",
     "tslib": "1.13.0",
     "webpack": "^4.41.5",
     "webpack-cli": "^3.3.10"
   }
-}
+}

package/lib/utils/QuadKeyUtils.d.ts

@@ -1,18 +0,0 @@
-import { QuadKey } from "@here/olp-sdk-core";
-/**
- * @deprecated This function will be removed by 08.2021.
- * Please use the same method from [[TileKey]] class, imported from `@here/olp-sdk-core` package.
- *
- * Checks if a quadkey is valid.
- *
- * The number of rows and columns must not be greater than the maximum number of rows and columns in the given level.
- * The maximum number of rows and columns in a level is computed as 2 to the power of the level.
- *
- * @note As the JavaScript number type can hold 53 bits in its mantissa, only levels up to 26 can be
- * represented in the number representation returned by [[mortonCodeFromQuadKey]].
- * A level must be positive and can't be greater than 26.
- *
- * @param key The current quadkey.
- * @return True if the quadkey is valid, false otherwise.
- */
-export declare function isValid(key: QuadKey): boolean;

package/lib/utils/QuadKeyUtils.js

@@ -1,48 +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
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isValid = void 0;
-/**
- * @deprecated This function will be removed by 08.2021.
- * Please use the same method from [[TileKey]] class, imported from `@here/olp-sdk-core` package.
- *
- * Checks if a quadkey is valid.
- *
- * The number of rows and columns must not be greater than the maximum number of rows and columns in the given level.
- * The maximum number of rows and columns in a level is computed as 2 to the power of the level.
- *
- * @note As the JavaScript number type can hold 53 bits in its mantissa, only levels up to 26 can be
- * represented in the number representation returned by [[mortonCodeFromQuadKey]].
- * A level must be positive and can't be greater than 26.
- *
- * @param key The current quadkey.
- * @return True if the quadkey is valid, false otherwise.
- */
-function isValid(key) {
-    // tslint:disable-next-line:no-magic-numbers
-    if (key.level < 0 || key.level > 26) {
-        return false;
-    }
-    const dimensionAtLevel = Math.pow(2, key.level);
-    const rowValid = key.row >= 0 && key.row < dimensionAtLevel;
-    const columnValid = key.column >= 0 && key.column < dimensionAtLevel;
-    return rowValid && columnValid;
-}
-exports.isValid = isValid;