@geekity/cms 0.14.0 → 0.16.0

package/dist/admin/documents.js

@@ -1,9 +1,12 @@
 import { mkdir, readFile, rename, rm } from 'node:fs/promises';
 import path from 'node:path';
+import { CITATION_PROPERTIES, citationText } from '../content/citation.js';
 import { renderMarkdown } from '../content/markdown.js';
 import { parseDocument } from '../content/parser.js';
 import { PINNED_FRONT_MATTER_KEY, PINNED_POST_LIMIT, pinnedAt } from '../content/pinned.js';
 import { postLabel, replyTarget } from '../content/post-type.js';
+import { ENCLOSURE_FRONT_MATTER_KEY, enclosureOf, isWebUrl, TRANSCRIPT_TYPES, } from '../content/enclosure.js';
+import { PHOTO_FRONT_MATTER_KEY, photoFrontMatter } from '../content/photo.js';
 import { contentFilePath, freeSlug, saveDocument } from '../content/save.js';
 import { scheduledFor } from '../content/schedule.js';
 import { htmlToText } from '../content/search.js';
@@ -11,7 +14,7 @@ import { defaultPermalink, slugify } from '../content/slug.js';
 import { DuplicatePermalinkError, isTrashedPath, TRASH_DIRECTORY } from '../content/store.js';
 import { calendarDayIn, DEFAULT_TIMEZONE, toUtcInstant, wallClockIn, zoneLabel, } from '../content/time.js';
 import { normalizeBody, serializeDocument } from '../content/writer.js';
-import { readAltTexts, undescribedImages } from '../images/alt-text.js';
+import { readAltTexts, undescribedImages, undescribedPhotos } from '../images/alt-text.js';
 import { isPublicDocument } from '../web/documents.js';
 import { LANG_FRONT_MATTER_KEY } from '../web/locale.js';
 import { absoluteUrl } from '../web/negotiate.js';
@@ -26,6 +29,9 @@ import { PREVIEW_PATH } from './preview.js';
 import { ADMIN_PREFIX } from './session.js';
 import { ADMIN_TEMPLATES } from './templates.js';
 import { UPLOADS_PATH } from './uploads.js';
+import { BLANK_ALTERNATE_ROW, BLANK_ENCLOSURE_FORM, ENCLOSURE_FIELDS, enclosureChoices, enclosureForm, enclosureFrontMatter, readEnclosureForm, resolveEnclosure, } from './enclosure-field.js';
+import { PHOTO_FIELDS, photoChoices, photoRows, photoRowViews, readPhotoForm, resolvePhotos, } from './photo-field.js';
+import { SYNDICATE_TO_FRONT_MATTER_KEY, syndicateToOf, syndicationTargetsReader, } from '../webmention/syndication.js';
 /**
  * The Eleventy key that keeps a document out of every collection.
  *
@@ -183,14 +189,9 @@ export function mountDocumentScreens(app, options) {
     });
 }
 /**
- * Write what the editor submitted.
- *
- * The order matters: the form is read and checked before anything is touched,
- * the on-disk file is re-hashed and compared with the hash the form loaded with
- * (doc-1's conflict rule), and only then is a file written. A save that is
- * refused — a page with no title, an unreadable date, a stale hash, a URL
- * another document already holds — leaves the content directory exactly as it
- * was.
+ * Write what the editor submitted through {@link writeDocument}, and answer
+ * with the editor again: the refusal on the form, the conflict side by side,
+ * or the saved document under a flash.
  */
 async function saveFromForm(c, options) {
     const { kind, render, document, body } = options;
@@ -206,12 +207,20 @@ async function saveFromForm(c, options) {
         description: text(body['description']).trim(),
         author: text(body['author']).trim(),
         inReplyTo: text(body['in-reply-to']).trim(),
+        ...citationFields((property) => (kind.type === 'post' ? text(body[property]).trim() : '')),
         lang: text(body['lang']).trim(),
         draft: body['draft'] !== undefined,
         exclude: body['exclude'] !== undefined,
         contact: body['contact'] !== undefined,
         pinned: kind.type === 'post' && body['pinned'] !== undefined,
         comments: commentSetting(text(body['comments'])),
+        enclosure: kind.type === 'post' ? readEnclosureForm(body) : BLANK_ENCLOSURE_FORM,
+        photos: kind.type === 'post' ? readPhotoForm(body) : [],
+        syndicateTo: kind.type === 'post'
+            ? syndicationTargetsReader(contentDir)()
+                .filter((target) => body[syndicateToField(target)] !== undefined)
+                .map((target) => target.id)
+            : [],
         body: normalizeBody(text(body['body'])),
         hash: text(body['hash']),
     };
@@ -229,46 +238,109 @@ async function saveFromForm(c, options) {
             status: 400,
         });
     }
