feat: ✨ provide useOaModelAjv to access ajv instance & addKeywords

playground/ajv-keywords.ts

@@ -0,0 +1,20 @@
+import type { KeywordDefinition } from 'ajv'
+
+export const keywords: KeywordDefinition[] = [{
+  keyword: 'range', // example from https://ajv.js.org/keywords.html#define-keyword-with-validate-function
+  validate ([min, max], data, parentSchema, _dataCxt) {
+    return data >= min && data <= max
+  },
+  error: {
+    message: ({ schema: [min, max], parentSchema }) => {
+      return `Value must be between ${min} and ${max} (inclusive)`
+    }
+  },
+  metaSchema: {
+    // schema to validate keyword value
+    type: 'array',
+    items: [{ type: 'number' }, { type: 'number' }],
+    minItems: 2,
+    additionalItems: false
+  }
+}]

playground/app.vue

@@ -33,7 +33,7 @@
         </template>
       </json-list>
       <dialog ref="dialog">
-        <json-schema ref="form" v-model="editedTodo" :schema="schema" :defs-schema="defsSchema" />
+        <json-schema ref="form" v-model="editedTodo" :schema="schema" :defs-schema="defsSchema" :keywords="keywords" />
         <menu>
           <button value="cancel" @click="closeTodo">
             Cancel
@@ -59,6 +59,7 @@
 
 <script lang="ts" setup>
 import { ref } from 'vue'
+import { keywords } from '~/ajv-keywords'
 import { useFetch, useOaSchema, useOaDefsSchema } from '#imports'
 
 const schema = useOaSchema('Todo')

playground/schemas/Todo.json

@@ -12,6 +12,10 @@
         "$ref": "defs#/definitions/tag"
       }
     },
+    "cost": {
+      "type": "integer",
+      "range": [0, 250]
+    },
     "done": {
       "type": "string",
       "format": "date-time",

playground/server/api/[...todos].ts

@@ -1,5 +1,10 @@
+import { ObjectId } from 'mongodb'
 import { consola } from 'consola'
 import { H3Event } from 'h3'
+import { keywords } from '~/ajv-keywords'
+
+const { addKeywords } = useOaModelAjv() // need to be called before any useOaModel()
+addKeywords(keywords)
 
 const Layer = useOaModel('Layer')
 consola.log(Layer.name) // model from layer base

src/module.ts

@@ -81,7 +81,7 @@ export default defineNuxtModule<ModuleOptions>({
     nuxt.options.nitro.imports.presets = nuxt.options.nitro.imports.presets || []
     nuxt.options.nitro.imports.presets.push({
       from: resolve('runtime/server/helpers/model'),
-      imports: ['useOaModel', 'useModel']
+      imports: ['useOaModel', 'useOaModelAjv']
     })
     nuxt.options.nitro.imports.presets.push({
       from: resolve('runtime/server/helpers/controllers'),

src/runtime/server/helpers/model.ts

@@ -1,8 +1,7 @@
 import { randomBytes } from 'node:crypto'
-import { useLogger } from '@nuxt/kit'
 import Ajv from 'ajv'
 import addFormats from 'ajv-formats'
-import type { ValidateFunction } from 'ajv'
+import type { KeywordDefinition, ValidateFunction } from 'ajv'
 import type { Collection, Document, ObjectId, OptionalUnlessRequiredId, WithId } from 'mongodb'
 import { Hookable, type HookCallback } from 'hookable'
 import { createError, type H3Event } from 'h3'
@@ -13,7 +12,6 @@ import { decrypt, encrypt } from './cipher'
 
 import { useRuntimeConfig } from '#imports'
 
-const logger = useLogger('nuxt-oa')
 const { cipherAlgo, cipherKey, stringifiedSchemasByName, stringifiedDefsSchemas } = useRuntimeConfig().oa
 const schemasByName = JSON.parse(stringifiedSchemasByName) as Record<keyof OaModels, Schema>
 const defsSchemas = JSON.parse(stringifiedDefsSchemas) as DefsSchema[]
@@ -365,10 +363,16 @@ export function useOaModel<T extends keyof OaModels & string> (name: T): Model<T
   return modelsCache[name]
 }
 
-/**
- * @deprecated use 'useOaModel' instead
- */
-export function useModel<T extends keyof OaModels & string> (name: T): Model<T> {
-  logger.warn('"useModel" is deprecated. Use "useOaModel" instead.')
-  return useOaModel(name)
+/** Add user-defined keywords to ajv instance used in OaModel */
+const addKeywords = (keywords: KeywordDefinition[]) => {
+  for (const keyword of keywords) {
+    ajv.addKeyword(keyword)
+  }
+}
+
+export function useOaModelAjv () {
+  return {
+    instance: ajv,
+    addKeywords
+  }
 }