Firedart 🔥🎯
A dart-native implementation of the Firebase Auth and Firestore SDKs.
This library attempts to minimize dependencies with the intention of making it able to run in any environment capable of executing dart code. Currently it has been successfully tested using the dart runtime (x86-64 and arm32) as well as on Flutter Android, iOS and Desktop.
Firedart currently implements a subset of Firebase Auth and Firestore.
Dependencies
Add Firedart to your pubspec.yaml file:
dependencies:
firedart: [latest version]
Firebase Auth
The FirebaseAuth class implements the necessary functionality for managing accounts. It currently only supports Email/Password sign-in and anonymous sign-in, so make sure these are enabled under Authentication -> Sign-in Method.
You'll also need to go to your Firebase Console, open Project Settings and under the General tab copy the Web API Key.
Note: in order to reduce external dependencies this library doesn't include a mechanism for persisting tokens. Please look at the following examples based on SharedPreferences and Hive.
Usage
import 'package:firedart/firedart.dart';
FirebaseAuth has a singleton version which should be enough for most use cases. You'll need to initialise it with your API key and a token store (see note above):
FirebaseAuth.initialize(apiKey, await HiveStore.create());
await FirebaseAuth.instance.signIn(email, password);
var user = await FirebaseAuth.instance.getUser();
Alternatively you can instantiate your own FirebaseAuth object:
var firebaseAuth = FirebaseAuth.(apiKey, await PreferencesStore());
await firebaseAuth.signIn(email, password);
var user = await firebaseAuth.getUser();
Further usage examples can be found in the integration tests.
Authentication providers
- Anonymous
- Email/Password
- Custom tokens
- Google app credentials (i.e. service-account.json)
Firestore
The Firestore class is a basic implementation of the service's RPC interface. The API is similar (but not identical) to that of the official SDK.
Usage
import 'package:firedart/firedart.dart';
As with FirebaseAuth, Firestore offers a singleton version that needs to be initialised with your Project ID, which you can find under Project Settings -> General:
Firestore.initialize(projectId);
var map = await Firestore.instance.collection("users").get();
var users = UserCollection.fromMap(map);
You can also instantiate your own Firestore object. Please note that if your database requires authenticated access, you'll need to pass along an instance of FirebaseAuth.
var firebaseAuth = FirebaseAuth.(apiKey, await HiveStore());
var auth = TokenAuthenticator.from(auth)?.authenticate;
var firestore = Firestore(projectId, authenticator: firebaseAuth);
await firebaseAuth.signIn(email, password);
var map = await firestore.collection("users").get();
var users = UserCollection.fromMap(map);
Further usage examples can be found in the integration tests.
Limitations
- Collection queries (limit, sort, etc.) are currently not supported.
- The data is not cached locally.
- Failed writes (e.g. due to network errors) are not retried.
- Closed streams are not automatically recovered.
Regenerating the RPC stubs
The Firestore RPC stubs are based on Google's official protobuf definition files from googleapis.
To regenerate them, you will need to check out both googleapis and protobuf.
Set the PROTOBUF and GOOGLEAPIS environment variables to point to your clones of the above repositories respectively, and then run:
$ tool/regenerate.sh
Debugging
For debugging Firebase Auth you can use VerboseClient, an HTTP client that logs all communication to the console. The logs can expose sensitive data including passwords and keys, so it's recommended to only enable it for development builds. In Flutter this can be achieved using the kReleaseMode constant from the foundation package:
var client = !kReleaseMode ? VerboseClient() : http.Client();
var firebaseAuth = FirebaseAuth(apiKey, await PreferencesStore(), httpClient: client);
Securing Tokens
If you're running your code in an environment that requires securing access tokens, you can extend TokenStore to persist data in a secure maner, e.g. by encrypting the data or storing it in an external vault. Example implementations can be found in token_store.dart.
Libraries
- generated/google/firestore/v1/aggregation_result.pb
- generated/google/firestore/v1/aggregation_result.pbenum
- generated/google/firestore/v1/aggregation_result.pbjson
- generated/google/protobuf/any.pb
- generated/google/protobuf/any.pbenum
- generated/google/protobuf/any.pbjson
- firestore/application_default_authenticator
- auth/auth_gateway
- generated/google/firestore/v1/bloom_filter.pb
- generated/google/firestore/v1/bloom_filter.pbenum
- generated/google/firestore/v1/bloom_filter.pbjson
- auth/client
- generated/google/firestore/v1/common.pb
- generated/google/firestore/v1/common.pbenum
- generated/google/firestore/v1/common.pbjson
- generated/google/firestore/v1/document.pb
- generated/google/firestore/v1/document.pbenum
- generated/google/firestore/v1/document.pbjson
- generated/google/protobuf/empty.pb
- generated/google/protobuf/empty.pbenum
- generated/google/protobuf/empty.pbjson
- auth/exceptions
- auth/firebase_auth
- firedart
- firestore/firestore
- generated/google/firestore/v1/firestore.pb
- generated/google/firestore/v1/firestore.pbenum
- generated/google/firestore/v1/firestore.pbgrpc
- generated/google/firestore/v1/firestore.pbjson
- firestore/firestore_gateway
- generated/google/type/latlng.pb
- generated/google/type/latlng.pbenum
- generated/google/type/latlng.pbjson
- firestore/models
- generated/google/firestore/v1/query.pb
- generated/google/firestore/v1/query.pbenum
- generated/google/firestore/v1/query.pbjson
- generated/google/rpc/status.pb
- generated/google/rpc/status.pbenum
- generated/google/rpc/status.pbjson
- generated/google/protobuf/struct.pb
- generated/google/protobuf/struct.pbenum
- generated/google/protobuf/struct.pbjson
- generated/google/protobuf/timestamp.pb
- generated/google/protobuf/timestamp.pbenum
- generated/google/protobuf/timestamp.pbjson
- firestore/token_authenticator
- auth/token_provider
- auth/token_store
- firestore/type_util
- auth/user_gateway
- generated/google/protobuf/wrappers.pb
- generated/google/protobuf/wrappers.pbenum
- generated/google/protobuf/wrappers.pbjson
- generated/google/firestore/v1/write.pb
- generated/google/firestore/v1/write.pbenum
- generated/google/firestore/v1/write.pbjson