@govflanders/vl-widget-global-header-types 1.0.20 → 1.0.22

package/README.md

@@ -100,37 +100,84 @@ client.setMainLinks([
 ```
 
 ## API
-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. Below is a detailed breakdown of each method, its parameters, and the expected return values.
+
+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. Below is a detailed breakdown of each method, its parameters, and the expected return values.
 
 ### getConfig(): Promise\<Config\>
 Retrieve the current widget configuration.
 
-### setServicePoints(servicePoints: Translatable\<ServicePoints\>): Promise\<Translatable\<ServicePoints\>\>
-Update the service points displayed in the widget.
+### 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.
 
-### getServicePoints(): Promise\<EnrichedServicePoints\>
-Fetch the current service points from the widget.
+- **getUmbrella(): Promise\<Partial\<BrandingConfigUmbrella\>\>**
+  Retrieve the umbrella configuration for branding.
 
-### resetServicePoints(): Promise\<boolean\>
-Reset the service points to the initial values defined in the widget’s configuration.
+- **setUmbrella(umbrella: BrandingConfigUmbrella): Promise\<boolean\>**
+  Set the umbrella branding configuration.
 
-### setProfile(profileConfig: Partial\<ProfileConfig\>): Promise\<boolean\>
-Set or update the profile configuration for the widget.
+- **getVariables(): Promise\<Record\<string, string\>\>**
+  Fetch branding-related variables as a dictionary.
 
-### 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.
+### contact
 
-### addApplicationMenuLink(link: ApplicationMenuLink): Promise\<ApplicationMenuLink[]\>
-Add a single link to the application menu.
+The `contact` object contains methods related to managing service points.
 
-### addApplicationMenuLinks(links: ApplicationMenuLink[]): Promise\<ApplicationMenuLink[]\>
-Add multiple links to the application menu.
+- **setServicePoints(servicePoints: Translatable\<ServicePoints\>): Promise\<Translatable\<ServicePoints\>\>**
+  Update the service points displayed in the widget.
 
-### setApplicationMenuLinks(links: ApplicationMenuLink[]): Promise\<ApplicationMenuLink[]\>
-Replace all application menu links.
+- **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.
+
+### 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.
+
+- **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
+
+Enable or disable the host and branding navigation.
 
 ### mount(element?: HTMLElement): Promise\<boolean\>
 

package/dist/citizen-profile.d.ts

@@ -23,7 +23,7 @@ export interface CitizenProfileConfig {
     pluginTypeId: 'citizen_profile';
     session: Session;
     application: Application;
-    applicationMenu?: ApplicationMenuLink[];
+    applicationMenu?: ApplicationLink[];
     mainLinks?: MainLink[];
 }
 export interface MainLink {

package/dist/client.d.ts

@@ -1,7 +1,7 @@
 import { Translatable } from './i18n';
 import { MainLink, ProfileConfig } from './citizen-profile';
 import { EnrichedServicePoints, ServicePoints } from './contact';
-import { Config } from './config';
+import { BrandingConfigColors, BrandingConfigHost, BrandingConfigUmbrella, Config } from './config';
 import { ApplicationMenuLink } from './citizen-profile';
 export type Handlers = {
     /**
@@ -67,6 +67,71 @@ export type Handlers = {
      * @returns A promise that resolves to true if the navigation enabled state was set, false otherwise
      */
     setNavigationEnabled: Handler<boolean, boolean>;
+    /**
+     * Get the level of branding
+     * @returns A promise that resolves to the branding level
+     */
+    getBrandingLevel: Handler<undefined, number>;
+    /**
+     * 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
+     */
+    setBrandingLevel: Handler<number, boolean>;
+    /**
+     * Get the branding colors
+     * @returns A promise that resolves to the branding colors
+     */
+    getBrandingColors: Handler<undefined, BrandingConfigColors>;
+    /**
+     * 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
+     */
+    getBrandingColor: Handler<keyof BrandingConfigColors, string>;
+    /**
+     * Set the branding colors
+     * @param colors The colors to set
+     * @returns A promise that resolves to true if the branding colors were set
+     */
+    setBrandingColors: Handler<BrandingConfigColors, boolean>;
+    /**
+     * Set a specific branding color by type
+     * @param type The type of branding color to set
+     * @param value The color value to set
+     * @returns A promise that resolves to true if the branding color was set
+     */
+    setBrandingColor: Handler<{
+        type: keyof BrandingConfigColors;
+        value: string;
+    }, boolean>;
+    /**
+     * Get the host context
+     * @returns A promise that resolves to the branding host settings
+     */
+    getBrandingHost: Handler<undefined, Partial<BrandingConfigHost>>;
+    /**
+     * 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
+     */
+    setBrandingHost: Handler<Partial<BrandingConfigHost>, boolean>;
+    /**
+     * Get the umbrella context
+     * @returns A promise that resolves to the branding umbrella settings
+     */
+    getBrandingUmbrella: Handler<undefined, Partial<BrandingConfigUmbrella>>;
+    /**
+     * 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
+     */
+    setBrandingUmbrella: Handler<Partial<BrandingConfigUmbrella>, boolean>;
+    /**
+     * Get the branding CSS variables
+     * @returns A promise that resolves to the branding CSS variables
+     */
+    getBrandingVariables: Handler<undefined, Record<string, string>>;
     /**
      * Mount an element
      * @param element The element to mount
@@ -83,7 +148,7 @@ type ArgumentTypes = {
 type ReturnTypes = {
     [HandlersKey in keyof Handlers]: Handlers[HandlersKey] extends Handler<any, infer Return> ? Return : never;
 };
-export type GlobalHeaderClient = {
+export type ClientMethods = {
     [K in keyof Handlers]: ArgumentTypes[K] extends undefined ? () => Promise<ReturnTypes[K]> : (args: ArgumentTypes[K]) => Promise<ReturnTypes[K]>;
 };
 export type QueueItem<Key extends keyof Handlers> = {
@@ -98,6 +163,36 @@ export interface GlobalHeaderLinker {
     queue: QueueItem<keyof Handlers>[];
     update: () => void;
 }
+export interface GlobalHeaderClient {
+    contact: {
+        getServicePoints: ClientMethods['getServicePoints'];
+        setServicePoints: ClientMethods['setServicePoints'];
+        resetServicePoints: ClientMethods['resetServicePoints'];
+    };
+    accessMenu: {
+        setMainLinks: ClientMethods['setMainLinks'];
+        addApplicationMenuLink: ClientMethods['addApplicationMenuLink'];
+        addApplicationMenuLinks: ClientMethods['addApplicationMenuLinks'];
+        setApplicationMenuLinks: ClientMethods['setApplicationMenuLinks'];
+        setProfile: ClientMethods['setProfile'];
+    };
+    branding: {
+        getLevel: ClientMethods['getBrandingLevel'];
+        setLevel: ClientMethods['setBrandingLevel'];
+        getColors: ClientMethods['getBrandingColors'];
+        getColor: ClientMethods['getBrandingColor'];
+        setColor: ClientMethods['setBrandingColor'];
+        setColors: ClientMethods['setBrandingColors'];
+        getHost: ClientMethods['getBrandingHost'];
+        setHost: ClientMethods['setBrandingHost'];
+        getUmbrella: ClientMethods['getBrandingUmbrella'];
+        setUmbrella: ClientMethods['setBrandingUmbrella'];
+        getVariables: ClientMethods['getBrandingVariables'];
+    };
+    setNavigationEnabled: ClientMethods['setNavigationEnabled'];
+    getConfig: ClientMethods['getConfig'];
+    mount: ClientMethods['mount'];
+}
 declare global {
     interface Window {
         globalHeaderClient: GlobalHeaderClient;

package/dist/idp.d.ts

@@ -30,7 +30,7 @@ interface Authorization {
     user: User;
     onBehalfOff?: Entity;
     mandateGiver?: Entity;
-    loginHint: string;
+    loginHint?: string;
 }
 export interface IDPData {
     active: Authorization;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@govflanders/vl-widget-global-header-types",
-  "version": "1.0.20",
+  "version": "1.0.22",
   "license": "MIT",
   "description": "TypeScript definitions for GlobalHeaderClient",
   "main": "",
@@ -27,6 +27,6 @@
     "release": "rm -rf dist && yarn build && yarn version --patch --no-git-tag-version && git add . && git commit -m \"Release global-header-types $(node -p \"require('./package.json').version\")\" && git tag \"global-header-types-$(node -p \"require('./package.json').version\")\" && git push && git push --tags && npm_config_registry=https://registry.npmjs.org/ npm publish --access public"
   },
   "dependencies": {
-    "@govflanders/vl-widget-shared": "^1.0.5"
+    "@govflanders/vl-widget-shared": "^1.0.6"
   }
 }