1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/**
* A facade around @cfworker/json-schema that provides additional formats and
* convenience methods whil executing inside a sandbox.
*/
const sandbox = new Cu.Sandbox(null, {
wantComponents: false,
wantGlobalProperties: ["URL"],
});
Services.scriptloader.loadSubScript(
"chrome://global/content/third_party/cfworker/json-schema.js",
sandbox
);
/**
* A JSON Schema string format for URLs intended to go through Services.urlFormatter.
*/
Cu.exportFunction(
function validateMozUrlFormat(input) {
try {
const formatted = Services.urlFormatter.formatURL(input);
return Cu.waiveXrays(sandbox.fastFormat).uri(formatted);
} catch {
return false;
}
},
sandbox.fastFormat,
{ defineAs: "moz-url-format" }
);
// initialBaseURI defaults to github.com/cfworker, which will be confusing.
Cu.evalInSandbox(
`this.initialBaseURI = initialBaseURI = new URL("http://mozilla.org");`,
sandbox
);
/**
* A JSONSchema validator that performs validation inside a sandbox.
*/
class Validator {
#inner;
#draft;
/**
* Create a new validator.
*
* @param {object} schema The schema to validate with.
* @param {object} options Options for the validator.
* @param {string} options.draft The draft to validate against. Should be one
* of "4", "6", "7", "2019-09", or "2020-12".
*
* If the |$schema| key is present in the
* |schema|, it will be used to auto-detect the
* correct version. Otherwise, 2019-09 will be
* used.
* @param {boolean} options.shortCircuit Whether or not the validator should
* return after a single error occurs.
*/
constructor(
schema,
{ draft = detectSchemaDraft(schema), shortCircuit = true } = {}
) {
this.#draft = draft;
this.#inner = Cu.waiveXrays(
new sandbox.Validator(Cu.cloneInto(schema, sandbox), draft, shortCircuit)
);
}
/**
* Validate the instance against the known schemas.
*
* @param {object} instance The instance to validate.
*
* @return {object} An object with |valid| and |errors| keys that indicates
* the success of validation.
*/
validate(instance) {
return this.#inner.validate(Cu.cloneInto(instance, sandbox));
}
/**
* Add a schema to the validator.
*
* @param {object} schema A JSON schema object.
* @param {string} id An optional ID to identify the schema if it does not
* provide an |$id| field.
*/
addSchema(schema, id) {
const draft = detectSchemaDraft(schema, undefined);
if (draft && this.#draft != draft) {
Cu.reportError(
`Adding a draft "${draft}" schema to a draft "${
this.#draft
}" validator.`
);
}
this.#inner.addSchema(Cu.cloneInto(schema, sandbox), id);
}
}
/**
* A wrapper around validate that provides some options as an object
* instead of positional arguments.
*
* @param {object} instance The instance to validate.
* @param {object} schema The JSON schema to validate against.
* @param {object} options Options for the validator.
* @param {string} options.draft The draft to validate against. Should
* be one of "4", "6", "7", "2019-09", or "2020-12".
*
* If the |$schema| key is present in the |schema|, it
* will be used to auto-detect the correct version.
* Otherwise, 2019-09 will be used.
* @param {boolean} options.shortCircuit Whether or not the validator should
* return after a single error occurs.
*
* @returns {object} An object with |valid| and |errors| keys that indicates the
* success of validation.
*/
function validate(
instance,
schema,
{ draft = detectSchemaDraft(schema), shortCircuit = true } = {}
) {
const clonedSchema = Cu.cloneInto(schema, sandbox);
return sandbox.validate(
Cu.cloneInto(instance, sandbox),
clonedSchema,
draft,
sandbox.dereference(clonedSchema),
shortCircuit
);
}
function detectSchemaDraft(schema, defaultDraft = "2019-09") {
const { $schema } = schema;
if (typeof $schema === "undefined") {
return defaultDraft;
}
switch ($schema) {
case "http://json-schema.org/draft-04/schema#":
return "4";
case "http://json-schema.org/draft-06/schema#":
return "6";
case "http://json-schema.org/draft-07/schema#":
return "7";
case "https://json-schema.org/draft/2019-09/schema":
return "2019-09";
case "https://json-schema.org/draft/2020-12/schema":
return "2020-12";
default:
Cu.reportError(
`Unexpected $schema "${$schema}", defaulting to ${defaultDraft}.`
);
return defaultDraft;
}
}
export const JsonSchema = {
Validator,
validate,
detectSchemaDraft,
};
|
