Add optional metadata object to AgentGeneratePayload [PIC-852] (#2864)

* feat: update AgentGeneratePayload to support custom metadata

* fix: simplify AgentGeneratePayload type definition

* fix: update AgentGeneratePayload type parameter for consistency

Author: elliotmassen

lib/entities/agent.ts

@@ -30,7 +30,7 @@ export type AgentProps = {
 
 type AgentMessageRole = 'system' | 'user' | 'assistant' | 'tool'
 
-export type AgentGeneratePayload = {
+export type AgentGeneratePayload<TMetadata = Record<string, unknown>> = {
   messages: Array<{
     parts: Array<{
       type: 'text'
@@ -40,6 +40,7 @@ export type AgentGeneratePayload = {
     role: AgentMessageRole
   }>
   threadId?: string
+  metadata?: TMetadata
 }
 
 export interface Agent extends AgentProps, DefaultElements<AgentProps> {

test/unit/plain/agent.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, test } from 'vitest'
-import { createClient } from '../../../lib/contentful-management'
+import { AgentGeneratePayload, createClient } from '../../../lib/contentful-management'
 import setupRestAdapter from '../adapters/REST/helpers/setupRestAdapter'
 
 describe('Agent', () => {
@@ -75,8 +75,15 @@ describe('Agent', () => {
     const { httpMock, adapterMock } = setupRestAdapter(Promise.resolve({ data: mockResponse }))
     const plainClient = createClient({ apiAdapter: adapterMock }, { type: 'plain' })
 
-    const payload = {
+    type CustomMetadata = {
+      customData: string
+    }
+
+    const payload: AgentGeneratePayload<CustomMetadata> = {
       messages: [{ parts: [{ type: 'text' as const, text: 'Hello' }], role: 'user' as const }],
+      metadata: {
+        customData: 'my-custom-data',
+      },
     }
 
     const response = await plainClient.agent.generate({ spaceId, environmentId, agentId }, payload)