fix(api): fix the search endpoint types

Author: tleon

config/admin/services.yml

@@ -36,3 +36,10 @@ services:
   PrestaShop\Module\APIResources\ApiPlatform\Normalizer\CountryIdNormalizer:
     tags:
       - { name: 'serializer.normalizer', priority: 100 }
+
+  PrestaShopBundle\ApiPlatform\Serializer\CQRSApiSerializer:
+    class: PrestaShop\Module\APIResources\Serializer\QueryParameterTypeCastSerializer
+    decorates: 'api_platform.serializer'
+    autowire: true
+    arguments:
+      $decorated: '@.inner'

src/ApiPlatform/Resources/Product/FoundProduct.php

@@ -24,50 +24,83 @@
 
 use ApiPlatform\Metadata\ApiProperty;
 use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\QueryParameter;
 use PrestaShop\PrestaShop\Core\Domain\Product\Query\SearchProducts;
 use PrestaShopBundle\ApiPlatform\Metadata\CQRSGetCollection;
 
 #[ApiResource(
     operations: [
         new CQRSGetCollection(
-            uriTemplate: '/products/search/{phrase}/{resultsLimit}/{isoCode}',
+            uriTemplate: '/products/search',
+            scopes: [
+                'product_read',
+            ],
+            CQRSQuery: SearchProducts::class,
+            parameters: [
+                new QueryParameter(
+                    key: 'phrase',
+                    required: true,
+                    description: 'Search phrase to find products'
+                ),
+                new QueryParameter(
+                    key: 'resultsLimit',
+                    schema: ['type' => 'integer', 'default' => 20],
+                    required: true,
+                    description: 'Maximum number of results to return'
+                ),
+                new QueryParameter(
+                    key: 'isoCode',
+                    required: true,
+                    description: 'Currency ISO code (e.g., EUR, USD)'
+                ),
+                new QueryParameter(
+                    key: 'orderId',
+                    schema: ['type' => 'integer'],
+                    required: false,
+                    description: 'Optional order ID for context-specific pricing'
+                ),
+            ],
             openapiContext: [
                 'parameters' => [
                     [
                         'name' => 'phrase',
-                        'in' => 'path',
+                        'in' => 'query',
                         'required' => true,
                         'schema' => [
                             'type' => 'string',
                         ],
+                        'description' => 'Search phrase to find products',
                     ],
                     [
                         'name' => 'resultsLimit',
-                        'in' => 'path',
+                        'in' => 'query',
                         'required' => true,
                         'schema' => [
-                            'type' => 'int',
+                            'type' => 'integer',
+                            'default' => 20,
                         ],
+                        'description' => 'Maximum number of results to return',
                     ],
                     [
                         'name' => 'isoCode',
-                        'in' => 'path',
+                        'in' => 'query',
                         'required' => true,
                         'schema' => [
                             'type' => 'string',
                         ],
+                        'description' => 'Currency ISO code (e.g., EUR, USD)',
                     ],
                     [
                         'name' => 'orderId',
                         'in' => 'query',
                         'required' => false,
                         'schema' => [
-                            'type' => 'int',
+                            'type' => 'integer',
                         ],
+                        'description' => 'Optional order ID for context-specific pricing',
                     ],
                 ],
-            ],
-            CQRSQuery: SearchProducts::class
+            ]
         ),
     ],
 )]

src/Serializer/QueryParameterTypeCastSerializer.php

@@ -0,0 +1,102 @@
+<?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\Serializer;
+
+use PrestaShopBundle\ApiPlatform\ContextParametersProvider;
+use PrestaShopBundle\ApiPlatform\LocalizedValueUpdater;
+use PrestaShopBundle\ApiPlatform\NormalizationMapper;
+use PrestaShopBundle\ApiPlatform\Serializer\CQRSApiSerializer;
+use ReflectionClass;
+use ReflectionException;
+use ReflectionNamedType;
+use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactoryInterface;
+use Symfony\Component\Serializer\Serializer;
+
+/**
+ * Extends CQRSApiSerializer to add automatic type casting for query parameters.
+ */
+class QueryParameterTypeCastSerializer extends CQRSApiSerializer
+{
+    public function __construct(
+        Serializer $decorated,
+        ContextParametersProvider $contextParametersProvider,
+        ClassMetadataFactoryInterface $classMetadataFactory,
+        LocalizedValueUpdater $localizedValueUpdater,
+        NormalizationMapper $normalizationMapper,
+    ) {
+        parent::__construct($decorated, $contextParametersProvider, $classMetadataFactory, $localizedValueUpdater, $normalizationMapper);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function denormalize(mixed $data, string $type, ?string $format = null, array $context = []): mixed
+    {
+        if (is_array($data) && str_starts_with($type, 'PrestaShop\\PrestaShop\\Core\\Domain\\')) {
+            $data = $this->castQueryParametersToExpectedTypes($data, $type);
+        }
+
+        return parent::denormalize($data, $type, $format, $context);
+    }
+
+    /**
+     * Cast string query parameter values to their expected types based on the CQRS query constructor.
+     */
+    private function castQueryParametersToExpectedTypes(array $data, string $queryClass): array
+    {
+        try {
+            $reflection = new ReflectionClass($queryClass);
+            $constructor = $reflection->getConstructor();
+
+            if (!$constructor) {
+                return $data;
+            }
+
+            foreach ($constructor->getParameters() as $parameter) {
+                $paramName = $parameter->getName();
+
+                if (!array_key_exists($paramName, $data) || !is_string($data[$paramName])) {
+                    continue;
+                }
+
+                $type = $parameter->getType();
+
+                if (!$type instanceof ReflectionNamedType || !$type->isBuiltin()) {
+                    continue;
+                }
+
+                $data[$paramName] = match ($type->getName()) {
+                    'int' => (int) $data[$paramName],
+                    'float' => (float) $data[$paramName],
+                    'bool' => filter_var($data[$paramName], FILTER_VALIDATE_BOOLEAN),
+                    default => $data[$paramName],
+                };
+            }
+        } catch (ReflectionException $e) {
+            return $data;
+        }
+
+        return $data;
+    }
+}
+