@govflanders/vl-widget-global-header-types 1.0.33 → 1.0.34

package/README.md

@@ -1,5 +1,3 @@
-# Global Header Widget types
-
 The **`@govflanders/vl-widget-global-header-types`** package provides TypeScript types and interfaces for interacting with the **Global Header Widget**. This widget is embedded in customer web pages and exposes a client object (`window.globalHeaderClient`) that allows for dynamic configuration and interaction with the global header.
 
 By using the types defined in this package, developers can ensure type-safe interactions with the widget while improving their development experience (DX) by utilizing autocompletion and built-in documentation.
@@ -105,142 +103,6 @@ The `window.globalHeaderClient` object offers several methods for interacting wi
 
 Checkout the [GlobalHeaderClient](./interfaces/GlobalHeaderClient.html) here to see how to use it.
 
-### getConfig(): Promise\<Config\>
-Retrieve the current widget configuration.
-
-### branding
-
-The `branding` object contains methods for interacting with branding configurations.
-
-- **getLevel(): Promise\<number\>**
-  Fetch the current branding level of the widget.
-
-- **setLevel(level: number): Promise\<boolean\>**
-  Set the branding level of the widget.
-
-- **getColor(colorKey: string): Promise\<string\>**
-  Fetch a specific branding color based on the provided color key.
-
-- **setColor(colorConfig: { key: string, value: string }): Promise\<boolean\>**
-  Set a specific branding color for the widget.
-
-- **getColors(): Promise\<BrandingConfigColors\>**
-  Fetch the entire set of branding colors.
-
-- **setColors(colors: BrandingConfigColors): Promise\<boolean\>**
-  Set multiple branding colors for the widget.
-
-- **getHost(): Promise\<Partial\<BrandingConfigHost\>\>**
-  Retrieve the host configuration for branding.
-
-- **setHost(host: BrandingConfigHost): Promise\<boolean\>**
-  Set the host branding configuration.
-
-- **getUmbrella(): Promise\<Partial\<BrandingConfigUmbrella\>\>**
-  Retrieve the umbrella configuration for branding.
-
-- **setUmbrella(umbrella: BrandingConfigUmbrella): Promise\<boolean\>**
-  Set the umbrella branding configuration.
-
-- **getVariables(): Promise\<Record\<string, string\>\>**
-  Fetch branding-related variables as a dictionary.
-
-### contact
-
-The `contact` object contains methods related to managing service points.
-
-- **setServicePoints(servicePoints: Translatable\<ServicePoints\>): Promise\<Translatable\<ServicePoints\>\>**
-  Update the service points displayed in the widget.
-
-- **getServicePoints(): Promise\<EnrichedServicePoints\>**
-  Fetch the current service points from the widget.
-
-- **resetServicePoints(): Promise\<boolean\>**
-  Reset the service points to the initial values defined in the widget’s configuration.
-
-- **open(): Promise\<boolean\>**
-	Opens the contact interface.
-
-- **close(): Promise\<boolean\>**
-	Closes the contact interface.
-
-- **toggle(): Promise\<boolean\>**
-	Toggles the visibility of the contact interface.
-
-- **isOpen(): Promise\<boolean\>**
-	Checks whether the contact interface is currently open.
-
-### accessMenu
-
-The `accessMenu` object contains methods for managing the access menu's links and profile.
-
-- **setProfile(profileConfig: Partial\<ProfileConfig\>): Promise\<boolean\>**
-  Set or update the profile configuration for the widget.
-
-- **getProfile(): Promise\<Partial\<ProfileConfig\>\>**
-  Retrieve the current profile configuration for the widget.
-
-- **setMainLinks(mainLinks: MainLink[]): Promise\<boolean\>**
-  Sets the main navigation links that are displayed within the widget. These links will only be visible for widgets that support sessions, and they are displayed only when the user is logged in.
-
-- **addApplicationMenuLink(link: ApplicationMenuLink): Promise\<ApplicationMenuLink[]\>**
-  Add a single link to the application menu.
-
-- **addApplicationMenuLinks(links: ApplicationMenuLink[]): Promise\<ApplicationMenuLink[]\>**
-  Add multiple links to the application menu.
-
-- **setApplicationMenuLinks(links: ApplicationMenuLink[]): Promise\<ApplicationMenuLink[]\>**
-  Replace all application menu links.
-
-### setNavigationEnabled(enabled: boolean): Promise\<boolean\>
-
-Enable or disable the host and branding navigation.
-
-### mount(element?: HTMLElement): Promise\<boolean\>
-
-The `mount` method allows you to control where the **Global Header Widget** is rendered on the page. There are two main ways to integrate the widget, depending on whether you want to manually control its placement or let it render automatically:
-
-1. **Using the 'entry' script**:
-   When you include the widget via the following script:
-
-   ```html
-   <script src="https://prod.widgets.burgerprofiel.vlaanderen.be/api/v2/widget/__global_header_id__/entry"></script>
-   ```
-
-   The widget is **not automatically rendered** on the page. Instead, you must call the `mount` method from the `window.globalHeaderClient` object to display it. This gives you control over where and when the widget is added. You can either:
-
-   - **Mount to a specific element**:
-     Pass an HTML element to the `mount` method to render the widget inside that element.
-
-     ```typescript
-     const element = document.getElementById('customHeader');
-     window.globalHeaderClient.mount(element);
-     ```
-
-   - **Mount without specifying an element**:
-     If no element is provided, the widget will automatically render at the top of the page.
-
-     ```typescript
-     window.globalHeaderClient.mount();
-     ```
-
-2. **Using the 'embed' script**:
-   If you use this script instead:
-
-   ```html
-   <script src="https://prod.widgets.burgerprofiel.vlaanderen.be/api/v2/widget/__global_header_id__/embed"></script>
-   ```
-
-   The widget will **automatically render** as a `<div>` at the location where the script is placed in the HTML. No additional action is needed to mount the widget in this case. For accessibility reasons, the header is marked with `role="banner"`. If you prefer not to include this role (e.g., to avoid multiple banner roles on a page), use the mount method described above with a `<div>` element.
-
-#### Return Value
-
-The `mount` method returns a promise that resolves to `true` if the widget was successfully mounted, or `false` otherwise.
-
-### unmount(): Promise\<boolean\>
-
-The `unmount` method unmounts the widget from the element it's mounted at.
-
 ## Migration guide: Upgrading from v4 to v5
 
 If you’re currently using version 4 of the Global Header Widget, please follow this guide to upgrade to version 5. This guide highlights the key changes and steps you need to take to ensure a smooth transition.
