allow any type and state

Author: QuentinGab

database/factories/InvoiceFactory.php

@@ -27,8 +27,8 @@ public function definition()
         );
 
         return [
-            'type' => InvoiceType::Invoice,
-            'state' => fake()->randomElement(InvoiceState::cases()),
+            'type' => InvoiceType::Invoice->value,
+            'state' => InvoiceState::Draft->value,
             'state_set_at' => fake()->dateTimeBetween($created_at),
             'updated_at' => fake()->dateTimeBetween($created_at),
             'created_at' => $created_at,

resources/views/default/invoice.blade.php

@@ -4,10 +4,10 @@
             <tr>
                 <td class="p-0 align-top">
                     <h1 class="mb-1 text-2xl">
-                        <strong>{{ $invoice->type->getLabel() }}</strong>
+                        <strong>{{ $invoice->type }}</strong>
                     </h1>
                     <p class="mb-5 text-sm">
-                        {{ $invoice->state->getLabel() }}
+                        {{ $invoice->state }}
                     </p>
 
                     <table class="w-full">

src/InvoiceServiceProvider.php

@@ -34,20 +34,24 @@ public function configurePackage(Package $package): void
             ->hasMigration('migrate_serial_number_details_columns_to_invoices_table');
     }
 
-    public static function getSerialNumberPrefixConfiguration(?InvoiceType $type): ?string
+    public static function getSerialNumberPrefixConfiguration(null|string|InvoiceType $type): ?string
     {
+        $value = $type instanceof InvoiceType ? $type->value : $type;
+
         /** @var string|array<string, string> $prefixes */
         $prefixes = config('invoices.serial_number.prefix', '');
 
         if (is_string($prefixes)) {
             return $prefixes;
         }
 
-        return $prefixes[$type?->value] ?? null;
+        return $prefixes[$value] ?? null;
     }
 
-    public static function getSerialNumberFormatConfiguration(?InvoiceType $type): string
+    public static function getSerialNumberFormatConfiguration(null|string|InvoiceType $type): string
     {
+        $value = $type instanceof InvoiceType ? $type->value : $type;
+
         /** @var string|array<string, string> $formats */
         $formats = config('invoices.serial_number.format') ?? '';
 
@@ -56,10 +60,10 @@ public static function getSerialNumberFormatConfiguration(?InvoiceType $type): s
         }
 
         /** @var ?string $format */
-        $format = $formats[$type?->value] ?? null;
+        $format = $formats[$value] ?? null;
 
         if (! $format) {
-            throw new Exception("No serial number format defined in config for type: {$type?->value}.");
+            throw new Exception("No serial number format defined in config for type: {$value}.");
         }
 
         return $format;

src/Models/Invoice.php

@@ -35,12 +35,12 @@
  * @property ?Invoice $parent
  * @property ?Invoice $quote
  * @property ?Invoice $credit
- * @property InvoiceType $type
+ * @property string $type
+ * @property string $state
+ * @property ?Carbon $state_set_at
  * @property string $description
  * @property ?array<string, mixed> $seller_information
  * @property ?array<string, mixed> $buyer_information
- * @property InvoiceState $state
- * @property ?Carbon $state_set_at
  * @property ?Carbon $due_at
  * @property ?string $tax_type
  * @property ?string $tax_exempt
@@ -79,26 +79,30 @@ class Invoice extends Model implements Attachable
     use HasFactory;
 
     protected $attributes = [
-        'type' => InvoiceType::Invoice,
-        'state' => InvoiceState::Draft,
+        'type' => InvoiceType::Invoice->value,
+        'state' => InvoiceState::Draft->value,
     ];
 
     protected $guarded = [];
 
-    protected $casts = [
-        'type' => InvoiceType::class,
-        'state_set_at' => 'datetime',
-        'due_at' => 'datetime',
-        'state' => InvoiceState::class,
-        'seller_information' => 'array',
-        'buyer_information' => 'array',
-        'metadata' => 'array',
-        'discounts' => Discounts::class,
-        'subtotal_amount' => MoneyCast::class.':currency',
-        'discount_amount' => MoneyCast::class.':currency',
-        'tax_amount' => MoneyCast::class.':currency',
-        'total_amount' => MoneyCast::class.':currency',
-    ];
+    /**
+     * @return array<string, string>
+     */
+    protected function casts(): array
+    {
+        return [
+            'state_set_at' => 'datetime',
+            'due_at' => 'datetime',
+            'seller_information' => 'array',
+            'buyer_information' => 'array',
+            'metadata' => 'array',
+            'discounts' => Discounts::class,
+            'subtotal_amount' => MoneyCast::class.':currency',
+            'discount_amount' => MoneyCast::class.':currency',
+            'tax_amount' => MoneyCast::class.':currency',
+            'total_amount' => MoneyCast::class.':currency',
+        ];
+    }
 
     public static function booted()
     {
@@ -463,11 +467,21 @@ public function getLogo(): ?string
         return null;
     }
 
+    public function getType(): string|InvoiceType
+    {
+        return InvoiceType::tryFrom($this->type) ?? $this->type;
+    }
+
+    public function getState(): string|InvoiceState
+    {
+        return InvoiceState::tryFrom($this->state) ?? $this->state;
+    }
+
     public function toPdfInvoice(): PdfInvoice
     {
         return new PdfInvoice(
-            type: $this->type,
-            state: $this->state,
+            type: $this->getType(),
+            state: $this->getState(),
             serial_number: $this->serial_number,
             due_at: $this->due_at,
             created_at: $this->created_at,

src/Models/InvoiceItem.php

@@ -39,15 +39,18 @@ class InvoiceItem extends Model
 
     protected $guarded = [];
 
-    protected $casts = [
-        /**
-         * This cast will be forwarded to the class defined in config at invoices.money_cast
-         */
-        'unit_price' => MoneyCast::class.':currency',
-        'unit_tax' => MoneyCast::class.':currency',
-        'metadata' => AsArrayObject::class,
-        'tax_percentage' => 'float',
-    ];
+    /**
+     * @return array<string, string>
+     */
+    protected function casts(): array
+    {
+        return [
+            'unit_price' => MoneyCast::class.':currency',
+            'unit_tax' => MoneyCast::class.':currency',
+            'metadata' => AsArrayObject::class,
+            'tax_percentage' => 'float',
+        ];
+    }
 
     /**
      * @return BelongsTo<Invoice, $this>

src/Pdf/PdfInvoice.php

@@ -22,6 +22,10 @@ class PdfInvoice
 {
     use FormatForPdf;
 
+    public string $type;
+
+    public string $state;
+
     public string $template;
 
     /**
@@ -32,8 +36,8 @@ class PdfInvoice
      * @param  array<string, mixed>  $templateData
      */
     public function __construct(
-        public InvoiceType $type = InvoiceType::Invoice,
-        public InvoiceState $state = InvoiceState::Draft,
+        InvoiceType|string $type = InvoiceType::Invoice,
+        InvoiceState|string $state = InvoiceState::Draft,
         public ?string $serial_number = null,
         public ?Carbon $created_at = null,
         public ?Carbon $due_at = null,
@@ -53,6 +57,9 @@ public function __construct(
 
         public ?string $logo = null,
     ) {
+        $this->type = $type instanceof InvoiceType ? $type->getLabel() : $type;
+        $this->state = $state instanceof InvoiceState ? $state->getLabel() : $state;
+
         // @phpstan-ignore-next-line
         $this->logo = $logo ?? config('invoices.pdf.logo') ?? config('invoices.default_logo');
         // @phpstan-ignore-next-line