@thebes/cadmus 0.3.0 → 0.4.1

package/dist/cms/index.cjs

@@ -307,6 +307,83 @@ function defineCmsConfig(config) {
 	return resolved;
 }
 //#endregion
+//#region src/cms/patch.ts
+function deepEqual(a, b) {
+	if (a === b) return true;
+	if (a === null || b === null) return false;
+	if (typeof a !== typeof b) return false;
+	if (Array.isArray(a) || Array.isArray(b)) {
+		if (!Array.isArray(a) || !Array.isArray(b)) return false;
+		if (a.length !== b.length) return false;
+		return a.every((item, i) => deepEqual(item, b[i]));
+	}
+	if (typeof a === "object" && typeof b === "object") {
+		const ak = Object.keys(a);
+		const bk = Object.keys(b);
+		if (ak.length !== bk.length) return false;
+		return ak.every((key) => Object.hasOwn(b, key) && deepEqual(a[key], b[key]));
+	}
+	return false;
+}
+/**
+* Field-level diff between two document snapshots — the per-field
+* added/removed/changed list a version-history UI renders. Values are
+* compared structurally (deep-equal), so a field only shows as `changed`
+* when its content actually differs.
+*/
+function diffDocuments(before, after, options = {}) {
+	const ignore = new Set(options.ignore ?? []);
+	const keys = options.fields ? options.fields : [...new Set([...Object.keys(before), ...Object.keys(after)])];
+	const changes = [];
+	for (const path of keys) {
+		if (ignore.has(path)) continue;
+		const inBefore = Object.hasOwn(before, path);
+		const inAfter = Object.hasOwn(after, path);
+		if (inBefore && !inAfter) changes.push({
+			path,
+			kind: "removed",
+			before: before[path]
+		});
+		else if (!inBefore && inAfter) changes.push({
+			path,
+			kind: "added",
+			after: after[path]
+		});
+		else if (inBefore && inAfter && !deepEqual(before[path], after[path])) changes.push({
+			path,
+			kind: "changed",
+			before: before[path],
+			after: after[path]
+		});
+	}
+	return changes;
+}
+/**
+* The {@link Patch} that transforms `before` into `after`: `set` for each
+* added/changed field, `unset` for each removed field. `applyPatch(before,
+* computePatch(before, after))` deep-equals `after`.
+*/
+function computePatch(before, after) {
+	return diffDocuments(before, after).map((change) => change.kind === "removed" ? {
+		op: "unset",
+		path: change.path
+	} : {
+		op: "set",
+		path: change.path,
+		value: change.after
+	});
+}
+/**
+* Apply a {@link Patch} to a document, returning a new document (the input is
+* never mutated). Unknown ops are ignored defensively.
+*/
+function applyPatch(doc, patch) {
+	const next = { ...doc };
+	for (const op of patch) if (op.op === "set") next[op.path] = op.value;
+	else if (op.op === "unset") delete next[op.path];
+	return next;
+}
+//#endregion
 //#region src/cms/validation.ts
 const EMAIL_RE = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
 const SLUG_RE = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
@@ -895,6 +972,21 @@ function createVersionedLocalApi(db, table, versionsTable, config, registry) {
 			const [row] = await db.update(table).set({ publishedVersionId: null }).where((0, drizzle_orm.eq)(idColumn, id)).returning();
 			if (!row) notFound(config, id);
 			return row;
+		},
+		async diffVersions(context, fromVersionId, toVersionId) {
+			await checkAccess(config, "read", context);
+			const rows = await db.select().from(versionsTable).where((0, drizzle_orm.inArray)(versionsIdColumn, [fromVersionId, toVersionId]));
+			const byId = new Map(rows.map((r) => [r.id, r.versionData]));
+			const before = byId.get(fromVersionId);
+			const after = byId.get(toVersionId);
+			if (!before) notFoundVersion(config, fromVersionId);
+			if (!after) notFoundVersion(config, toVersionId);
+			return diffDocuments(before, after, { ignore: [
+				"id",
+				"createdAt",
+				"status",
+				"publishedVersionId"
+			] });
 		}
 	};
 }
@@ -908,6 +1000,50 @@ function getCollectionsMeta(config) {
 	}));
 }
 //#endregion
+//#region src/cms/migrate.ts
+/** Identity helper — gives a migration definition its type + a greppable call site. */
+function defineMigration(migration) {
+	return migration;
+}
+function patchToUpdate(patch) {
+	const values = {};
+	for (const op of patch) values[op.path] = op.op === "set" ? op.value : null;
+	return values;
+}
+/**
+* Run a migration over every document in a collection. Reads all documents
+* through `api.find`, applies `migration.document`, and (unless `dryRun`)
+* writes the resulting patch through `api.update`. Returns a report of what
+* changed — run it `dryRun` first, then apply.
+*/
+async function runMigration(migration, options) {
+	const { api, context, dryRun = false } = options;
+	const rows = await api.find(context);
+	const changes = [];
+	const errors = [];
+	let changed = 0;
+	for (const before of rows) try {
+		const patch = computePatch(before, await migration.document(before) ?? before);
+		if (patch.length === 0) continue;
+		changes.push({
+			id: before.id,
+			patch
+		});
+		changed++;
+		if (!dryRun) await api.update(context, before.id, patchToUpdate(patch));
+	} catch (err) {
+		errors.push(`document ${before.id}: ${String(err)}`);
+	}
+	return {
+		migration: migration.name,
+		dryRun,
+		scanned: rows.length,
+		changed,
+		changes,
+		errors
+	};
+}
+//#endregion
 //#region src/cms/schema-gen.ts
 function toSnakeCase(value) {
 	return value.replace(/[A-Z]/g, (letter) => `_${letter.toLowerCase()}`);
@@ -1106,6 +1242,90 @@ function buildStudioStructure(config, options = {}) {
 	}));
 }
 //#endregion