@@ -249,7 +111,7 @@ If you’re currently using version 4 of the Global Header Widget, please follow
 
 No more client library or polyfill scripts: In version 5, you no longer need to include any additional client library or polyfill script links in your HTML. Access to the `window.globalHeaderClient` object is automatically provided when you include either the entry script or the embed script.
 Action Required:
-- Remove any `<script>` tags that reference client libraries or polyfil libraries for the widget.
+- Remove any `<script>` tags that reference client libraries or polyfill libraries for the widget.
 - Ensure that either the entry script or the embed script is included in your HTML.
 
 ### 2. Eliminate installable packages

package/dist/client.d.ts

@@ -1,8 +1,3 @@
-import { Translatable } from './i18n';
-import { MainLink, ProfileConfig } from './access-menu';
-import { EnrichedServicePoints, ServicePoints } from './contact';
-import { BrandingConfigColors, BrandingConfigHost, BrandingConfigUmbrella, Config } from './config';
-import { ApplicationMenuLink } from './access-menu';
 /**
  * The `window.globalHeaderClient` object offers several methods for interacting with the widget.
  * Each method is typed and returns promises, making asynchronous operations easier to handle.
@@ -13,13 +8,13 @@ export interface GlobalHeaderClient {
          * Get the current service points
          * @returns A promise that resolves to the current service points
          */
