9.2.0 (#609)

* feat: add advanced filters meta payload

* Fix styling

* feat: handle additional payload for advanced filters

* fix: wip

---------

Co-authored-by: binaryk <[email protected]>

docs-v2/content/en/search/advanced-filters.md

@@ -364,8 +364,18 @@ The response will look like this:
       "key": "created-after-date-filter",
       "type": "timestamp",
       "options": []
+    },
+    {
+      "key": "email",
+      "type": "value",
+      "description": "Email",
+      "label": "Email",
+      "meta": {
+        "operator": "like"
+      }
     }
   ]
+}
 ```
 
 Along with custom filters, you can also include in the response the primary filters (as matches), by using `?include` query param: 
@@ -374,3 +384,47 @@ Along with custom filters, you can also include in the response the primary filt
 /api/restify/posts/filters?include=matches,searchables,sortables
 ```
 
+## Handling Additional Payload Data in Advanced Filters
+
+In some scenarios, you might want to send additional data beyond the standard key and value in your filter payload. For instance, you may need to specify an operator or a column to apply more complex filtering logic. Laravel Restify Advanced Filters provide a way to handle these additional payload fields using the `$this->rest()` method.
+
+**Example Payload**
+
+Consider the following payload:
+```json
+const filters = btoa(JSON.stringify([
+    {
+        'key': ValueFilter::uriKey(),
+        'value': 'Valid%',
+        'operator' => 'like',
+        'column' => 'description',
+    }
+]));
+
+const response = await axios.get(`api/restify/posts?filters=${filters}`);
+```
+
+In this payload, besides the standard key and value, we are also sending operator and column. The operator specifies the type of SQL operation, and the column specifies the database column to filter.
+
+Using `$this->rest()` to Access Additional Data
+
+To handle these additional fields in your filter class, you need to ensure they are accessible via the `$this->rest()` method. Here is how you can achieve that:
+
+```php
+class ValueFilter extends AdvancedFilter
+{
+    public function filter(RestifyRequest $request, Builder|Relation $query, $value)
+    {
+        $operator = $this->rest('operator');
+        $column = $this->rest('column');
+
+        $query->where($column, $operator, $value);
+    }
+
+    public function rules(Request $request): array
+    {
+        return [];
+    }
+}
+```
+

src/Actions/DestructiveAction.php

@@ -2,6 +2,4 @@
 
 namespace Binaryk\LaravelRestify\Actions;
 
-abstract class DestructiveAction extends Action
-{
-}
+abstract class DestructiveAction extends Action {}

src/Bootstrap/Boot.php

@@ -10,8 +10,7 @@ class Boot
     public function __construct(
         private Request $request,
         private RoutesBoot $routesBoot,
-    ) {
-    }
+    ) {}
 
     public function boot(): void
     {

src/Bootstrap/BootRepository.php

@@ -9,8 +9,7 @@ class BootRepository
     /** * @var Repository */
     public function __construct(
         private string $repository
-    ) {
-    }
+    ) {}
 
     public function boot(): void
     {

src/Events/AdvancedFiltersApplied.php

@@ -11,6 +11,5 @@ public function __construct(
         public Repository $repository,
         public AdvancedFiltersCollection $advancedFiltersCollection,
         public ?string $rawFilters = null,
-    ) {
-    }
+    ) {}
 }

src/Exceptions/CredentialsDoesntMatch.php

@@ -7,6 +7,4 @@
 /**
  * @author Eduard Lupacescu <[email protected]>
  */
-class CredentialsDoesntMatch extends Exception
-{
-}
+class CredentialsDoesntMatch extends Exception {}

src/Exceptions/Eloquent/EntityNotFoundException.php

@@ -2,6 +2,4 @@
 
 namespace Binaryk\LaravelRestify\Exceptions\Eloquent;
 
-class EntityNotFoundException extends \Exception
-{
-}
+class EntityNotFoundException extends \Exception {}

src/Exceptions/PasswordResetException.php

@@ -7,6 +7,4 @@
 /**
  * @author Eduard Lupacescu <[email protected]>
  */
-class PasswordResetException extends Exception
-{
-}
+class PasswordResetException extends Exception {}

src/Exceptions/PasswordResetInvalidTokenException.php

@@ -7,6 +7,4 @@
 /**
  * @author Eduard Lupacescu <[email protected]>
  */
-class PasswordResetInvalidTokenException extends Exception
-{
-}
+class PasswordResetInvalidTokenException extends Exception {}

