@coywolf/emdash 0.0.0-stage → 0.35.13

package/src/schema/og-image.ts

@@ -0,0 +1,100 @@
+/**
+ * The page's og:image with Clean image URLs on: the default OG image at a
+ * clean 1200x630 URL, the page's own media-library image as the original
+ * file on the media host, and the Open Graph tags for it. Pure (no I/O), so
+ * tests can load it; the media lookups are in module.ts.
+ */
+import type { PageMetadataContribution } from "emdash";
+
+import { FORMATS, cdnOriginalUrl, cleanImagePath, imageCdn, mediaFile, mimeForExt, parseCdnUrl, parseImagePath } from "../images/lib.js";
+import { type ImageInfo, absolute } from "./graph.js";
+
+export const OG_WIDTH = 1200;
+export const OG_HEIGHT = 630;
+
+/**
+ * The site's default OG image as a clean 1200x630 URL. On the media host,
+ * /s/1200x630/<file> (the host serves the original format to crawlers that
+ * don't ask for WebP or AVIF, so the type is the original's). Otherwise the
+ * Worker route, where PNG stays PNG and anything else becomes JPEG. Null when
+ * it isn't a (raster) media-library image.
+ */
+export function cleanDefaultOgImage(defaultOg: ImageInfo | null | undefined, origin: string): ImageInfo | null {
+	if (!defaultOg) return null;
+	const file = mediaFile(defaultOg.url);
+	if (!file || file.ext === "svg") return null;
+	if (imageCdn()) {
+		const url = cleanImagePath(defaultOg.url, { width: OG_WIDTH, height: OG_HEIGHT });
+		return url ? { url, width: OG_WIDTH, height: OG_HEIGHT, alt: defaultOg.alt, mimeType: mimeForExt(file.ext) } : null;
+	}
+	const format = file.ext === "png" ? "png" : "jpg";
+	const path = cleanImagePath(defaultOg.url, { width: OG_WIDTH, height: OG_HEIGHT, format });
+	if (!path) return null;
+	return { url: absolute(path, origin) ?? path, width: OG_WIDTH, height: OG_HEIGHT, alt: defaultOg.alt, mimeType: FORMATS[format] };
+}
+
+/** The page's own image (a media-library file) as its original on the media host; null without a host or for anything else. */
+export function ownImageOnMediaHost(own: string | null | undefined): string | null {
+	return mediaFile(own) ? cdnOriginalUrl(own) : null;
+}
+
+/** A media item's row from the media table. */
+export interface MediaRow {
+	width: number | null;
+	height: number | null;
+	alt: string | null;
+	mime_type?: string | null;
+}
+
+/**
+ * Image facts for a media-host URL: the requested size (width-only keeps the
+ * original ratio; the original keeps its own size) and the original file's
+ * type. Null when the URL isn't on the media host.
+ */
+export function mediaHostImageInfo(url: string, row: MediaRow): ImageInfo | null {
+	const parsed = parseCdnUrl(url);
+	if (!parsed) return null;
+	let width: number | null = row.width;
+	let height: number | null = row.height;
+	if (parsed.width !== undefined) {
+		width = parsed.width;
+		height = parsed.height ?? (row.width && row.height ? Math.round((parsed.width * row.height) / row.width) : null);
+	}
+	return { url, width, height, alt: row.alt, mimeType: mimeForExt(parsed.ext) ?? row.mime_type ?? undefined };
+}
+
+/**
+ * Whether the pack outputs og:image/twitter:image itself (so they win over
+ * EmDash's, first contribution wins): for media-host URLs, and for the
+ * default image at its Worker-route clean URL. EmDash's own tags stay for
+ * everything else, so there's never a second og:image.
+ */
+export function packOwnsOgImage(url: string, origin: string, hasOwnImage: boolean): boolean {
+	if (parseCdnUrl(url)) return true;
+	if (hasOwnImage) return false;
+	try {
+		return parseImagePath(new URL(url, origin || "https://site.invalid").pathname) !== null;
+	} catch {
+		return false;
+	}
+}
+
+/** og:image (when the pack owns it), its size, type and alt, and twitter:image(:alt). */
+export function ogImageTags(image: ImageInfo | null, ownsUrl: boolean): PageMetadataContribution[] {
+	const out: PageMetadataContribution[] = [];
+	if (!image) return out;
+	if (ownsUrl) {
+		out.push({ kind: "property", property: "og:image", content: image.url });
+		out.push({ kind: "meta", name: "twitter:image", content: image.url });
+	}
+	if (image.width && image.height) {
+		out.push({ kind: "property", property: "og:image:width", content: String(image.width) });
+		out.push({ kind: "property", property: "og:image:height", content: String(image.height) });
+	}
+	if (image.mimeType?.startsWith("image/")) out.push({ kind: "property", property: "og:image:type", content: image.mimeType });
+	if (image.alt?.trim()) {
+		out.push({ kind: "property", property: "og:image:alt", content: image.alt.trim() });
+		out.push({ kind: "meta", name: "twitter:image:alt", content: image.alt.trim() });
+	}
+	return out;
+}

package/src/schema/pack.ts

@@ -0,0 +1,58 @@
+import { registerFeatures } from "../core/features.js";
+import type { PackModule } from "../core/module.js";
+import { type SchemaOptions, schemaMetadataHook, schemaModule, schemaStorage } from "./module.js";
+
+const FEATURES = [
+	{
+		id: "schema",
+		label: "Schema & Social",
+		description: "Schema.org structured data, robots directives, and Open Graph extras, configured on the Schema page.",
+		default: false,
+	},
+	{
+		id: "schema.graph",
+		label: "Schema.org graph",
+		description:
+			"One JSON-LD @graph per page (WebSite, publisher, typed WebPage and Article, authors, image) in place of EmDash's built-in JSON-LD.",
+		default: false,
+	},
+	{
+		id: "schema.breadcrumbs",
+		label: "Breadcrumb schema",
+		description:
+			"A BreadcrumbList from the theme's breadcrumbs, or derived from the URL. Remove any BreadcrumbList your theme prints itself.",
+		default: false,
+	},
+	{
+		id: "schema.robots",
+		label: "Robots directives",
+		description: "A robots meta tag with max-image-preview, max-snippet and max-video-preview, merged with each entry's No index.",
+		default: false,
+	},
+	{
+		id: "schema.openGraph",
+		label: "Open Graph extras",
+		description: "og:locale, plus og:image width, height, type and alt (from the media library) and twitter:image:alt.",
+		default: false,
+	},
+	{
+		id: "schema.authors",
+		label: "Author profiles",
+		description: "Schema.org Person properties per byline (job title, sameAs profiles, image…) used as article authors.",
+		default: false,
+	},
+];
+registerFeatures(FEATURES);
+
+export function schemaPack(options: SchemaOptions): PackModule {
+	return {
+		id: "schema",
+		label: "Schema & Social",
+		features: FEATURES,
+		routes: schemaModule(options).routes,
+		hooks: { "page:metadata": schemaMetadataHook(options) },
+		adminPages: [{ path: "/schema", label: "Schema", icon: "tree-structure" }],
+		storage: schemaStorage,
+		capabilities: ["content:read", "schema:read", "bylines:read", "media:read"],
+	};
+}