Kinvey SDK Download

npm install kinvey-node-sdk

Changelog

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

7.0.0

- Jul 15, 2022

• Clear session on InvalidCredentials error or MIC token refresh failure #638

6.0.3

- Jul 14, 2022

• Fixed behaviour when refreshing KCS tokens. a49b215
• Do not save refresh_token returned from _me endpoint. 3201bfa

6.0.2

- Apr 28, 2022

• Update package kinvey-js-sdk which fixed a bug when registering for Live service

6.0.1

- Apr 27, 2022

• Update dependencies to fix known vulnerabilities

6.0.0

- Jul 30, 2021

• Introduce MFA functionality. #593
• Improve the login process. #592
• Change the default API version to 6. #602
• Implement async SessionStore API. #598
• Do not use the authToken in me() method. #596
• Remove the option to set active user on signup. #616

5.1.4

- Jun 18, 2022

• Fix refresh token not being regenerated when using multiple devices

5.1.2

- May 26, 2022

• Update package kinvey-js-sdk to fix an issue with sporadic logouts

5.1.1

- Apr 12, 2021

• Fixed: The pull function returns an error with Auto store when called with autoPagination: true and there are no items. #590

5.1.0

- Apr 8, 2021

• Fixed: Auto DataStore disregards skip and limit and fetches up to 10000 items per call. #581

5.0.1

- Jul 22, 2020

• Multi Insert validations. #569

5.0.0

- Jul 10, 2020

• Introducing the Multi Insert functionality.
• Update the default KCS api version to 5. #566
• Add lastLoginTime to Kinvey metadata. #562

4.2.3

- Jul 22, 2019

• Fixed: Added validation for User signup(). #430
• Fixed: Added signup() as an instance function on the User class. #431

4.2.2

- Jul 5, 2019

• Fixed: Change auto protocol from https to https:. #423
• Fixed: Verify arguments for query.ascending() and query.descending(). #424
• Fixed: Verify arguments for query.exists(). #425
• Fixed: Verify arguments for query.notContainedId(). #426
• Fixed: Verify arguments for query.notEqualTo(). #427
• Fixed: Verify arguments for query.or(), query.and(), and query.nor(). #428

4.2.1

- Jun 19, 2019

• Fixed: Added a default version to all MIC API requests. #415

4.2.0

- Jun 7, 2019

• Fixed: A TimeoutError is will be thrown when a request times out.
• Enhancement: Added support for mulit-insert to the Network datastore type. #414

// You will need to set the API version to 5 when you initialize the SDK
Kinvey.init({
  appKey: '<appKey>',
  appSecret: '<appSecret>',
  apiVersion: 5
});

// Insert an array of books using the new multi insert API
const newBooks = [
  { title: 'Kinvey' },
  { title: 'Progress' }
];
const store = Kinvey.DataStore.collection('Books', Kinvey.DataStoreType.Network);
await store.save(newBooks);

4.1.0

- May 31, 2019

• Fixed: init() returns some missing properties that were returned in v3.x. #411
• Enhancement: Add Auto datastore type. This new datastore type prioritzes using the network first. If a network connection is not available then it will fall back to using the local cache until a network connection is re-established. #409
• Deprecated: We have deprecated the Cache datastore type. You should now use the Auto datastore type to instead.
• Deprecated: We have deprecated the use of initialize() to initialize the SDK. You should use init() instead.

4.0.0

- May 3, 2019

• Changed: All errors are available under the Errors namespace. Take a look at our Troubleshooting Guide on how to use errors.

3.12.4

- Feb 12, 2019

• Fixed: Prevent duplicate Live Service messages after a reconnection is made to PubNub. #389

3.12.2

- Nov 2, 2018

• Enhancement: Allow loginWithMIC() to work properly when viewing a NativeScript application with the NativeScript Preview App. #377
• Fixed: Use default AuthorizationGrant if null is provded to loginWithMIC(). #372
• Fixed: Merge _socialIdentity properly with response from /me endpoint. #374 #375
• Fixed: Return the correct error message if Files.findById() is called without a file id. #373

3.12.0

- Oct 3, 2018

• Fixed: Send custom properties to the backend using the x-kinvey-custom-request-properties header when creating an entity. #360

3.11.7

- Sep 20, 2018

• Fixed: Update rxjs to 6.x. #353
• Enhancement: Add new defice info header. #343

3.11.6

- Aug 2, 2018

• Fixed: Return response from backend when calling datastore.find(). #342
• Enhancement: Updated rxjs to 6.x. #340

