Skip to content

armgit / mimik

Public Imported from GitHub
0

🎬 A browser extension and desktop app that turns your clicks into step-by-step guides with annotated screenshots πŸ“–

fix(ai): keep an api key per provider instead of one for all of them

Luis Ortizb7dafe237f35
diff --git a/src/core/capture/ai/__tests__/keys.test.ts b/src/core/capture/ai/__tests__/keys.test.ts
new file mode 100644
index 0000000..7decfac
--- /dev/null
+++ b/src/core/capture/ai/__tests__/keys.test.ts
@@ -0,0 +1,77 @@
+import { describe, expect, it } from 'vitest';
+import { keyFor, migrateApiKeys, parseApiKeys, resolveAiKey, withKeyFor } from '../keys';
+
+describe('parseApiKeys', () => {
+ it('keeps only keys for providers that exist', () => {
+ expect(parseApiKeys({ openai: 'sk-a', openaiCompatible: 'sk-gone', anthropic: 'ak-b' })).toEqual({
+ openai: 'sk-a',
+ anthropic: 'ak-b',
+ });
+ });
+
+ it('drops blank keys and non-strings', () => {
+ expect(parseApiKeys({ openai: ' ', anthropic: 42, deepseek: 'sk-c' })).toEqual({ deepseek: 'sk-c' });
+ });
+
+ it('reads anything that is not an object as no keys', () => {
+ expect(parseApiKeys(null)).toEqual({});
+ expect(parseApiKeys('sk-loose')).toEqual({});
+ expect(parseApiKeys(undefined)).toEqual({});
+ });
+});
+
+describe('migrateApiKeys', () => {
+ it('attaches a pre-existing single key to the provider that was selected', () => {
+ expect(migrateApiKeys({ aiApiKey: 'sk-legacy', aiProvider: 'anthropic' })).toEqual({ anthropic: 'sk-legacy' });
+ });
+
+ it('attaches a legacy key to openai when the stored provider is gone', () => {
+ expect(migrateApiKeys({ aiApiKey: 'sk-legacy', aiProvider: 'openaiCompatible' })).toEqual({ openai: 'sk-legacy' });
+ });
+
+ it('prefers the per-provider map once it exists', () => {
+ expect(migrateApiKeys({ aiApiKeys: { openai: 'sk-new' }, aiApiKey: 'sk-legacy', aiProvider: 'anthropic' })).toEqual(
+ { openai: 'sk-new' },
+ );
+ });
+
+ it('returns nothing when no key was ever saved', () => {
+ expect(migrateApiKeys({})).toEqual({});
+ expect(migrateApiKeys({ aiApiKey: ' ' })).toEqual({});
+ });
+});
+
+describe('keyFor and withKeyFor', () => {
+ it('reads a provider with no key as empty rather than undefined', () => {
+ expect(keyFor({ openai: 'sk-a' }, 'anthropic')).toBe('');
+ });
+
+ it('stores a key against one provider without touching the others', () => {
+ const next = withKeyFor({ openai: 'sk-a' }, 'anthropic', 'ak-b');
+ expect(next).toEqual({ openai: 'sk-a', anthropic: 'ak-b' });
+ });
+
+ it('clearing one provider leaves the others intact', () => {
+ expect(withKeyFor({ openai: 'sk-a', anthropic: 'ak-b' }, 'anthropic', '')).toEqual({ openai: 'sk-a' });
+ expect(withKeyFor({ openai: 'sk-a', anthropic: 'ak-b' }, 'anthropic', ' ')).toEqual({ openai: 'sk-a' });
+ });
+});
+
+describe('resolveAiKey', () => {
+ it('hands back the key belonging to the selected provider, never another', () => {
+ const stored = { aiApiKeys: { openai: 'sk-openai', anthropic: 'ak-anthropic' }, aiProvider: 'anthropic' };
+ expect(resolveAiKey(stored)).toEqual({ provider: 'anthropic', apiKey: 'ak-anthropic' });
+ });
+
+ it('reports no key rather than a neighbour key when the selected provider has none', () => {
+ const stored = { aiApiKeys: { openai: 'sk-openai' }, aiProvider: 'openrouter' };
+ expect(resolveAiKey(stored)).toEqual({ provider: 'openrouter', apiKey: '' });
+ });
+
+ it('falls back to openai for an unknown stored provider', () => {
+ expect(resolveAiKey({ aiApiKeys: { openai: 'sk-a' }, aiProvider: 'nope' })).toEqual({
+ provider: 'openai',
+ apiKey: 'sk-a',
+ });
+ });
+});
diff --git a/src/core/capture/ai/keys.ts b/src/core/capture/ai/keys.ts
new file mode 100644
index 0000000..3f2d288
--- /dev/null
+++ b/src/core/capture/ai/keys.ts
@@ -0,0 +1,44 @@
+import { type AIProviderKey, isProviderKey, providerOrDefault } from './models';
+
+export type AIApiKeys = Partial<Record<AIProviderKey, string>>;
+
+export function parseApiKeys(value: unknown): AIApiKeys {
+ if (typeof value !== 'object' || value === null) return {};
+ const keys: AIApiKeys = {};
+ for (const [provider, key] of Object.entries(value as Record<string, unknown>)) {
+ if (!isProviderKey(provider)) continue;
+ const trimmed = typeof key === 'string' ? key.trim() : '';
+ if (trimmed) keys[provider] = trimmed;
+ }
+ return keys;
+}
+
+export function migrateApiKeys(stored: { aiApiKeys?: unknown; aiApiKey?: unknown; aiProvider?: unknown }): AIApiKeys {
+ const keys = parseApiKeys(stored.aiApiKeys);
+ if (Object.keys(keys).length > 0) return keys;
+
+ const legacy = typeof stored.aiApiKey === 'string' ? stored.aiApiKey.trim() : '';
+ return legacy ? { [providerOrDefault(stored.aiProvider)]: legacy } : {};
+}
+
+export function keyFor(keys: AIApiKeys, provider: AIProviderKey): string {
+ return keys[provider] ?? '';
+}
+
+export function withKeyFor(keys: AIApiKeys, provider: AIProviderKey, apiKey: string): AIApiKeys {
+ const next = { ...keys };
+ const trimmed = apiKey.trim();
+ if (trimmed) next[provider] = apiKey;
+ else delete next[provider];
+ return next;
+}
+
+export const AI_KEY_SETTINGS = ['aiApiKeys', 'aiApiKey', 'aiProvider'] as const;
+
+export function resolveAiKey(stored: { aiApiKeys?: unknown; aiApiKey?: unknown; aiProvider?: unknown }): {
+ provider: AIProviderKey;
+ apiKey: string;
+} {
+ const provider = providerOrDefault(stored.aiProvider);
+ return { provider, apiKey: keyFor(migrateApiKeys(stored), provider) };
+}
diff --git a/src/core/capture/ai/rewrite.ts b/src/core/capture/ai/rewrite.ts
index 160ecc8..fadfbd2 100644
--- a/src/core/capture/ai/rewrite.ts
+++ b/src/core/capture/ai/rewrite.ts
@@ -2,7 +2,8 @@ import { generateText } from 'ai';
import { localStorage } from '@/lib/browser-api';
import { logger } from '@/lib/logger';
import type { RewriteSelectionResponse } from '@/lib/messaging';
-import { AI_PROVIDERS, providerOrDefault } from './models';
+import { resolveAiKey } from './keys';
+import { AI_PROVIDERS } from './models';
import { getLanguageSuffix, REWRITE_PROMPT } from './prompts';
import { createModel } from './provider';
@@ -22,17 +23,23 @@ export function buildRewritePrompt(text: string, instruction: string, locale: st
}
export async function rewriteSelection(text: string, instruction: string): Promise<RewriteSelectionResponse> {
- const settings = await localStorage.get(['aiApiKey', 'aiProvider', 'aiModel', 'aiBaseUrl', 'aiLanguage']);
- if (!settings.aiApiKey) return { error: 'no-api-key' };
-
- const provider = providerOrDefault(settings.aiProvider);
+ const settings = await localStorage.get([
+ 'aiApiKeys',
+ 'aiApiKey',
+ 'aiProvider',
+ 'aiModel',
+ 'aiBaseUrl',
+ 'aiLanguage',
+ ]);
+ const { provider, apiKey } = resolveAiKey(settings);
+ if (!apiKey) return { error: 'no-api-key' };
try {
const { text: raw } = await generateText({
model: createModel(
provider,
(settings.aiModel as string) || AI_PROVIDERS[provider].defaultModel,
- settings.aiApiKey as string,
+ apiKey,
settings.aiBaseUrl as string | undefined,
),
prompt: buildRewritePrompt(text, instruction, (settings.aiLanguage as string) || 'en'),
diff --git a/src/core/capture/voice/__tests__/api-key.test.ts b/src/core/capture/voice/__tests__/api-key.test.ts
index 7b015a0..77dac6d 100644
--- a/src/core/capture/voice/__tests__/api-key.test.ts
+++ b/src/core/capture/voice/__tests__/api-key.test.ts
@@ -122,6 +122,6 @@ describe('normalizeVoiceProvider', () => {
describe('VOICE_KEY_SETTINGS', () => {
it('names every storage key the resolution reads', () => {
- expect([...VOICE_KEY_SETTINGS]).toEqual(['voiceProvider', 'voiceApiKey', 'aiProvider', 'aiApiKey']);
+ expect([...VOICE_KEY_SETTINGS]).toEqual(['voiceProvider', 'voiceApiKey', 'aiProvider', 'aiApiKey', 'aiApiKeys']);
});
});
diff --git a/src/core/capture/voice/api-key.ts b/src/core/capture/voice/api-key.ts
index bc90c90..90d8803 100644
--- a/src/core/capture/voice/api-key.ts
+++ b/src/core/capture/voice/api-key.ts
@@ -1,12 +1,14 @@
+import { resolveAiKey } from '@/core/capture/ai/keys';
import type { VoiceProvider } from './transcribe';
-export const VOICE_KEY_SETTINGS = ['voiceProvider', 'voiceApiKey', 'aiProvider', 'aiApiKey'] as const;
+export const VOICE_KEY_SETTINGS = ['voiceProvider', 'voiceApiKey', 'aiProvider', 'aiApiKey', 'aiApiKeys'] as const;
export interface VoiceKeySettings {
voiceProvider?: unknown;
voiceApiKey?: unknown;
aiProvider?: unknown;
aiApiKey?: unknown;
+ aiApiKeys?: unknown;
}
export type VoiceApiKeySource = 'voice' | 'ai' | 'none';
@@ -30,8 +32,9 @@ export function resolveVoiceApiKey(settings: VoiceKeySettings): ResolvedVoiceApi
const own = trimmed(settings.voiceApiKey);
if (own) return { provider, apiKey: own, source: 'voice' };
- const shared = trimmed(settings.aiApiKey);
- const aiProvider = trimmed(settings.aiProvider) || 'openai';
+ const resolved = resolveAiKey(settings);
+ const shared = resolved.apiKey;
+ const aiProvider = resolved.provider;
if (provider !== 'openai' || aiProvider !== 'openai' || !shared) {
return { provider, apiKey: '', source: 'none' };
}
diff --git a/src/core/guides/types.ts b/src/core/guides/types.ts
index a95f87d..a903889 100644
--- a/src/core/guides/types.ts
+++ b/src/core/guides/types.ts
@@ -1,3 +1,4 @@
+import type { AIApiKeys } from '@/core/capture/ai/keys';
import type { AIProviderKey } from '@/core/capture/ai/models';
import type { VoiceProvider } from '@/core/capture/voice/transcribe';
import type { ScreenshotEdits } from '@/core/screenshot/types';
@@ -14,7 +15,7 @@ export interface Guide {
staging?: boolean;
}
-export type DescriptionSource = 'narration' | 'ai' | 'heuristic';
+export type DescriptionSource = 'narration' | 'ai' | 'heuristic' | 'manual';
export type BlockType = 'heading' | 'callout';
@@ -60,6 +61,7 @@ export interface Screenshot {
export interface Settings {
aiApiKey: string;
+ aiApiKeys?: AIApiKeys;
aiProvider: AIProviderKey;
aiModel: string;
aiBaseUrl?: string;
diff --git a/src/entrypoints/background/guide-meta.ts b/src/entrypoints/background/guide-meta.ts
index decf3ff..f86dd34 100644
--- a/src/entrypoints/background/guide-meta.ts
+++ b/src/entrypoints/background/guide-meta.ts
@@ -1,6 +1,7 @@
import { i18n } from '#imports';
+import { resolveAiKey } from '@/core/capture/ai/keys';
import { generateGuideMeta } from '@/core/capture/ai/meta';
-import { AI_PROVIDERS, providerOrDefault } from '@/core/capture/ai/models';
+import { AI_PROVIDERS } from '@/core/capture/ai/models';
import { actionSteps } from '@/core/guides/blocks';
import {
clearStepAiPending,
@@ -29,20 +30,20 @@ type GuideMetaInputs =
| { ok: false; reason: ResolveFailure };
async function resolveGuideMetaInputs(guideId: string): Promise<GuideMetaInputs> {
- const settings = await localStorage.get(['aiApiKey', 'aiProvider', 'aiModel', 'aiBaseUrl']);
- if (!settings.aiApiKey) return { ok: false, reason: 'no-api-key' };
+ const settings = await localStorage.get(['aiApiKeys', 'aiApiKey', 'aiProvider', 'aiModel', 'aiBaseUrl']);
+ const { provider, apiKey } = resolveAiKey(settings);
+ if (!apiKey) return { ok: false, reason: 'no-api-key' };
const steps = actionSteps(await getStepsForGuide(guideId));
const described = steps.filter((s) => s.description).map((s) => ({ description: s.description, url: s.url }));
if (described.length === 0) return { ok: false, reason: 'no-steps' };
- const provider = providerOrDefault(settings.aiProvider);
return {
ok: true,
steps: described.length > 15 ? [...described.slice(0, 10), ...described.slice(-5)] : described,
provider,
model: (settings.aiModel as string) || AI_PROVIDERS[provider].defaultModel,
- apiKey: settings.aiApiKey as string,
+ apiKey,
baseUrl: settings.aiBaseUrl as string | undefined,
};
}
diff --git a/src/entrypoints/background/step-pipeline.ts b/src/entrypoints/background/step-pipeline.ts
index d89aaad..c1b109f 100644
--- a/src/entrypoints/background/step-pipeline.ts
+++ b/src/entrypoints/background/step-pipeline.ts
@@ -1,3 +1,4 @@
+import { AI_KEY_SETTINGS, resolveAiKey } from '@/core/capture/ai/keys';
import type { DOMContext } from '@/core/capture/dom/context';
import { CaptureState } from '@/core/capture/machine';
import { buildFallbackDescription } from '@/core/capture/step-description';
@@ -57,7 +58,7 @@ async function takeScreenshot(stepId: string, meta: ElementMeta): Promise<string
}
async function tryAIDescription(stepId: string, domContext: DOMContext) {
- if (!(await localStorage.get(['aiApiKey'])).aiApiKey) return;
+ if (!resolveAiKey(await localStorage.get([...AI_KEY_SETTINGS])).apiKey) return;
try {
await clearStepAiPending(stepId, await generateAiDescription(domContext));
} catch (err) {
@@ -79,7 +80,7 @@ export async function handleCaptureStep(data: CaptureStepData): Promise<CaptureS
const screenshotId = await takeScreenshot(stepId, data.elementMeta);
const narrationCapturing = getVoiceUpdate().phase === 'recording';
- const hasAiKey = !!(await localStorage.get(['aiApiKey'])).aiApiKey;
+ const hasAiKey = !!resolveAiKey(await localStorage.get([...AI_KEY_SETTINGS])).apiKey;
const willUseAI = shouldQueueAiDescription({
action: data.action,
hasDomContext: !!data.domContext,
@@ -98,6 +99,7 @@ export async function handleCaptureStep(data: CaptureStepData): Promise<CaptureS
timestamp,
screenshotId,
elementMeta: data.elementMeta,
+ descriptionSource: 'heuristic',
aiPending: willUseAI || narrationCapturing,
});
await addStepToGuide(guideId, stepId);
diff --git a/src/ui/onboarding/App.tsx b/src/ui/onboarding/App.tsx
index d6bb214..49e9124 100644
--- a/src/ui/onboarding/App.tsx
+++ b/src/ui/onboarding/App.tsx
@@ -2,6 +2,7 @@ import { Globe, Mic, MousePointerClick, Shield } from 'lucide-react';
import { useEffect, useState } from 'react';
import { browser, i18n } from '#imports';
import { PRESET_LABELS, type PresetKey } from '@/core/blur/regexes';
+import { type AIApiKeys, keyFor, migrateApiKeys, withKeyFor } from '@/core/capture/ai/keys';
import {
AI_PROVIDERS,
type AIProviderKey,
@@ -16,7 +17,7 @@ import type { VoiceProvider } from '@/core/capture/voice/transcribe';
import { localStorage, openSidebar, requestHostPermissions } from '@/lib/browser-api';
import { Input } from '@/ui/components/ui/input';
import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from '@/ui/components/ui/select';
-import { KeyStatusNote, ModelList, SecretInput, useKeyCheck } from '@/ui/shared/key-check';
+import { KeyStatusNote, KeyWarningNote, ModelList, SecretInput, useKeyCheck } from '@/ui/shared/key-check';
import MicrophonePicker from '@/ui/shared/MicrophonePicker';
interface StepProps {
@@ -127,6 +128,7 @@ function AISetupStep({ onNext, onSkip, onBack, index, total }: StepProps) {
const [provider, setProvider] = useState<AIProviderKey>('openai');
const [model, setModel] = useState(AI_PROVIDERS.openai.defaultModel);
const [apiKey, setApiKey] = useState('');
+ const [apiKeys, setApiKeys] = useState<AIApiKeys>({});
const [baseUrl, setBaseUrl] = useState('');
const [aiLanguage, setAiLanguage] = useState<AILanguageCode>('en');
const [ownServer, setOwnServer] = useState(false);
@@ -135,11 +137,13 @@ function AISetupStep({ onNext, onSkip, onBack, index, total }: StepProps) {
useEffect(() => {
const load = () =>
- localStorage.get(['aiProvider', 'aiModel', 'aiApiKey', 'aiBaseUrl', 'aiLanguage']).then((stored) => {
+ localStorage.get(['aiProvider', 'aiModel', 'aiApiKey', 'aiApiKeys', 'aiBaseUrl', 'aiLanguage']).then((stored) => {
const key = providerOrDefault(stored.aiProvider);
setProvider(key);
if (typeof stored.aiModel === 'string') setModel(stored.aiModel);
- if (typeof stored.aiApiKey === 'string') setApiKey(stored.aiApiKey);
+ const keys = migrateApiKeys(stored);
+ setApiKeys(keys);
+ setApiKey(keyFor(keys, key));
if (isCustomBaseUrl(AI_PROVIDERS[key], stored.aiBaseUrl as string)) {
setBaseUrl(stored.aiBaseUrl as string);
setOwnServer(true);
@@ -165,8 +169,10 @@ function AISetupStep({ onNext, onSkip, onBack, index, total }: StepProps) {
setCustomModel(false);
setOwnServer(false);
setBaseUrl('');
+ const nextKey = keyFor(apiKeys, newProvider);
+ setApiKey(nextKey);
aiKeyCheck.reset();
- void localStorage.set({ aiProvider: newProvider, aiModel: nextModel, aiBaseUrl: '' });
+ void localStorage.set({ aiProvider: newProvider, aiModel: nextModel, aiBaseUrl: '', aiApiKey: nextKey });
};
const handleOwnServerToggle = () => {
@@ -194,8 +200,10 @@ function AISetupStep({ onNext, onSkip, onBack, index, total }: StepProps) {
const handleApiKeyChange = (nextKey: string) => {
setApiKey(nextKey);
+ const nextKeys = withKeyFor(apiKeys, provider, nextKey);
+ setApiKeys(nextKeys);
aiKeyCheck.reset();
- void localStorage.set({ aiApiKey: nextKey });
+ void localStorage.set({ aiApiKey: nextKey, aiApiKeys: nextKeys });
};
const handleBaseUrlChange = (nextUrl: string) => {
@@ -289,6 +297,7 @@ function AISetupStep({ onNext, onSkip, onBack, index, total }: StepProps) {
</button>
<div className="min-w-0">
<KeyStatusNote status={aiKeyCheck.status} />
+ <KeyWarningNote warning={aiKeyCheck.warning} />
</div>
</div>
{aiKeyCheck.models && <ModelList models={aiKeyCheck.models} />}
diff --git a/src/ui/shared/SettingsView.tsx b/src/ui/shared/SettingsView.tsx
index dfc1e37..cf8c9bb 100644
--- a/src/ui/shared/SettingsView.tsx
+++ b/src/ui/shared/SettingsView.tsx
@@ -18,6 +18,7 @@ import {
import { useCallback, useEffect, useRef, useState } from 'react';
import { i18n } from '#imports';
import { PRESET_LABELS, type PresetKey } from '@/core/blur/regexes';
+import { type AIApiKeys, keyFor, migrateApiKeys, withKeyFor } from '@/core/capture/ai/keys';
import {
AI_PROVIDERS,
type AIProviderKey,
@@ -39,7 +40,7 @@ import { Input } from '@/ui/components/ui/input';
import { Popover, PopoverContent, PopoverTrigger } from '@/ui/components/ui/popover';
import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from '@/ui/components/ui/select';
import ColorPicker from '@/ui/shared/ColorPicker';
-import { KeyStatusNote, ModelList, SecretInput, useKeyCheck } from '@/ui/shared/key-check';
+import { KeyStatusNote, KeyWarningNote, ModelList, SecretInput, useKeyCheck } from '@/ui/shared/key-check';
import MicrophonePicker from '@/ui/shared/MicrophonePicker';
import { changedSettings, type SettingsSnapshot } from '@/ui/shared/settings-autosave';
@@ -60,6 +61,7 @@ export default function SettingsView({ onBack }: SettingsViewProps) {
const [provider, setProvider] = useState<AIProviderKey>('openai');
const [model, setModel] = useState(AI_PROVIDERS.openai.defaultModel);
const [apiKey, setApiKey] = useState('');
+ const [apiKeys, setApiKeys] = useState<AIApiKeys>({});
const [baseUrl, setBaseUrl] = useState('');
const [saved, setSaved] = useState(false);
const aiKeyCheck = useKeyCheck();
@@ -92,6 +94,7 @@ export default function SettingsView({ onBack }: SettingsViewProps) {
localStorage
.get([
'aiApiKey',
+ 'aiApiKeys',
'aiProvider',
'aiModel',
'aiBaseUrl',
@@ -109,7 +112,9 @@ export default function SettingsView({ onBack }: SettingsViewProps) {
const p = providerOrDefault(result.aiProvider);
setProvider(p);
setModel((result.aiModel as string) || AI_PROVIDERS[p].defaultModel);
- if (result.aiApiKey) setApiKey(result.aiApiKey as string);
+ const keys = migrateApiKeys(result);
+ setApiKeys(keys);
+ setApiKey(keyFor(keys, p));
if (isCustomBaseUrl(AI_PROVIDERS[p], result.aiBaseUrl as string)) {
setBaseUrl(result.aiBaseUrl as string);
setOwnServer(true);
@@ -129,6 +134,7 @@ export default function SettingsView({ onBack }: SettingsViewProps) {
const stored = {
aiApiKey: apiKey,
+ aiApiKeys: apiKeys,
aiProvider: provider,
aiModel: model,
aiBaseUrl: baseUrl,
@@ -194,6 +200,7 @@ export default function SettingsView({ onBack }: SettingsViewProps) {
const handleProviderChange = (newProvider: AIProviderKey) => {
setProvider(newProvider);
+ setApiKey(keyFor(apiKeys, newProvider));
aiKeyCheck.reset();
setCustomModel(false);
setModel(AI_PROVIDERS[newProvider].defaultModel);
@@ -320,6 +327,7 @@ export default function SettingsView({ onBack }: SettingsViewProps) {
value={apiKey}
onChange={(next) => {
setApiKey(next);
+ setApiKeys((prev) => withKeyFor(prev, provider, next));
aiKeyCheck.reset();
}}
placeholder="sk-..."
@@ -338,6 +346,7 @@ export default function SettingsView({ onBack }: SettingsViewProps) {
</Button>
</div>
<KeyStatusNote status={aiKeyCheck.status} />
+ <KeyWarningNote warning={aiKeyCheck.warning} />
{aiKeyCheck.models && <ModelList models={aiKeyCheck.models} />}
{!apiKey.trim() && (
<p className="mt-1.5 flex items-start gap-1.5 text-[10px] text-destructive leading-relaxed" role="alert">