becomap 1.6.1 → 1.6.8

package/lib/index.d.ts

@@ -397,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"}).
@@ -628,6 +634,21 @@ 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;
+	/**
+	 * Shows a specific route segment by its orderIndex.
+	 * @param orderIndex - The order index of the segment to display.
+	 */
+	showSegmentByOrderIndex(orderIndex: number): void;
+	/**
+	 * Gets the currently stored route segments.
+	 * @returns Array of BCRouteSegment objects or null if no segments are stored.
+	 */
+	get segments(): BCRouteSegment[] | null;
 	/**
 	 * 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.
@@ -649,6 +670,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.
  */
@@ -799,52 +830,6 @@ 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.
- */
-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[];
-}
 /**
  * Constructs a new MapView instance.
  *
@@ -887,6 +872,31 @@ 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
+	];
 }
 /**
  * Interface representing the public API of the BCMapView class.
@@ -940,6 +950,7 @@ export interface BCMapView {
 	 * @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.
@@ -960,6 +971,24 @@ export interface BCMapView {
 	 * @returns An array of amenity locations.
 	 */
 	getAllAminityLocations(): BCLocation[];
+	/**
+	 * Sets the current custom location for the map view.eg: Kiosk Location
+	 * @param customLocationId - The ID of the custom location to set as current.
+	 */
+	setCurrentCustomLocation(customLocationId: string): void;
+	/**
+	 * Gets the current custom location ID.
+	 * @returns The current custom location ID, or null if not set.
+	 */
+	getCurrentCustomLocationId(): string | null;
+	/**
+	 * Retrieves amenity locations of a specific type, sorted by floor priority and distance from kiosk location.
+	 * @param amenityType - The type of amenity to retrieve.
+	 * @param customLocationId - Optional. The ID of the kiosk location to calculate distances from. If not provided, uses the current kiosk location.
+	 * @param floorId - The preferred floor ID to prioritize in results.
+	 * @returns An array of sorted amenity locations.
+	 */
+	getAminityLocations(amenityType: BCSiteAmenity, customLocationId?: string, floorId?: string): BCLocation[];
 	/**
 	 * Searches for locations matching the provided search string.
 	 * @param searchString - The string to search for.
@@ -977,29 +1006,18 @@ export interface BCMapView {
 	 * @param location - The location to select.
 	 */
 	selectLocation(location: BCLocation): void;
+	selectLocationWithId(locationId: string): void;
+	/**
+	 * Selects multiple locations on the map.
+	 * @param locations - The array of locations to select.
+	 */
+	selectLocations(locations: BCLocation[]): void;
 	/**
 	 * 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 for the current map view.
-	 * @returns A promise that resolves to the session ID.
-	 */
-	getSessionId(): Promise<string>;
-	/**
-	 * 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 questions.
-	 */
-	getQuestions(): BCQuestion[];
 	/**
 	 * Retrieves all available amenities.
 	 * @returns An array of amenities.
@@ -1019,18 +1037,6 @@ export interface BCMapView {
 	 * Clears all current selections on the map.
 	 */
 	clearSelection(): void;
-	/**
-	 * Sets the map bounds to the specified southwest and northeast coordinates.
-	 * @param sw - The southwest coordinates.
-	 * @param ne - The northeast coordinates.
-	 */
-	setBounds(sw: [
-		number,
-		number
-	], ne: [
-		number,
-		number
-	]): void;
 	/**
 	 * Resets the default viewport with the provided options.
 	 * @param newOptions - Partial options to update the viewport.
@@ -1041,6 +1047,18 @@ export interface BCMapView {
 	 * @param newOptions - Partial options to update the viewport.
 	 */
 	setViewport(newOptions: Partial<BCMapViewOptions>): void;
+	/**
+	 * Submits user feedback to the server.
+	 * @param feedbackData - The feedback data containing name, message, siteId, phoneNumber, and rating.
+	 * @returns Promise that resolves with the server response.
+	 */
+	submitFeedback(feedbackData: {
+		name: string;
+		message: string;
+		siteId: string;
+		phoneNumber: string;
+		rating: number;
+	}): Promise<any>;
 }
 /**
  * Options for retrieving a specific site.

package/package.json

@@ -1,70 +1,72 @@
-{
-  "name": "becomap",
-  "version": "1.6.1",
-  "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.6.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",
+    "becomap": "^1.5.72",
+    "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"
+  }
+}