Compare commits
14 Commits
ai/issue-2
...
ai/issue-3
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4355986bd1 | ||
| a6ad14a1b5 | |||
| b02ecca7d4 | |||
| 26c0a0b0a1 | |||
|
|
59a4c1dd0c | ||
| e3248ac4dc | |||
| 969e559c57 | |||
| ae7d64a09a | |||
|
|
9d93e6f79b | ||
| 0541d82a85 | |||
| 35252e0d13 | |||
| 8260c588ac | |||
|
|
b0acd689bb | ||
|
|
0a8452b3c8 |
31
.gitea/workflows/test.yml
Normal file
31
.gitea/workflows/test.yml
Normal 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
|
||||
693
AGENTS.md
693
AGENTS.md
@@ -1,589 +1,224 @@
|
||||
# AGENTS.md — Dragonroll
|
||||
|
||||
Read this file before touching the code. It is a complete map of the project: layout, architecture,
|
||||
data model, API, conventions and known landmines. You should not need to explore the rest of the repo
|
||||
to make a correct change.
|
||||
Orientation map, kept short on purpose. Read the file you are about to change: this tells you where to
|
||||
look and what will bite you, it does not replace the code. Longer docs: `dragonroll-foundry/README.md`,
|
||||
`discord-bot/README.md`, `obsidian-plugin/README.md`.
|
||||
|
||||
## 1. What this is
|
||||
|
||||
**Dragonroll** is a free/open-source helper for tabletop RPG campaigns (notes, campaigns, folders,
|
||||
dice widgets, shared markdown, sounds). It is a two-app monorepo:
|
||||
Free/open-source helper for tabletop RPG campaigns (campaigns, markdown notes, folders, characters,
|
||||
items, maps, dice widgets, sounds).
|
||||
|
||||
- `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.
|
||||
- `backend/` — Node + **Express 5** + **Mongoose 9** (MongoDB) REST API, JWT auth, CommonJS, entry `src/index.js`.
|
||||
- `frontend/` — **Nuxt 4 / Vue 3** (`<script setup>`), SCSS, axios, marked, mitt, motion, entry `app/app.vue`. No routed pages (§5.1).
|
||||
- `discord-bot/` — Discord bot (slash commands) that talks to the backend with a shared service secret, no login.
|
||||
- `dragonroll-foundry/` — Foundry VTT module (`scripts/api.js`) + optional read-only snapshot bridge.
|
||||
- `obsidian-plugin/` — plain JavaScript Obsidian plugin that imports/pushes campaign notes.
|
||||
- `tests/` — `npm test` (`node --test`, no dependencies installed): Foundry sync toggle and pairing status, map pins, sidebar entries.
|
||||
|
||||
There is **no** database seeding, no ORM migrations, no linter/formatter config, no Pinia/Vuex, and no
|
||||
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.
|
||||
No DB seeding, no migrations, no linter/formatter, no Pinia/Vuex. Git: default branch `master` on a
|
||||
self-hosted Gitea; `.gitea/workflows/deploy.yml` builds and deploys Docker images on push to `master`,
|
||||
`.gitea/workflows/test.yml` runs `npm test` on every branch.
|
||||
|
||||
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
|
||||
`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`.
|
||||
|
||||
## 2. Root layout
|
||||
|
||||
```
|
||||
dragonroll/
|
||||
├── backend/ Express API (CommonJS, entry: src/index.js)
|
||||
├── 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
|
||||
├── nginx.conf reverse proxy rules for the compose stack
|
||||
├── ecosystem.config.js PM2 config (stale: runs `npm start`, which does not exist — see §9)
|
||||
├── .gitea/workflows/deploy.yml
|
||||
├── static/media/ README logo images only
|
||||
├── tests/ `node --test` tests (Foundry module sync toggle)
|
||||
├── package.json root: only `concurrently`, used by `npm run dev`
|
||||
└── README.md install/run instructions are STALE (see §9)
|
||||
```
|
||||
|
||||
## 3. Commands
|
||||
## 2. Commands
|
||||
|
||||
```bash
|
||||
npm install # root: installs `concurrently` only
|
||||
npm install --prefix backend
|
||||
npm install --prefix frontend # runs `nuxt prepare` via postinstall
|
||||
|
||||
npm run dev # both apps: backend (nodemon, :5000) + frontend (nuxt dev, :3000)
|
||||
# also runs the Foundry VTT start script from root .env
|
||||
# (FOUNDRY_START_SCRIPT, via scripts/run-foundry.js)
|
||||
npm --prefix backend run dev # backend only
|
||||
npm --prefix frontend run dev # frontend only
|
||||
npm --prefix frontend run build # nuxt build --dotenv .env.production
|
||||
npm --prefix frontend run preview
|
||||
|
||||
npm test # node --test tests/ (Foundry module sync logic, no dependencies)
|
||||
npm install --prefix backend && npm install --prefix frontend # root `npm install` = concurrently only
|
||||
npm run dev # backend :5000 + frontend :3000 + discord-bot + scripts/run-foundry.js
|
||||
npm --prefix backend run dev # or --prefix frontend run dev | build | preview
|
||||
npm test
|
||||
```
|
||||
|
||||
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);
|
||||
`npm test` covers the Foundry character/item sync toggle and per-actor force sync.
|
||||
No `start` script in backend/frontend and no lint command. Verification = run the dev server and
|
||||
exercise the flow (`GET /api/test` returns a JSON hello).
|
||||
|
||||
### Environment files
|
||||
Env: `backend/.env` (`PORT` is read but ignored, `DB_URI`), `frontend/.env` (`NUXT_PUBLIC_API_BASE_URL`),
|
||||
both gitignored; the `.env.production` files are committed. `backend/src/index.js` loads `.env.$NODE_ENV`
|
||||
when `NODE_ENV` is set, otherwise `.env`. The server always listens on **5000**.
|
||||
|
||||
| File | Contents | Notes |
|
||||
|---|---|---|
|
||||
| `.env` (root) | `FOUNDRY_START_SCRIPT=<path to Foundry VTT start.sh>` | gitignored; consumed by `scripts/run-foundry.js` during `npm run dev` |
|
||||
| `backend/.env` | `PORT=5000`, `DB_URI=mongodb://localhost:27017/dragonroll`, `NODE_ENV=development` | gitignored |
|
||||
| `backend/.env.production` | same shape, `DB_URI=mongodb://192.168.1.7:27017/dragonroll` | **committed** |
|
||||
| `frontend/.env` | `NUXT_PUBLIC_API_BASE_URL=http://localhost:5000/api` | gitignored |
|
||||
| `frontend/.env.production` | `NUXT_PUBLIC_API_BASE_URL=https://dragonroll.aranroig.com/api` | **committed** |
|
||||
## 3. Backend
|
||||
|
||||
`backend/src/index.js` loads `.env.$NODE_ENV` when `NODE_ENV` is set, otherwise plain `.env`.
|
||||
`PORT` is read from env but **ignored**: the server always listens on 5000.
|
||||
`src/models/` one Mongoose schema per file · `src/routes/` thin Express routers · `src/services/`
|
||||
shared infra (`keys.js` JWT secret, `passport.js` JwtStrategy, `storage.js` multer → `src/uploads/`
|
||||
served publicly at `/api/public`, `rate-limiter.js` 150 req/60 min, `service-links.js` the service
|
||||
pairing in §4, `*-foundry.js` Foundry document → Dragonroll field mappers).
|
||||
|
||||
## 4. Backend
|
||||
**Auth chain, order matters** (`src/index.js`): `/api/public/*` static → `/api/user`, `/api/discord`,
|
||||
`/api/link`, `/api/foundry` (link + sync, token-authenticated) are mounted **before**
|
||||
`checkAuth = passport.authenticate('jwt', {session:false})`; everything after it
|
||||
(`/api/campaign|note|folder|actor|item|map|foundry`) is JWT-protected. `checkAuth` is assigned without
|
||||
`const` (implicit global). New user routes are public unless the handler calls
|
||||
`passport.authenticate('jwt', {session:false})` inline (`/upload-avatar`, `/update-settings`,
|
||||
`/get-settings`). JWT: payload `{_id, username, name, email, admin, settings}`, 48h; `req.user` is the
|
||||
Mongoose document, so routes use `req.user.id`.
|
||||
|
||||
```
|
||||
backend/src/
|
||||
├── index.js app bootstrap: dotenv, static uploads, json limits (50mb),
|
||||
│ passport init, CORS, route mounting, listen(5000)
|
||||
├── db.js connectDB() -> mongoose.connect(process.env.DB_URI)
|
||||
├── models/ User.js Campaign.js Note.js Folder.js Actor.js Item.js Map.js
|
||||
│ FoundryLinkRequest.js DiscordLinkRequest.js DiscordGuildLink.js
|
||||
├── routes/ user.js campaign.js note.js folder.js actor.js item.js map.js
|
||||
│ foundry-link.js (token sync, mounted BEFORE auth) foundry.js (bridge proxy)
|
||||
│ discord.js
|
||||
├── services/
|
||||
│ ├── keys.js { secret: "putyoursecrethere" } <- JWT secret, hardcoded
|
||||
│ ├── passport.js JwtStrategy: Bearer token -> User.findById(jwt_payload._id)
|
||||
│ ├── middleware.js isAdmin — imported by routes/user.js but applied to no route yet
|
||||
│ ├── rate-limiter.js express-rate-limit: 150 req / 60 min, applied to /user/login and /user/setup
|
||||
│ ├── storage.js multer diskStorage -> backend/src/uploads/, filename `<field>-<timestamp><ext>`
|
||||
│ ├── foundry.js requestFoundry(): reads the optional snapshot bridge
|
||||
│ ├── foundry-fields.js shared asText/numberOr/plainText/stringList for the mappers
|
||||
│ ├── actor-foundry.js foundryActorToCharacter(): Foundry actor document -> Actor fields
|
||||
│ └── item-foundry.js foundryItemToItemData(): Foundry item document -> Item fields
|
||||
└── uploads/ created on demand, gitignored, served PUBLICLY at /api/public
|
||||
```
|
||||
CORS allows any origin for the service link/sync paths only; the app-wide CORS whitelists
|
||||
`http://localhost:3000` and nothing else (production hides behind the nginx same-origin proxy).
|
||||
|
||||
### Auth chain (order matters, `src/index.js`)
|
||||
|
||||
1. `/api/public/*` → static file serving of `src/uploads` (no auth).
|
||||
2. `app.use('/api/user', routes/user)` → **mounted before the JWT guard**, so the whole user router is
|
||||
reachable unauthenticated. Individual handlers that need a user call
|
||||
`passport.authenticate('jwt', {session:false})` inline (`/upload-avatar`, `/update-settings`,
|
||||
`/get-settings`).
|
||||
3. `checkAuth = passport.authenticate('jwt', { session: false })` — note the **missing declaration**
|
||||
(implicit global). Everything mounted after this is JWT-protected.
|
||||
4. `/api/campaign`, `/api/note`, `/api/folder`, `/api/actor`, `/api/item` and `/api/foundry`
|
||||
(the read-only bridge proxy). `routes/foundry-link.js` is deliberately mounted **before** step 3 —
|
||||
it authenticates with the per-campaign sync token instead of a Dragonroll login (see §4.1).
|
||||
|
||||
JWT: signed in `POST /api/user/login` with payload `{ _id, username, name, email, admin, settings }`,
|
||||
`expiresIn: 172800` (48h). `req.user` is the Mongoose `User` document, so routes use `req.user.id`.
|
||||
|
||||
### Response convention
|
||||
|
||||
Every endpoint returns HTTP 200 with a JSON envelope; there is almost no real status-code usage:
|
||||
**Response envelope** — always HTTP 200, no real status codes:
|
||||
|
||||
```jsonc
|
||||
{ "status": "ok", ...payload }
|
||||
{ "status": "error", "msg": "errors.internal" } // msg is an i18n KEY, not prose
|
||||
```
|
||||
|
||||
Common `msg` keys: `errors.missing-data`, `errors.notfound`, `errors.internal`, `unauthorized`,
|
||||
`login.errors.invalid-credentials`, `register.errors.email-username-exists`. The frontend checks
|
||||
`response.data.status !== 'ok'`. `GET /user/has-admin` uses a special `status: "init"` to mean
|
||||
"no admin exists yet → show first-run registration".
|
||||
Common keys: `errors.missing-data`, `errors.notfound`, `errors.internal`, `unauthorized`,
|
||||
`login.errors.invalid-credentials`, `register.errors.email-username-exists`. `GET /user/has-admin`
|
||||
returns `status: 'init'` when no admin exists yet (→ first-run registration).
|
||||
|
||||
### Authorization model
|
||||
**Authorization** — single-tenant: a campaign belongs to `createdBy`, everything else hangs off a
|
||||
campaign, and handlers check ownership with a `userOwnsCampaign(campaignId, userId)` helper that is
|
||||
*duplicated per router file* (match that unless you refactor all at once). `settings`, `color`,
|
||||
`description` are free-form fields.
|
||||
|
||||
Single-tenant per user: a campaign belongs to `createdBy`, everything else hangs off a campaign.
|
||||
`note.js` and `folder.js` define a local helper:
|
||||
**Models** (`*` = required; notes and folders are always ordered `date: -1`):
|
||||
|
||||
```js
|
||||
async function userOwnsCampaign(campaignId, userId) { ... } // duplicated in both files
|
||||
```
|
||||
- `User` — `name*`, `username*`, `email*` (both unique), `password` (bcrypt, 10 rounds), `admin`, `image`, `setupCode`, `settings`
|
||||
- `Campaign` — `name*`, `createdBy*`→User, `description`, `color`, `settings`, `foundryWorldId`/`foundryWorldTitle`/`foundrySystem`, `foundrySyncTokenHash` (`select: false`), `discordGuildId`
|
||||
- `Note` — `title`, `content` (markdown source), `campaign*`, `folder` (null = root), `color`
|
||||
- `Folder` — `name*`, `campaign*`, `parentFolder` (null = root, self-ref), `color`
|
||||
- `Actor` — `name*`, `campaign*`, `foundryActorId` (unique per campaign), plus free-form sheet fields (`type`, `species`, `className`, `level`, `abilityScores`, `armorClass`, `speed`, `proficiencies`, `traits`, `spells`, `image`) and `inventory[{name,quantity,weight}]` (flattened Foundry items, **not** `Item` docs)
|
||||
- `Item` — `name*`, `campaign*`, `foundryItemId` (unique per campaign), `foundryNames`, `category`, `rarity`, `quantity`, `weight`, `properties`, `description`
|
||||
- `Map` — `name*`, `campaign*`, `image` (filename in `src/uploads`), `gridSize`/`offsetX`/`offsetY`/`scale` (image px), `pins[{note→Note, x, y}]` (addressed by the pin's own `_id`)
|
||||
- `ServiceLinkRequest` — the pending/completed service pairings of §4; `DiscordGuildLink` maps a Discord guild to the Dragonroll user who claimed it
|
||||
|
||||
Ownership is enforced per handler. `settings`, `color`, `description` and `User.settings` are schemaless
|
||||
`Object`/free-form fields.
|
||||
**API surface** (all under `/api`, all `{status,msg}`):
|
||||
|
||||
### Data model
|
||||
- `user` — `register`, `verify-setup?code=`, `setup?code=`, `login` (`{usermail,password}`, accepts username or email → `{token}`), `upload-avatar` (multipart `image`, JWT) / `retrieve-avatar?username=`, `has-admin`, `update-settings` / `get-settings`. Files fetched from `/api/public/<filename>`.
|
||||
- `campaign` — `create`, `update`, `list`, `retrieve/:id`, `services` + `service-unlink` (what is linked to a campaign)
|
||||
- `note` — `list?campaign=` (root notes + folders with `parentFolder`), `subfolder/list?campaign=&folder=`, `all?campaign=` (titles only, for the map pin picker), `retrieve/:id`, `create`, `update` (partial), `delete`
|
||||
- `folder` — `list`, `create`, `update`, `rename`, `delete` (recursive: inner notes go to `folder: null`, subfolders re-parent then delete)
|
||||
- `actor` — `list`, `create`, `update` (partial, ownership checked), `upload-image?actor=` (multipart), `delete`
|
||||
- `item` — `list`, `create`, `update` (partial), `delete`
|
||||
- `map` — `list`, `create` (multipart `image` or JSON), `update` (multipart to replace the photo), `delete`, `pin` (`{id,note,x,y}`, re-pinning moves the marker), `unpin` (`{id,pin}`)
|
||||
- `foundry` — read-only proxy over the bridge (`/world`, `/actors`, `/characters`, `/items`, `/actors/:id`, `/items/:id`, `/actors/:id/items`), needs `FOUNDRY_API_URL`
|
||||
|
||||
```
|
||||
User ──< Campaign ──< Note ──?> Folder ──?> Folder (parentFolder, self-ref)
|
||||
└───────< Folder
|
||||
└───────< Actor (Foundry actors, when linked)
|
||||
└───────< Item (Foundry gear + hand-made items)
|
||||
└───────< Map (uploaded images + their grid settings)
|
||||
```
|
||||
## 4. Service integrations (Foundry, Discord, Obsidian)
|
||||
|
||||
| Model | File | Fields |
|
||||
|---|---|---|
|
||||
| `User` | `models/User.js` | `name*`, `username*` (unique), `email*` (unique), `password` (bcrypt hash, 10 salt rounds), `date`, `admin` (bool, default false), `image`, `setupCode`, `settings` (Object) |
|
||||
| `Campaign` | `models/Campaign.js` | `name*`, `description`, `color`, `createdBy*` → User, `date`, `settings` (Object), `foundryWorldId` (unique, sparse), `foundryWorldTitle`, `foundrySystem`, `foundrySyncTokenHash` (`select: false`), `discordGuildId` |
|
||||
| `Note` | `models/Note.js` | `title`, `content` (markdown source string), `campaign*` → Campaign, `folder` → 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` |
|
||||
| `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), `pins[{note → Note, x, y}]` (a note pinned at image px coordinates, addressed by its own `_id`), `campaign*` → Campaign, `date` |
|
||||
Every external service links to a campaign the same way, **never with a Dragonroll login**: it calls
|
||||
`POST /api/link/start`, shows the returned sign-up link, and the user opens it in the frontend
|
||||
(`/link/authorize`, handled by `views/ServiceLinkAuthorize.vue` outside the window app), signs in and
|
||||
picks a campaign at `POST /api/link/complete`; the service then redeems its credential once at
|
||||
`POST /api/link/pickup` (one-time; losing it means a new link). Proofs differ per service
|
||||
(`services/service-links.js`): the Discord bot proves itself with the shared secret header, Foundry and
|
||||
Obsidian only hold their link code, so what a link grants is decided by the user. Codes are hashed at
|
||||
rest, expire after 10 min, and Obsidian gets a long-lived (365 d) token back.
|
||||
|
||||
`*` = required. Notes and folders are ordered by `date: -1` everywhere.
|
||||
Foundry then syncs with that token on `/api/foundry/sync/*` (`routes/foundry-link.js`, mounted before
|
||||
the JWT guard; CORS opened for it): `snapshot` (actors + world items, `fullSync` also prunes),
|
||||
`item-snapshot`, `item-delete`, `characters`, `items`, `status`, `map` / `map-item`, `delete`. Rules:
|
||||
|
||||
### API reference
|
||||
|
||||
`POST /api/user/register` — body `{username,email,name,password}`. First registered user becomes
|
||||
`admin: true`. (Currently broken: see §9.)
|
||||
|
||||
`GET /api/user/verify-setup?code=` — `{status:'ok',code}` | `{status:'error',msg:'not-exists'}`
|
||||
|
||||
`POST /api/user/setup?code=` — rate limited. Body `{name,username,email,password}` completes an
|
||||
invited account (`setupCode` is cleared).
|
||||
|
||||
`POST /api/user/login` — rate limited. Body `{usermail,password}` (accepts username **or** email) →
|
||||
`{status:'ok', token, msg:'success'}`.
|
||||
|
||||
`POST /api/user/upload-avatar` — multipart field `image`, JWT required → stores filename on `User.image`.
|
||||
Fetch the file from `/api/public/<filename>`.
|
||||
|
||||
`GET /api/user/retrieve-avatar?username=` → `{status:'ok', image}`
|
||||
|
||||
`GET /api/user/has-admin` → `status: 'ok' | 'init' | 'error'`
|
||||
|
||||
`POST /api/user/update-settings` — JWT inline. Body `{ settings: {...} }` (whole object replaced).
|
||||
`GET /api/user/get-settings` — JWT inline → `{status:'ok', settings}`
|
||||
|
||||
`POST /api/campaign/create` — `{name,description,color,settings}` → `{status:'ok',campaign}`
|
||||
`GET /api/campaign/list` → `{status:'ok',campaigns}`
|
||||
`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);
|
||||
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/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/update` — `{id*, title?, content?, folder?, color?}` — partial, ownership checked
|
||||
`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}`
|
||||
`POST /api/folder/create` — `{name*,campaign*}`
|
||||
`POST /api/folder/rename` — `{id*,name*}`
|
||||
`POST /api/folder/update` — `{id*, name?, color?}` — partial, ownership checked
|
||||
`POST /api/folder/delete` — `{id}` — recursive: notes inside are moved to root (`folder: null`),
|
||||
subfolders re-parented to null then deleted.
|
||||
|
||||
`GET /api/test` — health check.
|
||||
|
||||
`GET /api/actor/list?campaign=` → `{status:'ok',actors}`
|
||||
`POST /api/actor/create` — `{name*,campaign*,type?,species?,className?,subclass?,level?,background?,challengeRating?,description?}`
|
||||
`POST /api/actor/update` — `{id*, name?, species?, className?, subclass?, level?, abilityScores?, armorClass?, speed?, proficiencies?, inventory?, traits?, spells?, image?}` — partial, ownership checked
|
||||
`POST /api/actor/upload-image?actor=` — multipart field `image`
|
||||
`POST /api/actor/delete` — `{id}`
|
||||
|
||||
`GET /api/item/list?campaign=` → `{status:'ok',items}`
|
||||
`POST /api/item/create` — `{name*,campaign*,category?,rarity?,quantity?,weight?,properties?,description?}`
|
||||
`POST /api/item/update` — `{id*, name?, category?, rarity?, quantity?, weight?, properties?, description?}` — partial, ownership checked. `''` for `quantity`/`weight` is ignored, like `/item/create`.
|
||||
`POST /api/item/delete` — `{id}`
|
||||
|
||||
`GET /api/map/list?campaign=` → `{status:'ok',maps}`
|
||||
`POST /api/map/create` — multipart (`image`) or JSON `{name*,campaign*,gridSize?,offsetX?,offsetY?,scale?}` → `{status:'ok',map}`
|
||||
`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).
|
||||
`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)
|
||||
|
||||
`dragonroll-foundry/` holds the Foundry VTT module (`scripts/api.js`, loaded by `module.json`) and an
|
||||
optional read-only snapshot bridge (`bridge/server.js`). The module talks to Dragonroll with a
|
||||
per-campaign bearer token, **not** a Dragonroll login: `POST /api/foundry/link/complete` redeems a
|
||||
pairing code, stores its hash on `Campaign.foundrySyncTokenHash` and hands the plain token to Foundry
|
||||
once. Every sync route re-reads the campaign from that hash and rejects payloads whose `worldId` is
|
||||
not `Campaign.foundryWorldId` (`syncCampaign` / `requestMatchesWorld`). CORS is opened for
|
||||
`/api/foundry/sync*` and `/foundry/link/complete` in `src/index.js`, before the app-wide CORS.
|
||||
`dragonroll-foundry/README.md` documents pairing, the bridge and its environment variables.
|
||||
|
||||
| Sync route (token) | Meaning |
|
||||
|---|---|
|
||||
| `POST /sync/snapshot` | `{worldId, actors[], items[], fullSync}` — upserts actors, world items and every item embedded in those actors; a `fullSync` also deletes actors/items that are gone |
|
||||
| `POST /sync/item-snapshot` | `{worldId, items[]}` — live world-item edits, upsert only (never prunes) |
|
||||
| `POST /sync/item-delete` | `{worldId, foundryItemId}` — a world item was deleted |
|
||||
| `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/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/delete` | `{worldId, foundryActorId}` |
|
||||
|
||||
Rules worth knowing before editing this:
|
||||
|
||||
- **Identity** is `foundryActorId` / `foundryItemId` (unique per campaign, partial index so local
|
||||
documents can leave it unset). A document carrying the `dragonroll-foundry.actorId` /
|
||||
`dragonroll-foundry.itemId` flag adopts the matching Dragonroll row.
|
||||
- **Items are deduplicated by name.** Foundry keeps the same gear once per carrier, so one Dragonroll
|
||||
`Item` per name: the first document to claim it keeps the mapping, later copies just return it.
|
||||
`foundryNames` remembers Foundry's names so a Dragonroll rename does not resurrect a duplicate.
|
||||
`services/item-foundry.js` returns `null` for non-gear types (spells, classes, feats, species…),
|
||||
which the sync skips.
|
||||
- **`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.
|
||||
- **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`.
|
||||
- `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.
|
||||
- **Identity** is `foundryActorId` / `foundryItemId` (unique per campaign, partial index); a Foundry document carrying the `dragonroll-foundry.actorId` / `.itemId` flag adopts the matching Dragonroll row.
|
||||
- **Items are deduplicated by name** — Foundry keeps the same gear once per carrier, so one `Item` per name; `foundryNames` keeps Foundry's names so a Dragonroll rename does not resurrect a duplicate. `services/item-foundry.js` returns `null` for non-gear types and those are skipped.
|
||||
- **`fullSync` preserves Dragonroll edits** (only new rows are overwritten); live Foundry events overwrite. Only a full snapshot can prune.
|
||||
- **Autosync is a Foundry-side setting** (`autoSync`, on by default): off = no CRUD push, no periodic reconcile, no startup snapshot; the actor directory's *Dragonroll: Force Sync* still upserts the selection (`fullSync:false`).
|
||||
- `GET /api/foundry/*` (`routes/foundry.js`) is unrelated: a JWT-protected proxy over the read-only bridge.
|
||||
|
||||
## 5. Frontend
|
||||
|
||||
```
|
||||
frontend/
|
||||
├── nuxt.config.ts css order (colors, fonts, main, callouts), runtimeConfig.public
|
||||
│ {apiBaseUrl, gitCommit, gitTag, gitBranch, buildDate}, @nuxtjs/i18n module,
|
||||
│ vite.optimizeDeps; git info harvested at build time via execSync
|
||||
├── 18n.config.ts vue-i18n fallbackLocale 'en'
|
||||
├── i18n/locales/ en/ es/ ca/ (+ empty en.json, es.json, ca.json for the nuxt module)
|
||||
├── public/ img/ icons/{iconoir/{regular,solid},Pixelarticons,ui} sounds/ fonts/{5e,amiri,...}
|
||||
│ → served at /img, /icons, /sounds, /fonts
|
||||
└── app/ Nuxt 4 source root (`~/` and `@/` both alias here)
|
||||
├── app.vue real entry: theme setup + start() boot logic + 5 managers
|
||||
├── assets/css/ colors.scss (theme maps → CSS vars), fonts.scss (5e-style font families),
|
||||
│ main.scss (globals, scrollbars, .icon), callouts.scss (Obsidian-like callouts)
|
||||
├── components/
|
||||
│ ├── managers/ WindowManager, ContentManager, ToastManager, TooltipManager, ContextMenuManager
|
||||
│ ├── windows/ ExampleWindow (template to copy), Login, Register, MainMenu, Settings,
|
||||
│ │ CreateCampaign, RenameNote, NewFolder + partials/{WindowHandle,
|
||||
│ │ FixedBottomButtons, BigIconTemplate}
|
||||
│ ├── partials/ ContentSidebar, NestedNoteList, CampaignEntry, EditUserPartial, Spinner,
|
||||
│ │ VersionRender
|
||||
│ ├── layouts/ IconButton, Dropdown, Tabs, ColorPicker (reusable UI atoms)
|
||||
│ └── viewer/ TopBar, statusbar/{StatusBar,FetchStatus}, topbar/{TopSearchBar,SearchResult},
|
||||
│ content/{Content,NoteContainer,Note}, map/MapViewerPane, widgets/{TableWidget,TestWidget,
|
||||
│ inline/RollWidgetInline,display/RollWidgetDisplay}
|
||||
├── composables/ useTheme.ts (theme+accent singletons, localStorage, data-* attrs),
|
||||
│ useEmitter.ts (BROKEN, see §9)
|
||||
├── plugins/ api.ts (inject runtimeConfig apiBaseUrl into the axios instance), i18n.ts
|
||||
└── services/ plain ES modules holding reactive module state (the app has no store)
|
||||
```
|
||||
### 5.1 Not a routed app
|
||||
|
||||
### 5.1 It is not a routed app
|
||||
There is no `app/pages/`. `app/app.vue` renders a shell of managers (`Window`, `Content`, `Toast`,
|
||||
`Tooltip`, `ContextMenu`) and boots: `GetUser()` (JWT in localStorage) → `RestoreCampaign()` or open
|
||||
`main_menu`; no user → `HasAdmin() ? 'login' : 'register' {firstTime:true}`. The one real URL is
|
||||
`/link/authorize` (and the legacy `/discord/authorize`), which renders the service link screen instead
|
||||
of the app.
|
||||
|
||||
There is no `app/pages/`. `app/app.vue` renders a fixed shell of managers. "Screens" are either:
|
||||
Two kinds of screens: **windows** (floating draggable/resizable overlays) and **content** — the
|
||||
campaign workspace (`TopBar` + `ContentSidebar` + note column + `StatusBar`), turned on when
|
||||
`Campaign` becomes non-null. The note column shows the open notes, or the anchored map
|
||||
(`ActivePane` / `AnchoredMap` / `AnchorMap` in `services/Content.js`); `viewer/map/MapViewerPane.vue`
|
||||
renders it both there and in the detached `map_viewer` window. Right-clicking that map pins a campaign
|
||||
note at the spot (`services/MapPins.js` translates image px ↔ screen), clicking the marker opens
|
||||
`pinned_note`.
|
||||
|
||||
- **Windows** — floating, draggable/resizable overlays (login, main menu, settings…), or
|
||||
- **Content** — the campaign workspace (`TopBar` + `ContentSidebar` + note column + `StatusBar`),
|
||||
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`.
|
||||
### 5.2 The window system
|
||||
|
||||
Boot sequence (`app.vue` → `start()`):
|
||||
`services/WindowDefinitions.js` is the registry (`{ title: 'i18n.key', component: () => import(...), movable, close?, back? }`)
|
||||
and `services/Windows.js` the runtime: `CreateWindow(type, data)` (one instance per type),
|
||||
`CreateChildWindow(parentId, ...)`, `ClearWindow({type}|{id})`, `GetWindowWithId`, `GetFirstWindowId`,
|
||||
`CallWindow(id, fn, arg)`, `SetSize/SetPosition/ResetPosition(id,'center')/SetMinSize/SetMaxSize/Top`,
|
||||
`getComponent(type)`, `SetupHandle(id, handleRef)`. Adding a window = registry entry + component in
|
||||
`components/windows/`; copy `ExampleWindow.vue`: props `['data']` (merged window object, `props.data.id`),
|
||||
and in `onMounted` call `Top(wrapper)`, `SetupHandle(id, handle)`, `SetSize`, `ResetPosition`.
|
||||
|
||||
```
|
||||
GetUser() (JWT in localStorage, un-expired)?
|
||||
├─ yes → RestoreCampaign() (localStorage.selectedCampaignId) → on failure open 'main_menu'
|
||||
└─ no → HasAdmin() ? open 'login' : open 'register' {firstTime:true}
|
||||
```
|
||||
DOM ids these services depend on — **do not rename**: `window-wrapper-{id}`, `window-handle-{id}`,
|
||||
`window-resize-handle-{id}`, `context-menu`, `mouse-tooltip`.
|
||||
|
||||
### 5.2 The window system (most important thing to understand)
|
||||
### 5.3 Services are the state layer
|
||||
|
||||
`app/services/WindowDefinitions.js` is the **registry**: key = window type, value =
|
||||
`{ title: 'i18n.key', component: () => import('~/components/windows/X.vue'), movable, close?, back?, ... }`.
|
||||
Adding a window = add an entry here **and** a component in `app/components/windows/`.
|
||||
`app/services/` are plain ES modules with module-scope `ref()`s — no DI, no store, singleton by import.
|
||||
`Server.js` (axios factory: `Server().get(...)`, interceptor adds `Authorization: Bearer <localStorage.token>`,
|
||||
`initApi()` from `plugins/api.ts`), `User.js` (`GetUser/SetUser/LogoutUser/HasAdmin`, `GetUserSetting`/
|
||||
`SetUserSetting` server-backed in `User.settings`), `Campaign.js` (`useCampaignService()`, `SetCampaign`
|
||||
writes `localStorage.selectedCampaignId`, `RestoreCampaign`), `Content.js` (§5.1), `Emitter.js`
|
||||
(`mitt()` bus), `Toaster.js`, `Tooltip.js`, `ContextMenu.js`, `Sound.js` (`AddSound` binds
|
||||
`snap.wav` to `.sound-click`), `Marker.js` (marked + widgets), `ActionRegistry.js` (command palette:
|
||||
`register/unregister/search/execute`), `Windows.js` / `WindowDefinitions.js`, `MapPins.js`,
|
||||
`widgets/DiceParser.js`.
|
||||
|
||||
`app/services/Windows.js` is the runtime. Module-level state: `windows = ref([])`, auto-incrementing
|
||||
`currentId`, `currentIndex` z-index counter. Key exports:
|
||||
### 5.4 Markdown → widgets
|
||||
|
||||
`CreateWindow(type, data)` (one instance per type — duplicates are ignored),
|
||||
`CreateChildWindow(parentId, type, data)` (child dies with parent), `ClearWindow({type}|{id})`
|
||||
(recursive over `children`), `ClearAll()`, `GetWindowWithId(id)`, `GetFirstWindowId(type)`,
|
||||
`CallWindow(id, callableName, arg)`, `SetSize/SetPosition/SetMinSize/SetMaxSize/SetResizable/
|
||||
SetMovable/ResetPosition(id,'center')/SetOnTop/Top`, `getComponent(type)` (cached `defineAsyncComponent`),
|
||||
and `SetupHandle(id, handleRef)` which wires raw DOM mouse listeners for drag/resize.
|
||||
`Marker.js` turns `@name\n…\n@end` (block), `@name[text]` (inline) and `[[target]]` (wiki link) into
|
||||
placeholder divs/spans; `Note.vue` renders with `v-html` and then mounts each placeholder with its own
|
||||
`createApp(GetWidget(kind, name), {content})` (and unmounts them on re-render). So widgets are isolated
|
||||
mini-apps: they get only the `content` string and must not rely on the parent app's provides/injection.
|
||||
Register one in `widget_map` in `Marker.js`, component in `components/viewer/widgets/{inline,display}/`.
|
||||
`DiceParser.js` evaluates `\d*d\d+` with `adv|dis|kh<N>|kl<N>`, `+ - * / ( )`, unary minus, floor
|
||||
division, and returns `{total, steps[]}` that `RollWidgetDisplay.vue` draws.
|
||||
|
||||
Contract a window component must fulfil (copy `ExampleWindow.vue`):
|
||||
### 5.5 Event bus
|
||||
|
||||
```vue
|
||||
<script setup>
|
||||
import { SetupHandle, SetSize, ResetPosition, Top } from '@/services/Windows';
|
||||
import WindowHandle from './partials/WindowHandle.vue';
|
||||
const handle = ref(null), wrapper = ref(null);
|
||||
const props = defineProps(['data']); // 'data' = merged {type,id,...WindowDefinitions entry,...CreateWindow data}
|
||||
const id = props.data.id;
|
||||
onMounted(() => {
|
||||
Top(wrapper); SetupHandle(id, handle);
|
||||
SetSize(id, { width: 500, height: 380 }); ResetPosition(id, 'center');
|
||||
});
|
||||
</script>
|
||||
<template>
|
||||
<div class="window-wrapper" :id="'window-wrapper-' + id" ref="wrapper">
|
||||
<WindowHandle :window="id" ref="handle"></WindowHandle>
|
||||
<!-- body -->
|
||||
</div>
|
||||
</template>
|
||||
```
|
||||
Events in use: `toast`, `push-note`, `close-note` (removes from the open column only), `delete-note`
|
||||
(closes **and** removes from the sidebar, and drops map pins — the note's close button must not use it),
|
||||
`title-updated`, `campaign-entry-created` / `campaign-entry-updated`, `note-created`, `note-renamed`,
|
||||
`folder-saved`, `folder-deleted`, `status-bar-update`. Payloads are API documents; the UI note shape is
|
||||
`{key, title, text, date}`, mapped at the boundary as `ContentSidebar.fetchCampaignNotes` does. Always
|
||||
`import { emitter } from '~/services/Emitter'` — `composables/useEmitter.ts` is broken (§8).
|
||||
|
||||
DOM id conventions that `Windows.js`, `WindowHandle.vue` and drag/resize depend on — do not rename:
|
||||
`window-wrapper-{id}`, `window-handle-{id}`, `window-resize-handle-{id}`, `context-menu`, `mouse-tooltip`.
|
||||
### 5.6 Styling, i18n
|
||||
|
||||
`WindowHandle.vue` reads `title` (translated at mount via `$t`), `close` and `back` off the window
|
||||
object, exposes `setupHandle()`, and plays `/sounds/close.wav` when closed.
|
||||
`colors.scss` Sass maps (`dark`/`light`, accents `katlum`/`solus`/`silang`) become `--color-*` CSS
|
||||
variables: always style with `var(--color-…)`, never hardcode hex, and add a new key to **both** maps.
|
||||
`useTheme.ts` persists theme/accent and sets `data-theme`/`data-accent` on `<html>`; `app.vue` forces
|
||||
`setTheme('dark')`. Icons are white SVGs with `.icon` (inverted via `--color-icon-invert`), from
|
||||
`/icons/...` or the `pixelarticons` package. Fonts (`fonts.scss`, 5e-style families) and sounds
|
||||
(`/sounds/*.wav`) live in `public/`.
|
||||
|
||||
### 5.3 Services (`app/services/`) — the state layer
|
||||
|
||||
Plain modules with module-scope `ref()`s imported directly. No DI, no Pinia. Singleton by import.
|
||||
|
||||
| Service | Provides |
|
||||
|---|---|
|
||||
| `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`) |
|
||||
| `Campaign.js` | `useCampaignService()` → `Campaign` (`useState('campaign')`), `SetCampaign(data)` (also writes `localStorage.selectedCampaignId`), `RestoreCampaign()` |
|
||||
| `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 |
|
||||
| `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` |
|
||||
| `ContextMenu.js` | `SetupContextMenu()`, `AddContextMenu(el, items, {dropdown:true})`, `ShowContextMenu(items)`, `HideContextMenu()`. Items: `{name, icon?, action?, divider?}` or `{name, context:[...]}` for a submenu; built imperatively into `#context-menu` with `motion` animations |
|
||||
| `Sound.js` | `AddSound(rootEl)` binds `/sounds/snap.wav` to every `.sound-click` inside `rootEl` |
|
||||
| `Marker.js` | marked `Marked` instance + custom extensions, `ParseMarkdown(src)`, `GetWidget(kind,name)` (§5.4) |
|
||||
| `ActionRegistry.js` | `register({id,label,description,execute,isActive?})`, `unregister`, `search(q)` (diacritic-insensitive, prefix-first sort), `execute(id,params)` — powers the command palette |
|
||||
| `Windows.js` / `WindowDefinitions.js` | §5.2 |
|
||||
| `widgets/DiceParser.js` | recursive-descent dice evaluator (§5.5) |
|
||||
|
||||
### 5.4 Markdown → Vue widgets
|
||||
|
||||
`Marker.js` registers three marked extensions:
|
||||
|
||||
| Syntax | Level | Output |
|
||||
|---|---|---|
|
||||
| `@name\n<content>\n@end` | block | `<div class="vue-component-display" data-component data-content>` |
|
||||
| `@name[text]` | inline | `<span class="vue-component-inline" data-component data-content>` |
|
||||
| `[[target]]` | inline | `<span class="vue-link" data-href>` (renders the literal text `Link`) |
|
||||
|
||||
`Note.vue` renders the HTML with `v-html`, then in a `setTimeout(...,0)` calls `mountComponents()`,
|
||||
which `querySelectorAll('.vue-component-display'|'.vue-component-inline')` and mounts each node with a
|
||||
**separate** `createApp(GetWidget(kind, el.dataset.component), { content: el.dataset.content })`.
|
||||
Widgets are therefore isolated mini-apps: they receive only `content` (a string) and must not rely on
|
||||
the parent app's provides/injection.
|
||||
|
||||
Registering a widget = add an entry to `widget_map` in `Marker.js`:
|
||||
|
||||
```js
|
||||
const widget_map = {
|
||||
inline: { roll: () => import("~/components/viewer/widgets/inline/RollWidgetInline.vue") },
|
||||
display: { roll: () => import("~/components/viewer/widgets/display/RollWidgetDisplay.vue") },
|
||||
};
|
||||
```
|
||||
|
||||
`Note.vue` also: handles `Ctrl/Cmd+E` (toggle edit/preview, saves on exit) and `Ctrl/Cmd+S` (save via
|
||||
`POST /note/update`), tracks dirty state (white dot in the vertical title strip), and wires
|
||||
Obsidian-style collapsible callouts (`setupCallout()`/`toggleCallout()` + `callouts.scss`).
|
||||
|
||||
### 5.5 Dice grammar (`DiceParser.js`)
|
||||
|
||||
`parse(expr) -> { total, steps[] }`. Tokens: `\d*d\d+` with optional `adv|dis|kh<N>|kl<N>`, integers,
|
||||
`+ - * / ( )`, unary minus. `adv`/`dis` roll 2dN and keep max/min; `kh`/`kl` keep highest/lowest N.
|
||||
Division is `Math.floor`. Guards: count 1–1000, sides 2–10000. `steps` are `{type:'op'|'const'|'dice'}`
|
||||
and `RollWidgetDisplay.vue` turns them into the visual breakdown (kept/dropped/max/min classes).
|
||||
|
||||
### 5.6 Event bus contract
|
||||
|
||||
Every listener in the app (there are only these six `emitter.on` call sites):
|
||||
|
||||
| Event | Payload | Listened by |
|
||||
|---|---|---|
|
||||
| `toast` | `{color,text,duration}` | `ToastManager.vue` |
|
||||
| `push-note` | `{key,title,text,date}` | `NoteContainer.vue` |
|
||||
| `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), `MapViewerPane.vue` (drops the markers pinned to that note) |
|
||||
| `title-updated` | `{key,title}` | `Note.vue`, `NoteContainer.vue`, `MapViewerPane.vue` (relabels the map pins of that note) |
|
||||
| `status-bar-update` | `{text,icon}` | `FetchStatus.vue` |
|
||||
|
||||
Emitters: `Toaster.js` (`toast`), `ContentSidebar` / `TopSearchBar` (`push-note`), `Note.vue`
|
||||
(`close-note` — the close button must not use `delete-note` or the sidebar entry disappears),
|
||||
`NestedNoteList.vue` (`delete-note`, after `POST /note/delete`), `ContentSidebar` (`title-updated`),
|
||||
`FetchStatus` (self-test emit).
|
||||
|
||||
**Orphan events** — emitted, never subscribed to anywhere (the matching handlers `handleNoteCreated` /
|
||||
`handleNoteRenamed` exist in `ContentSidebar.vue` but were never wired with `emitter.on`; see §9.17):
|
||||
|
||||
| Event | Emitted by | Intended handler |
|
||||
|---|---|---|
|
||||
| `note-created` | `ContentSidebar.createNote`, `TopSearchBar` | `ContentSidebar.handleNoteCreated` (dead) |
|
||||
| `note-renamed` | `RenameNoteWindow.vue` | `ContentSidebar.handleNoteRenamed` (dead) |
|
||||
| `folder-saved` | `NewFolderWindow.vue` | none — sidebar refreshes only via `@reload-notes` from `NestedNoteList` |
|
||||
|
||||
So "create note" currently works because the sidebar mutates its own list, and folder changes need an
|
||||
explicit `fetchCampaignNotes()`. If you rely on an event, check a listener exists.
|
||||
|
||||
Note object shape in the UI layer is `{ key, title, text, date }` (mapped from the API's
|
||||
`{_id,title,content,date}`); convert at the boundary as `ContentSidebar.fetchCampaignNotes` does.
|
||||
|
||||
### 5.7 Theming, fonts, icons, sounds
|
||||
|
||||
- `useTheme.ts` owns `theme` (`'light'|'dark'`) and `accent` (`'katlum'`, type currently narrow) as
|
||||
module singletons, persists to `localStorage`, and sets `data-theme` / `data-accent` on `<html>`.
|
||||
`app.vue` calls `setupTheme()` then forces `setTheme('dark')` on mount.
|
||||
- `colors.scss` holds Sass maps `dark`/`light` (and accents `katlum`/`solus`/`silang`) emitted as
|
||||
**`--color-*` CSS variables**. Always style with `var(--color-...)` (`background`,
|
||||
`window-background`, `button-hover`, `text`, `border`, `icon-invert`, …), never hardcode hex.
|
||||
- Icons are inverted via `filter: invert(var(--color-icon-invert))` — white SVGs + `.icon` class.
|
||||
Reference either as public assets (`/icons/iconoir/regular/xmark.svg`, `/icons/ui/...`,
|
||||
`/icons/Pixelarticons/white/close.svg`) or from the `pixelarticons` npm package
|
||||
(`import SearchIcon from 'pixelarticons/svg/search.svg'`).
|
||||
- Fonts (`fonts.scss` + `public/fonts/5e`): `BookInsanityRemake` (body default), `MrEavesRemake`
|
||||
(headings/window titles), `ScalySansRemake`, `NodestoCapsCondensed`, `SolberaImitationRemake`, etc.
|
||||
- Sounds in `public/sounds/`: `snap.wav` (the `.sound-click` default), `close.wav`, `click.wav`,
|
||||
`dice.wav`, `roll1.wav`, `roll2.wav`, `notify.wav`, `drums.wav`, `lock.wav`, `doors/`.
|
||||
|
||||
### 5.8 i18n
|
||||
|
||||
Locales: `en` (default), `es`, `ca`. Files live at `frontend/i18n/locales/<lang>/<namespace>.json`, and
|
||||
`app/plugins/i18n.ts` globs them and nests each under its **filename** — so the key is
|
||||
`<file>.<path>`, e.g. `i18n/locales/en/main-menu.json` → `$t('main-menu.create-campaign')`.
|
||||
Namespaces in use: `general`, `login`, `register`, `main-menu`, `settings`, `windows`, `campaigns`
|
||||
(`campaigns` currently only exists for `en`). Call it as `$t(...)` in templates or via `useI18n()` in
|
||||
script; `WindowDefinitions` stores raw keys (`title: 'windows.login'`) and `WindowHandle` translates them.
|
||||
|
||||
**Adding a string = add it to all three locales** (`en`, `es`, `ca`); the Nuxt i18n module is also
|
||||
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.
|
||||
|
||||
### 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.
|
||||
i18n: `frontend/i18n/locales/<lang>/<namespace>.json` for `en` (default), `es`, `ca`; `plugins/i18n.ts`
|
||||
nests each file under its filename, so the key is `<file>.<path>` (`$t('windows.login')`). **Add every
|
||||
new string to all three locales.** Namespaces in use: `general`, `login`, `register`, `main-menu`,
|
||||
`settings`, `windows`, `campaigns`, `link`, `foundry`, `discord`.
|
||||
|
||||
## 6. Conventions
|
||||
|
||||
- **Backend**: CommonJS `require`/`module.exports`; files in `services/` are shared infra, `routes/`
|
||||
are thin Express routers, `models/` one Mongoose schema per file exporting `mongoose.model(...)`.
|
||||
Every handler is `try/catch` → `{status:'error', msg:'errors.internal'}` + `console.error`.
|
||||
Route logic helpers (like `userOwnsCampaign`) are duplicated per router file today — match that
|
||||
style unless you refactor both at once.
|
||||
- **Frontend**: Vue 3 `<script setup>`; PascalCase exported functions in `services/` (`CreateWindow`,
|
||||
`GetUser`), camelCase locals; PascalCase component filenames; `kebab-case` DOM ids that services
|
||||
depend on. Both `~/` and `@/` aliases appear in imports (both resolve to `app/`) — follow whatever
|
||||
the neighbouring file uses.
|
||||
- Components talk to the API through `Server()` directly (there is no api-layer abstraction); `await`
|
||||
or `.then` both appear.
|
||||
- Code comments are mixed English and Catalan ("Moure aixo", "Programar un resizer mitjanament
|
||||
competent") — do not "translate" unrelated comments while editing.
|
||||
- No formatter: keep diffs minimal and local; the codebase is deliberately rough.
|
||||
- Backend: CommonJS; every handler `try/catch` → `{status:'error', msg:'errors.internal'}` + `console.error`.
|
||||
- Frontend: Vue 3 `<script setup>`, PascalCase exported service functions (`CreateWindow`, `GetUser`), PascalCase component filenames, kebab-case DOM ids. Both `~/` and `@/` resolve to `app/` — use what the neighbouring file uses.
|
||||
- Components call `Server()` directly (no api layer); `await` and `.then` both appear.
|
||||
- Comments mix English and Catalan ("Moure aixo") — do not translate unrelated comments while editing.
|
||||
- No formatter: keep diffs minimal and local, the codebase is deliberately rough.
|
||||
|
||||
## 7. Recipes
|
||||
|
||||
**New API resource**: add `models/X.js`, `routes/x.js` (with `userOwnsCampaign`-style ownership checks
|
||||
and the `{status,msg}` envelope), then `app.use('/api/x', require('./routes/x'))` in `src/index.js`
|
||||
**after** the `checkAuth` line if it needs auth.
|
||||
- **New API resource**: `models/X.js` + `routes/x.js` (ownership check + `{status,msg}` envelope), then `app.use('/api/x', require('./routes/x'))` in `src/index.js` **after** `checkAuth` if it needs auth.
|
||||
- **New window**: `WindowDefinitions.js` entry + `components/windows/X.vue` (§5.2) + strings in `i18n/locales/*/windows.json` (all three locales).
|
||||
- **New widget**: component in `components/viewer/widgets/{inline,display}/` + `widget_map` entry in `Marker.js`.
|
||||
- **New palette action**: `register({id, label, description, execute, isActive?})` from `~/services/ActionRegistry` (palette: `Ctrl/Cmd+K` or `/`).
|
||||
- **New theme color**: key in *both* `dark` and `light` maps in `colors.scss`, then `var(--color-<key>)`.
|
||||
|
||||
**New window**: entry in `WindowDefinitions.js` → component in `app/components/windows/` following
|
||||
§5.2 → open with `CreateWindow('type', data)` or `CreateChildWindow(parentId, 'type', data)` → strings
|
||||
in `i18n/locales/*/windows.json`.
|
||||
## 8. Known landmines (verified in code — do not "fix" silently, never make them worse)
|
||||
|
||||
**New markdown widget**: component in `app/components/viewer/widgets/{inline|display}/`, register in
|
||||
`widget_map` in `Marker.js`, consume the `content` prop.
|
||||
1. `README.md` says run `./install.sh` / `./start.sh`; **neither exists**. `frontend/README.md` says the frontend is **React**; it is Nuxt/Vue.
|
||||
2. `services/keys.js` ships the JWT secret `"putyoursecrethere"`, used in production.
|
||||
3. `POST /api/user/register` responds `{status:'ok', code: setupCode}` but `setupCode` is not in scope → caught → the first-run registration actually returns `errors.internal`. The register UI (`RegisterWindow.vue`) drives that flow; fix carefully.
|
||||
4. `POST /api/note/delete` has **no ownership check** (any authenticated user can delete any note id); the other `note.js` handlers and `folder.js` do check.
|
||||
5. `/api/user/*` is mounted before the JWT guard: new routes there are public unless they authenticate inline (`/api/discord` is also before it, but every route there is gated by `requireBot`, the shared bot-secret header). `services/middleware.js`'s `isAdmin` is imported but applied to no route.
|
||||
6. `composables/useEmitter.ts` reads `$emitter` from `useNuxtApp()` and no plugin provides it — use `~/services/Emitter`.
|
||||
7. App-wide CORS only whitelists `http://localhost:3000`; `.env.production` files are committed with internal hosts; `ecosystem.config.js` runs `npm start`, which backend/frontend do not define (PM2 is dead, compose + nginx is the real deploy).
|
||||
8. `Windows.js`: `getComponent` caches `defineAsyncComponent` per type for the whole process (restart the dev server if a new window misbehaves), `SetupHandle` attaches `document` mouse listeners per window and never removes them, and `ClearAll()` iterates `Object.keys(windows)` instead of `windows.value`.
|
||||
9. The frontend treats the JWT as the user cache: `settings` changes need `GetUserSetting`/`SetUserSetting` round-trips, the token payload goes stale.
|
||||
|
||||
**New command-palette action**: `register({id,label,description,execute,isActive?})` from
|
||||
`~/services/ActionRegistry` (see `registerCreateNoteAction` in `TopSearchBar.vue`); palette opens with
|
||||
`Ctrl/Cmd+K` or `/`.
|
||||
## 9. Ports
|
||||
|
||||
**New theme color**: add the key to *both* `dark` and `light` maps in `colors.scss`, use
|
||||
`var(--color-<key>)`.
|
||||
|
||||
## 8. Port map
|
||||
|
||||
`frontend dev :3000` · `backend :5000` (hardcoded) · MongoDB `:27017` · nginx `:3000 → 80` inside
|
||||
compose, proxying `/` → `frontend:3000`, `/api/` → `backend:5000`.
|
||||
|
||||
## 9. Known landmines (verified in code — do not "fix" silently, but never make them worse)
|
||||
|
||||
1. `README.md` tells you to run `./install.sh` and `./start.sh`; **neither script exists** in the repo.
|
||||
2. `frontend/README.md` says the frontend is **React**. It is Nuxt/Vue 3.
|
||||
3. `services/keys.js` ships a hardcoded JWT secret `"putyoursecrethere"`, used in prod.
|
||||
4. `src/index.js` sets CORS `origin: 'http://localhost:3000'` only — the production origin
|
||||
(`https://dragonroll.aranroig.com`) is not whitelisted; in production the nginx same-origin proxy
|
||||
is what hides this.
|
||||
5. `POST /api/user/register` responds `{status:'ok', code: setupCode}` but `setupCode` is not defined
|
||||
in that scope → ReferenceError → caught → the first-run registration actually returns
|
||||
`errors.internal`. Fix carefully: the register UI (`RegisterWindow.vue`) drives the first-admin flow.
|
||||
6. `POST /api/note/delete` has **no ownership check** (any authenticated user can delete any note id).
|
||||
`folder.js` and the other `note.js` handlers do check.
|
||||
7. `composables/useEmitter.ts` reads `$emitter` from `useNuxtApp()`, but **no plugin provides it** —
|
||||
always import `{ emitter }` from `~/services/Emitter` instead.
|
||||
8. `ecosystem.config.js` runs `npm start` in both apps; neither package defines a `start` script → PM2
|
||||
would fail. Compose/nginx is the real deployment path.
|
||||
9. `/api/user/*` is entirely mounted before the JWT guard (see §4); new user routes are public unless
|
||||
they call `passport.authenticate('jwt', {session:false})` inline.
|
||||
10. `checkAuth` in `src/index.js` is assigned without `const` (implicit global).
|
||||
11. `ClearAll()` in `Windows.js` iterates `Object.keys(windows)` (the ref object, not `.value`) — it
|
||||
does not behave like the name suggests.
|
||||
12. `GetWidget`/`getComponent` caches are process-global and never invalidated; new widget/window types
|
||||
need a dev-server restart if HMR misbehaves.
|
||||
13. `Windows.js` `SetupHandle` attaches `mousemove`/`mouseup` listeners on `document` for **every**
|
||||
window and never removes them; they early-return on `win.movable` but still accumulate.
|
||||
14. `Note.vue` mounts widgets with `createApp` and never unmounts them — leaked apps remain when note
|
||||
content is re-rendered.
|
||||
15. `User.js` (frontend) treats the JWT as the user cache: `settings` changes require
|
||||
`SetUserSetting`/`GetUserSetting` round-trips, the token payload goes stale.
|
||||
16. `.env.production` files (both apps) are committed and contain internal hosts.
|
||||
17. `note-created`, `note-renamed` and `folder-saved` are emitted with **no subscribers**; the sidebar's
|
||||
`handleNoteCreated` / `handleNoteRenamed` are unwired dead code (§5.6). The sidebar refreshes its
|
||||
tree only on `campaignId` change, on mount, on the manual refresh button, or on `@reload-notes`
|
||||
from `NestedNoteList.vue`.
|
||||
18. `SetShowContent` (`services/Content.js`) and `services/middleware.js`'s `isAdmin` are exported /
|
||||
imported but never used; `ContentManager.vue` never hides the workspace again once shown.
|
||||
`frontend dev :3000` · `backend :5000` (hardcoded) · MongoDB `:27017` · nginx `:3000 → 80` in compose,
|
||||
proxying `/` → frontend, `/api/` → backend.
|
||||
|
||||
@@ -40,32 +40,40 @@ require('./services/passport')(passport);
|
||||
// CORS
|
||||
app.use(cookieParser());
|
||||
|
||||
const foundryCorsPaths = [
|
||||
'/api/foundry/link/complete', '/foundry/link/complete',
|
||||
// Services talk to Dragonroll from their own application (a Foundry world, an
|
||||
// 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/link/start', '/link/start',
|
||||
'/api/link/pickup', '/link/pickup',
|
||||
];
|
||||
const foundryCors = cors({
|
||||
const openCors = cors({
|
||||
origin: true,
|
||||
methods: ['GET', 'POST', 'OPTIONS'],
|
||||
allowedHeaders: ['Authorization', 'Content-Type'],
|
||||
allowedHeaders: ['Authorization', 'Content-Type', 'X-Dragonroll-Discord-Bot-Secret'],
|
||||
});
|
||||
app.use('/api/foundry/link/complete', foundryCors);
|
||||
app.use('/foundry/link/complete', foundryCors);
|
||||
app.use('/api/foundry/sync', foundryCors);
|
||||
app.use('/foundry/sync', foundryCors);
|
||||
for (const path of openCorsPaths) {
|
||||
app.use(path, openCors);
|
||||
}
|
||||
|
||||
const appCors = cors({
|
||||
origin: 'http://localhost:3000',
|
||||
credentials: true, // if using cookies/auth
|
||||
});
|
||||
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);
|
||||
});
|
||||
|
||||
// ROUTES (NO AUTH)
|
||||
app.use('/api/user', require('./routes/user'));
|
||||
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('/foundry', require('./routes/foundry-link'));
|
||||
|
||||
|
||||
@@ -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);
|
||||
@@ -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);
|
||||
44
backend/src/models/ServiceLinkRequest.js
Normal file
44
backend/src/models/ServiceLinkRequest.js
Normal 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);
|
||||
@@ -1,24 +1,28 @@
|
||||
const express = require('express')
|
||||
const router = express.Router();
|
||||
const crypto = require('node:crypto');
|
||||
|
||||
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) {
|
||||
return crypto.createHash('sha256').update(String(code ?? '').trim()).digest('hex');
|
||||
}
|
||||
|
||||
async function expirePendingFoundryLinks(campaignId, userId) {
|
||||
const filter = {
|
||||
source: 'dragonroll',
|
||||
campaign: campaignId,
|
||||
createdBy: userId,
|
||||
completedAt: null
|
||||
};
|
||||
await FoundryLinkRequest.updateMany(filter, { $set: { expiresAt: new Date() } });
|
||||
await campaign.save();
|
||||
// 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);
|
||||
}
|
||||
|
||||
router.post('/create', async (req, res) => {
|
||||
@@ -74,73 +78,26 @@ router.post('/update', async (req, res) => {
|
||||
}
|
||||
});
|
||||
|
||||
router.post('/foundry-link/start', async (req, res) => {
|
||||
try {
|
||||
const campaign = await Campaign.findOne({ _id: req.body.campaignId, createdBy: req.user.id });
|
||||
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) => {
|
||||
// Which services a campaign has connected, and the account each of them was
|
||||
// authorized with.
|
||||
router.get('/services', async (req, res) => {
|
||||
try {
|
||||
const campaign = await Campaign.findOne({ _id: req.query.campaignId, createdBy: req.user.id });
|
||||
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||
|
||||
const request = await FoundryLinkRequest.findOne({
|
||||
source: 'dragonroll',
|
||||
campaign: campaign._id,
|
||||
createdBy: req.user.id,
|
||||
completedAt: null,
|
||||
expiresAt: { $gt: new Date() }
|
||||
}).sort({ createdAt: -1 });
|
||||
if (!request) return res.json({ status: 'ok', request: null });
|
||||
const links = await serviceLinks.listLinkedServices(campaign._id);
|
||||
const userIds = [...new Set(links.map((link) => String(link.dragonrollUser ?? '')).filter(Boolean))];
|
||||
const users = userIds.length
|
||||
? await User.find({ _id: { $in: userIds } }).select('username name').lean()
|
||||
: [];
|
||||
const names = new Map(users.map((user) => [String(user._id), user.username || user.name]));
|
||||
|
||||
res.set('Cache-Control', 'no-store');
|
||||
res.json({
|
||||
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) {
|
||||
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 {
|
||||
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 });
|
||||
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||
|
||||
campaign.foundryWorldId = undefined;
|
||||
campaign.foundryWorldTitle = undefined;
|
||||
campaign.foundrySystem = undefined;
|
||||
campaign.set('foundrySyncTokenHash', undefined);
|
||||
await campaign.save();
|
||||
await expirePendingFoundryLinks(campaign._id, req.user.id);
|
||||
res.json({ status: 'ok', campaign });
|
||||
await unlinkService(campaign, service);
|
||||
res.json({ status: 'ok', campaign, services: await serviceLinks.listLinkedServices(campaign._id) });
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
res.json({ status: 'error', msg: 'errors.internal' });
|
||||
|
||||
@@ -1,124 +1,25 @@
|
||||
const crypto = require('node:crypto');
|
||||
const express = require('express');
|
||||
const passport = require('passport');
|
||||
const router = express.Router();
|
||||
|
||||
const Actor = require('../models/Actor');
|
||||
const Campaign = require('../models/Campaign');
|
||||
const DiscordGuildLink = require('../models/DiscordGuildLink');
|
||||
const DiscordLinkRequest = require('../models/DiscordLinkRequest');
|
||||
const ServiceLinkRequest = require('../models/ServiceLinkRequest');
|
||||
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 requireBot = serviceLinks.requireDiscordBot;
|
||||
|
||||
function validGuildId(value) {
|
||||
return /^\d{5,25}$/.test(String(value ?? ''));
|
||||
}
|
||||
|
||||
function codeHash(code) {
|
||||
return crypto.createHash('sha256').update(String(code ?? '')).digest('hex');
|
||||
}
|
||||
|
||||
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' });
|
||||
}
|
||||
});
|
||||
// Connecting a Discord server is the service link of issue: the bot asks
|
||||
// /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.
|
||||
|
||||
async function dragonrollUserNames(requests) {
|
||||
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.
|
||||
router.post('/bot/link-requests/notifications', requireBot, async (req, res) => {
|
||||
try {
|
||||
const pending = await DiscordLinkRequest.find({
|
||||
completedAt: { $gte: new Date(Date.now() - NOTIFICATION_WINDOW_MS) },
|
||||
const pending = await ServiceLinkRequest.find({
|
||||
service: 'discord',
|
||||
state: 'linked',
|
||||
linkedAt: { $gte: new Date(Date.now() - serviceLinks.NOTIFICATION_WINDOW_MS) },
|
||||
notifiedAt: null
|
||||
}).select('_id guildId guildName discordUserId discordUserName dragonrollUser')
|
||||
}).select('_id targetId targetName targetUser targetMeta dragonrollUser campaign')
|
||||
.limit(NOTIFICATION_LIMIT)
|
||||
.lean();
|
||||
|
||||
const claimed = [];
|
||||
for (const request of pending) {
|
||||
const taken = await DiscordLinkRequest.findOneAndUpdate(
|
||||
const taken = await ServiceLinkRequest.findOneAndUpdate(
|
||||
{ _id: request._id, notifiedAt: null },
|
||||
{ $set: { notifiedAt: new Date() } },
|
||||
{ new: true }
|
||||
@@ -150,15 +53,22 @@ router.post('/bot/link-requests/notifications', requireBot, async (req, res) =>
|
||||
}
|
||||
|
||||
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({
|
||||
status: 'ok',
|
||||
notifications: claimed.map((request) => ({
|
||||
id: String(request._id),
|
||||
guildId: request.guildId,
|
||||
guildName: request.guildName,
|
||||
discordUserId: request.discordUserId,
|
||||
discordUserName: request.discordUserName,
|
||||
dragonrollUserName: names.get(String(request.dragonrollUser ?? '')) || null
|
||||
guildId: request.targetId,
|
||||
guildName: request.targetName,
|
||||
discordUserId: request.targetMeta?.userId || '',
|
||||
discordUserName: request.targetUser,
|
||||
dragonrollUserName: names.get(String(request.dragonrollUser ?? '')) || null,
|
||||
campaignName: campaignNames.get(String(request.campaign ?? '')) || null
|
||||
}))
|
||||
});
|
||||
} catch (err) {
|
||||
|
||||
@@ -1,18 +1,14 @@
|
||||
const crypto = require('node:crypto');
|
||||
const express = require('express');
|
||||
const rateLimit = require('express-rate-limit');
|
||||
const mongoose = require('mongoose');
|
||||
const router = express.Router();
|
||||
|
||||
const Campaign = require('../models/Campaign');
|
||||
const Actor = require('../models/Actor');
|
||||
const Item = require('../models/Item');
|
||||
const FoundryLinkRequest = require('../models/FoundryLinkRequest');
|
||||
const { foundryActorToCharacter } = require('../services/actor-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).
|
||||
const MAX_FOUNDRY_NAMES = 20;
|
||||
|
||||
@@ -129,113 +125,9 @@ async function syncFoundryItems(campaign, sources, fullSync = false) {
|
||||
return items;
|
||||
}
|
||||
|
||||
function readWorld(body) {
|
||||
const world = body?.world;
|
||||
if (!world || typeof world.id !== 'string' || !world.id.trim()) return null;
|
||||
|
||||
let foundryUrl = '';
|
||||
if (typeof world.url === 'string') {
|
||||
try {
|
||||
const url = new URL(world.url);
|
||||
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 {
|
||||
const world = readWorld(req.body);
|
||||
if (!world || typeof req.body.code !== 'string' || !req.body.code.trim()) {
|
||||
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.json({
|
||||
status: 'ok',
|
||||
campaign: { id: campaign.id, name: campaign.name },
|
||||
world: { id: world.worldId, title: world.worldTitle, system: world.system },
|
||||
syncToken,
|
||||
bridgeConfig: bridgeUrl && pushToken ? { url: bridgeUrl, pushToken } : null
|
||||
});
|
||||
} 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' });
|
||||
}
|
||||
});
|
||||
// Linking a world to a campaign happens through the sign-up link every service
|
||||
// uses (routes/service-link.js); what stays here is the sync that world keeps up
|
||||
// with the campaign once that link has handed it its token.
|
||||
|
||||
// The Foundry module shows this in its settings: the sync token alone only proves
|
||||
// a link was made once, so the module asks which campaign it belongs to and hears
|
||||
|
||||
209
backend/src/routes/service-link.js
Normal file
209
backend/src/routes/service-link.js
Normal 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;
|
||||
254
backend/src/services/service-links.js
Normal file
254
backend/src/services/service-links.js
Normal 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
|
||||
};
|
||||
@@ -47,11 +47,23 @@ function createDragonrollApi(config) {
|
||||
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) {
|
||||
return request('/discord/link/start', {
|
||||
const payload = await request('/link/start', {
|
||||
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() {
|
||||
|
||||
@@ -4,25 +4,24 @@ const SETTING_PUSH_TOKEN = "pushToken";
|
||||
const SETTING_BRIDGE_CONFIG = "bridgeConfig";
|
||||
const SETTING_DRAGONROLL_API_URL = "dragonrollApiUrl";
|
||||
const SETTING_LINK_CODE = "linkCode";
|
||||
const SETTING_LINK_URL = "linkUrl";
|
||||
const SETTING_PAIRING_STATUS = "pairingStatus";
|
||||
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 syncInProgress = false;
|
||||
let syncRequested = false;
|
||||
let handlingLinkCode = false;
|
||||
let updatingLinkCodeSetting = false;
|
||||
let linkRetriesDisabled = false;
|
||||
const FATAL_LINK_ERRORS = new Set([
|
||||
"foundry.errors.link-expired",
|
||||
"foundry.errors.world-already-linked",
|
||||
]);
|
||||
let askingForLink = false;
|
||||
let checkingLink = false;
|
||||
let updatingLinkSetting = false;
|
||||
// Marks a pairing Dragonroll honoured once and no longer accepts: the campaign
|
||||
// unlinked this world, so the token this client holds is dead.
|
||||
const PAIRING_REVOKED = "revoked";
|
||||
let updatingPairingStatus = false;
|
||||
let linkedCampaignName = "";
|
||||
let pairingProblem = "";
|
||||
let linkProblem = "";
|
||||
let actorSyncTimeout;
|
||||
let characterSyncRunning = false;
|
||||
let actorSyncErrorLogged = false;
|
||||
@@ -138,18 +137,24 @@ Hooks.once("init", () => {
|
||||
});
|
||||
|
||||
game.settings.register(MODULE_ID, SETTING_LINK_CODE, {
|
||||
name: "Dragonroll Campaign Pairing Code",
|
||||
hint: "Paste a pairing code created in Dragonroll campaign settings.",
|
||||
name: "Dragonroll Connection Link Code",
|
||||
scope: "client",
|
||||
config: true,
|
||||
config: false,
|
||||
type: String,
|
||||
default: "",
|
||||
});
|
||||
|
||||
game.settings.register(MODULE_ID, SETTING_LINK_URL, {
|
||||
name: "Dragonroll Connection Link",
|
||||
scope: "client",
|
||||
config: false,
|
||||
type: String,
|
||||
default: "",
|
||||
onChange: handleLinkCodeChange,
|
||||
});
|
||||
|
||||
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 and the pairing lives in the browser of whoever linked the world: there is nothing to set here.",
|
||||
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",
|
||||
config: true,
|
||||
type: String,
|
||||
@@ -218,39 +223,54 @@ async function getDragonroll(path, token) {
|
||||
return result;
|
||||
}
|
||||
|
||||
function linkErrorMessage(error) {
|
||||
const messages = {
|
||||
"foundry.errors.link-expired": "The pairing code is invalid, expired, or already used.",
|
||||
"foundry.errors.world-already-linked": "This Foundry world is already linked to another campaign.",
|
||||
// --- Connecting a world ----------------------------------------------------
|
||||
// A world does not paste a code into its settings any more: it asks Dragonroll
|
||||
// for the same sign-up link every service gets, the GM opens it and picks the
|
||||
// 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) {
|
||||
updatingLinkCodeSetting = true;
|
||||
async function setLink(code, url) {
|
||||
updatingLinkSetting = true;
|
||||
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 {
|
||||
updatingLinkCodeSetting = false;
|
||||
updatingLinkSetting = false;
|
||||
}
|
||||
}
|
||||
|
||||
function handleLinkCodeChange(value) {
|
||||
if (updatingLinkCodeSetting || handlingLinkCode || !value?.trim()) return;
|
||||
linkRetriesDisabled = false;
|
||||
// A code typed by hand supersedes whatever went wrong with the last one.
|
||||
pairingProblem = "";
|
||||
setPairingStatus(pairingStatusText());
|
||||
completeDragonrollCampaignLink(value.trim());
|
||||
async function requestDragonrollLink() {
|
||||
if (askingForLink || !game.user?.isGM || !game.world) return;
|
||||
askingForLink = true;
|
||||
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 = {}) {
|
||||
if (handlingLinkCode) return;
|
||||
handlingLinkCode = true;
|
||||
const notifyOnError = options.notifyOnError !== false;
|
||||
try {
|
||||
if (!game.user?.isGM || !game.world) throw new Error("Open the world as a GM to link it.");
|
||||
const result = await postDragonroll("foundry/link/complete", { code, world: api.getWorld() });
|
||||
// What a link leaves this client with once a campaign has been picked: the token
|
||||
// its sync runs on, and the bridge settings that came with it.
|
||||
async function applyDragonrollLink(result) {
|
||||
let syncTokenStored = false;
|
||||
if (result.syncToken) {
|
||||
try {
|
||||
@@ -265,43 +285,51 @@ async function completeDragonrollCampaignLink(code, options = {}) {
|
||||
await game.settings.set(MODULE_ID, SETTING_BRIDGE_CONFIG, result.bridgeConfig);
|
||||
} catch (error) {
|
||||
console.error(`${MODULE_ID} | Could not save the bridge configuration.`, error);
|
||||
ui.notifications?.warn("The world was linked, but its bridge settings could not be saved on this client.");
|
||||
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);
|
||||
setTimeout(initializeCharacterSync, 0);
|
||||
setTimeout(reconcileDragonrollItems, 2000);
|
||||
linkedCampaignName = String(result.campaign?.name || "").trim();
|
||||
ui.notifications?.info("This Foundry world is now linked to the Dragonroll campaign.");
|
||||
await setPairingStatus(pairingStatusText());
|
||||
} catch (error) {
|
||||
console.error(`${MODULE_ID} | Could not complete the campaign link.`, error);
|
||||
// Expired or already-used codes will never redeem, so stop the background
|
||||
// retry; any error keeps retrying (the Dragonroll server may be restarting).
|
||||
linkRetriesDisabled = FATAL_LINK_ERRORS.has(error.message);
|
||||
// Only a code that can never be redeemed belongs in the status: while the
|
||||
// retry is still running, waiting for Dragonroll is the honest text.
|
||||
if (linkRetriesDisabled) pairingProblem = linkErrorMessage(error);
|
||||
if (notifyOnError) ui.notifications?.error(linkErrorMessage(error));
|
||||
await setPairingStatus(pairingStatusText());
|
||||
} finally {
|
||||
handlingLinkCode = false;
|
||||
} else {
|
||||
// Without a token this client cannot sync, and only a fresh link gives one.
|
||||
linkProblem = "this client could not save the token it was given";
|
||||
ui.notifications?.warn("This world is linked to a Dragonroll campaign, but character sync is unavailable. Update Dragonroll and link the world again.");
|
||||
}
|
||||
}
|
||||
|
||||
// A pairing code entered while the Dragonroll server was unreachable (or just
|
||||
// before Foundry restarted) stays in the setting; redeem it on world start so
|
||||
// the connection survives restarts without typing the code in again.
|
||||
async function resumePendingDragonrollLink(options = {}) {
|
||||
if (handlingLinkCode || !game.user?.isGM || !game.world) return;
|
||||
// Where the sign-up link stands: still waiting for the GM to pick a campaign,
|
||||
// finished and handing its token over, or gone, in which case there is a new
|
||||
// link to show instead of a world that quietly stops trying.
|
||||
async function advanceDragonrollLink() {
|
||||
if (askingForLink || checkingLink || !game.user?.isGM || !game.world || getSyncToken()) return;
|
||||
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 --------------------------------------------------------
|
||||
@@ -310,19 +338,22 @@ async function resumePendingDragonrollLink(options = {}) {
|
||||
// reads correctly from the first frame and is corrected by refreshPairingStatus.
|
||||
|
||||
function pairingStatusText() {
|
||||
if (pairingProblem === PAIRING_REVOKED) {
|
||||
return "Not connected: this world is no longer linked to the Dragonroll campaign it was paired with. Create a new pairing code there to link it again.";
|
||||
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 (pairingProblem) return `Not connected: Dragonroll did not accept that pairing code (${pairingProblem})`;
|
||||
if (game.settings.get(MODULE_ID, SETTING_LINK_CODE)?.trim()) {
|
||||
return "Not connected yet: waiting for Dragonroll to accept this pairing code.";
|
||||
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. Paste a pairing code from that campaign's settings to link 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) {
|
||||
@@ -357,12 +388,19 @@ async function refreshPairingStatus() {
|
||||
try {
|
||||
const result = await getDragonroll("foundry/sync/status", token);
|
||||
linkedCampaignName = String(result.campaign?.name || "").trim();
|
||||
if (pairingProblem === PAIRING_REVOKED) pairingProblem = "";
|
||||
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") pairingProblem = PAIRING_REVOKED;
|
||||
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());
|
||||
}
|
||||
@@ -1140,11 +1178,13 @@ async function publishHeartbeat() {
|
||||
}
|
||||
|
||||
Hooks.once("ready", () => {
|
||||
resumePendingDragonrollLink().then(refreshPairingStatus);
|
||||
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(() => {
|
||||
if (linkRetriesDisabled) return;
|
||||
resumePendingDragonrollLink({ notifyOnError: false });
|
||||
}, 60000);
|
||||
if (getSyncToken()) return;
|
||||
advanceDragonrollLink();
|
||||
}, LINK_POLL_MS);
|
||||
setInterval(refreshPairingStatus, 60000);
|
||||
scheduleSnapshotSync(0);
|
||||
setInterval(publishHeartbeat, 60000);
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
import ContentManager from './components/managers/ContentManager.vue';
|
||||
import ToastManager from './components/managers/ToastManager.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 { GetUser, HasAdmin } from './services/User';
|
||||
@@ -12,10 +12,14 @@ import { useCampaignService } from './services/Campaign';
|
||||
|
||||
const { RestoreCampaign } = useCampaignService();
|
||||
|
||||
// El bot de Discord enllaça amb aquesta pantalla; no és part de l'aplicació i no ha d'arrencar
|
||||
// les finestres normals.
|
||||
// Els serveis (Discord, Foundry, Obsidian) enllacen amb aquesta pantalla única; no són part
|
||||
// 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 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(){
|
||||
if(GetUser()){
|
||||
@@ -46,14 +50,14 @@ useHead({
|
||||
onMounted(() => {
|
||||
setupTheme();
|
||||
setTheme('dark');
|
||||
if(!isDiscordAuthorize.value){
|
||||
if(!isServiceLink.value){
|
||||
start();
|
||||
}
|
||||
})
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<DiscordAuthorize v-if="isDiscordAuthorize"></DiscordAuthorize>
|
||||
<ServiceLinkAuthorize v-if="isServiceLink"></ServiceLinkAuthorize>
|
||||
<div v-else class="viewer">
|
||||
<ToastManager></ToastManager>
|
||||
<TooltipManager></TooltipManager>
|
||||
|
||||
@@ -665,7 +665,11 @@ onBeforeUnmount(() => {
|
||||
}
|
||||
|
||||
.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;
|
||||
gap: 3px; cursor: pointer;
|
||||
}
|
||||
@@ -673,8 +677,8 @@ onBeforeUnmount(() => {
|
||||
.entity-entry:focus-visible { outline: 1px solid var(--color-link); }
|
||||
/* The map currently anchored on the note container. */
|
||||
.entity-entry.anchored { border-color: var(--color-link); background: var(--color-background-soft); }
|
||||
.entity-entry-name-row { display: flex; align-items: baseline; gap: 6px; }
|
||||
.entity-entry-name { font-weight: bold; }
|
||||
.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 {
|
||||
font-size: 10px;
|
||||
letter-spacing: 0.04em;
|
||||
|
||||
@@ -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>
|
||||
395
frontend/app/components/views/ServiceLinkAuthorize.vue
Normal file
395
frontend/app/components/views/ServiceLinkAuthorize.vue
Normal 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>
|
||||
@@ -1,5 +1,5 @@
|
||||
<script setup>
|
||||
import { onBeforeUnmount, onMounted, ref } from 'vue';
|
||||
import { onMounted, ref } from 'vue';
|
||||
import WindowHandle from './partials/WindowHandle.vue';
|
||||
import Tabs from '../layouts/Tabs.vue';
|
||||
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 settings = ref(campaign.settings && typeof campaign.settings === 'object' ? campaign.settings : {});
|
||||
const foundryUrl = ref(settings.value.integrations?.foundryUrl || '');
|
||||
const pairingCode = ref('');
|
||||
const requestId = ref('');
|
||||
const linking = ref(false);
|
||||
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 = [
|
||||
{ id: 'basic', value: 'campaigns.settings.tabs.basic' },
|
||||
{ id: 'integrations', value: 'campaigns.settings.tabs.integrations' }
|
||||
];
|
||||
|
||||
const serviceKeys = ['foundry', 'discord', 'obsidian'];
|
||||
|
||||
onMounted(() => {
|
||||
Top(wrapper);
|
||||
SetupHandle(id, handle);
|
||||
@@ -36,11 +38,7 @@ onMounted(() => {
|
||||
ResetPosition(id, 'center');
|
||||
SetResizable(id, true);
|
||||
SetMinSize(id, { width: 440, height: 340 });
|
||||
ResumePendingFoundryLink();
|
||||
});
|
||||
|
||||
onBeforeUnmount(() => {
|
||||
clearInterval(statusPoll);
|
||||
LoadServices();
|
||||
});
|
||||
|
||||
function ApplyCampaignUpdate(updatedCampaign) {
|
||||
@@ -100,95 +98,56 @@ async function SaveSettings() {
|
||||
}
|
||||
}
|
||||
|
||||
async function StartFoundryLink() {
|
||||
linking.value = true;
|
||||
async function LoadServices() {
|
||||
try {
|
||||
const response = await Server().post('/campaign/foundry-link/start', { campaignId: campaign._id });
|
||||
if (response.data.status !== 'ok') {
|
||||
DisplayToast('red', $t(response.data.msg || 'errors.internal'), 3000);
|
||||
return;
|
||||
}
|
||||
|
||||
pairingCode.value = response.data.code;
|
||||
requestId.value = response.data.requestId;
|
||||
clearInterval(statusPoll);
|
||||
statusPoll = setInterval(CheckFoundryLinkStatus, 2500);
|
||||
const response = await Server().get(`/campaign/services?campaignId=${campaign._id}`);
|
||||
services.value = response.data.status === 'ok' && Array.isArray(response.data.services)
|
||||
? response.data.services
|
||||
: [];
|
||||
} catch {
|
||||
DisplayToast('red', $t('errors.internal'), 3000);
|
||||
} finally {
|
||||
linking.value = false;
|
||||
services.value = [];
|
||||
}
|
||||
}
|
||||
|
||||
// The pairing code lives server-side until it expires, so re-attach to it when
|
||||
// the window opens again after a reload, restart or closing the window.
|
||||
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.
|
||||
}
|
||||
function LinkFor(service) {
|
||||
return services.value.find((link) => link.service === service) || null;
|
||||
}
|
||||
|
||||
async function CheckFoundryLinkStatus() {
|
||||
if (!requestId.value || checkingStatus) return;
|
||||
checkingStatus = true;
|
||||
try {
|
||||
const response = await Server().get(`/campaign/foundry-link/status/${requestId.value}`);
|
||||
if (response.data.status !== 'ok' || response.data.state === 'expired') {
|
||||
clearInterval(statusPoll);
|
||||
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;
|
||||
}
|
||||
// El món de Foundry es descriu amb el que la campanya ja en sap, per si el món
|
||||
// es va enllaçar abans que els serveis tinguessin un registre comú.
|
||||
function ServiceTarget(service, link) {
|
||||
if (link?.targetName) return link.targetName;
|
||||
if (service === 'foundry' && campaign.foundryWorldTitle) return campaign.foundryWorldTitle;
|
||||
if (service === 'discord' && campaign.discordGuildId) return campaign.discordGuildId;
|
||||
return '';
|
||||
}
|
||||
|
||||
async function UnlinkFoundry() {
|
||||
linking.value = true;
|
||||
function WhoConnected(link) {
|
||||
return link?.dragonrollUserName ? $t('campaigns.settings.services.connected-by', { user: link.dragonrollUserName }) : '';
|
||||
}
|
||||
|
||||
async function Unlink(service) {
|
||||
unlinked.value = service;
|
||||
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') {
|
||||
DisplayToast('red', $t(response.data.msg || 'errors.internal'), 3000);
|
||||
return;
|
||||
}
|
||||
|
||||
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 {
|
||||
DisplayToast('red', $t('errors.internal'), 3000);
|
||||
} finally {
|
||||
linking.value = false;
|
||||
}
|
||||
}
|
||||
|
||||
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);
|
||||
unlinked.value = '';
|
||||
}
|
||||
}
|
||||
</script>
|
||||
@@ -212,29 +171,33 @@ async function CopyPairingCode() {
|
||||
</div>
|
||||
</template>
|
||||
<template #integrations>
|
||||
<p class="help-text standalone">{{ $t('campaigns.settings.services.help') }}</p>
|
||||
<div class="settings-fields">
|
||||
<div class="world-link">
|
||||
<div v-if="campaign.foundryWorldId" class="linked-world">
|
||||
<strong>{{ campaign.foundryWorldTitle || campaign.foundryWorldId }}</strong>
|
||||
<span v-if="campaign.foundrySystem">{{ campaign.foundrySystem }}</span>
|
||||
<button class="btn-primary sound-click" type="button" :disabled="linking" @click="UnlinkFoundry">
|
||||
{{ $t('campaigns.settings.unlink-foundry') }}
|
||||
<div v-for="service in serviceKeys" :key="service" class="service">
|
||||
<div class="service-head">
|
||||
<strong>{{ $t(`campaigns.settings.services.${service}.name`) }}</strong>
|
||||
<button
|
||||
v-if="LinkFor(service)"
|
||||
class="btn-primary sound-click"
|
||||
type="button"
|
||||
:disabled="unlinked !== ''"
|
||||
@click="Unlink(service)"
|
||||
>
|
||||
{{ $t('campaigns.settings.services.unlink') }}
|
||||
</button>
|
||||
</div>
|
||||
<p v-else class="help-text standalone">{{ $t('campaigns.settings.no-foundry-world') }}</p>
|
||||
|
||||
<button class="btn-primary sound-click" type="button" :disabled="linking" @click="StartFoundryLink">
|
||||
{{ $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>
|
||||
<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 class="settings-fields">
|
||||
<label class="field">
|
||||
<span>{{ $t('campaigns.settings.foundry-url') }}</span>
|
||||
<input
|
||||
@@ -313,40 +276,36 @@ input {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.world-link {
|
||||
.service {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 10px;
|
||||
gap: 6px;
|
||||
padding-bottom: 14px;
|
||||
border-bottom: 1px solid var(--color-border);
|
||||
}
|
||||
|
||||
.linked-world {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 10px;
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
|
||||
.linked-world span {
|
||||
opacity: 0.75;
|
||||
}
|
||||
|
||||
.pairing-code {
|
||||
.service-head {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: space-between;
|
||||
gap: 10px;
|
||||
padding: 10px;
|
||||
border: 1px solid var(--color-border);
|
||||
border-radius: 6px;
|
||||
}
|
||||
|
||||
.pairing-code code {
|
||||
user-select: text;
|
||||
.service-state {
|
||||
margin: 0;
|
||||
font-size: 14px;
|
||||
overflow-wrap: anywhere;
|
||||
}
|
||||
|
||||
.service-state.linked {
|
||||
color: var(--color-green);
|
||||
}
|
||||
|
||||
.who {
|
||||
opacity: 0.75;
|
||||
font-size: 13px;
|
||||
}
|
||||
|
||||
.actions {
|
||||
display: flex;
|
||||
justify-content: flex-end;
|
||||
|
||||
@@ -10,21 +10,30 @@
|
||||
"color": "Color de la campanya",
|
||||
"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.",
|
||||
"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.",
|
||||
"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.",
|
||||
"copy-code": "Copia el codi",
|
||||
"code-copied": "S'ha copiat el codi d'enllaç.",
|
||||
"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": {
|
||||
"name-required": "Introdueix un nom per a la campanya.",
|
||||
"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ç."
|
||||
"invalid-foundry-url": "Introdueix una URL vàlida de Foundry VTT amb http o https."
|
||||
}
|
||||
},
|
||||
"sidebar-label": "Campanya",
|
||||
|
||||
35
frontend/i18n/locales/ca/link.json
Normal file
35
frontend/i18n/locales/ca/link.json
Normal 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ç."
|
||||
}
|
||||
}
|
||||
@@ -14,21 +14,30 @@
|
||||
"color": "Campaign color",
|
||||
"foundry-url": "Foundry VTT URL",
|
||||
"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.",
|
||||
"linked": "Foundry world linked to this campaign.",
|
||||
"unlinked": "Foundry world unlinked from this campaign.",
|
||||
"copy-code": "Copy code",
|
||||
"code-copied": "Pairing code copied.",
|
||||
"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": {
|
||||
"name-required": "Enter a campaign name.",
|
||||
"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."
|
||||
"invalid-foundry-url": "Enter a valid Foundry VTT URL using http or https."
|
||||
}
|
||||
},
|
||||
"sidebar-label": "Campaign",
|
||||
|
||||
35
frontend/i18n/locales/en/link.json
Normal file
35
frontend/i18n/locales/en/link.json
Normal 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."
|
||||
}
|
||||
}
|
||||
@@ -10,21 +10,30 @@
|
||||
"color": "Color de la campaña",
|
||||
"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.",
|
||||
"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.",
|
||||
"linked": "El mundo de Foundry se ha vinculado a esta campaña.",
|
||||
"unlinked": "Se ha desvinculado el mundo de Foundry de esta campaña.",
|
||||
"copy-code": "Copiar código",
|
||||
"code-copied": "Código de vinculación copiado.",
|
||||
"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": {
|
||||
"name-required": "Introduce un nombre para la campaña.",
|
||||
"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."
|
||||
"invalid-foundry-url": "Introduce una URL válida de Foundry VTT con http o https."
|
||||
}
|
||||
},
|
||||
"sidebar-label": "Campaña",
|
||||
|
||||
35
frontend/i18n/locales/es/link.json
Normal file
35
frontend/i18n/locales/es/link.json
Normal 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."
|
||||
}
|
||||
}
|
||||
@@ -1,8 +1,12 @@
|
||||
// Tests for the pairing status the Dragonroll Foundry module shows in its
|
||||
// settings (Syndria98/dragonroll#17). Like foundry-sync-toggle.test.js, the module
|
||||
// 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 status is that answer
|
||||
// plus what this client holds (its sync token and any pairing code).
|
||||
// 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/`.
|
||||
|
||||
@@ -19,12 +23,19 @@ const MODULE_SOURCE = fs.readFileSync(
|
||||
);
|
||||
|
||||
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). `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 = "", answers = {} } = {}) {
|
||||
// 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(),
|
||||
@@ -36,6 +47,7 @@ function makeStubWorld({ syncToken = "sync-token-1", linkCode = "", answers = {}
|
||||
autoSync: true,
|
||||
syncToken,
|
||||
linkCode,
|
||||
linkUrl,
|
||||
dragonrollApiUrl: "http://backend.test:5000",
|
||||
};
|
||||
|
||||
@@ -60,7 +72,7 @@ function makeStubWorld({ syncToken = "sync-token-1", linkCode = "", answers = {}
|
||||
},
|
||||
},
|
||||
// The pairing status never waits on a timer: it is written when the world is
|
||||
// ready and whenever a pairing attempt answers, so dropping these keeps the
|
||||
// ready and whenever a link check answers, so dropping these keeps the
|
||||
// snapshot and reconcile loops out of these tests.
|
||||
setTimeout: () => 0,
|
||||
clearTimeout: () => {},
|
||||
@@ -71,6 +83,7 @@ function makeStubWorld({ syncToken = "sync-token-1", linkCode = "", answers = {}
|
||||
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));
|
||||
@@ -85,7 +98,7 @@ function makeStubWorld({ syncToken = "sync-token-1", linkCode = "", answers = {}
|
||||
};
|
||||
|
||||
sandbox.game = {
|
||||
user: { isGM: true },
|
||||
user: { isGM: true, name: "Test GM" },
|
||||
world: { id: "world-1", title: "Test World" },
|
||||
system: { id: "dnd5e" },
|
||||
modules: { get: () => ({}) },
|
||||
@@ -108,8 +121,11 @@ function makeStubWorld({ syncToken = "sync-token-1", linkCode = "", answers = {}
|
||||
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.
|
||||
@@ -122,11 +138,6 @@ function makeStubWorld({ syncToken = "sync-token-1", linkCode = "", answers = {}
|
||||
await state.settle();
|
||||
};
|
||||
|
||||
state.configure = async (key, value) => {
|
||||
await sandbox.game.settings.set(MODULE_ID, key, value);
|
||||
await state.settle();
|
||||
};
|
||||
|
||||
state.start = async () => {
|
||||
await state.fire("init");
|
||||
await state.fire("ready");
|
||||
@@ -145,20 +156,31 @@ test("the pairing status is a setting the module configures", async () => {
|
||||
assert.equal(setting.scope, "client", "the pairing status belongs to this client, like the token it comes from");
|
||||
});
|
||||
|
||||
test("a world that was never paired says it is not connected", async () => {
|
||||
const world = await makeStubWorld({ syncToken: "" }).start();
|
||||
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();
|
||||
|
||||
assert.match(world.status(), /^Not connected/, "an unpaired world says so plainly");
|
||||
assert.match(world.status(), /Dragonroll campaign/, "and names what it is not connected to");
|
||||
assert.deepEqual(world.statusRequests(), [], "there is nothing to verify without a sync token");
|
||||
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 paired world names the Dragonroll campaign it is connected to", async () => {
|
||||
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");
|
||||
});
|
||||
|
||||
@@ -169,6 +191,7 @@ test("a campaign that unlinked this world stops being reported as connected", as
|
||||
|
||||
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 () => {
|
||||
@@ -178,44 +201,58 @@ test("an unreachable Dragonroll keeps the pairing this client already knows", as
|
||||
"a Dragonroll without the status route says nothing, so the token speaks");
|
||||
});
|
||||
|
||||
test("a code that cannot be redeemed explains why the world is not connected", async () => {
|
||||
test("a link still waiting on its GM says the world is not connected yet", async () => {
|
||||
const world = await makeStubWorld({
|
||||
syncToken: "",
|
||||
answers: { "foundry/link/complete": { status: "error", msg: "foundry.errors.link-expired" } },
|
||||
});
|
||||
await world.start();
|
||||
linkCode: "link-code-1",
|
||||
linkUrl: SIGN_UP_LINK,
|
||||
answers: { "link/pickup": { status: "ok", state: "pending" } },
|
||||
}).start();
|
||||
|
||||
await world.configure("linkCode", "AN-EXPIRED-CODE");
|
||||
|
||||
assert.match(world.status(), /^Not connected/);
|
||||
assert.match(world.status(), /pairing code is invalid, expired, or already used/);
|
||||
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 code still waiting on Dragonroll says the pairing is not finished", async () => {
|
||||
const world = await makeStubWorld({
|
||||
syncToken: "",
|
||||
answers: { "foundry/link/complete": { status: "error", msg: "errors.internal" } },
|
||||
});
|
||||
await world.start();
|
||||
|
||||
await world.configure("linkCode", "A-CODE-TO-RETRY");
|
||||
|
||||
assert.equal(world.status(), "Not connected yet: waiting for Dragonroll to accept this pairing code.");
|
||||
});
|
||||
|
||||
test("redeeming a pairing code connects the world to its campaign", async () => {
|
||||
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: {
|
||||
"foundry/link/complete": { status: "ok", campaign: LINKED_CAMPAIGN, syncToken: "sync-token-2" },
|
||||
"link/pickup": {
|
||||
status: "ok",
|
||||
state: "linked",
|
||||
campaign: LINKED_CAMPAIGN,
|
||||
syncToken: "sync-token-2",
|
||||
bridgeConfig: { url: "http://bridge.test", pushToken: "push-1" },
|
||||
},
|
||||
});
|
||||
await world.start();
|
||||
|
||||
await world.configure("linkCode", "A-FRESH-CODE");
|
||||
// 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.game.settings.get(MODULE_ID, "linkCode"), "", "a redeemed code is not kept");
|
||||
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 () => {
|
||||
@@ -224,7 +261,8 @@ test("whatever is typed into the status is replaced by the real one", async () =
|
||||
});
|
||||
await world.start();
|
||||
|
||||
await world.configure("pairingStatus", "My own status text");
|
||||
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}".`);
|
||||
});
|
||||
|
||||
88
tests/sidebar-entity-entry.test.js
Normal file
88
tests/sidebar-entity-entry.test.js
Normal 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");
|
||||
});
|
||||
Reference in New Issue
Block a user