Fix: Expose the internal ajv variable in the validator implementation classes

CHANGELOG.md

@@ -21,6 +21,18 @@ should change the heading of the (upcoming) version to include a major version b
 
 - fix `getFieldNames`. Now correctly defines an array of primitives.
 
+## @rjsf/validator-ajv6
+
+- Updated the `AJV6Validator` class to expose the internal `ajv` object, allowing access to support a fix related to [#3972](https://github.com/rjsf-team/react-jsonschema-form/issues/3972)
+
+## @rjsf/validator-ajv8
+
+- Updated the `AJV8Validator` class to expose the internal `ajv` object, allowing access to support a fix related to [#3972](https://github.com/rjsf-team/react-jsonschema-form/issues/3972)
+
+## Dev / docs / playground
+
+- Updated the documentation to describe how to use the newly exposed `ajv` variable 
+
 # 5.15.0
 
 ## @rjsf/mui

packages/docs/docs/api-reference/validator-ajv8.md

@@ -25,7 +25,7 @@ If a `localizer` is provided, it is used to translate the messages generated by
 
 #### Returns
 
-- ValidatorType<T, S, F>: The custom validator implementation resulting from the set of parameters provided
+- AJV8Validator<T, S, F>: The custom validator implementation resulting from the set of parameters provided
 
 ### compileSchemaValidators<S extends StrictRJSFSchema = RJSFSchema>()
 

packages/docs/docs/usage/validation.md

@@ -585,6 +585,21 @@ const validator = customizeValidator({ ajvOptionsOverrides });
 render(<Form schema={schema} validator={validator} />, document.getElementById('app'));
 ```
 
+## Using the raw Ajv instance
+
+The `customizeValidator()` function returns the `AJV8Validator` (or `AJV6Validator` depending on the library you use) implementation class, which has an internal raw `ajv` instance within it.
+If you need to do some deep customization of the instance using any of the `ajv` libraries (like `ajv-keywords`), you can do so using this raw instance as follows:
+
+```ts
+import { customizeValidator } from '@rjsf/validator-ajv6';
+import ajvKeywords from 'ajv-keywords';
+
+const validator = customizeValidator();
+ajvKeywords(validator.ajv, ['your-keyword']);
+
+// use your update validator with a `Form`
+```
+
 ## Ajv8 validator differences
 
 There are a few differences in configuring the Ajv 8 validator.

packages/validator-ajv6/src/customizeValidator.ts

@@ -1,4 +1,4 @@
-import { FormContextType, RJSFSchema, StrictRJSFSchema, ValidatorType } from '@rjsf/utils';
+import { FormContextType, RJSFSchema, StrictRJSFSchema } from '@rjsf/utils';
 
 import { CustomValidatorOptionsType } from './types';
 import AJV6Validator from './validator';
@@ -13,6 +13,6 @@ export default function customizeValidator<
   T = any,
   S extends StrictRJSFSchema = RJSFSchema,
   F extends FormContextType = any
->(options: CustomValidatorOptionsType = {}): ValidatorType<T, S, F> {
+>(options: CustomValidatorOptionsType = {}) {
   return new AJV6Validator<T, S, F>(options);
 }

packages/validator-ajv6/src/validator.ts

@@ -31,10 +31,8 @@ export default class AJV6Validator<T = any, S extends StrictRJSFSchema = RJSFSch
   implements ValidatorType<T, S, F>
 {
   /** The AJV instance to use for all validations
-   *
-   * @private
    */
-  private ajv: Ajv;
+  ajv: Ajv;
 
   /** Constructs an `AJV6Validator` instance using the `options`
    *

packages/validator-ajv8/src/customizeValidator.ts

@@ -1,4 +1,4 @@
-import { FormContextType, RJSFSchema, StrictRJSFSchema, ValidatorType } from '@rjsf/utils';
+import { FormContextType, RJSFSchema, StrictRJSFSchema } from '@rjsf/utils';
 
 import { CustomValidatorOptionsType, Localizer } from './types';
 import AJV8Validator from './validator';
@@ -15,6 +15,6 @@ export default function customizeValidator<
   T = any,
   S extends StrictRJSFSchema = RJSFSchema,
   F extends FormContextType = any
->(options: CustomValidatorOptionsType = {}, localizer?: Localizer): ValidatorType<T, S, F> {
+>(options: CustomValidatorOptionsType = {}, localizer?: Localizer) {
   return new AJV8Validator<T, S, F>(options, localizer);
 }

packages/validator-ajv8/src/validator.ts

@@ -29,7 +29,7 @@ export default class AJV8Validator<T = any, S extends StrictRJSFSchema = RJSFSch
    *
    * @private
    */
-  private ajv: Ajv;
+  ajv: Ajv;
 
   /** The Localizer function to use for localizing Ajv errors
    *

packages/validator-ajv8/test/validator.test.ts

@@ -92,7 +92,6 @@ describe('AJV8Validator', () => {
           name: 'John Doe',
         };
 
-        // @ts-expect-error - accessing private Ajv instance to verify compilation happens once
         const addSchemaSpy = jest.spyOn(validator.ajv, 'addSchema');
 
         // Call isValid twice with the same schema
@@ -123,7 +122,6 @@ describe('AJV8Validator', () => {
           name: 'John Doe',
         };
 
-        // @ts-expect-error - accessing private Ajv instance to verify compilation happens once
         const ajvInstance = validator.ajv;
         const originalGetSchema = ajvInstance.getSchema.bind(ajvInstance);
         const getSchemaSpy = jest.spyOn(ajvInstance, 'getSchema');
@@ -345,7 +343,6 @@ describe('AJV8Validator', () => {
             },
           };
 
-          // @ts-expect-error - accessing private Ajv instance to verify compilation happens once
           const compileSpy = jest.spyOn(validator.ajv, 'compile');
           compileSpy.mockClear();
 
@@ -589,7 +586,6 @@ describe('AJV8Validator', () => {
           name: 'John Doe',
         };
 
-        // @ts-expect-error - accessing private Ajv instance to verify compilation happens once
         const addSchemaSpy = jest.spyOn(validator.ajv, 'addSchema');
         addSchemaSpy.mockClear();
 
@@ -803,7 +799,6 @@ describe('AJV8Validator', () => {
             },
           };
 
-          // @ts-expect-error - accessing private Ajv instance to verify compilation happens once
           const compileSpy = jest.spyOn(validator.ajv, 'compile');
           compileSpy.mockClear();
 
@@ -1047,7 +1042,6 @@ describe('AJV8Validator', () => {
           name: 'John Doe',
         };
 
-        // @ts-expect-error - accessing private Ajv instance to verify compilation happens once
         const addSchemaSpy = jest.spyOn(validator.ajv, 'addSchema');
         addSchemaSpy.mockClear();
 
@@ -1449,7 +1443,6 @@ describe('AJV8Validator', () => {
             },
           };
 
-          // @ts-expect-error - accessing private Ajv instance to verify compilation happens once
           const compileSpy = jest.spyOn(validator.ajv, 'compile');
           compileSpy.mockClear();