@adonisjs/http-server 5.10.1 → 5.11.0

package/build/adonis-typings/route.d.ts

@@ -198,6 +198,14 @@ declare module '@ioc:Adonis/Core/Route' {
          * Define controller namespace for a given 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
@@ -242,6 +250,10 @@ declare module '@ioc:Adonis/Core/Route' {
          * Define namespace for all the routes inside a given resource
          */
         namespace(namespace: string): this;
+        /**
+         * Set the param name for a given resource
+         */
+        paramFor(resource: string, param: string): this;
         /**
          * Prepend name to the routes names
          */

package/build/src/Router/Resource.d.ts

@@ -27,6 +27,13 @@ export declare class RouteResource extends Macroable implements RouteResourceCon
     private shallow;
     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;
     /**
      * A copy of routes that belongs to this resource
      */
@@ -77,6 +84,10 @@ export declare class RouteResource extends Macroable implements RouteResourceCon
      * Define namespace for all the routes inside a given resource
      */
     namespace(namespace: string): this;
+    /**
+     * Set the param name for a given resource
+     */
+    paramFor(resource: string, param: string): this;
     /**
      * Prepend name to the routes names
      */

package/build/src/Router/Resource.js

@@ -31,6 +31,13 @@ class RouteResource extends macroable_1.Macroable {
         this.controller = controller;
         this.globalMatchers = globalMatchers;
         this.shallow = shallow;
+        /**
+         * 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.
+         */
+        this.resourceParamNames = {};
         /**
          * A copy of routes that belongs to this resource
          */
@@ -59,8 +66,16 @@ class RouteResource extends macroable_1.Macroable {
         this.resource = this.resource.replace(/^\//, '').replace(/\/$/, '');
         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}/:${helpers_1.string.snakeCase((0, pluralize_1.singular)(token))}_id`)
+            .map((token) => {
+            const paramName = `:${helpers_1.string.snakeCase((0, pluralize_1.singular)(token))}_id`;
+            this.resourceParamNames[token] = paramName;
+            return `${token}/${paramName}`;
+        })
             .join('/')}/${mainResource}`;
         this.makeRoute(fullUrl, ['GET', 'HEAD'], 'index');
         this.makeRoute(`${fullUrl}/create`, ['GET', 'HEAD'], 'create');
@@ -136,6 +151,20 @@ class RouteResource extends macroable_1.Macroable {
         });
         return this;
     }
+    /**
+     * Set the param name for a given resource
+     */
+    paramFor(resource, param) {
+        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
      */

package/build/src/Router/Route.d.ts

@@ -77,7 +77,7 @@ export declare class Route extends Macroable implements RouteContract {
     /**
      * Returns a normalized pattern string by prefixing the `prefix` (if defined).
      */
-    private getPattern;
+    private computePattern;
     /**
      * Define Regex matcher for a given param. If a matcher exists, then we do not
      * override that, since the routes inside a group will set matchers before
@@ -122,6 +122,14 @@ export declare class Route extends Macroable implements RouteContract {
      * Define controller namespace for a given route
      */
     namespace(namespace: string, overwrite?: boolean): this;
+    /**
+     * Get the route pattern
+     */
+    getPattern(): string;
+    /**
+     * Set the route pattern
+     */
+    setPattern(pattern: string): this;
     /**
      * Returns [[RouteDefinition]] that can be passed to the [[Store]] for
      * registering the route

package/build/src/Router/Route.js

@@ -75,7 +75,7 @@ class Route extends macroable_1.Macroable {
     /**
      * Returns a normalized pattern string by prefixing the `prefix` (if defined).
      */
-    getPattern() {
+    computePattern() {
         const pattern = (0, helpers_2.dropSlash)(this.pattern);
         const prefix = this.prefixes
             .slice()
@@ -167,6 +167,19 @@ class Route extends macroable_1.Macroable {
         }
         return this;
     }
+    /**
+     * Get the route pattern
+     */
+    getPattern() {
+        return this.pattern;
+    }
+    /**
+     * Set the route pattern
+     */
+    setPattern(pattern) {
+        this.pattern = pattern;
+        return this;
+    }
     /**
      * Returns [[RouteDefinition]] that can be passed to the [[Store]] for
      * registering the route
@@ -174,7 +187,7 @@ class Route extends macroable_1.Macroable {
     toJSON() {
         return {
             domain: this.routeDomain,
-            pattern: this.getPattern(),
+            pattern: this.computePattern(),
             matchers: this.getMatchers(),
             meta: {
                 namespace: this.routeNamespace,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonisjs/http-server",
-  "version": "5.10.1",
+  "version": "5.11.0",
   "description": "AdonisJS HTTP server with support packed with Routing and Cookies",
   "main": "build/providers/HttpServerProvider.js",
   "files": [
@@ -42,12 +42,12 @@
     "@adonisjs/require-ts": "^2.0.12",
     "@japa/assert": "^1.3.4",
     "@japa/run-failed-tests": "^1.0.7",
-    "@japa/runner": "^2.0.8",
+    "@japa/runner": "^2.0.9",
     "@japa/spec-reporter": "^1.1.12",
     "@poppinss/dev-utils": "^2.0.3",
     "@types/cookie": "^0.5.1",
     "@types/ms": "^0.7.31",
-    "@types/node": "^17.0.35",
+    "@types/node": "^17.0.42",
     "@types/pluralize": "0.0.29",
     "@types/proxy-addr": "^2.0.0",
     "@types/qs": "^6.9.7",
@@ -57,23 +57,23 @@
     "cross-env": "^7.0.3",
     "cz-conventional-changelog": "^3.3.0",
     "del-cli": "^4.0.1",
-    "eslint": "^8.16.0",
+    "eslint": "^8.17.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-adonis": "^2.1.0",
     "eslint-plugin-prettier": "^4.0.0",
-    "fastify": "^3.29.0",
+    "fastify": "^4.0.1",
     "github-label-sync": "^2.2.0",
     "http-status-codes": "^2.2.0",
     "husky": "^8.0.1",
-    "middie": "^6.1.0",
+    "middie": "^7.1.0",
     "mrm": "^4.0.0",
     "np": "^7.6.1",
     "pem": "^1.14.6",
     "prettier": "^2.6.2",
     "reflect-metadata": "^0.1.13",
     "supertest": "^6.2.3",
-    "ts-node": "^10.8.0",
-    "typescript": "^4.7.2"
+    "ts-node": "^10.8.1",
+    "typescript": "^4.7.3"
   },
   "peerDependencies": {
     "@adonisjs/application": "^5.0.0",
@@ -114,7 +114,7 @@
     "on-finished": "^2.4.1",
     "pluralize": "^8.0.0",
     "proxy-addr": "^2.0.7",
-    "qs": "^6.10.3",
+    "qs": "^6.10.5",
     "tmp-cache": "^1.1.0",
     "type-is": "^1.6.18",
     "vary": "^1.1.2"