• Home
• dev.kord
• kord-common-jvm
• 0.15.0
• source code
• AuditLog.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

commonMain.entity.AuditLog.kt Maven / Gradle / Ivy

@file:Generate(
    INT_KORD_ENUM, name = "AuditLogEvent",
    docUrl = "https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-audit-log-events",
    entries = [
        Entry("GuildUpdate", intValue = 1, kDoc = "Server settings were updated."),
        Entry("ChannelCreate", intValue = 10, kDoc = "Channel was created."),
        Entry("ChannelUpdate", intValue = 11, kDoc = "Channel settings were updated."),
        Entry("ChannelDelete", intValue = 12, kDoc = "Channel was deleted."),
        Entry("ChannelOverwriteCreate", intValue = 13, kDoc = "Permission overwrite was added to a channel."),
        Entry("ChannelOverwriteUpdate", intValue = 14, kDoc = "Permission overwrite was updated for a channel."),
        Entry("ChannelOverwriteDelete", intValue = 15, kDoc = "Permission overwrite was deleted from a channel."),
        Entry("MemberKick", intValue = 20, kDoc = "Member was removed from server."),
        Entry("MemberPrune", intValue = 21, kDoc = "Members were pruned from server."),
        Entry("MemberBanAdd", intValue = 22, kDoc = "Member was banned from server."),
        Entry("MemberBanRemove", intValue = 23, kDoc = "Server ban was lifted for a member."),
        Entry("MemberUpdate", intValue = 24, kDoc = "Member was updated in server."),
        Entry("MemberRoleUpdate", intValue = 25, kDoc = "Member was added or removed from a role."),
        Entry("MemberMove", intValue = 26, kDoc = "Member was moved to a different voice channel."),
        Entry("MemberDisconnect", intValue = 27, kDoc = "Member was disconnected from a voice channel."),
        Entry("BotAdd", intValue = 28, kDoc = "Bot user was added to server."),
        Entry("RoleCreate", intValue = 30, kDoc = "Role was created."),
        Entry("RoleUpdate", intValue = 31, kDoc = "Role was edited."),
        Entry("RoleDelete", intValue = 32, kDoc = "Role was deleted."),
        Entry("InviteCreate", intValue = 40, kDoc = "Server invite was created."),
        Entry("InviteUpdate", intValue = 41, kDoc = "Server invite was updated."),
        Entry("InviteDelete", intValue = 42, kDoc = "Server invite was deleted."),
        Entry("WebhookCreate", intValue = 50, kDoc = "Webhook was created."),
        Entry("WebhookUpdate", intValue = 51, kDoc = "Webhook properties or channel were updated."),
        Entry("WebhookDelete", intValue = 52, kDoc = "Webhook was deleted."),
        Entry("EmojiCreate", intValue = 60, kDoc = "Emoji was created."),
        Entry("EmojiUpdate", intValue = 61, kDoc = "Emoji name was updated."),
        Entry("EmojiDelete", intValue = 62, kDoc = "Emoji was deleted."),
        Entry("MessageDelete", intValue = 72, kDoc = "Single message was deleted."),
        Entry("MessageBulkDelete", intValue = 73, kDoc = "Multiple messages were deleted."),
        Entry("MessagePin", intValue = 74, kDoc = "Message was pinned to a channel."),
        Entry("MessageUnpin", intValue = 75, kDoc = "Message was unpinned from a channel."),
        Entry("IntegrationCreate", intValue = 80, kDoc = "App was added to server."),
        Entry("IntegrationUpdate", intValue = 81, kDoc = "App was updated (as an example, its scopes were updated)."),
        Entry("IntegrationDelete", intValue = 82, kDoc = "App was removed from server."),
        Entry("StageInstanceCreate", intValue = 83, kDoc = "Stage instance was created (stage channel becomes live)."),
        Entry("StageInstanceUpdate", intValue = 84, kDoc = "Stage instance details were updated."),
        Entry("StageInstanceDelete", intValue = 85, kDoc = "Stage instance was deleted (stage channel no longer live)."),
        Entry("StickerCreate", intValue = 90, kDoc = "Sticker was created."),
        Entry("StickerUpdate", intValue = 91, kDoc = "Sticker details were updated."),
        Entry("StickerDelete", intValue = 92, kDoc = "Sticker was deleted."),
        Entry("GuildScheduledEventCreate", intValue = 100, kDoc = "Event was created."),
        Entry("GuildScheduledEventUpdate", intValue = 101, kDoc = "Event was updated."),
        Entry("GuildScheduledEventDelete", intValue = 102, kDoc = "Event was cancelled."),
        Entry("ThreadCreate", intValue = 110, kDoc = "Thread was created in a channel."),
        Entry("ThreadUpdate", intValue = 111, kDoc = "Thread was updated."),
        Entry("ThreadDelete", intValue = 112, kDoc = "Thread was deleted."),
        Entry("ApplicationCommandPermissionUpdate", intValue = 121, kDoc = "Permissions were updated for a command."),
        Entry("AutoModerationRuleCreate", intValue = 140, kDoc = "Auto Moderation rule was created."),
        Entry("AutoModerationRuleUpdate", intValue = 141, kDoc = "Auto Moderation rule was updated."),
        Entry("AutoModerationRuleDelete", intValue = 142, kDoc = "Auto Moderation rule was deleted."),
        Entry("AutoModerationBlockMessage", intValue = 143, kDoc = "Message was blocked by Auto Moderation."),
        Entry("AutoModerationFlagToChannel", intValue = 144, kDoc = "Message was flagged by Auto Moderation."),
        Entry("AutoModerationUserCommunicationDisabled", intValue = 145, kDoc = "Member was timed out by Auto Moderation."),
        Entry("CreatorMonetizationRequestCreated", intValue = 150, kDoc = "Creator monetization request was created."),
        Entry("CreatorMonetizationTermsAccepted", intValue = 151, kDoc = "Creator monetization terms were accepted."),
    ],
)

