feat(ddd): add Entity.toJSON primitive serializer#53
Merged
Conversation
Add Entity.toJSON() to emit id, createdAt, and props in one normalized primitive object so entity snapshots are consistent for transport and logging.
🦋 Changeset detectedLatest commit: e7ea76f The changes in this PR will be included in the next version bump. This PR includes changesets to release 4 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Introduce Entity.toJSON() method to return a JSON object containing id, createdAt, and entity properties, ensuring consistent serialization for transport and logging.
…n test Adjust the entity serialization test to ensure the id property is included in the expected JSON output, maintaining consistency with the Entity.toJSON() implementation.
Merged
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.
Summary
Entity.toJSON()method that returns a single object withid,createdAt, and all entity propstoJSON())Entity.toJSON()in the entity test suiteContext
This provides a consistent serialization contract at the entity base class level, reducing duplicate mapping logic in subclasses and making entity snapshots easier to use in transport/logging scenarios.
Breaking changes
Test plan
Entity.toJSON()output shape and primitive valuesNotes
pnpm vitest packages/ddd/src/domain/entities/__tests__/entity.spec.tscurrently fails in this environment due to an existing module resolution issue (Cannot find package '@/shared'), unrelated to this change.