🎬 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
feat(editor): label where each step description came from
Luis Ortiz1fbe1ac0a9b1
diff --git a/src/core/guides/service.ts b/src/core/guides/service.tsindex 161fa82..26c8b42 100644--- a/src/core/guides/service.ts+++ b/src/core/guides/service.ts@@ -3,7 +3,7 @@ import type { NarrationUpdate } from '@/core/capture/voice/narration-updates';import type { ScreenshotEdits } from '@/core/screenshot/types';import { db } from './db';import { hashPayload } from './snapshot-hash';-import type { BlockType, CalloutVariant, Guide, Screenshot, Snapshot, Step } from './types';+import type { BlockType, CalloutVariant, DescriptionSource, Guide, Screenshot, Snapshot, Step } from './types';export type GuideChangeEvent = { type: 'starred'; id: string; starred: boolean } | { type: 'mutated' };@@ -195,8 +195,12 @@ export async function updateCallout(stepId: string, variant: CalloutVariant, colawait db.steps.update(stepId, { calloutVariant: variant, calloutColor: color });}-export async function updateStepDescription(stepId: string, description: string): Promise<void> {- await db.steps.update(stepId, { description });+export async function updateStepDescription(+ stepId: string,+ description: string,+ source?: DescriptionSource,+): Promise<void> {+ await db.steps.update(stepId, source ? { description, descriptionSource: source } : { description });}export async function applyNarrationToSteps(updates: readonly NarrationUpdate[]): Promise<void> {diff --git a/src/locales/de.yml b/src/locales/de.ymlindex 01ee120..52cef14 100644--- a/src/locales/de.yml+++ b/src/locales/de.yml@@ -140,6 +140,7 @@ settings:keyModelRequired: Wähle ein Modell, bevor du diesen Schlüssel prüfst.keyModelInvalid: Das ausgewählte Modell ist bei diesem Anbieter nicht verfügbar.checkKey: Schlüssel prüfen+ keyCannotSpend: "Dieser Schlüssel hat kein Guthaben, es funktionieren nur kostenlose Modelle."keyUnreachable: Der Anbieter war nicht erreichbar. Prüfe deine Verbindung und versuche es erneut.modelsFound: "$1 Modelle verfügbar"@@ -534,3 +535,24 @@ micPermission:deniedMessage: Dein Browser blockiert das Mikrofon für Mimik, daher kann der Sprachkommentar nicht aufnehmen. Öffne die Website-Einstellungen über das Symbol links in der Adressleiste, setze Mikrofon auf Zulassen und versuche es dann erneut. Anleitungen aufzeichnen funktioniert auch ohne.retry: Erneut versuchenprivacy: Audio bleibt nur während der Aufnahme im Speicher und wird an den von dir konfigurierten Transkriptionsanbieter gesendet. Mimik speichert es nie.++aiStatus:+ rejected: "$1 hat deinen API-Schlüssel abgelehnt."+ noCredits: "Dein $1-Konto hat kein Guthaben."+ rateLimited: "$1 begrenzt, wie oft Mimik anfragen darf."+ modelInvalid: "$1 bietet dieses Modell für dein Konto nicht an."+ quota: "Diese Anfrage war zu groß für dieses Modell."+ network: "Mimik konnte $1 nicht erreichen."+ unknown: "$1 hat die Anfrage abgelehnt."+ actionCheckKey: "Prüfe deinen Schlüssel in den Einstellungen."+ actionAddCredits: "Guthaben aufladen, dann den Schlüssel erneut prüfen."+ actionWait: "Warte einen Moment, bevor du weiter aufnimmst."+ actionPickModel: "Wähle in den Einstellungen ein anderes Modell."+ actionConnection: "Prüfe deine Verbindung."++stepSource:+ ai: "KI"+ voice: "Stimme"+ basic: "Einfach"+ edited: "Bearbeitet"+ hint: "Woher diese Beschreibung kommt"diff --git a/src/locales/en.yml b/src/locales/en.ymlindex 9bf9511..1cc37f3 100644--- a/src/locales/en.yml+++ b/src/locales/en.yml@@ -134,6 +134,7 @@ settings:keyModelRequired: Choose a model before checking this key.keyModelInvalid: The selected model is not available from this provider.checkKey: Check key+ keyCannotSpend: "This key has no credits, so only free models will work."keyUnreachable: Could not reach the provider. Check your connection and try again.modelsFound: "$1 models available"smartBlur: Smart Blur@@ -533,3 +534,24 @@ micPermission:deniedMessage: Your browser is blocking the microphone for Mimik, so voice narration cannot record. Open the site settings from the icon at the left of the address bar, set Microphone to Allow, then try again. Capturing guides keeps working without it.retry: Try againprivacy: Audio is held in memory only while you record and is sent to the transcription provider you configured. Mimik never stores it.++aiStatus:+ rejected: "$1 rejected your API key."+ noCredits: "Your $1 account has no credits."+ rateLimited: "$1 is limiting how often Mimik can ask."+ modelInvalid: "$1 does not offer that model to your account."+ quota: "That request was too large for this model."+ network: "Mimik could not reach $1."+ unknown: "$1 refused the request."+ actionCheckKey: "Check your key in Settings."+ actionAddCredits: "Add credits, then check the key again."+ actionWait: "Wait a moment before recording more."+ actionPickModel: "Pick another model in Settings."+ actionConnection: "Check your connection."++stepSource:+ ai: "AI"+ voice: "Voice"+ basic: "Basic"+ edited: "Edited"+ hint: "Where this description came from"diff --git a/src/locales/es.yml b/src/locales/es.ymlindex ca56156..b56899b 100644--- a/src/locales/es.yml+++ b/src/locales/es.yml@@ -134,6 +134,7 @@ settings:keyModelRequired: Elige un modelo antes de comprobar esta clave.keyModelInvalid: El modelo seleccionado no está disponible en este proveedor.checkKey: Comprobar clave+ keyCannotSpend: "Esta clave no tiene créditos, solo funcionarán los modelos gratuitos."keyUnreachable: No se pudo conectar con el proveedor. Revisa tu conexión e inténtalo de nuevo.modelsFound: "$1 modelos disponibles"smartBlur: Desenfoque inteligente@@ -533,3 +534,24 @@ micPermission:deniedMessage: Tu navegador está bloqueando el micrófono para Mimik, así que la narración por voz no puede grabar. Abre la configuración del sitio desde el icono a la izquierda de la barra de direcciones, pon Micrófono en Permitir y vuelve a intentarlo. Capturar guías sigue funcionando sin esto.retry: Intentar de nuevoprivacy: El audio solo se guarda en memoria mientras grabas y se envía al proveedor de transcripción que hayas configurado. Mimik nunca lo almacena.++aiStatus:+ rejected: "$1 rechazó tu clave de API."+ noCredits: "Tu cuenta de $1 no tiene créditos."+ rateLimited: "$1 está limitando la frecuencia de las peticiones de Mimik."+ modelInvalid: "$1 no ofrece ese modelo a tu cuenta."+ quota: "Esa petición fue demasiado grande para este modelo."+ network: "Mimik no pudo contactar con $1."+ unknown: "$1 rechazó la petición."+ actionCheckKey: "Revisa tu clave en Ajustes."+ actionAddCredits: "Añade créditos y vuelve a comprobar la clave."+ actionWait: "Espera un momento antes de seguir grabando."+ actionPickModel: "Elige otro modelo en Ajustes."+ actionConnection: "Revisa tu conexión."++stepSource:+ ai: "IA"+ voice: "Voz"+ basic: "Básica"+ edited: "Editada"+ hint: "De dónde viene esta descripción"diff --git a/src/locales/fr.yml b/src/locales/fr.ymlindex b7ffabb..7e7836b 100644--- a/src/locales/fr.yml+++ b/src/locales/fr.yml@@ -134,6 +134,7 @@ settings:keyModelRequired: Choisissez un modèle avant de vérifier cette clé.keyModelInvalid: "Le modèle sélectionné n'est pas disponible chez ce fournisseur."checkKey: Vérifier la clé+ keyCannotSpend: "Cette clé n’a pas de crédits, seuls les modèles gratuits fonctionneront."keyUnreachable: Le fournisseur est injoignable. Vérifiez votre connexion et réessayez.modelsFound: "$1 modèles disponibles"smartBlur: Flou intelligent@@ -533,3 +534,24 @@ micPermission:deniedMessage: Votre navigateur bloque le microphone pour Mimik, la narration vocale ne peut donc pas enregistrer. Ouvrez les paramètres du site depuis l'icône à gauche de la barre d'adresse, réglez Microphone sur Autoriser, puis réessayez. La capture de guides continue de fonctionner sans cela.retry: Réessayerprivacy: L'audio reste en mémoire pendant l'enregistrement et n'est envoyé qu'au service de transcription que vous avez configuré. Mimik ne le conserve jamais.++aiStatus:+ rejected: "$1 a refusé votre clé API."+ noCredits: "Votre compte $1 n’a pas de crédits."+ rateLimited: "$1 limite la fréquence des requêtes de Mimik."+ modelInvalid: "$1 ne propose pas ce modèle à votre compte."+ quota: "Cette requête était trop volumineuse pour ce modèle."+ network: "Mimik n’a pas pu joindre $1."+ unknown: "$1 a refusé la requête."+ actionCheckKey: "Vérifiez votre clé dans les réglages."+ actionAddCredits: "Ajoutez des crédits, puis revérifiez la clé."+ actionWait: "Attendez un instant avant de continuer."+ actionPickModel: "Choisissez un autre modèle dans les réglages."+ actionConnection: "Vérifiez votre connexion."++stepSource:+ ai: "IA"+ voice: "Voix"+ basic: "Simple"+ edited: "Modifiée"+ hint: "D’où vient cette description"diff --git a/src/locales/pt-BR.yml b/src/locales/pt-BR.ymlindex dd464ca..b4fe09b 100644--- a/src/locales/pt-BR.yml+++ b/src/locales/pt-BR.yml@@ -134,6 +134,7 @@ settings:keyModelRequired: Escolha um modelo antes de verificar esta chave.keyModelInvalid: O modelo selecionado não está disponível neste provedor.checkKey: Verificar chave+ keyCannotSpend: "Esta chave não tem créditos, então só modelos gratuitos vão funcionar."keyUnreachable: Não deu pra falar com o provedor. Confere sua conexão e tenta de novo.modelsFound: "$1 modelos disponíveis"smartBlur: Desfoque inteligente@@ -533,3 +534,24 @@ micPermission:deniedMessage: Seu navegador está bloqueando o microfone para o Mimik, então a narração por voz não pode gravar. Abra as configurações do site pelo ícone à esquerda da barra de endereços, defina Microfone como Permitir e tente de novo. Capturar guias continua funcionando sem isso.retry: Tentar de novoprivacy: O áudio fica apenas na memória enquanto você grava e é enviado ao provedor de transcrição que você configurou. O Mimik nunca o armazena.++aiStatus:+ rejected: "$1 rejeitou sua chave de API."+ noCredits: "Sua conta $1 não tem créditos."+ rateLimited: "$1 está limitando a frequência das requisições do Mimik."+ modelInvalid: "$1 não oferece esse modelo para sua conta."+ quota: "Essa requisição foi grande demais para este modelo."+ network: "O Mimik não conseguiu contatar $1."+ unknown: "$1 recusou a requisição."+ actionCheckKey: "Confira sua chave em Configurações."+ actionAddCredits: "Adicione créditos e verifique a chave de novo."+ actionWait: "Espere um momento antes de continuar gravando."+ actionPickModel: "Escolha outro modelo em Configurações."+ actionConnection: "Verifique sua conexão."++stepSource:+ ai: "IA"+ voice: "Voz"+ basic: "Básica"+ edited: "Editada"+ hint: "De onde veio esta descrição"diff --git a/src/locales/zh-CN.yml b/src/locales/zh-CN.ymlindex 934c678..c968a1b 100644--- a/src/locales/zh-CN.yml+++ b/src/locales/zh-CN.yml@@ -134,6 +134,7 @@ settings:keyModelInvalid: 所选模型在此提供商上不可用。请选择其他模型或输入自定义模型 ID。keyModelRequired: 需要选择模型。请从列表中选择或输入自定义模型 ID。checkKey: 检查密钥+ keyCannotSpend: "该密钥没有额度,只能使用免费模型。"keyUnreachable: 无法连接到提供商。请检查网络后重试。modelsFound: "找到 $1 个模型"smartBlur: 智能模糊@@ -533,3 +534,24 @@ micPermission:deniedMessage: 浏览器正在阻止 Mimik 使用麦克风,因此无法录制语音讲解。请从地址栏左侧图标打开网站设置,将麦克风设为允许,然后重试。即使没有麦克风,捕获指南仍可继续使用。retry: 重试privacy: 音频只会在录制期间保存在内存中,并会发送到你配置的转写提供商。Mimik 永远不会存储它。++aiStatus:+ rejected: "$1 拒绘了你的 API 密钥。"+ noCredits: "你的 $1 账户没有额度。"+ rateLimited: "$1 正在限制 Mimik 的请求频率。"+ modelInvalid: "$1 未向你的账户提供该模型。"+ quota: "该请求内容超出了模型上限。"+ network: "Mimik 无法连接到 $1。"+ unknown: "$1 拒绘了该请求。"+ actionCheckKey: "请在设置中检查密钥。"+ actionAddCredits: "充值后再次检查密钥。"+ actionWait: "稍等一下再继续录制。"+ actionPickModel: "请在设置中选择其他模型。"+ actionConnection: "请检查网络连接。"++stepSource:+ ai: "AI"+ voice: "语音"+ basic: "基础"+ edited: "已编辑"+ hint: "这条描述的来源"diff --git a/src/ui/fullview/GuideContent.tsx b/src/ui/fullview/GuideContent.tsxindex 7facbf9..0632ce4 100644--- a/src/ui/fullview/GuideContent.tsx+++ b/src/ui/fullview/GuideContent.tsx@@ -186,7 +186,7 @@ export default function GuideContent({ guideId, initialStepId, initialTool }: Gu}, [guideId]);const handleDescriptionChange = useCallback(async (stepId: string, description: string) => {- await updateStepDescription(stepId, description);+ await updateStepDescription(stepId, description, 'manual');setData((prev) => {if (!prev) return prev;return { ...prev, steps: prev.steps.map((s) => (s.id === stepId ? { ...s, description } : s)) };diff --git a/src/ui/shared/StepSourceBadge.tsx b/src/ui/shared/StepSourceBadge.tsxnew file mode 100644index 0000000..00edf4a--- /dev/null+++ b/src/ui/shared/StepSourceBadge.tsx@@ -0,0 +1,29 @@+import { i18n } from '#imports';+import type { DescriptionSource } from '@/core/guides/types';++const STYLES: Record<DescriptionSource, string> = {+ ai: 'bg-secondary text-accent',+ narration: 'bg-success/10 text-success',+ heuristic: 'bg-primary text-primary-foreground',+ manual: 'border border-border text-muted-foreground',+};++const LABELS: Record<DescriptionSource, string> = {+ ai: 'stepSource.ai',+ narration: 'stepSource.voice',+ heuristic: 'stepSource.basic',+ manual: 'stepSource.edited',+};++export default function StepSourceBadge({ source }: { source: DescriptionSource | undefined }) {+ if (!source) return null;++ return (+ <span+ className={`inline-block leading-none text-[9px] font-bold uppercase tracking-wide rounded px-1 py-[2px] shrink-0 ${STYLES[source]}`}+ title={i18n.t('stepSource.hint')}+ >+ {i18n.t(LABELS[source])}+ </span>+ );+}diff --git a/src/ui/shared/__tests__/step-source-badge.test.tsx b/src/ui/shared/__tests__/step-source-badge.test.tsxnew file mode 100644index 0000000..1fdbcf7--- /dev/null+++ b/src/ui/shared/__tests__/step-source-badge.test.tsx@@ -0,0 +1,39 @@+// @vitest-environment jsdom+import '@testing-library/jest-dom/vitest';+import { readFileSync } from 'node:fs';+import { join } from 'node:path';+import { render, screen } from '@testing-library/react';+import { describe, expect, it } from 'vitest';+import type { DescriptionSource } from '@/core/guides/types';+import StepSourceBadge from '@/ui/shared/StepSourceBadge';++const SOURCES: DescriptionSource[] = ['ai', 'narration', 'heuristic', 'manual'];+const LOCALES = ['en', 'de', 'es', 'fr', 'pt-BR', 'zh-CN'];++describe('StepSourceBadge', () => {+ it('says nothing for a step recorded before the field existed', () => {+ const { container } = render(<StepSourceBadge source={undefined} />);+ expect(container).toBeEmptyDOMElement();+ });++ it.each(SOURCES)('renders a label for %s', (source) => {+ render(<StepSourceBadge source={source} />);+ expect(screen.getByText(/.+/)).toBeInTheDocument();+ });++ it('distinguishes a rule-based description from an AI one', () => {+ const { container: ai } = render(<StepSourceBadge source="ai" />);+ const { container: basic } = render(<StepSourceBadge source="heuristic" />);+ expect(ai.textContent).not.toBe(basic.textContent);+ expect(ai.firstElementChild?.className).not.toBe(basic.firstElementChild?.className);+ });++ it('carries a label for every source, in every locale', () => {+ for (const locale of LOCALES) {+ const text = readFileSync(join(process.cwd(), 'src/locales', `${locale}.yml`), 'utf8');+ for (const key of ['ai', 'voice', 'basic', 'edited', 'hint']) {+ expect(text, `${locale} is missing stepSource.${key}`).toContain(` ${key}:`);+ }+ }+ });+});diff --git a/src/ui/sidepanel/RecordingView.tsx b/src/ui/sidepanel/RecordingView.tsxindex d950778..659cd55 100644--- a/src/ui/sidepanel/RecordingView.tsx+++ b/src/ui/sidepanel/RecordingView.tsx@@ -5,11 +5,13 @@ import { deleteStep, getScreenshotsForSteps, getStepsForGuide } from '@/core/guiimport type { Screenshot, Step } from '@/core/guides/types';import { getActiveTab, localStorage } from '@/lib/browser-api';import { sendMessage } from '@/lib/messaging';-import type { PanelVoiceUpdate } from '@/lib/port';+import type { PanelAiUpdate, PanelVoiceUpdate } from '@/lib/port';import { extractDomain } from '@/lib/utils';import { Button } from '@/ui/components/ui/button';import { Tooltip, TooltipContent, TooltipTrigger } from '@/ui/components/ui/tooltip';import ScreenshotView from '@/ui/shared/ScreenshotView';+import StepSourceBadge from '@/ui/shared/StepSourceBadge';+import AiStatus from './AiStatus';import MicToggle from './MicToggle';import VoiceStatus from './VoiceStatus';@@ -17,6 +19,7 @@ interface RecordingViewProps {guideId: string;onStop: () => void;voice: PanelVoiceUpdate;+ aiFailure: PanelAiUpdate | null;}function timeAgo(createdAt: number): string {@@ -31,7 +34,7 @@ interface LiveStep {screenshot?: Screenshot;}-export default function RecordingView({ guideId, onStop, voice }: RecordingViewProps) {+export default function RecordingView({ guideId, onStop, voice, aiFailure }: RecordingViewProps) {const [steps, setSteps] = useState<LiveStep[]>([]);const [siteUrl, setSiteUrl] = useState('');const [isBlurring, setIsBlurring] = useState(false);@@ -189,8 +192,11 @@ export default function RecordingView({ guideId, onStop, voice }: RecordingViewP{liveStep.step.description}</p>)}- <span className="text-[10px] text-purple">- {timeAgo(liveStep.step.timestamp)} · {extractDomain(liveStep.step.url || siteUrl)}+ <span className="flex items-baseline gap-1.5 text-[10px] text-purple">+ {!liveStep.step.aiPending && <StepSourceBadge source={liveStep.step.descriptionSource} />}+ <span>+ {timeAgo(liveStep.step.timestamp)} · {extractDomain(liveStep.step.url || siteUrl)}+ </span></span></div><Tooltip>@@ -216,6 +222,7 @@ export default function RecordingView({ guideId, onStop, voice }: RecordingViewP{/* Bottom bar */}<div className="shrink-0 border-t border-border">+ <AiStatus update={aiFailure} />{import.meta.env.BROWSER !== 'firefox' && <VoiceStatus update={voice} enabled={voiceEnabled} />}<div className="px-4 py-2.5 flex items-center gap-2"><Button onClick={onStop} className="flex-1 h-10 rounded-full font-semibold text-[13px]">diff --git a/src/ui/sidepanel/StepCard.tsx b/src/ui/sidepanel/StepCard.tsxindex 6b0e8b1..18d3dd9 100644--- a/src/ui/sidepanel/StepCard.tsx+++ b/src/ui/sidepanel/StepCard.tsx@@ -11,6 +11,7 @@ import ConfirmDialog from '@/ui/shared/ConfirmDialog';import { DragGrip, type DragHandleProps, useCardDrag } from '@/ui/shared/card-drag';import ImagePlaceholder from '@/ui/shared/ImagePlaceholder';import ScreenshotView from '@/ui/shared/ScreenshotView';+import StepSourceBadge from '@/ui/shared/StepSourceBadge';interface StepCardProps {step: Step;@@ -150,7 +151,8 @@ export default function StepCard({/>)}</div>- <div className="flex items-center justify-end mt-1">+ <div className="flex items-center justify-between gap-2 mt-1">+ {step.aiPending ? <span /> : <StepSourceBadge source={step.descriptionSource} />}<div className="flex items-center gap-0.5">{askAi.trigger}{screenshot && (