# `@eventstore/db-client`

## [v6.2.1](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v6.1.0...v6.2.1) (2024-05-10)
* Include dist in release 

## [v6.2.0](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v6.1.0...v6.2.0) (2024-05-10)

## Features
*  Support providing an x.509 certificate for user authentication (#361) [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/03f3afa536d5e470231655cf9ee6a91e3e71b549)

## Changed
### Updated error handling to use `NotFoundError` instead of `UnknownError` in projection operations when the projection doesn't exist 
* Previously, the server was returning UnknownError when a projection didn't exist. EventStoreDB now returns NotFoundError. This change updates the client to use NotFoundError instead of UnknownError when a projection doesn't exist. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/7cf6ed0b0cbbe4781374c3e8c9145a653ebb456e)
> ⚠️ This only affects users who are using EventStoreDB versions 24.6 and greater.

### Expect CancelledError when node is terminated to align with server version 24.4
* EventStoreDB recently configured the [ShutdownTimeout](https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.server.kestrel.kestrelserveroptions.shutdowntimeout?view=aspnetcore-1.1) to 5s after being set to 30s in recent .NET releases resulting to different error status code returned from the server. The client now expects a CancelledError when the node is terminated. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/3543b83e6090555f1d1900a6a1fc8330af568a87)
> ️⚠️ This only affects users who are using EventStoreDB versions 24.4 and greater.

### Miscellaneous
* The tests are now run against Node LTS (v20.12.2 as of this release).
* We are now using tsdoc for documentation comments as [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/package.json) does not support NodeJS versions below 18.

## [v6.1.0](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v6.0.0...v6.1.0) (2023-12-19)

## Features

*  Add support for caught up and fell behind subscription message [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/e00beb1b2a800e0e3d111e7de3de571d67e635fa)

## Enhancements

*  Increase test coverage for reconnection [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/acf48997607b4b7b64fd1f1683fd579cb286c371)
*  Use dynamic tags instead of hardcoding esdb versions [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/2bdbaab7a7f7884301c15f4cf6c090ab90fa7309)
*  Update TypeScript, ESLint and other dependencies [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/d3de1747df72efb00e8fcbbdc393ce2121f6d82f)
*  Update grpc-js to 1.9.12 [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/91fb2aac898ea2c6dce072f94393466390ccf89c)

## Thanks

:tada: Thanks for @jokesterfr and @Imanghvs for their contributions! :tada:

## [v6.0.0](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v5.0.1...v6.0.0) (2023-08-25)

## Breaking changes

### `CancelledError` is now thrown when a stream is cancelled by the server

Previously, we would throw an `UnavailableError` when the server was unavailable to take a request, _or_ a stream was cancelled by the server. This release now throws a `CancelledError` when the stream is cancelled, allowing users to distinguish between them.

If users are catching `UnavailableError` on a stream for this situation, they should now be looking for a `CancelledError`. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/022b150842800a2aa0ba297154061f941fbb8ca9)

Before:

```ts
try {
  for await (const event of client.readStream("my_stream")) {
    // do something
  }
} catch (error) {
  if (isCommandError(error)) {
    if (error.type === ErrorType.UNAVAILABLE) {
      // Server is unavailable to take request
      // _OR_
      // Stream was cancelled by server
    }
  }
}
```

After:

```ts
try {
  for await (const event of client.readStream("my_stream")) {
    // do something
  }
} catch (error) {
  if (isCommandError(error)) {
    if (error.type === ErrorType.CANCELLED) {
      // Stream was cancelled by server
    }

    if (error.type === ErrorType.UNAVAILABLE) {
      // Server is unavailable to take request
    }
  }
}
```

## Bug Fixes

- fix out of bounds value for stream revision [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/39094c2aa351fcb8f399a75168a322b7278ec467)

## [v5.0.1](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v5.0.0...v5.0.1) (2023-02-16)

## Bug Fixes

- Fix minor typo [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/8c13698e2e6b2847b2373ffa7c0a217ab8c501c7)
- Generate sourcemaps with build [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/9937ed91b3e6506c697f287f408497d013ce8738)

## Thanks

:tada: Thanks for @coffemakingtoaster for their contributions! :tada:

## [v5.0.0](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v4.0.0...v5.0.0) (2022-11-04)

## Breaking changes

### `RecordedEvent["created"]` is now a `Date`

Previously, a recorded event's created property was being returned in ticks, a 64bit integer in 100ns precision. As well as being an unusual format, this was being parsed into a `Number`, so was unsafe. This release changes the property to be represented by a `Date`.

#### Before:

`created` was an unsafe "ticks" since epoch:

