framework/framework library

Classes

Air
The main 'Air' state manager singleton.
AirAction
A wrapper for Air actions to carry data and callbacks
AirAnalytics
Analytics manager for Air Framework
AirAnalyticsAdapter
Analytics integration for Air Framework MEJORA-011: Export a Analytics
AirAudit
Centralized audit logging for security-sensitive operations
AirBuilder<T>
A reactive widget that builds based on an AirController.
AirBuilder2<T1, T2>
A reactive widget that builds based on two AirControllers
AirBuilder3<T1, T2, T3>
A reactive widget that builds based on three AirControllers
AirController<T>
A reactive state container for 'Air' A reactive state container for the Air Framework.
AirDelegate
Delegate interface for Air State to interact with the outer framework This allows decoupling from specific EventBus or Logger implementations.
AirDI
A centralized Service Locator for the Air Framework.
AirGraphTab
AirHotReload
Hot Module Reload (HMR) support for development.
AirLogEntry
A single log entry
AirLogger
Centralized logging system for the Air framework Only logs in debug mode to prevent information exposure in production
AirPulse<T>
A strictly named and typed signal
AirRoute
A wrapper for declaring routes in Air Framework
AirRouter
AirState
Base class for controllers that handle business logic reactively
AirStateKey<T>
Base class for typed state keys.
AirStatePersistence
State persistence manager for Air Framework
AirTestHarness
Testing utilities for Air Framework modules.
AirView
A reactive widget that automatically rebuilds when accessed states change.
AirWatcher
Interface for any widget/entity that wants to automatically track dependencies
Allow
Allows the navigation to proceed.
AuditEntry
A single audit entry
BatchingAnalyticsAdapter
Batching analytics adapter that collects events before sending
Block
Blocks the navigation from proceeding.
BoolSchema
Schema for boolean values
CLIResult
Result of a CLI command
Computed
Annotation to mark a computed state
ComputedState<T>
A computed state that derives from other states
ComputedStateManager
Manager for reactive computed states
ConsoleAnalyticsAdapter
Console-based analytics adapter for development
CustomParameterCodec
annotation to define a custom parameter decoder/encoder this is useful when the is encoded/decoded in a non-standard way like base64Url this must be used as an annotation on a field
CustomTransitionPage<T>
Page with custom transition functionality.
DataChangedEvent
Fired when data changes in a module
DebugOverlay
Overlay wrapper that adds debug inspector to any screen
DefaultAirDelegate
A default no-op / simple delegate for standalone usage or testing
DependencyResolutionResult
Result of dependency resolution
DependencyResolver
Resolves module dependencies and determines load order
DevToolsCLI
CLI interface for DevTools MEJORA-015: CLI Interactivo
DITab
EventBus
EventSchema<T>
Schema validation for events MEJORA-014: Validación de Schemas
EventSchemaValidator
Validator that registers and validates event schemas
EventSubscription
Event subscription that can be cancelled or automatically expire.
FederatedModuleConfig
Federated module loading for Air Framework MEJORA-013: Módulos Federados
FederatedModuleLoader
Loader for federated modules
GeneratedAirState
Base class for generated state classes INNOV-010: Code Generation Support
GeneratedAppModule
Base class for generated module classes
GeneratedEvent
Base class for generated events
GeneratedFlowsRegistry
Registry for generated flows (state keys)
GeneratedPulsesRegistry
Registry for generated pulses
GenerateEvent
Annotation to mark a class as an Air event
GenerateModule
Annotation to mark a class as an Air module
GenerateState
Annotation to mark a class as an Air state
GoRoute Get started Configuration Redirection Transition animations Named routes
A route that is displayed visually above the matching parent route using the Navigator.
GoRouteData Type-safe routes
A class to represent a GoRoute in Type-safe routing.
GoRouteInformationParser
Converts between incoming URLs and a RouteMatchList using RouteMatcher.
GoRouteInformationProvider
The RouteInformationProvider created by go_router.
GoRouter Get started Upgrading Configuration Navigation Redirection Web Deep linking Named routes Error handling State restoration
The route configuration for the app.
GoRouterDelegate
GoRouter implementation of RouterDelegate.
GoRouterState
The route state during routing.
ImperativeRouteMatch
The route match that represent route pushed through GoRouter.push.
InheritedGoRouter
GoRouter implementation of InheritedWidget.
Inject
Annotation to inject a dependency
InMemoryPersistenceStorage
In-memory storage for testing
ListSchema<T>
Schema for list values
LogEntry
A single log entry
LogsTab
MapSchema
Schema for map/object values
ModuleContext
Context provided to modules during lifecycle. Provides convenient access to framework services with automatic module ID tracking.
ModuleDebugInspector
Debug inspector widget for development Shows real-time module and framework state
ModuleDependency
Dependency with version requirement
ModuleEvent
Base class for all module events
ModuleInstalledEvent
Fired when a module is installed
ModuleInteraction
Represents an interaction between two modules
ModuleLogger
Centralized logger for modules
ModulePermissions
Annotation to declare module permissions
ModulesTab
ModuleUninstalledEvent
Fired when a module is uninstalled
NoTransitionPage<T>
Custom transition page with no transition.
NumberSchema
Schema for numeric values
OnEnterResult
The result of an onEnter callback.
PerformanceMonitor
Performance monitor widget for development
PerformanceTab
PermissionChecker
Permission checker for the framework
PersistenceStorage
Abstract storage adapter for state persistence
Pulse
Annotation to mark a method as a pulse (signal/action)
PulsesTab
RateLimitConfig
Configuration for event rate limiting to prevent system flooding.
RelativeGoRouteData Type-safe routes
A class to represent a relative GoRoute in Type-safe routing.
Route
Annotation to mark a method as a route
RouteBase
The base class for GoRoute and ShellRoute.
RouteBuilder
Builds the top-level Navigator for GoRouter.
RouteConfiguration
The route configuration for GoRouter configured by the app.
RouteData
Baseclass for supporting Type-safe routing.
RouteInformationState<T>
The data class to be stored in RouteInformation.state to be used by GoRouteInformationParser.
RouteMatch
An matched result by matching a GoRoute against a location.
RouteMatchBase
The base class for various route matches.
RouteMatchList
The list of RouteMatchBase objects.
RoutingConfig Configuration
A set of parameters that defines routing in GoRouter.
ScopedPermission
A scoped permission with optional pattern matching
SecureData<T>
Wrapper for secure data storage with encryption and expiration support.
SecureServiceDescriptor
Descriptor for a service that can be registered
SecureServiceRegistry
A secure service registry for modules with audit logging
SemanticVersion
Semantic version representation and comparison
ServiceCalledEvent
Fired when a service is called
ShellRoute Configuration
A route that displays a UI shell around the matching child route.
ShellRouteBase
Base class for classes that act as shells for sub-routes, such as ShellRoute and StatefulShellRoute.
ShellRouteContext
Context object used when building the shell and Navigator for a shell route.
ShellRouteData
A class to represent a ShellRoute in Type-safe routing.
ShellRouteMatch
An matched result by matching a ShellRoute against a location.
SignalHistoryEntry
Recorded signal for history
SimpleStateKey<T>
A simple implementation of AirStateKey for quick usage.
StateFlow
Annotation to mark a field as a flow (reactive state)
StatefulNavigationShell
Widget for managing the state of a StatefulShellRoute.
StatefulNavigationShellState
State for StatefulNavigationShell.
StatefulShellBranch
Representation of a separate branch in a stateful navigation tree, used to configure StatefulShellRoute.
StatefulShellBranchData
Base class for supporting StatefulShellRoute
StatefulShellRoute Configuration
A route that displays a UI shell with separate Navigators for its sub-routes.
StatefulShellRouteData
Base class for supporting StatefulShellRoute
StateMatcher
Matcher for checking state values
StatePersistenceConfig
Configuration for state persistence
StateTab
StringSchema
Schema for string values
TypedGoRoute<T extends GoRouteData>
A superclass for each typed go route descendant
TypedQueryParameter
Annotation to override the URI name for a route parameter.
TypedRelativeGoRoute<T extends RelativeGoRouteData>
A superclass for each typed relative go route descendant
TypedRoute<T extends RouteData>
A superclass for each typed route descendant
TypedShellRoute<T extends ShellRouteData>
A superclass for each typed shell route descendant
TypedStatefulShellBranch<T extends StatefulShellBranchData>
A superclass for each typed shell route descendant
TypedStatefulShellRoute<T extends StatefulShellRouteData>
A superclass for each typed shell route descendant
ValidationResult
Result of schema validation

