Easy User #

The easyuser package lets you manage user accounts and their information securely and with ease.

Intialization #

You can initialize the user functionality with UserService.instance.init(). This package actually works partially even without the initialization. However, to manage logged-in user information, you need to go through the initialization process.

The UserService.instance.init() function is designed to be initialized only once. Therefore, if an app initializes it, even if a dependent package uses the easyuser package, it won't initialize it a second time. Instead, it continues with the app's initialized settings.

How to use #

Usages #

The easy package developers might consider adding the easyuser package to their package. However, it's best to only add easyuser if necessary. For example, include easyuser if you need to search for users, as it offers a user search dialog. But, if you just need to check if a user is signed in or get the user's UID, you don't need to use the easyuser package.

Database structure for user #

User database structure customization is no longer supported by v0.0.8. This is because easyuser has a security rules to apply admin field and other reules. And it often leads more complication when the database structure customization applied.

If you have a different database structure for user data management, you will need to customize it by userself. It is recommended to simply store the copy version the user data into /users collection when the user updates his information.

User collection #

• Firestore 의 /users/{uid} 와 같이 저장됩니다. 컬렉션에 저장되는 문서의 키는 사용자 UID 입니다. 이 문서에는 공개 정보만 저장되어야 합니다. 이메일, 전화번호, 주소, 각종 신용카드, 면허증 번호 등의 연락 가능한 개인 정보, 민감한 정보를 저장해서는 안됩니다.

• 개인 정보는 /users/{uid}/user-meta/private 에 저장됩니다. 연락처 정보, 민감한 정보 등을 이 문서에 보관하면 됩니다.

• 개인 설정은 /users/{uid}/user-meta/settings 에 저장됩니다.

• /users/{uid} - The user data is stored in Firestore as /users/{uid}.

• The key for the user document is the user's uid.

• The user document should only contain public information. User's proviate information should not be store in this document.

  • Private informations are like card number, license number, email, phone number, address and otehr sensitive information.

• The user's private information is stored in /users/{uid}/user-meta/private.

• The user's settings are stored in /users/{uid}/user-meta/settings.

User document fields #

The fields used in the user document are as follows. If your app uses fields other than those listed below, you should ensure they are saved(copied) according to these fields.

• admin If this field is set to true, the user becomes an administrator. You can open the Firebase console directly and set the admin field of the desired user document to true.

• displayName This is the user's nickname. This value appears on the screen.

• name This is the user's full name.

• gender This is the user's gender. M is for male, F is for female.

• createdAt

• updatedAt

• birthYear

• birthMonth

• birthDay

• lastLoginAt

• photoUrl

• state

• stateMessage

Widget #

User sign-in or sign-out #

You display UI based on the user's login status with AuthStateChanges as shown below.

AuthStateChanges(
  builder: (user) {
    return user == null
        ? const EmailPasswordLogin()
        : Column(
            children: [
              Text('User UID: ${user.uid}'),
            ],
          );
  },
),

MyDoc #

• To know if my document is ready, so i can use my or UserService.instance.user, do the following

MyDoc(
  builder: (my) => my == null
      ? const SizedBox.shrink()
      : Column(
          children: [
            Text('Reference: ${my.ref.path}'),
            const SizedBox(height: 24),
            CommentInputBox(
              documentReference: my.ref,
            ),
            CommentListView(documentReference: my.ref),
          ],
        ),
),

And to make it short, you can use MyDocReady.

UserDoc #

You can create a widget using another user's information(document). This is handy when you have the user's UID and prefer not to repeatedly access the database, saving time and reducing costs by caching the data in memory.

uid is the user's UID. It uses the MemoryCache package to cach the data in memory.

There are three different modes for using UserDoc

If cacheOnly is true, it only uses data cached in memory. If there is cached data in memory, it uses that data. If there is no cached data in memory, it reads data from the server. The default value is true, and once user data is read from the DB, it does not read from the DB again.

If cacheOnly is false, it first shows the data cached in memory as the initialData and then fetches and shows data from the server. So, it build the widget twice.

Using [sync], it first shows the data cached in memory as the initialData and then shows data updated in real-time.

It uses the initialData for reducing flickering.

Examples:

• If you need to show a user's avatar which requires the user (document) obect but you only have his UID, then use the UserDoc to fetch the user's document object. This is a practical way to get the user object when you their uid only.

UserDoc(
  uid: widget.post.uid,
  builder: (user) => UserAvatar(
    user: user!,
  ),
),

Finding user #

You can search user from collection by thier display name. use UserSearchDialog() or UserService.instance.showUserSearchDialog

• if exactSearch is true it will search the exact text search provided in the user collection (ex: You search John Smith it will show result of user who name exactly Johm Smith). while if its false it will search base on the given and provide what might be your searching (ex: you search John and it will show result of user who have John in thier name John Smith, John Doe, John Carl, etc)

• if searchName is true is will search from the name field of the user. and if searchName is false it will search from the display name field of the user. search is case insensitive and the default search is name.

Note: Search is case-insensitive and the by default it will search exact match of the user name field.

Using UserSearchDialog Widget

ElevatedButton (
  onPressed:() {
    showDialog(
      context: context,
      builder: (context) => UserSearchDialog(
        exactSearch: false,
        searchName: true,
      ),
    )
  },
  child: const Text('Search User'),
);

Using UserService.instance.showUserSearchDialog

ElevatedButton(onPressed: () {
  UserService.instance.showUserSearchDialog(
      exactSearch: false,
      searchName: true,
    );
  }, 
  child: const Text('Search User'),
),

Trouble shooting #

• user-document-not-loaded this happens when the UserService.instance.user is accessed when it is null. If the user is logged in and this exception happens, then you should check if you are using it too early.