Add convert route

config/builder_pdf.php

@@ -1,5 +1,6 @@
 <?php
 
+use Sensiolabs\GotenbergBundle\Builder\Pdf\ConvertPdfBuilder;
 use Sensiolabs\GotenbergBundle\Builder\Pdf\HtmlPdfBuilder;
 use Sensiolabs\GotenbergBundle\Builder\Pdf\LibreOfficePdfBuilder;
 use Sensiolabs\GotenbergBundle\Builder\Pdf\MarkdownPdfBuilder;
@@ -58,4 +59,14 @@
         ->call('setLogger', [service('logger')->nullOnInvalid()])
         ->tag('sensiolabs_gotenberg.pdf_builder')
     ;
+
+    $services->set('.sensiolabs_gotenberg.pdf_builder.convert', ConvertPdfBuilder::class)
+        ->share(false)
+        ->args([
+            service('sensiolabs_gotenberg.client'),
+            service('sensiolabs_gotenberg.asset.base_dir_formatter'),
+        ])
+        ->call('setLogger', [service('logger')->nullOnInvalid()])
+        ->tag('sensiolabs_gotenberg.pdf_builder')
+    ;
 };

src/Builder/Pdf/ConvertPdfBuilder.php

@@ -0,0 +1,90 @@
+<?php
+
+namespace Sensiolabs\GotenbergBundle\Builder\Pdf;
+
+use Sensiolabs\GotenbergBundle\Enumeration\PdfFormat;
+use Sensiolabs\GotenbergBundle\Exception\InvalidBuilderConfiguration;
+use Sensiolabs\GotenbergBundle\Exception\MissingRequiredFieldException;
+use Symfony\Component\Mime\Part\DataPart;
+use Symfony\Component\Mime\Part\File as DataPartFile;
+
+final class ConvertPdfBuilder extends AbstractPdfBuilder
+{
+    private const ENDPOINT = '/forms/pdfengines/convert';
+
+    /**
+     * To set configurations by an array of configurations.
+     *
+     * @param array<string, mixed> $configurations
+     */
+    public function setConfigurations(array $configurations): self
+    {
+        foreach ($configurations as $property => $value) {
+            $this->addConfiguration($property, $value);
+        }
+
+        return $this;
+    }
+
+    /**
+     * Convert the resulting PDF into the given PDF/A format.
+     */
+    public function pdfFormat(PdfFormat $format): self
+    {
+        $this->formFields['pdfa'] = $format->value;
+
+        return $this;
+    }
+
+    /**
+     * Enable PDF for Universal Access for optimal accessibility.
+     */
+    public function pdfUniversalAccess(bool $bool = true): self
+    {
+        $this->formFields['pdfua'] = $bool;
+
+        return $this;
+    }
+
+    public function files(string ...$paths): self
+    {
+        $this->formFields['files'] = [];
+
+        foreach ($paths as $path) {
+            $this->assertFileExtension($path, ['pdf']);
+
+            $dataPart = new DataPart(new DataPartFile($this->asset->resolve($path)));
+
+            $this->formFields['files'][$path] = $dataPart;
+        }
+
+        return $this;
+    }
+
+    public function getMultipartFormData(): array
+    {
+        if (!\array_key_exists('pdfa', $this->formFields) && !\array_key_exists('pdfua', $this->formFields)) {
+            throw new MissingRequiredFieldException('At least "pdfa" or "pdfua" must be provided.');
+        }
+
+        if ([] === ($this->formFields['files'] ?? [])) {
+            throw new MissingRequiredFieldException('At least one PDF file is required');
+        }
+
+        return parent::getMultipartFormData();
+    }
+
+    protected function getEndpoint(): string
+    {
+        return self::ENDPOINT;
+    }
+
+    private function addConfiguration(string $configurationName, mixed $value): void
+    {
+        match ($configurationName) {
+            'pdf_format' => $this->pdfFormat(PdfFormat::from($value)),
+            'pdf_universal_access' => $this->pdfUniversalAccess($value),
+            default => throw new InvalidBuilderConfiguration(sprintf('Invalid option "%s": no method does not exist in class "%s" to configured it.', $configurationName, static::class)),
+        };
+    }
+}

src/Debug/TraceableGotenbergPdf.php

@@ -2,6 +2,7 @@
 
 namespace Sensiolabs\GotenbergBundle\Debug;
 
