Add carrier endpoints

TODO.md

@@ -0,0 +1,22 @@
+# TODO
+
+## GET /carriers/{carrierId}/ranges — Core limitation
+
+**Stato:** Endpoint implementato ma non funzionante (restituisce 422)
+
+**Causa:** `CarrierRangeRepository::assertShopConstraint()` nel core PrestaShop accetta
+solo `ShopConstraint::allShops()`, ma il framework API passa sempre un constraint
+shop-specifico (es. `shopId=1`). La funzione `applyShopConstraint()` ha un TODO
+irrisolto nel core.
+
+**File coinvolti:**
+- Modulo: `src/ApiPlatform/Resources/Carrier/CarrierRanges.php`
+- Core PS: `src/Adapter/Carrier/Repository/CarrierRangeRepository.php` (righe 220-237)
+
+**Fix richiesto:**
+1. Aprire una issue/PR nel repo `PrestaShop/PrestaShop` per implementare
+   `CarrierRangeRepository::applyShopConstraint()` con supporto ai constraint shop-specifici
+2. Una volta fixato il core, verificare che l'endpoint funzioni correttamente
+3. Valutare se rimuovere o mantenere il mapping `CarrierConstraintException → 422`
+
+**Workaround attuale:** `CarrierConstraintException` mappata a HTTP 422 invece di 500.

src/ApiPlatform/Resources/Address/Address.php

@@ -22,6 +22,7 @@
 
 use ApiPlatform\Metadata\ApiProperty;
 use ApiPlatform\Metadata\ApiResource;
+use ApiPlatform\Metadata\NotExposed;
 use PrestaShop\PrestaShop\Core\Domain\Address\Command\DeleteAddressCommand;
 use PrestaShop\PrestaShop\Core\Domain\Address\Exception\AddressConstraintException;
 use PrestaShop\PrestaShop\Core\Domain\Address\Exception\AddressNotFoundException;
@@ -38,6 +39,10 @@
                 'address_write',
             ],
         ),
+        new NotExposed(
+            uriTemplate: '/addresses/{addressId}',
+            requirements: ['addressId' => '\d+'],
+        ),
     ],
     exceptionToStatus: [
         AddressConstraintException::class => Response::HTTP_UNPROCESSABLE_ENTITY,

src/ApiPlatform/Resources/Address/AddressRequiredFields.php

@@ -0,0 +1,54 @@
+<?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\ApiPlatform\Resources\Address;
+
+use ApiPlatform\Metadata\ApiProperty;
+use ApiPlatform\Metadata\ApiResource;
+use PrestaShop\PrestaShop\Core\Domain\Address\Query\GetRequiredFieldsForAddress;
+use PrestaShopBundle\ApiPlatform\Metadata\CQRSGet;
+
+#[ApiResource(
+    operations: [
+        new CQRSGet(
+            uriTemplate: '/addresses/required-fields',
+            CQRSQuery: GetRequiredFieldsForAddress::class,
+            scopes: ['address_read'],
+            CQRSQueryMapping: ['[@index]' => '[requiredFields][@index]'],
+        ),
+    ],
+    normalizationContext: ['skip_null_values' => false],
+)]
+class AddressRequiredFields
+{
+    /**
+     * @var string[]
+     */
+    #[ApiProperty(
+        openapiContext: [
+            'type' => 'array',
+            'items' => ['type' => 'string'],
+            'example' => ['phone', 'company'],
+        ]
+    )]
+    public array $requiredFields = [];
+}

src/ApiPlatform/Resources/Carrier/BulkCarriers.php

@@ -0,0 +1,65 @@
+<?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\ApiPlatform\Resources\Carrier;
+
+use ApiPlatform\Metadata\ApiProperty;
+use ApiPlatform\Metadata\ApiResource;
+use PrestaShop\PrestaShop\Core\Domain\Carrier\Command\BulkToggleCarrierStatusCommand;
+use PrestaShop\PrestaShop\Core\Domain\Carrier\Exception\CarrierConstraintException;
+use PrestaShopBundle\ApiPlatform\Metadata\CQRSUpdate;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Validator\Constraints as Assert;
+
+#[ApiResource(
+    operations: [
+        new CQRSUpdate(
+            uriTemplate: '/carriers/bulk-set-status',
+            output: false,
+            CQRSCommand: BulkToggleCarrierStatusCommand::class,
+            CQRSCommandMapping: [
+                '[enabled]' => '[expectedStatus]',
+            ],
+            scopes: [
+                'carrier_write',
+            ],
+        ),
+    ],
+    exceptionToStatus: [
+        CarrierConstraintException::class => Response::HTTP_UNPROCESSABLE_ENTITY,
+    ],
+)]
+class BulkCarriers
+{
+    /**
+     * @var int[]
+     */
+    #[ApiProperty(openapiContext: ['type' => 'array', 'items' => ['type' => 'integer'], 'example' => [1, 3]])]
+    #[Assert\NotBlank]
+    #[Assert\All([
+        new Assert\Type('numeric'),
+        new Assert\Positive(),
+    ])]
+    public array $carrierIds;
+
+    public bool $enabled;
+}

src/ApiPlatform/Resources/Carrier/Carrier.php

