@focus-reactive/payload-plugin-ab 1.0.0

package/dist/types-OJFBnrUD.d.ts

@@ -0,0 +1,72 @@
+type TrackMetadata = Record<string, string | number | boolean>;
+interface TrackImpressionArgs {
+    /** The experiment identifier — typically the URL path, e.g. "/en/about" */
+    experimentId: string;
+    /** The assigned variant bucket, e.g. "a", "b" */
+    variantBucket: string;
+    visitorId: string;
+    locale?: string;
+    metadata?: TrackMetadata;
+}
+interface TrackConversionArgs {
+    /** The experiment identifier — typically the URL path, e.g. "/en/about" */
+    experimentId: string;
+    /** The assigned variant bucket, e.g. "a", "b" */
+    variantBucket: string;
+    visitorId: string;
+    /** Identifies what conversion goal was achieved, e.g. "cta_click", "purchase" */
+    goalId: string;
+    /** Optional numeric value for statistics */
+    goalValue?: number;
+    locale?: string;
+    metadata?: TrackMetadata;
+}
+interface DateRange {
+    /** 'NdaysAgo' or 'YYYY-MM-DD' */
+    startDate: string;
+    /** 'NdaysAgo', 'today', or 'YYYY-MM-DD' */
+    endDate: string;
+}
+interface VariantStats {
+    bucket: string;
+    impressions: number;
+    /** Fraction of total impressions (0–1) */
+    impressionShare: number;
+    conversions: number;
+    /** conversions / impressions (0–1), 0 when impressions = 0 */
+    conversionRate: number;
+}
+interface ExperimentStats {
+    experimentId: string;
+    dateRange: DateRange;
+    variants: VariantStats[];
+    totals: {
+        impressions: number;
+        conversions: number;
+    };
+}
+interface AnalyticsAdapter {
+    /**
+     * Fire when a user is assigned to and shown a variant.
+     * Called client-side from ExperimentTracker.
+     */
+    trackImpression(args: TrackImpressionArgs): void;
+    /**
+     * Fire when a user completes a conversion goal.
+     * Called client-side from useABConversion.
+     */
+    trackConversion(args: TrackConversionArgs): void;
+    /**
+     * Optional: fire an impression server-side (RSC / Server Action / middleware).
+     * Implemented via GA4 Measurement Protocol when apiSecret is provided.
+     */
+    trackImpressionServer?(args: TrackImpressionArgs): Promise<void>;
+    /**
+     * Optional: fetch aggregated stats for an experiment.
+     * Powers the ExperimentStatsWidget admin component.
+     * Requires propertyId and getAccessToken in the adapter config.
+     */
+    getStats?(experimentId: string, dateRange?: DateRange): Promise<ExperimentStats>;
+}
+
+export type { AnalyticsAdapter as A, DateRange as D, ExperimentStats as E, TrackConversionArgs as T, VariantStats as V, TrackImpressionArgs as a };

package/package.json

@@ -0,0 +1,122 @@
+{
+  "name": "@focus-reactive/payload-plugin-ab",
+  "version": "1.0.0",
+  "description": "A/B testing plugin for Payload CMS",
+  "keywords": [
+    "payload-cms",
+    "payload-plugin",
+    "ab-testing",
+    "split-testing",
+    "a-b-testing",
+    "page-variants",
+    "next.js",
+    "vercel-edge",
+    "edge-config",
+    "middleware",
+    "typescript",
+    "cms",
+    "conversion-optimization"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/focusreactive/payload-plugin-ab"
+  },
+  "author": "Kiryl Pekarski <kiryl.pekarski@fr.team>",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "typesVersions": {
+    "*": {
+      "adapters/payload-global": [
+        "./dist/adapters/payloadGlobal/index.d.ts"
+      ],
+      "adapters/vercel-edge": [
+        "./dist/adapters/vercelEdge/index.d.ts"
+      ],
+      "analytics": [
+        "./dist/analytics/index.d.ts"
+      ],
+      "analytics/client": [
+        "./dist/analytics/client.d.ts"
+      ],
+      "analytics/adapters/google-analytics": [
+        "./dist/analytics/adapters/googleAnalytics/index.d.ts"
+      ],
+      "middleware": [
+        "./dist/middleware/index.d.ts"
+      ]
+    }
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./adapters/payload-global": {
+      "import": "./dist/adapters/payloadGlobal/index.js",
+      "types": "./dist/adapters/payloadGlobal/index.d.ts"
+    },
+    "./adapters/vercel-edge": {
+      "import": "./dist/adapters/vercelEdge/index.js",
+      "types": "./dist/adapters/vercelEdge/index.d.ts"
+    },
+    "./analytics": {
+      "import": "./dist/analytics/index.js",
+      "types": "./dist/analytics/index.d.ts"
+    },
+    "./analytics/client": {
+      "import": "./dist/analytics/client.js",
+      "types": "./dist/analytics/client.d.ts"
+    },
+    "./analytics/adapters/google-analytics": {
+      "import": "./dist/analytics/adapters/googleAnalytics/index.js",
+      "types": "./dist/analytics/adapters/googleAnalytics/index.d.ts"
+    },
+    "./middleware": {
+      "import": "./dist/middleware/index.js",
+      "types": "./dist/middleware/index.d.ts"
+    }
+  },
+  "scripts": {
+    "build": "tsup",
+    "lint": "eslint src/",
+    "lint:fix": "eslint src/ --fix",
+    "format": "prettier --write src/",
+    "format:check": "prettier --check src/"
+  },
+  "peerDependencies": {
+    "next": "^14.0.0 || ^15.0.0",
+    "payload": "^3.0.0",
+    "react": "^18.0.0 || ^19.0.0"
+  },
+  "peerDependenciesMeta": {
+    "next": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    }
+  },
+  "optionalDependencies": {
+    "@vercel/edge-config": "^1.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "@types/react": "^19.0.0",
+    "eslint": "^9.0.0",
+    "eslint-config-prettier": "^9.0.0",
+    "next": "15.4.10",
+    "payload": "3.73.0",
+    "prettier": "^3.0.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0",
+    "typescript-eslint": "^8.0.0"
+  }
+}