@tideworthy/tidysites-platform 0.9.0 → 0.10.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.9.1
+
+- Editor: one editor on the site. An article page (a post, a service area, a page with the article layout) gets the bar too, with Publish from the entry's draft state, Business details and Done, over EmDash's inline prose editing; EmDash's own pill is hidden under the bar everywhere. Inside sections and record regions this editor owns the fields and EmDash's inline editor does not mount; outside them (article prose) it keeps working.
+
 ## 0.9.0
 
 - Editor: sections are an EmDash `blocks` field (`sections` by default), and the forms come from the seed's block type definitions (`slug`, `type`, `validation.options`, `subFields`) instead of Block Kit shapes. Fields render by EmDash type: string, text, url, number, integer, boolean, datetime, select, multiSelect, image (the media picker, storing EmDash's media value) and repeater; Portable Text and file fields say "edit in the admin". New blocks carry no `_version` so EmDash stamps the active one; a saved block keeps its `_type`, `_key` and `_version`, and fields the form read as empty are left out rather than written as null.

package/README.md

@@ -133,6 +133,10 @@ Applies the template seed's structure to a site that is already set up: block ty
 
 Runs EmDash's scheduled work now (scheduled publishing, cleanup) and returns what it published. Workers in a dispatch namespace never receive cron triggers, so the platform's cron calls this on every site each minute.
 
+### `GET|POST /_tidy/revisions`
+
+The site's revision history for the signed-in editor (the Astro session is the gate, no bearer). `GET ?path=/x` lists every publish; `GET ?id=<revision>&path=/x` returns that page as it was in the revision, read from the control plane's stored copy; `POST {action:"restore", id}` puts the live site and the staging content back on it; `POST {action:"publish"}` makes the live site follow staging now. The editor bar's Revisions and Publish live controls call it; `?tidy-revisions=1` on any page opens the list and `?tidy-revision=<id>` opens that revision of the page.
+
 ## Publish hooks
 
 The plugin registers `content:afterPublish`, `content:afterUnpublish`, and `content:afterDelete`. Each posts `{ reason, collection, id }` to `POST <TIDY_CONTROL_ORIGIN>/sites/<TIDY_SITE_ID>/publish` over the `PLATFORM` binding with the site secret as bearer. Hooks run with `errorPolicy: "continue"` and an 8 second timeout, so a slow or failing control plane never fails the editor's publish.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tideworthy/tidysites-platform",
-	"version": "0.9.0",
+	"version": "0.10.0",
 	"description": "The Tidysites platform integration for EmDash sites: bootstrap, sessions, maintenance, health, and publish hooks under /_tidy/*.",
 	"license": "MIT",
 	"type": "module",
@@ -30,7 +30,8 @@
 		"./routes/rotate-token": "./src/routes/rotate-token.ts",
 		"./routes/fill": "./src/routes/fill.ts",
 		"./routes/schema": "./src/routes/schema.ts",
-		"./routes/maintenance": "./src/routes/maintenance.ts"
+		"./routes/maintenance": "./src/routes/maintenance.ts",
+		"./routes/revisions": "./src/routes/revisions.ts"
 	},
 	"scripts": {
 		"typecheck": "tsc --noEmit -p tsconfig.json && tsc --noEmit -p tsconfig.editor.json",

package/src/editor/TidyEditor.astro

@@ -9,10 +9,10 @@
  * block with `data-tidy-block` (its key) and `data-tidy-type`, and wraps the
  * list in `data-tidy-blocks`. A record region (`data-tidy-record`,
  * `data-tidy-record-id`, `data-tidy-record-label`) gets an "Edit details"
- * chip whose form comes from EmDash's manifest. A page without blocks (an
- * article) gets the bar only; EmDash's inline editing handles its prose and
- * its toolbar shows there. While editing is off, EmDash's toolbar is hidden:
- * the bar is the one control. The bar sets `--tidy-bar` on <html> (its
+ * chip whose form comes from EmDash's manifest. A page without sections (an
+ * article) gets the bar too: Publish, Business details and Done over EmDash's
+ * inline prose editing, whose own pill is always hidden under the bar, so the
+ * site has one editor. The bar sets `--tidy-bar` on <html> (its
  * height) so a template's sticky header can sit below it.
  */
 import type { Block, BlockTypeSchema } from "./ops";
@@ -35,9 +35,12 @@ const signedIn = Boolean(Astro.session ? await Astro.session.get("user") : null)
 const active = Astro.cookies.get("emdash-edit-mode")?.value === "true";
 const here = Astro.url.pathname + Astro.url.search;
 const toggle = (on: boolean) => `/_tidy/edit?on=${on ? 1 : 0}&to=${encodeURIComponent(here)}`;
