becomap 1.5.64 → 1.6.0

package/lib/index.d.ts

@@ -1,5 +1,9 @@
 // Generated by dts-bundle-generator v9.5.1
 
+export interface BCMapLanguage {
+	name: string;
+	code: string;
+}
 /**
  * Represents a coordinate:
  * - A tuple containing latitude and longitude as [latitude, longitude]
@@ -195,6 +199,12 @@ export interface BCMapSite {
 	 * @returns The map as BCMapFloor.
 	 */
 	getDefaultMap(): BCMapFloor;
+	/**
+	 * list of language options available for the site.
+	 *
+	 * @returns The site languages as BCMapLanguage[].
+	 */
+	get otherLanguages(): BCMapLanguage[];
 }
 export interface BCColor {
 	rgba: string;
@@ -230,7 +240,10 @@ declare enum BCLocationType {
 	SHUTTLE = "SHUTTLE",
 	/** Represents a kiosk, such as an information booth or ticket counter. */
 	KIOSK = "KIOSK",
-	MAP_OBJECT = "MAP_OBJECT"
+	/** Represents a 3D Object in map. */
+	MAP_OBJECT = "MAP_OBJECT",
+	/** Represents a Floor connection, like Lift, Escalator, Ramp etc. */
+	CONNECTION = "CONNECTION"
 }
 /**
  * Enum representing various amenities available at a site.
@@ -832,6 +845,15 @@ export interface BCAnswer {
 	 */
 	answers: string[];
 }
+/**
+ * Constructs a new MapView instance.
+ *
+ * @param container - The HTML element that will contain the map.
+ * @param site - The BCMapSite object that provides context and data for the map.
+ * @param options - Optional configuration settings for the initial map view.
+ * @param language - Optional configuration for settings the language.
+ */
+export declare function getMapView(container: HTMLElement, site: BCMapSite, options?: BCMapViewOptions, language?: BCMapLanguage): Promise<BCMapView>;
 /**
  * Options for configuring the initial view of the map.
  *
@@ -867,176 +889,140 @@ export interface BCMapViewOptions {
 	bearing?: number;
 }
 /**
- * Class representing a map view, providing methods to manipulate and interact
- * with the map interface.
+ * Interface representing the public API of the BCMapView class.
+ * This interface defines all the public methods and properties
+ * available for interacting with the map view.
  */
