Merge pull request PrestaShop#41527 from tleon/Issue-24421-migrate-merchandise-return

Migrate merchandise return

Author: nicosomb

admin-dev/themes/new-theme/.webpack/common.js

@@ -112,7 +112,8 @@ module.exports = {
     maintenance: './js/pages/maintenance',
     manufacturer: './js/pages/manufacturer',
     manufacturer_address_form: './js/pages/manufacturer/manufacturer_address_form',
-    merchandise_return: './js/pages/merchandise-return',
+    order_return: './js/pages/order-return',
+    order_return_form: './js/pages/order-return/form',
     meta: './js/pages/meta',
     module: './js/pages/module',
     module_card: './js/app/pages/module-card',

admin-dev/themes/new-theme/js/pages/order-return/form.ts

@@ -0,0 +1,112 @@
+/**
+ * For the full copyright and license information, please view the
+ * docs/licenses/LICENSE.txt file that was distributed with this source code.
+ */
+
+/**
+ * Merchandise return edit page — deferred deletion of returned products (Issue #27628).
+ *
+ * When the merchant clicks the per-row "Delete" button we open a confirmation modal but
+ * do NOT call the back end. Instead the row is visually marked as staged-for-deletion and
+ * the row's (id_order_detail, id_customization) pair is appended to a hidden JSON field.
+ * The actual removal happens server-side when the form is submitted via the main "Save"
+ * button, processed by OrderReturnFormDataHandler.
+ */
+
+type StagedRow = {
+  order_detail_id: number;
+  customization_id: number;
+};
+
+const SELECTORS = {
+  deleteButton: '[data-role="order-return-delete-product"]',
+  productRow: '[data-role="order-return-product-row"]',
+  stagedField: '[data-role="order-return-staged-deletions"]',
+  modal: '#orderReturnDeleteProductModal',
+  modalConfirmButton: '[data-role="order-return-confirm-delete-product"]',
+} as const;
+
+const STAGED_ROW_CSS_CLASS = 'order-return-row-staged-for-deletion';
+
+class OrderReturnDeletionStager {
+  private readonly $form: JQuery;
+
+  private readonly $modal: JQuery;
+
+  private $pendingRow: JQuery | null = null;
+
+  constructor($form: JQuery) {
+    this.$form = $form;
+    this.$modal = $(SELECTORS.modal);
+    this.bind();
+  }
+
+  private bind(): void {
+    this.$form.on('click', SELECTORS.deleteButton, (event) => {
+      event.preventDefault();
+      this.$pendingRow = $(event.currentTarget).closest(SELECTORS.productRow);
+      this.$modal.modal('show');
+    });
+
+    this.$modal.on('click', SELECTORS.modalConfirmButton, () => {
+      if (this.$pendingRow !== null) {
+        this.stageRow(this.$pendingRow);
+        this.$pendingRow = null;
+      }
+      this.$modal.modal('hide');
+    });
+
+    this.$modal.on('hidden.bs.modal', () => {
+      this.$pendingRow = null;
+    });
+  }
+
+  private stageRow($row: JQuery): void {
+    const orderDetailId = parseInt($row.data('order-detail-id'), 10);
+    const customizationId = parseInt($row.data('customization-id'), 10);
+
+    if (Number.isNaN(orderDetailId) || orderDetailId <= 0) {
+      return;
+    }
+
+    // Visual feedback — strike-through + dim, plus disable any further interaction in the row.
+    $row.addClass(STAGED_ROW_CSS_CLASS);
+    $row.find(SELECTORS.deleteButton).attr('disabled', 'disabled');
+
+    // Update the hidden JSON payload that OrderReturnFormDataHandler reads on submit.
+    const $stagedField = this.$form.find(SELECTORS.stagedField);
+    const existing: StagedRow[] = OrderReturnDeletionStager.parseField($stagedField.val());
+
+    if (!existing.some((row) => row.order_detail_id === orderDetailId
+        && row.customization_id === (Number.isNaN(customizationId) ? 0 : customizationId))) {
+      existing.push({
+        order_detail_id: orderDetailId,
+        customization_id: Number.isNaN(customizationId) ? 0 : customizationId,
+      });
+    }
+    $stagedField.val(JSON.stringify(existing));
+  }
+
+  private static parseField(raw: unknown): StagedRow[] {
+    if (typeof raw !== 'string' || raw === '') {
+      return [];
+    }
+    try {
+      const decoded = JSON.parse(raw);
+
+      return Array.isArray(decoded) ? decoded as StagedRow[] : [];
+    } catch (_error) {
+      return [];
+    }
+  }
+}
+
+$(() => {
+  const $form = $(SELECTORS.stagedField).closest('form');
+
+  if ($form.length === 0) {
+    return;
+  }
+  // eslint-disable-next-line no-new
+  new OrderReturnDeletionStager($form);
+});

…eme/js/pages/merchandise-return/index.ts …new-theme/js/pages/order-return/index.tsadmin-dev/themes/new-theme/js/pages/merchandise-return/index.ts renamed to admin-dev/themes/new-theme/js/pages/order-return/index.ts admin-dev/themes/new-theme/js/pages/merchandise-return/index.ts renamed to admin-dev/themes/new-theme/js/pages/order-return/index.ts

@@ -12,7 +12,12 @@ $(() => {
   );
 
   const grid = new window.prestashop.component.Grid('merchandise_return');
+  grid.addExtension(new window.prestashop.component.GridExtensions.BulkActionCheckboxExtension());
+  grid.addExtension(new window.prestashop.component.GridExtensions.SubmitBulkActionExtension());
   grid.addExtension(new window.prestashop.component.GridExtensions.SortingExtension());
   grid.addExtension(new window.prestashop.component.GridExtensions.FiltersResetExtension());
+  grid.addExtension(new window.prestashop.component.GridExtensions.ReloadListExtension());
+  grid.addExtension(new window.prestashop.component.GridExtensions.SubmitRowActionExtension());
   grid.addExtension(new window.prestashop.component.GridExtensions.FiltersSubmitButtonEnablerExtension());
+  grid.addExtension(new window.prestashop.component.GridExtensions.LinkRowActionExtension());
 });

