venue-js 1.2.0-next.1 → 1.2.0-next.10

package/dist/index.d.mts

@@ -3,16 +3,16 @@ export { QueryObserver } from '@tanstack/query-core';
 import * as geojson from 'geojson';
 import { Position, Geometry, GeoJsonProperties, Feature, Point, Polygon, MultiPolygon, LineString, GeometryCollection } from 'geojson';
 import * as maptalks_dist_core_Class from 'maptalks/dist/core/Class';
-import * as maptalks_dist_geo_Extent from 'maptalks/dist/geo/Extent';
-import { Map, Coordinate as Coordinate$1, Extent } from 'maptalks-gl';
+import * as maptalks$1 from 'maptalks-gl';
+import { Map } from 'maptalks-gl';
 import { BaseObject, ThreeLayer } from 'maptalks.three';
 import * as maptalks from 'maptalks';
-import { Coordinate, Marker, ui, LineString as LineString$1, Polygon as Polygon$1, MultiPolygon as MultiPolygon$1, MultiLineString } from 'maptalks';
-import { ExtrudePolygonOptionType } from 'maptalks.three/dist/type';
+import { Extent, Coordinate, Marker, ui, LineString as LineString$1, Polygon as Polygon$1, MultiPolygon as MultiPolygon$1, MultiLineString } from 'maptalks';
+import { BaseObjectOptionType, ExtrudePolygonOptionType } from 'maptalks.three/dist/type';
 import { PolygonOptionsType } from 'maptalks/dist/geometry/Polygon';
 import { LineStringOptionsType } from 'maptalks/dist/geometry/LineString';
