Firebase Admin Node.js SDK Release Notes

To see release notes for the Firebase console and for other Firebase platforms and related SDKs, see the Firebase Release Notes.

Version 5.1.0 - July 25, 2017

Authentication

  • feature Added the method getUserByPhoneNumber() to the admin.auth interface. This method enables retrieving user profile information by a phone number.
  • feature createUser() and updateUser() methods now accept a phoneNumber property, which can be used to create users with a phone number field and/or update the phone number associated with a user.
  • feature Added the phoneNumber field to admin.auth.UserRecord, which exposes the phone number associated with a user account.
  • feature Added the phoneNumber field to admin.auth.UserInfo, which exposes the phone number associated with a user account by a linked identity provider.

Version 5.0.1 - July 12, 2017

  • fixed Improved the error messages thrown in the case of network and RPC errors. These errors now include outgoing HTTP request details that make it easier to localize and debug issues.

Authentication

  • fixed Implemented support in the user management API for handling photo URLs with special characters.

Version 5.0.0 - May 17, 2017

Initialization

  • fixed The deprecated serviceAccount property in the admin.App.Options type has been removed in favor of the credential property.
  • fixed Initializing the SDK without setting a credential results in an exception.
  • fixed Initializing the SDK with a malformed private key string results in an exception.

Authentication

  • fixed createdAt and lastSignedInAt properties in admin.auth.UserMetadata have been renamed to creationTime and lastSignInTime. Also these properties now provide UTC formatted strings instead of Date values.

Version 4.2.1 - April 12, 2017

  • fixed Updated the SDK to periodically refresh the OAuth access token internally used by FirebaseApp. This reduces the number of authentication failures encountered at runtime by SDK components like Realtime Database.

Version 4.2.0 - April 04, 2017

Cloud Messaging

Version 4.1.4 - March 28, 2017

Authentication

  • fixed Cleaned up a number of types to improve the log output, thereby making debugging easier.

Realtime Database

  • fixed Fixed an issue which could cause infinite loops when using push() with no arguments.

Version 4.1.3 - March 7, 2017

  • fixed Fixed incorrect usage of undefined - as opposed to void - in several places in the TypeScript typings.
  • fixed Added missing properties to the TypeScript typings for DecodedIdToken.
  • fixed Fixed issues when using some types with the TypeScript strictNullChecks option enabled.
  • fixed Removed incorrect admin.Promise type from the TypeScript typings in favor of the Node.js built-in Promise type, which the SDK actually uses.
  • fixed Added error codes to all app-level errors. All errors in the SDK now properly implement the FirebaseError interface.
  • fixed Improved error handling when initializing the SDK with a credential that cannot generate valid access tokens.
  • feature Added new admin.database.EventType to the TypeScript typings.

Realtime Database

  • fixed Improved how the Realtime Database reports errors when provided with various types of invalid credentials.

Version 4.1.2 - March 2, 2017

Authentication

  • fixed Improved input validation and error messages for all user management methods.
  • fixed verifyIdToken() now works with non-cert credentials, assuming the GCLOUD_PROJECT environment variable is set to your project ID, which is the case when running on Google infrastructure such as Google App Engine and Google Compute Engine.

Realtime Database

  • fixed Added toJSON() methods to the DataSnapshot and Query objects to make them properly JSON-serializable.

Cloud Messaging

Version 4.1.1 - February 14, 2017

  • fixed Added in missing TypeScript typings for the FirebaseError.toJSON() method.

Authentication

  • fixed Fixed issue with createUser() which sometimes caused multiple users to share the same email.

Version 4.1.0 - February 2, 2017

  • fixed Added in missing TypeScript typings for the toJSON() method off of several objects.

Cloud Messaging

Version 4.0.6 - January 24, 2017

Initialization

  • fixed Fixed an issue which caused importing the library via the ES2015 import syntax (import * as admin from "firebase-admin") to not work properly.

Version 4.0.5 - January 17, 2017

  • fixed TypeScript support has been greatly improved. Typings for the Realtime Database are now available and all other known issues with incorrect or incomplete type information have been resolved.

Initialization

  • fixed Fixed an issue which caused the SDK to appear to hang when provided with a credential that generated invalid access tokens. The most common cause of this was using a credential whose access had been revoked. Now, an error will be logged to the console in this scenario.

Authentication

  • feature The error message for an auth/internal-error error now includes the raw server response to more easily debug and track down unhandled errors.
  • fixed Fixed an issue that caused an auth/internal-error error to be thrown when calling getUser() or getUserByEmail() for a user without a creation date.
  • fixed Fixed an issue which caused an auth/internal-error error to be thrown when calling createUser() with an email that corresponds to an existing user.
  • fixed Fixed an issue which caused an auth/internal-error error to be thrown when calling Authentication methods with a credential with insufficient permission. Now, an auth/insufficient-permission error will be thrown instead.

Version 4.0.4 - December 6, 2016

Authentication

  • fixed Fixed an issue that caused several Authentication methods to throw an error when provided with inputs containing Unicode characters.

Version 4.0.3 - November 21, 2016

Initialization

  • fixed Fixed an issue that caused a null value for the databaseAuthVariableOverride property to be ignored when passed as part of the first argument to initializeApp(), which caused the app to still have full admin access. Now, passing this value has the expected behavior: the app has unauthenticated access to the Realtime Database, and behaves as if no user is logged into the app.

Authentication

  • fixed Fixed an issue that caused an auth/invalid-uid error to be thrown for valid uid values passed to several Authentication methods.

Version 4.0.2 - November 15, 2016

  • feature Improved error messages throughout the Admin Node.js SDK.
  • fixed Upgraded dependencies so that the Admin Node.js SDK no longer throws warnings for using deprecated Buffer APIs in Node.js 7.x.x.

Version 4.0.1 - November 9, 2016

  • fixed Fixed issue which caused the 4.0.0 release to not include the README.md and npm-shrinkwrap.json files.

Version 4.0.0 - November 7, 2016

  • feature The Admin Node.js SDK (available on npm as firebase-admin) is a new SDK which replaces and expands the admin capabilities of the standard firebase npm module. See Add the Firebase Admin SDK to your Server to get started.
  • issue This version does not include the README.md and npm-shrinkwrap.json files. This was fixed in version 4.0.1.

Initialization

Authentication

  • feature A new Admin API for managing your Firebase Authentication users is now available. This API lets you manage your users without using their existing credentials, and without worrying about client-side rate limiting. The new methods included in this API are getUser(), getUserByEmail(), createUser(), updateUser(), and deleteUser(). See Manage Users for more details.
  • changed The createCustomToken() method is now asynchronous, returning a Promise<string> instead of a string.

Send feedback about...

Need help? Visit our support page.