@docusaurus/core 0.0.0-5934 → 0.0.0-5938

package/lib/server/codegen/codegen.d.ts

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { CodeTranslations, DocusaurusConfig, GlobalData, I18n, PluginRouteConfig, SiteMetadata } from '@docusaurus/types';
+import type { CodeTranslations, DocusaurusConfig, GlobalData, I18n, PluginRouteConfig, SiteMetadata, SiteStorage } from '@docusaurus/types';
 type CodegenParams = {
     generatedFilesDir: string;
     siteConfig: DocusaurusConfig;
@@ -14,6 +14,7 @@ type CodegenParams = {
     i18n: I18n;
     codeTranslations: CodeTranslations;
     siteMetadata: SiteMetadata;
+    siteStorage: SiteStorage;
     routes: PluginRouteConfig[];
 };
 export declare function generateSiteFiles(params: CodegenParams): Promise<void>;

package/lib/server/codegen/codegen.js

@@ -50,6 +50,9 @@ function genCodeTranslations({ generatedFilesDir, codeTranslations, }) {
 function genSiteMetadata({ generatedFilesDir, siteMetadata, }) {
     return (0, utils_1.generate)(generatedFilesDir, 'site-metadata.json', JSON.stringify(siteMetadata, null, 2));
 }
+function genSiteStorage({ generatedFilesDir, siteStorage, }) {
+    return (0, utils_1.generate)(generatedFilesDir, 'site-storage.json', JSON.stringify(siteStorage, null, 2));
+}
 async function generateSiteFiles(params) {
     await Promise.all([
         genWarning(params),
@@ -58,6 +61,7 @@ async function generateSiteFiles(params) {
         (0, codegenRoutes_1.generateRouteFiles)(params),
         genGlobalData(params),
         genSiteMetadata(params),
+        genSiteStorage(params),
         genI18n(params),
         genCodeTranslations(params),
     ]);

package/lib/server/configValidation.d.ts

@@ -5,9 +5,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { Joi } from '@docusaurus/utils-validation';
+import type { FutureConfig, StorageConfig } from '@docusaurus/types/src/config';
 import type { DocusaurusConfig, I18nConfig, MarkdownConfig } from '@docusaurus/types';
 export declare const DEFAULT_I18N_CONFIG: I18nConfig;
+export declare const DEFAULT_STORAGE_CONFIG: StorageConfig;
+export declare const DEFAULT_FUTURE_CONFIG: FutureConfig;
 export declare const DEFAULT_MARKDOWN_CONFIG: MarkdownConfig;
-export declare const DEFAULT_CONFIG: Pick<DocusaurusConfig, 'i18n' | 'onBrokenLinks' | 'onBrokenAnchors' | 'onBrokenMarkdownLinks' | 'onDuplicateRoutes' | 'plugins' | 'themes' | 'presets' | 'headTags' | 'stylesheets' | 'scripts' | 'clientModules' | 'customFields' | 'themeConfig' | 'titleDelimiter' | 'noIndex' | 'tagline' | 'baseUrlIssueBanner' | 'staticDirectories' | 'markdown'>;
+export declare const DEFAULT_CONFIG: Pick<DocusaurusConfig, 'i18n' | '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.validateConfig = exports.ConfigSchema = exports.DEFAULT_CONFIG = exports.DEFAULT_MARKDOWN_CONFIG = exports.DEFAULT_I18N_CONFIG = void 0;
+exports.validateConfig = exports.ConfigSchema = exports.DEFAULT_CONFIG = exports.DEFAULT_MARKDOWN_CONFIG = exports.DEFAULT_FUTURE_CONFIG = exports.DEFAULT_STORAGE_CONFIG = exports.DEFAULT_I18N_CONFIG = void 0;
 const utils_1 = require("@docusaurus/utils");
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const utils_common_1 = require("@docusaurus/utils-common");
@@ -17,6 +17,13 @@ exports.DEFAULT_I18N_CONFIG = {
     locales: [DEFAULT_I18N_LOCALE],
     localeConfigs: {},
 };
+exports.DEFAULT_STORAGE_CONFIG = {
+    type: 'localStorage',
+    namespace: false,
+};
+exports.DEFAULT_FUTURE_CONFIG = {
+    experimental_storage: exports.DEFAULT_STORAGE_CONFIG,
+};
 exports.DEFAULT_MARKDOWN_CONFIG = {
     format: 'mdx', // TODO change this to "detect" in Docusaurus v4?
     mermaid: false,
@@ -34,6 +41,7 @@ exports.DEFAULT_MARKDOWN_CONFIG = {
 };
 exports.DEFAULT_CONFIG = {
     i18n: exports.DEFAULT_I18N_CONFIG,
+    future: exports.DEFAULT_FUTURE_CONFIG,
     onBrokenLinks: 'throw',
     onBrokenAnchors: 'warn', // TODO Docusaurus v4: change to throw
     onBrokenMarkdownLinks: 'warn',
@@ -120,6 +128,21 @@ const I18N_CONFIG_SCHEMA = utils_validation_1.Joi.object({
 })
     .optional()
     .default(exports.DEFAULT_I18N_CONFIG);
+const STORAGE_CONFIG_SCHEMA = utils_validation_1.Joi.object({
+    type: utils_validation_1.Joi.string()
+        .equal('localStorage', 'sessionStorage')
+        .default(exports.DEFAULT_STORAGE_CONFIG.type),
+    namespace: utils_validation_1.Joi.alternatives()
+        .try(utils_validation_1.Joi.string(), utils_validation_1.Joi.boolean())
+        .default(exports.DEFAULT_STORAGE_CONFIG.namespace),
+})
+    .optional()
+    .default(exports.DEFAULT_STORAGE_CONFIG);
+const FUTURE_CONFIG_SCHEMA = utils_validation_1.Joi.object({
+    experimental_storage: STORAGE_CONFIG_SCHEMA,
+})
+    .optional()
+    .default(exports.DEFAULT_FUTURE_CONFIG);
 const SiteUrlSchema = utils_validation_1.Joi.string()
     .required()
     .custom((value, helpers) => {
@@ -152,6 +175,7 @@ exports.ConfigSchema = utils_validation_1.Joi.object({
     url: SiteUrlSchema,
     trailingSlash: utils_validation_1.Joi.boolean(), // No default value! undefined = retrocompatible legacy behavior!
     i18n: I18N_CONFIG_SCHEMA,
+    future: FUTURE_CONFIG_SCHEMA,
     onBrokenLinks: utils_validation_1.Joi.string()
         .equal('ignore', 'log', 'warn', 'throw')
         .default(exports.DEFAULT_CONFIG.onBrokenLinks),

package/lib/server/i18n.js

@@ -10,8 +10,32 @@ exports.loadI18n = exports.getDefaultLocaleConfig = void 0;
 const tslib_1 = require("tslib");
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const rtl_detect_1 = require("rtl-detect");
+function inferLanguageDisplayName(locale) {
+    const tryLocale = (l) => {
+        try {
+            return new Intl.DisplayNames(l, {
+                type: 'language',
+                fallback: 'code',
+            }).of(l);
+        }
+        catch (e) {
+            // This is to compensate "of()" that is a bit strict
+            // Looks like starting Node 22, this locale throws: "en-US-u-ca-buddhist"
+            // RangeError: invalid_argument
+            return null;
+        }
+    };
+    const parts = locale.split('-');
+    // This is a best effort, we try various locale forms that could give a result
+    return (tryLocale(locale) ??
+        tryLocale(`${parts[0]}-${parts[1]}`) ??
+        tryLocale(parts[0]));
+}
 function getDefaultLocaleLabel(locale) {
-    const languageName = new Intl.DisplayNames(locale, { type: 'language' }).of(locale);
+    const languageName = inferLanguageDisplayName(locale);
+    if (!languageName) {
+        return locale;
+    }
     return (languageName.charAt(0).toLocaleUpperCase(locale) + languageName.substring(1));
 }
 function getDefaultCalendar(localeStr) {
@@ -34,13 +58,18 @@ function getDefaultCalendar(localeStr) {
     return 'gregory';
 }
 function getDefaultLocaleConfig(locale) {
-    return {
-        label: getDefaultLocaleLabel(locale),
-        direction: (0, rtl_detect_1.getLangDir)(locale),
-        htmlLang: locale,
-        calendar: getDefaultCalendar(locale),
-        path: locale,
-    };
+    try {
+        return {
+            label: getDefaultLocaleLabel(locale),
+            direction: (0, rtl_detect_1.getLangDir)(locale),
+            htmlLang: locale,
+            calendar: getDefaultCalendar(locale),
+            path: locale,
+        };
+    }
+    catch (e) {
+        throw new Error(`Docusaurus couldn't get default locale config for ${locale}`, { cause: e });
+    }
 }
 exports.getDefaultLocaleConfig = getDefaultLocaleConfig;
 async function loadI18n(config, options) {

package/lib/server/site.js

@@ -21,6 +21,7 @@ const translations_1 = require("./translations/translations");
 const utils_2 = require("../utils");
 const codegen_1 = require("./codegen/codegen");
 const routes_1 = require("./routes");
+const storage_1 = require("./storage");
 /**
  * Loading context is the very first step in site building. Its params are
  * directly acquired from CLI options. It mainly loads `siteConfig` and the i18n
@@ -53,9 +54,11 @@ async function loadContext(params) {
     const localizationDir = path_1.default.resolve(siteDir, i18n.path, i18n.localeConfigs[i18n.currentLocale].path);
     const siteConfig = { ...initialSiteConfig, baseUrl };
     const codeTranslations = await (0, translations_1.loadSiteCodeTranslations)({ localizationDir });
+    const siteStorage = (0, storage_1.createSiteStorage)(siteConfig);
     return {
         siteDir,
         siteVersion,
+        siteStorage,
         generatedFilesDir,
         localizationDir,
         siteConfig,
@@ -69,7 +72,7 @@ async function loadContext(params) {
 exports.loadContext = loadContext;
 function createSiteProps(params) {
     const { plugins, routes, context } = params;
-    const { generatedFilesDir, siteDir, siteVersion, siteConfig, siteConfigPath, outDir, baseUrl, i18n, localizationDir, codeTranslations: siteCodeTranslations, } = context;
+    const { generatedFilesDir, siteDir, siteVersion, siteConfig, siteConfigPath, siteStorage, outDir, baseUrl, i18n, localizationDir, codeTranslations: siteCodeTranslations, } = context;
     const { headTags, preBodyTags, postBodyTags } = (0, htmlTags_1.loadHtmlTags)(plugins);
     const siteMetadata = (0, siteMetadata_1.createSiteMetadata)({ plugins, siteVersion });
     const codeTranslations = {
@@ -83,6 +86,7 @@ function createSiteProps(params) {
         siteConfigPath,
         siteMetadata,
         siteVersion,
+        siteStorage,
         siteDir,
         outDir,
         baseUrl,
@@ -101,13 +105,14 @@ function createSiteProps(params) {
 // TODO global data should be part of site props?
 async function createSiteFiles({ site, globalData, }) {
     return utils_2.PerfLogger.async('Create site files', async () => {
-        const { props: { plugins, generatedFilesDir, siteConfig, siteMetadata, i18n, codeTranslations, routes, baseUrl, }, } = site;
+        const { props: { plugins, generatedFilesDir, siteConfig, siteMetadata, siteStorage, i18n, codeTranslations, routes, baseUrl, }, } = site;
         const clientModules = (0, clientModules_1.getAllClientModules)(plugins);
         await (0, codegen_1.generateSiteFiles)({
             generatedFilesDir,
             clientModules,
             siteConfig,
             siteMetadata,
+            siteStorage,
             i18n,
             codeTranslations,
             globalData,
@@ -125,7 +130,7 @@ async function createSiteFiles({ site, globalData, }) {
 async function loadSite(params) {
     const context = await utils_2.PerfLogger.async('Load context', () => loadContext(params));
     const { plugins, routes, globalData } = await (0, plugins_1.loadPlugins)(context);
-    const props = await createSiteProps({ plugins, routes, globalData, context });
+    const props = createSiteProps({ plugins, routes, globalData, context });
     const site = { props, params };
     await createSiteFiles({
         site,
@@ -147,7 +152,7 @@ async function reloadSitePlugin(site, pluginIdentifier) {
         plugins: site.props.plugins,
         context: site.props,
     });
-    const newProps = await createSiteProps({
+    const newProps = createSiteProps({
         plugins,
         routes,
         globalData,

package/lib/server/storage.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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 { DocusaurusConfig, SiteStorage } from '@docusaurus/types';
+type PartialFuture = Pick<DocusaurusConfig['future'], 'experimental_storage'>;
+type PartialConfig = Pick<DocusaurusConfig, 'url' | 'baseUrl'> & {
+    future: PartialFuture;
+};
+export declare function createSiteStorage(config: PartialConfig): SiteStorage;
+export {};

package/lib/server/storage.js

@@ -0,0 +1,36 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSiteStorage = void 0;
+const utils_1 = require("@docusaurus/utils");
+const utils_common_1 = require("@docusaurus/utils-common");
+function automaticNamespace(config) {
+    const normalizedUrl = (0, utils_common_1.addTrailingSlash)((0, utils_1.normalizeUrl)([config.url, config.baseUrl]));
+    return (0, utils_1.simpleHash)(normalizedUrl, 3);
+}
+function getNamespaceString(config) {
+    if (config.future.experimental_storage.namespace === true) {
+        return automaticNamespace(config);
+    }
+    else if (config.future.experimental_storage.namespace === false) {
+        return null;
+    }
+    else {
+        return config.future.experimental_storage.namespace;
+    }
+}
+function createSiteStorage(config) {
+    const { type } = config.future.experimental_storage;
+    const namespaceString = getNamespaceString(config);
+    const namespace = namespaceString ? `-${namespaceString}` : '';
+    return {
+        type,
+        namespace,
+    };
+}
+exports.createSiteStorage = createSiteStorage;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "0.0.0-5934",
+  "version": "0.0.0-5938",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -43,12 +43,12 @@
     "@babel/runtime": "^7.22.6",
     "@babel/runtime-corejs3": "^7.22.6",
     "@babel/traverse": "^7.22.8",
-    "@docusaurus/cssnano-preset": "0.0.0-5934",
-    "@docusaurus/logger": "0.0.0-5934",
-    "@docusaurus/mdx-loader": "0.0.0-5934",
-    "@docusaurus/utils": "0.0.0-5934",
-    "@docusaurus/utils-common": "0.0.0-5934",
-    "@docusaurus/utils-validation": "0.0.0-5934",
+    "@docusaurus/cssnano-preset": "0.0.0-5938",
+    "@docusaurus/logger": "0.0.0-5938",
+    "@docusaurus/mdx-loader": "0.0.0-5938",
+    "@docusaurus/utils": "0.0.0-5938",
+    "@docusaurus/utils-common": "0.0.0-5938",
+    "@docusaurus/utils-validation": "0.0.0-5938",
     "autoprefixer": "^10.4.14",
     "babel-loader": "^9.1.3",
     "babel-plugin-dynamic-import-node": "^2.3.3",
@@ -103,8 +103,8 @@
     "webpackbar": "^5.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-5934",
-    "@docusaurus/types": "0.0.0-5934",
+    "@docusaurus/module-type-aliases": "0.0.0-5938",
+    "@docusaurus/types": "0.0.0-5938",
     "@total-typescript/shoehorn": "^0.1.2",
     "@types/detect-port": "^1.3.3",
     "@types/react-dom": "^18.2.7",
@@ -124,5 +124,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "e5fc3801fc9b646c2dbaab6ae024a74344be0bb4"
+  "gitHead": "05801ec2481c5f73abb6085e50dda53aa70bbac9"
 }