3.11.5

- Jul 25, 2018

• Fixed: The error returned from the server when Kinvey.Files.downloadByUrl() fails is now thrown properly. #333
• Fixed: An error is not thrown when trying to upload a file and no metadata is provided. #334
• Changed: A query is not longer accepted to push a subset of items to the backend. #331

3.11.4

- Jul 9, 2018

• Fixed: Use correct Authorization header value when sending a request to refresh a MIC access token. #315
• Fixed: Queue network requests while in the middle of refreshing a MIC access token. This prevents other requests from invalidating the newly refreshed access token. #321

3.11.3

- Jun 29, 2018

• Enhancement: Calculate and validate file size before uploading the file. Any size provided to Files.upload() will be overridden with the size calculated by the SDK. #313
• Fixed: Remove _kmd.local property on an entity before it is send to the backend. _kmd.local is a property created by the SDK used to track if an entity was created using the SDK. #310
• Fixed: The active user will no longer be removed if local storage is being used to cache data loaded with the DataStore and the cache is cleared. #311

3.11.2

- Jun 15, 2018

• Enhancement: Add support to handle Mobile Identity Connect OAuth errors in redirectUri response. #307

3.11.1

- Jun 1, 2018

• Fixed: When calling User.me() to update the active users data, any data that was deleted since the last call will also be removed from the active user stored on the device. #299
• Fixed: Any error thrown in the onNext function while using an observable will cause the onError function to be called with the thrown error. The subscriber will also be unsubscribed from the observable. #302

3.11.0

- May 23, 2018

• Enhancement: Add support for Server Side Delta Set. #270

var datastore = Kinvey.DataStore.collection('books');

// Turn on for datastore instance
datastore.useDeltaSet = true; // Default is false

// Pass options.useDeltaSet to override datastore default for a pull() request.
// It will use value of datastore.useDeltaSet as default.
var promise = datastore.pull(query, { useDeltaSet: true });

// Pass options.useDeltaSet to override datastore default for a pull() request.
// It will use value of datastore.useDeltaSet as default.
var promise = datastore.find(query, { useDeltaSet: true });

3.10.3

- May 4, 2018

• Fixed: Add support for kinveyFileTTL and kinveyFileTLS query parameters for KinveyFile references on a DataStore collection. #289

var dataStore = Kinvey.DataStore.collection('pets');
dataStore.findById('3f583e9f-d064-4a25-a953-6cf0a3dc2ff1', { kinveyFileTTL: 3600, kinveyFileTLS: true })
  .subscribe(function(pet) {
    /*
      {
        "_id": "3f583e9f-d064-4a25-a953-6cf0a3dc2ff1",
        "_acl": {...},
        "dogName": "Bob",
        "furColor": "brown with black spots",
        "pawPrintPicture": {
          "_type": "KinveyFile",
          "_id": "325620e4-93dd-4a26-9f84-8a5e62c0db11",
          "_filename": "bobsPawPrint.png",
          "_acl": { ... },
          "_downloadURL": <Google Cloud Storage download URL>,
          "_expiresAt": "2018-06-18T23:07:23.394Z"
        }
      }
    */
  }, function(error) {
    // ...
  });

3.10.2

- Mar 29, 2018

• Enhancement: Previously, a datastore instance would implicitly push pending entity changes before performing a request that would overwrite the local entity changes. This change removes the implicit push and will instead return an error stating that there are entities that need to be synced before you complete the action. #276
• Enhancement: You can now provide a instanceId as a config option to init(). This will setup the backend and Mobile Identity Connect API urls to use your instanceId properly. #278

Kinvey.init({
  appKey: '<appKey>',
  appSecret: '<appSecret>'
  instanceId: '<my-subdomain>'
});

• Fixed: Check that a value is an object before calling Object.keys() in Query.isSupportedOffline(). #245
• Fixed: Use es6-promise for promises in live service related files instead of native promises. #272

3.10.1

- Mar 13, 2018

• Enhancement: The default API version used by Mobile Identity Connect is now v3. #259 #268
• Enhancement: Auto Pagination Support. #260

The Kinvey backend imposes a limit of 10,000 entities on data requests. If your app needs to pull a larger number of entities to the cache, you can request the SDK to "auto-paginate". The SDK will then retrieve the entire set of entities page by page. This feature only applies to Cache and Sync stores.

var dataStore = Kinvey.DataStore.collection('books', Kinvey.DataStoreType.Sync);

