Feature: Forward Authentication Cookie

composer-dependency-analyser.php

@@ -31,6 +31,9 @@
     ->ignoreErrorsOnPackage('twig/twig', [
         ErrorType::DEV_DEPENDENCY_IN_PROD,
     ])
+    ->ignoreErrorsOnPackage('symfony/security-core', [
+        ErrorType::DEV_DEPENDENCY_IN_PROD,
+    ])
 ;
 
 if (\PHP_VERSION_ID < 80200) { // TODO: Requires PHP >= 8.2

composer.json

@@ -50,6 +50,7 @@
         "symfony/http-client": "^6.4 || ^7.0",
         "symfony/monolog-bundle": "^3.10",
         "symfony/routing": "^6.4 || ^7.0",
+        "symfony/security-core": "^6.4 || ^7.0",
         "symfony/stopwatch": "^6.4 || ^7.0",
         "symfony/twig-bundle": "^6.4 || ^7.0",
         "symfony/var-dumper": "^6.4 || ^7.0",
@@ -68,6 +69,7 @@
         "symfony/twig-bundle": "Allows you to use Twig to render templates into PDF.",
         "monolog/monolog": "Enables logging througout the generating process.",
         "async-aws/s3": "Upload any file to aws s3 compatible endpoints supporting multi part upload without memory overhead.",
-        "league/flysystem-bundle": "Upload any file using this filesystem abstraction package."
+        "league/flysystem-bundle": "Upload any file using this filesystem abstraction package.",
+        "symfony/security-core": "Allows you to use asUser method to generate with CLI required an authentication"
     }
 }

docs/pdf/builders_api/HtmlPdfBuilder.md

@@ -64,7 +64,11 @@ Sets the webhook for cases of success.<br />Optionally sets a custom HTTP method
 ### addCookies(array $cookies)
 Add cookies to store in the Chromium cookie jar.<br />
 
+### asUser(Symfony\Component\Security\Core\User\UserInterface $user, string $firewallName)
+For CLI generation usage.
+
 ### cookies(array $cookies)
+### forwardAuthentication()
 ### forwardCookie(string $name)
 ### setCookie(string $name, Symfony\Component\HttpFoundation\Cookie|array $cookie)
 ### generateDocumentOutline(bool $bool)

docs/pdf/builders_api/MarkdownPdfBuilder.md

@@ -76,7 +76,11 @@ Sets the webhook for cases of success.<br />Optionally sets a custom HTTP method
 ### addCookies(array $cookies)
 Add cookies to store in the Chromium cookie jar.<br />
 
+### asUser(Symfony\Component\Security\Core\User\UserInterface $user, string $firewallName)
+For CLI generation usage.
+
 ### cookies(array $cookies)
+### forwardAuthentication()
 ### forwardCookie(string $name)
 ### setCookie(string $name, Symfony\Component\HttpFoundation\Cookie|array $cookie)
 ### generateDocumentOutline(bool $bool)

docs/pdf/builders_api/UrlPdfBuilder.md

@@ -74,7 +74,11 @@ Sets the webhook for cases of success.<br />Optionally sets a custom HTTP method
 ### addCookies(array $cookies)
 Add cookies to store in the Chromium cookie jar.<br />
 
+### asUser(Symfony\Component\Security\Core\User\UserInterface $user, string $firewallName)
+For CLI generation usage.
+
 ### cookies(array $cookies)
+### forwardAuthentication()
 ### forwardCookie(string $name)
 ### setCookie(string $name, Symfony\Component\HttpFoundation\Cookie|array $cookie)
 ### generateDocumentOutline(bool $bool)

docs/pdf/customization.md

