move plugins to the main repo

2026-09-17 08:47:22 +00:00 · 2022-01-26 19:02:34 +01:00
parent ecafae8e87
commit 7d2e157148
93 changed files with 4928 additions and 0 deletions
@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright Copyright 2021 - 2022 Discordeno
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
@@ -0,0 +1 @@
+# helpers-plugin
@@ -0,0 +1 @@
+export * from "../../mod.ts";
@@ -0,0 +1,123 @@
+import {
+  ApplicationCommandOptionChoice,
+  Bot,
+  Collection,
+  CreateMessage,
+  DiscordenoChannel,
+  DiscordenoMember,
+  DiscordenoMessage,
+  FinalHelpers,
+  ListGuildMembers,
+  ModifyThread,
+} from "./deps.ts";
+import { cloneChannel } from "./src/channels.ts";
+import { sendAutocompleteChoices } from "./src/sendAutoCompleteChoices.ts";
+import { sendDirectMessage } from "./src/sendDirectMessage.ts";
+import { suppressEmbeds } from "./src/suppressEmbeds.ts";
+import {
+  archiveThread,
+  editThread,
+  lockThread,
+  unarchiveThread,
+  unlockThread,
+} from "./src/threads.ts";
+import { disconnectMember } from "./src/disconnectMember.ts";
+import { getMembersPaginated } from "./src/getMembersPaginated.ts";
+import { moveMember } from "./src/moveMember.ts";
+
+export interface BotWithHelpersPlugin extends Bot {
+  helpers: FinalHelpers & {
+    sendDirectMessage: (
+      userId: bigint,
+      content: string | CreateMessage
+    ) => Promise<DiscordenoMessage>;
+    suppressEmbeds: (
+      channelId: bigint,
+      messageId: bigint
+    ) => Promise<DiscordenoMessage>;
+    archiveThread: (threadId: bigint) => Promise<DiscordenoChannel>;
+    unarchiveThread: (threadId: bigint) => Promise<DiscordenoChannel>;
+    lockThread: (threadId: bigint) => Promise<DiscordenoChannel>;
+    unlockThread: (threadId: bigint) => Promise<DiscordenoChannel>;
+    editThread: (
+      threadId: bigint,
+      options: ModifyThread,
+      reason?: string
+    ) => Promise<DiscordenoChannel>;
+    cloneChannel: (
+      channel: DiscordenoChannel,
+      reason?: string
+    ) => Promise<DiscordenoChannel>;
+    sendAutocompleteChoices: (
+      interactionId: bigint,
+      interactionToken: string,
+      choices: ApplicationCommandOptionChoice[]
+    ) => Promise<void>;
+    disconnectMember: (
+      guildId: bigint,
+      memberId: bigint
+    ) => Promise<DiscordenoMember>;
+    getMembersPaginated: (
+      guildId: bigint,
+      options: ListGuildMembers & { memberCount: number }
+    ) => Promise<Collection<bigint, DiscordenoMember>>;
+    moveMember: (
+      guildId: bigint,
+      memberId: bigint,
+      channelId: bigint
+    ) => Promise<DiscordenoMember>;
+  };
+}
+
+export function enableHelpersPlugin(rawBot: Bot): BotWithHelpersPlugin {
+  const bot = rawBot as BotWithHelpersPlugin;
+
+  bot.helpers.sendDirectMessage = (
+    userId: bigint,
+    content: string | CreateMessage
+  ) => sendDirectMessage(bot, userId, content);
+  bot.helpers.suppressEmbeds = (channelId: bigint, messageId: bigint) =>
+    suppressEmbeds(bot, channelId, messageId);
+  bot.helpers.archiveThread = (threadId: bigint) =>
+    archiveThread(bot, threadId);
+  bot.helpers.unarchiveThread = (threadId: bigint) =>
+    unarchiveThread(bot, threadId);
+  bot.helpers.lockThread = (threadId: bigint) => lockThread(bot, threadId);
+  bot.helpers.unlockThread = (threadId: bigint) => unlockThread(bot, threadId);
+  bot.helpers.editThread = (
+    threadId: bigint,
+    options: ModifyThread,
+    reason?: string
+  ) => editThread(bot, threadId, options, reason);
+  bot.helpers.cloneChannel = (channel: DiscordenoChannel, reason?: string) =>
+    cloneChannel(bot, channel, reason);
+  bot.helpers.sendAutocompleteChoices = (
+    interactionId: bigint,
+    interactionToken: string,
+    choices: ApplicationCommandOptionChoice[]
+  ) => sendAutocompleteChoices(bot, interactionId, interactionToken, choices);
+  bot.helpers.disconnectMember = (guildId: bigint, memberId: bigint) =>
+    disconnectMember(bot, guildId, memberId);
+  bot.helpers.getMembersPaginated = (
+    guildId: bigint,
+    options: ListGuildMembers & { memberCount: number }
+  ) => getMembersPaginated(bot, guildId, options);
+  bot.helpers.moveMember = (
+    guildId: bigint,
+    memberId: bigint,
+    channelId: bigint
+  ) => moveMember(bot, guildId, memberId, channelId);
+
+  return bot as BotWithHelpersPlugin;
+}
+
+// EXPORT EVERYTHING HERE SO USERS CAN OPT TO USE FUNCTIONS DIRECTLY
+export * from "./src/channels.ts";
+export * from "./src/disconnectMember.ts";
+export * from "./src/getMembersPaginated.ts";
+export * from "./src/moveMember.ts";
+export * from "./src/sendAutoCompleteChoices.ts";
+export * from "./src/sendDirectMessage.ts";
+export * from "./src/suppressEmbeds.ts";
+export * from "./src/threads.ts";
+export default enableHelpersPlugin;
@@ -0,0 +1,46 @@
+import {
+  Bot,
+  CreateGuildChannel,
+  DiscordenoChannel,
+  separateOverwrites,
+} from "../deps.ts";
+
+/** Create a copy of a channel */
+export async function cloneChannel(
+  bot: Bot,
+  channel: DiscordenoChannel,
+  reason?: string,
+) {
+  if (!channel.guildId) {
+    throw new Error(`Cannot clone a channel outside a guild`);
+  }
+
+  const createChannelOptions: CreateGuildChannel = {
+    type: channel.type,
+    bitrate: channel.bitrate,
+    userLimit: channel.userLimit,
+    rateLimitPerUser: channel.rateLimitPerUser,
+    position: channel.position,
+    parentId: channel.parentId,
+    nsfw: channel.nsfw,
+    name: channel.name!,
+    topic: channel.topic || undefined,
+    permissionOverwrites: channel.permissionOverwrites.map((overwrite) => {
+      const [type, id, allow, deny] = separateOverwrites(overwrite);
+
+      return {
+        id,
+        type,
+        allow: bot.utils.calculatePermissions(BigInt(allow)),
+        deny: bot.utils.calculatePermissions(BigInt(deny)),
+      };
+    }),
+  };
+
+  //Create the channel (also handles permissions)
+  return await bot.helpers.createChannel(
+    channel.guildId!,
+    createChannelOptions,
+    reason,
+  );
+}
@@ -0,0 +1,6 @@
+import { Bot } from "../deps.ts";
+
+/** Kicks a member from a voice channel */
+export function disconnectMember(bot: Bot, guildId: bigint, memberId: bigint) {
+  return bot.helpers.editMember(guildId, memberId, { channelId: null });
+}
@@ -0,0 +1,73 @@
+import {
+  Bot,
+  Collection,
+  DiscordenoMember,
+  GuildMemberWithUser,
+  ListGuildMembers,
+} from "../deps.ts";
+
+/**
+ * Highly recommended to **NOT** use this function to get members instead use fetchMembers().
+ * REST(this function): 50/s global(across all shards) rate limit with ALL requests this included
+ * GW(fetchMembers): 120/m(PER shard) rate limit. Meaning if you have 8 shards your limit is 960/m.
+ */
+export async function getMembersPaginated(
+  bot: Bot,
+  guildId: bigint,
+  options: ListGuildMembers & { memberCount: number }
+) {
+  const members = new Collection<bigint, DiscordenoMember>();
+
+  let membersLeft = options?.limit ?? options.memberCount;
+  let loops = 1;
+  while (
+    (options?.limit ?? options.memberCount) > members.size &&
+    membersLeft > 0
+  ) {
+    bot.events.debug("Running while loop in getMembers function.");
+
+    if (options?.limit && options.limit > 1000) {
+      console.log(
+        `Paginating get members from REST. #${loops} / ${Math.ceil(
+          (options?.limit ?? 1) / 1000
+        )}`
+      );
+    }
+
+    const result = await bot.rest.runMethod<GuildMemberWithUser[]>(
+      bot.rest,
+      "get",
+      `${bot.constants.endpoints.GUILD_MEMBERS(guildId)}?limit=${
+        membersLeft > 1000 ? 1000 : membersLeft
+      }${options?.after ? `&after=${options.after}` : ""}`
+    );
+
+    const discordenoMembers = result.map((member) =>
+      bot.transformers.member(
+        bot,
+        member,
+        guildId,
+        bot.transformers.snowflake(member.user.id)
+      )
+    );
+
+    if (!discordenoMembers.length) break;
+
+    discordenoMembers.forEach((member) => {
+      bot.events.debug(`Running forEach loop in get_members file.`);
+      members.set(member.id, member);
+    });
+
+    options = {
+      limit: options?.limit,
+      after: discordenoMembers[discordenoMembers.length - 1].id.toString(),
+      memberCount: options.memberCount,
+    };
+
+    membersLeft -= 1000;
+
+    loops++;
+  }
+
+  return members;
+}
@@ -0,0 +1,13 @@
+import { Bot } from "../deps.ts";
+
+/**
+ * Move a member from a voice channel to another.
+ */
+export function moveMember(
+  bot: Bot,
+  guildId: bigint,
+  memberId: bigint,
+  channelId: bigint
+) {
+  return bot.helpers.editMember(guildId, memberId, { channelId });
+}
@@ -0,0 +1,19 @@
+import {
+  ApplicationCommandOptionChoice,
+  Bot,
+  InteractionResponseTypes,
+} from "../deps.ts";
+
+export async function sendAutocompleteChoices(
+  bot: Bot,
+  interactionId: bigint,
+  interactionToken: string,
+  choices: ApplicationCommandOptionChoice[]
+): Promise<void> {
+  await bot.helpers.sendInteractionResponse(interactionId, interactionToken, {
+    type: InteractionResponseTypes.ApplicationCommandAutocompleteResult,
+    data: {
+      choices: choices,
+    },
+  });
+}
@@ -0,0 +1,27 @@
+import { Bot, Collection, CreateMessage } from "../deps.ts";
+
+/** Maps the <userId, channelId> for dm channels */
+export const dmChannelIds = new Collection<bigint, bigint>();
+
+/** Sends a direct message to a user. This can take two API calls. The first call is to create a dm channel. Then sending the message to that channel. Channel ids are cached as needed to prevent duplicate requests. */
+export async function sendDirectMessage(
+  bot: Bot,
+  userId: bigint,
+  content: string | CreateMessage,
+) {
+  if (typeof content === "string") content = { content };
+  
+  // GET CHANNEL ID FROM CACHE OR CREATE THE CHANNEL FOR THIS USER
+  const cachedChannelId = dmChannelIds.get(userId);
+  // IF ID IS CACHED SEND MESSAGE DIRECTLY
+  if (cachedChannelId) return bot.helpers.sendMessage(cachedChannelId, content);
+
+  // CREATE A NEW DM CHANNEL AND PULCK ITS ID
+  const channel = (await bot.helpers.getDmChannel(userId));
+
+  // CACHE IT FOR FUTURE REQUESTS
+  dmChannelIds.set(userId, channel.id);
+
+  // CACHE CHANNEL IF NEEDED
+  return bot.helpers.sendMessage(channel.id, content);
+}
@@ -0,0 +1,17 @@
+import { Bot, Message } from "../deps.ts";
+
+/** Suppress all the embeds in this message */
+export async function suppressEmbeds(
+  bot: Bot,
+  channelId: bigint,
+  messageId: bigint,
+) {
+  const result = await bot.rest.runMethod<Message>(
+    bot.rest,
+    "patch",
+    bot.constants.endpoints.CHANNEL_MESSAGE(channelId, messageId),
+    { flags: 4 },
+  );
+
+  return bot.transformers.message(bot, result);
+}
@@ -0,0 +1,38 @@
+import { Bot, Channel, ModifyThread } from "../deps.ts";
+
+/** Sets a thread channel to be archived. */
+export async function archiveThread(bot: Bot, threadId: bigint) {
+  return await editThread(bot, threadId, { archived: true });
+}
+
+/** Sets a thread channel to be unarchived. */
+export async function unarchiveThread(bot: Bot, threadId: bigint) {
+  return await editThread(bot, threadId, { archived: false });
+}
+
+/** Sets a thread channel to be locked. */
+export async function lockThread(bot: Bot, threadId: bigint) {
+  return await editThread(bot, threadId, { locked: true });
+}
+
+/** Sets a thread channel to be unlocked. */
+export async function unlockThread(bot: Bot, threadId: bigint) {
+  return await editThread(bot, threadId, { locked: false });
+}
+
+/** Update a thread's settings. Requires the `MANAGE_CHANNELS` permission for the guild. */
+export async function editThread(bot: Bot, threadId: bigint, options: ModifyThread, reason?: string) {
+  const result = await bot.rest.runMethod<Channel>(bot.rest, "patch", bot.constants.endpoints.CHANNEL_BASE(threadId), {
+    name: options.name,
+    archived: options.archived,
+    auto_archive_duration: options.autoArchiveDuration,
+    locked: options.locked,
+    rate_limit_per_user: options.rateLimitPerUser,
+    reason,
+  });
+
+  return bot.transformers.channel(bot, {
+    channel: result,
+    guildId: result.guild_id ? bot.transformers.snowflake(result.guild_id) : undefined,
+  });
+}