@docusaurus/plugin-sitemap 2.0.0-beta.17 → 2.0.0-beta.18

package/lib/index.d.ts

@@ -5,6 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { Options } from '@docusaurus/plugin-sitemap';
-import type { LoadContext, OptionValidationContext, ValidationResult, Plugin } from '@docusaurus/types';
-export default function pluginSitemap(_context: LoadContext, options: Options): Plugin<void>;
-export declare function validateOptions({ validate, options, }: OptionValidationContext<Options>): ValidationResult<Options>;
+import type { LoadContext, Plugin } from '@docusaurus/types';
+export default function pluginSitemap(context: LoadContext, options: Options): Plugin<void>;
+export { validateOptions } from './options';

package/lib/index.js

@@ -11,8 +11,7 @@ const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
 const createSitemap_1 = tslib_1.__importDefault(require("./createSitemap"));
-const pluginOptionSchema_1 = require("./pluginOptionSchema");
-function pluginSitemap(_context, options) {
+function pluginSitemap(context, options) {
     return {
         name: 'docusaurus-plugin-sitemap',
         async postBuild({ siteConfig, routesPaths, outDir }) {
@@ -33,8 +32,5 @@ function pluginSitemap(_context, options) {
     };
 }
 exports.default = pluginSitemap;
-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/{pluginOptionSchema.d.ts → options.d.ts}

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { Joi } from '@docusaurus/utils-validation';
 import type { Options } from '@docusaurus/plugin-sitemap';
-export declare const DEFAULT_OPTIONS: Required<Options>;
-export declare const PluginOptionSchema: Joi.ObjectSchema<any>;
+import type { OptionValidationContext } from '@docusaurus/types';
+export declare const DEFAULT_OPTIONS: Options;
+export declare function validateOptions({ validate, options, }: OptionValidationContext<Options, Options>): Options;

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

@@ -6,15 +6,14 @@
  * 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 sitemap_1 = require("sitemap");
 exports.DEFAULT_OPTIONS = {
     changefreq: sitemap_1.EnumChangefreq.WEEKLY,
     priority: 0.5,
 };
-exports.PluginOptionSchema = utils_validation_1.Joi.object({
-    // TODO temporary (@alpha-71)
+const PluginOptionSchema = utils_validation_1.Joi.object({
     cacheTime: utils_validation_1.Joi.forbidden().messages({
         'any.unknown': 'Option `cacheTime` in sitemap config is deprecated. Please remove it.',
     }),
@@ -26,3 +25,8 @@ exports.PluginOptionSchema = utils_validation_1.Joi.object({
         'any.unknown': 'Please use the new Docusaurus global trailingSlash config instead, and the sitemaps plugin will use it.',
     }),
 });
+function validateOptions({ validate, options, }) {
+    const validatedOptions = validate(PluginOptionSchema, options);
+    return validatedOptions;
+}
+exports.validateOptions = validateOptions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-sitemap",
-  "version": "2.0.0-beta.17",
+  "version": "2.0.0-beta.18",
   "description": "Simple sitemap generation plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-sitemap.d.ts",
@@ -18,16 +18,16 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.17",
-    "@docusaurus/utils": "2.0.0-beta.17",
-    "@docusaurus/utils-common": "2.0.0-beta.17",
-    "@docusaurus/utils-validation": "2.0.0-beta.17",
+    "@docusaurus/core": "2.0.0-beta.18",
+    "@docusaurus/utils": "2.0.0-beta.18",
+    "@docusaurus/utils-common": "2.0.0-beta.18",
+    "@docusaurus/utils-validation": "2.0.0-beta.18",
     "fs-extra": "^10.0.1",
     "sitemap": "^7.1.1",
     "tslib": "^2.3.1"
   },
   "devDependencies": {
-    "@docusaurus/types": "2.0.0-beta.17"
+    "@docusaurus/types": "2.0.0-beta.18"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
@@ -36,5 +36,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "0032c0b0480083227af2e1b4da2d3ee6ce992403"
+  "gitHead": "1a945d06993d53376e61bed2c942799fe07dc336"
 }

package/src/index.ts

@@ -9,23 +9,16 @@ import fs from 'fs-extra';
 import path from 'path';
 import type {Options} from '@docusaurus/plugin-sitemap';
 import createSitemap from './createSitemap';
-import type {
-  LoadContext,
-  Props,
-  OptionValidationContext,
-  ValidationResult,
-  Plugin,
-} from '@docusaurus/types';
-import {PluginOptionSchema} from './pluginOptionSchema';
+import type {LoadContext, Plugin} from '@docusaurus/types';
 
 export default function pluginSitemap(
-  _context: LoadContext,
+  context: LoadContext,
   options: Options,
 ): Plugin<void> {
   return {
     name: 'docusaurus-plugin-sitemap',
 
-    async postBuild({siteConfig, routesPaths, outDir}: Props) {
+    async postBuild({siteConfig, routesPaths, outDir}) {
       if (siteConfig.noIndex) {
         return;
       }
@@ -47,10 +40,4 @@ export default function pluginSitemap(
   };
 }
 
-export function validateOptions({
-  validate,
-  options,
-}: OptionValidationContext<Options>): ValidationResult<Options> {
-  const validatedOptions = validate(PluginOptionSchema, options);
-  return validatedOptions;
-}
+export {validateOptions} from './options';

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

@@ -8,14 +8,14 @@
 import {Joi} from '@docusaurus/utils-validation';
 import {EnumChangefreq} from 'sitemap';
 import type {Options} from '@docusaurus/plugin-sitemap';
+import type {OptionValidationContext} from '@docusaurus/types';
 
-export const DEFAULT_OPTIONS: Required<Options> = {
+export const DEFAULT_OPTIONS: Options = {
   changefreq: EnumChangefreq.WEEKLY,
   priority: 0.5,
 };
 
-export const PluginOptionSchema = Joi.object({
-  // TODO temporary (@alpha-71)
+const PluginOptionSchema = Joi.object({
   cacheTime: Joi.forbidden().messages({
     'any.unknown':
       'Option `cacheTime` in sitemap config is deprecated. Please remove it.',
@@ -29,3 +29,11 @@ export const PluginOptionSchema = Joi.object({
       'Please use the new Docusaurus global trailingSlash config instead, and the sitemaps plugin will use it.',
   }),
 });
+
+export function validateOptions({
+  validate,
+  options,
+}: OptionValidationContext<Options, Options>): Options {
+  const validatedOptions = validate(PluginOptionSchema, options);
+  return validatedOptions;
+}

package/src/plugin-sitemap.d.ts

@@ -8,6 +8,9 @@
 import type {EnumChangefreq} from 'sitemap';
 
 export type Options = {
+  id?: string;
+  /** @see https://www.sitemaps.org/protocol.html#xmlTagDefinitions */
   changefreq?: EnumChangefreq;
+  /** @see https://www.sitemaps.org/protocol.html#xmlTagDefinitions */
   priority?: number;
 };