disgroove 1.3.1 → 1.3.3-dev.1

package/lib/structures/Webhook.ts

@@ -0,0 +1,341 @@
+import { Base, Channel, Guild, Message, User } from ".";
+import type { Client } from "../Client";
+import { Endpoints, type File } from "../rest";
+import type {
+  JSONActionRow,
+  JSONAllowedMentions,
+  JSONAttachment,
+  JSONEmbed,
+  JSONWebhook,
+  RawMessage,
+  RawWebhook,
+} from "../types";
+import type { MessageFlags, WebhookTypes } from "../constants";
+
+/** https://discord.com/developers/docs/resources/webhook */
+export class Webhook extends Base {
+  protected override raw: RawWebhook;
+  type: WebhookTypes;
+  guildId?: string | null;
+  channelId: string | null;
+  user?: User;
+  name: string | null;
+  avatar: string | null;
+  token?: string;
+  applicationId: string | null;
+  sourceGuild?: Guild;
+  sourceChannel?: Channel;
+  url?: string;
+
+  constructor(data: RawWebhook, client: Client) {
+    super(data.id, client);
+
+    this.raw = data;
+    this.type = data.type;
+    this.channelId = data.channel_id;
+    this.name = data.name;
+    this.avatar = data.avatar;
+    this.applicationId = data.application_id;
+
+    this.patch(data);
+  }
+
+  protected override patch(data: RawWebhook): void {
+    if (data.guild_id !== undefined) this.guildId = data.guild_id;
+    if (data.user !== undefined) this.user = new User(data.user, this.client);
+    if (data.token !== undefined) this.token = data.token;
+    if (data.source_guild !== undefined)
+      this.sourceGuild = new Guild(data.source_guild, this.client);
+    if (data.source_channel !== undefined)
+      this.sourceChannel = new Channel(data.source_channel, this.client);
+    if (data.url !== undefined) this.url = data.url;
+  }
+
+  /** https://discord.com/developers/docs/resources/webhook#delete-webhook */
+  delete(reason?: string): void {
+    this.client.rest.delete(Endpoints.webhook(this.id), {
+      reason,
+    });
+  }
+
+  /** https://discord.com/developers/docs/resources/webhook#delete-webhook-message */
+  deleteMessage(
+    messageId: string,
+    options?: {
+      threadId?: string;
+    }
+  ): void {
+    if (!this.token) throw new Error("[disgroove] Webhook token not found");
+
+    this.client.rest.delete(
+      Endpoints.webhookMessage(this.id, this.token, messageId),
+      {
+        query: {
+          thread_id: options?.threadId,
+        },
+      }
+    );
+  }
+
+  /** https://discord.com/developers/docs/resources/webhook#delete-webhook-with-token */
+  deleteWithToken(reason?: string): void {
+    if (!this.token) throw new Error("[disgroove] Webhook token not found");
+
+    this.client.rest.delete(Endpoints.webhook(this.id, this.token), {
+      reason,
+      authorization: false,
+    });
+  }
+
+  /** https://discord.com/developers/docs/resources/webhook#modify-webhook */
+  async edit(
+    options: {
+      name?: string;
+      avatar?: string | null;
+      channelId?: string;
+    },
+    reason?: string
+  ): Promise<Webhook> {
+    return new Webhook(
+      await this.client.rest.patch<RawWebhook>(Endpoints.webhook(this.id), {
+        json: {
+          name: options.name,
+          avatar: options.avatar,
+          channel_id: options.channelId,
+        },
+        reason,
+      }),
+      this.client
+    );
+  }
+
+  /** https://discord.com/developers/docs/resources/webhook#edit-webhook-message */
+  async editMessage(
+    messageId: string,
+    options: {
+      threadId?: string;
+      content?: string | null;
+      embeds?: Array<JSONEmbed> | null;
+      flags?: MessageFlags | null;
+      allowedMentions?: JSONAllowedMentions | null;
+      components?: Array<JSONActionRow> | null;
+      files?: Array<File> | null;
+      attachments?: Array<JSONAttachment> | null;
+    }
+  ): Promise<Message> {
+    if (!this.token) throw new Error("[disgroove] Webhook token not found");
+
+    return new Message(
+      await this.client.rest.patch<RawMessage>(
+        Endpoints.webhookMessage(this.id, this.token, messageId),
+        {
+          json: {
+            content: options.content,
+            embeds:
+              options.embeds !== undefined
+                ? options.embeds !== null
+                  ? this.client.util.embedsToRaw(options.embeds)
+                  : null
+                : undefined,
+            allowed_mentions: {
+              parse: options.allowedMentions?.parse,
+              roles: options.allowedMentions?.roles,
+              users: options.allowedMentions?.users,
+              replied_user: options.allowedMentions?.repliedUser,
+            },
+            components:
+              options.components !== undefined
+                ? options.components !== null
+                  ? this.client.util.messageComponentsToRaw(options.components)
+                  : null
+                : undefined,
+            attachments: options.attachments,
+            flags: options.flags,
+          },
+          files: options.files,
+          query: {
+            thread_id: options.threadId,
+          },
+        }
+      ),
+      this.client
+    );
+  }
+
+  /** https://discord.com/developers/docs/resources/webhook#modify-webhook-with-token */
+  async editWithToken(
+    options: {
+      name?: string;
+      avatar?: string | null;
+    },
+    reason?: string
+  ): Promise<Webhook> {
+    if (!this.token) throw new Error("[disgroove] Webhook token not found");
+
+    return new Webhook(
+      await this.client.rest.patch<RawWebhook>(
+        Endpoints.webhook(this.id, this.token),
+        {
+          json: {
+            name: options.name,
+            avatar: options.avatar,
+          },
+          reason,
+          authorization: false,
+        }
+      ),
+      this.client
+    );
+  }
+
+  /** https://discord.com/developers/docs/resources/webhook#execute-webhook */
+  async execute(options: {
+    wait?: boolean;
+    threadId?: string;
+    content?: string | null;
+    username?: string;
+    avatarURL?: string;
+    tts?: boolean;
+    embeds?: Array<JSONEmbed> | null;
+    allowedMentions?: JSONAllowedMentions | null;
+    components?: Array<JSONActionRow> | null;
+    files?: Array<File> | null;
+    attachments?: Array<JSONAttachment> | null;
+    flags?: MessageFlags | null;
+    threadName?: string;
+  }): Promise<Message | null> {
+    if (!this.token) throw new Error("[disgroove] Webhook token not found");
+
+    return this.client.rest
+      .post<RawMessage | null>(Endpoints.webhook(this.id, this.token), {
+        json: {
+          content: options.content,
+          tts: options.tts,
+          embeds:
+            options.embeds !== undefined
+              ? options.embeds !== null
+                ? this.client.util.embedsToRaw(options.embeds)
+                : null
+              : undefined,
+          allowed_mentions: {
+            parse: options.allowedMentions?.parse,
+            roles: options.allowedMentions?.roles,
+            users: options.allowedMentions?.users,
+            replied_user: options.allowedMentions?.repliedUser,
+          },
+          components:
+            options.components !== undefined
+              ? options.components !== null
+                ? this.client.util.messageComponentsToRaw(options.components)
+                : null
+              : undefined,
+          attachments: options.attachments,
+          flags: options.flags,
+          thread_name: options.threadName,
+        },
+        files: options.files,
+        query: {
+          wait: options.wait,
+          thread_id: options.threadId,
+          username: options.username,
+          avatarURL: options.avatarURL,
+        },
+      })
+      .then((response) => {
+        if (response !== null) {
+          return new Message(response, this.client);
+        } else return null;
+      });
+  }
+
+  /** https://discord.com/developers/docs/resources/webhook#execute-githubcompatible-webhook */
+  async executeGitHubCompatible(options: {
+    threadId?: string;
+    wait?: boolean;
+  }): Promise<Message | null> {
+    if (!this.token) throw new Error("[disgroove] Webhook token not found");
+
+    return this.client.rest
+      .post<RawMessage | null>(
+        Endpoints.webhookPlatform(this.id, this.token, "github"),
+        {
+          query: {
+            thread_id: options.threadId,
+            wait: options.wait,
+          },
+        }
+      )
+      .then((response) => {
+        if (response !== null) {
+          return new Message(response, this.client);
+        } else return null;
+      });
+  }
+
+  /** https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook */
+  async executeSlackCompatible(options: {
+    threadId?: string;
+    wait?: boolean;
+  }): Promise<Message | null> {
+    if (!this.token) throw new Error("[disgroove] Webhook token not found");
+
+    return this.client.rest
+      .post<RawMessage | null>(
+        Endpoints.webhookPlatform(this.id, this.token, "slack"),
+        {
+          query: {
+            thread_id: options.threadId,
+            wait: options.wait,
+          },
+        }
+      )
+      .then((response) => {
+        if (response !== null) {
+          return new Message(response, this.client);
+        } else return null;
+      });
+  }
+
+  /** https://discord.com/developers/docs/resources/webhook#get-webhook-message */
+  async getMessage(
+    messageId: string,
+    options?: {
+      threadId?: string;
+    }
+  ): Promise<Message> {
+    if (!this.token) throw new Error("[disgroove] Webhook token not found");
+
+    return new Message(
+      await this.client.rest.get<RawMessage>(
+        Endpoints.webhookMessage(this.id, this.token, messageId),
+        {
+          query: {
+            thread_id: options?.threadId,
+          },
+        }
+      ),
+      this.client
+    );
+  }
+
+  override toRaw(): RawWebhook {
+    return this.raw;
+  }
+
+  override toJSON(): JSONWebhook {
+    return {
+      ...super.toJSON(),
+      type: this.type,
+      guildId: this.guildId,
+      channelId: this.channelId,
+      user: this.user?.toJSON(),
+      name: this.name,
+      avatar: this.avatar,
+      token: this.token,
+      applicationId: this.applicationId,
+      sourceGuild: this.sourceGuild?.toJSON(),
+      sourceChannel: this.sourceChannel?.toJSON(),
+      url: this.url,
+    };
+  }
+}

