fast_common_module library
The main library file for FastCommonModule.
Classes
- BaseAuthService
- Abstract base class for authentication services.
- BaseCacheService
- Base interface for cache services
- BaseMiddleware
- Base middleware interface for intercepting requests and responses
- BasePermissionService
- Abstract base class for permission services.
- BaseRateLimitService
- Base interface for rate limiting services
-
BaseRepository<
T extends FastModel> - Abstract base class for repositories.
- BaseRoleService
- Abstract base class for role services.
- ErrorHandlingMiddleware
- Error handling middleware for global error management
- FastApiClient
- FastApiClient is a generic, reusable API client for RESTful endpoints.
- FastAppInfo
- App information model representing the application's build details
- FastAuditLog
- FastAuditLog represents an audit log entry for user/system actions.
- FastAuditLogService
- Abstract service for audit logging of user and system actions.
- FastCacheConfig
- Cache configuration model for FastCacheService
-
FastCacheItem<
T> - Cache item model for storing cached data with metadata
- FastCacheService
- High-performance caching service with memory and disk storage layers
- FastCacheStatistics
- Cache statistics model for tracking cache performance and usage
- FastCircuitBreaker
- A robust, zero-dependency Circuit Breaker implementation for fault tolerance.
- FastCircuitBreakerConfig
- Configuration for the FastCircuitBreaker
- FastDeviceInfo
- Device information model representing hardware and OS details
- FastDeviceService
- Service to provide device and application information.
- FastDynamicPermission
- Represents a dynamic permission, which can be used for fine-grained UI or action-level authorization.
- FastEventBus
- A lightweight, zero-dependency Event Bus (Pub-Sub system).
- FastFileMeta
- Model representing file/media metadata.
- FastFileService
- Abstract service for file/media management (upload, download, delete, etc).
- FastFilter
- FastFilter is a generic filtering model for list queries.
- FastLanguage
- Model for language configuration with support for runtime management.
- FastLanguageDropdown
- Dropdown language selector.
- FastLanguagePopupMenu
- Popup menu language selector.
- FastLanguageSelector
- A widget for language selection with customizable UI.
- FastLocalization
- Advanced localization service with runtime language switching, dynamic translation loading, and user preference management.
- FastLocalizationBuilder
- Widget that rebuilds when language changes
- FastLocalizationController
- Controller for managing user language preferences with persistent storage.
- FastLocator
- A lightweight, dependency-free Service Locator (Dependency Injection) container.
- FastLogger
- A zero-dependency, advanced logging utility. Provides colored console output, log levels, and global callbacks for external crashlytics/monitoring tools.
- FastLogMessage
- Represents a single log entry created by FastLogger
- FastMiddlewareManager
- Middleware manager for handling middleware chain execution
- FastModel
- Abstract base model for data objects.
- FastNotification
- Model representing a notification/message in the system.
- FastNotificationService
- Abstract notification service for system/email/SMS notifications.
-
FastPage<
T> - FastPage is a generic pagination model for paged list responses.
- FastPermissionBuilder
- FastPermissionBuilder shows builder only if the user has the required permission(s).
- FastRateLimitConfig
- Rate limiting configuration model
- FastRateLimitEntry
- Rate limiting entry for tracking request counts and timestamps
- FastRateLimitResult
- Rate limiting check result
- FastRateLimitService
- High-performance rate limiting service with multiple algorithms
- FastRateLimitStatistics
- Rate limiting statistics model for monitoring and analysis
-
FastResponse<
T> - A generic response model for service and repository operations.
- FastRolePermissionService
- Abstract service for managing roles and their permissions with a data source (e.g., database).
- FastSession
- Model representing a user session/activity.
- FastSessionService
- Abstract service for user session/activity management.
- FastSetting
- Model representing a dynamic application setting/configuration.
- FastSettingsService
- Abstract service for dynamic application settings/config management.
- FastTenant
- FastTenant represents a tenant (organization/customer) in a multi-tenant system.
- FastTenantService
- Abstract service for managing tenants in a multi-tenant system.
- FastTokenService
- FastTokenService provides JWT/token management for authentication and authorization.
- FastTranslation
- Model for translation entry with key-value pairs and metadata.
- FastUser
- Model representing a user in FastCommonModule.
- FastUserMapper
- Mapper class for user-related transformations.
- FastUserPermissionService
- Service to aggregate all permissions (static and dynamic) for a user.
- FastUserRepository
- Abstract repository for managing FastUser data objects.
- FastUserService
- Abstract service for user-related business logic.
- FastValidator
- FastValidator provides static validation utilities for common form fields.
- Helpers
- Utility class for helper functions.
- LocalizationService
- Service for loading and accessing localized strings.
- LoggingMiddleware
- Logging middleware for request/response logging
- RetryMiddleware
- Retry middleware for automatic request retries
- RolePermissionMapper
- A utility class to manage roles and their permissions dynamically.
- TimeoutMiddleware
- Timeout middleware for request timeout handling
Enums
- FastCacheEvictionPolicy
- Cache eviction policies for when cache limits are reached
- FastCircuitBreakerState
- Represents the current state of the Circuit Breaker
- FastFileType
- Enum representing file/media types.
- FastLogLevel
- Defines the severity levels for FastLogger
- FastNotificationType
- Notification type for FastNotification.
- FastPermission
- Enum representing permissions for FastCommonModule roles.
- FastRateLimitAlgorithm
- Rate limiting algorithms
- FastRateLimitBlockReason
- Reasons for rate limiting blocks
- FastRole
- Enum representing roles in FastCommonModule.
Extensions
- FastLogLevelExtension on FastLogLevel
- LocalizationExtension on String
- Extension for easy access to localization in widgets
Functions
-
locate<
T> () → T - Global convenience function to access the FastLocator.
Exceptions / Errors
- FastCircuitBreakerException
- Exception thrown when a request is blocked because the circuit is open.
- FastException
- Custom exception for FastCommonModule operations.