```typescript
for await (const { event } of client.readStream(STREAM_NAME)) {
  // 16675621600650000 (greater than Number.MAX_SAFE_INTEGER)
  console.log(event?.created);
}
```

#### After:

`created` is a `Date`:

```typescript
for await (const { event } of client.readStream(STREAM_NAME)) {
  // 2022-11-04T11:42:40.065Z
  console.log(event?.created);
}
```

## [v4.0.0](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v3.4.0...v4.0.0) (2022-09-02)

## Breaking changes

### Add `emitEnabled` option to `createProjection`.

Due to a bug on the server, previously, the `trackEmittedStreams` option was setting `emitEnabled`, and not `trackEmittedStreams`. This release adds the `emitEnabled` option and corrects the behaviour of `trackEmittedStreams`, with a polyfill for earlier server versions. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/8b1b106bad69ccd9aa96a03b55a2c0bfee4fc110)

#### Before:

Setting `trackEmittedStreams` would enable emitting, but not track streams.

```typescript
await client.createProjection(PROJECTION_NAME, projectionQuery, {
  trackEmittedStreams: true,
});
```

#### After:

Setting `emitEnabled` works as expected:

```typescript
await client.createProjection(PROJECTION_NAME, projectionQuery, {
  emitEnabled: true,
});
```

Setting both `emitEnabled` and `trackEmittedStreams` works as expected:

```typescript
await client.createProjection(PROJECTION_NAME, projectionQuery, {
  emitEnabled: true,
  trackEmittedStreams: true,
});
```

Setting only `trackEmittedStreams` will be rejected by the server:

```typescript
// incorrect
await client.createProjection(PROJECTION_NAME, projectionQuery, {
  trackEmittedStreams: true,
});
```

## Features

### Add position to events from stream

When connected to a server that supports it (>22.6), events read from a stream will include their commit and prepare position. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/322b110e0815962733ac4e6d756208b16ae53df1)

## Bug Fixes

- Prevent multiple appends within the same event loop creating many batches, and improve backpressure. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/088bc4559146fe21340afcc38bdcce34353b36b3)
- Destroy read stream if stream is not found. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/5488d77ab32cfb4502cea3c4f718cba8616f9ea3)
- Only swallow unimplemented errors when creating server-features. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/fec332eb017def8ed57c1366aed0b42f2d6380c5)

## Removal of Deprecated Apis

- Remove deprecated consumer strategy names. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/3b1262488ae799714f2c9d9cb6988671c6850cc1)
- Remove deprecated persistent subscription methods. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/3e3e63383067aae10628ae4c665a27ef8c0db6ef)
- Remove deprecated `getProjectionStatistics` method. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/0956cbc32f4b65f70a281986ab5ca9ef4d00581c)

## [v3.4.0](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v3.3.1...v3.4.0) (2022-07-14)

## Features

### Add retry count to persistent subscription events

Adds `retryCount` property to events from `subscribeToPersistentSubscriptionToStream` and `subscribeToPersistentSubscriptionToAll` [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/e82d72763c34b1922928a2a73d396da2195e5083)

```typescript
const subscription = client.subscribeToPersistentSubscriptionToStream(
  STREAM_NAME,
  GROUP_NAME
);

for await (const event of subscription) {
  try {
    console.log(
      `handling event ${event.event?.type} with retryCount ${event.retryCount}`
    );
    await handleEvent(event);
    await subscription.ack(event);
  } catch (error) {
    await subscription.nack(PARK, error.toString(), event);
  }
}
```

## Bug Fixes

- Fix doc comment on readStream [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/1fcf0c8d69dc6dee0ef1b85867b07aacc86916e0)
- Fix type definition for acl in stream metadata [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/4f587f2e0dae9803f8ed45fa04caa0e57f2f6435)

## [v3.3.1](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v3.3.0...v3.3.1) (2022-04-06)

- Close channels when they fail to prevent memory leak. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/76f41ede6b23ec422daf12b2977323397c59b657)

## [v3.3.0](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v3.2.0...v3.3.0) (2022-03-30)

### Features

- Added `dispose` method to dispose all currently running streaming calls. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/fa0ba6c0d58a0f9b5d8843caa2aa21989122b3b4)

## [v3.2.0](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v3.1.0...v3.2.0) (2022-02-23)

## Features

### Persistent Subscription Control

New methods for persistent subscription control have been added.

