refactor: cleans up mime type and json schema

Author: JasonTheAdams

src/Common/Contracts/WithJsonSchema.php renamed to src/Common/Contracts/WithJsonSchemaInterface.php

@@ -12,7 +12,7 @@
  *
  * @since n.e.x.t
  */
-interface WithJsonSchema
+interface WithJsonSchemaInterface
 {
     /**
      * Gets the JSON schema representation of the object.

src/Files/DTO/InlineFile.php

@@ -4,8 +4,9 @@
 
 namespace WordPress\AiClient\Files\DTO;
 
-use WordPress\AiClient\Common\Contracts\WithJsonSchema;
+use WordPress\AiClient\Common\Contracts\WithJsonSchemaInterface;
 use WordPress\AiClient\Files\Contracts\FileInterface;
+use WordPress\AiClient\Files\Traits\HasMimeType;
 
 /**
  * Represents a file with inline base64-encoded data.
@@ -15,12 +16,9 @@
  *
  * @since n.e.x.t
  */
-class InlineFile implements FileInterface, WithJsonSchema
+class InlineFile implements FileInterface, WithJsonSchemaInterface
 {
-    /**
-     * @var string The MIME type of the file.
-     */
-    private string $mimeType;
+    use HasMimeType;
 
     /**
      * @var string The base64-encoded file data.
@@ -41,18 +39,6 @@ public function __construct(string $mimeType, string $base64Data)
         $this->base64Data = $base64Data;
     }
 
-    /**
-     * Gets the MIME type of the file.
-     *
-     * @since n.e.x.t
-     *
-     * @return string The MIME type.
-     */
-    public function getMimeType(): string
-    {
-        return $this->mimeType;
-    }
-
     /**
      * Gets the base64-encoded data.
      *

src/Files/DTO/LocalFile.php

@@ -4,8 +4,9 @@
 
 namespace WordPress\AiClient\Files\DTO;
 
-use WordPress\AiClient\Common\Contracts\WithJsonSchema;
+use WordPress\AiClient\Common\Contracts\WithJsonSchemaInterface;
 use WordPress\AiClient\Files\Contracts\FileInterface;
+use WordPress\AiClient\Files\Traits\HasMimeType;
 
 /**
  * Represents a file stored locally on the filesystem.
@@ -15,12 +16,9 @@
  *
  * @since n.e.x.t
  */
-class LocalFile implements FileInterface, WithJsonSchema
+class LocalFile implements FileInterface, WithJsonSchemaInterface
 {
-    /**
-     * @var string The MIME type of the file.
-     */
-    private string $mimeType;
+    use HasMimeType;
 
     /**
      * @var string The local filesystem path to the file.
@@ -41,18 +39,6 @@ public function __construct(string $mimeType, string $path)
         $this->path = $path;
     }
 
-    /**
-     * Gets the MIME type of the file.
-     *
-     * @since n.e.x.t
-     *
-     * @return string The MIME type.
-     */
-    public function getMimeType(): string
-    {
-        return $this->mimeType;
-    }
-
     /**
      * Gets the local filesystem path.
      *

src/Files/DTO/RemoteFile.php

@@ -4,8 +4,9 @@
 
 namespace WordPress\AiClient\Files\DTO;
 
-use WordPress\AiClient\Common\Contracts\WithJsonSchema;
+use WordPress\AiClient\Common\Contracts\WithJsonSchemaInterface;
 use WordPress\AiClient\Files\Contracts\FileInterface;
+use WordPress\AiClient\Files\Traits\HasMimeType;
 
 /**
  * Represents a file accessible via a remote URL.
@@ -15,12 +16,9 @@
  *
  * @since n.e.x.t
  */
-class RemoteFile implements FileInterface, WithJsonSchema
+class RemoteFile implements FileInterface, WithJsonSchemaInterface
 {
-    /**
-     * @var string The MIME type of the file.
-     */
-    private string $mimeType;
+    use HasMimeType;
 
     /**
      * @var string The URL to the remote file.
@@ -41,18 +39,6 @@ public function __construct(string $mimeType, string $url)
         $this->url = $url;
     }
 
-    /**
-     * Gets the MIME type of the file.
-     *
-     * @since n.e.x.t
-     *
-     * @return string The MIME type.
-     */
-    public function getMimeType(): string
-    {
-        return $this->mimeType;
-    }
-
     /**
      * Gets the URL to the remote file.
      *

src/Files/Traits/HasMimeType.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WordPress\AiClient\Files\Traits;
+
+/**
+ * Provides MIME type functionality for file objects.
+ *
+ * This trait can be used by any class that needs to store and retrieve
+ * a MIME type property.
+ *
+ * @since 1.0.0
+ */
+trait HasMimeType
+{
+    /**
+     * The MIME type of the file.
+     *
+     * @var string
+     */
+    protected string $mimeType;
+
+    /**
+     * Gets the MIME type of the file.
+     *
+     * @return string The MIME type.
+     *
+     * @since 1.0.0
+     */
+    public function getMimeType(): string
+    {
+        return $this->mimeType;
+    }
+}

src/Messages/DTO/Message.php

@@ -4,7 +4,7 @@
 
 namespace WordPress\AiClient\Messages\DTO;
 
-use WordPress\AiClient\Common\Contracts\WithJsonSchema;
+use WordPress\AiClient\Common\Contracts\WithJsonSchemaInterface;
 use WordPress\AiClient\Messages\Enums\MessageRoleEnum;
 
 /**
@@ -15,7 +15,7 @@
  *
  * @since n.e.x.t
  */
-class Message implements WithJsonSchema
+class Message implements WithJsonSchemaInterface
 {
     /**
      * @var MessageRoleEnum The role of the message sender.

src/Messages/DTO/MessagePart.php

@@ -4,7 +4,7 @@
 
 namespace WordPress\AiClient\Messages\DTO;
 
-use WordPress\AiClient\Common\Contracts\WithJsonSchema;
+use WordPress\AiClient\Common\Contracts\WithJsonSchemaInterface;
 use WordPress\AiClient\Files\DTO\InlineFile;
 use WordPress\AiClient\Files\DTO\RemoteFile;
 use WordPress\AiClient\Messages\Enums\MessagePartTypeEnum;
@@ -19,7 +19,7 @@
  *
  * @since n.e.x.t
  */
-class MessagePart implements WithJsonSchema
+class MessagePart implements WithJsonSchemaInterface
 {
     /**
      * @var MessagePartTypeEnum The type of this message part.

src/Operations/Contracts/OperationInterface.php

@@ -4,7 +4,7 @@
 
 namespace WordPress\AiClient\Operations\Contracts;
 
-use WordPress\AiClient\Common\Contracts\WithJsonSchema;
+use WordPress\AiClient\Common\Contracts\WithJsonSchemaInterface;
 use WordPress\AiClient\Operations\Enums\OperationStateEnum;
 
 /**
@@ -15,7 +15,7 @@
  *
  * @since n.e.x.t
  */
-interface OperationInterface extends WithJsonSchema
+interface OperationInterface extends WithJsonSchemaInterface
 {
     /**
      * Gets the operation ID.

src/Results/Contracts/ResultInterface.php

@@ -4,7 +4,7 @@
 
 namespace WordPress\AiClient\Results\Contracts;
 
-use WordPress\AiClient\Common\Contracts\WithJsonSchema;
+use WordPress\AiClient\Common\Contracts\WithJsonSchemaInterface;
 use WordPress\AiClient\Results\DTO\TokenUsage;
 
 /**
@@ -15,7 +15,7 @@
  *
  * @since n.e.x.t
  */
-interface ResultInterface extends WithJsonSchema
+interface ResultInterface extends WithJsonSchemaInterface
 {
     /**
      * Gets the result ID.

src/Results/DTO/Candidate.php

@@ -4,7 +4,7 @@
 
 namespace WordPress\AiClient\Results\DTO;
 
-use WordPress\AiClient\Common\Contracts\WithJsonSchema;
+use WordPress\AiClient\Common\Contracts\WithJsonSchemaInterface;
 use WordPress\AiClient\Messages\DTO\Message;
 use WordPress\AiClient\Results\Enums\FinishReasonEnum;
 
@@ -16,7 +16,7 @@
  *
  * @since n.e.x.t
  */
-class Candidate implements WithJsonSchema
+class Candidate implements WithJsonSchemaInterface
 {
     /**
      * @var Message The generated message.