-const editable = active && Boolean(collection && id && blocks && value);
-const config = editable ? JSON.stringify({ collection, id, field, blocks, value, records, done: toggle(false) }) : null;
-const htmlClass = !signedIn ? "" : !active ? "tidy-has-bar tidy-idle" : editable ? "tidy-has-bar" : "tidy-has-bar tidy-inline";
+// Any entry page is editable: a sections page gets the frames and the picker,
+// an article page gets the bar (Publish, Business details, Done) over EmDash's
+// inline prose editing. One editor on the site, never two.
+const editable = active && Boolean(collection && id);
+const config = editable ? JSON.stringify({ collection, id, field, blocks: blocks ?? [], value: value ?? [], records, done: toggle(false) }) : null;
+const htmlClass = !signedIn ? "" : !active ? "tidy-has-bar tidy-idle" : "tidy-has-bar";
 ---
 {signedIn && (
 	<>
@@ -49,6 +52,7 @@ const htmlClass = !signedIn ? "" : !active ? "tidy-has-bar tidy-idle" : editable
 			</div>
 		</div>
 		<script is:inline define:vars={{ htmlClass }}>document.documentElement.className += " " + htmlClass;</script>
+		<script src="./revisions.ts"></script>
 	</>
 )}
 {config && (
@@ -58,7 +62,8 @@ const htmlClass = !signedIn ? "" : !active ? "tidy-has-bar tidy-idle" : editable
 	</>
 )}
 <style is:global>