+use Sensiolabs\GotenbergBundle\Builder\Pdf\ConvertPdfBuilder;
 use Sensiolabs\GotenbergBundle\Builder\Pdf\HtmlPdfBuilder;
 use Sensiolabs\GotenbergBundle\Builder\Pdf\LibreOfficePdfBuilder;
 use Sensiolabs\GotenbergBundle\Builder\Pdf\MarkdownPdfBuilder;
@@ -103,6 +104,23 @@ public function markdown(): PdfBuilderInterface
         return $traceableBuilder;
     }
 
+    /**
+     * @return ConvertPdfBuilder|TraceablePdfBuilder
+     */
+    public function convert(): PdfBuilderInterface
+    {
+        /** @var ConvertPdfBuilder|TraceablePdfBuilder $traceableBuilder */
+        $traceableBuilder = $this->inner->convert();
+
+        if (!$traceableBuilder instanceof TraceablePdfBuilder) {
+            return $traceableBuilder;
+        }
+
+        $this->builders[] = ['convert', $traceableBuilder];
+
+        return $traceableBuilder;
+    }
+
     /**
      * @return list<array{string, TraceablePdfBuilder}>
      */

src/DependencyInjection/Configuration.php

@@ -48,6 +48,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                             ->append($this->addPdfUrlNode())
                             ->append($this->addPdfMarkdownNode())
                             ->append($this->addPdfOfficeNode())
+                            ->append($this->addPdfConvertNode())
                         ->end()
                         ->arrayNode('screenshot')
                             ->addDefaultsIfNotSet()
@@ -298,18 +299,11 @@ private function addChromiumPdfOptionsNode(ArrayNodeDefinition $parent): void
                     ->info('Do not wait for Chromium network to be idle. - default false. https://gotenberg.dev/docs/routes#performance-mode-chromium')
                     ->defaultNull()
                 ->end()
-                ->enumNode('pdf_format')
-                    ->info('Convert the resulting PDF into the given PDF/A format - default None. https://gotenberg.dev/docs/routes#pdfa-chromium')
-                    ->values(array_map(static fn (PdfFormat $case): string => $case->value, PdfFormat::cases()))
-                    ->defaultNull()
-                ->end()
-                ->booleanNode('pdf_universal_access')
-                    ->info('Enable PDF for Universal Access for optimal accessibility - default false. https://gotenberg.dev/docs/routes#console-exceptions')
-                    ->defaultNull()
-                ->end()
                 ->append($this->addPdfMetadata())
             ->end()
         ;
+
+        $this->addPdfFormat($parent);
     }
 
     private function addChromiumScreenshotOptionsNode(ArrayNodeDefinition $parent): void
@@ -444,7 +438,7 @@ private function addPdfOfficeNode(): NodeDefinition
     {
         $treeBuilder = new TreeBuilder('office');
 
-        return $treeBuilder->getRootNode()
+        $treeBuilder->getRootNode()
             ->addDefaultsIfNotSet()
             ->children()
                 ->booleanNode('landscape')
@@ -465,18 +459,39 @@ private function addPdfOfficeNode(): NodeDefinition
                     ->info('Merge alphanumerically the resulting PDFs. - default false. https://gotenberg.dev/docs/routes#merge-libreoffice')
                     ->defaultNull()
                 ->end()
-                ->enumNode('pdf_format')
-                    ->info('Convert the resulting PDF into the given PDF/A format - default None. https://gotenberg.dev/docs/routes#pdfa-chromium')
-                    ->values(array_map(static fn (PdfFormat $case): string => $case->value, PdfFormat::cases()))
-                    ->defaultNull()
-                ->end()
-                ->booleanNode('pdf_universal_access')
-                    ->info('Enable PDF for Universal Access for optimal accessibility - default false. https://gotenberg.dev/docs/routes#console-exceptions')
-                    ->defaultNull()
-                ->end()
                 ->append($this->addPdfMetadata())
             ->end()
         ;
+
+        $this->addPdfFormat($treeBuilder->getRootNode());
+
+        return $treeBuilder->getRootNode();
+    }
+
+    private function addPdfConvertNode(): NodeDefinition
+    {
+        $treeBuilder = new TreeBuilder('convert');
+        $this->addPdfFormat($treeBuilder->getRootNode());
+
+        return $treeBuilder->getRootNode();
+    }
+
+    private function addPdfFormat(ArrayNodeDefinition $parent): void
+    {
+        $parent
+           ->addDefaultsIfNotSet()
+           ->children()
+               ->enumNode('pdf_format')
+                   ->info('Convert PDF into the given PDF/A format - default None.')
+                   ->values(array_map(static fn (PdfFormat $case): string => $case->value, PdfFormat::cases()))
+                   ->defaultNull()
+               ->end()
+               ->booleanNode('pdf_universal_access')
+                   ->info('Enable PDF for Universal Access for optimal accessibility - default false.')
+                   ->defaultNull()
+               ->end()
+           ->end()
+        ;
     }
 
     private function addPdfMetadata(): NodeDefinition

