refactor: cleanup of interface and types names

Author: thetutlage

adonis-typings/context.ts

@@ -1,7 +1,3 @@
-/**
- * @module @adonisjs/http-server
- */
-
 /*
 * @adonisjs/http-server
 *

adonis-typings/http-server.ts

@@ -1,7 +1,3 @@
-/**
- * @module @adonisjs/http-server
- */
-
 /*
 * @adonisjs/http-server
 *
@@ -13,40 +9,30 @@
 
 declare module '@ioc:Adonis/Core/Server' {
   import { Server as HttpsServer } from 'https'
-  import { RequestConfigContract } from '@ioc:Adonis/Core/Request'
-  import { ResponseConfigContract } from '@ioc:Adonis/Core/Response'
+  import { RouterContract } from '@ioc:Adonis/Core/Route'
+  import { RequestConfig } from '@ioc:Adonis/Core/Request'
+  import { ResponseConfig } from '@ioc:Adonis/Core/Response'
   import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext'
   import { MiddlewareStoreContract } from '@ioc:Adonis/Core/Middleware'
-  import { RouteHandlerNode, RouterContract } from '@ioc:Adonis/Core/Route'
   import { IncomingMessage, ServerResponse, Server as HttpServer } from 'http'
 
-  export type CookieOptions = {
-    domain: string,
-    expires: Date | (() => Date),
-    httpOnly: boolean,
-    maxAge: number | string,
-    path: string,
-    sameSite: boolean | 'lax' | 'none' | 'strict',
-    secure: boolean,
-  }
-
   /**
    * Before hooks are executed before finding the route or finding
    * middleware
    */
-  export type HookNode = (ctx: HttpContextContract) => Promise<void>
+  export type HookHandler = (ctx: HttpContextContract) => Promise<void>
 
   /**
    * Error handler node
    */
-  export type ErrorHandlerNode = string | ((error: any, ctx: HttpContextContract) => Promise<any>)
+  export type ErrorHandler = string | ((error: any, ctx: HttpContextContract) => Promise<any>)
 
   /**
    * Shape of resolved error handler node
    */
