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

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

@@ -1,63 +1,30 @@
-/**
- * LRU (Least Recently Used) Cache implementation
- * Implements the ICache interface with:
- * - Configurable capacity limits
- * - TTL-based expiration
- * - LRU eviction policy
- * - Hit rate tracking
- *
- * @typeParam T - The type of values stored in the cache
- * @group Configuration
- *
- * @example
- * ```typescript
- * const cache = new LRUCache<string>({ maxItems: 100, ttlMs: 60000 })
- * cache.set("key1", "value1")
- * const value = cache.get("key1") // "value1"
- * ```
- */
 export class LRUCache {
     constructor(config) {
-        // Hit rate tracking
         this.hits = 0;
         this.misses = 0;
-        // Monotonic counter for LRU ordering (avoids issues with same-millisecond operations)
         this.accessCounter = 0;
         this.cache = new Map();
         this.maxItems = config.maxItems;
         this.ttlMs = config.ttlMs;
     }
-    /**
-     * Retrieves a value from the cache
-     * Updates access time for LRU tracking
-     * Returns undefined if key doesn't exist or is expired
-     */
     get(key) {
         const entry = this.cache.get(key);
         if (!entry) {
             this.misses++;
             return undefined;
         }
-        // Check TTL expiration (skip if ttlMs is 0)
         if (this.ttlMs > 0 && this.isExpired(entry)) {
             this.cache.delete(key);
             this.misses++;
             return undefined;
         }
-        // Update access time for LRU (using monotonic counter)
         entry.accessTime = ++this.accessCounter;
         this.hits++;
         return entry.value;
     }
-    /**
-     * Stores a value in the cache
-     * Evicts LRU item if at capacity
-     * Refreshes TTL for existing keys
-     */
     set(key, value) {
         const now = Date.now();
         const accessTime = ++this.accessCounter;
-        // If key already exists, update it (no eviction needed)
         if (this.cache.has(key)) {
             this.cache.set(key, {
                 value,
@@ -66,7 +33,6 @@ export class LRUCache {
             });
             return;
         }
-        // Evict if at capacity
         if (this.cache.size >= this.maxItems) {
             this.evictLRU();
         }
@@ -76,44 +42,28 @@ export class LRUCache {
             accessTime,
         });
     }
-    /**
-     * Checks if a key exists and is not expired
-     */
     has(key) {
         const entry = this.cache.get(key);
         if (!entry) {
             return false;
         }
-        // Check TTL expiration
         if (this.ttlMs > 0 && this.isExpired(entry)) {
             this.cache.delete(key);
             return false;
         }
         return true;
     }
-    /**
-     * Removes a specific key from the cache
-     */
     delete(key) {
         return this.cache.delete(key);
     }
-    /**
-     * Removes all entries from the cache
-     */
     clear() {
         this.cache.clear();
         this.hits = 0;
         this.misses = 0;
     }
-    /**
-     * Returns all keys in the cache
-     */
     keys() {
         return Array.from(this.cache.keys());
     }
-    /**
-     * Returns cache statistics
-     */
     getStats() {
         const totalRequests = this.hits + this.misses;
         const hitRate = totalRequests > 0 ? (this.hits / totalRequests) * 100 : undefined;
@@ -123,15 +73,9 @@ export class LRUCache {
             hitRate,
         };
     }
-    /**
-     * Checks if an entry has expired based on TTL
-     */
     isExpired(entry) {
         return Date.now() - entry.timestamp > this.ttlMs;
     }
-    /**
-     * Evicts the least recently used item from the cache
-     */
     evictLRU() {
         let oldestKey = null;
         let oldestAccessTime = Infinity;
@@ -146,4 +90,3 @@ export class LRUCache {
         }
     }
 }
-//# sourceMappingURL=LRUCache.js.map

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

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

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

@@ -1,37 +1,6 @@
 import { DEFAULT_MAX_STORAGE_BYTES } from "./cacheConfig";
 import { LRUCache } from "./LRUCache";
