Canal de notificaciones - Laravel Bluesky

Descripción general

laravel-bluesky se integra con el sistema de Notification de Laravel. Con BlueskyChannel puedes hacer publicaciones normales y con BlueskyPrivateChannel enviar mensajes directos (DM).

Canales disponibles

Canal	Uso
`BlueskyChannel`	Notificar como publicación pública normal
`BlueskyPrivateChannel`	Notificar como DM (chat privado) al destinatario

Clase Notification

BlueskyChannel

En via() indica BlueskyChannel::class y devuelve el contenido de envío desde toBluesky().

use Illuminate\Notifications\Notification;
use Revolution\Bluesky\Notifications\BlueskyChannel;
use Revolution\Bluesky\Record\Post;
use Revolution\Bluesky\RichText\TextBuilder;
use Revolution\Bluesky\Embed\External;

class TestNotification extends Notification
{
    public function via(object $notifiable): array
    {
        return [
            BlueskyChannel::class
        ];
    }

    public function toBluesky(object $notifiable): Post
    {
        $external = External::create(title: 'Title', description: 'test', uri: 'https://');

        return Post::build(function (TextBuilder $builder) {
                   $builder->text('test')
                           ->newLine()
                           ->tag('#Laravel');
        })->embed($external);
    }
}

El uso de Post es el mismo que en Basic client. TextBuilder, Embed y demás están disponibles de la misma forma.

BlueskyPrivateChannel

BlueskyPrivateMessage es casi idéntico a Post, pero solo admite text, facets y embed. Como embed, solo se admite QuoteRecord.

use Illuminate\Notifications\Notification;
use Revolution\Bluesky\Notifications\BlueskyPrivateChannel;
use Revolution\Bluesky\Notifications\BlueskyPrivateMessage;
use Revolution\Bluesky\RichText\TextBuilder;
use Revolution\Bluesky\Embed\QuoteRecord;
use Revolution\Bluesky\Types\StrongRef;

class TestNotification extends Notification
{
    public function via(object $notifiable): array
    {
        return [
            BlueskyPrivateChannel::class
        ];
    }

    public function toBlueskyPrivate(object $notifiable): BlueskyPrivateMessage
    {
        $quote = QuoteRecord::create(StrongRef::to(uri: 'at://', cid: 'cid'));

        return BlueskyPrivateMessage::build(function (TextBuilder $builder) {
                   $builder->text('test')
                           ->newLine()
                           ->tag('#Laravel');
        })->embed($quote);
    }
}

Notificaciones on-demand

Cuando quieras indicar el destinatario al vuelo sin usar un modelo, utiliza Notification::route().

BlueskyChannel

use Illuminate\Support\Facades\Notification;
use Revolution\Bluesky\Notifications\BlueskyRoute;
use Revolution\Bluesky\Session\OAuthSession;
use App\Models\User;

// App password
Notification::route('bluesky', BlueskyRoute::to(identifier: config('bluesky.identifier'), password: config('bluesky.password')))
            ->notify(new TestNotification());

// OAuth
$user = User::find(1);
$session = OAuthSession::create([
    'did' => $user->did,
    'iss' => $user->iss,
    'refresh_token' => $user->refresh_token,
]);
Notification::route('bluesky', BlueskyRoute::to(oauth: $session))
            ->notify(new TestNotification());

BlueskyPrivateChannel

Para los DMs es obligatorio indicar receiver (el DID o handle del destinatario). Además, el destinatario debe tener habilitada la recepción de DMs.

Con App password se necesita permiso para enviar DMs.
Con OAuth se requiere el scope transition:chat.bsky.

use Illuminate\Support\Facades\Notification;
use Revolution\Bluesky\Notifications\BlueskyRoute;
use Revolution\Bluesky\Session\OAuthSession;
use App\Models\User;

// App password
Notification::route('bluesky-private', BlueskyRoute::to(identifier: config('bluesky.identifier'), password: config('bluesky.password'), receiver: 'did or handle'))
            ->notify(new TestNotification());

// OAuth
$user = User::find(1);
$session = OAuthSession::create([
    'did' => $user->did,
    'iss' => $user->iss,
    'refresh_token' => $user->refresh_token,
]);
Notification::route('bluesky-private', BlueskyRoute::to(oauth: $session, receiver: 'did or handle'))
            ->notify(new TestNotification());

En Bluesky no puedes enviarte DMs a ti mismo. Si quieres notificarte a ti, prepara otra cuenta específica para el envío.

// Enviar DM a ti mismo

use Illuminate\Support\Facades\Notification;
use Revolution\Bluesky\Notifications\BlueskyRoute;

