Skip to main content

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.2.0] - 2026-04-15​

Added​

  • Weather Module

    • WeatherService — weather forecasting by coordinates and duration.
    • Conditions, Parameter, Daylight — weather condition data types.
    • LocationForecast — location-specific forecast results.

  • Social Overlay

    • SocialOverlay, SocialReportsOverlayInfo — social report overlays on the map.
    • SocialReportListener — listener for social report events.

  • Activation & Gate Keeper Services (React Native)

    • ActivationService, ActivationStatus, ActivationInfo, ProductID, DurationID — SDK activation management.
    • GateKeeperService, Gate, GateDecision, GateStatus — feature gating service.

  • Localization Services

    • LocalizationService, TtsLocalizationService — text and TTS localization.

  • Debug Utilities

    • Debug, GemDumpSdkLevel, GemConsoleLogLevel, NavigationModifiers — SDK debug and diagnostic tools.

  • EV Car Model

    • EVCarModel, EVCarModelList — electric vehicle car model data for EV routing.

  • Map Downloader (React Native)

    • MapDownloaderService — offline map download management.

  • Route Bookmarks

    • RouteBookmarks, RouteBookmarksSortOrder — save and manage route bookmarks.

  • Image Render Settings

    • AbstractGeometryImageRenderSettings, SignpostImageRenderSettings, LaneImageRenderSettings — image rendering configuration for signposts, lanes, and geometry.

  • Map View Render Info

    • MapViewRenderInfo, ViewDataTransitionStatus, ViewCameraTransitionStatus — map rendering state and transitions.

  • Traffic Parameters

    • TrafficParameters — configurable traffic request parameters.

  • Sensor Data Classes (React Native)

    • Acceleration, Attitude, Battery, Camera, Compass, HeartRate, MagneticField, MountInformation, NmeaChunk, Orientation, RotationRate, Temperature — individual sensor data types for activity recording.
    • PositionSensorConfiguration — sensor configuration for position data.

  • Camera Player & Log Uploader (React Native)

    • GemCameraPlayer, GemCameraPlayerStatus — camera playback from recordings.
    • LogUploader, LogUploadListener, LogUploaderState — upload recorded logs to the cloud.

  • Public Transport Route Details

    • PTRoute, PTRouteInstruction, PTRouteSegment — detailed public transport route, instruction, and segment classes.

  • Signpost Details Expansion

    • SignpostItem, SignpostItemList, SignpostConnectionInfo — signpost item classes with full enum support (SignpostPictogramType, RoadShieldType, SignpostItemType).

  • Terrain Profile Sections

    • ClimbSection, RoadTypeSection, SurfaceSection, SteepSection, TollSection — detailed terrain profile section types with grade, surface, and road type data.

  • Geographic Area Types

    • CircleGeographicArea, PolygonGeographicArea, TilesCollectionGeographicArea — additional geographic area geometry types.

  • Persistent Roadblock Listener

    • PersistentRoadblockListener, UserRoadblockPathPreviewCoordinate — listener for persistent roadblock events.

  • Render Settings Expansion

    • FollowPositionPreferences — detailed follow-position configuration (moved to dedicated module).
    • HighlightRenderSettings, HighlightOptions — highlight rendering for map objects.
    • MarkerRenderSettings, MarkerCollectionRenderSettings — marker-level rendering configuration.
    • RouteRenderSettings, RouteRenderOptions — route-level rendering configuration.

  • SDK Settings Expansion

    • LayoutImageId, PublicTransportImageId, RoutePreviewBubbleImageId, SdkImageIds — predefined SDK image ID enums.

  • Navigation Enhancements

    • NavigationEventType, NavigationInstructionUpdateEvents — granular navigation event types.
    • NextSpeedLimit, NextSpeedLimitStatus — upcoming speed limit information.

  • Landmark Enhancements

    • PredefinedExtraInfoKey — enum for well-known extra info keys.
    • Additional getters on Landmark: getCategories(), getImages(), getAuthor(), getExtraInfo(), getLandmarkStoreExtraInfo(), getRegisteredImages().

  • Marker Enhancements

    • MarkerInfo, MarkerType, MarkerJson — marker metadata types.
    • MarkerMatch, MarkerWithRenderSettings — marker matching and render settings pairing.

  • Overlay Enhancements

    • OverlayMutableCollection — mutable overlay collection for add/remove operations.
    • OverlayItemPosition — overlay item positioning.

  • Playback

    • Playback, ExternalPositionData — GPS log playback support.

  • Voice (React Native)

    • Voice, VoiceType — voice configuration for navigation TTS (moved to dedicated module).

  • Content Store Enhancements

    • ContentType — content type enum exported.
    • ContentUpdater, ContentUpdaterStatus — content update management.
    • ContentStoreItemStatus — item download status.
    • ContentDownloadThreadPriority, DataSavePolicy — download configuration enums.

  • View & Initialization

    • createView and createCanvas now accept an optional styleContent (Uint8Array) parameter to set the map style at view creation time.

Fixed​

  • Hovered map label highlight callbacks (onHoveredMapLabelHighlightedLandmark, onHoveredMapLabelHighlightedOverlayItem, onHoveredMapLabelHighlightedTrafficEvent) now receive null when the label loses focus, firing only on the transition from highlighted to not-highlighted.
  • Fixed right-click on map triggering unwanted mousedown/mouseup pointer events.
  • Rewrote AddressInfo to use a local Map<AddressField, string> instead of native pointer calls, fixing serialization and field access issues.
  • Added missing JSDoc comments to all dispose() implementations.
  • Fixed missing hyphens in @param TSDoc tags across the codebase.

