becomap 1.0.1

package/lib/becomap.js.LICENSE.txt

@@ -0,0 +1,4 @@
+/**
+ * MapLibre GL JS
+ * @license 3-Clause BSD. Full text of license: https://github.com/maplibre/maplibre-gl-js/blob/v4.4.1/LICENSE.txt
+ */

package/lib/index.d.ts

@@ -0,0 +1,475 @@
+// Generated by dts-bundle-generator v9.5.1
+
+/**
+ * Represents a coordinate in various forms, including:
+ * - An instance of BCMapCoordinate
+ * - An object with latitude and longitude properties
+ * - A tuple containing latitude and longitude as [longitude, latitude]
+ */
+export type BCMapCoordinateLike = BCMapCoordinate | {
+	longitude: number;
+	latitude: number;
+} | {
+	longitude: number;
+	latitude: number;
+} | [
+	number,
+	number
+];
+export interface BCMapCoordinate {
+	/**
+	 * The latitude of the coordinate.
+	 *
+	 * @returns The latitude value as a number.
+	 */
+	get latitude(): number;
+	/**
+	 * The longitude of the coordinate.
+	 *
+	 * @returns The longitude value as a number.
+	 */
+	get longitude(): number;
+	/**
+	 * Converts the coordinate to an array format: [longitude, latitude].
+	 *
+	 * @returns A tuple with longitude as the first element and latitude as the second.
+	 */
+	toArray(): [
+		number,
+		number
+	];
+	/**
+	 * Checks if this coordinate is equal to another coordinate.
+	 *
+	 * @param coordinate - The BCMapCoordinate to compare.
+	 * @returns `true` if both coordinates have the same latitude and longitude, otherwise `false`.
+	 */
+	equals(coordinate: BCMapCoordinate): boolean;
+	/**
+	 * Calculates the distance from this coordinate to another coordinate.
+	 *
+	 * @param coordinate - The target BCMapCoordinate.
+	 * @returns The distance to the target coordinate in appropriate units (e.g., meters).
+	 */
+	distanceTo(coordinate: BCMapCoordinate): number;
+}
+export interface BCBuilding {
+	get buildingId(): string;
+	get buildingName(): string;
+}
+export interface BCMapSite {
+	/**
+	 * Unique identifier for the site.
+	 *
+	 * @returns The site id as a string.
+	 */
+	get id(): string;
+	/**
+	 * Name of the site.
+	 *
+	 * @returns The name of the site as a string.
+	 */
+	get siteName(): string;
+	/**
+	 * Address of the site.
+	 *
+	 * @returns The site's address as a string.
+	 */
+	get address(): string;
+	/**
+	 * City where the site is located.
+	 *
+	 * @returns The city name as a string.
+	 */
+	get city(): string;
+	/**
+	 * Country code for the site's location (e.g., "US" for the United States).
+	 *
+	 * @returns The country code as a string.
+	 */
+	get countryCode(): string;
+	/**
+	 * Postal or ZIP code for the site's location.
+	 *
+	 * @returns The postal code as a string.
+	 */
+	get postal(): string;
+	/**
+	 * State or province where the site is located.
+	 *
+	 * @returns The state name or abbreviation as a string.
+	 */
+	get state(): string;
+	/**
+	 * Telephone contact number for the site.
+	 *
+	 * @returns The telephone number as a string.
+	 */
+	get telephone(): string;
+	/**
+	 * Time zone identifier for the site's location.
+	 *
+	 * @returns The time zone ID as a string.
+	 */
+	get tzId(): string;
+	/**
+	 * UTC offset for the site's time zone.
+	 *
+	 * @returns The UTC offset as a string (e.g., "-05:00" for Eastern Standard Time).
+	 */
+	get utcOffset(): string;
+	/**
+	 * Link or URL related to the site (e.g., website or documentation link).
+	 *
+	 * @returns The URL as a string.
+	 */
+	get link(): string;
+	/**
+	 * Type or category of the site (e.g., "office", "warehouse").
+	 *
+	 * @returns The site type as a string.
+	 */
+	get type(): string;
+	/**
+	 * list of buildings of the site (e.g., "Tower 1", "Tower 2").
+	 *
+	 * @returns The site buildings as BCBuilding[].
+	 */
+	get buildings(): BCBuilding[];
+}
+declare class BCMarker {
+	private _id;
+	private _markerElement;
+	constructor(id: string, markerElement?: HTMLElement);
+	get markerElement(): HTMLElement;
+}
+export interface BCMapNode {
+	/**
+	 * Unique identifier for the map node.
+	 *
+	 * @returns The node's ID as a string.
+	 */
+	get id(): string;
+	/**
+	 * The geographic coordinate of the map node.
+	 *
+	 * @returns The node's location as a BCMapCoordinate.
+	 */
+	get coordinate(): BCMapCoordinate;
+	/**
+	 * Finds a route from this node to a target node.
+	 *
+	 * @param to - The destination BCMapNode.
+	 * @param checkAccessibility - A flag indicating whether accessibility (e.g., walkable or drivable paths) should be checked.
+	 * @returns An object containing the path as an array of BCMapNode objects and the total cost of the route,
+	 *          or `null` if no route is found.
+	 */
+	findRout(to: BCMapNode, checkAccessibility: boolean): {
+		path: BCMapNode[];
+		totalCost: number;
+	} | null;
+}
+/**
+ * Options for retrieving a specific site.
+ *
+ * @property clientId - The client ID used for authentication.
+ * @property clientSecret - The client secret used for authentication.
+ * @property siteIdentifier - The unique identifier of the site to retrieve (e.g., site ID or name).
+ */
+export type BCMGetSiteOptions = {
+	clientId: string;
+	clientSecret: string;
+	siteIdentifier: string;
+};
+/**
+ * Retrieves site information using the specified authentication and site details.
+ *
+ * @param siteOptions - An object containing the client ID, client secret, and site identifier for retrieving the site.
+ * @returns A promise that resolves to a BCMapSite object containing the site's details, or throws an error if authentication fails.
+ *
+ * @async
+ * @throws Will log and rethrow an error if there is an issue with authentication or retrieval.
+ */
+export declare function getSite(siteOptions: BCMGetSiteOptions): Promise<BCMapSite>;
+declare enum BC_STEP_ACTION {
+	NONE = "None",
+	DEPARTURE = "Departure",
+	ARRIVALDESTINATION = "ArrivalDestination",
+	ARRIVALWAYPOINT = "ArrivalWaypoint",
+	TURN = "Turn",
+	SWITCHFLOOR = "SwitchFloor"
+}
+declare enum BC_STEP_DIRECTION {
+	NONE = "None",
+	STRAIGHT = "Straight",
+	RIGHT = "Right",
+	SLIGHTRIGHT = "SlightRight",
+	UTURNRIGHT = "UTurnRight",
+	LEFT = "Left",
+	SLIGHTLEFT = "SlightLeft",
+	UTURNLEFT = "UTurnLeft",
+	UP = "Up",
+	DOWN = "Down"
+}
+declare enum BC_STEP_POSITION {
+	NONE = "None",
+	AT = "At",
+	BEFORE = "Before",
+	AFTER = "After"
+}
+/**
+ * Represents an individual step in a route, providing details on the action, direction, position, and distance.
+ */
+export interface BCRouteStep {
+	/**
+	 * The map node where this step occurs.
+	 *
+	 * @returns The BCMapNode for this step.
+	 */
+	get node(): BCMapNode;
+	/**
+	 * The action associated with this step (e.g., "Turn", "ArrivalDestination").
+	 *
+	 * @returns The BC_STEP_ACTION enum value representing the action.
+	 */
+	get action(): BC_STEP_ACTION;
+	/**
+	 * The direction to take for this step (e.g., "Right", "Straight").
+	 *
+	 * @returns The BC_STEP_DIRECTION enum value representing the direction.
+	 */
+	get direction(): BC_STEP_DIRECTION;
+	/**
+	 * The reference position for this step, indicating the relation to a particular point.
+	 *
+	 * @returns The BC_STEP_POSITION enum value representing the reference position.
+	 */
+	get reference(): BC_STEP_POSITION;
+	/**
+	 * The distance associated with this step, typically representing the length of the step.
+	 *
+	 * @returns The distance as a number.
+	 */
+	get distance(): number;
+}
+export interface BCRouteSegment {
+	/**
+	 * Retrieves the path of the route segment, represented by a sequence of BCMapNode objects.
+	 *
+	 * @returns An array of BCMapNode objects indicating the path of this segment.
+	 */
+	get path(): BCMapNode[];
+	/**
+	 * Retrieves the steps that make up this route segment, each represented by a BCRouteStep object.
+	 *
+	 * @returns An array of BCRouteStep objects detailing each step in the segment.
+	 */
+	get steps(): BCRouteStep[];
+	/**
+	 * Retrieves the distance of the route segment in appropriate units (e.g., meters or kilometers).
+	 *
+	 * @returns The total distance of this segment as a number.
+	 */
+	get distance(): number;
+}
+export interface BCRouteController {
+	/**
+	 * Displays the specified route on the map.
+	 *
+	 * @param segments - A single BCRouteSegment or an array of BCRouteSegment objects to display on the map.
+	 */
+	showRoute(segments: BCRouteSegment | BCRouteSegment[]): void;
+	/**
+	* Initiates a walkthrough of the given route segment, animating through each step of the route.
+	*
+	* This function will display the route on the map by moving through each step in the provided
+	* BCRouteSegment, allowing the user to visually follow the route. Optionally, a callback can be
+	* provided that will be executed each time a new step is reached during the animation.
+	*
+	* @param segment - The BCRouteSegment object representing the route to be walked through.
+	*                  This object contains the sequence of steps that define the route.
+	* @param stepCallback - An optional function that will be called with the current BCRouteStep
+	*                       each time the animation reaches a new step. This allows for custom
+	*                       actions to be performed on each step, such as updating the UI or logging
+	*                       information. The callback takes a single parameter:
+	*                       - step (BCRouteStep): The current step being processed in the walkthrough.
+	*
+	* @example
+	* walkThrough(segment, (step) => {
+	*     console.log(`Now at step: ${step.message}`);
+	* });
+	*/
+	walkThrough(segment: BCRouteSegment, stepCallback?: (step: BCRouteStep) => void): void;
+	/**
+	 * Stops the ongoing walkthrough of the route segment.
+	 */
+	stopWalking(): void;
+	/**
+	* Displays the specified route step on the map.
+	*
+	* This method highlights the given BCRouteStep on the map, providing visual feedback
+	* to the user regarding the current step in the route. This may include showing markers,
+	* updating the UI with step details, or animating the map view to focus on the step's
+	* associated location.
+	*
+	* @param step - The BCRouteStep object representing the step to be displayed. This object
+	*               contains information about the node, the action to be taken, the direction,
+	*               and other relevant details that can be used to visually represent the step
+	*               on the map.
+	*
+	* @example
+	* const routeStep: BCRouteStep =  /obtain the step from a route segment/;
+	* this.showStep(routeStep);
+	*/
+	showStep(step: BCRouteStep): void;
+	/**
+	* Removes the specified route segment's layers and sources from the map view.
+	* @param segment - The BCRouteSegment object to remove.
+	*/
+	remove(segment: BCRouteSegment): 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.
+	*/
+	clearAllRoutes(): void;
+}
+export interface BCPolygon {
+}
+declare class Polygon implements BCPolygon {
+	#private;
+	constructor(id: string, coordinates: BCMapCoordinateLike[], color: string, height?: number, opacity?: number);
+	toGeoJSON(): GeoJSON.Feature<GeoJSON.Polygon>;
+	getId(): string;
+}
+/**
+ * Interface for controlling polygon-related operations.
+ * Provides methods to add, update, and remove polygons.
+ */
+export interface BCPolygonController {
+	/**
+	 * Adds a new polygon to the map or system.
+	 * @param polygon - The polygon object to be added.
+	 */
+	addPolygon(polygon: Polygon): void;
+	/**
+	 * Updates the height of an existing polygon.
+	 * @param height - The new height to apply to the polygon.
+	 * @param polygon - The polygon object to be updated.
+	 */
+	updatePolygonHeight(height: number, polygon: Polygon): void;
+	/**
+	 * Removes a polygon from the map or system.
+	 * @param polygon - The polygon object to be removed.
+	 */
+	removePolygon(polygon: Polygon): void;
+}
+/**
+ * Type definition for a callback function to be executed when the map has loaded.
+ *
+ * This callback should not take any parameters and does not return any value. It can
+ * be used to perform additional actions once the map is fully initialized.
+ */
+export type LoadCallback = () => void;
+/**
+ * Options for configuring the initial view of the map.
+ *
+ * This interface allows specifying various parameters that control the
+ * appearance and perspective of the map when it is first rendered.
+ */
+export interface MapViewOptions {
+	/**
+	* 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
+	 * view. Higher values indicate closer views (more detail), while lower
+	 * values provide a wider view. The default zoom level can be defined
+	 * in the implementation.
+	 */
+	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.
+	*/
+	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.
+	*/
+	bearing?: number;
+}
+/**
+ * Class representing a map view, providing methods to manipulate and interact
+ * with the map interface.
+ */
+export declare class MapView {
+	#private;
+	/**
+	 * 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 onLoadCallback - An optional callback function to be executed
+	 *                         once the map has fully loaded.
+	 */
+	constructor(container: HTMLElement, site: BCMapSite, options?: MapViewOptions, onLoadCallback?: LoadCallback);
+	/**
+	 * Gets the HTML element that contains the map.
+	 *
+	 * @returns The HTMLElement representing the map container.
+	 */
+	get container(): HTMLElement;
+	/**
+   * 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;
+	/**
+	* Provides access to the polygon controller, which handles all polygon-related
+	* operations within the map view, such as adding, updating, and removing polygons.
+	* @returns An instance of BCPolygonController for managing polygon operations.
+	*/
+	get polygonController(): BCPolygonController;
+	/**
+	 * Focuses the map on a specified geographical point, optionally adjusting
+	 * the zoom level, bearing, and pitch.
+	 *
+	 * @param point - The point to focus on, represented as a
+	 *                BCMapCoordinateLike object.
+	 * @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.
+	 */
+	focusOnPoint(point: BCMapCoordinateLike, zoomLevel?: number, bearing?: number, pitch?: number): void;
+	setBounds(sw: BCMapCoordinateLike, ne: BCMapCoordinateLike): void;
+	addMarker(marker: BCMarker, cordinate: BCMapCoordinate): void;
+	getNode(id: string): BCMapNode | null;
+}
+export type BCRoutable = BCMapNode;
+export interface BCRouteOptions {
+	maxDistanceThreshold: number;
+	getAccessiblePath: boolean;
+}
+/**
+ * Retrieves the route from a start point to a goal point, optionally including waypoints and route options.
+ *
+ * @param start - The starting point of the route, represented by a BCRoutable object.
+ * @param goal - The destination point of the route, represented by a BCRoutable object.
+ * @param waypoints - Optional array of intermediate points (BCRoutable) to include in the route.
+ * @param routeOptions - Optional parameter to specify additional routing preferences or constraints.
+ * @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;
+
+export {};

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "becomap",
+  "version": "1.0.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": "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/webpack": "^5.28.5",
+    "babel-loader": "^9.1.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",
+    "axios": "^1.7.5",
+    "maplibre-gl": "^4.4.1",
+    "protobufjs": "^7.4.0"
+  }
+}