1 Commits

Author SHA1 Message Date
Gitea OpenCode Agent
d03cc1eb59 Fix issue #57: Sync foundry folder colors
Some checks failed
Test / test (push) Failing after 2s
2026-10-15 13:58:42 +00:00
13 changed files with 398 additions and 320 deletions

View File

@@ -118,6 +118,7 @@ the JWT guard; CORS opened for it): `snapshot` (actors + world items, `fullSync`
- **Identity** is `foundryActorId` / `foundryItemId` (unique per campaign, partial index); a Foundry document carrying the `dragonroll-foundry.actorId` / `.itemId` flag adopts the matching Dragonroll row. - **Identity** is `foundryActorId` / `foundryItemId` (unique per campaign, partial index); a Foundry document carrying the `dragonroll-foundry.actorId` / `.itemId` flag adopts the matching Dragonroll row.
- **Items are deduplicated by name** — Foundry keeps the same gear once per carrier, so one `Item` per name; `foundryNames` keeps Foundry's names so a Dragonroll rename does not resurrect a duplicate. `services/item-foundry.js` returns `null` for non-gear types and those are skipped. - **Items are deduplicated by name** — Foundry keeps the same gear once per carrier, so one `Item` per name; `foundryNames` keeps Foundry's names so a Dragonroll rename does not resurrect a duplicate. `services/item-foundry.js` returns `null` for non-gear types and those are skipped.
- **Item folders mirror the world's item directory** (`Folder.foundryFolderId`, target `item`): every push carries the whole tree and the world owns its names and nesting. `color` is the one field the campaign sets too, so it travels back with the folders `GET /foundry/sync/items` answers with (`{items, folders}`) and the module writes it onto the world's folder.
- **`fullSync` preserves Dragonroll edits** (only new rows are overwritten); live Foundry events overwrite. Only a full snapshot can prune. - **`fullSync` preserves Dragonroll edits** (only new rows are overwritten); live Foundry events overwrite. Only a full snapshot can prune.
- **Autosync is a Foundry-side setting** (`autoSync`, on by default): off = no CRUD push, no periodic reconcile, no startup snapshot; the actor directory's *Dragonroll: Force Sync* still upserts the selection (`fullSync:false`). - **Autosync is a Foundry-side setting** (`autoSync`, on by default): off = no CRUD push, no periodic reconcile, no startup snapshot; the actor directory's *Dragonroll: Force Sync* still upserts the selection (`fullSync:false`).
- `GET /api/foundry/*` (`routes/foundry.js`) is unrelated: a JWT-protected proxy over the read-only bridge. - `GET /api/foundry/*` (`routes/foundry.js`) is unrelated: a JWT-protected proxy over the read-only bridge.

View File

@@ -144,6 +144,16 @@ async function syncFoundryItems(campaign, sources, fullSync = false, folders = n
// say nothing: the folders they carry belong to that actor's own inventory, and // say nothing: the folders they carry belong to that actor's own inventory, and
// Dragonroll keeps one item per piece of gear anyway. // Dragonroll keeps one item per piece of gear anyway.
// The colour a pushed folder carries. `undefined` means the push says nothing about
// colours — an older module, which knows nothing about them — and the colour the
// campaign has stays; `null` is the world leaving a folder uncoloured, which takes
// the campaign's colour off along with it. Anything else is the colour to show.
function foundryFolderColor(source) {
if (source?.color === undefined) return undefined;
const color = typeof source.color === 'string' ? source.color.trim() : '';
return color || null;
}
// Parents before children, so a folder is mapped before the one nested in it. // Parents before children, so a folder is mapped before the one nested in it.
// A folder whose parent is missing, or caught in a cycle, becomes a root. // A folder whose parent is missing, or caught in a cycle, becomes a root.
function orderFoundryFolderSources(sources) { function orderFoundryFolderSources(sources) {
@@ -152,7 +162,12 @@ function orderFoundryFolderSources(sources) {
const id = String(source?.id || '').trim().slice(0, 120); const id = String(source?.id || '').trim().slice(0, 120);
const name = String(source?.name || '').trim(); const name = String(source?.name || '').trim();
if (!id || !name) continue; if (!id || !name) continue;
byId.set(id, { id, name, parent: String(source?.parent || '').trim().slice(0, 120) }); byId.set(id, {
id,
name,
parent: String(source?.parent || '').trim().slice(0, 120),
color: foundryFolderColor(source)
});
} }
const ordered = []; const ordered = [];
@@ -195,6 +210,10 @@ async function syncFoundryItemFolders(campaign, folderSources) {
// The world owns this tree, so unlike an item's fields a rename or a move // The world owns this tree, so unlike an item's fields a rename or a move
// lands whatever kind of push carried it: the whole tree arrives with each. // lands whatever kind of push carried it: the whole tree arrives with each.
folder.name = source.name; folder.name = source.name;
// Its colour is the one part of the tree the campaign colours too: what the
// world shows arrives here, and what the campaign picks travels back to the
// world with the folder list `/sync/items` answers with.
if (source.color !== undefined) folder.color = source.color;
const parent = inTree.has(source.parent) ? folders.get(source.parent) : null; const parent = inTree.has(source.parent) ? folders.get(source.parent) : null;
folder.parentFolder = parent ? parent._id : null; folder.parentFolder = parent ? parent._id : null;
await folder.save(); await folder.save();
@@ -388,12 +407,20 @@ router.post('/sync/item-delete', async (req, res) => {
} }
}); });
// The item list the world reconciles against, together with the folders its rows are
// grouped into — the same shape the campaign's own `/item/list` answers with. The folders
// travel back for their colour: the world owns the tree's name and nesting, while whoever
// colours a folder on either side expects to see it coloured on the other.
router.get('/sync/items', async (req, res) => { router.get('/sync/items', async (req, res) => {
try { try {
const campaign = await syncCampaign(req, res); const campaign = await syncCampaign(req, res);
if (!campaign) return; if (!campaign) return;
const items = await Item.find({ campaign: campaign._id }).sort({ name: 1 }).lean(); const items = await Item.find({ campaign: campaign._id }).sort({ name: 1 }).lean();
res.json({ status: 'ok', items }); const folders = await Folder.find({ campaign: campaign._id, target: 'item' })
.select('_id name color foundryFolderId')
.sort({ name: 1 })
.lean();
res.json({ status: 'ok', items, folders });
} catch (err) { } catch (err) {
console.error(err); console.error(err);
res.json({ status: 'error', msg: 'errors.internal' }); res.json({ status: 'error', msg: 'errors.internal' });

View File

@@ -96,6 +96,10 @@ The campaign's Item list is synchronized with the world's gear, both ways:
properties, description). An item made by hand in Dragonroll is created in the world's item properties, description). An item made by hand in Dragonroll is created in the world's item
directory on the next reconcile, mapped afterwards, and editing it in Dragonroll updates the Foundry directory on the next reconcile, mapped afterwards, and editing it in Dragonroll updates the Foundry
document. document.
- The folders grouping the world's item directory arrive in the campaign as its own item folders, tree
and nesting included, and the items are filed in them. A folder's **colour** goes the other way too:
what the GM colours in Foundry shows on the campaign's folder, and what the campaign colours lands on
the world's folder on the next reconcile (the world's document keeps its name and nesting either way).
- A full snapshot keeps Dragonroll edits on reconnect; live Foundry edits overwrite. Item removal is - A full snapshot keeps Dragonroll edits on reconnect; live Foundry edits overwrite. Item removal is
pruned only by a full snapshot, so a live item push never deletes anything. Deleting a synced item in pruned only by a full snapshot, so a live item push never deletes anything. Deleting a synced item in
Dragonroll removes its Foundry world copy on the next reconcile. Items that live only in an actor's Dragonroll removes its Foundry world copy on the next reconcile. Items that live only in an actor's
@@ -110,14 +114,15 @@ The module calls these Dragonroll routes with the campaign sync token (no Dragon
| `POST /api/foundry/sync/item-snapshot` | Live world item edits, upsert only | | `POST /api/foundry/sync/item-snapshot` | Live world item edits, upsert only |
| `POST /api/foundry/sync/item-delete` | A world item was deleted | | `POST /api/foundry/sync/item-delete` | A world item was deleted |
| `GET /api/foundry/sync/characters` | Characters to apply back in Foundry | | `GET /api/foundry/sync/characters` | Characters to apply back in Foundry |
| `GET /api/foundry/sync/items` | Items to apply back in Foundry | | `GET /api/foundry/sync/items` | Items, and the item folders with their Dragonroll colours, to apply back in Foundry |
| `GET /api/foundry/sync/status` | The campaign this world's token belongs to, for the module's pairing status | | `GET /api/foundry/sync/status` | The campaign this world's token belongs to, for the module's pairing status |
| `POST /api/foundry/sync/map` / `map-item` | Store an id mapping after creating a document | | `POST /api/foundry/sync/map` / `map-item` | Store an id mapping after creating a document |
| `POST /api/foundry/sync/delete` | An actor was deleted | | `POST /api/foundry/sync/delete` | An actor was deleted |
Foundry documents keep the Dragonroll id in the `dragonroll-foundry.actorId` / `dragonroll-foundry.itemId` Foundry documents keep the Dragonroll id in the `dragonroll-foundry.actorId` / `dragonroll-foundry.itemId`
flag, and world items are marked with `dragonroll-foundry.syncMutation` while Dragonroll writes them so flag, and world items are marked with `dragonroll-foundry.syncMutation` while Dragonroll writes them so
the write is not echoed back. the write is not echoed back. A folder colour is written with that folder held in the client's set of
folders being synced, for the same reason.
## 2. Run the bridge on the Foundry host ## 2. Run the bridge on the Foundry host

View File

@@ -23,7 +23,6 @@ let updatingPairingStatus = false;
let linkedCampaignName = ""; let linkedCampaignName = "";
let linkProblem = ""; let linkProblem = "";
let actorSyncTimeout; let actorSyncTimeout;
let characterSyncRetryTimeout;
let characterSyncRunning = false; let characterSyncRunning = false;
let actorSyncErrorLogged = false; let actorSyncErrorLogged = false;
const syncingActorIds = new Set(); const syncingActorIds = new Set();
@@ -34,6 +33,7 @@ let itemSyncErrorLogged = false;
let folderSyncTimeout; let folderSyncTimeout;
let folderSyncRunning = false; let folderSyncRunning = false;
const syncingItemIds = new Set(); const syncingItemIds = new Set();
const syncingFolderIds = new Set();
const queuedItemChanges = new Map(); const queuedItemChanges = new Map();
function getCollectionContents(collection, collectionName) { function getCollectionContents(collection, collectionName) {
@@ -676,10 +676,23 @@ function isWorldItemFolder(folder, seen = new Set()) {
return isWorldItemFolder(parent, seen); return isWorldItemFolder(parent, seen);
} }
// A Foundry folder's colour, or null for one the GM left uncoloured. Null travels as null:
// it tells Dragonroll to take a colour off the folder it was given before, whereas a module
// that says nothing about colours at all leaves the campaign's own choice alone.
function itemFolderColor(folder) {
const color = typeof folder?.color === "string" ? folder.color.trim() : "";
return color || null;
}
function worldItemFolderSnapshots() { function worldItemFolderSnapshots() {
return (game.folders?.contents || []) return (game.folders?.contents || [])
.filter((folder) => isWorldItemFolder(folder)) .filter((folder) => isWorldItemFolder(folder))
.map((folder) => ({ id: folder.id, name: folder.name, parent: itemFolderParent(folder)?.id || null })); .map((folder) => ({
id: folder.id,
name: folder.name,
parent: itemFolderParent(folder)?.id || null,
color: itemFolderColor(folder),
}));
} }
// A world item travels with the folder it stands in, so Dragonroll can file it the // A world item travels with the folder it stands in, so Dragonroll can file it the
@@ -707,6 +720,35 @@ function getWorldItemSnapshots() {
return (game.items?.contents || []).map(serializeFoundryWorldItem).filter(Boolean); return (game.items?.contents || []).map(serializeFoundryWorldItem).filter(Boolean);
} }
// --- Folder colours ----------------------------------------------------------
// Colouring a folder is the one thing about the tree the campaign gets to do on its
// own: the world owns what the folders are called and how they nest, and Dragonroll
// owns the colour its user picks for one. So the colour travels back with the folder
// list the item reconcile reads, and lands on the world's folder — marked, like every
// Dragonroll write, so the world does not echo it straight back to the campaign.
async function withFolderSyncSuppressed(folder, callback) {
if (!folder?.id) return callback();
syncingFolderIds.add(folder.id);
try {
return await callback();
} finally {
syncingFolderIds.delete(folder.id);
}
}
async function applyDragonrollFolderColors(entries) {
for (const entry of entries || []) {
const folder = entry?.foundryFolderId ? game.folders?.get(entry.foundryFolderId) : null;
// Only the world's item directories: a Dragonroll folder the world has no document
// for is the campaign's business alone, and making one there is not ours to do.
if (!folder || folder.documentName !== "Folder" || !isWorldItemFolder(folder)) continue;
const color = entry.color || null;
if (itemFolderColor(folder) === color) continue;
await withFolderSyncSuppressed(folder, () => folder.update({ color }));
}
}
function dragonrollItemIdOf(item) { function dragonrollItemIdOf(item) {
return item.getFlag?.(MODULE_ID, "itemId") || item.flags?.[MODULE_ID]?.itemId || ""; return item.getFlag?.(MODULE_ID, "itemId") || item.flags?.[MODULE_ID]?.itemId || "";
} }
@@ -917,10 +959,13 @@ async function reconcileDragonrollItems() {
if (!token || !game.user?.isGM || !game.world || itemSyncRunning || !isAutoSyncEnabled()) return; if (!token || !game.user?.isGM || !game.world || itemSyncRunning || !isAutoSyncEnabled()) return;
itemSyncRunning = true; itemSyncRunning = true;
try { try {
const result = await getDragonroll("foundry/sync/items", token);
// The folder colours are applied first, and whatever system this world runs: a
// colour is the same on every one of them, while writing an item is what needs D&D 5e.
await applyDragonrollFolderColors(result.folders);
if (game.system.id !== "dnd5e") { if (game.system.id !== "dnd5e") {
throw new Error("Item sync currently requires the D&D 5e Foundry system."); throw new Error("Item sync currently requires the D&D 5e Foundry system.");
} }
const result = await getDragonroll("foundry/sync/items", token);
const remoteItems = result.items || []; const remoteItems = result.items || [];
const remoteById = new Map(remoteItems.map((entry) => [String(entry._id), entry])); const remoteById = new Map(remoteItems.map((entry) => [String(entry._id), entry]));
const localByRemoteId = new Map(game.items.contents const localByRemoteId = new Map(game.items.contents
@@ -1224,14 +1269,6 @@ async function reconcileDragonrollCharacters() {
} }
} }
// Both sides converge on a timer that only runs while the world is open, so a
// round that could not reach Dragonroll is asked for again in a while instead of
// leaving the campaign with whatever it happened to receive.
function scheduleDragonrollCharacterSync(delay = 15000) {
clearTimeout(characterSyncRetryTimeout);
characterSyncRetryTimeout = setTimeout(reconcileDragonrollCharacters, delay);
}
async function initializeCharacterSync() { async function initializeCharacterSync() {
if (!getSyncToken() || !game.user?.isGM || !game.world || !isAutoSyncEnabled()) return; if (!getSyncToken() || !game.user?.isGM || !game.world || !isAutoSyncEnabled()) return;
try { try {
@@ -1356,7 +1393,9 @@ Hooks.once("ready", () => {
} }
// An item folder the GM made, renamed or nested changes the tree the campaign // An item folder the GM made, renamed or nested changes the tree the campaign
// mirrors; nothing about the items themselves changed, so only the tree goes. // mirrors; nothing about the items themselves changed, so only the tree goes.
// A colour Dragonroll has just written into the folder is not the GM changing it.
if (document.documentName === "Folder") { if (document.documentName === "Folder") {
if (syncingFolderIds.has(document.id)) return;
if (document.type === "Item" && isWorldItemFolder(document)) queueFoundryItemFolders(); if (document.type === "Item" && isWorldItemFolder(document)) queueFoundryItemFolders();
return; return;
} }

View File

@@ -24,16 +24,6 @@ const abilityStats = [
{ key: 'int', label: 'INT' }, { key: 'wis', label: 'WIS' }, { key: 'cha', label: 'CHA' } { key: 'int', label: 'INT' }, { key: 'wis', label: 'WIS' }, { key: 'cha', label: 'CHA' }
]; ];
// Les pestanyes del lateral dret reparteixen la fitxa: característiques i combat,
// inventari, trets i conjurs. Són pestanyes de marcadors, no una pàgina nova.
const tabs = [
{ key: 'abilities', label: 'campaigns.character-sheet.tabs.abilities' },
{ key: 'inventory', label: 'campaigns.character-sheet.tabs.inventory' },
{ key: 'traits', label: 'campaigns.character-sheet.tabs.traits' },
{ key: 'spells', label: 'campaigns.character-sheet.tabs.spells' }
];
const activeTab = ref('abilities');
function normalizeActor(actor) { function normalizeActor(actor) {
return { return {
name: actor?.name ?? '', name: actor?.name ?? '',
@@ -217,9 +207,7 @@ async function saveSheet() {
<div v-if="error" class="sheet-error">{{ error }}</div> <div v-if="error" class="sheet-error">{{ error }}</div>
<div class="sheet-layout"> <main class="sheet-grid">
<div class="sheet-content">
<main v-show="activeTab === 'abilities'" class="sheet-grid">
<div v-if="form.image || editing" class="sheet-portrait" :class="{ empty: !form.image }"> <div v-if="form.image || editing" class="sheet-portrait" :class="{ empty: !form.image }">
<img v-if="form.image" :src="imageUrl" :alt="$t('campaigns.character-sheet.photo')"> <img v-if="form.image" :src="imageUrl" :alt="$t('campaigns.character-sheet.photo')">
<button v-if="editing && !form.image" class="portrait-upload" type="button" :disabled="uploadingPhoto" @click="pickPhoto"> <button v-if="editing && !form.image" class="portrait-upload" type="button" :disabled="uploadingPhoto" @click="pickPhoto">
@@ -268,9 +256,19 @@ async function saveSheet() {
<textarea v-if="editing" v-model="form.proficiencies" rows="5" :placeholder="$t('campaigns.character-sheet.proficiencies-placeholder')" /> <textarea v-if="editing" v-model="form.proficiencies" rows="5" :placeholder="$t('campaigns.character-sheet.proficiencies-placeholder')" />
<p v-else class="sheet-copy">{{ form.proficiencies || $t('campaigns.character-sheet.empty-proficiencies') }}</p> <p v-else class="sheet-copy">{{ form.proficiencies || $t('campaigns.character-sheet.empty-proficiencies') }}</p>
</section> </section>
</main>
<main v-show="activeTab === 'inventory'" class="sheet-tab-body"> <section class="sheet-panel traits-panel">
<h2>{{ $t('campaigns.character-sheet.traits') }}</h2>
<textarea v-if="editing" v-model="form.traits" rows="5" :placeholder="$t('campaigns.character-sheet.traits-placeholder')" />
<p v-else class="sheet-copy">{{ form.traits || $t('campaigns.character-sheet.empty-traits') }}</p>
</section>
<section class="sheet-panel spells-panel">
<h2>{{ $t('campaigns.character-sheet.spells') }}</h2>
<textarea v-if="editing" v-model="form.spells" rows="5" :placeholder="$t('campaigns.character-sheet.spells-placeholder')" />
<p v-else class="sheet-copy">{{ form.spells || $t('campaigns.character-sheet.empty-spells') }}</p>
</section>
<section class="sheet-panel inventory-panel"> <section class="sheet-panel inventory-panel">
<div class="panel-title-row"> <div class="panel-title-row">
<h2>{{ $t('campaigns.character-sheet.inventory') }}</h2> <h2>{{ $t('campaigns.character-sheet.inventory') }}</h2>
@@ -304,37 +302,6 @@ async function saveSheet() {
</div> </div>
</section> </section>
</main> </main>
<main v-show="activeTab === 'traits'" class="sheet-tab-body">
<section class="sheet-panel traits-panel">
<h2>{{ $t('campaigns.character-sheet.traits') }}</h2>
<textarea v-if="editing" v-model="form.traits" rows="12" :placeholder="$t('campaigns.character-sheet.traits-placeholder')" />
<p v-else class="sheet-copy">{{ form.traits || $t('campaigns.character-sheet.empty-traits') }}</p>
</section>
</main>
<main v-show="activeTab === 'spells'" class="sheet-tab-body">
<section class="sheet-panel spells-panel">
<h2>{{ $t('campaigns.character-sheet.spells') }}</h2>
<textarea v-if="editing" v-model="form.spells" rows="12" :placeholder="$t('campaigns.character-sheet.spells-placeholder')" />
<p v-else class="sheet-copy">{{ form.spells || $t('campaigns.character-sheet.empty-spells') }}</p>
</section>
</main>
</div>
<nav class="sheet-tabs" role="tablist" aria-orientation="vertical">
<button
v-for="tab in tabs"
:key="tab.key"
class="sheet-tab"
:class="{ active: activeTab === tab.key }"
type="button"
role="tab"
:aria-selected="activeTab === tab.key"
@click="activeTab = tab.key"
>{{ $t(tab.label) }}</button>
</nav>
</div>
</div> </div>
</div> </div>
</template> </template>
@@ -358,27 +325,7 @@ async function saveSheet() {
.sheet-button.primary { background: var(--color-link); color: var(--color-background); border-color: var(--color-link); } .sheet-button.primary { background: var(--color-link); color: var(--color-background); border-color: var(--color-link); }
.sheet-button:disabled { opacity: .55; cursor: wait; } .sheet-button:disabled { opacity: .55; cursor: wait; }
.sheet-button.compact { padding: 5px 9px; font-size: 12px; } .sheet-button.compact { padding: 5px 9px; font-size: 12px; }
.sheet-grid { display: grid; grid-template-columns: minmax(200px, 34%) minmax(0, 1fr) minmax(0, 1fr); grid-template-rows: auto auto; gap: 11px; align-items: start; } .sheet-grid { display: grid; grid-template-columns: minmax(200px, 34%) minmax(0, 1fr) minmax(0, 1fr); grid-template-rows: auto auto auto auto; gap: 11px; align-items: start; }
.sheet-layout { display: flex; align-items: flex-start; gap: 10px; }
.sheet-content { flex: 1 1 auto; min-width: 0; }
.sheet-tab-body { display: block; }
.sheet-tabs { flex: 0 0 auto; display: flex; flex-direction: column; gap: 6px; position: sticky; top: 0; align-self: flex-start; }
.sheet-tab {
text-align: left;
padding: 9px 14px 9px 11px;
border: 1px solid var(--color-border);
border-left-width: 3px;
border-radius: 0 9px 9px 0;
background: var(--color-background-soft);
color: var(--color-text);
font: 13px MrEavesRemake;
letter-spacing: .02em;
white-space: nowrap;
cursor: pointer;
transition: background .15s ease, border-color .15s ease, color .15s ease;
}
.sheet-tab:hover { background: var(--color-button-hover); }
.sheet-tab.active { background: var(--color-background-light); color: var(--color-link); border-left-color: var(--color-link); box-shadow: 0 3px 12px var(--color-window-shadow); }
.sheet-panel { min-width: 0; padding: 13px; border: 1px solid var(--color-border); border-radius: 10px; background: var(--color-background-light); box-shadow: 0 3px 12px var(--color-window-shadow); } .sheet-panel { min-width: 0; padding: 13px; border: 1px solid var(--color-border); border-radius: 10px; background: var(--color-background-light); box-shadow: 0 3px 12px var(--color-window-shadow); }
.sheet-panel h2 { margin: 0 0 12px; padding-bottom: 7px; border-bottom: 1px solid var(--color-border); font: 17px MrEavesRemake; letter-spacing: .03em; } .sheet-panel h2 { margin: 0 0 12px; padding-bottom: 7px; border-bottom: 1px solid var(--color-border); font: 17px MrEavesRemake; letter-spacing: .03em; }
.sheet-panel h3 { margin: 13px 0 7px; font: 14px MrEavesRemake; } .sheet-panel h3 { margin: 13px 0 7px; font: 14px MrEavesRemake; }
@@ -393,7 +340,9 @@ async function saveSheet() {
.portrait-controls button:disabled { opacity: .55; cursor: wait; } .portrait-controls button:disabled { opacity: .55; cursor: wait; }
.photo-input { display: none; } .photo-input { display: none; }
.abilities-panel { grid-column: 2 / -1; grid-row: 1; } .abilities-panel { grid-column: 2 / -1; grid-row: 1; }
.combat-panel { grid-column: 2 / -1; grid-row: 2; } .combat-panel { grid-column: 2; grid-row: 2; }
.traits-panel { grid-column: 3; grid-row: 2; }
.spells-panel { grid-column: 2 / -1; grid-row: 3; }
.ability-grid { display: grid; grid-template-columns: repeat(6, minmax(0, 1fr)); gap: 7px; } .ability-grid { display: grid; grid-template-columns: repeat(6, minmax(0, 1fr)); gap: 7px; }
.ability-card { min-height: 83px; padding: 8px 5px; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 3px; border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft); } .ability-card { min-height: 83px; padding: 8px 5px; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 3px; border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft); }
.ability-label { font-size: 11px; font-weight: 700; letter-spacing: .08em; opacity: .75; } .ability-label { font-size: 11px; font-weight: 700; letter-spacing: .08em; opacity: .75; }
@@ -420,6 +369,7 @@ textarea { resize: vertical; width: 100%; min-height: 88px; font-size: 12px; }
.weight-summary strong { white-space: nowrap; } .weight-summary strong { white-space: nowrap; }
.weight-track { height: 5px; margin-bottom: 10px; overflow: hidden; border-radius: 999px; background: var(--color-background-soft); } .weight-track { height: 5px; margin-bottom: 10px; overflow: hidden; border-radius: 999px; background: var(--color-background-soft); }
.weight-fill { height: 100%; border-radius: inherit; background: var(--color-link); transition: width .2s ease; } .weight-fill { height: 100%; border-radius: inherit; background: var(--color-link); transition: width .2s ease; }
.inventory-panel { grid-column: 2 / -1; grid-row: 4; }
.inventory-table-wrap { overflow-x: auto; } .inventory-table-wrap { overflow-x: auto; }
.inventory-table { width: 100%; border-collapse: collapse; font-size: 12px; } .inventory-table { width: 100%; border-collapse: collapse; font-size: 12px; }
.inventory-table th { padding: 6px 7px; text-align: left; font-weight: 600; opacity: .7; } .inventory-table th { padding: 6px 7px; text-align: left; font-weight: 600; opacity: .7; }
@@ -433,17 +383,17 @@ textarea { resize: vertical; width: 100%; min-height: 88px; font-size: 12px; }
.sheet-error { padding: 7px 10px; margin-bottom: 10px; border-radius: 6px; color: var(--color-red); background: var(--color-background-soft); font-size: 12px; } .sheet-error { padding: 7px 10px; margin-bottom: 10px; border-radius: 6px; color: var(--color-red); background: var(--color-background-soft); font-size: 12px; }
.sr-only { position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0; } .sr-only { position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0; }
@media (max-width: 760px) { @media (max-width: 760px) {
.sheet-grid { grid-template-columns: 1fr; grid-template-rows: none; } .sheet-grid { grid-template-columns: 1fr 1fr; grid-template-rows: none; }
.sheet-portrait, .abilities-panel, .combat-panel { grid-column: 1 / -1; grid-row: auto; } .sheet-portrait { grid-column: 1 / -1; grid-row: auto; }
.abilities-panel { grid-column: 1 / -1; grid-row: auto; }
.combat-panel, .traits-panel { grid-column: auto; grid-row: auto; }
.spells-panel, .inventory-panel { grid-column: 1 / -1; grid-row: auto; }
} }
@media (max-width: 520px) { @media (max-width: 520px) {
.sheet-body { padding: 10px; } .sheet-body { padding: 10px; }
.sheet-hero { align-items: flex-start; flex-wrap: wrap; } .sheet-hero { align-items: flex-start; flex-wrap: wrap; }
.sheet-actions { margin-left: auto; } .sheet-actions { margin-left: auto; }
.sheet-grid { grid-template-columns: 1fr; }
.ability-grid { grid-template-columns: repeat(3, minmax(0, 1fr)); } .ability-grid { grid-template-columns: repeat(3, minmax(0, 1fr)); }
.sheet-layout { flex-direction: column; }
.sheet-tabs { flex-direction: row; flex-wrap: wrap; order: -1; }
.sheet-tab { flex: 1 1 auto; text-align: center; border-radius: 7px; border-left-width: 1px; border-top-width: 3px; }
.sheet-tab.active { border-left-color: var(--color-border); border-top-color: var(--color-link); }
} }
</style> </style>

View File

@@ -105,7 +105,6 @@
}, },
"character-sheet": { "character-sheet": {
"title": "Fitxa de personatge", "name": "Nom del personatge", "class": "Classe", "subclass": "Subclasse", "unset-class": "Classe sense definir", "title": "Fitxa de personatge", "name": "Nom del personatge", "class": "Classe", "subclass": "Subclasse", "unset-class": "Classe sense definir",
"tabs": { "abilities": "Característiques", "inventory": "Inventari", "traits": "Trets", "spells": "Conjurs" },
"level": "Nivell", "species": "Espècie", "unset-species": "Espècie sense definir", "edit": "Edita la fitxa", "cancel": "Cancel·la", "level": "Nivell", "species": "Espècie", "unset-species": "Espècie sense definir", "edit": "Edita la fitxa", "cancel": "Cancel·la",
"saving": "Desant...", "save": "Desa la fitxa", "save-error": "No s'ha pogut desar aquesta fitxa de personatge.", "photo": "Foto", "upload-photo": "Pujar foto", "change-photo": "Canviar foto", "remove-photo": "Treure foto", "uploading-photo": "Pujant...", "photo-error": "No s'ha pogut pujar aquesta foto.", "ability-scores": "Característiques", "proficiency-bonus": "Bonificador de competència", "saving": "Desant...", "save": "Desa la fitxa", "save-error": "No s'ha pogut desar aquesta fitxa de personatge.", "photo": "Foto", "upload-photo": "Pujar foto", "change-photo": "Canviar foto", "remove-photo": "Treure foto", "uploading-photo": "Pujant...", "photo-error": "No s'ha pogut pujar aquesta foto.", "ability-scores": "Característiques", "proficiency-bonus": "Bonificador de competència",
"combat": "Combat", "armor-class": "Classe d'armadura", "speed": "Velocitat", "proficiencies": "Competències", "combat": "Combat", "armor-class": "Classe d'armadura", "speed": "Velocitat", "proficiencies": "Competències",

View File

@@ -109,7 +109,6 @@
}, },
"character-sheet": { "character-sheet": {
"title": "Character Sheet", "name": "Character name", "class": "Class", "subclass": "Subclass", "unset-class": "Class not set", "title": "Character Sheet", "name": "Character name", "class": "Class", "subclass": "Subclass", "unset-class": "Class not set",
"tabs": { "abilities": "Ability Scores", "inventory": "Inventory", "traits": "Traits", "spells": "Spells" },
"level": "Level", "species": "Species", "unset-species": "Species not set", "edit": "Edit sheet", "cancel": "Cancel", "level": "Level", "species": "Species", "unset-species": "Species not set", "edit": "Edit sheet", "cancel": "Cancel",
"saving": "Saving...", "save": "Save sheet", "save-error": "Unable to save this character sheet.", "saving": "Saving...", "save": "Save sheet", "save-error": "Unable to save this character sheet.",
"photo": "Photo", "upload-photo": "Upload photo", "change-photo": "Change photo", "remove-photo": "Remove photo", "photo": "Photo", "upload-photo": "Upload photo", "change-photo": "Change photo", "remove-photo": "Remove photo",

View File

@@ -105,7 +105,6 @@
}, },
"character-sheet": { "character-sheet": {
"title": "Hoja de personaje", "name": "Nombre del personaje", "class": "Clase", "subclass": "Subclase", "unset-class": "Clase sin definir", "title": "Hoja de personaje", "name": "Nombre del personaje", "class": "Clase", "subclass": "Subclase", "unset-class": "Clase sin definir",
"tabs": { "abilities": "Características", "inventory": "Inventario", "traits": "Rasgos", "spells": "Conjuros" },
"level": "Nivel", "species": "Especie", "unset-species": "Especie sin definir", "edit": "Editar hoja", "cancel": "Cancelar", "level": "Nivel", "species": "Especie", "unset-species": "Especie sin definir", "edit": "Editar hoja", "cancel": "Cancelar",
"saving": "Guardando...", "save": "Guardar hoja", "save-error": "No se pudo guardar esta hoja de personaje.", "photo": "Foto", "upload-photo": "Subir foto", "change-photo": "Cambiar foto", "remove-photo": "Quitar foto", "uploading-photo": "Subiendo...", "photo-error": "No se pudo subir esta foto.", "ability-scores": "Características", "proficiency-bonus": "Bonificador por competencia", "saving": "Guardando...", "save": "Guardar hoja", "save-error": "No se pudo guardar esta hoja de personaje.", "photo": "Foto", "upload-photo": "Subir foto", "change-photo": "Cambiar foto", "remove-photo": "Quitar foto", "uploading-photo": "Subiendo...", "photo-error": "No se pudo subir esta foto.", "ability-scores": "Características", "proficiency-bonus": "Bonificador por competencia",
"combat": "Combate", "armor-class": "Clase de armadura", "speed": "Velocidad", "proficiencies": "Competencias", "combat": "Combate", "armor-class": "Clase de armadura", "speed": "Velocidad", "proficiencies": "Competencias",

View File

@@ -1,89 +0,0 @@
// Tests for Syndria98/dragonroll#55: the character sheet splits its contents across bookmarks down
// the right edge (ability scores, inventory, traits, spells) instead of stacking every panel on one
// long page.
//
// The repository root installs no dependencies, so the window wiring is read from the sources the way
// tests/item-sheet-window.test.js and tests/settings-window.test.js do it.
//
// Run with `npm test` from the repository root, or `node --test tests/`.
const { test } = require("node:test");
const assert = require("node:assert/strict");
const fs = require("node:fs");
const path = require("node:path");
const read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
const sheetSource = read("frontend", "app", "components", "windows", "CharacterSheetWindow.vue");
const script = /<script setup>([\s\S]*?)<\/script>/.exec(sheetSource)?.[1] ?? "";
const template = /<template>([\s\S]*)<\/template>/.exec(sheetSource)?.[1] ?? "";
// The four bookmarks the issue asks for, in order.
test("the sheet declares the four tabs the issue splits the contents into", () => {
const array = /const tabs = \[([\s\S]*?)\];/.exec(script)?.[1] ?? "";
const keys = [...array.matchAll(/key:\s*['"](\w+)['"]/g)].map((m) => m[1]);
assert.deepEqual(keys, ["abilities", "inventory", "traits", "spells"]);
for (const key of keys) {
assert.ok(
new RegExp(`label:\\s*['"]campaigns\\.character-sheet\\.tabs\\.${key}['"]`).test(array),
`the ${key} tab must point at its own i18n key`
);
}
assert.match(script, /const activeTab = ref\(['"]abilities['"]\)/, "the sheet opens on the ability scores tab");
});
test("the tabs sit on the right as a vertical bookmark rail", () => {
assert.match(template, /<nav class="sheet-tabs"[^>]*role="tablist"[^>]*aria-orientation="vertical"/);
assert.match(template, /v-for="tab in tabs"[\s\S]*?:aria-selected="activeTab === tab\.key"/);
const rail = /\.sheet-tabs\s*\{[^}]*\}/.exec(sheetSource)?.[0] ?? "";
assert.match(rail, /flex-direction:\s*column/, "the bookmarks stack down the right edge");
// content column and rail sit side by side, the rail hugging the right
assert.match(sheetSource, /\.sheet-layout\s*\{[^}]*display:\s*flex[^}]*\}/, "content and rail share a row");
assert.match(sheetSource, /\.sheet-content\s*\{[^}]*flex:\s*1[^}]*\}/, "the content takes the room, the rail stays slim");
});
// Each tab shows only its own panels; the rest are hidden with v-show so an in-progress edit is
// not thrown away when hopping between tabs.
function tabBody(key) {
const block = new RegExp(`<main v-show="activeTab === '${key}'"[\\s\\S]*?</main>`).exec(template)?.[0];
assert.ok(block, `expected a body for the ${key} tab`);
return block;
}
test("every tab shows only its own content and hides the others", () => {
const abilities = tabBody("abilities");
assert.match(abilities, /class="sheet-portrait"/, "the portrait stays with ability scores");
assert.match(abilities, /class="sheet-panel abilities-panel"/);
assert.match(abilities, /class="sheet-panel combat-panel"/, "combat rides with the ability scores");
for (const other of ["inventory-panel", "traits-panel", "spells-panel"]) {
assert.doesNotMatch(abilities, new RegExp(other));
}
for (const [key, panel] of [["inventory", "inventory-panel"], ["traits", "traits-panel"], ["spells", "spells-panel"]]) {
const body = tabBody(key);
assert.ok(body.includes(panel), `the ${key} tab shows the ${panel}`);
assert.doesNotMatch(body, /class="sheet-portrait"/);
}
// the panels are toggled, not unmounted, so editing on one tab and flipping away keeps the draft
assert.match(template, /v-show="activeTab === 'inventory'"/);
assert.match(template, /v-show="activeTab === 'traits'"/);
assert.match(template, /v-show="activeTab === 'spells'"/);
});
test("the tabs still edit and save through the existing sheet form", () => {
assert.match(tabBody("inventory"), /@click="addInventoryItem"/);
assert.match(tabBody("inventory"), /removeInventoryItem\(index\)/);
assert.match(tabBody("traits"), /v-model="form\.traits"/);
assert.match(tabBody("spells"), /v-model="form\.spells"/);
assert.match(tabBody("abilities"), /v-model\.number="form\.abilityScores\[stat\.key\]"/);
});
test("every locale names the four tabs", () => {
for (const locale of ["en", "es", "ca"]) {
const sheet = JSON.parse(read("frontend", "i18n", "locales", locale, "campaigns.json"))["character-sheet"];
for (const key of ["abilities", "inventory", "traits", "spells"]) {
assert.ok(sheet.tabs?.[key], `${locale} is missing campaigns.character-sheet.tabs.${key}`);
}
}
});

View File

@@ -1,7 +1,9 @@
// Tests for item folders following the Foundry world into the campaign // Tests for item folders following the Foundry world into the campaign
// (Syndria98/dragonroll#44): the world's item directory is grouped into folders, and // (Syndria98/dragonroll#44): the world's item directory is grouped into folders, and
// Dragonroll mirrors that tree as Folders of target 'item' and files the synced items // Dragonroll mirrors that tree as Folders of target 'item' and files the synced items
// in them, so its item list reads like the world's. // in them, so its item list reads like the world's. And for those folders' colours
// going both ways (Syndria98/dragonroll#57): the world's colour arrives with its tree,
// and the one the campaign picks travels back on the folder list the module reads.
// //
// The repository root installs no dependencies, so each side is loaded the way the // The repository root installs no dependencies, so each side is loaded the way the
// other tests do it. The sync route runs against a stubbed `require` (express, // other tests do it. The sync route runs against a stubbed `require` (express,
@@ -55,7 +57,7 @@ function matches(document, filter = {}) {
}); });
} }
function fakeModel(table, seed = [], campaignId) { function fakeModel(table, seed = []) {
const rows = []; const rows = [];
let counter = 0; let counter = 0;
@@ -74,9 +76,7 @@ function fakeModel(table, seed = [], campaignId) {
Object.defineProperty(Document.prototype, "id", { get() { return this._id; } }); Object.defineProperty(Document.prototype, "id", { get() { return this._id; } });
for (const data of seed) { for (const data of seed) {
// A seeded row belongs to the campaign the requests are made against unless the const row = new Document({ [table === "folder" ? "target" : "name"]: undefined, ...data });
// seed says otherwise: the routes scope every lookup by campaign.
const row = new Document({ campaign: campaignId, [table === "folder" ? "target" : "name"]: undefined, ...data });
row.isNew = false; row.isNew = false;
rows.push(row); rows.push(row);
} }
@@ -122,17 +122,19 @@ function loadSyncRoute({ seed = {}, worldId = "world-1" } = {}) {
post: (route, ...handlers) => routes.set(`POST ${route}`, handlers), post: (route, ...handlers) => routes.set(`POST ${route}`, handlers),
}; };
const campaign = { _id: "campaign-1", id: "campaign-1", name: "Test Campaign", foundryWorldId: worldId }; const campaign = { _id: "campaign-1", id: "campaign-1", name: "Test Campaign", foundryWorldId: worldId };
// Every row belongs to the campaign the sync token belongs to, like every real row
// does: the sync looks its rows up by campaign, so a seeded row without one would be
// invisible to it and a test would pass without touching what it means to check.
const seeded = (rows = []) => rows.map((row) => ({ campaign: campaign._id, ...row }));
const models = { const models = {
"../models/Actor": fakeModel("actor", seed.actors, campaign.id), "../models/Actor": fakeModel("actor", seeded(seed.actors)),
"../models/Item": fakeModel("item", seed.items, campaign.id), "../models/Item": fakeModel("item", seeded(seed.items)),
"../models/Folder": fakeModel("folder", seed.folders, campaign.id), "../models/Folder": fakeModel("folder", seeded(seed.folders)),
}; };
const requireStub = (id) => { const requireStub = (id) => {
if (id === "express") return { Router: () => router }; if (id === "express") return { Router: () => router };
// The route hashes the sync token with node's own crypto: the real module costs nothing if (id.startsWith("node:")) return require(id); // crypto: the sync token is hashed, not stubbed
// to hand it, and nothing here depends on what the hash looks like.
if (id === "node:crypto") return require("node:crypto");
if (id === "mongoose") return { isValidObjectId: (value) => typeof value === "string" && value.length > 20 }; if (id === "mongoose") return { isValidObjectId: (value) => typeof value === "string" && value.length > 20 };
if (id === "../models/Campaign") return { findOne: async () => campaign }; if (id === "../models/Campaign") return { findOne: async () => campaign };
if (id === "../services/actor-foundry") return { foundryActorToCharacter: (actor) => ({ name: actor?.name ?? "" }) }; if (id === "../services/actor-foundry") return { foundryActorToCharacter: (actor) => ({ name: actor?.name ?? "" }) };
@@ -295,6 +297,74 @@ test("an item the world moved out of a folder follows it to the root", async ()
assert.equal(sync.models["../models/Item"].rows[0].folder, null); assert.equal(sync.models["../models/Item"].rows[0].folder, null);
}); });
test("a folder coloured in the world is coloured in the campaign", async () => {
const sync = loadSyncRoute();
await sync.call("POST /sync/item-snapshot", {
worldId: "world-1",
items: [],
folders: [{ id: "folder-melee", name: "Melee Weapons", parent: null, color: "#7f00ff" }],
});
assert.equal(sync.models["../models/Folder"].rows[0].color, "#7f00ff");
});
test("a folder the world leaves uncoloured takes the campaign's colour off", async () => {
const sync = loadSyncRoute({
seed: {
folders: [{ _id: "folder-1", target: "item", foundryFolderId: "folder-melee", name: "Melee Weapons", color: "#7f00ff" }],
},
});
await sync.call("POST /sync/item-snapshot", {
worldId: "world-1",
items: [],
folders: [{ id: "folder-melee", name: "Melee Weapons", parent: null, color: null }],
});
assert.equal(sync.models["../models/Folder"].rows[0].color, null, "the world has no colour to show, so neither does the campaign");
});
test("a module that says nothing about colours leaves the campaign's colour alone", async () => {
const sync = loadSyncRoute({
seed: {
folders: [{ _id: "folder-1", target: "item", foundryFolderId: "folder-melee", name: "Melee Weapons", color: "#7f00ff" }],
},
});
// A tree pushed by a module that knows folders but not their colours: no colour at all.
await sync.call("POST /sync/snapshot", {
worldId: "world-1",
actors: [],
items: [],
folders: [{ id: "folder-melee", name: "Melee Weapons", parent: null }],
});
assert.equal(sync.models["../models/Folder"].rows[0].color, "#7f00ff");
});
test("the folder list the world reads back carries the colours the campaign picked", async () => {
const sync = loadSyncRoute({
seed: {
folders: [
{ _id: "folder-1", target: "item", foundryFolderId: "folder-melee", name: "Melee Weapons", color: "#0080ff" },
{ _id: "folder-2", target: "item", name: "Homebrew" },
{ _id: "folder-3", name: "Chapter 1" },
],
items: [{ _id: "item-1", name: "Longsword", foundryItemId: "item-1", folder: "folder-1" }],
},
});
const response = await sync.call("GET /sync/items");
assert.equal(response.status, "ok");
assert.equal(response.items.length, 1);
const coloured = response.folders.find((folder) => folder._id === "folder-1");
assert.equal(coloured.foundryFolderId, "folder-melee", "the world's folder to write the colour back to");
assert.equal(coloured.color, "#0080ff");
assert.ok(!response.folders.some((folder) => folder._id === "folder-3"), "only the item list's folders travel back");
});
test("every folder listing says which campaign list it belongs to", () => { test("every folder listing says which campaign list it belongs to", () => {
// The sidebar's four lists share the Folder model, so a listing that names no target // The sidebar's four lists share the Folder model, so a listing that names no target
// would show folders of the other lists between its own rows. The note routes and // would show folders of the other lists between its own rows. The note routes and
@@ -303,12 +373,9 @@ test("every folder listing says which campaign list it belongs to", () => {
// field existed carry none at all. tests/entry-folders.test.js runs these routes. // field existed carry none at all. tests/entry-folders.test.js runs these routes.
for (const route of ["note.js", "folder.js"]) { for (const route of ["note.js", "folder.js"]) {
const source = read("backend", "src", "routes", route); const source = read("backend", "src", "routes", route);
// The listings that gather a campaign's folders are the ones shown as a section's const listings = source.match(/Folder\.find\(/g) ?? [];
// tree. A walk of one folder's own children (`parentFolder`) is inside a single
// list already: folders are only ever nested within their own section.
const listings = source.match(/Folder\.find\(\{\s*campaign/g) ?? [];
assert.ok(listings.length, `${route} lists folders`); assert.ok(listings.length, `${route} lists folders`);
const filtered = source.match(/Folder\.find\(\{\s*campaign[^{]*Folder\.filterForTarget\((?:'note'|target)\)/g) ?? []; const filtered = source.match(/Folder\.find\(\{[^{]*Folder\.filterForTarget\((?:'note'|target)\)/g) ?? [];
assert.equal(filtered.length, listings.length, `${route} has a folder listing that names no campaign list`); assert.equal(filtered.length, listings.length, `${route} has a folder listing that names no campaign list`);
} }
}); });
@@ -328,15 +395,40 @@ function makeWorld() {
registered: new Map(), registered: new Map(),
requests: [], requests: [],
timers: new Map(), timers: new Map(),
intervals: new Map(),
// What Dragonroll answers a folder reconcile with: the campaign's folders and the
// colours its user gave them.
remoteFolders: [],
nextTimerId: 1, nextTimerId: 1,
}; };
// Foundry's `update` takes dotted paths ("flags.dragonroll-foundry.itemId"); an
// embedded update names the row to write them on, so `_id` is not a path to set.
function writeFoundryPaths(target, data) {
for (const [key, value] of Object.entries(data)) {
if (key === "_id") continue;
const parts = key.split(".");
const last = parts.pop();
let node = target;
for (const part of parts) node = node[part] ??= {};
node[last] = value;
}
return target;
}
// A Folder document, plain data and the `update` both the GM and Dragonroll write with.
const makeFolder = (id, name, over = {}) => ({
id, name, type: "Item", parent: null, color: null, documentName: "Folder",
async update(data) { return writeFoundryPaths(this, data); },
...over,
});
const folders = [ const folders = [
{ id: "folder-melee", name: "Melee Weapons", type: "Item", parent: null, documentName: "Folder" }, makeFolder("folder-melee", "Melee Weapons", { color: "#8b0000" }),
{ id: "folder-ranged", name: "Ranged Weapons", type: "Item", parent: "folder-melee", documentName: "Folder" }, makeFolder("folder-ranged", "Ranged Weapons", { parent: "folder-melee" }),
// An actor's own inventory folder: it hangs off the actor, not the world. // An actor's own inventory folder: it hangs off the actor, not the world.
{ id: "folder-carried", name: "Carried", type: "Item", parent: { id: "actor-1", documentName: "Actor" }, documentName: "Folder" }, makeFolder("folder-carried", "Carried", { parent: { id: "actor-1", documentName: "Actor" } }),
{ id: "folder-journal", name: "Lore", type: "JournalEntry", parent: null, documentName: "Folder" }, makeFolder("folder-journal", "Lore", { type: "JournalEntry" }),
]; ];
const items = [ const items = [
{ {
@@ -362,10 +454,15 @@ function makeWorld() {
id: "actor-1", name: "Thalia", type: "character", documentName: "Actor", flags: {}, id: "actor-1", name: "Thalia", type: "character", documentName: "Actor", flags: {},
items: { contents: [carriedItem] }, items: { contents: [carriedItem] },
getFlag() { return undefined; }, getFlag() { return undefined; },
// A pushed actor has its items marked as synced and itself mapped to the async update(data) { return writeFoundryPaths(this, data); },
// campaign row: nothing here reads those flags back. // Embedded documents are written through the document holding them, and each
async update() { return this; }, // update names the row it belongs to.
async updateEmbeddedDocuments() { return []; }, async updateEmbeddedDocuments(_kind, updates) {
for (const update of updates) {
if (carriedItem.id === update._id) writeFoundryPaths(carriedItem, update);
}
return [];
},
toObject() { return { _id: this.id, name: this.name, type: this.type, flags: this.flags }; }, toObject() { return { _id: this.id, name: this.name, type: this.type, flags: this.flags }; },
}, },
]; ];
@@ -387,15 +484,24 @@ function makeWorld() {
return id; return id;
}, },
clearTimeout: (id) => state.timers.delete(id), clearTimeout: (id) => state.timers.delete(id),
setInterval: () => 0, setInterval: (fn, delay = 0) => {
clearInterval: () => {}, // Recorded, never run by itself: tests ask for a periodic reconcile with
// `runIntervals`, so the ones watching single pushes stay on their own.
const id = state.nextTimerId++;
state.intervals.set(id, { fn, delay });
return id;
},
clearInterval: (id) => state.intervals.delete(id),
fetch: async (url, options = {}) => { fetch: async (url, options = {}) => {
const href = String(url);
state.requests.push({ state.requests.push({
href: String(url), href,
method: options.method, method: options.method,
body: options.body ? JSON.parse(options.body) : null, body: options.body ? JSON.parse(options.body) : null,
}); });
return { ok: true, status: 200, json: async () => ({ status: "ok", actors: [], items: [] }) }; const payload = { status: "ok", actors: [], items: [] };
if (href.includes("foundry/sync/items")) payload.folders = state.remoteFolders;
return { ok: true, status: 200, json: async () => payload };
}, },
Actor: { async create() { return null; } }, Actor: { async create() { return null; } },
Item: { async create() { return null; } }, Item: { async create() { return null; } },
@@ -446,6 +552,12 @@ function makeWorld() {
await drain(); await drain();
} }
}; };
// The reconciles `setInterval` registered: what runs every few seconds on a world
// that is linked, and so what carries Dragonroll's folder colours back into the world.
state.runIntervals = async () => {
for (const interval of [...state.intervals.values()]) await interval.fn();
await drain();
};
state.linkedSetup = async () => { state.linkedSetup = async () => {
await state.fire("init"); await state.fire("init");
await state.fire("ready"); await state.fire("ready");
@@ -466,9 +578,9 @@ test("the world sends its item folder tree with a snapshot", async () => {
const [push] = world.pushes("foundry/sync/snapshot"); const [push] = world.pushes("foundry/sync/snapshot");
assert.ok(push, "the actor change pushed a snapshot"); assert.ok(push, "the actor change pushed a snapshot");
assert.deepEqual(push.body.folders, [ assert.deepEqual(push.body.folders, [
{ id: "folder-melee", name: "Melee Weapons", parent: null }, { id: "folder-melee", name: "Melee Weapons", parent: null, color: "#8b0000" },
{ id: "folder-ranged", name: "Ranged Weapons", parent: "folder-melee" }, { id: "folder-ranged", name: "Ranged Weapons", parent: "folder-melee", color: null },
], "the item directory tree, nested, without the actor's own or another type's folders"); ], "the item directory tree, nested and coloured, without the actor's own or another type's folders");
const longsword = push.body.items.find((item) => item._id === "item-1"); const longsword = push.body.items.find((item) => item._id === "item-1");
assert.equal(longsword.dragonroll.folder, "folder-melee", "a world item says which folder it stands in"); assert.equal(longsword.dragonroll.folder, "folder-melee", "a world item says which folder it stands in");
const torch = push.body.items.find((item) => item._id === "item-2"); const torch = push.body.items.find((item) => item._id === "item-2");
@@ -513,6 +625,21 @@ test("a folder change reaches Dragonroll without pushing the items in it", async
]); ]);
}); });
test("a folder the GM colours sends its colour with the tree", async () => {
const world = await makeWorld().linkedSetup();
const ranged = world.folder("folder-ranged");
ranged.color = "#123456";
await world.fire("updateFolder", ranged);
await world.runTimers();
const [push] = world.pushes("foundry/sync/item-snapshot");
assert.deepEqual(push.body.folders.map((folder) => [folder.id, folder.color]), [
["folder-melee", "#8b0000"],
["folder-ranged", "#123456"],
], "every folder reports the colour the world shows for it, `null` for one it left uncoloured");
});
test("a folder of another document type does not touch the item list", async () => { test("a folder of another document type does not touch the item list", async () => {
const world = await makeWorld().linkedSetup(); const world = await makeWorld().linkedSetup();
@@ -533,8 +660,48 @@ test("autosync off: folder changes stop syncing", async () => {
assert.deepEqual(world.syncRequests(), []); assert.deepEqual(world.syncRequests(), []);
}); });
// --- The colours the campaign gives those folders travel back to the world ---------
test("a folder coloured in the Dragonroll campaign is coloured in the world", async () => {
const world = await makeWorld().linkedSetup();
world.remoteFolders = [
{ _id: "db-melee", name: "Melee Weapons", foundryFolderId: "folder-melee", color: "#0080ff" },
// A folder the campaign made for its own items: there is no world document to colour.
{ _id: "db-homebrew", name: "Homebrew", color: "#00ff00" },
];
await world.runIntervals();
assert.equal(world.folder("folder-melee").color, "#0080ff");
assert.equal(world.folder("folder-ranged").color, null, "a folder the campaign says nothing about keeps what the world shows");
assert.deepEqual(world.requests.filter((request) => request.method === "POST"), [],
"Dragonroll's own write is not pushed back to the campaign as a world change");
});
test("a colour taken off in the campaign comes off the world's folder", async () => {
const world = await makeWorld().linkedSetup();
world.remoteFolders = [{ _id: "db-melee", name: "Melee Weapons", foundryFolderId: "folder-melee", color: null }];
await world.runIntervals();
assert.equal(world.folder("folder-melee").color, null, "uncoloured in the campaign is uncoloured in the world");
});
test("autosync off: the campaign's folder colours are not written into the world", async () => {
const world = await makeWorld().linkedSetup();
await world.game.settings.set("dragonroll-foundry", "autoSync", false);
world.remoteFolders = [{ _id: "db-melee", name: "Melee Weapons", foundryFolderId: "folder-melee", color: "#0080ff" }];
await world.runIntervals();
assert.equal(world.folder("folder-melee").color, "#8b0000", "the world keeps what it shows while autosync is off");
});
// --- The sidebar groups its items under those folders ---------------------------- // --- The sidebar groups its items under those folders ----------------------------
// `vm.compileFunction` is synchronous, so the service is ready right away. Loading it with
// a top-level `await` instead makes Node read this whole file as an ES module, where
// `require` is not defined and none of these tests run at all.
function loadItemFoldersService() { function loadItemFoldersService() {
const source = read("frontend", "app", "services", "ItemFolders.js").replace("export { BuildItemRows };", "return { BuildItemRows };"); const source = read("frontend", "app", "services", "ItemFolders.js").replace("export { BuildItemRows };", "return { BuildItemRows };");
return vm.compileFunction(source)(); return vm.compileFunction(source)();
@@ -558,15 +725,13 @@ test("items are grouped under the folder they stand in, nested", () => {
row.kind, row.kind === "folder" ? row.folder.name : row.item.name, row.depth, row.kind, row.kind === "folder" ? row.folder.name : row.item.name, row.depth,
]); ]);
// Every folder is followed by what stands in it, one step deeper, and the items that
// stand at the root come last (see BuildItemRows).
assert.deepEqual(shape, [ assert.deepEqual(shape, [
["folder", "Melee Weapons", 0], ["folder", "Melee Weapons", 0],
["item", "Longsword", 1],
["folder", "Ranged Weapons", 0], ["folder", "Ranged Weapons", 0],
["folder", "Powder Weapons", 1], ["folder", "Powder Weapons", 1],
["item", "Pistol", 2], ["item", "Pistol", 1],
["item", "Torch", 0], ["item", "Torch", 0],
["item", "Longsword", 1],
]); ]);
}); });
@@ -593,9 +758,9 @@ test("an item whose folder is gone, or a folder nested in itself, reads as a roo
); );
const shape = rows.map((row) => [row.kind, row.kind === "folder" ? row.folder.name : row.item.name]); const shape = rows.map((row) => [row.kind, row.kind === "folder" ? row.folder.name : row.item.name]);
assert.ok(shape.some(([kind, name]) => kind === "item" && name === "Torch"), "the item is not lost with the folder that was removed"); assert.ok(shape.includes(["item", "Torch"]), "the item is not lost with the folder that was removed");
assert.deepEqual(new Set(shape.filter(([kind]) => kind === "folder").map(([, name]) => name)), new Set(["A", "B"])); assert.deepEqual(new Set(shape.filter(([kind]) => kind === "folder").map(([, name]) => name)), new Set(["A", "B"]));
assert.equal(shape.filter(([kind]) => kind === "folder").length, 2, "a broken tree is walked once, not forever"); assert.equal(rows.filter(([kind]) => kind === "folder").length, 2, "a broken tree is walked once, not forever");
}); });
test("every locale labels the folder row", () => { test("every locale labels the folder row", () => {

View File

@@ -66,8 +66,8 @@ test("the item routes accept the icon and upload one", () => {
test("the item info window is registered and opens on a sidebar click", () => { test("the item info window is registered and opens on a sidebar click", () => {
assert.match(windowDefsSource, /item_sheet:\s*{\s*title:[^}]*ItemSheetWindow\.vue/s); assert.match(windowDefsSource, /item_sheet:\s*{\s*title:[^}]*ItemSheetWindow\.vue/s);
// clicking (or Enter/Space on) an item row opens the window instead of expanding inline. // clicking (or Enter/Space on) an item row opens the window instead of expanding inline.
// The rows come from the item list's folder tree, so the row holds the item. // Since #44 the rows come from the folder tree the world synced, so the row holds the item.
assert.match(sidebarSource, /v-for="row in entryRows\.item\.value"[\s\S]*?@click="openItemSheet\(row\.item\)"/); assert.match(sidebarSource, /v-for="row in itemRows"[\s\S]*?@click="openItemSheet\(row\.item\)"/);
assert.match(sidebarSource, /CreateWindow\(['"]item_sheet['"],\s*\{ item \}\)/); assert.match(sidebarSource, /CreateWindow\(['"]item_sheet['"],\s*\{ item \}\)/);
assert.doesNotMatch(sidebarSource, /toggleEntryDetails/); assert.doesNotMatch(sidebarSource, /toggleEntryDetails/);
}); });

View File

@@ -85,9 +85,6 @@ function loadMapRoutes({ ownsCampaign = true, maps = [], notes = [] } = {}) {
}, },
// The pins do not ask after actors, only the token routes below do. // The pins do not ask after actors, only the token routes below do.
"../models/Actor": { findOne: () => mongooseQuery(null) }, "../models/Actor": { findOne: () => mongooseQuery(null) },
// The map list's own folder tree: `/list` reads it and `/update` checks a move
// against it, so the pins need the model to answer, never what it answers.
"../models/Folder": { find: () => mongooseQuery([]), belongsToSection: async () => true },
}); });
} }
@@ -184,12 +181,7 @@ function loadNoteRoutes({ ownsCampaign = true, notes = [], folders = [], deleted
findById: (id) => mongooseQuery(notes.find((note) => note._id === id) ?? null), findById: (id) => mongooseQuery(notes.find((note) => note._id === id) ?? null),
deleteOne: () => mongooseQuery({ deletedCount }), deleteOne: () => mongooseQuery({ deletedCount }),
}, },
"../models/Folder": { "../models/Folder": { find: () => mongooseQuery(folders) },
find: () => mongooseQuery(folders),
// models/Folder.js: the note tree is every folder that is not one of the other
// campaign lists, whose rows carry no target at all.
filterForTarget: (target) => (target === "note" ? { target: { $nin: ["actor", "item", "map"] } } : { target }),
},
"../models/Map": { "../models/Map": {
// The driver drops the pins of the note from every map holding one; what is worth // The driver drops the pins of the note from every map holding one; what is worth
// keeping here is the filter it is asked to do that with. // keeping here is the filter it is asked to do that with.

View File

@@ -82,9 +82,6 @@ function loadMapRoutes({ ownsCampaign = true, maps = [], actors = [] } = {}) {
: null : null
), ),
}, },
// The map list's own folder tree: `/list` reads it and `/update` checks a move
// against it, so the tokens need the model to answer, never what it answers.
"../models/Folder": { find: () => mongooseQuery([]), belongsToSection: async () => true },
}); });
} }
@@ -191,8 +188,6 @@ function loadActorRoutes({ ownsCampaign = true, actors = [], deletedCount = 1 }
return { modifiedCount: 1 }; return { modifiedCount: 1 };
}, },
}, },
// The actor list's own folder tree, which the delete does not ask after.
"../models/Folder": { find: () => mongooseQuery([]), belongsToSection: async () => true },
}); });
return { api, tokensPulled }; return { api, tokensPulled };
} }
@@ -304,14 +299,10 @@ function mapViewerTokenWiringTests() {
const sidebar = readRepoFile("frontend", "app", "components", "partials", "ContentSidebar.vue"); const sidebar = readRepoFile("frontend", "app", "components", "partials", "ContentSidebar.vue");
test("an actor row of the sidebar can be dragged out of it", () => { test("an actor row of the sidebar can be dragged out of it", () => {
// The actors' block of the sidebar: since the entry lists got their folders the rows const actorRow = /<div v-for="actor in actors"[^>]*>/.exec(sidebar)?.[0];
// come from that tree, so the actor row holds its actor as `row.item`.
const actorSection = /<template v-else-if="activeSection === 'actors'">([\s\S]*?)<\/template>\s*\n\s*<template v-else-if="activeSection === 'items'">/
.exec(sidebar)?.[1] ?? "";
const actorRow = /<div v-else class="entity-entry"[^>]*>/.exec(actorSection)?.[0];
assert.ok(actorRow, "expected the actor rows of the sidebar"); assert.ok(actorRow, "expected the actor rows of the sidebar");
assert.match(actorRow, /draggable="true"/); assert.match(actorRow, /draggable="true"/);
assert.match(actorRow, /@dragstart="startActorDrag\(\$event, row\.item\)"/); assert.match(actorRow, /@dragstart="startActorDrag\(\$event, actor\)"/);
assert.match(sidebar, /setData\(ACTOR_DRAG_TYPE, String\(actor\._id\)\)/); assert.match(sidebar, /setData\(ACTOR_DRAG_TYPE, String\(actor\._id\)\)/);
}); });