| Method Name                              | Description                                                                                           |                                                                                                                |
| ---------------------------------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `getPersistendSubscriptionToAllInfo`     | Gets information and statistics on the specified persistent subscription to $all and its connections. | [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/d6099ef7039b3595da4effc7d521cf68b59ef30c) |
| `getPersistentSubscriptionToStreamInfo`  | Gets information and statistics on the specified persistent subscription and its connections.         | [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/d6099ef7039b3595da4effc7d521cf68b59ef30c) |
| `listAllPersistentSubscriptions`         | Lists all persistent subscriptions.                                                                   | [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/5efda84a6222adb29a2be0d504ce598c587ee8c1) |
| `listPersistentSubscriptionsToAll`       | Lists persistent subscriptions to the $all stream.                                                    | [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/5efda84a6222adb29a2be0d504ce598c587ee8c1) |
| `listPersistentSubscriptionsToStream`    | Lists persistent subscriptions to a specified stream.                                                 | [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/5efda84a6222adb29a2be0d504ce598c587ee8c1) |
| `replayParkedMessagesToAll`              | Replays the parked messages of a persistent subscription to $all.                                     | [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/21d6230af6d2a6759e07add4706c227ba30f2839) |
| `replayParkedMessagesToStream`           | Replays the parked messages of a persistent subscription.                                             | [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/7e5743b14e12f44e77d1f89905121354d5662617) |
| `restartPersistentSubscriptionSubsystem` | Restarts the persistent subscription subsystem.                                                       | [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/11ba5cde48cd18550ac5c8882456382560453d05) |

### Connection Name

The `connectionName` option has been added allowing you to name the connection in logs and persistent subscription info. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/ba2a8c68c0d5856bc1e8ad94b9185da9269507cf)

- Defaults to a UUID.
- Adds `connectionName` option to constructor.
- Adds `connectionName=<name>` param to connection string
- Adds `connectionName` getter to client for reading the name of the client.

### Allow skipping metadata key in `EventType`

Previously, to use `JSONEventType` or `BinaryEventType` you would have to provide a metadata key, even if you typed it as `unknown` or `never`. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/5f121cbadafa56d8dec6455bef0a861ab70e47a1)

#### Before:

```typescript
type MyEvent = JSONEventType<"my-event", { some: string }>;

// Property 'metadata' is missing in type '{ type: "my-event"; data: { some: string; }; }' but required in type 'JSONEventType<"my-event", { some: string; }, unknown>'.ts(2741)
const myEventData: MyEvent = {
    type: "my-event",
    { some: "data" }
}
```

#### After:

```typescript
type MyEvent = JSONEventType<"my-event", { some: string }>;

const myEventData: MyEvent = {
    type: "my-event",
    { some: "data" }
}
```

### Retain ability to descriminate event type unions after converting types

Previously, if you had a union of event types, you would lose the ability it descriminate them after converting them to `EventData` or a `RecordedEvent` due to typescript combining them into an intersection of the types. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/5f121cbadafa56d8dec6455bef0a861ab70e47a1)

#### Before:

```typescript
type MyFirstEvent = JSONEventType<
  "my-first-type",
  { some: string; other: string }
>;
type MySecondEvent = JSONEventType<
  "my-second-event",
  { other: string; another: boolean }
>;

type MyEvents = MyFirstEvent | MySecondEvent;
```

We can descriminate based on the `type` key.

```typescript
const descriminateType = (eventData: MyEvents) => {
  if (eventData.type === "my-first-type") {
    // { some: string; other: string; }
    eventData.data;
  } else {
    //  { other: string; another: boolean }
    eventData.data;
  }
};
```

However, this breaks down when `MyEvents` is passed directly to `JSONEventData` or a `JSONRecordedEvent`.

```typescript
const descriminateType = (eventData: JSONRecordedEvent<MyEvents>) => {
  if (eventData.type === "my-first-type") {
    // { some: string; other: string; } | { other: string; another: boolean }
    eventData.data;
  } else {
    // { some: string; other: string; } | { other: string; another: boolean }
    eventData.data;
  }
};
```

You would have to use the helper type `EventTypeToRecordedEvent` to retain correct descrimination.

```typescript
const descriminateType = (eventData: EventTypeToRecordedEvent<MyEvents>) => {
  if (eventData.type === "my-first-type") {
    // { some: string; other: string; }
    eventData.data;
  } else {
    // { other: string; another: boolean }
    eventData.data;
  }
};
```

#### After:

You can now pass your union directly to `JSONRecordedEvent`, `BinaryRecordedEvent` or the now generic `RecordedEvent` without losing the ability to descriminate the union:

```typescript
const descriminateType = (eventData: RecordedEvent<MyEvents>) => {
  if (eventData.type === "my-first-type") {
    // { some: string; other: string; }
    eventData.data;
  } else {
    // { other: string; another: boolean }
    eventData.data;
  }
};
```

