🎬 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
fix(guideme): derive the manual notice per viewed step and reword it
Luis Ortiz0a38333dc363
diff --git a/src/core/guideme/__tests__/manual.test.ts b/src/core/guideme/__tests__/manual.test.tsnew file mode 100644index 0000000..d21412b--- /dev/null+++ b/src/core/guideme/__tests__/manual.test.ts@@ -0,0 +1,54 @@+import { describe, expect, it } from 'vitest';+import type { Screenshot, Step } from '@/core/guides/types';+import { stepRequiresManual } from '../manual';++const step = (overrides: Partial<Step> = {}): Step => ({+ id: 's1',+ guideId: 'g1',+ index: 0,+ description: 'Click link',+ action: 'click',+ url: 'https://example.com',+ timestamp: 0,+ elementMeta: { textContent: 'Link' } as Step['elementMeta'],+ ...overrides,+});++const shot = (edits: Screenshot['edits'], bounds?: Screenshot['bounds']): Screenshot =>+ ({+ id: 'sc1',+ stepId: 's1',+ blob: new Blob(),+ mimeType: 'image/webp',+ width: 100,+ height: 100,+ edits,+ bounds,+ }) as Screenshot;++describe('stepRequiresManual', () => {+ it('requires manual advance when the step has no element metadata', () => {+ expect(stepRequiresManual(step({ elementMeta: undefined }), null)).toBe(true);+ });++ it('stays automatic when the step has metadata and no screenshot', () => {+ expect(stepRequiresManual(step(), null)).toBe(false);+ });++ it('stays automatic for an untouched capture', () => {+ const target = { x: 0, y: 0, width: 10, height: 10, border: 'dashed' as const, color: '#4F46E5' };+ expect(stepRequiresManual(step(), shot({ target }, { x: 0, y: 0, width: 10, height: 10 }))).toBe(false);+ });++ it('requires manual advance once the edit flag is set', () => {+ expect(stepRequiresManual(step(), shot({ requiresManual: true }))).toBe(true);+ });++ it('treats a cleared target on a real capture as manual', () => {+ expect(stepRequiresManual(step(), shot({ target: null }, { x: 0, y: 0, width: 10, height: 10 }))).toBe(true);+ });++ it('does not flag a cleared target when the capture never had bounds', () => {+ expect(stepRequiresManual(step(), shot({ target: null }))).toBe(false);+ });+});diff --git a/src/core/guideme/manual.ts b/src/core/guideme/manual.tsnew file mode 100644index 0000000..12a9964--- /dev/null+++ b/src/core/guideme/manual.ts@@ -0,0 +1,8 @@+import type { Screenshot, Step } from '@/core/guides/types';++export function stepRequiresManual(step: Step, screenshot: Screenshot | null | undefined): boolean {+ if (!step.elementMeta) return true;+ if (!screenshot) return false;+ if (screenshot.edits?.requiresManual === true) return true;+ return screenshot.edits?.target === null && Boolean(screenshot.bounds);+}diff --git a/src/entrypoints/background/index.ts b/src/entrypoints/background/index.tsindex d5a7a7f..283a70e 100644--- a/src/entrypoints/background/index.ts+++ b/src/entrypoints/background/index.ts@@ -1,5 +1,6 @@import { browser, defineBackground, i18n } from '#imports';import { generateGuideTitle } from '@/core/capture/ai/title';+import { stepRequiresManual } from '@/core/guideme/manual';import { advanceSession, cancelSession, completeSession, getSession, startSession } from '@/core/guideme/session';import {createGuide,@@ -58,14 +59,10 @@ async function generateTitleInBackground(guideId: string) {}}-async function stepRequiresManual(step: Step): Promise<boolean> {- if (!step.elementMeta) return true;- if (!step.screenshotId) return false;+async function resolveManual(step: Step): Promise<boolean> {+ if (!step.screenshotId) return stepRequiresManual(step, null);const screenshots = await getScreenshotsForSteps([step.screenshotId]);- const screenshot = screenshots.get(step.id);- if (!screenshot) return false;- if (screenshot.edits?.requiresManual === true) return true;- return screenshot.edits?.target === null && Boolean(screenshot.bounds);+ return stepRequiresManual(step, screenshots.get(step.id));}export default defineBackground(() => {@@ -201,7 +198,7 @@ export default defineBackground(() => {const firstStep = steps.find((s) => s.elementMeta) ?? steps[0];if (!steps.some((s) => s.elementMeta)) return { started: false, error: 'Guide lacks element metadata' };- await startSession(data.guideId, steps.length, firstStep, await stepRequiresManual(firstStep));+ await startSession(data.guideId, steps.length, firstStep, await resolveManual(firstStep));const activeTab = await getActiveTab();if (activeTab?.id && firstStep.url) {@@ -229,7 +226,7 @@ export default defineBackground(() => {await completeSession();return { advanced: true, completed: true };}- await advanceSession(nextStep, nextIndex, await stepRequiresManual(nextStep));+ await advanceSession(nextStep, nextIndex, await resolveManual(nextStep));const currentTab = await getActiveTab();if (currentTab?.id && nextStep.url && nextStep.url !== currentTab.url) {@@ -255,7 +252,7 @@ export default defineBackground(() => {const prevIndex = data.stepIndex - 1;const prevStep = steps[prevIndex];if (!prevStep) return { moved: false };- await advanceSession(prevStep, prevIndex, await stepRequiresManual(prevStep));+ await advanceSession(prevStep, prevIndex, await resolveManual(prevStep));const currentTab = await getActiveTab();if (currentTab?.id && prevStep.url && prevStep.url !== currentTab.url) {diff --git a/src/locales/en.yml b/src/locales/en.ymlindex 5ea4c93..b52f9e0 100644--- a/src/locales/en.yml+++ b/src/locales/en.yml@@ -45,7 +45,7 @@ library:guideme:live: Liveroadblock: "We hit a roadblock. Try taking action on the screen to move forward."- manualStep: "This step was edited, so it cannot be detected automatically. Mark it complete when you are done."+ manualStep: "This step was edited, so it can't be detected automatically — use Next once you've done it."stepOf: "Step $1 of $2"noDescription: No descriptionprev: Prevdiff --git a/src/locales/es.yml b/src/locales/es.ymlindex 341d4b5..ee085dd 100644--- a/src/locales/es.yml+++ b/src/locales/es.yml@@ -45,7 +45,7 @@ library:guideme:live: En vivoroadblock: "Nos encontramos con un obstáculo. Actúa en la pantalla para avanzar."- manualStep: "Este paso fue editado, así que no se puede detectar automáticamente. Márcalo como completado cuando termines."+ manualStep: "Este paso fue editado, así que no se puede detectar automáticamente: usa Siguiente cuando lo hayas hecho."stepOf: "Paso $1 de $2"noDescription: Sin descripciónprev: Anteriordiff --git a/src/locales/fr.yml b/src/locales/fr.ymlindex a0518c4..6351f96 100644--- a/src/locales/fr.yml+++ b/src/locales/fr.yml@@ -45,7 +45,7 @@ library:guideme:live: En directroadblock: "Nous avons rencontré un obstacle. Agissez à l'écran pour continuer."- manualStep: "Cette étape a été modifiée, elle ne peut donc pas être détectée automatiquement. Marquez-la comme terminée une fois faite."+ manualStep: "Cette étape a été modifiée, elle ne peut donc pas être détectée automatiquement : utilisez Suivant une fois faite."stepOf: "Étape $1 sur $2"noDescription: Aucune descriptionprev: "Préc."diff --git a/src/locales/pt-BR.yml b/src/locales/pt-BR.ymlindex 043e442..9d8abe4 100644--- a/src/locales/pt-BR.yml+++ b/src/locales/pt-BR.yml@@ -45,7 +45,7 @@ library:guideme:live: Ao vivoroadblock: "Encontramos um obstáculo. Aja na tela para avançar."- manualStep: "Esta etapa foi editada, então não pode ser detectada automaticamente. Marque como concluída quando terminar."+ manualStep: "Esta etapa foi editada, então não pode ser detectada automaticamente: use Próximo quando terminar."stepOf: "Passo $1 de $2"noDescription: Sem descriçãoprev: Anteriordiff --git a/src/ui/sidepanel/GuideMeView.tsx b/src/ui/sidepanel/GuideMeView.tsxindex 21fbf9b..b882b96 100644--- a/src/ui/sidepanel/GuideMeView.tsx+++ b/src/ui/sidepanel/GuideMeView.tsx@@ -1,8 +1,9 @@import { ArrowLeft, Check, ChevronLeft, ChevronRight, TriangleAlert } from 'lucide-react';import { useCallback, useEffect, useState } from 'react';import { browser, i18n } from '#imports';+import { stepRequiresManual } from '@/core/guideme/manual';import type { GuideMeSession } from '@/core/guideme/session';-import { BLOCKED_KEY, MANUAL_KEY, SESSION_KEY } from '@/core/guideme/session';+import { BLOCKED_KEY, SESSION_KEY } from '@/core/guideme/session';import { getGuide } from '@/core/guides/service';import type { Guide, Screenshot, Step } from '@/core/guides/types';import { sendMessage } from '@/lib/messaging';@@ -70,7 +71,6 @@ export default function GuideMeView({ guideId, onExit, onComplete }: GuideMeViewconst [viewedStepIndex, setViewedStepIndex] = useState(0);const [showExitConfirm, setShowExitConfirm] = useState(false);const [blockedStepIndex, setBlockedStepIndex] = useState<number | null>(null);- const [isManualStep, setIsManualStep] = useState(false);const loadGuide = useCallback(async () => {const result = await getGuide(guideId);@@ -91,9 +91,6 @@ export default function GuideMeView({ guideId, onExit, onComplete }: GuideMeViewif (changes[BLOCKED_KEY]) {setBlockedStepIndex((changes[BLOCKED_KEY].newValue as number | null) ?? null);}- if (changes[MANUAL_KEY]) {- setIsManualStep(changes[MANUAL_KEY].newValue === true);- }if (!changes[SESSION_KEY]) return;const session = changes[SESSION_KEY].newValue as GuideMeSession | null;if (!session) return;@@ -110,14 +107,13 @@ export default function GuideMeView({ guideId, onExit, onComplete }: GuideMeView}, [guideId, onComplete]);useEffect(() => {- browser.storage.local.get([SESSION_KEY, BLOCKED_KEY, MANUAL_KEY]).then((result: Record<string, unknown>) => {+ browser.storage.local.get([SESSION_KEY, BLOCKED_KEY]).then((result: Record<string, unknown>) => {const session = result[SESSION_KEY] as GuideMeSession | null;if (session?.active) {setActiveStepIndex(session.activeStepIndex);setViewedStepIndex(session.activeStepIndex);}setBlockedStepIndex((result[BLOCKED_KEY] as number | null) ?? null);- setIsManualStep(result[MANUAL_KEY] === true);});}, []);@@ -128,8 +124,12 @@ export default function GuideMeView({ guideId, onExit, onComplete }: GuideMeViewif (!data) return <p className="text-sm text-purple p-4">{i18n.t('guideme.guideNotFound')}</p>;const totalSteps = data.steps.length;- const isBlocked =- blockedStepIndex !== null && blockedStepIndex === activeStepIndex && viewedStepIndex === activeStepIndex;+ const viewedIsManual = viewedStep ? stepRequiresManual(viewedStep, viewedScreenshot) : false;+ const showRoadblock =+ !viewedIsManual &&+ blockedStepIndex !== null &&+ blockedStepIndex === activeStepIndex &&+ viewedStepIndex === activeStepIndex;return (<div className="min-h-screen bg-card flex flex-col relative">@@ -190,10 +190,10 @@ export default function GuideMeView({ guideId, onExit, onComplete }: GuideMeView/>)}- {isBlocked && (+ {(viewedIsManual || showRoadblock) && (<p className="mx-4 mb-3 flex items-start gap-2 rounded-lg bg-secondary p-3 text-[12px] leading-relaxed text-foreground"><TriangleAlert size={14} className="shrink-0 mt-0.5 text-accent" />- {isManualStep ? i18n.t('guideme.manualStep') : i18n.t('guideme.roadblock')}+ {viewedIsManual ? i18n.t('guideme.manualStep') : i18n.t('guideme.roadblock')}</p>)}