@docusaurus/plugin-sitemap 2.0.0-beta.ff31de0ff → 2.0.0-rc.1

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 { Joi } from '@docusaurus/utils-validation';
-import { PluginOptions } from './types';
-export declare const DEFAULT_OPTIONS: Required<PluginOptions>;
-export declare const PluginOptionSchema: Joi.ObjectSchema<any>;

package/lib/types.d.ts

@@ -1,12 +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 { EnumChangefreq } from 'sitemap';
-export interface PluginOptions {
-    changefreq?: EnumChangefreq;
-    priority?: number;
-    trailingSlash?: boolean;
-}

package/lib/types.js

@@ -1,8 +0,0 @@
-"use strict";
-/**
- * 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });

package/src/__tests__/createSitemap.test.ts

@@ -1,66 +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 createSitemap from '../createSitemap';
-import {DocusaurusConfig} from '@docusaurus/types';
-
-describe('createSitemap', () => {
-  test('simple site', async () => {
-    const sitemap = await createSitemap(
-      {
-        url: 'https://example.com',
-      } as DocusaurusConfig,
-      ['/', '/test'],
-      {
-        changefreq: 'daily',
-        priority: 0.7,
-        trailingSlash: false,
-      },
-    );
-    expect(sitemap).toContain(
-      `<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:news="http://www.google.com/schemas/sitemap-news/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1" xmlns:video="http://www.google.com/schemas/sitemap-video/1.1">`,
-    );
-  });
-
-  test('empty site', () => {
-    return expect(async () => {
-      await createSitemap({} as DocusaurusConfig, [], {});
-    }).rejects.toThrow('url in docusaurus.config.js cannot be empty/undefined');
-  });
-
-  test('exclusion of 404 page', async () => {
-    const sitemap = await createSitemap(
-      {
-        url: 'https://example.com',
-      } as DocusaurusConfig,
-      ['/', '/404.html', '/mypage'],
-      {
-        changefreq: 'daily',
-        priority: 0.7,
-        trailingSlash: false,
-      },
-    );
-    expect(sitemap).not.toContain('404');
-  });
-
-  test('add trailing slash', async () => {
-    const sitemap = await createSitemap(
-      {
-        url: 'https://example.com',
-      } as DocusaurusConfig,
-      ['/', '/test'],
-      {
-        changefreq: 'daily',
-        priority: 0.7,
-        trailingSlash: true,
-      },
-    );
-
-    expect(sitemap).toContain('<loc>https://example.com/test/</loc>');
-    expect(sitemap).not.toContain('<loc>https://example.com/test</loc>');
-  });
-});

package/src/__tests__/pluginOptionSchema.test.ts

@@ -1,56 +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 {PluginOptionSchema, DEFAULT_OPTIONS} from '../pluginOptionSchema';
-
-function normalizePluginOptions(options) {
-  const {value, error} = PluginOptionSchema.validate(options, {
-    convert: false,
-  });
-  if (error) {
-    throw error;
-  } else {
-    return value;
-  }
-}
-
-describe('normalizeSitemapPluginOptions', () => {
-  test('should return default values for empty user options', async () => {
-    const {value} = await PluginOptionSchema.validate({});
-    expect(value).toEqual(DEFAULT_OPTIONS);
-  });
-
-  test('should accept correctly defined user options', async () => {
-    const userOptions = {
-      changefreq: 'yearly',
-      priority: 0.9,
-      trailingSlash: false,
-    };
-    const {value} = await PluginOptionSchema.validate(userOptions);
-    expect(value).toEqual(userOptions);
-  });
-
-  test('should reject out-of-range priority inputs', () => {
-    expect(() => {
-      normalizePluginOptions({
-        priority: 2,
-      });
-    }).toThrowErrorMatchingInlineSnapshot(
-      `"\\"priority\\" must be less than or equal to 1"`,
-    );
-  });
-
-  test('should reject bad changefreq inputs', () => {
-    expect(() => {
-      normalizePluginOptions({
-        changefreq: 'annually',
-      });
-    }).toThrowErrorMatchingInlineSnapshot(
-      `"\\"changefreq\\" must be one of [daily, monthly, always, hourly, weekly, yearly, never]"`,
-    );
-  });
-});

package/src/pluginOptionSchema.ts

@@ -1,29 +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 {Joi} from '@docusaurus/utils-validation';
-import {EnumChangefreq} from 'sitemap';
-import {PluginOptions} from './types';
-
-export const DEFAULT_OPTIONS: Required<PluginOptions> = {
-  changefreq: EnumChangefreq.WEEKLY,
-  priority: 0.5,
-  trailingSlash: false,
-};
-
-export const PluginOptionSchema = Joi.object({
-  // TODO temporary (@alpha-71)
-  cacheTime: Joi.forbidden().messages({
-    'any.unknown':
-      'Option `cacheTime` in sitemap config is deprecated. Please remove it.',
-  }),
-  changefreq: Joi.string()
-    .valid(...Object.values(EnumChangefreq))
-    .default(DEFAULT_OPTIONS.changefreq),
-  priority: Joi.number().min(0).max(1).default(DEFAULT_OPTIONS.priority),
-  trailingSlash: Joi.bool().default(false),
-});

package/src/types.ts

@@ -1,14 +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 {EnumChangefreq} from 'sitemap';
-
-export interface PluginOptions {
-  changefreq?: EnumChangefreq;
-  priority?: number;
-  trailingSlash?: boolean;
-}

package/tsconfig.json

@@ -1,9 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "incremental": true,
-    "tsBuildInfoFile": "./lib/.tsbuildinfo",
-    "rootDir": "src",
-    "outDir": "lib"
-  }
-}