Configuration.php

<?php

/*
 * This file is part of the Silverback API Components Bundle Project
 *
 * (c) Daniel West <daniel@silverback.is>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Silverback\ApiComponentsBundle\DependencyInjection;

use Silverback\ApiComponentsBundle\ApiResource\ResourceManifest;
use Silverback\ApiComponentsBundle\Entity\Core\ComponentPosition;
use Silverback\ApiComponentsBundle\Entity\Core\Route;
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;
use Symfony\Component\HttpFoundation\Cookie;

/**
 * @author Daniel West <daniel@silverback.is>
 */
class Configuration implements ConfigurationInterface
{
    public function getConfigTreeBuilder(): TreeBuilder
    {
        $treeBuilder = new TreeBuilder('silverback_api_components');
        $rootNode = $treeBuilder->getRootNode();
        $rootNode
            ->children()
                ->scalarNode('website_name')->isRequired()->end()
                ->scalarNode('table_prefix')->defaultValue('_acb_')->end()
                ->scalarNode('metadata_key')->defaultValue('_metadata')->end()
            ->end();

        $this->addMercureNode($rootNode);
        $this->addRouteSecurityNode($rootNode);
        $this->addRoutableSecurityNode($rootNode);
        $this->addRefreshTokenNode($rootNode);
        $this->addPublishableNode($rootNode);
        $this->addEnabledComponentsNode($rootNode);
        $this->addUserNode($rootNode);
        $this->addHttpCacheNode($rootNode);

        return $treeBuilder;
    }

    private function addHttpCacheNode(ArrayNodeDefinition $rootNode): void
    {
        $rootNode
            ->children()
                ->arrayNode('http_cache')
                    ->addDefaultsIfNotSet()
                    ->info('Cache-safety headers for responses that vary by the authenticated session.')
                    ->children()
                        ->arrayNode('personalised_resource_classes')
                            ->info('Resource classes whose GET responses are marked `private, no-store` for authenticated users. Publishable resources are always treated as personalised in addition to this list.')
                            ->scalarPrototype()->end()
                            ->defaultValue([
                                Route::class,
                                ResourceManifest::class,
                                ComponentPosition::class,
                            ])
                        ->end()
                    ->end()
                ->end()
            ->end();
    }

    private function addMercureNode(ArrayNodeDefinition $rootNode): void
    {
        $rootNode
            ->children()
                ->arrayNode('mercure')
                    ->addDefaultsIfNotSet()
                    ->children()
                        ->scalarNode('hub_name')->defaultNull()->end()
                        ->booleanNode('secure_subscriptions')
                            ->defaultFalse()
                            ->info('When true, subscriber JWT tokens only include topics for resources the current user can access. Requires class-level security expressions (i.e. no "object" variable) on API operations to be evaluated at subscription time.')
                        ->end()
                        ->arrayNode('cookie')
                            ->addDefaultsIfNotSet()
                            ->children()
                                 ->scalarNode('samesite')->defaultValue(Cookie::SAMESITE_STRICT)
                                ->end()
                            ->end()
                        ->end()
                    ->end()
                ->end()
            ->end();
    }

    private function addRouteSecurityNode(ArrayNodeDefinition $rootNode): void
    {
        $rootNode
            ->children()
                ->arrayNode('route_security')
                    ->arrayPrototype()
                        ->children()
                            ->scalarNode('route')->end()
                            ->scalarNode('security')->end()
                        ->end()
                    ->end()
                ->end()
            ->end();
    }

    private function addRoutableSecurityNode(ArrayNodeDefinition $rootNode): void
    {
        $rootNode
            ->children()
                ->scalarNode('routable_security')->defaultNull()->end()
            ->end();
    }

    private function addRefreshTokenNode(ArrayNodeDefinition $rootNode): void
    {
        $rootNode
            ->children()
                ->arrayNode('refresh_token')
                    ->addDefaultsIfNotSet()
                    ->children()
                        ->scalarNode('handler_id')->cannotBeEmpty()->isRequired()->end()
                        ->arrayNode('options')
                            ->useAttributeAsKey('key')
                            ->prototype('variable')->end()
                        ->end()
                        ->scalarNode('cookie_name')->cannotBeEmpty()->isRequired()->end()
                        ->scalarNode('ttl')->cannotBeEmpty()->isRequired()->end()
                        ->scalarNode('database_user_provider')->cannotBeEmpty()->isRequired()->end()
                    ->end()
                ->end()
            ->end();
    }