All converter types (`EventTypeToRecordedEvent`, `RecordedEventToEventType`, `EventTypeToEventData`, `EventDataToEventType`, `RecordedEventToEventData`, `EventDataToRecordedEvent`) are still available.

#### Allow enforcing types on `appendToStream`

You can now enforce the types you append to a stream. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/5f121cbadafa56d8dec6455bef0a861ab70e47a1)

```typescript
await client.appendToStream<MyEvents>(`my_stream`, jsonEvents);
```

#### Export Options types

All method option types are not exported. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/2994ca9123ca91b6d093ef321671b9e8823cabb7)

## Bug Fixes

- Fix doc comment for persistent subscription `startFrom` [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/58e76ec07a69f97eb626dc8b3fc3679d4c6606b6)
- Ensure rediscovery is not run when the server returns a timeout [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/a8058d0c97af4a64be1f4906b6f20cb6459af227)

## Deprecations

- Consumer strategy names have been matched with server counterparts. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/d6099ef7039b3595da4effc7d521cf68b59ef30c)
  - `DISPATCH_TO_SINGLE`: `dispatch_to_single` -> `DispatchToSingle`;
  - `ROUND_ROBIN`: `round_robin` -> `RoundRobin`;
  - `PINNED`: `pinned` -> `Pinned`;
  - Only affects users who pass the strings directly. Constants have changed to match.
  - Previous strings will log a warning.
  - Will be removed in `v4.0.0`
- Persistent subscription methods, helpers and types relating to streams have been renamed to align with other method names. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/5a82a98c4fede4cd40cf825f828574163fc38c3b)
  - Methods:
    - `createPersistentSubscription` -> `createPersistentSubscriptionToStream`
    - `deletePersistentSubscription` -> `deletePersistentSubscriptionToStream`
    - `subscribeToPersistentSubscription` -> `subscribeToPersistentSubscriptionToStream`
    - `updatePersistentSubscription` -> `updatePersistentSubscriptionToStream`
  - Helper Functions:
    - `persistentSubscriptionSettingsFromDefaults` -> `persistentSubscriptionToStreamSettingsFromDefaults`
  - Types:
    - `PersistentSubscriptionSettings` -> `PersistentSubscriptionToStreamSettings`
    - `PersistentSubscription` -> `PersistentSubscriptionToStream`
  - Will be removed in `v4.0.0`

## [v3.1.0](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v3.0.0...v3.1.0) (2022-02-04)

## Features

- `getProjectionStatistics` has been renamed to `getProjectionStatus` to align with other clients. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/d03d5e9cd3e8d7974da31c24c4ad287b389e5eb9)

### Bug Fixes

- Increase maximum readable event size to match maximum event size that can be written internally. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/37474bd83c8e8f5f71050d96994ba663e9cbf6f6)

### Deprecations

- `getProjectionStatistics` is now deprecated [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/d03d5e9cd3e8d7974da31c24c4ad287b389e5eb9)
  - Will be removed in `v4.0.0`
  - Use `getProjectionStatus`

## [v3.0.0](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v2.1.1...v3.0.0) (2022-01-27)

### Breaking changes

#### EventStoreDBClient

- The default node preference is now `LEADER`. This applies when connecting with a connection string, and via the client constructor. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/96dfcfc3ae5536df1d7cf22b173c00044120f25f)

#### Persistent Subscriptions

The persistent subscriptions api has been updated to align with other eventstore clients, and the new persistent subscriptions to all api.

- `connectToPersistentSubscription` has been renamed to `subscribeToPersistentSubscription` [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/5266130e5794dfa3505160a7a61165b15ed32e9c)
- `persistentSubscriptionSettings` keys and default values have been changed. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/f7d5f7db012000ef82dac0e8b6fbcd4d598d812a)

<table>
  <thead>
    <tr>
      <th>Key</th> 
      <th>Default</th> 
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>
        <pre lang="diff">
- fromRevision
+ startFrom</pre>
      </td>
      <td>
        <pre lang="diff">
- START
+ END</pre>
      </td>
      <td>The exclusive position in the stream or transaction file the subscription should start from.</td>
    </tr>
    <tr>
      <td>
        <pre lang="diff">
- extraStats
+ extraStatistics</pre>
      </td>
      <td><code>false</code></td>
      <td>Enables if depth latency statistics should be tracked on subscription.</td>
    </tr>
    <tr>
      <td>
        <pre lang="diff">
- checkpointAfter
+ checkPointAfter</pre>
      </td>
      <td><code>2_000</code></td>
      <td>The amount of time to try checkpoint after in milliseconds.</td>
    </tr>
    <tr>
      <td>
        <pre lang="diff">
