@swisspost/internet-header 1.11.0 → 1.12.1

package/dist/docs.json

@@ -1,20 +1,45 @@
 {
-  "timestamp": "2023-10-24T09:50:13",
+  "timestamp": "2023-11-02T11:31:50",
   "compiler": {
     "name": "@stencil/core",
-    "version": "3.4.2",
-    "typescriptVersion": "5.0.4"
+    "version": "4.6.0",
+    "typescriptVersion": "5.2.2"
   },
   "components": [
     {
-      "filePath": "./src/components/post-klp-login-widget/post-klp-login-widget.tsx",
+      "filePath": "src/components/post-klp-login-widget/post-klp-login-widget.tsx",
       "encapsulation": "shadow",
       "tag": "post-klp-login-widget",
       "readme": "# post-klp-login-widget\n\n\n",
       "docs": "",
       "docsTags": [],
       "usage": {},
-      "props": [],
+      "props": [
+        {
+          "name": "logoutUrl",
+          "type": "string | undefined",
+          "complexType": {
+            "original": "string",
+            "resolved": "string | undefined",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "logout-url",
+          "reflectToAttr": false,
+          "docs": "Override the logout-url provided by the portal config.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        }
+      ],
       "methods": [
         {
           "name": "setFocus",
@@ -22,6 +47,21 @@
             "type": "Promise<void>",
             "docs": ""
           },
+          "complexType": {
+            "signature": "() => Promise<void>",
+            "parameters": [],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              },
+              "HTMLElement": {
+                "location": "global",
+                "id": "global::HTMLElement"
+              }
+            },
+            "return": "Promise<void>"
+          },
           "signature": "setFocus() => Promise<void>",
           "parameters": [],
           "docs": "Sets the focus on the login button",
@@ -44,7 +84,7 @@
       }
     },
     {
-      "filePath": "./src/components/post-language-switch/post-language-switch.tsx",
+      "filePath": "src/components/post-language-switch/post-language-switch.tsx",
       "encapsulation": "shadow",
       "tag": "post-language-switch",
       "readme": "# post-language-switch\n\n\n",
@@ -55,6 +95,11 @@
         {
           "name": "mode",
           "type": "\"dropdown\" | \"list\"",
+          "complexType": {
+            "original": "'dropdown' | 'list'",
+            "resolved": "\"dropdown\" | \"list\"",
+            "references": {}
+          },
           "mutable": false,
           "attr": "mode",
           "reflectToAttr": false,
@@ -81,6 +126,27 @@
             "type": "Promise<boolean>",
             "docs": "Boolean indicating new state"
           },
+          "complexType": {
+            "signature": "(force?: boolean) => Promise<boolean>",
+            "parameters": [
+              {
+                "tags": [
+                  {
+                    "name": "param",
+                    "text": "force Boolean to force a state"
+                  }
+                ],
+                "text": "Boolean to force a state"
+              }
+            ],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              }
+            },
+            "return": "Promise<boolean>"
+          },
           "signature": "toggleDropdown(force?: boolean) => Promise<boolean>",
           "parameters": [],
           "docs": "Open or close the language switch programatically",
@@ -101,6 +167,17 @@
           "event": "dropdownToggled",
           "detail": "{ open: boolean; element: DropdownElement; }",
           "bubbles": true,
+          "complexType": {
+            "original": "DropdownEvent",
+            "resolved": "{ open: boolean; element: DropdownElement; }",
+            "references": {
+              "DropdownEvent": {
+                "location": "import",
+                "path": "../../models/header.model",
+                "id": "src/models/header.model.ts::DropdownEvent"
+              }
+            }
+          },
           "cancelable": true,
           "composed": true,
           "docs": "",
@@ -110,6 +187,11 @@
           "event": "languageChanged",
           "detail": "string",
           "bubbles": true,
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
           "cancelable": true,
           "composed": true,
           "docs": "",
@@ -131,7 +213,7 @@
       }
     },
     {
-      "filePath": "./src/components/post-logo/post-logo.tsx",
+      "filePath": "src/components/post-logo/post-logo.tsx",
       "encapsulation": "shadow",
       "tag": "post-logo",
       "readme": "# post-logo\n\n\n",
@@ -156,7 +238,7 @@
       }
     },
     {
-      "filePath": "./src/components/post-main-navigation/post-main-navigation.tsx",
+      "filePath": "src/components/post-main-navigation/post-main-navigation.tsx",
       "encapsulation": "shadow",
       "tag": "post-main-navigation",
       "readme": "# post-main-navigation\n\n\n",
@@ -171,6 +253,27 @@
             "type": "Promise<void>",
             "docs": ""
           },
