new template and classes

Author: QuentinGab

.gitignore

@@ -9,4 +9,5 @@ phpstan.neon
 testbench.yaml
 vendor
 node_modules
-.phpunit.cache
+.phpunit.cache
+workbench/storage

README.md

@@ -70,10 +70,10 @@ php artisan vendor:publish --tag="invoices-config"
 This is the contents of the published config file:
 
 ```php
-use Finller\Invoice\Invoice;
+use Finller\Invoice\Models\Invoice;
 use Finller\Invoice\InvoiceDiscount;
-use Finller\Invoice\InvoiceItem;
-use Finller\Invoice\InvoiceType;
+use Finller\Invoice\Models\InvoiceItem;
+use Finller\Invoice\Enums\InvoiceType;
 
 return [
 
@@ -193,7 +193,7 @@ return [
 
 ### Storing an Invoice in Your Database
 
-You can store an Invoice in your database using the Eloquent Model: `Finller\Invoice\Invoice`.
+You can store an Invoice in your database using the Eloquent Model: `Finller\Invoice\Models\Invoice`.
 
 > [!NOTE]
 > Don't forget to publish and run the migrations
@@ -202,9 +202,9 @@ Here is a full example:
 
 ```php
 use Brick\Money\Money;
-use Finller\Invoice\Invoice;
-use Finller\Invoice\InvoiceState;
-use Finller\Invoice\InvoiceType;
+use Finller\Invoice\Models\Invoice;
+use Finller\Invoice\Enums\InvoiceState;
+use Finller\Invoice\Enums\InvoiceType;
 
 // Let's say your app edit invoices for your users
 $customer = User::find(1);
@@ -256,7 +256,7 @@ You can configure the format of your serial numbers in the configuration file. T
 
 When `invoices.serial_number.auto_generate` is set to `true`, a unique serial number is assigned to each new invoice automatically.
 
-Serial numbers are generated sequentially, with each new serial number based on the latest available one. To define what qualifies as the `previous` serial number, you can extend the `Finller\Invoice\Invoice` class and override the `getPreviousInvoice` method.
+Serial numbers are generated sequentially, with each new serial number based on the latest available one. To define what qualifies as the `previous` serial number, you can extend the `Finller\Invoice\Models\Invoice` class and override the `getPreviousInvoice` method.
 
 By default, the previous invoice is determined based on criteria such as prefix, series, year, and month for accurate, scoped numbering.
 
@@ -273,7 +273,7 @@ For instance, you might want to define a unique series for each user, creating s
 When creating an invoice, you can dynamically specify the prefix and series as follows:
 
 ```php
-use Finller\Invoice\Invoice;
+use Finller\Invoice\Models\Invoice;
 $invoice = new Invoice();
 
 $invoice->configureSerialNumber(
@@ -380,7 +380,7 @@ class PaymentInvoice extends Mailable
 
 To customize how your model is converted to a `PdfInvoice`, follow these steps:
 
-1. **Create a Custom Model**: Define your own `\App\Models\Invoice` class and ensure it extends the base `\Finller\Invoice\Invoice` class.
+1. **Create a Custom Model**: Define your own `\App\Models\Invoice` class and ensure it extends the base `\Finller\Invoice\Models\Invoice` class.
 
 2. **Override the `toPdfInvoice` Method**: Implement your specific logic within the `toPdfInvoice` method to control the customization.
 
@@ -399,7 +399,7 @@ If you need to set the logo dynamically on the invoice, for example, when allowi
 To dynamically set the logo, define the `getLogo` method as shown below:
 
 ```php
