@swisspost/internet-header 1.17.1 → 10.2.0

package/dist/types/components/post-internet-breadcrumbs/post-internet-breadcrumbs.d.ts

@@ -1,57 +0,0 @@
-import { IBreadcrumbItem, IBreadcrumbOverlay } from '../../models/breadcrumbs.model';
-export declare class PostInternetBreadcrumbs {
-    /**
-     * Add custom breadcrumb items to the end of the pre-configured list. Handy if your online service has its own navigation structure.
-     */
-    customItems?: string | IBreadcrumbItem[];
-    /**
-     * Hide all buttons.
-     */
-    hideButtons: boolean;
-    customBreadcrumbItems?: IBreadcrumbItem[];
-    overlayVisible: boolean;
-    isConcatenated: boolean;
-    dropdownOpen: boolean;
-    refsReady: boolean;
-    host: HTMLSwisspostInternetBreadcrumbsElement;
-    /**
-     * Toggle an overlay associated with a button.
-     * @param {IBreadcrumbOverlay['id']} overlayId
-     */
-    toggleOverlayById(overlayId: IBreadcrumbOverlay['id']): Promise<void>;
-    private controlNavRef?;
-    private visibleNavRef?;
-    private currentOverlay;
-    private debouncedResize;
-    private lastWindowWidth;
-    private openAnimation;
-    private loadedAnimation;
-    connectedCallback(): void;
-    disconnectedCallback(): void;
-    componentWillLoad(): Promise<void>;
-    componentDidLoad(): void;
-    handleCustomConfigChange(newValue: string | IBreadcrumbItem[]): void;
-    private handleResize;
-    private checkConcatenation;
-    private toggleOverlay;
-    /**
-     * Disable or re-enable body scrolling, depending on whether overlay is visible or not
-     */
-    private setBodyScroll;
-    private toggleDropdown;
-    private handleWindowClick;
-    private registerIFrameResizer;
-    /**
-     * Reference function for the overlay element got called. It is either null (overlay closed)
-     * or contains the overlay element as parameter.
-     * @param e Overlay element or null
-     * @returns void
-     */
-    private overlayRef;
-    private handleKeyDown;
-    private handleToggleDropdown;
-    private handleToggleOverlay;
-    private handleControlNavRef;
-    private handleVisibleNavRef;
-    render(): any;
-}

package/dist/types/components/post-internet-footer/components/post-footer-block-address.component.d.ts

@@ -1,5 +0,0 @@
-import { BlockEntity } from '../../../models/footer.model';
-export declare const PostFooterBlockAddress: (props: {
-    block: BlockEntity;
-    key: string;
-}) => any;

package/dist/types/components/post-internet-footer/components/post-footer-block-contact.component.d.ts

@@ -1,6 +0,0 @@
-import { BlockEntity } from '../../../models/footer.model';
-export declare const PostFooterBlockContact: (props: {
-    block: BlockEntity;
-    liveSupportEnabled: boolean;
-    key: string;
-}) => any;

package/dist/types/components/post-internet-footer/components/post-footer-block-custom.component.d.ts

@@ -1,4 +0,0 @@
-import { CustomBlockEntity } from '../../../models/footer.model';
-export declare const PostFooterBlockCustom: (props: {
-    block: CustomBlockEntity;
-}) => any;

package/dist/types/components/post-internet-footer/components/post-footer-block-list.component.d.ts

@@ -1,5 +0,0 @@
-import { CustomBlockEntity } from '../../../models/footer.model';
-export declare const PostFooterBlockList: (props: {
-    block: CustomBlockEntity;
-    key: string;
-}) => any;

package/dist/types/components/post-internet-footer/components/post-footer-block-socials.component.d.ts

@@ -1,5 +0,0 @@
-import { ContentEntity } from '../../../models/footer.model';
-export declare const PostFooterBlockSocials: (props: {
-    content: ContentEntity;
-    key: string;
-}) => any;

package/dist/types/components/post-internet-header/logo-animation/logo-animation.d.ts

