@docusaurus/module-type-aliases 2.0.0-beta.1decd6f80 → 2.0.0-beta.20

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/module-type-aliases",
-  "version": "2.0.0-beta.1decd6f80",
+  "version": "2.0.0-beta.20",
   "description": "Docusaurus module type aliases.",
   "types": "./src/index.d.ts",
   "publishConfig": {
@@ -11,13 +11,17 @@
     "url": "https://github.com/facebook/docusaurus.git",
     "directory": "packages/docusaurus-module-type-aliases"
   },
-  "devDependencies": {
+  "dependencies": {
+    "@docusaurus/types": "2.0.0-beta.20",
     "@types/react": "*",
-    "@types/react-helmet": "*",
-    "@types/react-loadable": "*",
     "@types/react-router-config": "*",
-    "@types/react-router-dom": "*"
+    "@types/react-router-dom": "*",
+    "react-helmet-async": "*"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-dom": "*"
   },
   "license": "MIT",
-  "gitHead": "0f82d5997e05666fa8c0e8852e551c1a8ffe3876"
+  "gitHead": "ed5cdba401a5948e187e927039b142a0decc702d"
 }

package/src/index.d.ts

@@ -6,118 +6,177 @@
  */
 
 declare module '@generated/client-modules' {
-  const clientModules: readonly any[];
+  import type {ClientModule} from '@docusaurus/types';
+
+  const clientModules: readonly (ClientModule & {default: ClientModule})[];
   export default clientModules;
 }
 
 declare module '@generated/docusaurus.config' {
-  const config: any;
+  import type {DocusaurusConfig} from '@docusaurus/types';
+
+  const config: DocusaurusConfig;
   export default config;
 }
 
 declare module '@generated/site-metadata' {
-  const siteMetadata: any;
-  export default siteMetadata;
+  import type {SiteMetadata} from '@docusaurus/types';
+
+  const siteMetadata: SiteMetadata;
+  export = siteMetadata;
 }
 
 declare module '@generated/registry' {
-  const registry: {
-    readonly [key: string]: [() => Promise<any>, string, string];
-  };
+  import type {Registry} from '@docusaurus/types';
+
+  const registry: Registry;
   export default registry;
 }
 
 declare module '@generated/routes' {
-  type Route = {
-    readonly path: string;
-    readonly component: any;
-    readonly exact?: boolean;
+  import type {RouteConfig as RRRouteConfig} from 'react-router-config';
+
+  type RouteConfig = RRRouteConfig & {
+    path: string;
   };
-  const routes: Route[];
+  const routes: RouteConfig[];
   export default routes;
 }
 
 declare module '@generated/routesChunkNames' {
-  const routesChunkNames: Record<string, Record<string, string>>;
-  export default routesChunkNames;
+  import type {RouteChunkNames} from '@docusaurus/types';
+
+  const routesChunkNames: RouteChunkNames;
+  export = routesChunkNames;
 }
 
 declare module '@generated/globalData' {
-  const globalData: Record<string, unknown>;
-  export default globalData;
+  import type {GlobalData} from '@docusaurus/types';
+
+  const globalData: GlobalData;
+  export = globalData;
 }
 
 declare module '@generated/i18n' {
-  const i18n: {
-    defaultLocale: string;
-    locales: [string, ...string[]];
-    currentLocale: string;
-    localeConfigs: Record<string, {label: string; direction: string}>;
-  };
-  export default i18n;
+  import type {I18n} from '@docusaurus/types';
+
+  const i18n: I18n;
+  export = i18n;
 }
 
 declare module '@generated/codeTranslations' {
-  const codeTranslations: Record<string, string>;
-  export default codeTranslations;
-}
+  import type {CodeTranslations} from '@docusaurus/types';
 
-declare module '@theme/*';
+  const codeTranslations: CodeTranslations;
+  export = codeTranslations;
+}
 
 declare module '@theme-original/*';
+declare module '@theme-init/*';
+
+declare module '@theme/Error' {
+  export interface Props {
+    readonly error: Error;
+    readonly tryAgain: () => void;
+  }
+  export default function Error(props: Props): JSX.Element;
+}
 