- minCheckpointCount
+ checkPointLowerBound</pre>
      </td>
      <td><code>10</code></td>
      <td>The minimum number of messages to process before a checkpoint may be written.</td>
    </tr>
    <tr>
      <td>
        <pre lang="diff">
- maxCheckpointCount
+ checkPointUpperBound</pre>
      </td>
      <td><code>1_000</code></td>
      <td>The maximum number of messages to process before a checkpoint may be written.</td>
    </tr>
    <tr>
      <td><code>maxSubscriberCount</code></td>
      <td>
        <pre lang="diff">
- UNLIMITED
+ UNBOUNDED</pre>
      </td>
      <td>The maximum number of subscribers allowed..</td>
    </tr>
    <tr>
      <td>
        <pre lang="diff">
- strategy
+ consumerStrategyName</pre>
      </td>
      <td><code>ROUND_ROBIN</code></td>
      <td>The strategy to use for distributing events to client consumers.</td>
    </tr>
    <tr>
      <td colspan="3" align="center">-- The following options remain unchanged. --</td>
    </tr>
    <tr>
      <td><code>resolveLinkTos</code></td>
      <td><code>false</code></td>
      <td>Also return events targeted by the links.</td>
    </tr>
    <tr>
      <td><code>messageTimeout</code></td>
      <td><code>30_000</code></td>
      <td>The amount of time in milliseconds after which a message should be considered to be timeout and retried.</td>
    </tr>
    <tr>
      <td><code>maxRetryCount</code></td>
      <td><code>10</code></td>
      <td>The maximum number of retries (due to timeout) before a message is considered to be parked.</td>
    </tr>
    <tr>
      <td><code>liveBufferSize</code></td>
      <td><code>500</code></td>
      <td>The size of the buffer listening to live messages as they happen.</td>
    </tr>
    <tr>
      <td><code>readBatchSize</code></td>
      <td><code>20</code></td>
      <td>The number of events read at a time when paging in history.</td>
    </tr>
    <tr>
      <td><code>historyBufferSize</code></td>
      <td><code>500</code></td>
      <td>The number of events to cache when paging through history.</td>
    </tr>
  </tbody>
</table>

- Constant `UNLIMITED` has been renamed to `UNBOUNDED`. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/f7d5f7db012000ef82dac0e8b6fbcd4d598d812a)

#### Projections

The projections api has been completely overhauled, removing one time and transient projections. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/d9fc4d1b40b7e65195f12dcc387c9028eceafcdc)

- `createProjection`:
  - `createContinuousProjection` has been renamed to `createProjection`.
  - `createOneTimeProjection` has been removed.
  - `createTransientProjection` has been removed.
- `listProjections`:
  - `listContinuousProjections` has been renamed to `listProjections`.
  - `listOneTimeProjections` has been removed.
  - `listTransientProjections` has been removed.
  - `mode` has been removed from `ProjectionDetails`, only `CONTINUOUS` projections are returned.
  - `CONTINUOUS` `ONE_TIME` & `TRANSIENT` constants have been removed.
- `resetProjection`:
  - `writeCheckpoint` option has been removed. (It previously had no effect ).
- `disableProjection`:
  - `writeCheckpoint` option has been removed. Use `abortProjection` if wishing to set this to `false`.
- `abortProjection`:
  - `abortProjection` method has been added.
- `deleteProjection`:
  - `deleteEmittedStreams` option now defaults to `false`.
  - `deleteStateStream` option now defaults to `false`.
  - `deleteCheckpointStream` option now defaults to `false`.
- `getProjectionState` & `getProjectionResult`:
  - `fromPartition` option has been renamed to `partition` [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/e7685d108ce77db63a2a9ce5480de41d4f8f5c1e)

#### Client Deadlines

The client now supports setting deadlines for non-streaming gRPC requests, with a default deadline of 10 seconds (formerly `Infinity`). [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/cdc673eee3eff97d0170a8250f251bb1712c7106)

- `defaultDeadline` global setting has been added to the constructor options and connection string.
- `deadline` option has been added to all methods, to allow setting the deadline per request.
- `DeadlineExceeded` error will now be thrown if a deadline has been exceeded.

### Features

#### Persistent Subscriptions to all

The client now supports persistent subscriptions to the all stream, for server version `21.10` and greater.

- Added `createPersistentSubscriptionToAll` method. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/f7d5f7db012000ef82dac0e8b6fbcd4d598d812a)