//Pull the entire collection page by page.
var promise = dataStore.pull(null, { autoPagination: true })
  .then(function onSuccess(count) {
    // "count" represents the number of entities retrieved
  }).catch(function onError(error) {
    // ...
  });

• Fixed: The authorization header for Mobile Identity Connect token requests now uses the long-form OAuth Client ID. This fix is only relevant to apps that use multiple auth providers. A detailed discussion on OAuth Client IDs can be found in the Mobile Identity Connect guide. #263

3.10.0

- Feb 26, 2018

• Enhancement: We've restructured our class hierarchy for working with data, to facilitate future performance improvements.
• Enhancement: CacheStore methods create() and update() can now handle more concurrent requests.
• Enhancement: CacheStore.delete() method now applies the same query both locally and against the backend, instead of making separate "by-id" requests for entities found in the cache.
• Enhancement: The clear() method for a CacheStore or SyncStore now clears the sync queue.
• Enhancement: Sync items found for entities which are no longer present in cache will be cleared when a sync push is performed to prevent errors.
• Enhancement: Improved the throttling of requests when doing a sync push.
• Fixed: Database connections to WebSQL are now cached. #241
• Fixed: Some browsers don't support Number.isNaN() so we added a polyfill. #243
• Fixed: Update typescript definitions to allow anonymouse user signup. #242
• Fixed: Export LiveServiceFacade instead of LiveService. #254

3.9.10

- Feb 9, 2018

• _id field not returned when specifying fields for a query #233

3.9.9

- Jan 26, 2018

• Enhancement: You can now specify which storage provider to use to cache data. See the code snippet below for an example. #213

Kinvey.init({
  appKey: '<appKey>',
  appSecret: '<appSecret>'
  storage: Kinvey.StorageProvider.Memory // or [Kinvey.StorageProvider.Memory]
});

// Possible Values
enum StorageProvider {
  Memory
}

• Enhancement: You can now use a datastore to perform actions on a subset of data in a collection without providing a query each time to match that subset of data. See the code snippet below for an example. #220

var datastore = Kinvey.DataStore.collection('books', Kinvey.DataStore.Sync, { tag: 'Kinvey' }); // Tag the datastore
var query = new Kinvey.Query().equalTo('author', 'Kinvey');
datastore.pull(query)
  .then(function() {
    return datastore.find().toPromise();
  })
  .then(function(books) {
    // all of these books have Kinvey as their author
  });

• Fixed: Correctly sort entities that have a null or undefined value for the sort field. #205
• Fixed: Add polyfill for Object.prototype.assign(). #225

3.9.6

- Jan 12, 2018

• Fixed: Subscribe for messages sent to user's personal collections channel #172
• Fixed: Allow null and undefined values to be used in a equal and notEqual query #201
• Fixed: Remove fileds when processing query after sorting data #202

3.9.3

- Dec 14, 2017

• Improvement: Use PubNub 4.19.0 rather then our custom fork. #193
• Improvement: We have updated the TypeScript definitions to support custom properties on a User instance. #183
• Improvement: Adopt a mono repo style repository. This change has no impact on the SDK output. It restructures our codebase to make releases and open source contributions easier. #171

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 NodeJS SDK will store the active user in memory.
• 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.

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

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

3.5.0

- Apr 24, 2017

• 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

• 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

• 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

3.4.2

- Mar 16, 2017

• Clone body of CacheRequest. #112
• Add back es6-promise. #113
• Add method to remove user by id. #114

3.4.1

- Feb 24, 2017

• 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.4.0

- Feb 9, 2017

• Refactor source to export all modules, expose Rack API, and to clean up code. #94
• Remove password hash from stored user object. #102
• Fix errors with using Kinvey.ACL on an entity that does not contain an _acl property. #103

3.3.5

- Jan 25, 2017

• Add User.lookup() API to perform user discovery. #96
• Fix a bug that causes any requests sent to the backend after updating a user to respond with a 401 status code. #101

3.3.4

- Jan 12, 2017

• Improved test coverage. #92
• Fixed a bug that would produce a TypeError for a failed login or any network request that resulted in an InvalidCredentialsError #95

3.3.3

- Dec 16, 2016

• Added error.kinveyRequestId as a property to error objects. This property is set to the X-Kinvey-Request-Id header value of a Kinvey API response. It is undefined by default. #84
• Added a global get/set default timeout property on the client. The library sets the default timeout to a value of 60 seconds. You can change this value by passing a default timeout when you initialize the SDK. #85

Kinvey.initialize({
  appKey: '<appKey>',
  appSecret: '<appSecret>',
  defaultTimeout: 30000 // 30 seconds in ms
});