Enums

AirLogLevel
Log levels for the Air framework
AuditSeverity
Audit severity levels
AuditType
Types of audit events
InteractionType
Type of interaction between modules
LogLevel
Log level enum
The type of the navigation.
Permission
Permission types for module access control.

Mixins

GeneratedInjection
Mixin for automatic dependency injection
HotReloadable
Mixin to add HMR support to modules
ModuleLogging
Mixin for modules to easily access logging

Extensions

AirDIControllerExtension on AirState
AirStateKeyBuilder on AirStateKey<T>
Extension for building widgets or accessing values directly from an AirStateKey.
AirStateKeyBuilder2 on (AirStateKey<T1>, AirStateKey<T2>)
Extension for building widgets from a pair of AirStateKeys.
AirStateKeyBuilder3 on (AirStateKey<T1>, AirStateKey<T2>, AirStateKey<T3>)
Extension for building widgets from a triplet of AirStateKeys.
AirTestHarnessMatchers on AirTestHarness
Extension for easier state assertions
ComputedAirState on Air
Extension to Air for computed state support
GoRouterHelper on BuildContext
Dart extension to add navigation function to a BuildContext object, e.g. context.go('/');
OffsetExt on Offset
TypedAirState on Air
Extension to Air singleton for typed state access.
TypedAirStateBase on AirState
Extension to AirState base class for typed key support.