-        getServicePoints: () => Promise<EnrichedServicePoints>;
+        getServicePoints: ClientMethods['getServicePoints'];
         /**
          * Set the service points
          * @param servicePoints The service points to set
          * @returns A promise that resolves to the set service points
          */
-        setServicePoints: (servicePoints: Translatable<ServicePoints>) => Promise<Translatable<ServicePoints>>;
+        setServicePoints: ClientMethods['setServicePoints'];
         /**
          * Reset the service points to the initial values from the configuration.
          *
@@ -29,27 +24,27 @@ export interface GlobalHeaderClient {
          *
          * @returns A promise that resolves when the service points have been reset.
          */
-        resetServicePoints: () => Promise<boolean>;
+        resetServicePoints: ClientMethods['resetServicePoints'];
         /**
          * Open the contact panel.
          * @returns A promise that resolves to true if the contact panel was opened.
          */
-        open: () => Promise<boolean>;
+        open: ClientMethods['openContact'];
         /**
          * Close the contact panel.
          * @returns A promise that resolves to true if the contact panel was closed.
          */
-        close: () => Promise<boolean>;
+        close: ClientMethods['closeContact'];
         /**
          * Toggle the contact panel.
          * @returns A promise that resolves to true if the contact panel is now open.
          */
-        toggle: () => Promise<boolean>;
+        toggle: ClientMethods['toggleContact'];
         /**
          * Check if the contact panel is open.
          * @returns A promise that resolves to true if the contact panel is open.
          */
-        isOpen: () => Promise<boolean>;
+        isOpen: ClientMethods['isContactOpen'];
     };
     accessMenu: {
         /**
@@ -57,125 +52,156 @@ export interface GlobalHeaderClient {
          * @param mainLinks The main links to set
          * @returns A promise that resolves to true if the main links were set, false otherwise
          */
-        setMainLinks: (mainLinks: Translatable<MainLink>[]) => Promise<boolean>;
+        setMainLinks: ClientMethods['setMainLinks'];
         /**
          * Add an application menu link
          * @param link The link to add
          * @returns A promise that resolves to the updated application menu
          */
-        addApplicationMenuLink: (link: ApplicationMenuLink) => Promise<ApplicationMenuLink[]>;
+        addApplicationMenuLink: ClientMethods['addApplicationMenuLink'];
         /**
          * Add multiple application menu links
          * @param links The links to add
          * @returns A promise that resolves to the updated application menu
          */
-        addApplicationMenuLinks: (links: ApplicationMenuLink[]) => Promise<ApplicationMenuLink[]>;
+        addApplicationMenuLinks: ClientMethods['addApplicationMenuLinks'];
         /**
          * Set the application menu links
          * @param links The links to set
          * @returns A promise that resolves to the updated application menu
          */
-        setApplicationMenuLinks: (links: ApplicationMenuLink[]) => Promise<ApplicationMenuLink[]>;
+        setApplicationMenuLinks: ClientMethods['setApplicationMenuLinks'];
         /**
          * Set the profile configuration
          * @param profileConfig The profile configuration to set
          * @returns A promise that resolves to true if the profile configuration was set, false otherwise
          */
-        setProfile: (profileConfig: Partial<ProfileConfig>) => Promise<boolean>;
+        setProfile: ClientMethods['setProfile'];
         /**
          * Get the profile configuration
          * @returns A promise that resolves to the current profile configuration
          */
-        getProfile: () => Promise<Partial<ProfileConfig>>;
+        getProfile: ClientMethods['getProfile'];
     };
     branding: {
         /**
          * Get the level of branding
          * @returns A promise that resolves to the branding level
          */
-        getLevel: () => Promise<number>;
+        getLevel: ClientMethods['getBrandingLevel'];
         /**
          * Set the branding level
          * @param level The level of branding to set
          * @returns A promise that resolves to true if the branding level was set
          */
-        setLevel: (level: number) => Promise<boolean>;
+        setLevel: ClientMethods['setBrandingLevel'];
         /**
          * Get the branding colors
          * @returns A promise that resolves to the branding colors
          */
-        getColors: () => Promise<BrandingConfigColors>;
+        getColors: ClientMethods['getBrandingColors'];
         /**
          * Get a specific branding color by type
          * @param type The type of branding color to get
          * @returns A promise that resolves to the branding color
          */
-        getColor: (type: keyof BrandingConfigColors) => Promise<string>;
+        getColor: ClientMethods['getBrandingColor'];
         /**
          * Set the branding colors
          * @param colors The colors to set
          * @returns A promise that resolves to true if the branding colors were set
          */
-        setColors: (colors: BrandingConfigColors) => Promise<boolean>;
+        setColors: ClientMethods['setBrandingColors'];
         /**
          * Set a specific branding color by type
          * @param args The type of branding color and value to set
          * @returns A promise that resolves to true if the branding color was set
          */
-        setColor: (args: {
-            type: keyof BrandingConfigColors;
-            value: string;
-        }) => Promise<boolean>;
+        setColor: ClientMethods['setBrandingColor'];
         /**
          * Get the host context
          * @returns A promise that resolves to the branding host settings
          */
-        getHost: () => Promise<Partial<BrandingConfigHost>>;
+        getHost: ClientMethods['getBrandingHost'];
         /**
          * Set the host context
          * @param host The branding host settings to set
          * @returns A promise that resolves to true if the branding host was set
          */
-        setHost: (host: Partial<BrandingConfigHost>) => Promise<boolean>;
+        setHost: ClientMethods['setBrandingHost'];
         /**
          * Get the umbrella context
          * @returns A promise that resolves to the branding umbrella settings
          */
-        getUmbrella: () => Promise<Partial<BrandingConfigUmbrella>>;
+        getUmbrella: ClientMethods['getBrandingUmbrella'];
         /**
          * Set the umbrella context
          * @param umbrella The branding umbrella settings to set
          * @returns A promise that resolves to true if the branding umbrella was set
          */
-        setUmbrella: (umbrella: Partial<BrandingConfigUmbrella>) => Promise<boolean>;
+        setUmbrella: ClientMethods['setBrandingUmbrella'];
         /**
          * Get the branding CSS variables
          * @returns A promise that resolves to the branding CSS variables
          */
-        getVariables: () => Promise<Record<string, string>>;
+        getVariables: ClientMethods['getBrandingVariables'];
     };
     /**
      * Set the navigation enabled state
      * @param enabled The navigation enabled state
      * @returns A promise that resolves to true if the navigation enabled state was set, false otherwise
      */
