🎉 Initial Release #

First stable release of riverpod_architecture - A modern Flutter state management architecture built on Riverpod 3.0.

✨ Features #

State Management

• BaseNotifier - Handles single-value state with initial/loading/error/data states
• PaginatedNotifier - Built-in pagination with infinite scroll support
• PaginatedStreamNotifier - Stream-based pagination for real-time data
• SimpleNotifier - Base-level notifier with utility methods

Notifier Variants

Each notifier type includes 4 variants:

• Base notifier
• AutoDispose variant (memory-efficient)
• Family variant (parameterized)
• AutoDisposeFamily variant (both features combined)

State Types

• BaseState - Sealed class with BaseInitial, BaseLoading, BaseError, BaseData
• PaginatedState - Sealed class with PaginatedLoading, PaginatedLoadingMore, PaginatedLoaded, PaginatedError
• Type-safe pattern matching with Dart 3

Error Handling

• Functional error handling with Either<Failure, T>
• EitherFailureOr<T> type alias for Future-based operations
• StreamFailureOr<T> type alias for Stream-based operations
• Failure entity with title, error details, and stack traces

Global Providers

• globalLoadingProvider - App-wide loading indicator
• globalFailureProvider - Global error notifications
• globalInfoProvider - Global info messages
• All global providers migrated to Riverpod 3.0 NotifierProvider

Data Layer Utilities

• EntityMapper<Entity, Response> - Map API responses to domain entities
• FormMapper<Request, Form> - Map forms to API requests
• RequestMapper<Request, Param> - Map parameters to API requests
• FormWithOptionMapper<Request, Form, Option> - Form mapping with options
• ErrorToFailureMixin - Automatic error to failure conversion

UI Components

• BaseWidget - Root widget for global providers (loading, failure, info)
• PaginatedListView - Ready-to-use widget for paginated lists
• Customizable loading indicators, error handlers, and refresh controls

Developer Experience

• Comprehensive documentation and examples
• Type-safe sealed classes with pattern matching
• Auto-disposal for memory efficiency
• Built-in throttling and debouncing
• Custom state handling callbacks

📚 Documentation #

• Complete README with installation and usage examples
• Full example project demonstrating all features:
  • BaseNotifier example (user detail screen)
  • PaginatedNotifier example (user list with pagination)
  • Mock repository with Either pattern
  • Pattern matching in UI
• Detailed API documentation
• Migration guide from other patterns

🛠️ Technical Details #

• Riverpod Version: 3.0.3
• Dart SDK: >=3.0.0 <4.0.0
• Dependencies:
  • flutter_riverpod: ^3.0.3
  • either_dart: ^1.0.0
  • equatable: ^2.0.7
  • meta: ^1.16.0

📦 Package Structure #

lib/
├── riverpod_architecture.dart    # Main export
├── base_notifier.dart            # BaseNotifier exports
├── paginated_notifier.dart       # Pagination exports
└── src/
    ├── domain/                   # Domain layer
    │   ├── notifiers/           # Notifier base classes
    │   ├── entities/            # Core entities
    │   ├── providers/           # Global providers
    │   └── mixins/              # Notifier mixins
    ├── data/                     # Data layer
    │   ├── mappers/             # Mapper interfaces
    │   └── mixins/              # Repository mixins
    └── presentation/             # Presentation layer
        └── widgets/             # Reusable widgets

🎯 Design Principles #

• Modern Riverpod 3.0 - Fully compatible with latest Riverpod
• Type Safety - Sealed classes and pattern matching
• Clean Architecture - Clear separation of concerns
• Memory Efficient - Auto-dispose variants by default
• Developer Friendly - Reduced boilerplate, clear patterns
• Production Ready - Comprehensive error handling and testing

📝 Important Notes #

• Override prepareForBuild() not build() - The build method is marked @nonVirtual
• Use pattern matching - States are sealed classes without .when() methods
• Use auto-dispose - Recommended for memory efficiency
• Global providers - Set up BaseWidget at app root for global notifications

🙏 Credits #

Based on Q-Architecture, fully migrated to Riverpod 3.0 with modern patterns and best practices.

---