feature: install spatie/laravel-json-api-paginate and support current…

…_sort

composer.json

@@ -35,6 +35,7 @@
         "rebing/graphql-laravel": "^9.1",
         "spatie/laravel-activitylog": "^4.7",
         "spatie/laravel-data": "^2.1",
+        "spatie/laravel-json-api-paginate": "^1.13",
         "spatie/laravel-model-states": "^2.3",
         "spatie/laravel-permission": "^5.9",
         "spatie/laravel-query-builder": "5.1.2",

config/json-api-paginate.php

@@ -0,0 +1,58 @@
+<?php
+
+return [
+
+    /*
+     * The maximum number of results that will be returned
+     * when using the JSON API paginator.
+     */
+    'max_results' => 50,
+
+    /*
+     * The default number of results that will be returned
+     * when using the JSON API paginator.
+     */
+    'default_size' => 20,
+
+    /*
+     * The key of the page[x] query string parameter for page number.
+     */
+    'number_parameter' => 'number',
+
+    /*
+     * The key of the page[x] query string parameter for page size.
+     */
+    'size_parameter' => 'size',
+
+    /*
+     * The key of the page[x] query string parameter for cursor.
+     */
+    'cursor_parameter' => 'cursor',
+
+    /*
+     * The name of the macro that is added to the Eloquent query builder.
+     */
+    'method_name' => 'jsonPaginate',
+
+    /*
+     * If you only need to display Next and Previous links, you may use
+     * simple pagination to perform a more efficient query.
+     */
+    'use_simple_pagination' => false,
+
+    /*
+     * If you want to use cursor pagination, set this to true.
+     * This would override use_simple_pagination.
+     */
+    'use_cursor_pagination' => false,
+
+    /*
+     * Here you can override the base url to be used in the link items.
+     */
+    'base_url' => null,
+
+    /*
+     * The name of the query parameter used for pagination
+     */
+    'pagination_parameter' => 'page',
+];

src/App/Api/PublicQuotes/Controllers/PublicQuotesController.php

@@ -7,6 +7,7 @@
 use App\Api\PublicQuotes\Resources\PublicQuoteResource;
 use App\Controller;
 use Illuminate\Http\Resources\Json\AnonymousResourceCollection;
+use Support\Metadata\GetQueryMetaDataAction;
 
 /** @authenticated */
 class PublicQuotesController extends Controller
@@ -19,9 +20,12 @@ class PublicQuotesController extends Controller
      */
     public function index(PublicQuoteIndexQuery $quoteQuery): AnonymousResourceCollection
     {
-        $quotes = $quoteQuery->paginate();
+        $quotes = $quoteQuery
+            ->jsonPaginate()
+            ->withQueryString();
 
-        return PublicQuoteResource::collection($quotes);
+        return PublicQuoteResource::collection($quotes)
+            ->additional(['meta' => (new GetQueryMetaDataAction())->__invoke($quoteQuery->getQuery())]);
     }
 
     /**

src/App/Api/PublicQuotes/Queries/PublicQuoteIndexQuery.php

@@ -26,6 +26,7 @@ public function __construct(Request $request)
 
         $this->allowedFilters(['title', 'content', 'user_id'])
             ->allowedIncludes('user')
+            ->defaultSort('created_at')
             ->allowedSorts('id', 'title', 'created_at');
     }
 }

src/App/Api/Quotes/Controllers/QuoteController.php

@@ -16,6 +16,7 @@
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Resources\Json\AnonymousResourceCollection;
 use Spatie\ModelStates\Exceptions\CouldNotPerformTransition;
+use Support\Metadata\GetQueryMetaDataAction;
 
 /** @authenticated */
 class QuoteController extends Controller
@@ -28,9 +29,12 @@ class QuoteController extends Controller
      */
     public function index(IndexQuoteQuery $quoteQuery): AnonymousResourceCollection
     {
-        $quotes = $quoteQuery->paginate();
+        $quotes = $quoteQuery
+            ->jsonPaginate()
+            ->withQueryString();
 
-        return QuoteResource::collection($quotes);
+        return QuoteResource::collection($quotes)
+            ->additional(['meta' => (new GetQueryMetaDataAction())->__invoke($quoteQuery->getQuery())]);
     }
 
     /**

src/App/Api/Quotes/Queries/IndexQuoteQuery.php

@@ -29,6 +29,7 @@ public function __construct(Request $request)
         parent::__construct($query, $request);
 
         $this->allowedFilters(['title', 'content', 'state'])
+            ->defaultSort('created_at')
             ->allowedSorts('id', 'title', 'created_at');
     }
 }

src/App/Api/Ratings/Controllers/RatingController.php

@@ -16,6 +16,7 @@
 use Illuminate\Auth\Access\AuthorizationException;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Resources\Json\AnonymousResourceCollection;
+use Support\Metadata\GetQueryMetaDataAction;
 
 /** @authenticated */
 class RatingController extends Controller
@@ -26,11 +27,14 @@ class RatingController extends Controller
      * @bodyParam include string Include qualifier and rateable Example: qualifier,rateable
      * @bodyParam sort string Sort by fields Example: id,created_at
      */
