@o-a/cms-agent 0.5.0 → 0.5.1

package/dist/create-site/generate-site.js

@@ -124,6 +124,17 @@ export function scaffoldSite(targetDir) {
             tunnel: 'node server.js --tunnel',
             dev: 'node --watch-path=../theme server.js',
             check: 'check-site',
+            // seed-media is the package's own installed CLI bin, exposed
+            // as a script for exactly the same reason check is: there is
+            // no package.json or node_modules at the SITE root, only here
+            // in vhost/, so the obvious-looking `npx seed-media` run from
+            // the site directory resolves nothing locally, goes to the
+            // public registry for a package by that name and dies with
+            // E404 - while still exiting 0. That is not hypothetical: it
+            // is what sent a generated site's images into theme/root/
+            // instead of media/. Run it from here as
+            // `npm run seed-media -- .. <file>`.
+            'seed-media': 'seed-media',
         },
         dependencies: {
             // Pinned exact, never a ^range - at v0.x even a minor bump

package/dist/create-site/template/AGENTS.md

@@ -38,7 +38,7 @@ This scaffold already ships real, working examples worth reading before writing
 **Only these keywords are supported**: `type`, `properties`, `required`, `additionalProperties`, `default`, `minLength`, `maxLength`, `minimum`, `maximum`, `pattern`, `enum`, `items`, `minItems`, `maxItems`, plus the custom `format`/`title`/`description`/`allowedBlocks`/`api`/`swatches`/`step`/`unit` keywords documented below. **Never `$ref`, `$defs`, `definitions`, `allOf`, `anyOf`, `oneOf`, `not`, or `if`/`then`/`else`** - every property's schema must be fully self-contained, written out in full where it's used. If the same shape (e.g. an image object) repeats across several properties or several component files, write it out each time rather than trying to share/reference a definition - there is no cross-referencing mechanism here, in a single schema block or across files, regardless of what standard JSON Schema itself supports elsewhere.
 3. Once the theme components exist, compose an actual page by writing a file under `content/pages/` whose `sections` array references those types by filename, with a `settings` object matching each one's schema (see "Content JSON model" below).
 4. **For any page type the site will have more than one of** - a project, an article, a case study, a team member - also write a starting point for it under `theme/templates/<name>.json`. This is easy to skip and worth not skipping: without a template, every new page an editor creates starts completely blank, and they have to rebuild the same section stack by hand every time. A template is just a real page file kept in a different folder - the same shape as anything under `content/pages/` (`schemaVersion`, `name`, `title`, `type`, `layout`, `published`, `sections`), validated identically, using the section types this theme already defines. Its `"title"` is the label an editor picks from, so name it for the page type (`"Project"`, `"Article"`), never `"Untitled"`. **Set its `"type"` to that kind too** (`"project"`, `"article"`) - not `"page"`. Every page an editor creates from a template inherits the template's own `type`, and that value is what listings filter on, so an Article template left at `"type": "page"` silently produces articles no blog index can find. This is easy to get wrong because the template still validates and previews perfectly either way; nothing fails, the listing is simply always empty. Fill each section's settings with short placeholder copy rather than leaving them empty - a template is a starting point to edit, not a blank form. A template that fails validation is skipped silently at boot, so preview a page built from it.
-5. **Put every image through `seed-media` before referencing it - never copy image files into the repo by hand.** Photographs and other content images do not belong in the site root, in `theme/root/`, or in `theme/assets/`; they belong in `media/`, under a content-addressed filename the CMS generates. Run `npx seed-media . <file>...` from the site directory and use the `/media/...` URL it prints, as the `url` of a `format: "image"` setting rendered through the `responsive-media` snippet - never a hand-written `<img>`. See "Images" below for the detail and for how this changes once a server is running. Getting this wrong is quiet rather than loud: the page still renders, the image is simply missing.
+5. **Put every image through `seed-media` before referencing it - never copy image files into the repo by hand.** Photographs and other content images do not belong in the site root, in `theme/root/`, or in `theme/assets/`; they belong in `media/`, under a content-addressed filename the CMS generates. Run `npm run seed-media -- .. <file>...` from `vhost/` (the same place `npm run check` runs from) and use the `/media/...` URL it prints, as the `url` of a `format: "image"` setting rendered through the `responsive-media` snippet - never a hand-written `<img>`. See "Images" below for the detail and for how this changes once a server is running. Getting this wrong is quiet rather than loud: the page still renders, the image is simply missing.
 6. Preview the result, then run `npm run check` before considering the task done - it renders every page for real and fails on any image or link pointing at a file that does not exist, which is the fastest way to catch a misplaced image. See "Previewing your work".
 
 ### Worked example - a section
@@ -385,11 +385,14 @@ Guard the call on the url, as above. An unset image renders nothing at all rathe
 If you're writing starter content before a server is even running - so `POST /v1/media` isn't reachable yet - use the `seed-media` CLI instead of placing images under `theme/root/`. It computes the exact same content-addressed filename a real upload would, so the result is indistinguishable from one:
 
 ```
-npx seed-media <site-directory> photo.jpg another.png
+cd vhost
+npm run seed-media -- .. photo.jpg another.png
 # photo.jpg -> /media/photo-3f9a2b7c1e04.jpg
 # another.png -> /media/another-91cd4a08f2b1.png
 ```
 
+Run it from `vhost/`, not the site root. There is no `package.json` or `node_modules` at the site root - the CMS is installed under `vhost/` - so a bare `npx seed-media` there resolves nothing locally, goes to the public npm registry looking for a package called "seed-media", and fails with a 404 while still exiting 0.
+
 Then use the printed URL as the `url` of a `format: "image"` setting, exactly like a real upload's - not as a plain string:
 
 ```json
@@ -440,6 +443,8 @@ From `vhost/`, with the site's dependencies already installed (no need for the s
 npm run check
 ```
 
-Renders every published page for real and reports, in one pass: any theme component excluded at boot (same warnings the server itself prints, see "Minimal form" above); any `<img src>`/`srcset`/`<a href>` in the rendered HTML pointing at a `/media/`, `/assets/`, or root-static file that doesn't actually exist on disk; and any internal link that doesn't point at a real, published page. Exits non-zero if it finds anything - safe to run after generating content, not just as a manual spot-check.
+Renders every published page for real and reports, in one pass: any theme component excluded at boot (same warnings the server itself prints, see "Minimal form" above); any `src`/`srcset`/`poster`/`href` in the rendered HTML pointing at a `/media/`, `/assets/`, or root-static file that doesn't actually exist on disk; any internal link that doesn't point at a real, published page; and **any content image or video being served from `theme/root/` or `theme/assets/` instead of `media/`**. Exits non-zero if it finds anything - safe to run after generating content, not just as a manual spot-check.
+
+That last one has no other way of being noticed: the file exists, so the page renders perfectly. It is simply invisible to the media library and an editor can never replace it.
 
 This catches the specific failure mode a snippet like `responsive-image` can introduce silently: a `widths` list that includes a size nothing was actually uploaded/generated for renders a perfectly normal-looking page with one broken image at that breakpoint - nothing about the page itself is wrong, so nothing else would ever flag it.

package/dist/site-check/cli.js

@@ -10,6 +10,7 @@ const KIND_LABELS = {
     'render-error': 'Render error',
     'missing-asset': 'Missing asset',
     'broken-link': 'Broken link',
+    'misplaced-media': 'Misplaced media',
 };
 function printGrouped(findings) {
     const byKind = new Map();

package/dist/site-check/run-check.d.ts

@@ -1,4 +1,4 @@
-export type CheckFindingKind = 'schema' | 'render-error' | 'missing-asset' | 'broken-link';
+export type CheckFindingKind = 'schema' | 'render-error' | 'missing-asset' | 'broken-link' | 'misplaced-media';
 export interface CheckFinding {
     kind: CheckFindingKind;
     message: string;

package/dist/site-check/run-check.js

@@ -4,6 +4,7 @@ import { renderPage } from "../renderer/render-page.js";
 import { PathSafetyError, sanitisePath } from "../services/path-safety.js";
 import { buildSitemapUrls } from "../routes/sitemap.js";
 import { urlToPagePath } from "../services/urls.js";
+import { ALLOWED_UPLOAD_EXTENSIONS } from "../media/filename.js";
 // A reference this project's own theme conventions actually produce:
 // src="...", srcset="w1 480w, w2 960w" (comma-separated, each entry a
 // url then a space then a width descriptor - strip the descriptor),
@@ -11,25 +12,46 @@ import { urlToPagePath } from "../services/urls.js";
 // "the schema surface here is narrow and flat... a library would be
 // heavier than the problem warrants" precedent for the equivalent
 // choice on the admin side.
-const ATTR_PATTERN = /\b(?:src|href)="([^"]*)"|\bsrcset="([^"]*)"/g;
+// poster is included deliberately: a video's poster is a real content
+// image and was not being checked at all before.
+const ATTR_PATTERN = /\b(src|href|poster|srcset)="([^"]*)"/g;
 function extractReferences(html) {
     const refs = [];
     for (const match of html.matchAll(ATTR_PATTERN)) {
-        const [, single, srcset] = match;
-        if (single !== undefined) {
-            refs.push(single);
+        const attribute = match[1] ?? '';
+        const value = match[2] ?? '';
+        if (attribute !== 'srcset') {
+            refs.push({ url: value, attribute });
         }
-        else if (srcset !== undefined) {
-            for (const entry of srcset.split(',')) {
+        else {
+            for (const entry of value.split(',')) {
                 const url = entry.trim().split(/\s+/)[0];
                 if (url) {
-                    refs.push(url);
+                    refs.push({ url, attribute });
                 }
             }
         }
     }
     return refs;
 }
+// Any scheme at all that is not http(s). The previous version listed
+// data: explicitly and nothing else, so mailto: (and tel:, and anything
+// future) fell through to the static-file branch below and was reported
+// as a missing file under theme/root/, purely because the text after
+// the "@" contains a dot. One real site produced 39 such findings and
+// not one true one, which is worse than no check: it teaches whoever
+// reads the output to ignore it.
+function hasExternalScheme(ref) {
+    return ref.startsWith('//') || /^[a-z][a-z0-9+.-]*:/i.test(ref);
+}
+// A content photograph or clip, as opposed to a design asset. Keyed off
+// the same extension list the media upload route accepts, so the two
+// cannot drift; .svg is absent from it, which is what keeps an inline
+// logo or icon from being mistaken for misplaced content.
+function isUploadableMedia(path) {
+    const lower = path.toLowerCase();
+    return [...ALLOWED_UPLOAD_EXTENSIONS].some((extension) => lower.endsWith(extension));
+}
 // True for a root-relative static path that looks like a real file
 // (has a "." in its last path segment - /favicon.ico, /robots.txt),
 // as opposed to a page URL like /about or /blog/hello-world, which
@@ -48,6 +70,17 @@ function looksLikeStaticFile(path) {
 // escaping root) is exactly as real a finding as one that's simply
 // missing - reported the same way, not silently skipped.
 function checkStaticReference(findings, root, relativePath, originalPath, rootLabel, pageUrl) {
+    // sanitisePath realpaths its root unconditionally, so a site that has
+    // no media/, theme/assets/ or theme/root/ directory at all threw a
+    // raw ENOENT out of the whole check rather than reporting anything -
+    // the check crashing with a stack trace on exactly the sites most
+    // likely to hold a broken reference. A root that does not exist means
+    // the file underneath it does not exist either, which is an ordinary
+    // finding, not an error.
+    if (!existsSync(root)) {
+        findings.push({ kind: 'missing-asset', message: `${originalPath} does not exist under ${rootLabel}`, pageUrl });
+        return;
+    }
     try {
         const filePath = sanitisePath(root, relativePath);
         if (!existsSync(filePath)) {
@@ -62,6 +95,13 @@ function checkStaticReference(findings, root, relativePath, originalPath, rootLa
         throw error;
     }
 }
+// The file exists, so nothing else would ever flag it - which is
+// precisely why this needs saying. A content image outside media/ is
+// invisible to the media library, cannot be replaced by an editor, and
+// is not what the CMS manages.
+function misplacedMessage(path, where) {
+    return `${path} is a content image served from ${where} - it belongs in media/ (run \`npm run seed-media -- .. <file>\` from vhost/ and use the /media/... URL it prints)`;
+}
 export async function runSiteCheck(siteRoot) {
     const booted = bootSite(siteRoot);
     const findings = [];
@@ -86,18 +126,27 @@ export async function runSiteCheck(siteRoot) {
             findings.push({ kind: 'render-error', message: detail, pageUrl });
             continue;
         }
-        for (const ref of extractReferences(html)) {
-            if (ref.startsWith('http://') || ref.startsWith('https://') || ref.startsWith('data:') || ref.startsWith('//')) {
+        for (const { url: ref, attribute } of extractReferences(html)) {
+            if (hasExternalScheme(ref)) {
                 continue;
             }
             const path = ref.split(/[?#]/)[0] ?? ref;
+            // Only src/srcset/poster can carry a content image. An href is a
+            // link or a favicon, and flagging those would make this useless.
+            const rendersMedia = attribute !== 'href' && isUploadableMedia(path);
             if (path.startsWith('/media/')) {
                 checkStaticReference(findings, booted.config.mediaRoot, path.slice('/media/'.length), path, 'media/', pageUrl);
             }
             else if (path.startsWith('/assets/')) {
+                if (rendersMedia) {
+                    findings.push({ kind: 'misplaced-media', message: misplacedMessage(path, 'theme/assets/'), pageUrl });
+                }
                 checkStaticReference(findings, booted.config.assetsRoot, path.slice('/assets/'.length), path, 'theme/assets/', pageUrl);
             }
             else if (looksLikeStaticFile(path)) {
+                if (rendersMedia) {
+                    findings.push({ kind: 'misplaced-media', message: misplacedMessage(path, 'theme/root/'), pageUrl });
+                }
                 checkStaticReference(findings, booted.config.rootMirrorRoot, path.slice(1), path, 'theme/root/', pageUrl);
             }
             else if (path !== '' && !publishedUrlSet.has(path)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@o-a/cms-agent",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "type": "module",
   "publishConfig": {
     "access": "public"