Fix renderer scope collisions, editor bugs; add welcome screen

Bug fixes from code review:
- Wrap renderer modules (canvas/dialogs/editor/app) in IIFEs: duplicate
  top-level 'const api' across plain scripts threw a SyntaxError that
  prevented app.js from ever running (blank window), and dialogs.js/
  editor.js silently overrode each other's labeledRow/makeSelect
- Focused-view toggle now writes step.focusedView.enabled instead of a
  nonexistent flat field that the schema dropped on save
- Annotation property edits no longer rebuild the panel on every
  keystroke (focus was stolen mid-typing); debounced save instead
- flushStep/undo/redo keep this.steps in sync with stepMap so the step
  list stops going stale after the first save
- Escape now deselects the annotation; Delete remains the delete key

Welcome screen (per spec): app opens to a title at top and three
buttons at the bottom — New Capture (creates a guide, opens the editor,
starts a capture session), Existing Workspace (library), Settings.
Brand click returns to the welcome screen.

Adds an env-gated dev screenshot hook (STEPFORGE_SCREENSHOT[_JS]) used
to visually verify welcome/library/editor views under WSLg.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Iisyourdad
2026-06-10 21:29:14 -05:00
parent 4ab18080ce
commit 03bd9b0e2b
6 changed files with 198 additions and 20 deletions
+23 -1
View File
@@ -76,7 +76,29 @@ function createWindow() {
}, },
}); });
mainWindow.loadFile(path.join(__dirname, 'renderer', 'index.html')); mainWindow.loadFile(path.join(__dirname, 'renderer', 'index.html'));
mainWindow.once('ready-to-show', () => mainWindow.show()); mainWindow.once('ready-to-show', () => {
mainWindow.show();
// Dev-only verification hook: optionally navigate, then write a
// screenshot locally and exit. Used by the smoke tooling.
if (process.env.STEPFORGE_SCREENSHOT) {
const target = process.env.STEPFORGE_SCREENSHOT;
const navigate = process.env.STEPFORGE_SCREENSHOT_JS || '';
setTimeout(async () => {
try {
if (navigate) {
await mainWindow.webContents.executeJavaScript(navigate, true);
await new Promise((r) => setTimeout(r, 900));
}
const image = await mainWindow.webContents.capturePage();
fs.writeFileSync(target, image.toPNG());
} catch (err) {
console.error('screenshot failed:', err.message);
} finally {
app.quit();
}
}, 1500);
}
});
mainWindow.on('closed', () => { mainWindow = null; }); mainWindow.on('closed', () => { mainWindow = null; });
} }
+77 -6
View File
@@ -1,5 +1,7 @@
'use strict'; 'use strict';
(() => {
const api = window.stepforge; const api = window.stepforge;
const dialogs = window.StepForgeDialogs || {}; const dialogs = window.StepForgeDialogs || {};
@@ -12,7 +14,7 @@ class StepForgeApp {
this.homeBtn = document.getElementById('btn-home'); this.homeBtn = document.getElementById('btn-home');
this.state = { this.state = {
view: 'library', view: 'welcome',
query: '', query: '',
folderFilter: 'all', folderFilter: 'all',
library: { guides: [], folders: [], guideFolders: {} }, library: { guides: [], folders: [], guideFolders: {} },
@@ -24,9 +26,11 @@ class StepForgeApp {
this.libraryRenderToken = 0; this.libraryRenderToken = 0;
this.view.innerHTML = ` this.view.innerHTML = `
<div id="library-host"></div> <div id="welcome-host"></div>
<div id="library-host" class="hidden"></div>
<div id="editor-host" class="hidden"></div> <div id="editor-host" class="hidden"></div>
`; `;
this.welcomeHost = document.getElementById('welcome-host');
this.libraryHost = document.getElementById('library-host'); this.libraryHost = document.getElementById('library-host');
this.editorHost = document.getElementById('editor-host'); this.editorHost = document.getElementById('editor-host');
@@ -61,7 +65,7 @@ class StepForgeApp {
}); });
this.homeBtn.addEventListener('click', () => { this.homeBtn.addEventListener('click', () => {
if (this.state.view === 'editor') this.showLibrary(); if (this.state.view !== 'welcome') this.showWelcome();
}); });
document.addEventListener('keydown', (e) => { document.addEventListener('keydown', (e) => {
@@ -85,9 +89,13 @@ class StepForgeApp {
} }
async init() { async init() {
await this.refreshData(); this.renderWelcome();
this.updateCaptureState(await api.capture.state()); try {
this.renderLibrary(); await this.refreshData();
this.updateCaptureState(await api.capture.state());
} catch (err) {
console.error(err);
}
} }
async refreshData() { async refreshData() {
@@ -123,12 +131,73 @@ class StepForgeApp {
setView(view) { setView(view) {
this.state.view = view; this.state.view = view;
this.welcomeHost.classList.toggle('hidden', view !== 'welcome');
this.libraryHost.classList.toggle('hidden', view !== 'library'); this.libraryHost.classList.toggle('hidden', view !== 'library');
this.editorHost.classList.toggle('hidden', view !== 'editor'); this.editorHost.classList.toggle('hidden', view !== 'editor');
this.searchInput.classList.toggle('hidden', view !== 'library'); this.searchInput.classList.toggle('hidden', view !== 'library');
this.renderTopbar(); this.renderTopbar();
} }
showWelcome() {
this.editor.setActive(false);
this.setView('welcome');
this.renderWelcome();
}
renderWelcome() {
this.setView('welcome');
clearNode(this.welcomeHost);
this.welcomeHost.append(
el('div.welcome', {},
el('div.welcome-title', {},
el('h1', {}, 'StepForge'),
el('p.muted', {}, 'Capture, annotate, and export step-by-step guides — fully offline.'),
),
el('div.welcome-actions', {},
el('button.welcome-btn.primary', {
type: 'button',
onClick: () => this.startNewCapture(),
},
el('span.welcome-btn-label', {}, 'New Capture'),
el('span.welcome-btn-hint', {}, 'Start a guide and capture your screen'),
),
el('button.welcome-btn', {
type: 'button',
onClick: () => this.openExistingWorkspace(),
},
el('span.welcome-btn-label', {}, 'Existing Workspace'),
el('span.welcome-btn-hint', {}, 'Browse your guide library'),
),
el('button.welcome-btn', {
type: 'button',
onClick: () => this.openSettings(),
},
el('span.welcome-btn-label', {}, 'Settings'),
el('span.welcome-btn-hint', {}, 'Theme, capture, and export options'),
),
),
),
);
}
async startNewCapture() {
const guide = await api.library.create({ title: 'Untitled capture' });
await this.refreshData();
await this.openGuide(guide.guideId);
const state = await api.capture.session({ action: 'start', guideId: guide.guideId });
this.updateCaptureState(state);
const hotkey = this.state.settings?.capture?.hotkeyCapture;
toast(hotkey ? `Capture session started — press ${hotkey} to grab a step.` : 'Capture session started.');
}
async openExistingWorkspace() {
await this.refreshData();
this.state.query = '';
this.searchInput.value = '';
this.state.folderFilter = 'all';
await this.showLibrary();
}
async showLibrary(reason = null) { async showLibrary(reason = null) {
this.editor.setActive(false); this.editor.setActive(false);
this.setView('library'); this.setView('library');
@@ -182,6 +251,7 @@ class StepForgeApp {
renderTopbar() { renderTopbar() {
clearNode(this.topbarContext); clearNode(this.topbarContext);
if (this.state.view === 'welcome') return;
if (this.state.view === 'library') { if (this.state.view === 'library') {
this.topbarContext.append( this.topbarContext.append(
el('button', { type: 'button', onClick: () => this.createGuide() }, 'New'), el('button', { type: 'button', onClick: () => this.createGuide() }, 'New'),
@@ -594,3 +664,4 @@ function boot() {
} }
boot(); boot();
})();
+3
View File
@@ -1,5 +1,7 @@
'use strict'; 'use strict';
(() => {
/** /**
* AnnotationCanvas: renders a step's working image plus its normalized * AnnotationCanvas: renders a step's working image plus its normalized
* annotation scene graph, and provides editing interactions (create, select, * annotation scene graph, and provides editing interactions (create, select,
@@ -500,3 +502,4 @@ class AnnotationCanvas {
} }
window.AnnotationCanvas = AnnotationCanvas; window.AnnotationCanvas = AnnotationCanvas;
})();
+3
View File
@@ -1,5 +1,7 @@
'use strict'; 'use strict';
(() => {
/** /**
* Small modal factories used by the renderer. They stay intentionally plain: * Small modal factories used by the renderer. They stay intentionally plain:
* a modal title, a few form rows, and action buttons. No decorative clutter. * a modal title, a few form rows, and action buttons. No decorative clutter.
@@ -438,3 +440,4 @@ window.StepForgeDialogs = {
showLinkedGuideDialog, showLinkedGuideDialog,
showInfoDialog, showInfoDialog,
}; };
})();
+43 -13
View File
@@ -1,5 +1,7 @@
'use strict'; 'use strict';
(() => {
const api = window.stepforge; const api = window.stepforge;
const dialogs = window.StepForgeDialogs || {}; const dialogs = window.StepForgeDialogs || {};
@@ -317,7 +319,20 @@ class GuideEditor {
bindCheckbox(this.dom.hiddenToggle.querySelector('input'), 'hidden'); bindCheckbox(this.dom.hiddenToggle.querySelector('input'), 'hidden');
bindCheckbox(this.dom.skippedToggle.querySelector('input'), 'skipped'); bindCheckbox(this.dom.skippedToggle.querySelector('input'), 'skipped');
bindCheckbox(this.dom.forceNewPageToggle.querySelector('input'), 'forceNewPage'); bindCheckbox(this.dom.forceNewPageToggle.querySelector('input'), 'forceNewPage');
bindCheckbox(this.dom.focusedViewToggle.querySelector('input'), 'focusedViewDefault');
// Focused view lives under step.focusedView.enabled, not a flat field.
const focusedInput = this.dom.focusedViewToggle.querySelector('input');
focusedInput.addEventListener('change', () => {
if (!this.currentStep) return;
this.currentStep.focusedView = {
zoom: 1.5, panX: 0.5, panY: 0.5,
...(this.currentStep.focusedView || {}),
enabled: focusedInput.checked,
};
this.pendingSave = true;
this.saveStepDebounced();
this.emitMeta();
});
this.dom.descEditor.addEventListener('focus', () => { this.dom.descEditor.addEventListener('focus', () => {
if (this.currentStep) this.pushCanvasHistory('description'); if (this.currentStep) this.pushCanvasHistory('description');
@@ -511,17 +526,20 @@ class GuideEditor {
{ value: 'right', label: 'Right' }, { value: 'right', label: 'Right' },
]); ]);
const apply = async (patch) => { // Light-weight apply: mutate the selected annotation, redraw, and let the
// debounced save flush. Re-rendering the panel here would rebuild the
// inputs and steal focus mid-keystroke, so only structural changes
// (type/tail) pass rerender: true.
const apply = (patch, { rerender = false } = {}) => {
const ann = this.canvas.selected(); const ann = this.canvas.selected();
if (!ann) return; if (!ann) return;
Object.assign(ann, patch); Object.assign(ann, patch);
this.beforeCanvasSnapshot = null; this.beforeCanvasSnapshot = null;
step.annotations = clone(this.canvas.annotations || []);
this.pendingSave = true; this.pendingSave = true;
this.canvas.setAnnotations(step.annotations || []); this.canvas.render();
this.canvas.select(ann.id); this.saveStepDebounced();
await this.flushStep(); if (rerender) this.renderAnnotationPanel();
this.renderAnnotationPanel();
this.renderStepList();
this.emitMeta(); this.emitMeta();
}; };
@@ -548,10 +566,10 @@ class GuideEditor {
); );
this.dom.annotationEditor.append(annSection); this.dom.annotationEditor.append(annSection);
typeSelect.addEventListener('change', async () => { typeSelect.addEventListener('change', () => {
const ann = this.canvas.selected(); const ann = this.canvas.selected();
if (!ann) return; if (!ann) return;
await apply({ type: typeSelect.value }); apply({ type: typeSelect.value }, { rerender: true });
if (ann.type === 'tooltip') this.editAnnotationText(ann); if (ann.type === 'tooltip') this.editAnnotationText(ann);
}); });
textInput.addEventListener('focus', () => this.pushCanvasHistory('annotation-text')); textInput.addEventListener('focus', () => this.pushCanvasHistory('annotation-text'));
@@ -671,6 +689,8 @@ class GuideEditor {
this.canvasFuture.push(clone(this.currentStep)); this.canvasFuture.push(clone(this.currentStep));
const previous = this.canvasHistory.pop(); const previous = this.canvasHistory.pop();
this.stepMap.set(previous.stepId, previous); this.stepMap.set(previous.stepId, previous);
const prevIdx = this.steps.findIndex((s) => s.stepId === previous.stepId);
if (prevIdx >= 0) this.steps[prevIdx] = previous;
this.selectedStepId = previous.stepId; this.selectedStepId = previous.stepId;
await this.flushStep(previous); await this.flushStep(previous);
this.renderAll(); this.renderAll();
@@ -685,6 +705,8 @@ class GuideEditor {
this.canvasHistory.push(clone(this.currentStep)); this.canvasHistory.push(clone(this.currentStep));
const next = this.canvasFuture.pop(); const next = this.canvasFuture.pop();
this.stepMap.set(next.stepId, next); this.stepMap.set(next.stepId, next);
const nextIdx = this.steps.findIndex((s) => s.stepId === next.stepId);
if (nextIdx >= 0) this.steps[nextIdx] = next;
this.selectedStepId = next.stepId; this.selectedStepId = next.stepId;
await this.flushStep(next); await this.flushStep(next);
this.renderAll(); this.renderAll();
@@ -695,12 +717,18 @@ class GuideEditor {
this.pendingSave = false; this.pendingSave = false;
const saved = await api.step.save({ guideId: this.guideId, step }); const saved = await api.step.save({ guideId: this.guideId, step });
this.stepMap.set(saved.stepId, saved); this.stepMap.set(saved.stepId, saved);
// Keep the steps array in sync — it holds the objects the list renders.
const idx = this.steps.findIndex((s) => s.stepId === saved.stepId);
if (idx >= 0) this.steps[idx] = saved;
if (this.selectedStepId === saved.stepId) { if (this.selectedStepId === saved.stepId) {
this.stepMap.set(saved.stepId, saved);
this.renderStepList(); this.renderStepList();
this.syncStepFields(); this.syncStepFields();
this.canvas.setAnnotations(saved.annotations || []); this.canvas.setAnnotations(saved.annotations || []);
this.renderAnnotationPanel(); // Rebuilding the annotation editor while the user is typing in one of
// its inputs would steal focus, so skip it in that case.
if (!this.dom.annotationEditor.contains(document.activeElement)) {
this.renderAnnotationPanel();
}
this.emitMeta(); this.emitMeta();
} }
return saved; return saved;
@@ -1140,9 +1168,10 @@ class GuideEditor {
return; return;
} }
if (e.key === 'Escape' && !isEditableTarget(e.target)) { if (e.key === 'Escape' && !isEditableTarget(e.target)) {
if (this.selectedAnnotationId && this.canvas.deleteSelected()) { // Escape deselects; Delete is the destructive key.
if (this.selectedAnnotationId) {
e.preventDefault(); e.preventDefault();
this.saveStepDebounced(); this.canvas.select(null);
return; return;
} }
} }
@@ -1206,3 +1235,4 @@ function loadImage(src) {
} }
window.GuideEditor = GuideEditor; window.GuideEditor = GuideEditor;
})();
+49
View File
@@ -671,3 +671,52 @@ fieldset legend {
border-top: 1px solid var(--border); border-top: 1px solid var(--border);
} }
/* ---------- welcome screen ---------- */
#welcome-host { flex: 1; min-height: 0; display: flex; }
.welcome {
flex: 1;
display: flex;
flex-direction: column;
align-items: center;
padding: 9vh 32px 7vh;
}
.welcome-title { text-align: center; }
.welcome-title h1 {
margin: 0 0 10px;
font-size: 44px;
font-weight: 700;
letter-spacing: -0.015em;
}
.welcome-title p { font-size: 14px; margin: 0; }
.welcome-actions {
margin-top: auto;
display: flex;
gap: 18px;
width: min(880px, 100%);
}
.welcome-btn {
flex: 1;
display: flex;
flex-direction: column;
align-items: center;
gap: 6px;
padding: 26px 18px;
border-radius: var(--radius);
border: 1px solid var(--border);
background: var(--panel);
box-shadow: var(--shadow);
cursor: pointer;
}
.welcome-btn:hover {
border-color: color-mix(in srgb, var(--accent) 55%, var(--border));
transform: translateY(-2px);
}
.welcome-btn.primary {
background: var(--accent);
border-color: var(--accent);
}
.welcome-btn.primary .welcome-btn-label,
.welcome-btn.primary .welcome-btn-hint { color: var(--accent-fg); }
.welcome-btn-label { font-size: 16px; font-weight: 650; }
.welcome-btn-hint { font-size: 12px; color: var(--muted); }