@delmaredigital/payload-experiments 0.0.0-stage → 0.1.0-rc.3

package/dist/types/manifest.d.ts

@@ -0,0 +1,42 @@
+import type { Arm, DocId, ExposurePolicy, ExperimentKind, TargetingRule, UnitType } from './contracts.js';
+export interface FlagDefault {
+    winnerArm: string;
+    params: Record<string, unknown>;
+    experiment: DocId;
+    decidedAt: string;
+}
+export interface Manifest {
+    v: 1;
+    revision: number;
+    experiments: ManifestExperiment[];
+    flagDefaults: Record<string, FlagDefault>;
+    archivedWinners: Record<string, string>;
+    archivedPages: Record<string, {
+        slug: string;
+        winnerPath: string;
+    }>;
+}
+export interface ManifestExperiment {
+    id: DocId;
+    slug: string;
+    kind: ExperimentKind;
+    unitType: UnitType;
+    status: 'running' | 'decided';
+    phase: number;
+    phaseKind: 'test' | 'rollout';
+    seed: string;
+    flagPoint?: string;
+    coverage: number;
+    arms: Array<Omit<Arm, 'label'>>;
+    targeting: Array<TargetingRule & {
+        type: 'string' | 'number' | 'boolean';
+    }>;
+    layer?: {
+        slug: string;
+        slices: number[];
+    };
+    exposurePolicy: ExposurePolicy;
+    winnerArm?: string;
+    holdoutKey?: string;
+    deferrable: boolean;
+}

package/dist/types/manifest.js

@@ -0,0 +1 @@
+export { };

package/dist/types/puck.d.ts

@@ -0,0 +1,23 @@
+import type { DocId } from './contracts.js';
+import type { Slot } from '@puckeditor/core';
+export type { Slot } from '@puckeditor/core';
+export type ArmSlot = 'control' | 'variantA' | 'variantB' | 'variantC';
+export type ExperimentRef = {
+    id: DocId;
+    slug: string;
+};
+export type ExperimentSlotProps = {
+    experiment: ExperimentRef | null;
+    control: Slot;
+    variantA: Slot;
+    variantB: Slot;
+    variantC: Slot;
+    xpArm?: string;
+    xpSlot?: ArmSlot;
+    xpExpose?: {
+        slug: string;
+        arm: string;
+        phase: number;
+    };
+};
+export declare const EXPERIMENT_SLOT_TYPE: "ExperimentSlot";

package/dist/types/puck.js

@@ -0,0 +1 @@
+export const EXPERIMENT_SLOT_TYPE = 'ExperimentSlot';

package/dist/types/runtime.d.ts

@@ -0,0 +1,59 @@
+import type { Payload } from 'payload';
+import type { NextRequest } from 'next/server';
+import type { Attributes } from './contracts.js';
+import type { Manifest } from './manifest.js';
+export interface ExperimentsProxyRuntimeOptions {
+    secret: string | string[];
+    apiRoute: string;
+    cookie?: {
+        name?: string;
+        maxAgeDays?: number;
+        domain?: string; /** Called with a request whose URL is a placeholder outside the proxy; read cookies and headers only. */
+        consent?(req: NextRequest): boolean;
+    };
+    loadManifest?: (opts?: {
+        ifRevision?: number;
+    }) => Promise<Manifest | 'not-modified' | null>;
+    getUnit?: (req: NextRequest) => {
+        userId?: string;
+        attributes: Attributes;
+        sessionUnknown?: boolean;
+    } | Promise<{
+        userId?: string;
+        attributes: Attributes;
+        sessionUnknown?: boolean;
+    }>;
+}
+export interface ExperimentsProxyRuntime {
+    readonly secrets: readonly string[];
+    readonly apiRoute: string;
+    readonly cookie: {
+        name: string;
+        maxAgeDays: number;
+        domain?: string; /** Called with a request whose URL is a placeholder outside the proxy; read cookies and headers only. */
+        consent?(req: NextRequest): boolean;
+    };
+    readonly loadManifest?: ExperimentsProxyRuntimeOptions['loadManifest'];
+    readonly getUnit?: ExperimentsProxyRuntimeOptions['getUnit'];
+}
+export interface ExperimentsServerRuntimeOptions<TUser extends {
+    id: string | number;
+} = {
+    id: string | number;
+}> {
+    getPayload: () => Promise<Payload>;
+    getUser?: () => Promise<TUser | null>;
+    userIdOf?: (user: TUser) => string;
+    attributesOf?: (user: TUser | null) => Partial<Attributes>;
+}
+export interface ExperimentsServerRuntime<TUser extends {
+    id: string | number;
+} = {
+    id: string | number;
+}> {
+    proxyRuntime: ExperimentsProxyRuntime;
+    getPayload: ExperimentsServerRuntimeOptions<TUser>['getPayload'];
+    getUser?: ExperimentsServerRuntimeOptions<TUser>['getUser'];
+    userIdOf: NonNullable<ExperimentsServerRuntimeOptions<TUser>['userIdOf']>;
+    attributesOf: NonNullable<ExperimentsServerRuntimeOptions<TUser>['attributesOf']>;
+}

