@mapvx/web-js 4.0.3 → 4.0.4

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

@@ -18,4 +18,3 @@ export interface DeviceOrientationEventExtended extends DeviceOrientationEvent {
  * @group Utils
  */
 export declare function isDeviceOrientationEventExtended(event: Event): event is DeviceOrientationEventExtended;
-//# sourceMappingURL=_internal.d.ts.map

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

@@ -1,11 +1,3 @@
-/**
- * Type guard function to check if an event is a DeviceOrientationEventExtended
- *
- * @param event The event to check
- * @returns True if the event is a DeviceOrientationEventExtended, false otherwise
- * @group Utils
- */
 export function isDeviceOrientationEventExtended(event) {
     return event instanceof DeviceOrientationEvent;
 }
-//# sourceMappingURL=_internal.js.map

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

@@ -185,4 +185,3 @@ export declare class InternalAnimationDrawingConfig implements AnimationDrawingC
     get aheadConfig(): InternalDrawRouteConfiguration;
     get behindConfig(): InternalDrawRouteConfiguration;
 }
-//# sourceMappingURL=animation.d.ts.map

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

@@ -12,11 +12,6 @@ export class InternalAnimationConfig {
         this.autoFitByPlace = config.autoFitByPlace;
     }
 }
-/**
- * Represents the drawing configuration for the animation.
- * @group Routes
- * @hidden
- */
 export class InternalAnimationDrawingConfig {
     constructor(data) {
         var _a, _b, _c;
@@ -56,4 +51,3 @@ export class InternalAnimationDrawingConfig {
         });
     }
 }
-//# sourceMappingURL=animation.js.map

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

@@ -61,4 +61,3 @@ export declare class Banner {
      */
     constructor(rawBanner: BannerResponse);
 }
-//# sourceMappingURL=banner.d.ts.map

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

@@ -1,13 +1,4 @@
-/**
- * Class that represents a banner in MapVX.
- * Contains information about the image, tags, and banner behavior.
- * @group Places & Locations
- */
 export class Banner {
-    /**
-     * Creates a new banner instance from API response data
-     * @param rawBanner API response data containing banner information
-     */
     constructor(rawBanner) {
         var _a;
         this.url = rawBanner.url;
@@ -17,4 +8,3 @@ export class Banner {
         this.description = rawBanner.description;
     }
 }
-//# sourceMappingURL=banner.js.map

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

@@ -113,4 +113,3 @@ export declare class Campaign {
      */
     constructor(rawCampaign: CampaignResponse);
 }
-//# sourceMappingURL=campaign.d.ts.map

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

@@ -1,40 +1,12 @@
-/**
- * Resolves a campaign image's media kind, tolerating the casing and spelling variations a
- * backend can return.
- *
- * A strict `mediaType === "video"` check silently classifies `"VIDEO"`, `"Video"` and
- * `"video/mp4"` as images, which puts an mp4 URL in an `<img>` slot — the screensaver
- * then holds a blank frame with no warning anywhere. The MIME-ish `type` field is
- * consulted as a fallback because it carries the same information (`"video/mp4"`) when
- * `mediaType` is missing or unrecognized.
- *
- * @param mediaType Raw `mediaType` from the API response, if any.
- * @param type Raw MIME `type` from the API response, used as the fallback signal.
- * @returns `"video"` when either field identifies video, otherwise `"image"`.
- * @hidden
- */
 function resolveMediaType(mediaType, type) {
     const declared = mediaType === null || mediaType === void 0 ? void 0 : mediaType.trim().toLowerCase();
     if (declared === "video" || (declared === null || declared === void 0 ? void 0 : declared.startsWith("video/")))
         return "video";
     if (declared === "image" || (declared === null || declared === void 0 ? void 0 : declared.startsWith("image/")))
         return "image";
-    // `mediaType` absent or unrecognized: fall back to the MIME type.
     return (type === null || type === void 0 ? void 0 : type.trim().toLowerCase().startsWith("video/")) ? "video" : "image";
 }
-/**
- * A campaign shown by a totem screensaver. Its media items and weekly schedules
- * drive the playlist; the SDK returns campaigns for a maps-group verbatim (it does
- * NOT filter by status/date/schedule — the consumer decides which are active).
- * @group Campaigns
- */
 export class Campaign {
-    /**
-     * Creates a campaign from API response data, applying the same normalization the
-     * backend uses: an unrecognized `mediaType` falls back to the MIME `type` and then to
-     * `"image"`, `endDate` defaults to `null`, and `order` mirrors `sortOrder`.
-     * @param rawCampaign API response data for a campaign.
-     */
     constructor(rawCampaign) {
         var _a, _b, _c, _d, _e, _f;
         this.id = rawCampaign.id;
@@ -66,4 +38,3 @@ export class Campaign {
         }));
     }
 }
