@docusaurus/utils-validation 2.0.0-beta.15d451942 → 2.0.0-beta.16

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,17 @@
+/**
+ * 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: typeof Joi;
+//# 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;AAaxB;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,EAAE,OAAO,GAAsC,CAAC"}

package/lib/JoiFrontMatter.js

@@ -0,0 +1,32 @@
+"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 = (0, 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,6DAAwB;AAExB,MAAM,oBAAoB,GAAkB;IAC1C,IAAI,EAAE,QAAQ;IACd,IAAI,EAAE,aAAG,CAAC,MAAM,EAAE;IAClB,2EAA2E;IAC3E,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;QACjB,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;AACF;;;;;;;GAOG;AACU,QAAA,cAAc,GAAe,aAAG,CAAC,MAAM,CAAC,oBAAoB,CAAC,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

@@ -11,3 +11,9 @@ export declare const RehypePluginsSchema: Joi.ArraySchema;
 export declare const AdmonitionsSchema: Joi.ObjectSchema<any>;
 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;AAEH,OAAO,GAAG,MAAM,OAAO,CAAC;AAKxB,eAAO,MAAM,cAAc,kBAKE,CAAC;AAU9B,eAAO,MAAM,mBAAmB,iBAAwB,CAAC;AACzD,eAAO,MAAM,mBAAmB,iBAAwB,CAAC;AAEzD,eAAO,MAAM,iBAAiB,uBAA2B,CAAC;AAI1D,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,46 +1,73 @@
 "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 Joi_1 = (0, tslib_1.__importDefault)(require("./Joi"));
 const utils_1 = require("@docusaurus/utils");
+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(/^[a-zA-Z0-9_-]+$/)
+    .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())
     .default([]);
 exports.RemarkPluginsSchema = MarkdownPluginsSchema;
 exports.RehypePluginsSchema = MarkdownPluginsSchema;
 exports.AdmonitionsSchema = Joi_1.default.object().default({});
-exports.URISchema = Joi_1.default.alternatives(Joi_1.default.string().uri({ allowRelative: true }), Joi_1.default.custom((val, helpers) => {
+// 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 ...
+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(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 / and not contain any domain or query string');
+    .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 FrontMatter 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,6DAAwB;AACxB,6CAAqE;AAErE,qDAAgD;AAEnC,QAAA,cAAc,GAAG,aAAG,CAAC,MAAM,EAAE;KACvC,KAAK,CAAC,kBAAkB,CAAC;KACzB,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,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,EACvE,aAAG,CAAC,QAAQ,EAAE,EACd,aAAG,CAAC,MAAM,EAAE,CACb;KACA,OAAO,CAAC,EAAE,CAAC,CAAC;AAEF,QAAA,mBAAmB,GAAG,qBAAqB,CAAC;AAC5C,QAAA,mBAAmB,GAAG,qBAAqB,CAAC;AAE5C,QAAA,iBAAiB,GAAG,aAAG,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;AAE1D,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,GAAG,EAAE,OAAO,EAAE,EAAE;IAC1B,IAAI;QACF,kCAAkC;QAClC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QACb,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,GAAG,EAAE,EAAE;IACd,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,+DAA+D;CAClE,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,12 +4,11 @@
  * 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';
+export declare function printWarning(warning?: Joi.ValidationError): void;
 export declare function normalizePluginOptions<T extends {
     id?: string;
 }>(schema: Joi.ObjectSchema<T>, options: Partial<T>): T;
 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;
+//# 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;AAEH,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAI7B,wBAAgB,YAAY,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,eAAe,GAAG,IAAI,CAOhE;AAED,wBAAgB,sBAAsB,CAAC,CAAC,SAAS;IAAC,EAAE,CAAC,EAAE,MAAM,CAAA;CAAC,EAC5D,MAAM,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAC3B,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,GAClB,CAAC,CAiBH;AAED,wBAAgB,oBAAoB,CAAC,CAAC,EACpC,MAAM,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,EAC3B,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC,GACtB,CAAC,CAgBH;AAED,wBAAgB,mBAAmB,CAAC,CAAC,EACnC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpC,MAAM,EAAE,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,GAC1B,CAAC,CAuBH"}

package/lib/validationUtils.js

@@ -1,52 +1,38 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateFrontMatter = exports.JoiFrontMatter = exports.normalizeThemeConfig = exports.normalizePluginOptions = 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 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
 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'));
+function printWarning(warning) {
+    if (warning) {
+        const warningMessages = warning.details
+            .map(({ message }) => message)
+            .join('\n');
+        logger_1.default.warn(warningMessages);
+    }
 }
-const logValidationBugReportHint = () => {
-    console.log(`\n${chalk_1.default.red('A validation error occured.')}${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;
+exports.printWarning = printWarning;
 function normalizePluginOptions(schema, options) {
     // All plugins can be provided an "id" option (multi-instance support)
     // we add schema validation automatically
     const finalSchema = schema.append({
         id: validationSchemas_1.PluginIdSchema,
     });
-    const { error, value } = finalSchema.validate(options, {
+    const { error, warning, value } = finalSchema.validate(options, {
         convert: false,
     });
+    printWarning(warning);
     if (error) {
-        exports.logValidationBugReportHint();
-        if (exports.isValidationDisabledEscapeHatch) {
-            console.error(error);
-            return options;
-        }
-        else {
-            throw error;
-        }
+        throw error;
     }
-    return value;
+    return value; // TODO remove this ! in TS 4.6, see https://twitter.com/sebastienlorber/status/1481950042277793793
 }
 exports.normalizePluginOptions = normalizePluginOptions;
 function normalizeThemeConfig(schema, themeConfig) {
@@ -54,62 +40,35 @@ function normalizeThemeConfig(schema, 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();
-    const { error, value } = finalSchema.validate(themeConfig, {
+    const { error, warning, value } = finalSchema.validate(themeConfig, {
         convert: false,
     });
+    printWarning(warning);
     if (error) {
-        exports.logValidationBugReportHint();
-        if (exports.isValidationDisabledEscapeHatch) {
-            console.error(error);
-            return themeConfig;
-        }
-        else {
-            throw error;
-        }
+        throw error;
     }
-    return value;
+    return value; // TODO remove this ! in TS 4.6
 }
 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);
 function validateFrontMatter(frontMatter, schema) {
     const { value, error, warning } = schema.validate(frontMatter, {
         convert: true,
         allowUnknown: true,
         abortEarly: false,
     });
+    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:
+${logger_1.default.yellow(frontMatterString)}
+contains invalid values for field(s): ${logger_1.default.yellow(invalidFields)}.
+${errorDetails.map(({ message }) => message)}
+`;
         throw error;
     }
-    if (warning) {
-        const warningMessages = warning.details
-            .map(({ message }) => message)
-            .join('\n');
-        console.log(chalk_1.default.yellow(warningMessages));
-    }
-    return value;
+    return value; // TODO remove this ! in TS 4.6
 }
 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;;;;AAGH,6EAAwC;AACxC,2DAAmD;AAEnD,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,SAAgB,sBAAsB,CACpC,MAA2B,EAC3B,OAAmB;IAEnB,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,KAAM,CAAC,CAAC,mGAAmG;AACpH,CAAC;AApBD,wDAoBC;AAED,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,KAAM,CAAC,CAAC,+BAA+B;AAChD,CAAC;AAnBD,oDAmBC;AAED,SAAgB,mBAAmB,CACjC,WAAoC,EACpC,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,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAC/D,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;EACd,gBAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC;wCACM,gBAAM,CAAC,MAAM,CAAC,aAAa,CAAC;EAClE,YAAY,CAAC,GAAG,CAAC,CAAC,EAAC,OAAO,EAAC,EAAE,EAAE,CAAC,OAAO,CAAC;CACzC,CAAC;QACE,MAAM,KAAK,CAAC;KACb;IAED,OAAO,KAAM,CAAC,CAAC,+BAA+B;AAChD,CAAC;AA1BD,kDA0BC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/utils-validation",
-  "version": "2.0.0-beta.15d451942",
+  "version": "2.0.0-beta.16",
   "description": "Node validation utility functions for Docusaurus packages.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -18,13 +18,13 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/utils": "2.0.0-beta.15d451942",
-    "chalk": "^4.1.1",
-    "joi": "^17.4.0",
-    "tslib": "^2.1.0"
+    "@docusaurus/logger": "2.0.0-beta.16",
+    "@docusaurus/utils": "2.0.0-beta.16",
+    "joi": "^17.6.0",
+    "tslib": "^2.3.1"
   },
   "engines": {
-    "node": ">=12.13.0"
+    "node": ">=14"
   },
-  "gitHead": "dfceae8bd3e8b42ba8fc14f1449d861046c26143"
+  "gitHead": "eb43c4d4f95a4fb97dc9bb9dc615413e0dc2e1e7"
 }

package/src/JoiFrontMatter.ts

@@ -0,0 +1,29 @@
+/**
+ * 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) => {
+    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: typeof Joi = Joi.extend(JoiFrontMatterString);

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';

package/src/validationSchemas.ts

@@ -4,13 +4,18 @@
  * 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';
-import {isValidPathname} from '@docusaurus/utils';
+import {isValidPathname, DEFAULT_PLUGIN_ID} from '@docusaurus/utils';
+import type {Tag} from '@docusaurus/utils';
+import {JoiFrontMatter} from './JoiFrontMatter';
 
 export const PluginIdSchema = Joi.string()
-  .regex(/^[a-zA-Z_-]+$/)
-  // duplicate core constant, otherwise cyclic dependency is created :(
-  .default('default');
+  .regex(/^[a-zA-Z0-9_-]+$/)
+  .message(
+    'Illegal plugin ID value "{#value}": it should only contain alphanumerics, underscores, and dashes.',
+  )
+  .default(DEFAULT_PLUGIN_ID);
 
 const MarkdownPluginsSchema = Joi.array()
   .items(
@@ -25,30 +30,64 @@ export const RehypePluginsSchema = MarkdownPluginsSchema;
 
 export const AdmonitionsSchema = Joi.object().default({});
 
+// TODO how can we make this emit a custom error message :'(
+//  Joi is such a pain, good luck to annoying trying to improve this
 export const URISchema = Joi.alternatives(
   Joi.string().uri({allowRelative: true}),
+  // This custom validation logic is required notably because Joi does not
+  // accept paths like /a/b/c ...
   Joi.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(val);
+      return val;
     } catch {
       return helpers.error('any.invalid');
     }
   }),
-);
+).messages({
+  'alternatives.match':
+    "{{#label}} does not look like a valid url (value='{{.value}}')",
+});
 
 export const PathnameSchema = Joi.string()
   .custom((val) => {
     if (!isValidPathname(val)) {
       throw new Error();
-    } else {
-      return val;
     }
+    return val;
   })
   .message(
-    '{{#label}} is not a valid pathname. Pathname should start with / and not contain any domain or query string',
+    '{{#label}} is not a valid pathname. Pathname should start with slash and not contain any domain or query string.',
   );
+
+const FrontMatterTagSchema = JoiFrontMatter.alternatives()
+  .try(
+    JoiFrontMatter.string().required(),
+    JoiFrontMatter.object<Tag>({
+      label: JoiFrontMatter.string().required(),
+      permalink: 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',
+  });
+
+export const FrontMatterTagsSchema = JoiFrontMatter.array()
+  .items(FrontMatterTagSchema)
+  .messages({
+    'array.base':
+      '{{#label}} does not look like a valid FrontMatter Yaml array.',
+  });
+
+export const FrontMatterTOCHeadingLevels = {
+  toc_min_heading_level: JoiFrontMatter.number().when('toc_max_heading_level', {
+    is: JoiFrontMatter.exist(),
+    then: JoiFrontMatter.number()
+      .min(2)
+      .max(JoiFrontMatter.ref('toc_max_heading_level')),
+    otherwise: JoiFrontMatter.number().min(2).max(6),
+  }),
+  toc_max_heading_level: JoiFrontMatter.number().min(2).max(6),
+};