@@ -1 +0,0 @@
-export declare const registerLogoAnimationObserver: (target: HTMLElement, headerRef: HTMLSwisspostInternetHeaderElement) => () => void;

package/dist/types/components/post-internet-header/logo-animation/logo-scale.d.ts

@@ -1,4 +0,0 @@
-/**
- * Returns intersection ratio
- */
-export declare const getLogoScale: (headerRef: HTMLSwisspostInternetHeaderElement, metaHeaderRef?: HTMLElement) => string;

package/dist/types/components/post-klp-login-widget/klp-widget.controller.d.ts

@@ -1,3 +0,0 @@
-import '../../assets/js/klp-login-widget.js';
-import { ILoginWidgetOptions } from '../../models/header.model.js';
-export declare const initializeKLPLoginWidget: (containerId: string, options: ILoginWidgetOptions) => void;

package/dist/types/components/post-klp-login-widget/post-klp-login-widget.d.ts

@@ -1,21 +0,0 @@
-import { IsFocusable } from '../../models/header.model';
-export declare class PostKlpLoginWidget implements IsFocusable {
-    host: HTMLPostKlpLoginWidgetElement;
-    /**
-     * Overrides the logout-url provided by the portal config.
-     */
-    logoutUrl?: string;
-    /**
-     * Overrides the self-admin origin for menu links.
-     */
-    selfAdminOrigin?: string;
-    componentDidLoad(): Promise<void>;
-    private setupTracking;
-    private handleClick;
-    disconnectedCallback(): void;
-    /**
-     * Sets the focus on the login button
-     */
-    setFocus(): Promise<void>;
-    render(): any;
-}

package/dist/types/components/post-language-switch/components/post-language-switch-list.d.ts

@@ -1,6 +0,0 @@
-import { NavLangEntity } from '../../../models/header.model';
-export declare const PostLanguageSwitchList: (props: {
-    navLang: NavLangEntity[];
-    switchLanguage: (lang: NavLangEntity) => void;
-    dropdownRef: (element: HTMLElement | undefined) => void;
-}) => any;

package/dist/types/components/post-language-switch/post-language-switch.d.ts

@@ -1,37 +0,0 @@
-import { EventEmitter } from '../../stencil-public-runtime';
-import { DropdownEvent, HasDropdown } from '../../models/header.model';
-export declare class PostLanguageSwitch implements HasDropdown {
-    /**
-     * Visualization of the language switch.
-     * Possible values: 'dropdown' | 'list'
-     */
-    mode: 'dropdown' | 'list';
-    langSwitchOpen: boolean;
-    host: HTMLPostLanguageSwitchElement;
-    /**
-     * Fires when the dropdown has been toggled.
-     */
-    dropdownToggled: EventEmitter<DropdownEvent>;
-    /**
-     * Fires when the language has been changed.
-     */
-    languageChanged: EventEmitter<string>;
-    private languageSwitchDropdown;
-    componentWillUpdate(): Promise<boolean> | undefined;
-    componentDidUpdate(): void;
-    /**
-     * Open or close the language switch programatically
-     * @param force Boolean to force a state
-     * @returns Boolean indicating new state
-     */
-    toggleDropdown(force?: boolean): Promise<boolean>;
-    /**
-     * Emit a language change to the parent component
-     *
-     * @param newLang Config of the new language
-     */
-    private switchLanguage;
-    private getMergedLanguageConfig;
-    private setDropdownRef;
-    render(): any;
-}

package/dist/types/components/post-logo/post-logo.d.ts

@@ -1,4 +0,0 @@
-export declare class PostLogo {
-    host: HTMLPostHeaderLogoElement;
-    render(): any;
-}

package/dist/types/components/post-main-navigation/components/level-one-action.component.d.ts

@@ -1,8 +0,0 @@
-import { NavMainEntity } from '../../../models/header.model';
-export declare const LevelOneAction: (props: {
-    level: NavMainEntity;
-    isOpen: boolean;
-    onTouchEnd: (e: any) => void;
-    onKeyDown: (e: any) => void;
-    onClick: (e: any) => void;
-}) => any;

