## [7.1.0] - 2026.05.26

### Feature:

- Starting this version it is possible to make multiple path updates atomically in one message, with one version bump for a given record.
- add setMulti / setMultiWithAck on Record; atomic PATCH_MULTI for Dequeue mutators; new unshiftWithAck / pushWithAck

## [7.0.6] - 2026.05.04

### Fix bug 608

- Node v>= 22 provides a native webSocket that does not support options. Fixed and separated the socket factory for browsers: browser bundle does not include ws at all reducing size in ~50kb.

### Chore

- update deps

## [7.0.5] - 2025.04.26

### Chore

- update deps

## [7.0.4] - 2024.02.19

### Chore

- update deps


## [7.0.3] - 2024.02.16

### Fix

onAuthUnsuccessful accepts custom server messages, either a string in response.body or a JSON `{clientData: 'customMessage' }`

### Misc

- update deps

## [7.0.2] - 2023.06.02

### Feature

New API to create double ended queues, a new implementation of lists that are efficient in network usage.

## [7.0.1] - 2023.02.21

### Fix
- Polyfill buffer since webpack doesn't do it starting v5
- remove outdated deps

## [7.0.0] - 2023.02.01

### Task
- Enable localstorage in client options. This provokes a breaking change for current users of offline record functionality. if you're not using offline records, there are no breaking changes.

### Fix
- Logic around dirty records and state transitions

### Misc

- update deps
- code comments

## [6.0.5] - 2022.06.20

### Misc

- update deps
- code comments

## [6.0.4] - 2022.06.20

### Fix

- data types when using record.set with path

## [6.0.3] - 2022.06.05

### Misc

- Updating dependencies

## [6.0.2] - 2022.06.02

### Task

- RPC provider callback now can return the rpcRequestorName and rpcRequestorData as third parameter if the server configuration mandates they are sent to the provider.

## [6.0.1] - 2022.04.22

### Fix

- Add missing return statements

### Misc

- Remove yarn.lock

## [6.0.0] - 2022.03.17

### Task

- Handle write ack errors now sent by deepstream server >= v6.1.0. This comes with some changes to state machine logic.

### Fix

- Various error logs

## [5.2.7] - 2022.02.20

### Misc

- Updating dependencies

## [5.2.6] - 2022.01.09

### Fix

- Add missing read registry

## [5.2.5] - 2021.09.24

### Misc

- Updating dependencies

## [5.2.4] - 2021.04.05

### Misc

- Updating dependencies

## [5.2.3] - 2021.05.02

### Fix

- ignore version conflicts that are of equal resolved values and state is not merging

## [5.2.2] - 2021.04.20

### Fix

- ignore version conflicts that are of equal resolved values and state is not merging

## [5.2.1] - 2021.01.11

### Task

Implement CI using github actions.

## [5.2.0] - 2020.12.29

### Breaking Change

Remove rpcAcceptTimeout and rpcResponseTimeout from client logic. These timeouts will be handled server side only.

## [5.1.12] - 2020.12.4

### Fix

- send heartbeats strictly according to `heartbeatInterval`.


## [5.1.11] - 2020.12.1

### Fix

- Send heartbeat packets according to `lastSentMessageTimestamp`, not `lastRecievedMessageTimestamp`.

### Misc

- Updating dependencies

## [5.1.10] - 2020.09.24

### Fix

- React-native postinstall script for Windows

## [5.1.9] - 2020.09.22

### Fix

- Typescript definitions for record subscribe method

## [5.1.8] - 2020.09.17

### Fix

- React-native post install script must point to non-minified bundle.

## [5.1.7] - 2020.09.10

### Fix

- Remove callback after calling single notifier with error. This was preventing future messages from being sent after reconnection.

## [5.1.6] - 2020.09.04

### Fix

- Undo last changes to  `discard()` and `unsubscribe()` logic. Those operations only affect the current record instances, not all instances of the record in the client.
- provide context for record subscriptions
- Fix emitter logic

