smart_local_cache 2.2.3

Local storage for Flutter with no third-party packages: Map records, live streams, queries, indexes, AES-256 encryption and a disk-backed box for big data.

smart_local_cache

Fast local storage for Flutter with zero third-party packages - no shared_preferences, path_provider, hive or isar. Plain Maps in, plain Maps out. No model classes, no build_runner.

• Everything is cached in memory - reads are instant
• Writes are batched, atomic and crash-safe (temp file + rename + backup)
• Big boxes are saved/loaded on a background isolate - no UI jank
• Live updates with Stream (watchAll, watch) - works with StreamBuilder
• Filter / sort / page with query(), batch ops, schema migrations
• lazyBox for big data (records stay on disk) with indexes (findBy, findRange)
• Optional AES-256-GCM encryption with the key in Android Keystore / iOS Keychain

Platforms: Android, iOS, macOS, Linux, Windows. Encryption: Android and iOS only. Web is not supported (it needs dart:io).

1. Open a box (no init needed)

final todos = await SmartLocalStorage.box('todos');

Same name = same box everywhere in your app.

2. Save, read, update, delete

final id = await todos.add({'title': 'Milk', 'done': false}); // auto id
await todos.put('user_42', {'name': 'Sandeep'});              // your own id
await todos.update(id, {'done': true});                       // merges
await todos.delete(id);

final one = todos.get(id);     // {'id': ..., 'title': ..., 'done': ...} or null
final all = todos.getAll();    // List<Map>, each has 'id'

'id' is reserved - the box always puts the record id there. Values must be String, num, bool, null, List, Map<String, ...> (use toIso8601String() for dates). Anything else throws right away instead of failing later.

3. Show it in the UI - auto refresh

StreamBuilder<List<Map<String, dynamic>>>(
  stream: todos.watchAll(),
  builder: (context, snap) {
    final list = snap.data ?? [];
    return ListView(children: [for (final t in list) Text(t['title'])]);
  },
)

No setState needed - the stream fires after every add / update / delete. Follow a single record with todos.watch(id).

4. Search, sort, page

todos.query(
  where: (r) => r['done'] == false,
  sort: (a, b) => (a['title'] as String).compareTo(b['title'] as String),
  offset: 0,
  limit: 20,
);
todos.count((r) => r['done'] == true);
todos.firstWhere((r) => r['title'] == 'Milk');
todos.watchAll(where: ..., sort: ..., limit: ...); // same options, live

5. Many records at once

await todos.addAll([{...}, {...}]);       // one disk write
await todos.putAll({'a': {...}, 'b': {...}});
await todos.deleteAll(['1', '2']);
await todos.deleteWhere((r) => r['done'] == true);

6. Your own model class (optional)

class Note {
  Note({this.id, required this.title});
  final String? id;
  final String title;
  Map<String, dynamic> toMap() => {'title': title};
  static Note fromMap(Map<String, dynamic> m) =>
      Note(id: m['id'] as String?, title: m['title'] as String);
}

final notes = SmartModelBox<Note>(
  await SmartLocalStorage.box('notes'),
  toMap: (n) => n.toMap(),
  fromMap: Note.fromMap,
);

await notes.add(Note(title: 'Milk'));
StreamBuilder<List<Note>>(stream: notes.watchAll(), builder: ...);

7. When does data reach the disk?

Changes are visible instantly and saved ~300 ms later, in one batch. Pending writes are also flushed automatically when the app goes to the background.

await todos.add({...}, flush: true); // wait until it is on disk
await todos.flush();                 // flush this box
await SmartLocalStorage.flushAll();  // flush every box

8. Changing your data shape later (migration)

final products = await SmartLocalStorage.box(
  'products',
  version: 2, // bumped from 1
  onMigrate: (from, to, records) {
    if (from < 2) {
      for (final r in records.values) { r['currency'] = 'INR'; }
    }
  },
);

Other options

SmartLocalStorage.box('x',
  writeDelay: Duration.zero,        // save on every change
  isolateThreshold: 500,            // records from which saving uses an isolate
  onError: (e, st) => log(e),       // background save failures
);

9. Big data: lazyBox (records stay on disk)

A normal box keeps everything in memory. For 50k+ records use a lazy box: only ids are in memory, each record is read from disk when you ask for it.

final people = await SmartLocalStorage.lazyBox(
  'people',
  indexes: ['city', 'age'],   // fields you want to search fast
);

await people.addAll([...]);                       // fast appends
final one = await people.get(id);                 // reads are async
final page = await people.query(where: (r) => r['age'] > 30, limit: 20);

// Indexed search - no scan of the whole box
final delhi = await people.findBy('city', 'Delhi');
final twenties = await people.findRange('age', min: 20, max: 29);

// Memory stays flat even for a huge box
await for (final person in people.stream()) { ... }

Same write API as a normal box (add, put, update, delete, addAll, deleteWhere, ...), plus watch(id) and watchAll(limit: ...). Only equality / range on one field per call - there are no joins. Store ids of other records and use getMany(ids) for relations.

10. Encryption

final secrets = await SmartLocalStorage.box('secrets', encrypted: true);
final big = await SmartLocalStorage.lazyBox('chats', encrypted: true);

AES-256-GCM, done by the OS: the key is created and kept in the Android Keystore / iOS Keychain and never reaches Dart. Data is unreadable on a copied or rooted device's file system.

Things to know:

• Android 6.0 (API 23)+ and iOS 13+. On older Android, encrypted: true throws.
• The key is lost when the app is uninstalled. On Android, Auto Backup can restore the files without the key, so exclude them: set android:allowBackup="false" or add a backup rule excluding files/smart_local_storage/.
• Existing plain data is encrypted on the next save. Turning encrypted off later still reads old encrypted files.
• Encrypted lazy boxes call the OS once per record, so they are slower than plain ones. Encrypt only what is sensitive.

Honest limits

• A normal box is fully in memory: great up to tens of thousands of small records.
• A lazy box handles hundreds of thousands, but has no joins, no multi-field indexes and no transactions across boxes.
• Need complex SQL, relations or multi-process access? Use SQLite / Drift / Isar.

Development

flutter pub get
flutter analyze
flutter test

GitHub Actions runs the same checks on stable and beta Flutter every week, so new Flutter releases are tested automatically.

Example app

example/ has 4 screens: plain Maps with live search, a typed model, a 20,000-record stress test with queries / flush / migration, and a big-data screen with lazy boxes, indexes and encryption.