@adonisjs/http-server 6.8.2-5 → 6.8.2-7

package/src/types/main.ts

@@ -1,16 +0,0 @@
-/*
- * @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 * 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/src/types/middleware.ts

@@ -1,59 +0,0 @@
-/*
- * @adonisjs/http-server
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-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
-}

package/src/types/qs.ts

@@ -1,85 +0,0 @@
-/*
- * @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 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/src/types/request.ts

@@ -1,52 +0,0 @@
-/*
- * @adonisjs/http-server
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-/**
- * 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/src/types/response.ts

@@ -1,57 +0,0 @@
-/*
- * @adonisjs/http-server
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-/**
- * 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 = NodeJS.ReadStream | NodeJS.ReadWriteStream | NodeJS.ReadableStream

package/src/types/route.ts

@@ -1,217 +0,0 @@
-/*
- * @adonisjs/http-server
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-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'
-
-/**
- * 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) => 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/src/types/server.ts

@@ -1,92 +0,0 @@
-/*
- * @adonisjs/http-server
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-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}`
-
-/**
- * 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
-  }