@meetsmore-oss/use-ai-core 1.5.1 → 1.7.0
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.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -0
- package/dist/types.d.ts +45 -10
- package/dist/types.d.ts.map +1 -1
- package/package.json +1 -1
- package/dist/citations.d.ts +0 -49
- package/dist/citations.d.ts.map +0 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
export type { ToolDefinition, ToolAnnotations, ClientMessage, RunAgentMessage, ToolResultMessage, AbortRunMessage, Tool, Message, Context, RunAgentInput, State, RunStartedEvent, RunFinishedEvent, RunErrorEvent, StepStartedEvent, StepFinishedEvent, TextMessageStartEvent, TextMessageContentEvent, TextMessageEndEvent, TextMessageChunkEvent, ToolCallStartEvent, ToolCallArgsEvent, ToolCallEndEvent, ToolCallChunkEvent, ToolCallResultEvent, StateSnapshotEvent, StateDeltaEvent, MessagesSnapshotEvent, RawEvent, CustomEvent, ActivitySnapshotEvent, ActivityDeltaEvent, AGUIEvent, ToolCallStartExtensions, WorkflowStatus, UseAIClientMessage, RunWorkflowMessage, FeedbackMessage, FeedbackValue, McpHeadersConfig, McpHeadersMap, AgentInfo, UseAIForwardedProps, TextContent, ImageContent, FileContent, TransformedFileContent, MultimodalContent, UserMessageContent, } from './types';
|
|
2
|
-
export { EventType, ErrorCode } from './types';
|
|
1
|
+
export type { ToolDefinition, ToolAnnotations, ClientMessage, RunAgentMessage, ToolResultMessage, AbortRunMessage, Tool, Message, Context, RunAgentInput, State, RunStartedEvent, RunFinishedEvent, RunErrorEvent, StepStartedEvent, StepFinishedEvent, TextMessageStartEvent, TextMessageContentEvent, TextMessageEndEvent, TextMessageChunkEvent, ToolCallStartEvent, ToolCallArgsEvent, ToolCallEndEvent, ToolCallChunkEvent, ToolCallResultEvent, StateSnapshotEvent, StateDeltaEvent, MessagesSnapshotEvent, RawEvent, CustomEvent, ActivitySnapshotEvent, ActivityDeltaEvent, AGUIEvent, ToolCallStartExtensions, WorkflowStatus, UseAIClientMessage, RunWorkflowMessage, FeedbackMessage, FeedbackValue, McpHeadersConfig, McpHeadersMap, AgentInfo, UseAIForwardedProps, ToolApprovalRequestEvent, ToolApprovalResponseMessage, TextContent, ImageContent, FileContent, TransformedFileContent, MultimodalContent, UserMessageContent, } from './types';
|
|
2
|
+
export { EventType, ErrorCode, TOOL_APPROVAL_REQUEST } from './types';
|
|
3
3
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAEV,cAAc,EACd,eAAe,EAEf,aAAa,EACb,eAAe,EACf,iBAAiB,EACjB,eAAe,EAEf,IAAI,EACJ,OAAO,EACP,OAAO,EACP,aAAa,EACb,KAAK,EAEL,eAAe,EACf,gBAAgB,EAChB,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACjB,qBAAqB,EACrB,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EAClB,eAAe,EACf,qBAAqB,EACrB,QAAQ,EACR,WAAW,EACX,qBAAqB,EACrB,kBAAkB,EAClB,SAAS,EAET,uBAAuB,EACvB,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,eAAe,EACf,aAAa,EACb,gBAAgB,EAChB,aAAa,EACb,SAAS,EACT,mBAAmB,EAEnB,WAAW,EACX,YAAY,EACZ,WAAW,EACX,sBAAsB,EACtB,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAEV,cAAc,EACd,eAAe,EAEf,aAAa,EACb,eAAe,EACf,iBAAiB,EACjB,eAAe,EAEf,IAAI,EACJ,OAAO,EACP,OAAO,EACP,aAAa,EACb,KAAK,EAEL,eAAe,EACf,gBAAgB,EAChB,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACjB,qBAAqB,EACrB,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EAClB,eAAe,EACf,qBAAqB,EACrB,QAAQ,EACR,WAAW,EACX,qBAAqB,EACrB,kBAAkB,EAClB,SAAS,EAET,uBAAuB,EACvB,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,eAAe,EACf,aAAa,EACb,gBAAgB,EAChB,aAAa,EACb,SAAS,EACT,mBAAmB,EAEnB,wBAAwB,EACxB,2BAA2B,EAE3B,WAAW,EACX,YAAY,EACZ,WAAW,EACX,sBAAsB,EACtB,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -4511,9 +4511,11 @@ var ErrorCode;
|
|
|
4511
4511
|
ErrorCode2["RATE_LIMITED"] = "RATE_LIMITED";
|
|
4512
4512
|
ErrorCode2["UNKNOWN_ERROR"] = "UNKNOWN_ERROR";
|
|
4513
4513
|
})(ErrorCode ||= {});
|
|
4514
|
+
var TOOL_APPROVAL_REQUEST = "TOOL_APPROVAL_REQUEST";
|
|
4514
4515
|
var export_EventType = import_core.EventType;
|
|
4515
4516
|
|
|
4516
4517
|
export {
|
|
4518
|
+
TOOL_APPROVAL_REQUEST,
|
|
4517
4519
|
export_EventType as EventType,
|
|
4518
4520
|
ErrorCode
|
|
4519
4521
|
};
|
package/dist/types.d.ts
CHANGED
|
@@ -106,6 +106,45 @@ export interface ToolCallStartExtensions {
|
|
|
106
106
|
/** MCP tool annotations (for displaying status text, etc.) */
|
|
107
107
|
annotations?: ToolAnnotations;
|
|
108
108
|
}
|
|
109
|
+
/**
|
|
110
|
+
* Event type for tool approval requests.
|
|
111
|
+
* This is a use-ai extension, not part of AG-UI protocol.
|
|
112
|
+
*/
|
|
113
|
+
export declare const TOOL_APPROVAL_REQUEST: "TOOL_APPROVAL_REQUEST";
|
|
114
|
+
/**
|
|
115
|
+
* Event emitted when a tool requires user approval before execution.
|
|
116
|
+
* This happens when a tool has `annotations.destructiveHint: true`.
|
|
117
|
+
*
|
|
118
|
+
* The client should display a confirmation dialog and respond with
|
|
119
|
+
* a tool_approval_response message.
|
|
120
|
+
*/
|
|
121
|
+
export interface ToolApprovalRequestEvent {
|
|
122
|
+
type: typeof TOOL_APPROVAL_REQUEST;
|
|
123
|
+
/** Unique ID for this tool call */
|
|
124
|
+
toolCallId: string;
|
|
125
|
+
/** Name of the tool requesting approval */
|
|
126
|
+
toolCallName: string;
|
|
127
|
+
/** Arguments the tool will be called with */
|
|
128
|
+
toolCallArgs: Record<string, unknown>;
|
|
129
|
+
/** Tool annotations for UI display */
|
|
130
|
+
annotations?: ToolAnnotations;
|
|
131
|
+
/** Timestamp when this event was generated */
|
|
132
|
+
timestamp: number;
|
|
133
|
+
}
|
|
134
|
+
/**
|
|
135
|
+
* Message sent from client to server to approve or reject a tool execution.
|
|
136
|
+
*/
|
|
137
|
+
export interface ToolApprovalResponseMessage {
|
|
138
|
+
type: 'tool_approval_response';
|
|
139
|
+
data: {
|
|
140
|
+
/** The tool call ID being approved/rejected */
|
|
141
|
+
toolCallId: string;
|
|
142
|
+
/** Whether the tool execution is approved */
|
|
143
|
+
approved: boolean;
|
|
144
|
+
/** Optional reason for rejection (shown to AI) */
|
|
145
|
+
reason?: string;
|
|
146
|
+
};
|
|
147
|
+
}
|
|
109
148
|
/**
|
|
110
149
|
* HTTP headers configuration for a single MCP endpoint.
|
|
111
150
|
* Can be used for authentication, custom headers, or any HTTP header needs.
|
|
@@ -134,6 +173,8 @@ export interface UseAIForwardedProps {
|
|
|
134
173
|
mcpHeaders?: McpHeadersMap;
|
|
135
174
|
/** Agent ID to use for this request (falls back to server default if not specified) */
|
|
136
175
|
agent?: string;
|
|
176
|
+
/** Telemetry metadata for observability (e.g., Langfuse eval tracing) */
|
|
177
|
+
telemetryMetadata?: Record<string, unknown>;
|
|
137
178
|
}
|
|
138
179
|
/**
|
|
139
180
|
* Mapping of MCP endpoint patterns to HTTP headers configurations.
|
|
@@ -167,13 +208,13 @@ export type WorkflowStatus = 'idle' | 'running' | 'completed' | 'error';
|
|
|
167
208
|
/**
|
|
168
209
|
* Extended message type for use-ai.
|
|
169
210
|
* Includes AG-UI protocol messages ('run_agent', 'tool_result', 'abort_run')
|
|
170
|
-
* plus use-ai-specific extensions ('run_workflow', 'message_feedback').
|
|
211
|
+
* plus use-ai-specific extensions ('run_workflow', 'message_feedback', 'tool_approval_response').
|
|
171
212
|
*
|
|
172
213
|
* Note: This extends beyond AG-UI protocol to support headless workflow triggers.
|
|
173
214
|
* For AG-UI compliance, use ClientMessage instead.
|
|
174
215
|
*/
|
|
175
216
|
export interface UseAIClientMessage {
|
|
176
|
-
type: 'run_agent' | 'tool_result' | 'abort_run' | 'run_workflow' | 'message_feedback';
|
|
217
|
+
type: 'run_agent' | 'tool_result' | 'abort_run' | 'run_workflow' | 'message_feedback' | 'tool_approval_response';
|
|
177
218
|
data: unknown;
|
|
178
219
|
}
|
|
179
220
|
/**
|
|
@@ -242,15 +283,9 @@ export interface RunWorkflowMessage {
|
|
|
242
283
|
threadId: string;
|
|
243
284
|
/**
|
|
244
285
|
* AG-UI extension point for additional fields in messages.
|
|
245
|
-
*
|
|
246
|
-
* @see RunAgentInput['forwardedProps']
|
|
286
|
+
* @see UseAIForwardedProps
|
|
247
287
|
*/
|
|
248
|
-
forwardedProps?:
|
|
249
|
-
/**
|
|
250
|
-
* A map of current McpHeaders that should be applied to MCP tool calls (e.g. auth headers)
|
|
251
|
-
*/
|
|
252
|
-
mcpHeaders?: McpHeadersMap;
|
|
253
|
-
};
|
|
288
|
+
forwardedProps?: UseAIForwardedProps;
|
|
254
289
|
};
|
|
255
290
|
}
|
|
256
291
|
/**
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,IAAI,EACJ,OAAO,EACP,OAAO,EACP,aAAa,EACb,KAAK,EAEL,eAAe,EACf,gBAAgB,EAChB,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EAEjB,qBAAqB,EACrB,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EAErB,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EAEnB,kBAAkB,EAClB,eAAe,EACf,qBAAqB,EAErB,QAAQ,EACR,WAAW,EAEX,qBAAqB,EACrB,kBAAkB,EACnB,MAAM,aAAa,CAAC;AAErB;;;GAGG;AACH,oBAAY,SAAS;IACnB,6DAA6D;IAC7D,cAAc,mBAAmB;IACjC,mDAAmD;IACnD,YAAY,iBAAiB;IAC7B,qDAAqD;IACrD,aAAa,kBAAkB;CAChC;AAED,YAAY,EACV,IAAI,EACJ,OAAO,EACP,OAAO,EACP,aAAa,EACb,KAAK,EACL,eAAe,EACf,gBAAgB,EAChB,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACjB,qBAAqB,EACrB,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EAClB,eAAe,EACf,qBAAqB,EACrB,QAAQ,EACR,WAAW,EACX,qBAAqB,EACrB,kBAAkB,GACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,uDAAuD;IACvD,WAAW,EAAE,MAAM,CAAC;IACpB,yDAAyD;IACzD,UAAU,EAAE;QACV,IAAI,EAAE,QAAQ,CAAC;QACf,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACpC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;KACrB,CAAC;IACF,sDAAsD;IACtD,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,qCAAqC;IACrC,IAAI,EAAE,WAAW,GAAG,aAAa,GAAG,WAAW,CAAC;IAChD,0BAA0B;IAC1B,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,aAAa,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,aAAa,CAAC;IACpB,IAAI,EAAE;QACJ,qCAAqC;QACrC,SAAS,EAAE,MAAM,CAAC;QAClB,wDAAwD;QACxD,UAAU,EAAE,MAAM,CAAC;QACnB,uCAAuC;QACvC,OAAO,EAAE,MAAM,CAAC;QAChB,6CAA6C;QAC7C,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE;QACJ,sBAAsB;QACtB,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,MAAM,SAAS,GACjB,eAAe,GACf,gBAAgB,GAChB,aAAa,GACb,gBAAgB,GAChB,iBAAiB,GACjB,qBAAqB,GACrB,uBAAuB,GACvB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,GAClB,iBAAiB,GACjB,gBAAgB,GAChB,kBAAkB,GAClB,mBAAmB,GACnB,kBAAkB,GAClB,eAAe,GACf,qBAAqB,GACrB,qBAAqB,GACrB,kBAAkB,GAClB,QAAQ,GACR,WAAW,CAAC;AAGhB,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AASxC;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,qEAAqE;IACrE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yEAAyE;IACzE,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,6GAA6G;IAC7G,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,2FAA2F;IAC3F,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,mFAAmF;IACnF,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,8DAA8D;IAC9D,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,+CAA+C;IAC/C,EAAE,EAAE,MAAM,CAAC;IACX,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,4DAA4D;IAC5D,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,gEAAgE;IAChE,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B,uFAAuF;IACvF,KAAK,CAAC,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,IAAI,EACJ,OAAO,EACP,OAAO,EACP,aAAa,EACb,KAAK,EAEL,eAAe,EACf,gBAAgB,EAChB,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EAEjB,qBAAqB,EACrB,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EAErB,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EAEnB,kBAAkB,EAClB,eAAe,EACf,qBAAqB,EAErB,QAAQ,EACR,WAAW,EAEX,qBAAqB,EACrB,kBAAkB,EACnB,MAAM,aAAa,CAAC;AAErB;;;GAGG;AACH,oBAAY,SAAS;IACnB,6DAA6D;IAC7D,cAAc,mBAAmB;IACjC,mDAAmD;IACnD,YAAY,iBAAiB;IAC7B,qDAAqD;IACrD,aAAa,kBAAkB;CAChC;AAED,YAAY,EACV,IAAI,EACJ,OAAO,EACP,OAAO,EACP,aAAa,EACb,KAAK,EACL,eAAe,EACf,gBAAgB,EAChB,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACjB,qBAAqB,EACrB,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EAClB,eAAe,EACf,qBAAqB,EACrB,QAAQ,EACR,WAAW,EACX,qBAAqB,EACrB,kBAAkB,GACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,uDAAuD;IACvD,WAAW,EAAE,MAAM,CAAC;IACpB,yDAAyD;IACzD,UAAU,EAAE;QACV,IAAI,EAAE,QAAQ,CAAC;QACf,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACpC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;KACrB,CAAC;IACF,sDAAsD;IACtD,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,qCAAqC;IACrC,IAAI,EAAE,WAAW,GAAG,aAAa,GAAG,WAAW,CAAC;IAChD,0BAA0B;IAC1B,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,aAAa,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,aAAa,CAAC;IACpB,IAAI,EAAE;QACJ,qCAAqC;QACrC,SAAS,EAAE,MAAM,CAAC;QAClB,wDAAwD;QACxD,UAAU,EAAE,MAAM,CAAC;QACnB,uCAAuC;QACvC,OAAO,EAAE,MAAM,CAAC;QAChB,6CAA6C;QAC7C,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE;QACJ,sBAAsB;QACtB,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,MAAM,SAAS,GACjB,eAAe,GACf,gBAAgB,GAChB,aAAa,GACb,gBAAgB,GAChB,iBAAiB,GACjB,qBAAqB,GACrB,uBAAuB,GACvB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,GAClB,iBAAiB,GACjB,gBAAgB,GAChB,kBAAkB,GAClB,mBAAmB,GACnB,kBAAkB,GAClB,eAAe,GACf,qBAAqB,GACrB,qBAAqB,GACrB,kBAAkB,GAClB,QAAQ,GACR,WAAW,CAAC;AAGhB,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AASxC;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,qEAAqE;IACrE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yEAAyE;IACzE,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,6GAA6G;IAC7G,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,2FAA2F;IAC3F,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,mFAAmF;IACnF,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,8DAA8D;IAC9D,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAMD;;;GAGG;AACH,eAAO,MAAM,qBAAqB,EAAG,uBAAgC,CAAC;AAEtE;;;;;;GAMG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,OAAO,qBAAqB,CAAC;IACnC,mCAAmC;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,2CAA2C;IAC3C,YAAY,EAAE,MAAM,CAAC;IACrB,6CAA6C;IAC7C,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACtC,sCAAsC;IACtC,WAAW,CAAC,EAAE,eAAe,CAAC;IAC9B,8CAA8C;IAC9C,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,wBAAwB,CAAC;IAC/B,IAAI,EAAE;QACJ,+CAA+C;QAC/C,UAAU,EAAE,MAAM,CAAC;QACnB,6CAA6C;QAC7C,QAAQ,EAAE,OAAO,CAAC;QAClB,kDAAkD;QAClD,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,+CAA+C;IAC/C,EAAE,EAAE,MAAM,CAAC;IACX,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,4DAA4D;IAC5D,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,gEAAgE;IAChE,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B,uFAAuF;IACvF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yEAAyE;IACzE,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC7C;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,SAAS,GAAG,WAAW,GAAG,OAAO,CAAC;AAExE;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,WAAW,GAAG,aAAa,GAAG,WAAW,GAAG,cAAc,GAAG,kBAAkB,GAAG,wBAAwB,CAAC;IACjH,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,UAAU,GAAG,IAAI,CAAC;AAEzD;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,kBAAkB,CAAC;IACzB,IAAI,EAAE;QACJ,qDAAqD;QACrD,SAAS,EAAE,MAAM,CAAC;QAClB,wDAAwD;QACxD,OAAO,EAAE,MAAM,CAAC;QAChB,qFAAqF;QACrF,QAAQ,EAAE,aAAa,CAAC;KACzB,CAAC;CACH;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE;QACJ,kDAAkD;QAClD,MAAM,EAAE,MAAM,CAAC;QACf,wEAAwE;QACxE,UAAU,EAAE,MAAM,CAAC;QACnB,kCAAkC;QAClC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC5B,iDAAiD;QACjD,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;QACzB,0BAA0B;QAC1B,KAAK,EAAE,MAAM,CAAC;QACd,0CAA0C;QAC1C,QAAQ,EAAE,MAAM,CAAC;QACjB;;;WAGG;QACH,cAAc,CAAC,EAAE,mBAAmB,CAAA;KACrC,CAAC;CACH;AAMD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,OAAO,CAAC;IACd,yCAAyC;IACzC,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,wCAAwC;IACxC,GAAG,EAAE,MAAM,CAAC;IACZ,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,kBAAkB,CAAC;IACzB,sDAAsD;IACtD,IAAI,EAAE,MAAM,CAAC;IACb,iEAAiE;IACjE,YAAY,EAAE;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GACzB,WAAW,GACX,YAAY,GACZ,WAAW,GACX,sBAAsB,CAAC;AAE3B;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,iBAAiB,EAAE,CAAC"}
|
package/package.json
CHANGED
package/dist/citations.d.ts
DELETED
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Custom event name for citation events.
|
|
3
|
-
* Used with AG-UI CustomEvent to transmit citation data.
|
|
4
|
-
*/
|
|
5
|
-
export declare const CITATION_EVENT_NAME = "citation";
|
|
6
|
-
/**
|
|
7
|
-
* A citation reference from an AI SDK source chunk.
|
|
8
|
-
* Citations are collected from structured AI SDK source data, not parsed from text.
|
|
9
|
-
*/
|
|
10
|
-
export interface Citation {
|
|
11
|
-
/** Unique identifier for this citation */
|
|
12
|
-
id: string;
|
|
13
|
-
/** Sequential number for display [1], [2], etc. */
|
|
14
|
-
number: number;
|
|
15
|
-
/** Type of citation source */
|
|
16
|
-
type: 'url' | 'document' | 'tool-result';
|
|
17
|
-
/** URL for web sources (opens in new tab when clicked) */
|
|
18
|
-
url?: string;
|
|
19
|
-
/** Title of the source (used for tooltip) */
|
|
20
|
-
title?: string;
|
|
21
|
-
/** Document ID for RAG sources */
|
|
22
|
-
documentId?: string;
|
|
23
|
-
/** Snippet/excerpt from the source */
|
|
24
|
-
snippet?: string;
|
|
25
|
-
/** Tool name that provided this citation */
|
|
26
|
-
toolName?: string;
|
|
27
|
-
/** Provider-specific metadata */
|
|
28
|
-
metadata?: Record<string, unknown>;
|
|
29
|
-
/**
|
|
30
|
-
* Where this citation should be rendered.
|
|
31
|
-
* - 'inline': Replace an embedded link in the text (OpenAI includes these)
|
|
32
|
-
* - 'trailing': Show at the end of the message (default for most providers)
|
|
33
|
-
*
|
|
34
|
-
* Server normalizes provider-specific behavior into this field.
|
|
35
|
-
* Client renders based on this without knowing about providers.
|
|
36
|
-
*/
|
|
37
|
-
placement?: 'inline' | 'trailing';
|
|
38
|
-
}
|
|
39
|
-
/**
|
|
40
|
-
* Event payload for citation custom events.
|
|
41
|
-
* Sent via CustomEvent with name='citation'.
|
|
42
|
-
*/
|
|
43
|
-
export interface CitationEvent {
|
|
44
|
-
/** The message ID these citations belong to */
|
|
45
|
-
messageId: string;
|
|
46
|
-
/** Array of citations collected so far */
|
|
47
|
-
citations: Citation[];
|
|
48
|
-
}
|
|
49
|
-
//# sourceMappingURL=citations.d.ts.map
|
package/dist/citations.d.ts.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"citations.d.ts","sourceRoot":"","sources":["../src/citations.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,eAAO,MAAM,mBAAmB,aAAa,CAAC;AAE9C;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,0CAA0C;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,mDAAmD;IACnD,MAAM,EAAE,MAAM,CAAC;IACf,8BAA8B;IAC9B,IAAI,EAAE,KAAK,GAAG,UAAU,GAAG,aAAa,CAAC;IACzC,0DAA0D;IAC1D,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,6CAA6C;IAC7C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kCAAkC;IAClC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,sCAAsC;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,+CAA+C;IAC/C,SAAS,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,SAAS,EAAE,QAAQ,EAAE,CAAC;CACvB"}
|