@docusaurus/theme-common 3.4.0 → 3.5.0

package/lib/utils/useThemeConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"useThemeConfig.js","sourceRoot":"","sources":["../../src/utils/useThemeConfig.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AA0HpE;;GAEG;AACH,MAAM,UAAU,cAAc;IAC5B,OAAO,oBAAoB,EAAE,CAAC,UAAU,CAAC,WAA0B,CAAC;AACtE,CAAC"}
+{"version":3,"file":"useThemeConfig.js","sourceRoot":"","sources":["../../src/utils/useThemeConfig.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AAgIpE;;GAEG;AACH,MAAM,UAAU,cAAc;IAC5B,OAAO,oBAAoB,EAAE,CAAC,UAAU,CAAC,WAA0B,CAAC;AACtE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/theme-common",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "Common code for Docusaurus themes.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -30,13 +30,10 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/mdx-loader": "3.4.0",
-    "@docusaurus/module-type-aliases": "3.4.0",
-    "@docusaurus/plugin-content-blog": "3.4.0",
-    "@docusaurus/plugin-content-docs": "3.4.0",
-    "@docusaurus/plugin-content-pages": "3.4.0",
-    "@docusaurus/utils": "3.4.0",
-    "@docusaurus/utils-common": "3.4.0",
+    "@docusaurus/mdx-loader": "3.5.0",
+    "@docusaurus/module-type-aliases": "3.5.0",
+    "@docusaurus/utils": "3.5.0",
+    "@docusaurus/utils-common": "3.5.0",
     "@types/history": "^4.7.11",
     "@types/react": "*",
     "@types/react-router-config": "*",
@@ -47,18 +44,19 @@
     "utility-types": "^3.10.0"
   },
   "devDependencies": {
-    "@docusaurus/core": "3.4.0",
-    "@docusaurus/types": "3.4.0",
+    "@docusaurus/core": "3.5.0",
+    "@docusaurus/types": "3.5.0",
     "fs-extra": "^11.1.1",
     "lodash": "^4.17.21",
     "schema-dts": "^1.1.2"
   },
   "peerDependencies": {
+    "@docusaurus/plugin-content-docs": "*",
     "react": "^18.0.0",
     "react-dom": "^18.0.0"
   },
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "49e9a2143274a8dd795659b417b470bc42abbd6e"
+  "gitHead": "cb5829f3c34b26d798b869e38ee25073488140bd"
 }

package/src/index.ts

@@ -5,6 +5,29 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+// TODO Docusaurus v4: remove these workarounds as a breaking change
+//  and remove docs plugin peerDeps in theme-common/package.json
+//  This is public API surface that we need to keep for v3
+//  See https://github.com/facebook/docusaurus/pull/10316
+export function useCurrentSidebarCategory(...args: unknown[]): unknown {
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  return require('@docusaurus/plugin-content-docs/client').useCurrentSidebarCategory(
+    ...args,
+  );
+}
+export function filterDocCardListItems(...args: unknown[]): unknown {
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  return require('@docusaurus/plugin-content-docs/client').filterDocCardListItems(
+    ...args,
+  );
+}
+export function useDocsPreferredVersion(...args: unknown[]): unknown {
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  return require('@docusaurus/plugin-content-docs/client').useDocsPreferredVersion(
+    ...args,
+  );
+}
+
 /*
  * APIs to document
  */
@@ -32,18 +55,6 @@ export {
   listStorageKeys,
 } from './utils/storageUtils';
 
-export {useContextualSearchFilters} from './utils/searchUtils';
-
-export {
-  useCurrentSidebarCategory,
-  filterDocCardListItems,
-} from './utils/docsUtils';
-
-export {
-  useBlogListPageStructuredData,
-  useBlogPostStructuredData,
-} from './utils/structuredDataUtils';
-
 export {usePluralForm} from './utils/usePluralForm';
 
 export {useCollapsible, Collapsible} from './components/Collapsible';
