@docusaurus/utils-validation 3.10.1-canary-6655 → 3.10.1-canary-6803
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.
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* This source code is licensed under the MIT license found in the
|
|
5
5
|
* LICENSE file in the root directory of this source tree.
|
|
6
6
|
*/
|
|
7
|
-
import { type FrontMatterTag } from '@docusaurus/utils';
|
|
7
|
+
import { type FrontMatterTag, type FrontMatterLastUpdate } from '@docusaurus/utils';
|
|
8
8
|
import Joi from './Joi';
|
|
9
9
|
export declare const PluginIdSchema: Joi.StringSchema<string>;
|
|
10
10
|
export declare const RemarkPluginsSchema: Joi.ArraySchema<any[]>;
|
|
@@ -25,5 +25,5 @@ export type ContentVisibility = {
|
|
|
25
25
|
};
|
|
26
26
|
export declare const ContentVisibilitySchema: Joi.ObjectSchema<ContentVisibility>;
|
|
27
27
|
export declare const FrontMatterLastUpdateErrorMessage = "{{#label}} does not look like a valid last update object. Please use an author key with a string or a date with a string or Date.";
|
|
28
|
-
export declare const FrontMatterLastUpdateSchema: Joi.ObjectSchema<
|
|
28
|
+
export declare const FrontMatterLastUpdateSchema: Joi.ObjectSchema<FrontMatterLastUpdate>;
|
|
29
29
|
//# sourceMappingURL=validationSchemas.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"validationSchemas.d.ts","sourceRoot":"","sources":["../src/validationSchemas.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAGL,KAAK,cAAc,
|
|
1
|
+
{"version":3,"file":"validationSchemas.d.ts","sourceRoot":"","sources":["../src/validationSchemas.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAGL,KAAK,cAAc,EACnB,KAAK,qBAAqB,EAC3B,MAAM,mBAAmB,CAAC;AAE3B,OAAO,GAAG,MAAM,OAAO,CAAC;AAGxB,eAAO,MAAM,cAAc,0BAKE,CAAC;AAe9B,eAAO,MAAM,mBAAmB,wBAAwB,CAAC;AACzD,eAAO,MAAM,mBAAmB,wBAAwB,CAAC;AACzD,eAAO,MAAM,kBAAkB,wBAAwB,CAAC;AAExD,eAAO,MAAM,iBAAiB,6BAqB1B,CAAC;AAIL,eAAO,MAAM,SAAS,6BAiBpB,CAAC;AAEH,eAAO,MAAM,cAAc,0BASxB,CAAC;AAaJ,eAAO,MAAM,mBAAmB,gCAO7B,CAAC;AAiBJ,eAAO,MAAM,qBAAqB,mCAK9B,CAAC;AAEL,eAAO,MAAM,2BAA2B;;;CASvC,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE,OAAO,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,eAAO,MAAM,uBAAuB,qCAiBxB,CAAC;AAEb,eAAO,MAAM,iCAAiC,sIACuF,CAAC;AAEtI,eAAO,MAAM,2BAA2B,yCAapC,CAAC"}
|
package/lib/validationSchemas.js
CHANGED
|
@@ -49,13 +49,11 @@ Joi_1.default.custom((val, helpers) => {
|
|
|
49
49
|
if (typeof val !== 'string') {
|
|
50
50
|
return helpers.error('any.invalid');
|
|
51
51
|
}
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
return val;
|
|
55
|
-
}
|
|
56
|
-
catch {
|
|
52
|
+
const url = URL.parse(String(val));
|
|
53
|
+
if (url === null) {
|
|
57
54
|
return helpers.error('any.invalid');
|
|
58
55
|
}
|
|
56
|
+
return val;
|
|
59
57
|
})).messages({
|
|
60
58
|
'alternatives.match': "{{#label}} does not look like a valid url (value='{{.value}}')",
|
|
61
59
|
});
|
|
@@ -129,7 +127,9 @@ exports.ContentVisibilitySchema = JoiFrontMatter_1.JoiFrontMatter.object({
|
|
|
129
127
|
exports.FrontMatterLastUpdateErrorMessage = '{{#label}} does not look like a valid last update object. Please use an author key with a string or a date with a string or Date.';
|
|
130
128
|
exports.FrontMatterLastUpdateSchema = Joi_1.default.object({
|
|
131
129
|
author: Joi_1.default.string(),
|
|
132
|
-
|
|
130
|
+
// Joi doesn't like our "string | Date" union type
|
|
131
|
+
// It expects an "alternative" type, even when using date().raw()
|
|
132
|
+
date: Joi_1.default.alternatives().try(Joi_1.default.date().raw()),
|
|
133
133
|
})
|
|
134
134
|
.or('author', 'date')
|
|
135
135
|
.messages({
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"validationSchemas.js","sourceRoot":"","sources":["../src/validationSchemas.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,
|
|
1
|
+
{"version":3,"file":"validationSchemas.js","sourceRoot":"","sources":["../src/validationSchemas.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,6CAK2B;AAC3B,2DAAyD;AACzD,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;AAC5C,QAAA,kBAAkB,GAAG,qBAAqB,CAAC;AAE3C,QAAA,iBAAiB,GAAG,+BAAc,CAAC,YAAY,EAAE;KAC3D,GAAG,CACF,+BAAc,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,EACnC,+BAAc,CAAC,MAAM,CAAC;IACpB,QAAQ,EAAE,+BAAc,CAAC,KAAK,EAAE,CAAC,KAAK,CACpC,+BAAc,CAAC,MAAM,EAAE,CAGxB;IACD,cAAc,EAAE,+BAAc,CAAC,OAAO,EAAE;IAExC,0BAA0B;IAC1B,GAAG,EAAE,aAAG,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC,QAAQ,CAAC;QAClC,aAAa,EAAE,mIAAmI;KACnJ,CAAC;CACH,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,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IACtC,CAAC;IACD,MAAM,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IACnC,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QACjB,OAAO,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IACtC,CAAC;IACD,OAAO,GAAG,CAAC;AACb,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,CAAC;QAC1B,MAAM,IAAI,KAAK,EAAE,CAAC;IACpB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;KACD,OAAO,CACN,+HAA+H,CAChI,CAAC;AAEJ,sEAAsE;AACtE,mCAAmC;AACnC,yEAAyE;AACzE,EAAE;AACF,YAAY;AACZ,YAAY;AACZ,oBAAoB;AACpB,qBAAqB;AACrB,qBAAqB;AACrB,kCAAkC;AAClC,mEAAmE;AACtD,QAAA,mBAAmB,GAAG,aAAG;IACpC,kEAAkE;KACjE,YAAY,EAAE;KACd,GAAG,CAAC,aAAG,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;KACtC,MAAM,CAAC,CAAC,KAAa,EAAE,EAAE;AACxB,qCAAqC;AACrC,IAAA,8BAAe,EAAC,KAAK,CAAC,CACvB,CAAC;AAEJ,MAAM,oBAAoB,GAAG,+BAAc,CAAC,YAAY,EAAE;KACvD,GAAG,CACF,+BAAc,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;AAClC,qEAAqE;AACrE,qCAAqC;AACrC,+BAAc,CAAC,MAAM,CAAiB;IACpC,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;AAOW,QAAA,uBAAuB,GAAG,+BAAc,CAAC,MAAM,CAG1D;IACA,KAAK,EAAE,+BAAc,CAAC,OAAO,EAAE;IAC/B,QAAQ,EAAE,+BAAc,CAAC,OAAO,EAAE;CACnC,CAAC;KACC,MAAM,CAAC,CAAC,WAA8B,EAAE,OAAO,EAAE,EAAE;IAClD,IAAI,WAAW,CAAC,KAAK,IAAI,WAAW,CAAC,QAAQ,EAAE,CAAC;QAC9C,OAAO,OAAO,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;IAC5D,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;KACD,QAAQ,CAAC;IACR,mCAAmC,EACjC,+CAA+C;CAClD,CAAC;KACD,OAAO,EAAE,CAAC;AAEA,QAAA,iCAAiC,GAC5C,mIAAmI,CAAC;AAEzH,QAAA,2BAA2B,GAAG,aAAG,CAAC,MAAM,CAGnD;IACA,MAAM,EAAE,aAAG,CAAC,MAAM,EAAE;IACpB,kDAAkD;IAClD,iEAAiE;IACjE,IAAI,EAAE,aAAG,CAAC,YAAY,EAAE,CAAC,GAAG,CAAC,aAAG,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,CAAC;CAC/C,CAAC;KACC,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC;KACpB,QAAQ,CAAC;IACR,gBAAgB,EAAE,yCAAiC;IACnD,aAAa,EAAE,yCAAiC;CACjD,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@docusaurus/utils-validation",
|
|
3
|
-
"version": "3.10.1-canary-
|
|
3
|
+
"version": "3.10.1-canary-6803",
|
|
4
4
|
"description": "Node validation utility functions for Docusaurus packages.",
|
|
5
5
|
"main": "./lib/index.js",
|
|
6
6
|
"types": "./lib/index.d.ts",
|
|
@@ -18,17 +18,20 @@
|
|
|
18
18
|
},
|
|
19
19
|
"license": "MIT",
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@docusaurus/logger": "3.10.1-canary-
|
|
22
|
-
"@docusaurus/utils": "3.10.1-canary-
|
|
23
|
-
"@docusaurus/utils-common": "3.10.1-canary-
|
|
21
|
+
"@docusaurus/logger": "3.10.1-canary-6803",
|
|
22
|
+
"@docusaurus/utils": "3.10.1-canary-6803",
|
|
23
|
+
"@docusaurus/utils-common": "3.10.1-canary-6803",
|
|
24
24
|
"fs-extra": "^11.2.0",
|
|
25
25
|
"joi": "^18.1.2",
|
|
26
26
|
"js-yaml": "^4.1.0",
|
|
27
27
|
"lodash": "^4.17.21",
|
|
28
28
|
"tslib": "^2.6.0"
|
|
29
29
|
},
|
|
30
|
+
"devDependencies": {
|
|
31
|
+
"@types/js-yaml": "^4.0.9"
|
|
32
|
+
},
|
|
30
33
|
"engines": {
|
|
31
34
|
"node": ">=24.14"
|
|
32
35
|
},
|
|
33
|
-
"gitHead": "
|
|
36
|
+
"gitHead": "d2c7b381512bd4e7e90e33f56649e68d618eaa92"
|
|
34
37
|
}
|
package/src/validationSchemas.ts
CHANGED
|
@@ -9,6 +9,7 @@ import {
|
|
|
9
9
|
isValidPathname,
|
|
10
10
|
DEFAULT_PLUGIN_ID,
|
|
11
11
|
type FrontMatterTag,
|
|
12
|
+
type FrontMatterLastUpdate,
|
|
12
13
|
} from '@docusaurus/utils';
|
|
13
14
|
import {addLeadingSlash} from '@docusaurus/utils-common';
|
|
14
15
|
import Joi from './Joi';
|
|
@@ -71,12 +72,11 @@ export const URISchema = Joi.alternatives(
|
|
|
71
72
|
if (typeof val !== 'string') {
|
|
72
73
|
return helpers.error('any.invalid');
|
|
73
74
|
}
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
return val;
|
|
77
|
-
} catch {
|
|
75
|
+
const url = URL.parse(String(val));
|
|
76
|
+
if (url === null) {
|
|
78
77
|
return helpers.error('any.invalid');
|
|
79
78
|
}
|
|
79
|
+
return val;
|
|
80
80
|
}),
|
|
81
81
|
).messages({
|
|
82
82
|
'alternatives.match':
|
|
@@ -152,12 +152,13 @@ export type ContentVisibility = {
|
|
|
152
152
|
unlisted: boolean;
|
|
153
153
|
};
|
|
154
154
|
|
|
155
|
-
export const ContentVisibilitySchema = JoiFrontMatter.object<
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
)
|
|
155
|
+
export const ContentVisibilitySchema = JoiFrontMatter.object<
|
|
156
|
+
ContentVisibility,
|
|
157
|
+
true
|
|
158
|
+
>({
|
|
159
|
+
draft: JoiFrontMatter.boolean(),
|
|
160
|
+
unlisted: JoiFrontMatter.boolean(),
|
|
161
|
+
})
|
|
161
162
|
.custom((frontMatter: ContentVisibility, helpers) => {
|
|
162
163
|
if (frontMatter.draft && frontMatter.unlisted) {
|
|
163
164
|
return helpers.error('frontMatter.draftAndUnlistedError');
|
|
@@ -173,9 +174,14 @@ export const ContentVisibilitySchema = JoiFrontMatter.object<ContentVisibility>(
|
|
|
173
174
|
export const FrontMatterLastUpdateErrorMessage =
|
|
174
175
|
'{{#label}} does not look like a valid last update object. Please use an author key with a string or a date with a string or Date.';
|
|
175
176
|
|
|
176
|
-
export const FrontMatterLastUpdateSchema = Joi.object
|
|
177
|
+
export const FrontMatterLastUpdateSchema = Joi.object<
|
|
178
|
+
FrontMatterLastUpdate,
|
|
179
|
+
true
|
|
180
|
+
>({
|
|
177
181
|
author: Joi.string(),
|
|
178
|
-
|
|
182
|
+
// Joi doesn't like our "string | Date" union type
|
|
183
|
+
// It expects an "alternative" type, even when using date().raw()
|
|
184
|
+
date: Joi.alternatives().try(Joi.date().raw()),
|
|
179
185
|
})
|
|
180
186
|
.or('author', 'date')
|
|
181
187
|
.messages({
|