Skip to content

armgit / mimik

Public Imported from GitHub
0

🎬 A browser extension and desktop app that turns your clicks into step-by-step guides with annotated screenshots πŸ“–

feat(fullview): gate guide editing behind an edit mode with version history

Luis Ortizaf5c2671d631
diff --git a/src/stores/fullview.ts b/src/stores/fullview.ts
index 8bc94ba..76c35d0 100644
--- a/src/stores/fullview.ts
+++ b/src/stores/fullview.ts
@@ -34,6 +34,18 @@ interface FullviewStore {
scrollToStep: (stepId: string) => void;
activeStepId: string | null;
setActiveStepId: (id: string | null) => void;
+
+ editing: boolean;
+ setEditing: (editing: boolean) => void;
+ historyOpen: boolean;
+ setHistoryOpen: (open: boolean) => void;
+ historyRefreshKey: number;
+ bumpHistoryRefresh: () => void;
+}
+
+function flushFocusedField() {
+ const el = document.activeElement;
+ if (el instanceof HTMLTextAreaElement || el instanceof HTMLInputElement) el.blur();
}
export const useFullviewStore = create<FullviewStore>((set) => ({
@@ -56,7 +68,12 @@ export const useFullviewStore = create<FullviewStore>((set) => ({
guideStepCount: 0,
setGuideStepCount: (guideStepCount) => set({ guideStepCount }),
guideExportData: null,
- setGuideExportData: (guideExportData) => set({ guideExportData }),
+ setGuideExportData: (guideExportData) =>
+ set((s) =>
+ s.guideExportData?.guideId === guideExportData?.guideId
+ ? { guideExportData }
+ : { guideExportData, editing: false, historyOpen: false, historyRefreshKey: 0 },
+ ),
scrollToStepId: null,
scrollToStep: (stepId) => {
set({ scrollToStepId: stepId });
@@ -64,6 +81,19 @@ export const useFullviewStore = create<FullviewStore>((set) => ({
},
activeStepId: null,
setActiveStepId: (activeStepId) => set({ activeStepId }),
+
+ editing: false,
+ setEditing: (editing) => {
+ if (!editing) flushFocusedField();
+ set({ editing });
+ },
+ historyOpen: false,
+ setHistoryOpen: (historyOpen) => {
+ if (historyOpen) flushFocusedField();
+ set({ historyOpen });
+ },
+ historyRefreshKey: 0,
+ bumpHistoryRefresh: () => set((s) => ({ historyRefreshKey: s.historyRefreshKey + 1 })),
}));
export function useFullview<T>(selector: (s: FullviewStore) => T): T {
diff --git a/src/ui/fullview/App.tsx b/src/ui/fullview/App.tsx
index 31dc4e5..7fe8e27 100644
--- a/src/ui/fullview/App.tsx
+++ b/src/ui/fullview/App.tsx
@@ -8,7 +8,10 @@ import TopNav from './TopNav';
export default function FullViewApp() {
const route = useRoute();
- const { toggleSearch } = useFullview((s) => ({ toggleSearch: s.toggleSearch }));
+ const { toggleSearch, historyOpen } = useFullview((s) => ({
+ toggleSearch: s.toggleSearch,
+ historyOpen: s.historyOpen,
+ }));
useEffect(() => {
const handler = (e: KeyboardEvent) => {
@@ -34,7 +37,7 @@ export default function FullViewApp() {
{route.page === 'guide' && (
<main className="flex-1 py-10 px-6">
- <div className="max-w-[720px] mx-auto">
+ <div className={`mx-auto ${historyOpen ? 'max-w-[1032px]' : 'max-w-[720px]'}`}>
<GuideContent guideId={route.guideId} initialStepId={route.stepId} initialTool={route.tool} />
</div>
</main>
diff --git a/src/ui/fullview/GuideContent.tsx b/src/ui/fullview/GuideContent.tsx
index b812aa9..b2f60ad 100644
--- a/src/ui/fullview/GuideContent.tsx
+++ b/src/ui/fullview/GuideContent.tsx
@@ -1,17 +1,26 @@
-import { Play } from 'lucide-react';
+import { History, Play } from 'lucide-react';
import { useCallback, useEffect, useRef, useState } from 'react';
import { TypeAnimation } from 'react-type-animation';
import { i18n } from '#imports';
-import { deleteStep, getGuide, onGuidesChanged, updateGuideTitle, updateStepDescription } from '@/core/guides/service';
-import type { Guide, Screenshot, Step } from '@/core/guides/types';
+import {
+ deleteStep,
+ getGuide,
+ getScreenshotsForSteps,
+ onGuidesChanged,
+ updateGuideTitle,
+ updateStepDescription,
+} from '@/core/guides/service';
+import type { Guide, Screenshot, Snapshot, Step } from '@/core/guides/types';
import type { ScreenshotEdits } from '@/core/screenshot/types';
import { openSidebar } from '@/lib/browser-api';
+import { logger } from '@/lib/logger';
import { sendMessage } from '@/lib/messaging';
import { formatDate, getMostCommonDomain } from '@/lib/utils';
import { useFullview } from '@/stores/fullview';
import AnnotationEditor from '@/ui/shared/AnnotationEditor';
import FaviconImg from '@/ui/shared/FaviconImg';
import GuideStepList from './components/GuideStepList';
+import VersionHistoryPanel from './components/VersionHistoryPanel';
interface GuideContentProps {
guideId: string;
@@ -25,12 +34,46 @@ interface GuideData {
screenshots: Map<string, Screenshot>;
}
+interface PreviewData {
+ snapshotId: string;
+ steps: Step[];
+ screenshots: Map<string, Screenshot>;
+}
+
+async function buildPreview(snapshot: Snapshot): Promise<PreviewData> {
+ const rows = new Map(snapshot.screenshots.map((row) => [row.id, row]));
+ const steps = [...snapshot.steps].sort((a, b) => a.index - b.index);
+ const wanted = steps.map((s) => s.screenshotId).filter((id): id is string => !!id && rows.has(id));
+ const live = await getScreenshotsForSteps(wanted);
+ const blobs = new Map([...live.values()].map((row) => [row.id, row.blob]));
+ const screenshots = new Map<string, Screenshot>();
+ for (const step of steps) {
+ const row = step.screenshotId ? rows.get(step.screenshotId) : undefined;
+ const blob = row ? blobs.get(row.id) : undefined;
+ if (row && blob) screenshots.set(step.id, { ...row, blob });
+ }
+ return { snapshotId: snapshot.id, steps, screenshots };
+}
+
export default function GuideContent({ guideId, initialStepId, initialTool }: GuideContentProps) {
- const { setGuideTitle, setGuideStepCount, setGuideExportData, scrollToStep } = useFullview((s) => ({
+ const {
+ setGuideTitle,
+ setGuideStepCount,
+ setGuideExportData,
+ scrollToStep,
+ editing,
+ historyOpen,
+ setHistoryOpen,
+ historyRefreshKey,
+ } = useFullview((s) => ({
setGuideTitle: s.setGuideTitle,
setGuideStepCount: s.setGuideStepCount,
setGuideExportData: s.setGuideExportData,
scrollToStep: s.scrollToStep,
+ editing: s.editing,
+ historyOpen: s.historyOpen,
+ setHistoryOpen: s.setHistoryOpen,
+ historyRefreshKey: s.historyRefreshKey,
}));
const [data, setData] = useState<GuideData | null>(null);
@@ -39,6 +82,8 @@ export default function GuideContent({ guideId, initialStepId, initialTool }: Gu
const [typingTitle, setTypingTitle] = useState<string | null>(null);
const [editingStepId, setEditingStepId] = useState<string | null>(null);
const [editingTool, setEditingTool] = useState<'annotate' | 'redact' | 'crop' | 'target'>('annotate');
+ const [preview, setPreview] = useState<Snapshot | null>(null);
+ const [previewData, setPreviewData] = useState<PreviewData | null>(null);
const titleRef = useRef('');
const appliedInitialRef = useRef(false);
@@ -119,6 +164,26 @@ export default function GuideContent({ guideId, initialStepId, initialTool }: Gu
[editingStepId, data],
);
+ useEffect(() => {
+ if (!preview) {
+ setPreviewData(null);
+ return;
+ }
+ let cancelled = false;
+ buildPreview(preview)
+ .then((built) => {
+ if (!cancelled) setPreviewData(built);
+ })
+ .catch((err) => logger.error(' Version preview failed', err));
+ return () => {
+ cancelled = true;
+ };
+ }, [preview]);
+
+ useEffect(() => {
+ if (editing) setPreview(null);
+ }, [editing]);
+
useEffect(() => {
if (appliedInitialRef.current || !data || !initialStepId) return;
if (!data.screenshots.has(initialStepId)) return;
@@ -153,8 +218,14 @@ export default function GuideContent({ guideId, initialStepId, initialTool }: Gu
);
if (!data) return <p className="text-sm py-12 text-center text-purple">{i18n.t('fullview_guideNotFound')}</p>;
- const domain = getMostCommonDomain(data.steps);
+ const previewView = preview && previewData?.snapshotId === preview.id ? previewData : null;
+ const viewSteps = previewView ? previewView.steps : data.steps;
+ const viewScreenshots = previewView ? previewView.screenshots : data.screenshots;
+ const domain = getMostCommonDomain(viewSteps);
const editingScreenshot = editingStepId ? data.screenshots.get(editingStepId) : undefined;
+ const animatingTitle = preview ? null : typingTitle;
+ const untitledPending =
+ !preview && !typingTitle && title === i18n.t('fullview_untitledGuide') && viewSteps.length > 0;
return (
<div className="flex flex-col min-h-[calc(100vh-64px)]">
@@ -167,98 +238,124 @@ export default function GuideContent({ guideId, initialStepId, initialTool }: Gu
/>
)}
- <div
- className={
- title === i18n.t('fullview_untitledGuide') && !typingTitle && data.steps.length > 0 ? 'min-h-[88px]' : ''
- }
- >
- {title === i18n.t('fullview_untitledGuide') && !typingTitle && data.steps.length > 0 ? (
- <div className="text-[32px] font-extrabold leading-tight animate-gradient-text bg-[length:300%_100%] bg-clip-text text-transparent bg-gradient-to-r from-muted-foreground via-violet to-muted-foreground max-w-[480px]">
- {i18n.t('fullview_writingTitle')}
- </div>
- ) : typingTitle ? (
- <div className="relative text-[32px] font-extrabold leading-tight">
- <div className="invisible" aria-hidden="true">
- {typingTitle}
+ <div className={historyOpen ? 'flex items-start gap-6' : ''}>
+ <div className={historyOpen ? 'flex-1 min-w-0' : ''}>
+ {preview && (
+ <div className="flex items-center gap-2 rounded-lg bg-secondary border border-border px-4 py-3 mb-4">
+ <History size={15} className="text-accent shrink-0" />
+ <span className="text-[12px] text-foreground">{i18n.t('history.readOnlyBanner')}</span>
</div>
- <div className="absolute inset-0 text-foreground">
- <TypeAnimation
- sequence={[
- typingTitle,
- () => {
- titleRef.current = typingTitle;
- setTitle(typingTitle);
- setTypingTitle(null);
- },
- ]}
- speed={70}
- cursor={false}
+ )}
+
+ <div className={untitledPending ? 'min-h-[88px]' : ''}>
+ {untitledPending ? (
+ <div className="text-[32px] font-extrabold leading-tight animate-gradient-text bg-[length:300%_100%] bg-clip-text text-transparent bg-gradient-to-r from-muted-foreground via-violet to-muted-foreground max-w-[480px]">
+ {i18n.t('fullview_writingTitle')}
+ </div>
+ ) : animatingTitle ? (
+ <div className="relative text-[32px] font-extrabold leading-tight">
+ <div className="invisible" aria-hidden="true">
+ {animatingTitle}
+ </div>
+ <div className="absolute inset-0 text-foreground">
+ <TypeAnimation
+ sequence={[
+ animatingTitle,
+ () => {
+ titleRef.current = animatingTitle;
+ setTitle(animatingTitle);
+ setTypingTitle(null);
+ },
+ ]}
+ speed={70}
+ cursor={false}
+ />
+ <span className="inline-block w-[3px] h-[30px] bg-violet ml-0.5 align-text-bottom animate-blink" />
+ </div>
+ </div>
+ ) : editing && !preview ? (
+ <textarea
+ ref={(el) => {
+ if (el) {
+ el.style.height = '0';
+ el.style.height = `${el.scrollHeight}px`;
+ }
+ }}
+ value={title}
+ rows={1}
+ onChange={(e) => {
+ setTitle(e.target.value);
+ setGuideTitle(e.target.value);
+ const el = e.target;
+ el.style.height = '0';
+ el.style.height = `${el.scrollHeight}px`;
+ }}
+ onBlur={handleTitleBlur}
+ className="text-[32px] font-extrabold bg-transparent border-b-2 border-transparent hover:border-border focus:outline-none focus:border-accent w-full p-0 text-foreground resize-none leading-tight overflow-hidden"
/>
- <span className="inline-block w-[3px] h-[30px] bg-violet ml-0.5 align-text-bottom animate-blink" />
- </div>
+ ) : (
+ <h1 className="text-[32px] font-extrabold leading-tight text-foreground whitespace-pre-wrap break-words">
+ {preview ? preview.title : title}
+ </h1>
+ )}
</div>
- ) : (
- <textarea
- ref={(el) => {
- if (el) {
- el.style.height = '0';
- el.style.height = `${el.scrollHeight}px`;
- }
- }}
- value={title}
- rows={1}
- onChange={(e) => {
- setTitle(e.target.value);
- setGuideTitle(e.target.value);
- const el = e.target;
- el.style.height = '0';
- el.style.height = `${el.scrollHeight}px`;
- }}
- onBlur={handleTitleBlur}
- className="text-[32px] font-extrabold bg-transparent border-b-2 border-transparent hover:border-border focus:outline-none focus:border-accent w-full p-0 text-foreground resize-none leading-tight overflow-hidden"
+
+ <div className="flex items-center gap-1.5 mt-2 mb-4 flex-wrap">
+ <span className="inline-flex items-center text-[11px] font-medium text-muted-foreground bg-card border border-border px-2.5 py-0.5 rounded-full">
+ {formatDate(data.guide.createdAt)}
+ </span>
+ <span className="inline-flex items-center text-[11px] font-medium text-muted-foreground bg-card border border-border px-2.5 py-0.5 rounded-full">
+ {viewSteps.length !== 1
+ ? i18n.t('fullview_stepCountPlural', [String(viewSteps.length)])
+ : i18n.t('fullview_stepCount', [String(viewSteps.length)])}
+ </span>
+ {domain && (
+ <span className="inline-flex items-center gap-1.5 text-[11px] font-medium text-muted-foreground bg-card border border-border pl-1.5 pr-2.5 py-0.5 rounded-full">
+ <FaviconImg domain={domain} size={14} className="rounded-full" />
+ {domain}
+ </span>
+ )}
+ {!preview && viewSteps.length > 0 && (
+ <button
+ onClick={() => {
+ openSidebar();
+ void sendMessage('startGuideMe', { guideId });
+ }}
+ disabled={!viewSteps.some((s) => s.elementMeta)}
+ className="inline-flex items-center gap-1.5 text-[11px] font-semibold text-primary-foreground bg-primary hover:bg-primary/90 px-3 py-0.5 rounded-full transition-colors disabled:opacity-30 disabled:cursor-not-allowed ml-auto"
+ >
+ <Play size={11} />
+ {i18n.t('fullview_guideMe')}
+ </button>
+ )}
+ </div>
+
+ <GuideStepList
+ guideId={guideId}
+ steps={viewSteps}
+ screenshots={viewScreenshots}
+ onDescriptionChange={handleDescriptionChange}
+ onDelete={handleDeleteStep}
+ onOpenEditor={handleOpenEditor}
+ onReorder={(newSteps) => setData((prev) => (prev ? { ...prev, steps: newSteps } : prev))}
+ readOnly={!editing || preview !== null}
/>
- )}
- </div>
+ </div>
- <div className="flex items-center gap-1.5 mt-2 mb-4 flex-wrap">
- <span className="inline-flex items-center text-[11px] font-medium text-muted-foreground bg-card border border-border px-2.5 py-0.5 rounded-full">
- {formatDate(data.guide.createdAt)}
- </span>
- <span className="inline-flex items-center text-[11px] font-medium text-muted-foreground bg-card border border-border px-2.5 py-0.5 rounded-full">
- {data.steps.length !== 1
- ? i18n.t('fullview_stepCountPlural', [String(data.steps.length)])
- : i18n.t('fullview_stepCount', [String(data.steps.length)])}
- </span>
- {domain && (
- <span className="inline-flex items-center gap-1.5 text-[11px] font-medium text-muted-foreground bg-card border border-border pl-1.5 pr-2.5 py-0.5 rounded-full">
- <FaviconImg domain={domain} size={14} className="rounded-full" />
- {domain}
- </span>
- )}
- {data.steps.length > 0 && (
- <button
- onClick={() => {
- openSidebar();
- void sendMessage('startGuideMe', { guideId });
+ {historyOpen && (
+ <VersionHistoryPanel
+ guideId={guideId}
+ selectedId={preview?.id ?? null}
+ refreshKey={historyRefreshKey}
+ onSelect={setPreview}
+ onRestored={loadGuide}
+ onClose={() => {
+ setHistoryOpen(false);
+ setPreview(null);
}}
- disabled={!data.steps.some((s) => s.elementMeta)}
- className="inline-flex items-center gap-1.5 text-[11px] font-semibold text-primary-foreground bg-primary hover:bg-primary/90 px-3 py-0.5 rounded-full transition-colors disabled:opacity-30 disabled:cursor-not-allowed ml-auto"
- >
- <Play size={11} />
- {i18n.t('fullview_guideMe')}
- </button>
+ />
)}
</div>
-
- <GuideStepList
- guideId={guideId}
- steps={data.steps}
- screenshots={data.screenshots}
- onDescriptionChange={handleDescriptionChange}
- onDelete={handleDeleteStep}
- onOpenEditor={handleOpenEditor}
- onReorder={(newSteps) => setData((prev) => (prev ? { ...prev, steps: newSteps } : prev))}
- />
</div>
);
}
diff --git a/src/ui/fullview/TopNav.tsx b/src/ui/fullview/TopNav.tsx
index 5d49ab2..c5306b1 100644
--- a/src/ui/fullview/TopNav.tsx
+++ b/src/ui/fullview/TopNav.tsx
@@ -1,8 +1,27 @@
-import { ChevronRight, Download, FileText, Search, Star, Trash2 } from 'lucide-react';
+import {
+ Check,
+ ChevronRight,
+ Download,
+ FileText,
+ History,
+ MoreHorizontal,
+ Pencil,
+ Search,
+ Star,
+ Trash2,
+} from 'lucide-react';
import { useState } from 'react';
import { i18n } from '#imports';
+import { createSnapshot } from '@/core/guides/service';
+import { logger } from '@/lib/logger';
import { useFullview } from '@/stores/fullview';
import { Button } from '@/ui/components/ui/button';
+import {
+ DropdownMenu,
+ DropdownMenuContent,
+ DropdownMenuItem,
+ DropdownMenuTrigger,
+} from '@/ui/components/ui/dropdown-menu';
import MascotIcon from '@/ui/shared/MascotIcon';
import ExportPreviewModal from './ExportPreviewModal';
import type { Route } from './router';
@@ -25,15 +44,36 @@ export default function TopNav({ route }: TopNavProps) {
guideStepCount,
guideExportData: exportData,
setSearchOpen,
+ editing,
+ setEditing,
+ setHistoryOpen,
+ bumpHistoryRefresh,
} = useFullview((s) => ({
counts: s.counts,
guideTitle: s.guideTitle,
guideStepCount: s.guideStepCount,
guideExportData: s.guideExportData,
setSearchOpen: s.setSearchOpen,
+ editing: s.editing,
+ setEditing: s.setEditing,
+ setHistoryOpen: s.setHistoryOpen,
+ bumpHistoryRefresh: s.bumpHistoryRefresh,
}));
const [exportOpen, setExportOpen] = useState(false);
+ const toggleEditing = (guideId: string) => {
+ if (editing) {
+ setEditing(false);
+ return;
+ }
+ setEditing(true);
+ createSnapshot(guideId)
+ .then((snapshot) => {
+ if (snapshot) bumpHistoryRefresh();
+ })
+ .catch((err) => logger.error(' Snapshot before editing failed', err));
+ };
+
return (
<header className="flex items-center gap-5 px-7 h-16 shrink-0 bg-gradient-to-br from-violet to-violet-light">
{/* Brand */}
@@ -100,6 +140,10 @@ export default function TopNav({ route }: TopNavProps) {
</Button>
{route.page === 'guide' && exportData && (
<>
+ <Button size="sm" variant="secondary" onClick={() => toggleEditing(exportData.guideId)}>
+ {editing ? <Check size={14} /> : <Pencil size={14} />}
+ {editing ? i18n.t('editor.done') : i18n.t('editor.edit')}
+ </Button>
<Button size="sm" onClick={() => setExportOpen(true)}>
<Download size={14} />
{i18n.t('common.export')}
@@ -111,6 +155,30 @@ export default function TopNav({ route }: TopNavProps) {
steps={exportData.steps}
screenshots={exportData.screenshots}
/>
+ <DropdownMenu>
+ <DropdownMenuTrigger asChild>
+ <Button
+ size="icon-sm"
+ variant="ghost"
+ aria-label={i18n.t('editor.moreActions')}
+ title={i18n.t('editor.moreActions')}
+ className="text-foreground hover:bg-foreground/10"
+ >
+ <MoreHorizontal size={16} />
+ </Button>
+ </DropdownMenuTrigger>
+ <DropdownMenuContent align="end">
+ <DropdownMenuItem
+ onSelect={() => {
+ setHistoryOpen(true);
+ setEditing(false);
+ }}
+ >
+ <History size={14} />
+ {i18n.t('editor.versionHistory')}
+ </DropdownMenuItem>
+ </DropdownMenuContent>
+ </DropdownMenu>
</>
)}
</div>
diff --git a/src/ui/fullview/components/VersionHistoryPanel.tsx b/src/ui/fullview/components/VersionHistoryPanel.tsx
index d7d2dd9..100b1b9 100644
--- a/src/ui/fullview/components/VersionHistoryPanel.tsx
+++ b/src/ui/fullview/components/VersionHistoryPanel.tsx
@@ -1,5 +1,5 @@
import { ChevronRight, RotateCcw, X } from 'lucide-react';
-import { useEffect, useState } from 'react';
+import { useEffect, useRef, useState } from 'react';
import { i18n } from '#imports';
import { getSnapshots, revertToSnapshot } from '@/core/guides/service';
import { groupSnapshots } from '@/core/guides/snapshot-groups';
@@ -13,6 +13,7 @@ function isQuotaError(e: unknown): boolean {
interface VersionHistoryPanelProps {
guideId: string;
selectedId: string | null;
+ refreshKey: number;
onSelect: (snapshot: Snapshot | null) => void;
onRestored: () => void;
onClose: () => void;
@@ -21,6 +22,7 @@ interface VersionHistoryPanelProps {
export default function VersionHistoryPanel({
guideId,
selectedId,
+ refreshKey,
onSelect,
onRestored,
onClose,
@@ -30,11 +32,16 @@ export default function VersionHistoryPanel({
const [error, setError] = useState<string | null>(null);
const [restoring, setRestoring] = useState(false);
const [expanded, setExpanded] = useState<Set<string>>(new Set());
+ const refreshRef = useRef(refreshKey);
useEffect(() => {
+ const silent = refreshRef.current !== refreshKey;
+ refreshRef.current = refreshKey;
let cancelled = false;
- setLoading(true);
- setError(null);
+ if (!silent) {
+ setLoading(true);
+ setError(null);
+ }
getSnapshots(guideId)
.then((list) => {
if (!cancelled) setSnapshots(list);
@@ -48,7 +55,7 @@ export default function VersionHistoryPanel({
return () => {
cancelled = true;
};
- }, [guideId]);
+ }, [guideId, refreshKey]);
const handleRestore = async (snapshot: Snapshot) => {
if (restoring) return;