@govflanders/vl-widget-global-header-types 1.0.38 → 1.0.39

package/dist/access-menu.d.ts

@@ -1,5 +1,11 @@
-import { Translatable } from './i18n';
 import { IDPData } from './idp';
+/**
+ * Represents the capacity code for main e-desks.
+ * Possible values are:
+ * - `'BUR'`: Burgerprofiel
+ * - `'EA'`: eLoket Ondernemers
+ * - `'VER'`: Verenigingsloket
+ */
 export type CapacityCode = 'BUR' | 'EA' | 'VER';
 /**
  * Represents the configuration for user profile and authentication settings.
@@ -31,33 +37,105 @@ export interface ProfileConfig {
      */
     idpData: IDPData;
 }
+/**
+ * Represents the session information for the application.
+ */
 export interface Session {
+    /**
+     * Application-specific session details.
+     */
     application: {
+        /**
+         * Indicates whether the application supports session management.
+         * If `true`, a version of the header will be shown which allows the user to
+         * log in, log out, switch capacity, and more.
+         */
         sessionSupport: boolean;
     };
 }
+/**
+ * Holds application-specific settings.
+ */
 export interface Application {
+    /**
+     * Indicates whether the application is a main capacity application.
+     * This means the application is one of the following:
+     * - Burgerprofiel (`BUR`)
+     * - eLoket Ondernemers (`EA`)
+     * - Verenigingsloket (`VER`)
+     */
     isMainCapacity: boolean;
+    /**
+     * The main capacity code setting, which changes certain UI elements
+     * like the eLoket icon.
+     */
     mainCapacityCode: CapacityCode;
+    /**
+     * The application name shown at the top of the access menu.
+     */
     name: string;
 }
+/**
+ * @ignore
+ */
 export interface AccessMenuConfig {
     pluginTypeId: 'citizen_profile';
     session: Session;
     application: Application;
-    applicationMenu?: ApplicationLink[];
+    applicationMenu?: ApplicationMenuLink[];
     mainLinks?: MainLink[];
 }
+/**
+ * Represents a main link in the Access Menu.
+ * These are the links shown in the top section of the menu.
+ */
 export interface MainLink {
+    /**
+     * The text that will be shown.
+     */
     label: string;
+    /**
+     * The URL it links to.
+     */
     href: string;
+    /**
+     * If `true`, an 'external' icon will be shown next to the link
+     * to indicate it leads to an external site.
+     */
     isExternal?: boolean;
+    /**
+     * Specifies where to open the linked document.
+     * Possible values are:
+     * - `'_blank'`: Opens the link in a new window or tab.
+     * - `'_self'`: Opens the link in the same frame as it was clicked (default).
+     * - `'_parent'`: Opens the link in the parent frame.
+     * - `'_top'`: Opens the link in the full body of the window.
+     */
     target?: '_blank' | '_self' | '_parent' | '_top';
 }
