domma-cms 1.8.45 → 1.9.0

package/plugins/quiz/plugin.js

@@ -1,275 +0,0 @@
-/**
- * Quiz - the API (mounted at /api/plugins/quiz).
- *
- * Admin (the `quiz` permission; read to look, manage to change):
- *   GET  /count                      sidebar badge: plays finished today
- *   GET  /quizzes                    every quiz as a list row
- *   GET  /quizzes/:id · POST /quizzes · PUT /quizzes/:id · DELETE /quizzes/:id
- *   POST /quizzes/:id/copy           a copy, as a draft
- *   GET  /quizzes/:id/test           what the player's start screen shows, as if it were open
- *   POST /quizzes/: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  /quizzes/:id/plays · DELETE /quizzes/:id/plays · PUT /plays/:id · DELETE /plays/:id
- *
- * Players (no sign-in), under /public - the server keeps the time and marks every answer:
- *   GET  /public/quiz/:slug                 title, intro, how many questions, the limits
- *   GET  /public/quiz/:slug/leaderboard     ?period=today|week|month|all&limit=
- *   POST /public/quiz/:slug/start           {name} -> {playId, token} (the token is shown once)
- *   GET  /public/play/:id                   where the play is now: the current question (no answer), time left
- *   POST /public/play/:id/answer            {q, answer} -> marked; feedback when the quiz shows answers as you go
- *   GET  /public/play/:id/result            score, time, place, and the answers when the quiz shows them
- * Each /public/play call carries the token in `X-Play-Token`.
- *
- * Shortcodes: [quiz id="<short name>" /] and [quiz-leaderboard id="<short name>" period="week" limit="10" /].
- */
-
-import {cleanPlayerName} from '../_lib/games/names.js';
-import {boardQuery, fail, isBot, limited, mountPlayAdmin, testerName, todayBadge, tokenOf} from '../_lib/games/http.js';
-import {answerText, cleanQuiz, isOpen, maxScoreOf, planPlay, rightText, summary} from './lib/quiz.js';
-import {answer, catchUp, feedbackFor, serve, view} from './lib/engine.js';
-import {allQuizzes, ensureCollections, getQuiz, plays, quizBySlug, removeQuiz, saveQuiz, uniqueSlug} from './lib/store.js';
-
-const esc = (s) => String(s ?? '').replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;').replace(/'/g, '&#39;');
-const slugAttr = (v) => String(v || '').toLowerCase().replace(/[^a-z0-9-]/g, '').slice(0, 60);
-
-function registerShortcodes(hooks) {
-    if (typeof hooks.registerShortcode !== 'function') return;
-    // Self-closing. The page's script (public/quiz.js, on every page via inject/body.html) mounts on the placeholder.
-    hooks.registerShortcode('quiz', (attrStr, _body, ctx) => {
-        const a = ctx.parseShortcodeAttrs(attrStr || '');
-        const slug = slugAttr(a.id || a.slug);
-        if (!slug) return '<p class="gm-muted">[quiz] needs id="the quiz\'s short name".</p>';
-        return `<div class="gm-app qz-app" data-quiz='${esc(JSON.stringify({slug}))}'><p class="gm-muted">Loading the quiz…</p></div>`;
-    });
-    hooks.registerShortcode('quiz-leaderboard', (attrStr, _body, ctx) => {
-        const a = ctx.parseShortcodeAttrs(attrStr || '');
-        const id = slugAttr(a.id || a.slug);
-        if (!id) return '<p class="gm-muted">[quiz-leaderboard] needs id="the quiz\'s short name".</p>';
-        const cfg = {id, period: String(a.period || 'all'), limit: Math.max(1, Math.min(100, Number(a.limit) || 10)), title: String(a.title || 'Leaderboard').slice(0, 80)};
-        return `<div class="qz-board" data-quiz-board='${esc(JSON.stringify(cfg))}'></div>`;
-    // First: the engine matches [quiz…/] by prefix, so [quiz] would otherwise take [quiz-leaderboard …/] too.
-    }, {priority: 5});
-}
-
-/** What anyone may know about a quiz before playing it. */
-function publicInfo(quiz) {
-    const state = isOpen(quiz);
-    const count = quiz.draw || quiz.questions.length;
-    return {
-        slug: quiz.slug, title: quiz.title, intro: quiz.intro, open: state.open, reason: state.reason, opensAt: state.opensAt || '',
-        questions: count, timeLimit: quiz.timeLimit, questionSeconds: quiz.questionSeconds,
-        perQuestionTimes: quiz.questions.some(q => q.seconds > 0),
-        showAnswers: quiz.showAnswers, leaderboard: quiz.leaderboard, leaderboardSize: quiz.leaderboardSize,
-        attemptsPerName: quiz.attemptsPerName
-    };
-}
-
-/** The review at the end: every question, their answer and the right one - only when the quiz shows answers. */
-function review(quiz, play) {
-    if (quiz.showAnswers === 'never') return null;
-    return play.state.order.map((slot, i) => {
-        const q = quiz.questions.find(x => x.id === slot.q);
-        const a = play.state.answers[i];
-        if (!q) return null;
-        return {
-            text: q.text, image: q.image, points: q.points,
-            yours: a ? (a.given == null ? '' : answerText(q, a.given)) : '',
-            right: rightText(q), correct: a?.correct === true, late: a?.late === true, explanation: q.explanation || ''
-        };
-    }).filter(Boolean);
-}
-
-export default async function quizPlugin(fastify, options) {
-    const {authenticate, requirePermission} = options.auth;
-    const hooks = options.hooks || {};
-    const can = (action) => ({preHandler: [authenticate, requirePermission('quiz', action)]});
-
-    await ensureCollections(fastify.log);
-    registerShortcodes(hooks);
-
-    if (typeof hooks.registerNotificationSource === 'function') {
-        try {
-            hooks.registerNotificationSource({id: 'top-scores', label: 'Quiz top scores', severity: 'info', defaultOn: true,
-                description: 'Someone has gone top of a quiz\'s all-time leaderboard.'});
-        } catch { /* older engine */ }
-    }
-
-    // ---- Admin ------------------------------------------------------------------
-
-    fastify.get('/count', can('read'), async () => todayBadge(plays, 'quiz play'));
-
-    fastify.get('/quizzes', can('read'), async () => {
-        const everyPlay = await plays.all();
-        return {quizzes: (await allQuizzes()).map(q => summary(q, everyPlay.filter(p => p.gameId === q.id && p.test !== true)))
-            .sort((a, b) => String(b.updatedAt).localeCompare(String(a.updatedAt)))};
-    });
-
-    fastify.get('/quizzes/:id', can('read'), async (request, reply) => {
-        const quiz = await getQuiz(request.params.id);
-        return quiz || fail(reply, 404, 'That quiz is not here any more.');
-    });
-
-    async function save(request, reply, id) {
-        const current = id ? await getQuiz(id) : null;
-        if (id && !current) return fail(reply, 404, 'That quiz is not here any more.');
-        const {quiz, errors} = cleanQuiz(request.body || {});
-        if (Object.keys(errors).length) return fail(reply, 400, Object.values(errors)[0], {errors});
-        quiz.slug = await uniqueSlug(quiz.slug, id || '');
-        const saved = await saveQuiz(id, quiz);
-        return id ? saved : reply.code(201).send(saved);
-    }
-
-    fastify.post('/quizzes', can('manage'), (request, reply) => save(request, reply, ''));
-    fastify.put('/quizzes/:id', can('manage'), (request, reply) => save(request, reply, request.params.id));
-
-    fastify.post('/quizzes/:id/copy', can('manage'), async (request, reply) => {
-        const quiz = await getQuiz(request.params.id);
-        if (!quiz) return fail(reply, 404, 'That quiz is not here any more.');
-        const {id, createdAt, updatedAt, ...rest} = quiz;
-        const copy = {...rest, title: `${quiz.title} (copy)`.slice(0, 120), status: 'draft', slug: await uniqueSlug(quiz.slug)};
-        return reply.code(201).send(await saveQuiz('', copy));
-    });
-
-    fastify.delete('/quizzes/:id', can('manage'), async (request, reply) => {
-        if (!await getQuiz(request.params.id)) return fail(reply, 404, 'That quiz is not here any more.');
-        return {ok: true, playsRemoved: await removeQuiz(request.params.id)};
-    });
-
-    mountPlayAdmin(fastify, {store: plays, base: '/quizzes', can, exists: async (id) => Boolean(await getQuiz(id))});
-
-    // The admin tries the quiz from the Tool: the saved version, whatever its status or dates, through
-    // the same player routes as anyone. The play is marked `test`, so it never counts anywhere.
-    const testInfo = (quiz) => ({...publicInfo(quiz), open: true, reason: ''});
-
-    fastify.get('/quizzes/:id/test', can('manage'), async (request, reply) => {
-        const quiz = await getQuiz(request.params.id);
-        if (!quiz) return fail(reply, 404, 'That quiz is not here any more.');
-        return {info: testInfo(quiz)};
-    });
-
-    fastify.post('/quizzes/:id/test', can('manage'), async (request, reply) => {
-        const quiz = await getQuiz(request.params.id);
-        if (!quiz) return fail(reply, 404, 'That quiz is not here any more.');
-        if (!quiz.questions?.length) return fail(reply, 409, 'Add a question and save, then test it.', {code: 'empty'});
-        await plays.clearTests(quiz.id);
-        const plan = planPlay(quiz);
-        const name = testerName(request);
-        const play = await plays.start({gameId: quiz.id, name, maxScore: maxScoreOf(quiz, plan), state: plan,
-            userId: String(request.user?.id || ''), test: true});
-        return reply.code(201).send({playId: play.id, token: play.token, name, total: plan.order.length, maxScore: play.maxScore,
-            info: testInfo(quiz)});
-    });
-
-    // ---- Players ----------------------------------------------------------------
-
-    /** A quiz the public may see: anything but a draft. */
-    const shownQuiz = async (slug) => {
-        const quiz = await quizBySlug(slug);
-        return quiz && quiz.status !== 'draft' ? quiz : null;
-    };
-
-    fastify.get('/public/quiz/:slug', limited(120), async (request, reply) => {
-        const quiz = await shownQuiz(request.params.slug);
-        if (!quiz) return fail(reply, 404, 'There is no quiz here.');
-        return publicInfo(quiz);
-    });
-
-    fastify.get('/public/quiz/:slug/leaderboard', limited(120), async (request, reply) => {
-        const quiz = await shownQuiz(request.params.slug);
-        if (!quiz || !quiz.leaderboard) return fail(reply, 404, 'There is no leaderboard here.');
-        const {period, limit} = boardQuery(request.query, quiz.leaderboardSize);
-        return {title: quiz.title, period, rows: await plays.board(quiz.id, {period, limit})};
-    });
-
-    fastify.post('/public/quiz/:slug/start', limited(20, 10), async (request, reply) => {
-        const quiz = await shownQuiz(request.params.slug);
-        if (!quiz) return fail(reply, 404, 'There is no quiz here.');
-        const state = isOpen(quiz);
-        if (!state.open) return fail(reply, 409, state.reason, {code: 'closed'});
-        if (isBot(request.body)) return fail(reply, 400, 'Something went wrong. Please try again.');
-        const {name, error} = cleanPlayerName(request.body?.name);
-        if (error) return fail(reply, 400, error, {code: 'name'});
-        if (quiz.attemptsPerName && await plays.attemptsBy(quiz.id, name) >= quiz.attemptsPerName) {
-            return fail(reply, 409, quiz.attemptsPerName === 1 ? `${name} has already had a go at this quiz.` : `${name} has already had ${quiz.attemptsPerName} goes at this quiz.`, {code: 'attempts'});
-        }
-        const plan = planPlay(quiz);
-        const play = await plays.start({gameId: quiz.id, name, maxScore: maxScoreOf(quiz, plan), state: plan});
-        return reply.code(201).send({playId: play.id, token: play.token, name, total: plan.order.length, maxScore: play.maxScore});
-    });
-
-    /**
-     * The play behind a request, brought up to date with the clock (and saved
-     * when that changed it). 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, {serveNow = false} = {}) {
-        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 quiz = await getQuiz(opened.gameId);
-        if (!quiz) { fail(reply, 404, 'That quiz is not here any more.', {code: 'gone'}); return null; }
-        const now = Date.now();
-        const play = await plays.change(opened.id, (p) => {
-            const a = catchUp(quiz, p, now);
-            const b = serveNow && serve(quiz, p, now);
-            return a || b ? p : null;
-        });
-        if (!play) { gone(reply); return null; }
-        if (play.status === 'finished' && opened.status === 'playing') await afterFinish(quiz, play);
-        return {quiz, play, now};
-    }
-
-    /** A new top of the all-time board tells the admins. */
-    async function afterFinish(quiz, play) {
-        try {
-            if (play.test || !quiz.leaderboard || await plays.placeOf(play, 'all') !== 1) return;
-            hooks.notify?.({
-                title: `New top score on "${quiz.title}"`,
-                body: `${play.name}: ${play.score} of ${play.maxScore} in ${Math.round(play.timeMs / 1000)} seconds`,
-                severity: 'info', link: `#/plugins/quiz/plays/${quiz.id}`, source: 'top-scores', dedupeKey: `quiz-top:${play.id}`
-            });
-        } catch { /* a notice never breaks a play */ }
-    }
-
-    fastify.get('/public/play/:id', limited(240), async (request, reply) => {
-        const live = await livePlay(request, reply, {serveNow: true});
-        if (!live) return reply;
-        return view(live.quiz, live.play, live.now);
-    });
-
-    fastify.post('/public/play/:id/answer', limited(240), async (request, reply) => {
-        const live = await livePlay(request, reply);
-        if (!live) return reply;
-        const {quiz} = live;
-        let outcome = null;
-        const play = await plays.change(live.play.id, (p) => {
-            outcome = answer(quiz, p, request.body?.q, request.body?.answer, Date.now());
-            return outcome.error ? null : p;
-        });
-        if (!play) return gone(reply);
-        if (outcome?.error) return fail(reply, 409, outcome.error, {code: outcome.code || 'finished', play: view(quiz, play)});
-        if (play.status === 'finished') await afterFinish(quiz, play);
-        return {correct: outcome.correct, late: outcome.late, points: outcome.points, feedback: feedbackFor(quiz, outcome.q, outcome), play: view(quiz, play)};
-    });
-
-    fastify.get('/public/play/:id/result', limited(120), async (request, reply) => {
-        const live = await livePlay(request, reply);
-        if (!live) return reply;
-        const {quiz, play} = live;
-        if (play.status !== 'finished') return fail(reply, 409, 'This play has not finished yet.', {code: 'playing'});
-        return {
-            name: play.name, score: play.score, maxScore: play.maxScore, timeMs: play.timeMs, timeUp: play.state.timeUp === true,
-            correct: play.state.answers.filter(a => a.correct).length, total: play.state.order.length,
-            hidden: play.hidden === true,
-            test: play.test === true,
-            place: quiz.leaderboard && !play.hidden && !play.test ? await plays.placeOf(play, 'all') : 0,
-            placeToday: quiz.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: quiz.leaderboard && play.test ? await plays.placeOf(play, 'all') : 0,
-            leaderboard: quiz.leaderboard,
-            review: review(quiz, play)
-        };
-    });
-}
-