+    const written = await writeDocument({
+        store,
+        config: c.var.config,
+        announce: c.var.announce,
+        writer: currentUsername(c),
+    }, { kind, document, form, draft });
+    if (written.outcome === 'refused')
+        return refuse(written.message);
+    if (written.outcome === 'conflict') {
+        return renderConflict(c, {
+            kind,
+            render,
+            document: written.document,
+            form: { ...form, draft },
+            media: written.media,
+            conflict: written.conflict,
+        });
+    }
+    const { saved, undescribed } = written;
+    flash(c, 'notice', savedMessage(kind, document, saved, store.now()));
+    if (undescribed.length > 0)
+        flash(c, 'warning', missingAltText(undescribed));
+    return c.redirect(editorPath(kind, saved.slug), 303);
+}
+/**
+ * The write path behind the editor and Micropub (TASK-164): one form in, one
+ * file out, announced to every subscriber.
+ *
+ * The order matters: the form is checked before anything is touched, the
+ * on-disk file is re-hashed and compared with the hash the form loaded with
+ * (doc-1's conflict rule), and only then is a file written. A write that is
+ * refused leaves the content directory exactly as it was.
+ */
+export async function writeDocument(site, write) {
+    const { store, config, writer } = site;
+    const { kind, document, form, draft } = write;
+    const contentDir = config.contentDir;
+    function refused(message) {
+        return { outcome: 'refused', message };
+    }
     // A post with no title is a note; a page is always named.
     if (form.title === '' && kind.type === 'page') {
-        return refuse(`A ${kind.singular} needs a title.`);
+        return refused(`A ${kind.singular} needs a title.`);
     }
     // A post is a reply only when the target is a URL (Post Type Discovery), so
     // anything else would be saved as a reply that is not one.
     if (kind.type === 'post' && form.inReplyTo !== '' && replyTarget(form) === undefined) {
-        return refuse('In reply to has to be a web address, like https://example.com/a-post/.');
+        return refused('In reply to has to be a web address, like https://example.com/a-post/.');
+    }
+    if (kind.type === 'post') {
+        for (const property of CITATION_PROPERTIES) {
+            const cited = form[CITATION_FIELDS[property]];
+            if (cited !== '' && !isWebUrl(cited)) {
+                return refused(`${CITATION_LABELS[property]} has to be a web address, like https://example.com/a-post/.`);
+            }
+        }
     }
     if (form.lang !== '' && !LANGUAGE_TAG_PATTERN.test(form.lang)) {
-        return refuse('That is not a language tag, such as en, fr or pt-BR.');
+        return refused('That is not a language tag, such as en, fr or pt-BR.');
+    }
+    let media = { recording: undefined, photos: [] };
+    if (kind.type === 'post') {
+        const resolved = resolveEnclosure(form.enclosure, document === undefined ? undefined : enclosureOf(document.extra), contentDir);
+        if ('error' in resolved)
+            return refused(resolved.error);
+        const photos = resolvePhotos(form.photos, contentDir);
+        if ('error' in photos)
+            return refused(photos.error);
+        media = { recording: resolved.enclosure, photos: photos.photos };
     }
     // TASK-207: a pin is new when the file does not carry one yet, and only a
     // new one can take an author past Mastodon's limit.
     if (form.pinned && (document === undefined || pinnedAt(document) === undefined)) {
-        const users = listUsers(c.var.config.dataDir);
-        const author = userForAuthor(users, chosenAuthor(c, form.author, document) ?? '');
+        const users = listUsers(config.dataDir);
+        const author = userForAuthor(users, chosenAuthor(config.dataDir, form.author, document, writer) ?? '');
         const names = author === undefined ? [] : authorNames(users, author);
         if (store.listPinnedByAuthor(names).length >= PINNED_POST_LIMIT) {
-            return refuse(`You can pin up to ${String(PINNED_POST_LIMIT)} posts. Unpin one first.`);
+            return refused(`You can pin up to ${String(PINNED_POST_LIMIT)} posts. Unpin one first.`);
         }
     }
     // TASK-141: an image nobody described is a problem to fix before readers
     // meet it. A draft is not checked, since nobody meets a draft.
+    // A photo counts too, unless the media library describes it (TASK-166).
+    const library = readAltTexts(contentDir);
     const undescribed = draft
         ? []
-        : undescribedImages(renderMarkdown(form.body), readAltTexts(contentDir));
-    if (undescribed.length > 0 && c.var.config.requireAltText) {
-        return refuse(`This site publishes no image without alt text. ${missingAltText(undescribed)}`);
+        : [
+            ...undescribedPhotos(media.photos, library),
+            ...undescribedImages(renderMarkdown(form.body), library),
+        ];
+    if (undescribed.length > 0 && config.requireAltText) {
+        return refused(`This site publishes no image without alt text. ${missingAltText(undescribed)}`);
     }
-    const timezone = siteTimezone(c);
+    const timezone = readSiteSettings(contentDir).timezone;
     // decision-11: what the file gets is a UTC instant, and an offset-less field
     // is the site's own wall clock rather than the server's.
     const typed = kind.dated ? (form.date === '' ? store.now().toISOString() : form.date) : undefined;
     if (typed !== undefined && !/^\d{4}-\d{2}-\d{2}/.test(typed)) {
-        return refuse('A date has to start with a year, a month and a day, like 2026-03-04.');
+        return refused('A date has to start with a year, a month and a day, like 2026-03-04.');
     }
     const date = typed === undefined ? undefined : toUtcInstant(typed, timezone);
     if (typed !== undefined && date === undefined) {
-        return refuse('That date is not one anybody can read. Try 2026-03-04 09:00.');
+        return refused('That date is not one anybody can read. Try 2026-03-04 09:00.');
     }
     const slug = slugify(form.slug) ||
         slugify(form.title) ||
@@ -307,11 +379,11 @@ async function saveFromForm(c, options) {
     if (document !== undefined) {
         const conflict = await conflictWith(contentDir, document, form.hash);
         if (conflict !== undefined) {
-            return renderConflict(c, { kind, render, document, form: { ...form, draft }, conflict });
+            return { outcome: 'conflict', document, media, conflict };
         }
     }
     if (target !== document?.path && store.getByPath(target) !== undefined) {
-        return refuse(`Another ${kind.singular} already lives in ${target}.`);
+        return refused(`Another ${kind.singular} already lives in ${target}.`);
     }
     const content = {
         title: form.title,
@@ -323,10 +395,10 @@ async function saveFromForm(c, options) {
         categories: kind.categorised ? splitTags(form.categories) : [],
         draft,
         ...(form.description === '' ? {} : { description: form.description }),
-        ...optional('author', chosenAuthor(c, form.author, document)),
+        ...optional('author', chosenAuthor(config.dataDir, form.author, document, writer)),
         ...optional('inReplyTo', replyTo(kind, form, document)),
-        ...optional('activitypub', keptIdentity(document, promised, permalink, c.var.config.baseUrl)),
-        extra: resolveExtra(kind, document, form, store.now()),
+        ...optional('activitypub', keptIdentity(document, promised, permalink, config.baseUrl)),
+        extra: resolveExtra(kind, document, form, store.now(), media, syndicationTargetsReader(contentDir)()),
         body: form.body,
     };
     // The row for the old path goes first: a rename briefly leaves two rows
@@ -343,7 +415,7 @@ async function saveFromForm(c, options) {
         if (renamedFrom !== undefined)
             store.upsert(renamedFrom);
         if (error instanceof DuplicatePermalinkError)
-            return refuse(error.message);
+            return refused(error.message);
         throw error;
     }
     if (renamedFrom !== undefined) {
@@ -355,17 +427,14 @@ async function saveFromForm(c, options) {
     // back to the file — the federation stamping `activitypub` into a post it
     // has just announced — has finished before the editor is reloaded with a
     // hash that would otherwise be one save behind.
-    await c.var.announce({
+    await site.announce({
         type: document === undefined ? 'created' : 'updated',
         path: saved.path,
         previous: document,
         next: saved,
         origin: 'admin',
     });
-    flash(c, 'notice', savedMessage(kind, document, saved, store.now()));
-    if (undescribed.length > 0)
-        flash(c, 'warning', missingAltText(undescribed));
-    return c.redirect(editorPath(kind, saved.slug), 303);
+    return { outcome: 'saved', saved, undescribed };
 }
 /** What a save says about the images it found with no alt text, naming each. */
 function missingAltText(images) {
@@ -546,8 +615,38 @@ function normalizePermalink(value) {
  * the `false` is written, because a key somebody wrote by hand is not the
  * editor's to delete.
  */
-function resolveExtra(kind, document, form, now) {
+function resolveExtra(kind, document, form, now, media, declared) {
     const extra = { ...(document?.extra ?? {}) };
+    if (kind.type === 'post') {
+        if (media.recording === undefined)
+            delete extra[ENCLOSURE_FRONT_MATTER_KEY];
+        else
+            extra[ENCLOSURE_FRONT_MATTER_KEY] = enclosureFrontMatter(media.recording);
+        if (media.photos.length === 0)
+            delete extra[PHOTO_FRONT_MATTER_KEY];
+        else
+            extra[PHOTO_FRONT_MATTER_KEY] = photoFrontMatter(media.photos);
+        for (const property of CITATION_PROPERTIES) {
+            const cited = form[CITATION_FIELDS[property]];
+            if (cited === '')
+                delete extra[property];
+            else
+                extra[property] = cited;
+        }
+    }
+    // The checkboxes speak for the targets the site declares (TASK-155). An id
+    // the file lists that names no declared target has no checkbox, so it is
+    // kept as written rather than lost to a save.
+    if (kind.type === 'post') {
+        const offered = new Set(declared.map((target) => target.id));
+        const kept = syndicateToOf(extra).filter((id) => !offered.has(id));
+        // A form loaded from the file (a Micropub update) already holds those ids.
+        const listed = [...new Set([...form.syndicateTo, ...kept])];
+        if (listed.length === 0)
+            delete extra[SYNDICATE_TO_FRONT_MATTER_KEY];
+        else
+            extra[SYNDICATE_TO_FRONT_MATTER_KEY] = listed;
+    }
     // The moment a post was pinned is what orders the featured collection, so a
     // pin the file already carries keeps its moment through every later save,
     // and unpinning takes the key out rather than writing `false` (TASK-207).
@@ -589,6 +688,10 @@ function resolveExtra(kind, document, form, now) {
     }
     return extra;
 }
+/** The editor checkbox that selects one syndication target. */
+function syndicateToField(target) {
+    return `${SYNDICATE_TO_FRONT_MATTER_KEY}-${target.id}`;
+}
 /**
  * A comma-separated taxonomy field as a list, without the blanks and the
  * repeats. Tags and categories are both entered this way.
@@ -624,11 +727,11 @@ function currentUsername(c) {
  * is either a hand-made request or a user deleted between the load and the
  * save, and neither is a reason to reattribute somebody's post.
  */
-function chosenAuthor(c, submitted, document) {
-    const named = userForAuthor(listUsers(c.var.config.dataDir), submitted);
+function chosenAuthor(dataDir, submitted, document, writer) {
+    const named = userForAuthor(listUsers(dataDir), submitted);
     if (named !== undefined)
         return named.username;
-    return document?.author ?? currentUsername(c);
+    return document?.author ?? writer;
 }
 /**
  * The Author select: every user, whoever the document names, and — for a file
@@ -714,7 +817,7 @@ function renderConflict(c, options) {
         ...optional('author', document.author),
         ...optional('inReplyTo', replyTo(kind, form, document)),
         ...optional('activitypub', document.activitypub),
-        extra: resolveExtra(kind, document, form, c.var.store.now()),
+        extra: resolveExtra(kind, document, form, c.var.store.now(), options.media, syndicationTargetsReader(c.var.config.contentDir)()),
         body: form.body,
     });
     c.status(409);
@@ -735,23 +838,41 @@ function renderConflict(c, options) {
     });
 }
 /**
- * Move a document into `content/_trash/` or back out of it.
- *
- * The trash mirrors the content tree — `posts/2026-03-04-x.md` becomes
- * `_trash/posts/2026-03-04-x.md` — so restoring is the same move backwards and
- * needs to remember nothing. The index is corrected as soon as the file has
- * landed rather than waiting for the watcher, so the public site stops or
- * starts serving the document with this request (doc-1).
+ * Move a document into the trash or back out of it from the editor, and go
+ * back where the form came from.
  */
 async function moveDocument(c, options) {
     const { kind, document, action } = options;
-    const store = c.var.store;
-    const contentDir = c.var.config.contentDir;
     const trashed = isTrashedPath(document.path);
     if (action === 'trash' && trashed)
         return backTo(c, options, `It is already in the trash.`);
     if (action === 'restore' && !trashed)
         return backTo(c, options, `It is not in the trash.`);
+    const moved = await moveDocumentFile({ store: c.var.store, contentDir: c.var.config.contentDir, announce: c.var.announce }, document, action);
+    if (moved === undefined) {
+        return backTo(c, options, `Could not move ${document.path}. Is the file still there?`);
+    }
+    const message = action === 'trash'
+        ? `Moved to the trash: ${postLabel(document)}`
+        : `Restored: ${postLabel(document)}`;
+    flash(c, 'notice', message);
+    return c.redirect(returnPath(options.returnTo) ??
+        (action === 'trash' ? kind.basePath : editorPath(kind, document.slug)), 303);
+}
+/**
+ * Move a document into `content/_trash/` or back out of it, the move behind
+ * the editor's trash and restore and Micropub's delete and undelete
+ * (TASK-167). The document is the moved one, or `undefined` when its file
+ * could not be moved.
+ *
+ * The trash mirrors the content tree — `posts/2026-03-04-x.md` becomes
+ * `_trash/posts/2026-03-04-x.md` — so restoring is the same move backwards and
+ * needs to remember nothing. The index is corrected as soon as the file has
+ * landed rather than waiting for the watcher, so the public site stops or
+ * starts serving the document with this request (doc-1).
+ */
+export async function moveDocumentFile(site, document, action) {
+    const { store, contentDir } = site;
     const target = action === 'trash'
         ? `${TRASH_DIRECTORY}/${document.path}`
         : document.path
@@ -767,26 +888,21 @@ async function moveDocument(c, options) {
         await rename(from, to);
     }
     catch {
-        return backTo(c, options, `Could not move ${document.path}. Is the file still there?`);
+        return undefined;
     }
     const moved = parseDocument(source, { path: target, type: document.type });
     store.remove(document.path);
     store.upsert(moved);
     // Trashing takes a post off the public site and restoring puts it back, so
     // both are visibility changes a subscriber has to hear about.
-    await c.var.announce({
+    await site.announce({
         type: 'updated',
         path: target,
         previous: document,
         next: moved,
         origin: 'admin',
     });
-    const message = action === 'trash'
-        ? `Moved to the trash: ${postLabel(document)}`
-        : `Restored: ${postLabel(document)}`;
-    flash(c, 'notice', message);
-    return c.redirect(returnPath(options.returnTo) ??
-        (action === 'trash' ? kind.basePath : editorPath(kind, document.slug)), 303);
+    return moved;
 }
 /** Report a move that did not happen and go back where the form came from. */
 function backTo(c, options, message) {
@@ -823,6 +939,29 @@ function replyTo(kind, form, document) {
         return document?.inReplyTo;
     return form.inReplyTo === '' ? undefined : form.inReplyTo;
 }
+/**
+ * The editor field each citing property fills (TASK-169). The form submits it
+ * under the property's own name, as `in-reply-to` is.
+ */
+export const CITATION_FIELDS = {
+    'repost-of': 'repostOf',
+    'like-of': 'likeOf',
+    'bookmark-of': 'bookmarkOf',
+};
+/** What the editor calls each citing field, which a refusal names. */
+const CITATION_LABELS = {
+    'repost-of': 'Repost of',
+    'like-of': 'Like of',
+    'bookmark-of': 'Bookmark of',
+};
+/** The three citing fields, each filled from its property. */
+function citationFields(value) {
+    return {
+        repostOf: value('repost-of'),
+        likeOf: value('like-of'),
+        bookmarkOf: value('bookmark-of'),
+    };
+}
 /**
  * The editor for a document that does not exist yet.
  *
@@ -844,12 +983,16 @@ export function blankForm(kind, timezone = DEFAULT_TIMEZONE, now = new Date()) {
         // {@link authorChoices} is where the default is applied.
         author: '',
         inReplyTo: '',
+        ...citationFields(() => ''),
         lang: '',
         draft: false,
         exclude: false,
         contact: false,
         pinned: false,
         comments: COMMENT_SETTINGS.site,
+        enclosure: BLANK_ENCLOSURE_FORM,
+        photos: [],
+        syndicateTo: [],
         body: '',
         hash: '',
     };
@@ -873,6 +1016,8 @@ export function formFor(document, timezone = DEFAULT_TIMEZONE) {
         description: document.description ?? '',
         author: document.author ?? '',
         inReplyTo: document.inReplyTo ?? '',
+        // As the file spells it, so a save writes back what it read.
+        ...citationFields((property) => document.type === 'post' ? citationText(document.extra[property]) : ''),
         lang: typeof document.extra[LANG_FRONT_MATTER_KEY] === 'string'
             ? document.extra[LANG_FRONT_MATTER_KEY]
             : '',
@@ -881,6 +1026,9 @@ export function formFor(document, timezone = DEFAULT_TIMEZONE) {
         contact: document.extra[CONTACT_FRONT_MATTER_KEY] === true,
         pinned: pinnedAt(document) !== undefined,
         comments: commentSettingOf(document),
+        enclosure: document.type === 'post' ? enclosureForm(document) : BLANK_ENCLOSURE_FORM,
+        photos: document.type === 'post' ? photoRows(document) : [],
+        syndicateTo: document.type === 'post' ? syndicateToOf(document.extra) : [],
         body: document.body,
         hash: document.hash,
     };
@@ -893,7 +1041,7 @@ export function formFor(document, timezone = DEFAULT_TIMEZONE) {
  * Update, and anything that exists can be thrown away or, if it already has
  * been, restored.
  */
-function renderEditor(c, options) {
+async function renderEditor(c, options) {
     const { kind, document, form } = options;
     const trashed = document !== undefined && isTrashedPath(document.path);
     const now = c.var.store.now();
@@ -925,6 +1073,23 @@ function renderEditor(c, options) {
         actions,
         trashed,
         commentSettings: COMMENT_SETTINGS,
+        ...(kind.type === 'post'
+            ? {
+                enclosureFields: ENCLOSURE_FIELDS,
+                enclosureChoices: await enclosureChoices(c.var.config.contentDir, form.enclosure.url),
+                transcriptTypes: TRANSCRIPT_TYPES,
+                alternateRows: [...form.enclosure.alternates, BLANK_ALTERNATE_ROW],
+                photoFields: PHOTO_FIELDS,
+                photoRows: photoRowViews(form.photos, readAltTexts(c.var.config.contentDir)),
+                photoChoices: await photoChoices(c.var.config.contentDir),
+                // TASK-155: one checkbox per target the site declares.
+                syndicationTargets: syndicationTargetsReader(c.var.config.contentDir)().map((target) => ({
+                    ...target,
+                    field: syndicateToField(target),
+                    checked: form.syndicateTo.includes(target.id),
+                })),
+            }
+            : {}),
         // Who this can be attributed to, and who it is attributed to now.
         authors: authorChoices(c, form.author),
         // What an empty Language field means.