Fixed all PHPStan Errors and all other tests Pass 100%

Author: momostafa

src/Responses/Responses/CreateResponse.php

@@ -24,6 +24,13 @@ final class CreateResponse implements ResponseContract, ResponseHasMetaInformati
     use Fakeable;
     use HasMetaInformation;
 
+    /**
+     * @param  array<int, array{type: string, id: string, status: string, role: string, content: array<int, array{type: string, text: string, annotations: array<mixed>}>}>  $output
+     * @param  array<mixed>  $reasoning
+     * @param  array{format: array{type: string}}  $text
+     * @param  array<mixed>  $tools
+     * @param  array{input_tokens: int, input_tokens_details: array<string, int>, output_tokens: int, output_tokens_details: array<string, int>, total_tokens: int}  $usage
+     */
     private function __construct(
         public readonly string $id,
         public readonly string $object,
@@ -45,16 +52,13 @@ private function __construct(
         public readonly array $tools,
         public readonly ?float $topP,
         public readonly string $truncation,
+        public readonly array $usage,
         public readonly ?string $user,
-        public array $metadata,
-        public readonly CreateResponseUsage $usage,
         private readonly MetaInformation $meta,
     ) {}
 
     /**
-     * Acts as static factory, and returns a new Response instance.
-     *
-     * @param  array{id: string, object: string, created_at: int, status: string, error: ?object, incomplete_details: object|null, instructions: ?string, max_output_tokens: ?int, model: string, output: array<int, array{type: string, id: string, status: string, role: string, content: array<int, array{type: string, text: string, annotations: array<mixed>}>}>, parallel_tool_calls: bool, previous_response_id: ?string, reasoning: array<mixed>, store: bool, temperature: ?float, text: array{format: array{type: string}}, tool_choice: string, tools: array<mixed>, top_p: ?float, truncation: string, usage: array{input_tokens: int, input_tokens_details: array<string, int>, output_tokens: int, output_tokens_details: array<string, int>, total_tokens: int}, user: ?string, metadata?: array<string, string>}  $attributes
+     * @param  array{id: string, object: string, created_at: int, status: string, error: object|null, incomplete_details: object|null, instructions: string|null, max_output_tokens: int|null, model: string, output: array<int, array{type: string, id: string, status: string, role: string, content: array<int, array{type: string, text: string, annotations: array<mixed>}>}>, parallel_tool_calls: bool, previous_response_id: string|null, reasoning: array<mixed>, store: bool, temperature: float|null, text: array{format: array{type: string}}, tool_choice: string, tools: array<mixed>, top_p: float|null, truncation: string, usage: array{input_tokens: int, input_tokens_details: array<string, int>, output_tokens: int, output_tokens_details: array<string, int>, total_tokens: int}, user: string|null, metadata?: array<string, string>}  $attributes
      */
     public static function from(array $attributes, MetaInformation $meta): self
     {
@@ -79,15 +83,14 @@ public static function from(array $attributes, MetaInformation $meta): self
             $attributes['tools'],
             $attributes['top_p'],
             $attributes['truncation'],
-            $attributes['user'],
-            $attributes['metadata'] ?? [],
-            CreateResponseUsage::from($attributes['usage']),
+            $attributes['usage'],
+            $attributes['user'] ?? null,
             $meta,
         );
     }
 
     /**
-     * {@inheritDoc}
+     * @return array{id: string, object: string, created_at: int, status: string, error: object|null, incomplete_details: object|null, instructions: string|null, max_output_tokens: int|null, model: string, output: array<int, array{type: string, id: string, status: string, role: string, content: array<int, array{type: string, text: string, annotations: array<mixed>}>}>, parallel_tool_calls: bool, previous_response_id: string|null, reasoning: array<mixed>, store: bool, temperature: float|null, text: array{format: array{type: string}}, tool_choice: string, tools: array<mixed>, top_p: float|null, truncation: string, usage: array{input_tokens: int, input_tokens_details: array<string, int>, output_tokens: int, output_tokens_details: array<string, int>, total_tokens: int}, user: string|null, metadata?: array<string, string>}
      */
     public function toArray(): array
     {
@@ -112,9 +115,8 @@ public function toArray(): array
             'tools' => $this->tools,
             'top_p' => $this->topP,
             'truncation' => $this->truncation,
+            'usage' => $this->usage,
             'user' => $this->user,
-            'metadata' => $this->metadata,
-            'usage' => $this->usage->toArray(),
         ];
     }
 }

