@adonisjs/http-server 6.8.2-1 → 6.8.2-10

package/build/src/types/qs.d.ts

@@ -1,15 +1,68 @@
 export type QSParserConfig = {
     parse: {
+        /**
+         * Nesting depth till the parameters should be parsed.
+         *
+         * Defaults to 5
+         */
         depth: number;
+        /**
+         * Number of parameters to parse.
+         *
+         * Defaults to 1000
+         */
         parameterLimit: number;
+        /**
+         * Allow sparse elements in an array.
+         *
+         * Defaults to false
+         */
         allowSparse: boolean;
+        /**
+         * The max limimit for the array indices. After the given limit
+         * the array indices will be converted to an object, where the
+         * index is the key.
+         *
+         * Defaults to 20
+         */
         arrayLimit: number;
+        /**
+         * Join comma seperated query string values to an array
+         *
+         * Defaults to false
+         */
         comma: boolean;
     };
     stringify: {
+        /**
+         * URI encode the stringified query string
+         *
+         * Defaults to true
+         */
         encode: boolean;
+        /**
+         * URI encode but only the values and not the keys
+         *
+         * Defaults to false
+         */
         encodeValuesOnly: boolean;
+        /**
+         * Define the format in which arrays should be serialized.
+         *
+         * - indices:   a[0]=b&a[1]=c
+         * - brackets:  a[]=b&a[]=c
+         * - repeat:    a=b&a=c
+         * - comma:     a=b,c
+         *
+         * Defaults to "indices"
+         */
         arrayFormat: 'indices' | 'brackets' | 'repeat' | 'comma';
+        /**
+         * Whether or not to skip null values when serializing. When set to
+         * false, the null values will be treated as an empty string.
+         *
+         * Defaults to: false
+         */
         skipNulls: boolean;
     };
 };

package/build/src/types/qs.js

@@ -1 +1,9 @@
+/*
+ * @adonisjs/http-server
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 export {};

package/build/src/types/request.d.ts

@@ -1,7 +1,39 @@
+/**
+ * Shape of the request config
+ */
 export type RequestConfig = {
+    /**
+     * URL segments to ignore when extracting subdomains from a URL.
+     * Defaults to 2
+     */
     subdomainOffset: number;
+    /**
+     * Enabling the flag will generated a unique request id from every
+     * HTTP request.
+     *
+     * The request id can be accessed using the "request.id()" method. Also,
+     * the value of `x-request-id` header is used as the id (if it exists).
+     *
+     * Defaults to false
+     */
     generateRequestId: boolean;
+    /**
+     * Method spoofing allows changing the request method using the query string.
+     * For example: Making a POST request on URL /users/1?_method=PATCH will
+     * be handled by the patch route.
+     *
+     * Defaults to false
+     */
     allowMethodSpoofing: boolean;
+    /**
+     * A custom implementation to get the request ip address
+     */
     getIp?: (request: any) => string;
+    /**
+     * A callback function to trust proxy ip addresses. You must use
+     * the `proxy-addr` package to compute this value.
+     *
+     * Defaults to: "proxyAddr.compile('loopback')"
+     */
     trustProxy: (address: string, distance: number) => boolean;
 };

package/build/src/types/request.js

