✨ add support for Uin8List bytes.

Author: BirjuVachhani

.github/workflows/docs.yml

@@ -1,4 +1,4 @@
-name: Deploy Playground
+name: Deploy Docs
 
 on:
   push:

packages/hyper_storage/lib/src/api/api.dart

@@ -2,6 +2,8 @@
 // Use of this source code is governed by a BSD license that can be
 // found in the LICENSE file.
 
+import 'dart:typed_data';
+
 import 'package:meta/meta.dart';
 
 import 'backend.dart';
@@ -549,6 +551,39 @@ abstract interface class StorageOperationsApi {
   /// * [ArgumentError] if the key is invalid.
   Future<List<String>?> getStringList(String key);
 
+  /// Saves a byte array with the given [key].
+  ///
+  /// This method stores a byte array (Uint8List) in the storage, associating it
+  /// with the specified key. If a value already exists for this key, it will be
+  /// replaced.
+  ///
+  /// Parameters:
+  /// - [key]: The unique identifier for the byte array.
+  /// - [bytes]: The byte array to store.
+  ///
+  /// Returns a [Future] that completes when the byte array has been successfully
+  /// stored.
+  ///
+  /// Throws:
+  /// - [ArgumentError] if the key is invalid.
+  Future<void> setBytes(String key, Uint8List bytes);
+
+  /// Retrieves a byte array by its [key].
+  ///
+  /// This method fetches a byte array (Uint8List) previously stored using [setBytes].
+  /// If no value exists for the given key, or the stored value is not a byte array,
+  /// this method returns `null`.
+  ///
+  /// Parameters:
+  /// - [key]: The unique identifier of the byte array to retrieve.
+  ///
+  /// Returns a [Future] that completes with the stored byte array if found,
+  /// or `null` if the key doesn't exist or the value is not a byte array.
+  ///
+  /// Throws:
+  /// - [ArgumentError] if the key is invalid.
+  Future<Uint8List?> getBytes(String key);
+
   /// Saves a JSON object (Map) with the given [key].
   ///
   /// This method stores a JSON-serializable map in the storage, associating it

packages/hyper_storage/lib/src/api/backend.dart

@@ -5,6 +5,7 @@
 library;
 
 import 'dart:convert';
+import 'dart:typed_data';
 
 import 'package:meta/meta.dart';
 
@@ -136,6 +137,16 @@ abstract class StorageBackend with GenericStorageOperationsMixin implements Stor
   @override
   Future<void> setDuration(String key, Duration value) => setInt(key, value.inMilliseconds);
 
+  @override
+  Future<void> setBytes(String key, List<int> value) => setString(key, base64Encode(value));
+
+  @override
+  Future<Uint8List?> getBytes(String key) async {
+    final value = await getString(key);
+    if (value == null) return null;
+    return base64Decode(value);
+  }
+
   @override
   Future<void> setEnum<E extends Enum>(String key, E value) => setString(key, value.name);
 
@@ -159,15 +170,17 @@ abstract class StorageBackend with GenericStorageOperationsMixin implements Stor
 /// a storage backend by providing type-aware routing logic.
 ///
 /// Supported types:
-/// * [String] - Routes to [getString] / [setString]
-/// * [int] - Routes to [getInt] / [setInt]
-/// * [double] - Routes to [getDouble] / [setDouble]
-/// * [bool] - Routes to [getBool] / [setBool]
-/// * [DateTime] - Routes to [getDateTime] / [setDateTime]
-/// * [Duration] - Routes to [getDuration] / [setDuration]
-/// * [List<String>] - Routes to [getStringList] / [setStringList]
-/// * [Map<String, dynamic>] - Routes to [getJson] / [setJson]
-/// * [List<Map<String, dynamic>>] - Routes to [getJsonList] / [setJsonList]
+/// - [String] - Routes to [getString] / [setString]
+/// - [int] - Routes to [getInt] / [setInt]
+/// - [double] - Routes to [getDouble] / [setDouble]
+/// - [bool] - Routes to [getBool] / [setBool]
+/// - [DateTime] - Routes to [getDateTime] / [setDateTime]
+/// - [Duration] - Routes to [getDuration] / [setDuration]
+/// - [List<String>] - Routes to [getStringList] / [setStringList]
+/// - [Map<String, dynamic>] - Routes to [getJson] / [setJson]
+/// - [List<Map<String, dynamic>>] - Routes to [getJsonList] / [setJsonList]
+/// - [Enum] - Routes to [getEnum] / [setEnum] (requires `enumValues` parameter for `get`)
+/// - [Uint8List] - Routes to [getBytes] / [setBytes]
 @internal
 mixin GenericStorageOperationsMixin implements StorageOperationsApi {
   @override
@@ -195,6 +208,7 @@ mixin GenericStorageOperationsMixin implements StorageOperationsApi {
       const (List<String>) => await getStringList(key) as E?,
       const (Map<String, dynamic>) => await getJson(key) as E?,
       const (List<Map<String, dynamic>>) => await getJsonList(key) as E?,
+      const (Uint8List) => await getBytes(key) as E?,
       _ when enumValues != null => await () async {
         checkEnumType<E>(enumValues);
         return await getEnum(key, enumValues.cast<Enum>()) as E?;
@@ -216,6 +230,7 @@ mixin GenericStorageOperationsMixin implements StorageOperationsApi {
       Map<String, dynamic> value => setJson(key, value),
       List<Map<String, dynamic>> value => setJsonList(key, value),
       Enum value => setString(key, value.name),
+      Uint8List value => setBytes(key, value),
       _ => throw UnsupportedError('Type ${value.runtimeType} is not supported'),
     };
   }

packages/hyper_storage/lib/src/hyper_storage.dart

@@ -3,7 +3,9 @@
 // found in the LICENSE file.
 
 import 'dart:async';
+import 'dart:convert';
 import 'dart:math';
+import 'dart:typed_data';
 
 import 'package:meta/meta.dart';
 
@@ -406,7 +408,7 @@ class HyperStorage extends _HyperStorageImpl {
   ///   - Duration
   ///   - Enum (requires providing [enumValues])
   Stream<E?> stream<E extends Object>(String key, {List<Enum>? enumValues}) async* {
-    if(enumValues != null) checkEnumType<E>(enumValues);
+    if (enumValues != null) checkEnumType<E>(enumValues);
     final E? itemValue = await get<E>(key, enumValues: enumValues);
     yield itemValue;
 

packages/hyper_storage/lib/src/hyper_storage_container.dart

@@ -4,6 +4,7 @@
 
 import 'dart:async';
 import 'dart:convert';
+import 'dart:typed_data';
 
 import 'package:meta/meta.dart' show protected;
 
@@ -234,32 +235,27 @@ final class HyperStorageContainer extends StorageContainer with ItemHolderMixin,
   }
 
   @override
-  Future<void> removeAll(Iterable<String> keys) async {
-    validateKeys(keys);
-    await backend.removeAll(keys.map(encodeKey));
-    for (final key in keys) {
-      notifyKeyListeners(key);
-    }
-    notifyListeners();
+  Future<Uint8List?> getBytes(String key) async {
+    validateKey(key);
+    final value = await backend.getString(encodeKey(key));
+    if (value == null) return null;
+    return base64Decode(value);
   }
 
   @override
-  Future<void> close() async {
-    removeAllListeners();
-    await backend.close();
-    await super.close();
+  Future<void> setBytes(String key, Uint8List bytes) {
+    validateKey(key);
+    return backend.setString(encodeKey(key), base64Encode(bytes));
   }
 
   @override
-  Future<void> clear() async {
-    final encodedKeys = await getEncodedKeys();
-    final decodedKeys = encodedKeys.map(decodeKey).toList();
-    await backend.removeAll(encodedKeys);
-    for (final key in decodedKeys) {
+  Future<void> removeAll(Iterable<String> keys) async {
+    validateKeys(keys);
+    await backend.removeAll(keys.map(encodeKey));
+    for (final key in keys) {
       notifyKeyListeners(key);
     }
     notifyListeners();
-    removeAllListeners();
   }
 
   /// Provides a [Stream] of values for the given [key].
@@ -284,7 +280,7 @@ final class HyperStorageContainer extends StorageContainer with ItemHolderMixin,
   ///   - Duration
   ///   - Enum (requires providing [enumValues])
   Stream<E?> stream<E extends Object>(String key, {List<Enum>? enumValues}) async* {
-    if(enumValues != null) checkEnumType<E>(enumValues);
+    if (enumValues != null) checkEnumType<E>(enumValues);
     final E? itemValue = await get<E>(key, enumValues: enumValues);
     yield itemValue;
 
@@ -305,4 +301,23 @@ final class HyperStorageContainer extends StorageContainer with ItemHolderMixin,
     // Defensive close call. Almost never reached because the stream is closed on cancel.
     await controller.close(); // coverage:ignore-line
   }
+
+  @override
+  Future<void> close() async {
+    removeAllListeners();
+    await backend.close();
+    await super.close();
+  }
+
+  @override
+  Future<void> clear() async {
+    final encodedKeys = await getEncodedKeys();
+    final decodedKeys = encodedKeys.map(decodeKey).toList();
+    await backend.removeAll(encodedKeys);
+    for (final key in decodedKeys) {
+      notifyKeyListeners(key);
+    }
+    notifyListeners();
+    removeAllListeners();
+  }
 }

packages/hyper_storage/lib/src/storage_base.dart

@@ -244,4 +244,19 @@ abstract class _HyperStorageImpl extends BaseStorage
     await backend.setStringList(key, value);
     notifyListeners(key);
   }
+
+  @override
+  Future<void> setBytes(String key, Uint8List bytes) async {
+    validateKey(key);
+    await backend.setString(key, base64Encode(bytes));
+    notifyListeners(key);
+  }
+
+  @override
+  Future<Uint8List?> getBytes(String key) async {
+    validateKey(key);
+    final String? base64String = await backend.getString(key);
+    if (base64String == null) return null;
+    return base64Decode(base64String);
+  }
 }