@swisspost/internet-header 1.5.0-beta.0

package/dist/types/components.d.ts

@@ -0,0 +1,365 @@
+/* eslint-disable */
+/* tslint:disable */
+/**
+ * This is an autogenerated file created by the Stencil compiler.
+ * It contains typing information for all components that exist in this project.
+ */
+import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
+import { DropdownEvent, NavMainEntity } from "./models/header.model";
+import { IBreadcrumbItem } from "./models/breadcrumbs.model";
+import { StickynessOptions } from "./models/implementor.model";
+import { Environment, ICustomConfig } from "./models/general.model";
+import { IAvailableLanguage } from "./models/language.model";
+export { DropdownEvent, NavMainEntity } from "./models/header.model";
+export { IBreadcrumbItem } from "./models/breadcrumbs.model";
+export { StickynessOptions } from "./models/implementor.model";
+export { Environment, ICustomConfig } from "./models/general.model";
+export { IAvailableLanguage } from "./models/language.model";
+export namespace Components {
+    interface PostKlpLoginWidget {
+        /**
+          * Sets the focus on the login button
+         */
+        "setFocus": () => Promise<void>;
+    }
+    interface PostLanguageSwitch {
+        "mode": 'dropdown' | 'list';
+        /**
+          * Open or close the language switch programatically
+          * @param force Boolean to force a state
+          * @returns Boolean indicating new state
+         */
+        "toggleDropdown": (force?: boolean) => Promise<boolean>;
+    }
+    interface PostLogo {
+    }
+    interface PostMainNavigation {
+        /**
+          * Open a specific flyout
+          * @param id Flyout ID
+         */
+        "setActiveFlyout": (id: string | null) => Promise<void>;
+        /**
+          * Focus the main navigation toggle button
+         */
+        "setFocus": () => Promise<void>;
+        /**
+          * Toggle the main navigation (only visible on mobile)
+          * @param force Force a state
+          * @returns Boolean indicating new state
+         */
+        "toggleDropdown": (force?: boolean) => Promise<boolean>;
+    }
+    interface PostMetaNavigation {
+        "fullWidth"?: boolean;
+        "orientation": 'horizontal' | 'vertical';
+    }
+    interface PostSearch {
+        /**
+          * Sets the focus on the search button
+         */
+        "setFocus": () => Promise<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?: unknown) => Promise<boolean>;
+    }
+    interface PostSkiplinks {
+    }
+    interface SwisspostInternetBreadcrumbs {
+        "customItems"?: string | IBreadcrumbItem[];
+    }
+    interface SwisspostInternetFooter {
+    }
+    interface SwisspostInternetHeader {
+        /**
+          * Set the currently activated route. If there is a link matching this URL in the header, it will be highlighted. Will also highlight partly matching URLs. When set to auto, will use current location.href for comparison.
+         */
+        "activeRoute"?: 'auto' | false | string;
+        /**
+          * DEPRECATED!: Define a proxy URL for the config fetch request. Will be removed in the next major version
+         */
+        "configProxy"?: string;
+        /**
+          * Customize the header config loaded from the post portal.
+         */
+        "customConfig"?: string | ICustomConfig;
+        /**
+          * Target environment. Choose 'int01' for local testing.
+         */
+        "environment": Environment;
+        /**
+          * Displays the header at full width for full-screen applications
+         */
+        "fullWidth"?: boolean;
+        /**
+          * Get the currently set language as a two letter string ("de", "fr" "it" or "en")
+          * @returns string
+         */
+        "getCurrentLanguage": () => Promise<'de' | 'fr' | 'it' | 'en' | string>;
+        /**
+          * Initial language to be used. Overrides automatic language detection.
+         */
+        "language"?: string;
+        /**
+          * The header uses this cookie to set the language. Disables automatic language detection.
+         */
+        "languageCookieKey"?: string;
+        /**
+          * The header uses this local storage key to set the language. Disables automatic language selection.
+         */
+        "languageLocalStorageKey"?: string;
+        /**
+          * Override the language switch links with custom URLs. Helpful when your application contains sub-pages and you would like to stay on subpages when the user changes language.
+         */
+        "languageSwitchOverrides"?: string | IAvailableLanguage[];
+        /**
+          * Toggle the login link (when logged out) or the user widget (when logged in).
+         */
+        "login": boolean;
+        /**
+          * Toggle the meta navigation.
+         */
+        "meta": boolean;
+        /**
+          * Online Services only: Add custom links to the special online service navigation entry
+         */
+        "osFlyoutOverrides"?: string | NavMainEntity;
+        /**
+          * Your project id, previously passed as query string parameter serviceId.
+         */
+        "project": string;
+        /**
+          * Toggle the search button.
+         */
+        "search": boolean;
+        /**
+          * Toggle skiplinks. They help keyboard users to quickly jump to important sections of the page.
+         */
+        "skiplinks": boolean;
+        /**
+          * Sticky behaviour of the header.
+         */
+        "stickyness": StickynessOptions;
+    }
+}
+export interface PostLanguageSwitchCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLPostLanguageSwitchElement;
+}
+export interface PostMainNavigationCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLPostMainNavigationElement;
+}
+export interface PostSearchCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLPostSearchElement;
+}
+export interface SwisspostInternetHeaderCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLSwisspostInternetHeaderElement;
+}
+declare global {
+    interface HTMLPostKlpLoginWidgetElement extends Components.PostKlpLoginWidget, HTMLStencilElement {
+    }
+    var HTMLPostKlpLoginWidgetElement: {
+        prototype: HTMLPostKlpLoginWidgetElement;
+        new (): HTMLPostKlpLoginWidgetElement;
+    };
+    interface HTMLPostLanguageSwitchElement extends Components.PostLanguageSwitch, HTMLStencilElement {
+    }
+    var HTMLPostLanguageSwitchElement: {
+        prototype: HTMLPostLanguageSwitchElement;
+        new (): HTMLPostLanguageSwitchElement;
+    };
+    interface HTMLPostLogoElement extends Components.PostLogo, HTMLStencilElement {
+    }
+    var HTMLPostLogoElement: {
+        prototype: HTMLPostLogoElement;
+        new (): HTMLPostLogoElement;
+    };
+    interface HTMLPostMainNavigationElement extends Components.PostMainNavigation, HTMLStencilElement {
+    }
+    var HTMLPostMainNavigationElement: {
+        prototype: HTMLPostMainNavigationElement;
+        new (): HTMLPostMainNavigationElement;
+    };
+    interface HTMLPostMetaNavigationElement extends Components.PostMetaNavigation, HTMLStencilElement {
+    }
+    var HTMLPostMetaNavigationElement: {
+        prototype: HTMLPostMetaNavigationElement;
+        new (): HTMLPostMetaNavigationElement;
+    };
+    interface HTMLPostSearchElement extends Components.PostSearch, HTMLStencilElement {
+    }
+    var HTMLPostSearchElement: {
+        prototype: HTMLPostSearchElement;
+        new (): HTMLPostSearchElement;
+    };
+    interface HTMLPostSkiplinksElement extends Components.PostSkiplinks, HTMLStencilElement {
+    }
+    var HTMLPostSkiplinksElement: {
+        prototype: HTMLPostSkiplinksElement;
+        new (): HTMLPostSkiplinksElement;
+    };
+    interface HTMLSwisspostInternetBreadcrumbsElement extends Components.SwisspostInternetBreadcrumbs, HTMLStencilElement {
+    }
+    var HTMLSwisspostInternetBreadcrumbsElement: {
+        prototype: HTMLSwisspostInternetBreadcrumbsElement;
+        new (): HTMLSwisspostInternetBreadcrumbsElement;
+    };
+    interface HTMLSwisspostInternetFooterElement extends Components.SwisspostInternetFooter, HTMLStencilElement {
+    }
+    var HTMLSwisspostInternetFooterElement: {
+        prototype: HTMLSwisspostInternetFooterElement;
+        new (): HTMLSwisspostInternetFooterElement;
+    };
+    interface HTMLSwisspostInternetHeaderElement extends Components.SwisspostInternetHeader, HTMLStencilElement {
+    }
+    var HTMLSwisspostInternetHeaderElement: {
+        prototype: HTMLSwisspostInternetHeaderElement;
+        new (): HTMLSwisspostInternetHeaderElement;
+    };
+    interface HTMLElementTagNameMap {
+        "post-klp-login-widget": HTMLPostKlpLoginWidgetElement;
+        "post-language-switch": HTMLPostLanguageSwitchElement;
+        "post-logo": HTMLPostLogoElement;
+        "post-main-navigation": HTMLPostMainNavigationElement;
+        "post-meta-navigation": HTMLPostMetaNavigationElement;
+        "post-search": HTMLPostSearchElement;
+        "post-skiplinks": HTMLPostSkiplinksElement;
+        "swisspost-internet-breadcrumbs": HTMLSwisspostInternetBreadcrumbsElement;
+        "swisspost-internet-footer": HTMLSwisspostInternetFooterElement;
+        "swisspost-internet-header": HTMLSwisspostInternetHeaderElement;
+    }
+}
+declare namespace LocalJSX {
+    interface PostKlpLoginWidget {
+    }
+    interface PostLanguageSwitch {
+        "mode"?: 'dropdown' | 'list';
+        "onDropdownToggled"?: (event: PostLanguageSwitchCustomEvent<DropdownEvent>) => void;
+        "onLanguageChanged"?: (event: PostLanguageSwitchCustomEvent<string>) => void;
+    }
+    interface PostLogo {
+    }
+    interface PostMainNavigation {
+        "onDropdownToggled"?: (event: PostMainNavigationCustomEvent<DropdownEvent>) => void;
+        "onFlyoutToggled"?: (event: PostMainNavigationCustomEvent<string | null>) => void;
+    }
+    interface PostMetaNavigation {
+        "fullWidth"?: boolean;
+        "orientation"?: 'horizontal' | 'vertical';
+    }
+    interface PostSearch {
+        "onDropdownToggled"?: (event: PostSearchCustomEvent<DropdownEvent>) => void;
+    }
+    interface PostSkiplinks {
+    }
+    interface SwisspostInternetBreadcrumbs {
+        "customItems"?: string | IBreadcrumbItem[];
+    }
+    interface SwisspostInternetFooter {
+    }
+    interface SwisspostInternetHeader {
+        /**
+          * Set the currently activated route. If there is a link matching this URL in the header, it will be highlighted. Will also highlight partly matching URLs. When set to auto, will use current location.href for comparison.
+         */
+        "activeRoute"?: 'auto' | false | string;
+        /**
+          * DEPRECATED!: Define a proxy URL for the config fetch request. Will be removed in the next major version
+         */
+        "configProxy"?: string;
+        /**
+          * Customize the header config loaded from the post portal.
+         */
+        "customConfig"?: string | ICustomConfig;
+        /**
+          * Target environment. Choose 'int01' for local testing.
+         */
+        "environment"?: Environment;
+        /**
+          * Displays the header at full width for full-screen applications
+         */
+        "fullWidth"?: boolean;
+        /**
+          * Initial language to be used. Overrides automatic language detection.
+         */
+        "language"?: string;
+        /**
+          * The header uses this cookie to set the language. Disables automatic language detection.
+         */
+        "languageCookieKey"?: string;
+        /**
+          * The header uses this local storage key to set the language. Disables automatic language selection.
+         */
+        "languageLocalStorageKey"?: string;
+        /**
+          * Override the language switch links with custom URLs. Helpful when your application contains sub-pages and you would like to stay on subpages when the user changes language.
+         */
+        "languageSwitchOverrides"?: string | IAvailableLanguage[];
+        /**
+          * Toggle the login link (when logged out) or the user widget (when logged in).
+         */
+        "login"?: boolean;
+        /**
+          * Toggle the meta navigation.
+         */
+        "meta"?: boolean;
+        /**
+          * Fires when the header has been rendered to the page.
+         */
+        "onHeaderLoaded"?: (event: SwisspostInternetHeaderCustomEvent<void>) => void;
+        /**
+          * Online Services only: Add custom links to the special online service navigation entry
+         */
+        "osFlyoutOverrides"?: string | NavMainEntity;
+        /**
+          * Your project id, previously passed as query string parameter serviceId.
+         */
+        "project"?: string;
+        /**
+          * Toggle the search button.
+         */
+        "search"?: boolean;
+        /**
+          * Toggle skiplinks. They help keyboard users to quickly jump to important sections of the page.
+         */
+        "skiplinks"?: boolean;
+        /**
+          * Sticky behaviour of the header.
+         */
+        "stickyness"?: StickynessOptions;
+    }
+    interface IntrinsicElements {
+        "post-klp-login-widget": PostKlpLoginWidget;
+        "post-language-switch": PostLanguageSwitch;
+        "post-logo": PostLogo;
+        "post-main-navigation": PostMainNavigation;
+        "post-meta-navigation": PostMetaNavigation;
+        "post-search": PostSearch;
+        "post-skiplinks": PostSkiplinks;
+        "swisspost-internet-breadcrumbs": SwisspostInternetBreadcrumbs;
+        "swisspost-internet-footer": SwisspostInternetFooter;
+        "swisspost-internet-header": SwisspostInternetHeader;
+    }
+}
+export { LocalJSX as JSX };
+declare module "@stencil/core" {
+    export namespace JSX {
+        interface IntrinsicElements {
+            "post-klp-login-widget": LocalJSX.PostKlpLoginWidget & JSXBase.HTMLAttributes<HTMLPostKlpLoginWidgetElement>;
+            "post-language-switch": LocalJSX.PostLanguageSwitch & JSXBase.HTMLAttributes<HTMLPostLanguageSwitchElement>;
+            "post-logo": LocalJSX.PostLogo & JSXBase.HTMLAttributes<HTMLPostLogoElement>;
+            "post-main-navigation": LocalJSX.PostMainNavigation & JSXBase.HTMLAttributes<HTMLPostMainNavigationElement>;
+            "post-meta-navigation": LocalJSX.PostMetaNavigation & JSXBase.HTMLAttributes<HTMLPostMetaNavigationElement>;
+            "post-search": LocalJSX.PostSearch & JSXBase.HTMLAttributes<HTMLPostSearchElement>;
+            "post-skiplinks": LocalJSX.PostSkiplinks & JSXBase.HTMLAttributes<HTMLPostSkiplinksElement>;
+            "swisspost-internet-breadcrumbs": LocalJSX.SwisspostInternetBreadcrumbs & JSXBase.HTMLAttributes<HTMLSwisspostInternetBreadcrumbsElement>;
+            "swisspost-internet-footer": LocalJSX.SwisspostInternetFooter & JSXBase.HTMLAttributes<HTMLSwisspostInternetFooterElement>;
+            "swisspost-internet-header": LocalJSX.SwisspostInternetHeader & JSXBase.HTMLAttributes<HTMLSwisspostInternetHeaderElement>;
+        }
+    }
+}

