feat: 🎸 New API

BREAKING CHANGE: 🧨 Changed almost all library APIs

Author: prc5

.bin/jest.sh

@@ -8,8 +8,8 @@ cwd=$(echo "$jest_config" | sed 's|\(.*\)/.*|\1|')
 
 cd "$cwd"
 
-command="yarn jest '$1' -c $jest_config -t '$5' $6"
+request="yarn jest '$1' -c $jest_config -t '$5' $6"
 
-eval "$command"
+eval "$request"
 
 cd ../..

README.md

@@ -73,7 +73,7 @@ particular `caching`, `queuing`, `persistence`, `offline first support`, `reques
 
 🔋 **Offline First** - [Read more](https://hyperfetch.bettertyped.com/docs/guides/Advanced/Offline)
 
-📡 **Built-in client** - [Read more](https://hyperfetch.bettertyped.com/docs/documentation/Core/Client)
+📡 **Built-in adapter** - [Read more](https://hyperfetch.bettertyped.com/docs/documentation/Core/Adapter)
 
 🧪 **Easy to test** - [Read more](https://hyperfetch.bettertyped.com/docs/documentation/Getting%20Started/Testing)
 
@@ -182,17 +182,17 @@ yarn add @hyper-fetch/core @hyper-fetch/react
 #### Simple Setup
 
 ```tsx
-import { Builder } from "@hyper-fetch/core";
+import { Client } from "@hyper-fetch/core";
 
 // Create global setup
-export const builder = new Builder({ url: "http://localhost:3000" });
+export const client = new Client({ url: "http://localhost:3000" });
 
