@sudobility/shapeshyft_client 0.0.67 → 0.0.69
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +51 -0
- package/package.json +6 -6
package/README.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# @sudobility/shapeshyft_client
|
|
2
|
+
|
|
3
|
+
React client library for the ShapeShyft API with state management hooks.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
bun add @sudobility/shapeshyft_client
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { useKeys, useProjects, useAiExecute } from '@sudobility/shapeshyft_client';
|
|
15
|
+
|
|
16
|
+
const { keys, isLoading, refresh, createKey } = useKeys(networkClient, baseUrl);
|
|
17
|
+
await refresh(userId, token);
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Hooks
|
|
21
|
+
|
|
22
|
+
| Hook | Purpose |
|
|
23
|
+
|------|---------|
|
|
24
|
+
| `useKeys` | LLM API key management |
|
|
25
|
+
| `useProjects` | Project CRUD |
|
|
26
|
+
| `useEndpoints` | Endpoint configuration |
|
|
27
|
+
| `useAiExecute` | LLM inference |
|
|
28
|
+
| `useAnalytics` | Usage analytics |
|
|
29
|
+
| `useSettings` | User settings |
|
|
30
|
+
|
|
31
|
+
Each hook returns `{ data, isLoading, error, refresh, clearError, reset }` plus CRUD methods.
|
|
32
|
+
|
|
33
|
+
## Development
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
bun run build # Build to dist/
|
|
37
|
+
bun run test # Run Vitest
|
|
38
|
+
bun run typecheck # TypeScript check
|
|
39
|
+
bun run lint # ESLint
|
|
40
|
+
bun run verify # Typecheck + lint + test + build
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Related Packages
|
|
44
|
+
|
|
45
|
+
- `@sudobility/shapeshyft_types` -- Shared type definitions
|
|
46
|
+
- `@sudobility/shapeshyft_lib` -- Zustand stores wrapping these hooks
|
|
47
|
+
- `shapeshyft_app` -- Frontend consumer
|
|
48
|
+
|
|
49
|
+
## License
|
|
50
|
+
|
|
51
|
+
BUSL-1.1
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sudobility/shapeshyft_client",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.69",
|
|
4
4
|
"description": "React client library for ShapeShyft API with TanStack Query hooks",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -36,16 +36,16 @@
|
|
|
36
36
|
"author": "John Huang",
|
|
37
37
|
"license": "BUSL-1.1",
|
|
38
38
|
"peerDependencies": {
|
|
39
|
-
"@sudobility/shapeshyft_types": "^1.0.
|
|
40
|
-
"@sudobility/types": "^1.9.
|
|
39
|
+
"@sudobility/shapeshyft_types": "^1.0.47",
|
|
40
|
+
"@sudobility/types": "^1.9.58",
|
|
41
41
|
"@tanstack/react-query": ">=5.0.0",
|
|
42
42
|
"react": ">=18.0.0"
|
|
43
43
|
},
|
|
44
44
|
"devDependencies": {
|
|
45
45
|
"@eslint/js": "^9.39.2",
|
|
46
|
-
"@sudobility/di": "^1.5.
|
|
47
|
-
"@sudobility/shapeshyft_types": "^1.0.
|
|
48
|
-
"@sudobility/types": "^1.9.
|
|
46
|
+
"@sudobility/di": "^1.5.46",
|
|
47
|
+
"@sudobility/shapeshyft_types": "^1.0.47",
|
|
48
|
+
"@sudobility/types": "^1.9.58",
|
|
49
49
|
"@tanstack/react-query": "^5.90.5",
|
|
50
50
|
"@testing-library/dom": "^10.4.1",
|
|
51
51
|
"@testing-library/react": "^16.3.1",
|