SDK Download

Version 3.8.1 - Aug 25, 2017
We recommend you use our CDN to include the latest version.
or download the library directly
Download

Changelog

Want to see how the rest of your backend is evolving? Check out the timeline.

Our SDKs are now open source! If you'd like to contribute code, suggest improvements or just take a look at how things work, check out the source on github.

3.8.1
- Aug 25, 2017

  • Fixed: Kinvey.initialize() fixed to resolve with either an instance of Kinvey.User or null.

3.8.0
- Aug 24, 2017

  • Added: Requests are logged using loglevel. Please refer to the Troubleshooting Guide for more information.
  • Added: Support for multiple MIC providers in a single app. The SDK adds a micId to the client_id value when it makes a request to authenticate with Mobile Identity Connect.
  • Added: Replace native node modules with npm packages.
  • Fixed: In previous SDK versions, the active user was read and stored asychronously using the storage adapter used to cache data loaded from the datastore. This caused us to make the initialization of the SDK asychronous to read the active user from storage. Some SDK environments do not work well with an asynchronous initialization process. To fix this problem each SDK can now override the storage location to make this process work correctly for that particular SDK. The Backbone SDK will store the active user in LocalStorage.
  • Fixed: Default to removing a user with hard equal to false. Please refer to the User Guide for more information.
  • Fixed: Throw any errors encountered when trying to load a storage adapter use to cache data loaded with a data store.
  • Deprecated: Kinvey.initialize() has been deprecated. Please use Kinvey.init() instead. Kinvey.init() does not return a promise.

Warning If you start using Kinvey.init() and have been using Kinvey.initialize() you will not have an active user anymore. You will need to migrate the active user to the new storage location by continuing to use Kinvey.initialize(). After the active user has been migrated you can replace Kinvey.initialize() with Kinviey.init(). You can also just logout using Kinvey.User.logout() and ask the user to login again.

// --------------------------------------------------
// Example code snippet on how to migrate active user.
// ---------------------------------------------------

var promise = Promise.resolve();

// Initialize the SDK using Kinvey.init()
Kinvey.init({
  appKey: '<appKey>',
  appSecret: '<appSecret>'
});

// Check if you have an active user.
if (!Kinvey.Backbone.User.getActiveUser()) {
  promise = Kinvey.initialize({
    appKey: '<appKey>',
    appSecret: '<appSecret>'
  });
}

promise
  .then(function() {
    // ...
  });

3.5.2
- Jul 8, 2017

  • Fixed: Allow special characters ('.', '$', '~', '>', '<', '!', '@') to be in the _id for an entity. #134
  • Fixed: Import es6-promise to prevent Promise Undefiend errors on environments that do not have a native promise implementation. #135
  • Fixed: Errors will now show the message property properly when logging errors to the console. #136
  • Fixed: Added a try/catch around openDatabase(). This allows any errors thrown when opening a new database connection to WebSQL be caught and used to reject the pending promise. #17

3.5.1
- Jun 30, 2017

  • Changed: https: will automatically be used when a custom hostname is missing a protocol. #129
  • Fixed: Prevent the active user from being null for a short period of time when setting the active user. #128
  • Added: usePopupClass() as a static function to the User class for registering a popup class to be used for MIC authentication.
  • Added: operation property to results returned when pushing sync items to the backend. The property either be equal to Kinvey.SyncOperation.Create, Kinvey.SyncOperation.Update, or Kinvey.SyncOperation.Delete.
var store = Kinvey.DataStore.collection('books', Kinvey.DataStoreType.Sync);
var query = new Kinvey.Query().equalTo('title', 'Kinvey');
store.remove(query)
  .then(function(response) {
    // response.count contains the count of books removed matching the query
    return store.push();
  })
  .then(function(results) {
    // Results is an array of responses from the pushing the sync items.
    // Each result object now contains an operation set to Kinvey.SyncOperation.Delete
  })
  • Changed: restore() static function on the User class to throw an error whenever it is called. This function required the master secret for an application. We strongly advise not to do this in your application.
  • Changed: All toJSON() functions have now been replaced by toPlainObject(). The returned result is the exact same.
  • Changed: save(), create(), and update() on datastore instances to no longer accept an array of entities. See the example below to see how to save an array of entities.
