Document breaking changes for ajv-errors 1.0.1 → 3.0.0 upgrade

[Copilot]

Documented breaking changes for the ajv-errors dependency update in response to maintainer request.

Critical Incompatibility

Peer dependency mismatch requires ajv upgrade:

• [email protected]: requires ajv >= 5.0.0
• [email protected]: requires ajv ^8.0.1
• Current packages/project/package.json: ajv ^6.12.6

Breaking Changes

ajv-errors changes:

• Error property renamed: dataPath → instancePath
• Complete rewrite for ajv v8 compatibility

Required ajv v6 → v8 migration:

• JSON Schema draft-04 support removed (id → $id)
• Format validation moved to separate ajv-formats package
• Must instantiate with new keyword (now ES6 class)
• Error messages changed: "should" → "must"
• Strict mode enabled by default
• Many options removed: errorDataPath, format, nullable, jsonPointers, unicode, extendRefs, schemaId
• Schema objects now used as cache keys (not serialized strings)

Impact on validation code:

const {default: Ajv} = await import("ajv");
const {default: ajvErrors} = await import("ajv-errors");
const ajv = new Ajv({allErrors: true, jsonPointers: true});
ajvErrors(ajv);  // Error handling will receive instancePath instead of dataPath

Error handling in ValidationError.js and schema definitions may need updates to accommodate these changes.

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[cla-assistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}