feat: Model added with updated return type and tests

composer.json

@@ -33,7 +33,8 @@
     ],
     "require": {
         "php": ">=8.0",
-        "guzzlehttp/guzzle": "^7.10"
+        "guzzlehttp/guzzle": "^7.10",
+        "nesbot/carbon": "^3.10"
     },
     "require-dev": {
         "laravel/pint": "^1.25",

src/Contracts/HamroCDNContract.php

@@ -4,22 +4,12 @@
 
 namespace HamroCDN\Contracts;
 
+use HamroCDN\Models\Upload;
+
 /**
- * @phpstan-type HamroCDNFile array{
- *     url: string,
- *     size: int
- * }
- * @phpstan-type HamroCDNUser array{
- *     name: string,
- *     email: string,
- *     role: string
- * }
- * @phpstan-type HamroCDNObject array{
- *     nanoId: string,
- *     user: HamroCDNUser,
- *     delete_at: string|null,
- *     original: HamroCDNFile
- * }
+ * @phpstan-import-type HamroCDNObject from Upload
+ * @phpstan-import-type UploadWithPagination from Upload
+ *
  * @phpstan-type HamroCDNData array{
  *     data: HamroCDNObject
  * }
@@ -33,28 +23,22 @@ interface HamroCDNContract
     /**
      * List all of your files in HamroCDN.
      *
-     * @return HamroCDNObjectWithPagination
+     * @return UploadWithPagination
      */
     public function index(): array;
 
     /**
      * Fetch a file from HamroCDN.
-     *
-     * @return HamroCDNData
      */
-    public function fetch(string $nanoId): array;
+    public function fetch(string $nanoId): Upload;
 
     /**
      * Upload a file to HamroCDN.
-     *
-     * @return HamroCDNData
      */
-    public function upload(string $filePath): array;
+    public function upload(string $filePath): Upload;
 
     /**
      * Upload a file to HamroCDN by URL.
-     *
-     * @return HamroCDNData
      */
-    public function uploadByURL(string $url): array;
+    public function uploadByURL(string $url): Upload;
 }

src/HamroCDN.php

@@ -7,10 +7,12 @@
 use GuzzleHttp\Client;
 use HamroCDN\Contracts\HamroCDNContract;
 use HamroCDN\Exceptions\HamroCDNException;
+use HamroCDN\Models\Upload;
 use HamroCDN\Traits\HasConfigValues;
 use HamroCDN\Traits\Requestable;
 
 /**
+ * @phpstan-import-type HamroCDNObject from Upload
  * @phpstan-import-type HamroCDNData from HamroCDNContract
  * @phpstan-import-type HamroCDNObjectWithPagination from HamroCDNContract
  */
