@govflanders/vl-widget-global-header-types 0.0.1

package/dist/alert.d.ts

@@ -0,0 +1,6 @@
+export type AlertModifier = 'success' | 'warning' | 'error';
+export interface AlertConfig {
+    enabled: boolean;
+    message: string;
+    modifier: AlertModifier;
+}

package/dist/branding.d.ts

@@ -0,0 +1,24 @@
+import { I18n } from './i18n';
+import { Image } from './image';
+import { LinkWithTarget } from './link';
+/** Only required for level < 4 */
+export interface BrandingConfigUmbrella extends LinkWithTarget {
+}
+export interface BrandingConfigHost extends LinkWithTarget {
+    logo: Image | null;
+}
+/** Configure the branding colors, only for level < 1 */
+export interface BrandingConfigColors {
+    primary: string;
+    functional: string;
+}
+/** Configure the branding level. */
+export type BrandingConfigLevel = 1 | 2 | 3 | 4;
+export interface BrandingConfig {
+    allowOverride?: boolean;
+    level?: BrandingConfigLevel;
+    colors?: Partial<BrandingConfigColors>;
+    umbrella?: Partial<BrandingConfigUmbrella>;
+    host?: Partial<BrandingConfigHost>;
+    i18n?: I18n;
+}

package/dist/citizen-profile.d.ts

@@ -0,0 +1,39 @@
+import { Translatable } from './i18n';
+import { IDPData } from './idp';
+export type CapacityCode = 'BUR' | 'EA' | 'VER';
+export interface ProfileConfig {
+    active: boolean;
+    loginUrl: string;
+    loginRedirectUrl: string;
+    logoutUrl: string;
+    switchCapacityUrl: string;
+    idpData: IDPData;
+}
+export interface Session {
+    application: {
+        sessionSupport: boolean;
+    };
+}
+export interface Application {
+    isMainCapacity: boolean;
+    mainCapacityCode: CapacityCode;
+    name: string;
+}
+export interface CitizenProfileConfig {
+    pluginTypeId: 'citizen_profile';
+    session: Session;
+    application: Application;
+}
+export interface MainLink {
+    title: string;
+    href: string;
+    isExternal?: boolean;
+    target?: '_blank' | '_self' | '_parent' | '_top';
+}
+export interface ApplicationLink {
+    title: string;
+    href: string;
+    target?: string;
+    icon?: 'e-desk' | 'e-desk-lock';
+}
+export type ApplicationMenuLink = ApplicationLink | Translatable<ApplicationLink>;

package/dist/client.d.ts

@@ -0,0 +1,101 @@
+import { Translatable } from './i18n';
+import { MainLink, ProfileConfig } from './citizen-profile';
+import { EnrichedServicePoints, ServicePoints } from './contact';
+import { Config } from './config';
+import { ApplicationMenuLink } from './citizen-profile';
+export type Handlers = {
+    /**
+     * Get the current configuration
+     * @returns A promise that resolves to the current configuration
+     */
+    getConfig: Handler<undefined, Config>;
+    /**
+     * Set the service points
+     * @param servicePoints The service points to set
+     * @returns A promise that resolves to the set service points
+     */
+    setServicePoints: Handler<Translatable<ServicePoints>, Translatable<ServicePoints>>;
+    /**
+     * Get the current service points
+     * @returns A promise that resolves to the current service points
+     */
+    getServicePoints: Handler<undefined, EnrichedServicePoints>;
+    /**
+     * Reset the service points to the initial values from the configuration.
+     *
+     * This method reverts the service points back to their original state
+     * as defined in the initial configuration, effectively overriding any
+     * previously set service points.
+     *
+     * @return {Promise<this>}
+     *   A promise that resolves when the service points have been reset.
+     */
+    resetServicePoints: Handler<undefined, boolean>;
+    /**
+     * 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: Handler<ProfileConfig, boolean>;
+    /**
+     * Set the main links
+     * @param mainLinks The main links to set
+     * @returns A promise that resolves to true if the main links were set, false otherwise
+     */
+    setMainLinks: Handler<MainLink[], boolean>;
+    /**
+     * Add an application menu link
+     * @param link The link to add
+     * @returns A promise that resolves to the updated application menu
+     */
+    addApplicationMenuLink: Handler<ApplicationMenuLink, ApplicationMenuLink[]>;
+    /**
+     * Add multiple application menu links
+     * @param links The links to add
+     * @returns A promise that resolves to the updated application menu
+     */
+    addApplicationMenuLinks: Handler<ApplicationMenuLink[], ApplicationMenuLink[]>;
+    /**
+     * Set the application menu links
+     * @param links The links to set
+     * @returns A promise that resolves to the updated application menu
+     */
+    setApplicationMenuLinks: Handler<ApplicationMenuLink[], ApplicationMenuLink[]>;
+    /**
+     * Mount an element
+     * @param element The element to mount
+     * @returns A promise that resolves to true if the element was mounted, false otherwise
+     */
+    mount: Handler<HTMLElement | void, boolean>;
+};
+type PromiseResolver<T> = (value: T | PromiseLike<T>) => void;
+type PromiseRejecter = (reason?: any) => void;
+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;
+};
+export type GlobalHeaderClient = {
+    [K in keyof Handlers]: (args: ArgumentTypes[K]) => Promise<ReturnTypes[K]>;
+};
+export type QueueItem<Key extends keyof Handlers> = {
+    [K in keyof Handlers]: {
+        key: K;
+        args: ArgumentTypes[K];
+        resolve: PromiseResolver<ReturnTypes[K]>;
+        reject: PromiseRejecter;
+    };
+}[Key];
+export interface GlobalHeaderLinker {
+    queue: QueueItem<keyof Handlers>[];
+    update: () => void;
+}
+declare global {
+    interface Window {
+        globalHeaderClient: GlobalHeaderClient;
+        globalHeaderLinker: GlobalHeaderLinker;
+    }
+}
+export {};