Functions

configureAirState() → void
Configure the Air State framework with the default secure delegate. This should be called at the start of the application.
createComputed<T>({required List<String> deps, required T compute(Map<String, dynamic> states), String? name}) → ComputedState<T>
Shorthand for creating computed states
testModule<M>({required M module, Map<String, dynamic> initialState = const {}, required Future<void> test(M module, AirTestHarness harness)}) → Future<void>
Test a module in isolation
testState<S extends AirState>({required S createState(), Map<String, dynamic> initialState = const {}, required Future<void> test(S state, AirTestHarness harness)}) → Future<void>
Test an AirState in isolation

Typedefs

EventMiddleware = void Function(dynamic event, void next(dynamic))
A typed event bus for inter-module communication.
ExitCallback = FutureOr<bool> Function(BuildContext context, GoRouterState state)
Signature for function used in RouteBase.onExit.
GoExceptionHandler = void Function(BuildContext context, GoRouterState state, GoRouter router)
The function signature of GoRouter.onException.
GoRouterBuilderWithNav = Widget Function(BuildContext context, Widget child)
Signature of a go router builder function with navigator.
GoRouterPageBuilder = Page Function(BuildContext context, GoRouterState state)
The page builder for GoRoute.
GoRouterRedirect = FutureOr<String?> Function(BuildContext context, GoRouterState state)
The signature of the redirect callback.
GoRouterWidgetBuilder = Widget Function(BuildContext context, GoRouterState state)
The widget builder for GoRoute.
The function signature for navigation callbacks in _OnEnterHandler.
Signature for functions used to build Navigators
OnEnter = FutureOr<OnEnterResult> Function(BuildContext context, GoRouterState currentState, GoRouterState nextState, GoRouter goRouter)
The signature for the top-level onEnter callback.
OnEnterThenCallback = FutureOr<void> Function()
Signature for callbacks invoked after an OnEnterResult is resolved.
ParserExceptionHandler = RouteMatchList Function(BuildContext context, RouteMatchList routeMatchList)
The function signature of GoRouteInformationParser.onParserException.
PopPageWithRouteMatchCallback = bool Function(Route route, dynamic result, RouteMatchBase match)
Signature for a function that takes in a route to be popped with the result and returns a boolean decision on whether the pop is successful.
RouteInfoState = RouteInformationState
Type alias for route information state with dynamic type parameter.
RouteMatchVisitor = bool Function(RouteMatchBase)
The function signature for RouteMatchList.visitRouteMatches
ShellNavigationContainerBuilder = Widget Function(BuildContext context, StatefulNavigationShell navigationShell, List<Widget> children)
Builder for a custom container for the branch Navigators of a StatefulShellRoute.
ShellRouteBuilder = Widget Function(BuildContext context, GoRouterState state, Widget child)
The widget builder for ShellRoute.
ShellRoutePageBuilder = Page Function(BuildContext context, GoRouterState state, Widget child)
The page builder for ShellRoute.
SignalMiddleware = void Function(String signalName, dynamic data, void next(String, dynamic))
Middleware for signal interception.
StatefulShellRouteBuilder = Widget Function(BuildContext context, GoRouterState state, StatefulNavigationShell navigationShell)
The widget builder for StatefulShellRoute.
StatefulShellRoutePageBuilder = Page Function(BuildContext context, GoRouterState state, StatefulNavigationShell navigationShell)
The page builder for StatefulShellRoute.

Exceptions / Errors

DependencyAlreadyRegisteredException
Exception thrown when attempting to register a dependency type that is already registered.
DependencyNotFoundException
Exception thrown when a dependency type is requested but not found in the AirDI container.
GoError
Thrown when GoRouter is used incorrectly.
GoException
Thrown when GoRouter can not handle a user request.
PermissionDeniedException
Exception thrown when permission is denied