Multiple improvements

openapi-ts · Jun 16, 2023 · b7648f6 · b7648f6
1 parent 3a4f410
commit b7648f6
Show file tree

Hide file tree

Showing 9 changed files with 532 additions and 402 deletions.
diff --git a/.changeset/beige-ligers-hunt.md b/.changeset/beige-ligers-hunt.md
@@ -0,0 +1,5 @@
+---
+"openapi-fetch": patch
+---
+
+Clone response internally
diff --git a/.changeset/khaki-bobcats-shave.md b/.changeset/khaki-bobcats-shave.md
@@ -0,0 +1,5 @@
+---
+"openapi-fetch": minor
+---
+
+Expose createFinalURL() logic for testing
diff --git a/.changeset/khaki-cycles-cough.md b/.changeset/khaki-cycles-cough.md
@@ -0,0 +1,5 @@
+---
+"openapi-fetch": minor
+---
+
+Automatically remove `undefined` and `null` query params without requiring querySerializer
diff --git a/.changeset/long-llamas-attend.md b/.changeset/long-llamas-attend.md
@@ -0,0 +1,5 @@
+---
+"openapi-fetch": patch
+---
+
+Strip trailing slashes from baseUrl
diff --git a/.changeset/mighty-dots-hammer.md b/.changeset/mighty-dots-hammer.md
@@ -0,0 +1,5 @@
+---
+"openapi-fetch": patch
+---
+
+Fix querySerializer typing
diff --git a/.changeset/rude-bikes-happen.md b/.changeset/rude-bikes-happen.md
@@ -0,0 +1,5 @@
+---
+"openapi-fetch": minor
+---
+
+Allow overriding of JSON body parsing
diff --git a/docs/src/content/docs/openapi-fetch/api.md b/docs/src/content/docs/openapi-fetch/api.md
@@ -27,14 +27,15 @@ const { get, put, post, del, options, head, patch, trace } = createClient<paths>
 const { data, error, response } = await get("/my-url", options);
 ```
 
-| Name              |        Type         | Description                                                                                                                                                                                   |
-| :---------------- | :-----------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `params`          |    ParamsObject     | Provide `path` and `query` params from the OpenAPI schema                                                                                                                                     |
-| `params.path`     | `{ [name]: value }` | Provide all `path` params (params that are part of the URL)                                                                                                                                   |
-| `params.query`    | `{ [name]: value }` | Provide all `query params (params that are part of the <a href="https://developer.mozilla.org/en-US/docs/Web/API/URL/searchParams" target="_blank" rel="noopener noreferrer">searchParams</a> |
-| `body`            | `{ [name]:value }`  | The <a href="https://spec.openapis.org/oas/latest.html#request-body-object" target="_blank" rel="noopener noreferrer">requestBody</a> data, if needed (PUT/POST/PATCH/DEL only)               |
-| `querySerializer` |   QuerySerializer   | (optional) Override default param serialization (see [Parameter Serialization](#parameter-serialization))                                                                                     |
-| (Fetch options)   |                     | Any valid fetch option (`headers`, `mode`, `cache`, `signal` …) (<a href="https://developer.mozilla.org/en-US/docs/Web/API/fetch#options" target="_blank" rel="noopener noreferrer">docs</a>) |
+| Name              |                     Type                      | Description                                                                                                                                                                                   |
+| :---------------- | :-------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `params`          |                 ParamsObject                  | Provide `path` and `query` params from the OpenAPI schema                                                                                                                                     |
+| `params.path`     |              `{ [name]: value }`              | Provide all `path` params (params that are part of the URL)                                                                                                                                   |
+| `params.query`    |              `{ [name]: value }`              | Provide all `query params (params that are part of the <a href="https://developer.mozilla.org/en-US/docs/Web/API/URL/searchParams" target="_blank" rel="noopener noreferrer">searchParams</a> |
+| `body`            |              `{ [name]:value }`               | The <a href="https://spec.openapis.org/oas/latest.html#request-body-object" target="_blank" rel="noopener noreferrer">requestBody</a> data, if needed (PUT/POST/PATCH/DEL only)               |
+| `querySerializer` |                QuerySerializer                | (optional) Override default param serialization (see [Parameter Serialization](#parameter-serialization))                                                                                     |
+| `parseAs`         | `"json" \| "arrayBuffer" \| "blob" \| "text"` | Decide how to parse the response body (default: `"json"`)                                                                                                                                     |
+| (Fetch options)   |                                               | Any valid fetch option (`headers`, `mode`, `cache`, `signal` …) (<a href="https://developer.mozilla.org/en-US/docs/Web/API/fetch#options" target="_blank" rel="noopener noreferrer">docs</a>) |
 
 ### Parameter Serialization