@docusaurus/plugin-sitemap 0.0.0-4728 → 0.0.0-4730

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/index.d.ts CHANGED
@@ -6,5 +6,5 @@
6
6
  */
7
7
  import type { Options } from '@docusaurus/plugin-sitemap';
8
8
  import type { LoadContext, OptionValidationContext, ValidationResult, Plugin } from '@docusaurus/types';
9
- export default function pluginSitemap(_context: LoadContext, options: Options): Plugin<void>;
9
+ export default function pluginSitemap(context: LoadContext, options: Options): Plugin<void>;
10
10
  export declare function validateOptions({ validate, options, }: OptionValidationContext<Options>): ValidationResult<Options>;
package/lib/index.js CHANGED
@@ -12,7 +12,7 @@ const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
12
12
  const path_1 = tslib_1.__importDefault(require("path"));
13
13
  const createSitemap_1 = tslib_1.__importDefault(require("./createSitemap"));
14
14
  const pluginOptionSchema_1 = require("./pluginOptionSchema");
15
- function pluginSitemap(_context, options) {
15
+ function pluginSitemap(context, options) {
16
16
  return {
17
17
  name: 'docusaurus-plugin-sitemap',
18
18
  async postBuild({ siteConfig, routesPaths, outDir }) {
@@ -14,7 +14,6 @@ exports.DEFAULT_OPTIONS = {
14
14
  priority: 0.5,
15
15
  };
16
16
  exports.PluginOptionSchema = utils_validation_1.Joi.object({
17
- // TODO temporary (@alpha-71)
18
17
  cacheTime: utils_validation_1.Joi.forbidden().messages({
19
18
  'any.unknown': 'Option `cacheTime` in sitemap config is deprecated. Please remove it.',
20
19
  }),
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@docusaurus/plugin-sitemap",
3
- "version": "0.0.0-4728",
3
+ "version": "0.0.0-4730",
4
4
  "description": "Simple sitemap generation plugin for Docusaurus.",
5
5
  "main": "lib/index.js",
6
6
  "types": "src/plugin-sitemap.d.ts",
@@ -18,16 +18,16 @@
18
18
  },
19
19
  "license": "MIT",
20
20
  "dependencies": {
21
- "@docusaurus/core": "0.0.0-4728",
22
- "@docusaurus/utils": "0.0.0-4728",
23
- "@docusaurus/utils-common": "0.0.0-4728",
24
- "@docusaurus/utils-validation": "0.0.0-4728",
21
+ "@docusaurus/core": "0.0.0-4730",
22
+ "@docusaurus/utils": "0.0.0-4730",
23
+ "@docusaurus/utils-common": "0.0.0-4730",
24
+ "@docusaurus/utils-validation": "0.0.0-4730",
25
25
  "fs-extra": "^10.0.1",
26
26
  "sitemap": "^7.1.1",
27
27
  "tslib": "^2.3.1"
28
28
  },
29
29
  "devDependencies": {
30
- "@docusaurus/types": "0.0.0-4728"
30
+ "@docusaurus/types": "0.0.0-4730"
31
31
  },
32
32
  "peerDependencies": {
33
33
  "react": "^16.8.4 || ^17.0.0",
@@ -36,5 +36,5 @@
36
36
  "engines": {
37
37
  "node": ">=14"
38
38
  },
39
- "gitHead": "517f5b73eaacc1002a973074567a321b469868fe"
39
+ "gitHead": "65b87b9d9f21c7904877ed1fade98e0b9fb61b56"
40
40
  }
package/src/index.ts CHANGED
@@ -19,7 +19,7 @@ import type {
19
19
  import {PluginOptionSchema} from './pluginOptionSchema';
20
20
 
21
21
  export default function pluginSitemap(
22
- _context: LoadContext,
22
+ context: LoadContext,
23
23
  options: Options,
24
24
  ): Plugin<void> {
25
25
  return {
@@ -8,6 +8,8 @@
8
8
  import type {EnumChangefreq} from 'sitemap';
9
9
 
10
10
  export type Options = {
11
+ /** @see https://www.sitemaps.org/protocol.html#xmlTagDefinitions */
11
12
  changefreq?: EnumChangefreq;
13
+ /** @see https://www.sitemaps.org/protocol.html#xmlTagDefinitions */
12
14
  priority?: number;
13
15
  };
@@ -15,7 +15,6 @@ export const DEFAULT_OPTIONS: Required<Options> = {
15
15
  };
16
16
 
17
17
  export const PluginOptionSchema = Joi.object({
18
- // TODO temporary (@alpha-71)
19
18
  cacheTime: Joi.forbidden().messages({
20
19
  'any.unknown':
21
20
  'Option `cacheTime` in sitemap config is deprecated. Please remove it.',