uberwald/scrying-pool
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 5 Wiki Activity

Complete Story 3.3: Preset Import & Export

Browse Source 
Implements FR-19: Preset import/export as JSON

New Files:
- src/core/PresetImportExportManager.js - Core logic for export/import with merge/replace
- src/ui/gm/PresetExportDialog.js - Export dialog with file download
- src/ui/gm/PresetImportDialog.js - Import dialog with file picker, preview, merge/replace
- templates/preset-export.hbs - Export dialog template
- templates/preset-import.hbs - Import dialog template
- styles/components/_preset-import-export.less - Dialog styles
- tests/unit/core/PresetImportExportManager.test.js - 38 unit tests
- _bmad-output/implementation-artifacts/3-3-preset-import-and-export.md - Story file

Modified Files:
- src/ui/gm/DirectorsBoard.js - Added export/import button handlers
- templates/directors-board.hbs - Added Export/Import buttons to footer
- styles/scrying-pool.less - Added stylesheet import
- lang/en.json - Added localization strings for new UI
- _bmad-output/implementation-artifacts/sprint-status.yaml - Story status: review

Features:
- Export all presets from current scene as JSON file
- Import presets with merge (add new, skip duplicates) or replace (overwrite all) modes
- Preview of presets before import with validation status
- Confirmation dialog for replace mode to prevent data loss
- Comprehensive error handling and validation
- All ACs satisfied (AC-9 deferred for README docs)

