@docusaurus/plugin-content-docs 3.10.2 → 4.0.0-canary-6809

package/lib/client/doc.js

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React, { useMemo, useContext } from 'react';
-import { ReactContextError } from '@docusaurus/theme-common/internal';
+import { ReactContextError } from '@docusaurus/theme-common';
 const Context = React.createContext(null);
 /**
  * Note: we don't use `PropDoc` as context value on purpose. Metadata is

package/lib/client/docSidebarItemsExpandedState.js

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React, { useMemo, useState, useContext } from 'react';
-import { ReactContextError } from '@docusaurus/theme-common/internal';
+import { ReactContextError } from '@docusaurus/theme-common';
 const EmptyContext = Symbol('EmptyContext');
 const Context = React.createContext(EmptyContext);
 /**

package/lib/client/docsPreferredVersion.js

@@ -8,7 +8,7 @@ import React, { useContext, useEffect, useMemo, useState, useCallback, } from 'r
 import { useAllDocsData, useDocsData, } from '@docusaurus/plugin-content-docs/client';
 import { DEFAULT_PLUGIN_ID } from '@docusaurus/constants';
 import { useThemeConfig } from '@docusaurus/theme-common';
-import { ReactContextError, createStorageSlot, } from '@docusaurus/theme-common/internal';
+import { ReactContextError, createStorageSlot } from '@docusaurus/theme-common';
 const storageKey = (pluginId) => `docs-preferred-version-${pluginId}`;
 const DocsPreferredVersionStorage = {
     save: (pluginId, persistence, versionName) => {

package/lib/client/docsSidebar.js

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React, { useMemo, useContext } from 'react';
-import { ReactContextError } from '@docusaurus/theme-common/internal';
+import { ReactContextError } from '@docusaurus/theme-common';
 // Using a Symbol because null is a valid context value (a doc with no sidebar)
 // Inspired by https://github.com/jamiebuilds/unstated-next/blob/master/src/unstated-next.tsx
 const EmptyContext = Symbol('EmptyContext');

package/lib/client/docsVersion.js

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React, { useContext } from 'react';
-import { ReactContextError } from '@docusaurus/theme-common/internal';
+import { ReactContextError } from '@docusaurus/theme-common';
 const Context = React.createContext(null);
 /**
  * Provide the current version's metadata to your children.

package/lib/client/structuredDataUtils.js

@@ -5,8 +5,15 @@
  * LICENSE file in the root directory of this source tree.
  */
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-export function useBreadcrumbsStructuredData({ breadcrumbs, }) {
-    const { siteConfig } = useDocusaurusContext();
+import { applyTrailingSlash } from '@docusaurus/utils-common';
+function getAbsoluteUrl(permalink, params) {
+    const absoluteUrl = `${params.url}${permalink}`;
+    return applyTrailingSlash(absoluteUrl, {
+        trailingSlash: params.trailingSlash,
+        baseUrl: params.baseUrl,
+    });
+}
+function getBreadcrumbsStructuredData({ breadcrumbs, params, }) {
     return {
         '@context': 'https://schema.org',
         '@type': 'BreadcrumbList',
@@ -18,7 +25,11 @@ export function useBreadcrumbsStructuredData({ breadcrumbs, }) {
             '@type': 'ListItem',
             position: index + 1,
             name: breadcrumb.label,
-            item: `${siteConfig.url}${breadcrumb.href}`,
+            item: getAbsoluteUrl(breadcrumb.href, params),
         })),
     };
 }
+export function useBreadcrumbsStructuredData({ breadcrumbs, }) {
+    const { siteConfig } = useDocusaurusContext();
+    return getBreadcrumbsStructuredData({ breadcrumbs, params: siteConfig });
+}

package/lib/frontMatter.d.ts

