@delmaredigital/payload-experiments 0.1.0-rc.7 → 0.2.0-rc.1

package/dist/admin/results/ResultsView.js

@@ -1,312 +0,0 @@
-'use client';
-import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
-import '../styles.js';
-import { useEffect, useMemo, useRef, useState } from 'react';
-import { Button, Form, useAuth, useDocumentInfo } from '@payloadcms/ui';
-import { useApi } from '../useApi.js';
-import { canManage } from '../permissions.model.js';
-import { armLabel } from '../labels.js';
-import { RESULTS_COPY as C } from '../copy/results.js';
-import { API_MESSAGES } from '../copy/common.js';
-import { ExperimentActions } from '../actions/ExperimentActions.js';
-import { PreviewLinks } from '../PreviewLinks.js';
-import { VerdictCard } from './VerdictCard.js';
-import { ArmTable } from './ArmTable.js';
-import { DataQualityPanel } from './DataQualityPanel.js';
-import { CiChart } from './CiChart.js';
-import { armRows, collectingLine, dataQuality, defaultRound, guardrailChips, powerLine, rolloutLine, roundOptions, verdictCard } from './results.model.js';
-function savedFormState(saved) {
-    const fields = {};
-    const field = (path, value)=>{
-        fields[path] = {
-            value,
-            initialValue: value
-        };
-    };
-    for (const path of [
-        'status',
-        'kind',
-        'allocation'
-    ])field(path, saved?.[path]);
-    saved?.arms?.forEach((arm, index)=>{
-        for (const [key, value] of Object.entries(arm))field(`arms.${index}.${key}`, value);
-    });
-    for (const [key, value] of Object.entries(saved?.decision ?? {}))field(`decision.${key}`, value);
-    for (const [key, value] of Object.entries(saved?.metrics ?? {}))field(`metrics.${key}`, value);
-    return fields;
-}
-export function ResultsView(_props) {
-    const { id, data, initialState } = useDocumentInfo();
-    const { permissions } = useAuth();
-    const formState = useMemo(()=>initialState ?? savedFormState(data), [
-        initialState,
-        data
-    ]);
-    if (id == null) return /*#__PURE__*/ _jsx("p", {
-        children: C.empty
-    });
-    return /*#__PURE__*/ _jsx(ResultsContent, {
-        id: id,
-        saved: data,
-        formState: formState,
-        manage: canManage(permissions)
-    }, id);
-}
-function ResultsContent({ id, saved, formState, manage }) {
-    const api = useApi();
-    const status = saved?.status ?? 'draft';
-    const decision = saved?.decision;
-    const [round, setRound] = useState(null);
-    const [phases, setPhases] = useState([]);
-    const [state, setState] = useState({
-        round: null,
-        kind: 'loading'
-    });
-    const [refresh, setRefresh] = useState(0);
-    const [placements, setPlacements] = useState(null);
-    const [previewError, setPreviewError] = useState(null);
-    const [previewRefresh, setPreviewRefresh] = useState(0);
-    const [busy, setBusy] = useState(false);
-    const inFlight = useRef(false);
-    const [actionError, setActionError] = useState(null);
-    useEffect(()=>{
-        let active = true;
-        setState((previous)=>({
-                round,
-                kind: 'loading',
-                data: previous.round === round ? previous.data : undefined
-            }));
-        void api.results(id, {
-            ...round === null ? {} : {
-                phase: round
-            },
-            series: true
-        }).then((result)=>{
-            if (!active) return;
-            if (!result.ok || !result.data) {
-                setState((previous)=>({
-                        round,
-                        kind: !result.ok && result.status === 403 ? 'forbidden' : 'error',
-                        data: previous.round === round ? previous.data : undefined,
-                        message: result.ok ? API_MESSAGES.unreadable : result.message
-                    }));
-                return;
-            }
-            setPhases(result.data.phases);
-            if (round === null) {
-                const initial = defaultRound({
-                    phases: result.data.phases,
-                    decision,
-                    status
-                });
-                if (initial !== null) {
-                    setRound(initial);
-                    return;
-                }
-            }
-            setState({
-                round,
-                kind: 'ready',
-                data: result.data
-            });
-        });
-        return ()=>{
-            active = false;
-        };
-    }, [
-        api,
-        id,
-        round,
-        refresh,
-        status,
-        decision?.phase
-    ]);
-    useEffect(()=>{
-        let active = true;
-        setPlacements(null);
-        setPreviewError(null);
-        if (manage) void api.preflight(id).then((result)=>{
-            if (!active) return;
-            if (result.ok && result.data) setPlacements(result.data.placements);
-            else setPreviewError(result.ok ? API_MESSAGES.unreadable : result.message);
-        });
-        return ()=>{
-            active = false;
-        };
-    }, [
-        api,
-        id,
-        manage,
-        previewRefresh
-    ]);
-    async function recompute() {
-        if (!manage || inFlight.current) return;
-        inFlight.current = true;
-        setBusy(true);
-        setActionError(null);
-        try {
-            const result = await api.recompute(id);
-            if (result.ok) setRefresh((value)=>value + 1);
-            else setActionError(result.message);
-        } finally{
-            inFlight.current = false;
-            setBusy(false);
-        }
-    }
-    const response = state.round === round ? state.data : undefined;
-    const phase = response?.phases.find((phase)=>phase.phase === round);
-    const snapshot = response?.snapshot;
-    const isDecidedTestRound = status === 'decided' && phase?.phaseKind === 'test' && decision?.phase === round;
-    const winner = phase?.arms.find((arm)=>arm.key === decision?.winnerArm)?.label ?? armLabel(decision?.winnerArm ?? 'control');
-    // Running is context for this round only, never the live status of an older round.
-    const lineStatus = status === 'running' && round === defaultRound({
-        phases,
-        status
-    }) ? 'running' : 'stopped';
-    const context = {
-        phase,
-        inLayer: saved?.layer != null,
-        layerSlices: saved?.layerSlices,
-        allocation: saved?.allocation
-    };
-    const primary = phase?.metrics.find((metric)=>metric.role === 'primary');
-    return /*#__PURE__*/ _jsxs("div", {
-        className: "xp-results",
-        style: {
-            color: 'var(--theme-text)'
-        },
-        children: [
-            phases.length > 0 ? /*#__PURE__*/ _jsxs("label", {
-                children: [
-                    C.round,
-                    /*#__PURE__*/ _jsx("select", {
-                        value: round ?? '',
-                        onChange: (event)=>setRound(Number(event.target.value)),
-                        children: roundOptions(phases).map((option)=>/*#__PURE__*/ _jsx("option", {
-                                value: option.value,
-                                children: option.label
-                            }, option.value))
-                    })
-                ]
-            }) : null,
-            state.round !== round || state.kind === 'loading' ? /*#__PURE__*/ _jsx("p", {
-                role: "status",
-                children: response ? C.refreshing : C.loading
-            }) : state.kind === 'forbidden' ? /*#__PURE__*/ _jsx("p", {
-                role: "alert",
-                children: C.forbidden
-            }) : state.kind === 'error' ? /*#__PURE__*/ _jsxs(_Fragment, {
-                children: [
-                    /*#__PURE__*/ _jsx("p", {
-                        role: "alert",
-                        children: state.message
-                    }),
-                    /*#__PURE__*/ _jsx(Button, {
-                        onClick: ()=>setRefresh((value)=>value + 1),
-                        children: C.retry
-                    })
-                ]
-            }) : null,
-            phase && snapshot ? /*#__PURE__*/ _jsxs(_Fragment, {
-                children: [
-                    /*#__PURE__*/ _jsx(VerdictCard, {
-                        model: verdictCard({
-                            snapshot,
-                            decisionSnapshot: response?.decisionSnapshot,
-                            isDecidedTestRound,
-                            winnerLabel: winner
-                        }),
-                        guardrails: guardrailChips(snapshot),
-                        power: powerLine({
-                            snapshot,
-                            phaseKind: phase.phaseKind,
-                            status: lineStatus
-                        }),
-                        collecting: collectingLine({
-                            snapshot,
-                            phaseKind: phase.phaseKind,
-                            status: lineStatus
-                        }, context),
-                        sinceShipping: rolloutLine(snapshot, phase, phases, decision ?? undefined)
-                    }),
-                    /*#__PURE__*/ _jsx(DataQualityPanel, {
-                        items: dataQuality(snapshot, context)
-                    }),
-                    [
-                        'primary',
-                        'secondary',
-                        'guardrail'
-                    ].map((role)=>{
-                        const metrics = phase.metrics.filter((metric)=>metric.role === role);
-                        return metrics.length ? /*#__PURE__*/ _jsxs("section", {
-                            children: [
-                                /*#__PURE__*/ _jsx("h2", {
-                                    children: C[role]
-                                }),
-                                metrics.map((metric)=>/*#__PURE__*/ _jsx(ArmTable, {
-                                        caption: metric.name,
-                                        method: snapshot.method,
-                                        metricKind: metric.kind,
-                                        rows: armRows({
-                                            snapshot,
-                                            phase,
-                                            metricId: metric.metricId
-                                        })
-                                    }, metric.metricId))
-                            ]
-                        }, role) : null;
-                    }),
-                    primary ? /*#__PURE__*/ _jsx(CiChart, {
-                        series: response?.series,
-                        metricId: primary.metricId,
-                        metricName: primary.name,
-                        phase: phase,
-                        contentChanges: snapshot.contentChanges
-                    }) : null
-                ]
-            }) : state.round === round && state.kind === 'ready' ? /*#__PURE__*/ _jsx("p", {
-                children: C.empty
-            }) : null,
-            manage && placements ? /*#__PURE__*/ _jsx(PreviewLinks, {
-                experimentId: id,
-                placements: placements,
-                arms: saved?.arms ?? []
-            }) : null,
-            manage && previewError ? /*#__PURE__*/ _jsxs(_Fragment, {
-                children: [
-                    /*#__PURE__*/ _jsx("p", {
-                        role: "alert",
-                        children: previewError
-                    }),
-                    /*#__PURE__*/ _jsx(Button, {
-                        onClick: ()=>setPreviewRefresh((value)=>value + 1),
-                        children: C.retryPreview
-                    })
-                ]
-            }) : null,
-            /*#__PURE__*/ _jsx(Form, {
-                initialState: formState,
-                el: "div",
-                children: /*#__PURE__*/ _jsx(ExperimentActions, {
-                    field: {
-                        name: 'actions',
-                        type: 'ui',
-                        admin: {}
-                    },
-                    path: "actions"
-                })
-            }),
-            manage ? /*#__PURE__*/ _jsx(Button, {
-                disabled: busy,
-                onClick: ()=>{
-                    void recompute();
-                },
-                children: busy ? C.recomputing : C.recompute
-            }) : null,
-            actionError ? /*#__PURE__*/ _jsx("p", {
-                role: "alert",
-                children: actionError
-            }) : null
-        ]
-    });
-}

