Core quickstart

VERSION 0.53.0 PUBLIC PREVIEW

The Core bundle provides essential shared functionality across the entire Maps SDK, including configuration management, common types, and utility functions.

Installing dependencies

The Core bundle is automatically included when you install the Map or Services bundles:

1
# npm or Yarn - automatic peer dependency installation
2
npm install @tomtom-org/maps-sdk
3

4
# pnpm - enable auto-install-peers for easiest setup
5
echo "auto-install-peers=true" >> .npmrc
6
pnpm install @tomtom-org/maps-sdk

Peer dependencies (installed automatically with above commands):

lodash-es (v4) - Utility functions
@turf/turf (v7) - Geospatial analysis

For more details, see the Project setup guide.

Common configuration

1
import { TomTomConfig } from '@tomtom-org/maps-sdk/core';
2

3
TomTomConfig.instance.put({
4
    apiKey: 'YOUR_API_KEY',
5
    language: 'en-GB'
6
});

Before you ship, decide where this key will live. A key used from the browser can be read by anyone who opens the page. A key used from Node.js cannot. See Where your API key runs for which case you are in and what to do about it, and TomTom’s API key management best practices for key restrictions, rotation and monitoring.

1
TomTomConfig.instance.put({
2
    apiKey: 'YOUR_API_KEY',
3
    language: 'en-GB',           // Search/routing/map labels language
4
    commonBaseURL: 'https://api.tomtom.com',  // API base URL
5
    apiVersion: 1                // Default API version for services
6
});

For a full reference of every global option — including display units and retry behavior — and how global values combine with per-request options, see the Global configuration guide.

Using with map bundle

1
import { TomTomConfig } from '@tomtom-org/maps-sdk/core';
2
import { TomTomMap } from '@tomtom-org/maps-sdk/map';
3

4
TomTomConfig.instance.put({
5
    apiKey: 'YOUR_API_KEY'
6
});
7

8
const map = new TomTomMap({ mapLibre: { container: 'map' } });

Using with services bundle

1
import { TomTomConfig } from '@tomtom-org/maps-sdk/core';
2
import { search } from '@tomtom-org/maps-sdk/services';
3

4
TomTomConfig.instance.put({
5
    apiKey: 'YOUR_API_KEY'
6
});
7

8
const results = await search({
9
    query: 'restaurants',
10
    position: [4.9041, 52.3676]
11
});

Node.js configuration

1
const { TomTomConfig } = require('@tomtom-org/maps-sdk/core');
2

3
TomTomConfig.instance.put({
4
    apiKey: process.env.TOMTOM_API_KEY,
5
    language: 'en-GB'
6
});

The Core bundle is automatically included when you install the Map or Services bundles - no separate installation needed.