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

package/dist/admin/arms/ArmsField.js

@@ -1,310 +0,0 @@
-'use client';
-import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
-import { useEffect, useMemo, useRef } from 'react';
-import { Button, TextInput, useField, useForm, useFormFields } from '@payloadcms/ui';
-import { EDITABLE_BY_STATUS, isEditable } from '../../collections/experiments/editability.js';
-import { lockedReason } from '../lockedNotice.model.js';
-import { ARMS_COPY, GROUP_LABELS, ISSUE_COPY, issueMessage } from '../copy/arms.js';
-import { addHoldoutArm, addVariant, ARM_FIELDS, defaultArms, issuesByRow, readArms, removeArm, setWeight, splitEvenly, totalWeight, withSlotsFor } from './arms.model.js';
-import { pageTargetIssue, setPageTarget, showsPageTarget } from './pageTarget.model.js';
-import { paramsForArm, paramsReadOnly } from './params.model.js';
-import { numberInputStyle, ParamsEditor } from './ParamsEditor.js';
-function newRowId() {
-    if (globalThis.crypto?.getRandomValues) {
-        return Array.from(globalThis.crypto.getRandomValues(new Uint8Array(12)), (byte)=>byte.toString(16).padStart(2, '0')).join('');
-    }
-    return (Date.now().toString(16).padStart(12, '0') + Math.floor(Math.random() * 2 ** 48).toString(16).padStart(12, '0')).slice(-24);
-}
-export function ArmsField({ field, path = 'arms', readOnly }) {
-    const form = useForm();
-    const { showError, errorMessage } = useField({
-        path,
-        hasRows: true
-    });
-    const kind = useFormFields(([fields])=>fields.kind?.value);
-    const status = useFormFields(([fields])=>fields.status?.value ?? 'draft');
-    const flagPoint = useFormFields(([fields])=>fields.flagPoint?.value);
-    const rowMetadata = useFormFields(([fields])=>fields[path]?.rows);
-    // Payload compares selector results by identity. Retain the arm slice when
-    // another field changes, including while a cleared weight contains NaN.
-    const selectRows = useMemo(()=>{
-        let previous = {
-            arms: [],
-            rowIds: []
-        };
-        return ([fields])=>{
-            const arms = readArms(fields, path);
-            const rowIds = arms.map((_, index)=>fields[`${path}.${index}.id`]?.value);
-            if (arms.length !== previous.arms.length || arms.some((arm, index)=>rowIds[index] !== previous.rowIds[index] || ARM_FIELDS.some((key)=>!Object.is(arm[key], previous.arms[index]?.[key])))) previous = {
-                arms,
-                rowIds
-            };
-            return previous;
-        };
-    }, [
-        path
-    ]);
-    const { arms, rowIds } = useFormFields(selectRows);
-    const seeded = useRef(false);
-    const editable = isEditable(status, 'arms') && !readOnly && !form.disabled;
-    const reason = lockedReason(status, 'arms', EDITABLE_BY_STATUS);
-    const points = field.admin?.custom?.flagPoints ?? [];
-    const point = points.find((candidate)=>candidate.id === flagPoint);
-    const issues = issuesByRow(arms, kind);
-    const total = totalWeight(arms);
-    const hasControl = arms.some((arm)=>arm.kind === 'control');
-    const serverCode = [
-        ...issues.form,
-        ...issues.rows.flat()
-    ].find((issue)=>issue.message === errorMessage)?.code ?? (typeof errorMessage === 'string' ? Object.keys(ISSUE_COPY).find((code)=>errorMessage.split(/[^a-z-]+/).includes(code)) : undefined);
-    function apply(next) {
-        if (!editable) return;
-        // null (from Postgres) and undefined both mean "unset"; only real differences are written.
-        const same = (a, b)=>Object.is(a, b) || a == null && b == null;
-        let changed = false;
-        next = withSlotsFor(next, kind);
-        if (next === arms) return;
-        const structureChanged = next.length !== arms.length || next.some((row, index)=>row.key !== arms[index]?.key);
-        // Array row IDs identify existing groups in the server's immutable-key check.
-        // Move both the hidden ID field and public row metadata with the logical key.
-        const idsByKey = new Map(arms.map((row, index)=>[
-                row.key,
-                rowIds[index]
-            ]));
-        const nextIds = structureChanged ? next.map((row)=>idsByKey.get(row.key) ?? newRowId()) : rowIds;
-        if (structureChanged) changed = true;
-        for(let rowIndex = arms.length - 1; rowIndex >= next.length; rowIndex--)form.removeFieldRow({
-            path,
-            rowIndex
-        });
-        for(let rowIndex = arms.length; rowIndex < next.length; rowIndex++){
-            const row = next[rowIndex];
-            const subFieldState = {
-                ...Object.fromEntries(ARM_FIELDS.filter((key)=>key !== 'params' || row.kind !== 'holdout').map((key)=>[
-                        key,
-                        {
-                            value: row[key],
-                            initialValue: undefined,
-                            valid: true
-                        }
-                    ])),
-                id: {
-                    value: nextIds[rowIndex],
-                    initialValue: undefined,
-                    valid: true
-                }
-            };
-            form.addFieldRow({
-                path,
-                rowIndex,
-                schemaPath: 'arms',
-                subFieldState
-            });
-        }
-        next.forEach((row, index)=>{
-            if (structureChanged && rowIds[index] !== nextIds[index]) form.dispatchFields({
-                type: 'UPDATE',
-                path: `${path}.${index}.id`,
-                value: nextIds[index]
-            });
-            for (const key of ARM_FIELDS){
-                if (key === 'params' && row.kind === 'holdout') {
-                    // Reusing a physical row for the holdout must drop the former
-                    // variant's params without assigning params to the holdout.
-                    if (arms[index]?.params != null) {
-                        changed = true;
-                        form.dispatchFields({
-                            type: 'UPDATE',
-                            path: `${path}.${index}.params`,
-                            value: undefined
-                        });
-                    }
-                    continue;
-                }
-                if (!same(arms[index]?.[key], row[key])) {
-                    changed = true;
-                    form.dispatchFields({
-                        type: 'UPDATE',
-                        path: `${path}.${index}.${key}`,
-                        value: row[key]
-                    });
-                }
-            }
-        });
-        if (structureChanged) form.dispatchFields({
-            type: 'UPDATE',
-            path,
-            rows: nextIds.map((id)=>rowMetadata?.find((row)=>row.id === id) ?? {
-                    id: id,
-                    isLoading: true
-                })
-        });
-        if (changed) form.setModified(true);
-    }
-    useEffect(()=>{
-        if (!editable) return;
-        if (!arms.length && !seeded.current) {
-            seeded.current = true;
-            apply(defaultArms(kind));
-        } else if (arms.length) apply(arms);
-    });
-    function update(index, patch) {
-        apply(arms.map((arm, i)=>i === index ? {
-                ...arm,
-                ...patch
-            } : arm));
-    }
-    return /*#__PURE__*/ _jsxs("div", {
-        className: "xp-groups",
-        children: [
-            reason ? /*#__PURE__*/ _jsx("p", {
-                className: "xp-locked-notice",
-                children: reason
-            }) : null,
-            arms.length ? issues.form.map((issue, i)=>/*#__PURE__*/ _jsx("p", {
-                    role: "alert",
-                    children: issueMessage(issue, total)
-                }, i)) : null,
-            showError && errorMessage ? /*#__PURE__*/ _jsx("p", {
-                role: "alert",
-                children: issueMessage({
-                    code: serverCode ?? '',
-                    message: errorMessage
-                }, total)
-            }) : null,
-            /*#__PURE__*/ _jsxs("fieldset", {
-                disabled: !editable,
-                "aria-label": ARMS_COPY.groups,
-                style: {
-                    border: 0,
-                    padding: 0,
-                    margin: 0
-                },
-                children: [
-                    arms.map((arm, index)=>{
-                        const rowPath = `${path}.${index}`;
-                        const pageIssue = kind && showsPageTarget(kind, arm.kind) ? pageTargetIssue(arm.pageTarget, arm.kind) : null;
-                        return /*#__PURE__*/ _jsxs("section", {
-                            className: "xp-group",
-                            style: {
-                                marginBottom: '1.5rem'
-                            },
-                            children: [
-                                /*#__PURE__*/ _jsx("h3", {
-                                    children: GROUP_LABELS[arm.key] ?? arm.label
-                                }),
-                                /*#__PURE__*/ _jsx(TextInput, {
-                                    hasMany: false,
-                                    path: `${rowPath}.label`,
-                                    label: ARMS_COPY.label,
-                                    value: arm.label ?? '',
-                                    readOnly: !editable,
-                                    onChange: (event)=>update(index, {
-                                            label: event.target.value
-                                        })
-                                }),
-                                /*#__PURE__*/ _jsxs("label", {
-                                    htmlFor: `${rowPath}.weight`,
-                                    children: [
-                                        ARMS_COPY.weight,
-                                        /*#__PURE__*/ _jsx("input", {
-                                            id: `${rowPath}.weight`,
-                                            name: `${rowPath}.weight`,
-                                            type: "number",
-                                            min: 0,
-                                            max: 100,
-                                            step: 1,
-                                            style: numberInputStyle,
-                                            disabled: !editable,
-                                            value: Number.isFinite(arm.weight) ? arm.weight : '',
-                                            onChange: (event)=>apply(setWeight(arms, arm.key, event.target.value === '' ? NaN : Number(event.target.value)))
-                                        })
-                                    ]
-                                }),
-                                kind === 'block' && arm.kind !== 'holdout' ? /*#__PURE__*/ _jsxs("p", {
-                                    children: [
-                                        ARMS_COPY.slot,
-                                        ": ",
-                                        GROUP_LABELS[arm.key] ?? arm.label
-                                    ]
-                                }) : null,
-                                kind === 'page' && arm.kind === 'holdout' ? /*#__PURE__*/ _jsx("p", {
-                                    children: ARMS_COPY.holdoutPage
-                                }) : null,
-                                kind && showsPageTarget(kind, arm.kind) ? /*#__PURE__*/ _jsx(TextInput, {
-                                    hasMany: false,
-                                    path: `${rowPath}.pageTarget`,
-                                    label: ARMS_COPY.pagePath,
-                                    value: arm.pageTarget ?? '',
-                                    required: true,
-                                    readOnly: !editable,
-                                    onChange: (event)=>{
-                                        const next = setPageTarget(arm, event.target.value);
-                                        update(index, {
-                                            pageTarget: next.pageTarget
-                                        });
-                                    }
-                                }) : null,
-                                pageIssue ? /*#__PURE__*/ _jsx("p", {
-                                    role: "alert",
-                                    children: pageIssue
-                                }) : null,
-                                kind === 'flag' && point && arm.kind !== 'holdout' ? /*#__PURE__*/ _jsxs(_Fragment, {
-                                    children: [
-                                        arm.kind === 'control' ? /*#__PURE__*/ _jsx("p", {
-                                            children: ARMS_COPY.controlParams
-                                        }) : null,
-                                        /*#__PURE__*/ _jsx(ParamsEditor, {
-                                            fields: point.params,
-                                            path: `${rowPath}.params`,
-                                            value: paramsForArm(arm, point),
-                                            readOnly: paramsReadOnly(arm, editable),
-                                            onChange: (params)=>update(index, {
-                                                    params
-                                                })
-                                        })
-                                    ]
-                                }) : null,
-                                issues.rows[index].map((issue, i)=>/*#__PURE__*/ _jsx("p", {
-                                        role: "alert",
-                                        children: issueMessage(issue, total)
-                                    }, i)),
-                                arm.kind === 'holdout' ? /*#__PURE__*/ _jsxs(_Fragment, {
-                                    children: [
-                                        /*#__PURE__*/ _jsx("p", {
-                                            children: ARMS_COPY.holdout
-                                        }),
-                                        /*#__PURE__*/ _jsx(Button, {
-                                            onClick: ()=>apply(removeArm(arms, arm.key)),
-                                            disabled: !editable,
-                                            children: ARMS_COPY.removeHoldout
-                                        })
-                                    ]
-                                }) : arm.kind === 'variant' ? /*#__PURE__*/ _jsx(Button, {
-                                    onClick: ()=>apply(removeArm(arms, arm.key)),
-                                    disabled: !editable,
-                                    children: ARMS_COPY.removeVariant
-                                }) : null
-                            ]
-                        }, index);
-                    }),
-                    /*#__PURE__*/ _jsx(Button, {
-                        disabled: !editable || !hasControl || arms.filter((arm)=>arm.kind === 'variant').length >= 3,
-                        onClick: ()=>apply(addVariant(arms, kind)),
-                        children: ARMS_COPY.addVariant
-                    }),
-                    !arms.some((arm)=>arm.kind === 'holdout') ? /*#__PURE__*/ _jsx(Button, {
-                        disabled: !editable || !hasControl,
-                        onClick: ()=>apply(addHoldoutArm(arms)),
-                        children: ARMS_COPY.addHoldout
-                    }) : null,
-                    /*#__PURE__*/ _jsx(Button, {
-                        disabled: !editable,
-                        onClick: ()=>apply(splitEvenly(arms)),
-                        children: ARMS_COPY.splitEvenly
-                    })
-                ]
-            })
-        ]
-    });
-}

