✨ scout with and only trashed

src/Query/ScoutBuilder.php

@@ -41,6 +41,10 @@ public function search(array $parameters = [])
             $this->applyFilters($parameters['filters']);
         });
 
+        $this->when(isset($parameters['text']['trashed']), function () use ($parameters) {
+            $this->applyTrashed($parameters['text']['trashed']);
+        });
+
         $this->when(isset($parameters['sorts']), function () use ($parameters) {
             $this->applySorts($parameters['sorts']);
         });
@@ -125,6 +129,15 @@ public function applySorts($sorts)
         }
     }
 
+    public function applyTrashed(string $trashed): void
+    {
+        if ($trashed === 'only') {
+            $this->queryBuilder->onlyTrashed();
+        } elseif ($trashed === 'with') {
+            $this->queryBuilder->withTrashed();
+        }
+    }
+
     /**
      * Apply an instruction to the query builder.
      *

src/Rules/Search/SearchText.php

@@ -2,6 +2,7 @@
 
 namespace Lomkit\Rest\Rules\Search;
 
+use Illuminate\Validation\Rule;
 use Lomkit\Rest\Rules\RestRule;
 
 class SearchText extends RestRule
@@ -15,8 +16,11 @@ public function buildValidationRules(string $attribute, mixed $value): array
         }
 
         return [
-            $attribute          => ['sometimes', 'array'],
-            $attribute.'.value' => ['nullable', 'string'],
+            $attribute            => ['sometimes', 'array'],
+            $attribute.'.value'   => ['nullable', 'string'],
+            $attribute.'.trashed' => [
+                Rule::in('with', 'only'),
+            ],
         ];
     }
 }

tests/Feature/Controllers/SearchScoutOperationsTest.php

@@ -379,4 +379,78 @@ public function test_getting_a_list_of_resources_with_null_scout(): void
             new ModelResource()
         );
     }
+
+    public function test_getting_a_list_of_resources_with_unknown_trashed(): void
+    {
+        ModelFactory::new()->count(2)->create();
+
+        Gate::policy(Model::class, GreenPolicy::class);
+
+        $response = $this->post(
+            '/api/searchable-models/search',
+            [
+                'search' => [
+                    'text' => [
+                        'trashed' => 'unknown',
+                    ],
+                ],
+            ],
+            ['Accept' => 'application/json']
+        );
+
+        $response->assertStatus(422);
+        $response->assertExactJsonStructure(['message', 'errors' => ['search.text.trashed']]);
+    }
+
+    public function test_getting_a_list_of_resources_with_trashed(): void
+    {
+        ModelFactory::new()->count(2)->create();
+
+        Gate::policy(Model::class, GreenPolicy::class);
+
+        $response = $this->post(
+            '/api/searchable-models/search',
+            [
+                'search' => [
+                    'text' => [
+                        'trashed' => 'with',
+                    ],
+                ],
+            ],
+            ['Accept' => 'application/json']
+        );
+
+        $this->assertResourcePaginated(
+            $response,
+            [],
+            new ModelResource()
+        );
+    }
+
+    public function test_getting_a_list_of_resources_only_trashed(): void
+    {
+        ModelFactory::new()->count(2)->create();
+
+        Gate::policy(Model::class, GreenPolicy::class);
+
+        $response = $this->post(
+            '/api/searchable-models/search',
+            [
+                'search' => [
+                    'text' => [
+                        'trashed' => 'only',
+                    ],
+                ],
+            ],
+            ['Accept' => 'application/json']
+        );
+
+        // @TODO: test only correctly applyed
+
+        $this->assertResourcePaginated(
+            $response,
+            [],
+            new ModelResource()
+        );
+    }
 }

tests/Unit/LaravelScoutTest.php

@@ -47,9 +47,7 @@ public function test_building_scout_with_filters()
 
         $scoutQueryBuilderMock
             ->search([
-                'text' => [
-                    ['value' => 'test'],
-                ],
+                'text'    => ['value' => 'test'],
                 'filters' => [
                     ['field' => 'test', 'value' => 1],
                 ],
@@ -69,9 +67,7 @@ public function test_building_scout_with_sorts()
 
         $scoutQueryBuilderMock
             ->search([
-                'text' => [
-                    ['value' => 'test'],
-                ],
+                'text'  => ['value' => 'test'],
                 'sorts' => [
                     ['field' => 'id'],
                 ],
@@ -91,14 +87,58 @@ public function test_building_scout_with_instructions()
 
         $scoutQueryBuilderMock
             ->search([
-                'text' => [
-                    ['value' => 'test'],
-                ],
+                'text'         => ['value' => 'test'],
                 'instructions' => [
                     ['name' => 'my_instruction'],
                 ],
             ]);
 
         ($scoutQueryBuilderMock->toBase()->queryCallback)(Model::query());
     }
+
+    public function test_building_scout_with_trashed()
+    {
+        Auth::setUser(Mockery::mock(User::class));
+        Gate::policy(Model::class, GreenPolicy::class);
+
+        $scoutQueryBuilderMock = Mockery::mock(ScoutBuilder::class, [new SearchableModelResource()])->makePartial();
+
+        $scoutQueryBuilderMock->shouldReceive('applyFilters')->never();
+        $scoutQueryBuilderMock->shouldReceive('applySorts')->never();
+        $scoutQueryBuilderMock->shouldReceive('applyInstructions')->never();
+        $scoutQueryBuilderMock->shouldReceive('applyTrashed')->with('with')->once();
+
+        $scoutQueryBuilderMock
+            ->search([
+                'text' => [
+                    'value'   => 'test',
+                    'trashed' => 'with',
+                ],
+            ]);
+
+        ($scoutQueryBuilderMock->toBase()->queryCallback)(Model::query());
+    }
+
+    public function test_building_scout_only_trashed()
+    {
+        Auth::setUser(Mockery::mock(User::class));
+        Gate::policy(Model::class, GreenPolicy::class);
+
+        $scoutQueryBuilderMock = Mockery::mock(ScoutBuilder::class, [new SearchableModelResource()])->makePartial();
+
+        $scoutQueryBuilderMock->shouldReceive('applyFilters')->never();
+        $scoutQueryBuilderMock->shouldReceive('applySorts')->never();
+        $scoutQueryBuilderMock->shouldReceive('applyInstructions')->never();
+        $scoutQueryBuilderMock->shouldReceive('applyTrashed')->with('only')->once();
+
+        $scoutQueryBuilderMock
+            ->search([
+                'text' => [
+                    'value'   => 'test',
+                    'trashed' => 'only',
+                ],
+            ]);
+
+        ($scoutQueryBuilderMock->toBase()->queryCallback)(Model::query());
+    }
 }