Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/invertase/dart_firebase_admin
🔥 A Firebase Admin SDK for Dart.
https://github.com/invertase/dart_firebase_admin
dart firebase
Last synced: 4 days ago
JSON representation
🔥 A Firebase Admin SDK for Dart.
- Host: GitHub
- URL: https://github.com/invertase/dart_firebase_admin
- Owner: invertase
- License: apache-2.0
- Created: 2022-02-10T11:52:30.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-11T09:34:16.000Z (2 months ago)
- Last Synced: 2024-09-11T13:10:49.197Z (2 months ago)
- Topics: dart, firebase
- Language: Dart
- Homepage:
- Size: 277 KB
- Stars: 117
- Watchers: 12
- Forks: 29
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## Dart Firebase Admin
Welcome! This project is a port of [Node's Firebase Admin SDK](https://github.com/firebase/firebase-admin-node) to Dart.
⚠️ This project is still in its early stages, and some features may be missing or bugged.
Currently, only Firestore is available, with more to come (auth next).
- [Dart Firebase Admin](#dart-firebase-admin)
- [Getting started](#getting-started)
- [Connecting to the SDK](#connecting-to-the-sdk)
- [Connecting using the environment](#connecting-using-the-environment)
- [Connecting using a `service-account.json` file](#connecting-using-a-service-accountjson-file)
- [Firestore](#firestore)
- [Usage](#usage)
- [Supported features](#supported-features)
- [Auth](#auth)
- [Usage](#usage-1)
- [Supported features](#supported-features-1)
- [Available features](#available-features)
- [Messaging](#messaging)
- [Usage](#usage-2)
- [Supported features](#supported-features-2)
## Getting started
### Connecting to the SDK
Before using Firebase, we must first authenticate.
There are currently two options:
- You can connect using environment variables
- Alternatively, you can specify a `service-account.json` file
#### Connecting using the environment
To connect using environment variables, you will need to have
the [Firebase CLI](https://firebaseopensource.com/projects/firebase/firebase-tools/) installed.
Once done, you can run:
```sh
firebase login
```
And log-in to the project of your choice.
From there, you can have your Dart program authenticate
using the environment with:
```dart
import 'package:dart_firebase_admin/dart_firebase_admin.dart';
void main() {
final admin = FirebaseAdminApp.initializeApp(
'',
// This will obtain authentication information from the environment
Credential.fromApplicationDefaultCredentials(),
);
// TODO use the Admin SDK
final firestore = Firestore(admin);
firestore.doc('hello/world').get();
}
```
#### Connecting using a `service-account.json` file
Alternatively, you can choose to use a `service-account.json` file.
This file can be obtained in your firebase console by going to:
```
https://console.firebase.google.com/u/0/project//settings/serviceaccounts/adminsdk
```
Make sure to replace `` with the name of your project.
One there, follow the steps and download the file. Place it anywhere you want in your project.
**⚠️ Note**:
This file should be kept private. Do not commit it on public repositories.
After all of that is done, you can now authenticate in your Dart program using:
```dart
import 'package:dart_firebase_admin/dart_firebase_admin.dart';
Future main() async {
final admin = FirebaseAdminApp.initializeApp(
'',
// Log-in using the newly downloaded file.
Credential.fromServiceAccount(
File(''),
),
);
// TODO use the Admin SDK
final firestore = Firestore(admin);
firestore.doc('hello/world').get();
// Don't forget to close the Admin SDK at the end of your "main"!
await admin.close();
}
```
## Firestore
### Usage
First, make sure to follow the steps on [how to authenticate](#connecting-to-the-sdk).
You should now have an instance of a `FirebaseAdminApp` object.
You can now use this object to create a `Firestore` object as followed:
```dart
// Obtained in the previous steps
FirebaseAdminApp admin;
final firestore = Firestore(admin);
```
From this point onwards, using Firestore with the admin ADK
is roughly equivalent to using [FlutterFire](https://github.com/firebase/flutterfire).
Using this `Firestore` object, you'll find your usual collection/query/document
objects.
For example you can perform a `where` query:
```dart
// The following lists all users above 18 years old
final collection = firestore.collection('users');
final adults = collection.where('age', WhereFilter.greaterThan, 18);
final adultsSnapshot = await adults.get();
for (final adult in adultsSnapshot.docs) {
print(adult.data()['age']);
}
```
Composite queries are also supported:
```dart
// List users with either John or Jack as first name.
firestore
.collection('users')
.whereFilter(
Filter.or([
Filter.where('firstName', WhereFilter.equal, 'John'),
Filter.where('firstName', WhereFilter.equal, 'Jack'),
]),
);
```
Alternatively, you can fetch a specific document too:
```dart
// Print the age of the user with ID "123"
final user = await firestore.doc('users/123').get();
print(user.data()?['age']);
```
### Supported features
| Firestore | |
| ------------------------------------------------ | --- |
| firestore.listCollections() | ✅ |
| reference.id | ✅ |
| reference.listCollections() | ✅ |
| reference.parent | ✅ |
| reference.path | ✅ |
| reference.== | ✅ |
| reference.withConverter | ✅ |
| collection.listDocuments | ✅ |
| collection.add | ✅ |
| collection.get | ✅ |
| collection.create | ✅ |
| collection.delete | ✅ |
| collection.set | ✅ |
| collection.update | ✅ |
| collection.collection | ✅ |
| query.where('field', operator, value) | ✅ |
| query.where('field.path', operator, value) | ✅ |
| query.where(FieldPath('...'), operator, value) | ✅ |
| query.whereFilter(Filter.and(a, b)) | ✅ |
| query.whereFilter(Filter.or(a, b)) | ✅ |
| query.startAt | ✅ |
| query.startAtDocument | ✅ |
| query.startAfter | ✅ |
| query.startAfterDocument | ✅ |
| query.endAt | ✅ |
| query.endAtDocument | ✅ |
| query.endAfter | ✅ |
| query.endAfterDocument | ✅ |
| query.select | ✅ |
| query.orderBy | ✅ |
| query.limit | ✅ |
| query.limitToLast | ✅ |
| query.offset | ✅ |
| querySnapshot.docs | ✅ |
| querySnapshot.readTime | ✅ |
| documentSnapshots.data | ✅ |
| documentSnapshots.readTime/createTime/updateTime | ✅ |
| documentSnapshots.id | ✅ |
| documentSnapshots.exists | ✅ |
| documentSnapshots.data | ✅ |
| documentSnapshots.get(fieldPath) | ✅ |
| FieldValue.documentId | ✅ |
| FieldValue.increment | ✅ |
| FieldValue.arrayUnion | ✅ |
| FieldValue.arrayRemove | ✅ |
| FieldValue.delete | ✅ |
| FieldValue.serverTimestamp | ✅ |
| collectionGroup | ✅ |
| GeoPoint | ✅ |
| Timestamp | ✅ |
| querySnapshot.docsChange | ⚠️ |
| query.onSnapshot | ❌ |
| runTransaction | ❌ |
| BundleBuilder | ❌ |
## Auth
### Usage
First, make sure to follow the steps on [how to authenticate](#connecting-to-the-sdk).
You should now have an instance of a `FirebaseAdminApp` object.
You can now use this object to create a `Auth` object as followed:
```dart
// Obtained in the previous steps
FirebaseAdminApp admin;
final auth = Auth(admin);
```
You can then use this `Auth` object to perform various
auth operations. For example, you can generate a password reset link:
```dart
final link = await auth.generatePasswordResetLink(
'[email protected]',
);
```
### Supported features
## Available features
| Auth | |
| ------------------------------------- | --- |
| auth.tenantManager | ❌ |
| auth.projectConfigManager | ❌ |
| auth.generatePasswordResetLink | ✅ |
| auth.generateEmailVerificationLink | ✅ |
| auth.generateVerifyAndChangeEmailLink | ✅ |
| auth.generateSignInWithEmailLink | ✅ |
| auth.listProviderConfigs | ✅ |
| auth.createProviderConfig | ✅ |
| auth.updateProviderConfig | ✅ |
| auth.getProviderConfig | ✅ |
| auth.deleteProviderConfig | ✅ |
| auth.createCustomToken | ✅ |
| auth.setCustomUserClaims | ✅ |
| auth.verifyIdToken | ✅ |
| auth.revokeRefreshTokens | ✅ |
| auth.createSessionCookie | ✅ |
| auth.verifySessionCookie | ✅ |
| auth.importUsers | ✅ |
| auth.listUsers | ✅ |
| auth.deleteUser | ✅ |
| auth.deleteUsers | ✅ |
| auth.getUser | ✅ |
| auth.getUserByPhoneNumber | ✅ |
| auth.getUserByEmail | ✅ |
| auth.getUserByProviderUid | ✅ |
| auth.getUsers | ✅ |
| auth.createUser | ✅ |
| auth.updateUser | ✅ |
## Messaging
### Usage
First, make sure to follow the steps on [how to authenticate](#connecting-to-the-sdk).
You should now have an instance of a `FirebaseAdminApp` object.
Then, you can create an instance of `Messaging` as followed:
```dart
// Obtained in the previous steps
FirebaseAdminApp admin;
final messaging = Messaging(messaging);
```
You can then use that `Messaging` object to interact with Firebase Messaging.
For example, if you want to send a notification to a specific device, you can do:
```dart
await messaging.send(
TokenMessage(
// The token of the targeted device.
// This token can be obtain by using FlutterFire's firebase_messaging:
// https://pub.dev/documentation/firebase_messaging/latest/firebase_messaging/FirebaseMessaging/getToken.html
token: "",
notification: Notification(
// The content of the notification
title: 'Hello',
body: 'World',
),
),
);
```
### Supported features
| Messaging | |
| ------------------------------ | --- |
| Messaging.send | ✅ |
| Messaging.sendEach | ✅ |
| Messaging.sendEachForMulticast | ✅ |
| Messaging.subscribeToTopic | ❌ |
| Messaging.unsubscribeFromTopic | ❌ |
| TokenMessage | ✅ |
| TopicMessage | ✅ |
| ConditionMessage | ✅ |
| Messaging.sendAll | ❌ |
| Messaging.sendMulticast | ❌ |
---
Built and maintained by Invertase.