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

package/README.md

@@ -103,6 +103,8 @@ client.setMainLinks([
 
 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.
 
+Checkout the [GlobalHeaderClient](./interfaces/GlobalHeaderClient.html) here to see how to use it.
+
 ### getConfig(): Promise\<Config\>
 Retrieve the current widget configuration.
 
@@ -274,6 +276,7 @@ Action Required:
 Example:
 
 ```diff
+// Using widgets V4
 - vl.widget.client.capture(
 -   // Verplichte capture functie.
 -   function(widget) {
@@ -282,6 +285,7 @@ Example:
 -     }
 -   },
 - );
+// Using widgets V5
 + globalHeaderClient.contact.resetServicePoints();
 ```
 

package/dist/client.d.ts

@@ -3,215 +3,179 @@ import { MainLink, ProfileConfig } from './access-menu';
 import { EnrichedServicePoints, ServicePoints } from './contact';
 import { BrandingConfigColors, BrandingConfigHost, BrandingConfigUmbrella, Config } from './config';
 import { ApplicationMenuLink } from './access-menu';
-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<Partial<ProfileConfig>, boolean>;
-    /**
-     * Get the profile configuration
-     * @returns A promise that resolves to the current profile configuration
-     */
-    getProfile: Handler<undefined, Partial<ProfileConfig>>;
-    /**
-     * 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<Translatable<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[]>;
+/**
+ * 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.
+ */
+export interface GlobalHeaderClient {
+    contact: {
+        /**
+         * Get the current service points
+         * @returns A promise that resolves to the current service points
+         */
+        getServicePoints: () => Promise<EnrichedServicePoints>;
+        /**
+         * 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>>;
+        /**
+         * 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.
+         *
+         * @returns A promise that resolves when the service points have been reset.
+         */
+        resetServicePoints: () => Promise<boolean>;
+        /**
+         * Open the contact panel.
+         * @returns A promise that resolves to true if the contact panel was opened.
+         */
+        open: () => Promise<boolean>;
+        /**
+         * Close the contact panel.
+         * @returns A promise that resolves to true if the contact panel was closed.
+         */
+        close: () => Promise<boolean>;
+        /**
+         * Toggle the contact panel.
+         * @returns A promise that resolves to true if the contact panel is now open.
+         */
+        toggle: () => Promise<boolean>;
+        /**
+         * Check if the contact panel is open.
+         * @returns A promise that resolves to true if the contact panel is open.
+         */
+        isOpen: () => Promise<boolean>;
+    };
+    accessMenu: {
+        /**
+         * 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: (mainLinks: Translatable<MainLink>[]) => Promise<boolean>;
+        /**
+         * 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[]>;
+        /**
+         * 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[]>;
+        /**
+         * 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[]>;
+        /**
+         * 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>;
+        /**
+         * Get the profile configuration
+         * @returns A promise that resolves to the current profile configuration
+         */
+        getProfile: () => Promise<Partial<ProfileConfig>>;
+    };
+    branding: {
+        /**
+         * Get the level of branding
+         * @returns A promise that resolves to the branding level
+         */
+        getLevel: () => Promise<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
+         */
+        setLevel: (level: number) => Promise<boolean>;
+        /**
+         * Get the branding colors
+         * @returns A promise that resolves to the branding colors
+         */
+        getColors: () => Promise<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
+         */
+        getColor: (type: keyof BrandingConfigColors) => Promise<string>;
+        /**
+         * 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>;
+        /**
+         * 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>;
+        /**
+         * Get the host context
+         * @returns A promise that resolves to the branding host settings
+         */
+        getHost: () => Promise<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
+         */
+        setHost: (host: Partial<BrandingConfigHost>) => Promise<boolean>;
+        /**
+         * Get the umbrella context
+         * @returns A promise that resolves to the branding umbrella settings
+         */
+        getUmbrella: () => Promise<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
+         */
+        setUmbrella: (umbrella: Partial<BrandingConfigUmbrella>) => Promise<boolean>;
+        /**
+         * Get the branding CSS variables
+         * @returns A promise that resolves to the branding CSS variables
+         */
+        getVariables: () => Promise<Record<string, string>>;
+    };
     /**
      * 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: 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>;
+    setNavigationEnabled: (enabled: boolean) => Promise<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
+     * Get the current configuration
+     * @returns A promise that resolves to the current configuration
      */
-    getBrandingVariables: Handler<undefined, Record<string, string>>;
+    getConfig: () => Promise<Config>;
     /**
      * 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>;
+    mount: (element?: HTMLElement) => Promise<boolean>;
     /**
      * Unmount an element
      * @returns A promise that resolves to true if the element was unmounted, false otherwise
      */
-    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;
-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 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> = {
-    [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;
-}
-export interface GlobalHeaderClient {
-    contact: {
-        getServicePoints: ClientMethods['getServicePoints'];
-        setServicePoints: ClientMethods['setServicePoints'];
-        resetServicePoints: ClientMethods['resetServicePoints'];
-        open: ClientMethods['openContact'];
-        close: ClientMethods['closeContact'];
-        toggle: ClientMethods['toggleContact'];
-        isOpen: ClientMethods['isContactOpen'];
-    };
-    accessMenu: {
-        setMainLinks: ClientMethods['setMainLinks'];
-        addApplicationMenuLink: ClientMethods['addApplicationMenuLink'];
-        addApplicationMenuLinks: ClientMethods['addApplicationMenuLinks'];
-        setApplicationMenuLinks: ClientMethods['setApplicationMenuLinks'];
-        setProfile: ClientMethods['setProfile'];
-        getProfile: ClientMethods['getProfile'];
-    };
-    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'];
-    unmount: ClientMethods['unmount'];
+    unmount: () => Promise<boolean>;
 }
 declare global {
     interface Window {
@@ -219,4 +183,3 @@ declare global {
         globalHeaderLinker: GlobalHeaderLinker;
     }
 }
-export {};

package/docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

package/docs/assets/highlight.css

@@ -0,0 +1,120 @@
+:root {
+    --light-hl-0: #800000;
+    --dark-hl-0: #808080;
+    --light-hl-1: #800000;
+    --dark-hl-1: #569CD6;
+    --light-hl-2: #000000;
+    --dark-hl-2: #D4D4D4;
+    --light-hl-3: #E50000;
+    --dark-hl-3: #9CDCFE;
+    --light-hl-4: #0000FF;
+    --dark-hl-4: #CE9178;
+    --light-hl-5: #000000FF;
+    --dark-hl-5: #D4D4D4;
+    --light-hl-6: #001080;
+    --dark-hl-6: #9CDCFE;
+    --light-hl-7: #795E26;
+    --dark-hl-7: #DCDCAA;
+    --light-hl-8: #008000;
+    --dark-hl-8: #6A9955;
+    --light-hl-9: #A31515;
+    --dark-hl-9: #CE9178;
+    --light-hl-10: #0000FF;
+    --dark-hl-10: #569CD6;
+    --light-hl-11: #AF00DB;
+    --dark-hl-11: #C586C0;
+    --light-hl-12: #0070C1;
+    --dark-hl-12: #4FC1FF;
+    --light-hl-13: #267F99;
+    --dark-hl-13: #4EC9B0;
+    --light-code-background: #FFFFFF;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
+    --hl-11: var(--light-hl-11);
+    --hl-12: var(--light-hl-12);
+    --hl-13: var(--light-hl-13);
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
+    --hl-11: var(--dark-hl-11);
+    --hl-12: var(--dark-hl-12);
+    --hl-13: var(--dark-hl-13);
+    --code-background: var(--dark-code-background);
+} }
+
+:root[data-theme='light'] {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
+    --hl-11: var(--light-hl-11);
+    --hl-12: var(--light-hl-12);
+    --hl-13: var(--light-hl-13);
+    --code-background: var(--light-code-background);
+}
+
+:root[data-theme='dark'] {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
+    --hl-11: var(--dark-hl-11);
+    --hl-12: var(--dark-hl-12);
+    --hl-13: var(--dark-hl-13);
+    --code-background: var(--dark-code-background);
+}
+
+.hl-0 { color: var(--hl-0); }
+.hl-1 { color: var(--hl-1); }
+.hl-2 { color: var(--hl-2); }
+.hl-3 { color: var(--hl-3); }
+.hl-4 { color: var(--hl-4); }
+.hl-5 { color: var(--hl-5); }
+.hl-6 { color: var(--hl-6); }
+.hl-7 { color: var(--hl-7); }
+.hl-8 { color: var(--hl-8); }
+.hl-9 { color: var(--hl-9); }
+.hl-10 { color: var(--hl-10); }
+.hl-11 { color: var(--hl-11); }
+.hl-12 { color: var(--hl-12); }
+.hl-13 { color: var(--hl-13); }
+pre, code { background: var(--code-background); }

package/docs/assets/icons.js

@@ -0,0 +1,18 @@
+(function() {
+    addIcons();
+    function addIcons() {
+        if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons);
+        const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg"));
+        svg.innerHTML = `<g id="icon-1" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-module)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">M</text></g><g id="icon-2" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-module)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">M</text></g><g id="icon-4" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">N</text></g><g id="icon-8" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">E</text></g><g id="icon-16" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-property)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">P</text></g><g id="icon-32" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">V</text></g><g id="icon-64" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">F</text></g><g id="icon-128" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">C</text></g><g id="icon-256" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">I</text></g><g id="icon-512" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-constructor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">C</text></g><g id="icon-1024" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-property)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">P</text></g><g id="icon-2048" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-method)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">M</text></g><g id="icon-4096" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">F</text></g><g id="icon-8192" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-property)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">P</text></g><g id="icon-16384" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-constructor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">C</text></g><g id="icon-32768" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-property)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">P</text></g><g id="icon-65536" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">T</text></g><g id="icon-131072" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">T</text></g><g id="icon-262144" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-accessor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">A</text></g><g id="icon-524288" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-accessor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">A</text></g><g id="icon-1048576" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-accessor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">A</text></g><g id="icon-2097152" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">T</text></g><g id="icon-4194304" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-reference)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">R</text></g><g id="icon-8388608" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-document)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><g stroke="var(--color-icon-text)" fill="none" stroke-width="1.5"><polygon points="6,5 6,19 18,19, 18,10 13,5"></polygon><line x1="9" y1="9" x2="13" y2="9"></line><line x1="9" y1="12" x2="15" y2="12"></line><line x1="9" y1="15" x2="15" y2="15"></line></g></g><g id="icon-folder" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-document)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><g stroke="var(--color-icon-text)" fill="none" stroke-width="1.5"><polygon points="5,5 10,5 12,8 19,8 19,18 5,18"></polygon></g></g><g id="icon-chevronDown" class="tsd-no-select"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-icon-text)"></path></g><g id="icon-chevronSmall" class="tsd-no-select"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-icon-text)"></path></g><g id="icon-checkbox" class="tsd-no-select"><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></g><g id="icon-menu" class="tsd-no-select"><rect x="1" y="3" width="14" height="2" fill="var(--color-icon-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-icon-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-icon-text)"></rect></g><g id="icon-search" class="tsd-no-select"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-icon-text)"></path></g><g id="icon-anchor" class="tsd-no-select"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></g>`;
+        svg.style.display = "none";
+        if (location.protocol === "file:") updateUseElements();
+    }
+
+    function updateUseElements() {
+        document.querySelectorAll("use").forEach(el => {
+            if (el.getAttribute("href").includes("#icon-")) {
+                el.setAttribute("href", el.getAttribute("href").replace(/.*#/, "#"));
+            }
+        });
+    }
+})()

package/docs/assets/icons.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg"><g id="icon-1" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-module)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">M</text></g><g id="icon-2" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-module)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">M</text></g><g id="icon-4" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">N</text></g><g id="icon-8" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">E</text></g><g id="icon-16" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-property)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">P</text></g><g id="icon-32" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">V</text></g><g id="icon-64" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">F</text></g><g id="icon-128" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">C</text></g><g id="icon-256" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">I</text></g><g id="icon-512" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-constructor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">C</text></g><g id="icon-1024" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-property)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">P</text></g><g id="icon-2048" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-method)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">M</text></g><g id="icon-4096" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">F</text></g><g id="icon-8192" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-property)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">P</text></g><g id="icon-16384" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-constructor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">C</text></g><g id="icon-32768" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-property)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">P</text></g><g id="icon-65536" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">T</text></g><g id="icon-131072" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">T</text></g><g id="icon-262144" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-accessor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">A</text></g><g id="icon-524288" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-accessor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">A</text></g><g id="icon-1048576" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-accessor)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">A</text></g><g id="icon-2097152" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">T</text></g><g id="icon-4194304" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-reference)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><text fill="var(--color-icon-text)" x="50%" y="50%" dominant-baseline="central" text-anchor="middle">R</text></g><g id="icon-8388608" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-document)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><g stroke="var(--color-icon-text)" fill="none" stroke-width="1.5"><polygon points="6,5 6,19 18,19, 18,10 13,5"></polygon><line x1="9" y1="9" x2="13" y2="9"></line><line x1="9" y1="12" x2="15" y2="12"></line><line x1="9" y1="15" x2="15" y2="15"></line></g></g><g id="icon-folder" class="tsd-no-select"><rect fill="var(--color-icon-background)" stroke="var(--color-document)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><g stroke="var(--color-icon-text)" fill="none" stroke-width="1.5"><polygon points="5,5 10,5 12,8 19,8 19,18 5,18"></polygon></g></g><g id="icon-chevronDown" class="tsd-no-select"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-icon-text)"></path></g><g id="icon-chevronSmall" class="tsd-no-select"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-icon-text)"></path></g><g id="icon-checkbox" class="tsd-no-select"><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></g><g id="icon-menu" class="tsd-no-select"><rect x="1" y="3" width="14" height="2" fill="var(--color-icon-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-icon-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-icon-text)"></rect></g><g id="icon-search" class="tsd-no-select"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-icon-text)"></path></g><g id="icon-anchor" class="tsd-no-select"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></g></svg>