-//# sourceMappingURL=campaign.js.map

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

@@ -178,4 +178,3 @@ export declare function isBasicWithIcon(category: BasicCategory): category is Ba
  */
 export declare function isBasicWithImageUrl(category: BasicCategory): category is BasicWithImageUrl;
 export {};
-//# sourceMappingURL=categories.d.ts.map

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

@@ -1,32 +1,12 @@
-// Category.ts
-/**
- * Checks if the category carries a logo image.
- * @group Utils
- * @param category - The category to inspect.
- * @returns `true` if the category exposes a non-empty `logo` URL, narrowing it to {@link BasicWithLogo}.
- */
 export function isBasicWithLogo(category) {
     const input = category;
     return input.logo != null && input.logo !== "";
 }
-/**
- * Checks if the category carries a Font Awesome icon.
- * @group Utils
- * @param category - The category to inspect.
- * @returns `true` if the category exposes a non-empty `icon` name, narrowing it to {@link BasicWithIcon}.
- */
 export function isBasicWithIcon(category) {
     const input = category;
     return input.icon != null && input.icon !== "";
 }
-/**
- * Checks if the category carries an image URL.
- * @group Utils
- * @param category - The category to inspect.
- * @returns `true` if the category exposes a non-empty `imageUrl`, narrowing it to {@link BasicWithImageUrl}.
- */
 export function isBasicWithImageUrl(category) {
     const input = category;
     return input.imageUrl != null && input.imageUrl !== "";
 }
-//# sourceMappingURL=categories.js.map

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