@@ -0,0 +1,130 @@
+<?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\ApiPlatform\Resources\Carrier;
+
+use ApiPlatform\Metadata\ApiProperty;
+use ApiPlatform\Metadata\ApiResource;
+use PrestaShop\PrestaShop\Core\Domain\Carrier\Command\DeleteCarrierCommand;
+use PrestaShop\PrestaShop\Core\Domain\Carrier\Command\ToggleCarrierIsFreeCommand;
+use PrestaShop\PrestaShop\Core\Domain\Carrier\Command\ToggleCarrierStatusCommand;
+use PrestaShop\PrestaShop\Core\Domain\Carrier\Exception\CarrierConstraintException;
+use PrestaShop\PrestaShop\Core\Domain\Carrier\Exception\CarrierNotFoundException;
+use PrestaShop\PrestaShop\Core\Domain\Carrier\Query\GetCarrierForEditing;
+use PrestaShopBundle\ApiPlatform\Metadata\CQRSDelete;
+use PrestaShopBundle\ApiPlatform\Metadata\CQRSGet;
+use PrestaShopBundle\ApiPlatform\Metadata\CQRSUpdate;
+use PrestaShopBundle\ApiPlatform\Metadata\LocalizedValue;
+use Symfony\Component\HttpFoundation\Response;
+
+#[ApiResource(
+    operations: [
+        new CQRSGet(
+            uriTemplate: '/carriers/{carrierId}',
+            requirements: ['carrierId' => '\d+'],
+            CQRSQuery: GetCarrierForEditing::class,
+            scopes: ['carrier_read'],
+            CQRSQueryMapping: self::QUERY_MAPPING,
+        ),
+        new CQRSUpdate(
+            uriTemplate: '/carriers/{carrierId}/toggle-status',
+            requirements: ['carrierId' => '\d+'],
+            output: false,
+            allowEmptyBody: true,
+            CQRSCommand: ToggleCarrierStatusCommand::class,
+            scopes: ['carrier_write'],
+        ),
+        new CQRSUpdate(
+            uriTemplate: '/carriers/{carrierId}/toggle-is-free',
+            requirements: ['carrierId' => '\d+'],
+            output: false,
+            allowEmptyBody: true,
+            CQRSCommand: ToggleCarrierIsFreeCommand::class,
+            scopes: ['carrier_write'],
+        ),
+        new CQRSDelete(
+            uriTemplate: '/carriers/{carrierId}',
+            requirements: ['carrierId' => '\d+'],
+            CQRSCommand: DeleteCarrierCommand::class,
+            scopes: ['carrier_write'],
+        ),
+    ],
+    normalizationContext: ['skip_null_values' => false],
+    exceptionToStatus: [
+        CarrierNotFoundException::class => Response::HTTP_NOT_FOUND,
+        CarrierConstraintException::class => Response::HTTP_UNPROCESSABLE_ENTITY,
+    ],
+)]
+class Carrier
+{
+    #[ApiProperty(identifier: true)]
+    public int $carrierId;
+
+    public string $name;
+
+    public int $grade;
+
+    public string $trackingUrl;
+
+    public int $position;
+
+    public bool $active;
+
+    #[LocalizedValue]
+    public array $delay;
+
+    public ?string $logoPath;
+
+    public int $maxWidth;
+
+    public int $maxHeight;
+
+    public int $maxDepth;
+
+    public float $maxWeight;
+
+    #[ApiProperty(openapiContext: ['type' => 'array', 'items' => ['type' => 'integer'], 'example' => [1, 3]])]
+    public array $associatedGroupIds;
+
+    public bool $hasAdditionalHandlingFee;
+
+    public bool $isFree;
+
+    public int $shippingMethod;
+
+    public int $idTaxRuleGroup;
+
+    public int $rangeBehavior;
+
+    #[ApiProperty(openapiContext: ['type' => 'array', 'items' => ['type' => 'integer'], 'example' => [1, 3]])]
+    public array $associatedShopIds;
+
+    #[ApiProperty(openapiContext: ['type' => 'array', 'items' => ['type' => 'object']])]
+    public array $zones;
+
+    public int $ordersCount;
+
+    public const QUERY_MAPPING = [
+        '[_context][shopConstraint]' => '[shopConstraint]',
+        '[localizedDelay]' => '[delay]',
+    ];
+}

src/ApiPlatform/Resources/Carrier/CarrierList.php

@@ -0,0 +1,71 @@
+<?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\ApiPlatform\Resources\Carrier;
+
+use ApiPlatform\Metadata\ApiProperty;
+use ApiPlatform\Metadata\ApiResource;
+use PrestaShop\PrestaShop\Core\Domain\Carrier\Exception\CarrierNotFoundException;
+use PrestaShop\PrestaShop\Core\Search\Filters\CarrierFilters;
+use PrestaShopBundle\ApiPlatform\Metadata\PaginatedList;
+use PrestaShopBundle\ApiPlatform\Provider\QueryListProvider;
+use Symfony\Component\HttpFoundation\Response;
+
+#[ApiResource(
+    operations: [
+        new PaginatedList(
+            uriTemplate: '/carriers',
+            provider: QueryListProvider::class,
+            scopes: ['carrier_read'],
+            ApiResourceMapping: [
+                '[id_carrier]' => '[carrierId]',
+                '[is_free]' => '[isFree]',
+            ],
+            gridDataFactory: 'prestashop.core.grid.data.factory.carrier',
+            filtersClass: CarrierFilters::class,
+            filtersMapping: [
+                '[carrierId]' => '[id_carrier]',
+                '[isFree]' => '[is_free]',
+            ],
+        ),
+    ],
+    exceptionToStatus: [
+        CarrierNotFoundException::class => Response::HTTP_NOT_FOUND,
+    ],
+)]
+class CarrierList
+{
+    #[ApiProperty(identifier: true)]
+    public int $carrierId;
+
+    public string $name;
+
+    public ?string $delay;
+
+    public bool $active;
+
+    public bool $isFree;
+
+    public int $position;
+
+    public ?string $logo;
+}