CHANGELOG

All notable changes to this project will be documented in this file. See Conventional Gitmoji icons for commit guidelines. For the structure of the changelog, we use Semantic Versioning in order to understand the different digits for upcoming versions.

Unreleased (develop)

Features and Improvements

✨ Add easeToCoordinates(coordinates, options?) to MapVXMap. Like fitCoordinates, but frames the coordinates with easeTo over an oriented bounding box aligned to the target bearing, instead of maplibre’s north-up fitBounds. This removes the wasted viewport space that fitCoordinates leaves around diagonal routes drawn under a bearing. Accepts the same options as fitCoordinates.

Bugfixes

🐛 Restore buildingId/floorId disambiguation on route requests (IdLocation), lost in the 1.2.4 release merge. Both fetchRoute and fetchRouteV2 now forward fromBuilding/toBuilding and fromFloor/toFloor query params again, with floorId taking precedence over the numeric level.

1.4.0 (2026-07)

Improvements

🔧 Update the default route animation icon: new arrow glyph, smaller default size (30×30 viewBox), and a new default backgroundColor (#276EF1, previously #0076B6). Configurable via RouteAnimationIconConfig as before.

1.2.2 (2026-06)

Features and Improvements

✨ Add MapConfig.bearing to set the initial map rotation (degrees clockwise from north). Useful to align an indoor map with a fixed installation such as a totem/kiosk so “up” on screen matches the device’s facing direction.
✨ Add map interaction-lock options to MapConfig: interactive, rotateEnabled, dragPan, scrollZoom, doubleClickZoom, touchZoomRotate and keyboard. rotateEnabled: false disables rotation while preserving pinch-to-zoom. Each flag defaults to enabled, so only the gestures you explicitly disable change.
✨ Add runtime camera/interaction methods to MapVXMap: setBearing(degrees, { animate?, onComplete? }), setRotationEnabled, setPanEnabled and setScrollZoomEnabled — e.g. to rotate the map to a totem’s orientation or build a static screen where only zoom in/out is allowed.

1.2.1 (2026-06)

Bugfixes

🐛 Circles now render above indoor floor-plate and building polygons. The previous placement (below the first label layer) let indoor basemap fills paint over circles, hiding them. The new default placement aboveBasemap anchors circles above the topmost basemap geometry layer and below the labels that follow it, and the z-order is re-asserted automatically after floor changes and parent-place style swaps.
🐛 getCircle() and getCircles() now return deep defensive copies (including the nested coordinate), as documented — mutating a returned record no longer writes into internal map state. Coordinate objects passed to addCircle/updateCircle/updateCirclePosition are also copied on input, so mutating your own object after the call no longer affects the map.

Features and Improvements

✨ Add CircleConfig.renderOrder ("aboveBasemap" | "belowLabels" | "top", default "aboveBasemap") to control circle z-placement explicitly. Export the CircleRenderOrder type from the package root.

1.2.0 (2026-06)

Features and Improvements

✨ Add metric radius circles to MapVXMap: addCircle, updateCircle, updateCirclePosition, removeCircle, removeAllCircles, showCircle and hideCircle. Radii are expressed in meters and rendered as geographic polygons, so circles stay metrically accurate at every zoom level — ideal for geofence and proximity-notification visualization.
✨ Circles are floor-aware (same floorId semantics as markers) and automatically survive floor transitions and map style changes.
✨ Add circle inspection and retrieval methods: getCircle(id), getCircles(), and hasCircle(id) to safely check existence and retrieve circle configurations.
✨ Add updateCircleStyle(id, style) for efficient styling updates without geometry recreation.
✨ Add isValidCircleConfig() type guard for pre-validation of circle configurations before adding.
✨ Export CircleConfig, CircleRecord, circleRing, CIRCLE_DEFAULTS, MAPVX_BRAND_COLOR, and isValidCircleConfig from the package root. Circle styling defaults to the MapVX brand blue and is fully configurable per circle.

Improvements

🔧 Circle API methods now provide clear error signals: updateCircle() returns string | null (null if circle not found), updateCirclePosition() returns boolean, showCircle() and hideCircle() return boolean (success/failure).
🔧 Input validation on all circle methods: radius must be positive and finite; coordinates must be within valid latitude [-90, 90] and longitude [-180, 180] ranges. Invalid inputs throw descriptive errors.
🔧 Automatic opacity clamping to [0, 1] range to ensure MapLibre compatibility.
🔧 Enhanced JSDoc documentation with examples, parameter constraints, and throw conditions.

1.1.1 (2026-06)

Bugfixes

🐛 Fix ReferenceError: DEBUG is not defined when loading the SDK through the ES/CJS builds (the package’s import/require entry points). The webpack-only DEBUG/VERSION define constants are now read through typeof guards, so initializeSDK() works in non-webpack consumers (Angular, Vite, plain Node) while still honoring a bundler-defined DEBUG global.

Improvements

🔧 Inject the package version into the tsc-built ES/CJS outputs (new build:defines step), so Countly and Rollbar keep reporting the real SDK version outside the UMD bundle.
🔧 Scope Rollbar to SDK-owned errors only: disable captureUncaught and captureUnhandledRejections, report only error level and above, and send the real code_version against the production project.

1.1.0 (2026-05)

Features and Improvements

✨ Add searchPlacesByTags(institutionId, tags, options?) method backed by the v2 endpoint GET /api/sdk/v2/searchPlacesByTags. Supports match (default), alphabetical and distance sort modes; distance requires either origin or lat+lng+floor+parentPlaces and is validated client-side.
✨ Authenticate via the Authorization: Bearer header for v2 endpoints (new baseUrlV2 in Requester); legacy /api/sdk/* endpoints keep using the token query parameter.
✨ Warm-cache results by mapvxId and clientId, so subsequent getPlaceDetail and getCachedPlaces lookups stay hot.
✨ Export SearchPlacesByTagsOptions and PlacesByTagsSort types from the package root so consumers can type reusable options objects.

Tooling

🔧 Chain docs:format:all (prettier + markdownlint) at the end of typedoc:build so the generated markdown is lint-staged-stable and never produces churn on commit.
🔧 Extend ESLint ignores with .agents/, e2e/ and modules/ so pnpm lint passes cleanly on worktrees that contain these directories.

3.0.27

Features and Improvements

✨ Add routeUnitSystem Configuration to difference between meters or feet.

3.0.26

Features and Improvements

✨ Add maxConcurrentTileFetches and a hard cap for maxTiles in tile cache configuration.
✨ Introduce Semaphore utility to manage concurrent tile fetches and improve tile loading performance.
✨ Refactor cached tile protocol to accept maxConcurrentFetches and use scoped semaphore-based concurrency control.

Security

🔒 Migrate API requests to use Authorization: Bearer headers instead of token-in-URL patterns.
🔒 Update route and institution requests to use authorization headers.
🔒 Update health ping endpoint URL.
🔒 Inject sensitive build-time values via webpack.
🔒 Add SECURITY.md.

3.0.25

Bugfixes

🐛 Fix animation of marker without corresponding polyline.

3.0.23

Features and Improvements

✨ Add keepFixedBearing to AnimationConfig to keep camera orientation fixed during route animations.
✨ Update route animation camera behavior (cameraFollow and marker rotation) to conditionally preserve bearing when keepFixedBearing is enabled.
✨ Add test coverage for camera bearing behavior in both default and fixed-bearing scenarios.

Bugfixes

🐛 Update sourcemaps upload script to run with bash instead of sh.

3.0.22

Features and Improvements

✨ Enhance SDK and demo app language support with runtime language selection in sidebar and SDK initialization.
✨ Improve language propagation across map instances, including RTL handling and language-aware place detail fetching/cache behavior.
✨ Add keepBearing to Configuration to control whether route bearing stays fixed during navigation steps.
✨ Unregister destroyed maps from SDK tracking to prevent updates on disposed instances; add coverage for destroyed-map language behavior.
✨ Improve sidebar layout and simulation control buttons for better readability and UX.

3.0.20

Features and Improvements

✨ Add mvxProduct to MapVxRequestContext; send the mvx-product header on requests to MapVx API hosts when set.
✨ Add isMapVxRequestHostname() to detect MapVx API hostnames; use it in Requester so mapvxRequestContext headers apply only to matching hosts.

3.0.19

Features and Improvements

✨ Add multi-route support: manage multiple concurrent routes with independent control, animation, and customization for each path.
✨ Add RouteInstance and StepAnimationConditions models for tracking independent route states.
✨ Add route progress tracking to visually distinguish traveled and remaining segments.
✨ Support route IDs in animation and removal methods for multi-route management.
✨ Add custom icon support for user location tracking.

3.0.17

Features and improvements

✨ Add instructionDurationMs to Configuration.

3.0.16

Features and Improvements

✨ Introduce mapvxRequestContext for enhanced request context in the SDK.
✨ Enhance SDK initialization with detailed mapvxRequestContext configuration.

3.0.15

Features and Improvements

✨ Update SDK to use secure public API endpoint; add separate base URLs for health checks and routes in Requester; ensure absolute URL handling and backward compatibility with existing base URL.

3.0.14

Bugfixes

🐛 Fix RouteController to handle elevator steps correctly; add tests for elevator step behavior.

3.0.13

Features and Improvements

✨ Add customMarkers to Configuration.

3.0.12

Features and Improvements

✨ Add directionBtnText & locationMarkerText to Configuration.
✨ Add showFloorAdvice to Configuration.

3.0.9

Features and Improvements

✨ Add fitToRoute & paddingToFit to Configuration.

3.0.7

Features and Improvements

✨ Add extractStepCoordinates() function to new route utils.
✨ Add autoFitByPlace property to AnimationRoute.
✨ Add fitRouteByPlace() function to MapVXMap.

3.0.6

Features and Improvements

✨ Add cityOptions property to Configuration.

2.26.5

Features and Improvements

✨ Add lat, lng and floor to search methods to ask for places sorted by distance.
✨ Add support to 24hrs opening hours

2.26.4

Features and Improvements

✨ Add origin to search methods to ask for places sorted by distance.

2.25.7

Features and Improvements

✨ Add property imageUrl to Categories.

2.25.5

Features and Improvements

✨ Add function to update position of marker.

2.25.3

Features and Improvements

✨ Add floor info in route response.

2.25.1

Features and Improvements

✨ Add property visibility to Place.

2.25.0

Features and Improvements

✨ Add property parkingFeature and contactInfo to Configuration.

2.24.0

Features and Improvements

✨ Add property description to Banner.

2.23.0-beta.1

Features and Improvements

✨ Add anchor property to MarkerConfig.

2.22.0

Features and Improvements

✨ Improved MapLibre GL JS style loading by including it in the bundle
📝 Enhance documentation and framework integration guides
⬆️ Upgrade maplibre-gl to version 5.7.0
➕ Add prettier to development dependencies for code formatting

2.21.0

Features and Improvements

✨ Add orderChildrenBy field to Property interface and update PropertyResponse handling

2.20.0

Features and Improvements

✨ Add MapVX product name option to configuration request
✨ Add method for requesting map style and places information outside of api key scope by using a special auth token
📝 Add documentation and testing

2.19.0-beta.2

Features and Improvements

✨ Add metadata to place data.
✨ Add function to remove all markers from the map.

2.19.0-beta.1

Features and Improvements

✨ Add metadata to place data.

2.18.0

Features and Improvements

✨ Add improvements for web components.

2.17.0

Features and Improvements

✨ Updated base url for request.
✨ Added support for property healthPingId on Configuration.
✨ Added new endpoint for health ping.
✨ Added function to process data for CSSCustomization and load it.

2.16.0

Features and Improvements

✨ Added support for logo variants.
✨ Added support for property shortName on InnerFloors.
✨ Updated logging of errors to Rollbar.

2.15.0

Features and Improvements

✨ Added parameter maintainAllPins to Configuration.

2.14.2

Bugfixes

🐛 Fix destination place doesn’t get highlighted.
🐛 Create layer when missing.

2.14.1

Bugfixes

✨ Make new parameter showPopup optional.

2.14.0

Features and Improvements

✨ Added new parameter showPopup to route step data.

2.13.1

Bugfixes

🐛 Fix name of new parameter routeDrawing on interface Configuration.

2.13.0

Features and Improvements

✨ Added parameter routeDrawing to Configuration.

2.12.4

Features and Improvements

✨ Added parameters showCarousel to Configuration.

2.12.2

Features and Improvements

✨ Added new ‘bearingSnap’ parameter to MapConfig

2.12.1

Bugfixes

🐛 Add code to give priority on the selected language for indoor data.

2.12.0

Features and Improvements

✨ Add load of RTL plugin to correctly show RTL strings on map.
✨ Add code to give priority to names on the selected language for the data from OpenMapTiles.

2.11.1

Bugfixes

🐛 Fix parser of Property.

2.11.0

Features and Improvements

✨ Add parameters enableGPS, initialBearing and initialPitch to Configuration.

2.10.0

Features and Improvements

✨ Add functions watchUserHeading and unwatchUserHeading to MapVXSDK.

Bugfixes

🐛 Update fitCoordinates function on MapVXMap.

2.9.0

Features and Improvements

✨ Add new shortDescription property to Place type.

2.8.0

Features and Improvements

✨ Add new route endpoint.

2.7.0

Features and Improvements

✨ Add new parameter to configuration.

2.6.0

Features and Improvements

✨ Add new function to obtain css customization.

2.5.10

Bugfixes

🔥 Remove some throws.
🐛 Fix location listener.

2.5.9

Features and Improvements

👽 downgrade searchPlacesWithFilters api call from v3 to v2, since it was not correctly done in the prior version

2.5.8

Features and Improvements

~~👽 downgrade searchPlacesWithFilters api call from v3 to v2~~
✨ Adding new function for verifying if point is contained in maps bounding box
🐛 Prevent drawing 3D elements in base layers

2.5.7-rc.1

Features and Improvements

👽️ update searchPlacesWithFilters api call from v2 to v3

2.5.6

Features and Improvements

🏷️ Adding new parameters to interface Property.

2.5.5

Bugfixes

🏷️ Adding new parameters to interface Configuration.

2.5.4

Bugfixes

🐛 Updating base filter for layers.

2.5.3

Bugfixes

🐛 Add extra argument to allow filter search with multiple places.

2.5.2-beta.1

Features and Improvements

✨ Update route animation for mixed routing.
✨ Add new function to change parent place and floor displayed on map.

2.5.1

Features and Improvements

✨ Prevent rotation animation for very small angles in routing
🥅 Change error message of getCategories function to give useful information about actual error

2.5.0

Features and Improvements

✨ Add parent ID and type into Place information

2.4.3-rc.2

Bugfixes

⬆️ Update dependencies.

2.4.2

Bugfixes

🐛 Fix param name, place_id to id

2.4.1

Bugfixes

🐛 Fix parent place undefined on getConfig and GetCategories

2.4.0

Features and Improvements

✨ Add function to set a border on a list of places.
✨ Add function to clear the added border.

Bugfixes

🐛 Fix problem with clearing colored polygons and changing floor.

2.3.0

Features and Improvements

✨ Add argument to set color to use on setPlaceAsSelected.
✨ Add function to clear places colored with setPlaceAsSelected.

2.2.0

Features and Improvements

✨ Add hide place by hide search

2.1.1

Bugfixes

🐛 Delete basic category from category type
🐛 Add Points of interest to configuration model

2.1.0

Features and Improvements

✨ Add get configuration
✨ Add get categories

2.0.3

Bugfixes

🐛 Update marker fixed to avoid losing the marker text

2.0.2

Bugfixes

🐛 Check marker visibility when is being added to map.

2.0.1

Bugfixes

🐛 Trigger animation config callback when animating previous step
🐛 first step animation trigger callback

2.0.0

💥 Breaking Changes

✨ Use of new endpoints
♻️ Change data models

Bugfixes

🐛 Markers creation with icon element html

1.8.1

Bugfixes

🐛 On click callback returns the MapVX ID

1.8.0

Features and Improvements

✨ Add callback parameter on map config to listen to floor changes.
✨ Enable using route object directly as argument on start animation function.

Bugfixes

♻️ Fix comparation typos and leave them as assignations
🐛 Fix marker behavior in route animation.
🐛 Fix marker text position errors.

1.7.0

Features and Improvements

♻️ New inFloor value getter for places

Bugfixes

🐛 Last route step displaying beyond it’s floor
🐛 Base floor polygons were not being displayed

1.6.1

Features and Improvements

✨ Add inFloor assignation with function

1.6.0

Features and Improvements

✨ Add parent institution id to place data.
✨ Add total duration and length of a route.

1.5.10

Bugfixes

🐛 Fix subPlaces load parameters

1.5.9

Features and Improvements

✨ Add InnerFloor array type to InFloors

1.5.8

Features, Improvements and Bugfixes

🐛 Added the function call to update the markers by floor in routes.
🐛 Changed that now the response of search by text and getSubPlaces only returns id or ids of floors.
✨ Added optional parameter for the innerFloors of reachableFromGPS

1.5.7

Bugfixes

🐛 Remove property with no data on InnerFloor.
🐛 Fix inverse order of InnerFloor data on map object.
🐛 Use baseFloor for layers filters.

1.5.6

Features, Improvements and Bugfixes

✨ Expose method for multiple selection of places by coloring polygons
🐛 Route marker is displayed in every floor
✨ explore different ways of set max and min limits

1.5.5

Features and Improvements

✨ Add InFloors to getPlacesByInput

1.5.4

Bugfixes

🐛 Fix inFloors adds on place model

1.5.3

Bugfixes

🐛 Fix bad version

1.5.2

Bugfixes

🐛 Fix parameters of getPlacesByInput

1.5.1

Features and Improvements

✨ Add subPlaces to getCachedPlaces function
✨ Add optional parameter to find place by text

1.5.0

Features and Improvements

✨ Add new method getContainer to get the map’s container.

1.4.5

Bugfixes

🐛 Avoid manipulating markers when animating route

1.4.4

Features and Improvements

✨ add hide and show marker functions

1.4.3

Features and Improvements

♻️ refactor and documentation of marker creation

1.4.2

Features and Improvements

♻️ refactor marker creation
✨ update marker by html functions
♻️ change hide and show marker

1.4.1

Bugfixes

🐛 Fix issue where error was not thrown when getting location.

1.4.0

Features and Improvements

✨ Add icon to institution data
🔊 Use a unique error for missing place id on cache.

Bugfixes

🐛 Fix get cache error on Firefox

1.3.6

Feature and Improvements

⚡️ Use cached response for Transport on failed request.

1.3.5

Feature and Improvements

⚡️ Add cache for Transport.

1.3.4

Bugfixes

🐛 Fix incorrect default value used when parsing properties.

1.3.3

Feature and Improvements

✨ Add option for selecting a new default language
🌐 Set english as default, though hardcoded, language

1.3.2

Features and Improvements

✨ Callback function added when new parent place is set and style is updated

1.3.1

Bugfixes

🐛 Add stops requests in transport

1.3.0

Features and Improvements

✨ Add urlAction and sameLink to Banner.
✨ Save to cache places on sdk initialization.
✨ New endpoint to get the cached places from a list of ids.

1.2.1

Bugfixes

🐛 Change data of transport model

1.2.0

Features and Improvements

✨ New cache for place’s information
✨ New endpoints for available places and institutions details
📝 Documentation updates
🎨 Code cleaning

1.1.9

Features and Improvements

🎨 Refactor of place descriptions parsing format
📝 Documentation updates

1.1.8

Features and Improvements

✨ Refactor of getInstitutions

1.1.7

Features and Improvements

✨ New URL property, that returns url as string to external websites

Bugfixes

🐛 Removing Multilang as return type for Place properties

1.1.6

Features and Improvements

✨ New callback that return map rotation value

1.1.5

Features and Improvements

✨ Map rotation when step changes
🐛 Implementing missing unwatch positions
✨ Center on current marker for step animation feature
✨ New user icon location

1.1.4

Features and Improvements

🐛 Places banner model fix

1.1.3

Features and Improvements

✨ Add and remove parent place from a map to change styles
✨ Getting user position one time
✨ Set a callback to get user position constantly
✨ Marker that tracks user position on map (working on change for icon)

1.1.2

Bugfixes

🐛 Minor fix for animation step when animation finishes

1.1.1

Features and Improvements

✨ Interaction with polygons on map, with a callback it’s possible to retrieve place information
✨ Colour places on map when clicked
✨ New fitCoordinates method to fit camera with a set of given coordinates

1.1.0

Features and Improvements

✨ Route animation step by step
🧑‍💻 Arguments for route animation are optional

Bugfixes

🐛 Fix for content on subtitle for properties
🐛 Fixing format for iframe documentation

1.0.1

Bugfixes

🐛 Console logs remove

1.0.0

Features and Improvements

✨ Route animation with play and pause options
✨ Search within places of institution connected to current apiKey
✨ Example updated with route examples
✨ Releases can be created for Github on update_version.sh file
📝 Updating documentation related to iframe configuration

Bugfixes

🐛 Fixing update_version.sh commands to add CHANGELOG.md changes

0.2.15

Bugfixes

🐛 Change LocalizedCategory to string in response

0.2.14

Bugfixes

🐛 Remove delete marker on updates

0.2.13

Features

✨ Uses for ids of markers

0.2.12

Features

✨ Parsing Institution and Places properties
✨ Places now has logo and images
✨ New parameter for LzPlace: inFloor to determine which floor is the place

0.2.11

Features

✨ New parameters for LzPlace and Institution (description, localizedCategory)
✨ LzPlace now returns a category string

Bugfixes

🐛 Returning first institution consistently based on alphabetical order
🐛 Title for LzPlace and Institution is not multilang is string

0.2.10

Features

✨ Return institution information with getInstitution()
✨ Filter for public_place added
✨ LzPlace now returns a category string

0.2.9

Features

✨ Add callback when zoom is applied
✨ Add transport endpoint fetch

0.2.8

Bugfixes

🐛 fix marker log and draggeable

0.2.7

Features

✨ Add reference id to marker config

0.2.6

Bugfixes

🐛 fix marker element name parameter

0.2.5

Bugfixes

🐛 fix marker element logic to obtain the element by parameter

0.2.4

Bugfixes

🐛 fix marker pin logic and rotation logic

0.2.3

Bugfixes

🐛 change logic of update marker

0.2.2

Features

✨ Add UpdateMarker function
✨ Add onClick to MarkerConfig
✨ Add option HTMLElement to marker icon

0.2.1

Bugfixes

🐛 Changing how Countly get the current version to submit errors
🐛 Fixes for Github action to upload new version

0.2.0

Features and Improvements

✨ Callback when map is ready
✨ Adding route on map available
⚡️ Webpack improvements on compile config

Bugfixes

🐛 Fix for display empty floor keys

0.1.3

Features and Improvements

🍱 Updating assets for documentation
✨ Map creation without a parentPlace

Bugfixes

📝 Fixing bad example for map creation
🐛 Fix for webpack configuration for production

0.1.0

📝 New documentation created with MKDocs
➕ Countly setup for logs and error catching
✨ Marker logic completed
✨ Camera config for map
📝 Typedoc for docs generation

0.0.1

Use an HTML tag to wrap the map
Floor selector
Zoom buttons
Paint the route on the map
New documentation