Skip to content

Commit 8b9642f

Browse files
epoberezkinepoberezkin
committed
evaluate_metaschema.json
1 parent 844518f commit 8b9642f

File tree

6 files changed

+93
-19
lines changed

6 files changed

+93
-19
lines changed

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,5 @@ build/Release
2525
# Dependency directory
2626
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
2727
node_modules
28+
29+
.DS_Store

‎evaluate.json ‎schema/evaluate.json

+42-15
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"id": "evaluate.json#",
3-
"$schema": "https://raw.githubusercontent.com/epoberezkin/ajv/master/lib/refs/json-schema-v5.json#",
2+
"id": "http://json-script.com/schema/evaluate.json#",
3+
"$schema": "http://json-script.com/schema/evaluate_metaschema.json#",
44
"description": "schema with custom keywords that evaluates JSON script. It assumes that the script is valid",
55
"switch": [
66
{
@@ -11,19 +11,18 @@
1111
"allOf":[
1212
{
1313
"title": "evaluate properties",
14-
"description": "evaluates all properties using the same schema, properties-scripts are replaced with promises",
14+
"description": "evaluates all properties using the same schema, properties-scripts are replaced with returned data or 'promise'",
1515
"additionalProperties": { "$ref": "#" }
1616
},
1717
{
1818
"title": "validate keywords",
1919
"description": "validates script keyword values or chains promises to validate resolved values of keywords",
2020
"properties": {
21-
"$func": { "thenValue": { "type": "string" } },
22-
"$object": { "thenValue": { "type": "string" } },
23-
"$method": { "thenValue": { "type": "string" } },
24-
"$ref": { "thenValue": { "type": "string" } },
25-
"$data": { "thenValue": { "type": "string" } },
26-
"$args": { "thenValue": { "type": [ "array", "object" ] } }
21+
"$func": { "thenValue": { "$ref": "#uuidOrIdentifier" } },
22+
"$object": { "thenValue": { "$ref": "#uuidOrIdentifier" } },
23+
"$method": { "thenValue": { "$ref": "#identifier" } },
24+
"$ref": { "thenValue": { "$ref": "#jsonPointer" } },
25+
"$data": { "thenValue": { "$ref": "#anyJsonPointer" } }
2726
}
2827
},
2928
{
@@ -32,19 +31,19 @@
3231
"switch": [
3332
{
3433
"if": { "required": [ "$func" ] },
35-
"then": { "applyFunc": [ "0/$func", "0/$args" ] }
34+
"then": { "applyFunc": true }
3635
},
3736
{
3837
"if": { "required": [ "$method" ] },
39-
"then": { "applyMethod": [ "0/$object", "0/$method", "0/$args" ] }
38+
"then": { "applyMethod": true }
4039
},
4140
{
4241
"if": { "required": [ "$ref" ] },
43-
"then": { "getRef": [ "0/$ref" ] }
42+
"then": { "getRef": true }
4443
},
4544
{
4645
"if": { "required": [ "$data" ] },
47-
"then": { "getData": [ "0/$data" ] }
46+
"then": { "getData": true }
4847
}
4948
]
5049
}
@@ -56,8 +55,36 @@
5655
"then": {
5756
"title": "sequential execution",
5857
"description": "queues items so that the next promise is created only after the previous one is resolved",
59-
"queueItems": [ "0/" ]
58+
"queueItems": true
6059
}
6160
}
62-
]
61+
],
62+
"definitions": {
63+
"identifier": {
64+
"id": "#identifier",
65+
"type": "string",
66+
"pattern": "^[A-Za-z$_][A-Za-z$_0-9]*$"
67+
},
68+
"uuidOrIdentifier": {
69+
"id": "#uuidOrIdentifier",
70+
"type": "string",
71+
"anyOf": [
72+
{ "pattern": "^[A-Za-z$_][A-Za-z$_0-9]*$" },
73+
{ "format": "uuid" }
74+
]
75+
},
76+
"jsonPointer": {
77+
"id": "#jsonPointer",
78+
"type": "string",
79+
"format": "json-pointer"
80+
},
81+
"anyJsonPointer": {
82+
"id": "#anyJsonPointer",
83+
"type": "string",
84+
"anyOf": [
85+
{ "format": "json-pointer" },
86+
{ "format": "relative-json-pointer" }
87+
]
88+
}
89+
}
6390
}

