@adonisjs/http-server 7.0.0-0 → 7.0.0-2

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/exception_handler.ts"],"sourcesContent":["/*\n * @adonisjs/http-server\n *\n * (c) AdonisJS\n *\n * For the full copyright and license information, please view the LICENSE\n * file that was distributed with this source code.\n */\n\nimport is from '@sindresorhus/is'\nimport Macroable from '@poppinss/macroable'\nimport type { Level } from '@adonisjs/logger/types'\n\nimport { parseRange } from './helpers.js'\nimport * as errors from './exceptions.js'\nimport type { HttpContext } from './http_context/main.js'\nimport type { HttpError, StatusPageRange, StatusPageRenderer } from './types/server.js'\n\n/**\n * The base HTTP exception handler one can inherit from to handle\n * HTTP exceptions.\n *\n * The HTTP exception handler has support for\n *\n * - Ability to render exceptions by calling the render method on the exception.\n * - Rendering status pages\n * - Pretty printing errors during development\n * - Transforming errors to JSON or HTML using content negotiation\n * - Reporting errors\n */\nexport class ExceptionHandler extends Macroable {\n  /**\n   * Computed from the status pages property\n   */\n  #expandedStatusPages?: Record<number, StatusPageRenderer>\n\n  /**\n   * Whether or not to render debug info. When set to true, the errors\n   * will have the complete error stack.\n   */\n  protected debug: boolean = process.env.NODE_ENV !== 'production'\n\n  /**\n   * Whether or not to render status pages. When set to true, the unhandled\n   * errors with matching status codes will be rendered using a status\n   * page.\n   */\n  protected renderStatusPages: boolean = process.env.NODE_ENV === 'production'\n\n  /**\n   * A collection of error status code range and the view to render.\n   */\n  protected statusPages: Record<StatusPageRange, StatusPageRenderer> = {}\n\n  /**\n   * Enable/disable errors reporting\n   */\n  protected reportErrors: boolean = true\n\n  /**\n   * An array of exception classes to ignore when\n   * reporting an error\n   */\n  protected ignoreExceptions: any[] = [\n    errors.E_HTTP_EXCEPTION,\n    errors.E_ROUTE_NOT_FOUND,\n    errors.E_CANNOT_LOOKUP_ROUTE,\n    errors.E_HTTP_REQUEST_ABORTED,\n  ]\n\n  /**\n   * An array of HTTP status codes to ignore when reporting\n   * an error\n   */\n  protected ignoreStatuses: number[] = [400, 422, 401]\n\n  /**\n   * An array of error codes to ignore when reporting\n   * an error\n   */\n  protected ignoreCodes: string[] = []\n\n  /**\n   * Expands status pages\n   */\n  #expandStatusPages() {\n    if (!this.#expandedStatusPages) {\n      this.#expandedStatusPages = Object.keys(this.statusPages).reduce(\n        (result, range) => {\n          const renderer = this.statusPages[range as StatusPageRange]\n          result = Object.assign(result, parseRange(range, renderer))\n          return result\n        },\n        {} as Record<number, StatusPageRenderer>\n      )\n    }\n\n    return this.#expandedStatusPages\n  }\n\n  /**\n   * Forcefully tweaking the type of the error object to\n   * have known properties.\n   */\n  #toHttpError(error: unknown): HttpError {\n    const httpError: any = is.object(error) ? error : new Error(String(error))\n    httpError.message = httpError.message || 'Internal server error'\n    httpError.status = httpError.status || 500\n    return httpError\n  }\n\n  /**\n   * Error reporting context\n   */\n  protected context(ctx: HttpContext): any {\n    const requestId = ctx.request.id()\n    return requestId\n      ? {\n          'x-request-id': requestId,\n        }\n      : {}\n  }\n\n  /**\n   * Returns the log level for an error based upon the error\n   * status code.\n   */\n  protected getErrorLogLevel(error: HttpError): Level {\n    if (error.status >= 500) {\n      return 'error'\n    }\n\n    if (error.status >= 400) {\n      return 'warn'\n    }\n\n    return 'info'\n  }\n\n  /**\n   * A boolean to control if errors should be rendered with\n   * all the available debugging info.\n   */\n  protected isDebuggingEnabled(_: HttpContext): boolean {\n    return this.debug\n  }\n\n  /**\n   * Returns a boolean by checking if an error should be reported.\n   */\n  protected shouldReport(error: HttpError): boolean {\n    if (this.reportErrors === false) {\n      return false\n    }\n\n    if (this.ignoreStatuses.includes(error.status)) {\n      return false\n    }\n\n    if (error.code && this.ignoreCodes.includes(error.code)) {\n      return false\n    }\n\n    if (this.ignoreExceptions.find((exception) => error instanceof exception)) {\n      return false\n    }\n\n    return true\n  }\n\n  /**\n   * Renders an error to JSON response\n   */\n  async renderErrorAsJSON(error: HttpError, ctx: HttpContext) {\n    if (this.isDebuggingEnabled(ctx)) {\n      const { default: Youch } = await import('youch')\n      const json = await new Youch(error, ctx.request.request).toJSON()\n      ctx.response.status(error.status).send(json.error)\n      return\n    }\n\n    ctx.response.status(error.status).send({ message: error.message })\n  }\n\n  /**\n   * Renders an error to JSON API response\n   */\n  async renderErrorAsJSONAPI(error: HttpError, ctx: HttpContext) {\n    if (this.isDebuggingEnabled(ctx)) {\n      const { default: Youch } = await import('youch')\n      const json = await new Youch(error, ctx.request.request).toJSON()\n      ctx.response.status(error.status).send(json.error)\n      return\n    }\n\n    ctx.response.status(error.status).send({\n      errors: [\n        {\n          title: error.message,\n          code: error.code,\n          status: error.status,\n        },\n      ],\n    })\n  }\n\n  /**\n   * Renders an error to HTML response\n   */\n  async renderErrorAsHTML(error: HttpError, ctx: HttpContext) {\n    if (this.isDebuggingEnabled(ctx)) {\n      const { default: Youch } = await import('youch')\n      const html = await new Youch(error, ctx.request.request).toHTML({\n        cspNonce: 'nonce' in ctx.response ? ctx.response.nonce : undefined,\n      })\n      ctx.response.status(error.status).send(html)\n      return\n    }\n\n    ctx.response.status(error.status).send(`<p> ${error.message} </p>`)\n  }\n\n  /**\n   * Renders the validation error message to a JSON\n   * response\n   */\n  async renderValidationErrorAsJSON(error: HttpError, ctx: HttpContext) {\n    ctx.response.status(error.status).send({\n      errors: error.messages,\n    })\n  }\n\n  /**\n   * Renders the validation error message as per JSON API\n   * spec\n   */\n  async renderValidationErrorAsJSONAPI(error: HttpError, ctx: HttpContext) {\n    ctx.response.status(error.status).send({\n      errors: error.messages.map((message: any) => {\n        return {\n          title: message.message,\n          code: message.rule,\n          source: {\n            pointer: message.field,\n          },\n          meta: message.meta,\n        }\n      }),\n    })\n  }\n\n  /**\n   * Renders the validation error as an HTML string\n   */\n  async renderValidationErrorAsHTML(error: HttpError, ctx: HttpContext) {\n    ctx.response\n      .status(error.status)\n      .type('html')\n      .send(\n        error.messages\n          .map((message: any) => {\n            return `${message.field} - ${message.message}`\n          })\n          .join('<br />')\n      )\n  }\n\n  /**\n   * Renders the error to response\n   */\n  renderError(error: HttpError, ctx: HttpContext) {\n    switch (ctx.request.accepts(['html', 'application/vnd.api+json', 'json'])) {\n      case 'application/vnd.api+json':\n        return this.renderErrorAsJSONAPI(error, ctx)\n      case 'json':\n        return this.renderErrorAsJSON(error, ctx)\n      case 'html':\n      default:\n        return this.renderErrorAsHTML(error, ctx)\n    }\n  }\n\n  /**\n   * Renders the validation error to response\n   */\n  renderValidationError(error: HttpError, ctx: HttpContext) {\n    switch (ctx.request.accepts(['html', 'application/vnd.api+json', 'json'])) {\n      case 'application/vnd.api+json':\n        return this.renderValidationErrorAsJSONAPI(error, ctx)\n      case 'json':\n        return this.renderValidationErrorAsJSON(error, ctx)\n      case 'html':\n      default:\n        return this.renderValidationErrorAsHTML(error, ctx)\n    }\n  }\n\n  /**\n   * Reports an error during an HTTP request\n   */\n  async report(error: unknown, ctx: HttpContext) {\n    const httpError = this.#toHttpError(error)\n    if (!this.shouldReport(httpError)) {\n      return\n    }\n\n    if (typeof httpError.report === 'function') {\n      httpError.report(httpError, ctx)\n      return\n    }\n\n    /**\n     * Log the error using the logger\n     */\n    const level = this.getErrorLogLevel(httpError)\n    ctx.logger.log(\n      level,\n      {\n        ...(level === 'error' || level === 'fatal' ? { err: httpError } : {}),\n        ...this.context(ctx),\n      },\n      httpError.message\n    )\n  }\n\n  /**\n   * Handles the error during the HTTP request.\n   */\n  async handle(error: unknown, ctx: HttpContext) {\n    const httpError = this.#toHttpError(error)\n\n    /**\n     * Self handle exception\n     */\n    if (typeof httpError.handle === 'function') {\n      return httpError.handle(httpError, ctx)\n    }\n\n    /**\n     * Handle validation error using the validation error\n     * renderers\n     */\n    if (httpError.code === 'E_VALIDATION_ERROR' && 'messages' in httpError) {\n      return this.renderValidationError(httpError, ctx)\n    }\n\n    /**\n     * Render status page\n     */\n    const statusPages = this.#expandStatusPages()\n    if (this.renderStatusPages && statusPages[httpError.status]) {\n      return statusPages[httpError.status](httpError, ctx)\n    }\n\n    /**\n     * Use the format renderers.\n     */\n    return this.renderError(httpError, ctx)\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AASA,OAAO,QAAQ;AACf,OAAO,eAAe;AAoBf,IAAM,mBAAN,cAA+B,UAAU;AAAA;AAAA;AAAA;AAAA,EAI9C;AAAA;AAAA;AAAA;AAAA;AAAA,EAMU,QAAiB,QAAQ,IAAI,aAAa;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO1C,oBAA6B,QAAQ,IAAI,aAAa;AAAA;AAAA;AAAA;AAAA,EAKtD,cAA2D,CAAC;AAAA;AAAA;AAAA;AAAA,EAK5D,eAAwB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMxB,mBAA0B;AAAA,IAC3B;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMU,iBAA2B,CAAC,KAAK,KAAK,GAAG;AAAA;AAAA;AAAA;AAAA;AAAA,EAMzC,cAAwB,CAAC;AAAA;AAAA;AAAA;AAAA,EAKnC,qBAAqB;AACnB,QAAI,CAAC,KAAK,sBAAsB;AAC9B,WAAK,uBAAuB,OAAO,KAAK,KAAK,WAAW,EAAE;AAAA,QACxD,CAAC,QAAQ,UAAU;AACjB,gBAAM,WAAW,KAAK,YAAY,KAAwB;AAC1D,mBAAS,OAAO,OAAO,QAAQ,WAAW,OAAO,QAAQ,CAAC;AAC1D,iBAAO;AAAA,QACT;AAAA,QACA,CAAC;AAAA,MACH;AAAA,IACF;AAEA,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,aAAa,OAA2B;AACtC,UAAM,YAAiB,GAAG,OAAO,KAAK,IAAI,QAAQ,IAAI,MAAM,OAAO,KAAK,CAAC;AACzE,cAAU,UAAU,UAAU,WAAW;AACzC,cAAU,SAAS,UAAU,UAAU;AACvC,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA,EAKU,QAAQ,KAAuB;AACvC,UAAM,YAAY,IAAI,QAAQ,GAAG;AACjC,WAAO,YACH;AAAA,MACE,gBAAgB;AAAA,IAClB,IACA,CAAC;AAAA,EACP;AAAA;AAAA;AAAA;AAAA;AAAA,EAMU,iBAAiB,OAAyB;AAClD,QAAI,MAAM,UAAU,KAAK;AACvB,aAAO;AAAA,IACT;AAEA,QAAI,MAAM,UAAU,KAAK;AACvB,aAAO;AAAA,IACT;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA,EAMU,mBAAmB,GAAyB;AACpD,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAKU,aAAa,OAA2B;AAChD,QAAI,KAAK,iBAAiB,OAAO;AAC/B,aAAO;AAAA,IACT;AAEA,QAAI,KAAK,eAAe,SAAS,MAAM,MAAM,GAAG;AAC9C,aAAO;AAAA,IACT;AAEA,QAAI,MAAM,QAAQ,KAAK,YAAY,SAAS,MAAM,IAAI,GAAG;AACvD,aAAO;AAAA,IACT;AAEA,QAAI,KAAK,iBAAiB,KAAK,CAAC,cAAc,iBAAiB,SAAS,GAAG;AACzE,aAAO;AAAA,IACT;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,kBAAkB,OAAkB,KAAkB;AAC1D,QAAI,KAAK,mBAAmB,GAAG,GAAG;AAChC,YAAM,EAAE,SAAS,MAAM,IAAI,MAAM,OAAO,OAAO;AAC/C,YAAM,OAAO,MAAM,IAAI,MAAM,OAAO,IAAI,QAAQ,OAAO,EAAE,OAAO;AAChE,UAAI,SAAS,OAAO,MAAM,MAAM,EAAE,KAAK,KAAK,KAAK;AACjD;AAAA,IACF;AAEA,QAAI,SAAS,OAAO,MAAM,MAAM,EAAE,KAAK,EAAE,SAAS,MAAM,QAAQ,CAAC;AAAA,EACnE;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,qBAAqB,OAAkB,KAAkB;AAC7D,QAAI,KAAK,mBAAmB,GAAG,GAAG;AAChC,YAAM,EAAE,SAAS,MAAM,IAAI,MAAM,OAAO,OAAO;AAC/C,YAAM,OAAO,MAAM,IAAI,MAAM,OAAO,IAAI,QAAQ,OAAO,EAAE,OAAO;AAChE,UAAI,SAAS,OAAO,MAAM,MAAM,EAAE,KAAK,KAAK,KAAK;AACjD;AAAA,IACF;AAEA,QAAI,SAAS,OAAO,MAAM,MAAM,EAAE,KAAK;AAAA,MACrC,QAAQ;AAAA,QACN;AAAA,UACE,OAAO,MAAM;AAAA,UACb,MAAM,MAAM;AAAA,UACZ,QAAQ,MAAM;AAAA,QAChB;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,kBAAkB,OAAkB,KAAkB;AAC1D,QAAI,KAAK,mBAAmB,GAAG,GAAG;AAChC,YAAM,EAAE,SAAS,MAAM,IAAI,MAAM,OAAO,OAAO;AAC/C,YAAM,OAAO,MAAM,IAAI,MAAM,OAAO,IAAI,QAAQ,OAAO,EAAE,OAAO;AAAA,QAC9D,UAAU,WAAW,IAAI,WAAW,IAAI,SAAS,QAAQ;AAAA,MAC3D,CAAC;AACD,UAAI,SAAS,OAAO,MAAM,MAAM,EAAE,KAAK,IAAI;AAC3C;AAAA,IACF;AAEA,QAAI,SAAS,OAAO,MAAM,MAAM,EAAE,KAAK,OAAO,MAAM,OAAO,OAAO;AAAA,EACpE;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,4BAA4B,OAAkB,KAAkB;AACpE,QAAI,SAAS,OAAO,MAAM,MAAM,EAAE,KAAK;AAAA,MACrC,QAAQ,MAAM;AAAA,IAChB,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,MAAM,+BAA+B,OAAkB,KAAkB;AACvE,QAAI,SAAS,OAAO,MAAM,MAAM,EAAE,KAAK;AAAA,MACrC,QAAQ,MAAM,SAAS,IAAI,CAAC,YAAiB;AAC3C,eAAO;AAAA,UACL,OAAO,QAAQ;AAAA,UACf,MAAM,QAAQ;AAAA,UACd,QAAQ;AAAA,YACN,SAAS,QAAQ;AAAA,UACnB;AAAA,UACA,MAAM,QAAQ;AAAA,QAChB;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,4BAA4B,OAAkB,KAAkB;AACpE,QAAI,SACD,OAAO,MAAM,MAAM,EACnB,KAAK,MAAM,EACX;AAAA,MACC,MAAM,SACH,IAAI,CAAC,YAAiB;AACrB,eAAO,GAAG,QAAQ,KAAK,MAAM,QAAQ,OAAO;AAAA,MAC9C,CAAC,EACA,KAAK,QAAQ;AAAA,IAClB;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA,EAKA,YAAY,OAAkB,KAAkB;AAC9C,YAAQ,IAAI,QAAQ,QAAQ,CAAC,QAAQ,4BAA4B,MAAM,CAAC,GAAG;AAAA,MACzE,KAAK;AACH,eAAO,KAAK,qBAAqB,OAAO,GAAG;AAAA,MAC7C,KAAK;AACH,eAAO,KAAK,kBAAkB,OAAO,GAAG;AAAA,MAC1C,KAAK;AAAA,MACL;AACE,eAAO,KAAK,kBAAkB,OAAO,GAAG;AAAA,IAC5C;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,sBAAsB,OAAkB,KAAkB;AACxD,YAAQ,IAAI,QAAQ,QAAQ,CAAC,QAAQ,4BAA4B,MAAM,CAAC,GAAG;AAAA,MACzE,KAAK;AACH,eAAO,KAAK,+BAA+B,OAAO,GAAG;AAAA,MACvD,KAAK;AACH,eAAO,KAAK,4BAA4B,OAAO,GAAG;AAAA,MACpD,KAAK;AAAA,MACL;AACE,eAAO,KAAK,4BAA4B,OAAO,GAAG;AAAA,IACtD;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,OAAO,OAAgB,KAAkB;AAC7C,UAAM,YAAY,KAAK,aAAa,KAAK;AACzC,QAAI,CAAC,KAAK,aAAa,SAAS,GAAG;AACjC;AAAA,IACF;AAEA,QAAI,OAAO,UAAU,WAAW,YAAY;AAC1C,gBAAU,OAAO,WAAW,GAAG;AAC/B;AAAA,IACF;AAKA,UAAM,QAAQ,KAAK,iBAAiB,SAAS;AAC7C,QAAI,OAAO;AAAA,MACT;AAAA,MACA;AAAA,QACE,GAAI,UAAU,WAAW,UAAU,UAAU,EAAE,KAAK,UAAU,IAAI,CAAC;AAAA,QACnE,GAAG,KAAK,QAAQ,GAAG;AAAA,MACrB;AAAA,MACA,UAAU;AAAA,IACZ;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,OAAO,OAAgB,KAAkB;AAC7C,UAAM,YAAY,KAAK,aAAa,KAAK;AAKzC,QAAI,OAAO,UAAU,WAAW,YAAY;AAC1C,aAAO,UAAU,OAAO,WAAW,GAAG;AAAA,IACxC;AAMA,QAAI,UAAU,SAAS,wBAAwB,cAAc,WAAW;AACtE,aAAO,KAAK,sBAAsB,WAAW,GAAG;AAAA,IAClD;AAKA,UAAM,cAAc,KAAK,mBAAmB;AAC5C,QAAI,KAAK,qBAAqB,YAAY,UAAU,MAAM,GAAG;AAC3D,aAAO,YAAY,UAAU,MAAM,EAAE,WAAW,GAAG;AAAA,IACrD;AAKA,WAAO,KAAK,YAAY,WAAW,GAAG;AAAA,EACxC;AACF;","names":[]}

package/build/src/cookies/client.d.ts

@@ -0,0 +1,37 @@
+import type { Encryption } from '@adonisjs/encryption';
+/**
+ * Cookie client exposes the API to parse/set AdonisJS cookies
+ * as a client.
+ */
+export declare class CookieClient {
+    #private;
+    constructor(encryption: Encryption);
+    /**
+     * Encrypt a key value pair to be sent in the cookie header
+     */
+    encrypt(key: string, value: any): string | null;
+    /**
+     * Sign a key value pair to be sent in the cookie header
+     */
+    sign(key: string, value: any): string | null;
+    /**
+     * Encode a key value pair to be sent in the cookie header
+     */
+    encode(_: string, value: any): string | null;
+    /**
+     * Unsign a signed cookie value
+     */
+    unsign(key: string, value: string): any;
+    /**
+     * Decrypt an encrypted cookie value
+     */
+    decrypt(key: string, value: string): any;
+    /**
+     * Decode an encoded cookie value
+     */
+    decode(_: string, value: string): any;
+    /**
+     * Parse response cookie
+     */
+    parse(key: string, value: any): any;
+}

package/build/src/cookies/drivers/encrypted.d.ts

@@ -0,0 +1,16 @@
+import type { Encryption } from '@adonisjs/encryption';
+/**
+ * Encrypt a value to be set as cookie
+ */
+export declare function pack(key: string, value: any, encryption: Encryption): null | string;
+/**
+ * Returns a boolean, if the unpack method from this module can attempt
+ * to unpack encrypted value.
+ */
+export declare function canUnpack(encryptedValue: string): boolean;
+/**
+ * Attempts to unpack the encrypted cookie value. Returns null, when fails to do so.
+ * Only call this method, when `canUnpack` returns true, otherwise runtime
+ * exceptions can be raised.
+ */
+export declare function unpack(key: string, encryptedValue: string, encryption: Encryption): null | any;

package/build/src/cookies/drivers/plain.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Encodes a value into a base64 url encoded string to
+ * be set as cookie
+ */
+export declare function pack(value: any): null | string;
+/**
+ * Returns true when this `unpack` method of this module can attempt
+ * to unpack the encode value.
+ */
+export declare function canUnpack(encodedValue: string): boolean;
+/**
+ * Attempts to unpack the value by decoding it. Make sure to call, `canUnpack`
+ * before calling this method
+ */
+export declare function unpack(encodedValue: string): null | any;

package/build/src/cookies/drivers/signed.d.ts

@@ -0,0 +1,16 @@
+import type { Encryption } from '@adonisjs/encryption';
+/**
+ * Signs a value to be shared as a cookie. The signed output has a
+ * hash to verify tampering with the original value
+ */
+export declare function pack(key: string, value: any, encryption: Encryption): null | string;
+/**
+ * Returns a boolean, if the unpack method from this module can attempt
+ * to unpack the signed value.
+ */
+export declare function canUnpack(signedValue: string): boolean;
+/**
+ * Attempts to unpack the signed value. Make sure to call `canUnpack` before
+ * calling this method.
+ */
+export declare function unpack(key: string, signedValue: string, encryption: Encryption): null | any;

package/build/src/cookies/parser.d.ts

@@ -0,0 +1,37 @@
+import type { Encryption } from '@adonisjs/encryption';
+/**
+ * Cookie parser parses the HTTP `cookie` header and collects all cookies
+ * inside an object of `key-value` pair, but doesn't attempt to decrypt
+ * or unsign or decode the individual values.
+ *
+ * The cookie values are lazily decrypted, or unsigned to avoid unncessary
+ * processing, which infact can be used as a means to burden the server
+ * by sending too many cookies which even doesn't belongs to the
+ * server.
+ */
+export declare class CookieParser {
+    #private;
+    constructor(cookieHeader: string, encryption: Encryption);
+    /**
+     * Attempts to decode a cookie by the name. When calling this method,
+     * you are assuming that the cookie was just encoded in the first
+     * place and not signed or encrypted.
+     */
+    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 in the first place.
+     */
+    unsign(key: string): null | any;
+    /**
+     * Attempts to decrypt a cookie by the name. When calling this method,
+     * you are assuming that the cookie was encrypted in the first place.
+     */
+    decrypt(key: string): null | any;
+    /**
+     * Returns an object of cookies key-value pair. Do note, the
+     * cookies are not decoded, unsigned or decrypted inside this
+     * list.
+     */
+    list(): Record<string, any>;
+}

package/build/src/cookies/serializer.d.ts

@@ -0,0 +1,33 @@
+import type { Encryption } from '@adonisjs/encryption';
+import type { CookieOptions } from '../types/response.js';
+/**
+ * Cookies serializer is used to serialize a value to be set on the `Set-Cookie`
+ * header. You can `encode`, `sign` on `encrypt` cookies using the serializer
+ * and then set them individually using the `set-cookie` header.
+ */
+export declare class CookieSerializer {
+    #private;
+    constructor(encryption: Encryption);
+    /**
+     * Encodes value as a plain cookie. By default, the plain value will be converted
+     * to a string using "JSON.stringify" method and then encoded as a base64 string.
+     *
+     * You can disable encoding of the cookie by setting `options.encoded = false`.
+     *
+     * ```ts
+     *  serializer.encode('name', 'virk')
+     * ```
+     */
+    encode(key: string, value: any, options?: Partial<CookieOptions & {
+        encode: boolean;
+    }>): string | null;
+    /**
+     * Sign a key-value pair to a signed cookie. The signed value has a
+     * verification hash attached to it to detect data tampering.
+     */
+    sign(key: string, value: any, options?: Partial<CookieOptions>): string | null;
+    /**
+     * Encrypts a key-value pair to an encrypted cookie.
+     */
+    encrypt(key: string, value: any, options?: Partial<CookieOptions>): string | null;
+}

package/build/src/debug.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="node" resolution-mode="require"/>
+declare const _default: import("util").DebugLogger;
+export default _default;

package/build/src/define_config.d.ts

@@ -0,0 +1,9 @@
+import type { ServerConfig } from './types/server.js';
+type UserDefinedServerConfig = Partial<Omit<ServerConfig, 'trustProxy'> & {
+    trustProxy: ((address: string, distance: number) => boolean) | boolean | string;
+}>;
+/**
+ * Define configuration for the HTTP server
+ */
+export declare function defineConfig(config: UserDefinedServerConfig): ServerConfig;
+export {};

package/build/src/define_middleware.d.ts

@@ -0,0 +1,11 @@
+import type { LazyImport, UnWrapLazyImport } from './types/base.js';
+import type { GetMiddlewareArgs, MiddlewareAsClass, ParsedGlobalMiddleware } from './types/middleware.js';
+/**
+ * Define an collection of named middleware. The collection gets converted
+ * into a collection of factory functions. Calling the function returns
+ * a reference to the executable middleware.
+ */
+export declare function defineNamedMiddleware<NamedMiddleware extends Record<string | number | symbol, LazyImport<MiddlewareAsClass>>>(collection: NamedMiddleware): { [K in keyof NamedMiddleware]: <Args extends GetMiddlewareArgs<UnWrapLazyImport<NamedMiddleware[K]>>>(...args: Args) => {
+    name: K;
+    args: Args[0];
+} & ParsedGlobalMiddleware; };

package/build/src/exception_handler.d.ts

@@ -0,0 +1,113 @@
+import Macroable from '@poppinss/macroable';
+import type { Level } from '@adonisjs/logger/types';
+import type { HttpContext } from './http_context/main.js';
+import type { HttpError, StatusPageRange, StatusPageRenderer } from './types/server.js';
+/**
+ * The base HTTP exception handler one can inherit from to handle
+ * HTTP exceptions.
+ *
+ * The HTTP exception handler has support for
+ *
+ * - Ability to render exceptions by calling the render method on the exception.
+ * - Rendering status pages
+ * - Pretty printing errors during development
+ * - Transforming errors to JSON or HTML using content negotiation
+ * - Reporting errors
+ */
+export declare class ExceptionHandler extends Macroable {
+    #private;
+    /**
+     * Whether or not to render debug info. When set to true, the errors
+     * will have the complete error stack.
+     */
+    protected debug: boolean;
+    /**
+     * Whether or not to render status pages. When set to true, the unhandled
+     * errors with matching status codes will be rendered using a status
+     * page.
+     */
+    protected renderStatusPages: boolean;
+    /**
+     * A collection of error status code range and the view to render.
+     */
+    protected statusPages: Record<StatusPageRange, StatusPageRenderer>;
+    /**
+     * Enable/disable errors reporting
+     */
+    protected reportErrors: boolean;
+    /**
+     * An array of exception classes to ignore when
+     * reporting an error
+     */
+    protected ignoreExceptions: any[];
+    /**
+     * An array of HTTP status codes to ignore when reporting
+     * an error
+     */
+    protected ignoreStatuses: number[];
+    /**
+     * An array of error codes to ignore when reporting
+     * an error
+     */
+    protected ignoreCodes: string[];
+    /**
+     * Error reporting context
+     */
+    protected context(ctx: HttpContext): any;
+    /**
+     * Returns the log level for an error based upon the error
+     * status code.
+     */
+    protected getErrorLogLevel(error: HttpError): Level;
+    /**
+     * A boolean to control if errors should be rendered with
+     * all the available debugging info.
+     */
+    protected isDebuggingEnabled(_: HttpContext): boolean;
+    /**
+     * Returns a boolean by checking if an error should be reported.
+     */
+    protected shouldReport(error: HttpError): boolean;
+    /**
+     * Renders an error to JSON response
+     */
+    renderErrorAsJSON(error: HttpError, ctx: HttpContext): Promise<void>;
+    /**
+     * Renders an error to JSON API response
+     */
+    renderErrorAsJSONAPI(error: HttpError, ctx: HttpContext): Promise<void>;
+    /**
+     * Renders an error to HTML response
+     */
+    renderErrorAsHTML(error: HttpError, ctx: HttpContext): Promise<void>;
+    /**
+     * Renders the validation error message to a JSON
+     * response
+     */
+    renderValidationErrorAsJSON(error: HttpError, ctx: HttpContext): Promise<void>;
+    /**
+     * Renders the validation error message as per JSON API
+     * spec
+     */
+    renderValidationErrorAsJSONAPI(error: HttpError, ctx: HttpContext): Promise<void>;
+    /**
+     * Renders the validation error as an HTML string
+     */
+    renderValidationErrorAsHTML(error: HttpError, ctx: HttpContext): Promise<void>;
+    /**
+     * Renders the error to response
+     */
+    renderError(error: HttpError, ctx: HttpContext): Promise<void>;
+    /**
+     * Renders the validation error to response
+     */
+    renderValidationError(error: HttpError, ctx: HttpContext): Promise<void>;
+    /**
+     * Reports an error during an HTTP request
+     */
+    report(error: unknown, ctx: HttpContext): Promise<void>;
+    /**
+     * Handles the error during the HTTP request.
+     */
+    handle(error: unknown, ctx: HttpContext): Promise<any>;
+}

package/build/src/exceptions.d.ts

@@ -0,0 +1,84 @@
+/// <reference types="node" resolution-mode="require"/>
+import { Exception } from '@poppinss/utils';
+import type { HttpContext } from './http_context/main.js';
+export declare const E_ROUTE_NOT_FOUND: new (args: [method: string, url: string], options?: ErrorOptions | undefined) => Exception;
+export declare const E_CANNOT_LOOKUP_ROUTE: new (args: [routeIdentifier: string], options?: ErrorOptions | undefined) => Exception;
+export declare const E_HTTP_EXCEPTION: {
+    new (message?: string | undefined, options?: (ErrorOptions & {
+        code?: string | undefined;
+        status?: number | undefined;
+    }) | undefined): {
+        body: any;
+        name: string;
+        help?: string | undefined;
+        code?: string | undefined;
+        status: number;
+        toString(): string;
+        readonly [Symbol.toStringTag]: string;
+        message: string;
+        stack?: string | undefined;
+        cause?: unknown;
+    };
+    code: string;
+    /**
+     * This method returns an instance of the exception class
+     */
+    invoke(body: any, status: number, code?: string): {
+        body: any;
+        name: string;
+        help?: string | undefined;
+        code?: string | undefined;
+        status: number;
+        toString(): string;
+        readonly [Symbol.toStringTag]: string;
+        message: string;
+        stack?: string | undefined;
+        cause?: unknown;
+    };
+    help?: string | undefined;
+    status?: number | undefined;
+    message?: string | undefined;
+    captureStackTrace(targetObject: object, constructorOpt?: Function | undefined): void;
+    prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
+    stackTraceLimit: number;
+};
+export declare const E_HTTP_REQUEST_ABORTED: {
+    new (message?: string | undefined, options?: (ErrorOptions & {
+        code?: string | undefined;
+        status?: number | undefined;
+    }) | undefined): {
+        handle(error: any, ctx: HttpContext): void;
+        body: any;
+        name: string;
+        help?: string | undefined;
+        code?: string | undefined;
+        status: number;
+        toString(): string;
+        readonly [Symbol.toStringTag]: string;
+        message: string;
+        stack?: string | undefined;
+        cause?: unknown;
+    };
+    code: string;
+    /**
+     * This method returns an instance of the exception class
+     */
+    invoke(body: any, status: number, code?: string): {
+        body: any;
+        name: string;
+        help?: string | undefined;
+        code?: string | undefined;
+        status: number;
+        toString(): string;
+        readonly [Symbol.toStringTag]: string;
+        message: string;
+        stack?: string | undefined;
+        cause?: unknown;
+    };
+    help?: string | undefined;
+    status?: number | undefined;
+    message?: string | undefined;
+    captureStackTrace(targetObject: object, constructorOpt?: Function | undefined): void;
+    prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
+    stackTraceLimit: number;
+};

package/build/src/helpers.d.ts

@@ -0,0 +1,23 @@
+import { Route } from './router/route.js';
+import { BriskRoute } from './router/brisk.js';
+import { RouteGroup } from './router/group.js';
+import type { RouteJSON } from './types/route.js';
+import { RouteResource } from './router/resource.js';
+/**
+ * Makes input string consistent by having only the starting
+ * slash
+ */
+export declare function dropSlash(input: string): string;
+/**
+ * Returns a flat list of routes from the route groups and resources
+ */
+export declare function toRoutesJSON(routes: (RouteGroup | Route | RouteResource | BriskRoute)[]): RouteJSON[];
+/**
+ * Helper to know if the remote address should
+ * be trusted.
+ */
+export declare function trustProxy(remoteAddress: string, proxyFn: (addr: string, distance: number) => boolean): boolean;
+/**
+ * Parses a range expression to an object filled with the range
+ */
+export declare function parseRange<T>(range: string, value: T): Record<number, T>;

package/build/src/http_context/local_storage.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="node" resolution-mode="require"/>
+import { AsyncLocalStorage } from 'node:async_hooks';
+import type { HttpContext } from './main.js';
+/**
+ * Async local storage for HTTP context
+ */
+export declare const asyncLocalStorage: {
+    isEnabled: boolean;
+    storage: null | AsyncLocalStorage<HttpContext>;
+    create(): AsyncLocalStorage<HttpContext>;
+    destroy(): void;
+};

package/build/src/http_context/main.d.ts

@@ -0,0 +1,58 @@
+import Macroable from '@poppinss/macroable';
+import type { Logger } from '@adonisjs/logger';
+import { ContainerResolver } from '@adonisjs/fold';
+import type { Request } from '../request.js';
+import type { Response } from '../response.js';
+import type { StoreRouteNode } from '../types/route.js';
+/**
+ * Http context encapsulates properties for a given HTTP request. The
+ * context class can be extended using macros and getters.
+ */
+export declare class HttpContext extends Macroable {
+    request: Request;
+    response: Response;
+    logger: Logger;
+    containerResolver: ContainerResolver<any>;
+    /**
+     * Find if async localstorage is enabled for HTTP requests
+     * or not
+     */
+    static get usingAsyncLocalStorage(): boolean;
+    /**
+     * Get access to the HTTP context. Available only when
+     * "usingAsyncLocalStorage" is true
+     */
+    static get(): HttpContext | null;
+    /**
+     * Get the HttpContext instance or raise an exception if not
+     * available
+     */
+    static getOrFail(): HttpContext;
+    /**
+     * Run a method that doesn't have access to HTTP context from
+     * the async local storage.
+     */
+    static runOutsideContext<T>(callback: (...args: any[]) => T, ...args: any[]): T;
+    /**
+     * Reference to the current route. Not available inside
+     * server middleware
+     */
+    route?: StoreRouteNode;
+    /**
+     * A unique key for the current route
+     */
+    routeKey?: string;
+    /**
+     * Route params
+     */
+    params: Record<string, any>;
+    /**
+     * Route subdomains
+     */
+    subdomains: Record<string, any>;
+    constructor(request: Request, response: Response, logger: Logger, containerResolver: ContainerResolver<any>);
+    /**
+     * A helper to see top level properties on the context object
+     */
+    inspect(): string;
+}

package/build/src/qs.d.ts

@@ -0,0 +1,11 @@
+import { QSParserConfig } from './types/qs.js';
+/**
+ * Query string parser used to parse and stringify query
+ * strings.
+ */
+export declare class Qs {
+    #private;
+    constructor(config: QSParserConfig);
+    parse(value: string): import("qs").ParsedQs;
+    stringify(value: any): string;
+}

package/build/src/redirect.d.ts

@@ -0,0 +1,42 @@
+/// <reference types="node" resolution-mode="require"/>
+import type { IncomingMessage } from 'node:http';
+import type { Qs } from './qs.js';
+import type { Response } from './response.js';
+import type { Router } from './router/main.js';
+import type { MakeUrlOptions } from './types/route.js';
+/**
+ * Exposes the API to construct redirect routes
+ */
+export declare class Redirect {
+    #private;
+    constructor(request: IncomingMessage, response: Response, router: Router, qs: Qs);
+    /**
+     * Set a custom status code.
+     */
+    status(statusCode: number): this;
+    /**
+     * Clearing query string values added using the
+     * "withQs" method
+     */
+    clearQs(): this;
+    /**
+     * Define query string for the redirect. Not passing
+     * any value will forward the current request query
+     * string.
+     */
+    withQs(): this;
+    withQs(values: Record<string, any>): this;
+    withQs(name: string, value: any): this;
+    /**
+     * Redirect to the previous path.
+     */
+    back(): void;
+    /**
+     * Redirect the request using a route identifier.
+     */
+    toRoute(routeIdentifier: string, params?: any[] | Record<string, any>, options?: MakeUrlOptions): void;
+    /**
+     * Redirect the request using a path.
+     */
+    toPath(url: string): void;
+}