Skip to content

Commit 3599747

Browse files
authored
chore(backend): Rename taskId -> agentTaskId (#8013)
1 parent 4ff81b6 commit 3599747

4 files changed

Lines changed: 22 additions & 5 deletions

File tree

.changeset/cute-places-wear.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@clerk/backend': patch
3+
---
4+
5+
Adds `agentTaskId` and deprecates `taskId` to Agent Tasks Create response.

packages/backend/src/api/__tests__/AgentTaskApi.test.ts

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ describe('AgentTaskAPI', () => {
1313
const mockAgentTaskResponse = {
1414
object: 'agent_task',
1515
agent_id: 'agent_123',
16-
task_id: 'task_456',
16+
task_id: 'agent_task_456',
17+
agent_task_id: 'agent_task_456',
1718
url: 'https://example.com/agent-task',
1819
};
1920

@@ -51,9 +52,9 @@ describe('AgentTaskAPI', () => {
5152
redirectUrl: 'https://example.com/callback',
5253
sessionMaxDurationInSeconds: 1800,
5354
});
54-
5555
expect(response.agentId).toBe('agent_123');
56-
expect(response.taskId).toBe('task_456');
56+
expect(response.taskId).toBe('agent_task_456');
57+
expect(response.agentTaskId).toBe('agent_task_456');
5758
expect(response.url).toBe('https://example.com/agent-task');
5859
});
5960

@@ -90,7 +91,8 @@ describe('AgentTaskAPI', () => {
9091
});
9192

9293
expect(response.agentId).toBe('agent_123');
93-
expect(response.taskId).toBe('task_456');
94+
expect(response.taskId).toBe('agent_task_456');
95+
expect(response.agentTaskId).toBe('agent_task_456');
9496
});
9597
});
9698
});

packages/backend/src/api/resources/AgentTask.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,13 @@ export class AgentTask {
1414
readonly agentId: string,
1515
/**
1616
* A unique identifier for this agent task.
17+
* @deprecated Use agentTaskId instead.
1718
*/
1819
readonly taskId: string,
20+
/**
21+
* A unique identifier for this agent task.
22+
*/
23+
readonly agentTaskId: string,
1924
/**
2025
* The FAPI URL that, when visited, creates a session for the user.
2126
*/
@@ -29,6 +34,7 @@ export class AgentTask {
2934
* @returns A new AgentTask instance
3035
*/
3136
static fromJSON(data: AgentTaskJSON): AgentTask {
32-
return new AgentTask(data.agent_id, data.task_id, data.url);
37+
const agentTaskId = data.agent_task_id ?? data.task_id ?? '';
38+
return new AgentTask(data.agent_id, agentTaskId, agentTaskId, data.url);
3339
}
3440
}

packages/backend/src/api/resources/JSON.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -599,6 +599,10 @@ export interface SignInTokenJSON extends ClerkResourceJSON {
599599
export interface AgentTaskJSON extends ClerkResourceJSON {
600600
object: typeof ObjectType.AgentTask;
601601
agent_id: string;
602+
agent_task_id: string;
603+
/**
604+
* @deprecated Use `agent_task_id` instead.
605+
*/
602606
task_id: string;
603607
url: string;
604608
}

0 commit comments

Comments
 (0)