Add custom rector rules to fix types in parameters automatically mapped to objects (#107)

Author: norberttech

rector.php

@@ -2,10 +2,22 @@
 
 declare(strict_types=1);
 
+use AmazonPHP\SellingPartner\Model\CatalogItem\Categories;
+use AmazonPHP\SellingPartner\Model\ListingsItems\ListingsItemPutRequest;
+use AmazonPHP\SellingPartner\Model\Messaging\GetSchemaResponse;
+use AmazonPHP\SellingPartner\Model\Uploads\UploadDestination;
+use PHPStan\Type\ArrayType;
+use PHPStan\Type\MixedType;
+use PHPStan\Type\NullType;
+use PHPStan\Type\UnionType;
 use Rector\Core\Configuration\Option;
-use Rector\Core\ValueObject\PhpVersion;
 use Rector\Set\ValueObject\SetList;
+use Rector\TypeDeclaration\Rector\ClassMethod\AddParamTypeDeclarationRector;
+use Rector\TypeDeclaration\Rector\ClassMethod\AddReturnTypeDeclarationRector;
+use Rector\TypeDeclaration\ValueObject\AddParamTypeDeclaration;
+use Rector\TypeDeclaration\ValueObject\AddReturnTypeDeclaration;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use Symplify\SymfonyPhpConfig\ValueObjectInliner;
 
 return static function (ContainerConfigurator $containerConfigurator): void {
     // get parameters
@@ -32,4 +44,63 @@
     $containerConfigurator->import(SetList::PHP_73);
     $containerConfigurator->import(SetList::PHP_74);
     $containerConfigurator->import(SetList::TYPE_DECLARATION);
+
+    /**
+     * Explanation here: https://github.com/amazon-php/sp-api-sdk/issues/101#issuecomment-1002159988
+     */
+    $services->set(AddParamTypeDeclarationRector::class)
+        ->call('configure', [[
+            AddParamTypeDeclarationRector::PARAMETER_TYPEHINTS => ValueObjectInliner::inline([
+                new AddParamTypeDeclaration(
+                    Categories::class,
+                    'setParent',
+                    0,
+                    new UnionType([new NullType(), new ArrayType(new MixedType(), new MixedType())])
+                ),
+                new AddParamTypeDeclaration(
+                    ListingsItemPutRequest::class,
+                    'setAttributes',
+                    0,
+                    new UnionType([new NullType(), new ArrayType(new MixedType(), new MixedType())])
+                ),
+                new AddParamTypeDeclaration(
+                    GetSchemaResponse::class,
+                    'setPayload',
+                    0,
+                    new UnionType([new NullType(), new ArrayType(new MixedType(), new MixedType())])
+                ),
+                new AddParamTypeDeclaration(
+                    UploadDestination::class,
+                    'setHeaders',
+                    0,
+                    new UnionType([new NullType(), new ArrayType(new MixedType(), new MixedType())])
+                ),
+            ])
+        ]]);
+
+    $services->set(AddReturnTypeDeclarationRector::class)
+        ->call('configure', [[
+            AddReturnTypeDeclarationRector::METHOD_RETURN_TYPES => ValueObjectInliner::inline([
+                new AddReturnTypeDeclaration(
+                    Categories::class,
+                    'getParent',
+                    new UnionType([new NullType(), new ArrayType(new MixedType(), new MixedType())]),
+                ),
+                new AddReturnTypeDeclaration(
+                    ListingsItemPutRequest::class,
+                    'getAttributes',
+                    new UnionType([new NullType(), new ArrayType(new MixedType(), new MixedType())]),
+                ),
+                new AddReturnTypeDeclaration(
+                    GetSchemaResponse::class,
+                    'getPayload',
+                    new UnionType([new NullType(), new ArrayType(new MixedType(), new MixedType())]),
+                ),
+                new AddReturnTypeDeclaration(
+                    GetSchemaResponse::class,
+                    'getHeaders',
+                    new UnionType([new NullType(), new ArrayType(new MixedType(), new MixedType())]),
+                ),
+            ])
+        ]]);
 };

src/AmazonPHP/SellingPartner/Model/CatalogItem/Categories.php

@@ -262,8 +262,10 @@ public function setProductCategoryName(?string $product_category_name) : self
 
     /**
      * Gets parent.
+     *
+     * @return null|object
      */
-    public function getParent() : ?object
+    public function getParent() : ?array
     {
         return $this->container['parent'];
     }
@@ -273,7 +275,7 @@ public function getParent() : ?object
      *
      * @param null|object $parent the parent product category
      */
-    public function setParent(?object $parent) : self
+    public function setParent(?array $parent) : self
     {
         $this->container['parent'] = $parent;
 

src/AmazonPHP/SellingPartner/Model/ListingsItems/ListingsItemPutRequest.php

@@ -313,7 +313,7 @@ public function setRequirements(?string $requirements) : self
     /**
      * Gets attributes.
      */
-    public function getAttributes() : object
+    public function getAttributes() : ?array
     {
         return $this->container['attributes'];
     }
@@ -323,7 +323,7 @@ public function getAttributes() : object
      *
      * @param object $attributes JSON object containing structured listings item attribute data keyed by attribute name
      */
-    public function setAttributes(object $attributes) : self
+    public function setAttributes(?array $attributes) : self
     {
         $this->container['attributes'] = $attributes;
 

src/AmazonPHP/SellingPartner/Model/Messaging/GetSchemaResponse.php

@@ -242,8 +242,10 @@ public function setLinks(?GetSchemaResponseLinks $_links) : self
 
     /**
      * Gets payload.
+     *
+     * @return null|object
      */
-    public function getPayload() : ?object
+    public function getPayload() : ?array
     {
         return $this->container['payload'];
     }
@@ -253,7 +255,7 @@ public function getPayload() : ?object
      *
      * @param null|object $payload A JSON schema document describing the expected payload of the action. This object can be validated against <a href=http://json-schema.org/draft-04/schema>http://json-schema.org/draft-04/schema</a>.
      */
-    public function setPayload(?object $payload) : self
+    public function setPayload(?array $payload) : self
     {
         $this->container['payload'] = $payload;
 

src/AmazonPHP/SellingPartner/Model/Uploads/UploadDestination.php

@@ -273,7 +273,7 @@ public function getHeaders() : ?object
      *
      * @param null|object $headers the headers to include in the upload request
      */
-    public function setHeaders(?object $headers) : self
+    public function setHeaders(?array $headers) : self
     {
         $this->container['headers'] = $headers;