discordeno/structures/guild.ts

import Client from '../module/client'
import { endpoints } from '../constants/discord'
import { formatImageURL } from '../utils/cdn'
import { create_role } from './role'
import { create_emoji } from './emoji'
import { createVoiceState } from './voiceState'
import { createMember } from './member'
import { create_channel } from './channel'
import { createPresence } from './presence'

interface CreateGuildPayload {
  /** The guild id */
  id: string
  /** The guild name 2-100 characters */
  name: string
  /** The guild icon image hash */
  icon: string | null
  /** The guild splash image hash */
  splash: string | null
  /** The id of the owner */
  owner_id: string
  /** The voice region id for the guild */
  region: string
  /** The afk channel id */
  afk_channel_id: string | null
  /** AFK Timeout in seconds. */
  afk_timeout: number
  /** Whether this guild is embeddable (widget) */
  embed_enabled?: boolean
  /** If not null, the channel id that the widge will generate an invite to. */
  embed_channel_id?: string | null
  /** The verification level required for the guild */
  verification_level: number
  /** The roles in the guild */
  roles: Role[]
  /** The custom guild emojis */
  emojis: Emoji[]
  /** Enabled guild features */
  features: GuildFeatures[]
  /** Required MFA level for the guild */
  mfa_level: number
  /** The id of the channel to which system mesages are sent */
  system_channel_id: string | null
  /** When this guild was joined at */
  joined_at: string
  /** Whether this is considered a large guild */
  large: boolean
  /** Whether this guild is unavailable */
  unavailable: boolean
  /** Total number of members in this guild */
  member_count: number
  voice_states: VoiceState[]
  /** Users in the guild */
  members: Member[]
  /** Channels in the guild */
  channels: Channel[]
  presences: Presence[]
  /** The maximum amount of presences for the guild(the default value, currently 5000 is in effect when null is returned.) */
  max_presences?: number | null
  /** The maximum amount of members for the guild */
  max_members?: number
  /** The vanity url code for the guild */
  vanity_url_code: string | null
  /** The description for the guild */
  description: string | null
  /** The banner hash */
  banner: string | null
  /** The premium tier */
  premium_tier: number
  /** The total number of users currently boosting this server. */
  premium_subscription_count: number
  /** The preferred local of this guild only set if guild has the DISCOVERABLE feature, defaults to en-US */
  preferred_locale: string
}

