@altimateai/ui-components 0.0.1-beta.5 → 0.0.1-beta.8

package/dist/types-6QSONCz1.d.ts

@@ -0,0 +1,249 @@
+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 ChatSession {
+    id: string;
+    messages: ChatMessage[];
+    context?: {
+        files?: File[];
+        selectedOptions?: string[];
+        [x: string]: unknown;
+    };
+}
+interface FileUploadProps {
+    allowedFiles: string;
+    contextFieldKey: string;
+}
+interface ChatbotUrls {
+    origin?: string;
+    askPath?: string;
+    proceedPath?: string;
+    frontendUrl?: string;
+    followupPath?: string;
+}
+interface ChatbotProps {
+    helloMessage?: React.ReactNode;
+    assistantMeta?: AssistantMeta;
+    context?: Record<string, unknown>;
+    fileUploadProps?: FileUploadProps;
+}
+interface ChatbotProviderProps extends ChatbotProps {
+    taskLabel?: keyof typeof TaskLabels;
+    initialValidation?: ChatState["initialValidation"];
+    onError?: (error: unknown) => void;
+    urls?: ChatbotUrls;
+    disableContext?: boolean;
+    requestParams?: RequestInit;
+    components?: {
+        feedback?: ReactNode;
+    };
+}
+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[];
+}
+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;
+}
+interface ChatState {
+    sessions: Record<string, ChatSession>;
+    currentSessionId: string | null;
+    loadingState: LoadingState;
+    error: string | null;
+    abortController: AbortController | null;
+    currentActions: AgentAction[];
+    taskLabel?: keyof typeof TaskLabels;
+    initialValidation?: (data: {
+        context: ChatSession["context"];
+    }) => Promise<void>;
+    urls?: ChatbotUrls;
+    disableContext?: boolean;
+    requestParams?: RequestInit;
+    components?: {
+        feedback?: ReactNode;
+    };
+}
+interface AgentStreamResponse {
+    id?: string;
+    type: "info" | "agent_outcome" | "require_user_action" | "analysis" | "error" | "citations";
+    heading?: string;
+    content: string;
+    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;
+}
+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, type CoachAiResponse as C, type Feedback as F, type InteractionRequest as I, type Learning as L, 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 ChatMessage as m, type AgentAction as n, LoadingState as o, type AssistantMeta as p, type ChatSession as q, type FileUploadProps as r, type ChatbotUrls as s, type InteractionType as t, type InteractionChoice as u, type ChatResponse as v, type ChatState as w, type AgentStreamResponse as x };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@altimateai/ui-components",
-  "version": "0.0.1-beta.5",
+  "version": "0.0.1-beta.8",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/AltimateAI/altimate-components.git"
@@ -52,4 +52,4 @@
     "react": "^17.0.0 || ^18.0.0",
     "react-dom": "^17.0.0 || ^18.0.0"
   }
-}
+}

package/readme.md

@@ -1,11 +1,11 @@
-## Installation
-
-To install the package, you can use either npm or yarn:
-
-```bash
-# Using npm
-npm install @altimateai/ui-components
-
-# Using yarn
-yarn add @altimateai/ui-components
-```
+## Installation
+
+To install the package, you can use either npm or yarn:
+
+```bash
+# Using npm
+npm install @altimateai/ui-components
+
+# Using yarn
+yarn add @altimateai/ui-components
+```