26 Commits

Author SHA1 Message Date
b02ecca7d4 Merge pull request 'Fix #27: Add frontend testing' (#28) from ai/issue-27 into master
All checks were successful
Test / test (push) Successful in 1s
Build and Deploy Nuxt / build (push) Successful in 48s
Reviewed-on: #28
2026-10-14 16:32:02 +00:00
26c0a0b0a1 Merge branch 'master' into ai/issue-27
All checks were successful
Test / test (push) Successful in 1s
2026-10-14 16:31:53 +00:00
Gitea OpenCode Agent
59a4c1dd0c Fix issue #27: Add frontend testing
All checks were successful
Test / test (push) Successful in 1s
2026-10-14 16:30:59 +00:00
e3248ac4dc Merge pull request 'Fix #20: Add notes to a map' (#23) from ai/issue-20 into master
All checks were successful
Build and Deploy Nuxt / build (push) Successful in 1m5s
Reviewed-on: #23
2026-10-14 16:30:54 +00:00
969e559c57 Merge branch 'master' into ai/issue-20 2026-10-14 16:30:48 +00:00
ae7d64a09a Merge pull request 'Fix #25: Backend error' (#26) from ai/issue-25 into master
All checks were successful
Build and Deploy Nuxt / build (push) Successful in 1m7s
Reviewed-on: #26
2026-10-14 16:25:36 +00:00
Gitea OpenCode Agent
9d93e6f79b Fix issue #25: Backend error 2026-10-14 16:24:43 +00:00
0541d82a85 Merge pull request 'Fix #21: entity-entry sizing problem' (#24) from ai/issue-21 into master
All checks were successful
Build and Deploy Nuxt / build (push) Successful in 1m9s
Reviewed-on: #24
2026-10-14 16:20:15 +00:00
35252e0d13 Merge branch 'master' into ai/issue-21 2026-10-14 16:20:06 +00:00
8260c588ac Merge pull request 'Fix #19: Add unified campaign sync' (#22) from ai/issue-19 into master
Some checks failed
Build and Deploy Nuxt / build (push) Has been cancelled
Reviewed-on: #22
2026-10-14 16:19:57 +00:00
Gitea OpenCode Agent
b0acd689bb Fix issue #21: entity-entry sizing problem 2026-10-14 14:52:18 +00:00
Gitea OpenCode Agent
ba84e10525 Fix issue #20: Add notes to a map 2026-10-14 14:46:58 +00:00
Gitea OpenCode Agent
0a8452b3c8 Fix issue #19: Add unified campaign sync 2026-10-14 14:07:52 +00:00
9d9738b2b4 Merge pull request 'Fix #17: Foundry Module: Show pairing status' (#18) from ai/issue-17 into master
All checks were successful
Build and Deploy Nuxt / build (push) Successful in 1m7s
Reviewed-on: #18
2026-10-14 13:02:23 +00:00
ce03b0bfb9 Merge branch 'master' into ai/issue-17 2026-10-14 13:02:15 +00:00
Gitea OpenCode Agent
ed0b9af00b Fix issue #17: Foundry Module: Show pairing status 2026-10-14 12:59:26 +00:00
9c6f59f937 Obsidian plugin
All checks were successful
Build and Deploy Nuxt / build (push) Successful in 1m5s
(cherry picked from commit caeff595da)
2026-10-14 14:48:00 +02:00
5cd468ed24 Merge pull request 'Fix #15: Dragonroll Frontend: Map Viewer adjustmentes' (#16) from ai/issue-15 into master
All checks were successful
Build and Deploy Nuxt / build (push) Successful in 53s
Reviewed-on: #16
2026-10-14 12:37:20 +00:00
Gitea OpenCode Agent
4a5b17c77c Fix issue #15: Dragonroll Frontend: Map Viewer adjustmentes 2026-10-14 12:35:05 +00:00
67ca4b0210 Merge pull request 'Fix #10: Add map support' (#11) from ai/issue-10 into master
All checks were successful
Build and Deploy Nuxt / build (push) Successful in 1m3s
Reviewed-on: #11
2026-10-14 12:08:35 +00:00
ff4090412c Merge branch 'master' into ai/issue-10 2026-10-14 12:08:31 +00:00
445e97f2f8 Merge pull request 'Fix #12: Fix copy foundry code localization' (#13) from ai/issue-12 into master
All checks were successful
Build and Deploy Nuxt / build (push) Successful in 50s
Reviewed-on: #13
2026-10-14 12:01:12 +00:00
dc6a04df8a Merge branch 'master' into ai/issue-12 2026-10-14 12:01:06 +00:00
0799dec5b3 Merge pull request 'Fix #8: Sync toggle on foundry' (#9) from ai/issue-8 into master
All checks were successful
Build and Deploy Nuxt / build (push) Successful in 50s
Reviewed-on: #9
2026-10-14 12:00:17 +00:00
Gitea OpenCode Agent
8378e9b3e7 Fix issue #12: Fix copy foundry code localization 2026-10-14 11:57:34 +00:00
Gitea OpenCode Agent
7d19a22a4b Fix issue #8: Sync toggle on foundry 2026-10-13 23:02:43 +00:00
51 changed files with 4264 additions and 1077 deletions

31
.gitea/workflows/test.yml Normal file
View File

@@ -0,0 +1,31 @@
name: Test
on:
push:
branches: ['**']
jobs:
test:
runs-on: docker
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node
run: |
# The suite runs on Node's built-in test runner and needs Node 18+. The container the
# docker runner starts jobs in is not guaranteed to ship one, so fall back to the
# official LTS tarball. The tests themselves install no dependencies.
if node -e 'process.exit(Number(process.versions.node.split(".")[0]) >= 18 ? 0 : 1)' 2>/dev/null; then
node --version
else
apt-get update -y && apt-get install -y curl ca-certificates xz-utils
curl -fsSL https://nodejs.org/dist/v22.12.0/node-v22.12.0-linux-x64.tar.xz -o /tmp/node.tar.xz
tar -xJf /tmp/node.tar.xz -C /usr/local --strip-components=1
node --version
fi
- name: Run tests
run: npm test

View File

@@ -12,13 +12,17 @@ dice widgets, shared markdown, sounds). It is a two-app monorepo:
- `backend/` — Node + **Express 5** + **Mongoose 9** (MongoDB) REST API, JWT auth. CommonJS. - `backend/` — Node + **Express 5** + **Mongoose 9** (MongoDB) REST API, JWT auth. CommonJS.
- `frontend/` — **Nuxt 4 / Vue 3** client (Composition API, `<script setup>`), SCSS, axios, marked, mitt, motion. - `frontend/` — **Nuxt 4 / Vue 3** client (Composition API, `<script setup>`), SCSS, axios, marked, mitt, motion.
There is **no** database seeding, no ORM migrations, no test suite, no linter/formatter config, no There is **no** database seeding, no ORM migrations, no linter/formatter config, no Pinia/Vuex, and no
Pinia/Vuex, and no Vue Router pages (see §5.1 — the UI is a window manager, not routed pages). Vue Router pages (see §5.1 — the UI is a window manager, not routed pages). The only automated tests
are `tests/*.test.js` (`npm test`, Node's built-in runner), which exercise the Foundry module's sync
logic against stubbed Foundry globals.
Git: default branch `master`, hosted on a self-hosted Gitea (`git.aranroig.com/BinarySandia04/Dragonroll`). Git: default branch `master`, hosted on a self-hosted Gitea (`git.aranroig.com/BinarySandia04/Dragonroll`).
CI (`.gitea/workflows/deploy.yml`) builds two Docker images on every push to `master`, pushes them to CI (`.gitea/workflows/deploy.yml`) builds two Docker images on every push to `master`, pushes them to
`git.aranroig.com/<user>/dragonroll-{frontend,backend}:latest`, copies `docker-compose.yml` + `git.aranroig.com/<user>/dragonroll-{frontend,backend}:latest`, copies `docker-compose.yml` +
`nginx.conf` to the deploy host and runs `docker compose pull && up -d`. `nginx.conf` to the deploy host and runs `docker compose pull && up -d`.
`.gitea/workflows/test.yml` runs the `npm test` suite (frontend + Foundry module tests, no dependencies
installed) on every push to any branch, not just `master`.
## 2. Root layout ## 2. Root layout
@@ -26,11 +30,13 @@ CI (`.gitea/workflows/deploy.yml`) builds two Docker images on every push to `ma
dragonroll/ dragonroll/
├── backend/ Express API (CommonJS, entry: src/index.js) ├── backend/ Express API (CommonJS, entry: src/index.js)
├── frontend/ Nuxt 4 app (entry: app/app.vue) ├── frontend/ Nuxt 4 app (entry: app/app.vue)
├── obsidian-plugin/ Plain JavaScript Obsidian plugin for campaign note import/push
├── docker-compose.yml nginx :3000 -> frontend :3000, /api -> backend :5000 ├── docker-compose.yml nginx :3000 -> frontend :3000, /api -> backend :5000
├── nginx.conf reverse proxy rules for the compose stack ├── nginx.conf reverse proxy rules for the compose stack
├── ecosystem.config.js PM2 config (stale: runs `npm start`, which does not exist — see §9) ├── ecosystem.config.js PM2 config (stale: runs `npm start`, which does not exist — see §9)
├── .gitea/workflows/deploy.yml ├── .gitea/workflows/deploy.yml
├── static/media/ README logo images only ├── static/media/ README logo images only
├── tests/ `node --test` tests (Foundry module sync toggle)
├── package.json root: only `concurrently`, used by `npm run dev` ├── package.json root: only `concurrently`, used by `npm run dev`
└── README.md install/run instructions are STALE (see §9) └── README.md install/run instructions are STALE (see §9)
``` ```
@@ -49,10 +55,13 @@ npm --prefix backend run dev # backend only
npm --prefix frontend run dev # frontend only npm --prefix frontend run dev # frontend only
npm --prefix frontend run build # nuxt build --dotenv .env.production npm --prefix frontend run build # nuxt build --dotenv .env.production
npm --prefix frontend run preview npm --prefix frontend run preview
npm test # node --test tests/ (Foundry module sync logic, no dependencies)
``` ```
There is no `start` script in either package, no test command, and no lint command. There is no `start` script in either package and no lint command.
Verification = run the dev server and exercise the flow (`/api/test` returns a JSON hello). Verification = run the dev server and exercise the flow (`/api/test` returns a JSON hello);
`npm test` covers the Foundry character/item sync toggle and per-actor force sync.
### Environment files ### Environment files
@@ -152,7 +161,7 @@ User ──< Campaign ──< Note ──?> Folder ──?> Folder (parentFolder
| `Folder` | `models/Folder.js` | `name*`, `campaign*` → Campaign, `parentFolder` → Folder (null = root), `color` (hex string, sidebar entry background), `date` | | `Folder` | `models/Folder.js` | `name*`, `campaign*` → Campaign, `parentFolder` → Folder (null = root), `color` (hex string, sidebar entry background), `date` |
| `Actor` | `models/Actor.js` | `name*`, `type` (`character`\|`npc`\|`creature`), `species`, `className`, `subclass`, `level`, `background`, `challengeRating`, `description`, `image`, `abilityScores{str..cha}`, `armorClass`, `speed`, `proficiencies`, `inventory[{name,quantity,weight}]` (flattened Foundry items, embedded — not `Item` docs), `traits`, `spells` (newline text), `campaign*` → Campaign, `foundryActorId` (unique per campaign), `date` | | `Actor` | `models/Actor.js` | `name*`, `type` (`character`\|`npc`\|`creature`), `species`, `className`, `subclass`, `level`, `background`, `challengeRating`, `description`, `image`, `abilityScores{str..cha}`, `armorClass`, `speed`, `proficiencies`, `inventory[{name,quantity,weight}]` (flattened Foundry items, embedded — not `Item` docs), `traits`, `spells` (newline text), `campaign*` → Campaign, `foundryActorId` (unique per campaign), `date` |
| `Item` | `models/Item.js` | `name*`, `category` (`weapon`\|`armor`\|`shield`\|`adventuring-gear`\|`magic-item`\|`consumable`\|`tool`\|`treasure`\|`other`), `rarity` (`common`…`artifact`), `quantity`, `weight`, `properties`, `description`, `campaign*` → Campaign, `foundryItemId` (unique per campaign), `foundryNames` (names Foundry uses for it, keeps dedup stable across a Dragonroll rename), `date` | | `Item` | `models/Item.js` | `name*`, `category` (`weapon`\|`armor`\|`shield`\|`adventuring-gear`\|`magic-item`\|`consumable`\|`tool`\|`treasure`\|`other`), `rarity` (`common`…`artifact`), `quantity`, `weight`, `properties`, `description`, `campaign*` → Campaign, `foundryItemId` (unique per campaign), `foundryNames` (names Foundry uses for it, keeps dedup stable across a Dragonroll rename), `date` |
| `Map` | `models/Map.js` | `name*`, `image` (filename in `src/uploads`), `gridSize` (cell size in image px), `offsetX`/`offsetY` (grid origin in image px), `scale` (distance one cell stands for), `campaign*` → Campaign, `date` | | `Map` | `models/Map.js` | `name*`, `image` (filename in `src/uploads`), `gridSize` (cell size in image px), `offsetX`/`offsetY` (grid origin in image px), `scale` (distance one cell stands for), `pins[{note → Note, x, y}]` (a note pinned at image px coordinates, addressed by its own `_id`), `campaign*` → Campaign, `date` |
`*` = required. Notes and folders are ordered by `date: -1` everywhere. `*` = required. Notes and folders are ordered by `date: -1` everywhere.
@@ -183,11 +192,15 @@ Fetch the file from `/api/public/<filename>`.
`GET /api/campaign/list` → `{status:'ok',campaigns}` `GET /api/campaign/list` → `{status:'ok',campaigns}`
`GET /api/campaign/retrieve/:id` → `{status:'ok',campaign}` (401 when no `req.user.id`) `GET /api/campaign/retrieve/:id` → `{status:'ok',campaign}` (401 when no `req.user.id`)
`GET /api/note/list?campaign=` → `{status:'ok', folders, notes}` — notes with `folder: null` (roots) `GET /api/note/list?campaign=` → `{status:'ok', folders, notes}` — notes with `folder: null` (roots);
folder entries include `parentFolder` so clients can rebuild nested folder paths
`GET /api/note/subfolder/list?campaign=&folder=` → `{status:'ok', subfolders, notes}` `GET /api/note/subfolder/list?campaign=&folder=` → `{status:'ok', subfolders, notes}`
`GET /api/note/all?campaign=` → `{status:'ok', notes, folders}` — every note of the campaign, titles
only (no `content`); the map viewer's note picker and its pin labels
`GET /api/note/retrieve/:id` → `{status:'ok',note}` — one note with its content, ownership checked
`POST /api/note/create` — `{title*,content,campaign*,folder?}` (folder validated against campaign) `POST /api/note/create` — `{title*,content,campaign*,folder?}` (folder validated against campaign)
`POST /api/note/update` — `{id*, title?, content?, folder?, color?}` — partial, ownership checked `POST /api/note/update` — `{id*, title?, content?, folder?, color?}` — partial, ownership checked
`POST /api/note/delete` — `{id}` — **no ownership check** (§9) `POST /api/note/delete` — `{id}` — **no ownership check** (§9); pulls the note off every map's `pins`
`GET /api/folder/list?campaign=` → `{status:'ok',folders}` `GET /api/folder/list?campaign=` → `{status:'ok',folders}`
`POST /api/folder/create` — `{name*,campaign*}` `POST /api/folder/create` — `{name*,campaign*}`
@@ -214,6 +227,9 @@ subfolders re-parented to null then deleted.
`POST /api/map/update` — `{id*, name?, gridSize?, offsetX?, offsetY?, scale?}`, partial, ownership checked. Send it as `POST /api/map/update` — `{id*, name?, gridSize?, offsetX?, offsetY?, scale?}`, partial, ownership checked. Send it as
multipart with an `image` field to replace the photo (multer reads the other fields from the form; JSON works too). multipart with an `image` field to replace the photo (multer reads the other fields from the form; JSON works too).
`POST /api/map/delete` — `{id}` `POST /api/map/delete` — `{id}`
`POST /api/map/pin` — `{id*, note*, x, y}` — pins a note of the same campaign at those image px;
pinning a note that is pinned already moves that marker → `{status:'ok',map}`
`POST /api/map/unpin` — `{id*, pin*}` (`pin` is the subdocument `_id`) → `{status:'ok',map}`
### 4.1 Foundry integration (actors, items) ### 4.1 Foundry integration (actors, items)
@@ -233,6 +249,7 @@ not `Campaign.foundryWorldId` (`syncCampaign` / `requestMatchesWorld`). CORS is
| `POST /sync/item-delete` | `{worldId, foundryItemId}` — a world item was deleted | | `POST /sync/item-delete` | `{worldId, foundryItemId}` — a world item was deleted |
| `GET /sync/characters` | Actors the module applies back into Foundry | | `GET /sync/characters` | Actors the module applies back into Foundry |
| `GET /sync/items` | Items the module applies back into Foundry (creates world items for Dragonroll-authored ones) | | `GET /sync/items` | Items the module applies back into Foundry (creates world items for Dragonroll-authored ones) |
| `GET /sync/status` | The campaign a sync token belongs to; the module shows it in its **Dragonroll Pairing Status** setting and treats `unauthorized` as the campaign having unlinked the world |
| `POST /sync/map` / `POST /sync/map-item` | Store the id mapping after the module creates a document | | `POST /sync/map` / `POST /sync/map-item` | Store the id mapping after the module creates a document |
| `POST /sync/delete` | `{worldId, foundryActorId}` | | `POST /sync/delete` | `{worldId, foundryActorId}` |
@@ -248,6 +265,13 @@ Rules worth knowing before editing this:
which the sync skips. which the sync skips.
- **`fullSync` preserves Dragonroll edits** (only new rows are overwritten); live Foundry events - **`fullSync` preserves Dragonroll edits** (only new rows are overwritten); live Foundry events
overwrite. Item pruning requires the full snapshot, since only it sees world items and actor copies. overwrite. Item pruning requires the full snapshot, since only it sees world items and actor copies.
- **Autosync is a Foundry-side switch** (`autoSync` client setting, on by default): when off, the
module queues no CRUD push, runs no periodic reconcile and sends no startup snapshot; the actor
directory's `Dragonroll: Force Sync` entry still pushes the selected actors as an upsert
(`fullSync:false`, so it never prunes). The read-only bridge snapshot is not gated by it.
- **`pairingStatus` is a setting the module writes, not the GM**: the module settings sentence about
whether this world is connected comes from the stored sync token plus the answer from
`/sync/status` (checked at world start and every minute), and anything typed into it is replaced.
- `Actor.inventory` stays a flattened copy of the actor's embedded items; it is not linked to `Item`. - `Actor.inventory` stays a flattened copy of the actor's embedded items; it is not linked to `Item`.
- `GET /api/foundry/*` (`routes/foundry.js`) is unrelated: a JWT-protected proxy over the read-only - `GET /api/foundry/*` (`routes/foundry.js`) is unrelated: a JWT-protected proxy over the read-only
bridge, only useful when `FOUNDRY_API_URL` is configured. bridge, only useful when `FOUNDRY_API_URL` is configured.
@@ -276,7 +300,7 @@ frontend/
│ │ VersionRender │ │ VersionRender
│ ├── layouts/ IconButton, Dropdown, Tabs, ColorPicker (reusable UI atoms) │ ├── layouts/ IconButton, Dropdown, Tabs, ColorPicker (reusable UI atoms)
│ └── viewer/ TopBar, statusbar/{StatusBar,FetchStatus}, topbar/{TopSearchBar,SearchResult}, │ └── viewer/ TopBar, statusbar/{StatusBar,FetchStatus}, topbar/{TopSearchBar,SearchResult},
│ content/{Content,NoteContainer,Note}, widgets/{TableWidget,TestWidget, │ content/{Content,NoteContainer,Note}, map/MapViewerPane, widgets/{TableWidget,TestWidget,
│ inline/RollWidgetInline,display/RollWidgetDisplay} │ inline/RollWidgetInline,display/RollWidgetDisplay}
├── composables/ useTheme.ts (theme+accent singletons, localStorage, data-* attrs), ├── composables/ useTheme.ts (theme+accent singletons, localStorage, data-* attrs),
│ useEmitter.ts (BROKEN, see §9) │ useEmitter.ts (BROKEN, see §9)
@@ -290,7 +314,13 @@ There is no `app/pages/`. `app/app.vue` renders a fixed shell of managers. "Scre
- **Windows** — floating, draggable/resizable overlays (login, main menu, settings…), or - **Windows** — floating, draggable/resizable overlays (login, main menu, settings…), or
- **Content** — the campaign workspace (`TopBar` + `ContentSidebar` + note column + `StatusBar`), - **Content** — the campaign workspace (`TopBar` + `ContentSidebar` + note column + `StatusBar`),
shown when `Campaign` state is non-null. shown when `Campaign` state is non-null. The note column shows the open notes, or the map anchored
on it (`AnchorMap` / `ActivePane` in `services/Content.js`); the sidebar's notes and maps buttons
switch between the two while both keep their state, and `viewer/map/MapViewerPane.vue` renders the
map there and inside the `map_viewer` window (a detached anchored map). Right clicking that map pins
one of the campaign notes at the spot (`services/MapPins.js` translates between image pixels and
the screen and labels the note picker); clicking the marker opens `pinned_note`
(`PinnedNoteWindow.vue`), which reads the note itself through `/note/retrieve/:id`.
Boot sequence (`app.vue` → `start()`): Boot sequence (`app.vue` → `start()`):
@@ -353,7 +383,7 @@ Plain modules with module-scope `ref()`s imported directly. No DI, no Pinia. Sin
| `Server.js` | axios instance (fallback baseURL `http://localhost:5000/api`), `initApi(baseURL)` called by `plugins/api.ts`, request interceptor adding `Authorization: Bearer <localStorage.token>`, `getBaseUrl()`. Default export is a factory: call `Server()` then `.get/.post`. | | `Server.js` | axios instance (fallback baseURL `http://localhost:5000/api`), `initApi(baseURL)` called by `plugins/api.ts`, request interceptor adding `Authorization: Bearer <localStorage.token>`, `getBaseUrl()`. Default export is a factory: call `Server()` then `.get/.post`. |
| `User.js` | `UserStatus` ref, `GetUser()` (decodes JWT, auto-logout on `exp`), `SetUser(token)`, `LoadUser`, `LogoutUser`, `IsAdmin`, `HasAdmin()`, `GetUserSetting(key)` / `SetUserSetting(key,value)` (server-backed, in `User.settings`) | | `User.js` | `UserStatus` ref, `GetUser()` (decodes JWT, auto-logout on `exp`), `SetUser(token)`, `LoadUser`, `LogoutUser`, `IsAdmin`, `HasAdmin()`, `GetUserSetting(key)` / `SetUserSetting(key,value)` (server-backed, in `User.settings`) |
| `Campaign.js` | `useCampaignService()` → `Campaign` (`useState('campaign')`), `SetCampaign(data)` (also writes `localStorage.selectedCampaignId`), `RestoreCampaign()` | | `Campaign.js` | `useCampaignService()` → `Campaign` (`useState('campaign')`), `SetCampaign(data)` (also writes `localStorage.selectedCampaignId`), `RestoreCampaign()` |
| `Content.js` | `ShowContent` ref (drives the campaign workspace). `SetShowContent` is exported but unused — `ContentManager.vue` sets it from a `watch(Campaign)` and never turns it back off | | `Content.js` | `ShowContent` ref (drives the campaign workspace: `ContentManager.vue` turns it on from a `watch(Campaign)`, `TopBar` off when leaving a campaign) and the anchored map: `ActivePane` (`'notes'`\|`'map'`), `AnchoredMap`, `SetActivePane`, `AnchorMap`, `ClearAnchoredMap` |
| `Emitter.js` | `export const emitter = mitt()` — the app-wide event bus | | `Emitter.js` | `export const emitter = mitt()` — the app-wide event bus |
| `Toaster.js` | `DisplayToast(color, text, duration)` → emits `toast`; `ToastManager.vue` renders it | | `Toaster.js` | `DisplayToast(color, text, duration)` → emits `toast`; `ToastManager.vue` renders it |
| `Tooltip.js` | `SetupTooltip()`, `AddTooltip(el, text, {max_width})` (stores on `el._dr_tooltip`), polled visibility via `elementsFromPoint` | | `Tooltip.js` | `SetupTooltip()`, `AddTooltip(el, text, {max_width})` (stores on `el._dr_tooltip`), polled visibility via `elementsFromPoint` |
@@ -409,8 +439,8 @@ Every listener in the app (there are only these six `emitter.on` call sites):
| `toast` | `{color,text,duration}` | `ToastManager.vue` | | `toast` | `{color,text,duration}` | `ToastManager.vue` |
| `push-note` | `{key,title,text,date}` | `NoteContainer.vue` | | `push-note` | `{key,title,text,date}` | `NoteContainer.vue` |
| `close-note` | note key (string) | `NoteContainer.vue` (removes the note from the open column only) | | `close-note` | note key (string) | `NoteContainer.vue` (removes the note from the open column only) |
| `delete-note` | note key (string) | `NoteContainer.vue`, `ContentSidebar.vue`, `NestedNoteList.vue` (real deletion: closes the note **and** removes it from the sidebar) | | `delete-note` | note key (string) | `NoteContainer.vue`, `ContentSidebar.vue`, `NestedNoteList.vue` (real deletion: closes the note **and** removes it from the sidebar), `MapViewerPane.vue` (drops the markers pinned to that note) |
| `title-updated` | `{key,title}` | `Note.vue`, `NoteContainer.vue` | | `title-updated` | `{key,title}` | `Note.vue`, `NoteContainer.vue`, `MapViewerPane.vue` (relabels the map pins of that note) |
| `status-bar-update` | `{text,icon}` | `FetchStatus.vue` | | `status-bar-update` | `{text,icon}` | `FetchStatus.vue` |
Emitters: `Toaster.js` (`toast`), `ContentSidebar` / `TopSearchBar` (`push-note`), `Note.vue` Emitters: `Toaster.js` (`toast`), `ContentSidebar` / `TopSearchBar` (`push-note`), `Note.vue`
@@ -463,6 +493,23 @@ script; `WindowDefinitions` stores raw keys (`title: 'windows.login'`) and `Wind
configured (`nuxt.config.ts`, `langDir: 'locales/'`, `vueI18n: './i18n.config.ts'`) but its locale files configured (`nuxt.config.ts`, `langDir: 'locales/'`, `vueI18n: './i18n.config.ts'`) but its locale files
(`locales/en.json` etc.) are empty `{}` — the custom plugin is what components actually consume. (`locales/en.json` etc.) are empty `{}` — the custom plugin is what components actually consume.
### 5.9 Obsidian plugin
`obsidian-plugin/` is a plain JavaScript community plugin; copy `main.js` and `manifest.json` into
`<vault>/.obsidian/plugins/dragonroll-sync/` (details in its README). It signs in through
`POST /api/user/login`, saves the 48-hour JWT token in plugin data, and does not save the password.
The user selects a campaign from `GET /api/campaign/list`.
- **Import or refresh campaign notes** reads `/api/note/list` plus `/api/note/subfolder/list` and
creates/updates Markdown files under `Dragonroll/<Campaign>/`, preserving Dragonroll's folder tree.
- **Push active note to Dragonroll** creates a root campaign note or updates the note linked in its
frontmatter.
- `dragonrollId`, `dragonrollCampaign`, and `dragonrollTitle` frontmatter properties link imported
notes. They are omitted from content sent to Dragonroll. Per-note signatures detect local edits;
imports preserve modified local files, and push is explicit.
The plugin uses Obsidian's `requestUrl` helper, so the request path does not depend on browser CORS.
## 6. Conventions ## 6. Conventions
- **Backend**: CommonJS `require`/`module.exports`; files in `services/` are shared infra, `routes/` - **Backend**: CommonJS `require`/`module.exports`; files in `services/` are shared infra, `routes/`

View File

@@ -24,6 +24,7 @@ Dragonroll is an open source connector for role-playing games.
- Play music during physical campaings - Play music during physical campaings
- Plan different encounters - Plan different encounters
- Manage different items and spells - Manage different items and spells
- Import and edit campaign notes in Obsidian with the [Dragonroll Sync plugin](obsidian-plugin/README.md)
- And so much more! - And so much more!
## Installation 🛠️ ## Installation 🛠️
@@ -55,7 +56,6 @@ if you want to start the development environments
- Dragonroll <-> Foundry integration - Dragonroll <-> Foundry integration
- Dragonroll <-> Discord Bot integration - Dragonroll <-> Discord Bot integration
- Dragonroll <-> Obsidian integration
What to sync: What to sync:

View File

@@ -40,32 +40,40 @@ require('./services/passport')(passport);
// CORS // CORS
app.use(cookieParser()); app.use(cookieParser());
const foundryCorsPaths = [ // Services talk to Dragonroll from their own application (a Foundry world, an
'/api/foundry/link/complete', '/foundry/link/complete', // Obsidian vault, the Discord bot), so their link routes cannot be limited to
// one origin. What they may do is decided by the link code each of them holds.
const openCorsPaths = [
'/api/foundry/sync', '/foundry/sync', '/api/foundry/sync', '/foundry/sync',
'/api/link/start', '/link/start',
'/api/link/pickup', '/link/pickup',
]; ];
const foundryCors = cors({ const openCors = cors({
origin: true, origin: true,
methods: ['GET', 'POST', 'OPTIONS'], methods: ['GET', 'POST', 'OPTIONS'],
allowedHeaders: ['Authorization', 'Content-Type'], allowedHeaders: ['Authorization', 'Content-Type', 'X-Dragonroll-Discord-Bot-Secret'],
}); });
app.use('/api/foundry/link/complete', foundryCors); for (const path of openCorsPaths) {
app.use('/foundry/link/complete', foundryCors); app.use(path, openCors);
app.use('/api/foundry/sync', foundryCors); }
app.use('/foundry/sync', foundryCors);
const appCors = cors({ const appCors = cors({
origin: 'http://localhost:3000', origin: 'http://localhost:3000',
credentials: true, // if using cookies/auth credentials: true, // if using cookies/auth
}); });
app.use((req, res, next) => { app.use((req, res, next) => {
if (foundryCorsPaths.some((path) => req.path === path || req.path.startsWith(`${path}/`))) return next(); if (openCorsPaths.some((path) => req.path === path || req.path.startsWith(`${path}/`))) return next();
appCors(req, res, next); appCors(req, res, next);
}); });
// ROUTES (NO AUTH) // ROUTES (NO AUTH)
app.use('/api/user', require('./routes/user')); app.use('/api/user', require('./routes/user'));
app.use('/api/discord', require('./routes/discord')); app.use('/api/discord', require('./routes/discord'));
// The one way every service (Foundry, Discord, Obsidian) links itself to a
// campaign: it asks for a sign-up link, a user opens it and picks the campaign.
// Each service authenticates with its own proof: the Discord bot with its
// secret, Foundry and Obsidian with the link code they were handed.
app.use('/api/link', require('./routes/service-link'));
app.use('/api/foundry', require('./routes/foundry-link')); app.use('/api/foundry', require('./routes/foundry-link'));
app.use('/foundry', require('./routes/foundry-link')); app.use('/foundry', require('./routes/foundry-link'));

View File

@@ -1,20 +0,0 @@
const mongoose = require('mongoose');
const Schema = mongoose.Schema;
const DiscordLinkRequestSchema = new Schema({
codeHash: { type: String, required: true, unique: true },
guildId: { type: String, required: true },
guildName: { type: String, required: true },
discordUserId: { type: String, required: true },
discordUserName: { type: String, required: true },
dragonrollUser: { type: Schema.Types.ObjectId, ref: 'User' },
createdAt: { type: Date, default: Date.now },
expiresAt: { type: Date, required: true },
completedAt: { type: Date },
// Quan el bot ja ha confirmat a Discord que aquesta autoritzacio s'ha fet.
notifiedAt: { type: Date }
});
DiscordLinkRequestSchema.index({ expiresAt: 1 }, { expireAfterSeconds: 0 });
module.exports = mongoose.model('DiscordLinkRequest', DiscordLinkRequestSchema);

View File

@@ -1,24 +0,0 @@
const mongoose = require('mongoose');
const Schema = mongoose.Schema;
const FoundryLinkRequestSchema = new Schema({
codeHash: { type: String, required: true, unique: true },
// Kept in clear text so the campaign settings screen can re-display a pending
// pairing code after a reload or a backend restart. It is only ever returned
// to the user who created the request and is cleared once the link completes.
code: { type: String },
source: { type: String, enum: ['dragonroll'], required: true },
campaign: { type: Schema.Types.ObjectId, ref: 'Campaign' },
createdBy: { type: Schema.Types.ObjectId, ref: 'User' },
worldId: { type: String },
worldTitle: { type: String },
system: { type: String },
foundryUrl: { type: String },
createdAt: { type: Date, default: Date.now },
expiresAt: { type: Date, required: true },
completedAt: { type: Date }
});
FoundryLinkRequestSchema.index({ expiresAt: 1 }, { expireAfterSeconds: 0 });
module.exports = mongoose.model('FoundryLinkRequest', FoundryLinkRequestSchema);

View File

@@ -12,6 +12,13 @@ const MapSchema = new Schema({
offsetY: { type: Number, default: 0 }, offsetY: { type: Number, default: 0 },
// Distance each grid cell stands for (feet, metres...) // Distance each grid cell stands for (feet, metres...)
scale: { type: Number, min: 0.01, default: 5 }, scale: { type: Number, min: 0.01, default: 5 },
// Notes pinned onto the map like markers. x/y are image pixels from the top left corner of the
// image, so a pin keeps its place whatever the zoom or the grid settings are.
pins: [{
note: { type: Schema.Types.ObjectId, ref: 'Note', required: true },
x: { type: Number, default: 0 },
y: { type: Number, default: 0 }
}],
campaign: { campaign: {
type: Schema.Types.ObjectId, type: Schema.Types.ObjectId,
ref: 'Campaign', ref: 'Campaign',

View File

@@ -0,0 +1,44 @@
const mongoose = require('mongoose');
const Schema = mongoose.Schema;
// One row per service installation that wants to use a campaign: a Foundry
// world, a Discord server, an Obsidian vault. Asking for a link resets the row
// to a fresh pending request, so a service always has one row and that row is
// also the record of the link that is active right now.
//
// The service starts the request and shows the sign-up link it gets back; a
// Dragonroll user then signs in through that link and picks the campaign. The
// service picks its credential up with the same code it was given.
const ServiceLinkRequestSchema = new Schema({
service: { type: String, enum: ['foundry', 'discord', 'obsidian'], required: true },
// Who is asking, in its own terms: Foundry world id, Discord guild id, vault id.
targetId: { type: String },
targetName: { type: String },
// The person who asked, as far as the service knows: GM name, Discord user...
targetUser: { type: String },
// Whatever else the service describes itself with (Foundry system and URL).
targetMeta: { type: Object },
codeHash: { type: String, required: true, unique: true },
campaign: { type: Schema.Types.ObjectId, ref: 'Campaign' },
dragonrollUser: { type: Schema.Types.ObjectId, ref: 'User' },
// 'pending' until a Dragonroll user picks a campaign through the sign-up
// link, 'linked' while that choice stands, 'revoked' once the campaign
// unlinked the service again.
state: { type: String, enum: ['pending', 'linked', 'revoked'], default: 'pending' },
// What the service gets when it picks the link up: the Foundry sync token,
// the Obsidian session. Dropped as soon as it has been delivered.
credentials: { type: Object, select: false },
createdAt: { type: Date, default: Date.now },
// Only a request nobody answers expires: an empty value keeps the link.
expiresAt: { type: Date },
linkedAt: { type: Date },
pickedUpAt: { type: Date },
// The Discord bot has confirmed this authorization in Discord.
notifiedAt: { type: Date }
});
ServiceLinkRequestSchema.index({ expiresAt: 1 }, { expireAfterSeconds: 0 });
ServiceLinkRequestSchema.index({ service: 1, targetId: 1 });
ServiceLinkRequestSchema.index({ campaign: 1, service: 1, state: 1 });
module.exports = mongoose.model('ServiceLinkRequest', ServiceLinkRequestSchema);

View File

@@ -1,24 +1,28 @@
const express = require('express') const express = require('express')
const router = express.Router(); const router = express.Router();
const crypto = require('node:crypto');
const Campaign = require("../models/Campaign"); const Campaign = require("../models/Campaign");
const FoundryLinkRequest = require('../models/FoundryLinkRequest'); const User = require('../models/User');
const serviceLinks = require('../services/service-links');
const FOUNDRY_LINK_TTL_MS = 10 * 60 * 1000; // Every service links to a campaign through the same sign-up link
// (routes/service-link.js); a campaign only drops one of them again.
async function unlinkService(campaign, service) {
if (service === 'foundry') {
campaign.foundryWorldId = undefined;
campaign.foundryWorldTitle = undefined;
campaign.foundrySystem = undefined;
campaign.set('foundrySyncTokenHash', undefined);
} else if (service === 'discord') {
// The Discord account the bot answers to stays: the server is simply
// left without a campaign until somebody picks one again.
campaign.discordGuildId = undefined;
}
function foundryCodeHash(code) { await campaign.save();
return crypto.createHash('sha256').update(String(code ?? '').trim()).digest('hex'); // A link a service still holds becomes invalid, and it finds that out the
} // next time it asks where its link stands.
await serviceLinks.revokeServiceLink(service, campaign._id);
async function expirePendingFoundryLinks(campaignId, userId) {
const filter = {
source: 'dragonroll',
campaign: campaignId,
createdBy: userId,
completedAt: null
};
await FoundryLinkRequest.updateMany(filter, { $set: { expiresAt: new Date() } });
} }
router.post('/create', async (req, res) => { router.post('/create', async (req, res) => {
@@ -74,73 +78,26 @@ router.post('/update', async (req, res) => {
} }
}); });
router.post('/foundry-link/start', async (req, res) => { // Which services a campaign has connected, and the account each of them was
try { // authorized with.
const campaign = await Campaign.findOne({ _id: req.body.campaignId, createdBy: req.user.id }); router.get('/services', async (req, res) => {
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
await expirePendingFoundryLinks(campaign._id, req.user.id);
const code = crypto.randomBytes(24).toString('base64url');
const expiresAt = new Date(Date.now() + FOUNDRY_LINK_TTL_MS);
const request = await FoundryLinkRequest.create({
codeHash: foundryCodeHash(code),
code,
source: 'dragonroll',
campaign: campaign._id,
createdBy: req.user.id,
expiresAt
});
res.set('Cache-Control', 'no-store');
res.json({ status: 'ok', code, requestId: request.id, expiresAt });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.get('/foundry-link/status/:requestId', async (req, res) => {
try {
const request = await FoundryLinkRequest.findOne({
_id: req.params.requestId,
source: 'dragonroll',
createdBy: req.user.id
});
if (!request) return res.json({ status: 'ok', state: 'expired' });
if (!request.completedAt && request.expiresAt <= new Date()) {
return res.json({ status: 'ok', state: 'expired' });
}
if (!request.completedAt) return res.json({ status: 'ok', state: 'pending' });
const campaign = await Campaign.findOne({ _id: request.campaign, createdBy: req.user.id });
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
res.json({ status: 'ok', state: 'complete', campaign });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
// Returns the still-valid pending pairing request for a campaign, so the
// settings window can restore its pairing code across reloads and restarts.
router.get('/foundry-link/pending', async (req, res) => {
try { try {
const campaign = await Campaign.findOne({ _id: req.query.campaignId, createdBy: req.user.id }); const campaign = await Campaign.findOne({ _id: req.query.campaignId, createdBy: req.user.id });
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' }); if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
const request = await FoundryLinkRequest.findOne({ const links = await serviceLinks.listLinkedServices(campaign._id);
source: 'dragonroll', const userIds = [...new Set(links.map((link) => String(link.dragonrollUser ?? '')).filter(Boolean))];
campaign: campaign._id, const users = userIds.length
createdBy: req.user.id, ? await User.find({ _id: { $in: userIds } }).select('username name').lean()
completedAt: null, : [];
expiresAt: { $gt: new Date() } const names = new Map(users.map((user) => [String(user._id), user.username || user.name]));
}).sort({ createdAt: -1 });
if (!request) return res.json({ status: 'ok', request: null });
res.set('Cache-Control', 'no-store');
res.json({ res.json({
status: 'ok', status: 'ok',
request: { requestId: request.id, code: request.code, expiresAt: request.expiresAt } services: links.map((link) => ({
...link,
dragonrollUserName: names.get(String(link.dragonrollUser ?? '')) || null
}))
}); });
} catch (err) { } catch (err) {
console.error(err); console.error(err);
@@ -148,18 +105,16 @@ router.get('/foundry-link/pending', async (req, res) => {
} }
}); });
router.post('/foundry-unlink', async (req, res) => { router.post('/service-unlink', async (req, res) => {
try { try {
const service = String(req.body.service || '').trim();
if (!serviceLinks.isService(service)) return res.json({ status: 'error', msg: 'errors.missing-data' });
const campaign = await Campaign.findOne({ _id: req.body.campaignId, createdBy: req.user.id }); const campaign = await Campaign.findOne({ _id: req.body.campaignId, createdBy: req.user.id });
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' }); if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
campaign.foundryWorldId = undefined; await unlinkService(campaign, service);
campaign.foundryWorldTitle = undefined; res.json({ status: 'ok', campaign, services: await serviceLinks.listLinkedServices(campaign._id) });
campaign.foundrySystem = undefined;
campaign.set('foundrySyncTokenHash', undefined);
await campaign.save();
await expirePendingFoundryLinks(campaign._id, req.user.id);
res.json({ status: 'ok', campaign });
} catch (err) { } catch (err) {
console.error(err); console.error(err);
res.json({ status: 'error', msg: 'errors.internal' }); res.json({ status: 'error', msg: 'errors.internal' });

View File

@@ -1,124 +1,25 @@
const crypto = require('node:crypto');
const express = require('express'); const express = require('express');
const passport = require('passport');
const router = express.Router(); const router = express.Router();
const Actor = require('../models/Actor'); const Actor = require('../models/Actor');
const Campaign = require('../models/Campaign'); const Campaign = require('../models/Campaign');
const DiscordGuildLink = require('../models/DiscordGuildLink'); const DiscordGuildLink = require('../models/DiscordGuildLink');
const DiscordLinkRequest = require('../models/DiscordLinkRequest'); const ServiceLinkRequest = require('../models/ServiceLinkRequest');
const User = require('../models/User'); const User = require('../models/User');
const serviceLinks = require('../services/service-links');
const LINK_TTL_MS = 10 * 60 * 1000;
const NOTIFICATION_WINDOW_MS = 15 * 60 * 1000;
const NOTIFICATION_LIMIT = 10; const NOTIFICATION_LIMIT = 10;
const requireBot = serviceLinks.requireDiscordBot;
function validGuildId(value) { function validGuildId(value) {
return /^\d{5,25}$/.test(String(value ?? '')); return /^\d{5,25}$/.test(String(value ?? ''));
} }
function codeHash(code) { // Connecting a Discord server is the service link of issue: the bot asks
return crypto.createHash('sha256').update(String(code ?? '')).digest('hex'); // /api/link/start for a sign-up link, and whoever opens it signs in and picks the
} // campaign this server may read. What is left here is what the bot needs once
// that link exists: confirming it in Discord and working with its campaign.
function requireBot(req, res, next) {
const configuredSecret = process.env.DRAGONROLL_DISCORD_BOT_SECRET?.trim() || '';
const suppliedSecret = req.get('x-dragonroll-discord-bot-secret') || '';
const expected = Buffer.from(configuredSecret);
const supplied = Buffer.from(suppliedSecret);
if (!expected.length || expected.length !== supplied.length || !crypto.timingSafeEqual(expected, supplied)) {
return res.status(401).json({ status: 'error', msg: 'errors.unauthorized' });
}
return next();
}
function frontendAuthorizeUrl() {
const frontendUrl = (process.env.DRAGONROLL_FRONTEND_URL || 'http://localhost:3000').trim().replace(/\/+$/, '');
return `${frontendUrl}/discord/authorize`;
}
// La pantalla d'autorització l'serveix el frontend. El codi viatja al fragment de la URL i el
// navegador no l'envia mai al servidor, així que els enllaços antics del bot arriben a la
// pantalla sense codi i demanen de tornar a executar /dragonroll connect.
router.get('/authorize', (req, res) => {
res.set('Cache-Control', 'no-store');
res.set('Referrer-Policy', 'no-referrer');
res.set('X-Content-Type-Options', 'nosniff');
res.redirect(302, frontendAuthorizeUrl());
});
router.post('/link/start', requireBot, async (req, res) => {
try {
const { guildId, guildName, discordUserId, discordUserName } = req.body;
if (!validGuildId(guildId) || !/^\d{5,25}$/.test(String(discordUserId ?? '')) || !guildName || !discordUserName) {
return res.json({ status: 'error', msg: 'errors.missing-data' });
}
const code = crypto.randomBytes(32).toString('base64url');
await DiscordLinkRequest.create({
codeHash: codeHash(code),
guildId: String(guildId),
guildName: String(guildName).slice(0, 100),
discordUserId: String(discordUserId),
discordUserName: String(discordUserName).slice(0, 100),
expiresAt: new Date(Date.now() + LINK_TTL_MS)
});
res.json({ status: 'ok', code, expiresAt: new Date(Date.now() + LINK_TTL_MS) });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/link/details', async (req, res) => {
try {
res.set('Cache-Control', 'no-store');
const request = await DiscordLinkRequest.findOne({
codeHash: codeHash(req.body.code),
expiresAt: { $gt: new Date() },
completedAt: null
}).lean();
if (!request) return res.json({ status: 'error', msg: 'discord.errors.link-expired' });
res.json({ status: 'ok', guildName: request.guildName, discordUserName: request.discordUserName });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/link/complete', passport.authenticate('jwt', { session: false }), async (req, res) => {
try {
const request = await DiscordLinkRequest.findOneAndUpdate({
codeHash: codeHash(req.body.code),
expiresAt: { $gt: new Date() },
completedAt: null
}, {
$set: { completedAt: new Date(), dragonrollUser: req.user.id }
}, { new: true });
if (!request) return res.json({ status: 'error', msg: 'discord.errors.link-expired' });
await Campaign.updateMany(
{ discordGuildId: request.guildId, createdBy: { $ne: req.user.id } },
{ $unset: { discordGuildId: 1 } }
);
await DiscordGuildLink.findOneAndUpdate({ guildId: request.guildId }, {
$set: {
discordUserId: request.discordUserId,
dragonrollUser: req.user.id,
connectedAt: new Date()
}
}, { new: true, upsert: true, setDefaultsOnInsert: true });
res.json({ status: 'ok', guildName: request.guildName });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
async function dragonrollUserNames(requests) { async function dragonrollUserNames(requests) {
const userIds = [...new Set(requests.map((request) => String(request.dragonrollUser ?? '')).filter(Boolean))]; const userIds = [...new Set(requests.map((request) => String(request.dragonrollUser ?? '')).filter(Boolean))];
@@ -132,16 +33,18 @@ async function dragonrollUserNames(requests) {
// mateix evita que dos processos del bot confirmïn la mateixa vegada. // mateix evita que dos processos del bot confirmïn la mateixa vegada.
router.post('/bot/link-requests/notifications', requireBot, async (req, res) => { router.post('/bot/link-requests/notifications', requireBot, async (req, res) => {
try { try {
const pending = await DiscordLinkRequest.find({ const pending = await ServiceLinkRequest.find({
completedAt: { $gte: new Date(Date.now() - NOTIFICATION_WINDOW_MS) }, service: 'discord',
state: 'linked',
linkedAt: { $gte: new Date(Date.now() - serviceLinks.NOTIFICATION_WINDOW_MS) },
notifiedAt: null notifiedAt: null
}).select('_id guildId guildName discordUserId discordUserName dragonrollUser') }).select('_id targetId targetName targetUser targetMeta dragonrollUser campaign')
.limit(NOTIFICATION_LIMIT) .limit(NOTIFICATION_LIMIT)
.lean(); .lean();
const claimed = []; const claimed = [];
for (const request of pending) { for (const request of pending) {
const taken = await DiscordLinkRequest.findOneAndUpdate( const taken = await ServiceLinkRequest.findOneAndUpdate(
{ _id: request._id, notifiedAt: null }, { _id: request._id, notifiedAt: null },
{ $set: { notifiedAt: new Date() } }, { $set: { notifiedAt: new Date() } },
{ new: true } { new: true }
@@ -150,15 +53,22 @@ router.post('/bot/link-requests/notifications', requireBot, async (req, res) =>
} }
const names = await dragonrollUserNames(claimed); const names = await dragonrollUserNames(claimed);
const campaignIds = [...new Set(claimed.map((request) => String(request.campaign ?? '')).filter(Boolean))];
const campaigns = campaignIds.length
? await Campaign.find({ _id: { $in: campaignIds } }).select('_id name').lean()
: [];
const campaignNames = new Map(campaigns.map((campaign) => [String(campaign._id), campaign.name]));
res.json({ res.json({
status: 'ok', status: 'ok',
notifications: claimed.map((request) => ({ notifications: claimed.map((request) => ({
id: String(request._id), id: String(request._id),
guildId: request.guildId, guildId: request.targetId,
guildName: request.guildName, guildName: request.targetName,
discordUserId: request.discordUserId, discordUserId: request.targetMeta?.userId || '',
discordUserName: request.discordUserName, discordUserName: request.targetUser,
dragonrollUserName: names.get(String(request.dragonrollUser ?? '')) || null dragonrollUserName: names.get(String(request.dragonrollUser ?? '')) || null,
campaignName: campaignNames.get(String(request.campaign ?? '')) || null
})) }))
}); });
} catch (err) { } catch (err) {

View File

@@ -1,18 +1,14 @@
const crypto = require('node:crypto'); const crypto = require('node:crypto');
const express = require('express'); const express = require('express');
const rateLimit = require('express-rate-limit');
const mongoose = require('mongoose'); const mongoose = require('mongoose');
const router = express.Router(); const router = express.Router();
const Campaign = require('../models/Campaign'); const Campaign = require('../models/Campaign');
const Actor = require('../models/Actor'); const Actor = require('../models/Actor');
const Item = require('../models/Item'); const Item = require('../models/Item');
const FoundryLinkRequest = require('../models/FoundryLinkRequest');
const { foundryActorToCharacter } = require('../services/actor-foundry'); const { foundryActorToCharacter } = require('../services/actor-foundry');
const { foundryItemToItemData } = require('../services/item-foundry'); const { foundryItemToItemData } = require('../services/item-foundry');
const linkRateLimit = rateLimit({ windowMs: 15 * 60 * 1000, max: 20 });
// Upper bound for the Foundry names remembered per synced item (see Item model). // Upper bound for the Foundry names remembered per synced item (see Item model).
const MAX_FOUNDRY_NAMES = 20; const MAX_FOUNDRY_NAMES = 20;
@@ -129,109 +125,26 @@ async function syncFoundryItems(campaign, sources, fullSync = false) {
return items; return items;
} }
function readWorld(body) { // Linking a world to a campaign happens through the sign-up link every service
const world = body?.world; // uses (routes/service-link.js); what stays here is the sync that world keeps up
if (!world || typeof world.id !== 'string' || !world.id.trim()) return null; // with the campaign once that link has handed it its token.
let foundryUrl = ''; // The Foundry module shows this in its settings: the sync token alone only proves
if (typeof world.url === 'string') { // a link was made once, so the module asks which campaign it belongs to and hears
try { // back nothing but `unauthorized` once that campaign unlinks the world again.
const url = new URL(world.url); router.get('/sync/status', async (req, res) => {
if (url.protocol === 'http:' || url.protocol === 'https:') foundryUrl = url.origin;
} catch {}
}
return {
worldId: world.id.trim().slice(0, 120),
worldTitle: typeof world.title === 'string' ? world.title.trim().slice(0, 200) : '',
system: typeof world.system === 'string' ? world.system.trim().slice(0, 120) : '',
foundryUrl
};
}
async function attachWorldToCampaign(campaign, world) {
const linkedElsewhere = await Campaign.findOne({
foundryWorldId: world.worldId,
_id: { $ne: campaign._id }
}).select('_id');
if (linkedElsewhere) return false;
campaign.foundryWorldId = world.worldId;
campaign.foundryWorldTitle = world.worldTitle;
campaign.foundrySystem = world.system;
if (world.foundryUrl) {
const settings = campaign.settings && typeof campaign.settings === 'object' ? campaign.settings : {};
const integrations = settings.integrations && typeof settings.integrations === 'object'
? settings.integrations
: {};
campaign.settings = {
...settings,
integrations: {
...integrations,
foundryUrl: integrations.foundryUrl || world.foundryUrl
}
};
}
await campaign.save();
return true;
}
async function expireOtherPendingLinks(campaignId, userId, requestId) {
await FoundryLinkRequest.updateMany({
source: 'dragonroll',
campaign: campaignId,
createdBy: userId,
completedAt: null,
_id: { $ne: requestId }
}, { $set: { expiresAt: new Date() } });
}
router.post('/link/complete', linkRateLimit, async (req, res) => {
try { try {
const world = readWorld(req.body); const campaign = await syncCampaign(req, res);
if (!world || typeof req.body.code !== 'string' || !req.body.code.trim()) { if (!campaign) return;
return res.json({ status: 'error', msg: 'errors.missing-data' });
}
const request = await FoundryLinkRequest.findOne({
codeHash: codeHash(req.body.code),
source: 'dragonroll',
expiresAt: { $gt: new Date() },
completedAt: null
});
if (!request) return res.json({ status: 'error', msg: 'foundry.errors.link-expired' });
const campaign = await Campaign.findOne({ _id: request.campaign, createdBy: request.createdBy });
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
const attached = await attachWorldToCampaign(campaign, world);
if (!attached) return res.json({ status: 'error', msg: 'foundry.errors.world-already-linked' });
const syncToken = crypto.randomBytes(32).toString('base64url');
campaign.foundrySyncTokenHash = codeHash(syncToken);
await campaign.save();
request.worldId = world.worldId;
request.worldTitle = world.worldTitle;
request.system = world.system;
request.foundryUrl = world.foundryUrl;
request.completedAt = new Date();
request.code = undefined; // Redeemed: keep only the hash from now on.
await request.save();
await expireOtherPendingLinks(campaign._id, request.createdBy, request._id);
const bridgeUrl = process.env.FOUNDRY_API_CLIENT_URL || process.env.FOUNDRY_API_URL;
const pushToken = process.env.FOUNDRY_API_PUSH_TOKEN;
res.set('Cache-Control', 'no-store'); res.set('Cache-Control', 'no-store');
res.json({ res.json({
status: 'ok', status: 'ok',
world: { id: world.worldId, title: world.worldTitle, system: world.system }, campaign: { id: campaign.id, name: campaign.name },
syncToken, worldId: campaign.foundryWorldId
bridgeConfig: bridgeUrl && pushToken ? { url: bridgeUrl, pushToken } : null
}); });
} catch (err) { } catch (err) {
console.error(err); console.error(err);
if (err.code === 11000) return res.json({ status: 'error', msg: 'foundry.errors.world-already-linked' });
res.json({ status: 'error', msg: 'errors.internal' }); res.json({ status: 'error', msg: 'errors.internal' });
} }
}); });

View File

@@ -5,6 +5,7 @@ const upload = require('../services/storage');
const Campaign = require('../models/Campaign'); const Campaign = require('../models/Campaign');
const Map = require('../models/Map'); const Map = require('../models/Map');
const Note = require('../models/Note');
async function userOwnsCampaign(campaignId, userId) { async function userOwnsCampaign(campaignId, userId) {
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean(); const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
@@ -92,4 +93,63 @@ router.post('/delete', async (req, res) => {
} }
}); });
// A pin is a note placed at a spot of the map, in image pixels. Coordinates arrive as strings with
// multipart requests and are never negative: the viewer clamps them to the image already.
function toCoordinate(value) {
const number = Number(value);
if (!Number.isFinite(number)) return 0;
return Math.max(0, Math.round(number));
}
router.post('/pin', async (req, res) => {
try {
const { id, note, x, y } = req.body;
if (!id || !note) return res.json({ status: 'error', msg: 'errors.missing-data' });
const map = await Map.findById(id);
if (!map) return res.json({ status: 'error', msg: 'errors.notfound' });
if (!(await userOwnsCampaign(map.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
// Only a note of the same campaign can be pinned onto one of its maps.
const noteDoc = await Note.findOne({ _id: note, campaign: map.campaign }).select('_id').lean();
if (!noteDoc) return res.json({ status: 'error', msg: 'errors.notfound' });
// A note is pinned once per map: pinning it again moves the marker instead of adding a twin.
const pin = map.pins.find((current) => String(current.note) === String(note));
if (pin) {
pin.x = toCoordinate(x);
pin.y = toCoordinate(y);
} else {
map.pins.push({ note, x: toCoordinate(x), y: toCoordinate(y) });
}
await map.save();
res.json({ status: 'ok', map });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/unpin', async (req, res) => {
try {
const { id, pin } = req.body;
if (!id || !pin) return res.json({ status: 'error', msg: 'errors.missing-data' });
const map = await Map.findById(id);
if (!map) return res.json({ status: 'error', msg: 'errors.notfound' });
if (!(await userOwnsCampaign(map.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
// `_id` stays with the pins that remain: the viewer removes them by that id.
map.pins = map.pins
.filter((current) => String(current._id) !== String(pin))
.map((current) => ({ _id: current._id, note: current.note, x: current.x, y: current.y }));
await map.save();
res.json({ status: 'ok', map });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
module.exports = router; module.exports = router;

View File

@@ -4,6 +4,7 @@ const router = express.Router();
const Campaign = require('../models/Campaign'); const Campaign = require('../models/Campaign');
const Note = require('../models/Note'); const Note = require('../models/Note');
const Folder = require('../models/Folder'); const Folder = require('../models/Folder');
const Map = require('../models/Map');
async function userOwnsCampaign(campaignId, userId) { async function userOwnsCampaign(campaignId, userId) {
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean(); const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
@@ -19,7 +20,7 @@ router.get('/list', async (req, res) => {
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' }); if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
const folders = await Folder.find({ campaign }) const folders = await Folder.find({ campaign })
.select('_id name date color') .select('_id name parentFolder date color')
.sort({ date: -1 }) .sort({ date: -1 })
.lean(); .lean();
@@ -64,6 +65,49 @@ router.get('/subfolder/list', async (req, res) => {
} }
}); });
// Every note of the campaign, folders included, without their content: enough to offer a note
// picker and to label the pins other screens put on a map.
router.get('/all', async (req, res) => {
try {
const { campaign } = req.query;
if (!campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
const hasAccess = await userOwnsCampaign(campaign, req.user.id);
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
const notes = await Note.find({ campaign })
.select('_id title folder date')
.sort({ title: 1 })
.lean();
const folders = await Folder.find({ campaign })
.select('_id name parentFolder')
.lean();
res.json({ status: 'ok', notes, folders });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
// One note with its content, for the screens that show a note on their own (a map pin, for
// instance) instead of from the sidebar's note list.
router.get('/retrieve/:id', async (req, res) => {
try {
const note = await Note.findById(req.params.id).lean();
if (!note) return res.json({ status: 'error', msg: 'errors.notfound' });
const hasAccess = await userOwnsCampaign(note.campaign, req.user.id);
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
res.json({ status: 'ok', note });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
router.post('/create', async (req, res) => { router.post('/create', async (req, res) => {
try { try {
const { title, content, campaign, folder } = req.body; const { title, content, campaign, folder } = req.body;
@@ -119,6 +163,9 @@ router.post('/delete', async (req, res) => {
const result = await Note.deleteOne({ _id: id }); const result = await Note.deleteOne({ _id: id });
if (result.deletedCount === 0) return res.json({ status: 'error', msg: 'errors.notfound' }); if (result.deletedCount === 0) return res.json({ status: 'error', msg: 'errors.notfound' });
// A pin pointing at a note that is gone would open nothing: drop those along with the note.
await Map.updateMany({ 'pins.note': id }, { $pull: { pins: { note: id } } });
res.json({ status: 'ok' }); res.json({ status: 'ok' });
} catch (err) { } catch (err) {
console.error(err); console.error(err);

View File

@@ -0,0 +1,209 @@
const crypto = require('node:crypto');
const express = require('express');
const jwt = require('jsonwebtoken');
const passport = require('passport');
const rateLimit = require('express-rate-limit');
const router = express.Router();
const Campaign = require('../models/Campaign');
const DiscordGuildLink = require('../models/DiscordGuildLink');
const secret = require('../services/keys').secret;
const serviceLinks = require('../services/service-links');
const linkRateLimit = rateLimit({ windowMs: 15 * 60 * 1000, max: 40 });
const GUILD_ID = /^\d{5,25}$/;
// What the sign-up screen shows about the request behind a code.
function publicRequest(request) {
return {
service: request.service,
serviceName: serviceLinks.serviceName(request.service),
targetName: request.targetName,
targetUser: request.targetUser,
system: request.targetMeta?.system || '',
expiresAt: request.expiresAt
};
}
// A session for a service that keeps working once the browser which authorised
// it is gone: Obsidian gets the same kind of session signing in gives, so its
// notes keep travelling over the routes they always used.
function userSession(user) {
const payload = {
_id: user._id,
username: user.username,
name: user.name,
email: user.email,
admin: user.admin,
settings: user.settings
};
return jwt.sign(payload, secret, { expiresIn: 172800 });
}
// A Foundry world tells Dragonroll who it is when it asks for its link, so the
// user only has to say which campaign the world may work on.
async function completeFoundryLink(campaign, request) {
const linkedElsewhere = await Campaign.findOne({
foundryWorldId: request.targetId,
_id: { $ne: campaign._id }
}).select('_id');
if (linkedElsewhere) return { msg: 'foundry.errors.world-already-linked' };
campaign.foundryWorldId = request.targetId;
campaign.foundryWorldTitle = request.targetName;
campaign.foundrySystem = request.targetMeta?.system || '';
const settings = campaign.settings && typeof campaign.settings === 'object' ? campaign.settings : {};
const integrations = settings.integrations && typeof settings.integrations === 'object' ? settings.integrations : {};
const foundryUrl = request.targetMeta?.url || '';
if (foundryUrl && !integrations.foundryUrl) {
campaign.settings = { ...settings, integrations: { ...integrations, foundryUrl } };
}
const syncToken = crypto.randomBytes(32).toString('base64url');
campaign.foundrySyncTokenHash = serviceLinks.codeHash(syncToken);
await campaign.save();
const bridgeUrl = process.env.FOUNDRY_API_CLIENT_URL || process.env.FOUNDRY_API_URL;
const pushToken = process.env.FOUNDRY_API_PUSH_TOKEN;
return {
credentials: {
syncToken,
bridgeConfig: bridgeUrl && pushToken ? { url: bridgeUrl, pushToken } : null
}
};
}
// The Discord account behind the request is the one the bot answers to; a new
// authorization takes the server over from whoever held it before.
async function completeDiscordLink(campaign, request, user) {
await Campaign.updateMany(
{ discordGuildId: request.targetId, createdBy: { $ne: user.id } },
{ $unset: { discordGuildId: 1 } }
);
await DiscordGuildLink.findOneAndUpdate({ guildId: request.targetId }, {
$set: {
discordUserId: request.targetMeta?.userId || request.targetId,
dragonrollUser: user.id,
connectedAt: new Date()
}
}, { new: true, upsert: true, setDefaultsOnInsert: true });
campaign.discordGuildId = request.targetId;
await campaign.save();
}
// A service asks for a sign-up link and shows it to whoever is sitting in front
// of it. Nothing is linked until a Dragonroll user opens that link, signs in and
// picks one of their campaigns.
router.post('/start', linkRateLimit, async (req, res) => {
try {
const service = String(req.body.service || '').trim();
if (!serviceLinks.isService(service)) return res.json({ status: 'error', msg: 'link.errors.unknown-service' });
// A service that can prove who it is gets its link checked: a Discord
// server is claimed by whoever runs the bot, not by whoever knows its id.
if (serviceLinks.isBotOnly(service) && !serviceLinks.isDiscordBot(req)) {
return res.status(401).json({ status: 'error', msg: 'errors.unauthorized' });
}
const target = serviceLinks.readTarget(req.body);
if (!target.targetId) return res.json({ status: 'error', msg: 'errors.missing-data' });
if (service === 'discord' && (!GUILD_ID.test(target.targetId) || !target.targetName || !target.targetUser)) {
return res.json({ status: 'error', msg: 'errors.missing-data' });
}
const link = await serviceLinks.startServiceLink(service, target);
res.set('Cache-Control', 'no-store');
res.json({ status: 'ok', service, code: link.code, linkUrl: link.url, expiresAt: link.expiresAt });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
// What a sign-up link is about, so the screen can name the world, Discord server
// or vault that is waiting, and the person who asked.
router.post('/details', async (req, res) => {
try {
res.set('Cache-Control', 'no-store');
const request = await serviceLinks.findServiceLinkByCode(req.body.code);
if (!request || serviceLinks.linkIsExpired(request)) {
return res.json({ status: 'error', msg: 'link.errors.expired' });
}
res.json({ status: 'ok', ...publicRequest(request) });
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
// The user who signs in through a link owns the campaigns listed there, so
// picking one of them is the whole authorization.
router.post('/complete', passport.authenticate('jwt', { session: false }), async (req, res) => {
try {
res.set('Cache-Control', 'no-store');
const request = await serviceLinks.findServiceLinkByCode(req.body.code);
if (!request || serviceLinks.linkIsExpired(request)) {
return res.json({ status: 'error', msg: 'link.errors.expired' });
}
const campaign = await Campaign.findOne({ _id: req.body.campaignId, createdBy: req.user.id });
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
if (request.service === 'discord' && campaign.discordGuildId && campaign.discordGuildId !== request.targetId) {
return res.json({ status: 'error', msg: 'discord.errors.campaign-already-linked' });
}
if (request.service === 'foundry') {
const linked = await completeFoundryLink(campaign, request);
if (linked.msg) return res.json({ status: 'error', msg: linked.msg });
await serviceLinks.completeServiceLink(request, campaign, req.user, linked.credentials);
} else if (request.service === 'discord') {
await completeDiscordLink(campaign, request, req.user);
await serviceLinks.completeServiceLink(request, campaign, req.user);
} else {
await serviceLinks.completeServiceLink(request, campaign, req.user, { token: userSession(req.user) });
}
res.json({ status: 'ok', service: request.service, campaign: { id: campaign.id, name: campaign.name } });
} catch (err) {
console.error(err);
if (err.code === 11000) return res.json({ status: 'error', msg: 'foundry.errors.world-already-linked' });
res.json({ status: 'error', msg: 'errors.internal' });
}
});
// Where a link stands, and what the service that asked for it gets out of it.
// A credential is delivered once: a service that loses it asks for a new link.
router.post('/pickup', async (req, res) => {
try {
res.set('Cache-Control', 'no-store');
const request = await serviceLinks.findServiceLinkByCode(req.body.code);
if (!request || serviceLinks.linkIsExpired(request)) {
return res.json({ status: 'ok', state: 'expired' });
}
if (request.state !== 'linked') {
return res.json({ status: 'ok', state: request.state, campaign: null });
}
const campaign = await Campaign.findOne({ _id: request.campaign }).select('_id name').lean();
const credentials = await serviceLinks.takeServiceLinkCredentials(request);
res.json({
status: 'ok',
state: 'linked',
service: request.service,
campaign: campaign ? { id: String(campaign._id), name: campaign.name } : null,
syncToken: credentials?.syncToken || '',
bridgeConfig: credentials?.bridgeConfig || null,
token: credentials?.token || ''
});
} catch (err) {
console.error(err);
res.json({ status: 'error', msg: 'errors.internal' });
}
});
module.exports = router;

View File

@@ -0,0 +1,254 @@
const crypto = require('node:crypto');
const jwt = require('jsonwebtoken');
const ServiceLinkRequest = require('../models/ServiceLinkRequest');
const Campaign = require('../models/Campaign');
const keys = require('./keys');
// How long a sign-up link waits for somebody to open it.
const LINK_TTL_MS = 10 * 60 * 1000;
// How long the Discord bot can still confirm an authorization it was away for.
const NOTIFICATION_WINDOW_MS = 15 * 60 * 1000;
// The token the Obsidian plugin gets back is its long-lived credential: a plugin cannot ask
// somebody to open the sign-up link again every 48 hours. It carries the id of the link so that
// revoking the link works right away — see services/passport.js.
const OBSIDIAN_TOKEN_TTL = '365d';
// Every service that connects to a campaign does it the same way: it asks the
// backend for a sign-up link, shows it to the person sitting in front of it,
// and picks its credential up once a Dragonroll user has signed in through that
// link and chosen a campaign. `botOnly` services are the ones that can prove
// who they are to the backend; the others can only be trusted with their own
// link, which is why what they get from a link is decided by the user.
const SERVICES = {
foundry: { name: 'Foundry VTT' },
discord: { name: 'Discord', botOnly: true },
obsidian: { name: 'Obsidian' },
};
function isService(value) {
return Object.prototype.hasOwnProperty.call(SERVICES, value);
}
function serviceName(service) {
return SERVICES[service]?.name || service;
}
function isBotOnly(service) {
return SERVICES[service]?.botOnly === true;
}
function codeHash(code) {
return crypto.createHash('sha256').update(String(code ?? '').trim()).digest('hex');
}
function newLinkCode() {
return crypto.randomBytes(32).toString('base64url');
}
function frontendBaseUrl() {
return (process.env.DRAGONROLL_FRONTEND_URL || 'http://localhost:3000').trim().replace(/\/+$/, '');
}
// The sign-up link a service shows: it opens the Dragonroll page where somebody
// signs in and picks the campaign. The code travels in the fragment, so the
// browser never sends it to the server.
function signUpLinkUrl(service, code) {
return `${frontendBaseUrl()}/link/authorize?service=${encodeURIComponent(service)}#code=${encodeURIComponent(code)}`;
}
// The bot talks to the backend with a shared secret instead of a login, so a
// Discord server cannot be claimed by somebody who merely knows its id.
function isDiscordBot(req) {
const configuredSecret = process.env.DRAGONROLL_DISCORD_BOT_SECRET?.trim() || '';
const suppliedSecret = req.get('x-dragonroll-discord-bot-secret') || '';
const expected = Buffer.from(configuredSecret);
const supplied = Buffer.from(suppliedSecret);
return !!expected.length
&& expected.length === supplied.length
&& crypto.timingSafeEqual(expected, supplied);
}
function requireDiscordBot(req, res, next) {
if (!isDiscordBot(req)) {
return res.status(401).json({ status: 'error', msg: 'errors.unauthorized' });
}
return next();
}
function readText(value, max) {
return typeof value === 'string' ? value.trim().slice(0, max) : '';
}
// Whatever else a service says about itself: the Foundry system it runs, the
// Discord user id behind the person who asked... Values are kept short and
// plain, because they come from a service and end up shown to a user.
function readMeta(source) {
const meta = {};
for (const [key, value] of Object.entries(source).slice(0, MAX_META_ENTRIES)) {
if (value === null || value === undefined || typeof value === 'boolean') {
if (typeof value === 'boolean') meta[key] = value;
continue;
}
if (typeof value !== 'string' && typeof value !== 'number') continue;
meta[key] = String(value).trim().slice(0, MAX_META_VALUE_LENGTH);
}
return meta;
}
// How a service describes itself: which world/server/vault is asking, on whose
// behalf, and the little that goes with it.
function readTarget(body) {
const source = body?.target && typeof body.target === 'object' ? body.target : {};
const target = {
targetId: readText(source.id, 120),
targetName: readText(source.name, 200),
targetUser: readText(source.user, 120),
targetMeta: source.meta && typeof source.meta === 'object' && !Array.isArray(source.meta)
? readMeta(source.meta)
: {}
};
if (typeof target.targetMeta.url === 'string') {
try {
const url = new URL(target.targetMeta.url);
target.targetMeta.url = url.protocol === 'http:' || url.protocol === 'https:' ? url.origin : '';
} catch {
target.targetMeta.url = '';
}
}
return target;
}
function linkIsExpired(request) {
return request?.state === 'pending' && (!request.expiresAt || request.expiresAt <= new Date());
}
// A service asking again reuses its own row: one world, one Discord server and
// one vault each have a single link, and asking for it replaces the last one.
async function startServiceLink(service, target) {
const code = newLinkCode();
const expiresAt = new Date(Date.now() + LINK_TTL_MS);
const request = await ServiceLinkRequest.findOneAndUpdate(
{ service: service, targetId: target.targetId },
{
$set: {
service: service,
targetId: target.targetId,
targetName: target.targetName,
targetUser: target.targetUser,
targetMeta: target.targetMeta,
codeHash: codeHash(code),
state: 'pending',
expiresAt: expiresAt
},
$unset: {
campaign: 1,
dragonrollUser: 1,
credentials: 1,
linkedAt: 1,
pickedUpAt: 1,
notifiedAt: 1
}
},
{ new: true, upsert: true, setDefaultsOnInsert: true }
);
return { request, code, url: signUpLinkUrl(service, code), expiresAt };
}
async function findServiceLinkByCode(code) {
if (!code) return null;
return ServiceLinkRequest.findOne({ codeHash: codeHash(code) }).select('+credentials').lean();
}
// The credential that belongs to a link is handed over once and then dropped:
// whoever loses it starts the link again from the service, which is where they
// got the link from in the first place.
async function takeServiceLinkCredentials(request) {
const credentials = request?.credentials || null;
if (!credentials) return null;
await ServiceLinkRequest.updateOne(
{ _id: request._id },
{ $set: { pickedUpAt: new Date() }, $unset: { credentials: 1 } }
);
return credentials;
}
// The user who owns the campaign picked it for this link.
async function completeServiceLink(request, campaign, user, credentials = null) {
request.campaign = campaign._id;
request.dragonrollUser = user.id;
request.state = 'linked';
request.linkedAt = new Date();
request.pickedUpAt = null;
request.notifiedAt = null;
request.credentials = credentials || undefined;
// An answered link is the record of a live connection: it stays until the
// service re-links or the campaign unlinks it.
request.expiresAt = null;
await request.save();
return request;
}
// A campaign dropping a service: the link stops being valid, and the service
// finds that out the next time it asks.
async function revokeServiceLink(service, campaignId) {
const result = await ServiceLinkRequest.updateMany(
{ service: service, campaign: campaignId, state: 'linked' },
{
$set: { state: 'revoked', campaign: null },
$unset: { credentials: 1, linkedAt: 1 }
}
);
return result.matchedCount;
}
// What a campaign has connected to it, newest link first and one row per
// service, so the campaign settings can list its services together.
async function listLinkedServices(campaignId) {
const links = await ServiceLinkRequest.find({ campaign: campaignId, state: 'linked' })
.sort({ linkedAt: -1 })
.lean();
const seen = new Set();
const services = [];
for (const link of links) {
if (seen.has(link.service)) continue;
seen.add(link.service);
services.push({
service: link.service,
name: serviceName(link.service),
targetId: link.targetId || '',
targetName: link.targetName || '',
targetUser: link.targetUser || '',
dragonrollUser: link.dragonrollUser || null,
linkedAt: link.linkedAt
});
}
return services;
}
module.exports = {
LINK_TTL_MS,
NOTIFICATION_WINDOW_MS,
SERVICES,
codeHash,
completeServiceLink,
findServiceLinkByCode,
isBotOnly,
isDiscordBot,
isService,
linkIsExpired,
listLinkedServices,
readTarget,
requireDiscordBot,
revokeServiceLink,
serviceName,
signUpLinkUrl,
startServiceLink,
takeServiceLinkCredentials
};

View File

@@ -47,11 +47,23 @@ function createDragonrollApi(config) {
return payload; return payload;
} }
// The backend hands out the sign-up link the person opens to pick a campaign,
// so the bot never builds one itself: every service shows the same link.
async function startAuthorization(guildId, guildName, discordUserId, discordUserName) { async function startAuthorization(guildId, guildName, discordUserId, discordUserName) {
return request('/discord/link/start', { const payload = await request('/link/start', {
method: 'POST', method: 'POST',
body: JSON.stringify({ guildId, guildName, discordUserId, discordUserName }) body: JSON.stringify({
service: 'discord',
target: {
id: String(guildId),
name: guildName,
user: discordUserName,
meta: { userId: String(discordUserId) }
}
})
}); });
if (!payload.linkUrl) throw new Error('Dragonroll did not provide a sign-up link. Update the Dragonroll backend.');
return payload;
} }
async function claimLinkNotifications() { async function claimLinkNotifications() {

View File

@@ -41,6 +41,14 @@ For a local backend, use `http://localhost:5000`; the module omits `/api` and th
the local pairing route at its root. Character synchronization works without the optional snapshot the local pairing route at its root. Character synchronization works without the optional snapshot
bridge. Configure that bridge only if you also need the read-only world snapshot API described below. bridge. Configure that bridge only if you also need the read-only world snapshot API described below.
**Dragonroll Pairing Status** in the module settings always says whether this browser holds a pairing
and, once Dragonroll has answered `GET /api/foundry/sync/status`, which campaign the world is
connected to. It is written by the module, not by the GM: it appears as not connected until the world
is paired, names the campaign after a pairing or a check on world start and every minute afterwards,
gives the reason when a pairing code can never be redeemed, and says the world is no longer linked
once the campaign unlinks it. Because both the pairing code and the sync token are client settings,
another browser of the same world reads as not paired.
The campaign settings show the linked world's title and system. A Foundry world can be linked to The campaign settings show the linked world's title and system. A Foundry world can be linked to
only one campaign at a time. The pairing endpoint accepts cross-origin requests from the Foundry only one campaign at a time. The pairing endpoint accepts cross-origin requests from the Foundry
client and uses the one-time code instead of a Dragonroll login token. client and uses the one-time code instead of a Dragonroll login token.
@@ -53,6 +61,25 @@ within about five seconds. The module currently creates Dragonroll characters in
worlds. After updating an already-linked world to a version with character sync, create a fresh worlds. After updating an already-linked world to a version with character sync, create a fresh
pairing code and enter it in Foundry once to issue the sync token. pairing code and enter it in Foundry once to issue the sync token.
### Auto-sync, and sending one actor on purpose
**Dragonroll Auto-sync** in the module settings (on by default) is what keeps the campaign and this
world in step: actors and world items the GM creates, updates or deletes are sent to Dragonroll, and
both sides reconcile every few seconds. Turn it off to stop synchronizing altogether — nothing is
sent to the campaign, and Dragonroll stops rewriting those documents in Foundry, so the campaign
keeps whatever it already holds. Turn it back on to reconcile both sides again; the Foundry edits
queued while it was off are sent as the world catches up.
With autosync off — or any time a single character needs to cross over right now — right-click an
actor (or several selected ones) in the Foundry actor directory and pick **Dragonroll: Force Sync**.
Those actors, together with the gear carried inside them, are pushed to the campaign immediately even
when autosync is off. It is an upsert only: it never prunes the campaign's other actors, which a full
snapshot does and a forced sync never claims to. Actors Dragonroll does not import (anything that is
not a character, NPC or creature) are refused with a notification.
The optional read-only snapshot bridge is not affected: it keeps publishing the world snapshot behind
`/api/foundry/*`, which is never written into the campaign.
### Items ### Items
The campaign's Item list is synchronized with the world's gear, both ways: The campaign's Item list is synchronized with the world's gear, both ways:
@@ -84,6 +111,7 @@ The module calls these Dragonroll routes with the campaign sync token (no Dragon
| `POST /api/foundry/sync/item-delete` | A world item was deleted | | `POST /api/foundry/sync/item-delete` | A world item was deleted |
| `GET /api/foundry/sync/characters` | Characters to apply back in Foundry | | `GET /api/foundry/sync/characters` | Characters to apply back in Foundry |
| `GET /api/foundry/sync/items` | Items to apply back in Foundry | | `GET /api/foundry/sync/items` | Items 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/map` / `map-item` | Store an id mapping after creating a document |
| `POST /api/foundry/sync/delete` | An actor was deleted | | `POST /api/foundry/sync/delete` | An actor was deleted |

View File

@@ -2,7 +2,7 @@
"id": "dragonroll-foundry", "id": "dragonroll-foundry",
"title": "Dragonroll Foundry API", "title": "Dragonroll Foundry API",
"description": "Links a Foundry world to a Dragonroll campaign and exposes a client-side API for world data.", "description": "Links a Foundry world to a Dragonroll campaign and exposes a client-side API for world data.",
"version": "0.3.0", "version": "0.4.0",
"library": true, "library": true,
"compatibility": { "compatibility": {
"minimum": "12", "minimum": "12",

View File

@@ -4,17 +4,24 @@ const SETTING_PUSH_TOKEN = "pushToken";
const SETTING_BRIDGE_CONFIG = "bridgeConfig"; const SETTING_BRIDGE_CONFIG = "bridgeConfig";
const SETTING_DRAGONROLL_API_URL = "dragonrollApiUrl"; const SETTING_DRAGONROLL_API_URL = "dragonrollApiUrl";
const SETTING_LINK_CODE = "linkCode"; const SETTING_LINK_CODE = "linkCode";
const SETTING_LINK_URL = "linkUrl";
const SETTING_PAIRING_STATUS = "pairingStatus";
const SETTING_SYNC_TOKEN = "syncToken"; const SETTING_SYNC_TOKEN = "syncToken";
const SETTING_AUTO_SYNC = "autoSync";
// How often a world asks Dragonroll whether its sign-up link has been answered.
const LINK_POLL_MS = 5000;
let syncTimeout; let syncTimeout;
let syncInProgress = false; let syncInProgress = false;
let syncRequested = false; let syncRequested = false;
let handlingLinkCode = false; let askingForLink = false;
let updatingLinkCodeSetting = false; let checkingLink = false;
let linkRetriesDisabled = false; let updatingLinkSetting = false;
const FATAL_LINK_ERRORS = new Set([ // Marks a pairing Dragonroll honoured once and no longer accepts: the campaign
"foundry.errors.link-expired", // unlinked this world, so the token this client holds is dead.
"foundry.errors.world-already-linked", const PAIRING_REVOKED = "revoked";
]); let updatingPairingStatus = false;
let linkedCampaignName = "";
let linkProblem = "";
let actorSyncTimeout; let actorSyncTimeout;
let characterSyncRunning = false; let characterSyncRunning = false;
let actorSyncErrorLogged = false; let actorSyncErrorLogged = false;
@@ -130,13 +137,39 @@ Hooks.once("init", () => {
}); });
game.settings.register(MODULE_ID, SETTING_LINK_CODE, { game.settings.register(MODULE_ID, SETTING_LINK_CODE, {
name: "Dragonroll Campaign Pairing Code", name: "Dragonroll Connection Link Code",
hint: "Paste a pairing code created in Dragonroll campaign settings.", scope: "client",
config: false,
type: String,
default: "",
});
game.settings.register(MODULE_ID, SETTING_LINK_URL, {
name: "Dragonroll Connection Link",
scope: "client",
config: false,
type: String,
default: "",
});
game.settings.register(MODULE_ID, SETTING_PAIRING_STATUS, {
name: "Dragonroll Pairing Status",
hint: "Whether this world is connected to a Dragonroll campaign. The module keeps this text up to date: it asks Dragonroll for a sign-up link, and whoever opens that link picks the campaign. There is nothing to set here.",
scope: "client", scope: "client",
config: true, config: true,
type: String, type: String,
default: "", default: "",
onChange: handleLinkCodeChange, onChange: handlePairingStatusChange,
});
game.settings.register(MODULE_ID, SETTING_AUTO_SYNC, {
name: "Dragonroll Auto-sync",
hint: "Keep the linked Dragonroll campaign in step with this world as its actors and items change. Turn this off to stop synchronizing; the actor directory's Dragonroll: Force Sync entry then sends an actor over only when you ask for it.",
scope: "client",
config: true,
type: Boolean,
default: true,
onChange: handleAutoSyncChange,
}); });
const module = game.modules.get(MODULE_ID); const module = game.modules.get(MODULE_ID);
@@ -190,81 +223,186 @@ async function getDragonroll(path, token) {
return result; return result;
} }
function linkErrorMessage(error) { // --- Connecting a world ----------------------------------------------------
const messages = { // A world does not paste a code into its settings any more: it asks Dragonroll
"foundry.errors.link-expired": "The pairing code is invalid, expired, or already used.", // for the same sign-up link every service gets, the GM opens it and picks the
"foundry.errors.world-already-linked": "This Foundry world is already linked to another campaign.", // campaign this world may work on. That link then hands the world its token.
function worldLinkRequest() {
const world = api.getWorld();
return {
service: "foundry",
target: {
id: world.id,
name: world.title,
user: game.user?.name || "",
meta: { system: world.system, url: world.url },
},
}; };
return messages[error.message] || error.message;
} }
async function setLinkCode(value) { async function setLink(code, url) {
updatingLinkCodeSetting = true; updatingLinkSetting = true;
try { try {
await game.settings.set(MODULE_ID, SETTING_LINK_CODE, value); await game.settings.set(MODULE_ID, SETTING_LINK_CODE, code);
await game.settings.set(MODULE_ID, SETTING_LINK_URL, url);
} finally { } finally {
updatingLinkCodeSetting = false; updatingLinkSetting = false;
} }
} }
function handleLinkCodeChange(value) { async function requestDragonrollLink() {
if (updatingLinkCodeSetting || handlingLinkCode || !value?.trim()) return; if (askingForLink || !game.user?.isGM || !game.world) return;
linkRetriesDisabled = false; askingForLink = true;
completeDragonrollCampaignLink(value.trim()); try {
const result = await postDragonroll("link/start", worldLinkRequest());
linkProblem = "";
await setLink(String(result.code || ""), String(result.linkUrl || ""));
ui.notifications?.info(`Open this link to pick the Dragonroll campaign for this world: ${result.linkUrl}`);
} catch (error) {
console.error(`${MODULE_ID} | Could not get a Dragonroll connection link.`, error);
linkProblem = error.message;
} finally {
askingForLink = false;
await setPairingStatus(pairingStatusText());
}
} }
async function completeDragonrollCampaignLink(code, options = {}) { // What a link leaves this client with once a campaign has been picked: the token
if (handlingLinkCode) return; // its sync runs on, and the bridge settings that came with it.
handlingLinkCode = true; async function applyDragonrollLink(result) {
const notifyOnError = options.notifyOnError !== false; let syncTokenStored = false;
try { if (result.syncToken) {
if (!game.user?.isGM || !game.world) throw new Error("Open the world as a GM to link it."); try {
const result = await postDragonroll("foundry/link/complete", { code, world: api.getWorld() }); await game.settings.set(MODULE_ID, SETTING_SYNC_TOKEN, result.syncToken);
let syncTokenStored = false; syncTokenStored = true;
if (result.syncToken) { } catch (error) {
try { console.error(`${MODULE_ID} | Could not save the character sync token.`, error);
await game.settings.set(MODULE_ID, SETTING_SYNC_TOKEN, result.syncToken);
syncTokenStored = true;
} catch (error) {
console.error(`${MODULE_ID} | Could not save the character sync token.`, error);
}
} }
if (result.bridgeConfig?.url && result.bridgeConfig?.pushToken) { }
try { if (result.bridgeConfig?.url && result.bridgeConfig?.pushToken) {
await game.settings.set(MODULE_ID, SETTING_BRIDGE_CONFIG, result.bridgeConfig); try {
} catch (error) { await game.settings.set(MODULE_ID, SETTING_BRIDGE_CONFIG, result.bridgeConfig);
console.error(`${MODULE_ID} | Could not save the bridge configuration.`, error); } catch (error) {
ui.notifications?.warn("The world was linked, but its bridge settings could not be saved on this client."); console.error(`${MODULE_ID} | Could not save the bridge configuration.`, error);
} ui.notifications?.warn("This world was linked, but its bridge settings could not be saved on this client.");
}
// Keep an unprocessed pairing code in the setting when its sync token could
// not be saved, so the retry below can complete the link again.
if (syncTokenStored || !result.syncToken) await setLinkCode("");
if (!syncTokenStored) {
ui.notifications?.warn("The world was linked, but character sync is unavailable. Update Dragonroll and link the world again.");
} }
}
linkedCampaignName = String(result.campaign?.name || "").trim();
await setLink("", "");
if (syncTokenStored) {
ui.notifications?.info("This Foundry world is now linked to the Dragonroll campaign.");
scheduleSnapshotSync(0); scheduleSnapshotSync(0);
setTimeout(initializeCharacterSync, 0); setTimeout(initializeCharacterSync, 0);
setTimeout(reconcileDragonrollItems, 2000); setTimeout(reconcileDragonrollItems, 2000);
ui.notifications?.info("This Foundry world is now linked to the Dragonroll campaign."); } else {
} catch (error) { // Without a token this client cannot sync, and only a fresh link gives one.
console.error(`${MODULE_ID} | Could not complete the campaign link.`, error); linkProblem = "this client could not save the token it was given";
// Expired or already-used codes will never redeem, so stop the background ui.notifications?.warn("This world is linked to a Dragonroll campaign, but character sync is unavailable. Update Dragonroll and link the world again.");
// retry; any error keeps retrying (the Dragonroll server may be restarting).
linkRetriesDisabled = FATAL_LINK_ERRORS.has(error.message);
if (notifyOnError) ui.notifications?.error(linkErrorMessage(error));
} finally {
handlingLinkCode = false;
} }
} }
// A pairing code entered while the Dragonroll server was unreachable (or just // Where the sign-up link stands: still waiting for the GM to pick a campaign,
// before Foundry restarted) stays in the setting; redeem it on world start so // finished and handing its token over, or gone, in which case there is a new
// the connection survives restarts without typing the code in again. // link to show instead of a world that quietly stops trying.
async function resumePendingDragonrollLink(options = {}) { async function advanceDragonrollLink() {
if (handlingLinkCode || !game.user?.isGM || !game.world) return; if (askingForLink || checkingLink || !game.user?.isGM || !game.world || getSyncToken()) return;
const code = game.settings.get(MODULE_ID, SETTING_LINK_CODE)?.trim(); const code = game.settings.get(MODULE_ID, SETTING_LINK_CODE)?.trim();
if (code) await completeDragonrollCampaignLink(code, options); if (!code) return requestDragonrollLink();
checkingLink = true;
try {
const result = await postDragonroll("link/pickup", { code });
if (result.state === "pending") return;
if (result.state === "linked") await applyDragonrollLink(result);
else if (result.state === "revoked") {
linkProblem = PAIRING_REVOKED;
await setLink("", "");
} else {
await setLink("", "");
await requestDragonrollLink();
}
} catch (error) {
// Dragonroll may be restarting: the next check asks again.
console.warn(`${MODULE_ID} | Could not check the Dragonroll connection link.`, error);
} finally {
checkingLink = false;
await setPairingStatus(pairingStatusText());
}
}
// --- Pairing status --------------------------------------------------------
// The pairing status is the sentence the module settings show. Everything in it
// comes from this client plus what Dragonroll last said about its token, so it
// reads correctly from the first frame and is corrected by refreshPairingStatus.
function pairingStatusText() {
const link = game.settings.get(MODULE_ID, SETTING_LINK_URL)?.trim();
if (linkProblem === PAIRING_REVOKED) {
return link
? `Not connected: this world is no longer linked to the Dragonroll campaign it was paired with. Open ${link} to pick a campaign again.`
: "Not connected: this world is no longer linked to the Dragonroll campaign it was paired with. Its settings will show a link to pick one again.";
}
if (getSyncToken()) {
return linkedCampaignName
? `Connected to the Dragonroll campaign "${linkedCampaignName}".`
: "Connected to a Dragonroll campaign.";
}
if (linkProblem) return `Not connected: Dragonroll did not answer this world's link (${linkProblem})`;
if (link) {
return `Not connected yet: open ${link} in a browser, sign in and pick the campaign for this world.`;
}
return "Not connected to a Dragonroll campaign. Set the Dragonroll Endpoint in these settings, then reload this world to get a sign-up link.";
}
async function setPairingStatus(text) {
if (game.settings.get(MODULE_ID, SETTING_PAIRING_STATUS) === text) return;
updatingPairingStatus = true;
try {
await game.settings.set(MODULE_ID, SETTING_PAIRING_STATUS, text);
} catch (error) {
console.warn(`${MODULE_ID} | Could not store the Dragonroll pairing status.`, error);
} finally {
updatingPairingStatus = false;
}
}
// Nothing is configured here: anything typed into the status is replaced by the
// status the module actually has.
function handlePairingStatusChange() {
if (updatingPairingStatus) return;
setPairingStatus(pairingStatusText());
}
// A token in this client only proves the world was paired once. Ask Dragonroll
// which campaign that token belongs to, and hear back when the campaign has
// unlinked this world again in the meantime.
async function refreshPairingStatus() {
const token = getSyncToken();
if (!token) {
linkedCampaignName = "";
await setPairingStatus(pairingStatusText());
return;
}
try {
const result = await getDragonroll("foundry/sync/status", token);
linkedCampaignName = String(result.campaign?.name || "").trim();
if (linkProblem === PAIRING_REVOKED) linkProblem = "";
} catch (error) {
// An unauthorized token is a campaign that unlinked this world. Any other
// failure (an unreachable Dragonroll, or one old enough to have no status
// route) says nothing about the pairing, so keep showing what we know.
if (error.message === "unauthorized") {
linkProblem = PAIRING_REVOKED;
linkedCampaignName = "";
// The dead token is dropped so the world stops pushing to a campaign that
// no longer wants it, and its link check asks for a sign-up link again.
await game.settings.set(MODULE_ID, SETTING_SYNC_TOKEN, "");
ui.notifications?.warn("This world is no longer linked to its Dragonroll campaign. Its settings show the link to pick one again.");
}
}
await setPairingStatus(pairingStatusText());
} }
function scheduleSnapshotSync(delay = 500) { function scheduleSnapshotSync(delay = 500) {
@@ -287,6 +425,35 @@ function getSyncToken() {
return game.settings.get(MODULE_ID, SETTING_SYNC_TOKEN)?.trim() || ""; return game.settings.get(MODULE_ID, SETTING_SYNC_TOKEN)?.trim() || "";
} }
// Autosync is what the module has always done: every Foundry create, update and
// delete pushes to Dragonroll, and both sides reconcile on a timer. When it is
// off, nothing syncs on its own and only a forced actor sync reaches Dragonroll.
function isAutoSyncEnabled() {
return game.settings.get(MODULE_ID, SETTING_AUTO_SYNC) !== false;
}
function handleAutoSyncChange(value) {
if (value === false) {
clearTimeout(actorSyncTimeout);
clearTimeout(itemSyncTimeout);
return;
}
if (!game.user?.isGM || !getSyncToken()) return;
// Switching it back on converges both sides again, then the changes queued
// while autosync was off are pushed so this world's state wins over them.
initializeCharacterSync();
reconcileDragonrollItems();
if (queuedActorChanges.size) {
clearTimeout(actorSyncTimeout);
actorSyncTimeout = setTimeout(flushActorChanges, 400);
}
if (queuedItemChanges.size) {
clearTimeout(itemSyncTimeout);
itemSyncTimeout = setTimeout(flushItemChanges, 400);
}
}
function dragonrollActorId(actor) { function dragonrollActorId(actor) {
return actor.getFlag?.(MODULE_ID, "actorId") || actor.flags?.[MODULE_ID]?.actorId || ""; return actor.getFlag?.(MODULE_ID, "actorId") || actor.flags?.[MODULE_ID]?.actorId || "";
} }
@@ -380,6 +547,34 @@ async function deleteDragonrollActor(foundryActorId) {
}, token); }, token);
} }
// Sending actors on purpose, whether or not autosync is on: this is the push the
// GM asks for. It upserts those actors only, so unlike a full snapshot it never
// prunes anything else the campaign holds.
async function forceSyncActorsToDragonroll(actors) {
if (!game.user?.isGM || !game.world || !actors.length) return;
if (!getSyncToken()) {
ui.notifications?.warn("Link this world to a Dragonroll campaign before syncing actors to it.");
return;
}
const supported = actors.filter(isSupportedCharacterActor);
const refused = actors.filter((actor) => !supported.includes(actor));
if (refused.length) {
ui.notifications?.warn(`${refused.map((actor) => actor.name).join(", ")} ${refused.length === 1 ? "is" : "are"} not a character, NPC or creature: Dragonroll does not import ${refused.length === 1 ? "it" : "them"}.`);
}
if (!supported.length) return;
try {
await pushFoundryActors(supported);
ui.notifications?.info(supported.length === 1
? `${supported[0].name} was sent to the Dragonroll campaign.`
: `${supported.length} actors were sent to the Dragonroll campaign.`);
} catch (error) {
console.error(`${MODULE_ID} | Could not force sync the selected actors.`, error);
ui.notifications?.error(`Dragonroll sync failed: ${error.message}`);
}
}
function queueActorChange(kind, actor) { function queueActorChange(kind, actor) {
if (!actor || !game.user?.isGM || !getSyncToken()) return; if (!actor || !game.user?.isGM || !getSyncToken()) return;
if (syncingActorIds.has(actor.id) || actor.flags?.[MODULE_ID]?.syncMutation) return; if (syncingActorIds.has(actor.id) || actor.flags?.[MODULE_ID]?.syncMutation) return;
@@ -389,6 +584,9 @@ function queueActorChange(kind, actor) {
actorSyncTimeout = setTimeout(flushActorChanges, 400); actorSyncTimeout = setTimeout(flushActorChanges, 400);
} }
async function flushActorChanges() { async function flushActorChanges() {
// Autosync may have been switched off while changes were queued: keep them
// waiting so turning it back on still sends them.
if (!isAutoSyncEnabled()) return;
const changes = [...queuedActorChanges.values()]; const changes = [...queuedActorChanges.values()];
queuedActorChanges.clear(); queuedActorChanges.clear();
const deleted = changes.filter((change) => change.kind === "delete"); const deleted = changes.filter((change) => change.kind === "delete");
@@ -518,6 +716,8 @@ function queueFoundryItemChange(kind, item) {
} }
async function flushItemChanges() { async function flushItemChanges() {
// Autosync off: the queued edits wait here, like the actor changes do.
if (!isAutoSyncEnabled()) return;
const changes = [...queuedItemChanges.values()]; const changes = [...queuedItemChanges.values()];
queuedItemChanges.clear(); queuedItemChanges.clear();
const deleted = changes.filter((change) => change.kind === "delete"); const deleted = changes.filter((change) => change.kind === "delete");
@@ -616,7 +816,7 @@ async function createFoundryWorldItem(entry) {
async function reconcileDragonrollItems() { async function reconcileDragonrollItems() {
const token = getSyncToken(); const token = getSyncToken();
if (!token || !game.user?.isGM || !game.world || itemSyncRunning) return; if (!token || !game.user?.isGM || !game.world || itemSyncRunning || !isAutoSyncEnabled()) return;
itemSyncRunning = true; itemSyncRunning = true;
try { try {
if (game.system.id !== "dnd5e") { if (game.system.id !== "dnd5e") {
@@ -847,7 +1047,7 @@ async function createFoundryCharacter(entry) {
async function reconcileDragonrollCharacters() { async function reconcileDragonrollCharacters() {
const token = getSyncToken(); const token = getSyncToken();
if (!token || !game.user?.isGM || !game.world || characterSyncRunning) return; if (!token || !game.user?.isGM || !game.world || characterSyncRunning || !isAutoSyncEnabled()) return;
characterSyncRunning = true; characterSyncRunning = true;
try { try {
if (game.system.id !== "dnd5e") { if (game.system.id !== "dnd5e") {
@@ -887,7 +1087,7 @@ async function reconcileDragonrollCharacters() {
} }
async function initializeCharacterSync() { async function initializeCharacterSync() {
if (!getSyncToken() || !game.user?.isGM || !game.world) return; if (!getSyncToken() || !game.user?.isGM || !game.world || !isAutoSyncEnabled()) return;
try { try {
await pushFoundryActors(game.actors.contents, true); await pushFoundryActors(game.actors.contents, true);
await reconcileDragonrollCharacters(); await reconcileDragonrollCharacters();
@@ -978,11 +1178,14 @@ async function publishHeartbeat() {
} }
Hooks.once("ready", () => { Hooks.once("ready", () => {
resumePendingDragonrollLink(); advanceDragonrollLink().then(refreshPairingStatus);
// While this world has no campaign, its sign-up link is what the GM has to
// work with: keep showing it and keep asking whether it has been answered.
setInterval(() => { setInterval(() => {
if (linkRetriesDisabled) return; if (getSyncToken()) return;
resumePendingDragonrollLink({ notifyOnError: false }); advanceDragonrollLink();
}, 60000); }, LINK_POLL_MS);
setInterval(refreshPairingStatus, 60000);
scheduleSnapshotSync(0); scheduleSnapshotSync(0);
setInterval(publishHeartbeat, 60000); setInterval(publishHeartbeat, 60000);
setTimeout(initializeCharacterSync, 1000); setTimeout(initializeCharacterSync, 1000);
@@ -1016,3 +1219,21 @@ Hooks.once("ready", () => {
}); });
} }
}); });
// A GM sends selected actors to Dragonroll from the actor directory's context
// menu. This works with autosync on and off: it is the one push done on purpose.
Hooks.on("getActorDirectoryEntryContext", (html, options) => {
if (!game.user?.isGM || !getSyncToken()) return;
options.push({
name: "Dragonroll: Force Sync",
icon: '<i class="fa-solid fa-rotate"></i>',
// Array.from: the selected entries are jQuery in Foundry 12 and a plain
// array afterwards, and both are array-like.
callback: (entries) => forceSyncActorsToDragonroll(
Array.from(entries || [])
.map((entry) => game.actors?.get(entry.dataset?.actorId))
.filter(Boolean),
),
});
});

View File

@@ -2,7 +2,7 @@
import ContentManager from './components/managers/ContentManager.vue'; import ContentManager from './components/managers/ContentManager.vue';
import ToastManager from './components/managers/ToastManager.vue'; import ToastManager from './components/managers/ToastManager.vue';
import WindowManager from './components/managers/WindowManager.vue'; import WindowManager from './components/managers/WindowManager.vue';
import DiscordAuthorize from './components/views/DiscordAuthorize.vue'; import ServiceLinkAuthorize from './components/views/ServiceLinkAuthorize.vue';
import { CreateWindow } from '@/services/Windows' import { CreateWindow } from '@/services/Windows'
import { GetUser, HasAdmin } from './services/User'; import { GetUser, HasAdmin } from './services/User';
@@ -12,10 +12,14 @@ import { useCampaignService } from './services/Campaign';
const { RestoreCampaign } = useCampaignService(); const { RestoreCampaign } = useCampaignService();
// El bot de Discord enllaça amb aquesta pantalla; no és part de l'aplicació i no ha d'arrencar // Els serveis (Discord, Foundry, Obsidian) enllacen amb aquesta pantalla única; no són part
// les finestres normals. // de l'aplicació i no han d'arrencar les finestres normals. La ruta antiga de Discord també
// hi porta, perquè els enllaços que ja corren per Discord no queden morts.
const requestUrl = useRequestURL(); const requestUrl = useRequestURL();
const isDiscordAuthorize = computed(() => requestUrl.pathname.replace(/\/+$/, '') === '/discord/authorize'); const isServiceLink = computed(() => {
const path = requestUrl.pathname.replace(/\/+$/, '');
return path === '/link/authorize' || path === '/discord/authorize';
});
async function start(){ async function start(){
if(GetUser()){ if(GetUser()){
@@ -46,14 +50,14 @@ useHead({
onMounted(() => { onMounted(() => {
setupTheme(); setupTheme();
setTheme('dark'); setTheme('dark');
if(!isDiscordAuthorize.value){ if(!isServiceLink.value){
start(); start();
} }
}) })
</script> </script>
<template> <template>
<DiscordAuthorize v-if="isDiscordAuthorize"></DiscordAuthorize> <ServiceLinkAuthorize v-if="isServiceLink"></ServiceLinkAuthorize>
<div v-else class="viewer"> <div v-else class="viewer">
<ToastManager></ToastManager> <ToastManager></ToastManager>
<TooltipManager></TooltipManager> <TooltipManager></TooltipManager>

View File

@@ -3,6 +3,7 @@ import { computed, nextTick, onBeforeUnmount, onMounted, ref, watch } from 'vue'
import { useI18n } from 'vue-i18n'; import { useI18n } from 'vue-i18n';
import { useCampaignService } from '~/services/Campaign.js'; import { useCampaignService } from '~/services/Campaign.js';
import { AnchorMap, AnchoredMap, ClearAnchoredMap, SetActivePane } from '~/services/Content.js';
import { emitter } from '~/services/Emitter'; import { emitter } from '~/services/Emitter';
import Server from '~/services/Server'; import Server from '~/services/Server';
import { ClearWindow, CreateWindow, GetFirstWindowId } from '~/services/Windows'; import { ClearWindow, CreateWindow, GetFirstWindowId } from '~/services/Windows';
@@ -119,6 +120,9 @@ function handleCampaignEntryUpdated({ entityType, entry }) {
if (!list) return; if (!list) return;
list.value = list.value.map((current) => current._id === entry._id ? entry : current) list.value = list.value.map((current) => current._id === entry._id ? entry : current)
.sort((a, b) => a.name.localeCompare(b.name)); .sort((a, b) => a.name.localeCompare(b.name));
// The anchored map is this very entry (its pins changed, say): write it back without touching
// the pane, so switching back from the notes still shows what is on the map.
if (entityType === 'map' && AnchoredMap.value?._id === entry._id) AnchoredMap.value = entry;
} }
const campaignId = computed(() => { const campaignId = computed(() => {
@@ -207,6 +211,9 @@ async function fetchCampaignEntries(entityType = activeSection.value, silent = f
function selectSection(section) { function selectSection(section) {
activeSection.value = section; activeSection.value = section;
if (isEntrySection(section)) fetchCampaignEntries(section); if (isEntrySection(section)) fetchCampaignEntries(section);
// The content area follows the sidebar: maps shows the anchored map, everything else the
// notes that are currently open.
SetActivePane(section === 'maps' && AnchoredMap.value ? 'map' : 'notes');
} }
function createEntry(entityType) { function createEntry(entityType) {
@@ -272,6 +279,7 @@ function showEntryMenu(entry, entityType) {
const response = await Server().post(`/${entityType}/delete`, { id: entry._id }); const response = await Server().post(`/${entityType}/delete`, { id: entry._id });
if (response.data.status === 'ok' && list) { if (response.data.status === 'ok' && list) {
list.value = list.value.filter((current) => current._id !== entry._id); list.value = list.value.filter((current) => current._id !== entry._id);
if (entityType === 'map' && isAnchoredMap(entry)) ClearAnchoredMap();
} }
} catch (error) {} finally { HideContextMenu(); } } catch (error) {} finally { HideContextMenu(); }
} }
@@ -294,13 +302,17 @@ async function openCharacterSheet(actor) {
CreateWindow('character_sheet', { actor }); CreateWindow('character_sheet', { actor });
} }
async function openMapViewer(map) { // Maps are anchored on the note container instead of opening a window: the notes that were open
const existingWindowId = GetFirstWindowId('map_viewer'); // stay open, and the sidebar's notes/maps buttons switch between the two.
if (existingWindowId !== undefined) { function openMapViewer(map) {
ClearWindow({ id: existingWindowId }); if (!map) return;
await nextTick(); const floatingViewer = GetFirstWindowId('map_viewer');
} if (floatingViewer !== undefined) ClearWindow({ id: floatingViewer });
CreateWindow('map_viewer', { map, campaign: campaignId.value }); AnchorMap(map);
}
function isAnchoredMap(map) {
return AnchoredMap.value?._id === map._id;
} }
function createNote() { function createNote() {
@@ -324,6 +336,7 @@ watch(campaignId, (newVal) => {
actors.value = []; actors.value = [];
items.value = []; items.value = [];
maps.value = []; maps.value = [];
ClearAnchoredMap();
fetchCampaignNotes(); fetchCampaignNotes();
if (isEntrySection(activeSection.value)) fetchCampaignEntries(activeSection.value); if (isEntrySection(activeSection.value)) fetchCampaignEntries(activeSection.value);
} else { } else {
@@ -334,6 +347,7 @@ watch(campaignId, (newVal) => {
maps.value = []; maps.value = [];
notesError.value = ''; notesError.value = '';
entriesError.value = ''; entriesError.value = '';
ClearAnchoredMap();
} }
}); });
@@ -502,8 +516,11 @@ onBeforeUnmount(() => {
<div v-if="loadingEntries" class="sidebar-state">{{ t('campaigns.states.loading') }}</div> <div v-if="loadingEntries" class="sidebar-state">{{ t('campaigns.states.loading') }}</div>
<div v-else-if="entriesError" class="sidebar-state error">{{ entriesError }}</div> <div v-else-if="entriesError" class="sidebar-state error">{{ entriesError }}</div>
<div v-else-if="maps.length === 0" class="sidebar-state">{{ t('campaigns.states.empty-maps') }}</div> <div v-else-if="maps.length === 0" class="sidebar-state">{{ t('campaigns.states.empty-maps') }}</div>
<div v-for="map in maps" :key="map._id" class="entity-entry" role="button" tabindex="0" @click="openMapViewer(map)" @keydown.enter="openMapViewer(map)" @keydown.space.prevent="openMapViewer(map)" @contextmenu.prevent="showEntryMenu(map, 'map')"> <div v-for="map in maps" :key="map._id" class="entity-entry" :class="{ anchored: isAnchoredMap(map) }" role="button" tabindex="0" @click="openMapViewer(map)" @keydown.enter="openMapViewer(map)" @keydown.space.prevent="openMapViewer(map)" @contextmenu.prevent="showEntryMenu(map, 'map')">
<span class="entity-entry-name">{{ map.name }}</span> <span class="entity-entry-name-row">
<span class="entity-entry-name">{{ map.name }}</span>
<span v-if="isAnchoredMap(map)" class="entity-entry-sync">{{ t('campaigns.map.anchored') }}</span>
</span>
<span class="entity-entry-meta">{{ mapSummary(map) }}</span> <span class="entity-entry-meta">{{ mapSummary(map) }}</span>
<span v-if="!map.image" class="entity-entry-description">{{ t('campaigns.map.no-image') }}</span> <span v-if="!map.image" class="entity-entry-description">{{ t('campaigns.map.no-image') }}</span>
</div> </div>
@@ -648,14 +665,20 @@ onBeforeUnmount(() => {
} }
.entity-entry { .entity-entry {
width: 100%; padding: 9px 10px; border: 1px solid transparent; border-radius: 8px; /* These rows are divs (the note and folder rows are buttons) and there is no global box-sizing
reset, so without border-box the padding and border add onto the 100% width and the entry
sticks out of the sidebar. */
width: 100%; min-width: 0; box-sizing: border-box; padding: 9px 10px; border: 1px solid transparent;
border-radius: 8px;
background: transparent; color: var(--color-text); text-align: left; display: flex; flex-direction: column; background: transparent; color: var(--color-text); text-align: left; display: flex; flex-direction: column;
gap: 3px; cursor: pointer; gap: 3px; cursor: pointer;
} }
.entity-entry:hover { border-color: var(--color-border); background: var(--color-background-soft); } .entity-entry:hover { border-color: var(--color-border); background: var(--color-background-soft); }
.entity-entry:focus-visible { outline: 1px solid var(--color-link); } .entity-entry:focus-visible { outline: 1px solid var(--color-link); }
.entity-entry-name-row { display: flex; align-items: baseline; gap: 6px; } /* The map currently anchored on the note container. */
.entity-entry-name { font-weight: bold; } .entity-entry.anchored { border-color: var(--color-link); background: var(--color-background-soft); }
.entity-entry-name-row { display: flex; align-items: baseline; gap: 6px; min-width: 0; }
.entity-entry-name { font-weight: bold; min-width: 0; word-break: break-word; }
.entity-entry-sync { .entity-entry-sync {
font-size: 10px; font-size: 10px;
letter-spacing: 0.04em; letter-spacing: 0.04em;

View File

@@ -1,13 +1,30 @@
<script setup> <script setup>
import NoteContainer from './NoteContainer.vue'; import NoteContainer from './NoteContainer.vue';
import MapViewerPane from '../map/MapViewerPane.vue';
import { ActivePane, AnchoredMap, ClearAnchoredMap } from '~/services/Content.js';
import { useCampaignService } from '~/services/Campaign.js';
import { CreateWindow } from '~/services/Windows';
const { Campaign } = useCampaignService();
// Detaching gives the map back a floating window and shows the open notes again.
function DetachMap() {
const map = AnchoredMap.value;
if (!map) return;
ClearAnchoredMap();
CreateWindow('map_viewer', { map, campaign: Campaign.value?._id ?? null });
}
</script> </script>
<template> <template>
<div class="content"> <div class="content">
<NoteContainer> <NoteContainer v-show="ActivePane !== 'map'">
</NoteContainer> </NoteContainer>
<div v-if="AnchoredMap" v-show="ActivePane === 'map'" class="anchored-map">
<MapViewerPane :map="AnchoredMap" anchored @detach="DetachMap"></MapViewerPane>
</div>
<!-- PowerMod --> <!-- PowerMod -->
</div> </div>
</template> </template>
@@ -21,4 +38,14 @@ import NoteContainer from './NoteContainer.vue';
align-items: center; align-items: center;
} }
</style> /* Hidden with v-show so the open notes stay mounted while the anchored map is displayed. */
.anchored-map {
width: 100%;
height: 100%;
min-width: 0;
flex-grow: 1;
display: flex;
flex-direction: column;
}
</style>

View File

@@ -2,6 +2,7 @@
import { onMounted, onUnmounted, ref } from 'vue'; import { onMounted, onUnmounted, ref } from 'vue';
import Note from './Note.vue'; import Note from './Note.vue';
import { emitter } from '~/services/Emitter'; import { emitter } from '~/services/Emitter';
import { SetActivePane } from '~/services/Content.js';
let noteData = ref([]); let noteData = ref([]);
@@ -34,6 +35,9 @@ function pushNote(note){
} }
function handlePushNote(note) { function handlePushNote(note) {
// A note opened from the sidebar or the search palette always comes to the front, even when
// the content area is showing an anchored map.
SetActivePane('notes');
pushNote(note); pushNote(note);
} }

View File

@@ -0,0 +1,410 @@
<script setup>
import { computed, nextTick, onBeforeUnmount, onMounted, ref, watch } from 'vue';
import { useI18n } from 'vue-i18n';
import { ClearWindow, CreateWindow, GetFirstWindowId } from '@/services/Windows';
import { HideContextMenu, ShowContextMenu } from '~/services/ContextMenu';
import { BuildNoteOptions, OptionLabel, ToImagePoint, ToScreenPoint } from '~/services/MapPins';
import { DisplayToast } from '~/services/Toaster';
import Server, { getBaseUrl } from '~/services/Server';
import { emitter } from '~/services/Emitter';
import { useCampaignService } from '~/services/Campaign.js';
// The map viewer without window chrome: it fills whatever flex column holds it, so the same
// component works inside MapViewerWindow.vue and anchored on the campaign content area.
const props = defineProps({
map: { type: Object, default: null },
// Anchored maps can be detached into a floating window; the window itself does not offer it.
anchored: { type: Boolean, default: false }
});
const emit = defineEmits(['detach']);
const { Campaign } = useCampaignService();
const campaignId = computed(() => Campaign.value?._id ?? Campaign.value?.id ?? null);
const map = ref(props.map ? { ...props.map } : null);
const viewport = ref(null);
const zoom = ref(1);
const pan = ref({ x: 0, y: 0 });
const imageSize = ref({ width: 0, height: 0 });
const showGrid = ref(true);
const dragging = ref(false);
const minZoom = 0.05;
const maxZoom = 8;
const imageUrl = computed(() => {
const image = map.value?.image;
if (!image) return '';
return /^(https?:|data:|\/\/)/i.test(image) ? image : `${getBaseUrl()}/public/${image}`;
});
const stageStyle = computed(() => ({
transform: `translate3d(${pan.value.x}px, ${pan.value.y}px, 0) scale(${zoom.value})`
}));
// The grid is drawn in screen space over the image so its lines stay one pixel wide at any zoom.
const gridStyle = computed(() => {
if (!showGrid.value || !imageSize.value.width) return { display: 'none' };
const cell = `${Math.max(1, Number(map.value?.gridSize) || 50) * zoom.value}px`;
return {
width: `${imageSize.value.width * zoom.value}px`,
height: `${imageSize.value.height * zoom.value}px`,
transform: `translate3d(${pan.value.x + (Number(map.value?.offsetX) || 0) * zoom.value}px, ${pan.value.y + (Number(map.value?.offsetY) || 0) * zoom.value}px, 0)`,
backgroundImage: `linear-gradient(to right, var(--color-link) 1px, transparent 1px), linear-gradient(to bottom, var(--color-link) 1px, transparent 1px)`,
backgroundSize: `${cell} ${cell}`
};
});
const zoomPercent = computed(() => `${Math.round(zoom.value * 100)}%`);
function clampZoom(value) {
if (!Number.isFinite(value)) return minZoom;
return Math.min(maxZoom, Math.max(minZoom, value));
}
function fitToWindow() {
const bounds = viewport.value?.getBoundingClientRect();
if (!bounds || !imageSize.value.width) return;
zoom.value = clampZoom(Math.min(bounds.width / imageSize.value.width, bounds.height / imageSize.value.height));
centerOn();
}
function centerOn() {
const bounds = viewport.value?.getBoundingClientRect();
if (!bounds || !imageSize.value.width) return;
pan.value = {
x: (bounds.width - imageSize.value.width * zoom.value) / 2,
y: (bounds.height - imageSize.value.height * zoom.value) / 2
};
}
function onImageLoaded(event) {
imageSize.value = { width: event.target.naturalWidth, height: event.target.naturalHeight };
fitToWindow();
}
// Zoom keeping the map point under `point` where it is.
function zoomAt(factor, point) {
const next = clampZoom(zoom.value * factor);
if (next === zoom.value) return;
const ratio = next / zoom.value;
pan.value = {
x: point.x - (point.x - pan.value.x) * ratio,
y: point.y - (point.y - pan.value.y) * ratio
};
zoom.value = next;
}
function onWheel(event) {
const bounds = viewport.value?.getBoundingClientRect();
if (!bounds) return;
zoomAt(event.deltaY < 0 ? 1.15 : 1 / 1.15, { x: event.clientX - bounds.left, y: event.clientY - bounds.top });
}
function zoomFromToolbar(incoming) {
const bounds = viewport.value?.getBoundingClientRect();
if (!bounds) return;
zoomAt(incoming ? 1.25 : 1 / 1.25, { x: bounds.width / 2, y: bounds.height / 2 });
}
let pointerId = null;
let lastPointer = { x: 0, y: 0 };
function onPointerDown(event) {
if (event.button !== 0 || !viewport.value) return;
dragging.value = true;
pointerId = event.pointerId;
lastPointer = { x: event.clientX, y: event.clientY };
viewport.value.setPointerCapture?.(event.pointerId);
}
function onPointerMove(event) {
if (!dragging.value || event.pointerId !== pointerId) return;
pan.value = { x: pan.value.x + (event.clientX - lastPointer.x), y: pan.value.y + (event.clientY - lastPointer.y) };
lastPointer = { x: event.clientX, y: event.clientY };
}
function onPointerUp(event) {
if (event.pointerId !== pointerId) return;
dragging.value = false;
pointerId = null;
viewport.value?.releasePointerCapture?.(event.pointerId);
}
function editMap() {
if (!map.value || !campaignId.value) return;
CreateWindow('create_map', { campaign: campaignId.value, entry: map.value });
}
function handleMapUpdated({ entityType, entry }) {
if (entityType !== 'map' || entry?._id !== map.value?._id) return;
const imageChanged = entry.image !== map.value.image;
map.value = { ...entry };
// A new image is fitted again by onImageLoaded; grid-only changes just move the overlay.
if (imageChanged) imageSize.value = { width: 0, height: 0 };
}
// --- Notes pinned onto the map ---
// Right clicking the map pins one of the campaign notes at that spot, and clicking the marker reads
// it in a window of its own.
const { t } = useI18n();
const noteOptions = ref([]);
const pins = computed(() => map.value?.pins ?? []);
const labelByNoteId = computed(() => new Map(noteOptions.value.map((option) => [option.value, option.label])));
// What the pin helpers need to know about the current view to translate between image and screen.
function viewState() {
return { zoom: zoom.value, pan: pan.value, width: imageSize.value.width, height: imageSize.value.height };
}
function pinStyle(pin) {
const point = ToScreenPoint(pin, viewState());
return { left: `${point.x}px`, top: `${point.y}px` };
}
function pinLabel(pin) {
return labelByNoteId.value.get(String(pin?.note)) ?? '';
}
// Every note of the campaign, so notes living in a folder can be pinned too and every marker can
// say which note it is.
async function fetchPinnableNotes() {
if (!campaignId.value) {
noteOptions.value = [];
return;
}
try {
const response = await Server().get('/note/all', { params: { campaign: campaignId.value } });
noteOptions.value = response.data.status === 'ok'
? BuildNoteOptions(response.data.notes, response.data.folders)
: [];
} catch (error) {
noteOptions.value = [];
}
}
function onMapContextMenu(event) {
// A pin marks a spot on the image, so there is nothing to pin while the map has no image.
const bounds = viewport.value?.getBoundingClientRect();
if (!imageUrl.value || !bounds) return;
// Reaching a submenu moves the mouse away from the spot, so it is kept for the menu actions.
const spot = ToImagePoint({ x: event.clientX - bounds.left, y: event.clientY - bounds.top }, viewState());
if (!spot) return;
if (!noteOptions.value.length) {
ShowContextMenu([{ name: t('campaigns.map.pins.none'), action: () => HideContextMenu() }]);
return;
}
ShowContextMenu([{
name: t('campaigns.map.pins.add'),
icon: '/icons/iconoir/regular/map-pin-plus.svg',
context: noteOptions.value.map((option) => ({
name: option.label,
icon: '/icons/iconoir/regular/notes.svg',
action: () => { HideContextMenu(); savePin(option.value, spot); }
}))
}]);
}
function onPinContextMenu(pin) {
ShowContextMenu([
{
name: t('campaigns.map.pins.open'),
icon: '/icons/iconoir/regular/notes.svg',
action: () => { HideContextMenu(); openPinnedNote(pin); }
},
{ divider: true },
{
name: t('campaigns.map.pins.remove'),
icon: '/icons/iconoir/regular/map-pin-xmark.svg',
action: () => { HideContextMenu(); removePin(pin); }
}
]);
}
async function savePin(noteId, spot) {
await updatePins('/map/pin', { id: map.value?._id, note: noteId, x: spot.x, y: spot.y });
}
async function removePin(pin) {
await updatePins('/map/unpin', { id: map.value?._id, pin: pin?._id });
}
// Both pin changes answer with the whole map, which keeps the sidebar entry and the anchored map in
// step with what is on screen.
async function updatePins(route, body) {
if (!body.id) return;
try {
const response = await Server().post(route, body);
if (response.data.status !== 'ok') {
DisplayToast('red', t('campaigns.map.pins.error'), 3000);
return;
}
map.value = { ...response.data.map };
emitter.emit('campaign-entry-updated', { entityType: 'map', entry: response.data.map });
} catch (error) {
DisplayToast('red', t('campaigns.map.pins.error'), 3000);
}
}
async function openPinnedNote(pin) {
if (!pin?.note) return;
// One window reads the pinned notes; opening another one replaces it, like the character sheet.
const existingWindowId = GetFirstWindowId('pinned_note');
if (existingWindowId !== undefined) ClearWindow({ id: existingWindowId });
await nextTick();
CreateWindow('pinned_note', { note: pin.note });
}
// The backend drops the pins of a note along with it; the markers on this open map follow at once.
function handlePinnedNoteDeleted(noteKey) {
if (!pins.value.length) return;
const remaining = map.value.pins.filter((pin) => String(pin.note) !== String(noteKey));
if (remaining.length !== map.value.pins.length) map.value = { ...map.value, pins: remaining };
}
function handlePinnedNoteRenamed({ key, title }) {
const option = noteOptions.value.find((current) => current.value === String(key));
if (!option) return;
option.title = title;
option.label = OptionLabel(option);
}
// A different map was anchored while this pane was already mounted.
watch(() => props.map, (incoming, previous) => {
if (incoming === previous) return;
map.value = incoming ? { ...incoming } : null;
imageSize.value = { width: 0, height: 0 };
});
watch(campaignId, () => {
noteOptions.value = [];
fetchPinnableNotes();
});
onMounted(() => {
emitter.on('campaign-entry-updated', handleMapUpdated);
emitter.on('delete-note', handlePinnedNoteDeleted);
emitter.on('title-updated', handlePinnedNoteRenamed);
fetchPinnableNotes();
});
onBeforeUnmount(() => {
emitter.off('campaign-entry-updated', handleMapUpdated);
emitter.off('delete-note', handlePinnedNoteDeleted);
emitter.off('title-updated', handlePinnedNoteRenamed);
});
</script>
<template>
<div class="map-pane">
<div class="viewer-bar">
<div class="viewer-identity">
<strong>{{ map?.name }}</strong>
<span class="viewer-meta">{{ $t('campaigns.map.summary', { size: map?.gridSize, scale: map?.scale }) }}</span>
</div>
<div class="viewer-tools">
<button class="viewer-tool" :class="{ selected: showGrid }" type="button" :title="$t('campaigns.map.toggle-grid')"
:aria-label="$t('campaigns.map.toggle-grid')" :aria-pressed="showGrid.toString()" @click="showGrid = !showGrid">
<img class="tool-icon" src="/icons/iconoir/regular/view-grid.svg" alt="" aria-hidden="true">
</button>
<button class="viewer-tool" type="button" :title="$t('campaigns.map.zoom-out')" :aria-label="$t('campaigns.map.zoom-out')" @click="zoomFromToolbar(false)">
<img class="tool-icon" src="/icons/iconoir/regular/minus.svg" alt="" aria-hidden="true">
</button>
<span class="zoom-readout">{{ zoomPercent }}</span>
<button class="viewer-tool" type="button" :title="$t('campaigns.map.zoom-in')" :aria-label="$t('campaigns.map.zoom-in')" @click="zoomFromToolbar(true)">
<img class="tool-icon" src="/icons/iconoir/regular/plus.svg" alt="" aria-hidden="true">
</button>
<button class="viewer-tool" type="button" :title="$t('campaigns.map.fit')" :aria-label="$t('campaigns.map.fit')" @click="fitToWindow">
<img class="tool-icon" src="/icons/iconoir/regular/expand.svg" alt="" aria-hidden="true">
</button>
<button class="viewer-tool" type="button" :title="$t('campaigns.map.edit')" :aria-label="$t('campaigns.map.edit')" @click="editMap">
<img class="tool-icon" src="/icons/iconoir/regular/edit.svg" alt="" aria-hidden="true">
</button>
<button v-if="anchored" class="viewer-tool" type="button" :title="$t('campaigns.map.open-window')" :aria-label="$t('campaigns.map.open-window')"
@click="emit('detach')">
<img class="tool-icon" src="/icons/iconoir/regular/open-in-window.svg" alt="" aria-hidden="true">
</button>
</div>
</div>
<div
ref="viewport"
class="map-viewport"
:class="{ dragging }"
@wheel.prevent="onWheel"
@pointerdown="onPointerDown"
@pointermove="onPointerMove"
@pointerup="onPointerUp"
@pointercancel="onPointerUp"
@contextmenu.prevent="onMapContextMenu"
>
<template v-if="imageUrl">
<img class="map-image" :src="imageUrl" :style="stageStyle" :alt="map?.name" draggable="false" @load="onImageLoaded">
<div class="map-grid" :style="gridStyle" aria-hidden="true"></div>
<div class="map-pins">
<button
v-for="pin in pins"
:key="pin._id"
class="map-pin"
type="button"
:style="pinStyle(pin)"
:title="pinLabel(pin) || $t('campaigns.map.pins.open')"
:aria-label="pinLabel(pin) || $t('campaigns.map.pins.open')"
@pointerdown.stop
@click="openPinnedNote(pin)"
@contextmenu.stop.prevent="onPinContextMenu(pin)"
>
<img class="pin-icon" src="/icons/iconoir/solid/pin.svg" alt="" aria-hidden="true">
<span class="pin-label">{{ pinLabel(pin) }}</span>
</button>
</div>
</template>
<div v-else class="map-empty">
{{ $t('campaigns.map.no-image') }}
<button class="map-edit" type="button" @click="editMap">{{ $t('campaigns.map.upload-photo') }}</button>
</div>
</div>
</div>
</template>
<style scoped>
.map-pane { width: 100%; flex: 1; min-width: 0; min-height: 0; display: flex; flex-direction: column; overflow: hidden; }
.viewer-bar { width: 100%; box-sizing: border-box; display: flex; align-items: center; justify-content: space-between; gap: 10px; padding: 8px 10px; border-bottom: 1px solid var(--color-border); background: var(--color-background-light); }
.viewer-identity { min-width: 0; display: flex; flex-direction: column; gap: 2px; }
.viewer-identity strong { font-family: MrEavesRemake; overflow-wrap: anywhere; }
.viewer-meta { font-size: 11px; opacity: .72; }
.viewer-tools { display: flex; align-items: center; gap: 4px; }
.viewer-tool { width: 30px; height: 30px; margin: 0; padding: 0; border: 1px solid var(--color-border); border-radius: 7px; background: var(--color-background-soft); display: flex; align-items: center; justify-content: center; cursor: pointer; }
.viewer-tool:hover { background: var(--color-button-hover); }
.viewer-tool.selected { border-color: var(--color-link); background: var(--color-button-hover); }
.tool-icon { width: 16px; height: 16px; filter: invert(var(--color-icon-invert)); }
.zoom-readout { min-width: 46px; text-align: center; font-size: 12px; }
.map-viewport { position: relative; width: 100%; flex: 1; min-height: 0; overflow: hidden; background-color: var(--color-background); cursor: grab; touch-action: none; }
.map-viewport.dragging { cursor: grabbing; }
.map-image { position: absolute; top: 0; left: 0; max-width: none; transform-origin: top left; user-select: none; }
.map-grid { position: absolute; top: 0; left: 0; opacity: .55; pointer-events: none; }
/* Pins live in image pixels but are drawn in screen space (see ToScreenPoint), so the overlay stays
unscaled and their markers are readable at every zoom. Only the markers catch the mouse. */
.map-pins { position: absolute; inset: 0; pointer-events: none; }
.map-pin {
position: absolute; transform: translate(-50%, -100%); pointer-events: auto;
display: flex; align-items: center; gap: 4px; margin: 0; padding: 3px 6px;
border: 1px solid var(--color-link); border-radius: 7px;
background: var(--color-background-soft); color: var(--color-text);
font-size: 11px; cursor: pointer; box-shadow: 0px 0px 6px -1px rgba(0,0,0,0.55);
}
.map-pin:hover { background: var(--color-button-hover); }
.map-pin:focus-visible { outline: 1px solid var(--color-link); }
.pin-icon { width: 12px; height: 12px; filter: invert(var(--color-icon-invert)); }
/* The note's name only when it is asked for: a map full of labels is a map nobody can read. */
.pin-label { display: none; max-width: 200px; overflow: hidden; text-overflow: ellipsis; white-space: nowrap; }
.map-pin:hover .pin-label, .map-pin:focus-visible .pin-label { display: inline; }
.map-empty { width: 100%; height: 100%; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 8px; font-size: 13px; opacity: .8; }
.map-edit { border: 1px solid var(--color-border); border-radius: 7px; padding: 6px 11px; background: var(--color-background-soft); color: var(--color-text); font-size: 12px; cursor: pointer; }
.map-edit:hover { background: var(--color-button-hover); }
</style>

View File

@@ -1,260 +0,0 @@
<script setup>
import { onMounted, ref } from 'vue';
import Server from '~/services/Server';
import { GetUser, SetUser } from '~/services/User';
import { AddSound } from '~/services/Sound';
import Spinner from '../partials/Spinner.vue';
// Pantalla autònoma que el bot obre des de Discord: l'usuari s'identifica aquí
// i autoritza el servidor de Discord que s'ha rebut per la URL.
useHead({ title: 'Connect Dragonroll to Discord' });
const card = ref(null);
const code = ref('');
const guildName = ref('');
const discordUserName = ref('');
const signedInAs = ref('');
const connectedGuild = ref('');
// 'checking' | 'login' | 'approve' | 'connected' | 'error'
const status = ref('checking');
const messageKey = ref('');
const username = ref('');
const password = ref('');
const busy = ref(false);
function readCode() {
const hash = new URLSearchParams(window.location.hash.slice(1));
const search = new URLSearchParams(window.location.search);
return hash.get('code') || search.get('code') || '';
}
function ShowError(key) {
messageKey.value = key;
}
function PrepareApproval() {
const user = GetUser();
if (!user) {
status.value = 'login';
messageKey.value = '';
return;
}
signedInAs.value = user.username || user.name || user.email || 'Dragonroll';
status.value = 'approve';
messageKey.value = '';
}
async function LoadRequest() {
const response = await Server().post('/discord/link/details', { code: code.value });
const details = response.data;
if (details.status !== 'ok') {
status.value = 'error';
ShowError('discord.errors.link-expired');
return;
}
guildName.value = details.guildName;
discordUserName.value = details.discordUserName;
PrepareApproval();
}
async function SignIn() {
busy.value = true;
messageKey.value = '';
try {
const response = await Server().post('/user/login', {
usermail: username.value,
password: password.value
});
if (response.data.status !== 'ok' || !response.data.token) {
ShowError(response.data.msg || 'discord.errors.sign-in-failed');
return;
}
// El token passa al servei d'usuari perquè el client el reutilitzi en autoritzar.
SetUser(response.data.token);
password.value = '';
PrepareApproval();
} catch {
ShowError('discord.errors.sign-in-failed');
} finally {
busy.value = false;
}
}
async function Authorize() {
busy.value = true;
try {
const response = await Server().post('/discord/link/complete', { code: code.value });
if (response.data.status !== 'ok') {
status.value = 'error';
ShowError('discord.errors.link-expired');
return;
}
connectedGuild.value = response.data.guildName;
status.value = 'connected';
messageKey.value = '';
// El codi ja s'ha fet servir, treu-lo de la barra d'adreces.
window.history.replaceState(null, '', window.location.pathname);
} catch (error) {
if (error?.response?.status === 401) {
status.value = 'login';
ShowError('discord.errors.session-expired');
return;
}
status.value = 'error';
ShowError('discord.errors.link-expired');
} finally {
busy.value = false;
}
}
onMounted(() => {
AddSound(card.value);
code.value = readCode();
if (!code.value) {
status.value = 'error';
ShowError('discord.errors.missing-code');
return;
}
LoadRequest().catch(() => {
status.value = 'error';
ShowError('discord.errors.internal');
});
});
</script>
<template>
<div class="discord-authorize">
<main class="authorize-card" ref="card">
<h1>{{ $t('discord.title') }}</h1>
<p v-if="guildName" class="summary">
{{ $t('discord.summary', { guild: guildName, user: discordUserName }) }}
</p>
<p v-else-if="status !== 'error'" class="summary">
<Spinner v-if="status === 'checking'"></Spinner>
<span v-else>{{ $t('discord.checking') }}</span>
</p>
<form v-if="status === 'login'" v-on:submit.prevent="SignIn">
<p>{{ $t('discord.sign-in-lead') }}</p>
<div class="form-field">
<label for="discord-authorize-usermail">{{ $t('login.username') }}</label>
<input
id="discord-authorize-usermail"
type="text"
:placeholder="$t('login.username-placeholder')"
name="usermail"
autocomplete="username"
v-model="username"
required
>
</div>
<div class="form-field">
<label for="discord-authorize-password">{{ $t('login.password') }}</label>
<input
id="discord-authorize-password"
type="password"
name="password"
autocomplete="current-password"
v-model="password"
required
>
</div>
<button class="btn-primary sound-click" type="submit" :disabled="busy">
<Spinner v-if="busy"></Spinner>
<span v-else>{{ $t('login.log-in') }}</span>
</button>
</form>
<section v-if="status === 'approve'">
<p>{{ $t('discord.signed-in-as', { user: signedInAs }) }}</p>
<p class="hint">{{ $t('discord.next-step') }}</p>
<p class="hint">{{ $t('discord.replace-warning') }}</p>
<button class="btn-primary sound-click" type="button" :disabled="busy" v-on:click="Authorize">
<Spinner v-if="busy"></Spinner>
<span v-else>{{ $t('discord.approve') }}</span>
</button>
</section>
<section v-if="status === 'connected'">
<p class="success">{{ $t('discord.connected', { guild: connectedGuild }) }}</p>
<p class="hint">{{ $t('discord.next-step') }}</p>
</section>
<p v-if="messageKey" class="error" role="status">
{{ $t(messageKey) }}
</p>
</main>
</div>
</template>
<style scoped>
.discord-authorize {
display: grid;
place-items: center;
width: 100%;
min-height: 100vh;
padding: 24px;
box-sizing: border-box;
background-color: var(--color-background);
color: var(--color-text);
}
.authorize-card {
width: min(100%, 460px);
padding: 28px;
box-sizing: border-box;
background-color: var(--color-window-background);
border: 1px solid var(--color-window-border);
border-radius: 12px;
box-shadow: 0 8px 24px var(--color-window-shadow);
text-align: center;
user-select: none;
}
.authorize-card h1 {
margin-top: 0;
font-family: 'MrEavesRemake', serif;
font-size: 1.5rem;
}
.authorize-card p {
line-height: 1.5;
}
.summary {
color: var(--color-gray);
}
form,
section {
margin-top: 18px;
}
.hint {
color: var(--color-gray);
font-size: 0.95rem;
}
.success {
color: var(--color-green);
}
.error {
color: var(--color-red);
}
button {
width: 100%;
}
</style>

View File

@@ -0,0 +1,395 @@
<script setup>
import { computed, onMounted, ref } from 'vue';
import Server from '~/services/Server';
import { GetUser, SetUser } from '~/services/User';
import { AddSound } from '~/services/Sound';
import Spinner from '../partials/Spinner.vue';
// Pantalla única d'enllaç de serveis (Discord, Foundry, Obsidian): el servei demana
// l'enllaç al backend, l'usuari hi entra, s'identifica i tria la campanya que el
// servei podrà fer servir. Abans cada servei tenia la seva pròpia pantalla.
const card = ref(null);
const service = ref('');
const serviceName = ref('Dragonroll');
const code = ref('');
const targetName = ref('');
const targetUser = ref('');
const system = ref('');
const signedInAs = ref('');
const campaigns = ref([]);
const selectedCampaign = ref('');
const connectedCampaign = ref('');
// 'checking' | 'login' | 'pick' | 'connected' | 'error'
const status = ref('checking');
const messageKey = ref('');
const username = ref('');
const password = ref('');
const busy = ref(false);
// El nom propi del servei és l'últim recurs: el backend el dona amb la petició.
const serviceLabel = computed(() => serviceName.value || serviceNameOf(service.value));
// Cada servei explica d'una manera què és el que demana i què cal fer després.
const targetKey = computed(() => `link.target.${service.value || 'other'}`);
const nextKey = computed(() => `link.next.${service.value || 'other'}`);
function serviceNameOf(value) {
if (value === 'discord') return 'Discord';
if (value === 'foundry') return 'Foundry VTT';
if (value === 'obsidian') return 'Obsidian';
return 'Dragonroll';
}
// El codi viatja al fragment de la URL, així que el navegador no l'envia mai al
// servidor. El servei, que és qui demana l'enllaç, hi posa també el seu nom.
function readLinkParams() {
const hash = new URLSearchParams(window.location.hash.slice(1));
const search = new URLSearchParams(window.location.search);
return {
code: hash.get('code') || search.get('code') || '',
service: hash.get('service') || search.get('service') || ''
};
}
function ShowError(key) {
messageKey.value = key;
}
function AskForLogin() {
const user = GetUser();
if (!user) {
status.value = 'login';
messageKey.value = '';
return;
}
signedInAs.value = user.username || user.name || user.email || 'Dragonroll';
status.value = 'pick';
messageKey.value = '';
LoadCampaigns();
}
async function LoadLinkDetails() {
const response = await Server().post('/link/details', { code: code.value });
const details = response.data;
if (details.status !== 'ok') {
status.value = 'error';
ShowError('link.errors.expired');
return;
}
service.value = details.service || service.value;
serviceName.value = details.serviceName || serviceNameOf(service.value);
targetName.value = details.targetName || '';
targetUser.value = details.targetUser || '';
system.value = details.system || '';
AskForLogin();
}
async function LoadCampaigns() {
try {
const response = await Server().get('/campaign/list');
campaigns.value = (response.data.status === 'ok' && Array.isArray(response.data.campaigns))
? response.data.campaigns
: [];
if (campaigns.value.length === 1) selectedCampaign.value = String(campaigns.value[0]._id);
} catch {
campaigns.value = [];
}
}
async function SignIn() {
busy.value = true;
messageKey.value = '';
try {
const response = await Server().post('/user/login', {
usermail: username.value,
password: password.value
});
if (response.data.status !== 'ok' || !response.data.token) {
ShowError(response.data.msg || 'link.errors.sign-in-failed');
return;
}
// El token passa al servei d'usuari perquè el client el reutilitzi en connectar.
SetUser(response.data.token);
password.value = '';
AskForLogin();
} catch {
ShowError('link.errors.sign-in-failed');
} finally {
busy.value = false;
}
}
// A campaign that already has this very service on it is being re-connected, and
// saying so is what keeps the picker honest.
function AlreadyLinked(campaign) {
if (service.value === 'foundry') return !!campaign.foundryWorldId;
if (service.value === 'discord') return !!campaign.discordGuildId;
return false;
}
async function Connect() {
if (!selectedCampaign.value) {
ShowError('link.errors.no-campaign');
return;
}
busy.value = true;
messageKey.value = '';
try {
const response = await Server().post('/link/complete', {
code: code.value,
campaignId: selectedCampaign.value
});
if (response.data.status !== 'ok') {
ShowError(response.data.msg || 'link.errors.expired');
return;
}
connectedCampaign.value = response.data.campaign?.name || '';
status.value = 'connected';
// El codi ja s'ha fet servir, treu-lo de la barra d'adreces.
window.history.replaceState(null, '', window.location.pathname);
} catch (error) {
if (error?.response?.status === 401) {
status.value = 'login';
ShowError('link.errors.session-expired');
return;
}
ShowError('link.errors.internal');
} finally {
busy.value = false;
}
}
useHead({
title: computed(() => `Connect ${serviceLabel.value} to Dragonroll`)
});
onMounted(() => {
AddSound(card.value);
const params = readLinkParams();
code.value = params.code;
service.value = params.service || (window.location.pathname.startsWith('/discord') ? 'discord' : '');
if (!code.value) {
status.value = 'error';
ShowError('link.errors.missing-code');
return;
}
LoadLinkDetails().catch(() => {
status.value = 'error';
ShowError('link.errors.internal');
});
});
</script>
<template>
<div class="service-link">
<main class="link-card" ref="card">
<h1>{{ $t('link.title', { service: serviceLabel }) }}</h1>
<p v-if="targetName" class="summary">
{{ $t(targetKey, {
target: targetName,
user: targetUser,
system: system ? $t('link.system', { system }) : ''
}) }}
</p>
<p v-else-if="status !== 'error'" class="summary">
<Spinner v-if="status === 'checking'"></Spinner>
<span v-else>{{ $t('link.checking') }}</span>
</p>
<form v-if="status === 'login'" v-on:submit.prevent="SignIn">
<p>{{ $t('link.sign-in-lead', { service: serviceLabel }) }}</p>
<div class="form-field">
<label for="service-link-usermail">{{ $t('login.username') }}</label>
<input
id="service-link-usermail"
type="text"
:placeholder="$t('login.username-placeholder')"
name="usermail"
autocomplete="username"
v-model="username"
required
>
</div>
<div class="form-field">
<label for="service-link-password">{{ $t('login.password') }}</label>
<input
id="service-link-password"
type="password"
name="password"
autocomplete="current-password"
v-model="password"
required
>
</div>
<button class="btn-primary sound-click" type="submit" :disabled="busy">
<Spinner v-if="busy"></Spinner>
<span v-else>{{ $t('login.log-in') }}</span>
</button>
</form>
<section v-if="status === 'pick'">
<p>{{ $t('link.signed-in-as', { user: signedInAs }) }}</p>
<p class="question">{{ $t('link.pick-campaign', { service: serviceLabel }) }}</p>
<p v-if="!campaigns.length" class="hint">{{ $t('link.no-campaigns') }}</p>
<ul v-else class="campaigns">
<li v-for="campaign in campaigns" :key="campaign._id">
<label class="campaign" :class="{ selected: selectedCampaign === String(campaign._id) }">
<input
type="radio"
name="campaign"
:value="String(campaign._id)"
v-model="selectedCampaign"
>
<span class="swatch" :style="{ backgroundColor: campaign.color || 'var(--color-accent)' }"></span>
<span class="campaign-name">{{ campaign.name }}</span>
<span v-if="AlreadyLinked(campaign)" class="badge">
{{ $t('link.already-linked', { service: serviceLabel }) }}
</span>
</label>
</li>
</ul>
<p class="hint">{{ $t('link.trust-warning', { service: serviceLabel }) }}</p>
<p class="hint">{{ $t('link.replace-warning') }}</p>
<button
class="btn-primary sound-click"
type="button"
:disabled="busy || !selectedCampaign"
v-on:click="Connect"
>
<Spinner v-if="busy"></Spinner>
<span v-else>{{ $t('link.connect', { service: serviceLabel }) }}</span>
</button>
</section>
<section v-if="status === 'connected'">
<p class="success">{{ $t('link.connected', { campaign: connectedCampaign }) }}</p>
<p class="hint">{{ $t(nextKey, { service: serviceLabel }) }}</p>
</section>
<p v-if="messageKey" class="error" role="status">
{{ $t(messageKey) }}
</p>
</main>
</div>
</template>
<style scoped>
.service-link {
display: grid;
place-items: center;
width: 100%;
min-height: 100vh;
padding: 24px;
box-sizing: border-box;
background-color: var(--color-background);
color: var(--color-text);
}
.link-card {
width: min(100%, 460px);
padding: 28px;
box-sizing: border-box;
background-color: var(--color-window-background);
border: 1px solid var(--color-window-border);
border-radius: 12px;
box-shadow: 0 8px 24px var(--color-window-shadow);
text-align: center;
user-select: none;
}
.link-card h1 {
margin-top: 0;
font-family: 'MrEavesRemake', serif;
font-size: 1.5rem;
}
.link-card p {
line-height: 1.5;
}
.summary {
color: var(--color-gray);
}
form,
section {
margin-top: 18px;
}
.question {
font-weight: bold;
}
.campaigns {
list-style: none;
margin: 0 0 14px 0;
padding: 0;
display: flex;
flex-direction: column;
gap: 8px;
text-align: left;
}
.campaign {
display: flex;
align-items: center;
gap: 10px;
padding: 10px;
border: 1px solid var(--color-border);
border-radius: 8px;
cursor: pointer;
}
.campaign.selected {
border-color: var(--color-accent);
background-color: var(--color-background-soft);
}
.swatch {
width: 14px;
height: 14px;
border-radius: 4px;
flex: 0 0 auto;
border: 1px solid var(--color-border);
}
.campaign-name {
flex: 1;
}
.badge {
font-size: 0.8rem;
color: var(--color-gray);
}
.hint {
color: var(--color-gray);
font-size: 0.95rem;
}
.success {
color: var(--color-green);
}
.error {
color: var(--color-red);
}
button {
width: 100%;
}
</style>

View File

@@ -1,5 +1,5 @@
<script setup> <script setup>
import { onBeforeUnmount, onMounted, ref } from 'vue'; import { onMounted, ref } from 'vue';
import WindowHandle from './partials/WindowHandle.vue'; import WindowHandle from './partials/WindowHandle.vue';
import Tabs from '../layouts/Tabs.vue'; import Tabs from '../layouts/Tabs.vue';
import { SetupHandle, SetSize, ResetPosition, Top, SetResizable, SetMinSize } from '@/services/Windows'; import { SetupHandle, SetSize, ResetPosition, Top, SetResizable, SetMinSize } from '@/services/Windows';
@@ -17,18 +17,20 @@ const name = ref(campaign.name || '');
const color = ref(campaign.color || '#6b6b6b'); const color = ref(campaign.color || '#6b6b6b');
const settings = ref(campaign.settings && typeof campaign.settings === 'object' ? campaign.settings : {}); const settings = ref(campaign.settings && typeof campaign.settings === 'object' ? campaign.settings : {});
const foundryUrl = ref(settings.value.integrations?.foundryUrl || ''); const foundryUrl = ref(settings.value.integrations?.foundryUrl || '');
const pairingCode = ref('');
const requestId = ref('');
const linking = ref(false);
const id = data.id; const id = data.id;
let statusPoll;
let checkingStatus = false; // Els serveis s'enllacen tots igual: ells mostren un enllaç de Dragonroll i aquí
// només es mira què té connectat la campanya i se'n desenllaça el que calgui.
const services = ref([]);
const unlinked = ref('');
const rows = [ const rows = [
{ id: 'basic', value: 'campaigns.settings.tabs.basic' }, { id: 'basic', value: 'campaigns.settings.tabs.basic' },
{ id: 'integrations', value: 'campaigns.settings.tabs.integrations' } { id: 'integrations', value: 'campaigns.settings.tabs.integrations' }
]; ];
const serviceKeys = ['foundry', 'discord', 'obsidian'];
onMounted(() => { onMounted(() => {
Top(wrapper); Top(wrapper);
SetupHandle(id, handle); SetupHandle(id, handle);
@@ -36,11 +38,7 @@ onMounted(() => {
ResetPosition(id, 'center'); ResetPosition(id, 'center');
SetResizable(id, true); SetResizable(id, true);
SetMinSize(id, { width: 440, height: 340 }); SetMinSize(id, { width: 440, height: 340 });
ResumePendingFoundryLink(); LoadServices();
});
onBeforeUnmount(() => {
clearInterval(statusPoll);
}); });
function ApplyCampaignUpdate(updatedCampaign) { function ApplyCampaignUpdate(updatedCampaign) {
@@ -100,95 +98,56 @@ async function SaveSettings() {
} }
} }
async function StartFoundryLink() { async function LoadServices() {
linking.value = true;
try { try {
const response = await Server().post('/campaign/foundry-link/start', { campaignId: campaign._id }); const response = await Server().get(`/campaign/services?campaignId=${campaign._id}`);
if (response.data.status !== 'ok') { services.value = response.data.status === 'ok' && Array.isArray(response.data.services)
DisplayToast('red', $t(response.data.msg || 'errors.internal'), 3000); ? response.data.services
return; : [];
}
pairingCode.value = response.data.code;
requestId.value = response.data.requestId;
clearInterval(statusPoll);
statusPoll = setInterval(CheckFoundryLinkStatus, 2500);
} catch { } catch {
DisplayToast('red', $t('errors.internal'), 3000); services.value = [];
} finally {
linking.value = false;
} }
} }
// The pairing code lives server-side until it expires, so re-attach to it when function LinkFor(service) {
// the window opens again after a reload, restart or closing the window. return services.value.find((link) => link.service === service) || null;
async function ResumePendingFoundryLink() {
try {
const response = await Server().get(`/campaign/foundry-link/pending?campaignId=${campaign._id}`);
if (response.data.status !== 'ok' || !response.data.request) return;
pairingCode.value = response.data.request.code || '';
requestId.value = response.data.request.requestId;
clearInterval(statusPoll);
statusPoll = setInterval(CheckFoundryLinkStatus, 2500);
} catch {
// Showing the stored pairing code is best-effort; ignore resume failures.
}
} }
async function CheckFoundryLinkStatus() { // El món de Foundry es descriu amb el que la campanya ja en sap, per si el món
if (!requestId.value || checkingStatus) return; // es va enllaçar abans que els serveis tinguessin un registre comú.
checkingStatus = true; function ServiceTarget(service, link) {
try { if (link?.targetName) return link.targetName;
const response = await Server().get(`/campaign/foundry-link/status/${requestId.value}`); if (service === 'foundry' && campaign.foundryWorldTitle) return campaign.foundryWorldTitle;
if (response.data.status !== 'ok' || response.data.state === 'expired') { if (service === 'discord' && campaign.discordGuildId) return campaign.discordGuildId;
clearInterval(statusPoll); return '';
pairingCode.value = '';
requestId.value = '';
const error = response.data.state === 'expired'
? 'campaigns.settings.errors.link-expired'
: response.data.msg || 'campaigns.settings.errors.link-expired';
DisplayToast('red', $t(error), 3000);
return;
}
if (response.data.state === 'complete') {
ApplyCampaignUpdate(response.data.campaign);
clearInterval(statusPoll);
pairingCode.value = '';
requestId.value = '';
DisplayToast('green', $t('campaigns.settings.linked'), 3000);
}
} catch {
// Keep polling while the Foundry module completes the pairing.
} finally {
checkingStatus = false;
}
} }
async function UnlinkFoundry() { function WhoConnected(link) {
linking.value = true; return link?.dragonrollUserName ? $t('campaigns.settings.services.connected-by', { user: link.dragonrollUserName }) : '';
}
async function Unlink(service) {
unlinked.value = service;
try { try {
const response = await Server().post('/campaign/foundry-unlink', { campaignId: campaign._id }); const response = await Server().post('/campaign/service-unlink', {
campaignId: campaign._id,
service
});
if (response.data.status !== 'ok') { if (response.data.status !== 'ok') {
DisplayToast('red', $t(response.data.msg || 'errors.internal'), 3000); DisplayToast('red', $t(response.data.msg || 'errors.internal'), 3000);
return; return;
} }
ApplyCampaignUpdate(response.data.campaign); ApplyCampaignUpdate(response.data.campaign);
DisplayToast('green', $t('campaigns.settings.unlinked'), 3000); services.value = Array.isArray(response.data.services) ? response.data.services : [];
DisplayToast('green', $t('campaigns.settings.services.unlinked', {
service: $t(`campaigns.settings.services.${service}.name`)
}), 3000);
} catch { } catch {
DisplayToast('red', $t('errors.internal'), 3000); DisplayToast('red', $t('errors.internal'), 3000);
} finally { } finally {
linking.value = false; unlinked.value = '';
}
}
async function CopyPairingCode() {
try {
await navigator.clipboard.writeText(pairingCode.value);
DisplayToast('green', $t('campaigns.settings.code-copied'), 2000);
} catch {
DisplayToast('red', $t('campaigns.settings.errors.copy-code'), 3000);
} }
} }
</script> </script>
@@ -212,29 +171,33 @@ async function CopyPairingCode() {
</div> </div>
</template> </template>
<template #integrations> <template #integrations>
<p class="help-text standalone">{{ $t('campaigns.settings.services.help') }}</p>
<div class="settings-fields"> <div class="settings-fields">
<div class="world-link"> <div v-for="service in serviceKeys" :key="service" class="service">
<div v-if="campaign.foundryWorldId" class="linked-world"> <div class="service-head">
<strong>{{ campaign.foundryWorldTitle || campaign.foundryWorldId }}</strong> <strong>{{ $t(`campaigns.settings.services.${service}.name`) }}</strong>
<span v-if="campaign.foundrySystem">{{ campaign.foundrySystem }}</span> <button
<button class="btn-primary sound-click" type="button" :disabled="linking" @click="UnlinkFoundry"> v-if="LinkFor(service)"
{{ $t('campaigns.settings.unlink-foundry') }} class="btn-primary sound-click"
</button> type="button"
</div> :disabled="unlinked !== ''"
<p v-else class="help-text standalone">{{ $t('campaigns.settings.no-foundry-world') }}</p> @click="Unlink(service)"
>
<button class="btn-primary sound-click" type="button" :disabled="linking" @click="StartFoundryLink"> {{ $t('campaigns.settings.services.unlink') }}
{{ $t('campaigns.settings.start-foundry-link') }}
</button>
<p class="help-text standalone">{{ $t('campaigns.settings.start-foundry-link-help') }}</p>
<div v-if="pairingCode" class="pairing-code">
<code>{{ pairingCode }}</code>
<button class="btn-primary sound-click" type="button" @click="CopyPairingCode">
{{ $t('campaigns.settings.copy-code') }}
</button> </button>
</div> </div>
<p class="service-state" :class="{ linked: LinkFor(service) }">
{{ ServiceTarget(service, LinkFor(service)) || $t('campaigns.settings.services.not-connected') }}
<span v-if="WhoConnected(LinkFor(service))" class="who">
{{ WhoConnected(LinkFor(service)) }}
</span>
</p>
<p class="help-text standalone">
{{ $t(`campaigns.settings.services.${service}.how`) }}
</p>
</div> </div>
</div>
<div class="settings-fields">
<label class="field"> <label class="field">
<span>{{ $t('campaigns.settings.foundry-url') }}</span> <span>{{ $t('campaigns.settings.foundry-url') }}</span>
<input <input
@@ -313,40 +276,36 @@ input {
margin: 0; margin: 0;
} }
.world-link { .service {
display: flex; display: flex;
flex-direction: column; flex-direction: column;
gap: 10px; gap: 6px;
padding-bottom: 14px; padding-bottom: 14px;
border-bottom: 1px solid var(--color-border); border-bottom: 1px solid var(--color-border);
} }
.linked-world { .service-head {
display: flex;
align-items: center;
gap: 10px;
flex-wrap: wrap;
}
.linked-world span {
opacity: 0.75;
}
.pairing-code {
display: flex; display: flex;
align-items: center; align-items: center;
justify-content: space-between; justify-content: space-between;
gap: 10px; gap: 10px;
padding: 10px;
border: 1px solid var(--color-border);
border-radius: 6px;
} }
.pairing-code code { .service-state {
user-select: text; margin: 0;
font-size: 14px;
overflow-wrap: anywhere; overflow-wrap: anywhere;
} }
.service-state.linked {
color: var(--color-green);
}
.who {
opacity: 0.75;
font-size: 13px;
}
.actions { .actions {
display: flex; display: flex;
justify-content: flex-end; justify-content: flex-end;

View File

@@ -129,7 +129,8 @@ async function saveMap() {
</label> </label>
<label class="form-field"> <label class="form-field">
<span>{{ $t('campaigns.map.scale') }}</span> <span>{{ $t('campaigns.map.scale') }}</span>
<input v-model.number="form.scale" type="number" min="0.01" step="0.5"> <!-- step="any": any decimal works, the 0.01 minimum alone keeps it positive -->
<input v-model.number="form.scale" type="number" min="0.01" step="any" inputmode="decimal">
</label> </label>
<label class="form-field"> <label class="form-field">
<span>{{ $t('campaigns.map.offset-x') }}</span> <span>{{ $t('campaigns.map.offset-x') }}</span>
@@ -154,7 +155,16 @@ async function saveMap() {
<style scoped> <style scoped>
.window-wrapper { display: flex; align-items: center; flex-direction: column; } .window-wrapper { display: flex; align-items: center; flex-direction: column; }
.body { width: 100%; padding: 10px 18px 16px; overflow-y: auto; } /* Stretch so the outer margin insets the content instead of overflowing the window. */
.body {
flex: 1;
min-height: 0;
align-self: stretch;
box-sizing: border-box;
margin: 10px;
padding: 8px;
overflow-y: auto;
}
h3 { margin: 0 0 12px; font-family: MrEavesRemake; } h3 { margin: 0 0 12px; font-family: MrEavesRemake; }
form { display: flex; flex-direction: column; gap: 10px; } form { display: flex; flex-direction: column; gap: 10px; }
.form-field { min-width: 0; display: flex; flex-direction: column; gap: 4px; font-size: 13px; } .form-field { min-width: 0; display: flex; flex-direction: column; gap: 4px; font-size: 13px; }

View File

@@ -1,139 +1,14 @@
<script setup> <script setup>
import { computed, onBeforeUnmount, onMounted, ref } from 'vue'; import { onMounted, ref } from 'vue';
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top, CreateWindow } from '@/services/Windows'; import { SetupHandle, SetSize, ResetPosition, Top } from '@/services/Windows';
import WindowHandle from './partials/WindowHandle.vue'; import WindowHandle from './partials/WindowHandle.vue';
import { getBaseUrl } from '~/services/Server'; import MapViewerPane from '../viewer/map/MapViewerPane.vue';
import { emitter } from '~/services/Emitter';
const props = defineProps(['data']); const props = defineProps(['data']);
const id = props.data.id; const id = props.data.id;
const campaignId = props.data.campaign;
const handle = ref(null); const handle = ref(null);
const wrapper = ref(null); const wrapper = ref(null);
const map = props.data.map ? { ...props.data.map } : null;
const map = ref(props.data.map ? { ...props.data.map } : null);
const viewport = ref(null);
const zoom = ref(1);
const pan = ref({ x: 0, y: 0 });
const imageSize = ref({ width: 0, height: 0 });
const showGrid = ref(true);
const dragging = ref(false);
const minZoom = 0.05;
const maxZoom = 8;
const imageUrl = computed(() => {
const image = map.value?.image;
if (!image) return '';
return /^(https?:|data:|\/\/)/i.test(image) ? image : `${getBaseUrl()}/public/${image}`;
});
const stageStyle = computed(() => ({
transform: `translate3d(${pan.value.x}px, ${pan.value.y}px, 0) scale(${zoom.value})`
}));
// The grid is drawn in screen space over the image so its lines stay one pixel wide at any zoom.
const gridStyle = computed(() => {
if (!showGrid.value || !imageSize.value.width) return { display: 'none' };
const cell = `${Math.max(1, Number(map.value?.gridSize) || 50) * zoom.value}px`;
return {
width: `${imageSize.value.width * zoom.value}px`,
height: `${imageSize.value.height * zoom.value}px`,
transform: `translate3d(${pan.value.x + (Number(map.value?.offsetX) || 0) * zoom.value}px, ${pan.value.y + (Number(map.value?.offsetY) || 0) * zoom.value}px, 0)`,
backgroundImage: `linear-gradient(to right, var(--color-link) 1px, transparent 1px), linear-gradient(to bottom, var(--color-link) 1px, transparent 1px)`,
backgroundSize: `${cell} ${cell}`
};
});
const zoomPercent = computed(() => `${Math.round(zoom.value * 100)}%`);
function clampZoom(value) {
if (!Number.isFinite(value)) return minZoom;
return Math.min(maxZoom, Math.max(minZoom, value));
}
function fitToWindow() {
const bounds = viewport.value?.getBoundingClientRect();
if (!bounds || !imageSize.value.width) return;
zoom.value = clampZoom(Math.min(bounds.width / imageSize.value.width, bounds.height / imageSize.value.height));
centerOn();
}
function centerOn() {
const bounds = viewport.value?.getBoundingClientRect();
if (!bounds || !imageSize.value.width) return;
pan.value = {
x: (bounds.width - imageSize.value.width * zoom.value) / 2,
y: (bounds.height - imageSize.value.height * zoom.value) / 2
};
}
function onImageLoaded(event) {
imageSize.value = { width: event.target.naturalWidth, height: event.target.naturalHeight };
fitToWindow();
}
// Zoom keeping the map point under `point` where it is.
function zoomAt(factor, point) {
const next = clampZoom(zoom.value * factor);
if (next === zoom.value) return;
const ratio = next / zoom.value;
pan.value = {
x: point.x - (point.x - pan.value.x) * ratio,
y: point.y - (point.y - pan.value.y) * ratio
};
zoom.value = next;
}
function onWheel(event) {
const bounds = viewport.value?.getBoundingClientRect();
if (!bounds) return;
zoomAt(event.deltaY < 0 ? 1.15 : 1 / 1.15, { x: event.clientX - bounds.left, y: event.clientY - bounds.top });
}
function zoomFromToolbar(incoming) {
const bounds = viewport.value?.getBoundingClientRect();
if (!bounds) return;
zoomAt(incoming ? 1.25 : 1 / 1.25, { x: bounds.width / 2, y: bounds.height / 2 });
}
let pointerId = null;
let lastPointer = { x: 0, y: 0 };
function onPointerDown(event) {
if (event.button !== 0 || !viewport.value) return;
dragging.value = true;
pointerId = event.pointerId;
lastPointer = { x: event.clientX, y: event.clientY };
viewport.value.setPointerCapture?.(event.pointerId);
}
function onPointerMove(event) {
if (!dragging.value || event.pointerId !== pointerId) return;
pan.value = { x: pan.value.x + (event.clientX - lastPointer.x), y: pan.value.y + (event.clientY - lastPointer.y) };
lastPointer = { x: event.clientX, y: event.clientY };
}
function onPointerUp(event) {
if (event.pointerId !== pointerId) return;
dragging.value = false;
pointerId = null;
viewport.value?.releasePointerCapture?.(event.pointerId);
}
function editMap() {
if (!map.value) return;
CreateWindow('create_map', { campaign: campaignId, entry: map.value });
}
function handleMapUpdated({ entityType, entry }) {
if (entityType !== 'map' || entry?._id !== map.value?._id) return;
const imageChanged = entry.image !== map.value.image;
map.value = { ...entry };
// A new image is fitted again by onImageLoaded; grid-only changes just move the overlay.
if (imageChanged) imageSize.value = { width: 0, height: 0 };
}
onMounted(() => { onMounted(() => {
Top(wrapper); Top(wrapper);
@@ -143,82 +18,16 @@ onMounted(() => {
height: Math.max(360, Math.min(760, window.innerHeight - 32)) height: Math.max(360, Math.min(760, window.innerHeight - 32))
}); });
ResetPosition(id, 'center'); ResetPosition(id, 'center');
emitter.on('campaign-entry-updated', handleMapUpdated);
});
onBeforeUnmount(() => {
emitter.off('campaign-entry-updated', handleMapUpdated);
}); });
</script> </script>
<template> <template>
<div class="window-wrapper viewer-window" :id="'window-wrapper-' + id" ref="wrapper"> <div class="window-wrapper viewer-window" :id="'window-wrapper-' + id" ref="wrapper">
<WindowHandle :window="id" ref="handle" /> <WindowHandle :window="id" ref="handle" />
<div class="viewer-bar"> <MapViewerPane :map="map" />
<div class="viewer-identity">
<strong>{{ map?.name }}</strong>
<span class="viewer-meta">{{ $t('campaigns.map.summary', { size: map?.gridSize, scale: map?.scale }) }}</span>
</div>
<div class="viewer-tools">
<button class="viewer-tool" :class="{ selected: showGrid }" type="button" :title="$t('campaigns.map.toggle-grid')"
:aria-label="$t('campaigns.map.toggle-grid')" :aria-pressed="showGrid.toString()" @click="showGrid = !showGrid">
<img class="tool-icon" src="/icons/iconoir/regular/view-grid.svg" alt="" aria-hidden="true">
</button>
<button class="viewer-tool" type="button" :title="$t('campaigns.map.zoom-out')" :aria-label="$t('campaigns.map.zoom-out')" @click="zoomFromToolbar(false)">
<img class="tool-icon" src="/icons/iconoir/regular/minus.svg" alt="" aria-hidden="true">
</button>
<span class="zoom-readout">{{ zoomPercent }}</span>
<button class="viewer-tool" type="button" :title="$t('campaigns.map.zoom-in')" :aria-label="$t('campaigns.map.zoom-in')" @click="zoomFromToolbar(true)">
<img class="tool-icon" src="/icons/iconoir/regular/plus.svg" alt="" aria-hidden="true">
</button>
<button class="viewer-tool" type="button" :title="$t('campaigns.map.fit')" :aria-label="$t('campaigns.map.fit')" @click="fitToWindow">
<img class="tool-icon" src="/icons/iconoir/regular/expand.svg" alt="" aria-hidden="true">
</button>
<button class="viewer-tool" type="button" :title="$t('campaigns.map.edit')" :aria-label="$t('campaigns.map.edit')" @click="editMap">
<img class="tool-icon" src="/icons/iconoir/regular/edit.svg" alt="" aria-hidden="true">
</button>
</div>
</div>
<div
ref="viewport"
class="map-viewport"
:class="{ dragging }"
@wheel.prevent="onWheel"
@pointerdown="onPointerDown"
@pointermove="onPointerMove"
@pointerup="onPointerUp"
@pointercancel="onPointerUp"
>
<template v-if="imageUrl">
<img class="map-image" :src="imageUrl" :style="stageStyle" :alt="map?.name" draggable="false" @load="onImageLoaded">
<div class="map-grid" :style="gridStyle" aria-hidden="true"></div>
</template>
<div v-else class="map-empty">
{{ $t('campaigns.map.no-image') }}
<button class="map-edit" type="button" @click="editMap">{{ $t('campaigns.map.upload-photo') }}</button>
</div>
</div>
</div> </div>
</template> </template>
<style scoped> <style scoped>
.viewer-window { min-width: 320px; min-height: 0; } .viewer-window { min-width: 320px; min-height: 0; }
.viewer-bar { width: 100%; box-sizing: border-box; display: flex; align-items: center; justify-content: space-between; gap: 10px; padding: 8px 10px; border-bottom: 1px solid var(--color-border); background: var(--color-background-light); }
.viewer-identity { min-width: 0; display: flex; flex-direction: column; gap: 2px; }
.viewer-identity strong { font-family: MrEavesRemake; overflow-wrap: anywhere; }
.viewer-meta { font-size: 11px; opacity: .72; }
.viewer-tools { display: flex; align-items: center; gap: 4px; }
.viewer-tool { width: 30px; height: 30px; margin: 0; padding: 0; border: 1px solid var(--color-border); border-radius: 7px; background: var(--color-background-soft); display: flex; align-items: center; justify-content: center; cursor: pointer; }
.viewer-tool:hover { background: var(--color-button-hover); }
.viewer-tool.selected { border-color: var(--color-link); background: var(--color-button-hover); }
.tool-icon { width: 16px; height: 16px; filter: invert(var(--color-icon-invert)); }
.zoom-readout { min-width: 46px; text-align: center; font-size: 12px; }
.map-viewport { position: relative; width: 100%; flex: 1; min-height: 0; overflow: hidden; background-color: var(--color-background); cursor: grab; touch-action: none; }
.map-viewport.dragging { cursor: grabbing; }
.map-image { position: absolute; top: 0; left: 0; max-width: none; transform-origin: top left; user-select: none; }
.map-grid { position: absolute; top: 0; left: 0; opacity: .55; pointer-events: none; }
.map-empty { width: 100%; height: 100%; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 8px; font-size: 13px; opacity: .8; }
.map-edit { border: 1px solid var(--color-border); border-radius: 7px; padding: 6px 11px; background: var(--color-background-soft); color: var(--color-text); font-size: 12px; cursor: pointer; }
.map-edit:hover { background: var(--color-button-hover); }
</style> </style>

View File

@@ -0,0 +1,122 @@
<script setup>
import { createApp, onBeforeUnmount, onMounted, ref } from 'vue';
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top } from '@/services/Windows';
import WindowHandle from './partials/WindowHandle.vue';
import { GetWidget, ParseMarkdown } from '~/services/Marker';
import Server from '~/services/Server';
// The note a map pin points at (see MapViewerPane.vue). The note is fetched here instead of being
// carried over from the map, so a pin works whatever the note column shows and always reads fresh.
const props = defineProps(['data']);
const id = props.data.id;
const noteId = props.data.note;
const handle = ref(null);
const wrapper = ref(null);
const renderedContent = ref(null);
const note = ref(null);
const displayText = ref('');
const loading = ref(true);
const failed = ref(false);
// Widgets mounted over this note, kept to unmount them again the way Note.vue does: re-rendering
// would otherwise leave the apps of the nodes it replaced behind.
const mountedApps = [];
function unmountWidgets() {
for (const app of mountedApps) {
try {
app.unmount();
} catch (error) {
// The container may already be off the DOM; ignore and drop it all the same.
}
}
mountedApps.length = 0;
}
function mountWidgets() {
const root = renderedContent.value;
if (!root) return;
['display', 'inline'].forEach((widgetType) => {
root.querySelectorAll('.vue-component-' + widgetType).forEach((el) => {
const widget = GetWidget(widgetType, el.dataset.component);
if (!widget) return;
try {
const app = createApp(widget, { content: el.dataset.content });
app.config.errorHandler = (error) => console.error('Widget error', el.dataset.component, error);
app.mount(el);
mountedApps.push(app);
} catch (error) {
console.error('Failed to mount widget', el.dataset.component, error);
}
});
});
}
async function fetchNote() {
loading.value = true;
failed.value = false;
try {
const response = await Server().get(`/note/retrieve/${noteId}`);
if (response.data.status !== 'ok' || !response.data.note) {
failed.value = true;
return;
}
note.value = response.data.note;
unmountWidgets();
displayText.value = ParseMarkdown(response.data.note.content ?? '');
setTimeout(() => mountWidgets(), 0);
} catch (error) {
failed.value = true;
} finally {
loading.value = false;
}
}
onMounted(() => {
Top(wrapper);
SetupHandle(id, handle);
SetSize(id, {
width: Math.max(360, Math.min(720, window.innerWidth - 24)),
height: Math.max(360, Math.min(720, window.innerHeight - 32))
});
ResetPosition(id, 'center');
fetchNote();
});
onBeforeUnmount(() => {
unmountWidgets();
ClearWindow({ type: 'pinned_note' });
});
</script>
<template>
<div class="window-wrapper pinned-note-window" :id="'window-wrapper-' + id" ref="wrapper">
<WindowHandle :window="id" ref="handle" />
<div class="body">
<div v-if="loading" class="note-state">{{ $t('campaigns.states.loading') }}</div>
<div v-else-if="failed" class="note-state">{{ $t('campaigns.map.pins.note-error') }}</div>
<template v-else>
<h1 v-if="note.title" class="note-title">{{ note.title }}</h1>
<div ref="renderedContent" class="note-content" v-html="displayText"></div>
</template>
</div>
</div>
</template>
<style scoped>
.window-wrapper { display: flex; align-items: center; flex-direction: column; }
/* Stretch so the outer margin insets the content instead of overflowing the window. */
.body {
flex: 1;
min-height: 0;
align-self: stretch;
box-sizing: border-box;
margin: 10px;
padding: 8px;
overflow-y: auto;
}
.note-title { margin: 0 0 10px; font-family: MrEavesRemake; overflow-wrap: anywhere; }
.note-state { padding: 10px; font-size: 13px; opacity: .8; }
.note-content :deep(img) { max-width: 100%; height: auto; display: block; }
</style>

View File

@@ -2,11 +2,38 @@ import { ref } from 'vue';
const ShowContent = ref(false); const ShowContent = ref(false);
// What the campaign workspace shows where the notes live: the open notes, or the map the
// sidebar anchored on the note container. 'notes' | 'map'
const ActivePane = ref('notes');
// The map anchored on the note container (a campaign entry of the sidebar's maps section).
const AnchoredMap = ref(null);
function SetShowContent(value) { function SetShowContent(value) {
ShowContent.value = value; ShowContent.value = value;
} }
function SetActivePane(value) {
ActivePane.value = value;
}
// Anchoring shows the map where the open notes are; they stay open and come back on 'notes'.
function AnchorMap(map) {
AnchoredMap.value = map ?? null;
ActivePane.value = AnchoredMap.value ? 'map' : 'notes';
}
function ClearAnchoredMap() {
AnchoredMap.value = null;
if (ActivePane.value === 'map') ActivePane.value = 'notes';
}
export { export {
ShowContent, ShowContent,
SetShowContent SetShowContent,
} ActivePane,
AnchoredMap,
SetActivePane,
AnchorMap,
ClearAnchoredMap
}

View File

@@ -0,0 +1,77 @@
// The rules behind the note pins of a map (right click a map, pin one of the campaign notes at that
// spot, click the pin to read it). Pins are stored in image pixels, so these helpers only translate
// between the image and what the map viewer shows; they hold no state and talk to no API.
const PATH_SEPARATOR = ' / ';
// Screen pixels (relative to the top left corner of the map viewport) → image pixels, or null when
// the point is not over the image: nothing gets pinned outside of it.
function ToImagePoint(point, view) {
const zoom = Number(view?.zoom);
const width = Number(view?.width);
const height = Number(view?.height);
if (!zoom || !width || !height) return null;
const x = (Number(point?.x) - Number(view?.pan?.x ?? 0)) / zoom;
const y = (Number(point?.y) - Number(view?.pan?.y ?? 0)) / zoom;
if (!Number.isFinite(x) || !Number.isFinite(y)) return null;
if (x < 0 || y < 0 || x > width || y > height) return null;
return { x: Math.round(x), y: Math.round(y) };
}
// A pin (image pixels) → screen pixels of the map viewport. Pins are drawn in screen space instead
// of inside the scaled stage, so their marker keeps the same size whatever the zoom is.
function ToScreenPoint(pin, view) {
const zoom = Number(view?.zoom) || 0;
return {
x: Number(view?.pan?.x ?? 0) + Number(pin?.x ?? 0) * zoom,
y: Number(view?.pan?.y ?? 0) + Number(pin?.y ?? 0) * zoom
};
}
// The path of the folder a note lives in, so two notes sharing a name can still be told apart.
function FolderPath(folderId, folderById) {
const names = [];
const seen = new Set();
let folder = folderId ? folderById.get(String(folderId)) : null;
// Folder trees are acyclic by construction; `seen` only keeps a broken parent chain from
// looping forever.
while (folder && !seen.has(String(folder._id))) {
seen.add(String(folder._id));
if (folder.name) names.unshift(String(folder.name));
folder = folder.parentFolder ? folderById.get(String(folder.parentFolder)) : null;
}
return names.join(PATH_SEPARATOR);
}
// 'Folder / Subfolder / Note title' out of the picker option's folder path and title.
function OptionLabel(option) {
const path = option?.path ? `${option.path}${PATH_SEPARATOR}` : '';
return `${path}${option?.title ?? ''}`;
}
// The note picker of a campaign: `{ value, title, path, label }` per note, sorted by label. Notes
// without a title are left out, they would show as an empty menu entry.
function BuildNoteOptions(notes, folders) {
const folderById = new Map((folders ?? []).map((folder) => [String(folder._id), folder]));
return (notes ?? [])
.filter((note) => note?._id && String(note.title ?? '').trim())
.map((note) => {
const option = {
value: String(note._id),
title: String(note.title).trim(),
path: FolderPath(note.folder, folderById)
};
return { ...option, label: OptionLabel(option) };
})
.sort((a, b) => a.label.localeCompare(b.label));
}
export {
BuildNoteOptions,
OptionLabel,
ToImagePoint,
ToScreenPoint
};

View File

@@ -82,6 +82,12 @@ const defWindows = {
component: () => import('~/components/windows/MapViewerWindow.vue'), component: () => import('~/components/windows/MapViewerWindow.vue'),
close: () => ClearWindow({type: 'map_viewer'}), close: () => ClearWindow({type: 'map_viewer'}),
movable: true movable: true
},
pinned_note: {
title: 'windows.pinned-note',
component: () => import('~/components/windows/PinnedNoteWindow.vue'),
close: () => ClearWindow({type: 'pinned_note'}),
movable: true
} }
} }

View File

@@ -10,20 +10,30 @@
"color": "Color de la campanya", "color": "Color de la campanya",
"foundry-url": "URL de Foundry VTT", "foundry-url": "URL de Foundry VTT",
"foundry-url-help": "Introdueix l'URL base de la instància de Foundry VTT que executa el mòdul Dragonroll Foundry.", "foundry-url-help": "Introdueix l'URL base de la instància de Foundry VTT que executa el mòdul Dragonroll Foundry.",
"no-foundry-world": "Aquesta campanya no té cap món de Foundry enllaçat.",
"start-foundry-link": "Crea un codi per a Foundry",
"start-foundry-link-help": "Copia aquest codi a l'opció Dragonroll Campaign Pairing Code del mòdul de Foundry. Dragonroll Endpoint utilitza https://dragonroll.aranroig.com de manera predeterminada. El codi caduca al cap de 10 minuts.",
"unlink-foundry": "Desenllaça",
"saved": "S'ha desat la configuració de la campanya.", "saved": "S'ha desat la configuració de la campanya.",
"linked": "S'ha enllaçat el món de Foundry amb aquesta campanya.",
"unlinked": "S'ha desenllaçat el món de Foundry d'aquesta campanya.",
"code-copied": "S'ha copiat el codi d'enllaç.",
"saving": "Desant...", "saving": "Desant...",
"services": {
"help": "Tots els serveis es connecten igual: demanen a Dragonroll un enllaç de registre, te'l mostren i tries aquesta campanya allà. Des d'aquí no es connecta res.",
"not-connected": "No connectat",
"unlink": "Desenllaça",
"unlinked": "{service} ja no està connectat amb aquesta campanya.",
"connected-by": "connectat per {user}",
"foundry": {
"name": "Foundry VTT",
"how": "Obre l'enllaç de Dragonroll des de la configuració del mòdul del teu món i tria aquesta campanya."
},
"discord": {
"name": "Discord",
"how": "Executa /dragonroll connect al teu servidor i tria aquesta campanya."
},
"obsidian": {
"name": "Obsidian",
"how": "Prem Connect to Dragonroll a la configuració del connector d'Obsidian i tria aquesta campanya."
}
},
"errors": { "errors": {
"name-required": "Introdueix un nom per a la campanya.", "name-required": "Introdueix un nom per a la campanya.",
"invalid-foundry-url": "Introdueix una URL vàlida de Foundry VTT amb http o https.", "invalid-foundry-url": "Introdueix una URL vàlida de Foundry VTT amb http o https."
"link-expired": "El codi d'enllaç ha caducat. Crea'n un de nou.",
"copy-code": "No s'ha pogut copiar el codi d'enllaç."
} }
}, },
"sidebar-label": "Campanya", "sidebar-label": "Campanya",
@@ -67,7 +77,14 @@
"summary": "Quadrícula de {size} px · {scale} per cel·la", "summary": "Quadrícula de {size} px · {scale} per cel·la",
"save-error": "No s'ha pogut desar aquest mapa.", "save-error": "No s'ha pogut desar aquest mapa.",
"no-image": "Aquest mapa encara no té imatge.", "no-image": "Aquest mapa encara no té imatge.",
"zoom-in": "Apropar", "zoom-out": "Allunyar", "fit": "Ajustar a la finestra", "toggle-grid": "Mostrar la quadrícula" "zoom-in": "Apropar", "zoom-out": "Allunyar", "fit": "Ajustar a la finestra", "toggle-grid": "Mostrar la quadrícula",
"open-window": "Obre en una finestra", "anchored": "Ancorat",
"pins": {
"add": "Fixa una nota aquí", "none": "Encara no hi ha notes per fixar",
"open": "Obre la nota", "remove": "Treu el marcador",
"error": "No s'han pogut canviar els marcadors d'aquest mapa.",
"note-error": "No s'ha pogut llegir aquesta nota. Potser s'ha suprimit."
}
}, },
"character-sheet": { "character-sheet": {
"title": "Fitxa de personatge", "name": "Nom del personatge", "class": "Classe", "subclass": "Subclasse", "unset-class": "Classe sense definir", "title": "Fitxa de personatge", "name": "Nom del personatge", "class": "Classe", "subclass": "Subclasse", "unset-class": "Classe sense definir",

View File

@@ -0,0 +1,35 @@
{
"title": "Connecta {service} amb Dragonroll",
"checking": "Comprovant aquest enllaç…",
"system": " · {system}",
"target": {
"discord": "Servidor de Discord: {target}. Sol·licitat per {user}.",
"foundry": "Món de Foundry: {target}{system}. Sol·licitat per {user}.",
"obsidian": "Vault d'Obsidian: {target}.",
"other": "{target} vol fer servir una de les teves campanyes."
},
"sign-in-lead": "Inicia sessió amb el compte de Dragonroll propietari de la campanya que ha de fer servir {service}.",
"signed-in-as": "Has iniciat sessió com a {user}.",
"pick-campaign": "Quina campanya pot fer servir {service}?",
"no-campaigns": "Aquest compte encara no té campanyes. Crea'n una primer a Dragonroll.",
"already-linked": "ja connectat a un {service}",
"connect": "Connecta aquesta campanya",
"connected": "Aquesta campanya ja està connectada amb {target}.",
"trust-warning": "Connecta només serveis de confiança: poden llegir i modificar el que conté la seva campanya.",
"replace-warning": "Connectar una campanya reemplaça el que aquest servei tenia connectat abans.",
"next": {
"discord": "Torna a Discord: el bot hi confirmarà la connexió.",
"foundry": "Torna a Foundry: el mòdul es connectarà sol.",
"obsidian": "Torna a Obsidian: el connector ho agafarà sol.",
"other": "Torna al servei d'on vens."
},
"errors": {
"missing-code": "A aquest enllaç li falta el codi. Demana'n un de nou al servei.",
"expired": "Aquest enllaç no és vàlid o ha caducat. Demana'n un de nou al servei.",
"sign-in-failed": "No s'ha pogut iniciar sessió a Dragonroll. Revisa l'usuari i la contrasenya.",
"session-expired": "La teva sessió de Dragonroll ha caducat. Inicia sessió de nou per continuar.",
"no-campaign": "Tria la campanya que ha de fer servir aquest servei.",
"notfound": "Aquesta campanya no és teva. Inicia sessió amb el compte propietari.",
"internal": "No s'ha pogut carregar aquest enllaç."
}
}

View File

@@ -7,5 +7,6 @@
"settings": "Configuració", "settings": "Configuració",
"create-campaign": "Crear campanya", "create-campaign": "Crear campanya",
"create-map": "Crear mapa", "create-map": "Crear mapa",
"map-viewer": "Mapa" "map-viewer": "Mapa",
"pinned-note": "Nota fixada"
} }