-import { MapViewType, MapAnimationOptionsType } from 'maptalks/dist/map/Map';
-import { SpriteMaterial, AmbientLight, DirectionalLight } from 'three';
+import { MapViewType, MapAnimationOptionsType, MapPaddingType } from 'maptalks/dist/map/Map';
+import { SpriteMaterial } from 'three';
 
 type Id = string;
 type MediaFile = {
@@ -183,6 +183,7 @@ type OccupantProperties = EntityTimestamps & {
     kiosk_ids: Id[];
     unit_ids: Id[];
     website_link: string | null;
+    show_name_on_all_units: boolean;
 };
 type OccupantFeature = ImdfFeature<OccupantGeometry, OccupantProperties>;
 type OpeningGeometry = LineString;
@@ -533,10 +534,13 @@ type OccupantFeaturePopulated = OccupantFeature & {
          * [IMDF] Occupant's position
          */
         anchor: AnchorFeaturePopulated;
+        ordinal: number;
         /**
          * [venue.in.th] Occupant's category
          */
         local_categories: TaxonomyFeaturePopulated[];
+        unit?: UnitFeaturePopulated;
+        kiosk?: KioskFeaturePopulated;
         /**
          * [venue.in.th] Bind correlation between units on an occupant,
          * which will be used for highlighting in the floor plan and
@@ -713,8 +717,87 @@ declare const safeFetchFeature: <T extends FeatureType = FeatureType>(featureTyp
     baseUrl: string;
 }) => Promise<FeatureResponseMap[T][]>;
 
+/**
+ * Checks if a point is a valid coordinate pair.
+ *
+ * @param point - The point to be checked.
+ * @return True if the point is a valid coordinate pair, false otherwise.
+ */
+declare const isValidCoordinate: (point: Position) => boolean;
+/**
+ * Checks if an input represents a valid polygon, which may include holes.
+ * The input can be a single array of coordinates for simple polygons, or
+ * an array of arrays of coordinates for polygons with holes.
+ *
+ * @param polygon - The input representing a polygon.
+ * @return True if the polygon is valid, false otherwise.
+ */
+declare const isValidPolygonCoordinates: (polygon: Position[] | Position[][]) => boolean;
+/**
+ * Checks if an array of polygons forms a valid MultiPolygon.
+ *
+ * @param multipolygon - The array of polygons.
+ * @return True if the multipolygon is valid, false otherwise.
+ */
+declare const isValidMultiPolygonCoordinates: (multipolygon: Position[][][]) => boolean;
+/**
+ * Checks if a set of points forms a valid LineString.
+ * A valid LineString must have at least two points, each point must be a valid coordinate,
+ * and it should not form a closed loop.
+ *
+ * @param lineString - The array of points representing a LineString.
+ * @return True if the LineString is valid, false otherwise.
+ */
+declare const isValidLineStringCoordinates: (lineString: Position[]) => boolean;
+declare const isValidMultiPolygon: (geometry: Exclude<Geometry, GeometryCollection>) => boolean;
+declare const isValidPolygon: (geometry: Exclude<Geometry, GeometryCollection>) => boolean;
+declare const isValidLineString: (geometry: Exclude<Geometry, GeometryCollection>) => boolean;
+declare const isValidPoint: (geometry: Exclude<Geometry, GeometryCollection>) => boolean;
+
+declare function matchFilter(value: Value | Value[], filter: Filter): boolean;
+declare function matchFilters<T extends Record<string, any>>(item: T, filters: Filters): boolean;
+
+declare const getOccupantMainLocation: (occupant: OccupantFeaturePopulated) => UnitFeaturePopulated | KioskFeaturePopulated;
+declare const getOccupantCorrelatedLocations: (occupant: OccupantFeaturePopulated) => Array<UnitFeaturePopulated | KioskFeaturePopulated>;
+type OccupantMarkerPlacementType = 'ONCE_PER_LEVEL' | 'ALL_LOCATIONS';
+declare const getOccupantMarkerLocations: (occupant: OccupantFeaturePopulated, options?: {
+    type: OccupantMarkerPlacementType;
+}) => Array<UnitFeaturePopulated | KioskFeaturePopulated>;
+
+type occupantHelper_OccupantMarkerPlacementType = OccupantMarkerPlacementType;
+declare const occupantHelper_getOccupantCorrelatedLocations: typeof getOccupantCorrelatedLocations;
+declare const occupantHelper_getOccupantMainLocation: typeof getOccupantMainLocation;
+declare const occupantHelper_getOccupantMarkerLocations: typeof getOccupantMarkerLocations;
+declare namespace occupantHelper {
+  export { type occupantHelper_OccupantMarkerPlacementType as OccupantMarkerPlacementType, occupantHelper_getOccupantCorrelatedLocations as getOccupantCorrelatedLocations, occupantHelper_getOccupantMainLocation as getOccupantMainLocation, occupantHelper_getOccupantMarkerLocations as getOccupantMarkerLocations };
+}
+
 declare const getDataClient: (options: VenueClientOptions) => VenueDataClient;
 
+type TextMarkerOptions = BaseObjectOptionType & {
+    text?: string;
+    textAlign?: CanvasTextAlign;
+    color?: CanvasFillStrokeStyles["fillStyle"];
+    fontFamily?: string;
+    fontSize?: number;
+    fontWeight?: number;
+    background?: CanvasFillStrokeStyles["fillStyle"];
+    lineHeight?: number;
+    strokeColor?: CanvasFillStrokeStyles["strokeStyle"];
+    strokeWidth?: number;
+    strokeStyle?: CanvasLineJoin;
+    padding?: number;
+    maxWidth?: number;
+    scale?: number;
+    altitude?: number;
+    bottomHeight?: number;
+    opacity?: number | {
+        stops: Stop[];
+    };
+};
+
+type Stop = [zoom: number, value: number];
+type MapElement = maptalks.Geometry | BaseObject;
 /** 2D */
 type TypeRenderOptions<TOptionsType> = {
     default: TOptionsType;
@@ -737,19 +820,26 @@ type Element3DRendererOptions = {
     unit?: TypeRenderOptions<CreateExtrudePolygonOptionType>;
 };
 /** RendererManager */
-type RendererManagerOptions = {
+type BaseRenderManagerOptions = {
+    delayBeforeCreateElements?: number;
+    onRendererReady?: () => void;
+};
+type RendererManagerOptions = BaseRenderManagerOptions & {
     type: "2D";
     elements: Element2DRendererOptions;
-    onRendererReady?: () => void;
-} | {
+} | BaseRenderManagerOptions & {
     type: "3D";
     elements: Element3DRendererOptions;
-    onRendererReady?: () => void;
 };
+type HighlightElementOptions = {
+    reset: boolean;
+};
+
+type AnyMarkerOptions = TextMarkerOptions;
 
 declare class RendererManager extends EventTarget {
     #private;
-    map: maptalks.Map;
+    map: maptalks$1.Map;
     options: RendererManagerOptions;
     /** Elements: Responsible for converting feature info elements and add to map */
     private elementRenderer;
@@ -759,31 +849,51 @@ declare class RendererManager extends EventTarget {
     private currentOrdinals;
     private markersMap;
     private markersByOrdinal;
-    constructor(map: maptalks.Map, dataClient: VenueDataClient, options: RendererManagerOptions);
-    getElementsByOrdinal: (ordinal: number) => BaseObject[] | maptalks.Geometry[];
-    getMarkersByOrdinal: (ordinal: number) => BaseObject[] | maptalks.ui.UIMarker[];
+    private highlightControllers;
+    constructor(map: maptalks$1.Map, dataClient: VenueDataClient, options: RendererManagerOptions);
+    set onClickElement(func: any);
+    handleClickElement: (e: any) => void;
+    getElementsByOrdinal: (ordinal: number) => MapElement[];
     addElementsToManager: (id: any, elements: any, ordinal: any) => void;
-    addMarkersToManager: (id: any, markers: any, ordinal: any) => void;
     changeLevelByOrdinal(targetOrdinal: null | number | number[]): void;
+    highlightElements: (elemIds: string[], options?: HighlightElementOptions) => void;
+    clearHighlightElements: () => void;
     /**
      * ========================================================================
      * Markers
      * ======================================================================== */
-    createMarker(coordinate: Position, ordinal: number, text: string, options: any): void;
+    _getMarkersByOrdinal: (ordinal: number) => BaseObject[] | maptalks$1.ui.UIMarker[];
+    _addMarkersToManager: (id: any, markers: any, ordinal: any) => void;
+    createMarker(coordinate: Position, ordinal: number, text: string, options: AnyMarkerOptions): void;
     clearMarkers(): void;
 }
 
+interface CameraManagerOptions {
+    defaultView?: MapViewType;
+}
+declare class CameraManager {
+    map: Map;
+    constructor(map: Map, options?: CameraManagerOptions);
+    /** Public methods */
+    getView: () => MapViewType;
+    setView: (value: MapViewType) => void;
+    animateTo: (view: MapViewType, options?: MapAnimationOptionsType, step?: (frame: any) => void) => void;
+    setMaxExtent(extent: Extent): Map;
+    getFeatureExtent: (feature: any, scaleFactor?: number) => Extent;
+    getExtentZoom: (extent: Extent, options?: {
+        isFraction?: boolean;
+        padding?: MapPaddingType;
+    }) => number;
+    set maxZoom(value: number);
+    set minZoom(value: number);
+}
+
 interface IndoorMapOptions {
     onMapReady?: () => void;
     onMapLoading?: () => void;
     centerCross?: boolean;
     dataClient: VenueDataClient;
-    camera?: {
-        defaultCenter?: [number, number];
-        defaultZoom?: number;
-        defaultBearing?: number;
-        defaultPitch?: number;
-    };
+    camera?: CameraManagerOptions;
     renderer?: RendererManagerOptions;
     pixelRatio?: number;
     locale?: string;
@@ -868,29 +978,9 @@ interface IMapConfig {
     prepare_steps?: IGraphFeatureOptions;
 }
 
-interface CameraManagerOptions {
-    defaultView?: MapViewType;
-}
-declare class CameraManager {
-    #private;
-    map: Map;
-    constructor(map: Map, options?: CameraManagerOptions);
-    /** Public methods */
-    getView: () => MapViewType;
-    getZoom: () => number;
-    setView: (value: MapViewType) => void;
-    flyTo: (center: any, options?: MapAnimationOptionsType & MapViewType) => void;
-    flyToAndZoomIn: (centerPoint: any, options?: MapAnimationOptionsType & MapViewType) => void;
-}
-
-type MapPaddingType = {
-    paddingLeft: number;
-    paddingRight: number;
-    paddingTop: number;
-    paddingBottom: number;
-};
 declare class IndoorMap extends EventTarget {
     #private;
+    options: IndoorMapOptions;
     map: Map | null;
     camera: CameraManager;
     rendererManager: RendererManager;
@@ -900,10 +990,10 @@ declare class IndoorMap extends EventTarget {
     onMapLoading: () => void;
     constructor(elementId: any, options: IndoorMapOptions);
     set dataClient(value: any);
-    on(eventName: string, handler: any): void;
     /**
      * Events
      */
+    on(eventName: string, handler: any): void;
     handleMapClick: ({ coordinate }: {
         coordinate: any;
     }) => void;
@@ -919,34 +1009,21 @@ declare class IndoorMap extends EventTarget {
     set mapTheme(value: any);
     get venues(): any[];
     set detectVenueInView(value: any);
-    get ordinals(): any[];
-    set ordinals(value: any[]);
     set billboards(value: any);
-    set mapConfig(value: IMapConfig);
     set mapDecorations(value: any);
-    set maxZoom(value: number);
-    set minZoom(value: number);
     set groundLabels(value: any);
     set pixelRatio(value: number);
     set onClickElement(func: any);
     set locale(value: string);
     handleClickElement: (e: any) => void;
-    setCenter(center: Coordinate$1, padding?: MapPaddingType): void;
     /**
      * Change Level & animate to path / geometry / view / etc.
      * ================================== */
     changeLevelByOrdinal(ordinal: null | number | number[]): void;
-    getFeatureExtent: (feature: any, scaleFactor?: number) => Extent;
-    getExtentCenter: (extent: Extent) => maptalks_dist_geo_Extent.PositionType;
-    getExtentZoom: (extent: Extent, options?: {
-        isFraction?: boolean;
-        padding?: MapPaddingType;
-    }) => number;
     findVenueInView: () => {
         venueId: string;
         distance: number;
     };
-    flyTo: (center: any, options: any) => void;
     getLineStringBearing: (feature: any) => number;
     addAnimations(animation: {
         id: string;
@@ -1014,15 +1091,6 @@ declare class IndoorMap extends EventTarget {
     /**
      * render (frame)
      */
-    getTargetViewCenter: (targetView: any, options?: {
-        offset: {
-            top: number;
-            left: number;
-            right: number;
-            bottom: number;
-        };
-    }) => Coordinate$1;
-    setMaxExtent(extent: Extent): Map;
     render(): void;
 }
 
@@ -1125,11 +1193,7 @@ declare function styledFeatureGenerator(mapTheme: any): {
     create3DAmenityMarker: (feature: any, threeLayer: any, config: any) => SpriteMarker;
     create3DOccupantAmenityMarker: (feature: any, threeLayer: any, config: any) => SpriteMarker;
     create3DOpeningMarker: (feature: any, threeLayer: any, config: any) => SpriteMarker;
-    createVenue3DModel: (venue: any, threeLayer: any) => Promise<any[]>;
-    create3DFixture: (fixture: any, threeLayer: any) => Promise<any[]>;
     createExtrudedUnit: (unit: any, threeLayer: any, options: any) => any;
-    createAmbientLight: (config: any) => AmbientLight;
-    createDirectionalLight: (config: any) => DirectionalLight;
 };
 declare function getLocationByAmenity(feature: any): any;
 declare function getLocationByOccupant(feature: any): any;
@@ -1220,4 +1284,4 @@ declare const VENUE_EVENTS: {
     VENUE_MOVEINTOVIEW: string;
 };
 
-export { ALL_FEATURE_TYPES, ALWAYS_VISIBLE_FEATURE_TYPES, type AmenityFeature, type AmenityFeaturePopulated, type AmenityGeometry, type AmenityProperties, type AnchorFeature, type AnchorFeaturePopulated, type AnchorGeometry, type AnchorProperties, BASE_LAYER_NAME, DEFAULT_BASE_URL, DEFAULT_HIGHLIGHT_OPTIONS, DEFAULT_LOCALE, DEFAULT_SET_HIGHLIGHT_2DELEMENT_IDS_OPTIONS, DESTINATION_MARKER_ID, type DetailFeature, type DetailGeometry, type DetailProperties, type ElementFeature, type ElementGeometry, type ElementProperties, type EventFeature, type EventGeometry, type EventProperties, type FeaturePopulatedResponseMap, type FeatureQueryOptions, type FeatureResponseMap, type FeatureType, type FilterParams, type FindParams, type FixtureFeature, type FixtureFeaturePopulated, type FixtureGeometry, type FixtureProperties, GEOJSON_FEATURE_TYPES, HIGHLIGHT_LAYER_NAME, IMDF_FEATURE_TYPES, type Id, type ImdfFeature, IndoorMap, type InternalFilterByType, type InternalFindById, type KioskFeature, type KioskFeaturePopulated, type KioskGeometry, type KioskProperties, LAST_USER_LOCATION_ELEMENT_ID_PREFIX, LAYERS, LAYER_FEATURE_TYPE_OBJ, LAYER_OPTIONS, LOCALE_SYMBOL_KEY, type LabelFeature, type LabelGeometry, type LabelProperties, type LevelFeature, type LevelFeaturePopulated, type LevelGeometry, type LevelProperties, MARKER_LAYER_NAME, type Media, type MediaFile, type Model3d, NONIMDF_FEATURE_TYPES, ORIGIN_MARKER_ID, type OccupantFeature, type OccupantFeaturePopulated, type OccupantGeometry, type OccupantProperties, type OpeningFeature, type OpeningFeaturePopulated, type OpeningGeometry, type OpeningProperties, POI_MARKER_LAYER_NAME, type Page, type PolygonalFeature, type PopulatableFeatureType, type PopulatedParams, type PrivilegeFeature, type PrivilegeGeometry, type PrivilegeProperties, type PromotionFeature, type PromotionProperties, type RelationshipFeature, type RelationshipGeometry, type RelationshipProperties, type SectionFeature, type SectionFeaturePopulated, type SectionGeometry, type SectionProperties, type SponsoredContentFeature, type SponsoredContentLegacyType, type SponsoredContentPlacementType, type SponsoredContentStrapiV4ApiResponse, type TaxonomyFeature, type TaxonomyFeaturePopulated, type TaxonomyGeometry, type TaxonomyProperties, USER_LOCATION_ELEMENT_ID, USER_LOCATION_LAYER_NAME, type UnitFeature, type UnitFeaturePopulated, type UnitGeometry, type UnitProperties, VENUE_EVENTS, type VenueClientOptions, type VenueDataClient, type VenueFeature, type VenueFeaturePopulated, type VenueGeometry, type VenueProperties, createPolygonFromLineString, createSpriteMaterialByLabelSymbol, createStyledUIMarkerElement, defaultFeatureQueryOptionsMap, fetchDeliveryApi, fetchPreviewApi, getBearingBetweenPoints, getCenterFromGeometry, getDataClient, getExtrudeConfigByFeature, getFeatureByLocationId, getLocationByAmenity, getLocationByFeature, getLocationByOccupant, getLocationIdByFeature, getOrdinalByLocationId, getRelatedLocationIdsByFeature, getRelatedLocationsByAmenity, getRelatedLocationsByFeature, getRelatedLocationsByOccupant, getSuitablyValueBetweenBearings, isClickableFeature, safeFetchFeature, styledFeatureGenerator };
+export { ALL_FEATURE_TYPES, ALWAYS_VISIBLE_FEATURE_TYPES, type AmenityFeature, type AmenityFeaturePopulated, type AmenityGeometry, type AmenityProperties, type AnchorFeature, type AnchorFeaturePopulated, type AnchorGeometry, type AnchorProperties, BASE_LAYER_NAME, DEFAULT_BASE_URL, DEFAULT_HIGHLIGHT_OPTIONS, DEFAULT_LOCALE, DEFAULT_SET_HIGHLIGHT_2DELEMENT_IDS_OPTIONS, DESTINATION_MARKER_ID, type DetailFeature, type DetailGeometry, type DetailProperties, type ElementFeature, type ElementGeometry, type ElementProperties, type EventFeature, type EventGeometry, type EventProperties, type FeaturePopulatedResponseMap, type FeatureQueryOptions, type FeatureResponseMap, type FeatureType, type FilterParams, type FindParams, type FixtureFeature, type FixtureFeaturePopulated, type FixtureGeometry, type FixtureProperties, GEOJSON_FEATURE_TYPES, HIGHLIGHT_LAYER_NAME, type IAllVenuesViewConfig, type IExtrudeConfig, type IGraphFeatureOptions, type IGraphOptions, type IHighlightOptions, IMDF_FEATURE_TYPES, type IMapAnimation, type IMapConfig, type IMapExtrudeConfig, type ISetHighlight2DElementIdsOptions, type ISetHighlightElementIdsOptions, type IUnitDistanceModifier, type IVerticalGraphOptions, type Id, type ImdfFeature, IndoorMap, type IndoorMapOptions, type InternalFilterByType, type InternalFindById, type KioskFeature, type KioskFeaturePopulated, type KioskGeometry, type KioskProperties, LAST_USER_LOCATION_ELEMENT_ID_PREFIX, LAYERS, LAYER_FEATURE_TYPE_OBJ, LAYER_OPTIONS, LOCALE_SYMBOL_KEY, type LabelFeature, type LabelGeometry, type LabelProperties, type LevelFeature, type LevelFeaturePopulated, type LevelGeometry, type LevelProperties, MARKER_LAYER_NAME, type Media, type MediaFile, type Model3d, NONIMDF_FEATURE_TYPES, ORIGIN_MARKER_ID, type OccupantFeature, type OccupantFeaturePopulated, type OccupantGeometry, occupantHelper as OccupantHelpers, type OccupantProperties, type OpeningFeature, type OpeningFeaturePopulated, type OpeningGeometry, type OpeningProperties, POI_MARKER_LAYER_NAME, type Page, type PolygonalFeature, type PopulatableFeatureType, type PopulatedParams, type PrivilegeFeature, type PrivilegeGeometry, type PrivilegeProperties, type PromotionFeature, type PromotionProperties, type RelationshipFeature, type RelationshipGeometry, type RelationshipProperties, type SectionFeature, type SectionFeaturePopulated, type SectionGeometry, type SectionProperties, type SponsoredContentFeature, type SponsoredContentLegacyType, type SponsoredContentPlacementType, type SponsoredContentStrapiV4ApiResponse, type SymbolSet, type TaxonomyFeature, type TaxonomyFeaturePopulated, type TaxonomyGeometry, type TaxonomyProperties, USER_LOCATION_ELEMENT_ID, USER_LOCATION_LAYER_NAME, type UnitFeature, type UnitFeaturePopulated, type UnitGeometry, type UnitProperties, VENUE_EVENTS, type VenueClientOptions, type VenueDataClient, type VenueFeature, type VenueFeaturePopulated, type VenueGeometry, type VenueProperties, createPolygonFromLineString, createSpriteMaterialByLabelSymbol, createStyledUIMarkerElement, defaultFeatureQueryOptionsMap, fetchDeliveryApi, fetchPreviewApi, getBearingBetweenPoints, getCenterFromGeometry, getDataClient, getExtrudeConfigByFeature, getFeatureByLocationId, getLocationByAmenity, getLocationByFeature, getLocationByOccupant, getLocationIdByFeature, getOrdinalByLocationId, getRelatedLocationIdsByFeature, getRelatedLocationsByAmenity, getRelatedLocationsByFeature, getRelatedLocationsByOccupant, getSuitablyValueBetweenBearings, isClickableFeature, isValidCoordinate, isValidLineString, isValidLineStringCoordinates, isValidMultiPolygon, isValidMultiPolygonCoordinates, isValidPoint, isValidPolygon, isValidPolygonCoordinates, matchFilter, matchFilters, safeFetchFeature, styledFeatureGenerator };