@@ -43,6 +43,9 @@
 [cookies](#cookies)  
 [setCookie](#setCookie)  
 [addCookies](#addCookies)  
+[forwardCookie](#forwardCookie)  
+[forwardAuthentication](#forwardAuthentication)  
+[asUser](#asUser)  
 [userAgent](#userAgent)  
 [extraHttpHeaders](#extraHttpHeaders)  
 [addExtraHttpHeaders](#addExtraHttpHeaders)  
@@ -872,6 +875,96 @@ class YourController
 }
 ```
 
+### forwardCookie
+
+If you want to forward existing cookie from the current request.
+
+```php
+namespace App\Controller;
+
+use Sensiolabs\GotenbergBundle\GotenbergPdfInterface;
+
+class YourController
+{
+    public function yourControllerMethod(GotenbergPdfInterface $gotenberg): Response
+    {
+        return $gotenberg
+            ->html()
+            ->content('content.html.twig', [
+                'my_var' => 'value'
+            ])
+            ->forwardCookie('my_cookie')
+            ->generate()
+            ->stream()
+        ;
+    }
+}
+```
+
+### forwardAuthentication
+
+If you want to forward the authentication cookie from the current request.
+Can be useful to generate a PDF from restricted route.
+
+```php
+namespace App\Controller;
+
+use Sensiolabs\GotenbergBundle\GotenbergPdfInterface;
+
+class YourController
+{
+    public function yourControllerMethod(GotenbergPdfInterface $gotenberg): Response
+    {
+        return $gotenberg
+            ->url()
+            ->route('auth_route')
+            ->forwardAuthentication()
+            ->generate()
+            ->stream()
+        ;
+    }
+}
+```
+
+### asUser
+
+If you want to generate a PDF for a restricted route in a CLI context.
+
+```php
+namespace App\Controller;
+
+use Sensiolabs\GotenbergBundle\GotenbergPdfInterface;
+
+#[AsCommand(name: 'app:create-pdf', description: 'Create pdf')]
+final class CreatePdf extends Command
+{
+    public function __construct(
+        private readonly GotenbergPdfInterface $gotenberg,
+        private readonly UserProviderInterface $userProvider,
+    ) {
+        parent::__construct();
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $user = $this->userProvider->loadUserByIdentifier('john_doe');
+
+        return $this->gotenberg
+            ->url()
+            ->route('auth_route')
+            ->asUser($user)
+            ->processor(new FileProcessor(new Filesystem(), dirname(__DIR__).'/../var/pdf'))
+            ->generate()
+            ->process()
+        ;
+
+        $output->writeln('PDF generated');
+
+        return Command::SUCCESS;
+    }
+}
+```
+
 ### userAgent()
 
 default: `None`

docs/screenshot/builders_api/HtmlScreenshotBuilder.md

@@ -36,7 +36,11 @@ Sets the webhook for cases of success.<br />Optionally sets a custom HTTP method
 ### addCookies(array $cookies)
 Add cookies to store in the Chromium cookie jar.<br />
 
+### asUser(Symfony\Component\Security\Core\User\UserInterface $user, string $firewallName)
+For CLI generation usage.
+
 ### cookies(array $cookies)
+### forwardAuthentication()
 ### forwardCookie(string $name)
 ### setCookie(string $name, Symfony\Component\HttpFoundation\Cookie|array $cookie)
 ### clip(bool $bool)

docs/screenshot/builders_api/MarkdownScreenshotBuilder.md

@@ -48,7 +48,11 @@ Sets the webhook for cases of success.<br />Optionally sets a custom HTTP method
 ### addCookies(array $cookies)
 Add cookies to store in the Chromium cookie jar.<br />
 
+### asUser(Symfony\Component\Security\Core\User\UserInterface $user, string $firewallName)
+For CLI generation usage.
+
 ### cookies(array $cookies)
+### forwardAuthentication()
 ### forwardCookie(string $name)
 ### setCookie(string $name, Symfony\Component\HttpFoundation\Cookie|array $cookie)
 ### clip(bool $bool)

docs/screenshot/builders_api/UrlScreenshotBuilder.md

@@ -45,7 +45,11 @@ Sets the webhook for cases of success.<br />Optionally sets a custom HTTP method
 ### addCookies(array $cookies)
 Add cookies to store in the Chromium cookie jar.<br />
 
+### asUser(Symfony\Component\Security\Core\User\UserInterface $user, string $firewallName)
+For CLI generation usage.
+
 ### cookies(array $cookies)
+### forwardAuthentication()
 ### forwardCookie(string $name)
 ### setCookie(string $name, Symfony\Component\HttpFoundation\Cookie|array $cookie)
 ### clip(bool $bool)

docs/screenshot/customization.md

@@ -24,6 +24,9 @@
 [cookies](#cookies)  
 [setCookie](#setCookie)  
 [addCookies](#addCookies)  
+[forwardCookie](#forwardCookie)  
+[forwardAuthentication](#forwardAuthentication)  
+[asUser](#asUser)  
 [userAgent](#userAgent)  
 [extraHttpHeaders](#extraHttpHeaders)  
 [addExtraHttpHeaders](#addExtraHttpHeaders)  
@@ -217,7 +220,7 @@ class YourController
                 ],
                 [
                     'url' => 'http://example.com/url/to/file',
-                    'extraHttpHeaders' => 
+                    'extraHttpHeaders' =>
                     [
                         'MyHeaderOne' => 'MyValue',
                         'MyHeaderTwo' => 'MyValue',
@@ -283,6 +286,9 @@ class YourController
     {
         return $gotenberg
             ->html()
+            ->content('twig_simple_pdf.html.twig', [
+                'my_var' => 'value'
+            ])
             ->waitDelay('5s')
             ->generate()
             ->stream()
@@ -309,6 +315,9 @@ class YourController
     {
         return $gotenberg
             ->html()
+            ->content('twig_simple_pdf.html.twig', [
+                'my_var' => 'value'
+            ])
             ->waitForExpression("window.globalVar === 'ready'")
             ->generate()
             ->stream()
@@ -339,6 +348,9 @@ class YourController
     {
         return $gotenberg
             ->html()
+            ->content('twig_simple_pdf.html.twig', [
+                'my_var' => 'value'
+            ])
             ->emulatedMediaType(EmulatedMediaType::Screen)
             ->generate()
             ->stream()
@@ -366,6 +378,9 @@ class YourController
     {
         return $gotenberg
             ->html()
+            ->content('twig_simple_pdf.html.twig', [
+                'my_var' => 'value'
+            ])
             ->cookies([[
                 'name' => 'my_cookie',
                 'value' => 'symfony',
@@ -400,6 +415,9 @@ class YourController
     {
         return $gotenberg
             ->html()
+            ->content('twig_simple_pdf.html.twig', [
+                'my_var' => 'value'
+            ])
             ->setCookie([
                 'name' => 'my_cookie',
                 'value' => 'symfony',
@@ -431,6 +449,9 @@ class YourController
     {
         return $gotenberg
             ->html()
+            ->content('twig_simple_pdf.html.twig', [
+                'my_var' => 'value'
+            ])
             ->addCookies([[
                 'name' => 'my_cookie',
                 'value' => 'symfony',
@@ -446,6 +467,96 @@ class YourController
 }
 ```
 
+### forwardCookie
+
+If you want to forward existing cookie from the current request.
+
+```php
+namespace App\Controller;
+
+use Sensiolabs\GotenbergBundle\GotenbergScreenshotInterface;
+
+class YourController
+{
+    public function yourControllerMethod(GotenbergScreenshotInterface $gotenberg): Response
+    {
+        return $gotenberg
+            ->html()
+            ->content('content.html.twig', [
+                'my_var' => 'value'
+            ])
+            ->forwardCookie('my_cookie')
+            ->generate()
+            ->stream()
+        ;
+    }
+}
+```
+
+### forwardAuthentication
+
+If you want to forward the authentication cookie from the current request.
+Can be useful to generate a screenshot from restricted route.
+
+```php
+namespace App\Controller;
+
+use Sensiolabs\GotenbergBundle\GotenbergScreenshotInterface;
+
+class YourController
+{
+    public function yourControllerMethod(GotenbergScreenshotInterface $gotenberg): Response
+    {
+        return $gotenberg
+            ->url()
+            ->route('auth_route')
+            ->forwardAuthentication()
+            ->generate()
+            ->stream()
+        ;
+    }
+}
+```
+
+### asUser
+
+If you want to generate a screenshot for a restricted route in a CLI context.
+
+```php
+namespace App\Controller;
+
+use Sensiolabs\GotenbergBundle\GotenbergScreenshotInterface;
+
+#[AsCommand(name: 'app:create-pdf', description: 'Create pdf')]
+final class CreatePdf extends Command
+{
+    public function __construct(
+        private readonly GotenbergScreenshotInterface $gotenberg,
+        private readonly UserProviderInterface $userProvider,
+    ) {
+        parent::__construct();
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $user = $this->userProvider->loadUserByIdentifier('john_doe');
+
+        return $this->gotenberg
+            ->url()
+            ->route('auth_route')
+            ->asUser($user)
+            ->processor(new FileProcessor(new Filesystem(), dirname(__DIR__).'/../var/screenshot'))
+            ->generate()
+            ->process()
+        ;
+
+        $output->writeln('PDF generated');
+
+        return Command::SUCCESS;
+    }
+}
+```
+
 ### userAgent()
 
 default: `None`