Skip to content

Commit

Permalink
Strongly type the user_id of a Beatmapset's Event
Browse files Browse the repository at this point in the history
  • Loading branch information
@TTTaevas
TTTaevas committed Mar 28, 2024
1 parent b056173 commit 8795d57
Showing 1 changed file with 87 additions and 50 deletions.
137 changes: 87 additions & 50 deletions lib/beatmapset.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,6 @@ export namespace Beatmapset {
"genre_edit" | "language_edit" | "nsfw_toggle" | "offset_edit" | "tags_edit" | "beatmap_owner_change"
comment: object | null
created_at: Date
user_id: User["id"] | null
beatmapset: Beatmapset.WithUserHype
}

Expand All @@ -120,89 +119,127 @@ export namespace Beatmapset {
interface WithOptionalDiscussion extends Event {
discussion?: Discussion.WithStartingpost | null
}

interface WithUserid extends Event {
user_id: User["id"]
}

export interface NoComment extends Event {
type: "love" | "qualify" | "rank"
comment: null
/** @group Beatmap Change */
export interface BeatmapOwnerChange extends WithUserid {
type: "beatmap_owner_change"
comment: Comment.WithDiscussionidPostidBeatmapidBeatmapversionNewuseridNewuserusername
}

export interface Nominate extends Event {
type: "nominate"
comment: Comment.WithModes
/** @group Beatmap Change */
export interface GenreEdit extends WithUserid {
type: "genre_edit"
comment: Comment.WithDiscussionidPostidOldgenreNewgenre
}

/** A Generic event is one where the comment is simply a discussion id and a post id */
export interface Generic extends Event {
type: "discussion_delete"
comment: Comment.WithDiscussionidPostid
/** @group Beatmap Change */
export interface LanguageEdit extends WithUserid {
type: "language_edit"
comment: Comment.WithDiscussionidPostidOldlanguageNewlanguage
}

/**
* @remarks Depending of the type, when the discussion is not a `Discussion`, then it is either `null` or `undefined`;
* Because `null` and `undefined` are both falsy, those types are regrouped in this interface instead of being distinct
*/
export interface GenericWithOptionalDiscussion extends WithOptionalDiscussion {
type: "kudosu_recalculate" | "discussion_lock" | "discussion_unlock" | "discussion_restore"
comment: Comment.WithDiscussionidPostid
/** @group Beatmap Change */
export interface NsfwToggle extends WithUserid {
type: "nsfw_toggle"
comment: Comment.WithDiscussionidPostidOldnsfwNewnsfw
}

export interface GenericWithDiscussion extends WithDiscussion {
type: "kudosu_allow" | "kudosu_deny" | "issue_resolve" | "issue_reopen" | "discussion_post_delete" | "discussion_post_restore"
comment: Comment.WithDiscussionidPostid
/** @group Beatmap Change */
export interface OffsetEdit extends WithUserid {
type: "offset_edit"
comment: Comment.WithDiscussionidPostidOldoffsetNewoffset
}

/** @group Beatmap Change */
export interface TagsEdit extends WithOptionalDiscussion, WithUserid {
type: "tags_edit"
comment: Comment.WithDiscussionidPostidOldtagsNewtags
}

export type AnyBeatmapChange = BeatmapOwnerChange | GenreEdit | LanguageEdit | NsfwToggle | OffsetEdit | TagsEdit

/** @group Beatmapset Status Change */
export interface QualifyORRank extends Event {
type: "qualify" | "rank"
comment: null
}

/** @group Beatmapset Status Change */
export interface Love extends WithUserid {
type: "love"
comment: null
}

export interface RemoveFromLoved extends Event {
/** @group Beatmapset Status Change */
export interface Nominate extends WithUserid {
type: "nominate"
comment: Comment.WithModes
}

/** @group Beatmapset Status Change */
export interface RemoveFromLoved extends WithUserid {
type: "remove_from_loved"
comment: Comment.WithDiscussionidPostidReason
}

export interface DisqualifyORNominationReset extends WithDiscussion {
/** @group Beatmapset Status Change */
export interface DisqualifyORNominationReset extends WithDiscussion, WithUserid {
type: "disqualify" | "nomination_reset"
comment: Comment.WithDiscussionidPostidNominatorsids
}

export interface GenreEdit extends Event {
type: "genre_edit"
comment: Comment.WithDiscussionidPostidOldgenreNewgenre
/** @group Beatmapset Status Change */
export interface NominationResetReceived extends WithDiscussion, WithUserid {
type: "nomination_reset_received"
comment: Comment.WithDiscussionidPostidSourceuseridSourceuserusername
}

export interface LanguageEdit extends Event {
type: "language_edit"
comment: Comment.WithDiscussionidPostidOldlanguageNewlanguage
}
export type AnyBeatmapsetStatusChange = QualifyORRank | Love | Nominate | RemoveFromLoved | DisqualifyORNominationReset | NominationResetReceived

export interface NsfwToggle extends Event {
type: "nsfw_toggle"
comment: Comment.WithDiscussionidPostidOldnsfwNewnsfw
/** @group Discussion Change */
export interface DiscussionDelete extends Event {
type: "discussion_delete"
comment: Comment.WithDiscussionidPostid
}

export interface OffsetEdit extends Event {
type: "offset_edit"
comment: Comment.WithDiscussionidPostidOldoffsetNewoffset
/** @group Discussion Change */
export interface DiscussionRestoreORKudosuRecalculate extends WithOptionalDiscussion {
type: "discussion_restore" | "kudosu_recalculate"
comment: Comment.WithDiscussionidPostid
}

export interface TagsEdit extends WithOptionalDiscussion {
type: "tags_edit"
comment: Comment.WithDiscussionidPostidOldtagsNewtags
/** @group Discussion Change */
export interface KudosuAllowORDenyORDiscussionPostDeleteORRestore extends WithDiscussion {
type: "kudosu_allow" | "kudosu_deny" | "discussion_post_delete" | "discussion_post_restore"
comment: Comment.WithDiscussionidPostid
}

export interface KudosuChange extends WithDiscussion {
type: "kudosu_gain" | "kudosu_lost"
comment: Comment.WithDiscussionidPostidNewvotevotes
/** @group Discussion Change */
export interface DiscussionLockORUnlock extends WithOptionalDiscussion, WithUserid {
type: "discussion_lock" | "discussion_unlock"
comment: Comment.WithDiscussionidPostid
}

export interface NominationResetReceived extends WithDiscussion {
type: "nomination_reset_received"
comment: Comment.WithDiscussionidPostidSourceuseridSourceuserusername
/** @group Discussion Change */
export interface IssueResolveOrReopen extends WithDiscussion, WithUserid {
type: "issue_resolve" | "issue_reopen"
comment: Comment.WithDiscussionidPostid
}

export interface BeatmapOwnerChange extends Event {
type: "beatmap_owner_change"
comment: Comment.WithDiscussionidPostidBeatmapidBeatmapversionNewuseridNewuserusername
/** @group Discussion Change */
export interface KudosuGainORLost extends WithDiscussion, WithUserid {
type: "kudosu_gain" | "kudosu_lost"
comment: Comment.WithDiscussionidPostidNewvotevotes
}

export type Any = NoComment | Nominate | Generic | GenericWithOptionalDiscussion | GenericWithDiscussion | RemoveFromLoved | DisqualifyORNominationReset |
GenreEdit | LanguageEdit | NsfwToggle | OffsetEdit | TagsEdit | KudosuChange | NominationResetReceived | BeatmapOwnerChange
export type AnyDiscussionChange = DiscussionDelete | DiscussionRestoreORKudosuRecalculate | KudosuAllowORDenyORDiscussionPostDeleteORRestore |
DiscussionLockORUnlock | IssueResolveOrReopen | KudosuGainORLost

export type Any = AnyBeatmapChange | AnyBeatmapsetStatusChange | AnyDiscussionChange

/** An event's comment (unrelated to comments in bundles) can be a **lot** of things depending of the event type */
export interface Comment {}
Expand Down

0 comments on commit 8795d57

Please sign in to comment.