blueprint_flutter_core 2.2.0

A modular Flutter core package providing UI components, theming, and feature modules for scalable apps.

Changelog

All notable changes to this project are documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

2.2.0

Added

Auth

• Implemented forgot password functionality with new state management and UI templates.
• Enhanced authentication flow with new step templates.

Widgets & Forms

• Introduced FxPhoneInputTheme and FxFormControl classes.
• Added new input field components and enhanced existing widgets with new options and themes.

Networking & Core

• Introduced FxError and FxResult classes for improved error handling and response management.

Changed

Auth

• Refactored authentication flow existing steps for improved structure.
• Updated EmailStepScreen layout to use body parameter.
• Updated phone input formatting logic and consolidated auth module exports.

Widgets & UI

• Refactored input field components for improved usability and theme management.
• Updated icon path handling across multiple categories for consistency and maintainability.

Networking

• Enhanced FxAuthInterceptor to normalize public endpoint paths and improve token handling.

2.1.0

Added

Widgets

• FxCounterBadge and FxCounterText widgets.
• FxEmptyState widget for handling empty data UI states.
• FxRefreshView layout widget to implement pull-to-refresh functionality easily.
• FxNotificationIconButton and FxNotificationPageView widgets in the notifications module.

Auth

• Added new styling models for Phone Auth: FxPhoneEntryStyle, FxOtpEntryStyle, FxRegisterEntryStyle.

Changed

• Restructured FxPhoneAuth steps into internal components (_phone_entry.dart, _otp_entry.dart, _register_entry.dart).
• Removed FxPhoneAuthTheme in favor of individual component styles.

Refactoring (Breaking)

Notifications

• Renamed notification module files and classes to use Fx prefix:
  • NotificationController → FxNotificationController
  • NotificationState → FxNotificationState
  • NotificationService → FxNotificationService
  • AppNotification → FxNotification
  • DeviceRegistration → FxDeviceRegistration

2.0.0

Breaking

Networking

• Rename public networking types to the Fx prefix:
  • ApiClient → FxApiClient
  • TokenManager → FxTokenManager
  • AppService → FxService
  • ServiceContext → FxServiceContext
  • AuthInterceptor → FxAuthInterceptor
  • LogInterceptor → FxLogInterceptor
  • FirebaseClient → FxFirebaseClient
• Rename api_endpoints.dart → fx_api_endpoints.dart (update deep imports if used)
• Riverpod: dioProvider → fxDioProvider, serviceContextProvider → fxServiceProvider
• FxControllerMixin.serviceContext returns FxServiceContext from fxServiceProvider
• Update blueprint_flutter_core.dart and blueprint_network.dart imports/exports
• Stop exporting ErrorInterceptor, ErrorMapper, RefreshCoordinator, and PendingRequestHandler (private part files of FxAuthInterceptor)
• Remove ErrorInterceptor (401 refresh + error mapping live in FxAuthInterceptor)

Theme

• Rename theme source files: base_colors.dart, base_sizes.dart, base_theme.dart, base_theme_data.dart, base_typography.dart → fx_colors.dart, fx_sizes.dart, fx_theme.dart, fx_theme_data.dart, fx_typography.dart
• Update blueprint_theme.dart export paths (type names such as FxColors are unchanged)

Routing

• AuthGuard → FxAuthGuard (blueprint_flutter_core.dart export path updated)
• Default publicPaths now includes '/' in addition to splash and login

Controllers

• Remove FxState helper base class from fx_controller_mixin.dart (was a part file)

Widgets

• FxTextDivider: remove isDotted; add align; dashWidth, dashSpace, and strokeWidth are required doubles with new defaults; divider rendering logic updated

Added

App shell (exported from blueprint_widgets.dart)

• FxShell, FxShellScope, FxShellStyle — post-login scaffold with pane body switching
• FxPane, FxSite, FxPaneState, FxPaneType, FxPaneDividerStyle, FxShellAnimation
• FxDock, FxDockStyle — bottom navigation dock
• FxDrawer, FxDrawerStyle — side drawers
• FxShellCtrl and fxShellCtrlProvider — pane registry and navigation (goToPane, panesFor, syncFromWidget)

Widgets

• FxReveal, FxRevealPreferred, FxRevealTransitions — animated show/hide for chrome (e.g. app bar)
• FxTile, FxTileView — tile list / navigation helpers
• FxAppBarStyle and FxAppBar.fromStyle
• FxScaffold: FxSafeAreaInsets, full Scaffold parity (drawers, bottom sheet, FAB location, extendBody, restoration, etc.), optional systemUiOverlayStyle; padding: EdgeInsets.zero skips padding; safeArea: null disables SafeArea
• FxUiToolkit.shellScope on FxShellScope

Networking

• FxHeadersInterceptor — X-Request-Id, X-Correlation-Id, X-Client-Trace-Id, Accept-Language, User-Agent, X-API-Version, X-Environment; optional X-Tenant-Id / X-Org-Id from FxConfig; optional Idempotency-Key via Options.extra[FxRequestExtras.idempotencyKey]
• FxService, FxServiceContext
• FxConfig: apiUserAgent, clientVersion, tenantId, orgId

Auth

• AuthUser.roles (List<String>, default [])
• JwtHelper.roles(String token)

Utilities

• TextFormatter.maskPhoneNumber for masked phone display

Dependencies

• easy_copy_with_annotation (runtime)
• easy_copy_with (dev) — used for shell style copyWith codegen

Changed

• FxApiClient interceptor order: FxHeadersInterceptor → FxLogInterceptor → FxAuthInterceptor
• Auth refresh and error mapping consolidated in FxAuthInterceptor
• AuthController, auth/email/phone auth, notification, and profile services use Fx* networking types
• FxCore and NotificationController use FxFirebaseClient
• FxScrollableForm and FxPhoneAuthTheme layout/theming adjustments
• Example app updated for FxAuthGuard and related APIs

Removed

• ErrorInterceptor
• app_service.dart, service_context.dart (replaced by fx_service.dart, fx_service_context.dart)
• fx_state.dart (FxState base class)
• Theme base_*.dart files (replaced by fx_*.dart)

Migration

Providers and services

ref.read(fxDioProvider);
ref.read(fxServiceProvider);

class MyService extends FxService {
  MyService(super.ctx);
}

Auth redirect

redirect: (context, state) => FxAuthGuard.redirect(
  authState: ref.read(authControllerProvider),
  location: state.uri.toString(),
  loginPath: '/login',
  homePath: '/home',
);

Idempotency (mutating requests)

dio.post('/path', data: body, options: Options(
  extra: {FxRequestExtras.idempotencyKey: 'stable-key'},
));

Theme imports

// Before
import 'package:blueprint_flutter_core/src/core/theme/base_colors.dart';

// After
import 'package:blueprint_flutter_core/blueprint_theme.dart';
// or
import 'package:blueprint_flutter_core/src/core/theme/fx_colors.dart';

1.0.2

• Add flutter_libphonenumber dependency
• Enhance phone input handling