package/dist/types/runtime.js

@@ -0,0 +1 @@
+export { };

package/dist/types/snapshot.d.ts

@@ -0,0 +1,117 @@
+import type { GaussianPrior } from '@delmaredigital/experiments-stats';
+import type { DocId, MetricSource } from './contracts.js';
+export type VerdictCode = 'unavailable' | 'data-problem' | 'guardrail-failing' | 'collecting' | 'original-better' | 'worse-none-better' | 'winner' | 'mixed' | 'keep-running' | 'no-difference' | 'rollout-collecting' | 'rollout-readout';
+export interface Snapshot {
+    experiment: DocId;
+    phase: number;
+    phaseKind: 'test' | 'rollout';
+    computedAt: string;
+    winnerArm: string | null;
+    minExposuresPerArm: number;
+    window: {
+        from: string;
+        to: string;
+    };
+    method: 'sequential' | 'bayesian';
+    alpha: number;
+    alphaAdjusted: number;
+    k: number;
+    params: {
+        sequentialTuningParameter: number;
+        prior: GaussianPrior;
+        cupedLookbackDays: number;
+        caps: Record<DocId, {
+            type: 'percentile' | 'absolute';
+            value: number;
+            resolvedCap: number | null;
+            historyUnits?: number;
+        }>;
+        attributionWindows: Record<DocId, number>;
+        guardrailThresholds: Record<DocId, number>;
+        minSampleSizes: Record<DocId, number>;
+        bayesian: {
+            ctw: number;
+            risk: number;
+        };
+    };
+    exposures: {
+        total: number;
+        perArm: Record<string, number>;
+        excludedMultiArm: number;
+        multiArmShare: number;
+        armMismatch: number;
+        identityConflictShare: number;
+        capped: Record<DocId, number>;
+    };
+    srm: {
+        p: number;
+        flagged: boolean;
+        expected: Record<string, number>;
+    };
+    metrics: Array<{
+        metricId: DocId;
+        name: string;
+        kind: MetricSource['kind'];
+        role: 'primary' | 'secondary' | 'guardrail';
+        cupedApplied: boolean;
+        unavailable?: string;
+        perArm: Array<{
+            arm: string;
+            n: number;
+            converters: number;
+            sum: number;
+            sumSquares: number;
+            mean: number;
+            variance: number;
+            covariate?: {
+                preSum: number;
+                preSumSquares: number;
+                postPreSumOfProducts: number;
+            };
+            capped?: {
+                resolvedCap: number;
+                uncappedTotal: number;
+                cappedCount: number;
+            };
+        }>;
+        comparisons: Array<{
+            arm: string;
+            lift: number;
+            ci: [number | null, number | null];
+            ciAdjusted: [number | null, number | null];
+            pValue?: number;
+            pValueAdjusted?: number;
+            chanceToWin?: number;
+            risk?: number;
+            significant: 'better' | 'worse' | 'none';
+        }>;
+    }>;
+    guardrails: Array<{
+        metricId: DocId;
+        status: 'failing' | 'ok' | 'warning' | 'insufficient';
+    }>;
+    power: {
+        daysRemaining: number | null;
+        exposuresNeededPerArm: number | null;
+        lowerBound: boolean;
+        feasible: boolean;
+    };
+    verdict: {
+        row: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 'R1' | 'R2' | 'R3';
+        code: VerdictCode;
+        finding: string;
+        action: string | null;
+        headline: string;
+        detail: string;
+        recommendedArm: string | null;
+        guardrailLine?: string;
+    };
+    contentChanges: Array<{
+        at: string;
+        doc: {
+            collection: string;
+            id: DocId;
+        };
+        by: DocId | null;
+    }>;
+}

package/dist/types/snapshot.js

@@ -0,0 +1 @@
+export { };

package/package.json

