Fix #65: Item selecting icon #73

Closed
Agent wants to merge 1 commits from ai/issue-65 into master
20 changed files with 823 additions and 59 deletions

View File

@@ -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`
- `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
## 4. Service integrations (Foundry, Discord, Obsidian)

View File

@@ -1,6 +1,16 @@
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 {
@@ -24,4 +34,38 @@ 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;

View File

@@ -0,0 +1,110 @@
// 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
};

View File

@@ -135,6 +135,9 @@ 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
```
@@ -170,6 +173,7 @@ 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,
@@ -177,6 +181,13 @@ 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.

View File

@@ -1,4 +1,6 @@
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";
@@ -12,6 +14,9 @@ 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.");
@@ -106,6 +111,80 @@ 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" });
@@ -188,6 +267,10 @@ 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;

View File

@@ -0,0 +1,166 @@
<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>

View File

@@ -0,0 +1,128 @@
<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>

View File

@@ -1,9 +1,10 @@
<script setup>
import { computed, onBeforeUnmount, onMounted, ref } from 'vue';
import { useI18n } from 'vue-i18n';
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top } from '@/services/Windows';
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top, CreateChildWindow } 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']);
@@ -12,9 +13,10 @@ const itemId = props.data.item?._id;
const handle = ref(null);
const wrapper = ref(null);
const error = ref('');
const uploadingIcon = ref(false);
const applyingFoundryIcon = ref(false);
const photoInput = ref(null);
// 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 { t } = useI18n();
function normalizeItem(item) {
@@ -44,9 +46,10 @@ onMounted(() => {
onBeforeUnmount(() => ClearWindow({ type: 'item_sheet' }));
// The sidebar keeps this entry fresh (Foundry sync lands in the background);
// follow along unless the window is mid-icon-upload.
// follow along unless this window is mid-icon-change. The icon windows leave
// their result here, on the same event.
function handleItemSync({ entityType, entry }) {
if (entityType !== 'item' || entry?._id !== itemId || uploadingIcon.value) return;
if (entityType !== 'item' || entry?._id !== itemId || applyingIcon.value) return;
form.value = normalizeItem(entry);
}
@@ -70,40 +73,22 @@ async function updateItem(payload) {
return true;
}
function pickIcon() {
photoInput.value?.click();
// 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 || ''
});
}
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.
// 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 useFoundryIcon() {
if (!canUseFoundryIcon.value || applyingFoundryIcon.value) return;
applyingFoundryIcon.value = true;
if (!canUseFoundryIcon.value || applyingIcon.value) return;
applyingIcon.value = true;
error.value = '';
try {
const done = await updateItem({ image: form.value.foundryImage });
@@ -111,18 +96,21 @@ async function useFoundryIcon() {
} catch (requestError) {
error.value = t('campaigns.item.sheet.save-error');
} finally {
applyingFoundryIcon.value = false;
applyingIcon.value = false;
}
}
async function removeIcon() {
if (!form.value.image) return;
if (!form.value.image || applyingIcon.value) return;
applyingIcon.value = true;
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>
@@ -132,10 +120,12 @@ async function removeIcon() {
<WindowHandle :window="id" ref="handle" />
<div class="item-body">
<header class="item-hero">
<div class="item-icon" :class="{ empty: !form.image }">
<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">
<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>
</div>
</button>
<div class="item-identity">
<h1>{{ form.name }}</h1>
<div class="item-tags">
@@ -149,16 +139,13 @@ async function removeIcon() {
<div v-if="error" class="item-error">{{ error }}</div>
<div class="icon-controls">
<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 class="sheet-button" type="button" @click="chooseIcon">
{{ 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="applyingFoundryIcon" @click="useFoundryIcon">
<button v-if="canUseFoundryIcon" class="sheet-button secondary" type="button" :disabled="applyingIcon" @click="useFoundryIcon">
{{ $t('campaigns.item.sheet.foundry-icon') }}
</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">
<button v-if="form.image" class="sheet-button secondary" type="button" :disabled="applyingIcon" :aria-label="$t('campaigns.item.sheet.remove-icon')" @click="removeIcon">×</button>
</div>
<dl class="item-facts">
@@ -189,7 +176,8 @@ 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; }
.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.empty { border-style: dashed; }
.item-icon img { width: 100%; height: 100%; object-fit: contain; }
.item-identity { min-width: 0; }
@@ -202,7 +190,6 @@ 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; }

View File

@@ -88,6 +88,21 @@ 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'),

View File

@@ -73,6 +73,11 @@
"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"

View File

@@ -3,6 +3,15 @@
"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."
"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"
}
}

View File

@@ -10,5 +10,7 @@
"create-map": "Crear mapa",
"map-viewer": "Mapa",
"pinned-note": "Nota fixada",
"item-sheet": "Objecte"
"item-sheet": "Objecte",
"icon-source": "Tria una icona",
"foundry-icons": "Icones del Foundry"
}

View File

@@ -77,6 +77,11 @@
"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"

View File

@@ -3,6 +3,15 @@
"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."
"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"
}
}

View File

@@ -10,5 +10,7 @@
"create-map": "Create Map",
"map-viewer": "Map",
"pinned-note": "Pinned note",
"item-sheet": "Item"
"item-sheet": "Item",
"icon-source": "Choose an icon",
"foundry-icons": "Foundry icons"
}

View File

@@ -73,6 +73,11 @@
"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"

View File

@@ -3,6 +3,15 @@
"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."
"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"
}
}

View File

@@ -10,5 +10,7 @@
"create-map": "Crear mapa",
"map-viewer": "Mapa",
"pinned-note": "Nota fijada",
"item-sheet": "Objeto"
"item-sheet": "Objeto",
"icon-source": "Elegir icono",
"foundry-icons": "Iconos de Foundry"
}

View File

@@ -0,0 +1,170 @@
// 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}`);
}
}
});

View File

@@ -77,8 +77,10 @@ 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: upload through the item route like the character sheet does its photo
assert.match(itemWindowSource, /\/item\/upload-image\?item=/);
// 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['"]/);
// 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 \}\)/);