@swisspost/internet-header 1.17.1 → 10.2.0

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

@@ -1,48 +1,10 @@
-export interface IFooterConfig {
-    title: string;
-    asWebComponent: boolean;
-    osLinks?: {
-        serviceName: string;
-        links: LinksEntity[];
-    };
-    block: BlockEntity[];
-    entry: {
-        text: string;
-    };
-    links: LinksEntity[];
-    classes: string[];
-    additionalAttributes: string[];
-}
-export interface BlockEntity {
-    columnType: string;
-    title: string;
-    links?: LinksEntity[];
-    content?: ContentEntity[];
-}
-export interface LinksEntity {
-    url: string;
-    target: string;
-    text?: string;
-    title?: string;
-    name?: string;
-    icon?: string;
-    classes: string[];
-    additionalAttributes: unknown[];
-}
-export interface ContentEntity {
-    address: string;
-    describe: string;
-    hours: string;
-    links: LinksEntity[];
-    name: string;
-    number: string;
-    text: string;
-    title: string;
-}
-export interface ICustomFooterConfig {
-    block: CustomBlockEntity;
-}
-export interface CustomBlockEntity {
-    title: string;
-    links?: LinksEntity[];
+import { IconLinkConfig, ImageLinkConfig, LinkListConfig, SimpleLinkConfig } from './shared.model';
+export interface FooterConfig {
+    prefooter?: LinkListConfig<SimpleLinkConfig>;
+    sections?: Array<LinkListConfig<SimpleLinkConfig>>;
+    socialLinks?: LinkListConfig<IconLinkConfig>;
+    appStoreLinks?: LinkListConfig<ImageLinkConfig>;
+    companyLinks?: LinkListConfig<SimpleLinkConfig>;
+    complianceLinks?: LinkListConfig<SimpleLinkConfig>;
+    copyright?: string;
 }

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

@@ -1,55 +1,22 @@
-import { IHeaderConfig, ICustomHeaderConfig, NavMainEntity } from './header.model';
-import { IBreadcrumbConfig } from './breadcrumbs.model';
-import { IFooterConfig, ICustomFooterConfig } from './footer.model';
+import { HeaderConfig } from './header.model';
+import { FooterConfig } from './footer.model';
 declare global {
     interface Window {
-        OPPklpWidget: any;
-        klpWidgetDev: any;
-        jQuery: any;
-        $: any;
-        SockJS: any;
+        OPPklpWidget: unknown;
+        klpWidgetDev: unknown;
+        jQuery: unknown;
+        $: unknown;
+        SockJS: unknown;
     }
 }
-export interface IPortalConfig {
-    de?: ILocalizedConfig;
-    fr?: ILocalizedConfig;
-    it?: ILocalizedConfig;
-    en?: ILocalizedConfig;
+export interface LocalizedConfig {
+    header: HeaderConfig;
+    footer?: FooterConfig;
 }
-export interface ILocalizedConfig {
-    header: IHeaderConfig;
-    breadcrumb: IBreadcrumbConfig;
-    footer?: IFooterConfig;
-}
-export interface ICustomConfig {
-    de?: ILocalizedCustomConfig;
-    fr?: ILocalizedCustomConfig;
-    it?: ILocalizedCustomConfig;
-    en?: ILocalizedCustomConfig;
-}
-export interface ILocalizedCustomConfig {
-    header?: ICustomHeaderConfig;
-    footer?: ICustomFooterConfig;
-}
-export type Environment = 'dev01' | 'dev02' | 'devs1' | 'test' | 'int01' | 'int02' | 'prod';
-export type ActiveRouteProp = 'auto' | 'exact' | false | string;
-export type LocalizedConfigParameters = {
+export interface LocalizedConfigParameters {
     projectId: string;
     environment: Environment;
     language?: string;
-    mapMyPost?: boolean;
-    cookieKey?: string;
-    localStorageKey?: string;
-    activeRouteProp?: ActiveRouteProp;
-    localizedCustomConfig?: ILocalizedCustomConfig;
-    osFlyoutOverrides?: NavMainEntity;
-};
-export interface TagManagerDataLayer {
-    push: (payload: {
-        event: string | undefined;
-        text: string | undefined;
-        link_url: string | undefined;
-        label: string | undefined;
-        type: string | undefined;
-    }) => void;
 }
+export type Environment = 'dev01' | 'dev02' | 'devs1' | 'test' | 'int01' | 'int02' | 'prod';
+export type ActiveRouteProp = 'auto' | 'exact' | 'none' | string;

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

@@ -1,167 +1,66 @@
-import { EventEmitter } from '../stencil-public-runtime';
-import { AdditionalAttribute } from './breadcrumbs.model';
-import { Environment } from './general.model';
-export interface IHeaderConfig {
-    asWebComponent: boolean;
-    isHeaderResponsive: boolean;
-    isLoginWidgetHidden: boolean;
-    showJobsLoginWidget: boolean;
-    icons: {
-        backArrowIcon: IIconConfig;
-        closeIcon: IIconConfig;
-        downArrowIcon: IIconConfig;
-        menuIcon: IIconConfig;
-        rightArrowIcon: IIconConfig;
-        searchIcon: IIconConfig;
-        loginIcon: IIconConfig;
+import { UserConfig } from "./user.model";
+import { AccessibleTextConfig, IconLinkConfig, ImageLinkConfig, LinkListConfig, SimpleLinkConfig } from './shared.model';
+export interface HeaderConfig {
+    /**
+     * Organization-wide header, shared across all apps.
+     */
+    globalHeader: {
+        postLogo: SimpleLinkConfig | ImageLinkConfig;
+        audience?: Array<SimpleLinkConfig>;
+        primaryNavigation?: Array<IconLinkConfig>;
+        secondaryNavigation?: Array<IconLinkConfig>;
+        languages?: Array<LanguageLinkConfig>;
+        postLogin?: PostLoginConfig;
     };
-    loginWidgetOptions?: ILoginWidgetOptions;
-    loginWidgetId: string;
-    logo: ILogoConfig;
-    mobileMenu: {
-        text: string;
+    /**
+     * Application-specific header.
+     *
+     * At least one of `title` or `mainNav` should be present.
+     */
+    localHeader: {
+        title?: string;
+        mainNavigation?: MainNavigationConfig;
+        navigation?: Array<IconLinkConfig | UserMenuConfig>;
     };
-    search: ISearchConfig;
-    onlineServiceId: string;
-    navMain: NavMainEntity[];
-    navMeta?: NavMetaEntity[];
-    navLang: NavLangEntity[];
-    translations: IHeaderTranslations;
 }
-export interface IIconConfig {
-    name: string;
-    classes?: string[];
-    additionalAttributes?: AdditionalAttribute[];
+/**
+ * Configuration for the post-login widget.
+ */
+export interface PostLoginConfig {
+    loginLink: IconLinkConfig;
+    accountSwitch: IconLinkConfig;
+    companySwitch: IconLinkConfig;
+    userProfile?: IconLinkConfig;
+    settings?: IconLinkConfig;
+    userLinks?: Array<IconLinkConfig>;
+    logoutLink: IconLinkConfig;
+}
+/**
+ * Main navigation links and dropdowns displayed in the local header.
+ */
+export type MainNavigationConfig = Array<SimpleLinkConfig | MegadropdownConfig>;
+/**
+ * A navigation item that opens a large dropdown panel
+ * with multiple grouped link sections.
+ */
+export interface MegadropdownConfig {
+    trigger: AccessibleTextConfig;
+    overview?: SimpleLinkConfig;
+    sections: Array<LinkListConfig<SimpleLinkConfig>>;
+}
+/**
+ * Menu displayed when a user is authenticated.
+ */
+export interface UserMenuConfig {
+    user: UserConfig;
+    options: Array<IconLinkConfig>;
+    accountSwitch?: IconLinkConfig;
+    companySwitch?: IconLinkConfig;
+    logoutLink?: IconLinkConfig;
+}
+/**
+ * Language option (for language menu).
+ */
+export interface LanguageLinkConfig extends SimpleLinkConfig {
+    code: string;
 }
-export interface ILoginWidgetOptions {
-    applicationId: string;
-    serviceId: string;
-    appLoginUrl: string;
-    currentLang: string;
-    environment?: Environment;
-    options: {
-        isDebugEnabled: boolean;
-        logoutTargetURL: string;
-    };
-    platform: {
-        endPoint: string;
-        notificationsEndPoint: string;
-        logoutURL: string;
-        keepAliveURL: string;
-        autoLoginURL: string;
-        selfAdminOrigin?: string;
-    };
-}
-export interface ILogoConfig {
-    logoLink: string;
-    logoLinkTitle: string;
-    logoSvg: string;
-    logoText: string;
-}
-export interface ISearchConfig {
-    isSearchHidden: boolean;
-    searchPageUrl: string;
-    redirectPattern: string;
-    searchBoxSuggestionsThreshold: string;
-    searchBoxSuggestionsAllNumber: string;
-    searchBoxSuggestionsCoveoNumber: string;
-    placesRedirectUrl: string;
-    packageTrackingRedirectUrl: string;
-    searchHubName: string;
-    searchPipelineName: string;
-    searchRecommendations: ISearchRecommendationContainer;
-    isCustomSuggestionHidden?: boolean;
-}
-export interface ISearchRecommendationContainer {
-    title: string;
-    links: ISearchRecommendation[];
-}
-export interface ISearchRecommendation {
-    href: string;
-    inlineSvg: string;
-    label: string;
-    target: string;
-    additionalAttributes: Array<{
-        name: string;
-        value: string;
-    }>;
-}
-export interface NavMainEntity {
-    id?: string;
-    text: string;
-    title: string;
-    url: string;
-    isActive?: boolean;
-    isActiveOverride?: boolean;
-    noFlyout?: boolean;
-    flyout?: FlyoutEntity[];
-}
-export interface FlyoutEntity {
-    title: string;
-    linkList: LinkListEntity[];
-}
-export interface LinkListEntity {
-    title: string;
-    url: string;
-    target?: string;
-    isActive?: boolean;
-    isActiveOverride?: boolean;
-}
-export interface NavMetaEntity {
-    isActive: boolean;
-    isHomeLink: boolean;
-    target?: string;
-    text: string;
-    url: string;
-}
-export interface NavLangEntity {
-    a11yLabel?: string;
-    isCurrent: boolean;
-    lang: string;
-    text: string;
-    title: string;
-    url?: string;
-}
-export interface IHeaderTranslations {
-    backButtonText: string;
-    closeButtonText: string;
-    homeLinkTitle: string;
-    navLangAriaLabel: string;
-    navMainAriaLabel: string;
-    navMetaAriaLabel: string;
-    searchAriaLabel: string;
-    flyoutSearchBoxFloatingLabel: string;
-    searchPlaceholder: string;
-    searchSubmit: string;
-    searchToggle: string;
-    searchToggleExpanded: string;
-    searchA11yLabelClosed: string;
-    searchA11yLabelOpened: string;
-    mobileNavToggleClose: string;
-    mobileNavToggleOpen: string;
-    nonResponsiveHeader: string;
-    loginWidgetText?: string;
-}
-export interface IsFocusable {
-    setFocus: () => void;
-}
-export type FocusableElement = HTMLElement & IsFocusable;
-export interface IDropdownElement {
-    toggleDropdown: (force?: boolean) => Promise<boolean>;
-}
-export interface HasDropdown extends IDropdownElement {
-    dropdownToggled: EventEmitter<DropdownEvent>;
-}
-export type DropdownElement = HTMLElement & IDropdownElement;
-export type DropdownEvent = {
-    open: boolean;
-    element: DropdownElement;
-};
-export interface ICustomHeaderConfig {
-    navMain: NavMainEntity[];
-}
-export type MainNavScoreList = {
-    main: NavMainEntity;
-    sub?: LinkListEntity;
-    score: number;
-}[];

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

@@ -0,0 +1,24 @@
+export interface LinkListConfig<T extends SimpleLinkConfig = LinkConfig> {
+    title: string | SimpleLinkConfig;
+    items: Array<T>;
+}
+export type LinkConfig = SimpleLinkConfig | IconLinkConfig | ImageLinkConfig;
+export interface ImageLinkConfig extends SimpleLinkConfig {
+    image: {
+        src: string;
+        alt: string;
+    };
+}
+export interface IconLinkConfig extends SimpleLinkConfig {
+    icon: string;
+}
+export type SimpleLinkConfig = AccessibleTextConfig & RouteLink;
+export interface RouteLink {
+    url: string;
+    active?: boolean;
+}
+export interface AccessibleTextConfig {
+    text: string;
+    label?: string;
+    description?: string;
+}

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

@@ -0,0 +1,9 @@
+export interface UserConfig {
+    name: string;
+    surname: string;
+    email: string;
+    company?: string;
+    userType: 'B2B' | 'B2C';
+    canChangeCompany?: boolean;
+    changeUserAndProfile: 'notAvailable' | 'userAndProfile';
+}

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

@@ -1,56 +1,35 @@
-import { Environment, IPortalConfig, ILocalizedConfig, ICustomConfig, ILocalizedCustomConfig, LocalizedConfigParameters } from '../models/general.model';
-import { NavMainEntity } from '../models/header.model';
+import { Environment, LocalizedConfig, LocalizedConfigParameters } from "../models/general.model";
 /**
  * Get a localized config object
  *
  * @param projectId String identifying the project
+ * @param environment Target environment
  * @param language [optional] Preferred language
  * @returns Localized config object
  */
-export declare const getLocalizedConfig: ({ projectId, environment, language, cookieKey, localStorageKey, activeRouteProp, localizedCustomConfig, osFlyoutOverrides, }: LocalizedConfigParameters) => Promise<ILocalizedConfig>;
+export declare const getLocalizedConfig: ({ projectId, environment, language, }: LocalizedConfigParameters) => Promise<LocalizedConfig>;
 /**
- * Merge portal config with custom os flyout overrides
- * @param config Localized config
- * @param osFlyoutOverrides Overrides for the flyout
- * @returns Merged localized config
- */
-export declare const mergeOsFlyoutOverrides: (config: ILocalizedConfig, osFlyoutOverrides: NavMainEntity) => NavMainEntity[];
-/**
- * Fetch the general config based on project id
+ * Fetch the config for a project, in a given language
  *
- * @returns Promise for Post Portal general config
+ * @param projectId String identifying the project
+ * @param environment Target environment
+ * @param lang Currently selected language
+ * @returns Promise for a single-language config object
  */
-export declare const fetchConfig: (projectId: string, environment: Environment) => Promise<IPortalConfig>;
+export declare const fetchConfig: (projectId: string, environment: Environment, lang: string) => Promise<LocalizedConfig>;
 /**
- * Generate an URL with all necessary query params to get the configuration.
+ * Generate a URL with all necessary query params to get the configuration.
  * Project id "test" will return a test configuration
  * @param projectId string
  * @param environment int01, int02 or prod
+ * @param lang currently selected language
  * @returns URL pointing to the project config
  */
-export declare const generateConfigUrl: (projectId: string, environment: Environment) => string;
+export declare const generateConfigUrl: (projectId: string, environment: Environment, lang: string) => string;
 /**
  * Check if project id contains only URL safe characters
  *
- * @param projectId Project Id string
+ * @param projectId Project ID string
  * @returns The valid project id
  */
 export declare const isValidProjectId: (projectId: string) => boolean;
-/**
- * Get the localized config object from a custom config
- *
- * @param config String or json object of the custom config
- * @param language Specific language
- * @returns Localized custom config object
- */
-export declare const getLocalizedCustomConfig: (config: string | ICustomConfig, language: string) => ILocalizedCustomConfig | undefined;
-/**
- * Check if mobile header styles are applied or not
- * @returns True if browser is smaller than 1024px
- */
-export declare const isMobile: () => boolean;
-/**
- * Set unique ID's on main navigation entities but conserve flyout_os to be able to
- * identify the online-service flyout, which can be configured by osFlyoutOverrides
- */
-export declare const setMainNavigationIds: (navMainEntities: NavMainEntity[]) => void;

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

@@ -1,110 +1,7 @@
-export declare const getUserLang: (supportedLanguages: string[], implementorPreferredLanguage?: string, localStorageKey?: string, cookieKey?: string) => string;
 /**
- * Persist chosen language to local storage
- * @param lang Currently chose language, two char string
- */
-export declare const persistLanguageChoice: (lang: string, cookieKey?: string, localStorageKey?: string) => void;
-/**
- * Read a cookie by name
- * https://stackoverflow.com/questions/5639346/what-is-the-shortest-function-for-reading-a-cookie-by-name-in-javascript?rq=1
- * @param name Cookie name
- * @returns Cookie value or an empty string
- */
-export declare const getCookie: (name: string) => string;
-/**
- * Write a new cookie
- * https://developer.mozilla.org/en-US/docs/Web/API/document/cookie#A_little_framework.3A_a_complete_cookies_reader.2Fwriter_with_full_unicode_support
- * @param key
- * @param value
- */
-export declare const setCookie: (key: string, value: string) => void;
-/**
- * Simple translate function for general header UI strings
+ * Determine the current user language
  *
- * @param key Translation key
- * @param lang Force a language
- * @param translationObject Optionally provide translations
- * @returns Translated string or the key
+ * @param implementorPreferredLanguage [optional] Preferred language
+ * @returns The resolved language code
  */
-export declare const translate: (key: string, lang?: string, translationObject?: {
-    'Active navigation element': {
-        de: string;
-        fr: string;
-        it: string;
-    };
-    'Close overlay': {
-        de: string;
-        fr: string;
-        it: string;
-    };
-    'Current language is English': {
-        de: string;
-        fr: string;
-        it: string;
-    };
-    'Change language': {
-        de: string;
-        fr: string;
-        it: string;
-    };
-    'Go to main content': {
-        de: string;
-        fr: string;
-        it: string;
-    };
-    'Go to search': {
-        de: string;
-        fr: string;
-        it: string;
-    };
-    'Go to login': {
-        de: string;
-        fr: string;
-        it: string;
-    };
-    'Open menu': {
-        de: string;
-        fr: string;
-        it: string;
-    };
-    'Navigate on post.ch': {
-        de: string;
-        fr: string;
-        it: string;
-    };
-    'Skip Links': {
-        de: string;
-        fr: string;
-        it: string;
-    };
-    'Intermediary links': {
-        de: string;
-        fr: string;
-        it: string;
-    };
-    'Cookie Settings': {
-        de: string;
-        fr: string;
-        it: string;
-    };
-    'Delete search term': {
-        de: string;
-        fr: string;
-        it: string;
-    };
-    'Enter search term. Press "Enter" to search.': {
-        de: string;
-        fr: string;
-        it: string;
-    };
-    'most searched topics available, press the tab key to continue.': {
-        de: string;
-        fr: string;
-        it: string;
-    };
-    'search result(s)': {
-        de: string;
-        fr: string;
-        it: string;
-    };
-}) => any;
+export declare const getUserLang: (implementorPreferredLanguage?: string) => string;

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

@@ -1,39 +1,23 @@
 import { ActiveRouteProp } from '../models/general.model';
-import { NavMainEntity, MainNavScoreList } from '../models/header.model';
+import { RouteLink } from '../models/shared.model';
 /**
- * Activate the current route based on the config and the match mode
- * @param config Main Navigation Config
- * @param activeRouteProp Match mode or custom URL to compare against
- * @returns Modified Main Navigation Config
+ * Determine the active link from the header config and the activeRoute prop.
+ * @param activeRouteProp Match mode or custom URL
+ * @returns The best-matching link config object, or null
  */
-export declare const markActiveRoute: (config: NavMainEntity[], activeRouteProp: ActiveRouteProp) => NavMainEntity[];
+export declare const getActiveLink: (activeRouteProp: ActiveRouteProp) => RouteLink | null;
 /**
- * Check if the portal config set any active route
- * @param config Main navigation config
- * @returns True if portal set any route as active
- */
-export declare const hasActivePortalRoute: (config: NavMainEntity[]) => boolean;
-export declare const resetActiveStateToPortalConfig: (config: NavMainEntity[]) => NavMainEntity[];
-/**
- * Compile a list of scores based on how well nav items match the reference URL
- * @param config Main Nav Config
- * @param referenceUrl URL to compare nav items against (window.location or custom)
- * @param activeRouteProp Match mode
- * @returns A list of scored URLs if any matched
- */
-export declare const compileScoreList: (config: NavMainEntity[], referenceUrl: URL, activeRouteProp: ActiveRouteProp, isRelativeReference: boolean) => MainNavScoreList;
-/**
- * Compare a nav item URL against the reference URL for similarity
- * @param referenceUrl URL we're comparing against (from window.location or custom)
- * @param navItemUrl URL from the navigation item
+ * Compare two URLs for similarity based on a match mode
+ * @param baseUrl Browser URL
+ * @param compareUrl Navigation URL
  * @param matchMode exact or auto matching
- * @returns Score indicating how well the URLs match
+ * @returns Score
  */
-export declare const compareRoutes: (referenceUrl: URL, navItemUrl: URL, isRelativeReference: boolean, matchMode?: 'auto' | 'exact') => number;
+export declare const compareRoutes: (baseUrl: URL, compareUrl: URL, matchMode?: "auto" | "exact") => number;
 /**
  * Check how many items in an array match
- * @param a Reference array
- * @param b Nav item array to compare
+ * @param a Base array
+ * @param b Compare array
  * @returns Score
  */
 export declare const getSimilarityScore: (a: string[], b: string[]) => number;