@docusaurus/theme-classic 2.0.0-beta.20 → 2.0.0-beta.21

package/lib/index.js

@@ -1,53 +1,24 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.AnnouncementBarDismissStorageKey = void 0;
-exports.default = themeClassic;
-Object.defineProperty(exports, "getSwizzleConfig", {
-  enumerable: true,
-  get: function () {
-    return _getSwizzleConfig.default;
-  }
-});
-Object.defineProperty(exports, "validateThemeConfig", {
-  enumerable: true,
-  get: function () {
-    return _validateThemeConfig.validateThemeConfig;
-  }
-});
-
-var _translations = require("./translations");
-
-var _module = require("module");
-
-var _rtlcss = _interopRequireDefault(require("rtlcss"));
-
-var _themeTranslations = require("@docusaurus/theme-translations");
-
-var _getSwizzleConfig = _interopRequireDefault(require("./getSwizzleConfig"));
-
-var _validateThemeConfig = require("./validateThemeConfig");
-
-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.
  */
-const requireFromDocusaurusCore = (0, _module.createRequire)(require.resolve('@docusaurus/core/package.json'));
-const ContextReplacementPlugin = requireFromDocusaurusCore('webpack/lib/ContextReplacementPlugin'); // Need to be inlined to prevent dark mode FOUC
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateThemeConfig = exports.getSwizzleConfig = exports.AnnouncementBarDismissStorageKey = void 0;
+const tslib_1 = require("tslib");
+const path_1 = tslib_1.__importDefault(require("path"));
+const module_1 = require("module");
+const rtlcss_1 = tslib_1.__importDefault(require("rtlcss"));
+const theme_translations_1 = require("@docusaurus/theme-translations");
+const translations_1 = require("./translations");
+const requireFromDocusaurusCore = (0, module_1.createRequire)(require.resolve('@docusaurus/core/package.json'));
+const ContextReplacementPlugin = requireFromDocusaurusCore('webpack/lib/ContextReplacementPlugin');
+// Need to be inlined to prevent dark mode FOUC
 // Make sure the key is the same as the one in `/theme/hooks/useTheme.js`
-
 const ThemeStorageKey = 'theme';
-
-const noFlashColorMode = ({
-  defaultMode,
-  respectPrefersColorScheme
-}) => `(function() {
+const noFlashColorMode = ({ defaultMode, respectPrefersColorScheme, }) => `(function() {
   var defaultMode = '${defaultMode}';
   var respectPrefersColorScheme = ${respectPrefersColorScheme};
 
@@ -81,139 +52,114 @@ const noFlashColorMode = ({
       setDataThemeAttribute(defaultMode === 'dark' ? 'dark' : 'light');
     }
   }
-})();`; // Duplicated constant. Unfortunately we can't import it from theme-common, as
+})();`;
+// Duplicated constant. Unfortunately we can't import it from theme-common, as
 // we need to support older nodejs versions without ESM support
 // TODO: import from theme-common once we only support Node.js with ESM support
 // + move all those announcementBar stuff there too
-
-
-const AnnouncementBarDismissStorageKey = 'docusaurus.announcement.dismiss';
-exports.AnnouncementBarDismissStorageKey = AnnouncementBarDismissStorageKey;
-const AnnouncementBarDismissDataAttribute = 'data-announcement-bar-initially-dismissed'; // We always render the announcement bar html on the server, to prevent layout
+exports.AnnouncementBarDismissStorageKey = 'docusaurus.announcement.dismiss';
+const AnnouncementBarDismissDataAttribute = 'data-announcement-bar-initially-dismissed';
+// We always render the announcement bar html on the server, to prevent layout
 // shifts on React hydration. The theme can use CSS + the data attribute to hide
 // the announcement bar asap (before React hydration)
-
 const AnnouncementBarInlineJavaScript = `
 (function() {
   function isDismissed() {
     try {
-      return localStorage.getItem('${AnnouncementBarDismissStorageKey}') === 'true';
+      return localStorage.getItem('${exports.AnnouncementBarDismissStorageKey}') === 'true';
     } catch (err) {}
     return false;
   }
   document.documentElement.setAttribute('${AnnouncementBarDismissDataAttribute}', isDismissed());
 })();`;
-
 function getInfimaCSSFile(direction) {
-  return `infima/dist/css/default/default${direction === 'rtl' ? '-rtl' : ''}.css`;
+    return `infima/dist/css/default/default${direction === 'rtl' ? '-rtl' : ''}.css`;
 }
