remove Discord* types for guilds

This commit is contained in:
ITOH
2021-04-30 19:34:16 +02:00
parent aa27e92234
commit fe81cc1ea3
33 changed files with 36 additions and 145 deletions

View File

@@ -1,12 +1,9 @@
import { User } from "../users/user.ts";
import { SnakeCasedPropertiesDeep } from "../util.ts";
/** https://discord.com/developers/docs/resources/guild#ban-object */
export interface Ban {
/** The reason for the ban */
reason: string | null;
/** The banned user */
user: User;
}
/** https://discord.com/developers/docs/resources/guild#ban-object */
export type DiscordBan = SnakeCasedPropertiesDeep<Ban>;

View File

@@ -1,5 +1,4 @@
import { SnakeCasedPropertiesDeep } from "../util.ts";
/** https://discord.com/developers/docs/resources/guild#begin-guild-prune */
export interface BeginGuildPrune {
/** Number of days to prune (1 or more), default: 7 */
days?: number;
@@ -8,6 +7,3 @@ export interface BeginGuildPrune {
/** Role(s) ro include, default: none */
includeRoles?: string[];
}
/** https://discord.com/developers/docs/resources/guild#begin-guild-prune */
export type DiscordBeginGuildPrune = SnakeCasedPropertiesDeep<BeginGuildPrune>;

View File

@@ -1,11 +1,11 @@
import { Channel } from "../channels/channel.ts";
import { Role } from "../permissions/role.ts";
import { SnakeCasedPropertiesDeep } from "../util.ts";
import { DiscordDefaultMessageNotificationLevels } from "./default_message_notification_levels.ts";
import { DiscordExplicitContentFilterLevels } from "./explicit_content_filter_levels.ts";
import { DiscordSystemChannelFlags } from "./system_channel_flags.ts";
import { DiscordVerificationLevels } from "./verification_levels.ts";
/** https://discord.com/developers/docs/resources/guild#create-guild */
export interface CreateGuild {
/** Name of the guild (2-100 characters) */
name: string;
@@ -32,6 +32,3 @@ export interface CreateGuild {
/** System channel flags */
systemChannelFlags?: DiscordSystemChannelFlags;
}
/** https://discord.com/developers/docs/resources/guild#create-guild */
export type DiscordCreateGuild = SnakeCasedPropertiesDeep<CreateGuild>;

View File

@@ -1,11 +1,7 @@
import { SnakeCasedPropertiesDeep } from "../util.ts";
/** https://discord.com/developers/docs/resources/guild#create-guild-ban */
export interface CreateGuildBan {
/** Number of days to delete messages for (0-7) */
deleteMessageDays?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
/** Reason for the ban */
reason?: string;
}
/** https://discord.com/developers/docs/resources/guild#create-guild-ban */
export type DiscordCreateGuildBan = SnakeCasedPropertiesDeep<CreateGuildBan>;

View File

@@ -32,3 +32,4 @@ export interface DiscordCreateGuildChannel extends
> {
permission_overwrites: DiscordOverwrite[];
}
// TODO: check this

View File

@@ -18,3 +18,4 @@ export interface DiscordCreateGuildRole
extends Omit<CreateGuildRole, "permissions"> {
permissions?: string;
}
// TODO: check this

View File

@@ -1,9 +1,5 @@
import { SnakeCasedPropertiesDeep } from "../util.ts";
/** https://discord.com/developers/docs/resources/guild#get-guild */
export interface GetGuildQuery {
/** When true, will return approximate member and presence counts for the guild */
withCounts?: boolean;
}
/** https://discord.com/developers/docs/resources/guild#get-guild */
export type DiscordGetGuildQuery = SnakeCasedPropertiesDeep<GetGuildQuery>;

View File

@@ -1,13 +1,7 @@
import { SnakeCasedPropertiesDeep } from "../util.ts";
/** https://discord.com/developers/docs/resources/guild#get-guild-prune-count */
export interface GetGuildPruneCountQuery {
/** Number of days to count prune for (1 or more), default: 7 */
days?: number;
/** Role(s) to include, default: none */
includeRoles: string | string[];
}
/** https://discord.com/developers/docs/resources/guild#get-guild-prune-count */
export type DiscordGetGuildPruneCountQuery = SnakeCasedPropertiesDeep<
GetGuildPruneCountQuery
>;

View File

@@ -1,9 +1,7 @@
import { DiscordGetGuildWidgetImageStyleOptions } from "./get_guild_widget_image_style_options.ts";
/** https://discord.com/developers/docs/resources/guild#get-guild-widget-image-query-string-params */
export interface GetGuildWidgetImageQuery {
/** Style of the widget returned, default: shield */
style?: DiscordGetGuildWidgetImageStyleOptions;
}
/** https://discord.com/developers/docs/resources/guild#get-guild-widget-image-query-string-params */
export type DiscordGetGuildWidgetImage = GetGuildWidgetImageQuery;

View File

@@ -2,7 +2,6 @@ import { Channel } from "../channels/channel.ts";
import { Emoji } from "../emojis/emoji.ts";
import { PresenceUpdate } from "../misc/presence_update.ts";
import { Role } from "../permissions/role.ts";
import { SnakeCasedPropertiesDeep } from "../util.ts";
import { VoiceState } from "../voice/voice_state.ts";
import { DiscordDefaultMessageNotificationLevels } from "./default_message_notification_levels.ts";
import { DiscordExplicitContentFilterLevels } from "./explicit_content_filter_levels.ts";
@@ -14,6 +13,7 @@ import { DiscordSystemChannelFlags } from "./system_channel_flags.ts";
import { DiscordVerificationLevels } from "./verification_levels.ts";
import { WelcomeScreen } from "./welcome_screen.ts";
/** https://discord.com/developers/docs/resources/guild#guild-object */
export interface Guild {
/** Guild id */
id: string;
@@ -108,6 +108,3 @@ export interface Guild {
/** The welcome screen of a Community guild, shown to new members, returned when in the invite object */
welcomeScreen?: WelcomeScreen;
}
/** https://discord.com/developers/docs/resources/guild#guild-object */
export type DiscordGuild = SnakeCasedPropertiesDeep<Guild>;

View File

@@ -1,14 +1,9 @@
import { User } from "../users/user.ts";
import { SnakeCasedPropertiesDeep } from "../util.ts";
/** https://discord.com/developers/docs/topics/gateway#guild-ban-add */
export interface GuildBanAddRemove {
/** id of the guild */
guildId: string;
/** The banned user */
user: User;
}
/** https://discord.com/developers/docs/topics/gateway#guild-ban-add */
export type DiscordGuildBanAddRemove = SnakeCasedPropertiesDeep<
GuildBanAddRemove
>;

View File

@@ -1,12 +1,9 @@
import { User } from "../users/user.ts";
import { SnakeCasedPropertiesDeep } from "../util.ts";
/** https://discord.com/developers/docs/topics/gateway#guild-ban-remove */
export interface GuildBanRemove {
/** id of the guild */
guildId: string;
/** The unbanned user */
user: User;
}
/** https://discord.com/developers/docs/topics/gateway#guild-ban-remove */
export type DiscordGuildBanRemove = SnakeCasedPropertiesDeep<GuildBanRemove>;

View File

@@ -17,7 +17,8 @@ export enum DiscordGuildFeatures {
/** Guild has access to create news channels */
NEWS = "NEWS",
/** Guild is able to be discovered in the directory */
DISCOVERABLE = "DISCOVERABLE", /** guild cannot be discoverable */
DISCOVERABLE = "DISCOVERABLE",
/** guild cannot be discoverable */
DISCOVERABLE_DISABLED = "DISCOVERABLE_DISABLED",
/** Guild is able to be featured in the directory */
FEATURABLE = "FEATURABLE",

View File

@@ -1,6 +1,6 @@
import { User } from "../users/user.ts";
import { SnakeCasedPropertiesDeep } from "../util.ts";
/** https://discord.com/developers/docs/resources/guild#guild-member-object */
export interface GuildMember {
/** The user this guild member represents */
user?: User;
@@ -20,13 +20,7 @@ export interface GuildMember {
pending?: boolean;
}
/** https://discord.com/developers/docs/resources/guild#guild-member-object */
export type DiscordGuildMember = SnakeCasedPropertiesDeep<GuildMember>;
// We use these types much since user always exists unless its a `CREATE_MESSAGE` or `MESSAGE_UPDATE` event
export type GuildMemberWithUser = Omit<GuildMember, "user"> & { user: User };
/** https://discord.com/developers/docs/resources/guild#guild-member-object */
export type DiscordGuildMemberWithUser = SnakeCasedPropertiesDeep<
GuildMemberWithUser
>;
export type GuildMemberWithUser = Omit<GuildMember, "user"> & { user: User };

View File

@@ -1,7 +1,7 @@
import { Emoji } from "../emojis/emoji.ts";
import { SnakeCasedPropertiesDeep } from "../util.ts";
import { DiscordGuildFeatures } from "./guild_features.ts";
/** https://discord.com/developers/docs/resources/guild#guild-preview-object */
export interface GuildPreview {
/** Guild id */
id: string;
@@ -24,6 +24,3 @@ export interface GuildPreview {
/** The description for the guild, if the guild is discoverable */
description: string | null;
}
/** https://discord.com/developers/docs/resources/guild#guild-preview-object */
export type DiscordGuildPreview = SnakeCasedPropertiesDeep<GuildPreview>;

View File

@@ -1,12 +1,9 @@
import { Role } from "../permissions/role.ts";
import { SnakeCasedPropertiesDeep } from "../util.ts";
/** https://discord.com/developers/docs/topics/gateway#guild-role-create */
export interface GuildRoleCreate {
/** The id of the guild */
guildId: string;
/** The role created */
role: Role;
}
/** https://discord.com/developers/docs/topics/gateway#guild-role-create */
export type DiscordGuildRoleCreate = SnakeCasedPropertiesDeep<GuildRoleCreate>;

View File

@@ -1,11 +1,7 @@
import { SnakeCasedPropertiesDeep } from "../util.ts";
/** https://discord.com/developers/docs/topics/gateway#guild-role-delete */
export interface GuildRoleDelete {
/** id of the guild */
guildId: string;
/** id of the role */
roleId: string;
}
/** https://discord.com/developers/docs/topics/gateway#guild-role-delete */
export type DiscordGuildRoleDelete = SnakeCasedPropertiesDeep<GuildRoleDelete>;

View File

@@ -1,12 +1,9 @@
import { Role } from "../permissions/role.ts";
import { SnakeCasedPropertiesDeep } from "../util.ts";
/** https://discord.com/developers/docs/topics/gateway#guild-role-update */
export interface GuildRoleUpdate {
/** The id of the guild */
guildId: string;
/** The role updated */
role: Role;
}
/** https://discord.com/developers/docs/topics/gateway#guild-role-update */
export type DiscordGuildRoleUpdate = SnakeCasedPropertiesDeep<GuildRoleUpdate>;

View File

@@ -1,11 +1,7 @@
import { SnakeCasedPropertiesDeep } from "../util.ts";
/** https://discord.com/developers/docs/resources/guild#guild-widget-object-guild-widget-structure */
export interface GuildWidget {
/** Whether the widget is enabled */
enabled: boolean;
/** The widget channel id */
channelId: string | null;
}
/** https://discord.com/developers/docs/resources/guild#guild-widget-object-guild-widget-structure */
export type DiscordGuildWidget = SnakeCasedPropertiesDeep<GuildWidget>;

View File

@@ -1,9 +1,7 @@
/** https://discord.com/developers/docs/resources/guild#list-guild-members */
export interface ListGuildMembers {
/** Max number of members to return (1-1000). Default: 1 */
limit?: number;
/** The highest user id in the previous page. Default: 0 */
after?: string;
}
/** https://discord.com/developers/docs/resources/guild#list-guild-members */
export type DiscordListGuildMembers = ListGuildMembers;

View File

@@ -1,7 +1,5 @@
/** https://discord.com/developers/docs/resources/guild#modify-current-user-nick */
export interface ModifyCurrentUserNick {
/** Value to set users nickname to. Requires the CHANGENICKNAME permission */
nick?: string | null;
}
/** https://discord.com/developers/docs/resources/guild#modify-current-user-nick */
export type DiscordModifyCurrentUserNick = ModifyCurrentUserNick;

View File

@@ -1,10 +1,10 @@
import { SnakeCasedPropertiesDeep } from "../util.ts";
import { DiscordDefaultMessageNotificationLevels } from "./default_message_notification_levels.ts";
import { DiscordExplicitContentFilterLevels } from "./explicit_content_filter_levels.ts";
import { DiscordGuildFeatures } from "./guild_features.ts";
import { DiscordSystemChannelFlags } from "./system_channel_flags.ts";
import { DiscordVerificationLevels } from "./verification_levels.ts";
/** https://discord.com/developers/docs/resources/guild#modify-guild */
export interface ModifyGuild {
/** Guild name */
name?: string;
@@ -43,6 +43,3 @@ export interface ModifyGuild {
/** Enabled guild features */
features?: DiscordGuildFeatures[];
}
/** https://discord.com/developers/docs/resources/guild#modify-guild */
export type DiscordModifyGuild = SnakeCasedPropertiesDeep<ModifyGuild>;

View File

@@ -1,4 +1,5 @@
// TODO: most likely it is but check if lockPositions and parentId really are optional
/** https://discord.com/developers/docs/resources/guild#modify-guild-channel-positions */
export interface ModifyGuildChannelPositions {
/** Channel id */
id: string;
@@ -9,6 +10,3 @@ export interface ModifyGuildChannelPositions {
/** The new parent ID for the channel that is moved */
parentId?: string | null;
}
/** https://discord.com/developers/docs/resources/guild#modify-guild-channel-positions */
export type DiscordModifyGuildChannelPositions = ModifyGuildChannelPositions;

View File

@@ -1,5 +1,4 @@
import { SnakeCasedPropertiesDeep } from "../util.ts";
/** https://discord.com/developers/docs/resources/guild#modify-guild-member */
export interface ModifyGuildMember {
/** Value to set users nickname to. Requires the `MANAGE_NICKNAMES` permission */
nick?: string | null;
@@ -12,8 +11,3 @@ export interface ModifyGuildMember {
/** Id of channel to move user to (if they are connected to voice). Requires the `MOVE_MEMBERS` permission */
channelId: string | null;
}
/** https://discord.com/developers/docs/resources/guild#modify-guild-member */
export type DiscordModifyGuildMember = SnakeCasedPropertiesDeep<
ModifyGuildMember
>;

View File

@@ -18,3 +18,5 @@ export interface DiscordModifyGuildRole
extends Omit<ModifyGuildRole, "permissions"> {
permissions?: string | null;
}
// TODO: check this

View File

@@ -1,9 +1,7 @@
/** https://discord.com/developers/docs/resources/guild#modify-guild-role-positions */
export interface ModifyGuildRolePositions {
/** Role id */
id: string;
/** Sorting position of the role */
position?: number | null;
}
/** https://discord.com/developers/docs/resources/guild#modify-guild-role-positions */
export type DiscordModifyGuildRolePositions = ModifyGuildRolePositions;

View File

@@ -1,6 +1,6 @@
import { SnakeCasedPropertiesDeep } from "../util.ts";
import { WelcomeScreenChannel } from "./welcome_screen_channel.ts";
/** https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen */
export interface ModifyGuildWelcomeScreen {
/** Whether the welcome screen is enabled */
enabled?: boolean | null;
@@ -9,8 +9,3 @@ export interface ModifyGuildWelcomeScreen {
/** The server description to show in the welcome screen */
description?: string | null;
}
/** https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen */
export type DiscordModifyGuildWelcomeScreen = SnakeCasedPropertiesDeep<
ModifyGuildWelcomeScreen
>;

View File

@@ -1,5 +1,4 @@
import { SnakeCasedPropertiesDeep } from "../util.ts";
/** https://discord.com/developers/docs/topics/gateway#request-guild-members */
export interface RequestGuildMembers {
/** id of the guild to get members for */
guildId: string;
@@ -14,8 +13,3 @@ export interface RequestGuildMembers {
/** Nonce to identify the Guild Members Chunk response */
nonce?: string;
}
/** https://discord.com/developers/docs/topics/gateway#request-guild-members */
export type DiscordRequestGuildMembers = SnakeCasedPropertiesDeep<
RequestGuildMembers
>;

View File

@@ -1,9 +1,4 @@
import { SnakeCasedPropertiesDeep } from "../util.ts";
import { Guild } from "./guild.ts";
export type UnavailableGuild = Pick<Guild, "id" | "unavailable">;
/** https://discord.com/developers/docs/resources/guild#unavailable-guild-object */
export type DiscordUnavailableGuild = SnakeCasedPropertiesDeep<
UnavailableGuild
>;
export type UnavailableGuild = Pick<Guild, "id" | "unavailable">;

View File

@@ -1,13 +1,7 @@
import { SnakeCasedProperties } from "../util.ts";
/** https://discord.com/developers/docs/resources/guild#update-user-voice-state */
export interface UpdateOthersVoiceState {
/** The id of the channel the user is currently in */
channelId: string;
/** Toggles the user's suppress state */
suppress?: boolean;
}
/** https://discord.com/developers/docs/resources/guild#update-user-voice-state */
export type DiscordUpdateOthersVoiceState = SnakeCasedProperties<
UpdateOthersVoiceState
>;

View File

@@ -1,5 +1,4 @@
import { SnakeCasedProperties } from "../util.ts";
/** https://discord.com/developers/docs/resources/guild#update-current-user-voice-state */
export interface UpdateSelfVoiceState {
/** The id of the channel the user is currently in */
channelId: string;
@@ -8,8 +7,3 @@ export interface UpdateSelfVoiceState {
/** Sets the user's request to speak */
requestToSpeakTimestamp?: string | null;
}
/** https://discord.com/developers/docs/resources/guild#update-current-user-voice-state */
export type DiscordUpdateSelfVoiceState = SnakeCasedProperties<
UpdateSelfVoiceState
>;

View File

@@ -1,12 +1,9 @@
import { SnakeCasedPropertiesDeep } from "../util.ts";
import { WelcomeScreenChannel } from "./welcome_screen_channel.ts";
/** https://discord.com/developers/docs/resources/guild#welcome-screen-object-welcome-screen-structure */
export interface WelcomeScreen {
/** The server description shown in the welcome screen */
description: string | null;
/** The channels shown in the welcome screen, up to 5 */
welcomeChannels: WelcomeScreenChannel[];
}
/** https://discord.com/developers/docs/resources/guild#welcome-screen-object-welcome-screen-structure */
export type DiscordWelcomeScreen = SnakeCasedPropertiesDeep<WelcomeScreen>;

View File

@@ -1,5 +1,4 @@
import { SnakeCasedPropertiesDeep } from "../util.ts";
/** https://discord.com/developers/docs/resources/guild#welcome-screen-object-welcome-screen-channel-structure */
export interface WelcomeScreenChannel {
/** The channel's id */
channelId: string;
@@ -10,8 +9,3 @@ export interface WelcomeScreenChannel {
/** The emoji name if custom, the unicode character if standard, or `null` if no emoji is set */
emojiName: string | null;
}
/** https://discord.com/developers/docs/resources/guild#welcome-screen-object-welcome-screen-channel-structure */
export type DiscordWelcomeScreenChannel = SnakeCasedPropertiesDeep<
WelcomeScreenChannel
>;