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

package/lib/client/DataRequest.js

@@ -1,115 +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.DataRequest = void 0;
-const olp_sdk_core_1 = require("@here/olp-sdk-core");
-const olp_sdk_dataservice_read_1 = require("@here/olp-sdk-dataservice-read");
-/**
- *  Prepares information for calls to get data from the HERE Blob Service.
- */
-class DataRequest {
-    constructor() {
-        this.fetchOption = olp_sdk_core_1.FetchOptions.OnlineIfNotFound;
-    }
-    /**
-     * Gets a data handle for the request.
-     *
-     * The data handle identifies a specific blob so that you can get the contents of that blob.
-     *
-     * @return The `DataHandle` string.
-     */
-    getDataHandle() {
-        return this.dataHandle;
-    }
-    /**
-     * Sets the provided data handle.
-     *
-     * @param dataHandle The `DataHandler` string.
-     * @return The updated [[DataRequest]] instance that you can use to chain methods.
-     */
-    withDataHandle(dataHandle) {
-        this.dataHandle = dataHandle;
-        return this;
-    }
-    /**
-     * Gets a partition ID for the request.
-     *
-     * @return The `partitionID` string.
-     */
-    getPartitionId() {
-        return this.partitionId;
-    }
-    /**
-     * Sets the provided partition ID.
-     *
-     * @param partitionId The `partitionID` string.
-     * @returns The updated [[DataRequest]] instance that you can use to chain methods.
-     */
-    withPartitionId(partitionId) {
-        this.partitionId = partitionId;
-        return this;
-    }
-    /**
-     * An optional free-form tag that is used for grouping billing records together.
-     *
-     * If supplied, it must be 4–16 characters long and contain only alphanumeric ASCII characters [A–Za–z0–9].
-     *
-     * @param tag The `BillingTag` string.
-     * @return The updated [[DataRequest]] instance that you can use to chain methods.
-     */
-    withBillingTag(tag) {
-        this.billingTag = olp_sdk_dataservice_read_1.validateBillingTag(tag);
-        return this;
-    }
-    /**
-     * Gets a billing tag to group billing records together.
-     *
-     * @return The `BillingTag` string.
-     */
-    getBillingTag() {
-        return this.billingTag;
-    }
-    /**
-     * Sets the fetch option that you can use to set the source from
-     * which data should be fetched.
-     *
-     * @see `getFetchOption()` for information on usage and format.
-     *
-     * @param option The `FetchOption` enum.
-     *
-     * @return A reference to the updated `DataRequest` instance.
-     */
-    withFetchOption(option) {
-        this.fetchOption = option;
-        return this;
-    }
-    /**
-     * Gets the fetch option that controls how requests are handled.
-     *
-     * The default option is `OnlineIfNotFound`. It queries the network if
-     * the requested resource is not in the cache.
-     *
-     * @return The fetch option.
-     */
-    getFetchOption() {
-        return this.fetchOption;
-    }
-}
-exports.DataRequest = DataRequest;

package/lib/client/IndexLayerClient.js