package/dist/types/components/post-main-navigation/post-main-navigation.d.ts

@@ -1,48 +0,0 @@
-import { EventEmitter } from '../../stencil-public-runtime';
-import { DropdownEvent, HasDropdown, IsFocusable } from '../../models/header.model';
-export declare class PostMainNavigation implements HasDropdown, IsFocusable {
-    activeFlyout: string | null;
-    mobileMenuOpen: boolean;
-    /**
-     * Fires when the dropdown has been toggled.
-     */
-    dropdownToggled: EventEmitter<DropdownEvent>;
-    /**
-     * Fires when the flyout has been toggled.
-     */
-    flyoutToggled: EventEmitter<string | null>;
-    host: HTMLPostMainNavigationElement;
-    private throttledResize;
-    private resizeTimer;
-    private mouseLeaveTimer;
-    private mouseEnterTimer;
-    connectedCallback(): void;
-    disconnectedCallback(): void;
-    private handleResize;
-    private setWindowHeight;
-    private openFlyout;
-    private closeFlyout;
-    private addFlyoutAnimation;
-    private isActiveFlyout;
-    private handleMouseEnter;
-    private handleMouseLeave;
-    private handleTouchEnd;
-    private handleKeyPress;
-    private handleClick;
-    /**
-     * Toggle the main navigation (only visible on mobile)
-     * @param force Force a state
-     * @returns Boolean indicating new state
-     */
-    toggleDropdown(force?: boolean): Promise<boolean>;
-    /**
-     * Focus the main navigation toggle button
-     */
-    setFocus(): Promise<void>;
-    /**
-     * Open a specific flyout
-     * @param id Flyout ID
-     */
-    setActiveFlyout(id: string | null): Promise<void>;
-    render(): any;
-}

package/dist/types/components/post-meta-navigation/post-meta-navigation.d.ts

@@ -1,12 +0,0 @@
-export declare class PostMetaNavigation {
-    /**
-     * Displays the meta-navigation horihontally or vertically.
-     * Allowed values: 'horizontal' | 'vertical'
-     */
-    orientation: 'horizontal' | 'vertical';
-    /**
-     * Displays the meta-navigation in full-width.
-     */
-    fullWidth?: boolean;
-    render(): any;
-}

package/dist/types/components/post-search/post-search.d.ts

@@ -1,79 +0,0 @@
-import { EventEmitter } from '../../stencil-public-runtime';
-import { CoveoCompletion } from '../../models/coveo.model';
-import { GeocodeLocation } from '../../models/geocode.model';
-import { DropdownEvent, HasDropdown, IsFocusable } from '../../models/header.model';
-import { TrackAndTraceInfo } from '../../models/track-and-trace.model';
-export declare class PostSearch implements HasDropdown, IsFocusable {
-    searchDropdownOpen: boolean;
-    coveoSuggestions: CoveoCompletion[];
-    placeSuggestions: GeocodeLocation[];
-    parcelSuggestion: (TrackAndTraceInfo & {
-        url: string;
-    }) | null;
-    /**
-     * Fires when the dropdown has been toggled.
-     */
-    dropdownToggled: EventEmitter<DropdownEvent>;
-    host: HTMLPostSearchElement;
-    private searchBox?;
-    private searchFlyout;
-    private throttledResize;
-    private clearButton?;
-    connectedCallback(): void;
-    disconnectedCallback(): void;
-    componentWillUpdate(): Promise<boolean> | undefined;
-    componentDidUpdate(): void;
-    /**
-     * Toggle the dropdown and optionally force an open/closed state
-     * @param force Boolean to force open/closed state
-     * @returns Boolean indicating open state of the component
-     */
-    toggleDropdown(force?: boolean | Event): Promise<boolean>;
-    /**
-     * Sets the focus on the search button
-     */
-    setFocus(): Promise<void>;
-    private handleResize;
-    /**
-     * Disable or re-enable body scrolling, depending on whether search dropdown is open or closed in mobile view (width < 1024px)
-     */
-    private setBodyScroll;
-    /**
-     * Fetch suggestions from all available sources
-     */
-    private handleSearchInput;
-    /**
-     * clear Search box
-     * calls handleSearchInput to update/remove suggestions
-     */
-    private handleClearSearchBox;
-    /**
-     * Start search on enter
-     * @param event
-     */
-    private handleKeyDown;
-    /**
-     * Set selected suggestion on mouse enter
-     * @param event
-     */
-    private handleMouseEnterSuggestion;
-    /**
-     * Set selected suggestion on mouse enter
-     * @param event
-     */
-    private handleMouseLeaveSuggestions;
-    /**
-     * Deselect any previously selected suggestion
-     */
-    private deselectSuggestion;
-    /**
-     * Update search box with selected suggestion
-     */
-    private updateSearchBoxWithSuggestion;
-    /**
-     * Redirect to the post search page
-     */
-    private startSearch;
-    private trackRecommendationClick;
-    render(): any;
-}

