becomap 1.5.6 → 1.5.8

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]
@@ -59,6 +63,11 @@ export interface BCMapFloor {
 	 * @returns {string} - The name of the map.
 	 */
 	get name(): string;
+	/**
+	 * defauilt view port for the floor.
+	 * @returns {BCMapViewOptions} - The viewPort of the map.
+	 */
+	get viewPort(): BCMapViewOptions;
 	/**
 	 * Elevation value.
 	 * @returns {number} - The elevation of floor on the map.
@@ -190,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;
@@ -225,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.
@@ -379,6 +397,12 @@ export interface BCLocation {
 	 */
 	get amenity(): BCSiteAmenity;
 	/**
+   * The area of the location.
+   *
+   * @returns  The area of the location as a string.
+   */
+	get area(): string | null;
+	/**
 	 * Stores phone numbers associated with the location, where the key represents the type of phone number.
 	 *
 	 * @returns A record of phone numbers keyed by type (e.g., {"main": "123-456-7890"}).
@@ -610,6 +634,11 @@ export interface BCRouteController {
 	 * this.showStep(routeStep);
 	 */
 	showStep(step: BCRouteStep): void;
+	/**
+	 * Shows the route step by its orderIndex.
+	 * @param orderIndex - The order index of the step to display.
+	 */
+	showStepByOrderIndex(orderIndex: number): void;
 	/**
 	 * Clears the current route from the map by removing the route layer or data from the map view.
 	 * It relies on the routeController to manage route layers or data.
@@ -631,6 +660,16 @@ export interface BCRouteOptions {
  * @returns An array of BCRouteSegment objects representing each segment of the route, or `null` if a route cannot be generated.
  */
 export declare function getRoute(start: BCRoutable, goal: BCRoutable, waypoints?: BCRoutable[], routeOptions?: BCRouteOptions): BCRouteSegment[] | null;
+/**
+ * Retrieves the route using location IDs for start, goal, and waypoints.
+ *
+ * @param startId - The starting location's ID.
+ * @param goalId - The goal location's ID.
+ * @param waypointIds - Optional array of waypoint location IDs.
+ * @param routeOptions - Optional routing options.
+ * @returns An array of BCRouteSegment objects or null if not found.
+ */
+export declare function getRouteById(startId: string, goalId: string, waypointIds?: string[], routeOptions?: BCRouteOptions): BCRouteSegment[] | null;
 /**
  * Defines the events supported by the BCMapView and their corresponding arguments.
  */
@@ -781,52 +820,15 @@ export interface BCHappenings {
 	*/
 	customFields: Record<string, any>;
 }
-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.
+ * 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 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[];
-}
+export declare function getMapView(container: HTMLElement, site: BCMapSite, options?: BCMapViewOptions, language?: BCMapLanguage): Promise<BCMapView>;
 /**
  * Options for configuring the initial view of the map.
  *
@@ -860,194 +862,156 @@ export interface BCMapViewOptions {
 	 * Default bearing can be defined in the implementation.
 	 */
 	bearing?: number;
