@hulanbv/nest-utilities-client-state
v1.2.2
Published
React hooks for state management when using nest-utilities-client and a nest-utilities based API.
Downloads
93
Keywords
Readme
nest-utilities-client-state
An extension for nest-utilities-client, providing an easy way to transition your HTTP services and data to reusable state through React hooks.
Installation
npm i @hulanbv/nest-utilities-client-state
Why?
How does it work?
NUCS keeps a live state for every unique request hook you use. A request's uniqueness is determined by i.a. it's NUC service, endpoint and http options.
For example, if you wanted to use a request state for fetching all users with name "Alex", you would use useAll(userService, { filter: { name: { $eq: "Alex" }}})
.
The request state's defining properties are userService
, and query name=Alex
. Under the hood, those properties are used to generate an identifier for this particular request state. If you were to implement another request hook with those exact same parameters, the already created request state will be used, because their identifiers are equal. Therefor that state could be shared by multiple components and/or compositions and their respectable states and views will be synchronized.
How to use & examples
The packages provides a set of pre-made hooks regarding common use cases for persistant data (e.g. CRUD functions).
| Hook | CRUD Function |
| ----------- | ------------- |
| useAll
| GET |
| useById
| GET |
| useDelete
| DELETE |
| useMany
| GET |
| usePatch
| PATCH |
| usePost
| POST |
| usePut
| PUT |
Or, for edge cases: useRequest
.
All these hooks return an IRequestState object. The following example implements request state properties in a practical context.
Simple implementation
This react function component renders some user info.
function User({ id: string }) {
const { data } = useById(userService, id);
return (
<div data-id={data?.id}>
<p>{data?.firstName}</p>
<p>{data?.email}</p>
<p>{data?.dateOfBirth}</p>
</div>
);
}
Extensive example
This example renders a list of user mail adresses, and implements all provided state properties.
function EmailList() {
// Create a request state for "all" users.
const { data, response, fetchState, call, cacheKey, service } = useAll(
// pass our user service
userService,
// limit results by 10, using http options
{ limit: 10 },
// cache the response data
{ cache: true }
);
// When the `cache` option is set, data will be saved to local storage under a key. This key is provided through `cacheKey`.
useEffect(() => {
console.log(localStorage.getItem(cacheKey));
}, [cacheKey]);
// Show a loading message while promise is pending
if (fetchState === FetchState.Pending) return 'Loading...';
// Show email list when response is ok, else show error.
return response?.ok ? (
<div>
{/* Call the provided `call` method, which will (re)execute the fetch request. */}
<button onClick={() => call()}>{'Refresh data'}</button>
{/* Render your data */}
{data?.map((user) => (
<div key={user.id}>{user.email}</div>
))}
</div>
) : (
<p>Error: {response?.data.message}</p>
);
}
Custom hooks
Ofcourse, the provided hooks aren't restricted to usage directly in a React function component. React hooks were created for reusable state logic and this package adheres to that philosophy.
A useAll
implementation with some preset http options.
/**
* Gets 10 most popular articles and their authors.
*/
function usePopularArticles() {
return useAll(articleService, {
sort: ['-likesAmount'],
populate: ['author'],
limit: 10,
});
}
A custom authorization state manager
/**
* Manages a session token.
*/
function useSession() {
const { data: sessionToken, response, call, service, cacheKey } = usePost(
authenticationService,
{ populate: ['user'] },
{ cache: 'authentication' }
);
// Create login call
const login = useCallback(
async (credentials: FormData) => await call(credentials as any),
[call]
);
// Create validate call
const validate = useCallback(async () => await call(service.validate()), [
call,
]);
useEffect(() => {
const { token } = sessionToken;
// Do something with the cache key and session token.
// For example, pass the token to your HTTP Headers in some base service class.
}, [cacheKey, sessionToken]);
return {
login,
validate,
response,
sessionToken,
};
}
function App() {
const { login, sessionToken } = useSession();
if (sessionToken?.isActive) return (
<div>Hello, {sessionToken.user?.name}!</div>
);
return (
<form onSubmit={(e) => {
e.preventDefault();
login(new FormData(e.target);
}}>
<input name="username" />
<input name="password" />
</form>
);
}
Shared state
In this example, we have a Player list component, and a Status component. PlayerList
will display a list of available players, while Status
will display a welcome message, and the total amount of existing players.
Executing call
in component PlayerList
will also trigger an update in component Status
.
// A.tsx
function PlayerList() {
const { data: players, call } = useAll(playerService, { select: ['id'] });
useEffect(() => {
// Fetch all players every 5 seconds. This will also cause `Status @ B.tsx` to update!
setInterval(() => call(), 5000);
}, []);
return players?.map((player) => <div>{player.name}</div>);
}
// B.tsx
function Status() {
// This hook as identical parameters as in PlayerList, so that particular state will be used:
const { response } = useAll(playerService, { select: ['id'] });
// When `PlayerList @ A.tsx` executes it's call, this component will also update!
return (
<div>
<p>Total available players: {response?.headers.get('X-total-count')}</p>
</div>
);
}
// C.txt
function App() {
return (
<>
<Status />
<PlayerList />
</>
);
}
API reference
usePut
, usePatch
and useDelete
hooks will execute a proxy GET request, to get initial data to work with. So you won't have to create two hooks (for example useById + usePut) when you would want to fetch and edit data.
useAll(service, httpOptions, stateOptions)
Use a request state for all models. Will immediately fetch on creation, unless set otherwise in stateOptions
.
Arguments
service
: CrudService
httpOptions?
: IHttpOptions
stateOptions?
: IStateOptions
Returns
IRequestState
Example
const { data: animals } = useAll(animalService);
useById(service, id, httpOptions, stateOptions)
Use a request state for a single model, by model id. Will immediately fetch on creation, unless set otherwise in stateOptions
.
Arguments
service
: CrudService
id?
: string
httpOptions?
: IHttpOptions
stateOptions?
: IStateOptions
Returns
IRequestState
Example
const { data: car } = useById(carService, '<id>');
useDelete(service, id, httpOptions, stateOptions)
Use a request state for a single model that is to be deleted.
This method will not be called immediately on creation, but instead needs to be called with it's returned call
property to actually delete the model.
Arguments
service
: CrudService
id?
: string
httpOptions?
: IHttpOptions
stateOptions?
: IStateOptions
Returns
IRequestState
Example
const { data: covid19, call } = useDelete(pandemicService, '<id>');
const clickHandler = useCallback(() => {
// delete the model
call();
}, [call]);
useMany(service, ids, httpOptions, stateOptions)
Use a request state for a set of models, by id's. Will immediately fetch on creation, unless set otherwise in stateOptions
.
Arguments
service
: CrudService
ids
: Array<string>
httpOptions?
: IHttpOptions
stateOptions?
: IStateOptions
Returns
IRequestState
Example
const { data: guitars } = useMany(guitarService, ['<id1>', '<id2>']);
usePatch(service, id, httpOptions, stateOptions)
Use a request state to patch a model by id.
This method will not be called immediately on creation, but instead needs to be called with it's returned call
property to actually patch the model.
Arguments
service
: CrudService
id?
: string
httpOptions?
: IHttpOptions
stateOptions?
: IStateOptions
Returns
IRequestState
Example
const { call: patch } = usePatch(carService, '<id>');
const submitHandler = useCallback(
(formData: FormData) => {
patch(formData);
},
[call]
);
usePost(service, httpOptions, stateOptions)
Use a request state to create a model.
Arguments
service
: CrudService
httpOptions?
: IHttpOptions
stateOptions?
: IStateOptions
Returns
IRequestState
Example
const { call: create } = usePost(fruitService);
const submitHandler = useCallback(
(formData: FormData) => {
create(formData);
},
[create]
);
usePut
Use a request state to put a model by id.
This method will not be called immediately on creation, but instead needs to be called with it's returned call
property to actually update the model.
Arguments
service
: CrudService
id?
: string
httpOptions?
: IHttpOptions
stateOptions?
: IStateOptions
Returns
IRequestState
Example
const { call: put } = usePut(carService, '<id>');
const submitHandler = useCallback(
(formData: FormData) => {
put(formData);
},
[call]
);
useRequest(service, query, method, httpOptions, stateOptions)
Use a request state.
Arguments
service
: CrudService
query?
: string
method?
: "POST" | "GET" | "PUT" | "PATCH" | "DELETE", default "GET"
httpOptions?
: IHttpOptions
stateOptions?
: IStateOptions
Returns
IRequestState
Example
const { call, service } = useRequest(authenticationService, '', 'POST');
const login = useCallback(
(credentials: FormData) => {
login(credentials);
},
[call]
);
const validate = useCallback(async () => {
return await service.validate();
}, [service]);
Note that when invoking useRequest
, no immediate fetch takes place. The fetchTiming
option is ignored, so you will have to manually invoke the created state's call
method if you want to immediately fetch on creation.
function useSomeData() {
const { data, call } = useRequest(service, 'query', 'GET');
// manual immediate fetch
useEffect(() => void call(), []);
return data;
}
// or, a more common scenario with an optional query parameter
function useSomeData(id?: string) {
const { data, call } = useRequest(service, id, 'GET');
// manual immediate fetch, but only if `id` is defined
useEffect(() => {
if (id) call();
}, [id]);
return data;
}
interface IRequestState
| Property | Type | | ---------- | -------------------------------------------------------------------------------- | | cacheKey | <optional> string | | data | <response data> | null | | fetchState | FetchState | | response | Response | | service | CrudService | | call | IStateUpdater |
interface IStateOptions
| Property | Type |
| ----------- | -------------------------------------------------------------------------------------------------- |
| distinct | <optional> boolean |
| cache | <optional> string | boolean |
| fetchTiming | <optional> FetchTiming.IMMEDIATE
(default) | FetchTiming.ON_CALL
| FetchTiming.WHEN_EMPTY
|
| proxyMethod | "POST" | "GET" | "PUT" | "PATCH" | "DELETE" |
| debug | <optional> boolean |
| appendQuery | <optional> string |
enum FetchState
| Field | Key | | --------- | --- | | Fulfilled | 0 | | Idle | 1 | | Pending | 2 | | Rejected | 3 |
function IStateUpdater
Executes a fetch call and updates state properties accordingly. Returns true
if the http request was succesful, false
if not.
Arguments
body?
: Promise | Model | FormData | null
proxy?
: boolean
Returns
boolean
Examples
Shoe update example.
const { call } = usePatch(shoeService, '<id>');
// update our shoe
const submitHandler = useCallback(
(formData: FormData) => {
call(formData);
},
[call]
);
// fetch our shoe
const getData = useCallback(() => {
// pass `true` to the proxy parameter. This will execute a GET request instead of PATCH.
call(null, true);
}, [call]);