src/DependencyInjection/SensiolabsGotenbergExtension.php

@@ -18,7 +18,7 @@ public function load(array $configs, ContainerBuilder $container): void
     {
         $configuration = new Configuration();
 
-        /** @var array{base_uri: string, http_client: string|null, request_context?: array{base_uri?: string}, assets_directory: string, default_options: array{pdf: array{html: array<string, mixed>, url: array<string, mixed>, markdown: array<string, mixed>, office: array<string, mixed>}, screenshot: array{html: array<string, mixed>, url: array<string, mixed>, markdown: array<string, mixed>}}} $config */
+        /** @var array{base_uri: string, http_client: string|null, request_context?: array{base_uri?: string}, assets_directory: string, default_options: array{pdf: array{html: array<string, mixed>, url: array<string, mixed>, markdown: array<string, mixed>, office: array<string, mixed>, convert: array<string, mixed>}, screenshot: array{html: array<string, mixed>, url: array<string, mixed>, markdown: array<string, mixed>}}} $config */
         $config = $this->processConfiguration($configuration, $configs);
 
         $loader = new PhpFileLoader($container, new FileLocator(__DIR__.'/../../config'));
@@ -34,6 +34,7 @@ public function load(array $configs, ContainerBuilder $container): void
                     'url' => $this->cleanUserOptions($config['default_options']['pdf']['url']),
                     'markdown' => $this->cleanUserOptions($config['default_options']['pdf']['markdown']),
                     'office' => $this->cleanUserOptions($config['default_options']['pdf']['office']),
+                    'convert' => $this->cleanUserOptions($config['default_options']['pdf']['convert']),
                 ])
             ;
         }
@@ -73,6 +74,9 @@ public function load(array $configs, ContainerBuilder $container): void
         $definition = $container->getDefinition('.sensiolabs_gotenberg.pdf_builder.office');
         $definition->addMethodCall('setConfigurations', [$this->cleanUserOptions($config['default_options']['pdf']['office'])]);
 
+        $definition = $container->getDefinition('.sensiolabs_gotenberg.pdf_builder.convert');
+        $definition->addMethodCall('setConfigurations', [$this->cleanUserOptions($config['default_options']['pdf']['convert'])]);
+
         $definition = $container->getDefinition('.sensiolabs_gotenberg.screenshot_builder.html');
         $definition->addMethodCall('setConfigurations', [$this->cleanUserOptions($config['default_options']['screenshot']['html'])]);
 

src/GotenbergPdf.php

@@ -22,12 +22,13 @@ public function get(string $builder): PdfBuilderInterface
     }
 
     /**
-     * @param 'html'|'url'|'markdown'|'office' $key
+     * @param 'html'|'url'|'markdown'|'office'|'convert' $key
      *
      * @return ($key is 'html' ? HtmlPdfBuilder :
      *         $key is 'url' ? UrlPdfBuilder :
      *         $key is 'markdown' ? MarkdownPdfBuilder :
      *         $key is 'office' ? LibreOfficePdfBuilder :
+     *         $key is 'convert' ? ConvertPdfBuilder :
      *         PdfBuilderInterface)
      * )
      */
@@ -55,4 +56,9 @@ public function markdown(): PdfBuilderInterface
     {
         return $this->getInternal('markdown');
     }
+
+    public function convert(): PdfBuilderInterface
+    {
+        return $this->getInternal('convert');
+    }
 }

src/GotenbergPdfInterface.php

@@ -2,6 +2,7 @@
 
 namespace Sensiolabs\GotenbergBundle;
 
