@docusaurus/theme-classic 0.0.0-5030 → 0.0.0-5033

package/lib/translations.js

@@ -1,156 +1,140 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getTranslationFiles = getTranslationFiles;
-exports.translateThemeConfig = translateThemeConfig;
-
-var _lodash = _interopRequireDefault(require("lodash"));
-
-var _utils = require("@docusaurus/utils");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * 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.translateThemeConfig = exports.getTranslationFiles = void 0;
+const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const utils_1 = require("@docusaurus/utils");
 function getNavbarTranslationFile(navbar) {
-  // TODO handle properly all the navbar item types here!
-  function flattenNavbarItems(items) {
-    const subItems = items.flatMap(item => {
-      const allSubItems = [item.items ?? []].flat();
-      return flattenNavbarItems(allSubItems);
-    });
-    return [...items, ...subItems];
-  }
-
-  const allNavbarItems = flattenNavbarItems(navbar.items);
-  const navbarItemsTranslations = Object.fromEntries(allNavbarItems.filter(navbarItem => navbarItem.label).map(navbarItem => [`item.label.${navbarItem.label}`, {
-    message: navbarItem.label,
-    description: `Navbar item with label ${navbarItem.label}`
-  }]));
-  const titleTranslations = navbar.title ? {
-    title: {
-      message: navbar.title,
-      description: 'The title in the navbar'
+    // TODO handle properly all the navbar item types here!
+    function flattenNavbarItems(items) {
+        const subItems = items.flatMap((item) => {
+            const allSubItems = [item.items ?? []].flat();
+            return flattenNavbarItems(allSubItems);
+        });
+        return [...items, ...subItems];
     }
-  } : {};
-  return (0, _utils.mergeTranslations)([titleTranslations, navbarItemsTranslations]);
+    const allNavbarItems = flattenNavbarItems(navbar.items);
+    const navbarItemsTranslations = Object.fromEntries(allNavbarItems
+        .filter((navbarItem) => navbarItem.label)
+        .map((navbarItem) => [
+        `item.label.${navbarItem.label}`,
+        {
+            message: navbarItem.label,
+            description: `Navbar item with label ${navbarItem.label}`,
+        },
+    ]));
+    const titleTranslations = navbar.title
+        ? { title: { message: navbar.title, description: 'The title in the navbar' } }
+        : {};
+    return (0, utils_1.mergeTranslations)([titleTranslations, navbarItemsTranslations]);
 }
-
 function translateNavbar(navbar, navbarTranslations) {
-  var _navbarTranslations$t;
-
-  if (!navbarTranslations) {
-    return navbar;
-  }
-
-  return { ...navbar,
-    title: ((_navbarTranslations$t = navbarTranslations.title) === null || _navbarTranslations$t === void 0 ? void 0 : _navbarTranslations$t.message) ?? navbar.title,
-    //  TODO handle properly all the navbar item types here!
-    items: navbar.items.map(item => {
-      var _item$items, _navbarTranslations$2;
-
-      const subItems = (_item$items = item.items) === null || _item$items === void 0 ? void 0 : _item$items.map(subItem => {
-        var _navbarTranslations$;
-
-        return { ...subItem,
-          label: ((_navbarTranslations$ = navbarTranslations[`item.label.${subItem.label}`]) === null || _navbarTranslations$ === void 0 ? void 0 : _navbarTranslations$.message) ?? subItem.label
-        };
-      });
-      return { ...item,
-        label: ((_navbarTranslations$2 = navbarTranslations[`item.label.${item.label}`]) === null || _navbarTranslations$2 === void 0 ? void 0 : _navbarTranslations$2.message) ?? item.label,
-        ...(subItems ? {
-          items: subItems
-        } : undefined)
-      };
-    })
-  };
+    if (!navbarTranslations) {
+        return navbar;
+    }
+    return {
+        ...navbar,
+        title: navbarTranslations.title?.message ?? navbar.title,
+        //  TODO handle properly all the navbar item types here!
+        items: navbar.items.map((item) => {
+            const subItems = item.items?.map((subItem) => ({
+                ...subItem,
+                label: navbarTranslations[`item.label.${subItem.label}`]?.message ??
+                    subItem.label,
+            }));
+            return {
+                ...item,
+                label: navbarTranslations[`item.label.${item.label}`]?.message ?? item.label,
+                ...(subItems ? { items: subItems } : undefined),
+            };
+        }),
+    };
 }
-
 function isMultiColumnFooterLinks(links) {
-  return links.length > 0 && 'title' in links[0];
+    return links.length > 0 && 'title' in links[0];
 }
-
 function getFooterTranslationFile(footer) {
-  const footerLinkTitles = Object.fromEntries((isMultiColumnFooterLinks(footer.links) ? footer.links.filter(link => link.title) : []).map(link => [`link.title.${link.title}`, {
-    message: link.title,
-    description: `The title of the footer links column with title=${link.title} in the footer`
-  }]));
-  const footerLinkLabels = Object.fromEntries((isMultiColumnFooterLinks(footer.links) ? footer.links.flatMap(link => link.items).filter(link => link.label) : footer.links.filter(link => link.label)).map(link => [`link.item.label.${link.label}`, {
-    message: link.label,
-    description: `The label of footer link with label=${link.label} linking to ${link.to ?? link.href}`
-  }]));
-  const copyright = footer.copyright ? {
-    copyright: {
-      message: footer.copyright,
-      description: 'The footer copyright'
-    }
-  } : {};
-  return (0, _utils.mergeTranslations)([footerLinkTitles, footerLinkLabels, copyright]);
+    const footerLinkTitles = Object.fromEntries((isMultiColumnFooterLinks(footer.links)
+        ? footer.links.filter((link) => link.title)
+        : []).map((link) => [
+        `link.title.${link.title}`,
+        {
+            message: link.title,
+            description: `The title of the footer links column with title=${link.title} in the footer`,
+        },
+    ]));
+    const footerLinkLabels = Object.fromEntries((isMultiColumnFooterLinks(footer.links)
+        ? footer.links.flatMap((link) => link.items).filter((link) => link.label)
+        : footer.links.filter((link) => link.label)).map((link) => [
+        `link.item.label.${link.label}`,
+        {
+            message: link.label,
+            description: `The label of footer link with label=${link.label} linking to ${link.to ?? link.href}`,
+        },
+    ]));
+    const copyright = footer.copyright
+        ? {
+            copyright: {
+                message: footer.copyright,
+                description: 'The footer copyright',
+            },
+        }
+        : {};
+    return (0, utils_1.mergeTranslations)([footerLinkTitles, footerLinkLabels, copyright]);
 }
-
 function translateFooter(footer, footerTranslations) {
-  var _footerTranslations$c;
-
-  if (!footerTranslations) {
-    return footer;
-  }
-
-  const links = isMultiColumnFooterLinks(footer.links) ? footer.links.map(link => {
-    var _footerTranslations$;
-
-    return { ...link,
-      title: ((_footerTranslations$ = footerTranslations[`link.title.${link.title}`]) === null || _footerTranslations$ === void 0 ? void 0 : _footerTranslations$.message) ?? link.title,
-      items: link.items.map(linkItem => {
-        var _footerTranslations$2;
-
-        return { ...linkItem,
-          label: ((_footerTranslations$2 = footerTranslations[`link.item.label.${linkItem.label}`]) === null || _footerTranslations$2 === void 0 ? void 0 : _footerTranslations$2.message) ?? linkItem.label
-        };
-      })
-    };
-  }) : footer.links.map(link => {
-    var _footerTranslations$3;
-
-    return { ...link,
-      label: ((_footerTranslations$3 = footerTranslations[`link.item.label.${link.label}`]) === null || _footerTranslations$3 === void 0 ? void 0 : _footerTranslations$3.message) ?? link.label
+    if (!footerTranslations) {
+        return footer;
+    }
+    const links = isMultiColumnFooterLinks(footer.links)
+        ? footer.links.map((link) => ({
+            ...link,
+            title: footerTranslations[`link.title.${link.title}`]?.message ?? link.title,
+            items: link.items.map((linkItem) => ({
+                ...linkItem,
+                label: footerTranslations[`link.item.label.${linkItem.label}`]?.message ??
+                    linkItem.label,
+            })),
+        }))
+        : footer.links.map((link) => ({
+            ...link,
+            label: footerTranslations[`link.item.label.${link.label}`]?.message ??
+                link.label,
+        }));
+    const copyright = footerTranslations.copyright?.message ?? footer.copyright;
+    return {
+        ...footer,
+        links,
+        copyright,
     };
-  });
-  const copyright = ((_footerTranslations$c = footerTranslations.copyright) === null || _footerTranslations$c === void 0 ? void 0 : _footerTranslations$c.message) ?? footer.copyright;
-  return { ...footer,
-    links,
-    copyright
-  };
 }
-
-function getTranslationFiles({
-  themeConfig
-}) {
-  const translationFiles = [{
-    path: 'navbar',
-    content: getNavbarTranslationFile(themeConfig.navbar)
-  }, themeConfig.footer ? {
-    path: 'footer',
-    content: getFooterTranslationFile(themeConfig.footer)
-  } : undefined];
-  return translationFiles.filter(Boolean);
+function getTranslationFiles({ themeConfig, }) {
+    const translationFiles = [
+        { path: 'navbar', content: getNavbarTranslationFile(themeConfig.navbar) },
+        themeConfig.footer
+            ? {
+                path: 'footer',
+                content: getFooterTranslationFile(themeConfig.footer),
+            }
+            : undefined,
+    ];
+    return translationFiles.filter(Boolean);
 }
-
-function translateThemeConfig({
-  themeConfig,
-  translationFiles
-}) {
-  var _translationFilesMap$, _translationFilesMap$2;
-
-  const translationFilesMap = _lodash.default.keyBy(translationFiles, f => f.path);
-
-  return { ...themeConfig,
-    navbar: translateNavbar(themeConfig.navbar, (_translationFilesMap$ = translationFilesMap.navbar) === null || _translationFilesMap$ === void 0 ? void 0 : _translationFilesMap$.content),
-    footer: themeConfig.footer ? translateFooter(themeConfig.footer, (_translationFilesMap$2 = translationFilesMap.footer) === null || _translationFilesMap$2 === void 0 ? void 0 : _translationFilesMap$2.content) : undefined
-  };
-}
+exports.getTranslationFiles = getTranslationFiles;
+function translateThemeConfig({ themeConfig, translationFiles, }) {
+    const translationFilesMap = lodash_1.default.keyBy(translationFiles, (f) => f.path);
+    return {
+        ...themeConfig,
+        navbar: translateNavbar(themeConfig.navbar, translationFilesMap.navbar?.content),
+        footer: themeConfig.footer
+            ? translateFooter(themeConfig.footer, translationFilesMap.footer?.content)
+            : undefined,
+    };
+}
+exports.translateThemeConfig = translateThemeConfig;

package/lib/validateThemeConfig.d.ts

@@ -0,0 +1,68 @@
+/**
+ * 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 { Joi } from '@docusaurus/utils-validation';
+import type { ThemeConfig, ThemeConfigValidationContext } from '@docusaurus/types';
+export declare const DEFAULT_CONFIG: {
+    colorMode: {
+        defaultMode: string;
+        disableSwitch: boolean;
+        respectPrefersColorScheme: boolean;
+    };
+    docs: {
+        versionPersistence: string;
+        sidebar: {
+            hideable: boolean;
+            autoCollapseCategories: boolean;
+        };
+    };
+    metadata: never[];
+    prism: {
+        additionalLanguages: never[];
+        theme: {
+            plain: {
+                [styleKey: string]: string | number | void;
+                color?: string | undefined;
+                backgroundColor?: string | undefined;
+                fontStyle?: "normal" | "italic" | undefined;
+                fontWeight?: "bold" | "normal" | "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900" | undefined;
+                textDecorationLine?: "none" | "underline" | "line-through" | "underline line-through" | undefined;
+                opacity?: number | undefined;
+            };
+            styles: {
+                types: string[];
+                style: {
+                    [styleKey: string]: string | number | void;
+                    color?: string | undefined;
+                    backgroundColor?: string | undefined;
+                    fontStyle?: "normal" | "italic" | undefined;
+                    fontWeight?: "bold" | "normal" | "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900" | undefined;
+                    textDecorationLine?: "none" | "underline" | "line-through" | "underline line-through" | undefined;
+                    opacity?: number | undefined;
+                };
+                languages?: ("markup" | "bash" | "clike" | "c" | "cpp" | "css" | "javascript" | "jsx" | "coffeescript" | "actionscript" | "css-extr" | "diff" | "git" | "go" | "graphql" | "handlebars" | "json" | "less" | "makefile" | "markdown" | "objectivec" | "ocaml" | "python" | "reason" | "sass" | "scss" | "sql" | "stylus" | "tsx" | "typescript" | "wasm" | "yaml")[] | undefined;
+            }[];
+        };
+        magicComments: {
+            className: string;
+            line: string;
+            block: {
+                start: string;
+                end: string;
+            };
+        }[];
+    };
+    navbar: {
+        hideOnScroll: boolean;
+        items: never[];
+    };
+    tableOfContents: {
+        minHeadingLevel: number;
+        maxHeadingLevel: number;
+    };
+};
+export declare const ThemeConfigSchema: Joi.ObjectSchema<any>;
+export declare function validateThemeConfig({ validate, themeConfig, }: ThemeConfigValidationContext<ThemeConfig>): ThemeConfig;