@adonisjs/http-server 5.11.0 → 6.0.0-0

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

@@ -0,0 +1,18 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+export type CookieOptions = {
+    domain: string;
+    expires: Date | (() => Date);
+    httpOnly: boolean;
+    maxAge: number | string;
+    path: string;
+    sameSite: boolean | 'lax' | 'none' | 'strict';
+    secure: boolean;
+};
+export type CastableHeader = string | number | boolean | string[] | number[] | boolean[];
+export type ResponseConfig = {
+    etag: boolean;
+    jsonpCallbackName: string;
+    cookie: Partial<CookieOptions>;
+};
+export type ResponseStream = NodeJS.ReadStream | NodeJS.ReadWriteStream | NodeJS.ReadableStream;

package/build/src/types/response.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,74 @@
+import type Middleware from '@poppinss/middleware';
+import type { ContainerResolver } from '@adonisjs/fold';
+import type { HttpContext } from '../http_context/main.js';
+import type { MiddlewareFn, ParsedGlobalMiddleware } from './middleware.js';
+export type MatchItRouteToken = RouteMatcher & {
+    old: string;
+    type: 0 | 1 | 2 | 3;
+    val: string;
+    end: string;
+};
+export type RouteFn = (ctx: HttpContext) => any;
+export type StoreRouteHandler = RouteFn | {
+    name: string;
+    handle: (resolver: ContainerResolver, ...args: [ctx: HttpContext, ...injections: any[]]) => any;
+};
+export type StoreRouteMiddleware = MiddlewareFn | ({
+    name?: string;
+    args?: any[];
+} & ParsedGlobalMiddleware);
+export type StoreRouteNode = {
+    execute: (route: StoreRouteNode, resolver: ContainerResolver, ctx: HttpContext) => any;
+    name?: string;
+    pattern: string;
+    handler: StoreRouteHandler;
+    middleware: Middleware<StoreRouteMiddleware>;
+    meta: Record<string, any>;
+};
+export type StoreMethodNode = {
+    tokens: MatchItRouteToken[][];
+    routeKeys: {
+        [pattern: string]: string;
+    };
+    routes: {
+        [pattern: string]: StoreRouteNode;
+    };
+};
+export type StoreDomainNode = {
+    [method: string]: StoreMethodNode;
+};
+export type StoreRoutesTree = {
+    tokens: MatchItRouteToken[][];
+    domains: {
+        [domain: string]: StoreDomainNode;
+    };
+};
+export type MatchedRoute = {
+    route: StoreRouteNode;
+    routeKey: string;
+    params: Record<string, any>;
+    subdomains: Record<string, any>;
+};
+export type RouteMatcher = {
+    match?: RegExp;
+    cast?: (value: string) => any;
+};
+export type RouteMatchers = {
+    [param: string]: RouteMatcher;
+};
+export type RouteJSON = StoreRouteNode & {
+    methods: string[];
+    domain: string;
+    matchers: RouteMatchers;
+};
+export type ResourceActionNames = 'create' | 'index' | 'store' | 'show' | 'edit' | 'update' | 'destroy';
+export type MakeUrlOptions = {
+    qs?: Record<string, any>;
+    domain?: string;
+    prefixUrl?: string;
+    disableRouteLookup?: boolean;
+};
+export type MakeSignedUrlOptions = MakeUrlOptions & {
+    expiresIn?: string | number;
+    purpose?: string;
+};

package/build/src/types/route.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,13 @@
+import type { Constructor } from './base.js';
+import type { RequestConfig } from './request.js';
+import type { ResponseConfig } from './response.js';
+import type { HttpContext } from '../http_context/main.js';
+import { QSParserConfig } from './qs.js';
+export type ServerErrorHandler = {
+    handle: (error: any, ctx: HttpContext) => any;
+};
+export type ErrorHandlerAsAClass = Constructor<ServerErrorHandler>;
+export type ServerConfig = RequestConfig & ResponseConfig & {
+    useAsyncLocalStorage: boolean;
+    qs: QSParserConfig;
+};

