@docusaurus/core 4.0.0-canary-6839 → 4.0.0-canary-6841

package/lib/client/App.js

@@ -13,7 +13,6 @@ import Root from '@theme/Root';
 import ThemeProvider from '@theme/ThemeProvider';
 import SiteMetadata from '@theme/SiteMetadata';
 import normalizeLocation from './normalizeLocation';
-import { BrowserContextProvider } from './browserContext';
 import { DocusaurusContextProvider } from './docusaurusContext';
 import PendingNavigation from './PendingNavigation';
 import BaseUrlIssueBanner from './BaseUrlIssueBanner';
@@ -33,17 +32,15 @@ function AppNavigation() {
 export default function App() {
     return (<ErrorBoundary>
       <DocusaurusContextProvider>
-        <BrowserContextProvider>
-          <Root>
-            <ThemeProvider>
-              <SiteMetadataDefaults />
-              <SiteMetadata />
-              <BaseUrlIssueBanner />
-              <AppNavigation />
-            </ThemeProvider>
-          </Root>
-          <HasHydratedDataAttribute />
-        </BrowserContextProvider>
+        <Root>
+          <ThemeProvider>
+            <SiteMetadataDefaults />
+            <SiteMetadata />
+            <BaseUrlIssueBanner />
+            <AppNavigation />
+          </ThemeProvider>
+        </Root>
+        <HasHydratedDataAttribute />
       </DocusaurusContextProvider>
     </ErrorBoundary>);
 }

package/lib/client/exports/useIsBrowser.js

@@ -4,8 +4,14 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { useContext } from 'react';
-import { Context } from '../browserContext';
+import { useSyncExternalStore } from 'react';
+// The "browser" state never changes, there's nothing to subscribe to
+const subscribe = () => () => { };
+// On first client-side render, we need to render exactly as the server rendered
+// See https://www.joshwcomeau.com/react/the-perils-of-rehydration/
+// React uses getServerSnapshot during SSR and hydration, and re-renders with
+// getSnapshot right after hydration. Components mounted after hydration
+// directly get the client value, without an extra re-render.
 export default function useIsBrowser() {
-    return useContext(Context);
+    return useSyncExternalStore(subscribe, () => true, () => false);
 }

package/lib/commands/start/utils.d.ts

@@ -15,9 +15,6 @@ export type OpenUrlContext = {
         router: RouterType;
     }) => string;
 };
-export declare function createOpenUrlContext({ cliOptions, }: {
-    cliOptions: StartCLIOptions;
-}): Promise<OpenUrlContext>;
 type StartParams = {
     siteDirParam: string;
     cliOptions: Partial<StartCLIOptions>;

package/lib/commands/start/utils.js

@@ -6,7 +6,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createOpenUrlContext = createOpenUrlContext;
 exports.createReloadableSite = createReloadableSite;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));

package/lib/commands/start/watcher.d.ts

@@ -11,27 +11,11 @@ type PollingOptions = {
     interval: number | undefined;
 };
 export declare function createPollingOptions(cliOptions: StartCLIOptions): PollingOptions;
-export type FileWatchEventName = 'add' | 'addDir' | 'change' | 'unlink' | 'unlinkDir';
+type FileWatchEventName = 'add' | 'addDir' | 'change' | 'unlink' | 'unlinkDir';
 export type FileWatchEvent = {
     name: FileWatchEventName;
     path: string;
 };
-type WatchParams = {
-    pathsToWatch: string[];
-    siteDir: string;
-} & PollingOptions;
-/**
- * Watch file system paths for changes and emit events
- * Returns an async handle to stop watching
- */
-export declare function watchPaths(params: WatchParams, callback: (event: FileWatchEvent) => void): () => Promise<void>;
-export declare function getSitePathsToWatch({ props }: {
-    props: Props;
-}): string[];
-export declare function getPluginPathsToWatch({ siteDir, plugin, }: {
-    siteDir: string;
-    plugin: LoadedPlugin;
-}): string[];
 export declare function setupSiteFileWatchers({ props, cliOptions, }: {
     props: Props;
     cliOptions: StartCLIOptions;

package/lib/commands/start/watcher.js

@@ -7,9 +7,6 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createPollingOptions = createPollingOptions;
-exports.watchPaths = watchPaths;
-exports.getSitePathsToWatch = getSitePathsToWatch;
-exports.getPluginPathsToWatch = getPluginPathsToWatch;
 exports.setupSiteFileWatchers = setupSiteFileWatchers;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));

package/lib/commands/swizzle/components.d.ts

