@atlashub/smartstack-cli 1.13.2 → 1.14.0

package/templates/skills/controller/steps/step-04-perms.md

@@ -0,0 +1,219 @@
+---
+name: step-04-perms
+description: Synchronize permissions in Permissions.cs and PermissionConfiguration.cs
+next_step: steps/step-05-validate.md
+---
+
+# Step 4: Synchronize Permissions
+
+## YOUR TASK:
+
+Add permissions to both Permissions.cs (constants) and PermissionConfiguration.cs (database seeds).
+
+**CRITICAL: Both files MUST be in sync. Missing permissions = runtime 403 errors.**
+
+---
+
+## EXECUTION SEQUENCE:
+
+### 1. Update Permissions.cs
+
+**Target file:**
+```
+src/SmartStack.Application/Common/Authorization/Permissions.cs
+```
+
+**Find the correct parent class based on {permission_path}:**
+
+| Permission Path | Parent Class |
+|-----------------|--------------|
+| `platform.administration.*` | `Platform.Administration` |
+| `platform.support.*` | `Platform.Support` |
+| `business.*` | `Business` |
+| `personal.myspace.*` | `Personal.MySpace` |
+
+**Add nested class:**
+
+```csharp
+public static class {module}
+{
+    public const string View = "{permission_path}.read";
+    public const string Create = "{permission_path}.create";
+    public const string Update = "{permission_path}.update";
+    public const string Delete = "{permission_path}.delete";
+}
+```
+
+**Example for platform.support.tickets:**
+
+```csharp
+public static partial class Permissions
+{
+    public static class Platform
+    {
+        public static class Support
+        {
+            // Existing classes...
+
+            public static class Tickets  // NEW
+            {
+                public const string View = "platform.support.tickets.read";
+                public const string Create = "platform.support.tickets.create";
+                public const string Update = "platform.support.tickets.update";
+                public const string Delete = "platform.support.tickets.delete";
+            }
+        }
+    }
+}
+```
+
+### 2. Update PermissionConfiguration.cs
+
+**Target file:**
+```
+src/SmartStack.Infrastructure/Persistence/Configurations/PermissionConfiguration.cs
+```
+
+**Find HasData section and add seeds:**
+
+```csharp
+builder.HasData(
+    // Existing permissions...
+
+    // {module} permissions
+    new Permission
+    {
+        Id = Guid.NewGuid(), // Generate new GUID
+        Code = "{permission_path}.read",
+        Name = "View {module}",
+        Description = "Allows viewing {module_lowercase} list and details",
+        Category = "{area}",
+        IsSystem = true,
+        CreatedAt = new DateTime(2024, 1, 1, 0, 0, 0, DateTimeKind.Utc)
+    },
+    new Permission
+    {
+        Id = Guid.NewGuid(),
+        Code = "{permission_path}.create",
+        Name = "Create {module}",
+        Description = "Allows creating new {module_lowercase}",
+        Category = "{area}",
+        IsSystem = true,
+        CreatedAt = new DateTime(2024, 1, 1, 0, 0, 0, DateTimeKind.Utc)
+    },
+    new Permission
+    {
+        Id = Guid.NewGuid(),
+        Code = "{permission_path}.update",
+        Name = "Update {module}",
+        Description = "Allows updating existing {module_lowercase}",
+        Category = "{area}",
+        IsSystem = true,
+        CreatedAt = new DateTime(2024, 1, 1, 0, 0, 0, DateTimeKind.Utc)
+    },
+    new Permission
+    {
+        Id = Guid.NewGuid(),
+        Code = "{permission_path}.delete",
+        Name = "Delete {module}",
+        Description = "Allows deleting {module_lowercase}",
+        Category = "{area}",
+        IsSystem = true,
+        CreatedAt = new DateTime(2024, 1, 1, 0, 0, 0, DateTimeKind.Utc)
+    }
+);
+```
+
+### 3. Generate Migration (Required)
+
+**After updating PermissionConfiguration:**
+
+```
+IMPORTANT: New HasData entries require a migration!
+
+Suggest command:
+/efcore:migration Add{module}Permissions
+```
+
+**If auto_mode:**
+- Inform user that migration is needed
+- Do NOT auto-run migration (user decision)
+
+### 4. Validation Check
+
+**Verify sync between files:**
+
+| Permission Code | In Permissions.cs | In PermissionConfiguration.cs |
+|-----------------|-------------------|------------------------------|
+| `{permission_path}.read` | ✅ | ✅ |
+| `{permission_path}.create` | ✅ | ✅ |
+| `{permission_path}.update` | ✅ | ✅ |
+| `{permission_path}.delete` | ✅ | ✅ |
+
+### 5. Generate Postman Tests (if postman_mode)
+
+**If {postman_mode} = true:**
+
+Load `postman-templates.md` and generate tests:
+
+```json
+{
+  "name": "{module} API Tests",
+  "item": [
+    {
+      "name": "GET {module} - SuperAdmin (200)",
+      "request": {
+        "method": "GET",
+        "url": "{{baseUrl}}/api/{area}/{module}"
+      },
+      "event": [
+        {
+          "listen": "test",
+          "script": {
+            "exec": ["pm.test('Status 200', () => pm.response.to.have.status(200));"]
+          }
+        }
+      ]
+    },
+    {
+      "name": "GET {module} - No Permission (403)",
+      "request": { "method": "GET", "url": "{{baseUrl}}/api/{area}/{module}" },
+      "event": [
+        {
+          "listen": "prerequest",
+          "script": { "exec": ["// Use NoPermUser token"] }
+        },
+        {
+          "listen": "test",
+          "script": { "exec": ["pm.test('Status 403', () => pm.response.to.have.status(403));"] }
+        }
+      ]
+    }
+  ]
+}
+```
+
+---
+
+## OUTPUT FORMAT:
+
+```
+Permissions Synchronized:
+
+| File | Changes |
+|------|---------|
+| Permissions.cs | Added {module} class with 4 constants |
+| PermissionConfiguration.cs | Added 4 permission seeds |
+| Postman Collection | Added {test_count} tests |
+
+⚠️ MIGRATION REQUIRED:
+Run: /efcore:migration Add{module}Permissions
+
+-> Validating build...
+```
+
+---
+
+## NEXT STEP:
+
+After permissions synced, proceed to `./step-05-validate.md`

