Merge pull request #28 from WordPress/feature/data-transfer-objects

Adds Implementor Data Transfer Objects

Author: JasonTheAdams

phpstan.neon.dist

@@ -2,3 +2,4 @@ parameters:
     level: max
     paths:
         - src
+    treatPhpDocTypesAsCertain: false

src/Common/AbstractEnum.php

@@ -30,6 +30,9 @@
  * $enum->is(PersonEnum::firstName()); // Returns true
  * PersonEnum::cases(); // Returns array of all enum instances
  *
+ * @property-read string $value The value of the enum instance.
+ * @property-read string $name The name of the enum constant.
+ *
  * @since n.e.x.t
  */
 abstract class AbstractEnum
@@ -195,11 +198,11 @@ final public function is(self $other): bool
      *
      * @since n.e.x.t
      *
-     * @return array<string, string> Map of constant names to values.
+     * @return string[] List of all enum values.
      */
     final public static function getValues(): array
     {
-        return self::getConstants();
+        return array_values(self::getConstants());
     }
 
     /**

src/Common/Contracts/WithJsonSchemaInterface.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WordPress\AiClient\Common\Contracts;
+
+/**
+ * Interface for objects that can provide their JSON schema representation.
+ *
+ * This interface is implemented by DTOs to provide a consistent way to retrieve
+ * their JSON schema for validation and serialization purposes.
+ *
+ * @since n.e.x.t
+ */
+interface WithJsonSchemaInterface
+{
+    /**
+     * Gets the JSON schema representation of the object.
+     *
+     * @since n.e.x.t
+     *
+     * @return array<string, mixed> The JSON schema as an associative array.
+     */
+    public static function getJsonSchema(): array;
+}