package/dist/types/components/post-skiplinks/post-skiplinks.d.ts

@@ -1,9 +0,0 @@
-export declare class PostSkiplinks {
-    host: HTMLPostSkiplinksElement;
-    private getMainId;
-    private setFocus;
-    private focusMain;
-    private focusSearch;
-    private focusLogin;
-    render(): any;
-}

package/dist/types/components/shared/focus-trap.d.ts

@@ -1,17 +0,0 @@
-import * as focusTrap from 'focus-trap';
-/**
- * Trap the focus inside a specific container.
- *
- * @param active  activate or deactivate the focus trap
- */
-export declare class FocusTrap {
-    active: boolean;
-    host: HTMLElement;
-    trap: undefined | focusTrap.FocusTrap;
-    handleActiveChange(active: boolean): void;
-    connectedCallback(): void;
-    componentDidLoad(): void;
-    disconnectedCallback(): void;
-    private toggleTrap;
-    render(): any;
-}

package/dist/types/models/breadcrumbs.model.d.ts

@@ -1,36 +0,0 @@
-import { IIconConfig } from './header.model';
-export interface IBreadcrumbConfig {
-    a11yLabel: string;
-    asWebComponent: boolean;
-    buttons: IBreadcrumbButton[];
-    isCentered: boolean;
-    items: IBreadcrumbItem[];
-    svgIconArrowRightSmall: IIconConfig;
-    svgIconHome: IIconConfig;
-    truncateButtonText: string;
-    classes: any[];
-    additionalAttributes: any[];
-}
-export interface IBreadcrumbButton {
-    svgIcon: IIconConfig;
-    text: string;
-    overlay: IBreadcrumbOverlay;
-    classes: string[];
-    additionalAttributes: any[];
-}
-export interface IBreadcrumbOverlay {
-    id: string;
-    target: string;
-    closeText: string;
-    closeIcon: IIconConfig;
-    classes: string[];
-    additionalAttributes: any[];
-}
-export interface AdditionalAttribute {
-    name: string;
-    value: string;
-}
-export interface IBreadcrumbItem {
-    text: string;
-    url: string;
-}

package/dist/types/models/coveo.model.d.ts

@@ -1,22 +0,0 @@
-import { Environment } from './general.model';
-export interface CoveoResponse {
-    completions: CoveoCompletion[];
-    responseId: string;
-}
-export interface CoveoCompletion {
-    expression: string;
-    score: number;
-    highlighted: string;
-    executableConfidence: number;
-    objectId: string;
-    redirectUrl?: string;
-}
-export interface CoveoOptions {
-    url: string;
-    environment: {
-        [key in Environment]: {
-            organisation: string;
-            token: string;
-        };
-    };
-}

package/dist/types/models/geocode.model.d.ts

