feat: add support to rename the resource param names

Author: thetutlage

adonis-typings/route.ts

@@ -228,6 +228,16 @@ declare module '@ioc:Adonis/Core/Route' {
      */
     namespace(namespace: string): this
 
+    /**
+     * Get the route pattern
+     */
+    getPattern(): string
+
+    /**
+     * Update route pattern
+     */
+    setPattern(pattern: string): this
+
     /**
      * Returns [[RouteDefinition]] that can be passed to the [[Store]] for
      * registering the route
@@ -290,6 +300,11 @@ declare module '@ioc:Adonis/Core/Route' {
      */
     namespace(namespace: string): this
 
+    /**
+     * Set the param name for a given resource
+     */
+    paramFor(resource: string, param: string): this
+
     /**
      * Prepend name to the routes names
      */

src/Router/Resource.ts

@@ -37,6 +37,14 @@ export class RouteResource extends Macroable implements RouteResourceContract {
   protected static macros = {}
   protected static getters = {}
 
+  /**
+   * The param names used to create the resource URLs.
+   *
+   * We need these later when someone explicitly wants to remap
+   * param name for a given resource using the "paramFor" method.
+   */
+  private resourceParamNames: Record<string, string> = {}
+
   /**
    * A copy of routes that belongs to this resource
    */
@@ -79,8 +87,18 @@ export class RouteResource extends Macroable implements RouteResourceContract {
     const resourceTokens = this.resource.split('.')
     const mainResource = resourceTokens.pop()!
 
+    /**
+     * The main resource always uses ids
+     */
+    this.resourceParamNames[mainResource] = ':id'
+
     const fullUrl = `${resourceTokens
-      .map((token) => `${token}/:${string.snakeCase(singular(token))}_id`)
+      .map((token) => {
+        const paramName = `:${string.snakeCase(singular(token))}_id`
+        this.resourceParamNames[token] = paramName
+
+        return `${token}/${paramName}`
+      })
       .join('/')}/${mainResource}`
 
     this.makeRoute(fullUrl, ['GET', 'HEAD'], 'index')
@@ -173,6 +191,24 @@ export class RouteResource extends Macroable implements RouteResourceContract {
     return this
   }
 
+  /**
+   * Set the param name for a given resource
+   */
+  public paramFor(resource: string, param: string): this {
+    const existingParam = this.resourceParamNames[resource]
+    this.resourceParamNames[resource] = `:${param}`
+
+    this.routes.forEach((route) => {
+      /**
+       * Update the pattern for the route with the new param name
+       */
+      route.setPattern(
+        route.getPattern().replace(`${resource}/${existingParam}`, `${resource}/:${param}`)
+      )
+    })
+    return this
+  }
+
   /**
    * Prepend name to the routes names
    */

src/Router/Route.ts

@@ -105,7 +105,7 @@ export class Route extends Macroable implements RouteContract {
   /**
    * Returns a normalized pattern string by prefixing the `prefix` (if defined).
    */
-  private getPattern(): string {
+  private computePattern(): string {
     const pattern = dropSlash(this.pattern)
     const prefix = this.prefixes
       .slice()
@@ -208,14 +208,29 @@ export class Route extends Macroable implements RouteContract {
     return this
   }
 
+  /**
+   * Get the route pattern
+   */
+  public getPattern(): string {
+    return this.pattern
+  }
+
+  /**
+   * Set the route pattern
+   */
+  public setPattern(pattern: string): this {
+    this.pattern = pattern
+    return this
+  }
+
   /**
    * Returns [[RouteDefinition]] that can be passed to the [[Store]] for
    * registering the route
    */
   public toJSON(): RouteJSON {
     return {
       domain: this.routeDomain,
-      pattern: this.getPattern(),
+      pattern: this.computePattern(),
       matchers: this.getMatchers(),
       meta: {
         namespace: this.routeNamespace,