+//#region src/cms/visual-editing.ts
+/** The data attribute editable regions are tagged with. */
+const EDIT_ATTR = "data-cadmus-edit";
+/** `postMessage` payload type for a click-to-edit selection. */
+const VISUAL_EDIT_MESSAGE = "cadmus:visual-edit";
+function encodeEditRef(ref) {
+	return `${ref.collection}:${ref.id}:${ref.field}`;
+}
+/** Parse an {@link EditRef} string, or null if malformed. */
+function decodeEditRef(value) {
+	const parts = value.split(":");
+	if (parts.length !== 3) return null;
+	const [collection, idRaw, field] = parts;
+	const id = Number.parseInt(idRaw, 10);
+	if (!collection || !field || !Number.isFinite(id)) return null;
+	return {
+		collection,
+		id,
+		field
+	};
+}
+/**
+* Attribute object to spread onto a rendered element so the overlay can map
+* it back to its source field, e.g. `<h1 {...editAttr({collection:'pages',
+* id, field:'title'})}>`.
+*/
+function editAttr(ref) {
+	return { [EDIT_ATTR]: encodeEditRef(ref) };
+}
+/**
+* Mount the click-to-edit overlay. Browser-only — call from a preview page's
+* client script. Highlights `[data-cadmus-edit]` elements on hover and, on
+* click, calls `onSelect` and posts a {@link VisualEditingMessage} to the
+* parent window. Returns a cleanup function that removes the listeners.
+*/
+function mountVisualEditing(options = {}) {
+	const { onSelect, targetOrigin = "*", highlightColor = "#56c6be" } = options;
+	const closest = (target) => {
+		if (!(target instanceof Element)) return null;
+		const el = target.closest(`[${EDIT_ATTR}]`);
+		return el instanceof HTMLElement ? el : null;
+	};
+	let previous = null;
+	const clearHighlight = () => {
+		if (previous) {
+			previous.el.style.outline = previous.outline;
+			previous = null;
+		}
+	};
+	const onOver = (event) => {
+		const el = closest(event.target);
+		if (!el || el === previous?.el) return;
+		clearHighlight();
+		previous = {
+			el,
+			outline: el.style.outline
+		};
+		el.style.outline = `2px solid ${highlightColor}`;
+		el.style.outlineOffset = "2px";
+		el.style.cursor = "pointer";
+	};
+	const onClick = (event) => {
+		const el = closest(event.target);
+		if (!el) return;
+		const ref = decodeEditRef(el.getAttribute("data-cadmus-edit") ?? "");
+		if (!ref) return;
+		event.preventDefault();
+		event.stopPropagation();
+		onSelect?.(ref, el);
+		const message = {
+			type: VISUAL_EDIT_MESSAGE,
+			ref
+		};
+		window.parent?.postMessage(message, targetOrigin);
+	};
+	document.addEventListener("mouseover", onOver, true);
+	document.addEventListener("click", onClick, true);
+	return () => {
+		clearHighlight();
+		document.removeEventListener("mouseover", onOver, true);
+		document.removeEventListener("click", onClick, true);
+	};
+}
+//#endregion
 //#region src/cms/webhooks.ts
 /**
 * Builds an `afterChange` hook that enqueues a `WebhookMessage` for every
@@ -1186,7 +1406,10 @@ async function deliverWebhookMessage(message) {
 }
 //#endregion
 exports.DEFAULT_STUDIO_GROUP = DEFAULT_STUDIO_GROUP;
+exports.EDIT_ATTR = EDIT_ATTR;
 exports.Rule = Rule;
+exports.VISUAL_EDIT_MESSAGE = VISUAL_EDIT_MESSAGE;
+exports.applyPatch = applyPatch;
 exports.assertValid = assertValid;
 exports.buildStudioStructure = buildStudioStructure;
 exports.can = can;
@@ -1195,24 +1418,32 @@ exports.collectionSearchTableName = collectionSearchTableName;
 exports.collectionSearchTableSQL = collectionSearchTableSQL;
 exports.collectionToTable = collectionToTable;
 exports.collectionVersionsTable = collectionVersionsTable;
+exports.computePatch = computePatch;
 exports.createBlockRegistry = createBlockRegistry;
 exports.createLocalApi = createLocalApi;
 exports.createVersionedLocalApi = createVersionedLocalApi;
 exports.createWebhookHook = createWebhookHook;
+exports.decodeEditRef = decodeEditRef;
 exports.defineCmsConfig = defineCmsConfig;
 exports.defineCollection = defineCollection;
 exports.defineField = defineField;
+exports.defineMigration = defineMigration;
 exports.deliverWebhookMessage = deliverWebhookMessage;
+exports.diffDocuments = diffDocuments;
+exports.editAttr = editAttr;
+exports.encodeEditRef = encodeEditRef;
 exports.extractSearchText = extractSearchText;
 exports.flattenDoc = flattenDoc;
 exports.flattenFields = flattenFields;
 exports.generateSchemaSource = generateSchemaSource;
 exports.getCollectionsMeta = getCollectionsMeta;
 exports.getRegisteredApi = getRegisteredApi;
+exports.mountVisualEditing = mountVisualEditing;
 exports.nestDoc = nestDoc;
 exports.relationshipJoinTables = relationshipJoinTables;
 exports.renderBlocksToString = renderBlocksToString;
 exports.rule = rule;
+exports.runMigration = runMigration;
 exports.validateDocument = validateDocument;
 
 //# sourceMappingURL=index.cjs.map