-class Invoice extends \Finller\Invoice\Invoice
+class Invoice extends \Finller\Invoice\Models\Invoice
 {
     // ...
 
@@ -426,7 +426,7 @@ You can even use this package exclusively for the `PdfInvoice` class if that sui
 Here’s an example of a fully configured `PdfInvoice` instance:
 
 ```php
-use Finller\Invoice\PdfInvoice;
+use Finller\Invoice\Pdf\PdfInvoice;
 
 $pdfInvoice = new PdfInvoice(
     name: "Invoice",
@@ -480,7 +480,7 @@ $pdfInvoice = new PdfInvoice(
 ```php
 namespace App\Http\Controllers;
 
-use Finller\Invoice\PdfInvoice;
+use Finller\Invoice\Pdf\PdfInvoice;
 
 class InvoiceController extends Controller
 {
@@ -519,7 +519,7 @@ class InvoiceController extends Controller
 ```php
 namespace App\Http\Controllers;
 
-use Finller\Invoice\PdfInvoice;
+use Finller\Invoice\Pdf\PdfInvoice;
 
 class Invoice extends Component
 {

composer.json

@@ -18,7 +18,7 @@
     ],
     "require": {
         "php": "^8.1",
-        "barryvdh/laravel-dompdf": "^3.0.0",
+        "dompdf/dompdf": "^3.1",
         "elegantly/laravel-money": "^2.1.0",
         "illuminate/contracts": "^11.0||^12.0",
         "spatie/laravel-package-tools": "^1.14"

config/invoices.php

@@ -2,10 +2,10 @@
 
 declare(strict_types=1);
 
-use Finller\Invoice\Invoice;
+use Finller\Invoice\Enums\InvoiceType;
 use Finller\Invoice\InvoiceDiscount;
-use Finller\Invoice\InvoiceItem;
-use Finller\Invoice\InvoiceType;
+use Finller\Invoice\Models\Invoice;
+use Finller\Invoice\Models\InvoiceItem;
 
 return [
 
@@ -77,40 +77,49 @@
     'default_currency' => 'USD',
 
     'pdf' => [
+
+        'paper' => [
+            'paper' => 'a4',
+            'orientation' => 'portrait',
+        ],
+
         /**
          * Default DOM PDF options
          *
          * @see Available options https://github.com/barryvdh/laravel-dompdf#configuration
          */
         'options' => [
-            'isPhpEnabled' => true,
-            'fontHeightRatio' => 0.9,
+            'isRemoteEnabled' => true,
+            'isPhpEnabled' => false,
+            'fontHeightRatio' => 1,
             /**
              * Supported values are: 'DejaVu Sans', 'Helvetica', 'Courier', 'Times', 'Symbol', 'ZapfDingbats'
              */
             'defaultFont' => 'Helvetica',
-        ],
 
-        'paper' => [
-            'paper' => 'a4',
-            'orientation' => 'portrait',
+            'fontDir' => sys_get_temp_dir(),
+            'fontCache' => sys_get_temp_dir(),
+            'tempDir' => sys_get_temp_dir(),
+            'chroot' => sys_get_temp_dir(),
         ],
 
         /**
          * The logo displayed in the PDF
          */
         'logo' => null,
 
-        /**
-         * The color displayed at the top of the PDF
-         */
-        'color' => '#050038',
-
         /**
          * The template used to render the PDF
          */
         'template' => 'default.layout',
 
+        'template_data' => [
+            /**
+             * The color displayed at the top of the PDF
+             */
+            'color' => '#050038',
+        ],
+
     ],
 
 ];

database/factories/InvoiceFactory.php

@@ -5,9 +5,12 @@
 namespace Finller\Invoice\Database\Factories;
 
 use Carbon\Carbon;
-use Finller\Invoice\Invoice;
-use Finller\Invoice\InvoiceState;
-use Finller\Invoice\InvoiceType;
+use Finller\Invoice\Enums\InvoiceState;
+use Finller\Invoice\Enums\InvoiceType;
+use Finller\Invoice\Models\Invoice;
+use Finller\Invoice\Support\Address;
+use Finller\Invoice\Support\Buyer;
+use Finller\Invoice\Support\Seller;
 use Illuminate\Database\Eloquent\Factories\Factory;
 
 /**
@@ -31,19 +34,20 @@ public function definition()
             'created_at' => $created_at,
             'due_at' => fake()->dateTimeBetween($created_at, '+ 30 days'),
             'description' => fake()->sentence(),
-            'buyer_information' => [
-                'name' => fake()->company(),
-                'address' => [
-                    'street' => fake()->streetName(),
-                    'city' => fake()->city(),
-                    'postal_code' => fake()->postcode(),
-                    'state' => null,
-                    'country' => fake()->country(),
-                ],
-                'email' => fake()->email(),
-                'phone_number' => fake()->phoneNumber(),
-                'tax_number' => fake()->numberBetween(12345678, 99999999),
-            ],
+            // @phpstan-ignore-next-line
+            'seller_information' => Seller::fromArray(config('invoices.default_seller')),
+            'buyer_information' => new Buyer(
+                name : fake()->company(),
+                billing_address : new Address(
+                    street: fake()->streetName(),
+                    city: fake()->city(),
+                    postal_code : fake()->postcode(),
+                    country: fake()->country(),
+                ),
+                email : fake()->email(),
+                phone : fake()->phoneNumber(),
+                tax_number : (string) fake()->numberBetween(12345678, 99999999),
+            ),
         ];
     }
 

database/factories/InvoiceItemFactory.php

@@ -5,7 +5,7 @@
 namespace Finller\Invoice\Database\Factories;
 
 use Brick\Money\Money;
-use Finller\Invoice\InvoiceItem;
+use Finller\Invoice\Models\InvoiceItem;
 use Illuminate\Database\Eloquent\Factories\Factory;
 
 /**

database/migrations/migrate_serial_number_details_columns_to_invoices_table.php.stub

@@ -4,7 +4,7 @@ use Illuminate\Database\Migrations\Migration;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
 use Illuminate\Database\Eloquent\Collection;
-use Finller\Invoice\Invoice;
+use Finller\Invoice\Models\Invoice;
 use Illuminate\Database\Eloquent\Model;
 
 return new class extends Migration

resources/lang/en/invoice.php

@@ -25,6 +25,7 @@
 
     'from' => 'Bill From',
     'to' => 'Bill To',
+    'shipping_to' => 'Shipping To',
 
     'states' => [
         'draft' => 'Draft',
@@ -39,4 +40,6 @@
         'credit' => 'Credit note',
         'proforma' => 'Proforma invoice',
     ],
+
+    'page' => 'Page',
 ];

resources/lang/fr/invoice.php

@@ -25,6 +25,7 @@
 
     'from' => 'De',
     'to' => 'Pour',
+    'shipping_to' => 'Livré à',
 
     'states' => [
         'draft' => 'Brouillon',
@@ -39,4 +40,6 @@
         'credit' => "Facture d'avoir",
         'proforma' => 'Facture Proforma',
     ],
+
+    'page' => 'Page',
 ];