@boostecom/provider 0.0.1

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.
Files changed (70) hide show
  1. package/README.md +90 -0
  2. package/dist/index.cjs +2522 -0
  3. package/dist/index.cjs.map +1 -0
  4. package/dist/index.d.cts +848 -0
  5. package/dist/index.d.ts +848 -0
  6. package/dist/index.js +2484 -0
  7. package/dist/index.js.map +1 -0
  8. package/docs/content/README.md +337 -0
  9. package/docs/content/agent-teams.mdx +324 -0
  10. package/docs/content/api.mdx +757 -0
  11. package/docs/content/best-practices.mdx +624 -0
  12. package/docs/content/examples.mdx +675 -0
  13. package/docs/content/guide.mdx +516 -0
  14. package/docs/content/index.mdx +99 -0
  15. package/docs/content/installation.mdx +246 -0
  16. package/docs/content/skills.mdx +548 -0
  17. package/docs/content/troubleshooting.mdx +588 -0
  18. package/docs/examples/README.md +499 -0
  19. package/docs/examples/abort-signal.ts +125 -0
  20. package/docs/examples/agent-teams.ts +122 -0
  21. package/docs/examples/basic-usage.ts +73 -0
  22. package/docs/examples/check-cli.ts +51 -0
  23. package/docs/examples/conversation-history.ts +69 -0
  24. package/docs/examples/custom-config.ts +90 -0
  25. package/docs/examples/generate-object-constraints.ts +209 -0
  26. package/docs/examples/generate-object.ts +211 -0
  27. package/docs/examples/hooks-callbacks.ts +63 -0
  28. package/docs/examples/images.ts +76 -0
  29. package/docs/examples/integration-test.ts +241 -0
  30. package/docs/examples/limitations.ts +150 -0
  31. package/docs/examples/logging-custom-logger.ts +99 -0
  32. package/docs/examples/logging-default.ts +55 -0
  33. package/docs/examples/logging-disabled.ts +74 -0
  34. package/docs/examples/logging-verbose.ts +64 -0
  35. package/docs/examples/long-running-tasks.ts +179 -0
  36. package/docs/examples/message-injection.ts +210 -0
  37. package/docs/examples/mid-stream-injection.ts +126 -0
  38. package/docs/examples/run-all-examples.sh +48 -0
  39. package/docs/examples/sdk-tools-callbacks.ts +49 -0
  40. package/docs/examples/skills-discovery.ts +144 -0
  41. package/docs/examples/skills-management.ts +140 -0
  42. package/docs/examples/stream-object.ts +80 -0
  43. package/docs/examples/streaming.ts +52 -0
  44. package/docs/examples/structured-output-repro.ts +227 -0
  45. package/docs/examples/tool-management.ts +215 -0
  46. package/docs/examples/tool-streaming.ts +132 -0
  47. package/docs/examples/zod4-compatibility-test.ts +290 -0
  48. package/docs/src/claude-code-language-model.test.ts +3883 -0
  49. package/docs/src/claude-code-language-model.ts +2586 -0
  50. package/docs/src/claude-code-provider.test.ts +97 -0
  51. package/docs/src/claude-code-provider.ts +179 -0
  52. package/docs/src/convert-to-claude-code-messages.images.test.ts +104 -0
  53. package/docs/src/convert-to-claude-code-messages.test.ts +193 -0
  54. package/docs/src/convert-to-claude-code-messages.ts +419 -0
  55. package/docs/src/errors.test.ts +213 -0
  56. package/docs/src/errors.ts +216 -0
  57. package/docs/src/index.test.ts +49 -0
  58. package/docs/src/index.ts +98 -0
  59. package/docs/src/logger.integration.test.ts +164 -0
  60. package/docs/src/logger.test.ts +184 -0
  61. package/docs/src/logger.ts +65 -0
  62. package/docs/src/map-claude-code-finish-reason.test.ts +120 -0
  63. package/docs/src/map-claude-code-finish-reason.ts +60 -0
  64. package/docs/src/mcp-helpers.test.ts +71 -0
  65. package/docs/src/mcp-helpers.ts +123 -0
  66. package/docs/src/message-injection.test.ts +460 -0
  67. package/docs/src/types.ts +447 -0
  68. package/docs/src/validation.test.ts +558 -0
  69. package/docs/src/validation.ts +360 -0
  70. package/package.json +124 -0