-    public function index(RatingIndexQuery $quoteQuery): AnonymousResourceCollection
+    public function index(RatingIndexQuery $ratingQuery): AnonymousResourceCollection
     {
-        $quotes = $quoteQuery->paginate();
+        $quotes = $ratingQuery
+            ->jsonPaginate()
+            ->withQueryString();
 
-        return RatingResource::collection($quotes);
+        return RatingResource::collection($quotes)
+            ->additional(['meta' => (new GetQueryMetaDataAction())->__invoke($ratingQuery->getQuery())]);
     }
 
     /**

src/App/Api/Ratings/Queries/RatingIndexQuery.php

@@ -25,6 +25,7 @@ public function __construct(Request $request)
 
         $this->allowedFilters(['qualifier_type', 'rateable_type'])
             ->allowedIncludes(['qualifier', 'rateable'])
+            ->defaultSort('created_at')
             ->allowedSorts('id', 'created_at');
     }
 }

src/App/Api/Users/Controllers/UserController.php

@@ -7,6 +7,7 @@
 use App\Api\Users\Resources\UserResource;
 use App\Controller;
 use Illuminate\Http\Resources\Json\AnonymousResourceCollection;
+use Support\Metadata\GetQueryMetaDataAction;
 
 /** @authenticated */
 class UserController extends Controller
@@ -19,9 +20,12 @@ class UserController extends Controller
      */
     public function index(UserIndexQuery $userQuery): AnonymousResourceCollection
     {
-        $users = $userQuery->paginate();
+        $users = $userQuery
+            ->jsonPaginate()
+            ->withQueryString();
 
-        return UserResource::collection($users);
+        return UserResource::collection($users)
+            ->additional(['meta' => (new GetQueryMetaDataAction())->__invoke($userQuery->getQuery())]);
     }
 
     /**

src/App/Api/Users/Queries/UserIndexQuery.php

@@ -21,6 +21,7 @@ public function __construct(Request $request)
 
         $this->allowedFilters(['id', 'name'])
             ->allowedIncludes('quotes')
-            ->allowedSorts('id', 'name');
+            ->defaultSort('created_at')
+            ->allowedSorts('id', 'name', 'created_at');
     }
 }

src/App/ApiAdmin/Activities/Controllers/ActivityController.php

@@ -12,6 +12,7 @@
 use Illuminate\Http\Resources\Json\AnonymousResourceCollection;
 use Maatwebsite\Excel\Facades\Excel;
 use Spatie\Activitylog\Models\Activity;
+use Support\Metadata\GetQueryMetaDataAction;
 use Symfony\Component\HttpFoundation\BinaryFileResponse;
 
 /** @authenticated */
@@ -27,9 +28,12 @@ public function index(ActivityIndexQuery $activityQuery): AnonymousResourceColle
     {
         $this->authorize('viewAny', Activity::class);
 
-        $activities = $activityQuery->paginate();
+        $activities = $activityQuery
+            ->jsonPaginate()
+            ->withQueryString();
 
-        return ActivityResource::collection($activities);
+        return ActivityResource::collection($activities)
+            ->additional(['meta' => (new GetQueryMetaDataAction())->__invoke($activityQuery->getQuery())]);
     }
 
     /**

src/App/ApiAdmin/Users/Controllers/UserController.php

@@ -12,6 +12,7 @@
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Resources\Json\AnonymousResourceCollection;
 use Illuminate\Support\Facades\Auth;
+use Support\Metadata\GetQueryMetaDataAction;
 
 /** @authenticated */
 class UserController extends Controller
@@ -29,9 +30,12 @@ public function index(UserIndexQuery $userQuery): AnonymousResourceCollection
     {
         $this->authorize('viewAny', User::class);
 
-        $users = $userQuery->paginate();
+        $users = $userQuery
+            ->jsonPaginate()
+            ->withQueryString();
 
-        return UserResource::collection($users);
+        return UserResource::collection($users)
+            ->additional(['meta' => (new GetQueryMetaDataAction())->__invoke($userQuery->getQuery())]);
     }
 
     /**

src/App/ApiAdmin/Users/Queries/UserIndexQuery.php

@@ -24,6 +24,7 @@ public function __construct(Request $request)
 
         $this->allowedFilters(['id', 'name', AllowedFilter::trashed()])
             ->allowedIncludes(['permissions', 'roles'])
-            ->allowedSorts('id', 'name');
+            ->defaultSort('created_at')
+            ->allowedSorts('id', 'name', 'created_at');
     }
 }

src/App/Web/Quotes/Queries/QuoteIndexQuery.php

@@ -19,6 +19,7 @@ public function __construct(Request $request)
         parent::__construct($query, $request);
 
         $this->allowedFilters(['title', 'content'])
-            ->allowedSorts('title');
+            ->defaultSort('created_at')
+            ->allowedSorts('title', 'created_at');
     }
 }

src/Support/Metadata/GetQueryMetaDataAction.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Support\Metadata;
+
+use Illuminate\Database\Query\Builder;
+
+class GetQueryMetaDataAction
+{
+    public function __invoke(Builder $query): array
+    {
+        return [
+            'current_sort' => $query->orders,
+        ];
+    }
+}