## [5.1.5] - 2020.08.18

### Fix

- Discard all references of a record when calling `.discard()`
- Remove subscriptions from record reference when calling `.unsubscribe()`

## [5.1.4] - 2020.07.29

### Chore

- Bump dependencies

## [5.1.3] - 2020.07.14

### Fix

- set main file in package.json to `dist/src/deepstream.js`
- add postinstall script that works when passing the `DEEPSTREAM_ENV=react-native` variable to the npm install command in order to change the main file in package.json to `dist/bundle/ds.min.js` for react-native usage.


## [5.1.2] - 2020.07.05

### Fix

- set main file in package.json to minified bundle
- Revert the explicit Buffer import since it's not required when using the bundled client file.

## [5.1.1] - 2020.06.30

### Fix

- Manipulate string url in socket factory without external dependencies. Fixes #515
- Export the client constructor as object in order to maintain api in bundle.Fixes #528
- Make explicit Buffer import. Fixes #529

## [5.1.0] - 2020.05.11

### Feature

Send down sdkVersion and sdkType to server on challenge for better metrics

### Fix

Fixes #504: WriteAcks on conflicts

  This needs to be used with server 5.0.17 in order to work.

  The issue was VERSION_EXISTS didn't go through the ack service
  which resulted in it never reacting.

  To test this, run `ts-node bugs/504-merge-conflict-silent.ts` in
  two terminals

Fix connection timeouts if server doesn't send something in time

When a user has permission to read but not write to record, when trying to set with ack the error callback was not triggered and the client hanged indefinitely.

## [5.0.8] - 2020.04.15

### Fix

Deep-compare method in record change event emitter, this prevents spurious events when users are subscribed to a record path pointing to an object.

### Improvement

Updating dependencies

## [5.0.7] - 2020.02.08

### Fix

Revert: Allow to work on react native (at cost of bigger bundle size)

## [5.0.6] - 2020.02.08

### Improvement

Updating dependencies

### Fix

Allow to work on react native (at cost of bigger bundle size)

## [5.0.5] - 2019.11.21

### Fix

Method signature for the `DeepstreamClient.login()` overload that takes only a callback was incorrect

## [5.0.4] - 2019.11.03

### Fix

Linting issue failed release build

## [5.0.3] - 2019.11.03

### Fix

Actual library fix, previous one was a spoof

## [5.0.2] - 2019.11.03

### Fix

Adding library directly into browser from webpack should expose DeepstreamClient globally

## [5.0.1] - 2019.10.29

### Fix

Added a missing transition state on record resubscription

## [5.0.0] - 2019.10.27

### Breaking Change

Importing and creating the client has changed in order to be less insane when using typescript.

When creating the client you now do:

```typescript
const { DeepstreamClient } = require('@deepstream/client')
const dsClient = new DeepstreamClient(url, options)
```

instead of:

```javascript
const deepstream = require('@deepstream/client')
const dsClient = deepstream(url, options)
```

## [4.1.3] - 2019.09.09

### Fix

Another socketOptions defaulting issue

## [4.1.2] - 2019.09.09

### Fix

Defaulting socketOptions in socket wrapper factory.

# [4.1.1] - 2019-09-08

### Feature

Adding a `jsonTransportMode` flag that can be passed to `socketOptions` that allows the client
to talk to the server in JSON. This is mainly done to help people to debug writing new SDKs and
should not be used in production.

# [4.1.0] - 2019-09-05

### Improvement

Including a default implementation of timeouts using the native setTimeout API. The interval based one was created in order to mitigate the insane amount
of ack registries we used to have get created, and also because setting timeouts
isn't cheap (you can verify this by creating a couple thousand records and noticing the cost within the default noop storage registry). However as correctly stated by @Krishna [here](https://github.com/deepstreamIO/deepstream.io-client-js/issues/500) the interval implementation is naive in terms of mobile (looping every 20milliseconds for idle connections is overkill) and the benefits now is no longer as apparent as during the RC release (since bulk messaging now only makes one timeout for N amount amount of subscriptions).