@@ -1,3 +1,9 @@
+/**
+ * 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 { DocFrontMatter } from '@docusaurus/plugin-content-docs';
 export declare const DocFrontMatterSchema: import("joi").ObjectSchema<DocFrontMatter>;
 export declare function validateDocFrontMatter(frontMatter: {

package/lib/frontMatter.js

@@ -1,13 +1,14 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DocFrontMatterSchema = void 0;
-exports.validateDocFrontMatter = validateDocFrontMatter;
 /**
  * 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.
  */
+/* eslint-disable camelcase */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocFrontMatterSchema = void 0;
+exports.validateDocFrontMatter = validateDocFrontMatter;
 const utils_validation_1 = require("@docusaurus/utils-validation");
 // NOTE: we don't add any default value on purpose here
 // We don't want default values to magically appear in doc metadata and props

package/lib/sidebars/generator.js

@@ -131,7 +131,7 @@ Available doc IDs:
                     return undefined;
                 }
                 const id = link
-                    ? findDocByLocalId(link.id)?.id ?? getDoc(link.id).id
+                    ? (findDocByLocalId(link.id)?.id ?? getDoc(link.id).id)
                     : findConventionalCategoryDocLink()?.id;
                 if (!id) {
                     return undefined;

package/lib/sidebars/index.js

@@ -73,7 +73,7 @@ async function loadSidebarsFileUnsafe(sidebarFilePath) {
         return exports.DisabledSidebars;
     }
     // We don't want sidebars to be cached because of hot reloading.
-    const module = await (0, utils_1.loadFreshModule)(sidebarFilePath);
+    const module = await (0, utils_1.loadFreshModule)(sidebarFilePath, { default: true });
     // TODO unsafe, need to refactor and improve validation
     return module;
 }

package/lib/versions/files.js

@@ -93,7 +93,7 @@ async function readVersionNames(siteDir, options) {
     if (!versionFileContent && options.disableVersioning) {
         throw new Error(`Docs: using "disableVersioning: true" option on a non-versioned site does not make sense.`);
     }
-    const versions = options.disableVersioning ? [] : versionFileContent ?? [];
+    const versions = options.disableVersioning ? [] : (versionFileContent ?? []);
     // We add the current version at the beginning, unless:
     // - user don't want to; or
     // - it's already been explicitly added to versions.json

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "3.10.2",
+  "version": "4.0.0-canary-6809",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": false,
@@ -35,37 +35,37 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "3.10.2",
-    "@docusaurus/logger": "3.10.2",
-    "@docusaurus/mdx-loader": "3.10.2",
-    "@docusaurus/module-type-aliases": "3.10.2",
-    "@docusaurus/theme-common": "3.10.2",
-    "@docusaurus/types": "3.10.2",
-    "@docusaurus/utils": "3.10.2",
-    "@docusaurus/utils-common": "3.10.2",
-    "@docusaurus/utils-validation": "3.10.2",
-    "@types/react-router-config": "^5.0.7",
-    "combine-promises": "^1.1.0",
-    "fs-extra": "^11.1.1",
-    "js-yaml": "^4.1.0",
-    "lodash": "^4.17.21",
-    "schema-dts": "^1.1.2",
-    "tslib": "^2.6.0",
-    "utility-types": "^3.10.0",
-    "webpack": "^5.88.1"
+    "@docusaurus/core": "4.0.0-canary-6809",
+    "@docusaurus/logger": "4.0.0-canary-6809",
+    "@docusaurus/mdx-loader": "4.0.0-canary-6809",
+    "@docusaurus/module-type-aliases": "4.0.0-canary-6809",
+    "@docusaurus/theme-common": "4.0.0-canary-6809",
+    "@docusaurus/types": "4.0.0-canary-6809",
+    "@docusaurus/utils": "4.0.0-canary-6809",
+    "@docusaurus/utils-common": "4.0.0-canary-6809",
+    "@docusaurus/utils-validation": "4.0.0-canary-6809",
+    "@types/react-router-config": "^5.0.11",
+    "combine-promises": "^1.2.0",
+    "fs-extra": "^11.4.0",
+    "js-yaml": "^4.3.2",
+    "lodash": "^4.18.1",
+    "schema-dts": "^1.1.5",
+    "tslib": "^2.8.1",
+    "utility-types": "^3.11.0",
+    "webpack": "^5.110.3"
   },
   "devDependencies": {
-    "@types/js-yaml": "^4.0.5",
-    "@types/picomatch": "^2.3.0",
+    "@types/js-yaml": "^4.0.9",
+    "@types/picomatch": "^2.3.4",
     "commander": "^5.1.0",
-    "picomatch": "^2.3.1"
+    "picomatch": "^2.3.2"
   },
   "peerDependencies": {
-    "react": "^18.0.0 || ^19.0.0",
-    "react-dom": "^18.0.0 || ^19.0.0"
+    "react": "^19.3.0",
+    "react-dom": "^19.3.0"
   },
   "engines": {
-    "node": ">=20.0"
+    "node": ">=24.14"
   },
