@xyd-js/core 0.1.0-build.170

package/dist/index.d.ts

@@ -0,0 +1,1553 @@
+import * as React from 'react';
+
+/**
+ * @todo rename to PageMeta
+ *
+ * Represents metadata for a content page.
+ * Usually used as md/mdx frontmatter.
+ *
+ */
+interface Metadata<P = void> {
+    /** The main title of the content - by default visible in navigation and page title */
+    title: string;
+    /** Title to display in the sidebar navigation */
+    sidebarTitle?: string;
+    /** Disply description for SEO purposes */
+    description?: string;
+    /**  Icon identifier for the navigation item */
+    icon?: string;
+    /** Layout type for the content display */
+    layout?: PageLayout;
+    /** Max depth for table of contents */
+    maxTocDepth?: number;
+    /** External URL for the content */
+    url?: string;
+    /**
+     * If false, hide the copy page button
+     */
+    copyPage?: boolean;
+    /**
+     * @internal
+     *
+     * The type of component to render this content with
+     */
+    component?: "docs" | "atlas" | "home" | "firstslide" | "bloghome" | "blogpost";
+    /**
+     * @internal
+     *
+     * Properties specific to the component type
+     */
+    componentProps?: P;
+    /**
+     * @internal
+     *
+     * Group for sidebar navigation
+    */
+    group?: string[];
+    /**
+     * Uniform for API Docs references
+     */
+    uniform?: PageMetaUniform;
+    /**
+     * @internal
+     *
+     * used for graphql references
+     */
+    graphql?: string;
+    /**
+     * @internal
+     *
+     * used for openapi references
+     */
+    openapi?: string;
+    /**
+     * If true, hide from navigation
+     */
+    hidden?: boolean;
+    /**
+     * Optional 'tocCard' for custom cards in the table of contents
+     *
+     * @example
+     * ```
+     * tocCard: {
+     *     link: "https://github.com/livesession/livesession-browser",
+     *     title: "Checkout the code",
+     *     description: "Check how to use the LiveSession Browser SDK",
+     *     icon: "github"
+     * }
+     * ```
+     */
+    tocCard?: TocCard | TocCard[];
+}
+interface TocCard {
+    /** 'link' to the card */
+    link: string;
+    /** 'title' of the card */
+    title: string;
+    /** 'description' of the card */
+    description: string;
+    /** 'icon' of the card */
+    icon?: string;
+}
+type PageMetaUniform = string | PageMetaUniformDetails;
+/**
+ * Uniform details allows to specify more options than just the path, for example eager loading
+ */
+type PageMetaUniformDetails = {
+    /**
+     * Path to the uniform file / url
+     */
+    path: string;
+    /**
+     * If true, the uniform will be eagerly loaded
+     */
+    eager?: boolean;
+};
+type MetadataMap<P = void> = {
+    [page: string]: Metadata<P>;
+};
+type PageLayout = "wide" | "page" | "reader";
+
+/**
+ * Interface representing all possible meta tags that can be used in HTML documents.
+ * This includes standard meta tags, Open Graph tags, Twitter cards, and various other
+ * specialized meta tags for different content types.
+ *
+ */
+interface MetaTags {
+    /** Standard meta tag for controlling search engine crawling and indexing
+     * @example "noindex"
+     */
+    robots: string;
+    /** Character encoding for the document
+     * @example "UTF-8"
+     */
+    charset: string;
+    /** Viewport settings for responsive design
+     * @example "width=device-width, initial-scale=1, maximum-scale=1"
+     */
+    viewport: string;
+    /** Brief description of the page content
+     * @example "Your page description"
+     */
+    description: string;
+    /** Keywords relevant to the page content
+     * @example "keyword, keyword2"
+     */
+    keywords: string;
+    /** Author of the page content
+     * @example "Author Name"
+     */
+    author: string;
+    /** Google-specific crawling instructions
+     * @example "index, follow"
+     */
+    googlebot: string;
+    /** Google-specific settings
+     * @example "notranslate"
+     */
+    google: string;
+    /** Google Search Console verification token
+     * @example "verification_token"
+     */
+    "google-site-verification": string;
+    /** Software used to generate the page
+     * @example "xyd"
+     */
+    generator: string;
+    /** Theme color for browser UI
+     * @example "#ffffff"
+     */
+    "theme-color": string;
+    /** Color scheme preference
+     * @example "light"
+     */
+    "color-scheme": string;
+    /** Format detection settings
+     * @example "telephone=no"
+     */
+    "format-detection": string;
+    /** Referrer policy
+     * @example "origin"
+     */
+    referrer: string;
+    /** Page refresh settings
+     * @example "0;url=https://example.com"
+     */
+    refresh: string;
+    /** Content rating
+     * @example "general"
+     */
+    rating: string;
+    /** Crawl frequency suggestion
+     * @example "7 days"
+     */
+    "revisit-after": string;
+    /** Page language
+     * @example "en-US"
+     */
+    language: string;
+    /** Copyright information
+     * @example "Copyright 2024"
+     */
+    copyright: string;
+    /** Reply-to email address
+     * @example "contact@example.com"
+     */
+    "reply-to": string;
+    /** Content distribution scope
+     * @example "global"
+     */
+    distribution: string;
+    /** Content coverage area
+     * @example "Worldwide"
+     */
+    coverage: string;
+    /** Content category
+     * @example "Technology"
+     */
+    category: string;
+    /** Target audience
+     * @example "all"
+     */
+    target: string;
+    /** Mobile device compatibility
+     * @example "true"
+     */
+    HandheldFriendly: string;
+    /** Mobile optimization settings
+     * @example "width"
+     */
+    MobileOptimized: string;
+    /** iOS web app capability
+     * @example "yes"
+     */
+    "apple-mobile-web-app-capable": string;
+    /** iOS status bar style
+     * @example "black"
+     */
+    "apple-mobile-web-app-status-bar-style": string;
+    /** iOS web app title
+     * @example "App Name"
+     */
+    "apple-mobile-web-app-title": string;
+    /** Web application name
+     * @example "My App"
+     */
+    "application-name": string;
+    /** Windows tile color
+     * @example "#2b5797"
+     */
+    "msapplication-TileColor": string;
+    /** Windows tile image
+     * @example "/mstile-144x144.png"a
+     */
+    "msapplication-TileImage": string;
+    /** Windows browser config
+     * @example "/browserconfig.xml"
+     */
+    "msapplication-config": string;
+    /** Open Graph title
+     * @example "Page Title"
+     */
+    "og:title": string;
+    /** Open Graph content type
+     * @example "website"
+     */
+    "og:type": string;
+    /** Open Graph URL
+     * @example "https://example.com"
+     */
+    "og:url": string;
+    /** Open Graph image
+     * @example "https://example.com/image.jpg"
+     */
+    "og:image": string;
+    /** Open Graph description
+     * @example "A brief description for social media"
+     */
+    "og:description": string;
+    /** Open Graph site name
+     * @example "Site Name"
+     */
+    "og:site_name": string;
+    /** Open Graph locale
+     * @example "en_US"
+     */
+    "og:locale": string;
+    /** Open Graph video
+     * @example "https://example.com/video.mp4"
+     */
+    "og:video": string;
+    /** Open Graph audio
+     * @example "https://example.com/audio.mp3"
+     */
+    "og:audio": string;
+    /** Twitter card type
+     * @example "summary"
+     */
+    "twitter:card": string;
+    /** Twitter site handle
+     * @example "@username"
+     */
+    "twitter:site": string;
+    /** Twitter creator handle
+     * @example "@author"
+     */
+    "twitter:creator": string;
+    /** Twitter title
+     * @example "Page Title"
+     */
+    "twitter:title": string;
+    /** Twitter description
+     * @example "A brief description for Twitter"
+     */
+    "twitter:description": string;
+    /** Twitter image
+     * @example "https://example.com/image.jpg"
+     */
+    "twitter:image": string;
+    /** Twitter image alt text
+     * @example "Image description"
+     */
+    "twitter:image:alt": string;
+    /** Twitter player URL
+     * @example "https://example.com/player"
+     */
+    "twitter:player": string;
+    /** Twitter player width
+     * @example "480"
+     */
+    "twitter:player:width": string;
+    /** Twitter player height
+     * @example "480"
+     */
+    "twitter:player:height": string;
+    /** Twitter iOS app name
+     * @example "App Name"
+     */
+    "twitter:app:name:iphone": string;
+    /** Twitter iOS app ID
+     * @example "123456789"
+     */
+    "twitter:app:id:iphone": string;
+    /** Twitter iOS app URL
+     * @example "app://"
+     */
+    "twitter:app:url:iphone": string;
+    /** Article publication time
+     * @example "2024-03-20T12:00:00Z"
+     */
+    "article:published_time": string;
+    /** Article modification time
+     * @example "2024-03-21T15:30:00Z"
+     */
+    "article:modified_time": string;
+    /** Article expiration time
+     * @example "2024-04-20T12:00:00Z"
+     */
+    "article:expiration_time": string;
+    /** Article author
+     * @example "John Doe"
+     */
+    "article:author": string;
+    /** Article section
+     * @example "Technology"
+     */
+    "article:section": string;
+    /** Article tags
+     * @example "Web Development"
+     */
+    "article:tag": string;
+    /** Book author
+     * @example "Jane Smith"
+     */
+    "book:author": string;
+    /** Book ISBN
+     * @example "978-3-16-148410-0"
+     */
+    "book:isbn": string;
+    /** Book release date
+     * @example "2024-01-01"
+     */
+    "book:release_date": string;
+    /** Book tags
+     * @example "Fiction"
+     */
+    "book:tag": string;
+    /** Profile first name
+     * @example "John"
+     */
+    "profile:first_name": string;
+    /** Profile last name
+     * @example "Doe"
+     */
+    "profile:last_name": string;
+    /** Profile username
+     * @example "johndoe"
+     */
+    "profile:username": string;
+    /** Profile gender
+     * @example "male"
+     */
+    "profile:gender": string;
+    /** Music duration in seconds
+     * @example "180"
+     */
+    "music:duration": string;
+    /** Music album name
+     * @example "Album Name"
+     */
+    "music:album": string;
+    /** Music album disc number
+     * @example "1"
+     */
+    "music:album:disc": string;
+    /** Music album track number
+     * @example "1"
+     */
+    "music:album:track": string;
+    /** Music musician/artist
+     * @example "Artist Name"
+     */
+    "music:musician": string;
+    /** Music song name
+     * @example "Song Name"
+     */
+    "music:song": string;
+    /** Music song disc number
+     * @example "1"
+     */
+    "music:song:disc": string;
+    /** Music song track number
+     * @example "1"
+     */
+    "music:song:track": string;
+    /** Video actor name
+     * @example "Actor Name"
+     */
+    "video:actor": string;
+    /** Video actor role
+     * @example "Character Name"
+     */
+    "video:actor:role": string;
+    /** Video director
+     * @example "Director Name"
+     */
+    "video:director": string;
+    /** Video writer
+     * @example "Writer Name"
+     */
+    "video:writer": string;
+    /** Video duration in seconds
+     * @example "120"
+     */
+    "video:duration": string;
+    /** Video release date
+     * @example "2024-01-01"
+     */
+    "video:release_date": string;
+    /** Video tags
+     * @example "Action"
+     */
+    "video:tag": string;
+    /** Video series name
+     * @example "Series Name"
+     */
+    "video:series": string;
+}
+
+type RawTheme = {
+    name?: string;
+    type?: string;
+    tokenColors?: ThemeSetting[];
+    colors?: {
+        [key: string]: string;
+    };
+    [key: string]: any;
+};
+type ThemeSetting = {
+    name?: string;
+    scope?: string | string[];
+    settings: {
+        fontStyle?: string;
+        foreground?: string;
+        background?: string;
+    };
+};
+declare const THEME_NAMES: readonly ["dark-plus", "dracula-soft", "dracula", "github-dark", "github-dark-dimmed", "github-from-css", "github-light", "light-plus", "material-darker", "material-default", "material-from-css", "material-lighter", "material-ocean", "material-palenight", "min-dark", "min-light", "monokai", "nord", "one-dark-pro", "poimandres", "slack-dark", "slack-ochin", "solarized-dark", "solarized-light"];
+type NamesTuple$1 = typeof THEME_NAMES;
+type StringTheme = NamesTuple$1[number];
+type Theme$1 = StringTheme | RawTheme;
+
+/**
+ * Main settings interface for the application
+ */
+interface Settings {
+    /** Theme configuration for the application */
+    theme?: Theme;
+    /** Navigation configuration */
+    navigation?: Navigation;
+    /** API Docs configuration */
+    api?: API;
+    /** Integrations configuration */
+    integrations?: Integrations;
+    /** Plugins configuration */
+    plugins?: Plugins;
+    /**
+     * SEO configuration
+     */
+    seo?: SEO;
+    /**
+     * @internal
+     *
+     * WebEditor configuration - building blocks for UI editing
+     */
+    webeditor?: WebEditor;
+    /**
+     *
+     *  Components configuration
+     */
+    components?: Components;
+    /** Engine configuration - advanced engine-like configuration */
+    engine?: Engine;
+    /**
+     * @internal
+     * Redirects configuration
+     */
+    redirects?: Redirects[];
+}
+/**
+ * Theme configuration that changes the look and feel of the project
+ */
+interface Theme {
+    /**
+     * A theme name.
+     */
+    readonly name: ThemePresetName | (string & {});
+    /**
+     * Path to logo image or object with path to "light" and "dark" mode logo images, and where the logo links to.
+     */
+    logo?: string | Logo | React.JSX.Element;
+    /**
+     * Font configuration for the theme.
+     */
+    fonts?: ThemeFont;
+    /**
+     * Path to the favicon image. For example: /path/to/favicon.svg
+     */
+    favicon?: string;
+    /**
+     * The iconify library setup.
+     */
+    icons?: Icons;
+    /**
+     * Appearance configuration for the theme.
+     */
+    appearance?: Appearance;
+    /**
+     * Writer configuration for the theme.
+     */
+    writer?: Writer;
+    /**
+     * Coder configuration for the theme, including options like syntax highlighting.
+     */
+    coder?: Coder;
+    /**
+     * Head configuration
+     */
+    head?: HeadConfig[];
+    /**
+     * Custom scripts to be added to the head of the every page.
+     * Paths are relative to the root of the project or absolute.
+     */
+    scripts?: Script[];
+}
+type ThemeFont = Font | Font[] | {
+    body?: Font | Font[];
+    coder?: Font | Font[];
+};
+interface Font {
+    /**
+     * The font family to use.
+     */
+    family?: string;
+    /**
+     * The font weight to use.
+     */
+    weight?: string;
+    /**
+     * The font src to use.
+     */
+    src?: string;
+    /**
+     * The font format to use.
+     */
+    format?: "woff2" | "woff" | "ttf";
+}
+/**
+ * Coder configuration for the theme, including options like syntax highlighting.
+ */
+interface Coder {
+    /**
+     * If `true` then code blocks will have line numbers by default.
+     */
+    lines?: boolean;
+    /**
+     * If `true` then code blocks will have a scrollbar by default.
+     */
+    scroll?: boolean;
+    /**
+     * Syntax highlighting configuration.
+     */
+    syntaxHighlight?: Theme$1;
+}
+interface Writer {
+    /**
+     * The maximum number of table of conten§ts levels.
+     */
+    maxTocDepth?: number;
+    /**
+     * Copy page button
+     */
+    copyPage?: boolean;
+}
+/**
+ * Appearance configuration for the theme.
+ */
+interface Appearance {
+    /**
+     * The default color scheme to use.
+     */
+    colorScheme?: "light" | "dark" | "os";
+    /**
+     * Colors configuration for the theme.
+     */
+    colors?: Colors;
+    /**
+     * CSS tokens for the theme.
+     */
+    cssTokens?: {
+        [token: string]: string;
+    };
+    /**
+     * Presets for the theme.
+     */
+    presets?: string[];
+    /**
+     * Logo appearance for the theme.
+     */
+    logo?: AppearanceLogo;
+    /**
+     * Search appearance for the theme.
+     */
+    search?: AppearanceSearch;
+    /**
+     * Header appearance for the theme.
+     */
+    header?: AppearanceHeader;
+    /**
+     * Tabs appearance for the theme.
+     */
+    tabs?: AppearanceTabs;
+    /**
+     * Sidebar appearance for the theme.
+     */
+    sidebar?: AppearanceSidebar;
+    /**
+     * Buttons appearance for the theme.
+     */
+    buttons?: AppearanceButtons;
+    /**
+     * Table appearance for the theme.
+     */
+    tables?: AppearanceTables;
+    /**
+     * Banner appearance for the theme.
+     */
+    banner?: AppearanceBanner;
+    /**
+     * Content appearance for the theme.
+     */
+    content?: AppearanceContent;
+    /**
+     * Footer appearance for the theme.
+     */
+    footer?: AppearanceFooter;
+}
+interface Colors {
+    /**
+     * The primary color of the theme.
+     */
+    primary: string;
+    /**
+     * The light color of the theme.
+     */
+    light?: string;
+    /**
+     * The dark color of the theme.
+     */
+    dark?: string;
+}
+interface AppearanceTabs {
+    /**
+     * The tabs to display in the header.
+     */
+    surface?: "center" | "sidebar";
+}
+/**
+ * AppearanceLogo configuration for the theme.
+ */
+interface AppearanceLogo {
+    /**
+     * If `true` then the logo will be displayed on the sidebar.
+     */
+    sidebar?: boolean | "mobile" | "desktop";
+    /**
+     * If `true` then the logo will be displayed on the header.
+     */
+    header?: boolean | "mobile" | "desktop";
+}
+interface AppearanceContent {
+    /**
+     * Content decorator for the theme.
+     */
+    contentDecorator?: "secondary";
+    /**
+     * If `true` then the breadcrumbs will be displayed.
+     */
+    breadcrumbs?: boolean;
+    /**
+     * If `true` then the section separator will be displayed.
+     */
+    sectionSeparator?: boolean;
+}
+interface AppearanceFooter {
+    /**
+     * The footer surface.
+     */
+    surface?: "page";
+}
+interface AppearanceSearch {
+    /**
+     * If `true` then the search bar will be displayed as a full width.
+     */
+    fullWidth?: boolean;
+    /**
+     * If `true` then the search bar will be displayed on the sidebar.
+     */
+    sidebar?: boolean | "mobile" | "desktop";
+    /**
+     * If `true` then the search bar will be displayed in the middle of the header.
+     */
+    middle?: boolean | "mobile" | "desktop";
+    /**
+     * If `true` then the search bar will be displayed on the right side of the header.
+     */
+    right?: boolean | "mobile" | "desktop";
+}
+interface AppearanceHeader {
+    /**
+     * If `true` then the header external links will display an external arrow.
+     */
+    externalArrow?: boolean;
+    /**
+     * If `right` then separator will be displayed on the right side of the header.
+     */
+    separator?: "right";
+    /**
+     * The type of the header.
+     */
+    type?: "classic" | "pad";
+    /**
+     * The button size of the header.
+     */
+    buttonSize?: "sm" | "md" | "lg";
+}
+interface AppearanceSidebar {
+    /**
+     * If `true` then the sidebar will display a scroll shadow.
+     */
+    externalArrow?: boolean;
+    /**
+     * If `true` then the sidebar will display a scroll shadow.
+     */
+    scrollShadow?: boolean;
+    /**
+     * The color of the sidebar scrollbar.
+     */
+    scrollbar?: "secondary";
+    /**
+     * The color of the sidebar scrollbar.
+     */
+    scrollbarColor?: string;
+    /**
+     * The transition behaviour of the sidebar scroll when navigating to a new page.
+     */
+    scrollTransition?: "smooth" | "instant";
+}
+interface AppearanceButtons {
+    rounded?: boolean | "lg" | "md" | "sm";
+}
+interface AppearanceTables {
+    /**
+     * The kind of the table.
+     */
+    kind?: "secondary";
+}
+interface AppearanceBanner {
+    /**
+     * If `true` then the banner will have fixed position (always visible).
+     */
+    fixed?: boolean;
+}
+/**
+ * Configuration type for head elements that can be added to the HTML head.
+ * Format: [tagName, attributes]
+ *
+ * @example: ['script', { src: 'https://example.com/script.js', defer: true }]
+ */
+type HeadConfig = [string, Record<string, string | boolean>, string?];
+type Script = string;
+/**
+ * Logo configuration interface
+ */
+interface Logo {
+    /** Path to the logo in light mode. For example: `/path/to/logo.svg` */
+    light?: string;
+    /** Path to the logo in dark mode. For example: `/path/to/logo.svg` */
+    dark?: string;
+    /** External href to when clicking on the logo */
+    href?: string;
+    /** The page to link to when clicking on the logo */
+    page?: string;
+}
+interface IconLibrary {
+    /** The iconify library name */
+    name: string;
+    /** The iconify library version */
+    version?: string;
+    /** The default iconify icon name */
+    default?: boolean;
+    /** Merge icons from the library into the default iconify library */
+    noprefix?: boolean;
+}
+interface Icons {
+    /** The iconify library */
+    library?: string | IconLibrary | (string | IconLibrary)[];
+}
+/** Available theme preset names */
+type ThemePresetName = "poetry" | "cosmo" | "opener" | "picasso";
+/** Search bar location options */
+type SearchType = "side" | "top";
+/**
+ * Navigation configuration interface
+ */
+interface Navigation {
+    /**
+     * Sidebar navigation - main navigation on the left side of the page.
+     */
+    sidebar: SidebarNavigation;
+    /**
+     * Tabs navigation - navigation through tabs.
+     */
+    tabs?: Tabs;
+    /**
+     * Sidebar dropdown navigation - navigation through dropdown in the sidebar.
+     */
+    sidebarDropdown?: SidebarDropdown;
+    /**
+     * Segments navigation - navigation elements visible only on specific routes.
+     */
+    segments?: Segment[];
+    /**
+     * Anchors navigation - fixed navigation, for anchor-like elements.
+     */
+    anchors?: Anchors;
+}
+type SidebarDropdown = NavigationItem[];
+/**
+ * Tabs configuration
+ */
+type Tabs = NavigationItem[];
+/**
+ * Sidebar navigation type
+ */
+type SidebarNavigation = (SidebarRoute | Sidebar | string)[];
+/**
+ * Sidebar route configuration
+ */
+interface SidebarRoute {
+    /** Route for this sidebar */
+    route: string;
+    /** The group of the route */
+    group?: string | false;
+    /** The id of the route */
+    id?: string;
+    /** Sidebar pages within this route or sub routes */
+    pages: Sidebar[] | SidebarRoute[];
+}
+/**
+ * Sidebar configuration
+ */
+interface Sidebar {
+    /** The name of the group */
+    group?: string | false;
+    /**
+     * The relative paths to the markdown files that will serve as pages.
+     * Note: groups are recursive, so to add a sub-folder add another group object in the page array.
+     */
+    pages?: PageURL[];
+    /**
+     * The icon of the group.
+     */
+    icon?: string;
+    /**
+     * The order of the group.
+     */
+    order?: Order;
+}
+type Order = 0 | -1 | {
+    after: string;
+} | {
+    before: string;
+};
+/**
+ * Page URL type
+ */
+type PageURL = string | VirtualPage | Sidebar;
+/**
+ * @internal
+ *
+ * Virtual page type
+ *
+ * Virtual pages are composition of pages, needed for templating e.g in uniform
+ *
+ * Example:
+ *
+ * {
+ *  pages: [0
+ *    ".xyd/.cache/.content/docs/rest/todo:docs/rest/todo",
+ *  ]
+ * }
+ *
+ * above will be rendered as docs/rest/todo.md using composition from xyd's `.content`
+ */
+type VirtualPage = string | {
+    /** The virtual page to use for the page */
+    virtual: string;
+    /** The page to use for the page */
+    page: string;
+    /** The template to use for the page */
+    templates?: string | string[];
+};
+/**
+ * Segment configuration
+ */
+interface Segment {
+    /** Route for this segment */
+    route: string;
+    /** Title of this segment */
+    title?: string;
+    /** Appearance of this segment. If 'sidebarDropdown' then show this segment as a dropdown in the sidebar if match. */
+    appearance?: "sidebarDropdown";
+    /** Items within this segment */
+    pages: NavigationItem[];
+}
+/**
+ * Core interface for navigation items
+ */
+interface NavigationItem {
+    /**
+     * The navigation item title
+     */
+    title?: string;
+    /**
+     * The navigation item description
+     */
+    description?: string;
+    /**
+     * The navigation page, if set it redirects to the page + matches based on routing
+     */
+    page?: string;
+    /**
+     * The navigation href, if set it redirects but does not match based on routing
+     */
+    href?: string;
+    /**
+     * The navigation item icon
+     */
+    icon?: string | React.ReactNode;
+}
+type NavigationItemButton = NavigationItem & {
+    button: "primary" | "secondary";
+};
+type NavigationItemSocial = NavigationItem & {
+    social: Social;
+};
+/**
+ * Anchor root configuration
+ */
+interface Anchors {
+    /** Header anchors */
+    header?: AnchorHeader[];
+    /** Sidebar anchors */
+    sidebar?: {
+        top?: NavigationItem[];
+        bottom?: NavigationItem[];
+    };
+}
+type AnchorHeader = NavigationItem | NavigationItemButton | NavigationItemSocial;
+/**
+ * WebEditor navigation item configuration
+ */
+type WebEditorNavigationItem = NavigationItem & Partial<JSONComponent> & {
+    /**
+     * If `true` then the item will be displayed on mobile.
+     */
+    mobile?: boolean;
+    /**
+     * If `true` then the item will be displayed on desktop.
+     */
+    desktop?: boolean;
+};
+interface Components {
+    /**
+     * WebEditor banner configuration
+     */
+    banner?: WebEditorBanner;
+    /**
+     * WebEditor footer configuration
+     */
+    footer?: WebEditorFooter;
+}
+/**
+ * WebEditor configuration
+ */
+interface WebEditor {
+    /**
+     * WebEditor header configuration
+     */
+    sidebarTop?: WebEditorNavigationItem[];
+    /**
+     * WebEditor header configuration
+     */
+    header?: WebEditorHeader[];
+    /**
+     * WebEditor header configuration
+     */
+    subheader?: WebEditorSubHeader;
+}
+type Social = "x" | "facebook" | "youtube" | "discord" | "slack" | "github" | "linkedin" | "instagram" | "hackernews" | "medium" | "telegram" | "bluesky" | "reddit";
+interface WebEditorFooter {
+    kind?: "minimal";
+    logo?: boolean | ComponentLike;
+    /** Footer socials */
+    social?: {
+        [K in Social]?: string;
+    };
+    /** Footer links  */
+    links?: WebEditorFooterLinks;
+    /** Footer footnote */
+    footnote?: ComponentLike;
+}
+type WebEditorFooterLinks = WebEditorFooterLink[] | WebEditorFooterLinkItem[];
+interface WebEditorFooterLink {
+    header: string;
+    items: WebEditorFooterLinkItem[];
+}
+type WebEditorFooterLinkItem = {
+    label: string;
+    href: string;
+};
+interface WebEditorBanner {
+    /**
+     * Banner content.
+     */
+    content: ComponentLike;
+    /**
+     * Banner label.
+     */
+    label?: string;
+    /**
+     * Banner kind.
+     */
+    kind?: "secondary";
+    /**
+     * Banner href.
+     */
+    href?: string;
+    /**
+     * Banner icon.
+     */
+    icon?: string;
+}
+/**
+ * WebEditor header configuration
+ */
+type WebEditorHeader = WebEditorNavigationItem & {
+    /** Float the header to the right */
+    float?: "right" | "center";
+};
+/**
+ * WebEditorSubHeader header configuration
+ */
+interface WebEditorSubHeader {
+    /** Items of this subheader */
+    items: WebEditorNavigationItem[];
+    /** Title of this segment */
+    title?: string;
+}
+/**
+ * API Docs configuration interface
+ */
+interface API {
+    /**
+     * OpenAPI configuration
+     */
+    openapi?: APIFile;
+    /**
+     * GraphQL configuration
+     */
+    graphql?: APIFile;
+    /**
+     * Sources configuration
+     */
+    sources?: APIFile;
+}
+/**
+ * API file configuration. Can be a path, an array of paths, a map of paths, or an advanced configuration
+ */
+type APIFile = string | string[] | APIFileMap | APIFileAdvanced;
+/**
+ * API file map type
+ */
+type APIFileMap = {
+    [name: string]: string | APIFileAdvanced;
+};
+/**
+ * API file advanced type
+ */
+type APIFileAdvanced = {
+    /** API information configuration */
+    info?: APIInfo;
+    /** Route configuration */
+    route: string;
+};
+/**
+ * API file type - can be a string, array of strings, or a map of strings
+ */
+/**
+ * API information configuration
+ */
+interface APIInfo {
+    /**
+     * The base url for all API endpoints. If baseUrl is an array, it will enable
+     * for multiple base url options that the user can toggle.
+     */
+    baseUrl?: string;
+    /** Authentication information */
+    auth?: APIAuth;
+    /**
+     * The name of the authentication parameter used in the API playground.
+     * If method is basic, the format should be [usernameName]:[passwordName]
+     */
+    name?: string;
+    /**
+     * The default value that's designed to be a prefisx for the authentication input field.
+     * E.g. If an inputPrefix of AuthKey would inherit the default input result of the authentication field as AuthKey.
+     */
+    inputPrefix?: string;
+    /** Request configuration */
+    request?: APIInfoRequest;
+}
+/**
+ * API authentication configuration
+ */
+interface APIAuth {
+    /** The authentication strategy used for all API endpoints */
+    method: "bearer" | "basic" | "key";
+}
+/**
+ * API request configuration
+ */
+interface APIInfoRequest {
+    /** Configurations for the auto-generated API request examples */
+    example?: {
+        /**
+         * An array of strings that determine the order of the languages of the auto-generated request examples.
+         * You can either define custom languages utilizing x-codeSamples or use our default languages which include
+         * bash, python, javascript, php, go, java
+         */
+        languages?: string[];
+    };
+}
+/**
+ * Integrations configuration
+ */
+interface Integrations {
+    /**
+     * Configurations to add third-party analytics integrations.
+     * See full list of supported analytics here.
+     */
+    analytics?: IntegrationAnalytics;
+    /**
+     * Configurations to add third-party support integrations.
+     */
+    support?: IntegrationSupport;
+    /**
+     * Configurations to add third-party search integrations.
+     * See full list of supported search here.
+     */
+    search?: IntegrationSearch;
+    /**
+     * A/B testing configuration
+     */
+    abtesting?: IntegrationABTesting;
+    /**
+     * Diagrams configuration
+     */
+    diagrams?: boolean;
+    /**
+     * Custom apps directory.
+     */
+    [".apps"]?: AppsDirectory;
+}
+/**
+ * Analytics configuration
+ */
+interface IntegrationAnalytics {
+    /** Livesession analytics configuration */
+    livesession?: IntegrationAnalyticsLiveSession;
+}
+/**
+ * Livesession analytics configuration
+*/
+interface IntegrationAnalyticsLiveSession {
+    /** Livesession's TrackID */
+    trackId: string;
+}
+/**
+ * Support configuration
+ */
+interface IntegrationSupport {
+    /** Chatwoot support configuration */
+    chatwoot?: IntegrationSupportChatwoot;
+    /** Intercom support configuration */
+    intercom?: IntegrationSupportIntercom;
+    /** Livechat support configuration */
+    livechat?: IntegrationSupportLivechat;
+}
+/**
+ * Chatwoot support configuration
+ */
+interface IntegrationSupportChatwoot {
+    /** Chatwoot website token */
+    websiteToken: string;
+    /** Chatwoot base URL */
+    baseURL?: string;
+    /** Chatwoot settings */
+    chatwootSettings?: JSON;
+}
+/**
+ * Intercom support configuration
+ */
+interface IntegrationSupportIntercom {
+    /** Intercom app ID */
+    appId: string;
+    /** Intercom API base */
+    apiBase?: string;
+}
+interface IntegrationSupportLivechat {
+    /** Livechat license ID */
+    licenseId: string;
+}
+/**
+ * Search configuration
+ */
+interface IntegrationSearch {
+    /** Algolia search configuration */
+    algolia?: {
+        /** Algolia application ID */
+        appId: string;
+        /** Algolia API key */
+        apiKey: string;
+    };
+    orama?: {
+        /** Orama endpoint */
+        endpoint: string;
+        /** Orama API key */
+        apiKey: string;
+        /** Orama suggestions */
+        suggestions?: string[];
+    } | boolean;
+}
+/**
+ * A/B testing configuration
+ */
+interface IntegrationABTesting {
+    /**
+     * Context max age in milliseconds
+     */
+    contextMaxAge?: number;
+    /**
+     * Context storage key used to store the context in the browser storage
+     */
+    contextStorageKey?: string;
+    /**
+     * Providers configuration
+     */
+    providers?: IntegrationABTestingProviders;
+}
+interface IntegrationABTestingProviders {
+    /**
+     * GrowthBook configuration
+     */
+    growthbook?: IntegrationABTestingGrowthBook;
+    /**
+     * LaunchDarkly configuration
+     */
+    launchdarkly?: IntegrationABTestingLaunchDarkly;
+}
+interface IntegrationABTestingGrowthBook {
+    /**
+     * GrowthBook API host
+     */
+    apiHost: string;
+    /**
+     * GrowthBook client key
+     */
+    clientKey: string;
+}
+interface IntegrationABTestingLaunchDarkly {
+    /**
+     * LaunchDarkly environment key
+     */
+    env: string;
+}
+interface AppsDirectory {
+    /**
+     * Github star app configuration.
+     */
+    githubStar?: IntegrationAppGithubStar;
+    /**
+     * Supademo app configuration.
+     */
+    supademo?: IntegrationAppSupademo;
+}
+interface IntegrationAppGithubStar {
+    /**
+     * The title of the Github button
+     */
+    title: string;
+    /**
+     * The label of the Github Button
+     */
+    label?: string;
+    /**
+     * The href of the Github project
+     */
+    href: string;
+    /**
+     * The data-show-count of the Github project
+     */
+    dataShowCount?: boolean;
+    /**
+     * The data-icon of the Github button
+     */
+    dataIcon?: string;
+    /**
+     * The data-size of the Github button
+     */
+    dataSize?: string;
+    /**
+     * The aria-label of the Github button
+     */
+    ariaLabel?: string;
+}
+interface IntegrationAppSupademo {
+    /**
+     * The Supademo API key
+     */
+    apiKey: string;
+}
+/**
+ * Plugin configuration
+ *
+ * @example
+ * 1)
+ * {
+ *  plugins: [
+ *    "livesession",
+ *  ]
+ * }
+ *
+ * or 2)
+ * {
+ *  plugins: [
+ *    [
+ *      "livesession",
+ *      "accountID.websiteID",
+ *      {
+ *          keystrokes: true
+ *      }
+ *    ]
+ *  ]
+ * }
+ *
+ * @example [audience:dev]
+ * You can also use the type to define the plugin config in your code:
+ *
+ * const livesessionPlugin: PluginConfig<"livesession", [string, { keystrokes: boolean }]> = [
+ *    "livesession",
+ *    "accountID.websiteID",
+ *    {
+ *        keystrokes: true
+ *    }
+ * ]
+ */
+type Plugins = (string | PluginConfig)[];
+type PluginConfig<PluginName extends string = string, PluginArgs extends unknown[] = unknown[]> = [PluginName, ...PluginArgs];
+/**
+ * Redirects configuration
+ */
+interface Redirects {
+    /** Source path to redirect from */
+    source: string;
+    /** Destination path to redirect to */
+    destination: string;
+}
+/**
+ * SEO configuration
+ */
+interface SEO {
+    /**
+     * Domain name
+     */
+    domain?: string;
+    /**
+     * Meta tags
+     */
+    metatags?: {
+        [tag: string]: string;
+    };
+}
+/**
+ * Engine configuration
+ */
+interface Engine {
+    /**
+     * Path aliases for imports. Avoid long relative paths by creating shortcuts.
+     *
+     * @example
+     * ```json
+     * {
+     *   "paths": {
+     *     "@my-package/*": ["../my-package/src/*"],
+     *     "@livesession-go/*": ["https://github.com/livesession/livesession-go/*"]
+     *   }
+     * }
+     * ```
+     *
+     * Usage:
+     * ```typescript
+     * // Instead of
+     * @importCode("../../../my-package/src/components/Badge.tsx")
+     *
+     * // Use
+     * @importCode("@my-package/src/components/Badge.tsx")
+     * ```
+     */
+    paths?: EnginePaths;
+    /**
+     *
+     * Uniform configuration
+     *
+     */
+    uniform?: EngineUniform;
+}
+type EnginePaths = {
+    [key: string]: string[];
+};
+type EngineUniform = {
+    /**
+     * If `true` then virtual pages will not created and generated content will be stored on disk
+     */
+    store?: boolean;
+};
+/**
+ * JSON representation of a component.
+ */
+interface JSONComponent {
+    /**
+     * The component type, e.g. "Button", "Card", etc.
+     */
+    component: string;
+    /**
+     * The component's children, which can be a string, an array of strings, or an array of JSONComponent objects.
+     */
+    props?: Record<string, any>;
+}
+/**
+ * A type that can be used to represent a component-like structure.
+ */
+type ComponentLike = React.JSX.Element | JSONComponent | string;
+interface ThemeColors {
+    colorScheme: string;
+    foreground: string;
+    background: string;
+    lighter: {
+        inlineBackground: string;
+    };
+    editor: {
+        background: string;
+        foreground: string;
+        lineHighlightBackground: string;
+        rangeHighlightBackground: string;
+        infoForeground: string;
+        selectionBackground: string;
+    };
+    focusBorder: string;
+    tab: {
+        activeBackground: string;
+        activeForeground: string;
+        inactiveBackground: string;
+        inactiveForeground: string;
+        border: string;
+        activeBorder: string;
+        activeBorderTop: string;
+    };
+    editorGroup: {
+        border: string;
+    };
+    editorGroupHeader: {
+        tabsBackground: string;
+    };
+    editorLineNumber: {
+        foreground: string;
+    };
+    input: {
+        background: string;
+        foreground: string;
+        border: string;
+    };
+    icon: {
+        foreground: string;
+    };
+    sideBar: {
+        background: string;
+        foreground: string;
+        border: string;
+    };
+    list: {
+        activeSelectionBackground: string;
+        activeSelectionForeground: string;
+        hoverBackground: string;
+        hoverForeground: string;
+    };
+}
+interface UserPreferences {
+    themeColors?: ThemeColors;
+}
+
+export type { API, APIAuth, APIFile, APIFileAdvanced, APIFileMap, APIInfo, APIInfoRequest, AnchorHeader, Anchors, Appearance, AppearanceBanner, AppearanceButtons, AppearanceContent, AppearanceFooter, AppearanceHeader, AppearanceLogo, AppearanceSearch, AppearanceSidebar, AppearanceTables, AppearanceTabs, AppsDirectory, Coder, Colors, ComponentLike, Components, Engine, EnginePaths, EngineUniform, Font, HeadConfig, IconLibrary, Icons, IntegrationABTesting, IntegrationABTestingGrowthBook, IntegrationABTestingLaunchDarkly, IntegrationABTestingProviders, IntegrationAnalytics, IntegrationAnalyticsLiveSession, IntegrationAppGithubStar, IntegrationAppSupademo, IntegrationSearch, IntegrationSupport, IntegrationSupportChatwoot, IntegrationSupportIntercom, IntegrationSupportLivechat, Integrations, JSONComponent, Logo, MetaTags, Metadata, MetadataMap, Navigation, NavigationItem, NavigationItemButton, NavigationItemSocial, PageLayout, PageMetaUniform, PageMetaUniformDetails, PageURL, PluginConfig, Plugins, Redirects, SEO, Script, SearchType, Segment, Settings, Sidebar, SidebarDropdown, SidebarNavigation, SidebarRoute, Social, Tabs, Theme, ThemeColors, ThemeFont, ThemePresetName, TocCard, UserPreferences, VirtualPage, WebEditor, WebEditorBanner, WebEditorFooter, WebEditorFooterLink, WebEditorFooterLinkItem, WebEditorFooterLinks, WebEditorHeader, WebEditorNavigationItem, WebEditorSubHeader, Writer };