@@ -1,111 +0,0 @@
-"use strict";
-/*
- * Copyright (C) 2020 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.IndexLayerClient = void 0;
-const olp_sdk_core_1 = require("@here/olp-sdk-core");
-const olp_sdk_dataservice_api_1 = require("@here/olp-sdk-dataservice-api");
-/**
- * Describes a index layer and provides the possibility to get partitions metadata and data.
- */
-class IndexLayerClient {
-    /**
-     * Creates the [[IndexLayerClient]] instance with IndexLayerClientParams.
-     *
-     * @param params parameters for use to initialize IndexLayerClient.
-     */
-    constructor(params) {
-        this.apiVersion = "v1";
-        this.hrn = params.catalogHrn.toString();
-        this.layerId = params.layerId;
-        this.settings = params.settings;
-    }
-    /**
-     * Fetches all partitions metadata from a layer that match a query from the [[IndexQueryRequest]] instance.
-     *
-     * @param IndexQueryRequest The [[IndexQueryRequest]] instance.
-     * @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).
-     *
-     * @returns A list of metadata for each of the partitions from the requested layer.
-     */
-    getPartitions(request, abortSignal) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const query = request.getQueryString();
-            if (!query) {
-                return Promise.reject(new Error("Please provide correct query"));
-            }
-            const requestBuilder = yield this.getRequestBuilder("index", olp_sdk_core_1.HRN.fromString(this.hrn), abortSignal).catch(err => Promise.reject(err));
-            const indexMetadata = yield olp_sdk_dataservice_api_1.IndexApi.performQuery(requestBuilder, {
-                layerID: this.layerId,
-                query,
-                huge: request.getHugeResponse()
-            }).catch(err => Promise.reject(err));
-            return indexMetadata.data
-                ? Promise.resolve(indexMetadata.data)
-                : Promise.reject(indexMetadata.error);
-        });
-    }
-    /**
-     * Fetches partition data using data handle.
-     *
-     * @param model The data model of partition metadata.
-     * @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 data from the requested partition.
-     */
-    getData(model, abortSignal) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!model.id) {
-                return Promise.reject(new Error("No data handle for this partition"));
-            }
-            const builder = yield this.getRequestBuilder("blob", olp_sdk_core_1.HRN.fromString(this.hrn), abortSignal).catch(err => Promise.reject(err));
-            return olp_sdk_dataservice_api_1.BlobApi.getBlob(builder, {
-                dataHandle: model.id,
-                layerId: this.layerId
-            });
-        });
-    }
-    /**
-     * Fetch baseUrl and create requestBuilder for sending requests to the API Lookup Service.
-     * @param builderType endpoint name is needed to create propriate requestBuilder
-     *
-     * @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).catch(err => Promise.reject(err));
-        });
-    }
-}
-exports.IndexLayerClient = IndexLayerClient;

package/lib/client/IndexQueryRequest.js

@@ -1,63 +0,0 @@
-"use strict";
-/*
- * Copyright (C) 2020 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.IndexQueryRequest = void 0;
-/**
- * Prepares information for calls to get partitions metadata from the platform Index Service.
- */
-class IndexQueryRequest {
-    /**
-     * @param query An RSQL query to use to retrieve partitions that match the query.
-     * The query must use the indexing attributes defined in the index layer.
-     * @returns The updated [[IndexQueryRequest]] instance that you can use to chain methods.
-     */
-    withQueryString(query) {
-        this.queryString = query;
-        return this;
-    }
-    /**
-     * A setter for the provided isHugeResponse parameter.
-     *
-     * @param isHuge The boolean parameter shows is the query huge.
-     *
-     * @returns The updated [[IndexQueryRequest]] instance that you can use to chain methods.
-     */
-    withHugeResponse(isHuge) {
-        this.isHugeResponse = isHuge;
-        return this;
-    }
-    /**
-     * Gets a queryString for the request.
-     *
-     * @return The queryString string.
-     */
-    getQueryString() {
-        return this.queryString;
-    }
-    /**
-     * Gets isHugeResponse property for the request.
-     *
-     * @return The `isHugeResponse` boolean.
-     */
-    getHugeResponse() {
-        return this.isHugeResponse;
-    }
-}
-exports.IndexQueryRequest = IndexQueryRequest;

package/lib/client/LayerVersionsRequest.js

@@ -1,64 +0,0 @@
-"use strict";
-/*
- * Copyright (C) 2020 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.LayerVersionsRequest = void 0;
-const olp_sdk_dataservice_read_1 = require("@here/olp-sdk-dataservice-read");
-/** Prepares information for calls to get layer versions of a specific catalog version. */
-class LayerVersionsRequest {
-    /**
-     * Gets a catalog version.
-     *
-     * @returns The catalog version.
-     */
-    getVersion() {
-        return this.version;
-    }
-    /**
-     * Sets the catalog version value that is used in the 'getLayerVersions' method of [[CatalogClient]].
-     *
-     * @param version Specify the catalog version.
-     * @returns The updated [[LayerVersionsRequest]] instance
-     */
-    withVersion(version) {
-        this.version = version;
-        return this;
-    }
-    /**
-     * An optional free-form tag that is used for grouping billing records together.
-     *
-     * If supplied, it must be 4–16 characters long and contain only alphanumeric ASCII characters [A–Za–z0–9].
-     *
-     * @param tag The `BillingTag` string.
-     * @return The updated [[LayerVersionsRequest]] instance that you can use to chain methods.
-     */
-    getBillingTag() {
-        return this.billingTag;
-    }
-    /**
-     * An optional free-form tag that is used for grouping billing records together.
-     *
-     * If supplied, it must be 4–16 characters long and contain only alphanumeric ASCII characters [A–Za–z0–9].
-     */
-    withBillingTag(tag) {
-        this.billingTag = olp_sdk_dataservice_read_1.validateBillingTag(tag);
-        return this;
-    }
-}
-exports.LayerVersionsRequest = LayerVersionsRequest;

