Added SearchResult DTO

Author: fabio-ivona

README.md

@@ -137,6 +137,7 @@ class ProductResource
 ```php
 
 use DefStudio\SearchableInput\Forms\Components\SearchableInput;
+use DefStudio\SearchableInput\DTO\SearchResult;
 
 class ProductResource
 {
@@ -149,32 +150,24 @@ class ProductResource
                     return Product::query()
                         ->where('description', 'like', "%$search%")
                         ->limit(15)
-                        ->map(fn(Product $product) => [
-                            'value' => $product->description,
-                            'label' => $product->code . ' - ' . $product->description,
-                            'product_id' => $product->id,
-                            'product_code' => $product->code,
-                        ])
+                        ->map(fn(Product $product) => SearchResult::make($product->description, "[$product->code] $product->description")
+                            ->withData('product_id', $product->id)
+                            ->withData('product_code', $product->code) 
+                        )
                         ->toArray()
 
                 })
-                ->onItemSelected(function(array $item){
-                    /*
-                     * $item = [
-                     *      'value' => // "product description",
-                     *      'label' => //the dropdown label
-                     *      'product_id' => eg. 42
-                     *      'product_code' => eg. "AB0042"
-                     * ]
-                     */ 
+                ->onItemSelected(function(SearchResult $item){
+                    $item->value();
+                    $item->label();
+                    $item->get('product_id');
+                    $item->get('product_code');
                 }),
         ]);
     }
 }
 ```
 
-Note: in order for this to work, each item must have at least a `value` and a `label` key.
-
 
 ## Filament Utility Injection
 

resources/js/index.js

@@ -0,0 +1,63 @@
+<?php
+
+namespace DefStudio\SearchableInput\DTO;
+
+use Illuminate\Contracts\Support\Arrayable;
+
+class SearchResult implements Arrayable
+{
+    protected array $data = [];
+
+    public function __construct(
+        protected string $value,
+        protected string $label,
+    ) {
+    }
+
+    public static function make(string $value, string $label = null): self
+    {
+        return new static($value, $label ?? $value);
+    }
+
+    public function withData(string|array $key, string $value): self
+    {
+        if (is_array($key)) {
+            $this->data = $key;
+            return $this;
+        }
+
+        data_set($this->data, $key, $value);
+        return $this;
+    }
+
+    public function value(): string
+    {
+        return $this->value;
+    }
+
+    public function label(): string
+    {
+        return $this->label;
+    }
+
+    public function get(string $key, mixed $default = null): array
+    {
+        return data_get($this->data, $key, $default);
+    }
+
+    public static function fromArray(array $item): self
+    {
+        $dto = new static($item['value'], $item['label'] ?? $item['value']);
+        $dto->data = $item['data'] ?? [];
+
+        return $dto;
+    }
+
+    public function toArray(): array
+    {
+        return [
+            'value' => $this->value,
+            'label' => $this->label,
+        ];
+    }
+}

src/DTO/SearchResult.php

@@ -3,15 +3,16 @@
 namespace DefStudio\SearchableInput\Forms\Components;
 
 use Closure;
+use DefStudio\SearchableInput\DTO\SearchResult;
 use Filament\Forms\Components\Actions\Action;
 use Filament\Forms\Components\TextInput;
 
 class SearchableInput extends TextInput
 {
-    /** @var ?Closure(string): ?array<int|string, string|array{label: string, value: string}> */
+    /** @var ?Closure(string): ?array<int|string, string|SearchResult> */
     protected ?Closure $searchUsing = null;
 
-    /** @var ?Closure(array{label: string, value: string}>:): void */
+    /** @var ?Closure(SearchResult $item): void */
     protected ?Closure $onItemSelected = null;
 
     /** @var array<array-key, string>|Closure(): ?array<array-key, string>|null */
@@ -43,16 +44,11 @@ protected function setUp(): void
                 if (collect($results)->every(fn ($item) => is_string($item))) {
                     if (array_is_list($results)) {
                         $results = collect($results)
-                            ->map(fn ($item) => [
-                                'value' => $item,
-                                'label' => $item,
-                            ])->toArray();
+                            ->map(fn ($item) => SearchResult::make($item))
+                            ->toArray();
                     } else {
                         $results = collect($results)
-                            ->map(fn ($item, $key) => [
-                                'value' => $key,
-                                'label' => $item,
-                            ])->toArray();
+                            ->map(fn ($item, $key) => SearchResult::make($key, $item))->toArray();
                     }
                 }
 
@@ -61,7 +57,7 @@ protected function setUp(): void
 
             Action::make('item_selected')->action(function ($arguments) {
                 $this->evaluate($this->onItemSelected, [
-                    'item' => $arguments['item'],
+                    'item' => SearchResult::make($arguments['item']),
                 ]);
             }),
         ]);
@@ -85,13 +81,19 @@ public function options(array | Closure | null $options): static
         return $this;
     }
 
+    /**
+     * @param  ?Closure(string): ?array<int|string, string|SearchResult>  $searchUsing
+     */
     public function searchUsing(?Closure $searchUsing): static
     {
         $this->searchUsing = $searchUsing;
 
         return $this;
     }
 
+    /**
+     * @param  ?Closure(SearchResult $item): void  $callback
+     */
     public function onItemSelected(?Closure $callback): static
     {
         $this->onItemSelected = $callback;