View File

@@ -14,20 +14,30 @@
"color": "Campaign color", "color": "Campaign color",
"foundry-url": "Foundry VTT URL", "foundry-url": "Foundry VTT URL",
"foundry-url-help": "Enter the base URL of the Foundry VTT instance running the Dragonroll Foundry module.", "foundry-url-help": "Enter the base URL of the Foundry VTT instance running the Dragonroll Foundry module.",
"no-foundry-world": "No Foundry world is linked to this campaign.",
"start-foundry-link": "Create a code for Foundry",
"start-foundry-link-help": "Copy this code into the Dragonroll Campaign Pairing Code setting in the Foundry module. The Dragonroll Endpoint defaults to https://dragonroll.aranroig.com. The code expires after 10 minutes.",
"unlink-foundry": "Unlink",
"saved": "Campaign settings saved.", "saved": "Campaign settings saved.",
"linked": "Foundry world linked to this campaign.",
"unlinked": "Foundry world unlinked from this campaign.",
"code-copied": "Pairing code copied.",
"saving": "Saving...", "saving": "Saving...",
"services": {
"help": "Every service connects the same way: it asks Dragonroll for a sign-up link, shows it to you, and you pick this campaign there. Nothing connects from here.",
"not-connected": "Not connected",
"unlink": "Unlink",
"unlinked": "{service} is no longer connected to this campaign.",
"connected-by": "connected by {user}",
"foundry": {
"name": "Foundry VTT",
"how": "Open the Dragonroll link from the module settings of your world and pick this campaign."
},
"discord": {
"name": "Discord",
"how": "Run /dragonroll connect in your server and pick this campaign."
},
"obsidian": {
"name": "Obsidian",
"how": "Press Connect to Dragonroll in the Obsidian plugin settings and pick this campaign."
}
},
"errors": { "errors": {
"name-required": "Enter a campaign name.", "name-required": "Enter a campaign name.",
"invalid-foundry-url": "Enter a valid Foundry VTT URL using http or https.", "invalid-foundry-url": "Enter a valid Foundry VTT URL using http or https."
"link-expired": "This pairing code expired. Create a new one.",
"copy-code": "Unable to copy the pairing code."
} }
}, },
"sidebar-label": "Campaign", "sidebar-label": "Campaign",
@@ -71,7 +81,14 @@
"summary": "{size} px grid · {scale} per cell", "summary": "{size} px grid · {scale} per cell",
"save-error": "Unable to save this map.", "save-error": "Unable to save this map.",
"no-image": "This map has no image yet.", "no-image": "This map has no image yet.",
"zoom-in": "Zoom in", "zoom-out": "Zoom out", "fit": "Fit to window", "toggle-grid": "Show grid" "zoom-in": "Zoom in", "zoom-out": "Zoom out", "fit": "Fit to window", "toggle-grid": "Show grid",
"open-window": "Open in window", "anchored": "Anchored",
"pins": {
"add": "Pin a note here", "none": "No notes to pin yet",
"open": "Open note", "remove": "Remove pin",
"error": "Unable to change the pins of this map.",
"note-error": "This note could not be read. It may have been deleted."
}
}, },
"character-sheet": { "character-sheet": {
"title": "Character Sheet", "name": "Character name", "class": "Class", "subclass": "Subclass", "unset-class": "Class not set", "title": "Character Sheet", "name": "Character name", "class": "Class", "subclass": "Subclass", "unset-class": "Class not set",

View File

@@ -0,0 +1,35 @@
{
"title": "Connect {service} to Dragonroll",
"checking": "Checking this link…",
"system": " · {system}",
"target": {
"discord": "Discord server: {target}. Requested by {user}.",
"foundry": "Foundry world: {target}{system}. Requested by {user}.",
"obsidian": "Obsidian vault: {target}.",
"other": "{target} wants to use one of your campaigns."
},
"sign-in-lead": "Sign in with the Dragonroll account that owns the campaign {service} should use.",
"signed-in-as": "Signed in as {user}.",
"pick-campaign": "Which campaign may {service} use?",
"no-campaigns": "This account has no campaigns yet. Create one in Dragonroll first.",
"already-linked": "already connected to a {service}",
"connect": "Connect this campaign",
"connected": "This campaign is now connected to {target}.",
"trust-warning": "Only connect a service you trust: it can read and change what its campaign holds.",
"replace-warning": "Connecting a campaign replaces whatever this service was connected to before.",
"next": {
"discord": "Return to Discord: the bot confirms the connection there.",
"foundry": "Return to Foundry: the module connects on its own.",
"obsidian": "Return to Obsidian: the plugin picks this up on its own.",
"other": "Return to the service you came from."
},
"errors": {
"missing-code": "This link is missing its code. Ask the service for a new one.",
"expired": "This link is invalid or has expired. Ask the service for a new one.",
"sign-in-failed": "Dragonroll sign in failed. Check your username and password.",
"session-expired": "Your Dragonroll session has expired. Sign in again to continue.",
"no-campaign": "Choose the campaign this service should use.",
"notfound": "That campaign is not one of yours. Sign in with the account that owns it.",
"internal": "Could not load this link."
}
}

View File

@@ -7,5 +7,6 @@
"settings": "Settings", "settings": "Settings",
"create-campaign": "Create Campaign", "create-campaign": "Create Campaign",
"create-map": "Create Map", "create-map": "Create Map",
"map-viewer": "Map" "map-viewer": "Map",
"pinned-note": "Pinned note"
} }