+use Sensiolabs\GotenbergBundle\Builder\Pdf\ConvertPdfBuilder;
 use Sensiolabs\GotenbergBundle\Builder\Pdf\HtmlPdfBuilder;
 use Sensiolabs\GotenbergBundle\Builder\Pdf\LibreOfficePdfBuilder;
 use Sensiolabs\GotenbergBundle\Builder\Pdf\MarkdownPdfBuilder;
@@ -38,4 +39,9 @@ public function office(): PdfBuilderInterface;
      * @return MarkdownPdfBuilder
      */
     public function markdown(): PdfBuilderInterface;
+
+    /**
+     * @return ConvertPdfBuilder
+     */
+    public function convert(): PdfBuilderInterface;
 }

tests/Builder/Pdf/ConvertPdfBuilderTest.php

@@ -0,0 +1,93 @@
+<?php
+
+namespace Sensiolabs\GotenbergBundle\Tests\Builder\Pdf;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\UsesClass;
+use Sensiolabs\GotenbergBundle\Builder\Pdf\AbstractPdfBuilder;
+use Sensiolabs\GotenbergBundle\Builder\Pdf\ConvertPdfBuilder;
+use Sensiolabs\GotenbergBundle\Exception\MissingRequiredFieldException;
+use Sensiolabs\GotenbergBundle\Formatter\AssetBaseDirFormatter;
+use Sensiolabs\GotenbergBundle\Tests\Builder\AbstractBuilderTestCase;
+
+#[CoversClass(ConvertPdfBuilder::class)]
+#[UsesClass(AbstractPdfBuilder::class)]
+#[UsesClass(AssetBaseDirFormatter::class)]
+final class ConvertPdfBuilderTest extends AbstractBuilderTestCase
+{
+    private const PDF_DOCUMENTS_DIR = 'assets/pdf';
+
+    public function testEndpointIsCorrect(): void
+    {
+        $this->gotenbergClient
+            ->expects($this->once())
+            ->method('call')
+            ->with(
+                $this->equalTo('/forms/pdfengines/convert'),
+                $this->anything(),
+                $this->anything(),
+            )
+        ;
+
+        $this->getConvertPdfBuilder()
+            ->files(self::PDF_DOCUMENTS_DIR.'/document.pdf')
+            ->pdfUniversalAccess()
+            ->generate()
+        ;
+    }
+
+    public static function configurationIsCorrectlySetProvider(): \Generator
+    {
+        yield 'pdf_format' => ['pdf_format', 'PDF/A-1b', [
+            'pdfa' => 'PDF/A-1b',
+        ]];
+        yield 'pdf_universal_access' => ['pdf_universal_access', false, [
+            'pdfua' => 'false',
+        ]];
+    }
+
+    /**
+     * @param array<mixed> $expected
+     */
+    #[DataProvider('configurationIsCorrectlySetProvider')]
+    public function testConfigurationIsCorrectlySet(string $key, mixed $value, array $expected): void
+    {
+        $builder = $this->getConvertPdfBuilder();
+        $builder->setConfigurations([
+            $key => $value,
+        ]);
+        $builder->files(self::PDF_DOCUMENTS_DIR.'/document.pdf');
+
+        self::assertEquals($expected, $builder->getMultipartFormData()[0]);
+    }
+
+    public function testRequiredFormat(): void
+    {
+        $builder = $this->getConvertPdfBuilder();
+        $builder
+            ->files(self::PDF_DOCUMENTS_DIR.'/document.pdf')
+        ;
+
+        $this->expectException(MissingRequiredFieldException::class);
+        $this->expectExceptionMessage('At least "pdfa" or "pdfua" must be provided.');
+
+        $builder->getMultipartFormData();
+    }
+
+    public function testRequiredPdfFile(): void
+    {
+        $builder = $this->getConvertPdfBuilder();
+        $builder->pdfUniversalAccess();
+
+        $this->expectException(MissingRequiredFieldException::class);
+        $this->expectExceptionMessage('At least one PDF file is required');
+
+        $builder->getMultipartFormData();
+    }
+
+    private function getConvertPdfBuilder(): ConvertPdfBuilder
+    {
+        return new ConvertPdfBuilder($this->gotenbergClient, self::$assetBaseDirFormatter);
+    }
+}