@afoures/http-client 0.3.0 → 0.4.0

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 import { AbortedError, HttpClientError, NetworkError, ParseError, SerializationError, TimeoutError, UnexpectedError } from "./lib/errors.mjs";
 import { HTTPFetch, HTTPMethod, HTTPStatus, Parser, Pathname, Schema, Serializer } from "./lib/types.mjs";
 import { AnyEndpoint, Endpoint, EndpointDefinition } from "./lib/endpoint.mjs";
-import { EndpointMap, HttpClientOptions, http_client } from "./lib/http-client.mjs";
-export { AbortedError, type AnyEndpoint, Endpoint, type EndpointDefinition, type EndpointMap, type HTTPFetch, type HTTPMethod, type HTTPStatus, HttpClientError, type HttpClientOptions, NetworkError, ParseError, type Parser, type Pathname, type Schema, SerializationError, type Serializer, TimeoutError, UnexpectedError, http_client };
+import { $infer, EndpointMap, HttpClientOptions, http_client } from "./lib/http-client.mjs";
+export { type $infer, AbortedError, type AnyEndpoint, Endpoint, type EndpointDefinition, type EndpointMap, type HTTPFetch, type HTTPMethod, type HTTPStatus, HttpClientError, type HttpClientOptions, NetworkError, ParseError, type Parser, type Pathname, type Schema, SerializationError, type Serializer, TimeoutError, UnexpectedError, http_client };

package/dist/lib/http-client.d.mts

@@ -1,5 +1,5 @@
 import { AbortedError, NetworkError, ParseError, SerializationError, TimeoutError, UnexpectedError } from "./errors.mjs";
-import { HTTPFetch, HTTPMethod, HeadersInitWithReducer, MaybePromise, Schema } from "./types.mjs";
+import { HTTPFetch, HTTPMethod, HeadersInitWithReducer, MaybePromise, Pathname, Pretty, Schema } from "./types.mjs";
 import { AnyEndpoint, Endpoint } from "./endpoint.mjs";
 import * as _standard_schema_spec0 from "@standard-schema/spec";
 
@@ -8,6 +8,23 @@ interface EndpointMap {
   [name: string]: AnyEndpoint | EndpointMap;
 }
 type CustomFetch = (request: Request) => Promise<Response>;