View File

@@ -10,20 +10,30 @@
"color": "Color de la campaña", "color": "Color de la campaña",
"foundry-url": "URL de Foundry VTT", "foundry-url": "URL de Foundry VTT",
"foundry-url-help": "Introduce la URL base de la instancia de Foundry VTT que ejecuta el módulo Dragonroll Foundry.", "foundry-url-help": "Introduce la URL base de la instancia de Foundry VTT que ejecuta el módulo Dragonroll Foundry.",
"no-foundry-world": "Esta campaña no tiene ningún mundo de Foundry vinculado.",
"start-foundry-link": "Crear un código para Foundry",
"start-foundry-link-help": "Copia este código en el ajuste Dragonroll Campaign Pairing Code del módulo de Foundry. Dragonroll Endpoint usa https://dragonroll.aranroig.com de forma predeterminada. El código caduca en 10 minutos.",
"unlink-foundry": "Desvincular",
"saved": "Se han guardado los ajustes de la campaña.", "saved": "Se han guardado los ajustes de la campaña.",
"linked": "El mundo de Foundry se ha vinculado a esta campaña.",
"unlinked": "Se ha desvinculado el mundo de Foundry de esta campaña.",
"code-copied": "Código de vinculación copiado.",
"saving": "Guardando...", "saving": "Guardando...",
"services": {
"help": "Todos los servicios se conectan igual: piden a Dragonroll un enlace de registro, te lo muestran y eliges esta campaña allí. Desde aquí no se conecta nada.",
"not-connected": "Sin conectar",
"unlink": "Desvincular",
"unlinked": "{service} ya no está conectado a esta campaña.",
"connected-by": "conectado por {user}",
"foundry": {
"name": "Foundry VTT",
"how": "Abre el enlace de Dragonroll desde los ajustes del módulo de tu mundo y elige esta campaña."
},
"discord": {
"name": "Discord",
"how": "Ejecuta /dragonroll connect en tu servidor y elige esta campaña."
},
"obsidian": {
"name": "Obsidian",
"how": "Pulsa Connect to Dragonroll en los ajustes del plugin de Obsidian y elige esta campaña."
}
},
"errors": { "errors": {
"name-required": "Introduce un nombre para la campaña.", "name-required": "Introduce un nombre para la campaña.",
"invalid-foundry-url": "Introduce una URL válida de Foundry VTT con http o https.", "invalid-foundry-url": "Introduce una URL válida de Foundry VTT con http o https."
"link-expired": "El código de vinculación ha caducado. Crea uno nuevo.",
"copy-code": "No se pudo copiar el código de vinculación."
} }
}, },
"sidebar-label": "Campaña", "sidebar-label": "Campaña",
@@ -67,7 +77,14 @@
"summary": "Cuadrícula de {size} px · {scale} por celda", "summary": "Cuadrícula de {size} px · {scale} por celda",
"save-error": "No se pudo guardar este mapa.", "save-error": "No se pudo guardar este mapa.",
"no-image": "Este mapa aún no tiene imagen.", "no-image": "Este mapa aún no tiene imagen.",
"zoom-in": "Acercar", "zoom-out": "Alejar", "fit": "Ajustar a la ventana", "toggle-grid": "Mostrar cuadrícula" "zoom-in": "Acercar", "zoom-out": "Alejar", "fit": "Ajustar a la ventana", "toggle-grid": "Mostrar cuadrícula",
"open-window": "Abrir en una ventana", "anchored": "Anclado",
"pins": {
"add": "Fija una nota aquí", "none": "Aún no hay notas que fijar",
"open": "Abrir nota", "remove": "Quitar el marcador",
"error": "No se pudieron cambiar los marcadores de este mapa.",
"note-error": "No se pudo leer esta nota. Puede que se haya eliminado."
}
}, },
"character-sheet": { "character-sheet": {
"title": "Hoja de personaje", "name": "Nombre del personaje", "class": "Clase", "subclass": "Subclase", "unset-class": "Clase sin definir", "title": "Hoja de personaje", "name": "Nombre del personaje", "class": "Clase", "subclass": "Subclase", "unset-class": "Clase sin definir",

View File

@@ -0,0 +1,35 @@
{
"title": "Conectar {service} con Dragonroll",
"checking": "Comprobando este enlace…",
"system": " · {system}",
"target": {
"discord": "Servidor de Discord: {target}. Solicitado por {user}.",
"foundry": "Mundo de Foundry: {target}{system}. Solicitado por {user}.",
"obsidian": "Vault de Obsidian: {target}.",
"other": "{target} quiere usar una de tus campañas."
},
"sign-in-lead": "Inicia sesión con la cuenta de Dragonroll propietaria de la campaña que debe usar {service}.",
"signed-in-as": "Has iniciado sesión como {user}.",
"pick-campaign": "¿Qué campaña puede usar {service}?",
"no-campaigns": "Esta cuenta todavía no tiene campañas. Crea una primero en Dragonroll.",
"already-linked": "ya conectado a un {service}",
"connect": "Conectar esta campaña",
"connected": "Esta campaña ya está conectada a {target}.",
"trust-warning": "Conecta solo servicios de confianza: pueden leer y modificar lo que contenga su campaña.",
"replace-warning": "Conectar una campaña reemplaza lo que este servicio tuviera conectado antes.",
"next": {
"discord": "Vuelve a Discord: el bot confirmará la conexión allí.",
"foundry": "Vuelve a Foundry: el módulo se conectará solo.",
"obsidian": "Vuelve a Obsidian: el plugin lo detectará solo.",
"other": "Vuelve al servicio desde el que has venido."
},
"errors": {
"missing-code": "A este enlace le falta el código. Pide uno nuevo al servicio.",
"expired": "Este enlace no es válido o ha caducado. Pide uno nuevo al servicio.",
"sign-in-failed": "No se ha podido iniciar sesión en Dragonroll. Revisa el usuario y la contraseña.",
"session-expired": "Tu sesión de Dragonroll ha caducado. Inicia sesión de nuevo para continuar.",
"no-campaign": "Elige la campaña que debe usar este servicio.",
"notfound": "Esa campaña no es tuya. Inicia sesión con la cuenta propietaria.",
"internal": "No se ha podido cargar este enlace."
}
}

View File

@@ -7,5 +7,6 @@
"settings": "Configuración", "settings": "Configuración",
"create-campaign": "Crear campanya", "create-campaign": "Crear campanya",
"create-map": "Crear mapa", "create-map": "Crear mapa",
"map-viewer": "Mapa" "map-viewer": "Mapa",
"pinned-note": "Nota fijada"
} }

