@mapvx/web-js 4.0.2 → 4.0.3-dev.2

package/dist/es/domain/models/route.js

@@ -1,16 +1,6 @@
 import { decode } from "@googlemaps/polyline-codec";
 import { v4 as uuid } from "uuid";
-/**
- * Represents a complete route in MapVX that can contain multiple legs.
- * Each route is composed of a series of legs that connect different points.
- * @group Routes
- */
 export class MVXRoute {
-    /**
-     * Creates a new route instance from API response data
-     * @hidden
-     * @param data API response data containing route information
-     */
     constructor(data) {
         this.id = uuid();
         this.legs = [];
@@ -19,47 +9,21 @@ export class MVXRoute {
             this.legs.push(leg);
         });
     }
-    /**
-     * Gets all steps of the route by combining steps from all legs
-     * @returns Array with all route steps
-     */
     get steps() {
         return this.legs.flatMap((leg) => leg.steps);
     }
-    /**
-     * Gets the total duration of the route.
-     * This property calculates the sum of the duration of all legs in the route.
-     *
-     * @returns {number} The total duration of the route, in seconds.
-     */
     get duration() {
         return this.legs
             .map((leg) => leg.duration)
             .reduce((accumulator, currentValue) => accumulator + currentValue, 0);
     }
-    /**
-     * Gets the total length of the route.
-     * This property calculates the sum of the length of all legs in the route.
-     *
-     * @returns {number} The total length of the route, in meters.
-     */
     get length() {
         return this.legs
             .map((leg) => leg.distance)
             .reduce((accumulator, currentValue) => accumulator + currentValue, 0);
     }
 }
-/**
- * Represents a route leg that connects two specific points.
- * Each leg contains information about distance, duration, and detailed steps.
- * @group Routes
- */
 export class MVXRouteLeg {
-    /**
-     * Creates a new route leg instance from response data
-     * @hidden
-     * @param data API response data containing leg information
-     */
     constructor(data) {
         this.distance = data.distance.value;
         this.duration = data.duration.value;
@@ -72,17 +36,7 @@ export class MVXRouteLeg {
         });
     }
 }
