@docusaurus/theme-classic 2.0.0-beta.8e9b829d9 → 2.0.0-beta.9

package/lib/types.d.ts

@@ -5,60 +5,93 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-/* eslint-disable import/no-duplicates */
-/* eslint-disable spaced-comment */
 /// <reference types="@docusaurus/module-type-aliases" />
 /// <reference types="@docusaurus/plugin-content-blog" />
 /// <reference types="@docusaurus/plugin-content-docs" />
 /// <reference types="@docusaurus/plugin-content-pages" />
 
+declare module '@docusaurus/theme-classic' {
+  export type Options = Partial<import('./index').PluginOptions>;
+}
+
 declare module '@theme/AnnouncementBar' {
   const AnnouncementBar: () => JSX.Element | null;
   export default AnnouncementBar;
 }
 
+declare module '@theme/BackToTopButton' {
+  export default function BackToTopButton(): JSX.Element;
+}
+
 declare module '@theme/BlogListPaginator' {
   import type {Metadata} from '@theme/BlogListPage';
 
-  export type Props = {readonly metadata: Metadata};
+  export interface Props {
+    readonly metadata: Metadata;
+  }
 
   const BlogListPaginator: (props: Props) => JSX.Element;
   export default BlogListPaginator;
 }
 
 declare module '@theme/BlogPostItem' {
-  import type {FrontMatter, Metadata} from '@theme/BlogPostPage';
+  import type {FrontMatter, Assets, Metadata} from '@theme/BlogPostPage';
 
-  export type Props = {
+  export interface Props {
     readonly frontMatter: FrontMatter;
+    readonly assets: Assets;
     readonly metadata: Metadata;
     readonly truncated?: string | boolean;
     readonly isBlogPostPage?: boolean;
     readonly children: JSX.Element;
-  };
+  }
 
   const BlogPostItem: (props: Props) => JSX.Element;
   export default BlogPostItem;
 }
 
