Add thumbnail on product variant (#309)

* docs: update config and components (media, brand and customer) * feat: add thumbnail to varaint, and move storage config from core to media config file * chore: refactor phpstan
shopperlabs · Dec 6, 2024 · 3c65cdf · 3c65cdf
1 parent 782625d
commit 3c65cdf
Show file tree

Hide file tree

Showing 33 changed files with 156 additions and 127 deletions.
diff --git a/packages/admin/docs/content/brands.md b/packages/admin/docs/content/brands.md
@@ -72,6 +72,7 @@ return [
     ```
 
 ### Components
+
 By default, brands Livewire components are not published. To customize components, you must publish them.
 
 ```bash
@@ -160,7 +161,7 @@ class HomeController extends Controller
 
         return view('home', [
             'products' =>  $products,
-            'brands' => Brand::query()->get()->take(12), // [tl! focus]
+            'brands' => Brand::enabled()->get()->take(12), // [tl! focus]
         ]);
     }
 }

diff --git a/packages/admin/docs/content/configuration.md b/packages/admin/docs/content/configuration.md
@@ -32,6 +32,7 @@ You can update this configuration in the `admin.php` file, or you can add the `S
 :::tip
 If you update this configuration, you have to republish the assets to take the new link. 
 The assets are dynamically loaded by a symbolic link named as the prefix.
+
 ```php
 php artisan shopper:link
 ```

diff --git a/packages/admin/docs/content/customers.md b/packages/admin/docs/content/customers.md
@@ -1,4 +1,5 @@
 # Customers
+
 In e-commerce stores, customers are one if not the fundamental point for the functioning of your store.
 
 The first page under the "Customers" menu gives you a list of all the registered users on your shop.
@@ -11,60 +12,72 @@ The first page under the "Customers" menu gives you a list of all the registered
 During the [installation](/installing#update-existing-files) of Shopper, one of the first things required is to inherit to our model User the features of the model User that is in Shopper.
 
 ## Fields
-The model used is `App\Models\User` which extends the `\Shopper\Framework\Models\User\User` model. 
+
+The model used is `App\Models\User` which extends the `\Shopper\Core\Models\User` model. 
 
 :::warning
 During the installation of Shopper, the `name` column of the users table is removed and replaced by 2 new fields which are `first_name` and `last_name`.
 :::
 
-| Name        | Type      | Required   |  Notes   |
-|-------------|-----------|------------|------------|
-| `id` | autoinc |         |  auto  |
-| `first_name` | string  | no | Nullable  |
-| `last_name` | string  | yes |  |
-| `email` | string  | yes | Unique  |
-| `password` | string  | no | Nullable  |
-| `email_verified_at` | timestamp  | no | Nullable  |
-| `gender` | enum  | yes | values `['male', 'female']` |
-| `phone_number` | string  | no | Nullable  |
-| `birth_date` | date  | no | Nullable  |
-| `avatar_type` | string  | no | default [ui-avatars](https://ui-avatars.com/)  |
-| `avatar_location` | string  | no | Nullable, picture filename  |
-| `timezone` | string  | no | Nullable  |
-| `opt_in` | boolean  | no | default `false`, this field is for mailing subcription  |
-| `last_login_at` | timestamp  | no | Nullable  |
-| `last_login_ip` | string  | no | Nullable  |
+| Name                | Type      | Required | Notes                                                            |
+|---------------------|-----------|----------|------------------------------------------------------------------|
+| `id`                | autoinc   |          | auto                                                             |
+| `first_name`        | string    | no       | Nullable                                                         |
+| `last_name`         | string    | yes      |                                                                  |
+| `email`             | string    | yes      | Unique                                                           |
+| `password`          | string    | no       | Nullable                                                         |
+| `email_verified_at` | timestamp | no       | Nullable                                                         |
+| `gender`            | enum      | yes      | values `['male', 'female']`                                      |
+| `phone_number`      | string    | no       | Nullable                                                         |
+| `birth_date`        | date      | no       | Nullable                                                         |
+| `avatar_type`       | string    | no       | default [ui-avatars](https://ui-avatars.com/)                    |
+| `avatar_location`   | string    | no       | Nullable, picture filename                                       |
+| `timezone`          | string    | no       | Nullable                                                         |
+| `opt_in`            | boolean   | no       | default `false`, this field can be used for mailing subscription |
+| `last_login_at`     | timestamp | no       | Nullable                                                         |
+| `last_login_ip`     | string    | no       | Nullable                                                         |
 
 ## Components
-The components used to manage customers are found in the component configuration file `config/shopper/components.php`.
+
+By default, brands Livewire components are not published. To customize components, you must publish them.
+
+```bash
+php artisan shopper:component:publish customer
+```
+
+This command will publish all Livewire components used for brand management (from pages to form components).
+Once you've published the component, you can find it in the `customer.php` locate in the `config/shopper/components` folder.
+
 
 ```php