43
obsidian-plugin/README.md Normal file
View File

@@ -0,0 +1,43 @@
# Dragonroll Sync for Obsidian
An Obsidian community plugin that imports notes from a Dragonroll campaign and pushes the active
Markdown note back to Dragonroll.
## Install from this repository
Copy `main.js` and `manifest.json` into:
```text
<vault>/.obsidian/plugins/dragonroll-sync/
```
Then enable **Dragonroll Sync** in Obsidian's Community Plugins settings. The plugin is plain
JavaScript and does not need a build step.
## Connect your account
Open **Settings → Community plugins → Dragonroll Sync**, enter the Dragonroll API URL and sign in
with your Dragonroll username/email and password. The default API URL is
`https://dragonroll.aranroig.com/api`; a local server can use `http://localhost:5000/api`.
Choose a campaign after signing in. The plugin saves the Dragonroll session token in this vault;
Dragonroll sessions expire after 48 hours. The password is not saved.
## Commands
- **Import or refresh campaign notes** fetches all campaign notes, including notes inside nested
Dragonroll folders, into `Dragonroll/<Campaign>/`. Imported notes keep their folder hierarchy.
- **Push active note to Dragonroll** creates the active Markdown note as a root campaign note, or
updates its linked Dragonroll note. A note linked to a different campaign cannot be pushed while
another campaign is selected.
The import command adds `dragonrollId`, `dragonrollCampaign`, and `dragonrollTitle` properties to
each imported note's frontmatter. These properties link the local file to its remote record and are
omitted from the Markdown content sent back to Dragonroll. Pushing a new local note adds those
properties as well.
Import protects local edits. It updates a linked note only when the local copy still matches the
last imported/pushed version. If the local copy changed, or both copies changed since the last sync,
the plugin keeps the local file and reports it for review. Push is explicit and updates Dragonroll
with the active note's current title and content.
This is an explicit import/push workflow; it does not sync in the background or delete notes.