package/lib/client/PartitionsRequest.js

@@ -1,124 +0,0 @@
-"use strict";
-/*
- * Copyright (C) 2019-2020 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.PartitionsRequest = void 0;
-const olp_sdk_core_1 = require("@here/olp-sdk-core");
-const olp_sdk_dataservice_read_1 = require("@here/olp-sdk-dataservice-read");
-/**
- * Prepares information for calls to get partitions metadata from the Metadata Service API.
- */
-class PartitionsRequest {
-    constructor() {
-        this.fetchOption = olp_sdk_core_1.FetchOptions.OnlineIfNotFound;
-    }
-    /**
-     * An optional free-form tag that is used for grouping billing records together.
-     *
-     * If supplied, it must be 4–16 characters long and contain only alphanumeric ASCII characters [A–Za–z0–9].
-     *
-     * @param tag The `BillingTag` string.
-     * @return The updated [[PartitionsRequest]] instance that you can use to chain methods.
-     */
-    withBillingTag(tag) {
-        this.billingTag = olp_sdk_dataservice_read_1.validateBillingTag(tag);
-        return this;
-    }
-    /**
-     * Gets a billing tag to group billing records together.
-     *
-     * @return The `BillingTag` string.
-     */
-    getBillingTag() {
-        return this.billingTag;
-    }
-    /**
-     * Sets the provided partition IDs.
-     *
-     * @param ids The IDs of partitions from which you want to get metadata.
-     *
-     * The required quantity is between 1 and 100.
-     * If partition IDs are not provided, all partitions are retrieved.
-     * If the quantity of partition IDs is less than 1 (empty array) or more than 100, an error is thrown.
-     * @returns The updated [[PartitionsRequest]] instance that you can use to chain methods.
-     */
-    withPartitionIds(ids) {
-        this.partitionIds = olp_sdk_dataservice_read_1.validatePartitionsIdsList(ids);
-        return this;
-    }
-    /**
-     * Gets partition IDs for the request.
-     *
-     * @return The `partitionIds` string.
-     */
-    getPartitionIds() {
-        return this.partitionIds;
-    }
-    /**
-     * Sets the provided additional fields: `dataSize`, `checksum`, `compressedDataSize`, and `crc`.
-     *
-     * @param additionalFields The array of strings.
-     * The array can contain the following values: `dataSize`, `checksum`, `compressedDataSize`, and `crc`.
-     *
-     * @returns The updated [[PartitionsRequest]] instance that you can use to chain methods.
-     */
-    withAdditionalFields(additionalFields) {
-        if (additionalFields.length) {
-            this.additionalFields = additionalFields;
-            return this;
-        }
-        else {
-            throw new Error("Error. Parameter 'additionalFields' could not contain empty array. Add value or do not use this method.");
-        }
-    }
-    /**
-     * Gets additional fields for the request.
-     *
-     * @return The `partitionIds` string.
-     */
-    getAdditionalFields() {
-        return this.additionalFields;
-    }
-    /**
-     * Sets the fetch option that you can use to set the source from
-     * which data should be fetched.
-     *
-     * @see `getFetchOption()` for information on usage and format.
-     *
-     * @param option The `FetchOption` enum.
-     *
-     * @return A reference to the updated `PartitionsRequest` instance.
-     */
-    withFetchOption(option) {
-        this.fetchOption = option;
-        return this;
-    }
-    /**
-     * Gets the fetch option that controls how requests are handled.
-     *
-     * The default option is `OnlineIfNotFound`. It queries the network if
-     * the requested resource is not in the cache.
-     *
-     * @return The fetch option.
-     */
-    getFetchOption() {
-        return this.fetchOption;
-    }
-}
-exports.PartitionsRequest = PartitionsRequest;

package/lib/client/PollRequest.js