-  "gitHead": "f37f9035584917a97a260b91fc2842cba4f8b94f"
+  "gitHead": "db942b07f3529b5359bcae27ab3796cb07dec10e"
 }

package/src/client/doc.tsx

@@ -6,7 +6,7 @@
  */
 
 import React, {useMemo, type ReactNode, useContext} from 'react';
-import {ReactContextError} from '@docusaurus/theme-common/internal';
+import {ReactContextError} from '@docusaurus/theme-common';
 import type {PropDocContent} from '@docusaurus/plugin-content-docs';
 
 /**

package/src/client/docSidebarItemsExpandedState.tsx

@@ -6,7 +6,7 @@
  */
 
 import React, {type ReactNode, useMemo, useState, useContext} from 'react';
-import {ReactContextError} from '@docusaurus/theme-common/internal';
+import {ReactContextError} from '@docusaurus/theme-common';
 
 type ContextValue = {
   /**

package/src/client/docsPreferredVersion.tsx

@@ -21,10 +21,7 @@ import {
 } from '@docusaurus/plugin-content-docs/client';
 import {DEFAULT_PLUGIN_ID} from '@docusaurus/constants';
 import {useThemeConfig, type ThemeConfig} from '@docusaurus/theme-common';
-import {
-  ReactContextError,
-  createStorageSlot,
-} from '@docusaurus/theme-common/internal';
+import {ReactContextError, createStorageSlot} from '@docusaurus/theme-common';
 
 type DocsVersionPersistence = ThemeConfig['docs']['versionPersistence'];
 

package/src/client/docsSearch.test.ts

@@ -5,6 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+import {describe, expect, it} from 'vitest';
 import {getDocsVersionSearchTag} from './docsSearch';
 
 describe('getDocsVersionSearchTag', () => {

package/src/client/docsSidebar.tsx

@@ -6,7 +6,7 @@
  */
 
 import React, {useMemo, useContext, type ReactNode} from 'react';
-import {ReactContextError} from '@docusaurus/theme-common/internal';
+import {ReactContextError} from '@docusaurus/theme-common';
 import type {PropSidebar} from '@docusaurus/plugin-content-docs';
 
 // Using a Symbol because null is a valid context value (a doc with no sidebar)

package/src/client/docsVersion.tsx

@@ -6,7 +6,7 @@
  */
 
 import React, {type ReactNode, useContext} from 'react';
-import {ReactContextError} from '@docusaurus/theme-common/internal';
+import {ReactContextError} from '@docusaurus/theme-common';
 import type {PropVersionMetadata} from '@docusaurus/plugin-content-docs';
 
 const Context = React.createContext<PropVersionMetadata | null>(null);

package/src/client/index.ts

@@ -138,7 +138,7 @@ export const useDocsData = (pluginId: string | undefined): GlobalPluginData => {
       `You are using a feature of the Docusaurus docs plugin, but this plugin does not seem to be enabled${
         pluginId === 'Default' ? '' : ` (pluginId=${pluginId}`
       }`,
-      {cause: error as Error},
+      {cause: error},
     );
   }
 };