-    setNavigationEnabled: (enabled: boolean) => Promise<boolean>;
+    setNavigationEnabled: ClientMethods['setNavigationEnabled'];
     /**
      * Get the current configuration
      * @returns A promise that resolves to the current configuration
      */
-    getConfig: () => Promise<Config>;
+    getConfig: ClientMethods['getConfig'];
     /**
-     * Mount an element
+     * The `mount` method allows you to control where the **Global Header Widget** is rendered on the page. There are two main ways to integrate the widget, depending on whether you want to manually control its placement or let it render automatically:
+     *
+     * 1. **Using the 'entry' script**:
+     *    When you include the widget via the following script:
+     *
+     *    ```html
+     *    <script src="https://prod.widgets.burgerprofiel.vlaanderen.be/api/v2/widget/__global_header_id__/entry"></script>
+     *    ```
+     *
+     *    The widget is **not automatically rendered** on the page. Instead, you must call the `mount` method from the `window.globalHeaderClient` object to display it. This gives you control over where and when the widget is added. You can either:
+     *
+     *    - **Mount to a specific element**:
+     *      Pass an HTML element to the `mount` method to render the widget inside that element.
+     *
+     *      ```typescript
+     *      const element = document.getElementById('customHeader');
+     *      window.globalHeaderClient.mount(element);
+     *      ```
+     *
+     *    - **Mount without specifying an element**:
+     *      If no element is provided, the widget will automatically render at the top of the page.
+     *
+     *      ```typescript
+     *      window.globalHeaderClient.mount();
+     *      ```
+     *
+     * 2. **Using the 'embed' script**:
+     *    If you use this script instead:
+     *
+     *    ```html
+     *    <script src="https://prod.widgets.burgerprofiel.vlaanderen.be/api/v2/widget/__global_header_id__/embed"></script>
+     *    ```
+     *
+     *    The widget will **automatically render** as a `<div>` at the location where the script is placed in the HTML. No additional action is needed to mount the widget in this case. For accessibility reasons, the header is marked with `role="banner"`. If you prefer not to include this role (e.g., to avoid multiple banner roles on a page), use the mount method described above with a `<div>` element.
+     *
      * @param element The element to mount
-     * @returns A promise that resolves to true if the element was mounted, false otherwise
+     * @returns A promise that resolves to `true` if the element was mounted, `false` otherwise
      */
