labymod / discord-webhook Goto Github PK

Make it possible to add message components like actions, buttons, etc.

@see https://discord.com/developers/docs/interactions/message-components#component-object

Goal

Configure & send messages with embeds to a given discord channel

Workflow

Unlike the old library (Webhooks) we want to design the interface to create embeds less painful.

An option would be to create a universal embed class and configure the type with constants.

Description

Currently it is quite an overhead to create simple webhooks. Even the simplest ones require at least this boilerplate:

$webhook = new Webhook('your very long webhook url here');
$webhook->setMessage('My cool message');
$webhook->send();

The idea

New class: SimpleWebhook
You are able to set the default url in two ways:

• Via env variable: DWH_DEFAULT_URL=https://xy
• Via static property: SimpleWebhook::setDefaultUrl('xy');

Then, in your application it is as simple as this to send basic webhooks with text-messages:

\DiscordWebhook\SimpleWebhook::sendMessage('my message');

Todo

• New SimpleWebhook class with static API
• environment resolver
• Priority logic for WH endpoint

Description

Create a symfony bundle with or within this library.
Goals are:

• Configure channels in yaml directly
• Resolve the webhook from DI
• Make endpoint configuration simpler

Todo

• Evaluation: Within this library or as separate bundle?
• Basic symfony Bundle structure
• Configuration boilerplate according to: https://symfony.com/doc/current/components/config/definition.html#adding-node-definitions-to-the-tree
  • client configurations (maybe with bot name and avatar?)
  • url configurations
  • Support for different clients, similar to: https://symfony.com/doc/current/http_client.html#scoping-client
• Define webhook class as service

Add a fluent interface to build messages/embeds. Similar to the symfony config-definition builder.

The benefit would be that you can better see how the messages would look like when they're being sent and it makes building complex embeds easier (and cooler) I guess.

Could look something like this:

$builder = new WebhookBuilder();
$builder
    ->embeds()
        ->embed()
            ->title('embed ONE title')
            ->timestamp(new \DateTime())
            ->fields()
                ->field()
                    ->name('field title')
                    ->value('some field value')
                ->end()
            ->end()
        ->end()
        ->embed()
            ->title('embed TWO title')
            ->author()
                ->name('scrummer')
                ->iconUrl('https://my.icon.url/icon.jpg')
            ->end()
        -> end()
    ->end()
;

$builder->send();

Make the constructor accept a string OR an array of webhook URLs.
Currently you have to pack also a single URL into an array even if you do not intend to use more than one URL.

// OLD:
new \DiscordWebhook\Webhook(['https://discord.com/webhook/url']);

// NEW, these two options:
new \DiscordWebhook\Webhook(['https://discord.com/webhook/url']);
new \DiscordWebhook\Webhook('https://discord.com/webhook/url');

// ofc. if you want more WHs just add them to the array:
new \DiscordWebhook\Webhook([
    'https://discord.com/webhook/url/one',
    'https://discord.com/webhook/url/two',
    'https://discord.com/webhook/url/three'
]);

• Implement Enums
  • e.g. for embed colours
• New major version (3.0.0)

Goal is to create a external repo for a Symfony bundle to easily integrate discord webhooks into any symfony application.

• Update repo to use ddev.
• #6
• General 8.1 compatibility
• Improve README with version compatibility
• Drop support for PHP 7.4