@mapvx/web-js 1.0.0

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

@@ -0,0 +1,396 @@
+import { Marker } from "maplibre-gl";
+import { generateHexadecimalKey } from "../../utils/utils";
+/**
+ * Represents the possible placements of text elements in a marker container.
+ * Defines the relative positioning of text labels around marker icons.
+ *
+ * @example
+ * ```typescript
+ * const markerConfig: MarkerConfig = {
+ *   text: "Coffee Shop",
+ *   textPosition: TextPosition.right,
+ *   coordinate: { lat: 40.7128, lng: -74.0060 }
+ * };
+ * ```
+ *
+ * @group Markers
+ */
+export var TextPosition;
+(function (TextPosition) {
+    /** Text positioned to the left of the icon */
+    TextPosition[TextPosition["left"] = 0] = "left";
+    /** Text positioned to the right of the icon */
+    TextPosition[TextPosition["right"] = 1] = "right";
+    /** Text positioned above the icon */
+    TextPosition[TextPosition["top"] = 2] = "top";
+    /** Text positioned below the icon */
+    TextPosition[TextPosition["bottom"] = 3] = "bottom";
+})(TextPosition || (TextPosition = {}));
+/**
+ * Utility class for creating and manipulating marker elements on a map.
+ * Provides static methods for marker element creation and styling.
+ */
+class MarkerUtils {
+    /**
+     * Creates a container element for the marker and adds the icon and text
+     * according to the properties specified in the `MarkerConfig` object.
+     *
+     * @param marker - `MarkerConfig` object containing the marker configuration
+     * @returns Marker container element ready to be added to the map
+     *
+     * @example
+     * ```typescript
+     * const markerElement = MarkerUtils.createMarkerElement(markerConfig);
+     * map.addLayer(markerElement);
+     * ```
+     */
+    static createMarkerElement(marker) {
+        var _a, _b, _c, _d;
+        const markerContainer = document.createElement("div");
+        // Configure specific marker dimensions
+        const iconWidth = (_b = (_a = marker.iconProperties) === null || _a === void 0 ? void 0 : _a.width) !== null && _b !== void 0 ? _b : 40;
+        const iconHeight = (_d = (_c = marker.iconProperties) === null || _c === void 0 ? void 0 : _c.height) !== null && _d !== void 0 ? _d : 40;
+        // Apply base class
+        markerContainer.className = "mapvx-marker";
+        // Configure classes and dimensions based on text presence
+        if (marker.text) {
+            // If text exists, adjust layout according to position
+            switch (marker.textPosition) {
+                case TextPosition.top:
+                case TextPosition.bottom:
+                    markerContainer.classList.add("text-column");
+                    markerContainer.style.width = `${Math.max(iconWidth, 200)}px`;
+                    markerContainer.style.height = "auto";
+                    break;
+                case TextPosition.left:
+                case TextPosition.right:
+                default:
+                    markerContainer.classList.add("text-row");
+                    markerContainer.style.width = "auto";
+                    markerContainer.style.height = `${iconHeight}px`;
+                    break;
+            }
+        }
+        else {
+            // No text, use fixed icon dimensions as in official example
+            markerContainer.classList.add("no-text");
+            markerContainer.style.width = `${iconWidth}px`;
+            markerContainer.style.height = `${iconHeight}px`;
+        }
+        markerContainer.addEventListener("click", () => {
+            var _a;
+            (_a = marker.onClick) === null || _a === void 0 ? void 0 : _a.call(marker);
+        });
+        if (marker.element) {
+            markerContainer.appendChild(marker.element);
+            return this.setAndCreateText(marker, markerContainer, `${iconHeight}px`, `${iconWidth}px`);
+        }
+        // Create elements in correct order according to textPosition
+        const iconElement = this.createIconElement(marker, iconWidth, iconHeight);
+        const textElement = marker.text
+            ? this.createTextContainer(typeof marker.text === "string"
+                ? this.createTextElement(marker.text, marker.textProperties)
+                : marker.text, marker.textPosition)
+            : null;
+        // Add elements in correct order
+        if (marker.textPosition === TextPosition.top || marker.textPosition === TextPosition.left) {
+            if (textElement)
+                markerContainer.appendChild(textElement);
+            markerContainer.appendChild(iconElement);
+        }
+        else {
+            markerContainer.appendChild(iconElement);
+            if (textElement)
+                markerContainer.appendChild(textElement);
+        }
+        return markerContainer;
+    }
+    /**
+     * Sets up text positioning and styling for the marker.
+     *
+     * @param markerConfig - Configuration object containing text properties
+     * @param container - Container element where text will be added
+     * @param iconHeight - Height of the icon for positioning calculations
+     * @param iconWidth - Width of the icon for positioning calculations
+     * @returns Container element with properly positioned text
+     */
+    static setAndCreateText(markerConfig, container, iconHeight, iconWidth) {
+        if (markerConfig.text) {
+            const textElement = typeof markerConfig.text === "string"
+                ? this.createTextElement(markerConfig.text, markerConfig.textProperties)
+                : markerConfig.text;
+            const textContainer = this.createTextContainer(textElement, markerConfig.textPosition);
+            container.appendChild(textContainer);
+        }
+        return container;
+    }
+    /**
+     * Creates an icon element with proper styling.
+     *
+     * @param marker - Marker configuration
+     * @param iconWidth - Width of the icon
+     * @param iconHeight - Height of the icon
+     * @returns Icon element ready to be added to the container
+     */
+    static createIconElement(marker, iconWidth, iconHeight) {
+        if (typeof marker.icon === "string") {
+            return this.createIcon(marker);
+        }
+        else if (marker.icon instanceof HTMLImageElement) {
+            marker.icon.style.width = `${iconWidth}px`;
+            marker.icon.style.height = `${iconHeight}px`;
+            return marker.icon;
+        }
+        else if (marker.icon) {
+            return marker.icon;
+        }
+        else {
+            // Create default element if no icon is provided
+            const defaultIcon = document.createElement("div");
+            defaultIcon.className = "icon-default";
+            defaultIcon.style.width = `${iconWidth}px`;
+            defaultIcon.style.height = `${iconHeight}px`;
+            return defaultIcon;
+        }
+    }
+    /**
+     * Creates a text container with proper positioning using CSS classes.
+     * Uses natural block/flex layout without absolute positioning.
+     *
+     * @param textElement - The text element to contain
+     * @param textPosition - Desired position relative to the icon
+     * @returns Container with text positioned using CSS classes
+     */
+    static createTextContainer(textElement, textPosition) {
+        const textContainer = document.createElement("div");
+        // Apply base class
+        textContainer.className = "text-container";
+        // Apply position class
+        switch (textPosition) {
+            case TextPosition.top:
+                textContainer.classList.add("top");
+                break;
+            case TextPosition.bottom:
+                textContainer.classList.add("bottom");
+                break;
+            case TextPosition.left:
+                textContainer.classList.add("left");
+                break;
+            default: // right
+                textContainer.classList.add("right");
+                break;
+        }
+        textElement.style.display = "block";
+        textElement.style.margin = "0";
+        textContainer.appendChild(textElement);
+        return textContainer;
+    }
+    /**
+     * Creates and returns an icon element for the marker, using the image URL
+     * specified in the `MarkerConfig` object.
+     *
+     * @param marker - `MarkerConfig` object containing the marker configuration
+     * @returns Marker icon element with proper styling and dimensions
+     *
+     * @example
+     * ```typescript
+     * const iconElement = MarkerUtils.createIcon(markerConfig);
+     * container.appendChild(iconElement);
+     * ```
+     */
+    static createIcon(marker) {
+        var _a, _b, _c, _d;
+        const image = document.createElement("img");
+        image.src = typeof marker.icon == "string" ? marker.icon : "";
+        image.width = (_b = (_a = marker.iconProperties) === null || _a === void 0 ? void 0 : _a.width) !== null && _b !== void 0 ? _b : 40;
+        image.height = (_d = (_c = marker.iconProperties) === null || _c === void 0 ? void 0 : _c.height) !== null && _d !== void 0 ? _d : 40;
+        image.style.objectFit = "contain";
+        image.style.filter = "drop-shadow(0px 4px 4px rgba(0, 0, 0, 0.25))";
+        return image;
+    }
+    /**
+     * Creates and returns a text element for the marker container, applying
+     * custom text styles if provided in the marker properties.
+     *
+     * @param text - Text content to display
+     * @param properties - Optional text styling properties
+     * @returns Text element with applied styles
+     *
+     * @example
+     * ```typescript
+     * const textElement = MarkerUtils.createTextElement("Coffee Shop", {
+     *   fontSize: "14px",
+     *   color: "#333333"
+     * });
+     * ```
+     */
+    static createTextElement(text, properties) {
+        var _a, _b, _c, _d, _e, _f, _g;
+        const textElement = document.createElement("p");
+        textElement.textContent = text;
+        textElement.style.fontSize = (_a = properties === null || properties === void 0 ? void 0 : properties.fontSize) !== null && _a !== void 0 ? _a : "14px";
+        textElement.style.padding = (_b = properties === null || properties === void 0 ? void 0 : properties.padding) !== null && _b !== void 0 ? _b : "0px";
+        textElement.style.margin = (_c = properties === null || properties === void 0 ? void 0 : properties.margin) !== null && _c !== void 0 ? _c : "0px";
+        textElement.style.fontWeight = (_d = properties === null || properties === void 0 ? void 0 : properties.fontWeight) !== null && _d !== void 0 ? _d : "600";
+        textElement.style.fontFamily = (_e = properties === null || properties === void 0 ? void 0 : properties.fontFamily) !== null && _e !== void 0 ? _e : "'Open Sans', sans-serif";
+        textElement.style.color = (_f = properties === null || properties === void 0 ? void 0 : properties.color) !== null && _f !== void 0 ? _f : "#000000";
+        textElement.style.textShadow =
+            (_g = properties === null || properties === void 0 ? void 0 : properties.textShadow) !== null && _g !== void 0 ? _g : "-1px -1px 0 #fff, 1px -1px 0 #fff, -1px  1px 0 #fff, 1px  1px 0 #fff";
+        return textElement;
+    }
+}
+/**
+ * Custom implementation of a MapLibre Marker with additional functionality.
+ * Extends the base MapLibre Marker class with MapVX-specific features.
+ *
+ * @example
+ * ```typescript
+ * const marker = new MarkerAttribute({
+ *   id: "place-1",
+ *   coordinate: { lat: 40.7128, lng: -74.0060 },
+ *   icon: "https://example.com/icon.png"
+ * });
+ * marker.addToMap(map);
+ * ```
+ */
+export class MarkerAttribute extends Marker {
+    /**
+     * Constructs a new `MarkerAttribute` object with the specified properties.
+     *
+     * @param markerConfig - `MarkerConfig` object containing the configuration properties
+     *
+     * @example
+     * ```typescript
+     * const marker = new MarkerAttribute({
+     *   id: "coffee-shop",
+     *   coordinate: { lat: 40.7128, lng: -74.0060 },
+     *   floorId: "ground-floor",
+     *   icon: "coffee-icon.png"
+     * });
+     * ```
+     */
+    constructor(markerConfig) {
+        var _a, _b, _c, _d;
+        super({
+            element: MarkerUtils.createMarkerElement(markerConfig),
+            draggable: false,
+            anchor: (_a = markerConfig.anchor) !== null && _a !== void 0 ? _a : "center",
+            offset: [0, 0],
+        });
+        this.setLngLat([markerConfig.coordinate.lng, markerConfig.coordinate.lat]);
+        this.setRotationAlignment((_b = markerConfig.rotationAlignment) !== null && _b !== void 0 ? _b : "viewport");
+        this.setPitchAlignment("viewport");
+        this.id = (_c = markerConfig.id) !== null && _c !== void 0 ? _c : generateHexadecimalKey();
+        this.coordinate = markerConfig.coordinate;
+        this.floorId = (_d = markerConfig.floorId) !== null && _d !== void 0 ? _d : "";
+    }
+    /**
+     * Adds the marker attribute to the specified map.
+     *
+     * @param map - The map instance where the marker attribute will be added
+     *
+     * @example
+     * ```typescript
+     * const marker = new MarkerAttribute(markerConfig);
+     * marker.addToMap(mapInstance);
+     * ```
+     */
+    addToMap(map) {
+        if (!map)
+            return;
+        this.addTo(map);
+    }
+    /**
+     * Updates the icon of the marker attribute based on the specified marker configuration.
+     *
+     * @param marker - `MarkerConfig` object containing the new marker configuration
+     *
+     * @example
+     * ```typescript
+     * marker.updateIcon({
+     *   icon: "new-icon.png",
+     *   text: "Updated Text"
+     * });
+     * ```
+     */
+    updateIcon(marker) {
+        var _a, _b;
+        if (marker.element) {
+            this._element.innerHTML = "";
+            this._element.appendChild(marker.element);
+        }
+        else {
+            const markerElement = MarkerUtils.createMarkerElement(marker);
+            const oldMarkerContent = this._element.querySelector("div");
+            const newMarkerContent = markerElement.querySelector("div");
+            if (newMarkerContent) {
+                (_a = oldMarkerContent === null || oldMarkerContent === void 0 ? void 0 : oldMarkerContent.parentElement) === null || _a === void 0 ? void 0 : _a.replaceChild(newMarkerContent, oldMarkerContent);
+            }
+        }
+        this.setRotationAlignment((_b = marker.rotationAlignment) !== null && _b !== void 0 ? _b : "viewport");
+        this.setPitchAlignment("viewport");
+    }
+    /**
+     * Sets the current floor ID for the marker.
+     * Marker will be shown if and only if such floor is displayed.
+     *
+     * @param floorId - The ID of the floor to set for the marker.
+     *                  This parameter is optional and defaults to `undefined` if not provided.
+     *
+     * @example
+     * ```typescript
+     * marker.setFloor("ground-floor");
+     * ```
+     */
+    setFloor(floorId) {
+        this.floorId = floorId;
+    }
+    /**
+     * Hides the marker element from the map without deleting it.
+     * The marker can be shown again using the {@link show} method.
+     *
+     * @example
+     * ```typescript
+     * marker.hide();
+     * ```
+     */
+    hide() {
+        this.remove();
+    }
+    /**
+     * Makes the marker visible again after it has been hidden.
+     *
+     * @param map - The map instance where the marker should be shown
+     *
+     * @example
+     * ```typescript
+     * marker.show(mapInstance);
+     * ```
+     */
+    show(map) {
+        if (!map)
+            return;
+        this.addTo(map);
+    }
+    /**
+     * Hides marker if currentFloor is different from the marker floor.
+     * Used for floor-based marker visibility management.
+     *
+     * @param floorId - The current floor ID to compare against
+     * @param map - The map instance for showing/hiding the marker
+     *
+     * @example
+     * ```typescript
+     * marker.changeFloor("first-floor", mapInstance);
+     * ```
+     */
+    changeFloor(floorId, map, isOutdoor = false) {
+        if (floorId == this.floorId || (isOutdoor && !this.floorId)) {
+            this.show(map);
+        }
+        else {
+            this.hide();
+        }
+    }
+}
+//# sourceMappingURL=marker.js.map