package dev.kord.common.entity

import dev.kord.common.entity.optional.Optional
import dev.kord.common.entity.optional.OptionalSnowflake
import dev.kord.common.entity.optional.orEmpty
import dev.kord.common.serialization.DurationInDaysSerializer
import dev.kord.common.serialization.DurationInSecondsSerializer
import dev.kord.common.serialization.LongOrStringSerializer
import dev.kord.ksp.Generate
import dev.kord.ksp.Generate.EntityType.INT_KORD_ENUM
import dev.kord.ksp.Generate.Entry
import kotlinx.datetime.Instant
import kotlinx.serialization.*
import kotlinx.serialization.builtins.ListSerializer
import kotlinx.serialization.builtins.serializer
import kotlinx.serialization.descriptors.*
import kotlinx.serialization.encoding.*
import kotlinx.serialization.json.Json
import kotlinx.serialization.json.JsonElement
import kotlin.time.Duration
import dev.kord.common.Color as CommonColor
import dev.kord.common.entity.DefaultMessageNotificationLevel as CommonDefaultMessageNotificationLevel
import dev.kord.common.entity.ExplicitContentFilter as CommonExplicitContentFilter
import dev.kord.common.entity.MFALevel as CommonMFALevel
import dev.kord.common.entity.Permissions as CommonPermissions
import dev.kord.common.entity.VerificationLevel as CommonVerificationLevel

@Serializable
public data class DiscordAuditLog(
    val webhooks: List,
    val users: List,
    @SerialName("application_commands")
    val applicationCommands: List,
    @SerialName("audit_log_entries")
    val auditLogEntries: List,
    @SerialName("auto_moderation_rules")
    val autoModerationRules: List,
    val integrations: List,
    val threads: List
)

