Feat/add structured events for payroll run creation - #229
Open
PeterGado wants to merge 3 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces a structured event emitted upon the creation or initialization of a payroll run. This enhancement significantly strengthens our contract layer by improving auditability, test coverage, and overall system visibility for SDK and dashboard consumers.
Changes Implemented
Event Definition: Defined a predictable event shape for payroll run creation, including key identifiers such as company_id and payroll_run_id.
Contract Logic: Updated the relevant contract function to emit this structured event upon successful initialization.
Testing: Added assertions and comprehensive tests to verify that the event is correctly emitted with the expected payloads.
Documentation: Updated README.md to document the new event shape and its structure for SDK and dashboard consumers.
Acceptance Criteria Checklist
[x] Payroll run creation emits a predictable, structured event.
[x] Event payload includes company_id and payroll_run_id.
[x] Tests confirm correct event emission.
[x] Event shape is fully documented.