package/dist/es/domain/models/marker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"marker.js","sourceRoot":"","sources":["../../../../src/domain/models/marker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAiC,MAAM,aAAa,CAAA;AACnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAG1D;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAN,IAAY,YASX;AATD,WAAY,YAAY;IACtB,8CAA8C;IAC9C,+CAAI,CAAA;IACJ,+CAA+C;IAC/C,iDAAK,CAAA;IACL,qCAAqC;IACrC,6CAAG,CAAA;IACH,qCAAqC;IACrC,mDAAM,CAAA;AACR,CAAC,EATW,YAAY,KAAZ,YAAY,QASvB;AAiLD;;;GAGG;AACH,MAAM,WAAW;IACf;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,mBAAmB,CAAC,MAAoB;;QAC7C,MAAM,eAAe,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;QAErD,uCAAuC;QACvC,MAAM,SAAS,GAAG,MAAA,MAAA,MAAM,CAAC,cAAc,0CAAE,KAAK,mCAAI,EAAE,CAAA;QACpD,MAAM,UAAU,GAAG,MAAA,MAAA,MAAM,CAAC,cAAc,0CAAE,MAAM,mCAAI,EAAE,CAAA;QAEtD,mBAAmB;QACnB,eAAe,CAAC,SAAS,GAAG,cAAc,CAAA;QAE1C,0DAA0D;QAC1D,IAAI,MAAM,CAAC,IAAI,EAAE;YACf,sDAAsD;YACtD,QAAQ,MAAM,CAAC,YAAY,EAAE;gBAC3B,KAAK,YAAY,CAAC,GAAG,CAAC;gBACtB,KAAK,YAAY,CAAC,MAAM;oBACtB,eAAe,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,CAAA;oBAC5C,eAAe,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,IAAI,CAAA;oBAC7D,eAAe,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,CAAA;oBACrC,MAAK;gBACP,KAAK,YAAY,CAAC,IAAI,CAAC;gBACvB,KAAK,YAAY,CAAC,KAAK,CAAC;gBACxB;oBACE,eAAe,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;oBACzC,eAAe,CAAC,KAAK,CAAC,KAAK,GAAG,MAAM,CAAA;oBACpC,eAAe,CAAC,KAAK,CAAC,MAAM,GAAG,GAAG,UAAU,IAAI,CAAA;oBAChD,MAAK;aACR;SACF;aAAM;YACL,4DAA4D;YAC5D,eAAe,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;YACxC,eAAe,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,SAAS,IAAI,CAAA;YAC9C,eAAe,CAAC,KAAK,CAAC,MAAM,GAAG,GAAG,UAAU,IAAI,CAAA;SACjD;QAED,eAAe,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE;;YAC7C,MAAA,MAAM,CAAC,OAAO,sDAAI,CAAA;QACpB,CAAC,CAAC,CAAA;QAEF,IAAI,MAAM,CAAC,OAAO,EAAE;YAClB,eAAe,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;YAC3C,OAAO,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,eAAe,EAAE,GAAG,UAAU,IAAI,EAAE,GAAG,SAAS,IAAI,CAAC,CAAA;SAC3F;QAED,6DAA6D;QAC7D,MAAM,WAAW,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,SAAS,EAAE,UAAU,CAAC,CAAA;QACzE,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI;YAC7B,CAAC,CAAC,IAAI,CAAC,mBAAmB,CACtB,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ;gBAC7B,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,cAAc,CAAC;gBAC5D,CAAC,CAAC,MAAM,CAAC,IAAI,EACf,MAAM,CAAC,YAAY,CACpB;YACH,CAAC,CAAC,IAAI,CAAA;QAER,gCAAgC;QAChC,IAAI,MAAM,CAAC,YAAY,KAAK,YAAY,CAAC,GAAG,IAAI,MAAM,CAAC,YAAY,KAAK,YAAY,CAAC,IAAI,EAAE;YACzF,IAAI,WAAW;gBAAE,eAAe,CAAC,WAAW,CAAC,WAAW,CAAC,CAAA;YACzD,eAAe,CAAC,WAAW,CAAC,WAAW,CAAC,CAAA;SACzC;aAAM;YACL,eAAe,CAAC,WAAW,CAAC,WAAW,CAAC,CAAA;YACxC,IAAI,WAAW;gBAAE,eAAe,CAAC,WAAW,CAAC,WAAW,CAAC,CAAA;SAC1D;QAED,OAAO,eAAe,CAAA;IACxB,CAAC;IAED;;;;;;;;OAQG;IACK,MAAM,CAAC,gBAAgB,CAC7B,YAA0B,EAC1B,SAAsB,EACtB,UAAkB,EAClB,SAAiB;QAEjB,IAAI,YAAY,CAAC,IAAI,EAAE;YACrB,MAAM,WAAW,GACf,OAAO,YAAY,CAAC,IAAI,KAAK,QAAQ;gBACnC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,YAAY,CAAC,IAAI,EAAE,YAAY,CAAC,cAAc,CAAC;gBACxE,CAAC,CAAC,YAAY,CAAC,IAAI,CAAA;YAEvB,MAAM,aAAa,GAAG,IAAI,CAAC,mBAAmB,CAAC,WAAW,EAAE,YAAY,CAAC,YAAY,CAAC,CAAA;YACtF,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC,CAAA;SACrC;QAED,OAAO,SAAS,CAAA;IAClB,CAAC;IAED;;;;;;;OAOG;IACK,MAAM,CAAC,iBAAiB,CAC9B,MAAoB,EACpB,SAAiB,EACjB,UAAkB;QAElB,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE;YACnC,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;SAC/B;aAAM,IAAI,MAAM,CAAC,IAAI,YAAY,gBAAgB,EAAE;YAClD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,SAAS,IAAI,CAAA;YAC1C,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,GAAG,UAAU,IAAI,CAAA;YAC5C,OAAO,MAAM,CAAC,IAAI,CAAA;SACnB;aAAM,IAAI,MAAM,CAAC,IAAI,EAAE;YACtB,OAAO,MAAM,CAAC,IAAI,CAAA;SACnB;aAAM;YACL,gDAAgD;YAChD,MAAM,WAAW,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;YACjD,WAAW,CAAC,SAAS,GAAG,cAAc,CAAA;YACtC,WAAW,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,SAAS,IAAI,CAAA;YAC1C,WAAW,CAAC,KAAK,CAAC,MAAM,GAAG,GAAG,UAAU,IAAI,CAAA;YAC5C,OAAO,WAAW,CAAA;SACnB;IACH,CAAC;IAED;;;;;;;OAOG;IACK,MAAM,CAAC,mBAAmB,CAChC,WAAwB,EACxB,YAA2B;QAE3B,MAAM,aAAa,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;QAEnD,mBAAmB;QACnB,aAAa,CAAC,SAAS,GAAG,gBAAgB,CAAA;QAE1C,uBAAuB;QACvB,QAAQ,YAAY,EAAE;YACpB,KAAK,YAAY,CAAC,GAAG;gBACnB,aAAa,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;gBAClC,MAAK;YACP,KAAK,YAAY,CAAC,MAAM;gBACtB,aAAa,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;gBACrC,MAAK;YACP,KAAK,YAAY,CAAC,IAAI;gBACpB,aAAa,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;gBACnC,MAAK;YACP,SAAS,QAAQ;gBACf,aAAa,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;gBACpC,MAAK;SACR;QAED,WAAW,CAAC,KAAK,CAAC,OAAO,GAAG,OAAO,CAAA;QACnC,WAAW,CAAC,KAAK,CAAC,MAAM,GAAG,GAAG,CAAA;QAC9B,aAAa,CAAC,WAAW,CAAC,WAAW,CAAC,CAAA;QAEtC,OAAO,aAAa,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,UAAU,CAAC,MAAoB;;QACpC,MAAM,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;QAE3C,KAAK,CAAC,GAAG,GAAG,OAAO,MAAM,CAAC,IAAI,IAAI,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAA;QAC7D,KAAK,CAAC,KAAK,GAAG,MAAA,MAAA,MAAM,CAAC,cAAc,0CAAE,KAAK,mCAAI,EAAE,CAAA;QAChD,KAAK,CAAC,MAAM,GAAG,MAAA,MAAA,MAAM,CAAC,cAAc,0CAAE,MAAM,mCAAI,EAAE,CAAA;QAClD,KAAK,CAAC,KAAK,CAAC,SAAS,GAAG,SAAS,CAAA;QACjC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,8CAA8C,CAAA;QAEnE,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACK,MAAM,CAAC,iBAAiB,CAC9B,IAAY,EACZ,UAAsC;;QAEtC,MAAM,WAAW,GAAG,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,CAAA;QAE/C,WAAW,CAAC,WAAW,GAAG,IAAI,CAAA;QAE9B,WAAW,CAAC,KAAK,CAAC,QAAQ,GAAG,MAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,QAAQ,mCAAI,MAAM,CAAA;QAC3D,WAAW,CAAC,KAAK,CAAC,OAAO,GAAG,MAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,OAAO,mCAAI,KAAK,CAAA;QACxD,WAAW,CAAC,KAAK,CAAC,MAAM,GAAG,MAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,MAAM,mCAAI,KAAK,CAAA;QACtD,WAAW,CAAC,KAAK,CAAC,UAAU,GAAG,MAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,UAAU,mCAAI,KAAK,CAAA;QAC9D,WAAW,CAAC,KAAK,CAAC,UAAU,GAAG,MAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,UAAU,mCAAI,yBAAyB,CAAA;QAElF,WAAW,CAAC,KAAK,CAAC,KAAK,GAAG,MAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAK,mCAAI,SAAS,CAAA;QACxD,WAAW,CAAC,KAAK,CAAC,UAAU;YAC1B,MAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,UAAU,mCACtB,sEAAsE,CAAA;QACxE,OAAO,WAAW,CAAA;IACpB,CAAC;CACF;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,eAAgB,SAAQ,MAAM;IAmBzC;;;;;;;;;;;;;;OAcG;IACH,YAAY,YAA0B;;QACpC,KAAK,CAAC;YACJ,OAAO,EAAE,WAAW,CAAC,mBAAmB,CAAC,YAAY,CAAC;YACtD,SAAS,EAAE,KAAK;YAChB,MAAM,EAAE,MAAA,YAAY,CAAC,MAAM,mCAAI,QAAQ;YACvC,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;SACf,CAAC,CAAA;QAEF,IAAI,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,GAAG,EAAE,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAA;QAC1E,IAAI,CAAC,oBAAoB,CAAC,MAAA,YAAY,CAAC,iBAAiB,mCAAI,UAAU,CAAC,CAAA;QACvE,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAA;QAClC,IAAI,CAAC,EAAE,GAAG,MAAA,YAAY,CAAC,EAAE,mCAAI,sBAAsB,EAAE,CAAA;QACrD,IAAI,CAAC,UAAU,GAAG,YAAY,CAAC,UAAU,CAAA;QACzC,IAAI,CAAC,OAAO,GAAG,MAAA,YAAY,CAAC,OAAO,mCAAI,EAAE,CAAA;IAC3C,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,GAAQ;QACf,IAAI,CAAC,GAAG;YAAE,OAAM;QAChB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACjB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,MAAoB;;QAC7B,IAAI,MAAM,CAAC,OAAO,EAAE;YAClB,IAAI,CAAC,QAAQ,CAAC,SAAS,GAAG,EAAE,CAAA;YAC5B,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;SAC1C;aAAM;YACL,MAAM,aAAa,GAAG,WAAW,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAA;YAC7D,MAAM,gBAAgB,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;YAC3D,MAAM,gBAAgB,GAAG,aAAa,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;YAC3D,IAAI,gBAAgB,EAAE;gBACpB,MAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,aAAa,0CAAE,YAAY,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAA;aAClF;SACF;QACD,IAAI,CAAC,oBAAoB,CAAC,MAAA,MAAM,CAAC,iBAAiB,mCAAI,UAAU,CAAC,CAAA;QACjE,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAA;IACpC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,OAAgB;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI;QACF,IAAI,CAAC,MAAM,EAAE,CAAA;IACf,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,GAAQ;QACX,IAAI,CAAC,GAAG;YAAE,OAAM;QAChB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACjB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,OAAkC,EAAE,GAAQ,EAAE,YAAqB,KAAK;QAClF,IAAI,OAAO,IAAI,IAAI,CAAC,OAAO,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YAC3D,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;SACf;aAAM;YACL,IAAI,CAAC,IAAI,EAAE,CAAA;SACZ;IACH,CAAC;CACF"}

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