+type Hooks = {
+  on_request?: (request: Request) => void;
+  on_response?: (response: Response) => void;
+};
+declare function fetch_endpoint_factory<http_method extends HTTPMethod.Any, pathname extends Pathname.Relative, params_schema extends Schema._, query_schema extends Schema._, body_schema extends Schema._, data_schema extends Schema._, error_schema extends Schema._>({
+  base_url,
+  endpoint,
+  custom_fetch,
+  get_default_options,
+  hooks
+}: {
+  base_url: string;
+  endpoint: Endpoint<http_method, pathname, params_schema, query_schema, body_schema, data_schema, error_schema>;
+  custom_fetch: CustomFetch;
+  get_default_options?: () => MaybePromise<HTTPFetch.OptionalRequestInit & HTTPFetch.DefaultRequestInit>;
+  hooks?: Hooks;
+}): (input: Pretty<HTTPFetch.TypedParamsInit<pathname, params_schema> & HTTPFetch.TypedQueryInit<query_schema> & HTTPFetch.TypedBodyInit<body_schema> & HTTPFetch.OptionalRequestInit & HTTPFetch.DefaultRequestInit>) => Promise<TimeoutError | AbortedError | SerializationError | ParseError | NetworkError | UnexpectedError | HTTPFetch.RedirectMessage | HTTPFetch.ClientErrorResponse<[error_schema] extends [never] ? string : _standard_schema_spec0.StandardSchemaV1.InferOutput<error_schema>> | HTTPFetch.ServerErrorResponse<[error_schema] extends [never] ? string : _standard_schema_spec0.StandardSchemaV1.InferOutput<error_schema>> | HTTPFetch.SuccessfulResponse<[data_schema] extends [never] ? void : _standard_schema_spec0.StandardSchemaV1.InferOutput<data_schema>>>;
 type HttpClientOptions<endpoints extends EndpointMap> = {
   base_url: string;
   endpoints: endpoints;
@@ -60,5 +77,19 @@ declare function http_client<const endpoints extends EndpointMap>({
 } & Omit<RequestInit, "body" | "method" | "headers"> extends infer T_16 ? { [K_10 in keyof T_16]: T_16[K_10] } : never) => Promise<TimeoutError | AbortedError | SerializationError | ParseError | NetworkError | UnexpectedError | HTTPFetch.RedirectMessage | HTTPFetch.ClientErrorResponse<[error_schema] extends [never] ? string : _standard_schema_spec0.StandardSchemaV1.InferOutput<error_schema>> | HTTPFetch.ServerErrorResponse<[error_schema] extends [never] ? string : _standard_schema_spec0.StandardSchemaV1.InferOutput<error_schema>> | HTTPFetch.SuccessfulResponse<[data_schema] extends [never] ? void : _standard_schema_spec0.StandardSchemaV1.InferOutput<data_schema>>> : T_15[name_9] extends EndpointMap ? (T_15[name_9] extends infer T_17 extends EndpointMap ? { -readonly [name_10 in keyof T_17]: T_17[name_10] extends Endpoint<infer http_method extends HTTPMethod.Any, infer pathname extends `/${string}`, infer params_schema extends Schema._<unknown, unknown>, infer query_schema extends Schema._<unknown, unknown>, infer body_schema extends Schema._<unknown, unknown>, infer data_schema extends Schema._<unknown, unknown>, infer error_schema extends Schema._<unknown, unknown>> ? (input: HTTPFetch.TypedParamsInit<pathname, params_schema> & HTTPFetch.TypedQueryInit<query_schema> & HTTPFetch.TypedBodyInit<body_schema> & HTTPFetch.OptionalRequestInit & {
   headers?: HeadersInitWithReducer;
 } & Omit<RequestInit, "body" | "method" | "headers"> extends infer T_18 ? { [K_11 in keyof T_18]: T_18[K_11] } : never) => Promise<TimeoutError | AbortedError | SerializationError | ParseError | NetworkError | UnexpectedError | HTTPFetch.RedirectMessage | HTTPFetch.ClientErrorResponse<[error_schema] extends [never] ? string : _standard_schema_spec0.StandardSchemaV1.InferOutput<error_schema>> | HTTPFetch.ServerErrorResponse<[error_schema] extends [never] ? string : _standard_schema_spec0.StandardSchemaV1.InferOutput<error_schema>> | HTTPFetch.SuccessfulResponse<[data_schema] extends [never] ? void : _standard_schema_spec0.StandardSchemaV1.InferOutput<data_schema>>> : T_17[name_10] extends EndpointMap ? (T_17[name_10] extends infer T_19 extends EndpointMap ? { -readonly [name_11 in keyof T_19]: T_19[name_11] extends Endpoint<infer http_method extends HTTPMethod.Any, infer pathname extends `/${string}`, infer params_schema extends Schema._<unknown, unknown>, infer query_schema extends Schema._<unknown, unknown>, infer body_schema extends Schema._<unknown, unknown>, infer data_schema extends Schema._<unknown, unknown>, infer error_schema extends Schema._<unknown, unknown>> ? (input: /*elided*/any) => Promise<TimeoutError | AbortedError | SerializationError | ParseError | NetworkError | UnexpectedError | HTTPFetch.RedirectMessage | HTTPFetch.ClientErrorResponse<[error_schema] extends [never] ? string : _standard_schema_spec0.StandardSchemaV1.InferOutput<error_schema>> | HTTPFetch.ServerErrorResponse<[error_schema] extends [never] ? string : _standard_schema_spec0.StandardSchemaV1.InferOutput<error_schema>> | HTTPFetch.SuccessfulResponse<[data_schema] extends [never] ? void : _standard_schema_spec0.StandardSchemaV1.InferOutput<data_schema>>> : T_19[name_11] extends EndpointMap ? /*elided*/any : never } : never) extends infer T_18 ? { [K_11 in keyof T_18]: T_18[K_11] } : never : never } : never) extends infer T_16 ? { [K_10 in keyof T_16]: T_16[K_10] } : never : never } : never) extends infer T_14 ? { [K_9 in keyof T_14]: T_14[K_9] } : never : never } : never) extends infer T_12 ? { [K_8 in keyof T_12]: T_12[K_8] } : never : never } : never) extends infer T_10 ? { [K_7 in keyof T_10]: T_10[K_7] } : never : never } : never) extends infer T_8 ? { [K_6 in keyof T_8]: T_8[K_6] } : never : never } : never) extends infer T_6 ? { [K_5 in keyof T_6]: T_6[K_5] } : never : never } : never) extends infer T_4 ? { [K_4 in keyof T_4]: T_4[K_4] } : never : never } : never) extends infer T_2 ? { [K_3 in keyof T_2]: T_2[K_3] } : never : never } : never) extends infer T ? { [K_2 in keyof T]: T[K_2] } : never : never }[K] };
