merging

Author: thruthesky

CHANGELOG.md

@@ -1,7 +1,35 @@
-## [0.0.43] - Document update only
+## [0.0.48] - Document update only
 
 - Add documentation on location.
 
+## [0.0.47] - Chat functions
+
+- Document update on chat functions.
+
+## [0.0.46] - Big break on user data events
+
+This is going to be a big break.
+
+- `userDataChange` and `userPublicDataChange` had been diverged from the previous version of `userChange`.
+- And `userChange` is now used as an alias of `FirebaseAuth.instance.userChanges()` which will be fired on all user change events.
+- Resets userPublicData property when user logs in or register.
+
+## [0.0.45] - Revert fetch timeout
+
+- Revert code related with `fetched` adn `fetchTimeout`. So, when it can't fetch posts, it would stuck there foerver.
+
+## [0.0.44] - Fetch timeout
+
+- `getPublicData()` has been deprecatd. Use `getUserPublicData()`.
+- `fetched` becomes true if the app had fetched the first batch of posts from Firestore. Mostly the UI shows a spinner(loader) that the fetching is in progress. And if there is no document to fetch, it would ever become true that causes the UI show spinner and wait forever. So, it will turn into true after the [fetchTimeout] when there is no documents to fetch. This does not mean any documents are actually fetched.
+
+## [0.0.43] - Variable name changes and minor changes.
+
+- `email` and `password` of `loginOrRegister` are now optional.
+- `userPublicData` has been renamed to `getUserPublicData`.
+- `publicData` has been renamed to `userPublicData`.
+- When user logs out, `userPublicData` become an empty Map.
+
 ## [0.0.42] - Storage related code update
 
 - Storage security rules are updated and user's uid is attached to the file metadata.

README.md