package/templates/skills/controller/steps/step-05-validate.md

@@ -0,0 +1,107 @@
+---
+name: step-05-validate
+description: Validate build and SmartStack conventions
+next_step: null
+---
+
+# Step 5: Validate
+
+## YOUR TASK:
+
+Verify the generated code compiles and follows SmartStack conventions.
+
+---
+
+## EXECUTION SEQUENCE:
+
+### 1. Build Check
+
+**Run build to verify compilation:**
+
+```bash
+dotnet build src/SmartStack.Api/SmartStack.Api.csproj --no-restore
+```
+
+**If build fails:**
+- Parse error messages
+- Fix issues in generated files
+- Re-run build until success
+
+### 2. Convention Validation
+
+**Use SmartStack MCP to validate:**
+
+```
+mcp__smartstack__validate_conventions:
+  checks: ["controllers", "services", "namespaces"]
+```
+
+**Manual checks:**
+
+| Convention | Check | Status |
+|------------|-------|--------|
+| Route attribute | `[Route("api/{area}/[controller]")]` | ✅/❌ |
+| Authorize attribute | `[Authorize]` present | ✅/❌ |
+| RequirePermission | Uses `Permissions.*` constants | ✅/❌ |
+| ProducesResponseType | All endpoints documented | ✅/❌ |
+| Logging | All CRUD operations logged | ✅/❌ |
+| System account protection | Guard present (if applicable) | ✅/❌ |
+
+### 3. Security Audit
+
+**Verify security requirements:**
+
+| Security Check | Required | Present |
+|----------------|----------|---------|
+| No string permission literals | Yes | ✅/❌ |
+| No raw SQL | Yes | ✅/❌ |
+| Input validation | Yes | ✅/❌ |
+| Tenant isolation (if TenantEntity) | Yes | ✅/❌ |
+| Audit logging | Yes | ✅/❌ |
+
+### 4. Final Summary
+
+**Display completion report:**
+
+```
+╔═══════════════════════════════════════════════════════════════════╗
+║                    CONTROLLER GENERATED                            ║
+╠═══════════════════════════════════════════════════════════════════╣
+║  Controller: {area}/{module}Controller                             ║
+║  Entity:     {entity}                                              ║
+║  Type:       {controller_type}                                     ║
+╠═══════════════════════════════════════════════════════════════════╣
+║  FILES CREATED:                                                    ║
+║  ✅ src/.../Controllers/{area}/{module}Controller.cs               ║
+║  ✅ src/.../Authorization/Permissions.cs (updated)                 ║
+║  ✅ src/.../Configurations/PermissionConfiguration.cs (updated)    ║
+║  {dto_mode ? "✅ src/.../DTOs/{module}/*.cs" : ""}                 ║
+║  {postman_mode ? "✅ tests/SmartStack.Security.postman.json" : ""} ║
+╠═══════════════════════════════════════════════════════════════════╣
+║  PERMISSIONS ADDED:                                                ║
+║  🔐 {permission_path}.read                                         ║
+║  🔐 {permission_path}.create                                       ║
+║  🔐 {permission_path}.update                                       ║
+║  🔐 {permission_path}.delete                                       ║
+╠═══════════════════════════════════════════════════════════════════╣
+║  NEXT STEPS:                                                       ║
+║  1. Create migration: /efcore:migration Add{module}Permissions     ║
+║  2. Apply migration: /efcore:db-deploy                             ║
+║  3. Test endpoints in Swagger: /api/{area}/{module}                ║
+║  4. Run Postman tests (if generated)                               ║
+╚═══════════════════════════════════════════════════════════════════╝
+```
+
+---
+
+## SUCCESS CRITERIA:
+
+- Build passes without errors
+- All conventions validated
+- Security requirements met
+- Clear summary displayed
+- Next steps documented
+
+## COMPLETION:
+
+Controller generation complete. No more steps.