@bygghammar/cms-platform 0.21.0 → 0.23.0

package/src/config/site-config.ts

@@ -0,0 +1,236 @@
+/**
+ * Site configuration contract (Phase 1 of the stand-alone CMS work).
+ *
+ * A site describes itself once, in code, with `defineSiteConfig`. A subset of
+ * those values may be overridden at runtime from the `site_settings` table so
+ * non-developers can change them in the backoffice. Shared platform code reads
+ * the resolved config instead of hardcoding a site name, locale set, backoffice
+ * path or feature set.
+ */
+
+/** Feature modules a site can switch on. Unknown flags are ignored. */
+export type SiteFeatureFlags = {
+  /** Trips / departures module (`/kontoret/trips`). */
+  trips: boolean;
+  /** Courses module (`/kontoret/kurser`). */
+  courses: boolean;
+  /** Reviews module (`/kontoret/recensioner`). */
+  reviews: boolean;
+  /** Transactional email + provider settings screens. */
+  email: boolean;
+  /** Head/body code injection and analytics pixels. */
+  tracking: boolean;
+  /** Backup & restore tooling (superadmin only). */
+  backup: boolean;
+  /** Custom domain management screen. */
+  domains: boolean;
+  /** Public forms module. */
+  forms: boolean;
+};
+
+export const DEFAULT_FEATURE_FLAGS: SiteFeatureFlags = {
+  trips: false,
+  courses: false,
+  reviews: false,
+  email: true,
+  tracking: true,
+  backup: true,
+  domains: false,
+  forms: true,
+};
+
+/** Official company / contact details. Locale-neutral by design. */
+export type SiteCompany = {
+  legalName: string;
+  locationName: string;
+  street: string;
+  postCode: string;
+  city: string;
+  country: string;
+  orgNumber: string;
+  email: string;
+  phone: string;
+};
+
+export const EMPTY_COMPANY: SiteCompany = {
+  legalName: "",
+  locationName: "",
+  street: "",
+  postCode: "",
+  city: "",
+  country: "",
+  orgNumber: "",
+  email: "",
+  phone: "",
+};
+
+/** Brand design tokens. Values are CSS colors written into the theme contract. */
+export type SiteBrandTokens = Record<string, string>;
+
+export type SiteConfigInput = {
+  /** Machine key, e.g. "voyara". Lowercase, no spaces. */
+  key: string;
+  /** Display name used in the backoffice and default SEO titles. */
+  name: string;
+  /** Canonical public origin, without a trailing slash. */
+  origin: string;
+  /** Locales the public site serves, most important first. */
+  locales: readonly string[];
+  /** Locale used when nothing else matches. Must be in `locales`. */
+  defaultLocale: string;
+  /** Path the backoffice is mounted at, e.g. "/kontoret". */
+  backofficePath?: string;
+  /** UI language of the backoffice itself. */
+  backofficeLocale?: string;
+  company?: Partial<SiteCompany>;
+  brand?: SiteBrandTokens;
+  features?: Partial<SiteFeatureFlags>;
+  /** Optional free-form per-site extras shared code never reads. */
+  extra?: Record<string, unknown>;
+};
+
+export type SiteConfig = {
+  key: string;
+  name: string;
+  origin: string;
+  locales: readonly string[];
+  defaultLocale: string;
+  backofficePath: string;
+  backofficeLocale: string;
+  company: SiteCompany;
+  brand: SiteBrandTokens;
+  features: SiteFeatureFlags;
+  extra: Record<string, unknown>;
+};
+
+function fail(message: string): never {
+  throw new Error(`@bygghammar/cms-platform: invalid site config — ${message}`);
+}
+
+/** Validate and normalize a site config. Throws on anything unusable. */
+export function defineSiteConfig(input: SiteConfigInput): SiteConfig {
+  if (!/^[a-z0-9][a-z0-9-]*$/.test(input.key)) fail(`key "${input.key}" must be kebab-case`);
+  if (!input.name.trim()) fail("name is required");
+  if (!/^https?:\/\/[^/]+$/.test(input.origin)) {
+    fail(`origin "${input.origin}" must be an absolute URL without a path`);
+  }
+  if (!input.locales.length) fail("at least one locale is required");
+  if (!input.locales.includes(input.defaultLocale)) {
+    fail(`defaultLocale "${input.defaultLocale}" is not listed in locales`);
+  }
+  const backofficePath = input.backofficePath ?? "/kontoret";
+  if (!backofficePath.startsWith("/") || backofficePath.endsWith("/")) {
+    fail(`backofficePath "${backofficePath}" must start with "/" and not end with one`);
+  }
+  return {
+    key: input.key,
+    name: input.name.trim(),
+    origin: input.origin.replace(/\/$/, ""),
+    locales: [...input.locales],
+    defaultLocale: input.defaultLocale,
+    backofficePath,
+    backofficeLocale: input.backofficeLocale ?? "en",
+    company: { ...EMPTY_COMPANY, ...(input.company ?? {}) },
+    brand: { ...(input.brand ?? {}) },
+    features: { ...DEFAULT_FEATURE_FLAGS, ...(input.features ?? {}) },
+    extra: { ...(input.extra ?? {}) },
+  };
+}
+
+/**
+ * Keys the backoffice may override from the database. Everything else is
+ * code-only on purpose: routing, locale set and origin must be deployable and
+ * reviewable, not editable at runtime.
+ */
+export const OVERRIDABLE_SETTING_KEYS = [
+  "name",
+  "company",
+  "brand",
+  "features",
+] as const satisfies readonly (keyof SiteConfig)[];
+
+export type OverridableSettingKey = (typeof OVERRIDABLE_SETTING_KEYS)[number];
+
+/** Stored override rows, keyed by `OverridableSettingKey`. */
+export type SiteSettingOverrides = Partial<{
+  name: string;
+  company: Partial<SiteCompany>;
+  brand: SiteBrandTokens;
+  features: Partial<SiteFeatureFlags>;
+}>;
+
+function isRecord(value: unknown): value is Record<string, unknown> {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+
+/** Narrow an untrusted settings payload to the overridable subset. */
+export function parseSiteSettingOverrides(raw: unknown): SiteSettingOverrides {
+  if (!isRecord(raw)) return {};
+  const out: SiteSettingOverrides = {};
+  if (typeof raw["name"] === "string" && raw["name"].trim()) out.name = raw["name"].trim();
+  if (isRecord(raw["company"])) {
+    const company: Partial<SiteCompany> = {};
+    for (const key of Object.keys(EMPTY_COMPANY) as (keyof SiteCompany)[]) {
+      const value = (raw["company"] as Record<string, unknown>)[key];
+      if (typeof value === "string") company[key] = value;
+    }
+    out.company = company;
+  }
+  if (isRecord(raw["brand"])) {
+    const brand: SiteBrandTokens = {};
+    for (const [key, value] of Object.entries(raw["brand"])) {
+      if (typeof value === "string") brand[key] = value;
+    }
+    out.brand = brand;
+  }
+  if (isRecord(raw["features"])) {
+    const features: Partial<SiteFeatureFlags> = {};
+    for (const key of Object.keys(DEFAULT_FEATURE_FLAGS) as (keyof SiteFeatureFlags)[]) {
+      const value = (raw["features"] as Record<string, unknown>)[key];
+      if (typeof value === "boolean") features[key] = value;
+    }
+    out.features = features;
+  }
+  return out;
+}
+
+/** Layer database overrides over the code config. Code stays the fallback. */
+export function resolveSiteConfig(base: SiteConfig, overrides: unknown): SiteConfig {
+  const parsed = parseSiteSettingOverrides(overrides);
+  return {
+    ...base,
+    name: parsed.name ?? base.name,
+    company: { ...base.company, ...(parsed.company ?? {}) },
+    brand: { ...base.brand, ...(parsed.brand ?? {}) },
+    features: { ...base.features, ...(parsed.features ?? {}) },
+  };
+}
+
+/** True when a feature module is enabled for the resolved config. */
+export function isFeatureEnabled(config: SiteConfig, flag: keyof SiteFeatureFlags): boolean {
+  return config.features[flag] === true;
+}
+
+/** Build a backoffice URL from the configured mount path. */
+export function backofficeUrl(config: SiteConfig, subpath = ""): string {
+  if (!subpath) return config.backofficePath;
+  return `${config.backofficePath}/${subpath.replace(/^\//, "")}`;
+}
+
+let active: SiteConfig | null = null;
+
+/** Register the resolved site config once at startup. */
+export function registerSiteConfig(config: SiteConfig): SiteConfig {
+  active = config;
+  return config;
+}
+
+/** Read the registered site config. Throws when a site forgot to register. */
+export function siteConfig(): SiteConfig {
+  if (!active) {
+    throw new Error(
+      "@bygghammar/cms-platform: no site config registered. Call registerSiteConfig(defineSiteConfig({...})) during startup.",
+    );
+  }
+  return active;
+}

package/src/platform/contract.ts

@@ -67,12 +67,7 @@ export const SCHEMA_MIGRATIONS: readonly string[] = [
   "20260803201518_6e8a6028-b70f-4a7d-8bc9-95c86304e7ae.sql",
   "20260803201535_32a9a213-cb92-4035-b8cd-8211ca34af68.sql",
   "20260811103505_29df753d-14fa-4a05-8fea-f4207785fba3.sql",
-  "20260811112455_217c4028-f587-4c98-9e4f-9e6c452ab761.sql",
-  "20260811114438_6687d67d-bad3-4803-9638-8b7670d2e5d4.sql",
   "20260811130318_7cb95e95-9baa-40af-8f3f-de1d4e09cec4.sql",
-  "20260811220548_80d99ec2-bd4b-475d-a627-9408bb60ce56.sql",
-  "20260811222519_6b040f56-4de3-49e0-92e4-d9deec5ead6a.sql",
-  "20260812000000_seed_voyara_content.sql",
   "20260818040722_1bdf1b8f-7fb0-4ae8-8ecf-73f1fadff3c2.sql",
   "20260818040808_69a5e832-57e8-4aa7-aff8-7fd7777faa7c.sql",
   "20260818040839_e6523163-bbf5-4a39-9233-91759059569a.sql",

package/src/server/site-settings-core.ts

@@ -0,0 +1,66 @@
+/**
+ * Host-agnostic core for the `site_settings` key/value store.
+ *
+ * Rows are `{ key, value jsonb }` where `key` is one of
+ * `OVERRIDABLE_SETTING_KEYS`. Reads use whatever client the host passes
+ * (publishable client for the public site, authenticated client in the
+ * backoffice); writes always run as the signed-in staff user so RLS applies.
+ */
+
+import {
+  OVERRIDABLE_SETTING_KEYS,
+  parseSiteSettingOverrides,
+  type OverridableSettingKey,
+  type SiteSettingOverrides,
+} from "../config/site-config";
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+type Client = {
+  from: (table: string) => any;
+};
+/* eslint-enable @typescript-eslint/no-explicit-any */
+
+export const SITE_SETTINGS_TABLE = "site_settings";
+
+/** Load every stored override, narrowed to the overridable subset. */
+export async function loadSiteSettingsCore(client: Client): Promise<SiteSettingOverrides> {
+  const { data, error } = await client.from(SITE_SETTINGS_TABLE).select("key, value");
+  if (error) throw new Error(error.message);
+  const raw: Record<string, unknown> = {};
+  for (const row of (data ?? []) as Array<{ key: string; value: unknown }>) {
+    if ((OVERRIDABLE_SETTING_KEYS as readonly string[]).includes(row.key)) raw[row.key] = row.value;
+  }
+  return parseSiteSettingOverrides(raw);
+}
+
+/**
+ * Upsert the provided override keys. Keys absent from `patch` are untouched, so
+ * a screen can save one section without clobbering another.
+ */
+export async function saveSiteSettingsCore(
+  client: Client,
+  patch: SiteSettingOverrides,
+  actorId?: string | null,
+): Promise<SiteSettingOverrides> {
+  const clean = parseSiteSettingOverrides(patch);
+  const rows = (Object.keys(clean) as OverridableSettingKey[]).map((key) => ({
+    key,
+    value: clean[key] as unknown,
+    updated_by: actorId ?? null,
+    updated_at: new Date().toISOString(),
+  }));
+  if (rows.length) {
+    const { error } = await client.from(SITE_SETTINGS_TABLE).upsert(rows, { onConflict: "key" });
+    if (error) throw new Error(error.message);
+  }
+  return loadSiteSettingsCore(client);
+}
+
+/** Remove one override so the code default takes over again. */
+export async function clearSiteSettingCore(
+  client: Client,
+  key: OverridableSettingKey,
+): Promise<void> {
+  const { error } = await client.from(SITE_SETTINGS_TABLE).delete().eq("key", key);
+  if (error) throw new Error(error.message);
+}

package/migrations/20260811112455_217c4028-f587-4c98-9e4f-9e6c452ab761.sql

@@ -1,20 +0,0 @@
-UPDATE public.page_seo SET seo = jsonb_set(seo, '{title,sv}', to_jsonb(v.title)) FROM (VALUES
- ('home','Nordens största partykryssning och festkryssning | Voyara'),
- ('artister','Artister på vinterns hetaste partykryssning · Voyara'),
- ('hytter','Hytter ombord · Voyara partykryssning'),
- ('mat-och-dryck','Mat och dryck på Voyara · Partykryssning'),
- ('tallinn','Tallinn · Voyara partykryssning'),
- ('sakerhet','Säkerhet och en trygg miljö · Voyara'),
- ('galleri','Galleri · Voyara partykryssning'),
- ('faq','FAQ · Voyara partykryssning'),
- ('boka','Boka nu · Voyara partykryssning'),
- ('samarbete','Samarbete · Voyara partykryssning'),
- ('ambassador','Bli ambassadör · Voyara partykryssning'),
- ('kontakt','Kontakta oss · Voyara'),
- ('intresse','Intresseanmälan · Voyara partykryssning')
-) AS v(page_key, title) WHERE public.page_seo.page_key = v.page_key;
-
-UPDATE public.page_seo SET seo = jsonb_set(seo, '{description,sv}', to_jsonb(v.descr)) FROM (VALUES
- ('home','Välkommen till en festkryssning och partykryssning utöver det vanliga. Artister, DJ:s och shower varje kväll — studenter och alla är välkomna.'),
- ('artister','Välkommen till partykryssningen med de hetaste artisterna. Ett unikt nöjeskoncept i två dagar med uppträdanden båda kvällarna.')
-) AS v(page_key, descr) WHERE public.page_seo.page_key = v.page_key;

package/migrations/20260811114438_6687d67d-bad3-4803-9638-8b7670d2e5d4.sql

@@ -1,86 +0,0 @@
-begin;
-
-with p as (select id from public.pages where key = 'home'),
-cur as (
-  select v.blocks from public.page_versions v
-  join public.pages pg on pg.current_version_id = v.id
-  where pg.key = 'home'
-),
-tiles as (
-  select jsonb_build_object(
-    'id', 'blk-link-tiles-home',
-    'type', 'linkTiles',
-    'name', 'Boka / Elevkårer / Ambassadör',
-    'props', jsonb_build_object(
-      'tone', 'white',
-      'columns', 3,
-      'gap', 'md',
-      'aspect', 'portrait',
-      'overlay', 'brand',
-      'labelAlign', 'left',
-      'rounded', false,
-      'items', jsonb_build_array(
-        jsonb_build_object(
-          'id', 'tile-boka',
-          'image', 'https://ybnqylupuisyhuldqrgt.supabase.co/storage/v1/object/public/media/boka-nu.jpg',
-          'label', jsonb_build_object('sv', 'Boka nu'),
-          'alt', jsonb_build_object('sv', 'Publik framför scenen på Voyara partykryssning'),
-          'href', '/boka'
-        ),
-        jsonb_build_object(
-          'id', 'tile-elevkarer',
-          'image', 'https://ybnqylupuisyhuldqrgt.supabase.co/storage/v1/object/public/media/artister-scen.jpg',
-          'label', jsonb_build_object('sv', 'För elevkårer'),
-          'alt', jsonb_build_object('sv', 'Artist på scen ombord'),
-          'href', '/samarbete'
-        ),
-        jsonb_build_object(
-          'id', 'tile-ambassador',
-          'image', 'https://ybnqylupuisyhuldqrgt.supabase.co/storage/v1/object/public/media/voyara-publik.jpg',
-          'label', jsonb_build_object('sv', 'Bli ambassadör'),
-          'alt', jsonb_build_object('sv', 'Gäster som festar ombord'),
-          'href', '/ambassador'
-        )
-      )
-    )
-  ) as blk
-),
-newblocks as (
-  select (
-    select coalesce(jsonb_agg(x.b order by x.idx), '[]'::jsonb)
-    from (
-      select b, idx::numeric as idx from cur, lateral jsonb_array_elements(cur.blocks) with ordinality t(b, idx)
-      where b->>'type' <> 'linkTiles'
-      union all
-      select (select blk from tiles),
-             coalesce((
-               select max(idx) + 0.5 from cur, lateral jsonb_array_elements(cur.blocks) with ordinality t(b, idx)
-               where b->>'type' = 'courseList'
-             ), 999)
-    ) x
-  ) as blocks
-),
-ins as (
-  insert into public.page_versions (page_id, version_no, blocks, note, created_by_email)
-  select p.id,
-         coalesce((select max(version_no) from public.page_versions pv where pv.page_id = p.id), 0) + 1,
-         (select blocks from newblocks),
-         'Add link tiles row (Boka / Elevkårer / Ambassadör)',
-         'system'
-  from p
-  returning id, page_id
-),
-deact as (
-  update public.page_publications pp set is_active = false
-  where pp.page_id = (select id from p) and pp.is_active
-  returning 1
-),
-pub as (
-  insert into public.page_publications (page_id, version_id, note)
-  select page_id, id, 'Add link tiles row' from ins
-  returning page_id, version_id
-)
-update public.pages pg set current_version_id = pub.version_id, updated_at = now()
-from pub where pg.id = pub.page_id;
-
-commit;

package/migrations/20260811220548_80d99ec2-bd4b-475d-a627-9408bb60ce56.sql

@@ -1 +0,0 @@
-UPDATE public.locale_domains SET domain = 'byggis.voyara.se', updated_at = now() WHERE domain = 'www.dev.barskola.nu';

package/migrations/20260811222519_6b040f56-4de3-49e0-92e4-d9deec5ead6a.sql

@@ -1,3 +0,0 @@
-UPDATE public.page_versions
-SET blocks = replace(blocks::text, 'booking.summerinvasion.se', 'booking.voyara.se')::jsonb
-WHERE blocks::text LIKE '%booking.summerinvasion.se%';