package/dist/config.d.ts

@@ -0,0 +1,18 @@
+import { I18n } from './i18n';
+import { AlertConfig } from './alert';
+import { BrandingConfig } from './branding';
+export type PluginTypeId = 'contact' | 'citizen_profile';
+export interface Config {
+    branding: BrandingConfig;
+    alert: AlertConfig;
+    i18n?: I18n;
+    extensions: {
+        pluginTypeId: PluginTypeId;
+        i18n?: I18n;
+        [key: string]: string | number | object | undefined;
+    }[];
+}
+export * from './alert';
+export * from './branding';
+export * from './contact';
+export * from './citizen-profile';

package/dist/contact.d.ts

@@ -0,0 +1,140 @@
+export type CobrowseChannel = 'link-mobile' | 'chat';
+export interface CobrowseConfig {
+    isEnabled: boolean;
+    licenseKey?: string;
+    channels: CobrowseChannel[];
+    consent: CobrowseConsentConfig;
+}
+export interface CobrowseConsentConfig {
+    title: string;
+    htmlContent: string;
+}
+export type ContactServiceEndpoints = Partial<{
+    channels: string;
+    chatCsat: string;
+    sendEmail: string;
+    chatSocket: string;
+    requestCallMe: string;
+    sendMailFormDataMessage: string;
+}>;
+export interface ContactConfig {
+    pluginTypeId: 'contact';
+    cobrowse: CobrowseConfig;
+    defaultContext: string;
+    serviceEndpoints: ContactServiceEndpoints;
+}
+type ContactOptionType = 'contactOption';
+type LinkType = 'link';
+interface BaseOption {
+    type: ContactOptionType | LinkType;
+    label?: string;
+}
+export interface ContactOptionRef extends BaseOption {
+    type: ContactOptionType;
+    contactGroupId: string;
+}
+interface Link extends BaseOption {
+    type: LinkType;
+    href: string;
+    name?: string;
+}
+type DisplayMode = 'grouped';
+export type ServicePoint = ContactOption | ContactOptionRef | Link;
+export type EnrichedServicePoint = ContactOption | Link;
+export interface ServicePoints {
+    displayMode?: DisplayMode;
+    groupLabel?: string;
+    contextual?: ServicePoint[] | null;
+    defaults?: ServicePoint[] | null;
+}
+export interface EnrichedServicePoints extends ServicePoints {
+    contextual: EnrichedServicePoint[];
+    defaults: EnrichedServicePoint[];
+}
+export type ContactOptionSocialPlatform = 'facebook' | 'twitter' | 'instagram' | 'linkedin' | 'youtube' | 'x';
+export interface ContactOption extends Record<string, unknown> {
+    label: string;
+    key: string;
+    name: string;
+    about?: string;
+    ouapi_id?: string;
+    configCategory?: 'CONTACTOPTIES';
+    createdAt?: string;
+    lastModifiedAt?: string;
+    channels?: Channel[];
+    social?: {
+        description?: string;
+        media?: {
+            icon: ContactOptionSocialPlatform;
+            text?: string;
+            description?: string;
+            url: string;
+        }[];
+    };
+    subject?: string;
+    requestedBy?: string;
+    privacy?: ContactPrivacy;
+}
+interface ContactPrivacy {
+    gdpr: string;
+}
+export type ChannelIcon = 'call' | 'mail' | 'chat' | 'screen' | 'location';
+export type ChannelType = 'link-mobile' | 'form' | 'chat' | 'link' | 'location';
+export interface Channel {
+    id?: string;
+    name: string;
+    icon?: ChannelIcon;
+    type: ChannelType;
+    url?: string;
+    information?: string;
+    ouapi_contactline_id?: string;
+    value?: null | {
+        name: string;
+        address: string;
+        campaign: string;
+        workgroup: string;
+        information: string;
+        formId: string;
+        fields: {
+            type: string;
+            label: string;
+            attrs: {
+                name: string;
+                maxlength: number;
+                type: string;
+                placeholder: string;
+                required: string;
+            };
+        }[];
+    };
+    availability?: {
+        openInformation?: string;
+        closedInformation?: string;
+        exceptionallyClosedInformation?: string;
+        hours?: ContactOptionTimeSlot[][];
+        exceptions?: ContactOptionAvailabilityException[];
+        remark: string;
+    };
+    opening_hours?: {
+        is_open: boolean;
+    };
+}
+declare enum ContactOptionTimeSlotRemark {
+    OPEN = "OPEN",
+    APPOINTMENT = "APPOINTMENT",
+    PHONE = "PHONE",
+    DIGITAL = "DIGITAL",
+    OTHER = "OTHER"
+}
+interface ContactOptionTimeSlot {
+    from: string;
+    to: string;
+    remark?: ContactOptionTimeSlotRemark;
+    customRemark?: string;
+}
+interface ContactOptionAvailabilityException {
+    date?: string;
+    information?: string;
+    hours?: ContactOptionTimeSlot[];
+}
+export {};