    private function addPublishableNode(ArrayNodeDefinition $rootNode): void
    {
        $rootNode
            ->children()
                ->arrayNode('publishable')
                    ->addDefaultsIfNotSet()
                    ->children()
                        ->scalarNode('permission')->cannotBeEmpty()->isRequired()->end()
                    ->end()
                ->end()
            ->end();
    }

    private function addEnabledComponentsNode(ArrayNodeDefinition $rootNode): void
    {
        $rootNode
            ->children()
                ->arrayNode('enabled_components')
                    ->addDefaultsIfNotSet()
                    ->children()
                        ->booleanNode('form')->defaultValue(true)->end()
                        ->booleanNode('collection')->defaultValue(true)->end()
                    ->end()
                ->end()
            ->end();
    }

    private function addUserNode(ArrayNodeDefinition $rootNode): void
    {
        $rootNode
            ->children()
                ->arrayNode('user')
                    ->addDefaultsIfNotSet()
                    ->children()
                        ->scalarNode('class_name')
                            ->isRequired()
                        ->end()
                        ->arrayNode('email_verification')
                            ->canBeDisabled()
                            ->addDefaultsIfNotSet()
                            ->children()
                                ->arrayNode('email')
                                    ->children()
                                        ->scalarNode('redirect_path_query')->end()
                                        ->scalarNode('default_redirect_path')->isRequired()->end()
                                        ->scalarNode('subject')->cannotBeEmpty()->defaultValue('Please verify your email')->end()
                                    ->end()
                                ->end()
                                ->booleanNode('default_value')->isRequired()->end()
                                ->booleanNode('verify_on_change')->isRequired()->end()
                                ->booleanNode('verify_on_register')->isRequired()->end()
                                ->booleanNode('deny_unverified_login')->isRequired()->end()
                            ->end()
                        ->end()
                        ->arrayNode('new_email_confirmation')
                            ->addDefaultsIfNotSet()
                            ->children()
                                ->arrayNode('email')
                                    ->children()
                                        ->scalarNode('redirect_path_query')->end()
                                        ->scalarNode('default_redirect_path')->isRequired()->end()
                                        ->scalarNode('subject')->cannotBeEmpty()->defaultValue('Please confirm your new email address')->end()
                                    ->end()
                                ->end()
                                ->integerNode('request_timeout_seconds')->defaultValue(86400)->end()
                            ->end()
                        ->end()
                        ->arrayNode('password_reset')
                            ->addDefaultsIfNotSet()
                            ->children()
                                ->arrayNode('email')
                                    ->children()
                                        ->scalarNode('redirect_path_query')->end()
                                        ->scalarNode('default_redirect_path')->isRequired()->end()
                                        ->scalarNode('subject')->cannotBeEmpty()->defaultValue('Your password reset request')->end()
                                    ->end()
                                ->end()
                                ->integerNode('repeat_ttl_seconds')->defaultValue(86400)->end()
                                ->integerNode('request_timeout_seconds')->defaultValue(3600)->end()
                            ->end()
                        ->end()
                        ->arrayNode('emails')
                            ->addDefaultsIfNotSet()
                            ->children()
                                ->arrayNode('welcome')
                                    ->canBeDisabled()
                                    ->addDefaultsIfNotSet()
                                    ->children()
                                        ->scalarNode('subject')->cannotBeEmpty()->defaultValue('Welcome to {{ website_name }}')->end()
                                    ->end()
                                ->end()
                                ->arrayNode('user_enabled')
                                    ->canBeDisabled()
                                    ->addDefaultsIfNotSet()
                                    ->children()
                                        ->scalarNode('subject')->cannotBeEmpty()->defaultValue('Your account has been enabled')->end()
                                    ->end()
                                ->end()
                                ->arrayNode('username_changed')
                                    ->canBeDisabled()
                                    ->addDefaultsIfNotSet()
                                    ->children()
                                        ->scalarNode('subject')->cannotBeEmpty()->defaultValue('Your username has been updated')->end()
                                    ->end()
                                ->end()
                                ->arrayNode('password_changed')
                                    ->canBeDisabled()
                                    ->addDefaultsIfNotSet()
                                    ->children()
                                        ->scalarNode('subject')->cannotBeEmpty()->defaultValue('Your password has been changed')->end()
                                    ->end()
                                ->end()
                            ->end()
                        ->end()
                    ->end()
                ->end()
            ->end();
    }
}