@@ -4,8 +4,17 @@ class Base {
   /// Check if Firebase has initialized.
   bool isFirebaseInitialized = false;
 
-  /// Fires after Firebase has initialized or if already initialized.
-  /// The true event will be fired only once when Firebase initialized.
+  /// Firebase intialized event
+  ///
+  /// This event is fires after Firebase has initialized(created instance) or if
+  /// it has already initialized.
+  ///
+  /// When this event is fired, `initUser()` is already called which means,
+  /// `authStateChanages` and `userChanges` are ready to be consumed.
+  ///
+  /// The arguemnt will be true only after when Firebase initialized.
+  ///
+  // ignore: close_sinks
   BehaviorSubject<bool> firebaseInitialized = BehaviorSubject.seeded(false);
 
   /// Returns Firestore instance. Firebase database instance.
@@ -50,17 +59,28 @@ class Base {
 
   bool enableNotification;
 
-  /// [authStateChange] is a link to `FirebaseAuth.instance.authStateChanges()`
+  /// [authStateChange] is fired whenever user logs in or out.
   ///
-  /// Use this to know if the user has logged in or not.
+  /// Use this to know if the user has logged in or not. Since this is
+  /// `BehaviorSubject` that delivers Firebase `User` object, it can be used
+  /// outside of `ff.firebaseInitialized.listen()`
   ///
   /// You can do the following with [authStateChanges]
-  /// ```
+  /// ```dart
   /// StreamBuilder(
   ///   stream: ff.authStateChanges,
   ///   builder: (context, snapshot) { ... });
   /// ```
-  Stream<User> authStateChanges;
+  ///
+  /// ```dart
+  /// ff.authStateChanges.listen((user) { ... }
+  /// ```
+  BehaviorSubject<User> authStateChanges = BehaviorSubject.seeded(null);
+
+  /// [userChanges] is a simple alias of `FirebaseAuth.instance.userChanges()`
+  ///
+  /// It will be fired when user changes `dispolayName` or `photoURL`.
+  Stream<User> userChanges;
 
   /// Firebase User instance
   ///
@@ -87,22 +107,32 @@ class Base {
   /// User document data.
   Map<String, dynamic> userData = {};
 
-  /// User public document data.
-  Map<String, dynamic> publicData = {};
+  @Deprecated('Use userPublicData')
 
-  bool get loggedIn => user != null;
-  bool get notLoggedIn => !loggedIn;
+  /// User public document data.
+  Map<String, dynamic> get publicData => userPublicData;
+  Map<String, dynamic> userPublicData = {};
+
+  // /// [userChange] event fires when
+  // /// - user document(without subcollection) like when user updates his profile
+  // /// - user log in,
+  // /// - user log out,
+  // /// - user verify his phone nubmer
+  // /// - user profile photo changes
+  // ///
+  // /// It is important to know that [authStateChanges] event happens only when
+  // /// user logs in or logs out.
+  // BehaviorSubject<UserChangeData> userChange = BehaviorSubject.seeded(null);
+
+  /// [userDataChange] is fired when `/users/{uid}` changes.
+  // ignore: close_sinks
+  BehaviorSubject<Map<String, dynamic>> userDataChange =
+      BehaviorSubject.seeded(null);
 
-  /// [userChange] event fires when
-  /// - user document(without subcollection) like when user updates his profile
-  /// - user log in,
-  /// - user log out,
-  /// - user verify his phone nubmer
-  /// - user profile photo changes
-  ///
-  /// It is important to know that [authStateChanges] event happens only when
-  /// user logs in or logs out.
-  BehaviorSubject<UserChangeData> userChange = BehaviorSubject.seeded(null);
+  /// [userPublicDataChange] is fired when `/meta/user/public/{uid}` changes.
+  // ignore: close_sinks
+  BehaviorSubject<Map<String, dynamic>> userPublicDataChange =
+      BehaviorSubject.seeded(null);
 
   /// [notification] will be fired whenever there is a push notification.
   /// the return data will the following and can be use when user receive notifications.
@@ -146,13 +176,36 @@ class Base {
   /// For chat and other functionalities that do user search need this option.
   bool openProfile = false;
 
+  /// Helper functions
+  ///
+  /// [loggedIn] returns true if the user has logged in.
+  bool get loggedIn => user != null;
+
+  /// [notLoggedIn] returns true if the user is not logged in.
+  bool get notLoggedIn => !loggedIn;
+
+  /// [uid] returns login user's uid.
+  String get uid => user == null ? null : user.uid;
+
+  /// [displayName] returns displayName or null if the user has not logged in.
+  ///
+  /// ```dart
+  /// Text(ff.displayName ?? '')
+  /// ```
+  String get displayName => user == null ? null : user.displayName;
+
+  /// [photoURL] returns login user's phogo URL.
+  String get photoURL => user == null ? null : user.photoURL;
+
   initUser() {
-    authStateChanges = FirebaseAuth.instance.authStateChanges();
+    userChanges = FirebaseAuth.instance.userChanges();
 
     /// Note: listen handler will called twice if Firestore is working as offline mode.
-    authStateChanges.listen((User user) {
+    FirebaseAuth.instance.authStateChanges().listen((User user) {
+      authStateChanges.add(user);
+
       /// [userChange] event fires when user is logs in or logs out.
-      userChange.add(UserChangeData(UserChangeType.auth, user: user));
+      // userChange.add(UserChangeData(UserChangeType.auth, user: user));
 
       /// Cancel listening user document.
       ///
@@ -172,8 +225,7 @@ class Base {
           (DocumentSnapshot snapshot) {
             if (snapshot.exists) {
               userData = snapshot.data();
-              userChange
-                  .add(UserChangeData(UserChangeType.document, user: user));
+              userDataChange.add(userData);
             }
           },
         );
@@ -182,8 +234,8 @@ class Base {
         userPublicDocSubscription = publicDoc.snapshots().listen(
           (DocumentSnapshot snapshot) {
             if (snapshot.exists) {
-              publicData = snapshot.data();
-              userChange.add(UserChangeData(UserChangeType.public, user: user));
+              userPublicData = snapshot.data();
+              userPublicDataChange.add(userPublicData);
             }
           },
         );
@@ -195,17 +247,16 @@ class Base {
 
   /// Initialize Firebase
   ///
-  /// Firebase is initialized asynchronously. It does not block the app by async/await.
+  /// Firebase is initialized asynchronously. Meaning, it does not block the app
+  /// while it's intializaing.
+  ///
+  /// Invoked by `ff.init()`.
   initFirebase() {
     // WidgetsFlutterBinding.ensureInitialized();
     return Firebase.initializeApp().then((firebaseApp) {
-      isFirebaseInitialized = true;
-      firebaseInitialized.add(isFirebaseInitialized);
       FirebaseFirestore.instance.settings =
           Settings(cacheSizeBytes: Settings.CACHE_SIZE_UNLIMITED);
 
-      usersCol = FirebaseFirestore.instance.collection('users');
-      postsCol = FirebaseFirestore.instance.collection('posts');
       return firebaseApp;
     });
   }

lib/base.dart

@@ -16,7 +16,7 @@ enum RenderType {
   fileUpload,
   fileDelete,
   fetching,
-  finishFetching
+  finishFetching,
 }
 
 enum ForumStatus {
@@ -64,14 +64,14 @@ const ERROR_SIGNIN_ABORTED = 'ERROR_SIGNIN_ABORTED';
 /// [UserChangeType.document] is for `/users/{uid}` change.
 /// [UserChangeType.auth] is for login, or logout. Be reminded that login even will be fired twice. This is the nature of firebase.
 /// [UserChangeType.profile] is for changing `photoURL` or `displayName`.
-enum UserChangeType { auth, document, public, register, profile }
+// enum UserChangeType { auth, document, public, register, profile }
 
 /// Event data on [userChange] event
-class UserChangeData {
-  UserChangeData(this.type, {this.user});
-  UserChangeType type;
-  User user;
-}
+// class UserChangeData {
+//   UserChangeData(this.type, {this.user});
+//   UserChangeType type;
+//   User user;
+// }
 
 enum NotificationType { onMessage, onLaunch, onResume }
 
@@ -114,10 +114,13 @@ class ForumData {
   /// [uid] could be the login user's uid or other user's uid.
   String uid;
 
-  /// [fetched] becomes true if the app has fetched from Firestore.
+  /// [fetched] becomes true if the app had fetched the first batch of posts
+  /// from Firestore. Mostly the UI shows a spinner(loader) that the fetching
+  /// is in progress. And if there is no document to fetch, it would never
+  /// become true that causes the UI show spinner and wait forever.
   ///
-  /// There might no no there even after it has fetched. So, [fetched] will be true
-  /// while [posts] is still empty array.
+  /// There might no posts there even after it has fetched. So, [fetched] might
+  /// be true while [posts] is still empty array.
   ///
   bool fetched = false;
 
@@ -141,28 +144,3 @@ class ForumData {
     }
   }
 }
-
-// class VoteChoice {
-//   static String like = 'like';
-//   static String dislike = 'dislike';
-// }
-
-// /// Algolia search data to index
-// class SearchData {
-//   /// [path] is the path of document
-//   final String path;
-//   final String title;
-//   final String content;
-
-//   /// [stamp] is unix timestmap
-//   final String stamp;
-//   SearchData({@required this.path, this.title, this.content, this.stamp});
-//   Map<String, dynamic> toMap() {
-//     return {
-//       'path': path,
-//       if (title != null) 'title': title,
-//       if (content != null) 'content': content,
-//       if (stamp != null) 'stamp': stamp,
-//     };
-//   }
-// }