src/Adapter/OrderReturn/CommandHandler/BulkDeleteOrderReturnsHandler.php

@@ -0,0 +1,68 @@
+<?php
+/**
+ * For the full copyright and license information, please view the
+ * docs/licenses/LICENSE.txt file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace PrestaShop\PrestaShop\Adapter\OrderReturn\CommandHandler;
+
+use PrestaShop\PrestaShop\Adapter\OrderReturn\Repository\OrderReturnRepository;
+use PrestaShop\PrestaShop\Core\CommandBus\Attributes\AsCommandHandler;
+use PrestaShop\PrestaShop\Core\Domain\AbstractBulkCommandHandler;
+use PrestaShop\PrestaShop\Core\Domain\Exception\BulkCommandExceptionInterface;
+use PrestaShop\PrestaShop\Core\Domain\OrderReturn\Command\BulkDeleteOrderReturnsCommand;
+use PrestaShop\PrestaShop\Core\Domain\OrderReturn\CommandHandler\BulkDeleteOrderReturnsHandlerInterface;
+use PrestaShop\PrestaShop\Core\Domain\OrderReturn\Exception\BulkDeleteOrderReturnsException;
+use PrestaShop\PrestaShop\Core\Domain\OrderReturn\Exception\DeleteOrderReturnException;
+use PrestaShop\PrestaShop\Core\Domain\OrderReturn\ValueObject\OrderReturnId;
+
+#[AsCommandHandler]
+class BulkDeleteOrderReturnsHandler extends AbstractBulkCommandHandler implements BulkDeleteOrderReturnsHandlerInterface
+{
+    private OrderReturnRepository $orderReturnRepository;
+
+    public function __construct(OrderReturnRepository $orderReturnRepository)
+    {
+        $this->orderReturnRepository = $orderReturnRepository;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function handle(BulkDeleteOrderReturnsCommand $command): void
+    {
+        $orderReturnIds = $command->getOrderReturnIds();
+        if ($orderReturnIds === []) {
+            return;
+        }
+
+        $this->handleBulkAction($orderReturnIds, DeleteOrderReturnException::class);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function handleSingleAction(mixed $id, mixed $command): void
+    {
+        /* @var OrderReturnId $id */
+        $this->orderReturnRepository->delete($id);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function supports($id): bool
+    {
+        return $id instanceof OrderReturnId;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function buildBulkException(array $caughtExceptions): BulkCommandExceptionInterface
+    {
+        return new BulkDeleteOrderReturnsException($caughtExceptions);
+    }
+}

src/Adapter/OrderReturn/CommandHandler/BulkDeleteProductsFromOrderReturnHandler.php

