HERE Data SDK for TypeScript is a TypeScript client for the HERE platform.

Master	Node version	Status
Build/Test/Bundling/Typedoc	Node 16.13.2 (LTS)

Platform	Status
Linux

We try to develop and maintain our API in a way that preserves its compatibility with the existing applications. Changes in Data SDK for TypeScript are greatly influenced by the Data API development. Data API introduces breaking changes 6 months in advance. Therefore, you may need to migrate to a new version of Data SDK for TypeScript every half a year.

For more information on Data API, see its Developer Guide and API Reference.

When new API is introduced in Data SDK for TypeScript, the old one is not deleted straight away. The standard API deprecation time is 6 months. It gives you time to switch to new code. However, we do not provide ABI backward compatibility.

All of the deprecated methods, functions, and parameters are documented in the Data SDK for TypeScript API Reference and changelog.

For more information on Data SDK for TypeScrypt, see our Developer Guide.

The Data SDK repository is a monorepo that contains the core components of the platform SDK organized in the NPM workspace.

All components can be used stand-alone and are in the @here subdirectory.

You can install the Data SDK modules using npm or add compiled bundles to an HTML page.

To install the Data SDK modules using npm, run the following commands:

npm install @here/olp-sdk-authentication
npm install @here/olp-sdk-core
npm install @here/olp-sdk-dataservice-read
npm install @here/olp-sdk-dataservice-write
npm install @here/olp-sdk-dataservice-api

To use the Data SDK with pure JavaScript, inject the compiled bundles from the CDN repository in your HTML application.

<script src="https://unpkg.com/@here/olp-sdk-fetch/bundle.umd.min.js"></script> 
<script src="https://unpkg.com/@here/olp-sdk-core/bundle.umd.min.js"></script> 
<script src="https://unpkg.com/@here/olp-sdk-authentication/bundle.umd.min.js"></script> 
<script src="https://unpkg.com/@here/olp-sdk-dataservice-api/bundle.umd.min.js"></script> 
<script src="https://unpkg.com/@here/olp-sdk-dataservice-read/bundle.umd.min.js"></script> 
<script src="https://unpkg.com/@here/olp-sdk-dataservice-write/bundle.umd.min.js"></script> 

To learn how to use the Data SDK, see the Getting Started Guide, Developer Guide, and API Reference.

Data SDK for TypeScript has the following dependencies:

• npm 6.0.0+ (for installation instructions, see npm)
• Node.js 10+ (for installation instructions, see Node.js)
• Lerna.js 3+ (for installation instructions, see Lerna.js)
• TypeDoc 0.15+ (for installation instructions, see TypeDoc)

Note: As an alternative to npm, you can also use Yarn 1+ (for installation instructions, see Yarn).

To bootstrap the packages in the current Lerna repository, install all interdependent packages, and link any cross-dependencies, run the following command:

yarn install && yarn bootstrap

To build the TypeScript source code into the JavaScript code, run the following command:

npm run build

You can test the build results using unit and integration tests.

To test the build results using unit tests, run the following command:

npm run test

To test the build results using integration tests, run the following command:

npm run integration-test

To run unit tests and generate test coverage reports, run the following command:

npm run coverage

To generate documentation for all modules and classes, run the following command:

npm run typedoc

The dist/doc folder is generated with the documentation from the annotated source code.

If you want to have a compiled project, you can use bundle commands. After running each of the following commands, you get the .js bundled files from the root folder for each package:

@here/olp-sdk-authentication/bundle.umd.min.js
@here/olp-sdk-core/bundle.umd.min.js
@here/olp-sdk-dataservice-read/bundle.umd.min.js
@here/olp-sdk-dataservice-write/bundle.umd.min.js
@here/olp-sdk-dataservice-api/bundle.umd.min.js
@here/olp-sdk-fetch/bundle.umd.min.js

To get the bundled .js files with the sourcemaps files for all modules, run the following command:

npm run bundle:dev

To get a minified version for production, run the following command:

npm run bundle:prod

To get the bundled and minified .js files, run the following command:

npm run bundle

Copyright (C) 2019–2022 HERE Europe B.V.

For license details, see the LICENSE file in the root of this project.