Enhancement: Nullable 1-1 Relations

[the-mediocre-dev]

Proposed changes

It is not uncommon to design relations between tables with a nullable foreign key, signalling a 0-1 relation rather than a 1-1. While lucid will allow this, the typings do not, meaning that downstream from the models the typings cannot be trusted. This change adds Typescript support for nullable HasOne and BelongsTo relations, as such:

@hasOne(() => Profile)
public profile: HasOne<typeof Profile> | null

Discussed in:

• Nullable belongsTo relationships #941

Types of changes

Relationship type changes

Put an x in the boxes that apply

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

• I have read the CONTRIBUTING doc
• Lint and unit tests pass locally with my changes
• I have added tests that prove my fix is effective or that my feature works.
• I have added necessary documentation (if appropriate)

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.