firebase 4.1.0

Dart wrapper library for the new Firebase

Build Status

This is a Dart wrapper library for the new Firebase. If you are using Dart to write Flutter apps, consider using the FlutterFire plugins instead.

You can find more information on how to use Firebase on the Getting started page.

Don't forget to setup correct rules for your realtime database and/or storage in the Firebase console.

Authentication also has to be enabled in the Firebase console. For more info, see the next section in this document.

Usage

Installation

Install the library from the pub or Github:

dependencies:
  firebase: '^4.0.0'

Include Firebase source

You must include the original Firebase JavaScript source into your .html file to be able to use the library.

<script src="https://www.gstatic.com/firebasejs/4.2.0/firebase.js"></script>

Use it

import 'package:firebase/firebase.dart' as fb;

void main() {
  fb.initializeApp(
    apiKey: "YourApiKey",
    authDomain: "YourAuthDomain",
    databaseURL: "YourDatabaseUrl",
    storageBucket: "YourStorageBucket");

  fb.Database database = fb.database();
  fb.DatabaseReference ref = database.ref("messages");

  ref.onValue.listen((e) {
    fb.DataSnapshot datasnapshot = e.snapshot;
    // Do something with datasnapshot
  });
}

IO Client

This library also contains an IO client. Create an instance of FirebaseClient and then use the appropriate method (GET, PUT, POST, DELETE or PATCH). More info in the official documentation.

The IO client also supports authentication. See the documentation on how to get auth credentials.

import 'package:firebase/firebase_io.dart';

void main() {
  var credential = ... // Retrieve auth credential
  var fbClient = new FirebaseClient(credential); // FirebaseClient.anonymous() is also available
  
  var path = ... // Full path to your database location with .json appended
  
  // GET
  var response = await fbClient.get(path);
  
  // DELETE
  await fbClient.delete(path);
  
  ...
}

Examples

You can find more examples on realtime database, auth and storage in the example folder.

Dart Dev Summit 2016 demo app

Demo app which uses Google login, realtime database and storage.

Before tests and examples are run

You need to ensure a couple of things before tests and examples in this library are run.

All tests and examples

Create config.json file (see config.json.sample) in lib/src/assets folder with configuration for your Firebase project.

To run the io tests, you need to provide the service_account.json file. Go to Settings/Project settings/Service accounts tab in your project's Firebase console, select the Firebase Admin SDK and click on the Generate new private key button, which downloads you a file. Rename the file to service_account.json and put it into the lib/src/assets folder.

Warning: Use the contents of lib/src/assets is only for development and testing this package.

App tests

No special action needed here.

Auth tests and example

Auth tests and some examples need to have Auth providers correctly set. The following providers need to be enabled in Firebase console, Auth/Sign-in method section:

  • E-mail/password
  • Anonymous
  • Phone

Database tests and example

Database tests and example need to have public rules to be able to read and write to database. Update your rules in Firebase console, Database/Rules section to:

{
  "rules": {
    ".read": true,
    ".write": true
  }
}

Warning: At the moment, anybody can read and write to your database. You usually don't want to have this in your production apps. You can find more information on how to setup correct database rules in the official Firebase documentation.

Storage tests and example

Storage tests and example need to have public rules to be able to read and write to storage. Update your rules in Firebase console, Storage/Rules section to:

service firebase.storage {
  match /b/YOUR_STORAGE_BUCKET_URL/o {
    match /{allPaths=**} {
      allow read, write;
    }
  }
}

Warning: At the moment, anybody can read and write to your storage. You usually don't want to have this in your production apps. You can find more information on how to setup correct storage rules in the official Firebase documentation.

Bugs

If you find a bug, please file an issue.

4.1.0

  • Upgraded to Firebase JS API 4.2.0.
  • Added toJson to DataSnapshot and Query.
  • Auth:
    • Implemented PhoneAuthProvider and RecaptchaVerifier.
  • User:
    • Added phoneNumber property to the UserInfo.
    • Added linkWithPhoneNumber, updatePhoneNumber and reauthenticateWithPhoneNumber methods.
  • New example demonstrating PhoneAuthProvider functionality in example/auth_phone.
  • Added more tests for V4 API.

4.0.0

  • Upgraded to Firebase JS API 4.1.3.

  • Breaking changes

    • The value in Auth.onAuthStateChanged is now User. AuthEvent has been removed.

  • Removed deprecated APIs:

    • User
      • link method in favor of linkWithCredential.
      • reauthenticate method in favor of reauthenticateWithCredential.
    • AuthCredential
      • provider property in favor of providerId.

  • User: added getIdToken, reauthenticateAndRetrieveDataWithCredential, linkAndRetrieveDataWithCredential, and toJson().

  • Auth: added signInAndRetrieveDataWithCredential and onIdTokenChanged.

