Create API Access page with grid and basic form

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

@@ -41,6 +41,7 @@ module.exports = {
   },
   entry: {
     address: './js/pages/address',
+    api_access: './js/pages/api-access',
     attachment: './js/pages/attachment',
     attribute: './js/pages/attribute',
     attribute_group: './js/pages/attribute-group',

admin-dev/themes/new-theme/js/pages/api-access/index.ts

@@ -0,0 +1,47 @@
+/**
+ * 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 Open Software License (OSL 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/OSL-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.
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ * versions in the future. If you wish to customize PrestaShop for your
+ * needs please refer to https://devdocs.prestashop.com/ for more information.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
+ */
+
+import Grid from '@components/grid/grid';
+import SortingExtension from '@components/grid/extension/sorting-extension';
+import FiltersResetExtension from '@components/grid/extension/filters-reset-extension';
+import ReloadListActionExtension from '@components/grid/extension/reload-list-extension';
+import SubmitRowActionExtension from '@components/grid/extension/action/row/submit-row-action-extension';
+import ExportToSqlManagerExtension from '@components/grid/extension/export-to-sql-manager-extension';
+import FiltersSubmitButtonEnablerExtension from '@components/grid/extension/filters-submit-button-enabler-extension';
+import AsyncToggleColumnExtension from '@components/grid/extension/column/common/async-toggle-column-extension';
+
+const {$} = window;
+
+$(() => {
+  const grid = new Grid('api_access');
+
+  grid.addExtension(new ExportToSqlManagerExtension());
+  grid.addExtension(new ReloadListActionExtension());
+  grid.addExtension(new SortingExtension());
+  grid.addExtension(new FiltersResetExtension());
+  grid.addExtension(new SubmitRowActionExtension());
+  grid.addExtension(new FiltersSubmitButtonEnablerExtension());
+  grid.addExtension(new AsyncToggleColumnExtension());
+});

src/Adapter/ApiAccess/CommandHandler/DeleteApiAccessHandler.php

@@ -0,0 +1,62 @@
+<?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 Open Software License (OSL 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/OSL-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.
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ * versions in the future. If you wish to customize PrestaShop for your
+ * needs please refer to https://devdocs.prestashop.com/ for more information.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
+ */
+
+declare(strict_types=1);
+
+namespace PrestaShop\PrestaShop\Adapter\ApiAccess\CommandHandler;
+
+use Doctrine\ORM\Exception\ORMException;
+use Doctrine\ORM\NoResultException;
+use PrestaShop\PrestaShop\Core\CommandBus\Attributes\AsCommandHandler;
+use PrestaShop\PrestaShop\Core\Domain\ApiAccess\Command\DeleteApiAccessCommand;
+use PrestaShop\PrestaShop\Core\Domain\ApiAccess\CommandHandler\DeleteApiAccessHandlerInterface;
+use PrestaShop\PrestaShop\Core\Domain\ApiAccess\Exception\ApiAccessNotFoundException;
+use PrestaShop\PrestaShop\Core\Domain\ApiAccess\Exception\CannotDeleteApiAccessException;
+use PrestaShopBundle\Entity\Repository\ApiAccessRepository;
+
+#[AsCommandHandler]
+class DeleteApiAccessHandler implements DeleteApiAccessHandlerInterface
+{
+    public function __construct(
+        private readonly ApiAccessRepository $repository,
+    ) {
+    }
+
+    public function handle(DeleteApiAccessCommand $command): void
+    {
+        try {
+            $apiAccess = $this->repository->getById($command->getApiAccessId()->getValue());
+        } catch (NoResultException $e) {
+            throw new ApiAccessNotFoundException(sprintf('Could not find Api access with ID %s', $command->getApiAccessId()->getValue()), 0, $e);
+        }
+
+        try {
+            $this->repository->delete($apiAccess);
+        } catch (ORMException $e) {
+            throw new CannotDeleteApiAccessException('Could not delete Api access', 0, $e);
+        }
+    }
+}

src/Adapter/ApiAccess/CommandHandler/EditApiAccessHandler.php

@@ -52,7 +52,7 @@ public function __construct(
     public function handle(EditApiAccessCommand $command): void
     {
         try {
-            $apiAccess = $this->repository->findOneBy(['id' => $command->getApiAccessId()->getValue()]);
+            $apiAccess = $this->repository->getById($command->getApiAccessId()->getValue());
         } catch (NoResultException $e) {
             throw new ApiAccessNotFoundException(sprintf('Could not find Api access %s', $command->getApiClientId()), 0, $e);
         }

src/Adapter/ApiAccess/QueryHandler/GetApiAccessForEditingHandler.php

@@ -47,7 +47,7 @@ public function __construct(private readonly ApiAccessRepository $repository)
     public function handle(GetApiAccessForEditing $query): EditableApiAccess
     {
         try {
-            $apiAccess = $this->repository->findOneBy(['id' => $query->getApiAccessId()->getValue()]);
+            $apiAccess = $this->repository->getById($query->getApiAccessId()->getValue());
         } catch (NoResultException $e) {
             throw new ApiAccessNotFoundException(sprintf('Could not find Api access %s', $query->getApiAccessId()->getValue()), 0, $e);
         }

src/Core/Domain/ApiAccess/ApiAccessSettings.php

@@ -0,0 +1,39 @@
+<?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 Open Software License (OSL 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/OSL-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.
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ * versions in the future. If you wish to customize PrestaShop for your
+ * needs please refer to https://devdocs.prestashop.com/ for more information.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
+ */
+
+declare(strict_types=1);
+
+namespace PrestaShop\PrestaShop\Core\Domain\ApiAccess;
+
+/**
+ * Defines settings for API Access.
+ */
+class ApiAccessSettings
+{
+    public const MAX_CLIENT_ID_LENGTH = 255;
+    public const MAX_CLIENT_NAME_LENGTH = 255;
+    public const MAX_DESCRIPTION_LENGTH = 21844;
+}

src/Core/Domain/ApiAccess/Command/DeleteApiAccessCommand.php

@@ -0,0 +1,46 @@
+<?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 Open Software License (OSL 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/OSL-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.
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ * versions in the future. If you wish to customize PrestaShop for your
+ * needs please refer to https://devdocs.prestashop.com/ for more information.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
+ */
+
+declare(strict_types=1);
+
+namespace PrestaShop\PrestaShop\Core\Domain\ApiAccess\Command;
+
+use PrestaShop\PrestaShop\Core\Domain\ApiAccess\ValueObject\ApiAccessId;
+
+class DeleteApiAccessCommand
+{
+    private ApiAccessId $apiAccessId;
+
+    public function __construct(int $apiAccessId)
+    {
+        $this->apiAccessId = new ApiAccessId($apiAccessId);
+    }
+
+    public function getApiAccessId(): ApiAccessId
+    {
+        return $this->apiAccessId;
+    }
+}

src/Core/Domain/ApiAccess/CommandHandler/DeleteApiAccessHandlerInterface.php

@@ -0,0 +1,36 @@
+<?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 Open Software License (OSL 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/OSL-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.
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ * versions in the future. If you wish to customize PrestaShop for your
+ * needs please refer to https://devdocs.prestashop.com/ for more information.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
+ */
+
+declare(strict_types=1);
+
+namespace PrestaShop\PrestaShop\Core\Domain\ApiAccess\CommandHandler;
+
+use PrestaShop\PrestaShop\Core\Domain\ApiAccess\Command\DeleteApiAccessCommand;
+
+interface DeleteApiAccessHandlerInterface
+{
+    public function handle(DeleteApiAccessCommand $command): void;
+}

src/Core/Domain/ApiAccess/Exception/CannotDeleteApiAccessException.php

@@ -0,0 +1,33 @@
+<?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 Open Software License (OSL 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/OSL-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.
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ * versions in the future. If you wish to customize PrestaShop for your
+ * needs please refer to https://devdocs.prestashop.com/ for more information.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
+ */
+
+declare(strict_types=1);
+
+namespace PrestaShop\PrestaShop\Core\Domain\ApiAccess\Exception;
+
+class CannotDeleteApiAccessException extends ApiAccessException
+{
+}

src/Core/Form/IdentifiableObject/DataHandler/ApiAccessFormDataHandler.php

@@ -0,0 +1,68 @@
+<?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 Open Software License (OSL 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/OSL-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.
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ * versions in the future. If you wish to customize PrestaShop for your
+ * needs please refer to https://devdocs.prestashop.com/ for more information.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
+ */
+
+declare(strict_types=1);
+
+namespace PrestaShop\PrestaShop\Core\Form\IdentifiableObject\DataHandler;
+
+use PrestaShop\PrestaShop\Core\CommandBus\CommandBusInterface;
+use PrestaShop\PrestaShop\Core\Domain\ApiAccess\Command\AddApiAccessCommand;
+use PrestaShop\PrestaShop\Core\Domain\ApiAccess\Command\EditApiAccessCommand;
+use PrestaShop\PrestaShop\Core\Domain\ApiAccess\ValueObject\ApiAccessId;
+
+class ApiAccessFormDataHandler implements FormDataHandlerInterface
+{
+    public function __construct(
+        private CommandBusInterface $commandBus
+    ) {
+    }
+
+    public function create(array $data)
+    {
+        /** @var ApiAccessId $apiAccessId */
+        $apiAccessId = $this->commandBus->handle(new AddApiAccessCommand(
+            $data['client_name'],
+            $data['client_id'],
+            (bool) $data['enabled'],
+            $data['description'],
+        ));
+
+        return $apiAccessId->getValue();
+    }
+
+    public function update($id, array $data)
+    {
+        $command = new EditApiAccessCommand((int) $id);
+        $command
+            ->setClientName($data['client_name'])
+            ->setApiClientId($data['client_id'])
+            ->setDescription($data['description'])
+            ->setEnabled((bool) $data['enabled'])
+        ;
+
+        $this->commandBus->handle($command);
+    }
+}