@meetsmore-oss/use-ai-core 1.2.3 → 1.3.0

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export type { ToolDefinition, 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, WorkflowStatus, UseAIClientMessage, RunWorkflowMessage, McpHeadersConfig, McpHeadersMap, AgentInfo, UseAIForwardedProps, TextContent, ImageContent, FileContent, MultimodalContent, UserMessageContent, } from './types';
+export type { ToolDefinition, 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, WorkflowStatus, UseAIClientMessage, RunWorkflowMessage, McpHeadersConfig, McpHeadersMap, AgentInfo, UseAIForwardedProps, TextContent, ImageContent, FileContent, TransformedFileContent, MultimodalContent, UserMessageContent, } from './types';
 export { EventType, ErrorCode } from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAEV,cAAc,EAEd,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,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,SAAS,EACT,mBAAmB,EAEnB,WAAW,EACX,YAAY,EACZ,WAAW,EACX,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAEV,cAAc,EAEd,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,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,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"}

package/dist/types.d.ts

@@ -235,11 +235,30 @@ export interface FileContent {
     /** Original file name */
     name: string;
 }
+/**
+ * Transformed file content part for multimodal messages.
+ * Created when a file is processed by a FileTransformer on the client.
+ * The AI receives the transformed text, not the original file data.
+ *
+ * Note: This is internal to use-ai. The server converts this to plain text
+ * before passing to the AI SDK, preserving AG-UI protocol compatibility.
+ */
+export interface TransformedFileContent {
+    type: 'transformed_file';
+    /** The transformed text representation of the file */
+    text: string;
+    /** Metadata about the original file (for display and context) */
+    originalFile: {
+        name: string;
+        mimeType: string;
+        size: number;
+    };
+}
 /**
  * Content part for multimodal messages.
  * A message can contain multiple content parts of different types.
  */
