-
Notifications
You must be signed in to change notification settings - Fork 0
Feature/member domain model v2 #48
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
strawberri16
wants to merge
11
commits into
main
Choose a base branch
from
feature/member-domain-model-v2
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
f42649a
added the member domain model-attemp-2
strawberri16 6284d18
feat(database): update Prisma member schema and create migration
WilliamTayNZ aff4f4a
fix(admin-members): removed original admin placeholder due to schema …
WilliamTayNZ 861ac88
Merge branch 'main' of https://github.com/UoaWDCC/lug into feature/me…
strawberri16 d6922c7
added Member Registration domain types
strawberri16 95ce9f3
added member registration domain types
strawberri16 cae0742
Merge branch 'feature/member-domain-model-v2' of https://github.com/U…
strawberri16 282500c
feat(member): define registration domain types
strawberri16 c195183
feat(member): fixed the registration types
strawberri16 1e33ed3
cleaned up code per PR review
strawberri16 5b8fb30
Merge branch 'main' into feature/member-domain-model-v2
strawberri16 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,64 @@ | ||
| // Vedanti will develop this | ||
| // If you are doing the validation task, I will provide you with the expected domain shape | ||
| export type LinuxSkillLevel = | ||
| | "NOTHING" | ||
| | "AWARE_OF_EXISTENCE" | ||
| | "BEGINNER_USER" | ||
| | "REGULAR_USER" | ||
| | "POWER_USER" | ||
| | "CONTRIBUTOR"; | ||
|
|
||
| export type PotentialInvolvement = | ||
| | "ATTENDING" | ||
| | "SPEAKING" | ||
| | "EXECUTIVE" | ||
| | "PROJECTS"; | ||
|
|
||
| export type YearLevel = | ||
| | "FIRST_YEAR" | ||
| | "SECOND_YEAR" | ||
| | "THIRD_YEAR" | ||
| | "FOURTH_YEAR" | ||
| | "FIFTH_YEAR_OR_LATER" | ||
| | "GRADUATED_WITHIN_2_YEARS"; | ||
|
|
||
| // Shared base fields present on every registration path | ||
| export type BaseMemberRegistration = { | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is good, but one field is missing! (and its an optional field) Can we also leave an empty line after the email field? (very nitpicky) |
||
| firstName: string; | ||
| lastName: string; | ||
| email: string; | ||
| discordUsername?: string; | ||
| linuxSkillLevel: LinuxSkillLevel; | ||
| potentialInvolvement: PotentialInvolvement[]; | ||
| }; | ||
|
|
||
| // Case 1: Returning member - Registration path 1 | ||
| export type ConditionalReturningMember = BaseMemberRegistration & { | ||
| isConditionalReturningMember: true; | ||
| upi: string; | ||
| studentId: string; | ||
| }; | ||
|
|
||
| // Case 2: Current UoA student - Registration path 2 | ||
| export type CurrentUoaStudentMember = BaseMemberRegistration & { | ||
| isConditionalReturningMember: false; | ||
| isCurrentUoaStudent: true; | ||
| upi: string; | ||
| studentId: string; | ||
| faculty: string[]; | ||
| programme: string; | ||
| yearLevel: YearLevel; | ||
| }; | ||
|
|
||
| // Case 3: Non-current UoA student - Registration path 3 | ||
| export type NonCurrentUoaStudentMember = BaseMemberRegistration & { | ||
| isConditionalReturningMember: false; | ||
| isCurrentUoaStudent: false; | ||
| primaryAffiliation: string; | ||
| nonUoaExcerpt?: string; | ||
| nonUoaPitch?: string; | ||
| }; | ||
|
|
||
| // Union type used everywhere a registration is handled | ||
| export type MemberRegistration = | ||
| | ConditionalReturningMember | ||
| | CurrentUoaStudentMember | ||
| | NonCurrentUoaStudentMember; | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The LinuxSkillLevel, PotentialInvolvement, YearLevel are generally good, this comment is more nitpicky.
We want to capitalise the values in the types, this is not strictly necessary, but these correspond to enums in Prisma, and it is convention for enum values in Prisma to be capitalised, so we prefer the domain to match this.
Would also prefer to use these names for the values (very nitpicky)
LinuxSkillLevel: "NOTHING", "AWARE_OF_EXISTENCE", "BEGINNER_USER", "REGULAR_USER", "POWER_USER", "CONTRIBUTOR"
PotentialInvolvement: "ATTENDING", "SPEAKING", "EXECUTIVE", "PROJECTS"
YearLevel: "FIRST_YEAR", "SECOND_YEAR", "THIRD_YEAR", "FOURTH_YEAR", "FIFTH_YEAR_OR_LATER", "POSTGRADUATE"