@@ -1 +1,9 @@
+/*
+ * @adonisjs/http-server
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 export {};

package/build/src/types/response.d.ts

@@ -1,5 +1,8 @@
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
+/**
+ * Cookie options can that can be set on the response
+ */
 export type CookieOptions = {
     domain: string;
     expires: Date | (() => Date);
@@ -9,10 +12,34 @@ export type CookieOptions = {
     sameSite: boolean | 'lax' | 'none' | 'strict';
     secure: boolean;
 };
+/**
+ * Types from which response header can be casted to a
+ * string
+ */
 export type CastableHeader = string | number | boolean | string[] | number[] | boolean[];
+/**
+ * Config accepted by response the class
+ */
 export type ResponseConfig = {
+    /**
+     * Whether or not to generate etags for responses. Etags can be
+     * enabled/disabled when sending response as well.
+     *
+     * Defaults to false
+     */
     etag: boolean;
+    /**
+     * The callback name for the JSONP response.
+     *
+     * Defaults to 'callback'
+     */
     jsonpCallbackName: string;
+    /**
+     * Options to set cookies
+     */
     cookie: Partial<CookieOptions>;
 };
+/**
+ * Stream that can be piped to the "response.stream" method
+ */
 export type ResponseStream = NodeJS.ReadStream | NodeJS.ReadWriteStream | NodeJS.ReadableStream;

package/build/src/types/response.js

@@ -1 +1,9 @@
+/*
+ * @adonisjs/http-server
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 export {};

package/build/src/types/route.d.ts

@@ -3,32 +3,74 @@ import type { ContainerResolver } from '@adonisjs/fold';
 import type { Constructor, LazyImport } from './base.js';
 import type { HttpContext } from '../http_context/main.js';
 import type { MiddlewareFn, ParsedGlobalMiddleware } from './middleware.js';
+import { ServerErrorHandler } from './server.js';
+/**
+ * Returns a union of methods from a controller that accepts
+ * the context as the first argument.
+ */
 export type GetControllerHandlers<Controller extends Constructor<any>> = {
     [K in keyof InstanceType<Controller>]: InstanceType<Controller>[K] extends (ctx: HttpContext, ...args: any[]) => any ? K : never;
 }[keyof InstanceType<Controller>];
+/**
+ * Route token stored by matchit library
+ */
 export type MatchItRouteToken = RouteMatcher & {
     old: string;
     type: 0 | 1 | 2 | 3;
     val: string;
     end: string;
 };
+/**
+ * Route handler defined as a function
+ */
 export type RouteFn = (ctx: HttpContext) => any;
+/**
+ * Route handler persisted with the route store
+ */
 export type StoreRouteHandler = RouteFn | {
     reference: string | [LazyImport<Constructor<any>> | Constructor<any>, any?];
     handle: (resolver: ContainerResolver<any>, ...args: [ctx: HttpContext, ...injections: any[]]) => any;
 };
+/**
+ * The middleware persisted with the route store
+ */
 export type StoreRouteMiddleware = MiddlewareFn | ({
     name?: string;
     args?: any[];
 } & ParsedGlobalMiddleware);
+/**
+ * Route node persisted within the routes store
+ */
 export type StoreRouteNode = {
-    execute: (route: StoreRouteNode, resolver: ContainerResolver<any>, ctx: HttpContext) => any;
+    /**
+     * The execute function to execute the route middleware
+     * and the handler
+     */
+    execute: (route: StoreRouteNode, resolver: ContainerResolver<any>, ctx: HttpContext, errorResponder: ServerErrorHandler['handle']) => any;
+    /**
+     * A unique name for the route
+     */
     name?: string;
+    /**
+     * Route URI pattern
+     */
     pattern: string;
+    /**
+     * Route handler
+     */
     handler: StoreRouteHandler;
+    /**
+     * Route middleware
+     */
     middleware: Middleware<StoreRouteMiddleware>;
+    /**
+     * Additional metadata associated with the route
+     */
     meta: Record<string, any>;
 };
+/**
+ * An object of routes for a given HTTP method
+ */
 export type StoreMethodNode = {
     tokens: MatchItRouteToken[][];
     routeKeys: {
@@ -38,40 +80,86 @@ export type StoreMethodNode = {
         [pattern: string]: StoreRouteNode;
     };
 };
+/**
+ * Each domain node container an object of methods. Each method
+ * object has nested routes.
+ */
 export type StoreDomainNode = {
     [method: string]: StoreMethodNode;
 };
+/**
+ * Routes tree stored within the routes store
+ */
 export type StoreRoutesTree = {
     tokens: MatchItRouteToken[][];
     domains: {
         [domain: string]: StoreDomainNode;
     };
 };
+/**
+ * Shape of the matched route for a pattern, method and domain.
+ */
 export type MatchedRoute = {
     route: StoreRouteNode;
+    /**
+     * A unique key for the looked up route
+     */
     routeKey: string;
+    /**
+     * Route params
+     */
     params: Record<string, any>;
+    /**
+     * Route subdomains (if part of a subdomain)
+     */
     subdomains: Record<string, any>;
 };
+/**
+ * Shape of a route param matcher
+ */
 export type RouteMatcher = {
     match?: RegExp;
     cast?: (value: string) => any;
 };
+/**
+ * A collection of route matchers
+ */
 export type RouteMatchers = {
     [param: string]: RouteMatcher;
 };
+/**
+ * Representation of a route as JSON
+ */
 export type RouteJSON = StoreRouteNode & {
+    /**
+     * HTTP methods, the route responds to.
+     */
     methods: string[];
+    /**
+     * The domain for which the route is registered.
+     */
     domain: string;
+    /**
+     * Matchers for route params.
+     */
     matchers: RouteMatchers;
 };
+/**
+ * Resource action names
+ */
 export type ResourceActionNames = 'create' | 'index' | 'store' | 'show' | 'edit' | 'update' | 'destroy';
+/**
+ * Options accepted by makeUrl method
+ */
 export type MakeUrlOptions = {
     qs?: Record<string, any>;
     domain?: string;
     prefixUrl?: string;
     disableRouteLookup?: boolean;
 };
+/**
+ * Options accepted by makeSignedUrl method
+ */
 export type MakeSignedUrlOptions = MakeUrlOptions & {
     expiresIn?: string | number;
     purpose?: string;

package/build/src/types/route.js

@@ -1 +1,9 @@
+/*
+ * @adonisjs/http-server
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 export {};

package/build/src/types/server.d.ts

@@ -4,6 +4,10 @@ import type { QSParserConfig } from './qs.js';
 import type { RequestConfig } from './request.js';
 import type { ResponseConfig } from './response.js';
 import type { HttpContext } from '../http_context/main.js';
+/**
+ * Normalized HTTP error used by the exception
+ * handler.
+ */
 export type HttpError = {
     message: string;
     status: number;
@@ -15,23 +19,54 @@ export type HttpError = {
     handle?: (...args: any[]) => any;
     report?: (...args: any[]) => any;
 };
+/**
+ * The pipeline for executing middleware during tests
+ */
 export interface TestingMiddlewarePipeline {
     finalHandler(handler: FinalHandler): this;
     errorHandler(handler: ErrorHandler): this;
     run(ctx: HttpContext): Promise<any>;
 }
-export type StatusPageRange = `${number}..${number}`;
+/**
+ * The expression to define a status page range
+ */
+export type StatusPageRange = `${number}..${number}` | `${number}` | number;
+/**
+ * The callback function to render status page for a given
+ * error.
+ */
 export type StatusPageRenderer = (error: HttpError, ctx: HttpContext) => any | Promise<any>;
+/**
+ * Data type for the "http:request_finished" event
+ */
 export type HttpRequestFinishedPayload = {
     ctx: HttpContext;
     duration: [number, number];
 };
+/**
+ * Error handler to handle HTTP errors
+ */
 export type ServerErrorHandler = {
     report: (error: any, ctx: HttpContext) => any;
     handle: (error: any, ctx: HttpContext) => any;
 };
+/**
+ * Error handler represented as a class
+ */
 export type ErrorHandlerAsAClass = Constructor<ServerErrorHandler>;
+/**
+ * Config accepted by the HTTP server
+ */
 export type ServerConfig = RequestConfig & ResponseConfig & {
+    /**
+     * Whether or not to create an async local storage store for
+     * the HTTP context.
+     *
+     * Defaults to false
+     */
     useAsyncLocalStorage: boolean;
+    /**
+     * Config for query string parser
+     */
     qs: QSParserConfig;
 };

package/build/src/types/server.js

@@ -1 +1,9 @@
+/*
+ * @adonisjs/http-server
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonisjs/http-server",
-  "version": "6.8.2-1",
+  "version": "6.8.2-10",
   "description": "AdonisJS HTTP server with support packed with Routing and Cookies",
   "main": "build/index.js",
   "type": "module",
@@ -15,10 +15,14 @@
     "./types": "./build/src/types/main.js",
     "./factories": "./build/factories/main.js"
   },
+  "engines": {
+    "node": ">=18.16.0"
+  },
   "scripts": {
     "pretest": "npm run lint",
-    "test": "cross-env NODE_DEBUG=adonisjs:http c8 npm run vscode:test",
+    "test": "cross-env NODE_DEBUG=adonisjs:http c8 npm run quick:test",
     "clean": "del-cli build",
+    "typecheck": "tsc --noEmit",
     "compile": "npm run lint && npm run clean && tsc",
     "build": "npm run compile",
     "prebenchmark": "npm run build",
@@ -30,7 +34,7 @@
     "lint": "eslint . --ext=.ts",
     "sync-labels": "github-label-sync --labels .github/labels.json adonisjs/http-server",
     "test:watch": "node --watch --loader=ts-node/esm --experimental-import-meta-resolve bin/test.ts",
-    "vscode:test": "node --loader=ts-node/esm --experimental-import-meta-resolve bin/test.ts"
+    "quick:test": "node --loader=ts-node/esm --experimental-import-meta-resolve bin/test.ts"
   },
   "keywords": [
     "http",
@@ -39,20 +43,22 @@
   "author": "virk,adonisjs",
   "license": "MIT",
   "devDependencies": {
-    "@adonisjs/application": "^7.1.2-0",
-    "@adonisjs/encryption": "^5.1.2-0",
-    "@adonisjs/events": "^8.4.9-0",
-    "@adonisjs/fold": "^9.9.3-0",
-    "@adonisjs/logger": "^5.4.2-0",
-    "@commitlint/cli": "^17.4.4",
-    "@commitlint/config-conventional": "^17.4.4",
-    "@fastify/middie": "^8.1.0",
-    "@japa/assert": "^1.4.1",
-    "@japa/expect-type": "^1.0.3",
-    "@japa/run-failed-tests": "^1.1.1",
-    "@japa/runner": "^2.5.1",
-    "@japa/spec-reporter": "^1.3.3",
-    "@swc/core": "^1.3.39",
+    "@adonisjs/application": "^7.1.2-8",
+    "@adonisjs/encryption": "^5.1.2-2",
+    "@adonisjs/eslint-config": "^1.1.8",
+    "@adonisjs/events": "^8.4.9-3",
+    "@adonisjs/fold": "^9.9.3-6",
+    "@adonisjs/logger": "^5.4.2-3",
+    "@adonisjs/prettier-config": "^1.1.8",
+    "@adonisjs/tsconfig": "^1.1.8",
+    "@commitlint/cli": "^17.6.7",
+    "@commitlint/config-conventional": "^17.6.7",
+    "@fastify/middie": "^8.3.0",
+    "@japa/api-client": "^2.0.0-0",
+    "@japa/assert": "^2.0.0-1",
+    "@japa/expect-type": "^2.0.0-0",
+    "@japa/runner": "^3.0.0-5",
+    "@swc/core": "^1.3.70",
     "@types/accepts": "^1.3.5",
     "@types/content-disposition": "^0.5.5",
     "@types/cookie": "^0.5.1",
@@ -63,42 +69,41 @@
     "@types/fs-extra": "^11.0.1",
     "@types/http-status-codes": "^1.2.0",
     "@types/mime-types": "^2.1.1",
-    "@types/node": "^18.15.0",
+    "@types/node": "^20.4.3",
     "@types/on-finished": "^2.3.1",
-    "@types/pem": "^1.9.6",
+    "@types/pem": "^1.14.0",
     "@types/proxy-addr": "^2.0.0",
     "@types/qs": "^6.9.7",
     "@types/supertest": "^2.0.12",
     "@types/type-is": "^1.6.3",
     "@types/vary": "^1.1.0",
-    "autocannon": "^7.10.0",
-    "c8": "^7.13.0",
+    "@vinejs/vine": "^1.5.2",
+    "autocannon": "^7.11.0",
+    "c8": "^8.0.0",
     "cross-env": "^7.0.3",
     "del-cli": "^5.0.0",
-    "eslint": "^8.36.0",
-    "eslint-config-prettier": "^8.7.0",
-    "eslint-plugin-adonis": "^3.0.3",
-    "eslint-plugin-prettier": "^4.2.1",
-    "fastify": "^4.14.1",
-    "fs-extra": "^11.1.0",
+    "eslint": "^8.45.0",
+    "fastify": "^4.20.0",
+    "fs-extra": "^11.1.1",
+    "get-port": "^7.0.0",
     "github-label-sync": "^2.3.1",
     "http-status-codes": "^2.2.0",
     "husky": "^8.0.3",
-    "np": "^7.6.3",
-    "pem": "^1.14.6",
-    "prettier": "^2.8.4",
+    "np": "^8.0.4",
+    "pem": "^1.14.8",
+    "prettier": "^3.0.0",
     "reflect-metadata": "^0.1.13",
     "supertest": "^6.3.3",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.5"
+    "typescript": "^5.1.6"
   },
   "dependencies": {
-    "@paralleldrive/cuid2": "^2.2.0",
-    "@poppinss/macroable": "^1.0.0-2",
+    "@paralleldrive/cuid2": "^2.2.1",
+    "@poppinss/macroable": "^1.0.0-7",
     "@poppinss/matchit": "^3.1.2",
-    "@poppinss/middleware": "^3.1.1",
-    "@poppinss/utils": "^6.5.0-0",
-    "@sindresorhus/is": "^5.3.0",
+    "@poppinss/middleware": "^3.1.3",
+    "@poppinss/utils": "^6.5.0-3",
+    "@sindresorhus/is": "^5.5.2",
     "accepts": "^1.3.8",
     "content-disposition": "^0.5.4",
     "cookie": "^0.5.0",
@@ -109,18 +114,18 @@
     "mime-types": "^2.1.35",
     "on-finished": "^2.4.1",
     "proxy-addr": "^2.0.7",
-    "qs": "^6.11.1",
+    "qs": "^6.11.2",
     "tmp-cache": "^1.1.0",
     "type-is": "^1.6.18",
     "vary": "^1.1.2",
     "youch": "^3.2.3"
   },
   "peerDependencies": {
-    "@adonisjs/application": "^7.1.2-0",
-    "@adonisjs/encryption": "^5.1.2-0",
-    "@adonisjs/events": "^8.4.9-0",
-    "@adonisjs/fold": "^9.9.3-0",
-    "@adonisjs/logger": "^5.4.2-0"
+    "@adonisjs/application": "^7.1.2-3",
+    "@adonisjs/encryption": "^5.1.2-1",
+    "@adonisjs/events": "^8.4.9-2",
+    "@adonisjs/fold": "^9.9.3-4",
+    "@adonisjs/logger": "^5.4.2-1"
   },
   "repository": {
     "type": "git",
@@ -130,37 +135,6 @@
     "url": "https://github.com/adonisjs/http-server/issues"
   },
   "homepage": "https://github.com/adonisjs/http-server#readme",
-  "eslintConfig": {
-    "extends": [
-      "plugin:adonis/typescriptPackage",
-      "prettier"
-    ],
-    "plugins": [
-      "prettier"
-    ],
-    "rules": {
-      "prettier/prettier": [
-        "error",
-        {
-          "endOfLine": "auto"
-        }
-      ]
-    }
-  },
-  "eslintIgnore": [
-    "build",
-    "backup"
-  ],
-  "prettier": {
-    "trailingComma": "es5",
-    "semi": false,
-    "singleQuote": true,
-    "useTabs": false,
-    "quoteProps": "consistent",
-    "bracketSpacing": true,
-    "arrowParens": "always",
-    "printWidth": 100
-  },
   "commitlint": {
     "extends": [
       "@commitlint/config-conventional"
@@ -186,5 +160,9 @@
       "factories/**",
       ".yalc/**"
     ]
-  }
+  },
+  "eslintConfig": {
+    "extends": "@adonisjs/eslint-config/package"
+  },
+  "prettier": "@adonisjs/prettier-config"
 }