You can toggle them with the following:

```
# When true uses setTimeout
nativeTimerRegistry: true,
# When nativeTimerRegistry is false uses an interval with this timer resolution
intervalTimerResolution: 50,
```

Either ways both implementations are expensive in terms of garbage collection since it binds to the context and data as part of the API. This can probably be avoided by providing a null context going forward.

### Fix

Lists were not propagating the events on record-core. Discard, delete and error is now properly passed, and documentation needs to be updated to indicate the ready event was dropped in V4

# [4.0.5] - 2019-08-30

### Improvement

The initial version change seems to have broken some things, so it is now configurable and defaults to 1

# [4.0.4] - 2019-08-19

### Feature

If record is in readonly mode, only subscribe and read, don't try to upsert / create

# [4.0.3] - 2019-08-09

### Feature

Adding notify on record handler to notify if the db was changed without using deepstream APIs

### Fix

Change error message on connection to pass through error

### Breaking Change

This shouldn't be a breaking change for those with offline disabled, which noone is using yet
hence the patch release. This just changes the initial version 1 to 0

### Fix:

# [4.0.2] - 2019-08-03

### Fix:

- Adding a readOnlyFlag

This is an issue where when not doing offline first requesting a record that doesn't exist would result in a new empty record being created (locally) with no data. This would break bindings for some people. Instead what we do now is use a recordReadOnlyMode flag which indicates that we expected most records to be only ever read from server, and hence will only be ready on data load. You can explicitly mention the things you do want to write to via a recordPrefixWriteWhitelist.

- Also added a transition from unsubscribing to deleted, because so many transitions.

# [4.0.1] - 2019-08-03

### Fix:

- Do a deep compare when setting data to avoid processing unchanged values

# [4.0.0] - 2019-07-30

### Features:

- New binary protocol support (under the hood)
- Bulk actions support (under the hood)
- Full typescript declaration files
- Promises everywhere! Long live async/await!
- Offline record support

```JavaScript
{
    // Use indexdb to store data client side
    offlineEnabled: false,
    // Save each update as it comes in from the server
    saveUpdatesOffline: false,
    indexdb: {
        // The db version, incrementing this triggers a db upgrade
        dbVersion: 1,
        // This auto updates the indexdb version if the objectStore names change
        autoVersion: false,
        // The key to index records by
        primaryKey: 'id',
        // The indexdb databae name
        storageDatabaseName: 'deepstream',
        // The default store name if not using a '/' to indicate the object store (example person/uuid)
        defaultObjectStoreName: 'records',
        // The object store names, required in advance due to how indexdb works
        objectStoreNames: [],
        // Things to not save, such search results
        ignorePrefixes: [],
        // The amount of time to buffer together actions before making a request
        flushTimeout: 50
    }
}
```

- Customizable offline storage support

```typescript
export type offlineStoreWriteResponse = ((error: string | null, recordName: string) => void)

export interface RecordOfflineStore {
  get: (recordName: string, callback: ((recordName: string, version: number, data: RecordData) => void)) => void
  set: (recordName: string, version: number, data: RecordData, callback: offlineStoreWriteResponse) => void
  delete: (recordName: string, callback: offlineStoreWriteResponse) => void
}
```

### Improvements

- Separation of errors and warnings for clarity. Non critical failures (such as an ack timeout) can now be treated separated or fully muted.
- Enhanced services to reduce timeout overhead

### Backwards compatibility

- Only works with V4 server
- All single response APIs now return promises when not providing a callback. This means most APIs that could have been chained would now break.

```JavaScript
const client = deepstream()
try {
    await client.login()

    const record = client.record.getRecord(name)
    await record.whenReady()

    const data = await client.record.snapshot(name)
    const version = await client.record.head(name)
    const exists = await client.record.has(name)
    const result = await client.rpc.make(name, data)
    const users = await client.presence.getAll()
} catch (e) {
    console.log('Error occurred', e)
}
```