package/lib/structures/index.ts

@@ -0,0 +1,27 @@
+export * from "./Base";
+export * from "./Application";
+export * from "./ApplicationCommand";
+export * from "./AuditLog";
+export * from "./AutoModerationRule";
+export * from "./Channel";
+export * from "./ClientApplication";
+export * from "./Emoji";
+export * from "./Entitlement";
+export * from "./Guild";
+export * from "./GuildMember";
+export * from "./GuildScheduledEvent";
+export * from "./GuildTemplate";
+export * from "./Integration";
+export * from "./Interaction";
+export * from "./Invite";
+export * from "./Message";
+export * from "./Role";
+export * from "./SKU";
+export * from "./StageInstance";
+export * from "./Sticker";
+export * from "./Team";
+export * from "./TestEntitlement";
+export * from "./UnavailableGuild";
+export * from "./User";
+export * from "./VoiceState";
+export * from "./Webhook";

package/lib/types/application-command.ts

@@ -0,0 +1,118 @@
+import type {
+  ApplicationCommandTypes,
+  ApplicationCommandOptionType,
+  ChannelTypes,
+  Locale,
+  ApplicationCommandPermissionType,
+} from "../constants";
+
+/** https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-structure */
+export interface RawApplicationCommand {
+  id: string;
+  type?: ApplicationCommandTypes;
+  application_id: string;
+  guild_id?: string;
+  name: string;
+  name_localizations?: Partial<Record<Locale, string>> | null;
+  description: string;
+  description_localizations?: Partial<Record<Locale, string>> | null;
+  options?: Array<RawApplicationCommandOption>;
+  default_member_permissions: string | null;
+  dm_permission?: boolean;
+  default_permission?: boolean | null;
+  nsfw?: boolean;
+  version: string;
+}
+
+/** https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-structure */
+export interface RawApplicationCommandOption {
+  type: ApplicationCommandOptionType;
+  name: string;
+  name_localizations?: Partial<Record<Locale, string>> | null;
+  description: string;
+  description_localizations?: Partial<Record<Locale, string>> | null;
+  required?: boolean;
+  choices?: Array<RawApplicationCommandOptionChoice>;
+  options?: Array<RawApplicationCommandOption>;
+  channel_types?: Array<ChannelTypes>;
+  min_value?: number;
+  max_value?: number;
+  min_length?: number;
+  max_length?: number;
+  autocomplete?: boolean;
+}
+
+/** https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-choice-structure */
+export interface RawApplicationCommandOptionChoice {
+  name: string;
+  name_localizations?: Partial<Record<Locale, string>> | null;
+  value: string;
+}
+
+/** https://discord.com/developers/docs/interactions/application-commands#application-command-permissions-object-guild-application-command-permissions-structure */
+export interface RawGuildApplicationCommandPermissions {
+  id: string;
+  application_id: string;
+  guild_id: string;
+  permissions: Array<RawApplicationCommandPermission>;
+}
+
+/** https://discord.com/developers/docs/interactions/application-commands#application-command-permissions-object-application-command-permissions-structure */
+export interface RawApplicationCommandPermission {
+  id: string;
+  type: ApplicationCommandPermissionType;
+  permission: boolean;
+}
+
+export interface JSONApplicationCommand {
+  id: string;
+  type?: ApplicationCommandTypes;
+  applicationId: string;
+  guildId?: string;
+  name: string;
+  nameLocalizations?: Partial<Record<Locale, string>> | null;
+  description: string;
+  descriptionLocalizations?: Partial<Record<Locale, string>> | null;
+  options?: Array<JSONApplicationCommandOption>;
+  defaultMemberPermissions: string | null;
+  dmPermission?: boolean;
+  defaultPermission?: boolean | null;
+  nsfw?: boolean;
+  version: string;
+}
+
+export interface JSONApplicationCommandOption {
+  type: ApplicationCommandOptionType;
+  name: string;
+  nameLocalizations?: Partial<Record<Locale, string>> | null;
+  description: string;
+  descriptionLocalizations?: Partial<Record<Locale, string>> | null;
+  required?: boolean;
+  choices?: Array<JSONApplicationCommandOptionChoice>;
+  options?: Array<JSONApplicationCommandOption>;
+  channelTypes?: Array<ChannelTypes>;
+  minValue?: number;
+  maxValue?: number;
+  minLength?: number;
+  maxLength?: number;
+  autocomplete?: boolean;
+}
+
+export interface JSONApplicationCommandOptionChoice {
+  name: string;
+  nameLocalizations?: Partial<Record<Locale, string>> | null;
+  value: string;
+}
+
+export interface JSONGuildApplicationCommandPermissions {
+  id: string;
+  applicationId: string;
+  guildId: string;
+  permissions: Array<JSONApplicationCommandPermission>;
+}
+
+export interface JSONApplicationCommandPermission {
+  id: string;
+  type: ApplicationCommandPermissionType;
+  permission: boolean;
+}

