prapti 0.0.6 → 1.0.2

package/README.md

@@ -106,6 +106,34 @@ const headers = response.validatedHeaders;
 console.log(`Rate limit remaining: ${headers["x-rate-limit-remaining"]}`);
 ```
 
+Notes:
+- When `validate.request.headers` is provided, Prapti preserves original headers and overwrites them with validated values by default.
+- Use `headerValidationMode: "strict"` to send only validated headers.
+- If a header is validated to `null` or `undefined`, it is removed from the outgoing request.
+- Include `content-type` in your header schema if you want it validated; in strict mode, include it if you want it sent.
+
+</details>
+
+<details>
+<summary>Serialization</summary>
+
+By default, Prapti uses `JSON.stringify` and `JSON.parse` for JSON payloads. You can supply a custom serializer per instance:
+
+```typescript
+import superjson from "superjson";
+
+const { fetch } = prapti(zodAdapter, {
+  serializer: {
+    stringify: (value) => superjson.stringify(value),
+    parse: (value) => superjson.parse(value),
+    isJsonContentType: (contentType) =>
+      contentType?.toLowerCase().includes("application/json") ?? false,
+  },
+});
+```
+
+`ValidatedResponse.json()` uses the same serializer for response parsing.
+
 </details>
 
 ## Adapters
@@ -138,12 +166,18 @@ const { fetch } = prapti(customAdapter);
 ## API
 
 <details>
-<summary><code>prapti(adapter)</code></summary>
+<summary><code>prapti(adapter, config?)</code></summary>
 
 Factory function. Pass a validation adapter and get back an enhanced `fetch`.
 
 ```typescript
-const { fetch } = prapti(zodAdapter);
+const { fetch } = prapti(zodAdapter, {
+  serializer: {
+    stringify: JSON.stringify,
+    parse: JSON.parse,
+  },
+  headerValidationMode: "preserve",
+});
 ```
 
 </details>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prapti",
-  "version": "0.0.6",
+  "version": "1.0.2",
   "description": "Type-safe HTTP client with runtime schema validation support for Zod, Valibot, Yup, and more",
   "files": [
     "dist/*",