feat(state-history): 🔥 Add an option to control future state

[johnfewell]

An option called resetFutureOnNewState has been added to the StateHistoryOptions interface. This option allows the user to control whether the future redo states should be cleared when a new state is added after the user has undone one or more state changes. The default value of this option is set to false, meaning that by default, the future states will not be cleared.

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our guidelines: https://github.com/ngneat/elf/blob/master/CONTRIBUTING.md#commit
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Currently, when a new state is added after the user has undone one or more state changes, the future redo states are not cleared.

Issue Number: N/A

What is the new behavior?

A new option called resetFutureOnNewState has been added to the StateHistoryOptions interface. This option allows the user to control whether the future redo states should be cleared when a new state is added after the user has undone one or more state changes. The default value of this option is set to false, meaning that by default, the future states will not be cleared.

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

This new feature provides more control to the user over the state history and can prevent unnecessary state changes from being redone. It is a useful feature for applications that need finer control over state changes and their history.

[stackblitz]

Run & review this pull request in StackBlitz Codeflow.