package/dist/types/data/store.d.ts

@@ -0,0 +1,16 @@
+import { Environment, ILocalizedConfig, ILocalizedCustomConfig } from '../models/general.model';
+import { NavMainEntity } from '../models/header.model';
+import { IAvailableLanguage } from '../models/language.model';
+export interface HeaderState {
+  localizedConfig: ILocalizedConfig | null;
+  currentLanguage: string | null;
+  projectId: string | null;
+  environment: Environment;
+  search: boolean;
+  login: boolean;
+  meta: boolean;
+  languageSwitchOverrides?: IAvailableLanguage[];
+  localizedCustomConfig?: ILocalizedCustomConfig;
+  osFlyoutOverrides?: NavMainEntity;
+}
+export declare const state: HeaderState, reset: () => void, dispose: () => void;

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export { Components, JSX } from './components';

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

@@ -0,0 +1,36 @@
+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

@@ -0,0 +1,22 @@
+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/footer.model.d.ts

@@ -0,0 +1,48 @@
+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[];
+}

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

@@ -0,0 +1,46 @@
+import { IHeaderConfig, ICustomHeaderConfig, NavMainEntity } from './header.model';
+import { IBreadcrumbConfig } from './breadcrumbs.model';
+import { IFooterConfig, ICustomFooterConfig } from './footer.model';
+declare global {
+  interface Window {
+    OPPklpWidget: any;
+    klpWidgetDev: any;
+    jQuery: any;
+    $: any;
+    SockJS: any;
+  }
+}
+export interface IPortalConfig {
+  de?: ILocalizedConfig;
+  fr?: ILocalizedConfig;
+  it?: ILocalizedConfig;
+  en?: ILocalizedConfig;
+}
+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 = 'int01' | 'int02' | 'prod';
+export type ActiveRouteProp = 'auto' | 'exact' | false | string;
+export type LocalizedConfigParameters = {
+  projectId: string;
+  environment: Environment;
+  language?: string;
+  mapMyPost?: boolean;
+  cookieKey?: string;
+  localStorageKey?: string;
+  activeRouteProp?: ActiveRouteProp;
+  localizedCustomConfig?: ILocalizedCustomConfig;
+  osFlyoutOverrides?: NavMainEntity;
+};

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

@@ -0,0 +1,52 @@
+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 enum GeocodeResponseType {
+  Region = "region",
+  City = "city",
+  Zip = "zip",
+  Locality = "locality",
+  Address = "address",
+  Poi = "poi"
+}
+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;
+}