@docusaurus/theme-classic 0.0.0-4277 → 0.0.0-4285

package/lib-next/translations.js

@@ -1,141 +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 {keyBy, chain} from 'lodash';
-import {mergeTranslations} from '@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 = chain(
-    allNavbarItems.filter((navbarItem) => !!navbarItem.label),
-  )
-    .keyBy((navbarItem) => `item.label.${navbarItem.label}`)
-    .mapValues((navbarItem) => ({
-      message: navbarItem.label,
-      description: `Navbar item with label ${navbarItem.label}`,
-    }))
-    .value();
-  const titleTranslations = navbar.title
-    ? {
-        title: {
-          message: navbar.title,
-          description: 'The title in the navbar',
-        },
-      }
-    : {};
-  return mergeTranslations([titleTranslations, navbarItemsTranslations]);
-}
-
-function translateNavbar(navbar, navbarTranslations) {
-  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 getFooterTranslationFile(footer) {
-  // TODO POC code
-  const footerLinkTitles = chain(footer.links.filter((link) => !!link.title))
-    .keyBy((link) => `link.title.${link.title}`)
-    .mapValues((link) => ({
-      message: link.title,
-      description: `The title of the footer links column with title=${link.title} in the footer`,
-    }))
-    .value();
-  const footerLinkLabels = chain(
-    footer.links.flatMap((link) => link.items).filter((link) => !!link.label),
-  )
-    .keyBy((linkItem) => `link.item.label.${linkItem.label}`)
-    .mapValues((linkItem) => ({
-      message: linkItem.label,
-      description: `The label of footer link with label=${
-        linkItem.label
-      } linking to ${linkItem.to ?? linkItem.href}`,
-    }))
-    .value();
-  const copyright = footer.copyright
-    ? {
-        copyright: {
-          message: footer.copyright,
-          description: 'The footer copyright',
-        },
-      }
-    : {};
-  return mergeTranslations([footerLinkTitles, footerLinkLabels, copyright]);
-}
-
-function translateFooter(footer, footerTranslations) {
-  const 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,
-    })),
-  }));
-  const copyright = footerTranslations.copyright?.message ?? footer.copyright;
-  return {...footer, links, copyright};
-}
-
-export function getTranslationFiles({themeConfig}) {
-  const translationFiles = [
-    {
-      path: 'navbar',
-      content: getNavbarTranslationFile(themeConfig.navbar),
-    },
-    themeConfig.footer
-      ? {
-          path: 'footer',
-          content: getFooterTranslationFile(themeConfig.footer),
-        }
-      : undefined,
-  ];
-  return translationFiles.filter(Boolean);
-}
-export function translateThemeConfig({themeConfig, translationFiles}) {
-  const translationFilesMap = keyBy(translationFiles, (f) => f.path);
-  return {
-    ...themeConfig,
-    navbar: translateNavbar(
-      themeConfig.navbar,
-      translationFilesMap.navbar.content,
-    ),
-    footer: themeConfig.footer
-      ? translateFooter(themeConfig.footer, translationFilesMap.footer.content)
-      : undefined,
-  };
-}

package/lib-next/types.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.
- */
-
-/// <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/lib-next/validateThemeConfig.js

