@docusaurus/plugin-content-pages 2.0.0-beta.16 → 2.0.0-beta.19

package/lib/{pageFrontMatter.d.ts → frontMatter.d.ts}

@@ -5,4 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { FrontMatter } from '@docusaurus/plugin-content-pages';
-export declare function validatePageFrontMatter(frontMatter: Record<string, unknown>): FrontMatter;
+export declare function validatePageFrontMatter(frontMatter: {
+    [key: string]: unknown;
+}): FrontMatter;

package/lib/index.d.ts

@@ -4,9 +4,9 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { LoadContext, Plugin, OptionValidationContext, ValidationResult } from '@docusaurus/types';
-import type { LoadedContent, PagesContentPaths } from './types';
-import type { PluginOptions } from '@docusaurus/plugin-content-pages';
+import type { LoadContext, Plugin } from '@docusaurus/types';
+import type { PagesContentPaths } from './types';
+import type { PluginOptions, LoadedContent } from '@docusaurus/plugin-content-pages';
 export declare function getContentPathList(contentPaths: PagesContentPaths): string[];
 export default function pluginContentPages(context: LoadContext, options: PluginOptions): Promise<Plugin<LoadedContent | null>>;
-export declare function validateOptions({ validate, options, }: OptionValidationContext<PluginOptions>): ValidationResult<PluginOptions>;
+export { validateOptions } from './options';

package/lib/index.js

@@ -8,22 +8,20 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateOptions = exports.getContentPathList = void 0;
 const tslib_1 = require("tslib");
-const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
-const path_1 = (0, tslib_1.__importDefault)(require("path"));
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const path_1 = tslib_1.__importDefault(require("path"));
 const utils_1 = require("@docusaurus/utils");
-const remark_admonitions_1 = (0, tslib_1.__importDefault)(require("remark-admonitions"));
-const pluginOptionSchema_1 = require("./pluginOptionSchema");
-const pageFrontMatter_1 = require("./pageFrontMatter");
+const remark_admonitions_1 = tslib_1.__importDefault(require("remark-admonitions"));
+const frontMatter_1 = require("./frontMatter");
 function getContentPathList(contentPaths) {
     return [contentPaths.contentPathLocalized, contentPaths.contentPath];
 }
 exports.getContentPathList = getContentPathList;
 const isMarkdownSource = (source) => source.endsWith('.md') || source.endsWith('.mdx');
 async function pluginContentPages(context, options) {
-    var _a;
     if (options.admonitions) {
         options.remarkPlugins = options.remarkPlugins.concat([
-            [remark_admonitions_1.default, options.admonitions || {}],
+            [remark_admonitions_1.default, options.admonitions],
         ]);
     }
     const { siteConfig, siteDir, generatedFilesDir, i18n: { currentLocale }, } = context;
@@ -37,11 +35,11 @@ async function pluginContentPages(context, options) {
         }),
     };
     const pluginDataDirRoot = path_1.default.join(generatedFilesDir, 'docusaurus-plugin-content-pages');
-    const dataDir = path_1.default.join(pluginDataDirRoot, (_a = options.id) !== null && _a !== void 0 ? _a : utils_1.DEFAULT_PLUGIN_ID);
+    const dataDir = path_1.default.join(pluginDataDirRoot, options.id ?? utils_1.DEFAULT_PLUGIN_ID);
     return {
         name: 'docusaurus-plugin-content-pages',
         getPathsToWatch() {
-            const { include = [] } = options;
+            const { include } = options;
             return getContentPathList(contentPaths).flatMap((contentPath) => include.map((pattern) => `${contentPath}/${pattern}`));
         },
         async loadContent() {
@@ -55,7 +53,6 @@ async function pluginContentPages(context, options) {
                 ignore: options.exclude,
             });
             async function toMetadata(relativeSource) {
-                var _a, _b;
                 // Lookup in localized folder in priority
                 const contentPath = await (0, utils_1.getFolderContainingFile)(getContentPathList(contentPaths), relativeSource);
                 const source = path_1.default.join(contentPath, relativeSource);
@@ -74,13 +71,13 @@ async 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, pageFrontMatter_1.validatePageFrontMatter)(unsafeFrontMatter);
+                const frontMatter = (0, frontMatter_1.validatePageFrontMatter)(unsafeFrontMatter);
                 return {
                     type: 'mdx',
                     permalink,
                     source: aliasedSourcePath,
-                    title: (_a = frontMatter.title) !== null && _a !== void 0 ? _a : contentTitle,
-                    description: (_b = frontMatter.description) !== null && _b !== void 0 ? _b : excerpt,
+                    title: frontMatter.title ?? contentTitle,
+                    description: frontMatter.description ?? excerpt,
                     frontMatter,
                 };
             }
