@meetsmore-oss/use-ai-core 1.2.1

package/dist/citations.d.ts

@@ -0,0 +1,92 @@
+/**
+ * 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

@@ -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;;;;;;;;;;;;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"}

package/dist/index.d.ts

@@ -0,0 +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 { EventType, ErrorCode } from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +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"}