Fix signatures of bsonSerialize() methods (#1156)

* Fix signatures of bsonSerialize() methods

* Update psalm baseline

Author: alcaeus

examples/persistable.php

@@ -7,6 +7,7 @@
 use MongoDB\BSON\Persistable;
 use MongoDB\Client;
 use MongoDB\Model\BSONArray;
+use stdClass;
 use UnexpectedValueException;
 
 use function getenv;
@@ -34,7 +35,7 @@ public function getId(): ObjectId
         return $this->id;
     }
 
-    public function bsonSerialize(): object
+    public function bsonSerialize(): stdClass
     {
         return (object) [
             '_id' => $this->id,
@@ -73,7 +74,7 @@ public function __construct(string $type, string $address)
         $this->address = $address;
     }
 
-    public function bsonSerialize(): object
+    public function bsonSerialize(): stdClass
     {
         return (object) [
             'type' => $this->type,

psalm-baseline.xml

@@ -5,6 +5,23 @@
       <code><![CDATA[$clientEncryption->decrypt($document->encryptedField)]]></code>
     </MixedArgument>
   </file>
+  <file src="examples/persistable.php">
+    <LessSpecificReturnStatement>
+      <code><![CDATA[(object) [
+            '_id' => $this->id,
+            'name' => $this->name,
+            'emails' => $this->emails,
+        ]]]></code>
+      <code><![CDATA[(object) [
+            'type' => $this->type,
+            'address' => $this->address,
+        ]]]></code>
+    </LessSpecificReturnStatement>
+    <MoreSpecificReturnType>
+      <code>stdClass</code>
+      <code>stdClass</code>
+    </MoreSpecificReturnType>
+  </file>
   <file src="src/ChangeStream.php">
     <DeprecatedConstant>
       <code>self::CURSOR_NOT_FOUND</code>
@@ -159,6 +176,9 @@
     </MixedArrayOffset>
   </file>
   <file src="src/Model/IndexInput.php">
+    <LessSpecificReturnStatement>
+      <code><![CDATA[(object) $this->index]]></code>
+    </LessSpecificReturnStatement>
     <MixedArgument>
       <code>$fieldName</code>
       <code><![CDATA[$index['key']]]></code>
@@ -173,6 +193,17 @@
     <MixedReturnStatement>
       <code><![CDATA[$this->index['name']]]></code>
     </MixedReturnStatement>
+    <MoreSpecificReturnType>
+      <code>stdClass</code>
+    </MoreSpecificReturnType>
+  </file>
+  <file src="src/Model/SearchIndexInput.php">
+    <LessSpecificReturnStatement>
+      <code><![CDATA[(object) $this->index]]></code>
+    </LessSpecificReturnStatement>
+    <MoreSpecificReturnType>
+      <code>stdClass</code>
+    </MoreSpecificReturnType>
   </file>
   <file src="src/Operation/Aggregate.php">
     <MixedArgument>

src/Model/IndexInput.php

@@ -19,6 +19,7 @@
 
 use MongoDB\BSON\Serializable;
 use MongoDB\Exception\InvalidArgumentException;
+use stdClass;
 
 use function is_float;
 use function is_int;
@@ -86,7 +87,7 @@ public function __toString(): string
      * @see \MongoDB\Collection::createIndexes()
      * @see https://php.net/mongodb-bson-serializable.bsonserialize
      */
-    public function bsonSerialize(): object
+    public function bsonSerialize(): stdClass
     {
         return (object) $this->index;
     }

src/Model/SearchIndexInput.php

@@ -19,6 +19,7 @@
 
 use MongoDB\BSON\Serializable;
 use MongoDB\Exception\InvalidArgumentException;
+use stdClass;
 
 use function is_string;
 use function MongoDB\is_document;
@@ -66,7 +67,7 @@ public function __construct(array $index)
      * @see \MongoDB\Collection::createSearchIndexes()
      * @see https://php.net/mongodb-bson-serializable.bsonserialize
      */
-    public function bsonSerialize(): object
+    public function bsonSerialize(): stdClass
     {
         return (object) $this->index;
     }