Refactor PEPPOL to use enums, remove JSON columns, use key-value config, and logging trait

Co-authored-by: nielsdrost7 <[email protected]>

Author: Copilot

…validation_fields_to_relations_table.php …validation_fields_to_relations_table.phpModules/Clients/Database/Migrations/2025_10_02_000004_add_peppol_validation_fields_to_relations_table.php renamed to Modules/Clients/Database/Migrations/2025_10_02_000007_add_peppol_validation_fields_to_relations_table.php Modules/Clients/Database/Migrations/2025_10_02_000004_add_peppol_validation_fields_to_relations_table.php renamed to Modules/Clients/Database/Migrations/2025_10_02_000007_add_peppol_validation_fields_to_relations_table.php

@@ -6,12 +6,9 @@
 
 return new class extends Migration
 {
-    /**
-     * Run the migrations.
-     */
     public function up(): void
     {
-        Schema::table('relations', function (Blueprint $table) {
+        Schema::table('relations', function (Blueprint $table): void {
             $table->string('peppol_scheme', 50)->nullable()->after('peppol_id')
                 ->comment('Peppol endpoint scheme (e.g., BE:CBE, DE:VAT)');
 
@@ -26,12 +23,9 @@ public function up(): void
         });
     }
 
-    /**
-     * Reverse the migrations.
-     */
     public function down(): void
     {
-        Schema::table('relations', function (Blueprint $table) {
+        Schema::table('relations', function (Blueprint $table): void {
             $table->dropColumn(['peppol_scheme', 'peppol_validation_status', 'peppol_validation_message', 'peppol_validated_at']);
         });
     }

Modules/Clients/Models/Relation.php

@@ -17,6 +17,7 @@
 use Modules\Core\Models\User;
 use Modules\Core\Traits\BelongsToCompany;
 use Modules\Expenses\Models\Expense;
+use Modules\Invoices\Enums\PeppolValidationStatus;
 use Modules\Invoices\Models\CustomerPeppolValidationHistory;
 use Modules\Invoices\Models\Invoice;
 use Modules\Payments\Models\Payment;
@@ -41,7 +42,7 @@
  * @property string|null          $peppol_scheme
  * @property string|null          $peppol_format
  * @property bool                 $enable_e_invoicing
- * @property string|null          $peppol_validation_status
+ * @property PeppolValidationStatus|null $peppol_validation_status
  * @property string|null          $peppol_validation_message
  * @property Carbon|null          $peppol_validated_at
  * @property Carbon               $registered_at
@@ -73,6 +74,7 @@ class Relation extends Model
         'relation_type'      => RelationType::class,
         'relation_status'    => RelationStatus::class,
         'enable_e_invoicing' => 'boolean',
+        'peppol_validation_status' => PeppolValidationStatus::class,
         'peppol_validated_at' => 'datetime',
     ];
 
@@ -198,7 +200,7 @@ public function getCustomerEmailAttribute()
     public function hasPeppolIdValidated(): bool
     {
         return $this->enable_e_invoicing 
-            && $this->peppol_validation_status === 'valid'
+            && $this->peppol_validation_status === PeppolValidationStatus::VALID
             && $this->peppol_id !== null;
     }
 

Modules/Invoices/Database/Migrations/2025_10_02_000001_create_peppol_integrations_table.php

@@ -6,32 +6,24 @@
 
 return new class extends Migration
 {
-    /**
-     * Run the migrations.
-     */
     public function up(): void
     {
-        Schema::create('peppol_integrations', function (Blueprint $table) {
+        Schema::create('peppol_integrations', function (Blueprint $table): void {
             $table->id();
             $table->unsignedBigInteger('company_id');
-            $table->string('provider_name', 50)->comment('e.g., storecove, e_invoice_be');
+            $table->string('provider_name', 50)->comment('e.g., e_invoice_be, storecove');
             $table->text('encrypted_api_token')->nullable()->comment('Encrypted API credentials');
-            $table->json('config')->nullable()->comment('Provider-specific configuration');
             $table->string('test_connection_status', 20)->default('untested')->comment('untested, success, failed');
             $table->text('test_connection_message')->nullable()->comment('Last test connection result message');
             $table->timestamp('test_connection_at')->nullable();
             $table->boolean('enabled')->default(false)->comment('Whether integration is active');
-            $table->timestamps();
 
             $table->foreign('company_id')->references('id')->on('companies')->onDelete('cascade');
             $table->index(['company_id', 'enabled']);
             $table->index('provider_name');
         });
     }
 
-    /**
-     * Reverse the migrations.
-     */
     public function down(): void
     {
         Schema::dropIfExists('peppol_integrations');

Modules/Invoices/Database/Migrations/2025_10_02_000002_create_peppol_integration_config_table.php

@@ -0,0 +1,26 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    public function up(): void
+    {
+        Schema::create('peppol_integration_config', function (Blueprint $table): void {
+            $table->id();
+            $table->unsignedBigInteger('integration_id');
+            $table->string('config_key', 100);
+            $table->text('config_value');
+            
+            $table->foreign('integration_id')->references('id')->on('peppol_integrations')->onDelete('cascade');
+            $table->index(['integration_id', 'config_key']);
+        });
+    }
+
+    public function down(): void
+    {
+        Schema::dropIfExists('peppol_integration_config');
+    }
+};

…02_create_peppol_transmissions_table.php …03_create_peppol_transmissions_table.phpModules/Invoices/Database/Migrations/2025_10_02_000002_create_peppol_transmissions_table.php renamed to Modules/Invoices/Database/Migrations/2025_10_02_000003_create_peppol_transmissions_table.php Modules/Invoices/Database/Migrations/2025_10_02_000002_create_peppol_transmissions_table.php renamed to Modules/Invoices/Database/Migrations/2025_10_02_000003_create_peppol_transmissions_table.php

@@ -6,12 +6,9 @@
 
 return new class extends Migration
 {
-    /**
-     * Run the migrations.
-     */
     public function up(): void
     {
-        Schema::create('peppol_transmissions', function (Blueprint $table) {
+        Schema::create('peppol_transmissions', function (Blueprint $table): void {
             $table->id();
             $table->unsignedBigInteger('invoice_id');
             $table->unsignedBigInteger('customer_id');
@@ -25,11 +22,11 @@ public function up(): void
             $table->string('stored_pdf_path')->nullable()->comment('Path to stored PDF file');
             $table->text('last_error')->nullable()->comment('Last error message if failed');
             $table->string('error_type', 20)->nullable()->comment('TRANSIENT, PERMANENT, UNKNOWN');
-            $table->json('provider_response')->nullable()->comment('Last provider response data');
             $table->timestamp('sent_at')->nullable();
             $table->timestamp('acknowledged_at')->nullable();
             $table->timestamp('next_retry_at')->nullable();
-            $table->timestamps();
+            $table->timestamp('created_at')->nullable();
+            $table->timestamp('updated_at')->nullable();
 
             $table->foreign('invoice_id')->references('id')->on('invoices')->onDelete('cascade');
             $table->foreign('customer_id')->references('id')->on('relations')->onDelete('cascade');
@@ -42,9 +39,6 @@ public function up(): void
         });
     }
 
-    /**
-     * Reverse the migrations.
-     */
     public function down(): void
     {
         Schema::dropIfExists('peppol_transmissions');

Modules/Invoices/Database/Migrations/2025_10_02_000004_create_peppol_transmission_responses_table.php

@@ -0,0 +1,26 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    public function up(): void
+    {
+        Schema::create('peppol_transmission_responses', function (Blueprint $table): void {
+            $table->id();
+            $table->unsignedBigInteger('transmission_id');
+            $table->string('response_key', 100);
+            $table->text('response_value');
+            
+            $table->foreign('transmission_id')->references('id')->on('peppol_transmissions')->onDelete('cascade');
+            $table->index(['transmission_id', 'response_key']);
+        });
+    }
+
+    public function down(): void
+    {
+        Schema::dropIfExists('peppol_transmission_responses');
+    }
+};

…omer_peppol_validation_history_table.php …omer_peppol_validation_history_table.phpModules/Invoices/Database/Migrations/2025_10_02_000003_create_customer_peppol_validation_history_table.php renamed to Modules/Invoices/Database/Migrations/2025_10_02_000005_create_customer_peppol_validation_history_table.php Modules/Invoices/Database/Migrations/2025_10_02_000003_create_customer_peppol_validation_history_table.php renamed to Modules/Invoices/Database/Migrations/2025_10_02_000005_create_customer_peppol_validation_history_table.php

@@ -6,12 +6,9 @@
 
 return new class extends Migration
 {
-    /**
-     * Run the migrations.
-     */
     public function up(): void
     {
-        Schema::create('customer_peppol_validation_history', function (Blueprint $table) {
+        Schema::create('customer_peppol_validation_history', function (Blueprint $table): void {
             $table->id();
             $table->unsignedBigInteger('customer_id');
             $table->unsignedBigInteger('integration_id')->nullable()->comment('Which integration was used for validation');
@@ -20,9 +17,8 @@ public function up(): void
             $table->string('peppol_id', 100);
             $table->string('validation_status', 20)->comment('valid, invalid, not_found, error');
             $table->text('validation_message')->nullable();
-            $table->json('provider_response')->nullable()->comment('Full provider response for audit');
-            $table->json('request_payload')->nullable()->comment('Request sent to provider');
-            $table->timestamps();
+            $table->timestamp('created_at')->nullable();
+            $table->timestamp('updated_at')->nullable();
 
             $table->foreign('customer_id')->references('id')->on('relations')->onDelete('cascade');
             $table->foreign('integration_id')->references('id')->on('peppol_integrations')->onDelete('set null');
@@ -33,9 +29,6 @@ public function up(): void
         });
     }
 
-    /**
-     * Reverse the migrations.
-     */
     public function down(): void
     {
         Schema::dropIfExists('customer_peppol_validation_history');

Modules/Invoices/Database/Migrations/2025_10_02_000006_create_customer_peppol_validation_responses_table.php

@@ -0,0 +1,27 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    public function up(): void
+    {
+        Schema::create('customer_peppol_validation_responses', function (Blueprint $table): void {
+            $table->id();
+            $table->unsignedBigInteger('validation_history_id');
+            $table->string('response_key', 100);
+            $table->text('response_value');
+            
+            $table->foreign('validation_history_id', 'fk_peppol_validation_responses')
+                ->references('id')->on('customer_peppol_validation_history')->onDelete('cascade');
+            $table->index(['validation_history_id', 'response_key'], 'idx_validation_responses');
+        });
+    }
+
+    public function down(): void
+    {
+        Schema::dropIfExists('customer_peppol_validation_responses');
+    }
+};

Modules/Invoices/Enums/PeppolConnectionStatus.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Modules\Invoices\Enums;
+
+use Modules\Core\Contracts\LabeledEnum;
+use Modules\Core\Traits\HasOptions;
+
+enum PeppolConnectionStatus: string implements LabeledEnum
+{
+    use HasOptions;
+
+    case UNTESTED = 'untested';
+    case SUCCESS = 'success';
+    case FAILED = 'failed';
+
+    public function label(): string
+    {
+        return match ($this) {
+            self::UNTESTED => 'Untested',
+            self::SUCCESS => 'Success',
+            self::FAILED => 'Failed',
+        };
+    }
+
+    public function color(): string
+    {
+        return match ($this) {
+            self::UNTESTED => 'gray',
+            self::SUCCESS => 'green',
+            self::FAILED => 'red',
+        };
+    }
+
+    public function icon(): string
+    {
+        return match ($this) {
+            self::UNTESTED => 'heroicon-o-question-mark-circle',
+            self::SUCCESS => 'heroicon-o-check-circle',
+            self::FAILED => 'heroicon-o-x-circle',
+        };
+    }
+}

Modules/Invoices/Enums/PeppolErrorType.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Modules\Invoices\Enums;
+
+use Modules\Core\Contracts\LabeledEnum;
+use Modules\Core\Traits\HasOptions;
+
+enum PeppolErrorType: string implements LabeledEnum
+{
+    use HasOptions;
+
+    case TRANSIENT = 'TRANSIENT';
+    case PERMANENT = 'PERMANENT';
+    case UNKNOWN = 'UNKNOWN';
+
+    public function label(): string
+    {
+        return match ($this) {
+            self::TRANSIENT => 'Transient Error',
+            self::PERMANENT => 'Permanent Error',
+            self::UNKNOWN => 'Unknown Error',
+        };
+    }
+
+    public function color(): string
+    {
+        return match ($this) {
+            self::TRANSIENT => 'yellow',
+            self::PERMANENT => 'red',
+            self::UNKNOWN => 'gray',
+        };
+    }
+
+    public function icon(): string
+    {
+        return match ($this) {
+            self::TRANSIENT => 'heroicon-o-arrow-path',
+            self::PERMANENT => 'heroicon-o-x-circle',
+            self::UNKNOWN => 'heroicon-o-question-mark-circle',
+        };
+    }
+}