fix(core): correct names of interfaces

config/pdk-services.php

@@ -48,7 +48,9 @@
 use MyParcelNL\Pdk\Notification\Service\NotificationService;
 use MyParcelNL\Pdk\Platform\PlatformManager;
 use MyParcelNL\Pdk\Platform\PlatformManagerInterface;
+use MyParcelNL\Pdk\Settings\Contract\PdkSettingsRepositoryInterface;
 use MyParcelNL\Pdk\Settings\Contract\SettingsManagerInterface;
+use MyParcelNL\Pdk\Settings\Contract\SettingsRepositoryInterface;
 use MyParcelNL\Pdk\Settings\SettingsManager;
 use MyParcelNL\Pdk\Shipment\Contract\DropOffServiceInterface;
 use MyParcelNL\Pdk\Shipment\Service\DropOffService;
@@ -185,6 +187,13 @@
         return \MyParcelNL\Pdk\Facade\Pdk::get(AccountRepositoryInterface::class);
     }),
 
+    /**
+     * @todo remove in v3.0.0
+     */
+    PdkSettingsRepositoryInterface::class      => factory(function () {
+        return \MyParcelNL\Pdk\Facade\Pdk::get(SettingsRepositoryInterface::class);
+    }),
+
     /**
      * Handles executing pdk actions.
      */

config/pdk-template.php

@@ -15,7 +15,7 @@
 use MyParcelNL\Pdk\Base\Contract\CronServiceInterface;
 use MyParcelNL\Pdk\Frontend\Contract\ViewServiceInterface;
 use MyParcelNL\Pdk\Language\Contract\LanguageServiceInterface;
-use MyParcelNL\Pdk\Settings\Contract\SettingsRepositoryInterface;
+use MyParcelNL\Pdk\Settings\Contract\PdkSettingsRepositoryInterface;
 use Psr\Log\LoggerInterface;
 use function DI\autowire;
 use function DI\value;
@@ -81,10 +81,10 @@
      * Handles settings being saved and retrieved in your app.
      *
      * @note Required for plugin settings.
-     * @see  \MyParcelNL\Pdk\Settings\Repository\AbstractSettingsRepository
+     * @see  \MyParcelNL\Pdk\Settings\Repository\AbstractPdkSettingsRepository
      */
 