-export declare class BCMapView {
-	#private;
-	readonly mapSite: BCMapSite;
-	readonly eventsHandler: BCEventEmitter<BCMapViewEvents>;
-	get currentFloor(): BCMapFloor;
+export interface BCMapView {
 	/**
-	 * Constructs a new MapView instance.
-	 *
-	 * @param container - The HTML element that will contain the map.
-	 * @param site - The BCMapSite object that provides context and data for the map.
-	 * @param options - Optional configuration settings for the initial map view.
+	 * The site associated with the map view.
 	 */
-	constructor(container: HTMLElement, site: BCMapSite, options?: BCMapViewOptions);
+	readonly mapSite: BCMapSite;
 	/**
-	 * Gets the HTML element that contains the map.
-	 *
-	 * @returns The HTMLElement representing the map container.
+	 * The currently selected floor in the map view.
 	 */
-	get container(): HTMLElement;
+	readonly currentFloor: BCMapFloor;
 	/**
-	 * Provides access to the route controller, which manages routing operations
-	 * within the map view, such as route rendering.
-	 * @returns An instance of BCRouteController for managing route operations.
+	 * Event handler for managing map-related events.
 	 */
+	readonly eventsHandler: BCEventEmitter<BCMapViewEvents>;
+	/**
+	* Provides access to the route controller, which manages routing operations
+	* within the map view, such as route rendering.
+	* @returns An instance of BCRouteController for managing route operations.
+	*/
 	get routeController(): BCRouteController;
 	/**
-	 * Focuses the map on a specified location, optionally adjusting
-	 * the zoom level, bearing, and pitch.
-	 *
-	 * @param location - The location as BCLocation to focus on.
-	 * @param zoomLevel - Optional zoom level to apply when focusing on
-	 *                    the point. Defaults to the current zoom level if not specified.
-	 * @param bearing - Optional bearing to apply when focusing on the
-	 *                  point. Defaults to the current bearing if not specified.
-	 * @param pitch - Optional pitch to apply when focusing on the point.
-	 *                Defaults to the current pitch if not specified.
+	 * Focuses the map on a specific location.
+	 * @param location - The location to focus on.
+	 * @param zoomLevel - Optional zoom level for the map.
+	 * @param bearing - Optional bearing (rotation) for the map.
+	 * @param pitch - Optional pitch (tilt) for the map.
 	 */
 	focusTo(location: BCLocation, zoomLevel?: number, bearing?: number | null, pitch?: number | null): void;
 	/**
-	 * Updates the zoom level of the map view.
-	 * If the provided zoom level is invalid (not a number or out of range), retains the current zoom level.
-	 *
-	 * @param {number} zoomLevel - The desired zoom level. Must be within the map's minZoom and maxZoom range.
+	 * Updates the zoom level of the map.
+	 * @param zoomLevel - The desired zoom level.
 	 */
 	updateZoom(zoomLevel: number): void;
 	/**
-	 * Updates the pitch (tilt angle) of the map view.
-	 * If the provided pitch is invalid (not a number or out of range), retains the current pitch.
-	 *
-	 * @param {number} pitch - The desired pitch angle in degrees. Must be between 0 and 60.
-	 *                         Values outside this range will be clamped.
+	 * Updates the pitch (tilt angle) of the map.
+	 * @param pitch - The desired pitch angle in degrees.
 	 */
 	updatePitch(pitch: number): void;
 	/**
-	 * Updates the bearing (rotation angle) of the map view.
-	 * If the provided bearing is invalid (not a number), retains the current bearing.
-	 *
-	 * @param {number} bearing - The desired bearing angle in degrees.
-	 *                           The value is normalized to a range of 0 to 360 degrees.
+	 * Updates the bearing (rotation angle) of the map.
+	 * @param bearing - The desired bearing angle in degrees.
 	 */
 	updateBearing(bearing: number): void;
 	/**
 	 * Selects and displays the specified floor on the map.
-	 *
-	 * @param floor - The BCMapFloor object representing the floor to be selected.
-	 *
-	 * Preconditions:
-	 * - The `floor` parameter must be a valid BCMapFloor instance.
-	 *
-	 * Example:
-	 * selectFloor(groundFloorMap);
+	 * @param floor - The floor to be selected.
 	 */
 	selectFloor(floor: BCMapFloor): void;
+	/**
+	 * Retrieves the currently selected floor.
+	 * @returns The currently selected floor.
+	 */
 	get floor(): BCMapFloor;
 	/**
 	 * Retrieves all available categories.
-	 * @returns An array of `BCCategory` objects representing all stored categories.
+	 * @returns An array of categories.
 	 */
 	getCategories(): BCCategory[];
 	/**
 	 * Retrieves all available locations.
-	 * @returns An array of `BCLocation` objects representing all stored locations.
+	 * @returns An array of locations.
 	 */
 	getLocations(): BCLocation[];
+	/**
+	 * Retrieves all amenity locations.
+	 * @returns An array of amenity locations.
+	 */
 	getAllAminityLocations(): BCLocation[];
 	/**
-	 * Searches for locations that match the provided search string.
-	 *
-	 * @param searchString - The string input used to match against location names or tags.
-	 * @param callback - A function to execute once the matching process is complete,
-	 *                   receiving an array of matched `BCLocation` objects.
+	 * Searches for locations matching the provided search string.
+	 * @param searchString - The string to search for.
+	 * @param callback - A callback function to handle the search results.
 	 */
 	searchForLocations(searchString: string, callback: (matches: BCLocation[]) => void): void;
 	/**
-	 * Searches for categories that match the provided search string.
-	 *
-	 * @param searchString - The string input used to match against location names or tags.
-	 * @param callback - A function to execute once the matching process is complete,
-	 *                   receiving an array of matched `BCCategory` objects.
+	 * Searches for categories matching the provided search string.
+	 * @param searchString - The string to search for.
+	 * @param callback - A callback function to handle the search results.
 	 */
 	searchForCategories(searchString: string, callback: (matches: BCCategory[]) => void): void;
 	/**
-	 * Selects the specified location on the map.
-	 *
-	 * @param location - The BCLocation object representing the POI to be selected.
-	 *
-	 * Preconditions:
-	 * - The `floor` parameter must be a valid BCLocation instance.
-	 *
-	 * Example:
-	 * selectLocation(location);
+	 * Selects a specific location on the map.
+	 * @param location - The location to select.
 	 */
 	selectLocation(location: BCLocation): void;
 	/**
-	 * Retrieves all available happenings.
-	 * @returns An array of `BCHappenings` objects.
+	 * Retrieves all available happenings of a specific type.
+	 * @param type - The type of happenings to retrieve.
+	 * @returns An array of happenings.
 	 */
 	getHappenings(type: BCHappeningType): BCHappenings[];
 	/**
-	 * Retrieves the session ID.
-	 * @returns A promise that resolves to a string session ID.
+	 * Retrieves the session ID for the current map view.
+	 * @returns A promise that resolves to the session ID.
 	 */
 	getSessionId(): Promise<string>;
 	/**
-	 * Retrieves the suggestions based on user answers.
-	 * @returns A promise that returns a list of event IDs.
+	 * Retrieves event suggestions based on user answers.
+	 * @param sessionId - The session ID.
+	 * @param answers - The user's answers.
+	 * @returns A promise that resolves to a list of event IDs.
 	 */
 	getEventSuggestions(sessionId: string, answers: BCAnswer[]): Promise<string[]>;
 	/**
 	 * Retrieves all available questions.
-	 * @returns An array of `BCQuestion` objects.
+	 * @returns An array of questions.
 	 */
 	getQuestions(): BCQuestion[];
 	/**
 	 * Retrieves all available amenities.
-	 * @returns An array of `BCSiteAmenity` objects representing all map amenities.
+	 * @returns An array of amenities.
 	 */
 	getAmenities(): BCSiteAmenity[];
 	/**
-	 * Selects the specified amenities on the map.
-	 *
-	 * @param amenityType - The BCSiteAmenity representing type of POI to be selected.
-	 *
-	 * Example:
-	 * selectAmenities(BCSiteAmenity.RESTROOM);
+	 * Selects a specific amenity type on the map.
+	 * @param amenityType - The type of amenity to select.
 	 */
 	selectAmenities(amenityType: BCSiteAmenity): void;
 	/**
 	 * Enables or disables multi-selection mode for locations.
-	 *
-	 * When multi-selection is enabled, multiple locations can be selected at the same time.
-	 * When disabled, only the most recently selected location is kept in the selection.
-	 *
-	 * @param {boolean} [enable=true] - Whether to enable or disable multi-selection.
-	 *                                  Defaults to `true` (enable).
+	 * @param enable - Whether to enable or disable multi-selection.
 	 */
 	enableMultiSelection(enable?: boolean): void;
 	/**
-	 * Clears any current selections in the map or application.
-	 * This method resets the selection state, removing highlights
-	 * or selected features and ensuring a clean slate for new selections.
+	 * Clears all current selections on the map.
 	 */
 	clearSelection(): void;
 	/**
-	 * @hidden
-	 * @internal
-	 * Retrieves the step node.
+	 * Sets the map bounds to the specified southwest and northeast coordinates.
+	 * @param sw - The southwest coordinates.
+	 * @param ne - The northeast coordinates.
 	 */
 	setBounds(sw: [
 		number,
@@ -1046,13 +1032,13 @@ export declare class BCMapView {
 		number
 	]): void;
 	/**
-	 * Reset Default Viewport with the provided options.
-	 * @param newOptions Partial BCMapViewOptions to update the viewport.
+	 * Resets the default viewport with the provided options.
+	 * @param newOptions - Partial options to update the viewport.
 	 */
 	resetDefaultViewport(newOptions?: Partial<BCMapViewOptions>): void;
 	/**
-	 * Sets the viewport with the provided options without changing the defaulf values.
-	 * @param newOptions Partial BCMapViewOptions to update the viewport.
+	 * Sets the viewport with the provided options without changing the default values.
+	 * @param newOptions - Partial options to update the viewport.
 	 */
 	setViewport(newOptions: Partial<BCMapViewOptions>): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "becomap",
-  "version": "1.5.64",
+  "version": "1.6.0",
   "description": "we lib to display becomap",
   "main": "lib/becomap.js",
   "module": "lib/becomap.js",