@@ -1,344 +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 {Joi, URISchema} from '@docusaurus/utils-validation';
-const DEFAULT_DOCS_CONFIG = {
-  versionPersistence: 'localStorage',
-};
-const DocsSchema = Joi.object({
-  versionPersistence: Joi.string()
-    .equal('localStorage', 'none')
-    .default(DEFAULT_DOCS_CONFIG.versionPersistence),
-}).default(DEFAULT_DOCS_CONFIG);
-const DEFAULT_COLOR_MODE_CONFIG = {
-  defaultMode: 'light',
-  disableSwitch: false,
-  respectPrefersColorScheme: false,
-  switchConfig: {
-    darkIcon: '🌜',
-    darkIconStyle: {},
-    lightIcon: '🌞',
-    lightIconStyle: {},
-  },
-};
-const DEFAULT_CONFIG = {
-  colorMode: DEFAULT_COLOR_MODE_CONFIG,
-  docs: DEFAULT_DOCS_CONFIG,
-  metadata: [],
-  prism: {
-    additionalLanguages: [],
-  },
-  navbar: {
-    hideOnScroll: false,
-    items: [],
-  },
-  hideableSidebar: false,
-  tableOfContents: {
-    minHeadingLevel: 2,
-    maxHeadingLevel: 3,
-  },
-};
-const NavbarItemPosition = Joi.string().equal('left', 'right').default('left');
-const NavbarItemBaseSchema = Joi.object({
-  label: Joi.string(),
-  className: Joi.string(),
-}) // We allow any unknown attributes on the links
-  // (users may need additional attributes like target, aria-role, data-customAttribute...)
-  .unknown();
-const DefaultNavbarItemSchema = NavbarItemBaseSchema.append({
-  to: Joi.string(),
-  href: URISchema,
-  activeBasePath: Joi.string(),
-  activeBaseRegex: Joi.string(),
-  prependBaseUrlToHref: Joi.bool(),
-  // This is only triggered in case of a nested dropdown
-  items: Joi.forbidden().messages({
-    'any.unknown': 'Nested dropdowns are not allowed',
-  }),
-})
-  .xor('href', 'to')
-  .messages({
-    'object.xor': 'One and only one between "to" and "href" should be provided',
-  });
-const DocsVersionNavbarItemSchema = NavbarItemBaseSchema.append({
-  type: Joi.string().equal('docsVersion').required(),
-  to: Joi.string(),
-  docsPluginId: Joi.string(),
-});
-const DocItemSchema = NavbarItemBaseSchema.append({
-  type: Joi.string().equal('doc').required(),
-  docId: Joi.string().required(),
-  docsPluginId: Joi.string(),
-});
-
-const itemWithType = (type) => {
-  // because equal(undefined) is not supported :/
-  const typeSchema = type
-    ? Joi.string().required().equal(type)
-    : Joi.string().forbidden();
-  return Joi.object({
-    type: typeSchema,
-  })
-    .unknown()
-    .required();
-};
-
-const DropdownSubitemSchema = Joi.object({
-  position: Joi.forbidden(),
-}).when('.', {
-  switch: [
-    {
-      is: itemWithType('docsVersion'),
-      then: DocsVersionNavbarItemSchema,
-    },
-    {
-      is: itemWithType('doc'),
-      then: DocItemSchema,
-    },
-    {
-      is: itemWithType(undefined),
-      then: DefaultNavbarItemSchema,
-    },
-    {
-      is: Joi.alternatives().try(
-        itemWithType('dropdown'),
-        itemWithType('docsVersionDropdown'),
-        itemWithType('localeDropdown'),
-        itemWithType('search'),
-      ),
-      then: Joi.forbidden().messages({
-        'any.unknown': 'Nested dropdowns are not allowed',
-      }),
-    },
-  ],
-  otherwise: Joi.forbidden().messages({
-    'any.unknown': 'Bad navbar item type {.type}',
-  }),
-});
-const DropdownNavbarItemSchema = NavbarItemBaseSchema.append({
-  items: Joi.array().items(DropdownSubitemSchema).required(),
-});
-const DocsVersionDropdownNavbarItemSchema = NavbarItemBaseSchema.append({
-  type: Joi.string().equal('docsVersionDropdown').required(),
-  docsPluginId: Joi.string(),
-  dropdownActiveClassDisabled: Joi.boolean(),
-  dropdownItemsBefore: Joi.array().items(DropdownSubitemSchema).default([]),
-  dropdownItemsAfter: Joi.array().items(DropdownSubitemSchema).default([]),
-});
-const LocaleDropdownNavbarItemSchema = NavbarItemBaseSchema.append({
-  type: Joi.string().equal('localeDropdown').required(),
-  dropdownItemsBefore: Joi.array().items(DropdownSubitemSchema).default([]),
-  dropdownItemsAfter: Joi.array().items(DropdownSubitemSchema).default([]),
-});
-const SearchItemSchema = Joi.object({
-  type: Joi.string().equal('search').required(),
-});
-const NavbarItemSchema = Joi.object({
-  position: NavbarItemPosition,
-}).when('.', {
-  switch: [
-    {
-      is: itemWithType('docsVersion'),
-      then: DocsVersionNavbarItemSchema,
-    },
-    {
-      is: itemWithType('dropdown'),
-      then: DropdownNavbarItemSchema,
-    },
-    {
-      is: itemWithType('docsVersionDropdown'),
-      then: DocsVersionDropdownNavbarItemSchema,
-    },
-    {
-      is: itemWithType('doc'),
-      then: DocItemSchema,
-    },
-    {
-      is: itemWithType('localeDropdown'),
-      then: LocaleDropdownNavbarItemSchema,
-    },
-    {
-      is: itemWithType('search'),
-      then: SearchItemSchema,
-    },
-    {
-      is: itemWithType(undefined),
-      then: Joi.object().when('.', {
-        // Dropdown item can be specified without type field
-        is: Joi.object({
-          items: Joi.array().required(),
-        }).unknown(),
-        then: DropdownNavbarItemSchema,
-        otherwise: DefaultNavbarItemSchema,
-      }),
-    },
-  ],
-  otherwise: Joi.forbidden().messages({
-    'any.unknown': 'Bad navbar item type {.type}',
-  }),
-});
-const ColorModeSchema = Joi.object({
-  defaultMode: Joi.string()
-    .equal('dark', 'light')
-    .default(DEFAULT_COLOR_MODE_CONFIG.defaultMode),
-  disableSwitch: Joi.bool().default(DEFAULT_COLOR_MODE_CONFIG.disableSwitch),
-  respectPrefersColorScheme: Joi.bool().default(
-    DEFAULT_COLOR_MODE_CONFIG.respectPrefersColorScheme,
-  ),
-  switchConfig: Joi.object({
-    darkIcon: Joi.string().default(
-      DEFAULT_COLOR_MODE_CONFIG.switchConfig.darkIcon,
-    ),
-    darkIconStyle: Joi.object().default(
-      DEFAULT_COLOR_MODE_CONFIG.switchConfig.darkIconStyle,
-    ),
-    lightIcon: Joi.string().default(
-      DEFAULT_COLOR_MODE_CONFIG.switchConfig.lightIcon,
-    ),
-    lightIconStyle: Joi.object().default(
-      DEFAULT_COLOR_MODE_CONFIG.switchConfig.lightIconStyle,
-    ),
-  }).default(DEFAULT_COLOR_MODE_CONFIG.switchConfig),
-}).default(DEFAULT_COLOR_MODE_CONFIG); // schema can probably be improved
-
-const HtmlMetadataSchema = Joi.object({
-  id: Joi.string(),
-  name: Joi.string(),
-  property: Joi.string(),
-  content: Joi.string(),
-  itemprop: Joi.string(),
-}).unknown();
-const FooterLinkItemSchema = Joi.object({
-  to: Joi.string(),
-  href: URISchema,
-  html: Joi.string(),
-  label: Joi.string(),
-})
-  .xor('to', 'href', 'html')
-  .with('to', 'label')
-  .with('href', 'label')
-  .nand('html', 'label') // We allow any unknown attributes on the links
-  // (users may need additional attributes like target, aria-role, data-customAttribute...)
-  .unknown();
-const CustomCssSchema = Joi.alternatives()
-  .try(Joi.array().items(Joi.string().required()), Joi.string().required())
-  .optional();
-const ThemeConfigSchema = Joi.object({
-  // TODO temporary (@alpha-58)
-  disableDarkMode: Joi.any().forbidden().messages({
-    'any.unknown':
-      'disableDarkMode theme config is deprecated. Please use the new colorMode attribute. You likely want: config.themeConfig.colorMode.disableSwitch = true',
-  }),
-  // TODO temporary (@alpha-58)
-  defaultDarkMode: Joi.any().forbidden().messages({
-    'any.unknown':
-      'defaultDarkMode theme config is deprecated. Please use the new colorMode attribute. You likely want: config.themeConfig.colorMode.defaultMode = "dark"',
-  }),
-  customCss: CustomCssSchema,
-  colorMode: ColorModeSchema,
-  image: Joi.string(),
-  docs: DocsSchema,
-  metadata: Joi.array()
-    .items(HtmlMetadataSchema)
-    .default(DEFAULT_CONFIG.metadata),
-  metadatas: Joi.any().forbidden().messages({
-    'any.unknown':
-      'themeConfig.metadatas has been renamed as themeConfig.metadata. See https://github.com/facebook/docusaurus/pull/5871',
-  }),
-  announcementBar: Joi.object({
-    id: Joi.string().default('announcement-bar'),
-    content: Joi.string().required(),
-    backgroundColor: Joi.string(),
-    textColor: Joi.string(),
-    isCloseable: Joi.bool().default(true),
-  }).optional(),
-  navbar: Joi.object({
-    style: Joi.string().equal('dark', 'primary'),
-    hideOnScroll: Joi.bool().default(DEFAULT_CONFIG.navbar.hideOnScroll),
-    // TODO temporary (@alpha-58)
-    links: Joi.any().forbidden().messages({
-      'any.unknown':
-        'themeConfig.navbar.links has been renamed as themeConfig.navbar.items',
-    }),
-    items: Joi.array()
-      .items(NavbarItemSchema)
-      .default(DEFAULT_CONFIG.navbar.items),
-    title: Joi.string().allow('', null),
-    logo: Joi.object({
-      alt: Joi.string().allow(''),
-      src: Joi.string().required(),
-      srcDark: Joi.string(),
-      width: Joi.alternatives().try(Joi.string(), Joi.number()),
-      height: Joi.alternatives().try(Joi.string(), Joi.number()),
-      href: Joi.string(),
-      target: Joi.string(),
-    }),
-  }).default(DEFAULT_CONFIG.navbar),
-  footer: Joi.object({
-    style: Joi.string().equal('dark', 'light').default('light'),
-    logo: Joi.object({
-      alt: Joi.string().allow(''),
-      src: Joi.string(),
-      srcDark: Joi.string(),
-      // TODO infer this from reading the image
-      width: Joi.alternatives().try(Joi.string(), Joi.number()),
-      height: Joi.alternatives().try(Joi.string(), Joi.number()),
-      href: Joi.string(),
-    }),
-    copyright: Joi.string(),
-    links: Joi.array()
-      .items(
-        Joi.object({
-          title: Joi.string().allow(null),
-          items: Joi.array().items(FooterLinkItemSchema).default([]),
-        }),
-      )
-      .default([]),
-  }).optional(),
-  prism: Joi.object({
-    theme: Joi.object({
-      plain: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
-      styles: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
-    }),
-    darkTheme: Joi.object({
-      plain: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
-      styles: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
-    }),
-    defaultLanguage: Joi.string(),
-    additionalLanguages: Joi.array()
-      .items(Joi.string())
-      .default(DEFAULT_CONFIG.prism.additionalLanguages),
-  })
-    .default(DEFAULT_CONFIG.prism)
-    .unknown(),
-  hideableSidebar: Joi.bool().default(DEFAULT_CONFIG.hideableSidebar),
-  sidebarCollapsible: Joi.forbidden().messages({
-    'any.unknown':
-      'The themeConfig.sidebarCollapsible has been moved to docs plugin options. See: https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs',
-  }),
-  tableOfContents: Joi.object({
-    minHeadingLevel: Joi.number()
-      .default(DEFAULT_CONFIG.tableOfContents.minHeadingLevel)
-      .when('maxHeadingLevel', {
-        is: Joi.exist(),
-        then: Joi.number()
-          .integer()
-          .min(2)
-          .max(6)
-          .max(Joi.ref('maxHeadingLevel')),
-        otherwise: Joi.number().integer().min(2).max(6),
-      }),
-    maxHeadingLevel: Joi.number()
-      .integer()
-      .min(2)
-      .max(6)
-      .default(DEFAULT_CONFIG.tableOfContents.maxHeadingLevel),
-  }).default(DEFAULT_CONFIG.tableOfContents),
-});
-export {DEFAULT_CONFIG, ThemeConfigSchema};
-export function validateThemeConfig({validate, themeConfig}) {
-  return validate(ThemeConfigSchema, themeConfig);
-}

