Updated: made the Storage class singleton

Author: we-mohd-i001

lib/vaahextendflutter/services/storage/local/services/base_service.dart

@@ -0,0 +1,27 @@
+abstract class LocalStorageService {
+  Future<void> init();
+
+  Future<void> create({required String key, required String value});
+
+  Future<void> createMany({required Map<String, String> values});
+
+  Future<String?> read({required String key});
+
+  Future<Map<String, String?>> readMany({required List<String> keys});
+
+  Future<Map<String, String?>> readAll();
+
+  Future<void> update({required String key, required String value});
+
+  Future<void> updateMany({required Map<String, String> values});
+
+  Future<void> createOrUpdate({required String key, required String value});
+
+  Future<void> createOrUpdateMany({required Map<String, String> values});
+
+  Future<void> delete({required String key});
+
+  Future<void> deleteMany({List<String> keys = const []});
+
+  Future<void> deleteAll();
+}

lib/vaahextendflutter/services/storage/local/flutter_secure_storage/flutter_secure_storage_impl.dart renamed to lib/vaahextendflutter/services/storage/local/services/flutter_secure_storage_impl.dart

@@ -1,8 +1,8 @@
 import 'package:flutter_secure_storage/flutter_secure_storage.dart';
 
-import '../../storage.dart';
+import 'base_service.dart';
 