@Serializable
public data class DiscordAuditLogEntry(
    @SerialName("target_id")
    val targetId: Snowflake?,
    val changes: Optional>> = Optional.Missing(),
    @SerialName("user_id")
    val userId: Snowflake?,
    val id: Snowflake,
    @SerialName("action_type")
    val actionType: AuditLogEvent,
    val options: Optional = Optional.Missing(),
    val reason: Optional = Optional.Missing(),
) {

    @Suppress("UNCHECKED_CAST")
    public operator fun  get(value: AuditLogChangeKey): AuditLogChange? =
        changes.orEmpty().firstOrNull { it.key == value } as? AuditLogChange

}

@Serializable
public data class AuditLogEntryOptionalInfo(
    @SerialName("application_id")
    val applicationId: OptionalSnowflake = OptionalSnowflake.Missing,
    @SerialName("auto_moderation_rule_name")
    val autoModerationRuleName: Optional = Optional.Missing(),
    @SerialName("auto_moderation_rule_trigger_type")
    val autoModerationRuleTriggerType: Optional = Optional.Missing(),
    /*
    Do not trust the docs:
    2020-11-12 field is described as present but is in fact optional
     */
    @SerialName("delete_member_days")
    val deleteMemberDays: Optional = Optional.Missing(),
    /*
    Do not trust the docs:
    2020-11-12 field is described as present but is in fact optional
     */
    @SerialName("members_removed")
    val membersRemoved: Optional = Optional.Missing(),
    /*
    Do not trust the docs:
    2020-11-12 field is described as present but is in fact optional
     */
    @SerialName("channel_id")
    val channelId: OptionalSnowflake = OptionalSnowflake.Missing,
    /*
    Do not trust the docs:
    2020-11-12 field is described as present but is in fact optional
     */
    @SerialName("message_id")
    val messageId: OptionalSnowflake = OptionalSnowflake.Missing,
    /*
    Do not trust the docs:
    2020-11-12 field is described as present but is in fact optional
     */
    val count: Optional = Optional.Missing(),
    /*
    Do not trust the docs:
    2020-11-12 field is described as present but is in fact optional
     */
    val id: OptionalSnowflake = OptionalSnowflake.Missing,
    /*
    Do not trust the docs:
    2020-11-12 field is described as present but is in fact optional
     */
    val type: Optional = Optional.Missing(),
    /*
    Do not trust the docs:
    2020-11-12 field is described as present but is in fact optional
     */
    @SerialName("role_name")
    val roleName: Optional = Optional.Missing(),
    @SerialName("integration_type")
    val integrationType: Optional = Optional.Missing(),
)

@Serializable(with = AuditLogChange.Serializer::class)
public data class AuditLogChange(
    val new: T?,
    val old: T?,
    val key: AuditLogChangeKey,
) {

    internal class Serializer(private val ser: KSerializer) : KSerializer> {
        override val descriptor: SerialDescriptor = buildClassSerialDescriptor("Kord.AuditLogChange", ser.descriptor) {
            element("new_value")
            element("old_value")
            element("key", ser.descriptor)
        }

        override fun deserialize(decoder: Decoder) = decoder.decodeStructure(descriptor) {
            var new: JsonElement? = null
            var old: JsonElement? = null
            lateinit var key: AuditLogChangeKey<*>
            while (true) {
                when (val index = decodeElementIndex(descriptor)) {
                    0 -> new = decodeSerializableElement(descriptor, index, JsonElement.serializer())
                    1 -> old = decodeSerializableElement(descriptor, index, JsonElement.serializer())
                    2 -> key = decodeSerializableElement(
                        descriptor,
                        index,
                        AuditLogChangeKey.Serializer(Unit.serializer())
                    )
                    CompositeDecoder.DECODE_DONE -> break
                    else -> throw SerializationException("unknown index: $index")
                }
            }

            val newVal = new?.let { Json.decodeFromJsonElement(key.serializer, new) }
            val oldVal = old?.let { Json.decodeFromJsonElement(key.serializer, old) }

            @Suppress("UNCHECKED_CAST")
            AuditLogChange(
                new = newVal,
                old = oldVal,
                key = key as AuditLogChangeKey
            ) as AuditLogChange
        }

        @Suppress("UNCHECKED_CAST")
        override fun serialize(encoder: Encoder, value: AuditLogChange) {
            val logChange = value as AuditLogChange
            encoder.encodeStructure(descriptor) {
                encodeSerializableElement(descriptor, 0, logChange.key.serializer, logChange.new as Unit)
                encodeSerializableElement(descriptor, 0, logChange.key.serializer, logChange.old as Unit)
                encodeSerializableElement(descriptor, 0, AuditLogChangeKey.serializer(Unit.serializer()), logChange.key)
            }
        }
    }
}

