crexperium-sdk 1.2.3 → 1.2.5

package/dist/resources/experiments.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Experiments API Resource
+ * Handles A/B testing and feature flagging
+ */
+import { BaseResource } from './base';
+import { Experiment, VariantAssignment, AssignVariantInput, TrackConversionInput } from '../types/experiments';
+export declare class ExperimentsResource extends BaseResource {
+    /**
+     * Get an experiment by ID or key
+     */
+    get(experimentIdOrKey: string): Promise<Experiment>;
+    /**
+     * Get a variant assignment for a visitor
+     * This is the main SDK method for A/B testing
+     *
+     * @param experimentKey - The unique key of the experiment
+     * @param visitorId - The unique identifier for the visitor
+     * @param context - Optional context data (user agent, device, etc.)
+     * @returns The assigned variant with its payload
+     *
+     * @example
+     * ```typescript
+     * const assignment = await client.experiments.assign('checkout_button_test', {
+     *   visitor_id: 'visitor_123',
+     *   context: {
+     *     user_agent: navigator.userAgent,
+     *     device_type: 'desktop',
+     *     browser: 'chrome'
+     *   }
+     * });
+     *
+     * // Use the variant payload
+     * const buttonColor = assignment.variant.payload.button_color;
+     * ```
+     */
+    assign(experimentKey: string, input: AssignVariantInput): Promise<VariantAssignment>;
+    /**
+     * Track a conversion for a visitor in an experiment
+     * Call this when a visitor completes the desired action
+     *
+     * @param experimentKey - The unique key of the experiment
+     * @param input - Conversion data including visitor_id
+     *
+     * @example
+     * ```typescript
+     * await client.experiments.trackConversion('checkout_button_test', {
+     *   visitor_id: 'visitor_123',
+     *   event_name: 'purchase',
+     *   event_properties: {
+     *     amount: 99.99,
+     *     currency: 'USD'
+     *   }
+     * });
+     * ```
+     */
+    trackConversion(experimentKey: string, input: TrackConversionInput): Promise<void>;
+    /**
+     * Get a variant assignment and automatically track the exposure
+     * This combines assign() and exposure tracking in one call
+     *
+     * @param experimentKey - The unique key of the experiment
+     * @param input - Assignment data including visitor_id
+     * @returns The assigned variant with its payload
+     */
+    getVariant(experimentKey: string, input: AssignVariantInput): Promise<VariantAssignment>;
+}

package/dist/types/experiments.d.ts

@@ -0,0 +1,71 @@
+/**
+ * Types for Experiments module (A/B Testing)
+ */
+export type ExperimentStatus = 'DRAFT' | 'RUNNING' | 'PAUSED' | 'COMPLETED' | 'ARCHIVED';
+/**
+ * Experiment Variant
+ */
+export interface ExperimentVariant {
+    id: string;
+    experiment: string;
+    name: string;
+    key: string;
+    description?: string;
+    rollout_percentage: number;
+    payload: Record<string, any>;
+    is_control: boolean;
+    is_active: boolean;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * Experiment
+ */
+export interface Experiment {
+    id: string;
+    organization: string;
+    name: string;
+    key: string;
+    description?: string;
+    status: ExperimentStatus;
+    started_at?: string | null;
+    paused_at?: string | null;
+    completed_at?: string | null;
+    targeting_rules: Record<string, any>;
+    winning_variant?: string | null;
+    total_assignments: number;
+    created_at: string;
+    updated_at: string;
+    variants: ExperimentVariant[];
+}
+/**
+ * Variant Assignment Response (SDK)
+ */
+export interface VariantAssignment {
+    variant: {
+        id: string;
+        key: string;
+        name: string;
+        payload: Record<string, any>;
+    };
+    was_created: boolean;
+}
+/**
+ * Assign Variant Input (SDK)
+ */
+export interface AssignVariantInput {
+    visitor_id: string;
+    context?: {
+        user_agent?: string;
+        device_type?: string;
+        browser?: string;
+    };
+}
+/**
+ * Track Conversion Input
+ */
+export interface TrackConversionInput {
+    visitor_id: string;
+    event_name?: string;
+    event_properties?: Record<string, any>;
+}

package/dist/types/index.d.ts

@@ -6,3 +6,4 @@ export * from './events';
 export * from './contacts';
 export * from './deals';
 export * from './session-replay';
+export * from './experiments';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "crexperium-sdk",
-  "version": "1.2.3",
+  "version": "1.2.5",
   "description": "Official TypeScript/JavaScript SDK for Crexperium CRM",
   "main": "dist/index.js",
   "module": "dist/index.mjs",