- Listening

The listening API has been ever so slightly tweaked in order to simplify removing an active subscription.

Before when an active provider was started you would usually need to store it in a higher scope, for example:

```typescript
const listeners = new Map()

client.record.listen('users/.*', (name, isSubscribed, ({ accept, reject }) => {
    if (isSubscribed) {
        const updateInterval = setInterval(updateRecord.bind(this, name), 1000)
        listeners.set(name, updateInterval)
        accept()
    } else {
        clearTimeout(listeners.get(name))
        listeners.delete(name)
    }
})
```

Where now we instead do:

```typescript
const listeners = new Map()

client.record.listen('users/.*', (name, ({ accept, reject, onStop }) => {
    const updateInterval = setInterval(updateRecord.bind(this, name), 1000)
    accept()

    onStop(() => clearTimeout(updateInterval))
})
```

### TLDR;

You can see the in depth side explanation of the changes [here](https://deepstream.io/releases/client-js/v4-0-0/)

## [2.3.0] - 2017-09-25

### Features

- the presence feature can now be used on a per user basis. The online status of individual users can be queried for as well as subscribed to. Check out the tutorial on our website [here](https://deepstreamhub.com/tutorials/guides/presence/)

### Improvements

- error messages are now stringified to better display information [#386](https://github.com/deepstreamIO/deepstream.io-client-js/pull/386) courtesy of [@SejH](@SejH)
- improved handling of parameters in calls to `client.record.setData`

### Miscellaneous

- moved e2e steps into [deepstream.io](https://github.com/deepstreamIO/deepstream.io) repository

## [2.2.1] - 2017-06-02

### Fixes
- Update `dist/` files correctly

## [2.2.0] - 2017-05-29

### Features
- Clients are now able to perform and upsert operation `CU` (create and update) via `RecordHandler.setData`. This allows writing to records while not subscribed to them locally

## Fixes
- Heartbeat timeout now emits the reconnect event

## [2.1.5] - 2017-05-03

### Bug Fixes
- Calling login() with a callback (but no auth data) now behaves as you would expect.
- Fix issue where client did not emit `MAX_RECONNECTION_ATTEMPTS_REACHED` event by [@rbarroetavena](@rbarroetavena).

## [2.1.4] - 2017-04-11

### Enhancements
- Tightened up typescript callback interfaces by [@EnigmaCurry](@EnigmaCurry)

### Small Fixes
- Using main file as `dist/deepstream.js` over `src/client.js`

## [2.1.3] - 2017-04-08

### Enhancements
- Write acks now called with a failure message if connection is down by [@Erik Karlsson](@Erik Karlsson)
- Write acks now called with null if value hasn't changed by [@Erik Karlsson](@Erik Karlsson)
- Linting / Babel support
- Improved a few typescript bindings by [@EnigmaCurry](@EnigmaCurry)
- Changed heartbeat missed message to include time
- Setting anonymous record with same name no longer discards and resubscribes the record

### Bug Fixes

- Invalid remote wins merge conflicts
- Prevent records from being set with scalar values by [@datasage](@datasage)
- Prevent bad login message from constantly attempting to reconnect by [@datasage](@datasage)
- RecordHandler invalid destroy state emitted an error instead of using client._$onError

## [2.1.2] - 2017-02-28

### Enhancements

- heartbeat missed should close connection [#324](https://github.com/deepstreamIO/deepstream.io-client-js/pull/324)
- optimized json-path patch [#329](https://github.com/deepstreamIO/deepstream.io-client-js/pull/329)
- TypeScript typings [#283](https://github.com/deepstreamIO/deepstream.io-client-js/pull/283) and [#338](https://github.com/deepstreamIO/deepstream.io-client-js/pull/338)
- Added support for non-NaNish base 16 numbers in jsonpath [#328](https://github.com/deepstreamIO/deepstream.io-client-js/pull/328)
- There is now a single ack timeout registry for the client, shared between all handlers. This means that ack timeouts are cleared when the connection is lost and don't occur when the connection is not open [#342](https://github.com/deepstreamIO/deepstream.io-client-js/pull/342)

### Bug Fixes

- reset queued methods in List once called [#315](https://github.com/deepstreamIO/deepstream.io-client-js/pull/315)
- fix queued methods by passing index to .bind() [#316](https://github.com/deepstreamIO/deepstream.io-client-js/pull/316)

## [2.1.1] - 2016-12-21

### Bug Fixes

- Fixed the generated dist release files

## [2.1.0] - 2016-12-20

### Features

- Record write acknowledgement. Records are now able to be set with an optional callback which will be called with any errors from storing the record in cache/storage [#290](https://github.com/deepstreamIO/deepstream.io-client-js/pull/290)

### Enhancements

- Additional tests around presence and records [#284](https://github.com/deepstreamIO/deepstream.io-client-js/pull/284) and [#285](https://github.com/deepstreamIO/deepstream.io-client-js/pull/285)
- Allow passing of node socket options into constructor [#289](https://github.com/deepstreamIO/deepstream.io-client-js/issues/289)

### Bug Fixes

- Fix bug in JSON path when updating nested null values [#281](https://github.com/deepstreamIO/deepstream.io-client-js/issues/281)
- Adding check for undefined entries in single notifier [#291](https://github.com/deepstreamIO/deepstream.io-client-js/pull/291)

## [2.0.0] - 2016-11-18

### Features
- Added support for the deepstream `presence` API, enabling querying and
  subscribing to who is online within a cluster. For example:
  ``` javascript
  ds.presence.getAll((users) => {
    users.forEach((username) => {
      console.log(`${username} is online`)
    })
  })
  ds.presence.subscribe((username, loggedIn) => {
    if (loggedIn) {
      console.log(`${username} has logged in`)
    } else {
      console.log(`${username} has logged out`)
    }
  })
  ```
### Enhancements

- Added heartbeats over WebSocket connection
- Presence has been added to query and subscribe to who is online with the cluster
- E2E tests refactored

### Breaking Changes

- Supports deepstream.io v2.0.0+ only
- Changed format of RPC request ACK messages to be more consistent with the rest of the specs
[#408](https://github.com/deepstreamIO/deepstream.io/issues/408)
- We now depend only on browser/node.js WebSockets, removing support for TCP and engine.io
- Support for webRTC has been removed

## [1.1.1] - 2016-09-30

### Bug Fixes

- Connection errors now occur on the CONNECTION topic
- Message denied clears down associated ACK timeout messages

### Enhancements

- Optimize and refactor records by [@ronag](@ronag)

### Misc

- Porting over remaining e2e tests
- Adding specs as part of the client project and build

## [1.1.0] - 2016-09-08

### Bug Fixes

- fix leaking internal reference to the record data  [#202](https://github.com/deepstreamIO/deepstream.io-client-js/issues/202) by [@ronag](@ronag)

### Enhancements

###### `listen(pattern, isSubscribed, response)`
add a third argument for the listen callback (`client.record.listen` and `client.event.listen`) which contains
an object which two functions (`accept` and `reject`). One of these functions needs to be called otherwise you
will get a deprecated message. [#203](https://github.com/deepstreamIO/deepstream.io-client-js/issues/203) [#212](https://github.com/deepstreamIO/deepstream.io-client-js/issues/212)

This enhancements fixes some issues like [#74](https://github.com/deepstreamIO/deepstream.io-client-js/issues/74) [#155](https://github.com/deepstreamIO/deepstream.io-client-js/issues/155) [#170](https://github.com/deepstreamIO/deepstream.io-client-js/issues/170)

###### provider flag and event
Records supports now a boolean flag (`record.hasProvider`) which indicates whether a listener has accepted providing data. You can also subscribe to event which is triggered when the flag changes:

```javascript
record.on('hasProviderChanged', hasProvider => {
  /* do something */
})
```

###### API checks are now in place that throw an error if you provide the incorrect argument amount or types [#207](https://github.com/deepstreamIO/deepstream.io-client-js/pull/227) by [@ronag](@ronag)

### Misc

###### Gherkin tests are now used for E2E testing, allowing e2e tests to be run against any language rather than just node, and allows writing more scenarios much easier

## [1.0.2] - 2016-07-28

### Bug Fixes

- allow do create and discard the same record in a synchronous loop [#167](https://github.com/deepstreamIO/deepstream.io-client-js/issues/167)
- record snapshots are not waiting for `isReady` [#140](https://github.com/deepstreamIO/deepstream.io-client-js/issues/140)
- record subscriptions are not waiting for `isReady` in combination with `triggerNow` [#138](https://github.com/deepstreamIO/deepstream.io-client-js/issues/138)
- broken unsubscribe due to wrong internal argument delegation [#190](https://github.com/deepstreamIO/deepstream.io-client-js/issues/190)


### Enhancements

- provide a `MAX_RECONNECTION_ATTEMPTS_REACHED` event [#175](https://github.com/deepstreamIO/deepstream.io-client-js/issues/175)
- provide a `maxReconnectInterval` option [#176](https://github.com/deepstreamIO/deepstream.io-client-js/issues/176)

###  Features

- Terminate unauthenticated connections after a timeout [#226](https://github.com/deepstreamIO/deepstream.io/issues/226)

## [1.0.1] - 2016-07-19

### Bug Fixes

- Fixed issue where deleted record was not getting removed

## [1.0.0] - 2016-07-10

### Features

###### Merge Conflict Resolution #4
Users can now set a global and per record merge strategy. This allows the application to respond to `VERSION_EXISTS` and use a `REMOTE_WINS`, `LOCAL_WINS` or a custom merge strategy

Global:
```javascript
const client = deepstream( 'localhost:6020', {
    mergeStrategy: deepstream.MERGE_STRATEGIES.REMOTE_WINS
});
```

Local:
```javascript
const record = client.record.getRecord( 'user/1' )
record.setMergeStrategy( ( record, remoteValue, remoteVersion, callback ) => {
  callback( null, remoteValue )
} )
```


#### Enhancements

###### Connection Redirects
deepstream protocol now has a connection establishment handshake that allows the client to be redirected to another deepstream before requesting/publishing data

###### Record deletes #111
Users can now delete content within records by setting it to undefined

```javascript
record.set( path, undefined )
```

###### Reduced client size #75
Client size bundle has been reduced by not including mocks for the tcp connection

###### Discard/Delete only on ready #94
Record discards and deletes now get called after when ready, which makes the API cleaner

Before:
```javascript
record = client.record.getRecord( 'user1' )
record.set( 'name', 'bob' )
record.onReady( () => {
  record.discard()
})
```

Now:
```javascript
record = client.record.getRecord( 'user1' )
record
  .set( 'name', 'bob' )
  .discard()
```

###### Exposed Constants
You can now access constants on deepstream

```javascript
// on the constructor
const C = deepstream.CONSTANTS;
// and instance
const client = deepstream( 'localhost:6020' )
CONST C = client.CONSTANTS;
```

### Breaking Changes

###### Login callback

The login callback now only takes two arguments instead of three. This is to make it easier for the user to send their own custom data from an authentication hander or when using the http authentication handler

```javascript
client.login( {}, ( success, data ) => {
  if( success ) {
    // data is meta data associated with user session
    // or null
  } else {
    // data is error message or custom error object
    // with reason why or null
  }
} )
```

###### EngineIO Default Path
We now use `deepstream` instead of `engine.io` as the default engineio path

### Bug Fixes

- Login after logout doesn't overide auth parameters #88

- Deepstream not updating object properties #96 ( @drsirmrpresidentfathercharles )