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

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

@@ -0,0 +1,19 @@
+export type { NextFn } from '@poppinss/middleware/types';
+/**
+ * Accept one or more of the mentioned type
+ */
+export type OneOrMore<T> = T | T[];
+/**
+ * Class constructor type
+ */
+export type Constructor<T> = new (...args: any[]) => T;
+/**
+ * A function that lazily imports a middleware
+ */
+export type LazyImport<DefaultExport> = () => Promise<{
+    default: DefaultExport;
+}>;
+/**
+ * Unwraps default export from a lazy import function
+ */
+export type UnWrapLazyImport<Fn extends LazyImport<any>> = Awaited<ReturnType<Fn>>['default'];

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

@@ -1,14 +1,7 @@
-export { p as CastableHeader, C as Constructor, o as CookieOptions, E as ErrorHandlerAsAClass, r as GetControllerHandlers, G as GetMiddlewareArgs, e as HttpError, V as HttpRequestFinishedPayload, L as LazyImport, N as MakeSignedUrlOptions, K as MakeUrlOptions, s as MatchItRouteToken, A as MatchedRoute, M as MiddlewareAsClass, m as MiddlewareFn, O as OneOrMore, P as ParsedGlobalMiddleware, n as ParsedNamedMiddleware, Q as QSParserConfig, k as RequestConfig, J as ResourceActionNames, l as ResponseConfig, q as ResponseStream, t as RouteFn, I as RouteJSON, D as RouteMatcher, F as RouteMatchers, S as ServerConfig, W as ServerErrorHandler, c as StatusPageRange, d as StatusPageRenderer, y as StoreDomainNode, x as StoreMethodNode, u as StoreRouteHandler, v as StoreRouteMiddleware, w as StoreRouteNode, z as StoreRoutesTree, T as TestingMiddlewarePipeline, U as UnWrapLazyImport } from '../../main-e5b46c83.js';
-export { NextFn } from '@poppinss/middleware/types';
-import '@adonisjs/fold';
-import '@poppinss/macroable';
-import '@adonisjs/logger';
-import 'node:url';
-import '@adonisjs/encryption';
-import 'node:http';
-import 'qs';
-import 'http';
-import 'stream';
-import '@poppinss/middleware';
-import 'node:stream';
-import '@adonisjs/application';
+export * from './base.js';
+export * from './middleware.js';
+export * from './qs.js';
+export * from './request.js';
+export * from './response.js';
+export * from './route.js';
+export * from './server.js';

package/build/src/types/main.js

@@ -0,0 +1 @@
+//# sourceMappingURL=main.js.map

package/build/src/types/main.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

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

@@ -0,0 +1,35 @@
+import type { ContainerResolver } from '@adonisjs/fold';
+import type { Constructor, NextFn } from './base.js';
+import type { HttpContext } from '../http_context/main.js';
+/**
+ * Middleware represented as a class
+ */
+export type MiddlewareAsClass = Constructor<{
+    handle: (ctx: HttpContext, next: NextFn, args?: any) => any;
+}>;
+/**
+ * Check if a union has undefined or null
+ */
+type HasUndefined<T> = T extends NonNullable<T> ? true : false;
+/**
+ * Returns the arguments accepted by the middleware's handle method
+ */
+export type GetMiddlewareArgs<Middleware extends MiddlewareAsClass> = Parameters<InstanceType<Middleware>['handle']>[2] extends undefined ? [] : HasUndefined<Parameters<InstanceType<Middleware>['handle']>[2]> extends true ? [Parameters<InstanceType<Middleware>['handle']>[2]] : [Parameters<InstanceType<Middleware>['handle']>[2]?];
+/**
+ * The middleware defined as a function on the router or the server
+ */
+export type MiddlewareFn = (ctx: HttpContext, next: NextFn) => any;
+/**
+ * Parsed global middleware
+ */
+export type ParsedGlobalMiddleware = {
+    handle: (resolver: ContainerResolver<any>, ...args: [ctx: HttpContext, next: NextFn, params?: any]) => any;
+};
+/**
+ * Parsed named middleware
+ */
+export type ParsedNamedMiddleware = ParsedGlobalMiddleware & {
+    name: string;
+    args: any;
+};
+export {};

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