+          "complexType": {
+            "signature": "(id: string | null) => Promise<void>",
+            "parameters": [
+              {
+                "tags": [
+                  {
+                    "name": "param",
+                    "text": "id Flyout ID"
+                  }
+                ],
+                "text": "Flyout ID"
+              }
+            ],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              }
+            },
+            "return": "Promise<void>"
+          },
           "signature": "setActiveFlyout(id: string | null) => Promise<void>",
           "parameters": [],
           "docs": "Open a specific flyout",
@@ -187,6 +290,21 @@
             "type": "Promise<void>",
             "docs": ""
           },
+          "complexType": {
+            "signature": "() => Promise<void>",
+            "parameters": [],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              },
+              "HTMLElement": {
+                "location": "global",
+                "id": "global::HTMLElement"
+              }
+            },
+            "return": "Promise<void>"
+          },
           "signature": "setFocus() => Promise<void>",
           "parameters": [],
           "docs": "Focus the main navigation toggle button",
@@ -198,6 +316,27 @@
             "type": "Promise<boolean>",
             "docs": "Boolean indicating new state"
           },
+          "complexType": {
+            "signature": "(force?: boolean) => Promise<boolean>",
+            "parameters": [
+              {
+                "tags": [
+                  {
+                    "name": "param",
+                    "text": "force Force a state"
+                  }
+                ],
+                "text": "Force a state"
+              }
+            ],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              }
+            },
+            "return": "Promise<boolean>"
+          },
           "signature": "toggleDropdown(force?: boolean) => Promise<boolean>",
           "parameters": [],
           "docs": "Toggle the main navigation (only visible on mobile)",
@@ -218,6 +357,17 @@
           "event": "dropdownToggled",
           "detail": "{ open: boolean; element: DropdownElement; }",
           "bubbles": true,
+          "complexType": {
+            "original": "DropdownEvent",
+            "resolved": "{ open: boolean; element: DropdownElement; }",
+            "references": {
+              "DropdownEvent": {
+                "location": "import",
+                "path": "../../models/header.model",
+                "id": "src/models/header.model.ts::DropdownEvent"
+              }
+            }
+          },
           "cancelable": true,
           "composed": true,
           "docs": "",
@@ -227,6 +377,11 @@
           "event": "flyoutToggled",
           "detail": "null | string",
           "bubbles": true,
+          "complexType": {
+            "original": "string | null",
+            "resolved": "null | string",
+            "references": {}
+          },
           "cancelable": true,
           "composed": true,
           "docs": "",
@@ -248,7 +403,7 @@
       }
     },
     {
-      "filePath": "./src/components/post-meta-navigation/post-meta-navigation.tsx",
+      "filePath": "src/components/post-meta-navigation/post-meta-navigation.tsx",
       "encapsulation": "shadow",
       "tag": "post-meta-navigation",
       "readme": "# post-meta-navigation\n\n\n",
@@ -259,6 +414,11 @@
         {
           "name": "fullWidth",
           "type": "boolean | undefined",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean | undefined",
+            "references": {}
+          },
           "mutable": false,
           "attr": "full-width",
           "reflectToAttr": false,
@@ -279,6 +439,11 @@
         {
           "name": "orientation",
           "type": "\"horizontal\" | \"vertical\"",
+          "complexType": {
+            "original": "'horizontal' | 'vertical'",
+            "resolved": "\"horizontal\" | \"vertical\"",
+            "references": {}
+          },
           "mutable": false,
           "attr": "orientation",
           "reflectToAttr": false,
@@ -315,7 +480,7 @@
       }
     },
     {
-      "filePath": "./src/components/post-search/post-search.tsx",
+      "filePath": "src/components/post-search/post-search.tsx",
       "encapsulation": "shadow",
       "tag": "post-search",
       "readme": "# post-search\n\n\n",
@@ -330,6 +495,21 @@
             "type": "Promise<void>",
             "docs": ""
           },
