feat: use intersection type AbstractUid&TimeBasedUidInterface for flexible message IDs (#384)

This PR updates the message ID type from `TimeBasedUidInterface` to
`AbstractUid&TimeBasedUidInterface` using PHP's intersection types. This
change provides more flexibility while maintaining type safety.

Using the intersection type `AbstractUid&TimeBasedUidInterface` ensures
that:
- ✅ Both `toRfc4122()` (from AbstractUid) and `getDateTime()` (from
TimeBasedUidInterface) are available
- ✅ Implementations can use any time-based UID type (UUID v1/v6/v7 or
ULID)
- ✅ Type safety is maintained
- ✅ All existing tests pass without modification

- Updated `MessageInterface::getId()` return type
- Updated all message implementations (AssistantMessage, SystemMessage,
UserMessage, ToolCallMessage)
- Updated anonymous class in tests

1. **Flexibility**: Users can now implement messages with either UUID or
ULID
2. **Type Safety**: The intersection type guarantees all necessary
methods are available
3. **Future Proof**: Any new Symfony UID types that extend AbstractUid
and implement TimeBasedUidInterface will work

None - this is backwards compatible since all existing UUID
implementations already satisfy the new type constraint.

All existing tests pass. The implementation has been verified to work
with both UUID and ULID.

Author: OskarStark

src/platform/src/Message/AssistantMessage.php

@@ -12,14 +12,16 @@
 namespace Symfony\AI\Platform\Message;
 
 use Symfony\AI\Platform\Response\ToolCall;
+use Symfony\Component\Uid\AbstractUid;
+use Symfony\Component\Uid\TimeBasedUidInterface;
 use Symfony\Component\Uid\Uuid;
 
 /**
  * @author Denis Zunke <[email protected]>
  */
 final readonly class AssistantMessage implements MessageInterface
 {
-    public Uuid $id;
+    public AbstractUid&TimeBasedUidInterface $id;
 
     /**
      * @param ?ToolCall[] $toolCalls
@@ -36,7 +38,7 @@ public function getRole(): Role
         return Role::Assistant;
     }
 
-    public function getId(): Uuid
+    public function getId(): AbstractUid&TimeBasedUidInterface
     {
         return $this->id;
     }

src/platform/src/Message/MessageInterface.php

@@ -11,7 +11,8 @@
 
 namespace Symfony\AI\Platform\Message;
 
-use Symfony\Component\Uid\Uuid;
+use Symfony\Component\Uid\AbstractUid;
+use Symfony\Component\Uid\TimeBasedUidInterface;
 
 /**
  * @author Denis Zunke <[email protected]>
@@ -20,5 +21,5 @@ interface MessageInterface
 {
     public function getRole(): Role;
 
-    public function getId(): Uuid;
+    public function getId(): AbstractUid&TimeBasedUidInterface;
 }

src/platform/src/Message/SystemMessage.php

@@ -11,14 +11,16 @@
 
 namespace Symfony\AI\Platform\Message;
 
+use Symfony\Component\Uid\AbstractUid;
+use Symfony\Component\Uid\TimeBasedUidInterface;
 use Symfony\Component\Uid\Uuid;
 
 /**
  * @author Denis Zunke <[email protected]>
  */
 final readonly class SystemMessage implements MessageInterface
 {
-    public Uuid $id;
+    public AbstractUid&TimeBasedUidInterface $id;
 
     public function __construct(public string $content)
     {
@@ -30,7 +32,7 @@ public function getRole(): Role
         return Role::System;
     }
 
-    public function getId(): Uuid
+    public function getId(): AbstractUid&TimeBasedUidInterface
     {
         return $this->id;
     }

src/platform/src/Message/ToolCallMessage.php

@@ -12,14 +12,16 @@
 namespace Symfony\AI\Platform\Message;
 
 use Symfony\AI\Platform\Response\ToolCall;
+use Symfony\Component\Uid\AbstractUid;
+use Symfony\Component\Uid\TimeBasedUidInterface;
 use Symfony\Component\Uid\Uuid;
 
 /**
  * @author Denis Zunke <[email protected]>
  */
 final readonly class ToolCallMessage implements MessageInterface
 {
-    public Uuid $id;
+    public AbstractUid&TimeBasedUidInterface $id;
 
     public function __construct(
         public ToolCall $toolCall,
@@ -33,7 +35,7 @@ public function getRole(): Role
         return Role::ToolCall;
     }
 
-    public function getId(): Uuid
+    public function getId(): AbstractUid&TimeBasedUidInterface
     {
         return $this->id;
     }

src/platform/src/Message/UserMessage.php

@@ -15,6 +15,8 @@
 use Symfony\AI\Platform\Message\Content\ContentInterface;
 use Symfony\AI\Platform\Message\Content\Image;
 use Symfony\AI\Platform\Message\Content\ImageUrl;
+use Symfony\Component\Uid\AbstractUid;
+use Symfony\Component\Uid\TimeBasedUidInterface;
 use Symfony\Component\Uid\Uuid;
 
 /**
@@ -27,7 +29,7 @@
      */
     public array $content;
 
-    public Uuid $id;
+    public AbstractUid&TimeBasedUidInterface $id;
 
     public function __construct(
         ContentInterface ...$content,
@@ -41,7 +43,7 @@ public function getRole(): Role
         return Role::User;
     }
 
-    public function getId(): Uuid
+    public function getId(): AbstractUid&TimeBasedUidInterface
     {
         return $this->id;
     }

src/platform/tests/ContractTest.php

@@ -42,6 +42,8 @@
 use Symfony\AI\Platform\Message\SystemMessage;
 use Symfony\AI\Platform\Message\UserMessage;
 use Symfony\AI\Platform\Model;
+use Symfony\Component\Uid\AbstractUid;
+use Symfony\Component\Uid\TimeBasedUidInterface;
 use Symfony\Component\Uid\Uuid;
 
 #[Large]
@@ -208,7 +210,7 @@ public function getRole(): Role
                 return Role::User;
             }
 
-            public function getId(): Uuid
+            public function getId(): AbstractUid&TimeBasedUidInterface
             {
                 return Uuid::v7();
             }

src/platform/tests/Message/AssistantMessageTest.php

@@ -20,6 +20,8 @@
 use Symfony\AI\Platform\Message\Role;
 use Symfony\AI\Platform\Response\ToolCall;
 use Symfony\AI\Platform\Tests\Helper\UuidAssertionTrait;
+use Symfony\Component\Uid\AbstractUid;
+use Symfony\Component\Uid\TimeBasedUidInterface;
 use Symfony\Component\Uid\UuidV7;
 
 #[CoversClass(AssistantMessage::class)]
@@ -86,4 +88,14 @@ public function sameMessagesHaveDifferentUids(): void
         self::assertIsUuidV7($message1->getId()->toRfc4122());
         self::assertIsUuidV7($message2->getId()->toRfc4122());
     }
+
+    #[Test]
+    public function messageIdImplementsRequiredInterfaces(): void
+    {
+        $message = new AssistantMessage('test');
+
+        self::assertInstanceOf(AbstractUid::class, $message->getId());
+        self::assertInstanceOf(TimeBasedUidInterface::class, $message->getId());
+        self::assertInstanceOf(UuidV7::class, $message->getId());
+    }
 }

src/platform/tests/Message/SystemMessageTest.php

@@ -18,6 +18,8 @@
 use Symfony\AI\Platform\Message\Role;
 use Symfony\AI\Platform\Message\SystemMessage;
 use Symfony\AI\Platform\Tests\Helper\UuidAssertionTrait;
+use Symfony\Component\Uid\AbstractUid;
+use Symfony\Component\Uid\TimeBasedUidInterface;
 use Symfony\Component\Uid\UuidV7;
 
 #[CoversClass(SystemMessage::class)]
@@ -66,4 +68,14 @@ public function sameMessagesHaveDifferentUids(): void
         self::assertIsUuidV7($message1->getId()->toRfc4122());
         self::assertIsUuidV7($message2->getId()->toRfc4122());
     }