package/dist/admin/arms/ParamsEditor.d.ts

@@ -1,16 +0,0 @@
-import type { ParamField } from '../../types/contracts.js';
-export declare const numberInputStyle: {
-    readonly background: "var(--theme-input-bg)";
-    readonly color: "var(--theme-text)";
-    readonly border: "1px solid var(--theme-elevation-150)";
-    readonly borderRadius: "var(--style-radius-s)";
-    readonly padding: "0.65rem";
-    readonly width: "100%";
-};
-export declare function ParamsEditor({ fields, value, path, readOnly, onChange }: {
-    fields: Record<string, ParamField>;
-    value: Record<string, unknown>;
-    path: string;
-    readOnly: boolean;
-    onChange: (value: Record<string, unknown>) => void;
-}): import("react").JSX.Element;

package/dist/admin/arms/ParamsEditor.js

@@ -1,79 +0,0 @@
-'use client';
-import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
-import { CheckboxInput, SelectInput, TextareaInput, TextInput } from '@payloadcms/ui';
-import { paramIssue, setParam } from './params.model.js';
-export const numberInputStyle = {
-    background: 'var(--theme-input-bg)',
-    color: 'var(--theme-text)',
-    border: '1px solid var(--theme-elevation-150)',
-    borderRadius: 'var(--style-radius-s)',
-    padding: '0.65rem',
-    width: '100%'
-};
-export function ParamsEditor({ fields, value, path, readOnly, onChange }) {
-    return /*#__PURE__*/ _jsx("div", {
-        className: "xp-params-editor",
-        children: Object.entries(fields).map(([key, field])=>{
-            const fieldPath = `${path}.${key}`;
-            const change = (next)=>{
-                if (!readOnly) onChange(setParam(value, key, field, next));
-            };
-            const issue = paramIssue(field, value[key]);
-            const shared = {
-                path: fieldPath,
-                label: field.label,
-                required: field.required,
-                readOnly
-            };
-            const text = typeof value[key] === 'string' ? value[key] : '';
-            return /*#__PURE__*/ _jsxs("div", {
-                children: [
-                    field.type === 'number' ? /*#__PURE__*/ _jsxs("label", {
-                        htmlFor: fieldPath,
-                        children: [
-                            field.label,
-                            /*#__PURE__*/ _jsx("input", {
-                                id: fieldPath,
-                                name: fieldPath,
-                                type: "number",
-                                style: numberInputStyle,
-                                required: field.required,
-                                disabled: readOnly,
-                                min: field.min,
-                                max: field.max,
-                                step: "any",
-                                value: typeof value[key] === 'number' && Number.isFinite(value[key]) ? value[key] : '',
-                                "aria-invalid": !!issue,
-                                onChange: (event)=>change(event.target.value)
-                            })
-                        ]
-                    }) : field.type === 'checkbox' ? /*#__PURE__*/ _jsx(CheckboxInput, {
-                        ...shared,
-                        name: fieldPath,
-                        checked: value[key] === true,
-                        onToggle: (event)=>change(event.target.checked)
-                    }) : field.type === 'select' ? /*#__PURE__*/ _jsx(SelectInput, {
-                        ...shared,
-                        name: fieldPath,
-                        options: field.options ?? [],
-                        value: text,
-                        onChange: (option)=>change(!Array.isArray(option) ? option?.value ?? '' : '')
-                    }) : field.type === 'textarea' ? /*#__PURE__*/ _jsx(TextareaInput, {
-                        ...shared,
-                        value: text,
-                        onChange: (event)=>change(event.target.value)
-                    }) : /*#__PURE__*/ _jsx(TextInput, {
-                        hasMany: false,
-                        ...shared,
-                        value: text,
-                        onChange: (event)=>change(event.target.value)
-                    }),
-                    issue ? /*#__PURE__*/ _jsx("p", {
-                        role: "alert",
-                        children: issue
-                    }) : null
-                ]
-            }, key);
-        })
-    });
-}

