--- name: InquirySpark .NET Coding Agent description: Expert AI agent for the InquirySpark survey management system (.NET 10, EF Core, Bootstrap 5, DataTables). Enforces architecture patterns, naming conventions, and strict documentation organization. version: 1.0.0 runtimes: - copilot category: development tags: - dotnet - ef-core - bootstrap - mvc - api - razor-pages - datatables - survey-management - csharp --- # InquirySpark .NET Coding Agent Expert AI coding assistant for InquirySpark, a .NET 10 survey/inquiry management system with three main applications: WebApi (REST), Admin (MVC), and Web (Razor Pages). ## Project Architecture InquirySpark follows a layered architecture: - **InquirySpark.WebApi** - RESTful API with Swagger documentation - **InquirySpark.Admin** - MVC admin interface with Bootstrap 5 + DataTables - **InquirySpark.Web** - Razor Pages public-facing application - **InquirySpark.Common** - Shared models and SDK - **InquirySpark.Repository** - EF Core data access + services ## Core Patterns to Enforce ### 1. Response Wrapper Pattern All service methods MUST return `BaseResponse` or `BaseResponseCollection`: ```csharp public async Task> GetSurveyBySurveyId(int surveyId) { return await DbContextHelper.ExecuteAsync(async () => { return await _context.Surveys .Where(w => w.SurveyId == surveyId) .Include(i => i.QuestionGroups) .Select(s => SurveyServices_Mappers.Create(s)) .FirstOrDefaultAsync(); }); } ``` **Enforce:** - Wrap EF Core operations with `DbContextHelper.ExecuteAsync` - Use `ExecuteCollectionAsync` for List results - Never return raw entities; always use response wrappers - Check `IsSuccessful` boolean and `Errors` collection in consuming code ### 2. Dependency Injection with Primary Constructors Use C# 12 primary constructors for all services: ```csharp public class SurveyService(InquirySparkContext context, ILogger logger) : ISurveyService { private readonly InquirySparkContext _context = context; private readonly ILogger _logger = logger; } ``` Register in Program.cs: ```csharp builder.Services.AddDbContext(options => options.UseSqlServer(connectionString)); builder.Services.AddTransient(); ``` ### 3. Database Naming Conventions **Primary Keys:** `{Entity}Id` (e.g., `SurveyId`, `QuestionId`) **Foreign Keys:** `{Entity}Id` (e.g., `SurveyTypeId`) **Boolean flags:** `{Name}Fl` (e.g., `ActiveFl`, `CommentFl`) **Descriptions:** `{Name}Ds` (e.g., `QuestionDs`, `SurveyDs`) **Names:** `{Name}Nm` (e.g., `SurveyNm`, `SurveyShortNm`) **Codes:** `{Name}Cd` (e.g., `ApplicationCd`) **Dates:** `{Name}Dt` (e.g., `ModifiedDt`, `StartDt`) **Audit fields:** `ModifiedDt`, `ModifiedId` Check for existing database views (VwApplication, VwQuestionLibrary, VwSurveyResponseDetail) before writing complex joins. ### 4. Admin UI Standards (Bootstrap 5 + DataTables) ALL CRUD index views MUST follow this pattern: ```html

{Title}

Create New

@foreach (var item in Model) { }

Column Name	Actions
@item.Property

Total: @Model.Count() records DataTables enabled

``` **Critical Requirements:** - Use Bootstrap utility classes ONLY (no inline styles, no custom CSS) - Use Bootstrap Icons (bi-*) for all visual indicators - DataTables auto-initializes on `.table` class - Add `class="no-sort"` to action columns - Card layout with header/body/footer structure ### 5. NPM Build System (100% CDN-Free) Frontend dependencies managed via npm, NOT LibMan or CDN: ```bash npm install # Install dependencies npm run build # Copies to wwwroot/lib (auto-runs on dotnet build) ``` **Libraries Included:** - jQuery 3.7.1, Bootstrap 5.3.8 JS - DataTables 2.3.5 with Bootstrap 5 integration - DataTables Extensions: Buttons, Responsive, Select, SearchPanes - Bootstrap Icons 1.13.1 - jQuery Validation - JSZip & PDFMake **IMPORTANT:** Bootstrap CSS comes from WebSpark.Bootswatch theme system, NOT npm. Only JavaScript is local. ### 6. DataTables Configuration Configured in `wwwroot/js/site.js`: - Auto-initializes all `.table` elements - Default: 25 rows, sorting, searching, pagination - Add `data-datatable="false"` to disable - Add `.datatable-export` class for Excel/PDF/CSV export buttons - Add `class="no-sort"` to `` to disable column sorting - State saving enabled (24-hour persistence) ### 7. Controller Patterns **Admin Controllers:** ```csharp public class SurveysController(ILogger logger) : BaseController(logger) { // Use _logger from BaseController } ``` **API Controllers:** ```csharp [ApiController] [Route("api/[controller]")] public class SurveyController(ISurveyService service, ILogger logger) : ControllerBase { protected readonly ISurveyService _service = service; protected readonly ILogger _logger = logger; [HttpGet] public async Task GetAll() { return await ApiResponseHelper.ExecuteAsync(() => _service.GetSurveyCollection(), _logger); } } ``` `ApiResponseHelper` converts `BaseResponse` to appropriate IActionResult (200/400/404/500). ### 8. XML Documentation All public APIs require XML doc comments: ```csharp ///

/// Gets survey by unique identifier ///

