Compare commits
30 Commits
72596c3d15
...
ai/issue-1
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
eead3c9be8 | ||
| b5d5e570d5 | |||
|
|
cd1e3cb125 | ||
| 013c3512fe | |||
| 3f2ac16394 | |||
| 55fbacbdd7 | |||
| 5efe43fd99 | |||
| 00ac1b16cd | |||
|
|
07dcf08616 | ||
|
|
967c704801 | ||
| c9ee16f2f2 | |||
|
|
abcec4d2ff | ||
| dcc6d7a14b | |||
| 227fff1351 | |||
| a64fe499e9 | |||
| b75ee05276 | |||
| bc7231a1da | |||
| 252ae2d6b2 | |||
|
|
30e23b643c | ||
|
|
8376acfc6b | ||
|
|
f8dae95563 | ||
| 98aa3be078 | |||
| 80c6b1b62f | |||
| 2cce19e032 | |||
| abacfeca40 | |||
| f925881a54 | |||
|
|
9aad484fe9 | ||
|
|
5ee7353123 | ||
|
|
f0ffa2f72b | ||
| 2c1cc970e6 |
16
AGENTS.md
16
AGENTS.md
@@ -83,11 +83,12 @@ campaign, and handlers check ownership with a `userOwnsCampaign(campaignId, user
|
||||
|
||||
- `User` — `name*`, `username*`, `email*` (both unique), `password` (bcrypt, 10 rounds), `admin`, `image`, `setupCode`, `settings`
|
||||
- `Campaign` — `name*`, `createdBy*`→User, `description`, `color`, `settings`, `foundryWorldId`/`foundryWorldTitle`/`foundrySystem`, `foundrySyncTokenHash` (`select: false`), `discordGuildId`
|
||||
- `Note` — `title`, `content` (markdown source), `campaign*`, `folder` (null = root), `color`
|
||||
- `Note` — `title`, `content` (markdown source), `campaign*`, `folder` (null = root), `color`, `foundryPageId`
|
||||
- `Folder` — `name*`, `campaign*`, `parentFolder` (null = root, self-ref), `color`
|
||||
- `Actor` — `name*`, `campaign*`, `foundryActorId` (unique per campaign), `discordUserId` (the Discord player holding the character, unique per campaign — set only by `routes/discord.js`), plus free-form sheet fields (`type`, `species`, `className`, `level`, `abilityScores`, `armorClass`, `speed`, `proficiencies`, `traits`, `spells`, `image`) and `inventory[{name,quantity,weight}]` (flattened Foundry items, **not** `Item` docs)
|
||||
- `Item` — `name*`, `campaign*`, `foundryItemId` (unique per campaign), `foundryNames`, `category`, `rarity`, `quantity`, `weight`, `properties`, `description`
|
||||
- `Map` — `name*`, `campaign*`, `image` (filename in `src/uploads`), `gridSize`/`offsetX`/`offsetY`/`scale` (image px), `pins[{note→Note, x, y}]` (addressed by the pin's own `_id`), `tokens[{actor→Actor, x, y}]` (the centre of the grid cell the token stands in, also addressed by its own `_id`)
|
||||
- `Map` — `name*`, `campaign*`, `image` (filename in `src/uploads`, or a full URL a synced scene's
|
||||
picture arrives as), `gridSize`/`offsetX`/`offsetY`/`scale` (image px), `pins[{note→Note, x, y}]` (addressed by the pin's own `_id`), `tokens[{actor→Actor, x, y}]` (the centre of the grid cell the token stands in, also addressed by its own `_id`), `foundrySceneId` (the Foundry scene this map mirrors, unique per campaign)
|
||||
- `ServiceLinkRequest` — the pending/completed service pairings of §4; `DiscordGuildLink` maps a Discord guild to the Dragonroll user who claimed it
|
||||
|
||||
**API surface** (all under `/api`, all `{status,msg}`):
|
||||
@@ -114,11 +115,15 @@ rest, expire after 10 min, and Obsidian gets a long-lived (365 d) token back.
|
||||
|
||||
Foundry then syncs with that token on `/api/foundry/sync/*` (`routes/foundry-link.js`, mounted before
|
||||
the JWT guard; CORS opened for it): `snapshot` (actors + world items, `fullSync` also prunes),
|
||||
`item-snapshot`, `item-delete`, `characters`, `items`, `status`, `map` / `map-item`, `delete`. Rules:
|
||||
`item-snapshot`, `item-delete`, `scenes` (the world's scenes as the campaign's maps, `fullSync` also
|
||||
prunes), `scene-delete`, `characters`, `items`, `notes` / `map-note`, `status`,
|
||||
`map` / `map-item`, `delete`. Rules:
|
||||
|
||||
- **Identity** is `foundryActorId` / `foundryItemId` (unique per campaign, partial index); a Foundry document carrying the `dragonroll-foundry.actorId` / `.itemId` flag adopts the matching Dragonroll row.
|
||||
- **Only the world's item directory reaches the item list** (Syndria98/dragonroll#67) — `snapshotItemSources` reads `body.items` (`game.items`) alone; gear embedded in a character is that actor's `inventory` (see the `Actor` model), not an `Item`. A world item still folds into a hand-made or renamed row it matches by name (`foundryNames`), so a 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.
|
||||
- **A world's scenes arrive as its campaign's maps** (Syndria98/dragonroll#99): `POST /foundry/sync/scenes` writes one `Map` per scene through `saveFoundryScene`, and only the scene's background picture and grid cross over (`services/map-foundry.js`: `gridSize` from `grid`/`grid.size`, the offsets from `flags.core.shiftX`/`.shiftY`) — `scale`, the folder, the pins and the tokens stay with the campaign and nothing of a map goes back to the world. Identity is `Map.foundrySceneId` (unique per campaign), a `dragonroll-foundry.mapId` flag or a hand-made unmapped map of the same name; a scene with no picture makes no map. `POST /foundry/sync/scene-delete` drops the map of a deleted scene, and only the full list the module sends when the world links or loads prunes.
|
||||
- **Notes reach the world as journal pages, one way** (Syndria98/dragonroll#98): the module reads `GET /sync/notes` and stands every campaign note as a page of one world `JournalEntry` named Dragonroll — the page carries the note's id in a `dragonroll-foundry.noteId` flag, the note keeps the page's id in `foundryPageId` (`POST /sync/map-note`). The reconcile rewrites pages from the notes and drops the page of a deleted note; journal edits never travel back.
|
||||
- **`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`).
|
||||
- `GET /api/foundry/*` (`routes/foundry.js`) is unrelated: a JWT-protected proxy over the read-only bridge. Its one write, `POST /import`, pulls the bridge's actors or world items into the campaign through the same writers as a sync push.
|
||||
@@ -142,7 +147,10 @@ name is the slug, and the first heading is the title. `services/Docs.js` reads t
|
||||
(`import.meta.glob(..., {query:'?raw'})`), builds the sidebar and renders a page with marked;
|
||||
`services/DocsMarkdown.js` holds the heading/slug helpers the sidebar and the anchors share and imports
|
||||
nothing so `tests/docs.test.js` can load it. A new group's label goes in `docs.json` under
|
||||
`groups.<folder>` **in all three locales**. The first page is served at `/docs` itself.
|
||||
`groups.<folder>` **in all three locales**. The first page is served at `/docs` itself, and inside a
|
||||
campaign the top bar opens the same pages in the `documentation` window
|
||||
(`components/windows/DocumentationWindow.vue`), which holds the page it shows as its own state instead
|
||||
of a route so the campaign stays behind it.
|
||||
|
||||
Two kinds of screens: **windows** (floating draggable/resizable overlays) and **content** — the
|
||||
campaign workspace (`TopBar` + `ContentSidebar` + note column + `StatusBar`), turned on when
|
||||
|
||||
@@ -34,10 +34,57 @@ const ActorSchema = new Schema({
|
||||
max: { type: Number, min: 0, default: 1 }
|
||||
},
|
||||
proficiencies: { type: String, default: '' },
|
||||
// The skills the character is proficient with (Syndria98/dragonroll#83). Dragonroll holds
|
||||
// whole names; services/actor-foundry.js translates the short keys a Foundry world uses.
|
||||
skills: {
|
||||
acrobatics: { type: Boolean, default: false },
|
||||
animalHandling: { type: Boolean, default: false },
|
||||
arcana: { type: Boolean, default: false },
|
||||
athletics: { type: Boolean, default: false },
|
||||
deception: { type: Boolean, default: false },
|
||||
history: { type: Boolean, default: false },
|
||||
insight: { type: Boolean, default: false },
|
||||
intimidation: { type: Boolean, default: false },
|
||||
investigation: { type: Boolean, default: false },
|
||||
medicine: { type: Boolean, default: false },
|
||||
nature: { type: Boolean, default: false },
|
||||
perception: { type: Boolean, default: false },
|
||||
performance: { type: Boolean, default: false },
|
||||
persuasion: { type: Boolean, default: false },
|
||||
religion: { type: Boolean, default: false },
|
||||
sleightOfHand: { type: Boolean, default: false },
|
||||
stealth: { type: Boolean, default: false },
|
||||
survival: { type: Boolean, default: false }
|
||||
},
|
||||
// Which of the six saving throws the character adds its proficiency bonus to.
|
||||
savingThrows: {
|
||||
str: { type: Boolean, default: false },
|
||||
dex: { type: Boolean, default: false },
|
||||
con: { type: Boolean, default: false },
|
||||
int: { type: Boolean, default: false },
|
||||
wis: { type: Boolean, default: false },
|
||||
cha: { type: Boolean, default: false }
|
||||
},
|
||||
// Tool and language proficiencies: plain names, one per entry. The free-form
|
||||
// `proficiencies` text keeps whatever else the character is proficient with
|
||||
// (armour and weapons, say), which has no list of its own.
|
||||
tools: [{ type: String, trim: true }],
|
||||
languages: [{ type: String, trim: true }],
|
||||
// The coins the character holds, in the five D&D denominations.
|
||||
currency: {
|
||||
pp: { type: Number, min: 0, default: 0 },
|
||||
gp: { type: Number, min: 0, default: 0 },
|
||||
ep: { type: Number, min: 0, default: 0 },
|
||||
sp: { type: Number, min: 0, default: 0 },
|
||||
cp: { type: Number, min: 0, default: 0 }
|
||||
},
|
||||
inventory: [{
|
||||
name: { type: String, trim: true, default: '' },
|
||||
quantity: { type: Number, min: 1, default: 1 },
|
||||
weight: { type: Number, min: 0, default: 0 }
|
||||
weight: { type: Number, min: 0, default: 0 },
|
||||
// The gear's own picture: what a Foundry world sends with the item it stands
|
||||
// for, shown on the left of the inventory row.
|
||||
icon: { type: String, default: '' }
|
||||
}],
|
||||
traits: { type: String, default: '' },
|
||||
spells: { type: String, default: '' },
|
||||
|
||||
@@ -39,7 +39,15 @@ const MapSchema = new Schema({
|
||||
ref: 'Folder',
|
||||
default: null
|
||||
},
|
||||
// The Foundry scene this map mirrors, set by the scene sync only
|
||||
// (see routes/foundry-link.js). Only the picture and the grid follow the world.
|
||||
foundrySceneId: { type: String },
|
||||
date: { type: Date, default: Date.now }
|
||||
});
|
||||
|
||||
MapSchema.index(
|
||||
{ campaign: 1, foundrySceneId: 1 },
|
||||
{ unique: true, partialFilterExpression: { foundrySceneId: { $type: 'string' } } }
|
||||
);
|
||||
|
||||
module.exports = mongoose.model('Map', MapSchema);
|
||||
|
||||
@@ -14,7 +14,16 @@ const NoteSchema = new Schema({
|
||||
ref: 'Folder'
|
||||
},
|
||||
color: { type: String },
|
||||
// The journal page this note is written as in the linked Foundry world: the
|
||||
// page of the one "Dragonroll" journal whose rows carry this note's id in
|
||||
// their `dragonroll-foundry.noteId` flag (see the module's notes sync).
|
||||
foundryPageId: { type: String },
|
||||
date: { type: Date, default: Date.now }
|
||||
});
|
||||
|
||||
NoteSchema.index(
|
||||
{ campaign: 1, foundryPageId: 1 },
|
||||
{ unique: true, partialFilterExpression: { foundryPageId: { $type: 'string' } } }
|
||||
);
|
||||
|
||||
module.exports = mongoose.model('Note', NoteSchema);
|
||||
@@ -22,6 +22,13 @@ function barPool(existing, value) {
|
||||
return { current, max };
|
||||
}
|
||||
|
||||
// The tool and language lists (Syndria98/dragonroll#83): plain names, blank ones and
|
||||
// repeats dropped.
|
||||
function textList(value) {
|
||||
if (!Array.isArray(value)) return [];
|
||||
return [...new Set(value.map((name) => String(name).trim()).filter(Boolean))];
|
||||
}
|
||||
|
||||
// Folders the campaign's actors are grouped into, in the shape the sidebar groups by
|
||||
// (the notes, items and maps each keep a tree of their own, see models/Folder.js).
|
||||
async function actorFolders(campaignId) {
|
||||
@@ -65,7 +72,10 @@ router.post('/create', async (req, res) => {
|
||||
|
||||
router.post('/update', async (req, res) => {
|
||||
try {
|
||||
const { id, name, species, className, subclass, level, abilityScores, armorClass, speed, hitPoints, hitDice, proficiencies, inventory, traits, spells, image, folder } = req.body;
|
||||
const {
|
||||
id, name, species, className, subclass, level, abilityScores, armorClass, speed, hitPoints, hitDice,
|
||||
proficiencies, skills, savingThrows, tools, languages, currency, inventory, traits, spells, image, folder
|
||||
} = req.body;
|
||||
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||
|
||||
const actor = await Actor.findById(id);
|
||||
@@ -92,6 +102,14 @@ router.post('/update', async (req, res) => {
|
||||
if (hitPoints !== undefined) actor.hitPoints = barPool(actor.hitPoints, hitPoints);
|
||||
if (hitDice !== undefined) actor.hitDice = barPool(actor.hitDice, hitDice);
|
||||
if (proficiencies !== undefined) actor.proficiencies = proficiencies;
|
||||
// The lists the sheet toggles and fills in (Syndria98/dragonroll#83): which skills
|
||||
// and saving throws the character is proficient with, its tools, its languages and
|
||||
// the coins it carries.
|
||||
if (skills !== undefined) actor.skills = skills;
|
||||
if (savingThrows !== undefined) actor.savingThrows = savingThrows;
|
||||
if (tools !== undefined) actor.tools = textList(tools);
|
||||
if (languages !== undefined) actor.languages = textList(languages);
|
||||
if (currency !== undefined) actor.currency = currency;
|
||||
if (inventory !== undefined) actor.inventory = inventory;
|
||||
if (traits !== undefined) actor.traits = traits;
|
||||
if (spells !== undefined) actor.spells = spells;
|
||||
|
||||
@@ -6,9 +6,14 @@ const router = express.Router();
|
||||
const Campaign = require('../models/Campaign');
|
||||
const Actor = require('../models/Actor');
|
||||
const Item = require('../models/Item');
|
||||
// Not `Map`: this route builds plain `Map`s of its own to mirror the world's folder tree.
|
||||
const MapModel = require('../models/Map');
|
||||
const Folder = require('../models/Folder');
|
||||
const Note = require('../models/Note');
|
||||
const { foundryActorToCharacter } = require('../services/actor-foundry');
|
||||
const { foundryItemToItemData } = require('../services/item-foundry');
|
||||
const { foundrySceneToMapData } = require('../services/map-foundry');
|
||||
const { joinFoundryAssetUrl } = require('../services/foundry-icons');
|
||||
|
||||
// Upper bound for the Foundry names remembered per synced item (see Item model).
|
||||
const MAX_FOUNDRY_NAMES = 20;
|
||||
@@ -41,10 +46,33 @@ function requestMatchesWorld(campaign, worldId) {
|
||||
return typeof worldId === 'string' && worldId === campaign.foundryWorldId;
|
||||
}
|
||||
|
||||
async function saveFoundryActor(campaign, source, fullSync = false) {
|
||||
// Foundry serves its data directory from the world's own address, which is the one the
|
||||
// campaign keeps under `settings.integrations.foundryUrl` — the icon window already loads
|
||||
// the world's icons through it. The module sends the images it publishes as absolute URLs;
|
||||
// the bridge's snapshot and older modules carry Foundry's relative paths, and a sheet
|
||||
// reading one of those against Dragonroll's upload folder finds nothing, which is how the
|
||||
// icons stopped loading (Syndria98/dragonroll#89). An absolute URL travels as it is, and so
|
||||
// does a path when the campaign has no world address to read it against.
|
||||
function worldAssetUrl(image, worldUrl) {
|
||||
const value = String(image ?? '').trim();
|
||||
if (!value || /^(https?:|data:|\/\/)/i.test(value)) return value;
|
||||
return joinFoundryAssetUrl(worldUrl, value) || value;
|
||||
}
|
||||
|
||||
// The images a world document arrives with, read against its world before they land.
|
||||
function resolveWorldAssets(fields, campaign) {
|
||||
const worldUrl = campaign?.settings?.integrations?.foundryUrl;
|
||||
if (typeof fields.image === 'string') fields.image = worldAssetUrl(fields.image, worldUrl);
|
||||
if (Array.isArray(fields.inventory)) {
|
||||
for (const entry of fields.inventory) entry.icon = worldAssetUrl(entry.icon, worldUrl);
|
||||
}
|
||||
}
|
||||
|
||||
async function saveFoundryActor(campaign, source, fullSync = false, replace = false) {
|
||||
const foundryActorId = String(source?._id || source?.id || '').trim().slice(0, 120);
|
||||
const fields = foundryActorToCharacter(source || {});
|
||||
const fields = foundryActorToCharacter(source || {}, replace);
|
||||
if (!foundryActorId || !fields.name) return null;
|
||||
resolveWorldAssets(fields, campaign);
|
||||
|
||||
let actor = await Actor.findOne({ campaign: campaign._id, foundryActorId });
|
||||
const dragonrollActorId = source?.flags?.['dragonroll-foundry']?.actorId;
|
||||
@@ -85,6 +113,7 @@ async function saveFoundryItem(campaign, source, fullSync = false, folders = nul
|
||||
const foundryItemId = String(source?._id || source?.id || '').trim().slice(0, 120);
|
||||
const fields = foundryItemToItemData(source || {});
|
||||
if (!foundryItemId || !fields) return null;
|
||||
resolveWorldAssets(fields, campaign);
|
||||
|
||||
let item = await Item.findOne({ campaign: campaign._id, foundryItemId });
|
||||
const dragonrollItemId = source?.flags?.['dragonroll-foundry']?.itemId;
|
||||
@@ -243,6 +272,47 @@ function resolveFoundryItemFolder(source, folders) {
|
||||
return folders.get(foundryFolderId.trim())?._id || null;
|
||||
}
|
||||
|
||||
// --- Maps -------------------------------------------------------------------
|
||||
// A scene of the world becomes one of the campaign's maps (Syndria98/dragonroll#99):
|
||||
// services/map-foundry.js says what of a scene travels — its background picture and the
|
||||
// grid laid over it, and nothing else, so the map's pins, its tokens, the folder it
|
||||
// stands in and what one of its cells means stay the campaign's own.
|
||||
|
||||
async function saveFoundryScene(campaign, source, fullSync = false) {
|
||||
const foundrySceneId = String(source?._id || source?.id || '').trim().slice(0, 120);
|
||||
const fields = foundrySceneToMapData(source || {});
|
||||
if (!foundrySceneId || !fields) return null;
|
||||
resolveWorldAssets(fields, campaign);
|
||||
|
||||
let map = await MapModel.findOne({ campaign: campaign._id, foundrySceneId });
|
||||
const dragonrollMapId = source?.flags?.['dragonroll-foundry']?.mapId;
|
||||
if (!map && mongoose.isValidObjectId(dragonrollMapId)) {
|
||||
const flagged = await MapModel.findOne({ _id: dragonrollMapId, campaign: campaign._id });
|
||||
// Only adopt a flagged map while no other scene owns its mapping.
|
||||
if (flagged && (!flagged.foundrySceneId || flagged.foundrySceneId === foundrySceneId)) map = flagged;
|
||||
}
|
||||
if (!map) {
|
||||
// The campaign drew this place by hand before the scene of it ever arrived: a scene
|
||||
// naming the one unmapped map the campaign holds folds into that row instead of
|
||||
// adding a second copy of the same room.
|
||||
const sameName = await MapModel.find({
|
||||
campaign: campaign._id,
|
||||
name: fields.name,
|
||||
foundrySceneId: { $exists: false }
|
||||
}).limit(2);
|
||||
map = sameName.length === 1 ? sameName[0] : new MapModel({ campaign: campaign._id });
|
||||
}
|
||||
|
||||
map.foundrySceneId = foundrySceneId;
|
||||
// `created` says whether this row is new, like the actor and item writers answer it.
|
||||
const created = map.isNew;
|
||||
// A full snapshot runs when a GM reconnects: the grid the campaign lined up for a map
|
||||
// it already has survives that. Live scene edits continue to overwrite normally.
|
||||
if (!fullSync || map.isNew) Object.assign(map, fields);
|
||||
await map.save();
|
||||
return { foundrySceneId, mapId: map.id, created };
|
||||
}
|
||||
|
||||
|
||||
// Linking a world to a campaign happens through the sign-up link every service
|
||||
// uses (routes/service-link.js); what stays here is the sync that world keeps up
|
||||
@@ -279,12 +349,16 @@ router.post('/sync/snapshot', async (req, res) => {
|
||||
}
|
||||
|
||||
const fullSync = req.body.fullSync === true;
|
||||
// A forced actor sync from the module's context menu replaces the campaign's
|
||||
// row for the actors it sends entirely (Syndria98/dragonroll#96). It stays
|
||||
// clear of fullSync: it never prunes, unlike a reconnect's full snapshot.
|
||||
const replace = req.body.replace === true;
|
||||
// A module that knows nothing about item folders sends neither the tree
|
||||
// nor the folder of an item, and then nothing here touches the folders.
|
||||
const folderSources = Array.isArray(req.body.folders) ? req.body.folders : null;
|
||||
const actors = [];
|
||||
for (const source of actorSources || []) {
|
||||
const mapping = await saveFoundryActor(campaign, source, fullSync);
|
||||
const mapping = await saveFoundryActor(campaign, source, fullSync, replace);
|
||||
if (mapping) actors.push(mapping);
|
||||
}
|
||||
const itemFolders = folderSources ? await syncFoundryItemFolders(campaign, folderSources) : null;
|
||||
@@ -409,6 +483,59 @@ router.post('/sync/item-delete', async (req, res) => {
|
||||
}
|
||||
});
|
||||
|
||||
// The world's scenes, upserted as the campaign's maps (Syndria98/dragonroll#99). Like a
|
||||
// world item push, this one prunes only when it is told it carries every scene: that push
|
||||
// alone sees the whole scene list, so it alone knows which synced maps the world has let go
|
||||
// of. A map the campaign made by hand has no scene of its own and is never pruned.
|
||||
router.post('/sync/scenes', async (req, res) => {
|
||||
try {
|
||||
const campaign = await syncCampaign(req, res);
|
||||
if (!campaign) return;
|
||||
if (!requestMatchesWorld(campaign, req.body.worldId) || !Array.isArray(req.body.scenes)) {
|
||||
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||
}
|
||||
|
||||
const fullSync = req.body.fullSync === true;
|
||||
const maps = [];
|
||||
for (const source of req.body.scenes) {
|
||||
const mapping = await saveFoundryScene(campaign, source, fullSync);
|
||||
if (mapping) maps.push(mapping);
|
||||
}
|
||||
if (fullSync) {
|
||||
const currentIds = req.body.scenes
|
||||
.map((source) => String(source?._id || source?.id || '').trim())
|
||||
.filter(Boolean);
|
||||
await MapModel.deleteMany({
|
||||
campaign: campaign._id,
|
||||
foundrySceneId: { $exists: true, $nin: currentIds }
|
||||
});
|
||||
}
|
||||
res.json({ status: 'ok', maps });
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
res.json({ status: 'error', msg: 'errors.internal' });
|
||||
}
|
||||
});
|
||||
|
||||
// A scene the world deleted takes its map with it. Only the world says so; deleting a map
|
||||
// in the campaign leaves the world's scene alone, which is the campaign's own to do.
|
||||
router.post('/sync/scene-delete', async (req, res) => {
|
||||
try {
|
||||
const campaign = await syncCampaign(req, res);
|
||||
if (!campaign) return;
|
||||
const foundrySceneId = String(req.body.foundrySceneId || '').trim();
|
||||
if (!requestMatchesWorld(campaign, req.body.worldId) || !foundrySceneId) {
|
||||
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||
}
|
||||
|
||||
await MapModel.deleteOne({ campaign: campaign._id, foundrySceneId });
|
||||
res.json({ status: 'ok' });
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
res.json({ status: 'error', msg: 'errors.internal' });
|
||||
}
|
||||
});
|
||||
|
||||
// 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
|
||||
@@ -452,6 +579,57 @@ router.post('/sync/map-item', async (req, res) => {
|
||||
}
|
||||
});
|
||||
|
||||
// --- Note pages ------------------------------------------------------------
|
||||
// The campaign's notes are read where their authors' table sits: every note
|
||||
// stands as a page of the one journal the world calls "Dragonroll". Notes are
|
||||
// written in Dragonroll, so this copy runs one way — the module reads the notes
|
||||
// and rewrites their pages; nothing of the journal travels back. Its pages keep
|
||||
// the note's id in a `dragonroll-foundry.noteId` flag, and the note keeps the
|
||||
// page's id here, so either side recognises the pairing again after a restart.
|
||||
|
||||
// Every note of the campaign, content included: enough for the module to write
|
||||
// each one as a page. Folders of the notes do not travel — the journal is flat.
|
||||
router.get('/sync/notes', async (req, res) => {
|
||||
try {
|
||||
const campaign = await syncCampaign(req, res);
|
||||
if (!campaign) return;
|
||||
const notes = await Note.find({ campaign: campaign._id })
|
||||
.select('_id title content foundryPageId date')
|
||||
.sort({ date: -1 })
|
||||
.lean();
|
||||
res.json({ status: 'ok', notes });
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
res.json({ status: 'error', msg: 'errors.internal' });
|
||||
}
|
||||
});
|
||||
|
||||
// The page the module made for a note, kept on the note so the next reconcile —
|
||||
// or a world whose page flags were lost — writes that page instead of a second
|
||||
// one under the same title.
|
||||
router.post('/sync/map-note', async (req, res) => {
|
||||
try {
|
||||
const campaign = await syncCampaign(req, res);
|
||||
if (!campaign) return;
|
||||
const { noteId, foundryPageId, worldId } = req.body;
|
||||
if (!requestMatchesWorld(campaign, worldId) || !noteId || !foundryPageId) {
|
||||
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||
}
|
||||
|
||||
const note = await Note.findOne({ _id: noteId, campaign: campaign._id });
|
||||
if (!note) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||
const existing = await Note.findOne({ campaign: campaign._id, foundryPageId, _id: { $ne: note._id } });
|
||||
if (existing) return res.json({ status: 'error', msg: 'foundry.errors.note-already-synced' });
|
||||
|
||||
note.foundryPageId = String(foundryPageId).trim().slice(0, 120);
|
||||
await note.save();
|
||||
res.json({ status: 'ok', note });
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
res.json({ status: 'error', msg: 'errors.internal' });
|
||||
}
|
||||
});
|
||||
|
||||
module.exports = router;
|
||||
// The writers every Foundry document goes through: the sync pushes above, and the
|
||||
// force import a campaign asks for from its sidebar (routes/foundry.js). One set of
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
const { numberOr, asText, plainText, stringList } = require('./foundry-fields');
|
||||
const { isFoundryGearType } = require('./item-foundry');
|
||||
|
||||
// D&D 5e keeps an actor's background, species, class and subclass as a reference to an
|
||||
// embedded item: `system.details.background` and friends hold that item's id, and the
|
||||
@@ -23,7 +24,117 @@ function detailsName(value, items) {
|
||||
return looksLikeFoundryId(text) ? '' : text;
|
||||
}
|
||||
|
||||
function foundryActorToCharacter(foundryActor) {
|
||||
// --- Skills, saving throws, tools, languages and coins (Syndria98/dragonroll#83) ---
|
||||
|
||||
// The eighteen skills a 5e character has, as the system keys them and as Dragonroll
|
||||
// names them. The short keys mean nothing outside Foundry, and Dragonroll's sheet holds
|
||||
// the names it shows a user.
|
||||
const FOUNDRY_SKILLS = {
|
||||
acr: 'acrobatics', ani: 'animalHandling', arc: 'arcana', ath: 'athletics', dec: 'deception',
|
||||
his: 'history', ins: 'insight', itm: 'intimidation', inv: 'investigation', med: 'medicine',
|
||||
nat: 'nature', prc: 'perception', perf: 'performance', prs: 'persuasion', rel: 'religion',
|
||||
sle: 'sleightOfHand', stl: 'stealth', sur: 'survival'
|
||||
};
|
||||
const ABILITIES = ['str', 'dex', 'con', 'int', 'wis', 'cha'];
|
||||
const CURRENCIES = ['pp', 'gp', 'ep', 'sp', 'cp'];
|
||||
|
||||
// Whether one of the system's proficiency fields says the character has that
|
||||
// proficiency. The system has held it several ways across its releases — a boolean, a
|
||||
// number of proficiency steps, a list of proficiency modes ('prof', 'exp'), or one of
|
||||
// those under `value`, `proficient` or `prof` — and worlds run different releases of
|
||||
// it. Anything above nothing counts as proficient.
|
||||
function isProficient(value, depth = 0) {
|
||||
if (value === undefined || value === null || depth > 3) return false;
|
||||
if (typeof value === 'boolean') return value;
|
||||
if (typeof value === 'number') return value > 0;
|
||||
if (typeof value === 'string') {
|
||||
const text = value.trim();
|
||||
if (!text) return false;
|
||||
const number = Number(text);
|
||||
return Number.isFinite(number) ? number > 0 : text.toLowerCase() !== 'none';
|
||||
}
|
||||
if (Array.isArray(value)) return value.some((entry) => isProficient(entry, depth + 1));
|
||||
return ['value', 'proficient', 'prof'].some((key) => isProficient(value[key], depth + 1));
|
||||
}
|
||||
|
||||
// A toggled map (skill name or ability → proficient) from whatever the actor lists.
|
||||
// `null` says the actor says nothing about them at all, which is what keeps a live
|
||||
// Foundry edit from clearing the toggles the campaign set by hand.
|
||||
function toggleMap(sources) {
|
||||
const toggled = {};
|
||||
for (const [name, value] of Object.entries(sources)) {
|
||||
if (value !== undefined) toggled[name] = isProficient(value);
|
||||
}
|
||||
return Object.keys(toggled).length ? toggled : null;
|
||||
}
|
||||
|
||||
function foundrySkills(system) {
|
||||
const skills = system.skills && typeof system.skills === 'object' ? system.skills : {};
|
||||
return toggleMap(Object.fromEntries(Object.entries(FOUNDRY_SKILLS)
|
||||
.map(([key, name]) => [name, skills[key]])));
|
||||
}
|
||||
|
||||
function foundrySavingThrows(system) {
|
||||
const saves = system.saves && typeof system.saves === 'object' ? system.saves : {};
|
||||
return toggleMap(Object.fromEntries(ABILITIES.map((key) => [
|
||||
key,
|
||||
system.savingThrows?.[key] ?? system.abilities?.[key]?.save ?? saves[key]
|
||||
])));
|
||||
}
|
||||
|
||||
// Tools and languages: the module sends the labels its own CONFIG holds, because a
|
||||
// world's proficiency lists are keys — and, since the third system release, language
|
||||
// documents — that mean nothing outside Foundry. Without them the keys are the best
|
||||
// there is to name a proficiency with, and a bare Foundry document id is worse than
|
||||
// nothing at all. `null` says the actor says nothing about the kind, `[]` that it has
|
||||
// none of it. Dragonroll names its lists in full; the world keeps its tools under
|
||||
// `system.traits.tool` and its languages under `system.traits.languages`.
|
||||
const TRAIT_FIELDS = { tools: 'tool', languages: 'languages' };
|
||||
|
||||
function foundryTraitNames(actor, kind) {
|
||||
const labels = actor.dragonroll?.[kind];
|
||||
if (Array.isArray(labels)) {
|
||||
return [...new Set(labels.map((label) => asText(label).trim()).filter(Boolean))];
|
||||
}
|
||||
const trait = actor.system?.traits?.[TRAIT_FIELDS[kind] ?? kind];
|
||||
if (!trait || typeof trait !== 'object') return null;
|
||||
const names = [
|
||||
...stringList(trait.value),
|
||||
...asText(trait.custom).split(',').map((name) => name.trim())
|
||||
].filter((name) => name && !looksLikeFoundryId(name));
|
||||
return [...new Set(names)];
|
||||
}
|
||||
|
||||
function foundryCurrency(system) {
|
||||
const coins = system.currency;
|
||||
if (!coins || typeof coins !== 'object') return null;
|
||||
return Object.fromEntries(CURRENCIES.map((key) => [key, Math.max(0, numberOr(coins[key], 0))]));
|
||||
}
|
||||
|
||||
// The character's traits as the world writes them: the free-text details field some
|
||||
// system releases keep, or its trait items, which are how a monster's traits and a
|
||||
// character's racial and class features are written. `undefined` says the world holds
|
||||
// no traits to show.
|
||||
function foundryTraits(source, items) {
|
||||
const text = plainText(source.system?.details?.trait);
|
||||
if (text) return text;
|
||||
const features = items
|
||||
.filter((item) => item.type === 'feat' && stringList(item.system?.featType?.value ?? item.system?.featType)
|
||||
.some((type) => asText(type).toLowerCase().startsWith('tr')))
|
||||
.map((item) => {
|
||||
const name = asText(item.name).trim();
|
||||
const description = plainText(item.system?.description?.value ?? item.system?.description);
|
||||
return name ? `${name}\n${description}`.trim() : '';
|
||||
})
|
||||
.filter(Boolean);
|
||||
return features.length ? features.join('\n\n') : undefined;
|
||||
}
|
||||
|
||||
// `replace` is a forced actor sync from the module's context menu (Syndria98/dragonroll#96):
|
||||
// it replaces everything the campaign holds for this actor, so the fields a live edit
|
||||
// leaves out when the world says nothing are written empty instead of kept. A live Foundry
|
||||
// change passes `false` and keeps the campaign's own toggles and text.
|
||||
function foundryActorToCharacter(foundryActor, replace = false) {
|
||||
const system = foundryActor.system || {};
|
||||
const details = system.details || {};
|
||||
const abilities = system.abilities || {};
|
||||
@@ -43,7 +154,7 @@ function foundryActorToCharacter(foundryActor) {
|
||||
...stringList(traits.tool?.value)
|
||||
].join(', ');
|
||||
|
||||
return {
|
||||
const fields = {
|
||||
name: asText(foundryActor.name).trim(),
|
||||
type: ['character', 'npc', 'creature'].includes(savedDragonrollType)
|
||||
? savedDragonrollType
|
||||
@@ -56,24 +167,62 @@ function foundryActorToCharacter(foundryActor) {
|
||||
challengeRating: String(details.cr ?? ''),
|
||||
description: plainText(details.biography?.value || details.biography),
|
||||
image: asText(foundryActor.img || foundryActor.image),
|
||||
abilityScores: Object.fromEntries(['str', 'dex', 'con', 'int', 'wis', 'cha'].map((key) => [
|
||||
abilityScores: Object.fromEntries(ABILITIES.map((key) => [
|
||||
key,
|
||||
numberOr(abilities[key]?.value, 10)
|
||||
])),
|
||||
armorClass: numberOr(attributes.ac?.value ?? attributes.ac, 10),
|
||||
speed: numberOr(movement.walk ?? movement.value, 30),
|
||||
proficiencies: foundryProficiencies || asText(savedDragonrollFields.proficiencies),
|
||||
traits: asText(savedDragonrollFields.traits),
|
||||
// A replace takes the world's text even when it has none, so what Dragonroll
|
||||
// cached on the actor's flag does not survive it; a live edit keeps that text.
|
||||
proficiencies: foundryProficiencies || (replace ? '' : asText(savedDragonrollFields.proficiencies)),
|
||||
// What the character carries: gear, and gear only (Syndria98/dragonroll#89). A feat
|
||||
// is a trait — its tab shows it — and a race is the species; standing them in the
|
||||
// inventory next to the longswords is how traits and items got mixed up.
|
||||
inventory: items
|
||||
.filter((item) => !['class', 'subclass', 'background', 'spell'].includes(item.type))
|
||||
.filter((item) => isFoundryGearType(item.type))
|
||||
.map((item) => ({
|
||||
name: asText(item.name).trim(),
|
||||
quantity: numberOr(item.system?.quantity, 1),
|
||||
weight: numberOr(item.system?.weight?.value ?? item.system?.weight, 0)
|
||||
weight: numberOr(item.system?.weight?.value ?? item.system?.weight, 0),
|
||||
icon: asText(item.img).trim()
|
||||
}))
|
||||
.filter((item) => item.name),
|
||||
spells: items.filter((item) => item.type === 'spell').map((item) => asText(item.name)).filter(Boolean).join('\n')
|
||||
};
|
||||
|
||||
// What the world says about each of these, when it says anything: leaving a field
|
||||
// out of the character is what keeps a live Foundry edit from clearing what the
|
||||
// campaign toggled or wrote for it. Traits lead from the world when it has them, the
|
||||
// way the proficiencies do; the text the module carries back on its flag is what the
|
||||
// tab shows for an actor the world says nothing about.
|
||||
const skills = foundrySkills(system);
|
||||
if (skills) fields.skills = skills;
|
||||
const savingThrows = foundrySavingThrows(system);
|
||||
if (savingThrows) fields.savingThrows = savingThrows;
|
||||
const tools = foundryTraitNames(foundryActor, 'tools');
|
||||
if (tools) fields.tools = tools;
|
||||
const languages = foundryTraitNames(foundryActor, 'languages');
|
||||
if (languages) fields.languages = languages;
|
||||
const currency = foundryCurrency(system);
|
||||
if (currency) fields.currency = currency;
|
||||
const worldTraits = foundryTraits(foundryActor, items);
|
||||
const campaignTraits = replace ? '' : asText(savedDragonrollFields.traits);
|
||||
if (worldTraits || campaignTraits) fields.traits = worldTraits || campaignTraits;
|
||||
|
||||
// A replace writes the fields a live edit would leave out when the world says
|
||||
// nothing, so the campaign's toggles, lists and text for this actor go with it and
|
||||
// the row reads as the Foundry actor alone (Syndria98/dragonroll#96).
|
||||
if (replace) {
|
||||
if (fields.skills === undefined) fields.skills = {};
|
||||
if (fields.savingThrows === undefined) fields.savingThrows = {};
|
||||
if (fields.tools === undefined) fields.tools = [];
|
||||
if (fields.languages === undefined) fields.languages = [];
|
||||
if (fields.currency === undefined) fields.currency = {};
|
||||
if (fields.traits === undefined) fields.traits = '';
|
||||
}
|
||||
|
||||
return fields;
|
||||
}
|
||||
|
||||
module.exports = { foundryActorToCharacter };
|
||||
|
||||
@@ -23,6 +23,14 @@ const NON_GEAR_FOUNDRY_TYPES = new Set([
|
||||
'spell', 'class', 'subclass', 'background', 'feat', 'race', 'species', 'status', 'spellbook', 'language'
|
||||
]);
|
||||
|
||||
// Whether a Foundry document of this type is gear: something a character carries. Traits,
|
||||
// species, spells and the rest are documents of the world that mean something else on a
|
||||
// Dragonroll sheet — a feat is a trait and a race is a species — so they stand in the
|
||||
// character's own fields, never in its inventory (Syndria98/dragonroll#89).
|
||||
function isFoundryGearType(type) {
|
||||
return !NON_GEAR_FOUNDRY_TYPES.has(asText(type).toLowerCase().trim());
|
||||
}
|
||||
|
||||
// Item categories the Dragonroll Item model accepts.
|
||||
const CATEGORIES = ['weapon', 'armor', 'shield', 'adventuring-gear', 'magic-item', 'consumable', 'tool', 'treasure', 'other'];
|
||||
|
||||
@@ -107,4 +115,4 @@ function foundryItemToItemData(foundryItem) {
|
||||
};
|
||||
}
|
||||
|
||||
module.exports = { foundryItemToItemData };
|
||||
module.exports = { foundryItemToItemData, isFoundryGearType };
|
||||
|
||||
49
backend/src/services/map-foundry.js
Normal file
49
backend/src/services/map-foundry.js
Normal file
@@ -0,0 +1,49 @@
|
||||
const { numberOr, asText } = require('./foundry-fields');
|
||||
|
||||
// A Foundry scene is one of the campaign's maps (Syndria98/dragonroll#99): its background
|
||||
// picture and the grid laid over it travel to Dragonroll. Everything else a scene holds —
|
||||
// its padding, its lighting, the tokens standing on it — belongs to the world's table, and
|
||||
// so does what one of its cells stands for (`gridDistance` with its units): the campaign
|
||||
// sets its own scale and keeps it.
|
||||
|
||||
// The scene's background picture: `background.src` since Foundry V13, plain `img` before.
|
||||
function sceneImage(scene) {
|
||||
return asText(scene?.background?.src).trim() || asText(scene?.img).trim();
|
||||
}
|
||||
|
||||
// How many pixels of the picture one grid cell covers. Foundry keeps it under `grid.size`
|
||||
// since V13 and under plain `grid` before; 50 px is its own default cell size, and
|
||||
// Dragonroll's is the same, so a scene that says nothing gets the grid it draws.
|
||||
function sceneGridSize(scene) {
|
||||
const size = numberOr(scene?.grid?.size ?? scene?.grid, 0);
|
||||
return size >= 1 ? Math.round(size) : 50;
|
||||
}
|
||||
|
||||
// Where that grid starts on the picture. A world shifts it with the core flags of its own
|
||||
// (`flags.core.shiftX` / `.shiftY`, what it uses to line a hexagonal grid up); one that says
|
||||
// nothing has its grid at the corner of the picture. The scene's padding is blank canvas
|
||||
// *outside* the picture, so it is no part of the grid the campaign lays on the picture itself.
|
||||
function sceneGridOffset(scene, axis) {
|
||||
return Math.round(numberOr(scene?.flags?.core?.[`shift${axis}`], 0));
|
||||
}
|
||||
|
||||
// Returns null for a scene that is not a map: one with no name, or with no background
|
||||
// picture. A Dragonroll map without a picture is an empty viewer, so those scenes stay in
|
||||
// the world — their id is still listed by the snapshot that carries them, so nothing of the
|
||||
// campaign is pruned because of one.
|
||||
function foundrySceneToMapData(scene) {
|
||||
const name = asText(scene?.name).trim();
|
||||
const image = sceneImage(scene);
|
||||
if (!name || !image) return null;
|
||||
|
||||
return {
|
||||
name,
|
||||
// The module sends Foundry's picture as an absolute URL, like actors do.
|
||||
image,
|
||||
gridSize: sceneGridSize(scene),
|
||||
offsetX: sceneGridOffset(scene, 'X'),
|
||||
offsetY: sceneGridOffset(scene, 'Y')
|
||||
};
|
||||
}
|
||||
|
||||
module.exports = { foundrySceneToMapData };
|
||||
@@ -3,7 +3,7 @@
|
||||
Foundry modules run in the game client, so the module cannot bind an HTTP port on the Foundry host.
|
||||
This integration uses a small companion bridge process on that host:
|
||||
|
||||
1. A linked GM client syncs character Actors and world Items directly with the Dragonroll campaign.
|
||||
1. A linked GM client syncs character Actors, world Items and Scenes directly with the Dragonroll campaign.
|
||||
2. The module publishes the active world's actor and item snapshot to the optional bridge.
|
||||
3. The bridge serves authenticated HTTP read endpoints that Dragonroll proxies under `/api/foundry/*`.
|
||||
|
||||
@@ -73,9 +73,11 @@ queued while it was off are sent as the world catches up.
|
||||
With autosync off — or any time a single character needs to cross over right now — right-click an
|
||||
actor (or several selected ones) in the Foundry actor directory and pick **Dragonroll: Force Sync**.
|
||||
Those actors, together with the gear carried inside them, are pushed to the campaign immediately even
|
||||
when autosync is off. It is an upsert only: it never prunes the campaign's other actors, which a full
|
||||
snapshot does and a forced sync never claims to. Actors Dragonroll does not import (anything that is
|
||||
not a character, NPC or creature) are refused with a notification.
|
||||
when autosync is off, **replacing everything that campaign holds for them** (Syndria98/dragonroll#96):
|
||||
what the campaign had edited on those actors is written over by what the world says. It replaces
|
||||
those actors only — it never prunes the campaign's other actors, which a full snapshot does and a
|
||||
forced sync never claims to. Actors Dragonroll does not import (anything that is not a character, NPC
|
||||
or creature) are refused with a notification.
|
||||
|
||||
The optional read-only snapshot bridge is not affected: it keeps publishing the world snapshot behind
|
||||
`/api/foundry/*`, which is never written into the campaign.
|
||||
@@ -105,6 +107,42 @@ else (Syndria98/dragonroll#67):
|
||||
the whole world directory and can tell which synced rows it has let go of. Deleting a synced item in
|
||||
Dragonroll removes its Foundry world copy on the next reconcile.
|
||||
|
||||
### Maps
|
||||
|
||||
A scene of the world is one of the campaign's maps (Syndria98/dragonroll#99), and only two things
|
||||
about it cross over: the scene's **background picture** and the **grid** laid over it.
|
||||
|
||||
- The picture is sent as an absolute URL of this world, the way an actor's portrait is, so the
|
||||
campaign draws the same battle map the table is looking at. Its cell size is the scene's own
|
||||
(`grid`, and `grid.size` since Foundry V13), and the grid starts where the world shifts it
|
||||
(`flags.core.shiftX` / `.shiftY`). A scene with no background picture makes no map.
|
||||
- Everything else a scene holds stays in the world, and everything else a map holds stays in the
|
||||
campaign: what one of its cells stands for, the folder it stands in, the notes pinned onto it and
|
||||
the actors standing on it as tokens are the campaign's own. Nothing of a map is written back into
|
||||
the world — scene sync runs one way, so a map deleted in the campaign comes back with its scene on
|
||||
the next full list, and taking the scene off is what ends the map.
|
||||
- A scene is matched to a map by its Foundry id, kept on the map as `foundrySceneId` (unique within
|
||||
the campaign). A campaign that drew the same place by hand before its scene arrived is adopted
|
||||
instead of doubled: the scene takes over the unmapped map holding its name.
|
||||
- Live scene edits overwrite the map, including a picture and grid the campaign had set itself; a
|
||||
full snapshot (the world linking or loading) leaves a map it already has alone. The maps of scenes
|
||||
the world let go of are pruned by a full snapshot only, and a scene deleted in the world is
|
||||
reported on `foundry/sync/scene-delete`.
|
||||
- Autosync covers maps like everything else: turned off, no scene crosses over at all, and the ones
|
||||
queued while it was off go over when it is turned back on.
|
||||
|
||||
### Notes
|
||||
|
||||
The campaign's notes read like the campaign's journal in the world (Syndria98/dragonroll#98): every
|
||||
note stands as a page of one JournalEntry named **Dragonroll**. The module creates that journal — or
|
||||
adopts one the GM already made under that name, marking it as the notes' journal — and renders each
|
||||
note's markdown into page HTML with Foundry's own renderer. Notes are written in Dragonroll, so this
|
||||
copy runs one way: a note made or edited in the campaign rewrites its page on the next reconcile, and
|
||||
a note deleted there takes its page with it. A page standing under a note's title but carrying no
|
||||
Dragonroll mark is claimed as that note's page, so a lost pairing does not double it. Any other page in
|
||||
that journal — the GM's own — is left alone, and nothing written in the journal travels back. Autosync
|
||||
off stops it too, like the rest of the sync.
|
||||
|
||||
The module calls these Dragonroll routes with the campaign sync token (no Dragonroll login):
|
||||
|
||||
| Route | Use |
|
||||
@@ -112,14 +150,20 @@ The module calls these Dragonroll routes with the campaign sync token (no Dragon
|
||||
| `POST /api/foundry/sync/snapshot` | Actors and world items upsert; `fullSync` also prunes |
|
||||
| `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/scenes` | The world's scenes upsert as the campaign's maps; `fullSync` also prunes |
|
||||
| `POST /api/foundry/sync/scene-delete` | A scene was deleted |
|
||||
| `GET /api/foundry/sync/characters` | Characters 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/notes` | The campaign's notes, markdown and all, and the journal page each stands as |
|
||||
| `POST /api/foundry/sync/map-note` | Store a note's journal page id after creating that page |
|
||||
| `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/delete` | An actor was deleted |
|
||||
|
||||
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 a journal page the module made for a note keeps its note's id in the `dragonroll-foundry.noteId`
|
||||
flag, so the notes reconcile recognises its own pages. World items are marked with
|
||||
`dragonroll-foundry.syncMutation` while Dragonroll writes them so
|
||||
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,7 +2,7 @@
|
||||
"id": "dragonroll-foundry",
|
||||
"title": "Dragonroll Foundry API",
|
||||
"description": "Links a Foundry world to a Dragonroll campaign and exposes a client-side API for world data.",
|
||||
"version": "0.4.0",
|
||||
"version": "0.6.0",
|
||||
"library": true,
|
||||
"compatibility": {
|
||||
"minimum": "12",
|
||||
|
||||
@@ -33,9 +33,13 @@ let itemSyncRunning = false;
|
||||
let itemSyncErrorLogged = false;
|
||||
let folderSyncTimeout;
|
||||
let folderSyncRunning = false;
|
||||
let sceneSyncTimeout;
|
||||
let sceneSyncRetryTimeout;
|
||||
let sceneSyncErrorLogged = false;
|
||||
const syncingItemIds = new Set();
|
||||
const syncingFolderIds = new Set();
|
||||
const queuedItemChanges = new Map();
|
||||
const queuedSceneChanges = new Map();
|
||||
|
||||
function getCollectionContents(collection, collectionName) {
|
||||
if (!collection) {
|
||||
@@ -300,6 +304,7 @@ async function applyDragonrollLink(result) {
|
||||
scheduleSnapshotSync(0);
|
||||
setTimeout(initializeCharacterSync, 0);
|
||||
setTimeout(reconcileDragonrollItems, 2000);
|
||||
setTimeout(initializeSceneSync, 1000);
|
||||
} else {
|
||||
// Without a token this client cannot sync, and only a fresh link gives one.
|
||||
linkProblem = "this client could not save the token it was given";
|
||||
@@ -441,6 +446,8 @@ function handleAutoSyncChange(value) {
|
||||
clearTimeout(actorSyncTimeout);
|
||||
clearTimeout(itemSyncTimeout);
|
||||
clearTimeout(folderSyncTimeout);
|
||||
clearTimeout(sceneSyncTimeout);
|
||||
clearTimeout(sceneSyncRetryTimeout);
|
||||
return;
|
||||
}
|
||||
if (!game.user?.isGM || !getSyncToken()) return;
|
||||
@@ -450,6 +457,8 @@ function handleAutoSyncChange(value) {
|
||||
initializeCharacterSync();
|
||||
reconcileDragonrollItems();
|
||||
queueFoundryItemFolders(400);
|
||||
reconcileDragonrollNotes();
|
||||
initializeSceneSync();
|
||||
if (queuedActorChanges.size) {
|
||||
clearTimeout(actorSyncTimeout);
|
||||
actorSyncTimeout = setTimeout(flushActorChanges, 400);
|
||||
@@ -458,6 +467,10 @@ function handleAutoSyncChange(value) {
|
||||
clearTimeout(itemSyncTimeout);
|
||||
itemSyncTimeout = setTimeout(flushItemChanges, 400);
|
||||
}
|
||||
if (queuedSceneChanges.size) {
|
||||
clearTimeout(sceneSyncTimeout);
|
||||
sceneSyncTimeout = setTimeout(flushSceneChanges, 400);
|
||||
}
|
||||
}
|
||||
|
||||
function dragonrollActorId(actor) {
|
||||
@@ -474,17 +487,65 @@ function serializeFoundryActor(actor) {
|
||||
if (data.img && !/^(https?:|data:|\/\/)/i.test(data.img)) {
|
||||
data.img = new URL(data.img, window.location.origin).toString();
|
||||
}
|
||||
// Tools and languages travel by their names: what the actor holds are proficiency
|
||||
// keys (and, since the third release of the system, language documents), which mean
|
||||
// nothing to a sheet outside Foundry.
|
||||
const names = { tools: foundryTraitNames(actor, "tools"), languages: foundryTraitNames(actor, "languages") };
|
||||
if (names.tools || names.languages) data.dragonroll = { ...names };
|
||||
return data;
|
||||
}
|
||||
|
||||
// A proficiency list of `system.traits`: its keys resolved to the labels CONFIG gives
|
||||
// them, plus whatever the GM typed as a proficiency of their own. `null` for an actor
|
||||
// that has no such list, an empty array for one that has none of that kind. Dragonroll
|
||||
// names its lists in full, while the world keeps its tools under `system.traits.tool`
|
||||
// and its languages under `system.traits.languages`.
|
||||
const TRAIT_FIELDS = { tools: "tool", languages: "languages" };
|
||||
|
||||
function foundryTraitNames(actor, kind) {
|
||||
if (game.system?.id !== "dnd5e") return null;
|
||||
const trait = actor.system?.traits?.[TRAIT_FIELDS[kind] ?? kind];
|
||||
if (!trait || typeof trait !== "object") return null;
|
||||
|
||||
const names = (Array.isArray(trait.value) ? trait.value : [])
|
||||
.map((key) => foundryProficiencyLabel(kind, key))
|
||||
.filter(Boolean);
|
||||
for (const custom of String(trait.custom ?? "").split(",")) {
|
||||
const name = custom.trim();
|
||||
if (name) names.push(name);
|
||||
}
|
||||
return [...new Set(names)];
|
||||
}
|
||||
|
||||
function foundryProficiencyLabel(kind, key) {
|
||||
if (typeof key !== "string" || !key) return "";
|
||||
|
||||
const entry = CONFIG.DND5E?.[kind === "languages" ? "languages" : "tools"]?.[key];
|
||||
const label = entry?.label ?? entry?.name;
|
||||
if (label) return String(label);
|
||||
// A language the world added itself stands as a document of its own rather than in
|
||||
// the system's config.
|
||||
const document = kind === "languages" ? game.items?.get?.(key) : null;
|
||||
if (document?.name) return String(document.name);
|
||||
// The key beats dropping a proficiency the character really has.
|
||||
return key;
|
||||
}
|
||||
|
||||
function isSupportedCharacterActor(actor) {
|
||||
const savedType = actor.getFlag?.(MODULE_ID, "actorType") || actor.flags?.[MODULE_ID]?.actorType;
|
||||
return ["character", "npc", "creature"].includes(savedType || actor.type);
|
||||
}
|
||||
|
||||
// Embedded documents the world owns outright (Syndria98/dragonroll#89): a feat is a trait
|
||||
// and a race is a species — they reach the campaign through its traits and species fields,
|
||||
// never through its inventory. Dragonroll must neither mark them as its own nor delete one
|
||||
// when it writes the character, and an older campaign still holding such a row in its
|
||||
// inventory must be let to write it out of the campaign without the document going with it.
|
||||
const WORLD_OWNED_EMBEDDED_TYPES = new Set(["feat", "race", "species", "status", "spellbook", "language"]);
|
||||
|
||||
async function markActorItemsAsSynced(actor) {
|
||||
const updates = actor.items.contents
|
||||
.filter((item) => !item.getFlag?.(MODULE_ID, "syncedItem"))
|
||||
.filter((item) => !item.getFlag?.(MODULE_ID, "syncedItem") && !WORLD_OWNED_EMBEDDED_TYPES.has(item.type))
|
||||
.map((item) => ({
|
||||
_id: item.id,
|
||||
[`flags.${MODULE_ID}.syncedItem`]: true,
|
||||
@@ -518,7 +579,7 @@ function reportActorSyncError(error) {
|
||||
console.warn(`${MODULE_ID} | Character sync failed and will retry.`, error);
|
||||
}
|
||||
|
||||
async function pushFoundryActors(actors, fullSync = false) {
|
||||
async function pushFoundryActors(actors, fullSync = false, replace = false) {
|
||||
const token = getSyncToken();
|
||||
if (!token || !game.user?.isGM || !game.world || (!actors.length && !fullSync)) return;
|
||||
if (game.system.id !== "dnd5e") {
|
||||
@@ -537,6 +598,9 @@ async function pushFoundryActors(actors, fullSync = false) {
|
||||
// The folder tree those world items stand in (see worldItemFolderSnapshots).
|
||||
folders: worldItemFolderSnapshots(),
|
||||
fullSync,
|
||||
// A forced sync replaces the campaign's row for these actors outright; a live
|
||||
// change or a full snapshot never sets this, so the campaign keeps its edits.
|
||||
replace,
|
||||
}, token);
|
||||
|
||||
for (const mapping of result.actors || []) {
|
||||
@@ -559,8 +623,9 @@ async function deleteDragonrollActor(foundryActorId) {
|
||||
}
|
||||
|
||||
// Sending actors on purpose, whether or not autosync is on: this is the push the
|
||||
// GM asks for. It upserts those actors only, so unlike a full snapshot it never
|
||||
// prunes anything else the campaign holds.
|
||||
// GM asks for. It replaces everything the campaign holds for those actors (Syndria98/
|
||||
// dragonroll#96), but it upserts them only, so unlike a full snapshot it never prunes
|
||||
// anything else the campaign holds.
|
||||
async function forceSyncActorsToDragonroll(actors) {
|
||||
if (!game.user?.isGM || !game.world || !actors.length) return;
|
||||
if (!getSyncToken()) {
|
||||
@@ -576,7 +641,7 @@ async function forceSyncActorsToDragonroll(actors) {
|
||||
if (!supported.length) return;
|
||||
|
||||
try {
|
||||
await pushFoundryActors(supported);
|
||||
await pushFoundryActors(supported, false, true);
|
||||
ui.notifications?.info(supported.length === 1
|
||||
? `${supported[0].name} was sent to the Dragonroll campaign.`
|
||||
: `${supported.length} actors were sent to the Dragonroll campaign.`);
|
||||
@@ -1153,7 +1218,19 @@ async function reconcileEmbeddedItems(actor, entry) {
|
||||
const existing = actor.items.contents.find((item) => item.name === wanted.name
|
||||
&& item.type === wanted.type && item.getFlag?.(MODULE_ID, "syncedItem"))
|
||||
|| actor.items.contents.find((item) => item.name === wanted.name
|
||||
&& item.getFlag?.(MODULE_ID, "syncedItem"));
|
||||
&& item.getFlag?.(MODULE_ID, "syncedItem") && !WORLD_OWNED_EMBEDDED_TYPES.has(item.type));
|
||||
// A carried row holding the name of one of the world's own trait or species documents
|
||||
// — a trait a campaign that synced before #89 still has in its inventory — stands in
|
||||
// the world as that document: no loot is made after its name, and the document itself
|
||||
// is let be. Writing it out of the campaign is the campaign's to do, keeping it is the world's.
|
||||
if (!existing && wanted.type === "loot") {
|
||||
const worldOwned = actor.items.contents.find((item) => item.name === wanted.name
|
||||
&& WORLD_OWNED_EMBEDDED_TYPES.has(item.type));
|
||||
if (worldOwned) {
|
||||
retainedIds.add(worldOwned.id);
|
||||
continue;
|
||||
}
|
||||
}
|
||||
if (existing) {
|
||||
retainedIds.add(existing.id);
|
||||
const update = { _id: existing.id };
|
||||
@@ -1179,7 +1256,8 @@ async function reconcileEmbeddedItems(actor, entry) {
|
||||
}
|
||||
|
||||
const staleItemIds = actor.items.contents
|
||||
.filter((item) => item.getFlag?.(MODULE_ID, "syncedItem") && !retainedIds.has(item.id))
|
||||
.filter((item) => item.getFlag?.(MODULE_ID, "syncedItem") && !retainedIds.has(item.id)
|
||||
&& !WORLD_OWNED_EMBEDDED_TYPES.has(item.type))
|
||||
.map((item) => item.id);
|
||||
if (staleItemIds.length) await actor.deleteEmbeddedDocuments("Item", staleItemIds);
|
||||
}
|
||||
@@ -1295,6 +1373,276 @@ function queueFoundryActorChange(kind, actor) {
|
||||
queueActorChange(kind, actor);
|
||||
}
|
||||
|
||||
// --- Scene sync ---------------------------------------------------------------
|
||||
// A scene of this world is one of the campaign's maps (Syndria98/dragonroll#99): its
|
||||
// background picture and the grid laid over it travel to Dragonroll, which keeps a map per
|
||||
// scene. That is all of a scene that crosses over — pinning notes on a map, standing tokens
|
||||
// on it and saying how far one of its cells goes are the campaign's own business, so none
|
||||
// of it comes back to the world.
|
||||
|
||||
// A scene travels as plain document data with its picture read from this world: Dragonroll
|
||||
// draws it outside Foundry, so the path becomes an absolute URL the way a portrait does.
|
||||
// Since V13 the picture sits under `background.src`, and under plain `img` before that.
|
||||
function serializeFoundryScene(scene) {
|
||||
const data = toPlainData(scene);
|
||||
if (!data) return null;
|
||||
|
||||
const absolute = (path) => new URL(path, window.location.origin).toString();
|
||||
if (data.background?.src && !/^(https?:|data:|\/\/)/i.test(data.background.src)) {
|
||||
data.background = { ...data.background, src: absolute(data.background.src) };
|
||||
} else if (data.img && !/^(https?:|data:|\/\/)/i.test(data.img)) {
|
||||
data.img = absolute(data.img);
|
||||
}
|
||||
return data;
|
||||
}
|
||||
|
||||
// The scenes the campaign mirrors as its maps. Every scene goes, including one with no
|
||||
// picture: Dragonroll decides what of a scene is a map and, since such a scene's id is
|
||||
// still listed, no map of the campaign is pruned because of it.
|
||||
async function pushFoundryScenes(scenes, fullSync = false) {
|
||||
const token = getSyncToken();
|
||||
// A full push travels even with no scenes left: it is the one that tells the campaign
|
||||
// which of the maps it mirrors from this world the world has let go of.
|
||||
if (!token || !game.user?.isGM || !game.world || (!scenes.length && !fullSync)) return;
|
||||
|
||||
await postDragonroll("foundry/sync/scenes", {
|
||||
worldId: game.world.id,
|
||||
scenes: scenes.map(serializeFoundryScene).filter(Boolean),
|
||||
fullSync,
|
||||
}, token);
|
||||
sceneSyncErrorLogged = false;
|
||||
}
|
||||
|
||||
async function deleteDragonrollScene(foundrySceneId) {
|
||||
const token = getSyncToken();
|
||||
if (!token || !game.world || !foundrySceneId) return;
|
||||
await postDragonroll("foundry/sync/scene-delete", {
|
||||
worldId: game.world.id,
|
||||
foundrySceneId,
|
||||
}, token);
|
||||
}
|
||||
|
||||
function reportSceneSyncError(error) {
|
||||
if (sceneSyncErrorLogged) return;
|
||||
sceneSyncErrorLogged = true;
|
||||
console.warn(`${MODULE_ID} | Map sync failed and will retry.`, error);
|
||||
}
|
||||
|
||||
function queueFoundrySceneChange(kind, scene) {
|
||||
if (!scene || !game.user?.isGM || !getSyncToken()) return;
|
||||
|
||||
queuedSceneChanges.set(scene.id, { kind, scene });
|
||||
clearTimeout(sceneSyncTimeout);
|
||||
sceneSyncTimeout = setTimeout(flushSceneChanges, 400);
|
||||
}
|
||||
|
||||
async function flushSceneChanges() {
|
||||
// Autosync off: the scene edits wait here, like the actor and item changes do.
|
||||
if (!isAutoSyncEnabled()) return;
|
||||
const changes = [...queuedSceneChanges.values()];
|
||||
queuedSceneChanges.clear();
|
||||
const deleted = changes.filter((change) => change.kind === "delete");
|
||||
const changed = changes.filter((change) => change.kind !== "delete");
|
||||
|
||||
try {
|
||||
for (const change of deleted) await deleteDragonrollScene(change.scene.id);
|
||||
if (changed.length) await pushFoundryScenes(changed.map((change) => change.scene));
|
||||
} catch (error) {
|
||||
reportSceneSyncError(error);
|
||||
for (const change of changes) queuedSceneChanges.set(change.scene.id, change);
|
||||
clearTimeout(sceneSyncTimeout);
|
||||
sceneSyncTimeout = setTimeout(flushSceneChanges, 5000);
|
||||
}
|
||||
}
|
||||
|
||||
// The whole scene list travels when the world links and when it loads: the campaign's map
|
||||
// list mirrors this world's scenes, and only a push holding every scene can say which of
|
||||
// those maps the world has let go of.
|
||||
async function initializeSceneSync() {
|
||||
if (!getSyncToken() || !game.user?.isGM || !game.world || !isAutoSyncEnabled()) return;
|
||||
try {
|
||||
await pushFoundryScenes(game.scenes?.contents || [], true);
|
||||
} catch (error) {
|
||||
reportSceneSyncError(error);
|
||||
clearTimeout(sceneSyncRetryTimeout);
|
||||
sceneSyncRetryTimeout = setTimeout(initializeSceneSync, 15000);
|
||||
}
|
||||
}
|
||||
|
||||
// --- Note pages ------------------------------------------------------------
|
||||
// The campaign's notes read like the campaign's journal in the world: every note
|
||||
// stands as a page of one JournalEntry named "Dragonroll". Notes are written in
|
||||
// Dragonroll, so this copy runs one way — the reconcile writes each note into its
|
||||
// page and drops the page of a note the campaign deleted. Nothing of the journal
|
||||
// is read back. A page the module made carries the `dragonroll-foundry.noteId`
|
||||
// flag; one without it that stands under a note's title is claimed as that note's
|
||||
// page rather than doubled, and any other page is the GM's own and left alone.
|
||||
|
||||
const NOTES_JOURNAL_NAME = "Dragonroll";
|
||||
let noteSyncRunning = false;
|
||||
let noteSyncErrorLogged = false;
|
||||
|
||||
function dragonrollNoteId(page) {
|
||||
return page.getFlag?.(MODULE_ID, "noteId") || page.flags?.[MODULE_ID]?.noteId || "";
|
||||
}
|
||||
|
||||
// A note is markdown, a journal page is HTML. Foundry's own renderer keeps the
|
||||
// page readable in the journal and in its styles; where this Foundry does not
|
||||
// offer one, escaped paragraphs keep the text legible until it does.
|
||||
function notePageHtml(content) {
|
||||
const markdown = String(content ?? "");
|
||||
if (!markdown.trim()) return "";
|
||||
if (typeof TextEditor !== "undefined" && typeof TextEditor._getMarkdown === "function") {
|
||||
const html = TextEditor._getMarkdown(markdown);
|
||||
if (html) return html;
|
||||
}
|
||||
return markdown
|
||||
.split(/\n\s*\n/)
|
||||
.map((block) => `<p>${escapeNoteHtml(block.trim()).replace(/\n/g, "<br />")}</p>`)
|
||||
.join("\n");
|
||||
}
|
||||
|
||||
function escapeNoteHtml(value) {
|
||||
return String(value).replace(/&/g, "&").replace(/</g, "<").replace(/>/g, ">");
|
||||
}
|
||||
|
||||
function notePageTitle(entry) {
|
||||
return String(entry.title || "").trim() || "Untitled note";
|
||||
}
|
||||
|
||||
// The journal this module writes the campaign's notes into: the one it flagged as
|
||||
// its own, or one the GM already made under that name. An unflagged one is
|
||||
// flagged on use, so renaming it afterwards still leaves the notes' home findable.
|
||||
function notesJournal() {
|
||||
const journals = game.journals?.contents || [];
|
||||
return journals.find((journal) => journal.getFlag?.(MODULE_ID, "notesJournal"))
|
||||
|| journals.find((journal) => journal.name === NOTES_JOURNAL_NAME)
|
||||
|| null;
|
||||
}
|
||||
|
||||
async function ensureNotesJournal() {
|
||||
const existing = notesJournal();
|
||||
if (existing) {
|
||||
if (!existing.getFlag?.(MODULE_ID, "notesJournal")) {
|
||||
await existing.update({ [`flags.${MODULE_ID}.notesJournal`]: true });
|
||||
}
|
||||
return existing;
|
||||
}
|
||||
const created = await JournalEntry.create(
|
||||
{ name: NOTES_JOURNAL_NAME, flags: { [MODULE_ID]: { notesJournal: true } } },
|
||||
{ renderSheet: false },
|
||||
);
|
||||
return Array.isArray(created) ? created[0] : created;
|
||||
}
|
||||
|
||||
// The page a note stands as: rewrite what the campaign changed, and claim a page
|
||||
// the campaign mapped by id but whose flag was lost.
|
||||
async function applyDragonrollNotePage(page, entry) {
|
||||
const title = notePageTitle(entry);
|
||||
const html = notePageHtml(entry.content);
|
||||
const updates = {};
|
||||
if (String(page.name ?? "") !== title) updates.name = title;
|
||||
if (String(page.text?.content ?? "") !== html) updates["text.content"] = html;
|
||||
if (!dragonrollNoteId(page)) updates[`flags.${MODULE_ID}.noteId`] = String(entry._id);
|
||||
if (Object.keys(updates).length) await page.update(updates);
|
||||
}
|
||||
|
||||
async function createDragonrollNotePage(journal, entry) {
|
||||
const pages = await journal.createEmbeddedDocuments("JournalEntryPage", [{
|
||||
// A page's display title is its `name`; `title` only holds the table-of-contents
|
||||
// flags (`show`/`level`). Missing `name` fails the document's validation.
|
||||
name: notePageTitle(entry),
|
||||
text: { content: notePageHtml(entry.content) },
|
||||
flags: { [MODULE_ID]: { noteId: String(entry._id) } },
|
||||
}], { renderSheet: false });
|
||||
return Array.isArray(pages) ? pages[0] : pages;
|
||||
}
|
||||
|
||||
async function mapDragonrollNote(noteId, foundryPageId) {
|
||||
const token = getSyncToken();
|
||||
return postDragonroll("foundry/sync/map-note", {
|
||||
worldId: game.world.id,
|
||||
noteId: String(noteId),
|
||||
foundryPageId: String(foundryPageId),
|
||||
}, token);
|
||||
}
|
||||
|
||||
function reportNoteSyncError(error) {
|
||||
if (noteSyncErrorLogged) return;
|
||||
noteSyncErrorLogged = true;
|
||||
console.warn(`${MODULE_ID} | Note journal sync failed and will retry.`, error);
|
||||
}
|
||||
|
||||
async function reconcileDragonrollNotes() {
|
||||
const token = getSyncToken();
|
||||
if (!token || !game.user?.isGM || !game.world || noteSyncRunning || !isAutoSyncEnabled()) return;
|
||||
noteSyncRunning = true;
|
||||
try {
|
||||
const result = await getDragonroll("foundry/sync/notes", token);
|
||||
const remoteNotes = result.notes || [];
|
||||
// A campaign without notes gets no journal of its own — but one it once had
|
||||
// stays, so the pages of notes it deleted can go with them.
|
||||
if (!remoteNotes.length && !notesJournal()) return;
|
||||
const journal = await ensureNotesJournal();
|
||||
if (!journal) return;
|
||||
|
||||
const remoteById = new Map(remoteNotes.map((entry) => [String(entry._id), entry]));
|
||||
const localByRemoteId = new Map((journal.pages?.contents || [])
|
||||
.map((page) => [String(dragonrollNoteId(page)), page])
|
||||
.filter(([noteId]) => noteId));
|
||||
const retainedPageIds = new Set();
|
||||
|
||||
for (const entry of remoteNotes) {
|
||||
let page = entry.foundryPageId ? journal.pages?.get(entry.foundryPageId) : null;
|
||||
if (!page) page = localByRemoteId.get(String(entry._id));
|
||||
if (page) {
|
||||
retainedPageIds.add(page.id);
|
||||
await applyDragonrollNotePage(page, entry);
|
||||
if (!entry.foundryPageId) await mapDragonrollNote(entry._id, page.id);
|
||||
} else {
|
||||
// A page under the note's title that carries no Dragonroll mark — one the
|
||||
// module made before the campaign kept its mapping, or one whose flag was
|
||||
// lost — is claimed as that note's page instead of adding a second page of
|
||||
// the same name. Like the item sync's same-name adoption, this is what keeps
|
||||
// a note from being written as a new page on every reconcile.
|
||||
const sameName = (journal.pages?.contents || []).find((candidate) => (
|
||||
String(candidate.name ?? "") === notePageTitle(entry)
|
||||
&& !dragonrollNoteId(candidate)
|
||||
&& !retainedPageIds.has(candidate.id)
|
||||
));
|
||||
if (sameName) {
|
||||
retainedPageIds.add(sameName.id);
|
||||
await applyDragonrollNotePage(sameName, entry);
|
||||
await mapDragonrollNote(entry._id, sameName.id);
|
||||
} else {
|
||||
const created = await createDragonrollNotePage(journal, entry);
|
||||
if (created) {
|
||||
retainedPageIds.add(created.id);
|
||||
// The create carries the note's flag, but a world that drops it would leave
|
||||
// the page unclaimed and the next reconcile would make another: mark it
|
||||
// again the way the rest of the sync marks its documents.
|
||||
await applyDragonrollNotePage(created, entry);
|
||||
await mapDragonrollNote(entry._id, created.id);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Pages whose note the campaign deleted go with it. Only pages this module
|
||||
// made are its business: an unflagged page is the GM's own.
|
||||
for (const page of journal.pages?.contents || []) {
|
||||
const noteId = dragonrollNoteId(page);
|
||||
if (!noteId || retainedPageIds.has(page.id) || remoteById.has(String(noteId))) continue;
|
||||
await page.delete();
|
||||
}
|
||||
noteSyncErrorLogged = false;
|
||||
} catch (error) {
|
||||
reportNoteSyncError(error);
|
||||
} finally {
|
||||
noteSyncRunning = false;
|
||||
}
|
||||
}
|
||||
|
||||
async function publishSnapshot() {
|
||||
if (!game.user?.isGM || !game.world) return;
|
||||
if (syncInProgress) {
|
||||
@@ -1387,6 +1735,14 @@ Hooks.once("ready", () => {
|
||||
// already seen the world directory when it starts sending its own items back.
|
||||
setTimeout(reconcileDragonrollItems, 2000);
|
||||
setInterval(reconcileDragonrollItems, 5000);
|
||||
// The campaign's notes arrive as pages of the world's Dragonroll journal on
|
||||
// the same rhythm: a note written in the app is on the journal within seconds.
|
||||
setTimeout(reconcileDragonrollNotes, 3000);
|
||||
setInterval(reconcileDragonrollNotes, 5000);
|
||||
// The campaign's maps mirror this world's scenes: the whole list goes once the world is
|
||||
// loaded, and that push alone tells the campaign which of its synced maps this world has
|
||||
// let go of.
|
||||
setTimeout(initializeSceneSync, 3000);
|
||||
|
||||
for (const event of [
|
||||
"createActor", "updateActor", "deleteActor",
|
||||
@@ -1420,10 +1776,18 @@ Hooks.once("ready", () => {
|
||||
queueFoundryItemChange(isDelete ? "delete" : "upsert", document);
|
||||
});
|
||||
}
|
||||
|
||||
// A scene the GM makes, renames or throws away is one of the campaign's maps being drawn
|
||||
// or let go of (Syndria98/dragonroll#99). Only its picture and grid cross over, so this
|
||||
// goes one way and needs no snapshot of the world behind it.
|
||||
for (const event of ["createScene", "updateScene", "deleteScene"]) {
|
||||
Hooks.on(event, (document) => queueFoundrySceneChange(event.startsWith("delete") ? "delete" : "upsert", document));
|
||||
}
|
||||
});
|
||||
|
||||
// A GM sends selected actors to Dragonroll from the actor directory's context
|
||||
// menu. This works with autosync on and off: it is the one push done on purpose.
|
||||
// menu, replacing whatever the campaign holds for them. This works with autosync on
|
||||
// and off: it is the one push done on purpose.
|
||||
Hooks.on("getActorDirectoryEntryContext", (html, options) => {
|
||||
if (!game.user?.isGM || !getSyncToken()) return;
|
||||
|
||||
|
||||
@@ -417,4 +417,89 @@ span.artifact {
|
||||
|
||||
.fold.is-collapsed > .fold-body {
|
||||
display: none;
|
||||
}
|
||||
|
||||
/* El markdown renderitzat de la documentació: tot dins de .docs-markdown, que ve de v-html.
|
||||
Va aquí perquè la pàgina de /docs (views/DocsView.vue) i la finestra de documentació
|
||||
(windows/DocumentationWindow.vue) se'l serveixen plegades. */
|
||||
.docs-markdown h1 {
|
||||
margin: 0 0 14px 0;
|
||||
font-family: 'MrEavesRemake', serif;
|
||||
font-size: 2rem;
|
||||
font-weight: normal;
|
||||
line-height: 1.2;
|
||||
}
|
||||
|
||||
.docs-markdown h2 {
|
||||
margin: 30px 0 10px 0;
|
||||
padding-bottom: 4px;
|
||||
border-bottom: 1px solid var(--color-border);
|
||||
font-family: 'MrEavesRemake', serif;
|
||||
font-size: 1.35rem;
|
||||
font-weight: normal;
|
||||
scroll-margin-top: 20px;
|
||||
}
|
||||
|
||||
.docs-markdown h3 {
|
||||
margin: 22px 0 8px 0;
|
||||
font-family: 'MrEavesRemake', serif;
|
||||
font-size: 1.1rem;
|
||||
font-weight: normal;
|
||||
scroll-margin-top: 20px;
|
||||
}
|
||||
|
||||
.docs-markdown p,
|
||||
.docs-markdown li {
|
||||
line-height: 1.65;
|
||||
}
|
||||
|
||||
.docs-markdown ul,
|
||||
.docs-markdown ol {
|
||||
margin: 10px 0;
|
||||
padding-left: 1.5em;
|
||||
}
|
||||
|
||||
.docs-markdown a {
|
||||
color: var(--color-link);
|
||||
}
|
||||
|
||||
.docs-markdown code {
|
||||
padding: 1px 5px;
|
||||
border-radius: 4px;
|
||||
background-color: var(--color-background-light);
|
||||
font-family: ui-monospace, SFMono-Regular, Menlo, Consolas, monospace;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
|
||||
.docs-markdown pre {
|
||||
margin: 14px 0;
|
||||
padding: 12px 14px;
|
||||
border: 1px solid var(--color-border);
|
||||
border-radius: 8px;
|
||||
background-color: var(--color-background-light);
|
||||
overflow-x: auto;
|
||||
}
|
||||
|
||||
.docs-markdown pre code {
|
||||
padding: 0;
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
.docs-markdown table {
|
||||
margin: 14px 0;
|
||||
border-collapse: collapse;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
.docs-markdown th,
|
||||
.docs-markdown td {
|
||||
padding: 7px 10px;
|
||||
border: 1px solid var(--color-border);
|
||||
text-align: left;
|
||||
vertical-align: top;
|
||||
line-height: 1.5;
|
||||
}
|
||||
|
||||
.docs-markdown th {
|
||||
background-color: var(--color-background-light);
|
||||
}
|
||||
@@ -13,6 +13,13 @@ function OpenCampaignSettings() {
|
||||
CreateWindow('campaign_settings', { campaign: Campaign.value });
|
||||
}
|
||||
|
||||
function OpenDocumentation() {
|
||||
// La documentació és una finestra que va davant de l'espai de treball, així que les notes
|
||||
// obertes no es perden. CreateWindow deixa sola una finestra que ja és oberta: tornar a
|
||||
// prémer el botó no la torna a la primera pàgina.
|
||||
CreateWindow('documentation');
|
||||
}
|
||||
|
||||
function ExitCampaign() {
|
||||
// Torn al menú principal: neteja la campanya (i el localStorage), amaga
|
||||
// l'espai de treball i reobre el menú
|
||||
@@ -35,6 +42,11 @@ function ExitCampaign() {
|
||||
<TopSearchBar></TopSearchBar>
|
||||
</div>
|
||||
<div class="right">
|
||||
<!-- La documentació s'obre en una finestra seva, davant de la campanya: les notes
|
||||
obertes no es perden i no cal obrir una pestanya nova. -->
|
||||
<button class="btn-primary settings-button docs-button sound-click" type="button" @click="OpenDocumentation">
|
||||
{{ $t('main-menu.documentation') }}
|
||||
</button>
|
||||
<button class="btn-primary settings-button sound-click" type="button" @click="OpenCampaignSettings">
|
||||
{{ $t('main-menu.settings') }}
|
||||
</button>
|
||||
|
||||
@@ -436,6 +436,14 @@ async function onTokenPointerUp(event) {
|
||||
await placeToken(token.actor, { x, y });
|
||||
}
|
||||
|
||||
// Double clicking a token (or Enter on a focused one) opens the sheet of the actor it stands for.
|
||||
// A single click cannot be the trigger: the click that ends a drag lands on the token too, so
|
||||
// dragging a token over the map would open its sheet every time.
|
||||
function openTokenSheet(token) {
|
||||
const actor = tokenActor(token);
|
||||
if (actor) openActorSheet(actor);
|
||||
}
|
||||
|
||||
const CELL_STEPS = {
|
||||
ArrowLeft: [-1, 0],
|
||||
ArrowRight: [1, 0],
|
||||
@@ -443,7 +451,8 @@ const CELL_STEPS = {
|
||||
ArrowDown: [0, 1]
|
||||
};
|
||||
|
||||
// A focused token answers to the keyboard too: arrows walk it over the grid, Delete takes it off.
|
||||
// A focused token answers to the keyboard too: arrows walk it over the grid, Delete takes it off
|
||||
// and Enter opens its sheet, the way a double click does.
|
||||
async function onTokenKeydown(event, token) {
|
||||
const step = CELL_STEPS[event.key];
|
||||
if (step) {
|
||||
@@ -456,6 +465,7 @@ async function onTokenKeydown(event, token) {
|
||||
event.preventDefault();
|
||||
await removeToken(token);
|
||||
}
|
||||
if (event.key === 'Enter') openTokenSheet(token);
|
||||
}
|
||||
|
||||
function onTokenContextMenu(token) {
|
||||
@@ -609,6 +619,7 @@ onBeforeUnmount(() => {
|
||||
@pointermove="onTokenPointerMove"
|
||||
@pointerup="onTokenPointerUp"
|
||||
@pointercancel="onTokenPointerUp"
|
||||
@dblclick="openTokenSheet(token)"
|
||||
@contextmenu.stop.prevent="onTokenContextMenu(token)"
|
||||
@keydown="onTokenKeydown($event, token)"
|
||||
>
|
||||
|
||||
@@ -108,11 +108,13 @@ useHead({
|
||||
color: var(--color-text);
|
||||
}
|
||||
|
||||
/* Els dos aside fan la pàgina sencera avall: amb alçada d'una pantalla i enganxats a
|
||||
dalt, el fons i la vora arriben sempre fins a baix, per molt llarg que sigui el text. */
|
||||
.docs-sidebar,
|
||||
.docs-sections {
|
||||
position: sticky;
|
||||
top: 0;
|
||||
max-height: 100vh;
|
||||
height: 100vh;
|
||||
overflow-y: auto;
|
||||
box-sizing: border-box;
|
||||
padding: 18px 14px;
|
||||
@@ -122,7 +124,6 @@ useHead({
|
||||
flex: 0 0 268px;
|
||||
width: 268px;
|
||||
border-right: 1px solid var(--color-border);
|
||||
background-color: var(--color-background-light);
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 14px;
|
||||
@@ -208,8 +209,13 @@ useHead({
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
.docs-article {
|
||||
/* La columna de lectura, centrada dins l'espai que deixa la barra lateral: en una finestra
|
||||
ampla el text queda al mig, no enganxat a l'esquerra. */
|
||||
.docs-article,
|
||||
.docs-pager {
|
||||
width: 100%;
|
||||
max-width: 760px;
|
||||
margin-inline: auto;
|
||||
}
|
||||
|
||||
.docs-kicker {
|
||||
@@ -221,7 +227,6 @@ useHead({
|
||||
}
|
||||
|
||||
.docs-pager {
|
||||
max-width: 760px;
|
||||
margin-top: 34px;
|
||||
padding-top: 18px;
|
||||
border-top: 1px solid var(--color-border);
|
||||
@@ -256,8 +261,10 @@ useHead({
|
||||
}
|
||||
|
||||
.docs-sections {
|
||||
flex: 0 0 220px;
|
||||
width: 220px;
|
||||
flex: 0 0 240px;
|
||||
width: 240px;
|
||||
/* Més aire al voltant dels apartats, que ara mateix van clavats a la vora. */
|
||||
padding: 26px 22px 26px 18px;
|
||||
border-left: 1px solid var(--color-border);
|
||||
}
|
||||
|
||||
@@ -294,87 +301,19 @@ useHead({
|
||||
color: var(--color-link);
|
||||
}
|
||||
|
||||
/* El markdown renderitzat: tot dins de .docs-markdown, perquè ve de v-html. */
|
||||
.docs-markdown :deep(h1) {
|
||||
margin: 0 0 14px 0;
|
||||
font-family: 'MrEavesRemake', serif;
|
||||
font-size: 2rem;
|
||||
font-weight: normal;
|
||||
line-height: 1.2;
|
||||
}
|
||||
/* El markdown renderitzat ve estilat a assets/css/main.scss, sota .docs-markdown, perquè la
|
||||
finestra de documentació (windows/DocumentationWindow.vue) se'l serveix igualment. */
|
||||
|
||||
.docs-markdown :deep(h2) {
|
||||
margin: 30px 0 10px 0;
|
||||
padding-bottom: 4px;
|
||||
border-bottom: 1px solid var(--color-border);
|
||||
font-family: 'MrEavesRemake', serif;
|
||||
font-size: 1.35rem;
|
||||
font-weight: normal;
|
||||
scroll-margin-top: 20px;
|
||||
}
|
||||
/* Finestra molt ampla: tot el conjunt va al mig, així els apartats queden a prop del
|
||||
text en lloc d'estirats cap al cantó dret de la pantalla. */
|
||||
@media (min-width: 1440px) {
|
||||
.docs {
|
||||
justify-content: center;
|
||||
}
|
||||
|
||||
.docs-markdown :deep(h3) {
|
||||
margin: 22px 0 8px 0;
|
||||
font-family: 'MrEavesRemake', serif;
|
||||
font-size: 1.1rem;
|
||||
font-weight: normal;
|
||||
scroll-margin-top: 20px;
|
||||
}
|
||||
|
||||
.docs-markdown :deep(p),
|
||||
.docs-markdown :deep(li) {
|
||||
line-height: 1.65;
|
||||
}
|
||||
|
||||
.docs-markdown :deep(ul),
|
||||
.docs-markdown :deep(ol) {
|
||||
margin: 10px 0;
|
||||
padding-left: 1.5em;
|
||||
}
|
||||
|
||||
.docs-markdown :deep(a) {
|
||||
color: var(--color-link);
|
||||
}
|
||||
|
||||
.docs-markdown :deep(code) {
|
||||
padding: 1px 5px;
|
||||
border-radius: 4px;
|
||||
background-color: var(--color-background-light);
|
||||
font-family: ui-monospace, SFMono-Regular, Menlo, Consolas, monospace;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
|
||||
.docs-markdown :deep(pre) {
|
||||
margin: 14px 0;
|
||||
padding: 12px 14px;
|
||||
border: 1px solid var(--color-border);
|
||||
border-radius: 8px;
|
||||
background-color: var(--color-background-light);
|
||||
overflow-x: auto;
|
||||
}
|
||||
|
||||
.docs-markdown :deep(pre code) {
|
||||
padding: 0;
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
.docs-markdown :deep(table) {
|
||||
margin: 14px 0;
|
||||
border-collapse: collapse;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
.docs-markdown :deep(th),
|
||||
.docs-markdown :deep(td) {
|
||||
padding: 7px 10px;
|
||||
border: 1px solid var(--color-border);
|
||||
text-align: left;
|
||||
vertical-align: top;
|
||||
line-height: 1.5;
|
||||
}
|
||||
|
||||
.docs-markdown :deep(th) {
|
||||
background-color: var(--color-background-light);
|
||||
.docs-main {
|
||||
flex: 0 1 860px;
|
||||
}
|
||||
}
|
||||
|
||||
@media (max-width: 1200px) {
|
||||
@@ -391,7 +330,7 @@ useHead({
|
||||
.docs-sidebar,
|
||||
.docs-sections {
|
||||
position: static;
|
||||
max-height: none;
|
||||
height: auto;
|
||||
width: 100%;
|
||||
border-left: none;
|
||||
border-right: none;
|
||||
|
||||
@@ -24,6 +24,23 @@ const abilityStats = [
|
||||
{ key: 'int', label: 'INT' }, { key: 'wis', label: 'WIS' }, { key: 'cha', label: 'CHA' }
|
||||
];
|
||||
|
||||
// Les habilitats del 5e. Cada una té un cercle que s'encén quan el personatge hi és
|
||||
// proficient, i la modificadora que tira és la de la característica que mana.
|
||||
const skillList = [
|
||||
{ key: 'acrobatics', ability: 'dex' }, { key: 'animalHandling', ability: 'wis' },
|
||||
{ key: 'arcana', ability: 'int' }, { key: 'athletics', ability: 'str' },
|
||||
{ key: 'deception', ability: 'cha' }, { key: 'history', ability: 'int' },
|
||||
{ key: 'insight', ability: 'wis' }, { key: 'intimidation', ability: 'cha' },
|
||||
{ key: 'investigation', ability: 'int' }, { key: 'medicine', ability: 'wis' },
|
||||
{ key: 'nature', ability: 'int' }, { key: 'perception', ability: 'wis' },
|
||||
{ key: 'performance', ability: 'cha' }, { key: 'persuasion', ability: 'cha' },
|
||||
{ key: 'religion', ability: 'int' }, { key: 'sleightOfHand', ability: 'dex' },
|
||||
{ key: 'stealth', ability: 'dex' }, { key: 'survival', ability: 'wis' }
|
||||
];
|
||||
|
||||
// Les cinc monedes que un personatge porta al damunt.
|
||||
const currencyUnits = ['pp', 'gp', 'ep', 'sp', 'cp'];
|
||||
|
||||
// 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 = [
|
||||
@@ -39,6 +56,17 @@ const activeTab = ref('abilities');
|
||||
// per sota de 760px el marc les fa estar a dins i el marge deixa de fer falta.
|
||||
const TAB_RAIL_WIDTH = 150;
|
||||
|
||||
// Les eines i els idiomes viatgen com a llista i el formulari els edita com un quadre
|
||||
// de text: un nom per línia. Les comes també separen, que és com s'escriuen en una frase.
|
||||
function proficiencyText(value) {
|
||||
const names = Array.isArray(value) ? value : String(value ?? '').split(/[\n,]/);
|
||||
return [...new Set(names.map((name) => String(name).trim()).filter(Boolean))].join('\n');
|
||||
}
|
||||
|
||||
function proficiencyList(text) {
|
||||
return [...new Set(String(text ?? '').split(/[\n,]/).map((name) => String(name).trim()).filter(Boolean))];
|
||||
}
|
||||
|
||||
function normalizeActor(actor) {
|
||||
return {
|
||||
name: actor?.name ?? '',
|
||||
@@ -60,8 +88,17 @@ function normalizeActor(actor) {
|
||||
max: Number(actor?.hitDice?.max ?? actor?.level ?? 1)
|
||||
},
|
||||
proficiencies: actor?.proficiencies ?? '',
|
||||
// El que el personatge sap fer i el que porta: les habilitats i les tirades de
|
||||
// salvació són cercles que s'encenen, les eines i els idiomes són noms que el
|
||||
// formulari edita com un text d'una línia per nom, i la moneda són cinc xifres.
|
||||
skills: Object.fromEntries(skillList.map(({ key }) => [key, Boolean(actor?.skills?.[key])])),
|
||||
savingThrows: Object.fromEntries(abilityStats.map(({ key }) => [key, Boolean(actor?.savingThrows?.[key])])),
|
||||
tools: proficiencyText(actor?.tools),
|
||||
languages: proficiencyText(actor?.languages),
|
||||
currency: Object.fromEntries(currencyUnits.map((unit) => [unit, Number(actor?.currency?.[unit] ?? 0) || 0])),
|
||||
inventory: (actor?.inventory ?? []).map((item) => ({
|
||||
name: item.name ?? '', quantity: Number(item.quantity ?? 1), weight: Number(item.weight ?? 0)
|
||||
name: item.name ?? '', quantity: Number(item.quantity ?? 1), weight: Number(item.weight ?? 0),
|
||||
icon: item.icon ?? ''
|
||||
})),
|
||||
traits: actor?.traits ?? '',
|
||||
spells: actor?.spells ?? '',
|
||||
@@ -110,17 +147,37 @@ const carryingCapacity = computed(() => form.value.abilityScores.str * 15);
|
||||
const carriedWeight = computed(() => form.value.inventory.reduce((total, item) => total + (Number(item.quantity) || 0) * (Number(item.weight) || 0), 0));
|
||||
const carryPercent = computed(() => Math.min(100, carryingCapacity.value ? (carriedWeight.value / carryingCapacity.value) * 100 : 0));
|
||||
|
||||
function abilityModifier(score) {
|
||||
const modifier = Math.floor((Number(score) - 10) / 2);
|
||||
// `bonus` és el bonificador de proficiència, per a les habilitats i les tirades de
|
||||
// salvació del personatge que hi està entrenat.
|
||||
function abilityModifier(score, bonus = 0) {
|
||||
const modifier = Math.floor((Number(score) - 10) / 2) + (Number(bonus) || 0);
|
||||
return modifier >= 0 ? `+${modifier}` : String(modifier);
|
||||
}
|
||||
|
||||
const imageUrl = computed(() => {
|
||||
if (!form.value.image) return '';
|
||||
return /^(https?:|data:|\/\/)/i.test(form.value.image)
|
||||
? form.value.image
|
||||
: `${getBaseUrl()}/public/${form.value.image}`;
|
||||
});
|
||||
function skillModifier(skill) {
|
||||
return abilityModifier(form.value.abilityScores[skill.ability], form.value.skills[skill.key] ? proficiencyBonus.value : 0);
|
||||
}
|
||||
|
||||
function savingThrowModifier(stat) {
|
||||
return abilityModifier(form.value.abilityScores[stat.key], form.value.savingThrows[stat.key] ? proficiencyBonus.value : 0);
|
||||
}
|
||||
|
||||
// El cercle d'una habilitat o d'una salvació: s'encén i s'apaga, i es desa amb tota la
|
||||
// fitxa, com la resta del que s'edita.
|
||||
function toggleProficiency(group, key) {
|
||||
form.value[group][key] = !form.value[group][key];
|
||||
}
|
||||
|
||||
// Una imatge pot ser una adreça sencera (la que Foundry dona a un objecte, per
|
||||
// exemple) o un fitxer pujat aquí, que es serveix per `/api/public`.
|
||||
function resolveImage(image) {
|
||||
if (!image) return '';
|
||||
return /^(https?:|data:|\/\/)/i.test(image)
|
||||
? image
|
||||
: `${getBaseUrl()}/public/${image}`;
|
||||
}
|
||||
|
||||
const imageUrl = computed(() => resolveImage(form.value.image));
|
||||
|
||||
function pickPhoto() {
|
||||
photoInput.value?.click();
|
||||
@@ -184,6 +241,9 @@ async function saveSheet() {
|
||||
const payload = {
|
||||
id: actorId,
|
||||
...form.value,
|
||||
// Les eines i els idiomes van a l'API com a llista, que és com està desats.
|
||||
tools: proficiencyList(form.value.tools),
|
||||
languages: proficiencyList(form.value.languages),
|
||||
inventory: form.value.inventory.filter((item) => item.name.trim())
|
||||
};
|
||||
const response = await Server().post('/actor/update', payload);
|
||||
@@ -259,7 +319,10 @@ async function saveSheet() {
|
||||
|
||||
<div v-if="error" class="sheet-error">{{ error }}</div>
|
||||
|
||||
<main v-show="activeTab === 'abilities'" class="sheet-grid">
|
||||
<!-- La columna del personatge no penja de cap pestanya: la imatge i el que es mira
|
||||
d'anada i tornada — classe d'armadura, velocitat, bonificadors i les barres de
|
||||
cops — es queden a la vista des de qualsevol pestanya de la fitxa. -->
|
||||
<div class="sheet-layout">
|
||||
<div class="character-column">
|
||||
<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')">
|
||||
@@ -327,75 +390,148 @@ async function saveSheet() {
|
||||
</section>
|
||||
</div>
|
||||
|
||||
<section class="sheet-panel abilities-panel">
|
||||
<h2>{{ $t('campaigns.character-sheet.ability-scores') }}</h2>
|
||||
<div class="ability-grid">
|
||||
<div v-for="stat in abilityStats" :key="stat.key" class="ability-card">
|
||||
<span class="ability-label">{{ stat.label }}</span>
|
||||
<input v-if="editing" v-model.number="form.abilityScores[stat.key]" type="number" min="1" max="30" :aria-label="stat.label">
|
||||
<strong v-else class="ability-score">{{ form.abilityScores[stat.key] }}</strong>
|
||||
<span class="ability-modifier">{{ abilityModifier(form.abilityScores[stat.key]) }}</span>
|
||||
<main v-show="activeTab === 'abilities'" class="sheet-tab-body">
|
||||
<section class="sheet-panel abilities-panel">
|
||||
<h2>{{ $t('campaigns.character-sheet.ability-scores') }}</h2>
|
||||
<div class="ability-grid">
|
||||
<div v-for="stat in abilityStats" :key="stat.key" class="ability-card">
|
||||
<span class="ability-label">{{ stat.label }}</span>
|
||||
<input v-if="editing" v-model.number="form.abilityScores[stat.key]" type="number" min="1" max="30" :aria-label="stat.label">
|
||||
<strong v-else class="ability-score">{{ form.abilityScores[stat.key] }}</strong>
|
||||
<span class="ability-modifier">{{ abilityModifier(form.abilityScores[stat.key]) }}</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<section class="sheet-panel proficiencies-panel">
|
||||
<h2>{{ $t('campaigns.character-sheet.proficiencies') }}</h2>
|
||||
<textarea v-if="editing" v-model="form.proficiencies" rows="7" :placeholder="$t('campaigns.character-sheet.proficiencies-placeholder')" />
|
||||
<p v-else class="sheet-copy">{{ form.proficiencies || $t('campaigns.character-sheet.empty-proficiencies') }}</p>
|
||||
</section>
|
||||
</main>
|
||||
<!-- Les tirades de salvació van just a sota de les característiques, que
|
||||
són les que les manen: el cercle diu si el personatge hi està entrenat. -->
|
||||
<h3>{{ $t('campaigns.character-sheet.saving-throws') }}</h3>
|
||||
<div class="saving-throw-grid">
|
||||
<button
|
||||
v-for="stat in abilityStats"
|
||||
:key="stat.key"
|
||||
class="proficiency-row"
|
||||
type="button"
|
||||
role="switch"
|
||||
:aria-checked="form.savingThrows[stat.key]"
|
||||
:disabled="!editing"
|
||||
@click="toggleProficiency('savingThrows', stat.key)"
|
||||
>
|
||||
<span class="proficiency-dot" :class="{ proficient: form.savingThrows[stat.key] }" aria-hidden="true" />
|
||||
<span class="proficiency-name">{{ $t(`campaigns.character-sheet.abilities.${stat.key}`) }}</span>
|
||||
<span class="proficiency-modifier">{{ savingThrowModifier(stat) }}</span>
|
||||
</button>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<main v-show="activeTab === 'inventory'" class="sheet-tab-body">
|
||||
<section class="sheet-panel inventory-panel">
|
||||
<div class="panel-title-row">
|
||||
<h2>{{ $t('campaigns.character-sheet.inventory') }}</h2>
|
||||
<button v-if="editing" class="sheet-button secondary compact" type="button" @click="addInventoryItem">{{ $t('campaigns.character-sheet.add-item') }}</button>
|
||||
</div>
|
||||
<div class="weight-summary">
|
||||
<span>{{ $t('campaigns.character-sheet.carried-weight') }}</span>
|
||||
<strong>{{ carriedWeight.toFixed(1) }} / {{ carryingCapacity }} lb</strong>
|
||||
</div>
|
||||
<div class="weight-track"><div class="weight-fill" :style="{ width: `${carryPercent}%` }" /></div>
|
||||
<div class="inventory-table-wrap">
|
||||
<table class="inventory-table">
|
||||
<thead><tr>
|
||||
<th>{{ $t('campaigns.character-sheet.item-name') }}</th>
|
||||
<th>{{ $t('campaigns.character-sheet.quantity') }}</th>
|
||||
<th>{{ $t('campaigns.character-sheet.weight-each') }}</th>
|
||||
<th>{{ $t('campaigns.character-sheet.total-weight') }}</th>
|
||||
<th v-if="editing"><span class="sr-only">{{ $t('campaigns.character-sheet.actions') }}</span></th>
|
||||
</tr></thead>
|
||||
<tbody>
|
||||
<tr v-for="(item, index) in form.inventory" :key="index">
|
||||
<td><input v-if="editing" v-model="item.name" :aria-label="$t('campaigns.character-sheet.item-name')"><span v-else>{{ item.name }}</span></td>
|
||||
<td><input v-if="editing" v-model.number="item.quantity" type="number" min="1" :aria-label="$t('campaigns.character-sheet.quantity')"><span v-else>{{ item.quantity }}</span></td>
|
||||
<td><input v-if="editing" v-model.number="item.weight" type="number" min="0" step="0.1" :aria-label="$t('campaigns.character-sheet.weight-each')"><span v-else>{{ Number(item.weight).toFixed(1) }} lb</span></td>
|
||||
<td>{{ ((Number(item.quantity) || 0) * (Number(item.weight) || 0)).toFixed(1) }} lb</td>
|
||||
<td v-if="editing"><button class="remove-item" type="button" @click="removeInventoryItem(index)">×</button></td>
|
||||
</tr>
|
||||
<tr v-if="form.inventory.length === 0"><td :colspan="editing ? 5 : 4" class="empty-inventory">{{ $t('campaigns.character-sheet.empty-inventory') }}</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</section>
|
||||
</main>
|
||||
<section class="sheet-panel skills-panel">
|
||||
<h2>{{ $t('campaigns.character-sheet.skills') }}</h2>
|
||||
<div class="skill-grid">
|
||||
<button
|
||||
v-for="skill in skillList"
|
||||
:key="skill.key"
|
||||
class="proficiency-row"
|
||||
type="button"
|
||||
role="switch"
|
||||
:aria-checked="form.skills[skill.key]"
|
||||
:disabled="!editing"
|
||||
@click="toggleProficiency('skills', skill.key)"
|
||||
>
|
||||
<span class="proficiency-dot" :class="{ proficient: form.skills[skill.key] }" aria-hidden="true" />
|
||||
<span class="proficiency-name">{{ $t(`campaigns.character-sheet.skill-names.${skill.key}`) }}</span>
|
||||
<span class="proficiency-ability">{{ skill.ability.toUpperCase() }}</span>
|
||||
<span class="proficiency-modifier">{{ skillModifier(skill) }}</span>
|
||||
</button>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<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>
|
||||
<section class="sheet-panel proficiencies-panel">
|
||||
<h2>{{ $t('campaigns.character-sheet.proficiencies') }}</h2>
|
||||
<textarea v-if="editing" v-model="form.proficiencies" rows="7" :placeholder="$t('campaigns.character-sheet.proficiencies-placeholder')" />
|
||||
<p v-else class="sheet-copy">{{ form.proficiencies || $t('campaigns.character-sheet.empty-proficiencies') }}</p>
|
||||
|
||||
<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>
|
||||
<!-- Les eines i els idiomes tenen llista pròpia; el text de dalt guarda
|
||||
el que no en té, com les armadures i les armes. -->
|
||||
<div class="proficiency-lists">
|
||||
<div class="proficiency-list">
|
||||
<h3>{{ $t('campaigns.character-sheet.tools') }}</h3>
|
||||
<textarea v-if="editing" v-model="form.tools" rows="4" :placeholder="$t('campaigns.character-sheet.tools-placeholder')" />
|
||||
<p v-else class="sheet-copy">{{ form.tools || $t('campaigns.character-sheet.empty-tools') }}</p>
|
||||
</div>
|
||||
<div class="proficiency-list">
|
||||
<h3>{{ $t('campaigns.character-sheet.languages') }}</h3>
|
||||
<textarea v-if="editing" v-model="form.languages" rows="4" :placeholder="$t('campaigns.character-sheet.languages-placeholder')" />
|
||||
<p v-else class="sheet-copy">{{ form.languages || $t('campaigns.character-sheet.empty-languages') }}</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</main>
|
||||
|
||||
<main v-show="activeTab === 'inventory'" class="sheet-tab-body">
|
||||
<section class="sheet-panel inventory-panel">
|
||||
<div class="panel-title-row">
|
||||
<h2>{{ $t('campaigns.character-sheet.inventory') }}</h2>
|
||||
<button v-if="editing" class="sheet-button secondary compact" type="button" @click="addInventoryItem">{{ $t('campaigns.character-sheet.add-item') }}</button>
|
||||
</div>
|
||||
<div class="weight-summary">
|
||||
<span>{{ $t('campaigns.character-sheet.carried-weight') }}</span>
|
||||
<strong>{{ carriedWeight.toFixed(1) }} / {{ carryingCapacity }} lb</strong>
|
||||
</div>
|
||||
<div class="weight-track"><div class="weight-fill" :style="{ width: `${carryPercent}%` }" /></div>
|
||||
|
||||
<!-- La moneda que el personatge porta a sobre, en les cinc monedes del joc. -->
|
||||
<h3>{{ $t('campaigns.character-sheet.currency') }}</h3>
|
||||
<div class="currency-row">
|
||||
<label v-for="unit in currencyUnits" :key="unit" class="currency-field">
|
||||
<span>{{ $t(`campaigns.character-sheet.currency-units.${unit}`) }}</span>
|
||||
<input v-if="editing" v-model.number="form.currency[unit]" type="number" min="0" :aria-label="$t(`campaigns.character-sheet.currency-units.${unit}`)">
|
||||
<strong v-else>{{ form.currency[unit] }}</strong>
|
||||
</label>
|
||||
</div>
|
||||
<div class="inventory-table-wrap">
|
||||
<table class="inventory-table">
|
||||
<thead><tr>
|
||||
<th><span class="sr-only">{{ $t('campaigns.character-sheet.item-icon') }}</span></th>
|
||||
<th class="item-name-cell">{{ $t('campaigns.character-sheet.item-name') }}</th>
|
||||
<th>{{ $t('campaigns.character-sheet.quantity') }}</th>
|
||||
<th>{{ $t('campaigns.character-sheet.weight-each') }}</th>
|
||||
<th>{{ $t('campaigns.character-sheet.total-weight') }}</th>
|
||||
<th v-if="editing"><span class="sr-only">{{ $t('campaigns.character-sheet.actions') }}</span></th>
|
||||
</tr></thead>
|
||||
<tbody>
|
||||
<tr v-for="(item, index) in form.inventory" :key="index">
|
||||
<td class="item-icon-cell">
|
||||
<img v-if="item.icon" :src="resolveImage(item.icon)" :alt="$t('campaigns.character-sheet.item-icon')">
|
||||
<span v-else class="item-icon-blank" aria-hidden="true" />
|
||||
</td>
|
||||
<td class="item-name-cell"><input v-if="editing" v-model="item.name" :aria-label="$t('campaigns.character-sheet.item-name')"><span v-else>{{ item.name }}</span></td>
|
||||
<td><input v-if="editing" v-model.number="item.quantity" type="number" min="1" :aria-label="$t('campaigns.character-sheet.quantity')"><span v-else>{{ item.quantity }}</span></td>
|
||||
<td><input v-if="editing" v-model.number="item.weight" type="number" min="0" step="0.1" :aria-label="$t('campaigns.character-sheet.weight-each')"><span v-else>{{ Number(item.weight).toFixed(1) }} lb</span></td>
|
||||
<td>{{ ((Number(item.quantity) || 0) * (Number(item.weight) || 0)).toFixed(1) }} lb</td>
|
||||
<td v-if="editing"><button class="remove-item" type="button" @click="removeInventoryItem(index)">×</button></td>
|
||||
</tr>
|
||||
<tr v-if="form.inventory.length === 0"><td :colspan="editing ? 6 : 5" class="empty-inventory">{{ $t('campaigns.character-sheet.empty-inventory') }}</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</section>
|
||||
</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>
|
||||
</div>
|
||||
</div>
|
||||
</template>
|
||||
@@ -419,8 +555,10 @@ async function saveSheet() {
|
||||
.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.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-tab-body { display: block; }
|
||||
/* El marc de la fitxa: la columna del personatge, sempre a la vista, i al seu costat el contingent
|
||||
de la pestanya oberta. */
|
||||
.sheet-layout { display: grid; grid-template-columns: minmax(200px, 34%) minmax(0, 1fr); gap: 11px; align-items: start; }
|
||||
.sheet-tab-body { grid-column: 2; grid-row: 1; display: flex; flex-direction: column; gap: 11px; min-width: 0; }
|
||||
/* Pestilletes del marc: arrencen del cantó dret de la finestra, per fora del cos, i queden
|
||||
fora del contingent que desfila. Per sota de 760px no hi ha lloc fora (vegeu a sota). */
|
||||
.sheet-tabs { position: absolute; left: 100%; top: 34px; display: flex; flex-direction: column; align-items: flex-start; gap: 5px; padding-top: 6px; }
|
||||
@@ -454,16 +592,28 @@ async function saveSheet() {
|
||||
.portrait-controls button:disabled { opacity: .55; cursor: wait; }
|
||||
.photo-input { display: none; }
|
||||
/* La columna de la fitxa: la imatge dalt i, just a sota, el que es consulta d'anada i
|
||||
tornada — classe d'armadura, velocitat, bonificadors i les barres de cops. */
|
||||
.character-column { grid-column: 1; grid-row: 1 / -1; display: flex; flex-direction: column; gap: 11px; min-width: 0; }
|
||||
.abilities-panel { grid-column: 2 / -1; grid-row: 1; }
|
||||
.proficiencies-panel { grid-column: 2 / -1; grid-row: 2; }
|
||||
tornada — classe d'armadura, velocitat, bonificadors i les barres de cops. No penja de
|
||||
cap pestanya: es queda al seu lloc mentre se'n canvia. */
|
||||
.character-column { grid-column: 1; grid-row: 1; display: flex; flex-direction: column; gap: 11px; min-width: 0; }
|
||||
.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-label { font-size: 11px; font-weight: 700; letter-spacing: .08em; opacity: .75; }
|
||||
.ability-score { font: 25px MrEavesRemake; }
|
||||
.ability-modifier { min-width: 33px; text-align: center; padding: 2px 5px; border-radius: 999px; background: var(--color-background); font-size: 12px; }
|
||||
.ability-card input { width: 55px; text-align: center; font-size: 21px; }
|
||||
/* Les habilitats i les tirades de salvació: el cercle diu si el personatge hi està
|
||||
entrenat, al costat la característica que mana i la modificadora que tira. */
|
||||
.saving-throw-grid { display: grid; grid-template-columns: repeat(3, minmax(0, 1fr)); gap: 5px; }
|
||||
.skill-grid { display: grid; grid-template-columns: repeat(2, minmax(0, 1fr)); gap: 5px; }
|
||||
.proficiency-row { display: flex; align-items: center; gap: 6px; min-width: 0; padding: 5px 7px; border: 1px solid var(--color-border); border-radius: 7px; background: var(--color-background-soft); color: var(--color-text); font: inherit; font-size: 12px; text-align: left; cursor: pointer; }
|
||||
.proficiency-row:hover:not(:disabled) { border-color: var(--color-link); }
|
||||
.proficiency-row:disabled { cursor: default; }
|
||||
.proficiency-dot { width: 14px; height: 14px; flex: 0 0 14px; border: 2px solid var(--color-border); border-radius: 50%; }
|
||||
.proficiency-dot.proficient { border-color: var(--color-link); background: var(--color-link); box-shadow: inset 0 0 0 2px var(--color-background-soft); }
|
||||
.proficiency-name { flex: 1; min-width: 0; overflow-wrap: anywhere; }
|
||||
.proficiency-ability { font-size: 10px; letter-spacing: .06em; opacity: .6; }
|
||||
.proficiency-modifier { font-size: 11px; opacity: .8; }
|
||||
.proficiency-lists { display: grid; grid-template-columns: repeat(2, minmax(0, 1fr)); gap: 11px; }
|
||||
.vitals-panel { display: flex; flex-direction: column; gap: 11px; }
|
||||
.vital-stats { display: grid; grid-template-columns: 1fr 1fr; gap: 7px; }
|
||||
.vital-stat { min-height: 68px; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 4px; padding: 6px 4px; border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft); text-align: center; }
|
||||
@@ -495,20 +645,31 @@ textarea { resize: vertical; width: 100%; min-height: 88px; font-size: 12px; }
|
||||
.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; }
|
||||
.inventory-table-wrap { overflow-x: auto; }
|
||||
/* La moneda que el personatge porta a sobre, en les cinc del joc. */
|
||||
.currency-row { display: grid; grid-template-columns: repeat(5, minmax(0, 1fr)); gap: 7px; margin-bottom: 11px; }
|
||||
.currency-field { display: flex; flex-direction: column; align-items: center; gap: 3px; padding: 6px 4px; border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft); text-align: center; }
|
||||
.currency-field > span { font-size: 10px; letter-spacing: .05em; opacity: .72; }
|
||||
.currency-field > strong { font: 15px MrEavesRemake; }
|
||||
.currency-field input { width: 58px; text-align: center; }
|
||||
.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 td { padding: 5px 7px; border-top: 1px solid var(--color-border); }
|
||||
.inventory-table td input { width: 100%; min-width: 54px; }
|
||||
.inventory-table td:first-child input { min-width: 100px; }
|
||||
.inventory-table th:not(:first-child), .inventory-table td:not(:first-child) { text-align: center; }
|
||||
.inventory-table td.item-name-cell input { min-width: 100px; }
|
||||
/* La icona de cada objecte obre la filera; el nom continua alineat a l'esquerra i la
|
||||
quantitat i els pesos van al centre. */
|
||||
.inventory-table .item-icon-cell { width: 40px; padding-right: 0; }
|
||||
.item-icon-cell img { display: block; width: 26px; height: 26px; object-fit: contain; border-radius: 5px; }
|
||||
.item-icon-blank { display: block; width: 26px; height: 26px; border: 1px dashed var(--color-border); border-radius: 5px; opacity: .35; }
|
||||
.inventory-table th:not(:first-child):not(.item-name-cell), .inventory-table td:not(:first-child):not(.item-name-cell) { text-align: center; }
|
||||
.empty-inventory { text-align: center !important; opacity: .65; }
|
||||
.remove-item { width: 24px; height: 24px; border: 0; border-radius: 5px; background: transparent; color: var(--color-text); font-size: 20px; cursor: pointer; }
|
||||
.remove-item:hover { background: var(--color-button-hover); }
|
||||
.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; }
|
||||
@media (max-width: 760px) {
|
||||
.sheet-grid { grid-template-columns: 1fr; grid-template-rows: none; }
|
||||
.character-column, .abilities-panel, .proficiencies-panel { grid-column: 1 / -1; grid-row: auto; }
|
||||
.sheet-layout { grid-template-columns: 1fr; }
|
||||
.character-column, .sheet-tab-body { grid-column: 1 / -1; grid-row: auto; }
|
||||
/* El cantó dret no dona prou per penjar-hi les pestanyes: llavors es queden al marc, per
|
||||
dins, en una filera sota la barra de la finestra. */
|
||||
.sheet-tabs { position: static; align-self: stretch; flex-direction: row; flex-wrap: wrap; gap: 4px; padding: 6px 8px 0; }
|
||||
@@ -519,5 +680,7 @@ textarea { resize: vertical; width: 100%; min-height: 88px; font-size: 12px; }
|
||||
.sheet-hero { align-items: flex-start; flex-wrap: wrap; }
|
||||
.sheet-actions { margin-left: auto; }
|
||||
.ability-grid { grid-template-columns: repeat(3, minmax(0, 1fr)); }
|
||||
.skill-grid, .saving-throw-grid, .proficiency-lists { grid-template-columns: 1fr; }
|
||||
.currency-row { grid-template-columns: repeat(3, minmax(0, 1fr)); }
|
||||
}
|
||||
</style>
|
||||
|
||||
261
frontend/app/components/windows/DocumentationWindow.vue
Normal file
261
frontend/app/components/windows/DocumentationWindow.vue
Normal file
@@ -0,0 +1,261 @@
|
||||
<script setup>
|
||||
import { computed, nextTick, onMounted, ref } from 'vue';
|
||||
import { SetupHandle, SetSize, ResetPosition, Top, SetResizable, SetMinSize } from '@/services/Windows';
|
||||
|
||||
import WindowHandle from './partials/WindowHandle.vue';
|
||||
import { GetDocsFirstSlug, GetDocsNav, GetDocsPage } from '~/services/Docs';
|
||||
|
||||
// La documentació dins d'una finestra: el sumari a l'esquerra i la pàgina al centre, amb el
|
||||
// mateix contingut de app/content/docs que la pàgina pública de /docs (mira ~/services/Docs.js).
|
||||
// El sumari no porta enlloc amb rutes sinó amb estat propi, així obrir la documentació dins
|
||||
// d'una campanya no deixa les notes obertes enrere.
|
||||
const props = defineProps(['data']);
|
||||
const id = props.data.id;
|
||||
|
||||
const handle = ref(null);
|
||||
const wrapper = ref(null);
|
||||
const reading = ref(null);
|
||||
|
||||
const nav = GetDocsNav();
|
||||
const slug = ref(GetDocsFirstSlug());
|
||||
const page = computed(() => GetDocsPage(slug.value));
|
||||
|
||||
function GoTo(target) {
|
||||
if (!GetDocsPage(target)) return;
|
||||
slug.value = target;
|
||||
// Cada pàgina es comença a dalt, com faria el navegador.
|
||||
nextTick(() => { if (reading.value) reading.value.scrollTop = 0; });
|
||||
}
|
||||
|
||||
// Els enllaços que el markdown porta a dins (`[Foundry](/docs/foundry)`) i els seus apartats
|
||||
// s'han de seguir dins la finestra: sortir-ne per via d'una ruta deixaria la campanya enrere.
|
||||
function OnContentClick(event) {
|
||||
const link = event.target?.closest?.('a');
|
||||
if (!link) return;
|
||||
|
||||
const href = link.getAttribute('href') || '';
|
||||
|
||||
// Un apartat de la pàgina: el que fila és la columna de lectura, no la pantalla.
|
||||
if (href.startsWith('#')) {
|
||||
if (href.length < 2) return;
|
||||
const heading = reading.value?.querySelector('#' + CSS.escape(href.slice(1)));
|
||||
if (!heading) return;
|
||||
event.preventDefault();
|
||||
heading.scrollIntoView({ block: 'start' });
|
||||
return;
|
||||
}
|
||||
|
||||
const inside = /^\/docs\/?([a-z0-9-]*)$/.exec(href);
|
||||
if (inside) {
|
||||
event.preventDefault();
|
||||
GoTo(inside[1] || GetDocsFirstSlug());
|
||||
return;
|
||||
}
|
||||
|
||||
// Fora de la documentació: una pestanya nova, que la campanya no es mou d'aquí.
|
||||
if (href && !href.startsWith('/')) {
|
||||
event.preventDefault();
|
||||
window.open(href, '_blank', 'noopener');
|
||||
}
|
||||
}
|
||||
|
||||
onMounted(() => {
|
||||
Top(wrapper);
|
||||
SetupHandle(id, handle);
|
||||
SetSize(id, {
|
||||
width: Math.max(620, Math.min(1000, window.innerWidth - 24)),
|
||||
height: Math.max(420, Math.min(780, window.innerHeight - 32))
|
||||
});
|
||||
ResetPosition(id, 'center');
|
||||
SetResizable(id, true);
|
||||
SetMinSize(id, { width: 620, height: 420 });
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
<template>
|
||||
<div class="window-wrapper" :id="'window-wrapper-' + id" ref="wrapper">
|
||||
<WindowHandle :window="id" ref="handle"></WindowHandle>
|
||||
|
||||
<!-- Body -->
|
||||
<div class="docs-body">
|
||||
<aside class="docs-contents" :aria-label="$t('docs.contents')">
|
||||
<section v-for="group in nav" :key="group.key" class="docs-group">
|
||||
<h2 class="docs-group-title">{{ $t(`docs.groups.${group.key}`) }}</h2>
|
||||
<ul>
|
||||
<li v-for="entry in group.pages" :key="entry.slug">
|
||||
<button
|
||||
type="button"
|
||||
class="docs-nav-link sound-click"
|
||||
:class="{ active: entry.slug === slug }"
|
||||
v-on:click="GoTo(entry.slug)"
|
||||
>{{ entry.title }}</button>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</aside>
|
||||
|
||||
<div class="docs-reading" ref="reading">
|
||||
<template v-if="page">
|
||||
<article class="docs-article" v-on:click="OnContentClick">
|
||||
<p class="docs-kicker">{{ $t(`docs.groups.${page.group}`) }}</p>
|
||||
<!-- El contingut és markdown nostre, de app/content/docs -->
|
||||
<div class="docs-markdown" v-html="page.html"></div>
|
||||
</article>
|
||||
|
||||
<nav class="docs-pager">
|
||||
<button
|
||||
v-if="page.previous"
|
||||
type="button"
|
||||
class="docs-pager-link sound-click"
|
||||
v-on:click="GoTo(page.previous.slug)"
|
||||
>
|
||||
<span class="docs-pager-label">{{ $t('docs.previous') }}</span>
|
||||
<strong>{{ page.previous.title }}</strong>
|
||||
</button>
|
||||
<button
|
||||
v-if="page.next"
|
||||
type="button"
|
||||
class="docs-pager-link next sound-click"
|
||||
v-on:click="GoTo(page.next.slug)"
|
||||
>
|
||||
<span class="docs-pager-label">{{ $t('docs.next') }}</span>
|
||||
<strong>{{ page.next.title }}</strong>
|
||||
</button>
|
||||
</nav>
|
||||
</template>
|
||||
|
||||
<article v-else class="docs-article">
|
||||
<h1>{{ $t('docs.title') }}</h1>
|
||||
<p>{{ $t('docs.not-found', { page: slug }) }}</p>
|
||||
</article>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
|
||||
<style scoped lang="scss">
|
||||
/* El sumari i la lectura són les dues columnes d'una finestra: cada una fila per la seva,
|
||||
res d'una pantalla d'alçada ni de sticky, que la finestra ja és el que es mou. */
|
||||
.docs-body {
|
||||
display: flex;
|
||||
flex: 1;
|
||||
width: 100%;
|
||||
min-height: 0;
|
||||
}
|
||||
|
||||
.docs-contents {
|
||||
flex: 0 0 212px;
|
||||
min-width: 0;
|
||||
box-sizing: border-box;
|
||||
padding: 14px 10px;
|
||||
border-right: 1px solid var(--color-border);
|
||||
overflow-y: auto;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 16px;
|
||||
}
|
||||
|
||||
.docs-group-title {
|
||||
margin: 0 0 6px 0;
|
||||
font-family: 'MrEavesRemake', serif;
|
||||
font-size: 0.78rem;
|
||||
font-weight: normal;
|
||||
letter-spacing: 0.08em;
|
||||
text-transform: uppercase;
|
||||
color: var(--color-gray);
|
||||
}
|
||||
|
||||
.docs-contents ul {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
list-style: none;
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 2px;
|
||||
}
|
||||
|
||||
/* Les pàgines del sumari són botons: una finestra no té rutes a seguir. */
|
||||
.docs-nav-link {
|
||||
width: 100%;
|
||||
margin: 0;
|
||||
padding: 6px 9px;
|
||||
border: none;
|
||||
border-radius: 6px;
|
||||
box-shadow: none;
|
||||
background-color: transparent;
|
||||
font-size: 0.95rem;
|
||||
line-height: 1.35;
|
||||
text-align: left;
|
||||
color: var(--color-text);
|
||||
}
|
||||
|
||||
.docs-nav-link:hover {
|
||||
background-color: var(--color-hover);
|
||||
}
|
||||
|
||||
.docs-nav-link.active {
|
||||
background-color: var(--color-background-soft);
|
||||
color: var(--color-link);
|
||||
}
|
||||
|
||||
.docs-reading {
|
||||
flex: 1;
|
||||
min-width: 0;
|
||||
box-sizing: border-box;
|
||||
padding: 20px 26px 40px 26px;
|
||||
overflow-y: auto;
|
||||
/* El que es llegeix es pot seleccionar, encara que una finestra no ho permeti per defecte. */
|
||||
user-select: text;
|
||||
}
|
||||
|
||||
/* La columna de lectura, centrada dins l'espai que deixa el sumari. */
|
||||
.docs-article,
|
||||
.docs-pager {
|
||||
width: 100%;
|
||||
max-width: 720px;
|
||||
margin-inline: auto;
|
||||
}
|
||||
|
||||
.docs-kicker {
|
||||
margin: 0 0 4px 0;
|
||||
font-size: 0.8rem;
|
||||
letter-spacing: 0.08em;
|
||||
text-transform: uppercase;
|
||||
color: var(--color-gray);
|
||||
}
|
||||
|
||||
.docs-pager {
|
||||
margin-top: 30px;
|
||||
padding-top: 16px;
|
||||
border-top: 1px solid var(--color-border);
|
||||
display: flex;
|
||||
gap: 14px;
|
||||
}
|
||||
|
||||
/* Són els botons d'abans i després, no botons d'un formulari: van plans, com a /docs. */
|
||||
.docs-pager-link {
|
||||
flex: 1 1 0;
|
||||
min-width: 0;
|
||||
margin: 0;
|
||||
padding: 10px 12px;
|
||||
border: 1px solid var(--color-border);
|
||||
border-radius: 8px;
|
||||
box-shadow: none;
|
||||
text-align: left;
|
||||
color: var(--color-text);
|
||||
}
|
||||
|
||||
.docs-pager-link.next {
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
.docs-pager-label {
|
||||
display: block;
|
||||
font-size: 0.78rem;
|
||||
letter-spacing: 0.06em;
|
||||
text-transform: uppercase;
|
||||
color: var(--color-gray);
|
||||
}
|
||||
</style>
|
||||
@@ -14,11 +14,14 @@ Opening an actor opens its **character sheet**, in tabs:
|
||||
|
||||
| Tab | What it holds |
|
||||
| --- | --- |
|
||||
| Ability Scores | Strength, Dexterity, Constitution, Intelligence, Wisdom, Charisma, and the proficiency bonus |
|
||||
| Inventory | What it carries: item, quantity and weight each, with the total carried weight added up |
|
||||
| Ability Scores | Strength, Dexterity, Constitution, Intelligence, Wisdom, Charisma, and the proficiency bonus. Under them the six saving throws and the eighteen skills, each with a circle that stands lit when the character is proficient with it, next to the modifier it rolls. The proficiencies follow: the character's tools, its languages, and whatever else it is proficient with as text |
|
||||
| Inventory | What it carries: every item with its icon, quantity and weight each, the total carried weight added up, and the coins the character holds |
|
||||
| Traits | Features, traits and other details, as text |
|
||||
| Spells | The spells it knows, one per line |
|
||||
|
||||
Toggling a skill, a saving throw, or writing a tool or a language is done like everything else on the
|
||||
sheet: **Edit**, change it, **Save sheet**.
|
||||
|
||||
Combat lives above the tabs: armor class, speed, initiative, current and maximum hit points, and hit
|
||||
dice. The photo at the top of the sheet is what shows up next to the character everywhere else —
|
||||
including in [Discord](/docs/discord), where players can read the sheet of the character they hold.
|
||||
|
||||
@@ -44,8 +44,23 @@ cell you dropped it on and is sized by that cell, so a huge creature can be give
|
||||
sizing it up on the map's settings.
|
||||
|
||||
Once a token is on the map you can drag it to another cell, step it across the grid one cell at a time
|
||||
with the **arrow keys**, and take it off with **Delete**. Clicking a token opens the sheet of the actor
|
||||
it stands for.
|
||||
with the **arrow keys**, and take it off with **Delete**. Double-clicking a token opens the sheet of
|
||||
the actor it stands for, and **Enter** does the same on a token focused with the keyboard.
|
||||
|
||||
Tokens belong to the map, not to the actor: the same character can stand on several maps, and taking a
|
||||
token off does not remove the character from the campaign.
|
||||
|
||||
## Maps from a linked Foundry world
|
||||
|
||||
With a Foundry world linked to the campaign, its scenes arrive as maps of their own: each one with the
|
||||
scene's background picture and the grid laid over it, in the scene's own cell size and where the world
|
||||
shifts that grid onto the picture. That is all a scene lends a map — what one of your cells stands
|
||||
for, the folder a map stands in, and whatever you pin or stand on it stay yours, and nothing about a
|
||||
map goes back to the world.
|
||||
|
||||
A scene renamed in Foundry, or its grid moved, updates its map. Take the background picture off a
|
||||
scene and its map keeps the one it has; delete the scene and its map goes with it the next time the
|
||||
world sends its whole scene list, which is when the world loads. For the same reason a map you delete
|
||||
in the campaign comes back on the next world load while its scene is still there — take the scene off
|
||||
in Foundry to be rid of the map. A map you made yourself is never doubled by the scene of it: a scene
|
||||
arriving with the name of an unmapped map adopts that one. See [Foundry VTT](/docs/foundry).
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
# Foundry VTT
|
||||
|
||||
The Foundry integration keeps a Dragonroll campaign and a Foundry world in step: the world's
|
||||
characters and item directory arrive in the campaign, and what you change in Dragonroll goes back to
|
||||
the world.
|
||||
characters, item directory and scenes arrive in the campaign, and what you change in Dragonroll of
|
||||
those characters and items goes back to the world.
|
||||
|
||||
There are two separate parts, and you only need the first of them:
|
||||
|
||||
@@ -47,16 +47,27 @@ Worth knowing:
|
||||
|
||||
| In Foundry | In the campaign |
|
||||
| --- | --- |
|
||||
| Character, NPC and creature actors | Actors with the same sheet: abilities, combat stats, proficiencies, traits, spells, carried gear, portrait |
|
||||
| Character, NPC and creature actors | Actors with the same sheet: abilities, saving throws, skills, combat stats, proficiencies, tools, languages, traits, spells, carried gear with its icons, coins, portrait |
|
||||
| The world's **item directory** (the items tab) | The campaign's item list, with category, rarity, quantity, weight, properties and description |
|
||||
| The folders grouping that item directory | Item folders with the same names and nesting |
|
||||
| A folder's colour | The campaign's folder colour — and the other way round, what you colour in Dragonroll lands on the world's folder |
|
||||
| The world's **scenes** | The campaign's maps: the scene's background picture and the grid laid over it, in the scene's own cell size |
|
||||
| A journal called **Dragonroll** — one page per note | Your campaign's notes. They arrive **from** Dragonroll: what you write in the journal does not go back |
|
||||
|
||||
The item list is the world's item directory and nothing else. The gear a character carries is that
|
||||
character's inventory: it travels with the character and stays on its sheet, so a sword a fighter owns
|
||||
does not turn up in the campaign's item list. Spells, classes, subclasses, backgrounds, feats and
|
||||
species are not gear and are not imported.
|
||||
|
||||
The world's scenes are the campaign's maps, and only their **background picture** and their **grid**
|
||||
cross over: a map arrives with the scene's picture and its cell size, and with the grid where the
|
||||
world shifts it. That is where the two stop — what one of your cells stands for, the folder a map
|
||||
stands in, the notes pinned onto it and the characters standing on it as tokens stay in the campaign,
|
||||
and nothing about a map is written back into the world. The scene list goes over when the world links
|
||||
and when it loads, which is also when the map of a scene the GM deleted goes with it; scenes changed
|
||||
afterwards arrive as they happen. A scene with no background picture makes no map, and the full list
|
||||
leaves a map the campaign already had alone, so a grid you lined up yourself survives a reload.
|
||||
|
||||
An actor or item keeps the Dragonroll id it was given in a `dragonroll-foundry.actorId` /
|
||||
`dragonroll-foundry.itemId` flag, and that is what makes the two sides recognise each other. A world
|
||||
item that carries no flag is matched by name, so a hand-written item in Dragonroll is adopted instead of
|
||||
@@ -67,6 +78,13 @@ few seconds. A **full** snapshot — the one taken when the world links, or forc
|
||||
directory — is the only thing that prunes: it is the only moment either side can see the whole list and
|
||||
notice what is gone. Live edits never delete anything.
|
||||
|
||||
Notes are the exception that runs one way, because notes are written in Dragonroll: every note stands
|
||||
as a page of a single journal called **Dragonroll**. A note you make or edit in the app appears on that
|
||||
journal within a few seconds, and deleting one takes its page with it. A page that stands under a note's
|
||||
title but carries no Dragonroll mark is claimed as that note's page, so a pairing that was lost does not
|
||||
double it. Any other page — one the GM made in that journal themselves — is left alone, and nothing
|
||||
written in the journal travels back to the campaign.
|
||||
|
||||
## Auto-sync, and sending one actor on purpose
|
||||
|
||||
**Dragonroll Auto-sync** is what keeps the two in step: actors and world items you create, change or
|
||||
|
||||
@@ -120,6 +120,12 @@ const defWindows = {
|
||||
component: () => import('~/components/windows/PinnedNoteWindow.vue'),
|
||||
close: () => ClearWindow({type: 'pinned_note'}),
|
||||
movable: true
|
||||
},
|
||||
documentation: {
|
||||
title: 'windows.documentation',
|
||||
component: () => import('~/components/windows/DocumentationWindow.vue'),
|
||||
close: () => ClearWindow({type: 'documentation'}),
|
||||
movable: true
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -120,10 +120,22 @@
|
||||
"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", "initiative": "Iniciativa",
|
||||
"hit-points": "Punts de cop", "max-hit-points": "Punts de cop màxims", "hit-dice": "Daus de cop", "max-hit-dice": "Daus de cop màxims", "proficiencies": "Competències",
|
||||
"proficiencies-placeholder": "Afegeix salvacions, habilitats, armadures, armes, eines i idiomes...", "empty-proficiencies": "No hi ha competències afegides.",
|
||||
"proficiencies-placeholder": "Afegeix armadures, armes i qualsevol altra competència del personatge...", "empty-proficiencies": "No hi ha competències afegides.",
|
||||
"saving-throws": "Tirades de salvació", "skills": "Habilitats",
|
||||
"abilities": { "str": "Força", "dex": "Destresa", "con": "Constitució", "int": "Intel·ligència", "wis": "Saviesa", "cha": "Carisma" },
|
||||
"skill-names": {
|
||||
"acrobatics": "Acrobàcies", "animalHandling": "Tracte amb els animals", "arcana": "Arcan", "athletics": "Atletisme",
|
||||
"deception": "Engany", "history": "Història", "insight": "Penetració", "intimidation": "Intimidació",
|
||||
"investigation": "Investigació", "medicine": "Medicina", "nature": "Naturalesa", "perception": "Percepció",
|
||||
"performance": "Actuació", "persuasion": "Persuasió", "religion": "Religió", "sleightOfHand": "Jocs de mans",
|
||||
"stealth": "Furtivitat", "survival": "Supervivència"
|
||||
},
|
||||
"tools": "Eines", "tools-placeholder": "Escriu les eines, una per línia...", "empty-tools": "Cap competència amb eines.",
|
||||
"languages": "Idiomes", "languages-placeholder": "Escriu els idiomes, un per línia...", "empty-languages": "Cap idioma.",
|
||||
"traits": "Trets", "traits-placeholder": "Afegeix trets, capacitats i altres detalls...", "empty-traits": "No hi ha trets afegits.",
|
||||
"spells": "Conjurs", "spells-placeholder": "Escriu els conjurs, un per línia...", "empty-spells": "No hi ha conjurs afegits.",
|
||||
"inventory": "Inventari", "add-item": "Afegeix un objecte", "carried-weight": "Pes transportat", "item-name": "Objecte",
|
||||
"quantity": "Quant.", "weight-each": "Unitat (lb)", "total-weight": "Total (lb)", "actions": "Accions", "empty-inventory": "L'inventari és buit."
|
||||
"quantity": "Quant.", "weight-each": "Unitat (lb)", "total-weight": "Total (lb)", "actions": "Accions", "empty-inventory": "L'inventari és buit.",
|
||||
"currency": "Monedes", "currency-units": { "pp": "PP", "gp": "GP", "ep": "EP", "sp": "SP", "cp": "CP" }, "item-icon": "Icona"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -10,6 +10,7 @@
|
||||
"create-map": "Crear mapa",
|
||||
"map-viewer": "Mapa",
|
||||
"pinned-note": "Nota fixada",
|
||||
"documentation": "Documentació",
|
||||
"item-sheet": "Objecte",
|
||||
"icon-source": "Tria una icona",
|
||||
"foundry-icons": "Icones del Foundry"
|
||||
|
||||
@@ -126,10 +126,22 @@
|
||||
"uploading-photo": "Uploading...", "photo-error": "Unable to upload this photo.", "ability-scores": "Ability Scores", "proficiency-bonus": "Proficiency Bonus",
|
||||
"combat": "Combat", "armor-class": "Armor Class", "speed": "Speed", "initiative": "Initiative",
|
||||
"hit-points": "Hit Points", "max-hit-points": "Maximum hit points", "hit-dice": "Hit Dice", "max-hit-dice": "Maximum hit dice", "proficiencies": "Proficiencies",
|
||||
"proficiencies-placeholder": "Add saving throws, skills, armor, weapons, tools, and languages...", "empty-proficiencies": "No proficiencies added.",
|
||||
"proficiencies-placeholder": "Add armor, weapons, and anything else the character is proficient with...", "empty-proficiencies": "No proficiencies added.",
|
||||
"saving-throws": "Saving Throws", "skills": "Skills",
|
||||
"abilities": { "str": "Strength", "dex": "Dexterity", "con": "Constitution", "int": "Intelligence", "wis": "Wisdom", "cha": "Charisma" },
|
||||
"skill-names": {
|
||||
"acrobatics": "Acrobatics", "animalHandling": "Animal Handling", "arcana": "Arcana", "athletics": "Athletics",
|
||||
"deception": "Deception", "history": "History", "insight": "Insight", "intimidation": "Intimidation",
|
||||
"investigation": "Investigation", "medicine": "Medicine", "nature": "Nature", "perception": "Perception",
|
||||
"performance": "Performance", "persuasion": "Persuasion", "religion": "Religion", "sleightOfHand": "Sleight of Hand",
|
||||
"stealth": "Stealth", "survival": "Survival"
|
||||
},
|
||||
"tools": "Tools", "tools-placeholder": "List tools, one per line...", "empty-tools": "No tool proficiencies.",
|
||||
"languages": "Languages", "languages-placeholder": "List languages, one per line...", "empty-languages": "No languages.",
|
||||
"traits": "Traits", "traits-placeholder": "Add features, traits, and other character details...", "empty-traits": "No traits added.",
|
||||
"spells": "Spells", "spells-placeholder": "List spells, one per line...", "empty-spells": "No spells added.",
|
||||
"inventory": "Inventory", "add-item": "Add item", "carried-weight": "Carried weight", "item-name": "Item",
|
||||
"quantity": "Qty", "weight-each": "Each (lb)", "total-weight": "Total (lb)", "actions": "Actions", "empty-inventory": "Inventory is empty."
|
||||
"quantity": "Qty", "weight-each": "Each (lb)", "total-weight": "Total (lb)", "actions": "Actions", "empty-inventory": "Inventory is empty.",
|
||||
"currency": "Currency", "currency-units": { "pp": "PP", "gp": "GP", "ep": "EP", "sp": "SP", "cp": "CP" }, "item-icon": "Icon"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -10,6 +10,7 @@
|
||||
"create-map": "Create Map",
|
||||
"map-viewer": "Map",
|
||||
"pinned-note": "Pinned note",
|
||||
"documentation": "Documentation",
|
||||
"item-sheet": "Item",
|
||||
"icon-source": "Choose an icon",
|
||||
"foundry-icons": "Foundry icons"
|
||||
|
||||
@@ -120,10 +120,22 @@
|
||||
"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", "initiative": "Iniciativa",
|
||||
"hit-points": "Puntos de golpe", "max-hit-points": "Puntos de golpe máximos", "hit-dice": "Dados de golpe", "max-hit-dice": "Dados de golpe máximos", "proficiencies": "Competencias",
|
||||
"proficiencies-placeholder": "Añade salvaciones, habilidades, armaduras, armas, herramientas e idiomas...", "empty-proficiencies": "No hay competencias añadidas.",
|
||||
"proficiencies-placeholder": "Añade armaduras, armas y cualquier otra competencia del personaje...", "empty-proficiencies": "No hay competencias añadidas.",
|
||||
"saving-throws": "Tiradas de salvación", "skills": "Habilidades",
|
||||
"abilities": { "str": "Fuerza", "dex": "Destreza", "con": "Constitución", "int": "Inteligencia", "wis": "Sabiduría", "cha": "Carisma" },
|
||||
"skill-names": {
|
||||
"acrobatics": "Acrobacias", "animalHandling": "Trato con animales", "arcana": "Arcano", "athletics": "Atletismo",
|
||||
"deception": "Engaño", "history": "Historia", "insight": "Perspicacia", "intimidation": "Intimidación",
|
||||
"investigation": "Investigación", "medicine": "Medicina", "nature": "Naturaleza", "perception": "Percepción",
|
||||
"performance": "Interpretación", "persuasion": "Persuasión", "religion": "Religión", "sleightOfHand": "Manualidades",
|
||||
"stealth": "Sigilo", "survival": "Supervivencia"
|
||||
},
|
||||
"tools": "Herramientas", "tools-placeholder": "Escribe las herramientas, una por línea...", "empty-tools": "Sin competencias con herramientas.",
|
||||
"languages": "Idiomas", "languages-placeholder": "Escribe los idiomas, uno por línea...", "empty-languages": "Sin idiomas.",
|
||||
"traits": "Rasgos", "traits-placeholder": "Añade rasgos, capacidades y otros detalles...", "empty-traits": "No hay rasgos añadidos.",
|
||||
"spells": "Conjuros", "spells-placeholder": "Escribe los conjuros, uno por línea...", "empty-spells": "No hay conjuros añadidos.",
|
||||
"inventory": "Inventario", "add-item": "Añadir objeto", "carried-weight": "Peso transportado", "item-name": "Objeto",
|
||||
"quantity": "Cant.", "weight-each": "Unidad (lb)", "total-weight": "Total (lb)", "actions": "Acciones", "empty-inventory": "El inventario está vacío."
|
||||
"quantity": "Cant.", "weight-each": "Unidad (lb)", "total-weight": "Total (lb)", "actions": "Acciones", "empty-inventory": "El inventario está vacío.",
|
||||
"currency": "Monedas", "currency-units": { "pp": "PP", "gp": "GP", "ep": "EP", "sp": "SP", "cp": "CP" }, "item-icon": "Icono"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -10,6 +10,7 @@
|
||||
"create-map": "Crear mapa",
|
||||
"map-viewer": "Mapa",
|
||||
"pinned-note": "Nota fijada",
|
||||
"documentation": "Documentación",
|
||||
"item-sheet": "Objeto",
|
||||
"icon-source": "Elegir icono",
|
||||
"foundry-icons": "Iconos de Foundry"
|
||||
|
||||
604
tests/character-sheet-details.test.js
Normal file
604
tests/character-sheet-details.test.js
Normal file
@@ -0,0 +1,604 @@
|
||||
// Tests for Syndria98/dragonroll#83, the things the character sheet did not hold:
|
||||
// * the eighteen skills down the ability scores tab, each with a circle that stands lit
|
||||
// when the character is proficient with it, and the six saving throws beside them,
|
||||
// * proficiencies with tools and with languages,
|
||||
// * the coins a character carries and the icon of each item it carries,
|
||||
// * and traits that reach the campaign from the linked Foundry world.
|
||||
//
|
||||
// The window is a `.vue` file and the repository root installs no dependencies for it, so
|
||||
// its template, styles and plain functions are read out of the source the way
|
||||
// tests/character-sheet-tabs.test.js and tests/character-sheet-portrait-column.test.js
|
||||
// read them. The Foundry mapper is plain CommonJS and is required for real; the actor
|
||||
// route runs in a stubbed `require` against fake models, like tests/foundry-force-import.test.js.
|
||||
// The Foundry module goes into a `node:vm` context with stubbed globals, like
|
||||
// tests/foundry-sync-toggle.test.js, so what its actor snapshot carries is observable.
|
||||
//
|
||||
// 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 vm = require("node:vm");
|
||||
|
||||
const read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
|
||||
const MODULE_ID = "dragonroll-foundry";
|
||||
|
||||
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] ?? "";
|
||||
const actorModelSource = read("backend", "src", "models", "Actor.js");
|
||||
|
||||
// `fromSource` hands back one top-level declaration as a value, like the other character
|
||||
// sheet tests do it.
|
||||
function fromSource(source, pattern, locals = {}) {
|
||||
const declaration = pattern.exec(source)?.[0];
|
||||
assert.ok(declaration, `expected ${pattern} in the source`);
|
||||
const name = /(?:const|function)\s+(\w+)/.exec(declaration)[1];
|
||||
return new Function(...Object.keys(locals), `${declaration}\n;return ${name};`)(...Object.values(locals));
|
||||
}
|
||||
|
||||
const abilityStats = fromSource(script, /const abilityStats = \[[\s\S]*?\];/);
|
||||
const skillList = fromSource(script, /const skillList = \[[\s\S]*?\];/);
|
||||
const currencyUnits = fromSource(script, /const currencyUnits = \[[\s\S]*?\];/);
|
||||
const proficiencyText = fromSource(script, /function proficiencyText\(value\) \{[\s\S]*?\n\}/);
|
||||
const proficiencyList = fromSource(script, /function proficiencyList\(text\) \{[\s\S]*?\n\}/);
|
||||
const normalizeActor = fromSource(script, /function normalizeActor\(actor\) \{[\s\S]*?\n\}/, {
|
||||
abilityStats, skillList, currencyUnits, proficiencyText
|
||||
});
|
||||
|
||||
const skillKeys = skillList.map(({ key }) => key);
|
||||
|
||||
// --- The sheet: skills and saving throws on the ability scores tab -----------------
|
||||
|
||||
test("the sheet knows the eighteen skills, each under the ability that manages it", () => {
|
||||
assert.deepEqual(skillKeys, [
|
||||
"acrobatics", "animalHandling", "arcana", "athletics", "deception", "history", "insight",
|
||||
"intimidation", "investigation", "medicine", "nature", "perception", "performance",
|
||||
"persuasion", "religion", "sleightOfHand", "stealth", "survival"
|
||||
]);
|
||||
assert.deepEqual(
|
||||
skillList.map(({ ability }) => ability),
|
||||
["dex", "wis", "int", "str", "cha", "int", "wis", "cha", "int", "wis", "int", "wis", "cha", "cha", "int", "dex", "dex", "wis"],
|
||||
"each skill stands with the ability D&D counts for it"
|
||||
);
|
||||
});
|
||||
|
||||
test("every skill stands with a circle that toggles whether the character is proficient", () => {
|
||||
const panel = /<section class="sheet-panel skills-panel">([\s\S]*?)<\/section>/.exec(template)?.[1] ?? "";
|
||||
assert.match(panel, /campaigns\.character-sheet\.skills/, "the panel is named for the skills");
|
||||
assert.match(panel, /v-for="skill in skillList"/);
|
||||
assert.match(panel, /:aria-checked="form\.skills\[skill\.key\]"/, "the circle says what it holds");
|
||||
assert.match(panel, /@click="toggleProficiency\('skills', skill\.key\)"/);
|
||||
assert.match(panel, /class="proficiency-dot"/);
|
||||
assert.match(panel, /\{ proficient: form\.skills\[skill\.key\] \}/, "the circle stands lit for a proficiency");
|
||||
assert.match(panel, /campaigns\.character-sheet\.skill-names\.\$\{skill\.key\}/, "the skill is called by its name");
|
||||
assert.match(panel, /\{\{ skillModifier\(skill\) \}\}/, "and it shows the modifier the character rolls with it");
|
||||
|
||||
const toggle = /function toggleProficiency\(group, key\) \{[\s\S]*?\n\}/.exec(script)?.[0];
|
||||
assert.match(toggle, /form\.value\[group\]\[key\] = !form\.value\[group\]\[key\]/, "the circle flips the toggle");
|
||||
// The toggles belong to an edit in progress, like every other field of the sheet.
|
||||
assert.match(panel, /:disabled="!editing"/);
|
||||
});
|
||||
|
||||
test("the six saving throws ride with the ability scores", () => {
|
||||
const abilities = /<section class="sheet-panel abilities-panel">([\s\S]*?)<\/section>/.exec(template)?.[1] ?? "";
|
||||
assert.match(abilities, /campaigns\.character-sheet\.saving-throws/);
|
||||
assert.match(abilities, /v-for="stat in abilityStats"/, "one save per ability score");
|
||||
assert.match(abilities, /:aria-checked="form\.savingThrows\[stat\.key\]"/);
|
||||
assert.match(abilities, /@click="toggleProficiency\('savingThrows', stat\.key\)"/);
|
||||
assert.match(abilities, /\{\{ savingThrowModifier\(stat\) \}\}/);
|
||||
// The ability scores themselves are untouched, and the saves stand under them.
|
||||
assert.match(abilities, /v-model\.number="form\.abilityScores\[stat\.key\]"/);
|
||||
assert.ok(
|
||||
abilities.indexOf("ability-grid") < abilities.indexOf("saving-throw-grid"),
|
||||
"the saving throws follow the scores they come from"
|
||||
);
|
||||
});
|
||||
|
||||
test("a skill's form entry starts off, and the world's toggles carry over", () => {
|
||||
const fresh = normalizeActor({});
|
||||
assert.deepEqual(fresh.skills.acrobatics, false);
|
||||
assert.deepEqual(fresh.savingThrows.str, false);
|
||||
assert.deepEqual(Object.keys(fresh.skills).length, 18, "every skill stands in the form, toggled or not");
|
||||
assert.deepEqual(Object.keys(fresh.savingThrows).sort(), ["cha", "con", "dex", "int", "str", "wis"]);
|
||||
|
||||
const trained = normalizeActor({ skills: { stealth: true }, savingThrows: { con: true } });
|
||||
assert.equal(trained.skills.stealth, true);
|
||||
assert.equal(trained.savingThrows.con, true);
|
||||
});
|
||||
|
||||
// --- Tools and languages ----------------------------------------------------------
|
||||
|
||||
test("tools and languages have a list of their own under the proficiencies", () => {
|
||||
const panel = /<section class="sheet-panel proficiencies-panel">([\s\S]*?)<\/section>/.exec(template)?.[1] ?? "";
|
||||
for (const [key, field] of [["tools", "form.tools"], ["languages", "form.languages"]]) {
|
||||
assert.match(panel, new RegExp(`campaigns\\.character-sheet\\.${key}`), `the ${key} are named`);
|
||||
assert.match(panel, new RegExp(`v-model="${field}"`), `the ${key} are edited as text`);
|
||||
assert.match(panel, new RegExp(`\\{\\{ ${field} \\|\\| \\$t\\('campaigns\\.character-sheet\\.empty-${key}'\\) \\}\\}`));
|
||||
}
|
||||
// The free text keeps what has no list of its own, so it no longer asks for these.
|
||||
const placeholder = /"proficiencies-placeholder": "([^"]+)"/.exec(read("frontend", "i18n", "locales", "en", "campaigns.json"))[1];
|
||||
assert.doesNotMatch(placeholder, /skills|saving throws|tools|languages/i, "the text field does not ask for what has its own list");
|
||||
});
|
||||
|
||||
test("the tools and languages lists travel as a list and edit as one name per line", () => {
|
||||
assert.deepEqual(normalizeActor({ tools: ["Thieves tools", "Dice set"] }).tools, "Thieves tools\nDice set");
|
||||
assert.deepEqual(normalizeActor({ languages: [] }).languages, "");
|
||||
assert.deepEqual(
|
||||
normalizeActor({ tools: [" Thieves tools ", "Thieves tools", "", "Dice set"] }).tools,
|
||||
"Thieves tools\nDice set",
|
||||
"blanks, spaces and repeats are not kept"
|
||||
);
|
||||
assert.deepEqual(proficiencyList("Thieves tools\nDice set"), ["Thieves tools", "Dice set"]);
|
||||
assert.deepEqual(proficiencyList("Common, Elvish, Common"), ["Common", "Elvish"], "a comma separates too");
|
||||
assert.deepEqual(proficiencyList(""), []);
|
||||
assert.deepEqual(proficiencyList(proficiencyText(["Cartographer's supplies"])), ["Cartographer's supplies"]);
|
||||
});
|
||||
|
||||
// --- Currency and item icons on the inventory tab ---------------------------------
|
||||
|
||||
test("the inventory shows the coins the character carries", () => {
|
||||
assert.deepEqual(currencyUnits, ["pp", "gp", "ep", "sp", "cp"]);
|
||||
const panel = /<main v-show="activeTab === 'inventory'"[\s\S]*?<\/main>/.exec(template)?.[0] ?? "";
|
||||
assert.match(panel, /campaigns\.character-sheet\.currency/);
|
||||
assert.match(panel, /v-for="unit in currencyUnits"/);
|
||||
assert.match(panel, /v-model\.number="form\.currency\[unit\]"/, "each coin can be counted in");
|
||||
assert.match(panel, /\{\{ form\.currency\[unit\] \}\}/, "and reads back outside of editing");
|
||||
|
||||
assert.deepEqual(normalizeActor({}).currency, { pp: 0, gp: 0, ep: 0, sp: 0, cp: 0 });
|
||||
assert.deepEqual(normalizeActor({ currency: { gp: 12, cp: "40" } }).currency, { pp: 0, gp: 12, ep: 0, sp: 0, cp: 40 });
|
||||
});
|
||||
|
||||
test("every inventory row opens with the item's icon", () => {
|
||||
const panel = /<main v-show="activeTab === 'inventory'"[\s\S]*?<\/main>/.exec(template)?.[0] ?? "";
|
||||
const iconCell = /<td class="item-icon-cell">([\s\S]*?)<\/td>/.exec(panel)?.[1] ?? "";
|
||||
assert.match(iconCell, /v-if="item\.icon"/);
|
||||
assert.match(iconCell, /:src="resolveImage\(item\.icon\)"/, "a world's own icon and an upload both resolve");
|
||||
assert.match(iconCell, /item-icon-blank/, "and a row without one leaves the place marked");
|
||||
|
||||
// The icon comes first, and the name it stands in front of keeps reading left.
|
||||
const firstCells = /<tr v-for="\(item, index\) in form\.inventory" :key="index">([\s\S]*?)<\/td>\s*([\s\S]*?)<\/td>/.exec(panel);
|
||||
assert.match(firstCells[1], /item-icon-cell/);
|
||||
assert.match(firstCells[2], /item-name-cell/);
|
||||
const aligns = /\.inventory-table th:not\(:first-child\):not\(\.item-name-cell\)/.exec(sheetSource)?.[0];
|
||||
assert.ok(aligns, "the name column is let go of the centred columns");
|
||||
|
||||
assert.equal(normalizeActor({ inventory: [{ name: "Torch" }] }).inventory[0].icon, "");
|
||||
assert.equal(
|
||||
normalizeActor({ inventory: [{ name: "Torch", icon: "http://vtt.test/icons/torch.svg" }] }).inventory[0].icon,
|
||||
"http://vtt.test/icons/torch.svg"
|
||||
);
|
||||
});
|
||||
|
||||
// --- The model and the route ------------------------------------------------------
|
||||
|
||||
test("the Actor model holds the skills, the saves, the tools, the languages and the coins", () => {
|
||||
for (const key of skillKeys) {
|
||||
assert.match(actorModelSource, new RegExp(`${key}: \\{ type: Boolean, default: false \\}`), `${key} is a toggle`);
|
||||
}
|
||||
for (const key of ["str", "dex", "con", "int", "wis", "cha"]) {
|
||||
assert.ok(
|
||||
new RegExp(`savingThrows: \\{[\\s\\S]*?${key}: \\{ type: Boolean, default: false \\}`).test(actorModelSource),
|
||||
`the ${key} saving throw stands in the model`
|
||||
);
|
||||
}
|
||||
assert.match(actorModelSource, /tools: \[\{ type: String, trim: true \}\]/);
|
||||
assert.match(actorModelSource, /languages: \[\{ type: String, trim: true \}\]/);
|
||||
for (const unit of currencyUnits) {
|
||||
assert.ok(
|
||||
new RegExp(`currency: \\{[\\s\\S]*?${unit}: \\{ type: Number, min: 0, default: 0 \\}`).test(actorModelSource),
|
||||
`${unit} counts among the coins`
|
||||
);
|
||||
}
|
||||
assert.match(actorModelSource, /icon: \{ type: String, default: '' \}/, "a carried item keeps its icon");
|
||||
});
|
||||
|
||||
// The actor update route with every require stubbed, the way
|
||||
// tests/foundry-force-import.test.js runs the import route.
|
||||
function loadActorRoute(actor) {
|
||||
const routes = new Map();
|
||||
const router = {
|
||||
get: (route, ...handlers) => routes.set(`GET ${route}`, handlers),
|
||||
post: (route, ...handlers) => routes.set(`POST ${route}`, handlers),
|
||||
};
|
||||
const requireStub = (id) => {
|
||||
if (id === "express") return { Router: () => router };
|
||||
if (id === "../services/storage") return { single: () => (req, res, next) => next() };
|
||||
if (id === "../models/Campaign") {
|
||||
return { findOne: () => ({ lean: () => Promise.resolve({ _id: "campaign-1" }) }) };
|
||||
}
|
||||
if (id === "../models/Actor") return { findById: async () => actor };
|
||||
if (id === "../models/Folder") return { belongsToSection: async () => true };
|
||||
if (id === "../models/Map") return { updateMany: async () => ({}) };
|
||||
throw new Error(`require("${id}") is not stubbed`);
|
||||
};
|
||||
|
||||
const moduleStub = { exports: {} };
|
||||
vm.compileFunction(read("backend", "src", "routes", "actor.js"), ["require", "module", "exports"])(
|
||||
requireStub, moduleStub, moduleStub.exports
|
||||
);
|
||||
|
||||
async function update(body, user = { id: "user-1" }) {
|
||||
const handlers = routes.get("POST /update");
|
||||
assert.ok(handlers, "POST /update is not mounted");
|
||||
let payload = null;
|
||||
await handlers[handlers.length - 1]({ body, user }, { json: (sent) => { payload = sent; } });
|
||||
return payload;
|
||||
}
|
||||
|
||||
return { update };
|
||||
}
|
||||
|
||||
test("the actor update writes the skills, the saves, the tools, the languages and the coins", async () => {
|
||||
const actor = { _id: "actor-1", campaign: "campaign-1", save: async () => {} };
|
||||
const route = loadActorRoute(actor);
|
||||
|
||||
const response = await route.update({
|
||||
id: "actor-1",
|
||||
skills: { acrobatics: true, stealth: false },
|
||||
savingThrows: { con: true },
|
||||
tools: [" Thieves tools ", "Thieves tools", "", "Dice set"],
|
||||
languages: ["Elvish", "Undercommon"],
|
||||
currency: { gp: 12, cp: 40 },
|
||||
inventory: [{ name: "Torch", quantity: 2, weight: 0.5, icon: "icons/torch.svg" }],
|
||||
});
|
||||
|
||||
assert.equal(response.status, "ok");
|
||||
assert.deepEqual(actor.skills, { acrobatics: true, stealth: false });
|
||||
assert.deepEqual(actor.savingThrows, { con: true });
|
||||
assert.deepEqual(actor.tools, ["Thieves tools", "Dice set"], "blanks and repeats are written out of the lists");
|
||||
assert.deepEqual(actor.languages, ["Elvish", "Undercommon"]);
|
||||
assert.deepEqual(actor.currency, { gp: 12, cp: 40 });
|
||||
assert.deepEqual(actor.inventory, [{ name: "Torch", quantity: 2, weight: 0.5, icon: "icons/torch.svg" }]);
|
||||
});
|
||||
|
||||
test("an update that says nothing about them leaves the toggles and lists where they are", async () => {
|
||||
const actor = {
|
||||
_id: "actor-1",
|
||||
campaign: "campaign-1",
|
||||
skills: { acrobatics: true },
|
||||
tools: ["Disguise kit"],
|
||||
currency: { gp: 3 },
|
||||
save: async () => {},
|
||||
};
|
||||
const route = loadActorRoute(actor);
|
||||
|
||||
const response = await route.update({ id: "actor-1", name: "Thalia" });
|
||||
|
||||
assert.equal(response.status, "ok");
|
||||
assert.equal(actor.name, "Thalia");
|
||||
assert.deepEqual(actor.skills, { acrobatics: true });
|
||||
assert.deepEqual(actor.tools, ["Disguise kit"]);
|
||||
assert.deepEqual(actor.currency, { gp: 3 });
|
||||
});
|
||||
|
||||
// --- The Foundry world fills them in ---------------------------------------------
|
||||
|
||||
const { foundryActorToCharacter } = require(path.join(__dirname, "..", "backend", "src", "services", "actor-foundry.js"));
|
||||
|
||||
test("a world's skill and saving throw proficiencies arrive toggled", () => {
|
||||
const character = foundryActorToCharacter({
|
||||
name: "Thalia",
|
||||
system: {
|
||||
skills: { acr: { value: 1 }, stl: { value: 0 }, prc: { value: 2 }, arc: { value: ["exp"] }, his: { value: [] } },
|
||||
savingThrows: { str: { value: 1 }, dex: { value: 0 }, con: { prof: { value: 2 } } },
|
||||
},
|
||||
});
|
||||
|
||||
assert.deepEqual(character.skills, {
|
||||
acrobatics: true, stealth: false, arcana: true, history: false, perception: true,
|
||||
});
|
||||
assert.deepEqual(character.savingThrows, { str: true, dex: false, con: true });
|
||||
});
|
||||
|
||||
test("an older world holding its saves under the abilities is read the same way", () => {
|
||||
const character = foundryActorToCharacter({
|
||||
name: "Thalia",
|
||||
system: { abilities: { str: { save: 0 }, dex: { save: 1 } }, saves: { con: { proficient: true } } },
|
||||
});
|
||||
|
||||
assert.deepEqual(character.savingThrows, { str: false, dex: true, con: true });
|
||||
});
|
||||
|
||||
test("a world that says nothing about skills or saves leaves what the campaign toggled", () => {
|
||||
const character = foundryActorToCharacter({ name: "Thalia", system: { abilities: { str: { value: 16 } } } });
|
||||
|
||||
assert.ok(!("skills" in character), "no skills to report is not the same as none proficient");
|
||||
assert.ok(!("savingThrows" in character));
|
||||
assert.ok(!("currency" in character));
|
||||
assert.ok(!("tools" in character), "and neither are the tool and language lists");
|
||||
assert.ok(!("languages" in character));
|
||||
});
|
||||
|
||||
test("the tools and languages the module names come over as they are named", () => {
|
||||
const character = foundryActorToCharacter({
|
||||
name: "Thalia",
|
||||
system: { traits: { tool: { value: ["xyz12abc345def67"] }, languages: { value: ["aB3cD9eF1gH2iJ4k"] } } },
|
||||
dragonroll: { tools: ["Thieves' tools", "Dice set"], languages: ["Elvish", "Deep Speech"] },
|
||||
});
|
||||
|
||||
assert.deepEqual(character.tools, ["Thieves' tools", "Dice set"]);
|
||||
assert.deepEqual(character.languages, ["Elvish", "Deep Speech"]);
|
||||
});
|
||||
|
||||
test("without the module's names the proficiency keys are read off the actor", () => {
|
||||
const character = foundryActorToCharacter({
|
||||
name: "Thalia",
|
||||
system: {
|
||||
traits: {
|
||||
tool: { value: ["thieves", "alchemist"], custom: "Dice set, Playing cards" },
|
||||
languages: { value: ["common", "aB3cD9eF1gH2iJ4k"], custom: "Thieves' cant" },
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
assert.deepEqual(character.tools, ["thieves", "alchemist", "Dice set", "Playing cards"]);
|
||||
assert.deepEqual(
|
||||
character.languages,
|
||||
["common", "Thieves' cant"],
|
||||
"a language the sheet cannot name is dropped rather than shown as a document id"
|
||||
);
|
||||
|
||||
const none = foundryActorToCharacter({ name: "Thalia", system: { traits: { tool: { value: [] } } } });
|
||||
assert.deepEqual(none.tools, [], "a world with no tool proficiency says so");
|
||||
assert.ok(!("languages" in none), "and says nothing at all about the ones it does not list");
|
||||
});
|
||||
|
||||
test("the coins of the world are the coins of the campaign", () => {
|
||||
const character = foundryActorToCharacter({ name: "Thalia", system: { currency: { pp: 1, gp: 25, sp: -3 } } });
|
||||
|
||||
assert.deepEqual(character.currency, { pp: 1, gp: 25, ep: 0, sp: 0, cp: 0 }, "and never a debt");
|
||||
});
|
||||
|
||||
test("a carried item brings its own icon", () => {
|
||||
const character = foundryActorToCharacter({
|
||||
name: "Thalia",
|
||||
items: [
|
||||
{ name: "Longsword", type: "weapon", img: "http://vtt.test/icons/sword.svg", system: { quantity: 1, weight: { value: 3 } } },
|
||||
{ name: "Rope", type: "equipment", system: { quantity: 2 } },
|
||||
],
|
||||
});
|
||||
|
||||
assert.deepEqual(character.inventory, [
|
||||
{ name: "Longsword", quantity: 1, weight: 3, icon: "http://vtt.test/icons/sword.svg" },
|
||||
{ name: "Rope", quantity: 2, weight: 0, icon: "" },
|
||||
]);
|
||||
});
|
||||
|
||||
// --- The traits tab syncs --------------------------------------------------------
|
||||
|
||||
test("the world's own traits reach the campaign", () => {
|
||||
const fromText = foundryActorToCharacter({ name: "Thalia", system: { details: { trait: "Spellcaster.<br>Light sleeper." } } });
|
||||
assert.equal(fromText.traits, "Spellcaster.\nLight sleeper.");
|
||||
|
||||
const fromFeatures = foundryActorToCharacter({
|
||||
name: "Thalia",
|
||||
system: {},
|
||||
items: [
|
||||
{ name: "Darkvision", type: "feat", system: { featType: "trs", description: { value: "<p>See in the dark.</p>" } } },
|
||||
{ name: "Brave", type: "feat", system: { featType: ["tr"], description: { value: "Advantage on saves." } } },
|
||||
{ name: "Alert", type: "feat", system: { featType: "feat", description: { value: "Never surprised." } } },
|
||||
],
|
||||
});
|
||||
assert.equal(fromFeatures.traits, "Darkvision\nSee in the dark.\n\nBrave\nAdvantage on saves.");
|
||||
});
|
||||
|
||||
test("the world leads the traits tab, and what the campaign wrote fills in when it has none", () => {
|
||||
// The module carries whatever the campaign shows for the traits back to the world on
|
||||
// its flag, and the actor's own traits lead from there: a world keeps its traits in
|
||||
// step the same way it keeps its proficiencies in step, while a character the world
|
||||
// says nothing about keeps what the campaign wrote for it.
|
||||
const fromWorld = foundryActorToCharacter({
|
||||
name: "Thalia",
|
||||
system: { details: { trait: "The world's own traits" } },
|
||||
flags: { [MODULE_ID]: { traits: "What the campaign typed" } },
|
||||
});
|
||||
assert.equal(fromWorld.traits, "The world's own traits");
|
||||
|
||||
const fromCampaign = foundryActorToCharacter({
|
||||
name: "Thalia",
|
||||
system: {},
|
||||
flags: { [MODULE_ID]: { traits: "What the campaign typed" } },
|
||||
});
|
||||
assert.equal(fromCampaign.traits, "What the campaign typed");
|
||||
});
|
||||
|
||||
test("an actor that holds no traits does not clear what the campaign has", () => {
|
||||
const character = foundryActorToCharacter({ name: "Thalia", system: {}, items: [], flags: {} });
|
||||
|
||||
assert.ok(!("traits" in character), "a live edit that knows nothing about traits leaves the tab as it is");
|
||||
});
|
||||
|
||||
// A forced actor sync from the module's context menu replaces everything the campaign
|
||||
// holds for that actor (Syndria98/dragonroll#96): the fields a live edit leaves out when
|
||||
// the world says nothing are written empty instead of kept, and the campaign's own text
|
||||
// on the actor's flag does not survive it.
|
||||
test("a forced sync writes empty the fields a live edit would leave out", () => {
|
||||
const actor = {
|
||||
name: "Thalia",
|
||||
system: {},
|
||||
items: [],
|
||||
flags: { [MODULE_ID]: { traits: "What the campaign typed", proficiencies: "Armour, tools" } },
|
||||
};
|
||||
|
||||
const live = foundryActorToCharacter(actor);
|
||||
assert.equal(live.traits, "What the campaign typed", "a live edit fills the traits tab from the actor's flag");
|
||||
assert.equal(live.proficiencies, "Armour, tools", "and the free-text proficiencies from it too");
|
||||
assert.ok(
|
||||
!("tools" in live) && !("languages" in live) && !("skills" in live) && !("savingThrows" in live) && !("currency" in live),
|
||||
"and says nothing about the toggles and lists the world has no data for"
|
||||
);
|
||||
|
||||
const replaced = foundryActorToCharacter(actor, true);
|
||||
assert.equal(replaced.traits, "", "a forced sync clears the traits the campaign typed");
|
||||
assert.equal(replaced.proficiencies, "", "down to the free-text proficiencies");
|
||||
assert.deepEqual(replaced.tools, []);
|
||||
assert.deepEqual(replaced.languages, []);
|
||||
assert.deepEqual(replaced.skills, {});
|
||||
assert.deepEqual(replaced.savingThrows, {});
|
||||
assert.deepEqual(replaced.currency, {});
|
||||
});
|
||||
|
||||
// --- The module sends the names a sheet outside Foundry can read -----------------
|
||||
|
||||
function makeWorld({ actor, config = {}, worldItems = [] }) {
|
||||
const state = { hooks: new Map(), requests: [], timers: new Map(), nextTimerId: 1 };
|
||||
const documents = [actor];
|
||||
const settingsStore = { autoSync: true, syncToken: "sync-token-1", dragonrollApiUrl: "http://backend.test:5000" };
|
||||
|
||||
const sandbox = {
|
||||
console: { log() {}, info() {}, warn() {}, error() {} },
|
||||
URL,
|
||||
CONFIG: config,
|
||||
window: { location: { origin: "http://vtt.test" } },
|
||||
ui: { notifications: { info() {}, warn() {}, error() {} } },
|
||||
Hooks: {
|
||||
once(name, fn) { state.hooks.set(name, [fn]); },
|
||||
on(name, fn) { state.hooks.set(name, [...(state.hooks.get(name) || []), fn]); },
|
||||
},
|
||||
setTimeout: (fn) => { const id = state.nextTimerId++; state.timers.set(id, { fn }); return id; },
|
||||
clearTimeout: (id) => state.timers.delete(id),
|
||||
setInterval: () => 0,
|
||||
clearInterval: () => {},
|
||||
fetch: async (url, options = {}) => {
|
||||
state.requests.push({ href: String(url), body: options.body ? JSON.parse(options.body) : null });
|
||||
return { ok: true, status: 200, json: async () => ({ status: "ok", actors: [], items: [] }) };
|
||||
},
|
||||
Actor: { async create() { return null; } },
|
||||
Item: { async create() { return null; } },
|
||||
};
|
||||
|
||||
sandbox.game = {
|
||||
user: { isGM: true },
|
||||
world: { id: "world-1", title: "Test World" },
|
||||
system: { id: "dnd5e" },
|
||||
modules: { get: () => ({}) },
|
||||
actors: { contents: documents, get: (id) => documents.find((document) => document.id === id) },
|
||||
items: { contents: worldItems, get: (id) => worldItems.find((document) => document.id === id) },
|
||||
folders: { contents: [], get: () => null },
|
||||
settings: {
|
||||
register(module, key, definition) {
|
||||
if (!(key in settingsStore)) settingsStore[key] = definition.default;
|
||||
},
|
||||
get(module, key) { return settingsStore[key]; },
|
||||
async set(module, key, value) { settingsStore[key] = value; },
|
||||
},
|
||||
};
|
||||
|
||||
vm.createContext(sandbox);
|
||||
vm.runInContext(read("dragonroll-foundry", "scripts", "api.js"), sandbox);
|
||||
|
||||
const drain = async () => { await new Promise((resolve) => setImmediate(resolve)); };
|
||||
state.fire = async (name, ...args) => {
|
||||
for (const handler of state.hooks.get(name) || []) await handler(...args);
|
||||
await drain();
|
||||
};
|
||||
state.runTimers = async () => {
|
||||
for (let round = 0; round < 6; round += 1) {
|
||||
const due = [...state.timers.values()];
|
||||
state.timers.clear();
|
||||
for (const timer of due) await timer.fn();
|
||||
await drain();
|
||||
}
|
||||
};
|
||||
// Only the pushes of an actor count here: the world start sends one, and what an
|
||||
// actor changed sends the next.
|
||||
state.actorPushes = () => state.requests
|
||||
.filter((request) => request.href.includes("foundry/sync/snapshot"))
|
||||
.map((request) => request.body.actors[0]);
|
||||
|
||||
return state;
|
||||
}
|
||||
|
||||
function makeStubActor(id, name, system = {}, items = []) {
|
||||
return {
|
||||
id,
|
||||
name,
|
||||
type: "character",
|
||||
documentName: "Actor",
|
||||
img: "icons/svg/mystery-man.svg",
|
||||
system,
|
||||
flags: {},
|
||||
items: { contents: items },
|
||||
getFlag(module, key) { return this.flags?.[module]?.[key]; },
|
||||
async update(data) { return data; },
|
||||
toObject() { return { _id: this.id, name: this.name, type: this.type, img: this.img, flags: this.flags, system: this.system }; },
|
||||
};
|
||||
}
|
||||
|
||||
// A world document of its own — a language since the third release of the system —
|
||||
// plain enough to serialize like any other item of the world.
|
||||
function makeWorldItem(id, name) {
|
||||
return {
|
||||
id,
|
||||
name,
|
||||
type: "loot",
|
||||
documentName: "Item",
|
||||
parent: null,
|
||||
folder: null,
|
||||
flags: {},
|
||||
system: {},
|
||||
getFlag() { return undefined; },
|
||||
toObject() { return { _id: this.id, name: this.name, type: this.type, flags: this.flags, system: this.system }; },
|
||||
};
|
||||
}
|
||||
|
||||
async function pushAfterEdit(actor, options) {
|
||||
const world = makeWorld(options);
|
||||
await world.fire("init");
|
||||
await world.fire("ready");
|
||||
await world.runTimers();
|
||||
await world.fire("updateActor", actor);
|
||||
await world.runTimers();
|
||||
return world.actorPushes().at(-1);
|
||||
}
|
||||
|
||||
test("the actor snapshot names the world's tools and languages", async () => {
|
||||
const actor = makeStubActor("actor-1", "Thalia", {
|
||||
traits: {
|
||||
tool: { value: ["thieves"], custom: "Dice set" },
|
||||
languages: { value: ["common", "lang-1"] },
|
||||
},
|
||||
});
|
||||
|
||||
const sent = await pushAfterEdit(actor, {
|
||||
config: {
|
||||
DND5E: {
|
||||
tools: { thieves: { label: "Thieves' tools" } },
|
||||
languages: { common: { name: "Common" } },
|
||||
},
|
||||
},
|
||||
worldItems: [makeWorldItem("lang-1", "Deep Speech")],
|
||||
});
|
||||
|
||||
assert.equal(sent._id, "actor-1", "the actor the world edited is the one that was sent");
|
||||
assert.deepEqual(sent.dragonroll.tools, ["Thieves' tools", "Dice set"]);
|
||||
assert.deepEqual(sent.dragonroll.languages, ["Common", "Deep Speech"]);
|
||||
});
|
||||
|
||||
test("an actor listing no tools or languages says nothing about them", async () => {
|
||||
const actor = makeStubActor("actor-1", "Grunt", { details: { level: 1 } });
|
||||
|
||||
const sent = await pushAfterEdit(actor, { config: { DND5E: { tools: { thieves: { label: "Thieves' tools" } } } } });
|
||||
|
||||
assert.equal(sent.dragonroll, undefined, "no dragonroll block is what tells the campaign nothing was said");
|
||||
});
|
||||
|
||||
// --- Every locale says it ------------------------------------------------------
|
||||
|
||||
test("every locale names the skills, the saving throws, the tools, the languages and the coins", () => {
|
||||
for (const locale of ["en", "es", "ca"]) {
|
||||
const sheet = JSON.parse(read("frontend", "i18n", "locales", locale, "campaigns.json"))["character-sheet"];
|
||||
for (const key of ["skills", "saving-throws", "tools", "languages", "currency", "item-icon"]) {
|
||||
assert.ok(sheet[key], `${locale} is missing campaigns.character-sheet.${key}`);
|
||||
}
|
||||
for (const [group, keys] of [["abilities", ["str", "dex", "con", "int", "wis", "cha"]], ["skill-names", skillKeys], ["currency-units", currencyUnits]]) {
|
||||
for (const key of keys) {
|
||||
assert.ok(sheet[group]?.[key], `${locale} is missing campaigns.character-sheet.${group}.${key}`);
|
||||
}
|
||||
}
|
||||
assert.deepEqual(Object.keys(sheet["skill-names"]).sort(), [...skillKeys].sort(), `${locale} names every skill the sheet lists`);
|
||||
assert.notEqual(sheet["skill-names"].acrobatics, "acrobatics", `${locale} spells the skill out, not its key`);
|
||||
}
|
||||
});
|
||||
111
tests/character-sheet-persistent-column.test.js
Normal file
111
tests/character-sheet-persistent-column.test.js
Normal file
@@ -0,0 +1,111 @@
|
||||
// Tests for Syndria98/dragonroll#91: the column that opens the character sheet — the portrait with
|
||||
// the armor class, the speed, the bonuses and both pools under it — stays on screen whoever's tab is
|
||||
// open, instead of being the ability scores tab's own content and disappearing when the sheet moves
|
||||
// to the inventory, the traits or the spells.
|
||||
//
|
||||
// The window is a `.vue` file and the repository root installs no dependencies for the frontend, so
|
||||
// the template and the styles are read out of the source the way tests/character-sheet-tabs.test.js
|
||||
// and tests/character-sheet-portrait-column.test.js read them.
|
||||
//
|
||||
// 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 template = /<template>([\s\S]*)<\/template>/.exec(sheetSource)?.[1] ?? "";
|
||||
const TAB_KEYS = ["abilities", "inventory", "traits", "spells"];
|
||||
|
||||
const COLUMN = '<div class="character-column">';
|
||||
|
||||
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;
|
||||
}
|
||||
|
||||
// The column, taken whole: it stands ahead of the tab bodies, which are its siblings.
|
||||
function characterColumn() {
|
||||
const start = template.indexOf(COLUMN);
|
||||
const end = template.indexOf('<main v-show="activeTab');
|
||||
assert.ok(start !== -1 && end > start, "expected the character column ahead of the tab bodies");
|
||||
return template.slice(start, end);
|
||||
}
|
||||
|
||||
// The classes wrapping a tag, worked out by walking the blocks of the template in order the way a
|
||||
// browser nests them, so a tab cannot hide the column by wrapping it.
|
||||
function ancestorsOf(needle) {
|
||||
const at = template.indexOf(needle);
|
||||
assert.ok(at !== -1, `expected ${needle} in the template`);
|
||||
const stack = [];
|
||||
for (const match of template.matchAll(/<(\/?)(div|main|section|header|nav)\b([^>]*)>/g)) {
|
||||
if (match.index > at) break;
|
||||
const [, closed, , attrs] = match;
|
||||
if (closed) stack.pop();
|
||||
else if (!attrs.trimEnd().endsWith("/")) {
|
||||
const classes = /\bclass="([^"]*)"/.exec(attrs);
|
||||
stack.push(classes ? classes[1].trim().split(/\s+/) : []);
|
||||
}
|
||||
}
|
||||
return stack.slice(0, -1).map((classes) => classes.join(" "));
|
||||
}
|
||||
|
||||
test("the character column belongs to no tab", () => {
|
||||
const column = characterColumn();
|
||||
assert.ok(column.includes('class="sheet-portrait"'), "the portrait is part of the column");
|
||||
assert.ok(column.includes('class="sheet-panel vitals-panel"'), "and so is the panel of readouts and bars");
|
||||
// Nothing toggles the column: no tab decides whether it shows.
|
||||
assert.doesNotMatch(column, /v-show=/, "the column never hides behind a tab");
|
||||
|
||||
for (const key of TAB_KEYS) {
|
||||
const body = tabBody(key);
|
||||
assert.doesNotMatch(body, /class="character-column"/, `the ${key} tab does not own the column`);
|
||||
assert.doesNotMatch(body, /sheet-portrait|vitals-panel/, `the ${key} tab does not hold the column's contents`);
|
||||
}
|
||||
});
|
||||
|
||||
test("the column and the tab that is open stand beside each other", () => {
|
||||
const columnWrappers = ancestorsOf(COLUMN);
|
||||
assert.equal(columnWrappers.at(-1), "sheet-layout", "the column stands in the sheet's own layout");
|
||||
for (const key of TAB_KEYS) {
|
||||
assert.deepEqual(
|
||||
ancestorsOf(`<main v-show="activeTab === '${key}'"`),
|
||||
columnWrappers,
|
||||
`the ${key} tab is a sibling of the column, so it is never wrapped around it`
|
||||
);
|
||||
}
|
||||
|
||||
const layout = /\.sheet-layout\s*\{[^}]*\}/.exec(sheetSource)?.[0] ?? "";
|
||||
assert.match(layout, /display:\s*grid/, "the layout puts the column and the open tab side by side");
|
||||
assert.match(
|
||||
layout,
|
||||
/grid-template-columns:\s*minmax\(200px,\s*34%\)\s+minmax\(0,\s*1fr\)/,
|
||||
"the character keeps its own column and the tab has all the room left"
|
||||
);
|
||||
const columnRule = /\.character-column\s*\{[^}]*\}/.exec(sheetSource)?.[0] ?? "";
|
||||
assert.match(columnRule, /grid-column:\s*1/, "the character stands in the first column");
|
||||
const bodyRule = /\.sheet-tab-body\s*\{[^}]*\}/.exec(sheetSource)?.[0] ?? "";
|
||||
assert.match(bodyRule, /grid-column:\s*2/, "the open tab takes the space beside it");
|
||||
assert.match(bodyRule, /grid-row:\s*1/, "and on the same row, so switching a tab leaves the column where it was");
|
||||
});
|
||||
|
||||
test("a narrow window stacks the column over the tab instead of hiding it", () => {
|
||||
const narrow = /@media \(max-width: 760px\)\s*\{([\s\S]*?)\n\}/.exec(sheetSource)?.[1] ?? "";
|
||||
assert.match(narrow, /\.sheet-layout\s*\{[^}]*grid-template-columns:\s*1fr/, "the two columns become one");
|
||||
assert.match(
|
||||
narrow,
|
||||
/\.character-column,\s*\.sheet-tab-body\s*\{[^}]*grid-column:\s*1 \/ -1;[^}]*grid-row:\s*auto/,
|
||||
"the column goes over the tab, it does not go away with it"
|
||||
);
|
||||
});
|
||||
|
||||
test("what stays on screen is what the sheet is read for", () => {
|
||||
const column = characterColumn();
|
||||
for (const key of ["armor-class", "speed", "proficiency-bonus", "initiative", "hit-points", "hit-dice"]) {
|
||||
assert.ok(column.includes(`campaigns.character-sheet.${key}`), `the ${key} stays visible from any tab`);
|
||||
}
|
||||
});
|
||||
@@ -34,11 +34,16 @@ function fromSource(source, pattern, locals = {}) {
|
||||
}
|
||||
|
||||
const abilityStats = fromSource(script, /const abilityStats = \[[\s\S]*?\];/);
|
||||
const normalizeActor = fromSource(script, /function normalizeActor\(actor\) \{[\s\S]*?\n\}/, { abilityStats });
|
||||
// #83 put the skills, the saving throws, the tools, the languages and the coins into the
|
||||
// sheet form, so reading that form out of the source reads their names along with it.
|
||||
const skillList = fromSource(script, /const skillList = \[[\s\S]*?\];/);
|
||||
const currencyUnits = fromSource(script, /const currencyUnits = \[[\s\S]*?\];/);
|
||||
const proficiencyText = fromSource(script, /function proficiencyText\(value\) \{[\s\S]*?\n\}/);
|
||||
const normalizeActor = fromSource(script, /function normalizeActor\(actor\) \{[\s\S]*?\n\}/, { abilityStats, skillList, currencyUnits, proficiencyText });
|
||||
const barPercent = fromSource(script, /function barPercent\(current, max\) \{[\s\S]*?\n\}/);
|
||||
const barPool = fromSource(actorRouteSource, /function barPool\(existing, value\) \{[\s\S]*?\n\}/);
|
||||
|
||||
// The column that opens the abilities tab: the portrait with everything under it.
|
||||
// The column that stands beside every tab: the portrait with everything under it.
|
||||
function portraitColumn() {
|
||||
const start = template.indexOf('<div class="character-column">');
|
||||
const end = template.indexOf('<section class="sheet-panel abilities-panel">');
|
||||
@@ -117,10 +122,14 @@ test("the initiative bonus is the modifier of dexterity", () => {
|
||||
/const initiativeBonus = computed\(\(\) => abilityModifier\(form\.value\.abilityScores\.dex\)\)/,
|
||||
"D&D counts initiative as the dexterity modifier while the character carries no extra bonus"
|
||||
);
|
||||
const abilityModifier = fromSource(script, /function abilityModifier\(score\) \{[\s\S]*?\n\}/);
|
||||
// #83 gave the helper an optional proficiency bonus, for the skills and the saving
|
||||
// throws the character is proficient with; the bare modifier is unchanged.
|
||||
const abilityModifier = fromSource(script, /function abilityModifier\(score[^{]*\) \{[\s\S]*?\n\}/);
|
||||
assert.equal(abilityModifier(16), "+3");
|
||||
assert.equal(abilityModifier(10), "+0", "the sheet writes a flat modifier with its sign, as the ability cards do");
|
||||
assert.equal(abilityModifier(9), "-1");
|
||||
assert.equal(abilityModifier(16, 3), "+6", "a proficient skill adds the proficiency bonus to its modifier");
|
||||
assert.equal(abilityModifier(8, 2), "+1", "and one below 10 counts its own negative modifier first");
|
||||
});
|
||||
|
||||
test("an actor carries its pools, and one without them starts on its level", () => {
|
||||
|
||||
@@ -53,7 +53,6 @@ function tabBody(key) {
|
||||
|
||||
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 proficiencies-panel"/, "the proficiencies ride with the ability scores");
|
||||
for (const other of ["inventory-panel", "traits-panel", "spells-panel"]) {
|
||||
@@ -63,7 +62,12 @@ test("every tab shows only its own content and hides the others", () => {
|
||||
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"/);
|
||||
}
|
||||
|
||||
// #91 took the character column out of the tabs: it stands beside every one of them, so no tab
|
||||
// body holds the portrait (see tests/character-sheet-persistent-column.test.js).
|
||||
for (const key of ["abilities", "inventory", "traits", "spells"]) {
|
||||
assert.doesNotMatch(tabBody(key), /class="sheet-portrait"/, `the portrait is not the ${key} tab's to hide`);
|
||||
}
|
||||
|
||||
// the panels are toggled, not unmounted, so editing on one tab and flipping away keeps the draft
|
||||
|
||||
525
tests/character-sheet-traits-items.test.js
Normal file
525
tests/character-sheet-traits-items.test.js
Normal file
@@ -0,0 +1,525 @@
|
||||
// Tests for Syndria98/dragonroll#89: on the character sheet traits and items were all
|
||||
// displayed together and the icons did not load. The world's mapper put every embedded
|
||||
// document that was not a class, subclass, background or spell into the character's
|
||||
// inventory — so its traits (feat items) and its species (the race item) stood in the
|
||||
// inventory list beside the gear, while the sheet already shows both in fields of their
|
||||
// own. And a world image that arrives as a Foundry path — the bridge's snapshot and older
|
||||
// modules send those, where the module sends absolute URLs — was read against Dragonroll's
|
||||
// uploads folder, where nothing of that name is, so nothing loaded.
|
||||
//
|
||||
// The mapper is plain CommonJS and is required for real. The writers run in a stubbed
|
||||
// `require` against fake models, like tests/foundry-force-import.test.js runs them. And
|
||||
// since the campaign's inventory no longer claims trait and species documents, the module
|
||||
// must stop deleting ones earlier syncs marked as its own: the Foundry module goes into a
|
||||
// `node:vm` context holding stubbed Foundry globals with fake timers, like
|
||||
// tests/foundry-actor-details.test.js, so what writing a character leaves behind is observable.
|
||||
//
|
||||
// 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 vm = require("node:vm");
|
||||
|
||||
const read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
|
||||
const repoRequire = (relative) => require(path.join(__dirname, "..", relative));
|
||||
const MODULE_ID = "dragonroll-foundry";
|
||||
|
||||
// --- What the world's mapper keeps where -------------------------------------------------
|
||||
|
||||
const { foundryActorToCharacter } = require(path.join(__dirname, "..", "backend", "src", "services", "actor-foundry.js"));
|
||||
|
||||
test("traits and species stand in their own fields, not among the carried items", () => {
|
||||
const character = foundryActorToCharacter({
|
||||
name: "Thalia",
|
||||
system: { details: {} },
|
||||
items: [
|
||||
{ name: "Longsword", type: "weapon", img: "http://vtt.test/icons/sword.svg", system: { quantity: 1, weight: { value: 3 } } },
|
||||
{ name: "Rope", type: "equipment", system: { quantity: 2 } },
|
||||
{ name: "Darkvision", type: "feat", system: { featType: "trs", description: { value: "<p>See in the dark.</p>" } } },
|
||||
{ name: "Human", type: "race" },
|
||||
{ name: "Spellbook", type: "spellbook" },
|
||||
{ name: "Magic Missile", type: "spell" },
|
||||
{ name: "Fighter", type: "class" },
|
||||
{ name: "Oracle", type: "subclass" },
|
||||
{ name: "Soldier", type: "background" },
|
||||
],
|
||||
});
|
||||
|
||||
assert.deepEqual(character.inventory.map((item) => item.name), ["Longsword", "Rope"],
|
||||
"the inventory holds what the character carries, and nothing else");
|
||||
assert.deepEqual(character.inventory[0],
|
||||
{ name: "Longsword", quantity: 1, weight: 3, icon: "http://vtt.test/icons/sword.svg" });
|
||||
assert.equal(character.traits, "Darkvision\nSee in the dark.", "the feat is read as a trait, where the sheet shows it");
|
||||
assert.equal(character.spells, "Magic Missile", "and the spell where its tab shows it");
|
||||
});
|
||||
|
||||
test("gear of a type the mapper has never seen is still carried", () => {
|
||||
const character = foundryActorToCharacter({
|
||||
name: "Thalia",
|
||||
items: [{ name: "Strange Relic", type: "loot", system: { quantity: 1 } }],
|
||||
});
|
||||
|
||||
assert.deepEqual(character.inventory.map((item) => item.name), ["Strange Relic"],
|
||||
"only the listed non-gear types are let out of the inventory");
|
||||
});
|
||||
|
||||
// --- The writers read a world's paths off the world's address ----------------------------
|
||||
|
||||
function mongooseQuery(value) {
|
||||
const result = {
|
||||
select: () => result,
|
||||
sort: () => result,
|
||||
limit: (count) => mongooseQuery(value.slice(0, count)),
|
||||
lean: () => Promise.resolve(value),
|
||||
then: (onFulfilled, onRejected) => Promise.resolve(value).then(onFulfilled, onRejected),
|
||||
};
|
||||
return result;
|
||||
}
|
||||
|
||||
// Enough of the query language the writers use: equality and $or.
|
||||
function matches(document, filter = {}) {
|
||||
return Object.entries(filter).every(([key, expected]) => {
|
||||
if (key === "$or") return expected.some((part) => matches(document, part));
|
||||
const value = document?.[key];
|
||||
if (expected && typeof expected === "object" && !Array.isArray(expected)) {
|
||||
return Object.entries(expected).every(([operator, wanted]) => {
|
||||
if (operator === "$exists") return (value !== undefined && value !== null) === wanted;
|
||||
throw new Error(`filter operator "${key}.${operator}" is not stubbed`);
|
||||
});
|
||||
}
|
||||
return String(value ?? "") === String(expected ?? "");
|
||||
});
|
||||
}
|
||||
|
||||
function fakeModel(table, seed = [], campaignId) {
|
||||
const rows = [];
|
||||
let counter = 0;
|
||||
|
||||
function Document(data = {}) {
|
||||
counter += 1;
|
||||
this._id = `${table}-${counter}`;
|
||||
this.isNew = true;
|
||||
this.foundryNames = [];
|
||||
Object.assign(this, data);
|
||||
}
|
||||
Document.prototype.save = async function save() {
|
||||
if (this.isNew) rows.push(this);
|
||||
this.isNew = false;
|
||||
return this;
|
||||
};
|
||||
Object.defineProperty(Document.prototype, "id", { get() { return this._id; } });
|
||||
|
||||
for (const data of seed) {
|
||||
const row = new Document({ campaign: campaignId, ...data });
|
||||
row.isNew = false;
|
||||
rows.push(row);
|
||||
}
|
||||
|
||||
const model = function Model(data) { return new Document(data); };
|
||||
model.rows = rows;
|
||||
model.findOne = async (filter) => rows.find((row) => matches(row, filter)) ?? null;
|
||||
model.find = (filter) => mongooseQuery(rows.filter((row) => matches(row, filter)));
|
||||
return model;
|
||||
}
|
||||
|
||||
// The sync writers against fake models. `settings` is what the campaign keeps — the world
|
||||
// address the icons are loaded from stands in it, as it does in the real one.
|
||||
function loadFoundryWriters({ seed = {}, settings } = {}) {
|
||||
const campaign = { _id: "campaign-1", id: "campaign-1", foundryWorldId: "world-1", ...(settings ? { settings } : {}) };
|
||||
const seeded = (rows = []) => rows.map((row) => ({ campaign: campaign._id, ...row }));
|
||||
const models = {
|
||||
"../models/Actor": fakeModel("actor", seeded(seed.actors)),
|
||||
"../models/Item": fakeModel("item", seeded(seed.items)),
|
||||
"../models/Folder": fakeModel("folder", seeded(seed.folders)),
|
||||
"../models/Note": fakeModel("note", seeded(seed.notes)),
|
||||
"../models/Map": fakeModel("map", seeded(seed.maps)),
|
||||
};
|
||||
|
||||
const requireStub = (id) => {
|
||||
if (id === "express") return { Router: () => ({ get: () => {}, post: () => {} }) };
|
||||
if (id.startsWith("node:")) return require(id);
|
||||
if (id === "mongoose") return { isValidObjectId: (value) => typeof value === "string" && value.length > 20 };
|
||||
if (id === "../models/Campaign") return { findOne: async () => campaign };
|
||||
if (id === "../services/actor-foundry") return repoRequire(path.join("backend", "src", "services", "actor-foundry.js"));
|
||||
if (id === "../services/item-foundry") return repoRequire(path.join("backend", "src", "services", "item-foundry.js"));
|
||||
if (id === "../services/foundry-icons") return repoRequire(path.join("backend", "src", "services", "foundry-icons.js"));
|
||||
if (id === "../services/map-foundry") return repoRequire(path.join("backend", "src", "services", "map-foundry.js"));
|
||||
if (models[id]) return models[id];
|
||||
throw new Error(`require("${id}") is not stubbed`);
|
||||
};
|
||||
|
||||
const moduleStub = { exports: {} };
|
||||
vm.compileFunction(read("backend", "src", "routes", "foundry-link.js"), ["require", "module", "exports"])(
|
||||
requireStub, moduleStub, moduleStub.exports
|
||||
);
|
||||
return { campaign, models, writers: moduleStub.exports };
|
||||
}
|
||||
|
||||
test("a world image that arrives as a path is stored as the address the sheet can load", async () => {
|
||||
const sync = loadFoundryWriters({ settings: { integrations: { foundryUrl: "http://vtt.test:30000/" } } });
|
||||
|
||||
await sync.writers.saveFoundryActor(sync.campaign, {
|
||||
_id: "actor-1",
|
||||
name: "Thalia",
|
||||
type: "character",
|
||||
img: "icons/actors/thalia.svg",
|
||||
items: [
|
||||
{ name: "Torch", type: "loot", img: "icons/tools/torch torch.svg", system: { quantity: 2 } },
|
||||
{ name: "Darkvision", type: "feat", img: "icons/svg/eye.svg" },
|
||||
],
|
||||
});
|
||||
|
||||
const actor = sync.models["../models/Actor"].rows[0];
|
||||
assert.equal(actor.image, "http://vtt.test:30000/icons/actors/thalia.svg", "the portrait is read off the world's address");
|
||||
assert.deepEqual(actor.inventory.map((item) => item.name), ["Torch"], "the feat is not carried into the inventory");
|
||||
assert.equal(actor.inventory[0].icon, "http://vtt.test:30000/icons/tools/torch%20torch.svg", "and the gear's icon is");
|
||||
});
|
||||
|
||||
test("the absolute addresses the module sends travel as they are", async () => {
|
||||
const sync = loadFoundryWriters({ settings: { integrations: { foundryUrl: "http://vtt.test:30000" } } });
|
||||
|
||||
await sync.writers.saveFoundryActor(sync.campaign, {
|
||||
_id: "actor-1",
|
||||
name: "Thalia",
|
||||
img: "http://elsewhere.test/portraits/thalia.png",
|
||||
items: [{ name: "Torch", type: "loot", img: "data:image/png;base64,TgA=" }],
|
||||
});
|
||||
|
||||
const actor = sync.models["../models/Actor"].rows[0];
|
||||
assert.equal(actor.image, "http://elsewhere.test/portraits/thalia.png");
|
||||
assert.equal(actor.inventory[0].icon, "data:image/png;base64,TgA=");
|
||||
});
|
||||
|
||||
test("a campaign with no world address keeps the path as it came", async () => {
|
||||
const sync = loadFoundryWriters();
|
||||
|
||||
await sync.writers.saveFoundryActor(sync.campaign, {
|
||||
_id: "actor-1", name: "Thalia", img: "icons/actors/thalia.svg",
|
||||
});
|
||||
|
||||
assert.equal(sync.models["../models/Actor"].rows[0].image, "icons/actors/thalia.svg",
|
||||
"with no world to read it against, nothing is invented for it");
|
||||
});
|
||||
|
||||
test("a world item's icon is read off the world's address the same way", async () => {
|
||||
const sync = loadFoundryWriters({ settings: { integrations: { foundryUrl: "http://vtt.test:30000" } } });
|
||||
|
||||
await sync.writers.saveFoundryItem(sync.campaign, {
|
||||
_id: "item-1", name: "Longsword", type: "weapon", img: "icons/equipment/sword.svg",
|
||||
});
|
||||
|
||||
const item = sync.models["../models/Item"].rows[0];
|
||||
assert.equal(item.image, "http://vtt.test:30000/icons/equipment/sword.svg");
|
||||
assert.equal(item.foundryImage, "http://vtt.test:30000/icons/equipment/sword.svg",
|
||||
"the icon the item window offers back is the loadable one too");
|
||||
});
|
||||
|
||||
// --- The module leaves the world's own documents alone ------------------------------------
|
||||
|
||||
function makeStubItem(id, { name, type, system = {}, flags = {} }) {
|
||||
return {
|
||||
_id: id,
|
||||
id,
|
||||
name,
|
||||
type,
|
||||
system,
|
||||
flags,
|
||||
parent: { documentName: "Actor" },
|
||||
getFlag(module, key) { return this.flags?.[module]?.[key]; },
|
||||
toObject() {
|
||||
return { _id: this.id, name: this.name, type: this.type, system: this.system, flags: this.flags };
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
function writeDotted(target, data) {
|
||||
for (const [key, value] of Object.entries(data)) {
|
||||
const parts = key.split(".");
|
||||
const last = parts.pop();
|
||||
let node = target;
|
||||
for (const part of parts) node = node[part] ??= {};
|
||||
node[last] = value;
|
||||
}
|
||||
}
|
||||
|
||||
let stubCounter = 0;
|
||||
|
||||
function makeStubActor(name, { type = "character", system = {}, flags = {}, items = [] } = {}) {
|
||||
stubCounter += 1;
|
||||
const id = `actor-${stubCounter}`;
|
||||
const contents = items.map((item, index) => makeStubItem(item._id || `embedded-${stubCounter}-${index}`, item));
|
||||
const actor = {
|
||||
id,
|
||||
name,
|
||||
type,
|
||||
documentName: "Actor",
|
||||
img: "icons/svg/mystery-man.svg",
|
||||
system,
|
||||
flags,
|
||||
items: { contents },
|
||||
getFlag(module, key) { return this.flags?.[module]?.[key]; },
|
||||
async update(data) {
|
||||
writeDotted(this, data);
|
||||
return this;
|
||||
},
|
||||
async updateEmbeddedDocuments(documentName, updates) {
|
||||
for (const update of updates) {
|
||||
const item = contents.find((candidate) => candidate.id === update._id);
|
||||
if (item) writeDotted(item, update);
|
||||
}
|
||||
return updates.map((update) => contents.find((candidate) => candidate.id === update._id));
|
||||
},
|
||||
async createEmbeddedDocuments(documentName, datas) {
|
||||
const created = datas.map((data) => {
|
||||
const item = makeStubItem(`embedded-${stubCounter}-${contents.length}`, data);
|
||||
contents.push(item);
|
||||
return item;
|
||||
});
|
||||
return created;
|
||||
},
|
||||
async deleteEmbeddedDocuments(documentName, ids) {
|
||||
for (const id of ids) {
|
||||
const index = contents.findIndex((item) => item.id === id);
|
||||
if (index >= 0) contents.splice(index, 1);
|
||||
}
|
||||
return ids;
|
||||
},
|
||||
toObject() {
|
||||
return {
|
||||
_id: this.id,
|
||||
name: this.name,
|
||||
type: this.type,
|
||||
img: this.img,
|
||||
flags: this.flags,
|
||||
system: this.system,
|
||||
};
|
||||
},
|
||||
};
|
||||
return actor;
|
||||
}
|
||||
|
||||
function makeWorld({ actors = [], remoteActors = [] } = {}) {
|
||||
const state = {
|
||||
hooks: new Map(),
|
||||
registered: new Map(),
|
||||
requests: [],
|
||||
timers: new Map(),
|
||||
nextTimerId: 1,
|
||||
logs: [],
|
||||
};
|
||||
|
||||
const settingsStore = { autoSync: true, syncToken: "sync-token-1", dragonrollApiUrl: "http://backend.test:5000" };
|
||||
const sandbox = {
|
||||
console: {
|
||||
log() {},
|
||||
info() {},
|
||||
warn: (...args) => state.logs.push(args.map(String).join(" ")),
|
||||
error: (...args) => state.logs.push(args.map(String).join(" ")),
|
||||
},
|
||||
URL,
|
||||
CONFIG: {},
|
||||
window: { location: { origin: "http://vtt.test" } },
|
||||
ui: { notifications: { info() {}, warn() {}, error() {} } },
|
||||
Hooks: {
|
||||
once(name, fn) { state.hooks.set(name, [fn]); },
|
||||
on(name, fn) { state.hooks.set(name, [...(state.hooks.get(name) || []), fn]); },
|
||||
},
|
||||
setTimeout: (fn, delay = 0) => {
|
||||
const timerId = state.nextTimerId++;
|
||||
state.timers.set(timerId, { fn, delay });
|
||||
return timerId;
|
||||
},
|
||||
clearTimeout: (timerId) => state.timers.delete(timerId),
|
||||
setInterval: () => 0,
|
||||
clearInterval: () => {},
|
||||
fetch: async (url, options = {}) => {
|
||||
const href = String(url);
|
||||
state.requests.push({ href, method: options.method, body: options.body ? JSON.parse(options.body) : null });
|
||||
if (href.includes("foundry/sync/characters")) return { ok: true, status: 200, json: async () => ({ status: "ok", actors: remoteActors }) };
|
||||
if (href.includes("foundry/sync/items")) return { ok: true, status: 200, json: async () => ({ status: "ok", items: [] }) };
|
||||
return { ok: true, status: 200, json: async () => ({ status: "ok", actors: [], items: [] }) };
|
||||
},
|
||||
Item: { async create() { return null; } },
|
||||
Actor: {
|
||||
async create(data) {
|
||||
const actor = makeStubActor(data.name, {
|
||||
type: data.type,
|
||||
system: structuredClone(data.system || {}),
|
||||
flags: structuredClone(data.flags || {}),
|
||||
items: (data.items || []).map((item) => ({ name: item.name, type: item.type, system: item.system })),
|
||||
});
|
||||
actors.push(actor);
|
||||
return actor;
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
sandbox.game = {
|
||||
user: { isGM: true },
|
||||
world: { id: "world-1", title: "Test World" },
|
||||
system: { id: "dnd5e" },
|
||||
modules: { get: () => ({}) },
|
||||
actors: { contents: actors, get: (actorId) => actors.find((actor) => actor.id === actorId) },
|
||||
items: { contents: [], get: () => null },
|
||||
folders: { contents: [], get: () => null },
|
||||
settings: {
|
||||
register(module, key, definition) {
|
||||
state.registered.set(key, definition);
|
||||
if (!(key in settingsStore)) settingsStore[key] = definition.default;
|
||||
},
|
||||
get(module, key) { return settingsStore[key]; },
|
||||
async set(module, key, value) {
|
||||
settingsStore[key] = value;
|
||||
await state.registered.get(key)?.onChange?.(value);
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
vm.createContext(sandbox);
|
||||
vm.runInContext(read("dragonroll-foundry", "scripts", "api.js"), sandbox);
|
||||
|
||||
state.game = sandbox.game;
|
||||
const drain = async () => { await new Promise((resolve) => setImmediate(resolve)); };
|
||||
|
||||
// World start: the actors are pushed, then the campaign's characters are applied.
|
||||
state.start = async () => {
|
||||
await state.fire("init");
|
||||
await state.fire("ready");
|
||||
await state.runTimers();
|
||||
return state;
|
||||
};
|
||||
|
||||
state.fire = async (name, ...args) => {
|
||||
for (const handler of state.hooks.get(name) || []) await handler(...args);
|
||||
await drain();
|
||||
};
|
||||
state.runTimers = async () => {
|
||||
for (let round = 0; round < 6; round += 1) {
|
||||
if (!state.timers.size && round > 2) break;
|
||||
const due = [...state.timers.values()];
|
||||
state.timers.clear();
|
||||
for (const timer of due) await timer.fn();
|
||||
await drain();
|
||||
}
|
||||
};
|
||||
state.itemNames = (actor) => actor.items.contents.map((item) => [item.type, item.name]);
|
||||
state.actorPushes = () => state.requests
|
||||
.filter((request) => request.href.includes("foundry/sync/snapshot"))
|
||||
.map((request) => request.body.actors[0]);
|
||||
|
||||
return state;
|
||||
}
|
||||
|
||||
// The campaign's character for `actor`, holding what Dragonroll keeps for it.
|
||||
function campaignCharacter(actor, over = {}) {
|
||||
return {
|
||||
_id: "dr-actor-1",
|
||||
name: "Thalia",
|
||||
type: "character",
|
||||
species: "",
|
||||
className: "",
|
||||
subclass: "",
|
||||
level: 1,
|
||||
background: "",
|
||||
challengeRating: "",
|
||||
description: "",
|
||||
image: "",
|
||||
abilityScores: {},
|
||||
armorClass: 10,
|
||||
speed: 30,
|
||||
traits: "",
|
||||
proficiencies: "",
|
||||
spells: "",
|
||||
inventory: [],
|
||||
foundryActorId: actor?.id ?? null,
|
||||
...over,
|
||||
};
|
||||
}
|
||||
|
||||
test("a trait row an older campaign left in the inventory does not become a loot duplicate", async () => {
|
||||
// A campaign that synced before #89 still carries its world's traits as inventory
|
||||
// rows. Writing the character must neither make a piece of loot after a trait's name
|
||||
// nor touch the world's feat it holds that name — the row is the campaign's to write
|
||||
// off, and the document is the world's to keep.
|
||||
const actor = makeStubActor("Thalia", {
|
||||
system: { details: {} },
|
||||
flags: { [MODULE_ID]: { actorId: "dr-actor-1" } },
|
||||
items: [{ _id: "feat-1", name: "Darkvision", type: "feat", system: { featType: "trs" } }],
|
||||
});
|
||||
const world = await makeWorld({
|
||||
actors: [actor],
|
||||
remoteActors: [campaignCharacter(actor, {
|
||||
traits: "Darkvision\nSee in the dark.",
|
||||
inventory: [{ name: "Darkvision", quantity: 1, weight: 0 }],
|
||||
})],
|
||||
}).start();
|
||||
|
||||
assert.deepEqual(world.itemNames(actor), [["feat", "Darkvision"]],
|
||||
"no gear made after the trait's name, and the feat stands where it was");
|
||||
assert.equal(actor.items.contents[0].system.quantity, undefined, "the world's feat is not written as gear");
|
||||
assert.deepEqual(world.logs, [], "applying the character did not warn");
|
||||
});
|
||||
|
||||
test("writing the character leaves the world's trait and species documents where they stand", async () => {
|
||||
// An earlier sync marked everything in the actor as its own. The campaign no longer
|
||||
// carries traits and species in the inventory, so those marks must not cost the world
|
||||
// its documents — while loot the campaign truly dropped still goes.
|
||||
const actor = makeStubActor("Thalia", {
|
||||
system: { details: {} },
|
||||
flags: { [MODULE_ID]: { actorId: "dr-actor-1" } },
|
||||
items: [
|
||||
{ _id: "feat-1", name: "Darkvision", type: "feat", flags: { [MODULE_ID]: { syncedItem: true } } },
|
||||
{ _id: "race-1", name: "Human", type: "race", flags: { [MODULE_ID]: { syncedItem: true } } },
|
||||
{ _id: "loot-old", name: "Torch", type: "loot", flags: { [MODULE_ID]: { syncedItem: true } } },
|
||||
],
|
||||
});
|
||||
const world = await makeWorld({
|
||||
actors: [actor],
|
||||
remoteActors: [campaignCharacter(actor, {
|
||||
species: "Human",
|
||||
traits: "Darkvision\nSee in the dark.",
|
||||
inventory: [{ name: "Rations", quantity: 1, weight: 0.5 }],
|
||||
})],
|
||||
}).start();
|
||||
|
||||
assert.deepEqual(world.itemNames(actor), [
|
||||
["feat", "Darkvision"],
|
||||
["race", "Human"],
|
||||
["loot", "Rations"],
|
||||
], "the trait and the species survive, the carried gear follows the campaign");
|
||||
assert.equal(actor.system.details.race, "race-1", "the species reference still resolves to the surviving item");
|
||||
assert.deepEqual(world.logs, [], "applying the character did not warn");
|
||||
});
|
||||
|
||||
test("the snapshot marks the carried gear and no longer the world's own documents", async () => {
|
||||
const actor = makeStubActor("Grimnir", {
|
||||
system: { details: {} },
|
||||
items: [
|
||||
{ name: "Longsword", type: "weapon" },
|
||||
{ name: "Darkvision", type: "feat" },
|
||||
{ name: "Giant", type: "race" },
|
||||
],
|
||||
});
|
||||
await makeWorld({ actors: [actor], remoteActors: [] }).start();
|
||||
|
||||
const [sword, feat, race] = actor.items.contents;
|
||||
assert.equal(sword.getFlag(MODULE_ID, "syncedItem"), true, "the gear the campaign carries is marked as its own");
|
||||
assert.equal(feat.getFlag(MODULE_ID, "syncedItem"), undefined, "a trait is not");
|
||||
assert.equal(race.getFlag(MODULE_ID, "syncedItem"), undefined, "neither is a species");
|
||||
});
|
||||
|
||||
test("an actor snapshot still sends the feats its traits are made of", async () => {
|
||||
// Leaving feats out of the inventory must not leave them out of the snapshot: they are
|
||||
// what the campaign's traits tab reads.
|
||||
const actor = makeStubActor("Thalia", {
|
||||
system: { details: {} },
|
||||
items: [{ name: "Darkvision", type: "feat", system: { featType: "trs" } }],
|
||||
});
|
||||
const world = await makeWorld({ actors: [actor], remoteActors: [] }).start();
|
||||
|
||||
const sent = world.actorPushes().at(-1);
|
||||
assert.deepEqual(sent.items.map((item) => [item.type, item.name]), [["feat", "Darkvision"]],
|
||||
"the feat still travels with its actor, as the traits text is read off it");
|
||||
});
|
||||
@@ -3,8 +3,10 @@
|
||||
// numbered group, translations for the group's label, and no link pointing at a page that does not
|
||||
// exist, (2) the page about an integration really documents what that integration offers, which is
|
||||
// checked against the sources that define it: the slash commands of discord-bot/src/commands.js and
|
||||
// the commands the Obsidian plugin registers, and (3) the routes: /docs and /docs/<slug> render the
|
||||
// documentation and every other address still opens the window app.
|
||||
// the commands the Obsidian plugin registers, (3) the routes: /docs and /docs/<slug> render the
|
||||
// documentation and every other address still opens the window app, and (4) inside a campaign the
|
||||
// same documentation opens as a window of its own instead of a trip to /docs
|
||||
// (Syndria98/dragonroll#95).
|
||||
//
|
||||
// `frontend/app/services/DocsMarkdown.js` is the pure part of the docs (headings, slugs, titles) and
|
||||
// is loaded straight from source, the way the other tests load the frontend services; it imports
|
||||
@@ -326,3 +328,237 @@ test("the main menu points at the documentation", () => {
|
||||
assert.ok(strings.documentation, `${locale} has no label for the documentation link`);
|
||||
}
|
||||
});
|
||||
|
||||
// Inside a campaign the documentation is reached from the top bar, on the left of the campaign
|
||||
// settings button (Syndria98/dragonroll#90), and it opens as a window of its own in front of the
|
||||
// workspace rather than as a trip to /docs (Syndria98/dragonroll#95).
|
||||
test("the campaign top bar opens the documentation as a window", () => {
|
||||
const topBar = readRepoFile("frontend", "app", "components", "viewer", "TopBar.vue");
|
||||
const right = /<div class="right">([\s\S]*?)<\/div>/.exec(topBar)?.[1];
|
||||
assert.ok(right, "expected the top bar to have its buttons in a right-hand group");
|
||||
|
||||
assert.match(right, /OpenDocumentation/, "the top bar has a button for the documentation");
|
||||
assert.match(right, /main-menu\.documentation/, "under the same label the main menu uses");
|
||||
assert.match(topBar, /CreateWindow\('documentation'\)/, "the button opens the documentation window");
|
||||
|
||||
// To the left of the settings button: the group is read left to right, so the button has to
|
||||
// come first in it.
|
||||
const docsAt = right.indexOf("OpenDocumentation");
|
||||
const settingsAt = right.indexOf("OpenCampaignSettings");
|
||||
assert.ok(
|
||||
docsAt !== -1 && settingsAt !== -1 && docsAt < settingsAt,
|
||||
"the documentation button sits on the left of the settings button"
|
||||
);
|
||||
|
||||
// The open notes of the campaign live only in memory, so nothing the top bar does may leave
|
||||
// the app: a window comes to the front, an address would take the campaign away with it.
|
||||
assert.doesNotMatch(topBar, /href="\/docs"/, "the top bar does not send the campaign to /docs");
|
||||
assert.doesNotMatch(topBar, /target="_blank"/, "…nor opens a tab out of it");
|
||||
});
|
||||
|
||||
// The window the button opens (Syndria98/dragonroll#95): registered like every other window, and
|
||||
// reading its pages without ever leaving the window it is drawn in.
|
||||
test("the documentation is registered as a window", () => {
|
||||
const definitions = readRepoFile("frontend", "app", "services", "WindowDefinitions.js");
|
||||
const definition = /\n\s*documentation:\s*\{([\s\S]*?)\n\s{2}\}/.exec(definitions);
|
||||
assert.ok(definition, "the documentation is not registered as a window");
|
||||
|
||||
assert.match(definition[1], /title:\s*'windows\.documentation'/, "its title is an i18n key");
|
||||
assert.match(definition[1], /movable:\s*true/);
|
||||
assert.match(definition[1], /close:\s*\(\)\s*=>\s*ClearWindow\(\{\s*type:\s*'documentation'\s*\}\)/);
|
||||
|
||||
const component = /component:\s*\(\)\s*=>\s*import\(['"]~\/components\/windows\/([^'"]+)['"]\)/.exec(definition[1]);
|
||||
assert.ok(component, "the documentation window names no component of its own");
|
||||
assert.ok(
|
||||
fs.existsSync(path.join(__dirname, "..", "frontend", "app", "components", "windows", component[1])),
|
||||
`the documentation window points at a component that does not exist: ${component[1]}`
|
||||
);
|
||||
});
|
||||
|
||||
test("the documentation window reads the published pages without leaving itself", () => {
|
||||
const source = readRepoFile("frontend", "app", "components", "windows", "DocumentationWindow.vue");
|
||||
|
||||
// The pages are the ones of app/content/docs, read through the same service the /docs page uses.
|
||||
assert.match(source, /from '~\/services\/Docs'/, "the window reads the documentation through the docs service");
|
||||
for (const lookup of ["GetDocsNav", "GetDocsPage", "GetDocsFirstSlug"]) {
|
||||
assert.match(source, new RegExp(lookup), `the window does not use ${lookup}`);
|
||||
}
|
||||
|
||||
// Resizable, with a floor low enough to read the two columns on a small screen.
|
||||
assert.match(source, /SetResizable\(id,\s*true\)/, "the window is resizable");
|
||||
assert.match(source, /SetMinSize\(id,\s*\{\s*width:\s*\d+,\s*height:\s*\d+\s*\}\)/, "…and it says how small it goes");
|
||||
|
||||
// Nothing in it is a route: the window holds the page it shows, so following the sidebar
|
||||
// leaves the campaign behind it exactly as it was.
|
||||
assert.doesNotMatch(source, /NuxtLink|useRoute|navigateTo/, "the documentation window does not navigate the app");
|
||||
|
||||
// Which means the links the markdown carries (`[Foundry](/docs/foundry)`) and the sections of
|
||||
// a page have to be answered inside the window.
|
||||
assert.match(source, /\\\/docs/, "the markdown's links to the other pages are followed in the window");
|
||||
assert.match(source, /scrollIntoView/, "so are the sections of the page it is showing");
|
||||
assert.match(source, /preventDefault/, "…and none of them reaches the app's address");
|
||||
|
||||
// A window is not a page: the reading column is what scrolls, nothing is as tall as the viewport.
|
||||
const reading = /\.docs-reading\s*\{[^}]*\}/.exec(source)?.[0];
|
||||
assert.ok(reading, "the window has a reading column of its own");
|
||||
assert.match(reading, /overflow-y:\s*auto/, "…and that is what scrolls");
|
||||
assert.doesNotMatch(source, /100vh/, "a window fills itself, not the viewport");
|
||||
});
|
||||
|
||||
test("the documentation window is titled in every locale", () => {
|
||||
for (const locale of ["en", "es", "ca"]) {
|
||||
const strings = JSON.parse(readRepoFile("frontend", "i18n", "locales", locale, "windows.json"));
|
||||
const title = strings.documentation;
|
||||
assert.ok(title, `${locale} has no title for the documentation window`);
|
||||
if (locale !== "en") {
|
||||
assert.notEqual(title.toLowerCase(), "documentation", `the ${locale} window title is untranslated`);
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
// --- How the documentation is laid out (Syndria98/dragonroll#85) ---
|
||||
|
||||
// The `<style>` of DocsView.vue read as `{ selector, media, declarations }` rules: the block is
|
||||
// flat — every rule is a top level selector and the only nesting is the media queries — so pairing
|
||||
// braces is enough, and the test does not need a stylesheet parser the repository root lacks.
|
||||
function DocsStyleRules() {
|
||||
const source = readRepoFile("frontend", "app", "components", "views", "DocsView.vue");
|
||||
const css = source
|
||||
.slice(source.indexOf(">", source.indexOf("<style")) + 1, source.indexOf("</style>"))
|
||||
.replace(/\/\*[\s\S]*?\*\//g, "");
|
||||
|
||||
const rules = [];
|
||||
|
||||
function scan(text, media) {
|
||||
let index = 0;
|
||||
for (;;) {
|
||||
const brace = text.indexOf("{", index);
|
||||
if (brace === -1) return rules;
|
||||
|
||||
const selector = text.slice(index, brace).trim();
|
||||
let depth = 1;
|
||||
let cursor = brace + 1;
|
||||
while (cursor < text.length && depth > 0) {
|
||||
if (text[cursor] === "{") depth += 1;
|
||||
else if (text[cursor] === "}") depth -= 1;
|
||||
cursor += 1;
|
||||
}
|
||||
|
||||
const body = text.slice(brace + 1, cursor - 1);
|
||||
if (selector.startsWith("@")) scan(body, selector);
|
||||
else rules.push({ selector, media, declarations: body });
|
||||
index = cursor;
|
||||
}
|
||||
}
|
||||
|
||||
return scan(css, null);
|
||||
}
|
||||
|
||||
const styleRules = DocsStyleRules();
|
||||
|
||||
// The rules that name a class, with `media` null for the plain ones and "min-width" / "max-width"
|
||||
// for the ones a media query switches on. The last one wins where they overlap, as in a stylesheet.
|
||||
function RulesFor(className, media = null) {
|
||||
return styleRules.filter((rule) =>
|
||||
rule.selector.split(",").some((name) => name.trim() === className) &&
|
||||
(media === null ? rule.media === null : Boolean(rule.media) && rule.media.includes(media))
|
||||
);
|
||||
}
|
||||
|
||||
// A `padding:` shorthand spread over its four sides, the way the browser reads it.
|
||||
function PaddingOf(rule) {
|
||||
const shorthand = rule.declarations.match(/(?:^|[;\s])padding:\s*([^;]+)/);
|
||||
assert.ok(shorthand, `the ${rule.selector} rule sets no padding to compare`);
|
||||
|
||||
const values = shorthand[1].trim().split(/\s+/).map((value) => parseFloat(value));
|
||||
assert.ok(
|
||||
values.length <= 4 && values.every((value) => Number.isFinite(value)),
|
||||
`only px padding is compared here, ${rule.selector} has "${shorthand[1].trim()}"`
|
||||
);
|
||||
|
||||
return {
|
||||
top: values[0],
|
||||
right: values[1] ?? values[0],
|
||||
bottom: values[2] ?? values[0],
|
||||
left: values[3] ?? values[1] ?? values[0],
|
||||
};
|
||||
}
|
||||
|
||||
test("the two asides are as tall as the page they stand beside", () => {
|
||||
for (const className of [".docs-sidebar", ".docs-sections"]) {
|
||||
const aside = RulesFor(className).find((rule) => /position:\s*sticky/.test(rule.declarations));
|
||||
assert.ok(aside, `${className} has to stay beside the text while the page scrolls`);
|
||||
assert.match(aside.declarations, /height:\s*100vh/, `${className} has to fill the page, not just its own contents`);
|
||||
assert.doesNotMatch(aside.declarations, /max-height/, `${className} is capped at a screen height by 'height'`);
|
||||
}
|
||||
});
|
||||
|
||||
test("a narrow window stacks the columns and lets each one be its own height", () => {
|
||||
const stacked = RulesFor(".docs-sidebar", "max-width");
|
||||
assert.equal(stacked.length, 1, "the stacked layout is set by one rule");
|
||||
assert.match(stacked[0].declarations, /position:\s*static/, "a stacked sidebar does not follow the scroll");
|
||||
assert.match(stacked[0].declarations, /height:\s*auto/, "…and it is not held at a screen height either");
|
||||
});
|
||||
|
||||
test("the reading column is centred in the space left beside the sidebar", () => {
|
||||
const reading = RulesFor(".docs-article").find((rule) => /max-width:/.test(rule.declarations));
|
||||
assert.ok(reading, "the text has to be capped in width to be readable");
|
||||
assert.match(reading.declarations, /margin-inline:\s*auto/, "…and centred in the space left beside the sidebar");
|
||||
assert.match(reading.selector, /\.docs-pager/, "the pager under the text follows the same column");
|
||||
});
|
||||
|
||||
test("a very wide window keeps the sections next to the text, not at the edge of the screen", () => {
|
||||
const centred = RulesFor(".docs", "min-width");
|
||||
assert.equal(centred.length, 1, "one wide window rule centres the documentation");
|
||||
assert.match(centred[0].declarations, /justify-content:\s*center/);
|
||||
|
||||
const wider = Number(centred[0].media.match(/min-width:\s*(\d+)/)[1]);
|
||||
assert.ok(wider >= 1400, `${wider}px is not a wide window: the layout breaks before that`);
|
||||
|
||||
const main = RulesFor(".docs-main", "min-width");
|
||||
assert.equal(main.length, 1, "the main column is capped once the window is wide");
|
||||
assert.match(main[0].declarations, /flex:\s*0 1 \d+px/, "…so it stops growing and the sections sit next to it");
|
||||
});
|
||||
|
||||
test("the sections aside has more room around its links than the sidebar has", () => {
|
||||
const shared = RulesFor(".docs-sidebar").find((rule) => /padding:/.test(rule.declarations));
|
||||
const sections = RulesFor(".docs-sections").filter((rule) => /padding:/.test(rule.declarations)).pop();
|
||||
assert.ok(sections && sections !== shared, "the sections aside sets its own padding");
|
||||
|
||||
const room = PaddingOf(sections);
|
||||
const sidebar = PaddingOf(shared);
|
||||
|
||||
for (const side of ["top", "right", "bottom", "left"]) {
|
||||
assert.ok(room[side] >= sidebar[side], `the sections aside is tighter than the sidebar on the ${side}`);
|
||||
}
|
||||
assert.ok(
|
||||
["top", "right", "bottom", "left"].some((side) => room[side] > sidebar[side]),
|
||||
"the sections aside asks for more padding than the two asides share"
|
||||
);
|
||||
});
|
||||
|
||||
// The /docs page and the documentation window render the very same HTML, so the markdown it renders
|
||||
// is styled once, in the stylesheet both of them load, rather than in whichever one asked for it
|
||||
// first (Syndria98/dragonroll#95).
|
||||
test("the rendered markdown is styled once, where both readers reach it", () => {
|
||||
const styles = readRepoFile("frontend", "app", "assets", "css", "main.scss");
|
||||
const markdown = styles.slice(styles.indexOf(".docs-markdown h1"));
|
||||
|
||||
for (const selector of [
|
||||
".docs-markdown h1",
|
||||
".docs-markdown h2",
|
||||
".docs-markdown h3",
|
||||
".docs-markdown p",
|
||||
".docs-markdown a",
|
||||
".docs-markdown code",
|
||||
".docs-markdown pre",
|
||||
".docs-markdown table",
|
||||
]) {
|
||||
assert.ok(markdown.includes(selector), `${selector} has to be styled for both readers of the docs`);
|
||||
}
|
||||
|
||||
// Theme colours, as everywhere: the window and the page are read on either theme.
|
||||
for (const colour of ["var\\(--color-border\\)", "var\\(--color-link\\)", "var\\(--color-background-light\\)"]) {
|
||||
assert.match(markdown, new RegExp(colour), "the markdown's look uses the theme's colours");
|
||||
}
|
||||
});
|
||||
|
||||
@@ -271,6 +271,8 @@ function loadFoundryWriters({ seed = {} } = {}) {
|
||||
"../models/Actor": fakeModel("actor", seeded(seed.actors)),
|
||||
"../models/Item": fakeModel("item", seeded(seed.items)),
|
||||
"../models/Folder": fakeModel("folder", seeded(seed.folders)),
|
||||
"../models/Note": fakeModel("note", seeded(seed.notes)),
|
||||
"../models/Map": fakeModel("map", seeded(seed.maps)),
|
||||
};
|
||||
|
||||
const requireStub = (id) => {
|
||||
@@ -280,6 +282,8 @@ function loadFoundryWriters({ seed = {} } = {}) {
|
||||
if (id === "../models/Campaign") return { findOne: async () => campaign };
|
||||
if (id === "../services/actor-foundry") return repoRequire(path.join("backend", "src", "services", "actor-foundry.js"));
|
||||
if (id === "../services/item-foundry") return repoRequire(path.join("backend", "src", "services", "item-foundry.js"));
|
||||
if (id === "../services/foundry-icons") return repoRequire(path.join("backend", "src", "services", "foundry-icons.js"));
|
||||
if (id === "../services/map-foundry") return repoRequire(path.join("backend", "src", "services", "map-foundry.js"));
|
||||
if (models[id]) return models[id];
|
||||
throw new Error(`require("${id}") is not stubbed`);
|
||||
};
|
||||
@@ -327,6 +331,46 @@ test("an actor the world has never been seen as becomes one row, and the next im
|
||||
assert.equal(sync.models["../models/Actor"].rows[0].foundryActorId, "actor-9");
|
||||
});
|
||||
|
||||
// A forced sync from the module's context menu (Syndria98/dragonroll#96) replaces
|
||||
// everything the campaign holds for the actor; a live change is a merge and leaves the
|
||||
// fields the world says nothing about to the campaign.
|
||||
test("a forced actor sync clears what the campaign wrote; a live change keeps it", async () => {
|
||||
const sync = loadFoundryWriters({
|
||||
seed: { actors: [{
|
||||
_id: "actor-1",
|
||||
name: "Thalia",
|
||||
foundryActorId: "actor-1",
|
||||
traits: "A trait the campaign wrote",
|
||||
tools: ["Thieves' tools"],
|
||||
languages: ["Elvish"],
|
||||
skills: { perception: true },
|
||||
savingThrows: { dex: true },
|
||||
currency: { gp: 50 },
|
||||
}] },
|
||||
});
|
||||
// The world says nothing about any of those: the fields a live edit leaves out.
|
||||
const worldActor = { _id: "actor-1", name: "Thalia", type: "character", system: {} };
|
||||
|
||||
await sync.writers.saveFoundryActor(sync.campaign, worldActor, false, false);
|
||||
let row = sync.models["../models/Actor"].rows[0];
|
||||
assert.equal(row.traits, "A trait the campaign wrote", "a live push leaves what the campaign wrote alone");
|
||||
assert.deepEqual(row.tools, ["Thieves' tools"]);
|
||||
assert.deepEqual(row.languages, ["Elvish"]);
|
||||
assert.deepEqual(row.skills, { perception: true });
|
||||
assert.deepEqual(row.savingThrows, { dex: true });
|
||||
assert.deepEqual(row.currency, { gp: 50 });
|
||||
|
||||
await sync.writers.saveFoundryActor(sync.campaign, worldActor, false, true);
|
||||
row = sync.models["../models/Actor"].rows[0];
|
||||
assert.equal(row.name, "Thalia", "the actor is still the one the world sent");
|
||||
assert.equal(row.traits, "", "a forced sync clears the trait the campaign wrote");
|
||||
assert.deepEqual(row.tools, [], "and the tools, languages, skills, saving throws and coin it held");
|
||||
assert.deepEqual(row.languages, []);
|
||||
assert.deepEqual(row.skills, {});
|
||||
assert.deepEqual(row.savingThrows, {});
|
||||
assert.deepEqual(row.currency, {});
|
||||
});
|
||||
|
||||
test("a hand-made item folds into the import instead of doubling, and keeps being updated", async () => {
|
||||
const sync = loadFoundryWriters({
|
||||
seed: { items: [{ _id: "item-1", name: "Longsword", quantity: 1 }] },
|
||||
|
||||
605
tests/foundry-note-journal.test.js
Normal file
605
tests/foundry-note-journal.test.js
Normal file
@@ -0,0 +1,605 @@
|
||||
// Tests for the campaign's notes reaching the Foundry world as journal pages
|
||||
// (Syndria98/dragonroll#98): every Dragonroll note stands as a page of the one
|
||||
// journal the world calls "Dragonroll", written by the module and kept in step with
|
||||
// the campaign. The copy runs one way — notes are written in Dragonroll — so the
|
||||
// backend answers with the notes and remembers each note's page; the module reads
|
||||
// them, renders the markdown, and prunes the page of a note the campaign deleted.
|
||||
//
|
||||
// Both sides are loaded the way the other Foundry tests do it: the sync route runs
|
||||
// against a stubbed `require` (models answer with plain objects and a small filter
|
||||
// matcher), and the Foundry module is loaded into a `node:vm` context holding
|
||||
// stubbed Foundry globals (`game.journals` and `JournalEntry` included) with fake
|
||||
// timers, like tests/item-folder-sync.test.js.
|
||||
//
|
||||
// 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 vm = require("node:vm");
|
||||
|
||||
const MODULE_ID = "dragonroll-foundry";
|
||||
const read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
|
||||
const repoRequire = (relative) => require(path.join(__dirname, "..", relative));
|
||||
|
||||
// --- The sync route against stubbed models -------------------------------------
|
||||
|
||||
// A mongoose query answers whatever `await query` and `query.lean()` answer with, and
|
||||
// lets `select()`, `sort()` and `limit()` sit in between.
|
||||
function mongooseQuery(value) {
|
||||
const result = {
|
||||
select: () => result,
|
||||
sort: () => result,
|
||||
limit: (count) => mongooseQuery(value.slice(0, count)),
|
||||
lean: () => Promise.resolve(value),
|
||||
then: (onFulfilled, onRejected) => Promise.resolve(value).then(onFulfilled, onRejected),
|
||||
};
|
||||
return result;
|
||||
}
|
||||
|
||||
// Enough of the query language the note routes use: equality, $or, $in, $nin,
|
||||
// $exists, $ne. Anything else is a filter this test did not expect and says so.
|
||||
function matches(document, filter = {}) {
|
||||
return Object.entries(filter).every(([key, expected]) => {
|
||||
if (key === "$or") return expected.some((part) => matches(document, part));
|
||||
const value = document?.[key];
|
||||
if (expected && typeof expected === "object" && !Array.isArray(expected)) {
|
||||
return Object.entries(expected).every(([operator, wanted]) => {
|
||||
if (operator === "$exists") return (value !== undefined && value !== null) === wanted;
|
||||
if (operator === "$in") return wanted.some((entry) => String(value) === String(entry));
|
||||
if (operator === "$nin") return !wanted.some((entry) => String(value) === String(entry));
|
||||
if (operator === "$ne") return String(value ?? "") !== String(wanted ?? "");
|
||||
throw new Error(`filter operator "${key}.${operator}" is not stubbed`);
|
||||
});
|
||||
}
|
||||
return String(value ?? "") === String(expected ?? "");
|
||||
});
|
||||
}
|
||||
|
||||
function fakeModel(table, seed = [], campaignId) {
|
||||
const rows = [];
|
||||
let counter = 0;
|
||||
|
||||
function Document(data = {}) {
|
||||
counter += 1;
|
||||
this._id = `${table}-${counter}`;
|
||||
this.isNew = true;
|
||||
this.foundryNames = [];
|
||||
Object.assign(this, data);
|
||||
}
|
||||
Document.prototype.save = async function save() {
|
||||
if (this.isNew) rows.push(this);
|
||||
this.isNew = false;
|
||||
return this;
|
||||
};
|
||||
Object.defineProperty(Document.prototype, "id", { get() { return this._id; } });
|
||||
|
||||
for (const data of seed) {
|
||||
// A seeded row belongs to the campaign the requests are made against unless the
|
||||
// seed says otherwise: the routes scope every lookup by campaign.
|
||||
const row = new Document({ campaign: campaignId, ...data });
|
||||
row.isNew = false;
|
||||
rows.push(row);
|
||||
}
|
||||
|
||||
const model = function Model(data) { return new Document(data); };
|
||||
model.rows = rows;
|
||||
model.findOne = async (filter) => rows.find((row) => matches(row, filter)) ?? null;
|
||||
model.find = (filter) => mongooseQuery(rows.filter((row) => matches(row, filter)));
|
||||
model.deleteOne = async (filter) => {
|
||||
const hit = rows.filter((row) => matches(row, filter));
|
||||
for (const row of hit) rows.splice(rows.indexOf(row), 1);
|
||||
return { deletedCount: hit.length };
|
||||
};
|
||||
model.deleteMany = async (filter) => {
|
||||
const hit = rows.filter((row) => matches(row, filter));
|
||||
for (const row of hit) rows.splice(rows.indexOf(row), 1);
|
||||
return { deletedCount: hit.length };
|
||||
};
|
||||
model.updateMany = async (filter, update) => {
|
||||
const hit = rows.filter((row) => matches(row, filter));
|
||||
for (const row of hit) Object.assign(row, update.$set ?? {});
|
||||
return { modifiedCount: hit.length };
|
||||
};
|
||||
return model;
|
||||
}
|
||||
|
||||
// The Foundry sync route with every model it requires stubbed. `seed` pre-fills the
|
||||
// tables with documents the campaign already holds.
|
||||
function loadSyncRoute({ seed = {}, worldId = "world-1" } = {}) {
|
||||
const routes = new Map();
|
||||
const router = {
|
||||
get: (route, ...handlers) => routes.set(`GET ${route}`, handlers),
|
||||
post: (route, ...handlers) => routes.set(`POST ${route}`, handlers),
|
||||
};
|
||||
const campaign = { _id: "campaign-1", id: "campaign-1", name: "Test Campaign", foundryWorldId: worldId };
|
||||
const seeded = (rows = []) => rows.map((row) => ({ campaign: campaign._id, ...row }));
|
||||
const models = {
|
||||
"../models/Actor": fakeModel("actor", seeded(seed.actors)),
|
||||
"../models/Item": fakeModel("item", seeded(seed.items)),
|
||||
"../models/Folder": fakeModel("folder", seeded(seed.folders)),
|
||||
"../models/Note": fakeModel("note", seeded(seed.notes)),
|
||||
"../models/Map": fakeModel("map", seeded(seed.maps)),
|
||||
};
|
||||
|
||||
const requireStub = (id) => {
|
||||
if (id === "express") return { Router: () => router };
|
||||
if (id.startsWith("node:")) return require(id); // crypto: the sync token is hashed, not stubbed
|
||||
if (id === "mongoose") return { isValidObjectId: (value) => typeof value === "string" && value.length > 20 };
|
||||
if (id === "../models/Campaign") return { findOne: async () => campaign };
|
||||
if (id === "../services/actor-foundry") return { foundryActorToCharacter: (actor) => ({ name: actor?.name ?? "" }) };
|
||||
if (id === "../services/item-foundry") return repoRequire(path.join("backend", "src", "services", "item-foundry.js"));
|
||||
if (id === "../services/foundry-icons") return repoRequire(path.join("backend", "src", "services", "foundry-icons.js"));
|
||||
if (id === "../services/map-foundry") return repoRequire(path.join("backend", "src", "services", "map-foundry.js"));
|
||||
if (models[id]) return models[id];
|
||||
throw new Error(`require("${id}") is not stubbed`);
|
||||
};
|
||||
|
||||
const moduleStub = { exports: {} };
|
||||
vm.compileFunction(read("backend", "src", "routes", "foundry-link.js"), ["require", "module", "exports"])(
|
||||
requireStub, moduleStub, moduleStub.exports
|
||||
);
|
||||
|
||||
async function call(route, body = {}) {
|
||||
const handlers = routes.get(route);
|
||||
assert.ok(handlers, `${route} is not mounted`);
|
||||
const res = { payload: null, json(payload) { this.payload = payload; }, set: () => {} };
|
||||
const req = { body, get: (name) => (String(name).toLowerCase() === "authorization" ? "Bearer sync-token" : "") };
|
||||
await handlers[handlers.length - 1](req, res);
|
||||
return res.payload;
|
||||
}
|
||||
|
||||
return { call, models, campaign };
|
||||
}
|
||||
|
||||
// --- The sync route: the notes it answers and the page ids it keeps ---------------
|
||||
|
||||
test("the world reads the campaign's notes with their content and page mapping", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: {
|
||||
notes: [
|
||||
{ _id: "note-1", title: "Session 1", content: "**The start**", foundryPageId: "page-9" },
|
||||
{ _id: "note-2", title: "Tavern Brawl", content: "- rope" },
|
||||
],
|
||||
},
|
||||
});
|
||||
|
||||
const response = await sync.call("GET /sync/notes");
|
||||
|
||||
assert.equal(response.status, "ok");
|
||||
assert.deepEqual(response.notes.map((note) => note.title), ["Session 1", "Tavern Brawl"]);
|
||||
assert.equal(response.notes[0].content, "**The start**", "the markdown source travels: the module renders it");
|
||||
assert.equal(response.notes[0].foundryPageId, "page-9", "and the note says which page it already stands as");
|
||||
});
|
||||
|
||||
test("mapping a note to the page the module made keeps them paired", async () => {
|
||||
const sync = loadSyncRoute({ seed: { notes: [{ _id: "note-1", title: "Session 1", content: "hi" }] } });
|
||||
|
||||
const response = await sync.call("POST /sync/map-note", {
|
||||
worldId: "world-1", noteId: "note-1", foundryPageId: "page-9",
|
||||
});
|
||||
|
||||
assert.equal(response.status, "ok");
|
||||
assert.equal(sync.models["../models/Note"].rows[0].foundryPageId, "page-9");
|
||||
|
||||
// Mapping the same pair again is the module checking, not a conflict.
|
||||
const again = await sync.call("POST /sync/map-note", {
|
||||
worldId: "world-1", noteId: "note-1", foundryPageId: "page-9",
|
||||
});
|
||||
assert.equal(again.status, "ok");
|
||||
});
|
||||
|
||||
test("a page already mapped to another note is refused", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: {
|
||||
notes: [
|
||||
{ _id: "note-1", title: "Session 1", content: "hi", foundryPageId: "page-9" },
|
||||
{ _id: "note-2", title: "Tavern Brawl", content: "ho" },
|
||||
],
|
||||
},
|
||||
});
|
||||
|
||||
const response = await sync.call("POST /sync/map-note", {
|
||||
worldId: "world-1", noteId: "note-2", foundryPageId: "page-9",
|
||||
});
|
||||
|
||||
assert.equal(response.status, "error");
|
||||
assert.equal(response.msg, "foundry.errors.note-already-synced");
|
||||
assert.equal(sync.models["../models/Note"].rows.find((row) => row._id === "note-2").foundryPageId, undefined,
|
||||
"the first note keeps its page");
|
||||
});
|
||||
|
||||
test("map-note wants this world's note and a page for it", async () => {
|
||||
const sync = loadSyncRoute({ seed: { notes: [{ _id: "note-1", title: "Session 1", content: "hi" }] } });
|
||||
|
||||
assert.equal((await sync.call("POST /sync/map-note", { worldId: "world-1" })).msg, "errors.missing-data");
|
||||
assert.equal((await sync.call("POST /sync/map-note", { noteId: "note-1", foundryPageId: "page-9" })).msg, "errors.missing-data",
|
||||
"another world cannot map this campaign's note");
|
||||
const gone = await sync.call("POST /sync/map-note", {
|
||||
worldId: "world-1", noteId: "note-gone", foundryPageId: "page-9",
|
||||
});
|
||||
assert.equal(gone.msg, "errors.notfound");
|
||||
});
|
||||
|
||||
// --- The Foundry module writes the journal ---------------------------------------
|
||||
|
||||
// Foundry's `update` takes dotted paths ("flags.dragonroll-foundry.noteId"); an
|
||||
// embedded document's own 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;
|
||||
}
|
||||
|
||||
function makeWorld({ markdown = true, keepCreateFlags = true, failMapNote = false } = {}) {
|
||||
const state = {
|
||||
hooks: new Map(),
|
||||
registered: new Map(),
|
||||
requests: [],
|
||||
timers: new Map(),
|
||||
intervals: new Map(),
|
||||
keepCreateFlags,
|
||||
failMapNote,
|
||||
// What Dragonroll answers the notes reconcile with. Mapping a page answers
|
||||
// like the real backend: the note keeps the page id, so later reads carry it.
|
||||
remoteNotes: [],
|
||||
nextId: 1,
|
||||
};
|
||||
|
||||
const journals = [];
|
||||
|
||||
const makePage = (journal, data = {}) => {
|
||||
const page = {
|
||||
id: `page-${state.nextId++}`,
|
||||
documentName: "JournalEntryPage",
|
||||
name: data.name,
|
||||
text: { content: data.text?.content ?? "" },
|
||||
flags: data.flags ?? {},
|
||||
writes: 0,
|
||||
getFlag(module, key) { return this.flags?.[module]?.[key]; },
|
||||
async update(update) {
|
||||
page.writes += 1;
|
||||
writeFoundryPaths(page, update);
|
||||
return page;
|
||||
},
|
||||
async delete() {
|
||||
const index = journal.pages.contents.indexOf(page);
|
||||
if (index >= 0) journal.pages.contents.splice(index, 1);
|
||||
},
|
||||
};
|
||||
return page;
|
||||
};
|
||||
|
||||
const makeJournal = (data = {}) => {
|
||||
const pages = [];
|
||||
return {
|
||||
id: `journal-${state.nextId++}`,
|
||||
name: data.name,
|
||||
documentName: "JournalEntry",
|
||||
flags: data.flags ?? {},
|
||||
getFlag(module, key) { return this.flags?.[module]?.[key]; },
|
||||
pages: { contents: pages, get: (id) => pages.find((page) => page.id === id) },
|
||||
async update(update) { return writeFoundryPaths(this, update); },
|
||||
async createEmbeddedDocuments(documentName, docs) {
|
||||
assert.equal(documentName, "JournalEntryPage", "the notes' pages are journal pages");
|
||||
// Foundry's own page validation refuses a page without a name.
|
||||
for (const doc of docs) assert.ok(doc.name, "a journal page needs a non-empty name");
|
||||
// A world that does not keep the flags a create was handed: the page
|
||||
// exists but carries no mark, which is what a lost pairing looks like.
|
||||
const created = docs.map((doc) => makePage(this, keepCreateFlags ? doc : { ...doc, flags: {} }));
|
||||
pages.push(...created);
|
||||
return created;
|
||||
},
|
||||
};
|
||||
};
|
||||
|
||||
const settingsStore = { autoSync: true, syncToken: "sync-token-1", dragonrollApiUrl: "http://backend.test:5000" };
|
||||
const sandbox = {
|
||||
console: { log() {}, info() {}, warn() {}, error() {} },
|
||||
URL,
|
||||
CONFIG: {},
|
||||
window: { location: { origin: "http://vtt.test" } },
|
||||
ui: { notifications: { info() {}, warn() {}, error() {} } },
|
||||
Hooks: {
|
||||
once(name, fn) { state.hooks.set(name, [fn]); },
|
||||
on(name, fn) { state.hooks.set(name, [...(state.hooks.get(name) || []), fn]); },
|
||||
},
|
||||
setTimeout: (fn, delay = 0) => {
|
||||
const id = state.nextId++;
|
||||
state.timers.set(id, { fn, delay });
|
||||
return id;
|
||||
},
|
||||
clearTimeout: (id) => state.timers.delete(id),
|
||||
setInterval: (fn, delay = 0) => {
|
||||
// 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.nextId++;
|
||||
state.intervals.set(id, { fn, delay });
|
||||
return id;
|
||||
},
|
||||
clearInterval: (id) => state.intervals.delete(id),
|
||||
fetch: async (url, options = {}) => {
|
||||
const href = String(url);
|
||||
const body = options.body ? JSON.parse(options.body) : null;
|
||||
state.requests.push({ href, method: options.method, body });
|
||||
if (href.includes("foundry/sync/map-note")) {
|
||||
if (state.failMapNote) return { ok: false, status: 500, json: async () => ({ status: "error", msg: "errors.internal" }) };
|
||||
const note = state.remoteNotes.find((entry) => String(entry._id) === String(body.noteId));
|
||||
if (note) note.foundryPageId = body.foundryPageId;
|
||||
return { ok: true, status: 200, json: async () => ({ status: "ok", note }) };
|
||||
}
|
||||
if (href.includes("foundry/sync/notes")) {
|
||||
return { ok: true, status: 200, json: async () => ({ status: "ok", notes: state.remoteNotes }) };
|
||||
}
|
||||
return { ok: true, status: 200, json: async () => ({ status: "ok", actors: [], items: [] }) };
|
||||
},
|
||||
Actor: { async create() { return null; } },
|
||||
Item: { async create() { return null; } },
|
||||
JournalEntry: {
|
||||
async create(data) {
|
||||
const journal = makeJournal(data);
|
||||
journals.push(journal);
|
||||
return [journal];
|
||||
},
|
||||
},
|
||||
};
|
||||
if (markdown) sandbox.TextEditor = { _getMarkdown: (md) => `<marked>${md}</marked>` };
|
||||
|
||||
sandbox.game = {
|
||||
user: { isGM: true },
|
||||
world: { id: "world-1", title: "Test World" },
|
||||
system: { id: "dnd5e" },
|
||||
modules: { get: () => ({}) },
|
||||
actors: { contents: [], get: () => null },
|
||||
items: { contents: [], get: () => null },
|
||||
folders: { contents: [], get: () => null },
|
||||
journals: { contents: journals, get: (id) => journals.find((journal) => journal.id === id) },
|
||||
settings: {
|
||||
register(module, key, definition) {
|
||||
state.registered.set(key, definition);
|
||||
if (!(key in settingsStore)) settingsStore[key] = definition.default;
|
||||
},
|
||||
get(module, key) { return settingsStore[key]; },
|
||||
async set(module, key, value) {
|
||||
settingsStore[key] = value;
|
||||
await state.registered.get(key)?.onChange?.(value);
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
vm.createContext(sandbox);
|
||||
vm.runInContext(read("dragonroll-foundry", "scripts", "api.js"), sandbox);
|
||||
|
||||
state.game = sandbox.game;
|
||||
state.journals = () => journals;
|
||||
state.addJournal = (name, flags = {}) => {
|
||||
const journal = makeJournal({ name, flags });
|
||||
journals.push(journal);
|
||||
return journal;
|
||||
};
|
||||
state.addPage = (journal, data) => {
|
||||
const page = makePage(journal, data);
|
||||
journal.pages.contents.push(page);
|
||||
return page;
|
||||
};
|
||||
state.mapNoteRequests = () => state.requests.filter((request) => request.href.includes("foundry/sync/map-note"));
|
||||
state.notesReads = () => state.requests.filter((request) => request.href.includes("foundry/sync/notes"));
|
||||
|
||||
const drain = async () => { await new Promise((resolve) => setImmediate(resolve)); };
|
||||
state.fire = async (name, ...args) => {
|
||||
for (const handler of state.hooks.get(name) || []) await handler(...args);
|
||||
await drain();
|
||||
};
|
||||
state.runTimers = async () => {
|
||||
for (let round = 0; round < 6; round += 1) {
|
||||
if (!state.timers.size && round > 2) break;
|
||||
const due = [...state.timers.values()];
|
||||
state.timers.clear();
|
||||
for (const timer of due) await timer.fn();
|
||||
await drain();
|
||||
}
|
||||
};
|
||||
// The reconciles `setInterval` registered: what runs every few seconds on a
|
||||
// linked world, and so what carries each note into its journal page.
|
||||
state.runIntervals = async () => {
|
||||
for (const interval of [...state.intervals.values()]) await interval.fn();
|
||||
await drain();
|
||||
};
|
||||
state.linkedSetup = async () => {
|
||||
await state.fire("init");
|
||||
await state.fire("ready");
|
||||
await state.runTimers();
|
||||
state.requests.length = 0;
|
||||
return state;
|
||||
};
|
||||
|
||||
return state;
|
||||
}
|
||||
|
||||
// The fetch stub updates a note with the page it maps, like the real backend
|
||||
// does, so every test works on notes of its own.
|
||||
const sessionNote = (over = {}) => ({ _id: "note-1", title: "Session 1", content: "**The start**", ...over });
|
||||
const tavernNote = (over = {}) => ({ _id: "note-2", title: "Tavern Brawl", content: "A rope, a chandelier.", ...over });
|
||||
|
||||
test("the campaign's notes become pages of one Dragonroll journal", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
world.remoteNotes = [sessionNote(), tavernNote()];
|
||||
|
||||
await world.runIntervals();
|
||||
|
||||
assert.equal(world.journals().length, 1, "one journal carries the campaign's notes");
|
||||
const journal = world.journals()[0];
|
||||
assert.equal(journal.name, "Dragonroll");
|
||||
assert.deepEqual(journal.pages.contents.map((page) => [page.name, page.text.content]), [
|
||||
["Session 1", "<marked>**The start**</marked>"],
|
||||
["Tavern Brawl", "<marked>A rope, a chandelier.</marked>"],
|
||||
], "each note is a page, its markdown rendered by Foundry's own renderer");
|
||||
assert.deepEqual(journal.pages.contents.map((page) => page.getFlag(MODULE_ID, "noteId")), ["note-1", "note-2"],
|
||||
"each page keeps the note it stands for");
|
||||
assert.deepEqual(world.mapNoteRequests().map((request) => [request.body.noteId, request.body.foundryPageId]), [
|
||||
["note-1", journal.pages.contents[0].id],
|
||||
["note-2", journal.pages.contents[1].id],
|
||||
], "and the campaign remembers each note's page");
|
||||
});
|
||||
|
||||
test("reconciling again does not double the journal or its pages", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
world.remoteNotes = [sessionNote(), tavernNote()];
|
||||
|
||||
await world.runIntervals();
|
||||
await world.runIntervals();
|
||||
await world.runIntervals();
|
||||
|
||||
assert.equal(world.journals().length, 1, "the journal is made once, not per reconcile");
|
||||
assert.equal(world.journals()[0].pages.contents.length, 2, "and each note stands as the one page it was given");
|
||||
assert.equal(world.mapNoteRequests().length, 2, "an already-mapped note is not mapped again");
|
||||
});
|
||||
|
||||
test("an existing journal named Dragonroll is used, not doubled", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
const gmsOwn = world.addJournal("Dragonroll");
|
||||
|
||||
world.remoteNotes = [sessionNote()];
|
||||
await world.runIntervals();
|
||||
|
||||
assert.equal(world.journals().length, 1, "the journal the world already had is the notes' one");
|
||||
assert.deepEqual(gmsOwn.pages.contents.map((page) => page.name), ["Session 1"]);
|
||||
assert.equal(gmsOwn.getFlag(MODULE_ID, "notesJournal"), true, "and it is marked, so renaming it keeps the notes' home findable");
|
||||
});
|
||||
|
||||
test("a note edited in Dragonroll rewrites its page", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
world.remoteNotes = [sessionNote()];
|
||||
await world.runIntervals();
|
||||
|
||||
const first = world.remoteNotes[0];
|
||||
world.remoteNotes = [{ ...first, title: "Session 1 — revisited", content: "**A different start**" }];
|
||||
await world.runIntervals();
|
||||
|
||||
const journal = world.journals()[0];
|
||||
assert.equal(journal.pages.contents.length, 1, "the note still stands as the same single page");
|
||||
assert.deepEqual(journal.pages.contents[0].name, "Session 1 — revisited");
|
||||
assert.equal(journal.pages.contents[0].text.content, "<marked>**A different start**</marked>");
|
||||
assert.equal(world.mapNoteRequests().length, 1, "the pairing the world reads back needs no remapping");
|
||||
});
|
||||
|
||||
test("a note deleted in Dragonroll takes its page with it", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
world.remoteNotes = [sessionNote(), tavernNote()];
|
||||
await world.runIntervals();
|
||||
|
||||
const journal = world.journals()[0];
|
||||
const gmsPage = world.addPage(journal, { name: "My own notes", text: { content: "not from Dragonroll" } });
|
||||
world.remoteNotes = world.remoteNotes.filter((note) => note._id !== "note-2");
|
||||
await world.runIntervals();
|
||||
|
||||
assert.deepEqual(journal.pages.contents.map((page) => page.name), ["Session 1", "My own notes"],
|
||||
"the deleted note's page goes; the GM's own page stays");
|
||||
assert.ok(journal.pages.contents.includes(gmsPage));
|
||||
});
|
||||
|
||||
test("pages already in step with the campaign are not rewritten", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
world.remoteNotes = [sessionNote()];
|
||||
await world.runIntervals();
|
||||
|
||||
const [page] = world.journals()[0].pages.contents;
|
||||
assert.equal(page.writes, 0, "the page was created whole, not patched");
|
||||
await world.runIntervals();
|
||||
assert.equal(page.writes, 0, "a reconcile that changes nothing leaves the page alone");
|
||||
});
|
||||
|
||||
test("the campaign's page mapping claims a page whose flag was lost", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
const journal = world.addJournal("Dragonroll");
|
||||
const orphan = world.addPage(journal, { name: "Old name", text: { content: "old" } });
|
||||
|
||||
world.remoteNotes = [{ _id: "note-1", title: "Session 1", content: "**The start**", foundryPageId: orphan.id }];
|
||||
await world.runIntervals();
|
||||
|
||||
assert.equal(journal.pages.contents.length, 1, "no second page under the same title");
|
||||
assert.equal(orphan.name, "Session 1");
|
||||
assert.equal(orphan.getFlag(MODULE_ID, "noteId"), "note-1", "and the page is marked again");
|
||||
});
|
||||
|
||||
test("a page under the note's title with no mark is claimed, not doubled", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
const journal = world.addJournal("Dragonroll");
|
||||
const existing = world.addPage(journal, { name: "Session 1", text: { content: "an older copy" } });
|
||||
|
||||
// The campaign has no page id for the note, and the page carries no flag: this
|
||||
// is a page the module made before the pairing was kept, or one whose flag was
|
||||
// lost. It is claimed instead of a second page being made under the same title.
|
||||
world.remoteNotes = [sessionNote()];
|
||||
await world.runIntervals();
|
||||
|
||||
assert.equal(journal.pages.contents.length, 1, "no second page under the note's title");
|
||||
assert.equal(existing.text.content, "<marked>**The start**</marked>", "the note's text lands on the page the world already had");
|
||||
assert.equal(existing.getFlag(MODULE_ID, "noteId"), "note-1", "and the page is marked as the note's");
|
||||
assert.deepEqual(world.mapNoteRequests().map((request) => request.body.foundryPageId), [existing.id],
|
||||
"the campaign is told which page the note now stands as");
|
||||
|
||||
await world.runIntervals();
|
||||
assert.equal(journal.pages.contents.length, 1, "reconciling again does not add another");
|
||||
});
|
||||
|
||||
test("two notes of one title do not share a single page", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
const journal = world.addJournal("Dragonroll");
|
||||
const existing = world.addPage(journal, { name: "Session 1", text: { content: "an older copy" } });
|
||||
|
||||
world.remoteNotes = [sessionNote(), { _id: "note-9", title: "Session 1", content: "second" }];
|
||||
await world.runIntervals();
|
||||
|
||||
assert.equal(journal.pages.contents.length, 2, "the second note gets a page of its own");
|
||||
assert.equal(existing.getFlag(MODULE_ID, "noteId"), "note-1", "the world's page is claimed by the first note");
|
||||
assert.equal(journal.pages.contents[1].getFlag(MODULE_ID, "noteId"), "note-9");
|
||||
});
|
||||
|
||||
test("a page whose mark and mapping were both lost is claimed again, not doubled", async () => {
|
||||
// Both ways of recognising the pairing are gone: the create's flag did not stick,
|
||||
// and the campaign never got to keep the page id. Without claiming the page it
|
||||
// already made, every reconcile would write another one.
|
||||
const world = await makeWorld({ keepCreateFlags: false, failMapNote: true }).linkedSetup();
|
||||
world.remoteNotes = [sessionNote()];
|
||||
|
||||
await world.runIntervals();
|
||||
await world.runIntervals();
|
||||
await world.runIntervals();
|
||||
|
||||
const journal = world.journals()[0];
|
||||
assert.equal(journal.pages.contents.length, 1, "one note stands as the one page it was given");
|
||||
assert.equal(journal.pages.contents[0].getFlag(MODULE_ID, "noteId"), "note-1",
|
||||
"and the page keeps the note it stands for even though the create did not mark it");
|
||||
});
|
||||
|
||||
test("without Foundry's markdown renderer the fallback keeps the text legible", async () => {
|
||||
const world = await makeWorld({ markdown: false }).linkedSetup();
|
||||
world.remoteNotes = [{ _id: "note-1", title: "Session 1", content: "a & b < c\nline two\n\nsecond para" }];
|
||||
|
||||
await world.runIntervals();
|
||||
|
||||
assert.equal(
|
||||
world.journals()[0].pages.contents[0].text.content,
|
||||
"<p>a & b < c<br />line two</p>\n<p>second para</p>",
|
||||
"escaped paragraphs instead of nothing, until this Foundry offers a renderer",
|
||||
);
|
||||
});
|
||||
|
||||
test("autosync off: the campaign's notes are not written into the world", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
await world.game.settings.set(MODULE_ID, "autoSync", false);
|
||||
|
||||
world.remoteNotes = [sessionNote()];
|
||||
await world.runIntervals();
|
||||
|
||||
assert.deepEqual(world.journals(), [], "no journal is made");
|
||||
assert.deepEqual(world.notesReads(), [], "and the campaign is not even asked");
|
||||
});
|
||||
@@ -207,6 +207,7 @@ test("autosync on: Foundry CRUD events keep syncing with Dragonroll", async () =
|
||||
const pushes = world.syncRequests();
|
||||
assert.equal(pushes.length, 1);
|
||||
assert.equal(pushes[0].body.actors[0]._id, "actor-1");
|
||||
assert.equal(pushes[0].body.replace, false, "a live actor change never asks Dragonroll to replace the campaign's edits");
|
||||
});
|
||||
|
||||
test("autosync off: CRUD requests stop syncing", async () => {
|
||||
@@ -260,6 +261,7 @@ test("force sync sends selected actors to Dragonroll even with autosync off", as
|
||||
const pushes = world.syncRequests();
|
||||
assert.equal(pushes.length, 1);
|
||||
assert.equal(pushes[0].body.fullSync, false, "a forced actor never prunes the campaign");
|
||||
assert.equal(pushes[0].body.replace, true, "a forced sync replaces everything the campaign holds for those actors");
|
||||
assert.deepEqual(pushes[0].body.actors.map((actor) => actor._id), ["actor-2"]);
|
||||
assert.deepEqual(world.notifications.filter(([kind]) => kind !== "info"), []);
|
||||
});
|
||||
|
||||
@@ -132,6 +132,8 @@ function loadSyncRoute({ seed = {}, worldId = "world-1" } = {}) {
|
||||
"../models/Actor": fakeModel("actor", seeded(seed.actors)),
|
||||
"../models/Item": fakeModel("item", seeded(seed.items)),
|
||||
"../models/Folder": fakeModel("folder", seeded(seed.folders)),
|
||||
"../models/Note": fakeModel("note", seeded(seed.notes)),
|
||||
"../models/Map": fakeModel("map", seeded(seed.maps)),
|
||||
};
|
||||
|
||||
const requireStub = (id) => {
|
||||
@@ -141,6 +143,8 @@ function loadSyncRoute({ seed = {}, worldId = "world-1" } = {}) {
|
||||
if (id === "../models/Campaign") return { findOne: async () => campaign };
|
||||
if (id === "../services/actor-foundry") return { foundryActorToCharacter: (actor) => ({ name: actor?.name ?? "" }) };
|
||||
if (id === "../services/item-foundry") return repoRequire(path.join("backend", "src", "services", "item-foundry.js"));
|
||||
if (id === "../services/foundry-icons") return repoRequire(path.join("backend", "src", "services", "foundry-icons.js"));
|
||||
if (id === "../services/map-foundry") return repoRequire(path.join("backend", "src", "services", "map-foundry.js"));
|
||||
if (models[id]) return models[id];
|
||||
throw new Error(`require("${id}") is not stubbed`);
|
||||
};
|
||||
|
||||
599
tests/map-foundry-sync.test.js
Normal file
599
tests/map-foundry-sync.test.js
Normal file
@@ -0,0 +1,599 @@
|
||||
// Tests for the world's scenes arriving as the campaign's maps (Syndria98/dragonroll#99).
|
||||
// Only a scene's background picture and the grid laid over it travel: the campaign keeps its
|
||||
// own scale, its folders, its pinned notes and the tokens standing on the map, and none of it
|
||||
// goes back to the world.
|
||||
//
|
||||
// Same set-up as tests/item-folder-sync.test.js, which the repository root runs without
|
||||
// installing anything: the sync route is loaded into `node:vm` with express, mongoose and its
|
||||
// models stubbed (plain rows and a small filter matcher), so creating, adopting and pruning
|
||||
// maps is observable without a database. The Foundry module is loaded into a `node:vm` context
|
||||
// holding stubbed Foundry globals (`game.scenes` included) with fake timers, like
|
||||
// tests/foundry-sync-toggle.test.js.
|
||||
//
|
||||
// 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 vm = require("node:vm");
|
||||
|
||||
const read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
|
||||
const repoRequire = (relative) => require(path.join(__dirname, "..", relative));
|
||||
|
||||
// --- The sync route against stubbed models -------------------------------------
|
||||
|
||||
// A mongoose query answers whatever `await query` and `query.lean()` answer with, and
|
||||
// lets `select()`, `sort()` and `limit()` sit in between.
|
||||
function mongooseQuery(value) {
|
||||
const result = {
|
||||
select: () => result,
|
||||
sort: () => result,
|
||||
limit: (count) => mongooseQuery(value.slice(0, count)),
|
||||
lean: () => Promise.resolve(value),
|
||||
then: (onFulfilled, onRejected) => Promise.resolve(value).then(onFulfilled, onRejected),
|
||||
};
|
||||
return result;
|
||||
}
|
||||
|
||||
// Enough of the query language the scene sync uses: equality, $in, $nin, $exists.
|
||||
// Anything else is a filter this test did not expect and says so.
|
||||
function matches(document, filter = {}) {
|
||||
return Object.entries(filter).every(([key, expected]) => {
|
||||
const value = document?.[key];
|
||||
if (expected && typeof expected === "object" && !Array.isArray(expected)) {
|
||||
return Object.entries(expected).every(([operator, wanted]) => {
|
||||
if (operator === "$exists") return (value !== undefined && value !== null) === wanted;
|
||||
if (operator === "$in") return wanted.some((entry) => String(value) === String(entry));
|
||||
if (operator === "$nin") return !wanted.some((entry) => String(value) === String(entry));
|
||||
throw new Error(`filter operator "${key}.${operator}" is not stubbed`);
|
||||
});
|
||||
}
|
||||
return String(value ?? "") === String(expected ?? "");
|
||||
});
|
||||
}
|
||||
|
||||
function fakeModel(table, seed = [], campaignId) {
|
||||
const rows = [];
|
||||
let counter = 0;
|
||||
|
||||
function Document(data = {}) {
|
||||
counter += 1;
|
||||
this._id = `${table}-${counter}`;
|
||||
this.isNew = true;
|
||||
Object.assign(this, data);
|
||||
}
|
||||
Document.prototype.save = async function save() {
|
||||
if (this.isNew) rows.push(this);
|
||||
this.isNew = false;
|
||||
return this;
|
||||
};
|
||||
Object.defineProperty(Document.prototype, "id", { get() { return this._id; } });
|
||||
|
||||
for (const data of seed) {
|
||||
// A seeded row belongs to the campaign the requests are made against unless the seed
|
||||
// says otherwise: the sync scopes every lookup by campaign.
|
||||
const row = new Document({ campaign: campaignId, name: undefined, ...data });
|
||||
row.isNew = false;
|
||||
rows.push(row);
|
||||
}
|
||||
|
||||
const model = function Model(data) { return new Document(data); };
|
||||
model.rows = rows;
|
||||
model.findOne = async (filter) => rows.find((row) => matches(row, filter)) ?? null;
|
||||
model.find = (filter) => mongooseQuery(rows.filter((row) => matches(row, filter)));
|
||||
model.deleteOne = async (filter) => {
|
||||
const hit = rows.filter((row) => matches(row, filter));
|
||||
for (const row of hit) rows.splice(rows.indexOf(row), 1);
|
||||
return { deletedCount: hit.length };
|
||||
};
|
||||
model.deleteMany = async (filter) => {
|
||||
const hit = rows.filter((row) => matches(row, filter));
|
||||
for (const row of hit) rows.splice(rows.indexOf(row), 1);
|
||||
return { deletedCount: hit.length };
|
||||
};
|
||||
return model;
|
||||
}
|
||||
|
||||
// The Foundry sync route with every model it requires stubbed. `seed` pre-fills the tables
|
||||
// with documents the campaign already holds.
|
||||
function loadSyncRoute({ seed = {}, worldId = "world-1", settings } = {}) {
|
||||
const routes = new Map();
|
||||
const router = {
|
||||
get: (route, ...handlers) => routes.set(`GET ${route}`, handlers),
|
||||
post: (route, ...handlers) => routes.set(`POST ${route}`, handlers),
|
||||
};
|
||||
const campaign = {
|
||||
_id: "campaign-1", id: "campaign-1", name: "Test Campaign", foundryWorldId: worldId,
|
||||
...(settings ? { settings } : {}),
|
||||
};
|
||||
const seeded = (rows = []) => rows.map((row) => ({ campaign: campaign._id, ...row }));
|
||||
const models = {
|
||||
"../models/Actor": fakeModel("actor", seeded(seed.actors)),
|
||||
"../models/Item": fakeModel("item", seeded(seed.items)),
|
||||
"../models/Folder": fakeModel("folder", seeded(seed.folders)),
|
||||
"../models/Note": fakeModel("note", seeded(seed.notes)),
|
||||
"../models/Map": fakeModel("map", seeded(seed.maps)),
|
||||
};
|
||||
|
||||
const requireStub = (id) => {
|
||||
if (id === "express") return { Router: () => router };
|
||||
if (id.startsWith("node:")) return require(id); // crypto: the sync token is hashed, not stubbed
|
||||
if (id === "mongoose") return { isValidObjectId: (value) => typeof value === "string" && value.length > 20 };
|
||||
if (id === "../models/Campaign") return { findOne: async () => campaign };
|
||||
if (id === "../services/actor-foundry") return { foundryActorToCharacter: (actor) => ({ name: actor?.name ?? "" }) };
|
||||
if (id === "../services/item-foundry") return { foundryItemToItemData: () => null };
|
||||
if (id === "../services/foundry-icons") return repoRequire(path.join("backend", "src", "services", "foundry-icons.js"));
|
||||
if (id === "../services/map-foundry") return repoRequire(path.join("backend", "src", "services", "map-foundry.js"));
|
||||
if (models[id]) return models[id];
|
||||
throw new Error(`require("${id}") is not stubbed`);
|
||||
};
|
||||
|
||||
const moduleStub = { exports: {} };
|
||||
vm.compileFunction(read("backend", "src", "routes", "foundry-link.js"), ["require", "module", "exports"])(
|
||||
requireStub, moduleStub, moduleStub.exports
|
||||
);
|
||||
|
||||
async function call(route, body = {}) {
|
||||
const handlers = routes.get(route);
|
||||
assert.ok(handlers, `${route} is not mounted`);
|
||||
const res = { payload: null, json(payload) { this.payload = payload; }, set: () => {} };
|
||||
const req = { body, get: (name) => (String(name).toLowerCase() === "authorization" ? "Bearer sync-token" : "") };
|
||||
await handlers[handlers.length - 1](req, res);
|
||||
return res.payload;
|
||||
}
|
||||
|
||||
return { call, models, campaign };
|
||||
}
|
||||
|
||||
// A scene of the world, as the module sends it: plain document data with its picture read
|
||||
// from the world. This one is 70 px cells and the picture of the ruined keep.
|
||||
function worldScene(over = {}) {
|
||||
return {
|
||||
_id: "scene-1",
|
||||
name: "The Ruined Keep",
|
||||
img: "http://vtt.test/images/keep.webp",
|
||||
grid: 70,
|
||||
flags: {},
|
||||
...over,
|
||||
};
|
||||
}
|
||||
|
||||
const maps = (sync) => sync.models["../models/Map"].rows;
|
||||
|
||||
// --- A scene arrives as a map -------------------------------------------------------
|
||||
|
||||
test("a world scene arrives as a map of the campaign", async () => {
|
||||
const sync = loadSyncRoute();
|
||||
|
||||
const response = await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene()] });
|
||||
|
||||
assert.equal(response.status, "ok");
|
||||
const [map] = maps(sync);
|
||||
assert.equal(map.name, "The Ruined Keep");
|
||||
assert.equal(map.image, "http://vtt.test/images/keep.webp", "the scene's background picture is the map's");
|
||||
assert.equal(map.gridSize, 70, "the scene's own cell size is the grid the campaign draws");
|
||||
assert.equal(map.offsetX, 0);
|
||||
assert.equal(map.offsetY, 0, "a scene that shifts nothing has its grid at the corner of the picture");
|
||||
assert.equal(map.foundrySceneId, "scene-1");
|
||||
assert.equal(map.campaign, sync.campaign._id, "the map belongs to the campaign the world is linked to");
|
||||
assert.deepEqual(response.maps, [{ foundrySceneId: "scene-1", mapId: map._id, created: true }]);
|
||||
});
|
||||
|
||||
test("a scene keeps the grid its world shifted onto the picture", async () => {
|
||||
const sync = loadSyncRoute();
|
||||
|
||||
await sync.call("POST /sync/scenes", {
|
||||
worldId: "world-1",
|
||||
scenes: [worldScene({ grid: 64, flags: { core: { shiftX: 12, shiftY: -8 } } })],
|
||||
});
|
||||
|
||||
const [map] = maps(sync);
|
||||
assert.equal(map.gridSize, 64);
|
||||
assert.equal(map.offsetX, 12);
|
||||
assert.equal(map.offsetY, -8, "a grid that starts off the corner of the picture arrives where the world puts it");
|
||||
});
|
||||
|
||||
test("a scene of a newer Foundry still arrives", async () => {
|
||||
const sync = loadSyncRoute();
|
||||
|
||||
// Since Foundry V13 the picture sits under `background.src` and the cell size under
|
||||
// `grid.size`.
|
||||
await sync.call("POST /sync/scenes", {
|
||||
worldId: "world-1",
|
||||
scenes: [worldScene({ img: undefined, background: { src: "http://vtt.test/images/keep.webp" }, grid: { size: 128 } })],
|
||||
});
|
||||
|
||||
const [map] = maps(sync);
|
||||
assert.equal(map.image, "http://vtt.test/images/keep.webp");
|
||||
assert.equal(map.gridSize, 128);
|
||||
});
|
||||
|
||||
test("a scene's picture is read against the world the campaign knows", async () => {
|
||||
// An older module sends Foundry's own relative path; it is read against the world's
|
||||
// address, the way an actor's portrait is (Syndria98/dragonroll#89).
|
||||
const sync = loadSyncRoute({ settings: { integrations: { foundryUrl: "http://vtt.test:30000" } } });
|
||||
|
||||
await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene({ img: "images/keep.webp" })] });
|
||||
|
||||
assert.equal(maps(sync)[0].image, "http://vtt.test:30000/images/keep.webp");
|
||||
});
|
||||
|
||||
test("a scene with no picture is not a map", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: { maps: [{ _id: "map-1", name: "The Ruined Keep", foundrySceneId: "scene-1", image: "http://vtt.test/images/keep.webp" }] },
|
||||
});
|
||||
|
||||
// The GM took the picture off the scene: its id still travels with the snapshot, so its
|
||||
// map is neither made blank nor dropped, and no new row is made for it either.
|
||||
const response = await sync.call("POST /sync/scenes", {
|
||||
worldId: "world-1",
|
||||
scenes: [worldScene({ img: "" })],
|
||||
fullSync: true,
|
||||
});
|
||||
|
||||
assert.deepEqual(response.maps, []);
|
||||
assert.equal(maps(sync).length, 1);
|
||||
assert.equal(maps(sync)[0].image, "http://vtt.test/images/keep.webp");
|
||||
});
|
||||
|
||||
test("what one of the map's cells stands for stays the campaign's", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: { maps: [{ _id: "map-1", name: "The Ruined Keep", foundrySceneId: "scene-1", gridSize: 50, scale: 1.5 }] },
|
||||
});
|
||||
|
||||
await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene({ gridDistance: 1500, gridUnits: "m" })] });
|
||||
|
||||
assert.equal(maps(sync)[0].gridSize, 70, "the world's cell size arrives");
|
||||
assert.equal(maps(sync)[0].scale, 1.5, "and the distance the campaign says a cell covers is left alone");
|
||||
});
|
||||
|
||||
// --- One map per scene ---------------------------------------------------------------
|
||||
|
||||
test("the same scene is never made into two maps", async () => {
|
||||
const sync = loadSyncRoute();
|
||||
|
||||
await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene()] });
|
||||
const response = await sync.call("POST /sync/scenes", {
|
||||
worldId: "world-1",
|
||||
scenes: [worldScene({ name: "The Ruined Keep, II", grid: 80 })],
|
||||
});
|
||||
|
||||
assert.equal(maps(sync).length, 1, "the scene was written over, not doubled");
|
||||
assert.equal(maps(sync)[0].name, "The Ruined Keep, II");
|
||||
assert.equal(maps(sync)[0].gridSize, 80);
|
||||
assert.equal(response.maps[0].created, false, "the push says it wrote a map it already had");
|
||||
});
|
||||
|
||||
test("a live scene edit lands on the map, however the campaign had it", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: { maps: [{ _id: "map-1", name: "Old name", foundrySceneId: "scene-1", image: "old.png", gridSize: 40 }] },
|
||||
});
|
||||
|
||||
await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene()] });
|
||||
|
||||
const [map] = maps(sync);
|
||||
assert.equal(map.image, "http://vtt.test/images/keep.webp");
|
||||
assert.equal(map.gridSize, 70);
|
||||
assert.equal(map.name, "The Ruined Keep");
|
||||
});
|
||||
|
||||
test("a full snapshot leaves the picture and grid the campaign lined up alone", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: { maps: [{ _id: "map-1", name: "My keep", foundrySceneId: "scene-1", image: "my-keep.png", gridSize: 40 }] },
|
||||
});
|
||||
|
||||
await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene()], fullSync: true });
|
||||
|
||||
const [map] = maps(sync);
|
||||
assert.equal(map.image, "my-keep.png", "a GM reconnecting does not write over a map the campaign already had");
|
||||
assert.equal(map.gridSize, 40);
|
||||
assert.equal(map.name, "My keep");
|
||||
});
|
||||
|
||||
test("a scene takes over the map the campaign drew by hand", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: { maps: [{ _id: "map-1", name: "The Ruined Keep", image: "hand-made.png", gridSize: 50 }] },
|
||||
});
|
||||
|
||||
const response = await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene()] });
|
||||
|
||||
assert.equal(maps(sync).length, 1, "the room the campaign drew first is not doubled by its scene");
|
||||
assert.equal(maps(sync)[0]._id, "map-1");
|
||||
assert.equal(maps(sync)[0].foundrySceneId, "scene-1", "and it is the scene's map from then on");
|
||||
assert.equal(response.maps[0].mapId, "map-1");
|
||||
});
|
||||
|
||||
test("a scene carrying the campaign's map id adopts that row", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: { maps: [{ _id: "map-0123456789abcdef0123456789", name: "Keep under way", image: "hand-made.png" }] },
|
||||
});
|
||||
|
||||
const response = await sync.call("POST /sync/scenes", {
|
||||
worldId: "world-1",
|
||||
scenes: [worldScene({ name: "Somewhere else", flags: { "dragonroll-foundry": { mapId: "map-0123456789abcdef0123456789" } } })],
|
||||
});
|
||||
|
||||
assert.equal(maps(sync).length, 1);
|
||||
assert.equal(response.maps[0].mapId, "map-0123456789abcdef0123456789", "the flag says which map the scene is");
|
||||
});
|
||||
|
||||
// --- Pruning --------------------------------------------------------------------------
|
||||
|
||||
test("a full snapshot prunes the maps whose scene this world let go of", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: {
|
||||
maps: [
|
||||
{ _id: "map-1", name: "Cellar", foundrySceneId: "scene-gone" },
|
||||
{ _id: "map-2", name: "Homebrew ford" },
|
||||
{ _id: "map-3", name: "The Ruined Keep", foundrySceneId: "scene-1" },
|
||||
],
|
||||
},
|
||||
});
|
||||
|
||||
await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene()], fullSync: true });
|
||||
|
||||
assert.deepEqual(maps(sync).map((map) => map._id).sort(), ["map-2", "map-3"],
|
||||
"the scene that is gone takes its map with it, and the campaign's own maps stay");
|
||||
});
|
||||
|
||||
test("a live scene push never prunes", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: { maps: [{ _id: "map-1", name: "Cellar", foundrySceneId: "scene-gone" }] },
|
||||
});
|
||||
|
||||
await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene()] });
|
||||
|
||||
assert.equal(maps(sync).length, 2, "a push of one scene says nothing about the world's other scenes");
|
||||
});
|
||||
|
||||
test("a scene the world deleted takes its map with it", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: {
|
||||
maps: [
|
||||
{ _id: "map-1", name: "The Ruined Keep", foundrySceneId: "scene-1" },
|
||||
{ _id: "map-2", name: "Homebrew ford" },
|
||||
],
|
||||
},
|
||||
});
|
||||
|
||||
const response = await sync.call("POST /sync/scene-delete", { worldId: "world-1", foundrySceneId: "scene-1" });
|
||||
|
||||
assert.equal(response.status, "ok");
|
||||
assert.deepEqual(maps(sync).map((map) => map._id), ["map-2"], "only the map of that scene goes");
|
||||
});
|
||||
|
||||
// --- What the route refuses -----------------------------------------------------------
|
||||
|
||||
test("a push that is not the campaign's world, or names no scenes, is refused", async () => {
|
||||
const sync = loadSyncRoute();
|
||||
|
||||
assert.equal((await sync.call("POST /sync/scenes", { worldId: "another-world", scenes: [worldScene()] })).msg, "errors.missing-data");
|
||||
assert.equal((await sync.call("POST /sync/scenes", { worldId: "world-1" })).msg, "errors.missing-data");
|
||||
assert.deepEqual(maps(sync), [], "nothing was written");
|
||||
});
|
||||
|
||||
test("a delete from another world, or naming no scene, is refused", async () => {
|
||||
const sync = loadSyncRoute({ seed: { maps: [{ _id: "map-1", name: "Keep", foundrySceneId: "scene-1" }] } });
|
||||
|
||||
assert.equal((await sync.call("POST /sync/scene-delete", { worldId: "another-world", foundrySceneId: "scene-1" })).msg, "errors.missing-data");
|
||||
assert.equal((await sync.call("POST /sync/scene-delete", { worldId: "world-1" })).msg, "errors.missing-data");
|
||||
assert.equal(maps(sync).length, 1, "and the map is still there");
|
||||
});
|
||||
|
||||
test("a map remembers which scene of the world it mirrors", () => {
|
||||
const model = read("backend", "src", "models", "Map.js");
|
||||
assert.match(model, /foundrySceneId:\s*{\s*type:\s*String\s*}/, "the scene a map mirrors is kept on the map");
|
||||
assert.match(model, /\{\s*campaign:\s*1,\s*foundrySceneId:\s*1\s*\}/, "and is unique within the campaign");
|
||||
});
|
||||
|
||||
// --- The Foundry module sends its scenes ---------------------------------------------
|
||||
|
||||
const MODULE_ID = "dragonroll-foundry";
|
||||
|
||||
function makeWorld({ autoSync = true } = {}) {
|
||||
const state = {
|
||||
hooks: new Map(),
|
||||
registered: new Map(),
|
||||
requests: [],
|
||||
timers: new Map(),
|
||||
intervals: new Map(),
|
||||
nextTimerId: 1,
|
||||
};
|
||||
|
||||
// A Scene document: the plain data `toObject()` answers with, which since V13 carries
|
||||
// the picture under `background` rather than `img`.
|
||||
const makeScene = (id, name, over = {}) => ({
|
||||
id, name, documentName: "Scene", img: "", grid: 50, flags: {},
|
||||
toObject() {
|
||||
return {
|
||||
_id: this.id, name: this.name, img: this.img, grid: this.grid, flags: this.flags,
|
||||
...(this.background ? { background: this.background } : {}),
|
||||
};
|
||||
},
|
||||
...over,
|
||||
});
|
||||
const scenes = [
|
||||
makeScene("scene-keep", "The Ruined Keep", { img: "images/keep.webp", grid: 70 }),
|
||||
// A newer Foundry keeps its picture under `background`, and this one is already an
|
||||
// absolute URL, which travels as it is.
|
||||
makeScene("scene-tavern", "Tavern", { img: undefined, background: { src: "http://other.test/tavern.jpg" }, grid: 50 }),
|
||||
];
|
||||
|
||||
const settingsStore = { autoSync, syncToken: "sync-token-1", dragonrollApiUrl: "http://backend.test:5000" };
|
||||
const sandbox = {
|
||||
console: { log() {}, info() {}, warn() {}, error() {} },
|
||||
URL,
|
||||
CONFIG: {},
|
||||
window: { location: { origin: "http://vtt.test" } },
|
||||
ui: { notifications: { info() {}, warn() {}, error() {} } },
|
||||
Hooks: {
|
||||
once(name, fn) { state.hooks.set(name, [fn]); },
|
||||
on(name, fn) { state.hooks.set(name, [...(state.hooks.get(name) || []), fn]); },
|
||||
},
|
||||
setTimeout: (fn, delay = 0) => {
|
||||
const id = state.nextTimerId++;
|
||||
state.timers.set(id, { fn, delay });
|
||||
return id;
|
||||
},
|
||||
clearTimeout: (id) => state.timers.delete(id),
|
||||
setInterval: (fn, delay = 0) => {
|
||||
const id = state.nextTimerId++;
|
||||
state.intervals.set(id, { fn, delay });
|
||||
return id;
|
||||
},
|
||||
clearInterval: (id) => state.intervals.delete(id),
|
||||
fetch: async (url, options = {}) => {
|
||||
state.requests.push({
|
||||
href: String(url),
|
||||
method: options.method,
|
||||
body: options.body ? JSON.parse(options.body) : null,
|
||||
});
|
||||
return { ok: true, status: 200, json: async () => ({ status: "ok" }) };
|
||||
},
|
||||
Actor: { async create() { return null; } },
|
||||
Item: { async create() { return null; } },
|
||||
};
|
||||
|
||||
sandbox.game = {
|
||||
user: { isGM: true },
|
||||
world: { id: "world-1", title: "Test World" },
|
||||
system: { id: "dnd5e" },
|
||||
modules: { get: () => ({}) },
|
||||
actors: { contents: [], get: () => null },
|
||||
items: { contents: [], get: () => null },
|
||||
scenes: { contents: scenes, get: (id) => scenes.find((scene) => scene.id === id) },
|
||||
settings: {
|
||||
register(module, key, definition) {
|
||||
state.registered.set(key, definition);
|
||||
if (!(key in settingsStore)) settingsStore[key] = definition.default;
|
||||
},
|
||||
get(module, key) { return settingsStore[key]; },
|
||||
async set(module, key, value) {
|
||||
settingsStore[key] = value;
|
||||
await state.registered.get(key)?.onChange?.(value);
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
vm.createContext(sandbox);
|
||||
vm.runInContext(read("dragonroll-foundry", "scripts", "api.js"), sandbox);
|
||||
|
||||
state.game = sandbox.game;
|
||||
state.scene = (id) => scenes.find((scene) => scene.id === id);
|
||||
// The two routes the maps travel on: the campaign's reads live under the same prefix and
|
||||
// tell nothing about what the world sent.
|
||||
state.sceneRequests = () => state.requests.filter((request) => request.href.includes("foundry/sync/scenes")
|
||||
|| request.href.includes("foundry/sync/scene-delete"));
|
||||
state.pushes = (route) => state.requests.filter((request) => request.href.includes(route));
|
||||
|
||||
const drain = async () => { await new Promise((resolve) => setImmediate(resolve)); };
|
||||
state.fire = async (name, ...args) => {
|
||||
for (const handler of state.hooks.get(name) || []) await handler(...args);
|
||||
await drain();
|
||||
};
|
||||
state.runTimers = async () => {
|
||||
for (let round = 0; round < 6; round += 1) {
|
||||
if (!state.timers.size && round > 2) break;
|
||||
const due = [...state.timers.values()];
|
||||
state.timers.clear();
|
||||
for (const timer of due) await timer.fn();
|
||||
await drain();
|
||||
}
|
||||
};
|
||||
// A world that is already linked: init, ready, and the pushes the world makes as it loads.
|
||||
state.setup = async () => {
|
||||
await state.fire("init");
|
||||
await state.fire("ready");
|
||||
await state.runTimers();
|
||||
return state;
|
||||
};
|
||||
// The same, with the world's own pushes out of the way, so a test only sees what it causes.
|
||||
state.linkedSetup = async () => {
|
||||
await state.setup();
|
||||
state.requests.length = 0;
|
||||
return state;
|
||||
};
|
||||
|
||||
return state;
|
||||
}
|
||||
|
||||
test("the world sends its whole scene list as the campaign's maps when it loads", async () => {
|
||||
const world = await makeWorld().setup();
|
||||
|
||||
const [push] = world.pushes("foundry/sync/scenes");
|
||||
assert.ok(push, "a linked world pushes its scenes as it loads");
|
||||
assert.equal(push.body.fullSync, true, "the whole list travels, which is the push that lets the campaign prune");
|
||||
assert.deepEqual(push.body.worldId, "world-1");
|
||||
assert.deepEqual(push.body.scenes.map((scene) => [scene._id, scene.name]), [
|
||||
["scene-keep", "The Ruined Keep"],
|
||||
["scene-tavern", "Tavern"],
|
||||
]);
|
||||
assert.equal(push.body.scenes[0].img, "http://vtt.test/images/keep.webp",
|
||||
"the picture is read from this world, so it travels as an absolute URL");
|
||||
assert.equal(push.body.scenes[0].grid, 70, "the scene's own cell size travels with it");
|
||||
assert.equal(push.body.scenes[1].background.src, "http://other.test/tavern.jpg",
|
||||
"a picture that is already absolute is left as it is");
|
||||
});
|
||||
|
||||
test("a scene the GM changes reaches the campaign as that map", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
|
||||
const keep = world.scene("scene-keep");
|
||||
keep.name = "The Sunken Keep";
|
||||
keep.grid = 100;
|
||||
await world.fire("updateScene", keep);
|
||||
await world.runTimers();
|
||||
|
||||
const [push] = world.pushes("foundry/sync/scenes");
|
||||
assert.equal(push.body.fullSync, false, "a live scene edit never prunes the campaign's other maps");
|
||||
assert.deepEqual(push.body.scenes.map((scene) => [scene._id, scene.name, scene.grid]), [
|
||||
["scene-keep", "The Sunken Keep", 100],
|
||||
]);
|
||||
});
|
||||
|
||||
test("a scene the GM deletes takes its map off the campaign", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
|
||||
await world.fire("deleteScene", world.scene("scene-tavern"));
|
||||
await world.runTimers();
|
||||
|
||||
const [push] = world.pushes("foundry/sync/scene-delete");
|
||||
assert.equal(push.body.foundrySceneId, "scene-tavern");
|
||||
assert.deepEqual(world.pushes("foundry/sync/scenes"), [], "a deleted scene is not sent as a map to keep");
|
||||
});
|
||||
|
||||
test("autosync off: the world's scenes stop syncing, at world start and afterwards", async () => {
|
||||
const world = makeWorld({ autoSync: false });
|
||||
await world.fire("init");
|
||||
await world.fire("ready");
|
||||
await world.runTimers();
|
||||
assert.deepEqual(world.sceneRequests(), [], "a world with autosync off sends no scene list");
|
||||
|
||||
await world.fire("updateScene", world.scene("scene-keep"));
|
||||
await world.fire("deleteScene", world.scene("scene-tavern"));
|
||||
await world.runTimers();
|
||||
|
||||
assert.deepEqual(world.sceneRequests(), []);
|
||||
});
|
||||
|
||||
test("the scene edits queued while autosync was off are sent when it is turned back on", async () => {
|
||||
const world = await makeWorld({ autoSync: false });
|
||||
await world.fire("init");
|
||||
await world.fire("ready");
|
||||
await world.runTimers();
|
||||
|
||||
await world.fire("updateScene", world.scene("scene-keep"));
|
||||
await world.runTimers();
|
||||
assert.deepEqual(world.sceneRequests(), []);
|
||||
|
||||
await world.game.settings.set(MODULE_ID, "autoSync", true);
|
||||
await world.runTimers();
|
||||
|
||||
assert.ok(world.pushes("foundry/sync/scenes").some((push) => push.body.fullSync === true
|
||||
&& push.body.scenes.length === 2),
|
||||
"turning autosync back on sends this world's whole scene list again");
|
||||
assert.ok(world.pushes("foundry/sync/scenes").some((push) => push.body.fullSync === false
|
||||
&& push.body.scenes.map((scene) => scene._id).includes("scene-keep")),
|
||||
"and the scene edit queued while it was off is sent");
|
||||
});
|
||||
@@ -341,6 +341,17 @@ function mapViewerTokenWiringTests() {
|
||||
assert.match(pane, /@contextmenu\.stop\.prevent="onTokenContextMenu\(token\)"/);
|
||||
});
|
||||
|
||||
test("double clicking a token opens its actor's character sheet", () => {
|
||||
assert.match(pane, /@dblclick="openTokenSheet\(token\)"/);
|
||||
// The sheet is opened for the actor behind the token, and only when that actor is known.
|
||||
assert.match(pane, /function openTokenSheet\(token\) \{[^}]*tokenActor\(token\)[^}]*openActorSheet\(/);
|
||||
// A single click is not the trigger: it lands on the token at the end of every drag, so
|
||||
// moving a token would open its sheet every time.
|
||||
assert.doesNotMatch(pane, /@click="openTokenSheet\(/);
|
||||
// The keyboard reaches the same sheet: Enter on a focused token, like its arrow keys.
|
||||
assert.match(pane, /if \(event\.key === 'Enter'\) openTokenSheet\(token\);/);
|
||||
});
|
||||
|
||||
test("tokens are saved and taken off through the map routes", () => {
|
||||
assert.match(pane, /['"]\/map\/place-token['"]/);
|
||||
assert.match(pane, /['"]\/map\/remove-token['"]/);
|
||||
|
||||
Reference in New Issue
Block a user