@@ -219,4 +219,3 @@ export declare function resolveCircleConfig(config: CircleConfig, hidden?: boole
  * @group Circles
  */
 export declare function circleRing(lng: number, lat: number, radiusMeters: number, points?: number): [number, number][];
-//# sourceMappingURL=circle.d.ts.map

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

@@ -1,26 +1,10 @@
 import { generateHexadecimalKey } from "../../utils/utils";
-/**
- * MapVX brand color used as the default for circle styling and other
- * SDK-drawn overlays (colored places, borders).
- *
- * @group Circles
- */
 export const MAPVX_BRAND_COLOR = "#276EF1";
-/**
- * Valid values for {@link CircleRenderOrder}, in rendering order.
- * @internal
- */
 export const CIRCLE_RENDER_ORDERS = [
     "belowLabels",
     "aboveBasemap",
     "top",
 ];
-/**
- * Default styling values applied to a circle when the corresponding
- * {@link CircleConfig} fields are omitted.
- *
- * @group Circles
- */
 export const CIRCLE_DEFAULTS = {
     fillColor: MAPVX_BRAND_COLOR,
     fillOpacity: 0.14,
@@ -29,36 +13,14 @@ export const CIRCLE_DEFAULTS = {
     strokeOpacity: 0.65,
     renderOrder: "aboveBasemap",
 };
-/**
- * Returns a deep copy of a {@link CircleRecord}, including the nested
- * coordinate. Used by the map accessors so callers can't mutate internal
- * circle state by writing to a returned record.
- *
- * @param record The circle record to clone.
- * @returns An independent copy of the record.
- *
- * @group Circles
- */
 export function cloneCircleRecord(record) {
     return Object.assign(Object.assign({}, record), { coordinate: Object.assign({}, record.coordinate) });
 }
-/**
- * Validates that a radius in meters is positive and finite.
- * @param radius The radius value to validate.
- * @throws {Error} If radius is ≤ 0 or not finite (NaN/Infinity).
- * @internal
- */
 function validateRadiusMeters(radius) {
     if (!Number.isFinite(radius) || radius <= 0) {
         throw new Error(`Invalid radiusMeters: ${radius}. Must be a positive finite number.`);
     }
 }
-/**
- * Validates that a coordinate is within valid geographic bounds.
- * @param coord The coordinate to validate.
- * @throws {Error} If latitude is outside [-90, 90] or longitude outside [-180, 180], or not finite.
- * @internal
- */
 function validateCoordinate(coord) {
     if (coord == null || typeof coord !== "object") {
         throw new Error("Invalid coordinate: expected an object with lat and lng properties.");
@@ -73,36 +35,11 @@ function validateCoordinate(coord) {
             `latitude must be in [-90, 90], longitude in [-180, 180], and both finite.`);
     }
 }
-/**
- * Clamps an opacity value to the valid range [0, 1].
- * @param opacity The opacity value to clamp.
- * @param defaultValue Value to use if opacity is not a finite number.
- * @returns The clamped opacity value.
- * @internal
- */
 function clampOpacity(opacity, defaultValue) {
     if (!Number.isFinite(opacity))
         return defaultValue;
     return Math.max(0, Math.min(1, opacity));
 }
-/**
- * Type guard for validating circle configurations without throwing.
- * Returns true if the configuration is valid and can be added to the map.
- *
- * @param config Configuration to validate.
- * @returns True if config is a valid CircleConfig, false otherwise.
- *
- * @example
- * ```typescript
- * if (isValidCircleConfig(userInput)) {
- *   map.addCircle(userInput);
- * } else {
- *   console.error('Invalid circle configuration');
- * }
- * ```
- *
- * @group Circles
- */
 export function isValidCircleConfig(config) {
     if (config === null || config === undefined || typeof config !== "object") {
         return false;
@@ -152,17 +89,6 @@ export function isValidCircleConfig(config) {
     }
     return true;
 }
-/**
- * Resolves a {@link CircleConfig} into a {@link CircleRecord}, applying
- * default styling, generating an id when one is not provided, and validating inputs.
- *
- * @param config Circle configuration provided by the SDK consumer.
- * @param hidden Initial hidden state, defaults to visible.
- * @returns The resolved circle record ready to be stored and rendered.
- * @throws {Error} If radiusMeters is ≤ 0, not finite, or coordinates are invalid.
- *
- * @group Circles
- */
 export function resolveCircleConfig(config, hidden = false) {
     var _a, _b, _c, _d, _e;
     validateRadiusMeters(config.radiusMeters);
@@ -173,8 +99,6 @@ export function resolveCircleConfig(config, hidden = false) {
     }
     return {
         id: (_a = config.id) !== null && _a !== void 0 ? _a : generateHexadecimalKey(),
-        // Copy the coordinate so later mutations of the caller's object
-        // can't change internal circle state
         coordinate: { lat: config.coordinate.lat, lng: config.coordinate.lng },
         radiusMeters: config.radiusMeters,
         fillColor: (_b = config.fillColor) !== null && _b !== void 0 ? _b : CIRCLE_DEFAULTS.fillColor,
@@ -187,47 +111,7 @@ export function resolveCircleConfig(config, hidden = false) {
         hidden,
     };
 }
-/**
- * Builds a closed GeoJSON polygon ring approximating a geographic circle.
- *
- * The ring is computed with an equirectangular approximation: meters are
- * converted to degrees independently per axis, with the longitude scale
- * corrected by the cosine of the latitude. For the radii the SDK works with
- * (tens to hundreds of meters) the metric error is negligible (≤1%) at any latitude
- * where the projection is defined. At extreme polar latitudes, the approximation
- * breaks down, so circles near poles (|lat| > 85°) should be used with caution.
- *
- * @param lng Longitude of the circle center in degrees.
- * @param lat Latitude of the circle center in degrees.
- * @param radiusMeters Radius of the circle in meters. Must be positive and finite.
- * @param points Number of segments in the ring. Defaults to 64. Non-integer
- *               values are floored and the count is clamped to a minimum of 3,
- *               the smallest valid GeoJSON linear ring; non-finite values fall
- *               back to the default.
- * @returns A closed ring of `[lng, lat]` positions (first equals last).
- *
- * @example
- * ```typescript
- * import { circleRing } from '@mapvx/web-js';
- *
- * // Create a 150-meter radius circle ring
- * const ring = circleRing(-74.0060, 40.7128, 150);
- * const polygon = { type: "Polygon", coordinates: [ring] };
- *
- * // Custom segments (32 instead of 64) for lower resolution
- * const coarseRing = circleRing(-74.0060, 40.7128, 150, 32);
- * ```
- *
- * @note Equirectangular approximation is accurate for radii up to ~500 km and
- *       latitudes between approximately ±80°. Beyond these limits, visual
- *       distortion may occur near the poles.
- * @note Generated rings do not account for geographic obstacles, walls, or
- *       buildings. For complex geofencing, consider server-side validation.
- *
- * @group Circles
- */
 export function circleRing(lng, lat, radiusMeters, points = 64) {
-    // A linear ring needs at least 3 distinct positions to be valid GeoJSON
     const segments = Number.isFinite(points) ? Math.max(3, Math.floor(points)) : 64;
     const ring = [];
     const latRad = (lat * Math.PI) / 180;
@@ -239,8 +123,6 @@ export function circleRing(lng, lat, radiusMeters, points = 64) {
         const a = (i / segments) * Math.PI * 2;
         ring.push([lng + lngR * Math.cos(a), lat + latR * Math.sin(a)]);
     }
-    // Close the ring with an exact copy of the first position, as GeoJSON requires
     ring.push([ring[0][0], ring[0][1]]);
     return ring;
 }
-//# sourceMappingURL=circle.js.map

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

@@ -12,4 +12,3 @@ export interface ParentPlaceCityFilterOption {
     institutionId: string;
 }
 export type CityFilterOption = InstitutionCityFilterOption | ParentPlaceCityFilterOption;
-//# sourceMappingURL=cityFilterOption.d.ts.map

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

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

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

@@ -528,4 +528,3 @@ export interface Configuration {
      */
     routingUnitSystem?: string;
 }
-//# sourceMappingURL=configuration.d.ts.map

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

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

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

@@ -60,4 +60,3 @@ export interface CssDefinitions {
      */
     textFonts?: Record<string, string>;
 }
-//# sourceMappingURL=cssCustomization.d.ts.map

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

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

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

@@ -172,4 +172,3 @@ export interface BoundsOptions {
      */
     onComplete?: () => void;
 }
-//# sourceMappingURL=fitOptions.d.ts.map

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

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

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

@@ -39,4 +39,3 @@ export interface InnerFloor {
      */
     reachableFromGPS?: boolean;
 }
-//# sourceMappingURL=innerFloors.d.ts.map

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

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

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

@@ -66,4 +66,3 @@ export declare class Institution {
      */
     constructor(rawInstitution: InstitutionResponse);
 }
-//# sourceMappingURL=institution.d.ts.map

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

@@ -1,30 +1,5 @@
 import { PropertyUtils } from "./property";
-/**
- * MapVX Institution object, is a custom object containing data of conglomerate of places (enterprise or subdivision).
- * Represents a collection of related places that form a larger organizational unit.
- *
- * @example
- * ```typescript
- * const institution = new Institution(institutionResponse);
- * console.log(institution.title); // "Shopping Mall"
- * console.log(institution.hasPlaces); // true
- * ```
- *
- * @group Places & Locations
- */
 export class Institution {
-    /**
-     * Creates a new instance of an Institution object with the rawInstitution arguments.
-     *
-     * @param rawInstitution - JSON configuration parameters for the institution from API response
-     * @returns A new instance of Institution
-     *
-     * @example
-     * ```typescript
-     * const institutionResponse = await fetchInstitutionData(institutionId);
-     * const institution = new Institution(institutionResponse);
-     * ```
-     */
     constructor(rawInstitution) {
         var _a;
         this.mapvxId = rawInstitution.id;
@@ -38,4 +13,3 @@ export class Institution {
         this.properties = PropertyUtils.parseProperties((_a = rawInstitution.properties) !== null && _a !== void 0 ? _a : []);
     }
 }
-//# sourceMappingURL=institution.js.map

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

@@ -11,4 +11,3 @@ export interface LatLng {
  * @group Utils
  */
 export type PositionCallback = (latLng: GeolocationPosition) => void;
-//# sourceMappingURL=latLng.d.ts.map

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

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

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

@@ -7,4 +7,3 @@ export interface MVXLocation extends LatLng {
     floorId?: string;
     placeId?: string;
 }
-//# sourceMappingURL=location.d.ts.map

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

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

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

@@ -39,4 +39,3 @@ export declare abstract class Loggeable {
      */
     protected debugLog(...args: unknown[]): void;
 }
-//# sourceMappingURL=loggeable.d.ts.map

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

@@ -1,35 +1,16 @@
 import { Logger } from "../../logger/logger";
 import { convertToError } from "../../utils/error";
-/**
- * Represents the abstract class for the loggeable.
- * @hidden
- */
 export class Loggeable {
     constructor() {
         this.logger = Logger.getInstance();
     }
-    /**
-     * To log a event in this class.
-     * @param eventName The event name.
-     * @param eventSegmentation The pair key, value to segment this event count.
-     */
     logEvent(eventName, eventSegmentation = {}) {
         this.logger.logEvent(eventName, this.prepareSegmentation(eventSegmentation));
     }
-    /**
-     * To log a captured error in this class.
-     * @param error The captured error
-     * @param args The rest of the arguments.
-     */
     logError(error, ...args) {
         const errorTyped = convertToError(error);
         this.logger.logError(errorTyped, ...args);
     }
-    /**
-     * To log a captured error as a warning.
-     * @param error The captured error
-     * @param args The rest of the arguments.
-     */
     logWarning(error, ...args) {
         const errorTyped = convertToError(error);
         this.logger.logWarning(errorTyped, ...args);
@@ -37,12 +18,7 @@ export class Loggeable {
     logDebug(...args) {
         this.logger.logDebug(...args);
     }
-    /**
-     * Prints in console any number of given arguments, if and only if, app is running in debug mode.
-     * @param args An array of arguments to log
-     */
     debugLog(...args) {
         this.logger.debugLog(args);
     }
 }
-//# sourceMappingURL=loggeable.js.map

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

@@ -106,4 +106,3 @@ export interface CameraAnimation {
      */
     duration?: number;
 }
-//# sourceMappingURL=mapCamera.d.ts.map

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

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

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

@@ -610,4 +610,3 @@ export interface MapConfig {
      */
     onScene3DModelsProgress?: (progress: Scene3DModelsProgress) => void;
 }
-//# sourceMappingURL=mapConfig.d.ts.map

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

@@ -1,28 +1,13 @@
 import { DEFAULT_MAX_LABEL_WIDTH_PX } from "./marker";
-/**
- * Default values for tile cache configuration
- * @internal
- */
 export const DEFAULT_TILE_CACHE_CONFIG = {
     enabled: true,
     maxTiles: 400,
-    ttlMs: 30 * 60 * 1000, // 30 minutes
+    ttlMs: 30 * 60 * 1000,
     persistToServiceWorker: true,
     preloadAdjacentZooms: false,
     maxConcurrentTileFetches: 6,
 };
-/**
- * Hard cap for {@link MapTileCacheConfig.maxTiles}.
- * Configurations above this (e.g. millions) are clamped to avoid memory pressure
- * and excessive interaction with the tile CDN / service worker.
- *
- * @internal
- */
 export const MAPLIBRE_MAX_TILE_CACHE_HARD_CAP = 100000;
-/**
- * Default values for marker layout configuration
- * @internal
- */
 export const DEFAULT_MARKER_LAYOUT_CONFIG = {
     enabled: true,
     minZoomForLabels: Number.NEGATIVE_INFINITY,
@@ -31,4 +16,3 @@ export const DEFAULT_MARKER_LAYOUT_CONFIG = {
     paddingPx: 4,
     maxLabelWidthPx: DEFAULT_MAX_LABEL_WIDTH_PX,
 };
-//# sourceMappingURL=mapConfig.js.map

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

@@ -564,4 +564,3 @@ export declare class MarkerAttribute extends Marker {
     changeFloor(floorId: string | null | undefined, map: Map, isOutdoor?: boolean): void;
 }
 export {};
-//# sourceMappingURL=marker.d.ts.map