becomap 1.4.1 → 1.4.3

package/lib/index.d.ts

@@ -223,7 +223,8 @@ declare enum BCLocationType {
 	/** Represents a shuttle service or shuttle stop. */
 	SHUTTLE = "SHUTTLE",
 	/** Represents a kiosk, such as an information booth or ticket counter. */
-	KIOSK = "KIOSK"
+	KIOSK = "KIOSK",
+	MAP_OBJECT = "MAP_OBJECT"
 }
 /**
  * Enum representing various amenities available at a site.
@@ -764,6 +765,52 @@ export interface BCHappenings {
 	 */
 	priority: number;
 }
+declare enum BCQuestionType {
+	/** Represents a multiple-choice question with a single answer. */
+	MCQ_SINGLE_ANSWER = "MCQ_SINGLE_ANSWER",
+	/** Represents an open-ended text response. */
+	TEXT = "TEXT",
+	/** Represents a numerical response. */
+	NUMBER = "NUMBER",
+	/** Represents a boolean (true/false) response. */
+	BOOLEAN = "BOOLEAN"
+}
+/**
+ * Interface representing a single survey question.
+ */
+export interface BCQuestion {
+	/**
+	 * Unique identifier for the question.
+	 */
+	id: string;
+	/**
+	 * The text of the question.
+	 */
+	question: string;
+	/**
+	 * The type of the question, as defined in BCQuestionType.
+	 */
+	type: BCQuestionType;
+	/**
+	 * The list of possible options for multiple-choice questions.
+	 * Should be empty or undefined for non-MCQ question types.
+	 */
+	options?: string[];
+}
+/**
+ * Interface representing an answer to a survey question.
+ */
+export interface BCAnswer {
+	/**
+	 * Unique identifier for the question being answered.
+	 */
+	questionId: string;
+	/**
+	 * The answers provided by the user.
+	 * This can be a list to accommodate multiple responses for certain question types.
+	 */
+	answers: string[];
+}
 /**
  * Options for configuring the initial view of the map.
  *
@@ -772,10 +819,10 @@ export interface BCHappenings {
  */
 export interface BCMapViewOptions {
 	/**
-	* The geographical center point of the map, represented as a
-	* BCMapCoordinateLike object. If not specified, the map will
-	* default to its predefined center.
-	*/
+	 * The geographical center point of the map, represented as a
+	 * BCMapCoordinateLike object. If not specified, the map will
+	 * default to its predefined center.
+	 */
 	center?: BCMapCoordinateLike;
 	/**
 	 * The zoom level of the map, which determines the scale of the map
@@ -785,17 +832,17 @@ export interface BCMapViewOptions {
 	 */
 	zoom?: number;
 	/**
-	* The pitch of the map view, which controls the vertical tilt angle
-	* of the map. A pitch of 0 indicates a flat, bird's-eye view, while
-	* higher values provide an angled perspective. Default pitch can be
-	* set in the implementation.
-	*/
+	 * The pitch of the map view, which controls the vertical tilt angle
+	 * of the map. A pitch of 0 indicates a flat, bird's-eye view, while
+	 * higher values provide an angled perspective. Default pitch can be
+	 * set in the implementation.
+	 */
 	pitch?: number;
 	/**
-	* The bearing of the map view, which specifies the rotation angle
-	* of the map in degrees. A bearing of 0 means north is at the top.
-	* Default bearing can be defined in the implementation.
-	*/
+	 * The bearing of the map view, which specifies the rotation angle
+	 * of the map in degrees. A bearing of 0 means north is at the top.
+	 * Default bearing can be defined in the implementation.
+	 */
 	bearing?: number;
 }
 /**
@@ -807,9 +854,6 @@ export declare class BCMapView {
 	readonly mapSite: BCMapSite;
 	readonly eventsHandler: BCEventEmitter<BCMapViewEvents>;
 	get currentFloor(): BCMapFloor;
-	private _camera;
-	private _scene;
-	private _renderer;
 	/**
 	 * Constructs a new MapView instance.
 	 *
@@ -828,7 +872,7 @@ export declare class BCMapView {
 	 * 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
@@ -848,15 +892,15 @@ export declare class BCMapView {
 	 * 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.
-	*/
+	 */
 	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.
-	*/
+	 */
 	updatePitch(pitch: number): void;
 	/**
 	 * Updates the bearing (rotation angle) of the map view.
@@ -864,7 +908,7 @@ export declare class BCMapView {
 	 *
 	 * @param {number} bearing - The desired bearing angle in degrees.
 	 *                           The value is normalized to a range of 0 to 360 degrees.
-	*/
+	 */
 	updateBearing(bearing: number): void;
 	/**
 	 * Selects and displays the specified floor on the map.
@@ -876,7 +920,7 @@ export declare class BCMapView {
 	 *
 	 * Example:
 	 * selectFloor(groundFloorMap);
-   */
+	 */
 	selectFloor(floor: BCMapFloor): void;
 	get floor(): BCMapFloor;
 	/**
@@ -916,13 +960,28 @@ export declare class BCMapView {
 	 *
 	 * Example:
 	 * selectLocation(location);
-	*/
+	 */
 	selectLocation(location: BCLocation): void;
 	/**
 	 * Retrieves all available happenings.
 	 * @returns An array of `BCHappenings` objects.
 	 */
 	getHappenings(type: BCHappeningType): BCHappenings[];
+	/**
+	 * Retrieves the session ID.
+	 * @returns A promise that resolves to a string session ID.
+	 */
+	getSessionId(): Promise<string>;
+	/**
+	 * Retrieves the suggestions based on user answers.
+	 * @returns A promise that returns a list of event IDs.
+	 */
+	getEventSuggestions(sessionId: string, answers: BCAnswer[]): Promise<string[]>;
+	/**
+	 * Retrieves all available questions.
+	 * @returns An array of `BCQuestion` objects.
+	 */
+	getQuestions(): BCQuestion[];
 	/**
 	 * Retrieves all available amenities.
 	 * @returns An array of `BCSiteAmenity` objects representing all map amenities.
@@ -935,7 +994,7 @@ export declare class BCMapView {
 	 *
 	 * Example:
 	 * selectAmenities(BCSiteAmenity.RESTROOM);
-	*/
+	 */
 	selectAmenities(amenityType: BCSiteAmenity): void;
 	/**
 	 * Enables or disables multi-selection mode for locations.
@@ -945,13 +1004,13 @@ export declare class BCMapView {
 	 *
 	 * @param {boolean} [enable=true] - Whether to enable or disable multi-selection.
 	 *                                  Defaults to `true` (enable).
-	*/
+	 */
 	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.
-	*/
+	 */
 	clearSelection(): void;
 	/**
 	 * @hidden

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "becomap",
-  "version": "1.4.1",
+  "version": "1.4.3",
   "description": "we lib to display becomap",
   "main": "lib/becomap.js",
   "module": "lib/becomap.js",
@@ -66,4 +66,4 @@
     "three": "^0.172.0",
     "troika-three-text": "^0.52.3"
   }
-}
+}