@delmaredigital/payload-experiments 0.2.0-rc.7 → 0.3.0-rc.4

package/dist/admin/results/results.model.js

@@ -1,8 +1,11 @@
+import { READINESS_COPY, versionPageUnavailableCopy, versionPageUncheckedCopy } from '../copy/readiness.js';
 import { armLabel, phaseKindLabel, verdictCodeLabel } from '../labels.js';
 import { RESULTS_COPY, cappedCount, collectingCopy, conflictCopy, decidedTitle, exclusionCopy, ignoredCopy, metricUnavailable, moreDays, roundLabel, shareCopy, shippingTitle, srmP, uncappedTotal } from '../copy/results.js';
 import { formatCI, formatCount, formatMetric, formatPercent, formatProbability } from './format.js';
+import { legacyMinimum, legacyRolloutLine, legacyTooFew } from './legacy.js';
+import { isLegacySnapshot } from './snapshot.js';
 export function defaultRound({ phases, decision, status }) {
-    if (status === 'decided' && decision) return decision.phase;
+    if ((status === 'decided' || status === 'archived') && decision) return decision.phase;
     return phases.reduce((latest, phase)=>latest === null || phase.phase > latest ? phase.phase : latest, null);
 }
 export function roundOptions(phases) {
@@ -28,9 +31,10 @@ export function verdictCard({ snapshot, decisionSnapshot, isDecidedTestRound, wi
 }
 export function rolloutLine(snapshot, phase, phases, decision) {
     if (snapshot.phaseKind !== 'rollout') return null;
-    const newestRollout = phases.filter((phase)=>phase.phaseKind === 'rollout').reduce((latest, phase)=>latest === null || phase.phase > latest ? phase.phase : latest, null);
-    const winner = snapshot.winnerArm ?? (snapshot.phase === newestRollout ? decision?.winnerArm : undefined);
-    return shippingTitle(winner ? phase.arms.find((arm)=>arm.key === winner)?.label ?? armLabel(winner) : RESULTS_COPY.shippedGroup);
+    return isLegacySnapshot(snapshot) ? legacyRolloutLine(snapshot, phase, phases, decision) : currentRolloutLine(snapshot, phase);
+}
+function currentRolloutLine(snapshot, phase) {
+    return snapshot.winnerArm === null ? null : shippingTitle(phase.arms.find((arm)=>arm.key === snapshot.winnerArm)?.label ?? armLabel(snapshot.winnerArm));
 }
 export function cappedCell({ metric, arm, caps }) {
     const cap = caps?.[metric.metricId];
@@ -61,6 +65,7 @@ export function armRows({ snapshot, phase, metricId }) {
             key: group.key,
             label: group.label,
             n: formatCount(arm?.n ?? snapshot.exposures.perArm[group.key]),
+            rate: cell.statistic,
             value: metric?.kind === 'binomial' ? formatCount(arm?.converters) : cell.statistic,
             capped: cell
         };
@@ -74,6 +79,8 @@ export function armRows({ snapshot, phase, metricId }) {
         };
         const comparison = metric?.comparisons.find((comparison)=>comparison.arm === group.key);
         if (!comparison) return row;
+        row.lift = formatPercent(comparison.lift, true);
+        row.chanceToWin = snapshot.method === 'bayesian' ? formatPercent(comparison.chanceToWin) : '—';
         const common = {
             ci: formatCI(comparison.ci),
             significance: RESULTS_COPY.significance[comparison.significant]
@@ -121,10 +128,20 @@ function smallest(values) {
     if (phaseKind !== 'rollout' || snapshot.verdict.code !== 'rollout-collecting') return null;
     const keys = comparedKeys(snapshot, ctx.phase);
     const primary = snapshot.metrics.find((metric)=>metric.role === 'primary');
-    return collectingCopy(formatCount(smallest(keys.map((key)=>snapshot.exposures.perArm[key]))), formatCount(snapshot.minExposuresPerArm ?? ctx.minExposuresPerArm), formatCount(smallest(keys.map((key)=>primary?.perArm.find((arm)=>arm.arm === key)?.converters))), formatCount(primary ? snapshot.params.minSampleSizes[primary.metricId] : undefined));
+    return collectingCopy(formatCount(smallest(keys.map((key)=>snapshot.exposures.perArm[key]))), formatCount(isLegacySnapshot(snapshot) ? legacyMinimum(snapshot, ctx) : snapshot.minExposuresPerArm), formatCount(smallest(keys.map((key)=>primary?.perArm.find((arm)=>arm.arm === key)?.converters))), formatCount(primary ? snapshot.params.minSampleSizes[primary.metricId] : undefined));
 }
 export function dataQuality(snapshot, ctx = {}) {
-    const items = [];
+    const items = (snapshot.health ?? []).map((item)=>({
+            id: `${item.code}:${item.path}`,
+            message: READINESS_COPY.needsAttention,
+            nextStep: item.code === 'version-page-unavailable' ? versionPageUnavailableCopy(item.path, ctx.status) : versionPageUncheckedCopy(item.path, ctx.status)
+        }));
+    // Test snapshots store null by design; only rollout snapshots record the shipped winner.
+    if (!isLegacySnapshot(snapshot) && snapshot.phaseKind === 'rollout' && snapshot.winnerArm === null) items.push({
+        id: 'missing-winner',
+        message: RESULTS_COPY.missingWinner,
+        nextStep: RESULTS_COPY.missingWinnerNext
+    });
     const srmTotal = Object.keys(snapshot.srm.expected).reduce((total, key)=>total + (snapshot.exposures.perArm[key] ?? 0), 0);
     if (snapshot.srm.flagged) items.push({
         id: 'srm',
@@ -151,7 +168,7 @@ export function dataQuality(snapshot, ctx = {}) {
         detail: conflictCopy(formatPercent(exposures.identityConflictShare)),
         nextStep: RESULTS_COPY.identityNext
     });
-    if (snapshot.verdict.code === 'collecting' || snapshot.verdict.code === 'rollout-collecting') items.push({
+    if (isLegacySnapshot(snapshot) ? legacyTooFew(snapshot) : snapshot.verdict.code === 'collecting' || snapshot.verdict.code === 'rollout-collecting') items.push({
         id: 'too-few',
         message: RESULTS_COPY.tooFew,
         nextStep: RESULTS_COPY.tooFewNext

package/dist/admin/results/snapshot.d.ts

@@ -0,0 +1,14 @@
+import type { Snapshot } from '../../types/snapshot.js';
+type Core15aFields = Pick<Snapshot, 'winnerArm' | 'minExposuresPerArm'>;
+/** Immutable history written before CORE-15a, with at least one added field absent. */
+export type LegacySnapshot = Omit<Snapshot, keyof Core15aFields> & ({
+    winnerArm?: undefined;
+    minExposuresPerArm?: number;
+} | {
+    winnerArm?: string | null;
+    minExposuresPerArm?: undefined;
+});
+export type DisplaySnapshot = Snapshot | LegacySnapshot;
+/** A stored null winner is current data; only missing CORE-15a fields mark history. */
+export declare function isLegacySnapshot(snapshot: DisplaySnapshot): snapshot is LegacySnapshot;
+export {};

package/dist/admin/results/snapshot.js

@@ -0,0 +1,3 @@
+/** A stored null winner is current data; only missing CORE-15a fields mark history. */ export function isLegacySnapshot(snapshot) {
+    return snapshot.winnerArm === undefined || snapshot.minExposuresPerArm === undefined;
+}

package/dist/admin/surface/ResultsRoute.d.ts

@@ -1,7 +1,7 @@
 import type { DocId } from '../../types/contracts.js';
 import type { SurfaceProps } from './contracts.js';
-import './test/testPage.css';
 export declare function ResultsRoute(props: {
     id: DocId;
     surface: SurfaceProps;
+    onTitleChange?: (title: string) => void;
 }): import("react").JSX.Element;

package/dist/admin/surface/ResultsRoute.js

@@ -1,23 +1,34 @@
 'use client';
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-import { useState } from 'react';
+import { useEffect, useState } from 'react';
 import { useTestDocument } from './useTestDocument.js';
-import { TestHeader } from './test/TestHeader.js';
+import { ResultsHeader, ReaderResultsShell } from './results/ResultsHeader.js';
 import { ResultsBody } from './results/ResultsBody.js';
 import { TEST_PAGE as C } from '../copy/testPage.js';
-import './test/testPage.css';
+import { Button } from '../../ui/Button.js';
 export function ResultsRoute(props) {
     // Results-only readers cannot load the manager-only experiment or preflight.
     return props.surface.canManage ? /*#__PURE__*/ _jsx(ManagedResults, {
         ...props
     }) : /*#__PURE__*/ _jsx(ResultsBody, {
-        ...props
+        ...props,
+        renderPage: ({ children, data })=>/*#__PURE__*/ _jsx(ReaderResultsShell, {
+                surface: props.surface,
+                data: data,
+                children: children
+            })
     });
 }
-function ManagedResults({ id, surface }) {
+function ManagedResults({ id, surface, onTitleChange }) {
     const test = useTestDocument(id, {
         apiRoute: surface.apiRoute
     });
+    useEffect(()=>{
+        if (test.doc?.name) onTitleChange?.(test.doc.name);
+    }, [
+        test.doc?.name,
+        onTitleChange
+    ]);
     const [resultsVersion, setResultsVersion] = useState(0);
     // Add-goal changes metrics while status, phase and allocation stay the same.
     const bodyKey = test.doc ? JSON.stringify([
@@ -27,36 +38,50 @@ function ManagedResults({ id, surface }) {
         test.doc.metrics
     ]) : 'loading';
     // ResultsBody's Decide is the shared DecideDialog, which reloads the page; Recompute keeps status.
-    return /*#__PURE__*/ _jsxs("main", {
-        className: "xp-test-page",
-        children: [
-            test.loadState === 'ready' && test.doc ? /*#__PURE__*/ _jsx(TestHeader, {
+    if (test.loadState === 'ready' && test.doc) return /*#__PURE__*/ _jsx(ResultsBody, {
+        id: id,
+        surface: surface,
+        onRecomputed: ()=>setResultsVersion((value)=>value + 1),
+        onPagesReleased: ()=>{
+            void test.reload();
+        },
+        renderPage: (parts)=>/*#__PURE__*/ _jsx(ResultsHeader, {
                 test: test,
                 surface: surface,
-                view: "results",
-                resultsVersion: resultsVersion
-            }) : /*#__PURE__*/ _jsx("p", {
-                role: "status",
-                children: test.loadState === 'forbidden' ? C.forbidden : test.loadState === 'missing' ? C.missing : test.loadState === 'error' ? C.error : C.loading
-            }),
-            test.loadState === 'error' ? /*#__PURE__*/ _jsx("button", {
-                type: "button",
-                onClick: ()=>void test.reload(),
-                children: C.retry
-            }) : null,
-            test.errors._section ? /*#__PURE__*/ _jsx("p", {
-                role: "alert",
-                children: test.errors._section
-            }) : null,
-            test.preflightError ? /*#__PURE__*/ _jsx("p", {
-                role: "alert",
-                children: test.preflightError
-            }) : null,
-            test.loadState !== 'loading' && test.loadState !== 'missing' && test.loadState !== 'forbidden' ? /*#__PURE__*/ _jsx(ResultsBody, {
-                id: id,
-                surface: surface,
-                onRecomputed: ()=>setResultsVersion((value)=>value + 1)
-            }, bodyKey) : null
-        ]
+                resultsVersion: resultsVersion,
+                ...parts
+            }, `${test.doc.id}/${test.doc.status}`)
+    }, bodyKey);
+    return /*#__PURE__*/ _jsx(ReaderResultsShell, {
+        surface: surface,
+        children: /*#__PURE__*/ _jsxs("div", {
+            className: "xp-test-page",
+            children: [
+                /*#__PURE__*/ _jsx("p", {
+                    role: "status",
+                    children: test.loadState === 'forbidden' ? C.forbidden : test.loadState === 'missing' ? C.missing : test.loadState === 'error' ? C.error : C.loading
+                }),
+                test.loadState === 'error' ? /*#__PURE__*/ _jsx(Button, {
+                    onClick: ()=>void test.reload(),
+                    children: C.retry
+                }) : null,
+                test.errors._section ? /*#__PURE__*/ _jsx("p", {
+                    role: "alert",
+                    children: test.errors._section
+                }) : null,
+                test.preflightError ? /*#__PURE__*/ _jsx("p", {
+                    role: "alert",
+                    children: test.preflightError
+                }) : null,
+                test.loadState !== 'loading' && test.loadState !== 'missing' && test.loadState !== 'forbidden' ? /*#__PURE__*/ _jsx(ResultsBody, {
+                    id: id,
+                    surface: surface,
+                    onRecomputed: ()=>setResultsVersion((value)=>value + 1),
+                    onPagesReleased: ()=>{
+                        void test.reload();
+                    }
+                }, bodyKey) : null
+            ]
+        })
     });
 }

package/dist/admin/surface/SurfaceShell.d.ts

@@ -1,7 +1,16 @@
 import '../theme.css';
 import type { ReactNode } from 'react';
 import './surface.css';
-export declare function SurfaceShell({ adminRoute, children }: {
+export interface SurfaceShellProps {
     adminRoute: string;
     children: ReactNode;
-}): import("react").JSX.Element;
+    crumbs?: Array<{
+        label: string;
+        href?: string;
+    }>;
+    title?: string;
+    status?: ReactNode;
+    actions?: ReactNode;
+    subtitle?: ReactNode;
+}
+export declare function SurfaceShell({ adminRoute, children, crumbs, title, status, actions, subtitle }: SurfaceShellProps): import("react").JSX.Element;

package/dist/admin/surface/SurfaceShell.js

@@ -1,34 +1,69 @@
 'use client';
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import '../theme.css';
-import { Link } from '@payloadcms/ui';
 import { formatAdminURL } from 'payload/shared';
+import { Breadcrumb } from '../../ui/Breadcrumb.js';
+import { Button } from '../../ui/Button.js';
 import { SURFACE_COPY } from '../copy/surface.js';
 import './surface.css';
-export function SurfaceShell({ adminRoute, children }) {
+export function SurfaceShell({ adminRoute, children, crumbs = [
+    {
+        label: SURFACE_COPY.title
+    }
+], title = SURFACE_COPY.title, status, actions, subtitle }) {
     return /*#__PURE__*/ _jsxs("div", {
         className: "xp-tests-surface",
         children: [
             /*#__PURE__*/ _jsxs("header", {
                 className: "xp-tests-shell-header",
                 children: [
-                    /*#__PURE__*/ _jsx(Link, {
-                        href: formatAdminURL({
-                            adminRoute,
-                            path: '/experiments'
-                        }),
-                        children: SURFACE_COPY.title
+                    /*#__PURE__*/ _jsxs("div", {
+                        className: "xp-tests-container xp-tests-shell-top",
+                        children: [
+                            /*#__PURE__*/ _jsx(Breadcrumb, {
+                                items: crumbs
+                            }),
+                            /*#__PURE__*/ _jsx(Button, {
+                                variant: "quiet",
+                                size: "sm",
+                                href: formatAdminURL({
+                                    adminRoute
+                                }),
+                                children: SURFACE_COPY.backToAdmin
+                            })
+                        ]
                     }),
-                    /*#__PURE__*/ _jsx(Link, {
-                        href: formatAdminURL({
-                            adminRoute
-                        }),
-                        children: SURFACE_COPY.backToAdmin
+                    /*#__PURE__*/ _jsxs("div", {
+                        className: "xp-tests-container xp-tests-shell-main",
+                        children: [
+                            /*#__PURE__*/ _jsxs("div", {
+                                className: "xp-tests-shell-heading",
+                                children: [
+                                    /*#__PURE__*/ _jsxs("div", {
+                                        className: "xp-tests-shell-title",
+                                        children: [
+                                            /*#__PURE__*/ _jsx("h1", {
+                                                children: title
+                                            }),
+                                            status
+                                        ]
+                                    }),
+                                    subtitle ? /*#__PURE__*/ _jsx("div", {
+                                        className: "xp-tests-shell-subtitle",
+                                        children: subtitle
+                                    }) : null
+                                ]
+                            }),
+                            actions ? /*#__PURE__*/ _jsx("div", {
+                                className: "xp-tests-shell-actions",
+                                children: actions
+                            }) : null
+                        ]
                     })
                 ]
             }),
             /*#__PURE__*/ _jsx("main", {
-                className: "xp-tests-main",
+                className: "xp-tests-container xp-tests-main",
                 children: children
             })
         ]

package/dist/admin/surface/TestsHome.d.ts

@@ -1,4 +1,9 @@
-export declare function TestsHome({ adminRoute, apiRoute }: {
+import type { SurfaceShellProps } from './SurfaceShell.js';
+import type { ReadinessContext } from './readiness/readiness.model.js';
+export declare function TestsHome({ adminRoute, apiRoute, canManage, crumbs, flagPoints }: {
     adminRoute: string;
     apiRoute: string;
+    canManage?: boolean;
+    crumbs?: SurfaceShellProps['crumbs'];
+    flagPoints?: ReadinessContext['flagPoints'];
 }): import("react").JSX.Element;