Merge pull request #28 from TTTaevas/chat

Introduce functions related to chatting
TTTaevas · Nov 27, 2023 · 9729c41 · 9729c41
2 parents 8ed659b + 67005b9
commit 9729c41
Show file tree

Hide file tree

Showing 97 changed files with 802 additions and 442 deletions.
diff --git a/README.md b/README.md
@@ -107,16 +107,16 @@ Your `refresh_token` can actually also expire at a (purposefully) unknown time,
 - [ ] Lookup Changelog Build // likely won't implement unless I get convinced it's worth the confusion with Get Changelog Build
 
 ### Chat
-- [ ] Chat Keepalive
-- [ ] Create New PM
-- [ ] Get Channel Messages
-- [ ] Send Message to Channel
-- [ ] Join Channel
-- [ ] Leave Channel
-- [ ] Mark Channel as Read
-- [ ] Get Channel List
-- [ ] Create Channel
-- [ ] Get Channel
+- [x] Chat Keepalive
+- [x] Create New PM
+- [x] Get Channel Messages
+- [x] Send Message to Channel
+- [x] Join Channel
+- [x] Leave Channel
+- [x] Mark Channel as Read
+- [x] Get Channel List
+- [x] Create Channel // split between createChatPrivateChannel() and createChatAnnouncementChannel()
+- [x] Get Channel // removing `users` because `channel` would already have this property
 
 ### Comments
 - [ ] Get Comments

diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/API.html b/docs/classes/API.html
diff --git a/docs/classes/APIError.html b/docs/classes/APIError.html
diff --git a/docs/enums/RankStatus.html b/docs/enums/RankStatus.html
diff --git a/docs/enums/Rulesets.html b/docs/enums/Rulesets.html
diff --git a/docs/functions/generateAuthorizationURL.html b/docs/functions/generateAuthorizationURL.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/interfaces/Beatmap.html b/docs/interfaces/Beatmap.html
diff --git a/docs/interfaces/BeatmapDifficultyAttributes.html b/docs/interfaces/BeatmapDifficultyAttributes.html
diff --git a/docs/interfaces/BeatmapDifficultyAttributesFruits.html b/docs/interfaces/BeatmapDifficultyAttributesFruits.html
diff --git a/docs/interfaces/BeatmapDifficultyAttributesMania.html b/docs/interfaces/BeatmapDifficultyAttributesMania.html
diff --git a/docs/interfaces/BeatmapDifficultyAttributesOsu.html b/docs/interfaces/BeatmapDifficultyAttributesOsu.html
diff --git a/docs/interfaces/BeatmapDifficultyAttributesTaiko.html b/docs/interfaces/BeatmapDifficultyAttributesTaiko.html
diff --git a/docs/interfaces/BeatmapExtended.html b/docs/interfaces/BeatmapExtended.html
diff --git a/docs/interfaces/BeatmapExtendedWithFailtimes.html b/docs/interfaces/BeatmapExtendedWithFailtimes.html
diff --git a/docs/interfaces/BeatmapExtendedWithFailtimesBeatmapsetextended.html b/docs/interfaces/BeatmapExtendedWithFailtimesBeatmapsetextended.html
diff --git a/docs/interfaces/BeatmapPack.html b/docs/interfaces/BeatmapPack.html
diff --git a/docs/interfaces/BeatmapPlaycount.html b/docs/interfaces/BeatmapPlaycount.html
diff --git a/docs/interfaces/BeatmapUserScore.html b/docs/interfaces/BeatmapUserScore.html
diff --git a/docs/interfaces/BeatmapWithBeatmapset.html b/docs/interfaces/BeatmapWithBeatmapset.html
diff --git a/docs/interfaces/BeatmapWithBeatmapsetChecksumMaxcombo.html b/docs/interfaces/BeatmapWithBeatmapsetChecksumMaxcombo.html
diff --git a/docs/interfaces/Beatmapset.html b/docs/interfaces/Beatmapset.html
diff --git a/docs/interfaces/BeatmapsetExtended.html b/docs/interfaces/BeatmapsetExtended.html
diff --git a/docs/interfaces/BeatmapsetExtendedPlus.html b/docs/interfaces/BeatmapsetExtendedPlus.html
diff --git a/docs/interfaces/BeatmapsetExtendedWithBeatmapExtended.html b/docs/interfaces/BeatmapsetExtendedWithBeatmapExtended.html
diff --git a/docs/interfaces/ChangelogBuildWithChangelogentriesVersions.html b/docs/interfaces/ChangelogBuildWithChangelogentriesVersions.html
diff --git a/docs/interfaces/ChangelogBuildWithUpdatestreams.html b/docs/interfaces/ChangelogBuildWithUpdatestreams.html
diff --git a/docs/interfaces/ChangelogBuildWithUpdatestreamsChangelogentries.html b/docs/interfaces/ChangelogBuildWithUpdatestreamsChangelogentries.html
diff --git a/docs/interfaces/ChatChannel.html b/docs/interfaces/ChatChannel.html
diff --git a/docs/interfaces/ChatChannelWithDetails.html b/docs/interfaces/ChatChannelWithDetails.html
diff --git a/docs/interfaces/ChatMessage.html b/docs/interfaces/ChatMessage.html
diff --git a/docs/interfaces/Event.html b/docs/interfaces/Event.html
diff --git a/docs/interfaces/EventAchievement.html b/docs/interfaces/EventAchievement.html
diff --git a/docs/interfaces/EventBeatmap.html b/docs/interfaces/EventBeatmap.html
diff --git a/docs/interfaces/EventBeatmapPlaycount.html b/docs/interfaces/EventBeatmapPlaycount.html
diff --git a/docs/interfaces/EventBeatmapset.html b/docs/interfaces/EventBeatmapset.html
diff --git a/docs/interfaces/EventBeatmapsetApprove.html b/docs/interfaces/EventBeatmapsetApprove.html
diff --git a/docs/interfaces/EventBeatmapsetDelete.html b/docs/interfaces/EventBeatmapsetDelete.html
diff --git a/docs/interfaces/EventBeatmapsetRevive.html b/docs/interfaces/EventBeatmapsetRevive.html
diff --git a/docs/interfaces/EventBeatmapsetUpdate.html b/docs/interfaces/EventBeatmapsetUpdate.html
diff --git a/docs/interfaces/EventBeatmapsetUpload.html b/docs/interfaces/EventBeatmapsetUpload.html
diff --git a/docs/interfaces/EventRank.html b/docs/interfaces/EventRank.html
diff --git a/docs/interfaces/EventRankLost.html b/docs/interfaces/EventRankLost.html
diff --git a/docs/interfaces/EventUser.html b/docs/interfaces/EventUser.html
diff --git a/docs/interfaces/EventUserSupportAgain.html b/docs/interfaces/EventUserSupportAgain.html
diff --git a/docs/interfaces/EventUserSupportFirst.html b/docs/interfaces/EventUserSupportFirst.html
diff --git a/docs/interfaces/EventUserSupportGift.html b/docs/interfaces/EventUserSupportGift.html
diff --git a/docs/interfaces/EventUsernameChange.html b/docs/interfaces/EventUsernameChange.html
diff --git a/docs/interfaces/ForumPost.html b/docs/interfaces/ForumPost.html
diff --git a/docs/interfaces/ForumTopic.html b/docs/interfaces/ForumTopic.html
diff --git a/docs/interfaces/KudosuHistory.html b/docs/interfaces/KudosuHistory.html
diff --git a/docs/interfaces/Leader.html b/docs/interfaces/Leader.html
diff --git a/docs/interfaces/Match.html b/docs/interfaces/Match.html
diff --git a/docs/interfaces/MatchInfo.html b/docs/interfaces/MatchInfo.html
diff --git a/docs/interfaces/MultiplayerScore.html b/docs/interfaces/MultiplayerScore.html
diff --git a/docs/interfaces/MultiplayerScores.html b/docs/interfaces/MultiplayerScores.html
diff --git a/docs/interfaces/NewsPost.html b/docs/interfaces/NewsPost.html
diff --git a/docs/interfaces/NewsPostWithContentNavigation.html b/docs/interfaces/NewsPostWithContentNavigation.html
diff --git a/docs/interfaces/PlaylistItem.html b/docs/interfaces/PlaylistItem.html
diff --git a/docs/interfaces/PollConfig.html b/docs/interfaces/PollConfig.html
diff --git a/docs/interfaces/Rankings.html b/docs/interfaces/Rankings.html
diff --git a/docs/interfaces/RankingsCountry.html b/docs/interfaces/RankingsCountry.html
diff --git a/docs/interfaces/RankingsSpotlight.html b/docs/interfaces/RankingsSpotlight.html
diff --git a/docs/interfaces/Room.html b/docs/interfaces/Room.html
diff --git a/docs/interfaces/Score.html b/docs/interfaces/Score.html
diff --git a/docs/interfaces/ScoreWithMatch.html b/docs/interfaces/ScoreWithMatch.html
diff --git a/docs/interfaces/ScoreWithUser.html b/docs/interfaces/ScoreWithUser.html
diff --git a/docs/interfaces/ScoreWithUserBeatmap.html b/docs/interfaces/ScoreWithUserBeatmap.html
diff --git a/docs/interfaces/ScoreWithUserBeatmapBeatmapset.html b/docs/interfaces/ScoreWithUserBeatmapBeatmapset.html
diff --git a/docs/interfaces/SearchResultUser.html b/docs/interfaces/SearchResultUser.html
diff --git a/docs/interfaces/SearchResultWiki.html b/docs/interfaces/SearchResultWiki.html
diff --git a/docs/interfaces/Spotlight.html b/docs/interfaces/Spotlight.html
diff --git a/docs/interfaces/SpotlightWithParticipantcount.html b/docs/interfaces/SpotlightWithParticipantcount.html
diff --git a/docs/interfaces/UpdateStream.html b/docs/interfaces/UpdateStream.html
diff --git a/docs/interfaces/User.html b/docs/interfaces/User.html
diff --git a/docs/interfaces/UserExtended.html b/docs/interfaces/UserExtended.html
diff --git a/docs/interfaces/UserExtendedWithStatisticsrulesets.html b/docs/interfaces/UserExtendedWithStatisticsrulesets.html
diff --git a/docs/interfaces/UserSilence.html b/docs/interfaces/UserSilence.html
diff --git a/docs/interfaces/UserStatistics.html b/docs/interfaces/UserStatistics.html
diff --git a/docs/interfaces/UserStatisticsWithCountryrank.html b/docs/interfaces/UserStatisticsWithCountryrank.html
diff --git a/docs/interfaces/UserStatisticsWithUser.html b/docs/interfaces/UserStatisticsWithUser.html
diff --git a/docs/interfaces/UserWithCountry.html b/docs/interfaces/UserWithCountry.html
diff --git a/docs/interfaces/UserWithCountryCover.html b/docs/interfaces/UserWithCountryCover.html
diff --git a/docs/interfaces/UserWithCountryCoverGroupsStatisticsSupport.html b/docs/interfaces/UserWithCountryCoverGroupsStatisticsSupport.html
diff --git a/docs/interfaces/UserWithCountryCoverGroupsStatisticsrulesets.html b/docs/interfaces/UserWithCountryCoverGroupsStatisticsrulesets.html
diff --git a/docs/interfaces/UserWithKudosu.html b/docs/interfaces/UserWithKudosu.html
diff --git a/docs/interfaces/WikiPage.html b/docs/interfaces/WikiPage.html
diff --git a/docs/modules.html b/docs/modules.html
@@ -23,6 +23,9 @@
 <a href="interfaces/ChangelogBuildWithChangelogentriesVersions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Changelog<wbr/>Build<wbr/>With<wbr/>Changelogentries<wbr/>Versions</span></a>
 <a href="interfaces/ChangelogBuildWithUpdatestreams.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Changelog<wbr/>Build<wbr/>With<wbr/>Updatestreams</span></a>
 <a href="interfaces/ChangelogBuildWithUpdatestreamsChangelogentries.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Changelog<wbr/>Build<wbr/>With<wbr/>Updatestreams<wbr/>Changelogentries</span></a>