497
obsidian-plugin/main.js Normal file
View File

@@ -0,0 +1,497 @@
const {
Notice,
Plugin,
PluginSettingTab,
Setting,
normalizePath,
requestUrl,
} = require('obsidian');
const DEFAULT_SETTINGS = {
apiBaseUrl: 'https://dragonroll.aranroig.com/api',
token: '',
campaignId: '',
snapshots: {},
};
const NOTE_ID_PROPERTY = 'dragonrollId';
const CAMPAIGN_PROPERTY = 'dragonrollCampaign';
const REMOTE_TITLE_PROPERTY = 'dragonrollTitle';
module.exports = class DragonrollSyncPlugin extends Plugin {
async onload() {
await this.loadSettings();
this.status = this.addStatusBarItem();
this.updateStatus();
this.addRibbonIcon('refresh-cw', 'Import Dragonroll campaign notes', () => this.importCampaignNotes());
this.addCommand({
id: 'import-campaign-notes',
name: 'Import or refresh campaign notes',
callback: () => this.importCampaignNotes(),
});
this.addCommand({
id: 'push-active-note',
name: 'Push active note to Dragonroll',
checkCallback: (checking) => {
const file = this.app.workspace.getActiveFile();
if (!file || file.extension !== 'md') return false;
if (!checking) void this.pushActiveNote();
return true;
},
});
this.addSettingTab(new DragonrollSettingTab(this.app, this));
if (this.settings.token && this.settings.campaignId) {
this.status.setText('Dragonroll: ready');
}
}
async loadSettings() {
this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
if (!this.settings.snapshots || typeof this.settings.snapshots !== 'object') {
this.settings.snapshots = {};
}
}
async saveSettings() {
await this.saveData(this.settings);
this.updateStatus();
}
updateStatus() {
if (!this.status) return;
if (!this.settings.token) this.status.setText('Dragonroll: signed out');
else if (!this.settings.campaignId) this.status.setText('Dragonroll: choose campaign');
else this.status.setText('Dragonroll: ready');
}
apiBaseUrl() {
let url = String(this.settings.apiBaseUrl || '').trim().replace(/\/+$/, '');
if (!url) throw new Error('Enter the Dragonroll API URL in settings.');
if (!/\/api$/i.test(url)) url += '/api';
return url;
}
async request(path, { method = 'GET', body, authenticated = true } = {}) {
const headers = { Accept: 'application/json' };
if (authenticated && this.settings.token) {
headers.Authorization = `Bearer ${this.settings.token}`;
}
if (body !== undefined) headers['Content-Type'] = 'application/json';
let response;
try {
response = await requestUrl({
url: `${this.apiBaseUrl()}${path}`,
method,
headers,
body: body === undefined ? undefined : JSON.stringify(body),
throw: false,
});
} catch (error) {
throw new Error(`Could not reach Dragonroll: ${error.message || error}`);
}
let data;
try {
data = response.json;
} catch {
throw new Error(`Dragonroll returned an unreadable response (HTTP ${response.status}).`);
}
if (response.status < 200 || response.status >= 300 || data?.status !== 'ok') {
const message = data?.msg || `HTTP ${response.status}`;
if (response.status === 401 || message === 'unauthorized') {
throw new Error('Dragonroll rejected this session. Sign in again in plugin settings.');
}
throw new Error(`Dragonroll: ${message}`);
}
return data;
}
async login(usermail, password) {
const data = await this.request('/user/login', {
method: 'POST',
body: { usermail, password },
authenticated: false,
});
this.settings.token = data.token;
this.settings.campaignId = '';
await this.saveSettings();
return this.getCampaigns();
}
async getCampaigns() {
const data = await this.request('/campaign/list');
return data.campaigns || [];
}
async selectedCampaign() {
if (!this.settings.token) throw new Error('Sign in to Dragonroll in plugin settings first.');
if (!this.settings.campaignId) throw new Error('Choose a campaign in plugin settings first.');
const campaigns = await this.getCampaigns();
const campaign = campaigns.find((item) => String(item._id) === String(this.settings.campaignId));
if (!campaign) throw new Error('The selected campaign is unavailable. Choose a campaign in settings.');
return campaign;
}
async fetchCampaignNotes(campaignId) {
const root = await this.request(`/note/list?campaign=${encodeURIComponent(campaignId)}`);
const folders = root.folders || [];
const folderById = new Map(folders.map((folder) => [String(folder._id), folder]));
const pathCache = new Map();
const folderPath = (folderId, visiting = new Set()) => {
const id = String(folderId || '');
if (!id || !folderById.has(id)) return [];
if (pathCache.has(id)) return pathCache.get(id);
if (visiting.has(id)) return [];
const folder = folderById.get(id);
const nextVisiting = new Set(visiting);
nextVisiting.add(id);
const parent = folder.parentFolder ? String(folder.parentFolder) : '';
const path = [...folderPath(parent, nextVisiting), safeSegment(folder.name, 'Folder')];
pathCache.set(id, path);
return path;
};
const nestedResults = await Promise.all(folders.map(async (folder) => {
const data = await this.request(
`/note/subfolder/list?campaign=${encodeURIComponent(campaignId)}&folder=${encodeURIComponent(folder._id)}`
);
return (data.notes || []).map((note) => ({ note, folders: folderPath(folder._id) }));
}));
const notes = (root.notes || []).map((note) => ({ note, folders: [] }));
for (const result of nestedResults) notes.push(...result);
return notes;
}
async importCampaignNotes() {
try {
const campaign = await this.selectedCampaign();
const notes = await this.fetchCampaignNotes(campaign._id);
const existingById = await this.findFilesByDragonrollId();
const baseFolder = normalizePath(`Dragonroll/${safeSegment(campaign.name, 'Campaign')}`);
let created = 0;
let updated = 0;
let unchanged = 0;
let protectedNotes = 0;
for (const entry of notes) {
const remote = entry.note;
const id = String(remote._id);
const title = String(remote.title || 'Untitled');
const content = String(remote.content || '');
const remoteSignature = await signature(title, content);
const file = existingById.get(id);
if (!file) {
const targetFolder = normalizePath([baseFolder, ...entry.folders].join('/'));
await this.ensureFolder(targetFolder);
const path = await this.availableMarkdownPath(targetFolder, title, id);
const newFile = await this.app.vault.create(path, content);
await this.setNoteIdentity(newFile, id, campaign._id, title);
this.settings.snapshots[id] = remoteSignature;
created += 1;
continue;
}
const localContent = await this.app.vault.read(file);
const frontmatter = this.app.metadataCache.getFileCache(file)?.frontmatter || {};
const storedTitle = frontmatter[REMOTE_TITLE_PROPERTY];
const localTitle = storedTitle && safeSegment(storedTitle, 'Untitled') === file.basename
? String(storedTitle)
: file.basename;
const localSignature = await signature(localTitle, stripPluginMetadata(localContent));
const baseline = this.settings.snapshots[id];
if (!baseline) {
if (localSignature === remoteSignature) {
this.settings.snapshots[id] = remoteSignature;
unchanged += 1;
} else {
protectedNotes += 1;
}
continue;
}
const localChanged = localSignature !== baseline;
const remoteChanged = remoteSignature !== baseline;
if (localChanged && remoteChanged) {
protectedNotes += 1;
continue;
}
if (localChanged) {
protectedNotes += 1;
continue;
}
if (!remoteChanged) {
unchanged += 1;
continue;
}
await this.app.vault.modify(file, content);
await this.setNoteIdentity(file, id, campaign._id, title);
const renamed = await this.renameImportedFile(file, title, id);
this.settings.snapshots[id] = remoteSignature;
updated += 1;
if (renamed) existingById.set(id, renamed);
}
await this.saveSettings();
const details = protectedNotes ? `; ${protectedNotes} local edit(s) kept for review` : '';
new Notice(`Dragonroll import: ${created} added, ${updated} updated, ${unchanged} unchanged${details}.`);
} catch (error) {
new Notice(error.message || 'Could not import Dragonroll notes.');
}
}
async pushActiveNote() {
try {
const campaign = await this.selectedCampaign();
const file = this.app.workspace.getActiveFile();
if (!file || file.extension !== 'md') throw new Error('Open a Markdown note to push it.');
const cache = this.app.metadataCache.getFileCache(file);
const frontmatter = cache?.frontmatter || {};
const linkedCampaign = frontmatter[CAMPAIGN_PROPERTY];
const noteId = frontmatter[NOTE_ID_PROPERTY];
if (noteId && String(linkedCampaign || '') !== String(campaign._id)) {
throw new Error('This note is linked to another Dragonroll campaign. Select that campaign to push it.');
}
const markdown = stripPluginMetadata(await this.app.vault.read(file));
let remote;
if (noteId) {
const data = await this.request('/note/update', {
method: 'POST',
body: { id: String(noteId), title: file.basename, content: markdown },
});
remote = data.note;
} else {
const data = await this.request('/note/create', {
method: 'POST',
body: { title: file.basename, content: markdown, campaign: campaign._id },
});
remote = data.note;
}
const id = String(remote._id || noteId);
await this.setNoteIdentity(file, id, campaign._id, file.basename);
this.settings.snapshots[id] = await signature(file.basename, markdown);
await this.saveSettings();
new Notice(`Pushed “${file.basename}” to Dragonroll.`);
} catch (error) {
new Notice(error.message || 'Could not push this note to Dragonroll.');
}
}
async findFilesByDragonrollId() {
const result = new Map();
for (const file of this.app.vault.getMarkdownFiles()) {
const frontmatter = this.app.metadataCache.getFileCache(file)?.frontmatter;
const id = frontmatter?.[NOTE_ID_PROPERTY];
if (id && !result.has(String(id))) result.set(String(id), file);
}
return result;
}
async setNoteIdentity(file, noteId, campaignId, title) {
await this.app.fileManager.processFrontMatter(file, (frontmatter) => {
frontmatter[NOTE_ID_PROPERTY] = String(noteId);
frontmatter[CAMPAIGN_PROPERTY] = String(campaignId);
frontmatter[REMOTE_TITLE_PROPERTY] = String(title || file.basename);
});
}
async ensureFolder(path) {
const normalized = normalizePath(path);
if (!normalized || normalized === '.') return;
const parts = normalized.split('/');
let current = '';
for (const part of parts) {
current = current ? `${current}/${part}` : part;
if (!this.app.vault.getAbstractFileByPath(current)) {
await this.app.vault.createFolder(current);
}
}
}
async availableMarkdownPath(folder, title, noteId) {
const base = safeSegment(title, 'Untitled');
let path = normalizePath(`${folder}/${base}.md`);
if (!this.app.vault.getAbstractFileByPath(path)) return path;
const suffix = String(noteId).slice(-6);
path = normalizePath(`${folder}/${base} (${suffix}).md`);
let counter = 2;
while (this.app.vault.getAbstractFileByPath(path)) {
path = normalizePath(`${folder}/${base} (${suffix}-${counter}).md`);
counter += 1;
}
return path;
}
async renameImportedFile(file, title, noteId) {
const parent = file.parent?.path || '';
const base = safeSegment(title, 'Untitled');
let targetPath = normalizePath(parent ? `${parent}/${base}.md` : `${base}.md`);
if (targetPath === file.path) return file;
if (this.app.vault.getAbstractFileByPath(targetPath)) {
targetPath = await this.availableMarkdownPath(parent || '.', title, noteId);
}
await this.app.fileManager.renameFile(file, targetPath);
return this.app.vault.getAbstractFileByPath(targetPath);
}
};
class DragonrollSettingTab extends PluginSettingTab {
constructor(app, plugin) {
super(app, plugin);
this.plugin = plugin;
this.campaigns = [];
this.loginName = '';
this.password = '';
}
display() {
const { containerEl } = this;
containerEl.empty();
containerEl.createEl('h2', { text: 'Dragonroll Sync' });
containerEl.createEl('p', {
text: 'Sign in with your Dragonroll account, choose a campaign, then use the import and push commands. Your password is used only to sign in; the 48-hour session token is stored in this vault.',
});
new Setting(containerEl)
.setName('Dragonroll API URL')
.setDesc('Use the server address, with or without /api.')
.addText((text) => text
.setPlaceholder('https://dragonroll.aranroig.com/api')
.setValue(this.plugin.settings.apiBaseUrl)
.onChange(async (value) => {
const previous = this.plugin.settings.apiBaseUrl.trim().replace(/\/+$/, '');
const next = value.trim().replace(/\/+$/, '');
if (previous !== next) {
this.plugin.settings.token = '';
this.plugin.settings.campaignId = '';
this.campaigns = [];
}
this.plugin.settings.apiBaseUrl = value.trim();
await this.plugin.saveSettings();
}));
new Setting(containerEl)
.setName('Username or email')
.addText((text) => text
.setPlaceholder('Dragonroll username or email')
.onChange((value) => { this.loginName = value.trim(); }));
new Setting(containerEl)
.setName('Password')
.addText((text) => {
text.inputEl.type = 'password';
text.inputEl.autocomplete = 'off';
text.onChange((value) => { this.password = value; });
});
new Setting(containerEl)
.setName(this.plugin.settings.token ? 'Session' : 'Sign in')
.setDesc(this.plugin.settings.token ? 'The stored session expires after 48 hours.' : 'Password is not saved by this plugin.')
.addButton((button) => button
.setButtonText('Sign in')
.setCta()
.onClick(async () => {
if (!this.loginName || !this.password) {
new Notice('Enter your Dragonroll username/email and password.');
return;
}
button.setDisabled(true);
try {
this.campaigns = await this.plugin.login(this.loginName, this.password);
this.password = '';
this.display();
new Notice(`Signed in. Found ${this.campaigns.length} campaign(s).`);
} catch (error) {
new Notice(error.message || 'Could not sign in to Dragonroll.');
} finally {
button.setDisabled(false);
}
}));
if (this.plugin.settings.token) {
new Setting(containerEl)
.setName('Campaign')
.setDesc('The campaign used by import and push commands.')
.addDropdown((dropdown) => {
dropdown.addOption('', 'Choose a campaign');
for (const campaign of this.campaigns) {
dropdown.addOption(String(campaign._id), campaign.name);
}
dropdown.setValue(this.plugin.settings.campaignId || '');
dropdown.onChange(async (value) => {
this.plugin.settings.campaignId = value;
await this.plugin.saveSettings();
});
})
.addButton((button) => button
.setButtonText('Load campaigns')
.onClick(async () => {
button.setDisabled(true);
try {
this.campaigns = await this.plugin.getCampaigns();
this.display();
new Notice(`Loaded ${this.campaigns.length} campaign(s).`);
} catch (error) {
new Notice(error.message || 'Could not load campaigns.');
} finally {
button.setDisabled(false);
}
}));
new Setting(containerEl)
.setName('Sign out')
.setDesc('Remove the saved Dragonroll session from this vault.')
.addButton((button) => button
.setButtonText('Sign out')
.onClick(async () => {
this.plugin.settings.token = '';
this.plugin.settings.campaignId = '';
await this.plugin.saveSettings();
this.display();
}));
}
}
}
function safeSegment(value, fallback) {
const safe = String(value || '')
.replace(/[\\\/:*?"<>|#^\[\]]/g, '-')
.replace(/[. ]+$/g, '')
.trim();
return safe || fallback;
}
function stripPluginMetadata(markdown) {
const text = String(markdown || '');
const match = text.match(/^(---\r?\n)([\s\S]*?)(\r?\n---(?:\r?\n|$))/);
if (!match) return text;
const keptLines = match[2].split(/\r?\n/).filter((line) =>
!/^(dragonrollId|dragonrollCampaign|dragonrollTitle):\s*/.test(line)
);
const frontmatter = keptLines.join('\n').trim();
const body = text.slice(match[0].length);
return frontmatter ? `---\n${frontmatter}\n---\n${body}` : body;
}
async function signature(title, content) {
const value = `${title}\u0000${String(content).replace(/\r\n/g, '\n')}`;
if (globalThis.crypto?.subtle) {
const digest = await globalThis.crypto.subtle.digest('SHA-256', new TextEncoder().encode(value));
return Array.from(new Uint8Array(digest), (byte) => byte.toString(16).padStart(2, '0')).join('');
}
let hash = 2166136261;
for (let index = 0; index < value.length; index += 1) {
hash = Math.imul(hash ^ value.charCodeAt(index), 16777619);
}
return (hash >>> 0).toString(16);
}

View File

@@ -0,0 +1,9 @@
{
"id": "dragonroll-sync",
"name": "Dragonroll Sync",
"version": "1.0.0",
"minAppVersion": "1.5.0",
"description": "Import Dragonroll campaign notes into Obsidian and push edits back.",
"author": "Dragonroll",
"isDesktopOnly": false
}

View File

@@ -3,6 +3,7 @@
"concurrently": "^9.2.1" "concurrently": "^9.2.1"
}, },
"scripts": { "scripts": {
"dev": "concurrently -k -n BACKEND,FRONTEND,DISCORD-BOT,FOUNDRY -c blue,green,yellow,magenta \"DEBUG=* npm --prefix backend run dev\" \"npm --prefix frontend run dev\" \"npm --prefix discord-bot start\" \"node scripts/run-foundry.js\"" "dev": "concurrently -k -n BACKEND,FRONTEND,DISCORD-BOT,FOUNDRY -c blue,green,yellow,magenta \"DEBUG=* npm --prefix backend run dev\" \"npm --prefix frontend run dev\" \"npm --prefix discord-bot start\" \"node scripts/run-foundry.js\"",
"test": "node --test tests/"
} }
} }

