- Added upgrade to v3

Author: dash8x

composer.json

@@ -30,7 +30,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-main": "2.0-dev"
+            "dev-main": "3.0-dev"
         },
         "laravel": {
             "providers": [

docs/metadata.json

@@ -1,5 +1,5 @@
 {
     "name": "Query Builder",
     "description": "Modifications on top of spatie/query-builder",
-    "version": "1"
+    "version": "3"
 }

docs/migration.md

@@ -0,0 +1,64 @@
+---
+title: Migration from v2
+sidebar_position: 1.2
+---
+
+In v3, the access level of the `ApiBaseController` abstract methods have been changed from `protected` to `public`.
+
+```php
+// In v2
+
+/**
+ * Get the allowed sorts
+ *
+ * @return array
+ */
+protected function getAllowedSorts(): array
+{
+    return [
+        'id',
+        'name',
+        'slug',
+        'created_at',
+        'updated_at',
+    ];
+}
+
+// In v3
+
+/**
+ * Get the allowed sorts
+ *
+ * @return array
+ */
+public function getAllowedSorts(): array
+{
+    return [
+        'id',
+        'name',
+        'slug',
+        'created_at',
+        'updated_at',
+    ];
+}
+```
+
+So, you will need to change the access level of the following methods of your API controllers.
+
+
+```php
+getBaseQuery(): Builder;
+getAllowedFields(): array;
+getAllowedIncludes(): array;
+getAllowedAppends(): array;
+getAllowedSorts(): array;
+getDefaultSort(): string;
+getAllowedFilters(): array;
+getShowAllowedAppends(): array
+getAllShowAllowedAppends(): array
+getShowAllowedAppendAttributes(): array
+getAllowedAppendAttributes(): array
+getIndexAllowedFields(): array
+getFieldsToAlwaysInclude(): array
+allowUnlimitedResultsPerPage(): bool
+```

src/Concerns/IsApiController.php

@@ -35,7 +35,7 @@ trait IsApiController
      *
      * @return bool
      */
-    protected function allowUnlimitedResultsPerPage(): bool
+    public function allowUnlimitedResultsPerPage(): bool
     {
         return property_exists($this, 'allow_unlimited_results') ? $this->allow_unlimited_results : false;
     }
@@ -176,7 +176,7 @@ protected function getIndexValidation(): array
     /**
      * Get the fields to always include
      */
-    protected function getFieldsToAlwaysInclude(): array
+    public function getFieldsToAlwaysInclude(): array
     {
         return [
             'id'
@@ -186,7 +186,7 @@ protected function getFieldsToAlwaysInclude(): array
     /**
      * Get the index allowed fields
      */
-    protected function getIndexAllowedFields(): array
+    public function getIndexAllowedFields(): array
     {
         return $this->getAllowedFields();
     }
@@ -275,7 +275,7 @@ protected function modifyQuery(\Spatie\QueryBuilder\QueryBuilder $query): \Spati
      *
      * @return array
      */
-    protected function getAllowedAppendAttributes(): array
+    public function getAllowedAppendAttributes(): array
     {
         return Arr::rootKeys($this->getAllowedAppends());
     }
@@ -285,15 +285,15 @@ protected function getAllowedAppendAttributes(): array
      *
      * @return array
      */
-    protected function getShowAllowedAppendAttributes(): array
+    public function getShowAllowedAppendAttributes(): array
     {
         return Arr::rootKeys($this->getAllShowAllowedAppends());
     }
 
     /**
      * Get the show allowed appends
      */
-    protected function getAllShowAllowedAppends(): array
+    public function getAllShowAllowedAppends(): array
     {
         if (! $this->getShowAllowedAppends()) {
             return $this->getAllowedAppends();
@@ -309,7 +309,7 @@ protected function getAllShowAllowedAppends(): array
     /**
      * Get the allowed appends for only show endpoint
      */
-    protected function getShowAllowedAppends(): array
+    public function getShowAllowedAppends(): array
     {
         return [];
     }

src/Http/Controllers/ApiBaseController.php

@@ -29,35 +29,35 @@ public function __construct(QueryBuilderRequest $request)
     /**
      * Get the base query
      */
-    protected abstract function getBaseQuery(): Builder;
+    public abstract function getBaseQuery(): Builder;
 
     /**
      * Get the fields
      */
-    protected abstract function getAllowedFields(): array;
+    public abstract function getAllowedFields(): array;
 
     /**
      * Get the includes
      */
-    protected abstract function getAllowedIncludes(): array;
+    public abstract function getAllowedIncludes(): array;
 
     /**
      * Get the allowed appends
      */
-    protected abstract function getAllowedAppends(): array;
+    public abstract function getAllowedAppends(): array;
 
     /**
      * Get the allowed sorts
      */
-    protected abstract function getAllowedSorts(): array;
+    public abstract function getAllowedSorts(): array;
 
     /**
      * Get the default sort
      */
-    protected abstract function getDefaultSort(): string;
+    public abstract function getDefaultSort(): string;
 
     /**
      * Get the allowed filters
      */
-    protected abstract function getAllowedFilters(): array;
+    public abstract function getAllowedFilters(): array;
 }

tests/Controllers/ProductsController.php

@@ -14,7 +14,7 @@ class ProductsController extends ApiController
      *
      * @return Builder
      */
-    protected function getBaseQuery(): Builder
+    public function getBaseQuery(): Builder
     {
         return Product::query();
     }
@@ -24,7 +24,7 @@ protected function getBaseQuery(): Builder
      *
      * @return array
      */
-    protected function getAllowedFields(): array
+    public function getAllowedFields(): array
     {
         return array_diff(\Schema::getColumnListing('products'), (new Product)->getHidden());
     }
@@ -34,7 +34,7 @@ protected function getAllowedFields(): array
      *
      * @return array
      */
-    protected function getAllowedIncludes(): array
+    public function getAllowedIncludes(): array
     {
         return [
             'brand',
@@ -46,7 +46,7 @@ protected function getAllowedIncludes(): array
      *
      * @return array
      */
-    protected function getAllowedAppends(): array
+    public function getAllowedAppends(): array
     {
         return [
             'formatted_name' => [
@@ -60,7 +60,7 @@ protected function getAllowedAppends(): array
      *
      * @return array
      */
-    protected function getAllowedSorts(): array
+    public function getAllowedSorts(): array
     {
         return [
             'id',
@@ -76,7 +76,7 @@ protected function getAllowedSorts(): array
      *
      * @return string
      */
-    protected function getDefaultSort(): string
+    public function getDefaultSort(): string
     {
         return 'name';
     }
@@ -86,7 +86,7 @@ protected function getDefaultSort(): string
      *
      * @return array
      */
-    protected function getAllowedFilters(): array
+    public function getAllowedFilters(): array
     {
         return [
             'name',