-  export type ResolvedErrorHandlerNode = {
+  export type ResolvedErrorHandler = {
     type: 'function',
-    value: Exclude<ErrorHandlerNode, string>,
+    value: Exclude<ErrorHandler, string>,
   } | {
     type: 'class',
     value: any,
@@ -57,8 +43,8 @@ declare module '@ioc:Adonis/Core/Server' {
    * the one we want to expose to the end user
    */
   export interface HooksContract {
-    before (cb: HookNode): this
-    after (cb: HookNode): this
+    before (cb: HookHandler): this
+    after (cb: HookHandler): this
   }
 
   /**
@@ -69,15 +55,15 @@ declare module '@ioc:Adonis/Core/Server' {
     router: RouterContract
     hooks: HooksContract
     middleware: MiddlewareStoreContract
-    errorHandler (handler: ErrorHandlerNode): this
+    errorHandler (handler: ErrorHandler): this
     handle (req: IncomingMessage, res: ServerResponse): Promise<void>
     optimize (): void
   }
 
   /**
    * Config requried by request and response
    */
-  export type ServerConfigContract = RequestConfigContract & ResponseConfigContract
+  export type ServerConfig = RequestConfig & ResponseConfig
   const Server: ServerContract
   export default Server
 }

adonis-typings/index.ts

@@ -1,7 +1,3 @@
-/**
- * @module @adonisjs/http-server
- */
-
 /*
 * @adonisjs/http-server
 *

adonis-typings/middleware.ts

@@ -1,7 +1,3 @@
-/**
- * @module @adonisjs/http-server
- */
-
 /*
 * @adonisjs/http-server
 *
@@ -20,17 +16,17 @@ declare module '@ioc:Adonis/Core/Middleware' {
    * Input middleware node must be function or a string pointing
    * to the IoC container
    */
-  export type MiddlewareNode = string | (
+  export type MiddlewareHandler = string | (
     (ctx: HttpContextContract, next: () => Promise<void>, args?: string[]) => Promise<void>
   )
 
   /**
    * Shape of resolved middleware. This information is
    * enough to execute the middleware
    */
-  export type ResolvedMiddlewareNode = {
+  export type ResolvedMiddlewareHandler = {
     type: 'function',
-    value: Exclude<MiddlewareNode, string>,
+    value: Exclude<MiddlewareHandler, string>,
     args: string[],
   } | {
     type: 'autoload' | 'binding',
@@ -44,12 +40,12 @@ declare module '@ioc:Adonis/Core/Middleware' {
    * at runtime
    */
   export interface MiddlewareStoreContract {
-    register (middleware: MiddlewareNode[]): this
-    registerNamed (middleware: { [alias: string]: MiddlewareNode }): this
-    get (): ResolvedMiddlewareNode[]
-    getNamed (name: string): null | ResolvedMiddlewareNode
+    register (middleware: MiddlewareHandler[]): this
+    registerNamed (middleware: { [alias: string]: MiddlewareHandler }): this
+    get (): ResolvedMiddlewareHandler[]
+    getNamed (name: string): null | ResolvedMiddlewareHandler
     invokeMiddleware (
-      middleware: ResolvedMiddlewareNode,
+      middleware: ResolvedMiddlewareHandler,
       params: [HttpContextContract, () => Promise<void>],
     ): Promise<void>
   }

adonis-typings/request.ts

@@ -1,9 +1,5 @@
-/**
- * @module @poppinss/request
- */
-
 /*
-* @poppinss/request
+* @adonisjs/http-server
 *
 * (c) Harminder Virk <[email protected]>
 *
@@ -76,8 +72,7 @@ declare module '@ioc:Adonis/Core/Request' {
   /**
    * Shape of the request config
    */
-  export type RequestConfigContract = {
-    secret?: string,
+  export type RequestConfig = {
     forceContentNegotiationToJSON?: boolean,
     subdomainOffset: number,
     generateRequestId: boolean,
@@ -96,7 +91,7 @@ declare module '@ioc:Adonis/Core/Request' {
       request: IncomingMessage,
       response: ServerResponse,
       encryption: EncryptionContract,
-      config: RequestConfigContract,
+      config: RequestConfig,
     ): RequestContract
   }
 

adonis-typings/response.ts

@@ -1,9 +1,5 @@
-/**
-* @module @poppinss/response
-*/
-
 /*
-* @poppinss/response
+* @adonisjs/http-server
 *
 * (c) Harminder Virk <[email protected]>
 *
@@ -14,9 +10,22 @@
 declare module '@ioc:Adonis/Core/Response' {
   import { ServerResponse, IncomingMessage } from 'http'
   import { MacroableConstructorContract } from 'macroable'
-  import { CookieOptions } from '@ioc:Adonis/Core/Server'
+  import { EncryptionContract } from '@ioc:Adonis/Core/Encryption'
   import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext'
 
+  /**
+   * Cookie options can that can be set on the response
+   */
+  export type CookieOptions = {
+    domain: string,
+    expires: Date | (() => Date),
+    httpOnly: boolean,
+    maxAge: number | string,
+    path: string,
+    sameSite: boolean | 'lax' | 'none' | 'strict',
+    secure: boolean,
+  }
+
   /**
    * Types from which response header can be casted to a
    * string
@@ -101,6 +110,7 @@ declare module '@ioc:Adonis/Core/Response' {
 
     cookie (key: string, value: any, options?: Partial<CookieOptions>): this
     plainCookie (key: string, value: any, options?: Partial<CookieOptions>): this
+    encryptedCookie (key: string, value: any, options?: Partial<CookieOptions>): this
     clearCookie (key: string): this
 
     abort (body: any, status?: number): never
@@ -159,8 +169,7 @@ declare module '@ioc:Adonis/Core/Response' {
   /**
    * Config accepted by response the class
    */
-  export type ResponseConfigContract = {
-    secret?: string,
+  export type ResponseConfig = {
     etag: boolean,
     jsonpCallbackName: string,
     cookie: Partial<CookieOptions>,
@@ -175,7 +184,8 @@ declare module '@ioc:Adonis/Core/Response' {
     new (
       request: IncomingMessage,
       response: ServerResponse,
-      config: ResponseConfigContract,
+      encryption: EncryptionContract,
+      config: ResponseConfig,
     ): ResponseContract
   }