bug #490 [Platform] Fix data types of enum values in Json Schema (chr-hertel)

This PR was merged into the main branch.

Discussion
----------

[Platform] Fix data types of enum values in Json Schema

| Q             | A
| ------------- | ---
| Bug fix?      | yes
| New feature?  | no
| Docs?         | no
| Issues        |
| License       | MIT

Actually enum values in Json Schema can be more than just string :)

Commits
-------

14d5ccf Fix data types of enum values in Json Schema

Author: OskarStark

fixtures/StructuredOutput/ExampleDto.php

@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\AI\Fixtures\StructuredOutput;
+
+use Symfony\AI\Platform\Contract\JsonSchema\Attribute\With;
+
+class ExampleDto
+{
+    public function __construct(
+        public string $name,
+        #[With(enum: [7, 19])] public int $taxRate,
+        #[With(enum: ['Foo', 'Bar', null])] public ?string $category,
+    ) {
+    }
+}

src/platform/phpstan.dist.neon

@@ -7,6 +7,7 @@ parameters:
     paths:
         - src/
         - tests/
+    treatPhpDocTypesAsCertain: false
     ignoreErrors:
         -
             message: "#^Method .*::test.*\\(\\) has no return type specified\\.$#"

src/platform/src/Contract/JsonSchema/Attribute/With.php

@@ -20,8 +20,8 @@
 final readonly class With
 {
     /**
-     * @param list<int|string>|null    $enum
-     * @param string|int|string[]|null $const
+     * @param list<int|float|string|null>|null $enum
+     * @param string|int|string[]|null         $const
      */
     public function __construct(
         // can be used by many types
@@ -53,8 +53,9 @@ public function __construct(
         public ?bool $dependentRequired = null,
     ) {
         if (\is_array($enum)) {
-            if (array_filter($enum, fn ($item) => \is_string($item)) !== $enum) {
-                throw new InvalidArgumentException('All enum values must be strings.');
+            /* @phpstan-ignore-next-line function.alreadyNarrowedType */
+            if (array_filter($enum, fn (mixed $item) => null === $item || \is_int($item) || \is_float($item) || \is_string($item)) !== $enum) {
+                throw new InvalidArgumentException('All enum values must be float, integer, strings, or null.');
             }
         }
 

src/platform/tests/Contract/JsonSchema/Attribute/ToolParameterTest.php

@@ -26,11 +26,11 @@ public function testValidEnum()
         $this->assertSame($enum, $toolParameter->enum);
     }
 
-    public function testInvalidEnumContainsNonString()
+    public function testInvalidEnumContainsInvalidType()
     {
         $this->expectException(InvalidArgumentException::class);
-        $enum = ['value1', 2];
-        new With(enum: $enum);
+        $enum = ['value1', new \stdClass()];
+        new With(enum: $enum); /* @phpstan-ignore-line argument.type */
     }
 
     public function testValidConstString()

src/platform/tests/Contract/JsonSchema/FactoryTest.php

@@ -14,6 +14,7 @@
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\UsesClass;
 use PHPUnit\Framework\TestCase;
+use Symfony\AI\Fixtures\StructuredOutput\ExampleDto;
 use Symfony\AI\Fixtures\StructuredOutput\MathReasoning;
 use Symfony\AI\Fixtures\StructuredOutput\Step;
 use Symfony\AI\Fixtures\StructuredOutput\User;
@@ -240,4 +241,28 @@ public function testBuildPropertiesForStepClass()
 
         $this->assertSame($expected, $actual);
     }
+
+    public function testBuildPropertiesForExampleDto()
+    {
+        $expected = [
+            'type' => 'object',
+            'properties' => [
+                'name' => ['type' => 'string'],
+                'taxRate' => [
+                    'type' => 'integer',
+                    'enum' => [7, 19],
+                ],
+                'category' => [
+                    'type' => ['string', 'null'],
+                    'enum' => ['Foo', 'Bar', null],
+                ],
+            ],
+            'required' => ['name', 'taxRate'],
+            'additionalProperties' => false,
+        ];
+
+        $actual = $this->factory->buildProperties(ExampleDto::class);
+
+        $this->assertSame($expected, $actual);
+    }
 }