@worktango/ai-assistant 0.0.70 → 0.0.71-beta03

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "@worktango/ai-assistant",
-  "version": "0.0.70",
+  "version": "0.0.71-beta03",
   "files": [
+    "constants.js",
     "dist",
     "express.d.ts",
     "express.js",
     "react.d.ts",
-    "react.js"
+    "react.js",
+    "sharedTypes.ts"
   ],
   "scripts": {
     "dev": "vite --config vite.config.ts src/dev",

package/react.d.ts

@@ -6,10 +6,15 @@ import {
   GetChatCompletionOptions,
   GetStructuredResponseOptions,
   ToolDeclaration,
+  AiAssistantSuggestedPromptsProps,
 } from "./sharedTypes";
 
 export function AiAssistant(args: AiAssistantProps): JSX.Element;
 
+export function AiAssistantSuggestedPrompts(
+  args: AiAssistantSuggestedPromptsProps
+): JSX.Element;
+
 export const tools: {
   kazooTools: {
     getRewardsAndRecognitionCurrentUserTool: ToolDeclaration;

package/sharedTypes.ts

@@ -0,0 +1,200 @@
+import type { TSchema, Type } from "@sinclair/typebox";
+
+export type AiAssistantSuggestedPromptsProps = {
+  suggestedPrompts: Record<string, AiAssistantSuggestedPrompt[]>;
+  onSelect: (prompt: AiAssistantSuggestedPrompt) => void | Promise<void>;
+  includeGlobalPrompts?: boolean;
+};
+
+export type AiAssistantSuggestedPrompt = {
+  title: string;
+  fullPrompt?: string;
+};
+
+export type SupportedTextModel = "small" | "medium" | "large";
+
+export type ChatItem = {
+  role: "user" | "model" | "tool";
+  parts: ChatData[];
+};
+
+export type ToolDeclaration<TParams extends TSchema = TSchema> = {
+  name: string;
+  description: string;
+  parameters?: any;
+  chatItemMatches?: (chatItem: {
+    role: "user" | "model" | "tool";
+    parts: ChatData[];
+  }) => boolean;
+  fulfill: (result: TParams) => Promise<string | ChatDataFile>;
+};
+
+export type ChatData =
+  | ChatDataText
+  | ChatDataToolCall
+  | ChatDataToolResult
+  | ChatDataFile;
+
+export type ChatDataText = { type: "text"; text: string };
+
+export type ChatDataFile = {
+  type: "file";
+  fileUri: string;
+  mimeType: string;
+};
+
+export type ChatDataToolCall = {
+  type: "toolCall";
+  toolName: string;
+  args: Record<string, unknown>;
+};
+
+export type ChatDataToolResult = {
+  type: "toolResult";
+  toolName: string;
+  result: any;
+};
+
+export type ChatHistoryItem = {
+  title: string;
+  messages: any[];
+  [key: string]: any;
+};
+
+export type ChatHistory = Record<string, ChatHistoryItem[]>;
+
+export type ChatSizes = "small" | "default" | "large" | "full";
+
+export type AiAssistantControls = {
+  /**
+   * Set the prompt to use for the AI assistant.
+   * @param prompt - The prompt to set.
+   * @param submit - Whether to submit the prompt to the AI assistant once the new prompt is set.
+   */
+  setPrompt?: (prompt: string, submit?: boolean) => void;
+};
+
+export type AiAssistantProps = {
+  /**
+   * The title to display in the window. Default: "WorkTango AI Assistant".
+   */
+  windowTitle?: React.ReactNode;
+  /**
+   * The full suite of tools to use for the AI assistant.
+   */
+  tools?: ToolDeclaration<any>[];
+  /**
+   * Whether to enable debug mode. Default: false.
+   */
+  enableDebug?: boolean;
+  /**
+   * The function to call when the AI assistant is closed.
+   */
+  onClose: () => void;
+  /**
+   * The function to call when the AI assistant receives a text reply from the LLM.
+   * Is invoked with the entire chat history, including the new message.
+   */
+  onLlmTextReply?: (chatHistory: ChatItem[]) => void;
+  /**
+   * Whether to show a close button in the chat window. Default: true.
+   */
+  hasCloseButton?: boolean;
+  /**
+   * The zero state to display when the chat window is empty.
+   */
+  chatWindowZeroState?: React.ReactNode;
+  /**
+   * Whether to show a button to toggle the chat size. Default: true.
+   */
+  hasToggleChatSizeButton?: boolean;
+  /**
+   * If true, the chat history (list of past conversations) will be shown, by default
+   */
+  hasChatHistory?: boolean;
+  /**
+   * The initial width of the chat window. Default: "default".
+   */
+  startingWidth?: ChatSizes;
+  /**
+   * The system instruction to use for the AI assistant.
+   */
+  systemInstruction?: () => string | Promise<string>;
+  /**
+   * The initial prompt to use for the AI assistant.
+   */
+  initialPrompt?: string;
+  /**
+   * A ref to the controls object for the AI assistant. Used to allow some form
+   * of control over the AI assistant from outside the component, allowing things
+   * like recommended prompts to be set from outside the component.
+   */
+  controls?: React.MutableRefObject<AiAssistantControls>;
+  /**
+   * Whether to show the chat history by default. Default: true.
+   */
+  chatHistoryShownByDefault?: boolean;
+  /**
+   * Otherwise, if there's a chat history, we start with the latest history, so
+   * the user can continue the previous conversation.
+   */
+  startWithNewChat?: boolean;
+  /**
+   * The minimum number of characters that must be entered before the user can
+   * submit a message. Default: 5.
+   */
+  minimumCharacterCount?: number;
+  /**
+   * FollowUpSuggestions
+   */
+  followUpSuggestions?: FollowUpSuggestion[];
+};
+
+export type FollowUpSuggestion = {
+  /**
+   * A unique identifier for the follow-up suggestion. This will be used to keep user-level state for dismissed items.
+   */
+  id: string;
+  /**
+   * The title of the follow-up suggestion. This will be displayed in the UI as a pill button, so keep it short.
+   */
+  title: string;
+  /**
+   * The function to call when the follow-up suggestion is clicked.
+   */
+  onClick: () => void;
+};
+
+export interface Conversation {
+  id: string;
+  title: string;
+  updatedAt: Date;
+  messages: {
+    conversationId: string;
+    id: string;
+    messageText: string;
+    role: string;
+  }[];
+}
+
+export type GetStructuredResponseOptions<T extends TSchema> = {
+  requestBody: {
+    model: SupportedTextModel | undefined;
+    temperature: number | undefined;
+    prompt: string;
+    schema: (t: typeof Type) => T;
+  };
+};
+
+export type GetChatCompletionOptions = {
+  requestBody: {
+    model: SupportedTextModel | undefined;
+    temperature: number | undefined;
+    stream: boolean;
+    messages: ChatItem[];
+    tools?: ToolDeclaration[] | undefined;
+  };
+  onChunk?: (chunk: ChatData) => void;
+  onError?: (error: Error) => void;
+  onComplete?: () => void;
+};