@docusaurus/plugin-content-blog 3.9.2-canary-6443 → 3.9.2-canary-6445

package/lib/index.js

@@ -41,7 +41,7 @@ async function pluginContentBlog(context, options) {
             })
             : undefined,
     };
-    const pluginId = options.id ?? utils_1.DEFAULT_PLUGIN_ID;
+    const pluginId = options.id;
     const pluginDataDirRoot = path_1.default.join(generatedFilesDir, PluginName);
     const dataDir = path_1.default.join(pluginDataDirRoot, pluginId);
     // TODO Docusaurus v4 breaking change
@@ -164,9 +164,10 @@ async function pluginContentBlog(context, options) {
             const listedBlogPosts = blogPosts.filter(blogUtils_1.shouldBeListed);
             if (!blogPosts.length) {
                 return {
+                    blogTitle,
+                    blogDescription,
                     blogSidebarTitle,
                     blogPosts: [],
-                    blogListPaginated: [],
                     blogTags: {},
                     blogTagsListPath,
                     authorsMap,
@@ -191,14 +192,6 @@ async function pluginContentBlog(context, options) {
                     };
                 }
             });
-            const blogListPaginated = (0, blogUtils_1.paginateBlogPosts)({
-                blogPosts: listedBlogPosts,
-                blogTitle,
-                blogDescription,
-                postsPerPageOption,
-                basePageUrl: baseBlogUrl,
-                pageBasePath,
-            });
             const blogTags = (0, blogUtils_1.getBlogTags)({
                 blogPosts,
                 postsPerPageOption,
@@ -207,9 +200,10 @@ async function pluginContentBlog(context, options) {
                 pageBasePath,
             });
             return {
+                blogTitle,
+                blogDescription,
                 blogSidebarTitle,
                 blogPosts,
-                blogListPaginated,
                 blogTags,
                 blogTagsListPath,
                 authorsMap,

package/lib/options.js

@@ -13,6 +13,7 @@ const path_1 = tslib_1.__importDefault(require("path"));
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const utils_1 = require("@docusaurus/utils");
 exports.DEFAULT_OPTIONS = {
+    id: utils_1.DEFAULT_PLUGIN_ID,
     feedOptions: {
         type: ['rss', 'atom'],
         copyright: '',

package/lib/routes.js

@@ -19,15 +19,12 @@ async function createAllRoutes(param) {
     routes.forEach(param.actions.addRoute);
 }
 async function buildAllRoutes({ baseUrl, content, actions, options, aliasedSource, }) {
-    const { blogListComponent, blogPostComponent, blogTagsListComponent, blogAuthorsListComponent, blogAuthorsPostsComponent, blogTagsPostsComponent, blogArchiveComponent, routeBasePath, archiveBasePath, blogTitle, authorsBasePath, postsPerPage, blogDescription, } = options;
+    const { blogListComponent, blogPostComponent, blogTagsListComponent, blogAuthorsListComponent, blogAuthorsPostsComponent, blogTagsPostsComponent, blogArchiveComponent, routeBasePath, archiveBasePath, authorsBasePath, postsPerPage, pageBasePath, } = options;
     const pluginId = options.id;
     const { createData } = actions;
-    const { blogSidebarTitle, blogPosts, blogListPaginated, blogTags, blogTagsListPath, authorsMap, } = content;
-    const authorsListPath = (0, utils_1.normalizeUrl)([
-        baseUrl,
-        routeBasePath,
-        authorsBasePath,
-    ]);
+    const { blogTitle, blogDescription, blogSidebarTitle, blogPosts, blogTags, blogTagsListPath, authorsMap, } = content;
+    const blogBasePath = (0, utils_1.normalizeUrl)([baseUrl, routeBasePath]);
+    const authorsListPath = (0, utils_1.normalizeUrl)([blogBasePath, authorsBasePath]);
     const listedBlogPosts = blogPosts.filter(blogUtils_1.shouldBeListed);
     const blogPostsById = lodash_1.default.keyBy(blogPosts, (post) => post.id);
     function getBlogPostById(id) {
@@ -50,7 +47,7 @@ async function buildAllRoutes({ baseUrl, content, actions, options, aliasedSourc
     }
     async function createBlogMetadataModule() {
         const blogMetadata = {
-            blogBasePath: (0, utils_1.normalizeUrl)([baseUrl, routeBasePath]),
+            blogBasePath,
             blogTitle,
             authorsListPath,
         };
@@ -81,7 +78,7 @@ async function buildAllRoutes({ baseUrl, content, actions, options, aliasedSourc
         if (archiveBasePath && listedBlogPosts.length) {
             return [
                 {
-                    path: (0, utils_1.normalizeUrl)([baseUrl, routeBasePath, archiveBasePath]),
+                    path: (0, utils_1.normalizeUrl)([blogBasePath, archiveBasePath]),
                     component: blogArchiveComponent,
                     exact: true,
                     props: {
@@ -124,6 +121,14 @@ async function buildAllRoutes({ baseUrl, content, actions, options, aliasedSourc
         return blogPosts.map(createBlogPostRoute);
     }
     function createBlogPostsPaginatedRoutes() {
+        const blogListPaginated = (0, blogUtils_1.paginateBlogPosts)({
+            blogPosts: listedBlogPosts,
+            blogTitle,
+            blogDescription,
+            postsPerPageOption: postsPerPage,
+            basePageUrl: blogBasePath,
+            pageBasePath,
+        });
         return blogListPaginated.map((paginated) => {
             return {
                 path: paginated.metadata.permalink,

package/lib/translations.js

@@ -8,19 +8,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getTranslationFiles = getTranslationFiles;
 exports.translateContent = translateContent;
-function translateListPage(blogListPaginated, translations) {
-    return blogListPaginated.map((page) => {
-        const { items, metadata } = page;
-        return {
-            items,
-            metadata: {
-                ...metadata,
-                blogTitle: translations.title?.message ?? page.metadata.blogTitle,
-                blogDescription: translations.description?.message ?? page.metadata.blogDescription,
-            },
-        };
-    });
-}
 function getTranslationFiles(options) {
     return [
         {
@@ -43,10 +30,11 @@ function getTranslationFiles(options) {
     ];
 }
 function translateContent(content, translationFiles) {
-    const { content: optionsTranslations } = translationFiles[0];
+    const { content: translations } = translationFiles[0];
     return {
         ...content,
-        blogSidebarTitle: optionsTranslations['sidebar.title']?.message ?? content.blogSidebarTitle,
-        blogListPaginated: translateListPage(content.blogListPaginated, optionsTranslations),
+        blogTitle: translations.title?.message ?? content.blogTitle,
+        blogDescription: translations.description?.message ?? content.blogDescription,
+        blogSidebarTitle: translations['sidebar.title']?.message ?? content.blogSidebarTitle,
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "3.9.2-canary-6443",
+  "version": "3.9.2-canary-6445",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -31,14 +31,14 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "3.9.2-canary-6443",
-    "@docusaurus/logger": "3.9.2-canary-6443",
-    "@docusaurus/mdx-loader": "3.9.2-canary-6443",
-    "@docusaurus/theme-common": "3.9.2-canary-6443",
-    "@docusaurus/types": "3.9.2-canary-6443",
-    "@docusaurus/utils": "3.9.2-canary-6443",
-    "@docusaurus/utils-common": "3.9.2-canary-6443",
-    "@docusaurus/utils-validation": "3.9.2-canary-6443",
+    "@docusaurus/core": "3.9.2-canary-6445",
+    "@docusaurus/logger": "3.9.2-canary-6445",
+    "@docusaurus/mdx-loader": "3.9.2-canary-6445",
+    "@docusaurus/theme-common": "3.9.2-canary-6445",
+    "@docusaurus/types": "3.9.2-canary-6445",
+    "@docusaurus/utils": "3.9.2-canary-6445",
+    "@docusaurus/utils-common": "3.9.2-canary-6445",
+    "@docusaurus/utils-validation": "3.9.2-canary-6445",
     "cheerio": "1.0.0-rc.12",
     "feed": "^4.2.2",
     "fs-extra": "^11.1.1",
@@ -62,5 +62,5 @@
     "@total-typescript/shoehorn": "^0.1.2",
     "tree-node-cli": "^1.6.0"
   },
-  "gitHead": "a25dde30cfb44b2e621d62c4a58e371e3d9c96bf"
+  "gitHead": "ce0bfb61b6924d2bb866fa96ff27a73d93af235e"
 }

package/src/index.ts

@@ -17,7 +17,6 @@ import {
   createAbsoluteFilePathMatcher,
   getContentPathList,
   getDataFilePath,
-  DEFAULT_PLUGIN_ID,
   resolveMarkdownLinkPathname,
   getLocaleConfig,
 } from '@docusaurus/utils';
@@ -25,7 +24,6 @@ import {getTagsFilePathsToWatch} from '@docusaurus/utils-validation';
 import {createMDXLoaderItem} from '@docusaurus/mdx-loader';
 import {
   getBlogTags,
-  paginateBlogPosts,
   shouldBeListed,
   applyProcessBlogPosts,
   generateBlogPosts,
@@ -45,7 +43,6 @@ import type {
   Assets,
   BlogTags,
   BlogContent,
-  BlogPaginated,
 } from '@docusaurus/plugin-content-blog';
 import type {RuleSetRule, RuleSetUseItem} from 'webpack';
 
@@ -85,7 +82,7 @@ export default async function pluginContentBlog(
         })
       : undefined,
   };
-  const pluginId = options.id ?? DEFAULT_PLUGIN_ID;
+  const pluginId = options.id;
 
   const pluginDataDirRoot = path.join(generatedFilesDir, PluginName);
   const dataDir = path.join(pluginDataDirRoot, pluginId);
@@ -260,9 +257,10 @@ export default async function pluginContentBlog(
 
       if (!blogPosts.length) {
         return {
+          blogTitle,
+          blogDescription,
           blogSidebarTitle,
           blogPosts: [],
-          blogListPaginated: [],
           blogTags: {},
           blogTagsListPath,
           authorsMap,
@@ -291,15 +289,6 @@ export default async function pluginContentBlog(
         }
       });
 
-      const blogListPaginated: BlogPaginated[] = paginateBlogPosts({
-        blogPosts: listedBlogPosts,
-        blogTitle,
-        blogDescription,
-        postsPerPageOption,
-        basePageUrl: baseBlogUrl,
-        pageBasePath,
-      });
-
       const blogTags: BlogTags = getBlogTags({
         blogPosts,
         postsPerPageOption,
@@ -309,9 +298,10 @@ export default async function pluginContentBlog(
       });
 
       return {
+        blogTitle,
+        blogDescription,
         blogSidebarTitle,
         blogPosts,
-        blogListPaginated,
         blogTags,
         blogTagsListPath,
         authorsMap,

package/src/options.ts

@@ -15,7 +15,7 @@ import {
   RouteBasePathSchema,
   URISchema,
 } from '@docusaurus/utils-validation';
-import {GlobExcludeDefault} from '@docusaurus/utils';
+import {DEFAULT_PLUGIN_ID, GlobExcludeDefault} from '@docusaurus/utils';
 import type {
   PluginOptions,
   Options,
@@ -25,6 +25,7 @@ import type {
 import type {OptionValidationContext} from '@docusaurus/types';
 
 export const DEFAULT_OPTIONS: PluginOptions = {
+  id: DEFAULT_PLUGIN_ID,
   feedOptions: {
     type: ['rss', 'atom'],
     copyright: '',

package/src/plugin-content-blog.d.ts

@@ -431,7 +431,7 @@ declare module '@docusaurus/plugin-content-blog' {
   export type PluginOptions = MDXOptions &
     TagsPluginOptions & {
       /** Plugin ID. */
-      id?: string;
+      id: string;
       /**
        * Path to the blog content directory on the file system, relative to site
        * directory.
@@ -583,9 +583,10 @@ declare module '@docusaurus/plugin-content-blog' {
   export type AuthorsMap = {[authorKey: string]: AuthorWithKey};
 
   export type BlogContent = {
-    blogSidebarTitle: string;
+    blogTitle: string; // for translation purposes
+    blogDescription: string; // for translation purposes
+    blogSidebarTitle: string; // for translation purposes
     blogPosts: BlogPost[];
-    blogListPaginated: BlogPaginated[];
     blogTags: BlogTags;
     blogTagsListPath: string;
     authorsMap?: AuthorsMap;

package/src/routes.ts

@@ -67,27 +67,24 @@ export async function buildAllRoutes({
     blogArchiveComponent,
     routeBasePath,
     archiveBasePath,
-    blogTitle,
     authorsBasePath,
     postsPerPage,
-    blogDescription,
+    pageBasePath,
   } = options;
-  const pluginId = options.id!;
+  const pluginId = options.id;
   const {createData} = actions;
   const {
+    blogTitle,
+    blogDescription,
     blogSidebarTitle,
     blogPosts,
-    blogListPaginated,
     blogTags,
     blogTagsListPath,
     authorsMap,
   } = content;
 
-  const authorsListPath = normalizeUrl([
-    baseUrl,
-    routeBasePath,
-    authorsBasePath,
-  ]);
+  const blogBasePath = normalizeUrl([baseUrl, routeBasePath]);
+  const authorsListPath = normalizeUrl([blogBasePath, authorsBasePath]);
 
   const listedBlogPosts = blogPosts.filter(shouldBeListed);
 
@@ -119,7 +116,7 @@ export async function buildAllRoutes({
 
   async function createBlogMetadataModule() {
     const blogMetadata: BlogMetadata = {
-      blogBasePath: normalizeUrl([baseUrl, routeBasePath]),
+      blogBasePath,
       blogTitle,
       authorsListPath,
     };
@@ -156,7 +153,7 @@ export async function buildAllRoutes({
     if (archiveBasePath && listedBlogPosts.length) {
       return [
         {
-          path: normalizeUrl([baseUrl, routeBasePath, archiveBasePath]),
+          path: normalizeUrl([blogBasePath, archiveBasePath]),
           component: blogArchiveComponent,
           exact: true,
           props: {
@@ -210,6 +207,15 @@ export async function buildAllRoutes({
   }
 
   function createBlogPostsPaginatedRoutes(): RouteConfig[] {
+    const blogListPaginated = paginateBlogPosts({
+      blogPosts: listedBlogPosts,
+      blogTitle,
+      blogDescription,
+      postsPerPageOption: postsPerPage,
+      basePageUrl: blogBasePath,
+      pageBasePath,
+    });
+
     return blogListPaginated.map((paginated) => {
       return {
         path: paginated.metadata.permalink,

package/src/translations.ts

@@ -5,30 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import type {TranslationFileContent, TranslationFile} from '@docusaurus/types';
-import type {
-  PluginOptions,
-  BlogContent,
-  BlogPaginated,
-} from '@docusaurus/plugin-content-blog';
-
-function translateListPage(
-  blogListPaginated: BlogPaginated[],
-  translations: TranslationFileContent,
-) {
-  return blogListPaginated.map((page) => {
-    const {items, metadata} = page;
-    return {
-      items,
-      metadata: {
-        ...metadata,
-        blogTitle: translations.title?.message ?? page.metadata.blogTitle,
-        blogDescription:
-          translations.description?.message ?? page.metadata.blogDescription,
-      },
-    };
-  });
-}
+import type {TranslationFile} from '@docusaurus/types';
+import type {PluginOptions, BlogContent} from '@docusaurus/plugin-content-blog';
 
 export function getTranslationFiles(options: PluginOptions): TranslationFile[] {
   return [
@@ -56,14 +34,13 @@ export function translateContent(
   content: BlogContent,
   translationFiles: TranslationFile[],
 ): BlogContent {
-  const {content: optionsTranslations} = translationFiles[0]!;
+  const {content: translations} = translationFiles[0]!;
   return {
     ...content,
+    blogTitle: translations.title?.message ?? content.blogTitle,
+    blogDescription:
+      translations.description?.message ?? content.blogDescription,
     blogSidebarTitle:
-      optionsTranslations['sidebar.title']?.message ?? content.blogSidebarTitle,
-    blogListPaginated: translateListPage(
-      content.blogListPaginated,
-      optionsTranslations,
-    ),
+      translations['sidebar.title']?.message ?? content.blogSidebarTitle,
   };
 }