expo-ai-kit 0.3.6 → 0.4.0

package/src/types.ts

@@ -1,6 +1,3 @@
-/**
- * Role in a conversation message.
- */
 /**
  * Hardware backend for on-device model inference.
  *
@@ -18,6 +15,9 @@ export type SetModelOptions = {
   backend?: InferenceBackend;
 };
 
+/**
+ * Role in a conversation message.
+ */
 export type LLMRole = 'system' | 'user' | 'assistant';
 
 /**
@@ -77,246 +77,6 @@ export type LLMStreamEvent = {
  */
 export type LLMStreamCallback = (event: LLMStreamEvent) => void;
 
-// ============================================================================
-// Prompt Helper Types
-// ============================================================================
-
-/**
- * Options for the summarize helper.
- */
-export type LLMSummarizeOptions = {
-  /**
-   * Target length for the summary.
-   * @default 'medium'
-   */
-  length?: 'short' | 'medium' | 'long';
-  /**
-   * Style of summary to generate.
-   * @default 'paragraph'
-   */
-  style?: 'paragraph' | 'bullets' | 'tldr';
-};
-
-/**
- * Options for the translate helper.
- */
-export type LLMTranslateOptions = {
-  /**
-   * Target language to translate to.
-   */
-  to: string;
-  /**
-   * Source language (auto-detected if not provided).
-   */
-  from?: string;
-  /**
-   * Tone/formality of the translation.
-   * @default 'neutral'
-   */
-  tone?: 'formal' | 'informal' | 'neutral';
-};
-
-/**
- * Options for the rewrite helper.
- */
-export type LLMRewriteOptions = {
-  /**
-   * Style to rewrite in.
-   */
-  style:
-    | 'formal'
-    | 'casual'
-    | 'professional'
-    | 'friendly'
-    | 'concise'
-    | 'detailed'
-    | 'simple'
-    | 'academic';
-};
-
-/**
- * Options for the extractKeyPoints helper.
- */
-export type LLMExtractKeyPointsOptions = {
-  /**
-   * Maximum number of key points to extract.
-   * @default 5
-   */
-  maxPoints?: number;
-};
-
-/**
- * Options for the answerQuestion helper.
- */
-export type LLMAnswerQuestionOptions = {
-  /**
-   * How detailed the answer should be.
-   * @default 'medium'
-   */
-  detail?: 'brief' | 'medium' | 'detailed';
-};
-
-// ============================================================================
-// Smart Suggestions Types
-// ============================================================================
-
-/**
- * Options for the suggest helper.
- */
-export type LLMSuggestOptions = {
-  /**
-   * Number of suggestions to generate.
-   * @default 3
-   */
-  count?: number;
-  /**
-   * Optional context to inform the suggestions (e.g., surrounding text, app context).
-   */
-  context?: string;
-  /**
-   * Tone of the suggestions.
-   * @default 'neutral'
-   */
-  tone?: 'formal' | 'casual' | 'professional' | 'friendly' | 'neutral';
-};
-
-/**
- * A single suggestion item.
- */
-export type LLMSuggestion = {
-  /** The suggested text */
-  text: string;
-};
-
-/**
- * Response from suggest/smartReply containing multiple suggestions.
- */
-export type LLMSuggestResponse = {
-  /** Array of generated suggestions */
-  suggestions: LLMSuggestion[];
-  /** Raw response text from the model */
-  raw: string;
-};
-
-/**
- * Options for the smartReply helper.
- */
-export type LLMSmartReplyOptions = {
-  /**
-   * Number of reply suggestions to generate.
-   * @default 3
-   */
-  count?: number;
-  /**
-   * Tone of the reply suggestions.
-   * @default 'neutral'
-   */
-  tone?: 'formal' | 'casual' | 'professional' | 'friendly' | 'neutral';
-  /**
-   * Optional persona/context for the replier (e.g., "customer support agent", "friendly colleague").
-   */
-  persona?: string;
-};
-
-/**
- * Options for the autocomplete helper.
- */
-export type LLMAutocompleteOptions = {
-  /**
-   * Number of completions to generate.
-   * @default 3
-   */
-  count?: number;
-  /**
-   * Maximum length of each completion in words.
-   * @default 10
-   */
-  maxWords?: number;
-  /**
-   * Optional context to inform the completions (e.g., what the user is writing about).
-   */
-  context?: string;
-};
-
-// ============================================================================
-// Hook Types
-// ============================================================================
-
-/**
- * Options for the useChat hook.
- */
-export type UseChatOptions = {
-  /** System prompt for the AI assistant */
-  systemPrompt?: string;
-  /** Maximum conversation turns to keep in memory (default: 10) */
-  maxTurns?: number;
-  /** Initial messages to populate the chat */
-  initialMessages?: LLMMessage[];
-  /** Callback when a response is complete */
-  onFinish?: (response: LLMResponse) => void;
-  /** Callback when an error occurs */
-  onError?: (error: Error) => void;
-};
-
-/**
- * Return type for the useChat hook.
- */
-export type UseChatReturn = {
-  /** All messages in the conversation */
-  messages: LLMMessage[];
-  /** Current input text value */
-  input: string;
-  /** Set the input text value */
-  setInput: (input: string) => void;
-  /** Send the current input (or provided text) as a message */
-  sendMessage: (text?: string) => Promise<void>;
-  /** Whether the AI is currently streaming a response */
-  isStreaming: boolean;
-  /** Stop the current streaming response */
-  stop: () => void;
-  /** Clear all messages and reset the conversation */
-  clear: () => void;
-  /** The most recent error, if any */
-  error: Error | null;
-};
-
-/**
- * Options for the useCompletion hook.
- */
-export type UseCompletionOptions = {
-  /** System prompt for the AI */
-  systemPrompt?: string;
-  /** Callback when completion is done */
-  onFinish?: (response: LLMResponse) => void;
-  /** Callback when an error occurs */
-  onError?: (error: Error) => void;
-};
-
-/**
- * Return type for the useCompletion hook.
- */
-export type UseCompletionReturn = {
-  /** The current completion text */
-  completion: string;
-  /** Whether a completion is in progress */
-  isLoading: boolean;
-  /** Request a completion for the given prompt */
-  complete: (prompt: string) => Promise<string>;
-  /** Stop the current completion */
-  stop: () => void;
-  /** The most recent error, if any */
-  error: Error | null;
-};
-
-/**
- * Return type for the useOnDeviceAI hook.
- */
-export type UseOnDeviceAIReturn = {
-  /** Whether on-device AI is available */
-  isAvailable: boolean;
-  /** Whether the availability check is still in progress */
-  isChecking: boolean;
-};
 
 // ============================================================================
 // Model Types
