@docusaurus/plugin-content-pages 0.0.0-5362 → 0.0.0-5363

package/lib/frontMatter.js

@@ -14,7 +14,7 @@ const PageFrontMatterSchema = utils_validation_1.Joi.object({
     wrapperClassName: utils_validation_1.Joi.string(),
     hide_table_of_contents: utils_validation_1.Joi.boolean(),
     ...utils_validation_1.FrontMatterTOCHeadingLevels,
-});
+}).concat(utils_validation_1.ContentVisibilitySchema);
 function validatePageFrontMatter(frontMatter) {
     return (0, utils_validation_1.validateFrontMatter)(frontMatter, PageFrontMatterSchema);
 }

package/lib/index.js

@@ -45,7 +45,7 @@ function pluginContentPages(context, options) {
                 cwd: contentPaths.contentPath,
                 ignore: options.exclude,
             });
-            async function toMetadata(relativeSource) {
+            async function processPageSourceFile(relativeSource) {
                 // Lookup in localized folder in priority
                 const contentPath = await (0, utils_1.getFolderContainingFile)(getContentPathList(contentPaths), relativeSource);
                 const source = path_1.default.join(contentPath, relativeSource);
@@ -65,6 +65,10 @@ function pluginContentPages(context, options) {
                 const content = await fs_extra_1.default.readFile(source, 'utf-8');
                 const { frontMatter: unsafeFrontMatter, contentTitle, excerpt, } = (0, utils_1.parseMarkdownString)(content);
                 const frontMatter = (0, frontMatter_1.validatePageFrontMatter)(unsafeFrontMatter);
+                if ((0, utils_1.isDraft)({ frontMatter })) {
+                    return undefined;
+                }
+                const unlisted = (0, utils_1.isUnlisted)({ frontMatter });
                 return {
                     type: 'mdx',
                     permalink,
@@ -72,9 +76,18 @@ function pluginContentPages(context, options) {
                     title: frontMatter.title ?? contentTitle,
                     description: frontMatter.description ?? excerpt,
                     frontMatter,
+                    unlisted,
                 };
             }
-            return Promise.all(pagesFiles.map(toMetadata));
+            async function doProcessPageSourceFile(relativeSource) {
+                try {
+                    return await processPageSourceFile(relativeSource);
+                }
+                catch (err) {
+                    throw new Error(`Processing of page source file path=${relativeSource} failed.`, { cause: err });
+                }
+            }
+            return (await Promise.all(pagesFiles.map(doProcessPageSourceFile))).filter(Boolean);
         },
         async contentLoaded({ content, actions }) {
             if (!content) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-pages",
-  "version": "0.0.0-5362",
+  "version": "0.0.0-5363",
   "description": "Pages plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-pages.d.ts",
@@ -18,11 +18,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-5362",
-    "@docusaurus/mdx-loader": "0.0.0-5362",
-    "@docusaurus/types": "0.0.0-5362",
-    "@docusaurus/utils": "0.0.0-5362",
-    "@docusaurus/utils-validation": "0.0.0-5362",
+    "@docusaurus/core": "0.0.0-5363",
+    "@docusaurus/mdx-loader": "0.0.0-5363",
+    "@docusaurus/types": "0.0.0-5363",
+    "@docusaurus/utils": "0.0.0-5363",
+    "@docusaurus/utils-validation": "0.0.0-5363",
     "fs-extra": "^10.1.0",
     "tslib": "^2.4.0",
     "webpack": "^5.74.0"
@@ -34,5 +34,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "c3bef651473ab5aabf0b28f56c2e3d680a3d5615"
+  "gitHead": "dbe94ffd19b3e3eb1dcb64e85b61350045faa250"
 }

package/src/frontMatter.ts

@@ -9,6 +9,7 @@ import {
   Joi,
   validateFrontMatter,
   FrontMatterTOCHeadingLevels,
+  ContentVisibilitySchema,
 } from '@docusaurus/utils-validation';
 import type {FrontMatter} from '@docusaurus/plugin-content-pages';
 
@@ -18,7 +19,7 @@ const PageFrontMatterSchema = Joi.object<FrontMatter>({
   wrapperClassName: Joi.string(),
   hide_table_of_contents: Joi.boolean(),
   ...FrontMatterTOCHeadingLevels,
-});
+}).concat(ContentVisibilitySchema);
 
 export function validatePageFrontMatter(frontMatter: {
   [key: string]: unknown;

package/src/index.ts

@@ -20,6 +20,8 @@ import {
   normalizeUrl,
   DEFAULT_PLUGIN_ID,
   parseMarkdownString,
+  isUnlisted,
+  isDraft,
 } from '@docusaurus/utils';
 import {validatePageFrontMatter} from './frontMatter';
 
@@ -82,7 +84,9 @@ export default function pluginContentPages(
         ignore: options.exclude,
       });
 
-      async function toMetadata(relativeSource: string): Promise<Metadata> {
+      async function processPageSourceFile(
+        relativeSource: string,
+      ): Promise<Metadata | undefined> {
         // Lookup in localized folder in priority
         const contentPath = await getFolderContainingFile(
           getContentPathList(contentPaths),
@@ -110,6 +114,12 @@ export default function pluginContentPages(
           excerpt,
         } = parseMarkdownString(content);
         const frontMatter = validatePageFrontMatter(unsafeFrontMatter);
+
+        if (isDraft({frontMatter})) {
+          return undefined;
+        }
+        const unlisted = isUnlisted({frontMatter});
+
         return {
           type: 'mdx',
           permalink,
@@ -117,10 +127,24 @@ export default function pluginContentPages(
           title: frontMatter.title ?? contentTitle,
           description: frontMatter.description ?? excerpt,
           frontMatter,
+          unlisted,
         };
       }
 
-      return Promise.all(pagesFiles.map(toMetadata));
+      async function doProcessPageSourceFile(relativeSource: string) {
+        try {
+          return await processPageSourceFile(relativeSource);
+        } catch (err) {
+          throw new Error(
+            `Processing of page source file path=${relativeSource} failed.`,
+            {cause: err as Error},
+          );
+        }
+      }
+
+      return (
+        await Promise.all(pagesFiles.map(doProcessPageSourceFile))
+      ).filter(Boolean) as Metadata[];
     },
 
     async contentLoaded({content, actions}) {

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

@@ -27,6 +27,8 @@ declare module '@docusaurus/plugin-content-pages' {
     readonly hide_table_of_contents?: string;
     readonly toc_min_heading_level?: number;
     readonly toc_max_heading_level?: number;
+    readonly draft?: boolean;
+    readonly unlisted?: boolean;
   };
 
   export type JSXPageMetadata = {
@@ -42,6 +44,7 @@ declare module '@docusaurus/plugin-content-pages' {
     frontMatter: FrontMatter & {[key: string]: unknown};
     title?: string;
     description?: string;
+    unlisted: boolean;
   };
 
   export type Metadata = JSXPageMetadata | MDXPageMetadata;