@Serializable(with = AuditLogChangeKey.Serializer::class)
public sealed class AuditLogChangeKey(public val name: String, public val serializer: KSerializer) {

    override fun toString(): String = "AuditLogChangeKey(name=$name)"

    public class Unknown(name: String) : AuditLogChangeKey(name, JsonElement.serializer())

    @SerialName("name")
    public object Name : AuditLogChangeKey("name", String.serializer())

    @SerialName("icon_hash")
    public object IconHash : AuditLogChangeKey("icon_hash", String.serializer())

    @SerialName("image_hash")
    public object ImageHash : AuditLogChangeKey("image_hash", String.serializer())

    @SerialName("splash_hash")
    public object SplashHash : AuditLogChangeKey("splash_hash", String.serializer())

    @SerialName("owner_id")
    public object OwnerId : AuditLogChangeKey("owner_id", Snowflake.serializer())

    @SerialName("region")
    public object Region : AuditLogChangeKey("region", String.serializer())

    @SerialName("afk_channel_id")
    public object AfkChannelId : AuditLogChangeKey("afk_channel_id", Snowflake.serializer())

    @SerialName("afk_timeout")
    public object AfkTimeout : AuditLogChangeKey("afk_timeout", DurationInSecondsSerializer)

    @SerialName("mfa_level")
    public object MFALevel : AuditLogChangeKey("mfa_level", CommonMFALevel.serializer())

    @SerialName("verification_level")
    public object VerificationLevel :
        AuditLogChangeKey("verification_level", CommonVerificationLevel.serializer())

    @SerialName("explicit_content_filter")
    public object ExplicitContentFilter : AuditLogChangeKey(
        "explicit_content_filter",
        CommonExplicitContentFilter.serializer()
    )

    @SerialName("default_message_notifications")
    public object DefaultMessageNotificationLevel : AuditLogChangeKey(
        "default_message_notifications",
        CommonDefaultMessageNotificationLevel.serializer()
    )

    @SerialName("vanity_url_code")
    public object VanityUrlCode : AuditLogChangeKey("vanity_url_code", String.serializer())

    @SerialName("\$add")
    public object Add :
        AuditLogChangeKey>("\$add", ListSerializer(DiscordPartialRole.serializer()))

    @SerialName("\$remove")
    public object Remove :
        AuditLogChangeKey>("\$remove", ListSerializer(DiscordPartialRole.serializer()))

    @SerialName("prune_delete_days")
    public object PruneDeleteDays : AuditLogChangeKey("prune_delete_days", Int.serializer())

    @SerialName("widget_enabled")
    public object WidgetEnabled : AuditLogChangeKey("widget_enabled", Boolean.serializer())

    @SerialName("widget_channel_id")
    public object WidgetChannelId : AuditLogChangeKey("widget_channel_id", Snowflake.serializer())

    @SerialName("system_channel_id")
    public object SystemChannelId : AuditLogChangeKey("system_channel_id", Snowflake.serializer())

    @SerialName("position")
    public object Position : AuditLogChangeKey("position", Int.serializer())

    @SerialName("topic")
    public object Topic : AuditLogChangeKey("topic", String.serializer())

    @SerialName("bitrate")
    public object Bitrate : AuditLogChangeKey("bitrate", Int.serializer())

