domma-cms 1.8.32 → 1.8.34

package/plugins/crossword/docs/guide.md

@@ -0,0 +1,53 @@
+---
+title: Guide
+order: 1
+---
+
+Put crosswords on your website. You type the answers and clues, the grid is laid out for you, and visitors race the clock to a leaderboard. Crossword is free.
+
+## What it does
+
+- **You write words and clues; it builds the grid.** The preview updates as you type. Not happy with the shape? **Another layout** tries a different arrangement of the same words. Any word that will not cross the others is listed so you can change it.
+- **Phrases are fine.** "New York" shows as (3,4) and "well-being" as (4-5) in the clue.
+- **Timing kept by the server**, from the moment the crossword is started to the moment it is solved.
+- **Check** marks the wrong squares, at a time penalty you choose (30 seconds unless you change it). You can switch checking off.
+- **Submitting a wrong grid** costs a smaller penalty (10 seconds unless you change it), so guessing is not free. Empty squares are pointed out and cost nothing.
+- **Leaderboards** of the fastest solvers for today, this week, this month and all time, best go per name.
+- The answers never reach the visitor's browser until they have solved it.
+- Optional overall time limit, opening and closing times, and a limit on goes per name.
+
+## Getting started
+
+1. Switch Crossword on in **Tools**.
+2. Open **Tools > Games > Crossword** and choose **New crossword**.
+3. Add at least two answers with their clues. Ten to twenty words make a good grid.
+4. Press **Test** and solve it yourself (see below).
+5. Set the status to **Open** and save.
+6. Put it on any page:
+
+```
+[crossword id="sea-life" /]
+```
+
+## Testing a crossword
+
+**Test** (in the editor, on each crossword in the list, and on its Plays screen) opens the crossword right there in the admin, exactly as your players will see it: the same grid, clock, checks and penalties.
+
+- It plays the version you last saved. With unsaved changes the button says **Save and test**, and saves first.
+- It works whatever the status, so you can try a draft before anyone can see it.
+- A test go is never saved to the leaderboard. It is not in the Plays list, it does not count towards the goes each name is allowed, and it does not raise a notification. When you solve it, it tells you where you would have come.
+- Each new test clears away the one before.
+
+## A leaderboard on its own
+
+```
+[crossword-leaderboard id="sea-life" period="all" limit="10" title="Fastest solvers" /]
+```
+
+## Playing
+
+Click a square, or a clue, and type. Typing moves along the word. Arrow keys move around, clicking the same square again or pressing Space turns between across and down, Tab jumps to the next clue, and Backspace clears. Letters are remembered if the page is reloaded.
+
+## Looking after the board
+
+Open a crossword's **Plays** to see every go (your own test goes are not shown). You can hide a play from the leaderboard, delete it, or reset the leaderboard.

package/plugins/crossword/inject/body.html

@@ -1 +1 @@
-<script type="module" src="/plugins/crossword/public/crossword.js?v=1.0.0"></script>
+<script type="module" src="/plugins/crossword/public/crossword.js?v=1.1.0"></script>

package/plugins/crossword/plugin.js

@@ -6,6 +6,9 @@
  *   GET  /puzzles                       every crossword as a list row
  *   GET  /puzzles/:id · POST /puzzles · PUT /puzzles/:id · DELETE /puzzles/:id
  *   POST /puzzles/:id/copy              a copy, as a draft
+ *   GET  /puzzles/:id/test              what the player's start screen shows, as if it were open
+ *   POST /puzzles/:id/test              a TEST play of it as saved (draft or closed too) -> {playId, token, name, info};
+ *                                       played through the /public/play routes, never on a board (see _lib/games/plays.js)
  *   GET  /puzzles/:id/plays · DELETE /puzzles/:id/plays · PUT /plays/:id · DELETE /plays/:id
  *   The grid is laid out on the server from the words and the seed (the builder previews with
  *   the same function, public/lib/layout.js); a save answers `unplaced` for words that did not fit.
@@ -24,7 +27,7 @@
  */
 
 import {cleanPlayerName} from '../_lib/games/names.js';
-import {boardQuery, fail, isBot, limited, mountPlayAdmin, todayBadge, tokenOf} from '../_lib/games/http.js';
+import {boardQuery, fail, isBot, limited, mountPlayAdmin, testerName, todayBadge, tokenOf} from '../_lib/games/http.js';
 import {solutionGrid} from './public/lib/layout.js';
 import {catchUp, cleanPuzzle, compare, finish, isOpen, publicPuzzle, readCells, summary, view} from './lib/crossword.js';
 import {allPuzzles, ensureCollections, getPuzzle, plays, puzzleBySlug, removePuzzle, savePuzzle, uniqueSlug} from './lib/store.js';
