@docusaurus/utils-validation 2.0.0-beta.fbdeefcac → 2.0.0-rc.1

package/lib/Joi.d.ts

@@ -5,3 +5,4 @@
  * LICENSE file in the root directory of this source tree.
  */
 export { default } from 'joi';
+//# sourceMappingURL=Joi.d.ts.map

package/lib/Joi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Joi.d.ts","sourceRoot":"","sources":["../src/Joi.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,OAAO,EAAC,MAAM,KAAK,CAAC"}

package/lib/Joi.js

@@ -9,3 +9,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = void 0;
 var joi_1 = require("joi");
 Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(joi_1).default; } });
+//# sourceMappingURL=Joi.js.map

package/lib/Joi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Joi.js","sourceRoot":"","sources":["../src/Joi.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,2BAA4B;AAApB,+GAAA,OAAO,OAAA"}

package/lib/JoiFrontMatter.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 './Joi';
+/**
+ * Enhance the default `Joi.string()` type so that it can convert number to
+ * strings. If user use front matter "tag: 2021", we shouldn't need to ask her
+ * to write "tag: '2021'". Also yaml tries to convert patterns like "2019-01-01"
+ * to dates automatically.
+ *
+ * @see https://github.com/facebook/docusaurus/issues/4642
+ * @see https://github.com/sideway/joi/issues/1442#issuecomment-823997884
+ */
+export declare const JoiFrontMatter: Joi.Root;
+//# sourceMappingURL=JoiFrontMatter.d.ts.map

package/lib/JoiFrontMatter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"JoiFrontMatter.d.ts","sourceRoot":"","sources":["../src/JoiFrontMatter.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,GAAG,MAAM,OAAO,CAAC;AAcxB;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,UAAiD,CAAC"}

package/lib/JoiFrontMatter.js

@@ -0,0 +1,33 @@
+"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 });
+exports.JoiFrontMatter = void 0;
+const tslib_1 = require("tslib");
+const Joi_1 = tslib_1.__importDefault(require("./Joi"));
+const JoiFrontMatterString = {
+    type: 'string',
+    base: Joi_1.default.string(),
+    // Fix Yaml that tries to auto-convert many things to string out of the box
+    prepare: (value) => {
+        if (typeof value === 'number' || value instanceof Date) {
+            return { value: value.toString() };
+        }
+        return { value };
+    },
+};
+/**
+ * Enhance the default `Joi.string()` type so that it can convert number to
+ * strings. If user use front matter "tag: 2021", we shouldn't need to ask her
+ * to write "tag: '2021'". Also yaml tries to convert patterns like "2019-01-01"
+ * to dates automatically.
+ *
+ * @see https://github.com/facebook/docusaurus/issues/4642
+ * @see https://github.com/sideway/joi/issues/1442#issuecomment-823997884
+ */
+exports.JoiFrontMatter = Joi_1.default.extend(JoiFrontMatterString);
+//# sourceMappingURL=JoiFrontMatter.js.map

package/lib/JoiFrontMatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JoiFrontMatter.js","sourceRoot":"","sources":["../src/JoiFrontMatter.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,wDAAwB;AAExB,MAAM,oBAAoB,GAAkB;IAC1C,IAAI,EAAE,QAAQ;IACd,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE;IAClB,2EAA2E;IAC3E,OAAO,EAAE,CAAC,KAAc,EAAE,EAAE;QAC1B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,YAAY,IAAI,EAAE;YACtD,OAAO,EAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE,EAAC,CAAC;SAClC;QACD,OAAO,EAAC,KAAK,EAAC,CAAC;IACjB,CAAC;CACF,CAAC;AAEF;;;;;;;;GAQG;AACU,QAAA,cAAc,GAAG,aAAG,CAAC,MAAM,CAAC,oBAAoB,CAAe,CAAC"}

package/lib/index.d.ts

@@ -5,5 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 export { default as Joi } from './Joi';
-export * from './validationUtils';
-export * from './validationSchemas';
+export { JoiFrontMatter } from './JoiFrontMatter';
+export { printWarning, normalizePluginOptions, normalizeThemeConfig, validateFrontMatter, } from './validationUtils';
+export { PluginIdSchema, RemarkPluginsSchema, RehypePluginsSchema, AdmonitionsSchema, URISchema, PathnameSchema, FrontMatterTagsSchema, FrontMatterTOCHeadingLevels, } from './validationSchemas';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAC,OAAO,IAAI,GAAG,EAAC,MAAM,OAAO,CAAC;AACrC,OAAO,EAAC,cAAc,EAAC,MAAM,kBAAkB,CAAC;AAEhD,OAAO,EACL,YAAY,EACZ,sBAAsB,EACtB,oBAAoB,EACpB,mBAAmB,GACpB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,mBAAmB,EACnB,iBAAiB,EACjB,SAAS,EACT,cAAc,EACd,qBAAqB,EACrB,2BAA2B,GAC5B,MAAM,qBAAqB,CAAC"}