-use Shopper\Framework\Http\Livewire;
+use Shopper\Livewire;
+use Shopper\Livewire\Components;
 
 return [
 
-  'livewire' => [
-      'modals.delete-customer' => Livewire\Modals\DeleteCustomer::class,
-
-      'customers.addresses' => Livewire\Customers\Addresses::class,
-      'customers.browse' => Livewire\Customers\Browse::class,
-      'customers.create' => Livewire\Customers\Create::class,
-      'customers.orders' => Livewire\Customers\Orders::class,
-      'customers.profile' => Livewire\Customers\Profile::class,
-      'customers.show' => Livewire\Customers\Show::class,
+  'pages' => [
+      'customer-index' => Livewire\Pages\Customers\Index::class,
+      'customer-create' => Livewire\Pages\Customers\Create::class,
+      'customer-show' => Livewire\Pages\Customers\Show::class,
+  ],
 
-      'tables.customers-table' => Livewire\Tables\CustomersTable::class,
-  ];
+  'components' => [
+      'customers.addresses' => Components\Customers\Addresses::class,
+      'customers.orders' => Components\Customers\Orders::class,
+      'customers.profile' => Components\Customers\Profile::class,
+  ],
 
 ];
 ```
 
 ## Manage Customers
+
 When a new customer places an order with your store, their name and information are automatically added to your customer list. A customer profile is created when a customer interacts with your store.
 
 Alternatively, you can add a customer to your store manually.
 
 ### Create customer
+
 From your Shopper admin, go to Customers and click on "Add customer" button.
 
 <div class="screenshot">

diff --git a/packages/admin/docs/content/media.md b/packages/admin/docs/content/media.md
@@ -42,5 +42,5 @@ For more information on what's available, see [Defining conversions](https://spa
 To get an image with full url on a product, a brand or a collection
 
 ```php
