- Discontinued support of Node.js versions less than 18.x.
- Removed
node_fetch
from the dependencies.
olp-sdk-dataservice-api
- Updated the return type
any
=>Response
for functions:
ArtifactsApi::putArtifactFileUsingPUT
,
BlobApi::cancelMultipartUpload
,
BlobApi::deleteBlob
,
IndexApi::insertIndexes
,
IndexApi::performUpdate
,
VolatileBlobApi::deleteVolatileBlob
,
VolatileBlobApi::putVolatileBlob
.
- Removed deprecated interfaces (Removed the deprecated code (#511).
olp-sdk-dataservice-read
StreamLayerClient::poll()
now blocks sending a backend request if there are no messages to submit (#495).getTile
now does not throw an error on sparse versioned or volatile layers (#496).- Improved the interactive map layer API (#497).
olp-sdk-dataservice-api
- Updated the
value
parameter in theUrlBuilder.appendQuery()
method. You can also use this parameter as an object:{ [key: string]: string | number }
. - Updated the APIs generated by the Interactive API v1. Some interfaces have breaking changes: https://github.com/heremaps/here-data-sdk-typescript/commit/70d7d8799de59c23157dc0437eef0f78a46c8b63.
olp-sdk-core
- Updated the
@here/olp-sdk-dataservice-api
dependency.
olp-sdk-authentication
- Removed the deprecated code (#485).
- Updated the
@here/olp-sdk-core
dependency.
olp-sdk-dataservice-api
- Updated the generated code for
ConfigAPI
with information on theInteractiveMap
andObjectStore
layer types. - Updated the
date
types for theSchema
,Artifact
, andKeysListObjectItemResponse
interfaces ofArtifactAPI
. - Removed the deprecated code (#485).
olp-sdk-dataservice-read
- Removed the deprecated code (#485).
- Updated the
@here/olp-sdk-core
dependency. - Updated the
@here/olp-sdk-dataservice-api
dependency.
olp-sdk-dataservice-write
- Updated the
@here/olp-sdk-core
dependency. - Updated the
@here/olp-sdk-dataservice-api
dependency.
olp-sdk-dataservice-write
- Disable type checking for line
import { fs } from "@here/olp-sdk-core";
inNodeFileData
private class.
olp-sdk-core
- Change typings settings to
index.web
.
olp-sdk-dataservice-write
- Updated dependencies.
olp-sdk-dataservice-api
- Added the APIs generated by the
Interactive V1
specification to support IML layers.
olp-sdk-core
- Updated dependencies.
olp-sdk-authentication
- Updated dependencies.
olp-sdk-dataservice-read
- Updated dependencies.
olp-sdk-dataservice-write
- Added the
MultiPartUploadWrapper
class. You can use it to upload large files in a browser and Node.js to the Blob API v1 and v2 services in chunks. - Changed
VersionedLayerClient
. Now, to upload large files to versioned layers, use theMultiPartUploadWrapper
class. - Added the abstracted
BlobData
class. It is a wrapper of data (Blob
,Buffer
,File
, string, and so on) that allows to read a specific range of bytes and get data size.
olp-sdk-dataservice-api
- Fixed the issue with the incorrect
body
parameter in theObjectApi.startMultipartUploadByKey
function.
olp-sdk-core
- Added export for
fs
symbols to the Node.js index file.
olp-sdk-authentication
- Updated dependencies.
olp-sdk-dataservice-read
- Updated dependencies.
olp-sdk-dataservice-api
- Fixed the bug related to the crash in the Config API that occurred when the
catalogExists
function was called.
olp-sdk-core
- Added the
isValid
method toTileKey
. - Fixed the bug related to handling 202 and 303 responses.
- Extended the
HttpError
messages by adding details from the response if it exists. - Changed the Lookup API host URL for SIT.
- Updated dependencies.
olp-sdk-authentication
- Removed the deprecated code (#425).
- Updated dependencies.
olp-sdk-fetch
- Updated dependencies.
olp-sdk-dataservice-api
- Removed the deprecated code (#425).
- Added the APIs generated by
Blob V2
. - Updated dependencies.
olp-sdk-dataservice-read
- Removed the deprecated code (#425).
- Updated dependencies.
olp-sdk-dataservice-write
- Updated dependencies.
olp-sdk-core
- Changed the webpack configuration for bundling JS.
olp-sdk-authentication
- Added the maximum validity of the token
expiresIn
parameter toUserAuthConfig
. - Changed the webpack configuration for bundling JS.
olp-sdk-fetch
- Changed the webpack configuration for bundling JS.
olp-sdk-dataservice-api
- Changed the webpack configuration for bundling JS.
olp-sdk-dataservice-read
- Changed the webpack configuration for bundling JS.
olp-sdk-dataservice-write
- Changed the webpack configuration for bundling JS.
olp-sdk-core
- Added the
sentWith
query parameter to each request. - Updated dependencies.
olp-sdk-authentication
- Added the
sentWith
query parameter to each request. - Updated dependencies.
olp-sdk-fetch
- Updated dependencies.
olp-sdk-dataservice-api
- Added generated functions and interfaces that support Authorization APIs. You can find them at
@here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts
. - Added the
Content-Encoding
header to the PUT blob request. Without this header, it was not possible to upload gzipped blobs. - Breaking change Removed deprecated items that have exceeded the six-month deprecation period. @see #385.
- Updated dependencies.
olp-sdk-dataservice-read
- Now, using a version in the
MetadataCacheRepository
request class is deprecated and will be removed by 05.2021. - Updated dependencies.
- Breaking change Removed deprecated items that have exceeded the six-month deprecation period. @see #385.
olp-sdk-dataservice-write
- Updated dependencies.
olp-sdk-core
- Removed the
User-Agent
custom header from the requests. This was necessary due to issues sending a custom user-agent in Mozilla browsers.
olp-sdk-authentication
- Removed the
User-Agent
custom header from the requests. This was necessary due to issues sending a custom user-agent in Mozilla browsers. - Updated
@here/olp-sdk-fetch
to version 1.6.0.
olp-sdk-dataservice-api
- Added generated functions and interfaces for supporting Authorization APIs. You can find them in
@here/olp-sdk-dataservice-api/lib/authorization-api-v1.1.ts
.
olp-sdk-fetch
- Updated dependencies.
olp-sdk-dataservice-read
- Fixed the issue with caching partitions metadata without additional fields.
- Started using
RequestFactory
from the@here/olp-sdk-core
package.
olp-sdk-dataservice-write
- Added
@here/olp-sdk-dataservice-api
as a dependency. - Updated
@here/olp-sdk-core
to version 1.1.0. - Updated
@here/olp-sdk-fetch
to version 1.6.0.
olp-sdk-core
- Added
@here/olp-sdk-dataservice-api
as a dependency.
olp-sdk-authentication
- Updated
olp-sdk-core
to version ^1.0.0.
olp-sdk-dataservice-read
- Updated
olp-sdk-core
to version ^1.0.0.
olp-sdk-dataservice-write
- Updated
olp-sdk-core
to version ^1.0.0.
olp-sdk-core
- Added the new
@here/olp-sdk-core
module v1.0.0 and moved common components to it.
olp-sdk-authentication
- Added
@here/olp-sdk-core
as a dependency. - Updated
olp-sdk-fetch
to version 1.5.0. - Deprecated the
lib.version.ts
file. It will be removed by 02.2021. Use the same from the@here/olp-sdk-core
package instead. - Deprecated the
./lib/HttpError.ts
file. It will be removed by 02.2021. Use the same from the@here/olp-sdk-core
package instead.
olp-sdk-dataservice-api
- Added the
checkBlobExistsStatus
function toblob-api.ts
. It is a fork of thecheckBlobExists
function. - Deprecated the
checkBlobExists
function inblob-api.ts
. It will be removed by 02.2021. Use thecheckBlobExistsStatus
function instead. - Added the
doCompleteMultipartUpload
function toblob-api.ts
. It is a fork of thecompleteMultipartUpload
function. - Deprecated the
completeMultipartUpload
function inblob-api.ts
. It will be removed by 02.2021. Use thedoCompleteMultipartUpload
function instead. - Added the
putData
function toblob-api.ts
. It is a fork of theputBlob
function. - Deprecated the
putBlob
function inblob-api.ts
. It will be removed by 02.2021. Use theputData
function instead. - Added the
doUploadPart
function toblob-api.ts
. It is a fork of theuploadPart
function. - Deprecated the
uploadPart
function inblob-api.ts
. It will be removed by 02.2021. Use thedoUploadPart
function instead. - Deprecated the
./lib/HttpError.ts
file. It will be removed by 02.2021. Use the same from the@here/olp-sdk-core
package instead..
olp-sdk-fetch
- Updated dependencies.
olp-sdk-dataservice-read
- Added
@here/olp-sdk-core
as a dependency. - Deprecated the
lib.version.ts
file. It will be removed by 02.2021. Use the same from the@here/olp-sdk-core
package instead. - Deprecated the
lib/DataStoreDownloadManager.ts
file. It will be removed by 02.2021. Use the same from the@here/olp-sdk-core
package instead. - Deprecated the
lib/DataStoreRequestBuilder.ts
file. It will be removed by 02.2021. Use the same from the@here/olp-sdk-core
package instead. - Deprecated the
lib/DownloadManager.ts
file. It will be removed by 02.2021. Use the same from the@here/olp-sdk-core
package instead. - Deprecated the
lib/HRN.ts
file. It will be removed by 02.2021. Use the same from the@here/olp-sdk-core
package instead. - Deprecated the
lib/ApiCacheRepository.ts
file. It will be removed by 02.2021. Use the same from the@here/olp-sdk-core
package instead. - Deprecated the
lib/KeyValueCache.ts
file. It will be removed by 02.2021. Use the same from the@here/olp-sdk-core
package instead. - Deprecated the
lib/LRUCache.ts
file. It will be removed by 02.2021. Use the same from the@here/olp-sdk-core
package instead. - Deprecated the
DataRequest.getQuadKey
method. It will be removed by 02.2021. If you need to get data using a quadkey, use the [[getAggregatedData]] method instead. - Deprecated the
lib/FetchOptions.ts
file. It will be removed by 02.2021. Use the same from the@here/olp-sdk-core
package instead. - Deprecated the
lib/OlpClientSettings.ts
file. It will be removed by 02.2021. Use the same from the@here/olp-sdk-core
package instead. - Deprecated the
lib/QuadKey.ts
file. It will be removed by 02.2021. Use the same from the@here/olp-sdk-core
package instead. - Deprecated the
lib/getEnvLookupUrl.ts
file. It will be removed by 02.2021. Use the same from the@here/olp-sdk-core
package instead. - Deprecated the
lib/getDataSizeUtil.ts
file. It will be removed by 02.2021. Use the same from the@here/olp-sdk-core
package instead. - Deprecated the
lib/utils/RequestBuilderFactory.ts
file. This file will be removed by 02.2021. Use the same from the@here/olp-sdk-core
package instead. - Deprecated the
TileRequestParams
parameter required to constructTileRequest
. This signature will be removed by 02.2021. Use the newTileRequest()
parameter instead. - Deprecated the
TileRequest.getCatalogVersion()
method. It will be removed by 02.2021. Call thegetTile
method with the following signature instead:getTile(request: TileRequest, params: TileRequestParams, abortSignal?: AbortSignal)
. - Deprecated the signature for the following function:
getTile(request: TileRequest, abortSignal?: AbortSignal): Promise<Response>;
. This signature will be removed by 02.2021. Use the following signature instead:getTile(request: TileRequest, params: TileRequestParams, abortSignal?: AbortSignal): Promise<Response>
. - Added the
getAggregatedTile
method toVersionedLayerClient
andVolatileLayerClient
. This method fetches data of a tile or its closest ancestor. Use thegetAggregatedTile
method for tile-tree structures where children tile data is aggregated and stored in parent tiles.
olp-sdk-dataservice-write
- Added the new
olp-sdk-dataservice-write
module that you can use to upload data to catalogs. For instruction, see the related section in the Developer Guide. - Added
VersionedLayerClient
. You can use it to upload data to versioned layers. - Added the
VersionedLayerClient.checkDataExists()
method. You can use it to check if a data handle is not used in a layer. - Added the
VersionedLayerClient.getBaseVersion()
method. You can use it to get the latest version of a catalog. - Added the
VersionedLayerClient.startBatch()
method. You can use it to initialize a new publication for publishing. - Added the
VersionedLayerClient.publishToBatch()
method. You can use it to upload a blob and metadata of one partition. If you upload more than 50 MB of data, the data is split and uploaded in parts of 5 MB each. - Added the
VersionedLayerClient.uploadBlob()
method. You can use it to upload data blobs of multiple partitions. If you upload more than 50 MB of data, the data is split and uploaded in parts of 5 MB each. - Added the
VersionedLayerClient.uploadPartitions()
method. You can use it to upload metadata to the write service. - Added the
VersionedLayerClient.cancelBatch()
method. You can use it to cancel a publication if it has not been submitted. - Added the
VersionedLayerClient.getBatch()
method. You can use it to retrieve publication details. - Added the
VersionedLayerClient.completeBatch()
method. You can use it to submit a publication, that is a batch, and if necessary, initiate post-processing.
olp-sdk-authentication
- Updated
olp-sdk-fetch
to version 1.4.0.
olp-sdk-dataservice-api
- Deprecated the
commitOffsets
function instream-api.ts
. It will be removed by 09.2020. Use thedoCommitOffsets
function instead.
olp-sdk-fetch
- Updated dependencies.
olp-sdk-dataservice-read
- Added the
LRUCache
class. - Replaced
Map
withLRUCache
inKeyValueCache
. The default LRU cache capacity is 2 MB. - Added metadata caching to the
getPartitions
andgetData
methods inVersionedLayerClient
andVolatileLayerClient
. - Added the
getSize
,setCapacity
, andgetCapacity
methods toKeyValueCache
. You can use these methods to perform the following actions with the LRU cache instance: retrieve the current size, set a new size, and retrieve the total capacity. - Deprecated the
getQuadKey
andwithQuadKey
methods inDataRequest
. Both methods will be removed by 10.2020. Use thegetTile
function instead. - Added the
getTile
helper function for retrieving binary data of a versioned or volatile layer using a tile key. This function will optimize the metadata caching by requesting a quadtree with depth 4. This way, all the following requests within the same quadtree will benefit from the already cached metadata. - Added the
withFetchOption
andgetFetchOption
methods toDataRequest
andPartitionsRequest
. You can use these methods to define how and from where to retrieve data and metadata. Possible options areOnlineIfNotFound
, andOnlineOnly
. - Updated
olp-sdk-fetch
to version 1.4.0.
olp-sdk-dataservice-read
- Fixed API breaks in
VersionedLayerClient
andVolatileLayerClient
. - Fixed the incorrectly handled version in
VersionedLayerClient
,CatalogClient
, andQueryClient
. - Fixed the incorrectly handled headers in
DatastoreRequestBuilder
.
Common
- Updated dependencies.
The following bugs are fixed:
- Version "0" was incorrectly handled. It is now fixed.
- Additional fields were not passed correctly into the request. It is now fixed.
olp-sdk-fetch
- Updated
node-fetch
to version 2.6.0.
olp-sdk-authentication
- Updated
olp-sdk-fetch
to version 1.3.0.
olp-sdk-dataservice-api
- Added functions and models that are generated from the Stream API specification.
- Added the
isHttpError()
method to theHttpError
class. - Changed
CoverageAPI
. Now, thedataLevel
parameter is optional.
olp-sdk-dataservice-read
- Added the
VersionedLayerClientParams
interface. - Deprecated the
VersionedLayerClient
constructor. Instead, use the constructor that creates theVersionedLayerClient
instance with the help of theVersionedLayerClientParams
object. - Added the
VersionedLayerClient
constructor that creates theVersionedLayerClient
instance using theVersionedLayerClientParams
object and lock version. - Deprecated the
DataRequest.getVersion()
method. - Deprecated the
DataRequest.withVersion()
method. - Changed the
VersionedLayerClient.getData
andVersionedLayerClient.getPartitions
methods. Now, they ignore versions fromDataRequest
andPartitionsRequest
and use versions from theVersionedLayerClient
instance. If you initializeVersionedLayerClient
without any version, on the first call, the latest version is fetched from the service and set in the instance. - Added the
SubscribeRequest
class. This is used byStreamLayerClient.subscribe()
. - Deprecated the
StatisticsRequest.withDatalevel()
method with a string parameter and added theStatisticsRequest.withDatalevel()
method with a number parameter. - Changed
StatisticsRequest.getDataLevel()
. Now, it returns one of the following values: string, number, or undefined. - Added
StreamLayerClient
and reading support for streamed data usingStreamLayerClient
. Currently, you can subscribe, unsubscribe, and consume messages from a stream layer in a serial or parallel mode. Thepoll
method reads messages from a stream layer and commits successfully consumed messages before handing them over to you. With theseek
method, you can set to start reading messages from a stream layer at any given position. - Added the
PollRequest
class. It is used byStreamLayerClient.poll()
. - Added the
UnsubscribeRequest
class. It is used byStreamLayerClient.unsubscribe()
. - Added the
SeekRequest
class. It is used byStreamLayerClient.seek()
. - Deprecated the
VolatileLayerClient
constructor. Instead, use the constructor that creates theVolatileLayerClient
instance with the help of theVolatileLayerClientParams
object. - Added the
VolatileLayerClient
constructor that creates theVolatileLayerClient
instance usingVolatileLayerClientClientParams
object. - Deprecated the
IndexLayerClient
constructor. Instead, use the constructor that creates theIndexLayerClientClient
instance with the help of theIndexLayerClientClientParams
object. - Added the
IndexLayerClient
constructor that creates theIndexLayerClientClient
instance using theIndexLayerClientClientParams
object. - Changed the
LookupAPI.getBaseUrl()
method. Now, you can fetch all URLs in one request instead of fetching each URL separately. - Changed the
ConfigClient.getCatalogs()
method. Now, therequest
parameter is optional.
Common
- Updated the development dependencies.
olp-sdk-dataservice-read
- Fixed the crash in
VersionedLayerClient
andVolatileLayerClient
that happened when a non-existing tile was requested.
olp-sdk-authentication
- Reverted the API break in
AuthCredentials
.
Common
- Updated the development dependencies.
olp-sdk-dataservice-read
- Added the
IndexLayerClient
class that is used to access index layers on OLP. This class implements thegetPartitions
andgetData
methods. - Added the
HttpError
class that extends theError
class and adds a status code to HTTP errors. - Improved error propagations in all public methods. Now, these methods reject the promises with the
HttpError
instance orError
class when errors occur.
olp-sdk-authentication
-
Added the
HttpError
class that extends theError
class and adds a status code to HTTP errors. -
Improved error propagations in all public methods. Now, these methods reject the promises with the
HttpError
instance orError
class when errors occur. -
Breaking Change Improved the return type of the
getEarliestVersion
method inCatalogClient
. It is now the same as the return type of thegetLatestVersion
method. -
Breaking Change Public methods now reject the promises with the
HttpError
instance orError
class instead of strings when errors occur.
Common
- Updated the development dependencies.
olp-sdk-dataservice-read
- Added the
getPartitionsById
method toQueryClient
. Now, you can fetch metadata from specific partitions using their IDs. - Updated the
getPartitions
method inVersionedLayerClient
andVolatileLayerClient
. Now, you can fetch metadata from specific partitions of a volatile or versioned layer using partitions IDs. - Updated documentation for the public API.
olp-sdk-authentication
- The scope support was added to
UserAuth
throughUserAuthConfig
. You can now access the project bound resources using theUserAuthConfig
scope field. - Updated documentation for the public API.
olp-sdk-dataservice-read
-
Added new class
OlpClientSetting
withKeyValueCache
instance to be used for context. -
Added the
VersionedLayerClient
class that is used to access versioned layers on OLP. This class implements thegetData
andgetPartitions
methods. -
Added the
VolatileLayerClient
class that is used to access volatile layers on OLP. This class implements thegetPartitions
andgetData
methods. -
Added the
ArtifactClient
class that is used to access the artifact service on OLP. This class implements thegetSchemaDetails
andgetSchema
methods. -
Added the
ConfigClient
class that is used to access the configuration service on OLP. This class implements thegetCatalogs
method. -
Added the
QueryClient
class that is used to access the query service on OLP. This class implements thefetchQuadTreeIndex
method. -
Added a possibility to abort requests using
AbortSignal
. -
Added a possibility to set an optional billing tag in each request.
-
Added
QuadKeyUtils
that has a set of utilities and functions intended for work with quadkeys: convert a quadkey to a Morton code, convert a Morton code to a quadkey, and validate a quadkey. -
Added the
RequestFactory
class that is used for look-up requests. This class implements the staticcreate
method that returns the builtDatastoreDownloadManager
instance with a correct base URL to service, and thegetBaseUrl
method that caches and returns base URLs to services. -
The
CatalogClient
constructor changed. Users must pass nowOlpClientSettings
by value not by reference anymore. RemovedKeyValueCache
as it is now a part ofOlpClientSettings
. -
Breaking Change The
getLayer
method was removed fromCatalogClient
. Now, to initialize a deprecatedCatalogLayer
, use theVersionedLayerClient
orVolatileLayerClient
classes. -
Breaking Change The
getTile
method was removed fromCatalogClient
. Now, to get layer data, useVersionedLayerClient.getData()
orVolatileLayerClient.getData()
. -
Breaking Change The
getAgregatedTile
method was removed fromCatalogClient
. Now, to get partitions metadata and layer data, useVersionedLayerClient.getPartitions()
andVersionedLayerClient.getData()
orVolatileLayerClient.getPartitions()
andVolatileLayerClient.getData()
. -
Breaking Change The
getSchema
andgetSchemaDetails
methods were removed fromCatalogClient
. Now, to get schemas and schema metadata, use theArtifactClient
class. -
Breaking Change The
HypeDataProvider
class was removed. Now, catalog and layer clients can be initialized without additional classes. -
Breaking Change The
DatastoreClient
class was removed. Now,CatalogClient
can be initialized without additional classes. -
Breaking Change Replaced RequestInit with AbortSignal in all public APIs.
olp-sdk-dataservice-api
- Fixed issues with requests to the Blob REST APIs.
olp-sdk-authentication
- Added a possibility to read credentials from a file using Node.js.
- Changed prepare process before publishing.
- Changed configuration to the TypeDoc.
- Fixed tslints.
- Align Version and Volatile Layers with DatastoreApi.
olp-sdk-authentication
- Fixed build process for web.
- Breaking Change UserAuthConfig.tokenRequester is required now.
olp-sdk-dataservice-read
- Fixed build process for web.