package/lib/index.js

@@ -6,10 +6,24 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Joi = void 0;
-const tslib_1 = require("tslib");
+exports.FrontMatterTOCHeadingLevels = exports.FrontMatterTagsSchema = exports.PathnameSchema = exports.URISchema = exports.AdmonitionsSchema = exports.RehypePluginsSchema = exports.RemarkPluginsSchema = exports.PluginIdSchema = exports.validateFrontMatter = exports.normalizeThemeConfig = exports.normalizePluginOptions = exports.printWarning = exports.JoiFrontMatter = exports.Joi = void 0;
 // /!\ don't remove this export, as we recommend plugin authors to use it
 var Joi_1 = require("./Joi");
-Object.defineProperty(exports, "Joi", { enumerable: true, get: function () { return tslib_1.__importDefault(Joi_1).default; } });
-tslib_1.__exportStar(require("./validationUtils"), exports);
-tslib_1.__exportStar(require("./validationSchemas"), exports);
+Object.defineProperty(exports, "Joi", { enumerable: true, get: function () { return __importDefault(Joi_1).default; } });
+var JoiFrontMatter_1 = require("./JoiFrontMatter");
+Object.defineProperty(exports, "JoiFrontMatter", { enumerable: true, get: function () { return JoiFrontMatter_1.JoiFrontMatter; } });
+var validationUtils_1 = require("./validationUtils");
+Object.defineProperty(exports, "printWarning", { enumerable: true, get: function () { return validationUtils_1.printWarning; } });
+Object.defineProperty(exports, "normalizePluginOptions", { enumerable: true, get: function () { return validationUtils_1.normalizePluginOptions; } });
+Object.defineProperty(exports, "normalizeThemeConfig", { enumerable: true, get: function () { return validationUtils_1.normalizeThemeConfig; } });
+Object.defineProperty(exports, "validateFrontMatter", { enumerable: true, get: function () { return validationUtils_1.validateFrontMatter; } });
+var validationSchemas_1 = require("./validationSchemas");
+Object.defineProperty(exports, "PluginIdSchema", { enumerable: true, get: function () { return validationSchemas_1.PluginIdSchema; } });
+Object.defineProperty(exports, "RemarkPluginsSchema", { enumerable: true, get: function () { return validationSchemas_1.RemarkPluginsSchema; } });
+Object.defineProperty(exports, "RehypePluginsSchema", { enumerable: true, get: function () { return validationSchemas_1.RehypePluginsSchema; } });
+Object.defineProperty(exports, "AdmonitionsSchema", { enumerable: true, get: function () { return validationSchemas_1.AdmonitionsSchema; } });
+Object.defineProperty(exports, "URISchema", { enumerable: true, get: function () { return validationSchemas_1.URISchema; } });
+Object.defineProperty(exports, "PathnameSchema", { enumerable: true, get: function () { return validationSchemas_1.PathnameSchema; } });
+Object.defineProperty(exports, "FrontMatterTagsSchema", { enumerable: true, get: function () { return validationSchemas_1.FrontMatterTagsSchema; } });
+Object.defineProperty(exports, "FrontMatterTOCHeadingLevels", { enumerable: true, get: function () { return validationSchemas_1.FrontMatterTOCHeadingLevels; } });
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,yEAAyE;AACzE,6BAAqC;AAA7B,2GAAA,OAAO,OAAO;AACtB,mDAAgD;AAAxC,gHAAA,cAAc,OAAA;AAEtB,qDAK2B;AAJzB,+GAAA,YAAY,OAAA;AACZ,yHAAA,sBAAsB,OAAA;AACtB,uHAAA,oBAAoB,OAAA;AACpB,sHAAA,mBAAmB,OAAA;AAErB,yDAS6B;AAR3B,mHAAA,cAAc,OAAA;AACd,wHAAA,mBAAmB,OAAA;AACnB,wHAAA,mBAAmB,OAAA;AACnB,sHAAA,iBAAiB,OAAA;AACjB,8GAAA,SAAS,OAAA;AACT,mHAAA,cAAc,OAAA;AACd,0HAAA,qBAAqB,OAAA;AACrB,gIAAA,2BAA2B,OAAA"}

package/lib/validationSchemas.d.ts