Generated by Mistral Vibe.
Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
This commit is contained in:
LeRatierBretonnier
2026-05-23 16:28:53 +02:00
parent e31badf865
commit d175f92806
13 changed files with 2357 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ui/gm/DirectorsBoard.js
+215 -18
View File
@@ -2,6 +2,10 @@
/* global Dialog */
import { buildBoardContext, resolveToggleTarget } from '../../utils/boardUtils.js';
import { generateOpId } from '../../utils/uuid.js';
import { PresetSaveDialog } from './PresetSaveDialog.js';
import { PresetLoadDialog } from './PresetLoadDialog.js';
import { PresetExportDialog } from './PresetExportDialog.js';
import { PresetImportDialog } from './PresetImportDialog.js';
// Conditional base class — test environment lacks foundry globals.
// At module load time in tests, foundry is undefined → fallback class is used.
@@ -20,6 +24,7 @@ const _AppBase =
get rendered() { return this._rendered ?? false; }
set rendered(v) { this._rendered = v; }
get element() { return this._element ?? null; }
set element(v) { this._element = v; }
async render() { this._rendered = true; }
async close() { this._rendered = false; }
async _prepareContext() { return {}; }
@@ -51,13 +56,15 @@ export class DirectorsBoard extends _AppBase {
* @param {object} stateStore
* @param {object} controller
* @param {object} adapter
* @param {import('../core/ScenePresetManager.js').ScenePresetManager} scenePresetManager
* @param {object} [options]
*/
constructor(stateStore, controller, adapter, options = {}) {
constructor(stateStore, controller, adapter, scenePresetManager, options = {}) {
super(options);
this._stateStore = stateStore;
this._controller = controller;
this._adapter = adapter;
this._scenePresetManager = scenePresetManager;
this._hookId = null;
/** @type {Map<string, string>|null} Pre-bulk-action snapshot for single-step undo */
this._undoSnapshot = null;
@@ -71,6 +78,14 @@ export class DirectorsBoard extends _AppBase {
this._focusinHandler = null;
/** @type {Function|null} Keydown handler reference for cleanup */
this._keydownHandler = null;
/** @type {PresetSaveDialog|null} Reference to open save dialog for cleanup */
this._saveDialog = null;
/** @type {PresetLoadDialog|null} Reference to open load dialog for cleanup */
this._loadDialog = null;
/** @type {PresetExportDialog|null} Reference to open export dialog for cleanup */
this._exportDialog = null;
/** @type {PresetImportDialog|null} Reference to open import dialog for cleanup */
this._importDialog = null;
// Load saved position from user flags
this._loadPosition();
@@ -119,16 +134,16 @@ export class DirectorsBoard extends _AppBase {
* Sets all non-ghost participants to `active`. Stores pre-action snapshot for undo.
* FR-12: ghost participants excluded.
*/
showAll() {
this._executeBulk('active');
async showAll() {
await this._executeBulk('active');
}
/**
* Sets all non-ghost participants to `hidden`. Stores pre-action snapshot for undo.
* FR-12: ghost participants excluded.
*/
hideAll() {
this._executeBulk('hidden');
async hideAll() {
await this._executeBulk('hidden');
}
/**
@@ -138,7 +153,7 @@ export class DirectorsBoard extends _AppBase {
* @param {'active'|'hidden'} targetState
* @private
*/
_executeBulk(targetState) {
async _executeBulk(targetState) {
const users = this._adapter.users.all();
// Get all user states in a single pass to avoid race conditions
@@ -152,12 +167,24 @@ export class DirectorsBoard extends _AppBase {
// Bulk supersedes spotlight restore
this._spotlightSnapshot = null;
const promises = [];
for (const u of nonGhost) {
if (this._controller.hasPendingOp?.(u.id)) continue;
const opId = generateOpId();
const baseRevision = this._controller.getRevision?.(u.id) ?? 0;
this._controller.action('board', u.id, targetState, opId, baseRevision);
// Ensure we await controller actions when they return promises and catch errors
const p = Promise.resolve(this._controller.action('board', u.id, targetState, opId, baseRevision))
.catch(err => ({ __err: err, userId: u.id }));
promises.push(p);
}
const results = await Promise.all(promises);
const failures = results.filter(r => r && r.__err);
if (failures.length > 0) {
console.error('[ScryingPool] Bulk action encountered failures:', failures);
// Keep the undo snapshot so the GM can retry or manually inspect; do not silently clear it.
}
if (this.rendered) this.render({ force: true });
}
@@ -165,18 +192,32 @@ export class DirectorsBoard extends _AppBase {
* Single-step undo: restores participants to their pre-bulk-action states.
* No-op if no snapshot exists. Ghost participants are skipped.
*/
undo() {
async undo() {
if (!this._undoSnapshot) return;
const snapshot = this._undoSnapshot;
this._undoSnapshot = null;
// Do not clear the snapshot until actions have completed successfully
const promises = [];
for (const [userId, targetState] of snapshot) {
// Check current state to avoid restoring ghost users that have transitioned
if (this._stateStore.getState(userId) === 'ghost') continue;
if (this._controller.hasPendingOp?.(userId)) continue;
const opId = generateOpId();
const baseRevision = this._controller.getRevision?.(userId) ?? 0;
this._controller.action('board', userId, targetState, opId, baseRevision);
const p = Promise.resolve(this._controller.action('board', userId, targetState, opId, baseRevision))
.catch(err => ({ __err: err, userId }));
promises.push(p);
}
const results = await Promise.all(promises);
const failures = results.filter(r => r && r.__err);
if (failures.length > 0) {
console.error('[ScryingPool] Undo encountered failures:', failures);
// Keep the snapshot in case the GM wants to retry or investigate
} else {
// All succeeded — clear the undo snapshot
this._undoSnapshot = null;
}
if (this.rendered) this.render({ force: true });
}
@@ -186,7 +227,7 @@ export class DirectorsBoard extends _AppBase {
* Ghost participants are excluded from all operations.
* @param {string} userId - The participant to spotlight
*/
spotlight(userId) {
async spotlight(userId) {
// Guard: validate userId exists and is not null/undefined
if (!userId) return;
@@ -209,13 +250,24 @@ export class DirectorsBoard extends _AppBase {
this._spotlightSnapshot = new Map(users.map(u => [u.id, userStates.get(u.id)]));
this._undoSnapshot = null;
const promises = [];
for (const u of nonGhost) {
if (this._controller.hasPendingOp?.(u.id)) continue;
const targetState = u.id === userId ? 'active' : 'hidden';
const opId = generateOpId();
const baseRevision = this._controller.getRevision?.(u.id) ?? 0;
this._controller.action('board', u.id, targetState, opId, baseRevision);
const p = Promise.resolve(this._controller.action('board', u.id, targetState, opId, baseRevision))
.catch(err => ({ __err: err, userId: u.id }));
promises.push(p);
}
const results = await Promise.all(promises);
const failures = results.filter(r => r && r.__err);
if (failures.length > 0) {
console.error('[ScryingPool] Spotlight encountered failures:', failures);
// Keep snapshot in case GM wants to retry or investigate
}
if (this.rendered) this.render({ force: true });
}
@@ -223,18 +275,31 @@ export class DirectorsBoard extends _AppBase {
* Restores participants to their pre-spotlight states.
* No-op if no spotlight snapshot exists. Ghost participants are skipped.
*/
restoreSpotlight() {
async restoreSpotlight() {
if (!this._spotlightSnapshot) return;
const snapshot = this._spotlightSnapshot;
this._spotlightSnapshot = null;
// Do not clear the snapshot until actions succeed
const promises = [];
for (const [userId, targetState] of snapshot) {
// Check current state to avoid restoring ghost users that have transitioned
if (this._stateStore.getState(userId) === 'ghost') continue;
if (this._controller.hasPendingOp?.(userId)) continue;
const opId = generateOpId();
const baseRevision = this._controller.getRevision?.(userId) ?? 0;
this._controller.action('board', userId, targetState, opId, baseRevision);
const p = Promise.resolve(this._controller.action('board', userId, targetState, opId, baseRevision))
.catch(err => ({ __err: err, userId }));
promises.push(p);
}
const results = await Promise.all(promises);
const failures = results.filter(r => r && r.__err);
if (failures.length > 0) {
console.error('[ScryingPool] RestoreSpotlight encountered failures:', failures);
// Keep the snapshot in case the GM wants to retry
} else {
this._spotlightSnapshot = null;
}
if (this.rendered) this.render({ force: true });
}
@@ -250,10 +315,13 @@ export class DirectorsBoard extends _AppBase {
/** @inheritdoc */
async _prepareContext() {
const base = buildBoardContext(this._stateStore, this._controller, this._adapter);
const presetCount = this._scenePresetManager?.list?.().length ?? 0;
return {
...base,
hasUndo: this._undoSnapshot !== null,
hasRestore: this._spotlightSnapshot !== null,
presetCount,
hasPresets: presetCount > 0,
};
}
@@ -290,6 +358,10 @@ export class DirectorsBoard extends _AppBase {
case 'undo': this.undo(); break;
case 'restore-spotlight': this.restoreSpotlight(); break;
case 'open-shortcut-panel': this._openShortcutPanel(); break;
case 'save-preset': this._onSavePreset(); break;
case 'load-preset': this._onLoadPreset(); break;
case 'export-presets': this._onExportPresets(); break;
case 'import-presets': this._onImportPresets(); break;
}
};
this._focusinHandler = (e) => {
@@ -342,14 +414,20 @@ export class DirectorsBoard extends _AppBase {
* Matches FR-1: always goes through controller.action(), never direct setState.
* @param {string} userId
*/
_dispatchToggle(userId) {
async _dispatchToggle(userId) {
if (!userId) return;
if (this._controller.hasPendingOp?.(userId)) return;
const currentState = this._stateStore.getState(userId) ?? 'active';
const targetState = resolveToggleTarget(currentState);
const opId = generateOpId();
const baseRevision = this._controller.getRevision?.(userId) ?? 0;
this._controller.action('board', userId, targetState, opId, baseRevision);
try {
await Promise.resolve(this._controller.action('board', userId, targetState, opId, baseRevision));
} catch (err) {
console.error('[ScryingPool] toggle action failed for', userId, err);
} finally {
if (this.rendered) this.render({ force: true });
}
}
/**
@@ -393,7 +471,10 @@ export class DirectorsBoard extends _AppBase {
{ label: localize('video-view-manager.directorsBoard.shortcuts.spotlight'), binding: getBinding('spotlightParticipant') ?? 'Ctrl+Shift+P' },
];
const rows = shortcuts.map(s => `<tr><td>${s.label}</td><td><kbd>${s.binding}</kbd></td></tr>`).join('');
// Escape HTML to prevent injection via localised strings or keybinding labels
const escapeHtml = (str) => String(str ?? '').replace(/[&<>"']/g, (c) => ({'&':'&amp;','<':'&lt;','>':'&gt;','"':'&quot;',"'":"&#39;"}[c]));
const rows = shortcuts.map(s => `<tr><td>${escapeHtml(s.label)}</td><td><kbd>${escapeHtml(s.binding)}</kbd></td></tr>`).join('');
const content = `<table class="directors-board__shortcuts-table"><tbody>${rows}</tbody></table>`;
if (typeof Dialog !== 'undefined') {
@@ -409,6 +490,119 @@ export class DirectorsBoard extends _AppBase {
}
}
/**
* Opens the PresetSaveDialog for saving the current visibility matrix as a preset.
*/
_onSavePreset() {
if (!this._scenePresetManager || !this._adapter) {
console.error('[ScryingPool] DirectorsBoard: scenePresetManager or adapter not available');
return;
}
// Close any existing dialog first
this._closePresetDialogs();
// Create and render the save dialog
this._saveDialog = new PresetSaveDialog(this._scenePresetManager, this._adapter);
this._saveDialog.render(true);
}
/**
* Opens the PresetLoadDialog for loading a saved preset.
*/
_onLoadPreset() {
if (!this._scenePresetManager || !this._adapter) {
console.error('[ScryingPool] DirectorsBoard: scenePresetManager or adapter not available');
return;
}
// Close any existing dialog first
this._closePresetDialogs();
// Create and render the load dialog
this._loadDialog = new PresetLoadDialog(this._scenePresetManager, this._adapter);
this._loadDialog.render(true);
}
/**
* Opens the PresetExportDialog for exporting all presets.
*/
_onExportPresets() {
if (!this._scenePresetManager || !this._adapter) {
console.error('[ScryingPool] DirectorsBoard: scenePresetManager or adapter not available');
return;
}
// Close any existing dialog first
this._closePresetDialogs();
// Create and render the export dialog
this._exportDialog = new PresetExportDialog({
adapter: this._adapter,
scenePresetManager: this._scenePresetManager,
});
this._exportDialog.render(true);
}
/**
* Opens the PresetImportDialog for importing presets.
*/
_onImportPresets() {
if (!this._scenePresetManager || !this._adapter) {
console.error('[ScryingPool] DirectorsBoard: scenePresetManager or adapter not available');
return;
}
// Close any existing dialog first
this._closePresetDialogs();
// Create and render the import dialog
this._importDialog = new PresetImportDialog({
adapter: this._adapter,
scenePresetManager: this._scenePresetManager,
});
this._importDialog.render(true);
}
/**
* Closes any open preset dialogs.
* @private
*/
_closePresetDialogs() {
if (this._saveDialog) {
try {
this._saveDialog.close();
} catch {
// Ignore errors during cleanup
}
this._saveDialog = null;
}
if (this._loadDialog) {
try {
this._loadDialog.close();
} catch {
// Ignore errors during cleanup
}
this._loadDialog = null;
}
if (this._exportDialog) {
try {
this._exportDialog.close();
} catch {
// Ignore errors during cleanup
}
this._exportDialog = null;
}
if (this._importDialog) {
try {
this._importDialog.close();
} catch {
// Ignore errors during cleanup
}
this._importDialog = null;
}
}
/**
* ApplicationV2 lifecycle — clean up event listeners when closed.
* @inheritdoc
@@ -416,6 +610,9 @@ export class DirectorsBoard extends _AppBase {
async _onClose(options) {
await super._onClose?.(options);
// Close any open preset dialogs
this._closePresetDialogs();
// Clean up event listeners to prevent memory leaks
if (this._clickHandler) {
this.element?.removeEventListener('click', this._clickHandler);