+          "complexType": {
+            "signature": "() => Promise<void>",
+            "parameters": [],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              },
+              "HTMLElement": {
+                "location": "global",
+                "id": "global::HTMLElement"
+              }
+            },
+            "return": "Promise<void>"
+          },
           "signature": "setFocus() => Promise<void>",
           "parameters": [],
           "docs": "Sets the focus on the search button",
@@ -341,6 +521,27 @@
             "type": "Promise<boolean>",
             "docs": "Boolean indicating open state of the component"
           },
+          "complexType": {
+            "signature": "(force?: unknown) => Promise<boolean>",
+            "parameters": [
+              {
+                "tags": [
+                  {
+                    "name": "param",
+                    "text": "force Boolean to force open/closed state"
+                  }
+                ],
+                "text": "Boolean to force open/closed state"
+              }
+            ],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              }
+            },
+            "return": "Promise<boolean>"
+          },
           "signature": "toggleDropdown(force?: unknown) => Promise<boolean>",
           "parameters": [],
           "docs": "Toggle the dropdown and optionally force an open/closed state",
@@ -361,6 +562,17 @@
           "event": "dropdownToggled",
           "detail": "{ open: boolean; element: DropdownElement; }",
           "bubbles": true,
+          "complexType": {
+            "original": "DropdownEvent",
+            "resolved": "{ open: boolean; element: DropdownElement; }",
+            "references": {
+              "DropdownEvent": {
+                "location": "import",
+                "path": "../../models/header.model",
+                "id": "src/models/header.model.ts::DropdownEvent"
+              }
+            }
+          },
           "cancelable": true,
           "composed": true,
           "docs": "",
@@ -382,7 +594,7 @@
       }
     },
     {
-      "filePath": "./src/components/post-skiplinks/post-skiplinks.tsx",
+      "filePath": "src/components/post-skiplinks/post-skiplinks.tsx",
       "encapsulation": "none",
       "tag": "post-skiplinks",
       "readme": "# post-skiplinks\n\n\n",
@@ -407,7 +619,7 @@
       }
     },
     {
-      "filePath": "./src/components/post-internet-breadcrumbs/post-internet-breadcrumbs.tsx",
+      "filePath": "src/components/post-internet-breadcrumbs/post-internet-breadcrumbs.tsx",
       "encapsulation": "shadow",
       "tag": "swisspost-internet-breadcrumbs",
       "readme": "# post-internet-breadcrumbs\n\n\n",
@@ -418,6 +630,17 @@
         {
           "name": "customItems",
           "type": "IBreadcrumbItem[] | string | undefined",
+          "complexType": {
+            "original": "string | IBreadcrumbItem[]",
+            "resolved": "IBreadcrumbItem[] | string | undefined",
+            "references": {
+              "IBreadcrumbItem": {
+                "location": "import",
+                "path": "../../models/breadcrumbs.model",
+                "id": "src/models/breadcrumbs.model.ts::IBreadcrumbItem"
+              }
+            }
+          },
           "mutable": false,
           "attr": "custom-items",
           "reflectToAttr": false,
@@ -440,6 +663,11 @@
         {
           "name": "hideButtons",
           "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
           "mutable": false,
           "attr": "hide-buttons",
           "reflectToAttr": false,
@@ -462,6 +690,32 @@
             "type": "Promise<void>",
             "docs": ""
           },
+          "complexType": {
+            "signature": "(overlayId: IBreadcrumbOverlay['id']) => Promise<void>",
+            "parameters": [
+              {
+                "tags": [
+                  {
+                    "name": "param",
+                    "text": "overlayId"
+                  }
+                ],
+                "text": ""
+              }
+            ],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              },
+              "IBreadcrumbOverlay": {
+                "location": "import",
+                "path": "../../models/breadcrumbs.model",
+                "id": "src/models/breadcrumbs.model.ts::IBreadcrumbOverlay"
+              }
+            },
+            "return": "Promise<void>"
+          },
           "signature": "toggleOverlayById(overlayId: IBreadcrumbOverlay['id']) => Promise<void>",
           "parameters": [],
           "docs": "Toggle an overlay associated with a button.",
