π¬ 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
import { logger } from '@mimik/core/logger';
import { i18n } from '#imports';
import { extractDOMContext } from '@/core/capture/dom/context';
import { extractElementMeta, type FrozenRect, freezeRect } from '@/core/capture/dom/element-meta';
import { getFieldLabel, getFieldValue, isRedactedField, isSensitiveField } from '@/core/capture/dom/element-utils';
import { locateFrame, placeInTab } from '@/core/capture/dom/frame-placement';
import type { CaptureSink } from '@/core/capture/sink';
import { typedTitle } from '@/core/capture/typed-title';
export class InputSession {
stepId: string | null = null;
target: HTMLElement | null = null;
private guideId: string;
private atEvent: FrozenRect | undefined;
constructor(
guideId: string,
private sink: CaptureSink,
) {
this.guideId = guideId;
}
get active() {
return this.stepId !== null;
}
async start(target: HTMLElement, atEvent?: FrozenRect) {
this.atEvent = atEvent;
const placement = locateFrame();
const elementMeta = extractElementMeta(target, atEvent);
const res = await this.sink.captureStep({
guideId: this.guideId,
action: 'input',
elementMeta: placeInTab(elementMeta, await placement),
domContext: extractDOMContext(target, 'input'),
});
if ('stepId' in res) {
this.stepId = res.stepId;
this.target = target;
}
}
update(target: HTMLElement) {
if (!this.stepId) return;
this.atEvent = freezeRect(target);
const field = getFieldLabel(target);
const label = field ?? i18n.t('steps.textField');
if (isSensitiveField(target) || isRedactedField(target)) {
const description = isSensitiveField(target) ? i18n.t('steps.typeSecret') : i18n.t('steps.typeInto', [label]);
this.sink
.updateInputStep({ stepId: this.stepId, description })
.catch((err) => logger.warn('Failed to update input step', err));
return;
}
const val = getFieldValue(target);
const desc = val ? typedTitle(val, field) : i18n.t('steps.clearField', [label]);
this.sink
.updateInputStep({ stepId: this.stepId, description: desc, inputValue: val || undefined })
.catch((err) => logger.warn('Failed to update input step', err));
}
async finalize() {
if (!this.target || !this.stepId) return;
const target = this.target;
const stepId = this.stepId;
const atEvent = this.atEvent;
this.stepId = null;
this.target = null;
this.atEvent = undefined;
const placement = locateFrame();
const elementMeta = extractElementMeta(target, atEvent);
await this.sink.finalizeInputStep({
stepId,
elementMeta: placeInTab(elementMeta, await placement),
domContext: extractDOMContext(target, 'input'),
});
}
}