@@ -25,7 +25,6 @@ export type ThemeComponents = {
  */
 export declare function getMissingIntermediateComponentFolderNames(componentNames: string[]): string[];
 export declare function readComponentNames(themePath: string): Promise<string[]>;
-export declare function listComponentNames(themeComponents: ThemeComponents): string;
 export declare function getThemeComponents({ themeName, themePath, swizzleConfig, }: {
     themeName: string;
     themePath: string;

package/lib/commands/swizzle/components.js

@@ -8,7 +8,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getMissingIntermediateComponentFolderNames = getMissingIntermediateComponentFolderNames;
 exports.readComponentNames = readComponentNames;
-exports.listComponentNames = listComponentNames;
 exports.getThemeComponents = getThemeComponents;
 exports.getComponentName = getComponentName;
 const tslib_1 = require("tslib");

package/lib/commands/swizzle/themes.d.ts

@@ -5,7 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { type SwizzlePlugin } from './common';
-export declare function pluginToThemeName(plugin: SwizzlePlugin): string | undefined;
 export declare function getPluginByThemeName(plugins: SwizzlePlugin[], themeName: string): SwizzlePlugin;
 export declare function getThemeNames(plugins: SwizzlePlugin[]): string[];
 export declare function getThemeName({ themeNameParam, themeNames, list, }: {

package/lib/commands/swizzle/themes.js

@@ -6,7 +6,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.pluginToThemeName = pluginToThemeName;
 exports.getPluginByThemeName = getPluginByThemeName;
 exports.getThemeNames = getThemeNames;
 exports.getThemeName = getThemeName;

package/lib/server/configValidation.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { Joi } from '@docusaurus/utils-validation';
-import type { DocusaurusConfig, FasterConfig, FutureConfig, FutureV4Config, I18nConfig, MDX1CompatOptions, MarkdownConfig, MarkdownHooks, StorageConfig } from '@docusaurus/types';
+import type { DocusaurusConfig, FasterConfig, FutureConfig, FutureV4Config, I18nConfig, StorageConfig } from '@docusaurus/types';
 export declare const DEFAULT_I18N_CONFIG: I18nConfig;
 export declare const DEFAULT_STORAGE_CONFIG: StorageConfig;
 export declare const DEFAULT_FASTER_CONFIG: FasterConfig;
@@ -13,9 +13,6 @@ export declare const DEFAULT_FASTER_CONFIG_TRUE: FasterConfig;
 export declare const DEFAULT_FUTURE_V4_CONFIG: FutureV4Config;
 export declare const DEFAULT_FUTURE_V4_CONFIG_TRUE: FutureV4Config;
 export declare const DEFAULT_FUTURE_CONFIG: FutureConfig;
-export declare const DEFAULT_MARKDOWN_HOOKS: MarkdownHooks;
-export declare const DEFAULT_MARKDOWN_MDX1COMPAT: MDX1CompatOptions;
-export declare const DEFAULT_MARKDOWN_CONFIG: MarkdownConfig;
 export declare const DEFAULT_CONFIG: Pick<DocusaurusConfig, 'i18n' | 'storage' | 'future' | 'onBrokenLinks' | 'onBrokenAnchors' | 'onBrokenMarkdownLinks' | 'onDuplicateRoutes' | 'plugins' | 'themes' | 'presets' | 'headTags' | 'stylesheets' | 'scripts' | 'clientModules' | 'customFields' | 'themeConfig' | 'titleDelimiter' | 'noIndex' | 'tagline' | 'baseUrlIssueBanner' | 'staticDirectories' | 'markdown'>;
 export declare const ConfigSchema: Joi.ObjectSchema<DocusaurusConfig>;
 export declare function validateConfig(config: unknown, siteConfigPath: string): DocusaurusConfig;

package/lib/server/configValidation.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigSchema = exports.DEFAULT_CONFIG = exports.DEFAULT_MARKDOWN_CONFIG = exports.DEFAULT_MARKDOWN_MDX1COMPAT = exports.DEFAULT_MARKDOWN_HOOKS = exports.DEFAULT_FUTURE_CONFIG = exports.DEFAULT_FUTURE_V4_CONFIG_TRUE = exports.DEFAULT_FUTURE_V4_CONFIG = exports.DEFAULT_FASTER_CONFIG_TRUE = exports.DEFAULT_FASTER_CONFIG = exports.DEFAULT_STORAGE_CONFIG = exports.DEFAULT_I18N_CONFIG = void 0;
+exports.ConfigSchema = exports.DEFAULT_CONFIG = exports.DEFAULT_FUTURE_CONFIG = exports.DEFAULT_FUTURE_V4_CONFIG_TRUE = exports.DEFAULT_FUTURE_V4_CONFIG = exports.DEFAULT_FASTER_CONFIG_TRUE = exports.DEFAULT_FASTER_CONFIG = exports.DEFAULT_STORAGE_CONFIG = exports.DEFAULT_I18N_CONFIG = void 0;
 exports.validateConfig = validateConfig;
 const tslib_1 = require("tslib");
 const utils_1 = require("@docusaurus/utils");
@@ -87,17 +87,17 @@ exports.DEFAULT_FUTURE_CONFIG = {
     experimental_vcs: (0, utils_1.getVcsPreset)('default-v1'),
     experimental_router: 'browser',
 };
-exports.DEFAULT_MARKDOWN_HOOKS = {
+const DEFAULT_MARKDOWN_HOOKS = {
     onBrokenMarkdownLinks: 'warn',
     onBrokenMarkdownImages: 'throw',
     onUnusedMarkdownDirectives: 'warn',
 };
-exports.DEFAULT_MARKDOWN_MDX1COMPAT = {
+const DEFAULT_MARKDOWN_MDX1COMPAT = {
     comments: true,
     admonitions: true,
     headingIds: true,
 };
-exports.DEFAULT_MARKDOWN_CONFIG = {
+const DEFAULT_MARKDOWN_CONFIG = {
     // TODO Docusaurus v5: change this to "detect"?
     //  we probably need stable CommonMark support first
     //  see https://github.com/facebook/docusaurus/issues/9092
@@ -106,12 +106,12 @@ exports.DEFAULT_MARKDOWN_CONFIG = {
     emoji: true,
     preprocessor: undefined,
     parseFrontMatter: utils_1.DEFAULT_PARSE_FRONT_MATTER,
-    mdx1Compat: exports.DEFAULT_MARKDOWN_MDX1COMPAT,
+    mdx1Compat: DEFAULT_MARKDOWN_MDX1COMPAT,
     anchors: {
         maintainCase: false,
     },
     remarkRehypeOptions: undefined,
-    hooks: exports.DEFAULT_MARKDOWN_HOOKS,
+    hooks: DEFAULT_MARKDOWN_HOOKS,
 };
 exports.DEFAULT_CONFIG = {
     i18n: exports.DEFAULT_I18N_CONFIG,
@@ -135,7 +135,7 @@ exports.DEFAULT_CONFIG = {
     tagline: '',
     baseUrlIssueBanner: true,
     staticDirectories: [utils_1.DEFAULT_STATIC_DIR_NAME],
-    markdown: exports.DEFAULT_MARKDOWN_CONFIG,
+    markdown: DEFAULT_MARKDOWN_CONFIG,
 };
 function createPluginSchema(theme) {
     return utils_validation_1.Joi.alternatives()
@@ -449,7 +449,7 @@ function postProcessDocusaurusConfig(config) {
     // Resolve mdx1Compat config based on the v4.mdx1CompatDisabledByDefault flag
     // undefined means "not explicitly set by user"
     const mdx1CompatDefault = !config.future.v4.mdx1CompatDisabledByDefault;
-    const mdx1CompatKeys = Object.keys(exports.DEFAULT_MARKDOWN_MDX1COMPAT);
+    const mdx1CompatKeys = Object.keys(DEFAULT_MARKDOWN_MDX1COMPAT);
     for (const key of mdx1CompatKeys) {
         (_a = config.markdown.mdx1Compat)[key] ?? (_a[key] = mdx1CompatDefault);
     }

package/lib/server/translations/translations.d.ts

@@ -23,7 +23,6 @@ export declare function localizePluginTranslationFile({ localizationDir, plugin,
     plugin: InitializedPlugin;
     translationFile: TranslationFile;
 }): Promise<TranslationFile>;
-export declare function mergeCodeTranslations(codeTranslations: CodeTranslations[]): CodeTranslations;
 export declare function loadPluginsDefaultCodeTranslationMessages(plugins: InitializedPlugin[]): Promise<CodeTranslations>;
 export declare function getPluginsDefaultCodeTranslations({ plugins, }: {
     plugins: LoadedPlugin[];

package/lib/server/translations/translations.js

@@ -10,7 +10,6 @@ exports.readCodeTranslationFileContent = readCodeTranslationFileContent;
 exports.writeCodeTranslations = writeCodeTranslations;
 exports.writePluginTranslations = writePluginTranslations;
 exports.localizePluginTranslationFile = localizePluginTranslationFile;
-exports.mergeCodeTranslations = mergeCodeTranslations;
 exports.loadPluginsDefaultCodeTranslationMessages = loadPluginsDefaultCodeTranslationMessages;
 exports.getPluginsDefaultCodeTranslations = getPluginsDefaultCodeTranslations;
 exports.applyDefaultCodeTranslations = applyDefaultCodeTranslations;

package/lib/ssg/ssgTemplate.d.ts

@@ -6,7 +6,7 @@
  */
 import type { SSGParams } from './ssgParams';
 import type { AppRenderResult } from '../common';
-export type SSGTemplateData = {
+type SSGTemplateData = {
     appHtml: string;
     baseUrl: string;
     htmlAttributes: string;
@@ -30,3 +30,4 @@ export declare function renderSSGTemplate({ params, result, ssgTemplate, }: {
 export declare function renderHashRouterTemplate({ params, }: {
     params: SSGParams;
 }): Promise<string>;
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "4.0.0-canary-6839",
+  "version": "4.0.0-canary-6841",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -33,14 +33,14 @@
     "url": "https://github.com/facebook/docusaurus/issues"
   },
   "dependencies": {
-    "@docusaurus/babel": "4.0.0-canary-6839",
-    "@docusaurus/bundler": "4.0.0-canary-6839",
-    "@docusaurus/glob": "4.0.0-canary-6839",
-    "@docusaurus/logger": "4.0.0-canary-6839",
-    "@docusaurus/mdx-loader": "4.0.0-canary-6839",
-    "@docusaurus/utils": "4.0.0-canary-6839",
-    "@docusaurus/utils-common": "4.0.0-canary-6839",
-    "@docusaurus/utils-validation": "4.0.0-canary-6839",
+    "@docusaurus/babel": "4.0.0-canary-6841",
+    "@docusaurus/bundler": "4.0.0-canary-6841",
+    "@docusaurus/glob": "4.0.0-canary-6841",
+    "@docusaurus/logger": "4.0.0-canary-6841",
+    "@docusaurus/mdx-loader": "4.0.0-canary-6841",
+    "@docusaurus/utils": "4.0.0-canary-6841",
+    "@docusaurus/utils-common": "4.0.0-canary-6841",
+    "@docusaurus/utils-validation": "4.0.0-canary-6841",
     "boxen": "^8.0.1",
     "cli-table3": "^0.6.5",
     "combine-promises": "^1.2.0",
@@ -76,8 +76,8 @@
     "webpack-merge": "^6.0.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "4.0.0-canary-6839",
-    "@docusaurus/types": "4.0.0-canary-6839",
+    "@docusaurus/module-type-aliases": "4.0.0-canary-6841",
+    "@docusaurus/types": "4.0.0-canary-6841",
     "@total-typescript/shoehorn": "^0.1.2",
     "@types/escape-html": "^1.0.4",
     "@types/history": "^4.7.11",
@@ -88,10 +88,11 @@
     "@types/update-notifier": "^6.0.8",
     "@types/webpack-bundle-analyzer": "^4.7.0",
     "@types/webpack-env": "^1.18.8",
-    "tree-node-cli": "^3.0.0"
+    "tree-node-cli": "^3.0.0",
+    "utility-types": "^3.11.0"
   },
   "peerDependencies": {
-    "@docusaurus/faster": "4.0.0-canary-6839",
+    "@docusaurus/faster": "4.0.0-canary-6841",
     "@mdx-js/react": "^3.1.1",
     "react": "^19.3.0",
     "react-dom": "^19.3.0"
@@ -104,5 +105,5 @@
   "engines": {
     "node": ">=24.21"
   },
-  "gitHead": "c93a33b60c528917c38fbf07e54c14ff52bdc190"
+  "gitHead": "6c97ad62ff58f7eda88392a0e33fcd982d826567"
 }

package/lib/client/browserContext.d.ts

@@ -1,11 +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, { type ReactNode } from 'react';
-export declare const Context: React.Context<boolean>;
-export declare function BrowserContextProvider({ children, }: {
-    children: ReactNode;
-}): ReactNode;

package/lib/client/browserContext.js

@@ -1,22 +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, { useEffect, useState } from 'react';
-// Encapsulate the logic to avoid React hydration problems
-// See https://www.joshwcomeau.com/react/the-perils-of-rehydration/
-// On first client-side render, we need to render exactly as the server rendered
-// isBrowser is set to true only after a successful hydration
-// Note, isBrowser is not part of useDocusaurusContext() for perf reasons
-// Using useDocusaurusContext() (much more common need) should not trigger
-// re-rendering after a successful hydration
-export const Context = React.createContext(false);
-export function BrowserContextProvider({ children, }) {
-    const [isBrowser, setIsBrowser] = useState(false);
-    useEffect(() => {
-        setIsBrowser(true);
-    }, []);
-    return <Context.Provider value={isBrowser}>{children}</Context.Provider>;
-}