@@ -8,6 +8,12 @@ import Joi from './Joi';
 export declare const PluginIdSchema: Joi.StringSchema;
 export declare const RemarkPluginsSchema: Joi.ArraySchema;
 export declare const RehypePluginsSchema: Joi.ArraySchema;
-export declare const AdmonitionsSchema: Joi.ObjectSchema<any>;
+export declare const AdmonitionsSchema: Joi.AlternativesSchema;
 export declare const URISchema: Joi.AlternativesSchema;
 export declare const PathnameSchema: Joi.StringSchema;
+export declare const FrontMatterTagsSchema: Joi.ArraySchema;
+export declare const FrontMatterTOCHeadingLevels: {
+    toc_min_heading_level: Joi.NumberSchema;
+    toc_max_heading_level: Joi.NumberSchema;
+};
+//# sourceMappingURL=validationSchemas.d.ts.map

package/lib/validationSchemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validationSchemas.d.ts","sourceRoot":"","sources":["../src/validationSchemas.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,GAAG,MAAM,OAAO,CAAC;AAGxB,eAAO,MAAM,cAAc,kBAKE,CAAC;AAe9B,eAAO,MAAM,mBAAmB,iBAAwB,CAAC;AACzD,eAAO,MAAM,mBAAmB,iBAAwB,CAAC;AAQzD,eAAO,MAAM,iBAAiB,wBAkB1B,CAAC;AAIL,eAAO,MAAM,SAAS,wBAgBpB,CAAC;AAEH,eAAO,MAAM,cAAc,kBASxB,CAAC;AAeJ,eAAO,MAAM,qBAAqB,iBAK9B,CAAC;AAEL,eAAO,MAAM,2BAA2B;;;CASvC,CAAC"}

package/lib/validationSchemas.js

@@ -1,50 +1,95 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PathnameSchema = exports.URISchema = exports.AdmonitionsSchema = exports.RehypePluginsSchema = exports.RemarkPluginsSchema = exports.PluginIdSchema = void 0;
-const tslib_1 = require("tslib");
 /**
  * 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.
  */
-const Joi_1 = tslib_1.__importDefault(require("./Joi"));
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FrontMatterTOCHeadingLevels = exports.FrontMatterTagsSchema = exports.PathnameSchema = exports.URISchema = exports.AdmonitionsSchema = exports.RehypePluginsSchema = exports.RemarkPluginsSchema = exports.PluginIdSchema = void 0;
+const tslib_1 = require("tslib");
 const utils_1 = require("@docusaurus/utils");
+const Joi_1 = tslib_1.__importDefault(require("./Joi"));
+const JoiFrontMatter_1 = require("./JoiFrontMatter");
 exports.PluginIdSchema = Joi_1.default.string()
-    .regex(/^[a-zA-Z_-]+$/)
-    // duplicate core constant, otherwise cyclic dependency is created :(
-    .default('default');
+    .regex(/^[\w-]+$/)
+    .message('Illegal plugin ID value "{#value}": it should only contain alphanumerics, underscores, and dashes.')
+    .default(utils_1.DEFAULT_PLUGIN_ID);
 const MarkdownPluginsSchema = Joi_1.default.array()
-    .items(Joi_1.default.array().ordered(Joi_1.default.function().required(), Joi_1.default.object().required()), Joi_1.default.function(), Joi_1.default.object())
+    .items(Joi_1.default.array().ordered(Joi_1.default.function().required(), Joi_1.default.any().required()), Joi_1.default.function(), Joi_1.default.object())
+    .messages({
+    'array.includes': `{#label} does not look like a valid MDX plugin config. A plugin config entry should be one of:
+- A tuple, like \`[require("rehype-katex"), \\{ strict: false \\}]\`, or
+- A simple module, like \`require("remark-math")\``,
+})
     .default([]);
 exports.RemarkPluginsSchema = MarkdownPluginsSchema;
 exports.RehypePluginsSchema = MarkdownPluginsSchema;
