fix(api): fix the search endpoint types

Author: tleon

config/admin/services.yml

@@ -28,3 +28,9 @@ services:
   PrestaShop\Module\APIResources\Validation\IframeValidationGroupsResolver:
     arguments:
       - '@prestashop.adapter.legacy.configuration'
+
+  # Custom denormalizer to handle type conversion for SearchProducts query
+  PrestaShop\Module\APIResources\Normalizer\SearchProductsDenormalizer:
+    autowire: true
+    tags:
+      - { name: 'serializer.normalizer', priority: 10 }

src/ApiPlatform/Resources/Product/FoundProduct.php

@@ -31,6 +31,10 @@
     operations: [
         new CQRSGetCollection(
             uriTemplate: '/products/search/{phrase}/{resultsLimit}/{isoCode}',
+            scopes: [
+                'product_read',
+            ],
+            CQRSQuery: SearchProducts::class,
             openapiContext: [
                 'parameters' => [
                     [
@@ -46,7 +50,7 @@
                         'in' => 'path',
                         'required' => true,
                         'schema' => [
-                            'type' => 'int',
+                            'type' => 'integer',
                         ],
                     ],
                     [
@@ -62,12 +66,11 @@
                         'in' => 'query',
                         'required' => false,
                         'schema' => [
-                            'type' => 'int',
+                            'type' => 'integer',
                         ],
                     ],
                 ],
-            ],
-            CQRSQuery: SearchProducts::class
+            ]
         ),
     ],
 )]

src/Normalizer/SearchProductsDenormalizer.php

@@ -0,0 +1,94 @@
+<?php
+/**
+ * Copyright since 2007 PrestaShop SA and Contributors
+ * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Academic Free License version 3.0
+ * that is bundled with this package in the file LICENSE.md.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/AFL-3.0
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@prestashop.com so we can send you a copy immediately.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/AFL-3.0 Academic Free License version 3.0
+ */
+
+declare(strict_types=1);
+
+namespace PrestaShop\Module\APIResources\Normalizer;
+
+use PrestaShop\PrestaShop\Core\Domain\Product\Query\SearchProducts;
+use PrestaShopBundle\ApiPlatform\DomainObjectDetector;
+use PrestaShopBundle\ApiPlatform\LocalizedValueUpdater;
+use PrestaShopBundle\ApiPlatform\Normalizer\CQRSApiNormalizer;
+use PrestaShopBundle\ApiPlatform\Validator\CQRSApiValidator;
+use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
+use Symfony\Component\PropertyInfo\PropertyTypeExtractorInterface;
+use Symfony\Component\Serializer\Mapping\ClassDiscriminatorResolverInterface;
+use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
+use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
+
+class SearchProductsDenormalizer extends CQRSApiNormalizer
+{
+    public function __construct(
+        DomainObjectDetector $domainObjectDetector,
+        LocalizedValueUpdater $localizedValueUpdater,
+        CQRSApiValidator $CQRSApiValidator,
+        ?ClassMetadataFactoryInterface $classMetadataFactory = null,
+        ?NameConverterInterface $nameConverter = null,
+        ?PropertyAccessorInterface $propertyAccessor = null,
+        ?PropertyTypeExtractorInterface $propertyTypeExtractor = null,
+        ?ClassDiscriminatorResolverInterface $classDiscriminatorResolver = null,
+        ?callable $objectClassResolver = null,
+        array $defaultContext = [],
+    ) {
+        parent::__construct(
+            $domainObjectDetector,
+            $localizedValueUpdater,
+            $CQRSApiValidator,
+            $classMetadataFactory,
+            $nameConverter,
+            $propertyAccessor,
+            $propertyTypeExtractor,
+            $classDiscriminatorResolver,
+            $objectClassResolver,
+            $defaultContext
+        );
+    }
+
+    public function denormalize(mixed $data, string $type, ?string $format = null, array $context = []): mixed
+    {
+        if ($type === SearchProducts::class && is_array($data)) {
+            if (isset($data['resultsLimit']) && is_string($data['resultsLimit'])) {
+                $data['resultsLimit'] = (int) $data['resultsLimit'];
+            }
+
+            if (isset($data['orderId']) && is_string($data['orderId'])) {
+                $data['orderId'] = (int) $data['orderId'];
+            }
+        }
+
+        return parent::denormalize($data, $type, $format, $context);
+    }
+
+    public function supportsDenormalization(mixed $data, string $type, ?string $format = null, array $context = []): bool
+    {
+        if ($type === SearchProducts::class) {
+            return parent::supportsDenormalization($data, $type, $format, $context);
+        }
+
+        return false;
+    }
+
+    public function getSupportedTypes(?string $format): array
+    {
+        return [
+            SearchProducts::class => true,
+        ];
+    }
+}