@arbor-education/ask-arbor-chat-panel 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,243 @@
+import { ComponentProps } from 'react';
+import { Icon } from '@arbor-education/design-system.components';
+import { JSX as JSX_2 } from 'react';
+
+declare type AgentCompletionsConfig = {
+    model?: string;
+    agentName?: string;
+    systemPrompt?: string;
+    modelKwargs?: Record<string, unknown>;
+    mcps?: McpFilter[];
+};
+
+export declare type AIInteraction = {
+    id: string;
+    title: string;
+    updatedAt: string;
+    chatId: string;
+};
+
+export declare const AIServiceConnectorFactory: {
+    create(config: ConnectorConfig_2): IAIServiceConnector;
+};
+
+export declare type CanvasElement = {
+    id: string;
+    contentType: 'HTML' | 'CHART' | 'TABLE' | 'TABULAR_DATA';
+    outputType?: string;
+    content: any;
+    visible?: boolean;
+    title?: string;
+    editedOrCreatedByUser: boolean;
+    [key: string]: any;
+};
+
+declare type CategoryTheme = 'green' | 'blue' | 'purple' | 'orange' | 'teal' | 'salmon' | 'yellow';
+
+export declare const CHAT_RESPONSE_TYPE_AGENT = "AGENT";
+
+export declare const CHAT_RESPONSE_TYPE_ERROR = "ERROR";
+
+export declare const CHAT_RESPONSE_TYPE_INFO = "INFO";
+
+export declare const CHAT_RESPONSE_TYPE_USER = "USER";
+
+export declare const CHAT_RESPONSE_TYPE_WARNING = "WARNING";
+
+export declare type ChatMessage = {
+    text: string;
+    type: MessageType;
+    id: string;
+    followUpPrompts?: string[] | null;
+    element?: CanvasElement | CanvasElement[];
+};
+
+export declare const ChatPanel: ({ title, connector, newChatUrl, lockConversation, messageLimit: unsafeMessageLimit, chatId: chatIdFromProps, speechEnabled, speechLanguage, speechSubmissionDelay, chatHistory, canvasHistory, refreshAgentMessages, startQuery: initialStartQuery, slashMenuItems, menuContent, samplePrompts, dailyPrompt, prompts: promptsJson, promptLibrary, placeholder: inputPlaceholder, introHeading, introBody, onClose, onNavigate, onRatingPopupOpen, focusDelay, }: ChatPanelProps) => JSX_2.Element;
+
+export declare type ChatPanelProps = {
+    title?: string;
+    connector: IAIServiceConnector;
+    newChatUrl?: string;
+    /** Prompt library categories passed as a typed array. Takes precedence over the legacy `prompts` JSON string prop. */
+    promptLibrary?: PromptLibraryCategory[];
+    lockConversation?: boolean;
+    messageLimit?: string | number;
+    chatId?: string;
+    placeholder?: string;
+    samplePrompts?: string[];
+    dailyPrompt?: string;
+    speechEnabled?: boolean;
+    speechLanguage?: string;
+    speechSubmissionDelay?: number;
+    chatHistory?: ChatMessage[];
+    canvasHistory?: CanvasElement[];
+    refreshAgentMessages?: string;
+    /** Submits immediately when the panel opens. Ignored when loading an existing chat via `chatId`. */
+    startQuery?: string;
+    /** Slash menu items (opened with /). Omit or pass an empty array to disable. */
+    slashMenuItems?: MenuContentItem[];
+    /** Cog menu items. Omit or pass an empty array to hide the cog button. */
+    menuContent?: MenuContentItem[];
+    prompts?: string;
+    introHeading?: string;
+    introBody?: string;
+    /**
+     * Called when the component wants to close its container (e.g. a panel or slideover).
+     * Replaces `removeSlideover` from the Arbor ecosystem.
+     */
+    onClose?: () => void;
+    /**
+     * Called when the component needs to navigate to a URL.
+     * Defaults to `window.location.href` for internal URLs and `window.open` for https://.
+     */
+    onNavigate?: (url: string) => void;
+    /**
+     * Called when a rating popup URL should be opened.
+     * Defaults to `window.open(url, '_blank')`.
+     */
+    onRatingPopupOpen?: (url: string) => void;
+    /**
+     * Delay in ms before focusing the input on mount. Use 350 when rendering inside a panel
+     * with an entry transition (replaces the Arbor slideover focus-delay logic).
+     */
+    focusDelay?: number;
+};
+
+declare type ConnectorConfig = {
+    chatUrl: string;
+    authorizationToken?: string;
+    historicChatUrl?: string;
+    aiInteractionsUrl?: string;
+    ratingUrl?: string;
+    upRatingPopupUrl?: string;
+    downRatingPopupUrl?: string;
+    notificationCallbackUrl?: string;
+    agentCompletionsConfig?: AgentCompletionsConfig;
+};
+
+declare type ConnectorConfig_2 = {
+    chatUrl: string;
+    authorizationToken?: string | null;
+    historicChatUrl?: string | null;
+    aiInteractionsUrl?: string | null;
+    ratingUrl?: string | null;
+    upRatingPopupUrl?: string | null;
+    downRatingPopupUrl?: string | null;
+    notificationCallbackUrl?: string | null;
+    model?: string | null;
+    agentName?: string | null;
+    systemPrompt?: string | null;
+    mcps?: AgentCompletionsConfig['mcps'] | null;
+};
+
+declare type DSIconName = ComponentProps<typeof Icon>['name'];
+
+export declare type HistoricMessages = {
+    chatItems: ChatMessage[];
+    followUpPrompts: string[];
+};
+
+export declare class HttpAIServiceConnector implements IAIServiceConnector {
+    private readonly config;
+    constructor(config: ConnectorConfig);
+    get canRate(): boolean;
+    get canLoadHistory(): boolean;
+    get canListInteractions(): boolean;
+    get canSendNotification(): boolean;
+    get ratingPopupUrls(): {
+        up?: string;
+        down?: string;
+    };
+    sendMessage(params: SendMessageParams): Promise<SendMessageResult | null>;
+    loadHistory(chatId: string): Promise<HistoricMessages | null>;
+    listInteractions(): Promise<AIInteraction[] | null>;
+    rateMessage(params: RateMessageParams): Promise<void>;
+    sendNotification(params: SendNotificationParams): Promise<boolean>;
+}
+
+export declare interface IAIServiceConnector {
+    readonly canRate: boolean;
+    readonly canLoadHistory: boolean;
+    readonly canListInteractions: boolean;
+    readonly canSendNotification: boolean;
+    readonly ratingPopupUrls: {
+        up?: string;
+        down?: string;
+    };
+    sendMessage(params: SendMessageParams): Promise<SendMessageResult | null>;
+    loadHistory(chatId: string): Promise<HistoricMessages | null>;
+    listInteractions(): Promise<AIInteraction[] | null>;
+    rateMessage(params: RateMessageParams): Promise<void>;
+    sendNotification(params: SendNotificationParams): Promise<boolean>;
+}
+
+export declare type LastInputType = 'NONE' | 'KEYBOARD' | 'VOICE' | 'MIXED';
+
+declare type McpFilter = {
+    server: string;
+    tools: string[];
+};
+
+export declare type MenuContentItem = {
+    icon: string;
+    label: string;
+    url: string;
+};
+
+export declare type MenuItem = {
+    reference: string;
+    description: string;
+    link?: string;
+    icon?: string;
+};
+
+declare type MessageType = typeof CHAT_RESPONSE_TYPE_AGENT | typeof CHAT_RESPONSE_TYPE_USER | typeof CHAT_RESPONSE_TYPE_INFO | typeof CHAT_RESPONSE_TYPE_WARNING | typeof CHAT_RESPONSE_TYPE_ERROR;
+
+declare const PROMPT_LIBRARY_ICONS: readonly DSIconName[];
+
+declare type PromptGroup = {
+    tag: string;
+    prompts: string[];
+};
+
+declare type PromptLibraryCategory = {
+    id: string;
+    title: string;
+    description: string;
+    icon: PromptLibraryIconName;
+    theme: CategoryTheme;
+    promptGroups: PromptGroup[];
+};
+
+declare type PromptLibraryIconName = (typeof PROMPT_LIBRARY_ICONS)[number];
+
+export declare type RateMessageParams = {
+    messageId: string;
+    rating: 'up' | 'down';
+    chatId: string;
+};
+
+export declare type SendMessageParams = {
+    chatId?: string;
+    userMessage: string;
+    userInputDeviceLastUsed?: string;
+    chatHistory?: ChatMessage[];
+    canvasHistory?: CanvasElement[];
+};
+
+export declare type SendMessageResult = {
+    text: string;
+    id: string;
+    chatId?: string;
+    timedOut?: boolean;
+    deferred?: boolean;
+    hardStopped?: boolean;
+    type: MessageType;
+    element?: CanvasElement | CanvasElement[];
+};
+
+export declare type SendNotificationParams = {
+    chatId: string;
+};
+
+export { }