package/src/client/structuredDataUtils.ts

@@ -6,15 +6,28 @@
  */
 
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+import {applyTrailingSlash} from '@docusaurus/utils-common';
 import type {PropSidebarBreadcrumbsItem} from '@docusaurus/plugin-content-docs';
 import type {WithContext, BreadcrumbList} from 'schema-dts';
+import type {DocusaurusConfig} from '@docusaurus/types';
 
-export function useBreadcrumbsStructuredData({
+type Params = Pick<DocusaurusConfig, 'url' | 'baseUrl' | 'trailingSlash'>;
+
+function getAbsoluteUrl(permalink: string, params: Params): string {
+  const absoluteUrl = `${params.url}${permalink}`;
+  return applyTrailingSlash(absoluteUrl, {
+    trailingSlash: params.trailingSlash,
+    baseUrl: params.baseUrl,
+  });
+}
+
+function getBreadcrumbsStructuredData({
   breadcrumbs,
+  params,
 }: {
   breadcrumbs: PropSidebarBreadcrumbsItem[];
+  params: Params;
 }): WithContext<BreadcrumbList> {
-  const {siteConfig} = useDocusaurusContext();
   return {
     '@context': 'https://schema.org',
     '@type': 'BreadcrumbList',
@@ -26,7 +39,16 @@ export function useBreadcrumbsStructuredData({
         '@type': 'ListItem',
         position: index + 1,
         name: breadcrumb.label,
-        item: `${siteConfig.url}${breadcrumb.href}`,
+        item: getAbsoluteUrl(breadcrumb.href!, params),
       })),
   };
 }
+
+export function useBreadcrumbsStructuredData({
+  breadcrumbs,
+}: {
+  breadcrumbs: PropSidebarBreadcrumbsItem[];
+}): WithContext<BreadcrumbList> {
+  const {siteConfig} = useDocusaurusContext();
+  return getBreadcrumbsStructuredData({breadcrumbs, params: siteConfig});
+}

package/src/docs.ts

@@ -258,7 +258,7 @@ export async function processDocMetadata(args: {
   } catch (err) {
     throw new Error(
       `Can't process doc metadata for doc at path path=${args.docFile.filePath} in version name=${args.versionMetadata.versionName}`,
-      {cause: err as Error},
+      {cause: err},
     );
   }
 }

package/src/frontMatter.ts

@@ -4,6 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+/* eslint-disable camelcase */
+
 import {
   JoiFrontMatter as Joi, // Custom instance for front matter
   URISchema,

package/src/sidebars/generator.ts

@@ -206,7 +206,7 @@ Available doc IDs:
           return undefined;
         }
         const id = link
-          ? findDocByLocalId(link.id)?.id ?? getDoc(link.id).id
+          ? (findDocByLocalId(link.id)?.id ?? getDoc(link.id).id)
           : findConventionalCategoryDocLink()?.id;
         if (!id) {
           return undefined;

package/src/sidebars/index.ts

@@ -88,7 +88,7 @@ async function loadSidebarsFileUnsafe(
   }
 
   // We don't want sidebars to be cached because of hot reloading.
-  const module = await loadFreshModule(sidebarFilePath);
+  const module = await loadFreshModule(sidebarFilePath, {default: true});
 
   // TODO unsafe, need to refactor and improve validation
   return module as SidebarsConfig;

package/src/versions/files.ts

@@ -145,7 +145,7 @@ export async function readVersionNames(
     );
   }
 
-  const versions = options.disableVersioning ? [] : versionFileContent ?? [];
+  const versions = options.disableVersioning ? [] : (versionFileContent ?? []);
 
   // We add the current version at the beginning, unless:
   // - user don't want to; or