-/**
- * Represents an individual step within a route leg.
- * Each step contains specific instructions and coordinates for navigation.
- * @group Routes
- */
 export class MVXRouteStep {
-    /**
-     * Creates a new route step instance from response data
-     * @hidden
-     * @param data API response data containing step information
-     */
     constructor(data) {
         this.distance = data.distance.value;
         this.duration = data.duration.value;
@@ -100,30 +54,14 @@ export class MVXRouteStep {
         this.iconPrefix = data.icon_prefix;
         this.polyline = new Polyline(data.polyline);
     }
-    /**
-     * Gets the polyline coordinates in GeoJSON format
-     * @returns Array of coordinates in [longitude, latitude] format
-     */
     get geoJsonCoordinates() {
         return this.polyline.geoJsonCoordinates;
     }
-    /**
-     * Gets the polyline coordinates in LatLng format
-     * @returns Array of LatLng coordinates
-     */
     get coordinates() {
         return this.polyline.coordinates;
     }
 }
-/**
- * Internal class that handles polyline decoding and management.
- * A polyline is an encoded representation of a series of coordinates.
- */
 class Polyline {
-    /**
-     * Creates a new polyline instance from response data
-     * @param data Response data containing polyline information
-     */
     constructor(data) {
         this.points = data.points;
         this.pointsLatLng = data.points_lat_lng;
@@ -132,10 +70,6 @@ class Polyline {
             return { lat: point[0], lng: point[1] };
         });
     }
-    /**
-     * Gets coordinates in GeoJSON format
-     * @returns Array of coordinates in [longitude, latitude] format
-     */
     get geoJsonCoordinates() {
         if (this.overviewPoints != null) {
             return this.overviewPoints.map((point) => [point.lng, point.lat]);
@@ -144,10 +78,6 @@ class Polyline {
             return this.decodedPoints.map((point) => [point.lng, point.lat]);
         }
     }
-    /**
-     * Gets coordinates in LatLng format
-     * @returns Array of LatLng coordinates
-     */
     get coordinates() {
         if (this.overviewPoints != null) {
             return this.overviewPoints;
@@ -157,4 +87,3 @@ class Polyline {
         }
     }
 }
-//# sourceMappingURL=route.js.map

package/dist/es/domain/models/routeConfiguration.d.ts

@@ -184,4 +184,3 @@ export interface IdLocation {
  * @group Routes
  */
 export type RouteLocation = IdLocation | MVXLocation;
-//# sourceMappingURL=routeConfiguration.d.ts.map

package/dist/es/domain/models/routeConfiguration.js

@@ -1,27 +1,15 @@
-/**
- * Represents the announce format for the route.
- * @group Routes
- */
 export var AnnounceFormat;
 (function (AnnounceFormat) {
     AnnounceFormat["cardinal"] = "CARDINAL";
     AnnounceFormat["clock"] = "CLOCK";
     AnnounceFormat["relative"] = "RELATIVE";
 })(AnnounceFormat || (AnnounceFormat = {}));
-/**
- * Represents the unit system for the route.
- * @group Routes
- */
 export var UnitSystem;
 (function (UnitSystem) {
     UnitSystem["metric"] = "METRIC";
     UnitSystem["imperial"] = "IMPERIAL";
     UnitSystem["steps"] = "STEPS";
 })(UnitSystem || (UnitSystem = {}));
-/**
- * Represents the transportation mode for the route.
- * @group Routes
- */
 export var TransportationMode;
 (function (TransportationMode) {
     TransportationMode["walking"] = "WALKING";
@@ -29,21 +17,7 @@ export var TransportationMode;
     TransportationMode["bicycling"] = "BICYCLING";
     TransportationMode["transit"] = "TRANSIT";
 })(TransportationMode || (TransportationMode = {}));
-/**
- * Class representing the configuration of a route.
- * @hidden
- */
 export class InternalGetRouteConfiguration {
-    /**
-     * Create a new route configuration.
-     * @param initialLocation The initial location for the route.
-     * @param finalLocation The final location for the route.
-     * @param preferAccessibleRoute The option to generate a route (if available) for people with mobility disabilities.
-     * @param language The language for the instructions.
-     * @param unitSystem The unit system used for the distance.
-     * @param announceFormat The format used to announce directions in the instructions.
-     * @param userBearing The user's heading in degrees used as the reference direction for announcing turns.
-     */
     constructor(config) {
         var _a, _b, _c, _d, _e;
         this.initialLocation = config.initialLocation;
@@ -55,16 +29,7 @@ export class InternalGetRouteConfiguration {
         this.userBearing = (_e = config.userBearing) !== null && _e !== void 0 ? _e : 0;
     }
 }
-/**
- * Internal class for the configuration to draw the route on a map.
- * @hidden
- */
 export class InternalDrawRouteConfiguration {
-    /**
-     * Create a new configuration to draw a route in the map.
-     * @param polylineWidth The width of the route line in the map. If omitted, default to `10`.
-     * @param routeStyle The style for the steps on the route. If omitted, default to `{ color: "#33B5E5" }`.
-     */
     constructor(config) {
         var _a, _b;
         this.polylineWidth = (_a = config.polylineWidth) !== null && _a !== void 0 ? _a : 10;
@@ -74,4 +39,3 @@ export class InternalDrawRouteConfiguration {
         };
     }
 }
-//# sourceMappingURL=routeConfiguration.js.map

package/dist/es/domain/models/routeInstance.d.ts

@@ -129,4 +129,3 @@ export interface RouteInstance {
  * @group Routes
  */
 export declare function createRouteInstance(route: MVXRoute): RouteInstance;
-//# sourceMappingURL=routeInstance.d.ts.map

package/dist/es/domain/models/routeInstance.js

@@ -1,10 +1,3 @@
-/**
- * Creates a new RouteInstance from a route.
- * Each instance gets unique MapLibre source/layer IDs based on the route's UUID.
- * @param route The route to create an instance for.
- * @returns A new RouteInstance with initialized GeoJSON data structures.
- * @group Routes
- */
 export function createRouteInstance(route) {
     return {
         id: route.id,
@@ -24,4 +17,3 @@ export function createRouteInstance(route) {
         layerDrawConfigs: {},
     };
 }
-//# sourceMappingURL=routeInstance.js.map

package/dist/es/domain/models/routeStyle.d.ts

@@ -44,4 +44,3 @@ export interface SolidStyle {
      */
     type: "Solid";
 }
-//# sourceMappingURL=routeStyle.d.ts.map

package/dist/es/domain/models/routeStyle.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=routeStyle.js.map

package/dist/es/domain/models/scene3D.d.ts

@@ -462,4 +462,3 @@ export type SpriteIconData = {
     x: number;
     y: number;
 };
-//# sourceMappingURL=scene3D.d.ts.map

package/dist/es/domain/models/scene3D.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=scene3D.js.map

package/dist/es/domain/models/transport.d.ts

@@ -173,4 +173,3 @@ export declare class MVXTransport {
      */
     constructor(data: TransportResponse);
 }
-//# sourceMappingURL=transport.d.ts.map

package/dist/es/domain/models/transport.js

@@ -1,18 +1,6 @@
-/**
- * Class that represents a transport object in MapVX.
- * Contains both regular schedules and real-time information.
- * @group Others
- */
 export class MVXTransport {
-    /**
-     * Creates a new transport instance with the parameters specified in the response of the endpoint.
-     * @hidden
-     * @param data json parameters for the transport object.
-     * @returns A new instance of MVXTransport is returned.
-     */
     constructor(data) {
         this.schedule = data.schedules;
         this.routes = data.realtimeSchedules;
     }
 }
-//# sourceMappingURL=transport.js.map

package/dist/es/domain/ports/ICache.d.ts

@@ -67,4 +67,3 @@ export interface ICache<T> {
      */
     keys(): string[];
 }
-//# sourceMappingURL=ICache.d.ts.map

package/dist/es/domain/ports/ICache.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=ICache.js.map

package/dist/es/domain/ports/IHttpClient.d.ts

@@ -74,4 +74,3 @@ export interface IHttpClient {
      */
     delete<T = unknown>(url: string, options?: HttpRequestOptions): Promise<HttpResponse<T>>;
 }
-//# sourceMappingURL=IHttpClient.d.ts.map

package/dist/es/domain/ports/IHttpClient.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=IHttpClient.js.map

package/dist/es/domain/ports/ILogger.d.ts

@@ -58,4 +58,3 @@ export declare class NoopLogger implements ILogger {
     logWarning(): void;
     logDebug(): void;
 }
-//# sourceMappingURL=ILogger.d.ts.map

package/dist/es/domain/ports/ILogger.js

@@ -1,19 +1,10 @@
-/**
- * No-op logger implementation for testing or when logging is disabled
- * @group Utils
- */
 export class NoopLogger {
     logEvent() {
-        // No-op
     }
     logError() {
-        // No-op
     }
     logWarning() {
-        // No-op
     }
     logDebug() {
-        // No-op
     }
 }
-//# sourceMappingURL=ILogger.js.map

package/dist/es/domain/ports/index.d.ts

@@ -6,4 +6,3 @@ export type { ICache, CacheStats } from "./ICache";
 export type { IHttpClient, HttpResponse, HttpRequestOptions } from "./IHttpClient";
 export type { ILogger } from "./ILogger";
 export { NoopLogger } from "./ILogger";
-//# sourceMappingURL=index.d.ts.map

package/dist/es/domain/ports/index.js

@@ -1,6 +1 @@
-/**
- * Domain Ports (Interfaces)
- * These define the contracts for external dependencies following hexagonal architecture.
- */
 export { NoopLogger } from "./ILogger";
-//# sourceMappingURL=index.js.map

package/dist/es/index.d.ts

@@ -65,4 +65,3 @@ export declare const loadStyles: () => void;
  * @group Utils
  */
 export type { Map as MapLibreMap, Marker as MapLibreMarker, PositionAnchor, PointLike, StyleSpecification, LngLatLike, LngLatBoundsLike, MapOptions, MapEventType, MapLayerEventType, } from "maplibre-gl";
-//# sourceMappingURL=index.d.ts.map

package/dist/es/index.js

@@ -1,61 +1,34 @@
-// ─── Infrastructure: Cache ───────────────────────────────────────────────────
 export { LRUCache } from "./infrastructure/cache/LRUCache";
 export { PersistentCache } from "./infrastructure/cache/PersistentCache";
 export { CacheManager } from "./infrastructure/cache/CacheManager";
 export { DEFAULT_CACHE_CONFIGS, DEFAULT_MAX_STORAGE_BYTES, } from "./infrastructure/cache/cacheConfig";
-// ─── Infrastructure: HTTP ────────────────────────────────────────────────────
 export { FetchHttpClient } from "./infrastructure/http/FetchHttpClient";
-// ─── Infrastructure: Logging ─────────────────────────────────────────────────
 export { MVXLogger } from "./infrastructure/logging/MVXLogger";
-// ─── SDK ─────────────────────────────────────────────────────────────────────
 export { initializeSDK } from "./sdk";
-// ─── Domain Models: Assets / Icons ───────────────────────────────────────────
 export { createRouteAnimationIconDataUrl } from "./assets/icons";
-// ─── Domain Models: Banner ───────────────────────────────────────────────────
 export { Banner } from "./domain/models/banner";
-// ─── Domain Models: Campaigns ────────────────────────────────────────────────
 export { Campaign } from "./domain/models/campaign";
-// ─── Domain Models: Categories ───────────────────────────────────────────────
 export { isBasicWithIcon, isBasicWithImageUrl, isBasicWithLogo } from "./domain/models/categories";
-// ─── Domain Models: Circle ───────────────────────────────────────────────────
 export { circleRing, CIRCLE_DEFAULTS, MAPVX_BRAND_COLOR, isValidCircleConfig, } from "./domain/models/circle";
-// ─── Domain Models: Institution ──────────────────────────────────────────────
 export { Institution } from "./domain/models/institution";
-// ─── Domain Models: Map Config ───────────────────────────────────────────────
 export { DEFAULT_MARKER_LAYOUT_CONFIG, DEFAULT_TILE_CACHE_CONFIG, MAPLIBRE_MAX_TILE_CACHE_HARD_CAP, } from "./domain/models/mapConfig";
-// ─── Domain Models: Marker ───────────────────────────────────────────────────
 export { TextPosition } from "./domain/models/marker";
-// ─── Domain Models: Place ────────────────────────────────────────────────────
 export { MVXPlace } from "./domain/models/place";
-// ─── Domain Models: Route ────────────────────────────────────────────────────
 export { MVXRoute, MVXRouteLeg, MVXRouteStep } from "./domain/models/route";
-// ─── Domain Models: Route Configuration ──────────────────────────────────────
 export { AnnounceFormat, TransportationMode, UnitSystem } from "./domain/models/routeConfiguration";
-// ─── Domain Models: Transport ────────────────────────────────────────────────
 export { MVXTransport } from "./domain/models/transport";
-// ─── Utils ───────────────────────────────────────────────────────────────────
 export { loadCustomization } from "./utils/update-css";
 export { OpeningHoursHelper } from "./utils/opening-hours-helper";
 export { isMapVxRequestHostname } from "./utils/mapvxHostname";
 export { injectPreconnects, MAPVX_DEFAULT_PRECONNECT_HOSTS } from "./utils/preconnect";
-// ─── MapLibre worker ─────────────────────────────────────────────────────────
-// The SDK carries MapLibre's worker internally and installs it when the first map is created;
-// these exist for consumers whose Content-Security-Policy forbids blob: workers and who therefore
-// need to self-host it. See src/map/installMapLibreWorker.ts.
 export { installMapLibreWorker, setMapLibreWorkerUrl, getMapLibreWorkerUrl, } from "./map/installMapLibreWorker";
-/**
- * Function to load default styles
- * @group Utils
- */
 export const loadStyles = () => {
-    // Check if styles are already loaded
     if (document.querySelector("link[data-mapvx-styles]")) {
         return;
     }
     const link = document.createElement("link");
     link.rel = "stylesheet";
-    link.href = "./styles.css"; // Adjust path as needed
+    link.href = "./styles.css";
     link.setAttribute("data-mapvx-styles", "true");
     document.head.appendChild(link);
 };
-//# sourceMappingURL=index.js.map

package/dist/es/infrastructure/cache/CacheManager.d.ts

@@ -107,4 +107,3 @@ export declare class CacheManager {
      */
     getAllCacheStats(): Record<CacheType, CacheStats>;
 }
-//# sourceMappingURL=CacheManager.d.ts.map

package/dist/es/infrastructure/cache/CacheManager.js

@@ -2,16 +2,8 @@ import { DEFAULT_MAX_STORAGE_BYTES, getCacheConfig, } from "./cacheConfig";
 import { LRUCache } from "./LRUCache";
 import { PersistentCache } from "./PersistentCache";
 import { MVXPlace } from "../../domain/models/place";
-/**
- * Per-type revivers restoring class prototypes lost when the persistent cache
- * rehydrates values from localStorage (`JSON.parse` yields plain objects without
- * methods). Only caches that hold class instances need an entry; plain-data caches
- * (routes, configurations, etc.) are left untouched.
- */
 const CACHE_DESERIALIZERS = {
-    // `places` stores MVXPlace instances.
     places: (value) => MVXPlace.fromCache(value),
-    // `subPlaces` stores a DataSnapshot wrapping an MVXPlace[].
     subPlaces: (value) => {
         const snapshot = value;
         if (!snapshot || !Array.isArray(snapshot.data))
@@ -19,39 +11,12 @@ const CACHE_DESERIALIZERS = {
         return Object.assign(Object.assign({}, snapshot), { data: snapshot.data.map((place) => MVXPlace.fromCache(place)) });
     },
 };
-/**
- * CacheManager - Facade for managing multiple typed caches
- *
- * Replaces the old Cache singleton with a more flexible, configurable system.
- * Supports:
- * - Multiple cache types (places, routes, configurations, etc.)
- * - Language-aware caching
- * - Optional localStorage persistence
- * - Configurable limits and TTL per cache type
- *
- * @group Configuration
- *
- * @example
- * ```typescript
- * const cacheManager = new CacheManager({
- *   persistent: true,
- *   maxStorageBytes: 5 * 1024 * 1024,
- *   configs: {
- *     places: { maxItems: 1000, ttlMs: 60000 }
- *   }
- * })
- *
- * cacheManager.setPlace("place-1", "en", placeData)
- * const place = cacheManager.getPlace("place-1", "en")
- * ```
- */
 export class CacheManager {
     constructor(config) {
         var _a, _b, _c;
         this.caches = new Map();
         this.persistent = (_a = config === null || config === void 0 ? void 0 : config.persistent) !== null && _a !== void 0 ? _a : false;
         this.maxStorageBytes = (_b = config === null || config === void 0 ? void 0 : config.maxStorageBytes) !== null && _b !== void 0 ? _b : DEFAULT_MAX_STORAGE_BYTES;
-        // Initialize all cache types
         const cacheTypes = [
             "places",
             "routes",
@@ -67,42 +32,22 @@ export class CacheManager {
             this.caches.set(cacheType, this.createCache(cacheConfig, CACHE_DESERIALIZERS[cacheType]));
         }
     }
-    /**
-     * Creates a cache instance based on persistence configuration.
-     *
-     * @param config - Per-type cache configuration.
-     * @param deserialize - Optional reviver forwarded to the persistent cache to
-     *   rebuild class prototypes when values are rehydrated from localStorage.
-     */
     createCache(config, deserialize) {
         if (this.persistent && config.persistenceKey) {
             return new PersistentCache(config, this.maxStorageBytes, deserialize);
         }
         return new LRUCache(config);
     }
-    /**
-     * Generates a language-aware cache key
-     */
     makeKey(id, lang) {
         return `${id}_${lang}`;
     }
-    /**
-     * Generates a composite key for configurations
-     */
     makeConfigKey(placeId, product, lang) {
         return `${placeId || "default"}_${product || "default"}_${lang}`;
     }
-    // ==================== Places ====================
     getPlace(id, lang) {
         const cache = this.caches.get("places");
         return cache.get(this.makeKey(id, lang));
     }
-    /**
-     * Stores a place in cache
-     * @param id - Place ID
-     * @param value - Place data
-     * @param lang - Language code
-     */
     setPlace(id, value, lang) {
         const cache = this.caches.get("places");
         cache.set(this.makeKey(id, lang), value);
@@ -111,7 +56,6 @@ export class CacheManager {
         const cache = this.caches.get("places");
         return cache.has(this.makeKey(id, lang));
     }
-    // ==================== Routes ====================
     getRoute(destinationId) {
         const cache = this.caches.get("routes");
         return cache.get(destinationId);
@@ -123,7 +67,6 @@ export class CacheManager {
     cleanRoutesCache() {
         this.caches.get("routes").clear();
     }
-    // ==================== Accessible Routes ====================
     getAccessibleRoute(destinationId) {
         const cache = this.caches.get("accessibleRoutes");
         return cache.get(destinationId);
@@ -135,7 +78,6 @@ export class CacheManager {
     cleanAccessibleRoutesCache() {
         this.caches.get("accessibleRoutes").clear();
     }
-    // ==================== Configurations ====================
     getConfiguration(placeId, product, lang) {
         const cache = this.caches.get("configurations");
         return cache.get(this.makeConfigKey(placeId, product, lang));
@@ -144,7 +86,6 @@ export class CacheManager {
         const cache = this.caches.get("configurations");
         cache.set(this.makeConfigKey(placeId, product, lang), value);
     }
-    // ==================== Categories ====================
     getCategories(placeId, lang) {
         const cache = this.caches.get("categories");
         return cache.get(this.makeKey(placeId || "default", lang));
@@ -153,63 +94,35 @@ export class CacheManager {
         const cache = this.caches.get("categories");
         cache.set(this.makeKey(placeId || "default", lang), value);
     }
-    // ==================== Vehicles ====================
     getVehicle(id, lang) {
         const cache = this.caches.get("vehicles");
         return cache.get(this.makeKey(id, lang));
     }
-    /**
-     * Stores a vehicle in cache
-     * @param id - Stop ID
-     * @param value - Vehicle data (can be DataSnapshot for backward compatibility)
-     * @param lang - Language code
-     */
     setVehicle(id, value, lang) {
         const cache = this.caches.get("vehicles");
         cache.set(this.makeKey(id, lang), value);
     }
-    // ==================== Stops ====================
     getStops(id, lang) {
         const cache = this.caches.get("stops");
         return cache.get(this.makeKey(id, lang));
     }
-    /**
-     * Stores stops in cache
-     * @param id - Combined stop+vehicle ID
-     * @param value - Stops data (can be DataSnapshot for backward compatibility)
-     * @param lang - Language code
-     */
     setStops(id, value, lang) {
         const cache = this.caches.get("stops");
         cache.set(this.makeKey(id, lang), value);
     }
-    // ==================== SubPlaces ====================
     getSubPlaces(parentPlaceId, lang) {
         const cache = this.caches.get("subPlaces");
         return cache.get(this.makeKey(parentPlaceId, lang));
     }
-    /**
-     * Stores subplaces in cache
-     * @param parentPlaceId - Parent place ID
-     * @param lang - Language code
-     * @param value - SubPlaces data (can be DataSnapshot for backward compatibility)
-     */
     setSubPlaces(parentPlaceId, lang, value) {
         const cache = this.caches.get("subPlaces");
         cache.set(this.makeKey(parentPlaceId, lang), value);
     }
-    // ==================== Global Operations ====================
-    /**
-     * Clears all caches
-     */
     cleanAllCache() {
         for (const cache of this.caches.values()) {
             cache.clear();
         }
     }
-    /**
-     * Clears all entries for a specific language across all language-aware caches
-     */
     cleanLanguageCache(lang) {
         const languageAwareCaches = [
             "places",
@@ -230,9 +143,6 @@ export class CacheManager {
             }
         }
     }
-    /**
-     * Gets statistics for a specific cache type
-     */
     getCacheStats(cacheType) {
         const cache = this.caches.get(cacheType);
         if (!cache) {
@@ -240,9 +150,6 @@ export class CacheManager {
         }
         return cache.getStats();
     }
-    /**
-     * Gets statistics for all caches
-     */
     getAllCacheStats() {
         const stats = {};
         for (const [cacheType, cache] of this.caches) {
@@ -251,4 +158,3 @@ export class CacheManager {
         return stats;
     }
 }
-//# sourceMappingURL=CacheManager.js.map

package/dist/es/infrastructure/cache/LRUCache.d.ts

@@ -67,4 +67,3 @@ export declare class LRUCache<T> implements ICache<T> {
      */
     private evictLRU;
 }
-//# sourceMappingURL=LRUCache.d.ts.map