package/lib/types/application-role-connection-metadata.ts

@@ -0,0 +1,23 @@
+import type {
+  ApplicationRoleConnectionMetadataType,
+  Locale,
+} from "../constants";
+
+/** https://discord.com/developers/docs/resources/application-role-connection-metadata#application-role-connection-metadata-object-application-role-connection-metadata-structure */
+export interface RawApplicationRoleConnectionMetadata {
+  type: ApplicationRoleConnectionMetadataType;
+  key: string;
+  name: string;
+  name_localizations?: Partial<Record<Locale, string>> | null;
+  description: string;
+  description_localizations?: Partial<Record<Locale, string>> | null;
+}
+
+export interface JSONApplicationRoleConnectionMetadata {
+  type: ApplicationRoleConnectionMetadataType;
+  key: string;
+  name: string;
+  nameLocalizations?: Partial<Record<Locale, string>> | null;
+  description: string;
+  descriptionLocalizations?: Partial<Record<Locale, string>> | null;
+}

package/lib/types/application.ts

@@ -0,0 +1,77 @@
+import type {
+  RawUser,
+  RawTeam,
+  JSONTeam,
+  JSONUser,
+  RawGuild,
+  JSONGuild,
+} from ".";
+import type { ApplicationFlags, OAuth2Scopes } from "../constants";
+
+/** https://discord.com/developers/docs/resources/application#application-object-application-structure */
+export interface RawApplication {
+  id: string;
+  name: string;
+  icon: string | null;
+  description: string;
+  rpc_origins?: Array<string>;
+  bot_public: boolean;
+  bot_require_code_grant: boolean;
+  terms_of_service_url?: string;
+  privacy_policy_url?: string;
+  owner?: RawUser;
+  verify_key: string;
+  team: RawTeam | null;
+  guild_id?: string;
+  guild?: RawGuild;
+  primary_sku_id?: string;
+  slug?: string;
+  cover_image?: string;
+  flags?: ApplicationFlags;
+  approximate_guild_count?: number;
+  redirect_uris?: Array<string>;
+  interactions_endpoint_url?: string;
+  role_connections_verification_url?: string;
+  tags?: Array<string>;
+  install_params?: RawInstallParams;
+  custom_install_url?: string;
+}
+
+/** https://discord.com/developers/docs/resources/application#install-params-object-install-params-structure */
+export interface RawInstallParams {
+  scopes: Array<OAuth2Scopes>;
+  permissions: string;
+}
+
+export interface JSONApplication {
+  id: string;
+  name: string;
+  icon: string | null;
+  description: string;
+  rpcOrigins?: Array<string>;
+  botPublic: boolean;
+  botRequireCodeGrant: boolean;
+  termsOfServiceURL?: string;
+  privacyPolicyURL?: string;
+  owner?: JSONUser;
+  verifyKey: string;
+  team: JSONTeam | null;
+  guildId?: string;
+  guild?: JSONGuild;
+  primarySKUId?: string;
+  slug?: string;
+  coverImage?: string;
+  flags?: ApplicationFlags;
+  approximateGuildCount?: number;
+  redirectURIs?: Array<string>;
+  interactionsEndpointURL?: string;
+  roleConnectionsVerificationURL?: string;
+  tags?: Array<string>;
+  installParams?: JSONInstallParams;
+  customInstallURL?: string;
+}
+
+export interface JSONInstallParams {
+  scopes: Array<OAuth2Scopes>;
+  permissions: string;
+}

