@zimic/fetch 0.4.0 → 0.4.1-canary.0

package/README.md

@@ -13,9 +13,9 @@
 <p align="center">
   <a href="https://www.npmjs.com/package/@zimic/fetch">npm</a>
   <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-  <a href="https://github.com/zimicjs/zimic/wiki">Docs</a>
+  <a href="https://zimic.dev">Docs</a>
   <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
-  <a href="#examples">Examples</a>
+  <a href="https://zimic.dev/docs/examples">Examples</a>
   <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
   <a href="https://github.com/zimicjs/zimic/issues">Issues</a>
   <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
@@ -36,152 +36,30 @@
 
 ---
 
-- [Features](#features)
-- [Getting started](#getting-started)
-  - [Installation](#installation)
-- [Basic usage](#basic-usage)
-- [Documentation](#documentation)
-- [Examples](#examples)
-- [Changelog](#changelog)
-- [Contributing](#contributing)
+`@zimic/fetch` is a minimal (~2 kB minified and gzipped) and type-safe `fetch`-like API client.
 
----
+Status: :seedling: **Beta**
+
+## Features
 
-`@zimic/fetch` is a minimal (~2 kB minified and gzipped), zero-dependency, and type-safe `fetch`-like API client.
+- :zap: **Type-safe `fetch`**
 
-> [!WARNING]
->
-> Status: :seedling: **Beta**
+  Use your [`@zimic/http` schema](https://zimic.dev/docs/http/guides/schemas) to create a type-safe
+  [`fetch`-like](https://developer.mozilla.org/docs/Web/API/Fetch_API) API client and have your requests and responses
+  fully typed by default.
 
-## Features
+- :sparkles: **Zero dependencies**
+
+  `@zimic/fetch` has no external dependencies, making it a lightweight and fast alternative to other HTTP clients.
+
+- :muscle: **Developer experience**
+
+  Define default options to apply to your requests, such as a base URL, headers, search parameters, and more. Inspect
+  and modify requests and responses using [`onRequest`](https://zimic.dev/docs/fetch/api/fetch#onrequest) and
+  [`onResponse`](https://zimic.dev/docs/fetch/api/fetch#onresponse) listeners.
+
+**Learn more**:
 
-- :sparkles: **Type-safe `fetch`**: Create a type-safe
-  [`fetch`-like](https://developer.mozilla.org/docs/Web/API/Fetch_API) API client. Use your
-  [`@zimic/http` schema](https://github.com/zimicjs/zimic/wiki/api‐zimic‐http‐schemas) and have your requests and
-  responses fully typed by default.
-- :muscle: **Developer experience**: `@zimic/fetch` seeks to be as compatible with the
-  [native Fetch API](https://developer.mozilla.org/docs/Web/API/Fetch_API) as possible, while providing an ergonomic
-  interface to improve type safety. Define default options to apply to your requests, such as a base URL, headers,
-  search parameters, and more. Inspect and modify requests and responses using
-  [`onRequest`](https://github.com/zimicjs/zimic/wiki/api‐zimic‐fetch#fetchonrequest) and
-  [`onResponse`](https://github.com/zimicjs/zimic/wiki/api‐zimic‐fetch#fetchonresponse) listeners.
-
-## Getting started
-
-Check our [getting started guide](https://github.com/zimicjs/zimic/wiki/getting‐started‐fetch).
-
-### Installation
-
-| Manager | Command                                       |
-| :-----: | --------------------------------------------- |
-|   npm   | `npm install @zimic/http @zimic/fetch --save` |
-|  yarn   | `yarn add @zimic/http @zimic/fetch`           |
-|  pnpm   | `pnpm add @zimic/http @zimic/fetch`           |
-
-## Basic usage
-
-1.  Declare your HTTP schema using [`@zimic/http`](https://github.com/zimicjs/zimic/wiki/api‐zimic‐http):
-
-    ```ts
-    import { type HttpSchema } from '@zimic/http';
-
-    interface User {
-      username: string;
-    }
-
-    interface RequestError {
-      code: string;
-      message: string;
-    }
-
-    type Schema = HttpSchema<{
-      '/users': {
-        POST: {
-          request: { body: User };
-          response: {
-            201: { body: User };
-            400: { body: RequestError };
-            409: { body: RequestError };
-            500: { body: RequestError };
-          };
-        };
-
-        GET: {
-          request: {
-            searchParams: {
-              query?: string;
-              limit?: number;
-            };
-          };
-          response: {
-            200: { body: User[] };
-            404: { body: RequestError };
-            500: { body: RequestError };
-          };
-        };
-      };
-
-      '/users/:userId': {
-        PATCH: {
-          request: {
-            headers: { authorization: string };
-            body: Partial<User>;
-          };
-          response: {
-            204: {};
-            400: { body: RequestError };
-            500: { body: RequestError };
-          };
-        };
-      };
-    }>;
-    ```
-
-2.  Create your [fetch client](https://github.com/zimicjs/zimic/wiki/api‐zimic‐fetch#createfetch):
-
-    ```ts
-    import { createFetch } from '@zimic/fetch';
-
-    const fetch = createFetch<Schema>({
-      baseURL: 'http://localhost:3000',
-    });
-    ```
-
-3.  Enjoy requests and responses typed by default!
-
-    ```ts
-    const response = await fetch('/users', {
-      method: 'GET',
-      searchParams: { query: 'u', limit: 10 },
-    });
-
-    if (response.status === 404) {
-      return null; // Not found
-    }
-
-    if (!response.ok) {
-      throw response.error;
-    }
-
-    const users = await response.json();
-    return users; // User[]
-    ```
-
-## Documentation
-
-- [Introduction](https://github.com/zimicjs/zimic/wiki)
-- [Getting started](https://github.com/zimicjs/zimic/wiki/getting‐started‐fetch)
-- [API reference](https://github.com/zimicjs/zimic/wiki/api‐zimic‐fetch)
-
-## Examples
-
-Visit our [examples](../../examples/README.md) to see how to use Zimic with popular frameworks, libraries, and use
-cases.
-
-## Changelog
-
-The changelog is available on our [GitHub Releases](https://github.com/zimicjs/zimic/releases) page.
-
-## Contributing
-
-Interested in contributing to Zimic? Check out our [contributing guide](../../CONTRIBUTING.md) to get started!
+- [`@zimic/fetch` - Getting started](https://zimic.dev/docs/fetch/getting-started)
+- [`@zimic/fetch` - Guides](https://zimic.dev/docs/fetch/guides)
+- [`@zimic/fetch` - API](https://zimic.dev/docs/fetch/api)

package/package.json

@@ -13,7 +13,7 @@
     "api",
     "static"
   ],
-  "version": "0.4.0",
+  "version": "0.4.1-canary.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/zimicjs/zimic.git",
@@ -68,8 +68,8 @@
     "vitest": "^3.1.2",
     "@zimic/eslint-config-node": "0.0.0",
     "@zimic/lint-staged-config": "0.0.0",
+    "@zimic/interceptor": "0.19.1-canary.0",
     "@zimic/tsconfig": "0.0.0",
-    "@zimic/interceptor": "0.19.0-canary.2",
     "@zimic/utils": "0.0.0"
   },
   "peerDependencies": {
@@ -92,6 +92,6 @@
     "test": "dotenv -v NODE_ENV=test -- vitest",
     "test:turbo": "dotenv -v CI=true -- pnpm run test run --coverage",
     "types:check": "tsc --noEmit",
-    "deps:init": "playwright install chromium"
+    "deps:prepare": "playwright install chromium"
   }
 }