-    mount: (element?: HTMLElement) => Promise<boolean>;
+    mount: ClientMethods['mount'];
     /**
      * Unmount an element
      * @returns A promise that resolves to true if the element was unmounted, false otherwise
      */
-    unmount: () => Promise<boolean>;
+    unmount: ClientMethods['unmount'];
 }
 declare global {
     interface Window {

package/docs/hierarchy.html

@@ -1 +1 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@govflanders/vl-widget-global-header-types</title><meta name="description" content="Documentation for @govflanders/vl-widget-global-header-types"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script><link rel="stylesheet" href="assets/typedoc-github-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@govflanders/vl-widget-global-header-types</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>@govflanders/vl-widget-global-header-types</h1></div><h2>Class Hierarchy</h2><ul class="tsd-full-hierarchy"><li><a id="Link" class="tsd-anchor"></a><a href="interfaces/Link.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>Link</a><ul><li><a id="LinkWithTarget" class="tsd-anchor"></a><a href="interfaces/LinkWithTarget.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>LinkWithTarget</a><ul><li><a id="BrandingConfigUmbrella" class="tsd-anchor"></a><a href="interfaces/BrandingConfigUmbrella.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>BrandingConfigUmbrella</a><ul></ul></li><li><a id="BrandingConfigHost" class="tsd-anchor"></a><a href="interfaces/BrandingConfigHost.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>BrandingConfigHost</a><ul></ul></li></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li><a id="ServicePoints" class="tsd-anchor"></a><a href="interfaces/ServicePoints.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>ServicePoints</a><ul><li><a id="EnrichedServicePoints" class="tsd-anchor"></a><a href="interfaces/EnrichedServicePoints.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>EnrichedServicePoints</a><ul></ul></li></ul></li></ul></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>@govflanders/vl-widget-global-header-types</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a> with <a href="https://github.com/KillerJulian/typedoc-github-theme" target="_blank">typedoc-github-theme</a></p></footer><div class="overlay"></div></body></html>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Global Header Client</title><meta name="description" content="Documentation for Global Header Client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">Global Header Client</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>Global Header Client</h1></div><h2>Class Hierarchy</h2><ul class="tsd-full-hierarchy"><li><a id="Link" class="tsd-anchor"></a><a href="interfaces/Link.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>Link</a><ul><li><a id="LinkWithTarget" class="tsd-anchor"></a><a href="interfaces/LinkWithTarget.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>LinkWithTarget</a><ul><li><a id="BrandingConfigUmbrella" class="tsd-anchor"></a><a href="interfaces/BrandingConfigUmbrella.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>BrandingConfigUmbrella</a><ul></ul></li><li><a id="BrandingConfigHost" class="tsd-anchor"></a><a href="interfaces/BrandingConfigHost.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>BrandingConfigHost</a><ul></ul></li></ul></li></ul></li></ul><ul class="tsd-full-hierarchy"><li><a id="ServicePoints" class="tsd-anchor"></a><a href="interfaces/ServicePoints.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>ServicePoints</a><ul><li><a id="EnrichedServicePoints" class="tsd-anchor"></a><a href="interfaces/EnrichedServicePoints.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-256"></use></svg>EnrichedServicePoints</a><ul></ul></li></ul></li></ul></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>Global Header Client</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>