+<a href="interfaces/ChatChannel.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Chat<wbr/>Channel</span></a>
+<a href="interfaces/ChatChannelWithDetails.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Chat<wbr/>Channel<wbr/>With<wbr/>Details</span></a>
+<a href="interfaces/ChatMessage.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Chat<wbr/>Message</span></a>
 <a href="interfaces/Event.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Event</span></a>
 <a href="interfaces/EventAchievement.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Event<wbr/>Achievement</span></a>
 <a href="interfaces/EventBeatmap.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Event<wbr/>Beatmap</span></a>
@@ -40,13 +43,18 @@
 <a href="interfaces/EventUserSupportFirst.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Event<wbr/>User<wbr/>Support<wbr/>First</span></a>
 <a href="interfaces/EventUserSupportGift.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Event<wbr/>User<wbr/>Support<wbr/>Gift</span></a>
 <a href="interfaces/EventUsernameChange.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Event<wbr/>Username<wbr/>Change</span></a>
+<a href="interfaces/ForumPost.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Forum<wbr/>Post</span></a>
+<a href="interfaces/ForumTopic.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Forum<wbr/>Topic</span></a>
 <a href="interfaces/KudosuHistory.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Kudosu<wbr/>History</span></a>
 <a href="interfaces/Leader.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Leader</span></a>
 <a href="interfaces/Match.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Match</span></a>
 <a href="interfaces/MatchInfo.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Match<wbr/>Info</span></a>
 <a href="interfaces/MultiplayerScore.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Multiplayer<wbr/>Score</span></a>
 <a href="interfaces/MultiplayerScores.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Multiplayer<wbr/>Scores</span></a>
