feat: add HTTP transformers

Author: thetutlage

modules/http/request_validator.ts

@@ -76,7 +76,7 @@ export class RequestValidator {
    *     name: vine.string().minLength(3)
    *   })
    * )
-   * 
+   *
    * const data = await request.validateUsing(createUserValidator, {
    *   errorReporter: () => vine.errors.SimpleErrorReporter,
    *   messagesProvider: customMessages

modules/transformers/main.ts

@@ -0,0 +1,10 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export * from '@adonisjs/http-transformers'

package.json

@@ -56,6 +56,7 @@
     "./http": "./build/modules/http/main.js",
     "./logger": "./build/modules/logger.js",
     "./repl": "./build/modules/repl.js",
+    "./transformers": "./build/modules/transformers/main.js",
     "./package.json": "./package.json",
     "./exceptions": "./build/src/exceptions.js",
     "./test_utils": "./build/src/test_utils/main.js",
@@ -130,6 +131,7 @@
     "@adonisjs/hash": "^10.0.0-next.1",
     "@adonisjs/health": "^3.0.0-next.0",
     "@adonisjs/http-server": "^8.0.0-next.6",
+    "@adonisjs/http-transformers": "^1.1.0",
     "@adonisjs/logger": "^7.1.0-next.0",
     "@adonisjs/repl": "^5.0.0-next.0",
     "@poppinss/colors": "^4.1.5",

providers/app_provider.ts

@@ -14,12 +14,24 @@ import { Config } from '../modules/config.ts'
 import { Logger } from '../modules/logger.ts'
 import { Application } from '../modules/app.ts'
 import { Dumper } from '../modules/dumper/dumper.ts'
+import { HttpContext } from '../modules/http/main.ts'
 import { Encryption } from '../modules/encryption.ts'
 import { Router, Server } from '../modules/http/main.ts'
 import { BaseEvent, Emitter } from '../modules/events.ts'
+import { transform } from '../modules/transformers/main.ts'
+import { type TransformFn } from '../types/transformers.ts'
 import type { ApplicationService, LoggerService } from '../src/types.ts'
 import BodyParserMiddleware from '../modules/bodyparser/bodyparser_middleware.ts'
 
+/**
+ * Extend HTTP request class with the transform method
+ */
+declare module '@adonisjs/core/http' {
+  export interface HttpContext {
+    transform: TransformFn
+  }
+}
+
 /**
  * The Application Service provider registers all the baseline
  * features required to run the framework.
@@ -170,7 +182,7 @@ export default class AppServiceProvider {
    */
   protected async generateRoutesTypes(router: Router) {
     const types = router.generateTypes(4)
-    const outputPath = this.app.makePath('.adonisjs/server/routes.d.ts')
+    const outputPath = this.app.generatedServerPath('routes.d.ts')
 
     await mkdir(dirname(outputPath), { recursive: true })
     await writeFile(
@@ -219,6 +231,9 @@ export default class AppServiceProvider {
 
   async boot() {
     BaseEvent.useEmitter(await this.app.container.make('emitter'))
+    HttpContext.macro('transform', function (this: HttpContext, data, transformer, variant) {
+      return transform(data, transformer, variant, this.containerResolver) as any
+    })
   }
 
   async ready() {

tests/providers.spec.ts

@@ -23,6 +23,7 @@ import { Logger, LoggerManager } from '../modules/logger.ts'
 import { IgnitorFactory } from '../factories/core/ignitor.ts'
 import BodyParserMiddleware from '../modules/bodyparser/bodyparser_middleware.ts'
 import { defineConfig as defineDumperConfig } from '../modules/dumper/define_config.ts'
+import { HttpContext } from '@adonisjs/http-server'
 
 const BASE_URL = new URL('./tmp/', import.meta.url)
 const BASE_PATH = fileURLToPath(BASE_URL)
@@ -313,4 +314,21 @@ test.group('Providers', () => {
       'posts.index',
     ])
   })
+
+  test('add transform method to HTTP context', async ({ assert }) => {
+    const ignitor = new IgnitorFactory()
+      .merge({
+        rcFileContents: defineConfig({
+          providers: [() => import('../providers/app_provider.js')],
+        }),
+      })
+      .withCoreConfig()
+      .create(BASE_URL)
+
+    const app = ignitor.createApp('repl')
+    await app.init()
+    await app.boot()
+
+    assert.isFunction(HttpContext.prototype.transform)
+  })
 })

types/transformers.ts

@@ -0,0 +1,10 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export * from '@adonisjs/http-transformers/types'