create-nextblock 0.14.2 → 0.14.5

package/templates/nextblock-template/app/cms/revisions/utils.ts

@@ -1,132 +1,304 @@
-// apps/nextblock/app/cms/revisions/utils.ts
-import { createClient } from "@nextblock-cms/db/server";
-import type { Database, Json } from "@nextblock-cms/db";
-
-type BlockRow = Database['public']['Tables']['blocks']['Row'];
-
-export interface PageMetaContent {
-  title: string;
-  slug: string;
-  language_id: number;
-  status: Database['public']['Enums']['page_status'];
-  meta_title: string | null;
-  meta_description: string | null;
-  feature_image_id: string | null;
-}
-
-export interface PostMetaContent extends PageMetaContent {
-  label: string | null;
-  excerpt: string | null;
-  subtitle: string | null;
-  published_at: string | null;
-  feature_image_id: string | null;
-}
-
-export interface SimpleBlockContent {
-  language_id: number;
-  block_type: BlockRow['block_type'];
-  content: Json;
-  order: number;
-}
-
-export interface FullPageContent {
-  meta: PageMetaContent;
-  blocks: SimpleBlockContent[];
-}
-
-export interface FullPostContent {
-  meta: PostMetaContent;
-  blocks: SimpleBlockContent[];
-}
-
-export async function getFullPageContent(
-  pageId: number,
-  opts?: { overrideBlockId?: number; overrideBlockContent?: unknown; excludeDeletedBlockId?: number }
-): Promise<FullPageContent | null> {
-  const supabase = createClient();
-  const { data: page, error: pageError } = await supabase
-    .from('pages')
-    .select('id, title, slug, language_id, status, meta_title, meta_description, feature_image_id')
-    .eq('id', pageId)
-    .single();
-  if (pageError || !page) return null;
-
-  const { data: blocks, error: blocksError } = await supabase
-    .from('blocks')
-    .select('id, language_id, block_type, content, order, page_id, post_id')
-    .eq('page_id', pageId)
-    .order('order', { ascending: true });
-  if (blocksError) return null;
-
-  const processed = (blocks || [])
-    .filter(b => opts?.excludeDeletedBlockId ? b.id !== opts.excludeDeletedBlockId : true)
-    .map(b => ({
-      language_id: b.language_id,
-      block_type: b.block_type,
-      content: (opts?.overrideBlockId && b.id === opts.overrideBlockId)
-        ? (opts.overrideBlockContent as Json)
-        : (b.content as Json),
-      order: b.order,
-    } satisfies SimpleBlockContent));
-
-  return {
-    meta: {
-      title: page.title,
-      slug: page.slug,
-      language_id: page.language_id,
-      status: page.status,
-      meta_title: page.meta_title,
-      meta_description: page.meta_description,
-      feature_image_id: page.feature_image_id ?? null,
-    },
-    blocks: processed,
-  };
-}
-
-export async function getFullPostContent(
-  postId: number,
-  opts?: { overrideBlockId?: number; overrideBlockContent?: unknown; excludeDeletedBlockId?: number }
-): Promise<FullPostContent | null> {
-  const supabase = createClient();
-  const { data: post, error: postError } = await supabase
-    .from('posts')
-    .select('id, title, slug, language_id, status, meta_title, meta_description, label, excerpt, subtitle, published_at, feature_image_id')
-    .eq('id', postId)
-    .single();
-  if (postError || !post) return null;
-
-  const { data: blocks, error: blocksError } = await supabase
-    .from('blocks')
-    .select('id, language_id, block_type, content, order, page_id, post_id')
-    .eq('post_id', postId)
-    .order('order', { ascending: true });
-  if (blocksError) return null;
-
-  const processed = (blocks || [])
-    .filter(b => opts?.excludeDeletedBlockId ? b.id !== opts.excludeDeletedBlockId : true)
-    .map(b => ({
-      language_id: b.language_id,
-      block_type: b.block_type,
-      content: (opts?.overrideBlockId && b.id === opts.overrideBlockId)
-        ? (opts.overrideBlockContent as Json)
-        : (b.content as Json),
-      order: b.order,
-    } satisfies SimpleBlockContent));
-
-  return {
-    meta: {
-      title: post.title,
-      slug: post.slug,
-      language_id: post.language_id,
-      status: post.status,
-      meta_title: post.meta_title,
-      meta_description: post.meta_description,
-      label: post.label,
-      excerpt: post.excerpt,
-      subtitle: post.subtitle,
-      published_at: post.published_at ? new Date(post.published_at).toISOString() : null,
-      feature_image_id: post.feature_image_id ?? null,
-    },
-    blocks: processed,
-  };
-}
+// apps/nextblock/app/cms/revisions/utils.ts
+import { createClient } from "@nextblock-cms/db/server";
+import type { Database, Json } from "@nextblock-cms/db";
+
+type BlockRow = Database['public']['Tables']['blocks']['Row'];
+
+/**
+ * The columns a revision snapshot captures, in one place.
+ *
+ * These lists are the contract between four things that must agree exactly:
+ *   - the SELECTs in this file (what a snapshot records),
+ *   - the UPDATEs in service.ts (what a restore replays),
+ *   - the jsonb_build_object() calls in migration 00000000000016 (the stored baseline),
+ *   - RESTORE_EXCLUDED_META_COLUMNS below (what a restore must never replay).
+ *
+ * Anything editable that is missing here is silently un-restorable: a publish that only
+ * changed that field produces an empty JSON Patch, which createPageRevision treats as
+ * "nothing happened" and drops on the floor.
+ */
+export const PAGE_META_COLUMNS = [
+  'title',
+  'slug',
+  'language_id',
+  'status',
+  'meta_title',
+  'meta_description',
+  'custom_canonical',
+  'published_at',
+  'feature_image_id',
+] as const;
+
+export const POST_META_COLUMNS = [
+  ...PAGE_META_COLUMNS,
+  'label',
+  'excerpt',
+  'subtitle',
+] as const;
+
+export const PRODUCT_META_COLUMNS = [
+  'title',
+  'slug',
+  'language_id',
+  'status',
+  'meta_title',
+  'meta_description',
+  'custom_canonical',
+  'published_at',
+  'short_description',
+  'description_json',
+] as const;
+
+/**
+ * Visibility is owned by setContentVisibility (app/actions/visibilityActions.ts), which
+ * deliberately bypasses the draft/revision pipeline. Both fields are still *captured* —
+ * they are useful history — but replaying them on restore would let "restore the wording
+ * from last Tuesday" silently unpublish a live page or resurrect a cancelled schedule.
+ *
+ * They are excluded from change detection for the same reason: a status flip made from
+ * the top bar would otherwise be misattributed to whichever author saved next.
+ */
+export const RESTORE_EXCLUDED_META_COLUMNS = ['status', 'published_at'] as const;
+
+export interface PageMetaContent {
+  title: string;
+  slug: string;
+  language_id: number;
+  status: Database['public']['Enums']['page_status'];
+  meta_title: string | null;
+  meta_description: string | null;
+  custom_canonical: string | null;
+  published_at: string | null;
+  feature_image_id: string | null;
+}
+
+export interface PostMetaContent extends PageMetaContent {
+  label: string | null;
+  excerpt: string | null;
+  subtitle: string | null;
+}
+
+export interface ProductMetaContent {
+  title: string;
+  slug: string;
+  language_id: number;
+  status: string;
+  meta_title: string | null;
+  meta_description: string | null;
+  custom_canonical: string | null;
+  published_at: string | null;
+  short_description: string | null;
+  description_json: Json | null;
+}
+
+export interface SimpleBlockContent {
+  language_id: number;
+  block_type: BlockRow['block_type'];
+  content: Json;
+  order: number;
+}
+
+export interface FullPageContent {
+  meta: PageMetaContent;
+  blocks: SimpleBlockContent[];
+}
+
+export interface FullPostContent {
+  meta: PostMetaContent;
+  blocks: SimpleBlockContent[];
+}
+
+export interface FullProductContent {
+  meta: ProductMetaContent;
+  blocks: SimpleBlockContent[];
+}
+
+export type AnyFullContent = FullPageContent | FullPostContent | FullProductContent;
+
+/**
+ * Any Supabase client shape. Callers pass the cookie-scoped client, the service-role client,
+ * or nothing at all — the generics on those two differ enough that a union of them makes
+ * `.from()` uncallable, so this stays deliberately loose.
+ */
+type AnySupabaseClient = any;
+
+/**
+ * Normalise a timestamp to the exact format JSON snapshots use everywhere else —
+ * `Date#toISOString()`, millisecond precision, `Z` suffix. Postgres renders timestamptz
+ * with microseconds and a `+00:00` offset, so without this a value that round-trips
+ * through the database comes back textually different and shows up as a phantom diff.
+ */
+function normalizeTimestamp(value: string | null | undefined): string | null {
+  if (!value) return null;
+  const parsed = new Date(value);
+  return Number.isNaN(parsed.getTime()) ? null : parsed.toISOString();
+}
+
+interface BlockCaptureOptions {
+  overrideBlockId?: number;
+  overrideBlockContent?: unknown;
+  excludeDeletedBlockId?: number;
+}
+
+/** Reduce raw block rows to the id-free shape stored in revisions. */
+function toSimpleBlocks(
+  blocks: Pick<BlockRow, 'id' | 'language_id' | 'block_type' | 'content' | 'order'>[] | null,
+  opts?: BlockCaptureOptions
+): SimpleBlockContent[] {
+  return (blocks || [])
+    .filter(b => (opts?.excludeDeletedBlockId ? b.id !== opts.excludeDeletedBlockId : true))
+    .map(b => ({
+      language_id: b.language_id,
+      block_type: b.block_type,
+      content: (opts?.overrideBlockId && b.id === opts.overrideBlockId)
+        ? (opts.overrideBlockContent as Json)
+        : (b.content as Json),
+      order: b.order,
+    } satisfies SimpleBlockContent));
+}
+
+/**
+ * Blocks are ordered by `order` then `id`. Revision blocks carry no id, so their array
+ * position *is* their identity — two blocks sharing an `order` value would otherwise swap
+ * places between two reads and register as a content change that never happened.
+ */
+const BLOCK_SELECT = 'id, language_id, block_type, content, order';
+
+export async function getFullPageContent(
+  pageId: number,
+  opts?: BlockCaptureOptions,
+  client?: AnySupabaseClient
+): Promise<FullPageContent | null> {
+  const supabase = (client ?? createClient()) as AnySupabaseClient;
+  const { data: page, error: pageError } = await supabase
+    .from('pages')
+    .select(`id, ${PAGE_META_COLUMNS.join(', ')}`)
+    .eq('id', pageId)
+    .single();
+  if (pageError || !page) return null;
+
+  const { data: blocks, error: blocksError } = await supabase
+    .from('blocks')
+    .select(BLOCK_SELECT)
+    .eq('page_id', pageId)
+    .order('order', { ascending: true })
+    .order('id', { ascending: true });
+  if (blocksError) return null;
+
+  const row = page as Record<string, any>;
+
+  return {
+    meta: {
+      title: row['title'],
+      slug: row['slug'],
+      language_id: row['language_id'],
+      status: row['status'],
+      meta_title: row['meta_title'] ?? null,
+      meta_description: row['meta_description'] ?? null,
+      custom_canonical: row['custom_canonical'] ?? null,
+      published_at: normalizeTimestamp(row['published_at']),
+      feature_image_id: row['feature_image_id'] ?? null,
+    },
+    blocks: toSimpleBlocks(blocks as any, opts),
+  };
+}
+
+export async function getFullPostContent(
+  postId: number,
+  opts?: BlockCaptureOptions,
+  client?: AnySupabaseClient
+): Promise<FullPostContent | null> {
+  const supabase = (client ?? createClient()) as AnySupabaseClient;
+  const { data: post, error: postError } = await supabase
+    .from('posts')
+    .select(`id, ${POST_META_COLUMNS.join(', ')}`)
+    .eq('id', postId)
+    .single();
+  if (postError || !post) return null;
+
+  const { data: blocks, error: blocksError } = await supabase
+    .from('blocks')
+    .select(BLOCK_SELECT)
+    .eq('post_id', postId)
+    .order('order', { ascending: true })
+    .order('id', { ascending: true });
+  if (blocksError) return null;
+
+  const row = post as Record<string, any>;
+
+  return {
+    meta: {
+      title: row['title'],
+      slug: row['slug'],
+      language_id: row['language_id'],
+      status: row['status'],
+      meta_title: row['meta_title'] ?? null,
+      meta_description: row['meta_description'] ?? null,
+      custom_canonical: row['custom_canonical'] ?? null,
+      published_at: normalizeTimestamp(row['published_at']),
+      feature_image_id: row['feature_image_id'] ?? null,
+      label: row['label'] ?? null,
+      excerpt: row['excerpt'] ?? null,
+      subtitle: row['subtitle'] ?? null,
+    },
+    blocks: toSimpleBlocks(blocks as any, opts),
+  };
+}
+
+export async function getFullProductContent(
+  productId: string,
+  opts?: BlockCaptureOptions,
+  client?: AnySupabaseClient
+): Promise<FullProductContent | null> {
+  const supabase = (client ?? createClient()) as AnySupabaseClient;
+  const { data: product, error: productError } = await supabase
+    .from('products')
+    .select(`id, ${PRODUCT_META_COLUMNS.join(', ')}`)
+    .eq('id', productId)
+    .single();
+  if (productError || !product) return null;
+
+  const { data: blocks, error: blocksError } = await supabase
+    .from('blocks')
+    .select(BLOCK_SELECT)
+    .eq('product_id', productId)
+    .order('order', { ascending: true })
+    .order('id', { ascending: true });
+  if (blocksError) return null;
+
+  const row = product as Record<string, any>;
+
+  return {
+    meta: {
+      title: row['title'],
+      slug: row['slug'],
+      language_id: row['language_id'],
+      status: row['status'],
+      meta_title: row['meta_title'] ?? null,
+      meta_description: row['meta_description'] ?? null,
+      custom_canonical: row['custom_canonical'] ?? null,
+      published_at: normalizeTimestamp(row['published_at']),
+      short_description: row['short_description'] ?? null,
+      description_json: (row['description_json'] ?? null) as Json | null,
+    },
+    blocks: toSimpleBlocks(blocks as any, opts),
+  };
+}
+
+/**
+ * Build the meta payload a restore writes back, minus the fields a restore must never
+ * replay (see RESTORE_EXCLUDED_META_COLUMNS).
+ */
+export function buildRestoreMetaUpdate(
+  meta: Record<string, unknown>,
+  columns: readonly string[]
+): Record<string, unknown> {
+  const excluded = new Set<string>(RESTORE_EXCLUDED_META_COLUMNS);
+  const update: Record<string, unknown> = {};
+  for (const column of columns) {
+    if (excluded.has(column)) continue;
+    if (!Object.prototype.hasOwnProperty.call(meta, column)) continue;
+    update[column] = meta[column];
+  }
+  return update;
+}