‎schema/evaluate_metaschema.json

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
{
2+
"id": "http://json-script.com/schema/evaluate_metaschema.json#",
3+
"$schema": "https://raw.githubusercontent.com/epoberezkin/ajv/master/lib/refs/json-schema-v5.json#",
4+
"allOf": [
5+
{ "$ref": "https://raw.githubusercontent.com/epoberezkin/ajv/master/lib/refs/json-schema-v5.json#" },
6+
{
7+
"properties": {
8+
"thenValue": {
9+
"title": "'promise' validation",
10+
"description": "Validates the resolved value of the 'promise' and replaces the data with chained 'promise'. If the date is not a promise validates it immediately. Please not that the keyword itself executes synchronously.",
11+
"$ref": "https://raw.githubusercontent.com/epoberezkin/ajv/master/lib/refs/json-schema-v5.json#"
12+
},
13+
"applyFunc": {
14+
"title": "$func call",
15+
"description": "call function defined by $func instruction. Keyword should replace the instruction with the result or with the promise",
16+
"constant": true
17+
},
18+
"applyMethod": {
19+
"title": "$method call",
20+
"description": "call method defined by $object/$method instruction. Keyword should replace the instruction with the result or with the promise",
21+
"constant": true
22+
},
23+
"getRef": {
24+
"title": "$ref to the part of the script",
25+
"description": "Keyword should replace $ref instruction with the result of the script evaluation at this position.",
26+
"constant": true
27+
},
28+
"getData": {
29+
"title": "$data reference to the part of the data instance",
30+
"description": "Keyword should replace $data instruction with the data value at the position defined by JSON-pointer.",
31+
"constant": true
32+
},
33+
"queueItems": {
34+
"title": "sequntial evaluation",
35+
"description": "Keyword should replace the array with the promise that resolves to array of results, but instructions should only be executed after the previous one completes",
36+
"constant": true
37+
}
38+
}
39+
}
40+
]
41+
}

‎schema.json ‎schema/schema.json

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"id": "jsonscript.json#",
2+
"id": "http://json-script.com/schema/schema.json#",
33
"$schema": "http://json-schema.org/draft-04/schema#",
44
"title": "JSONScript schema",
55
"description": "JSONScript without instructions: on the top level only parallel/serial execution is allowed",
@@ -68,6 +68,7 @@
6868
"id": "#parallel",
6969
"description": "scripts in the object are executed in parallel, property names should not start with $",
7070
"type": "object",
71+
"minProperties": 1,
7172
"patternProperties": {
7273
"^[^$]": { "$ref": "#script" }
7374
},
@@ -77,6 +78,7 @@
7778
"id": "#serial",
7879
"description": "scripts in array are executed sequentially",
7980
"type": "array",
81+
"minItems": 1,
8082
"items": { "$ref": "#script" }
8183
},
8284
"scalar": {

‎spec/schema.spec.js

+4-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@
33
var jsonSchemaTest = require('json-schema-test')
44
, Ajv = require('ajv');
55

6-
var ajv = Ajv({ allErrors: true });
7-
ajv.addSchema(require('../schema'));
6+
var ajv = Ajv({ allErrors: true, v5: true });
7+
ajv.addSchema(require('../schema/schema'));
8+
ajv.addMetaSchema(require('../schema/evaluate_metaschema'));
9+
ajv.addSchema(require('../schema/evaluate'));
810

911

1012
jsonSchemaTest([ ajv ], {

‎spec/scripts/func.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[
22
{
33
"description": "$func call",
4-
"schema": { "$ref": "jsonscript.json#func" },
4+
"schema": { "$ref": "http://json-script.com/schema/schema.json#func" },
55
"tests": [
66
{
77
"description": "with args",

0 commit comments

Comments
 (0)