-exports.AdmonitionsSchema = Joi_1.default.object().default({});
+const LegacyAdmonitionConfigSchema = Joi_1.default.forbidden().messages({
+    'any.unknown': `The Docusaurus admonitions system has changed, and the option {#label} does not exist anymore.
+You now need to swizzle the admonitions component to provide UI customizations such as icons.
+Please refer to https://github.com/facebook/docusaurus/pull/7152 for detailed upgrade instructions.`,
+});
+exports.AdmonitionsSchema = JoiFrontMatter_1.JoiFrontMatter.alternatives()
+    .try(JoiFrontMatter_1.JoiFrontMatter.boolean().required(), JoiFrontMatter_1.JoiFrontMatter.object({
+    tag: JoiFrontMatter_1.JoiFrontMatter.string(),
+    keywords: JoiFrontMatter_1.JoiFrontMatter.array().items(JoiFrontMatter_1.JoiFrontMatter.string().required()),
+    // TODO Remove before 2023
+    customTypes: LegacyAdmonitionConfigSchema,
+    icons: LegacyAdmonitionConfigSchema,
+    infima: LegacyAdmonitionConfigSchema,
+}).required())
+    .default(true)
+    .messages({
+    'alternatives.types': '{{#label}} does not look like a valid admonitions config',
+});
 // TODO how can we make this emit a custom error message :'(
 //  Joi is such a pain, good luck to annoying trying to improve this
 exports.URISchema = Joi_1.default.alternatives(Joi_1.default.string().uri({ allowRelative: true }), 
-// This custom validation logic is required notably because Joi does not accept paths like /a/b/c ...
+// This custom validation logic is required notably because Joi does not
+// accept paths like /a/b/c ...
 Joi_1.default.custom((val, helpers) => {
     try {
-        const url = new URL(val);
-        if (url) {
-            return val;
-        }
-        else {
-            return helpers.error('any.invalid');
-        }
+        // eslint-disable-next-line no-new
+        new URL(String(val));
+        return val;
     }
     catch {
         return helpers.error('any.invalid');
     }
-}));
+})).messages({
+    'alternatives.match': "{{#label}} does not look like a valid url (value='{{.value}}')",
+});
 exports.PathnameSchema = Joi_1.default.string()
     .custom((val) => {
-    if (!utils_1.isValidPathname(val)) {
+    if (!(0, utils_1.isValidPathname)(val)) {
         throw new Error();
     }
-    else {
-        return val;
-    }
+    return val;
 })
     .message('{{#label}} is not a valid pathname. Pathname should start with slash and not contain any domain or query string.');
+const FrontMatterTagSchema = JoiFrontMatter_1.JoiFrontMatter.alternatives()
+    .try(JoiFrontMatter_1.JoiFrontMatter.string().required(), JoiFrontMatter_1.JoiFrontMatter.object({
+    label: JoiFrontMatter_1.JoiFrontMatter.string().required(),
+    permalink: JoiFrontMatter_1.JoiFrontMatter.string().required(),
+}).required())
+    .messages({
+    'alternatives.match': '{{#label}} does not look like a valid tag',
+    'alternatives.types': '{{#label}} does not look like a valid tag',
+});
+exports.FrontMatterTagsSchema = JoiFrontMatter_1.JoiFrontMatter.array()
+    .items(FrontMatterTagSchema)
+    .messages({
+    'array.base': '{{#label}} does not look like a valid front matter Yaml array.',
+});
+exports.FrontMatterTOCHeadingLevels = {
+    toc_min_heading_level: JoiFrontMatter_1.JoiFrontMatter.number().when('toc_max_heading_level', {
+        is: JoiFrontMatter_1.JoiFrontMatter.exist(),
+        then: JoiFrontMatter_1.JoiFrontMatter.number()
+            .min(2)
+            .max(JoiFrontMatter_1.JoiFrontMatter.ref('toc_max_heading_level')),
+        otherwise: JoiFrontMatter_1.JoiFrontMatter.number().min(2).max(6),
+    }),
+    toc_max_heading_level: JoiFrontMatter_1.JoiFrontMatter.number().min(2).max(6),
+};
+//# sourceMappingURL=validationSchemas.js.map

package/lib/validationSchemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validationSchemas.js","sourceRoot":"","sources":["../src/validationSchemas.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,6CAA+E;AAC/E,wDAAwB;AACxB,qDAAgD;AAEnC,QAAA,cAAc,GAAG,aAAG,CAAC,MAAM,EAAE;KACvC,KAAK,CAAC,UAAU,CAAC;KACjB,OAAO,CACN,oGAAoG,CACrG;KACA,OAAO,CAAC,yBAAiB,CAAC,CAAC;AAE9B,MAAM,qBAAqB,GAAG,aAAG,CAAC,KAAK,EAAE;KACtC,KAAK,CACJ,aAAG,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,aAAG,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,EAAE,aAAG,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,EACpE,aAAG,CAAC,QAAQ,EAAE,EACd,aAAG,CAAC,MAAM,EAAE,CACb;KACA,QAAQ,CAAC;IACR,gBAAgB,EAAE;;mDAE6B;CAChD,CAAC;KACD,OAAO,CAAC,EAAE,CAAC,CAAC;AAEF,QAAA,mBAAmB,GAAG,qBAAqB,CAAC;AAC5C,QAAA,mBAAmB,GAAG,qBAAqB,CAAC;AAEzD,MAAM,4BAA4B,GAAG,aAAG,CAAC,SAAS,EAAE,CAAC,QAAQ,CAAC;IAC5D,aAAa,EAAE;;oGAEmF;CACnG,CAAC,CAAC;AAEU,QAAA,iBAAiB,GAAG,+BAAc,CAAC,YAAY,EAAE;KAC3D,GAAG,CACF,+BAAc,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EACnC,+BAAc,CAAC,MAAM,CAAC;IACpB,GAAG,EAAE,+BAAc,CAAC,MAAM,EAAE;IAC5B,QAAQ,EAAE,+BAAc,CAAC,KAAK,EAAE,CAAC,KAAK,CACpC,+BAAc,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CACnC;IACD,0BAA0B;IAC1B,WAAW,EAAE,4BAA4B;IACzC,KAAK,EAAE,4BAA4B;IACnC,MAAM,EAAE,4BAA4B;CACrC,CAAC,CAAC,QAAQ,EAAE,CACd;KACA,OAAO,CAAC,IAAI,CAAC;KACb,QAAQ,CAAC;IACR,oBAAoB,EAClB,0DAA0D;CAC7D,CAAC,CAAC;AAEL,4DAA4D;AAC5D,oEAAoE;AACvD,QAAA,SAAS,GAAG,aAAG,CAAC,YAAY,CACvC,aAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAC,aAAa,EAAE,IAAI,EAAC,CAAC;AACvC,wEAAwE;AACxE,+BAA+B;AAC/B,aAAG,CAAC,MAAM,CAAC,CAAC,GAAY,EAAE,OAAO,EAAE,EAAE;IACnC,IAAI;QACF,kCAAkC;QAClC,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;QACrB,OAAO,GAAG,CAAC;KACZ;IAAC,MAAM;QACN,OAAO,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;KACrC;AACH,CAAC,CAAC,CACH,CAAC,QAAQ,CAAC;IACT,oBAAoB,EAClB,gEAAgE;CACnE,CAAC,CAAC;AAEU,QAAA,cAAc,GAAG,aAAG,CAAC,MAAM,EAAE;KACvC,MAAM,CAAC,CAAC,GAAW,EAAE,EAAE;IACtB,IAAI,CAAC,IAAA,uBAAe,EAAC,GAAG,CAAC,EAAE;QACzB,MAAM,IAAI,KAAK,EAAE,CAAC;KACnB;IACD,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;KACD,OAAO,CACN,kHAAkH,CACnH,CAAC;AAEJ,MAAM,oBAAoB,GAAG,+BAAc,CAAC,YAAY,EAAE;KACvD,GAAG,CACF,+BAAc,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,EAClC,+BAAc,CAAC,MAAM,CAAM;IACzB,KAAK,EAAE,+BAAc,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,SAAS,EAAE,+BAAc,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC9C,CAAC,CAAC,QAAQ,EAAE,CACd;KACA,QAAQ,CAAC;IACR,oBAAoB,EAAE,2CAA2C;IACjE,oBAAoB,EAAE,2CAA2C;CAClE,CAAC,CAAC;AAEQ,QAAA,qBAAqB,GAAG,+BAAc,CAAC,KAAK,EAAE;KACxD,KAAK,CAAC,oBAAoB,CAAC;KAC3B,QAAQ,CAAC;IACR,YAAY,EACV,gEAAgE;CACnE,CAAC,CAAC;AAEQ,QAAA,2BAA2B,GAAG;IACzC,qBAAqB,EAAE,+BAAc,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,uBAAuB,EAAE;QAC3E,EAAE,EAAE,+BAAc,CAAC,KAAK,EAAE;QAC1B,IAAI,EAAE,+BAAc,CAAC,MAAM,EAAE;aAC1B,GAAG,CAAC,CAAC,CAAC;aACN,GAAG,CAAC,+BAAc,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;QACnD,SAAS,EAAE,+BAAc,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;KACjD,CAAC;IACF,qBAAqB,EAAE,+BAAc,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;CAC7D,CAAC"}

package/lib/validationUtils.d.ts

@@ -4,13 +4,26 @@
  * 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 './Joi';
-export declare const isValidationDisabledEscapeHatch: boolean;
-export declare const logValidationBugReportHint: () => void;
+import type Joi from './Joi';
+/** Print warnings returned from Joi validation. */
 export declare function printWarning(warning?: Joi.ValidationError): void;
+/**
+ * The callback that should be used to validate plugin options. Handles plugin
+ * IDs on a generic level: no matter what the schema declares, this callback
+ * would require a string ID or default to "default".
+ */
 export declare function normalizePluginOptions<T extends {
     id?: string;
-}>(schema: Joi.ObjectSchema<T>, options: Partial<T>): T;
+}>(schema: Joi.ObjectSchema<T>, options?: Partial<T>): T;
+/**
+ * The callback that should be used to validate theme config. No matter what the
+ * schema declares, this callback would allow unknown attributes.
+ */
 export declare function normalizeThemeConfig<T>(schema: Joi.ObjectSchema<T>, themeConfig: Partial<T>): T;