@@ -0,0 +1,246 @@
1
+ ---
2
+ title: Installation
3
+ description: Guide d'installation et de configuration du provider Claude Code
4
+ ---
5
+
6
+ # Installation
7
+
8
+ Ce guide vous accompagne dans l'installation et la configuration du provider Claude Code pour le Vercel AI SDK. Ce provider fonctionne via le CLI Claude Code et votre abonnement Pro/Max — aucune clé API n'est nécessaire.
9
+
10
+ ## Prérequis
11
+
12
+ - **Node.js** ≥ 18
13
+ - **Abonnement Claude Pro ou Max** (pas de clé API Anthropic nécessaire)
14
+ - Terminal avec pnpm ou votre gestionnaire de packages préféré
15
+
16
+ ## Étape 1 : Installer le CLI Claude Code
17
+
18
+ Le CLI Claude Code est requis pour communiquer avec les serveurs d'Anthropic.
19
+
20
+ ```bash
21
+ npm install -g @anthropic-ai/claude-code
22
+ ```
23
+
24
+ <Note type="info">
25
+ Le CLI doit être installé globalement (`-g`) pour être accessible depuis n'importe où sur votre système.
26
+ </Note>
27
+
28
+ ## Étape 2 : Authentification
29
+
30
+ Connectez-vous avec votre compte Claude (abonnement Pro ou Max) :
31
+
32
+ ```bash
33
+ claude login
34
+ ```
35
+
36
+ Cette commande ouvrira votre navigateur et vous guidera à travers le processus d'authentification. Vos identifiants seront stockés de manière sécurisée dans `~/.claude/`.
37
+
38
+ <Accordion title="Vérifier l'authentification">
39
+ Pour vérifier que l'authentification a réussi, exécutez :
40
+
41
+ ```bash
42
+ claude --version
43
+ ```
44
+
45
+ Si vous voyez la version sans erreur, vous êtes correctement authentifié.
46
+ </Accordion>
47
+
48
+ ## Étape 3 : Installer le provider
49
+
50
+ ### Pour AI SDK v6 (Recommandé)
51
+
52
+ ```bash
53
+ npm install @boostecom/provider ai@^6.0.0 zod@^4.0.0
54
+ ```
55
+
56
+ ### Pour AI SDK v5
57
+
58
+ ```bash
59
+ npm install @boostecom/provider@ai-sdk-v5 ai@^5.0.0 zod@^4.0.0
60
+ ```
61
+
62
+ ### Pour AI SDK v4 (Legacy)
63
+
64
+ ```bash
65
+ npm install @boostecom/provider@ai-sdk-v4 ai@^4.3.16 zod@^3.0.0
66
+ ```
67
+
68
+ <Note type="warning">
69
+ **Compatibilité Zod** : Versions 3.2.0+ nécessitent Zod 4. Si vous devez utiliser Zod 3, installez `@boostecom/provider@3.1.x`.
70
+ </Note>
71
+
72
+ ## Étape 4 : Vérification de l'installation
73
+
74
+ Créez un fichier de test pour vérifier que tout fonctionne :
75
+
76
+ ```typescript title="test.ts"
77
+ import { generateText } from 'ai';
78
+ import { claudeCode } from '@boostecom/provider';
79
+
80
+ async function test() {
81
+ try {
82
+ const { text } = await generateText({
83
+ model: claudeCode('haiku'),
84
+ prompt: 'Dis bonjour en une phrase',
85
+ });
86
+
87
+ console.log('✅ Installation réussie!');
88
+ console.log('Réponse:', text);
89
+ } catch (error) {
90
+ console.error('❌ Erreur:', error);
91
+ }
92
+ }
93
+
94
+ test();
95
+ ```
96
+
97
+ Exécutez le test :
98
+
99
+ ```bash
100
+ npx tsx test.ts
101
+ ```
102
+
103
+ Si vous voyez une réponse de Claude, félicitations ! Votre installation est complète.
104
+
105
+ ## Configuration avancée
106
+
107
+ ### Variables d'environnement
108
+
109
+ Vous pouvez configurer certains comportements via des variables d'environnement :
110
+
111
+ ```bash
112
+ # Chemin personnalisé vers le CLI Claude Code
113
+ export CLAUDE_CODE_PATH="/chemin/vers/claude"
114
+
115
+ # Répertoire de travail par défaut
116
+ export CLAUDE_CWD="/chemin/projet"
117
+ ```
118
+
119
+ ### Utilisation dans un monorepo
120
+
121
+ Si vous utilisez un monorepo (pnpm, yarn workspaces, etc.), installez le CLI globalement et le provider localement dans chaque package :
122
+
123
+ ```bash
124
+ # Global
125
+ npm install -g @anthropic-ai/claude-code
126
+
127
+ # Dans chaque package
128
+ cd packages/mon-app
129
+ npm install @boostecom/provider ai zod
130
+ ```
131
+
132
+ ### Installation dans Docker
133
+
134
+ Pour utiliser le provider dans un conteneur Docker :
135
+
136
+ ```dockerfile
137
+ FROM node:18-alpine
138
+
139
+ # Installer le CLI globalement
140
+ RUN npm install -g @anthropic-ai/claude-code
141
+
142
+ # Copier les identifiants d'authentification (NE PAS faire en production)
143
+ # Préférez utiliser des secrets ou variables d'environnement
144
+ COPY .claude /root/.claude
145
+
146
+ WORKDIR /app
147
+ COPY package*.json ./
148
+ RUN npm install
149
+
150
+ COPY . .
151
+ CMD ["node", "index.js"]
152
+ ```
153
+
154
+ <Note type="danger">
155
+ **Sécurité** : Ne copiez JAMAIS vos identifiants dans une image Docker de production. Utilisez des secrets Docker, des volumes montés ou des services de gestion de secrets.
156
+ </Note>
157
+
158
+ ### Installation dans un environnement CI/CD
159
+
160
+ Pour les environnements CI/CD (GitHub Actions, GitLab CI, etc.) :
161
+
162
+ ```yaml title=".github/workflows/test.yml"
163
+ name: Test Claude Integration
164
+
165
+ on: [push]
166
+
167
+ jobs:
168
+ test:
169
+ runs-on: ubuntu-latest
170
+
171
+ steps:
172
+ - uses: actions/checkout@v3
173
+
174
+ - name: Setup Node.js
175
+ uses: actions/setup-node@v3
176
+ with:
177
+ node-version: '18'
178
+
179
+ - name: Install CLI
180
+ run: npm install -g @anthropic-ai/claude-code
181
+
182
+ - name: Setup Authentication
183
+ run: |
184
+ mkdir -p ~/.claude
185
+ echo "${{ secrets.CLAUDE_AUTH }}" > ~/.claude/auth.json
186
+
187
+ - name: Install dependencies
188
+ run: npm ci
189
+
190
+ - name: Run tests
191
+ run: npm test
192
+ ```
193
+
194
+ <Note type="info">
195
+ Stockez vos identifiants Claude dans les secrets de votre plateforme CI/CD pour une sécurité maximale.
196
+ </Note>
197
+
198
+ ## Dépannage
199
+
200
+ ### Le CLI n'est pas trouvé
201
+
202
+ **Problème** : `command not found: claude`
203
+
204
+ **Solution** :
205
+ ```bash
206
+ # Vérifier l'installation
207
+ npm list -g @anthropic-ai/claude-code
208
+
209
+ # Réinstaller si nécessaire
210
+ npm uninstall -g @anthropic-ai/claude-code
211
+ npm install -g @anthropic-ai/claude-code
212
+ ```
213
+
214
+ ### Erreur d'authentification
215
+
216
+ **Problème** : `Authentication failed` ou `Unauthorized`
217
+
218
+ **Solution** :
219
+ ```bash
220
+ # Supprimer les identifiants existants
221
+ rm -rf ~/.claude
222
+
223
+ # Se reconnecter
224
+ claude login
225
+ ```
226
+
227
+ ### Incompatibilité de version
228
+
229
+ **Problème** : Erreurs de types TypeScript ou comportements inattendus
230
+
231
+ **Solution** :
232
+ ```bash
233
+ # Vérifier les versions
234
+ npm list ai @boostecom/provider zod
235
+
236
+ # Réinstaller avec les bonnes versions
237
+ npm install @boostecom/provider@latest ai@^6.0.0 zod@^4.0.0
238
+ ```
239
+
240
+ ## Prochaines étapes
241
+
242
+ Maintenant que l'installation est complète, consultez :
243
+
244
+ - [Guide d'utilisation](/docs/guide) pour les patterns de base
245
+ - [API Reference](/docs/api) pour la documentation complète
246
+ - [Exemples](/docs/examples) pour des cas d'usage pratiques