ai-flow-dev 2.1.3 → 2.1.5

package/templates/backend/docs/code-standards.template.md

@@ -1,9 +1,7 @@
 # Code Standards
 
 > Coding conventions, quality rules, and best practices for {{PROJECT_NAME}}
-
 ---
-
 ## 🎨 Code Style
 
 ### Formatting
@@ -30,9 +28,7 @@
 # Format code
 {{FORMAT_COMMAND}}
 ```
-
 ---
-
 ## 📝 Naming Conventions
 
 ### Files
@@ -115,9 +111,7 @@ const hasPermission = false;
 const canEdit = checkPermissions();
 const shouldRefresh = false;
 ```
-
 ---
-
 ## 🏗️ Code Organization
 
 ### File Structure
@@ -201,9 +195,7 @@ import { validateEmail } from '@/utils/validation';
 ```
 
 {{/IF}}
-
 ---
-
 ## {{#IF TYPESCRIPT}}📘 TypeScript Rules{{ELSE}}📘 Type System{{/IF}}
 
 {{#IF TYPESCRIPT}}
@@ -267,9 +259,7 @@ class Repository<T> {
 ```
 
 {{/IF}}
-
 ---
-
 ## 🚨 Error Handling
 
 ### Strategy
@@ -299,9 +289,7 @@ class Repository<T> {
 ```{{LANGUAGE}}
 {{ERROR_LOGGING_EXAMPLE}}
 ```
-
 ---
-
 ## 📝 Logging Standards
 
 ### Log Levels
@@ -395,9 +383,7 @@ class Repository<T> {
 # Find by request ID
 {{LOG_REQUEST_ID_QUERY}}
 ```
-
 ---
-
 ## 📝 Comments and Documentation
 
 ### When to Comment
@@ -496,9 +482,7 @@ for (const user of users) {
 // FIXME(username): Description of bug that needs fixing
 // HACK(username): Explanation of why this hack exists
 ```
-
 ---
-
 ## 🧪 Code Quality Metrics
 
 ### Function Complexity
@@ -522,9 +506,7 @@ for (const user of users) {
 **Maximum File Length:** {{MAX_FILE_LENGTH}} lines
 
 **When to split:** If file exceeds limit or has multiple responsibilities
-
 ---
-
 ## ✅ Code Quality Rules
 
 ### Functions
@@ -563,9 +545,7 @@ for (const user of users) {
 - ✅ Avoid premature optimization
 - ✅ Readable over clever
 - ❌ Don't over-engineer
-
 ---
-
 ## 🔒 Security Coding Standards
 
 ### Input Validation
@@ -591,9 +571,7 @@ for (const user of users) {
 ```{{LANGUAGE}}
 {{SECRETS_EXAMPLE}}
 ```
-
 ---
-
 ## 🧹 Code Smell Detection
 
 ### Common Code Smells
@@ -607,9 +585,7 @@ for (const user of users) {
 | Dead Code | Unused code | Delete it |
 | Magic Numbers | Unexplained constants | Use named constants |
 | Nested Conditionals | Deep if/else nesting | Use early returns, guard clauses |
-
 ---
-
 ## 📦 Dependency Management
 
 ### Rules
@@ -631,9 +607,7 @@ for (const user of users) {
 ```bash
 {{SECURITY_AUDIT_COMMAND}}
 ```
-
 ---
-
 ## 🔧 Linting
 
 **Tool:** {{LINTER}}
@@ -655,9 +629,7 @@ for (const user of users) {
 {{#EACH LINT_RULE}}
 - **{{RULE_NAME}}**: {{RULE_DESCRIPTION}}
 {{/EACH}}
-
 ---
-
 ## ✍️ Git Commit Standards
 
 ### Commit Message Format
@@ -713,9 +685,7 @@ Closes #123
 - ✅ One logical change per commit
 - ❌ Don't mix refactoring with feature changes
 - ❌ Don't commit broken code
-
 ---
-
 ## 📋 Code Review Checklist
 
 ### Before Requesting Review
@@ -738,9 +708,7 @@ Closes #123
 - [ ] No security vulnerabilities
 - [ ] Performance is acceptable
 - [ ] Follows architecture patterns
-
 ---
-
 ## 🎯 Code Examples
 
 ### Controller Example
@@ -772,9 +740,7 @@ Closes #123
 ```{{LANGUAGE}}
 {{TEST_EXAMPLE}}
 ```
-
 ---
-
 ## 🚀 Performance Guidelines
 
 ### Database
@@ -802,9 +768,7 @@ Closes #123
 - ✅ Stream large files
 - ❌ Don't load entire files into memory
 - ❌ Don't create memory leaks
-
 ---
-
 ## 📚 Resources
 
 ### Official Docs
@@ -818,11 +782,11 @@ Closes #123
 {{#EACH STYLE_GUIDE}}
 - [{{GUIDE_NAME}}]({{GUIDE_URL}})
 {{/EACH}}
-
 ---
-
 **Document Version:** 1.0
 
 **Last Updated:** {{GENERATION_DATE}}
 
 **Generated by:** AI Flow v1.0.0
+
+

package/templates/backend/docs/contributing.template.md

@@ -1,9 +1,7 @@
 # Contributing Guide
 
 > How to contribute to {{PROJECT_NAME}}
-
 ---
-
 ## 🚀 Getting Started
 
 ### Prerequisites
@@ -35,9 +33,7 @@ cp .env.example .env
 # Start development server
 {{DEV_COMMAND}}
 ```
-
 ---
-
 ## 🔄 Development Workflow
 
 1. Create feature branch from `main`
@@ -48,9 +44,7 @@ cp .env.example .env
 6. Push and create pull request
 7. Address review comments
 8. Merge after approval
-
 ---
-
 ## 🌿 Branch Strategy
 
 **Main Branches:**
@@ -71,9 +65,7 @@ feature/add-user-authentication
 bugfix/fix-login-redirect
 hotfix/patch-security-vulnerability
 ```
-
 ---
-
 ## ✅ Before Committing
 
 ```bash
@@ -86,9 +78,7 @@ hotfix/patch-security-vulnerability
 # Check coverage
 {{COVERAGE_COMMAND}}
 ```
-
 ---
-
 ## 📝 Commit Standards
 
 **Format:** {{COMMIT_FORMAT}}
@@ -107,9 +97,7 @@ Closes #123
 ```
 
 {{/IF}}
-
 ---
-
 ## 🔍 Code Review
 
 ### Review Checklist
@@ -120,9 +108,7 @@ Closes #123
 - [ ] No console.logs
 - [ ] No security vulnerabilities
 - [ ] Performance acceptable
-
 ---
-
 ## 📚 Documentation
 
 {{#EACH DOC_LOCATION}}
@@ -156,8 +142,8 @@ The command will:
 4. Automatically update affected documents
 
 **For more information:** See the AI Flow README for detailed usage instructions.
-
 ---
-
 **Last Updated:** {{GENERATION_DATE}}
 
+
+

package/templates/backend/docs/data-model.template.md

@@ -14,9 +14,7 @@
 
 **Data Access Layer:** {{DATA_ACCESS_LAYER}}
 
-**Data Ownership:** {{DATA_OWNERSHIP}}
-
----
+## **Data Ownership:** {{DATA_OWNERSHIP}}
 
 ## 📊 Entity Catalog
 
@@ -114,8 +112,9 @@
 {{/EACH}}
 
 {{ELSE}}
+
 - No indexes explicitly defined yet. Indexes will be created based on query patterns and foreign keys.
-{{/IF}}
+  {{/IF}}
 
 ### Index Guidelines
 
@@ -136,12 +135,14 @@
 
 **Supported Levels:**
 {{#EACH ISOLATION_LEVEL}}
+
 - **{{LEVEL_NAME}}**: {{LEVEL_DESCRIPTION}}
-{{/EACH}}
+  {{/EACH}}
 
 ### Transaction Strategy
 
 **When to use transactions:**
+
 - ✅ Multi-step operations that must succeed or fail together
 - ✅ Updates affecting multiple tables
 - ✅ Operations requiring consistency guarantees
@@ -151,11 +152,13 @@
 
 {{#IF TRANSACTION_PATTERNS}}
 {{#EACH TRANSACTION_PATTERN}}
+
 #### {{PATTERN_NAME}}
 
 **Use Case:** {{PATTERN_USE_CASE}}
 
 **Implementation:**
+
 ```{{LANGUAGE}}
 {{PATTERN_EXAMPLE}}
 ```
@@ -164,8 +167,33 @@
 
 {{/EACH}}
 {{ELSE}}
+
 - Transaction patterns to be defined based on business requirements.
-{{/IF}}
+  {{/IF}}
+
+### Transaction Boundaries (Atomic Operations)
+
+{{#IF TRANSACTION_BOUNDARIES}}
+{{#EACH TRANSACTION_BOUNDARY}}
+
+#### {{OPERATION_NAME}}
+
+**Description:** {{DESCRIPTION}}
+
+**Steps (all or nothing):**
+{{#EACH STEP}}
+{{STEP_NUMBER}}. {{STEP_DESCRIPTION}} {{#IF IN_TRANSACTION}}✅ In transaction{{ELSE}}⚡ Outside (async){{/IF}}
+{{/EACH}}
+
+**Rollback Trigger:** {{ROLLBACK_TRIGGER}}
+
+**Compensating Actions:** {{COMPENSATING_ACTIONS}}
+
+{{/EACH}}
+{{ELSE}}
+
+- No explicit transaction boundaries defined. Individual operations are atomic by default.
+  {{/IF}}
 
 ### Consistency Model
 
@@ -173,17 +201,19 @@
 
 {{#IF EVENTUAL_CONSISTENCY}}
 **Eventual Consistency:**
+
 - Acceptable delay: {{CONSISTENCY_DELAY}}
 - Replication lag tolerance: {{REPLICATION_LAG}}
 - Conflict resolution: {{CONFLICT_RESOLUTION}}
-{{/IF}}
+  {{/IF}}
 
 {{#IF STRONG_CONSISTENCY}}
 **Strong Consistency:**
+
 - All reads see latest writes
 - Synchronous replication required
 - Higher latency, lower throughput
-{{/IF}}
+  {{/IF}}
 
 ---
 
@@ -195,26 +225,29 @@
 
 {{#IF PRISMA_MIGRATE}}
 **Prisma Migrate:**
+
 - Location: `prisma/migrations/`
 - Generate migration: `npx prisma migrate dev --name migration_name`
 - Apply migration: `npx prisma migrate deploy`
-{{/IF}}
+  {{/IF}}
 
 {{#IF TYPEORM_MIGRATIONS}}
 **TypeORM Migrations:**
+
 - Location: `src/migrations/`
 - Generate migration: `npm run migration:generate -- -n MigrationName`
 - Run migration: `npm run migration:run`
 - Revert migration: `npm run migration:revert`
-{{/IF}}
+  {{/IF}}
 
 {{#IF ALEMBIC}}
 **Alembic (Python):**
+
 - Location: `alembic/versions/`
 - Generate migration: `alembic revision --autogenerate -m "migration_name"`
 - Apply migration: `alembic upgrade head`
 - Rollback: `alembic downgrade -1`
-{{/IF}}
+  {{/IF}}
 
 ### Migration Strategy
 
@@ -250,8 +283,9 @@
 | {{VERSION}} | {{DESCRIPTION}} | {{APPLIED_DATE}} | {{#IF ROLLBACK_AVAILABLE}}Yes{{ELSE}}No{{/IF}} |
 {{/EACH}}
 {{ELSE}}
+
 - Migration history will be tracked by the migration tool.
-{{/IF}}
+  {{/IF}}
 
 ---
 
@@ -288,7 +322,81 @@
 
 ---
 
-## 📦 Serialization Contracts
+## �️ Soft Delete & Data Lifecycle
+
+### Deletion Strategy
+
+**Soft Delete Field:** `{{SOFT_DELETE_FIELD}}` ({{SOFT_DELETE_TYPE}})
+
+**Default Query Behavior:** {{SOFT_DELETE_QUERY_DEFAULT}}
+
+### Entity Deletion Rules
+
+| Entity | Delete Type | Field | Cleanup Policy |
+| ------ | ----------- | ----- | -------------- |
+
+{{#EACH ENTITY_DELETE_RULE}}
+| {{ENTITY}} | {{DELETE_TYPE}} | {{FIELD}} | {{CLEANUP_POLICY}} |
+{{/EACH}}
+
+### Permanent Cleanup Schedule
+
+**Policy:** {{CLEANUP_POLICY}}
+**Schedule:** {{CLEANUP_SCHEDULE}}
+**Retention Period:** {{RETENTION_DAYS}} days
+
+### Cascade Delete Behavior
+
+{{#EACH CASCADE_DELETE}}
+
+- **{{PARENT_ENTITY}}** → **{{CHILD_ENTITY}}**: {{BEHAVIOR}}
+  {{/EACH}}
+
+---
+
+## 🔄 State Machines
+
+{{#IF STATE_MACHINES}}
+{{#EACH STATE_MACHINE}}
+
+### {{ENTITY_NAME}} State Machine
+
+**States:** {{STATES}}
+
+**Initial State:** {{INITIAL_STATE}}
+
+**Terminal States:** {{TERMINAL_STATES}}
+
+```mermaid
+stateDiagram-v2
+    {{STATE_DIAGRAM}}
+```
+
+#### Valid Transitions
+
+| From | To  | Action | Guards | Side Effects |
+| ---- | --- | ------ | ------ | ------------ |
+
+{{#EACH TRANSITION}}
+| {{FROM}} | {{TO}} | {{ACTION}} | {{GUARDS}} | {{SIDE_EFFECTS}} |
+{{/EACH}}
+
+#### Invalid Transitions (Explicitly Forbidden)
+
+{{#EACH INVALID_TRANSITION}}
+
+- `{{FROM}}` → `{{TO}}`: {{REASON}}
+  {{/EACH}}
+
+{{/EACH}}
+{{ELSE}}
+
+- No state machines defined. Entities use simple status fields without formal transition rules.
+  {{/IF}}
+
+---
+
+## �📦 Serialization Contracts
 
 ### API Representations
 
@@ -312,9 +420,7 @@
 {{RESPONSE_SCHEMA}}
 ```
 
-**Notes:** {{NOTES}}
-
----
+## **Notes:** {{NOTES}}
 
 {{/EACH}}
 
@@ -328,8 +434,8 @@
   - Consumers: {{CONSUMERS}}
   - Schema:
     `json
-    {{SCHEMA}}
-    `
+{{SCHEMA}}
+`
     {{/EACH}}
     {{ELSE}}
 - No asynchronous payloads defined.
@@ -362,9 +468,7 @@
 
 **Retention Policy:** {{RETENTION_POLICY}}
 
-**Compliance Scope:** {{COMPLIANCE_SCOPE}}
-
----
+## **Compliance Scope:** {{COMPLIANCE_SCOPE}}
 
 ## 🧪 Testing & Quality Gates