@@ -37,37 +39,46 @@ public function __construct(?string $apiKey = null, ?string $baseUrl = null, ?Cl
     }
 
     /**
-     * @return HamroCDNObjectWithPagination
-     *
      * @throws HamroCDNException
      */
     public function index(?int $per_page = 20, ?int $page = 1): array
     {
-        /** @var HamroCDNObjectWithPagination */
-        return $this->get('uploads', [
+        /** @var HamroCDNObjectWithPagination $response */
+        $response = $this->get('uploads', [
             'per_page' => $per_page,
             'page' => $page,
         ]);
+
+        return [
+            'data' => array_map(
+                /** @param HamroCDNObject $item */
+                fn (array $item): Upload => Upload::fromArray($item),
+                $response['data']
+            ),
+            'meta' => $response['meta'],
+        ];
     }
 
     /**
      * @throws HamroCDNException
      */
-    public function fetch(string $nanoId): array
+    public function fetch(string $nanoId): Upload
     {
-        return $this->get("uploads/{$nanoId}");
+        $response = $this->get("uploads/{$nanoId}");
+
+        return Upload::fromArray($response['data']);
     }
 
     /**
      * @throws HamroCDNException
      */
-    public function upload(string $filePath): array
+    public function upload(string $filePath): Upload
     {
         if (! file_exists($filePath)) {
             throw HamroCDNException::fileError($filePath);
         }
 
-        return $this->post('uploads', [
+        $response = $this->post('uploads', [
             'multipart' => [
                 [
                     'name' => 'file',
@@ -76,17 +87,21 @@ public function upload(string $filePath): array
                 ],
             ],
         ]);
+
+        return Upload::fromArray($response['data']);
     }
 
     /**
      * @throws HamroCDNException
      */
-    public function uploadByURL(string $url): array
+    public function uploadByURL(string $url): Upload
     {
-        return $this->post('upload-from-url', [
+        $response = $this->post('upload-from-url', [
             'json' => [
                 'url' => $url,
             ],
         ]);
+
+        return Upload::fromArray($response['data']);
     }
 }

src/Models/File.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace HamroCDN\Models;
+
+/**
+ * @phpstan-type HamroCDNFile array{
+ *      url: string,
+ *      size: int
+ *  }
+ */
+final class File
+{
+    public function __construct(
+        private string $url,
+        private int $size
+    ) {}
+
+    /** @param HamroCDNFile $data */
+    public static function fromArray(array $data): self
+    {
+        return new self(
+            $data['url'],
+            (int) $data['size'],
+        );
+    }
+
+    public function getUrl(): string
+    {
+        return $this->url;
+    }
+
+    public function getSize(): int
+    {
+        return $this->size;
+    }
+
+    /** @return HamroCDNFile */
+    public function toArray(): array
+    {
+        return [
+            'url' => $this->url,
+            'size' => $this->size,
+        ];
+    }
+}

src/Models/Upload.php

@@ -0,0 +1,81 @@
+<?php
+
+declare(strict_types=1);
+
+namespace HamroCDN\Models;
+
+use Carbon\Carbon;
+
+/**
+ * @phpstan-import-type HamroCDNUser from User
+ * @phpstan-import-type HamroCDNFile from File
+ *
+ * @phpstan-type HamroCDNObject array{
+ *      nanoId: string,
+ *      user: HamroCDNUser|null,
+ *      delete_at: string|Carbon|null,
+ *      original: HamroCDNFile
+ * }
+ * @phpstan-type UploadWithPagination array{
+ *      data: array<Upload>,
+ *      meta: array{total: int, per_page: int, page: int}
+ *  }
+ */
+final class Upload
+{
+    public function __construct(
+        private string $nanoId,
+        private ?User $user,
+        private ?Carbon $deleteAt,
+        private File $original
+    ) {}
+
+    /** @param HamroCDNObject $data */
+    public static function fromArray(array $data): self
+    {
+        $user = null;
+        if (isset($data['user'])) {
+            $user = User::fromArray($data['user']);
+        }
+
+        $original = File::fromArray($data['original']);
+
+        return new self(
+            $data['nanoId'],
+            $user,
+            isset($data['delete_at']) ? new Carbon($data['delete_at']) : null,
+            $original
+        );
+    }
+
+    public function getNanoId(): string
+    {
+        return $this->nanoId;
+    }
+
+    public function getUser(): ?User
+    {
+        return $this->user;
+    }
+
+    public function getDeleteAt(): ?Carbon
+    {
+        return $this->deleteAt;
+    }
+
+    public function getOriginal(): File
+    {
+        return $this->original;
+    }
+
+    /** @return HamroCDNObject */
+    public function toArray(): array
+    {
+        return [
+            'nanoId' => $this->nanoId,
+            'user' => $this->user?->toArray(),
+            'delete_at' => $this->deleteAt,
+            'original' => $this->original->toArray(),
+        ];
+    }
+}

src/Models/User.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace HamroCDN\Models;
+
+/**
+ * @phpstan-type HamroCDNUser array{
+ *      name: string,
+ *      email: string
+ *  }
+ */
+final class User
+{
+    public function __construct(
+        private string $name,
+        private string $email
+    ) {}
+
+    /** @param HamroCDNUser $data */
+    public static function fromArray(array $data): self
+    {
+        return new self(
+            $data['name'],
+            $data['email'],
+        );
+    }
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    public function getEmail(): string
+    {
+        return $this->email;
+    }
+
+    /** @return HamroCDNUser */
+    public function toArray(): array
+    {
+        return [
+            'name' => $this->name,
+            'email' => $this->email,
+        ];
+    }
+}