package/plugins/quiz/plugin.json

@@ -1,79 +0,0 @@
-{
-  "name": "quiz",
-  "displayName": "Quiz",
-  "version": "1.1.0",
-  "tier": "free",
-  "minCmsVersion": "1.8.33",
-  "description": "Make quizzes in the admin and put them on any page. Players type a name, answer against the clock, and see where they came on the leaderboard. The server keeps the time and marks every answer, so the browser never holds the answers.",
-  "author": "Domma CMS",
-  "date": "2026-10-21",
-  "icon": "help-circle",
-  "permissions": [
-    {
-      "key": "quiz",
-      "label": "Quiz",
-      "group": "Plugins",
-      "icon": "help-circle",
-      "description": "See quizzes and who played them (read), or make, change and remove quizzes and plays (manage).",
-      "actions": [
-        {
-          "key": "read",
-          "label": "See",
-          "description": "Open Quiz and see the quizzes, plays and leaderboards"
-        },
-        {
-          "key": "manage",
-          "label": "Manage",
-          "description": "Make, change and delete quizzes; hide or remove plays; reset a leaderboard"
-        }
-      ],
-      "grant": [
-        "admin"
-      ]
-    }
-  ],
-  "inject": {
-    "bodyEnd": "inject/body.html"
-  },
-  "admin": {
-    "css": [
-      "../_lib/admin/games/games.css",
-      "admin/css/index.css"
-    ],
-    "sidebar": [
-      {
-        "id": "quiz",
-        "text": "Quiz",
-        "icon": "help-circle",
-        "url": "#/plugins/quiz",
-        "section": "#/plugins/quiz",
-        "permission": "quiz",
-        "group": "Games",
-        "countUrl": "/api/plugins/quiz/count"
-      }
-    ],
-    "routes": [
-      {
-        "path": "/plugins/quiz",
-        "view": "plugin-quiz",
-        "title": "Quiz - Domma CMS"
-      },
-      {
-        "path": "/plugins/quiz/:a",
-        "view": "plugin-quiz",
-        "title": "Quiz - Domma CMS"
-      },
-      {
-        "path": "/plugins/quiz/:a/:b",
-        "view": "plugin-quiz",
-        "title": "Quiz - Domma CMS"
-      }
-    ],
-    "views": {
-      "plugin-quiz": {
-        "entry": "quiz/admin/views/quiz.js?v=1.1.0",
-        "exportName": "quizView"
-      }
-    }
-  }
-}