-export interface ApplicationLink {
+/**
+ * Represents an application link displayed in the second section of the menu, under the main links.
+ */
+export interface ApplicationMenuLink {
+    /**
+     * The text that will be shown for the link.
+     */
     label: string;
+    /**
+     * The URL the link navigates to when clicked.
+     */
     href: string;
+    /**
+     * Specifies where to open the linked document, similar to the HTML `target` attribute.
+     * For example, `"_blank"` opens the link in a new tab.
+     */
     target?: string;
+    /**
+     * The icon to display next to the link.
+     * Possible values are:
+     * - `'e-desk'`: Displays the e-desk icon.
+     * - `'e-desk-lock'`: Displays the e-desk icon with a lock symbol on top.
+     * - `undefined` (not provided): No icon will be displayed.
+     */
     icon?: 'e-desk' | 'e-desk-lock';
 }
-export type ApplicationMenuLink = ApplicationLink | Translatable<ApplicationLink>;

package/dist/branding.d.ts

@@ -1,19 +1,48 @@
 import { I18n } from './i18n';
 import { Image } from './image';
 import { LinkWithTarget } from './link';
-/** Only required for level < 4 */
+/**
+ * Represents the link shown on the top left in the header.
+ * Only required for branding levels lower than 4.
+ */
 export interface BrandingConfigUmbrella extends LinkWithTarget {
 }
+/**
+ * Represents the host configuration shown to the right of the umbrella in the header (if an umbrella is available).
+ */
 export interface BrandingConfigHost extends LinkWithTarget {
+    /**
+     * The logo image to display at the right of the host.
+     * Can be an `Image` object or `null` if no logo is to be displayed.
+     */
     logo: Image | null;
 }
-/** Configure the branding colors, only for level < 1 */
+/**
+ * Configures the branding colors, only used for branding levels lower than 1.
+ */
 export interface BrandingConfigColors {
+    /**
+     * The primary color used for the background of the 'contact' plugin (located on the top right of the header).
+     */
     primary: string;
+    /**
+     * The functional color used for elements like buttons and links.
+     */
     functional: string;
 }
-/** Configure the branding level. */
+/**
+ * Configures the branding level.
+ *
+ * Branding levels are defined as:
+ * - `1`: Horizontale
+ * - `2`: Vertical
+ * - `3`: Verzelfstandigde agentschappen (Autonomous agencies)
+ * - `4`: Lokale besturen (Local governments)
+ */
 export type BrandingConfigLevel = 1 | 2 | 3 | 4;
+/**
+ * @ignore
+ */
 export interface BrandingConfig {
     allowOverride?: boolean;
     level?: BrandingConfigLevel;

package/dist/client.d.ts

@@ -14,9 +14,9 @@ export type Handlers = {
     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[]>;
+    addApplicationMenuLink: Handler<Translatable<ApplicationMenuLink>, Translatable<ApplicationMenuLink>[]>;
+    addApplicationMenuLinks: Handler<Translatable<ApplicationMenuLink>[], Translatable<ApplicationMenuLink>[]>;
+    setApplicationMenuLinks: Handler<Translatable<ApplicationMenuLink>[], Translatable<ApplicationMenuLink>[]>;
     setNavigationEnabled: Handler<boolean, boolean>;
     getBrandingLevel: Handler<undefined, number>;
     setBrandingLevel: Handler<number, boolean>;

package/dist/config.d.ts

@@ -1,7 +1,13 @@
 import { I18n } from './i18n';
 import { AlertConfig } from './alert';
 import { BrandingConfig } from './branding';
+/**
+ * @ignore
+ */
 export type PluginTypeId = 'contact' | 'citizen_profile';
+/**
+ * @ignore
+ */
 export interface Config {
     branding: BrandingConfig;
     alert: AlertConfig;

package/dist/contact.d.ts

@@ -1,93 +1,330 @@
+/**
+ * Represents the channel through which cobrowsing is initiated.
+ *
+ * Possible values are:
+ * - `'link-mobile'`: Cobrowse is shown next to a telephone link.
+ * - `'chat'`: Cobrowse is shown in the chat interface.
+ */
 export type CobrowseChannel = 'link-mobile' | 'chat';
+/**
+ * Configuration for the cobrowse functionality.
+ * @ignore
+ */
 export interface CobrowseConfig {
+    /**
+     * If `true`, cobrowse functionality will be enabled. If `false`, it will be hidden.
+     */
     isEnabled: boolean;
-    licenseKey?: string;
+    /**
+     * The cobrowse license key.
+     * For more information, refer to the documentation:
+     * {@link https://docs.cobrowse.io/sdk-installation/web#add-your-license-key Cobrowse SDK Installation}.
+     */
+    licenseKey: string;
+    /**
+     * An array of channels where cobrowse functionality is shown.
+     * Possible values are:
+     * - `'link-mobile'`: Shown next to a telephone link.
+     * - `'chat'`: Shown in the chat interface.
+     */
     channels: CobrowseChannel[];
+    /**
+     * An optional HTML string containing a custom consent text.
+     */
     consent: CobrowseConsentConfig;
 }
+/**
+ * Configuration for cobrowse consent.
+ * @ignore
+ */
 export interface CobrowseConsentConfig {
+    /**
+     * The title of the consent form.
+     */
     title: string;
+    /**
+     * The HTML content of the consent form.
+     */
     htmlContent: string;
 }
+/**
+ * Endpoints for the contact service.
+ */
 export type ContactServiceEndpoints = Partial<{
+    /**
+     * Endpoint for contact channels.
+     */
     channels: string;
+    /**
+     * Endpoint for chat satisfaction rating.
+     */
     chatCsat: string;
+    /**
+     * Endpoint to send an email.
+     */
     sendEmail: string;
+    /**
+     * WebSocket URL for chat.
+     */
     chatSocket: string;
+    /**
+     * Endpoint to request a callback.
+     */
     requestCallMe: string;
+    /**
+     * Endpoint to send mail form data.
+     */
     sendMailFormDataMessage: string;
 }>;
+/**
+ * Configuration for the contact plugin.
+ * @ignore
+ */
 export interface ContactConfig {
+    /**
+     * The type of plugin. Should always be `'contact'` for this configuration.
+     */
     pluginTypeId: 'contact';
+    /**
+     * Cobrowse configuration.
+     */
     cobrowse: CobrowseConfig;
+    /**
+     * The default context for the contact plugin.
+     */
     defaultContext: string;
+    /**
+     * The endpoints for the contact service.
+     */
     serviceEndpoints: ContactServiceEndpoints;
 }
+/**
+ * Represents a base option for contact or link types.
+ */
 type ContactOptionType = 'contactOption';
 type LinkType = 'link';
 interface BaseOption {
+    /**
+     * The type of the option, either a contact option or a link.
+     */
     type: ContactOptionType | LinkType;
+    /**
+     * The label for the option.
+     */
     label?: string;
 }
+/**
+ * Represents a reference to a contact option.
+ */
 export interface ContactOptionRef extends BaseOption {
+    /**
+     * Specifies that the option is a contact option.
+     */
     type: ContactOptionType;
+    /**
+     * The ID of the contact group associated with this option.
+     */
     contactGroupId: string;
 }
+/**
+ * Represents a link option.
+ */
 interface Link extends BaseOption {
+    /**
+     * Specifies that the option is a link.
+     */
     type: LinkType;
+    /**
+     * The URL the link points to.
+     */
     href: string;
+    /**
+     * The name of the link.
+     */
     name?: string;
 }
+/**
+ * Possible display modes for service points.
+ */
 type DisplayMode = 'grouped';
-export type ServicePoint = ContactOption | ContactOptionRef | Link;
 export type EnrichedServicePoint = ContactOption | Link;
+/**
+ * Represents a service point, either enriched or a contact option reference.
+ */
+export type ServicePoint = EnrichedServicePoint | ContactOptionRef;
+/**
+ * Configuration for service points.
+ */
 export interface ServicePoints {
+    /**
+     * The display mode for the service points.
+     */
     displayMode?: DisplayMode;
+    /**
+     * The label for the group of service points.
+     */
     groupLabel?: string;
+    /**
+     * The contextual service points.
+     */
     contextual?: ServicePoint[] | null;
+    /**
+     * The default service points.
+     */
     defaults?: ServicePoint[] | null;
 }
+/**
+ * Enriched version of the service points, ensuring that both `contextual` and `defaults` are non-null.
+ */
 export interface EnrichedServicePoints extends ServicePoints {
+    /**
+     * The contextual service points.
+     */
     contextual: EnrichedServicePoint[];
+    /**
+     * The default service points.
+     */
     defaults: EnrichedServicePoint[];
 }
+/**
+ * Social media platforms for contact options.
+ */
 export type ContactOptionSocialPlatform = 'facebook' | 'twitter' | 'instagram' | 'linkedin' | 'youtube' | 'x';
+/**
+ * Represents a contact option.
+ */
 export interface ContactOption extends Record<string, unknown> {
+    /**
+     * The label for the contact option.
+     */
     label: string;
+    /**
+     * The key associated with the contact option.
+     */
     key: string;
+    /**
+     * The name of the contact option.
+     */
     name: string;
+    /**
+     * Optional description or information about the contact option.
+     */
     about?: string;
+    /**
+     * Optional ID for API purposes.
+     */
     ouapi_id?: string;
+    /**
+     * The category for this configuration.
+     */
     configCategory?: 'CONTACTOPTIES';
+    /**
+     * Timestamp of when the contact option was created.
+     */
     createdAt?: string;
+    /**
+     * Timestamp of when the contact option was last modified.
+     */
     lastModifiedAt?: string;
+    /**
+     * Channels associated with the contact option.
+     */
     channels?: Channel[];
+    /**
+     * Social media links related to this contact option.
+     */
     social?: {
+        /**
+         * Optional description of the social media section.
+         */
         description?: string;
+        /**
+         * Array of social media links.
+         */
         media?: {
+            /**
+             * The social media platform.
+             */
             icon: ContactOptionSocialPlatform;
+            /**
+             * Optional text to describe the link.
+             */
             text?: string;
+            /**
+             * Optional description of the social media link.
+             */
             description?: string;
+            /**
+             * The URL of the social media link.
+             */
             url: string;
         }[];
     };
+    /**
+     * Subject of the contact option.
+     */
     subject?: string;
+    /**
+     * Person or entity requesting the contact option.
+     */
     requestedBy?: string;
+    /**
+     * Privacy settings related to the contact option.
+     */
     privacy?: ContactPrivacy;
 }
+/**
+ * Represents privacy settings for contact options.
+ */
 interface ContactPrivacy {
+    /**
+     * GDPR-related privacy information.
+     */
     gdpr: string;
 }
+/**
+ * Represents the icon types for channels.
+ */
 export type ChannelIcon = 'call' | 'mail' | 'chat' | 'screen' | 'location';
+/**
+ * Represents the type of a channel.
+ */
 export type ChannelType = 'link-mobile' | 'form' | 'chat' | 'link' | 'location';
+/**
+ * Represents a channel for communication.
+ */
 export interface Channel {
+    /**
+     * Optional ID of the channel.
+     */
     id?: string;
+    /**
+     * Name of the channel.
+     */
     name: string;
+    /**
+     * Optional icon representing the channel.
+     */
     icon?: ChannelIcon;
+    /**
+     * The type of channel.
+     */
     type: ChannelType;
+    /**
+     * Optional URL for the channel.
+     */
     url?: string;
+    /**
+     * Optional additional information about the channel.
+     */
     information?: string;
+    /**
+     * Optional contact line ID.
+     */
     ouapi_contactline_id?: string;
+    /**
+     * Optional structured information for forms or additional data.
+     */
     value?: null | {
         name: string;
         address: string;
@@ -107,6 +344,9 @@ export interface Channel {
             };
         }[];
     };
+    /**
+     * Availability details for the channel.
+     */
     availability?: {
         openInformation?: string;
         closedInformation?: string;
@@ -115,10 +355,16 @@ export interface Channel {
         exceptions?: ContactOptionAvailabilityException[];
         remark: string;
     };
+    /**
+     * Opening hours status for the channel.
+     */
     opening_hours?: {
         is_open: boolean;
     };
 }
+/**
+ * Remarks for contact option time slots.
+ */
 declare enum ContactOptionTimeSlotRemark {
     OPEN = "OPEN",
     APPOINTMENT = "APPOINTMENT",
@@ -126,15 +372,42 @@ declare enum ContactOptionTimeSlotRemark {
     DIGITAL = "DIGITAL",
     OTHER = "OTHER"
 }
+/**
+ * Represents a time slot for contact availability.
+ */
 interface ContactOptionTimeSlot {
+    /**
+     * Start time of the slot.
+     */
     from: string;
+    /**
+     * End time of the slot.
+     */
     to: string;
+    /**
+     * Optional remark associated with the time slot.
+     */
     remark?: ContactOptionTimeSlotRemark;
+    /**
+     * Optional custom remark for the time slot.
+     */
     customRemark?: string;
 }
+/**
+ * Represents an exception for contact option availability.
+ */
 interface ContactOptionAvailabilityException {
+    /**
+     * Date of the exception.
+     */
     date?: string;
+    /**
+     * Information related to the exception.
+     */
     information?: string;
+    /**
+     * Time slots for the exception.
+     */
     hours?: ContactOptionTimeSlot[];
 }
 export {};