3.2.1

  • Update minimum Dart SDK to 1.21.0 – required to use generic method syntax.

3.2.0

  • The FirebaseJsNotLoadedException is thrown when the firebase.js script is not included in the html file.

  • Fix to support dartdevc.

3.1.0

  • Updates from the Firebase 3.8.0 and 3.9.0 in auth library:
    • User
      • Deprecated link method in favor of linkWithCredential.
      • Deprecated reauthenticate method in favor of reauthenticateWithCredential.
      • Added new reauthenticateWithPopup and reauthenticateWithRedirect methods.
    • UserCredential
      • Added new operationType property.
    • AuthCredential
      • Deprecated provider property in favor of providerId.
  • The app.storage() has now an optional storage bucket parameter.

3.0.2

  • Throw FirebaseClientException if there are request failures in firebase_io.dart.
  • Fix provider's addScope and setCustomParameters methods return types.
  • Support the latest release of pkg/func.

3.0.1

  • Updated documentation and tests to reference the latest JS release: 3.7.2

  • Improvements to README.md

3.0.0

  • Completely rewritten for Firebase v3.

0.6.6+3

  • Support crypto 2.0.0.

0.6.6+2

  • Strong-mode clean.

  • Doc fixes.

0.6.6+1

  • Support non-integer values for priority in set operations.

0.6.6

  • Support latest version of pkg/crypto

  • Support latest version of firebase.js - 2.4.2

0.6.5+1

  • Fixed FirebaseClient.post to use POST.

0.6.5

  • Added FirebaseClient.post to firebase_io.dart.

0.6.4

  • Added Firebase.ServerValue.TIMESTAMP constant

0.6.3

  • Added onComplete argument to Firebase.push.

0.6.2

  • Fix an issue calling push with a Map.

  • Fixed the return type of Firebase.onAuth. Also made the returned Stream asynchronous.

0.6.1

  • Added anonymous constructor to FirebaseClient.

  • Added firebase_io.dart library.

    • createFirebaseJwtToken can be used for authentication.
    • The FirebaseClient class is a simple wrapper for the Firebase REST API.

  • Added encodeKey and decodeKey methods to firebase.dart and firebas_io.dart. Convenience methods for dealing with key values with disallowed characters.

0.6.0

  • Removed deprecated name property on Firebase and Snapshot. Use key instead`.

  • Removed deprecated limit method on Firebase. Use limitToFirst and limitToLast instead.

0.5.1

  • Updated startAt() and endAt() methods. They don't take a priority anymore and are meant to be used in conjunction with orderBy*

0.5.0

  • Added authWithOAuthToken()

  • Changed return value of auth methods to return a native dart Map object containing all authData. This is a breaking change.

0.4.0

  • Updated for Firebase api v2.2.2

  • Deprecated name getter on Firebase and DataSnapshot

  • Added key getter on Firebase and DataSnapshot, replacing name

  • Added changeEmail()

  • Added authAnonymously(), authWithOAuthPopup(), authWithOAuthRedirect()

  • Added getAuth() and onAuth() listener

  • Added orderByChild(), orderByKey(), orderByValue(), orderByPriority()

  • Added equalTo(), limitToFirst(), limitToLast()

  • Deprecated limit on Query object

  • Added exists getter to DataSnapshot

  • Added several tests

0.3.0

  • Add createUser(), removeUser() and authWithPassword() (thanks to wilsynet)
  • AuthResponse.auth was changed to type JsObject

0.2.1

  • Added new authWithCustomToken method (thanks to rayk)
  • Deprecate auth

0.2.0+1

  • Updated README to include latest firebase.js link.

0.2.0

  • A number of breaking changes and updates.

  • A number of methods are now properties.

0.1.1+3

  • Fixed up tests.

  • Cleaned up library structure.

1. Depend on it

Add this to your package's pubspec.yaml file:

dependencies:
  firebase: "^4.1.0"

2. Install it

You can install packages from the command line:

$ pub get

Alternatively, your editor might support 'pub get'. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use: 

import 'package:firebase/firebase.dart';

About

Dart libraries for Firebase

Author

Email jana.moudra@gmail.com Jana Moudra
Email kevmoo@google.com Kevin Moore

Homepage

github.com/firebase/firebase-dart

Documentation

www.dartdocs.org/documentation/firebase/4.1.0/

Source code (hyperlinked)

www.crossdart.info/p/firebase/4.1.0/

Uploader

sethladd@google.com
andrew@firebase.com
kevmoo@google.com

Published

Aug 3, 2017

Share