+type AnyFetchEndpointFunction = ReturnType<typeof fetch_endpoint_factory<any, any, any, any, any, any, any>>;
+declare namespace $infer {
+  type Query<fetch_endpoint extends AnyFetchEndpointFunction> = Parameters<fetch_endpoint>[0] extends {
+    query: infer query;
+  } ? query : never;
+  type Params<fetch_endpoint extends AnyFetchEndpointFunction> = Parameters<fetch_endpoint>[0] extends {
+    params: infer params;
+  } ? params : never;
+  type Body<fetch_endpoint extends AnyFetchEndpointFunction> = Parameters<fetch_endpoint>[0] extends {
+    body: infer body;
+  } ? body : never;
+  type Data<fetch_endpoint extends AnyFetchEndpointFunction> = ReturnType<fetch_endpoint> extends HTTPFetch.SuccessfulResponse<infer data> ? data : never;
+  type Error<fetch_endpoint extends AnyFetchEndpointFunction> = ReturnType<fetch_endpoint> extends HTTPFetch.ClientErrorResponse<infer error> ? error : ReturnType<fetch_endpoint> extends HTTPFetch.ServerErrorResponse<infer error> ? error : never;
+}
 //#endregion
-export { EndpointMap, HttpClientOptions, http_client };
+export { $infer, EndpointMap, HttpClientOptions, http_client };

package/docs/http-client.md

@@ -145,3 +145,46 @@ if (result.ok) {
   console.log(result.error)
 }
 ```
+
+## Type Inference
+
+The `$infer` namespace provides helpers to extract types from endpoint functions:
+
+```typescript
+import { $infer, http_client, Endpoint } from '@afoures/http-client'
+import { z } from 'zod'
+
+const api = http_client({
+  base_url: 'https://api.example.com',
+  endpoints: {
+    users: {
+      list: new Endpoint({
+        method: 'GET',
+        pathname: '/users',
+        data: { schema: z.array(z.object({ id: z.string(), name: z.string() })), parse: 'json' },
+      }),
+      create: new Endpoint({
+        method: 'POST',
+        pathname: '/users',
+        body: { schema: z.object({ name: z.string() }) },
+        data: { schema: z.object({ id: z.string(), name: z.string() }), parse: 'json' },
+      }),
+    },
+  },
+})
+
+type UsersListQuery = $infer.Query<typeof api.users.list>
+type UsersListData = $infer.Data<typeof api.users.list>
+type UsersListParams = $infer.Params<typeof api.users.list>
+type UsersListError = $infer.Error<typeof api.users.list>
+
+type UsersCreateBody = $infer.Body<typeof api.users.create>
+type UsersCreateData = $infer.Data<typeof api.users.create>
+```
+
+Available type helpers:
+- `$infer.Query` - Extracts the query parameter type
+- `$infer.Params` - Extracts the URL params type
+- `$infer.Body` - Extracts the request body type
+- `$infer.Data` - Extracts the successful response data type
+- `$infer.Error` - Extracts the error response type (client or server errors)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@afoures/http-client",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "A typesafe and robust HTTP client",
   "homepage": "https://github.com/afoures/http-client#readme",
   "bugs": {