@docusaurus/plugin-content-blog 0.0.0-4446 → 0.0.0-4453

package/lib/authors.js

@@ -10,12 +10,13 @@ exports.getBlogPostAuthors = exports.getAuthorsMap = exports.validateAuthorsMap
 const utils_1 = require("@docusaurus/utils");
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const AuthorsMapSchema = utils_validation_1.Joi.object().pattern(utils_validation_1.Joi.string(), utils_validation_1.Joi.object({
-    name: utils_validation_1.Joi.string().required(),
+    name: utils_validation_1.Joi.string(),
     url: utils_validation_1.URISchema,
     imageURL: utils_validation_1.URISchema,
     title: utils_validation_1.Joi.string(),
 })
     .rename('image_url', 'imageURL')
+    .or('name', 'imageURL')
     .unknown()
     .required());
 function validateAuthorsMap(content) {
@@ -38,7 +39,6 @@ function getFrontMatterAuthorLegacy(frontMatter) {
     const title = (_a = frontMatter.author_title) !== null && _a !== void 0 ? _a : frontMatter.authorTitle;
     const url = (_b = frontMatter.author_url) !== null && _b !== void 0 ? _b : frontMatter.authorURL;
     const imageURL = (_c = frontMatter.author_image_url) !== null && _c !== void 0 ? _c : frontMatter.authorImageURL;
-    // Shouldn't we require at least an author name?
     if (name || title || url || imageURL) {
         return {
             name,

package/lib/blogFrontMatter.js

@@ -15,7 +15,7 @@ const BlogPostFrontMatterAuthorSchema = utils_validation_1.JoiFrontMatter.object
     url: utils_validation_1.URISchema,
     imageURL: utils_validation_1.JoiFrontMatter.string(),
 })
-    .or('key', 'name')
+    .or('key', 'name', 'imageURL')
     .rename('image_url', 'imageURL', { alias: true });
 const FrontMatterAuthorErrorMessage = '{{#label}} does not look like a valid blog post author. Please use an author key or an author object (with a key and/or name).';
 const BlogFrontMatterSchema = utils_validation_1.JoiFrontMatter.object({

package/lib/blogUtils.js

@@ -33,16 +33,15 @@ function getBlogTags(blogPosts) {
     }));
 }
 exports.getBlogTags = getBlogTags;
-const DATE_FILENAME_REGEX = /^(?<date>\d{4}[-/]\d{1,2}[-/]\d{1,2})[-/]?(?<text>.*?)(\/index)?.mdx?$/;
+const DATE_FILENAME_REGEX = /^(?<folder>.*)(?<date>\d{4}[-/]\d{1,2}[-/]\d{1,2})[-/]?(?<text>.*?)(\/index)?.mdx?$/;
 function parseBlogFileName(blogSourceRelative) {
     const dateFilenameMatch = blogSourceRelative.match(DATE_FILENAME_REGEX);
     if (dateFilenameMatch) {
-        const dateString = dateFilenameMatch.groups.date;
-        const text = dateFilenameMatch.groups.text;
+        const { folder, text, date: dateString } = dateFilenameMatch.groups;
         // Always treat dates as UTC by adding the `Z`
         const date = new Date(`${dateString}Z`);
         const slugDate = dateString.replace(/-/g, '/');
-        const slug = `/${slugDate}/${text}`;
+        const slug = `/${slugDate}/${folder}${text}`;
         return { date, text, slug };
     }
     else {

package/lib/index.js

@@ -135,21 +135,23 @@ async function pluginContentBlog(context, options) {
             const sidebarBlogPosts = options.blogSidebarCount === 'ALL'
                 ? blogPosts
                 : blogPosts.slice(0, options.blogSidebarCount);
-            const archiveUrl = (0, utils_1.normalizeUrl)([
-                baseUrl,
-                routeBasePath,
-                archiveBasePath,
-            ]);
-            // creates a blog archive route
-            const archiveProp = await createData(`${(0, utils_1.docuHash)(archiveUrl)}.json`, JSON.stringify({ blogPosts }, null, 2));
-            addRoute({
-                path: archiveUrl,
-                component: '@theme/BlogArchivePage',
-                exact: true,
-                modules: {
-                    archive: aliasedSource(archiveProp),
-                },
-            });
+            if (archiveBasePath) {
+                const archiveUrl = (0, utils_1.normalizeUrl)([
+                    baseUrl,
+                    routeBasePath,
+                    archiveBasePath,
+                ]);
+                // creates a blog archive route
+                const archiveProp = await createData(`${(0, utils_1.docuHash)(archiveUrl)}.json`, JSON.stringify({ blogPosts }, null, 2));
+                addRoute({
+                    path: archiveUrl,
+                    component: '@theme/BlogArchivePage',
+                    exact: true,
+                    modules: {
+                        archive: aliasedSource(archiveProp),
+                    },
+                });
+            }
             // This prop is useful to provide the blog list sidebar
             const sidebarProp = await createData(
             // Note that this created data path must be in sync with

package/lib/pluginOptionSchema.js

@@ -40,7 +40,9 @@ exports.DEFAULT_OPTIONS = {
 };
 exports.PluginOptionSchema = utils_validation_1.Joi.object({
     path: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.path),
-    archiveBasePath: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.archiveBasePath),
+    archiveBasePath: utils_validation_1.Joi.string()
+        .default(exports.DEFAULT_OPTIONS.archiveBasePath)
+        .allow(null),
     routeBasePath: utils_validation_1.Joi.string()
         // '' not allowed, see https://github.com/facebook/docusaurus/issues/3374
         // .allow('')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "0.0.0-4446",
+  "version": "0.0.0-4453",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -18,11 +18,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4446",
-    "@docusaurus/logger": "0.0.0-4446",
-    "@docusaurus/mdx-loader": "0.0.0-4446",
-    "@docusaurus/utils": "0.0.0-4446",
-    "@docusaurus/utils-validation": "0.0.0-4446",
+    "@docusaurus/core": "0.0.0-4453",
+    "@docusaurus/logger": "0.0.0-4453",
+    "@docusaurus/mdx-loader": "0.0.0-4453",
+    "@docusaurus/utils": "0.0.0-4453",
+    "@docusaurus/utils-validation": "0.0.0-4453",
     "escape-string-regexp": "^4.0.0",
     "feed": "^4.2.2",
     "fs-extra": "^10.0.0",
@@ -36,7 +36,7 @@
     "webpack": "^5.61.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "0.0.0-4446"
+    "@docusaurus/types": "0.0.0-4453"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
@@ -45,5 +45,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "3b5ca11c2e1f052cb3c6f4be722c91f5f9de638d"
+  "gitHead": "5379d3424fde605d7bde0fa2ba86b9db1ca4becc"
 }

package/src/authors.ts

@@ -20,12 +20,13 @@ export type AuthorsMap = Record<string, Author>;
 const AuthorsMapSchema = Joi.object<AuthorsMap>().pattern(
   Joi.string(),
   Joi.object({
-    name: Joi.string().required(),
+    name: Joi.string(),
     url: URISchema,
     imageURL: URISchema,
     title: Joi.string(),
   })
     .rename('image_url', 'imageURL')
+    .or('name', 'imageURL')
     .unknown()
     .required(),
 );
@@ -63,7 +64,6 @@ function getFrontMatterAuthorLegacy(
   const url = frontMatter.author_url ?? frontMatter.authorURL;
   const imageURL = frontMatter.author_image_url ?? frontMatter.authorImageURL;
 
-  // Shouldn't we require at least an author name?
   if (name || title || url || imageURL) {
     return {
       name,

package/src/blogFrontMatter.ts

@@ -21,7 +21,7 @@ const BlogPostFrontMatterAuthorSchema = Joi.object({
   url: URISchema,
   imageURL: Joi.string(),
 })
-  .or('key', 'name')
+  .or('key', 'name', 'imageURL')
   .rename('image_url', 'imageURL', {alias: true});
 
 const FrontMatterAuthorErrorMessage =

package/src/blogUtils.ts

@@ -63,7 +63,7 @@ export function getBlogTags(blogPosts: BlogPost[]): BlogTags {
 }
 
 const DATE_FILENAME_REGEX =
-  /^(?<date>\d{4}[-/]\d{1,2}[-/]\d{1,2})[-/]?(?<text>.*?)(\/index)?.mdx?$/;
+  /^(?<folder>.*)(?<date>\d{4}[-/]\d{1,2}[-/]\d{1,2})[-/]?(?<text>.*?)(\/index)?.mdx?$/;
 
 type ParsedBlogFileName = {
   date: Date | undefined;
@@ -76,12 +76,11 @@ export function parseBlogFileName(
 ): ParsedBlogFileName {
   const dateFilenameMatch = blogSourceRelative.match(DATE_FILENAME_REGEX);
   if (dateFilenameMatch) {
-    const dateString = dateFilenameMatch.groups!.date!;
-    const text = dateFilenameMatch.groups!.text!;
+    const {folder, text, date: dateString} = dateFilenameMatch.groups!;
     // Always treat dates as UTC by adding the `Z`
     const date = new Date(`${dateString}Z`);
     const slugDate = dateString.replace(/-/g, '/');
-    const slug = `/${slugDate}/${text}`;
+    const slug = `/${slugDate}/${folder}${text}`;
     return {date, text, slug};
   } else {
     const text = blogSourceRelative.replace(/(\/index)?\.mdx?$/, '');

package/src/index.ts

@@ -242,25 +242,26 @@ export default async function pluginContentBlog(
           ? blogPosts
           : blogPosts.slice(0, options.blogSidebarCount);
 
-      const archiveUrl = normalizeUrl([
-        baseUrl,
-        routeBasePath,
-        archiveBasePath,
-      ]);
-
-      // creates a blog archive route
-      const archiveProp = await createData(
-        `${docuHash(archiveUrl)}.json`,
-        JSON.stringify({blogPosts}, null, 2),
-      );
-      addRoute({
-        path: archiveUrl,
-        component: '@theme/BlogArchivePage',
-        exact: true,
-        modules: {
-          archive: aliasedSource(archiveProp),
-        },
-      });
+      if (archiveBasePath) {
+        const archiveUrl = normalizeUrl([
+          baseUrl,
+          routeBasePath,
+          archiveBasePath,
+        ]);
+        // creates a blog archive route
+        const archiveProp = await createData(
+          `${docuHash(archiveUrl)}.json`,
+          JSON.stringify({blogPosts}, null, 2),
+        );
+        addRoute({
+          path: archiveUrl,
+          component: '@theme/BlogArchivePage',
+          exact: true,
+          modules: {
+            archive: aliasedSource(archiveProp),
+          },
+        });
+      }
 
       // This prop is useful to provide the blog list sidebar
       const sidebarProp = await createData(

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

@@ -112,7 +112,7 @@ declare module '@docusaurus/plugin-content-blog' {
     path: string;
     routeBasePath: string;
     tagsBasePath: string;
-    archiveBasePath: string;
+    archiveBasePath: string | null;
     include: string[];
     exclude: string[];
     postsPerPage: number | 'ALL';

package/src/pluginOptionSchema.ts

@@ -47,7 +47,9 @@ export const DEFAULT_OPTIONS: PluginOptions = {
 
 export const PluginOptionSchema = Joi.object<PluginOptions>({
   path: Joi.string().default(DEFAULT_OPTIONS.path),
-  archiveBasePath: Joi.string().default(DEFAULT_OPTIONS.archiveBasePath),
+  archiveBasePath: Joi.string()
+    .default(DEFAULT_OPTIONS.archiveBasePath)
+    .allow(null),
   routeBasePath: Joi.string()
     // '' not allowed, see https://github.com/facebook/docusaurus/issues/3374
     // .allow('')