feat(ddd): add DeepPrimitive type for type-safe Entity.toJSON()#73
Merged
Conversation
Introduce DeepPrimitive<T> and EntityJson<ID, Props> to infer structural JSON-safe return types from entity props, replacing Record<string, unknown> on toJSON() while keeping normalize() runtime behavior unchanged. Co-authored-by: Cursor <cursoragent@cursor.com>
🦋 Changeset detectedLatest commit: 30ecf60 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 |
Co-authored-by: Cursor <cursoragent@cursor.com>
Handle Tagged<UuID> IDs by introducing JsonIdValue and modeling EntityJson as DeepPrimitive<Props> plus explicit createdAt/id fields. Revert generic normalize to avoid excessive type instantiation depth in CI. Co-authored-by: Cursor <cursoragent@cursor.com>
Reorganized import statements in entity.ts for clarity and consistency. Updated the JsonPrimitive type definition in deep-primitive.type.ts to maintain a consistent order of primitive types. Co-authored-by: Cursor <cursoragent@cursor.com>
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
DeepPrimitive<T>recursive type utility mirroringEntity.normalize()runtime behaviorEntityJson<ID, Props>alias for structuraltoJSON()return typesEntity.toJSON()asEntityJson<ID, Props>instead ofRecord<string, unknown>tsdtype tests forDeepPrimitiveandEntity.toJSON()shapeCloses #72
Test plan
pnpm test:typesinpackages/dddpnpm check-typesinpackages/dddpnpm testinpackages/ddd(174 tests)Made with Cursor