Fix: ordering of multiple images with relationship

README.md

@@ -119,6 +119,7 @@ CuratorPicker::make(string $fieldName)
     ->imageResizeTargetHeight()
     ->multiple() // required if using a relationship with multiple media
     ->relationship(string $relationshipName, string 'titleColumnName')
+    ->orderColumn('order') // only necessary to rename the order column if using a relationship with multiple media
 ```
 
 ### Relationships
@@ -150,7 +151,8 @@ Form component
 ```php
 CuratorPicker::make('product_picture_ids')
     ->multiple()
-    ->relationship('product_pictures', 'id'),
+    ->relationship('product_pictures', 'id')
+    ->orderColumn('order'), // only necessary if you need to rename the order column
 ```
 
 Model
@@ -160,7 +162,10 @@ use Awcodes\Curator\Models\Media;
 
 public function productPictures(): BelongsTo
 {
-    return $this->belongsToMany(Media::class, 'media_post', 'post_id', 'media_id');
+    return $this
+        ->belongsToMany(Media::class, 'media_post', 'post_id', 'media_id')
+        ->withPivot('order')
+        ->orderBy('order');
 }
 ```
 

src/Components/Forms/CuratorPicker.php

@@ -63,6 +63,8 @@ class CuratorPicker extends Field
 
     protected string|Closure|null $relationship = null;
 
+    protected string | null $orderColumn = null;
+
     /**
      * @throws Exception
      */
@@ -244,6 +246,13 @@ public function preserveFilenames(bool|Closure|null $condition = true): static
         return $this;
     }
 
+    public function orderColumn(string $column): static
+    {
+        $this->orderColumn = $column;
+
+        return $this;
+    }
+
     /**
      * @deprecated
      */
@@ -341,6 +350,11 @@ public function isMultiple(): bool
         return $this->evaluate($this->isMultiple);
     }
 
+    public function getOrderColumn(): string
+    {
+        return $this->orderColumn ?? 'order';
+    }
+
     public function relationship(string | Closure $relationshipName, string | Closure $titleColumnName, ?Closure $callback = null): static
     {
         $this->relationship = $relationshipName;
@@ -380,14 +394,29 @@ public function relationship(string | Closure $relationshipName, string | Closur
                 return;
             }
 
+            $relationship = $component->getRelationship();
+
             if ($component->isMultiple()) {
+                if (
+                    ($relationship instanceof BelongsToMany) &&
+                    in_array($component->getOrderColumn(), $relationship->getPivotColumns())
+                ) {
+                    $orderColumn = $component->getOrderColumn();
+                    $state = collect(array_values($state))->mapWithKeys(function($item, $index) use ($orderColumn) {
+                       return [$item['id'] => [$orderColumn => $index + 1]];
+                    });
+
+                    $relationship->sync($state ?? []);
+                    return;
+                }
+
                 $state = Arr::pluck($state,'id');
-                $component->getRelationship()->sync($state ?? []);
+                $relationship->sync($state ?? []);
 
                 return;
             }
 
-            $component->getRelationship()->associate(Arr::first($state)['id']);
+            $relationship->associate(Arr::first($state)['id']);
             $record->save();
         });