View File

@@ -0,0 +1,268 @@
// Tests for how the Dragonroll Foundry module connects a world to a campaign
// (Syndria98/dragonroll#17 and #19). Like foundry-sync-toggle.test.js, the module
// script runs inside a `node:vm` context of stubbed Foundry globals; here each
// test also decides what Dragonroll answers, because the pairing status is that
// answer plus what this client holds (its sync token and its sign-up link).
//
// The world no longer redeems a code typed into its settings: it asks Dragonroll
// for the same sign-up link every service gets, shows it, and picks its token up
// once a user has answered that link.
//
// Run with `npm test` from the repository root, or `node --test tests/`.
const { test } = require("node:test");
const assert = require("node:assert/strict");
const fs = require("node:fs");
const path = require("node:path");
const vm = require("node:vm");
const MODULE_ID = "dragonroll-foundry";
const MODULE_SOURCE = fs.readFileSync(
path.join(__dirname, "..", "dragonroll-foundry", "scripts", "api.js"),
"utf8",
);
const LINKED_CAMPAIGN = { id: "campaign-1", name: "Curse of Strahd" };
const SIGN_UP_LINK = "http://frontend.test/link/authorize?service=foundry#code=link-code-1";
// The stub starts as a world that finished pairing (`syncToken: ""` is one that
// never did), optionally holding a sign-up link it is waiting on. `answers` maps
// a route fragment to the JSON Dragonroll replies with; a route that is not
// listed answers `{status:"ok"}`, and one mapped to null answers HTML, like a
// Dragonroll old enough not to have that route at all.
function makeStubWorld({
syncToken = "sync-token-1",
linkCode = "",
linkUrl = "",
answers = {},
} = {}) {
const state = {
hooks: new Map(),
registered: new Map(),
requests: [],
notifications: [],
};
const settingsStore = {
autoSync: true,
syncToken,
linkCode,
linkUrl,
dragonrollApiUrl: "http://backend.test:5000",
};
const sandbox = {
console: { log() {}, info() {}, warn() {}, error() {} },
URL,
CONFIG: {},
window: { location: { origin: "http://vtt.test" } },
ui: {
notifications: {
info: (text) => state.notifications.push(["info", text]),
warn: (text) => state.notifications.push(["warn", text]),
error: (text) => state.notifications.push(["error", text]),
},
},
Hooks: {
once(name, fn) { state.hooks.set(name, [fn]); },
on(name, fn) {
const handlers = state.hooks.get(name) || [];
handlers.push(fn);
state.hooks.set(name, handlers);
},
},
// The pairing status never waits on a timer: it is written when the world is
// ready and whenever a link check answers, so dropping these keeps the
// snapshot and reconcile loops out of these tests.
setTimeout: () => 0,
clearTimeout: () => {},
setInterval: () => 0,
clearInterval: () => {},
fetch: async (url, options = {}) => {
const href = String(url);
state.requests.push({
href,
method: options.method,
body: options.body ? JSON.parse(options.body) : null,
authorization: options.headers?.Authorization || "",
});
const route = Object.keys(answers).find((fragment) => href.includes(fragment));
const payload = route ? answers[route] : { status: "ok" };
if (payload === null) {
return { ok: false, status: 404, json: async () => { throw new SyntaxError("Unexpected token < in JSON."); } };
}
return { ok: true, status: 200, json: async () => payload };
},
Actor: { async create() { return null; } },
Item: { async create() { return null; } },
};
sandbox.game = {
user: { isGM: true, name: "Test GM" },
world: { id: "world-1", title: "Test World" },
system: { id: "dnd5e" },
modules: { get: () => ({}) },
actors: { contents: [], get: () => null },
items: { contents: [], get: () => null },
settings: {
register(module, key, definition) {
state.registered.set(key, definition);
if (!(key in settingsStore)) settingsStore[key] = definition.default;
},
get(module, key) { return settingsStore[key]; },
async set(module, key, value) {
settingsStore[key] = value;
await state.registered.get(key)?.onChange?.(value);
},
},
};
vm.createContext(sandbox);
vm.runInContext(MODULE_SOURCE, sandbox);
state.game = sandbox.game;
state.setting = (key) => settingsStore[key];
state.status = () => settingsStore.pairingStatus;
state.statusRequests = () => state.requests.filter((request) => request.href.includes("foundry/sync/status"));
state.linkStarts = () => state.requests.filter((request) => request.href.includes("link/start"));
state.linkPickups = () => state.requests.filter((request) => request.href.includes("link/pickup"));
// The module's own awaits run in the vm's promise intrinsics, so a few turns of
// the event loop are what it takes for a written status to be observable.
state.settle = async () => {
for (let round = 0; round < 10; round += 1) await new Promise((resolve) => setImmediate(resolve));
};
state.fire = async (name, ...args) => {
for (const handler of state.hooks.get(name) || []) await handler(...args);
await state.settle();
};
state.start = async () => {
await state.fire("init");
await state.fire("ready");
return state;
};
return state;
}
test("the pairing status is a setting the module configures", async () => {
const world = await makeStubWorld().start();
const setting = world.registered.get("pairingStatus");
assert.equal(setting.config, true, "the pairing status appears in the module settings");
assert.equal(setting.type.name, "String", "the pairing status is a sentence");
assert.equal(setting.scope, "client", "the pairing status belongs to this client, like the token it comes from");
});
test("an unpaired world asks Dragonroll for a sign-up link and shows it", async () => {
const world = await makeStubWorld({
syncToken: "",
answers: { "link/start": { status: "ok", code: "link-code-1", linkUrl: SIGN_UP_LINK } },
}).start();
const started = world.linkStarts()[0];
assert.ok(started, "the world asks for a link of its own");
assert.equal(started.body.service, "foundry", "and says which service it is");
assert.equal(started.body.target.id, "world-1", "the world tells Dragonroll who it is");
assert.equal(started.body.target.name, "Test World");
assert.equal(started.body.target.meta.system, "dnd5e");
assert.match(world.status(), /^Not connected yet/);
assert.ok(world.status().includes(SIGN_UP_LINK), "the status is the link the GM has to open");
assert.equal(world.setting("linkCode"), "link-code-1", "the code behind the link is kept to ask with");
});
test("a world that holds a token neither asks for a link nor waits on one", async () => {
const world = await makeStubWorld({
answers: { "foundry/sync/status": { status: "ok", campaign: LINKED_CAMPAIGN, worldId: "world-1" } },
}).start();
assert.equal(world.status(), `Connected to the Dragonroll campaign "${LINKED_CAMPAIGN.name}".`);
assert.deepEqual(world.linkStarts(), [], "a paired world has nothing to link");
assert.equal(world.statusRequests()[0].authorization, "Bearer sync-token-1", "the campaign is asked with the sync token");
});
test("a campaign that unlinked this world stops being reported as connected", async () => {
const world = await makeStubWorld({
answers: { "foundry/sync/status": { status: "error", msg: "unauthorized" } },
}).start();
assert.match(world.status(), /^Not connected/);
assert.match(world.status(), /no longer linked/);
assert.equal(world.setting("syncToken"), "", "the dead token is dropped, so nothing keeps pushing to that campaign");
});
test("an unreachable Dragonroll keeps the pairing this client already knows", async () => {
const world = await makeStubWorld({ answers: { "foundry/sync/status": null } }).start();
assert.equal(world.status(), "Connected to a Dragonroll campaign.",
"a Dragonroll without the status route says nothing, so the token speaks");
});
test("a link still waiting on its GM says the world is not connected yet", async () => {
const world = await makeStubWorld({
syncToken: "",
linkCode: "link-code-1",
linkUrl: SIGN_UP_LINK,
answers: { "link/pickup": { status: "ok", state: "pending" } },
}).start();
assert.equal(world.linkPickups()[0].body.code, "link-code-1", "the world asks with the code it was given");
assert.deepEqual(world.linkStarts(), [], "an unanswered link is kept, not replaced");
assert.match(world.status(), /^Not connected yet/);
assert.ok(world.status().includes(SIGN_UP_LINK), "and it is still the link to open");
});
test("a picked-up link connects the world, hands over its token and is dropped", async () => {
const world = await makeStubWorld({
syncToken: "",
linkCode: "link-code-1",
linkUrl: SIGN_UP_LINK,
answers: {
"link/pickup": {
status: "ok",
state: "linked",
campaign: LINKED_CAMPAIGN,
syncToken: "sync-token-2",
bridgeConfig: { url: "http://bridge.test", pushToken: "push-1" },
},
// The token this link handed over is the one the campaign is asked with.
"foundry/sync/status": { status: "ok", campaign: LINKED_CAMPAIGN, worldId: "world-1" },
},
}).start();
assert.equal(world.status(), `Connected to the Dragonroll campaign "${LINKED_CAMPAIGN.name}".`);
assert.equal(world.setting("syncToken"), "sync-token-2", "the token the link came with is what sync runs on");
assert.deepEqual(world.setting("bridgeConfig"), { url: "http://bridge.test", pushToken: "push-1" });
assert.equal(world.setting("linkCode"), "", "a link that delivered its token is not asked about again");
assert.equal(world.setting("linkUrl"), "");
});
test("an expired link is replaced by one the GM can still open", async () => {
const world = await makeStubWorld({
syncToken: "",
linkCode: "link-code-1",
linkUrl: SIGN_UP_LINK,
answers: {
"link/pickup": { status: "ok", state: "expired" },
"link/start": { status: "ok", code: "link-code-2", linkUrl: "http://frontend.test/link/authorize?service=foundry#code=link-code-2" },
},
}).start();
assert.equal(world.setting("linkCode"), "link-code-2", "the world keeps a link nobody has to guess at");
assert.match(world.status(), /link-code-2/, "and shows the new one");
});
test("whatever is typed into the status is replaced by the real one", async () => {
const world = await makeStubWorld({
answers: { "foundry/sync/status": { status: "ok", campaign: LINKED_CAMPAIGN, worldId: "world-1" } },
});
await world.start();
await world.game.settings.set(MODULE_ID, "pairingStatus", "My own status text");
await world.settle();
assert.equal(world.status(), `Connected to the Dragonroll campaign "${LINKED_CAMPAIGN.name}".`);
});

