Merge v1.7.4

 - `TimedMap`:
   - Added keyTimeoutChecker

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.7.4
+
+- `TimedMap`:
+  - Added keyTimeoutChecker
+
 ## 1.7.3
 
 - `MapAsCacheExtension`:

lib/src/bones_api_base.dart

@@ -42,7 +42,7 @@ typedef APILogger = void Function(APIRoot apiRoot, String type, String? message,
 /// Bones API Library class.
 class BonesAPI {
   // ignore: constant_identifier_names
-  static const String VERSION = '1.7.3';
+  static const String VERSION = '1.7.4';
 
   static bool _boot = false;
 

lib/src/bones_api_utils_timedmap.dart

@@ -5,7 +5,10 @@ class TimedMap<K, V> implements Map<K, V> {
   /// The key timeout. When a key is put, it expires after the timeout [Duration].
   final Duration keyTimeout;
 
-  TimedMap(this.keyTimeout, [Map<K, V>? map]) {
+  final bool? Function(TimedMap timedMap, Object? key, Duration elapsedTime,
+      Duration keyTimeout)? keyTimeoutChecker;
+
+  TimedMap(this.keyTimeout, [Map<K, V>? map, this.keyTimeoutChecker]) {
     if (map != null) {
       addAll(map);
     }
@@ -132,7 +135,17 @@ class TimedMap<K, V> implements Map<K, V> {
     var elapsedTime = getElapsedTime(key, now: now);
     if (elapsedTime == null) return false;
 
+    final keyTimeoutChecker = this.keyTimeoutChecker;
+
     keyTimeout ??= this.keyTimeout;
+
+    if (keyTimeoutChecker != null) {
+      var expired = keyTimeoutChecker(this, key, elapsedTime, keyTimeout);
+      if (expired != null) {
+        return expired;
+      }
+    }
+
     return elapsedTime.inMilliseconds > keyTimeout.inMilliseconds;
   }
 

pubspec.yaml

@@ -1,6 +1,6 @@
 name: bones_api
 description: Bones_API - A powerful API backend framework for Dart. It comes with a built-in HTTP Server, route handler, entity handler, SQL translator, and DB adapters.
-version: 1.7.3
+version: 1.7.4
 homepage: https://github.com/Colossus-Services/bones_api
 
 environment:

test/bones_api_utils_test.dart

@@ -433,6 +433,34 @@ void main() {
 
       expect(m.length, equals(0));
     });
+
+    test('keyTimeoutChecker', () async {
+      final checks = <String>[];
+
+      var m = TimedMap<String, int>(Duration(seconds: 1), null, (tm, k, t, to) {
+        checks.add('$k,${to.inMilliseconds}');
+        if (k == 'b') return false;
+        return null;
+      });
+
+      m.put('a', 1);
+      m.put('b', 2);
+
+      expect(m.length, equals(2));
+      expect(checks, isEmpty);
+
+      m.checkAllEntries();
+
+      expect(m.length, equals(2));
+      expect(checks, equals(['a,1000', 'b,1000']));
+
+      await Future.delayed(Duration(milliseconds: 1100));
+
+      m.checkAllEntries();
+
+      expect(m, equals({'b': 2}));
+      expect(checks, equals(['a,1000', 'b,1000', 'a,1000', 'b,1000']));
+    });
   });
 
   group('PositionalFields', () {