π¬ 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): add capture settings to the desktop window
Luis Ortiz03de7d1b6502
diff --git a/apps/desktop/scripts/check-pipeline.ts b/apps/desktop/scripts/check-pipeline.tsindex 07e9fcd..7ca2c18 100644--- a/apps/desktop/scripts/check-pipeline.ts+++ b/apps/desktop/scripts/check-pipeline.ts@@ -1,8 +1,9 @@import { join } from 'node:path';import { app, BrowserWindow, nativeImage, screen } from 'electron';import { ask } from '../src/main/ask';-import { DesktopRecorder } from '../src/main/capture/recorder';+import { DesktopRecorder, shouldCapture } from '../src/main/capture/recorder';import { clampToDisplays } from '../src/main/capture/region';+import { DEFAULT_CAPTURE_SETTINGS, loadSettings, normaliseSettings, saveSettings } from '../src/main/capture/settings';import type { Capture } from '../src/main/capture/screenshot';interface CheckResult {@@ -46,18 +47,74 @@ app.whenReady().then(async () => {return Promise.resolve({ png: image.toPNG(), width, height, scaleFactor: scale, displayId });}+ let settings = { ...DEFAULT_CAPTURE_SETTINGS, showCursor: false };+ let activeGuide = '';const recorder = new DesktopRecorder(() => region,(fn) => fn(),- (request) => ask(win.webContents, 'mimik:capture:step', { ...request, guideId }),+ (request) => ask(win.webContents, 'mimik:capture:step', { ...request, guideId: activeGuide }),syntheticDisplay,+ () => settings,);- const guideId = await ask<string>(win.webContents, 'mimik:capture:startGuide');++ activeGuide = await ask<string>(win.webContents, 'mimik:capture:startGuide');+ const guideId = activeGuide;await recorder.capture({ x: region.x + 120, y: region.y + 90 });await recorder.capture({ x: region.x + 400, y: region.y + 300 });const results = await ask<CheckResult[]>(win.webContents, 'mimik:check:verify', guideId, 60_000);+ const userSettings = loadSettings();+ const clamped = normaliseSettings({ screenshotDelayMs: 5000, cursorStyle: 'wobble' as never });+ const stored = saveSettings({ screenshotDelayMs: 750, captureOutsideClicks: true });+ const reloaded = loadSettings();+ results.push({+ name: 'settings clamp and persist',+ ok:+ clamped.screenshotDelayMs === 2000 &&+ clamped.cursorStyle === DEFAULT_CAPTURE_SETTINGS.cursorStyle &&+ reloaded.screenshotDelayMs === 750 &&+ reloaded.captureOutsideClicks === stored.captureOutsideClicks,+ detail: `5000 ms clamped to ${clamped.screenshotDelayMs}, unknown style fell back to ${clamped.cursorStyle}, 750 ms reloaded as ${reloaded.screenshotDelayMs}`,+ });+ saveSettings(userSettings);++ const outsidePoint = { x: region.x + region.width + 40, y: region.y + 20 };+ results.push({+ name: 'outside clicks are opt in',+ ok:+ !shouldCapture({ ...DEFAULT_CAPTURE_SETTINGS, captureOutsideClicks: false }, region, outsidePoint) &&+ shouldCapture({ ...DEFAULT_CAPTURE_SETTINGS, captureOutsideClicks: true }, region, outsidePoint) &&+ shouldCapture({ ...DEFAULT_CAPTURE_SETTINGS, captureOutsideClicks: false }, region, {+ x: region.x + 10,+ y: region.y + 10,+ }),+ detail: 'ignored when off, captured when on, inside always captured',+ });++ activeGuide = await ask<string>(win.webContents, 'mimik:capture:startGuide');++ settings = { ...DEFAULT_CAPTURE_SETTINGS, screenshotDelayMs: 400, showCursor: false };+ const before = Date.now();+ await recorder.capture({ x: region.x + 10, y: region.y + 10 });+ const elapsed = Date.now() - before;+ results.push({+ name: 'screenshot delay is honoured',+ ok: elapsed >= 400,+ detail: `${elapsed} ms for a 400 ms delay`,+ });++ settings = { ...DEFAULT_CAPTURE_SETTINGS, showCursor: true, cursorStyle: 'arrow', screenshotDelayMs: 0 };+ await recorder.capture({ x: region.x + 200, y: region.y + 150 });+ const cursorSizes = await ask<number[]>(win.webContents, 'mimik:check:blobSizes', activeGuide, 30_000);+ results.push({+ name: 'cursor is drawn into the frame',+ ok: cursorSizes.length >= 2 && cursorSizes[cursorSizes.length - 1] !== cursorSizes[0],+ detail: `${cursorSizes[0]} bytes without a cursor, ${cursorSizes[cursorSizes.length - 1]} bytes with one`,+ });++ await ask(win.webContents, 'mimik:check:cleanup', [guideId, activeGuide], 30_000);+process.stdout.write(`capture area ${region.width} Γ ${region.height} on a ${display.bounds.width} Γ ${display.bounds.height} display at ${display.scaleFactor}x\n\n`,);diff --git a/apps/desktop/src/preload/index.ts b/apps/desktop/src/preload/index.tsindex b8bafde..bb13cf0 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 { CaptureSettings } from '../main/capture/settings';interface Region {x: number;@@ -12,6 +13,11 @@ const api = {capture: {region: (): Promise<Region> => ipcRenderer.invoke('mimik:capture:region'),edit: (): Promise<void> => ipcRenderer.invoke('mimik:capture:edit'),+ settings: {+ get: (): Promise<CaptureSettings> => ipcRenderer.invoke('mimik:capture:settings:get'),+ set: (patch: Partial<CaptureSettings>): Promise<CaptureSettings> =>+ ipcRenderer.invoke('mimik:capture:settings:set', patch),+ },onCommand: (handler: (command: string, state: string, region: Region) => void): void => {ipcRenderer.on('mimik:capture:command', (_event, command: string, state: string, region: Region) =>handler(command, state, region),diff --git a/apps/desktop/src/renderer/check-pipeline.ts b/apps/desktop/src/renderer/check-pipeline.tsindex f65941d..53159bd 100644--- a/apps/desktop/src/renderer/check-pipeline.ts+++ b/apps/desktop/src/renderer/check-pipeline.ts@@ -19,6 +19,17 @@ const sink = new DesktopCaptureSink();window.mimik.onRequest('mimik:capture:startGuide', () => sink.startGuide());window.mimik.onRequest('mimik:capture:step', (payload) => sink.captureStep(payload as CaptureStepData));+window.mimik.onRequest('mimik:check:blobSizes', async (payload) => {+ const found = await getGuide(payload as string);+ if (!found) return [];+ return found.steps.map((step) => found.screenshots.get(step.id)?.blob.size ?? 0);+});++window.mimik.onRequest('mimik:check:cleanup', async (payload) => {+ for (const id of payload as string[]) await permanentlyDeleteGuide(id);+ return true;+});+window.mimik.onRequest('mimik:check:verify', async (payload) => {const guideId = payload as string;const results: CheckResult[] = [];@@ -80,6 +91,5 @@ window.mimik.onRequest('mimik:check:verify', async (payload) => {}}- await permanentlyDeleteGuide(guideId);return results;});diff --git a/apps/desktop/src/renderer/main.ts b/apps/desktop/src/renderer/main.tsindex ecd0b90..174215d 100644--- a/apps/desktop/src/renderer/main.ts+++ b/apps/desktop/src/renderer/main.ts@@ -2,6 +2,7 @@ import './core-env';import { PRESET_LABELS } from '@mimik/core/blur/regexes';import type { CaptureStepData } from '@mimik/core/capture/sink';import { getGuides } from '@mimik/core/guides/service';+import type { CaptureSettings } from '../main/capture/settings';import { DesktopCaptureSink } from './capture-sink';import './style.css';@@ -12,10 +13,11 @@ window.mimik.onRequest('mimik:capture:step', (payload) => sink.captureStep(payloconst root = document.getElementById('root') as HTMLElement;async function render(): Promise<void> {- const [version, atLogin, region] = await Promise.all([+ const [version, atLogin, region, settings] = await Promise.all([window.mimik.version(),window.mimik.openAtLogin.get(),window.mimik.capture.region(),+ window.mimik.capture.settings.get(),]);root.replaceChildren();@@ -60,7 +62,60 @@ async function render(): Promise<void> {void refresh();});- root.append(title, meta, label, area, edit, library, shared);+ const capturing = document.createElement('fieldset');+ const legend = document.createElement('legend');+ legend.textContent = 'Capturing';+ capturing.append(legend);++ let current: CaptureSettings = settings;+ const save = async (patch: Partial<CaptureSettings>) => {+ current = await window.mimik.capture.settings.set(patch);+ style.disabled = !current.showCursor;+ };++ const cursorRow = document.createElement('label');+ const cursorToggle = document.createElement('input');+ cursorToggle.type = 'checkbox';+ cursorToggle.checked = current.showCursor;+ cursorToggle.addEventListener('change', () => save({ showCursor: cursorToggle.checked }));+ cursorRow.append(cursorToggle, document.createTextNode('Show the cursor in screenshots'));++ const styleRow = document.createElement('label');+ const style = document.createElement('select');+ for (const option of ['arrow', 'hand', 'dot'] as const) {+ const node = document.createElement('option');+ node.value = option;+ node.textContent = option;+ node.selected = current.cursorStyle === option;+ style.append(node);+ }+ style.disabled = !current.showCursor;+ style.addEventListener('change', () => save({ cursorStyle: style.value as CaptureSettings['cursorStyle'] }));+ styleRow.append(document.createTextNode('Pointer style'), style);++ const delayRow = document.createElement('label');+ const delay = document.createElement('input');+ delay.type = 'number';+ delay.min = '0';+ delay.max = '2000';+ delay.step = '50';+ delay.value = String(current.screenshotDelayMs);+ delay.addEventListener('change', async () => {+ await save({ screenshotDelayMs: Number(delay.value) });+ delay.value = String(current.screenshotDelayMs);+ });+ delayRow.append(document.createTextNode('Screenshot delay (ms)'), delay);++ const outsideRow = document.createElement('label');+ const outside = document.createElement('input');+ outside.type = 'checkbox';+ outside.checked = current.captureOutsideClicks;+ outside.addEventListener('change', () => save({ captureOutsideClicks: outside.checked }));+ outsideRow.append(outside, document.createTextNode('Capture clicks outside the capture area'));++ capturing.append(cursorRow, styleRow, delayRow, outsideRow);++ root.append(title, meta, label, area, edit, capturing, library, shared);}render();diff --git a/apps/desktop/src/renderer/style.css b/apps/desktop/src/renderer/style.cssindex 2ba4692..274320c 100644--- a/apps/desktop/src/renderer/style.css+++ b/apps/desktop/src/renderer/style.css@@ -27,3 +27,30 @@ label {align-items: center;font-size: 14px;}++fieldset {+ margin: 16px 0 0;+ padding: 12px 16px 16px;+ border: 1px solid var(--border, #c7d2fe);+ border-radius: 10px;+}++legend {+ padding: 0 6px;+ font-size: 12px;+ text-transform: uppercase;+ letter-spacing: 0.08em;+}++fieldset label {+ display: flex;+ align-items: center;+ gap: 8px;+ margin-top: 8px;+}++fieldset select,+fieldset input[type='number'] {+ margin-left: auto;+ padding: 4px 6px;+}