src/Exceptions/UnauthenticateException.php

@@ -7,6 +7,4 @@
 /**
  * @author Eduard Lupacescu <[email protected]>
  */
-class UnauthenticateException extends Exception
-{
-}
+class UnauthenticateException extends Exception {}

src/Exceptions/UnverifiedUser.php

@@ -7,6 +7,4 @@
 /**
  * @author Eduard Lupacescu <[email protected]>
  */
-class UnverifiedUser extends Exception
-{
-}
+class UnverifiedUser extends Exception {}

src/Fields/BaseField.php

@@ -2,6 +2,4 @@
 
 namespace Binaryk\LaravelRestify\Fields;
 
-abstract class BaseField
-{
-}
+abstract class BaseField {}

src/Fields/HasField.php

@@ -2,6 +2,4 @@
 
 namespace Binaryk\LaravelRestify\Fields;
 
-class HasField extends EagerField
-{
-}
+class HasField extends EagerField {}

src/Fields/MorphMany.php

@@ -2,6 +2,4 @@
 
 namespace Binaryk\LaravelRestify\Fields;
 
-class MorphMany extends HasMany
-{
-}
+class MorphMany extends HasMany {}

src/Fields/MorphOne.php

@@ -2,6 +2,4 @@
 
 namespace Binaryk\LaravelRestify\Fields;
 
-class MorphOne extends BelongsTo
-{
-}
+class MorphOne extends BelongsTo {}

src/Fields/MorphToMany.php

@@ -2,6 +2,4 @@
 
 namespace Binaryk\LaravelRestify\Fields;
 
-class MorphToMany extends BelongsToMany
-{
-}
+class MorphToMany extends BelongsToMany {}

src/Filters/AdvancedFilter.php

@@ -37,5 +37,10 @@ protected function input(?string $key = null, $default = null)
         return data_get($this->dataObject->value, $key, $default);
     }
 
+    protected function rest(?string $key = null, $default = null)
+    {
+        return data_get($this->dataObject->rest, $key, $default);
+    }
+
     abstract public function rules(Request $request): array;
 }

src/Filters/AdvancedFilterPayloadDataObject.php

@@ -6,9 +6,14 @@
 
 class AdvancedFilterPayloadDataObject extends Data
 {
+    public array $rest;
+
     public function __construct(
         public string $key,
         public mixed $value,
+        array $rest = []
+
     ) {
+        $this->rest = $rest;
     }
 }

src/Filters/AdvancedFiltersCollection.php

@@ -47,10 +47,17 @@ public static function collectQueryFilters(RestifyRequest $request, Repository $
 
                 $advancedFilter = clone $advancedFilter;
 
+                $key = data_get($queryFilter, 'key');
+                $value = data_get($queryFilter, 'value');
+                unset($queryFilter['key'], $queryFilter['value']);
+
                 return $advancedFilter->resolve($request, $dto = new AdvancedFilterPayloadDataObject(
-                    key: data_get($queryFilter, 'key'),
-                    value: data_get($queryFilter, 'value'),
-                ))->validatePayload($request, $dto);
+                    $key,
+                    $value,
+                    $queryFilter,
+                ))
+                    ->withMeta($queryFilter['meta'] ?? [])
+                    ->validatePayload($request, $dto);
             })
             ->filter();
     }

src/Filters/Filter.php

@@ -259,9 +259,7 @@ public function dd(): self
         return $this;
     }
 
-    protected function booted()
-    {
-    }
+    protected function booted() {}
 
     protected function getType(): string
     {

src/Filters/FilterPayload.php

@@ -2,6 +2,4 @@
 
 namespace Binaryk\LaravelRestify\Filters;
 
-interface FilterPayload
-{
-}
+interface FilterPayload {}

src/Filters/FiltersCollection.php

@@ -10,6 +10,4 @@
  *
  * @extends \Illuminate\Support\Collection<TKey, TValue>
  */
-class FiltersCollection extends Collection
-{
-}
+class FiltersCollection extends Collection {}

src/Filters/PaginationDataObject.php

@@ -9,6 +9,5 @@ class PaginationDataObject extends Data
     public function __construct(
         public int|string|null $perPage,
         public int|string|null $page,
-    ) {
-    }
+    ) {}
 }

src/Filters/RelatedQueryCollection.php

@@ -10,6 +10,4 @@
  *
  * @extends \Illuminate\Support\Collection<TKey, TValue>
  */
