@bygghammar/cms-platform 0.13.0 → 0.14.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bygghammar/cms-platform",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "description": "Shared CMS platform: blocks, block types, i18n core, UI primitives and design-token contract used by every Bygghammar/Voyara site.",
   "type": "module",
   "sideEffects": false,

package/src/platform/index.ts

@@ -2,11 +2,11 @@
  * Host platform contract.
  *
  * Blocks and inspectors already reach the host through `../host`. Backoffice
- * *screens* additionally need data: pages, forms, media, SEO and audit access.
- * Those calls are per-site (each site owns its own database, server functions
- * and auth), while the screens themselves are identical everywhere — so the
- * package declares the contract here and each site registers an adapter at
- * startup.
+ * *screens* additionally need data: pages, global sections, forms, submissions,
+ * media, SEO, redirects and audit access. Those calls are per-site (each site
+ * owns its own database, server functions and auth), while the screens
+ * themselves are identical everywhere — so the package declares the contract
+ * here and each site registers an adapter at startup.
  *
  * Adapters return plain data. No Supabase client, request or response object
  * ever crosses this boundary, which keeps the package usable by a site that is
@@ -15,17 +15,60 @@
 
 import type { Json } from "../i18n/json";
 
+/** Contract revision. Bump when a required member is added or changed. */
+export const PLATFORM_DATA_VERSION = 2;
+
+export type BlockInstanceLike = {
+  id: string;
+  type: string;
+  name?: string;
+  props?: Record<string, unknown>;
+  visible?: boolean;
+};
+
 export type PageSummary = {
+  id: string;
   key: string;
-  title: string;
+  name: string;
+  isSystem: boolean;
+  status: string;
   updatedAt: string | null;
-  published: boolean;
+  currentVersionId: string | null;
 };
 