@@ -1,6 +1,140 @@
 {
   "name": "@delmaredigital/payload-experiments",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0-rc.3",
+  "description": "No-code A/B testing for Payload CMS and Next.js: block, page and flag experiments with holdouts, layers, exposure logging and honest statistics inside the admin — no vendor",
+  "type": "module",
+  "license": "MIT",
+  "main": "./dist/exports/index.js",
+  "types": "./dist/exports/index.d.ts",
+  "exports": {
+    ".": {
+      "@delmaredigital/source": "./src/exports/index.ts",
+      "types": "./dist/exports/index.d.ts",
+      "import": "./dist/exports/index.js",
+      "default": "./dist/exports/index.js"
+    },
+    "./runtime/proxy": {
+      "@delmaredigital/source": "./src/exports/runtimeProxy.ts",
+      "types": "./dist/exports/runtimeProxy.d.ts",
+      "import": "./dist/exports/runtimeProxy.js",
+      "default": "./dist/exports/runtimeProxy.js"
+    },
+    "./runtime/server": {
+      "@delmaredigital/source": "./src/exports/runtimeServer.ts",
+      "types": "./dist/exports/runtimeServer.d.ts",
+      "import": "./dist/exports/runtimeServer.js",
+      "default": "./dist/exports/runtimeServer.js"
+    },
+    "./proxy": {
+      "@delmaredigital/source": "./src/exports/proxy.ts",
+      "types": "./dist/exports/proxy.d.ts",
+      "import": "./dist/exports/proxy.js",
+      "default": "./dist/exports/proxy.js"
+    },
+    "./rsc": {
+      "@delmaredigital/source": "./src/exports/rsc.ts",
+      "types": "./dist/exports/rsc.d.ts",
+      "import": "./dist/exports/rsc.js",
+      "default": "./dist/exports/rsc.js"
+    },
+    "./client": {
+      "@delmaredigital/source": "./src/exports/client.ts",
+      "types": "./dist/exports/client.d.ts",
+      "import": "./dist/exports/client.js",
+      "default": "./dist/exports/client.js"
+    },
+    "./admin/client": {
+      "@delmaredigital/source": "./src/exports/adminClient.ts",
+      "types": "./dist/exports/adminClient.d.ts",
+      "import": "./dist/exports/adminClient.js",
+      "default": "./dist/exports/adminClient.js"
+    },
+    "./puck": {
+      "@delmaredigital/source": "./src/exports/puck.ts",
+      "types": "./dist/exports/puck.d.ts",
+      "import": "./dist/exports/puck.js",
+      "default": "./dist/exports/puck.js"
+    },
+    "./puck/editor": {
+      "@delmaredigital/source": "./src/exports/puckEditor.ts",
+      "types": "./dist/exports/puckEditor.d.ts",
+      "import": "./dist/exports/puckEditor.js",
+      "default": "./dist/exports/puckEditor.js"
+    }
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "peerDependencies": {
+    "@payloadcms/next": ">=3.90.0 <4",
+    "@payloadcms/ui": ">=3.90.0 <4",
+    "@puckeditor/core": ">=0.24.0",
+    "next": ">=16.4.1 <17",
+    "payload": ">=3.90.0 <4",
+    "react": ">=19.2.1 <20",
+    "react-dom": ">=19.2.1 <20",
+    "@payloadcms/db-postgres": ">=3.90.0 <4",
+    "pg": ">=8.13.0 <9"
+  },
+  "peerDependenciesMeta": {
+    "@puckeditor/core": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@delmaredigital/experiments-stats": "0.1.0"
+  },
+  "keywords": [
+    "payload",
+    "payloadcms",
+    "payload-plugin",
+    "ab-testing",
+    "experimentation",
+    "feature-flags",
+    "puck",
+    "nextjs"
+  ],
+  "engines": {
+    "node": ">=22.23.4"
+  },
+  "author": "Delmare Digital",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/delmaredigital/payload-experiments.git",
+    "directory": "packages/plugin"
+  },
+  "bugs": {
+    "url": "https://github.com/delmaredigital/payload-experiments/issues"
+  },
+  "homepage": "https://delmaredigital.com/developers",
+  "devDependencies": {
+    "payload": "^3.90.2",
+    "@payloadcms/db-postgres": "^3.90.2",
+    "@payloadcms/ui": "^3.90.2",
+    "@payloadcms/next": "^3.90.2",
+    "next": "^16.4.2",
+    "react": "^19.2.8",
+    "react-dom": "^19.2.8",
+    "@types/react": "^19.3.0",
+    "@types/react-dom": "^19.3.0",
+    "pg": "8.20.0",
+    "@types/pg": "8.20.0",
+    "jsdom": "^30.1.3",
+    "@testing-library/react": "^16.3.3",
+    "@testing-library/dom": "^10.4.2",
+    "@electric-sql/pglite": "^0.5.13",
+    "@puckeditor/core": "^0.24.0",
+    "drizzle-orm": "0.45.2",
+    "drizzle-kit": "0.31.7"
+  },
+  "scripts": {
+    "build": "swc ./src -d ./dist --strip-leading-paths --config-file ../../.swcrc && tsc -p tsconfig.build.json && copyfiles -u 1 \"src/**/*.css\" dist",
+    "dev": "swc ./src -d ./dist --strip-leading-paths --config-file ../../.swcrc --watch",
+    "typecheck": "tsc -p tsconfig.json && tsc -p tsconfig.test.json",
+    "check:esm": "node scripts/check-node-esm.mjs",
+    "check:package": "node scripts/check-package.mjs",
+    "clean": "rm -rf dist"
+  }
 }