package/dist/admin/copy/tabs.d.ts

@@ -1,7 +0,0 @@
-export declare const TAB_DESCRIPTIONS: {
-    What: string;
-    Who: string;
-    Groups: string;
-    Metrics: string;
-    Review: string;
-};

package/dist/admin/copy/tabs.js

@@ -1,7 +0,0 @@
-export const TAB_DESCRIPTIONS = {
-    What: "What you're testing and why.",
-    Who: 'Who takes part and how traffic is split.',
-    Groups: 'The Original, the variants, and an optional holdout.',
-    Metrics: 'What decides the winner and what must not get worse.',
-    Review: 'Check everything, see how long it will take, and start.'
-};

package/dist/admin/permissions.model.d.ts

@@ -1,10 +0,0 @@
-export type ManagePermissions = {
-    collections?: {
-        'xp-experiments'?: {
-            update?: boolean | {
-                permission?: boolean;
-            };
-        };
-    };
-};
-export declare function canManage(permissions: ManagePermissions | null | undefined): boolean;

package/dist/admin/permissions.model.js

@@ -1,4 +0,0 @@
-export function canManage(permissions) {
-    const update = permissions?.collections?.['xp-experiments']?.update;
-    return update === true || typeof update === 'object' && update !== null && update.permission === true;
-}