```ts
const groupName = "my_persistent_subscription";
const settings = persistentSubscriptionToAllSettingsFromDefaults({
  // start from the beginning of the all stream
  startFrom: START,
});
// Filter only events with type matching regex
const filter = eventTypeFilter({
  regex: "^[0-9]*_regex_filter_eventType_[A-z]*$",
});

// Create a persistent subscrition to the all stream
await client.createPersistentSubscriptionToAll(groupName, settings, { filter });
```

- Added `subscribeToPersistentSubscriptionToAll` method. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/bf660ef1d82c02cf577de439db2c5b5529399c0a)

```ts
// Connect to the created persistent subscription to all stream
const psToAll = client.subscribeToPersistentSubscriptionToAll(groupName);

for await (const event of psToAll) {
  doSomethingWithEvent(event);
  // Acknowledge that the event has been handled
  await psToAll.ack(event);
}
```

- Added `updatePersistentSubscriptionToAll` method. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/75aa261f6307408383b20a98447782ca77ce75c7)

```ts
const updatedSettings =  persistentSubscriptionToAllSettingsFromDefaults({
  // Ensure that our previous settings are persisted
  ...settings,
  // Enable extra statistics
  extraStatistics: true,
});

// Update the persistent subscription to use new settings.
await client.updatePersistentSubscriptionToAll(groupName, updatedSettings)l

```

- Added `deletePersistentSubscriptionToAll` method. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/cf4fa765282fe00cc3195acafcb75421fcd5f733)

```ts
// delete the unwanted persistent subscription to all
await client.deletePersistentSubscriptionToAll(groupName);
```

#### Other features

- When connected to server version `21.10` and greater, the client will now send appended events over a single duplex stream, resulting in much faster append times. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/4e764c1d3ca20627553ad16588a259d63283a31b)
- Client now internally checks if the server supports an api before sending a request. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/4122f6f17756c7a4deff0288bfb8af9adfca4aee)
- `fromPartition` option added to `getProjectionState` [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/a440c4558934e16cd43acb0cf49bc580a588659c)
- Improved `tlsVerifyCert` not supported message [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/6c6a67b2569fa54802af553f7b2b35114b91edb4)

### Bug Fixes

- Fixed incorrect log message where http was logged as https and vice versa. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/b056749de06338675fab25af35edb47f1042446d)
- `updateProjection` option `trackEmittedStreams` name has been corrected as `emitEnabled`. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/d9fc4d1b40b7e65195f12dcc387c9028eceafcdc)
- Prevent `WRITE_AFTER_END` from still being uncaught in rare cases. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/a1ba19a86fc440ceedc06b75a968ec1901f6eeec)

### Removal of Deprecated Apis

- Remove ack and nack via event id [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/5193cd6f1877e3c1e1cc19529754b2a43fb6df27)

## [v2.1.1](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v2.1.0...v2.1.1) (2021-09-29)

### Bug Fixes

- Ack and nack take a resolved event, rather than an event id [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/965dd70ae6ecadd1f4398e698299bea8b2aaa91e)
- Prevent `appendToStream` from writing after the stream has closed [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/75aa47d0f9769cc77d340ed941469b609e80690f)

### Deprecations

- Ack and nack via event id [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/965dd70ae6ecadd1f4398e698299bea8b2aaa91e)
  - Will be removed in `v3.0.0`.
  - Pass entire resolved event

## [v2.1.0](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v2.0.0...v2.1.0) (2021-08-05)

### Features

- `checkpointReached` callback added to filter to allow checkpointing filtered reads to all [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/0743b3d74a08a30b7476876e70fe7edf05e76b35)
- `LinkEvent` type added to event types [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/0183f104318a4ccf7547541b95d2f4bac6384e24)
- `resolveLinkTos` option added to `readAll` [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/0183f104318a4ccf7547541b95d2f4bac6384e24)

### Bug Fixes

- `parseConnectionString` allows different casings of `nodePreference` [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/9f1440d89070b3f6aee82ddfd50c3793f5f61bb0)

## [v2.0.0](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v1.2.2...v2.0.0) (2021-07-28)

### Breaking changes

- `readStream` and `readAll` return a stream of events [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/2dd21e66ad903e5fc111ca2105ace51817dc5cb0)