[1.1.1] - 2026-03-17​

Fixed​

  • Add missing methods
  • Fix map resize when in canvas
  • Fixed map mouse scroll offset when in canvas

[1.1.0] - 2026-02-19​

Added​

  • Track Recorder System

    • Recorder - Core recording service for GPS tracks with start/stop/pause/resume functionality, plus audio recording support.
    • RecorderConfiguration - Configuration options for recording sessions (data types, storage, continuous recording, video quality, etc.).
    • RecorderBookmarks - Bookmark management for recordings with import/export, protect, delete, and list capabilities.
    • ActivityRecord - Representation of recorded activities.
    • LogMetadata - Metadata for recorded logs (timestamps, durations, coordinates, active types, metrics).
    • LogMetrics, RecordMetrics - Recording metrics and statistics.
    • SoundMark, TextMark, LogMark - Mark types for annotating recordings at specific timestamps.

  • Sound Playing Service

    • SoundPlayingService - Service for managing audio playback (play text, play sound, cancel sounds).
    • SoundPlayingPreferences - Audio playback preferences and settings.
    • SoundPlayingListener - Event listener for audio playback events (start, stop, interruption, volume change).
    • SoundSessionRequestPreferences - Preferences for sound session requests.

  • Map Details & Terrain

    • MapDetails - Comprehensive static map information (coverage, providers, capabilities, country code/name, sunrise/sunset, etc.).
    • CountryData - Representation of country-specific data.
    • BuildTerrainProfile - Terrain profile building.

  • Vehicle Profiles

    • EVProfile - Electric Vehicle profile with support for battery capacity, health, departure/destination SOC, and connectors.
    • BikeProfileElectricBikeProfile & ElectricBikeProfile - Electric bike routing profiles.
    • MotorVehicleProfile, CarProfile, TruckProfile - Extended profile classes for detailed vehicle routing.

  • Navigation & Routing Enhancements

    • RoutePreferences Expansion: Added extensive getters/setters for routing configurations, including:
      • Accurate waypoints approach & track matching.
      • Profiles integration (bikeProfile, carProfile, truckProfile, pedestrianProfile).
      • Avoidance settings (ferries, motorways, toll roads, unpaved roads, traffic).
      • Public transport algorithm types and alternative route sorting.
    • RoundTripParameters - Parameters for round-trip route calculation.
    • DepartureHeading - Vehicle departure heading parameters.
    • VehicleRegistration - Vehicle registration data encapsulation.
    • PositionQualityExtension - Position quality extension for retrieving quality by ID.

  • View & Map API Enhancements (GemView/Core)

    • Viewport helpers: viewportF, viewportCenter properties.
    • Cursor & Selection: cursorWgsPosition property, plus helper methods cursorSelectionTrafficEvents(), cursorSelectionPath(), cursorSelectionMapSceneObject().
    • Camera & Movement: isAnimationInProgress, isCameraMoving properties.
    • Follow Position: getIsFollowingPosition() with alsoFlyToPosition parameter.
    • Zoom Control: minZoomLevel (getter/setter), maxZoomLevel (setter).
    • Camera/Terrain Accessors: mapAngle, viewAngle, hasTerrainTopography properties, and getAltitude() method.
    • Routing Helpers: clearRouteInstruction() method.
    • Rendering & Clipping: isRenderEnabled (getter/setter) and setClippingArea() method.
    • Callbacks & Listeners: Registration methods for map styles, cursor selection (paths, objects), and hovered map labels (landmarks, overlay items, traffic events).
    • Data Providers: getTransferStatistics() method with ServiceGroupType parameter.

Fixed​

  • Event conversion logic for TrafficEventList, Path, and MapSceneObject in event handlers.
  • Proper null handling for cursor selection methods (now explicitly returning null when no object is selected).
  • Missing hovered traffic event callback registration.
  • Text to speech instruction now receives the instruction text as a parameter in the callback.

[1.0.0] - 2026-02-06​

Added​

  • Initial release of Magic Lane Maps SDK for TypeScript
  • Core mapping functionality
  • Image handling utilities
  • Geographic area support
  • Coordinate system support

Roadmap​

The following features are planned for future releases:

FeatureAPIDescription
Multi-touch gestures-Pinch, rotate, tilt gestures for enhanced map interaction
Track RecorderRecorderCore recording service for GPS tracks
RecorderConfigurationConfiguration options for recording sessions
ActivityRecordRepresentation of recorded activities
Metrics, LogMetrics, RecordMetricsRecording metrics and statistics
RecorderBookmarksBookmark management for recordings
LogMetadataMetadata for recorded logs
LogMark, SoundMark, TextMarkMark types for annotating recordings
RecorderStatus, FileSortOrder, FileSortType, FileType, RecordingTransportModeEnums
Sound Playing ServiceSoundPlayingServiceService for managing audio playback
SoundPlayingPreferencesAudio playback preferences and settings
SoundPlayingListenerEvent listener for audio playback events
SoundPlayTypeTypes of sounds that can be played
Last updated on