improves types

defstudio · Aug 26, 2024 · 9af9435 · 9af9435
1 parent 9aae359
commit 9af9435
Show file tree

Hide file tree

Showing 27 changed files with 97 additions and 7 deletions.
diff --git a/database/factories/TelegraphBotFactory.php b/database/factories/TelegraphBotFactory.php
@@ -5,6 +5,9 @@
 use DefStudio\Telegraph\Models\TelegraphBot;
 use Illuminate\Database\Eloquent\Factories\Factory;
 
+/**
+ * @extends Factory<TelegraphBot>
+ */
 class TelegraphBotFactory extends Factory
 {
     protected $model = TelegraphBot::class;

diff --git a/database/factories/TelegraphChatFactory.php b/database/factories/TelegraphChatFactory.php
@@ -6,6 +6,9 @@
 use DefStudio\Telegraph\Models\TelegraphChat;
 use Illuminate\Database\Eloquent\Factories\Factory;
 
+/**
+ * @extends Factory<TelegraphChat>
+ */
 class TelegraphChatFactory extends Factory
 {
     protected $model = TelegraphChat::class;

diff --git a/phpstan.neon b/phpstan.neon
@@ -10,6 +10,6 @@ parameters:
         - '#expects string, array\|string\|null given#'
         - '#expects string, mixed given#'
 
+
     checkMissingIterableValueType: true
-    checkGenericClassInNonGenericObjectType: false
     reportUnmatchedIgnoredErrors: false
diff --git a/src/DTO/Animation.php b/src/DTO/Animation.php
@@ -5,6 +5,9 @@
 use DefStudio\Telegraph\Contracts\Downloadable;
 use Illuminate\Contracts\Support\Arrayable;
 
+/**
+ * @implements Arrayable<string, string|int|array<string, mixed>>
+ */
 class Animation implements Arrayable, Downloadable
 {
     private string $id;
@@ -26,8 +29,8 @@ private function __construct()
     /**
      * @param array{
      *     file_id: string,
-     *      width: int,
-     *      height: int,
+     *     width: int,
+     *     height: int,
      *     duration: int,
      *     file_name?: string,
      *     mime_type?: string,

diff --git a/src/DTO/Attachment.php b/src/DTO/Attachment.php
@@ -6,6 +6,9 @@
 use Illuminate\Support\Facades\File;
 use Illuminate\Support\Str;
 
+/**
+ * @implements Arrayable<string, string>
+ */
 class Attachment implements Arrayable
 {
     public function __construct(

diff --git a/src/DTO/Audio.php b/src/DTO/Audio.php
@@ -5,6 +5,9 @@
 use DefStudio\Telegraph\Contracts\Downloadable;
 use Illuminate\Contracts\Support\Arrayable;
 
+/**
+ * @implements Arrayable<string, string|int|array<string, mixed>>
+ */
 class Audio implements Arrayable, Downloadable
 {
     private string $id;

diff --git a/src/DTO/CallbackQuery.php b/src/DTO/CallbackQuery.php
@@ -8,6 +8,9 @@
 use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
 
+/**
+ * @implements Arrayable<string, string|int|array<string, mixed>>
+ */
 class CallbackQuery implements Arrayable
 {
     private int $id;
@@ -16,6 +19,9 @@ class CallbackQuery implements Arrayable
 
     private Message|null $message = null;
 
+    /**
+     * @var Collection<string, string>
+     */
     private Collection $data;
 
     private function __construct()
@@ -69,6 +75,9 @@ public function message(): Message|null
         return $this->message;
     }
 
+    /**
+     * @return Collection<string, string>
+     */
     public function data(): Collection
     {
         return $this->data;

diff --git a/src/DTO/Chat.php b/src/DTO/Chat.php
@@ -6,6 +6,9 @@
 
 use Illuminate\Contracts\Support\Arrayable;
 
+/**
+ * @implements Arrayable<string, string>
+ */
 class Chat implements Arrayable
 {
     public const TYPE_SENDER = 'sender';

diff --git a/src/DTO/ChatMember.php b/src/DTO/ChatMember.php
@@ -6,6 +6,9 @@
 
 use Illuminate\Contracts\Support\Arrayable;
 
+/**
+ * @implements Arrayable<string, string|int|bool|array<string, mixed>>
+ */
 class ChatMember implements Arrayable
 {
     public const STATUS_CREATOR = 'creator';

diff --git a/src/DTO/ChatMemberUpdate.php b/src/DTO/ChatMemberUpdate.php
@@ -8,6 +8,9 @@
 use Illuminate\Contracts\Support\Arrayable;
 use Illuminate\Support\Carbon;
 
+/**
+ * @implements Arrayable<string, string|int|array<string, mixed>>
+ */
 class ChatMemberUpdate implements Arrayable
 {
     private CarbonInterface $date;

diff --git a/src/DTO/Contact.php b/src/DTO/Contact.php
@@ -4,6 +4,9 @@
 
 use Illuminate\Contracts\Support\Arrayable;
 
+/**
+ * @implements Arrayable<string, string|int>
+ */
 class Contact implements Arrayable
 {
     private string $phone_number;

diff --git a/src/DTO/Document.php b/src/DTO/Document.php
@@ -5,6 +5,9 @@
 use DefStudio\Telegraph\Contracts\Downloadable;
 use Illuminate\Contracts\Support\Arrayable;
 
+/**
+ * @implements Arrayable<string, string|int|array<string, mixed>>
+ */
 class Document implements Arrayable, Downloadable
 {
     private string $id;

diff --git a/src/DTO/InlineQuery.php b/src/DTO/InlineQuery.php
@@ -4,6 +4,9 @@
 
 use Illuminate\Contracts\Support\Arrayable;
 
+/**
+ * @implements Arrayable<string, string|null|array<string, mixed>>
+ */
 class InlineQuery implements Arrayable
 {
     private string $id;

diff --git a/src/DTO/Location.php b/src/DTO/Location.php
@@ -4,6 +4,9 @@
 
 use Illuminate\Contracts\Support\Arrayable;
 
+/**
+ * @implements Arrayable<string, float>
+ */
 class Location implements Arrayable
 {
     private float $latitude;

diff --git a/src/DTO/Message.php b/src/DTO/Message.php
@@ -12,6 +12,9 @@
 use Illuminate\Support\Carbon;
 use Illuminate\Support\Collection;
 
+/**
+ * @implements Arrayable<string, string|int|bool|array<string, mixed>>
+ */
 class Message implements Arrayable
 {
     private int $id;

diff --git a/src/DTO/Photo.php b/src/DTO/Photo.php
@@ -5,6 +5,9 @@
 use DefStudio\Telegraph\Contracts\Downloadable;
 use Illuminate\Contracts\Support\Arrayable;
 
+/**
+ * @implements Arrayable<string, string|int>
+ */
 class Photo implements Arrayable, Downloadable
 {
     private string $id;

diff --git a/src/DTO/Sticker.php b/src/DTO/Sticker.php
@@ -5,6 +5,9 @@
 use DefStudio\Telegraph\Contracts\Downloadable;
 use Illuminate\Contracts\Support\Arrayable;
 
+/**
+ * @implements Arrayable<string, string|int|bool|array<string, mixed>>
+ */
 class Sticker implements Arrayable, Downloadable
 {
     private string $id;

diff --git a/src/DTO/TelegramUpdate.php b/src/DTO/TelegramUpdate.php
@@ -8,6 +8,9 @@
 
 use Illuminate\Contracts\Support\Arrayable;
 
+/**
+ * @implements Arrayable<string, int|array<string, mixed>>
+ */
 class TelegramUpdate implements Arrayable
 {
     private int $id;

diff --git a/src/DTO/User.php b/src/DTO/User.php
@@ -8,6 +8,9 @@
 use DefStudio\Telegraph\Contracts\Storable;
 use Illuminate\Contracts\Support\Arrayable;
 
+/**
+ * @implements Arrayable<string, string|int|bool|array<string, mixed>>
+ */
 class User implements Arrayable, Storable
 {
     use HasStorage;

diff --git a/src/DTO/Video.php b/src/DTO/Video.php
@@ -5,6 +5,9 @@
 use DefStudio\Telegraph\Contracts\Downloadable;
 use Illuminate\Contracts\Support\Arrayable;
 
+/**
+ * @implements Arrayable<string, string|int|array<string, mixed>>
+ */
 class Video implements Arrayable, Downloadable
 {
     private string $id;

diff --git a/src/DTO/Voice.php b/src/DTO/Voice.php
@@ -5,6 +5,9 @@
 use DefStudio\Telegraph\Contracts\Downloadable;
 use Illuminate\Contracts\Support\Arrayable;
 
+/**
+ * @implements Arrayable<string, string|int>
+ */
 class Voice implements Arrayable, Downloadable
 {
     private string $id;

diff --git a/src/DTO/WriteAccessAllowed.php b/src/DTO/WriteAccessAllowed.php
@@ -4,6 +4,9 @@
 
 use Illuminate\Contracts\Support\Arrayable;
 
+/**
+ * @implements Arrayable<string, string|bool>
+ */
 class WriteAccessAllowed implements Arrayable
 {
     private bool $fromRequest = false;

diff --git a/src/Handlers/WebhookHandler.php b/src/Handlers/WebhookHandler.php
@@ -39,6 +39,9 @@ abstract class WebhookHandler
     protected Message|null $message = null;
     protected CallbackQuery|null $callbackQuery = null;
 
+    /**
+     * @var Collection<string, string>
+     */
     protected Collection $data;
 
     protected Keyboard $originalKeyboard;

diff --git a/src/Keyboard/Keyboard.php b/src/Keyboard/Keyboard.php
@@ -8,6 +8,9 @@
 use Illuminate\Support\Str;
 use Illuminate\Support\Traits\Conditionable;
 
+/**
+ * @implements Arrayable<string, array<array-key, array{text: string, url?: string, callback_data?: string, web_app?:  string[], login_url?:  string[], switch_inline_query?: string, switch_inline_query_current_chat?: string}>>
+ */
 class Keyboard implements Arrayable
 {
     use Conditionable;

diff --git a/src/Keyboard/ReplyKeyboard.php b/src/Keyboard/ReplyKeyboard.php
@@ -9,6 +9,9 @@
 use Illuminate\Support\Collection;
 use Illuminate\Support\Traits\Conditionable;
 
+/**
+ * @implements Arrayable<string, array<array-key, array{text: string, request_contact?: bool, request_location?: bool, request_poll?: string[], web_app?: string[]}>>
+ */
 class ReplyKeyboard implements Arrayable
 {
     use Conditionable;
@@ -25,7 +28,7 @@ class ReplyKeyboard implements Arrayable
 
     public function __construct()
     {
-        /* @phpstan-ignore-next-line  */
+        /* @phpstan-ignore-next-line */
         $this->buttons = collect();
     }
 
@@ -216,7 +219,7 @@ public function deleteButton(string $label): self
     {
         $clone = $this->clone();
 
-        /* @phpstan-ignore-next-line  */
+        /* @phpstan-ignore-next-line */
         $clone->buttons = $clone->buttons->reject(fn (ReplyButton $button) => $button->label() == $label);
 
         return $clone;

diff --git a/src/Models/TelegraphBot.php b/src/Models/TelegraphBot.php
@@ -44,12 +44,15 @@ class TelegraphBot extends Model implements Storable
         'name',
     ];
 
+    /**
+     * @return TelegraphBotFactory
+     */
     protected static function newFactory(): Factory
     {
         return TelegraphBotFactory::new();
     }
 
-    public static function booted()
+    public static function booted(): void
     {
         self::created(function (TelegraphBot $bot) {
             if (empty($bot->name)) {
@@ -89,6 +92,9 @@ public static function fromToken(string $token): TelegraphBot
         return self::query()->where('token', $token)->sole();
     }
 
+    /**
+     * @return HasMany<TelegraphChat>
+     */
     public function chats(): HasMany
     {
         /** @phpstan-ignore-next-line */

diff --git a/src/Models/TelegraphChat.php b/src/Models/TelegraphChat.php
@@ -43,12 +43,15 @@ class TelegraphChat extends Model implements Storable
         'name',
     ];
 
+    /**
+     * @return TelegraphChatFactory
+     */
     protected static function newFactory(): Factory
     {
         return TelegraphChatFactory::new();
     }
 
-    public static function booted()
+    public static function booted(): void
     {
         self::created(function (TelegraphChat $chat) {
             if (empty($chat->name)) {
@@ -63,6 +66,9 @@ public function storageKey(): string|int
         return $this->id;
     }
 
+    /**
+     * @return BelongsTo<TelegraphBot, TelegraphChat>
+     */
     public function bot(): BelongsTo
     {
         /** @phpstan-ignore-next-line */