To allow for reading large numbers of events without running out of memory, `readSteam` and `readAll` now return a [readable stream](https://nodejs.org/api/stream.html#stream_readable_streams) rather than a promise of an array.

Before `v1.x`:

```ts
const events = await client.readStream<MyEventTypes>(streamName);

for (const event of events) {
  doSomething(event);
}
```

After `v2.x`:

```ts
const eventStream = client.readStream<MyEventTypes>(streamName);

for await (const event of eventStream) {
  doSomething(event);
}
```

### Features

- Reconnect on node loss [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/83e0145d3fcdf4a0713f84d5d58575148008249a)
- `readonlyreplica` node preference [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/0c5d29e3337502a3baf32452906b08691cc17c10)
- Faster data encoding [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/4cda18001f07f32eceb93a47644e8697fc4963ee)

### Bug Fixes

- Ensure member is in a connectable state during discovery [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/0c5d29e3337502a3baf32452906b08691cc17c10)

### Removal of Deprecated Apis

- `ConnectionTypeOptions` [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/5128e82a2d054aa5dd45f097d5095b60d35546da)

## [v1.2.2](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v1.2.1...v1.2.2) (2021-06-18)

### Features

- `DNSClusterOptions` `GossipClusterOptions` `SingleNodeOptions` types individually exported. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/16787856a5c5567dc3ca0bd86523f482c6af1def)

### Deprecations

- `ConnectionTypeOptions` [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/16787856a5c5567dc3ca0bd86523f482c6af1def)
  - Will be removed in `v2.0.0`.
  - Use newly exported members directly.

## [v1.2.1](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v1.2.0...v1.2.1) (2021-04-30)

### Features

- `ChannelCredentialOptions` interface exported. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/d40e33ca40c15e6a1262a3b77c47da9bf079e0ee)

## [v1.2.0](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v1.1.2...v1.2.0) (2021-04-22)

### Features

- Pass path to Certificate File in Connection String [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/9dc294991736ea5e6e26f302d393f2be86471ab8)

## [v1.1.2](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v1.1.1...v1.1.2) (2021-04-12)

### Bug Fixes

- Allow setting END for create persistent subscription `fromRevision` [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/710d4a0c04a314e5a27f0c786ac17a69706c4b31)

## [v1.1.1](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v1.1.0...v1.1.1) (2021-04-06)

### Bug Fixes

- Remove `console.log` in`TwoWaySubscription` [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/9d33ea9939c5c6cb62406c80feb2ccf88756fb89)

## [v1.1.0](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v1.0.2...v1.1.0) (2021-03-29)

### Features

- Add stream metadata methods [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/8fb2c4f95c6a2356e998790203ea78b04e8bd137)
  - `setStreamMetadata`
  - `getStreamMetadata`

## [v1.0.2](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v1.0.1...v1.0.2) (2021-03-23)

### Bug Fixes

- Replace all buffer encoding and decoding from `binary` (latin1) to `utf8` [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/d7bde0397096446e0f269381c6f678a4194fa79e)

## [v1.0.1](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v1.0.0...v1.0.1) (2021-02-25)

### Features

- Improved JSdoc comments [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/6e88a35c4ff118902a8952e88f89bae982e63e15)

### Bug Fixes

- Allow whitespace between tokens in connection string [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/63020d0639e01c66f9e9763ed7874d6be4c78063)

## [v1.0.0](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v0.0.0-alpha.17...v1.0.0) (2021-02-17)

### Features

- Keep alives [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/7934736faedf4e7ddec1d95a0a6561a3bb3bd8ac)
  - Keep server connection alive when network traffic is low.

## [v0.0.0-alpha.17](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v0.0.0-alpha.16...v0.0.0-alpha.17) (2021-02-11)

### Features

- Event types [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/243958a8b6d2a56bc17eb239408c0826a4905c0d)
  - Strongly type your events in `readEvents`, `subscribeToEvents` and `connectToPersistantSubscription`.

## [v0.0.0-alpha.16](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v0.0.0-alpha.15...v0.0.0-alpha.16) (2021-02-04)

### Bug Fixes

- `count` renamed to `maxCount` and made optional [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/3bea69d575932bfd5c0870c6da6ffe143e113019)
- Do not send credentials over insecure connection [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/3823115776b5555ba20ba7919be134f83f7d576a)

## [v0.0.0-alpha.15](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v0.0.0-alpha.14...v0.0.0-alpha.15) (2021-01-27)

### Bug Fixes

- Apply workaround for http2 assertion failure [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/92977d1cca5343ee604b9e519b9b77061216985f)

## [v0.0.0-alpha.14](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v0.0.0-alpha.13...v0.0.0-alpha.14) (2021-01-25)

### Features

- Improved `subscribeToAll` filters [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/972d7eba9291fb65b5a576d3b619377aa5a80ac3)
- `excludeSystemEvents` helper [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/395cd9a829b7bbe8c061d7263a0122ad13f5e0b2)

## [v0.0.0-alpha.13](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v0.0.0-alpha.12...v0.0.0-alpha.13) (2021-01-14)

### Features