+	/**
+	 * Whether to hide layers outside the defined map boundaries.
+	 * If set to `true`, layers outside the map's visible area will
+	 * be hidden. This can improve performance and focus on the
+	 * relevant map content.
+	 */
+	hideOutsideLayers?: boolean;
+	/**
+	 * The background color of the map container.
+	 * This property allows setting a custom background color for
+	 * the map container, which is visible when no map tiles are
+	 * rendered or when the map is loading.
+	 */
+	background?: string;
+	/**
+	 * Optional bounds for the map view, as [minLng, minLat, maxLng, maxLat].
+	 * minLng: southwest longitude, minLat: southwest latitude,
+	 * maxLng: northeast longitude, maxLat: northeast latitude
+	 */
+	bounds?: [
+		number,
+		number,
+		number,
+		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;
+	selectFloorWithId(floorId: string): 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;
+	selectLocationWithId(locationId: string): 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.
-	 */
-	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.
+	 * @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.
-	 */
-	setBounds(sw: [
-		number,
-		number
-	], ne: [
-		number,
-		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,70 +1,71 @@
-{
-  "name": "becomap",
-  "version": "1.5.6",
-  "description": "we lib to display becomap",
-  "main": "lib/becomap.js",
-  "module": "lib/becomap.js",
-  "types": "lib/index.d.ts",
-  "scripts": {
-    "test": "jest --config jestconfig.json",
-    "start": "npm run build && npm run serve && npm run watch",
-    "serve": "node scripts/serve.js",
-    "build": "cross-env APP_ENV=production node scripts/build.js",
-    "watch": "webpack --watch",
-    "format": "prettier --write \"src/**/*.ts\"",
-    "lint": "tslint -p tsconfig.json",
-    "proto": "./scripts/generate-proto.sh",
-    "readproto": "cd ./proto/sample && tsc readbin.ts && node ./readbin.js && cd .. && cd .."
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "devDependencies": {
-    "@babel/core": "^7.24.7",
-    "@babel/preset-env": "^7.24.7",
-    "@babel/preset-typescript": "^7.24.7",
-    "@types/jest": "^29.5.12",
-    "@types/node": "^20.14.5",
-    "@types/rbush": "^4.0.0",
-    "@types/three": "^0.172.0",
-    "@types/webpack": "^5.28.5",
-    "babel-loader": "^9.1.3",
-    "cross-env": "^7.0.3",
-    "css-loader": "^7.1.2",
-    "dotenv": "^16.4.5",
-    "dotenv-webpack": "^8.1.0",
-    "dts-bundle-generator": "^9.5.1",
-    "fs-extra": "^11.2.0",
-    "install": "^0.13.0",
-    "javascript-obfuscator": "^4.1.1",
-    "jest": "^29.7.0",
-    "npm": "^10.8.1",
-    "prettier": "^3.3.2",
-    "rimraf": "^6.0.1",
-    "style-loader": "^4.0.0",
-    "terser-webpack-plugin": "^5.3.10",
-    "ts-jest": "^29.1.5",
-    "ts-loader": "^9.5.1",
-    "ts-proto": "^2.2.3",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0",
-    "typescript": "^5.5.3",
-    "webpack": "^5.92.1",
-    "webpack-cli": "^5.1.4",
-    "webpack-dev-server": "^5.0.4",
-    "webpack-obfuscator": "^3.5.1"
-  },
-  "dependencies": {
-    "@turf/turf": "^7.1.0",
-    "@types/polylabel": "^1.1.3",
-    "axios": "^1.7.5",
-    "maplibre-gl": "^4.4.1",
-    "polished": "^4.3.1",
-    "polylabel": "^2.0.1",
-    "protobufjs": "^7.4.0",
-    "rbush": "^4.0.1",
-    "three": "^0.172.0",
-    "troika-three-text": "^0.52.3",
-    "word-wrap": "^1.2.5"
-  }
+{
+  "name": "becomap",
+  "version": "1.5.8",
+  "description": "we lib to display becomap",
+  "main": "lib/becomap.js",
+  "module": "lib/becomap.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "test": "jest --config jestconfig.json",
+    "start": "npm run build && npm run serve && npm run watch",
+    "serve": "node scripts/serve.js",
+    "build": "cross-env APP_ENV=production node scripts/build.js",
+    "watch": "webpack --watch",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "lint": "tslint -p tsconfig.json",
+    "proto": "./scripts/generate-proto.sh",
+    "readproto": "cd ./proto/sample && tsc readbin.ts && node ./readbin.js && cd .. && cd .."
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@babel/core": "^7.24.7",
+    "@babel/preset-env": "^7.24.7",
+    "@babel/preset-typescript": "^7.24.7",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.14.5",
+    "@types/rbush": "^4.0.0",
+    "@types/three": "^0.172.0",
+    "@types/webpack": "^5.28.5",
+    "babel-loader": "^9.1.3",
+    "cross-env": "^7.0.3",
+    "css-loader": "^7.1.2",
+    "dotenv": "^16.4.5",
+    "dotenv-webpack": "^8.1.0",
+    "dts-bundle-generator": "^9.5.1",
+    "fs-extra": "^11.2.0",
+    "install": "^0.13.0",
+    "javascript-obfuscator": "^4.1.1",
+    "jest": "^29.7.0",
+    "npm": "^10.8.1",
+    "prettier": "^3.3.2",
+    "rimraf": "^6.0.1",
+    "style-loader": "^4.0.0",
+    "terser-webpack-plugin": "^5.3.10",
+    "ts-jest": "^29.1.5",
+    "ts-loader": "^9.5.1",
+    "ts-proto": "^2.2.3",
+    "tslint": "^6.1.3",
+    "tslint-config-prettier": "^1.18.0",
+    "typescript": "^5.5.3",
+    "webpack": "^5.92.1",
+    "webpack-cli": "^5.1.4",
+    "webpack-dev-server": "^5.0.4",
+    "webpack-obfuscator": "^3.5.1"
+  },
+  "dependencies": {
+    "@turf/turf": "^7.1.0",
+    "@types/polylabel": "^1.1.3",
+    "axios": "^1.7.5",
+    "html-webpack-plugin": "^5.6.3",
+    "maplibre-gl": "^4.4.1",
+    "polished": "^4.3.1",
+    "polylabel": "^2.0.1",
+    "protobufjs": "^7.4.0",
+    "rbush": "^4.0.1",
+    "three": "^0.172.0",
+    "troika-three-text": "^0.52.3",
+    "word-wrap": "^1.2.5"
+  }
 }