improvement: improve resource.middleware types

Author: thetutlage

adonis-typings/route.ts

@@ -216,6 +216,15 @@ declare module '@ioc:Adonis/Core/Route' {
 		toJSON(): RouteJSON
 	}
 
+	export type ResourceRouteNames =
+		| 'create'
+		| 'index'
+		| 'store'
+		| 'show'
+		| 'edit'
+		| 'update'
+		| 'destroy'
+
 	/**
 	 * Shape of route resource class
 	 */
@@ -228,12 +237,12 @@ declare module '@ioc:Adonis/Core/Route' {
 		/**
 		 * Register only given routes and remove others
 		 */
-		only(names: string[]): this
+		only(names: ResourceRouteNames[]): this
 
 		/**
 		 * Register all routes, except the one's defined
 		 */
-		except(names: string[]): this
+		except(names: ResourceRouteNames[]): this
 
 		/**
 		 * Register api only routes. The `create` and `edit` routes, which
@@ -244,7 +253,13 @@ declare module '@ioc:Adonis/Core/Route' {
 		/**
 		 * Add middleware to routes inside the resource
 		 */
-		middleware(middleware: { [name: string]: MiddlewareHandler | MiddlewareHandler[] }): this
+		middleware(
+			middleware: {
+				[P in ResourceRouteNames]?: MiddlewareHandler | MiddlewareHandler[]
+			} & {
+				'*'?: MiddlewareHandler | MiddlewareHandler[]
+			}
+		): this
 
 		/**
 		 * Define matcher for params inside the resource

npm-audit.html

@@ -55,7 +55,7 @@ <h5 class="card-title">
                 <div class="card">
                     <div class="card-body">
                         <h5 class="card-title">
-                            July 23rd 2020, 7:09:43 am
+                            July 23rd 2020, 7:24:11 am
                         </h5>
                         <p class="card-text">Last updated</p>
                     </div>

src/Router/Resource.ts

@@ -14,7 +14,7 @@ import { Macroable } from 'macroable'
 import { lodash } from '@poppinss/utils'
 
 import { MiddlewareHandler } from '@ioc:Adonis/Core/Middleware'
-import { RouteMatchers, RouteResourceContract } from '@ioc:Adonis/Core/Route'
+import { RouteMatchers, RouteResourceContract, ResourceRouteNames } from '@ioc:Adonis/Core/Route'
 
 import { Route } from './Route'
 
@@ -58,7 +58,7 @@ export class RouteResource extends Macroable implements RouteResourceContract {
 	/**
 	 * Add a new route for the given pattern, methods and controller action
 	 */
-	private makeRoute(pattern: string, methods: string[], action: string) {
+	private makeRoute(pattern: string, methods: string[], action: ResourceRouteNames) {
 		const route = new Route(pattern, methods, `${this.controller}.${action}`, this.globalMatchers)
 
 		route.as(`${this.resourceName}.${action}`)
@@ -90,7 +90,7 @@ export class RouteResource extends Macroable implements RouteResourceContract {
 	/**
 	 * Filter the routes based on their partial names
 	 */
-	private filter(names: string[], inverse: boolean) {
+	private filter(names: ResourceRouteNames[], inverse: boolean) {
 		return this.routes.filter((route) => {
 			const match = names.find((name) => route.name.endsWith(name))
 			return inverse ? !match : match
@@ -100,15 +100,15 @@ export class RouteResource extends Macroable implements RouteResourceContract {
 	/**
 	 * Register only given routes and remove others
 	 */
-	public only(names: string[]): this {
+	public only(names: ResourceRouteNames[]): this {
 		this.filter(names, true).forEach((route) => (route.deleted = true))
 		return this
 	}
 
 	/**
 	 * Register all routes, except the one's defined
 	 */
-	public except(names: string[]): this {
+	public except(names: ResourceRouteNames[]): this {
 		this.filter(names, false).forEach((route) => (route.deleted = true))
 		return this
 	}
@@ -118,13 +118,19 @@ export class RouteResource extends Macroable implements RouteResourceContract {
 	 * are meant to show forms will not be registered
 	 */
 	public apiOnly(): this {
-		return this.except(['.create', '.edit'])
+		return this.except(['create', 'edit'])
 	}
 
 	/**
 	 * Add middleware to routes inside the resource
 	 */
-	public middleware(middleware: { [name: string]: MiddlewareHandler | MiddlewareHandler[] }): this {
+	public middleware(
+		middleware: {
+			[P in ResourceRouteNames]?: MiddlewareHandler | MiddlewareHandler[]
+		} & {
+			'*'?: MiddlewareHandler | MiddlewareHandler[]
+		}
+	): this {
 		for (let name in middleware) {
 			if (name === '*') {
 				this.routes.forEach((one) => one.middleware(middleware[name]))