-class RelatedQueryCollection extends Collection
-{
-}
+class RelatedQueryCollection extends Collection {}

src/Http/Controllers/RepositoryController.php

@@ -2,6 +2,4 @@
 
 namespace Binaryk\LaravelRestify\Http\Controllers;
 
-class RepositoryController extends RestController
-{
-}
+class RepositoryController extends RestController {}

src/Http/Requests/GlobalSearchRequest.php

@@ -2,6 +2,4 @@
 
 namespace Binaryk\LaravelRestify\Http\Requests;
 
-class GlobalSearchRequest extends RestifyRequest
-{
-}
+class GlobalSearchRequest extends RestifyRequest {}

src/Http/Requests/IndexRepositoryActionRequest.php

@@ -2,6 +2,4 @@
 
 namespace Binaryk\LaravelRestify\Http\Requests;
 
-class IndexRepositoryActionRequest extends ActionRequest
-{
-}
+class IndexRepositoryActionRequest extends ActionRequest {}

src/Http/Requests/ProfileRequestRequest.php

@@ -2,6 +2,4 @@
 
 namespace Binaryk\LaravelRestify\Http\Requests;
 
-class ProfileRequestRequest extends RepositoryShowRequest
-{
-}
+class ProfileRequestRequest extends RepositoryShowRequest {}

src/Http/Requests/RepositoryActionRequest.php

@@ -2,6 +2,4 @@
 
 namespace Binaryk\LaravelRestify\Http\Requests;
 
-class RepositoryActionRequest extends ActionRequest
-{
-}
+class RepositoryActionRequest extends ActionRequest {}

src/Http/Requests/RepositoryDestroyBulkRequest.php

@@ -2,6 +2,4 @@
 
 namespace Binaryk\LaravelRestify\Http\Requests;
 
-class RepositoryDestroyBulkRequest extends RestifyRequest
-{
-}
+class RepositoryDestroyBulkRequest extends RestifyRequest {}

src/Http/Requests/RepositoryDestroyRequest.php

@@ -2,6 +2,4 @@
 
 namespace Binaryk\LaravelRestify\Http\Requests;
 
-class RepositoryDestroyRequest extends RestifyRequest
-{
-}
+class RepositoryDestroyRequest extends RestifyRequest {}

src/Http/Requests/RepositoryFiltersRequest.php

@@ -2,6 +2,4 @@
 
 namespace Binaryk\LaravelRestify\Http\Requests;
 
-class RepositoryFiltersRequest extends RestifyRequest
-{
-}
+class RepositoryFiltersRequest extends RestifyRequest {}

src/Http/Requests/RepositoryGetterRequest.php

@@ -2,6 +2,4 @@
 
 namespace Binaryk\LaravelRestify\Http\Requests;
 
-class RepositoryGetterRequest extends GetterRequest
-{
-}
+class RepositoryGetterRequest extends GetterRequest {}

src/Http/Requests/RepositoryIndexRequest.php

@@ -2,6 +2,4 @@
 
 namespace Binaryk\LaravelRestify\Http\Requests;
 
-class RepositoryIndexRequest extends RestifyRequest
-{
-}
+class RepositoryIndexRequest extends RestifyRequest {}

src/Http/Requests/RepositoryPatchRequest.php

@@ -2,6 +2,4 @@
 
 namespace Binaryk\LaravelRestify\Http\Requests;
 
-class RepositoryPatchRequest extends RepositoryUpdateRequest
-{
-}
+class RepositoryPatchRequest extends RepositoryUpdateRequest {}

src/Http/Requests/RepositoryShowRequest.php

@@ -2,6 +2,4 @@
 
 namespace Binaryk\LaravelRestify\Http\Requests;
 
-class RepositoryShowRequest extends RestifyRequest
-{
-}
+class RepositoryShowRequest extends RestifyRequest {}

src/Http/Requests/RepositoryStoreRequest.php

@@ -2,6 +2,4 @@
 
 namespace Binaryk\LaravelRestify\Http\Requests;
 
-class RepositoryStoreRequest extends RestifyRequest
-{
-}
+class RepositoryStoreRequest extends RestifyRequest {}

src/Http/Requests/RepositoryUpdateRequest.php

@@ -2,6 +2,4 @@
 
 namespace Binaryk\LaravelRestify\Http\Requests;
 
-class RepositoryUpdateRequest extends RestifyRequest
-{
-}
+class RepositoryUpdateRequest extends RestifyRequest {}