-export type PageDraft = {
-  key: string;
+export type PageEditState = {
+  page: {
+    id: string;
+    key: string;
+    name: string;
+    isSystem: boolean;
+    status: string;
+    currentVersionId: string | null;
+  };
+  blocks: BlockInstanceLike[];
+};
+
+export type PageVersionSummary = {
+  id: string;
   versionNo: number;
-  blocks: Json;
+  note: string | null;
+  createdAt: string | null;
+  createdByEmail: string | null;
+};
+
+export type SavePageVersionInput = {
+  pageId: string;
+  blocks: BlockInstanceLike[];
+  publish?: boolean;
+  note?: string;
+};
+
+export type GlobalSectionSummary = {
+  id: string;
+  key: string;
+  name: string;
+  kind: string | null;
+  updatedAt: string | null;
 };
 
 export type MediaEntry = {
@@ -36,17 +79,102 @@ export type MediaEntry = {
   updatedAt: string | null;
 };
 
+/** A file in the site's media bin (soft-deleted, restorable by id). */
+export type MediaTrashEntry = {
+  id: string;
+  originalPath: string;
+  size: number;
+  contentType: string | null;
+  deletedAt: string | null;
+  url: string;
+};
+
+export type RedirectEntry = {
+  id?: string;
+  fromPath: string;
+  toPath: string;
+  /** 301 or 302. */
+  status: number;
+};
+
+/**
+ * SEO overrides are stored per page key, with per-locale slug and meta maps —
+ * one row covers every locale of a page.
+ */
+export type PageSeoRow = {
+  pageKey: string;
+  /** locale -> slug */
+  slugs: Json;
+  /** locale -> meta values */
+  seo: Json;
+};
+
+export type FormSummary = {
+  id: string;
+  key: string;
+  name: string;
+  updatedAt: string | null;
+};
+
+export type SubmissionSummary = {
+  id: string;
+  formKey: string;
+  status: string | null;
+  createdAt: string | null;
+  payload: Json;
+};
+
+export type SubmissionQuery = {
+  formKey?: string;
+  status?: string;
+  page?: number;
+  pageSize?: number;
+};
+
+export type SubmissionPage = {
+  rows: SubmissionSummary[];
+  total: number;
+};
+
 /** Data access the shared backoffice screens need from the host site. */
 export type PlatformData = {
   pages: {
     list: () => Promise<PageSummary[]>;
-    loadDraft: (key: string) => Promise<PageDraft | null>;
-    saveDraft: (input: PageDraft) => Promise<{ versionNo: number }>;
-    publish: (key: string, versionNo: number) => Promise<void>;
+    loadForEdit: (key: string) => Promise<PageEditState>;
+    saveVersion: (input: SavePageVersionInput) => Promise<{ versionId: string; versionNo: number }>;
+    listVersions?: (pageId: string) => Promise<PageVersionSummary[]>;
+    restoreVersion?: (input: { pageId: string; versionId: string }) => Promise<void>;
+    create?: (input: { key: string; name: string }) => Promise<{ id: string }>;
+    rename?: (input: { id: string; name: string }) => Promise<void>;
+    remove?: (id: string) => Promise<void>;
+  };
+  globalSections?: {
+    list: () => Promise<GlobalSectionSummary[]>;
+    loadForEdit: (key: string) => Promise<PageEditState>;
+    saveVersion: (input: SavePageVersionInput) => Promise<{ versionId: string; versionNo: number }>;
   };
   media: {
     list: () => Promise<MediaEntry[]>;
-    remove: (paths: string[]) => Promise<void>;
+    /** Soft delete a single library path (variants included by the host). */
+    remove: (path: string) => Promise<void>;
+    listTrash?: () => Promise<MediaTrashEntry[]>;
+    restore?: (trashId: string) => Promise<void>;
+    purge?: (trashId: string) => Promise<void>;
+  };
+  seo?: {
+    list: () => Promise<PageSeoRow[]>;
+    save: (row: PageSeoRow) => Promise<void>;
+    removeOverride: (input: { pageKey: string }) => Promise<void>;
+  };
+  redirects?: {
+    list: () => Promise<RedirectEntry[]>;
+    save: (entry: RedirectEntry) => Promise<void>;
+    remove: (id: string) => Promise<void>;
+  };
+  forms?: {
+    list: () => Promise<FormSummary[]>;
+    listSubmissions: (query?: SubmissionQuery) => Promise<SubmissionPage>;
+    setSubmissionStatus: (input: { ids: string[]; status: string }) => Promise<void>;
   };
   audit?: {
     log: (event: { action: string; target: string; detail?: Json }) => Promise<void>;
@@ -61,6 +189,8 @@ export type PlatformSite = {
   backofficeBasePath: string;
   /** Public site origin, used for preview links. */
   publicOrigin?: string;
+  /** Locales the site authors content in; first entry is the default. */
+  locales?: string[];
 };
 
 export type HostPlatform = {
@@ -88,3 +218,32 @@ export function getHostPlatform(): HostPlatform {
 export function hasHostPlatform(): boolean {
   return platform !== null;
 }
+
+/** Required members every adapter must implement, used by host-side tests. */
+export const REQUIRED_PLATFORM_DATA: Record<string, readonly string[]> = {
+  pages: ["list", "loadForEdit", "saveVersion"],
+  media: ["list", "remove"],
+};
+
+/**
+ * Assert an adapter implements every required member. Sites call this in a test
+ * (or at startup) so a contract bump fails loudly instead of at click time.
+ */
+export function assertPlatformData(data: PlatformData): void {
+  const missing: string[] = [];
+  for (const [group, members] of Object.entries(REQUIRED_PLATFORM_DATA)) {
+    const bag = (data as unknown as Record<string, Record<string, unknown> | undefined>)[group];
+    if (!bag) {
+      missing.push(group);
+      continue;
+    }
+    for (const member of members) {
+      if (typeof bag[member] !== "function") missing.push(`${group}.${member}`);
+    }
+  }
+  if (missing.length > 0) {
+    throw new Error(
+      `@bygghammar/cms-platform: host platform adapter is missing ${missing.join(", ")}`,
+    );
+  }
+}