@shadow-library/fastify 1.3.0 → 1.4.0

package/README.md

@@ -850,6 +850,55 @@ export class AppModule {}
 - **Database**: Add database connection decorators
 - **Caching**: Configure caching plugins
 
+### Customizing AJV Validation
+
+The module uses [AJV](https://ajv.js.org/) for JSON Schema validation. You can customize the AJV instance by providing custom options or plugins through the `ajv` configuration:
+
+```typescript
+import { Module } from '@shadow-library/app';
+import { FastifyModule } from '@shadow-library/fastify';
+import ajvFormats from 'ajv-formats';
+import ajvKeywords from 'ajv-keywords';
+
+@Module({
+  imports: [
+    FastifyModule.forRoot({
+      controllers: [UserController],
+      ajv: {
+        // Custom AJV options
+        customOptions: {
+          removeAdditional: 'all',
+          coerceTypes: 'array',
+          useDefaults: true,
+        },
+        // AJV plugins - supports both formats:
+        // 1. Just the plugin function (uses empty options)
+        // 2. Tuple of [plugin, options]
+        plugins: [
+          ajvFormats, // Plugin without options
+          [ajvKeywords, { keywords: ['typeof', 'instanceof'] }], // Plugin with options
+        ],
+      },
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+#### AJV Configuration Options
+
+| Option          | Type                                       | Description                                           |
+| --------------- | ------------------------------------------ | ----------------------------------------------------- |
+| `customOptions` | `object`                                   | Custom AJV options to merge with the default settings |
+| `plugins`       | `Array<Plugin \| [Plugin, PluginOptions]>` | Array of AJV plugins to register with both validators |
+
+#### Common Use Cases for AJV Customization:
+
+- **Format Validation**: Add `ajv-formats` for email, uri, date-time validation
+- **Custom Keywords**: Use `ajv-keywords` for additional validation keywords
+- **Strict Mode**: Configure strict schema validation settings
+- **Type Coercion**: Customize how types are coerced during validation
+
 ## Middleware
 
 Create custom middleware by implementing the `Middleware` decorator:

package/cjs/module/fastify.utils.d.ts

@@ -1,9 +1,16 @@
 import { ValidationError } from '@shadow-library/common';
-import { SchemaObject } from 'ajv';
+import Ajv, { SchemaObject } from 'ajv';
 import { FastifyInstance } from 'fastify';
 import { FastifyRouteSchemaDef, FastifySchemaValidationError, FastifyValidationResult, SchemaErrorDataVar } from 'fastify/types/schema';
 import { FastifyConfig, FastifyModuleOptions } from './fastify-module.interface.js';
+/**
+ * Defining types
+ */
+export interface AjvValidators {
+    strictValidator: Ajv;
+    lenientValidator: Ajv;
+}
 export declare const notFoundHandler: () => never;
-export declare function compileValidator(routeSchema: FastifyRouteSchemaDef<SchemaObject>): FastifyValidationResult;
+export declare function compileValidator(routeSchema: FastifyRouteSchemaDef<SchemaObject>, validators: AjvValidators): FastifyValidationResult;
 export declare function formatSchemaErrors(errors: FastifySchemaValidationError[], dataVar: SchemaErrorDataVar): ValidationError;
 export declare function createFastifyInstance(config: FastifyConfig, fastifyFactory?: FastifyModuleOptions['fastifyFactory']): Promise<FastifyInstance>;

package/cjs/module/fastify.utils.js

@@ -18,17 +18,13 @@ const fastify_1 = require("fastify");
  * Importing user defined packages
  */
 const server_error_1 = require("../server.error.js");
-/**
- * Defining types
- */
 /**
  * Declaring the constants
  */
 const keywords = ['x-fastify'];
 const allowedHttpParts = ['body', 'params', 'querystring'];
-const strictValidator = new ajv_1.default({ allErrors: true, useDefaults: true, removeAdditional: true, strict: true, keywords });
-const lenientValidator = new ajv_1.default({ allErrors: true, coerceTypes: true, useDefaults: true, removeAdditional: true, strict: true, keywords });
 const notFoundError = new server_error_1.ServerError(server_error_1.ServerErrorCode.S002);
+const defaultAjvOptions = { allErrors: true, useDefaults: true, removeAdditional: true, strict: true, keywords };
 const notFoundHandler = () => (0, common_1.throwError)(notFoundError);
 exports.notFoundHandler = notFoundHandler;
 function compileSchema(ajv, schema) {
@@ -41,13 +37,13 @@ function compileSchema(ajv, schema) {
     }
     return ajv.getSchema(schema.$id);
 }
-function compileValidator(routeSchema) {
+function compileValidator(routeSchema, validators) {
     (0, node_assert_1.default)(allowedHttpParts.includes(routeSchema.httpPart), `Invalid httpPart: ${routeSchema.httpPart}`);
     if (routeSchema.httpPart === 'body')
-        return compileSchema(strictValidator, routeSchema.schema);
+        return compileSchema(validators.strictValidator, routeSchema.schema);
     if (routeSchema.httpPart === 'params')
-        return compileSchema(lenientValidator, routeSchema.schema);
-    const validate = compileSchema(lenientValidator, routeSchema.schema);
+        return compileSchema(validators.lenientValidator, routeSchema.schema);
+    const validate = compileSchema(validators.lenientValidator, routeSchema.schema);
     return (data) => {
         validate(data);
         for (const error of validate.errors ?? []) {
@@ -78,10 +74,19 @@ function formatSchemaErrors(errors, dataVar) {
 async function createFastifyInstance(config, fastifyFactory) {
     const options = common_1.utils.object.omitKeys(config, ['port', 'host', 'errorHandler', 'responseSchema']);
     const { errorHandler } = config;
+    const strictValidator = new ajv_1.default({ ...defaultAjvOptions, ...config.ajv?.customOptions });
+    const lenientValidator = new ajv_1.default({ ...defaultAjvOptions, coerceTypes: true, ...config.ajv?.customOptions });
+    for (let plugin of config.ajv?.plugins ?? []) {
+        if (typeof plugin === 'function')
+            plugin = [plugin, {}];
+        const [ajvPlugin, options] = plugin;
+        ajvPlugin(strictValidator, options);
+        ajvPlugin(lenientValidator, options);
+    }
     const instance = (0, fastify_1.fastify)(options);
     instance.setSchemaErrorFormatter(formatSchemaErrors);
     instance.setNotFoundHandler(exports.notFoundHandler);
     instance.setErrorHandler(errorHandler.handle.bind(errorHandler));
-    instance.setValidatorCompiler(compileValidator);
+    instance.setValidatorCompiler(routeSchema => compileValidator(routeSchema, { strictValidator, lenientValidator }));
     return fastifyFactory ? await fastifyFactory(instance) : instance;
 }

package/esm/module/fastify.utils.d.ts

@@ -1,9 +1,16 @@
 import { ValidationError } from '@shadow-library/common';
-import { SchemaObject } from 'ajv';
+import Ajv, { SchemaObject } from 'ajv';
 import { FastifyInstance } from 'fastify';
 import { FastifyRouteSchemaDef, FastifySchemaValidationError, FastifyValidationResult, SchemaErrorDataVar } from 'fastify/types/schema';
 import { FastifyConfig, FastifyModuleOptions } from './fastify-module.interface.js';
+/**
+ * Defining types
+ */
+export interface AjvValidators {
+    strictValidator: Ajv;
+    lenientValidator: Ajv;
+}
 export declare const notFoundHandler: () => never;
-export declare function compileValidator(routeSchema: FastifyRouteSchemaDef<SchemaObject>): FastifyValidationResult;
+export declare function compileValidator(routeSchema: FastifyRouteSchemaDef<SchemaObject>, validators: AjvValidators): FastifyValidationResult;
 export declare function formatSchemaErrors(errors: FastifySchemaValidationError[], dataVar: SchemaErrorDataVar): ValidationError;
 export declare function createFastifyInstance(config: FastifyConfig, fastifyFactory?: FastifyModuleOptions['fastifyFactory']): Promise<FastifyInstance>;

package/esm/module/fastify.utils.js

@@ -9,17 +9,13 @@ import { fastify } from 'fastify';
  * Importing user defined packages
  */
 import { ServerError, ServerErrorCode } from '../server.error.js';
-/**
- * Defining types
- */
 /**
  * Declaring the constants
  */
 const keywords = ['x-fastify'];
 const allowedHttpParts = ['body', 'params', 'querystring'];
-const strictValidator = new Ajv({ allErrors: true, useDefaults: true, removeAdditional: true, strict: true, keywords });
-const lenientValidator = new Ajv({ allErrors: true, coerceTypes: true, useDefaults: true, removeAdditional: true, strict: true, keywords });
 const notFoundError = new ServerError(ServerErrorCode.S002);
+const defaultAjvOptions = { allErrors: true, useDefaults: true, removeAdditional: true, strict: true, keywords };
 export const notFoundHandler = () => throwError(notFoundError);
 function compileSchema(ajv, schema) {
     if (!schema.$id)
@@ -31,13 +27,13 @@ function compileSchema(ajv, schema) {
     }
     return ajv.getSchema(schema.$id);
 }
-export function compileValidator(routeSchema) {
+export function compileValidator(routeSchema, validators) {
     assert(allowedHttpParts.includes(routeSchema.httpPart), `Invalid httpPart: ${routeSchema.httpPart}`);
     if (routeSchema.httpPart === 'body')
-        return compileSchema(strictValidator, routeSchema.schema);
+        return compileSchema(validators.strictValidator, routeSchema.schema);
     if (routeSchema.httpPart === 'params')
-        return compileSchema(lenientValidator, routeSchema.schema);
-    const validate = compileSchema(lenientValidator, routeSchema.schema);
+        return compileSchema(validators.lenientValidator, routeSchema.schema);
+    const validate = compileSchema(validators.lenientValidator, routeSchema.schema);
     return (data) => {
         validate(data);
         for (const error of validate.errors ?? []) {
@@ -68,10 +64,19 @@ export function formatSchemaErrors(errors, dataVar) {
 export async function createFastifyInstance(config, fastifyFactory) {
     const options = utils.object.omitKeys(config, ['port', 'host', 'errorHandler', 'responseSchema']);
     const { errorHandler } = config;
+    const strictValidator = new Ajv({ ...defaultAjvOptions, ...config.ajv?.customOptions });
+    const lenientValidator = new Ajv({ ...defaultAjvOptions, coerceTypes: true, ...config.ajv?.customOptions });
+    for (let plugin of config.ajv?.plugins ?? []) {
+        if (typeof plugin === 'function')
+            plugin = [plugin, {}];
+        const [ajvPlugin, options] = plugin;
+        ajvPlugin(strictValidator, options);
+        ajvPlugin(lenientValidator, options);
+    }
     const instance = fastify(options);
     instance.setSchemaErrorFormatter(formatSchemaErrors);
     instance.setNotFoundHandler(notFoundHandler);
     instance.setErrorHandler(errorHandler.handle.bind(errorHandler));
-    instance.setValidatorCompiler(compileValidator);
+    instance.setValidatorCompiler(routeSchema => compileValidator(routeSchema, { strictValidator, lenientValidator }));
     return fastifyFactory ? await fastifyFactory(instance) : instance;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shadow-library/fastify",
   "type": "module",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "sideEffects": false,
   "description": "A Fastify wrapper featuring decorator-based routing, middleware and error handling",
   "repository": {