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

package/dist/access-menu.d.ts

@@ -1,12 +1,34 @@
 import { Translatable } from './i18n';
 import { IDPData } from './idp';
 export type CapacityCode = 'BUR' | 'EA' | 'VER';
+/**
+ * Represents the configuration for user profile and authentication settings.
+ */
 export interface ProfileConfig {
+    /**
+     * Indicates whether the website is logged in with the Identity Provider (IdP).
+     * Should be true when logged in, and false otherwise.
+     */
     active: boolean;
+    /**
+     * The URL where the sign-in button points to when clicked.
+     */
     loginUrl: string;
+    /**
+     * @deprecated This property is deprecated and should not be used anymore.
+     */
     loginRedirectUrl: string;
+    /**
+     * The URL where the sign-out button points to.
+     */
     logoutUrl: string;
+    /**
+     * The URL where the 'switch capacity' link points to.
+     */
     switchCapacityUrl: string;
+    /**
+     * Extra data from the Identity Provider (IdP) to enrich the header.
+     */
     idpData: IDPData;
 }
 export interface Session {

package/dist/alert.d.ts

@@ -1,6 +1,18 @@
 export type AlertModifier = 'success' | 'warning' | 'error';
+/**
+ * Represents the configuration for the alert bar displayed on top of the header widget.
+ */
 export interface AlertConfig {
+    /**
+     * Shows or hides the alert bar on top of the header widget.
+     */
     enabled: boolean;
+    /**
+     * The content of the alert. This can be an HTML string.
+     */
     message: string;
+    /**
+     * Changes the icon and color of the alert.
+     */
     modifier: AlertModifier;
 }

package/dist/client.d.ts

@@ -1,3 +1,80 @@
+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';
+/**
+ * @ignore
+ */
+export type Handlers = {
+    getConfig: Handler<undefined, Config>;
+    setServicePoints: Handler<Translatable<ServicePoints>, Translatable<ServicePoints>>;
+    getServicePoints: Handler<undefined, EnrichedServicePoints>;
+    resetServicePoints: Handler<undefined, boolean>;
+    setProfile: Handler<Partial<ProfileConfig>, boolean>;
+    getProfile: Handler<undefined, Partial<ProfileConfig>>;
+    setMainLinks: Handler<Translatable<MainLink>[], boolean>;
+    addApplicationMenuLink: Handler<ApplicationMenuLink, ApplicationMenuLink[]>;
+    addApplicationMenuLinks: Handler<ApplicationMenuLink[], ApplicationMenuLink[]>;
+    setApplicationMenuLinks: Handler<ApplicationMenuLink[], ApplicationMenuLink[]>;
+    setNavigationEnabled: Handler<boolean, boolean>;
+    getBrandingLevel: Handler<undefined, number>;
+    setBrandingLevel: Handler<number, boolean>;
+    getBrandingColors: Handler<undefined, BrandingConfigColors>;
+    getBrandingColor: Handler<keyof BrandingConfigColors, string>;
+    setBrandingColors: Handler<BrandingConfigColors, boolean>;
+    setBrandingColor: Handler<{
+        type: keyof BrandingConfigColors;
+        value: string;
+    }, boolean>;
+    getBrandingHost: Handler<undefined, Partial<BrandingConfigHost>>;
+    setBrandingHost: Handler<Partial<BrandingConfigHost>, boolean>;
+    getBrandingUmbrella: Handler<undefined, Partial<BrandingConfigUmbrella>>;
+    setBrandingUmbrella: Handler<Partial<BrandingConfigUmbrella>, boolean>;
+    getBrandingVariables: Handler<undefined, Record<string, string>>;
+    mount: Handler<HTMLElement | void, boolean>;
+    unmount: Handler<undefined, boolean>;
+    openContact: Handler<undefined, boolean>;
+    closeContact: Handler<undefined, boolean>;
+    toggleContact: Handler<undefined, boolean>;
+    isContactOpen: Handler<undefined, boolean>;
+};
+type PromiseResolver<T> = (value: T | PromiseLike<T>) => void;
+type PromiseRejecter = (reason?: any) => void;
+/**
+ * @ignore
+ */
+export type Handler<Args, Return> = (args: Args, resolve: PromiseResolver<Return>, reject: PromiseRejecter) => void;
+type ArgumentTypes = {
+    [HandlersKey in keyof Handlers]: Handlers[HandlersKey] extends Handler<infer Args, any> ? Args : never;
+};
+type ReturnTypes = {
+    [HandlersKey in keyof Handlers]: Handlers[HandlersKey] extends Handler<any, infer Return> ? Return : never;
+};
+/**
+ * @ignore
+ */
+export type ClientMethods = {
+    [K in keyof Handlers]: ArgumentTypes[K] extends undefined ? () => Promise<ReturnTypes[K]> : (args: ArgumentTypes[K]) => Promise<ReturnTypes[K]>;
+};
+/**
+ * @ignore
+ */
+export type QueueItem<Key extends keyof Handlers> = {
+    [K in keyof Handlers]: {
+        key: K;
+        args: ArgumentTypes[K];
+        resolve: PromiseResolver<ReturnTypes[K]>;
+        reject: PromiseRejecter;
+    };
+}[Key];
+/**
+ * @ignore
+ */
+export interface GlobalHeaderLinker {
+    queue: QueueItem<keyof Handlers>[];
+    update: () => void;
+}
 /**
  * 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.
@@ -209,3 +286,4 @@ declare global {
         globalHeaderLinker: GlobalHeaderLinker;
     }
 }
+export {};

package/docs/assets/typedoc-github-style.css

@@ -0,0 +1,435 @@
+/*
+ * Define colors
+ */
+
+:root {
+	/* GitHub "Light default" */
+	--light-color-background: #ffffff;
+	--light-color-background-secondary: #f6f8fa;
+	--light-color-background-navbar: #f6f8fa;
+
+	--light-color-accent: #d0d7de;
+
+	--light-color-text: #1f2328;
+	--light-color-text-aside: #636c76;
+
+	--light-color-link: #0969da;
+
+	--light-color-warning-border: #f7ebba;
+	--light-color-background-warning: #fff8c5;
+
+	/* GitHub "Dark default" */
+	--dark-color-background: #0d1117;
+	--dark-color-background-secondary: #161b22;
+	--dark-color-background-navbar: #000000;
+
+	--dark-color-accent: #30363d;
+
+	--dark-color-text: #e6edf3;
+	--dark-color-text-aside: #8d96a0;
+
+	--dark-color-link: #4493f8;
+
+	--dark-color-warning-border: #3a2d12;
+	--dark-color-background-warning: #282215;
+
+	/* Link colors */
+	--color-warning-text: var(--color-text);
+	--color-icon-background: var(--color-background);
+	--color-focus-outline: var(--color-accent);
+}
+
+@media (prefers-color-scheme: light) {
+	:root {
+		--color-background-navbar: var(--light-color-background-navbar);
+		--color-warning-border: var(--light-color-warning-border);
+	}
+}
+
+@media (prefers-color-scheme: dark) {
+	:root {
+		--color-background-navbar: var(--dark-color-background-navbar);
+		--color-warning-border: var(--dark-color-warning-border);
+	}
+}
+
+:root[data-theme='light'] {
+	--color-background-navbar: var(--light-color-background-navbar);
+	--color-warning-border: var(--light-color-warning-border);
+}
+
+:root[data-theme='dark'] {
+	--color-background-navbar: var(--dark-color-background-navbar);
+	--color-warning-border: var(--dark-color-warning-border);
+}
+
+/*
+ * Define fonts
+ */
+
+:root {
+	--font-family-text: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Noto Sans', Helvetica, Arial, sans-serif, 'Apple Color Emoji',
+		'Segoe UI Emoji';
+	--font-family-code: ui-monospace, SFMono-Regular, SF Mono, Menlo, Consolas, Liberation Mono, monospace;
+}
+
+body {
+	font-family: var(--font-family-text);
+}
+
+/*
+ * Headlines
+ */
+
+h1,
+h2,
+h3,
+h4,
+h5,
+h6 {
+	margin-top: 1em;
+	margin-bottom: 0.5em;
+}
+
+/*
+ * Links
+ */
+
+a,
+.tsd-kind-class {
+	color: var(--color-link);
+	text-decoration: underline;
+}
+
+.tsd-index-link {
+	text-decoration: none;
+}
+
+.tsd-index-link:hover {
+	text-decoration: underline;
+}
+
+.tsd-sources a {
+	color: var(--color-link);
+}
+
+/*
+ * Lists
+ */
+
+ul,
+ol {
+	margin-left: 20px;
+	list-style: disc;
+}
+
+li::marker {
+	color: var(--color-accent);
+}
+
+/*
+ * Input fields
+ */
+
+input {
+	background-color: var(--color-background-secondary);
+	color: var(--color-text);
+	border: 1px solid var(--color-accent);
+	border-radius: 6px;
+	padding: 8px;
+	width: 100%;
+}
+
+/*
+ * Tables
+ */
+
+table {
+	margin: 1em 0;
+}
+
+.tsd-typography th,
+.tsd-typography td {
+	padding: 8px;
+	text-align: left;
+}
+
+.tsd-typography th {
+	background-color: var(--color-background);
+	color: var(--color-text);
+}
+
+.tsd-typography tr:nth-child(2n) {
+	background-color: var(--color-background-code);
+}
+
+/*
+ * Horizontal line
+ */
+
+.tsd-typography hr {
+	color: var(--color-accent);
+}
+
+/*
+ * Buttons
+ */
+
+button {
+	background-color: var(--color-background-navbar);
+	color: var(--color-text);
+	border: 1px solid var(--color-accent);
+	border-radius: 6px;
+	padding: 8px 16px;
+	cursor: pointer;
+	transition: background-color 0.1s ease-in-out;
+}
+
+button:hover {
+	background-color: var(--color-accent);
+}
+
+pre > button {
+	background-color: transparent;
+	transition: background-color 0.1s ease-in-out;
+	border: none;
+	opacity: 1;
+	top: 8px;
+	padding: 4px 8px;
+}
+
+/*
+ * Checkbox
+ */
+
+.tsd-filter-input input[type='checkbox'],
+.tsd-filter-input svg {
+	width: 1em;
+	height: 1em;
+}
+
+.tsd-filter-input svg {
+	border-radius: 2px;
+}
+
+.tsd-checkbox-background {
+	fill: var(--color-background);
+	stroke: var(--color-accent);
+	stroke-width: 6px;
+}
+
+input[type='checkbox']:checked ~ svg .tsd-checkbox-background {
+	fill: var(--color-accent);
+}
+
+.tsd-checkbox-checkmark {
+	color: var(--color-text);
+}
+
+/*
+ * Select
+ */
+
+select {
+	background-color: var(--color-background);
+	border: 1px solid var(--color-accent);
+	border-radius: 6px;
+	padding: 8px;
+	font-family: inherit;
+}
+
+/*
+ * Code blocks
+ */
+
+code,
+pre {
+	border: none;
+	border-radius: 6px;
+	margin: 1em 0;
+	background-color: var(--color-background-secondary);
+	color: var(--color-text);
+	font-family: var(--font-family-code);
+}
+
+code.tsd-tag {
+	background-color: var(--color-accent);
+	border: unset;
+}
+
+/*
+ * Warnings
+ */
+
+.warning {
+	border-style: solid;
+	border-width: 1px;
+	border-color: var(--color-warning-border);
+	border-radius: 6px;
+}
+
+/*
+ * Topbar
+ */
+
+.tsd-page-toolbar {
+	background-color: var(--color-background-navbar);
+	border-bottom-color: var(--color-accent);
+}
+
+.tsd-page-toolbar a.title:hover {
+	text-decoration: none;
+}
+
+#tsd-search.has-focus {
+	background-color: var(--color-background-navbar);
+}
+
+#tsd-search .results,
+#tsd-search .results li,
+#tsd-search .results li:nth-child(2n) {
+	background-color: var(--color-background-navbar);
+}
+
+#tsd-search .results li {
+	margin-bottom: 0px;
+}
+
+#tsd-search .results li:hover:not(.no-results) {
+	background-color: var(--color-accent);
+}
+
+#tsd-search .results {
+	border-style: solid;
+	border-width: 1px;
+	border-color: var(--color-accent);
+	border-radius: 0px 0px 6px 6px;
+	overflow: hidden;
+}
+
+#tsd-search .results .no-results {
+	padding: calc(4px + 0.25rem);
+}
+
+/*
+ * Baseboard
+ */
+
+footer {
+	border-top-color: var(--color-accent);
+}
+
+/*
+ * Side navigations
+ */
+
+.site-menu {
+	padding: 1rem 0;
+}
+
+.tsd-navigation a {
+	color: var(--color-text);
+	border-radius: 6px;
+	padding: 6px;
+}
+
+.tsd-navigation a,
+.tsd-navigation a:hover {
+	text-decoration: none;
+}
+
+.tsd-navigation a:hover:not(.current) {
+	background-color: color-mix(in srgb, var(--color-text-aside), #0000 88%);
+}
+
+.tsd-navigation a.current {
+	background-color: color-mix(in srgb, var(--color-text-aside), #0000 92%);
+}
+
+/*
+ * Type definition groups
+ */
+
+.tsd-index-panel,
+.tsd-member-group {
+	background-color: var(--color-background);
+	padding: 16px;
+	border: 1px var(--color-accent) solid;
+	border-radius: 6px;
+}
+
+.tsd-panel > h1,
+.tsd-panel > h2,
+.tsd-panel > h3 {
+	margin-top: 0px;
+}
+
+.tsd-panel-group.tsd-index-group details {
+	margin: 0px;
+}
+
+.tsd-member-group .tsd-member:last-child {
+	margin-bottom: 0px;
+}
+
+.tsd-signature {
+	border: 1px solid var(--color-accent);
+	border-radius: 6px;
+}
+
+.tsd-signatures .tsd-signature {
+	border-color: var(--color-accent);
+	border-radius: 0px;
+}
+
+.tsd-description .tsd-signatures .tsd-signature {
+	border-radius: 6px;
+}
+
+.tsd-full-hierarchy:not(:last-child) {
+	border-bottom: var(--color-accent);
+}
+
+/*
+ * Footer
+ */
+
+footer p {
+	font-size: 1rem;
+	text-align: center;
+	color: var(--color-text-aside);
+}
+
+/*
+ * Fix collapsed margin
+ */
+
+.tsd-accordion-summary.tsd-index-summary > h5 {
+	margin-top: 0px;
+	margin-bottom: 0px;
+}
+
+.tsd-panel-group:not([open]) > .tsd-accordion-summary {
+	margin-bottom: 0px;
+}
+
+/*
+ * Fix collapse arrow position
+ */
+
+.tsd-accordion-summary:has(svg) > * {
+	display: inline-flex;
+	align-items: center;
+	line-height: normal;
+}
+
+.tsd-accordion-summary > * > svg {
+	padding-top: 0px;
+	position: relative;
+	left: 0px;
+	top: 50%;
+}
+
+.tsd-accordion-summary svg {
+	transition: transform 0.1s ease-in-out;
+}

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>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>
+<!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><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">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> with <a href="https://github.com/KillerJulian/typedoc-github-theme" target="_blank">typedoc-github-theme</a></p></footer><div class="overlay"></div></body></html>

package/docs/index.html

@@ -1,4 +1,4 @@
-<!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><div class="tsd-panel tsd-typography"><p>The <strong><code>@govflanders/vl-widget-global-header-types</code></strong> package provides TypeScript types and interfaces for interacting with the <strong>Global Header Widget</strong>. This widget is embedded in customer web pages and exposes a client object (<code>window.globalHeaderClient</code>) that allows for dynamic configuration and interaction with the global header.</p>
+<!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><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">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><div class="tsd-panel tsd-typography"><p>The <strong><code>@govflanders/vl-widget-global-header-types</code></strong> package provides TypeScript types and interfaces for interacting with the <strong>Global Header Widget</strong>. This widget is embedded in customer web pages and exposes a client object (<code>window.globalHeaderClient</code>) that allows for dynamic configuration and interaction with the global header.</p>
 <p>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.</p>
 <a id="md:adding-a-flanders-global-header-to-your-website" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Adding a Flanders Global Header to Your Website<a href="#md:adding-a-flanders-global-header-to-your-website" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>You can integrate the <strong>Flanders Global Header</strong> into your website using one of two methods: the <strong>entry script</strong> or the <strong>embed script</strong>. Each serves a different purpose:</p>
 <a id="md:1-using-the-entry-script" class="tsd-anchor"></a><h3 class="tsd-anchor-link">1. Using the Entry Script<a href="#md:1-using-the-entry-script" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>The entry script should be placed in the <code>&lt;head&gt;</code> section of your HTML, preferably at the top. This is essential because the <code>globalHeaderClient</code> object is only available after this script has loaded. With the entry script, the header does not render automatically, so you'll need to call the <code>mount</code> method to display it.</p>
@@ -115,4 +115,4 @@ Action Required:</p>
 <a id="md:maintainers" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Maintainers<a href="#md:maintainers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
 <li><a href="https://github.com/m44rten1" target="_blank" class="external">Maarten Van Steenkiste</a></li>
 </ul>
-</div></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><details open class="tsd-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:adding-a-flanders-global-header-to-your-website"><span>Adding a <wbr/>Flanders <wbr/>Global <wbr/>Header to <wbr/>Your <wbr/>Website</span></a><ul><li><a href="#md:1-using-the-entry-script"><span>1. <wbr/>Using the <wbr/>Entry <wbr/>Script</span></a></li><li><a href="#md:2-using-the-embed-script"><span>2. <wbr/>Using the <wbr/>Embed <wbr/>Script</span></a></li><li><a href="#md:summary"><span>Summary</span></a></li></ul><a href="#md:installation"><span>Installation</span></a><a href="#md:usage"><span>Usage</span></a><a href="#md:api"><span>API</span></a><a href="#md:migration-guide-upgrading-from-v4-to-v5"><span>Migration guide: <wbr/>Upgrading from v4 to v5</span></a><ul><li><a href="#md:1-remove-client-library-script-links"><span>1. <wbr/>Remove client library script links</span></a></li><li><a href="#md:2-eliminate-installable-packages"><span>2. <wbr/>Eliminate installable packages</span></a></li><li><a href="#md:3-update-embed-script-links"><span>3. <wbr/>Update <wbr/>Embed script links</span></a></li><li><a href="#md:4-update-api-usage"><span>4. <wbr/>Update API usage</span></a></li><li><a href="#md:5-accessing-windowglobalheaderclient"><span>5. <wbr/>Accessing window.global<wbr/>Header<wbr/>Client</span></a></li><li><a href="#md:6-verify-styling-and-rendering"><span>6. <wbr/>Verify <wbr/>Styling and <wbr/>Rendering</span></a></li></ul><a href="#md:notes"><span>Notes</span></a><ul><li><a href="#md:language-switching"><span>Language <wbr/>Switching</span></a></li><li><a href="#md:translatable-type"><span>Translatable <wbr/>Type</span></a></li><li><ul><li><a href="#md:example"><span>Example</span></a></li></ul></li></ul><a href="#md:browser-support"><span>Browser <wbr/>Support</span></a><a href="#md:contact-information"><span>Contact <wbr/>Information</span></a><a href="#md:maintainers"><span>Maintainers</span></a></div></details></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>
+</div></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><details open class="tsd-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:adding-a-flanders-global-header-to-your-website"><span>Adding a <wbr/>Flanders <wbr/>Global <wbr/>Header to <wbr/>Your <wbr/>Website</span></a><ul><li><a href="#md:1-using-the-entry-script"><span>1. <wbr/>Using the <wbr/>Entry <wbr/>Script</span></a></li><li><a href="#md:2-using-the-embed-script"><span>2. <wbr/>Using the <wbr/>Embed <wbr/>Script</span></a></li><li><a href="#md:summary"><span>Summary</span></a></li></ul><a href="#md:installation"><span>Installation</span></a><a href="#md:usage"><span>Usage</span></a><a href="#md:api"><span>API</span></a><a href="#md:migration-guide-upgrading-from-v4-to-v5"><span>Migration guide: <wbr/>Upgrading from v4 to v5</span></a><ul><li><a href="#md:1-remove-client-library-script-links"><span>1. <wbr/>Remove client library script links</span></a></li><li><a href="#md:2-eliminate-installable-packages"><span>2. <wbr/>Eliminate installable packages</span></a></li><li><a href="#md:3-update-embed-script-links"><span>3. <wbr/>Update <wbr/>Embed script links</span></a></li><li><a href="#md:4-update-api-usage"><span>4. <wbr/>Update API usage</span></a></li><li><a href="#md:5-accessing-windowglobalheaderclient"><span>5. <wbr/>Accessing window.global<wbr/>Header<wbr/>Client</span></a></li><li><a href="#md:6-verify-styling-and-rendering"><span>6. <wbr/>Verify <wbr/>Styling and <wbr/>Rendering</span></a></li></ul><a href="#md:notes"><span>Notes</span></a><ul><li><a href="#md:language-switching"><span>Language <wbr/>Switching</span></a></li><li><a href="#md:translatable-type"><span>Translatable <wbr/>Type</span></a></li><li><ul><li><a href="#md:example"><span>Example</span></a></li></ul></li></ul><a href="#md:browser-support"><span>Browser <wbr/>Support</span></a><a href="#md:contact-information"><span>Contact <wbr/>Information</span></a><a href="#md:maintainers"><span>Maintainers</span></a></div></details></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> with <a href="https://github.com/KillerJulian/typedoc-github-theme" target="_blank">typedoc-github-theme</a></p></footer><div class="overlay"></div></body></html>