-$product->getFirstMediaUrl(config('shopper.core.storage.disk_name'))
+$product->getFirstMediaUrl(config('shopper.media.storage.disk_name'))
 ```
diff --git a/packages/admin/resources/views/livewire/components/customers/orders.blade.php b/packages/admin/resources/views/livewire/components/customers/orders.blade.php
@@ -76,7 +76,7 @@ class="text-xs font-medium uppercase leading-4 tracking-wider text-gray-500 dark
                                         <div class="shrink-0">
                                             <img
                                                 class="size-8 rounded-full object-cover"
-                                                src="{{ $item->product->getFirstMediaUrl(config('shopper.core.storage.thumbnail_collection')) }}"
+                                                src="{{ $item->product->getFirstMediaUrl(config('shopper.media.storage.thumbnail_collection')) }}"
                                                 alt="{{ $item->name }}"
                                             />
                                         </div>

diff --git a/packages/admin/resources/views/livewire/components/products/forms/related.blade.php b/packages/admin/resources/views/livewire/components/products/forms/related.blade.php
@@ -31,7 +31,7 @@
                         <div class="relative">
                             <div class="h-70 overflow-hidden rounded-lg bg-gray-100 dark:bg-gray-800">
                                 <img
-                                    src="{{ $relatedProduct->getFirstMediaUrl(config('shopper.core.storage.thumbnail_collection')) }}"
+                                    src="{{ $relatedProduct->getFirstMediaUrl(config('shopper.media.storage.thumbnail_collection')) }}"
                                     alt="{{ $relatedProduct->name }} Thumbnail"
                                     class="h-full w-full max-w-none object-cover object-center"
                                 />

diff --git a/packages/admin/resources/views/livewire/pages/orders/detail.blade.php b/packages/admin/resources/views/livewire/pages/orders/detail.blade.php
@@ -143,7 +143,7 @@ class="!w-20"
                                             <div class="shrink-0">
                                                 <img
                                                     class="size-10 rounded-lg object-cover"
-                                                    src="{{ $item->product->getFirstMediaUrl(config('shopper.core.storage.thumbnail_collection')) }}"
+                                                    src="{{ $item->product->getFirstMediaUrl(config('shopper.media.storage.thumbnail_collection')) }}"
                                                     alt="{{ $item->name }}"
                                                 />
                                             </div>

diff --git a/packages/admin/resources/views/livewire/tables/cells/orders/purchased.blade.php b/packages/admin/resources/views/livewire/tables/cells/orders/purchased.blade.php
@@ -5,7 +5,7 @@
 <div class="flex items-center gap-2">
     <img
         class="size-8 rounded-full object-cover"
-        src="{{ $firstItem->product->getFirstMediaUrl(config('shopper.core.storage.thumbnail_collection')) }}"
+        src="{{ $firstItem->product->getFirstMediaUrl(config('shopper.media.storage.thumbnail_collection')) }}"
         alt="Avatar {{ $firstItem->product->name }}"
     />
 

diff --git a/packages/admin/src/Http/Middleware/Authenticate.php b/packages/admin/src/Http/Middleware/Authenticate.php
@@ -15,8 +15,6 @@ protected function authenticate($request, array $guards): void
 
         if (! $guard->check()) {
             $this->unauthenticated($request, $guards);
-
-            return;
         }
 
         $this->auth->shouldUse($guardName);

diff --git a/packages/admin/src/Livewire/Components/Account/Profile.php b/packages/admin/src/Livewire/Components/Account/Profile.php
@@ -44,7 +44,7 @@ public function form(Form $form): Form
                             ->avatar()
                             ->image()
                             ->maxSize(1024)
-                            ->disk(config('shopper.core.storage.disk_name')),
+                            ->disk(config('shopper.media.storage.disk_name')),
                         Components\Grid::make()
                             ->schema([
                                 Components\TextInput::make('first_name')

diff --git a/packages/admin/src/Livewire/Components/Collection/CollectionProducts.php b/packages/admin/src/Livewire/Components/Collection/CollectionProducts.php
@@ -42,7 +42,7 @@ public function table(Table $table): Table
             ->columns([
                 Tables\Columns\SpatieMediaLibraryImageColumn::make('thumbnail')
                     ->label(__('shopper::forms.label.thumbnail'))
-                    ->collection(config('shopper.core.storage.thumbnail_collection'))
+                    ->collection(config('shopper.media.storage.thumbnail_collection'))
                     ->circular()
                     ->defaultImageUrl(shopper_fallback_url()),
                 Tables\Columns\TextColumn::make('name'),

diff --git a/packages/admin/src/Livewire/Components/Products/Form/Edit.php b/packages/admin/src/Livewire/Components/Products/Form/Edit.php
@@ -132,11 +132,12 @@ public function form(Form $form): Form
                                     ->relationship(
                                         relationship: 'categories',
                                         titleAttribute: 'name',
-                                        parentAttribute: 'parent_id'
+                                        parentAttribute: 'parent_id',
+                                        modifyQueryUsing: fn (Builder $query) => $query->where('is_enabled', true)
                                     )
-                                    ->searchable()
                                     ->independent(false)
-                                    ->enableBranchNode()
+                                    ->grouped(false)
+                                    ->searchable()
                                     ->visible(Feature::enabled('category')),
                             ])
                             ->visible(

diff --git a/packages/admin/src/Livewire/Components/Products/Form/Media.php b/packages/admin/src/Livewire/Components/Products/Form/Media.php
@@ -34,21 +34,21 @@ public function form(Form $form): Form
     {
         return $form
             ->schema([
-                Forms\Components\SpatieMediaLibraryFileUpload::make('media')
-                    ->collection(config('shopper.core.storage.collection_name'))
+                Forms\Components\SpatieMediaLibraryFileUpload::make('images')
+                    ->collection(config('shopper.media.storage.collection_name'))
                     ->label(__('shopper::words.images'))
                     ->helperText(__('shopper::pages/products.images_helpText'))
                     ->multiple()
                     ->panelLayout('grid')
+                    ->maxSize(config('shopper.media.max_size.images'))
                     ->columnSpan(['lg' => 2]),
 
                 Forms\Components\SpatieMediaLibraryFileUpload::make('thumbnail')
-                    ->collection(config('shopper.core.storage.thumbnail_collection'))
+                    ->collection(config('shopper.media.storage.thumbnail_collection'))
                     ->label(__('shopper::forms.label.thumbnail'))
                     ->helperText(__('shopper::pages/products.thumbnail_helpText'))
                     ->image()
-                    ->maxSize(1024)
-                    ->imageEditor()
+                    ->maxSize(config('shopper.media.max_size.thumbnail'))
                     ->columnSpan(['lg' => 1]),
             ])
             ->columns(3)

diff --git a/packages/admin/src/Livewire/Components/Products/Form/Variants.php b/packages/admin/src/Livewire/Components/Products/Form/Variants.php
@@ -43,23 +43,18 @@ public function table(Table $table): Table
                     ->newQuery()
             )
             ->columns([
-                Tables\Columns\SpatieMediaLibraryImageColumn::make('images')
-                    ->collection(config('shopper.core.storage.collection_name'))
-                    ->stacked()
-                    ->circular()
-                    ->wrap()
-                    ->defaultImageUrl(shopper_fallback_url()),
-
+                Tables\Columns\SpatieMediaLibraryImageColumn::make('thumbnail')
+                    ->collection(config('shopper.media.storage.thumbnail_collection'))
+                    ->label(__('shopper::forms.label.thumbnail'))
+                    ->circular(),
                 Tables\Columns\TextColumn::make('name')
                     ->label(__('shopper::forms.label.name'))
                     ->searchable()
                     ->sortable(),
-
                 Tables\Columns\TextColumn::make('sku')
                     ->label(__('shopper::layout.tables.sku'))
                     ->searchable()
                     ->sortable(),
-
                 Tables\Columns\TextColumn::make('stock')
                     ->label(__('shopper::layout.tables.current_stock'))
                     ->formatStateUsing(
@@ -70,7 +65,6 @@ public function table(Table $table): Table
                             </div>
                         BLADE))
                     ),
-
                 Tables\Columns\TextColumn::make('price_amount')
                     ->label(__('shopper::forms.label.price'))
                     ->money(shopper_currency())

diff --git a/packages/admin/src/Livewire/Modals/PaymentMethodForm.php b/packages/admin/src/Livewire/Modals/PaymentMethodForm.php
@@ -46,7 +46,7 @@ public function form(Form $form): Form
                     ->avatar()
                     ->image()
                     ->maxSize(1024)
-                    ->disk(config('shopper.core.storage.disk_name'))
+                    ->disk(config('shopper.media.storage.disk_name'))
                     ->columnSpan('full'),
                 Components\TextInput::make('title')
                     ->label(__('shopper::forms.label.payment_method'))

diff --git a/packages/admin/src/Livewire/Pages/Brand/Index.php b/packages/admin/src/Livewire/Pages/Brand/Index.php
@@ -34,7 +34,7 @@ public function table(Table $table): Table
             ->query((new BrandRepository)->query())
             ->columns([
                 Tables\Columns\SpatieMediaLibraryImageColumn::make('Logo')
-                    ->collection(config('shopper.core.storage.thumbnail_collection'))
+                    ->collection(config('shopper.media.storage.thumbnail_collection'))
                     ->circular()
                     ->defaultImageUrl(shopper_fallback_url())
                     ->grow(false),

diff --git a/packages/admin/src/Livewire/Pages/Category/Index.php b/packages/admin/src/Livewire/Pages/Category/Index.php
@@ -37,7 +37,7 @@ public function table(Table $table): Table
             )
             ->columns([
                 Tables\Columns\SpatieMediaLibraryImageColumn::make('image')
-                    ->collection(config('shopper.core.storage.thumbnail_collection'))
+                    ->collection(config('shopper.media.storage.thumbnail_collection'))
                     ->circular()
                     ->defaultImageUrl(shopper_fallback_url())
                     ->grow(false),

diff --git a/packages/admin/src/Livewire/Pages/Collection/Edit.php b/packages/admin/src/Livewire/Pages/Collection/Edit.php
@@ -84,7 +84,7 @@ public function form(Form $form): Form
                     ->schema([
                         Forms\Components\SpatieMediaLibraryFileUpload::make('file')
                             ->label(__('shopper::forms.label.image_preview'))
-                            ->collection(config('shopper.core.storage.thumbnail_collection'))
+                            ->collection(config('shopper.media.storage.thumbnail_collection'))
                             ->image()
                             ->maxSize(1024),
 

diff --git a/packages/admin/src/Livewire/Pages/Collection/Index.php b/packages/admin/src/Livewire/Pages/Collection/Index.php
@@ -34,7 +34,7 @@ public function table(Table $table): Table
             )
             ->columns([
                 Tables\Columns\SpatieMediaLibraryImageColumn::make('image')
-                    ->collection(config('shopper.core.storage.thumbnail_collection'))
+                    ->collection(config('shopper.media.storage.thumbnail_collection'))
                     ->circular()
                     ->defaultImageUrl(shopper_fallback_url())
                     ->grow(false),

diff --git a/packages/admin/src/Livewire/Pages/Product/Create.php b/packages/admin/src/Livewire/Pages/Product/Create.php
@@ -127,21 +127,21 @@ public function form(Form $form): Form
                     Components\Wizard\StepColumn::make(__('shopper::words.media'))
                         ->icon('untitledui-image')
                         ->schema([
-                            Forms\Components\SpatieMediaLibraryFileUpload::make('media')
-                                ->collection(config('shopper.core.storage.collection_name'))
+                            Forms\Components\SpatieMediaLibraryFileUpload::make('images')
+                                ->collection(config('shopper.media.storage.collection_name'))
                                 ->label(__('shopper::words.images'))
                                 ->helperText(__('shopper::pages/products.images_helpText'))
                                 ->multiple()
                                 ->panelLayout('grid')
+                                ->maxSize(config('shopper.media.max_size.images'))
                                 ->columnSpan(['lg' => 3]),
 
                             Forms\Components\SpatieMediaLibraryFileUpload::make('thumbnail')
-                                ->collection(config('shopper.core.storage.thumbnail_collection'))
+                                ->collection(config('shopper.media.storage.thumbnail_collection'))
                                 ->label(__('shopper::forms.label.thumbnail'))
                                 ->helperText(__('shopper::pages/products.thumbnail_helpText'))
                                 ->image()
-                                ->maxSize(1024)
-                                ->imageEditor()
+                                ->maxSize(config('shopper.media.max_size.thumbnail'))
                                 ->columnSpan(['lg' => 2]),
                         ])
                         ->columns(5),
@@ -167,10 +167,11 @@ public function form(Form $form): Form
                                 ->relationship(
                                     relationship: 'categories',
                                     titleAttribute: 'name',
-                                    parentAttribute: 'parent_id'
+                                    parentAttribute: 'parent_id',
+                                    modifyQueryUsing: fn (Builder $query) => $query->where('is_enabled', true)
                                 )
                                 ->independent(false)
-                                ->enableBranchNode()
+                                ->grouped(false)
                                 ->searchable()
                                 ->visible(Feature::enabled('category')),
                         ])
-Original file line number
+Diff line change
@@ Expand Up @@
     :::tip
     If you update this configuration, you have to republish the assets to take the new link.
     The assets are dynamically loaded by a symbolic link named as the prefix.
     ```php
     php artisan shopper:link
     ```
@@ Expand Down @@