research-agent-ui 0.1.93 → 0.1.95

package/dist/lib/composer.d.ts

@@ -1,5 +1,5 @@
 /**
- * Shared logic for chat message composers.
+ * @fileoverview Shared logic for chat message composers.
  */
 /**
  * Whether a composer has enough to submit. A request is valid when the user

package/dist/lib/file-sources.d.ts

@@ -1,3 +1,10 @@
+/**
+ * @fileoverview localStorage-backed CRUD for configured file sources (local, SSH, S3, R2, B2, Google Docs, Turso).
+ *
+ * Always guarantees a default "Local Files" source is present and tracks
+ * which source is currently active; used by the file browser to let users
+ * connect and switch between multiple storage backends.
+ */
 import { AnyFileSource } from '../types/fileSource';
 export type { FileSource, AnyFileSource } from '../types/fileSource';
 export type { FileSourceType, SSHCredentials, S3Credentials, R2Credentials, B2Credentials, GoogleDocsCredentials, TursoDBCredentials, LocalFileSource, SSHFileSource, S3FileSource, R2FileSource, B2FileSource, GoogleDocsFileSource, TursoDBFileSource } from '../types/fileSource';

package/dist/lib/guest.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @fileoverview localStorage-backed CRUD for guest (unauthenticated) chat history.
+ *
+ * Mirrors the shape of server-persisted chats so guest users can create,
+ * read, update, and delete chats entirely client-side without an account.
+ */
 import { Message } from "../components/ChatConversation/ChatWindow";
 import type { ChatFile as File } from "../types/chat";
 export interface GuestChat {

package/dist/lib/relative-time.d.ts

@@ -1,5 +1,5 @@
 /**
- * Formats a timestamp as a compact relative string (e.g. "5 min", "2 hr",
+ * @fileoverview Formats a timestamp as a compact relative string (e.g. "5 min", "2 hr",
  * "3 days"). Used by the home page chat history chips to show how long ago a
  * conversation was last active, without a trailing "ago".
  */

package/dist/lib/url-autolink.d.ts

@@ -1,7 +1,6 @@
 /**
- * URL Auto-linking Utility
+ * @fileoverview URL auto-linking utility: detects plain URLs and email addresses in text and converts them to markdown links.
  *
- * Detects plain URLs (with or without protocol) and converts them to markdown links.
  * Handles patterns like:
  * - github.com/kubet/mk-blog
  * - https://github.com/kubet/mk-blog

package/dist/lib/utils.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @fileoverview Small shared utilities: Tailwind class merging and human-readable time formatting.
+ */
 import { type ClassValue } from 'clsx';
 export declare function cn(...inputs: ClassValue[]): string;
 /**

package/dist/lib/voiceAutoStart.d.ts

@@ -0,0 +1,22 @@
+/** Whether the user has opted in to auto-starting dictation. */
+export declare function isVoiceAutoStartEnabled(): boolean;
+/** Persists the user's auto-start preference. */
+export declare function setVoiceAutoStartEnabled(enabled: boolean): void;
+/** Marks auto-start as already fired in this browser. */
+export declare function markVoiceAutoStartTriggered(): void;
+export interface ShouldAutoStartVoiceOptions {
+    /** Whether the user opted in via `isVoiceAutoStartEnabled()`. */
+    enabled: boolean;
+    /** Whether the browser/environment can actually run speech input. */
+    isSpeechSupported: boolean;
+    /** Whether dictation is already listening. */
+    isListening: boolean;
+}
+/**
+ * Pure decision of whether to auto-start dictation right now. Does not read
+ * or write localStorage itself so it stays trivially testable; callers read
+ * the "already triggered" flag and call `markVoiceAutoStartTriggered()`.
+ */
+export declare function shouldAutoStartVoice({ enabled, isSpeechSupported, isListening }: ShouldAutoStartVoiceOptions, alreadyTriggered: boolean): boolean;
+/** Whether auto-start has already fired in this browser. */
+export declare function hasVoiceAutoStartTriggered(): boolean;

package/dist/{rolldown-runtime-CMqjfN_6.cjs → rolldown-runtime-BocRIvOZ.cjs}

@@ -1 +1 @@
-var e=Object.create,t=Object.defineProperty,n=Object.getOwnPropertyDescriptor,r=Object.getOwnPropertyNames,i=Object.getPrototypeOf,a=Object.prototype.hasOwnProperty,o=(e,i,o,s)=>{if(i&&typeof i==`object`||typeof i==`function`)for(var c=r(i),l=0,u=c.length,d;l<u;l++)d=c[l],!a.call(e,d)&&d!==o&&t(e,d,{get:(e=>i[e]).bind(null,d),enumerable:!(s=n(i,d))||s.enumerable});return e},s=(n,r,a)=>(a=n==null?{}:e(i(n)),o(r||!n||!n.__esModule?t(a,`default`,{value:n,enumerable:!0}):a,n));Object.defineProperty(exports,"t",{enumerable:!0,get:function(){return s}});
+var e=Object.create,t=Object.defineProperty,n=Object.getOwnPropertyDescriptor,r=Object.getOwnPropertyNames,i=Object.getPrototypeOf,a=Object.prototype.hasOwnProperty,o=(e,i,o,s)=>{if(i&&typeof i==`object`||typeof i==`function`)for(var c=r(i),l=0,u=c.length,d;l<u;l++)d=c[l],!a.call(e,d)&&d!==o&&t(e,d,{get:(e=>i[e]).bind(null,d),enumerable:!(s=n(i,d))||s.enumerable});return e},s=(n,r,s)=>(s=n==null?{}:e(i(n)),o(r||!n||!n.__esModule||!a.call(n,`default`)?t(s,`default`,{value:n,enumerable:!0}):s,n));Object.defineProperty(exports,"t",{enumerable:!0,get:function(){return s}});

package/dist/settings/index.d.ts

@@ -0,0 +1,57 @@
+/** The kind of control a setting is edited with. */
+export type SettingsFieldType = "string" | "password" | "textarea" | "select" | "switch" | "theme";
+/** Where a setting's value lives: browser `localStorage` or the server config. */
+export type SettingsFieldScope = "client" | "server";
+export interface SettingsFieldOption {
+    name: string;
+    value: string;
+}
+export interface SettingsFieldLink {
+    name: string;
+    url: string;
+}
+/**
+ * A single declarative setting. This is intentionally structurally compatible
+ * with `shadcn-settings`' field type so the schema can be passed straight to
+ * the renderer, and with the app's own `UIConfigField` union.
+ */
+export interface SettingsFieldSchema {
+    name: string;
+    key: string;
+    type: SettingsFieldType;
+    required: boolean;
+    description: string;
+    scope: SettingsFieldScope;
+    default?: string | boolean;
+    placeholder?: string;
+    env?: string;
+    options?: SettingsFieldOption[];
+    links?: SettingsFieldLink[];
+}
+/** Metadata describing one entry in the settings sidebar/menu. */
+export interface SettingsSectionSchema {
+    /** Stable id used for routing and the active-tab state. */
+    key: string;
+    /** Human-readable label shown in the menu and header. */
+    name: string;
+    /** One-line summary shown under the header. */
+    description: string;
+    /** lucide-react icon name; the app maps this to a component. */
+    icon: string;
+    /** Config namespace this section reads/writes (`config.values[dataAdd]`). */
+    dataAdd: string;
+}
+/** Ordered list of settings sections (menu items). */
+export declare const settingsSections: SettingsSectionSchema[];
+/** Field declarations for the "Search Settings" section. */
+export declare const searchSettingsFields: SettingsFieldSchema[];
+/** Every field group keyed by the section `dataAdd` it belongs to. */
+export declare const settingsFieldsBySection: Record<string, SettingsFieldSchema[]>;
+/**
+ * Return the full app settings schema. Named like a request because the app
+ * asks this module for "the setting info" rather than declaring it inline.
+ */
+export declare function getSettingsSchema(): {
+    sections: SettingsSectionSchema[];
+    fieldsBySection: Record<string, SettingsFieldSchema[]>;
+};

package/dist/stories/mocks.d.ts

@@ -1,5 +1,5 @@
 /**
- * Shared mock data for Storybook stories.
+ * @fileoverview Shared mock data for Storybook stories.
  *
  * These fixtures let the chat components render in complete isolation — no
  * API calls, auth session, or chat provider required. Everything a story

package/dist/types/fileSource.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @fileoverview Type definitions for pluggable file storage source backends and their credentials.
+ */
 export type FileSourceType = 'local' | 'ssh' | 's3' | 'r2' | 'b2' | 'gdocs' | 'turso';
 export interface SSHCredentials {
     /** SSH host name or IP address. */

package/dist/types/research.d.ts

@@ -1,5 +1,5 @@
 /**
- * Type definitions used by the ResearchAgent area of the ResearchAgent feature.
+ * @fileoverview Type definitions used by the ResearchAgent area of the ResearchAgent feature.
  */
 import { ChatFile, ChatModelProvider } from "./chat";
 export type { ChatModelProvider };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "research-agent-ui",
   "description": "Chat research agent UI: conversation window, article reader, search config, file uploads, and chat history",
-  "version": "0.1.93",
+  "version": "0.1.95",
   "author": "vtempest",
   "repository": {
     "type": "git",
@@ -31,10 +31,18 @@
     "./file-sources": {
       "types": "./src/lib/file-sources.ts",
       "import": "./src/lib/file-sources.ts"
+    },
+    "./settings": {
+      "types": "./src/settings/index.ts",
+      "import": "./src/settings/index.ts"
+    },
+    "./settings/*": {
+      "import": "./src/settings/*"
     }
   },
   "files": [
     "dist",
+    "src/settings",
     "README.md"
   ],
   "sideEffects": false,
@@ -46,7 +54,9 @@
     "type-check": "tsc --noEmit",
     "storybook": "storybook dev -p 6006",
     "build-storybook": "storybook build",
-    "prepublishOnly": "bun run build"
+    "prepublishOnly": "bun run build",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage"
   },
   "keywords": [
     "chat",
@@ -70,30 +80,34 @@
     "@radix-ui/react-tooltip": "^1.2.9",
     "@ricky0123/vad-web": "^0.0.30",
     "ai": "^5.0.0",
-    "chat-agent-toolkit": "^1.2.117",
-    "domain-rank": "^0.1.106",
-    "drizzle-orm": "^0.45.2",
-    "fuse.js": "^7.1.0",
+    "chat-agent-toolkit": "^1.2.223",
     "class-variance-authority": "^0.7.1",
     "clsx": "^2.1.1",
+    "domain-rank": "^0.1.212",
     "dompurify": "^3.4.9",
-    "extract-webpage": "^1.2.117",
-    "search-web-api": "^1.0.75",
+    "drizzle-orm": "^0.45.2",
+    "extract-webpage": "^1.2.223",
     "framer-motion": "^12.40.0",
+    "fuse.js": "^7.1.0",
     "grab-url": "^1.6.22",
-    "kokoro-js": "^1.2.1",
-    "qwksearch-api-client": "^0.9.64",
     "html2canvas": "^1.4.1",
+    "kokoro-js": "^1.2.1",
     "lucide-react": "^1.17.0",
     "markdown-to-jsx": "^9.8.2",
     "motion": "^12.40.0",
     "quantum-sphere-loading-icon": "^1.0.3",
+    "qwksearch-api-client": "^0.9.170",
     "react-icons": "^5.6.0",
+    "react-native-app-buttons": "^0.1.4",
     "react-textarea-autosize": "^8.5.9",
+    "trending-news-api": "^0.1.0",
+    "use-weather-forecast": "^0.1.40",
+    "search-web-api": "^1.0.76",
     "sonner": "^2.0.7",
     "streamdown": "^2.5.0",
     "tailwind-merge": "^3.6.0",
-    "turndown": "^7.2.4"
+    "turndown": "^7.2.4",
+    "use-voice-control": "^0.1.37"
   },
   "devDependencies": {
     "@cloudflare/workers-types": "^4.20250115.0",
@@ -102,8 +116,11 @@
     "@types/turndown": "^5.0.5",
     "@storybook/react-vite": "^9.0.0",
     "@tailwindcss/vite": "^4.3.0",
+    "@testing-library/react": "^16.1.0",
     "@vitejs/plugin-react": "^6.0.3",
+    "@vitest/coverage-v8": "^4.0.18",
     "itty-router": "^5.0.24",
+    "jsdom": "^28.1.0",
     "storybook": "^9.0.0",
     "tailwindcss": "^4.3.0",
     "next": "^16.2.10",
@@ -111,6 +128,7 @@
     "react-dom": "^19.2.7",
     "typescript": "^5.7.2",
     "vite": "^8.1.3",
+    "vitest": "^4.0.18",
     "wrangler": "^3.88.0"
   },
   "license": "rights.institute/PROSPER"

package/src/settings/index.ts

@@ -0,0 +1,96 @@
+/**
+ * @fileoverview App-specific settings schema, declared as data.
+ *
+ * These JSON files are the single source of truth for *which* settings the app
+ * exposes and how each one should be described and edited. The consuming app
+ * "requests" this information at build/runtime and hands it to a renderer (see
+ * the `shadcn-settings` package) that turns each declaration into a control.
+ *
+ * Keeping the schema here — separate from both the server config manager that
+ * reads/writes the values and the components that render them — means the list
+ * of settings can change without touching rendering or persistence code.
+ */
+import sectionsJson from "./sections.json";
+import searchJson from "./search.json";
+
+/** The kind of control a setting is edited with. */
+export type SettingsFieldType =
+  | "string"
+  | "password"
+  | "textarea"
+  | "select"
+  | "switch"
+  | "theme";
+
+/** Where a setting's value lives: browser `localStorage` or the server config. */
+export type SettingsFieldScope = "client" | "server";
+
+export interface SettingsFieldOption {
+  name: string;
+  value: string;
+}
+
+export interface SettingsFieldLink {
+  name: string;
+  url: string;
+}
+
+/**
+ * A single declarative setting. This is intentionally structurally compatible
+ * with `shadcn-settings`' field type so the schema can be passed straight to
+ * the renderer, and with the app's own `UIConfigField` union.
+ */
+export interface SettingsFieldSchema {
+  name: string;
+  key: string;
+  type: SettingsFieldType;
+  required: boolean;
+  description: string;
+  scope: SettingsFieldScope;
+  default?: string | boolean;
+  placeholder?: string;
+  env?: string;
+  options?: SettingsFieldOption[];
+  links?: SettingsFieldLink[];
+}
+
+/** Metadata describing one entry in the settings sidebar/menu. */
+export interface SettingsSectionSchema {
+  /** Stable id used for routing and the active-tab state. */
+  key: string;
+  /** Human-readable label shown in the menu and header. */
+  name: string;
+  /** One-line summary shown under the header. */
+  description: string;
+  /** lucide-react icon name; the app maps this to a component. */
+  icon: string;
+  /** Config namespace this section reads/writes (`config.values[dataAdd]`). */
+  dataAdd: string;
+}
+
+/** Ordered list of settings sections (menu items). */
+export const settingsSections: SettingsSectionSchema[] =
+  sectionsJson as unknown as SettingsSectionSchema[];
+
+/** Field declarations for the "Search Settings" section. */
+export const searchSettingsFields: SettingsFieldSchema[] =
+  searchJson as unknown as SettingsFieldSchema[];
+
+/** Every field group keyed by the section `dataAdd` it belongs to. */
+export const settingsFieldsBySection: Record<string, SettingsFieldSchema[]> = {
+  search: searchSettingsFields,
+};
+
+/**
+ * Return the full app settings schema. Named like a request because the app
+ * asks this module for "the setting info" rather than declaring it inline.
+ */
+export function getSettingsSchema(): {
+  sections: SettingsSectionSchema[];
+  fieldsBySection: Record<string, SettingsFieldSchema[]>;
+} {
+  return {
+    sections: settingsSections,
+    fieldsBySection: settingsFieldsBySection,
+  };
+}

package/src/settings/search.json

@@ -0,0 +1,161 @@
+[
+  {
+    "name": "Background Art",
+    "key": "showBackgroundArt",
+    "type": "switch",
+    "required": false,
+    "description": "Show a random artistic background on the chat homepage.",
+    "default": true,
+    "scope": "client"
+  },
+  {
+    "name": "Orb Hover Glow",
+    "key": "orbHoverGlow",
+    "type": "switch",
+    "required": false,
+    "description": "Highlight the homepage orb animation with a color glow when you hover over it.",
+    "default": false,
+    "scope": "client"
+  },
+  {
+    "name": "Cursor Glow Trail",
+    "key": "cursorGlowTrail",
+    "type": "switch",
+    "required": false,
+    "description": "Paint a colored glow trail that follows your cursor across the chat homepage background.",
+    "default": false,
+    "scope": "client"
+  },
+  {
+    "name": "Search Result Glow Effect",
+    "key": "searchResultGlow",
+    "type": "switch",
+    "required": false,
+    "description": "Add a cursor-following glow border to source cards in the search results panel.",
+    "default": false,
+    "scope": "client"
+  },
+  {
+    "name": "TTS Voice",
+    "key": "ttsSpeaker",
+    "type": "select",
+    "required": false,
+    "description": "Voice used for read-aloud text-to-speech.",
+    "default": "angus",
+    "scope": "client",
+    "options": [
+      { "name": "Angus", "value": "angus" },
+      { "name": "Asteria", "value": "asteria" },
+      { "name": "Arcas", "value": "arcas" },
+      { "name": "Orion", "value": "orion" },
+      { "name": "Orpheus", "value": "orpheus" },
+      { "name": "Athena", "value": "athena" },
+      { "name": "Luna", "value": "luna" },
+      { "name": "Zeus", "value": "zeus" },
+      { "name": "Perseus", "value": "perseus" },
+      { "name": "Helios", "value": "helios" },
+      { "name": "Hera", "value": "hera" },
+      { "name": "Stella", "value": "stella" }
+    ]
+  },
+  {
+    "name": "System Instructions",
+    "key": "systemInstructions",
+    "type": "textarea",
+    "required": false,
+    "description": "Add custom behavior or tone for the model.",
+    "placeholder": "e.g., \"Respond in a friendly and concise tone\" or \"Use British English and format answers as bullet points.\"",
+    "scope": "client"
+  },
+  {
+    "name": "Follow-up Questions",
+    "key": "maxFollowupQuestions",
+    "type": "select",
+    "options": [
+      { "name": "2 questions", "value": "2" },
+      { "name": "3 questions", "value": "3" },
+      { "name": "4 questions (default)", "value": "4" },
+      { "name": "5 questions", "value": "5" },
+      { "name": "6 questions", "value": "6" }
+    ],
+    "required": false,
+    "description": "Number of follow-up question suggestions to generate after each chat response.",
+    "default": "4",
+    "scope": "client"
+  },
+  {
+    "name": "SearXNG URL",
+    "key": "searxngURL",
+    "type": "string",
+    "required": false,
+    "description": "The URL of your SearXNG instance",
+    "placeholder": "http://localhost:4000",
+    "default": "",
+    "scope": "server",
+    "env": "SEARXNG_API_URL"
+  },
+  {
+    "name": "Proxy URL",
+    "key": "proxyURL",
+    "type": "string",
+    "required": false,
+    "description": "Optional HTTP/HTTPS/SOCKS5 proxy for outbound search and scrape requests. Format: http://user:pass@host:port or socks5://host:port",
+    "placeholder": "http://user:pass@proxy.example.com:8080",
+    "default": "",
+    "scope": "server",
+    "env": "PROXY_URL",
+    "links": [
+      { "name": "Webshare", "url": "https://www.webshare.io/?referral_code=proxy" },
+      { "name": "Bright Data", "url": "https://brightdata.com" },
+      { "name": "ProxyMesh", "url": "https://proxymesh.com" },
+      { "name": "Free Proxy List", "url": "https://free-proxy-list.net" }
+    ]
+  },
+  {
+    "name": "Tavily API Key",
+    "key": "tavilyApiKey",
+    "type": "password",
+    "required": false,
+    "description": "Optional. Enter your own Tavily API key to override the site default. Leave blank to use the site-provided key.",
+    "placeholder": "tvly-...",
+    "default": "",
+    "scope": "server",
+    "env": "TAVILY_API_KEY"
+  },
+  {
+    "name": "Scrape timeout (seconds)",
+    "key": "sourceScrapeTimeout",
+    "type": "select",
+    "options": [
+      { "name": "3 seconds", "value": "3" },
+      { "name": "5 seconds (default)", "value": "5" },
+      { "name": "10 seconds", "value": "10" },
+      { "name": "15 seconds", "value": "15" },
+      { "name": "20 seconds", "value": "20" }
+    ],
+    "required": false,
+    "description": "Maximum time to wait when scraping each source URL. Slower timeouts allow more content but increase response time.",
+    "default": "5",
+    "scope": "server"
+  },
+  {
+    "name": "Weather Locations",
+    "key": "weatherLocations",
+    "type": "textarea",
+    "required": false,
+    "description": "Show the homepage weather widget for one or more places. Enter one location per line as \"Label, latitude, longitude\" (for example: Tokyo, 35.68, 139.69). Leave blank to auto-detect your current location.",
+    "placeholder": "Tokyo, 35.68, 139.69\nNew York, 40.71, -74.01",
+    "scope": "client",
+    "default": ""
+  },
+  {
+    "name": "Trending News API URL",
+    "key": "trendingNewsApiUrl",
+    "type": "string",
+    "required": false,
+    "description": "Show the homepage trending news widget. Enter the URL of your deployed trending-news-api Cloudflare Worker. Leave blank to hide the widget.",
+    "placeholder": "https://trending-news-api.your-subdomain.workers.dev",
+    "scope": "client",
+    "default": ""
+  }
+]

package/src/settings/sections.json

@@ -0,0 +1,65 @@
+[
+  {
+    "key": "account",
+    "name": "Account",
+    "description": "Manage your profile, password, and linked accounts.",
+    "icon": "UserCircle",
+    "dataAdd": "account"
+  },
+  {
+    "key": "models",
+    "name": "Language Models",
+    "description": "Connect to AI services and manage connections.",
+    "icon": "BrainCog",
+    "dataAdd": "modelProviders"
+  },
+  {
+    "key": "mcpservers",
+    "name": "Connectors",
+    "description": "Configure Model Context Protocol servers.",
+    "icon": "Server",
+    "dataAdd": "mcpServers"
+  },
+  {
+    "key": "skills-memory",
+    "name": "Skills & Memory",
+    "description": "Manage agent skills and view your stored memories.",
+    "icon": "Brain",
+    "dataAdd": "skillsMemory"
+  },
+  {
+    "key": "searchEngines",
+    "name": "Search Sources",
+    "description": "Manage search engine sources by category.",
+    "icon": "Search",
+    "dataAdd": "searchEngines"
+  },
+  {
+    "key": "search",
+    "name": "Search Settings",
+    "description": "Configure search parameters.",
+    "icon": "Search",
+    "dataAdd": "search"
+  },
+  {
+    "key": "fileSources",
+    "name": "Cloud Storage",
+    "description": "Manage storage sources (SSH, S3, R2, B2, Google Docs, Turso DB).",
+    "icon": "HardDrive",
+    "dataAdd": "storage"
+  },
+  {
+    "key": "aiRewriteModes",
+    "name": "Rewrite Modes",
+    "description": "Customize AI rewrite prompts and add your own modes.",
+    "icon": "Wand2",
+    "dataAdd": "rewritePrompts"
+  },
+  {
+    "key": "voice",
+    "name": "Voice Settings",
+    "description": "Configure text-to-speech with Kokoro.js or Cloudflare TTS.",
+    "icon": "Volume2",
+    "dataAdd": "voice"
+  }
+]