firebase_for_all

Description:

firebase for all

This package is the way to use firebase features on all platforms without code changes. Its developed by using these packages(For desktop part):

firebase_dart
firedart
firebase_auth_desktop
firebase_core_desktop

firebase_dart & firedart are both great packages that will suffice all your needs for firebase. On non-windows patforms it is more desirable to use original package with minimum risk of bugs and problems.
This package will deal with channelizing task of these packages for you. It will automatically switch between packages and allow you to run "Firedart" on Windows and "cloud_firestore" on any other platform.
New classes and functions have been designed carefully so that you dont have to modify your old codes and migrate your project very easily.
Like everyone else, I'm looking forward to the end of the flutterFire desktop process. I hope this library can help a little bit until then
Features #
Currently supports the following firebase services:

Authentication
Cloud firestore
Cloud storage

Examples #
All examples in example/lib/functions.dart
Usage #
The documentation link will be added in future
You must add the library as a dependency to your project.
dependencies:
firebase_for_all: ^latest
copied to clipboard
If you setup your Firebase via FlutterFire CLI then InitializeApp function will throw an error. Do this to avoid this error:
dependency_overrides:
firebase_core_platform_interface: 4.5.1
copied to clipboard
Then run flutter packages get
Getting started #
Initiliaze firebase and choose the features you want. There are two ways to configure firebase for your project.

Old school way: configure everything by hand
New flutterfire way by using firebase CLI

Old school way:
await FirebaseCoreForAll.initializeApp(
options: FirebaseOptions(
apiKey: 'XXXXXXXXXXXXXXXXXXXXXX',
appId: 'XXXXXXXXXXXXXXXXXXXXXX',
messagingSenderId: 'XXXXXXXXXXX',
projectId: 'XXXXXXXXXXXXXX',
authDomain: 'XXXXXXXXXXXXX.firebaseapp.com',
storageBucket: 'XXXXXXXXXXXXX.appspot.com',
),
firestore: true,
auth: true,
storage: true);
copied to clipboard
New flutterfire way:
await FirebaseCoreForAll.initializeApp(
options: DefaultFirebaseOptions.currentPlatform,
firestore: true,
auth: true,
storage: true);
copied to clipboard
Cloud Storage #
get FirebaseAuth.instance with "FirebaseAuthForAll.instance"
await FirebaseAuthForAll.instance.createUserWithEmailAndPassword(email: "[email protected]", password: "password123");
copied to clipboard
Cloud Firestore #
Document & Query Snapshots #
QuerySnapshot
FirestoreForAll.instance
.collection('users')
.get()
.then((QuerySnapshotForAll querySnapshot) {
querySnapshot.docs.forEach((doc) {
print(doc["first_name"]);
});
});
copied to clipboard
DocumentSnapshot
FirestoreForAll.instance
.collection('users')
.doc(userId)
.get()
.then((DocumentSnapshotForAll documentSnapshot) {
if (documentSnapshot.exists) {
print('Document data: ${documentSnapshot.data()}');
} else {
print('Document does not exist on the database');
}
});
copied to clipboard
Querying #
Filtering
Warning: "isNotEqualTo" and "whereNotIn" dont work on desktop(except MACOS). You should use it with this in mind
FirestoreForAll.instance
.collection('users')
.where('age', isGreaterThan: 10)
.get()
.then(...);
copied to clipboard
Ordering
FirestoreForAll.instance
.collection('users')
.orderBy('age', descending: true)
.get()
.then(...);
copied to clipboard
Limiting
Warning: "limitToLast" doesnt work on desktop(except MACOS). You should use it with this in mind
FirestoreForAll.instance
.collection('users')
.limit(2)
.get()
.then(...);
copied to clipboard
Start & End Cursors
Warning: Unfortunately this feature doesnt work on desktop(except MACOS)
FirestoreForAll.instance
.collection('users')
.orderBy('age')
.orderBy('company')
.startAt([4, 'Alphabet Inc.'])
.endAt([21, 'Google LLC'])
.get()
.then(...);
copied to clipboard
Adding&Updating&Deleting Documents #
ColRef users = FirestoreForAll.instance.collection('users');
users
.add({
'full_name': fullName, // John Doe
'company': company, // Stokes and Sons
'age': age // 42
})
.then((value) => print("User Added"))
.catchError((error) => print("Failed to add user: $error"));

users
.doc("12345")
.set({
'full_name': fullName, // John Doe
'company': company, // Stokes and Sons
'age': age // 42
})
.then((value) => print("User Added"))
.catchError((error) => print("Failed to add user: $error"));

users
.doc('ABC123')
.update({'company': 'Stokes and Sons'})
.then((value) => print("User Updated"))
.catchError((error) => print("Failed to update user: $error"));