View File

@@ -0,0 +1,312 @@
// Tests for the Dragonroll Foundry module's sync toggle and per-actor force sync
// (Syndria98/dragonroll#8). The module is a Foundry client script with no module
// wrapper, so it is loaded into a `node:vm` context holding stubbed Foundry
// globals (`game`, `Hooks`, `ui`, `fetch`) with fake timers: that makes every
// queued push, retry and reconcile observable without a running Foundry VTT.
//
// Run with `npm test` from the repository root, or `node --test tests/`.
const { test } = require("node:test");
const assert = require("node:assert/strict");
const fs = require("node:fs");
const path = require("node:path");
const vm = require("node:vm");
const MODULE_ID = "dragonroll-foundry";
const MODULE_SOURCE = fs.readFileSync(
path.join(__dirname, "..", "dragonroll-foundry", "scripts", "api.js"),
"utf8",
);
function stubDocument(id, name, extra = {}) {
return {
id,
name,
flags: {},
getFlag(module, key) { return this.flags?.[module]?.[key]; },
async update(data) {
for (const [key, value] of Object.entries(data)) {
const parts = key.split(".");
const last = parts.pop();
let target = this;
for (const part of parts) target = target[part] ??= {};
target[last] = value;
}
return this;
},
toObject() {
return {
_id: this.id,
name: this.name,
type: this.type,
img: "icons/svg/mystery-man.svg",
flags: this.flags,
...(this.system ? { system: this.system } : {}),
};
},
...extra,
};
}
function makeWorldItem(id, name) {
return stubDocument(id, name, {
documentName: "Item",
type: "weapon",
parent: null,
system: { properties: { value: [] }, quantity: 1, weight: 3, rarity: "common" },
});
}
function makeStubWorld({ autoSync = true } = {}) {
const state = {
hooks: new Map(),
registered: new Map(),
requests: [],
notifications: [],
timers: new Map(),
nextTimerId: 1,
};
const actors = [
stubDocument("actor-1", "Thalia", { documentName: "Actor", type: "character", items: { contents: [] } }),
stubDocument("actor-2", "Grunt", { documentName: "Actor", type: "npc", items: { contents: [] } }),
];
const settingsStore = {
autoSync,
syncToken: "sync-token-1",
dragonrollApiUrl: "http://backend.test:5000",
};
const sandbox = {
console: { log() {}, info() {}, warn() {}, error() {} },
URL,
CONFIG: {},
window: { location: { origin: "http://vtt.test" } },
ui: {
notifications: {
info: (text) => state.notifications.push(["info", text]),
warn: (text) => state.notifications.push(["warn", text]),
error: (text) => state.notifications.push(["error", text]),
},
},
Hooks: {
once(name, fn) { state.hooks.set(name, [fn]); },
on(name, fn) {
const handlers = state.hooks.get(name) || [];
handlers.push(fn);
state.hooks.set(name, handlers);
},
},
// Fake timers: the module debounces and retries with setTimeout, so the tests
// decide when those callbacks run instead of waiting on the wall clock.
setTimeout: (fn, delay = 0) => {
const id = state.nextTimerId++;
state.timers.set(id, { fn, delay });
return id;
},
clearTimeout: (id) => state.timers.delete(id),
setInterval: () => 0,
clearInterval: () => {},
fetch: async (url, options = {}) => {
state.requests.push({
href: String(url),
method: options.method,
body: options.body ? JSON.parse(options.body) : null,
});
return { ok: true, status: 200, json: async () => ({ status: "ok", actors: [], items: [] }) };
},
Actor: { async create() { return null; } },
Item: { async create() { return null; } },
};
sandbox.game = {
user: { isGM: true },
world: { id: "world-1", title: "Test World" },
system: { id: "dnd5e" },
modules: { get: () => ({}) },
actors: { contents: actors, get: (id) => actors.find((actor) => actor.id === id) },
items: { contents: [], get: () => null },
settings: {
register(module, key, definition) {
state.registered.set(key, definition);
if (!(key in settingsStore)) settingsStore[key] = definition.default;
},
get(module, key) { return settingsStore[key]; },
async set(module, key, value) {
settingsStore[key] = value;
await state.registered.get(key)?.onChange?.(value);
},
},
};
vm.createContext(sandbox);
vm.runInContext(MODULE_SOURCE, sandbox);
state.game = sandbox.game;
state.actor = (id) => actors.find((document) => document.id === id);
// Sync pushes only: the pairing status read lives under the same prefix, and it
// tells nothing about what the world sent.
state.syncRequests = () => state.requests.filter((request) => request.href.includes("foundry/sync")
&& !request.href.includes("foundry/sync/status"));
state.fire = async (name, ...args) => {
for (const handler of state.hooks.get(name) || []) await handler(...args);
await drain();
};
state.runTimers = async () => {
for (let round = 0; round < 6; round += 1) {
if (!state.timers.size && round > 2) break;
const due = [...state.timers.values()];
state.timers.clear();
for (const timer of due) await timer.fn();
await drain();
}
};
async function drain() {
await new Promise((resolve) => setImmediate(resolve));
}
state.linkedSetup = async () => {
await state.fire("init");
await state.fire("ready");
await state.runTimers();
state.requests.length = 0;
return state;
};
return state;
}
async function forceSyncActors(world, ...actorIds) {
const options = [];
await world.fire("getActorDirectoryEntryContext", null, options);
const entry = options.find((option) => option.name === "Dragonroll: Force Sync");
assert.ok(entry, "Dragonroll: Force Sync is offered in the actor directory context menu");
await entry.callback(actorIds.map((actorId) => ({ dataset: { actorId } })));
await world.runTimers();
}
test("auto-sync is a module setting that is on by default", async () => {
const world = makeStubWorld();
await world.fire("init");
const setting = world.registered.get("autoSync");
assert.equal(setting.default, true, "autosync is on by default");
assert.equal(setting.config, true, "autosync appears in the module settings");
assert.equal(world.game.settings.get(MODULE_ID, "autoSync"), true);
});
test("autosync on: Foundry CRUD events keep syncing with Dragonroll", async () => {
const world = await makeStubWorld().linkedSetup();
await world.fire("updateActor", world.actor("actor-1"));
await world.runTimers();
const pushes = world.syncRequests();
assert.equal(pushes.length, 1);
assert.equal(pushes[0].body.actors[0]._id, "actor-1");
});
test("autosync off: CRUD requests stop syncing", async () => {
const world = await makeStubWorld().linkedSetup();
await world.game.settings.set(MODULE_ID, "autoSync", false);
await world.fire("updateActor", world.actor("actor-1"));
await world.fire("deleteActor", world.actor("actor-2"));
await world.fire("createItem", makeWorldItem("item-1", "Longsword"));
await world.runTimers();
assert.deepEqual(world.syncRequests(), []);
});
test("edits made while autosync is off are delivered when it is turned back on", async () => {
const world = await makeStubWorld().linkedSetup();
await world.game.settings.set(MODULE_ID, "autoSync", false);
await world.fire("updateActor", world.actor("actor-1"));
await world.fire("createItem", makeWorldItem("item-1", "Longsword"));
await world.runTimers();
assert.deepEqual(world.syncRequests(), []);
await world.game.settings.set(MODULE_ID, "autoSync", true);
await world.runTimers();
const pushes = world.syncRequests();
assert.ok(pushes.some((request) => request.body?.fullSync === false
&& request.body.actors?.some((actor) => actor._id === "actor-1")),
"the actor edit queued while autosync was off is sent");
assert.ok(pushes.some((request) => request.href.includes("foundry/sync/item-snapshot")
&& request.body.items.some((item) => item._id === "item-1")),
"the item edit queued while autosync was off is sent");
});
test("autosync off at world start: no snapshot and no reconcile", async () => {
const world = makeStubWorld({ autoSync: false });
await world.fire("init");
await world.fire("ready");
await world.runTimers();
assert.deepEqual(world.syncRequests(), []);
});
test("force sync sends selected actors to Dragonroll even with autosync off", async () => {
const world = await makeStubWorld().linkedSetup();
await world.game.settings.set(MODULE_ID, "autoSync", false);
await forceSyncActors(world, "actor-2");
const pushes = world.syncRequests();
assert.equal(pushes.length, 1);
assert.equal(pushes[0].body.fullSync, false, "a forced actor never prunes the campaign");
assert.deepEqual(pushes[0].body.actors.map((actor) => actor._id), ["actor-2"]);
assert.deepEqual(world.notifications.filter(([kind]) => kind !== "info"), []);
});
test("force sync sends every selected actor in one push", async () => {
const world = await makeStubWorld().linkedSetup();
await world.game.settings.set(MODULE_ID, "autoSync", false);
await forceSyncActors(world, "actor-1", "actor-2");
const pushes = world.syncRequests();
assert.equal(pushes.length, 1);
assert.deepEqual(pushes[0].body.actors.map((actor) => actor._id), ["actor-1", "actor-2"]);
});
test("force sync also works while autosync is on", async () => {
const world = await makeStubWorld().linkedSetup();
await forceSyncActors(world, "actor-1");
assert.deepEqual(world.syncRequests()[0]?.body.actors.map((actor) => actor._id), ["actor-1"]);
});
test("force sync refuses an actor Dragonroll does not import", async () => {
const world = makeStubWorld({ autoSync: false });
await world.fire("init");
const cart = stubDocument("actor-3", "Cart", { documentName: "Actor", type: "vehicle", items: { contents: [] } });
world.game.actors.contents.push(cart);
await forceSyncActors(world, "actor-3");
assert.deepEqual(world.syncRequests(), []);
assert.ok(world.notifications.some(([kind, text]) => kind === "warn" && text.includes("Cart")));
});
test("turning autosync back on reconciles both sides again", async () => {
const world = makeStubWorld({ autoSync: false });
await world.fire("init");
await world.fire("ready");
await world.runTimers();
assert.deepEqual(world.syncRequests(), []);
await world.game.settings.set(MODULE_ID, "autoSync", true);
await world.runTimers();
assert.ok(world.syncRequests().some((request) => request.body?.fullSync === true),
"the world sends its full snapshot again");
assert.ok(world.requests.some((request) => request.href.includes("foundry/sync/characters")),
"Dragonroll documents are applied back into the world");
});