+
+    #[Test]
+    public function messageIdImplementsRequiredInterfaces(): void
+    {
+        $message = new SystemMessage('test');
+
+        self::assertInstanceOf(AbstractUid::class, $message->getId());
+        self::assertInstanceOf(TimeBasedUidInterface::class, $message->getId());
+        self::assertInstanceOf(UuidV7::class, $message->getId());
+    }
 }

src/platform/tests/Message/ToolCallMessageTest.php

@@ -19,6 +19,8 @@
 use Symfony\AI\Platform\Message\ToolCallMessage;
 use Symfony\AI\Platform\Response\ToolCall;
 use Symfony\AI\Platform\Tests\Helper\UuidAssertionTrait;
+use Symfony\Component\Uid\AbstractUid;
+use Symfony\Component\Uid\TimeBasedUidInterface;
 use Symfony\Component\Uid\UuidV7;
 
 #[CoversClass(ToolCallMessage::class)]
@@ -72,4 +74,15 @@ public function sameMessagesHaveDifferentUids(): void
         self::assertIsUuidV7($message1->getId()->toRfc4122());
         self::assertIsUuidV7($message2->getId()->toRfc4122());
     }
+
+    #[Test]
+    public function messageIdImplementsRequiredInterfaces(): void
+    {
+        $toolCall = new ToolCall('foo', 'bar');
+        $message = new ToolCallMessage($toolCall, 'test');
+
+        self::assertInstanceOf(AbstractUid::class, $message->getId());
+        self::assertInstanceOf(TimeBasedUidInterface::class, $message->getId());
+        self::assertInstanceOf(UuidV7::class, $message->getId());
+    }
 }

src/platform/tests/Message/UserMessageTest.php

@@ -22,6 +22,8 @@
 use Symfony\AI\Platform\Message\Role;
 use Symfony\AI\Platform\Message\UserMessage;
 use Symfony\AI\Platform\Tests\Helper\UuidAssertionTrait;
+use Symfony\Component\Uid\AbstractUid;
+use Symfony\Component\Uid\TimeBasedUidInterface;
 use Symfony\Component\Uid\UuidV7;
 
 #[CoversClass(UserMessage::class)]
@@ -116,4 +118,14 @@ public function sameMessagesHaveDifferentUids(): void
         self::assertIsUuidV7($message1->getId()->toRfc4122());
         self::assertIsUuidV7($message2->getId()->toRfc4122());
     }
+
+    #[Test]
+    public function messageIdImplementsRequiredInterfaces(): void
+    {
+        $message = new UserMessage(new Text('test'));
+
+        self::assertInstanceOf(AbstractUid::class, $message->getId());
+        self::assertInstanceOf(TimeBasedUidInterface::class, $message->getId());
+        self::assertInstanceOf(UuidV7::class, $message->getId());
+    }
 }