package/dist/admin/review/ReviewPanel.d.ts

@@ -1,2 +0,0 @@
-import type { UIFieldClientProps } from 'payload';
-export declare function ReviewPanel(_props: UIFieldClientProps): import("react").JSX.Element;

package/dist/admin/review/ReviewPanel.js

@@ -1,268 +0,0 @@
-'use client';
-import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
-import { useEffect, useRef, useState } from 'react';
-import { Button, useConfig, useDocumentInfo, useForm, useFormFields, useFormModified } from '@payloadcms/ui';
-import { useApi } from '../useApi.js';
-import { reloadPage } from '../reload.js';
-import { readArms } from '../arms/arms.model.js';
-import { PreviewLinks } from '../PreviewLinks.js';
-import { REVIEW_COPY as C } from '../copy/review.js';
-import { API_MESSAGES, LOCKED_MESSAGES } from '../copy/common.js';
-import { availableActions } from '../actions/actions.model.js';
-import { ConfirmDialog } from '../actions/ConfirmDialog.js';
-import { reviewView } from './review.model.js';
-export function ReviewPanel(_props) {
-    const { id, data } = useDocumentInfo();
-    const savedAt = typeof data?.updatedAt === 'string' ? data.updatedAt : undefined;
-    const { config, getEntityConfig } = useConfig();
-    const api = useApi();
-    const { dispatchFields, setModified } = useForm();
-    const modified = useFormModified();
-    const status = useFormFields(([fields])=>fields.status?.value ?? 'draft');
-    const kind = useFormFields(([fields])=>fields.kind?.value ?? 'block');
-    const armsJson = useFormFields(([fields])=>JSON.stringify(readArms(fields)));
-    const arms = JSON.parse(armsJson);
-    const metricFields = getEntityConfig({
-        collectionSlug: 'xp-metrics'
-    })?.fields;
-    const sourcesJson = JSON.stringify(metricFields?.find((field)=>field.name === 'source')?.admin?.custom?.sources ?? []);
-    const [preflight, setPreflight] = useState(null);
-    const [refresh, setRefresh] = useState(0);
-    const [loading, setLoading] = useState(true);
-    const [busy, setBusy] = useState(false);
-    const [confirmStart, setConfirmStart] = useState(false);
-    const inFlight = useRef(false);
-    const [error, setError] = useState(null);
-    const [metricKind, setMetricKind] = useState();
-    const [duration, setDuration] = useState('');
-    const [tuning, setTuning] = useState('');
-    useEffect(()=>{
-        if (id == null) return;
-        let active = true;
-        setLoading(true);
-        setError(null);
-        void api.preflight(id).then((result)=>{
-            if (!active) return;
-            if (result.ok && result.data) {
-                setPreflight(result.data);
-                setDuration(result.data.estimate ? String(result.data.estimate.plannedDurationDays) : '');
-                setTuning(result.data.estimate ? String(result.data.estimate.sequentialTuningParameter) : '');
-            } else {
-                setPreflight(null);
-                setError(result.ok ? API_MESSAGES.unreadable : result.message);
-            }
-            setLoading(false);
-        });
-        return ()=>{
-            active = false;
-        };
-    }, [
-        id,
-        api,
-        refresh,
-        savedAt
-    ]);
-    // The preflight wire shape contains the value, but the saved metric's source supplies its kind.
-    const metricId = preflight?.baseline?.metricId;
-    useEffect(()=>{
-        setMetricKind(undefined);
-        if (metricId == null) return;
-        const controller = new AbortController();
-        void (async ()=>{
-            try {
-                const response = await fetch(`${config.routes.api.replace(/\/$/, '')}/xp-metrics/${encodeURIComponent(metricId)}?depth=0`, {
-                    credentials: 'include',
-                    signal: controller.signal
-                });
-                if (!response.ok) return;
-                const metric = await response.json();
-                const sources = JSON.parse(sourcesJson);
-                if (!controller.signal.aborted) setMetricKind(sources.find((source)=>source.id === metric.source)?.kind);
-            } catch  {}
-        })();
-        return ()=>controller.abort();
-    }, [
-        metricId,
-        config.routes.api,
-        sourcesJson
-    ]);
-    if (id == null) return /*#__PURE__*/ _jsx("p", {
-        children: C.save
-    });
-    const view = preflight ? reviewView(preflight, {
-        status,
-        primaryMetricKind: metricKind
-    }) : null;
-    const editable = status === 'draft' || status === 'stopped';
-    const startAction = availableActions({
-        status,
-        kind,
-        arms,
-        canManage: true
-    }).find((action)=>action.id === 'start');
-    const pending = busy || confirmStart;
-    const lockedReason = status === 'running' ? LOCKED_MESSAGES.running : status === 'decided' ? LOCKED_MESSAGES.decided : LOCKED_MESSAGES.archived;
-    const validValues = duration.trim() !== '' && Number.isInteger(Number(duration)) && Number(duration) > 0 && tuning.trim() !== '' && Number.isFinite(Number(tuning)) && Number(tuning) >= 0;
-    function apply() {
-        if (!editable || pending || loading || !view?.applyValues || !validValues) return;
-        dispatchFields({
-            type: 'UPDATE',
-            path: 'analysis.plannedDurationDays',
-            value: Number(duration)
-        });
-        dispatchFields({
-            type: 'UPDATE',
-            path: 'analysis.sequentialTuningParameter',
-            value: Number(tuning)
-        });
-        setModified(true);
-        setRefresh((value)=>value + 1);
-    }
-    async function start() {
-        if (id == null || inFlight.current || pending || loading || modified || !view?.canStart) return;
-        if (status === 'stopped') {
-            setConfirmStart(true);
-            return;
-        }
-        inFlight.current = true;
-        setBusy(true);
-        setError(null);
-        const result = await api.start(id);
-        if (result.ok) {
-            reloadPage();
-            return;
-        }
-        setError(result.message);
-        inFlight.current = false;
-        setBusy(false);
-    }
-    return /*#__PURE__*/ _jsxs("div", {
-        className: "xp-review",
-        children: [
-            loading ? /*#__PURE__*/ _jsx("p", {
-                role: "status",
-                children: C.loading
-            }) : null,
-            view && preflight ? /*#__PURE__*/ _jsxs(_Fragment, {
-                children: [
-                    /*#__PURE__*/ _jsx("ul", {
-                        children: view.checks.map((check, index)=>/*#__PURE__*/ _jsxs("li", {
-                                children: [
-                                    /*#__PURE__*/ _jsxs("span", {
-                                        children: [
-                                            check.ok ? '✓' : '✗',
-                                            " ",
-                                            check.ok ? check.done : check.hint
-                                        ]
-                                    }),
-                                    check.detail ? /*#__PURE__*/ _jsx("p", {
-                                        children: check.detail
-                                    }) : null
-                                ]
-                            }, index))
-                    }),
-                    /*#__PURE__*/ _jsx("ul", {
-                        children: view.placements.map((placement)=>/*#__PURE__*/ _jsxs("li", {
-                                children: [
-                                    placement.ok ? '✓' : '✗',
-                                    " ",
-                                    placement.title,
-                                    placement.detail ? /*#__PURE__*/ _jsx("p", {
-                                        children: placement.detail
-                                    }) : null
-                                ]
-                            }, `${placement.collection}/${placement.id}`))
-                    }),
-                    /*#__PURE__*/ _jsx("fieldset", {
-                        disabled: pending || loading,
-                        style: {
-                            border: 0,
-                            padding: 0
-                        },
-                        children: /*#__PURE__*/ _jsx(PreviewLinks, {
-                            experimentId: id,
-                            placements: preflight.placements,
-                            arms: arms
-                        })
-                    }),
-                    /*#__PURE__*/ _jsx("p", {
-                        children: view.baseline
-                    }),
-                    /*#__PURE__*/ _jsx("p", {
-                        children: view.traffic
-                    }),
-                    /*#__PURE__*/ _jsx("p", {
-                        className: view.estimateWarning ? 'xp-review__warning' : undefined,
-                        style: view.estimateWarning ? {
-                            color: 'var(--theme-warning-600)'
-                        } : undefined,
-                        children: view.estimate
-                    }),
-                    view.applyValues ? /*#__PURE__*/ _jsxs(_Fragment, {
-                        children: [
-                            /*#__PURE__*/ _jsxs("label", {
-                                children: [
-                                    C.duration,
-                                    /*#__PURE__*/ _jsx("input", {
-                                        type: "number",
-                                        min: 1,
-                                        step: 1,
-                                        value: duration,
-                                        disabled: !editable || pending || loading,
-                                        onChange: (event)=>setDuration(event.target.value)
-                                    })
-                                ]
-                            }),
-                            /*#__PURE__*/ _jsxs("label", {
-                                children: [
-                                    C.tuning,
-                                    /*#__PURE__*/ _jsx("input", {
-                                        type: "number",
-                                        min: 0,
-                                        step: "any",
-                                        value: tuning,
-                                        disabled: !editable || pending || loading,
-                                        onChange: (event)=>setTuning(event.target.value)
-                                    })
-                                ]
-                            }),
-                            /*#__PURE__*/ _jsx(Button, {
-                                disabled: !editable || pending || loading || !validValues,
-                                onClick: apply,
-                                children: C.apply
-                            })
-                        ]
-                    }) : null,
-                    !editable ? /*#__PURE__*/ _jsx("p", {
-                        children: lockedReason
-                    }) : null,
-                    modified ? /*#__PURE__*/ _jsx("p", {
-                        children: C.saveFirst
-                    }) : null,
-                    /*#__PURE__*/ _jsx(Button, {
-                        disabled: !view.canStart || modified || pending || loading,
-                        onClick: ()=>{
-                            void start();
-                        },
-                        children: startAction?.label ?? C.start
-                    })
-                ]
-            }) : null,
-            error ? /*#__PURE__*/ _jsx("p", {
-                role: "alert",
-                children: error
-            }) : null,
-            error && !preflight ? /*#__PURE__*/ _jsx(Button, {
-                disabled: pending || loading,
-                onClick: ()=>setRefresh((value)=>value + 1),
-                children: C.retry
-            }) : null,
-            confirmStart && startAction ? /*#__PURE__*/ _jsx(ConfirmDialog, {
-                id: id,
-                action: startAction,
-                winnerLabel: "",
-                onClose: ()=>setConfirmStart(false)
-            }, `${id}/start`) : null
-        ]
-    });
-}

