@fgrzl/fetch 1.4.0-alpha.2 → 1.4.0

package/CONTRIBUTING.md

@@ -146,8 +146,8 @@ export function createClient(config?: ClientConfig): FetchClient {
   const client = new FetchClient(config);
 
   // Apply smart defaults
-  useCSRF(client);
-  useRetry(client);
+  addCSRF(client);
+  addRetry(client);
 
   return client;
 }

package/LICENSE

@@ -1,21 +1,201 @@
-MIT License
-
-Copyright (c) 2025 fgrzl
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to the Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright 2025 Jeffrey M Repanich
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -1,121 +1,141 @@
 [![ci](https://github.com/fgrzl/fetch/actions/workflows/ci.yml/badge.svg)](https://github.com/fgrzl/fetch/actions/workflows/ci.yml)
-[![Dependabot Updates](https://github.com/fgrzl/fetch/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/fgrzl/fetch/actions/workflows/dependabot/dependabot-updates)
 
 # @fgrzl/fetch
 
-A production-ready HTTP client for TypeScript that **just works** out of the box.
+**A TypeScript HTTP client wrapper around `fetch` that adds typed responses, middleware, and sane defaults.**
 
-## ✨ Features
+If you’ve ever thought “I just want a small client that makes `fetch` feel production-ready”, this is it.
 
-- **Pit of Success Design**: Simple defaults that just work, customizable when needed
-- Simple API: `api.get('/api/user')`
-- Built-in CSRF token support (XSRF-TOKEN standard)
-- Smart 401 redirect handling with return URL preservation
-- Retry middleware with configurable strategies
-- Custom middleware support (request/response)
-- TypeScript-first, small and dependency-free
+Use this if you want:
 
-## 📦 Installation
+- ✅ Simple, typed HTTP requests that just work
+- ✅ A consistent response shape (`ok`, `data`, `error`) instead of `try/catch` everywhere
+- ✅ Middleware for auth, retries, caching, logging, CSRF, rate limiting
+- ✅ Zero config to start, full control when needed
+- ✅ TypeScript-first with zero runtime dependencies
 
-**Install**
+Don't use this if you:
+
+- ❌ Need complex GraphQL support
+- ❌ Require advanced request/response transformations
+
+## Quick Start
 
 ```bash
 npm install @fgrzl/fetch
 ```
 
-**Use immediately** - no configuration required:
-
 ```ts
 import api from "@fgrzl/fetch";
 
-// It just works! 🎉
+// Works immediately
 const users = await api.get("https://api.example.com/api/users");
-const newUser = await api.post("https://api.example.com/api/users", {
-  name: "John",
-});
 
-// Built-in error handling
 if (users.ok) {
-  console.log("Users:", users.data);
+  console.log(users.data);
 } else {
-  console.error("Error:", users.error?.message);
+  console.error(users.error?.message);
 }
 ```
 
+## Why This Exists
+
+`fetch` is a great low-level primitive, but most apps end up re-implementing the same things:
+
+- Base URLs + query params
+- Typed responses
+- Retry/backoff
+- Caching
+- Auth header injection
+- Timeouts and cancellation
+- Consistent error handling
+
+`@fgrzl/fetch` provides those in a small, composable way.
+
+## Two Ways To Use It
+
+### 1) Default client (recommended)
+
+The default export is a ready-to-use client with a production-friendly middleware stack (retry, cache, logging, rate limiting). Add auth (or anything else) via middleware when you need it.
+
 ```ts
 import api from "@fgrzl/fetch";
 
-// Set the base url to keep things simple
 api.setBaseUrl("https://api.example.com");
+const users = await api.get("/users");
+```
 
-// It just works! 🎉
-const users = await api.get("/api/users");
-const newUser = await api.post("/api/users", { name: "John" });
+### 2) Custom client
 
-// Built-in error handling
-if (users.ok) {
-  console.log("Users:", users.data);
-} else {
-  console.error("Error:", users.error?.message);
-}
+Start with a plain `FetchClient` (no middleware), then add only what you want.
+
+```ts
+import { FetchClient } from "@fgrzl/fetch";
+
+const client = new FetchClient({ credentials: "omit" });
+const result = await client.get("https://api.example.com/users");
 ```
 
-**Need custom config?** Add it when you need it:
+## What You Can Do
 
-```ts
-import { FetchClient, useAuthentication } from "@fgrzl/fetch";
+| Task | How |
+| --- | --- |
+| Make requests | `api.get()`, `api.post()`, `api.put()`, etc. |
+| Type responses | `api.get<User>("/user")` |
+| Add auth | `addAuthentication(api, { tokenProvider })` |
+| Handle errors | `if (response.ok) { ... } else { ... }` |
+| Cancel / timeout | Pass `signal` or `timeout` in request options |
+| Add retries / cache / logging | Use the prebuilt middleware or stacks |
 
-const authClient = useAuthentication(new FetchClient(), {
-  tokenProvider: () => localStorage.getItem("token") || "",
-});
+## Examples
+
+**Set a base URL:**
+
+```ts
+api.setBaseUrl("https://api.example.com");
+await api.get("/users"); // GET https://api.example.com/users
 ```
 
-**Working with APIs?** Use a base URL:
+**Add authentication:**
 
 ```ts
-import { FetchClient } from "@fgrzl/fetch";
+import api, { addAuthentication } from "@fgrzl/fetch";
 
-const apiClient = new FetchClient({
-  baseUrl: "https://api.example.com",
+const authedApi = addAuthentication(api, {
+  tokenProvider: () => localStorage.getItem("token") || "",
 });
 
-// All relative URLs are prefixed with the base URL
-await apiClient.get("/users"); // → GET https://api.example.com/users
-await apiClient.post("/users", data); // → POST https://api.example.com/users
-
-// Absolute URLs work as expected
-await apiClient.get("https://other-api.com/data"); // → GET https://other-api.com/data
+// Use the authenticated client
+await authedApi.get("/users");
 ```
 
-**Advanced usage** with middleware stacks:
+**Use with TypeScript:**
 
 ```ts
-// Smart defaults - just works
-useCSRF(client);
-useAuthorization(client); // Redirects to /login with return URL
-useRetry(client);
-
-// All requests now return FetchResponse<T>
 interface User {
   id: number;
   name: string;
 }
-const userResponse = await client.get<User>("/api/user");
-if (userResponse.ok) {
-  console.log(userResponse.data.name); // Typed access to data
-} else {
-  console.error(`Failed with status ${userResponse.status}`);
-}
+const response = await api.get<User>("/api/user");
+if (response.ok) console.log(response.data.name);
 ```
 
-## ✨ What You Get Out of the Box
+**Cancel requests and set timeouts:**
 
-- **Zero Configuration** - Works immediately with smart defaults
-- **CSRF Protection** - Automatic XSRF-TOKEN handling
-- **Retry Logic** - Exponential backoff for failed requests
-- **Request Logging** - Built-in observability
-- **TypeScript First** - Full type safety and IntelliSense
-- **Middleware System** - Composable and extensible
+```ts
+const controller = new AbortController();
+const response = await api.get(
+  "/api/data",
+  {},
+  {
+    signal: controller.signal,
+    timeout: 5000, // 5 second timeout
+  },
+);
+
+// Cancel it
+controller.abort();
+```
 
 ## 📚 Documentation
 
@@ -124,26 +144,12 @@ Ready to go deeper? Check out our comprehensive guides:
 - **[Getting Started](docs/getting-started.md)** - Installation and basic usage
 - **[Configuration](docs/configuration.md)** - Advanced client setup
 - **[Middleware](docs/middleware.md)** - Authentication, caching, retries
+- **[Cancellation & Timeouts](docs/cancellation.md)** - Abort requests and set timeouts
 - **[Error Handling](docs/error-handling.md)** - Robust error management
 - **[TypeScript Guide](docs/typescript.md)** - Type-safe API calls
 - **[Troubleshooting](docs/troubleshooting.md)** - Common issues and solutions
-
-### 🔧 For Maintainers
-
-- **[Release Guide](docs/releases.md)** - How to create releases
 - **[Contributing](CONTRIBUTING.md)** - Development setup and guidelines
 
-## 🏗️ Architecture
-
-Built on a **"pit of success"** philosophy where:
-
-- Simple things are simple (`api.get("/path")`)
-- Complex things are possible (custom middleware stacks)
-- TypeScript guides you to correct usage
-- Smart defaults handle 80% of use cases
-
-[Learn more about our architecture →](docs/architecture.md)
-
 ## License
 
 MIT