@adonisjs/http-server 5.10.1 → 5.12.0

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

@@ -520,7 +520,7 @@ declare module '@ioc:Adonis/Core/Request' {
          * Returns value for a given key from unsigned cookies. Optional
          * defaultValue is returned when actual value is undefined.
          */
-        plainCookie(key: string, defaultValue?: any): any;
+        plainCookie(key: string, defaultValue?: any, encoded?: boolean): any;
         /**
          * Returns a boolean telling if a signed url as a valid signature
          * or not.

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

@@ -310,7 +310,9 @@ declare module '@ioc:Adonis/Core/Response' {
          * Set unsigned cookie as the response header. The inline options overrides
          * all options from the config (means they are not merged)
          */
-        plainCookie(key: string, value: any, options?: Partial<CookieOptions>): this;
+        plainCookie(key: string, value: any, options?: Partial<CookieOptions & {
+            encoded: boolean;
+        }>): this;
         /**
          * Set unsigned cookie as the response header. The inline options overrides
          * all options from the config (means they are not merged)

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/Cookie/Parser/index.d.ts

@@ -41,7 +41,7 @@ export declare class CookieParser {
      * you are assuming that the cookie was just encoded at the first
      * place and not signed or encrypted.
      */
-    decode(key: string): any | null;
+    decode(key: string, encoded?: boolean): any | null;
     /**
      * Attempts to unsign a cookie by the name. When calling this method,
      * you are assuming that the cookie was signed at the first place.

package/build/src/Cookie/Parser/index.js

@@ -64,7 +64,7 @@ class CookieParser {
      * you are assuming that the cookie was just encoded at the first
      * place and not signed or encrypted.
      */
-    decode(key) {
+    decode(key, encoded = true) {
         /*
          * Ignore when initial value is not defined or null
          */
@@ -88,7 +88,7 @@ class CookieParser {
          * Attempt to unpack and cache it for future. The value is only
          * when value it is not null.
          */
-        const parsed = this.client.decode(key, value);
+        const parsed = encoded ? this.client.decode(key, value) : value;
         if (parsed !== null) {
             cacheObject[key] = parsed;
         }

package/build/src/Cookie/Serializer/index.d.ts

@@ -31,7 +31,9 @@ export declare class CookieSerializer {
      *  serializer.encode('name', 'virk')
      * ```
      */
-    encode(key: string, value: any, options?: Partial<CookieOptions>): string | null;
+    encode(key: string, value: any, options?: Partial<CookieOptions & {
+        encode: boolean;
+    }>): string | null;
     /**
      * Signs the value and returns it back as a url safe string. The signed value
      * has a verification hash attached to it to detect data tampering.

package/build/src/Cookie/Serializer/index.js

@@ -57,7 +57,7 @@ class CookieSerializer {
      * ```
      */
     encode(key, value, options) {
-        const packedValue = this.client.encode(key, value);
+        const packedValue = !(options?.encode ?? true) ? value : this.client.encode(key, value);
         if (packedValue === null) {
             return null;
         }

package/build/src/Request/index.d.ts

@@ -593,7 +593,7 @@ export declare class Request extends Macroable implements RequestContract {
      * Returns value for a given key from unsigned cookies. Optional
      * defaultValue is returned when actual value is undefined.
      */
-    plainCookie(key: string, defaultValue?: string): any;
+    plainCookie(key: string, defaultValue?: string, encoded?: boolean): any;
     /**
      * Returns a boolean telling if a signed url as a valid signature
      * or not.

package/build/src/Request/index.js

@@ -811,9 +811,9 @@ class Request extends macroable_1.Macroable {
      * Returns value for a given key from unsigned cookies. Optional
      * defaultValue is returned when actual value is undefined.
      */
-    plainCookie(key, defaultValue) {
+    plainCookie(key, defaultValue, encoded) {
         this.initiateCookieParser();
-        return this.cookieParser.decode(key) || defaultValue;
+        return this.cookieParser.decode(key, encoded) || defaultValue;
     }
     /**
      * Returns a boolean telling if a signed url as a valid signature

package/build/src/Response/index.d.ts

@@ -350,7 +350,9 @@ export declare class Response extends Macroable implements ResponseContract {
      * Set unsigned cookie as the response header. The inline options overrides
      * all options from the config (means they are not merged)
      */
-    plainCookie(key: string, value: any, options?: Partial<CookieOptions>): this;
+    plainCookie(key: string, value: any, options?: Partial<CookieOptions & {
+        encode: boolean;
+    }>): this;
     /**
      * Set unsigned cookie as the response header. The inline options overrides
      * all options from the config (means they are not merged)

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/build/src/Server/PreCompiler/index.js

@@ -110,8 +110,10 @@ class PreCompiler {
                 error.help = exceptions_json_1.E_MISSING_NAMED_MIDDLEWARE.help.join('\n');
                 throw error;
             }
-            resolvedMiddleware.args = args;
-            return resolvedMiddleware;
+            return {
+                ...resolvedMiddleware,
+                args,
+            };
         });
     }
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonisjs/http-server",
-  "version": "5.10.1",
+  "version": "5.12.0",
   "description": "AdonisJS HTTP server with support packed with Routing and Cookies",
   "main": "build/providers/HttpServerProvider.js",
   "files": [
@@ -39,41 +39,41 @@
     "@adonisjs/application": "^5.2.5",
     "@adonisjs/encryption": "^4.0.8",
     "@adonisjs/mrm-preset": "^5.0.3",
-    "@adonisjs/require-ts": "^2.0.12",
-    "@japa/assert": "^1.3.4",
-    "@japa/run-failed-tests": "^1.0.7",
-    "@japa/runner": "^2.0.8",
-    "@japa/spec-reporter": "^1.1.12",
+    "@adonisjs/require-ts": "^2.0.13",
+    "@japa/assert": "^1.3.6",
+    "@japa/run-failed-tests": "^1.1.0",
+    "@japa/runner": "^2.2.2",
+    "@japa/spec-reporter": "^1.3.2",
     "@poppinss/dev-utils": "^2.0.3",
     "@types/cookie": "^0.5.1",
     "@types/ms": "^0.7.31",
-    "@types/node": "^17.0.35",
+    "@types/node": "^18.11.0",
     "@types/pluralize": "0.0.29",
     "@types/proxy-addr": "^2.0.0",
     "@types/qs": "^6.9.7",
     "@types/supertest": "^2.0.12",
-    "autocannon": "^7.9.0",
-    "commitizen": "^4.2.4",
+    "autocannon": "^7.10.0",
+    "commitizen": "^4.2.5",
     "cross-env": "^7.0.3",
     "cz-conventional-changelog": "^3.3.0",
-    "del-cli": "^4.0.1",
-    "eslint": "^8.16.0",
+    "del-cli": "^5.0.0",
+    "eslint": "^8.25.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-adonis": "^2.1.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "fastify": "^3.29.0",
+    "eslint-plugin-adonis": "^2.1.1",
+    "eslint-plugin-prettier": "^4.2.1",
+    "fastify": "^4.9.0",
     "github-label-sync": "^2.2.0",
     "http-status-codes": "^2.2.0",
     "husky": "^8.0.1",
-    "middie": "^6.1.0",
-    "mrm": "^4.0.0",
-    "np": "^7.6.1",
+    "middie": "^7.1.0",
+    "mrm": "^4.1.7",
+    "np": "^7.6.2",
     "pem": "^1.14.6",
-    "prettier": "^2.6.2",
+    "prettier": "^2.7.1",
     "reflect-metadata": "^0.1.13",
-    "supertest": "^6.2.3",
-    "ts-node": "^10.8.0",
-    "typescript": "^4.7.2"
+    "supertest": "^6.3.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.8.4"
   },
   "peerDependencies": {
     "@adonisjs/application": "^5.0.0",
@@ -98,7 +98,7 @@
   },
   "dependencies": {
     "@poppinss/matchit": "^3.1.2",
-    "@poppinss/utils": "^4.0.4",
+    "@poppinss/utils": "^5.0.0",
     "accepts": "^1.3.8",
     "co-compose": "^7.0.2",
     "content-disposition": "^0.5.4",
@@ -108,13 +108,13 @@
     "etag": "^1.8.1",
     "fresh": "^0.5.2",
     "haye": "^3.0.0",
-    "macroable": "^7.0.1",
+    "macroable": "^7.0.2",
     "mime-types": "^2.1.35",
     "ms": "^2.1.3",
     "on-finished": "^2.4.1",
     "pluralize": "^8.0.0",
     "proxy-addr": "^2.0.7",
-    "qs": "^6.10.3",
+    "qs": "^6.11.0",
     "tmp-cache": "^1.1.0",
     "type-is": "^1.6.18",
     "vary": "^1.1.2"