interface Guild {
  /** The guild id */
  id: string
  /** The guild name 2-100 characters */
  name: string
  /** The guild icon image hash */
  icon: string | null
  /** The guild splash image hash */
  splash: string | null
  /** The id of the owner */
  owner_id: string
  /** The voice region id for the guild */
  region: string
  /** The afk channel id */
  afk_channel_id: string | null
  /** AFK Timeout in seconds. */
  afk_timeout: number
  /** The verification level required for the guild */
  verification_level: number
  /** The roles in the guild */
  roles: Map<string, Role>
  /** The custom guild emojis */
  emojis: Map<string, Emoji>
  /** Enabled guild features */
  features: GuildFeatures[]
  /** Required MFA level for the guild */
  mfa_level: number
  /** The id of the channel to which system mesages are sent */
  system_channel_id: string | null
  /** When this guild was joined at */
  joined_at: number
  /** Whether this is considered a large guild */
  large: boolean
  /** Whether this guild is unavailable */
  unavailable: boolean
  /** Total number of members in this guild */
  member_count: number
  voice_states: Map<string, Voice_State>
  /** Users in the guild */
  members: Map<string, Member>
  /** Channels in the guild */
  channels: Channel[]
  presences: Presence[]
  /** The maximum amount of presences for the guild(the default value, currently 5000 is in effect when null is returned.) */
  max_presences?: number | null
  /** The maximum amount of members for the guild */
  max_members?: number
  /** The vanity url code for the guild */
  vanity_url_code: string | null
  /** The description for the guild */
  description: string | null
  /** The banner hash */
  banner: string | null
  /** The premium tier */
  premium_tier: number
  /** The total number of users currently boosting this server. */
  premium_subscription_count: number
  /** The preferred local of this guild only set if guild has the DISCOVERABLE feature, defaults to en-US */
  preferred_locale: string
  /** The full URL of the icon from Discords CDN. Undefined when no icon is set. */
  icon_url(size?: Image_Size, format?: Image_Formats): string | undefined
  /** The full URL of the splash from Discords CDN. Undefined if no splash is set. */
  splash_url(size?: Image_Size, format?: Image_Formats): string | undefined
  /** The full URL of the banner from Discords CDN. Undefined if no banner is set. */
  banner_url(size?: Image_Size, format?: Image_Formats): string | undefined
  /** Create a channel in your server. Bot needs MANAGE_CHANNEL permissions in the server. */
  create_channel(name: string, options: ChannelCreate_Options): Promise<Channel>
  /** Create an emoji in the server. Emojis and animated emojis have a maximum file size of 256kb. Attempting to upload an emoji larger than this limit will fail and return 400 Bad Request and an error message, but not a JSON status code. */
  create_emoji(name: string, image: string, options: Create_Emojis_Options): Promise<Emoji>
  /** Modify the given emoji. Requires the MANAGE_EMOJIS permission. */
  edit_emoji(id: string, options: Edit_Emojis_Options): Promise<Emoji>
  /** Delete the given emoji. Requires the MANAGE_EMOJIS permission. Returns 204 No Content on success. */
  delete_emoji(id: string, reason?: string): Promise<void>
  /** Create a new role for the guild. Requires the MANAGE_ROLES permission. */
  create_role(options: Create_Role_Options): Promise<Role>
  /** Edi a guild role. Requires the MANAGE_ROLES permission. */
  edit_role(id: string, options: Create_Role_Options): Promise<Role>
  /** Delete a guild role. Requires the MANAGE_ROLES permission. */
  delete_role(id: string): Promise<void>
  /** Check how many members would be removed from the server in a prune operation. Requires the KICK_MEMBERS permission */
  get_prune_count(days: number): Promise<number>
  /** Begin pruning all members in the given time period */
  prune_members(days: number): Promise<void>
  /** Returns the audit logs for the guild. Requires VIEW AUDIT LOGS permission */
  get_audit_logs(options: Get_audit_logsOptions): Promise<AuditLog>
  /** Returns the guild embed object. Requires the MANAGE_GUILD permission. */
  get_embed(): Promise<Guild_Embed>
  /** Modify a guild embed object for the guild. Requires the MANAGE_GUILD permission. */
  edit_embed(enabled: boolean, channel_id?: string | null): Promise<Guild_Embed>
  /** Returns the code and uses of the vanity url for this server if it is enabled. Requires the MANAGE_GUILD permission. */
  get_vanity_url(): Promise<Vanity_Invite>
  /** Returns a list of integrations for the guild. Requires the MANAGE_GUILD permission. */
  get_integrations(): Promise<Guild_Integration[]>

  leave_voice_channel(): Promise<void>
}

export interface Guild_Integration {
  /** The integrations unique id */
  id: string
  /** the integrations name */
  name: string
  /** The integration type like twitch, youtube etc */
  type: string
  /** Is this integration enabled */
  enabled: boolean
  /** is this integration syncing */
  syncing: boolean
  /** id that this integration uses for "subscribers" */
  role_id: string
  /** The behavior of expiring subscribers */
  expire_behavior: number
  /** The grace period before expiring subscribers */
  expire_grace_period: number
  /** The user for this integration */
  user: User_Data
  /** The integration account information */
  account: Account
  /** When this integration was last synced */
  synced_at: string
}

export interface User_Data {
  /** The user's id */
  id: string
  /** the user's username, not unique across the platform */
  username: string
  /** The user's 4 digit discord tag */
  discriminator: string
  /** The user's avatar hash */
  avatar: string | null
  /** Whether the user is a bot */
  bot?: boolean
  /** Whether the user is an official discord system user (part of the urgent message system.) */
  system?: boolean
  /** Whether the user has two factor enabled on their account */
  mfa_enabled?: boolean
  /** the user's chosen language option */
  locale?: string
  /** Whether the email on this account has been verified */
  verified?: boolean
  /** The user's email */
  email?: string
  /** The flags on a user's account. */
  flags?: number
  /** The type of Nitro subscription on a user's account. */
  premium_type?: number
}

export enum User_Flags {
  NONE,
  DISCORD_EMPLOYEE,
  DISCORD_PARTNER,
  HYPE_SQUAD_EVENTS = 1 << 2,
  BUG_HUNTER = 1 << 3,
  HOUSE_BRAVERY = 1 << 6,
  HOUSE_BRILLIANCE = 1 << 7,
  HOUSE_BALANCE = 1 << 8,
  EARLY_SUPPORTER = 1 << 9,
  TEAM_USER = 1 << 10,
  SYSTEM = 1 << 12
}

