feat(signals): add Events plugin

[markostanimirovic]

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our guidelines: https://github.com/ngrx/platform/blob/main/CONTRIBUTING.md#commit
• Tests for the changes have been added (for bug fixes / features)
• Documentation has 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?

Closes #4580

What is the new behavior?

Events plugin has been added to the @ngrx/signals package.

Does this PR introduce a breaking change?

[ ] Yes
[x] No

[netlify]

❌ Deploy Preview for ngrx-site-v19 failed.

Name	Link
🔨 Latest commit	01585bd
🔍 Latest deploy log	https://app.netlify.com/sites/ngrx-site-v19/deploys/681e678fe2712b00083f420f

[netlify]

✅ Deploy Preview for ngrx-io canceled.

Name	Link
🔨 Latest commit	01585bd
🔍 Latest deploy log	https://app.netlify.com/sites/ngrx-io/deploys/681e678f95ac50000832a1cd

[timdeschryver]

This is looking good! 🤘
I left a couple of questions.

To include it to the docs you'll to also have to update the following files:

• projects/ngrx.io/tools/transforms/authors-package/api-package.js
• projects/ngrx.io/tools/transforms/angular-api-package/index.js

[rainerhahnekamp]

Super! I've left a few comments.

Some of them may have already been discussed during the RFC, but they only became apparent to me once I started using it.

[markostanimirovic]

Changes from the last commit:

• Added additional tests
• eventCreator and eventCreatorGroup functions are renamed back to event and eventGroup for simplicity
• Event type is renamed to EventInstance to avoid naming conflict with the global Event type
• Explicit payload property is used for events. This change significantly simplified the implementation:
  • There are no multiple types for event/event creators with and without payload (Event/EventWithProps and EventCreator/EventCreatorWithProps). Instead, there are only two types: EventInstance and EventCreator.
  • props and emptyProps helpers are deleted. type from the core @ngrx/signals package can be used to define the payload type
  • Runtime checks of the payload type are removed because they're not needed anymore
  • Runtime check when the event creator is accidentally dispatched instead of the event is removed - compilation error will be thrown instead
• The second argument (state) is removed from the case reducer callback because a partial state updater can be returned.

[timdeschryver]

Nice work! 😎

[rainerhahnekamp]

Very good, just a minor issue with filenames and jsdoc for event(group) and the bigger one with including methods in withEffects

[rainerhahnekamp]

Wonderful. Good to go 🚀