package/plugins/quiz/public/quiz.css

@@ -1,36 +0,0 @@
-/* Quiz - the player. Shared pieces (cards, clock, leaderboard) are in /plugins/_lib/public/games/games.css. */
-
-.qz-q { font-size: 1.35rem; line-height: 1.35; margin: 0 0 1rem; outline: none; }
-.qz-image { display: block; max-width: 100%; max-height: 320px; border-radius: 8px; margin: 0 0 1rem; }
-.qz-hint { margin: -.5rem 0 .75rem; }
-
-.qz-options { display: grid; gap: .6rem; }
-@media (min-width: 640px) { .qz-options { grid-template-columns: 1fr 1fr; } }
-.qz-option {
-    display: flex; align-items: center; gap: .75rem; width: 100%; text-align: left; font: inherit; cursor: pointer;
-    padding: .8rem 1rem; border-radius: 10px; border: 2px solid var(--gm-line); background: var(--gm-soft); color: inherit;
-    transition: border-color .12s, transform .12s;
-}
-.qz-option:hover:not(:disabled) { border-color: var(--gm-accent); transform: translateY(-1px); }
-.qz-option:focus-visible { outline: 2px solid var(--gm-accent); outline-offset: 2px; }
-.qz-option:disabled { cursor: default; opacity: .7; }
-.qz-option.is-picked { border-color: var(--gm-accent); background: color-mix(in srgb, var(--gm-accent) 15%, transparent); }
-.qz-letter {
-    flex: none; display: inline-grid; place-items: center; width: 1.8rem; height: 1.8rem; border-radius: 50%;
-    background: var(--gm-accent); color: #fff; font-weight: 700; font-size: .9rem;
-}
-.qz-typed { display: flex; flex-direction: column; gap: .35rem; max-width: 420px; }
-
-.qz-verdict { font-size: 1.8rem; margin: 0 0 .5rem; outline: none; }
-.qz-verdict.is-right { color: var(--gm-good); }
-.qz-verdict.is-wrong { color: var(--gm-bad); }
-
-.qz-review { margin-top: 1.5rem; }
-.qz-review h3 { margin: 0 0 .5rem; font-size: 1.1rem; }
-.qz-review-list { margin: 0; padding-left: 0; list-style: none; display: grid; gap: .5rem; }
-.qz-review-list li { padding: .6rem .8rem; border-radius: 8px; border-left: 4px solid var(--gm-line); background: var(--gm-soft); }
-.qz-review-list li.is-right { border-left-color: var(--gm-good); }
-.qz-review-list li.is-wrong { border-left-color: var(--gm-bad); }
-.qz-review-q { margin: 0 0 .25rem; font-weight: 600; }
-.qz-review-a { margin: 0; }
-.qz-live { position: absolute; left: -9999px; }