package/dist/admin/summaryBatcher.d.ts

@@ -1,8 +0,0 @@
-import type { DocId } from '../types/contracts.js';
-import type { SummaryResponse } from '../types/endpoints.js';
-import type { createApi } from './api.js';
-export type SummaryEntry = SummaryResponse[DocId];
-type Api = Pick<ReturnType<typeof createApi>, 'summary'>;
-/** All list cells mounted in this tick share a request, even with separate useApi instances. */
-export declare function requestSummary(api: Api, id: DocId): Promise<SummaryEntry | null>;
-export {};

package/dist/admin/summaryBatcher.js

@@ -1,33 +0,0 @@
-let pending = [];
-/** All list cells mounted in this tick share a request, even with separate useApi instances. */ export function requestSummary(api, id) {
-    return new Promise((resolve)=>{
-        pending.push({
-            id,
-            resolve
-        });
-        if (pending.length !== 1) return;
-        queueMicrotask(()=>{
-            const batch = pending;
-            pending = [];
-            const ids = [
-                ...new Map(batch.map((item)=>[
-                        String(item.id),
-                        item.id
-                    ])).values()
-            ];
-            for(let offset = 0; offset < ids.length; offset += 100){
-                const chunk = ids.slice(offset, offset + 100);
-                const keys = new Set(chunk.map(String));
-                const callers = batch.filter((item)=>keys.has(String(item.id)));
-                void (async ()=>{
-                    try {
-                        const result = await api.summary(chunk);
-                        for (const caller of callers)caller.resolve(result.ok ? result.data?.[caller.id] ?? null : null);
-                    } catch  {
-                        for (const caller of callers)caller.resolve(null);
-                    }
-                })();
-            }
-        });
-    });
-}

