x_flutter_core_models 1.0.0

Flutter core models — failure types, server error hierarchy, and progress state for domain layers.

x_flutter_core_models

Flutter core models — failure types, server error hierarchy, and progress state for domain layers.

Features

• DataResponse — standard response contract for repositories and data sources.
• Failure — abstract root type for all domain failures.
• ApiFailure hierarchy — typed server failures covering no-network, unauthorized, too-many-requests, exceptions, and unknown states.
• CanceledRequestFailure — const-constructible failure for canceled in-flight requests.
• BaseProgressState / DefaultProgressState — sealed progress state for driving loading indicators without coupling UI to business logic.

Installation

dependencies:
  x_flutter_core_models: ^1.0.0

Usage

Response handling

import 'package:x_flutter_core_models/x_flutter_core_models.dart';

Future<DataResponse<User>> getUser(String id) async {
  try {
    final data = await api.fetchUser(id);
    return DataResponse.success(data);
  } on SocketException {
    return DataResponse.failure(ConnectionFailure());
  } on UnauthorizedException {
    return DataResponse.failure(ApiUnauthorizedFailure());
  } on ApiException catch (e) {
    return DataResponse.failure(ApiExceptionFailure(message: e.message));
  }
}

Failure types

The package provides a rich hierarchy of failure types that can be used with DataResponse.

Progress state

import 'package:x_flutter_core_models/x_flutter_core_models.dart';

// Extend BaseProgressState to carry custom data alongside show/hide signals.
class UploadProgressState extends BaseProgressState {
  final double percent;
  const UploadProgressState(this.percent);
}

// Use DefaultProgressState for simple boolean show/hide.
const loading = DefaultProgressState(showProgress: true);
const idle    = DefaultProgressState(showProgress: false);

API reference

Class	Description
DataResponse	Standard response model (Success/Failure) for repositories.
Failure	Abstract root — implement or extend to create domain-specific failures.
ApiFailure	Base for all server/network failures; carries ServerFailure enum, optional status code, and message.
ApiUndefinedFailure	Server returned an unrecognized error.
ConnectionFailure	No network / socket unreachable.
ApiExceptionFailure	Unexpected exception during an API call.
ApiUnauthorizedFailure	HTTP 401 / auth token rejected.
ApiTooManyRequestsFailure	HTTP 429 / rate-limited.
ApiUnknownFailure	Catch-all when the failure type cannot be determined.
CanceledRequestFailure	Request was deliberately canceled before completion.
BaseProgressState	Sealed base for progress state; extend to attach custom payload.
DefaultProgressState	Simple showProgress boolean state for loading indicators.

License

MIT