package/dist/i18n.d.ts

@@ -0,0 +1,20 @@
+import { PluginTypeId } from './config';
+export type Language = 'nl' | 'fr' | 'de' | 'en';
+type LanguageTranslationsMap = Partial<Record<Language, RecursiveRecord>>;
+export interface Translations {
+    base: LanguageTranslationsMap;
+    extensions: Partial<Record<PluginTypeId, LanguageTranslationsMap>>;
+}
+export interface RecursiveRecord {
+    [key: string]: string | RecursiveRecord;
+}
+export interface ResolveOptions {
+    fallback?: string;
+    extension?: PluginTypeId;
+}
+export interface I18n {
+    default: Language;
+    translations: Partial<Record<Language, RecursiveRecord>>;
+}
+export type Translatable<T> = T | Record<Language, T>;
+export {};

package/dist/idp.d.ts

@@ -0,0 +1,39 @@
+interface BaseEntity {
+    code: 'BUR' | 'VER' | 'EA' | 'GID' | 'LB' | 'OV';
+    name: string;
+    identifier?: string;
+}
+interface GID extends BaseEntity {
+    code: 'GID';
+    /** identifier: ovoCode */
+    identifier: string;
+}
+interface VER extends BaseEntity {
+    code: 'VER';
+    vCode: string;
+}
+interface EA extends BaseEntity {
+    code: 'EA';
+    identifier: string;
+}
+interface BUR extends BaseEntity {
+    code: 'BUR';
+    name: string;
+    firstName: string;
+}
+interface User {
+    firstName: string;
+    name: string;
+}
+type Entity = BUR | GID | VER | EA;
+interface Authorization {
+    user: User;
+    onBehalfOff?: Entity;
+    mandateGiver?: Entity;
+    loginHint: string;
+}
+export interface IDPData {
+    active: Authorization;
+    identities: Authorization[];
+}
+export {};

package/dist/image.d.ts

@@ -0,0 +1,5 @@
+export interface Image {
+    readonly src?: string | null;
+    readonly srcSet?: string[] | null;
+    readonly alt: string;
+}

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export * from './alert';
+export * from './branding';
+export * from './citizen-profile';
+export * from './client';
+export * from './config';
+export * from './contact';
+export * from './i18n';
+export * from './idp';
+export * from './image';
+export * from './link';

package/dist/link.d.ts

@@ -0,0 +1,7 @@
+export interface Link {
+    readonly label: string;
+    readonly href: string;
+}
+export interface LinkWithTarget extends Link {
+    readonly target?: string | null;
+}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@govflanders/vl-widget-global-header-types",
+  "version": "0.0.1",
+  "description": "TypeScript definitions for GlobalHeaderClient",
+  "main": "",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "typescript",
+    "types",
+    "global",
+    "header",
+    "client"
+  ],
+  "author": "Maarten Van Steenkiste",
+  "license": "MIT",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "publish": "npm_config_registry=https://registry.npmjs.org/ npm publish --access public"
+  }
+}