mirror of
https://github.com/discordeno/discordeno.git
synced 2026-09-17 08:47:22 +00:00
LTS20050703
3a95a1beda
* Adds mention limits in automod * add mention limit to automod helper, transformer * helpers/automod: send mention_total_limit to discord
86 lines
3.2 KiB
TypeScript
86 lines
3.2 KiB
TypeScript
import { Bot } from "../../../bot.ts";
|
|
import { AutoModerationRule } from "../../../transformers/automodRule.ts";
|
|
import {
|
|
AutoModerationActionType,
|
|
AutoModerationEventTypes,
|
|
DiscordAutoModerationRule,
|
|
DiscordAutoModerationRuleTriggerMetadataPresets,
|
|
} from "../../../types/discord.ts";
|
|
|
|
/** Edit a rule currently configured for guild. */
|
|
export async function editAutomodRule(
|
|
bot: Bot,
|
|
guildId: bigint,
|
|
options: Partial<EditAutoModerationRuleOptions>,
|
|
): Promise<AutoModerationRule> {
|
|
const result = await bot.rest.runMethod<DiscordAutoModerationRule>(
|
|
bot.rest,
|
|
"PATCH",
|
|
bot.constants.routes.AUTOMOD_RULES(guildId),
|
|
{
|
|
name: options.name,
|
|
event_type: options.eventType,
|
|
trigger_metadata: options.triggerMetadata
|
|
? {
|
|
keyword_filter: options.triggerMetadata.keywordFilter,
|
|
presets: options.triggerMetadata.presets,
|
|
allow_list: options.triggerMetadata.allowList,
|
|
mention_total_limit: options.triggerMetadata.mentionTotalLimit,
|
|
}
|
|
: undefined,
|
|
actions: options.actions?.map((action) => ({
|
|
type: action.type,
|
|
metadata: {
|
|
channel_id: action.metadata.channelId?.toString(),
|
|
duration_seconds: action.metadata.durationSeconds,
|
|
},
|
|
})),
|
|
enabled: options.enabled ?? true,
|
|
exempt_roles: options.exemptRoles?.map((id) => id.toString()),
|
|
exempt_channels: options.exemptChannels?.map((id) => id.toString()),
|
|
reason: options.reason,
|
|
},
|
|
);
|
|
|
|
return bot.transformers.automodRule(bot, result);
|
|
}
|
|
|
|
export interface EditAutoModerationRuleOptions {
|
|
/** The name of the rule. */
|
|
name: string;
|
|
/** The type of event to trigger the rule on. */
|
|
eventType: AutoModerationEventTypes;
|
|
/** The metadata to use for the trigger. */
|
|
triggerMetadata: {
|
|
/** The keywords needed to match. Only present when TriggerType.Keyword */
|
|
keywordFilter?: string[];
|
|
// TODO: This may need a special type or enum
|
|
/** The pre-defined lists of words to match from. Only present when TriggerType.KeywordPreset */
|
|
presets?: DiscordAutoModerationRuleTriggerMetadataPresets[];
|
|
/** The substrings which will exempt from triggering the preset trigger type. Only present when TriggerType.KeywordPreset */
|
|
allowList?: string[];
|
|
/** Total number of mentions (role & user) allowed per message (Maximum of 50) */
|
|
mentionTotalLimit: number;
|
|
};
|
|
/** The actions that will trigger for this rule */
|
|
actions: {
|
|
/** The type of action to take when a rule is triggered */
|
|
type: AutoModerationActionType;
|
|
/** additional metadata needed during execution for this specific action type */
|
|
metadata: {
|
|
/** The id of channel to which user content should be logged. Only in SendAlertMessage */
|
|
channelId?: bigint;
|
|
/** Timeout duration in seconds. Only supported for TriggerType.Keyword */
|
|
durationSeconds?: number;
|
|
};
|
|
}[];
|
|
/** Whether the rule should be enabled. */
|
|
enabled?: boolean;
|
|
/** The role ids that should not be effected by the rule */
|
|
exemptRoles?: bigint[];
|
|
/** The channel ids that should not be effected by the rule. */
|
|
exemptChannels?: bigint[];
|
|
/** The reason to add to the audit logs. */
|
|
reason?: string;
|
|
}
|