@@ -1,63 +0,0 @@
-"use strict";
-/*
- * Copyright (C) 2020 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.PollRequest = void 0;
-/**
- * Prepares information for calls to the platform Stream Service.
- */
-class PollRequest {
-    /**
-     * Gets the subscription mode for the request.
-     *
-     * @return The subscription mode.
-     */
-    getMode() {
-        return this.mode;
-    }
-    /**
-     * A setter for the provided subscription mode.
-     *
-     * @param mode The subscription mode.
-     * @returns The [[PollRequest]] instance that you can use to chain methods.
-     */
-    withMode(mode) {
-        this.mode = mode;
-        return this;
-    }
-    /**
-     * Gets the subscription id for the request.
-     *
-     * @return The subscription id.
-     */
-    getSubscriptionId() {
-        return this.subscriptionId;
-    }
-    /**
-     * A setter for the provided subscription id.
-     *
-     * @param id The subscription id.
-     * @returns The [[PollRequest]] instance that you can use to chain methods.
-     */
-    withSubscriptionId(id) {
-        this.subscriptionId = id;
-        return this;
-    }
-}
-exports.PollRequest = PollRequest;

package/lib/client/QuadKeyPartitionsRequest.js

@@ -1,110 +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.QuadKeyPartitionsRequest = void 0;
-const olp_sdk_dataservice_read_1 = require("@here/olp-sdk-dataservice-read");
-/**
- * Prepares information for calls to get quadtree metadata from the Query Service API.
- *
- * This class works only with versioned and volatile layers where the partitioning scheme is HERE Tile.
- */
-class QuadKeyPartitionsRequest {
-    /**
-     * A geometric area represented as a HERE tile.
-     *
-     * @param quadKey Addresses a tile in the quadtree.
-     * @returns The updated [[QuadKeyPartitionsRequest]] instance that you can use to chain methods.
-     */
-    withQuadKey(quadKey) {
-        this.quadKey = quadKey;
-        return this;
-    }
-    /**
-     * The recursion depth of the response.
-     * The maximum allowed value for the depth parameter is 4.
-     *
-     * @param depth The recursion depth of the response.
-     * @returns The updated [[QuadKeyPartitionsRequest]] instance that you can use to chain methods.
-     *
-     * If set to 0, the response includes only data from the quadkey specified in the request.
-     * In this way, the depth describes the maximum length of the subQuadKeys in the response.
-     */
-    withDepth(depth) {
-        this.depth = depth;
-        return this;
-    }
-    /**
-     * An optional free-form tag that is used for grouping billing records together.
-     *
-     * If supplied, it must be 4–16 characters long and contain only alphanumeric ASCII characters [A-Za-z0-9].
-     *
-     * @param tag The `BillingTag` string.
-     * @return The updated [[QuadKeyPartitionsRequest]] instance that you can use to chain methods.
-     */
-    withBillingTag(tag) {
-        this.billingTag = olp_sdk_dataservice_read_1.validateBillingTag(tag);
-        return this;
-    }
-    /**
-     * A setter for the provided additional fields
-     *
-     * @param additionalFields Array of strings. Array could contain next values "dataSize" | "checksum" | "compressedDataSize | "crc"".
-     * This values could be useful for getPartitions method from versionedLayerClient and volatileLayerClient.
-     *
-     * @returns The updated [[QuadKeyPartitionsRequest]] instance that you can use to chain methods.
-     */
-    withAdditionalFields(additionalFields) {
-        this.additionalFields = additionalFields;
-        return this;
-    }
-    /**
-     * Gets the configured [[QuadKey]] object for the request.
-     *
-     * @return The the configured [[QuadKey]] object.
-     */
-    getQuadKey() {
-        return this.quadKey;
-    }
-    /**
-     * Gets the configured depth for the request.
-     *
-     * @return The number of the configured depth.
-     */
-    getDepth() {
-        return this.depth || 0;
-    }
-    /**
-     * Gets a billing tag to group billing records together.
-     *
-     * @return The `BillingTag` string.
-     */
-    getBillingTag() {
-        return this.billingTag;
-    }
-    /**
-     * Gets the additional fields for the request.
-     *
-     * @return Additional fields.
-     */
-    getAdditionalFields() {
-        return this.additionalFields;
-    }
-}
-exports.QuadKeyPartitionsRequest = QuadKeyPartitionsRequest;