-    SettingsRepositoryInterface::class => autowire(),
+    PdkSettingsRepositoryInterface::class => autowire(),
 
     /**
      * Handles conversion of your app's cart data to PDK cart data.

src/Account/Contract/AccountRepositoryInterface.php

@@ -8,6 +8,7 @@
 
 /**
  * @deprecated Will be removed in v3.0.0. Use PdkAccountRepositoryInterface instead.
+ * @todo       remove in v3.0.0
  */
 interface AccountRepositoryInterface extends PdkAccountRepositoryInterface
 {

src/App/Account/Repository/AbstractPdkAccountRepository.php

@@ -9,7 +9,7 @@
 use MyParcelNL\Pdk\App\Account\Contract\PdkAccountRepositoryInterface;
 use MyParcelNL\Pdk\Base\Repository\Repository;
 use MyParcelNL\Pdk\Facade\Settings;
-use MyParcelNL\Pdk\Settings\Contract\SettingsRepositoryInterface;
+use MyParcelNL\Pdk\Settings\Contract\PdkSettingsRepositoryInterface;
 use MyParcelNL\Pdk\Settings\Model\AccountSettings;
 use MyParcelNL\Pdk\Storage\Contract\StorageInterface;
 use Throwable;
@@ -22,19 +22,19 @@ abstract class AbstractPdkAccountRepository extends Repository implements PdkAcc
     private $accountRepository;
 
     /**
-     * @var \MyParcelNL\Pdk\Settings\Contract\SettingsRepositoryInterface
+     * @var \MyParcelNL\Pdk\Settings\Contract\PdkSettingsRepositoryInterface
      */
     private $settingsRepository;
 
     /**
-     * @param  \MyParcelNL\Pdk\Storage\Contract\StorageInterface             $storage
-     * @param  \MyParcelNL\Pdk\Account\Repository\AccountRepository          $accountRepository
-     * @param  \MyParcelNL\Pdk\Settings\Contract\SettingsRepositoryInterface $settingsRepository
+     * @param  \MyParcelNL\Pdk\Storage\Contract\StorageInterface                $storage
+     * @param  \MyParcelNL\Pdk\Account\Repository\AccountRepository             $accountRepository
+     * @param  \MyParcelNL\Pdk\Settings\Contract\PdkSettingsRepositoryInterface $settingsRepository
      */
     public function __construct(
-        StorageInterface            $storage,
-        AccountRepository           $accountRepository,
-        SettingsRepositoryInterface $settingsRepository
+        StorageInterface               $storage,
+        AccountRepository              $accountRepository,
+        PdkSettingsRepositoryInterface $settingsRepository
     ) {
         parent::__construct($storage);
         $this->accountRepository  = $accountRepository;

src/App/Action/Backend/Account/UpdateAccountAction.php

@@ -13,7 +13,7 @@
 use MyParcelNL\Pdk\App\Api\Shared\PdkSharedActions;
 use MyParcelNL\Pdk\Context\Context;
 use MyParcelNL\Pdk\Facade\Actions;
-use MyParcelNL\Pdk\Settings\Contract\SettingsRepositoryInterface;
+use MyParcelNL\Pdk\Settings\Contract\PdkSettingsRepositoryInterface;
 use MyParcelNL\Pdk\Settings\Model\AccountSettings;
 use RuntimeException;
 use Symfony\Component\HttpFoundation\Request;
@@ -37,20 +37,20 @@ class UpdateAccountAction implements ActionInterface
     protected $pdkAccountRepository;
 
     /**
-     * @var \MyParcelNL\Pdk\Settings\Contract\SettingsRepositoryInterface
+     * @var \MyParcelNL\Pdk\Settings\Contract\PdkSettingsRepositoryInterface
      */
     protected $pdkSettingsRepository;
 
     /**
      * @param  \MyParcelNL\Pdk\Account\Repository\ShopCarrierConfigurationRepository $carrierConfigurationRepository
      * @param  \MyParcelNL\Pdk\Account\Repository\ShopCarrierOptionsRepository       $carrierOptionsRepository
-     * @param  \MyParcelNL\Pdk\Settings\Contract\SettingsRepositoryInterface         $pdkSettingsRepository
+     * @param  \MyParcelNL\Pdk\Settings\Contract\PdkSettingsRepositoryInterface      $pdkSettingsRepository
      * @param  \MyParcelNL\Pdk\App\Account\Contract\PdkAccountRepositoryInterface    $pdkAccountRepository
      */
     public function __construct(
         ShopCarrierConfigurationRepository $carrierConfigurationRepository,
         ShopCarrierOptionsRepository       $carrierOptionsRepository,
-        SettingsRepositoryInterface        $pdkSettingsRepository,
+        PdkSettingsRepositoryInterface     $pdkSettingsRepository,
         PdkAccountRepositoryInterface      $pdkAccountRepository
     ) {
         $this->carrierConfigurationRepository = $carrierConfigurationRepository;

src/App/Action/Backend/Settings/UpdatePluginSettingsAction.php

@@ -7,22 +7,22 @@
 use InvalidArgumentException;
 use MyParcelNL\Pdk\Api\Response\JsonResponse;
 use MyParcelNL\Pdk\App\Action\Contract\ActionInterface;
-use MyParcelNL\Pdk\Settings\Contract\SettingsRepositoryInterface;
+use MyParcelNL\Pdk\Settings\Contract\PdkSettingsRepositoryInterface;
 use MyParcelNL\Pdk\Settings\Model\Settings;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 
 class UpdatePluginSettingsAction implements ActionInterface
 {
     /**
-     * @var \MyParcelNL\Pdk\Settings\Contract\SettingsRepositoryInterface
+     * @var \MyParcelNL\Pdk\Settings\Contract\PdkSettingsRepositoryInterface
      */
     private $settingsRepository;
 
     /**
-     * @param  \MyParcelNL\Pdk\Settings\Contract\SettingsRepositoryInterface $settingsRepository
+     * @param  \MyParcelNL\Pdk\Settings\Contract\PdkSettingsRepositoryInterface $settingsRepository
      */
-    public function __construct(SettingsRepositoryInterface $settingsRepository)
+    public function __construct(PdkSettingsRepositoryInterface $settingsRepository)
     {
         $this->settingsRepository = $settingsRepository;
     }

src/App/Installer/Service/InstallerService.php

@@ -11,7 +11,7 @@
 use MyParcelNL\Pdk\Facade\Logger;
 use MyParcelNL\Pdk\Facade\Pdk;
 use MyParcelNL\Pdk\Facade\Settings as SettingsFacade;
-use MyParcelNL\Pdk\Settings\Contract\SettingsRepositoryInterface;
+use MyParcelNL\Pdk\Settings\Contract\PdkSettingsRepositoryInterface;
 use MyParcelNL\Pdk\Settings\Model\Settings;
 
 class InstallerService implements InstallerServiceInterface
@@ -22,17 +22,17 @@ class InstallerService implements InstallerServiceInterface
     private $migrationService;
 
     /**
-     * @var \MyParcelNL\Pdk\Settings\Contract\SettingsRepositoryInterface
+     * @var \MyParcelNL\Pdk\Settings\Contract\PdkSettingsRepositoryInterface
      */
     private $settingsRepository;
 
     /**
-     * @param  \MyParcelNL\Pdk\Settings\Contract\SettingsRepositoryInterface    $settingsRepository
+     * @param  \MyParcelNL\Pdk\Settings\Contract\PdkSettingsRepositoryInterface $settingsRepository
      * @param  \MyParcelNL\Pdk\App\Installer\Contract\MigrationServiceInterface $migrationService
      */
     public function __construct(
-        SettingsRepositoryInterface $settingsRepository,
-        MigrationServiceInterface   $migrationService
+        PdkSettingsRepositoryInterface $settingsRepository,
+        MigrationServiceInterface      $migrationService
     ) {
         $this->settingsRepository = $settingsRepository;
         $this->migrationService   = $migrationService;

src/Audit/Contract/AuditRepositoryInterface.php → src/Audit/Contract/PdkAuditRepositoryInterface.php

@@ -8,7 +8,7 @@
 use MyParcelNL\Pdk\Audit\Model\Audit;
 use MyParcelNL\Pdk\Base\Contract\RepositoryInterface;
 
-interface AuditRepositoryInterface extends RepositoryInterface
+interface PdkAuditRepositoryInterface extends RepositoryInterface
 {
     /**
      * Get all audits from the database.

src/Audit/Service/AuditService.php

@@ -5,22 +5,22 @@
 namespace MyParcelNL\Pdk\Audit\Service;
 
 use MyParcelNL\Pdk\Audit\Collection\AuditCollection;
-use MyParcelNL\Pdk\Audit\Contract\AuditRepositoryInterface;
 use MyParcelNL\Pdk\Audit\Contract\AuditServiceInterface;
+use MyParcelNL\Pdk\Audit\Contract\PdkAuditRepositoryInterface;
 use MyParcelNL\Pdk\Audit\Model\Audit;
 use MyParcelNL\Pdk\Base\Model\Model;
 
 class AuditService implements AuditServiceInterface
 {
     /**
-     * @var \MyParcelNL\Pdk\Audit\Contract\AuditRepositoryInterface
+     * @var \MyParcelNL\Pdk\Audit\Contract\PdkAuditRepositoryInterface
      */
     private $auditRepository;
 
     /**
-     * @param  \MyParcelNL\Pdk\Audit\Contract\AuditRepositoryInterface $auditRepository
+     * @param  \MyParcelNL\Pdk\Audit\Contract\PdkAuditRepositoryInterface $auditRepository
      */
-    public function __construct(AuditRepositoryInterface $auditRepository)
+    public function __construct(PdkAuditRepositoryInterface $auditRepository)
     {
         $this->auditRepository = $auditRepository;
     }

src/Context/Model/DynamicContext.php

@@ -11,7 +11,7 @@
 use MyParcelNL\Pdk\Facade\AccountSettings;
 use MyParcelNL\Pdk\Facade\Pdk;
 use MyParcelNL\Pdk\Frontend\View\PrintOptionsView;
-use MyParcelNL\Pdk\Settings\Contract\SettingsRepositoryInterface;
+use MyParcelNL\Pdk\Settings\Contract\PdkSettingsRepositoryInterface;
 use MyParcelNL\Pdk\Settings\Model\LabelSettings;
 use MyParcelNL\Pdk\Settings\Model\Settings;
 
@@ -46,8 +46,8 @@ public function __construct(?array $data = null)
     {
         parent::__construct($data);
 
-        /** @var \MyParcelNL\Pdk\Settings\Contract\SettingsRepositoryInterface $settingsRepository */
-        $settingsRepository = Pdk::get(SettingsRepositoryInterface::class);
+        /** @var \MyParcelNL\Pdk\Settings\Contract\PdkSettingsRepositoryInterface $settingsRepository */
+        $settingsRepository = Pdk::get(PdkSettingsRepositoryInterface::class);
 
         $this->attributes['pluginSettings'] = $settingsRepository->all();
 

src/Settings/Contract/PdkSettingsRepositoryInterface.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MyParcelNL\Pdk\Settings\Contract;
+
+use MyParcelNL\Pdk\Base\Contract\RepositoryInterface;
+use MyParcelNL\Pdk\Settings\Collection\SettingsModelCollection;
+use MyParcelNL\Pdk\Settings\Model\AbstractSettingsModel;
+use MyParcelNL\Pdk\Settings\Model\Settings;
+
+interface PdkSettingsRepositoryInterface extends RepositoryInterface
+{
+    /**
+     * Retrieve all settings from your platform.
+     */
+    public function all(): Settings;
+
+    /**
+     * Get a single setting's value from your platform by a dot separated setting identifier.
+     *
+     * @see     \MyParcelNL\Pdk\Settings\Model\Settings
+     * @example get('general.apiKey')
+     * @example get('carrier.postnl.allowOnlyRecipient')
+     */
+    public function get(string $key);
+
+    /**
+     * Store a single setting's value in your platform by a dot separated setting identifier.
+     */
+    public function store(string $key, $value): void;
+
+    /**
+     * @param  \MyParcelNL\Pdk\Settings\Model\Settings $settings
+     *
+     * @return void
+     */
+    public function storeAllSettings(Settings $settings): void;
+
+    /**
+     * @param  SettingsModelCollection|AbstractSettingsModel $settings
+     *
+     * @return void
+     */
+    public function storeSettings($settings): void;
+}

src/Settings/Contract/SettingsRepositoryInterface.php

@@ -4,43 +4,8 @@
 
 namespace MyParcelNL\Pdk\Settings\Contract;
 
-use MyParcelNL\Pdk\Base\Contract\RepositoryInterface;
-use MyParcelNL\Pdk\Settings\Collection\SettingsModelCollection;
-use MyParcelNL\Pdk\Settings\Model\AbstractSettingsModel;
-use MyParcelNL\Pdk\Settings\Model\Settings;
-
-interface SettingsRepositoryInterface extends RepositoryInterface
-{
-    /**
-     * Retrieve all settings from your platform.
-     */
-    public function all(): Settings;
-
-    /**
-     * Get a single setting's value from your platform by a dot separated setting identifier.
-     *
-     * @see     \MyParcelNL\Pdk\Settings\Model\Settings
-     * @example get('general.apiKey')
-     * @example get('carrier.postnl.allowOnlyRecipient')
-     */
-    public function get(string $key);
-
-    /**
-     * Store a single setting's value in your platform by a dot separated setting identifier.
-     */
-    public function store(string $key, $value): void;
-
-    /**
-     * @param  \MyParcelNL\Pdk\Settings\Model\Settings $settings
-     *
-     * @return void
-     */
-    public function storeAllSettings(Settings $settings): void;
-
-    /**
-     * @param  SettingsModelCollection|AbstractSettingsModel $settings
-     *
-     * @return void
-     */
-    public function storeSettings($settings): void;
-}
+/**
+ * @deprecated use PdkSettingsRepositoryInterface. Will be removed in v3.0.0
+ * @todo       remove in v3.0.0
+ */
+interface SettingsRepositoryInterface extends PdkSettingsRepositoryInterface { }

src/Settings/Repository/AbstractSettingsRepository.php → src/Settings/Repository/AbstractPdkSettingsRepository.php

@@ -9,11 +9,11 @@
 use MyParcelNL\Pdk\Base\Support\Arr;
 use MyParcelNL\Pdk\Facade\Pdk;
 use MyParcelNL\Pdk\Settings\Collection\SettingsModelCollection;
-use MyParcelNL\Pdk\Settings\Contract\SettingsRepositoryInterface;
+use MyParcelNL\Pdk\Settings\Contract\PdkSettingsRepositoryInterface;
 use MyParcelNL\Pdk\Settings\Model\AbstractSettingsModel;
 use MyParcelNL\Pdk\Settings\Model\Settings;
 
-abstract class AbstractSettingsRepository extends Repository implements SettingsRepositoryInterface
+abstract class AbstractPdkSettingsRepository extends Repository implements PdkSettingsRepositoryInterface
 {
     /**
      * @param  string $namespace

src/Settings/SettingsManager.php

@@ -9,7 +9,7 @@
 use MyParcelNL\Pdk\Facade\Pdk;
 use MyParcelNL\Pdk\Facade\Platform;
 use MyParcelNL\Pdk\Settings\Contract\SettingsManagerInterface;
-use MyParcelNL\Pdk\Settings\Contract\SettingsRepositoryInterface;
+use MyParcelNL\Pdk\Settings\Contract\PdkSettingsRepositoryInterface;
 use MyParcelNL\Pdk\Settings\Model\CarrierSettings;
 use MyParcelNL\Pdk\Settings\Model\Settings;
 
@@ -22,14 +22,14 @@ class SettingsManager implements SettingsManagerInterface
     public const KEY_ALL = '*';
 
     /**
-     * @var \MyParcelNL\Pdk\Settings\Contract\SettingsRepositoryInterface
+     * @var \MyParcelNL\Pdk\Settings\Contract\PdkSettingsRepositoryInterface
      */
     protected $repository;
 
     /**
-     * @param  \MyParcelNL\Pdk\Settings\Contract\SettingsRepositoryInterface $repository
+     * @param  \MyParcelNL\Pdk\Settings\Contract\PdkSettingsRepositoryInterface $repository
      */
-    public function __construct(SettingsRepositoryInterface $repository)
+    public function __construct(PdkSettingsRepositoryInterface $repository)
     {
         $this->repository = $repository;
     }

tests/Bootstrap/MockMigration110.php

@@ -6,19 +6,19 @@
 
 use MyParcelNL\Pdk\App\Installer\Contract\MigrationInterface;
 use MyParcelNL\Pdk\Facade\Pdk;
-use MyParcelNL\Pdk\Settings\Contract\SettingsRepositoryInterface;
+use MyParcelNL\Pdk\Settings\Contract\PdkSettingsRepositoryInterface;
 use MyParcelNL\Pdk\Settings\Model\LabelSettings;
 
 class MockMigration110 implements MigrationInterface
 {
     private const SETTING_KEY = LabelSettings::ID . '.' . LabelSettings::DESCRIPTION;
 
     /**
-     * @var \MyParcelNL\Pdk\Settings\Contract\SettingsRepositoryInterface
+     * @var \MyParcelNL\Pdk\Settings\Contract\PdkSettingsRepositoryInterface
      */
     private $settingsRepository;
 
-    public function __construct(SettingsRepositoryInterface $settingsRepository)
+    public function __construct(PdkSettingsRepositoryInterface $settingsRepository)
     {
         $this->settingsRepository = $settingsRepository;
     }