src/Responses/Responses/ListInputItems.php

@@ -24,6 +24,9 @@ final class ListInputItems implements ResponseContract, ResponseHasMetaInformati
     use Fakeable;
     use HasMetaInformation;
 
+    /**
+     * @param  array<int, array{type: string, id: string, status: string, role: string, content: array<int, array{type: string, text: string, annotations: array<mixed>}>}>  $data
+     */
     private function __construct(
         public readonly string $object,
         public readonly array $data,
@@ -40,14 +43,9 @@ private function __construct(
      */
     public static function from(array $attributes, MetaInformation $meta): self
     {
-        $data = array_map(fn (array $result): ResponseObject => ResponseObject::from(
-            $result,
-            $meta,
-        ), $attributes['data']);
-
         return new self(
             $attributes['object'],
-            $data,
+            $attributes['data'],
             $attributes['first_id'],
             $attributes['last_id'],
             $attributes['has_more'],
@@ -62,10 +60,7 @@ public function toArray(): array
     {
         return [
             'object' => $this->object,
-            'data' => array_map(
-                static fn (ResponseObject $result): array => $result->toArray(),
-                $this->data,
-            ),
+            'data' => $this->data,
             'first_id' => $this->firstId,
             'last_id' => $this->lastId,
             'has_more' => $this->hasMore,

src/Responses/Responses/ResponseObject.php

@@ -12,7 +12,7 @@
 use OpenAI\Testing\Responses\Concerns\Fakeable;
 
 /**
- * @implements ResponseContract<array{id: string, object: string, created_at: int, status: string, error: object|null, incomplete_details: object|null, instructions: string|null, max_output_tokens: int|null, model: string, output: array<int, array{type: string, id: string, status: string, role: string, content: array<int, array{type: string, text: string, annotations: array<mixed>}>}>, parallel_tool_calls: bool, previous_response_id: string|null, reasoning: array<mixed>, store: bool, temperature: float|null, text: object{format: array{type: string}}, tool_choice: string, tools: array<mixed>, top_p: float|null, truncation: string, usage: array{input_tokens: int, input_tokens_details: array<string, int>, output_tokens: int, output_tokens_details: array<string, int>, total_tokens: int}, user: string|null, metadata?: array<string, string>}>
+ * @implements ResponseContract<array{id: string, object: string, created_at: int, status: string, error: object|null, incomplete_details: object|null, instructions: string|null, max_output_tokens: int|null, model: string, output: array<int, array{type: string, id: string, status: string, role: string, content: array<int, array{type: string, text: string, annotations: array<mixed>}>}>, parallel_tool_calls: bool, previous_response_id: string|null, reasoning: array<mixed>, store: bool, temperature: float|null, text: array{format: array{type: string}}, tool_choice: string, tools: array<mixed>, top_p: float|null, truncation: string, usage: array{input_tokens: int, input_tokens_details: array<string, int>, output_tokens: int, output_tokens_details: array<string, int>, total_tokens: int}, user: string|null, metadata?: array<string, string>}>
  */
 final class ResponseObject implements ResponseContract, ResponseHasMetaInformationContract
 {
@@ -24,12 +24,19 @@ final class ResponseObject implements ResponseContract, ResponseHasMetaInformati
     use Fakeable;
     use HasMetaInformation;
 
+    /**
+     * @param  array<int, array{type: string, id: string, status: string, role: string, content: array<int, array{type: string, text: string, annotations: array<mixed>}>}>  $output
+     * @param  array<string, mixed>  $reasoning
+     * @param  array{format: array{type: string}}  $text
+     * @param  array<mixed>  $tools
+     * @param  array<string, string>  $metadata
+     */
     private function __construct(
         public readonly string $id,
         public readonly string $object,
         public readonly int $createdAt,
         public readonly string $status,
-        public readonly object $error,
+        public readonly ?object $error,
         public readonly ?object $incompleteDetails,
         public readonly ?string $instructions,
         public readonly ?int $maxOutputTokens,
@@ -47,12 +54,13 @@ private function __construct(
         public readonly string $truncation,
         public readonly ?string $user,
         public array $metadata,
-        public readonly CreateResponseUsage $usage,
+        /** @var array{input_tokens: int, input_tokens_details: array<string, int>, output_tokens: int, output_tokens_details: array<string, int>, total_tokens: int} */
+        public readonly array $usage,
         private readonly MetaInformation $meta,
     ) {}
 
     /**
-     * @param  array{id: string, object: string, created_at: int, status: string, error: ?object, incomplete_details: object|null, instructions: ?string, max_output_tokens: ?int, model: string, output: array<int, array{type: string, id: string, status: string, role: string, content: array<int, array{type: string, text: string, annotations: array<mixed>}>}>, parallel_tool_calls: bool, previous_response_id: ?string, reasoning: array<mixed>, store: bool, temperature: ?float, text: array{format: array{type: string}}, tool_choice: string, tools: array<mixed>, top_p: ?float, truncation: string, usage: array{input_tokens: int, input_tokens_details: array<string, int>, output_tokens: int, output_tokens_details: array<string, int>, total_tokens: int}, user: ?string, metadata?: array<string, string>}  $attributes
+     * @param  array{id: string, object: string, created_at: int, status: string, error: object|null, incomplete_details: object|null, instructions: string|null, max_output_tokens: int|null, model: string, output: array<int, array{type: string, id: string, status: string, role: string, content: array<int, array{type: string, text: string, annotations: array<mixed>}>}>, parallel_tool_calls: bool, previous_response_id: string|null, reasoning: array<mixed>, store: bool, temperature: float|null, text: array{format: array{type: string}}, tool_choice: string, tools: array<mixed>, top_p: float|null, truncation: string, usage: array{input_tokens: int, input_tokens_details: array<string, int>, output_tokens: int, output_tokens_details: array<string, int>, total_tokens: int}, user: string|null, metadata?: array<string, string>}  $attributes
      */
     public static function from(array $attributes, MetaInformation $meta): self
     {
@@ -79,13 +87,13 @@ public static function from(array $attributes, MetaInformation $meta): self
             $attributes['truncation'],
             $attributes['user'],
             $attributes['metadata'] ?? [],
-            CreateResponseUsage::from($attributes['usage']),
+            $attributes['usage'],
             $meta,
         );
     }
 
     /**
-     * {@inheritDoc}
+     * @return array{id: string, object: string, created_at: int, status: string, error: object|null, incomplete_details: object|null, instructions: string|null, max_output_tokens: int|null, model: string, output: array<int, array{type: string, id: string, status: string, role: string, content: array<int, array{type: string, text: string, annotations: array<mixed>}>}>, parallel_tool_calls: bool, previous_response_id: string|null, reasoning: array<mixed>, store: bool, temperature: float|null, text: array{format: array{type: string}}, tool_choice: string, tools: array<mixed>, top_p: float|null, truncation: string, usage: array{input_tokens: int, input_tokens_details: array<string, int>, output_tokens: int, output_tokens_details: array<string, int>, total_tokens: int}, user: string|null, metadata: array<string, string>}
      */
     public function toArray(): array
     {
@@ -112,7 +120,7 @@ public function toArray(): array
             'truncation' => $this->truncation,
             'user' => $this->user,
             'metadata' => $this->metadata,
-            'usage' => $this->usage->toArray(),
+            'usage' => $this->usage,
         ];
     }
 }

src/Responses/Responses/RetrieveResponse.php

@@ -24,6 +24,14 @@ final class RetrieveResponse implements ResponseContract, ResponseHasMetaInforma
     use Fakeable;
     use HasMetaInformation;
 
+    /**
+     * @param  array<int, array{type: string, id: string, status: string, role: string, content: array<int, array{type: string, text: string, annotations: array<mixed>}>}>  $output
+     * @param  array<mixed>  $reasoning
+     * @param  array{format: array{type: string}}  $text
+     * @param  array<mixed>  $tools
+     * @param  array<string, string>  $metadata
+     * @param  array{input_tokens: int, input_tokens_details: array<string, int>, output_tokens: int, output_tokens_details: array<string, int>, total_tokens: int}  $usage
+     */
     private function __construct(
         public readonly string $id,
         public readonly string $object,
@@ -47,14 +55,12 @@ private function __construct(
         public readonly string $truncation,
         public readonly ?string $user,
         public array $metadata,
-        public readonly CreateResponseUsage $usage,
+        public readonly array $usage,
         private readonly MetaInformation $meta,
     ) {}
 
     /**
-     * Acts as static factory, and returns a new Response instance.
-     *
-     * @param  array{id: string, object: string, created_at: int, status: string, error: object|null, incomplete_details: object|null, instructions: ?string, max_output_tokens: ?int, model: string, output: array<int, array{type: string, id: string, status: string, role: string, content: array<int, array{type: string, text: string, annotations: array<mixed>}>}>, parallel_tool_calls: bool, previous_response_id: ?string, reasoning: array<mixed>, store: bool, temperature: ?float, text: array{format: array{type: string}}, tool_choice: string, tools: array<mixed>, top_p: ?float, truncation: string, usage: array{input_tokens: int, input_tokens_details: array<string, int>, output_tokens: int, output_tokens_details: array<string, int>, total_tokens: int}, user: ?string, metadata?: array<string, string>}  $attributes
+     * @param  array{id: string, object: string, created_at: int, status: string, error: object|null, incomplete_details: object|null, instructions: string|null, max_output_tokens: int|null, model: string, output: array<int, array{type: string, id: string, status: string, role: string, content: array<int, array{type: string, text: string, annotations: array<mixed>}>}>, parallel_tool_calls: bool, previous_response_id: string|null, reasoning: array<mixed>, store: bool, temperature: float|null, text: array{format: array{type: string}}, tool_choice: string, tools: array<mixed>, top_p: float|null, truncation: string, usage: array{input_tokens: int, input_tokens_details: array<string, int>, output_tokens: int, output_tokens_details: array<string, int>, total_tokens: int}, user: string|null, metadata?: array<string, string>}  $attributes
      */
     public static function from(array $attributes, MetaInformation $meta): self
     {
@@ -81,13 +87,13 @@ public static function from(array $attributes, MetaInformation $meta): self
             $attributes['truncation'],
             $attributes['user'],
             $attributes['metadata'] ?? [],
-            CreateResponseUsage::from($attributes['usage']),
+            $attributes['usage'],
             $meta,
         );
     }
 
     /**
-     * {@inheritDoc}
+     * @return array{id: string, object: string, created_at: int, status: string, error: object|null, incomplete_details: object|null, instructions: string|null, max_output_tokens: int|null, model: string, output: array<int, array{type: string, id: string, status: string, role: string, content: array<int, array{type: string, text: string, annotations: array<mixed>}>}>, parallel_tool_calls: bool, previous_response_id: string|null, reasoning: array<mixed>, store: bool, temperature: float|null, text: array{format: array{type: string}}, tool_choice: string, tools: array<mixed>, top_p: float|null, truncation: string, usage: array{input_tokens: int, input_tokens_details: array<string, int>, output_tokens: int, output_tokens_details: array<string, int>, total_tokens: int}, user: string|null, metadata: array<string, string>}
      */
     public function toArray(): array
     {
@@ -114,7 +120,7 @@ public function toArray(): array
             'truncation' => $this->truncation,
             'user' => $this->user,
             'metadata' => $this->metadata,
-            'usage' => $this->usage->toArray(),
+            'usage' => $this->usage,
         ];
     }
 }