@@ -424,44 +184,3 @@ export type ModelStateChangeEvent = {
   /** New status */
   status: DownloadableModelStatus;
 };
-
-// ============================================================================
-// Chat Memory Types
-// ============================================================================
-
-/**
- * Options for creating a ChatMemoryManager.
- */
-export type ChatMemoryOptions = {
-  /**
-   * Maximum number of conversation turns to keep in memory.
-   * A turn is one user message + one assistant response.
-   * @default 10
-   */
-  maxTurns?: number;
-  /**
-   * Optional system prompt to prepend to every generated prompt.
-   */
-  systemPrompt?: string;
-  /**
-   * Maximum context window in tokens. When set, trimHistory will also
-   * trim messages that exceed this token budget (in addition to maxTurns).
-   * Whichever limit is hit first triggers trimming.
-   * @default Infinity (no token-based trimming)
-   */
-  contextWindow?: number;
-};
-
-/**
- * A snapshot of the current chat memory state.
- */
-export type ChatMemorySnapshot = {
-  /** All messages currently in memory */
-  messages: LLMMessage[];
-  /** The system prompt (if any) */
-  systemPrompt: string | undefined;
-  /** Current number of turns stored */
-  turnCount: number;
-  /** Maximum turns allowed */
-  maxTurns: number;
-};

package/build/hooks.d.ts

