@pointr-tech/web-sdk 10.11.0 → 10.12.0

package/dist/pointrwebsdk.d.ts

@@ -141,6 +141,7 @@ interface PoiProperties {
     readonly mapPersonas?: string[] | null;
     name?: string;
     description?: string;
+    shortDescription?: string;
     keywords?: string | string[];
     internalIdentifier?: string;
     imageUrl?: string;
@@ -181,6 +182,7 @@ declare class Poi implements SearchablePoi {
     siteInternalIdentifier?: string;
     constructor(data?: PoiData);
     protected normalizeProperties(value: PoiProperties): PoiProperties;
+    protected buildSearchDescription(properties: PoiProperties): string;
     protected lockImmutableProperty(target: PoiProperties, key: keyof PoiProperties, propertyValue: unknown): void;
     protected warnIfImmutablePropertyChanged(current: PoiProperties, incoming: PoiProperties, key: keyof PoiProperties): void;
     isValid(): boolean;
@@ -243,6 +245,7 @@ interface DecodedToken {
     signedUrlParams?: string;
     sasToken?: string;
     cdnBaseUrl?: string;
+    peteToken?: string;
 }
 declare class NetworkCoordinator {
     static _instance: NetworkCoordinator;
@@ -1051,6 +1054,7 @@ declare class MapView extends BaseView {
     setLayerZoomRange(layerId: string, minZoom: number, maxZoom: number): void;
     setPaintProperty(layerId: string, property: string, value: any): void;
     setLayoutProperty(layerId: string, property: string, value: any): void;
+    refreshLayerAfterFilterChange(layerId: string): void;
     setFilter(layerId: string, expression: any): void;
     getAllLayers(): any[];
     zoomTo(level: number): void;
@@ -1580,6 +1584,15 @@ declare class SearchViewController extends BaseViewController {
     reset(): void;
 }
 
+type SyntheticCategoryId = "bookmarked" | "favorites";
+interface CategoryItem {
+    title: string;
+    iconUrl: string;
+    match?: JsonObject[];
+    syntheticId?: SyntheticCategoryId;
+    [key: string]: JsonValue;
+}
+
 declare class CategoryListView extends BaseView {
     events: BaseView["events"] & {
         categorySelected: string;
@@ -1588,6 +1601,7 @@ declare class CategoryListView extends BaseView {
     pointrSearchId: string;
     draggableBoxId: string;
     categoryItemClass: string;
+    categoryItemSyntheticClass: string;
     categoryIconClass: string;
     categoryIconWrapperClass: string;
     categoryIconWrapperStyleClass: Record<number, string>;
@@ -1604,8 +1618,11 @@ declare class CategoryListView extends BaseView {
     initKeyboardNavigation(): void;
     private static isKeyboardFocusEvent;
     refreshCategoryListKeyboard(activeIndex?: number): void;
+    resetViewState(): void;
     applyAccessibilityLabels(): void;
     populate(): boolean;
+    appendSyntheticCategoryIcon(iconWrapper: JQuery, iconUrl: string, title: string): void;
+    getSyntheticCategoryTitle(categoryItem: CategoryItem): string;
     show(): void;
     hide(): boolean;
     setCategories(_categoryList: unknown[]): void;
@@ -1619,9 +1636,14 @@ declare class CategoryListViewController extends BaseViewController {
     populate(): boolean;
     showView(): void;
     setCategories(categoryList: unknown[]): void;
+    prependSyntheticCategories(categories: CategoryItem[]): CategoryItem[];
+    getSyntheticCategorySiteId(): string;
+    getAvailablePoiFidSet(): Set<string>;
+    hasMatchingStoredPois(siteId: string, actionId: "favorite" | "bookmark", availableFids: Set<string>): boolean;
     getCategories(): unknown[] | undefined;
     hideView(): void;
     setTranslation(translation: Translation): void;
+    updateSyntheticCategoryTitles(): void;
 }
 
 interface LevelSelectorLevelObj {
@@ -1710,6 +1732,34 @@ declare class LevelSelectorViewController extends BaseViewController {
     hide(): void;
 }
 
+interface PoiPropertyPill {
+    valueKey: string;
+    label: string;
+    iconName?: string;
+    colorToken?: string;
+    iconOnly?: boolean;
+    [key: string]: JsonValue;
+}
+interface PoiPropertyPillsGroup {
+    kind: "pills";
+    key: string;
+    title: string;
+    showTitle: boolean;
+    pills: PoiPropertyPill[];
+    segment?: string;
+    [key: string]: JsonValue;
+}
+type PoiPropertyAnchorKey = "openingHours" | "description" | "tags";
+interface PoiPropertyAnchorGroup {
+    kind: "anchor";
+    key: PoiPropertyAnchorKey;
+    title: string;
+    showTitle: boolean;
+    segment?: string;
+    [key: string]: JsonValue;
+}
+type PoiPropertyGroup = PoiPropertyPillsGroup | PoiPropertyAnchorGroup;
+
 interface OpenHoursEntry {
     day?: string | number;
     open?: string;
@@ -1723,6 +1773,12 @@ interface PoiDetailsButton {
     type?: string;
     [key: string]: JsonValue;
 }
+interface PoiDetailsHeaderActionConfig {
+    id: string;
+    iconUrl: string;
+    labelKey: string;
+    enabled?: boolean;
+}
 interface PoiDetailsDict {
     name?: string;
     levelTitle?: string;
@@ -1732,10 +1788,19 @@ interface PoiDetailsDict {
     numberOfRatings?: number;
     ratingMax?: number;
     priceRange?: number;
+    isWheelchairAccessible?: boolean;
+    crowdLevel?: string;
+    waitTime?: number;
+    dietaryOptions?: string[];
+    occupancyStatus?: string;
+    accessRestrictions?: string[];
+    highlightPropertyKeys?: string[];
+    propertySections?: PoiPropertyGroup[];
     openHours?: OpenHoursEntry[] | JsonObject;
     images?: string[];
     tags?: string[] | string;
     description?: string;
+    shortDescription?: string;
     buttons?: PoiDetailsButton[] | string;
     isFeatured?: boolean;
     [key: string]: JsonValue;
@@ -1745,13 +1810,23 @@ declare class PoiDetailsView extends BaseView {
     translation: Translation;
     events: BaseView["events"] & {
         closeClicked: string;
+        headerActionClicked: string;
         routeButtonClicked: string;
-        accessibilityButtonClicked: string;
         poiButtonClicked: string;
+        shareClicked: string;
         expanded: string;
         minimized: string;
+        sheetSizeChanged: string;
     };
     constructor(options?: Options, translation?: Translation);
+    setupButtonsHorizontalScroll(): void;
+    onButtonsScrollDragStart(event: Event): void;
+    updateButtonsScrollableState(): void;
+    isButtonsRowScrollable(): boolean;
+    onButtonsScrollPointerDown(event: PointerEvent): void;
+    onButtonsScrollPointerMove(event: PointerEvent): void;
+    onButtonsScrollPointerUp(event: PointerEvent): void;
+    onButtonsScrollWheel(event: WheelEvent): void;
     shouldHandleBottomSheetDrag(): boolean;
     attachSheetTouchMoveListener(): void;
     detachSheetTouchMoveListener(): void;
@@ -1761,14 +1836,49 @@ declare class PoiDetailsView extends BaseView {
     lockBottomSheetExpanded(): void;
     handleSheetTouchEnd(event: Event): void;
     snapBottomSheetFromDrag(releaseClientY: number): void;
+    getSheetHeight(): number;
+    captureCollapsedSheetHeight(): void;
+    checkSheetSizeChangeAfterExpand(): void;
+    cancelSheetSizeChangeCheck(): void;
     createUi(): void;
+    renderGoButton(): void;
+    updateGoButtonLabel(): void;
+    syncShareButton(): void;
+    renderShareButton(): void;
+    updateShareButtonLabel(): void;
+    bindShareButtonClick(): void;
+    applyShareButtonAccessibility(): void;
+    onShareClicked(): void;
+    resolveHeaderActions(): PoiDetailsHeaderActionConfig[];
+    setHeaderActionsEnabled(enabled: boolean): void;
+    renderHeaderActions(): void;
+    loadHeaderActionIcon($el: JQuery, iconUrl: string): void;
+    setHeaderActionSelected(actionId: string, selected: boolean): void;
+    isHeaderActionSelected(actionId: string): boolean;
+    syncHeaderActionSelectedUi(actionId: string): void;
+    toggleHeaderAction(actionId: string): void;
+    onHeaderActionsClick(event: Event): void;
     applyAccessibilityLabels(): void;
-    applyAccessibilityRouteSwitch(translation?: Translation): void;
+    applyHeaderActionAccessibilityLabels(): void;
     dismissPoiDetails(): void;
-    updateAccessibilityRouteLabel(): void;
     populate(dict: PoiDetailsDict | undefined): boolean;
+    resetScrollPositions(): void;
     populatePoiName(name: string | undefined): void;
-    populateRating(rating: any, numberOfRatings: any, ratingMax: any): void;
+    populateHighlightProperties({ rating, numberOfRatings, ratingMax, priceRange, isWheelchairAccessible, crowdLevel, waitTime, dietaryOptions, occupancyStatus, accessRestrictions, highlightPropertyKeys, }?: {
+        rating?: any;
+        numberOfRatings?: any;
+        ratingMax?: any;
+        priceRange?: any;
+        isWheelchairAccessible?: boolean | undefined;
+        crowdLevel?: string | undefined;
+        waitTime?: number | undefined;
+        dietaryOptions?: string[] | undefined;
+        occupancyStatus?: string | undefined;
+        accessRestrictions?: string[] | undefined;
+        highlightPropertyKeys?: string[] | undefined;
+    }): void;
+    setHighlightRowHidden(isHidden: boolean): void;
+    populateRating(rating: any, numberOfRatings: any, ratingMax: any): boolean;
     isValidRating(rating: any): boolean;
     getLocalizedRatingValues(rating: any, ratingMax: any, numberOfRatings: any): {
         ratingLocale: any;
@@ -1780,7 +1890,29 @@ declare class PoiDetailsView extends BaseView {
     appendRatingMax(ratingEl: any, ratingMaxLocale: any, rating: any, ratingMax: any): void;
     appendNumberOfRatings(ratingTextBoxEl: any, numberOfRatings: any, numberOfRatingsLocale: any): void;
     simplifyNumberOfRatings(numberOfRatings: any): any;
-    populatePriceInfo(priceRange: any): void;
+    populatePriceInfo(priceRange: any): boolean;
+    populateWheelchairAccessibility(isWheelchairAccessible?: boolean): boolean;
+    populateCrowdLevelAndWaitTime(crowdLevel?: string, waitTime?: number): boolean;
+    populateDietaryOptionsHighlight(dietaryOptions?: string[]): boolean;
+    populateOccupancyStatusHighlight(occupancyStatus?: string): boolean;
+    populateAccessRestrictionsHighlight(accessRestrictions?: string[]): boolean;
+    appendIconLabelHighlightItem({ itemClass, iconUrl, label, color, colorIcon, }: {
+        itemClass: string;
+        iconUrl: string;
+        label: string;
+        color?: string;
+        colorIcon?: boolean;
+    }): void;
+    fitHighlightLabels(): void;
+    scheduleHighlightLabelFit(): void;
+    setupHighlightRowResizeObserver(): void;
+    disconnectHighlightRowResizeObserver(): void;
+    populatePoiProperties(groups: PoiPropertyGroup[] | undefined): boolean;
+    releaseAnchoredPropertyNodes(): void;
+    createPropertyGroupEl(key: string, title: string, showTitle: boolean, segment?: string): JQuery;
+    appendAnchoredPropertyGroup(key: string, title: string, showTitle: boolean, segment?: string): boolean;
+    getAnchorSelector(key: string): string | undefined;
+    createPropertyPillEl(pill: PoiPropertyPill, propertyKey?: string): JQuery;
     populateWorkingHourInfo(openHours: any): boolean;
     getStatus(currentDate: any): string;
     setRegionalTimeFormat(): void;
@@ -1808,6 +1940,7 @@ declare class PoiDetailsView extends BaseView {
     resetFullscreenViewer(): void;
     setFullScreenViewerUI(shouldShow: any): void;
     populateTags(tags: any): boolean;
+    populateShortDescription(shortDescription: string | undefined): boolean;
     populateDescription(description: any): boolean;
     isDescriptionOverflowing(): boolean;
     updateReadMoreButtonVisibility(): void;
@@ -1818,9 +1951,6 @@ declare class PoiDetailsView extends BaseView {
     show(): void;
     hide(): boolean;
     onRouteClicked(): void;
-    onAccessibilityClicked(): void;
-    setAccessibilityButtonStatus(status: any): void;
-    handleAccessibilityStatus(isAnimationActive: any): void;
     isFsLightboxCloseTarget(target: EventTarget | null): boolean;
     isFsLightboxChromeTarget(target: EventTarget | null): boolean;
     setPoiDetailsInteractionBlocked(blocked: boolean): void;
@@ -1829,6 +1959,7 @@ declare class PoiDetailsView extends BaseView {
     wireFullscreenViewerCloseButton(): void;
     setupSplideCarouselAccessibility(): void;
     clearContent(): void;
+    shouldShowButtonsContainer(): boolean;
     formatTime(date: any): any;
     setCanExpand(): void;
     resetTouchDragState(): void;
@@ -1845,8 +1976,16 @@ declare class PoiDetailsViewController extends BaseViewController {
     populate(poi: any): boolean;
     setTranslation(translation: Translation): void;
     getCurrentPoi(): any;
+    getHeaderActionSiteId(poi?: any): string;
+    getHeaderActionPoiFid(poi?: any): string;
+    restoreHeaderActionSelections(): void;
+    PoiDetailsView_onHeaderActionClicked: (payload?: {
+        id?: string;
+        selected?: boolean;
+    }) => void;
     PoiDetailsView_onCloseClicked: () => void;
-    setAccessibilityButtonStatus(isAccessible: boolean): void;
+    PoiDetailsView_onShareClicked: () => void;
+    shareCurrentPoi(): Promise<void>;
 }
 
 interface LoadingErrorLike {
@@ -2057,6 +2196,55 @@ declare class ZoomSelectorViewController extends BaseViewController {
     handleZoomOut(zoom: number): void;
 }
 
+interface AccessibilityToggleStatusOption {
+    shouldEnable: boolean;
+}
+declare class AccessibilityToggleView extends BaseView {
+    events: BaseView["events"] & {
+        accessibilityButtonClicked: string;
+    };
+    options: Options;
+    toggleViewId: string;
+    toggleButtonId: string;
+    iconId: string;
+    titleClass: string;
+    statusClass: string;
+    labelsClass: string;
+    targetEl: string;
+    rootEl: string;
+    toggleButtonEl: string;
+    iconEl: string;
+    isNavigationAccessible: boolean;
+    collapseTimeout: ReturnType<typeof setTimeout> | null;
+    enabled: boolean;
+    constructor(options?: Options, translation?: Translation);
+    createUi(): void;
+    applyAccessibilityLabels(): void;
+    updateAriaLabel(): void;
+    onToggleClicked(): void;
+    setAccessibilityButtonStatus(status: boolean): void;
+    updateVisualState(_animate: boolean): void;
+    show(): void;
+    hide(): boolean;
+    expand(): void;
+    scheduleCollapse(): void;
+    clearCollapseTimeout(): void;
+    setStatus(options: AccessibilityToggleStatusOption): void;
+    populate(): boolean;
+}
+
+declare class AccessibilityToggleViewController extends BaseViewController {
+    options: Options;
+    view: AccessibilityToggleView;
+    enabled: boolean | undefined;
+    constructor(options?: Options, translation?: Translation);
+    populate(): boolean;
+    setAccessibilityButtonStatus(isAccessible: boolean): void;
+    setStatus(options: AccessibilityToggleStatusOption): void;
+    showView(): void;
+    hideView(): void;
+}
+
 interface NavigationSearchResult {
     identifier: string;
     name: (lang: Language | undefined) => string;
@@ -2378,6 +2566,7 @@ declare class NavigationViewController extends BaseViewController {
 interface PoiCardSearchResult {
     name?: string;
     description?: string;
+    shortDescription?: string;
     iconUrl?: string;
     tags?: string[] | string;
     levelLongTitle?: string;
@@ -2395,9 +2584,9 @@ declare class PoiCardsView extends BaseView {
         poiSelected: string;
         resultsPopulated: string;
         routeButtonClicked: string;
-        accessibilityButtonClicked: string;
         goBackButtonClicked: string;
         poiViewed: string;
+        removeActionClicked: string;
     };
     poiCardsViewId: string;
     listHeaderContainerId: string;
@@ -2421,10 +2610,10 @@ declare class PoiCardsView extends BaseView {
     poisOfCategory: PoiCardSearchResult[];
     activeCardIndex: number;
     isAnyPoiCardButtonClicked: boolean;
-    isNavigationAccessible: boolean;
     textColor: string | null;
     isRTL?: boolean;
     uiEl: string;
+    removeActionId: "favorite" | "bookmark" | undefined;
     constructor(options?: Options, poiManager?: PoiManager, analyticsManager?: AnalyticsManager, translation?: Translation);
     createUi(): void;
     applyAccessibilityLabels(): void;
@@ -2436,12 +2625,11 @@ declare class PoiCardsView extends BaseView {
     prepareBottomDrawerForPoiCardsView(): void;
     show(): void;
     populateResults(searchResults?: PoiCardSearchResult[]): void;
+    createEmptyState(): any;
     createListItem(index: number, searchResults: PoiCardSearchResult[]): any;
     createFeaturedBadge(): any;
     createListItemContent(container: any, searchResult: PoiCardSearchResult, index: number): any;
     onRouteClicked(poiId?: string | number): void;
-    onAccessibilityButtonClicked(): void;
-    updateAccessibilityRouteLabels(): void;
     showResults(title?: string, icon?: string): void;
     hide(): boolean;
     clear(): void;
@@ -2450,8 +2638,6 @@ declare class PoiCardsView extends BaseView {
     clearSelectedPoi(): void;
     setSelectedPoi(poi: any): void;
     setHeader(headerText?: string, _icon?: string): void;
-    setAccessibilityButtonStatus(status: boolean): void;
-    handleAccessibilityStatus(isAnimationActive: boolean): void;
     setTranslation(translation: Translation): void;
 }
 
@@ -2467,10 +2653,10 @@ declare class PoiCardsViewController extends BaseViewController {
     selectedPoi: Poi | undefined;
     enabled: boolean;
     poisOfCategory: Poi[] | undefined;
-    isNavigationAccessible: boolean;
+    removeActionId: "favorite" | "bookmark" | undefined;
     constructor(options?: Options, poiManager?: PoiManager, analyticsManager?: AnalyticsManager, translation?: Translation);
     populate(): boolean;
-    displayPoisOfCategory(pois: any[], categoryName?: string, categoryIcon?: string): void;
+    displayPoisOfCategory(pois: any[], categoryName?: string, categoryIcon?: string, removeActionId?: "favorite" | "bookmark"): void;
     hideView(): void;
     showView(): void;
     clearSelectedPoi(): void;
@@ -2483,8 +2669,6 @@ declare class PoiCardsViewController extends BaseViewController {
     PoiCardsView_onPoiViewed: (poiId: string | number) => void;
     goBack(): void;
     shouldShow(): boolean;
-    PoiCardsView_onAccesssibilityButtonClicked: () => void;
-    setAccessibilityButtonStatus(isAccessible: boolean): void;
     setTranslation(translation: Translation): void;
 }
 
@@ -2679,13 +2863,6 @@ declare class SiteBuildingManager {
     getLevelWithLevelIndexFromBuilding(buildingInternalIdentifier?: string, levelIndex?: number): Level | undefined;
 }
 
-interface CategoryItem {
-    title: string;
-    iconUrl: string;
-    match?: JsonObject[];
-    [key: string]: JsonValue;
-}
-
 declare class UiController {
     options: Options;
     translation: Translation;
@@ -2702,6 +2879,7 @@ declare class UiController {
     watermarkViewController: WatermarkViewController;
     languageSelectorViewController: LanguageSelectorViewController;
     zoomSelectorViewController: ZoomSelectorViewController;
+    accessibilityToggleViewController: AccessibilityToggleViewController;
     navigationViewController: NavigationViewController;
     bannerViewController: BannerViewController;
     welcomeViewController: WelcomeViewController;
@@ -2725,6 +2903,7 @@ declare class UiController {
     getPoiCardsViewController(): PoiCardsViewController;
     getCategoryListViewController(): CategoryListViewController;
     getLanguageSelectorViewController(): LanguageSelectorViewController;
+    getAccessibilityToggleViewController(): AccessibilityToggleViewController;
     getLevelSelectorViewController(): LevelSelectorViewController;
     getPoiDetailsViewController(): PoiDetailsViewController;
     getLoadingViewController(): LoadingViewController;
@@ -2740,6 +2919,7 @@ declare class UiController {
     registerLevelSelectorViewEvents(): void;
     registerZoomSelectorViewEvents(): void;
     registerLanguageSelectorViewEvents(): void;
+    registerAccessibilityToggleViewEvents(): void;
     registerSearchViewEvents(): void;
     registerPoiCardsViewEvents(): void;
     registerPoiDetailsEvents(): void;
@@ -2795,7 +2975,7 @@ declare class UiController {
     MapView_onExitClicked: () => void;
     MapView_onInfoClicked: () => void;
     MapView_onDraggedUpwards: () => void;
-    postPoiDetailsExpandedAnalytics(): void;
+    postPoiDetailsExpandedAnalytics(didSheetSizeChange?: boolean): void;
     LevelSelectorView_onLevelSelected: () => void;
     ZoomSelectorView_onZoomIn: () => void;
     ZoomSelectorView_onZoomOut: () => void;
@@ -2803,8 +2983,9 @@ declare class UiController {
     PoiDetailsView_onViewHidden: () => void;
     PoiDetailsView_onCloseClicked: () => void;
     PoiDetailsView_onRouteButtonClicked: () => void;
-    PoiDetailsView_onAccessibilityButtonClicked: (status: boolean) => void;
+    AccessibilityToggleView_onAccessibilityButtonClicked: (status: boolean) => void;
     PoiDetailsView_onExpanded: () => void;
+    PoiDetailsView_onSheetSizeChanged: () => void;
     PoiDetailsView_onMinimized: () => void;
     NavigationView_onViewShown: () => void;
     NavigationView_onViewHidden: () => void;
@@ -2841,13 +3022,21 @@ declare class UiController {
     WelcomeView_onCloseClicked: () => void;
     InfoView_onViewHidden: () => void;
     highlightCategory: (categoryItem: CategoryItem) => Promise<void>;
+    shouldDeferSyntheticPoiCardsRefresh(): boolean;
+    PoiDetailsView_onHeaderActionClicked: () => Promise<void>;
+    refreshOpenSyntheticPoiCardsFromStorage(): void;
+    syncMapAfterSyntheticPoiCardsListUpdate(remainingPois: Poi[]): void;
+    refreshCategoryListWithSyntheticCategories(): Promise<void>;
     PoiCardsView_onViewShown: () => void;
     PoiCardsView_onViewHidden: () => void;
     PoiCardsView_onGoBackButtonClicked: () => void;
     PoiCardsView_onPoiSelected: () => void;
     PoiCardsView_onRouteButtonClicked: () => void;
     PoiCardsView_onPoiViewed: () => void;
-    PoiCardsView_onAccessibilityButtonClicked: (status: boolean) => void;
+    PoiCardsView_onRemoveActionClicked: (payload: {
+        fid?: string | number;
+        actionId?: string;
+    }) => Promise<void>;
     showLoadingView(): void;
     showSplashScreen(): void;
     hideLoadingView(): void;