@@ -0,0 +1,27 @@
+/**
+ * Multilanguage object model for different languages
+ * Represents text content that can be displayed in multiple languages
+ * @group Places & Locations
+ */
+export interface MultiLanguage {
+    /**
+     * Default language text that will be used if the requested language is not available
+     */
+    default: string;
+    /**
+     * Language-specific text content indexed by language code
+     * Example: { "en": "Hello", "es": "Hola", "default": "Hello" }
+     */
+    [language: string]: string;
+}
+/**
+ * Returns the string corresponding to the given language prefix.
+ * If the requested language is not available, falls back to the default language.
+ *
+ * @param multiLangString Multilanguage string to localize
+ * @param lang Local language prefix for translations (e.g., "en", "es", "fr")
+ * @returns Localized string in the requested language or default if not available
+ * @group Places & Locations
+ */
+export declare function getString(multiLangString: MultiLanguage, lang: string): string;
+//# sourceMappingURL=multilanguage.d.ts.map

package/dist/es/domain/models/multilanguage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"multilanguage.d.ts","sourceRoot":"","sources":["../../../../src/domain/models/multilanguage.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;;OAGG;IACH,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;CAC3B;AAED;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CAAC,eAAe,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAE9E"}

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

@@ -0,0 +1,14 @@
+/**
+ * Returns the string corresponding to the given language prefix.
+ * If the requested language is not available, falls back to the default language.
+ *
+ * @param multiLangString Multilanguage string to localize
+ * @param lang Local language prefix for translations (e.g., "en", "es", "fr")
+ * @returns Localized string in the requested language or default if not available
+ * @group Places & Locations
+ */
+export function getString(multiLangString, lang) {
+    var _a, _b;
+    return (_b = (_a = multiLangString[lang]) !== null && _a !== void 0 ? _a : multiLangString.default) !== null && _b !== void 0 ? _b : "";
+}
+//# sourceMappingURL=multilanguage.js.map