-/**
- * Persistent Cache implementation (Decorator pattern)
- * Wraps LRUCache with localStorage persistence.
- *
- * Features:
- * - Automatic save to localStorage on modifications
- * - Hydration from localStorage on initialization
- * - Graceful degradation when localStorage unavailable
- * - Storage quota management
- * - Expired items filtered during hydration
- *
- * @typeParam T - The type of values stored in the cache
- * @group Configuration
- *
- * @example
- * ```typescript
- * const cache = new PersistentCache<string>({
- *   maxItems: 100,
- *   ttlMs: 60000,
- *   persistenceKey: "my_cache"
- * })
- * cache.set("key1", "value1") // Saved to memory and localStorage
- * ```
- */
 export class PersistentCache {
-    /**
-     * @param config - Cache configuration (limits, TTL, persistence key).
-     * @param maxStorageBytes - Optional per-cache localStorage budget.
-     * @param deserialize - Optional reviver applied to each value read back from
-     *   localStorage. `JSON.parse` strips class prototypes, so values that carry
-     *   methods (e.g. `MVXPlace`) must be rebuilt here; plain-data caches omit it.
-     */
     constructor(config, maxStorageBytes, deserialize) {
         this.storageAvailable = true;
         this.lruCache = new LRUCache(config);
@@ -68,9 +37,6 @@ export class PersistentCache {
     getStats() {
         return this.lruCache.getStats();
     }
-    /**
-     * Loads cache data from localStorage on initialization
-     */
     hydrate() {
         if (!this.isStorageAvailable()) {
             this.storageAvailable = false;
@@ -86,22 +52,16 @@ export class PersistentCache {
             }
             const now = Date.now();
             for (const entry of data.entries) {
-                // Skip expired entries (if TTL is configured)
                 if (this.ttlMs > 0 && now - entry.timestamp > this.ttlMs) {
                     continue;
                 }
-                // Restore to LRU cache, reviving class prototypes stripped by JSON when needed.
                 this.lruCache.set(entry.key, this.deserialize ? this.deserialize(entry.value) : entry.value);
             }
         }
         catch (_a) {
-            // Corrupted data or storage error - start with empty cache
             this.storageAvailable = this.isStorageAvailable();
         }
     }
-    /**
-     * Saves current cache state to localStorage
-     */
     persist() {
         if (!this.storageAvailable)
             return;
@@ -121,21 +81,15 @@ export class PersistentCache {
             }
             const data = { entries };
             const serialized = JSON.stringify(data);
-            // Check storage quota
             if (serialized.length > this.maxStorageBytes) {
-                // Skip persistence if too large
                 return;
             }
             localStorage.setItem(this.persistenceKey, serialized);
         }
         catch (_a) {
-            // Storage quota exceeded or other error
             this.storageAvailable = false;
         }
     }
-    /**
-     * Removes cache data from localStorage
-     */
     removeFromStorage() {
         if (!this.storageAvailable)
             return;
@@ -143,12 +97,8 @@ export class PersistentCache {
             localStorage.removeItem(this.persistenceKey);
         }
         catch (_a) {
-            // Ignore errors
         }
     }
-    /**
-     * Checks if localStorage is available
-     */
     isStorageAvailable() {
         try {
             const testKey = "__storage_test__";
@@ -161,4 +111,3 @@ export class PersistentCache {
         }
     }
 }
-//# sourceMappingURL=PersistentCache.js.map

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

@@ -48,4 +48,3 @@ export declare const DEFAULT_CACHE_CONFIGS: Record<CacheType, CacheConfig>;
  * @returns Complete cache configuration
  */
 export declare function getCacheConfig(cacheType: CacheType, userConfig?: Partial<CacheConfig>): CacheConfig;
-//# sourceMappingURL=cacheConfig.d.ts.map

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

@@ -1,66 +1,47 @@
-/**
- * Cache configuration types and defaults
- * Defines the configuration options for the caching system
- * @module cacheConfig
- */
-/**
- * Default maximum storage size: 5MB
- */
 export const DEFAULT_MAX_STORAGE_BYTES = 5 * 1024 * 1024;
-/**
- * Default cache configurations per type
- * These values balance memory usage with performance
- */
 export const DEFAULT_CACHE_CONFIGS = {
     places: {
         maxItems: 500,
-        ttlMs: 30 * 60 * 1000, // 30 minutes
+        ttlMs: 30 * 60 * 1000,
         persistenceKey: "mvx_places",
     },
     routes: {
         maxItems: 100,
-        ttlMs: 5 * 60 * 1000, // 5 minutes
+        ttlMs: 5 * 60 * 1000,
         persistenceKey: "mvx_routes",
     },
     accessibleRoutes: {
         maxItems: 100,
-        ttlMs: 5 * 60 * 1000, // 5 minutes
+        ttlMs: 5 * 60 * 1000,
         persistenceKey: "mvx_accessible_routes",
     },
     configurations: {
         maxItems: 10,
-        ttlMs: 60 * 60 * 1000, // 1 hour
+        ttlMs: 60 * 60 * 1000,
         persistenceKey: "mvx_configurations",
     },
     categories: {
         maxItems: 20,
-        ttlMs: 60 * 60 * 1000, // 1 hour
+        ttlMs: 60 * 60 * 1000,
         persistenceKey: "mvx_categories",
     },
     vehicles: {
         maxItems: 50,
-        ttlMs: 60 * 1000, // 1 minute
+        ttlMs: 60 * 1000,
         persistenceKey: "mvx_vehicles",
     },
     stops: {
         maxItems: 100,
-        ttlMs: 60 * 1000, // 1 minute
+        ttlMs: 60 * 1000,
         persistenceKey: "mvx_stops",
     },
     subPlaces: {
         maxItems: 200,
-        ttlMs: 15 * 60 * 1000, // 15 minutes
+        ttlMs: 15 * 60 * 1000,
         persistenceKey: "mvx_subplaces",
     },
 };
-/**
- * Merges user config with defaults for a specific cache type
- * @param cacheType - The type of cache
- * @param userConfig - Optional user-provided configuration
- * @returns Complete cache configuration
- */
 export function getCacheConfig(cacheType, userConfig) {
     const defaultConfig = DEFAULT_CACHE_CONFIGS[cacheType];
     return Object.assign(Object.assign({}, defaultConfig), userConfig);
 }
-//# sourceMappingURL=cacheConfig.js.map

package/dist/es/infrastructure/http/FetchHttpClient.d.ts

@@ -38,4 +38,3 @@ export declare class FetchHttpClient implements IHttpClient {
      */
     private request;
 }
-//# sourceMappingURL=FetchHttpClient.d.ts.map

package/dist/es/infrastructure/http/FetchHttpClient.js

@@ -1,51 +1,18 @@
-/**
- * HTTP Client implementation using the Fetch API
- *
- * Implements the IHttpClient interface providing HTTP operations
- * with consistent response handling and JSON serialization.
- *
- * @group Utils
- *
- * @example
- * ```typescript
- * const client = new FetchHttpClient()
- * const response = await client.get<User>('https://api.example.com/users/1')
- * if (response.ok) {
- *   console.log(response.data.name)
- * }
- * ```
- */
 export class FetchHttpClient {
-    /**
-     * Performs a GET request
-     */
     async get(url, options) {
         return this.request(url, "GET", undefined, options);
     }
-    /**
-     * Performs a POST request
-     */
     async post(url, body, options) {
         return this.request(url, "POST", body, options);
     }
-    /**
-     * Performs a PUT request
-     */
     async put(url, body, options) {
         return this.request(url, "PUT", body, options);
     }
-    /**
-     * Performs a DELETE request
-     */
     async delete(url, options) {
         return this.request(url, "DELETE", undefined, options);
     }
-    /**
-     * Internal request method that handles all HTTP methods
-     */
     async request(url, method, body, options) {
         const headers = Object.assign({}, options === null || options === void 0 ? void 0 : options.headers);
-        // Add Content-Type for requests with body
         if (body !== undefined && !headers["Content-Type"]) {
             headers["Content-Type"] = "application/json";
         }
@@ -53,12 +20,10 @@ export class FetchHttpClient {
             method,
             headers,
         };
-        // Add body for POST/PUT requests
         if (body !== undefined) {
             fetchOptions.body = JSON.stringify(body);
         }
         const response = await fetch(url, fetchOptions);
-        // Parse JSON response
         const data = await response.json();
         return {
             ok: response.ok,
@@ -68,4 +33,3 @@ export class FetchHttpClient {
         };
     }
 }
-//# sourceMappingURL=FetchHttpClient.js.map

package/dist/es/infrastructure/logging/MVXLogger.d.ts

@@ -46,4 +46,3 @@ export declare class MVXLogger implements ILogger {
      */
     private enrichSegmentation;
 }
-//# sourceMappingURL=MVXLogger.d.ts.map

package/dist/es/infrastructure/logging/MVXLogger.js

@@ -1,36 +1,12 @@
 import { Logger } from "../../logger/logger";
-/**
- * MapVX Logger Adapter
- *
- * Default {@link ILogger} implementation for the SDK. Provider-agnostic by name
- * so the underlying error-tracking backend can change without affecting the
- * public API. It wraps the internal Logger singleton: errors are captured as
- * exceptions and events/warnings are recorded as breadcrumbs (currently backed
- * by Sentry).
- *
- * @group Utils
- *
- * @example
- * ```typescript
- * const logger: ILogger = new MVXLogger()
- * logger.logEvent("user_action", { action: "click" })
- * logger.logError(new Error("Something failed"))
- * ```
- */
 export class MVXLogger {
     constructor() {
         this.logger = Logger.getInstance();
     }
-    /**
-     * Records an analytics-style event as a Sentry breadcrumb.
-     */
     logEvent(eventName, segmentation) {
         const enrichedSegmentation = this.enrichSegmentation(segmentation);
         this.logger.logEvent(eventName, enrichedSegmentation);
     }
-    /**
-     * Captures an error as a Sentry exception.
-     */
     logError(error, context) {
         if (error instanceof Error) {
             this.logger.logError(error, context);
@@ -39,9 +15,6 @@ export class MVXLogger {
             this.logger.logError(String(error), context);
         }
     }
-    /**
-     * Records a warning as a Sentry breadcrumb.
-     */
     logWarning(error, context) {
         if (error instanceof Error) {
             this.logger.logWarning(error, context);
@@ -50,21 +23,12 @@ export class MVXLogger {
             this.logger.logWarning(String(error), context);
         }
     }
-    /**
-     * Logs debug information (only in debug mode)
-     */
     logDebug(...args) {
         this.logger.debugLog(...args);
     }
-    /**
-     * Sets the API token used to enrich event segmentation.
-     */
     setToken(token) {
         this.token = token;
     }
-    /**
-     * Enriches segmentation with token if available
-     */
     enrichSegmentation(segmentation) {
         const base = segmentation !== null && segmentation !== void 0 ? segmentation : {};
         if (this.token) {
@@ -73,4 +37,3 @@ export class MVXLogger {
         return base;
     }
 }
-//# sourceMappingURL=MVXLogger.js.map

package/dist/es/interfaces/cache.d.ts

@@ -2,4 +2,3 @@ export interface DataSnapshot<T> {
     timestamp: number;
     data: T;
 }
-//# sourceMappingURL=cache.d.ts.map

package/dist/es/interfaces/cache.js

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

package/dist/es/interfaces/healthResponse.d.ts

@@ -14,4 +14,3 @@ export interface HealthResponse {
     host: string;
     referer: string;
 }
-//# sourceMappingURL=healthResponse.d.ts.map

package/dist/es/interfaces/healthResponse.js

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

package/dist/es/interfaces/institutionResponse.d.ts

@@ -10,4 +10,3 @@ export interface InstitutionResponse {
     city?: string;
     properties?: PropertyResponse[];
 }
-//# sourceMappingURL=institutionResponse.d.ts.map

package/dist/es/interfaces/institutionResponse.js

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

package/dist/es/interfaces/metadata.d.ts

@@ -4,4 +4,3 @@ export interface Metadata {
     logo?: string;
     tags?: string[];
 }
-//# sourceMappingURL=metadata.d.ts.map

package/dist/es/interfaces/metadata.js

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

package/dist/es/interfaces/placeResponse.d.ts

@@ -47,4 +47,3 @@ export interface PlaceResponse {
     metadata?: Metadata;
     visibility?: "public" | "protected" | "hidden";
 }
-//# sourceMappingURL=placeResponse.d.ts.map

package/dist/es/interfaces/placeResponse.js

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

package/dist/es/interfaces/routeCacheResponse.d.ts

@@ -10,4 +10,3 @@ export interface RouteCacheResponse {
 export interface CacheTimestampResponse {
     lastUpdate: number;
 }
-//# sourceMappingURL=routeCacheResponse.d.ts.map

package/dist/es/interfaces/routeCacheResponse.js

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

package/dist/es/interfaces/routeResponse.d.ts

@@ -39,4 +39,3 @@ export interface RoutePolylineResponse {
     points_lat_lng?: LatLng[];
     overview_points?: LatLng[];
 }
-//# sourceMappingURL=routeResponse.d.ts.map

package/dist/es/interfaces/routeResponse.js

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

package/dist/es/interfaces/styleResponse.d.ts

@@ -2,4 +2,3 @@ import { type StyleSpecification } from "maplibre-gl";
 export interface StyleResponse {
     style: string | StyleSpecification;
 }
-//# sourceMappingURL=styleResponse.d.ts.map

package/dist/es/interfaces/styleResponse.js

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

package/dist/es/logger/logger.d.ts

@@ -9,4 +9,3 @@ export declare class Logger {
     logError(...args: unknown[]): void;
     debugLog(...args: unknown[]): void;
 }
-//# sourceMappingURL=logger.d.ts.map

package/dist/es/logger/logger.js

@@ -1,8 +1,4 @@
 import { createSentryScope, stringifyLogArgument } from "./sentry";
-// DEBUG is a webpack DefinePlugin constant, substituted only in the UMD bundle.
-// The tsc-built ES/CJS outputs keep it as a bare global, so reading it directly
-// throws ReferenceError in consumers of those builds. The typeof guard makes
-// the lookup safe everywhere.
 const IS_DEBUG = typeof DEBUG !== "undefined" ? DEBUG : false;
 export class Logger {
     constructor() {
@@ -24,9 +20,6 @@ export class Logger {
             console.log(eventName, eventSegmentation);
         }
         else {
-            // Sentry is an error-tracking service, not an analytics platform, so the
-            // former Countly analytics events are recorded as breadcrumbs. They carry
-            // no value on their own but add context to the next captured error.
             (_a = this.sentry) === null || _a === void 0 ? void 0 : _a.addBreadcrumb({
                 category: "event",
                 message: eventName,
@@ -46,8 +39,6 @@ export class Logger {
             console.warn(...args);
         }
         else {
-            // Warnings are not reported to Sentry on their own (matching the previous
-            // error-only report level) but are kept as breadcrumbs for context.
             (_a = this.sentry) === null || _a === void 0 ? void 0 : _a.addBreadcrumb({
                 category: "warning",
                 level: "warning",
@@ -71,4 +62,3 @@ export class Logger {
             console.log(...args);
     }
 }
-//# sourceMappingURL=logger.js.map

package/dist/es/logger/sentry.d.ts

@@ -16,4 +16,3 @@ export declare function createSentryScope(): Scope;
  * error messages.
  */
 export declare function stringifyLogArgument(arg: unknown): string;
-//# sourceMappingURL=sentry.d.ts.map