@@ -483,7 +737,7 @@
       "dependencyGraph": {}
     },
     {
-      "filePath": "./src/components/post-internet-footer/post-internet-footer.tsx",
+      "filePath": "src/components/post-internet-footer/post-internet-footer.tsx",
       "encapsulation": "shadow",
       "tag": "swisspost-internet-footer",
       "readme": "# post-internet-footer\n\n\n",
@@ -502,7 +756,7 @@
       "dependencyGraph": {}
     },
     {
-      "filePath": "./src/components/post-internet-header/post-internet-header.tsx",
+      "filePath": "src/components/post-internet-header/post-internet-header.tsx",
       "encapsulation": "shadow",
       "tag": "swisspost-internet-header",
       "readme": "# post-internet-header\n\n\n",
@@ -513,6 +767,11 @@
         {
           "name": "activeRoute",
           "type": "boolean | string | undefined",
+          "complexType": {
+            "original": "'auto' | false | string",
+            "resolved": "boolean | string | undefined",
+            "references": {}
+          },
           "mutable": false,
           "attr": "active-route",
           "reflectToAttr": false,
@@ -536,6 +795,11 @@
         {
           "name": "configProxy",
           "type": "string | undefined",
+          "complexType": {
+            "original": "string",
+            "resolved": "string | undefined",
+            "references": {}
+          },
           "mutable": false,
           "attr": "config-proxy",
           "reflectToAttr": false,
@@ -555,6 +819,17 @@
         {
           "name": "customConfig",
           "type": "ICustomConfig | string | undefined",
+          "complexType": {
+            "original": "string | ICustomConfig",
+            "resolved": "ICustomConfig | string | undefined",
+            "references": {
+              "ICustomConfig": {
+                "location": "import",
+                "path": "../../models/general.model",
+                "id": "src/models/general.model.ts::ICustomConfig"
+              }
+            }
+          },
           "mutable": false,
           "attr": "custom-config",
           "reflectToAttr": false,
@@ -577,6 +852,17 @@
         {
           "name": "environment",
           "type": "\"dev01\" | \"dev02\" | \"devs1\" | \"int01\" | \"int02\" | \"prod\" | \"test\"",
+          "complexType": {
+            "original": "Environment",
+            "resolved": "\"dev01\" | \"dev02\" | \"devs1\" | \"int01\" | \"int02\" | \"prod\" | \"test\"",
+            "references": {
+              "Environment": {
+                "location": "import",
+                "path": "../../models/general.model",
+                "id": "src/models/general.model.ts::Environment"
+              }
+            }
+          },
           "mutable": false,
           "attr": "environment",
           "reflectToAttr": false,
@@ -619,6 +905,11 @@
         {
           "name": "fullWidth",
           "type": "boolean | undefined",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean | undefined",
+            "references": {}
+          },
           "mutable": false,
           "attr": "full-width",
           "reflectToAttr": false,
@@ -639,6 +930,11 @@
         {
           "name": "language",
           "type": "\"de\" | \"en\" | \"fr\" | \"it\" | undefined",
+          "complexType": {
+            "original": "'de' | 'fr' | 'it' | 'en'",
+            "resolved": "\"de\" | \"en\" | \"fr\" | \"it\" | undefined",
+            "references": {}
+          },
           "mutable": false,
           "attr": "language",
           "reflectToAttr": false,
@@ -671,6 +967,11 @@
         {
           "name": "languageCookieKey",
           "type": "string | undefined",
+          "complexType": {
+            "original": "string",
+            "resolved": "string | undefined",
+            "references": {}
+          },
           "mutable": false,
           "attr": "language-cookie-key",
           "reflectToAttr": false,
@@ -690,6 +991,11 @@
         {
           "name": "languageLocalStorageKey",
           "type": "string | undefined",
+          "complexType": {
+            "original": "string",
+            "resolved": "string | undefined",
+            "references": {}
+          },
           "mutable": false,
           "attr": "language-local-storage-key",
           "reflectToAttr": false,
@@ -710,6 +1016,17 @@
         {
           "name": "languageSwitchOverrides",
           "type": "IAvailableLanguage[] | string | undefined",
+          "complexType": {
+            "original": "string | IAvailableLanguage[]",
+            "resolved": "IAvailableLanguage[] | string | undefined",
+            "references": {
+              "IAvailableLanguage": {
+                "location": "import",
+                "path": "../../models/language.model",
+                "id": "src/models/language.model.ts::IAvailableLanguage"
+              }
+            }
+          },
           "mutable": false,
           "attr": "language-switch-overrides",
           "reflectToAttr": false,
@@ -732,6 +1049,11 @@
         {
           "name": "login",
           "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
           "mutable": false,
           "attr": "login",
           "reflectToAttr": false,
@@ -746,9 +1068,38 @@
           "optional": false,
           "required": false
         },
+        {
+          "name": "logoutUrl",
+          "type": "string | undefined",
+          "complexType": {
+            "original": "string",
+            "resolved": "string | undefined",
+            "references": {}
+          },
+          "mutable": false,
+          "attr": "logout-url",
+          "reflectToAttr": false,
+          "docs": "Override the logout-url provided by the portal config.",
+          "docsTags": [],
+          "values": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "undefined"
+            }
+          ],
+          "optional": true,
+          "required": false
+        },
         {
           "name": "meta",
           "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
           "mutable": false,
           "attr": "meta",
           "reflectToAttr": false,
@@ -766,6 +1117,17 @@
         {
           "name": "osFlyoutOverrides",
           "type": "NavMainEntity | string | undefined",
+          "complexType": {
+            "original": "string | NavMainEntity",
+            "resolved": "NavMainEntity | string | undefined",
+            "references": {
+              "NavMainEntity": {
+                "location": "import",
+                "path": "../../models/header.model",
+                "id": "src/models/header.model.ts::NavMainEntity"
+              }
+            }
+          },
           "mutable": false,
           "attr": "os-flyout-overrides",
           "reflectToAttr": false,
@@ -788,6 +1150,11 @@
         {
           "name": "project",
           "type": "string",
+          "complexType": {
+            "original": "string",
+            "resolved": "string",
+            "references": {}
+          },
           "mutable": false,
           "attr": "project",
           "reflectToAttr": false,
@@ -804,6 +1171,11 @@
         {
           "name": "search",
           "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
           "mutable": false,
           "attr": "search",
           "reflectToAttr": false,
@@ -821,6 +1193,11 @@
         {
           "name": "skiplinks",
           "type": "boolean",
+          "complexType": {
+            "original": "boolean",
+            "resolved": "boolean",
+            "references": {}
+          },
           "mutable": false,
           "attr": "skiplinks",
           "reflectToAttr": false,
@@ -838,6 +1215,17 @@
         {
           "name": "stickyness",
           "type": "\"full\" | \"main\" | \"minimal\" | \"none\"",
+          "complexType": {
+            "original": "StickynessOptions",
+            "resolved": "\"full\" | \"main\" | \"minimal\" | \"none\"",
+            "references": {
+              "StickynessOptions": {
+                "location": "import",
+                "path": "../../models/implementor.model",
+                "id": "src/models/implementor.model.ts::StickynessOptions"
+              }
+            }
+          },
           "mutable": false,
           "attr": "stickyness",
           "reflectToAttr": false,
@@ -873,6 +1261,17 @@
             "type": "Promise<string>",
             "docs": "string"
           },
+          "complexType": {
+            "signature": "() => Promise<'de' | 'fr' | 'it' | 'en' | string>",
+            "parameters": [],
+            "references": {
+              "Promise": {
+                "location": "global",
+                "id": "global::Promise"
+              }
+            },
+            "return": "Promise<string>"
+          },
           "signature": "getCurrentLanguage() => Promise<'de' | 'fr' | 'it' | 'en' | string>",
           "parameters": [],
           "docs": "Get the currently set language as a two letter string (\"de\", \"fr\" \"it\" or \"en\")",
@@ -889,6 +1288,11 @@
           "event": "headerLoaded",
           "detail": "void",
           "bubbles": true,
+          "complexType": {
+            "original": "void",
+            "resolved": "void",
+            "references": {}
+          },
           "cancelable": true,
           "composed": true,
           "docs": "Fires when the header has been rendered to the page.",
@@ -927,5 +1331,47 @@
         ]
       }
     }
-  ]
+  ],
+  "typeLibrary": {
+    "src/models/breadcrumbs.model.ts::IBreadcrumbItem": {
+      "declaration": "export interface IBreadcrumbItem {\n  text: string;\n  url: string;\n}",
+      "docstring": "",
+      "path": "src/models/breadcrumbs.model.ts"
+    },
+    "src/models/breadcrumbs.model.ts::IBreadcrumbOverlay": {
+      "declaration": "export interface IBreadcrumbOverlay {\n  id: string;\n  target: string;\n  closeText: string;\n  closeIcon: IIconConfig;\n  classes: string[];\n  additionalAttributes: any[];\n}",
+      "docstring": "",
+      "path": "src/models/breadcrumbs.model.ts"
+    },
+    "src/models/implementor.model.ts::StickynessOptions": {
+      "declaration": "export type StickynessOptions = 'none' | 'minimal' | 'main' | 'full';",
+      "docstring": "",
+      "path": "src/models/implementor.model.ts"
+    },
+    "src/models/general.model.ts::Environment": {
+      "declaration": "export type Environment = 'dev01' | 'dev02' | 'devs1' | 'test' | 'int01' | 'int02' | 'prod';",
+      "docstring": "",
+      "path": "src/models/general.model.ts"
+    },
+    "src/models/language.model.ts::IAvailableLanguage": {
+      "declaration": "export interface IAvailableLanguage {\n  lang: string;\n  text?: string;\n  title?: string;\n  url?: string;\n}",
+      "docstring": "",
+      "path": "src/models/language.model.ts"
+    },
+    "src/models/general.model.ts::ICustomConfig": {
+      "declaration": "export interface ICustomConfig {\n  de?: ILocalizedCustomConfig;\n  fr?: ILocalizedCustomConfig;\n  it?: ILocalizedCustomConfig;\n  en?: ILocalizedCustomConfig;\n}",
+      "docstring": "",
+      "path": "src/models/general.model.ts"
+    },
+    "src/models/header.model.ts::NavMainEntity": {
+      "declaration": "export interface NavMainEntity {\n  id?: string;\n  text: string;\n  title: string;\n  url: string;\n  isActive?: boolean;\n  isActiveOverride?: boolean;\n  noFlyout?: boolean;\n  flyout: FlyoutEntity[];\n}",
+      "docstring": "",
+      "path": "src/models/header.model.ts"
+    },
+    "src/models/header.model.ts::DropdownEvent": {
+      "declaration": "{ open: boolean; element: DropdownElement }",
+      "docstring": "",
+      "path": "src/models/header.model.ts"
+    }
+  }
 }