@naturalcycles/nodejs-lib 15.37.2 → 15.39.0

package/src/validation/ajv/getAjv.ts

@@ -1,10 +1,12 @@
-/* eslint-disable @typescript-eslint/prefer-string-starts-ends-with */
-/* eslint-disable unicorn/prefer-code-point */
 import { _lazyValue } from '@naturalcycles/js-lib'
-import type { Options } from 'ajv'
-import { Ajv } from 'ajv'
-import ajvFormats from 'ajv-formats'
-import ajvKeywords from 'ajv-keywords'
+import { Set2 } from '@naturalcycles/js-lib/object'
+import { _substringAfterLast } from '@naturalcycles/js-lib/string'
+import { _, Ajv, type Options, type ValidateFunction } from 'ajv'
+import type { JsonSchemaStringEmailOptions } from './jsonSchemaBuilder.js'
+import { validTLDs } from './tlds.js'
+
+/* eslint-disable @typescript-eslint/prefer-string-starts-ends-with */
+// oxlint-disable unicorn/prefer-code-point
 
 const AJV_OPTIONS: Options = {
   removeAdditional: true,
@@ -51,101 +53,256 @@ export function createAjv(opt?: Options): Ajv {
     ...opt,
   })
 
-  // Add custom formats
-  addCustomAjvFormats(ajv)
-
-  // todo: review and possibly cherry-pick/vendor the formats
-  // Adds ajv "formats"
-  // https://ajv.js.org/guide/formats.html
-  // @ts-expect-error types are wrong
-  ajvFormats(ajv)
-
-  // https://ajv.js.org/packages/ajv-keywords.html
-  // @ts-expect-error types are wrong
-  ajvKeywords(ajv, [
-    'transform', // trim, toLowerCase, etc.
-    'uniqueItemProperties',
-    'instanceof',
-  ])
-
   // Adds $merge, $patch keywords
   // https://github.com/ajv-validator/ajv-merge-patch
   // Kirill: temporarily disabled, as it creates a noise of CVE warnings
   // require('ajv-merge-patch')(ajv)
 
-  return ajv
-}
+  ajv.addKeyword({
+    keyword: 'transform',
+    type: 'string',
+    modifying: true,
+    schemaType: 'object',
+    errors: true,
+    code(ctx) {
+      const { gen, data, schema, it } = ctx
+      const { parentData, parentDataProperty } = it
+
+      if (schema.trim) {
+        gen.assign(_`${data}`, _`${data}.trim()`)
+      }
+
+      if (schema.toLowerCase) {
+        gen.assign(_`${data}`, _`${data}.toLowerCase()`)
+      }
+
+      if (schema.toUpperCase) {
+        gen.assign(_`${data}`, _`${data}.toUpperCase()`)
+      }
+
+      if (typeof schema.truncate === 'number' && schema.truncate >= 0) {
+        gen.assign(_`${data}`, _`${data}.slice(0, ${schema.truncate})`)
+
+        if (schema.trim) {
+          gen.assign(_`${data}`, _`${data}.trim()`)
+        }
+      }
+
+      gen.if(_`${parentData} !== undefined`, () => {
+        gen.assign(_`${parentData}[${parentDataProperty}]`, data)
+      })
+    },
+  })
 
-const TS_2500 = 16725225600 // 2500-01-01
-const TS_2500_MILLIS = TS_2500 * 1000
-const TS_2000 = 946684800 // 2000-01-01
-const TS_2000_MILLIS = TS_2000 * 1000
+  ajv.addKeyword({
+    keyword: 'instanceof',
+    modifying: true,
+    schemaType: 'string',
+    validate(instanceOf: string, data: unknown, _schema, _ctx) {
+      if (typeof data !== 'object') return false
+      if (data === null) return false
+
+      let proto = Object.getPrototypeOf(data)
+      while (proto) {
+        if (proto.constructor?.name === instanceOf) return true
+        proto = Object.getPrototypeOf(proto)
+      }
+
+      return false
+    },
+  })
 