-export type MultimodalContent = TextContent | ImageContent | FileContent;
+export type MultimodalContent = TextContent | ImageContent | FileContent | TransformedFileContent;
 /**
  * User message content - can be a simple string or multimodal content array.
  * When multimodal, the array can contain text, images, and files.

package/dist/types.d.ts.map

@@ -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,4EAA4E;IAC5E,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;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;;;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;CAChB;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,CAAC;IACjE,IAAI,EAAE,OAAO,CAAC;CACf;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;;;;WAIG;QACH,cAAc,CAAC,EAAE;YACf;;eAEG;YACH,UAAU,CAAC,EAAE,aAAa,CAAA;SAC3B,CAAA;KACF,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;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,YAAY,GAAG,WAAW,CAAC;AAEzE;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,iBAAiB,EAAE,CAAC"}
+{"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,4EAA4E;IAC5E,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;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;;;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;CAChB;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,CAAC;IACjE,IAAI,EAAE,OAAO,CAAC;CACf;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;;;;WAIG;QACH,cAAc,CAAC,EAAE;YACf;;eAEG;YACH,UAAU,CAAC,EAAE,aAAa,CAAA;SAC3B,CAAA;KACF,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

@@ -1,6 +1,6 @@
 {
   "name": "@meetsmore-oss/use-ai-core",
-  "version": "1.2.3",
+  "version": "1.3.0",
   "license": "BUSL-1.1",
   "files": [
     "dist"

package/dist/citations.d.ts

@@ -1,92 +0,0 @@
-/**
- * Custom event name for citation events.
- * Used with AG-UI CustomEvent to transmit citation data.
- */
-export declare const CITATION_EVENT_NAME = "citation";
-/**
- * Unicode Private Use Area delimiters for citation markers.
- * Using PUA characters as delimiters prevents collision with natural text.
- *
- * Format: START + "cite" + SEP + number + END
- * Example: '\ue200cite\ue2021\ue201' for citation 1
- *
- * This format follows the ChatGPT citation style where:
- * - \ue200 marks the start of a citation reference
- * - \ue201 marks the end of a citation reference
- * - \ue202 separates the type from the reference identifier
- * - "cite" and the number are visible text the AI can output
- */
-export declare const CITATION_MARKER_START = "\uE200";
-export declare const CITATION_MARKER_END = "\uE201";
-export declare const CITATION_MARKER_SEP = "\uE202";
-/**
- * Pattern to match legacy [n] citation markers in text.
- * Used for backwards compatibility.
- */
-export declare const LEGACY_CITATION_PATTERN: RegExp;
-/**
- * Pattern to match citation markers in text.
- * Uses Markdown footnote syntax [^n] which Claude outputs naturally and rarely appears in code.
- * Examples: [^1], [^2], [^1,2]
- */
-export declare const CITATION_PATTERN: RegExp;
-/**
- * Creates a citation marker for a given number.
- * @param num The citation number (1, 2, 3, etc.)
- * @returns The marker string (e.g., '[^1]')
- */
-export declare function createCitationMarker(num: number): string;
-/**
- * Transforms legacy [n] citation markers to footnote format.
- * @param text Text containing [1], [2], etc. markers
- * @returns Text with footnote markers ([^1], [^2], etc.)
- */
-export declare function transformLegacyCitations(text: string): string;
-/**
- * System prompt instruction for AI models to use citation markers.
- * Uses Markdown footnote syntax [^n] which Claude outputs naturally.
- *
- * @example
- * ```typescript
- * new AISDKAgent({
- *   model: anthropic('claude-sonnet-4-20250514'),
- *   providerTools: { web_search: webSearch },
- *   // Citation instruction is auto-appended when citations: true (default)
- * });
- * ```
- */
-export declare const CITATION_SYSTEM_INSTRUCTION = "**CITATION FORMAT (REQUIRED)**\nWhen referencing information from sources, cite using Markdown footnote markers.\n\nFormat: [^N] where N is the source number (1-indexed position in results).\nMultiple sources: [^1,2]\n\nEXAMPLES:\n- \"TypeScript 5.7 was released in November 2024[^1].\"\n- \"React 19 introduced new features[^2] and performance improvements[^1,3].\"\n\nRULES:\n1. Place [^N] IMMEDIATELY after the cited claim.\n2. Every fact from sources MUST have a citation marker.";
-/**
- * A citation reference that can be displayed inline as [n] linking to a source.
- */
-export interface Citation {
-    /** Unique identifier for this citation */
-    id: string;
-    /** Sequential number for display [1], [2], etc. */
-    number: number;
-    /** Type of citation source */
-    type: 'url' | 'document' | 'tool-result';
-    /** URL for web sources (opens in new tab when clicked) */
-    url?: string;
-    /** Title of the source (used for tooltip) */
-    title?: string;
-    /** Document ID for RAG sources */
-    documentId?: string;
-    /** Snippet/excerpt from the source */
-    snippet?: string;
-    /** Tool name that provided this citation */
-    toolName?: string;
-    /** Provider-specific metadata */
-    metadata?: Record<string, unknown>;
-}
-/**
- * Event payload for citation custom events.
- * Sent via CustomEvent with name='citation'.
- */
-export interface CitationEvent {
-    /** The message ID these citations belong to */
-    messageId: string;
-    /** Array of citations collected so far */
-    citations: Citation[];
-}
-//# sourceMappingURL=citations.d.ts.map

package/dist/citations.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"citations.d.ts","sourceRoot":"","sources":["../src/citations.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,eAAO,MAAM,mBAAmB,aAAa,CAAC;AAE9C;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,qBAAqB,WAAW,CAAC;AAC9C,eAAO,MAAM,mBAAmB,WAAW,CAAC;AAC5C,eAAO,MAAM,mBAAmB,WAAW,CAAC;AAE5C;;;GAGG;AACH,eAAO,MAAM,uBAAuB,QAAe,CAAC;AAEpD;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,QAA0B,CAAC;AAExD;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAExD;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE7D;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,2BAA2B,weAYgB,CAAC;AAEzD;;GAEG;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;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,+CAA+C;IAC/C,SAAS,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,SAAS,EAAE,QAAQ,EAAE,CAAC;CACvB"}