package/lib/types/audit-log.ts

@@ -0,0 +1,105 @@
+import type {
+  RawApplicationCommand,
+  RawGuildScheduledEvent,
+  RawAutoModerationRule,
+  RawIntegration,
+  RawChannel,
+  RawUser,
+  RawWebhook,
+  JSONUser,
+  JSONApplicationCommand,
+  JSONAutoModerationRule,
+  JSONGuildScheduledEvent,
+  JSONIntegration,
+  JSONChannel,
+  JSONWebhook,
+} from ".";
+import type { AuditLogEvents } from "../constants";
+
+/** https://discord.com/developers/docs/resources/audit-log#audit-log-object-audit-log-structure */
+export interface RawAuditLog {
+  application_commands: Array<RawApplicationCommand>;
+  audit_log_entries: Array<RawAuditLogEntry>;
+  auto_moderation_rules: Array<RawAutoModerationRule>;
+  guild_scheduled_events: Array<RawGuildScheduledEvent>;
+  integrations: Array<RawIntegration>;
+  threads: Array<RawChannel>;
+  users: Array<RawUser>;
+  webhooks: Array<RawWebhook>;
+}
+
+/** https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-audit-log-entry-structure */
+export interface RawAuditLogEntry {
+  target_id: string | null;
+  changes?: Array<RawAuditLogChange>;
+  user_id: string | null;
+  id: string;
+  action_type: AuditLogEvents;
+  options?: RawOptionalAuditLogEntryInfo;
+  reason?: string;
+}
+
+/** https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-optional-audit-entry-info */
+export interface RawOptionalAuditLogEntryInfo {
+  application_id: string;
+  auto_moderation_rule_name: string;
+  auto_moderation_rule_trigger_type: string;
+  channel_id: string;
+  count: string;
+  delete_member_days: string;
+  id: string;
+  members_removed: string;
+  message_id: string;
+  role_name: string;
+  type: string;
+  integration_type: string;
+}
+
+/** https://discord.com/developers/docs/resources/audit-log#audit-log-change-object-audit-log-change-structure */
+export interface RawAuditLogChange {
+  new_value?: any;
+  old_value?: any;
+  key: string;
+}
+
+export interface JSONAuditLog {
+  applicationCommands: Array<JSONApplicationCommand>;
+  auditLogEntries: Array<JSONAuditLogEntry>;
+  autoModerationRules: Array<JSONAutoModerationRule>;
+  guildScheduledEvents: Array<JSONGuildScheduledEvent>;
+  integrations: Array<JSONIntegration>;
+  threads: Array<JSONChannel>;
+  users: Array<JSONUser>;
+  webhooks: Array<JSONWebhook>;
+}
+
+export interface JSONAuditLogEntry {
+  targetId: string | null;
+  changes?: Array<JSONAuditLogChange>;
+  userId: string | null;
+  id: string;
+  actionType: AuditLogEvents;
+  options?: JSONOptionalAuditLogEntryInfo;
+  reason?: string;
+}
+
+export interface JSONOptionalAuditLogEntryInfo {
+  applicationId: string;
+  autoModerationRuleName: string;
+  autoModerationRuleTriggerType: string;
+  channelId: string;
+  count: string;
+  deleteMemberDays: string;
+  id: string;
+  membersRemoved: string;
+  messageId: string;
+  roleName: string;
+  type: string;
+  integrationType: string;
+}
+
+export interface JSONAuditLogChange {
+  newValue?: any;
+  oldValue?: any;
+  key: string;
+}