@atlashub/smartstack-cli 1.5.1 → 1.5.3
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/.documentation/css/styles.css +2168 -2168
- package/.documentation/js/app.js +794 -794
- package/config/default-config.json +86 -86
- package/config/settings.json +53 -53
- package/config/settings.local.example.json +16 -16
- package/dist/index.js +0 -0
- package/dist/index.js.map +1 -1
- package/package.json +88 -88
- package/templates/agents/action.md +36 -36
- package/templates/agents/efcore/conflicts.md +84 -84
- package/templates/agents/efcore/db-deploy.md +51 -51
- package/templates/agents/efcore/db-reset.md +59 -59
- package/templates/agents/efcore/db-seed.md +56 -56
- package/templates/agents/efcore/db-status.md +64 -64
- package/templates/agents/efcore/migration.md +85 -85
- package/templates/agents/efcore/rebase-snapshot.md +62 -62
- package/templates/agents/efcore/scan.md +90 -90
- package/templates/agents/efcore/squash.md +67 -67
- package/templates/agents/explore-codebase.md +65 -65
- package/templates/agents/explore-docs.md +97 -97
- package/templates/agents/fix-grammar.md +49 -49
- package/templates/agents/gitflow/abort.md +45 -45
- package/templates/agents/gitflow/cleanup.md +85 -85
- package/templates/agents/gitflow/commit.md +40 -40
- package/templates/agents/gitflow/exec.md +48 -48
- package/templates/agents/gitflow/finish.md +92 -92
- package/templates/agents/gitflow/init.md +139 -139
- package/templates/agents/gitflow/merge.md +62 -62
- package/templates/agents/gitflow/plan.md +42 -42
- package/templates/agents/gitflow/pr.md +78 -78
- package/templates/agents/gitflow/review.md +49 -49
- package/templates/agents/gitflow/start.md +61 -61
- package/templates/agents/gitflow/status.md +32 -32
- package/templates/agents/snipper.md +36 -36
- package/templates/agents/websearch.md +46 -46
- package/templates/commands/_resources/formatting-guide.md +124 -124
- package/templates/commands/ai-prompt.md +315 -315
- package/templates/commands/apex/1-analyze.md +100 -100
- package/templates/commands/apex/2-plan.md +145 -145
- package/templates/commands/apex/3-execute.md +171 -171
- package/templates/commands/apex/4-examine.md +116 -116
- package/templates/commands/apex/5-tasks.md +209 -209
- package/templates/commands/apex.md +76 -76
- package/templates/commands/application/create.md +362 -362
- package/templates/commands/application/templates-backend.md +463 -463
- package/templates/commands/application/templates-frontend.md +517 -517
- package/templates/commands/application/templates-i18n.md +478 -478
- package/templates/commands/application/templates-seed.md +362 -362
- package/templates/commands/application.md +303 -303
- package/templates/commands/business-analyse/0-orchestrate.md +640 -640
- package/templates/commands/business-analyse/1-init.md +269 -269
- package/templates/commands/business-analyse/2-discover.md +520 -520
- package/templates/commands/business-analyse/3-analyse.md +408 -408
- package/templates/commands/business-analyse/4-specify.md +598 -598
- package/templates/commands/business-analyse/5-validate.md +326 -326
- package/templates/commands/business-analyse/6-handoff.md +746 -746
- package/templates/commands/business-analyse/7-doc-html.md +602 -602
- package/templates/commands/business-analyse/bug.md +325 -325
- package/templates/commands/business-analyse/change-request.md +368 -368
- package/templates/commands/business-analyse/hotfix.md +200 -200
- package/templates/commands/business-analyse.md +640 -640
- package/templates/commands/controller/create.md +216 -216
- package/templates/commands/controller/postman-templates.md +528 -528
- package/templates/commands/controller/templates.md +600 -600
- package/templates/commands/controller.md +337 -337
- package/templates/commands/create/agent.md +138 -138
- package/templates/commands/create/command.md +166 -166
- package/templates/commands/create/hook.md +234 -234
- package/templates/commands/create/plugin.md +329 -329
- package/templates/commands/create/project.md +507 -507
- package/templates/commands/create/skill.md +199 -199
- package/templates/commands/create.md +220 -220
- package/templates/commands/debug.md +95 -95
- package/templates/commands/documentation/module.md +202 -202
- package/templates/commands/documentation/templates.md +432 -432
- package/templates/commands/documentation.md +190 -190
- package/templates/commands/efcore/_env-check.md +153 -153
- package/templates/commands/efcore/conflicts.md +186 -186
- package/templates/commands/efcore/db-deploy.md +193 -193
- package/templates/commands/efcore/db-reset.md +426 -426
- package/templates/commands/efcore/db-seed.md +326 -326
- package/templates/commands/efcore/db-status.md +226 -226
- package/templates/commands/efcore/migration.md +400 -400
- package/templates/commands/efcore/rebase-snapshot.md +264 -264
- package/templates/commands/efcore/scan.md +198 -198
- package/templates/commands/efcore/squash.md +298 -298
- package/templates/commands/efcore.md +224 -224
- package/templates/commands/epct.md +69 -69
- package/templates/commands/explain.md +186 -186
- package/templates/commands/explore.md +45 -45
- package/templates/commands/feature-full.md +267 -267
- package/templates/commands/gitflow/1-init.md +1038 -1038
- package/templates/commands/gitflow/10-start.md +768 -768
- package/templates/commands/gitflow/11-finish.md +457 -457
- package/templates/commands/gitflow/12-cleanup.md +276 -276
- package/templates/commands/gitflow/13-sync.md +216 -216
- package/templates/commands/gitflow/14-rebase.md +251 -251
- package/templates/commands/gitflow/2-status.md +277 -277
- package/templates/commands/gitflow/3-commit.md +344 -344
- package/templates/commands/gitflow/4-plan.md +145 -145
- package/templates/commands/gitflow/5-exec.md +147 -147
- package/templates/commands/gitflow/6-abort.md +344 -344
- package/templates/commands/gitflow/7-pull-request.md +453 -355
- package/templates/commands/gitflow/8-review.md +240 -176
- package/templates/commands/gitflow/9-merge.md +451 -365
- package/templates/commands/gitflow.md +128 -128
- package/templates/commands/implement.md +663 -663
- package/templates/commands/init.md +567 -567
- package/templates/commands/mcp-integration.md +330 -330
- package/templates/commands/notification.md +129 -129
- package/templates/commands/oneshot.md +57 -57
- package/templates/commands/quick-search.md +72 -72
- package/templates/commands/ralph-loop/cancel-ralph.md +18 -18
- package/templates/commands/ralph-loop/help.md +126 -126
- package/templates/commands/ralph-loop/ralph-loop.md +18 -18
- package/templates/commands/review.md +106 -106
- package/templates/commands/utils/test-web-config.md +160 -160
- package/templates/commands/utils/test-web.md +151 -151
- package/templates/commands/validate.md +233 -233
- package/templates/commands/workflow.md +193 -193
- package/templates/gitflow/config.json +138 -138
- package/templates/hooks/ef-migration-check.md +139 -139
- package/templates/hooks/hooks.json +25 -25
- package/templates/hooks/stop-hook.sh +177 -177
- package/templates/skills/ai-prompt/SKILL.md +778 -778
- package/templates/skills/application/SKILL.md +563 -563
- package/templates/skills/application/templates-backend.md +450 -450
- package/templates/skills/application/templates-frontend.md +531 -531
- package/templates/skills/application/templates-i18n.md +520 -520
- package/templates/skills/application/templates-seed.md +647 -647
- package/templates/skills/business-analyse/SKILL.md +191 -191
- package/templates/skills/business-analyse/questionnaire.md +283 -283
- package/templates/skills/business-analyse/templates-frd.md +477 -477
- package/templates/skills/business-analyse/templates-react.md +580 -580
- package/templates/skills/controller/SKILL.md +240 -240
- package/templates/skills/controller/postman-templates.md +614 -614
- package/templates/skills/controller/templates.md +1468 -1468
- package/templates/skills/documentation/SKILL.md +133 -133
- package/templates/skills/documentation/templates.md +476 -476
- package/templates/skills/feature-full/SKILL.md +838 -838
- package/templates/skills/notification/SKILL.md +555 -555
- package/templates/skills/ui-components/SKILL.md +870 -870
- package/templates/skills/workflow/SKILL.md +582 -582
- package/templates/test-web/api-health.json +38 -38
- package/templates/test-web/minimal.json +19 -19
- package/templates/test-web/npm-package.json +46 -46
- package/templates/test-web/seo-check.json +54 -54
|
@@ -1,337 +1,337 @@
|
|
|
1
|
-
# /controller - Skill Controller SmartStack
|
|
2
|
-
|
|
3
|
-
> **Synergie Skill/Commande:**
|
|
4
|
-
> - **Skill** (`.claude/skills/controller/`) → Invocation automatique par Claude
|
|
5
|
-
> - **Commande** (`/controller:create`) → Invocation manuelle par l'utilisateur
|
|
6
|
-
> - Templates partagés dans `.claude/skills/controller/templates.md`
|
|
7
|
-
|
|
8
|
-
> **MCP INTEGRATION:** This command can use `mcp__smartstack__scaffold_extension` for code generation.
|
|
9
|
-
|
|
10
|
-
---
|
|
11
|
-
|
|
12
|
-
## MCP SCAFFOLDING (Recommended)
|
|
13
|
-
|
|
14
|
-
> **NEW:** Use SmartStack MCP for consistent code generation across all projects.
|
|
15
|
-
|
|
16
|
-
### When to Use MCP
|
|
17
|
-
|
|
18
|
-
| Scenario | Use MCP | Use Templates |
|
|
19
|
-
|----------|---------|---------------|
|
|
20
|
-
| Standard CRUD controller | Yes | - |
|
|
21
|
-
| Controller with custom logic | - | Yes |
|
|
22
|
-
| Need validation before | Yes | - |
|
|
23
|
-
| Offline mode | - | Yes |
|
|
24
|
-
|
|
25
|
-
### MCP Invocation
|
|
26
|
-
|
|
27
|
-
**Claude instruction:** For standard controller generation, invoke MCP first:
|
|
28
|
-
|
|
29
|
-
```json
|
|
30
|
-
{
|
|
31
|
-
"tool": "mcp__smartstack__scaffold_extension",
|
|
32
|
-
"parameters": {
|
|
33
|
-
"type": "controller",
|
|
34
|
-
"name": "{MODULE}",
|
|
35
|
-
"options": {
|
|
36
|
-
"namespace": "SmartStack.Api.Controllers.{AREA}",
|
|
37
|
-
"methods": ["GetAll", "GetById", "Create", "Update", "Delete"]
|
|
38
|
-
}
|
|
39
|
-
}
|
|
40
|
-
}
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
The MCP returns a `ScaffoldResult`:
|
|
44
|
-
|
|
45
|
-
```typescript
|
|
46
|
-
interface ScaffoldResult {
|
|
47
|
-
success: boolean;
|
|
48
|
-
files: GeneratedFile[];
|
|
49
|
-
instructions: string[];
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
interface GeneratedFile {
|
|
53
|
-
path: string;
|
|
54
|
-
content: string;
|
|
55
|
-
type: 'created' | 'modified';
|
|
56
|
-
}
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
### Post-MCP Steps
|
|
60
|
-
|
|
61
|
-
After MCP generates the controller:
|
|
62
|
-
1. Review generated code
|
|
63
|
-
2. Add to `Permissions.cs` (STEP 6 below)
|
|
64
|
-
3. Add to `PermissionConfiguration.cs`
|
|
65
|
-
4. Create migration if needed
|
|
66
|
-
|
|
67
|
-
---
|
|
68
|
-
|
|
69
|
-
## ARGUMENTS
|
|
70
|
-
|
|
71
|
-
```
|
|
72
|
-
/controller:create <area> <module> [entity]
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
| Variable | Extraction | Valeurs |
|
|
76
|
-
|----------|------------|---------|
|
|
77
|
-
| `$AREA` | Premier mot | `Admin`, `Support`, `Business`, `User`, `Auth` |
|
|
78
|
-
| `$MODULE` | Deuxième mot | Nom du module (PascalCase) |
|
|
79
|
-
| `$ENTITY` | Troisième mot (optionnel) | Nom de l'entité Domain (défaut = singulier de $MODULE) |
|
|
80
|
-
|
|
81
|
-
**Exemples:**
|
|
82
|
-
```
|
|
83
|
-
/controller:create Admin Users
|
|
84
|
-
/controller:create Support Tickets Ticket
|
|
85
|
-
/controller:create Business Leads Lead
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
---
|
|
89
|
-
|
|
90
|
-
## VALIDATION CONTEXTES (CRITIQUE)
|
|
91
|
-
|
|
92
|
-
> **RAPPEL:** Les controllers client doivent être dans l'Area `Business`.
|
|
93
|
-
|
|
94
|
-
### Mapping Area → Context
|
|
95
|
-
|
|
96
|
-
| Area | Route Prefix | Permission Context | Autorisé Client |
|
|
97
|
-
|------|--------------|-------------------|-----------------|
|
|
98
|
-
| `Admin` | `api/admin/` | `platform.administration.*` | ❌ NON |
|
|
99
|
-
| `Support` | `api/support/` | `platform.support.*` | ❌ NON |
|
|
100
|
-
| `Business` | `api/business/` | `business.*` | ✅ OUI |
|
|
101
|
-
| `User` | `api/user/` | `personal.myspace.*` | ❌ NON |
|
|
102
|
-
| `Auth` | `api/auth/` | (AllowAnonymous) | ❌ NON |
|
|
103
|
-
|
|
104
|
-
### Validation Automatique
|
|
105
|
-
|
|
106
|
-
```
|
|
107
|
-
AVANT génération:
|
|
108
|
-
|
|
109
|
-
SI $AREA NOT IN ["Admin", "Support", "Business", "User", "Auth"]:
|
|
110
|
-
❌ ERREUR: "Area '$AREA' non reconnue"
|
|
111
|
-
SUGGÉRER: "Utilisez 'Business' pour les modules client"
|
|
112
|
-
ABORT
|
|
113
|
-
|
|
114
|
-
SI création par client ET $AREA IN ["Admin", "Support", "User", "Auth"]:
|
|
115
|
-
⚠️ WARNING: "L'area '$AREA' est réservée au core SmartStack"
|
|
116
|
-
SUGGÉRER: "Utilisez '/controller:create Business $MODULE $ENTITY'"
|
|
117
|
-
```
|
|
118
|
-
|
|
119
|
-
---
|
|
120
|
-
|
|
121
|
-
## RÈGLES ABSOLUES
|
|
122
|
-
|
|
123
|
-
1. **TOUJOURS** utiliser `[RequirePermission(Permissions.*)]` - jamais de strings
|
|
124
|
-
2. **TOUJOURS** ajouter `[ProducesResponseType]` pour chaque status possible
|
|
125
|
-
3. **TOUJOURS** logger les opérations (Info pour CRUD, Warning pour Delete/Sensitive)
|
|
126
|
-
4. **TOUJOURS** protéger les comptes système (UserType.System/LocalAdmin)
|
|
127
|
-
5. **JAMAIS** de SQL direct - utiliser EF Core
|
|
128
|
-
6. **JAMAIS** d'endpoint sans permission (sauf [AllowAnonymous] pour auth)
|
|
129
|
-
|
|
130
|
-
---
|
|
131
|
-
|
|
132
|
-
## WORKFLOW
|
|
133
|
-
|
|
134
|
-
### ÉTAPE 1: PARSING DES ARGUMENTS
|
|
135
|
-
|
|
136
|
-
```
|
|
137
|
-
EXTRAIRE $AREA = premier mot des arguments (PascalCase)
|
|
138
|
-
EXTRAIRE $MODULE = deuxième mot des arguments (PascalCase)
|
|
139
|
-
EXTRAIRE $ENTITY = troisième mot OU singulier de $MODULE
|
|
140
|
-
|
|
141
|
-
SI $AREA absent → AskUserQuestion (options: Admin, Support, Business, User, Auth)
|
|
142
|
-
SI $MODULE absent → AskUserQuestion (texte libre)
|
|
143
|
-
```
|
|
144
|
-
|
|
145
|
-
### ÉTAPE 2: ANALYSE EXISTANTE
|
|
146
|
-
|
|
147
|
-
| Action | Commande |
|
|
148
|
-
|--------|----------|
|
|
149
|
-
| Entity Domain | `Glob "Domain/**/{Entity}.cs"` |
|
|
150
|
-
| Permissions existantes | `Read Permissions.cs` |
|
|
151
|
-
| DbContext DbSet | `Grep "{Entity}s" ApplicationDbContext.cs` |
|
|
152
|
-
| Controller existant | `Glob "Controllers/{Area}/{Module}Controller.cs"` |
|
|
153
|
-
|
|
154
|
-
### ÉTAPE 3: CONFIRMATION UTILISATEUR
|
|
155
|
-
|
|
156
|
-
```typescript
|
|
157
|
-
AskUserQuestion({
|
|
158
|
-
questions: [
|
|
159
|
-
{
|
|
160
|
-
header: "Type",
|
|
161
|
-
question: "Quel type de controller ?",
|
|
162
|
-
options: [
|
|
163
|
-
{ label: "CRUD Complet (Recommended)", description: "GET list, GET by ID, POST, PUT, PATCH, DELETE" },
|
|
164
|
-
{ label: "Read-Only", description: "GET list, GET by ID uniquement" },
|
|
165
|
-
{ label: "Custom", description: "Actions spécifiques à définir" }
|
|
166
|
-
]
|
|
167
|
-
},
|
|
168
|
-
{
|
|
169
|
-
header: "Postman",
|
|
170
|
-
question: "Générer les tests Postman ?",
|
|
171
|
-
options: [
|
|
172
|
-
{ label: "Oui (Recommended)", description: "Ajoute tests dans SmartStack.Security.postman_collection.json" },
|
|
173
|
-
{ label: "Non", description: "Controller uniquement" }
|
|
174
|
-
]
|
|
175
|
-
}
|
|
176
|
-
]
|
|
177
|
-
})
|
|
178
|
-
```
|
|
179
|
-
|
|
180
|
-
### ÉTAPE 4: VALIDATION SÉCURITÉ
|
|
181
|
-
|
|
182
|
-
**Vérifications obligatoires avant génération:**
|
|
183
|
-
|
|
184
|
-
1. ✅ Permission path existe ou sera créée
|
|
185
|
-
2. ✅ Format permission: `context.application.module.action`
|
|
186
|
-
3. ✅ DbSet existe dans ApplicationDbContext
|
|
187
|
-
4. ✅ Entity a les méthodes Create/Update nécessaires
|
|
188
|
-
|
|
189
|
-
### ÉTAPE 5: GÉNÉRATION
|
|
190
|
-
|
|
191
|
-
| Fichier | Chemin | Action |
|
|
192
|
-
|---------|--------|--------|
|
|
193
|
-
| Controller | `src/SmartStack.Api/Controllers/{Area}/{Module}Controller.cs` | CREATE |
|
|
194
|
-
| Permissions | `src/SmartStack.Application/Common/Authorization/Permissions.cs` | UPDATE |
|
|
195
|
-
| Tests Postman | `tests/SmartStack.Security.postman_collection.json` | UPDATE (si choisi) |
|
|
196
|
-
|
|
197
|
-
**Utiliser templates de** → `.claude/skills/controller/templates.md`
|
|
198
|
-
|
|
199
|
-
### ÉTAPE 6: SYNCHRONISATION BASE DE DONNÉES (OBLIGATOIRE)
|
|
200
|
-
|
|
201
|
-
> **CRITIQUE:** Un controller avec `[RequirePermission]` retournera **403 Forbidden** pour TOUS les utilisateurs si la permission n'existe pas dans la base de données.
|
|
202
|
-
|
|
203
|
-
#### Workflow obligatoire
|
|
204
|
-
|
|
205
|
-
```
|
|
206
|
-
┌──────────────────────────────────────────────────────────────────────────────┐
|
|
207
|
-
│ WORKFLOW SYNCHRONISATION PERMISSIONS │
|
|
208
|
-
├──────────────────────────────────────────────────────────────────────────────┤
|
|
209
|
-
│ │
|
|
210
|
-
│ 1. GÉNÉRER CONTROLLER │
|
|
211
|
-
│ └─→ [RequirePermission(Permissions.{Module}.View)] │
|
|
212
|
-
│ │
|
|
213
|
-
│ 2. AJOUTER À Permissions.cs (Application layer) │
|
|
214
|
-
│ └─→ public static class {Module} { ... } │
|
|
215
|
-
│ │
|
|
216
|
-
│ 3. AJOUTER À PermissionConfiguration.cs (Infrastructure layer) │
|
|
217
|
-
│ └─→ HasData(new { Path = "...", ModuleId = ..., ... }) │
|
|
218
|
-
│ │
|
|
219
|
-
│ 4. CRÉER MIGRATION EF CORE │
|
|
220
|
-
│ └─→ /efcore:migration Add{Module}Permissions │
|
|
221
|
-
│ │
|
|
222
|
-
│ 5. VALIDER COHÉRENCE │
|
|
223
|
-
│ └─→ Vérifier que TOUS les paths dans Permissions.cs │
|
|
224
|
-
│ existent dans PermissionConfiguration.cs │
|
|
225
|
-
│ │
|
|
226
|
-
└──────────────────────────────────────────────────────────────────────────────┘
|
|
227
|
-
```
|
|
228
|
-
|
|
229
|
-
### ÉTAPE 7: LOGS CRITIQUES - VÉRIFICATION
|
|
230
|
-
|
|
231
|
-
Après génération, **VÉRIFIER** que le controller contient :
|
|
232
|
-
|
|
233
|
-
| Événement | Niveau Requis | Présent ? |
|
|
234
|
-
|-----------|---------------|-----------|
|
|
235
|
-
| Login échoué (si auth) | `LogCritical` | ☐ |
|
|
236
|
-
| Compte verrouillé (si auth) | `LogCritical` | ☐ |
|
|
237
|
-
| Password change | `LogWarning` | ☐ |
|
|
238
|
-
| Création | `LogInformation` | ☐ |
|
|
239
|
-
| Modification | `LogInformation` | ☐ |
|
|
240
|
-
| Suppression | `LogWarning` | ☐ |
|
|
241
|
-
| Désactivation | `LogWarning` | ☐ |
|
|
242
|
-
|
|
243
|
-
### ÉTAPE 8: RÉSUMÉ FINAL
|
|
244
|
-
|
|
245
|
-
Afficher:
|
|
246
|
-
- ✅ Fichiers créés (chemins cliquables)
|
|
247
|
-
- 🔐 Permissions ajoutées
|
|
248
|
-
- 🧪 Tests Postman générés (si applicable)
|
|
249
|
-
- 📝 Prochaines étapes:
|
|
250
|
-
- Vérifier les DTOs
|
|
251
|
-
- Ajouter validation métier si nécessaire
|
|
252
|
-
- Tester avec Swagger/Postman
|
|
253
|
-
|
|
254
|
-
---
|
|
255
|
-
|
|
256
|
-
## SOURCES DE DONNÉES
|
|
257
|
-
|
|
258
|
-
| Donnée | Source |
|
|
259
|
-
|--------|--------|
|
|
260
|
-
| Entity Domain | `src/SmartStack.Domain/**/{Entity}.cs` |
|
|
261
|
-
| DbContext | `src/SmartStack.Application/Common/Interfaces/IApplicationDbContext.cs` |
|
|
262
|
-
| Permissions | `src/SmartStack.Application/Common/Authorization/Permissions.cs` |
|
|
263
|
-
| Controllers existants | `src/SmartStack.Api/Controllers/**/*.cs` |
|
|
264
|
-
| Tests Postman | `tests/SmartStack.Security.postman_collection.json` |
|
|
265
|
-
|
|
266
|
-
---
|
|
267
|
-
|
|
268
|
-
## RÈGLES SÉCURITÉ - LOGS CRITIQUES (OBLIGATOIRE)
|
|
269
|
-
|
|
270
|
-
| Événement | Niveau | Pattern |
|
|
271
|
-
|-----------|--------|---------|
|
|
272
|
-
| Login échoué | `Critical` | `LogCritical("Login attempt on locked account...")` |
|
|
273
|
-
| Permission refusée | `Critical` | Auto via `SecurityAuditMiddleware` |
|
|
274
|
-
| Compte verrouillé | `Critical` | `LogCritical("Account locked...")` |
|
|
275
|
-
| Password change | `Warning` | `LogWarning("Password changed...")` |
|
|
276
|
-
| Création/MAJ | `Information` | `LogInformation("User {User} creating...")` |
|
|
277
|
-
| Suppression | `Warning` | `LogWarning("User {User} deleting...")` |
|
|
278
|
-
|
|
279
|
-
---
|
|
280
|
-
|
|
281
|
-
## CONTRAINTES TECHNIQUES
|
|
282
|
-
|
|
283
|
-
### Injection de Dépendances (Obligatoire)
|
|
284
|
-
|
|
285
|
-
```csharp
|
|
286
|
-
public {Module}Controller(
|
|
287
|
-
IApplicationDbContext context, // TOUJOURS
|
|
288
|
-
ICurrentUserService currentUser, // TOUJOURS
|
|
289
|
-
ILogger<{Module}Controller> logger // TOUJOURS
|
|
290
|
-
// + services spécifiques au module
|
|
291
|
-
)
|
|
292
|
-
```
|
|
293
|
-
|
|
294
|
-
### ProducesResponseType (Obligatoire)
|
|
295
|
-
|
|
296
|
-
```csharp
|
|
297
|
-
[ProducesResponseType(typeof(PagedResult<T>), StatusCodes.Status200OK)]
|
|
298
|
-
[ProducesResponseType(StatusCodes.Status401Unauthorized)] // Si [Authorize]
|
|
299
|
-
[ProducesResponseType(StatusCodes.Status403Forbidden)] // Si [RequirePermission]
|
|
300
|
-
[ProducesResponseType(StatusCodes.Status404NotFound)] // Si GET/PUT/DELETE by ID
|
|
301
|
-
```
|
|
302
|
-
|
|
303
|
-
### Logging Pattern (Obligatoire)
|
|
304
|
-
|
|
305
|
-
```csharp
|
|
306
|
-
// Information - opérations standard
|
|
307
|
-
_logger.LogInformation("User {User} created {Entity} {Id}",
|
|
308
|
-
_currentUser.Email, entity.Id);
|
|
309
|
-
|
|
310
|
-
// Warning - opérations sensibles
|
|
311
|
-
_logger.LogWarning("User {User} deleted {Entity} {Id} ({Name})",
|
|
312
|
-
_currentUser.Email, id, entity.Name);
|
|
313
|
-
|
|
314
|
-
// Critical - sécurité (automatique via middleware pour 401/403)
|
|
315
|
-
_logger.LogCritical("SECURITY: Login attempt on locked account - {Email} from {IP}",
|
|
316
|
-
email, ipAddress);
|
|
317
|
-
```
|
|
318
|
-
|
|
319
|
-
---
|
|
320
|
-
|
|
321
|
-
## TEMPLATES
|
|
322
|
-
|
|
323
|
-
→ **Voir `.claude/skills/controller/templates.md`**
|
|
324
|
-
|
|
325
|
-
Templates disponibles:
|
|
326
|
-
- CRUD Controller (standard)
|
|
327
|
-
- Auth Controller (login/logout/change-password)
|
|
328
|
-
- Controller avec Relations (nested resources)
|
|
329
|
-
- Patterns réutilisables (pagination, error responses)
|
|
330
|
-
|
|
331
|
-
→ **Voir `.claude/skills/controller/postman-templates.md`**
|
|
332
|
-
|
|
333
|
-
Templates tests:
|
|
334
|
-
- GET list (200, 403, 401)
|
|
335
|
-
- POST create (201, 403)
|
|
336
|
-
- DELETE (403)
|
|
337
|
-
- Auth (login success/fail, invalid token)
|
|
1
|
+
# /controller - Skill Controller SmartStack
|
|
2
|
+
|
|
3
|
+
> **Synergie Skill/Commande:**
|
|
4
|
+
> - **Skill** (`.claude/skills/controller/`) → Invocation automatique par Claude
|
|
5
|
+
> - **Commande** (`/controller:create`) → Invocation manuelle par l'utilisateur
|
|
6
|
+
> - Templates partagés dans `.claude/skills/controller/templates.md`
|
|
7
|
+
|
|
8
|
+
> **MCP INTEGRATION:** This command can use `mcp__smartstack__scaffold_extension` for code generation.
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## MCP SCAFFOLDING (Recommended)
|
|
13
|
+
|
|
14
|
+
> **NEW:** Use SmartStack MCP for consistent code generation across all projects.
|
|
15
|
+
|
|
16
|
+
### When to Use MCP
|
|
17
|
+
|
|
18
|
+
| Scenario | Use MCP | Use Templates |
|
|
19
|
+
|----------|---------|---------------|
|
|
20
|
+
| Standard CRUD controller | Yes | - |
|
|
21
|
+
| Controller with custom logic | - | Yes |
|
|
22
|
+
| Need validation before | Yes | - |
|
|
23
|
+
| Offline mode | - | Yes |
|
|
24
|
+
|
|
25
|
+
### MCP Invocation
|
|
26
|
+
|
|
27
|
+
**Claude instruction:** For standard controller generation, invoke MCP first:
|
|
28
|
+
|
|
29
|
+
```json
|
|
30
|
+
{
|
|
31
|
+
"tool": "mcp__smartstack__scaffold_extension",
|
|
32
|
+
"parameters": {
|
|
33
|
+
"type": "controller",
|
|
34
|
+
"name": "{MODULE}",
|
|
35
|
+
"options": {
|
|
36
|
+
"namespace": "SmartStack.Api.Controllers.{AREA}",
|
|
37
|
+
"methods": ["GetAll", "GetById", "Create", "Update", "Delete"]
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
The MCP returns a `ScaffoldResult`:
|
|
44
|
+
|
|
45
|
+
```typescript
|
|
46
|
+
interface ScaffoldResult {
|
|
47
|
+
success: boolean;
|
|
48
|
+
files: GeneratedFile[];
|
|
49
|
+
instructions: string[];
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
interface GeneratedFile {
|
|
53
|
+
path: string;
|
|
54
|
+
content: string;
|
|
55
|
+
type: 'created' | 'modified';
|
|
56
|
+
}
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Post-MCP Steps
|
|
60
|
+
|
|
61
|
+
After MCP generates the controller:
|
|
62
|
+
1. Review generated code
|
|
63
|
+
2. Add to `Permissions.cs` (STEP 6 below)
|
|
64
|
+
3. Add to `PermissionConfiguration.cs`
|
|
65
|
+
4. Create migration if needed
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
## ARGUMENTS
|
|
70
|
+
|
|
71
|
+
```
|
|
72
|
+
/controller:create <area> <module> [entity]
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
| Variable | Extraction | Valeurs |
|
|
76
|
+
|----------|------------|---------|
|
|
77
|
+
| `$AREA` | Premier mot | `Admin`, `Support`, `Business`, `User`, `Auth` |
|
|
78
|
+
| `$MODULE` | Deuxième mot | Nom du module (PascalCase) |
|
|
79
|
+
| `$ENTITY` | Troisième mot (optionnel) | Nom de l'entité Domain (défaut = singulier de $MODULE) |
|
|
80
|
+
|
|
81
|
+
**Exemples:**
|
|
82
|
+
```
|
|
83
|
+
/controller:create Admin Users
|
|
84
|
+
/controller:create Support Tickets Ticket
|
|
85
|
+
/controller:create Business Leads Lead
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## VALIDATION CONTEXTES (CRITIQUE)
|
|
91
|
+
|
|
92
|
+
> **RAPPEL:** Les controllers client doivent être dans l'Area `Business`.
|
|
93
|
+
|
|
94
|
+
### Mapping Area → Context
|
|
95
|
+
|
|
96
|
+
| Area | Route Prefix | Permission Context | Autorisé Client |
|
|
97
|
+
|------|--------------|-------------------|-----------------|
|
|
98
|
+
| `Admin` | `api/admin/` | `platform.administration.*` | ❌ NON |
|
|
99
|
+
| `Support` | `api/support/` | `platform.support.*` | ❌ NON |
|
|
100
|
+
| `Business` | `api/business/` | `business.*` | ✅ OUI |
|
|
101
|
+
| `User` | `api/user/` | `personal.myspace.*` | ❌ NON |
|
|
102
|
+
| `Auth` | `api/auth/` | (AllowAnonymous) | ❌ NON |
|
|
103
|
+
|
|
104
|
+
### Validation Automatique
|
|
105
|
+
|
|
106
|
+
```
|
|
107
|
+
AVANT génération:
|
|
108
|
+
|
|
109
|
+
SI $AREA NOT IN ["Admin", "Support", "Business", "User", "Auth"]:
|
|
110
|
+
❌ ERREUR: "Area '$AREA' non reconnue"
|
|
111
|
+
SUGGÉRER: "Utilisez 'Business' pour les modules client"
|
|
112
|
+
ABORT
|
|
113
|
+
|
|
114
|
+
SI création par client ET $AREA IN ["Admin", "Support", "User", "Auth"]:
|
|
115
|
+
⚠️ WARNING: "L'area '$AREA' est réservée au core SmartStack"
|
|
116
|
+
SUGGÉRER: "Utilisez '/controller:create Business $MODULE $ENTITY'"
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
## RÈGLES ABSOLUES
|
|
122
|
+
|
|
123
|
+
1. **TOUJOURS** utiliser `[RequirePermission(Permissions.*)]` - jamais de strings
|
|
124
|
+
2. **TOUJOURS** ajouter `[ProducesResponseType]` pour chaque status possible
|
|
125
|
+
3. **TOUJOURS** logger les opérations (Info pour CRUD, Warning pour Delete/Sensitive)
|
|
126
|
+
4. **TOUJOURS** protéger les comptes système (UserType.System/LocalAdmin)
|
|
127
|
+
5. **JAMAIS** de SQL direct - utiliser EF Core
|
|
128
|
+
6. **JAMAIS** d'endpoint sans permission (sauf [AllowAnonymous] pour auth)
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
## WORKFLOW
|
|
133
|
+
|
|
134
|
+
### ÉTAPE 1: PARSING DES ARGUMENTS
|
|
135
|
+
|
|
136
|
+
```
|
|
137
|
+
EXTRAIRE $AREA = premier mot des arguments (PascalCase)
|
|
138
|
+
EXTRAIRE $MODULE = deuxième mot des arguments (PascalCase)
|
|
139
|
+
EXTRAIRE $ENTITY = troisième mot OU singulier de $MODULE
|
|
140
|
+
|
|
141
|
+
SI $AREA absent → AskUserQuestion (options: Admin, Support, Business, User, Auth)
|
|
142
|
+
SI $MODULE absent → AskUserQuestion (texte libre)
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
### ÉTAPE 2: ANALYSE EXISTANTE
|
|
146
|
+
|
|
147
|
+
| Action | Commande |
|
|
148
|
+
|--------|----------|
|
|
149
|
+
| Entity Domain | `Glob "Domain/**/{Entity}.cs"` |
|
|
150
|
+
| Permissions existantes | `Read Permissions.cs` |
|
|
151
|
+
| DbContext DbSet | `Grep "{Entity}s" ApplicationDbContext.cs` |
|
|
152
|
+
| Controller existant | `Glob "Controllers/{Area}/{Module}Controller.cs"` |
|
|
153
|
+
|
|
154
|
+
### ÉTAPE 3: CONFIRMATION UTILISATEUR
|
|
155
|
+
|
|
156
|
+
```typescript
|
|
157
|
+
AskUserQuestion({
|
|
158
|
+
questions: [
|
|
159
|
+
{
|
|
160
|
+
header: "Type",
|
|
161
|
+
question: "Quel type de controller ?",
|
|
162
|
+
options: [
|
|
163
|
+
{ label: "CRUD Complet (Recommended)", description: "GET list, GET by ID, POST, PUT, PATCH, DELETE" },
|
|
164
|
+
{ label: "Read-Only", description: "GET list, GET by ID uniquement" },
|
|
165
|
+
{ label: "Custom", description: "Actions spécifiques à définir" }
|
|
166
|
+
]
|
|
167
|
+
},
|
|
168
|
+
{
|
|
169
|
+
header: "Postman",
|
|
170
|
+
question: "Générer les tests Postman ?",
|
|
171
|
+
options: [
|
|
172
|
+
{ label: "Oui (Recommended)", description: "Ajoute tests dans SmartStack.Security.postman_collection.json" },
|
|
173
|
+
{ label: "Non", description: "Controller uniquement" }
|
|
174
|
+
]
|
|
175
|
+
}
|
|
176
|
+
]
|
|
177
|
+
})
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
### ÉTAPE 4: VALIDATION SÉCURITÉ
|
|
181
|
+
|
|
182
|
+
**Vérifications obligatoires avant génération:**
|
|
183
|
+
|
|
184
|
+
1. ✅ Permission path existe ou sera créée
|
|
185
|
+
2. ✅ Format permission: `context.application.module.action`
|
|
186
|
+
3. ✅ DbSet existe dans ApplicationDbContext
|
|
187
|
+
4. ✅ Entity a les méthodes Create/Update nécessaires
|
|
188
|
+
|
|
189
|
+
### ÉTAPE 5: GÉNÉRATION
|
|
190
|
+
|
|
191
|
+
| Fichier | Chemin | Action |
|
|
192
|
+
|---------|--------|--------|
|
|
193
|
+
| Controller | `src/SmartStack.Api/Controllers/{Area}/{Module}Controller.cs` | CREATE |
|
|
194
|
+
| Permissions | `src/SmartStack.Application/Common/Authorization/Permissions.cs` | UPDATE |
|
|
195
|
+
| Tests Postman | `tests/SmartStack.Security.postman_collection.json` | UPDATE (si choisi) |
|
|
196
|
+
|
|
197
|
+
**Utiliser templates de** → `.claude/skills/controller/templates.md`
|
|
198
|
+
|
|
199
|
+
### ÉTAPE 6: SYNCHRONISATION BASE DE DONNÉES (OBLIGATOIRE)
|
|
200
|
+
|
|
201
|
+
> **CRITIQUE:** Un controller avec `[RequirePermission]` retournera **403 Forbidden** pour TOUS les utilisateurs si la permission n'existe pas dans la base de données.
|
|
202
|
+
|
|
203
|
+
#### Workflow obligatoire
|
|
204
|
+
|
|
205
|
+
```
|
|
206
|
+
┌──────────────────────────────────────────────────────────────────────────────┐
|
|
207
|
+
│ WORKFLOW SYNCHRONISATION PERMISSIONS │
|
|
208
|
+
├──────────────────────────────────────────────────────────────────────────────┤
|
|
209
|
+
│ │
|
|
210
|
+
│ 1. GÉNÉRER CONTROLLER │
|
|
211
|
+
│ └─→ [RequirePermission(Permissions.{Module}.View)] │
|
|
212
|
+
│ │
|
|
213
|
+
│ 2. AJOUTER À Permissions.cs (Application layer) │
|
|
214
|
+
│ └─→ public static class {Module} { ... } │
|
|
215
|
+
│ │
|
|
216
|
+
│ 3. AJOUTER À PermissionConfiguration.cs (Infrastructure layer) │
|
|
217
|
+
│ └─→ HasData(new { Path = "...", ModuleId = ..., ... }) │
|
|
218
|
+
│ │
|
|
219
|
+
│ 4. CRÉER MIGRATION EF CORE │
|
|
220
|
+
│ └─→ /efcore:migration Add{Module}Permissions │
|
|
221
|
+
│ │
|
|
222
|
+
│ 5. VALIDER COHÉRENCE │
|
|
223
|
+
│ └─→ Vérifier que TOUS les paths dans Permissions.cs │
|
|
224
|
+
│ existent dans PermissionConfiguration.cs │
|
|
225
|
+
│ │
|
|
226
|
+
└──────────────────────────────────────────────────────────────────────────────┘
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
### ÉTAPE 7: LOGS CRITIQUES - VÉRIFICATION
|
|
230
|
+
|
|
231
|
+
Après génération, **VÉRIFIER** que le controller contient :
|
|
232
|
+
|
|
233
|
+
| Événement | Niveau Requis | Présent ? |
|
|
234
|
+
|-----------|---------------|-----------|
|
|
235
|
+
| Login échoué (si auth) | `LogCritical` | ☐ |
|
|
236
|
+
| Compte verrouillé (si auth) | `LogCritical` | ☐ |
|
|
237
|
+
| Password change | `LogWarning` | ☐ |
|
|
238
|
+
| Création | `LogInformation` | ☐ |
|
|
239
|
+
| Modification | `LogInformation` | ☐ |
|
|
240
|
+
| Suppression | `LogWarning` | ☐ |
|
|
241
|
+
| Désactivation | `LogWarning` | ☐ |
|
|
242
|
+
|
|
243
|
+
### ÉTAPE 8: RÉSUMÉ FINAL
|
|
244
|
+
|
|
245
|
+
Afficher:
|
|
246
|
+
- ✅ Fichiers créés (chemins cliquables)
|
|
247
|
+
- 🔐 Permissions ajoutées
|
|
248
|
+
- 🧪 Tests Postman générés (si applicable)
|
|
249
|
+
- 📝 Prochaines étapes:
|
|
250
|
+
- Vérifier les DTOs
|
|
251
|
+
- Ajouter validation métier si nécessaire
|
|
252
|
+
- Tester avec Swagger/Postman
|
|
253
|
+
|
|
254
|
+
---
|
|
255
|
+
|
|
256
|
+
## SOURCES DE DONNÉES
|
|
257
|
+
|
|
258
|
+
| Donnée | Source |
|
|
259
|
+
|--------|--------|
|
|
260
|
+
| Entity Domain | `src/SmartStack.Domain/**/{Entity}.cs` |
|
|
261
|
+
| DbContext | `src/SmartStack.Application/Common/Interfaces/IApplicationDbContext.cs` |
|
|
262
|
+
| Permissions | `src/SmartStack.Application/Common/Authorization/Permissions.cs` |
|
|
263
|
+
| Controllers existants | `src/SmartStack.Api/Controllers/**/*.cs` |
|
|
264
|
+
| Tests Postman | `tests/SmartStack.Security.postman_collection.json` |
|
|
265
|
+
|
|
266
|
+
---
|
|
267
|
+
|
|
268
|
+
## RÈGLES SÉCURITÉ - LOGS CRITIQUES (OBLIGATOIRE)
|
|
269
|
+
|
|
270
|
+
| Événement | Niveau | Pattern |
|
|
271
|
+
|-----------|--------|---------|
|
|
272
|
+
| Login échoué | `Critical` | `LogCritical("Login attempt on locked account...")` |
|
|
273
|
+
| Permission refusée | `Critical` | Auto via `SecurityAuditMiddleware` |
|
|
274
|
+
| Compte verrouillé | `Critical` | `LogCritical("Account locked...")` |
|
|
275
|
+
| Password change | `Warning` | `LogWarning("Password changed...")` |
|
|
276
|
+
| Création/MAJ | `Information` | `LogInformation("User {User} creating...")` |
|
|
277
|
+
| Suppression | `Warning` | `LogWarning("User {User} deleting...")` |
|
|
278
|
+
|
|
279
|
+
---
|
|
280
|
+
|
|
281
|
+
## CONTRAINTES TECHNIQUES
|
|
282
|
+
|
|
283
|
+
### Injection de Dépendances (Obligatoire)
|
|
284
|
+
|
|
285
|
+
```csharp
|
|
286
|
+
public {Module}Controller(
|
|
287
|
+
IApplicationDbContext context, // TOUJOURS
|
|
288
|
+
ICurrentUserService currentUser, // TOUJOURS
|
|
289
|
+
ILogger<{Module}Controller> logger // TOUJOURS
|
|
290
|
+
// + services spécifiques au module
|
|
291
|
+
)
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
### ProducesResponseType (Obligatoire)
|
|
295
|
+
|
|
296
|
+
```csharp
|
|
297
|
+
[ProducesResponseType(typeof(PagedResult<T>), StatusCodes.Status200OK)]
|
|
298
|
+
[ProducesResponseType(StatusCodes.Status401Unauthorized)] // Si [Authorize]
|
|
299
|
+
[ProducesResponseType(StatusCodes.Status403Forbidden)] // Si [RequirePermission]
|
|
300
|
+
[ProducesResponseType(StatusCodes.Status404NotFound)] // Si GET/PUT/DELETE by ID
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
### Logging Pattern (Obligatoire)
|
|
304
|
+
|
|
305
|
+
```csharp
|
|
306
|
+
// Information - opérations standard
|
|
307
|
+
_logger.LogInformation("User {User} created {Entity} {Id}",
|
|
308
|
+
_currentUser.Email, entity.Id);
|
|
309
|
+
|
|
310
|
+
// Warning - opérations sensibles
|
|
311
|
+
_logger.LogWarning("User {User} deleted {Entity} {Id} ({Name})",
|
|
312
|
+
_currentUser.Email, id, entity.Name);
|
|
313
|
+
|
|
314
|
+
// Critical - sécurité (automatique via middleware pour 401/403)
|
|
315
|
+
_logger.LogCritical("SECURITY: Login attempt on locked account - {Email} from {IP}",
|
|
316
|
+
email, ipAddress);
|
|
317
|
+
```
|
|
318
|
+
|
|
319
|
+
---
|
|
320
|
+
|
|
321
|
+
## TEMPLATES
|
|
322
|
+
|
|
323
|
+
→ **Voir `.claude/skills/controller/templates.md`**
|
|
324
|
+
|
|
325
|
+
Templates disponibles:
|
|
326
|
+
- CRUD Controller (standard)
|
|
327
|
+
- Auth Controller (login/logout/change-password)
|
|
328
|
+
- Controller avec Relations (nested resources)
|
|
329
|
+
- Patterns réutilisables (pagination, error responses)
|
|
330
|
+
|
|
331
|
+
→ **Voir `.claude/skills/controller/postman-templates.md`**
|
|
332
|
+
|
|
333
|
+
Templates tests:
|
|
334
|
+
- GET list (200, 403, 401)
|
|
335
|
+
- POST create (201, 403)
|
|
336
|
+
- DELETE (403)
|
|
337
|
+
- Auth (login success/fail, invalid token)
|