🎬 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(desktop): capture more steps from the + between steps
Luis Ortiz8cbfa251942d
diff --git a/apps/desktop/scripts/check-pipeline.ts b/apps/desktop/scripts/check-pipeline.tsindex 46b0a72..cf40567 100644--- a/apps/desktop/scripts/check-pipeline.ts+++ b/apps/desktop/scripts/check-pipeline.ts@@ -602,6 +602,45 @@ app.whenReady().then(async () => {} catch (error) {titled = error instanceof Error ? error.message : String(error);}+ let merged = 'no reply';+ try {+ const labelled = (guide: string, ariaLabel: string) =>+ ask(app_.webContents, 'mimik:capture:step', {+ guideId: guide,+ action: 'click',+ elementMeta: {+ source: 'screen',+ textContent: null,+ ariaLabel,+ placeholder: null,+ altText: null,+ name: null,+ role: 'button',+ rect: { x: 0, y: 0, width: 10, height: 10 },+ devicePixelRatio: 1,+ },+ }, 20_000);+ const target = await ask<string>(app_.webContents, 'mimik:capture:startGuide', false, 20_000);+ await labelled(target, 'First');+ await labelled(target, 'Third');+ const before = await ask<string | null>(win.webContents, 'mimik:check:title', target, 20_000);+ const staging = await ask<string>(app_.webContents, 'mimik:capture:startGuide', true, 20_000);+ await labelled(staging, 'Second');+ await ask(app_.webContents, 'mimik:capture:insertGuide', { guideId: staging, targetGuideId: target, atIndex: 1 }, 20_000);+ const order = (await ask<string[] | null>(win.webContents, 'mimik:check:steps', target, 20_000)) ?? [];+ const left = await ask<string[] | null>(win.webContents, 'mimik:check:steps', staging, 20_000);+ const after = await ask<string | null>(win.webContents, 'mimik:check:title', target, 20_000);+ merged = `${order.map((text) => text.match(/First|Second|Third/)?.[0] ?? text).join(', ')}; staging ${left === null ? 'gone' : 'left behind'}; title ${after === before ? 'kept' : `changed to ${after}`}`;+ await ask(app_.webContents, 'mimik:check:cleanup', [target, staging], 20_000).catch(() => undefined);+ } catch (error) {+ merged = error instanceof Error ? error.message : String(error);+ }+ results.push({+ name: 'more steps land where the + was',+ ok: merged === 'First, Second, Third; staging gone; title kept',+ detail: merged,+ });+results.push({name: 'stopping names the guide',ok: titled.length > 0 && titled !== 'Untitled Guide' && !titled.includes('untitledGuide'),diff --git a/apps/desktop/src/main/capture/insert.ts b/apps/desktop/src/main/capture/insert.tsnew file mode 100644index 0000000..f1133af--- /dev/null+++ b/apps/desktop/src/main/capture/insert.ts@@ -0,0 +1,5 @@+export interface CaptureInsert {+ guideId: string;+ atIndex: number;+ afterStep: number;+}diff --git a/apps/desktop/src/main/index.ts b/apps/desktop/src/main/index.tsindex fab4432..5d4d9d1 100644--- a/apps/desktop/src/main/index.ts+++ b/apps/desktop/src/main/index.ts@@ -3,6 +3,7 @@ import { app, BrowserWindow, dialog, ipcMain, Menu, nativeImage, protocol, screeimport { registerAiFetch } from './ai-fetch';import { ask } from './ask';import { focusedWindow } from './capture/focused-window';+import type { CaptureInsert } from './capture/insert';import { DesktopRecorder, frameFor } from './capture/recorder';import { registerScreenshotProtocol, SCREENSHOT_SCHEME, sweepScreenshots } from './capture/screenshot-store';import { type CaptureMode, type CaptureSettings, loadSettings, saveSettings } from './capture/settings';@@ -15,6 +16,7 @@ let tray: Tray | null = null;let overlay: CaptureOverlay | null = null;let recorder: DesktopRecorder | null = null;let guideId: string | null = null;+let insert: CaptureInsert | null = null;let captureSettings: CaptureSettings | null = null;let steps: OverlayStep[] = [];@@ -174,7 +176,10 @@ function refreshTrayMenu(): void {{label: 'Set capture area',click: () => {- if (!isCapturing()) enterCapture();+ if (!isCapturing()) {+ insert = null;+ enterCapture();+ }overlay?.edit();},},@@ -217,7 +222,10 @@ function applyShortcuts(): void {function onShortcut(name: ShortcutName): void {if (!overlay) return;if (name === 'startStop') {- if (overlay.state === 'hidden') enterCapture();+ if (overlay.state === 'hidden') {+ insert = null;+ enterCapture();+ }overlay.run(overlay.state === 'hidden' || overlay.state === 'armed' ? 'start' : 'stop');return;}@@ -250,7 +258,7 @@ async function onOverlayCommand(command: OverlayCommand): Promise<void> {steps = [];overlay?.setAiFailure(null);try {- guideId = await ask<string>(mainWindow?.webContents ?? null, 'mimik:capture:startGuide');+ guideId = await ask<string>(mainWindow?.webContents ?? null, 'mimik:capture:startGuide', insert !== null);} catch (error) {overlay?.hide();dialog.showErrorBox('Mimik cannot record', error instanceof Error ? error.message : String(error));@@ -270,11 +278,23 @@ async function onOverlayCommand(command: OverlayCommand): Promise<void> {} else if (command === 'stop' || command === 'cancel') {recorder?.stop();await recorder?.drain();- if (command === 'stop' && steps.length > 0) finished = guideId;- if (finished) {- await ask(mainWindow?.webContents ?? null, 'mimik:capture:finishGuide', finished, 45_000).catch(- () => undefined,- );+ const target = insert;+ insert = null;+ if (guideId && target) {+ await ask(+ mainWindow?.webContents ?? null,+ 'mimik:capture:insertGuide',+ { guideId, targetGuideId: target.guideId, atIndex: target.atIndex },+ 45_000,+ ).catch(() => undefined);+ if (command === 'stop' && steps.length > 0) finished = target.guideId;+ } else {+ if (command === 'stop' && steps.length > 0) finished = guideId;+ if (finished) {+ await ask(mainWindow?.webContents ?? null, 'mimik:capture:finishGuide', finished, 45_000).catch(+ () => undefined,+ );+ }}guideId = null;}@@ -355,7 +375,7 @@ if (!app.requestSingleInstanceLock()) {if (reply?.stepId && reply.title) {const step: OverlayStep = {id: reply.stepId,- index: steps.length + 1,+ index: steps.length + 1 + (insert?.afterStep ?? 0),title: reply.title,src: request.image.src,source: 'heuristic',@@ -396,11 +416,13 @@ if (!app.requestSingleInstanceLock()) {},);ipcMain.handle('mimik:capture:region', () => overlay?.region);- ipcMain.handle('mimik:capture:edit', () => {+ ipcMain.handle('mimik:capture:edit', (_event, target?: CaptureInsert) => {+ insert = target ?? null;enterCapture();overlay?.edit();});- ipcMain.handle('mimik:capture:arm', () => {+ ipcMain.handle('mimik:capture:arm', (_event, target?: CaptureInsert) => {+ insert = target ?? null;enterCapture();overlay?.arm();});diff --git a/apps/desktop/src/preload/index.ts b/apps/desktop/src/preload/index.tsindex 07fe9b0..2e68f32 100644--- a/apps/desktop/src/preload/index.ts+++ b/apps/desktop/src/preload/index.ts@@ -1,4 +1,5 @@import { contextBridge, ipcRenderer } from 'electron';+import type { CaptureInsert } from '../main/capture/insert';import type { CaptureSettings } from '../main/capture/settings';import type { OverlayAiFailure } from '../main/overlay';@@ -13,8 +14,8 @@ const api = {version: (): Promise<string> => ipcRenderer.invoke('mimik:version'),capture: {region: (): Promise<Region> => ipcRenderer.invoke('mimik:capture:region'),- edit: (): Promise<void> => ipcRenderer.invoke('mimik:capture:edit'),- arm: (): Promise<void> => ipcRenderer.invoke('mimik:capture:arm'),+ edit: (insert?: CaptureInsert): Promise<void> => ipcRenderer.invoke('mimik:capture:edit', insert),+ arm: (insert?: CaptureInsert): Promise<void> => ipcRenderer.invoke('mimik:capture:arm', insert),described: (stepId: string, description: string | null, failure: OverlayAiFailure | null): void =>ipcRenderer.send('mimik:capture:described', stepId, description, failure),settings: {diff --git a/apps/desktop/src/renderer/App.tsx b/apps/desktop/src/renderer/App.tsxindex 0a9d2af..6f006bc 100644--- a/apps/desktop/src/renderer/App.tsx+++ b/apps/desktop/src/renderer/App.tsx@@ -1,5 +1,6 @@import { GuideContent, LibraryContent, navigate, SearchModal, TooltipProvider, TopNav, useRoute } from '@mimik/ui';import { useEffect, useState } from 'react';+import type { CaptureInsert } from '../main/capture/insert';import { CaptureSheet } from './CaptureSheet';import { GuideZoom } from './GuideZoom';import { REOPEN_SETTINGS } from './settings/lib/reopen-settings';@@ -8,19 +9,20 @@ import { SettingsDialog } from './settings/SettingsDialog';export function App() {const route = useRoute();const [settingsOpen, setSettingsOpen] = useState(() => sessionStorage.getItem(REOPEN_SETTINGS) !== null);- const [sheetOpen, setSheetOpen] = useState(false);+ const [sheet, setSheet] = useState<{ insert?: CaptureInsert } | null>(null);+ const [guideKey, setGuideKey] = useState(0);useEffect(() => {window.mimik.capture.onCommand((command, _state, _region, id) => {if (command !== 'stop' || !id) return;setSettingsOpen(false);- setSheetOpen(false);+ setSheet(null);navigate({ page: 'guide', guideId: id });+ setGuideKey((n) => n + 1);});}, []);const library = route.page === 'library';- const [guideKey, setGuideKey] = useState(0);return (<TooltipProvider>@@ -42,17 +44,18 @@ export function App() {guideId={route.guideId}initialStepId={route.stepId}initialTool={route.tool}+ onCaptureMore={(insert) => setSheet({ insert })}/></div></main>) : (<main className="flex-1 py-8 px-6">- <LibraryContent category={route.category} onStartCapture={() => setSheetOpen(true)} />+ <LibraryContent category={route.category} onStartCapture={() => setSheet({})} /></main>)}<SearchModal /><SettingsDialog open={settingsOpen} onOpenChange={setSettingsOpen} />- {sheetOpen && <CaptureSheet onClose={() => setSheetOpen(false)} />}+ {sheet && <CaptureSheet insert={sheet.insert} onClose={() => setSheet(null)} />}</div></TooltipProvider>);diff --git a/apps/desktop/src/renderer/CaptureSheet.tsx b/apps/desktop/src/renderer/CaptureSheet.tsxindex 07be8df..f268956 100644--- a/apps/desktop/src/renderer/CaptureSheet.tsx+++ b/apps/desktop/src/renderer/CaptureSheet.tsx@@ -2,6 +2,7 @@ import { i18n } from '@mimik/core/env';import { Button } from '@mimik/ui';import { AppWindow, Crop, Monitor, Video, X } from 'lucide-react';import { useEffect, useState } from 'react';+import type { CaptureInsert } from '../main/capture/insert';import type { CaptureSettings } from '../main/capture/settings';type Mode = CaptureSettings['captureMode'];@@ -12,7 +13,7 @@ const MODES: { id: Mode; label: string; Icon: typeof AppWindow }[] = [{ id: 'region', label: 'desktop_modeRegion', Icon: Crop },];-export function CaptureSheet({ onClose }: { onClose(): void }) {+export function CaptureSheet({ insert, onClose }: { insert?: CaptureInsert; onClose(): void }) {const [settings, setSettings] = useState<CaptureSettings | null>(null);useEffect(() => {@@ -33,8 +34,8 @@ export function CaptureSheet({ onClose }: { onClose(): void }) {const start = async () => {onClose();- if (settings?.captureMode === 'region') await window.mimik.capture.edit();- else await window.mimik.capture.arm();+ if (settings?.captureMode === 'region') await window.mimik.capture.edit(insert);+ else await window.mimik.capture.arm(insert);};return (@@ -47,8 +48,19 @@ export function CaptureSheet({ onClose }: { onClose(): void }) {/><aside className="relative flex h-full w-[416px] flex-col border-l border-border bg-card shadow-2xl">- <div className="flex items-center border-b border-secondary px-6 pb-4 pt-5">- <h2 className="mr-auto text-base font-semibold text-foreground">{i18n.t('desktop_startSheetTitle')}</h2>+ <div className={`flex border-b border-secondary px-6 pb-4 pt-5 ${insert ? 'items-start' : 'items-center'}`}>+ <div className="mr-auto flex flex-col gap-1">+ <h2 className="text-base font-semibold text-foreground">+ {i18n.t(insert ? 'capture_moreStepsTitle' : 'desktop_startSheetTitle')}+ </h2>+ {insert && (+ <p className="text-[12.5px] text-muted-foreground">+ {insert.afterStep === 0+ ? i18n.t('desktop_moreStepsFirst')+ : i18n.t('desktop_moreStepsAfter', [String(insert.afterStep)])}+ </p>+ )}+ </div><buttontype="button"aria-label={i18n.t('common_close')}diff --git a/apps/desktop/src/renderer/capture-host.ts b/apps/desktop/src/renderer/capture-host.tsindex 3a55d07..2f7443b 100644--- a/apps/desktop/src/renderer/capture-host.ts+++ b/apps/desktop/src/renderer/capture-host.ts@@ -3,8 +3,10 @@ import type { CaptureStepData } from '@mimik/core/capture/sink';import { i18n } from '@mimik/core/env';import {allScreenshotIds,+ createSnapshot,deleteStep,getStepsForGuide,+ mergeGuideInto,permanentlyDeleteGuide,updateGuideDescription,updateGuideTitle,@@ -16,7 +18,7 @@ const sink = new DesktopCaptureSink();allScreenshotIds().then((ids) => window.mimik.screenshots.sweep(ids));-window.mimik.onRequest('mimik:capture:startGuide', () => sink.startGuide());+window.mimik.onRequest('mimik:capture:startGuide', (payload) => sink.startGuide(payload === true));window.mimik.onRequest('mimik:capture:step', (payload) => sink.captureStep(payload as CaptureStepData));window.mimik.onRequest('mimik:capture:removeStep', async (payload) => {@@ -38,6 +40,14 @@ window.mimik.onRequest('mimik:capture:finishGuide', async (payload) => {return true;});+window.mimik.onRequest('mimik:capture:insertGuide', async (payload) => {+ const { guideId, targetGuideId, atIndex } = payload as { guideId: string; targetGuideId: string; atIndex: number };+ await settleDescriptions(guideId);+ await createSnapshot(targetGuideId);+ await mergeGuideInto(guideId, targetGuideId, atIndex);+ return true;+});+window.mimik.onRequest('mimik:check:cleanup', async (payload) => {for (const id of payload as string[]) await permanentlyDeleteGuide(id);return true;diff --git a/apps/desktop/src/renderer/capture-sink.ts b/apps/desktop/src/renderer/capture-sink.tsindex 9146ad9..602ef7c 100644--- a/apps/desktop/src/renderer/capture-sink.ts+++ b/apps/desktop/src/renderer/capture-sink.ts@@ -29,8 +29,8 @@ export type DesktopCaptureStepData = CaptureStepData & {};export class DesktopCaptureSink implements CaptureSink {- async startGuide(): Promise<string> {- const guide = await createGuide(crypto.randomUUID());+ async startGuide(staging = false): Promise<string> {+ const guide = await createGuide(crypto.randomUUID(), staging);return guide.id;}diff --git a/apps/desktop/src/renderer/check-pipeline.ts b/apps/desktop/src/renderer/check-pipeline.tsindex 273731c..fdd4ec4 100644--- a/apps/desktop/src/renderer/check-pipeline.ts+++ b/apps/desktop/src/renderer/check-pipeline.ts@@ -40,6 +40,11 @@ window.mimik.onRequest('mimik:check:cleanup', async (payload) => {return true;});+window.mimik.onRequest('mimik:check:steps', async (payload) => {+ const found = await getGuide(payload as string);+ return found ? found.steps.map((step) => step.description) : null;+});+window.mimik.onRequest('mimik:check:title', async (payload) => {const found = await getGuide(payload as string);return found?.guide.title ?? null;diff --git a/packages/ui/src/guide/components/GuideContent.tsx b/packages/ui/src/guide/components/GuideContent.tsxindex 587f586..008cd2c 100644--- a/packages/ui/src/guide/components/GuideContent.tsx+++ b/packages/ui/src/guide/components/GuideContent.tsx@@ -35,6 +35,7 @@ interface GuideContentProps {guideId: string;initialStepId?: string;initialTool?: 'annotate' | 'redact' | 'crop' | 'target';+ onCaptureMore?: (target: { guideId: string; atIndex: number; afterStep: number }) => void;}interface GuideData {@@ -43,7 +44,7 @@ interface GuideData {screenshots: Map<string, Screenshot>;}-export function GuideContent({ guideId, initialStepId, initialTool }: GuideContentProps) {+export function GuideContent({ guideId, initialStepId, initialTool, onCaptureMore }: GuideContentProps) {const {setGuideTitle,setGuideStepCount,@@ -441,6 +442,7 @@ export function GuideContent({ guideId, initialStepId, initialTool }: GuideContepanel.open();void tabs.startInsertRecording(targetGuideId, insertAtIndex, tabId);}}+ onCaptureMore={onCaptureMore && ((atIndex, afterStep) => onCaptureMore({ guideId, atIndex, afterStep }))}/></div>diff --git a/packages/ui/src/guide/components/GuideStepList.tsx b/packages/ui/src/guide/components/GuideStepList.tsxindex 606ff6a..4665f4b 100644--- a/packages/ui/src/guide/components/GuideStepList.tsx+++ b/packages/ui/src/guide/components/GuideStepList.tsx@@ -27,6 +27,7 @@ interface GuideStepListProps {onChanged?: () => void;hasApiKey?: boolean;onInsertRecording?: (guideId: string, insertAtIndex: number, tabId: number) => void;+ onCaptureMore?: (atIndex: number, afterStep: number) => void;}export function GuideStepList({@@ -41,6 +42,7 @@ export function GuideStepList({onChanged,hasApiKey,onInsertRecording,+ onCaptureMore,}: GuideStepListProps) {const { scrollToStepId, setActiveStepId, bumpHistoryRefresh } = useFullview((s) => ({scrollToStepId: s.scrollToStepId,@@ -57,6 +59,13 @@ export function GuideStepList({const stepRefs = useRef<Map<string, HTMLDivElement>>(new Map());const frameRatio = dominantRatio(screenshots);const numbers = stepNumbers(steps);+ const recordAt =+ onCaptureMore || onInsertRecording+ ? (atIndex: number) => () =>+ onCaptureMore+ ? onCaptureMore(atIndex, steps.slice(0, atIndex).filter((step) => !isBlock(step)).length)+ : setRecordAtIndex(atIndex)+ : undefined;useEffect(() => {if (scrollToStepId) {@@ -167,10 +176,7 @@ export function GuideStepList({<div className="flex flex-col"><EmptyGuideState />{!readOnly && (- <InsertBlockMenu- onInsert={(blockType) => handleInsertBlock(0, blockType)}- onRecord={onInsertRecording && (() => setRecordAtIndex(0))}- />+ <InsertBlockMenu onInsert={(blockType) => handleInsertBlock(0, blockType)} onRecord={recordAt?.(0)} />)}{captureDialog}</div>@@ -180,10 +186,7 @@ export function GuideStepList({return (<div className="space-y-6">{!readOnly && (- <InsertBlockMenu- onInsert={(blockType) => handleInsertBlock(0, blockType)}- onRecord={onInsertRecording && (() => setRecordAtIndex(0))}- />+ <InsertBlockMenu onInsert={(blockType) => handleInsertBlock(0, blockType)} onRecord={recordAt?.(0)} />)}{steps.map((step, idx) => (<div@@ -239,7 +242,7 @@ export function GuideStepList({{!readOnly && (<InsertBlockMenuonInsert={(blockType) => handleInsertBlock(idx + 1, blockType)}- onRecord={onInsertRecording && (() => setRecordAtIndex(idx + 1))}+ onRecord={recordAt?.(idx + 1)}/>)}</div>diff --git a/src/locales/de.yml b/src/locales/de.ymlindex 6a9cbc4..49137a4 100644--- a/src/locales/de.yml+++ b/src/locales/de.yml@@ -167,6 +167,8 @@ desktop:modeScreen: BildschirmmodeRegion: BereichstartSheetTitle: Aufnahme starten+ moreStepsAfter: "Neue Schritte werden nach Schritt $1 eingefügt."+ moreStepsFirst: "Neue Schritte werden vor Schritt 1 eingefügt."startButton: StartenshortcutsSection: "Tastenkürzel"generalSection: "Allgemein"diff --git a/src/locales/en.yml b/src/locales/en.ymlindex a9e0434..62e159b 100644--- a/src/locales/en.yml+++ b/src/locales/en.yml@@ -167,6 +167,8 @@ desktop:modeScreen: ScreenmodeRegion: AreastartSheetTitle: Start a capture+ moreStepsAfter: "New steps are inserted after step $1."+ moreStepsFirst: "New steps are inserted before step 1."startButton: StartshortcutsSection: "Shortcuts"generalSection: "General"diff --git a/src/locales/es.yml b/src/locales/es.ymlindex 9f3afbc..af2b441 100644--- a/src/locales/es.yml+++ b/src/locales/es.yml@@ -167,6 +167,8 @@ desktop:modeScreen: PantallamodeRegion: ÁreastartSheetTitle: Iniciar una captura+ moreStepsAfter: "Los nuevos pasos se insertan después del paso $1."+ moreStepsFirst: "Los nuevos pasos se insertan antes del paso 1."startButton: IniciarshortcutsSection: "Atajos"generalSection: "General"diff --git a/src/locales/fr.yml b/src/locales/fr.ymlindex a1c7110..efb0119 100644--- a/src/locales/fr.yml+++ b/src/locales/fr.yml@@ -167,6 +167,8 @@ desktop:modeScreen: ÉcranmodeRegion: ZonestartSheetTitle: Démarrer une capture+ moreStepsAfter: "Les nouvelles étapes sont insérées après l'étape $1."+ moreStepsFirst: "Les nouvelles étapes sont insérées avant l'étape 1."startButton: DémarrershortcutsSection: "Raccourcis"generalSection: "Général"diff --git a/src/locales/pt-BR.yml b/src/locales/pt-BR.ymlindex d80047f..cb4ae04 100644--- a/src/locales/pt-BR.yml+++ b/src/locales/pt-BR.yml@@ -167,6 +167,8 @@ desktop:modeScreen: TelamodeRegion: ÁreastartSheetTitle: Iniciar uma captura+ moreStepsAfter: "As novas etapas entram depois da etapa $1."+ moreStepsFirst: "As novas etapas entram antes da etapa 1."startButton: IniciarshortcutsSection: "Atalhos"generalSection: "Geral"diff --git a/src/locales/zh-CN.yml b/src/locales/zh-CN.ymlindex 01a4e7b..47800ec 100644--- a/src/locales/zh-CN.yml+++ b/src/locales/zh-CN.yml@@ -167,6 +167,8 @@ desktop:modeScreen: 屏幕modeRegion: 区域startSheetTitle: 开始捕获+ moreStepsAfter: "新步骤会插入到第 $1 步之后。"+ moreStepsFirst: "新步骤会插入到第 1 步之前。"startButton: 开始shortcutsSection: "快捷键"generalSection: "通用"