Added missing models implementations, documentations, and bitset getters

Author: MeixDev

example/lib/main.dart

@@ -75,7 +75,7 @@ class _MyHomePageState extends State<MyHomePage> {
       ),
     ).then((_) {
       if (_discordClient.discordHttpClient.discordToken != null) {
-        print(
+        debugPrint(
             "TOKEN: ${_discordClient.discordHttpClient.discordToken?.accessToken}");
         return _discordClient.discordHttpClient.discordToken;
       }

example/pubspec.lock

@@ -136,7 +136,7 @@ packages:
       name: path
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.8.0"
+    version: "1.8.1"
   sky_engine:
     dependency: transitive
     description: flutter
@@ -183,7 +183,7 @@ packages:
       name: test_api
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.4.8"
+    version: "0.4.9"
   typed_data:
     dependency: transitive
     description:

lib/src/models/discord_activity.dart

@@ -126,10 +126,17 @@ class DiscordActivity {
   DiscordActivityType get typeAsEnum =>
       _typeAsEnum ??= DiscordActivityType.values[type];
 
-// TODO: RECOVER FLAGS FROM BITSET IN DISCORD ACTIVITY
-
-//  List<DiscordActivityFlag>? get flagsAsEnum =>
-//      _flagsAsEnum ??= DiscordActivityFlag.valuesFromMask(flags);
+  List<DiscordActivityFlag>? get flagsAsEnum {
+    if (_flagsAsEnum != null) return _flagsAsEnum!;
+    if (flags == null) return _flagsAsEnum ??= [];
+    _flagsAsEnum = <DiscordActivityFlag>[];
+    for (final k in DiscordActivityFlag.values) {
+      if ((flags! & (1 << k.index)) >> k.index == 1) {
+        _flagsAsEnum!.add(k);
+      }
+    }
+    return _flagsAsEnum!;
+  }
 
   factory DiscordActivity.fromJson(Map<String, dynamic> json) =>
       DiscordActivity(

lib/src/models/discord_attachment.dart

@@ -1,16 +1,34 @@
 import 'discord_snowflake.dart';
 
-// TODO: Add Documentation
 class DiscordAttachment {
+  /// attachment id
   final DiscordSnowflake id;
+
+  /// name of file attached
   final String filename;
+
+  /// description for the file
   final String? description;
+
+  /// the attachment's [media type](https://en.wikipedia.org/wiki/Media_type)
   final String? contentType;
+
+  /// size of file in bytes
   final int size;
+
+  /// source url of file
   final String url;
+
+  /// a proxied url of file
   final String proxyUrl;
+
+  /// height of file (if image)
   final int? height;
+
+  /// width of file (if image)
   final int? width;
+
+  /// whether this attachment is ephemeral
   final bool? ephemeral;
 
   static const idEntry = 'id';

lib/src/models/discord_audit_log.dart

@@ -47,46 +47,23 @@ class DiscordAuditLog {
   factory DiscordAuditLog.fromJson(Map<String, dynamic> json) =>
       DiscordAuditLog(
         auditLogEntries: List<DiscordAuditLogEntry>.from(
-          json[auditLogEntriesEntry].map(
-            (x) => DiscordAuditLogEntry.fromJson(
-              x as Map<String, dynamic>,
-            ),
-          ),
+          json[auditLogEntriesEntry].map(DiscordAuditLogEntry.fromJson),
         ),
         guildScheduledEvents: List<DiscordGuildScheduledEvent>.from(
-          json[guildScheduledEventsEntry].map(
-            (x) => DiscordGuildScheduledEvent.fromJson(
-              x as Map<String, dynamic>,
-            ),
-          ),
+          json[guildScheduledEventsEntry]
+              .map(DiscordGuildScheduledEvent.fromJson),
         ),
         integrations: List<DiscordIntegration>.from(
-          json[integrationsEntry].map(
-            (x) => DiscordIntegration.fromJson(
-              x as Map<String, dynamic>,
-            ),
-          ),
+          json[integrationsEntry].map(DiscordIntegration.fromJson),
         ),
         threads: List<DiscordChannel>.from(
-          json[threadsEntry].map(
-            (x) => DiscordChannel.fromJson(
-              x as Map<String, dynamic>,
-            ),
-          ),
+          json[threadsEntry].map(DiscordChannel.fromJson),
         ),
         users: List<DiscordUser>.from(
-          json[usersEntry].map(
-            (x) => DiscordUser.fromJson(
-              x as Map<String, dynamic>,
-            ),
-          ),
+          json[usersEntry].map(DiscordUser.fromJson),
         ),
         webhooks: List<DiscordWebhook>.from(
-          json[webhooksEntry].map(
-            (x) => DiscordWebhook.fromJson(
-              x as Map<String, dynamic>,
-            ),
-          ),
+          json[webhooksEntry].map(DiscordWebhook.fromJson),
         ),
       );
 }

lib/src/models/discord_authorization_information.dart

@@ -33,11 +33,12 @@ class DiscordAuthorizationInformation {
 
   factory DiscordAuthorizationInformation.fromJson(Map<String, dynamic> json) =>
       DiscordAuthorizationInformation(
-        application: DiscordApplication.fromJson(json[applicationEntry]),
-        scopes: List<String>.from(json[scopesEntry]),
-        expiresAt: DateTime.parse(json[expiresEntry]),
+        application: DiscordApplication.fromJson(
+            json[applicationEntry] as Map<String, dynamic>),
+        scopes: List<String>.from(json[scopesEntry] as List<String>),
+        expiresAt: DateTime.parse(json[expiresEntry] as String),
         user: json[userEntry] != null
-            ? DiscordUser.fromJson(json[userEntry])
+            ? DiscordUser.fromJson(json[userEntry] as Map<String, dynamic>)
             : null,
       );
 }

lib/src/models/discord_ban.dart

@@ -1,4 +1,24 @@
+import 'discord_user.dart';
+
 class DiscordBan {
-  // TODO: Implement!
-  // https://discord.com/developers/docs/resources/guild#ban-object
+  // the reason for the ban
+  final String? reason;
+
+  /// the banned user
+  final DiscordUser user;
+
+  static const reasonEntry = 'reason';
+  static const userEntry = 'user';
+
+  DiscordBan({
+    this.reason,
+    required this.user,
+  });
+
+  factory DiscordBan.fromJson(Map<String, dynamic> json) {
+    return DiscordBan(
+      reason: json[reasonEntry] as String?,
+      user: DiscordUser.fromJson(json[userEntry] as Map<String, dynamic>),
+    );
+  }
 }

lib/src/models/discord_channel.dart

@@ -6,35 +6,96 @@ import 'discord_thread_metadata.dart';
 import 'discord_user.dart';
 import 'discord_video_quality_mode.dart';
 
-/// TODO: Add Documentation
 class DiscordChannel {
+  /// the id of this channel
   final DiscordSnowflake id;
+
+  /// the [type of channel](https://discord.com/developers/docs/resources/channel#channel-object-channel-types)
   final int type;
+
   late final DiscordChannelType? _typeAsEnum;
+
+  /// the id of the guild (may be missing for some channel objects received over gateway guild dispatches)
   final DiscordSnowflake? guildId;
+
+  /// sorting position of the channel
   final int? position;
+
+  /// explicit permission overewrites for members and roles
   final List<DiscordOverwrite>? permissionOverwrites;
+
+  /// the name of the channel (1-100 characters)
   final String? name;
+
+  /// the channel topic (0-1024 characters)
   final String? topic;
+
+  /// whether the channel is nsfw
   final bool? nsfw;
+
+  /// the id of the last message sent in this channel (may not point to an existing or valid message)
   final DiscordSnowflake? lastMessageId;
+
+  /// the bitrate (in bits) of the voice channel
   final int? bitrate;
+
+  /// the user limit of the voice channel
   final int? userLimit;
+
+  /// amount of seconds a user has to wait before sending another message (0-21600);
+  /// bots, as well as users with the permission `manage_messages` or `manage_channel`, are unaffected
   final int? rateLimitPerUser;
+
+  /// the recipients of the DM
   final List<DiscordUser>? recipients;
+
+  /// icon hash of the group DM
   final String? icon;
+
+  /// id of the creator of the group DM or thread
   final DiscordSnowflake? ownerId;
+
+  /// application id of the group DM creator if it is bot-created
+  final DiscordSnowflake? applicationId;
+
+  /// for guild channels: id of the parent category for a channel (each parent category can contain up
+  /// to 50 channels), for threads: id of the text channel this thread was created
   final DiscordSnowflake? parentId;
+
+  ///	when the last pinned message was pinned. This may be null in events such as
+  /// GUILD_CREATE when a message is not pinned.
   final String? lastPinTimestamp;
+
   late final DateTime? _lastPinTimestampAsDateTime;
-  final String? rtcRegion; // Id of a voice region
+
+  /// [voice region](https://discord.com/developers/docs/resources/voice#voice-region-object)
+  /// id for the voice channel, automatic when set to null
+  final String? rtcRegion;
+
+  ///	the camera [video quality mode](https://discord.com/developers/docs/resources/channel#channel-object-video-quality-modes)
+  /// of the voice channel, 1 when not present
   final int? videoQualityMode;
+
   late final DiscordVideoQualityMode? _videoQualityModeAsEnum;
-  final int? messageCount; // approximative + caps at 50
-  final int? memberCount; // approximative + caps at 50
+
+  ///	an approximate count of messages in a thread, stops counting at 50
+  final int? messageCount;
+
+  /// an approximate count of users in a thread, stops counting at 50
+  final int? memberCount;
+
+  /// thread-specific fields not needed by other channels
   final DiscordThreadMetadata? threadMetadata;
+
+  ///	thread member object for the current user, if they have joined the thread, only included on certain API endpoints
   final DiscordThreadMember? member;
+
+  ///	default duration that the clients (not the API) will use for newly created threads, in minutes,
+  /// to automatically archive the thread after recent activity, can be set to: 60, 1440, 4320, 10080
   final int? defaultAutoArchiveDuration;
+
+  ///	computed permissions for the invoking user in the channel, including overwrites, only included
+  /// when part of the `resolved` data received on a slash command interaction
   final String? permissions;
 
   static const idEntry = 'id';
@@ -52,6 +113,7 @@ class DiscordChannel {
   static const recipientsEntry = 'recipients';
   static const iconEntry = 'icon';
   static const ownerIdEntry = 'owner_id';
+  static const applicationIdEntry = 'application_id';
   static const parentIdEntry = 'parent_id';
   static const lastPinTimestampEntry = 'last_pin_timestamp';
   static const rtcRegionEntry = 'rtc_region';
@@ -80,6 +142,7 @@ class DiscordChannel {
     this.recipients,
     this.icon,
     this.ownerId,
+    this.applicationId,
     this.parentId,
     this.lastPinTimestamp,
     this.rtcRegion,
@@ -135,6 +198,9 @@ class DiscordChannel {
         ownerId: json[ownerIdEntry] != null
             ? DiscordSnowflake(json[ownerIdEntry] as String)
             : null,
+        applicationId: json[applicationIdEntry] != null
+            ? DiscordSnowflake(json[applicationIdEntry] as String)
+            : null,
         parentId: json[parentIdEntry] != null
             ? DiscordSnowflake(json[parentIdEntry] as String)
             : null,

lib/src/models/discord_channel_type.dart

@@ -1,17 +1,46 @@
-// TODO: Add Documentation
 enum DiscordChannelType {
+  /// a text channel within a server
   guildText,
+
+  /// a direct message between users
   dm,
+
+  /// a voice channel within a server
   guildVoice,
+
+  /// a direct message between multiple users
   groupDm,
+
+  /// an [organizational category](https://support.discord.com/hc/en-us/articles/115001580171-Channel-Categories-101)
+  /// that contains up to 50 channels
   guildCategory,
+
+  /// a channel that [users can follow and crosspost into their own server](https://support.discord.com/hc/en-us/articles/360032008192)
   guildNews,
+
+  /// a channel in which game developers can [sell their game on Discord]()
   guildStore,
+
   unused7,
   unused8,
   unused9,
+
+  /// a temporary sub-channel within a GUILD_NEWS channel
+  ///
+  /// only available in API v9
   guildNewsThread,
+
+  /// a temporary sub-channel within a GUILD_TEXT channel
+  ///
+  /// only available in API v9
   guildPublicThread,
+
+  /// a temporary sub-channel within a GUILD_TEXT channel that is only viewable
+  /// by those invited and those with the MANAGE_THREADS permission
+  ///
+  /// only available in API v9
   guildPrivateThread,
+
+  /// a voice channel for [hosting events with an audience](https://support.discord.com/hc/en-us/articles/1500005513722)
   guildStageVoice,
 }