var books = [{ name: 'book1' }, { name: 'book2' }];
var store = Kinvey.DataStore.collection('books');
var promises = [];

// Loop through each of the books and save them one by one.
// You can now reference a book easily in the event an error
// occurs when saving a book.
books.forEach(function(book) {
  var promise = store.save(book)
    .catch(function(error) {
      console.log('Error saving book ' + book.name);
    });
  promises.push(promise);
});

// Using a third party library wait for all the promises to complete
RSVP.Promise.all(promises)
  .then(function(books) {
    // ...
  });
  • Changed: remove() and removeById() on datastore instances to now return the count of entities removed and not the actual entity removed.
var store = Kinvey.DataStore.collection('books');

// Remove books using a query
var query = new Kinvey.Query().equalTo('title', 'Kinvey');
store.remove(query)
  .then(function(response) {
    // response.count contains the count of books removed matching the query
  });

// Remove a book using an id
store.removeById('1')
  .then(function(response) {
    // response.count will equal 1 if the book was removed or 0 if the book was not removed
  });
  • Removed: init() static function on Kinvey namespace. This was deprecated with v3.3.3.
  • Removed: baseUrl, protocol, and host properties on a client instance. These were deprecated with v3.0.0.
  • Removed: syncCount() and purge() on CacheStore and SyncStore instances. These were deprecated with v3.2.0.
  • Removed Kinvey.Users and Kinvey.UserStore. These were deprecated with v3.2.0.

3.4.5
- Apr 13, 2017

JavaScript Full Changelog
Backbone Full Changelog

  • Share active user information with 1.x SDK. Just use version 3.4.5 to share active user information. No changes are needed to your 3.x application.
  • Use query to push a subset of sync entities to the backend. #120
  • Add more tests for query. #121
  • Allow multiple sync push operations to be in progress at the same time for difference collections.. Only one sync push operation is allowed to be in progress for the same collection. This fixes an issue caused with #117 that only allowed one sync push operation to be in progress regardless of the collection. #123

3.4.4
- Mar 27, 2017

JavaScript Full Changelog
Backbone Full Changelog

  • Don't perform a sync push operation while one is already in progress. #117
  • Use tls: true by default when fetching files. #118
  • Catch a NotFoundError thrown when trying to store an active user in the cache. #119
  • Close IndexedDB connection before deleting database. This fixes an issue that prevented a user from being logged out on IE. #14

3.4.1
- Feb 24, 2017

JavaScript Core Full Changelog
Backbone Full Changelog

  • Correctly refresh MIC sessions. #104
  • Add missing error objects. #105
  • Fixed a bug that prevented files from being uploaded to GCS. #106
  • Add more unit tests for user logout. #110

3.2.2
- Oct 26, 2016

  • Bugfix: Import UserStore from correct path. Kinvey.UserStore is now not undefined.
  • Bugfix: Add missing group function to Kinvey.Collection.
  • Bugfix: Fix typo of CacheRequest in Push module.

3.2.1
- Oct 17, 2016

  • Initial release.

Download Older Versions

We recommend using the latest version.

Version Download Date
3.8.1 Download Aug 25, 2017
3.8.0 Download Aug 24, 2017
3.5.2 Download Jul 8, 2017
3.5.1 Jun 30, 2017
3.4.5 Download Apr 13, 2017
3.4.4 Download Mar 27, 2017
3.4.1 Download Feb 24, 2017
3.2.2 Oct 26, 2016
3.2.1 Oct 17, 2016
Got a question?