• Delta fetch requests now works with queries. #83
• Fixed a check with instanceof in Mobile Identity Connect that caused a TypeError to be thrown. #87
• Entities will now be persisted when calling store.sync on a data store instance. #88
• Fixed issues that caused inconsistencies with Error objects. #89
• Sort, limit, and skip now work correctly when querying the local cache. #90

3.3.2

- Dec 3, 2016

• Bugfix: Add missing semicolon in aggregation count function.
• Enhancement: Update aggregation processing.

3.3.1

- Dec 2, 2016

• Bugfix: Aggregations have been fixed. See Aggregation Guide to learn how to use aggregations.
• Bugfix: user._socialIdentity properties returned from the network are no longer removed on a succesful login.
• Bugfix: Fixed a typo in the NetworkStore.

3.3.0

- Nov 22, 2016

• Enhancement: All error objects are exposed on the Kinvey namespace. See Troubleshooting Guide for more information.
• Bugfix: Fix name property on Error objects.
• Bugfix: Merge user._socialIdentity properties when using an identity to login a user with the response from a login request.
• Bugfix: Do not disconnect identities on a user logout.
• Bugfix: Support private browser mode for Chrome, Firefox, and Safari.
• Deprecated: Kinvey.initialize should be used instead of Kinvey.init.

Kinvey.initialize({
  appKey: '<appKey>',
  appSecret: '<appSecret>'
})
  .then(function(activeUser) {
    // ...
  });

3.2.2

- Oct 26, 2016

• Bugfix: Import UserStore from correct path. Kinvey.UserStore is now not undefined.
• Bugfix: Add missing group function to data stores.

3.2.1

- Oct 6, 2016

• Enhancement: Default apiHostname protocol to https: if one is not provided.
• Bugfix: Make default timeout for network requests 10 seconds.
• Bugfix: Prevent delta fetch from loading all entities when they are not needed.

3.2.0

- Sep 27, 2016

• Bugfix: Don't send a DELETE request to the backend when calling clear() on a CacheStore or SyncStore instance to clear the local cache.
• Bugfix: Allow a the credentials for a user to be provided as an object to Kinvey.User.login().
• Bugfix: Use { field: <value> } format when serializing a query that contains an equalTo expression.
• Bugfix: Fix a bug that prevented a popup from being opened when trying to login with Kinvey.User.loginWithMIC().
• Bugfix: Allow network connections from behind a firewall.
• Deprecated: forgotUsername(), verifyEmail(), and resetPassword() instance functions on the Kinvey.User class. You should now use the static version of each function.

3.1.0

- Sep 10, 2016

• Bugfix: Fixed bug that prevented logout of a user.

3.0.3

- Aug 12, 2016

• Bugfix: Send correct X-Kinvey-Device-Information header format.
• Bugfix: Update the cache to represent the state of the backend correctly when a sync pull is performed.
• Bugfix: Expose the Acl class on the Kinvey namespace.

3.0.2

- Aug 3, 2016

• Enhancement: Support anonymous user sign up. See Autogenerated Users Guide for more information.

3.0.1

- Jul 29, 2016

• Enhancement: Update to latest version of the JavaScript SDK Core.

3.0.0

- Jul 11, 2016

• Bugfix: Store results from a pull in the cache.
• Bugfix: Return server generated _id when creating entities.
• Enhancement: Make file uploads resumable.
• Enhancement: Make Kinvey.Promise accessible as a property on the Kinvey namespace.
• API Change: To get an instance of DataStore you now have to call the collection() function instead of getInstance()

var store = Kinvey.DataStore.collection('myCollection');

3.0.0-beta.12

- Mar 29, 2016

• Added adapters for http, popup, and device.

3.0.0-beta.8

- Feb 24, 2016

• Fixed a bug that caused the library to be exported incorrectly.

3.0.0-beta.7

- Feb 22, 2016

• Fixed a bug that prevented a user from being able to login with Mobile Identity Connect.
• Fixed a bug that prevented entities from being updated.

3.0.0-beta.6

- Feb 18, 2016

• Fixed bug that would resolve promise when using incorrect credentials to login a user.
• Fixed a bug that would remove entities locally on a device but not on the network.
• Fixed a bug that would not allow items to be saved to the device locally.

3.0.0-beta.5

- Feb 17, 2016

• Bug fixes.

3.0.0-beta.4

- Feb 1, 2016

• Initial release.

Download Older Versions

We recommend using the latest version.