export enum Nitro_Types {
  NITRO_CLASSIC = 1,
  NITRO
}

export interface Vanity_Invite {
  code: string | null
  uses: number
}

export interface Guild_Embed {
  /** Whether the embed is enbaled. */
  enabled: boolean
}

export interface Get_audit_logsOptions {
  /** Filter the logs for actions made by this user. */
  user_id?: string
  /** The type of audit log. */
  action_type?: AuditLogType
  /** Filter the logs before a certain log entry. */
  before?: string
  /** How many entries are returned. Between 1-100. Default 50. */
  limit?: number
}

export type AuditLogType =
  | `GUILD_UPDATE`
  | `CHANNEL_CREATE`
  | `CHANNEL_UPDATE`
  | `CHANNEL_DELETE`
  | `CHANNEL_OVERWRITE_CREATE`
  | `CHANNEL_OVERWRITE_UPDATE`
  | `CHANNEL_OVERWRITE_DELETE`
  | `MEMBER_KICK`
  | `MEMBER_PRUNE`
  | `MEMBER_BAN_ADD`
  | `MEMBER_BAN_REMOVE`
  | `MEMBER_UPDATE`
  | `MEMBER_ROLE_UPDATE`
  | `MEMBER_MOVE`
  | `MEMBER_DISCONNECT`
  | `BOT_ADD`
  | `ROLE_CREATE`
  | `ROLE_UPDATE`
  | `ROLE_DELETE`
  | `INVITE_CREATE`
  | `INVITE_UPDATE`
  | `INVITE_DELETE`
  | `WEBHOOK_CREATE`
  | `WEBHOOK_UPDATE`
  | `WEBHOOK_DELETE`
  | `EMOJI_CREATE`
  | `EMOJI_UPDATE`
  | `EMOJI_DELETE`
  | `MESSAGE_DELETE`
  | `MESSAGE_BULK_DELETE`
  | `MESSAGE_PIN`
  | `MESSAGE_UNPIN`
  | `INTEGRATION_CREATE`
  | `INTEGRATION_UPDATE`
  | `INTEGRATION_DELETE`

export enum AuditLogs {
  GUILD_UPDATE = 1,
  CHANNEL_CREATE = 10,
  CHANNEL_UPDATE,
  CHANNEL_DELETE,
  CHANNEL_OVERWRITE_CREATE,
  CHANNEL_OVERWRITE_UPDATE,
  CHANNEL_OVERWRITE_DELETE,
  MEMBER_KICK = 20,
  MEMBER_PRUNE,
  MEMBER_BAN_ADD,
  MEMBER_BAN_REMOVE,
  MEMBER_UPDATE,
  MEMBER_ROLE_UPDATE,
  MEMBER_MOVE,
  MEMBER_DISCONNECT,
  BOT_ADD,
  ROLE_CREATE = 30,
  ROLE_UPDATE,
  ROLE_DELETE,
  INVITE_CREATE = 40,
  INVITE_UPDATE,
  INVITE_DELETE,
  WEBHOOK_CREATE = 50,
  WEBHOOK_UPDATE,
  WEBHOOK_DELETE,
  EMOJI_CREATE = 60,
  EMOJI_UPDATE,
  EMOJI_DELETE,
  MESSAGE_DELETE = 72,
  MESSAGE_BULK_DELETE,
  MESSAGE_PIN,
  MESSAGE_UNPIN,
  INTEGRATION_CREATE = 80,
  INTEGRATION_UPDATE,
  INTEGRATION_DELETE
}

export type Image_Size = 16 | 32 | 64 | 128 | 256 | 512 | 1024 | 2048
export type Image_Formats = 'jpg' | 'jpeg' | 'png' | 'webp' | 'gif'
export type ChannelType = 'text' | 'dm' | 'news' | 'voice' | 'category' | 'store'

export type Permission =
  | `CREATE_INSTANT_INVITE`
  | `KICK_MEMBERS`
  | `BAN_MEMBERS`
  | `ADMINISTRATOR`
  | `MANAGE_CHANNELS`
  | `MANAGE_GUILD`
  | `ADD_REACTIONS`
  | `VIEW_AUDIT_LOG`
  | `VIEW_CHANNEL`
  | `SEND_MESSAGES`
  | `SEND_TTS_MESSAGES`
  | `MANAGE_MESSAGES`
  | `EMBED_LINKS`
  | `ATTACH_FILES`
  | `READ_MESSAGE_HISTORY`
  | `MENTION_EVERYONE`
  | `USE_EXTERNAL_EMOJIS`
  | `CONNECT`
  | `SPEAK`
  | `MUTE_MEMBERS`
  | `DEAFEN_MEMBERS`
  | `MOVE_MEMBERS`
  | `USE_VAD`
  | `PRIORITY_SPEAKER`
  | `STREAM`
  | `CHANGE_NICKNAME`
  | `MANAGE_NICKNAMES`
  | `MANAGE_ROLES`
  | `MANAGE_WEBHOOKS`
  | `MANAGE_EMOJIS`