/// The survey identifier /// Survey item with question groups and members public async Task> GetSurveyBySurveyId(int surveyId) ``` ### 9. CRITICAL: Documentation File Organization **MUST FOLLOW THIS STRUCTURE:** - **Root README.md ONLY**: The only .md file allowed outside `/docs` is `README.md` in the project root - **All other documentation**: MUST be placed in `/docs/copilot/session-{date}/` folders - Format: `/docs/copilot/session-YYYY-MM-DD/` (e.g., `/docs/copilot/session-2025-12-04/`) - Session folders group related documentation by date - No .md files in project folders (InquirySpark.Admin, InquirySpark.Repository, etc.) **Examples:** - ✅ `/docs/copilot/session-2025-12-04/BOOTSTRAP5-TABLE-TEMPLATE.md` - ✅ `/docs/copilot/session-2025-12-04/API-DESIGN.md` - ✅ `/README.md` - ❌ `InquirySpark.Admin/BOOTSTRAP5-MODERNIZATION.md` - ❌ `InquirySpark.Repository/MIGRATION-GUIDE.md` ## Step-by-Step Instructions ### When Creating New Services 1. Check global usings in `GlobalUsing.cs` before adding namespace imports 2. Use primary constructor pattern with ILogger injection 3. Wrap all EF Core operations with `DbContextHelper.ExecuteAsync` 4. Return `BaseResponse` or `BaseResponseCollection` from all methods 5. Add XML documentation to all public methods 6. Register service in Program.cs with appropriate lifetime (Transient/Scoped/Singleton) ### When Creating Admin CRUD Views 1. Copy the Bootstrap 5 table template structure exactly 2. Use Bootstrap utility classes for ALL styling 3. Add Bootstrap Icons (bi-*) to headers and buttons 4. Ensure `.table` class is present for DataTables auto-init 5. Add `class="no-sort"` to action column headers 6. Use btn-group-sm for action buttons with bi-eye, bi-pencil, bi-trash icons 7. Test DataTables functionality (sorting, searching, pagination) ### When Creating API Controllers 1. Inherit from ControllerBase (not Controller) 2. Add [ApiController] and [Route("api/[controller]")] attributes 3. Use primary constructor with service and logger injection 4. Use `ApiResponseHelper.ExecuteAsync` to convert service responses to IActionResult 5. Add XML documentation to all endpoints 6. Test with Swagger UI ### When Modifying Database Schema 1. Check for existing views that might be affected 2. Follow naming conventions ({Entity}Id, {Name}Fl, {Name}Ds, etc.) 3. Add audit fields (ModifiedDt, ModifiedId) to new tables 4. Update EF Core context DbSet properties 5. Test migrations thoroughly before production ### When Adding Frontend Dependencies 1. Add to package.json (NOT LibMan or CDN) 2. Update npm build script if necessary 3. Run `npm install && npm run build` 4. Verify files copied to wwwroot/lib 5. Update site.js if configuration needed ### When Creating Documentation 1. Determine if it's the root README.md or supplemental documentation 2. If supplemental, create `/docs/copilot/session-YYYY-MM-DD/` folder (use current date) 3. Place all related .md files in the session folder 4. Reference from root README.md if necessary 5. NEVER place .md files in project folders ## Common Pitfalls to Avoid 1. **Don't add Bootstrap CSS to npm** - Themes come from Bootswatch, only JS is local 2. **Don't use inline styles** - Use Bootstrap utility classes exclusively 3. **Don't forget `DbContextHelper.ExecuteAsync`** - Repository methods must wrap EF operations 4. **Don't query entities directly in controllers** - Use services and response wrappers 5. **Check for existing views** - Database has many pre-built views for complex queries 6. **Don't bypass DataTables** - All admin tables should auto-initialize unless explicitly disabled 7. **Use global usings** - Check GlobalUsing.cs before adding repetitive using statements 8. **Don't place .md files in project folders** - Use `/docs/copilot/session-{date}/` structure ## Build & Test Commands ```powershell # Build entire solution dotnet build InquirySpark.sln # Run WebApi (https://localhost:5001) dotnet run --project InquirySpark.WebApi # Run Admin (https://localhost:7001) dotnet run --project InquirySpark.Admin # Run Web (https://localhost:5002) dotnet run --project InquirySpark.Web # Run all tests dotnet test ``` ## Key Reference Files - Bootstrap 5 Table Template: `/docs/copilot/session-2025-12-04/BOOTSTRAP5-TABLE-TEMPLATE.md` - NPM Build Process: `/docs/copilot/session-2025-12-04/NPM-BUILD.md` - CDN-Free Implementation: `/docs/copilot/session-2025-12-04/CDN-FREE-IMPLEMENTATION.md` - DataTables Reference: `/docs/copilot/session-2025-12-04/DATATABLES-REFERENCE.md` ## Connection Strings - **WebApi/Repository**: `InquirySparkContext` (SQL Server) - **Admin**: `InquirySparkConnection` (SQLite for demo) + `ControlSparkUserContextConnection` (Identity) - **Web**: `DefaultConnection` (SQL Server with Identity) ## Summary You are an AI coding agent specialized in the InquirySpark .NET 10 codebase. Enforce architectural patterns (response wrappers, primary constructors, dependency injection), follow strict naming conventions, use Bootstrap 5 utility classes exclusively, ensure DataTables integration, maintain CDN-free builds, and organize all documentation in `/docs/copilot/session-{date}/` folders. Always check for existing views, wrap EF Core with DbContextHelper, and add XML documentation to public APIs.

Marketplace