@mapxus/mapxus-map-jp 8.0.0 → 8.1.0

package/es/index.d.ts

@@ -1,6 +1,7 @@
 // Generated by dts-bundle-generator v9.5.1
 
 import { AxiosPromise } from 'axios';
+import { EventEmitter } from 'events';
 import { GeoJsonProperties, LineString, Point } from 'geojson';
 import maplibregl$1 from 'maplibre-gl';
 import { ControlPosition, ExpressionSpecification, FilterSpecification, IControl, LngLat, MapGeoJSONFeature, MapLayerEventType, PaddingOptions, PointLike, RequireAtLeastOne } from 'maplibre-gl';
@@ -32,6 +33,10 @@ export declare enum ThemeType {
 	COMMON = "common",
 	MAPXUS_V2 = "mapxus_v2"
 }
+export declare enum AccessControlOrigin {
+	Self = "self",
+	Map = "map"
+}
 export interface IBbox {
 	maxLat: number;
 	maxLon: number;
@@ -92,6 +97,28 @@ export interface IResponseBuildings {
 	total: number;
 }
 export type TPromiseBuildings = AxiosPromise<IResponse<IResponseBuildings>>;
+export interface IBuildingSearchCustomizedOptions {
+	bounds?: [
+		[
+			number,
+			number
+		],
+		[
+			number,
+			number
+		]
+	];
+	center?: [
+		number,
+		number
+	];
+	distance?: number;
+	keywords?: string;
+	signal?: boolean;
+	visual?: boolean;
+	offset?: number;
+	page?: number;
+}
 export type TPointFeature = GeoJSON.Feature<Point, GeoJsonProperties>;
 export type TLineStringFeature = GeoJSON.Feature<LineString, GeoJsonProperties>;
 export interface IFloor {
@@ -200,6 +227,41 @@ export interface IPointEvent {
 	coordinate: LngLat;
 	point: PointLike;
 }
+export declare enum DistanceSearchType {
+	POINT = "Point",
+	POLYGON = "Polygon"
+}
+export declare enum OrientationDistanceSearchType {
+	POINT = "Point",
+	POLYGON = "Polygon",
+	GATE = "Gate"
+}
+export interface IBoundsSpec {
+	/** An array of LngLat coordinates in [sw, ne] order */
+	bounds: [
+		[
+			number,
+			number
+		],
+		[
+			number,
+			number
+		]
+	];
+}
+export interface IKeywordSpec {
+	keywords?: string;
+}
+export interface IBuildingSpec {
+	buildingId: string;
+}
+export interface IVenueSpec {
+	venueId: string;
+}
+export interface IFloorSpec {
+	floorId: string;
+}
+export type TSearchCategoriesOptions = IVenueSpec | IBuildingSpec | IFloorSpec | (IBoundsSpec & IKeywordSpec);
 export interface IPoi {
 	accessibilityDetail: IMultilingualName;
 	buildingId: string;
@@ -226,11 +288,6 @@ export interface IResponsePois {
 export type TPromisePois = AxiosPromise<IResponse<IResponsePois>>;
 export type TPromiseCategories = AxiosPromise<IResponse<IPoiCategory[]>>;
 export type TPromiseOrientationPois = AxiosPromise<IResponse<IOrientationPoi[]>>;
-export declare enum DistanceSearchType {
-	POINT = "Point",
-	POLYGON = "Polygon",
-	GATE = "Gate"
-}
 export interface IPoiCategory {
 	category: string;
 	description: string | null;
@@ -309,7 +366,7 @@ export interface ISearchOrientation {
 	/**
 	 * The type of POI, default is 'Point'.
 	 */
-	distanceSearchType?: DistanceSearchType;
+	distanceSearchType?: OrientationDistanceSearchType;
 }
 export interface IPoiSearchByOrientationAndBuildingOptions extends ISearchOrientation {
 	buildingId: string;
@@ -324,6 +381,10 @@ export type TPoiSearchByOrientationOptions = IPoiSearchByOrientationAndBuildingO
 export declare enum PoisOrderBy {
 	DEFAULT_NAME = "DefaultName"
 }
+export declare enum PoisSortBy {
+	ABSOLUTE_DISTANCE = "AbsoluteDistance",
+	ACTUAL_DISTANCE = "ActualDistance"
+}
 export interface ISearchKeywords {
 	keywords?: string;
 	/**
@@ -363,6 +424,34 @@ export interface IPoiSearchByBoundsOptions extends ISearchKeywords {
 	];
 	orderBy?: PoisOrderBy;
 }
+export interface IPoiSearchCustomizedOptions {
+	bounds?: [
+		[
+			number,
+			number
+		],
+		[
+			number,
+			number
+		]
+	];
+	center?: [
+		number,
+		number
+	];
+	distance?: number;
+	category?: string;
+	excludedCategories?: string | string[];
+	floorId?: string;
+	buildingId?: string;
+	venueId?: string;
+	keywords?: string;
+	orderBy?: PoisOrderBy;
+	sort?: PoisSortBy;
+	distanceSearchType?: DistanceSearchType;
+	offset?: number;
+	page?: number;
+}
 export interface ITokenInfo {
 	"app:name": string;
 	auth_time: number;
@@ -497,87 +586,9 @@ export interface IResponseVenues {
 	total: number;
 }
 export type TPromiseVenues = AxiosPromise<IResponse<IResponseVenues>>;
-export interface IBoundsSpec {
-	/** An array of LngLat coordinates in [sw, ne] order */
-	bounds: [
-		[
-			number,
-			number
-		],
-		[
-			number,
-			number
-		]
-	];
+export interface IVenueSearchCustomizedOptions extends IBuildingSearchCustomizedOptions {
 }
-export interface IKeywordSpec {
-	keywords?: string;
-}
-export interface IBuildingSpec {
-	buildingId: string;
-}
-export interface IVenueSpec {
-	venueId: string;
-}
-export interface IFloorSpec {
-	floorId: string;
-}
-export type TSearchCategoriesOptions = IVenueSpec | IBuildingSpec | IFloorSpec | (IBoundsSpec & IKeywordSpec);
-export type Listener = (param: any) => any;
-declare class Event$1 {
-	private _type;
-	private _target;
-	constructor(type: string, data?: Object);
-	get type(): string;
-	set type(type: string);
-	get target(): Evented;
-	set target(target: Evented);
-}
-declare class Evented {
-	private _listeners;
-	private _oneTimeListeners;
-	private _eventedParent;
-	private _eventedParentData;
-	/**
-	 * @description Register a new event listener
-	 * @param type name of the event(a unique string)
-	 * @param listener event handler, it will be called when the event is fired
-	 */
-	on(type: string, listener: Listener): this;
-	/**
-	 * @description Remove a registered event listener
-	 * @param type name of the event
-	 * @param listener event handler
-	 */
-	off(type: string, listener: Listener): this;
-	/**
-	 * Adds a listener that will be called only once to a specified event type.
-	 *
-	 * The listener will be called first time the event fires after the listener is registered.
-	 *
-	 * @param {string} type The event type to listen for.
-	 * @param {Function} listener The function to be called when the event is fired the first time.
-	 * @returns {Object} `this`
-	 */
-	once(type: string, listener: Listener): this;
-	fire(event: Event$1): this;
-	/**
-	 * Returns a true if this instance of Evented or any forwardeed instances of Evented have a listener for the specified type.
-	 *
-	 * @param {string} type The event type
-	 * @returns {boolean} `true` if there is at least one registered listener for specified event type, `false` otherwise
-	 * @private
-	 */
-	listens(type: string): boolean;
-	/**
-	 * Bubble all events fired by this instance of Evented to this parent instance of Evented.
-	 *
-	 * @returns {Object} `this`
-	 * @private
-	 */
-	setEventedParent(parent: Evented, data?: Object | (() => Object)): this;
-}
-export declare class Indoor extends Evented {
+export declare class Indoor extends EventEmitter {
 	private _map;
 	private _features;
 	private _allBuildings;
@@ -603,7 +614,7 @@ export declare class Indoor extends Evented {
 	private _maplibreMapLoaded;
 	private _indoorMapLoaded;
 	private readonly _isVenueMode;
-	private _isMaskMode;
+	private readonly _isMaskMode;
 	private _upperLevels;
 	private _lowerLevels;
 	private _featureIncomplete;
@@ -615,6 +626,10 @@ export declare class Indoor extends Evented {
 	private _upperBuildings;
 	private _lowerBuildings;
 	private readonly _hiddenBuildings;
+	private _isDestroyed;
+	private _findBuildingTimeoutId;
+	private _findBuildingIntervalId;
+	private _debounceRendering;
 	constructor(props: {
 		map: maplibregl$1.Map;
 		/** @deprecated */
@@ -626,6 +641,7 @@ export declare class Indoor extends Evented {
 		outdoorMapShown?: boolean;
 		selectedBuildingBorderStyle?: ISelectedBuildingBorderStyle;
 	});
+	destroy(): void;
 	/**
 	 * @description Set whether to allow exiting building.
 	 * @param allow
@@ -739,6 +755,7 @@ export declare class Indoor extends Evented {
 	private _resetSelectedBuildingLevel;
 	private _checkAndPanToBuilding;
 	private _invisibleSelectedBuilding;
+	private _clearTimers;
 }
 export declare class BuildingFilterControl implements IControl {
 	private _map;
@@ -751,29 +768,13 @@ export declare class BuildingFilterControl implements IControl {
 	private _listHeight;
 	private _visible;
 	private _position;
-	/**
-	 * @param map
-	 * @param position - **@deprecated** The optional parameter **'position' will be removed soon**.
-	 * @param buildingSelectorEnabled
-	 */
-	constructor(map: Map$1, position?: ControlPosition, buildingSelectorEnabled?: boolean);
+	constructor(map: Map$1, buildingSelectorEnabled?: boolean);
 	onAdd(map: maplibregl$1.Map): HTMLElement;
 	onRemove(): void;
 	get position(): ControlPosition;
 	get enabled(): boolean;
 	getDefaultPosition(): ControlPosition;
-	/**
-	 * @deprecated Use 'setVisibility' instead.
-	 * @param isHidden
-	 */
-	setLayoutHidden(isHidden: boolean): void;
 	setVisibility(isVisible: boolean): void;
-	/**
-	 * @deprecated Use 'changePosition' instead.
-	 * @param from
-	 * @param to
-	 */
-	moveBuildingFilter(from: ControlPosition, to: ControlPosition): void;
 	changePosition(from: ControlPosition, to: ControlPosition, index?: number): void;
 	private _loadData;
 	private _init;
@@ -819,10 +820,8 @@ export declare class FloorsControl implements IControl {
 	private _isEnabled;
 	private _visible;
 	private _dragPan;
-	/**
-	 * @param indoor
-	 * @param options
-	 */
+	private _debounceScroll;
+	private _clearScrollEventListener;
 	constructor(indoor: Indoor, options: IFloorSelectorOptions);
 	onAdd(map: maplibregl$1.Map): HTMLElement;
 	onRemove(): void;
@@ -835,7 +834,7 @@ export declare class FloorsControl implements IControl {
 	 * @param ordinal
 	 * @param dragPan
 	 */
-	switchByOrdinal(ordinal: string, dragPan?: boolean): void;
+	switchByOrdinal(ordinal: string, dragPan?: boolean): Promise<void>;
 	changePosition(from: ControlPosition, to: ControlPosition, index?: number): void;
 	setStyle(style: Partial<IFloorSelectorStyle>): void;
 	private _setVisibility;
@@ -910,7 +909,8 @@ export declare class SwitchOutdoorHandler {
 	disable(): void;
 	get isEnabled(): boolean;
 }
-declare class Map$1 extends Evented {
+declare class Map$1 {
+	private _appId;
 	private _map;
 	private _indoor;
 	private _poi;
@@ -923,6 +923,9 @@ declare class Map$1 extends Evented {
 	private _fitBuildingBounds;
 	private _history;
 	private _hiddenBuildings;
+	private _debounceHTTPErrorHandler;
+	private _debounceTilesFilter;
+	isDestroyed: boolean;
 	switchOutdoor: SwitchOutdoorHandler;
 	switchBuilding: SwitchBuildingHandler;
 	buildingSelector: BuildingSelectorHandler;
@@ -933,6 +936,7 @@ declare class Map$1 extends Evented {
 	 * @param callback
 	 */
 	renderComplete(callback: VoidFunction): void;
+	destroyed(callback: VoidFunction): void;
 	/**
 	 * @description Get map indoor instance.
 	 */
@@ -1079,6 +1083,7 @@ declare class Map$1 extends Evented {
 	 * @returns Map<buildingId, buildingFeature>
 	 */
 	private _getCenterBuildingsMap;
+	private _destroy;
 }
 export declare class Marker {
 	private readonly _maplibreMap;
@@ -1204,7 +1209,9 @@ export declare class Poi {
 	private _map;
 	private _layerIds;
 	private _dispatch;
+	private _debounceQueryFeatures;
 	constructor(map: maplibregl$1.Map);
+	destroy(): void;
 	/**
 	 * @description Listen for POI click events.
 	 * @param listener
@@ -1213,7 +1220,7 @@ export declare class Poi {
 		unsubscribe: VoidFunction;
 	};
 	private _bindEvents;
-	private _init;
+	private _queryPoiLayers;
 	private _initPoiClick;
 	private _getFloorDataByFloorId;
 }
@@ -1352,6 +1359,37 @@ export declare class RoutePainter {
 	private _updateLayers;
 	private _filterRouteOpacity;
 }
+/**
+ * AccessControl class, for providing token and managing token lifecycle.
+ * @extends EventEmitter
+ * Three events are emitted:
+ * - "updated": Emitted when the token is updated. Usage: accessControl.on("updated", ({ appId, token }) => {});
+ * - "error": Emitted when an error occurs during token update. Usage: accessControl.on("error", (error) => {});
+ * - "closed": Emitted when the access control is closed. Usage: accessControl.on("closed", () => {});
+ */
+export declare class AccessControl extends EventEmitter {
+	private readonly _appId;
+	private readonly _secret;
+	isClosed: boolean;
+	private _timeoutId;
+	private _isInitialized;
+	private readonly _initializationPromise;
+	private _tokenManager;
+	private readonly _from;
+	constructor(appId: string, secret: string, origin?: AccessControlOrigin);
+	ready(): Promise<void>;
+	get appId(): string;
+	/**
+	 * Get the token which is kept up-to-date automatically.
+	 */
+	get token(): string;
+	/**
+	 * Destroy the access_control instance, stop updating token.
+	 */
+	close(): void;
+	private _initToken;
+	private _loopUpdateToken;
+}
 export declare class VenuesService {
 	private _api;
 	private _request;
@@ -1393,6 +1431,7 @@ export declare class VenuesService {
 	 * @param page Default is 1.
 	 */
 	searchByGlobal(keywords: string, offset?: number, page?: number): TPromiseVenues;
+	search(options: IVenueSearchCustomizedOptions): TPromiseVenues;
 	private _changedRes;
 }
 export declare class BuildingsService {
@@ -1433,6 +1472,7 @@ export declare class BuildingsService {
 	 * @param floorId
 	 */
 	searchByFloorId(floorId: string): TPromiseBuildings;
+	search(options: IBuildingSearchCustomizedOptions): TPromiseBuildings;
 	private _changedRes;
 }
 export declare class PoisService {
@@ -1491,6 +1531,7 @@ export declare class PoisService {
 	 * @param options {TPoiSearchByCategoryOptions}
 	 */
 	searchByCategory(options: TPoiSearchByCategoryOptions): TPromisePois;
+	search(options: IPoiSearchCustomizedOptions): TPromisePois;
 	private _changedRes;
 }
 export declare class RouteService {