export interface Overwrite {
  /** The role or user id */
  id: string
  /** Whether this is a role or a member */
  type: 'role' | 'member'
  /** The permissions that this id is allowed to do. (This will mark it as a green check.) */
  allow: Permission[]
  /** The permissions that this id is NOT allowed to do. (This will mark it as a red x.) */
  deny: Permission[]
}

export enum ChannelTypes {
  text,
  dm,
  voice,
  category = 4,
  news,
  store
}

export enum Permissions {
  CREATE_INSTANT_INVITE = 0x00000001,
  KICK_MEMBERS = 0x00000002,
  BAN_MEMBERS = 0x00000004,
  ADMINISTRATOR = 0x00000008,
  MANAGE_CHANNELS = 0x00000010,
  MANAGE_GUILD = 0x00000020,
  ADD_REACTIONS = 0x00000040,
  VIEW_AUDIT_LOG = 0x00000080,
  VIEW_CHANNEL = 0x00000400,
  SEND_MESSAGES = 0x00000800,
  SEND_TTS_MESSAGES = 0x00001000,
  MANAGE_MESSAGES = 0x00002000,
  EMBED_LINKS = 0x00004000,
  ATTACH_FILES = 0x00008000,
  READ_MESSAGE_HISTORY = 0x00010000,
  MENTION_EVERYONE = 0x00020000,
  USE_EXTERNAL_EMOJIS = 0x00040000,
  CONNECT = 0x00100000,
  SPEAK = 0x00200000,
  MUTE_MEMBERS = 0x00400000,
  DEAFEN_MEMBERS = 0x00800000,
  MOVE_MEMBERS = 0x01000000,
  USE_VAD = 0x02000000,
  PRIORITY_SPEAKER = 0x00000100,
  STREAM = 0x00000200,
  CHANGE_NICKNAME = 0x04000000,
  MANAGE_NICKNAMES = 0x08000000,
  MANAGE_ROLES = 0x10000000,
  MANAGE_WEBHOOKS = 0x20000000,
  MANAGE_EMOJIS = 0x40000000
}

export interface ChannelCreate_Options {
  /** The type of the channel */
  type?: ChannelType
  /** The channel topic. (0-1024 characters) */
  topic?: string
  /** The bitrate(in bits) of the voice channel. */
  bitrate?: number
  /** The user limit of the voice channel. */
  user_limit?: number
  /** The amount of seconds a user has to wait before sending another message. (0-21600 seconds). Bots, as well as users with the permission `manage_messages or manage_channel` are unaffected. */
  rate_limit_per_user?: number
  /** The sorting position of the channel */
  position?: number
  /** The channel's permission overwrites */
  permission_overwrites?: Overwrite[]
  /** The id of the parent category for the channel */
  parent_id?: string
  /** Whether the channel is nsfw */
  nsfw?: boolean
  /** The reason to add in the Audit Logs. */
  reason?: string
}

export interface Create_Emojis_Options {
  /** The roles for which this emoji will be whitelisted. Only the users with one of these roles can use this emoji. */
  roles: string[]
  /** The reason to have in the Audit Logs. */
  reason: string
}

export interface Edit_Emojis_Options {
  /** The name of the emoji */
  name: string
  /** The roles for which this emoji will be whitelisted. Only the users with one of these roles can use this emoji. */
  roles: string[]
}

export interface Create_Role_Options {
  name?: string
  permissions?: Permission[]
  color?: number
  hoist?: boolean
  mentionable?: boolean
}

export interface PrunePayload {
  pruned: number
}

