Support custom PaginationType & Enhance Upload Type & Fix Privacy and SelectFields no working on Paginate (#169)

* add custom pagination type

* update advanced.md

* add getInstance to UploadType for singleton, fix parse value cause error

* update documentation

* fix Privacy & SelectFields no working on Paginate

* check is pagination by instance instead of name

* fix mutation error

* use pagination type instead of custom pagination type & optimize selectFields check is pagination type

* selectFields check pagination field type by instance

* remove unused $parentTypeName

* add accessibility of typeName and dataKey to paginationType

Author: a70537952

Readme.md

@@ -503,7 +503,7 @@ class UserProfilePhotoMutation extends Mutation
         return [
             'profilePicture' => [
                 'name' => 'profilePicture',
-                'type' => new UploadType($this->attributes['name']),
+                'type' => UploadType::getInstance(),
                 'rules' => ['required', 'image', 'max:1500'],
             ],
         ];

docs/advanced.md

@@ -552,7 +552,127 @@ If you want to change the name of a default field to fit with users expectations
 than 'total'), just copy the entry for the field you want to replace (they're in Rebing/GraphQL/Support/PaginationType.php) 
 and add it to your custom class.
 
+#### Custom Pagination Type
+If pagination cant fulfill you needs, you might want to custom your own pagination type.<br/>
+Replace default **pagination_type** inside graphql config and use your own pagination type class.
+```php
+    'pagination_type' => \Rebing\GraphQL\Support\PaginationType::class,
+```
+Example usage of custom pagination_type: <br>
+<br/>
+If you want pagination info under **cursor** rather than same level with **data** ,<br>
+**Result of default pagination type:**
+```
+{
+ "user": {
+   "data": [],
+   "total": 0 // pagination info
+ }
+}
+```
+**Result of custom pagination type:**
+```
+{
+ "user": {
+   "items": [],
+   "cursor": {
+     "total": 0, // pagination info
+   }
+ }
+}
+```
+you will need to create your own **Custom Pagination Type**
+<br/>
+**Example of PaginationType.php**
+```php
+<?php
+
+namespace App\GraphQL\Pagination;
+
+use GraphQL\Type\Definition\ObjectType;
+use GraphQL\Type\Definition\Type as GraphQLType;
+use Illuminate\Pagination\LengthAwarePaginator;
+use Rebing\GraphQL\Support\Facades\GraphQL;
+
+class PaginationType extends ObjectType
+{
+    //custom object-types, reference https://webonyx.github.io/graphql-php/type-system/object-types/#recurring-and-circular-types
+    private static $PaginationCursorType;
+    public function __construct($typeName, $customName = null)
+    {
+        $name = $customName ?: $typeName . 'Pagination';
+        $config = [
+            'name' => $name,
+            'fields' => array_merge(
+                [
+                    'cursor' => [ // we want pagination info under cursor rather than same level with data
+                        'type' => GraphQLType::nonNull(self::$PaginationCursorType ?: (self::$PaginationCursorType = new PaginationCursorType())),
+                        'resolve' => function (LengthAwarePaginator $paginator) {
+                            return $paginator;
+                        },
+                    ]
+                ],
+                [
+                    'data' => [
+                        'type' => GraphQLType::listOf(GraphQL::type($typeName)),
+                        'resolve' => function (LengthAwarePaginator $data) {
+                            return $data->getCollection();
+                        },
+                    ],
+                ]
+            )
+        ];
+        parent::__construct($config);
+    }
+}
+```
+**Example of PaginationCursorType.php**
+```php
+<?php
 
+namespace App\GraphQL\Pagination;
+
+use GraphQL\Type\Definition\ObjectType;
+use Illuminate\Pagination\LengthAwarePaginator;
+use GraphQL\Type\Definition\Type as GraphQLType;
+
+class PaginationCursorType extends ObjectType
+{
+    public function __construct()
+    {
+        // See https://laravel.com/api/5.6/Illuminate/Pagination/LengthAwarePaginator.html for more fields.
+        parent::__construct([
+            'fields' => [
+                'total' => [
+                    'type' => GraphQLType::nonNull(GraphQLType::int()),
+                    'resolve' => function (LengthAwarePaginator $paginator) {
+                        return $paginator->total();
+                    },
+                ],
+                'perPage' => [
+                    'type' => GraphQLType::nonNull(GraphQLType::int()),
+                    'resolve' => function (LengthAwarePaginator $paginator) {
+                        return $paginator->perPage();
+                    },
+                ],
+                'currentPage' => [
+                    'type' => GraphQLType::nonNull(GraphQLType::int()),
+                    'resolve' => function (LengthAwarePaginator $paginator) {
+                        return $paginator->currentPage();
+                    },
+                ],
+                'hasPages' => [
+                    'type' => GraphQLType::nonNull(GraphQLType::boolean()),
+                    'resolve' => function (LengthAwarePaginator $paginator) {
+                        return $paginator->hasMorePages();
+                    },
+                ],
+            ],
+        ]);
+    }
+}
+
+```
 ### Batching
 
 You can send multiple queries (or mutations) at once by grouping them together. Therefore, instead of creating two HTTP requests:

src/Rebing/GraphQL/GraphQL.php

@@ -268,7 +268,8 @@ public function paginate($typeName, $customName = null)
 
         if(!isset($this->typesInstances[$name]))
         {
-            $this->typesInstances[$name] = new PaginationType($typeName, $customName);
+            $paginationType = config('graphql.pagination_type', PaginationType::class);
+            $this->typesInstances[$name] = new $paginationType($typeName, $customName);
         }
 
         return $this->typesInstances[$name];

src/Rebing/GraphQL/Support/PaginationType.php

@@ -9,9 +9,13 @@
 
 class PaginationType extends ObjectType {
 
+    public $typeName;
+    public $dataKey = 'data';
+
     public function __construct($typeName, $customName = null)
     {
-        $name = $customName ?: $typeName . '_pagination';
+        $this->typeName = $typeName;
+        $name = $customName ?: $this->typeName . '_pagination';
 
         $customPaginator = config('graphql.custom_paginators.' . $name, null);
         $customFields = $customPaginator ? $customPaginator::getPaginationFields() : [];
@@ -22,8 +26,8 @@ public function __construct($typeName, $customName = null)
                 $this->getPaginationFields(),
                 $customFields,
                 [
-                    'data' => [
-                        'type'      => GraphQLType::listOf(GraphQL::type($typeName)),
+                    $this->dataKey => [
+                        'type'      => GraphQLType::listOf(GraphQL::type($this->typeName)),
                         'resolve'   => function(LengthAwarePaginator $data) { return $data->getCollection();  },
                     ],
                 ]

src/Rebing/GraphQL/Support/SelectFields.php

@@ -38,8 +38,15 @@ public function __construct(ResolveInfo $info, $parentType, array $args)
         if( ! is_null($info->fieldNodes[0]->selectionSet))
         {
             self::$args = $args;
+            $requestedFields = $info->getFieldSelection(5);
+            $paginationType = config('graphql.pagination_type', PaginationType::class);
 
-            $fields = self::getSelectableFieldsAndRelations($info->getFieldSelection(5), $parentType);
+            if ($parentType instanceof $paginationType) {
+                $requestedFields = $requestedFields[$parentType->dataKey];
+                $parentType = $info->schema->getType($parentType->typeName);
+            }
+
+            $fields = self::getSelectableFieldsAndRelations($requestedFields, $parentType);
 
             $this->select = $fields[0];
             $this->relations = $fields[1];

src/Rebing/GraphQL/Support/UploadType.php

@@ -14,7 +14,6 @@ class UploadType extends ScalarType {
      * @var string
      */
     public $name = 'Upload';
-
     /**
      * @var string
      */
@@ -50,10 +49,6 @@ public function serialize($value)
      */
     public function parseValue($value)
     {
-        if (!$value instanceof UploadedFile) {
-            throw new \UnexpectedValueException('Could not get uploaded file, be sure to conform to GraphQL multipart request specification. Instead got: ' . Utils::printSafe($value));
-        }
-
         return $value;
     }
 
@@ -68,4 +63,12 @@ public function parseLiteral($valueNode, ?array $variables = NULL)
     {
         throw new Error('`Upload` cannot be hardcoded in query, be sure to conform to GraphQL multipart request specification. Instead got: ' . $valueNode->kind, [$valueNode]);
     }
+
+    public static function getInstance() {
+        static $inst = null;
+        if ($inst === null) {
+            $inst = new UploadType();
+        }
+        return $inst;
+    }
 }

src/config/config.php

@@ -164,6 +164,12 @@
         // 'my_custom_pagination' => \Path\To\Your\CustomPagination::class,
     ],
 
+    /*
+     * You can define your own pagination type.
+     * Reference \Rebing\GraphQL\Support\PaginationType::class
+     */
+    'pagination_type' => \Rebing\GraphQL\Support\PaginationType::class,
+
     /*
      * Config for GraphiQL (see (https://github.com/graphql/graphiql).
      */