-export declare const JoiFrontMatter: typeof Joi;
-export declare function validateFrontMatter<T>(frontMatter: Record<string, unknown>, schema: Joi.ObjectSchema<T>): T;
+/**
+ * Validate front matter with better error message
+ */
+export declare function validateFrontMatter<T>(frontMatter: {
+    [key: string]: unknown;
+}, schema: Joi.ObjectSchema<T>): T;
+//# sourceMappingURL=validationUtils.d.ts.map

package/lib/validationUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validationUtils.d.ts","sourceRoot":"","sources":["../src/validationUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAE7B,mDAAmD;AACnD,wBAAgB,YAAY,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,eAAe,GAAG,IAAI,CAOhE;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS;IAAC,EAAE,CAAC,EAAE,MAAM,CAAA;CAAC,EAC5D,MAAM,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAE3B,OAAO,GAAE,OAAO,CAAC,CAAC,CAAM,GACvB,CAAC,CAiBH;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EACpC,MAAM,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAC3B,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC,GACtB,CAAC,CAgBH;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,EACnC,WAAW,EAAE;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAC,EACrC,MAAM,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,GAC1B,CAAC,CAuBH"}

package/lib/validationUtils.js

@@ -1,42 +1,34 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateFrontMatter = exports.JoiFrontMatter = exports.normalizeThemeConfig = exports.normalizePluginOptions = exports.printWarning = exports.logValidationBugReportHint = exports.isValidationDisabledEscapeHatch = void 0;
-const tslib_1 = require("tslib");
 /**
  * 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.
  */
