From 0e20075c17bb3af9e88d50a87bca2861ad1c26d1 Mon Sep 17 00:00:00 2001
From: ernest-deriv <120568427+ernest-deriv@users.noreply.github.com>
Date: Thu, 28 Dec 2023 14:29:01 +0400
Subject: [PATCH] chore(flutter_deriv_api): deprecating_connection_state_class

---
 example/lib/sample_app.dart                | 24 ++++++++++------------
 lib/state/connection/connection_cubit.dart |  2 +-
 lib/state/connection/connection_state.dart | 23 ++++++++++++++++-----
 3 files changed, 30 insertions(+), 19 deletions(-)

diff --git a/example/lib/sample_app.dart b/example/lib/sample_app.dart
index a3799bfe71..edfad53b7c 100644
--- a/example/lib/sample_app.dart
+++ b/example/lib/sample_app.dart
@@ -2,8 +2,7 @@ import 'package:flutter/material.dart';
 import 'package:flutter_bloc/flutter_bloc.dart';
 
 import 'package:flutter_deriv_api/services/connection/api_manager/connection_information.dart';
-import 'package:flutter_deriv_api/state/connection/connection_cubit.dart'
-    as api_connection;
+import 'package:flutter_deriv_api/state/connection/connection_cubit.dart';
 import 'package:flutter_deriv_api_example/pages/main_page.dart';
 
 /// Sample App main widget
@@ -13,13 +12,13 @@ class SampleApp extends StatefulWidget {
 }
 
 class _SampleAppState extends State<SampleApp> {
-  late api_connection.ConnectionCubit _connectionCubit;
+  late ConnectionCubit _connectionCubit;
 
   @override
   void initState() {
     super.initState();
 
-    _connectionCubit = api_connection.ConnectionCubit(
+    _connectionCubit = ConnectionCubit(
       ConnectionInformation(
         appId: '1089',
         brand: 'binary',
@@ -39,7 +38,7 @@ class _SampleAppState extends State<SampleApp> {
   @override
   Widget build(BuildContext context) => MultiBlocProvider(
         providers: <BlocProvider<dynamic>>[
-          BlocProvider<api_connection.ConnectionCubit>.value(
+          BlocProvider<ConnectionCubit>.value(
             value: _connectionCubit,
           ),
         ],
@@ -47,20 +46,19 @@ class _SampleAppState extends State<SampleApp> {
           appBar: AppBar(
             title: const Text('API Sample App'),
           ),
-          body: BlocBuilder<api_connection.ConnectionCubit,
-              api_connection.ConnectionState>(
+          body: BlocBuilder<ConnectionCubit, DerivConnectionState>(
             builder: (
               BuildContext context,
-              api_connection.ConnectionState state,
+              DerivConnectionState state,
             ) {
-              if (state is api_connection.ConnectionConnectedState) {
+              if (state is ConnectionConnectedState) {
                 return MainPage();
-              } else if (state is api_connection.ConnectionInitialState ||
-                  state is api_connection.ConnectionConnectingState) {
+              } else if (state is ConnectionInitialState ||
+                  state is ConnectionConnectingState) {
                 return _buildCenterText('Connecting...');
-              } else if (state is api_connection.ConnectionErrorState) {
+              } else if (state is ConnectionErrorState) {
                 return _buildCenterText('Connection Error\n${state.error}');
-              } else if (state is api_connection.ConnectionDisconnectedState) {
+              } else if (state is ConnectionDisconnectedState) {
                 return _buildCenterText(
                   'Connection is down, trying to reconnect...',
                 );
diff --git a/lib/state/connection/connection_cubit.dart b/lib/state/connection/connection_cubit.dart
index cc8b8d9949..cfce6c7435 100644
--- a/lib/state/connection/connection_cubit.dart
+++ b/lib/state/connection/connection_cubit.dart
@@ -16,7 +16,7 @@ import 'package:deriv_dependency_injector/dependency_injector.dart';
 part 'connection_state.dart';
 
 /// Bringing [ConnectionCubit] to flutter-deriv-api to simplify the usage of api.
-class ConnectionCubit extends Cubit<ConnectionState> {
+class ConnectionCubit extends Cubit<DerivConnectionState> {
   /// Initializes [ConnectionCubit].
   ConnectionCubit(
     ConnectionInformation connectionInformation, {
diff --git a/lib/state/connection/connection_state.dart b/lib/state/connection/connection_state.dart
index 6ae26e40a5..9e82b1e0ec 100644
--- a/lib/state/connection/connection_state.dart
+++ b/lib/state/connection/connection_state.dart
@@ -1,6 +1,7 @@
 part of 'connection_cubit.dart';
 
 /// Connection states base class.
+@Deprecated('Use DerivConnectionState instead')
 abstract class ConnectionState extends Equatable {
   /// Initializes [ConnectionState].
   const ConnectionState();
@@ -12,26 +13,38 @@ abstract class ConnectionState extends Equatable {
   List<Object> get props => <Object>[];
 }
 
+/// Connection states base class.
+abstract class DerivConnectionState extends ConnectionState {
+  /// Initializes [DerivConnectionState].
+  const DerivConnectionState();
+
+  @override
+  String toString() => 'DerivConnectionState: $runtimeType';
+
+  @override
+  List<Object> get props => <Object>[];
+}
+
 /// Connection initial state.
-class ConnectionInitialState extends ConnectionState {
+class ConnectionInitialState extends DerivConnectionState {
   /// Initializes [ConnectionInitialState].
   const ConnectionInitialState();
 }
 
 /// Shows that we are in the process of connecting.
-class ConnectionConnectingState extends ConnectionState {
+class ConnectionConnectingState extends DerivConnectionState {
   /// Initializes [ConnectionConnectingState].
   const ConnectionConnectingState();
 }
 
 /// Connection connected state.
-class ConnectionConnectedState extends ConnectionState {
+class ConnectionConnectedState extends DerivConnectionState {
   /// Initializes [ConnectionConnectedState].
   const ConnectionConnectedState();
 }
 
 /// Connection disconnected state.
-class ConnectionDisconnectedState extends ConnectionState {
+class ConnectionDisconnectedState extends DerivConnectionState {
   /// Initializes [ConnectionDisconnectedState].
   const ConnectionDisconnectedState({this.isChangingLanguage = false});
 
@@ -40,7 +53,7 @@ class ConnectionDisconnectedState extends ConnectionState {
 }
 
 /// Connection error state.
-class ConnectionErrorState extends ConnectionState {
+class ConnectionErrorState extends DerivConnectionState {
   /// Initializes with the this [error] message.
   const ConnectionErrorState(this.error);