    @SerialName("permission_overwrites")
    public object PermissionOverwrites :
        AuditLogChangeKey>("permission_overwrites", ListSerializer(Overwrite.serializer()))

    @SerialName("nsfw")
    public object Nsfw : AuditLogChangeKey("nsfw", Boolean.serializer())

    @SerialName("application_id")
    public object ApplicationId : AuditLogChangeKey("application_id", Snowflake.serializer())

    @SerialName("rate_limit_per_user")
    public object RateLimitPerUser : AuditLogChangeKey("rate_limit_per_user", DurationInSecondsSerializer)

    @SerialName("permissions")
    public object Permissions : AuditLogChangeKey("permissions", CommonPermissions.serializer())

    @SerialName("color")
    public object Color : AuditLogChangeKey("color", CommonColor.serializer())

    @SerialName("command_id")
    public object CommandId : AuditLogChangeKey("command_id", Snowflake.serializer())

    @SerialName("communication_disabled_until")
    public object CommunicationDisabledUntil :
        AuditLogChangeKey("communication_disabled_until", Instant.serializer())

    @SerialName("hoist")
    public object Hoist : AuditLogChangeKey("hoist", Boolean.serializer())

    @SerialName("mentionable")
    public object Mentionable : AuditLogChangeKey("mentionable", Boolean.serializer())

    @SerialName("allow")
    public object Allow : AuditLogChangeKey("allow", CommonPermissions.serializer())

    @SerialName("deny")
    public object Deny : AuditLogChangeKey("deny", CommonPermissions.serializer())

    @SerialName("code")
    public object Code : AuditLogChangeKey("code", String.serializer())

    @SerialName("channel_id")
    public object ChannelId : AuditLogChangeKey("channel_id", Snowflake.serializer())

    @SerialName("inviter_id")
    public object InviterId : AuditLogChangeKey("inviter_id", Snowflake.serializer())

    @SerialName("location")
    public object Location : AuditLogChangeKey("location", String.serializer())

    @SerialName("max_uses")
    public object MaxUses : AuditLogChangeKey("max_uses", Int.serializer())

    @SerialName("uses")
    public object Uses : AuditLogChangeKey("uses", Int.serializer())

    @SerialName("max_age")
    public object MaxAges : AuditLogChangeKey("max_age", DurationInSecondsSerializer)

    @SerialName("temporary")
    public object Temporary : AuditLogChangeKey("temporary", Boolean.serializer())

    @SerialName("deaf")
    public object Deaf : AuditLogChangeKey("deaf", Boolean.serializer())

    @SerialName("mute")
    public object Mute : AuditLogChangeKey("mute", Boolean.serializer())

    @SerialName("nick")
    public object Nick : AuditLogChangeKey("nick", String.serializer())

    @SerialName("avatar_hash")
    public object AvatarHash : AuditLogChangeKey("avatar_hash", String.serializer())

    @SerialName("id")
    public object Id : AuditLogChangeKey("id", Snowflake.serializer())

    /**
     * The actual supertype is [AuditLogChangeKey][AuditLogChangeKey] but Kotlin does not support union
     * types yet. [Long]s are instead converted to a [String].
     */
    // Audit Log Change Key "type" has integer or string values, so we need some sort of union serializer
    // (see https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-audit-log-change-key)
    // TODO use union type `String | Int` if Kotlin ever introduces them
    @SerialName("type")
    public object Type : AuditLogChangeKey("type", LongOrStringSerializer)

    @SerialName("enable_emoticons")
    public object EnableEmoticons : AuditLogChangeKey("enable_emoticons", Boolean.serializer())

    @SerialName("expire_behavior")
    public object ExpireBehavior :
        AuditLogChangeKey("expire_behavior", IntegrationExpireBehavior.serializer())

    @SerialName("expire_grace_period")
    public object ExpireGracePeriod : AuditLogChangeKey("expire_grace_period", DurationInDaysSerializer)

    @SerialName("user_limit")
    public object UserLimit : AuditLogChangeKey("user_limit", Int.serializer())

