@bygghammar/cms-platform 0.40.0 → 0.41.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.41.0
+
+- New `backoffice/routes`: a host registry (`registerBackofficeHost`) plus package-owned
+  route components for audit, email logs, log index, roles, users, version, site
+  settings, redirects, tracking, contact details and form settings. A site route
+  file is now just `createFileRoute(...)({ component: XRoute })`.
+
 ## 0.40.0
 
 - New `backoffice/shell`: shared `BackofficeShell` (auth gate, no-access screen,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bygghammar/cms-platform",
-  "version": "0.40.0",
+  "version": "0.41.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,
@@ -155,7 +155,9 @@
     "./server/forms-delivery-core": "./src/server/forms-delivery-core.ts",
     "./server/forms-submissions-core": "./src/server/forms-submissions-core.ts",
     "./server/backup-core": "./src/server/backup-core.ts",
-    "./backoffice/shell": "./src/backoffice/shell/index.ts"
+    "./backoffice/shell": "./src/backoffice/shell/index.ts",
+    "./backoffice/routes": "./src/backoffice/routes/index.tsx",
+    "./backoffice/routes/host": "./src/backoffice/routes/host.ts"
   },
   "dependencies": {
     "fflate": "^0.8.3"

package/src/backoffice/routes/host.ts

@@ -0,0 +1,93 @@
+/**
+ * Backoffice host registry.
+ *
+ * A site registers its server functions and site-level facts once; the package
+ * then owns the backoffice route components themselves, so a site's route file
+ * is a two-line `createFileRoute(...)({ component: XRoute })`.
+ */
+
+import type { SiteConfig } from "../../config/site-config";
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/** A TanStack server function as seen from the host (called via `useServerFn`). */
+export type HostServerFn = (...args: any[]) => Promise<any>;
+/* eslint-enable @typescript-eslint/no-explicit-any */
+
+/** Everything the package needs from a host to render the backoffice routes. */
+export type BackofficeHost = {
+  /** Site configuration used for defaults on the settings screen. */
+  siteConfig: SiteConfig;
+  /** Locales the site publishes, used by tracking/domain screens. */
+  locales: readonly string[];
+  /** Role identifiers this platform build supports. */
+  allRoles: string[];
+  /** Company details used as code defaults on the contact screen. */
+  company: Record<string, string>;
+  /** Locale used to preview form copy in the backoffice. */
+  previewLocale?: string;
+  /** Server functions, grouped per module. */
+  fns: {
+    // admin
+    listAuditLogs: HostServerFn;
+    listEmailLogs: HostServerFn;
+    listUsers: HostServerFn;
+    getMyRoles: HostServerFn;
+    createUser: HostServerFn;
+    deleteUser: HostServerFn;
+    setUserPassword: HostServerFn;
+    sendPasswordResetEmail: HostServerFn;
+    setUserRoles: HostServerFn;
+    getSystemVersion: HostServerFn;
+    // site settings
+    getSiteSettings: HostServerFn;
+    saveSiteSettings: HostServerFn;
+    clearSiteSetting: HostServerFn;
+    // redirects
+    listRedirects: HostServerFn;
+    saveRedirect: HostServerFn;
+    deleteRedirect: HostServerFn;
+    // tracking + domains
+    listInjections: HostServerFn;
+    saveInjection: HostServerFn;
+    deleteInjection: HostServerFn;
+    getLocaleDomains: HostServerFn;
+    // shared content
+    getContentOverrides: HostServerFn;
+    saveContentSection: HostServerFn;
+    // forms
+    getFormDefaults: HostServerFn;
+    saveFormDefaults: HostServerFn;
+    purgeOldSubmissions: HostServerFn;
+  };
+};
+
+let current: BackofficeHost | null = null;
+
+/** Registers the host adapters. Call once, from a module the routes import. */
+export function registerBackofficeHost(host: BackofficeHost): BackofficeHost {
+  current = host;
+  return host;
+}
+
+/** Reads the registered host, failing loudly when a site forgot to register. */
+export function backofficeHost(): BackofficeHost {
+  if (!current) {
+    throw new Error(
+      "Backoffice host not registered — call registerBackofficeHost() before rendering backoffice routes.",
+    );
+  }
+  return current;
+}
+
+/** Absolute backoffice paths derived from the site's configured base path. */
+export function backofficePaths(host: BackofficeHost = backofficeHost()) {
+  const base = host.siteConfig.backofficePath;
+  return {
+    base,
+    admin: `${base}/admin`,
+    audit: `${base}/admin/audit`,
+    emailLogs: `${base}/admin/email-logs`,
+    users: `${base}/admin/users`,
+    forms: `${base}/forms`,
+  };
+}

package/src/backoffice/routes/index.tsx

@@ -0,0 +1,231 @@
+/**
+ * Package-owned backoffice route components.
+ *
+ * Each component is a complete screen: it reads the host adapters from the
+ * registry, wires queries/mutations and renders the shared view. A site route
+ * file only maps a URL to one of these.
+ */
+
+import { Link, useNavigate } from "@tanstack/react-router";
+import { useQuery, useQueryClient } from "@tanstack/react-query";
+import { useServerFn } from "@tanstack/react-start";
+
+import type { SiteSettingOverrides } from "../../config/site-config";
+import { AuditView } from "../AuditView";
+import { ContactDetailsView } from "../ContactDetailsView";
+import { EmailLogsView } from "../EmailLogsView";
+import { FormSettingsView } from "../FormSettingsView";
+import { LogsView } from "../LogsView";
+import { RedirectsView } from "../RedirectsView";
+import { RolesView } from "../RolesView";
+import { SiteSettingsView } from "../SiteSettingsView";
+import { TrackingView } from "../TrackingView";
+import { UsersView } from "../UsersView";
+import { VersionView } from "../VersionView";
+import { backofficeHost, backofficePaths } from "./host";
+
+export * from "./host";
+
+/** Audit trail screen. */
+export function AuditRoute() {
+  const { fns } = backofficeHost();
+  const fetchLogs = useServerFn(fns.listAuditLogs);
+  const q = useQuery({
+    queryKey: ["admin", "audit"],
+    queryFn: () => fetchLogs({ data: { limit: 300 } }),
+  });
+  return <AuditView rows={(q.data ?? []) as never} />;
+}
+
+/** Outbound email log screen. */
+export function EmailLogsRoute() {
+  const { fns } = backofficeHost();
+  const fetchLogs = useServerFn(fns.listEmailLogs);
+  const q = useQuery({
+    queryKey: ["admin", "email-logs"],
+    queryFn: () => fetchLogs({ data: { limit: 300 } }),
+  });
+  return <EmailLogsView rows={(q.data ?? []) as never} />;
+}
+
+/** Log index linking the audit trail and email log. */
+export function LogsRoute() {
+  const paths = backofficePaths();
+  return <LogsView auditPath={paths.audit} emailLogsPath={paths.emailLogs} />;
+}
+
+/** Role reference screen. */
+export function RolesRoute() {
+  const host = backofficeHost();
+  return <RolesView allRoles={host.allRoles} usersPath={backofficePaths(host).users} />;
+}
+
+/** User administration screen. */
+export function UsersRoute() {
+  const { fns, allRoles } = backofficeHost();
+  const qc = useQueryClient();
+  const fetchUsers = useServerFn(fns.listUsers);
+  const fetchMyRoles = useServerFn(fns.getMyRoles);
+  const runCreate = useServerFn(fns.createUser);
+  const runDelete = useServerFn(fns.deleteUser);
+  const runSetPw = useServerFn(fns.setUserPassword);
+  const runReset = useServerFn(fns.sendPasswordResetEmail);
+  const runSetRoles = useServerFn(fns.setUserRoles);
+
+  const usersQ = useQuery({ queryKey: ["admin", "users"], queryFn: () => fetchUsers() });
+  const myRolesQ = useQuery({ queryKey: ["admin", "my-roles"], queryFn: () => fetchMyRoles() });
+
+  return (
+    <UsersView
+      deps={{
+        users: (usersQ.data ?? []) as never,
+        myRoles: myRolesQ.data ?? [],
+        allRoles,
+        createUser: (input) => runCreate(input as never),
+        deleteUser: (input) => runDelete(input),
+        setUserPassword: (input) => runSetPw(input),
+        sendPasswordResetEmail: (input) => runReset(input),
+        setUserRoles: (input) => runSetRoles(input as never),
+        refresh: () => qc.invalidateQueries({ queryKey: ["admin", "users"] }),
+      }}
+    />
+  );
+}
+
+/** CMS build and platform version screen. */
+export function VersionRoute() {
+  const { fns } = backofficeHost();
+  const fetchVersion = useServerFn(fns.getSystemVersion);
+  const q = useQuery({ queryKey: ["admin", "system-version"], queryFn: () => fetchVersion() });
+  return (
+    <VersionView
+      deps={{ build: q.data?.build, releases: q.data?.releases ?? [], loading: q.isLoading }}
+    />
+  );
+}
+
+/** Site settings screen (code defaults plus database overrides). */
+export function SiteSettingsRoute() {
+  const { fns, siteConfig } = backofficeHost();
+  const load = useServerFn(fns.getSiteSettings);
+  const save = useServerFn(fns.saveSiteSettings);
+  const clear = useServerFn(fns.clearSiteSetting);
+  const q = useQuery({ queryKey: ["admin", "site-settings"], queryFn: () => load() });
+
+  return (
+    <SiteSettingsView
+      deps={{
+        config: q.data?.config ?? siteConfig,
+        overrides: (q.data?.overrides ?? {}) as SiteSettingOverrides,
+        saveSettings: (input) => save(input as never),
+        clearSetting: (input) => clear(input as never),
+        refresh: () => q.refetch(),
+        originSource: q.data?.originSource ?? "code",
+      }}
+    />
+  );
+}
+
+/** URL redirect administration. */
+export function RedirectsRoute() {
+  const { fns } = backofficeHost();
+  const list = useServerFn(fns.listRedirects);
+  const save = useServerFn(fns.saveRedirect);
+  const remove = useServerFn(fns.deleteRedirect);
+  const q = useQuery({ queryKey: ["cms", "redirects"], queryFn: () => list() });
+
+  return (
+    <RedirectsView
+      deps={{
+        rows: q.data ?? [],
+        saveRedirect: (input) => save(input),
+        deleteRedirect: (input) => remove(input),
+        refresh: () => q.refetch(),
+      }}
+    />
+  );
+}
+
+/** Code & tracking injection screen. */
+export function TrackingRoute() {
+  const { fns, locales } = backofficeHost();
+  const list = useServerFn(fns.listInjections);
+  const save = useServerFn(fns.saveInjection);
+  const remove = useServerFn(fns.deleteInjection);
+  const domains = useServerFn(fns.getLocaleDomains);
+
+  const q = useQuery({ queryKey: ["admin", "injections"], queryFn: () => list() });
+  const domainsQ = useQuery({ queryKey: ["admin", "locale-domains"], queryFn: () => domains() });
+
+  return (
+    <TrackingView
+      deps={{
+        profiles: q.data ?? [],
+        domains: domainsQ.data ?? [],
+        locales: locales as never,
+        saveInjection: (input) => save(input as never),
+        deleteInjection: (input) => remove(input),
+        refresh: () => q.refetch(),
+      }}
+    />
+  );
+}
+
+/** Company contact details screen. */
+export function ContactDetailsRoute() {
+  const { fns, company } = backofficeHost();
+  const fetchOverrides = useServerFn(fns.getContentOverrides);
+  const save = useServerFn(fns.saveContentSection);
+  const qc = useQueryClient();
+  const overridesQ = useQuery({
+    queryKey: ["cms", "content-overrides"],
+    queryFn: () => fetchOverrides(),
+  });
+
+  return (
+    <ContactDetailsView
+      deps={{
+        defaults: company,
+        stored: overridesQ.data?.company as Record<string, string> | undefined,
+        loading: overridesQ.isLoading,
+        saveSection: (input) => save(input as never),
+        refresh: () => qc.invalidateQueries({ queryKey: ["cms", "content-overrides"] }),
+      }}
+    />
+  );
+}
+
+/** Form defaults and retention screen. */
+export function FormSettingsRoute() {
+  const host = backofficeHost();
+  const { fns } = host;
+  const load = useServerFn(fns.getFormDefaults);
+  const save = useServerFn(fns.saveFormDefaults);
+  const purge = useServerFn(fns.purgeOldSubmissions);
+  const formsPath = backofficePaths(host).forms;
+  const { data, isLoading } = useQuery({ queryKey: ["form-defaults"], queryFn: () => load() });
+
+  return (
+    <FormSettingsView
+      deps={{
+        defaults: data,
+        isLoading,
+        saveDefaults: (input) => save(input as never),
+        purgeOldSubmissions: (input) => purge(input),
+        previewLocale: host.previewLocale ?? host.siteConfig.defaultLocale,
+        BackLink: ({ className, children }) => (
+          <Link to={formsPath} className={className}>
+            {children}
+          </Link>
+        ),
+      }}
+    />
+  );
+}
+
+/** Shared-content SEO detail helper: back navigation to the SEO list. */
+export function useSeoListNavigate() {
+  const navigate = useNavigate();
+  const paths = backofficePaths();
+  return () => navigate({ to: `${paths.base}/seo` });
+}