@@ -83,7 +86,7 @@ export default async function crosswordPlugin(fastify, options) {
 
     fastify.get('/puzzles', can('read'), async () => {
         const everyPlay = await plays.all();
-        return {puzzles: (await allPuzzles()).map(p => summary(p, everyPlay.filter(x => x.gameId === p.id)))
+        return {puzzles: (await allPuzzles()).map(p => summary(p, everyPlay.filter(x => x.gameId === p.id && x.test !== true)))
             .sort((a, b) => String(b.updatedAt).localeCompare(String(a.updatedAt)))};
     });
 
@@ -119,6 +122,27 @@ export default async function crosswordPlugin(fastify, options) {
 
     mountPlayAdmin(fastify, {store: plays, base: '/puzzles', can, exists: async (id) => Boolean(await getPuzzle(id))});
 
+    // The admin tries the crossword from the Tool: the saved grid, whatever its status or dates, through
+    // the same player routes as anyone. The play is marked `test`, so it never counts anywhere.
+    const testInfo = (puzzle) => ({...publicInfo(puzzle), open: true, reason: ''});
+
+    fastify.get('/puzzles/:id/test', can('manage'), async (request, reply) => {
+        const puzzle = await getPuzzle(request.params.id);
+        if (!puzzle) return fail(reply, 404, 'That crossword is not here any more.');
+        return {info: testInfo(puzzle)};
+    });
+
+    fastify.post('/puzzles/:id/test', can('manage'), async (request, reply) => {
+        const puzzle = await getPuzzle(request.params.id);
+        if (!puzzle) return fail(reply, 404, 'That crossword is not here any more.');
+        if (!puzzle.layout?.entries?.length) return fail(reply, 409, 'Add answers and clues and save, then test it.', {code: 'empty'});
+        await plays.clearTests(puzzle.id);
+        const name = testerName(request);
+        const play = await plays.start({gameId: puzzle.id, name, maxScore: 1, state: {checks: 0, submits: 0, penaltyMs: 0},
+            userId: String(request.user?.id || ''), test: true});
+        return reply.code(201).send({playId: play.id, token: play.token, name, info: testInfo(puzzle)});
+    });
+
     // ---- Players ----------------------------------------------------------------
 
     const shownPuzzle = async (slug) => {
@@ -155,18 +179,22 @@ export default async function crosswordPlugin(fastify, options) {
     });
 
     /** The play behind a request, up to date with the clock. Null after answering with the reason. */
+    /** The play went while this request was on its way (a reset, a delete, or the next test clearing it). */
+    const gone = (reply) => fail(reply, 404, 'That game is not here any more. Start again.', {code: 'gone'});
+
     async function livePlay(request, reply) {
         const opened = await plays.open(request.params.id, tokenOf(request));
         if (!opened) { fail(reply, 404, 'That game is not here any more. Start again.', {code: 'gone'}); return null; }
         const puzzle = await getPuzzle(opened.gameId);
         if (!puzzle) { fail(reply, 404, 'That crossword is not here any more.', {code: 'gone'}); return null; }
         const play = await plays.change(opened.id, (p) => (catchUp(puzzle, p) ? p : null));
+        if (!play) { gone(reply); return null; }
         return {puzzle, play};
     }
 
     async function afterFinish(puzzle, play) {
         try {
-            if (!puzzle.leaderboard || await plays.placeOf(play, 'all') !== 1) return;
+            if (play.test || !puzzle.leaderboard || await plays.placeOf(play, 'all') !== 1) return;
             hooks.notify?.({
                 title: `Fastest solve of "${puzzle.title}"`,
                 body: `${play.name} solved it in ${secs(play.timeMs)} seconds`,
@@ -195,6 +223,7 @@ export default async function crosswordPlugin(fastify, options) {
             p.state.penaltyMs = (p.state.penaltyMs || 0) + puzzle.checkPenalty * 1000;
             return p;
         });
+        if (!play) return gone(reply);
         return {wrong, empty, play: view(puzzle, play)};
     });
 
@@ -214,6 +243,7 @@ export default async function crosswordPlugin(fastify, options) {
             if (!solved && !empty) p.state.penaltyMs = (p.state.penaltyMs || 0) + puzzle.wrongPenalty * 1000;
             return solved ? finish(p) : p;
         });
+        if (!play) return gone(reply);
         if (solved) await afterFinish(puzzle, play);
         return {
             solved, empty, wrongCount: solved || empty ? 0 : wrong.length,
@@ -231,8 +261,11 @@ export default async function crosswordPlugin(fastify, options) {
         const solved = play.status === 'finished';
         return {
             name: play.name, solved, timeMs: play.timeMs, penaltyMs: play.state.penaltyMs || 0, checks: play.state.checks || 0,
-            place: solved && puzzle.leaderboard && !play.hidden ? await plays.placeOf(play, 'all') : 0,
-            placeToday: solved && puzzle.leaderboard && !play.hidden ? await plays.placeOf(play, 'today') : 0,
+            test: play.test === true,
+            place: solved && puzzle.leaderboard && !play.hidden && !play.test ? await plays.placeOf(play, 'all') : 0,
+            placeToday: solved && puzzle.leaderboard && !play.hidden && !play.test ? await plays.placeOf(play, 'today') : 0,
+            // A test is on no board; this is where it would have come.
+            wouldPlace: solved && puzzle.leaderboard && play.test ? await plays.placeOf(play, 'all') : 0,
             leaderboard: puzzle.leaderboard,
             // The answers only to someone who solved it: a timed-out play under another name must not be a way to read them.
             solution: solved ? solutionGrid(puzzle.layout).map(row => row.map(ch => ch || ' ').join('')) : null

package/plugins/crossword/plugin.json

@@ -1,11 +1,12 @@
 {
   "name": "crossword",
   "displayName": "Crossword",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "tier": "free",
+  "minCmsVersion": "1.8.33",
   "description": "Type answers and clues in the admin and the grid lays itself out. Put the crossword on any page: players type a name, solve against the clock, and the fastest go top of the leaderboard. The answers stay on the server until someone has solved it.",
   "author": "Domma CMS",
-  "date": "2026-10-20",
+  "date": "2026-10-21",
   "icon": "grid",
   "permissions": [
     {
@@ -70,7 +71,7 @@
     ],
     "views": {
       "plugin-crossword": {
-        "entry": "crossword/admin/views/crossword.js?v=dec171f7",
+        "entry": "crossword/admin/views/crossword.js?v=1.1.0",
         "exportName": "crosswordView"
       }
     }

package/plugins/crossword/public/crossword.css

@@ -1 +1,36 @@
-.cw-app{max-width:1040px}.cw-live{position:absolute;left:-9999px}.cw-clocks{display:inline-flex;align-items:center;gap:.5rem}.cw-current{margin:0 0 .75rem;padding:.5rem .75rem;border-radius:8px;font-weight:600;background:color-mix(in srgb,var(--gm-accent) 14%,transparent)}.cw-layout{display:grid;grid-template-columns:auto minmax(14rem,1fr);gap:1.25rem;align-items:start}@media(max-width:760px){.cw-layout{grid-template-columns:1fr}}.cw-grid-wrap{overflow-x:auto;max-width:100%}.cw-grid{--cw-size: clamp(1.6rem, calc((100vw - 4rem) / var(--cw-cols, 15)), 2.4rem);--cw-ink: #111827;--cw-paper: #ffffff;display:inline-flex;flex-direction:column;border:2px solid var(--cw-ink);background:var(--cw-ink)}.cw-row{display:flex}.cw-cell{position:relative;width:var(--cw-size);height:var(--cw-size);box-sizing:border-box;border:1px solid #9ca3af;background:var(--cw-paper)}.cw-cell.is-block{background:var(--cw-ink);border-color:var(--cw-ink)}.cw-cell.is-word{background:color-mix(in srgb,var(--gm-accent) 22%,var(--cw-paper))}.cw-cell.is-cursor{background:color-mix(in srgb,var(--gm-accent) 55%,var(--cw-paper))}.cw-cell.is-wrong .cw-input{color:#dc2626;text-decoration:line-through}.cw-num{position:absolute;top:1px;left:2px;font-size:calc(var(--cw-size) * .28);line-height:1;pointer-events:none;color:#4b5563}.cw-input{width:100%;height:100%;border:0;padding:0;margin:0;background:transparent;text-align:center;text-transform:uppercase;font:700 calc(var(--cw-size) * .55)/1 var(--dm-font-sans, inherit);color:var(--cw-ink);caret-color:transparent;cursor:pointer}.cw-input:focus{outline:none}.cw-input[readonly]{cursor:default}.cw-clues{display:grid;grid-template-columns:1fr;gap:1rem;max-height:34rem;overflow:auto}@media(min-width:1000px){.cw-clues{grid-template-columns:1fr 1fr}}.cw-clues h3{margin:0 0 .35rem;font-size:1rem;text-transform:uppercase;letter-spacing:.05em}.cw-list{list-style:none;margin:0;padding:0;display:flex;flex-direction:column;gap:.1rem}.cw-clue{display:block;width:100%;text-align:left;font:inherit;color:inherit;background:none;border:0;padding:.3rem .45rem;border-radius:6px;cursor:pointer}.cw-clue:hover{background:var(--gm-soft)}.cw-list li.is-on .cw-clue{background:color-mix(in srgb,var(--gm-accent) 20%,transparent)}.cw-message.is-bad{color:var(--gm-bad);font-weight:600}.cw-message.is-good{color:var(--gm-good);font-weight:600}.cw-result{margin-bottom:1rem}
+/* Crossword - the player. Shared pieces (cards, clocks, leaderboard) are in /plugins/_lib/public/games/games.css. */
+.cw-app { max-width: 1040px; }
+.cw-live { position: absolute; left: -9999px; }
+.cw-clocks { display: inline-flex; align-items: center; gap: .5rem; }
+.cw-current { margin: 0 0 .75rem; padding: .5rem .75rem; border-radius: 8px; font-weight: 600;
+    background: color-mix(in srgb, var(--gm-accent) 14%, transparent); }
+
+.cw-layout { display: grid; grid-template-columns: auto minmax(14rem, 1fr); gap: 1.25rem; align-items: start; }
+@media (max-width: 760px) { .cw-layout { grid-template-columns: 1fr; } }
+.cw-grid-wrap { overflow-x: auto; max-width: 100%; }
+/* A crossword is black and white whatever the theme: light squares, dark blocks, the theme's accent for the cursor. */
+.cw-grid { --cw-size: clamp(1.6rem, calc((100vw - 4rem) / var(--cw-cols, 15)), 2.4rem); --cw-ink: #111827; --cw-paper: #ffffff;
+    display: inline-flex; flex-direction: column; border: 2px solid var(--cw-ink); background: var(--cw-ink); }
+.cw-row { display: flex; }
+.cw-cell { position: relative; width: var(--cw-size); height: var(--cw-size); box-sizing: border-box;
+    border: 1px solid #9ca3af; background: var(--cw-paper); }
+.cw-cell.is-block { background: var(--cw-ink); border-color: var(--cw-ink); }
+.cw-cell.is-word { background: color-mix(in srgb, var(--gm-accent) 22%, var(--cw-paper)); }
+.cw-cell.is-cursor { background: color-mix(in srgb, var(--gm-accent) 55%, var(--cw-paper)); }
+.cw-cell.is-wrong .cw-input { color: #dc2626; text-decoration: line-through; }
+.cw-num { position: absolute; top: 1px; left: 2px; font-size: calc(var(--cw-size) * .28); line-height: 1; pointer-events: none; color: #4b5563; }
+.cw-input { width: 100%; height: 100%; border: 0; padding: 0; margin: 0; background: transparent; text-align: center; text-transform: uppercase;
+    font: 700 calc(var(--cw-size) * .55)/1 var(--dm-font-sans, inherit); color: var(--cw-ink); caret-color: transparent; cursor: pointer; }
+.cw-input:focus { outline: none; }
+.cw-input[readonly] { cursor: default; }
+
+.cw-clues { display: grid; grid-template-columns: 1fr; gap: 1rem; max-height: 34rem; overflow: auto; }
+@media (min-width: 1000px) { .cw-clues { grid-template-columns: 1fr 1fr; } }
+.cw-clues h3 { margin: 0 0 .35rem; font-size: 1rem; text-transform: uppercase; letter-spacing: .05em; }
+.cw-list { list-style: none; margin: 0; padding: 0; display: flex; flex-direction: column; gap: .1rem; }
+.cw-clue { display: block; width: 100%; text-align: left; font: inherit; color: inherit; background: none; border: 0; padding: .3rem .45rem; border-radius: 6px; cursor: pointer; }
+.cw-clue:hover { background: var(--gm-soft); }
+.cw-list li.is-on .cw-clue { background: color-mix(in srgb, var(--gm-accent) 20%, transparent); }
+.cw-message.is-bad { color: var(--gm-bad); font-weight: 600; }
+.cw-message.is-good { color: var(--gm-good); font-weight: 600; }
+.cw-result { margin-bottom: 1rem; }