-const Joi_1 = tslib_1.__importDefault(require("./Joi"));
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateFrontMatter = exports.normalizeThemeConfig = exports.normalizePluginOptions = exports.printWarning = void 0;
+const tslib_1 = require("tslib");
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
 const validationSchemas_1 = require("./validationSchemas");
-// TODO temporary escape hatch for alpha-60: to be removed soon
-// Our validation schemas might be buggy at first
-// will permit users to bypass validation until we fix all validation errors
-// see for example: https://github.com/facebook/docusaurus/pull/3120
-// Undocumented on purpose, as we don't want users to keep using it over time
-// Maybe we'll make this escape hatch official some day, with a better api?
-exports.isValidationDisabledEscapeHatch = process.env.DISABLE_DOCUSAURUS_VALIDATION === 'true';
-if (exports.isValidationDisabledEscapeHatch) {
-    console.error(chalk_1.default.red('You should avoid using DISABLE_DOCUSAURUS_VALIDATION escape hatch, this will be removed.'));
-}
-const logValidationBugReportHint = () => {
-    console.log(`\n${chalk_1.default.red('A validation error occurred.')}${chalk_1.default.cyanBright('\nThe validation system was added recently to Docusaurus as an attempt to avoid user configuration errors.' +
-        '\nWe may have made some mistakes.' +
-        '\nIf you think your configuration is valid and should keep working, please open a bug report.')}\n`);
-};
-exports.logValidationBugReportHint = logValidationBugReportHint;
+/** Print warnings returned from Joi validation. */
 function printWarning(warning) {
     if (warning) {
         const warningMessages = warning.details
             .map(({ message }) => message)
             .join('\n');
-        console.log(chalk_1.default.yellow(warningMessages));
+        logger_1.default.warn(warningMessages);
     }
 }
 exports.printWarning = printWarning;
