1 import type {CodeKeywordDefinition, ErrorObject, KeywordErrorDefinition} from "../../types"
2 import type {KeywordCxt} from "../../compile/validate"
4 checkReportMissingProp,
10 import {_, str, nil, not, Name, Code} from "../../compile/codegen"
11 import {checkStrictMode} from "../../compile/util"
13 export type RequiredError = ErrorObject<
15 {missingProperty: string},
16 string[] | {$data: string}
19 const error: KeywordErrorDefinition = {
20 message: ({params: {missingProperty}}) => str`must have required property '${missingProperty}'`,
21 params: ({params: {missingProperty}}) => _`{missingProperty: ${missingProperty}}`,
24 const def: CodeKeywordDefinition = {
30 code(cxt: KeywordCxt) {
31 const {gen, schema, schemaCode, data, $data, it} = cxt
33 if (!$data && schema.length === 0) return
34 const useLoop = schema.length >= opts.loopRequired
35 if (it.allErrors) allErrorsMode()
36 else exitOnErrorMode()
38 if (opts.strictRequired) {
39 const props = cxt.parentSchema.properties
40 const {definedProperties} = cxt.it
41 for (const requiredKey of schema) {
42 if (props?.[requiredKey] === undefined && !definedProperties.has(requiredKey)) {
43 const schemaPath = it.schemaEnv.baseId + it.errSchemaPath
44 const msg = `required property "${requiredKey}" is not defined at "${schemaPath}" (strictRequired)`
45 checkStrictMode(it, msg, it.opts.strictRequired)
50 function allErrorsMode(): void {
51 if (useLoop || $data) {
52 cxt.block$data(nil, loopAllRequired)
54 for (const prop of schema) {
55 checkReportMissingProp(cxt, prop)
60 function exitOnErrorMode(): void {
61 const missing = gen.let("missing")
62 if (useLoop || $data) {
63 const valid = gen.let("valid", true)
64 cxt.block$data(valid, () => loopUntilMissing(missing, valid))
67 gen.if(checkMissingProp(cxt, schema, missing))
68 reportMissingProp(cxt, missing)
73 function loopAllRequired(): void {
74 gen.forOf("prop", schemaCode as Code, (prop) => {
75 cxt.setParams({missingProperty: prop})
76 gen.if(noPropertyInData(gen, data, prop, opts.ownProperties), () => cxt.error())
80 function loopUntilMissing(missing: Name, valid: Name): void {
81 cxt.setParams({missingProperty: missing})
86 gen.assign(valid, propertyInData(gen, data, missing, opts.ownProperties))
87 gen.if(not(valid), () => {