@@ -1,147 +0,0 @@
-import type { UseChatOptions, UseChatReturn, UseCompletionOptions, UseCompletionReturn, UseOnDeviceAIReturn, BuiltInModel, DownloadableModel, DownloadableModelStatus, ModelError } from './types';
-/**
- * React hook to check if on-device AI is available.
- *
- * Caches the result so multiple components don't re-check.
- *
- * @returns Object with isAvailable and isChecking states
- *
- * @example
- * ```tsx
- * function MyComponent() {
- *   const { isAvailable, isChecking } = useOnDeviceAI();
- *
- *   if (isChecking) return <Text>Checking AI availability...</Text>;
- *   if (!isAvailable) return <Text>On-device AI not available</Text>;
- *
- *   return <ChatComponent />;
- * }
- * ```
- */
-export declare function useOnDeviceAI(): UseOnDeviceAIReturn;
-/**
- * React hook for building chat interfaces with on-device AI.
- *
- * Manages messages, input state, streaming, and conversation memory automatically.
- * Built on top of ChatMemoryManager and streamMessage.
- *
- * @param options - Configuration options for the chat
- * @returns Chat state and control functions
- *
- * @example
- * ```tsx
- * function ChatScreen() {
- *   const { messages, input, setInput, sendMessage, isStreaming, stop } = useChat({
- *     systemPrompt: 'You are a helpful assistant.',
- *   });
- *
- *   return (
- *     <View>
- *       <FlatList
- *         data={messages}
- *         renderItem={({ item }) => (
- *           <Text>{item.role}: {item.content}</Text>
- *         )}
- *       />
- *       <TextInput value={input} onChangeText={setInput} />
- *       {isStreaming ? (
- *         <Button title="Stop" onPress={stop} />
- *       ) : (
- *         <Button title="Send" onPress={() => sendMessage()} />
- *       )}
- *     </View>
- *   );
- * }
- * ```
- */
-export declare function useChat(options?: UseChatOptions): UseChatReturn;
-/**
- * React hook for single-shot AI completions.
- *
- * Unlike useChat (which manages a conversation), useCompletion is for
- * one-off tasks like summarization, translation, or content generation.
- *
- * @param options - Configuration options
- * @returns Completion state and control functions
- *
- * @example
- * ```tsx
- * function SummarizerScreen() {
- *   const { completion, isLoading, complete, stop } = useCompletion({
- *     systemPrompt: 'You are a summarization assistant. Summarize the given text concisely.',
- *   });
- *
- *   return (
- *     <View>
- *       <Button
- *         title="Summarize"
- *         onPress={() => complete('Long article text here...')}
- *       />
- *       {isLoading && <Button title="Stop" onPress={stop} />}
- *       <Text>{completion}</Text>
- *     </View>
- *   );
- * }
- * ```
- */
-export declare function useCompletion(options?: UseCompletionOptions): UseCompletionReturn;
-/**
- * React hook for managing a downloadable model's lifecycle.
- *
- * Tracks download status, progress, and provides download/delete controls.
- *
- * @param modelId - The downloadable model ID (e.g. 'gemma-e2b')
- * @returns Model status, progress, and control functions
- *
- * @example
- * ```tsx
- * function ModelManager() {
- *   const { status, progress, download, delete: remove, error } = useModel('gemma-e2b');
- *
- *   if (status === 'not-downloaded') {
- *     return <Button title="Download" onPress={download} />;
- *   }
- *   if (status === 'downloading') {
- *     return <Text>Downloading: {Math.round(progress * 100)}%</Text>;
- *   }
- *   if (status === 'loading') {
- *     return <Text>Loading model...</Text>;
- *   }
- *   return <Text>Model ready!</Text>;
- * }
- * ```
- */
-export declare function useModel(modelId: string): {
-    status: DownloadableModelStatus;
-    progress: number;
-    download: () => Promise<void>;
-    delete: () => Promise<void>;
-    error: ModelError | null;
-};
-/**
- * React hook to discover all available models (built-in and downloadable).
- *
- * @returns Built-in models, downloadable models, and loading state
- *
- * @example
- * ```tsx
- * function ModelPicker() {
- *   const { builtIn, downloadable, isLoading } = useAvailableModels();
- *
- *   if (isLoading) return <Text>Loading models...</Text>;
- *
- *   return (
- *     <View>
- *       <Text>Built-in: {builtIn.map(m => m.name).join(', ')}</Text>
- *       <Text>Downloadable: {downloadable.map(m => m.name).join(', ')}</Text>
- *     </View>
- *   );
- * }
- * ```
- */
-export declare function useAvailableModels(): {
-    builtIn: BuiltInModel[];
-    downloadable: DownloadableModel[];
-    isLoading: boolean;
-};
-//# sourceMappingURL=hooks.d.ts.map

package/build/hooks.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../src/hooks.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAEV,cAAc,EACd,aAAa,EACb,oBAAoB,EACpB,mBAAmB,EACnB,mBAAmB,EACnB,YAAY,EACZ,iBAAiB,EACjB,uBAAuB,EACvB,UAAU,EACX,MAAM,SAAS,CAAC;AAmBjB;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,aAAa,IAAI,mBAAmB,CAwBnD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,wBAAgB,OAAO,CAAC,OAAO,GAAE,cAAmB,GAAG,aAAa,CA8GnE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,aAAa,CAAC,OAAO,GAAE,oBAAyB,GAAG,mBAAmB,CAgFrF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG;IACzC,MAAM,EAAE,uBAAuB,CAAC;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,KAAK,EAAE,UAAU,GAAG,IAAI,CAAC;CAC1B,CA0EA;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,kBAAkB,IAAI;IACpC,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,YAAY,EAAE,iBAAiB,EAAE,CAAC;IAClC,SAAS,EAAE,OAAO,CAAC;CACpB,CAwBA"}