-function normalizePluginOptions(schema, options) {
+/**
+ * The callback that should be used to validate plugin options. Handles plugin
+ * IDs on a generic level: no matter what the schema declares, this callback
+ * would require a string ID or default to "default".
+ */
+function normalizePluginOptions(schema, 
+// This allows us to automatically normalize undefined to { id: "default" }
+options = {}) {
     // All plugins can be provided an "id" option (multi-instance support)
     // we add schema validation automatically
     const finalSchema = schema.append({
@@ -47,20 +39,17 @@ function normalizePluginOptions(schema, options) {
     });
     printWarning(warning);
     if (error) {
-        exports.logValidationBugReportHint();
-        if (exports.isValidationDisabledEscapeHatch) {
-            console.error(error);
-            return options;
-        }
-        else {
-            throw error;
-        }
+        throw error;
     }
     return value;
 }
 exports.normalizePluginOptions = normalizePluginOptions;
+/**
+ * The callback that should be used to validate theme config. No matter what the
+ * schema declares, this callback would allow unknown attributes.
+ */
 function normalizeThemeConfig(schema, themeConfig) {
-    // A theme should only validate his "slice" of the full themeConfig,
+    // A theme should only validate its "slice" of the full themeConfig,
     // not the whole object, so we allow unknown attributes
     // otherwise one theme would fail validating the data of another theme
     const finalSchema = schema.unknown();
@@ -69,35 +58,14 @@ function normalizeThemeConfig(schema, themeConfig) {
     });
     printWarning(warning);
     if (error) {
-        exports.logValidationBugReportHint();
-        if (exports.isValidationDisabledEscapeHatch) {
-            console.error(error);
-            return themeConfig;
-        }
-        else {
-            throw error;
-        }
+        throw error;
     }
     return value;
 }
 exports.normalizeThemeConfig = normalizeThemeConfig;
-// Enhance the default Joi.string() type so that it can convert number to strings
-// If user use frontmatter "tag: 2021", we shouldn't need to ask the user to write "tag: '2021'"
-// Also yaml tries to convert patterns like "2019-01-01" to dates automatically
-// see https://github.com/facebook/docusaurus/issues/4642
-// see https://github.com/sideway/joi/issues/1442#issuecomment-823997884
-const JoiFrontMatterString = {
-    type: 'string',
-    base: Joi_1.default.string(),
-    // Fix Yaml that tries to auto-convert many things to string out of the box
-    prepare: (value) => {
-        if (typeof value === 'number' || value instanceof Date) {
-            return { value: value.toString() };
-        }
-        return { value };
-    },
-};
-exports.JoiFrontMatter = Joi_1.default.extend(JoiFrontMatterString);
+/**
+ * Validate front matter with better error message
+ */
 function validateFrontMatter(frontMatter, schema) {
     const { value, error, warning } = schema.validate(frontMatter, {
         convert: true,
@@ -106,16 +74,17 @@ function validateFrontMatter(frontMatter, schema) {
     });
     printWarning(warning);
     if (error) {
-        const frontMatterString = JSON.stringify(frontMatter, null, 2);
         const errorDetails = error.details;
         const invalidFields = errorDetails.map(({ path }) => path).join(', ');
-        const errorMessages = errorDetails
-            .map(({ message }) => ` - ${message}`)
-            .join('\n');
-        exports.logValidationBugReportHint();
-        console.error(chalk_1.default.red(`The following frontmatter:\n${chalk_1.default.yellow(frontMatterString)}\ncontains invalid values for field(s): ${invalidFields}.\n${errorMessages}\n`));
+        logger_1.default.error `The following front matter:
+---
+${js_yaml_1.default.dump(frontMatter)}---
+contains invalid values for field(s): code=${invalidFields}.
+${errorDetails.map(({ message }) => message)}
+`;
         throw error;
     }
     return value;
 }
 exports.validateFrontMatter = validateFrontMatter;
+//# sourceMappingURL=validationUtils.js.map

package/lib/validationUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validationUtils.js","sourceRoot":"","sources":["../src/validationUtils.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,wEAAwC;AACxC,8DAA2B;AAC3B,2DAAmD;AAGnD,mDAAmD;AACnD,SAAgB,YAAY,CAAC,OAA6B;IACxD,IAAI,OAAO,EAAE;QACX,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO;aACpC,GAAG,CAAC,CAAC,EAAC,OAAO,EAAC,EAAE,EAAE,CAAC,OAAO,CAAC;aAC3B,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,gBAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;KAC9B;AACH,CAAC;AAPD,oCAOC;AAED;;;;GAIG;AACH,SAAgB,sBAAsB,CACpC,MAA2B;AAC3B,2EAA2E;AAC3E,UAAsB,EAAE;IAExB,sEAAsE;IACtE,yCAAyC;IACzC,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC;QAChC,EAAE,EAAE,kCAAc;KACnB,CAAC,CAAC;IACH,MAAM,EAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAC,GAAG,WAAW,CAAC,QAAQ,CAAC,OAAO,EAAE;QAC5D,OAAO,EAAE,KAAK;KACf,CAAC,CAAC;IAEH,YAAY,CAAC,OAAO,CAAC,CAAC;IAEtB,IAAI,KAAK,EAAE;QACT,MAAM,KAAK,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AArBD,wDAqBC;AAED;;;GAGG;AACH,SAAgB,oBAAoB,CAClC,MAA2B,EAC3B,WAAuB;IAEvB,oEAAoE;IACpE,uDAAuD;IACvD,sEAAsE;IACtE,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;IAErC,MAAM,EAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAC,GAAG,WAAW,CAAC,QAAQ,CAAC,WAAW,EAAE;QAChE,OAAO,EAAE,KAAK;KACf,CAAC,CAAC;IAEH,YAAY,CAAC,OAAO,CAAC,CAAC;IAEtB,IAAI,KAAK,EAAE;QACT,MAAM,KAAK,CAAC;KACb;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAnBD,oDAmBC;AAED;;GAEG;AACH,SAAgB,mBAAmB,CACjC,WAAqC,EACrC,MAA2B;IAE3B,MAAM,EAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE;QAC3D,OAAO,EAAE,IAAI;QACb,YAAY,EAAE,IAAI;QAClB,UAAU,EAAE,KAAK;KAClB,CAAC,CAAC;IAEH,YAAY,CAAC,OAAO,CAAC,CAAC;IAEtB,IAAI,KAAK,EAAE;QACT,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC;QACnC,MAAM,aAAa,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,EAAC,IAAI,EAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEpE,gBAAM,CAAC,KAAK,CAAA;;EAEd,iBAAI,CAAC,IAAI,CAAC,WAAW,CAAC;6CACqB,aAAa;EACxD,YAAY,CAAC,GAAG,CAAC,CAAC,EAAC,OAAO,EAAC,EAAE,EAAE,CAAC,OAAO,CAAC;CACzC,CAAC;QACE,MAAM,KAAK,CAAC;KACb;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AA1BD,kDA0BC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/utils-validation",
-  "version": "2.0.0-beta.fbdeefcac",
+  "version": "2.0.0-rc.1",
   "description": "Node validation utility functions for Docusaurus packages.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -18,13 +18,14 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/utils": "2.0.0-beta.fbdeefcac",
-    "chalk": "^4.1.1",
-    "joi": "^17.4.0",
-    "tslib": "^2.1.0"
+    "@docusaurus/logger": "2.0.0-rc.1",
+    "@docusaurus/utils": "2.0.0-rc.1",
+    "joi": "^17.6.0",
+    "js-yaml": "^4.1.0",
+    "tslib": "^2.4.0"
   },
   "engines": {
-    "node": ">=12.13.0"
+    "node": ">=16.14"
   },
-  "gitHead": "636c490f68d16a7452499ab722deb5ed51ef49fc"
+  "gitHead": "c8ddd02a8e68dfaf515c20465a049a83153bd205"
 }