- Discovery options [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/ce0c488495fc7b4780b89d0576342027f2547979)
- `throwOnAppendFailure` [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/a10bb649e77f486ff2ac6dfba6bc5182793dc398)
- Correct naming `nextExpectedVersion` to `nextExpectedRevision` [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/4f470625d96fe0943e11727d9473afdd0d7d9bd2)

### Bug Fixes

- Case-insensitive keys in connection string (#109) [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/ac6e02c640ef80111dd903ea3e73a142dc4924f9)
- Don't assume that metadata matches the event type [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/dd0992487811248bfe66dba883b8f1afaaead4fd)
- Prevent possible Channel race condition, that could allow a client to send requests to separate nodes. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/f8bb84e15657e3a71f00db19c1c6b77d347419e5)

## [v0.0.0-alpha.12](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v0.0.0-alpha.11...v0.0.0-alpha.12) (2020-12-30)

### Features

- Add generics to event types [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/1f51cf687dd6dcb1cc1a14d888a65d19c0b317c8)

### Bug Fixes

- Incorrect name in `subscribeToStream` debug messages [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/d20ab4cb8a77334de50545ccb850497fcffbed3f)
- .NET Client naming alignment [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/eebe7737e4ac5e632d7d2493c0919e593c35f010)

## [v0.0.0-alpha.11](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v0.0.0-alpha.10...v0.0.0-alpha.11) (2020-12-22)

### Bug Fixes

- Fix streams for node version 12.x [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/b5d0f1b7d621f06d73f338d459647daf2aa122f7)

## [v0.0.0-alpha.10](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v0.0.0-alpha.9...v0.0.0-alpha.10) (2020-12-21)

### Features

- Subscriptions return `ReadableStreams` [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/f3b4ed4149d6d8f1b0133884db494f152c7b6dac)

### Bug Fixes

- .NET Client naming alignment [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/54096c9658a9c6474f02f18a37a37f3e66adca89)

## [v0.0.0-alpha.9](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v0.0.0-alpha.8...v0.0.0-alpha.9) (2020-12-08)

### Features

- large internal refactor

### Bug Fixes

- Update DNS discovery to work properly with EventStore Cloud. [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/c6c510af1662f48a57b6ba06815d53d67a31ecce)

## [v0.0.0-alpha.8](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v0.0.0-alpha.7...v0.0.0-alpha.8) (2020-11-19)

### Bug Fixes

- Don't assume that events with content type `application/json` contain valid JSON [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/9c90fbc19cd35a08134f5918b35ae72541672fd5)

## [v0.0.0-alpha.7](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v0.0.0-alpha.6...v0.0.0-alpha.7) (2020-11-04)

### Features

- Connection string [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/bb5e14f0b448d7a3915c4b97193cadd325d5b5e7)
- `defaultCredentials` [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/4a07ef50acae3de0793bff5ceac3d144483574b4)

### Bug Fixes

- Test utilities accidentally being included in package [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/ee88c6c4799eeeb864047822e22fa933fde06d97)

## [v0.0.0-alpha.6](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v0.0.0-alpha.5...v0.0.0-alpha.6) (2020-10-30)

## [v0.0.0-alpha.5](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v0.0.0-alpha.4...v0.0.0-alpha.5) (2020-10-30)

### Features

- Projections API [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/1e1cbf65936443b7b16ace3f64144851fc7e43ef)

### Bug Fixes

- Use secure by default [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/08ee2042f6c816abcc516fc2f793ba373ab59f86)

## [v0.0.0-alpha.4](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v0.0.0-alpha.3...v0.0.0-alpha.4) (2020-10-21)

### Features

- debugging [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/348b05be8fafe94a1fc2eeab8fae47585824de8f)

  - Set the `DEBUG` environment variable to `esdb:*` to enable debug logs

### Bug Fixes

- `streamName` is correctly converted to as string in `StreamNotFoundError` [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/231f60a37db817be557322598af315376619fd83)

## [v0.0.0-alpha.3](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v0.0.0-alpha.2...v0.0.0-alpha.3) (2020-10-09)

## [v0.0.0-alpha.2](https://github.com/EventStore/EventStore-Client-NodeJS/compare/v0.0.0-alpha.1...v0.0.0-alpha.2) (2020-09-29)

### Bug Fixes

- Do not return position on stream read events [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/1764a2a73f76b2a2e05593e2f7659fb0b9312e0c)
- Remove `no_stream` `expectedRevision` from `tombstone` (not supported by server) [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/47a0c666ef187ead7e0eaa2db97631f2e78dcd03)
- Fix `ack` and `nack` [View](https://github.com/EventStore/EventStore-Client-NodeJS/commit/d144b6f9741679cb75f55420a54ba2da7dd968de)