@@ -0,0 +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/request.d.ts

@@ -0,0 +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/response.d.ts

@@ -0,0 +1,45 @@
+/// <reference types="node" resolution-mode="require"/>
+import { Readable } from 'node:stream';
+/**
+ * Cookie options can that can be set on the response
+ */
+export type CookieOptions = {
+    domain: string;
+    expires: Date | (() => Date);
+    httpOnly: boolean;
+    maxAge: number | string;
+    path: string;
+    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 = Readable;

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

@@ -0,0 +1,166 @@
+import type Middleware from '@poppinss/middleware';
+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 = {
+    /**
+     * 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: {
+        [pattern: string]: string;
+    };
+    routes: {
+        [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/server.d.ts

@@ -0,0 +1,72 @@
+import type { ErrorHandler, FinalHandler } from '@poppinss/middleware/types';
+import type { Constructor } from './base.js';
+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;
+    code?: string;
+    stack?: string;
+    cause?: any;
+    messages?: any;
+    errors?: any;
+    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>;
+}
+/**
+ * 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/package.json

@@ -1,11 +1,13 @@
 {
   "name": "@adonisjs/http-server",
-  "version": "7.0.0-0",
+  "version": "7.0.0-2",
   "description": "AdonisJS HTTP server with support packed with Routing and Cookies",
   "main": "build/index.js",
   "type": "module",
   "files": [
-    "build"
+    "build",
+    "!build/bin",
+    "!build/tests"
   ],
   "exports": {
     ".": "./build/index.js",
@@ -20,7 +22,8 @@
     "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 && tsup-node",
+    "precompile": "npm run lint && npm run clean",
+    "compile": "tsup-node && tsc --emitDeclarationOnly --declaration",
     "build": "npm run compile",
     "prebenchmark": "npm run build",
     "benchmark": "node benchmarks/index.js",
@@ -40,45 +43,45 @@
   "author": "virk,adonisjs",
   "license": "MIT",
   "devDependencies": {
-    "@adonisjs/application": "^8.0.0-0",
-    "@adonisjs/encryption": "^5.1.2-3",
-    "@adonisjs/eslint-config": "^1.1.8",
-    "@adonisjs/events": "^9.0.0-0",
-    "@adonisjs/fold": "^9.9.3-10",
-    "@adonisjs/logger": "^5.4.2-6",
-    "@adonisjs/prettier-config": "^1.1.8",
-    "@adonisjs/tsconfig": "^1.1.8",
-    "@commitlint/cli": "^17.8.0",
-    "@commitlint/config-conventional": "^17.8.0",
+    "@adonisjs/application": "^8.0.0-2",
+    "@adonisjs/encryption": "^5.1.2-4",
+    "@adonisjs/eslint-config": "^1.1.9",
+    "@adonisjs/events": "^9.0.0-1",
+    "@adonisjs/fold": "^9.9.3-11",
+    "@adonisjs/logger": "^5.4.2-7",
+    "@adonisjs/prettier-config": "^1.1.9",
+    "@adonisjs/tsconfig": "^1.1.9",
+    "@commitlint/cli": "^18.4.3",
+    "@commitlint/config-conventional": "^18.4.3",
     "@fastify/middie": "^8.3.0",
-    "@japa/assert": "^2.0.0",
+    "@japa/assert": "^2.0.1",
     "@japa/expect-type": "^2.0.0",
-    "@japa/runner": "^3.0.2",
-    "@swc/core": "1.3.82",
-    "@types/accepts": "^1.3.5",
-    "@types/content-disposition": "^0.5.6",
-    "@types/cookie": "^0.5.2",
-    "@types/destroy": "^1.0.1",
-    "@types/encodeurl": "^1.0.0",
-    "@types/etag": "^1.8.1",
-    "@types/fresh": "^0.5.0",
-    "@types/fs-extra": "^11.0.2",
+    "@japa/runner": "^3.1.0",
+    "@swc/core": "^1.3.99",
+    "@types/accepts": "^1.3.7",
+    "@types/content-disposition": "^0.5.8",
+    "@types/cookie": "^0.5.4",
+    "@types/destroy": "^1.0.3",
+    "@types/encodeurl": "^1.0.2",
+    "@types/etag": "^1.8.3",
+    "@types/fresh": "^0.5.2",
+    "@types/fs-extra": "^11.0.4",
     "@types/http-status-codes": "^1.2.0",
-    "@types/mime-types": "^2.1.2",
-    "@types/node": "^20.8.6",
-    "@types/on-finished": "^2.3.2",
-    "@types/pem": "^1.14.2",
-    "@types/proxy-addr": "^2.0.1",
-    "@types/qs": "^6.9.8",
-    "@types/supertest": "^2.0.14",
-    "@types/type-is": "^1.6.4",
-    "@types/vary": "^1.1.1",
+    "@types/mime-types": "^2.1.4",
+    "@types/node": "^20.9.4",
+    "@types/on-finished": "^2.3.4",
+    "@types/pem": "^1.14.4",
+    "@types/proxy-addr": "^2.0.3",
+    "@types/qs": "^6.9.10",
+    "@types/supertest": "^2.0.16",
+    "@types/type-is": "^1.6.6",
+    "@types/vary": "^1.1.3",
     "@vinejs/vine": "^1.6.0",
     "autocannon": "^7.12.0",
     "c8": "^8.0.1",
     "cross-env": "^7.0.3",
     "del-cli": "^5.1.0",
-    "eslint": "^8.51.0",
+    "eslint": "^8.54.0",
     "fastify": "^4.24.2",
     "fs-extra": "^11.1.1",
     "get-port": "^7.0.0",
@@ -87,23 +90,23 @@
     "husky": "^8.0.3",
     "np": "^8.0.4",
     "pem": "^1.14.8",
-    "prettier": "^3.0.3",
+    "prettier": "^3.1.0",
     "reflect-metadata": "^0.1.13",
     "supertest": "^6.3.3",
     "ts-node": "^10.9.1",
-    "tsup": "^7.2.0",
-    "typescript": "^5.2.2"
+    "tsup": "^8.0.1",
+    "typescript": "5.2.2"
   },
   "dependencies": {
     "@paralleldrive/cuid2": "^2.2.2",
     "@poppinss/macroable": "^1.0.0",
     "@poppinss/matchit": "^3.1.2",
-    "@poppinss/middleware": "^3.2.0",
-    "@poppinss/utils": "^6.5.0",
-    "@sindresorhus/is": "^6.0.1",
+    "@poppinss/middleware": "^3.2.1",
+    "@poppinss/utils": "^6.5.1",
+    "@sindresorhus/is": "^6.1.0",
     "accepts": "^1.3.8",
     "content-disposition": "^0.5.4",
-    "cookie": "^0.5.0",
+    "cookie": "^0.6.0",
     "destroy": "^1.2.0",
     "encodeurl": "^1.0.2",
     "etag": "^1.8.1",
@@ -115,14 +118,14 @@
     "tmp-cache": "^1.1.0",
     "type-is": "^1.6.18",
     "vary": "^1.1.2",
-    "youch": "^3.3.2"
+    "youch": "^3.3.3"
   },
   "peerDependencies": {
-    "@adonisjs/application": "^8.0.0-0",
-    "@adonisjs/encryption": "^5.1.2-3",
-    "@adonisjs/events": "^9.0.0-0",
-    "@adonisjs/fold": "^9.9.3-10",
-    "@adonisjs/logger": "^5.4.2-6"
+    "@adonisjs/application": "^8.0.0-2",
+    "@adonisjs/encryption": "^5.1.2-4",
+    "@adonisjs/events": "^9.0.0-1",
+    "@adonisjs/fold": "^9.9.3-11",
+    "@adonisjs/logger": "^5.4.2-7"
   },
   "repository": {
     "type": "git",
@@ -171,7 +174,8 @@
     "outDir": "./build",
     "clean": true,
     "format": "esm",
-    "dts": true,
+    "dts": false,
+    "sourcemap": true,
     "target": "esnext"
   }
 }