Compare commits
1 Commits
ai/issue-6
...
ai/issue-6
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d8900cfb7f |
@@ -99,7 +99,7 @@ campaign, and handlers check ownership with a `userOwnsCampaign(campaignId, user
|
||||
- `actor` — `list`, `create`, `update` (partial, ownership checked), `upload-image?actor=` (multipart), `delete`
|
||||
- `item` — `list`, `create`, `update` (partial), `delete`
|
||||
- `map` — `list`, `create` (multipart `image` or JSON), `update` (multipart to replace the photo), `delete`, `pin` (`{id,note,x,y}`, re-pinning moves the marker), `unpin` (`{id,pin}`), `place-token` (`{id,actor,x,y}`, snapped to a cell centre, re-placing moves the token), `remove-token` (`{id,token}`)
|
||||
- `foundry` — read-only proxy over the bridge (`/world`, `/actors`, `/characters`, `/items`, `/actors/:id`, `/items/:id`, `/actors/:id/items`), needs `FOUNDRY_API_URL`; `/icons?campaign=&dir=&offset=` lists one folder of the world's core `icons/` library (the bridge reads it from `DRAGONROLL_FOUNDRY_DATA_PATH`) and answers `{dir, parent, folders, files[{path,name,url}], next}`, the icons paged so the library stays lazy to load
|
||||
- `foundry` — read-only proxy over the bridge (`/world`, `/actors`, `/characters`, `/items`, `/actors/:id`, `/items/:id`, `/actors/:id/items`), needs `FOUNDRY_API_URL`
|
||||
|
||||
## 4. Service integrations (Foundry, Discord, Obsidian)
|
||||
|
||||
@@ -118,7 +118,6 @@ the JWT guard; CORS opened for it): `snapshot` (actors + world items, `fullSync`
|
||||
|
||||
- **Identity** is `foundryActorId` / `foundryItemId` (unique per campaign, partial index); a Foundry document carrying the `dragonroll-foundry.actorId` / `.itemId` flag adopts the matching Dragonroll row.
|
||||
- **Items are deduplicated by name** — Foundry keeps the same gear once per carrier, so one `Item` per name; `foundryNames` keeps Foundry's names so a Dragonroll rename does not resurrect a duplicate. `services/item-foundry.js` returns `null` for non-gear types and those are skipped.
|
||||
- **Item folders mirror the world's item directory** (`Folder.foundryFolderId`, target `item`): every push carries the whole tree and the world owns its names and nesting. `color` is the one field the campaign sets too, so it travels back with the folders `GET /foundry/sync/items` answers with (`{items, folders}`) and the module writes it onto the world's folder.
|
||||
- **`fullSync` preserves Dragonroll edits** (only new rows are overwritten); live Foundry events overwrite. Only a full snapshot can prune.
|
||||
- **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.
|
||||
|
||||
@@ -144,16 +144,6 @@ async function syncFoundryItems(campaign, sources, fullSync = false, folders = n
|
||||
// say nothing: the folders they carry belong to that actor's own inventory, and
|
||||
// Dragonroll keeps one item per piece of gear anyway.
|
||||
|
||||
// The colour a pushed folder carries. `undefined` means the push says nothing about
|
||||
// colours — an older module, which knows nothing about them — and the colour the
|
||||
// campaign has stays; `null` is the world leaving a folder uncoloured, which takes
|
||||
// the campaign's colour off along with it. Anything else is the colour to show.
|
||||
function foundryFolderColor(source) {
|
||||
if (source?.color === undefined) return undefined;
|
||||
const color = typeof source.color === 'string' ? source.color.trim() : '';
|
||||
return color || null;
|
||||
}
|
||||
|
||||
// Parents before children, so a folder is mapped before the one nested in it.
|
||||
// A folder whose parent is missing, or caught in a cycle, becomes a root.
|
||||
function orderFoundryFolderSources(sources) {
|
||||
@@ -162,12 +152,7 @@ function orderFoundryFolderSources(sources) {
|
||||
const id = String(source?.id || '').trim().slice(0, 120);
|
||||
const name = String(source?.name || '').trim();
|
||||
if (!id || !name) continue;
|
||||
byId.set(id, {
|
||||
id,
|
||||
name,
|
||||
parent: String(source?.parent || '').trim().slice(0, 120),
|
||||
color: foundryFolderColor(source)
|
||||
});
|
||||
byId.set(id, { id, name, parent: String(source?.parent || '').trim().slice(0, 120) });
|
||||
}
|
||||
|
||||
const ordered = [];
|
||||
@@ -210,10 +195,6 @@ async function syncFoundryItemFolders(campaign, folderSources) {
|
||||
// The world owns this tree, so unlike an item's fields a rename or a move
|
||||
// lands whatever kind of push carried it: the whole tree arrives with each.
|
||||
folder.name = source.name;
|
||||
// Its colour is the one part of the tree the campaign colours too: what the
|
||||
// world shows arrives here, and what the campaign picks travels back to the
|
||||
// world with the folder list `/sync/items` answers with.
|
||||
if (source.color !== undefined) folder.color = source.color;
|
||||
const parent = inTree.has(source.parent) ? folders.get(source.parent) : null;
|
||||
folder.parentFolder = parent ? parent._id : null;
|
||||
await folder.save();
|
||||
@@ -407,20 +388,12 @@ router.post('/sync/item-delete', async (req, res) => {
|
||||
}
|
||||
});
|
||||
|
||||
// The item list the world reconciles against, together with the folders its rows are
|
||||
// grouped into — the same shape the campaign's own `/item/list` answers with. The folders
|
||||
// travel back for their colour: the world owns the tree's name and nesting, while whoever
|
||||
// colours a folder on either side expects to see it coloured on the other.
|
||||
router.get('/sync/items', async (req, res) => {
|
||||
try {
|
||||
const campaign = await syncCampaign(req, res);
|
||||
if (!campaign) return;
|
||||
const items = await Item.find({ campaign: campaign._id }).sort({ name: 1 }).lean();
|
||||
const folders = await Folder.find({ campaign: campaign._id, target: 'item' })
|
||||
.select('_id name color foundryFolderId')
|
||||
.sort({ name: 1 })
|
||||
.lean();
|
||||
res.json({ status: 'ok', items, folders });
|
||||
res.json({ status: 'ok', items });
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
res.json({ status: 'error', msg: 'errors.internal' });
|
||||
|
||||
@@ -1,16 +1,6 @@
|
||||
const express = require('express');
|
||||
const router = express.Router();
|
||||
const { requestFoundry } = require('../services/foundry');
|
||||
const { normalizeIconDirectory, readIconListingPage, shapeIconListing } = require('../services/foundry-icons');
|
||||
|
||||
const Campaign = require('../models/Campaign');
|
||||
|
||||
// The world address the icons are loaded from is kept on the campaign, so an icon
|
||||
// listing is always asked for one of the caller's own campaigns.
|
||||
async function findOwnedCampaign(campaignId, userId) {
|
||||
if (!campaignId) return null;
|
||||
return Campaign.findOne({ _id: campaignId, createdBy: userId }).select('settings').lean();
|
||||
}
|
||||
|
||||
async function proxy(path, res) {
|
||||
try {
|
||||
@@ -34,38 +24,4 @@ router.get('/actors/:id/items', (req, res) => proxy(`api/actors/${encodeURICompo
|
||||
router.get('/actors/:id', (req, res) => proxy(`api/actors/${encodeURIComponent(req.params.id)}`, res));
|
||||
router.get('/items/:id', (req, res) => proxy(`api/items/${encodeURIComponent(req.params.id)}`, res));
|
||||
|
||||
// Foundry's core icon library: the `icons/` folder of the world's data directory.
|
||||
// One folder per request, and the icons inside it paged, because that library runs
|
||||
// into the thousands and the window only ever shows where the user is standing.
|
||||
// The bridge reads it on the Foundry host; the images themselves are loaded by the
|
||||
// browser from the campaign's world address, the same way a synced item's icon is.
|
||||
router.get('/icons', async (req, res) => {
|
||||
try {
|
||||
const campaign = await findOwnedCampaign(req.query.campaign, req.user.id);
|
||||
if (!campaign) return res.status(404).json({ status: 'error', msg: 'errors.notfound' });
|
||||
|
||||
const base = campaign.settings?.integrations?.foundryUrl || '';
|
||||
if (!base) return res.status(400).json({ status: 'error', msg: 'foundry.errors.icons-no-world-url' });
|
||||
|
||||
const dir = normalizeIconDirectory(req.query.dir);
|
||||
if (!dir) return res.status(400).json({ status: 'error', msg: 'errors.missing-data' });
|
||||
|
||||
const { limit, offset } = readIconListingPage(req.query);
|
||||
const query = new URLSearchParams({ dir, offset: String(offset), limit: String(limit) });
|
||||
const result = await requestFoundry(`api/icons?${query}`);
|
||||
if (result.status !== 200 || result.data?.status !== 'ok') {
|
||||
return res.status(502).json({ status: 'error', msg: 'foundry.errors.icons-unavailable' });
|
||||
}
|
||||
|
||||
res.json({ status: 'ok', ...shapeIconListing({ base, dir, listing: result.data }) });
|
||||
} catch (err) {
|
||||
if (err.code === 'FOUNDRY_NOT_CONFIGURED') {
|
||||
return res.status(503).json({ status: 'error', msg: 'foundry.errors.icons-unavailable' });
|
||||
}
|
||||
|
||||
console.error(err);
|
||||
res.status(502).json({ status: 'error', msg: 'foundry.errors.icons-unavailable' });
|
||||
}
|
||||
});
|
||||
|
||||
module.exports = router;
|
||||
|
||||
@@ -1,110 +0,0 @@
|
||||
// Foundry's core icon library is the `icons/` folder of its data directory: a few
|
||||
// thousand images spread over its own folder tree. Dragonroll never reads that
|
||||
// tree itself — the bridge on the Foundry host lists one folder per request (see
|
||||
// dragonroll-foundry/bridge/server.js) — but everything that goes over the wire is
|
||||
// normalised here first, so a caller cannot ask for a folder outside the icon root.
|
||||
|
||||
const ICON_ROOT = 'icons';
|
||||
|
||||
// Image formats Foundry's own file picker offers.
|
||||
const ICON_EXTENSIONS = ['.svg', '.png', '.webp', '.jpg', '.jpeg', '.gif', '.avif'];
|
||||
|
||||
// How many icons one request lists. The window asks again for the next page, so a
|
||||
// folder with hundreds of them is never sent or rendered all at once.
|
||||
const DEFAULT_ICON_PAGE_SIZE = 120;
|
||||
const MAX_ICON_PAGE_SIZE = 500;
|
||||
|
||||
// The folder a listing request asks for, inside the icon root: `icons`, `icons/svg`,
|
||||
// ... Empty asks for the root. Anything that tries to leave the root is invalid.
|
||||
function normalizeIconDirectory(input) {
|
||||
const raw = String(input ?? '').trim().replace(/\\/g, '/').replace(/^\/+|\/+$/g, '');
|
||||
if (!raw || raw === '.') return ICON_ROOT;
|
||||
|
||||
const segments = raw.split('/').filter((segment) => segment && segment !== '.');
|
||||
if (!segments.length || segments.includes('..')) return null;
|
||||
if (segments[0] !== ICON_ROOT) return null;
|
||||
return segments.join('/');
|
||||
}
|
||||
|
||||
// The folder above an icon folder, or null at the root.
|
||||
function parentIconDirectory(dir) {
|
||||
const normalized = normalizeIconDirectory(dir);
|
||||
if (!normalized || normalized === ICON_ROOT) return null;
|
||||
return normalized.slice(0, normalized.lastIndexOf('/'));
|
||||
}
|
||||
function iconName(filePath) {
|
||||
const path = String(filePath ?? '');
|
||||
return path.slice(path.lastIndexOf('/') + 1);
|
||||
}
|
||||
|
||||
function isIconFile(filePath) {
|
||||
const lower = String(filePath ?? '').toLowerCase();
|
||||
return ICON_EXTENSIONS.some((extension) => lower.endsWith(extension));
|
||||
}
|
||||
|
||||
// Where the browser loads a Foundry data file from: Foundry serves its data
|
||||
// directory over the world's own address, which is the one the campaign keeps
|
||||
// (settings.integrations.foundryUrl). Items store icons as these absolute URLs,
|
||||
// the same way a synced Foundry item's icon arrives as one.
|
||||
function joinFoundryAssetUrl(baseUrl, filePath) {
|
||||
const base = String(baseUrl ?? '').trim();
|
||||
const file = String(filePath ?? '').trim().replace(/^\/+/, '');
|
||||
if (!base || !file) return '';
|
||||
return `${base.replace(/\/+$/, '')}/${encodeURI(file)}`;
|
||||
}
|
||||
|
||||
// The page a request asks for. Directories are always listed whole — the window
|
||||
// needs every subfolder to navigate — so paging only ever covers the icons.
|
||||
function readIconListingPage(query) {
|
||||
const requestedLimit = Number(query?.limit);
|
||||
const limit = Number.isFinite(requestedLimit)
|
||||
? Math.min(MAX_ICON_PAGE_SIZE, Math.max(1, Math.trunc(requestedLimit)))
|
||||
: DEFAULT_ICON_PAGE_SIZE;
|
||||
const requestedOffset = Number(query?.offset);
|
||||
const offset = Number.isFinite(requestedOffset) ? Math.max(0, Math.trunc(requestedOffset)) : 0;
|
||||
|
||||
return { limit, offset };
|
||||
}
|
||||
|
||||
// The bridge answers with plain relative paths; this is the shape the icon window
|
||||
// works with: the folder it shows, the one above it, its subfolders, and its icons
|
||||
// with a url to load. `next` is the offset of the next page, null once it is all
|
||||
// listed, which is what keeps a big library lazy to load.
|
||||
function shapeIconListing({ base = '', dir, listing = {} } = {}) {
|
||||
const current = normalizeIconDirectory(dir ?? listing.dir) || ICON_ROOT;
|
||||
|
||||
const folders = [];
|
||||
const seenFolders = new Set();
|
||||
for (const entry of Array.isArray(listing.directories) ? listing.directories : []) {
|
||||
const path = normalizeIconDirectory(typeof entry === 'string' ? entry : entry?.path);
|
||||
if (!path || path === current || seenFolders.has(path)) continue;
|
||||
seenFolders.add(path);
|
||||
folders.push({ path, name: iconName(path) });
|
||||
}
|
||||
|
||||
const files = (Array.isArray(listing.files) ? listing.files : [])
|
||||
.map((entry) => String(typeof entry === 'string' ? entry : entry?.path ?? '').trim().replace(/^\/+/, ''))
|
||||
.filter((entry) => entry.startsWith(`${ICON_ROOT}/`) && isIconFile(entry))
|
||||
.map((entry) => ({ path: entry, name: iconName(entry), url: joinFoundryAssetUrl(base, entry) }));
|
||||
|
||||
const offset = Number.isFinite(Number(listing.offset)) ? Math.max(0, Math.trunc(Number(listing.offset))) : 0;
|
||||
const next = Number.isFinite(Number(listing.next)) && Number(listing.next) > offset
|
||||
? Math.trunc(Number(listing.next))
|
||||
: null;
|
||||
|
||||
return { dir: current, parent: parentIconDirectory(current), folders, files, offset, next };
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
ICON_ROOT,
|
||||
ICON_EXTENSIONS,
|
||||
DEFAULT_ICON_PAGE_SIZE,
|
||||
MAX_ICON_PAGE_SIZE,
|
||||
normalizeIconDirectory,
|
||||
parentIconDirectory,
|
||||
iconName,
|
||||
isIconFile,
|
||||
joinFoundryAssetUrl,
|
||||
readIconListingPage,
|
||||
shapeIconListing
|
||||
};
|
||||
@@ -96,10 +96,6 @@ The campaign's Item list is synchronized with the world's gear, both ways:
|
||||
properties, description). An item made by hand in Dragonroll is created in the world's item
|
||||
directory on the next reconcile, mapped afterwards, and editing it in Dragonroll updates the Foundry
|
||||
document.
|
||||
- The folders grouping the world's item directory arrive in the campaign as its own item folders, tree
|
||||
and nesting included, and the items are filed in them. A folder's **colour** goes the other way too:
|
||||
what the GM colours in Foundry shows on the campaign's folder, and what the campaign colours lands on
|
||||
the world's folder on the next reconcile (the world's document keeps its name and nesting either way).
|
||||
- A full snapshot keeps Dragonroll edits on reconnect; live Foundry edits overwrite. Item removal is
|
||||
pruned only by a full snapshot, so a live item push never deletes anything. Deleting a synced item in
|
||||
Dragonroll removes its Foundry world copy on the next reconcile. Items that live only in an actor's
|
||||
@@ -114,15 +110,14 @@ The module calls these Dragonroll routes with the campaign sync token (no Dragon
|
||||
| `POST /api/foundry/sync/item-snapshot` | Live world item edits, upsert only |
|
||||
| `POST /api/foundry/sync/item-delete` | A world item 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/items` | Items to apply back in Foundry |
|
||||
| `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
|
||||
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.
|
||||
the write is not echoed back.
|
||||
|
||||
## 2. Run the bridge on the Foundry host
|
||||
|
||||
@@ -135,9 +130,6 @@ export DRAGONROLL_FOUNDRY_PUSH_TOKEN='replace-with-a-different-long-random-publi
|
||||
export DRAGONROLL_FOUNDRY_ALLOWED_ORIGINS='https://vtt.example.com'
|
||||
export DRAGONROLL_FOUNDRY_HOST='0.0.0.0'
|
||||
export DRAGONROLL_FOUNDRY_PORT='8787'
|
||||
# Optional: the Foundry Data directory. With it the bridge can list the core
|
||||
# `icons/` library Dragonroll's item icon browser shows.
|
||||
export DRAGONROLL_FOUNDRY_DATA_PATH='/home/foundry/Foundry Data'
|
||||
npm start --prefix foundry/bridge
|
||||
```
|
||||
|
||||
@@ -173,7 +165,6 @@ The backend exposes these JWT-protected routes when the optional snapshot bridge
|
||||
| `GET /api/foundry/actors/:id/items` | Items embedded in an actor |
|
||||
| `GET /api/foundry/items` | World-level items |
|
||||
| `GET /api/foundry/items/:id` | One world-level item |
|
||||
| `GET /api/foundry/icons?campaign=&dir=&offset=` | One folder of Foundry's core icon library |
|
||||
|
||||
The bridge exposes the matching routes under `/api/*`, plus `GET /health`. Data routes require
|
||||
`Authorization: Bearer <read-token>`. Responses contain `{ status: "ok", data, world, syncedAt,
|
||||
@@ -181,13 +172,6 @@ ageSeconds, stale }`. The snapshot stays in memory; `stale` becomes true when th
|
||||
received a GM heartbeat for more than two minutes. The bridge returns `503 foundry.not-ready` until a
|
||||
configured GM client has published its first snapshot.
|
||||
|
||||
The icon library is the one route that reads the disk instead of the snapshot: with
|
||||
`DRAGONROLL_FOUNDRY_DATA_PATH` set, `GET /api/icons?dir=icons/svg&offset=120&limit=120` answers one
|
||||
folder at a time — `{ status: "ok", dir, directories, files, offset, next }` of paths relative to the
|
||||
data directory — and never reads outside `icons/`. `next` is the offset of the next page of icons, or
|
||||
null once the folder is listed, which is how the campaign's icon browser keeps a library of thousands
|
||||
lazy to load. Without that variable the route answers `503 foundry.errors.icons-unavailable`.
|
||||
|
||||
World-level items come from Foundry's `game.items`; actor inventories come from each actor's embedded
|
||||
items collection. The API returns plain document data snapshots. This is a read-only integration: it
|
||||
does not create or update Foundry documents, and it does not persist the bridge cache across restarts.
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
const http = require("node:http");
|
||||
const fs = require("node:fs");
|
||||
const path = require("node:path");
|
||||
const { timingSafeEqual } = require("node:crypto");
|
||||
|
||||
const host = process.env.DRAGONROLL_FOUNDRY_HOST || "0.0.0.0";
|
||||
@@ -14,9 +12,6 @@ const allowedOrigins = new Set(
|
||||
.filter(Boolean),
|
||||
);
|
||||
const maxBodySize = 50 * 1024 * 1024;
|
||||
// The Foundry Data directory, for listing the core `icons/` library. Optional:
|
||||
// without it the bridge simply cannot answer icon listing requests.
|
||||
const dataPath = (process.env.DRAGONROLL_FOUNDRY_DATA_PATH || "").trim();
|
||||
|
||||
if (!readToken || !pushToken) {
|
||||
throw new Error("Set DRAGONROLL_FOUNDRY_READ_TOKEN and DRAGONROLL_FOUNDRY_PUSH_TOKEN before starting the bridge.");
|
||||
@@ -111,80 +106,6 @@ function decodePathSegment(segment) {
|
||||
}
|
||||
}
|
||||
|
||||
// --- Core icon library -----------------------------------------------------
|
||||
// Foundry keeps the icons it ships in the `icons/` folder of its data directory:
|
||||
// thousands of images over a folder tree of their own. The campaign's icon window
|
||||
// browses that tree, so the bridge lists one folder per request and pages the
|
||||
// icons inside it. It never reads outside `icons/`.
|
||||
|
||||
const iconRoot = "icons";
|
||||
const iconExtensions = new Set([".svg", ".png", ".webp", ".jpg", ".jpeg", ".gif", ".avif"]);
|
||||
const defaultIconPageSize = 120;
|
||||
const maxIconPageSize = 500;
|
||||
|
||||
function normalizeIconDirectory(input) {
|
||||
const raw = String(input ?? "").trim().replace(/\\/g, "/").replace(/^\/+|\/+$/g, "");
|
||||
if (!raw || raw === ".") return iconRoot;
|
||||
|
||||
const segments = raw.split("/").filter((segment) => segment && segment !== ".");
|
||||
if (!segments.length || segments.includes("..") || segments[0] !== iconRoot) return null;
|
||||
return segments.join("/");
|
||||
}
|
||||
|
||||
function readIconDirectory(dir, offset, limit) {
|
||||
const root = path.resolve(dataPath, iconRoot);
|
||||
const target = path.resolve(dataPath, dir);
|
||||
if (target !== root && !target.startsWith(root + path.sep)) return null;
|
||||
|
||||
const directories = [];
|
||||
const files = [];
|
||||
for (const entry of fs.readdirSync(target, { withFileTypes: true })) {
|
||||
const entryPath = path.posix.join(dir, entry.name);
|
||||
if (entry.isDirectory()) directories.push(entryPath);
|
||||
else if (entry.isFile() && iconExtensions.has(path.extname(entry.name).toLowerCase())) files.push(entryPath);
|
||||
}
|
||||
directories.sort((a, b) => a.localeCompare(b));
|
||||
files.sort((a, b) => a.localeCompare(b));
|
||||
|
||||
const page = files.slice(offset, offset + limit);
|
||||
return {
|
||||
// Subfolders always come back whole: the window needs every one of them to
|
||||
// navigate, and there are never many. Paging covers the icons.
|
||||
directories,
|
||||
files: page,
|
||||
offset,
|
||||
next: offset + page.length < files.length ? offset + page.length : null,
|
||||
};
|
||||
}
|
||||
|
||||
function sendIconListing(request, response) {
|
||||
if (!dataPath) return sendJson(response, 503, { status: "error", msg: "foundry.errors.icons-unavailable" });
|
||||
|
||||
const params = new URL(request.url, "http://localhost").searchParams;
|
||||
const dir = normalizeIconDirectory(params.get("dir"));
|
||||
if (!dir) return sendJson(response, 400, { status: "error", msg: "errors.missing-data" });
|
||||
|
||||
const requestedLimit = Number(params.get("limit"));
|
||||
const limit = Number.isFinite(requestedLimit)
|
||||
? Math.min(maxIconPageSize, Math.max(1, Math.trunc(requestedLimit)))
|
||||
: defaultIconPageSize;
|
||||
const requestedOffset = Number(params.get("offset"));
|
||||
const offset = Number.isFinite(requestedOffset) ? Math.max(0, Math.trunc(requestedOffset)) : 0;
|
||||
|
||||
try {
|
||||
const listing = readIconDirectory(dir, offset, limit);
|
||||
if (!listing) return sendJson(response, 400, { status: "error", msg: "errors.missing-data" });
|
||||
sendJson(response, 200, { status: "ok", dir, ...listing });
|
||||
} catch (error) {
|
||||
if (error.code === "ENOENT" || error.code === "ENOTDIR") {
|
||||
sendJson(response, 404, { status: "error", msg: "errors.notfound" });
|
||||
return;
|
||||
}
|
||||
console.error(`Could not list the Foundry icon folder ${dir}.`, error);
|
||||
sendJson(response, 500, { status: "error", msg: "foundry.errors.icons-unavailable" });
|
||||
}
|
||||
}
|
||||
|
||||
const server = http.createServer(async (request, response) => {
|
||||
if (!setCorsHeaders(request, response)) {
|
||||
sendJson(response, 403, { status: "error", msg: "foundry.origin-not-allowed" });
|
||||
@@ -267,10 +188,6 @@ const server = http.createServer(async (request, response) => {
|
||||
return;
|
||||
}
|
||||
|
||||
// The icon library is on disk, not in the world snapshot, so it answers whether
|
||||
// or not a GM client has published one yet.
|
||||
if (pathname === "/api/icons") return sendIconListing(request, response);
|
||||
|
||||
const current = currentSnapshot(response);
|
||||
if (!current) return;
|
||||
|
||||
|
||||
@@ -23,6 +23,7 @@ let updatingPairingStatus = false;
|
||||
let linkedCampaignName = "";
|
||||
let linkProblem = "";
|
||||
let actorSyncTimeout;
|
||||
let characterSyncRetryTimeout;
|
||||
let characterSyncRunning = false;
|
||||
let actorSyncErrorLogged = false;
|
||||
const syncingActorIds = new Set();
|
||||
@@ -33,7 +34,6 @@ let itemSyncErrorLogged = false;
|
||||
let folderSyncTimeout;
|
||||
let folderSyncRunning = false;
|
||||
const syncingItemIds = new Set();
|
||||
const syncingFolderIds = new Set();
|
||||
const queuedItemChanges = new Map();
|
||||
|
||||
function getCollectionContents(collection, collectionName) {
|
||||
@@ -676,23 +676,10 @@ function isWorldItemFolder(folder, seen = new Set()) {
|
||||
return isWorldItemFolder(parent, seen);
|
||||
}
|
||||
|
||||
// A Foundry folder's colour, or null for one the GM left uncoloured. Null travels as null:
|
||||
// it tells Dragonroll to take a colour off the folder it was given before, whereas a module
|
||||
// that says nothing about colours at all leaves the campaign's own choice alone.
|
||||
function itemFolderColor(folder) {
|
||||
const color = typeof folder?.color === "string" ? folder.color.trim() : "";
|
||||
return color || null;
|
||||
}
|
||||
|
||||
function worldItemFolderSnapshots() {
|
||||
return (game.folders?.contents || [])
|
||||
.filter((folder) => isWorldItemFolder(folder))
|
||||
.map((folder) => ({
|
||||
id: folder.id,
|
||||
name: folder.name,
|
||||
parent: itemFolderParent(folder)?.id || null,
|
||||
color: itemFolderColor(folder),
|
||||
}));
|
||||
.map((folder) => ({ id: folder.id, name: folder.name, parent: itemFolderParent(folder)?.id || null }));
|
||||
}
|
||||
|
||||
// A world item travels with the folder it stands in, so Dragonroll can file it the
|
||||
@@ -720,35 +707,6 @@ function getWorldItemSnapshots() {
|
||||
return (game.items?.contents || []).map(serializeFoundryWorldItem).filter(Boolean);
|
||||
}
|
||||
|
||||
// --- Folder colours ----------------------------------------------------------
|
||||
// Colouring a folder is the one thing about the tree the campaign gets to do on its
|
||||
// own: the world owns what the folders are called and how they nest, and Dragonroll
|
||||
// owns the colour its user picks for one. So the colour travels back with the folder
|
||||
// list the item reconcile reads, and lands on the world's folder — marked, like every
|
||||
// Dragonroll write, so the world does not echo it straight back to the campaign.
|
||||
|
||||
async function withFolderSyncSuppressed(folder, callback) {
|
||||
if (!folder?.id) return callback();
|
||||
syncingFolderIds.add(folder.id);
|
||||
try {
|
||||
return await callback();
|
||||
} finally {
|
||||
syncingFolderIds.delete(folder.id);
|
||||
}
|
||||
}
|
||||
|
||||
async function applyDragonrollFolderColors(entries) {
|
||||
for (const entry of entries || []) {
|
||||
const folder = entry?.foundryFolderId ? game.folders?.get(entry.foundryFolderId) : null;
|
||||
// Only the world's item directories: a Dragonroll folder the world has no document
|
||||
// for is the campaign's business alone, and making one there is not ours to do.
|
||||
if (!folder || folder.documentName !== "Folder" || !isWorldItemFolder(folder)) continue;
|
||||
const color = entry.color || null;
|
||||
if (itemFolderColor(folder) === color) continue;
|
||||
await withFolderSyncSuppressed(folder, () => folder.update({ color }));
|
||||
}
|
||||
}
|
||||
|
||||
function dragonrollItemIdOf(item) {
|
||||
return item.getFlag?.(MODULE_ID, "itemId") || item.flags?.[MODULE_ID]?.itemId || "";
|
||||
}
|
||||
@@ -959,13 +917,10 @@ async function reconcileDragonrollItems() {
|
||||
if (!token || !game.user?.isGM || !game.world || itemSyncRunning || !isAutoSyncEnabled()) return;
|
||||
itemSyncRunning = true;
|
||||
try {
|
||||
const result = await getDragonroll("foundry/sync/items", token);
|
||||
// The folder colours are applied first, and whatever system this world runs: a
|
||||
// colour is the same on every one of them, while writing an item is what needs D&D 5e.
|
||||
await applyDragonrollFolderColors(result.folders);
|
||||
if (game.system.id !== "dnd5e") {
|
||||
throw new Error("Item sync currently requires the D&D 5e Foundry system.");
|
||||
}
|
||||
const result = await getDragonroll("foundry/sync/items", token);
|
||||
const remoteItems = result.items || [];
|
||||
const remoteById = new Map(remoteItems.map((entry) => [String(entry._id), entry]));
|
||||
const localByRemoteId = new Map(game.items.contents
|
||||
@@ -1269,6 +1224,14 @@ async function reconcileDragonrollCharacters() {
|
||||
}
|
||||
}
|
||||
|
||||
// Both sides converge on a timer that only runs while the world is open, so a
|
||||
// round that could not reach Dragonroll is asked for again in a while instead of
|
||||
// leaving the campaign with whatever it happened to receive.
|
||||
function scheduleDragonrollCharacterSync(delay = 15000) {
|
||||
clearTimeout(characterSyncRetryTimeout);
|
||||
characterSyncRetryTimeout = setTimeout(reconcileDragonrollCharacters, delay);
|
||||
}
|
||||
|
||||
async function initializeCharacterSync() {
|
||||
if (!getSyncToken() || !game.user?.isGM || !game.world || !isAutoSyncEnabled()) return;
|
||||
try {
|
||||
@@ -1393,9 +1356,7 @@ Hooks.once("ready", () => {
|
||||
}
|
||||
// An item folder the GM made, renamed or nested changes the tree the campaign
|
||||
// mirrors; nothing about the items themselves changed, so only the tree goes.
|
||||
// A colour Dragonroll has just written into the folder is not the GM changing it.
|
||||
if (document.documentName === "Folder") {
|
||||
if (syncingFolderIds.has(document.id)) return;
|
||||
if (document.type === "Item" && isWorldItemFolder(document)) queueFoundryItemFolders();
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -1,166 +0,0 @@
|
||||
<script setup>
|
||||
import { computed, onBeforeUnmount, onMounted, ref } from 'vue';
|
||||
import { useI18n } from 'vue-i18n';
|
||||
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top, SetResizable, SetMinSize } from '@/services/Windows';
|
||||
import WindowHandle from './partials/WindowHandle.vue';
|
||||
import Server from '~/services/Server';
|
||||
import { emitter } from '~/services/Emitter';
|
||||
|
||||
const props = defineProps(['data']);
|
||||
const id = props.data.id;
|
||||
const itemId = props.data.item?._id;
|
||||
const campaign = props.data.campaign || '';
|
||||
const ICON_ROOT = 'icons';
|
||||
|
||||
const handle = ref(null);
|
||||
const wrapper = ref(null);
|
||||
const loading = ref(false);
|
||||
const error = ref('');
|
||||
const applying = ref('');
|
||||
// What the window is standing on: one folder of Foundry's icon library at a time.
|
||||
const listing = ref({ dir: ICON_ROOT, parent: null, folders: [], files: [], next: null });
|
||||
const { t } = useI18n();
|
||||
|
||||
onMounted(() => {
|
||||
Top(wrapper);
|
||||
SetupHandle(id, handle);
|
||||
SetSize(id, { width: 560, height: 540 });
|
||||
ResetPosition(id, 'center');
|
||||
SetResizable(id, true);
|
||||
SetMinSize(id, { width: 420, height: 340 });
|
||||
Load(ICON_ROOT);
|
||||
});
|
||||
|
||||
onBeforeUnmount(() => ClearWindow({ type: 'foundry_icons' }));
|
||||
|
||||
// One request per folder, and the icons inside it a page at a time: that library
|
||||
// runs into the thousands, so the window only ever asks for what it shows.
|
||||
async function Load(dir, offset = 0) {
|
||||
if (loading.value) return;
|
||||
if (!campaign) {
|
||||
error.value = t('foundry.errors.icons-no-world-url');
|
||||
return;
|
||||
}
|
||||
loading.value = true;
|
||||
error.value = '';
|
||||
try {
|
||||
const params = new URLSearchParams({ campaign, dir });
|
||||
if (offset) params.set('offset', String(offset));
|
||||
const response = await Server().get(`/foundry/icons?${params.toString()}`);
|
||||
if (response.data.status !== 'ok') {
|
||||
error.value = t(response.data.msg || 'foundry.errors.icons-unavailable');
|
||||
return;
|
||||
}
|
||||
const page = {
|
||||
dir: response.data.dir || dir,
|
||||
parent: response.data.parent ?? null,
|
||||
folders: response.data.folders || [],
|
||||
files: response.data.files || [],
|
||||
next: response.data.next ?? null,
|
||||
};
|
||||
listing.value = offset
|
||||
? { ...page, files: [...listing.value.files, ...page.files] }
|
||||
: page;
|
||||
} catch (requestError) {
|
||||
error.value = t('foundry.errors.icons-unavailable');
|
||||
} finally {
|
||||
loading.value = false;
|
||||
}
|
||||
}
|
||||
|
||||
const trail = computed(() => {
|
||||
const parts = String(listing.value.dir || ICON_ROOT).split('/').filter(Boolean);
|
||||
return parts.map((name, index) => ({ name, path: parts.slice(0, index + 1).join('/') }));
|
||||
});
|
||||
|
||||
const empty = computed(() => !loading.value && !listing.value.folders.length && !listing.value.files.length);
|
||||
|
||||
function GoUp() {
|
||||
Load(listing.value.parent || ICON_ROOT);
|
||||
}
|
||||
|
||||
// The icon is stored as the url the browser loads it from, the same shape a synced
|
||||
// Foundry item's icon has; the item window follows the event this leaves behind.
|
||||
async function Choose(icon) {
|
||||
if (applying.value) return;
|
||||
applying.value = icon.path;
|
||||
error.value = '';
|
||||
try {
|
||||
const response = await Server().post('/item/update', { id: itemId, image: icon.url });
|
||||
if (response.data.status !== 'ok') {
|
||||
error.value = t('campaigns.item.sheet.save-error');
|
||||
return;
|
||||
}
|
||||
emitter.emit('campaign-entry-updated', { entityType: 'item', entry: response.data.item });
|
||||
ClearWindow({ type: 'foundry_icons' });
|
||||
ClearWindow({ type: 'item_icon_source' });
|
||||
} catch (requestError) {
|
||||
error.value = t('campaigns.item.sheet.save-error');
|
||||
} finally {
|
||||
applying.value = '';
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<div class="window-wrapper foundry-icons-window" :id="'window-wrapper-' + id" ref="wrapper">
|
||||
<WindowHandle :window="id" ref="handle" />
|
||||
<div class="icons-body">
|
||||
<nav class="icons-trail" :aria-label="$t('foundry.icons.path')">
|
||||
<button class="trail-up" type="button" :disabled="loading || !listing.parent" :aria-label="$t('foundry.icons.up')" @click="GoUp">
|
||||
<img class="icon" src="/icons/iconoir/regular/arrow-up.svg" alt="" aria-hidden="true">
|
||||
</button>
|
||||
<template v-for="crumb in trail" :key="crumb.path">
|
||||
<span class="trail-separator" aria-hidden="true">/</span>
|
||||
<button class="trail-crumb" type="button" :disabled="loading" @click="Load(crumb.path)">{{ crumb.name }}</button>
|
||||
</template>
|
||||
</nav>
|
||||
|
||||
<div v-if="error" class="icons-error">{{ error }}</div>
|
||||
<p v-if="loading" class="icons-state">{{ $t('foundry.icons.loading') }}</p>
|
||||
<p v-else-if="empty" class="icons-state">{{ $t('foundry.icons.empty') }}</p>
|
||||
|
||||
<div v-if="listing.folders.length" class="icon-tiles">
|
||||
<button v-for="folder in listing.folders" :key="folder.path" class="icon-tile folder" type="button" :disabled="loading" @click="Load(folder.path)">
|
||||
<img class="icon" src="/icons/iconoir/regular/folder.svg" alt="" aria-hidden="true">
|
||||
<span class="tile-name">{{ folder.name }}</span>
|
||||
</button>
|
||||
</div>
|
||||
|
||||
<div v-if="listing.files.length" class="icon-tiles">
|
||||
<button v-for="icon in listing.files" :key="icon.path" class="icon-tile" type="button"
|
||||
:disabled="applying !== ''" :title="icon.name" @click="Choose(icon)">
|
||||
<img class="tile-image" :src="icon.url" :alt="icon.name" loading="lazy">
|
||||
<span class="tile-name">{{ icon.name }}</span>
|
||||
</button>
|
||||
</div>
|
||||
|
||||
<button v-if="listing.next" class="icons-more sheet-button" type="button" :disabled="loading" @click="Load(listing.dir, listing.next)">
|
||||
{{ $t('foundry.icons.load-more') }}
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<style scoped>
|
||||
.foundry-icons-window { min-width: 0; min-height: 0; }
|
||||
.icons-body { width: 100%; min-height: 0; flex: 1; overflow: auto; padding: 12px 14px 16px; box-sizing: border-box; display: flex; flex-direction: column; gap: 10px; }
|
||||
.icons-trail { display: flex; align-items: center; flex-wrap: wrap; gap: 4px; position: sticky; top: 0; padding-bottom: 8px; background: var(--color-window-background); font-size: 12px; }
|
||||
.trail-up, .trail-crumb { display: inline-flex; align-items: center; padding: 4px 7px; border: 1px solid var(--color-border); border-radius: 6px; background: var(--color-background-soft); color: var(--color-text); cursor: pointer; font-size: 12px; }
|
||||
.trail-up:hover, .trail-crumb:hover { background: var(--color-button-hover); }
|
||||
.trail-up:disabled, .trail-crumb:disabled { opacity: .5; cursor: wait; }
|
||||
.trail-separator { opacity: .45; }
|
||||
.icons-error { padding: 7px 10px; border-radius: 6px; color: var(--color-red); background: var(--color-background-soft); font-size: 12px; }
|
||||
.icons-state { margin: 0; font-size: 12px; opacity: .7; }
|
||||
.icon-tiles { display: grid; grid-template-columns: repeat(auto-fill, minmax(78px, 1fr)); gap: 8px; }
|
||||
.icon-tile { display: flex; flex-direction: column; align-items: center; gap: 5px; padding: 8px 6px; border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft); color: var(--color-text); cursor: pointer; }
|
||||
.icon-tile:hover { background: var(--color-button-hover); border-color: var(--color-link); }
|
||||
.icon-tile:disabled { opacity: .55; cursor: wait; }
|
||||
.icon-tile.folder { justify-content: center; }
|
||||
.icon-tile .icon { width: 22px; height: 22px; }
|
||||
.tile-image { width: 40px; height: 40px; object-fit: contain; }
|
||||
.tile-name { max-width: 100%; overflow: hidden; text-overflow: ellipsis; white-space: nowrap; font-size: 10px; opacity: .75; }
|
||||
.icons-more { align-self: center; border: 1px solid var(--color-border); border-radius: 7px; padding: 7px 12px; background: var(--color-background-soft); color: var(--color-text); cursor: pointer; white-space: nowrap; font-size: 13px; }
|
||||
.icons-more:hover { background: var(--color-button-hover); }
|
||||
.icons-more:disabled { opacity: .55; cursor: wait; }
|
||||
</style>
|
||||
@@ -1,128 +0,0 @@
|
||||
<script setup>
|
||||
import { computed, onBeforeUnmount, onMounted, ref } from 'vue';
|
||||
import { useI18n } from 'vue-i18n';
|
||||
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top, CreateChildWindow } from '@/services/Windows';
|
||||
import WindowHandle from './partials/WindowHandle.vue';
|
||||
import Server, { getBaseUrl } from '~/services/Server';
|
||||
import { emitter } from '~/services/Emitter';
|
||||
|
||||
const props = defineProps(['data']);
|
||||
const id = props.data.id;
|
||||
const item = props.data.item || {};
|
||||
const itemId = item._id;
|
||||
const campaign = props.data.campaign || '';
|
||||
const handle = ref(null);
|
||||
const wrapper = ref(null);
|
||||
const error = ref('');
|
||||
const uploading = ref(false);
|
||||
const photoInput = ref(null);
|
||||
const image = ref(item.image || '');
|
||||
const { t } = useI18n();
|
||||
|
||||
onMounted(() => {
|
||||
Top(wrapper);
|
||||
SetupHandle(id, handle);
|
||||
SetSize(id, { width: 430, height: 320 });
|
||||
ResetPosition(id, 'center');
|
||||
});
|
||||
|
||||
onBeforeUnmount(() => ClearWindow({ type: 'item_icon_source' }));
|
||||
|
||||
// An uploaded icon is a file of the backend's uploads folder and a Foundry one an
|
||||
// absolute url of the world; both are drawn the way the item window draws them.
|
||||
const imageUrl = computed(() => {
|
||||
if (!image.value) return '';
|
||||
return /^(https?:|data:|\/\/)/i.test(image.value)
|
||||
? image.value
|
||||
: `${getBaseUrl()}/public/${image.value}`;
|
||||
});
|
||||
|
||||
function pickLocalIcon() {
|
||||
photoInput.value?.click();
|
||||
}
|
||||
|
||||
// The icon browser opens on top of this window, as its child: closing the chooser
|
||||
// takes the browser with it, like every other child window here.
|
||||
function openFoundryIcons() {
|
||||
CreateChildWindow(id, 'foundry_icons', { item: { _id: itemId, name: item.name }, campaign });
|
||||
}
|
||||
|
||||
async function onIconSelected(event) {
|
||||
const file = event.target.files?.[0];
|
||||
event.target.value = '';
|
||||
if (!file || uploading.value) return;
|
||||
uploading.value = true;
|
||||
error.value = '';
|
||||
try {
|
||||
const formData = new FormData();
|
||||
formData.append('image', file);
|
||||
const response = await Server().post(`/item/upload-image?item=${itemId}`, formData, {
|
||||
headers: { "Content-Type": "multipart/form-data" }
|
||||
});
|
||||
if (response.data.status !== 'ok') {
|
||||
error.value = t('campaigns.item.sheet.upload-error');
|
||||
return;
|
||||
}
|
||||
// The item window follows this event and shows the new icon.
|
||||
emitter.emit('campaign-entry-updated', { entityType: 'item', entry: response.data.item });
|
||||
ClearWindow({ id });
|
||||
} catch (requestError) {
|
||||
error.value = t('campaigns.item.sheet.upload-error');
|
||||
} finally {
|
||||
uploading.value = false;
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<div class="window-wrapper icon-source-window" :id="'window-wrapper-' + id" ref="wrapper">
|
||||
<WindowHandle :window="id" ref="handle" />
|
||||
<div class="source-body">
|
||||
<header class="source-hero">
|
||||
<div class="source-icon" :class="{ empty: !image }">
|
||||
<img v-if="imageUrl" :src="imageUrl" :alt="$t('campaigns.item.sheet.icon')">
|
||||
<span v-else aria-hidden="true">{{ (item.name || '?').slice(0, 1).toUpperCase() }}</span>
|
||||
</div>
|
||||
<p class="source-intro">{{ $t('campaigns.item.icon-picker.intro') }}</p>
|
||||
</header>
|
||||
|
||||
<div v-if="error" class="source-error">{{ error }}</div>
|
||||
|
||||
<div class="source-options">
|
||||
<button class="source-option" type="button" :disabled="uploading" @click="pickLocalIcon">
|
||||
<img class="icon" src="/icons/iconoir/regular/cloud-upload.svg" alt="" aria-hidden="true">
|
||||
<span class="source-option-title">{{ uploading
|
||||
? $t('campaigns.item.sheet.uploading')
|
||||
: $t('campaigns.item.icon-picker.upload') }}</span>
|
||||
<span class="source-option-hint">{{ $t('campaigns.item.icon-picker.upload-hint') }}</span>
|
||||
</button>
|
||||
<button class="source-option" type="button" @click="openFoundryIcons">
|
||||
<img class="icon" src="/icons/iconoir/regular/media-image.svg" alt="" aria-hidden="true">
|
||||
<span class="source-option-title">{{ $t('campaigns.item.icon-picker.foundry') }}</span>
|
||||
<span class="source-option-hint">{{ $t('campaigns.item.icon-picker.foundry-hint') }}</span>
|
||||
</button>
|
||||
</div>
|
||||
|
||||
<input ref="photoInput" class="photo-input" type="file" accept="image/*" @change="onIconSelected">
|
||||
</div>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<style scoped>
|
||||
.icon-source-window { min-width: 0; min-height: 0; }
|
||||
.source-body { width: 100%; min-height: 0; flex: 1; overflow: auto; padding: 14px 16px 16px; box-sizing: border-box; display: flex; flex-direction: column; gap: 12px; }
|
||||
.source-hero { display: flex; align-items: center; gap: 13px; padding-bottom: 12px; border-bottom: 1px solid var(--color-border); }
|
||||
.source-icon { width: 56px; height: 56px; flex: 0 0 56px; display: grid; place-items: center; overflow: hidden; border-radius: 10px; border: 1px solid var(--color-border); background: var(--color-background-soft); color: var(--color-link); font: 26px MrEavesRemake; }
|
||||
.source-icon.empty { border-style: dashed; }
|
||||
.source-icon img { width: 100%; height: 100%; object-fit: contain; }
|
||||
.source-intro { margin: 0; font-size: 13px; opacity: .85; }
|
||||
.source-error { padding: 7px 10px; border-radius: 6px; color: var(--color-red); background: var(--color-background-soft); font-size: 12px; }
|
||||
.source-options { display: flex; flex-direction: column; gap: 10px; }
|
||||
.source-option { display: grid; grid-template-columns: 26px 1fr; align-items: center; gap: 4px 10px; padding: 12px 14px; text-align: left; border: 1px solid var(--color-border); border-radius: 10px; background: var(--color-background-soft); color: var(--color-text); cursor: pointer; }
|
||||
.source-option:hover { background: var(--color-button-hover); }
|
||||
.source-option:disabled { opacity: .55; cursor: wait; }
|
||||
.source-option .icon { width: 20px; height: 20px; grid-row: span 2; }
|
||||
.source-option-title { font: 15px MrEavesRemake; }
|
||||
.source-option-hint { font-size: 12px; opacity: .7; }
|
||||
.photo-input { display: none; }
|
||||
</style>
|
||||
@@ -1,10 +1,9 @@
|
||||
<script setup>
|
||||
import { computed, onBeforeUnmount, onMounted, ref } from 'vue';
|
||||
import { useI18n } from 'vue-i18n';
|
||||
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top, CreateChildWindow } from '@/services/Windows';
|
||||
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top } from '@/services/Windows';
|
||||
import WindowHandle from './partials/WindowHandle.vue';
|
||||
import Server, { getBaseUrl } from '~/services/Server';
|
||||
import { useCampaignService } from '~/services/Campaign.js';
|
||||
import { emitter } from '~/services/Emitter';
|
||||
|
||||
const props = defineProps(['data']);
|
||||
@@ -13,10 +12,9 @@ const itemId = props.data.item?._id;
|
||||
const handle = ref(null);
|
||||
const wrapper = ref(null);
|
||||
const error = ref('');
|
||||
// Set while this window writes the item's icon, so a Foundry sync landing behind
|
||||
// the window does not rewrite the form under the change being made.
|
||||
const applyingIcon = ref(false);
|
||||
const { Campaign } = useCampaignService();
|
||||
const uploadingIcon = ref(false);
|
||||
const applyingFoundryIcon = ref(false);
|
||||
const photoInput = ref(null);
|
||||
const { t } = useI18n();
|
||||
|
||||
function normalizeItem(item) {
|
||||
@@ -46,10 +44,9 @@ onMounted(() => {
|
||||
onBeforeUnmount(() => ClearWindow({ type: 'item_sheet' }));
|
||||
|
||||
// The sidebar keeps this entry fresh (Foundry sync lands in the background);
|
||||
// follow along unless this window is mid-icon-change. The icon windows leave
|
||||
// their result here, on the same event.
|
||||
// follow along unless the window is mid-icon-upload.
|
||||
function handleItemSync({ entityType, entry }) {
|
||||
if (entityType !== 'item' || entry?._id !== itemId || applyingIcon.value) return;
|
||||
if (entityType !== 'item' || entry?._id !== itemId || uploadingIcon.value) return;
|
||||
form.value = normalizeItem(entry);
|
||||
}
|
||||
|
||||
@@ -73,22 +70,40 @@ async function updateItem(payload) {
|
||||
return true;
|
||||
}
|
||||
|
||||
// Choosing an icon is a window of its own: upload one from this device, or browse
|
||||
// the icon library of the linked Foundry world. Both leave their result on the
|
||||
// `campaign-entry-updated` event, which this window follows.
|
||||
function chooseIcon() {
|
||||
CreateChildWindow(id, 'item_icon_source', {
|
||||
item: { _id: itemId, name: form.value.name, image: form.value.image },
|
||||
campaign: Campaign.value?._id || ''
|
||||
});
|
||||
function pickIcon() {
|
||||
photoInput.value?.click();
|
||||
}
|
||||
|
||||
// The world's own icon for this item: the module keeps it on the item, so this
|
||||
// just switches back to it. Picking one of the world's other icons is what the
|
||||
// icon browser is for.
|
||||
async function onIconSelected(event) {
|
||||
const file = event.target.files?.[0];
|
||||
event.target.value = '';
|
||||
if (!file || uploadingIcon.value) return;
|
||||
uploadingIcon.value = true;
|
||||
error.value = '';
|
||||
try {
|
||||
const formData = new FormData();
|
||||
formData.append('image', file);
|
||||
const response = await Server().post(`/item/upload-image?item=${itemId}`, formData, {
|
||||
headers: { "Content-Type": "multipart/form-data" }
|
||||
});
|
||||
if (response.data.status !== 'ok') {
|
||||
error.value = t('campaigns.item.sheet.upload-error');
|
||||
return;
|
||||
}
|
||||
form.value = normalizeItem(response.data.item);
|
||||
emitter.emit('campaign-entry-updated', { entityType: 'item', entry: response.data.item });
|
||||
} catch (requestError) {
|
||||
error.value = t('campaigns.item.sheet.upload-error');
|
||||
} finally {
|
||||
uploadingIcon.value = false;
|
||||
}
|
||||
}
|
||||
|
||||
// "Fetch from Foundry's icons": the module keeps the world's own icon on the
|
||||
// item, so this just switches back to it.
|
||||
async function useFoundryIcon() {
|
||||
if (!canUseFoundryIcon.value || applyingIcon.value) return;
|
||||
applyingIcon.value = true;
|
||||
if (!canUseFoundryIcon.value || applyingFoundryIcon.value) return;
|
||||
applyingFoundryIcon.value = true;
|
||||
error.value = '';
|
||||
try {
|
||||
const done = await updateItem({ image: form.value.foundryImage });
|
||||
@@ -96,21 +111,18 @@ async function useFoundryIcon() {
|
||||
} catch (requestError) {
|
||||
error.value = t('campaigns.item.sheet.save-error');
|
||||
} finally {
|
||||
applyingIcon.value = false;
|
||||
applyingFoundryIcon.value = false;
|
||||
}
|
||||
}
|
||||
|
||||
async function removeIcon() {
|
||||
if (!form.value.image || applyingIcon.value) return;
|
||||
applyingIcon.value = true;
|
||||
if (!form.value.image) return;
|
||||
error.value = '';
|
||||
try {
|
||||
const done = await updateItem({ image: '' });
|
||||
if (!done) error.value = t('campaigns.item.sheet.save-error');
|
||||
} catch (requestError) {
|
||||
error.value = t('campaigns.item.sheet.save-error');
|
||||
} finally {
|
||||
applyingIcon.value = false;
|
||||
}
|
||||
}
|
||||
</script>
|
||||
@@ -120,12 +132,10 @@ async function removeIcon() {
|
||||
<WindowHandle :window="id" ref="handle" />
|
||||
<div class="item-body">
|
||||
<header class="item-hero">
|
||||
<button class="item-icon" :class="{ empty: !form.image }" type="button"
|
||||
:aria-label="$t(form.image ? 'campaigns.item.sheet.change-icon' : 'campaigns.item.sheet.choose-icon')"
|
||||
@click="chooseIcon">
|
||||
<div class="item-icon" :class="{ empty: !form.image }">
|
||||
<img v-if="form.image" :src="imageUrl" :alt="$t('campaigns.item.sheet.icon')">
|
||||
<span v-else aria-hidden="true">{{ form.name.slice(0, 1).toUpperCase() }}</span>
|
||||
</button>
|
||||
</div>
|
||||
<div class="item-identity">
|
||||
<h1>{{ form.name }}</h1>
|
||||
<div class="item-tags">
|
||||
@@ -139,13 +149,16 @@ async function removeIcon() {
|
||||
<div v-if="error" class="item-error">{{ error }}</div>
|
||||
|
||||
<div class="icon-controls">
|
||||
<button class="sheet-button" type="button" @click="chooseIcon">
|
||||
{{ form.image ? $t('campaigns.item.sheet.change-icon') : $t('campaigns.item.sheet.choose-icon') }}
|
||||
<button class="sheet-button" type="button" :disabled="uploadingIcon" @click="pickIcon">
|
||||
{{ uploadingIcon
|
||||
? $t('campaigns.item.sheet.uploading')
|
||||
: (form.image ? $t('campaigns.item.sheet.change-icon') : $t('campaigns.item.sheet.choose-icon')) }}
|
||||
</button>
|
||||
<button v-if="canUseFoundryIcon" class="sheet-button secondary" type="button" :disabled="applyingIcon" @click="useFoundryIcon">
|
||||
<button v-if="canUseFoundryIcon" class="sheet-button secondary" type="button" :disabled="applyingFoundryIcon" @click="useFoundryIcon">
|
||||
{{ $t('campaigns.item.sheet.foundry-icon') }}
|
||||
</button>
|
||||
<button v-if="form.image" class="sheet-button secondary" type="button" :disabled="applyingIcon" :aria-label="$t('campaigns.item.sheet.remove-icon')" @click="removeIcon">×</button>
|
||||
<button v-if="form.image" class="sheet-button secondary" type="button" :disabled="uploadingIcon" :aria-label="$t('campaigns.item.sheet.remove-icon')" @click="removeIcon">×</button>
|
||||
<input ref="photoInput" class="photo-input" type="file" accept="image/*" @change="onIconSelected">
|
||||
</div>
|
||||
|
||||
<dl class="item-facts">
|
||||
@@ -176,8 +189,7 @@ async function removeIcon() {
|
||||
.item-window { min-width: 0; min-height: 0; }
|
||||
.item-body { width: 100%; min-height: 0; flex: 1; overflow: auto; padding: 14px 16px 16px; box-sizing: border-box; }
|
||||
.item-hero { display: flex; align-items: center; gap: 13px; padding: 2px 2px 13px; margin-bottom: 11px; border-bottom: 1px solid var(--color-border); }
|
||||
.item-icon { width: 64px; height: 64px; flex: 0 0 64px; display: grid; place-items: center; overflow: hidden; border-radius: 10px; border: 1px solid var(--color-border); background: var(--color-background-soft); color: var(--color-link); font: 30px MrEavesRemake; padding: 0; cursor: pointer; }
|
||||
.item-icon:hover { border-color: var(--color-link); }
|
||||
.item-icon { width: 64px; height: 64px; flex: 0 0 64px; display: grid; place-items: center; overflow: hidden; border-radius: 10px; border: 1px solid var(--color-border); background: var(--color-background-soft); color: var(--color-link); font: 30px MrEavesRemake; }
|
||||
.item-icon.empty { border-style: dashed; }
|
||||
.item-icon img { width: 100%; height: 100%; object-fit: contain; }
|
||||
.item-identity { min-width: 0; }
|
||||
@@ -190,6 +202,7 @@ async function removeIcon() {
|
||||
.sheet-button { border: 1px solid var(--color-border); border-radius: 7px; padding: 7px 12px; background: var(--color-background-soft); color: var(--color-text); cursor: pointer; white-space: nowrap; font-size: 13px; }
|
||||
.sheet-button:hover { background: var(--color-button-hover); }
|
||||
.sheet-button:disabled { opacity: .55; cursor: wait; }
|
||||
.photo-input { display: none; }
|
||||
.item-facts { display: flex; flex-wrap: wrap; gap: 8px; margin: 0 0 13px; }
|
||||
.item-fact { flex: 1 1 120px; min-width: 0; padding: 9px 11px; border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft); }
|
||||
.item-fact dt { font-size: 11px; text-transform: uppercase; letter-spacing: .05em; opacity: .72; }
|
||||
|
||||
@@ -88,21 +88,6 @@ const defWindows = {
|
||||
close: () => ClearWindow({type: 'item_sheet'}),
|
||||
movable: true
|
||||
},
|
||||
item_icon_source: {
|
||||
title: 'windows.icon-source',
|
||||
component: () => import('~/components/windows/ItemIconSourceWindow.vue'),
|
||||
close: () => ClearWindow({ type: 'item_icon_source' }),
|
||||
movable: true
|
||||
},
|
||||
foundry_icons: {
|
||||
title: 'windows.foundry-icons',
|
||||
component: () => import('~/components/windows/FoundryIconPickerWindow.vue'),
|
||||
// Back closes the icon browser and leaves the chooser it was opened from,
|
||||
// which is still open behind it.
|
||||
back: () => ClearWindow({ type: 'foundry_icons' }),
|
||||
close: () => ClearWindow({ type: 'foundry_icons' }),
|
||||
movable: true
|
||||
},
|
||||
create_map: {
|
||||
title: 'windows.create-map',
|
||||
component: () => import('~/components/windows/CreateMapWindow.vue'),
|
||||
|
||||
@@ -73,11 +73,6 @@
|
||||
"foundry-icon": "Fes servir la icona del Foundry", "remove-icon": "Treu la icona", "save-error": "No s'ha pogut desar aquest objecte.",
|
||||
"no-description": "Sense descripció afegida."
|
||||
},
|
||||
"icon-picker": {
|
||||
"intro": "D'on ha de sortir la icona d'aquest objecte?",
|
||||
"upload": "Pujar una icona", "upload-hint": "Tria una imatge d'aquest dispositiu.",
|
||||
"foundry": "Carregar del Foundry", "foundry-hint": "Recorre les icones que inclou el teu món del Foundry."
|
||||
},
|
||||
"categories": {
|
||||
"weapon": "Arma", "armor": "Armadura", "shield": "Escut", "adventuring-gear": "Equip d'aventura",
|
||||
"magic-item": "Objecte màgic", "consumable": "Consumible", "tool": "Eina", "treasure": "Tresor", "other": "Altre"
|
||||
|
||||
@@ -3,15 +3,6 @@
|
||||
"link-expired": "El codi d'enllaç de Foundry no és vàlid, ha caducat o ja s'ha utilitzat.",
|
||||
"world-already-linked": "Aquest món de Foundry ja està enllaçat amb una altra campanya.",
|
||||
"actor-already-synced": "Un altre actor d'aquesta campanya ja està sincronitzat amb aquell actor del Foundry.",
|
||||
"item-already-synced": "Un altre objecte d'aquesta campanya ja està sincronitzat amb aquell objecte del Foundry.",
|
||||
"icons-unavailable": "Les icones del Foundry no són disponibles: el seu bridge no està configurat o ara mateix no hi arriba.",
|
||||
"icons-no-world-url": "Aquesta campanya no té adreça del món del Foundry. Definiu-la als ajustos de la campanya, a la pestanya d'integracions."
|
||||
},
|
||||
"icons": {
|
||||
"path": "Carpeta d'icones",
|
||||
"up": "Una carpeta amunt",
|
||||
"loading": "Carregant icones...",
|
||||
"empty": "No hi ha icones per triar en aquesta carpeta.",
|
||||
"load-more": "Carregar més icones"
|
||||
"item-already-synced": "Un altre objecte d'aquesta campanya ja està sincronitzat amb aquell objecte del Foundry."
|
||||
}
|
||||
}
|
||||
|
||||
@@ -10,7 +10,5 @@
|
||||
"create-map": "Crear mapa",
|
||||
"map-viewer": "Mapa",
|
||||
"pinned-note": "Nota fixada",
|
||||
"item-sheet": "Objecte",
|
||||
"icon-source": "Tria una icona",
|
||||
"foundry-icons": "Icones del Foundry"
|
||||
"item-sheet": "Objecte"
|
||||
}
|
||||
|
||||
@@ -77,11 +77,6 @@
|
||||
"foundry-icon": "Use Foundry icon", "remove-icon": "Remove icon", "save-error": "Unable to save this item.",
|
||||
"no-description": "No description added."
|
||||
},
|
||||
"icon-picker": {
|
||||
"intro": "Where should this item's icon come from?",
|
||||
"upload": "Upload icon", "upload-hint": "Choose an image from this device.",
|
||||
"foundry": "Load from Foundry", "foundry-hint": "Browse the icons your Foundry world ships with."
|
||||
},
|
||||
"categories": {
|
||||
"weapon": "Weapon", "armor": "Armor", "shield": "Shield", "adventuring-gear": "Adventuring gear",
|
||||
"magic-item": "Magic item", "consumable": "Consumable", "tool": "Tool", "treasure": "Treasure", "other": "Other"
|
||||
|
||||
@@ -3,15 +3,6 @@
|
||||
"link-expired": "This Foundry pairing code is invalid, expired, or already used.",
|
||||
"world-already-linked": "This Foundry world is already linked to another campaign.",
|
||||
"actor-already-synced": "Another actor in this campaign is already synced with that Foundry actor.",
|
||||
"item-already-synced": "Another item in this campaign is already synced with that Foundry item.",
|
||||
"icons-unavailable": "Foundry's icons are not available: its bridge is not set up, or it cannot be reached right now.",
|
||||
"icons-no-world-url": "This campaign has no Foundry world address. Set it under campaign settings, in the Integrations tab."
|
||||
},
|
||||
"icons": {
|
||||
"path": "Icon folder",
|
||||
"up": "One folder up",
|
||||
"loading": "Loading icons...",
|
||||
"empty": "No icons to pick in this folder.",
|
||||
"load-more": "Load more icons"
|
||||
"item-already-synced": "Another item in this campaign is already synced with that Foundry item."
|
||||
}
|
||||
}
|
||||
|
||||
@@ -10,7 +10,5 @@
|
||||
"create-map": "Create Map",
|
||||
"map-viewer": "Map",
|
||||
"pinned-note": "Pinned note",
|
||||
"item-sheet": "Item",
|
||||
"icon-source": "Choose an icon",
|
||||
"foundry-icons": "Foundry icons"
|
||||
"item-sheet": "Item"
|
||||
}
|
||||
|
||||
@@ -73,11 +73,6 @@
|
||||
"foundry-icon": "Usar el icono de Foundry", "remove-icon": "Quitar el icono", "save-error": "No se pudo guardar este objeto.",
|
||||
"no-description": "Sin descripción añadida."
|
||||
},
|
||||
"icon-picker": {
|
||||
"intro": "¿De dónde debe salir el icono de este objeto?",
|
||||
"upload": "Subir icono", "upload-hint": "Elige una imagen de este dispositivo.",
|
||||
"foundry": "Cargar desde Foundry", "foundry-hint": "Recorre los iconos que incluye tu mundo de Foundry."
|
||||
},
|
||||
"categories": {
|
||||
"weapon": "Arma", "armor": "Armadura", "shield": "Escudo", "adventuring-gear": "Equipo de aventura",
|
||||
"magic-item": "Objeto mágico", "consumable": "Consumible", "tool": "Herramienta", "treasure": "Tesoro", "other": "Otro"
|
||||
|
||||
@@ -3,15 +3,6 @@
|
||||
"link-expired": "El código de vinculación de Foundry no es válido, ha caducado o ya se ha usado.",
|
||||
"world-already-linked": "Este mundo de Foundry ya está vinculado a otra campaña.",
|
||||
"actor-already-synced": "Otro actor de esta campaña ya está sincronizado con ese actor de Foundry.",
|
||||
"item-already-synced": "Otro objeto de esta campaña ya está sincronizado con ese objeto de Foundry.",
|
||||
"icons-unavailable": "Los iconos de Foundry no están disponibles: su bridge no está configurado o no es accesible ahora.",
|
||||
"icons-no-world-url": "Esta campaña no tiene dirección del mundo de Foundry. Defínala en los ajustes de la campaña, en la pestaña de integraciones."
|
||||
},
|
||||
"icons": {
|
||||
"path": "Carpeta de iconos",
|
||||
"up": "Una carpeta arriba",
|
||||
"loading": "Cargando iconos...",
|
||||
"empty": "No hay iconos para elegir en esta carpeta.",
|
||||
"load-more": "Cargar más iconos"
|
||||
"item-already-synced": "Otro objeto de esta campaña ya está sincronizado con ese objeto de Foundry."
|
||||
}
|
||||
}
|
||||
|
||||
@@ -10,7 +10,5 @@
|
||||
"create-map": "Crear mapa",
|
||||
"map-viewer": "Mapa",
|
||||
"pinned-note": "Nota fijada",
|
||||
"item-sheet": "Objeto",
|
||||
"icon-source": "Elegir icono",
|
||||
"foundry-icons": "Iconos de Foundry"
|
||||
"item-sheet": "Objeto"
|
||||
}
|
||||
|
||||
@@ -1,170 +0,0 @@
|
||||
// Tests for Syndria98/dragonroll#65: picking an item's icon opens a window that asks
|
||||
// where the icon comes from — upload one from this device, or load one from the icon
|
||||
// library the linked Foundry world ships in its data directory's `icons/` folder.
|
||||
// That library runs into the thousands, so it is listed one folder per request, with
|
||||
// its icons paged and its thumbnails lazy to load.
|
||||
//
|
||||
// The icon listing helpers are a pure CommonJS service, so they are required and called
|
||||
// directly. The windows and the bridge live in files this repository installs no
|
||||
// dependencies for, so those checks read the sources, like tests/map-viewer.test.js does.
|
||||
//
|
||||
// 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 iconService = require(path.join(__dirname, "..", "backend", "src", "services", "foundry-icons"));
|
||||
|
||||
const windowDefsSource = read("frontend", "app", "services", "WindowDefinitions.js");
|
||||
const itemWindowSource = read("frontend", "app", "components", "windows", "ItemSheetWindow.vue");
|
||||
const sourceWindowSource = read("frontend", "app", "components", "windows", "ItemIconSourceWindow.vue");
|
||||
const foundryIconsSource = read("frontend", "app", "components", "windows", "FoundryIconPickerWindow.vue");
|
||||
const foundryRouteSource = read("backend", "src", "routes", "foundry.js");
|
||||
const bridgeSource = read("dragonroll-foundry", "bridge", "server.js");
|
||||
|
||||
// --- The listing service: what the browser may ask for, and what it gets back ------
|
||||
|
||||
test("icon listings always stay inside Foundry's icon root", () => {
|
||||
assert.equal(iconService.ICON_ROOT, "icons");
|
||||
assert.equal(iconService.normalizeIconDirectory(""), "icons");
|
||||
assert.equal(iconService.normalizeIconDirectory(undefined), "icons");
|
||||
assert.equal(iconService.normalizeIconDirectory("/icons/svg/"), "icons/svg");
|
||||
assert.equal(iconService.normalizeIconDirectory("icons/sfdcc/axes"), "icons/sfdcc/axes");
|
||||
assert.equal(iconService.normalizeIconDirectory("icons/./svg"), "icons/svg");
|
||||
// nothing that leaves `icons/` is a folder this route will list
|
||||
assert.equal(iconService.normalizeIconDirectory("icons/../secret"), null);
|
||||
assert.equal(iconService.normalizeIconDirectory("../etc"), null);
|
||||
assert.equal(iconService.normalizeIconDirectory("systems/dnd5e/icons"), null);
|
||||
assert.equal(iconService.parentIconDirectory("icons/svg/axes"), "icons/svg");
|
||||
assert.equal(iconService.parentIconDirectory("icons"), null);
|
||||
});
|
||||
|
||||
test("icons are listed a page at a time, bounded", () => {
|
||||
assert.deepEqual(iconService.readIconListingPage({}), { limit: iconService.DEFAULT_ICON_PAGE_SIZE, offset: 0 });
|
||||
assert.deepEqual(iconService.readIconListingPage({ limit: "20", offset: "240" }), { limit: 20, offset: 240 });
|
||||
// a caller cannot ask for the whole library at once, or for a page before the first
|
||||
assert.equal(iconService.readIconListingPage({ limit: "99999" }).limit, iconService.MAX_ICON_PAGE_SIZE);
|
||||
assert.equal(iconService.readIconListingPage({ offset: "-10" }).offset, 0);
|
||||
});
|
||||
|
||||
test("only image files become icons, and they load from the world's own address", () => {
|
||||
const listing = iconService.shapeIconListing({
|
||||
base: "https://vtt.example.com/",
|
||||
dir: "icons/svg",
|
||||
listing: {
|
||||
directories: ["icons/svg/creature", "icons/svg/creature", "icons/svg"],
|
||||
files: ["icons/svg/dice.svg", "icons/svg/sword.png", "icons/svg/readme.txt", "stray.md"],
|
||||
offset: 0,
|
||||
next: 120,
|
||||
},
|
||||
});
|
||||
|
||||
assert.equal(listing.dir, "icons/svg");
|
||||
assert.equal(listing.parent, "icons");
|
||||
assert.deepEqual(listing.folders.map((folder) => folder.path), ["icons/svg/creature"]);
|
||||
assert.deepEqual(listing.folders.map((folder) => folder.name), ["creature"]);
|
||||
assert.deepEqual(listing.files.map((icon) => icon.path), ["icons/svg/dice.svg", "icons/svg/sword.png"]);
|
||||
assert.equal(listing.files[0].name, "dice.svg");
|
||||
assert.equal(listing.files[0].url, "https://vtt.example.com/icons/svg/dice.svg");
|
||||
assert.equal(listing.next, 120);
|
||||
});
|
||||
|
||||
test("an icon path with spaces still gives the browser a loadable url", () => {
|
||||
assert.equal(
|
||||
iconService.joinFoundryAssetUrl("http://vtt.test:30000", "icons/sfdcc/axes/halberd sword.svg"),
|
||||
"http://vtt.test:30000/icons/sfdcc/axes/halberd%20sword.svg"
|
||||
);
|
||||
assert.equal(iconService.joinFoundryAssetUrl("", "icons/svg/dice.svg"), "");
|
||||
});
|
||||
|
||||
// --- The backend route ------------------------------------------------------------
|
||||
|
||||
test("the foundry proxy lists one icon folder for one of the caller's campaigns", () => {
|
||||
assert.match(foundryRouteSource, /router\.get\(["']\/icons["'], async \(req, res\)/);
|
||||
const route = /router\.get\(["']\/icons[\s\S]*?module\.exports/.exec(foundryRouteSource)?.[0] ?? foundryRouteSource;
|
||||
// the campaign is where the world address is kept, so it has to be the caller's own
|
||||
assert.match(route, /findOwnedCampaign\(req\.query\.campaign, req\.user\.id\)/);
|
||||
assert.match(foundryRouteSource, /Campaign\.findOne\(\{\s*_id:\s*campaignId,\s*createdBy:\s*userId\s*\}\)/);
|
||||
assert.match(route, /campaign\.settings\?\.integrations\?\.foundryUrl/);
|
||||
assert.match(route, /requestFoundry\(`api\/icons\?\$\{query\}`\)/);
|
||||
// a folder outside the icon root is refused before it reaches the Foundry host
|
||||
assert.match(route, /const dir = normalizeIconDirectory\(req\.query\.dir\);/);
|
||||
});
|
||||
|
||||
// --- The bridge on the Foundry host ------------------------------------------------
|
||||
|
||||
test("the bridge lists a core icon folder and never leaves the icon root", () => {
|
||||
assert.match(bridgeSource, /const dataPath = \(process\.env\.DRAGONROLL_FOUNDRY_DATA_PATH \|\| ""\)\.trim\(\);/);
|
||||
assert.match(bridgeSource, /if \(pathname === "\/api\/icons"\) return sendIconListing\(request, response\);/);
|
||||
assert.match(bridgeSource, /if \(!dataPath\) return sendJson\(response, 503, \{ status: "error", msg: "foundry\.errors\.icons-unavailable" \}\);/);
|
||||
const normalize = /function normalizeIconDirectory\(input\) \{[\s\S]*?\n\}/.exec(bridgeSource)?.[0] ?? "";
|
||||
assert.match(normalize, /segments\.includes\("\.\."\) \|\| segments\[0\] !== iconRoot/);
|
||||
// the answer is one folder plus the offset of the next page of its icons
|
||||
assert.match(bridgeSource, /directories\.sort\(\(a, b\) => a\.localeCompare\(b\)\);/);
|
||||
assert.match(bridgeSource, /const page = files\.slice\(offset, offset \+ limit\);/);
|
||||
assert.match(bridgeSource, /next: offset \+ page\.length < files\.length \? offset \+ page\.length : null,/);
|
||||
});
|
||||
|
||||
// --- The windows -------------------------------------------------------------------
|
||||
|
||||
test("choosing an icon opens its own window from the item sheet", () => {
|
||||
assert.match(windowDefsSource, /item_icon_source:\s*{\s*title:[^}]*ItemIconSourceWindow\.vue/s);
|
||||
assert.match(windowDefsSource, /foundry_icons:\s*{\s*title:[^}]*FoundryIconPickerWindow\.vue/s);
|
||||
// the item window asks where the icon comes from instead of opening a file dialog
|
||||
assert.match(itemWindowSource, /CreateChildWindow\(id, ['"]item_icon_source['"]/);
|
||||
assert.doesNotMatch(itemWindowSource, /type="file"/);
|
||||
});
|
||||
|
||||
test("the icon source window offers uploading and Foundry, and uploads the local file", () => {
|
||||
assert.match(sourceWindowSource, /\$t\(['"]campaigns\.item\.icon-picker\.upload['"]\)/);
|
||||
assert.match(sourceWindowSource, /\$t\(['"]campaigns\.item\.icon-picker\.foundry['"]\)/);
|
||||
// upload: a local file, sent through the item route like the character sheet does its photo
|
||||
assert.match(sourceWindowSource, /type="file" accept="image\/\*"/);
|
||||
assert.match(sourceWindowSource, /\/item\/upload-image\?item=\$\{itemId\}/);
|
||||
assert.match(sourceWindowSource, /formData\.append\(['"]image['"], file\)/);
|
||||
// and it hands the item over to the icon browser, as its child window
|
||||
assert.match(sourceWindowSource, /CreateChildWindow\(id, ['"]foundry_icons['"]/);
|
||||
});
|
||||
|
||||
test("the icon browser browses the world's icons folder by folder", () => {
|
||||
assert.match(foundryIconsSource, /\/foundry\/icons\?\$\{params\.toString\(\)\}/);
|
||||
// one folder per request: navigating a folder asks for it, and going up asks for its parent
|
||||
assert.match(foundryIconsSource, /Load\(ICON_ROOT\)/);
|
||||
assert.match(foundryIconsSource, /@click="Load\(folder\.path\)"/);
|
||||
assert.match(foundryIconsSource, /Load\(listing\.value\.parent \|\| ICON_ROOT\)/);
|
||||
// lazy in every way that matters: a page of icons at a time, thumbnails fetched when seen
|
||||
assert.match(foundryIconsSource, /if \(offset\) params\.set\(['"]offset['"], String\(offset\)\)/);
|
||||
assert.match(foundryIconsSource, /@click="Load\(listing\.dir, listing\.next\)"/);
|
||||
assert.match(foundryIconsSource, /loading="lazy"/);
|
||||
// picking an icon stores the world's url and tells the item window about it
|
||||
assert.match(foundryIconsSource, /Server\(\)\.post\(['"]\/item\/update['"], \{ id: itemId, image: icon\.url \}\)/);
|
||||
assert.match(foundryIconsSource, /emitter\.emit\(['"]campaign-entry-updated['"], \{ entityType: ['"]item['"], entry: response\.data\.item \}\)/);
|
||||
assert.match(foundryIconsSource, /ClearWindow\(\{ type: ['"]item_icon_source['"] \}\)/);
|
||||
});
|
||||
|
||||
// --- Strings -----------------------------------------------------------------------
|
||||
|
||||
test("every locale names the icon windows and their controls", () => {
|
||||
for (const locale of ["en", "es", "ca"]) {
|
||||
const windows = JSON.parse(read("frontend", "i18n", "locales", locale, "windows.json"));
|
||||
for (const key of ["icon-source", "foundry-icons"]) {
|
||||
assert.ok(windows[key], `${locale} is missing the ${key} window title`);
|
||||
}
|
||||
|
||||
const campaigns = JSON.parse(read("frontend", "i18n", "locales", locale, "campaigns.json"));
|
||||
for (const key of ["intro", "upload", "upload-hint", "foundry", "foundry-hint"]) {
|
||||
assert.ok(campaigns.item?.["icon-picker"]?.[key], `${locale} is missing campaigns.item.icon-picker.${key}`);
|
||||
}
|
||||
|
||||
const foundry = JSON.parse(read("frontend", "i18n", "locales", locale, "foundry.json"));
|
||||
for (const key of ["loading", "empty", "load-more", "up"]) {
|
||||
assert.ok(foundry.icons?.[key], `${locale} is missing foundry.icons.${key}`);
|
||||
}
|
||||
for (const key of ["icons-unavailable", "icons-no-world-url"]) {
|
||||
assert.ok(foundry.errors?.[key], `${locale} is missing foundry.errors.${key}`);
|
||||
}
|
||||
}
|
||||
});
|
||||
@@ -1,9 +1,7 @@
|
||||
// Tests for item folders following the Foundry world into the campaign
|
||||
// (Syndria98/dragonroll#44): the world's item directory is grouped into folders, and
|
||||
// Dragonroll mirrors that tree as Folders of target 'item' and files the synced items
|
||||
// in them, so its item list reads like the world's. And for those folders' colours
|
||||
// going both ways (Syndria98/dragonroll#57): the world's colour arrives with its tree,
|
||||
// and the one the campaign picks travels back on the folder list the module reads.
|
||||
// in them, so its item list reads like the world's.
|
||||
//
|
||||
// The repository root installs no dependencies, so each side is loaded the way the
|
||||
// other tests do it. The sync route runs against a stubbed `require` (express,
|
||||
@@ -57,7 +55,7 @@ function matches(document, filter = {}) {
|
||||
});
|
||||
}
|
||||
|
||||
function fakeModel(table, seed = []) {
|
||||
function fakeModel(table, seed = [], campaignId) {
|
||||
const rows = [];
|
||||
let counter = 0;
|
||||
|
||||
@@ -76,7 +74,9 @@ function fakeModel(table, seed = []) {
|
||||
Object.defineProperty(Document.prototype, "id", { get() { return this._id; } });
|
||||
|
||||
for (const data of seed) {
|
||||
const row = new Document({ [table === "folder" ? "target" : "name"]: undefined, ...data });
|
||||
// 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, [table === "folder" ? "target" : "name"]: undefined, ...data });
|
||||
row.isNew = false;
|
||||
rows.push(row);
|
||||
}
|
||||
@@ -122,19 +122,17 @@ function loadSyncRoute({ seed = {}, worldId = "world-1" } = {}) {
|
||||
post: (route, ...handlers) => routes.set(`POST ${route}`, handlers),
|
||||
};
|
||||
const campaign = { _id: "campaign-1", id: "campaign-1", name: "Test Campaign", foundryWorldId: worldId };
|
||||
// Every row belongs to the campaign the sync token belongs to, like every real row
|
||||
// does: the sync looks its rows up by campaign, so a seeded row without one would be
|
||||
// invisible to it and a test would pass without touching what it means to check.
|
||||
const seeded = (rows = []) => rows.map((row) => ({ campaign: campaign._id, ...row }));
|
||||
const models = {
|
||||
"../models/Actor": fakeModel("actor", seeded(seed.actors)),
|
||||
"../models/Item": fakeModel("item", seeded(seed.items)),
|
||||
"../models/Folder": fakeModel("folder", seeded(seed.folders)),
|
||||
"../models/Actor": fakeModel("actor", seed.actors, campaign.id),
|
||||
"../models/Item": fakeModel("item", seed.items, campaign.id),
|
||||
"../models/Folder": fakeModel("folder", seed.folders, campaign.id),
|
||||
};
|
||||
|
||||
const requireStub = (id) => {
|
||||
if (id === "express") return { Router: () => router };
|
||||
if (id.startsWith("node:")) return require(id); // crypto: the sync token is hashed, not stubbed
|
||||
// The route hashes the sync token with node's own crypto: the real module costs nothing
|
||||
// to hand it, and nothing here depends on what the hash looks like.
|
||||
if (id === "node:crypto") return require("node:crypto");
|
||||
if (id === "mongoose") return { isValidObjectId: (value) => typeof value === "string" && value.length > 20 };
|
||||
if (id === "../models/Campaign") return { findOne: async () => campaign };
|
||||
if (id === "../services/actor-foundry") return { foundryActorToCharacter: (actor) => ({ name: actor?.name ?? "" }) };
|
||||
@@ -297,74 +295,6 @@ test("an item the world moved out of a folder follows it to the root", async ()
|
||||
assert.equal(sync.models["../models/Item"].rows[0].folder, null);
|
||||
});
|
||||
|
||||
test("a folder coloured in the world is coloured in the campaign", async () => {
|
||||
const sync = loadSyncRoute();
|
||||
|
||||
await sync.call("POST /sync/item-snapshot", {
|
||||
worldId: "world-1",
|
||||
items: [],
|
||||
folders: [{ id: "folder-melee", name: "Melee Weapons", parent: null, color: "#7f00ff" }],
|
||||
});
|
||||
|
||||
assert.equal(sync.models["../models/Folder"].rows[0].color, "#7f00ff");
|
||||
});
|
||||
|
||||
test("a folder the world leaves uncoloured takes the campaign's colour off", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: {
|
||||
folders: [{ _id: "folder-1", target: "item", foundryFolderId: "folder-melee", name: "Melee Weapons", color: "#7f00ff" }],
|
||||
},
|
||||
});
|
||||
|
||||
await sync.call("POST /sync/item-snapshot", {
|
||||
worldId: "world-1",
|
||||
items: [],
|
||||
folders: [{ id: "folder-melee", name: "Melee Weapons", parent: null, color: null }],
|
||||
});
|
||||
|
||||
assert.equal(sync.models["../models/Folder"].rows[0].color, null, "the world has no colour to show, so neither does the campaign");
|
||||
});
|
||||
|
||||
test("a module that says nothing about colours leaves the campaign's colour alone", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: {
|
||||
folders: [{ _id: "folder-1", target: "item", foundryFolderId: "folder-melee", name: "Melee Weapons", color: "#7f00ff" }],
|
||||
},
|
||||
});
|
||||
|
||||
// A tree pushed by a module that knows folders but not their colours: no colour at all.
|
||||
await sync.call("POST /sync/snapshot", {
|
||||
worldId: "world-1",
|
||||
actors: [],
|
||||
items: [],
|
||||
folders: [{ id: "folder-melee", name: "Melee Weapons", parent: null }],
|
||||
});
|
||||
|
||||
assert.equal(sync.models["../models/Folder"].rows[0].color, "#7f00ff");
|
||||
});
|
||||
|
||||
test("the folder list the world reads back carries the colours the campaign picked", async () => {
|
||||
const sync = loadSyncRoute({
|
||||
seed: {
|
||||
folders: [
|
||||
{ _id: "folder-1", target: "item", foundryFolderId: "folder-melee", name: "Melee Weapons", color: "#0080ff" },
|
||||
{ _id: "folder-2", target: "item", name: "Homebrew" },
|
||||
{ _id: "folder-3", name: "Chapter 1" },
|
||||
],
|
||||
items: [{ _id: "item-1", name: "Longsword", foundryItemId: "item-1", folder: "folder-1" }],
|
||||
},
|
||||
});
|
||||
|
||||
const response = await sync.call("GET /sync/items");
|
||||
|
||||
assert.equal(response.status, "ok");
|
||||
assert.equal(response.items.length, 1);
|
||||
const coloured = response.folders.find((folder) => folder._id === "folder-1");
|
||||
assert.equal(coloured.foundryFolderId, "folder-melee", "the world's folder to write the colour back to");
|
||||
assert.equal(coloured.color, "#0080ff");
|
||||
assert.ok(!response.folders.some((folder) => folder._id === "folder-3"), "only the item list's folders travel back");
|
||||
});
|
||||
|
||||
test("every folder listing says which campaign list it belongs to", () => {
|
||||
// The sidebar's four lists share the Folder model, so a listing that names no target
|
||||
// would show folders of the other lists between its own rows. The note routes and
|
||||
@@ -373,9 +303,12 @@ test("every folder listing says which campaign list it belongs to", () => {
|
||||
// field existed carry none at all. tests/entry-folders.test.js runs these routes.
|
||||
for (const route of ["note.js", "folder.js"]) {
|
||||
const source = read("backend", "src", "routes", route);
|
||||
const listings = source.match(/Folder\.find\(/g) ?? [];
|
||||
// The listings that gather a campaign's folders are the ones shown as a section's
|
||||
// tree. A walk of one folder's own children (`parentFolder`) is inside a single
|
||||
// list already: folders are only ever nested within their own section.
|
||||
const listings = source.match(/Folder\.find\(\{\s*campaign/g) ?? [];
|
||||
assert.ok(listings.length, `${route} lists folders`);
|
||||
const filtered = source.match(/Folder\.find\(\{[^{]*Folder\.filterForTarget\((?:'note'|target)\)/g) ?? [];
|
||||
const filtered = source.match(/Folder\.find\(\{\s*campaign[^{]*Folder\.filterForTarget\((?:'note'|target)\)/g) ?? [];
|
||||
assert.equal(filtered.length, listings.length, `${route} has a folder listing that names no campaign list`);
|
||||
}
|
||||
});
|
||||
@@ -395,40 +328,15 @@ function makeWorld() {
|
||||
registered: new Map(),
|
||||
requests: [],
|
||||
timers: new Map(),
|
||||
intervals: new Map(),
|
||||
// What Dragonroll answers a folder reconcile with: the campaign's folders and the
|
||||
// colours its user gave them.
|
||||
remoteFolders: [],
|
||||
nextTimerId: 1,
|
||||
};
|
||||
|
||||
// Foundry's `update` takes dotted paths ("flags.dragonroll-foundry.itemId"); an
|
||||
// embedded update names the row to write them on, so `_id` is not a path to set.
|
||||
function writeFoundryPaths(target, data) {
|
||||
for (const [key, value] of Object.entries(data)) {
|
||||
if (key === "_id") continue;
|
||||
const parts = key.split(".");
|
||||
const last = parts.pop();
|
||||
let node = target;
|
||||
for (const part of parts) node = node[part] ??= {};
|
||||
node[last] = value;
|
||||
}
|
||||
return target;
|
||||
}
|
||||
|
||||
// A Folder document, plain data and the `update` both the GM and Dragonroll write with.
|
||||
const makeFolder = (id, name, over = {}) => ({
|
||||
id, name, type: "Item", parent: null, color: null, documentName: "Folder",
|
||||
async update(data) { return writeFoundryPaths(this, data); },
|
||||
...over,
|
||||
});
|
||||
|
||||
const folders = [
|
||||
makeFolder("folder-melee", "Melee Weapons", { color: "#8b0000" }),
|
||||
makeFolder("folder-ranged", "Ranged Weapons", { parent: "folder-melee" }),
|
||||
{ id: "folder-melee", name: "Melee Weapons", type: "Item", parent: null, documentName: "Folder" },
|
||||
{ id: "folder-ranged", name: "Ranged Weapons", type: "Item", parent: "folder-melee", documentName: "Folder" },
|
||||
// An actor's own inventory folder: it hangs off the actor, not the world.
|
||||
makeFolder("folder-carried", "Carried", { parent: { id: "actor-1", documentName: "Actor" } }),
|
||||
makeFolder("folder-journal", "Lore", { type: "JournalEntry" }),
|
||||
{ id: "folder-carried", name: "Carried", type: "Item", parent: { id: "actor-1", documentName: "Actor" }, documentName: "Folder" },
|
||||
{ id: "folder-journal", name: "Lore", type: "JournalEntry", parent: null, documentName: "Folder" },
|
||||
];
|
||||
const items = [
|
||||
{
|
||||
@@ -454,15 +362,10 @@ function makeWorld() {
|
||||
id: "actor-1", name: "Thalia", type: "character", documentName: "Actor", flags: {},
|
||||
items: { contents: [carriedItem] },
|
||||
getFlag() { return undefined; },
|
||||
async update(data) { return writeFoundryPaths(this, data); },
|
||||
// Embedded documents are written through the document holding them, and each
|
||||
// update names the row it belongs to.
|
||||
async updateEmbeddedDocuments(_kind, updates) {
|
||||
for (const update of updates) {
|
||||
if (carriedItem.id === update._id) writeFoundryPaths(carriedItem, update);
|
||||
}
|
||||
return [];
|
||||
},
|
||||
// A pushed actor has its items marked as synced and itself mapped to the
|
||||
// campaign row: nothing here reads those flags back.
|
||||
async update() { return this; },
|
||||
async updateEmbeddedDocuments() { return []; },
|
||||
toObject() { return { _id: this.id, name: this.name, type: this.type, flags: this.flags }; },
|
||||
},
|
||||
];
|
||||
@@ -484,24 +387,15 @@ function makeWorld() {
|
||||
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.nextTimerId++;
|
||||
state.intervals.set(id, { fn, delay });
|
||||
return id;
|
||||
},
|
||||
clearInterval: (id) => state.intervals.delete(id),
|
||||
setInterval: () => 0,
|
||||
clearInterval: () => {},
|
||||
fetch: async (url, options = {}) => {
|
||||
const href = String(url);
|
||||
state.requests.push({
|
||||
href,
|
||||
href: String(url),
|
||||
method: options.method,
|
||||
body: options.body ? JSON.parse(options.body) : null,
|
||||
});
|
||||
const payload = { status: "ok", actors: [], items: [] };
|
||||
if (href.includes("foundry/sync/items")) payload.folders = state.remoteFolders;
|
||||
return { ok: true, status: 200, json: async () => payload };
|
||||
return { ok: true, status: 200, json: async () => ({ status: "ok", actors: [], items: [] }) };
|
||||
},
|
||||
Actor: { async create() { return null; } },
|
||||
Item: { async create() { return null; } },
|
||||
@@ -552,12 +446,6 @@ function makeWorld() {
|
||||
await drain();
|
||||
}
|
||||
};
|
||||
// The reconciles `setInterval` registered: what runs every few seconds on a world
|
||||
// that is linked, and so what carries Dragonroll's folder colours back into the world.
|
||||
state.runIntervals = async () => {
|
||||
for (const interval of [...state.intervals.values()]) await interval.fn();
|
||||
await drain();
|
||||
};
|
||||
state.linkedSetup = async () => {
|
||||
await state.fire("init");
|
||||
await state.fire("ready");
|
||||
@@ -578,9 +466,9 @@ test("the world sends its item folder tree with a snapshot", async () => {
|
||||
const [push] = world.pushes("foundry/sync/snapshot");
|
||||
assert.ok(push, "the actor change pushed a snapshot");
|
||||
assert.deepEqual(push.body.folders, [
|
||||
{ id: "folder-melee", name: "Melee Weapons", parent: null, color: "#8b0000" },
|
||||
{ id: "folder-ranged", name: "Ranged Weapons", parent: "folder-melee", color: null },
|
||||
], "the item directory tree, nested and coloured, without the actor's own or another type's folders");
|
||||
{ id: "folder-melee", name: "Melee Weapons", parent: null },
|
||||
{ id: "folder-ranged", name: "Ranged Weapons", parent: "folder-melee" },
|
||||
], "the item directory tree, nested, without the actor's own or another type's folders");
|
||||
const longsword = push.body.items.find((item) => item._id === "item-1");
|
||||
assert.equal(longsword.dragonroll.folder, "folder-melee", "a world item says which folder it stands in");
|
||||
const torch = push.body.items.find((item) => item._id === "item-2");
|
||||
@@ -625,21 +513,6 @@ test("a folder change reaches Dragonroll without pushing the items in it", async
|
||||
]);
|
||||
});
|
||||
|
||||
test("a folder the GM colours sends its colour with the tree", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
|
||||
const ranged = world.folder("folder-ranged");
|
||||
ranged.color = "#123456";
|
||||
await world.fire("updateFolder", ranged);
|
||||
await world.runTimers();
|
||||
|
||||
const [push] = world.pushes("foundry/sync/item-snapshot");
|
||||
assert.deepEqual(push.body.folders.map((folder) => [folder.id, folder.color]), [
|
||||
["folder-melee", "#8b0000"],
|
||||
["folder-ranged", "#123456"],
|
||||
], "every folder reports the colour the world shows for it, `null` for one it left uncoloured");
|
||||
});
|
||||
|
||||
test("a folder of another document type does not touch the item list", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
|
||||
@@ -660,48 +533,8 @@ test("autosync off: folder changes stop syncing", async () => {
|
||||
assert.deepEqual(world.syncRequests(), []);
|
||||
});
|
||||
|
||||
// --- The colours the campaign gives those folders travel back to the world ---------
|
||||
|
||||
test("a folder coloured in the Dragonroll campaign is coloured in the world", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
|
||||
world.remoteFolders = [
|
||||
{ _id: "db-melee", name: "Melee Weapons", foundryFolderId: "folder-melee", color: "#0080ff" },
|
||||
// A folder the campaign made for its own items: there is no world document to colour.
|
||||
{ _id: "db-homebrew", name: "Homebrew", color: "#00ff00" },
|
||||
];
|
||||
await world.runIntervals();
|
||||
|
||||
assert.equal(world.folder("folder-melee").color, "#0080ff");
|
||||
assert.equal(world.folder("folder-ranged").color, null, "a folder the campaign says nothing about keeps what the world shows");
|
||||
assert.deepEqual(world.requests.filter((request) => request.method === "POST"), [],
|
||||
"Dragonroll's own write is not pushed back to the campaign as a world change");
|
||||
});
|
||||
|
||||
test("a colour taken off in the campaign comes off the world's folder", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
|
||||
world.remoteFolders = [{ _id: "db-melee", name: "Melee Weapons", foundryFolderId: "folder-melee", color: null }];
|
||||
await world.runIntervals();
|
||||
|
||||
assert.equal(world.folder("folder-melee").color, null, "uncoloured in the campaign is uncoloured in the world");
|
||||
});
|
||||
|
||||
test("autosync off: the campaign's folder colours are not written into the world", async () => {
|
||||
const world = await makeWorld().linkedSetup();
|
||||
await world.game.settings.set("dragonroll-foundry", "autoSync", false);
|
||||
|
||||
world.remoteFolders = [{ _id: "db-melee", name: "Melee Weapons", foundryFolderId: "folder-melee", color: "#0080ff" }];
|
||||
await world.runIntervals();
|
||||
|
||||
assert.equal(world.folder("folder-melee").color, "#8b0000", "the world keeps what it shows while autosync is off");
|
||||
});
|
||||
|
||||
// --- The sidebar groups its items under those folders ----------------------------
|
||||
|
||||
// `vm.compileFunction` is synchronous, so the service is ready right away. Loading it with
|
||||
// a top-level `await` instead makes Node read this whole file as an ES module, where
|
||||
// `require` is not defined and none of these tests run at all.
|
||||
function loadItemFoldersService() {
|
||||
const source = read("frontend", "app", "services", "ItemFolders.js").replace("export { BuildItemRows };", "return { BuildItemRows };");
|
||||
return vm.compileFunction(source)();
|
||||
@@ -725,13 +558,15 @@ test("items are grouped under the folder they stand in, nested", () => {
|
||||
row.kind, row.kind === "folder" ? row.folder.name : row.item.name, row.depth,
|
||||
]);
|
||||
|
||||
// Every folder is followed by what stands in it, one step deeper, and the items that
|
||||
// stand at the root come last (see BuildItemRows).
|
||||
assert.deepEqual(shape, [
|
||||
["folder", "Melee Weapons", 0],
|
||||
["item", "Longsword", 1],
|
||||
["folder", "Ranged Weapons", 0],
|
||||
["folder", "Powder Weapons", 1],
|
||||
["item", "Pistol", 1],
|
||||
["item", "Pistol", 2],
|
||||
["item", "Torch", 0],
|
||||
["item", "Longsword", 1],
|
||||
]);
|
||||
});
|
||||
|
||||
@@ -758,9 +593,9 @@ test("an item whose folder is gone, or a folder nested in itself, reads as a roo
|
||||
);
|
||||
|
||||
const shape = rows.map((row) => [row.kind, row.kind === "folder" ? row.folder.name : row.item.name]);
|
||||
assert.ok(shape.includes(["item", "Torch"]), "the item is not lost with the folder that was removed");
|
||||
assert.ok(shape.some(([kind, name]) => kind === "item" && name === "Torch"), "the item is not lost with the folder that was removed");
|
||||
assert.deepEqual(new Set(shape.filter(([kind]) => kind === "folder").map(([, name]) => name)), new Set(["A", "B"]));
|
||||
assert.equal(rows.filter(([kind]) => kind === "folder").length, 2, "a broken tree is walked once, not forever");
|
||||
assert.equal(shape.filter(([kind]) => kind === "folder").length, 2, "a broken tree is walked once, not forever");
|
||||
});
|
||||
|
||||
test("every locale labels the folder row", () => {
|
||||
|
||||
@@ -66,8 +66,8 @@ test("the item routes accept the icon and upload one", () => {
|
||||
test("the item info window is registered and opens on a sidebar click", () => {
|
||||
assert.match(windowDefsSource, /item_sheet:\s*{\s*title:[^}]*ItemSheetWindow\.vue/s);
|
||||
// clicking (or Enter/Space on) an item row opens the window instead of expanding inline.
|
||||
// Since #44 the rows come from the folder tree the world synced, so the row holds the item.
|
||||
assert.match(sidebarSource, /v-for="row in itemRows"[\s\S]*?@click="openItemSheet\(row\.item\)"/);
|
||||
// The rows come from the item list's folder tree, so the row holds the item.
|
||||
assert.match(sidebarSource, /v-for="row in entryRows\.item\.value"[\s\S]*?@click="openItemSheet\(row\.item\)"/);
|
||||
assert.match(sidebarSource, /CreateWindow\(['"]item_sheet['"],\s*\{ item \}\)/);
|
||||
assert.doesNotMatch(sidebarSource, /toggleEntryDetails/);
|
||||
});
|
||||
@@ -77,10 +77,8 @@ test("the item window shows the info and offers both icon sources", () => {
|
||||
for (const key of ["form.name", "form.category", "form.rarity", "form.quantity", "form.weight", "form.properties", "form.description"]) {
|
||||
assert.ok(itemWindowSource.includes(key), `expected the window to render ${key}`);
|
||||
}
|
||||
// own icon: #65 moved picking one into a window of its own, which uploads through
|
||||
// the item route (see tests/foundry-icon-picker.test.js); the sheet opens it and
|
||||
// follows whatever the choice leaves behind.
|
||||
assert.match(itemWindowSource, /CreateChildWindow\(id, ['"]item_icon_source['"]/);
|
||||
// own icon: upload through the item route like the character sheet does its photo
|
||||
assert.match(itemWindowSource, /\/item\/upload-image\?item=/);
|
||||
// Foundry icon: switch the item image back to the one the world sent
|
||||
assert.match(itemWindowSource, /form\.value\.foundryImage/);
|
||||
assert.match(itemWindowSource, /updateItem\(\{ image: form\.value\.foundryImage \}\)/);
|
||||
|
||||
@@ -85,6 +85,9 @@ function loadMapRoutes({ ownsCampaign = true, maps = [], notes = [] } = {}) {
|
||||
},
|
||||
// The pins do not ask after actors, only the token routes below do.
|
||||
"../models/Actor": { findOne: () => mongooseQuery(null) },
|
||||
// The map list's own folder tree: `/list` reads it and `/update` checks a move
|
||||
// against it, so the pins need the model to answer, never what it answers.
|
||||
"../models/Folder": { find: () => mongooseQuery([]), belongsToSection: async () => true },
|
||||
});
|
||||
}
|
||||
|
||||
@@ -181,7 +184,12 @@ function loadNoteRoutes({ ownsCampaign = true, notes = [], folders = [], deleted
|
||||
findById: (id) => mongooseQuery(notes.find((note) => note._id === id) ?? null),
|
||||
deleteOne: () => mongooseQuery({ deletedCount }),
|
||||
},
|
||||
"../models/Folder": { find: () => mongooseQuery(folders) },
|
||||
"../models/Folder": {
|
||||
find: () => mongooseQuery(folders),
|
||||
// models/Folder.js: the note tree is every folder that is not one of the other
|
||||
// campaign lists, whose rows carry no target at all.
|
||||
filterForTarget: (target) => (target === "note" ? { target: { $nin: ["actor", "item", "map"] } } : { target }),
|
||||
},
|
||||
"../models/Map": {
|
||||
// The driver drops the pins of the note from every map holding one; what is worth
|
||||
// keeping here is the filter it is asked to do that with.
|
||||
|
||||
@@ -82,6 +82,9 @@ function loadMapRoutes({ ownsCampaign = true, maps = [], actors = [] } = {}) {
|
||||
: null
|
||||
),
|
||||
},
|
||||
// The map list's own folder tree: `/list` reads it and `/update` checks a move
|
||||
// against it, so the tokens need the model to answer, never what it answers.
|
||||
"../models/Folder": { find: () => mongooseQuery([]), belongsToSection: async () => true },
|
||||
});
|
||||
}
|
||||
|
||||
@@ -188,6 +191,8 @@ function loadActorRoutes({ ownsCampaign = true, actors = [], deletedCount = 1 }
|
||||
return { modifiedCount: 1 };
|
||||
},
|
||||
},
|
||||
// The actor list's own folder tree, which the delete does not ask after.
|
||||
"../models/Folder": { find: () => mongooseQuery([]), belongsToSection: async () => true },
|
||||
});
|
||||
return { api, tokensPulled };
|
||||
}
|
||||
@@ -299,10 +304,14 @@ function mapViewerTokenWiringTests() {
|
||||
const sidebar = readRepoFile("frontend", "app", "components", "partials", "ContentSidebar.vue");
|
||||
|
||||
test("an actor row of the sidebar can be dragged out of it", () => {
|
||||
const actorRow = /<div v-for="actor in actors"[^>]*>/.exec(sidebar)?.[0];
|
||||
// The actors' block of the sidebar: since the entry lists got their folders the rows
|
||||
// come from that tree, so the actor row holds its actor as `row.item`.
|
||||
const actorSection = /<template v-else-if="activeSection === 'actors'">([\s\S]*?)<\/template>\s*\n\s*<template v-else-if="activeSection === 'items'">/
|
||||
.exec(sidebar)?.[1] ?? "";
|
||||
const actorRow = /<div v-else class="entity-entry"[^>]*>/.exec(actorSection)?.[0];
|
||||
assert.ok(actorRow, "expected the actor rows of the sidebar");
|
||||
assert.match(actorRow, /draggable="true"/);
|
||||
assert.match(actorRow, /@dragstart="startActorDrag\(\$event, actor\)"/);
|
||||
assert.match(actorRow, /@dragstart="startActorDrag\(\$event, row\.item\)"/);
|
||||
assert.match(sidebar, /setData\(ACTOR_DRAG_TYPE, String\(actor\._id\)\)/);
|
||||
});
|
||||
|
||||
|
||||
Reference in New Issue
Block a user