chore: upgrade to docusaurus 3.5.2 (#7996)

elastic · Sep 9, 2024 · 2c67c23 · 2c67c23
1 parent d2afcab
commit 2c67c23
Show file tree

Hide file tree

Showing 18 changed files with 242 additions and 249 deletions.
diff --git a/packages/docusaurus-theme/package.json b/packages/docusaurus-theme/package.json
@@ -14,7 +14,7 @@
  "directory": "packages/docusaurus-theme"
  },
  "devDependencies": {
- "@docusaurus/types": "^3.4.0",
+ "@docusaurus/types": "^3.5.2",
  "@types/react": "^18.3.3",
  "@types/react-dom": "^18.3.0",
  "@types/react-is": "^18",
@@ -28,10 +28,11 @@
  }
  },
  "dependencies": {
- "@docusaurus/core": "^3.4.0",
- "@docusaurus/module-type-aliases": "^3.4.0",
- "@docusaurus/theme-common": "^3.4.0",
- "@docusaurus/utils-validation": "^3.4.0",
+ "@docusaurus/core": "^3.5.2",
+ "@docusaurus/module-type-aliases": "^3.5.2",
+ "@docusaurus/plugin-content-docs": "^3.5.2",
+ "@docusaurus/theme-common": "^3.5.2",
+ "@docusaurus/utils-validation": "^3.5.2",
  "@elastic/datemath": "^5.0.3",
  "@elastic/eui": "94.5.0",
  "@elastic/eui-docgen": "workspace:^",

diff --git a/packages/docusaurus-theme/src/theme/DocBreadcrumbs/index.tsx b/packages/docusaurus-theme/src/theme/DocBreadcrumbs/index.tsx
@@ -2,10 +2,8 @@ import React, { type ReactNode } from 'react';
 import clsx from 'clsx';
 import { css } from '@emotion/react';
 import { ThemeClassNames } from '@docusaurus/theme-common';
-import {
- useSidebarBreadcrumbs,
- useHomePageRoute,
-} from '@docusaurus/theme-common/internal';
+import { useSidebarBreadcrumbs } from '@docusaurus/plugin-content-docs/client';
+import { useHomePageRoute } from '@docusaurus/theme-common/internal';
 import Link from '@docusaurus/Link';
 import { translate } from '@docusaurus/Translate';
 import { EuiIcon, useEuiMemoizedStyles, UseEuiTheme } from '@elastic/eui';

diff --git a/packages/docusaurus-theme/src/theme/DocItem/Content/index.tsx b/packages/docusaurus-theme/src/theme/DocItem/Content/index.tsx
@@ -1,8 +1,7 @@
-import { ReactNode } from 'react';
 import clsx from 'clsx';
 import { css } from '@emotion/react';
 import { ThemeClassNames } from '@docusaurus/theme-common';
-import { useDoc } from '@docusaurus/theme-common/internal';
+import { useDoc } from '@docusaurus/plugin-content-docs/client';
 import MDXContent from '@theme-original/MDXContent';
 import {
  EuiHorizontalRule,

diff --git a/packages/docusaurus-theme/src/theme/DocItem/Footer/index.tsx b/packages/docusaurus-theme/src/theme/DocItem/Footer/index.tsx
@@ -1,7 +1,7 @@
 import React from 'react';
 import clsx from 'clsx';
 import { ThemeClassNames } from '@docusaurus/theme-common';
-import { useDoc } from '@docusaurus/theme-common/internal';
+import { useDoc } from '@docusaurus/plugin-content-docs/client';
 import TagsListInline from '@theme-original/TagsListInline';
 
 import EditMetaRow from '@theme-original/EditMetaRow';

diff --git a/packages/docusaurus-theme/src/theme/DocItem/Layout/index.tsx b/packages/docusaurus-theme/src/theme/DocItem/Layout/index.tsx
@@ -10,9 +10,9 @@ import React from 'react';
 import { EuiHorizontalRule } from '@elastic/eui';
 import { css } from '@emotion/react';
 import { useWindowSize } from '@docusaurus/theme-common';
-import { useDoc } from '@docusaurus/theme-common/internal';
+import { useDoc } from '@docusaurus/plugin-content-docs/client';
 import DocItemPaginator from '@theme-original/DocItem/Paginator';
-import Unlisted from '@theme-original/Unlisted';
+import ContentVisibility from '@theme-original/ContentVisibility';
 import DocVersionBanner from '@theme-original/DocVersionBanner';
 import DocVersionBadge from '@theme-original/DocVersionBadge';
 import * as Props from '@theme-original/DocItem/Layout';
@@ -67,13 +67,12 @@ function useDocTOC() {
 
 export default function DocItemLayout({ children }: typeof Props): JSX.Element {
  const docTOC = useDocTOC();
- const {
- metadata: { unlisted },
- } = useDoc();
+ const { metadata } = useDoc();
+
  return (
  <div className="row" css={styles.docItemRow}>
  <div className="col" css={styles.docItemCol}>
- {unlisted && <Unlisted />}
+ <ContentVisibility metadata={metadata} />
  <DocVersionBanner />
  <div css={styles.docItemContainer}>
  <article>

diff --git a/packages/docusaurus-theme/src/theme/DocItem/Metadata/index.tsx b/packages/docusaurus-theme/src/theme/DocItem/Metadata/index.tsx
@@ -1,6 +1,6 @@
 import React from 'react';
 import {PageMetadata} from '@docusaurus/theme-common';
-import {useDoc} from '@docusaurus/theme-common/internal';
+import { useDoc } from '@docusaurus/plugin-content-docs/client';
 
 export default function DocItemMetadata(): JSX.Element {
  const {metadata, frontMatter, assets} = useDoc();

diff --git a/packages/docusaurus-theme/src/theme/DocItem/Paginator/index.tsx b/packages/docusaurus-theme/src/theme/DocItem/Paginator/index.tsx
@@ -1,5 +1,5 @@
 import React from 'react';
-import { useDoc } from '@docusaurus/theme-common/internal';
+import { useDoc } from '@docusaurus/plugin-content-docs/client';
 import DocPaginator from '@theme-original/DocPaginator';
 
 /**

diff --git a/packages/docusaurus-theme/src/theme/DocItem/TOC/Desktop/index.tsx b/packages/docusaurus-theme/src/theme/DocItem/TOC/Desktop/index.tsx
@@ -1,6 +1,6 @@
 import React from 'react';
 import { ThemeClassNames } from '@docusaurus/theme-common';
-import { useDoc } from '@docusaurus/theme-common/internal';
+import { useDoc } from '@docusaurus/plugin-content-docs/client';
 
 import TOC from '@theme-original/TOC';
 

diff --git a/packages/docusaurus-theme/src/theme/DocItem/TOC/Mobile/index.tsx b/packages/docusaurus-theme/src/theme/DocItem/TOC/Mobile/index.tsx
@@ -1,7 +1,7 @@
 import React from 'react';
 import { css } from '@emotion/react';
 import { ThemeClassNames } from '@docusaurus/theme-common';
-import { useDoc } from '@docusaurus/theme-common/internal';
+import { useDoc } from '@docusaurus/plugin-content-docs/client';
 
 import TOCCollapsible from '@theme-original/TOCCollapsible';
 

diff --git a/packages/docusaurus-theme/src/theme/DocItem/index.tsx b/packages/docusaurus-theme/src/theme/DocItem/index.tsx
@@ -1,6 +1,6 @@
 import React from 'react';
 import { HtmlClassNameProvider } from '@docusaurus/theme-common';
-import { DocProvider } from '@docusaurus/theme-common/internal';
+import { DocProvider } from '@docusaurus/plugin-content-docs/client';
 import type { Props } from '@theme/DocItem';
 
 import DocItemMetadata from './Metadata';

diff --git a/packages/docusaurus-theme/src/theme/DocRoot/Layout/Main/index.tsx b/packages/docusaurus-theme/src/theme/DocRoot/Layout/Main/index.tsx
@@ -1,7 +1,7 @@
 import React from 'react';
 import clsx from 'clsx';
 import { css } from '@emotion/react';
-import { useDocsSidebar } from '@docusaurus/theme-common/internal';
+import { useDocsSidebar } from '@docusaurus/plugin-content-docs/client';
 import type { Props } from '@theme-original/DocRoot/Layout/Main';
 
 // converted from css modules to Emotion

diff --git a/packages/docusaurus-theme/src/theme/DocRoot/Layout/Sidebar/index.tsx b/packages/docusaurus-theme/src/theme/DocRoot/Layout/Sidebar/index.tsx
@@ -5,7 +5,7 @@ import {
  prefersReducedMotion,
  ThemeClassNames,
 } from '@docusaurus/theme-common';
-import { useDocsSidebar } from '@docusaurus/theme-common/internal';
+import { useDocsSidebar } from '@docusaurus/plugin-content-docs/client';
 import { useLocation } from '@docusaurus/router';
 import DocSidebar from '@theme-original/DocSidebar';
 import type { Props } from '@theme-original/DocRoot/Layout/Sidebar';

diff --git a/packages/docusaurus-theme/src/theme/DocRoot/Layout/index.tsx b/packages/docusaurus-theme/src/theme/DocRoot/Layout/index.tsx
@@ -1,6 +1,6 @@
 import React, { useEffect, useState } from 'react';
 import { css } from '@emotion/react';
-import { useDocsSidebar } from '@docusaurus/theme-common/internal';
+import { useDocsSidebar } from '@docusaurus/plugin-content-docs/client';
 import useIsBrowser from '@docusaurus/useIsBrowser';
 import BackToTopButton from '@theme-original/BackToTopButton';
 import type { Props } from '@theme-original/DocRoot/Layout';

diff --git a/packages/docusaurus-theme/src/theme/DocSidebarItem/Category/index.tsx b/packages/docusaurus-theme/src/theme/DocSidebarItem/Category/index.tsx
@@ -8,12 +8,12 @@ import {
  Collapsible,
  useCollapsible,
 } from '@docusaurus/theme-common';
+import { isSamePath } from '@docusaurus/theme-common/internal';
 import {
  isActiveSidebarItem,
  findFirstSidebarItemLink,
  useDocSidebarItemsExpandedState,
- isSamePath,
-} from '@docusaurus/theme-common/internal';
+} from '@docusaurus/plugin-content-docs/client';
 import Link from '@docusaurus/Link';
 import { translate } from '@docusaurus/Translate';
 import useIsBrowser from '@docusaurus/useIsBrowser';

diff --git a/packages/docusaurus-theme/src/theme/DocSidebarItem/Link/index.tsx b/packages/docusaurus-theme/src/theme/DocSidebarItem/Link/index.tsx
@@ -2,7 +2,7 @@ import React from 'react';
 import clsx from 'clsx';
 import { css } from '@emotion/react';
 import { ThemeClassNames } from '@docusaurus/theme-common';
-import { isActiveSidebarItem } from '@docusaurus/theme-common/internal';
+import { isActiveSidebarItem } from '@docusaurus/plugin-content-docs/client';
 import Link from '@docusaurus/Link';
 import isInternalUrl from '@docusaurus/isInternalUrl';
 import IconExternalLink from '@theme-original/Icon/ExternalLink';

diff --git a/packages/docusaurus-theme/src/theme/DocSidebarItems/index.tsx b/packages/docusaurus-theme/src/theme/DocSidebarItems/index.tsx
@@ -2,7 +2,7 @@ import React, { memo } from 'react';
 import {
  DocSidebarItemsExpandedStateProvider,
  useVisibleSidebarItems,
-} from '@docusaurus/theme-common/internal';
+} from '@docusaurus/plugin-content-docs/client';
 import type { Props } from '@theme-original/DocSidebarItems';
 import DocSidebarItem from '../DocSidebarItem';
 

diff --git a/packages/website/package.json b/packages/website/package.json
@@ -15,8 +15,8 @@
  "typecheck": "tsc"
  },
  "dependencies": {
- "@docusaurus/core": "3.4.0",
- "@docusaurus/preset-classic": "3.4.0",
+ "@docusaurus/core": "^3.5.2",
+ "@docusaurus/preset-classic": "^3.5.2",
  "@elastic/datemath": "^5.0.3",
  "@elastic/eui": "94.5.0",
  "@elastic/eui-docgen": "workspace:^",
@@ -35,9 +35,9 @@
  },
  "devDependencies": {
  "@babel/preset-react": "^7.24.7",
- "@docusaurus/module-type-aliases": "3.4.0",
- "@docusaurus/tsconfig": "3.4.0",
- "@docusaurus/types": "3.4.0",
+ "@docusaurus/module-type-aliases": "^3.5.2",
+ "@docusaurus/tsconfig": "^3.5.2",
+ "@docusaurus/types": "^3.5.2",
  "@types/react": "^18.3.3",
  "@types/react-dom": "^18.3.0",
  "cross-env": "^7.0.3",