Added importer details endpoint

app/Http/Controllers/Api/V1/ImportController.php

@@ -6,6 +6,8 @@ namespace App\Http\Controllers\Api\V1;
 
 use App\Http\Requests\V1\Import\ImportRequest;
 use App\Models\Organization;
+use App\Service\Import\Importers\ImporterContract;
+use App\Service\Import\Importers\ImporterProvider;
 use App\Service\Import\Importers\ImportException;
 use App\Service\Import\ImportService;
 use Illuminate\Auth\Access\AuthorizationException;
@@ -13,6 +15,39 @@ use Illuminate\Http\JsonResponse;
 
 class ImportController extends Controller
 {
+    /**
+     * Get information about available importers
+     *
+     * @operationId getImporters
+     *
+     * @throws AuthorizationException
+     *
+     * @response array{data: array<array{ key: string, name: string, description: string }>}
+     */
+    public function index(Organization $organization, ImporterProvider $importerProvider): JsonResponse
+    {
+        $this->checkPermission($organization, 'import');
+
+        $importers = $importerProvider->getImporters();
+
+        /** @var array<array{ key: string, name: string, description: string }> $importersResponse */
+        $importersResponse = [];
+
+        foreach ($importers as $key => $importerClass) {
+            /** @var ImporterContract $importer */
+            $importer = new $importerClass();
+            $importersResponse[] = [
+                'key' => $key,
+                'name' => $importer->getName(),
+                'description' => $importer->getDescription(),
+            ];
+        }
+
+        return new JsonResponse([
+            'data' => $importersResponse,
+        ], 200);
+    }
+
     /**
      * Import data into the organization
      *

app/Service/Import/Importers/ClockifyProjectsImporter.php

@@ -84,4 +84,16 @@ class ClockifyProjectsImporter extends DefaultImporter
             }
         }
     }
+
+    #[\Override]
+    public function getName(): string
+    {
+        return __('importer.clockify_projects.name');
+    }
+
+    #[\Override]
+    public function getDescription(): string
+    {
+        return __('importer.clockify_projects.description');
+    }
 }

app/Service/Import/Importers/ClockifyTimeEntriesImporter.php

@@ -158,4 +158,16 @@ class ClockifyTimeEntriesImporter extends DefaultImporter
             }
         }
     }
+
+    #[\Override]
+    public function getName(): string
+    {
+        return __('importer.toggl_data_importer.name');
+    }
+
+    #[\Override]
+    public function getDescription(): string
+    {
+        return __('importer.toggl_data_importer.description');
+    }
 }

app/Service/Import/Importers/ImporterContract.php

@@ -13,4 +13,8 @@ interface ImporterContract
     public function importData(string $data): void;
 
     public function getReport(): ReportDto;
+
+    public function getName(): string;
+
+    public function getDescription(): string;
 }

app/Service/Import/Importers/ImporterProvider.php

@@ -32,6 +32,14 @@ class ImporterProvider
         return array_keys($this->importers);
     }
 
+    /**
+     * @return array<string, class-string<ImporterContract>>
+     */
+    public function getImporters(): array
+    {
+        return $this->importers;
+    }
+
     public function getImporter(string $type): ImporterContract
     {
         if (! array_key_exists($type, $this->importers)) {

app/Service/Import/Importers/TogglDataImporter.php

@@ -114,4 +114,16 @@ class TogglDataImporter extends DefaultImporter
             throw new ImportException('Unknown error');
         }
     }
+
+    #[\Override]
+    public function getName(): string
+    {
+        return __('importer.toggl_data_importer.name');
+    }
+
+    #[\Override]
+    public function getDescription(): string
+    {
+        return __('importer.toggl_data_importer.description');
+    }
 }

app/Service/Import/Importers/TogglTimeEntriesImporter.php

@@ -142,4 +142,16 @@ class TogglTimeEntriesImporter extends DefaultImporter
             }
         }
     }
+
+    #[\Override]
+    public function getName(): string
+    {
+        return __('importer.toggl_time_entries.name');
+    }
+
+    #[\Override]
+    public function getDescription(): string
+    {
+        return __('importer.toggl_time_entries.description');
+    }
 }