@@ -0,0 +1,82 @@
+<?php
+/**
+ * For the full copyright and license information, please view the
+ * docs/licenses/LICENSE.txt file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace PrestaShop\PrestaShop\Adapter\OrderReturn\CommandHandler;
+
+use PrestaShop\PrestaShop\Adapter\OrderReturn\Repository\OrderReturnRepository;
+use PrestaShop\PrestaShop\Core\CommandBus\Attributes\AsCommandHandler;
+use PrestaShop\PrestaShop\Core\Domain\AbstractBulkCommandHandler;
+use PrestaShop\PrestaShop\Core\Domain\Exception\BulkCommandExceptionInterface;
+use PrestaShop\PrestaShop\Core\Domain\OrderReturn\Command\BulkDeleteProductsFromOrderReturnCommand;
+use PrestaShop\PrestaShop\Core\Domain\OrderReturn\CommandHandler\BulkDeleteProductsFromOrderReturnHandlerInterface;
+use PrestaShop\PrestaShop\Core\Domain\OrderReturn\Exception\BulkDeleteProductsFromOrderReturnException;
+use PrestaShop\PrestaShop\Core\Domain\OrderReturn\Exception\CannotDeleteLastProductFromOrderReturnException;
+use PrestaShop\PrestaShop\Core\Domain\OrderReturn\Exception\DeleteProductFromOrderReturnException;
+use PrestaShop\PrestaShop\Core\Domain\OrderReturn\ValueObject\OrderReturnProductId;
+
+#[AsCommandHandler]
+class BulkDeleteProductsFromOrderReturnHandler extends AbstractBulkCommandHandler implements BulkDeleteProductsFromOrderReturnHandlerInterface
+{
+    /**
+     * @var OrderReturnRepository
+     */
+    private $orderReturnRepository;
+
+    public function __construct(OrderReturnRepository $orderReturnRepository)
+    {
+        $this->orderReturnRepository = $orderReturnRepository;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function handle(BulkDeleteProductsFromOrderReturnCommand $command): void
+    {
+        $productIds = $command->getProductIds();
+        if ($productIds === []) {
+            return;
+        }
+
+        // Pre-check the legacy parity guard once, before any row deletion, so partial bulk
+        // deletes can never leave the return empty.
+        $currentCount = $this->orderReturnRepository->countProductLines($command->getOrderReturnId());
+        if ($currentCount - count($productIds) < 1) {
+            throw new CannotDeleteLastProductFromOrderReturnException(
+                'A merchandise return must contain at least one product after deletion.'
+            );
+        }
+
+        $this->handleBulkAction($productIds, DeleteProductFromOrderReturnException::class, $command);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function handleSingleAction(mixed $id, mixed $command): void
+    {
+        /* @var OrderReturnProductId $id */
+        /* @var BulkDeleteProductsFromOrderReturnCommand $command */
+        $this->orderReturnRepository->deleteProductLine($command->getOrderReturnId(), $id);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function supports($id): bool
+    {
+        return $id instanceof OrderReturnProductId;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function buildBulkException(array $caughtExceptions): BulkCommandExceptionInterface
+    {
+        return new BulkDeleteProductsFromOrderReturnException($caughtExceptions);
+    }
+}

src/Adapter/OrderReturn/CommandHandler/DeleteOrderReturnHandler.php

@@ -0,0 +1,33 @@
+<?php
+/**
+ * For the full copyright and license information, please view the
+ * docs/licenses/LICENSE.txt file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace PrestaShop\PrestaShop\Adapter\OrderReturn\CommandHandler;
+
+use PrestaShop\PrestaShop\Adapter\OrderReturn\Repository\OrderReturnRepository;
+use PrestaShop\PrestaShop\Core\CommandBus\Attributes\AsCommandHandler;
+use PrestaShop\PrestaShop\Core\Domain\OrderReturn\Command\DeleteOrderReturnCommand;
+use PrestaShop\PrestaShop\Core\Domain\OrderReturn\CommandHandler\DeleteOrderReturnHandlerInterface;
+
+#[AsCommandHandler]
+class DeleteOrderReturnHandler implements DeleteOrderReturnHandlerInterface
+{
+    private OrderReturnRepository $orderReturnRepository;
+
+    public function __construct(OrderReturnRepository $orderReturnRepository)
+    {
+        $this->orderReturnRepository = $orderReturnRepository;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function handle(DeleteOrderReturnCommand $command): void
+    {
+        $this->orderReturnRepository->delete($command->getOrderReturnId());
+    }
+}

src/Adapter/OrderReturn/CommandHandler/DeleteProductFromOrderReturnHandler.php

@@ -0,0 +1,44 @@
+<?php
+/**
+ * For the full copyright and license information, please view the
+ * docs/licenses/LICENSE.txt file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace PrestaShop\PrestaShop\Adapter\OrderReturn\CommandHandler;
+
+use PrestaShop\PrestaShop\Adapter\OrderReturn\Repository\OrderReturnRepository;
+use PrestaShop\PrestaShop\Core\CommandBus\Attributes\AsCommandHandler;
+use PrestaShop\PrestaShop\Core\Domain\OrderReturn\Command\DeleteProductFromOrderReturnCommand;
+use PrestaShop\PrestaShop\Core\Domain\OrderReturn\CommandHandler\DeleteProductFromOrderReturnHandlerInterface;
+use PrestaShop\PrestaShop\Core\Domain\OrderReturn\Exception\CannotDeleteLastProductFromOrderReturnException;
+
+#[AsCommandHandler]
+class DeleteProductFromOrderReturnHandler implements DeleteProductFromOrderReturnHandlerInterface
+{
+    /**
+     * @var OrderReturnRepository
+     */
+    private $orderReturnRepository;
+
+    public function __construct(OrderReturnRepository $orderReturnRepository)
+    {
+        $this->orderReturnRepository = $orderReturnRepository;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function handle(DeleteProductFromOrderReturnCommand $command): void
+    {
+        // Mirrors AdminReturnController::postProcess: the operation must leave at least one row.
+        if ($this->orderReturnRepository->countProductLines($command->getOrderReturnId()) <= 1) {
+            throw new CannotDeleteLastProductFromOrderReturnException(
+                'A merchandise return must contain at least one product.'
+            );
+        }
+
+        $this->orderReturnRepository->deleteProductLine($command->getOrderReturnId(), $command->getProductId());
+    }
+}