export const createGuild = (data: CreateGuildPayload, client: Client) => {
  const guild: Guild = {
    ...data,
    roles: new Map(data.roles.map(r => [r.id, create_role(r)])),
    emojis: new Map(data.emojis.map(e => [e.id, create_emoji(e)])),
    joinedAt: Date.parse(data.joined_at),
    voiceStates: new Map(data.voice_states.map(vs => [vs.id, create_voice_state(vs)])),
    members: new Map(data.members.map(m => [m.id, create_member(m)])),
    channels: data.channels.map(channel => create_channel(channel)),
    presences: data.presences.map(presence => createPresence(presence)),
    icon_url: (size, format) =>
      data.icon ? formatImageURL(endpoints.GUILD_ICON(data.id, data.icon), size, format) : undefined,
    splash_url: (size, format) =>
      data.splash ? formatImageURL(endpoints.GUILD_SPLASH(data.id, data.splash), size, format) : undefined,
    banner_url: (size, format) =>
      data.banner ? formatImageURL(endpoints.GUILD_BANNER(data.id, data.banner), size, format) : undefined,
    create_channel: (name, options) => {
      // TODO: Check if the bot has `MANAGE_CHANNELS` permission before making a channel
      return client.RequestManager.post(endpoints.GUILD_CHANNELS(data.id), {
        name,
        type: options?.type ? ChannelTypes[options.type] : undefined,
        permission_overwrites: options?.permission_overwrites
          ? options.permission_overwrites.map(perm => ({
              ...perm,
              allow: perm.allow.map(p => Permissions[p]),
              deny: perm.deny.map(p => Permissions[p])
            }))
          : undefined,
        ...options
      })
    },
    create_emoji: (name, image, options) => {
      // TODO: Check if the bot has `MANAGE_EMOJIS` permission
      return client.RequestManager.post(endpoints.GUILD_EMOJIS(data.id), {
        ...options,
        name,
        image
      })
    },
    edit_emoji: (id, options) => {
      // TODO: check if the bot has `MANAGE_EMOJIS` permission
      return client.RequestManager.patch(endpoints.GUILD_EMOJI(data.id, id), {
        name: options.name,
        roles: options.roles
      })
    },
    delete_emoji: (id, reason) => {
      // TODO: check if the bot has `MANAGE_EMOJIS` permission
      return client.RequestManager.delete(endpoints.GUILD_EMOJI(data.id, id), { reason })
    },
    create_role: async options => {
      // TODO: check if the bot has the `MANAGE_ROLES` permission.
      const role = await client.RequestManager.post(endpoints.GUILD_ROLES(data.id), {
        ...options,
        permissions: options.permissions?.map(perm => Permissions[perm])
      })
      // TODO: cache this role

      return role
    },
    edit_role: (id, options) => {
      return client.RequestManager.patch(endpoints.GUILD_ROLE(data.id, id), options)
    },
    delete_role: id => {
      return client.RequestManager.delete(endpoints.GUILD_ROLE(data.id, id))
    },
    get_prune_count: async days => {
      if (days < 1) throw `The number of days to count prune for must be 1 or more.`
      // TODO: check if the bot has `KICK_MEMBERS` permission
      const result = (await client.RequestManager.get(endpoints.GUILD_PRUNE(data.id), { days })) as PrunePayload
      return result.pruned
    },
    prune_members: days => {
      if (days < 1) throw `The number of days must be 1 or more.`
      // TODO: check if the bot has `KICK_MEMBERS` permission.
      return client.RequestManager.post(endpoints.GUILD_PRUNE(data.id), { days })
    },
    fetchAllMembers: () => {
      // TODO: REQUEST THIS OVER WEBSOCKET WITH GET_GUILD_MEMBERS ENDPOINT
    },
    get_audit_logs: options => {
      // TODO: check if the bot has VIEW_AUDIT_LOGS permission
      return client.RequestManager.get(endpoints.GUILD_AUDIT_LOGS(data.id), {
        ...options,
        limit: options.limit && options.limit >= 1 && options.limit <= 100 ? options.limit : 50
      })
    },
    get_embed: () => {
      // TODO: check if the bot has the MANAGE_GUILD permission
      return client.RequestManager.get(endpoints.GUILD_EMBED(data.id))
    },
    edit_embed: (enabled, channel_id) => {
      // TODO: Requires the MANAGE_GUILD permission.
      return client.RequestManager.patch(endpoints.GUILD_EMBED(data.id), { enabled, channel_id })
    },
    get_vanity_url: () => {
      return client.RequestManager.get(endpoints.GUILD_VANITY_URL(data.id))
    },
    get_integrations: () => {
      // TODO: requires the MANAGE_GUILD permission
      return client.RequestManager.get(endpoints.GUILD_INTEGRATIONS(data.id))
    },
    leave_voice_channel: () => {}
  }

  return guild
}