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/ky-migration.md
View on GitHub# Ky → @data-client/rest Migration
## Detection
- `"ky"` in `package.json` dependencies
- `import ky from 'ky'` or `import ky from 'ky/umd'` in source
Search patterns:
- `import.*from ['"]ky['"]` — import statements
- `ky\.create` — instance creation
- `ky\.(get|post|put|patch|delete|head)` — direct calls
## Migration Rules
### Basic instance → base class
```ts
// Before: ky instance
import ky from 'ky';
const api = ky.create({
prefixUrl: 'https://api.example.com',
headers: { Authorization: `Bearer ${token}` },
hooks: {
beforeRequest: [req => { /* ... */ }],
afterResponse: [(_req, _opts, res) => { /* ... */ }],
},
});
const users = await api.get('users').json<User[]>();
// After: RestEndpoint base class
import { RestEndpoint, RestGenerics } from '@data-client/rest';
class ApiEndpoint<O extends RestGenerics = any> extends RestEndpoint<O> {
urlPrefix = 'https://api.example.com';
getHeaders(headers: HeadersInit) {
return {
...headers,
Authorization: `Bearer ${token}`,
};
}
}
export const getUsers = new ApiEndpoint({
path: '/users',
schema: [User],
});
```
### Key conversions
| Ky pattern | RestEndpoint equivalent |
|------------|----------------------|
| `prefixUrl` | `urlPrefix` |
| `headers` option | `getHeaders()` |
| `hooks.beforeRequest` | `getHeaders()` or `getRequestInit()` |
| `hooks.afterResponse` | `process()` in the base class |
| `hooks.beforeError` | `fetchResponse()` override |
| `ky.create()` shared options | Base class overrides |
| `.json<T>()` | Automatic — RestEndpoint parses JSON by default |
| `HTTPError` | `NetworkError` |
| `searchParams` option | `searchParams` type on endpoint |
| `timeout` | `AbortSignal.timeout(ms)` in a `getRequestInit()` override, so each request gets its own timer ([Timeout](axios-migration.md#timeout)); a `signal` option would start one timer when the endpoint is created |
| `retry` (ky retries by default) | Delete it: Data Client has no retry loop, and a failed request is fetched again when a component next needs it after `errorExpiryLength` (default 1 second). Tell the user that automatic retries are dropped |
| `credentials` | `getRequestInit()` override |
### Hooks → lifecycle methods
```ts
// Before: ky hooks
const api = ky.create({
hooks: {
beforeRequest: [
request => {
request.headers.set('X-Request-Id', generateId());
},
],
afterResponse: [
(_request, _options, response) => {
logResponse(response.status);
return response;
},
],
beforeError: [
error => {
reportError(error);
return error;
},
],
},
});
// After: lifecycle methods
class ApiEndpoint<O extends RestGenerics = any> extends RestEndpoint<O> {
getHeaders(headers: HeadersInit) {
return {
...headers,
'X-Request-Id': generateId(),
};
}
async parseResponse(response: Response) {
logResponse(response.status);
return super.parseResponse(response);
}
async fetchResponse(input: RequestInfo, init: RequestInit) {
try {
return await super.fetchResponse(input, init);
} catch (error) {
reportError(error);
throw error;
}
}
}
```
### Error handling
```ts
// Before
import { HTTPError } from 'ky';
try { ... } catch (err) {
if (err instanceof HTTPError) {
const body = await err.response.json();
console.log(err.response.status, body);
}
}
// After
import { NetworkError } from '@data-client/rest';
try { ... } catch (err) {
if (err instanceof NetworkError) {
console.log(err.status);
const body = await err.response.json();
}
}
```
## Reference
- [RestEndpoint API](https://dataclient.io/rest/api/RestEndpoint) — lifecycle methods reference
- [NetworkError](https://dataclient.io/rest/api/RestEndpoint#fetchResponse) — error class
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 |