π¬ A browser extension and desktop app that turns your clicks into step-by-step guides with annotated screenshots π
TypeScript browser-extensionchrome-extensiondocumentationfirefox-extensionguide-generatorlocal-firstmanifest-v3privacy-firstproductivityreactscreenshotstep-by-step-guidetutorialtypescriptworkflowwxt
refactor(core): share AI credentials and the steps a guide is named from
Luis Ortizef8933e20617
diff --git a/apps/desktop/src/renderer/ai/credentials.ts b/apps/desktop/src/renderer/ai/credentials.tsindex d29cb89..573330a 100644--- a/apps/desktop/src/renderer/ai/credentials.ts+++ b/apps/desktop/src/renderer/ai/credentials.ts@@ -1,24 +1,6 @@-import { resolveAiKey } from '@mimik/core/capture/ai/keys';-import { AI_PROVIDERS } from '@mimik/core/capture/ai/models';+import { AI_CREDENTIAL_SETTINGS, type AiCredentials, resolveAiCredentials } from '@mimik/core/capture/ai/keys';import { localStorage } from '@mimik/core/env';-const AI_SETTINGS = ['aiApiKeys', 'aiApiKey', 'aiProvider', 'aiModel', 'aiBaseUrl'] as const;--interface Credentials {- provider: string;- model: string;- apiKey: string;- baseUrl?: string;-}--export async function credentials(): Promise<Credentials | null> {- const stored = await localStorage.get(AI_SETTINGS);- const { provider, apiKey } = resolveAiKey(stored);- if (!apiKey) return null;- return {- provider,- apiKey,- model: (stored.aiModel as string) || AI_PROVIDERS[provider].defaultModel,- baseUrl: (stored.aiBaseUrl as string) || undefined,- };+export async function credentials(): Promise<AiCredentials | null> {+ return resolveAiCredentials(await localStorage.get(AI_CREDENTIAL_SETTINGS));}diff --git a/apps/desktop/src/renderer/ai/name-guide.ts b/apps/desktop/src/renderer/ai/name-guide.tsindex 5050985..5009c0c 100644--- a/apps/desktop/src/renderer/ai/name-guide.ts+++ b/apps/desktop/src/renderer/ai/name-guide.ts@@ -1,16 +1,14 @@-import { type GuideMeta, generateGuideMeta } from '@mimik/core/capture/ai/meta';+import { type GuideMeta, generateGuideMeta, guideMetaSteps } from '@mimik/core/capture/ai/meta';+import type { Step } from '@mimik/core/guides/types';import { credentials } from './credentials';-export async function nameGuide(steps: { description: string }[]): Promise<GuideMeta | null> {+export async function nameGuide(steps: Step[]): Promise<GuideMeta | null> {const keys = await credentials();if (!keys) return null;- const described = steps- .filter((step) => step.description)- .map((step) => ({ description: step.description, url: '' }));+ const described = guideMetaSteps(steps);if (described.length === 0) return null;- const trimmed = described.length > 15 ? [...described.slice(0, 10), ...described.slice(-5)] : described;try {- return await generateGuideMeta(trimmed, keys.provider, keys.model, keys.apiKey, keys.baseUrl);+ return await generateGuideMeta(described, keys.provider, keys.model, keys.apiKey, keys.baseUrl);} catch {return null;}diff --git a/packages/core/src/capture/ai/keys.ts b/packages/core/src/capture/ai/keys.tsindex 3f2d288..2343a7c 100644--- a/packages/core/src/capture/ai/keys.ts+++ b/packages/core/src/capture/ai/keys.ts@@ -1,4 +1,4 @@-import { type AIProviderKey, isProviderKey, providerOrDefault } from './models';+import { AI_PROVIDERS, type AIProviderKey, isProviderKey, providerOrDefault } from './models';export type AIApiKeys = Partial<Record<AIProviderKey, string>>;@@ -42,3 +42,29 @@ export function resolveAiKey(stored: { aiApiKeys?: unknown; aiApiKey?: unknown;const provider = providerOrDefault(stored.aiProvider);return { provider, apiKey: keyFor(migrateApiKeys(stored), provider) };}++export const AI_CREDENTIAL_SETTINGS = [...AI_KEY_SETTINGS, 'aiModel', 'aiBaseUrl'] as const;++export interface AiCredentials {+ provider: AIProviderKey;+ model: string;+ apiKey: string;+ baseUrl?: string;+}++export function resolveAiCredentials(stored: {+ aiApiKeys?: unknown;+ aiApiKey?: unknown;+ aiProvider?: unknown;+ aiModel?: unknown;+ aiBaseUrl?: unknown;+}): AiCredentials | null {+ const { provider, apiKey } = resolveAiKey(stored);+ if (!apiKey) return null;+ return {+ provider,+ apiKey,+ model: (typeof stored.aiModel === 'string' && stored.aiModel) || AI_PROVIDERS[provider].defaultModel,+ baseUrl: typeof stored.aiBaseUrl === 'string' ? stored.aiBaseUrl : undefined,+ };+}diff --git a/packages/core/src/capture/ai/meta.ts b/packages/core/src/capture/ai/meta.tsindex 9e5a4a8..3a65381 100644--- a/packages/core/src/capture/ai/meta.ts+++ b/packages/core/src/capture/ai/meta.ts@@ -1,5 +1,7 @@import { generateObject, generateText, jsonSchema } from 'ai';import { localStorage } from '@/core/env';+import { actionSteps } from '@/core/guides/blocks';+import type { Step } from '@/core/guides/types';import { logger } from '@/core/logger';import { GUIDE_META_JSON_SUFFIX, GUIDE_META_PROMPT, getLanguageSuffix } from './prompts';import { createModel } from './provider';@@ -92,3 +94,10 @@ export async function generateGuideMeta(return null;}}++export function guideMetaSteps(steps: Step[]): { description: string; url: string }[] {+ const described = actionSteps(steps)+ .filter((step) => step.description)+ .map((step) => ({ description: step.description, url: step.url }));+ return described.length > 15 ? [...described.slice(0, 10), ...described.slice(-5)] : described;+}diff --git a/packages/core/src/capture/ai/rewrite.ts b/packages/core/src/capture/ai/rewrite.tsindex 6be88d5..ac6d6b7 100644--- a/packages/core/src/capture/ai/rewrite.ts+++ b/packages/core/src/capture/ai/rewrite.ts@@ -1,8 +1,7 @@import { generateText } from 'ai';import { localStorage } from '@/core/env';import { logger } from '@/core/logger';-import { resolveAiKey } from './keys';-import { AI_PROVIDERS } from './models';+import { AI_CREDENTIAL_SETTINGS, resolveAiCredentials } from './keys';import { getLanguageSuffix, REWRITE_PROMPT } from './prompts';import { createModel } from './provider';@@ -29,25 +28,13 @@ export function buildRewritePrompt(text: string, instruction: string, locale: st}export async function rewriteSelection(text: string, instruction: string): Promise<RewriteSelectionResponse> {- const settings = await localStorage.get([- 'aiApiKeys',- 'aiApiKey',- 'aiProvider',- 'aiModel',- 'aiBaseUrl',- 'aiLanguage',- ]);- const { provider, apiKey } = resolveAiKey(settings);- if (!apiKey) return { error: 'no-api-key' };+ const settings = await localStorage.get([...AI_CREDENTIAL_SETTINGS, 'aiLanguage']);+ const keys = resolveAiCredentials(settings);+ if (!keys) return { error: 'no-api-key' };try {const { text: raw } = await generateText({- model: createModel(- provider,- (settings.aiModel as string) || AI_PROVIDERS[provider].defaultModel,- apiKey,- settings.aiBaseUrl as string | undefined,- ),+ model: createModel(keys.provider, keys.model, keys.apiKey, keys.baseUrl),prompt: buildRewritePrompt(text, instruction, (settings.aiLanguage as string) || 'en'),maxOutputTokens: 400,});diff --git a/src/entrypoints/background/__tests__/guide-meta.test.ts b/src/entrypoints/background/__tests__/guide-meta.test.tsindex 74222c5..4be8c9c 100644--- a/src/entrypoints/background/__tests__/guide-meta.test.ts+++ b/src/entrypoints/background/__tests__/guide-meta.test.ts@@ -18,7 +18,10 @@ const {updateGuideTitleMock: vi.fn(),}));-vi.mock('@/core/capture/ai/meta', () => ({ generateGuideMeta: generateGuideMetaMock }));+vi.mock('@/core/capture/ai/meta', async (importOriginal) => ({+ ...(await importOriginal<typeof import('@/core/capture/ai/meta')>()),+ generateGuideMeta: generateGuideMetaMock,+}));vi.mock('@/core/guides/service', () => ({clearStepAiPending: clearStepAiPendingMock,diff --git a/src/entrypoints/background/ai-description.ts b/src/entrypoints/background/ai-description.tsindex dadfd82..c671e8e 100644--- a/src/entrypoints/background/ai-description.ts+++ b/src/entrypoints/background/ai-description.ts@@ -1,25 +1,23 @@import { logger } from '@mimik/core/logger';import { getAIDescription } from '@/core/capture/ai/description';import { describeAiFailure } from '@/core/capture/ai/errors';-import { resolveAiKey } from '@/core/capture/ai/keys';-import { AI_PROVIDERS } from '@/core/capture/ai/models';+import { AI_CREDENTIAL_SETTINGS, resolveAiCredentials } from '@/core/capture/ai/keys';import { type DOMContext, serializeDOMContext } from '@/core/capture/dom/context';import { localStorage } from '@/lib/browser-api/local-storage';import { broadcastAiToPanel } from '@/lib/port/broadcast-ai-to-panel';export async function generateAiDescription(domContext: DOMContext): Promise<string | undefined> {- const settings = await localStorage.get(['aiApiKeys', 'aiApiKey', 'aiProvider', 'aiModel', 'aiBaseUrl']);- const { provider, apiKey } = resolveAiKey(settings);- if (!apiKey) return undefined;+ const keys = resolveAiCredentials(await localStorage.get([...AI_CREDENTIAL_SETTINGS]));+ if (!keys) return undefined;+ const { provider } = keys;- const model = (settings.aiModel as string) || AI_PROVIDERS[provider].defaultModel;try {const description = await getAIDescription(serializeDOMContext(domContext),provider,- model,- apiKey,- settings.aiBaseUrl as string | undefined,+ keys.model,+ keys.apiKey,+ keys.baseUrl,);return description || undefined;} catch (err) {diff --git a/src/entrypoints/background/guide-meta.ts b/src/entrypoints/background/guide-meta.tsindex e2e4952..fa9e1fe 100644--- a/src/entrypoints/background/guide-meta.ts+++ b/src/entrypoints/background/guide-meta.ts@@ -1,9 +1,7 @@import { logger } from '@mimik/core/logger';import { i18n } from '#imports';-import { resolveAiKey } from '@/core/capture/ai/keys';-import { generateGuideMeta } from '@/core/capture/ai/meta';-import { AI_PROVIDERS } from '@/core/capture/ai/models';-import { actionSteps } from '@/core/guides/blocks';+import { AI_CREDENTIAL_SETTINGS, resolveAiCredentials } from '@/core/capture/ai/keys';+import { generateGuideMeta, guideMetaSteps } from '@/core/capture/ai/meta';import {clearStepAiPending,getGuideDomain,@@ -30,22 +28,13 @@ type GuideMetaInputs =| { ok: false; reason: ResolveFailure };async function resolveGuideMetaInputs(guideId: string): Promise<GuideMetaInputs> {- 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 keys = resolveAiCredentials(await localStorage.get([...AI_CREDENTIAL_SETTINGS]));+ if (!keys) 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 steps = guideMetaSteps(await getStepsForGuide(guideId));+ if (steps.length === 0) return { ok: false, reason: 'no-steps' };- 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,- baseUrl: settings.aiBaseUrl as string | undefined,- };+ return { ok: true, steps, ...keys };}async function applyFallbackTitle(guideId: string) {