@@ -90,12 +101,10 @@ export {isMultiColumnFooterLinks} from './utils/footerUtils';
 
 export {isRegexpStringMatch} from './utils/regexpUtils';
 
-export {duplicates, uniq} from './utils/jsUtils';
+export {duplicates, uniq, groupBy} from './utils/jsUtils';
 
 export {usePrismTheme} from './hooks/usePrismTheme';
 
-export {useDocsPreferredVersion} from './contexts/docsPreferredVersion';
-
 export {processAdmonitionProps} from './utils/admonitionUtils';
 
 export {
@@ -114,7 +123,9 @@ export {
   UnlistedBannerTitle,
   UnlistedBannerMessage,
   UnlistedMetadata,
-} from './utils/unlistedUtils';
+  DraftBannerTitle,
+  DraftBannerMessage,
+} from './translations/contentVisibilityTranslations';
 
 export {
   ErrorBoundaryTryAgainButton,

package/src/internal.ts

@@ -18,25 +18,6 @@
 // eslint-disable-next-line no-restricted-syntax
 export * from './index';
 
-export {
-  DocSidebarItemsExpandedStateProvider,
-  useDocSidebarItemsExpandedState,
-} from './contexts/docSidebarItemsExpandedState';
-export {DocsVersionProvider, useDocsVersion} from './contexts/docsVersion';
-export {DocsSidebarProvider, useDocsSidebar} from './contexts/docsSidebar';
-
-export {DocProvider, useDoc, type DocContextValue} from './contexts/doc';
-export {
-  BlogPostProvider,
-  useBlogPost,
-  type BlogPostContextValue,
-} from './contexts/blogPost';
-
-export {
-  useDocsPreferredVersionByPluginId,
-  DocsPreferredVersionContextProvider,
-} from './contexts/docsPreferredVersion';
-
 export {
   AnnouncementBarProvider,
   useAnnouncementBar,
@@ -59,22 +40,7 @@ export {
   containsLineNumbers,
 } from './utils/codeBlockUtils';
 
-export {docVersionSearchTag, DEFAULT_SEARCH_TAG} from './utils/searchUtils';
-
-export {
-  isDocsPluginEnabled,
-  useDocById,
-  findSidebarCategory,
-  findFirstSidebarItemLink,
-  isActiveSidebarItem,
-  isVisibleSidebarItem,
-  useVisibleSidebarItems,
-  useSidebarBreadcrumbs,
-  useDocsVersionCandidates,
-  useLayoutDoc,
-  useLayoutDocsSidebar,
-  useDocRootMetadata,
-} from './utils/docsUtils';
+export {DEFAULT_SEARCH_TAG} from './utils/searchUtils';
 
 export {useTitleFormatter} from './utils/generalUtils';
 
@@ -113,7 +79,6 @@ export {
   type TOCHighlightConfig,
 } from './hooks/useTOCHighlight';
 
-export {useVisibleBlogSidebarItems} from './utils/blogUtils';
 export {useDateTimeFormat} from './utils/IntlUtils';
 
 export {useHideableNavbar} from './hooks/useHideableNavbar';
@@ -125,3 +90,10 @@ export {useLockBodyScroll} from './hooks/useLockBodyScroll';
 export {useCodeWordWrap} from './hooks/useCodeWordWrap';
 export {getPrismCssVariables} from './utils/codeBlockUtils';
 export {useBackToTopButton} from './hooks/useBackToTopButton';
+
+export {
+  useBlogTagsPostsPageTitle,
+  useBlogAuthorPageTitle,
+  translateBlogAuthorsListPageTitle,
+  BlogAuthorsListViewAllLabel,
+} from './translations/blogTranslations';

package/src/translations/blogTranslations.tsx

@@ -0,0 +1,79 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import React, {type ReactNode} from 'react';
+import Translate, {translate} from '@docusaurus/Translate';
+import {usePluralForm} from '../utils/usePluralForm';
+
+// Only used locally
+function useBlogPostsPlural(): (count: number) => string {
+  const {selectMessage} = usePluralForm();
+  return (count: number) =>
+    selectMessage(
+      count,
+      translate(
+        {
+          id: 'theme.blog.post.plurals',
+          description:
+            'Pluralized label for "{count} posts". Use as much plural forms (separated by "|") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)',
+          message: 'One post|{count} posts',
+        },
+        {count},
+      ),
+    );
+}
+
+export function useBlogTagsPostsPageTitle(tag: {
+  label: string;
+  count: number;
+}): string {
+  const blogPostsPlural = useBlogPostsPlural();
+  return translate(
+    {
+      id: 'theme.blog.tagTitle',
+      description: 'The title of the page for a blog tag',
+      message: '{nPosts} tagged with "{tagName}"',
+    },
+    {nPosts: blogPostsPlural(tag.count), tagName: tag.label},
+  );
+}
+
+export function useBlogAuthorPageTitle(author: {
+  key: string;
+  name?: string;
+  count: number;
+}): string {
+  const blogPostsPlural = useBlogPostsPlural();
+  return translate(
+    {
+      id: 'theme.blog.author.pageTitle',
+      description: 'The title of the page for a blog author',
+      message: '{authorName} - {nPosts}',
+    },
+    {
+      nPosts: blogPostsPlural(author.count),
+      authorName: author.name || author.key,
+    },
+  );
+}
+
+export const translateBlogAuthorsListPageTitle = (): string =>
+  translate({
+    id: 'theme.blog.authorsList.pageTitle',
+    message: 'Authors',
+    description: 'The title of the authors page',
+  });
+
+export function BlogAuthorsListViewAllLabel(): ReactNode {
+  return (
+    <Translate
+      id="theme.blog.authorsList.viewAll"
+      description="The label of the link targeting the blog authors page">
+      View All Authors
+    </Translate>
+  );
+}

package/src/{utils/unlistedUtils.tsx → translations/contentVisibilityTranslations.tsx}

@@ -12,7 +12,7 @@ import Head from '@docusaurus/Head';
 export function UnlistedBannerTitle(): JSX.Element {
   return (
     <Translate
-      id="theme.unlistedContent.title"
+      id="theme.contentVisibility.unlistedBanner.title"
       description="The unlisted content banner title">
       Unlisted page
     </Translate>
@@ -22,7 +22,7 @@ export function UnlistedBannerTitle(): JSX.Element {
 export function UnlistedBannerMessage(): JSX.Element {
   return (
     <Translate
-      id="theme.unlistedContent.message"
+      id="theme.contentVisibility.unlistedBanner.message"
       description="The unlisted content banner message">
       This page is unlisted. Search engines will not index it, and only users
       having a direct link can access it.
@@ -30,6 +30,8 @@ export function UnlistedBannerMessage(): JSX.Element {
   );
 }
 
+// TODO Docusaurus v4 breaking change (since it's v3 public theme-common API :/)
+//  Move this to theme/ContentVisibility/Unlisted
 export function UnlistedMetadata(): JSX.Element {
   return (
     <Head>
@@ -37,3 +39,24 @@ export function UnlistedMetadata(): JSX.Element {
     </Head>
   );
 }
+
+export function DraftBannerTitle(): JSX.Element {
+  return (
+    <Translate
+      id="theme.contentVisibility.draftBanner.title"
+      description="The draft content banner title">
+      Draft page
+    </Translate>
+  );
+}
+
+export function DraftBannerMessage(): JSX.Element {
+  return (
+    <Translate
+      id="theme.contentVisibility.draftBanner.message"
+      description="The draft content banner message">
+      This page is a draft. It will only be visible in dev and be excluded from
+      the production build.
+    </Translate>
+  );
+}

package/src/types.d.ts

@@ -6,6 +6,3 @@
  */
 
 /// <reference types="@docusaurus/module-type-aliases" />
-/// <reference types="@docusaurus/plugin-content-blog" />
-/// <reference types="@docusaurus/plugin-content-docs" />
-/// <reference types="@docusaurus/plugin-content-pages" />

package/src/utils/ThemeClassNames.ts

@@ -18,6 +18,8 @@ export const ThemeClassNames = {
     blogPostPage: 'blog-post-page',
     blogTagsListPage: 'blog-tags-list-page',
     blogTagPostListPage: 'blog-tags-post-list-page',
+    blogAuthorsListPage: 'blog-authors-list-page',
+    blogAuthorsPostsPage: 'blog-authors-posts-page',
 
     docsDocPage: 'docs-doc-page',
     docsTagsListPage: 'docs-tags-list-page',
@@ -41,6 +43,7 @@ export const ThemeClassNames = {
     codeBlock: 'theme-code-block',
     admonition: 'theme-admonition',
     unlistedBanner: 'theme-unlisted-banner',
+    draftBanner: 'theme-draft-banner',
 
     admonitionType: (type: string) => `theme-admonition-${type}`,
   },

package/src/utils/jsUtils.ts

@@ -34,3 +34,21 @@ export function uniq<T>(arr: T[]): T[] {
   // Note: had problems with [...new Set()]: https://github.com/facebook/docusaurus/issues/4972#issuecomment-863895061
   return Array.from(new Set(arr));
 }
+
+// TODO 2025: replace by std Object.groupBy ?
+// This is a local polyfill with exact same TS signature
+// see https://github.com/microsoft/TypeScript/blob/main/src/lib/esnext.object.d.ts
+export function groupBy<K extends PropertyKey, T>(
+  items: Iterable<T>,
+  keySelector: (item: T, index: number) => K,
+): Partial<Record<K, T[]>> {
+  const result: Partial<Record<K, T[]>> = {};
+  let index = 0;
+  for (const item of items) {
+    const key = keySelector(item, index);
+    result[key] ??= [];
+    result[key]!.push(item);
+    index += 1;
+  }
+  return result;
+}

package/src/utils/searchUtils.ts

@@ -5,62 +5,4 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {
-  useAllDocsData,
-  useActivePluginAndVersion,
-} from '@docusaurus/plugin-content-docs/client';
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-import {useDocsPreferredVersionByPluginId} from '../contexts/docsPreferredVersion';
-
 export const DEFAULT_SEARCH_TAG = 'default';
-
-/** The search tag to append as each doc's metadata. */
-export function docVersionSearchTag(
-  pluginId: string,
-  versionName: string,
-): string {
-  return `docs-${pluginId}-${versionName}`;
-}
-
-/**
- * Gets the relevant context information for contextual search.
- *
- * The value is generic and not coupled to Algolia/DocSearch, since we may want
- * to support multiple search engines, or allowing users to use their own search
- * engine solution.
- */
-export function useContextualSearchFilters(): {locale: string; tags: string[]} {
-  const {i18n} = useDocusaurusContext();
-  const allDocsData = useAllDocsData();
-  const activePluginAndVersion = useActivePluginAndVersion();
-  const docsPreferredVersionByPluginId = useDocsPreferredVersionByPluginId();
-
-  // This can't use more specialized hooks because we are mapping over all
-  // plugin instances.
-  function getDocPluginTags(pluginId: string) {
-    const activeVersion =
-      activePluginAndVersion?.activePlugin.pluginId === pluginId
-        ? activePluginAndVersion.activeVersion
-        : undefined;
-
-    const preferredVersion = docsPreferredVersionByPluginId[pluginId];
-
-    const latestVersion = allDocsData[pluginId]!.versions.find(
-      (v) => v.isLast,
-    )!;
-
-    const version = activeVersion ?? preferredVersion ?? latestVersion;
-
-    return docVersionSearchTag(pluginId, version.name);
-  }
-
-  const tags = [
-    DEFAULT_SEARCH_TAG,
-    ...Object.keys(allDocsData).map(getDocPluginTags),
-  ];
-
-  return {
-    locale: i18n.currentLocale,
-    tags,
-  };
-}

package/src/utils/useThemeConfig.ts

@@ -109,6 +109,12 @@ export type ThemeConfig = {
     };
   };
 
+  blog: {
+    sidebar: {
+      groupByYear: boolean;
+    };
+  };
+
   // TODO we should complete this theme config type over time
   // and share it across all themes
   // and use it in the Joi validation schema?

package/lib/contexts/blogPost.d.ts

@@ -1,33 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-import { type ReactNode } from 'react';
-import type { PropBlogPostContent } from '@docusaurus/plugin-content-blog';
-/**
- * The React context value returned by the `useBlogPost()` hook.
- * It contains useful data related to the currently browsed blog post.
- */
-export type BlogPostContextValue = Pick<PropBlogPostContent, 'metadata' | 'frontMatter' | 'assets' | 'toc'> & {
-    readonly isBlogPostPage: boolean;
-};
-/**
- * This is a very thin layer around the `content` received from the MDX loader.
- * It provides metadata about the blog post to the children tree.
- */
-export declare function BlogPostProvider({ children, content, isBlogPostPage, }: {
-    children: ReactNode;
-    content: PropBlogPostContent;
-    isBlogPostPage?: boolean;
-}): JSX.Element;
-/**
- * Returns the data of the currently browsed blog post. Gives access to
- * front matter, metadata, TOC, etc.
- * When swizzling a low-level component (e.g. the "Edit this page" link)
- * and you need some extra metadata, you don't have to drill the props
- * all the way through the component tree: simply use this hook instead.
- */
-export declare function useBlogPost(): BlogPostContextValue;
-//# sourceMappingURL=blogPost.d.ts.map

package/lib/contexts/blogPost.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"blogPost.d.ts","sourceRoot":"","sources":["../../src/contexts/blogPost.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EAAU,KAAK,SAAS,EAAa,MAAM,OAAO,CAAC;AAGjE,OAAO,KAAK,EAAC,mBAAmB,EAAC,MAAM,iCAAiC,CAAC;AAEzE;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,CACrC,mBAAmB,EACnB,UAAU,GAAG,aAAa,GAAG,QAAQ,GAAG,KAAK,CAC9C,GAAG;IACF,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC;CAClC,CAAC;AA4BF;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,EAC/B,QAAQ,EACR,OAAO,EACP,cAAsB,GACvB,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;IACpB,OAAO,EAAE,mBAAmB,CAAC;IAC7B,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,GAAG,GAAG,CAAC,OAAO,CAGd;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,IAAI,oBAAoB,CAMlD"}

package/lib/contexts/blogPost.js

@@ -1,46 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-import React, { useMemo, useContext } from 'react';
-import { ReactContextError } from '../utils/reactUtils';
-const Context = React.createContext(null);
-/**
- * Note: we don't use `PropBlogPostContent` as context value on purpose.
- * Metadata is currently stored inside the MDX component, but we may want to
- * change that in the future.
- */
-function useContextValue({ content, isBlogPostPage, }) {
-    return useMemo(() => ({
-        metadata: content.metadata,
-        frontMatter: content.frontMatter,
-        assets: content.assets,
-        toc: content.toc,
-        isBlogPostPage,
-    }), [content, isBlogPostPage]);
-}
-/**
- * This is a very thin layer around the `content` received from the MDX loader.
- * It provides metadata about the blog post to the children tree.
- */
-export function BlogPostProvider({ children, content, isBlogPostPage = false, }) {
-    const contextValue = useContextValue({ content, isBlogPostPage });
-    return <Context.Provider value={contextValue}>{children}</Context.Provider>;
-}
-/**
- * Returns the data of the currently browsed blog post. Gives access to
- * front matter, metadata, TOC, etc.
- * When swizzling a low-level component (e.g. the "Edit this page" link)
- * and you need some extra metadata, you don't have to drill the props
- * all the way through the component tree: simply use this hook instead.
- */
-export function useBlogPost() {
-    const blogPost = useContext(Context);
-    if (blogPost === null) {
-        throw new ReactContextError('BlogPostProvider');
-    }
-    return blogPost;
-}
-//# sourceMappingURL=blogPost.js.map

package/lib/contexts/blogPost.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"blogPost.js","sourceRoot":"","sources":["../../src/contexts/blogPost.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EAAC,OAAO,EAAkB,UAAU,EAAC,MAAM,OAAO,CAAC;AACjE,OAAO,EAAC,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AAetD,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAA8B,IAAI,CAAC,CAAC;AAEvE;;;;GAIG;AACH,SAAS,eAAe,CAAC,EACvB,OAAO,EACP,cAAc,GAIf;IACC,OAAO,OAAO,CACZ,GAAG,EAAE,CAAC,CAAC;QACL,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,cAAc;KACf,CAAC,EACF,CAAC,OAAO,EAAE,cAAc,CAAC,CAC1B,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,EAC/B,QAAQ,EACR,OAAO,EACP,cAAc,GAAG,KAAK,GAKvB;IACC,MAAM,YAAY,GAAG,eAAe,CAAC,EAAC,OAAO,EAAE,cAAc,EAAC,CAAC,CAAC;IAChE,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC9E,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW;IACzB,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IACrC,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;QACtB,MAAM,IAAI,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;IAClD,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/lib/contexts/doc.d.ts

@@ -1,30 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-import { type ReactNode } from 'react';
-import type { PropDocContent } from '@docusaurus/plugin-content-docs';
-/**
- * The React context value returned by the `useDoc()` hook.
- * It contains useful data related to the currently browsed doc.
- */
-export type DocContextValue = Pick<PropDocContent, 'metadata' | 'frontMatter' | 'toc' | 'assets' | 'contentTitle'>;
-/**
- * This is a very thin layer around the `content` received from the MDX loader.
- * It provides metadata about the doc to the children tree.
- */
-export declare function DocProvider({ children, content, }: {
-    children: ReactNode;
-    content: PropDocContent;
-}): JSX.Element;
-/**
- * Returns the data of the currently browsed doc. Gives access to the doc's MDX
- * Component, front matter, metadata, TOC, etc. When swizzling a low-level
- * component (e.g. the "Edit this page" link) and you need some extra metadata,
- * you don't have to drill the props all the way through the component tree:
- * simply use this hook instead.
- */
-export declare function useDoc(): DocContextValue;
-//# sourceMappingURL=doc.d.ts.map

package/lib/contexts/doc.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"doc.d.ts","sourceRoot":"","sources":["../../src/contexts/doc.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EAAU,KAAK,SAAS,EAAa,MAAM,OAAO,CAAC;AAEjE,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,iCAAiC,CAAC;AAEpE;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,IAAI,CAChC,cAAc,EACd,UAAU,GAAG,aAAa,GAAG,KAAK,GAAG,QAAQ,GAAG,cAAc,CAC/D,CAAC;AAwBF;;;GAGG;AACH,wBAAgB,WAAW,CAAC,EAC1B,QAAQ,EACR,OAAO,GACR,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;IACpB,OAAO,EAAE,cAAc,CAAC;CACzB,GAAG,GAAG,CAAC,OAAO,CAGd;AAED;;;;;;GAMG;AACH,wBAAgB,MAAM,IAAI,eAAe,CAMxC"}

package/lib/contexts/doc.js

@@ -1,48 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-import React, { useMemo, useContext } from 'react';
-import { ReactContextError } from '../utils/reactUtils';
-const Context = React.createContext(null);
-/**
- * Note: we don't use `PropDoc` as context value on purpose. Metadata is
- * currently stored inside the MDX component, but we may want to change that in
- * the future. This layer is a good opportunity to decouple storage from
- * consuming API, potentially allowing us to provide metadata as both props and
- * route context without duplicating the chunks in the future.
- */
-function useContextValue(content) {
-    return useMemo(() => ({
-        metadata: content.metadata,
-        frontMatter: content.frontMatter,
-        assets: content.assets,
-        contentTitle: content.contentTitle,
-        toc: content.toc,
-    }), [content]);
-}
-/**
- * This is a very thin layer around the `content` received from the MDX loader.
- * It provides metadata about the doc to the children tree.
- */
-export function DocProvider({ children, content, }) {
-    const contextValue = useContextValue(content);
-    return <Context.Provider value={contextValue}>{children}</Context.Provider>;
-}
-/**
- * Returns the data of the currently browsed doc. Gives access to the doc's MDX
- * Component, front matter, metadata, TOC, etc. When swizzling a low-level
- * component (e.g. the "Edit this page" link) and you need some extra metadata,
- * you don't have to drill the props all the way through the component tree:
- * simply use this hook instead.
- */
-export function useDoc() {
-    const doc = useContext(Context);
-    if (doc === null) {
-        throw new ReactContextError('DocProvider');
-    }
-    return doc;
-}
-//# sourceMappingURL=doc.js.map

package/lib/contexts/doc.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"doc.js","sourceRoot":"","sources":["../../src/contexts/doc.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,EAAC,OAAO,EAAkB,UAAU,EAAC,MAAM,OAAO,CAAC;AACjE,OAAO,EAAC,iBAAiB,EAAC,MAAM,qBAAqB,CAAC;AAYtD,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAAyB,IAAI,CAAC,CAAC;AAElE;;;;;;GAMG;AACH,SAAS,eAAe,CAAC,OAAuB;IAC9C,OAAO,OAAO,CACZ,GAAG,EAAE,CAAC,CAAC;QACL,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,GAAG,EAAE,OAAO,CAAC,GAAG;KACjB,CAAC,EACF,CAAC,OAAO,CAAC,CACV,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,EAC1B,QAAQ,EACR,OAAO,GAIR;IACC,MAAM,YAAY,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;IAC9C,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC9E,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,MAAM;IACpB,MAAM,GAAG,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAChC,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QACjB,MAAM,IAAI,iBAAiB,CAAC,aAAa,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/lib/contexts/docSidebarItemsExpandedState.d.ts

@@ -1,31 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-import { type ReactNode } from 'react';
-type ContextValue = {
-    /**
-     * The item that the user last opened, `null` when there's none open. On
-     * initial render, it will always be `null`, which doesn't necessarily mean
-     * there's no category open (can have 0, 1, or many being initially open).
-     */
-    expandedItem: number | null;
-    /**
-     * Set the currently expanded item, when the user opens one. Set the value to
-     * `null` when the user closes an open category.
-     */
-    setExpandedItem: (a: number | null) => void;
-};
-/**
- * Should be used to wrap one sidebar category level. This provider syncs the
- * expanded states of all sibling categories, and categories can choose to
- * collapse itself if another one is expanded.
- */
-export declare function DocSidebarItemsExpandedStateProvider({ children, }: {
-    children: ReactNode;
-}): JSX.Element;
-export declare function useDocSidebarItemsExpandedState(): ContextValue;
-export {};
-//# sourceMappingURL=docSidebarItemsExpandedState.d.ts.map

package/lib/contexts/docSidebarItemsExpandedState.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"docSidebarItemsExpandedState.d.ts","sourceRoot":"","sources":["../../src/contexts/docSidebarItemsExpandedState.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAc,EAAC,KAAK,SAAS,EAAgC,MAAM,OAAO,CAAC;AAG3E,KAAK,YAAY,GAAG;IAClB;;;;OAIG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B;;;OAGG;IACH,eAAe,EAAE,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,CAAC;CAC7C,CAAC;AAOF;;;;GAIG;AACH,wBAAgB,oCAAoC,CAAC,EACnD,QAAQ,GACT,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;CACrB,GAAG,GAAG,CAAC,OAAO,CAQd;AAED,wBAAgB,+BAA+B,IAAI,YAAY,CAM9D"}