@@ -1,53 +0,0 @@
-export interface GeocodeResponse {
-    ok: boolean;
-    info: string;
-    time: string;
-    note: string;
-    count: number;
-    locations: GeocodeLocation[];
-}
-export interface GeocodeLocation {
-    id?: string;
-    name: string;
-    type: string;
-    subtype?: string;
-    pt: [number, number];
-    bbox: [number, number, number, number];
-}
-export declare const GeocodeResponseType: {
-    readonly Region: "region";
-    readonly City: "city";
-    readonly Zip: "zip";
-    readonly Locality: "locality";
-    readonly Address: "address";
-    readonly Poi: "poi";
-};
-export type GeocodeResponseType = (typeof GeocodeResponseType)[keyof typeof GeocodeResponseType];
-export interface ServiceTypesResponse {
-    ok: boolean;
-    info: string;
-    time: string;
-    opentmin: string;
-    opentmax: string;
-    flags: {
-        [key: string]: string;
-    };
-    count: number;
-    types: ServiceType[];
-}
-export interface ServiceType {
-    tag: string;
-    count: number;
-    cat: string;
-    id: string;
-    desc: string;
-    rectype?: string;
-    group?: string;
-    groupSortKey?: number;
-    itemSortKey?: number;
-    list?: boolean;
-    priv?: boolean;
-    biz?: boolean;
-    url?: string;
-    urlMobile?: string;
-}

package/dist/types/models/implementor.model.d.ts

@@ -1,22 +0,0 @@
-export type StickynessOptions = 'none' | 'minimal' | 'main' | 'full';
-/**
- * Settings any implementor of the internet header can set on the component
- * itself. Has to be a valid JSON string.
- *
- * HTML example (note the quotes):
- * ```html
- * <post-internet-header config='{ "serviceId": "test" }'></post-internet-header>
- * ```
- * or via JavaScript:
- * ```js
- * const header = document.querySelector('post-internet-header');
- * header.config = { serviceId: 'test' };
- * ```
- */
-export interface IImplementorConfig {
-    serviceId: string;
-    stickyness?: StickynessOptions;
-    preferredLanguage?: string;
-    languageCookieName?: string;
-    languageStorageKey?: string;
-}

package/dist/types/models/language.model.d.ts

@@ -1,6 +0,0 @@
-export interface IAvailableLanguage {
-    lang: string;
-    text?: string;
-    title?: string;
-    url?: string;
-}

package/dist/types/models/track-and-trace.model.d.ts

@@ -1,25 +0,0 @@
-export interface TrackAndTraceInfo {
-    ok: boolean | string;
-    timestamp: string;
-    sending?: {
-        'id': string;
-        'product': string;
-        'state': string;
-        'state-id': number;
-        'recipient': {
-            zipcode: string;
-            city: string;
-        };
-    };
-    events?: [
-        {
-            date: string;
-            time: string;
-            number: string;
-            description: string;
-            zip: string;
-            city: string;
-            coords: [number, number];
-        }
-    ];
-}

package/dist/types/services/search/coveo.service.d.ts

@@ -1,9 +0,0 @@
-import { CoveoCompletion } from '../../models/coveo.model';
-/**
- * Get suggestions from coveo
- * https://docs.coveo.com/en/1459/build-a-search-ui/get-query-suggestions#context-object
- *
- * @param query Search term
- * @returns
- */
-export declare const getCoveoSuggestions: (query: string) => Promise<CoveoCompletion[]>;

package/dist/types/services/search/coveo.settings.d.ts

@@ -1,2 +0,0 @@
-import { CoveoOptions } from '../../models/coveo.model';
-export declare const coveo: CoveoOptions;

package/dist/types/services/search/parcel.service.d.ts

@@ -1,28 +0,0 @@
-import { ISearchConfig } from '../../models/header.model';
-import { TrackAndTraceInfo } from '../../models/track-and-trace.model';
-export declare const getTrackAndTraceApiUrl: (id: string) => string;
-export declare const getTrackAndTraceRedirectUrl: (query: string, { packageTrackingRedirectUrl }: ISearchConfig) => string;
-/**
- * Check whether a query is a tracking id
- *
- * @param query User query
- * @returns Boolean
- */
-export declare const isParcel: (query: string, searchConfig: ISearchConfig) => Promise<boolean>;
-/**
- * Try to get parcel info from a query that is possibly a tracking id.
- * This is mainly used to check if a search should redirect to track&trace instead of the regular search.
- *
- * @param query User query that is possibly a tracking number
- * @returns Track and trace info
- */
-export declare const getParcelInfo: (query: string, { redirectPattern }: ISearchConfig) => Promise<TrackAndTraceInfo>;
-/**
- * Get parcel info if query is a parcel or null
- *
- * @param query Parcel id
- * @returns Parcel info and a redirect url or null if not a parcel
- */
-export declare const getParcelSuggestion: (query: string, searchConfig: ISearchConfig) => Promise<(TrackAndTraceInfo & {
-    url: string;
-}) | null>;

