Merge pull request #6 from frouriojs/develop

chore(release): 0.18.0

Author: solufa

CHANGELOG.md

@@ -2,6 +2,23 @@
 
 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.18.0](https://github.com/frouriojs/frourio-express/compare/v0.17.1...v0.18.0) (2020-10-18)
+
+
+### ⚠ BREAKING CHANGES
+
+* add AdditionalRequest
+
+### Features
+
+* add AdditionalRequest ([766d4c1](https://github.com/frouriojs/frourio-express/commit/766d4c13e7df7ce695c6374c30ce03568eaa81bc))
+
+
+### Documentation
+
+* update benchmarks ([a2a737f](https://github.com/frouriojs/frourio-express/commit/a2a737f795be174eb286d328cbfa33c34017b42f))
+* update README ([538f165](https://github.com/frouriojs/frourio-express/commit/538f165db9087eb52af5a0d21518ddd1acac66e6))
+
 ### [0.17.1](https://github.com/frouriojs/frourio-express/compare/v0.17.0...v0.17.1) (2020-10-11)
 
 

README.md

@@ -23,7 +23,7 @@
   </a>
 </div>
 
-<p align="center">Frourio-express is a perfectly type-checkable REST framework for TypeScript.</p>
+<p align="center">Type safe full stack REST framework, for TypeScript</p>
 <br />
 <br />
 <br />
@@ -67,6 +67,60 @@ Benchmarks taken using https://github.com/frouriojs/benchmarks. This is a
 synthetic, "hello world" benchmark that aims to evaluate the framework
 overhead.
 
+## Breaking change (2020/10/19) :warning:
+
+Since frourio-express >= `0.18.0`, the way to add user properties to the request object has changed.
+
+`server/api/user/hooks.ts`
+
+```ts
+import passport from 'passport'
+import { defineHooks } from './$relay'
+import { getUserIdByToken } from '$/service/user'
+
+// < 0.18.0
+// export type User = {
+//   id: string
+// }
+
+// >= 0.18.0
+export type AdditionalRequest = {
+  user: {
+    id: string
+  }
+}
+
+passport.use(
+  // eslint-disable-next-line
+  new (require('passport-trusted-header').Strategy)(
+    { headers: ['token'] },
+    // eslint-disable-next-line
+    (headers: { token: string }, done: Function) => {
+      done(null, getUserIdByToken(headers.token))
+    }
+  )
+)
+
+export default defineHooks(() => ({
+  onRequest: [
+    passport.initialize(),
+    passport.authenticate('trusted-header', { session: false })
+  ]
+}))
+```
+
+`server/api/user/controller.ts`
+
+```ts
+import { defineController } from './$relay'
+import { getUserNameById } from '$/service/user'
+
+export default defineController(() => ({
+  // user was added by AdditionalRequest of ./hooks.ts
+  get: async ({ user }) => ({ status: 200, body: await getUserNameById(user.id) })
+}))
+```
+
 ## Table of Contents
 
 - [Install](#Install)
@@ -397,9 +451,10 @@ import passport from 'passport'
 import { defineHooks } from './$relay' // '$relay.ts' is automatically generated by frourio-express
 import { getUserIdByToken } from '$/service/user'
 
-// Export the User in hooks.ts to receive the user in controller.ts
-export type User = {
-  id: string
+export type AdditionalRequest = {
+  user: {
+    id: string
+  }
 }
 
 passport.use(
@@ -428,6 +483,7 @@ import { defineController } from './$relay'
 import { getUserNameById } from '$/service/user'
 
 export default defineController(() => ({
+  // user was added by AdditionalRequest of ./hooks.ts
   get: async ({ user }) => ({ status: 200, body: await getUserNameById(user.id) })
 }))
 ```

package.json

@@ -1,7 +1,7 @@
 {
   "name": "frourio-express",
-  "version": "0.17.1",
-  "description": "Perfectly type-checkable REST framework for TypeScript",
+  "version": "0.18.0",
+  "description": "Type safe full stack REST framework, for TypeScript",
   "author": "Solufa <[email protected]>",
   "license": "MIT",
   "main": "dist/index.js",
@@ -83,11 +83,11 @@
     ]
   },
   "dependencies": {
-    "aspida": "^0.22.0",
+    "aspida": "^0.22.1",
     "velona": "^0.5.1"
   },
   "devDependencies": {
-    "@aspida/axios": "^0.12.0",
+    "@aspida/axios": "^0.12.1",
     "@types/express": "^4.17.7",
     "@types/jest": "^26.0.14",
     "@types/multer": "^1.4.4",
@@ -96,7 +96,7 @@
     "axios": "^0.20.0",
     "class-validator": "^0.12.2",
     "eslint": "^7.11.0",
-    "eslint-config-prettier": "^6.12.0",
+    "eslint-config-prettier": "^6.13.0",
     "eslint-config-standard": "^14.1.1",
     "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-jest": "^24.1.0",

servers/all/$server.ts

@@ -7,6 +7,7 @@ import { validateOrReject } from 'class-validator'
 import * as Validators from './validators'
 import hooksFn0 from './api/hooks'
 import hooksFn1 from './api/users/hooks'
+import hooksFn2 from './api/users/_userId@number/_name/hooks'
 import controllerFn0, { hooks as ctrlHooksFn0 } from './api/controller'
 import controllerFn1 from './api/500/controller'
 import controllerFn2 from './api/empty/noEmpty/controller'
@@ -48,11 +49,6 @@ type ServerResponse<K extends AspidaMethodParams> =
     >)
   | PartiallyPartial<BaseResponse<any, any, HttpStatusNoOk>, 'body' | 'headers'>
 
-type ServerValues = {
-  params?: Record<string, any>
-  user?: any
-}
-
 type BlobToFile<T extends AspidaMethodParams> = T['reqFormat'] extends FormData
   ? {
       [P in keyof T['reqBody']]: Required<T['reqBody']>[P] extends Blob
@@ -73,7 +69,7 @@ type RequestParams<T extends AspidaMethodParams> = Pick<{
   headers: Required<T>['reqHeaders'] extends {} | null ? 'headers' : never
 }['query' | 'body' | 'headers']>
 
-export type ServerMethods<T extends AspidaMethods, U extends ServerValues> = {
+export type ServerMethods<T extends AspidaMethods, U extends Record<string, any> = {}> = {
   [K in keyof T]: (
     req: RequestParams<T[K]> & U
   ) => ServerResponse<T[K]> | Promise<ServerResponse<T[K]>>
@@ -193,6 +189,7 @@ export default (app: Express, options: FrourioOptions = {}) => {
   const basePath = options.basePath ?? ''
   const hooks0 = hooksFn0(app)
   const hooks1 = hooksFn1(app)
+  const hooks2 = hooksFn2(app)
   const ctrlHooks0 = ctrlHooksFn0(app)
   const ctrlHooks1 = ctrlHooksFn1(app)
   const controller0 = controllerFn0()
@@ -312,6 +309,7 @@ export default (app: Express, options: FrourioOptions = {}) => {
   app.get(`${basePath}/users/:userId/:name`, [
     ...hooks0.onRequest,
     hooks1.onRequest,
+    hooks2.onRequest,
     hooks0.preParsing,
     createTypedParamsHandler(['userId']),
     methodToHandler(controller9.get)

servers/all/api/$relay.ts

@@ -4,14 +4,13 @@ import { Deps, depend } from 'velona'
 import { ServerMethods } from '../$server'
 import { Methods } from './'
 
-type ControllerMethods = ServerMethods<Methods, {}>
-
-export type Hooks = {
+type Hooks = {
   onRequest?: RequestHandler | RequestHandler[]
   preParsing?: RequestHandler | RequestHandler[]
   preValidation?: RequestHandler | RequestHandler[]
   preHandler?: RequestHandler | RequestHandler[]
 }
+type ControllerMethods = ServerMethods<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: Deps<T>, app: Express) => U): { (app: Express): U; inject(d: Deps<T>): (app: Express) => U }

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

@@ -4,14 +4,13 @@ import { Deps, depend } from 'velona'
 import { ServerMethods } from '../../$server'
 import { Methods } from './'
 
-type ControllerMethods = ServerMethods<Methods, {}>
-
-export type Hooks = {
+type Hooks = {
   onRequest?: RequestHandler | RequestHandler[]
   preParsing?: RequestHandler | RequestHandler[]
   preValidation?: RequestHandler | RequestHandler[]
   preHandler?: RequestHandler | RequestHandler[]
 }
+type ControllerMethods = ServerMethods<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: Deps<T>, app: Express) => U): { (app: Express): U; inject(d: Deps<T>): (app: Express) => U }

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

@@ -4,14 +4,13 @@ import { Deps, depend } from 'velona'
 import { ServerMethods } from '../../$server'
 import { Methods } from './'
 
-type ControllerMethods = ServerMethods<Methods, {}>
-
-export type Hooks = {
+type Hooks = {
   onRequest?: RequestHandler | RequestHandler[]
   preParsing?: RequestHandler | RequestHandler[]
   preValidation?: RequestHandler | RequestHandler[]
   preHandler?: RequestHandler | RequestHandler[]
 }
+type ControllerMethods = ServerMethods<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: Deps<T>, app: Express) => U): { (app: Express): U; inject(d: Deps<T>): (app: Express) => U }

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

@@ -4,14 +4,13 @@ import { Deps, depend } from 'velona'
 import { ServerMethods } from '../../../$server'
 import { Methods } from './'
 
-type ControllerMethods = ServerMethods<Methods, {}>
-
-export type Hooks = {
+type Hooks = {
   onRequest?: RequestHandler | RequestHandler[]
   preParsing?: RequestHandler | RequestHandler[]
   preValidation?: RequestHandler | RequestHandler[]
   preHandler?: RequestHandler | RequestHandler[]
 }
+type ControllerMethods = ServerMethods<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: Deps<T>, app: Express) => U): { (app: Express): U; inject(d: Deps<T>): (app: Express) => U }

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

@@ -4,14 +4,13 @@ import { Deps, depend } from 'velona'
 import { ServerMethods } from '../../$server'
 import { Methods } from './'
 
-type ControllerMethods = ServerMethods<Methods, {}>
-
-export type Hooks = {
+type Hooks = {
   onRequest?: RequestHandler | RequestHandler[]
   preParsing?: RequestHandler | RequestHandler[]
   preValidation?: RequestHandler | RequestHandler[]
   preHandler?: RequestHandler | RequestHandler[]
 }
+type ControllerMethods = ServerMethods<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: Deps<T>, app: Express) => U): { (app: Express): U; inject(d: Deps<T>): (app: Express) => U }

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

@@ -4,14 +4,13 @@ import { Deps, depend } from 'velona'
 import { ServerMethods } from '../../$server'
 import { Methods } from './'
 
-type ControllerMethods = ServerMethods<Methods, {}>
-
-export type Hooks = {
+type Hooks = {
   onRequest?: RequestHandler | RequestHandler[]
   preParsing?: RequestHandler | RequestHandler[]
   preValidation?: RequestHandler | RequestHandler[]
   preHandler?: RequestHandler | RequestHandler[]
 }
+type ControllerMethods = ServerMethods<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: Deps<T>, app: Express) => U): { (app: Express): U; inject(d: Deps<T>): (app: Express) => U }

servers/all/api/texts/_label@string/$relay.ts

@@ -4,18 +4,17 @@ import { Deps, depend } from 'velona'
 import { ServerMethods } from '../../../$server'
 import { Methods } from './'
 
-type ControllerMethods = ServerMethods<Methods, {
-  params: {
-    label: string
-  }
-}>
-
-export type Hooks = {
+type Hooks = {
   onRequest?: RequestHandler | RequestHandler[]
   preParsing?: RequestHandler | RequestHandler[]
   preValidation?: RequestHandler | RequestHandler[]
   preHandler?: RequestHandler | RequestHandler[]
 }
+type ControllerMethods = ServerMethods<Methods, {
+  params: {
+    label: string
+  }
+}>
 
 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: Deps<T>, app: Express) => U): { (app: Express): U; inject(d: Deps<T>): (app: Express) => U }

servers/all/api/texts/sample/$relay.ts

@@ -4,14 +4,13 @@ import { Deps, depend } from 'velona'
 import { ServerMethods } from '../../../$server'
 import { Methods } from './'
 
-type ControllerMethods = ServerMethods<Methods, {}>
-
-export type Hooks = {
+type Hooks = {
   onRequest?: RequestHandler | RequestHandler[]
   preParsing?: RequestHandler | RequestHandler[]
   preValidation?: RequestHandler | RequestHandler[]
   preHandler?: RequestHandler | RequestHandler[]
 }
+type ControllerMethods = ServerMethods<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: Deps<T>, app: Express) => U): { (app: Express): U; inject(d: Deps<T>): (app: Express) => U }

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

@@ -2,19 +2,19 @@
 import { Express, RequestHandler } from 'express'
 import { Deps, depend } from 'velona'
 import { ServerMethods } from '../../$server'
-import { User } from './hooks'
+import { AdditionalRequest as AdditionalRequest0 } from './hooks'
+import { AdditionalRequest as AdditionalRequest1 } from './controller'
 import { Methods } from './'
 
-type ControllerMethods = ServerMethods<Methods, {
-  user: User
-}>
-
-export type Hooks = {
-  onRequest?: RequestHandler | RequestHandler[]
-  preParsing?: RequestHandler | RequestHandler[]
-  preValidation?: RequestHandler | RequestHandler[]
-  preHandler?: RequestHandler | RequestHandler[]
+type AdditionalRequest = AdditionalRequest0 & AdditionalRequest1
+type AddedRequestHandler = RequestHandler extends (req: infer U, ...args: infer V) => infer W ? (req: U & Partial<AdditionalRequest>, ...args: V) => W : never
+type Hooks = {
+  onRequest?: AddedRequestHandler | AddedRequestHandler[]
+  preParsing?: AddedRequestHandler | AddedRequestHandler[]
+  preValidation?: AddedRequestHandler | AddedRequestHandler[]
+  preHandler?: AddedRequestHandler | AddedRequestHandler[]
 }
+type ControllerMethods = ServerMethods<Methods, AdditionalRequest>
 
 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: Deps<T>, app: Express) => U): { (app: Express): U; inject(d: Deps<T>): (app: Express) => U }