@velliajs/discord 1.0.3 → 1.0.4

package/src/structures/GuildAuditLogs.js

@@ -7,18 +7,12 @@ const Integration = require('./Integration');
 const Webhook = require('./Webhook');
 const { flatten } = require('../util/Util');
 
-/**
- * Audit logs entries are held in this class.
- */
+
 class GuildAuditLogs {
   constructor(guild, data) {
     if (data.users) for (const user of data.users) guild.client.users._add(user);
     if (data.threads) for (const thread of data.threads) guild.client.channels._add(thread, guild);
-    /**
-     * Cached webhooks
-     * @type {Collection<Snowflake, Webhook>}
-     * @private
-     */
+    
     this.webhooks = new Collection();
     if (data.webhooks) {
       for (const hook of data.webhooks) {
@@ -26,11 +20,7 @@ class GuildAuditLogs {
       }
     }
 
-    /**
-     * Cached integrations
-     * @type {Collection<Snowflake|string, Integration>}
-     * @private
-     */
+    
     this.integrations = new Collection();
     if (data.integrations) {
       for (const integration of data.integrations) {
@@ -38,22 +28,14 @@ class GuildAuditLogs {
       }
     }
 
-    /**
-     * Cached {@link GuildScheduledEvent}s.
-     * @type {Collection<Snowflake, GuildScheduledEvent>}
-     * @private
-     */
+    
     this.guildScheduledEvents = data.guild_scheduled_events.reduce(
       (guildScheduledEvents, guildScheduledEvent) =>
         guildScheduledEvents.set(guildScheduledEvent.id, guild.scheduledEvents._add(guildScheduledEvent)),
       new Collection(),
     );
 
-    /**
-     * Cached application commands, includes application commands from other applications
-     * @type {Collection<Snowflake, ApplicationCommand>}
-     * @private
-     */
+    
     this.applicationCommands = new Collection();
     if (data.application_commands) {
       for (const command of data.application_commands) {
@@ -61,21 +43,14 @@ class GuildAuditLogs {
       }
     }
 
-    /**
-     * Cached auto moderation rules.
-     * @type {Collection<Snowflake, AutoModerationRule>}
-     * @private
-     */
+    
     this.autoModerationRules = data.auto_moderation_rules.reduce(
       (autoModerationRules, autoModerationRule) =>
         autoModerationRules.set(autoModerationRule.id, guild.autoModerationRules._add(autoModerationRule)),
       new Collection(),
     );
 
-    /**
-     * The entries for this guild's audit logs
-     * @type {Collection<Snowflake, GuildAuditLogsEntry>}
-     */
+    
     this.entries = new Collection();
     for (const item of data.audit_log_entries) {
       const entry = new GuildAuditLogsEntry(guild, item, this);

package/src/structures/GuildAuditLogsEntry.js

@@ -32,136 +32,50 @@ const Targets = {
   Unknown: 'Unknown',
 };
 
-/**
- * The target of a guild audit log entry. It can be one of:
- * * A guild
- * * A channel
- * * A user
- * * A role
- * * An invite
- * * A webhook
- * * An emoji
- * * A message
- * * An integration
- * * A stage instance
- * * A sticker
- * * A guild scheduled event
- * * A thread
- * * An application command
- * * An auto moderation rule
- * * An object with an id key if target was deleted or fake entity
- * * An object where the keys represent either the new value or the old value
- * @typedef {?(Object|Guild|BaseChannel|User|Role|Invite|Webhook|GuildEmoji|Message|Integration|StageInstance|Sticker|
- * GuildScheduledEvent|ApplicationCommand|AutoModerationRule)} AuditLogEntryTarget
- */
-
-/**
- * The action type of an entry, e.g. `Create`. Here are the available types:
- * * Create
- * * Delete
- * * Update
- * * All
- * @typedef {string} AuditLogActionType
- */
-
-/**
- * The target type of an entry. Here are the available types:
- * * Guild
- * * Channel
- * * User
- * * Role
- * * Invite
- * * Webhook
- * * Emoji
- * * Message
- * * Integration
- * * StageInstance
- * * Sticker
- * * Thread
- * * GuildScheduledEvent
- * * ApplicationCommandPermission
- * @typedef {string} AuditLogTargetType
- */
-
-/**
- * Audit logs entry.
- */
+
+
+
+
+
+
+
 class GuildAuditLogsEntry {
-  /**
-   * Key mirror of all available audit log targets.
-   * @type {Object<string, string>}
-   * @memberof GuildAuditLogsEntry
-   */
+  
   static Targets = Targets;
 
   constructor(guild, data, logs) {
-    /**
-     * The target type of this entry
-     * @type {AuditLogTargetType}
-     */
+    
     this.targetType = GuildAuditLogsEntry.targetType(data.action_type);
     const targetType = this.targetType;
 
-    /**
-     * The action type of this entry
-     * @type {AuditLogActionType}
-     */
+    
     this.actionType = GuildAuditLogsEntry.actionType(data.action_type);
 
-    /**
-     * The type of action that occurred.
-     * @type {AuditLogEvent}
-     */
+    
     this.action = data.action_type;
 
-    /**
-     * The reason of this entry
-     * @type {?string}
-     */
+    
     this.reason = data.reason ?? null;
 
-    /**
-     * The id of the user that executed this entry
-     * @type {?Snowflake}
-     */
+    
     this.executorId = data.user_id;
 
-    /**
-     * The user that executed this entry
-     * @type {?User}
-     */
+    
     this.executor = data.user_id
       ? guild.client.options.partials.includes(Partials.User)
         ? guild.client.users._add({ id: data.user_id })
         : guild.client.users.cache.get(data.user_id) ?? null
       : null;
 
-    /**
-     * An entry in the audit log representing a specific change.
-     * @typedef {Object} AuditLogChange
-     * @property {string} key The property that was changed, e.g. `nick` for nickname changes
-     * <warn>For application command permissions updates the key is the id of the user, channel,
-     * role, or a permission constant that was updated instead of an actual property name</warn>
-     * @property {*} [old] The old value of the change, e.g. for nicknames, the old nickname
-     * @property {*} [new] The new value of the change, e.g. for nicknames, the new nickname
-     */
-
-    /**
-     * Specific property changes
-     * @type {AuditLogChange[]}
-     */
+    
+
+    
     this.changes = data.changes?.map(c => ({ key: c.key, old: c.old_value, new: c.new_value })) ?? [];
 
-    /**
-     * The entry's id
-     * @type {Snowflake}
-     */
+    
     this.id = data.id;
 
-    /**
-     * Any extra data from the entry
-     * @type {?(Object|Role|GuildMember)}
-     */
+    
     this.extra = null;
     switch (data.action_type) {
       case AuditLogEvent.MemberPrune:
@@ -245,16 +159,10 @@ class GuildAuditLogsEntry {
         break;
     }
 
-    /**
-     * The id of the target of this entry
-     * @type {?Snowflake}
-     */
+    
     this.targetId = data.target_id;
 
-    /**
-     * The target of this entry
-     * @type {?AuditLogEntryTarget}
-     */
+    
     this.target = null;
     if (targetType === Targets.Unknown) {
       this.target = this.changes.reduce((o, c) => {
@@ -262,7 +170,7 @@ class GuildAuditLogsEntry {
         return o;
       }, {});
       this.target.id = data.target_id;
-      // MemberDisconnect and similar types do not provide a target_id.
+      
     } else if (targetType === Targets.User && data.target_id) {
       this.target = guild.client.options.partials.includes(Partials.User)
         ? guild.client.users._add({ id: data.target_id })
@@ -302,7 +210,7 @@ class GuildAuditLogsEntry {
           ),
         );
     } else if (targetType === Targets.Message) {
-      // Discord sends a channel id for the MessageBulkDelete action type.
+      
       this.target =
         data.action_type === AuditLogEvent.MessageBulkDelete
           ? guild.channels.cache.get(data.target_id) ?? { id: data.target_id }
@@ -395,11 +303,7 @@ class GuildAuditLogsEntry {
     }
   }
 
-  /**
-   * Finds the target type of a guild audit log entry.
-   * @param {AuditLogEvent} target The action target
-   * @returns {AuditLogTargetType}
-   */
+  
   static targetType(target) {
     if (target < 10) return Targets.Guild;
     if (target < 20) return Targets.Channel;
@@ -419,11 +323,7 @@ class GuildAuditLogsEntry {
     return Targets.Unknown;
   }
 
-  /**
-   * Finds the action type from the guild audit log entry action.
-   * @param {AuditLogEvent} action The action target
-   * @returns {AuditLogActionType}
-   */
+  
   static actionType(action) {
     if (
       [
@@ -501,20 +401,12 @@ class GuildAuditLogsEntry {
     return 'All';
   }
 
-  /**
-   * The timestamp this entry was created at
-   * @type {number}
-   * @readonly
-   */
+  
   get createdTimestamp() {
     return DiscordSnowflake.timestampFrom(this.id);
   }
 
-  /**
-   * The time this entry was created at
-   * @type {Date}
-   * @readonly
-   */
+  
   get createdAt() {
     return new Date(this.createdTimestamp);
   }

package/src/structures/GuildBan.js

@@ -2,18 +2,12 @@
 
 const Base = require('./Base');
 
-/**
- * Represents a ban in a guild on Discord.
- * @extends {Base}
- */
+
 class GuildBan extends Base {
   constructor(client, data, guild) {
     super(client);
 
-    /**
-     * The guild in which the ban is
-     * @type {Guild}
-     */
+    
     this.guild = guild;
 
     this._patch(data);
@@ -21,36 +15,22 @@ class GuildBan extends Base {
 
   _patch(data) {
     if ('user' in data) {
-      /**
-       * The user this ban applies to
-       * @type {User}
-       */
+      
       this.user = this.client.users._add(data.user, true);
     }
 
     if ('reason' in data) {
-      /**
-       * The reason for the ban
-       * @type {?string}
-       */
+      
       this.reason = data.reason;
     }
   }
 
-  /**
-   * Whether this GuildBan is partial. If the reason is not provided the value is null
-   * @type {boolean}
-   * @readonly
-   */
+  
   get partial() {
     return !('reason' in this);
   }
 
-  /**
-   * Fetches this GuildBan.
-   * @param {boolean} [force=true] Whether to skip the cache check and request the API
-   * @returns {Promise<GuildBan>}
-   */
+  
   fetch(force = true) {
     return this.guild.bans.fetch({ user: this.user, cache: true, force });
   }