@swisspost/internet-header 1.5.0-beta.2 → 1.5.0

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

@@ -1,163 +1,163 @@
-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;
-  };
-  loginWidgetOptions?: ILoginWidgetOptions;
-  loginWidgetId: string;
-  logo: ILogoConfig;
-  mobileMenu: {
-    text: string;
-  };
-  search: ISearchConfig;
-  onlineServiceId: string;
-  navMain: NavMainEntity[];
-  navMeta?: NavMetaEntity[];
-  navLang: NavLangEntity[];
-  translations: IHeaderTranslations;
-}
-export interface IIconConfig {
-  name: string;
-  classes?: string[];
-  additionalAttributes?: AdditionalAttribute[];
-}
-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;
-  };
-}
-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;
-}
-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 HasDropdown {
-  toggleDropdown: (force?: boolean) => Promise<boolean>;
-  dropdownToggled: EventEmitter<DropdownEvent>;
-}
-export type DropdownElement = HTMLElement & HasDropdown;
-export type DropdownEvent = {
-  open: boolean;
-  element: DropdownElement;
-};
-export interface ICustomHeaderConfig {
-  navMain: NavMainEntity[];
-}
-export type MainNavScoreList = {
-  main: NavMainEntity;
-  sub?: LinkListEntity;
-  score: number;
-}[];
+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;
+  };
+  loginWidgetOptions?: ILoginWidgetOptions;
+  loginWidgetId: string;
+  logo: ILogoConfig;
+  mobileMenu: {
+    text: string;
+  };
+  search: ISearchConfig;
+  onlineServiceId: string;
+  navMain: NavMainEntity[];
+  navMeta?: NavMetaEntity[];
+  navLang: NavLangEntity[];
+  translations: IHeaderTranslations;
+}
+export interface IIconConfig {
+  name: string;
+  classes?: string[];
+  additionalAttributes?: AdditionalAttribute[];
+}
+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;
+  };
+}
+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;
+}
+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 HasDropdown {
+  toggleDropdown: (force?: boolean) => Promise<boolean>;
+  dropdownToggled: EventEmitter<DropdownEvent>;
+}
+export type DropdownElement = HTMLElement & HasDropdown;
+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/implementor.model.d.ts

@@ -1,22 +1,22 @@
-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;
-}
+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 +1,6 @@
-export interface IAvailableLanguage {
-  lang: string;
-  text?: string;
-  title?: string;
-  url?: string;
-}
+export interface IAvailableLanguage {
+  lang: string;
+  text?: string;
+  title?: string;
+  url?: string;
+}

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

@@ -1,25 +1,25 @@
-export interface TrackAndTraceInfo {
-  ok: boolean;
-  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];
-    }
-  ];
-}
+export interface TrackAndTraceInfo {
+  ok: boolean;
+  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/config.service.d.ts

@@ -1,56 +1,56 @@
-import { Environment, IPortalConfig, ILocalizedConfig, ICustomConfig, ILocalizedCustomConfig, LocalizedConfigParameters } from '../models/general.model';
-import { NavMainEntity } from '../models/header.model';
-/**
- * Get a localized config object
- *
- * @param projectId String identifying the project
- * @param language [optional] Preferred language
- * @returns Localized config object
- */
-export declare const getLocalizedConfig: ({ projectId, environment, language, cookieKey, localStorageKey, activeRouteProp, localizedCustomConfig, osFlyoutOverrides, }: LocalizedConfigParameters) => Promise<ILocalizedConfig>;
-/**
- * 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
- *
- * @returns Promise for Post Portal general config
- */
-export declare const fetchConfig: (projectId: string, environment: Environment) => Promise<IPortalConfig>;
-/**
- * Generate an 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
- * @returns URL pointing to the project config
- */
-export declare const generateConfigUrl: (projectId: string, environment: Environment) => string;
-/**
- * Check if project id contains only URL safe characters
- *
- * @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;
+import { Environment, IPortalConfig, ILocalizedConfig, ICustomConfig, ILocalizedCustomConfig, LocalizedConfigParameters } from '../models/general.model';
+import { NavMainEntity } from '../models/header.model';
+/**
+ * Get a localized config object
+ *
+ * @param projectId String identifying the project
+ * @param language [optional] Preferred language
+ * @returns Localized config object
+ */
+export declare const getLocalizedConfig: ({ projectId, environment, language, cookieKey, localStorageKey, activeRouteProp, localizedCustomConfig, osFlyoutOverrides, }: LocalizedConfigParameters) => Promise<ILocalizedConfig>;
+/**
+ * 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
+ *
+ * @returns Promise for Post Portal general config
+ */
+export declare const fetchConfig: (projectId: string, environment: Environment) => Promise<IPortalConfig>;
+/**
+ * Generate an 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
+ * @returns URL pointing to the project config
+ */
+export declare const generateConfigUrl: (projectId: string, environment: Environment) => string;
+/**
+ * Check if project id contains only URL safe characters
+ *
+ * @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,65 +1,65 @@
-export declare const getUserLang: (supportedLanguages: string[], implementorPreferredLanguage?: string, localStorageKey?: string, cookieKey?: string) => string | undefined;
-/**
- * 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
- *
- * @param key Translation key
- * @param lang Force a language
- * @param translationObject Optionally provide translations
- * @returns Translated string or the key
- */
-export declare const translate: (key: string, lang?: string, translationObject?: {
-  '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;
-  };
-}) => any;
+export declare const getUserLang: (supportedLanguages: string[], implementorPreferredLanguage?: string, localStorageKey?: string, cookieKey?: string) => string | undefined;
+/**
+ * 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
+ *
+ * @param key Translation key
+ * @param lang Force a language
+ * @param translationObject Optionally provide translations
+ * @returns Translated string or the key
+ */
+export declare const translate: (key: string, lang?: string, translationObject?: {
+  '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;
+  };
+}) => any;