-const monthLengths = [0, 31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
+  ajv.addKeyword({
+    keyword: 'Set2',
+    type: ['array', 'object'],
+    modifying: true,
+    errors: true,
+    schemaType: 'object',
+    compile(innerSchema, _parentSchema, _it) {
+      const validateItem: ValidateFunction = ajv.compile(innerSchema)
+
+      function validateSet(data: any, ctx: any): boolean {
+        let set: Set2
+
+        const isIterable = data === null || typeof data[Symbol.iterator] === 'function'
+
+        if (data instanceof Set2) {
+          set = data
+        } else if (isIterable && ctx?.parentData) {
+          set = new Set2(data)
+        } else if (isIterable && !ctx?.parentData) {
+          ;(validateSet as any).errors = [
+            {
+              instancePath: ctx?.instancePath ?? '',
+              message:
+                'can only transform an Iterable into a Set2 when the schema is in an object or an array schema. This is an Ajv limitation.',
+            },
+          ]
+          return false
+        } else {
+          ;(validateSet as any).errors = [
+            {
+              instancePath: ctx?.instancePath ?? '',
+              message: 'must be a Set2 object (or optionally an Iterable in some cases)',
+            },
+          ]
+          return false
+        }
+
+        let idx = 0
+        for (const value of set.values()) {
+          if (!validateItem(value)) {
+            ;(validateSet as any).errors = [
+              {
+                instancePath: (ctx?.instancePath ?? '') + '/' + idx,
+                message: `invalid set item at index ${idx}`,
+                params: { errors: validateItem.errors },
+              },
+            ]
+            return false
+          }
+          idx++
+        }
+
+        if (ctx?.parentData && ctx.parentDataProperty) {
+          ctx.parentData[ctx.parentDataProperty] = set
+        }
+
+        return true
+      }
+
+      return validateSet
+    },
+  })
 
-function addCustomAjvFormats(ajv: Ajv): Ajv {
-  return (
-    ajv
-      .addFormat('id', /^[a-z0-9_]{6,64}$/)
-      .addFormat('slug', /^[a-z0-9-]+$/)
-      .addFormat('semVer', /^[0-9]+\.[0-9]+\.[0-9]+$/)
-      // IETF language tag (https://en.wikipedia.org/wiki/IETF_language_tag)
-      .addFormat('languageTag', /^[a-z]{2}(-[A-Z]{2})?$/)
-      .addFormat('countryCode', /^[A-Z]{2}$/)
-      .addFormat('currency', /^[A-Z]{3}$/)
-      .addFormat('unixTimestamp', {
-        type: 'number',
-        validate: (n: number) => {
-          return n >= 0 && n < TS_2500
-        },
-      })
-      .addFormat('unixTimestamp2000', {
-        type: 'number',
-        validate: (n: number) => {
-          return n >= TS_2000 && n < TS_2500
-        },
-      })
-      .addFormat('unixTimestampMillis', {
-        type: 'number',
-        validate: (n: number) => {
-          return n >= 0 && n < TS_2500_MILLIS
-        },
-      })
-      .addFormat('unixTimestampMillis2000', {
-        type: 'number',
-        validate: (n: number) => {
-          return n >= TS_2000_MILLIS && n < TS_2500_MILLIS
+  ajv.addKeyword({
+    keyword: 'Buffer',
+    modifying: true,
+    errors: true,
+    schemaType: 'boolean',
+    compile(_innerSchema, _parentSchema, _it) {
+      function validateBuffer(data: any, ctx: any): boolean {
+        let buffer: Buffer
+
+        if (data === null) return false
+
+        const isValid =
+          data instanceof Buffer ||
+          data instanceof ArrayBuffer ||
+          Array.isArray(data) ||
+          typeof data === 'string'
+        if (!isValid) return false
+
+        if (data instanceof Buffer) {
+          buffer = data
+        } else if (isValid && ctx?.parentData) {
+          buffer = Buffer.from(data as any)
+        } else if (isValid && !ctx?.parentData) {
+          ;(validateBuffer as any).errors = [
+            {
+              instancePath: ctx?.instancePath ?? '',
+              message:
+                'can only transform data into a Buffer when the schema is in an object or an array schema. This is an Ajv limitation.',
+            },
+          ]
+          return false
+        } else {
+          ;(validateBuffer as any).errors = [
+            {
+              instancePath: ctx?.instancePath ?? '',
+              message:
+                'must be a Buffer object (or optionally an Array-like object or ArrayBuffer in some cases)',
+            },
+          ]
+          return false
+        }
+
+        if (ctx?.parentData && ctx.parentDataProperty) {
+          ctx.parentData[ctx.parentDataProperty] = buffer
+        }
+
+        return true
+      }
+
+      return validateBuffer
+    },
+  })
+
+  ajv.addKeyword({
+    keyword: 'email',
+    type: 'string',
+    modifying: false,
+    errors: true,
+    schemaType: 'object',
+    validate: function validate(opt: JsonSchemaStringEmailOptions, data: string, _schema, ctx) {
+      const { checkTLD } = opt
+      if (!checkTLD) return true
+
+      const tld = _substringAfterLast(data, '.')
+      if (validTLDs.has(tld)) return true
+      ;(validate as any).errors = [
+        {
+          instancePath: ctx?.instancePath ?? '',
+          message: `has an invalid TLD`,
         },
-      })
-      .addFormat('utcOffset', {
-        type: 'number',
-        validate: (n: number) => {
-          // min: -14 hours
-          // max +14 hours
-          // multipleOf 15 (minutes)
-          return n >= -14 * 60 && n <= 14 * 60 && Number.isInteger(n)
+      ]
+      return false
+    },
+  })
+
+  ajv.addKeyword({
+    keyword: 'IsoDate',
+    type: 'string',
+    modifying: false,
+    errors: true,
+    schemaType: 'boolean',
+    validate: function validate(_opt: true, data: string, _schema, ctx) {
+      const isValid = isIsoDateValid(data)
+      if (isValid) return true
+      ;(validate as any).errors = [
+        {
+          instancePath: ctx?.instancePath ?? '',
+          message: `is an invalid IsoDate`,
         },
-      })
-      .addFormat('utcOffsetHours', {
-        type: 'number',
-        validate: (n: number) => {
-          // min: -14 hours
-          // max +14 hours
-          // multipleOf 15 (minutes)
-          return n >= -14 && n <= 14 && Number.isInteger(n)
+      ]
+      return false
+    },
+  })
+
+  ajv.addKeyword({
+    keyword: 'IsoDateTime',
+    type: 'string',
+    modifying: false,
+    errors: true,
+    schemaType: 'boolean',
+    validate: function validate(_opt: true, data: string, _schema, ctx) {
+      const isValid = isIsoDateTimeValid(data)
+      if (isValid) return true
+      ;(validate as any).errors = [
+        {
+          instancePath: ctx?.instancePath ?? '',
+          message: `is an invalid IsoDateTime`,
         },
-      })
-      .addFormat('IsoDate', {
-        type: 'string',
-        validate: isIsoDateValid,
-      })
-      .addFormat('IsoDateTime', {
-        type: 'string',
-        validate: isIsoDateTimeValid,
-      })
-  )
+      ]
+      return false
+    },
+  })
+
+  ajv.addKeyword({
+    keyword: 'errorMessages',
+    schemaType: 'object',
+  })
+
+  ajv.addKeyword({
+    keyword: 'hasIsOfTypeCheck',
+    schemaType: 'boolean',
+  })
+
+  return ajv
 }
 
+const monthLengths = [0, 31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
+
 const DASH_CODE = '-'.charCodeAt(0)
 const ZERO_CODE = '0'.charCodeAt(0)
 const PLUS_CODE = '+'.charCodeAt(0)

package/src/validation/ajv/index.ts

@@ -3,5 +3,6 @@ import Ajv from 'ajv'
 export * from './ajvSchema.js'
 export * from './ajvValidationError.js'
 export * from './getAjv.js'
+export * from './jsonSchemaBuilder.js'
 
 export { Ajv }