package/dist/admin/phaseHistory.model.d.ts

@@ -1,19 +0,0 @@
-export type HistoryPhase = {
-    phase: number;
-    phaseKind: 'test' | 'rollout';
-    startedAt: string;
-    endedAt?: string | null;
-    arms: readonly {
-        weight: number;
-    }[];
-};
-export declare function phaseHistory(phases: readonly HistoryPhase[], decision?: {
-    decidedBy?: unknown;
-} | null): {
-    rows: {
-        phase: number;
-        phaseKind: "test" | "rollout";
-        text: string;
-    }[];
-    decision: string | null;
-};

package/dist/admin/phaseHistory.model.js

@@ -1,19 +0,0 @@
-import { phaseKindLabel } from './labels.js';
-import { HISTORY_COPY, roundRow } from './copy/history.js';
-const dateFormat = new Intl.DateTimeFormat('en-US', {
-    month: 'short',
-    day: 'numeric',
-    timeZone: 'UTC'
-});
-export function phaseHistory(phases, decision) {
-    return {
-        rows: [
-            ...phases
-        ].sort((a, b)=>a.phase - b.phase || new Date(a.startedAt).getTime() - new Date(b.startedAt).getTime()).map((phase)=>({
-                phase: phase.phase,
-                phaseKind: phase.phaseKind,
-                text: roundRow(phase.phase, phaseKindLabel(phase.phaseKind), dateFormat.format(new Date(phase.startedAt)), phase.endedAt ? dateFormat.format(new Date(phase.endedAt)) : HISTORY_COPY.now, phase.arms.map((arm)=>arm.weight).join('/'))
-            })),
-        decision: decision?.decidedBy != null ? HISTORY_COPY.decided : null
-    };
-}

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

@@ -1,3 +0,0 @@
-import '../styles.js';
-import type { DocumentViewClientProps } from 'payload';
-export declare function ResultsView(_props: DocumentViewClientProps): import("react").JSX.Element;