users
.doc('ABC123')
.delete()
.then((value) => print("User Deleted"))
.catchError((error) => print("Failed to delete user: $error"));
copied to clipboard
Realtime changes #
Listening collection
CollectionSnapshots collectionSnapshots = FirestoreForAll.instance.collection('users').snapshots();
collectionSnapshots.listen(
(snapshot) {},
onDone: () {},
onError: (e, stackTrace) {},
);
copied to clipboard
Warning: StreamBuilder doesnt work for this one. Use this instead:
CollectionBuilder(
stream: FirestoreForAll.instance.collection("users").snapshots(),
builder: (BuildContext context,
AsyncSnapshot<QuerySnapshotForAll> snapshot) {
if (snapshot.hasError) {
return Text('Something went wrong');
}

if (snapshot.connectionState == ConnectionState.waiting) {
return Text("Loading");
}

return ListView(
children:
snapshot.data!.docs.map((DocumentSnapshotForAll document) {
Map<String, dynamic> data =
document.data() as Map<String, dynamic>;
return ListTile(
title: Text(data['name']),
subtitle: Text(data['surname']),
);
}).toList(),
);
},
)
copied to clipboard
Listening document
DocumentSnapshots documentSnapshots=FirestoreForAll.instance.collection('users').doc('ABC123').snapshots();
documentSnapshots.listen(
(snapshot) {},
onDone: () {},
onError: (e, stackTrace) {},
);
copied to clipboard
Warning: StreamBuilder doesnt work for this one. Use this instead:
DocumentBuilder(
stream: FirestoreForAll.instance
.collection("users")
.doc('ABC123')
.snapshots(),
builder: (BuildContext context,
AsyncSnapshot<DocumentSnapshotForAll> snapshot) {
if (snapshot.hasError) {
return Text('Something went wrong');
}

if (snapshot.connectionState == ConnectionState.waiting) {
return Text("Loading");
}

return ListTile(
title: Text(snapshot.data!['name']),
subtitle: Text(snapshot.data!['surname']),
);
},
)
copied to clipboard
Typing CollectionReference and DocumentReference #
The only thing that has changed here is "User.fromJson(snapshot.map!)" instead of "User.fromJson(snapshot.data()!)"
final moviesRef = FirestoreForAll.instance.collection('movies').withConverter<User>(
fromFirestore: (snapshot, _) => User.fromJson(snapshot.map!),
toFirestore: (movie, _) => movie.toJson(),
);
copied to clipboard
// Obtain 31 aged users
List<DocumentSnapshotForAll<User>> users = await userRef
.where('age', isEqualTo: 31)
.get()
.then((snapshot) => snapshot.docs);

// Add a user
await userRef.add(
User(
name: 'Chris',
surname: 'Doe',
age: 20
),
);

// Get a user with the id 42
User user = await userRef.doc('42').get().then((snapshot) => snapshot.data()!);
copied to clipboard
Cloud Storage #
Upload Files #
Upload from a file
final storageRef = FirebaseStorageForAll.instance.ref();
final mountainsRef = storageRef.child("mountains.jpg");
Directory appDocDir = await getApplicationDocumentsDirectory();
String filePath = '${appDocDir.absolute}/file-to-upload.png';
File file = File(filePath);

UploadTaskForAll task= mountainsRef.putFile(file);
copied to clipboard
Upload from a String
String dataUrl = 'data:text/plain;base64,SGVsbG8sIFdvcmxkIQ==';
UploadTaskForAll task= mountainsRef.putString(dataUrl, format: PutStringFormat.dataUrl);
copied to clipboard
Uploading raw data
UploadTaskForAll task= mountainsRef.putData(file.readAsBytesSync());
copied to clipboard
Get Download Url
await mountainsRef.getDownloadURL();
copied to clipboard
Manage Uploads #
File file = File(filePath);
mountainsRef.putFile(file).snapshotEvents.listen((taskSnapshot) {
switch (taskSnapshot.state) {
case TaskState.running:
// ...
break;
case TaskState.paused:
// ...
break;
case TaskState.success:
// ...
break;
case TaskState.canceled:
// ...
break;
case TaskState.error:
// ...
break;
}
});
copied to clipboard
Download Files #
Download in memory #
final storageRef = FirebaseStorageForAll.instance.ref();
final islandRef = storageRef.child("images/island.jpg");
const oneMegabyte = 1024 * 1024;
final Uint8List? data = await islandRef.getData(oneMegabyte);
copied to clipboard
Download to a local file #
final islandRef = storageRef.child("images/island.jpg");

final appDocDir = await getApplicationDocumentsDirectory();
final filePath = "${appDocDir.absolute}/images/island.jpg";
final file = File(filePath);

DownloadTaskForAll downloadTask = await islandRef.writeToFile(file);
copied to clipboard
Manage Downloads #
downloadTask.snapshotEvents.listen((taskSnapshot) {
switch (taskSnapshot.state) {
case TaskState.running:
// TODO: Handle this case.
break;
case TaskState.paused:
// TODO: Handle this case.
break;
case TaskState.success:
// TODO: Handle this case.
break;
case TaskState.canceled:
// TODO: Handle this case.
break;
case TaskState.error:
// TODO: Handle this case.
break;
}
});
copied to clipboard
Delete File #
final desertRef = storageRef.child("images/desert.jpg");
await desertRef.delete();
copied to clipboard
List all files #
final storageRef = FirebaseStorage.instance.ref().child("files/uid");
final listResult = await storageRef.listAll();
for (var prefix in listResult.prefixes) {
// The prefixes under storageRef.
// You can call listAll() recursively on them.
}
for (var item in listResult.items) {
// The items under storageRef.
}
copied to clipboard
New Features #
StorageFile #
class StorageFile{
String cloudPath;
String fileName;
StorageRef reference;
String type,extension;
List<String> relatedDirs;
int size;
}
copied to clipboard
StorageDirectory #
class StorageDirectory{
String cloudPath;
String dirName;
StorageRef reference;
List<String> relatedDirs;
}
copied to clipboard
New Function - getFiles() #
This function is to get information of every files inside reference path
List<StorageFile> files = await storageRef.getFiles();
copied to clipboard
New Function - getSize() #
This function is to get the file size
final desertRef = FirebaseStorageForAll.instance.ref().child("images/desert.jpg");

int size = await desertRef.getSize();
copied to clipboard
New Function - getDirectories() #
This function is to get information of every directories inside reference path
List<StorageDirectory> files = await storageRef.getDirectories();
copied to clipboard
New Function - getDirSize() #
This function is to get the file size
final storageRef = FirebaseStorageForAll.instance.ref().child("files/uid");

int size = await storageRef.getDirSize();
copied to clipboard