@tideworthy/tidysites-platform 0.10.6 → 0.10.8

package/CHANGELOG.md

@@ -1,16 +1,16 @@
 # Changelog
 
-## 0.10.6
+## 0.10.8
 
-- Editor: Publish live, Restore and Remove section confirm in a dialog of the editor's own, never the browser's box. The bar's note reads "A private copy to see working changes on the website, not publicly accessible."
+- Editor: Request a change, from the bar and a floating button at the corner. A panel takes what to change and which page (the current one by default) and hands it to the platform through the control plane (`POST /_tidy/change`); it shows up under Changes.
 
-## 0.10.5
+## 0.10.7
 
-- Editor bar: an interim note.
+- Editor: Publish live, Restore and Remove section confirm in a dialog of the editor's own, never the browser's box. The bar's note reads "A private copy to see working changes on the website, not publicly accessible."
 
-## 0.10.5
+## 0.10.5, 0.10.6
 
-- Editor: the bar's note reads "Changes here go live when you publish."
+- Editor bar: interim notes.
 
 ## 0.10.4
 

package/package.json

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

package/src/editor/TidyEditor.astro

@@ -55,7 +55,7 @@ const htmlClass = !signedIn ? (signInUrl ? "tidy-has-bar tidy-idle" : "") : !act
 {(signedIn || signInUrl) && (
 	<>
 		<div class="tidy-bar" id="tidy-bar" role="region" aria-label="Site editing">
-			<span class="tidy-bar-label"><span class="tidy-bar-dot" aria-hidden="true"></span>{label} website<span class="tidy-bar-note">Changes here go live when you publish.</span></span>
+			<span class="tidy-bar-label"><span class="tidy-bar-dot" aria-hidden="true"></span>{label} website<span class="tidy-bar-note">A private copy to see working changes on the website, not publicly accessible.</span></span>
 			<div class="tidy-bar-actions" id="tidy-bar-actions">
 				{!signedIn && <a class="tidy-btn tidy-btn-primary" href={signInUrl!}>Sign in to edit</a>}
 				{signedIn && !active && <a class="tidy-btn tidy-btn-primary" href={toggle(true)}>Edit</a>}
@@ -64,6 +64,7 @@ const htmlClass = !signedIn ? (signInUrl ? "tidy-has-bar tidy-idle" : "") : !act
 		</div>
 		<script is:inline define:vars={{ htmlClass }}>document.documentElement.className += " " + htmlClass;</script>
 		{signedIn && <script src="./revisions.ts"></script>}
+		{signedIn && <script src="./request.ts"></script>}
 	</>
 )}
 {config && (
@@ -135,6 +136,17 @@ const htmlClass = !signedIn ? (signInUrl ? "tidy-has-bar tidy-idle" : "") : !act
 	.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-fab { position: fixed; right: 20px; bottom: 20px; z-index: 2147483000; width: 52px; height: 52px; border-radius: 50%; border: 0; background: #2b7fd1; color: #fff; display: grid; place-items: center; cursor: pointer; box-shadow: 0 10px 30px rgba(0,0,0,.28); }
+	.tidy-fab:hover { background: #2470bd; }
+	.tidy-form { display: grid; gap: 14px; margin-bottom: 16px; }
+	.tidy-dialog-backdrop { position: fixed; inset: 0; z-index: 2147483003; display: grid; place-items: center; background: rgba(23,33,28,.45); padding: 16px; }
+	.tidy-dialog { width: min(440px, 100%); background: #fff; color: #17211c; border-radius: 12px; padding: 20px; box-shadow: 0 24px 60px rgba(0,0,0,.3); font: 14px/1.45 system-ui, sans-serif; }
+	.tidy-dialog h2 { margin: 0 0 6px; font-size: 17px; }
+	.tidy-dialog p { margin: 0 0 18px; color: #4a5851; }
+	.tidy-dialog-actions { display: flex; gap: 8px; justify-content: flex-end; }
+	.tidy-dialog .tidy-btn { color: #17211c; border-color: #c9d2cc; background: #fff; padding: 7px 14px; }
+	.tidy-dialog .tidy-btn-primary { background: #2b7fd1; border-color: #2b7fd1; color: #fff; }
+	.tidy-dialog .tidy-btn-danger { background: #b3261e; border-color: #b3261e; color: #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; }

package/src/editor/request.ts

@@ -0,0 +1,93 @@
+/**
+ * Request a change, from the staging site: a button on the bar and a
+ * floating one at the corner open a panel with the form; the request goes
+ * to the platform through /_tidy/change and shows up under Changes.
+ */
+const ROUTE = "/_tidy/change";
+
+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 === "text") node.textContent = v;
+		else node.setAttribute(k, v);
+	}
+	node.append(...children);
+	return node;
+}
+
+export function mountRequestChange(): void {
+	const actions = document.getElementById("tidy-bar-actions");
+	if (!actions) return;
+	const here = location.pathname + location.search;
+
+	const panel = el("div", { class: "tidy-panel", hidden: "" });
+	document.body.append(panel);
+	let sending = false;
+
+	function close() {
+		panel.hidden = true;
+		panel.replaceChildren();
+	}
+
+	function render() {
+		const head = el("div", { class: "tidy-panel-head" }, [el("h2", { text: "Request a change" }), el("p", { text: "Say what you would like changed. It shows up under Changes and someone picks it up." })]);
+		const body = el("textarea", { id: "tidy-change-body", rows: "7", maxlength: "10000", required: "" });
+		const page = el("input", { id: "tidy-change-page", type: "text", value: here });
+		const err = el("p", { class: "tidy-field-note", hidden: "" });
+		const cancel = el("button", { type: "button", class: "tidy-btn", text: "Cancel" });
+		const send = el("button", { type: "button", class: "tidy-btn tidy-btn-primary", text: "Send request" });
+		cancel.addEventListener("click", close);
+		send.addEventListener("click", async () => {
+			if (sending) return;
+			const text = body.value.trim();
+			if (!text) {
+				body.focus();
+				return;
+			}
+			sending = true;
+			send.disabled = true;
+			send.textContent = "Sending";
+			err.hidden = true;
+			const r = await fetch(ROUTE, { method: "POST", credentials: "same-origin", headers: { "content-type": "application/json" }, body: JSON.stringify({ body: text, pageUrl: page.value.trim() || null }) }).catch(() => null);
+			const j = ((await r?.json().catch(() => ({}))) ?? {}) as { ok?: boolean; error?: string };
+			sending = false;
+			if (r?.ok && j.ok) {
+				panel.replaceChildren(
+					el("div", { class: "tidy-panel-head" }, [el("h2", { text: "Request sent" }), el("p", { text: "It is under Changes now. You will hear back there." })]),
+					el("div", { class: "tidy-panel-actions" }, [el("button", { type: "button", class: "tidy-btn", text: "Close" })])
+				);
+				panel.querySelector("button")?.addEventListener("click", close);
+				return;
+			}
+			send.disabled = false;
+			send.textContent = "Send request";
+			err.textContent = j.error ?? "The request could not be sent. Try again.";
+			err.hidden = false;
+		});
+		panel.replaceChildren(
+			head,
+			el("div", { class: "tidy-form" }, [
+				el("div", { class: "tidy-field" }, [el("label", { class: "tidy-field-label", for: "tidy-change-body", text: "What would you like changed?" }), body]),
+				el("div", { class: "tidy-field" }, [el("label", { class: "tidy-field-label", for: "tidy-change-page", text: "Which page" }), page]),
+				err
+			]),
+			el("div", { class: "tidy-panel-actions" }, [cancel, send])
+		);
+		panel.hidden = false;
+		body.focus();
+	}
+
+	const barBtn = el("button", { type: "button", class: "tidy-btn", text: "Request a change" });
+	barBtn.addEventListener("click", render);
+	actions.prepend(barBtn);
+
+	const fab = el("button", { type: "button", class: "tidy-fab", title: "Request a change", "aria-label": "Request a change" });
+	fab.innerHTML = '<svg width="22" height="22" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M21 15a2 2 0 0 1-2 2H7l-4 4V5a2 2 0 0 1 2-2h14a2 2 0 0 1 2 2z"/></svg>';
+	fab.addEventListener("click", render);
+	document.body.append(fab);
+	document.addEventListener("keydown", (e) => {
+		if (e.key === "Escape" && !panel.hidden) close();
+	});
+}
+
+mountRequestChange();

package/src/index.ts

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

package/src/routes/change.ts

@@ -0,0 +1,48 @@
+/**
+ * /_tidy/change: a change request from the signed-in person on the staging
+ * site, handed to the platform through the control plane with the site's
+ * own secret. The Astro session is the gate; the person's name and email
+ * come from the site's user record.
+ *
+ *   POST { body, pageUrl? }  → { ok, changeId }
+ */
+import type { APIRoute } from "astro";
+import { isSafeLocalPath, json, readJson } from "../lib/http";
+import { methodNotAllowed, platformRoute } 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> };
+}
+
+export const POST: APIRoute = platformRoute(
+	async (context, deps, rawEnv) => {
+		const session = context.session ? ((await context.session.get("user")) as { id?: string } | null) : null;
+		if (!session?.id) return new Response("Unauthorized", { status: 401 });
+		const env = rawEnv as ControlEnv;
+		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 json({ error: "not configured" }, 503);
+		const input = await readJson<{ body?: unknown; pageUrl?: unknown }>(context.request);
+		const body = typeof input.body === "string" ? input.body.trim() : "";
+		if (!body) return json({ error: "Say what you would like changed." }, 400);
+		const pageUrl = isSafeLocalPath(input.pageUrl) ? input.pageUrl : null;
+		const user = await deps.store.findUserById(session.id);
+		const r = await platform.fetch(`${origin.replace(/\/+$/, "")}/sites/${encodeURIComponent(siteId)}/changes`, {
+			method: "POST",
+			headers: { authorization: `Bearer ${secret}`, "content-type": "application/json" },
+			body: JSON.stringify({ body: body.slice(0, 10_000), pageUrl, requester: user ? { name: user.name, email: user.email } : null })
+		});
+		const j = (await r.json().catch(() => ({}))) as Record<string, unknown>;
+		return json(r.ok ? { ok: true, changeId: j.changeId ?? null } : { error: (j.error as string) ?? "The request could not be sent." }, r.ok ? 200 : 502, { "cache-control": "no-store" });
+	},
+	{ requireBearer: false }
+);
+
+export const ALL = methodNotAllowed("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.10.6";
+export const VERSION = "0.10.8";
 export const PLUGIN_ID = "tidy-platform";