-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
44 changed files
with
1,031 additions
and
164 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,56 +1,40 @@ | ||
| # nyxx_extensions | ||
|
|
||
| [](https://discord.gg/nyxx) | ||
| [](https://pub.dartlang.org/packages/nyxx_extensions) | ||
| [](https://www.dartdocs.org/documentation/nyxx_extensions/latest/) | ||
| [](https://discord.gg/nyxx) | ||
| [](https://pub.dev/packages/nyxx_extensions) | ||
| [](https://pub.dev/documentation/nyxx_extensions/latest/) | ||
|
|
||
| Simple, robust framework for creating discord bots for Dart language. | ||
| Additional utilities and helpers for working with [nyxx](https://pub.dev/packages/nyxx). | ||
|
|
||
| <hr /> | ||
| While the main [nyxx](https://pub.dev/packages/nyxx) package focuses on providing a wrapper only for the features described in [Discord's developer documentation](https://discord.com/developers/docs/intro), this package contains a collection of commonly used functions and plugins when making Discord bots, such as [pagination](https://pub.dev/documentation/nyxx_extensions/latest/nyxx_extensions/Pagination-class.html), [sanitization](https://pub.dev/documentation/nyxx_extensions/latest/nyxx_extensions/sanitizeContent.html) or [endpoint pagination](https://pub.dev/documentation/nyxx_extensions/latest/search.html?q=stream). | ||
|
|
||
| ### Features | ||
|
|
||
| Additional extensions and subpackages to ease out developing bots in nyxx framework. | ||
| This package is very open to contributions as it is built upon the needs of developers using [nyxx](https://pub.dev/packages/nyxx). If you find yourself implementing a feature that isn't specific to your bot, please consider [opening a pull request](https://github.com/nyxx-discord/nyxx_extensions/pulls) and add your code to this package. Read our [contribution document](https://github.com/nyxx-discord/nyxx_extensions/blob/dev/CONTRIBUTING.md) for more information. | ||
|
|
||
| ## Other nyxx packages | ||
|
|
||
| - [nyxx](https://github.com/nyxx-discord/nyxx) | ||
| - [nyxx_interactions](https://github.com/nyxx-discord/nyxx_interactions) | ||
| - [nyxx_commander](https://github.com/nyxx-discord/nyxx_commander) | ||
| - [nyxx_lavalink](https://github.com/nyxx-discord/nyxx_lavalink) | ||
| - [nyxx_pagination](https://github.com/nyxx-discord/nyxx_pagination) | ||
|
|
||
| ## More examples | ||
|
|
||
| Nyxx examples can be found [here](https://github.com/nyxx-discord/nyxx_extensions/tree/dev/example). | ||
| - [nyxx](https://pub.dev/packages/nyxx): The main package wrapping Discord's developer API. | ||
| - [nyxx_commands](https://pub.dev/packages/nyxx_commands): A command framework for handling both simple & complex commands. | ||
| - [nyxx_lavalink](https://pub.dev/packages/nyxx_lavalink): Lavalink support for playing audio in voice channels. | ||
|
|
||
| ### Example bots | ||
| - [Running on Dart](https://github.com/l7ssha/running_on_dart) | ||
| ## Additional documentation & help | ||
|
|
||
| ## Documentation, help and examples | ||
| The API documentation for the latest stable version can be found on [pub](https://pub.dev/documentation/nyxx). | ||
|
|
||
| **Dartdoc documentation for latest stable version is hosted on [pub](https://www.dartdocs.org/documentation/nyxx_extensions/latest/)** | ||
| ### [Docs and wiki](https://nyxx.l7ssha.xyz) | ||
| Tutorials and wiki articles are hosted here, as well as API documentation for development versions from GitHub. | ||
|
|
||
| #### [Docs and wiki](https://nyxx.l7ssha.xyz) | ||
| You can read docs and wiki articles for latest stable version on my website. This website also hosts docs for latest | ||
| dev changes to framework (`dev` branch) | ||
| ### [Official nyxx Discord server](https://discord.gg/nyxx) | ||
| Our Discord server is where you can get help for any nyxx packages, as well as release announcements and discussions about the library. | ||
|
|
||
| #### [Official nyxx discord server](https://discord.gg/nyxx) | ||
| If you need assistance in developing bot using nyxx you can join official nyxx discord guild. | ||
| ### [Discord API docs](https://discord.dev/) | ||
| Discord's API documentation details what nyxx implements & provides more detailed explanations of certain topics. | ||
|
|
||
| #### [Discord API docs](https://discordapp.com/developers/docs/intro) | ||
| Discord API documentation features rich descriptions about all topics that nyxx covers. | ||
|
|
||
| #### [Discord API Guild](https://discord.gg/discord-api) | ||
| ### [Discord API Server](https://discord.gg/discord-api) | ||
| The unofficial guild for Discord Bot developers. To get help with nyxx check `#dart_nyxx` channel. | ||
|
|
||
| #### [Dartdocs](https://www.dartdocs.org/documentation/nyxx_extensions/latest/) | ||
| ### [Pub.dev docs](https://pub.dev/documentation/nyxx) | ||
| The dartdocs page will always have the documentation for the latest release. | ||
|
|
||
| ## Contributing to Nyxx | ||
|
|
||
| Read [contributing document](https://github.com/nyxx-discord/nyxx_extensions/blob/dev/CONTRIBUTING.md) | ||
|
|
||
| ## Credits | ||
|
|
||
| * [Hackzzila's](https://github.com/Hackzzila) for [nyx](https://github.com/Hackzzila/nyx). | ||
| Read the [contributing document](https://github.com/nyxx-discord/nyxx/blob/dev/CONTRIBUTING.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,34 @@ | ||
| /// Extensions and additional utilities for working with [nyxx](https://pub.dev/packages/nyxx). | ||
| library nyxx_extensions; | ||
|
|
||
| export 'src/channel.dart'; | ||
| export 'src/date_time.dart'; | ||
| export 'src/embed_builder.dart'; | ||
| export 'src/emoji.dart'; | ||
| export 'src/guild.dart'; | ||
| export 'src/message.dart'; | ||
| export 'src/pagination.dart'; | ||
| export 'src/role.dart'; | ||
| export 'src/sanitizer.dart'; | ||
| export 'src/user.dart'; | ||
| export 'src/utils/emoji.dart'; | ||
| export 'src/utils/endpoint_paginator.dart' hide streamPaginatedEndpoint; | ||
| export 'src/utils/formatters.dart'; | ||
| export 'src/utils/guild_joins.dart'; | ||
| export 'src/utils/pagination.dart'; | ||
| export 'src/utils/permissions.dart'; | ||
| export 'src/utils/sanitizer.dart'; | ||
|
|
||
| export 'src/extensions/cdn_asset.dart' hide getRequest; | ||
| export 'src/extensions/channel.dart'; | ||
| export 'src/extensions/client.dart'; | ||
| export 'src/extensions/date_time.dart'; | ||
| export 'src/extensions/embed.dart'; | ||
| export 'src/extensions/emoji.dart'; | ||
| export 'src/extensions/guild.dart'; | ||
| export 'src/extensions/managers/audit_log_manager.dart'; | ||
| export 'src/extensions/managers/channel_manager.dart'; | ||
| export 'src/extensions/managers/entitlement_manager.dart'; | ||
| export 'src/extensions/managers/guild_manager.dart'; | ||
| export 'src/extensions/managers/member_manager.dart'; | ||
| export 'src/extensions/managers/message_manager.dart'; | ||
| export 'src/extensions/managers/scheduled_event_manager.dart'; | ||
| export 'src/extensions/managers/user_manager.dart'; | ||
| export 'src/extensions/member.dart'; | ||
| export 'src/extensions/message.dart'; | ||
| export 'src/extensions/role.dart'; | ||
| export 'src/extensions/scheduled_event.dart'; | ||
| export 'src/extensions/snowflake_entity.dart'; | ||
| export 'src/extensions/user.dart'; | ||
| export 'src/extensions/list.dart'; | ||
| export 'src/extensions/application.dart'; |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| import 'package:nyxx/nyxx.dart'; | ||
|
|
||
| /// Extensions on [PartialApplication]s. | ||
| extension ApplicationExtensions on PartialApplication { | ||
| /// Get a URL users can visit to add this bot to a guild. | ||
| Uri getInviteUri({ | ||
| List<String> scopes = const ['bot', 'application.commands'], | ||
| Flags<Permissions>? permissions, | ||
| Snowflake? guildId, | ||
| bool? disableGuildSelect, | ||
| }) => | ||
| Uri.https( | ||
| 'discord.com', | ||
| '/oauth2/authorize', | ||
| { | ||
| 'client_id': id.toString(), | ||
| 'scope': scopes.join(' '), | ||
| if (permissions != null) 'permissions': permissions.value.toString(), | ||
| if (guildId != null) 'guild_id': guildId.toString(), | ||
| if (disableGuildSelect != null) 'disable_guild_select': disableGuildSelect, | ||
| }, | ||
| ); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| import 'package:nyxx/nyxx.dart'; | ||
|
|
||
| extension CdnAssetExtensions on CdnAsset { | ||
| Uri get({CdnFormat? format, int? size}) => getRequest(this, format ?? defaultFormat, size).prepare(client).url; | ||
| } | ||
|
|
||
| // Re-implementing the private method from CdnAsset | ||
| CdnRequest getRequest(CdnAsset asset, CdnFormat format, int? size) { | ||
| final route = HttpRoute(); | ||
|
|
||
| for (final part in asset.base.parts) { | ||
| route.add(part); | ||
| } | ||
| route.add(HttpRoutePart('${asset.hash}.${format.extension}')); | ||
|
|
||
| return CdnRequest( | ||
| route, | ||
| queryParameters: { | ||
| if (size != null) 'size': size.toString(), | ||
| }, | ||
| ); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| import 'package:nyxx/nyxx.dart'; | ||
| import 'package:nyxx_extensions/src/extensions/guild.dart'; | ||
| import 'package:nyxx_extensions/src/extensions/managers/channel_manager.dart'; | ||
| import 'package:nyxx_extensions/src/utils/formatters.dart'; | ||
| import 'package:nyxx_extensions/src/utils/permissions.dart'; | ||
|
|
||
| /// Extensions on [PartialChannel]s. | ||
| extension PartialChannelExtensions on PartialChannel { | ||
| /// A mention of this channel. | ||
| String get mention => channelMention(id); | ||
| } | ||
|
|
||
| /// Extensions on [Channel]s. | ||
| extension ChannelExtensions on Channel { | ||
| /// A URL clients can visit to navigate to this channel. | ||
| Uri get url => Uri.https(manager.client.apiOptions.host, '/channels/${this is GuildChannel ? '${(this as GuildChannel).guildId}' : '@me'}/$id'); | ||
| } | ||
|
|
||
| /// Extensions on [GuildChannel]s. | ||
| extension GuildChannelExtensions on GuildChannel { | ||
| /// Compute [member]'s permissions in this channel. | ||
| /// | ||
| /// {@macro compute_permissions_detail} | ||
| Future<Permissions> computePermissionsFor(PartialMember member) async => await computePermissions(this, await member.get()); | ||
| } | ||
|
|
||
| /// Extensions on all [GuildChannel] types | ||
| extension GuildChannelsExtension<T extends GuildChannel> on T { | ||
| /// Create a builder with the properties of this channel | ||
| GuildChannelBuilder<T> toBuilder() => switch (this) { | ||
| GuildTextChannel channel => GuildTextChannelBuilder( | ||
| name: channel.name, | ||
| defaultAutoArchiveDuration: channel.defaultAutoArchiveDuration, | ||
| isNsfw: channel.isNsfw, | ||
| parentId: channel.parentId, | ||
| permissionOverwrites: channel.permissionOverwrites | ||
| .map((e) => PermissionOverwriteBuilder( | ||
| id: e.id, | ||
| type: e.type, | ||
| allow: e.allow, | ||
| deny: e.deny, | ||
| )) | ||
| .toList(), | ||
| position: channel.position, | ||
| rateLimitPerUser: channel.rateLimitPerUser, | ||
| topic: channel.topic, | ||
| ) as GuildChannelBuilder<T>, | ||
| GuildVoiceChannel channel => GuildVoiceChannelBuilder( | ||
| name: channel.name, | ||
| permissionOverwrites: | ||
| channel.permissionOverwrites.map((e) => PermissionOverwriteBuilder(id: e.id, type: e.type, allow: e.allow, deny: e.deny)).toList(), | ||
| position: channel.position, | ||
| isNsfw: channel.isNsfw, | ||
| parentId: channel.parentId, | ||
| bitRate: channel.bitrate, | ||
| rtcRegion: channel.rtcRegion, | ||
| userLimit: channel.userLimit, | ||
| videoQualityMode: channel.videoQualityMode, | ||
| ) as GuildChannelBuilder<T>, | ||
| GuildStageChannel channel => GuildStageChannelBuilder( | ||
| name: channel.name, | ||
| bitRate: channel.bitrate, | ||
| isNsfw: channel.isNsfw, | ||
| parentId: channel.parentId, | ||
| permissionOverwrites: | ||
| channel.permissionOverwrites.map((e) => PermissionOverwriteBuilder(id: e.id, type: e.type, allow: e.allow, deny: e.deny)).toList(), | ||
| position: channel.position, | ||
| rtcRegion: channel.rtcRegion, | ||
| userLimit: channel.userLimit, | ||
| videoQualityMode: channel.videoQualityMode, | ||
| ) as GuildChannelBuilder<T>, | ||
| PrivateThread thread => ThreadBuilder.privateThread( | ||
| name: thread.name, | ||
| autoArchiveDuration: thread.autoArchiveDuration, | ||
| invitable: thread.isInvitable, | ||
| rateLimitPerUser: thread.rateLimitPerUser, | ||
| ) as GuildChannelBuilder<T>, | ||
| PublicThread thread => ThreadBuilder.publicThread( | ||
| name: thread.name, | ||
| autoArchiveDuration: thread.autoArchiveDuration, | ||
| rateLimitPerUser: thread.rateLimitPerUser, | ||
| ) as GuildChannelBuilder<T>, | ||
| GuildCategory category => GuildCategoryBuilder( | ||
| name: category.name, | ||
| permissionOverwrites: | ||
| category.permissionOverwrites.map((e) => PermissionOverwriteBuilder(id: e.id, type: e.type, allow: e.allow, deny: e.deny)).toList(), | ||
| position: category.position, | ||
| ) as GuildChannelBuilder<T>, | ||
| GuildAnnouncementChannel channel => GuildAnnouncementChannelBuilder( | ||
| name: channel.name, | ||
| defaultAutoArchiveDuration: channel.defaultAutoArchiveDuration, | ||
| isNsfw: channel.isNsfw, | ||
| parentId: channel.parentId, | ||
| permissionOverwrites: | ||
| channel.permissionOverwrites.map((e) => PermissionOverwriteBuilder(id: e.id, type: e.type, allow: e.allow, deny: e.deny)).toList(), | ||
| position: channel.position, | ||
| topic: channel.topic, | ||
| ) as GuildChannelBuilder<T>, | ||
| _ => GuildChannelBuilder( | ||
| name: name, | ||
| type: type, | ||
| position: position, | ||
| permissionOverwrites: permissionOverwrites.map((e) => PermissionOverwriteBuilder(id: e.id, type: e.type, allow: e.allow, deny: e.deny)).toList(), | ||
| ), | ||
| }; | ||
| } | ||
|
|
||
| /// Extensions on [Thread]s. | ||
| extension ThreadExtensions on Thread { | ||
| /// Same as [listThreadMembers], but has no limit on the number of members returned. | ||
| /// | ||
| /// {@macro paginated_endpoint_streaming_parameters} | ||
| Stream<ThreadMember> streamThreadMembers({bool? withMembers, Snowflake? after, Snowflake? before, int? pageSize}) => | ||
| manager.streamThreadMembers(id, withMembers: withMembers, after: after, before: before, pageSize: pageSize); | ||
| } | ||
|
|
||
| /// Extensions on [GuildCategory]s. | ||
| extension GuildCategoryExtensions on GuildCategory { | ||
| /// Fetch the channels in this category. | ||
| Future<List<GuildChannel>> fetchChannels() async { | ||
| final guildChannels = await guild.fetchChannels(); | ||
|
|
||
| return guildChannels.where((element) => element.parentId == id).toList(); | ||
| } | ||
|
|
||
| /// Return a list of channels in the client's cache that are in this category. | ||
| List<GuildChannel> get cachedChannels => guild.cachedChannels.where((element) => element.parentId == id).toList(); | ||
| } |
Oops, something went wrong.