@byline/host-tanstack-start 4.15.0 → 4.17.0

package/src/routes/create-admin-layout-route.tsx

@@ -41,6 +41,7 @@ import { buildLocaleDefinitions } from '../i18n/locale-definitions.js'
 import { bylineAdminServices } from '../integrations/byline-admin-services.js'
 import { BylineAiAdminProvider } from '../integrations/byline-ai.js'
 import { bylineFieldServices } from '../integrations/byline-field-services.js'
+import { getAnalyticsRuntime } from '../server-fns/analytics/index.js'
 import { getCurrentAdminUser } from '../server-fns/auth/index.js'
 import { getScheduledPublicationRuntime } from '../server-fns/collections/index.js'
 import { getActiveLocaleFn, setAdminLocaleFn } from '../server-fns/i18n/index.js'
@@ -58,9 +59,12 @@ export function createAdminLayoutRoute(path: string) {
         // than calling `resolveRequestLocale` directly) keeps
         // `@tanstack/react-start/server` out of the client bundle — the
         // same pattern `getCurrentAdminUser` uses for `getAdminRequestContext`.
-        const activeLocale = await getActiveLocaleFn()
-        const scheduledPublicationRuntime = await getScheduledPublicationRuntime()
-        return { user, activeLocale, scheduledPublicationRuntime }
+        const [activeLocale, scheduledPublicationRuntime, analyticsRuntime] = await Promise.all([
+          getActiveLocaleFn(),
+          getScheduledPublicationRuntime(),
+          getAnalyticsRuntime(),
+        ])
+        return { user, activeLocale, scheduledPublicationRuntime, analyticsRuntime }
       } catch {
         // `getCurrentAdminUser` (via `getAdminRequestContext`) throws
         // `ERR_UNAUTHENTICATED` or a related auth error when no valid
@@ -73,11 +77,13 @@ export function createAdminLayoutRoute(path: string) {
       }
     },
     component: function AdminLayoutComponent() {
-      const { user, activeLocale, scheduledPublicationRuntime } = Route.useRouteContext() as {
-        user: Awaited<ReturnType<typeof getCurrentAdminUser>>
-        activeLocale: LocaleCode
-        scheduledPublicationRuntime: Awaited<ReturnType<typeof getScheduledPublicationRuntime>>
-      }
+      const { user, activeLocale, scheduledPublicationRuntime, analyticsRuntime } =
+        Route.useRouteContext() as {
+          user: Awaited<ReturnType<typeof getCurrentAdminUser>>
+          activeLocale: LocaleCode
+          scheduledPublicationRuntime: Awaited<ReturnType<typeof getScheduledPublicationRuntime>>
+          analyticsRuntime: Awaited<ReturnType<typeof getAnalyticsRuntime>>
+        }
       const { i18n } = getAdminConfig()
       const localeDefinitions = buildLocaleDefinitions(
         i18n.admin.locales,
@@ -113,6 +119,7 @@ export function createAdminLayoutRoute(path: string) {
                   <AdminAppBar user={user} />
                   <main className={cx('byline-admin-layout-main', layoutStyles.main)}>
                     <AdminMenuDrawer
+                      analyticsEnabled={analyticsRuntime.enabled}
                       scheduledPublicationEnabled={scheduledPublicationRuntime.enabled}
                     />
                     <Content>

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

@@ -8,8 +8,7 @@
 
 import { createFileRoute, notFound } from '@tanstack/react-router'
 
-import type { CollectionDefinition } from '@byline/core'
-import { getCollectionDefinition } from '@byline/core'
+import type { MultiCollectionDefinition } from '@byline/core'
 import { useTranslation } from '@byline/i18n/react'
 import { z } from 'zod'
 
@@ -18,6 +17,7 @@ import { ApiView } from '../admin-shell/collections/api.js'
 import { getCollectionDocument } from '../server-fns/collections/index.js'
 import { getAdminRoutePath } from './admin-path.js'
 import { getContentLocaleRouteConfig } from './get-content-locale-route-config.js'
+import { getMultiCollectionDefinition } from './get-multi-collection-definition.js'
 
 const searchSchema = z.object({
   locale: z.string().optional(),
@@ -44,7 +44,7 @@ export function createCollectionApiRoute(path: string) {
       params: { collection: string; id: string }
       deps: { locale?: string; depth?: number }
     }) => {
-      const collectionDef = getCollectionDefinition(params.collection)
+      const collectionDef = getMultiCollectionDefinition(params.collection)
       if (!collectionDef) {
         throw notFound()
       }
@@ -74,7 +74,7 @@ export function createCollectionApiRoute(path: string) {
       const data = Route.useLoaderData()
       const { collection, id } = Route.useParams() as { collection: string; id: string }
       const { locale, depth } = Route.useSearch() as z.infer<typeof searchSchema>
-      const collectionDef = getCollectionDefinition(collection) as CollectionDefinition
+      const collectionDef = getMultiCollectionDefinition(collection) as MultiCollectionDefinition
       const { t } = useTranslation('byline-admin')
       const { contentLocales, defaultContentLocale } = getContentLocaleRouteConfig()
 

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

@@ -8,18 +8,15 @@
 
 import { createFileRoute, notFound } from '@tanstack/react-router'
 
-import type { CollectionDefinition } from '@byline/core'
-import {
-  buildInitialDataFromFields,
-  getCollectionAdminConfig,
-  getCollectionDefinition,
-} from '@byline/core'
+import type { MultiCollectionDefinition } from '@byline/core'
+import { buildInitialDataFromFields, getCollectionAdminConfig } from '@byline/core'
 import { useTranslation } from '@byline/i18n/react'
 import { z } from 'zod'
 
 import { BreadcrumbsClient } from '../admin-shell/chrome/breadcrumbs/breadcrumbs-client.js'
 import { CreateView } from '../admin-shell/collections/create.js'
 import { getAdminRoutePath } from './admin-path.js'
+import { getMultiCollectionDefinition } from './get-multi-collection-definition.js'
 
 const searchSchema = z.object({
   /** URL-encoded list search state to return to on cancel — see list-return-state.ts. */
@@ -36,7 +33,7 @@ export function createCollectionCreateRoute(path: string) {
       params: { collection: string }
       // biome-ignore lint/suspicious/noExplicitAny: collection-specific shape
     }): Promise<{ initialData: any }> => {
-      const collectionDef = getCollectionDefinition(params.collection)
+      const collectionDef = getMultiCollectionDefinition(params.collection)
       if (!collectionDef) {
         throw notFound()
       }
@@ -50,7 +47,7 @@ export function createCollectionCreateRoute(path: string) {
       const { collection } = Route.useParams() as { collection: string }
       // biome-ignore lint/suspicious/noExplicitAny: collection-specific shape
       const { initialData } = Route.useLoaderData() as { initialData: any }
-      const collectionDef = getCollectionDefinition(collection) as CollectionDefinition
+      const collectionDef = getMultiCollectionDefinition(collection) as MultiCollectionDefinition
       const adminConfig = getCollectionAdminConfig(collection)
       const { t } = useTranslation('byline-admin')
       const search = Route.useSearch() as z.infer<typeof searchSchema>

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

@@ -9,8 +9,8 @@
 import { useEffect, useRef, useState } from 'react'
 import { createFileRoute, notFound } from '@tanstack/react-router'
 
-import type { CollectionDefinition } from '@byline/core'
-import { getCollectionAdminConfig, getCollectionDefinition } from '@byline/core'
+import type { MultiCollectionDefinition } from '@byline/core'
+import { getCollectionAdminConfig } from '@byline/core'
 import { useTranslation } from '@byline/i18n/react'
 import { useToastManager } from '@byline/ui/react'
 import { z } from 'zod'
@@ -21,6 +21,7 @@ import { EditView } from '../admin-shell/collections/edit.js'
 import { getCollectionDocument } from '../server-fns/collections/index.js'
 import { getAdminRoutePath } from './admin-path.js'
 import { getContentLocaleRouteConfig } from './get-content-locale-route-config.js'
+import { getMultiCollectionDefinition } from './get-multi-collection-definition.js'
 import { decodeListReturnState } from './list-return-state.js'
 import { persistListReturnState, readListReturnState } from './list-return-storage.js'
 
@@ -46,7 +47,7 @@ export function createCollectionEditRoute(path: string) {
       params: { collection: string; id: string }
       deps: { locale?: string }
     }) => {
-      const collectionDef = getCollectionDefinition(params.collection)
+      const collectionDef = getMultiCollectionDefinition(params.collection)
       if (!collectionDef) {
         throw notFound()
       }
@@ -77,7 +78,7 @@ export function createCollectionEditRoute(path: string) {
       const { collection, id } = Route.useParams() as { collection: string; id: string }
       const search = Route.useSearch() as z.infer<typeof searchSchema>
       const { locale } = search
-      const collectionDef = getCollectionDefinition(collection) as CollectionDefinition
+      const collectionDef = getMultiCollectionDefinition(collection) as MultiCollectionDefinition
       const adminConfig = getCollectionAdminConfig(collection)
       const { t } = useTranslation('byline-admin')
       const toastManager = useToastManager()

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

@@ -8,12 +8,8 @@
 
 import { createFileRoute, notFound } from '@tanstack/react-router'
 
-import type { CollectionDefinition } from '@byline/core'
-import {
-  getCollectionAdminConfig,
-  getCollectionDefinition,
-  getWorkflowStatuses,
-} from '@byline/core'
+import type { MultiCollectionDefinition } from '@byline/core'
+import { getCollectionAdminConfig, getWorkflowStatuses } from '@byline/core'
 import { useTranslation } from '@byline/i18n/react'
 import { z } from 'zod'
 
@@ -26,6 +22,7 @@ import {
 } from '../server-fns/collections/index.js'
 import { getAdminRoutePath } from './admin-path.js'
 import { getContentLocaleRouteConfig } from './get-content-locale-route-config.js'
+import { getMultiCollectionDefinition } from './get-multi-collection-definition.js'
 
 const searchSchema = z.object({
   page: z.coerce.number().min(1).optional(),
@@ -68,7 +65,7 @@ export function createCollectionHistoryRoute(path: string) {
         locale?: string
       }
     }) => {
-      const collectionDef = getCollectionDefinition(params.collection)
+      const collectionDef = getMultiCollectionDefinition(params.collection)
       if (!collectionDef) {
         throw notFound()
       }
@@ -111,7 +108,7 @@ export function createCollectionHistoryRoute(path: string) {
     component: function CollectionHistoryComponent() {
       const { history, currentDocument, auditLog } = Route.useLoaderData()
       const { collection } = Route.useParams() as { collection: string; id: string }
-      const collectionDef = getCollectionDefinition(collection) as CollectionDefinition
+      const collectionDef = getMultiCollectionDefinition(collection) as MultiCollectionDefinition
       const adminConfig = getCollectionAdminConfig(collection)
       const { t } = useTranslation('byline-admin')
       const { contentLocales, defaultContentLocale } = getContentLocaleRouteConfig()

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

@@ -10,12 +10,8 @@ import { useEffect, useRef } from 'react'
 import { createFileRoute, notFound } from '@tanstack/react-router'
 
 import { applyRelationColumnFormatters } from '@byline/admin/react'
-import type { CollectionDefinition } from '@byline/core'
-import {
-  getCollectionAdminConfig,
-  getCollectionDefinition,
-  getWorkflowStatuses,
-} from '@byline/core'
+import type { MultiCollectionDefinition } from '@byline/core'
+import { getCollectionAdminConfig, getWorkflowStatuses } from '@byline/core'
 import { useTranslation } from '@byline/i18n/react'
 import { useToastManager } from '@byline/ui/react'
 import type { z } from 'zod'
@@ -31,6 +27,7 @@ import {
   reorderCollectionDocument,
 } from '../server-fns/collections/index.js'
 import { getAdminRoutePath } from './admin-path.js'
+import { getMultiCollectionDefinition } from './get-multi-collection-definition.js'
 import { collectionListSearchSchema as searchSchema } from './list-return-state.js'
 import type { CollectionTreeRow } from '../server-fns/collections/tree.js'
 
@@ -62,7 +59,7 @@ export function createCollectionListRoute(path: string) {
         status?: string
       }
     }) => {
-      const collectionDef = getCollectionDefinition(params.collection)
+      const collectionDef = getMultiCollectionDefinition(params.collection)
       if (!collectionDef) {
         throw notFound()
       }
@@ -108,7 +105,7 @@ export function createCollectionListRoute(path: string) {
       const { collection } = Route.useParams() as { collection: string }
       const search = Route.useSearch() as z.infer<typeof searchSchema>
       const navigate = useNavigate()
-      const collectionDef = getCollectionDefinition(collection) as CollectionDefinition
+      const collectionDef = getMultiCollectionDefinition(collection) as MultiCollectionDefinition
       const adminConfig = getCollectionAdminConfig(collection)
       // Apply the built-in relation formatter to any relation column without an
       // explicit one, so relation cells render the target's title (the list

package/src/routes/create-singleton-history-route.test.node.ts

@@ -0,0 +1,148 @@
+/**
+ * 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 { beforeEach, describe, expect, it, vi } from 'vitest'
+
+const mocks = vi.hoisted(() => ({
+  getSingletonHistory: vi.fn(),
+  getSingleton: vi.fn(),
+  definition: {
+    singleton: true,
+    path: 'site-settings',
+    label: 'Site settings',
+    fields: [],
+  },
+}))
+
+vi.mock('@tanstack/react-router', () => ({
+  createFileRoute: () => (options: Record<string, unknown>) => ({ options }),
+  notFound: () => new Error('not found'),
+}))
+
+vi.mock('@byline/core', () => ({
+  getCollectionDefinition: (path: string) =>
+    path === mocks.definition.path ? mocks.definition : null,
+  isSingleton: (definition: { singleton?: boolean }) => definition.singleton === true,
+  getSingletonAdminConfig: () => null,
+  getWorkflowStatuses: () => [],
+}))
+
+vi.mock('../server-fns/singletons/index.js', () => ({
+  getSingletonHistory: mocks.getSingletonHistory,
+  getSingleton: mocks.getSingleton,
+}))
+
+vi.mock('../admin-shell/chrome/breadcrumbs/breadcrumbs-client.js', () => ({
+  BreadcrumbsClient: () => null,
+}))
+vi.mock('../admin-shell/singletons/history.js', () => ({ SingletonHistoryView: () => null }))
+vi.mock('@byline/i18n/react', () => ({ useTranslation: () => ({ t: (key: string) => key }) }))
+vi.mock('./admin-path.js', () => ({ getAdminRoutePath: () => '/admin' }))
+vi.mock('./get-content-locale-route-config.js', () => ({
+  getContentLocaleRouteConfig: () => ({ contentLocales: [], defaultContentLocale: 'en' }),
+}))
+
+import { createSingletonHistoryRoute } from './create-singleton-history-route.js'
+
+interface RouteLoaderInput {
+  params: { singleton: string }
+  deps: {
+    page?: number
+    page_size?: number
+    order?: string
+    desc?: boolean
+    locale?: string
+  }
+}
+
+type RouteLoader = (input: RouteLoaderInput) => Promise<unknown>
+
+function loader(): RouteLoader {
+  const route = createSingletonHistoryRoute('/admin/singletons/$singleton/history') as {
+    options: { loader: RouteLoader }
+  }
+  return route.options.loader
+}
+
+describe('singleton history route loader', () => {
+  beforeEach(() => {
+    vi.clearAllMocks()
+    mocks.getSingleton.mockResolvedValue(null)
+  })
+
+  it('loads a paginated materialised singleton history without a document id input', async () => {
+    const history = {
+      docs: [{ id: 'document-settings', versionId: 'version-1', status: 'draft' }],
+      meta: { total: 3, page: 2, pageSize: 1, totalPages: 3 },
+      actors: {},
+    }
+    const currentDocument = {
+      id: 'document-settings',
+      versionId: 'version-3',
+      status: 'draft',
+      fields: {},
+    }
+    mocks.getSingletonHistory.mockResolvedValue(history)
+    mocks.getSingleton.mockResolvedValue(currentDocument)
+
+    await expect(
+      loader()({
+        params: { singleton: 'site-settings' },
+        deps: { page: 2, page_size: 1, order: 'created_at', desc: true, locale: 'fr' },
+      })
+    ).resolves.toEqual({ history, currentDocument })
+
+    expect(mocks.getSingletonHistory).toHaveBeenCalledWith({
+      data: {
+        singleton: 'site-settings',
+        params: {
+          page: 2,
+          page_size: 1,
+          order: 'created_at',
+          desc: true,
+          locale: 'fr',
+        },
+      },
+    })
+    expect(mocks.getSingleton).toHaveBeenCalledWith({
+      data: { singleton: 'site-settings', locale: 'fr' },
+    })
+  })
+
+  it('preserves the requested empty FindResult envelope for an unmaterialised slot', async () => {
+    const history = {
+      docs: [],
+      meta: { total: 0, page: 4, pageSize: 30, totalPages: 0 },
+      actors: {},
+    }
+    mocks.getSingletonHistory.mockResolvedValue(history)
+
+    await expect(
+      loader()({
+        params: { singleton: 'site-settings' },
+        deps: { page: 4, page_size: 30 },
+      })
+    ).resolves.toEqual({ history, currentDocument: null })
+
+    expect(mocks.getSingleton).toHaveBeenCalledWith({
+      data: { singleton: 'site-settings', locale: 'all' },
+    })
+  })
+
+  it('preserves a kind-aware read denial from the singleton handle', async () => {
+    const forbidden = {
+      code: 'ERR_FORBIDDEN',
+      details: { ability: 'singletons.site-settings.read' },
+    }
+    mocks.getSingletonHistory.mockRejectedValue(forbidden)
+
+    await expect(loader()({ params: { singleton: 'site-settings' }, deps: {} })).rejects.toBe(
+      forbidden
+    )
+  })
+})

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

@@ -0,0 +1,116 @@
+/**
+ * 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 { createFileRoute, notFound } from '@tanstack/react-router'
+
+import { getSingletonAdminConfig, getWorkflowStatuses } from '@byline/core'
+import { useTranslation } from '@byline/i18n/react'
+import { z } from 'zod'
+
+import { BreadcrumbsClient } from '../admin-shell/chrome/breadcrumbs/breadcrumbs-client.js'
+import { SingletonHistoryView } from '../admin-shell/singletons/history.js'
+import { getSingleton, getSingletonHistory } from '../server-fns/singletons/index.js'
+import { getAdminRoutePath } from './admin-path.js'
+import { getContentLocaleRouteConfig } from './get-content-locale-route-config.js'
+import { getSingletonDefinition } from './get-singleton-definition.js'
+import type { VersionHistoryData } from '../admin-shell/collections/version-history.js'
+
+const searchSchema = z.object({
+  page: z.coerce.number().min(1).optional(),
+  page_size: z.coerce.number().max(100).optional(),
+  order: z.string().optional(),
+  desc: z.coerce.boolean().optional(),
+  locale: z.string().optional(),
+})
+
+export function createSingletonHistoryRoute(path: string) {
+  // biome-ignore lint/suspicious/noExplicitAny: dynamic path bypasses route-tree typing
+  const Route: any = createFileRoute(path as never)({
+    validateSearch: searchSchema,
+    loaderDeps: ({ search }: { search: z.infer<typeof searchSchema> }) => ({
+      page: search.page,
+      page_size: search.page_size,
+      order: search.order,
+      desc: search.desc,
+      locale: search.locale,
+    }),
+    loader: async ({
+      params,
+      deps,
+    }: {
+      params: { singleton: string }
+      deps: z.infer<typeof searchSchema>
+    }) => {
+      if (getSingletonDefinition(params.singleton) == null) throw notFound()
+
+      const [history, currentDocument] = await Promise.all([
+        getSingletonHistory({
+          data: {
+            singleton: params.singleton,
+            params: {
+              page: deps.page,
+              page_size: deps.page_size,
+              order: deps.order,
+              desc: deps.desc,
+              locale: deps.locale,
+            },
+          },
+        }),
+        // Use the same locale shape as the version stream so DiffModal compares
+        // like with like. An empty slot returns null while history returns its
+        // requested empty FindResult envelope.
+        getSingleton({
+          data: { singleton: params.singleton, locale: deps.locale ?? 'all' },
+        }),
+      ])
+
+      return { history, currentDocument }
+    },
+    staleTime: 0,
+    gcTime: 0,
+    shouldReload: true,
+    component: function SingletonHistoryRouteComponent() {
+      const { history, currentDocument } = Route.useLoaderData()
+      const { singleton } = Route.useParams() as { singleton: string }
+      const definition = getSingletonDefinition(singleton)
+      if (definition == null) throw notFound()
+
+      const { t } = useTranslation('byline-admin')
+      const { contentLocales, defaultContentLocale } = getContentLocaleRouteConfig()
+
+      return (
+        <>
+          <BreadcrumbsClient
+            breadcrumbs={[
+              { label: t('chrome.menu.dashboard'), href: getAdminRoutePath() },
+              {
+                label: definition.label,
+                href: getAdminRoutePath('singletons', singleton),
+              },
+              {
+                label: t('collections.breadcrumbs.history'),
+                href: getAdminRoutePath('singletons', singleton, 'history'),
+              },
+            ]}
+          />
+          <SingletonHistoryView
+            singletonDefinition={definition}
+            adminConfig={getSingletonAdminConfig(singleton) ?? undefined}
+            data={history as VersionHistoryData}
+            currentDocument={currentDocument as Record<string, unknown> | null}
+            contentLocales={contentLocales}
+            defaultContentLocale={defaultContentLocale}
+            workflowStatuses={getWorkflowStatuses(definition)}
+          />
+        </>
+      )
+    },
+  })
+
+  return Route
+}