package/dist/es/domain/models/multilanguage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"multilanguage.js","sourceRoot":"","sources":["../../../../src/domain/models/multilanguage.ts"],"names":[],"mappings":"AAkBA;;;;;;;;GAQG;AACH,MAAM,UAAU,SAAS,CAAC,eAA8B,EAAE,IAAY;;IACpE,OAAO,MAAA,MAAA,eAAe,CAAC,IAAI,CAAC,mCAAI,eAAe,CAAC,OAAO,mCAAI,EAAE,CAAA;AAC/D,CAAC"}

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

@@ -0,0 +1,30 @@
+/**
+ * Two-characters string indicator for each day of the week
+ * Represents the standard format for identifying days in the week
+ * @group Places & Locations
+ */
+export type DaysOfTheWeek = "mo" | "tu" | "we" | "th" | "fr" | "sa" | "su";
+/**
+ * Object model for indicating a single period of opening time
+ * Represents a time range when a place is open
+ * @group Places & Locations
+ */
+export interface OpeningTime {
+    /**
+     * Opening time in 24-hour format (e.g., "09:00")
+     */
+    open: string;
+    /**
+     * Closing time in 24-hour format (e.g., "18:00")
+     */
+    close: string;
+}
+/**
+ * Object model for indicating multiple opening times periods for different days of the week
+ * Maps each day of the week to an array of opening time periods
+ * @group Places & Locations
+ */
+export type OpeningHours = {
+    [day in DaysOfTheWeek]: OpeningTime[];
+};
+//# sourceMappingURL=openingHours.d.ts.map