package/src/__tests__/__snapshots__/translations.test.ts.snap

@@ -1,116 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`getTranslationFiles should return translation files matching snapshot 1`] = `
-Array [
-  Object {
-    "content": Object {
-      "item.label.Dropdown": Object {
-        "description": "Navbar item with label Dropdown",
-        "message": "Dropdown",
-      },
-      "item.label.Dropdown item 1": Object {
-        "description": "Navbar item with label Dropdown item 1",
-        "message": "Dropdown item 1",
-      },
-      "item.label.Dropdown item 2": Object {
-        "description": "Navbar item with label Dropdown item 2",
-        "message": "Dropdown item 2",
-      },
-      "title": Object {
-        "description": "The title in the navbar",
-        "message": "navbar title",
-      },
-    },
-    "path": "navbar",
-  },
-  Object {
-    "content": Object {
-      "copyright": Object {
-        "description": "The footer copyright",
-        "message": "Copyright FB",
-      },
-      "link.item.label.Link 1": Object {
-        "description": "The label of footer link with label=Link 1 linking to https://facebook.com",
-        "message": "Link 1",
-      },
-      "link.item.label.Link 2": Object {
-        "description": "The label of footer link with label=Link 2 linking to https://facebook.com",
-        "message": "Link 2",
-      },
-      "link.item.label.Link 3": Object {
-        "description": "The label of footer link with label=Link 3 linking to https://facebook.com",
-        "message": "Link 3",
-      },
-      "link.title.Footer link column 1": Object {
-        "description": "The title of the footer links column with title=Footer link column 1 in the footer",
-        "message": "Footer link column 1",
-      },
-      "link.title.Footer link column 2": Object {
-        "description": "The title of the footer links column with title=Footer link column 2 in the footer",
-        "message": "Footer link column 2",
-      },
-    },
-    "path": "footer",
-  },
-]
-`;
-
-exports[`translateThemeConfig should return translated themeConfig matching snapshot 1`] = `
-Object {
-  "announcementBar": Object {},
-  "colorMode": Object {},
-  "docs": Object {
-    "versionPersistence": "none",
-  },
-  "footer": Object {
-    "copyright": "Copyright FB (translated)",
-    "links": Array [
-      Object {
-        "items": Array [
-          Object {
-            "label": "Link 1 (translated)",
-            "to": "https://facebook.com",
-          },
-          Object {
-            "label": "Link 2 (translated)",
-            "to": "https://facebook.com",
-          },
-        ],
-        "title": "Footer link column 1 (translated)",
-      },
-      Object {
-        "items": Array [
-          Object {
-            "label": "Link 3 (translated)",
-            "to": "https://facebook.com",
-          },
-        ],
-        "title": "Footer link column 2 (translated)",
-      },
-    ],
-    "style": "light",
-  },
-  "hideableSidebar": true,
-  "navbar": Object {
-    "hideOnScroll": false,
-    "items": Array [
-      Object {
-        "items": Array [
-          Object {
-            "items": Array [],
-            "label": "Dropdown item 1 (translated)",
-          },
-          Object {
-            "items": Array [],
-            "label": "Dropdown item 2 (translated)",
-          },
-        ],
-        "label": "Dropdown (translated)",
-      },
-    ],
-    "style": "dark",
-    "title": "navbar title (translated)",
-  },
-  "prism": Object {},
-}
-`;