package/dist/types/services/search/places.service.d.ts

@@ -1,24 +0,0 @@
-import { GeocodeLocation } from '../../models/geocode.model';
-/**
- * Query the Gis API for locations and localities (pois)
- *
- * @param query User input string
- * @returns
- */
-export declare const queryPlaces: (query: string) => Promise<GeocodeLocation[]>;
-/**
- * Try to highlight place suggestions
- * Limitation: accented chars are not handled by this basic function
- *
- * @param query Search term
- * @param place Name of the suggested place
- * @returns
- */
-export declare const highlightPlacesString: (query: string | undefined, place: string) => string;
-/**
- * Get the deeplink to any location found via geocoder
- *
- * @param location A location from the Gis API Geocode endpoint
- * @returns
- */
-export declare const getPlacesUrl: (location: GeocodeLocation) => string;

package/dist/types/services/search/places.settings.d.ts

@@ -1,3 +0,0 @@
-export declare const gisAPIUrl = "https://places.post.ch/StandortSuche/StaoCacheServiceV2/api/v1";
-export declare const placesUrl = "https://places.post.ch";
-export declare const pois: string[];

package/dist/types/services/search/search-utilities.d.ts

@@ -1,9 +0,0 @@
-/**
- * Transform to lowercase, extract accents to separate unicode chars,
- * replace all accent unicode chars so only standard latin chars remain
- * https://stackoverflow.com/questions/990904/remove-accents-diacritics-in-a-string-in-javascript/37511463#37511463
- *
- * @param str Input string
- * @returns
- */
-export declare const hardNormalize: (str: string) => string;

package/dist/types/services/search/search.service.d.ts

@@ -1,24 +0,0 @@
-import { ISearchConfig } from '../../models/header.model';
-/**
- * Construct a search page url from a query
- *
- * @param query Search term
- * @returns
- */
-export declare const getSearchRedirectUrl: (query: string, searchConfig: ISearchConfig) => Promise<string | undefined>;
-/**
- * Stitch toghether the search page URL
- *
- * @param query Search term
- * @returns Search page URL
- */
-export declare const getSearchPageUrl: (query: string) => string | undefined;
-/**
- * Equalize the length of two arrays while filling up empty slots up to max. length
- *
- * @param arrayA First array
- * @param arrayB Second array
- * @param maxLength Max. length of result array
- * @returns Array with two resulting arrays
- */
-export declare const equalizeArrays: <A, B>(arrayA: A[], arrayB: B[], maxLength?: number) => [A[], B[]];

package/dist/types/services/ui.service.d.ts

@@ -1,23 +0,0 @@
-/**
- * Check if an element with `text-overflow: ellipsis;` is fully displayed or concatenated
- * https://stackoverflow.com/questions/7738117/html-text-overflow-ellipsis-detection
- *
- * @param element Element to check. This is the element with the `text-overflow: ellipsis;` style
- * @returns
- */
-export declare const isConcatenated: (element: HTMLElement) => boolean;
-/**
- * Check if user preferes reduced motion
- * Windows 10: `Windows Settings` > `Ease of Access` > `Display` > `Simplify and Personalize Windows` > `Show animations in Windows`
- *
- * @returns
- */
-export declare const userPrefersReducedMotion: () => boolean;
-/**
- * Check if an element has a transition applied
- *
- * @param element Element to check. This is the element with the `transition` style
- * @param transition Specific transition to check for (e.g. `translate`)
- * @returns
- */
-export declare const elementHasTransition: (element: HTMLElement, transition: string) => boolean;