package/dist/admin/targeting/TargetingAttributeField.d.ts

@@ -1,2 +0,0 @@
-import type { TextFieldClientProps } from 'payload';
-export declare function TargetingAttributeField({ path, field, readOnly }: TextFieldClientProps): import("react").JSX.Element;

package/dist/admin/targeting/TargetingAttributeField.js

@@ -1,31 +0,0 @@
-'use client';
-import { jsx as _jsx } from "react/jsx-runtime";
-import { SelectInput, useField, useFormFields } from '@payloadcms/ui';
-import { isEditable } from '../../collections/experiments/editability.js';
-import { WHO_COPY } from '../copy/who.js';
-import { humaniseAttribute } from './targeting.model.js';
-export function TargetingAttributeField({ path, field, readOnly }) {
-    const { value, setValue } = useField({
-        path
-    });
-    const status = useFormFields(([fields])=>fields.status?.value ?? 'draft');
-    const keys = field.admin?.custom?.attributeKeys ?? {};
-    const locked = Boolean(readOnly || field.admin?.readOnly || !isEditable(status, 'targeting'));
-    return /*#__PURE__*/ _jsx("div", {
-        children: /*#__PURE__*/ _jsx(SelectInput, {
-            path: path,
-            name: path,
-            label: WHO_COPY.attribute,
-            required: field.required,
-            options: Object.keys(keys).map((key)=>({
-                    label: humaniseAttribute(key),
-                    value: key
-                })),
-            value: value ?? '',
-            readOnly: locked,
-            onChange: (option)=>{
-                if (!locked) setValue(option && !Array.isArray(option) ? option.value : null);
-            }
-        })
-    });
-}

package/dist/admin/targeting/TargetingOpField.d.ts

@@ -1,2 +0,0 @@
-import type { TextFieldClientProps } from 'payload';
-export declare function TargetingOpField({ path, field, readOnly }: TextFieldClientProps): import("react").JSX.Element;