Merge pull request #94 from frouriojs/develop

feat: add response schema and hooks to controller

Author: solufa

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [0.31.0](https://github.com/frouriojs/frourio-express/compare/v0.30.0...v0.31.0) (2022-11-24)
+
+### Features
+
+- feat: add response schema and hooks to controller (https://github.com/frouriojs/frourio-express/pull/94)
+
 ## [0.30.0](https://github.com/frouriojs/frourio-express/compare/v0.29.0...v0.30.0) (2022-11-18)
 
 ### Features

README.md

@@ -1,4 +1,5 @@
 # frourio-express
+
 <br />
 <img src="https://frouriojs.github.io/frourio/assets/images/ogp.png" width="1280" alt="frourio-express" />
 
@@ -33,15 +34,15 @@ We are always forced to write "Two TypeScript".
 We waste a lot of time on dynamic testing using the browser and server.
 
 <div align="center">
-   <img src="https://frourio.io/img/TwoTS.svg" width="1200" alt="Why frourio ?" />
+   <img src="https://frourio.com/img/TwoTS.svg" width="1200" alt="Why frourio ?" />
 </div>
 <br />
 <br />
 
 Frourio-express is a framework for developing web apps quickly and safely in **"One TypeScript"**.
 
 <div align="center">
-   <img src="https://frourio.io/img/OneTS.svg" width="1200" alt="Architecture of create-frourio-app" />
+   <img src="https://frourio.com/img/OneTS.svg" width="1200" alt="Architecture of create-frourio-app" />
 </div>
 <br />
 <br />

__test__/index.spec.ts

@@ -207,18 +207,6 @@ test('POST: formdata', async () => {
 
 test('PUT: zod validations', async () => {
   const port = '3000'
-  const res1 = await fetchClient.$put({
-    query: {
-      requiredNum: 0,
-      requiredNumArr: [],
-      id: '1',
-      disable: 'true',
-      bool: false,
-      boolArray: []
-    },
-    body: { port }
-  })
-  expect(res1.port).toBe(port)
 
   await Promise.all([
     expect(
@@ -248,6 +236,20 @@ test('PUT: zod validations', async () => {
       })
     ).rejects.toHaveProperty('response.status', 400)
   ])
+
+  await expect(
+    fetchClient.put({
+      query: {
+        requiredNum: 0,
+        requiredNumArr: [],
+        id: '1',
+        disable: 'true',
+        bool: false,
+        boolArray: []
+      },
+      body: { port }
+    })
+  ).resolves.toHaveProperty('status', 201)
 })
 
 test('POST: multi file upload', async () => {

jest.config.ts

@@ -5,7 +5,7 @@ import { compilerOptions } from './tsconfig.json'
 const config: Config.InitialOptions = {
   preset: 'ts-jest',
   testEnvironment: 'node',
-  globals: { Blob: {}, 'ts-jest': {} },
+  globals: { Blob: {} },
   moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths, { prefix: '<rootDir>/' }),
   coveragePathIgnorePatterns: ['\\$api.ts', 'dist']
 }

package.json

@@ -7,7 +7,7 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "bin": "bin/index.js",
-  "homepage": "https://frourio.io",
+  "homepage": "https://frourio.com",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/frouriojs/frourio-express.git"
@@ -86,8 +86,8 @@
   "devDependencies": {
     "@aspida/axios": "^1.11.0",
     "@aspida/node-fetch": "^1.11.0",
-    "@types/express": "^4.17.7",
-    "@types/jest": "^26.0.23",
+    "@types/express": "^4.17.14",
+    "@types/jest": "^29.2.3",
     "@types/multer": "^1.4.7",
     "@types/node-fetch": "^2.5.10",
     "@types/rimraf": "^3.0.0",
@@ -114,6 +114,6 @@
     "rimraf": "^3.0.2",
     "ts-jest": "^29.0.3",
     "ts-node": "^10.9.1",
-    "typescript": "^4.8.4"
+    "typescript": "^4.9.3"
   }
 }

servers/all/$server.ts

@@ -8,11 +8,11 @@ import type { Express, RequestHandler, Request } from 'express'
 import express from 'express'
 import type { Options } from 'multer'
 import multer from 'multer'
-import type { Schema } from 'fast-json-stringify'
 import fastJson from 'fast-json-stringify'
 import * as Validators from './validators'
 import type { ReadStream } from 'fs'
 import type { HttpStatusOk, AspidaMethodParams } from 'aspida'
+import type { Schema } from 'fast-json-stringify'
 import type { z } from 'zod'
 import hooksFn0 from './api/hooks'
 import hooksFn1 from './api/empty/hooks'
@@ -35,11 +35,11 @@ import controllerFn9 from './api/users/_userId@number/_name/controller'
 
 export type FrourioOptions = {
   basePath?: string
-  transformer?: ClassTransformOptions | undefined
-  validator?: ValidatorOptions | undefined
-  plainToInstance?: ((cls: new (...args: any[]) => object, object: unknown, options: ClassTransformOptions) => object) | undefined
-  validateOrReject?: ((instance: object, options: ValidatorOptions) => Promise<void>) | undefined
-  multer?: Options | undefined
+  transformer?: ClassTransformOptions
+  validator?: ValidatorOptions
+  plainToInstance?: ((cls: new (...args: any[]) => object, object: unknown, options: ClassTransformOptions) => object)
+  validateOrReject?: ((instance: object, options: ValidatorOptions) => Promise<void>)
+  multer?: Options
 }
 
 export type MulterFile = Express.Multer.File
@@ -97,6 +97,13 @@ type ServerHandlerPromise<T extends AspidaMethodParams, U extends Record<string,
 
 export type ServerMethodHandler<T extends AspidaMethodParams,  U extends Record<string, any> = {}> = ServerHandler<T, U> | ServerHandlerPromise<T, U> | {
   validators?: Partial<{ [Key in keyof RequestParams<T>]?: z.ZodType<RequestParams<T>[Key]>}>
+  schemas?: { response?: { [V in HttpStatusOk]?: Schema }}
+  hooks?: {
+    onRequest?: RequestHandler | RequestHandler[]
+    preParsing?: RequestHandler | RequestHandler[]
+    preValidation?: RequestHandler | RequestHandler[]
+    preHandler?: RequestHandler | RequestHandler[]
+  }
   handler: ServerHandler<T, U> | ServerHandlerPromise<T, U>
 }
 
@@ -255,9 +262,48 @@ const asyncMethodToHandler = (
   }
 }
 
+const methodToHandlerWithSchema = (
+  methodCallback: ServerHandler<any, any>,
+  schema: { [K in HttpStatusOk]?: Schema }
+): RequestHandler => {
+  const stringifySet = Object.entries(schema).reduce(
+    (prev, [key, val]) => ({ ...prev, [key]: fastJson(val!) }),
+    {} as Record<HttpStatusOk, ReturnType<typeof fastJson> | undefined>
+  )
+
+  return (req, res, next) => {
+    try {
+      const data = methodCallback(req as any) as any
+      const stringify = stringifySet[data.status as HttpStatusOk]
+
+      if (stringify) {
+        res.set('content-type', 'application/json; charset=utf-8')
+
+        if (data.headers) {
+          for (const key in data.headers) {
+            res.setHeader(key, data.headers[key])
+          }
+        }
+
+        res.status(data.status).send(stringify(data.body))
+      } else {
+        if (data.headers) {
+          for (const key in data.headers) {
+            res.setHeader(key, data.headers[key])
+          }
+        }
+
+        res.status(data.status).send(data.body)
+      }
+    } catch (e) {
+      next(e)
+    }
+  }
+}
+
 const asyncMethodToHandlerWithSchema = (
   methodCallback: ServerHandlerPromise<any, any>,
-  schema: { [K in HttpStatusOk]?: Schema | undefined }
+  schema: { [K in HttpStatusOk]?: Schema }
 ): RequestHandler => {
   const stringifySet = Object.entries(schema).reduce(
     (prev, [key, val]) => ({ ...prev, [key]: fastJson(val!) }),
@@ -355,8 +401,10 @@ export default (app: Express, options: FrourioOptions = {}) => {
     parseNumberTypeQueryParams([['requiredNum', false, false], ['optionalNum', true, false], ['optionalNumArr', true, true], ['emptyNum', true, false], ['requiredNumArr', false, true]]),
     parseBooleanTypeQueryParams([['bool', false, false], ['optionalBool', true, false], ['boolArray', false, true], ['optionalBoolArray', true, true]]),
     parseJSONBoby,
+    ...controller0.put.hooks.preValidation,
     ...Object.entries(controller0.put.validators).map(([key, validator]) => validatorCompiler(key as 'query' | 'headers' | 'body', validator)),
-    methodToHandler(controller0.put.handler)
+    controller0.put.hooks.preHandler,
+    methodToHandlerWithSchema(controller0.put.handler, controller0.put.schemas.response)
   ])
 
   app.get(`${basePath}/500`, [

servers/all/api/$relay.ts

@@ -7,19 +7,19 @@ import type { ServerMethodHandler } from '../$server'
 import type { Methods } from './'
 
 type Hooks = {
-  onRequest?: RequestHandler | RequestHandler[] | undefined
-  preParsing?: RequestHandler | RequestHandler[] | undefined
-  preValidation?: RequestHandler | RequestHandler[] | undefined
-  preHandler?: RequestHandler | RequestHandler[] | undefined
+  onRequest?: RequestHandler | RequestHandler[]
+  preParsing?: RequestHandler | RequestHandler[]
+  preValidation?: RequestHandler | RequestHandler[]
+  preHandler?: RequestHandler | RequestHandler[]
 }
 
-export function defineResponseSchema<T extends { [U in keyof Methods]?: { [V in HttpStatusOk]?: Schema | undefined } | undefined }>(methods: () => T) {
+export function defineResponseSchema<T extends { [U in keyof Methods]?: { [V in HttpStatusOk]?: Schema }}>(methods: () => T) {
   return methods
 }
 
 export function defineHooks<T extends Hooks>(hooks: (app: Express) => T): (app: Express) => T
 export function defineHooks<T extends Record<string, any>, U extends Hooks>(deps: T, cb: (d: T, app: Express) => U): Injectable<T, [Express], U>
-export function defineHooks<T extends Record<string, any>>(hooks: (app: Express) => Hooks | T, cb?: ((deps: T, app: Express) => Hooks) | undefined) {
+export function defineHooks<T extends Record<string, any>>(hooks: (app: Express) => Hooks | T, cb?: ((deps: T, app: Express) => Hooks)) {
   return cb && typeof hooks !== 'function' ? depend(hooks, cb) : hooks
 }
 
@@ -29,6 +29,6 @@ type ServerMethods = {
 
 export function defineController<M extends ServerMethods>(methods: (app: Express) => M): (app: Express) => M
 export function defineController<M extends ServerMethods, T extends Record<string, any>>(deps: T, cb: (d: T, app: Express) => M): Injectable<T, [Express], M>
-export function defineController<M extends ServerMethods, T extends Record<string, any>>(methods: ((app: Express) => M) | T, cb?: ((deps: T, app: Express) => M) | undefined) {
+export function defineController<M extends ServerMethods, T extends Record<string, any>>(methods: ((app: Express) => M) | T, cb?: ((deps: T, app: Express) => M)) {
   return cb && typeof methods !== 'function' ? depend(methods, cb) : methods
 }

servers/all/api/500/$relay.ts

@@ -7,19 +7,19 @@ import type { ServerMethodHandler } from '../../$server'
 import type { Methods } from './'
 
 type Hooks = {
-  onRequest?: RequestHandler | RequestHandler[] | undefined
-  preParsing?: RequestHandler | RequestHandler[] | undefined
-  preValidation?: RequestHandler | RequestHandler[] | undefined
-  preHandler?: RequestHandler | RequestHandler[] | undefined
+  onRequest?: RequestHandler | RequestHandler[]
+  preParsing?: RequestHandler | RequestHandler[]
+  preValidation?: RequestHandler | RequestHandler[]
+  preHandler?: RequestHandler | RequestHandler[]
 }
 
-export function defineResponseSchema<T extends { [U in keyof Methods]?: { [V in HttpStatusOk]?: Schema | undefined } | undefined }>(methods: () => T) {
+export function defineResponseSchema<T extends { [U in keyof Methods]?: { [V in HttpStatusOk]?: Schema }}>(methods: () => T) {
   return methods
 }
 
 export function defineHooks<T extends Hooks>(hooks: (app: Express) => T): (app: Express) => T
 export function defineHooks<T extends Record<string, any>, U extends Hooks>(deps: T, cb: (d: T, app: Express) => U): Injectable<T, [Express], U>
-export function defineHooks<T extends Record<string, any>>(hooks: (app: Express) => Hooks | T, cb?: ((deps: T, app: Express) => Hooks) | undefined) {
+export function defineHooks<T extends Record<string, any>>(hooks: (app: Express) => Hooks | T, cb?: ((deps: T, app: Express) => Hooks)) {
   return cb && typeof hooks !== 'function' ? depend(hooks, cb) : hooks
 }
 
@@ -29,6 +29,6 @@ type ServerMethods = {
 
 export function defineController<M extends ServerMethods>(methods: (app: Express) => M): (app: Express) => M
 export function defineController<M extends ServerMethods, T extends Record<string, any>>(deps: T, cb: (d: T, app: Express) => M): Injectable<T, [Express], M>
-export function defineController<M extends ServerMethods, T extends Record<string, any>>(methods: ((app: Express) => M) | T, cb?: ((deps: T, app: Express) => M) | undefined) {
+export function defineController<M extends ServerMethods, T extends Record<string, any>>(methods: ((app: Express) => M) | T, cb?: ((deps: T, app: Express) => M)) {
   return cb && typeof methods !== 'function' ? depend(methods, cb) : methods
 }

servers/all/api/controller.ts

@@ -14,42 +14,15 @@ const responseSchema = defineResponseSchema(() => ({
     200: {
       type: 'object',
       properties: {
-        id: {
-          type: 'string'
-        },
-        emptyNum: {
-          type: 'number'
-        },
-        requiredNum: {
-          type: 'number'
-        },
-        requiredNumArr: {
-          type: 'array',
-          items: {
-            type: 'number'
-          }
-        },
-        bool: {
-          type: 'boolean'
-        },
-        optionalBool: {
-          type: 'boolean'
-        },
-        boolArray: {
-          type: 'array',
-          items: {
-            type: 'boolean'
-          }
-        },
-        optionalBoolArray: {
-          type: 'array',
-          items: {
-            type: 'boolean'
-          }
-        },
-        disable: {
-          type: 'string'
-        }
+        id: { type: 'string' },
+        emptyNum: { type: 'number' },
+        requiredNum: { type: 'number' },
+        requiredNumArr: { type: 'array', items: { type: 'number' } },
+        bool: { type: 'boolean' },
+        optionalBool: { type: 'boolean' },
+        boolArray: { type: 'array', items: { type: 'boolean' } },
+        optionalBoolArray: { type: 'array', items: { type: 'boolean' } },
+        disable: { type: 'string' }
       }
     }
   }
@@ -87,6 +60,21 @@ export default defineController(
         }),
         body: z.object({ port: z.string() })
       },
+      schemas: {
+        response: {
+          201: {
+            type: 'object',
+            properties: { id: { type: 'number' }, port: { type: 'string' } }
+          }
+        }
+      },
+      hooks: {
+        preValidation: [],
+        preHandler: (req, _, done) => {
+          console.log(req.method)
+          done()
+        }
+      },
       handler: v => ({
         status: 201,
         body: { id: +v.query.id, port: v.body.port }

servers/all/api/empty/$relay.ts

@@ -7,19 +7,19 @@ import type { ServerMethodHandler } from '../../$server'
 import type { Methods } from './'
 
 type Hooks = {
-  onRequest?: RequestHandler | RequestHandler[] | undefined
-  preParsing?: RequestHandler | RequestHandler[] | undefined
-  preValidation?: RequestHandler | RequestHandler[] | undefined
-  preHandler?: RequestHandler | RequestHandler[] | undefined
+  onRequest?: RequestHandler | RequestHandler[]
+  preParsing?: RequestHandler | RequestHandler[]
+  preValidation?: RequestHandler | RequestHandler[]
+  preHandler?: RequestHandler | RequestHandler[]
 }
 
-export function defineResponseSchema<T extends { [U in keyof Methods]?: { [V in HttpStatusOk]?: Schema | undefined } | undefined }>(methods: () => T) {
+export function defineResponseSchema<T extends { [U in keyof Methods]?: { [V in HttpStatusOk]?: Schema }}>(methods: () => T) {
   return methods
 }
 
 export function defineHooks<T extends Hooks>(hooks: (app: Express) => T): (app: Express) => T
 export function defineHooks<T extends Record<string, any>, U extends Hooks>(deps: T, cb: (d: T, app: Express) => U): Injectable<T, [Express], U>
-export function defineHooks<T extends Record<string, any>>(hooks: (app: Express) => Hooks | T, cb?: ((deps: T, app: Express) => Hooks) | undefined) {
+export function defineHooks<T extends Record<string, any>>(hooks: (app: Express) => Hooks | T, cb?: ((deps: T, app: Express) => Hooks)) {
   return cb && typeof hooks !== 'function' ? depend(hooks, cb) : hooks
 }
 
@@ -29,6 +29,6 @@ type ServerMethods = {
 
 export function defineController<M extends ServerMethods>(methods: (app: Express) => M): (app: Express) => M
 export function defineController<M extends ServerMethods, T extends Record<string, any>>(deps: T, cb: (d: T, app: Express) => M): Injectable<T, [Express], M>
-export function defineController<M extends ServerMethods, T extends Record<string, any>>(methods: ((app: Express) => M) | T, cb?: ((deps: T, app: Express) => M) | undefined) {
+export function defineController<M extends ServerMethods, T extends Record<string, any>>(methods: ((app: Express) => M) | T, cb?: ((deps: T, app: Express) => M)) {
   return cb && typeof methods !== 'function' ? depend(methods, cb) : methods
 }