@adonisjs/http-server 8.0.0-next.5 → 8.0.0-next.7

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

@@ -3,21 +3,25 @@
  */
 import { type Prettify } from '@poppinss/utils/types';
 /**
- * Options accepted by "urlFor" helper
+ * Configuration options for URL generation helpers
  */
 export type URLOptions = {
+    /** Query string parameters to append to the URL */
     qs?: Record<string, any>;
+    /** URL prefix to prepend to the generated URL */
     prefixUrl?: string;
 };
 /**
- * Options accepted by "signedUrlFor" helper
+ * Configuration options for signed URL generation helpers
  */
 export type SignedURLOptions = URLOptions & {
+    /** Expiration time for the signed URL */
     expiresIn?: string | number;
+    /** Purpose identifier for the signed URL */
     purpose?: string;
 };
 /**
- * Returns params for a route identifier
+ * Utility type that constructs function arguments for route URL builders based on route parameters
  */
 export type RouteBuilderArguments<Identifier, Route, Options extends any = URLOptions> = Route extends LookupListRoute ? Prettify<Route['params'] extends undefined ? [identifier: Identifier, params?: undefined, options?: Options] : [undefined] extends [Route['params']] ? [
     identifier: Identifier,
@@ -28,21 +32,31 @@ export type RouteBuilderArguments<Identifier, Route, Options extends any = URLOp
     params: Route['params'] | Route['paramsTuple'],
     options?: Options
 ]> : never;
+/**
+ * LookupList type is used by the URLBuilder to provide
+ * type-safety when creating URLs.
+ *
+ * There is no runtime property that matches this type. Its
+ * purely for type-inference.
+ */
+/**
+ * Route definition structure for type-safe URL building
+ */
 export type LookupListRoute = {
+    /** Parameters as a tuple for positional arguments */
     paramsTuple?: [...any[]];
+    /** Parameters as a named object */
     params?: {
         [name: string]: any;
     };
 };
 /**
- * LookupList type is used by the URLBuilder to provide
- * type-safety when creating URLs.
- *
- * There is no runtime property that matches this type. Its
- * purely for type-inference.
+ * Complete route lookup structure organized by HTTP methods and route identifiers
  */
 export type LookupList = {
+    /** HTTP method to route mapping */
     [method: string]: {
+        /** Route identifier to route definition mapping */
         [identifier: string]: LookupListRoute;
     };
 };
@@ -134,14 +148,13 @@ export type UrlFor<Routes extends LookupList, Options extends any = URLOptions>
     };
 };
 /**
- * Helper to get routes for a given method from Routes
+ * Utility type to extract routes for a specific HTTP method from the routes collection
  */
 export type GetRoutesForMethod<Routes, Method> = {
     [K in keyof Routes]: Method extends K ? Routes[Method] : never;
 }[keyof Routes];
 /**
- * To be generated by the router and used by the URL builder
- * and the LookupStore
+ * Interface to be augmented by the router containing all registered routes for type-safe URL generation
  */
 export interface RoutesList {
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonisjs/http-server",
-  "version": "8.0.0-next.5",
+  "version": "8.0.0-next.7",
   "description": "AdonisJS HTTP server with support packed with Routing and Cookies",
   "main": "build/index.js",
   "type": "module",
@@ -32,7 +32,8 @@
     "format": "prettier --write .",
     "prepublishOnly": "npm run build",
     "lint": "eslint",
-    "quick:test": "node --import=@poppinss/ts-exec --enable-source-maps bin/test.ts"
+    "quick:test": "node --import=@poppinss/ts-exec --enable-source-maps bin/test.ts",
+    "docs": "typedoc"
   },
   "keywords": [
     "http",
@@ -41,12 +42,12 @@
   "author": "virk,adonisjs",
   "license": "MIT",
   "devDependencies": {
-    "@adonisjs/application": "^9.0.0-next.2",
-    "@adonisjs/encryption": "^7.0.0-next.0",
-    "@adonisjs/eslint-config": "^3.0.0-next.0",
-    "@adonisjs/events": "^10.1.0-next.1",
-    "@adonisjs/fold": "^11.0.0-next.0",
-    "@adonisjs/logger": "^7.0.0-next.1",
+    "@adonisjs/application": "^9.0.0-next.4",
+    "@adonisjs/encryption": "^7.0.0-next.1",
+    "@adonisjs/eslint-config": "^3.0.0-next.1",
+    "@adonisjs/events": "^10.1.0-next.2",
+    "@adonisjs/fold": "^11.0.0-next.2",
+    "@adonisjs/logger": "^7.1.0-next.0",
     "@adonisjs/prettier-config": "^1.4.5",
     "@adonisjs/tsconfig": "^2.0.0-next.0",
     "@fastify/middie": "^9.0.3",
@@ -65,7 +66,7 @@
     "@types/fresh": "^0.5.3",
     "@types/fs-extra": "^11.0.4",
     "@types/mime-types": "^3.0.1",
-    "@types/node": "^24.3.0",
+    "@types/node": "^24.3.1",
     "@types/on-finished": "^2.3.5",
     "@types/pem": "^1.14.4",
     "@types/proxy-addr": "^2.0.3",
@@ -78,7 +79,7 @@
     "c8": "^10.1.3",
     "cross-env": "^10.0.0",
     "eslint": "^9.34.0",
-    "fastify": "^5.5.0",
+    "fastify": "^5.6.0",
     "fs-extra": "^11.3.1",
     "get-port": "^7.1.0",
     "http-status-codes": "^2.3.0",
@@ -88,6 +89,7 @@
     "release-it": "^19.0.4",
     "supertest": "^7.1.4",
     "tsup": "^8.5.0",
+    "typedoc": "^0.28.12",
     "typescript": "^5.9.2",
     "youch": "^4.1.0-beta.11"
   },
@@ -113,11 +115,11 @@
     "vary": "^1.1.2"
   },
   "peerDependencies": {
-    "@adonisjs/application": "^9.0.0-next.2",
-    "@adonisjs/encryption": "^7.0.0-next.0",
-    "@adonisjs/events": "^10.1.0-next.1",
-    "@adonisjs/fold": "^11.0.0-next.0",
-    "@adonisjs/logger": "^7.0.0-next.1",
+    "@adonisjs/application": "^9.0.0-next.4",
+    "@adonisjs/encryption": "^7.0.0-next.1",
+    "@adonisjs/events": "^10.1.0-next.2",
+    "@adonisjs/fold": "^11.0.0-next.2",
+    "@adonisjs/logger": "^7.1.0-next.0",
     "youch": "^4.1.0-beta.11"
   },
   "peerDependenciesMeta": {