Merge branch 'master' of github.com:agjs/use-ajv-form

Author: agjs

README.md

@@ -213,6 +213,7 @@ You can customize `useAJVForm` using the following options:
 | `userDefinedMessages`       | `Record<string, AJVMessageFunction>` | Custom error messages for validation errors.                                                            |
 | `shouldDebounceAndValidate` | `boolean`                            | If `true`, enables debouncing for field validation.                                                     |
 | `debounceTime`              | `number`                             | Time in milliseconds for debouncing validation. Ignored if `shouldDebounceAndValidate` is set to false. |
+| `ajv`                       | `Ajv`                                | Your own AJV instance that might have custom keywords, errors, etc.                                     |
 
 ## Usage in Practice
 

pnpm-lock.yaml

@@ -1,6 +1,6 @@
 import { useEffect, useMemo, useRef, useState } from 'react';
 import { addUserDefinedKeywords, getErrors, getInitial, getValue } from './utils';
-import { ajv } from './utils/validation';
+import { ajv as ajvInternal } from './utils/validation';
 
 import { ErrorObject, JSONSchemaType, KeywordDefinition, SchemaObject } from 'ajv';
 import { useDebounce } from './Hooks/useDebounce';
@@ -17,6 +17,7 @@ const useAJVForm = <T extends Record<string, any>>(
   initial: T,
   schema: JSONSchemaType<T> | SchemaObject,
   options?: {
+    ajv?: typeof ajvInternal;
     customKeywords?: KeywordDefinition[];
     errors?: ErrorObject[];
     userDefinedMessages?: Record<string, AJVMessageFunction>;
@@ -25,6 +26,8 @@ const useAJVForm = <T extends Record<string, any>>(
     debug?: boolean;
   },
 ): UseFormReturn<T> => {
+  const ajvInstance = options?.ajv || ajvInternal;
+
   const initialStateRef = useRef<IState<T>>(getInitial(initial));
 
   const [state, setState] = useState<IState<T>>(getInitial(initial));
@@ -41,10 +44,10 @@ const useAJVForm = <T extends Record<string, any>>(
   );
 
   if (options?.customKeywords?.length) {
-    addUserDefinedKeywords(ajv, options.customKeywords);
+    addUserDefinedKeywords(ajvInstance, options.customKeywords);
   }
 
-  const AJVValidate = ajv.compile(schema);
+  const AJVValidate = ajvInstance.compile(schema);
 
   const resetForm = () => {
     logger.log('Form reset to initial state');

src/index.ts

@@ -1,5 +1,6 @@
 import { act, renderHook } from '@testing-library/react-hooks';
 import { JSONSchemaType } from 'ajv';
+import Ajv from 'ajv';
 import { vi } from 'vitest';
 import useAJVForm from '.';
 
@@ -126,7 +127,7 @@ describe('useAJVForm', () => {
     expect(validation.isValid).toBe(true);
   });
 
-  it('isValid should be false when the initial state is set or when reset is called', () => {
+  it('isValid should be true when the initial state is set or when reset is called', () => {
     const initialData = { title: 'Foo' };
     const schema: JSONSchemaType<{ title: string }> = {
       type: 'object',