@afoures/http-client 0.1.1 → 0.3.0

package/docs/response-parsing.md

@@ -56,7 +56,9 @@ type ServerErrorResponse<Error> = {
 
 Define a `data` parser for successful responses:
 
-### JSON (Default)
+### JSON
+
+Use `parse: 'json'` to parse the response body as JSON:
 
 ```typescript
 const endpoint = new Endpoint({
@@ -67,6 +69,7 @@ const endpoint = new Endpoint({
       id: z.string(),
       name: z.string(),
     }),
+    parse: 'json',
   },
 })
 
@@ -84,7 +87,7 @@ const endpoint = new Endpoint({
   pathname: '/health',
   data: {
     schema: z.string(),
-    deserialization: 'text',
+    parse: 'text',
   },
 })
 ```
@@ -97,7 +100,7 @@ const endpoint = new Endpoint({
   pathname: '/data',
   data: {
     schema: z.object({ value: z.number() }),
-    deserialization: async (body) => {
+    parse: async (body) => {
       const text = await new Response(body).text()
       return JSON.parse(text)
     },
@@ -129,13 +132,13 @@ Define an `error` parser for error responses:
 const endpoint = new Endpoint({
   method: 'POST',
   pathname: '/users',
-  body: { schema: z.object({ name: z.string() }) },
+  body: { schema: z.object({ name: z.string() }), serialize: 'json' },
   error: {
     schema: z.object({
       message: z.string(),
       code: z.string(),
     }),
-    deserialization: 'json',
+    parse: 'json',
   },
 })
 
@@ -154,7 +157,7 @@ const endpoint = new Endpoint({
   pathname: '/users/(:id)',
   error: {
     schema: z.string(),
-    deserialization: 'text',
+    parse: 'text',
   },
 })
 
@@ -193,6 +196,7 @@ const endpoint = new Endpoint({
       name: z.string().transform(s => s.toUpperCase()),
       createdAt: z.string().transform(s => new Date(s)),
     }),
+    parse: 'json',
   },
 })
 
@@ -203,15 +207,15 @@ if (result.ok) {
 }
 ```
 
-## Deserialization Errors
+## Parse Errors
 
-If response parsing fails validation, a `DeserializationError` is returned:
+If response parsing fails validation, a `ParseError` is returned:
 
 ```typescript
 const result = await endpoint.parse_response(response)
 
-if (result instanceof DeserializationError) {
-  console.log(result.message) // "Response deserialization failed"
+if (result instanceof ParseError) {
+  console.log(result.message) // "Response parsing failed"
   console.log(result.cause)    // Schema validation issues
 }
 ```

package/docs/retry-policy.md

@@ -177,7 +177,7 @@ const result = await api.users.get({
 
 ```typescript
 const api = http_client({
-  origin: 'https://api.example.com',
+  base_url: 'https://api.example.com',
   endpoints: {
     users: new Endpoint({
       method: 'GET',

package/docs/schema-integration.md

@@ -15,6 +15,7 @@ const endpoint = new Endpoint({
       name: z.string().min(1),
       email: z.string().email(),
     }),
+    serialize: 'json',
   },
   data: {
     schema: z.object({
@@ -22,6 +23,7 @@ const endpoint = new Endpoint({
       name: z.string(),
       createdAt: z.string().datetime(),
     }),
+    parse: 'json',
   },
 })
 ```
@@ -43,6 +45,7 @@ const endpoint = new Endpoint({
     schema: z.object({
       createdAt: z.string().transform(s => new Date(s)), // parse ISO to Date
     }),
+    parse: 'json',
   },
 })
 
@@ -66,6 +69,7 @@ const endpoint = new Endpoint({
       email: 'string',
       age: 'number?',
     }),
+    serialize: 'json',
   },
   data: {
     schema: type({
@@ -73,6 +77,7 @@ const endpoint = new Endpoint({
       name: 'string',
       'email?': 'string',
     }),
+    parse: 'json',
   },
 })
 ```
@@ -90,6 +95,7 @@ const endpoint = new Endpoint({
       id: 'string',
       'createdAt': 'string.parse(v => new Date(v))',
     }),
+    parse: 'json',
   },
 })
 ```
@@ -107,12 +113,14 @@ const endpoint = new Endpoint({
       name: v.pipe(v.string(), v.minLength(1)),
       email: v.pipe(v.string(), v.email()),
     }),
+    serialize: 'json',
   },
   data: {
     schema: v.object({
       id: v.string(),
       name: v.string(),
     }),
+    parse: 'json',
   },
 })
 ```
@@ -130,6 +138,7 @@ const endpoint = new Endpoint({
       id: v.string(),
       createdAt: v.pipe(v.string(), v.transform(s => new Date(s))),
     }),
+    parse: 'json',
   },
 })
 ```
@@ -180,24 +189,24 @@ const UserSchema = z.object({
 const CreateUserSchema = UserSchema.omit({ id: true })
 
 const api = http_client({
-  origin: 'https://api.example.com',
+  base_url: 'https://api.example.com',
   endpoints: {
     users: {
       list: new Endpoint({
         method: 'GET',
         pathname: '/users',
-        data: { schema: z.array(UserSchema) },
+        data: { schema: z.array(UserSchema), parse: 'json' },
       }),
       get: new Endpoint({
         method: 'GET',
         pathname: '/users/(:id)',
-        data: { schema: UserSchema },
+        data: { schema: UserSchema, parse: 'json' },
       }),
       create: new Endpoint({
         method: 'POST',
         pathname: '/users',
-        body: { schema: CreateUserSchema },
-        data: { schema: UserSchema },
+        body: { schema: CreateUserSchema, serialize: 'json' },
+        data: { schema: UserSchema, parse: 'json' },
       }),
     },
   },

package/docs/serialization.md

@@ -17,7 +17,7 @@ const endpoint = new Endpoint({
 })
 
 const url = await endpoint.generate_url({
-  origin: 'https://api.example.com',
+  base_url: 'https://api.example.com',
   params: { id: '123' },
 })
 // https://api.example.com/users/123
@@ -41,7 +41,7 @@ const endpoint = new Endpoint({
 
 ### Custom Serialization
 
-Provide a `serialization` function to transform validated params:
+Provide a `serialize` function to transform validated params:
 
 ```typescript
 const endpoint = new Endpoint({
@@ -49,12 +49,12 @@ const endpoint = new Endpoint({
   pathname: '/users/(:id)',
   params: {
     schema: z.object({ id: z.number() }),
-    serialization: (data) => ({ id: `user-${data.id}` }),
+    serialize: (data) => ({ id: `user-${data.id}` }),
   },
 })
 
 const url = await endpoint.generate_url({
-  origin: 'https://api.example.com',
+  base_url: 'https://api.example.com',
   params: { id: 123 },
 })
 // https://api.example.com/users/user-123
@@ -79,7 +79,7 @@ const endpoint = new Endpoint({
 })
 
 const url = await endpoint.generate_url({
-  origin: 'https://api.example.com',
+  base_url: 'https://api.example.com',
   query: { page: 1, search: 'john' },
 })
 // https://api.example.com/users?page=1&search=john
@@ -95,7 +95,7 @@ const endpoint = new Endpoint({
     schema: z.object({
       tags: z.array(z.string()),
     }),
-    serialization: (data) => {
+    serialize: (data) => {
       const params = new URLSearchParams()
       params.set('tags', data.tags.join(','))
       return params
@@ -104,7 +104,7 @@ const endpoint = new Endpoint({
 })
 
 const url = await endpoint.generate_url({
-  origin: 'https://api.example.com',
+  base_url: 'https://api.example.com',
   query: { tags: ['admin', 'active'] },
 })
 // https://api.example.com/users?tags=admin,active
@@ -114,9 +114,9 @@ const url = await endpoint.generate_url({
 
 Request bodies are serialized for POST, PUT, PATCH, and DELETE methods.
 
-### JSON (Default)
+### JSON
 
-For JSON-compatible schemas, JSON serialization is automatic:
+Use `serialize: 'json'` to serialize the body as JSON:
 
 ```typescript
 const endpoint = new Endpoint({
@@ -127,6 +127,7 @@ const endpoint = new Endpoint({
       name: z.string(),
       email: z.string().email(),
     }),
+    serialize: 'json',
   },
 })
 
@@ -150,7 +151,7 @@ const endpoint = new Endpoint({
       file: z.instanceof(File),
       name: z.string(),
     }),
-    serialization: (data) => {
+    serialize: (data) => {
       const formData = new FormData()
       formData.append('file', data.file)
       formData.append('name', data.name)
@@ -171,7 +172,7 @@ const endpoint = new Endpoint({
       username: z.string(),
       password: z.string(),
     }),
-    serialization: (data) => {
+    serialize: (data) => {
       const params = new URLSearchParams()
       params.set('username', data.username)
       params.set('password', data.password)
@@ -189,7 +190,7 @@ const endpoint = new Endpoint({
   pathname: '/echo',
   body: {
     schema: z.string(),
-    serialization: (text) => ({
+    serialize: (text) => ({
       body: text,
       content_type: 'text/plain',
     }),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@afoures/http-client",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "A typesafe and robust HTTP client",
   "homepage": "https://github.com/afoures/http-client#readme",
   "bugs": {
@@ -35,12 +35,12 @@
     "@standard-schema/spec": "^1.1.0"
   },
   "devDependencies": {
-    "@afoures/auto-release": "^0.4.1",
+    "@afoures/auto-release": "^0.5.0",
     "@arktype/attest": "^0.56.0",
-    "@types/node": "^24.12.0",
-    "msw": "^2.12.10",
+    "@types/node": "^24.12.2",
+    "msw": "^2.13.2",
     "oxfmt": "^0.36.0",
-    "oxlint": "^1.51.0",
+    "oxlint": "^1.59.0",
     "tsdown": "^0.21.0",
     "typescript": "^5.9.3",
     "zod": "^4.3.6"