@hyperjump/json-schema 1.2.2 → 1.2.4
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.
- package/lib/core.js +21 -12
- package/lib/fetch.js +1 -1
- package/lib/index.js +2 -0
- package/lib/keywords/meta-data.js +4 -1
- package/lib/keywords/unknown.js +4 -0
- package/lib/keywords/validation.js +46 -15
- package/lib/keywords.js +6 -22
- package/lib/media-types.d.ts +1 -0
- package/package.json +3 -4
package/lib/core.js
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
1
|
import curry from "just-curry-it";
|
|
2
|
-
import
|
|
3
|
-
import
|
|
2
|
+
import { subscribe, unsubscribe } from "./pubsub.js";
|
|
3
|
+
import {
|
|
4
|
+
setMetaSchemaOutputFormat,
|
|
5
|
+
getShouldValidateSchema,
|
|
6
|
+
isExperimentalKeywordEnabled,
|
|
7
|
+
setExperimentalKeywordEnabled,
|
|
8
|
+
getMetaSchemaOutputFormat
|
|
9
|
+
} from "./configuration.js";
|
|
4
10
|
import * as Instance from "./instance.js";
|
|
5
11
|
import { InvalidSchemaError } from "./invalid-schema-error.js";
|
|
6
12
|
import * as Schema from "./schema.js";
|
|
@@ -8,7 +14,7 @@ import Validation from "./keywords/validation.js";
|
|
|
8
14
|
|
|
9
15
|
|
|
10
16
|
export const FLAG = "FLAG", BASIC = "BASIC", DETAILED = "DETAILED", VERBOSE = "VERBOSE";
|
|
11
|
-
|
|
17
|
+
setMetaSchemaOutputFormat(FLAG);
|
|
12
18
|
|
|
13
19
|
export const validate = async (url, value = undefined, outputFormat = undefined) => {
|
|
14
20
|
const compiled = await compile(url);
|
|
@@ -30,9 +36,12 @@ export const interpret = curry(({ ast, schemaUri }, value, outputFormat = FLAG)
|
|
|
30
36
|
}
|
|
31
37
|
|
|
32
38
|
const output = [];
|
|
33
|
-
const subscriptionToken =
|
|
34
|
-
|
|
35
|
-
|
|
39
|
+
const subscriptionToken = subscribe("result", outputHandler(outputFormat, output));
|
|
40
|
+
try {
|
|
41
|
+
Validation.interpret(schemaUri, value, ast, {});
|
|
42
|
+
} finally {
|
|
43
|
+
unsubscribe("result", subscriptionToken);
|
|
44
|
+
}
|
|
36
45
|
|
|
37
46
|
return output[0];
|
|
38
47
|
});
|
|
@@ -70,26 +79,26 @@ const outputHandler = (outputFormat, output) => {
|
|
|
70
79
|
};
|
|
71
80
|
|
|
72
81
|
const metaValidators = {};
|
|
73
|
-
|
|
74
|
-
if (
|
|
82
|
+
subscribe("validate.metaValidate", async (message, schema) => {
|
|
83
|
+
if (getShouldValidateSchema() && !schema.validated) {
|
|
75
84
|
Schema.markValidated(schema.id);
|
|
76
85
|
|
|
77
86
|
// Compile
|
|
78
87
|
if (!(schema.dialectId in metaValidators)) {
|
|
79
88
|
// Dynamic references are experimental, but are necessary for meta-validation
|
|
80
89
|
const dyanmicRefKeywordId = "https://json-schema.org/keyword/dynamicRef";
|
|
81
|
-
const isDynamicRefEnabled =
|
|
82
|
-
|
|
90
|
+
const isDynamicRefEnabled = isExperimentalKeywordEnabled(dyanmicRefKeywordId);
|
|
91
|
+
setExperimentalKeywordEnabled(dyanmicRefKeywordId, true);
|
|
83
92
|
|
|
84
93
|
const compiledSchema = await compile(schema.dialectId);
|
|
85
94
|
metaValidators[schema.dialectId] = interpret(compiledSchema);
|
|
86
95
|
|
|
87
|
-
|
|
96
|
+
setExperimentalKeywordEnabled(dyanmicRefKeywordId, isDynamicRefEnabled);
|
|
88
97
|
}
|
|
89
98
|
|
|
90
99
|
// Interpret
|
|
91
100
|
const schemaInstance = Instance.cons(schema.schema, schema.id);
|
|
92
|
-
const metaResults = metaValidators[schema.dialectId](schemaInstance,
|
|
101
|
+
const metaResults = metaValidators[schema.dialectId](schemaInstance, getMetaSchemaOutputFormat());
|
|
93
102
|
if (!metaResults.valid) {
|
|
94
103
|
throw new InvalidSchemaError(metaResults);
|
|
95
104
|
}
|
package/lib/fetch.js
CHANGED
package/lib/index.js
CHANGED
|
@@ -57,6 +57,7 @@ import type from "./keywords/type.js";
|
|
|
57
57
|
import unevaluatedItems from "./keywords/unevaluatedItems.js";
|
|
58
58
|
import unevaluatedProperties from "./keywords/unevaluatedProperties.js";
|
|
59
59
|
import uniqueItems from "./keywords/uniqueItems.js";
|
|
60
|
+
import unknown from "./keywords/unknown.js";
|
|
60
61
|
import vocabulary from "./keywords/vocabulary.js";
|
|
61
62
|
import writeOnly from "./keywords/writeOnly.js";
|
|
62
63
|
|
|
@@ -125,6 +126,7 @@ addKeyword(type);
|
|
|
125
126
|
addKeyword(unevaluatedItems);
|
|
126
127
|
addKeyword(unevaluatedProperties);
|
|
127
128
|
addKeyword(uniqueItems);
|
|
129
|
+
addKeyword(unknown);
|
|
128
130
|
addKeyword(vocabulary);
|
|
129
131
|
addKeyword(writeOnly);
|
|
130
132
|
|
|
@@ -27,7 +27,7 @@ const compile = async (schema, ast) => {
|
|
|
27
27
|
|
|
28
28
|
const schemaValue = Schema.value(schema);
|
|
29
29
|
if (!["object", "boolean"].includes(typeof schemaValue)) {
|
|
30
|
-
throw Error(`No schema found at '${
|
|
30
|
+
throw Error(`No schema found at '${url}'`);
|
|
31
31
|
}
|
|
32
32
|
|
|
33
33
|
ast[url] = [
|
|
@@ -38,12 +38,15 @@ const compile = async (schema, ast) => {
|
|
|
38
38
|
Pact.map(async ([keyword, keywordSchema]) => {
|
|
39
39
|
const keywordId = getKeywordId(schema.dialectId, keyword);
|
|
40
40
|
if (!keywordId) {
|
|
41
|
-
throw Error(`Encountered unknown keyword '${keyword}' at ${
|
|
41
|
+
throw Error(`Encountered unknown keyword '${keyword}' at ${url}`);
|
|
42
42
|
}
|
|
43
43
|
|
|
44
44
|
const keywordHandler = getKeyword(keywordId);
|
|
45
|
+
if (!keywordHandler) {
|
|
46
|
+
throw Error(`Encountered unsupported keyword ${keyword} at '${url}'. You can provide an implementation for the '${keywordId}' keyword using the 'addKeyword' function.`);
|
|
47
|
+
}
|
|
45
48
|
if (keywordHandler.experimental && !isExperimentalKeywordEnabled(keywordId)) {
|
|
46
|
-
throw Error(`Encountered experimental keyword ${keyword} at '${
|
|
49
|
+
throw Error(`Encountered experimental keyword ${keyword} at '${url}'. You can enable this keyword with: setExperimentalKeywordEnabled('${keywordId}', true)`);
|
|
47
50
|
}
|
|
48
51
|
|
|
49
52
|
const keywordAst = await keywordHandler.compile(keywordSchema, ast, schema);
|
|
@@ -89,6 +92,7 @@ const interpret = (url, instance, ast, dynamicAnchors) => {
|
|
|
89
92
|
return isValid;
|
|
90
93
|
};
|
|
91
94
|
|
|
95
|
+
const emptyPropertyNames = [];
|
|
92
96
|
const collectEvaluatedProperties = (url, instance, ast, dynamicAnchors, isTop = false) => {
|
|
93
97
|
const nodes = ast[url][2];
|
|
94
98
|
|
|
@@ -96,14 +100,28 @@ const collectEvaluatedProperties = (url, instance, ast, dynamicAnchors, isTop =
|
|
|
96
100
|
return nodes ? [] : false;
|
|
97
101
|
}
|
|
98
102
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
103
|
+
const accumulatedPropertyNames = [];
|
|
104
|
+
for (const [keywordId, , keywordValue] of nodes) {
|
|
105
|
+
if (isTop && keywordId === "https://json-schema.org/keyword/unevaluatedProperties") {
|
|
106
|
+
continue;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
const keywordHandler = getKeyword(keywordId);
|
|
110
|
+
const propertyNames = "collectEvaluatedProperties" in keywordHandler
|
|
111
|
+
? keywordHandler.collectEvaluatedProperties(keywordValue, instance, ast, dynamicAnchors, isTop)
|
|
112
|
+
: keywordHandler.interpret(keywordValue, instance, ast, dynamicAnchors, isTop) && emptyPropertyNames;
|
|
113
|
+
|
|
114
|
+
if (propertyNames === false) {
|
|
115
|
+
return false;
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
Array.prototype.push.apply(accumulatedPropertyNames, propertyNames);
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
return accumulatedPropertyNames;
|
|
105
122
|
};
|
|
106
123
|
|
|
124
|
+
const emptyItemIndexes = new Set();
|
|
107
125
|
const collectEvaluatedItems = (url, instance, ast, dynamicAnchors, isTop = false) => {
|
|
108
126
|
const nodes = ast[url][2];
|
|
109
127
|
|
|
@@ -111,12 +129,25 @@ const collectEvaluatedItems = (url, instance, ast, dynamicAnchors, isTop = false
|
|
|
111
129
|
return nodes ? new Set() : false;
|
|
112
130
|
}
|
|
113
131
|
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
132
|
+
const accumulatedItemIndexes = new Set();
|
|
133
|
+
for (const [keywordId, , keywordValue] of nodes) {
|
|
134
|
+
if (isTop && keywordId === "https://json-schema.org/keyword/unevaluatedItems") {
|
|
135
|
+
continue;
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
const keywordHandler = getKeyword(keywordId);
|
|
139
|
+
const itemIndexes = "collectEvaluatedItems" in keywordHandler
|
|
140
|
+
? keywordHandler.collectEvaluatedItems(keywordValue, instance, ast, dynamicAnchors, isTop)
|
|
141
|
+
: keywordHandler.interpret(keywordValue, instance, ast, dynamicAnchors, isTop) && emptyItemIndexes;
|
|
142
|
+
|
|
143
|
+
if (itemIndexes === false) {
|
|
144
|
+
return false;
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
itemIndexes.forEach(Set.prototype.add.bind(accumulatedItemIndexes));
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
return accumulatedItemIndexes;
|
|
120
151
|
};
|
|
121
152
|
|
|
122
153
|
export default { id, compile, interpret, collectEvaluatedProperties, collectEvaluatedItems };
|
package/lib/keywords.js
CHANGED
|
@@ -1,19 +1,8 @@
|
|
|
1
|
-
import metaData from "./keywords/meta-data.js";
|
|
2
|
-
|
|
3
|
-
|
|
4
1
|
const _keywords = {};
|
|
5
|
-
export const getKeyword = (id) => _keywords[id]
|
|
2
|
+
export const getKeyword = (id) => _keywords[id];
|
|
6
3
|
|
|
7
4
|
export const addKeyword = (keywordHandler) => {
|
|
8
|
-
_keywords[keywordHandler.id] =
|
|
9
|
-
collectEvaluatedItems: (keywordValue, instance, ast, dynamicAnchors, isTop) => {
|
|
10
|
-
return keywordHandler.interpret(keywordValue, instance, ast, dynamicAnchors, isTop) && new Set();
|
|
11
|
-
},
|
|
12
|
-
collectEvaluatedProperties: (keywordValue, instance, ast, dynamicAnchors, isTop) => {
|
|
13
|
-
return keywordHandler.interpret(keywordValue, instance, ast, dynamicAnchors, isTop) && [];
|
|
14
|
-
},
|
|
15
|
-
...keywordHandler
|
|
16
|
-
};
|
|
5
|
+
_keywords[keywordHandler.id] = keywordHandler;
|
|
17
6
|
};
|
|
18
7
|
|
|
19
8
|
const _vocabularies = {};
|
|
@@ -24,7 +13,7 @@ export const defineVocabulary = (id, keywords) => {
|
|
|
24
13
|
const _dialects = {};
|
|
25
14
|
const _allowUnknownKeywords = {};
|
|
26
15
|
export const getKeywordId = (dialectId, keyword) => _dialects[dialectId]?.[keyword]
|
|
27
|
-
|| _allowUnknownKeywords[dialectId] &&
|
|
16
|
+
|| _allowUnknownKeywords[dialectId] && "https://json-schema.org/keyword/unknown";
|
|
28
17
|
export const getKeywordName = (dialectId, keywordId) => {
|
|
29
18
|
for (const keyword in _dialects[dialectId]) {
|
|
30
19
|
if (_dialects[dialectId][keyword] === keywordId) {
|
|
@@ -44,14 +33,9 @@ export const loadDialect = (dialectId, dialect, allowUnknownKeywords = false) =>
|
|
|
44
33
|
if (vocabularyId in _vocabularies) {
|
|
45
34
|
Object.entries(_vocabularies[vocabularyId])
|
|
46
35
|
.forEach(([keyword, keywordId]) => {
|
|
47
|
-
if (!(keywordId in _keywords)) {
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
throw Error(`The '${keywordId}' keyword is not supported. This keyword was included in the '${vocabularyId}' vocabulary which is required by the '${dialectId}' dialect.`);
|
|
51
|
-
} else {
|
|
52
|
-
// Allow keyword to be ignored
|
|
53
|
-
keywordId = `https://json-schema.org/keyword/unknown#${keyword}`;
|
|
54
|
-
}
|
|
36
|
+
if (!(keywordId in _keywords) && !isRequired) {
|
|
37
|
+
// Allow keyword to be ignored
|
|
38
|
+
keywordId = "https://json-schema.org/keyword/unknown";
|
|
55
39
|
}
|
|
56
40
|
_dialects[dialectId][keyword] = keywordId;
|
|
57
41
|
});
|
package/lib/media-types.d.ts
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hyperjump/json-schema",
|
|
3
|
-
"version": "1.2.
|
|
3
|
+
"version": "1.2.4",
|
|
4
4
|
"description": "A JSON Schema validator with support for custom keywords, vocabularies, and dialects",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./stable/index.js",
|
|
@@ -56,7 +56,6 @@
|
|
|
56
56
|
"eslint-plugin-import": "*",
|
|
57
57
|
"json-schema-test-suite": "github:json-schema-org/JSON-Schema-Test-Suite",
|
|
58
58
|
"mocha": "*",
|
|
59
|
-
"nock": "*",
|
|
60
59
|
"ts-node": "*",
|
|
61
60
|
"typescript": "*",
|
|
62
61
|
"yaml": "*"
|
|
@@ -67,10 +66,10 @@
|
|
|
67
66
|
"@hyperjump/uri": "^1.0.0",
|
|
68
67
|
"content-type": "^1.0.4",
|
|
69
68
|
"fastest-stable-stringify": "^2.0.2",
|
|
70
|
-
"
|
|
69
|
+
"undici": "^5.19.1",
|
|
71
70
|
"uuid": "^9.0.0"
|
|
72
71
|
},
|
|
73
72
|
"engines": {
|
|
74
|
-
"node": "
|
|
73
|
+
"node": ">=18.0.0"
|
|
75
74
|
}
|
|
76
75
|
}
|