+declare module '@theme/BlogPostAuthor' {
+  import type {Metadata} from '@theme/BlogPostPage';
+
+  export interface Props {
+    readonly author: Metadata['authors'][number];
+  }
+
+  export default function BlogPostAuthor(props: Props): JSX.Element;
+}
+
+declare module '@theme/BlogPostAuthors' {
+  import type {Metadata, Assets} from '@theme/BlogPostPage';
+
+  export interface Props {
+    readonly authors: Metadata['authors'];
+    readonly assets: Assets;
+  }
+
+  export default function BlogPostAuthors(props: Props): JSX.Element;
+}
+
 declare module '@theme/BlogPostPaginator' {
   type Item = {readonly title: string; readonly permalink: string};
 
-  export type Props = {readonly nextItem?: Item; readonly prevItem?: Item};
+  export interface Props {
+    readonly nextItem?: Item;
+    readonly prevItem?: Item;
+  }
 
   const BlogPostPaginator: (props: Props) => JSX.Element;
   export default BlogPostPaginator;
 }
 
 declare module '@theme/BlogLayout' {
+  import type {ReactNode} from 'react';
   import type {Props as LayoutProps} from '@theme/Layout';
   import type {BlogSidebar} from '@theme/BlogSidebar';
-  import type {TOCItem} from '@docusaurus/types';
 
-  export type Props = LayoutProps & {
+  export interface Props extends LayoutProps {
     readonly sidebar?: BlogSidebar;
-    readonly toc?: readonly TOCItem[];
-  };
+    readonly toc?: ReactNode;
+  }
 
   const BlogLayout: (props: Props) => JSX.Element;
   export default BlogLayout;
@@ -67,12 +100,12 @@ declare module '@theme/BlogLayout' {
 declare module '@theme/CodeBlock' {
   import {ReactElement} from 'react';
 
-  export type Props = {
+  export interface Props {
     readonly children: string | ReactElement;
     readonly className?: string;
     readonly metastring?: string;
     readonly title?: string;
-  };
+  }
 
   const CodeBlock: (props: Props) => JSX.Element;
   export default CodeBlock;
@@ -81,9 +114,9 @@ declare module '@theme/CodeBlock' {
 declare module '@theme/DocPaginator' {
   type PageInfo = {readonly permalink: string; readonly title: string};
 
-  export type Props = {
+  export interface Props {
     readonly metadata: {readonly previous?: PageInfo; readonly next?: PageInfo};
-  };
+  }
 
   const DocPaginator: (props: Props) => JSX.Element;
   export default DocPaginator;
@@ -92,12 +125,14 @@ declare module '@theme/DocPaginator' {
 declare module '@theme/DocSidebar' {
   import type {PropSidebarItem} from '@docusaurus/plugin-content-docs-types';
 
-  export type Props = {
+  export interface Props {
     readonly path: string;
     readonly sidebar: readonly PropSidebarItem[];
     readonly onCollapse: () => void;
     readonly isHidden: boolean;
-  };
+    // MobileSecondaryFilter expects Record<string, unknown>
+    readonly [key: string]: unknown;
+  }
 
   const DocSidebar: (props: Props) => JSX.Element;
   export default DocSidebar;
@@ -109,12 +144,13 @@ declare module '@theme/DocSidebarItem' {
   type DocSidebarPropsBase = {
     readonly activePath: string;
     readonly onItemClick?: () => void;
+    readonly level: number;
     readonly tabIndex?: number;
   };
 
-  export type Props = DocSidebarPropsBase & {
+  export interface Props extends DocSidebarPropsBase {
     readonly item: PropSidebarItem;
-  };
+  }
   const DocSidebarItem: (props: Props) => JSX.Element;
   export default DocSidebarItem;
 
@@ -130,9 +166,9 @@ declare module '@theme/DocVersionSuggestions' {
 }
 
 declare module '@theme/EditThisPage' {
-  export type Props = {
+  export interface Props {
     readonly editUrl: string;
-  };
+  }
   const EditThisPage: (props: Props) => JSX.Element;
   export default EditThisPage;
 }
@@ -146,7 +182,7 @@ declare module '@theme/Heading' {
   import type {ComponentProps} from 'react';
 
   export type HeadingType = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
-  export type Props = ComponentProps<HeadingType>;
+  export interface Props extends ComponentProps<HeadingType> {}
 
   const Heading: (Tag: HeadingType) => (props: Props) => JSX.Element;
   export default Heading;
@@ -187,19 +223,6 @@ declare module '@theme/hooks/usePrismTheme' {
   export default usePrismTheme;
 }
 
-declare module '@theme/hooks/useScrollPosition' {
-  export type ScrollPosition = {scrollX: number; scrollY: number};
-
-  const useScrollPosition: (
-    effect: (
-      position: ScrollPosition,
-      lastPosition: ScrollPosition | null,
-    ) => void,
-    deps?: unknown[],
-  ) => void;
-  export default useScrollPosition;
-}
-
 declare module '@theme/hooks/useTabGroupChoice' {
   export type useTabGroupChoiceReturns = {
     readonly tabGroupChoices: {readonly [groupId: string]: string};
@@ -231,14 +254,6 @@ declare module '@theme/hooks/useThemeContext' {
   export default function useThemeContext(): ThemeContextProps;
 }
 
-declare module '@theme/hooks/useTOCHighlight' {
-  export default function useTOCHighlight(
-    linkClassName: string,
-    linkActiveClassName: string,
-    topOffset: number,
-  ): void;
-}
-
 declare module '@theme/hooks/useUserPreferencesContext' {
   export type UserPreferencesContextProps = {
     tabGroupChoices: {readonly [groupId: string]: string};
@@ -269,21 +284,21 @@ declare module '@theme/hooks/useKeyboardNavigation' {
 declare module '@theme/Layout' {
   import type {ReactNode} from 'react';
 
-  export type Props = {
-    children: ReactNode;
-    title?: string;
-    noFooter?: boolean;
-    description?: string;
-    image?: string;
-    keywords?: string | string[];
-    permalink?: string;
-    wrapperClassName?: string;
-    pageClassName?: string;
-    searchMetadatas?: {
-      version?: string;
-      tag?: string;
+  export interface Props {
+    readonly children: ReactNode;
+    readonly title?: string;
+    readonly noFooter?: boolean;
+    readonly description?: string;
+    readonly image?: string;
+    readonly keywords?: string | string[];
+    readonly permalink?: string;
+    readonly wrapperClassName?: string;
+    readonly pageClassName?: string;
+    readonly searchMetadatas?: {
+      readonly version?: string;
+      readonly tag?: string;
     };
-  };
+  }
 
   const Layout: (props: Props) => JSX.Element;
   export default Layout;
@@ -292,29 +307,29 @@ declare module '@theme/Layout' {
 declare module '@theme/LayoutHead' {
   import type {Props as LayoutProps} from '@theme/Layout';
 
-  export type Props = Omit<LayoutProps, 'children'>;
+  export interface Props extends Omit<LayoutProps, 'children'> {}
 
   const LayoutHead: (props: Props) => JSX.Element;
   export default LayoutHead;
 }
 
 declare module '@theme/SearchMetadatas' {
-  export type Props = {
-    locale?: string;
-    version?: string;
-    tag?: string;
-  };
+  export interface Props {
+    readonly locale?: string;
+    readonly version?: string;
+    readonly tag?: string;
+  }
 
   const SearchMetadatas: (props: Props) => JSX.Element;
   export default SearchMetadatas;
 }
 
 declare module '@theme/LastUpdated' {
-  export type Props = {
-    lastUpdatedAt?: number;
-    formattedLastUpdatedAt?: string;
-    lastUpdatedBy?: string;
-  };
+  export interface Props {
+    readonly lastUpdatedAt?: number;
+    readonly formattedLastUpdatedAt?: string;
+    readonly lastUpdatedBy?: string;
+  }
 
   const LastUpdated: (props: Props) => JSX.Element;
   export default LastUpdated;
@@ -328,8 +343,10 @@ declare module '@theme/SkipToContent' {
 declare module '@theme/MDXComponents' {
   import type {ComponentProps} from 'react';
   import type CodeBlock from '@theme/CodeBlock';
+  import type Head from '@docusaurus/Head';
 
   export type MDXComponentsObject = {
+    readonly head: typeof Head;
     readonly code: typeof CodeBlock;
     readonly a: (props: ComponentProps<'a'>) => JSX.Element;
     readonly pre: typeof CodeBlock;
@@ -369,9 +386,9 @@ declare module '@theme/NavbarItem/DefaultNavbarItem' {
     readonly position?: 'left' | 'right';
   };
 
-  export type Props = DesktopOrMobileNavBarItemProps & {
+  export interface Props extends DesktopOrMobileNavBarItemProps {
     readonly mobile?: boolean;
-  };
+  }
 
   export const NavLink: (props: NavLinkProps) => JSX.Element;
 
@@ -389,16 +406,18 @@ declare module '@theme/NavbarItem/DropdownNavbarItem' {
     readonly className?: string;
   };
 
-  export type Props = DesktopOrMobileNavBarItemProps & {
+  export interface Props extends DesktopOrMobileNavBarItemProps {
     readonly mobile?: boolean;
-  };
+  }
 
   const DropdownNavbarItem: (props: Props) => JSX.Element;
   export default DropdownNavbarItem;
 }
 
 declare module '@theme/NavbarItem/SearchNavbarItem' {
-  export type Props = {readonly mobile?: boolean};
+  export interface Props {
+    readonly mobile?: boolean;
+  }
 
   const SearchNavbarItem: (props: Props) => JSX.Element;
   export default SearchNavbarItem;
@@ -408,10 +427,10 @@ declare module '@theme/NavbarItem/LocaleDropdownNavbarItem' {
   import type {Props as DropdownNavbarItemProps} from '@theme/NavbarItem/DropdownNavbarItem';
   import type {LinkLikeNavbarItemProps} from '@theme/NavbarItem';
 
-  export type Props = DropdownNavbarItemProps & {
+  export interface Props extends DropdownNavbarItemProps {
     readonly dropdownItemsBefore: LinkLikeNavbarItemProps[];
     readonly dropdownItemsAfter: LinkLikeNavbarItemProps[];
-  };
+  }
 
   const LocaleDropdownNavbarItem: (props: Props) => JSX.Element;
   export default LocaleDropdownNavbarItem;
@@ -421,12 +440,12 @@ declare module '@theme/NavbarItem/DocsVersionDropdownNavbarItem' {
   import type {Props as DropdownNavbarItemProps} from '@theme/NavbarItem/DropdownNavbarItem';
   import type {LinkLikeNavbarItemProps} from '@theme/NavbarItem';
 
-  export type Props = DropdownNavbarItemProps & {
+  export interface Props extends DropdownNavbarItemProps {
     readonly docsPluginId?: string;
     readonly dropdownActiveClassDisabled?: boolean;
     readonly dropdownItemsBefore: LinkLikeNavbarItemProps[];
     readonly dropdownItemsAfter: LinkLikeNavbarItemProps[];
-  };
+  }
 
   const DocsVersionDropdownNavbarItem: (props: Props) => JSX.Element;
   export default DocsVersionDropdownNavbarItem;
@@ -435,7 +454,9 @@ declare module '@theme/NavbarItem/DocsVersionDropdownNavbarItem' {
 declare module '@theme/NavbarItem/DocsVersionNavbarItem' {
   import type {Props as DefaultNavbarItemProps} from '@theme/NavbarItem/DefaultNavbarItem';
 
-  export type Props = DefaultNavbarItemProps & {readonly docsPluginId?: string};
+  export interface Props extends DefaultNavbarItemProps {
+    readonly docsPluginId?: string;
+  }
 
   const DocsVersionNavbarItem: (props: Props) => JSX.Element;
   export default DocsVersionNavbarItem;
@@ -444,11 +465,10 @@ declare module '@theme/NavbarItem/DocsVersionNavbarItem' {
 declare module '@theme/NavbarItem/DocNavbarItem' {
   import type {Props as DefaultNavbarItemProps} from '@theme/NavbarItem/DefaultNavbarItem';
 
-  export type Props = DefaultNavbarItemProps & {
+  export interface Props extends DefaultNavbarItemProps {
     readonly docId: string;
-    readonly activeSidebarClassName: string;
     readonly docsPluginId?: string;
-  };
+  }
 
   const DocsSidebarNavbarItem: (props: Props) => JSX.Element;
   export default DocsSidebarNavbarItem;
@@ -489,15 +509,21 @@ declare module '@theme/NavbarItem' {
   export default NavbarItem;
 }
 
+declare module '@theme/SearchBar' {
+  export default function SearchBar(): JSX.Element;
+}
+
 declare module '@theme/TabItem' {
   import type {ReactNode} from 'react';
 
-  export type Props = {
+  export interface Props {
     readonly children: ReactNode;
     readonly value: string;
+    readonly default?: boolean;
+    readonly label?: string;
     readonly hidden?: boolean;
     readonly className?: string;
-  };
+  }
 
   const TabItem: (props: Props) => JSX.Element;
   export default TabItem;
@@ -507,15 +533,15 @@ declare module '@theme/Tabs' {
   import type {ReactElement} from 'react';
   import type {Props as TabItemProps} from '@theme/TabItem';
 
-  export type Props = {
+  export interface Props {
     readonly lazy?: boolean;
     readonly block?: boolean;
     readonly children: readonly ReactElement<TabItemProps>[];
-    readonly defaultValue?: string;
-    readonly values: readonly {value: string; label: string}[];
+    readonly defaultValue?: string | null;
+    readonly values?: readonly {value: string; label?: string}[];
     readonly groupId?: string;
     readonly className?: string;
-  };
+  }
 
   const Tabs: (props: Props) => JSX.Element;
   export default Tabs;
@@ -524,12 +550,12 @@ declare module '@theme/Tabs' {
 declare module '@theme/ThemedImage' {
   import type {ComponentProps} from 'react';
 
-  export type Props = {
+  export interface Props extends Omit<ComponentProps<'img'>, 'src'> {
     readonly sources: {
       readonly light: string;
       readonly dark: string;
     };
-  } & Omit<ComponentProps<'img'>, 'src'>;
+  }
 
   const ThemedImage: (props: Props) => JSX.Element;
   export default ThemedImage;
@@ -538,29 +564,53 @@ declare module '@theme/ThemedImage' {
 declare module '@theme/Details' {
   import {Details, DetailsProps} from '@docusaurus/theme-common';
 
-  export type Props = DetailsProps;
+  export interface Props extends DetailsProps {}
   export default Details;
 }
 
 declare module '@theme/ThemeProvider' {
   import type {ReactNode} from 'react';
 
-  export type Props = {readonly children: ReactNode};
+  export interface Props {
+    readonly children: ReactNode;
+  }
 
   const ThemeProvider: (props: Props) => JSX.Element;
   export default ThemeProvider;
 }
 
+declare module '@theme/TOCItems' {
+  import type {TOCItem} from '@docusaurus/types';
+
+  export type TOCItemsProps = {
+    readonly toc: readonly TOCItem[];
+    readonly minHeadingLevel?: number;
+    readonly maxHeadingLevel?: number;
+    readonly className?: string;
+    readonly linkClassName?: string | null;
+    readonly linkActiveClassName?: string;
+  };
+
+  export default function TOCItems(props: TOCItemsProps): JSX.Element;
+}
+
 declare module '@theme/TOC' {
   import type {TOCItem} from '@docusaurus/types';
 
+  // minHeadingLevel only exists as a per-doc option,
+  // and won't have a default set by Joi. See TOC, TOCInline,
+  // TOCCollapsible for examples
   export type TOCProps = {
     readonly toc: readonly TOCItem[];
+    readonly minHeadingLevel?: number;
+    readonly maxHeadingLevel?: number;
+    readonly className?: string;
   };
 
   export type TOCHeadingsProps = {
     readonly toc: readonly TOCItem[];
-    readonly isChild?: boolean;
+    readonly minHeadingLevel?: number;
+    readonly maxHeadingLevel?: number;
   };
 
   export const TOCHeadings: (props: TOCHeadingsProps) => JSX.Element;
@@ -574,6 +624,8 @@ declare module '@theme/TOCInline' {
 
   export type TOCInlineProps = {
     readonly toc: readonly TOCItem[];
+    readonly minHeadingLevel?: number;
+    readonly maxHeadingLevel?: number;
   };
 
   const TOCInline: (props: TOCInlineProps) => JSX.Element;
@@ -585,6 +637,8 @@ declare module '@theme/TOCCollapsible' {
 
   export type TOCCollapsibleProps = {
     readonly className?: string;
+    readonly minHeadingLevel?: number;
+    readonly maxHeadingLevel?: number;
     readonly toc: readonly TOCItem[];
   };
 
@@ -595,11 +649,11 @@ declare module '@theme/TOCCollapsible' {
 declare module '@theme/Toggle' {
   import type {SyntheticEvent} from 'react';
 
-  export type Props = {
+  export interface Props {
     readonly className?: string;
     readonly checked: boolean;
     readonly onChange: (e: SyntheticEvent) => void;
-  };
+  }
 
   const Toggle: (props: Props) => JSX.Element;
   export default Toggle;
@@ -608,7 +662,9 @@ declare module '@theme/Toggle' {
 declare module '@theme/UserPreferencesProvider' {
   import type {ReactNode} from 'react';
 
-  export type Props = {readonly children: ReactNode};
+  export interface Props {
+    readonly children: ReactNode;
+  }
 
   const UserPreferencesProvider: (props: Props) => JSX.Element;
   export default UserPreferencesProvider;
@@ -617,7 +673,9 @@ declare module '@theme/UserPreferencesProvider' {
 declare module '@theme/LayoutProviders' {
   import type {ReactNode} from 'react';
 
-  export type Props = {readonly children: ReactNode};
+  export interface Props {
+    readonly children: ReactNode;
+  }
 
   const LayoutProviders: (props: Props) => JSX.Element;
   export default LayoutProviders;
@@ -644,10 +702,10 @@ declare module '@theme/UserPreferencesContext' {
 declare module '@theme/Logo' {
   import type {ComponentProps} from 'react';
 
-  export type Props = {
-    imageClassName?: string;
-    titleClassName?: string;
-  } & ComponentProps<'a'>;
+  export interface Props extends ComponentProps<'a'> {
+    readonly imageClassName?: string;
+    readonly titleClassName?: string;
+  }
 
   const Logo: (props: Props) => JSX.Element;
   export default Logo;
@@ -656,7 +714,7 @@ declare module '@theme/Logo' {
 declare module '@theme/IconArrow' {
   import type {ComponentProps} from 'react';
 
-  export type Props = ComponentProps<'svg'>;
+  export interface Props extends ComponentProps<'svg'> {}
 
   const IconArrow: (props: Props) => JSX.Element;
   export default IconArrow;
@@ -665,7 +723,7 @@ declare module '@theme/IconArrow' {
 declare module '@theme/IconEdit' {
   import type {ComponentProps} from 'react';
 
-  export type Props = ComponentProps<'svg'>;
+  export interface Props extends ComponentProps<'svg'> {}
 
   const IconEdit: (props: Props) => JSX.Element;
   export default IconEdit;
@@ -674,16 +732,25 @@ declare module '@theme/IconEdit' {
 declare module '@theme/IconMenu' {
   import type {ComponentProps} from 'react';
 
-  export type Props = ComponentProps<'svg'>;
+  export interface Props extends ComponentProps<'svg'> {}
 
   const IconMenu: (props: Props) => JSX.Element;
   export default IconMenu;
 }
 
+declare module '@theme/IconClose' {
+  import type {ComponentProps} from 'react';
+
+  export interface Props extends ComponentProps<'svg'> {}
+
+  const IconClose: (props: Props) => JSX.Element;
+  export default IconClose;
+}
+
 declare module '@theme/IconLanguage' {
   import type {ComponentProps} from 'react';
 
-  export type Props = ComponentProps<'svg'>;
+  export interface Props extends ComponentProps<'svg'> {}
 
   const IconLanguage: (props: Props) => JSX.Element;
   export default IconLanguage;
@@ -692,8 +759,52 @@ declare module '@theme/IconLanguage' {
 declare module '@theme/IconExternalLink' {
   import type {ComponentProps} from 'react';
 
-  export type Props = ComponentProps<'svg'>;
+  export interface Props extends ComponentProps<'svg'> {}
 
   const IconExternalLink: (props: Props) => JSX.Element;
   export default IconExternalLink;
 }
+
+declare module '@theme/TagsListByLetter' {
+  export type TagsListItem = Readonly<{
+    name: string;
+    permalink: string;
+    count: number;
+  }>;
+  export interface Props {
+    readonly tags: readonly TagsListItem[];
+  }
+  export default function TagsListByLetter(props: Props): JSX.Element;
+}
+
+declare module '@theme/TagsListInline' {
+  export type Tag = Readonly<{label: string; permalink: string}>;
+  export interface Props {
+    readonly tags: readonly Tag[];
+  }
+  export default function TagsListInline(props: Props): JSX.Element;
+}
+
+declare module '@theme/Tag' {
+  import type {TagsListItem} from '@theme/TagsListByLetter';
+  import type {Optional} from 'utility-types';
+
+  export interface Props extends Optional<TagsListItem, 'count'> {}
+
+  export default function Tag(props: Props): JSX.Element;
+}
+
+declare module '@theme/prism-include-languages' {
+  import type * as PrismNamespace from 'prismjs';
+
+  export default function prismIncludeLanguages(
+    PrismObject: typeof PrismNamespace,
+  ): void;
+}
+
+declare module 'prism-react-renderer/prism' {
+  import type * as PrismNamespace from 'prismjs';
+
+  const Prism: typeof PrismNamespace;
+  export default Prism;
+}