package/src/JoiFrontMatter.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 './Joi';
+
+const JoiFrontMatterString: Joi.Extension = {
+  type: 'string',
+  base: Joi.string(),
+  // Fix Yaml that tries to auto-convert many things to string out of the box
+  prepare: (value: unknown) => {
+    if (typeof value === 'number' || value instanceof Date) {
+      return {value: value.toString()};
+    }
+    return {value};
+  },
+};
+
+/**
+ * Enhance the default `Joi.string()` type so that it can convert number to
+ * strings. If user use front matter "tag: 2021", we shouldn't need to ask her
+ * to write "tag: '2021'". Also yaml tries to convert patterns like "2019-01-01"
+ * to dates automatically.
+ *
+ * @see https://github.com/facebook/docusaurus/issues/4642
+ * @see https://github.com/sideway/joi/issues/1442#issuecomment-823997884
+ */
+export const JoiFrontMatter = Joi.extend(JoiFrontMatterString) as typeof Joi;

package/src/index.ts

@@ -7,6 +7,21 @@
 
 // /!\ don't remove this export, as we recommend plugin authors to use it
 export {default as Joi} from './Joi';
+export {JoiFrontMatter} from './JoiFrontMatter';
 
-export * from './validationUtils';
-export * from './validationSchemas';
+export {
+  printWarning,
+  normalizePluginOptions,
+  normalizeThemeConfig,
+  validateFrontMatter,
+} from './validationUtils';
+export {
+  PluginIdSchema,
+  RemarkPluginsSchema,
+  RehypePluginsSchema,
+  AdmonitionsSchema,
+  URISchema,
+  PathnameSchema,
+  FrontMatterTagsSchema,
+  FrontMatterTOCHeadingLevels,
+} from './validationSchemas';