@adonisjs/http-server 8.0.0-next.4 → 8.0.0-next.6

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

@@ -3,29 +3,33 @@
  */
 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<Routes, Method extends keyof Routes, Identifier extends keyof Routes[Method], Options extends any = URLOptions> = Routes extends LookupList ? Prettify<Routes[Method][Identifier]['params'] extends undefined ? [identifier: Identifier, params?: undefined, options?: Options] : [undefined] extends [Routes[Method][Identifier]['params']] ? [
+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,
-    params?: Routes[Method][Identifier]['params'] | Routes[Method][Identifier]['paramsTuple'],
+    params?: Route['params'] | Route['paramsTuple'],
     options?: Options
 ] : [
     identifier: Identifier,
-    params: Routes[Method][Identifier]['params'] | Routes[Method][Identifier]['paramsTuple'],
+    params: Route['params'] | Route['paramsTuple'],
     options?: Options
 ]> : never;
 /**
@@ -35,14 +39,25 @@ export type RouteBuilderArguments<Routes, Method extends keyof Routes, Identifie
  * 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;
+    };
+};
+/**
+ * Complete route lookup structure organized by HTTP methods and route identifiers
+ */
 export type LookupList = {
+    /** HTTP method to route mapping */
     [method: string]: {
-        [identifier: string]: {
-            paramsTuple?: [...any[]];
-            params?: {
-                [name: string]: any;
-            };
-        };
+        /** Route identifier to route definition mapping */
+        [identifier: string]: LookupListRoute;
     };
 };
 /**
@@ -57,7 +72,7 @@ export type LookupList = {
  * urlFor('blog.adonisjs.com@posts.show', [1]) // /posts/1
  * ```
  */
-export type UrlFor<Routes extends LookupList, Options extends any = URLOptions> = (<Identifier extends keyof Routes['ALL'] & string>(...[identifier, params, options]: RouteBuilderArguments<Routes, 'ALL', Identifier, Options>) => string) & {
+export type UrlFor<Routes extends LookupList, Options extends any = URLOptions> = (<Identifier extends keyof Routes['ALL'] & string>(...[identifier, params, options]: RouteBuilderArguments<Identifier, Routes['ALL'][Identifier], Options>) => string) & {
     /**
      * Make URL for a GET route. An error will be raised if the route doesn't
      * exist.
@@ -67,7 +82,7 @@ export type UrlFor<Routes extends LookupList, Options extends any = URLOptions>
      * urlFor.get('users.store', [1]) // Error: Route not found GET@users/store
      * ```
      */
-    get<RouteIdentifier extends keyof Routes['GET'] & string>(...[identifier, params, options]: RouteBuilderArguments<Routes, 'GET', RouteIdentifier, Options>): {
+    get<RouteIdentifier extends keyof Routes['GET'] & string>(...[identifier, params, options]: RouteBuilderArguments<RouteIdentifier, Routes['GET'][RouteIdentifier], Options>): {
         method: 'get';
         url: string;
     };
@@ -80,7 +95,7 @@ export type UrlFor<Routes extends LookupList, Options extends any = URLOptions>
      * urlFor.post('users.show', [1]) // Error: Route not found POST@users.show
      * ```
      */
-    post<RouteIdentifier extends keyof Routes['POST'] & string>(...[identifier, params, options]: RouteBuilderArguments<Routes, 'POST', RouteIdentifier, Options>): {
+    post<RouteIdentifier extends keyof Routes['POST'] & string>(...[identifier, params, options]: RouteBuilderArguments<RouteIdentifier, Routes['POST'][RouteIdentifier], Options>): {
         method: 'post';
         url: string;
     };
@@ -93,7 +108,7 @@ export type UrlFor<Routes extends LookupList, Options extends any = URLOptions>
      * urlFor.put('users.show', [1]) // Error: Route not found PUT@users.show
      * ```
      */
-    put<RouteIdentifier extends keyof Routes['PUT'] & string>(...[identifier, params, options]: RouteBuilderArguments<Routes, 'PUT', RouteIdentifier, Options>): {
+    put<RouteIdentifier extends keyof Routes['PUT'] & string>(...[identifier, params, options]: RouteBuilderArguments<RouteIdentifier, Routes['PUT'][RouteIdentifier], Options>): {
         method: 'put';
         url: string;
     };
@@ -106,7 +121,7 @@ export type UrlFor<Routes extends LookupList, Options extends any = URLOptions>
      * urlFor.put('users.show', [1]) // Error: Route not found PATCH@users.show
      * ```
      */
-    patch<RouteIdentifier extends keyof Routes['PATCH'] & string>(...[identifier, params, options]: RouteBuilderArguments<Routes, 'PATCH', RouteIdentifier, Options>): {
+    patch<RouteIdentifier extends keyof Routes['PATCH'] & string>(...[identifier, params, options]: RouteBuilderArguments<RouteIdentifier, Routes['PATCH'][RouteIdentifier], Options>): {
         method: 'patch';
         url: string;
     };
@@ -119,7 +134,7 @@ export type UrlFor<Routes extends LookupList, Options extends any = URLOptions>
      * urlFor.delete('users.show', [1]) // Error: Route not found DELETE@users.show
      * ```
      */
-    delete<RouteIdentifier extends keyof Routes['DELETE'] & string>(...[identifier, params, options]: RouteBuilderArguments<Routes, 'DELETE', RouteIdentifier, Options>): {
+    delete<RouteIdentifier extends keyof Routes['DELETE'] & string>(...[identifier, params, options]: RouteBuilderArguments<RouteIdentifier, Routes['DELETE'][RouteIdentifier], Options>): {
         method: 'delete';
         url: string;
     };
@@ -127,21 +142,19 @@ export type UrlFor<Routes extends LookupList, Options extends any = URLOptions>
      * Make URL for a custom route method. An error will be raised if the route doesn't
      * exist for the same method.
      */
-    method<Method extends keyof Routes & string, RouteIdentifier extends keyof Routes[Method] & string>(method: Method, ...[identifier, params, options]: RouteBuilderArguments<Routes, Method, RouteIdentifier, Options>): {
+    method<Method extends keyof Routes & string, RouteIdentifier extends keyof Routes[Method] & string>(method: Method, ...[identifier, params, options]: RouteBuilderArguments<RouteIdentifier, Routes[Method][RouteIdentifier], Options>): {
         method: Method;
         url: string;
     };
 };
 /**
- * To be generated by the router and used by the URL builder
- * and the LookupStore
+ * Utility type to extract routes for a specific HTTP method from the routes collection
  */
-export interface RoutesList {
-}
+export type GetRoutesForMethod<Routes, Method> = {
+    [K in keyof Routes]: Method extends K ? Routes[Method] : never;
+}[keyof Routes];
 /**
- * Helper to get routes for a given method from the RoutesList. The
- * RoutesList is extended in the userland code.
+ * Interface to be augmented by the router containing all registered routes for type-safe URL generation
  */
-export type GetRoutesForMethod<Method> = {
-    [K in keyof RoutesList]: Method extends K ? RoutesList[Method] : never;
-};
+export interface RoutesList {
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonisjs/http-server",
-  "version": "8.0.0-next.4",
+  "version": "8.0.0-next.6",
   "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",
@@ -88,6 +89,7 @@
     "release-it": "^19.0.4",
     "supertest": "^7.1.4",
     "tsup": "^8.5.0",
+    "typedoc": "^0.28.11",
     "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": {