@multi-agent-protocol/sdk 0.1.4 → 0.1.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{index-B5adJHGI.d.cts → index-iu0EgJzG.d.cts} +88 -32
- package/dist/{index-B5adJHGI.d.ts → index-iu0EgJzG.d.ts} +88 -32
- package/dist/index.cjs +146 -88
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +146 -88
- package/dist/index.js.map +1 -1
- package/dist/testing.cjs +146 -88
- package/dist/testing.cjs.map +1 -1
- package/dist/testing.d.cts +1 -1
- package/dist/testing.d.ts +1 -1
- package/dist/testing.js +146 -88
- package/dist/testing.js.map +1 -1
- package/package.json +1 -1
|
@@ -2637,7 +2637,7 @@ interface TrajectoryContentChunkNotification extends MAPNotificationBase<Traject
|
|
|
2637
2637
|
params: TrajectoryContentChunkParams;
|
|
2638
2638
|
}
|
|
2639
2639
|
/** Standard task status values. Implementations may use `meta` for richer states. */
|
|
2640
|
-
type MAPTaskStatus =
|
|
2640
|
+
type MAPTaskStatus = "open" | "in_progress" | "blocked" | "completed" | "failed";
|
|
2641
2641
|
/**
|
|
2642
2642
|
* A task in the MAP system.
|
|
2643
2643
|
*
|
|
@@ -2682,7 +2682,7 @@ interface TaskCompletedEventData {
|
|
|
2682
2682
|
}
|
|
2683
2683
|
interface TasksCreateRequestParams {
|
|
2684
2684
|
/** Task data. If `id` is omitted, the server generates one. */
|
|
2685
|
-
task: Omit<MAPTask,
|
|
2685
|
+
task: Omit<MAPTask, "id"> & {
|
|
2686
2686
|
id?: TaskId;
|
|
2687
2687
|
};
|
|
2688
2688
|
_meta?: Meta;
|
|
@@ -2909,6 +2909,7 @@ declare const TASK_METHODS: {
|
|
|
2909
2909
|
declare const NOTIFICATION_METHODS: {
|
|
2910
2910
|
readonly EVENT: "map/event";
|
|
2911
2911
|
readonly MESSAGE: "map/message";
|
|
2912
|
+
readonly SEND: "map/send";
|
|
2912
2913
|
/** Client acknowledges received events (for backpressure) */
|
|
2913
2914
|
readonly SUBSCRIBE_ACK: "map/subscribe.ack";
|
|
2914
2915
|
/** Server notifies client that auth is about to expire */
|
|
@@ -5516,7 +5517,7 @@ interface AgentReconnectionOptions {
|
|
|
5516
5517
|
/**
|
|
5517
5518
|
* Agent reconnection event types
|
|
5518
5519
|
*/
|
|
5519
|
-
type AgentReconnectionEventType =
|
|
5520
|
+
type AgentReconnectionEventType = "disconnected" | "reconnecting" | "reconnected" | "reconnectFailed";
|
|
5520
5521
|
/**
|
|
5521
5522
|
* Handler for reconnection events
|
|
5522
5523
|
*/
|
|
@@ -5567,7 +5568,7 @@ interface AgentConnectOptions {
|
|
|
5567
5568
|
metadata?: Record<string, unknown>;
|
|
5568
5569
|
/** Authentication credentials */
|
|
5569
5570
|
auth?: {
|
|
5570
|
-
method:
|
|
5571
|
+
method: AuthMethod;
|
|
5571
5572
|
token?: string;
|
|
5572
5573
|
};
|
|
5573
5574
|
/**
|
|
@@ -5606,7 +5607,7 @@ interface AgentMeshConnectOptions {
|
|
|
5606
5607
|
metadata?: Record<string, unknown>;
|
|
5607
5608
|
/** Authentication credentials */
|
|
5608
5609
|
auth?: {
|
|
5609
|
-
method:
|
|
5610
|
+
method: "bearer" | "api-key" | "mtls" | "none";
|
|
5610
5611
|
token?: string;
|
|
5611
5612
|
};
|
|
5612
5613
|
/**
|
|
@@ -5661,6 +5662,27 @@ declare class AgentConnection {
|
|
|
5661
5662
|
* ```
|
|
5662
5663
|
*/
|
|
5663
5664
|
static connect(url: string, options?: AgentConnectOptions): Promise<AgentConnection>;
|
|
5665
|
+
/**
|
|
5666
|
+
* Create an AgentConnection over WebSocket without performing the MAP handshake.
|
|
5667
|
+
*
|
|
5668
|
+
* Use this when you need to control the connection flow — e.g., to handle
|
|
5669
|
+
* server-driven auth negotiation before registration.
|
|
5670
|
+
*
|
|
5671
|
+
* @example
|
|
5672
|
+
* ```typescript
|
|
5673
|
+
* const agent = await AgentConnection.createConnection('ws://localhost:8080', {
|
|
5674
|
+
* name: 'Worker',
|
|
5675
|
+
* role: 'processor',
|
|
5676
|
+
* });
|
|
5677
|
+
*
|
|
5678
|
+
* const result = await agent.connectOnly();
|
|
5679
|
+
* if (result.authRequired) {
|
|
5680
|
+
* await agent.authenticate({ method: result.authRequired.methods[0], token: cred });
|
|
5681
|
+
* }
|
|
5682
|
+
* await agent.register();
|
|
5683
|
+
* ```
|
|
5684
|
+
*/
|
|
5685
|
+
static createConnection(url: string, options?: AgentConnectOptions): Promise<AgentConnection>;
|
|
5664
5686
|
/**
|
|
5665
5687
|
* Connect and register an agent via agentic-mesh transport.
|
|
5666
5688
|
*
|
|
@@ -5706,13 +5728,52 @@ declare class AgentConnection {
|
|
|
5706
5728
|
/** Token to resume a previously disconnected session */
|
|
5707
5729
|
resumeToken?: string;
|
|
5708
5730
|
auth?: {
|
|
5709
|
-
method:
|
|
5731
|
+
method: AuthMethod;
|
|
5710
5732
|
token?: string;
|
|
5711
5733
|
};
|
|
5712
5734
|
}): Promise<{
|
|
5713
5735
|
connection: ConnectResponseResult;
|
|
5714
5736
|
agent: Agent;
|
|
5715
5737
|
}>;
|
|
5738
|
+
/**
|
|
5739
|
+
* Connect to the MAP system without registering an agent.
|
|
5740
|
+
*
|
|
5741
|
+
* Use this when the server may require authentication before registration.
|
|
5742
|
+
* After connecting, check `authRequired` in the response and call
|
|
5743
|
+
* `authenticate()` if needed, then `register()` to complete the handshake.
|
|
5744
|
+
*
|
|
5745
|
+
* @example
|
|
5746
|
+
* ```typescript
|
|
5747
|
+
* const result = await agent.connectOnly();
|
|
5748
|
+
*
|
|
5749
|
+
* if (result.authRequired) {
|
|
5750
|
+
* const method = result.authRequired.methods[0];
|
|
5751
|
+
* await agent.authenticate({ method, token: myCredential });
|
|
5752
|
+
* }
|
|
5753
|
+
*
|
|
5754
|
+
* await agent.register();
|
|
5755
|
+
* ```
|
|
5756
|
+
*/
|
|
5757
|
+
connectOnly(options?: {
|
|
5758
|
+
agentId?: AgentId;
|
|
5759
|
+
resumeToken?: string;
|
|
5760
|
+
auth?: {
|
|
5761
|
+
method: AuthMethod;
|
|
5762
|
+
token?: string;
|
|
5763
|
+
};
|
|
5764
|
+
}): Promise<ConnectResponseResult>;
|
|
5765
|
+
/**
|
|
5766
|
+
* Register as an agent after connecting.
|
|
5767
|
+
*
|
|
5768
|
+
* Call this after `connectOnly()` and optional `authenticate()` to complete
|
|
5769
|
+
* the connection handshake. Uses the options provided during construction
|
|
5770
|
+
* (name, role, scopes, etc.) unless overridden.
|
|
5771
|
+
*/
|
|
5772
|
+
register(overrides?: {
|
|
5773
|
+
agentId?: AgentId;
|
|
5774
|
+
name?: string;
|
|
5775
|
+
role?: string;
|
|
5776
|
+
}): Promise<Agent>;
|
|
5716
5777
|
/**
|
|
5717
5778
|
* Authenticate with the server after connection.
|
|
5718
5779
|
*
|
|
@@ -5725,26 +5786,21 @@ declare class AgentConnection {
|
|
|
5725
5786
|
*
|
|
5726
5787
|
* @example
|
|
5727
5788
|
* ```typescript
|
|
5728
|
-
* const
|
|
5729
|
-
*
|
|
5730
|
-
* // First connect to get auth requirements
|
|
5731
|
-
* const connectResult = await agent.connectOnly();
|
|
5789
|
+
* const result = await agent.connectOnly();
|
|
5732
5790
|
*
|
|
5733
|
-
* if (
|
|
5791
|
+
* if (result.authRequired) {
|
|
5734
5792
|
* const authResult = await agent.authenticate({
|
|
5735
|
-
* method:
|
|
5736
|
-
* token:
|
|
5793
|
+
* method: result.authRequired.methods[0],
|
|
5794
|
+
* token: myCredential,
|
|
5737
5795
|
* });
|
|
5738
|
-
*
|
|
5739
5796
|
* if (authResult.success) {
|
|
5740
|
-
*
|
|
5741
|
-
* await agent.register({ name: 'MyAgent', role: 'worker' });
|
|
5797
|
+
* await agent.register();
|
|
5742
5798
|
* }
|
|
5743
5799
|
* }
|
|
5744
5800
|
* ```
|
|
5745
5801
|
*/
|
|
5746
5802
|
authenticate(auth: {
|
|
5747
|
-
method:
|
|
5803
|
+
method: AuthMethod;
|
|
5748
5804
|
token?: string;
|
|
5749
5805
|
}): Promise<AuthenticateResponseResult>;
|
|
5750
5806
|
/**
|
|
@@ -5756,7 +5812,7 @@ declare class AgentConnection {
|
|
|
5756
5812
|
* @returns Updated principal information
|
|
5757
5813
|
*/
|
|
5758
5814
|
refreshAuth(auth: {
|
|
5759
|
-
method:
|
|
5815
|
+
method: AuthMethod;
|
|
5760
5816
|
token?: string;
|
|
5761
5817
|
}): Promise<{
|
|
5762
5818
|
success: boolean;
|
|
@@ -5920,7 +5976,7 @@ declare class AgentConnection {
|
|
|
5920
5976
|
* @param params - Conversation creation parameters
|
|
5921
5977
|
* @returns Created conversation and participant info
|
|
5922
5978
|
*/
|
|
5923
|
-
createConversation(params?: Omit<MailCreateRequestParams,
|
|
5979
|
+
createConversation(params?: Omit<MailCreateRequestParams, "_meta">): Promise<MailCreateResponseResult>;
|
|
5924
5980
|
/**
|
|
5925
5981
|
* Get a conversation by ID with optional includes.
|
|
5926
5982
|
*
|
|
@@ -5928,14 +5984,14 @@ declare class AgentConnection {
|
|
|
5928
5984
|
* @param include - Optional fields to include (participants, threads, recentTurns, stats)
|
|
5929
5985
|
* @returns Conversation details with requested includes
|
|
5930
5986
|
*/
|
|
5931
|
-
getConversation(conversationId: ConversationId, include?: MailGetRequestParams[
|
|
5987
|
+
getConversation(conversationId: ConversationId, include?: MailGetRequestParams["include"]): Promise<MailGetResponseResult>;
|
|
5932
5988
|
/**
|
|
5933
5989
|
* List conversations with optional filters.
|
|
5934
5990
|
*
|
|
5935
5991
|
* @param params - Optional filter, limit, and cursor parameters
|
|
5936
5992
|
* @returns Paginated list of conversations
|
|
5937
5993
|
*/
|
|
5938
|
-
listConversations(params?: Omit<MailListRequestParams,
|
|
5994
|
+
listConversations(params?: Omit<MailListRequestParams, "_meta">): Promise<MailListResponseResult>;
|
|
5939
5995
|
/**
|
|
5940
5996
|
* Close a conversation.
|
|
5941
5997
|
*
|
|
@@ -5950,7 +6006,7 @@ declare class AgentConnection {
|
|
|
5950
6006
|
* @param params - Join parameters including conversationId and optional catch-up config
|
|
5951
6007
|
* @returns Conversation, participant, and optional history
|
|
5952
6008
|
*/
|
|
5953
|
-
joinConversation(params: Omit<MailJoinRequestParams,
|
|
6009
|
+
joinConversation(params: Omit<MailJoinRequestParams, "_meta">): Promise<MailJoinResponseResult>;
|
|
5954
6010
|
/**
|
|
5955
6011
|
* Leave a conversation.
|
|
5956
6012
|
*
|
|
@@ -5965,49 +6021,49 @@ declare class AgentConnection {
|
|
|
5965
6021
|
* @param params - Invite parameters including conversationId and participant info
|
|
5966
6022
|
* @returns Invite result
|
|
5967
6023
|
*/
|
|
5968
|
-
inviteToConversation(params: Omit<MailInviteRequestParams,
|
|
6024
|
+
inviteToConversation(params: Omit<MailInviteRequestParams, "_meta">): Promise<MailInviteResponseResult>;
|
|
5969
6025
|
/**
|
|
5970
6026
|
* Record a turn (message) in a conversation.
|
|
5971
6027
|
*
|
|
5972
6028
|
* @param params - Turn parameters including conversationId, contentType, and content
|
|
5973
6029
|
* @returns The created turn
|
|
5974
6030
|
*/
|
|
5975
|
-
recordTurn(params: Omit<MailTurnRequestParams,
|
|
6031
|
+
recordTurn(params: Omit<MailTurnRequestParams, "_meta">): Promise<MailTurnResponseResult>;
|
|
5976
6032
|
/**
|
|
5977
6033
|
* List turns in a conversation with optional filters.
|
|
5978
6034
|
*
|
|
5979
6035
|
* @param params - List parameters including conversationId and optional filters
|
|
5980
6036
|
* @returns Paginated list of turns
|
|
5981
6037
|
*/
|
|
5982
|
-
listTurns(params: Omit<MailTurnsListRequestParams,
|
|
6038
|
+
listTurns(params: Omit<MailTurnsListRequestParams, "_meta">): Promise<MailTurnsListResponseResult>;
|
|
5983
6039
|
/**
|
|
5984
6040
|
* Create a thread in a conversation.
|
|
5985
6041
|
*
|
|
5986
6042
|
* @param params - Thread creation parameters including conversationId and rootTurnId
|
|
5987
6043
|
* @returns The created thread
|
|
5988
6044
|
*/
|
|
5989
|
-
createThread(params: Omit<MailThreadCreateRequestParams,
|
|
6045
|
+
createThread(params: Omit<MailThreadCreateRequestParams, "_meta">): Promise<MailThreadCreateResponseResult>;
|
|
5990
6046
|
/**
|
|
5991
6047
|
* List threads in a conversation.
|
|
5992
6048
|
*
|
|
5993
6049
|
* @param params - List parameters including conversationId
|
|
5994
6050
|
* @returns Paginated list of threads
|
|
5995
6051
|
*/
|
|
5996
|
-
listThreads(params: Omit<MailThreadListRequestParams,
|
|
6052
|
+
listThreads(params: Omit<MailThreadListRequestParams, "_meta">): Promise<MailThreadListResponseResult>;
|
|
5997
6053
|
/**
|
|
5998
6054
|
* Get a summary of a conversation.
|
|
5999
6055
|
*
|
|
6000
6056
|
* @param params - Summary parameters including conversationId and optional scope/includes
|
|
6001
6057
|
* @returns Generated summary with optional key points, decisions, and questions
|
|
6002
6058
|
*/
|
|
6003
|
-
getConversationSummary(params: Omit<MailSummaryRequestParams,
|
|
6059
|
+
getConversationSummary(params: Omit<MailSummaryRequestParams, "_meta">): Promise<MailSummaryResponseResult>;
|
|
6004
6060
|
/**
|
|
6005
6061
|
* Replay turns from a conversation, optionally from a specific point.
|
|
6006
6062
|
*
|
|
6007
6063
|
* @param params - Replay parameters including conversationId and optional starting point
|
|
6008
6064
|
* @returns Replayed turns with pagination info
|
|
6009
6065
|
*/
|
|
6010
|
-
replayConversation(params: Omit<MailReplayRequestParams,
|
|
6066
|
+
replayConversation(params: Omit<MailReplayRequestParams, "_meta">): Promise<MailReplayResponseResult>;
|
|
6011
6067
|
/**
|
|
6012
6068
|
* Send a message to an agent with mail context attached.
|
|
6013
6069
|
*
|
|
@@ -6042,7 +6098,7 @@ declare class AgentConnection {
|
|
|
6042
6098
|
* @param params - Task creation parameters
|
|
6043
6099
|
* @returns The created task
|
|
6044
6100
|
*/
|
|
6045
|
-
createTask(params: Omit<TasksCreateRequestParams,
|
|
6101
|
+
createTask(params: Omit<TasksCreateRequestParams, "_meta">): Promise<TasksCreateResponseResult>;
|
|
6046
6102
|
/**
|
|
6047
6103
|
* Assign a task to an agent.
|
|
6048
6104
|
*
|
|
@@ -6057,14 +6113,14 @@ declare class AgentConnection {
|
|
|
6057
6113
|
* @param params - Update parameters including taskId and fields to change
|
|
6058
6114
|
* @returns The updated task
|
|
6059
6115
|
*/
|
|
6060
|
-
updateTask(params: Omit<TasksUpdateRequestParams,
|
|
6116
|
+
updateTask(params: Omit<TasksUpdateRequestParams, "_meta">): Promise<TasksUpdateResponseResult>;
|
|
6061
6117
|
/**
|
|
6062
6118
|
* List tasks with optional filters.
|
|
6063
6119
|
*
|
|
6064
6120
|
* @param params - Optional filter, limit, and cursor parameters
|
|
6065
6121
|
* @returns Paginated list of tasks
|
|
6066
6122
|
*/
|
|
6067
|
-
listTasks(params?: Omit<TasksListRequestParams,
|
|
6123
|
+
listTasks(params?: Omit<TasksListRequestParams, "_meta">): Promise<TasksListResponseResult>;
|
|
6068
6124
|
}
|
|
6069
6125
|
|
|
6070
6126
|
/**
|
|
@@ -2637,7 +2637,7 @@ interface TrajectoryContentChunkNotification extends MAPNotificationBase<Traject
|
|
|
2637
2637
|
params: TrajectoryContentChunkParams;
|
|
2638
2638
|
}
|
|
2639
2639
|
/** Standard task status values. Implementations may use `meta` for richer states. */
|
|
2640
|
-
type MAPTaskStatus =
|
|
2640
|
+
type MAPTaskStatus = "open" | "in_progress" | "blocked" | "completed" | "failed";
|
|
2641
2641
|
/**
|
|
2642
2642
|
* A task in the MAP system.
|
|
2643
2643
|
*
|
|
@@ -2682,7 +2682,7 @@ interface TaskCompletedEventData {
|
|
|
2682
2682
|
}
|
|
2683
2683
|
interface TasksCreateRequestParams {
|
|
2684
2684
|
/** Task data. If `id` is omitted, the server generates one. */
|
|
2685
|
-
task: Omit<MAPTask,
|
|
2685
|
+
task: Omit<MAPTask, "id"> & {
|
|
2686
2686
|
id?: TaskId;
|
|
2687
2687
|
};
|
|
2688
2688
|
_meta?: Meta;
|
|
@@ -2909,6 +2909,7 @@ declare const TASK_METHODS: {
|
|
|
2909
2909
|
declare const NOTIFICATION_METHODS: {
|
|
2910
2910
|
readonly EVENT: "map/event";
|
|
2911
2911
|
readonly MESSAGE: "map/message";
|
|
2912
|
+
readonly SEND: "map/send";
|
|
2912
2913
|
/** Client acknowledges received events (for backpressure) */
|
|
2913
2914
|
readonly SUBSCRIBE_ACK: "map/subscribe.ack";
|
|
2914
2915
|
/** Server notifies client that auth is about to expire */
|
|
@@ -5516,7 +5517,7 @@ interface AgentReconnectionOptions {
|
|
|
5516
5517
|
/**
|
|
5517
5518
|
* Agent reconnection event types
|
|
5518
5519
|
*/
|
|
5519
|
-
type AgentReconnectionEventType =
|
|
5520
|
+
type AgentReconnectionEventType = "disconnected" | "reconnecting" | "reconnected" | "reconnectFailed";
|
|
5520
5521
|
/**
|
|
5521
5522
|
* Handler for reconnection events
|
|
5522
5523
|
*/
|
|
@@ -5567,7 +5568,7 @@ interface AgentConnectOptions {
|
|
|
5567
5568
|
metadata?: Record<string, unknown>;
|
|
5568
5569
|
/** Authentication credentials */
|
|
5569
5570
|
auth?: {
|
|
5570
|
-
method:
|
|
5571
|
+
method: AuthMethod;
|
|
5571
5572
|
token?: string;
|
|
5572
5573
|
};
|
|
5573
5574
|
/**
|
|
@@ -5606,7 +5607,7 @@ interface AgentMeshConnectOptions {
|
|
|
5606
5607
|
metadata?: Record<string, unknown>;
|
|
5607
5608
|
/** Authentication credentials */
|
|
5608
5609
|
auth?: {
|
|
5609
|
-
method:
|
|
5610
|
+
method: "bearer" | "api-key" | "mtls" | "none";
|
|
5610
5611
|
token?: string;
|
|
5611
5612
|
};
|
|
5612
5613
|
/**
|
|
@@ -5661,6 +5662,27 @@ declare class AgentConnection {
|
|
|
5661
5662
|
* ```
|
|
5662
5663
|
*/
|
|
5663
5664
|
static connect(url: string, options?: AgentConnectOptions): Promise<AgentConnection>;
|
|
5665
|
+
/**
|
|
5666
|
+
* Create an AgentConnection over WebSocket without performing the MAP handshake.
|
|
5667
|
+
*
|
|
5668
|
+
* Use this when you need to control the connection flow — e.g., to handle
|
|
5669
|
+
* server-driven auth negotiation before registration.
|
|
5670
|
+
*
|
|
5671
|
+
* @example
|
|
5672
|
+
* ```typescript
|
|
5673
|
+
* const agent = await AgentConnection.createConnection('ws://localhost:8080', {
|
|
5674
|
+
* name: 'Worker',
|
|
5675
|
+
* role: 'processor',
|
|
5676
|
+
* });
|
|
5677
|
+
*
|
|
5678
|
+
* const result = await agent.connectOnly();
|
|
5679
|
+
* if (result.authRequired) {
|
|
5680
|
+
* await agent.authenticate({ method: result.authRequired.methods[0], token: cred });
|
|
5681
|
+
* }
|
|
5682
|
+
* await agent.register();
|
|
5683
|
+
* ```
|
|
5684
|
+
*/
|
|
5685
|
+
static createConnection(url: string, options?: AgentConnectOptions): Promise<AgentConnection>;
|
|
5664
5686
|
/**
|
|
5665
5687
|
* Connect and register an agent via agentic-mesh transport.
|
|
5666
5688
|
*
|
|
@@ -5706,13 +5728,52 @@ declare class AgentConnection {
|
|
|
5706
5728
|
/** Token to resume a previously disconnected session */
|
|
5707
5729
|
resumeToken?: string;
|
|
5708
5730
|
auth?: {
|
|
5709
|
-
method:
|
|
5731
|
+
method: AuthMethod;
|
|
5710
5732
|
token?: string;
|
|
5711
5733
|
};
|
|
5712
5734
|
}): Promise<{
|
|
5713
5735
|
connection: ConnectResponseResult;
|
|
5714
5736
|
agent: Agent;
|
|
5715
5737
|
}>;
|
|
5738
|
+
/**
|
|
5739
|
+
* Connect to the MAP system without registering an agent.
|
|
5740
|
+
*
|
|
5741
|
+
* Use this when the server may require authentication before registration.
|
|
5742
|
+
* After connecting, check `authRequired` in the response and call
|
|
5743
|
+
* `authenticate()` if needed, then `register()` to complete the handshake.
|
|
5744
|
+
*
|
|
5745
|
+
* @example
|
|
5746
|
+
* ```typescript
|
|
5747
|
+
* const result = await agent.connectOnly();
|
|
5748
|
+
*
|
|
5749
|
+
* if (result.authRequired) {
|
|
5750
|
+
* const method = result.authRequired.methods[0];
|
|
5751
|
+
* await agent.authenticate({ method, token: myCredential });
|
|
5752
|
+
* }
|
|
5753
|
+
*
|
|
5754
|
+
* await agent.register();
|
|
5755
|
+
* ```
|
|
5756
|
+
*/
|
|
5757
|
+
connectOnly(options?: {
|
|
5758
|
+
agentId?: AgentId;
|
|
5759
|
+
resumeToken?: string;
|
|
5760
|
+
auth?: {
|
|
5761
|
+
method: AuthMethod;
|
|
5762
|
+
token?: string;
|
|
5763
|
+
};
|
|
5764
|
+
}): Promise<ConnectResponseResult>;
|
|
5765
|
+
/**
|
|
5766
|
+
* Register as an agent after connecting.
|
|
5767
|
+
*
|
|
5768
|
+
* Call this after `connectOnly()` and optional `authenticate()` to complete
|
|
5769
|
+
* the connection handshake. Uses the options provided during construction
|
|
5770
|
+
* (name, role, scopes, etc.) unless overridden.
|
|
5771
|
+
*/
|
|
5772
|
+
register(overrides?: {
|
|
5773
|
+
agentId?: AgentId;
|
|
5774
|
+
name?: string;
|
|
5775
|
+
role?: string;
|
|
5776
|
+
}): Promise<Agent>;
|
|
5716
5777
|
/**
|
|
5717
5778
|
* Authenticate with the server after connection.
|
|
5718
5779
|
*
|
|
@@ -5725,26 +5786,21 @@ declare class AgentConnection {
|
|
|
5725
5786
|
*
|
|
5726
5787
|
* @example
|
|
5727
5788
|
* ```typescript
|
|
5728
|
-
* const
|
|
5729
|
-
*
|
|
5730
|
-
* // First connect to get auth requirements
|
|
5731
|
-
* const connectResult = await agent.connectOnly();
|
|
5789
|
+
* const result = await agent.connectOnly();
|
|
5732
5790
|
*
|
|
5733
|
-
* if (
|
|
5791
|
+
* if (result.authRequired) {
|
|
5734
5792
|
* const authResult = await agent.authenticate({
|
|
5735
|
-
* method:
|
|
5736
|
-
* token:
|
|
5793
|
+
* method: result.authRequired.methods[0],
|
|
5794
|
+
* token: myCredential,
|
|
5737
5795
|
* });
|
|
5738
|
-
*
|
|
5739
5796
|
* if (authResult.success) {
|
|
5740
|
-
*
|
|
5741
|
-
* await agent.register({ name: 'MyAgent', role: 'worker' });
|
|
5797
|
+
* await agent.register();
|
|
5742
5798
|
* }
|
|
5743
5799
|
* }
|
|
5744
5800
|
* ```
|
|
5745
5801
|
*/
|
|
5746
5802
|
authenticate(auth: {
|
|
5747
|
-
method:
|
|
5803
|
+
method: AuthMethod;
|
|
5748
5804
|
token?: string;
|
|
5749
5805
|
}): Promise<AuthenticateResponseResult>;
|
|
5750
5806
|
/**
|
|
@@ -5756,7 +5812,7 @@ declare class AgentConnection {
|
|
|
5756
5812
|
* @returns Updated principal information
|
|
5757
5813
|
*/
|
|
5758
5814
|
refreshAuth(auth: {
|
|
5759
|
-
method:
|
|
5815
|
+
method: AuthMethod;
|
|
5760
5816
|
token?: string;
|
|
5761
5817
|
}): Promise<{
|
|
5762
5818
|
success: boolean;
|
|
@@ -5920,7 +5976,7 @@ declare class AgentConnection {
|
|
|
5920
5976
|
* @param params - Conversation creation parameters
|
|
5921
5977
|
* @returns Created conversation and participant info
|
|
5922
5978
|
*/
|
|
5923
|
-
createConversation(params?: Omit<MailCreateRequestParams,
|
|
5979
|
+
createConversation(params?: Omit<MailCreateRequestParams, "_meta">): Promise<MailCreateResponseResult>;
|
|
5924
5980
|
/**
|
|
5925
5981
|
* Get a conversation by ID with optional includes.
|
|
5926
5982
|
*
|
|
@@ -5928,14 +5984,14 @@ declare class AgentConnection {
|
|
|
5928
5984
|
* @param include - Optional fields to include (participants, threads, recentTurns, stats)
|
|
5929
5985
|
* @returns Conversation details with requested includes
|
|
5930
5986
|
*/
|
|
5931
|
-
getConversation(conversationId: ConversationId, include?: MailGetRequestParams[
|
|
5987
|
+
getConversation(conversationId: ConversationId, include?: MailGetRequestParams["include"]): Promise<MailGetResponseResult>;
|
|
5932
5988
|
/**
|
|
5933
5989
|
* List conversations with optional filters.
|
|
5934
5990
|
*
|
|
5935
5991
|
* @param params - Optional filter, limit, and cursor parameters
|
|
5936
5992
|
* @returns Paginated list of conversations
|
|
5937
5993
|
*/
|
|
5938
|
-
listConversations(params?: Omit<MailListRequestParams,
|
|
5994
|
+
listConversations(params?: Omit<MailListRequestParams, "_meta">): Promise<MailListResponseResult>;
|
|
5939
5995
|
/**
|
|
5940
5996
|
* Close a conversation.
|
|
5941
5997
|
*
|
|
@@ -5950,7 +6006,7 @@ declare class AgentConnection {
|
|
|
5950
6006
|
* @param params - Join parameters including conversationId and optional catch-up config
|
|
5951
6007
|
* @returns Conversation, participant, and optional history
|
|
5952
6008
|
*/
|
|
5953
|
-
joinConversation(params: Omit<MailJoinRequestParams,
|
|
6009
|
+
joinConversation(params: Omit<MailJoinRequestParams, "_meta">): Promise<MailJoinResponseResult>;
|
|
5954
6010
|
/**
|
|
5955
6011
|
* Leave a conversation.
|
|
5956
6012
|
*
|
|
@@ -5965,49 +6021,49 @@ declare class AgentConnection {
|
|
|
5965
6021
|
* @param params - Invite parameters including conversationId and participant info
|
|
5966
6022
|
* @returns Invite result
|
|
5967
6023
|
*/
|
|
5968
|
-
inviteToConversation(params: Omit<MailInviteRequestParams,
|
|
6024
|
+
inviteToConversation(params: Omit<MailInviteRequestParams, "_meta">): Promise<MailInviteResponseResult>;
|
|
5969
6025
|
/**
|
|
5970
6026
|
* Record a turn (message) in a conversation.
|
|
5971
6027
|
*
|
|
5972
6028
|
* @param params - Turn parameters including conversationId, contentType, and content
|
|
5973
6029
|
* @returns The created turn
|
|
5974
6030
|
*/
|
|
5975
|
-
recordTurn(params: Omit<MailTurnRequestParams,
|
|
6031
|
+
recordTurn(params: Omit<MailTurnRequestParams, "_meta">): Promise<MailTurnResponseResult>;
|
|
5976
6032
|
/**
|
|
5977
6033
|
* List turns in a conversation with optional filters.
|
|
5978
6034
|
*
|
|
5979
6035
|
* @param params - List parameters including conversationId and optional filters
|
|
5980
6036
|
* @returns Paginated list of turns
|
|
5981
6037
|
*/
|
|
5982
|
-
listTurns(params: Omit<MailTurnsListRequestParams,
|
|
6038
|
+
listTurns(params: Omit<MailTurnsListRequestParams, "_meta">): Promise<MailTurnsListResponseResult>;
|
|
5983
6039
|
/**
|
|
5984
6040
|
* Create a thread in a conversation.
|
|
5985
6041
|
*
|
|
5986
6042
|
* @param params - Thread creation parameters including conversationId and rootTurnId
|
|
5987
6043
|
* @returns The created thread
|
|
5988
6044
|
*/
|
|
5989
|
-
createThread(params: Omit<MailThreadCreateRequestParams,
|
|
6045
|
+
createThread(params: Omit<MailThreadCreateRequestParams, "_meta">): Promise<MailThreadCreateResponseResult>;
|
|
5990
6046
|
/**
|
|
5991
6047
|
* List threads in a conversation.
|
|
5992
6048
|
*
|
|
5993
6049
|
* @param params - List parameters including conversationId
|
|
5994
6050
|
* @returns Paginated list of threads
|
|
5995
6051
|
*/
|
|
5996
|
-
listThreads(params: Omit<MailThreadListRequestParams,
|
|
6052
|
+
listThreads(params: Omit<MailThreadListRequestParams, "_meta">): Promise<MailThreadListResponseResult>;
|
|
5997
6053
|
/**
|
|
5998
6054
|
* Get a summary of a conversation.
|
|
5999
6055
|
*
|
|
6000
6056
|
* @param params - Summary parameters including conversationId and optional scope/includes
|
|
6001
6057
|
* @returns Generated summary with optional key points, decisions, and questions
|
|
6002
6058
|
*/
|
|
6003
|
-
getConversationSummary(params: Omit<MailSummaryRequestParams,
|
|
6059
|
+
getConversationSummary(params: Omit<MailSummaryRequestParams, "_meta">): Promise<MailSummaryResponseResult>;
|
|
6004
6060
|
/**
|
|
6005
6061
|
* Replay turns from a conversation, optionally from a specific point.
|
|
6006
6062
|
*
|
|
6007
6063
|
* @param params - Replay parameters including conversationId and optional starting point
|
|
6008
6064
|
* @returns Replayed turns with pagination info
|
|
6009
6065
|
*/
|
|
6010
|
-
replayConversation(params: Omit<MailReplayRequestParams,
|
|
6066
|
+
replayConversation(params: Omit<MailReplayRequestParams, "_meta">): Promise<MailReplayResponseResult>;
|
|
6011
6067
|
/**
|
|
6012
6068
|
* Send a message to an agent with mail context attached.
|
|
6013
6069
|
*
|
|
@@ -6042,7 +6098,7 @@ declare class AgentConnection {
|
|
|
6042
6098
|
* @param params - Task creation parameters
|
|
6043
6099
|
* @returns The created task
|
|
6044
6100
|
*/
|
|
6045
|
-
createTask(params: Omit<TasksCreateRequestParams,
|
|
6101
|
+
createTask(params: Omit<TasksCreateRequestParams, "_meta">): Promise<TasksCreateResponseResult>;
|
|
6046
6102
|
/**
|
|
6047
6103
|
* Assign a task to an agent.
|
|
6048
6104
|
*
|
|
@@ -6057,14 +6113,14 @@ declare class AgentConnection {
|
|
|
6057
6113
|
* @param params - Update parameters including taskId and fields to change
|
|
6058
6114
|
* @returns The updated task
|
|
6059
6115
|
*/
|
|
6060
|
-
updateTask(params: Omit<TasksUpdateRequestParams,
|
|
6116
|
+
updateTask(params: Omit<TasksUpdateRequestParams, "_meta">): Promise<TasksUpdateResponseResult>;
|
|
6061
6117
|
/**
|
|
6062
6118
|
* List tasks with optional filters.
|
|
6063
6119
|
*
|
|
6064
6120
|
* @param params - Optional filter, limit, and cursor parameters
|
|
6065
6121
|
* @returns Paginated list of tasks
|
|
6066
6122
|
*/
|
|
6067
|
-
listTasks(params?: Omit<TasksListRequestParams,
|
|
6123
|
+
listTasks(params?: Omit<TasksListRequestParams, "_meta">): Promise<TasksListResponseResult>;
|
|
6068
6124
|
}
|
|
6069
6125
|
|
|
6070
6126
|
/**
|