feat(providers): ValidationProvider

Signed-off-by: Lexus Drumgold <[email protected]>

Author: unicornware

src/app.module.ts

@@ -9,6 +9,7 @@ import { ConfigModule } from '@nestjs/config'
 import DatabaseModule from './database/database.module'
 import MiddlewareModule from './middleware/middleware.module'
 import { Config } from './models'
+import { RxJSProvider, ValidationProvider } from './providers'
 import { DocsModule, HealthModule } from './subdomains'
 
 /**
@@ -18,6 +19,7 @@ import { DocsModule, HealthModule } from './subdomains'
  */
 @Global()
 @Module({
+  exports: [RxJSProvider],
   imports: [
     ConfigModule.forRoot({
       cache:
@@ -34,7 +36,8 @@ import { DocsModule, HealthModule } from './subdomains'
     DocsModule,
     HealthModule,
     MiddlewareModule
-  ]
+  ],
+  providers: [ValidationProvider, RxJSProvider]
 })
 class AppModule {}
 

src/providers/__tests__/helmet-options.provider.spec.ts

@@ -8,11 +8,15 @@ import { isObjectPlain } from '@flex-development/tutils'
 import TestSubject from '../helmet-options.provider'
 
 describe('unit:providers/HelmetOptionsProvider', () => {
-  it('should provide HELMET_OPTIONS', () => {
-    expect(TestSubject).to.have.property('provide').deep.equal(HELMET_OPTIONS)
+  describe('.provide', () => {
+    it('should provide HELMET_OPTIONS', () => {
+      expect(TestSubject).to.have.property('provide').deep.equal(HELMET_OPTIONS)
+    })
   })
 
-  it('should use HelmetOptions object as value', () => {
-    expect(TestSubject).to.have.property('useValue').satisfy(isObjectPlain)
+  describe('.useValue', () => {
+    it('should use HelmetOptions object', () => {
+      expect(TestSubject).to.have.property('useValue').satisfy(isObjectPlain)
+    })
   })
 })

src/providers/__tests__/rxjs.provider.spec.ts

@@ -8,11 +8,15 @@ import * as rxjs from 'rxjs'
 import TestSubject from '../rxjs.provider'
 
 describe('unit:providers/RxJSProvider', () => {
-  it('should provide RXJS', () => {
-    expect(TestSubject).to.have.property('provide').deep.equal(RXJS)
+  describe('.provide', () => {
+    it('should provide RXJS', () => {
+      expect(TestSubject).to.have.property('provide').deep.equal(RXJS)
+    })
   })
 
-  it('should use value rxjs', () => {
-    expect(TestSubject).to.have.property('useValue').deep.equal(rxjs)
+  describe('.useValue', () => {
+    it('should use rxjs', () => {
+      expect(TestSubject).to.have.property('useValue').deep.equal(rxjs)
+    })
   })
 })

src/providers/__tests__/validation.provider.spec-d.ts

@@ -0,0 +1,15 @@
+/**
+ * @file Type Tests - ValidationProvider
+ * @module sneusers/providers/tests/unit-d/ValidationProvider
+ */
+
+import type { ValidationPipe, ValueProvider } from '@nestjs/common'
+import type TestSubject from '../validation.provider'
+
+describe('unit-d:providers/ValidationProvider', () => {
+  it('should equal type of ValueProvider<ValidationPipe>', () => {
+    expectTypeOf<typeof TestSubject>().toEqualTypeOf<
+      ValueProvider<ValidationPipe>
+    >()
+  })
+})

src/providers/__tests__/validation.provider.spec.ts

@@ -0,0 +1,24 @@
+/**
+ * @file Unit Tests - ValidationProvider
+ * @module sneusers/providers/tests/unit/ValidationProvider
+ */
+
+import { ValidationPipe } from '@nestjs/common'
+import { APP_PIPE } from '@nestjs/core'
+import TestSubject from '../validation.provider'
+
+describe('unit:providers/ValidationProvider', () => {
+  describe('.provide', () => {
+    it('should provide APP_PIPE', () => {
+      expect(TestSubject).to.have.property('provide').deep.equal(APP_PIPE)
+    })
+  })
+
+  describe('.useValue', () => {
+    it('should use ValidationPipe instance', () => {
+      expect(TestSubject)
+        .to.have.property('useValue')
+        .be.instanceof(ValidationPipe)
+    })
+  })
+})

src/providers/index.ts

@@ -6,3 +6,4 @@
 
 export { default as HelmetOptionsProvider } from './helmet-options.provider'
 export { default as RxJSProvider } from './rxjs.provider'
+export { default as ValidationProvider } from './validation.provider'

src/providers/validation.provider.ts

@@ -0,0 +1,34 @@
+/**
+ * @file Providers - ValidationProvider
+ * @module sneusers/providers/ValidationProvider
+ */
+
+import type { ValueProvider } from '@nestjs/common'
+import { HttpStatus, ValidationPipe } from '@nestjs/common'
+import { APP_PIPE } from '@nestjs/core'
+
+/**
+ * Validation provider.
+ *
+ * @see https://docs.nestjs.com/techniques/validation
+ *
+ * @const {ValueProvider<ValidationPipe>} ValidationProvider
+ */
+const ValidationProvider: ValueProvider<ValidationPipe> = {
+  provide: APP_PIPE,
+  useValue: new ValidationPipe({
+    enableDebugMessages: true,
+    errorHttpStatusCode: HttpStatus.BAD_REQUEST,
+    forbidUnknownValues: true,
+    skipNullProperties: false,
+    skipUndefinedProperties: false,
+    stopAtFirstError: false,
+    transform: true,
+    transformOptions: { exposeUnsetFields: false },
+    validateCustomDecorators: true,
+    validationError: { target: false },
+    whitelist: true
+  })
+}
+
+export default ValidationProvider

src/subdomains/docs/docs.module.ts

@@ -4,7 +4,6 @@
  */
 
 import type { IConfig } from '#src/interfaces'
-import { RxJSProvider } from '#src/providers'
 import { HttpModule, type HttpModuleOptions } from '@nestjs/axios'
 import { Module } from '@nestjs/common'
 import { ConfigService } from '@nestjs/config'
@@ -27,8 +26,7 @@ import { DocsController } from './controllers'
         transitional: { clarifyTimeoutError: true, silentJSONParsing: false }
       })
     })
-  ],
-  providers: [RxJSProvider]
+  ]
 })
 class DocsModule extends SwaggerModule {}
 

tsconfig.typecheck.json

@@ -2,6 +2,7 @@
   "compilerOptions": {
     "target": "es2022"
   },
+  "exclude": ["**/coverage", "**/dist", "**/node_modules", "./scratch.ts"],
   "extends": "./tsconfig.json",
   "include": [
     "**/**.cts",