-class FlutterSecureStorageImpl implements Storage {
+class FlutterSecureStorageImpl implements LocalStorageService {
   final _storage = const FlutterSecureStorage();
 
   @override

lib/vaahextendflutter/services/storage/local/hive/hive_storage_impl.dart renamed to lib/vaahextendflutter/services/storage/local/services/hive_storage_impl.dart

@@ -1,9 +1,10 @@
 import 'package:hive/hive.dart';
 
-import '../../storage.dart';
+import '../storage.dart';
+import 'base_service.dart';
 
 /// A class implementing Storage interface using Hive as storage backend.
-class HiveStorageImpl implements Storage {
+class HiveStorageImpl implements LocalStorageService {
   final String name;
 
   Box? _box;

lib/vaahextendflutter/services/storage/local/services/no_op_storage.dart

@@ -0,0 +1,49 @@
+import 'base_service.dart';
+
+/// A placeholder storage class when [LocalStorageType.none] is selected in env.dart.
+class NoOpStorage implements LocalStorageService {
+  @override
+  Future<void> init() async {}
+
+  @override
+  Future<void> create({required String key, required String value}) async {}
+
+  @override
+  Future<void> createMany({required Map<String, String> values}) async {}
+
+  @override
+  Future<String?> read({required String key}) async {
+    return null;
+  }
+
+  @override
+  Future<Map<String, String?>> readMany({required List<String> keys}) async {
+    return {};
+  }
+
+  @override
+  Future<Map<String, String?>> readAll() async {
+    return {};
+  }
+
+  @override
+  Future<void> update({required String key, required String value}) async {}
+
+  @override
+  Future<void> updateMany({required Map<String, String> values}) async {}
+
+  @override
+  Future<void> createOrUpdate({required String key, required String value}) async {}
+
+  @override
+  Future<void> createOrUpdateMany({required Map<String, String> values}) async {}
+
+  @override
+  Future<void> delete({required String key}) async {}
+
+  @override
+  Future<void> deleteMany({List<String> keys = const []}) async {}
+
+  @override
+  Future<void> deleteAll() async {}
+}

lib/vaahextendflutter/services/storage/local/storage.dart

@@ -0,0 +1,201 @@
+import '../../../env.dart';
+import 'services/base_service.dart';
+import 'services/flutter_secure_storage_impl.dart';
+import 'services/hive_storage_impl.dart';
+import 'services/no_op_storage.dart';
+
+LocalStorageService get instanceLocal {
+  final EnvironmentConfig envConfig = EnvironmentConfig.getEnvConfig();
+  switch (envConfig.localStorageType) {
+    case LocalStorageType.hive:
+      return HiveStorageImpl();
+    case LocalStorageType.flutterSecureStorage:
+      return FlutterSecureStorageImpl();
+    default:
+      return NoOpStorage();
+  }
+}
+
+abstract class LocalStorage {
+  static final LocalStorageService _instanceLocal = instanceLocal;
+
+  /// Initializes the [LocalStorage].
+  /// In the case of [HiveStorageImpl], it creates a [Directory] using the path_provide package,
+  /// initializes hive at that directory and opens a box with name [name] provided during [LocalStorage]
+  /// creation.
+  /// It's not required in the case of [FlutterSecureStorageImpl].
+  ///
+  /// Example:
+  /// ```dart
+  /// Storage.init();
+  /// ```
+  static Future<void> init() {
+    return _instanceLocal.init();
+  }
+
+  /// Creates a new item in the [LocalStorage].
+  ///
+  /// To create a single key-value pair pass the [key] and the [value] as String, the
+  /// String could be a JSON String or a simple text according to your requirement.
+  /// If the key is already present in the [LocalStorage] it's vlaue will be overwritten.
+  ///
+  /// Example:
+  /// ```dart
+  /// await Storage.create(key: 'key', value: 'value');
+  /// ```
+  static Future<void> create(String name, {required String key, required String value}) {
+    return _instanceLocal.create(key: key, value: value);
+  }
+
+  /// Creates new items in the [LocalStorage].
+  /// If you want to create multiple entries pass the [values] as a Map<String, String>, then it
+  /// will create all the key-value pairs from the [values] map.
+  /// If any key from the [values] is already present in the [LocalStorage] it's value will be
+  /// overwritten.
+  ///
+  /// Example:
+  /// ```dart
+  /// await Storage.createMany(values: {
+  ///     'key1': 'Value1',
+  ///     'key2': 'Value2',
+  ///     'key3': 'Value3',
+  ///     'key4': 'Value4',
+  ///     'key5': 'Value5',
+  ///     //...
+  ///   },
+  /// );
+  /// ```
+  static Future<void> createMany({required Map<String, String> values}) {
+    return _instanceLocal.createMany(values: values);
+  }
+
+  /// Reads the value of the item at [key] from the [LocalStorage] and returns the value.
+  ///
+  /// Read a single value by passing [key] as String, it will return the value as String?.
+  ///
+  /// Example:
+  /// ```dart
+  /// await Storage.read(key: 'key');
+  /// ```
+  static Future<String?> read({required String key}) {
+    return _instanceLocal.read(key: key);
+  }
+
+  /// Reads multiple values, pass the List of [keys] as argument. It will return the value as
+  /// Map<String, String?>.
+  ///
+  /// Example:
+  /// ```dart
+  /// await Storage.readMany(keys: [
+  ///     'key1',
+  ///     'key2',
+  ///     //...
+  ///   ],
+  /// );
+  /// ```
+  static Future<Map<String, String?>> readMany({required List<String> keys}) {
+    return _instanceLocal.readMany(keys: keys);
+  }
+
+  /// It will return all the values from that [LocalStorage] as Map<String, String?>.
+  static Future<Map<String, String?>> readAll() {
+    return _instanceLocal.readAll();
+  }
+
+  /// Updates an item in the [LocalStorage].
+  ///
+  /// To update a single key-value pair pass the [key] and the [value] as String, the
+  ///
+  /// Example:
+  /// ```dart
+  /// await Storage.update(key: 'key', value: 'value');
+  /// ```
+  static Future<void> update({required String key, required String value}) {
+    return _instanceLocal.update(key: key, value: value);
+  }
+
+  /// Updates items in the [LocalStorage].
+  /// If you want to update multiple entries pass the [values] as a Map<String, String>, then it
+  /// will update all the key-value pairs in the [values] map.
+  ///
+  /// Example:
+  /// ```dart
+  /// await Storage.updateMany(values: {
+  ///     'key1': 'Value1',
+  ///     'key2': 'Value2',
+  ///     'key3': 'Value3',
+  ///     'key4': 'Value4',
+  ///     'key5': 'Value5',
+  ///     //...
+  ///   },
+  /// );
+  /// ```
+  static Future<void> updateMany({required Map<String, String> values}) {
+    return _instanceLocal.updateMany(values: values);
+  }
+
+  /// Creates or updates an item in the [LocalStorage].
+  ///
+  /// To create or update a single key-value pair pass the [key] and the [value] as String, the
+  /// If the [key] is already present in the [LocalStorage] it's value will be overwritten.
+  ///
+  /// Example:
+  /// ```dart
+  /// await Storage.createOrUpdate(key: 'key', value: 'value');
+  /// ```
+  static Future<void> createOrUpdate({required String key, required String value}) {
+    return _instanceLocal.createOrUpdate(key: key, value: value);
+  }
+
+  /// Creates or updates items in the [LocalStorage].
+  /// If you want to create or update multiple entries pass the [values] as a Map<String, String>, then it
+  /// will create all the key-value pairs from the [values] map.
+  /// If any key from the [values] is already present in the [LocalStorage] it's value will be
+  /// overwritten.
+  ///
+  /// Example:
+  /// ```dart
+  /// await Storage.createOrUpdateMany(values: {
+  ///     'key1': 'Value1',
+  ///     'key2': 'Value2',
+  ///     'key3': 'Value3',
+  ///     'key4': 'Value4',
+  ///     'key5': 'Value5',
+  ///     //...
+  ///   },
+  /// );
+  /// ```
+  static Future<void> createOrUpdateMany({required Map<String, String> values}) {
+    return _instanceLocal.createOrUpdateMany(values: values);
+  }
+
+  /// Deletes an item at [key].
+  ///
+  /// Example:
+  /// ```dart
+  /// await Storage.delete(key: 'key');
+  /// ```
+  static Future<void> delete({required String key}) {
+    return _instanceLocal.delete(key: key);
+  }
+
+  /// Deletes item at a key present in [keys], from that [LocalStorage].
+  ///
+  /// Example:
+  /// ```dart
+  /// await Storage.deleteMany(keys: [
+  ///     'key1',
+  ///     'key2',
+  ///     //...
+  ///   ],
+  /// );
+  /// ```
+  static Future<void> deleteMany({List<String> keys = const []}) {
+    return _instanceLocal.deleteMany(keys: keys);
+  }
+
+  /// Deletes all the values from that [LocalStorage]
+  static Future<void> deleteAll() {
+    return _instanceLocal.deleteAll();
+  }
+}