-
 function themeClassic(context, options) {
-  const {
-    i18n: {
-      currentLocale,
-      localeConfigs
-    }
-  } = context;
-  const themeConfig = context.siteConfig.themeConfig;
-  const {
-    announcementBar,
-    colorMode,
-    prism: {
-      additionalLanguages
-    }
-  } = themeConfig;
-  const {
-    customCss
-  } = options ?? {};
-  const {
-    direction
-  } = localeConfigs[currentLocale];
-  return {
-    name: 'docusaurus-theme-classic',
-
-    getThemePath() {
-      return '../lib-next/theme';
-    },
-
-    getTypeScriptThemePath() {
-      return '../src/theme';
-    },
-
-    getTranslationFiles: () => (0, _translations.getTranslationFiles)({
-      themeConfig
-    }),
-    translateThemeConfig: params => (0, _translations.translateThemeConfig)({
-      themeConfig: params.themeConfig,
-      translationFiles: params.translationFiles
-    }),
-
-    getDefaultCodeTranslationMessages() {
-      return (0, _themeTranslations.readDefaultCodeTranslationMessages)({
-        locale: currentLocale,
-        name: 'theme-common'
-      });
-    },
-
-    getClientModules() {
-      const modules = [require.resolve(getInfimaCSSFile(direction)), './prism-include-languages', './admonitions.css', './nprogress'];
-
-      if (customCss) {
-        if (Array.isArray(customCss)) {
-          modules.push(...customCss);
-        } else {
-          modules.push(customCss);
-        }
-      }
-
-      return modules;
-    },
-
-    configureWebpack() {
-      const prismLanguages = additionalLanguages.map(lang => `prism-${lang}`).join('|');
-      return {
-        plugins: [// This allows better optimization by only bundling those components
-        // that the user actually needs, because the modules are dynamically
-        // required and can't be known during compile time.
-        new ContextReplacementPlugin(/prismjs[\\/]components$/, new RegExp(`^./(${prismLanguages})$`))]
-      };
-    },
-
-    configurePostCss(postCssOptions) {
-      if (direction === 'rtl') {
-        const resolvedInfimaFile = require.resolve(getInfimaCSSFile(direction));
-
-        const plugin = {
-          postcssPlugin: 'RtlCssPlugin',
-          prepare: result => {
-            var _result$root, _result$root$source, _result$root$source$i;
-
-            const file = (_result$root = result.root) === null || _result$root === void 0 ? void 0 : (_result$root$source = _result$root.source) === null || _result$root$source === void 0 ? void 0 : (_result$root$source$i = _result$root$source.input) === null || _result$root$source$i === void 0 ? void 0 : _result$root$source$i.file; // Skip Infima as we are using the its RTL version.
-
-            if (file === resolvedInfimaFile) {
-              return {};
+    const { i18n: { currentLocale, localeConfigs }, } = context;
+    const themeConfig = context.siteConfig.themeConfig;
+    const { announcementBar, colorMode, prism: { additionalLanguages }, } = themeConfig;
+    const { customCss } = options ?? {};
+    const { direction } = localeConfigs[currentLocale];
+    return {
+        name: 'docusaurus-theme-classic',
+        getThemePath() {
+            return '../lib/theme';
+        },
+        getTypeScriptThemePath() {
+            return '../src/theme';
+        },
+        getTranslationFiles: () => (0, translations_1.getTranslationFiles)({ themeConfig }),
+        translateThemeConfig: (params) => (0, translations_1.translateThemeConfig)({
+            themeConfig: params.themeConfig,
+            translationFiles: params.translationFiles,
+        }),
+        getDefaultCodeTranslationMessages() {
+            return (0, theme_translations_1.readDefaultCodeTranslationMessages)({
+                locale: currentLocale,
+                name: 'theme-common',
+            });
+        },
+        getClientModules() {
+            const modules = [
+                require.resolve(getInfimaCSSFile(direction)),
+                './prism-include-languages',
+                './admonitions.css',
+                './nprogress',
+            ];
+            if (customCss) {
+                modules.push(...(Array.isArray(customCss) ? customCss : [customCss]).map((p) => path_1.default.resolve(context.siteDir, p)));
             }
-
-            return (0, _rtlcss.default)(result.root);
-          }
-        };
-        postCssOptions.plugins.push(plugin);
-      }
-
-      return postCssOptions;
-    },
-
-    injectHtmlTags() {
-      return {
-        preBodyTags: [{
-          tagName: 'script',
-          innerHTML: `
+            return modules;
+        },
+        configureWebpack() {
+            const prismLanguages = additionalLanguages
+                .map((lang) => `prism-${lang}`)
+                .join('|');
+            return {
+                plugins: [
+                    // This allows better optimization by only bundling those components
+                    // that the user actually needs, because the modules are dynamically
+                    // required and can't be known during compile time.
+                    new ContextReplacementPlugin(/prismjs[\\/]components$/, new RegExp(`^./(${prismLanguages})$`)),
+                ],
+            };
+        },
+        configurePostCss(postCssOptions) {
+            if (direction === 'rtl') {
+                const resolvedInfimaFile = require.resolve(getInfimaCSSFile(direction));
+                const plugin = {
+                    postcssPlugin: 'RtlCssPlugin',
+                    prepare: (result) => {
+                        const file = result.root.source?.input.file;
+                        // Skip Infima as we are using the its RTL version.
+                        if (file === resolvedInfimaFile) {
+                            return {};
+                        }
+                        return (0, rtlcss_1.default)(result.root);
+                    },
+                };
+                postCssOptions.plugins.push(plugin);
+            }
+            return postCssOptions;
+        },
+        injectHtmlTags() {
+            return {
+                preBodyTags: [
+                    {
+                        tagName: 'script',
+                        innerHTML: `
 ${noFlashColorMode(colorMode)}
 ${announcementBar ? AnnouncementBarInlineJavaScript : ''}
-            `
-        }]
-      };
-    }
-
-  };
-}
+            `,
+                    },
+                ],
+            };
+        },
+    };
+}
+exports.default = themeClassic;
+var getSwizzleConfig_1 = require("./getSwizzleConfig");
+Object.defineProperty(exports, "getSwizzleConfig", { enumerable: true, get: function () { return tslib_1.__importDefault(getSwizzleConfig_1).default; } });
+var validateThemeConfig_1 = require("./validateThemeConfig");
+Object.defineProperty(exports, "validateThemeConfig", { enumerable: true, get: function () { return validateThemeConfig_1.validateThemeConfig; } });

package/lib/nprogress.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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 './nprogress.css';
+import type { ClientModule } from '@docusaurus/types';
+declare const clientModule: ClientModule;
+export default clientModule;

package/lib/nprogress.js

@@ -1,46 +1,25 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _nprogress = _interopRequireDefault(require("nprogress"));
-
-require("./nprogress.css");
-
-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.
  */
-_nprogress.default.configure({
-  showSpinner: false
-});
-
+import nprogress from 'nprogress';
+import './nprogress.css';
+nprogress.configure({ showSpinner: false });
 const delay = 200;
 const clientModule = {
-  onRouteUpdate({
-    location,
-    previousLocation
-  }) {
-    if (previousLocation && location.pathname !== previousLocation.pathname) {
-      const progressBarTimeout = window.setTimeout(() => {
-        _nprogress.default.start();
-      }, delay);
-      return () => window.clearTimeout(progressBarTimeout);
-    }
-
-    return undefined;
-  },
-
-  onRouteDidUpdate() {
-    _nprogress.default.done();
-  }
-
+    onRouteUpdate({ location, previousLocation }) {
+        if (previousLocation && location.pathname !== previousLocation.pathname) {
+            const progressBarTimeout = window.setTimeout(() => {
+                nprogress.start();
+            }, delay);
+            return () => window.clearTimeout(progressBarTimeout);
+        }
+        return undefined;
+    },
+    onRouteDidUpdate() {
+        nprogress.done();
+    },
 };
-var _default = clientModule;
-exports.default = _default;
+export default clientModule;

package/lib/prism-include-languages.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 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.
+ */
+export {};

package/lib/prism-include-languages.js

@@ -1,15 +1,9 @@
-"use strict";
-
-var _prism = _interopRequireDefault(require("prism-react-renderer/prism"));
-
-var _prismIncludeLanguages = _interopRequireDefault(require("@theme/prism-include-languages"));
-
-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.
  */
-(0, _prismIncludeLanguages.default)(_prism.default);
+import Prism from 'prism-react-renderer/prism';
+import prismIncludeLanguages from '@theme/prism-include-languages';
+prismIncludeLanguages(Prism);

package/lib/theme/Admonition/index.d.ts

@@ -0,0 +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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/Admonition';
+export default function Admonition({ children, type, title, icon, }: Props): JSX.Element;

package/lib/theme/AnnouncementBar/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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="react" />
+export default function AnnouncementBar(): JSX.Element | null;

package/{lib-next → lib}/theme/AnnouncementBar/index.js

@@ -13,27 +13,21 @@ import styles from './styles.module.css';
 export default function AnnouncementBar() {
   const {isActive, close} = useAnnouncementBar();
   const {announcementBar} = useThemeConfig();
-
   if (!isActive) {
     return null;
   }
-
   const {content, backgroundColor, textColor, isCloseable} = announcementBar;
   return (
     <div
       className={styles.announcementBar}
-      style={{
-        backgroundColor,
-        color: textColor,
-      }}
+      style={{backgroundColor, color: textColor}}
       role="banner">
       {isCloseable && <div className={styles.announcementBarPlaceholder} />}
       <div
-        className={styles.announcementBarContent} // Developer provided the HTML, so assume it's safe.
+        className={styles.announcementBarContent}
+        // Developer provided the HTML, so assume it's safe.
         // eslint-disable-next-line react/no-danger
-        dangerouslySetInnerHTML={{
-          __html: content,
-        }}
+        dangerouslySetInnerHTML={{__html: content}}
       />
       {isCloseable ? (
         <button

package/lib/theme/BackToTopButton/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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="react" />
+export default function BackToTopButton(): JSX.Element;

package/{lib-next → lib}/theme/BackToTopButton/index.js

@@ -10,9 +10,7 @@ import {translate} from '@docusaurus/Translate';
 import {ThemeClassNames, useBackToTopButton} from '@docusaurus/theme-common';
 import styles from './styles.module.css';
 export default function BackToTopButton() {
-  const {shown, scrollToTop} = useBackToTopButton({
-    threshold: 300,
-  });
+  const {shown, scrollToTop} = useBackToTopButton({threshold: 300});
   return (
     <button
       aria-label={translate({

package/lib/theme/BlogArchivePage/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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/plugin-content-blog" />
+/// <reference types="react" />
+import type { Props } from '@theme/BlogArchivePage';
+export default function BlogArchive({ archive }: Props): JSX.Element;

package/{lib-next → lib}/theme/BlogArchivePage/index.js

@@ -5,11 +5,10 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
-import Layout from '@theme/Layout';
 import Link from '@docusaurus/Link';
 import {translate} from '@docusaurus/Translate';
 import {PageMetadata} from '@docusaurus/theme-common';
-
+import Layout from '@theme/Layout';
 function Year({year, posts}) {
   return (
     <>
@@ -26,7 +25,6 @@ function Year({year, posts}) {
     </>
   );
 }
-
 function YearsSection({years}) {
   return (
     <section className="margin-vert--lg">
@@ -42,7 +40,6 @@ function YearsSection({years}) {
     </section>
   );
 }
-
 function listPostsByYears(blogPosts) {
   const postsByYear = blogPosts.reduceRight((posts, post) => {
     const year = post.metadata.date.split('-')[0];
@@ -54,7 +51,6 @@ function listPostsByYears(blogPosts) {
     posts,
   }));
 }
-
 export default function BlogArchive({archive}) {
   const title = translate({
     id: 'theme.blog.archive.title',

package/lib/theme/BlogLayout/index.d.ts

@@ -0,0 +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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/BlogLayout';
+export default function BlogLayout(props: Props): JSX.Element;

package/lib/theme/BlogListPage/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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/plugin-content-blog" />
+/// <reference types="react" />
+import type { Props } from '@theme/BlogListPage';
+export default function BlogListPage(props: Props): JSX.Element;

package/{lib-next → lib}/theme/BlogListPage/index.js

@@ -5,18 +5,17 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React from 'react';
+import clsx from 'clsx';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-import BlogLayout from '@theme/BlogLayout';
-import BlogPostItem from '@theme/BlogPostItem';
-import BlogListPaginator from '@theme/BlogListPaginator';
 import {
   PageMetadata,
   HtmlClassNameProvider,
   ThemeClassNames,
 } from '@docusaurus/theme-common';
+import BlogLayout from '@theme/BlogLayout';
+import BlogPostItem from '@theme/BlogPostItem';
+import BlogListPaginator from '@theme/BlogListPaginator';
 import SearchMetadata from '@theme/SearchMetadata';
-import clsx from 'clsx';
-
 function BlogListPageMetadata(props) {
   const {metadata} = props;
   const {
@@ -32,7 +31,6 @@ function BlogListPageMetadata(props) {
     </>
   );
 }
-
 function BlogListPageContent(props) {
   const {metadata, items, sidebar} = props;
   return (
@@ -51,7 +49,6 @@ function BlogListPageContent(props) {
     </BlogLayout>
   );
 }
-
 export default function BlogListPage(props) {
   return (
     <HtmlClassNameProvider

package/lib/theme/BlogListPaginator/index.d.ts

@@ -0,0 +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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/BlogListPaginator';
+export default function BlogListPaginator(props: Props): JSX.Element;

package/lib/theme/BlogPostAuthor/index.d.ts

@@ -0,0 +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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/BlogPostAuthor';
+export default function BlogPostAuthor({ author }: Props): JSX.Element;

package/{lib-next → lib}/theme/BlogPostAuthor/index.js

@@ -6,15 +6,12 @@
  */
 import React from 'react';
 import Link from '@docusaurus/Link';
-
 function MaybeLink(props) {
   if (props.href) {
     return <Link {...props} />;
   }
-
   return <>{props.children}</>;
 }
-
 export default function BlogPostAuthor({author}) {
   const {name, title, url, imageURL, email} = author;
   const link = url || (email && `mailto:${email}`) || undefined;

package/lib/theme/BlogPostAuthors/index.d.ts

@@ -0,0 +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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/BlogPostAuthors';
+export default function BlogPostAuthors({ authors, assets, }: Props): JSX.Element | null;