+<a href="interfaces/NewsPost.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>News<wbr/>Post</span></a>
+<a href="interfaces/NewsPostWithContentNavigation.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>News<wbr/>Post<wbr/>With<wbr/>Content<wbr/>Navigation</span></a>
 <a href="interfaces/PlaylistItem.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Playlist<wbr/>Item</span></a>
+<a href="interfaces/PollConfig.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Poll<wbr/>Config</span></a>
 <a href="interfaces/Rankings.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Rankings</span></a>
 <a href="interfaces/RankingsCountry.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Rankings<wbr/>Country</span></a>
 <a href="interfaces/RankingsSpotlight.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Rankings<wbr/>Spotlight</span></a>
@@ -64,6 +72,7 @@
 <a href="interfaces/User.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>User</span></a>
 <a href="interfaces/UserExtended.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>User<wbr/>Extended</span></a>
 <a href="interfaces/UserExtendedWithStatisticsrulesets.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>User<wbr/>Extended<wbr/>With<wbr/>Statisticsrulesets</span></a>
+<a href="interfaces/UserSilence.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>User<wbr/>Silence</span></a>
 <a href="interfaces/UserStatistics.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>User<wbr/>Statistics</span></a>
 <a href="interfaces/UserStatisticsWithCountryrank.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>User<wbr/>Statistics<wbr/>With<wbr/>Countryrank</span></a>
 <a href="interfaces/UserStatisticsWithUser.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>User<wbr/>Statistics<wbr/>With<wbr/>User</span></a>

diff --git a/docs/types/Mod.html b/docs/types/Mod.html
diff --git a/docs/types/ProfileBanner.html b/docs/types/ProfileBanner.html
diff --git a/docs/types/Scope.html b/docs/types/Scope.html
diff --git a/lib/chat.ts b/lib/chat.ts
@@ -1,42 +1,64 @@
-import { CurrentUserAttributes, User } from "./user.js";
-
-export type ChannelType =
-"PUBLIC" |
-"PRIVATE" |
-"MULTIPLAYER" |
-"SPECTATOR" |
-"TEMPORARY" |
-"PRIVATE" |
-"PM" |
-"GROUP" |
-"ANNOUNCE";
+import { User } from "./user.js";
 
+/**
+ * Expected from api.keepChatAlive()
+ */
 export interface UserSilence {
 	id: number
 	user_id: number
 }
 
+/**
+ * Expected from api.sendChatPrivateMessage(), api.createChatPrivateChannel()
+ */
 export interface ChatChannel {
 	channel_id: number
 	name: string
 	description: string | null
 	icon: string | null
-	type: ChannelType
+	type: "PUBLIC" | "PRIVATE" | "MULTIPLAYER" | "SPECTATOR" | "TEMPORARY" | "PRIVATE" | "PM" | "GROUP" | "ANNOUNCE"
 	moderated: boolean
 	uuid: string | null
-	current_user_attributes?: CurrentUserAttributes | null
-	last_message_id?: number | null
-	users?: number[] | null
 }
 
+/**
+ * Expected from api.joinChatChannel(), api.getChatChannel()
+ */
+export interface ChatChannelWithDetails extends ChatChannel {
+	current_user_attributes: {
+		can_message: boolean
+		/**
+		 * The reason why messages can't be sent in this channel
+		 * @remarks Is null if messages can be sent
+		 */
+		can_message_error: string | null
+		/**
+		 * @remarks Is null if no message has been read (I think)
+		 */
+		last_read_id: number | null
+	}
+	last_message_id: number
+	/**
+	 * The ids of the users that are in the channel
+	 * @remarks Is empty for public channels
+	 */
+	users: number[]
+}
+
+/**
+ * Expected from api.sendChatPrivateMessage(), api.getChatMessages(), api.sendChatMessage()
+ */
 export interface ChatMessage {
 	channel_id: number
 	content: string
 	is_action: boolean
 	message_id: number
 	sender_id: number
 	timestamp: Date
+	/**
+	 * Like "action", "markdown", "plain"
+	 */
 	type: string
-	uuid: string | null
-	sender?: User
+	uuid?: string | null
+	sender: User
 }
