@altimateai/ui-components 0.0.29 → 0.0.31-beta.1

package/dist/types-rSkEslHb.d.ts

@@ -0,0 +1,545 @@
+import { ReactNode, Dispatch, ComponentType } from 'react';
+import { UnknownAction } from '@reduxjs/toolkit';
+import { z } from 'zod';
+
+interface AgentAction {
+    id?: string;
+    type: "info" | "analysis";
+    content: string;
+    timestamp: number;
+    artifacts?: Artifact[];
+}
+declare enum LoadingState {
+    LOADING = "LOADING",
+    LOADED = "LOADED",
+    ERROR = "ERROR",
+    UNINITIALIZED = "UNINITIALIZED"
+}
+interface AssistantMeta {
+    avatar: string;
+    name: string;
+}
+interface Feedback {
+    rating?: "up" | "down";
+    comment?: string;
+}
+interface ContextOption {
+    label: string;
+    key: string;
+    options?: {
+        id: string;
+        label: string;
+    }[];
+    customComponent?: React.ComponentType<{
+        onUpdateContext: (_context: Record<string, unknown>) => void;
+        closePopover: () => void;
+    }>;
+}
+interface ChatSession {
+    id: string;
+    messages: ChatMessage[];
+    context?: {
+        files?: File[];
+        [x: string]: unknown;
+    };
+    selectedModel?: string | null;
+    mode?: string;
+    datamates?: string[];
+}
+interface FileUploadProps {
+    allowedFiles: string;
+    contextFieldKey: string;
+}
+interface ChatbotUrls {
+    origin?: string;
+    askPath?: string;
+    proceedPath?: string;
+    frontendUrl?: string;
+    followupPath?: string;
+}
+interface Datamate {
+    id: string;
+    label: string;
+}
+interface Mode {
+    value: string;
+    label: string;
+    isComingSoon?: boolean;
+}
+interface ChatbotProps {
+    helloMessage?: React.ReactNode;
+    assistantMeta?: AssistantMeta;
+    context?: Record<string, unknown>;
+    fileUploadProps?: FileUploadProps;
+    contextOptions?: ContextOption[];
+    placeholder?: string;
+    enableDatamatesSelection?: boolean;
+    datamates?: Datamate[];
+    modes?: Mode[];
+    classNames?: {
+        chatbot?: string;
+    };
+}
+interface ChatbotProviderProps extends ChatbotProps {
+    taskLabel?: keyof typeof TaskLabels;
+    initialValidation?: ChatState["initialValidation"];
+    onError?: (error: unknown) => void;
+    urls?: ChatbotUrls;
+    disableContext?: boolean;
+    requestParams?: RequestInit;
+    components?: {
+        feedback?: ReactNode;
+        questionFormButtons?: (userPrompt: string, onAccept: (improvedPrompt: string) => void) => ReactNode;
+    };
+    contextOptions?: ContextOption[];
+    isMarkdownResponse?: boolean;
+    models?: {
+        label: string;
+        value: string;
+    }[];
+    placeholder?: string;
+    sessions?: Record<string, ChatSession>;
+    currentSessionId?: string;
+}
+type InteractionType = "text" | "select" | "multiSelect" | "confirm";
+interface InteractionChoice {
+    id: string;
+    label: string;
+    value: string;
+}
+interface InteractionRequest {
+    type: InteractionType;
+    id: string;
+    prompt: string;
+    required?: boolean;
+    choices?: InteractionChoice[];
+    validation?: {
+        pattern?: string;
+        message?: string;
+    };
+}
+interface ChatMessage {
+    id: string;
+    content: string;
+    role: "user" | "assistant";
+    timestamp: number;
+    actions?: AgentAction[];
+    interaction?: InteractionRequest;
+    artifacts?: Artifact[];
+    heading: string;
+    citations?: Citation[];
+    todos?: TodoItem[];
+}
+interface Artifact {
+    content: string;
+    entity: string;
+    name: string;
+    type: string;
+}
+interface ChatResponse {
+    content: string;
+    actions?: AgentAction[];
+    interaction?: InteractionRequest;
+    role: "assistant" | "user";
+    timestamp: number;
+    artifacts?: Artifact[];
+    heading: string;
+    todos?: TodoItem[];
+}
+interface ChatState {
+    sessions: Record<string, ChatSession>;
+    currentSessionId: string | null;
+    loadingState: LoadingState;
+    error: string | null;
+    abortController: AbortController | null;
+    currentActions: AgentAction[];
+    currentTodos: TodoItem[];
+    taskLabel?: keyof typeof TaskLabels;
+    initialValidation?: (data: {
+        context: ChatSession["context"];
+    }) => Promise<void>;
+    urls?: ChatbotUrls;
+    disableContext?: boolean;
+    requestParams?: RequestInit;
+    isMarkdownResponse?: boolean;
+    models?: {
+        label: string;
+        value: string;
+    }[];
+    components?: {
+        feedback?: ReactNode;
+        questionFormButtons?: (userPrompt: string, onAccept: (improvedPrompt: string) => void) => ReactNode;
+    };
+    enableDatamatesSelection?: boolean;
+    datamates?: Datamate[];
+    modes?: Mode[];
+    classNames?: {
+        chatbot?: string;
+    };
+}
+declare const todoItemSchema: z.ZodObject<{
+    id: z.ZodString;
+    content: z.ZodString;
+    status: z.ZodEnum<["pending", "in_progress", "completed"]>;
+    priority: z.ZodEnum<["high", "medium", "low"]>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    content: string;
+    status: "pending" | "in_progress" | "completed";
+    priority: "high" | "low" | "medium";
+}, {
+    id: string;
+    content: string;
+    status: "pending" | "in_progress" | "completed";
+    priority: "high" | "low" | "medium";
+}>;
+type TodoItem = z.infer<typeof todoItemSchema>;
+interface ToolUsageData {
+    tool: string;
+    id: string;
+}
+interface ProgressUpdate {
+    timestamp: string;
+    todos: TodoItem[];
+}
+interface FinalResponseData {
+    tool_usage?: ToolUsageData[];
+    turns?: number;
+    tools_used?: number;
+    progress_updates?: ProgressUpdate[];
+    total_progress_updates?: number;
+}
+declare const agentStreamResponseSchema: z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    type: z.ZodEnum<["info", "agent_outcome", "require_user_action", "analysis", "error", "citations", "text", "tool_use", "final_response", "complete"]>;
+    heading: z.ZodOptional<z.ZodString>;
+    content: z.ZodOptional<z.ZodString>;
+    tool: z.ZodOptional<z.ZodString>;
+    todos: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        content: z.ZodString;
+        status: z.ZodEnum<["pending", "in_progress", "completed"]>;
+        priority: z.ZodEnum<["high", "medium", "low"]>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        content: string;
+        status: "pending" | "in_progress" | "completed";
+        priority: "high" | "low" | "medium";
+    }, {
+        id: string;
+        content: string;
+        status: "pending" | "in_progress" | "completed";
+        priority: "high" | "low" | "medium";
+    }>, "many">>;
+    response: z.ZodOptional<z.ZodString>;
+    data: z.ZodOptional<z.ZodObject<{
+        tool_usage: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            tool: z.ZodString;
+            id: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            tool: string;
+        }, {
+            id: string;
+            tool: string;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        tool_usage?: {
+            id: string;
+            tool: string;
+        }[] | undefined;
+    }, {
+        tool_usage?: {
+            id: string;
+            tool: string;
+        }[] | undefined;
+    }>>;
+    interaction: z.ZodOptional<z.ZodObject<{
+        type: z.ZodEnum<["text", "multiSelect", "confirm", "select"]>;
+        id: z.ZodString;
+        prompt: z.ZodString;
+        required: z.ZodOptional<z.ZodBoolean>;
+        choices: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            label: z.ZodString;
+            value: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            value: string;
+            label: string;
+        }, {
+            id: string;
+            value: string;
+            label: string;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        type: "text" | "select" | "multiSelect" | "confirm";
+        prompt: string;
+        required?: boolean | undefined;
+        choices?: {
+            id: string;
+            value: string;
+            label: string;
+        }[] | undefined;
+    }, {
+        id: string;
+        type: "text" | "select" | "multiSelect" | "confirm";
+        prompt: string;
+        required?: boolean | undefined;
+        choices?: {
+            id: string;
+            value: string;
+            label: string;
+        }[] | undefined;
+    }>>;
+    artifacts: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        content: z.ZodString;
+        entity: z.ZodString;
+        name: z.ZodString;
+        type: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        content: string;
+        name: string;
+        type: string;
+        entity: string;
+    }, {
+        content: string;
+        name: string;
+        type: string;
+        entity: string;
+    }>, "many">>;
+    citations: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        content: z.ZodString;
+        entity: z.ZodString;
+        name: z.ZodString;
+        type: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        content: string;
+        name: string;
+        type: string;
+        entity: string;
+    }, {
+        content: string;
+        name: string;
+        type: string;
+        entity: string;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    type: "text" | "info" | "error" | "analysis" | "agent_outcome" | "require_user_action" | "citations" | "tool_use" | "final_response" | "complete";
+    id?: string | undefined;
+    content?: string | undefined;
+    heading?: string | undefined;
+    data?: {
+        tool_usage?: {
+            id: string;
+            tool: string;
+        }[] | undefined;
+    } | undefined;
+    citations?: {
+        content: string;
+        name: string;
+        type: string;
+        entity: string;
+    }[] | undefined;
+    tool?: string | undefined;
+    todos?: {
+        id: string;
+        content: string;
+        status: "pending" | "in_progress" | "completed";
+        priority: "high" | "low" | "medium";
+    }[] | undefined;
+    response?: string | undefined;
+    interaction?: {
+        id: string;
+        type: "text" | "select" | "multiSelect" | "confirm";
+        prompt: string;
+        required?: boolean | undefined;
+        choices?: {
+            id: string;
+            value: string;
+            label: string;
+        }[] | undefined;
+    } | undefined;
+    artifacts?: {
+        content: string;
+        name: string;
+        type: string;
+        entity: string;
+    }[] | undefined;
+}, {
+    type: "text" | "info" | "error" | "analysis" | "agent_outcome" | "require_user_action" | "citations" | "tool_use" | "final_response" | "complete";
+    id?: string | undefined;
+    content?: string | undefined;
+    heading?: string | undefined;
+    data?: {
+        tool_usage?: {
+            id: string;
+            tool: string;
+        }[] | undefined;
+    } | undefined;
+    citations?: {
+        content: string;
+        name: string;
+        type: string;
+        entity: string;
+    }[] | undefined;
+    tool?: string | undefined;
+    todos?: {
+        id: string;
+        content: string;
+        status: "pending" | "in_progress" | "completed";
+        priority: "high" | "low" | "medium";
+    }[] | undefined;
+    response?: string | undefined;
+    interaction?: {
+        id: string;
+        type: "text" | "select" | "multiSelect" | "confirm";
+        prompt: string;
+        required?: boolean | undefined;
+        choices?: {
+            id: string;
+            value: string;
+            label: string;
+        }[] | undefined;
+    } | undefined;
+    artifacts?: {
+        content: string;
+        name: string;
+        type: string;
+        entity: string;
+    }[] | undefined;
+}>;
+interface AgentStreamResponse {
+    id?: string;
+    type: "info" | "agent_outcome" | "require_user_action" | "analysis" | "error" | "citations" | "text" | "tool_use" | "final_response" | "complete";
+    heading?: string;
+    content?: string;
+    tool?: string;
+    todos?: TodoItem[];
+    response?: string;
+    data?: FinalResponseData;
+    interaction?: {
+        type: "text" | "multiSelect" | "confirm" | "select";
+        id: string;
+        prompt: string;
+        required?: boolean;
+        choices?: Array<{
+            id: string;
+            label: string;
+            value: string;
+        }>;
+    };
+    artifacts?: Artifact[];
+    citations?: Citation[];
+}
+
+interface TeamMateState {
+    showCoachingForm: boolean;
+}
+interface TeamMateContextProps {
+    state: TeamMateState;
+    dispatch: Dispatch<UnknownAction>;
+}
+interface CoachAiResponse {
+    ai_response: string;
+    category: string;
+    personalizationScope: string;
+}
+interface CoachAiConfirmationResponse {
+    ok: boolean;
+    train_doc_uid: string;
+    frontend_url: string;
+}
+declare enum ContentCategory {
+    TERM_CLARIFICATION = "TermClarification",
+    GENERAL_GUIDELINES = "GeneralGuidelines",
+    BUSINESS_EXPLANATION = "BusinessExplanation"
+}
+declare enum TaskLabels {
+    DocGen = "DocGen",
+    ChartBot = "ChartBot",
+    SqlBot = "SqlExpert",
+    OpportunitiesBot = "OpportunitiesBot",
+    ProjectGovernor = "ProjectGovernor",
+    TeradataToSnowflakeMigrator = "TeradataToSnowflakeMigrator",
+    AlertManager = "AlertManager"
+}
+declare enum PersonalizationScope {
+    USER_SPECIFIC = "UserSpecific",
+    ALL_USERS = "AllUsers"
+}
+declare const learningSchema: z.ZodObject<{
+    train_doc_uid: z.ZodString;
+    userId: z.ZodString;
+    display_name: z.ZodString;
+    taskLabel: z.ZodString;
+    category: z.ZodEnum<[string, ...string[]]>;
+    personalizationScope: z.ZodDefault<z.ZodEnum<[string, ...string[]]>>;
+    createdDate: z.ZodString;
+    updatedDate: z.ZodString;
+    content: z.ZodString;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    isActive: z.ZodDefault<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    content: string;
+    isActive: boolean;
+    display_name: string;
+    userId: string;
+    taskLabel: string;
+    category: string;
+    personalizationScope: string;
+    train_doc_uid: string;
+    createdDate: string;
+    updatedDate: string;
+    metadata?: Record<string, unknown> | undefined;
+}, {
+    content: string;
+    display_name: string;
+    userId: string;
+    taskLabel: string;
+    category: string;
+    train_doc_uid: string;
+    createdDate: string;
+    updatedDate: string;
+    metadata?: Record<string, unknown> | undefined;
+    isActive?: boolean | undefined;
+    personalizationScope?: string | undefined;
+}>;
+interface Learning extends z.infer<typeof learningSchema> {
+}
+declare enum TeamMateAvailability {
+    EXTENSION = "VSCode Extension",
+    SAAS = "SaaS"
+}
+interface TeamMateComponentProps<T = void> {
+    onClose?: (data?: T) => void;
+    frontendUrl?: string;
+    urls?: ChatbotUrls;
+    requestParams?: RequestInit;
+    context?: ChatSession["context"];
+    contextOptions?: ContextOption[];
+}
+interface TeamMateConfig<T = unknown> {
+    name: string;
+    avatar: string;
+    description: string;
+    availability: TeamMateAvailability[];
+    key: TaskLabels;
+    seeInAction?: boolean;
+    comingSoon?: boolean | (() => boolean);
+    displayComponent?: ComponentType<TeamMateComponentProps<T>>;
+    formComponent?: ComponentType<TeamMateComponentProps<T>>;
+}
+declare enum TeamMateActionType {
+    SEE_IN_ACTION = "SEE_IN_ACTION",
+    REQUEST_ACCESS = "REQUEST_ACCESS",
+    VIEW_DETAILS = "VIEW_DETAILS"
+}
+interface Citation {
+    id: string;
+    content: string;
+    taskLabel: TaskLabels;
+}
+
+export { type Artifact as A, todoItemSchema as B, type CoachAiResponse as C, type Datamate as D, type ToolUsageData as E, type Feedback as F, type ProgressUpdate as G, type FinalResponseData as H, type InteractionRequest as I, agentStreamResponseSchema as J, type Learning as L, type Mode as M, PersonalizationScope as P, TaskLabels as T, type TeamMateContextProps as a, type TeamMateState as b, type TeamMateConfig as c, TeamMateActionType as d, TeamMateAvailability as e, type CoachAiConfirmationResponse as f, ContentCategory as g, type TeamMateComponentProps as h, type Citation as i, type ChatbotProps as j, type ChatbotProviderProps as k, learningSchema as l, type ChatState as m, type ContextOption as n, type ChatMessage as o, type AgentAction as p, type ChatResponse as q, type AgentStreamResponse as r, type TodoItem as s, LoadingState as t, type AssistantMeta as u, type ChatSession as v, type FileUploadProps as w, type ChatbotUrls as x, type InteractionType as y, type InteractionChoice as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@altimateai/ui-components",
-  "version": "0.0.29",
+  "version": "0.0.31-beta.1",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/AltimateAI/altimate-components.git"