expo-ai-kit 0.1.16 → 0.1.17

package/README.md

@@ -29,7 +29,8 @@ On-device AI for Expo apps. Run language models locally—no API keys, no cloud,
 - **Native performance** — Built on Apple Foundation Models (iOS) and Google ML Kit Prompt API (Android)
 - **Multi-turn conversations** — Full conversation context support
 - **Streaming support** — Progressive token streaming for responsive UIs
-- **Simple API** — Just 3 functions: `isAvailable()`, `sendMessage()`, and `streamMessage()`
+- **Simple API** — Core functions plus prompt helpers for common tasks
+- **Prompt helpers** — Built-in `summarize()`, `translate()`, `rewrite()`, and more
 
 ## Requirements
 
@@ -172,6 +173,39 @@ const { promise, stop } = streamMessage(
 await promise;
 ```
 
+### Prompt Helpers
+
+Use built-in helpers for common AI tasks without crafting prompts:
+
+```tsx
+import { summarize, translate, rewrite, extractKeyPoints, answerQuestion } from 'expo-ai-kit';
+
+// Summarize text
+const summary = await summarize(longArticle, { length: 'short', style: 'bullets' });
+
+// Translate text
+const translated = await translate('Hello, world!', { to: 'Spanish' });
+
+// Rewrite in a different style
+const formal = await rewrite('hey whats up', { style: 'formal' });
+
+// Extract key points
+const points = await extractKeyPoints(article, { maxPoints: 5 });
+
+// Answer questions about content
+const answer = await answerQuestion('What is the main topic?', documentText);
+```
+
+All helpers also have streaming variants (`streamSummarize`, `streamTranslate`, etc.):
+
+```tsx
+const { promise, stop } = streamSummarize(
+  longArticle,
+  (event) => setSummary(event.accumulatedText),
+  { style: 'bullets' }
+);
+```
+
 ### Streaming with Cancel Button
 
 ```tsx
@@ -380,6 +414,97 @@ const response = await promise;
 
 ---
 
+### `summarize(text, options?)`
+
+Summarizes text using on-device AI.
+
+```typescript
+function summarize(text: string, options?: LLMSummarizeOptions): Promise<LLMResponse>
+```
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `text` | `string` | Text to summarize |
+| `options.length` | `'short' \| 'medium' \| 'long'` | Summary length (default: `'medium'`) |
+| `options.style` | `'paragraph' \| 'bullets' \| 'tldr'` | Output format (default: `'paragraph'`) |
+
+**Streaming:** `streamSummarize(text, onToken, options?)`
+
+---
+
+### `translate(text, options)`
+
+Translates text to another language.
+
+```typescript
+function translate(text: string, options: LLMTranslateOptions): Promise<LLMResponse>
+```
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `text` | `string` | Text to translate |
+| `options.to` | `string` | Target language (required) |
+| `options.from` | `string` | Source language (auto-detected if omitted) |
+| `options.tone` | `'formal' \| 'informal' \| 'neutral'` | Translation tone (default: `'neutral'`) |
+
+**Streaming:** `streamTranslate(text, onToken, options)`
+
+---
+
+### `rewrite(text, options)`
+
+Rewrites text in a different style.
+
+```typescript
+function rewrite(text: string, options: LLMRewriteOptions): Promise<LLMResponse>
+```
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `text` | `string` | Text to rewrite |
+| `options.style` | `string` | Target style (required) |
+
+**Available styles:** `'formal'`, `'casual'`, `'professional'`, `'friendly'`, `'concise'`, `'detailed'`, `'simple'`, `'academic'`
+
+**Streaming:** `streamRewrite(text, onToken, options)`
+
+---
+
+### `extractKeyPoints(text, options?)`
+
+Extracts key points from text as bullet points.
+
+```typescript
+function extractKeyPoints(text: string, options?: LLMExtractKeyPointsOptions): Promise<LLMResponse>
+```
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `text` | `string` | Text to analyze |
+| `options.maxPoints` | `number` | Maximum points to extract (default: `5`) |
+
+**Streaming:** `streamExtractKeyPoints(text, onToken, options?)`
+
+---
+
+### `answerQuestion(question, context, options?)`
+
+Answers a question based on provided context.
+
+```typescript
+function answerQuestion(question: string, context: string, options?: LLMAnswerQuestionOptions): Promise<LLMResponse>
+```
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `question` | `string` | Question to answer |
+| `context` | `string` | Context/document to base answer on |
+| `options.detail` | `'brief' \| 'medium' \| 'detailed'` | Answer detail level (default: `'medium'`) |
+
+**Streaming:** `streamAnswerQuestion(question, context, onToken, options?)`
+
+---
+
 ### Types
 
 ```typescript
@@ -417,6 +542,30 @@ type LLMStreamEvent = {
 };
 
 type LLMStreamCallback = (event: LLMStreamEvent) => void;
+
+// Prompt Helper Types
+type LLMSummarizeOptions = {
+  length?: 'short' | 'medium' | 'long';
+  style?: 'paragraph' | 'bullets' | 'tldr';
+};
+
+type LLMTranslateOptions = {
+  to: string;
+  from?: string;
+  tone?: 'formal' | 'informal' | 'neutral';
+};
+
+type LLMRewriteOptions = {
+  style: 'formal' | 'casual' | 'professional' | 'friendly' | 'concise' | 'detailed' | 'simple' | 'academic';
+};
+
+type LLMExtractKeyPointsOptions = {
+  maxPoints?: number;
+};
+
+type LLMAnswerQuestionOptions = {
+  detail?: 'brief' | 'medium' | 'detailed';
+};
 ```
 
 ## Feature Comparison
@@ -426,6 +575,7 @@ type LLMStreamCallback = (event: LLMStreamEvent) => void;
 | `isAvailable()` | ✅ | ✅ |
 | `sendMessage()` | ✅ | ✅ |
 | `streamMessage()` | ✅ | ✅ |
+| Prompt helpers | ✅ | ✅ |
 | System prompts | ✅ Native | ✅ Prepended |
 | Multi-turn context | ✅ | ✅ |
 | Cancel streaming | ✅ | ✅ |
@@ -476,7 +626,8 @@ const { text } = await sendMessage(messages, { systemPrompt: '...' });
 | Feature | Status | Priority |
 |---------|--------|----------|
 | ✅ Streaming responses | Done | - |
-| Prompt helpers (summarize, translate, etc.) | Planned | Medium |
+| ✅ Prompt helpers (summarize, translate, etc.) | Done | - |
+| Conversation memory (useChat hook) | Planned | High |
 | Web/generic fallback | Idea | Medium |
 | Configurable hyperparameters (temperature, etc.) | Idea | Low |
 

package/build/index.d.ts

@@ -1,4 +1,4 @@
-import { LLMMessage, LLMSendOptions, LLMResponse, LLMStreamOptions, LLMStreamCallback } from './types';
+import { LLMMessage, LLMSendOptions, LLMResponse, LLMStreamOptions, LLMStreamCallback, LLMSummarizeOptions, LLMTranslateOptions, LLMRewriteOptions, LLMExtractKeyPointsOptions, LLMAnswerQuestionOptions } from './types';
 export * from './types';
 /**
  * Check if on-device AI is available on the current device.
@@ -89,4 +89,247 @@ export declare function streamMessage(messages: LLMMessage[], onToken: LLMStream
     promise: Promise<LLMResponse>;
     stop: () => void;
 };
+/**
+ * Summarize text content using on-device AI.
+ *
+ * @param text - The text to summarize
+ * @param options - Optional settings for summary style and length
+ * @returns Promise with the generated summary
+ *
+ * @example
+ * ```ts
+ * // Basic summarization
+ * const result = await summarize(longArticle);
+ * console.log(result.text);
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Short bullet-point summary
+ * const result = await summarize(longArticle, {
+ *   length: 'short',
+ *   style: 'bullets'
+ * });
+ * ```
+ *
+ * @example
+ * ```ts
+ * // TL;DR style
+ * const result = await summarize(longArticle, {
+ *   style: 'tldr'
+ * });
+ * ```
+ */
+export declare function summarize(text: string, options?: LLMSummarizeOptions): Promise<LLMResponse>;
+/**
+ * Summarize text with streaming output.
+ *
+ * @param text - The text to summarize
+ * @param onToken - Callback for each token received
+ * @param options - Optional settings for summary style and length
+ * @returns Object with stop() function and promise
+ *
+ * @example
+ * ```ts
+ * const { promise } = streamSummarize(
+ *   longArticle,
+ *   (event) => setSummary(event.accumulatedText),
+ *   { style: 'bullets' }
+ * );
+ * await promise;
+ * ```
+ */
+export declare function streamSummarize(text: string, onToken: LLMStreamCallback, options?: LLMSummarizeOptions): {
+    promise: Promise<LLMResponse>;
+    stop: () => void;
+};
+/**
+ * Translate text to another language using on-device AI.
+ *
+ * @param text - The text to translate
+ * @param options - Translation options including target language
+ * @returns Promise with the translated text
+ *
+ * @example
+ * ```ts
+ * // Basic translation
+ * const result = await translate('Hello, world!', { to: 'Spanish' });
+ * console.log(result.text); // "¡Hola, mundo!"
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Formal translation with source language
+ * const result = await translate('Hey, what\'s up?', {
+ *   to: 'French',
+ *   from: 'English',
+ *   tone: 'formal'
+ * });
+ * ```
+ */
+export declare function translate(text: string, options: LLMTranslateOptions): Promise<LLMResponse>;
+/**
+ * Translate text with streaming output.
+ *
+ * @param text - The text to translate
+ * @param onToken - Callback for each token received
+ * @param options - Translation options including target language
+ * @returns Object with stop() function and promise
+ *
+ * @example
+ * ```ts
+ * const { promise } = streamTranslate(
+ *   'Hello, world!',
+ *   (event) => setTranslation(event.accumulatedText),
+ *   { to: 'Japanese' }
+ * );
+ * await promise;
+ * ```
+ */
+export declare function streamTranslate(text: string, onToken: LLMStreamCallback, options: LLMTranslateOptions): {
+    promise: Promise<LLMResponse>;
+    stop: () => void;
+};
+/**
+ * Rewrite text in a different style using on-device AI.
+ *
+ * @param text - The text to rewrite
+ * @param options - Rewrite options specifying the target style
+ * @returns Promise with the rewritten text
+ *
+ * @example
+ * ```ts
+ * // Make text more formal
+ * const result = await rewrite('hey can u help me out?', {
+ *   style: 'formal'
+ * });
+ * console.log(result.text); // "Would you be able to assist me?"
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Simplify complex text
+ * const result = await rewrite(technicalText, { style: 'simple' });
+ * ```
+ */
+export declare function rewrite(text: string, options: LLMRewriteOptions): Promise<LLMResponse>;
+/**
+ * Rewrite text with streaming output.
+ *
+ * @param text - The text to rewrite
+ * @param onToken - Callback for each token received
+ * @param options - Rewrite options specifying the target style
+ * @returns Object with stop() function and promise
+ *
+ * @example
+ * ```ts
+ * const { promise } = streamRewrite(
+ *   'hey whats up',
+ *   (event) => setRewritten(event.accumulatedText),
+ *   { style: 'professional' }
+ * );
+ * await promise;
+ * ```
+ */
+export declare function streamRewrite(text: string, onToken: LLMStreamCallback, options: LLMRewriteOptions): {
+    promise: Promise<LLMResponse>;
+    stop: () => void;
+};
+/**
+ * Extract key points from text using on-device AI.
+ *
+ * @param text - The text to extract key points from
+ * @param options - Optional settings for extraction
+ * @returns Promise with the key points as text
+ *
+ * @example
+ * ```ts
+ * // Extract key points from an article
+ * const result = await extractKeyPoints(article);
+ * console.log(result.text);
+ * // "• Point 1\n• Point 2\n• Point 3"
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Limit to 3 key points
+ * const result = await extractKeyPoints(article, { maxPoints: 3 });
+ * ```
+ */
+export declare function extractKeyPoints(text: string, options?: LLMExtractKeyPointsOptions): Promise<LLMResponse>;
+/**
+ * Extract key points with streaming output.
+ *
+ * @param text - The text to extract key points from
+ * @param onToken - Callback for each token received
+ * @param options - Optional settings for extraction
+ * @returns Object with stop() function and promise
+ *
+ * @example
+ * ```ts
+ * const { promise } = streamExtractKeyPoints(
+ *   article,
+ *   (event) => setKeyPoints(event.accumulatedText),
+ *   { maxPoints: 5 }
+ * );
+ * await promise;
+ * ```
+ */
+export declare function streamExtractKeyPoints(text: string, onToken: LLMStreamCallback, options?: LLMExtractKeyPointsOptions): {
+    promise: Promise<LLMResponse>;
+    stop: () => void;
+};
+/**
+ * Answer a question based on provided context using on-device AI.
+ *
+ * @param question - The question to answer
+ * @param context - The context/document to base the answer on
+ * @param options - Optional settings for the answer
+ * @returns Promise with the answer
+ *
+ * @example
+ * ```ts
+ * // Answer a question about a document
+ * const result = await answerQuestion(
+ *   'What is the main topic?',
+ *   documentText
+ * );
+ * console.log(result.text);
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Get a detailed answer
+ * const result = await answerQuestion(
+ *   'Explain the methodology',
+ *   researchPaper,
+ *   { detail: 'detailed' }
+ * );
+ * ```
+ */
+export declare function answerQuestion(question: string, context: string, options?: LLMAnswerQuestionOptions): Promise<LLMResponse>;
+/**
+ * Answer a question with streaming output.
+ *
+ * @param question - The question to answer
+ * @param context - The context/document to base the answer on
+ * @param onToken - Callback for each token received
+ * @param options - Optional settings for the answer
+ * @returns Object with stop() function and promise
+ *
+ * @example
+ * ```ts
+ * const { promise } = streamAnswerQuestion(
+ *   'What are the key findings?',
+ *   documentText,
+ *   (event) => setAnswer(event.accumulatedText),
+ *   { detail: 'detailed' }
+ * );
+ * await promise;
+ * ```
+ */
+export declare function streamAnswerQuestion(question: string, context: string, onToken: LLMStreamCallback, options?: LLMAnswerQuestionOptions): {
+    promise: Promise<LLMResponse>;
+    stop: () => void;
+};
 //# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,UAAU,EACV,cAAc,EACd,WAAW,EACX,gBAAgB,EAEhB,iBAAiB,EAClB,MAAM,SAAS,CAAC;AAEjB,cAAc,SAAS,CAAC;AAUxB;;;GAGG;AACH,wBAAsB,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC,CAKpD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,wBAAsB,WAAW,CAC/B,QAAQ,EAAE,UAAU,EAAE,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,WAAW,CAAC,CAgBtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,UAAU,EAAE,EACtB,OAAO,EAAE,iBAAiB,EAC1B,OAAO,CAAC,EAAE,gBAAgB,GACzB;IAAE,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAAC,IAAI,EAAE,MAAM,IAAI,CAAA;CAAE,CAiErD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,UAAU,EACV,cAAc,EACd,WAAW,EACX,gBAAgB,EAEhB,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,iBAAiB,EACjB,0BAA0B,EAC1B,wBAAwB,EACzB,MAAM,SAAS,CAAC;AAEjB,cAAc,SAAS,CAAC;AAkGxB;;;GAGG;AACH,wBAAsB,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC,CAKpD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,wBAAsB,WAAW,CAC/B,QAAQ,EAAE,UAAU,EAAE,EACtB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,WAAW,CAAC,CAgBtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,UAAU,EAAE,EACtB,OAAO,EAAE,iBAAiB,EAC1B,OAAO,CAAC,EAAE,gBAAgB,GACzB;IAAE,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAAC,IAAI,EAAE,MAAM,IAAI,CAAA;CAAE,CAiErD;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAsB,SAAS,CAC7B,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,WAAW,CAAC,CActB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,iBAAiB,EAC1B,OAAO,CAAC,EAAE,mBAAmB,GAC5B;IAAE,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAAC,IAAI,EAAE,MAAM,IAAI,CAAA;CAAE,CAmBrD;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAsB,SAAS,CAC7B,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,mBAAmB,GAC3B,OAAO,CAAC,WAAW,CAAC,CAatB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,iBAAiB,EAC1B,OAAO,EAAE,mBAAmB,GAC3B;IAAE,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAAC,IAAI,EAAE,MAAM,IAAI,CAAA;CAAE,CAkBrD;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAsB,OAAO,CAC3B,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,WAAW,CAAC,CAatB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,iBAAiB,EAC1B,OAAO,EAAE,iBAAiB,GACzB;IAAE,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAAC,IAAI,EAAE,MAAM,IAAI,CAAA;CAAE,CAkBrD;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,gBAAgB,CACpC,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,0BAA0B,GACnC,OAAO,CAAC,WAAW,CAAC,CAatB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,iBAAiB,EAC1B,OAAO,CAAC,EAAE,0BAA0B,GACnC;IAAE,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAAC,IAAI,EAAE,MAAM,IAAI,CAAA;CAAE,CAkBrD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,cAAc,CAClC,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,WAAW,CAAC,CAkBtB;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,iBAAiB,EAC1B,OAAO,CAAC,EAAE,wBAAwB,GACjC;IAAE,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAAC,IAAI,EAAE,MAAM,IAAI,CAAA;CAAE,CA0BrD"}