hive_local_storage

---

A utility package to storage user session and cache values in hive box

• uses hive_ce for caching
• uses flutter_secure_storage to storage encryption key of secured hive box for session storage

Get Started

dependencies:
  hive_local_storage: latest
  hive_ce: latest
  hive_ce_flutter: latest # optional

if you want to use custom class for hive you need to add hive_generator in your dev_dependencies

dev_dependencies:
  build_runner: latest
  hive_ce_generator: latest

Usage

  import 'package:hive_local_storage/hive_local_storage.dart';

Registering Custom Adapters

NOTE: avoid using typeId=0 for data classes because typeId=0 is already used by session class.

As Session is using typeId 0 make sure to add 0 in reserved type ids while initializing @GenerateAdapters of hive_ce

part 'hive_adapters.g.dart';
  @GenerateAdapters(
    [AdapterSpec<Contact>(), AdapterSpec<User>()],
    firstTypeId: 1,
    reservedTypeIds: {0},
  )
  // ignore: unused_element
  void _() {}

and import extension function Hive.registerAdapters generated using hive_ce_generator from hive_registrar.g.dart

  await LocalStorage.initialize(registerAdapters:Hive.registerAdapters);

Session

hive_local_storage provides easy mechanism to store session using encrypted box

• Store Session

    await LocalStorage.i.saveToken('accessToken','refreshToken'); // refreshToken is optional
  

• Get Session

     /// get access token
     final accessToken  = LocalStorage.i.accessToken;
  
     /// get refresh token
     final refreshToken = LocalStorage.i.refreshToken;
  
     /// check wheather session is saved or not
     final bool hasSession = LocalStorage.i.hasSession;
  
     /// listen wheather session is present or not
     StreamSubscription<bool> _subscription = LocalStorage.i.onSessionChange.listen((bool hasSession){
      // do your stuff
     });
     /// cancel your subscription on close/dispose method;
     _subscription.cancel();
  
    //to check whether accessToken is expired or not
    final isTokenExpired = LocalStorage.i.isTokenExpired;
  
  

• Remove Session

      await LocalStorage.i.clearSession();
  

Opening Custom Boxes

This is useful when you want to store hive objects directly to use this method you need to register adapter for hive objects in initialization

    /// typeId must between 1-223
    class TestModel{

        TestModel(this.firstName);

        final String firstName;

        /// rest of fields
    }
    await LocalStorage.i.openBox<TestModel>(boxName:'__TEST_BOX__',typeId:1)

Read From Custom Box

   List<TestModel> data = LocalStorage.i.values<TestModel>('__TEST_BOX__');

Write data to Custom Box

    void storeData() async {
      /// store single data
      final testModel = TestModel();
      await LocalStorage.i.add<TestModel>(boxName: '__TEST_BOX__',value:testModel);

      /// store multipleData
      final listData = <TestModel>[TestModel(),TestModel()];
      await LocalStorage.i.addAll<TestModel>(boxName: '__TEST_BOX__',values:listData);
    }

delete data from Custom Box

    void deleteData(TestModel test) async {
      await LocalStorage.i.delete<TestModel>(boxName: '__TEST_BOX__',value:testModel);
    }

update data to Custom Box

    void updateData(TestModel test) async {
      await LocalStorage.i.update<TestModel>(boxName: '__TEST_BOX__',value:testModel);
    }

To use with Riverpod

/// create provider
final localStorageProvider = Provider<LocalStorage>((ref)=>throw UnImplementedError());

/// in main function

void main() {
  runZonedGuarded(
    () async {
      await LocalStorage.initialize();
      runApp(
        ProviderScope(
          overrides: [
            localStorageProvider.overrideWithValue(LocalStorage.i),
          ],
          child: App(),
        ),
      );
    },
    (e, _) => throw e,
  );
}

Write data

   /// initialize local_storage
await LocalStorage.initialize();

// to store value in cache box
await LocalStorage.i.put<int>(key:'count',value:0);


// write multiple values in cache box
await LocalStorage.i.putAll(Map<String, dynamic> entries);

// put list of data in cache box
await LocalStorage.i.putList<Model>(key:'KeyName',value:<Model>[]);

Read data

   /// initialize local_storage
await LocalStorage.initialize();

// to get value from cache box
final count =  LocalStorage.i.get<int>(key:'count');

// watch value changed on key
LocalStorage.i.watchKey(key:'key').listen((value){
  //TODO: do your work
});

// read list data from cache box
final listData = LocalStorage.i.getList<Model>(key:'Your KeyName');

Delete data

   /// initialize local_storage
await LocalStorage.initialize();

// remove value from cache box
await LocalStorage.i.remove(key:'count');

// remove all from cache box
await LocalStorage.i.clear();

// clear both session and cache box
await LocalStorage.i.clearAll();