379
tests/map-pins.test.js Normal file
View File

@@ -0,0 +1,379 @@
// Tests for the notes pinned onto a map (Syndria98/dragonroll#20): right clicking a map pins one of
// the campaign notes at that spot, and clicking the marker reads the linked note in a window.
//
// The repository root installs no dependencies, so both sides are loaded into `node:vm` contexts.
// The express routers run against a stubbed `require` (express itself, multer and the mongoose
// models) answering with plain objects: that keeps the ownership, same-campaign and dedup rules of
// POST /map/pin observable without a database. `frontend/app/services/MapPins.js` holds the image ↔
// screen translation and the note picker labels, and is loaded the way map-viewer.test.js loads
// Content.js. The last checks read the template of the map viewer, because there the wiring itself
// is what has to stay right.
//
// Run with `npm test` from the repository root, or `node --test tests/`.
const { test } = require("node:test");
const assert = require("node:assert/strict");
const fs = require("node:fs");
const path = require("node:path");
const vm = require("node:vm");
function readRepoFile(...parts) {
return fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
}
// A mongoose query answers whatever `await query` and `query.lean()` answer with, and lets `select()`
// and `sort()` sit in between.
function mongooseQuery(value) {
const result = {
select: () => result,
sort: () => result,
lean: () => Promise.resolve(value),
then: (onFulfilled, onRejected) => Promise.resolve(value).then(onFulfilled, onRejected),
};
return result;
}
// Loads an express router file with every module it requires stubbed out: `stubs` maps a require
// path ("../models/Map") to the module the route should see.
function loadRouter(relativeParts, stubs) {
const routes = new Map();
const router = {
get: (route, ...handlers) => routes.set(`GET ${route}`, handlers),
post: (route, ...handlers) => routes.set(`POST ${route}`, handlers),
};
const requireStub = (id) => {
if (id === "express") return { Router: () => router };
if (id === "../services/storage") return { single: () => (req, res, next) => next() };
if (!(id in stubs)) throw new Error(`require("${id}") is not stubbed`);
return stubs[id];
};
// Both files only need `require`, `module` and `exports`, so they are compiled as functions in
// the realm of the tests: the objects the routes build are then plain host objects to assert on.
const moduleStub = { exports: {} };
vm.compileFunction(readRepoFile(...relativeParts), ["require", "module", "exports"])(
requireStub, moduleStub, moduleStub.exports
);
async function call(route, { body = {}, query = {}, params = {}, user = { id: "user-1" } } = {}) {
const handlers = routes.get(route);
assert.ok(handlers, `${route} is not mounted`);
const res = { payload: null, json(payload) { this.payload = payload; } };
// The multer middleware the routes mount is stubbed away, so the handler is the last one.
await handlers[handlers.length - 1]({ body, query, params, user }, res);
return res.payload;
}
return { routes, call };
}
function makeMap(pins = []) {
return { _id: "map-1", campaign: "campaign-1", pins, save: async () => {} };
}
function loadMapRoutes({ ownsCampaign = true, maps = [], notes = [] } = {}) {
return loadRouter(["backend", "src", "routes", "map.js"], {
"../models/Campaign": { findOne: () => mongooseQuery(ownsCampaign ? { _id: "campaign-1" } : null) },
"../models/Map": { findById: (id) => mongooseQuery(maps.find((map) => map._id === id) ?? null) },
"../models/Note": {
findOne: (filter) => mongooseQuery(
notes.some((note) => note._id === String(filter._id) && String(note.campaign) === String(filter.campaign))
? { _id: String(filter._id) }
: null
),
},
});
}
function mapPinRouteTests() {
test("pinning a note stores it at the spot that was clicked", async () => {
const map = makeMap();
const api = loadMapRoutes({ maps: [map], notes: [{ _id: "note-1", campaign: "campaign-1" }] });
const response = await api.call("POST /pin", { body: { id: "map-1", note: "note-1", x: 420, y: 96 } });
assert.equal(response.status, "ok");
assert.deepEqual(map.pins, [{ note: "note-1", x: 420, y: 96 }]);
});
test("a pin keeps whole image pixels and never goes off the top left corner", async () => {
const map = makeMap();
const api = loadMapRoutes({ maps: [map], notes: [{ _id: "note-1", campaign: "campaign-1" }] });
// Coordinates arrive as strings from a multipart form, and a drag can leave the image.
await api.call("POST /pin", { body: { id: "map-1", note: "note-1", x: "120.6", y: -8 } });
assert.deepEqual(map.pins, [{ note: "note-1", x: 121, y: 0 }]);
});
test("a note of another campaign cannot be pinned onto a map", async () => {
const map = makeMap();
const api = loadMapRoutes({ maps: [map], notes: [{ _id: "note-2", campaign: "campaign-2" }] });
const response = await api.call("POST /pin", { body: { id: "map-1", note: "note-2", x: 10, y: 10 } });
assert.equal(response.msg, "errors.notfound");
assert.deepEqual(map.pins, []);
});
test("a map of somebody else's campaign answers unauthorized", async () => {
const map = makeMap();
const api = loadMapRoutes({ ownsCampaign: false, maps: [map], notes: [{ _id: "note-1", campaign: "campaign-1" }] });
const response = await api.call("POST /pin", { body: { id: "map-1", note: "note-1", x: 10, y: 10 } });
assert.equal(response.msg, "unauthorized");
assert.deepEqual(map.pins, []);
});
test("pinning a note again moves its marker instead of adding a twin", async () => {
const map = makeMap([{ _id: "pin-1", note: "note-1", x: 10, y: 10 }]);
const api = loadMapRoutes({ maps: [map], notes: [{ _id: "note-1", campaign: "campaign-1" }] });
await api.call("POST /pin", { body: { id: "map-1", note: "note-1", x: 300, y: 220 } });
assert.equal(map.pins.length, 1);
assert.deepEqual({ ...map.pins[0] }, { _id: "pin-1", note: "note-1", x: 300, y: 220 });
});
test("pinning needs both a map and a note", async () => {
const map = makeMap();
const api = loadMapRoutes({ maps: [map], notes: [{ _id: "note-1", campaign: "campaign-1" }] });
assert.equal((await api.call("POST /pin", { body: { note: "note-1", x: 1, y: 1 } })).msg, "errors.missing-data");
assert.equal((await api.call("POST /pin", { body: { id: "map-1", x: 1, y: 1 } })).msg, "errors.missing-data");
assert.deepEqual(map.pins, []);
});
test("unpin removes the pin it is given and keeps the others", async () => {
const map = makeMap([
{ _id: "pin-1", note: "note-1", x: 10, y: 10 },
{ _id: "pin-2", note: "note-2", x: 20, y: 20 },
]);
const api = loadMapRoutes({ maps: [map], notes: [] });
const response = await api.call("POST /unpin", { body: { id: "map-1", pin: "pin-1" } });
assert.equal(response.status, "ok");
assert.deepEqual(map.pins.map((pin) => pin._id), ["pin-2"]);
});
test("unpin of a map of somebody else keeps its pins", async () => {
const map = makeMap([{ _id: "pin-1", note: "note-1", x: 10, y: 10 }]);
const api = loadMapRoutes({ ownsCampaign: false, maps: [map] });
const response = await api.call("POST /unpin", { body: { id: "map-1", pin: "pin-1" } });
assert.equal(response.msg, "unauthorized");
assert.equal(map.pins.length, 1);
});
}
function loadNoteRoutes({ ownsCampaign = true, notes = [], folders = [], deletedCount = 1 } = {}) {
const pinsPulled = [];
const api = loadRouter(["backend", "src", "routes", "note.js"], {
"../models/Campaign": { findOne: () => mongooseQuery(ownsCampaign ? { _id: "campaign-1" } : null) },
"../models/Note": {
find: () => mongooseQuery(notes),
findById: (id) => mongooseQuery(notes.find((note) => note._id === id) ?? null),
deleteOne: () => mongooseQuery({ deletedCount }),
},
"../models/Folder": { find: () => mongooseQuery(folders) },
"../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.
updateMany: async (filter, update) => {
pinsPulled.push({ filter, update });
return { modifiedCount: 1 };
},
},
});
return { api, pinsPulled };
}
function campaignNotesTests() {
const notes = [
{ _id: "note-1", title: "The Altar", folder: "folder-2" },
{ _id: "note-2", title: "The Inn", folder: null },
];
const folders = [
{ _id: "folder-1", name: "Undercity" },
{ _id: "folder-2", name: "Temple", parentFolder: "folder-1" },
];
test("the note picker answers with every note and the folders they live in", async () => {
const { api } = loadNoteRoutes({ notes, folders });
const response = await api.call("GET /all", { query: { campaign: "campaign-1" } });
assert.equal(response.status, "ok");
assert.deepEqual(response.notes.map((note) => note.title), ["The Altar", "The Inn"]);
assert.deepEqual(response.folders.map((folder) => folder.name), ["Undercity", "Temple"]);
});
test("the note picker needs a campaign, and only of one's own", async () => {
const { api } = loadNoteRoutes({ notes, folders });
const { api: foreignCampaign } = loadNoteRoutes({ ownsCampaign: false, notes, folders });
assert.equal((await api.call("GET /all")).msg, "errors.missing-data");
assert.equal((await foreignCampaign.call("GET /all", { query: { campaign: "campaign-1" } })).msg, "unauthorized");
});
test("a note can be read on its own, the way a map pin asks for it", async () => {
const { api } = loadNoteRoutes({ notes: [{ _id: "note-1", title: "The Altar", content: "## The altar" }] });
const response = await api.call("GET /retrieve/:id", { params: { id: "note-1" } });
assert.equal(response.status, "ok");
assert.equal(response.note.content, "## The altar");
});
test("a note of a campaign the user does not own cannot be read", async () => {
const { api } = loadNoteRoutes({ ownsCampaign: false, notes: [{ _id: "note-1", title: "The Altar" }] });
const response = await api.call("GET /retrieve/:id", { params: { id: "note-1" } });
assert.equal(response.msg, "unauthorized");
});
test("deleting a note pulls the pins pointing at it", async () => {
const { api, pinsPulled } = loadNoteRoutes({ notes: [{ _id: "note-1", title: "The Altar" }] });
const response = await api.call("POST /delete", { body: { id: "note-1" } });
assert.equal(response.status, "ok");
assert.deepEqual(pinsPulled, [{ filter: { "pins.note": "note-1" }, update: { $pull: { pins: { note: "note-1" } } } }]);
});
test("deleting a note that is not there does not touch any map", async () => {
const { api, pinsPulled } = loadNoteRoutes({ notes: [], deletedCount: 0 });
const response = await api.call("POST /delete", { body: { id: "note-9" } });
assert.equal(response.msg, "errors.notfound");
assert.deepEqual(pinsPulled, []);
});
}
function loadMapPinsService() {
const source = readRepoFile("frontend", "app", "services", "MapPins.js");
const body = source
.replace(/import\s*\{[^}]*\}\s*from\s*['"]vue['"];?/, "")
.replace(/export\s*\{/, "return {")
.concat("\n;");
return vm.compileFunction(body, [])();
}
function mapPinsServiceTests() {
const service = loadMapPinsService();
// 800x600 image, shown at 200% and panned so its top left corner sits at (20, 10) of the viewport.
const view = { zoom: 2, pan: { x: 20, y: 10 }, width: 800, height: 600 };
test("a spot of the viewport becomes the pixel of the image it stands for", () => {
assert.deepEqual(service.ToImagePoint({ x: 100, y: 50 }, view), { x: 40, y: 20 });
});
test("spots outside the image pin nothing", () => {
assert.equal(service.ToImagePoint({ x: 10, y: 50 }, view), null);
assert.equal(service.ToImagePoint({ x: 100, y: -5 }, view), null);
assert.equal(service.ToImagePoint({ x: 1700, y: 50 }, view), null);
});
test("without a loaded image there is no spot to pin", () => {
assert.equal(service.ToImagePoint({ x: 100, y: 50 }, { zoom: 1, pan: { x: 0, y: 0 }, width: 0, height: 0 }), null);
assert.equal(service.ToImagePoint({ x: 100, y: 50 }, undefined), null);
});
test("a pin lands on the same spot of the screen it was placed at", () => {
// An even spot: the image pixels of a pin are rounded, so the round trip is exact there.
const spot = service.ToImagePoint({ x: 370, y: 124 }, view);
assert.deepEqual(spot, { x: 175, y: 57 });
assert.deepEqual(service.ToScreenPoint(spot, view), { x: 370, y: 124 });
});
test("pins follow the map but keep their own size", () => {
// Only the position scales: the marker itself is drawn outside of the scaled stage.
assert.deepEqual(service.ToScreenPoint({ x: 40, y: 20 }, { ...view, zoom: 4 }), { x: 180, y: 90 });
assert.deepEqual(service.ToScreenPoint({ x: 40, y: 20 }, { ...view, pan: { x: -40, y: 0 } }), { x: 40, y: 40 });
});
test("notes of a folder are labelled with where they live", () => {
const options = service.BuildNoteOptions(
[{ _id: "note-1", title: "The Altar", folder: "folder-2" }, { _id: "note-2", title: "The Inn", folder: null }],
[{ _id: "folder-1", name: "Undercity" }, { _id: "folder-2", name: "Temple", parentFolder: "folder-1" }]
);
assert.deepEqual(options.map((option) => option.label), ["The Inn", "Undercity / Temple / The Altar"]);
assert.equal(options.find((option) => option.value === "note-1").path, "Undercity / Temple");
});
test("the picker is sorted by the label it shows, not by the bare title", () => {
const options = service.BuildNoteOptions(
[{ _id: "note-1", title: "Bridge", folder: null }, { _id: "note-2", title: "Altar", folder: "folder-1" }],
[{ _id: "folder-1", name: "Cave" }]
);
// "Altar" would lead the menu by title, but it is nowhere near it once its folder is named.
assert.deepEqual(options.map((option) => option.value), ["note-1", "note-2"]);
});
test("a note without a title is left out of the picker", () => {
const options = service.BuildNoteOptions([{ _id: "note-1", title: " " }], []);
assert.deepEqual(options, []);
});
test("a broken folder chain cannot loop the picker", () => {
const options = service.BuildNoteOptions(
[{ _id: "note-1", title: "The Altar", folder: "folder-1" }],
[{ _id: "folder-1", name: "One", parentFolder: "folder-2" }, { _id: "folder-2", name: "Two", parentFolder: "folder-1" }]
);
assert.equal(options[0].label, "Two / One / The Altar");
});
test("renaming a note keeps the folder path of its label", () => {
const option = { value: "note-1", title: "The Altar", path: "Undercity / Temple" };
option.title = "The Ruined Altar";
assert.equal(service.OptionLabel(option), "Undercity / Temple / The Ruined Altar");
});
}
function mapViewerWiringTests() {
const pane = readRepoFile("frontend", "app", "components", "viewer", "map", "MapViewerPane.vue");
const definitions = readRepoFile("frontend", "app", "services", "WindowDefinitions.js");
const windowSource = readRepoFile("frontend", "app", "components", "windows", "PinnedNoteWindow.vue");
test("right clicking the map opens the pin menu", () => {
const viewport = /<div[^>]*ref="viewport"[^>]*>/.exec(pane)?.[0];
assert.ok(viewport, "expected the map viewport element");
assert.match(viewport, /@contextmenu\.prevent="onMapContextMenu"/);
});
test("pins are drawn in screen space and only they catch the mouse", () => {
// Inside the scaled stage the markers would shrink and grow with the map instead of staying
// where they were placed; the overlay must not take the mouse away from panning.
assert.match(pane, /class="map-pin"[^>]*:style="pinStyle\(pin\)"/);
assert.match(pane, /\.map-pins\s*\{[^}]*pointer-events:\s*none/);
assert.match(pane, /\.map-pin\s*\{[^}]*pointer-events:\s*auto/);
});
test("a pin opens the linked note and does not start a pan", () => {
assert.match(pane, /@pointerdown\.stop/);
assert.match(pane, /@click="openPinnedNote\(pin\)"/);
assert.match(pane, /CreateWindow\('pinned_note'/);
});
test("the pinned note window is registered and reads the note from the server", () => {
assert.match(definitions, /pinned_note:\s*\{[^}]*windows\.pinned-note[^}]*PinnedNoteWindow\.vue/s);
assert.match(windowSource, /get\(`\/note\/retrieve\/\$\{noteId\}`\)/);
});
}
mapPinRouteTests();
campaignNotesTests();
mapPinsServiceTests();
mapViewerWiringTests();

116
tests/map-viewer.test.js Normal file
View File

@@ -0,0 +1,116 @@
// Tests for the map viewer adjustments of Syndria98/dragonroll#15:
// * the campaign workspace can show an anchored map where the open notes are, and the sidebar's
// notes/maps buttons switch between the two without losing either,
// * the create map window no longer snaps the scale to `min + n * step` values and insets its
// content from the window edges.
//
// `frontend/app/services/Content.js` is a Vue module and the repository root installs no
// dependencies, so it is loaded into a `node:vm` context with a minimal `ref` stub: the anchor and
// pane rules are plain state transitions and stay fully observable that way. The create map window
// checks read its template, because both requirements are about the input element itself.
//
// Run with `npm test` from the repository root, or `node --test tests/`.
const { test } = require("node:test");
const assert = require("node:assert/strict");
const fs = require("node:fs");
const path = require("node:path");
const vm = require("node:vm");
function readRepoFile(...parts) {
return fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
}
function loadContentService() {
const source = readRepoFile("frontend", "app", "services", "Content.js");
const body = source
.replace(/import\s*\{[^}]*\}\s*from\s*['"]vue['"];?/, "")
.replace(/export\s*\{/, "return {")
.concat("\n;");
const context = vm.createContext({ ref: (value) => ({ value }) });
return vm.compileFunction(body, [], { parsingContext: context })();
}
function anchoredMapTests() {
test("the workspace starts on the open notes with no map anchored", () => {
const service = loadContentService();
assert.equal(service.ActivePane.value, "notes");
assert.equal(service.AnchoredMap.value, null);
});
test("anchoring a map shows it instead of the notes", () => {
const service = loadContentService();
service.AnchorMap({ _id: "map-1", name: "Dungeon" });
assert.equal(service.ActivePane.value, "map");
assert.equal(service.AnchoredMap.value._id, "map-1");
});
test("switching back to the notes keeps the map anchored", () => {
const service = loadContentService();
service.AnchorMap({ _id: "map-1" });
service.SetActivePane("notes");
assert.equal(service.ActivePane.value, "notes");
assert.equal(service.AnchoredMap.value._id, "map-1");
});
test("clearing the anchor shows the notes again", () => {
const service = loadContentService();
service.AnchorMap({ _id: "map-1" });
service.ClearAnchoredMap();
assert.equal(service.AnchoredMap.value, null);
assert.equal(service.ActivePane.value, "notes");
});
test("anchoring nothing falls back to the notes", () => {
const service = loadContentService();
service.AnchorMap({ _id: "map-1" });
service.AnchorMap(null);
assert.equal(service.AnchoredMap.value, null);
assert.equal(service.ActivePane.value, "notes");
});
test("hiding a pane does not disturb the other one", () => {
const service = loadContentService();
service.AnchorMap({ _id: "map-1" });
service.SetShowContent(false);
assert.equal(service.ShowContent.value, false);
assert.equal(service.ActivePane.value, "map");
});
}
function createMapWindowTests() {
const source = readRepoFile("frontend", "app", "components", "windows", "CreateMapWindow.vue");
const scaleInput = /<input[^>]*v-model\.number="form\.scale"[^>]*>/.exec(source);
test("the create map window has a scale input", () => {
assert.ok(scaleInput, "expected a v-model.number=\"form.scale\" input");
});
test("the scale input accepts any decimal number", () => {
const step = /step="([^"]*)"/.exec(scaleInput[0])?.[1];
// A number input only accepts `min + n * step`, so a 0.5 step on the 0.01 minimum only
// ever offered 5.01, 5.51, 6.01... instead of the number that was typed.
assert.ok(
step === undefined || step === "any",
`the scale input must not snap values, found step="${step}"`
);
});
test("the scale input keeps the positive minimum shared with the backend", () => {
const min = /min="([^"]*)"/.exec(scaleInput[0])?.[1];
assert.equal(min, "0.01");
});
test("the create map window insets its content with an outer margin", () => {
const body = /\.body\s*\{[^}]*\}/.exec(source)?.[0];
assert.ok(body, "expected a .body style rule");
assert.match(body, /margin:\s*[^;]*\d+px/, ".body needs an outer margin");
// Without border-box the horizontal margin is added outside the full width and the
// content overflows the window instead of being inset by it.
assert.match(body, /box-sizing:\s*border-box/, ".body needs box-sizing: border-box");
});
}
anchoredMapTests();
createMapWindowTests();

View File

@@ -0,0 +1,88 @@
// Tests for the entity-entry sizing problem of Syndria98/dragonroll#21: the actor / item / map rows
// in the campaign sidebar were wider than the sidebar itself, so their hover border and the anchored
// state of a map poked outside of it.
//
// The repository root installs no dependencies, so the checks read the sidebar component the same way
// `tests/map-viewer.test.js` reads its window: the rules are about the box of the elements themselves.
//
// 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 source = fs.readFileSync(
path.join(__dirname, "..", "frontend", "app", "components", "partials", "ContentSidebar.vue"),
"utf8"
);
// `selector` is inserted verbatim, so escape the `.` of a class combination (`entity-entry\\.anchored`).
// A trailing `\.entity-entry\s*\{` cannot match `.entity-entry:hover` or `.entity-entry-name`, so the
// plain rule is always the one that comes back. Comments are dropped: they explain a rule, they are
// not part of it.
function ruleFor(selector) {
const rule = new RegExp(`\\.${selector}\\s*\\{([^}]*)\\}`).exec(source)?.[0];
return rule?.replace(/\/\*[\s\S]*?\*\//g, "");
}
function declaration(rule, property) {
return new RegExp(`${property}:\\s*([^;]*)`).exec(rule)?.[1].trim();
}
test("the sidebar list the entity entries live in is border-box sized", () => {
const wrap = ruleFor("sidebar-list-drop-wrap");
assert.ok(wrap, "expected a .sidebar-list-drop-wrap style rule");
// Its fixed width already includes the padding the entries sit in; the entries' 100% resolves
// against that padded content box.
assert.match(wrap, /box-sizing:\s*border-box/);
assert.match(wrap, /padding:/);
});
test("every section renders its entries inside the sidebar list", () => {
const list = /class="sidebar-list-drop-wrap"[\s\S]*?\n {12}<\/div>\n {8}<\/aside>/.exec(source);
assert.ok(list, "expected the sidebar list wrapper to be followed by the closing aside");
// actors, items and maps all use the same row
const rendered = list[0].match(/class="entity-entry"/g) || [];
assert.ok(rendered.length >= 3, `expected every section to render entity entries, found ${rendered.length}`);
});
test("an entity entry measures its padding and border inside the sidebar width", () => {
const entry = ruleFor("entity-entry");
assert.ok(entry, "expected a .entity-entry style rule");
const width = declaration(entry, "width");
const padding = declaration(entry, "padding");
const border = declaration(entry, "border");
assert.ok(width, "the entry must fill the sidebar list");
assert.ok(padding && border, "the entry has inner padding and a border to fit");
// These rows are divs and the app ships no global box-sizing reset, so with the default
// content-box the padding and the border were added on top of the 100% width and the box — border
// and all — overflowed the sidebar.
assert.equal(
declaration(entry, "box-sizing"),
"border-box",
"an entry sized at 100% with padding and a border needs box-sizing: border-box"
);
});
test("the hovered and anchored states keep the entry the same size", () => {
const entry = ruleFor("entity-entry");
// The resting border is transparent instead of `none`, so showing it on hover or when a map is
// anchored only recolours it and never grows the row.
assert.match(declaration(entry, "border"), /transparent/);
for (const selector of ["entity-entry:hover", "entity-entry\\.anchored"]) {
const rule = ruleFor(selector);
assert.ok(rule, `expected a .${selector} style rule`);
assert.doesNotMatch(rule, /border(-width)?\s*:\s*[^;]*\d+px/, `.${selector} must not widen the border`);
assert.match(rule, /border-color:/, `.${selector} is a state that shows the border`);
}
});
test("a long entry name wraps instead of pushing the entry out of the sidebar", () => {
const name = ruleFor("entity-entry-name");
assert.ok(name, "expected a .entity-entry-name style rule");
assert.match(name, /(word-break|overflow-wrap):/, "an unbreakable name has to wrap inside the entry");
});