package/build/src/types/server.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,33 +1,34 @@
 {
   "name": "@adonisjs/http-server",
-  "version": "5.11.0",
+  "version": "6.0.0-0",
   "description": "AdonisJS HTTP server with support packed with Routing and Cookies",
-  "main": "build/providers/HttpServerProvider.js",
+  "main": "build/index.js",
+  "type": "module",
   "files": [
-    "build/adonis-typings",
-    "build/providers",
     "build/src",
-    "build/exceptions.json",
-    "build/standalone.d.ts",
-    "build/standalone.js"
+    "build/index.d.ts",
+    "build/index.js"
   ],
+  "exports": {
+    ".": "./build/index.js",
+    "./types": "./build/src/types.js"
+  },
   "scripts": {
-    "mrm": "mrm --preset=@adonisjs/mrm-preset",
     "pretest": "npm run lint",
-    "test": "node -r ts-node/register/transpile-only bin/test.ts",
+    "test": "cross-env NODE_DEBUG=adonisjs:http c8 npm run vscode:test",
     "clean": "del-cli build",
     "compile": "npm run lint && npm run clean && tsc",
     "build": "npm run compile",
-    "benchmark": "ENV_SILENT=true node build/benchmarks/index.js",
-    "build:tmp": "npm run compile",
-    "commit": "git-cz",
-    "release": "np --message=\"chore(release): %s\"",
+    "prebenchmark": "npm run build",
+    "benchmark": "node --experimental-import-meta-resolve build/benchmarks/index.js",
+    "release": "np",
     "version": "npm run build",
+    "format": "prettier --write .",
     "prepublishOnly": "npm run build",
     "lint": "eslint . --ext=.ts",
-    "format": "prettier --write .",
-    "sync-labels": "github-label-sync --labels ./node_modules/@adonisjs/mrm-preset/gh-labels.json adonisjs/http-server",
-    "prepare": "husky install"
+    "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"
   },
   "keywords": [
     "http",
@@ -36,92 +37,86 @@
   "author": "virk,adonisjs",
   "license": "MIT",
   "devDependencies": {
-    "@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.9",
-    "@japa/spec-reporter": "^1.1.12",
-    "@poppinss/dev-utils": "^2.0.3",
+    "@adonisjs/application": "^6.1.2-0",
+    "@adonisjs/config": "^4.1.1-0",
+    "@adonisjs/encryption": "^5.0.1-0",
+    "@adonisjs/env": "^4.0.3-0",
+    "@adonisjs/fold": "^9.4.1-0",
+    "@adonisjs/logger": "^5.0.2-0",
+    "@commitlint/cli": "^17.3.0",
+    "@commitlint/config-conventional": "^17.3.0",
+    "@fastify/middie": "^8.0.0",
+    "@japa/api-client": "^1.4.2",
+    "@japa/assert": "^1.3.6",
+    "@japa/expect-type": "^1.0.2",
+    "@japa/run-failed-tests": "^1.1.0",
+    "@japa/runner": "^2.2.2",
+    "@japa/spec-reporter": "^1.3.2",
+    "@swc/core": "^1.3.21",
+    "@types/accepts": "^1.3.5",
+    "@types/content-disposition": "^0.5.5",
     "@types/cookie": "^0.5.1",
-    "@types/ms": "^0.7.31",
-    "@types/node": "^17.0.42",
-    "@types/pluralize": "0.0.29",
+    "@types/destroy": "^1.0.0",
+    "@types/encodeurl": "^1.0.0",
+    "@types/etag": "^1.8.1",
+    "@types/fresh": "^0.5.0",
+    "@types/fs-extra": "^9.0.13",
+    "@types/http-status-codes": "^1.2.0",
+    "@types/mime-types": "^2.1.1",
+    "@types/on-finished": "^2.3.1",
+    "@types/pem": "^1.9.6",
     "@types/proxy-addr": "^2.0.0",
     "@types/qs": "^6.9.7",
     "@types/supertest": "^2.0.12",
-    "autocannon": "^7.9.0",
-    "commitizen": "^4.2.4",
+    "@types/type-is": "^1.6.3",
+    "@types/vary": "^1.1.0",
+    "autocannon": "^7.10.0",
+    "c8": "^7.12.0",
     "cross-env": "^7.0.3",
-    "cz-conventional-changelog": "^3.3.0",
-    "del-cli": "^4.0.1",
-    "eslint": "^8.17.0",
+    "del-cli": "^5.0.0",
+    "eslint": "^8.28.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-adonis": "^2.1.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "fastify": "^4.0.1",
+    "eslint-plugin-adonis": "^3.0.3",
+    "eslint-plugin-prettier": "^4.2.1",
+    "fastify": "^4.10.2",
+    "fs-extra": "^11.1.0",
     "github-label-sync": "^2.2.0",
     "http-status-codes": "^2.2.0",
-    "husky": "^8.0.1",
-    "middie": "^7.1.0",
-    "mrm": "^4.0.0",
-    "np": "^7.6.1",
+    "husky": "^8.0.2",
+    "np": "^7.6.2",
     "pem": "^1.14.6",
-    "prettier": "^2.6.2",
+    "prettier": "^2.8.0",
     "reflect-metadata": "^0.1.13",
-    "supertest": "^6.2.3",
-    "ts-node": "^10.8.1",
-    "typescript": "^4.7.3"
-  },
-  "peerDependencies": {
-    "@adonisjs/application": "^5.0.0",
-    "@adonisjs/encryption": "^4.0.0"
-  },
-  "nyc": {
-    "exclude": [
-      "test"
-    ],
-    "extension": [
-      ".ts"
-    ]
-  },
-  "config": {
-    "commitizen": {
-      "path": "cz-conventional-changelog"
-    }
-  },
-  "np": {
-    "contents": ".",
-    "anyBranch": false
+    "supertest": "^6.3.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.3"
   },
   "dependencies": {
+    "@poppinss/macroable": "^1.0.0-0",
     "@poppinss/matchit": "^3.1.2",
-    "@poppinss/utils": "^4.0.4",
+    "@poppinss/middleware": "^3.0.0",
+    "@poppinss/utils": "^6.1.0-0",
+    "@sindresorhus/is": "^5.3.0",
     "accepts": "^1.3.8",
-    "co-compose": "^7.0.2",
     "content-disposition": "^0.5.4",
     "cookie": "^0.5.0",
+    "cuid": "^2.1.8",
     "destroy": "^1.2.0",
     "encodeurl": "^1.0.2",
     "etag": "^1.8.1",
     "fresh": "^0.5.2",
-    "haye": "^3.0.0",
-    "macroable": "^7.0.1",
     "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.5",
+    "qs": "^6.11.0",
     "tmp-cache": "^1.1.0",
     "type-is": "^1.6.18",
     "vary": "^1.1.2"
   },
-  "directories": {
-    "doc": "docs",
-    "test": "test"
+  "peerDependencies": {
+    "@adonisjs/application": "^6.1.2-0",
+    "@adonisjs/encryption": "^5.0.1-0",
+    "@adonisjs/fold": "^9.4.1-0"
   },
   "repository": {
     "type": "git",
@@ -131,26 +126,6 @@
     "url": "https://github.com/adonisjs/http-server/issues"
   },
   "homepage": "https://github.com/adonisjs/http-server#readme",
-  "adonisjs": {
-    "exceptions": "./build/exceptions.json"
-  },
-  "publishConfig": {
-    "access": "public",
-    "tag": "latest"
-  },
-  "mrmConfig": {
-    "core": true,
-    "license": "MIT",
-    "services": [
-      "github-actions"
-    ],
-    "minNodeVersion": "14.15.4",
-    "probotApps": [
-      "stale",
-      "lock"
-    ],
-    "runGhActionsOnWindows": false
-  },
   "eslintConfig": {
     "extends": [
       "plugin:adonis/typescriptPackage",
@@ -169,7 +144,8 @@
     }
   },
   "eslintIgnore": [
-    "build"
+    "build",
+    "backup"
   ],
   "prettier": {
     "trailingComma": "es5",
@@ -180,5 +156,31 @@
     "bracketSpacing": true,
     "arrowParens": "always",
     "printWidth": 100
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "next"
+  },
+  "np": {
+    "message": "chore(release): %s",
+    "tag": "next",
+    "branch": "main",
+    "anyBranch": false
+  },
+  "c8": {
+    "reporter": [
+      "text",
+      "html"
+    ],
+    "exclude": [
+      "tests/**",
+      "test_factories/**",
+      ".yalc/**"
+    ]
   }
 }

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

@@ -1,24 +0,0 @@
-/**
- * @adonisjs/http-server
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-declare module '@ioc:Adonis/Core/Application' {
-    import { RouterContract } from '@ioc:Adonis/Core/Route';
-    import { ServerContract } from '@ioc:Adonis/Core/Server';
-    import { CookieClientContract } from '@ioc:Adonis/Core/CookieClient';
-    import { RequestConstructorContract } from '@ioc:Adonis/Core/Request';
-    import { ResponseConstructorContract } from '@ioc:Adonis/Core/Response';
-    import { HttpContextConstructorContract } from '@ioc:Adonis/Core/HttpContext';
-    interface ContainerBindings {
-        'Adonis/Core/Route': RouterContract;
-        'Adonis/Core/Server': ServerContract;
-        'Adonis/Core/CookieClient': CookieClientContract;
-        'Adonis/Core/Request': RequestConstructorContract;
-        'Adonis/Core/Response': ResponseConstructorContract;
-        'Adonis/Core/HttpContext': HttpContextConstructorContract;
-    }
-}

package/build/adonis-typings/container.js

@@ -1,8 +0,0 @@
-/**
- * @adonisjs/http-server
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */

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

@@ -1,73 +0,0 @@
-/**
- * @adonisjs/http-server
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-/// <reference types="@adonisjs/logger/build/adonis-typings/logger" />
-/// <reference types="@adonisjs/profiler/build/adonis-typings/profiler" />
-/// <reference types="node" />
-declare module '@ioc:Adonis/Core/HttpContext' {
-    import { RouteNode } from '@ioc:Adonis/Core/Route';
-    import { IncomingMessage, ServerResponse } from 'http';
-    import { MacroableConstructorContract } from 'macroable';
-    import { LoggerContract } from '@ioc:Adonis/Core/Logger';
-    import { RequestContract } from '@ioc:Adonis/Core/Request';
-    import { ResponseContract } from '@ioc:Adonis/Core/Response';
-    import { ProfilerRowContract } from '@ioc:Adonis/Core/Profiler';
-    import { ApplicationContract } from '@ioc:Adonis/Core/Application';
-    /**
-     * Http request context passed to all middleware
-     * and route handler
-     */
-    export interface HttpContextContract {
-        /**
-         * A helper to see top level properties on the context object
-         */
-        inspect(): any;
-        request: RequestContract;
-        response: ResponseContract;
-        logger: LoggerContract;
-        profiler: ProfilerRowContract;
-        route?: RouteNode & {
-            params: string[];
-        };
-        routeKey: string;
-        params: Record<string, any>;
-        subdomains: Record<string, any>;
-    }
-    /**
-     * Shape of the constructor. We export the constructor and not
-     * the context instance, since that is passed to the HTTP
-     * lifecycle
-     */
-    export interface HttpContextConstructorContract extends MacroableConstructorContract<HttpContextContract> {
-        app?: ApplicationContract;
-        /**
-         * Find if ALS is enabled inside the config/app.ts file
-         */
-        readonly usingAsyncLocalStorage: boolean;
-        /**
-         * Returns the current HTTP context or null if there is none.
-         */
-        get(): HttpContextContract | null;
-        /**
-         * Returns the current HTTP context or throws if there is none.
-         */
-        getOrFail(): HttpContextContract;
-        /**
-         * Run a method that doesn't have access to HTTP context from
-         * the async local storage.
-         */
-        runOutsideContext<T>(callback: (...args: any[]) => T, ...args: any[]): T;
-        /**
-         * Creates a new fake context instance for a given route.
-         */
-        create(routePattern: string, routeParams: Record<string, any>, req?: IncomingMessage, res?: ServerResponse): HttpContextContract;
-        new (request: RequestContract, response: ResponseContract, logger: LoggerContract, profiler: ProfilerRowContract): HttpContextContract;
-    }
-    const HttpContext: HttpContextConstructorContract;
-    export default HttpContext;
-}

package/build/adonis-typings/context.js

@@ -1,8 +0,0 @@
-/**
- * @adonisjs/http-server
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */

package/build/adonis-typings/cookie-client.d.ts

@@ -1,34 +0,0 @@
-declare module '@ioc:Adonis/Core/CookieClient' {
-    export interface CookieClientContract {
-        /**
-         * 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(key: string, value: any): string | null;
-        /**
-         * Parse the set-cookie header
-         */
-        parse(key: string, value: string): any | null;
-        /**
-         * Unsign a signed cookie value
-         */
-        unsign(key: string, value: string): any | null;
-        /**
-         * Decrypt an encrypted cookie value
-         */
-        decrypt(key: string, value: string): any | null;
-        /**
-         * Decode an encoded cookie value
-         */
-        decode(key: string, value: string): any | null;
-    }
-    const CookieClient: CookieClientContract;
-    export default CookieClient;
-}

package/build/adonis-typings/cookie-client.js

@@ -1,8 +0,0 @@
-/*
- * @adonisjs/http-server
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */

package/build/adonis-typings/http-server.d.ts

@@ -1,98 +0,0 @@
-/**
- * @adonisjs/http-server
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-/// <reference types="node" />
-/// <reference types="node" />
-declare module '@ioc:Adonis/Core/Server' {
-    import { Server as HttpsServer } from 'https';
-    import { RouterContract } from '@ioc:Adonis/Core/Route';
-    import { RequestConfig } from '@ioc:Adonis/Core/Request';
-    import { ResponseConfig } from '@ioc:Adonis/Core/Response';
-    import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext';
-    import { MiddlewareStoreContract } from '@ioc:Adonis/Core/Middleware';
-    import { IncomingMessage, ServerResponse, Server as HttpServer } from 'http';
-    /**
-     * Before hooks are executed before finding the route or finding
-     * middleware
-     */
-    export type HookHandler = (ctx: HttpContextContract) => Promise<void>;
-    /**
-     * Error handler node
-     */
-    export type ErrorHandler = string | ((error: any, ctx: HttpContextContract) => Promise<any>);
-    /**
-     * Shape of resolved error handler node
-     */
-    export type ResolvedErrorHandler = {
-        type: 'function';
-        value: Exclude<ErrorHandler, string>;
-    } | {
-        type: 'alias' | 'binding';
-        namespace: string;
-        method: string;
-    };
-    /**
-     * Shape of the public methods for the hooks contract. By `public`
-     * the one we want to expose to the end user
-     */
-    export interface HooksContract {
-        /**
-         * Register before hook
-         */
-        before(cb: HookHandler): this;
-        /**
-         * Register after hook
-         */
-        after(cb: HookHandler): this;
-    }
-    /**
-     * HTTP server
-     */
-    export interface ServerContract {
-        /**
-         * The server itself doesn't create the http server instance. However, the consumer
-         * of this class can create one and set the instance for further reference. This
-         * is what ignitor does.
-         */
-        instance?: HttpServer | HttpsServer;
-        /**
-         * The route to register routes
-         */
-        router: RouterContract;
-        /**
-         * Server before/after hooks
-         */
-        hooks: HooksContract;
-        /**
-         * The middleware store to register global and named middleware
-         */
-        middleware: MiddlewareStoreContract;
-        /**
-         * Define custom error handler to handler all errors
-         * occurred during HTTP request
-         */
-        errorHandler(handler: ErrorHandler): this;
-        /**
-         * Handles a given HTTP request. This method can be attached to any HTTP
-         * server
-         */
-        handle(req: IncomingMessage, res: ServerResponse): Promise<void>;
-        /**
-         * Optimizes internal handlers, based upon the existence of
-         * before handlers and global middleware. This helps in
-         * increasing throughput by 10%
-         */
-        optimize(): void;
-    }
-    /**
-     * Config requried by request and response
-     */
-    export type ServerConfig = RequestConfig & ResponseConfig;
-    const Server: ServerContract;
-    export default Server;
-}

package/build/adonis-typings/http-server.js

@@ -1,8 +0,0 @@
-/**
- * @adonisjs/http-server
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */

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

@@ -1,16 +0,0 @@
-/**
- * @adonisjs/http-server
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-/// <reference path="container.d.ts" />
-/// <reference path="context.d.ts" />
-/// <reference path="http-server.d.ts" />
-/// <reference path="middleware.d.ts" />
-/// <reference path="request.d.ts" />
-/// <reference path="response.d.ts" />
-/// <reference path="route.d.ts" />
-/// <reference path="cookie-client.d.ts" />