@byline/host-tanstack-start 3.8.0 → 3.10.0

package/src/routes/create-collection-history-route.tsx

@@ -21,6 +21,7 @@ import { BreadcrumbsClient } from '../admin-shell/chrome/breadcrumbs/breadcrumbs
 import { HistoryView } from '../admin-shell/collections/history.js'
 import {
   getCollectionDocument,
+  getCollectionDocumentAuditLog,
   getCollectionDocumentHistory,
 } from '../server-fns/collections/index.js'
 import type { ContentLocaleOption } from '../admin-shell/collections/view-menu.js'
@@ -31,8 +32,17 @@ const searchSchema = z.object({
   order: z.string().optional(),
   desc: z.coerce.boolean().optional(),
   locale: z.string().optional(),
+  // Which sub-view of the history page is active (docs/AUDIT.md — Workstream
+  // 3). 'versions' is the content version stream; 'document' is the
+  // document-grain audit log. Absent → 'versions'.
+  tab: z.enum(['versions', 'document']).optional(),
 })
 
+// The per-document audit log is small and bounded (path / locale / status
+// changes + the deletion event), so v1 fetches a single generous page rather
+// than wiring a second, tab-specific pager into the shared history route.
+const AUDIT_LOG_PAGE_SIZE = 100
+
 interface CollectionHistoryOpts {
   contentLocales: ReadonlyArray<ContentLocaleOption>
   defaultContentLocale: string
@@ -67,7 +77,7 @@ export function createCollectionHistoryRoute(path: string, opts: CollectionHisto
         throw notFound()
       }
 
-      const [history, currentDocument] = await Promise.all([
+      const [history, currentDocument, auditLog] = await Promise.all([
         getCollectionDocumentHistory({
           data: {
             collection: params.collection,
@@ -84,15 +94,26 @@ export function createCollectionHistoryRoute(path: string, opts: CollectionHisto
         // Fetch the current document with the same locale (or 'all') so diffs
         // compare the same shape as what the user is viewing.
         getCollectionDocument(params.collection, params.id, deps.locale ?? 'all'),
+        // Document-grain audit log for the "Document history" tab (W3). Fetched
+        // in parallel and unconditionally — it's cheap, and the active tab is a
+        // pure render concern read from the URL, so switching tabs never
+        // refetches.
+        getCollectionDocumentAuditLog({
+          data: {
+            collection: params.collection,
+            id: params.id,
+            params: { page: 1, page_size: AUDIT_LOG_PAGE_SIZE },
+          },
+        }),
       ])
 
-      return { history, currentDocument }
+      return { history, currentDocument, auditLog }
     },
     staleTime: 0,
     gcTime: 0,
     shouldReload: true,
     component: function CollectionHistoryComponent() {
-      const { history, currentDocument } = Route.useLoaderData()
+      const { history, currentDocument, auditLog } = Route.useLoaderData()
       const { collection } = Route.useParams() as { collection: string; id: string }
       const collectionDef = getCollectionDefinition(collection) as CollectionDefinition
       const adminConfig = getCollectionAdminConfig(collection)
@@ -119,6 +140,7 @@ export function createCollectionHistoryRoute(path: string, opts: CollectionHisto
             workflowStatuses={getWorkflowStatuses(collectionDef)}
             adminConfig={adminConfig ?? undefined}
             data={history}
+            auditLog={auditLog}
             currentDocument={currentDocument as Record<string, unknown> | null}
             contentLocales={opts.contentLocales}
             defaultContentLocale={opts.defaultContentLocale}

package/src/server-fns/collections/audit.ts

@@ -0,0 +1,97 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+
+import { createServerFn } from '@tanstack/react-start'
+
+import { ERR_NOT_FOUND, getLogger } from '@byline/core'
+
+import { ensureCollection } from '../../integrations/api-utils.js'
+import { getAdminBylineClient } from '../../integrations/byline-client.js'
+import { type ActorLabelMap, resolveActorLabels } from './actors.js'
+
+// ---------------------------------------------------------------------------
+// Shared param types
+// ---------------------------------------------------------------------------
+
+export interface AuditLogSearchParams {
+  page?: number
+  page_size?: number
+}
+
+/**
+ * Audit entry as it crosses the server-fn boundary. `occurredAt` is an ISO
+ * string (Date doesn't survive serialization) and `before` / `after` are
+ * narrowed from the storage layer's `unknown` jsonb to the concrete shapes the
+ * shipped actions actually carry (path/status strings, the available-locales
+ * array, or null for the deletion event) — `unknown` is not a serializable
+ * type the TanStack server-fn validator accepts.
+ */
+export interface AuditLogEntryDto {
+  id: string
+  documentId: string | null
+  collectionId: string | null
+  actorId: string | null
+  actorRealm: string
+  action: string
+  field: string | null
+  before: string | string[] | null
+  after: string | string[] | null
+  occurredAt: string
+}
+
+// ---------------------------------------------------------------------------
+// Get document-grain audit log (docs/AUDIT.md — Workstream 3)
+// ---------------------------------------------------------------------------
+
+export const getCollectionDocumentAuditLog = createServerFn({ method: 'GET' })
+  .inputValidator(
+    (input: { collection: string; id: string; params?: AuditLogSearchParams }) => input
+  )
+  .handler(async ({ data }) => {
+    const { collection: path, id, params } = data
+    const config = await ensureCollection(path)
+    if (!config) {
+      throw ERR_NOT_FOUND({
+        message: 'Collection not found',
+        details: { collectionPath: path },
+      }).log(getLogger())
+    }
+
+    // Routes through CollectionHandle.auditLog so the document's own read gate
+    // (`beforeRead` via `findById`) is applied — identical to the history
+    // server fn. An actor whose predicate excludes the document gets an empty
+    // log rather than leaked change metadata.
+    const result = await getAdminBylineClient().collection(path).auditLog(id, {
+      page: params?.page,
+      pageSize: params?.page_size,
+    })
+
+    // Acting-user labels for the audit list (docs/AUDIT.md — W3). Resolved
+    // here, in the admin realm, from each entry's raw `actorId`; the UI joins
+    // by id. System/tooling rows (NULL actorId) and deleted users are absent
+    // from the map — the UI renders the corresponding tombstone label.
+    const actors: ActorLabelMap = await resolveActorLabels(result.entries.map((e) => e.actorId))
+
+    // Map to the serializable DTO: ISO-string the timestamp and narrow the
+    // jsonb before/after off `unknown` so the value survives the TanStack
+    // server-fn boundary.
+    const entries: AuditLogEntryDto[] = result.entries.map((e) => ({
+      id: e.id,
+      documentId: e.documentId,
+      collectionId: e.collectionId,
+      actorId: e.actorId,
+      actorRealm: e.actorRealm,
+      action: e.action,
+      field: e.field,
+      before: e.before as string | string[] | null,
+      after: e.after as string | string[] | null,
+      occurredAt: e.occurredAt instanceof Date ? e.occurredAt.toISOString() : String(e.occurredAt),
+    }))
+
+    return { entries, meta: result.meta, actors }
+  })

package/src/server-fns/collections/index.ts

@@ -5,6 +5,7 @@
  * function and exports a clean public API.
  */
 
+export * from './audit'
 export * from './copy-to-locale'
 export * from './create'
 export * from './delete'