diff --git a/lib/index.ts b/lib/index.ts
@@ -23,6 +23,7 @@ import { WikiPage } from "./wiki.js"
 import { NewsPost, NewsPostWithContentNavigation } from "./news.js"
 import { SearchResultUser, SearchResultWiki } from "./home.js"
 import { Rulesets, Mod, Scope } from "./misc.js"
+import { ChatChannel, ChatChannelWithDetails, ChatMessage, UserSilence } from "./chat.js"
 
 
 export { User, UserWithKudosu, UserWithCountry, UserWithCountryCover, UserWithCountryCoverGroupsStatisticsrulesets, UserWithCountryCoverGroupsStatisticsSupport,
@@ -47,6 +48,7 @@ export { WikiPage } from "./wiki.js"
 export { NewsPost, NewsPostWithContentNavigation } from "./news.js"
 export { SearchResultUser, SearchResultWiki } from "./home.js"
 export { Rulesets, Mod, Scope } from "./misc.js"
+export { ChatChannel, ChatChannelWithDetails, ChatMessage, UserSilence } from "./chat.js"
 
 /**
  * Some stuff doesn't have the right type to begin with, such as dates, which are being returned as strings, this fixes that
@@ -362,14 +364,15 @@ export class API {
 				this.log(true, "Will request again in a few instants...", `(Try #${number_try})`)
 				const to_wait = (Math.floor(Math.random() * (500 - 100 + 1)) + 100) * 10
 				await new Promise(res => setTimeout(res, to_wait))
-				return correctType(await this.request(method, endpoint, parameters, number_try + 1))
+				return await this.request(method, endpoint, parameters, number_try + 1)
 			}
 
 			throw new APIError(err, `${this.server}/api/v2`, endpoint, parameters)
 		}
 
 		this.log(false, response.statusText, response.status, {endpoint, parameters})
-		return correctType(await response.json())
+		// 204 means the request worked as intended and did not give us anything, so we can't `.json()` the response
+		return response.status !== 204 ? correctType(await response.json()) : undefined
 	}
 
 
@@ -894,4 +897,133 @@ export class API {
 	async editForumPost(post: {id: number} | ForumPost, new_text: string): Promise<ForumPost> {
 		return await this.request("put", `forums/posts/${post.id}`, {body: new_text})
 	}
+
+
+	// CHAT STUFF
+
+	/**
+	 * Needs to be done periodically to reset chat activity timeout
+	 * @remarks Every 30 seconds is a good idea
+	 * @param since UserSilences that are before that will not be returned!
+	 * @returns A list of recent silences
+	 * @scope chat.read
+	 */
+	async keepChatAlive(since?: {user_silence?: {id: number} | UserSilence, message?: {message_id: number} | ChatMessage}): Promise<UserSilence[]> {
+		return await this.request("post", "chat/ack", {history_since: since?.user_silence?.id, since: since?.message?.message_id})
+	}
+
+	/**
+	 * Send a private message to someone!
+	 * @remarks You don't need to use `createChatPrivateChannel` before sending a message
+	 * @param user_target The User you wanna send your message to!
+	 * @param message The message you wanna send
+	 * @param is_action (defaults to false) Is it a command? Like `/me dances`
+	 * @param uuid A client-side message identifier
+	 * @returns The message you sent
+	 * @scope chat.write
+	 */
+	async sendChatPrivateMessage(user_target: {id: number} | User, message: string, is_action: boolean = false, uuid?: string):
+	Promise<{channel: ChatChannel, message: ChatMessage}> {
+		return await this.request("post", "chat/new", {target_id: user_target.id, message, is_action, uuid})
+	}
+
+	/**
+	 * Get the recent messages of a specific ChatChannel!
+	 * @param channel The Channel you wanna get the messages from
+	 * @param limit (defaults to 20, max 50) The maximum amount of messages you want to get!
+	 * @param since Get the messages sent after this message
+	 * @param until Get the messages sent up to but not including this message
+	 * @scope chat.read
+	 */
+	async getChatMessages(channel: {channel_id: number} | ChatChannel, limit: number = 20,
+	since?: {message_id: number} | ChatMessage, until?: {message_id: number} | ChatMessage): Promise<ChatMessage[]> {
+		return await this.request("get", `chat/channels/${channel.channel_id}/messages`, {limit, since: since?.message_id, until: until?.message_id})
+	}
+
+	/**
+	 * Send a message in a ChatChannel!
+	 * @param channel The channel in which you want to send your message
+	 * @param message The message you wanna send
+	 * @param is_action (defaults to false) Is it a command? Like `/me dances`
+	 * @returns The newly sent ChatMessage!
+	 * @scope chat.write
+	 */
+	async sendChatMessage(channel: {channel_id: number} | ChatChannel, message: string, is_action: boolean = false): Promise<ChatMessage> {
+		return await this.request("post", `chat/channels/${channel.channel_id}/messages`, {message, is_action})
+	}
+
+	/**
+	 * Join a public or multiplayer ChatChannel, allowing you to interact with it!
+	 * @param channel The channel you wanna join
+	 * @param user (defaults to the presumed authorized user) The user joining the channel
+	 * @scope chat.write_manage
+	 */
+	async joinChatChannel(channel: {channel_id: number} | ChatChannel, user?: {id: number} | User): Promise<ChatChannelWithDetails> {
+		return await this.request("put", `chat/channels/${channel.channel_id}/users/${user?.id || this.user}`)
+	}
+
+	/**
+	 * Leave/Close a public ChatChannel!
+	 * @param channel The channel you wanna join
+	 * @param user (defaults to the presumed authorized user) The user joining the channel
+	 * @scope chat.write_manage
+	 */
+	async leaveChatChannel(channel: {channel_id: number} | ChatChannel, user?: {id: number} | User): Promise<void> {
+		return await this.request("delete", `chat/channels/${channel.channel_id}/users/${user?.id || this.user}`)
+	}
+
+	/**
+	 * Mark a certain channel as read up to a given message!
+	 * @param channel The channel in question
+	 * @param message You're marking this and all the messages before it as read!
+	 * @scope chat.read
+	 */
+	async markChatChannelAsRead(channel: {channel_id: number} | ChatChannel, message: {message_id: number} | ChatMessage): Promise<void> {
+		return await this.request("put",
+		`chat/channels/${channel.channel_id}/mark-as-read/${message.message_id}`, {channel_id: channel.channel_id, message: message.message_id})
+	}
+
+	/**
+	 * Get a list of all publicly joinable channels!
+	 * @scope chat.read
+	 */
+	async getChatChannels(): Promise<ChatChannel[]> {
+		return await this.request("get", "chat/channels")
+	}
+
+	/**
+	 * Create/Open/Join a private messages chat channel!
+	 * @param user_target The other user able to read and send messages in this channel
+	 * @returns The newly created channel!
+	 * @scope chat.write_manage
+	 */
+	async createChatPrivateChannel(user_target: {id: number} | User): Promise<ChatChannel> {
+		return await this.request("post", "chat/channels", {type: "PM", target_id: user_target.id})
+	}
+
+	/**
+	 * Create a new announcement!
+	 * @remarks From my understanding, this WILL 403 unless the user is kinda special
+	 * @param channel Details of the channel you're creating
+	 * @param user_targets The people that will receive your message
+	 * @param message The message to send with the announcement
+	 * @returns The newly created channel!
+	 * @scope chat.write_manage
+	 */
+	async createChatAnnouncementChannel(channel: {name: string, description: string}, user_targets: Array<{id: number} | User>, message: string):
+	Promise<ChatChannel> {
+		const target_ids = user_targets.map((u) => u.id)
+		return await this.request("post", "chat/channels", {type: "ANNOUNCE", channel, target_ids, message})
+	}
+
+	/**
+	 * Get a ChatChannel, and the users in it if it is a private channel!
+	 * @remarks Will 404 if the user has not joined the channel (use `joinChatChannel` for that)
+	 * @param channel The channel in question
+	 * @scope chat.read
+	 */
+	async getChatChannel(channel: {channel_id: number} | ChatChannel): Promise<ChatChannelWithDetails> {
+		const response = await this.request("get", `chat/channels/${channel.channel_id}`)
+		return response.channel
+	}
 }