@@ -119,7 +116,7 @@ async function pluginContentPages(context, options) {
                 }
             }));
         },
-        configureWebpack(_config, isServer, { getJSLoader }) {
+        configureWebpack(config, isServer, { getJSLoader }) {
             const { rehypePlugins, remarkPlugins, beforeDefaultRehypePlugins, beforeDefaultRemarkPlugins, } = options;
             const contentDirs = getContentPathList(contentPaths);
             return {
@@ -171,8 +168,5 @@ async function pluginContentPages(context, options) {
     };
 }
 exports.default = pluginContentPages;
-function validateOptions({ validate, options, }) {
-    const validatedOptions = validate(pluginOptionSchema_1.PluginOptionSchema, options);
-    return validatedOptions;
-}
-exports.validateOptions = validateOptions;
+var options_1 = require("./options");
+Object.defineProperty(exports, "validateOptions", { enumerable: true, get: function () { return options_1.validateOptions; } });

package/lib/markdownLoader.js

@@ -11,6 +11,6 @@ function markdownLoader(fileString) {
     // const options = this.getOptions();
     // TODO provide additional md processing here? like interlinking pages?
     // fileString = linkify(fileString)
-    return callback && callback(null, fileString);
+    return callback?.(null, fileString);
 }
 exports.default = markdownLoader;

package/lib/options.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 type { PluginOptions, Options } from '@docusaurus/plugin-content-pages';
+import type { OptionValidationContext } from '@docusaurus/types';
+export declare const DEFAULT_OPTIONS: PluginOptions;
+export declare function validateOptions({ validate, options, }: OptionValidationContext<Options, PluginOptions>): PluginOptions;

package/lib/{pluginOptionSchema.js → options.js}

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PluginOptionSchema = exports.DEFAULT_OPTIONS = void 0;
+exports.validateOptions = exports.DEFAULT_OPTIONS = void 0;
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const utils_1 = require("@docusaurus/utils");
 exports.DEFAULT_OPTIONS = {
@@ -21,7 +21,7 @@ exports.DEFAULT_OPTIONS = {
     beforeDefaultRemarkPlugins: [],
     admonitions: {},
 };
-exports.PluginOptionSchema = utils_validation_1.Joi.object({
+const PluginOptionSchema = utils_validation_1.Joi.object({
     path: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.path),
     routeBasePath: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.routeBasePath),
     include: utils_validation_1.Joi.array().items(utils_validation_1.Joi.string()).default(exports.DEFAULT_OPTIONS.include),
@@ -33,3 +33,8 @@ exports.PluginOptionSchema = utils_validation_1.Joi.object({
     beforeDefaultRemarkPlugins: utils_validation_1.RemarkPluginsSchema.default(exports.DEFAULT_OPTIONS.beforeDefaultRemarkPlugins),
     admonitions: utils_validation_1.AdmonitionsSchema.default(exports.DEFAULT_OPTIONS.admonitions),
 });
+function validateOptions({ validate, options, }) {
+    const validatedOptions = validate(PluginOptionSchema, options);
+    return validatedOptions;
+}
+exports.validateOptions = validateOptions;

package/lib/types.d.ts

@@ -4,8 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { Metadata } from '@docusaurus/plugin-content-pages';
-export declare type LoadedContent = Metadata[];
 export declare type PagesContentPaths = {
     contentPath: string;
     contentPathLocalized: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-pages",
-  "version": "2.0.0-beta.16",
+  "version": "2.0.0-beta.19",
   "description": "Pages plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-pages.d.ts",
@@ -18,17 +18,17 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.16",
-    "@docusaurus/mdx-loader": "2.0.0-beta.16",
-    "@docusaurus/utils": "2.0.0-beta.16",
-    "@docusaurus/utils-validation": "2.0.0-beta.16",
-    "fs-extra": "^10.0.1",
+    "@docusaurus/core": "2.0.0-beta.19",
+    "@docusaurus/mdx-loader": "2.0.0-beta.19",
+    "@docusaurus/utils": "2.0.0-beta.19",
+    "@docusaurus/utils-validation": "2.0.0-beta.19",
+    "fs-extra": "^10.1.0",
     "remark-admonitions": "^1.2.1",
-    "tslib": "^2.3.1",
-    "webpack": "^5.69.1"
+    "tslib": "^2.4.0",
+    "webpack": "^5.72.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "2.0.0-beta.16"
+    "@docusaurus/types": "2.0.0-beta.19"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
@@ -37,5 +37,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "eb43c4d4f95a4fb97dc9bb9dc615413e0dc2e1e7"
+  "gitHead": "a71e60a49cce93c1006ef10c41ac03187f057102"
 }

package/src/deps.d.ts

@@ -6,7 +6,7 @@
  */
 
 declare module 'remark-admonitions' {
-  type Options = Record<string, unknown>;
+  type Options = {[key: string]: unknown};
 
   const plugin: (options?: Options) => void;
   export = plugin;

package/src/{pageFrontMatter.ts → frontMatter.ts}

@@ -20,8 +20,8 @@ const PageFrontMatterSchema = Joi.object<FrontMatter>({
   ...FrontMatterTOCHeadingLevels,
 });
 
-export function validatePageFrontMatter(
-  frontMatter: Record<string, unknown>,
-): FrontMatter {
+export function validatePageFrontMatter(frontMatter: {
+  [key: string]: unknown;
+}): FrontMatter {
   return validateFrontMatter(frontMatter, PageFrontMatterSchema);
 }

package/src/index.ts

@@ -21,18 +21,16 @@ import {
   DEFAULT_PLUGIN_ID,
   parseMarkdownString,
 } from '@docusaurus/utils';
-import type {
-  LoadContext,
-  Plugin,
-  OptionValidationContext,
-  ValidationResult,
-} from '@docusaurus/types';
+import type {LoadContext, Plugin} from '@docusaurus/types';
 import admonitions from 'remark-admonitions';
-import {PluginOptionSchema} from './pluginOptionSchema';
-import {validatePageFrontMatter} from './pageFrontMatter';
+import {validatePageFrontMatter} from './frontMatter';
 
-import type {LoadedContent, PagesContentPaths} from './types';
-import type {PluginOptions, Metadata} from '@docusaurus/plugin-content-pages';
+import type {PagesContentPaths} from './types';
+import type {
+  PluginOptions,
+  Metadata,
+  LoadedContent,
+} from '@docusaurus/plugin-content-pages';
 
 export function getContentPathList(contentPaths: PagesContentPaths): string[] {
   return [contentPaths.contentPathLocalized, contentPaths.contentPath];
@@ -47,7 +45,7 @@ export default async function pluginContentPages(
 ): Promise<Plugin<LoadedContent | null>> {
   if (options.admonitions) {
     options.remarkPlugins = options.remarkPlugins.concat([
-      [admonitions, options.admonitions || {}],
+      [admonitions, options.admonitions],
     ]);
   }
   const {
@@ -77,7 +75,7 @@ export default async function pluginContentPages(
     name: 'docusaurus-plugin-content-pages',
 
     getPathsToWatch() {
-      const {include = []} = options;
+      const {include} = options;
       return getContentPathList(contentPaths).flatMap((contentPath) =>
         include.map((pattern) => `${contentPath}/${pattern}`),
       );
@@ -176,7 +174,7 @@ export default async function pluginContentPages(
       );
     },
 
-    configureWebpack(_config, isServer, {getJSLoader}) {
+    configureWebpack(config, isServer, {getJSLoader}) {
       const {
         rehypePlugins,
         remarkPlugins,
@@ -241,10 +239,4 @@ export default async function pluginContentPages(
   };
 }
 
-export function validateOptions({
-  validate,
-  options,
-}: OptionValidationContext<PluginOptions>): ValidationResult<PluginOptions> {
-  const validatedOptions = validate(PluginOptionSchema, options);
-  return validatedOptions;
-}
+export {validateOptions} from './options';

package/src/markdownLoader.ts

@@ -18,5 +18,5 @@ export default function markdownLoader(
   // TODO provide additional md processing here? like interlinking pages?
   // fileString = linkify(fileString)
 
-  return callback && callback(null, fileString);
+  return callback?.(null, fileString);
 }

package/src/{pluginOptionSchema.ts → options.ts}

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import type {PluginOptions} from '@docusaurus/plugin-content-pages';
+import type {PluginOptions, Options} from '@docusaurus/plugin-content-pages';
 import {
   Joi,
   RemarkPluginsSchema,
@@ -13,6 +13,7 @@ import {
   AdmonitionsSchema,
 } from '@docusaurus/utils-validation';
 import {GlobExcludeDefault} from '@docusaurus/utils';
+import type {OptionValidationContext} from '@docusaurus/types';
 
 export const DEFAULT_OPTIONS: PluginOptions = {
   path: 'src/pages', // Path to data on filesystem, relative to site dir.
@@ -27,7 +28,7 @@ export const DEFAULT_OPTIONS: PluginOptions = {
   admonitions: {},
 };
 
-export const PluginOptionSchema = Joi.object({
+const PluginOptionSchema = Joi.object({
   path: Joi.string().default(DEFAULT_OPTIONS.path),
   routeBasePath: Joi.string().default(DEFAULT_OPTIONS.routeBasePath),
   include: Joi.array().items(Joi.string()).default(DEFAULT_OPTIONS.include),
@@ -43,3 +44,11 @@ export const PluginOptionSchema = Joi.object({
   ),
   admonitions: AdmonitionsSchema.default(DEFAULT_OPTIONS.admonitions),
 });
+
+export function validateOptions({
+  validate,
+  options,
+}: OptionValidationContext<Options, PluginOptions>): PluginOptions {
+  const validatedOptions = validate(PluginOptionSchema, options);
+  return validatedOptions;
+}

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

@@ -6,16 +6,17 @@
  */
 
 declare module '@docusaurus/plugin-content-pages' {
-  import type {RemarkAndRehypePluginOptions} from '@docusaurus/mdx-loader';
+  import type {MDXOptions} from '@docusaurus/mdx-loader';
+  import type {LoadContext, Plugin} from '@docusaurus/types';
 
-  export type PluginOptions = RemarkAndRehypePluginOptions & {
+  export type PluginOptions = MDXOptions & {
     id?: string;
     path: string;
     routeBasePath: string;
     include: string[];
     exclude: string[];
     mdxPageComponent: string;
-    admonitions: Record<string, unknown>;
+    admonitions: {[key: string]: unknown};
   };
 
   export type Options = Partial<PluginOptions>;
@@ -39,28 +40,30 @@ declare module '@docusaurus/plugin-content-pages' {
     type: 'mdx';
     permalink: string;
     source: string;
-    frontMatter: FrontMatter & Record<string, unknown>;
+    frontMatter: FrontMatter & {[key: string]: unknown};
     title?: string;
     description?: string;
   };
 
   export type Metadata = JSXPageMetadata | MDXPageMetadata;
+
+  export type LoadedContent = Metadata[];
+
+  export default function pluginContentPages(
+    context: LoadContext,
+    options: PluginOptions,
+  ): Promise<Plugin<LoadedContent | null>>;
 }
 
 declare module '@theme/MDXPage' {
-  import type {TOCItem} from '@docusaurus/types';
+  import type {LoadedMDXContent} from '@docusaurus/mdx-loader';
   import type {
     MDXPageMetadata,
     FrontMatter,
   } from '@docusaurus/plugin-content-pages';
 
   export interface Props {
-    readonly content: {
-      readonly frontMatter: FrontMatter;
-      readonly metadata: MDXPageMetadata;
-      readonly toc: readonly TOCItem[];
-      (): JSX.Element;
-    };
+    readonly content: LoadedMDXContent<FrontMatter, MDXPageMetadata>;
   }
 
   export default function MDXPage(props: Props): JSX.Element;

package/src/types.ts

@@ -5,10 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import type {Metadata} from '@docusaurus/plugin-content-pages';
-
-export type LoadedContent = Metadata[];
-
 export type PagesContentPaths = {
   contentPath: string;
   contentPathLocalized: string;

package/lib/pluginOptionSchema.d.ts

@@ -1,10 +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 type { PluginOptions } from '@docusaurus/plugin-content-pages';
-import { Joi } from '@docusaurus/utils-validation';
-export declare const DEFAULT_OPTIONS: PluginOptions;
-export declare const PluginOptionSchema: Joi.ObjectSchema<any>;