feat!: add built-in token expiration support

packages/fresh/example/README.md

@@ -0,0 +1,6 @@
+An token refresh library for dart. This package exposes the core components that are common to various refresh token implementations (REST, GraphQL, etc...).
+
+| Package                                                                               | Pub                                                                                                      |
+| ------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
+| [fresh_dio](https://github.com/felangel/fresh/tree/master/packages/fresh_dio)         | [![pub package](https://img.shields.io/pub/v/fresh_dio.svg)](https://pub.dev/packages/fresh_dio)         |
+| [fresh_graphql](https://github.com/felangel/fresh/tree/master/packages/fresh_graphql) | [![pub package](https://img.shields.io/pub/v/fresh_graphql.svg)](https://pub.dev/packages/fresh_graphql) |

packages/fresh/lib/src/fresh.dart

@@ -48,7 +48,7 @@ enum AuthenticationStatus {
 }
 
 /// An interface which must be implemented to
-/// read, write, and delete the `Token`.
+/// manage the underlying `Token`.
 abstract class TokenStorage<T> {
   /// Returns the stored token asynchronously.
   Future<T?> read();
@@ -58,6 +58,9 @@ abstract class TokenStorage<T> {
 
   /// Deletes the stored token asynchronously.
   Future<void> delete();
+
+  /// Whether the stored token is expired.
+  Future<bool> isExpired() async => false;
 }
 
 /// Function responsible for building the token header(s) give a [token].
@@ -66,12 +69,43 @@ typedef TokenHeaderBuilder<T> = Map<String, String> Function(
 );
 
 /// A [TokenStorage] implementation that keeps the token in memory.
-class InMemoryTokenStorage<T> implements TokenStorage<T> {
+class InMemoryTokenStorage<T> extends TokenStorage<T> {
+  T? _token;
+
+  @override
+  Future<void> delete() async {
+    _token = null;
+  }
+
+  @override
+  Future<T?> read() async {
+    return _token;
+  }
+
+  @override
+  Future<void> write(T token) async {
+    _token = token;
+  }
+}
+
+/// A [TokenStorage] implementation that keeps the [OAuth2Token] in memory.
+class InMemoryOAuth2TokenStorage<T extends OAuth2Token>
+    extends TokenStorage<T> {
   T? _token;
+  DateTime? _expiresAt;
+
+  @override
+  Future<bool> isExpired() async {
+    if (_expiresAt == null) return false;
+    return DateTime.now()
+        .toUtc()
+        .isAfter(_expiresAt!.subtract(const Duration(seconds: 10)));
+  }
 
   @override
   Future<void> delete() async {
     _token = null;
+    _expiresAt = null;
   }
 
   @override
@@ -82,6 +116,10 @@ class InMemoryTokenStorage<T> implements TokenStorage<T> {
   @override
   Future<void> write(T token) async {
     _token = token;
+    if (token.expiresIn != null) {
+      _expiresAt =
+          DateTime.now().toUtc().add(Duration(seconds: token.expiresIn!));
+    }
   }
 }
 
@@ -104,6 +142,9 @@ mixin FreshMixin<T> {
     _tokenStorage = tokenStorage..read().then(_updateStatus);
   }
 
+  /// Returns whether the current token is expired.
+  Future<bool> isTokenExpired() => _tokenStorage.isExpired();
+
   /// Returns the current token.
   Future<T?> get token async {
     if (_authenticationStatus != AuthenticationStatus.initial) return _token;

packages/fresh/pubspec.yaml

@@ -5,10 +5,10 @@ issue_tracker: https://github.com/felangel/fresh/issues
 homepage: https://github.com/felangel/fresh
 funding: [https://github.com/sponsors/felangel]
 
-version: 0.4.3
+version: 0.5.0
 
 environment:
-  sdk: ">=2.12.0 <4.0.0"
+  sdk: ">=3.0.0 <4.0.0"
 
 dev_dependencies:
   mocktail: ^1.0.0

packages/fresh_dio/example/.metadata

@@ -4,7 +4,27 @@
 # This file should be version controlled and should not be manually edited.
 
 version:
-  revision: d3ed9ec945f8869f0e136c357d0c2a6be2b60c98
-  channel: beta
+  revision: "dec2ee5c1f98f8e84a7d5380c05eb8a3d0a81668"
+  channel: "stable"
 
 project_type: app
+
+# Tracks metadata for the flutter migrate command
+migration:
+  platforms:
+    - platform: root
+      create_revision: dec2ee5c1f98f8e84a7d5380c05eb8a3d0a81668
+      base_revision: dec2ee5c1f98f8e84a7d5380c05eb8a3d0a81668
+    - platform: web
+      create_revision: dec2ee5c1f98f8e84a7d5380c05eb8a3d0a81668
+      base_revision: dec2ee5c1f98f8e84a7d5380c05eb8a3d0a81668
+
+  # User provided section
+
+  # List of Local paths (relative to this file) that should be
+  # ignored by the migrate tool.
+  #
+  # Files that are not part of the templates will be ignored by default.
+  unmanaged_files:
+    - 'lib/main.dart'
+    - 'ios/Runner.xcodeproj/project.pbxproj'