-// Create reusable commands to trigger requests
-export const postData = builder.createCommand<ResponseType, RequestType, LocalErrorType, QueryParamsType>()({
+// Create reusable requests to trigger requests
+export const postData = client.createRequest<ResponseType, RequestType, LocalErrorType, QueryParamsType>()({
   method: "POST",
   endpoint: "/data/:accountId",
 });
-export const getData = builder.createCommand<ResponseType, RequestType, LocalErrorType, QueryParamsType>()({
+export const getData = client.createRequest<ResponseType, RequestType, LocalErrorType, QueryParamsType>()({
   method: "GET",
   endpoint: "/user",
 });
@@ -201,17 +201,17 @@ export const getData = builder.createCommand<ResponseType, RequestType, LocalErr
 #### Triggering request
 
 ```tsx
-// Set the information to command (methods return command clone - NOT mutating the source)
-const command = postData
+// Set the information to request (methods return request clone - NOT mutating the source)
+const request = postData
   .setParams({ accountId: 104 }) // Set Params
   .setQueryParams({ paramOne: "test", paramTwo: "test2" })
   .setData({ name: "My new entity", description: "Some description" }); // Add payload data
 
-// Use command directly
-const [data, error, status] = await command.send();
+// Use request directly
+const [data, error, status] = await request.send();
 
 // OR pass dynamic data directly to '.send' method
-const [data, error, status] = await command.send({
+const [data, error, status] = await request.send({
   params: { accountId: 104 },
   data: { name: "My new entity", description: "Some description" },
   queryParams: { paramOne: "test", paramTwo: "test2" },
@@ -244,7 +244,7 @@ onError((error) => {
 ```tsx
 import { useSubmit } from "@hyper-fetch/react";
 
-const { submit, data, error, submitting, onSubmitSuccess, onSubmitError } = useSubmit(command);
+const { submit, data, error, submitting, onSubmitSuccess, onSubmitError } = useSubmit(request);
 
 onSuccess((data) => {
   console.log(data);
@@ -262,7 +262,7 @@ return <button onClick={() => submit()}>Trigger request!</button>;
 ```tsx
 import { useSubmit } from "@hyper-fetch/react";
 
-const { submit, data, error, submitting, onSubmitSuccess, onSubmitError } = useSubmit(command);
+const { submit, data, error, submitting, onSubmitSuccess, onSubmitError } = useSubmit(request);
 
 onSuccess((data) => {
   console.log(data);
@@ -293,7 +293,7 @@ return (
 import { useSubmit } from "@hyper-fetch/react";
 
 // Manual triggering
-const { submit, data, error, submitting, onSubmitSuccess, onSubmitError } = useSubmit(command);
+const { submit, data, error, submitting, onSubmitSuccess, onSubmitError } = useSubmit(request);
 
 onSuccess((data) => {
   console.log(data);

documentation/README.md

@@ -1,7 +1,6 @@
 # Website
 
-This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website
-generator.
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
 
 ### Installation
 
@@ -15,23 +14,23 @@ $ yarn
 $ yarn start
 ```
 
-This command starts a local development server and opens up a browser window. Most changes are
-reflected live without having to restart the server.
+This request starts a local development server and opens up a browser window. Most changes are reflected live without
+having to restart the server.
 
 ### Build
 
 ```
 $ yarn build
 ```
 
-This command generates static content into the `build` directory and can be served using any static
-contents hosting service.
+This request generates static content into the `build` directory and can be served using any static contents hosting
+service.
 
 ### Deployment
 
 ```
 $ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
 ```
 
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and
-push to the `gh-pages` branch.
+If you are using GitHub pages for hosting, this request is a convenient way to build the website and push to the
+`gh-pages` branch.

documentation/blog/2021-12-29-introducing-hyper-fetch.md

@@ -26,7 +26,7 @@ in systems that need offline or even persistent cache and request queues. It was
 classes for those purposes but it also suited my philosophy of writing interceptors in tests, where the functional
 approach requires copying part of the setup or extracting it significantly around files. As one of the lazy type of
 developers, the most pleasant thing was to write a class based shared setup, where the tester or developer could connect
-to such a builder or a specific command, thanks to which he based everything on the current setup running in the
+to such a client or a specific request, thanks to which he based everything on the current setup running in the
 application. Thanks to this approach, the tests were more maintainable, any changes in the structure were visible
 immediately thanks to typescript and the smaller config values were updated automatically, e.g. adding change to the
 name of the endpoint did not have to be corrected in the tests because it uses actual app setup. It is simply a
@@ -43,19 +43,19 @@ plugins and extensions - we are very open to help in testing and development, bu
 approved by the creators, especially at the beginning of the road, where testing and it may take us a while to cover
 everything with testing.
 
-## Builder
+## Client
 
-Builder is a class thanks to which we can control the entire process of interaction with the server. This is where all
-request sending queues, cache and other modules necessary for operation, such as the http client, are initialized. Its
+Client is a class thanks to which we can control the entire process of interaction with the server. This is where all
+request sending queues, cache and other modules necessary for operation, such as the http adapter, are initialized. Its
 main purpose is to set up one place where we prepare our connection, first of all establishing the base url of our
-server. With the setup builder behind us, we can create new instances of commands that will be able to use the prepared
+server. With the setup client behind us, we can create new instances of requests that will be able to use the prepared
 setup and derive information from it.
 
-## Command
+## Request
 
-Command is an interaction with a given endpoint. During initialization, we set the path, method and a whole range of
+Request is an interaction with a given endpoint. During initialization, we set the path, method and a whole range of
 interesting options such as cache time, retries count etc. It keeps the configuration needed to execute the request or
-to dump it and save in queue storage to wait for its turn. The biggest advantage of Command is simplicity and the
+to dump it and save in queue storage to wait for its turn. The biggest advantage of Request is simplicity and the
 ability to quickly set the entire configuration - only one option is required - the endpoint(method is defaulted to
 GET).
 

documentation/docs/documentation/01-Getting Started/Comparison.mdx

@@ -13,7 +13,7 @@ Hyper Fetch is not just a wrapper; it offers full control over the flow and obse
 were to introduce:
 
 - a data storage standard,
-- offer an embedded HTTP client,
+- offer an embedded HTTP adapter,
 - reduce setup times,
 - solve major architectural difficulties.
 
@@ -30,8 +30,8 @@ data needs to be corrected, please let us know by opening an issue.
 
 - Easy upload/download progress and ETA tracking
 - Supports request queueing and many [dispatching strategies](/documentation/02-Core/Dispatcher.mdx#dispatching-modes)!
-- [Command](/documentation/02-Core/Command.mdx) / [Builder](/documentation/02-Core/Builder.mdx) pattern gives you
-  amazing control over requests at any time
+- [Command](/documentation/02-Core/Request.mdx) / [Builder](/documentation/02-Core/Client.mdx) pattern gives you amazing
+  control over requests at any time
 - Code-sharing architecture lets [testers to hook into development setup and types](/documentation/01-Getting
   Started/Testing.mdx)
 - Features flat side-effects [helper hooks annotation](/documentation/04-React/01-Overview.mdx#helper-hooks) and
@@ -89,14 +89,14 @@ data needs to be corrected, please let us know by opening an issue.
       </tr>
       <tr>
         <td>Caching Approach</td>
-        <td>Command Schema</td>
+        <td>Request Schema</td>
         <td>Hierarchical Key > Value</td>
         <td>Unique Key > Value</td>
         <td>Normalized Schema</td>
       </tr>
       <tr>
         <td>Cache Key Strategy</td>
-        <td>Command Key</td>
+        <td>Request Key</td>
         <td>JSON</td>
         <td>JSON</td>
         <td>GraphQL Query</td>
@@ -117,7 +117,7 @@ data needs to be corrected, please let us know by opening an issue.
       </tr>
       <tr>
         <td>Queue Key Strategy</td>
-        <td>Command Key</td>
+        <td>Request Key</td>
         <td>N/A</td>
         <td>N/A</td>
         <td>N/A</td>
@@ -143,8 +143,8 @@ data needs to be corrected, please let us know by opening an issue.
       </tr>
       <tr>
         <td>
-          Shared Command{" "}
-          <Tippy content="Being able to prepare commands to be reused in the application">
+          Shared Request{" "}
+          <Tippy content="Being able to prepare requests to be reused in the application">
             <span>ℹ️</span>
           </Tippy>
         </td>
@@ -277,8 +277,8 @@ data needs to be corrected, please let us know by opening an issue.
       </tr>
       <tr>
         <td>
-          Default Client{" "}
-          <Tippy content="Library includes prepared client for requesting">
+          Default Adapter{" "}
+          <Tippy content="Library includes prepared adapter for requesting">
             <span>ℹ️</span>
           </Tippy>
         </td>
@@ -597,7 +597,7 @@ data needs to be corrected, please let us know by opening an issue.
       <tr>
         <td>
           File Uploading{" "}
-          <Tippy content="File upload with built-in client">
+          <Tippy content="File upload with built-in adapter">
             <span>ℹ️</span>
           </Tippy>
         </td>
@@ -632,8 +632,8 @@ data needs to be corrected, please let us know by opening an issue.
       </tr>
       <tr>
         <td>
-          Simple Command Execution{" "}
-          <Tippy content="Possibility to trigger requests commands">
+          Simple Request Execution{" "}
+          <Tippy content="Possibility to trigger requests requests">
             <span>ℹ️</span>
           </Tippy>
         </td>
@@ -804,8 +804,8 @@ data needs to be corrected, please let us know by opening an issue.
       </tr>
       <tr>
         <td>
-          Command state tracking types{" "}
-          <Tippy content="Types to check if you already set the data/params/query params on given command to prevent data corruption">
+          Request state tracking types{" "}
+          <Tippy content="Types to check if you already set the data/params/query params on given request to prevent data corruption">
             <span>ℹ️</span>
           </Tippy>
         </td>

documentation/docs/documentation/01-Getting Started/Development.mdx

@@ -5,20 +5,20 @@ sidebar_position: 5
 ## Structure
 
 1. Structure is critically important, so we'll explain how we approach it in HyperFetch. First of all, we create a
-   directory for our `builder` and its `commands`. We export the prepared elements from this directory.
+   directory for our `client` and its `requests`. We export the prepared elements from this directory.
 
 2. Next, we create a directory for each entity in our system (i.e. users, todos, categories, products, groups ...) and
-   store our commands.
+   store our requests.
 
 3. During this setup, we maintain maximum re-usability; thanks to the usage of classes and object-oriented approach, we
-   can access these elements from anywhere. We can reuse our previously-prepared commands in any component. Also, tests
+   can access these elements from anywhere. We can reuse our previously-prepared requests in any component. Also, tests
    have full access without any setup duplication – they use the current settings.
 
 ```
 src
 │
 ├── api
-│   ├── builder.ts
+│   ├── client.ts
 │   ├── users
 │   │   ├── users.api.ts
 │   │   └── index.ts
@@ -39,12 +39,12 @@ You can debug apps in one of two ways:
 
 ** 1. Use the built-in logger **
 
-Use the builder `setDebug(true)` method for this. It will start logging actions in the console. To adjust what type of
+Use the client `setDebug(true)` method for this. It will start logging actions in the console. To adjust what type of
 logs will be shown, use `setLoggerSeverity(3)` to get debug logs displayed in the console. Those will show you the exact
 data and information flow in the library while working on your application.
 
 ** 2. Create your own logger **
 
 You can create your own dev tools based on events sent from the
-[commandManager](/documentation/02-Core/Managers.mdx#commandmanager). There is no limitation, and you can receive all
+[requestManager](/documentation/02-Core/Managers.mdx#requestmanager). There is no limitation, and you can receive all
 necessary data to create everything you may need.

documentation/docs/documentation/01-Getting Started/Quick Start.mdx

@@ -11,22 +11,22 @@ The basic version of Hyper Fetch is not associated with any framework or library
 
 :::
 
-### 1. Initialize the Builder
+### 1. Initialize the Client
 
-The first step in implementing Hyper Fetch is to initialize the **[Builder](/documentation/02-Core/Builder.mdx)**. It
+The first step in implementing Hyper Fetch is to initialize the **[Client](/documentation/02-Core/Client.mdx)**. It
 manages the basic configuration for connection to the server and all Hyper Fetch’s essential elements (i.e. instances of
 **dispatchers**, **cache**, and **app managers**). Start by determining the `url` of your server.
 
-```tsx title="/src/server/builder.ts"
-import { Builder } from "@hyper-fetch/core";
+```tsx title="/src/server/client.ts"
+import { Client } from "@hyper-fetch/core";
 
-export const builder = new Builder({ url: "http://localhost:3000" });
+export const client = new Client({ url: "http://localhost:3000" });
 ```
 
-### 2. Create Commands
+### 2. Create Requests
 
-Then, having already prepared a connection to the server, we use the builder method to create
-**[commands](/documentation/02-Core/Command.mdx)** and assign types to them.
+Then, having already prepared a connection to the server, we use the client method to create
+**[requests](/documentation/02-Core/Request.mdx)** and assign types to them.
 
 :::caution
 
@@ -37,15 +37,15 @@ resolved.
 :::
 
 ```tsx title="/src/server/auth/auth.ts"
-import { builder } from "../builder.ts";
+import { client } from "../client.ts";
 
 type ResponseType = { token: string; refreshToken: string };
 type RequestType = { email: string; password: string };
 
-const postLogin = builder.createCommand<ResponseType, RequestType>()({ method: "POST", endpoint: "/auth/login" });
+const postLogin = client.createRequest<ResponseType, RequestType>()({ method: "POST", endpoint: "/auth/login" });
 ```
 
-### 3. Use Commands
+### 3. Use Requests
 
 <Tabs>
   <TabItem value="React" label="React" default>