    @SerialName("archived")
    public object Archived : AuditLogChangeKey("archived", Boolean.serializer())

    @SerialName("locked")
    public object Locked : AuditLogChangeKey("locked", Boolean.serializer())

    @SerialName("auto_archive_duration")
    public object AutoArchiveDuration :
        AuditLogChangeKey("auto_archive_duration", ArchiveDuration.serializer())

    @SerialName("default_auto_archive_duration")
    public object DefaultAutoArchiveDuration :
        AuditLogChangeKey("default_auto_archive_duration", ArchiveDuration.serializer())

    @SerialName("entity_type")
    public object EntityType : AuditLogChangeKey("entity_type", ScheduledEntityType.serializer())

    @SerialName("status")
    public object Status :
        AuditLogChangeKey("status", GuildScheduledEventStatus.serializer())

    @SerialName("sku_ids")
    public object SkuIds : AuditLogChangeKey>("sku_ids", ListSerializer(Snowflake.serializer()))

    internal class Serializer(val type: KSerializer) : KSerializer> {
        override val descriptor: SerialDescriptor
            get() = PrimitiveSerialDescriptor("Kord.AuditLogKey", PrimitiveKind.STRING)

        override fun serialize(encoder: Encoder, value: AuditLogChangeKey) {
            encoder.encodeString(value.name)
        }

        @Suppress("UNCHECKED_CAST")
        override fun deserialize(decoder: Decoder): AuditLogChangeKey {
            val name = decoder.decodeString()
            return when (name) {
                "name" -> Name
                "icon_hash" -> IconHash
                "image_hash" -> ImageHash
                "splash_hash" -> SplashHash
                "owner_id" -> OwnerId
                "region" -> Region
                "afk_channel_id" -> AfkChannelId
                "afk_timeout" -> AfkTimeout
                "mfa_level" -> MFALevel
                "verification_level" -> VerificationLevel
                "explicit_content_filter" -> ExplicitContentFilter
                "default_message_notifications" -> DefaultMessageNotificationLevel
                "vanity_url_code" -> VanityUrlCode
                "\$add" -> Add
                "\$remove" -> Remove
                "prune_delete_days" -> PruneDeleteDays
                "widget_enabled" -> WidgetEnabled
                "widget_channel_id" -> WidgetChannelId
                "system_channel_id" -> SystemChannelId
                "position" -> Position
                "topic" -> Topic
                "bitrate" -> Bitrate
                "permission_overwrites" -> PermissionOverwrites
                "nsfw" -> Nsfw
                "application_id" -> ApplicationId
                "rate_limit_per_user" -> RateLimitPerUser
                "permissions" -> Permissions
                "color" -> Color
                "command_id" -> CommandId
                "communication_disabled_until" -> CommunicationDisabledUntil
                "hoist" -> Hoist
                "mentionable" -> Mentionable
                "allow" -> Allow
                "deny" -> Deny
                "code" -> Code
                "channel_id" -> ChannelId
                "inviter_id" -> InviterId
                "location" -> Location
                "max_uses" -> MaxUses
                "uses" -> Uses
                "max_age" -> MaxAges
                "temporary" -> Temporary
                "deaf" -> Deaf
                "mute" -> Mute
                "nick" -> Nick
                "avatar_hash" -> AvatarHash
                "id" -> Id
                "type" -> Type
                "enable_emoticons" -> EnableEmoticons
                "expire_behavior" -> ExpireBehavior
                "expire_grace_period" -> ExpireGracePeriod
                "user_limit" -> UserLimit
                "locked" -> Locked
                "archived" -> Archived
                "auto_archive_duration" -> AutoArchiveDuration
                "default_auto_archive_duration" -> DefaultAutoArchiveDuration
                "entity_type" -> EntityType
                "status" -> Status
                "sku_ids" -> SkuIds
                else -> Unknown(name)
            } as AuditLogChangeKey
        }
    }
}