Notification::route('bluesky-private', BlueskyRoute::to(identifier: 'sender identifier', password: 'sender password', receiver: 'your did or handle'))
            ->notify(new TestNotification());

Si vas a usar siempre el mismo emisor y receptor (por ejemplo, uso personal), puedes configurarlo en .env. Crea una cuenta dedicada al envío.

BLUESKY_SENDER_IDENTIFIER=sender did or handle
BLUESKY_SENDER_APP_PASSWORD=sender password
BLUESKY_RECEIVER=your did or handle

Notification::route('bluesky-private', BlueskyRoute::to(
    identifier: config('bluesky.notification.private.sender.identifier'),
    password: config('bluesky.notification.private.sender.password'),
    receiver: config('bluesky.notification.private.receiver'),
))->notify(new TestNotification());

Notificación a usuarios

Define la ruta de notificación en el modelo que use el trait Notifiable.

BlueskyChannel

use Illuminate\Notifications\Notifiable;
use Revolution\Bluesky\Notifications\BlueskyRoute;
use Revolution\Bluesky\Session\OAuthSession;

class User
{
    use Notifiable;

    public function routeNotificationForBluesky($notification): BlueskyRoute
    {
        // App password
        return BlueskyRoute::to(identifier: $this->bluesky_identifier, password: $this->bluesky_password);

        // OAuth
        $session = OAuthSession::create([
            'did' => $this->did,
            'iss' => $this->iss,
            'refresh_token' => $this->refresh_token,
        ]);
        return BlueskyRoute::to(oauth: $session);
    }
}

$user->notify(new TestNotification());

BlueskyPrivateChannel

use Illuminate\Notifications\Notifiable;
use Revolution\Bluesky\Notifications\BlueskyRoute;
use Revolution\Bluesky\Session\OAuthSession;

class User
{
    use Notifiable;

    public function routeNotificationForBlueskyPrivate($notification): BlueskyRoute
    {
        // App password
        return BlueskyRoute::to(identifier: $this->bluesky_identifier, password: $this->bluesky_password, receiver: $this->receiver);

        // OAuth
        $session = OAuthSession::create([
            'did' => $this->did,
            'iss' => $this->iss,
            'refresh_token' => $this->refresh_token,
        ]);
        return BlueskyRoute::to(oauth: $session, receiver: $this->receiver);
    }
}

$user->notify(new TestNotification());

También puedes usar como destinatario al propio usuario.

public function routeNotificationForBlueskyPrivate($notification): BlueskyRoute
{
    // App password
    return BlueskyRoute::to(identifier: 'sender identifier', password: 'sender password', receiver: $this->did);
}

BlueskyRoute

La forma de especificar depende del método de autenticación (App password u OAuth). Se recomienda usar argumentos con nombre.

use Revolution\Bluesky\Notifications\BlueskyRoute;
use Revolution\Bluesky\Session\OAuthSession;

// App password
BlueskyRoute::to(identifier: config('bluesky.identifier'), password: config('bluesky.password'))

// OAuth
$session = OAuthSession::create([
    'did' => '...',
    'iss' => '...',
    'refresh_token' => '...',
]);
BlueskyRoute::to(oauth: $session);

Si solo necesitas notificar a tu propia cuenta, App password es lo más sencillo. No hay que preocuparse por refrescar el refresh_token, y basta con configurar el .env.

BLUESKY_IDENTIFIER=
BLUESKY_APP_PASSWORD=

Comprobar el resultado de la notificación

Como en cualquier proyecto Laravel, puedes verificar la respuesta con el evento NotificationSent después del envío.

use Illuminate\Notifications\Events\NotificationSent;
use Illuminate\Http\Client\Response;

class Listener
{
    public function handle(NotificationSent $event): void
    {
        // $event->channel  BlueskyChannel
        // $event->notifiable
        // $event->notification
        // $event->response  null|Response
    }
}

Source: docs/notification.md

​Descripción general

​Canales disponibles

​Clase Notification

​BlueskyChannel

​BlueskyPrivateChannel

​Notificaciones on-demand

​BlueskyChannel

​BlueskyPrivateChannel

​Notificación a usuarios

​BlueskyChannel

​BlueskyPrivateChannel

​BlueskyRoute

​Comprobar el resultado de la notificación

Descripción general

Canales disponibles

Clase Notification

BlueskyChannel

BlueskyPrivateChannel

Notificaciones on-demand

BlueskyChannel

BlueskyPrivateChannel

Notificación a usuarios

BlueskyChannel

BlueskyPrivateChannel

BlueskyRoute

Comprobar el resultado de la notificación