-declare module '@docusaurus/*';
+declare module '@theme/Layout' {
+  import type {ReactNode} from 'react';
 
-declare module '@docusaurus/Head' {
-  import type {HelmetProps} from 'react-helmet';
+  export interface Props {
+    readonly children?: ReactNode;
+  }
+  export default function Layout(props: Props): JSX.Element;
+}
+
+declare module '@theme/Loading' {
+  import type {LoadingComponentProps} from 'react-loadable';
+
+  export default function Loading(props: LoadingComponentProps): JSX.Element;
+}
+
+declare module '@theme/NotFound' {
+  export default function NotFound(): JSX.Element;
+}
+
+declare module '@theme/Root' {
   import type {ReactNode} from 'react';
 
-  export type HeadProps = HelmetProps & {children: ReactNode};
+  export interface Props {
+    readonly children: ReactNode;
+  }
+  export default function Root({children}: Props): JSX.Element;
+}
 
-  const Head: (props: HeadProps) => JSX.Element;
-  export default Head;
+declare module '@theme/SiteMetadata' {
+  export default function SiteMetadata(): JSX.Element;
 }
 
-declare module '@docusaurus/Link' {
+declare module '@docusaurus/constants' {
+  export const DEFAULT_PLUGIN_ID: 'default';
+}
+
+declare module '@docusaurus/ErrorBoundary' {
   import type {ReactNode} from 'react';
+  import type ErrorComponent from '@theme/Error';
 
-  type RRLinkProps = Partial<import('react-router-dom').LinkProps>;
-  export type LinkProps = RRLinkProps & {
-    readonly isNavLink?: boolean;
-    readonly to?: string;
-    readonly href?: string;
-    readonly activeClassName?: string;
-    readonly children?: ReactNode;
-    readonly isActive?: (match: any, location: any) => boolean;
-    readonly autoAddBaseUrl?: boolean;
+  export interface Props {
+    readonly fallback?: typeof ErrorComponent;
+    readonly children: ReactNode;
+  }
+  export default function ErrorBoundary(props: Props): JSX.Element;
+}
 
-    // escape hatch in case broken links check is annoying for a specific link
-    readonly 'data-noBrokenLinkCheck'?: boolean;
-  };
-  const Link: (props: LinkProps) => JSX.Element;
-  export default Link;
+declare module '@docusaurus/Head' {
+  import type {HelmetProps} from 'react-helmet-async';
+  import type {ReactNode} from 'react';
+
+  export type Props = HelmetProps & {children: ReactNode};
+
+  export default function Head(props: Props): JSX.Element;
+}
+
+declare module '@docusaurus/Link' {
+  import type {CSSProperties, ComponentProps} from 'react';
+  import type {NavLinkProps as RRNavLinkProps} from 'react-router-dom';
+
+  type NavLinkProps = Partial<RRNavLinkProps>;
+  export type Props = NavLinkProps &
+    ComponentProps<'a'> & {
+      readonly className?: string;
+      readonly style?: CSSProperties;
+      readonly isNavLink?: boolean;
+      readonly to?: string;
+      readonly href?: string;
+      readonly autoAddBaseUrl?: boolean;
+
+      /** Escape hatch in case broken links check doesn't make sense. */
+      readonly 'data-noBrokenLinkCheck'?: boolean;
+    };
+  export default function Link(props: Props): JSX.Element;
 }
 
 declare module '@docusaurus/Interpolate' {
   import type {ReactNode} from 'react';
 
-  // TODO use TS template literal feature to make values typesafe!
-  // (requires upgrading TS first)
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  export type ExtractInterpolatePlaceholders<Str extends string> = string;
+  export type ExtractInterpolatePlaceholders<Str extends string> =
+    Str extends `${string}{${infer Key}}${infer Rest}`
+      ? Key | ExtractInterpolatePlaceholders<Rest>
+      : never;
 
-  export type InterpolateValues<
-    Str extends string,
-    Value extends ReactNode
-  > = Record<ExtractInterpolatePlaceholders<Str>, Value>;
+  export type InterpolateValues<Str extends string, Value extends ReactNode> = {
+    [key in ExtractInterpolatePlaceholders<Str>]: Value;
+  };
 
-  // TS function overload: if all the values are plain strings, then interpolate returns a simple string
+  // If all the values are plain strings, interpolate returns a simple string
   export function interpolate<Str extends string>(
     text: Str,
     values?: InterpolateValues<Str, string | number>,
   ): string;
 
-  // If values contain any ReactNode, then the return is a ReactNode
+  // If values contain any ReactNode, the return is a ReactNode
   export function interpolate<Str extends string, Value extends ReactNode>(
     text: Str,
     values?: InterpolateValues<Str, Value>,
@@ -134,18 +193,23 @@ declare module '@docusaurus/Interpolate' {
 }
 
 declare module '@docusaurus/Translate' {
-  import type {
-    InterpolateProps,
-    InterpolateValues,
-  } from '@docusaurus/Interpolate';
+  import type {ReactNode} from 'react';
+  import type {InterpolateValues} from '@docusaurus/Interpolate';
+
+  // TS type to ensure that at least one of id or message is always provided
+  // (Generic permits to handled message provided as React children)
+  type IdOrMessage<
+    MessageKey extends 'children' | 'message',
+    Str extends string,
+  > =
+    | ({[key in MessageKey]: Str} & {id?: string})
+    | ({[key in MessageKey]?: Str} & {id: string});
 
-  export type TranslateParam<Str extends string> = Partial<
-    InterpolateProps<Str>
+  export type TranslateParam<Str extends string> = IdOrMessage<
+    'message',
+    Str
   > & {
-    message: Str;
-    id?: string;
     description?: string;
-    values?: InterpolateValues<Str, string | number>;
   };
 
   export function translate<Str extends string>(
@@ -153,9 +217,12 @@ declare module '@docusaurus/Translate' {
     values?: InterpolateValues<Str, string | number>,
   ): string;
 
-  export type TranslateProps<Str extends string> = InterpolateProps<Str> & {
-    id?: string;
+  export type TranslateProps<Str extends string> = IdOrMessage<
+    'children',
+    Str
+  > & {
     description?: string;
+    values?: InterpolateValues<Str, ReactNode>;
   };
 
   export default function Translate<Str extends string>(
@@ -165,11 +232,23 @@ declare module '@docusaurus/Translate' {
 
 declare module '@docusaurus/router' {
   // eslint-disable-next-line import/no-extraneous-dependencies
-  export * from 'react-router-dom';
+  export {useHistory, useLocation, Redirect, matchPath} from 'react-router-dom';
 }
 
 declare module '@docusaurus/useDocusaurusContext' {
-  export default function (): any;
+  import type {DocusaurusContext} from '@docusaurus/types';
+
+  export default function useDocusaurusContext(): DocusaurusContext;
+}
+
+declare module '@docusaurus/useRouteContext' {
+  import type {PluginRouteContext} from '@docusaurus/types';
+
+  export default function useRouteContext(): PluginRouteContext;
+}
+
+declare module '@docusaurus/useIsBrowser' {
+  export default function useIsBrowser(): boolean;
 }
 
 declare module '@docusaurus/useBaseUrl' {
@@ -203,20 +282,18 @@ declare module '@docusaurus/ExecutionEnvironment' {
 declare module '@docusaurus/ComponentCreator' {
   import type Loadable from 'react-loadable';
 
-  function ComponentCreator(
+  export default function ComponentCreator(
     path: string,
     hash: string,
   ): ReturnType<typeof Loadable>;
-  export default ComponentCreator;
 }
 
 declare module '@docusaurus/BrowserOnly' {
-  export type Props = {
-    children?: () => JSX.Element;
-    fallback?: JSX.Element;
-  };
-  const BrowserOnly: (props: Props) => JSX.Element | null;
-  export default BrowserOnly;
+  export interface Props {
+    readonly children?: () => JSX.Element;
+    readonly fallback?: JSX.Element;
+  }
+  export default function BrowserOnly(props: Props): JSX.Element | null;
 }
 
 declare module '@docusaurus/isInternalUrl' {
@@ -236,17 +313,28 @@ declare module '@docusaurus/renderRoutes' {
 }
 
 declare module '@docusaurus/useGlobalData' {
-  export function useAllPluginInstancesData<T = unknown>(
+  import type {GlobalData, UseDataOptions} from '@docusaurus/types';
+
+  export function useAllPluginInstancesData(
     pluginName: string,
-  ): Record<string, T>;
+    options?: UseDataOptions,
+  ): GlobalData[string] | undefined;
 
-  export function usePluginData<T = unknown>(
+  export function usePluginData(
     pluginName: string,
     pluginId?: string,
-  ): T;
+    options?: UseDataOptions,
+  ): GlobalData[string][string] | undefined;
 
-  function useGlobalData(): Record<string, any>;
-  export default useGlobalData;
+  export default function useGlobalData(): GlobalData;
+}
+
+declare module '*.svg' {
+  import type {ComponentType, SVGProps} from 'react';
+
+  const ReactComponent: ComponentType<SVGProps<SVGSVGElement>>;
+
+  export default ReactComponent;
 }
 
 declare module '*.module.css' {
@@ -258,3 +346,10 @@ declare module '*.css' {
   const src: string;
   export default src;
 }
+
+interface Window {
+  docusaurus: {
+    prefetch: (url: string) => false | Promise<void[]>;
+    preload: (url: string) => false | Promise<void[]>;
+  };
+}