-	.tidy-editing #emdash-toolbar, .tidy-idle #emdash-toolbar { display: none !important; }
+	/* EmDash's own pill never shows under the bar; its inline prose editing keeps working underneath. */
+	html.tidy-has-bar #emdash-toolbar { display: none !important; }
 	html.tidy-has-bar { --tidy-bar: 44px; }
 	html.tidy-has-bar body { padding-top: var(--tidy-bar); }
 	.tidy-bar { position: fixed; top: 0; left: 0; right: 0; height: var(--tidy-bar, 44px); z-index: 2147483000; display: flex; align-items: center; justify-content: space-between; gap: 12px; padding: 0 16px; box-sizing: border-box; background: #17211c; color: #fff; font: 500 13px/1 system-ui, sans-serif; box-shadow: 0 1px 0 rgba(255,255,255,.08), 0 6px 20px rgba(0,0,0,.18); }
@@ -115,4 +120,9 @@ const htmlClass = !signedIn ? "" : !active ? "tidy-has-bar tidy-idle" : editable
 	.tidy-add-item { display: grid; gap: 2px; text-align: left; padding: 10px 12px; border: 1px solid #d3dcd6; border-radius: 8px; background: #fff; cursor: pointer; font: inherit; }
 	.tidy-add-item:hover { border-color: #2b7fd1; background: rgba(43,127,209,.06); }
 	.tidy-add-item span { color: #4a5851; font-size: 13px; }
+	.tidy-viewer { position: fixed; inset: 0; z-index: 2147483002; display: flex; flex-direction: column; background: #fff; }
+	.tidy-viewer[hidden] { display: none; }
+	.tidy-viewer-bar { display: flex; align-items: center; gap: 8px; padding: 0 16px; height: 44px; background: #17211c; color: #fff; font: 500 13px/1 system-ui, sans-serif; }
+	.tidy-viewer-label { flex: 1; opacity: .85; }
+	.tidy-viewer-frame { flex: 1; width: 100%; border: 0; }
 </style>

package/src/editor/revisions.ts

@@ -0,0 +1,154 @@
+/// <reference lib="dom" />
+/// <reference lib="dom.iterable" />
+/**
+ * Revision history and Publish live, on the editor bar for anyone signed in,
+ * editing or not. Revisions are the site's publishes (the control plane keeps
+ * a full copy of each). Pick one and the page you are on shows as it was
+ * then; Restore puts the live site, and the staging content, back on it.
+ * Publish live makes the live site follow staging now.
+ *
+ * Deep links: ?tidy-revisions=1 opens the list; ?tidy-revision=<id> opens
+ * that revision of this page.
+ */
+
+interface Revision {
+	id: string;
+	at: string;
+	pages: number | null;
+	restoredFrom: string | null;
+}
+
+const ROUTE = "/_tidy/revisions";
+
+function el<K extends keyof HTMLElementTagNameMap>(tag: K, attrs: Record<string, string> = {}, children: Array<Node | string> = []): HTMLElementTagNameMap[K] {
+	const node = document.createElement(tag);
+	for (const [k, v] of Object.entries(attrs)) {
+		if (k === "class") node.className = v;
+		else if (k === "text") node.textContent = v;
+		else node.setAttribute(k, v);
+	}
+	for (const c of children) node.append(c);
+	return node;
+}
+
+function when(iso: string): string {
+	return new Date(iso).toLocaleString(undefined, { month: "short", day: "numeric", year: "numeric", hour: "numeric", minute: "2-digit" });
+}
+
+export function startRevisions(): void {
+	const actions = document.getElementById("tidy-bar-actions");
+	if (!actions) return;
+	const here = location.pathname;
+	const revBtn = el("button", { type: "button", class: "tidy-btn", text: "Revisions" });
+	const liveBtn = el("button", { type: "button", class: "tidy-btn", text: "Publish live" });
+	actions.prepend(revBtn, liveBtn);
+
+	// --- the panel --------------------------------------------------------
+	const panel = el("div", { class: "tidy-panel", hidden: "" });
+	document.body.append(panel);
+	let revisions: Revision[] = [];
+
+	async function load(): Promise<Revision[]> {
+		const r = await fetch(`${ROUTE}?path=${encodeURIComponent(here)}`, { credentials: "same-origin" });
+		if (!r.ok) throw new Error(`${r.status}`);
+		const j = (await r.json()) as { revisions: Revision[] };
+		revisions = j.revisions;
+		return revisions;
+	}
+
+	function close() {
+		panel.hidden = true;
+		panel.replaceChildren();
+		viewer.hidden = true;
+		frame.removeAttribute("srcdoc");
+	}
+
+	function renderList() {
+		const head = el("div", { class: "tidy-panel-head" }, [el("h2", { text: "Revisions" }), el("p", { text: "Every time the website was published. Open one to see this page as it was then." })]);
+		const list = el("div", { class: "tidy-add-list" });
+		revisions.forEach((rev, i) => {
+			const note = i === 0 ? "Live now" : rev.restoredFrom ? "Restored" : "";
+			const item = el("button", { type: "button", class: "tidy-add-item" }, [el("strong", { text: when(rev.at) }), el("span", { text: [note, rev.pages ? `${rev.pages} pages` : ""].filter(Boolean).join(" · ") })]);
+			item.addEventListener("click", () => void view(rev, i === 0));
+			list.append(item);
+		});
+		if (revisions.length === 0) list.append(el("p", { class: "tidy-field-note", text: "Nothing published yet." }));
+		const closeBtn = el("button", { type: "button", class: "tidy-btn", text: "Close" });
+		closeBtn.addEventListener("click", close);
+		panel.replaceChildren(head, list, el("div", { class: "tidy-panel-actions" }, [closeBtn]));
+		panel.hidden = false;
+	}
+
+	// --- the viewer: this page as it was in a revision --------------------
+	const viewer = el("div", { class: "tidy-viewer", hidden: "" });
+	const viewerBar = el("div", { class: "tidy-viewer-bar" });
+	const viewerLabel = el("span", { class: "tidy-viewer-label" });
+	const backBtn = el("button", { type: "button", class: "tidy-btn", text: "Back to revisions" });
+	const restoreBtn = el("button", { type: "button", class: "tidy-btn tidy-btn-primary", text: "Restore this version" });
+	const frame = el("iframe", { class: "tidy-viewer-frame", title: "This page in an earlier revision", sandbox: "allow-same-origin" });
+	viewerBar.append(viewerLabel, backBtn, restoreBtn);
+	viewer.append(viewerBar, frame);
+	document.body.append(viewer);
+	backBtn.addEventListener("click", () => { viewer.hidden = true; frame.removeAttribute("srcdoc"); renderList(); });
+
+	async function view(rev: Revision, isLive: boolean) {
+		panel.hidden = true;
+		viewerLabel.textContent = `${when(rev.at)}${isLive ? " · live now" : ""}`;
+		restoreBtn.hidden = isLive;
+		const r = await fetch(`${ROUTE}?id=${encodeURIComponent(rev.id)}&path=${encodeURIComponent(here)}`, { credentials: "same-origin" });
+		if (!r.ok) {
+			const j = (await r.json().catch(() => ({}))) as { error?: string };
+			frame.srcdoc = `<p style="font:15px system-ui;margin:2rem">${j.error ?? "This revision could not be read."}</p>`;
+		} else {
+			// The stored copy links its assets by absolute path; a base tag resolves them against the live site, where they still are.
+			const html = await r.text();
+			frame.srcdoc = html.replace(/<head([^>]*)>/i, `<head$1><base href="${location.origin}/"><style>html.tidy-has-bar body{padding-top:0!important}#tidy-bar,.tidy-bar{display:none!important}</style>`);
+		}
+		viewer.hidden = false;
+		restoreBtn.onclick = async () => {
+			if (!confirm(`Restore the website to ${when(rev.at)}?\n\nThe live site goes back to how it was then, and so does staging: every change made since is lost.`)) return;
+			restoreBtn.disabled = true;
+			restoreBtn.textContent = "Restoring";
+			const p = await fetch(ROUTE, { method: "POST", credentials: "same-origin", headers: { "content-type": "application/json" }, body: JSON.stringify({ action: "restore", id: rev.id }) });
+			if (p.ok) location.href = here;
+			else {
+				restoreBtn.disabled = false;
+				restoreBtn.textContent = "Restore failed. Try again";
+			}
+		};
+	}
+
+	revBtn.addEventListener("click", async () => {
+		if (!panel.hidden) return close();
+		try {
+			await load();
+			renderList();
+		} catch {
+			panel.replaceChildren(el("p", { class: "tidy-field-note", text: "The revisions could not be read right now." }));
+			panel.hidden = false;
+		}
+	});
+
+	liveBtn.addEventListener("click", async () => {
+		if (!confirm("Publish the website?\n\nEverything on staging goes live, every change made since the last publish.")) return;
+		liveBtn.disabled = true;
+		liveBtn.textContent = "Publishing";
+		const p = await fetch(ROUTE, { method: "POST", credentials: "same-origin", headers: { "content-type": "application/json" }, body: JSON.stringify({ action: "publish" }) });
+		liveBtn.disabled = false;
+		liveBtn.textContent = p.ok ? "Published" : "Publish failed";
+		setTimeout(() => (liveBtn.textContent = "Publish live"), 4000);
+	});
+
+	// Deep links from the platform.
+	const params = new URLSearchParams(location.search);
+	const want = params.get("tidy-revision");
+	if (want || params.get("tidy-revisions")) {
+		void load().then((list) => {
+			const rev = want ? list.find((x) => x.id === want) : null;
+			if (rev) void view(rev, list[0]?.id === rev.id);
+			else renderList();
+		}).catch(() => undefined);
+	}
+}
+
+startRevisions();

package/src/editor/runtime.ts

@@ -99,9 +99,11 @@ export function start(config: Config): void {
 	const schemaOf = (type: string) => config.blocks.find((b) => b.slug === type);
 	const frames = () => Array.from(document.querySelectorAll<HTMLElement>("[data-tidy-block]"));
 
-	// EmDash's inline editor is for prose pages; here the sections and records own their fields.
+	// Inside the sections and the record regions this editor owns the fields, so
+	// EmDash's inline editor must not mount there; article prose outside them
+	// keeps EmDash's in-place editing under this bar.
 	document.documentElement.classList.add("tidy-editing");
-	document.querySelectorAll("[data-emdash-ref]").forEach((n) => n.removeAttribute("data-emdash-ref"));
+	document.querySelectorAll("[data-tidy-blocks] [data-emdash-ref], [data-tidy-record] [data-emdash-ref]").forEach((n) => n.removeAttribute("data-emdash-ref"));
 
 	// --- pending publishes ---------------------------------------------------
 	// Records whose publish failed after a save; the page itself is read from EmDash.

package/src/index.ts

@@ -30,7 +30,8 @@ export const PLATFORM_ROUTES = [
 	{ pattern: "/_tidy/rotate-token", entrypoint: `${PACKAGE}/routes/rotate-token` },
 	{ pattern: "/_tidy/fill", entrypoint: `${PACKAGE}/routes/fill` },
 	{ pattern: "/_tidy/schema", entrypoint: `${PACKAGE}/routes/schema` },
-	{ pattern: "/_tidy/maintenance", entrypoint: `${PACKAGE}/routes/maintenance` }
+	{ pattern: "/_tidy/maintenance", entrypoint: `${PACKAGE}/routes/maintenance` },
+	{ pattern: "/_tidy/revisions", entrypoint: `${PACKAGE}/routes/revisions` }
 ] as const;
 
 /**

package/src/routes/revisions.ts

@@ -0,0 +1,74 @@
+/**
+ * /_tidy/revisions: the site's revision history for the signed-in editor,
+ * read from the control plane with the site's own secret. No bearer: the
+ * browser calls it from the editor bar, and the Astro session is the gate.
+ *
+ *   GET  ?path=/reviews            the revisions (every publish, newest first)
+ *   GET  ?id=<revision>&path=/x    the page as it was in that revision (HTML)
+ *   POST { action: "restore", id } put the live site (and staging) back on it
+ *   POST { action: "publish" }     make the live site follow staging now
+ */
+import type { APIContext, APIRoute } from "astro";
+import { workerEnv } from "../lib/env";
+import { isSafeLocalPath, json, readJson } from "../lib/http";
+import { methodNotAllowed } from "./_shared";
+
+export const prerender = false;
+
+interface ControlEnv {
+	TIDY_CONTROL_ORIGIN?: unknown;
+	TIDY_SITE_ID?: unknown;
+	TIDY_PLATFORM_SECRET?: unknown;
+	PLATFORM?: { fetch(input: string, init?: RequestInit): Promise<Response> };
+}
+
+async function control(context: APIContext): Promise<{ call(path: string, init?: RequestInit): Promise<Response> } | Response> {
+	const user = context.session ? await context.session.get("user") : null;
+	if (!user) return new Response("Unauthorized", { status: 401 });
+	const env = (await workerEnv()) as ControlEnv | undefined;
+	const origin = env?.TIDY_CONTROL_ORIGIN;
+	const siteId = env?.TIDY_SITE_ID;
+	const secret = env?.TIDY_PLATFORM_SECRET;
+	const platform = env?.PLATFORM;
+	if (!platform || typeof origin !== "string" || typeof siteId !== "string" || typeof secret !== "string") return new Response("Not found", { status: 404 });
+	const base = `${origin.replace(/\/+$/, "")}/sites/${encodeURIComponent(siteId)}`;
+	return {
+		call: (path, init = {}) => platform.fetch(`${base}${path}`, { ...init, headers: { authorization: `Bearer ${secret}`, ...(init.headers as Record<string, string> | undefined) } })
+	};
+}
+
+export const GET: APIRoute = async (context) => {
+	const c = await control(context);
+	if (c instanceof Response) return c;
+	const id = context.url.searchParams.get("id");
+	const rawPath = context.url.searchParams.get("path");
+	const path = isSafeLocalPath(rawPath) ? rawPath.replace(/[?#].*$/, "") : "/";
+	if (id) {
+		if (!/^[0-9a-f-]{36}$/i.test(id)) return json({ error: "bad revision id" }, 400);
+		const r = await c.call(`/releases/${id}/page?path=${encodeURIComponent(path)}`);
+		if (!r.ok) return json({ error: r.status === 404 ? "That page was not in this revision." : "The revision could not be read." }, r.status === 404 ? 404 : 502);
+		return new Response(await r.text(), { headers: { "content-type": "text/html; charset=utf-8", "cache-control": "no-store" } });
+	}
+	const r = await c.call("/releases");
+	if (!r.ok) return json({ error: "The revisions could not be read." }, 502);
+	const body = (await r.json().catch(() => ({}))) as { releases?: Array<{ deployId: string; at: string; pages?: number; restoredFrom?: string }> };
+	return json({ revisions: (body.releases ?? []).map((x) => ({ id: x.deployId, at: x.at, pages: x.pages ?? null, restoredFrom: x.restoredFrom ?? null })) }, 200, { "cache-control": "no-store" });
+};
+
+export const POST: APIRoute = async (context) => {
+	const c = await control(context);
+	if (c instanceof Response) return c;
+	const body = await readJson<{ action?: unknown; id?: unknown; keepContent?: unknown }>(context.request);
+	if (body.action === "publish") {
+		const r = await c.call("/publish-live", { method: "POST" });
+		return json(await r.json().catch(() => ({})), r.ok ? 200 : 502);
+	}
+	if (body.action === "restore") {
+		if (typeof body.id !== "string" || !/^[0-9a-f-]{36}$/i.test(body.id)) return json({ error: "bad revision id" }, 400);
+		const r = await c.call(`/releases/${body.id}/restore`, { method: "POST", headers: { "content-type": "application/json" }, body: JSON.stringify({ keepContent: body.keepContent === true }) });
+		return json(await r.json().catch(() => ({})), r.ok ? 200 : 502);
+	}
+	return json({ error: "action must be publish or restore" }, 400);
+};
+
+export const ALL = methodNotAllowed("GET, POST");

package/src/version.ts

@@ -1,3 +1,3 @@
 /** Kept in step with package.json by the release checklist in MAINTAINING.md. */
-export const VERSION = "0.9.0";
+export const VERSION = "0.10.0";
 export const PLUGIN_ID = "tidy-platform";