ajv-validator / ajv-validator/ajv-errors

Keyword error replacement in nested objects it's not working

未关闭
#147 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
TypeScript
星标
289
派生
21
PR 合并指标
30 天内没有已合并 PR

描述

ajv-errors:3.0.0

I've created this test (using the code from object.spec.ts) and using a simple schema with some nested property.
The idea, based on the documentation, is that the error message for the "required" keyword should be replaced, but this it's not happening.

The error object is generated like this:

```json
{
"instancePath": "/sections/0",
"schemaPath": "#/properties/sections/items/required",
"keyword": "required",
"params": {
"missingProperty": "identityFieldValue"
},
"message": "must have required property 'identityFieldValue'"
}
```

This is the test to replicate the problem:

```typescript
describe("errorMessage value is an object custom", () => {
const ajv = _ajv();

it("should replace keyword errors with custom error messages", () => {
const schema: SchemaObject = {
type: "object",
required: ["foo", "sections"],
properties: {
foo: {type: "integer"},
sections: {
minItems: 1,
type: "array",
items: {
type: "object",
properties: {
identityFieldValue: { type: "string", minLength: 1 },
},
required: ["identityFieldValue"],
}
}
},
additionalProperties: false,
errorMessage: {
type: "should be an object",
required: "should have property foo",
additionalProperties: "should not have properties other than foo",
},
};

const validate = ajv.compile(schema);
testInvalid({foo: 1, sections: [{

}]}, [["required"]]);

function testInvalid(data: any, expectedErrors: (string | string[])[]): void {
assert.strictEqual(validate(data), false)
assert.strictEqual(validate.errors?.length, expectedErrors.length)
validate.errors.forEach((err, i) => {
const expectedErr = expectedErrors[i]
if (Array.isArray(expectedErr)) {
// errorMessage error
assert.strictEqual(err.keyword, "errorMessage")
assert.strictEqual(err.message, schema.errorMessage[err.params.errors[0].keyword])
assert.strictEqual(err.instancePath, "")
assert.strictEqual(err.schemaPath, "#/errorMessage")
const replacedKeywords = err.params.errors.map((e: ErrorObject) => e.keyword)
assert.deepStrictEqual(
Array.from(replacedKeywords.sort()),
Array.from(expectedErr.sort())
)
} else {
// original error
assert.strictEqual(err.keyword, expectedErr)
}
})
}
})
});

```

贡献指南

这个仓库没有索引到贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。