<?php

/*
 * This file is part of the Maestro Project.
 * Copyright (C) Compos Juliot
 */

namespace App\Application\Adapter;

/**
 * [Contract fro App\Application\Services\Mercure\MercureHubService].
 */
interface MercureHubInterface
{
    /**
     * [
     *      - Send a message to Mercure's hub from topic that we want to subscribe.
     *      - When message is private, it will be successfully proceed by messenger and queue. Althought it wont be send to the hub (Debugging Tools).
     *      - It seems that Mercure will auto-generate a JWT (See Symfony\Component\Mercure\Hub.php publish method) maybe based on MERCURE_JWT_SECRET env var but according to symfony doc (https://symfony.com/doc/4.4/mercure.html#configuration),
     *        this env var must be a JWT token and not a secret key => misunderstand cause with a secret key it will work instead of use a JWT signed with secret key ...
     * ]
     * 
     * @param string|array $topics [description]
     * @param string|array $messages [description]
     * @param bool $private [description]
     * 
     * @return void [description]
     */
    public function publish($topics, $messages, ?bool $private = false): void;
}