package/dist/es/domain/models/openingHours.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openingHours.d.ts","sourceRoot":"","sources":["../../../../src/domain/models/openingHours.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAA;AAE1E;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG;KACxB,GAAG,IAAI,aAAa,GAAG,WAAW,EAAE;CACtC,CAAA"}

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

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

package/dist/es/domain/models/openingHours.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openingHours.js","sourceRoot":"","sources":["../../../../src/domain/models/openingHours.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,167 @@
+import { type Metadata } from "../../interfaces/metadata";
+import { type PlaceResponse } from "../../interfaces/placeResponse";
+import { Banner } from "./banner";
+import { type InnerFloor } from "./innerFloors";
+import { type LatLng } from "./latLng";
+import { type OpeningHours } from "./openingHours";
+import { type Property, type TransportLine } from "./property";
+/**
+ * MapVX place object, is a custom object containing data of a specific real place.
+ * Represents a physical location with all its associated metadata and properties.
+ *
+ * @example
+ * ```typescript
+ * const place = new MVXPlace(placeResponse);
+ * console.log(place.title); // "Coffee Shop"
+ * console.log(place.position); // { lat: 40.7128, lng: -74.0060 }
+ * ```
+ *
+ * @group Places & Locations
+ */
+export declare class MVXPlace {
+    /**
+     * Unique identifier to reference the place in MapVX system
+     */
+    mapvxId: string;
+    /**
+     * Client-side identifier for the place (optional)
+     * Used for custom identification in client applications
+     */
+    clientId?: string;
+    /**
+     * Title text for the place (localized based on client language)
+     */
+    title: string;
+    /**
+     * Detailed description text for the place (localized based on client language)
+     */
+    description?: string;
+    /**
+     * Short description text for the place (localized based on client language)
+     */
+    shortDescription?: string;
+    /**
+     * Central position coordinates for the place
+     * @see {@link LatLng} for coordinate structure
+     */
+    position: LatLng;
+    /**
+     * Flag to control visibility of the place in search results
+     */
+    hidePlace: boolean;
+    /**
+     * Category identifier for the place
+     */
+    category: string;
+    /**
+     * Localized category name for the place (based on client language)
+     */
+    localizedCategory?: string;
+    /**
+     * General purpose category string for the place (localized)
+     */
+    generalCategory: string;
+    /**
+     * Floors available in the parent place. If this exists, the place is indoor.
+     * Otherwise, the place is considered outdoor.
+     * @see {@link InnerFloor} for floor structure
+     */
+    innerFloors: InnerFloor[];
+    /**
+     * Specific floor identifiers where this place exists (for indoor locations)
+     */
+    inFloors?: string[];
+    /**
+     * Unique identifier of the institution to which this place belongs
+     */
+    parentInstitutionId: string;
+    /**
+     * Business hours when the place is open
+     * @see {@link OpeningHours} for schedule structure
+     */
+    openingHours?: OpeningHours;
+    /**
+     * Physical address of the place in plain text (if provided)
+     */
+    address?: string;
+    /**
+     * Transport services associated with this place
+     * @see {@link TransportLine} for transport service structure
+     */
+    transportLine?: TransportLine[];
+    /**
+     * URL of the place's logo image
+     */
+    logo?: string;
+    /**
+     * List of available image URLs for the place
+     */
+    images: string[];
+    /**
+     * List of available banner images for the place
+     * @see {@link Banner} for banner structure
+     */
+    banners: Banner[];
+    /**
+     * List of properties connected to the place
+     * @see {@link Property} for property structure
+     */
+    properties?: Property[];
+    /**
+     * Unique identifier of the parent place or object
+     */
+    parentId: string;
+    /**
+     * Type of the object being referenced by {@link parentId}
+     */
+    parentType: string;
+    /**
+     * Tags associated with the place for categorization and filtering
+     */
+    tags: string[];
+    /**
+     * Metadata of the place.
+     */
+    metadata?: Metadata;
+    /**
+     * Visibility of the place
+     */
+    visibility: "public" | "protected" | "hidden";
+    /**
+     * Creates a new place instance with the parameters specified in the data.
+     *
+     * @param rawPlace - JSON configuration parameters for the place from API response
+     * @returns A new instance of MVXPlace
+     *
+     * @example
+     * ```typescript
+     * const placeResponse = await fetchPlaceData(placeId);
+     * const place = new MVXPlace(placeResponse);
+     * ```
+     */
+    constructor(rawPlace: PlaceResponse);
+    /**
+     * Returns the floor in which the place exists as an InnerFloor object.
+     * If no matching available floor is found or if the place is not indoor,
+     * an undefined value will be returned.
+     *
+     * @param parentPlaceFloors - Array of existing parent place floors to search in
+     * @returns The matching InnerFloor object or undefined if not found
+     *
+     * @example
+     * ```typescript
+     * const buildingFloors = getBuildingFloors();
+     * const placeFloor = place.inFloor(buildingFloors);
+     * if (placeFloor) {
+     *   console.log(`Place is on floor: ${placeFloor.name}`);
+     * }
+     * ```
+     */
+    inFloor(parentPlaceFloors: InnerFloor[]): InnerFloor | undefined;
+    /**
+     * Returns a string representation of the place
+     * @returns String in format "MVXPlace {mapvxId}"
+     */
+    toString(): string;
+}
+//# sourceMappingURL=place.d.ts.map

