reactive/data-client / .agents/skills/data-client-rest-setup
data-client-rest-setup
VerifiedSet up and migrate to @data-client/rest for REST APIs. Detects existing HTTP patterns (axios, fetch, ky, superagent, got) and migrates them. Creates custom RestEndpoint base class with common behaviors. Use when adopting @data-client/rest in a new or existing project.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 7.5 KB |
| evals/evals.json | config | 2.8 KB |
| references.json | config | 386 B |
| references/RestEndpoint.md | markdown | 45.2 KB |
| references/RestEndpoint.vue.md | markdown | 46.1 KB |
| references/auth.md | markdown | 9.4 KB |
| references/auth.vue.md | markdown | 9.7 KB |
| references/axios-migration.md | markdown | 25.4 KB |
| references/axios-migration.vue.md | markdown | 25.5 KB |
| references/django.md | markdown | 2.3 KB |
| references/fetch-migration.md | markdown | 3.8 KB |
| references/got-migration.md | markdown | 4.3 KB |
| references/hookifyResource.md | markdown | 6.0 KB |
| references/hookifyResource.vue.md | markdown | 6.3 KB |
| references/ky-migration.md | markdown | 3.8 KB |
| references/resource.md | markdown | 27.0 KB |
| references/resource.vue.md | markdown | 27.1 KB |
| references/superagent-migration.md | markdown | 4.0 KB |
references/auth.md
View on GitHub<!-- Generated by `yarn build:skills` from docs/rest/guides/auth.md (react). Edit the source doc, not this file. -->
# Rest Authentication
All network requests are run through the [getRequestInit](./RestEndpoint.md#getRequestInit) optionally
defined in your [RestEndpoint](./RestEndpoint.md).
## Cookie Auth (credentials)
Here's an example using simple [cookie](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies) auth by sending [fetch credentials](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch#sending_a_request_with_credentials_included):
```ts title="AuthdEndpoint" {9}
import { RestEndpoint, type RestGenerics } from '@data-client/rest';
export default class AuthdEndpoint<
O extends RestGenerics = any,
> extends RestEndpoint<O> {
async getRequestInit(body: any): Promise<RequestInit> {
return {
...(await super.getRequestInit(body)),
credentials: 'same-origin',
};
}
}
```
```ts title="MyResource"
import { resource, Entity } from '@data-client/rest';
import AuthdEndpoint from './AuthdEndpoint';
class MyEntity extends Entity {
id = '';
title = '';
}
export const MyResource = resource({
path: '/my/:id',
schema: MyEntity,
Endpoint: AuthdEndpoint,
});
```
```ts title="Usage" column
import { MyResource } from './MyResource';
MyResource.get({ id: 1 });
```
See [Django Integration](./django.md) for an example that also includes [CSRF protection](https://docs.djangoproject.com/en/5.0/howto/csrf/#using-csrf-protection-with-ajax).
## Access Tokens or JWT
**static member**
```ts title="login"
export const login = async (data: FormData) =>
(
await fetch('/login', { method: 'POST', body: data })
).json() as Promise<{
accessToken: string;
}>;
```
```ts title="AuthdEndpoint" {7,15,22}
import { RestEndpoint, type RestGenerics } from '@data-client/rest';
import { login } from './login';
export default class AuthdEndpoint<
O extends RestGenerics = any,
> extends RestEndpoint<O> {
declare static accessToken?: string;
getHeaders(headers: HeadersInit) {
// TypeScript doesn't infer properly
const EP = this.constructor as typeof AuthdEndpoint;
if (!EP.accessToken) return headers;
return {
...headers,
'Access-Token': EP.accessToken,
};
}
}
export const handleLogin = async e => {
const { accessToken } = await login(new FormData(e.target));
AuthdEndpoint.accessToken = accessToken;
};
```
```tsx title="Auth"
import { handleLogin } from './AuthdEndpoint';
export default function Auth() {
return <AuthForm onSubmit={handleLogin} />;
}
```
```ts title="MyResource"
import { resource, Entity } from '@data-client/rest';
import AuthdEndpoint from './AuthdEndpoint';
class MyEntity extends Entity {
id = '';
title = '';
}
export const MyResource = resource({
path: '/my/:id',
schema: MyEntity,
Endpoint: AuthdEndpoint,
});
```
```ts title="Usage" column
import { MyResource } from './MyResource';
MyResource.get({ id: 1 });
```
**async function**
```ts title="login"
export const login = async (data: FormData) =>
(
await fetch('/login', { method: 'POST', body: data })
).json() as Promise<{
accessToken: string;
}>;
let token = '';
// imagine this used an async API like indexedDB
export const getAuthToken = async () => token;
export const setAuthToken = (accessToken: string) => {
token = accessToken;
};
```
```ts title="AuthdEndpoint" {10,17}
import { RestEndpoint, type RestGenerics } from '@data-client/rest';
import { getAuthToken, setAuthToken, login } from './login';
export default class AuthdEndpoint<
O extends RestGenerics = any,
> extends RestEndpoint<O> {
async getHeaders(headers: HeadersInit) {
return {
...headers,
'Access-Token': await getAuthToken(),
};
}
}
export const handleLogin = async e => {
const { accessToken } = await login(new FormData(e.target));
setAuthToken(accessToken);
};
```
```tsx title="Auth"
import { handleLogin } from './AuthdEndpoint';
export default function Auth() {
return <AuthForm onSubmit={handleLogin} />;
}
```
```ts title="MyResource"
import { resource, Entity } from '@data-client/rest';
import AuthdEndpoint from './AuthdEndpoint';
class MyEntity extends Entity {
id = '';
title = '';
pk() {
return this.id;
}
}
export const MyResource = resource({
path: '/my/:id',
schema: MyEntity,
Endpoint: AuthdEndpoint,
});
```
```ts title="Usage" column
import { MyResource } from './MyResource';
MyResource.get({ id: 1 });
```
**function singleton**
```ts title="login"
export const login = async (data: FormData) =>
(
await fetch('/login', { method: 'POST', body: data })
).json() as Promise<{
accessToken: string;
}>;
let token = '';
export const getAuthToken = () => token;
export const setAuthToken = (accessToken: string) => {
token = accessToken;
};
```
```ts title="AuthdEndpoint" {10,17}
import { RestEndpoint, type RestGenerics } from '@data-client/rest';
import { getAuthToken, setAuthToken, login } from './login';
export default class AuthdEndpoint<
O extends RestGenerics = any,
> extends RestEndpoint<O> {
getHeaders(headers: HeadersInit) {
return {
...headers,
'Access-Token': getAuthToken(),
};
}
}
export const handleLogin = async e => {
const { accessToken } = await login(new FormData(e.target));
setAuthToken(accessToken);
};
```
```tsx title="Auth"
import { handleLogin } from './AuthdEndpoint';
export default function Auth() {
return <AuthForm onSubmit={handleLogin} />;
}
```
```ts title="MyResource"
import { resource, Entity } from '@data-client/rest';
import AuthdEndpoint from './AuthdEndpoint';
class MyEntity extends Entity {
id = '';
title = '';
pk() {
return this.id;
}
}
export const MyResource = resource({
path: '/my/:id',
schema: MyEntity,
Endpoint: AuthdEndpoint,
});
```
```ts title="Usage" column
import { MyResource } from './MyResource';
MyResource.get({ id: 1 });
```
## Auth Headers from React Context {#auth-headers-from-react-context}
> **Warning**
>
> Using React Context for state that is not displayed (like auth tokens) is not recommended.
> This will result in unnecessary re-renders and application complexity.
**Resource**
We can transform any [Resource](./resource.md) into one that uses hooks to create endpoints
by using [hookifyResource](./hookifyResource.md)
```ts title="resources/Post.ts"
import { Entity, resource, hookifyResource } from '@data-client/rest';
import { useAuthContext } from '../AuthContext';
class Post extends Entity {
id = '';
title = '';
}
export const PostResource = hookifyResource(
resource({ path: '/posts/:id', schema: Post }),
function useInit(): RequestInit {
const accessToken = useAuthContext();
return {
headers: {
'Access-Token': accessToken,
},
};
},
);
```
Then we can get the endpoints as hooks in our React Components
```tsx
import { useSuspense } from '@data-client/react';
import { PostResource } from 'resources/Post';
function PostDetail({ id }) {
const post = useSuspense(PostResource.useGet(), { id });
return <div>{post.title}</div>;
}
```
> **Warning**
>
> Using this means all endpoint calls must only occur during a function render.
>
> ```tsx
> import { useController } from '@data-client/react';
> import { PostResource } from './resources/Post';
>
> function CreatePost() {
> const controller = useController();
> const createPost = PostResource.useGetList().push;
>
> return (
> <form
> onSubmit={e =>
> controller.fetch(createPost, {}, new FormData(e.currentTarget))
> }
> >
> {/* ... */}
> </form>
> );
> }
> ```
**RestEndpoint**
We will first provide an easy way of using the context to alter the fetch headers.
```ts title="api/AuthdEndpoint.ts"
import { RestEndpoint, type RestGenerics } from '@data-client/rest';
export default class AuthdEndpoint<
O extends RestGenerics = any,
> extends RestEndpoint<O> {
declare accessToken?: string;
getHeaders(headers: HeadersInit): HeadersInit {
return {
...headers,
'Access-Token': this.accessToken,
};
}
}
```
Next we will [extend](./RestEndpoint.md#extend) to generate a new endpoint with this context injected.
```tsx
import { useMemo } from 'react';
import type { IRestEndpoint } from '@data-client/rest';
import { useAuthContext } from './AuthContext';
function useEndpoint(endpoint: IRestEndpoint) {
const accessToken = useAuthContext();
return useMemo(
() => endpoint.extend({ accessToken }),
[endpoint, accessToken],
);
}
```
> **Warning**
>
> Using this means all endpoint calls must only occur during a function render.
>
> ```tsx
> import { useController } from '@data-client/react';
> import { PostResource } from './api/Post';
> import { useEndpoint } from './useEndpoint';
>
> function CreatePost() {
> const controller = useController();
> const createPost = useEndpoint(PostResource.getList.push);
>
> return (
> <form
> onSubmit={e =>
> controller.fetch(createPost, {}, new FormData(e.target))
> }
> >
> {/* ... */}
> </form>
> );
> }
> ```
## Code organization
If much of your `Resources` share a similar auth mechanism, you might
try extending from a base class that defines such common customizations.
## 401 Logout Handling
In case a users authorization expires, the server will typically responsd to indicate
as such. The standard way of doing this is with a 401. [LogoutManager](https://dataclient.io/docs/api/LogoutManager)
can be used to easily trigger any de-authorization cleanup.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| receiving-code-reviewobra/superpowersUse when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative agreement or blind implementation | Stars: 319k | Updated | Claude CodeCodex | Verified | Install |
| requesting-code-reviewobra/superpowersUse when completing tasks, implementing major features, or before merging to verify work meets requirements | Stars: 319k | Updated | Claude CodeCodex | Verified | Install |
| using-git-worktreesobra/superpowersUse when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallback | Stars: 319k | Updated | Claude CodeCodex | Verified | Install |
| verification-before-completionobra/superpowersUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions always | Stars: 319k | Updated | Claude CodeCodex | Verified | Install |