Architecture

Documentation Index

Fetch the complete documentation index at: https://docs.snackbase.dev/llms.txt

Use this file to discover all available pages before exploring further.

​

Architecture Overview

​

Layer Structure

​

Key Architectural Patterns

1. Repository Pattern: 17 repositories abstract data access
2. Service Layer Pattern: 17 domain services contain business logic
3. Hook System: 33+ events across 8 categories for extensibility (stable API v1.0)
4. Rule Engine: Custom DSL for permission expressions
5. Multi-Tenancy: Row-level isolation via account_id
6. JWT Authentication: Access token (1h) + refresh token (7d)
7. Configuration System: Hierarchical provider configuration with encryption at rest
8. Email System: Multi-provider email with template rendering

​

Component Statistics

• 19 API Routers: auth, oauth, saml, accounts, collections, roles, permissions, users, groups, invitations, macros, dashboard, files, audit-logs, migrations, admin, email_templates, records, health
• 17 ORM Models: Account, User, Role, Permission, Collection, Macro, Group, Invitation, RefreshToken, UsersGroups, AuditLog, Configuration, OAuthState, EmailVerification, EmailTemplate, EmailLog
• 17 Repositories matching each model
• 17 Domain Entities + 17 Domain Services
• 10 React Pages + 40+ Components
• 14 ShadCN UI Components

​

Technology Stack

​

Major Systems

​

1. Configuration/Provider System

• System-level configs: Use account_id 00000000-0000-0000-0000-000000000000 for defaults
• Account-level configs: Per-account overrides that take precedence
• Encryption at rest: All sensitive values encrypted using Fernet symmetric encryption
• 5-minute TTL cache: ConfigRegistry caches resolved configurations

​

2. Email Verification System

• EmailVerificationTokenModel - Stores SHA-256 hashed tokens
• EmailVerificationRepository - Database operations
• EmailVerificationService - Business logic for verification workflow
• Token expiration: 24 hours
• Single-use tokens (marked as used after verification)

1. User registers → send_verification_email() generates token
2. Token stored as SHA-256 hash
3. Email sent with verification URL
4. User clicks link → verify_email() validates token
5. User record updated: email_verified=True, email_verified_at=now()

​

3. Email Template System

• EmailTemplateModel - ORM model with locale support
• EmailTemplateRepository - Template CRUD operations
• TemplateRenderer - Jinja2-based rendering
• EmailService - Orchestrates sending with provider selection

• email_verification - Email verification emails
• password_reset - Password reset emails
• invitation - User invitation emails

• Account-level templates override system defaults
• Multi-language support via locale field
• System variables injected: app_name, app_url, support_email
• Comprehensive logging via EmailLogModel

​

4. Hook System (Stable API v1.0)

• timestamp_hook (priority: -100) - Sets created_at/updated_at
• account_isolation_hook (priority: -200) - Enforces account_id on records
• created_by_hook (priority: -150) - Sets created_by/updated_by
• audit_capture_hook (priority: 100) - Captures audit trails for records
• SQLAlchemy Event Listeners - Systemic audit logging for models

​

5. Audit Logging System

• Configurable: Toggle via SNACKBASE_AUDIT_LOGGING_ENABLED (default: true)
• Column-level granularity: Each row represents a single column change
• Immutable: Database triggers prevent UPDATE/DELETE operations
• Blockchain integrity: checksum and previous_hash chain
• Electronic signature support: CFR Part 11 compliant (es_username, es_reason, es_timestamp)
• Systemic capture: SQLAlchemy event listeners automatically log all model changes
• Record capture: Hooks automatically log all dynamic collection record changes

1. SQLAlchemy event listener detects model change OR hook detects record change
2. AuditLogService creates audit entries for each changed column
3. AuditChecksum computes SHA-256 hash linking to previous entry
4. Entries written atomically with the operation
5. Database triggers enforce immutability

​

Data Flow Examples

​

Authentication Flow

LoginPage → auth.service.login()
  → POST /api/v1/auth/login
  → JWT Service creates tokens
  → UserRepository updates last_login
  → Return AuthResponse
  → Zustand Store stores tokens

​

Permission Check Flow

GET /api/v1/records/posts
  → Authorization Middleware
  → PermissionResolver.resolve_permission()
    → Rule Engine: parse_rule() → Lexer → Parser → AST
    → Evaluator.evaluate() with MacroExecutionEngine
    → PermissionCache (5-min TTL)
  → If allowed: RecordRepository.find_all()
  → PIIMaskingService masks sensitive fields
  → Return filtered response

​

Record Creation Flow

POST /api/v1/records/posts
  → Validate request fields
  → Permission check
  → RecordValidator.validate_and_apply_defaults()
  → Trigger ON_RECORD_BEFORE_CREATE hooks
    → account_isolation_hook (priority: -200)
    → created_by_hook (priority: -150)
    → timestamp_hook (priority: -100)
    → User hooks (priority: >=0)
  → RecordRepository.insert_record()
  → Trigger ON_RECORD_AFTER_CREATE hooks
    → audit_capture_hook (priority: 100)
  → Apply field filter + PII masking
  → Return RecordResponse

​

Email Sending Flow

EmailService.send_template_email()
  → EmailTemplateRepository.get_template()
    → Check account-level template
    → Fallback to system-level template
  → TemplateRenderer.render() with Jinja2
    → Merge system variables + user variables
  → ConfigurationRepository.list_configs()
    → Check account-level email provider
    → Fallback to system-level provider
  → Decrypt config with EncryptionService
  → Provider.send_email() (SMTP/SES/Resend)
  → EmailLogRepository.create() log entry
  → Commit transaction atomically

​

Key Files

​

Related Guides

• Hook System Reference
• Creating Custom Hooks
• Security Model
• Authentication Model