package/dist/es/domain/models/place.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"place.d.ts","sourceRoot":"","sources":["../../../../src/domain/models/place.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,2BAA2B,CAAA;AACzD,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,gCAAgC,CAAA;AACnE,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACjC,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,eAAe,CAAA;AAC/C,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAA;AACtC,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAClD,OAAO,EAAiB,KAAK,QAAQ,EAAE,KAAK,aAAa,EAAE,MAAM,YAAY,CAAA;AAE7E;;;;;;;;;;;;GAYG;AACH,qBAAa,QAAQ;IACnB;;OAEG;IACI,OAAO,EAAE,MAAM,CAAA;IAEtB;;;OAGG;IACI,QAAQ,CAAC,EAAE,MAAM,CAAA;IAExB;;OAEG;IACI,KAAK,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACI,WAAW,CAAC,EAAE,MAAM,CAAA;IAE3B;;OAEG;IACI,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEhC;;;OAGG;IACI,QAAQ,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACI,SAAS,EAAE,OAAO,CAAA;IAEzB;;OAEG;IACI,QAAQ,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACI,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAEjC;;OAEG;IACI,eAAe,EAAE,MAAM,CAAA;IAE9B;;;;OAIG;IACI,WAAW,EAAE,UAAU,EAAE,CAAA;IAEhC;;OAEG;IACI,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IAE1B;;OAEG;IACI,mBAAmB,EAAE,MAAM,CAAA;IAElC;;;OAGG;IACI,YAAY,CAAC,EAAE,YAAY,CAAA;IAElC;;OAEG;IACI,OAAO,CAAC,EAAE,MAAM,CAAA;IAEvB;;;OAGG;IACI,aAAa,CAAC,EAAE,aAAa,EAAE,CAAA;IAEtC;;OAEG;IACI,IAAI,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACI,MAAM,EAAE,MAAM,EAAE,CAAA;IAEvB;;;OAGG;IACI,OAAO,EAAE,MAAM,EAAE,CAAA;IAExB;;;OAGG;IACI,UAAU,CAAC,EAAE,QAAQ,EAAE,CAAA;IAE9B;;OAEG;IACI,QAAQ,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACI,UAAU,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACI,IAAI,EAAE,MAAM,EAAE,CAAA;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAA;IAEnB;;OAEG;IACI,UAAU,EAAE,QAAQ,GAAG,WAAW,GAAG,QAAQ,CAAA;IAEpD;;;;;;;;;;;OAWG;gBACS,QAAQ,EAAE,aAAa;IA0CnC;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,iBAAiB,EAAE,UAAU,EAAE,GAAG,UAAU,GAAG,SAAS;IAQhE;;;OAGG;IACH,QAAQ,IAAI,MAAM;CAGnB"}