refactor: replace ajv-formats-draft2019 with custom implementations for idn-email format (leveraging ajv-formats)

Signed-off-by: Pasi Eronen <pe@iki.fi>

Author: pasieronen

README.md

@@ -129,7 +129,6 @@ Some features require optional peer dependencies — see `package.json` for vers
 * Validation of JSON on _Node.js_ requires all of:
   * [`ajv`](https://www.npmjs.com/package/ajv)
   * [`ajv-formats`](https://www.npmjs.com/package/ajv-formats)
-  * [`ajv-formats-draft2019`](https://www.npmjs.com/package/ajv-formats-draft2019)
 * Validation of XML on _Node.js_ requires any of:
   * [`libxmljs2`](https://www.npmjs.com/package/libxmljs2)  
     * the system might need to meet the requirements for [`node-gyp`](https://github.com/TooTallNate/node-gyp#installation), in certain cases.

docs/install.rst

@@ -30,7 +30,6 @@ See the shipped ``package.json`` for version constraints.
 * Validation of JSON on _Node.js_ requires all of:
     * `ajv <https://www.npmjs.com/package/ajv>`_
     * `ajv-formats <https://www.npmjs.com/package/ajv-formats>`_
-    * `ajv-formats-draft2019 <https://www.npmjs.com/package/ajv-formats-draft2019>`_
 * Validation of XML on _Node.js_ requires all of:
     * `libxmljs2 <https://www.npmjs.com/package/libxmljs2>`_
     * the system must meet the requirements for `node-gyp <https://github.com/TooTallNate/node-gyp#installation>`_

package.json

@@ -83,7 +83,6 @@
   "peerDependencies": {
     "ajv": "^8.12.0",
     "ajv-formats": "^3.0.1",
-    "ajv-formats-draft2019": "^1.6.1",
     "libxmljs2": "^0.35||^0.37",
     "xmlbuilder2": "^3.0.2||^4.0.0",
     "packageurl-js": "*",
@@ -96,9 +95,6 @@
     "ajv-formats": {
       "optional": true
     },
-    "ajv-formats-draft2019": {
-      "optional": true
-    },
     "libxmljs2": {
       "optional": true
     },
@@ -127,7 +123,6 @@
   "devDependencies": {
     "ajv": "^8.12.0",
     "ajv-formats": "^3.0.1",
-    "ajv-formats-draft2019": "^1.6.1",
     "libxmljs2": "^0.35||^0.37",
     "xmlbuilder2": "^3.0.2||^4.0.0",
     "spdx-expression-parse": "^3.0.1||^4",

src/_optPlug.node/__jsonValidators/ajv.ts

@@ -21,8 +21,6 @@ import { readFile } from 'node:fs/promises'
 
 import Ajv, { type Options as AjvOptions } from 'ajv'
 import addFormats from 'ajv-formats'
-/* @ts-expect-error TS7016 */
-import addFormats2019 from 'ajv-formats-draft2019'
 
 import type { ValidationError } from '../../validation/types'
 import type { Functionality, Validator } from '../jsonValidator'
@@ -50,11 +48,19 @@ export default (async function (schemaPath: string, schemaMap: Record<string, st
   /* eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- intended */
   const ajv = new Ajv({ ...ajvOptions, schemas })
   addFormats(ajv)
-  /* eslint-disable-next-line @typescript-eslint/no-unsafe-call -- intended */
-  addFormats2019(ajv, { formats: ['idn-email'] })
+
   // there is just no working implementation for format "iri-reference": see https://github.com/luzlab/ajv-formats-draft2019/issues/22
   ajv.addFormat('iri-reference', true)
 
+  // add idn-email format (was previously provided by ajv-formats-draft2019)
+  const emailValidator = ajv.compile({type: 'string', format: 'email'})
+  ajv.addFormat('idn-email', {
+    type: 'string',
+    // syntax allows non-ASCII characters in places where 'x' would be allowed
+    // (don't attempt to validate exactly which Unicode characters are OK - too complex)
+    validate: x => emailValidator(x.replace(/[\u0080-\uffff]+/g, 'x'))
+  })
+
   const validator = ajv.compile(schema)
 
   return function (data: string): null | ValidationError {

src/_optPlug.node/jsonValidator.ts

@@ -27,7 +27,7 @@ export default opWrapper<Functionality>('JsonValidator', [
   /* eslint-disable @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-return, @typescript-eslint/no-require-imports
      -- needed */
 
-  ['( ajv && ajv-formats && ajv-formats-draft2019 )', () => require('./__jsonValidators/ajv').default]
+  ['( ajv && ajv-formats )', () => require('./__jsonValidators/ajv').default]
   // ... add others here, pull-requests welcome!
 
 /* eslint-enable @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-return, @typescript-eslint/no-require-imports */