@runbandit/sdk 3.1.3 → 3.3.0

package/dist/index.d.ts

@@ -1,470 +1,5 @@
-declare const STOREFRONT_KINDS: readonly ["text", "image", "ordering", "offer"];
-type StorefrontKind = (typeof STOREFRONT_KINDS)[number];
-declare const PLACEMENTS_BY_KIND: {
-    readonly text: readonly ["hero_headline", "hero_subhead", "cta_primary", "banner_text", "badge_text"];
-    readonly image: readonly ["hero_image", "banner_image", "feature_image"];
-    readonly ordering: readonly ["product_list_primary", "product_list_secondary"];
-    readonly offer: readonly ["offer_banner"];
-};
-type Placement = (typeof PLACEMENTS_BY_KIND)[StorefrontKind][number];
-declare const PLACEMENTS: readonly Placement[];
-declare function isPlacement(value: unknown): value is Placement;
-declare function kindOfPlacement(placement: Placement): StorefrontKind;
-declare const CONTENT_TYPE_BY_KIND: {
-    readonly text: {
-        readonly contentType: "TEXT";
-        readonly contentSubtype: "plain_text";
-    };
-    readonly image: {
-        readonly contentType: "FILE";
-        readonly contentSubtype: "image";
-    };
-    readonly ordering: {
-        readonly contentType: "CODE";
-        readonly contentSubtype: "json";
-    };
-    readonly offer: {
-        readonly contentType: "CODE";
-        readonly contentSubtype: "json";
-    };
-};
-declare const MIN_ORDERING_ITEMS = 2;
-declare const MAX_ORDERING_ITEMS = 12;
-interface ImageContent {
-    url: string;
-    alt: string;
-    width: number;
-    height: number;
-    sourceId: string;
-}
-interface OfferContent {
-    discountId: string;
-    code: string;
-    headline: string;
-    subtext: string;
-}
-type TreatmentContent = {
-    kind: 'text';
-    text: string;
-} | {
-    kind: 'image';
-    image: ImageContent;
-} | {
-    kind: 'ordering';
-    productIds: string[];
-} | {
-    kind: 'offer';
-    offer: OfferContent | null;
-};
-declare function isShopifyCdnUrl(value: string): boolean;
-declare function parseTreatmentContent(kind: StorefrontKind, config: unknown): TreatmentContent | null;
-declare function serializeTreatmentConfig(content: TreatmentContent): {
-    content: unknown;
-};
-
-declare const SITE_TARGET_KINDS: readonly ["text", "image"];
-type SiteTargetKind = (typeof SITE_TARGET_KINDS)[number];
-interface SiteTarget {
-    page: string;
-    selector: string;
-    tag: string;
-    kind: SiteTargetKind;
-    original: string;
-}
-type FunnelGoal = {
-    kind: 'page';
-    page: string;
-} | {
-    kind: 'click';
-    page: string;
-    selector: string;
-    tag: string;
-    label: string;
-};
-declare function parseSiteContent(config: unknown): string | null;
-declare function normalizeSiteTarget(target: SiteTarget): SiteTarget;
-declare function normalizeFunnelGoal(goal: FunnelGoal): FunnelGoal;
-declare function targetMatchesPage(target: Pick<SiteTarget, 'page'>, pathname: string): boolean;
-declare function goalMatchesPage(goal: Pick<FunnelGoal, 'page'>, pathname: string): boolean;
-declare const MAX_ALTERNATIVES = 5;
-declare const MAX_TEXT_ALTERNATIVE_LENGTH = 300;
-declare const MAX_IMAGE_URL_LENGTH = 2048;
-interface PickDraft {
-    target?: SiteTarget;
-    alternatives: string[];
-    goal?: FunnelGoal;
-}
-interface PickState {
-    funnelId: string;
-    siteHost: string;
-    expiresAt: number;
-    draft: PickDraft;
-    funnelGoal: FunnelGoal | null;
-    experimentId: string | null;
-    runningExperiments: number;
-}
-declare const SUGGESTED_SITE_EXPERIMENTS = 3;
-declare function moreExperimentsSentence(running: number, suggested: number): string;
-type PickStep = 'pick' | 'alternatives' | 'goal' | 'ready' | 'live';
-declare function pickStep(state: Pick<PickState, 'draft' | 'funnelGoal' | 'experimentId'>): PickStep;
-declare function parseAlternative(kind: SiteTargetKind, raw: string): string;
-declare const PICK_CHANNEL = "bandit-pick";
-declare const PICK_PROTOCOL_VERSION = 1;
-declare const PICK_MODES: readonly ["idle", "target", "goal-click"];
-type PickMode = (typeof PICK_MODES)[number];
-declare const PICK_REJECTIONS: readonly ["not-text-or-image", "has-markup", "not-clickable", "no-selector"];
-type PickRejection = (typeof PICK_REJECTIONS)[number];
-type ClickFunnelGoal = Extract<FunnelGoal, {
-    kind: 'click';
-}>;
-type PickerToPanel = {
-    type: 'navigated';
-    page: string;
-} | {
-    type: 'target-picked';
-    target: SiteTarget;
-} | {
-    type: 'goal-picked';
-    goal: ClickFunnelGoal;
-} | {
-    type: 'rejected';
-    reason: PickRejection;
-} | {
-    type: 'cancelled';
-};
-type PanelToPicker = {
-    type: 'hello';
-} | {
-    type: 'mode';
-    mode: PickMode;
-} | {
-    type: 'preview';
-    target: SiteTarget;
-    content: string;
-} | {
-    type: 'clear-preview';
-} | {
-    type: 'finish';
-} | {
-    type: 'renew';
-    token: string;
-};
-declare const PICK_TOKEN_PREFIX = "bpick_";
-interface PickEnvelope<M> {
-    channel: typeof PICK_CHANNEL;
-    v: typeof PICK_PROTOCOL_VERSION;
-    msg: M;
-}
-declare function pickEnvelope<M extends PickerToPanel | PanelToPicker>(msg: M): PickEnvelope<M>;
-declare function parsePickerMessage(data: unknown): PickerToPanel | null;
-declare function parsePanelMessage(data: unknown): PanelToPicker | null;
-
-interface Company {
-    id: string;
-    name: string;
-    subdomain?: string;
-    domain?: string;
-    plan: string;
-    apiKey: string;
-    status: string;
-    createdAt: Date;
-    updatedAt: Date;
-}
-interface User {
-    id: string;
-    email: string;
-    name: string;
-    image?: string;
-    role: string;
-    companyId: string | null;
-    emailVerified?: boolean;
-    createdAt: Date;
-    updatedAt: Date;
-}
-interface Session {
-    id: string;
-    userId: string;
-    token: string;
-    expiresAt: Date;
-    ipAddress?: string | null;
-    userAgent?: string | null;
-    createdAt: Date;
-    updatedAt: Date;
-}
-interface Account {
-    id: string;
-    userId: string;
-    provider: string;
-    providerAccountId: string;
-    accessToken?: string;
-    refreshToken?: string;
-    accessTokenExpiresAt?: Date;
-    refreshTokenExpiresAt?: Date;
-    scope?: string;
-    idToken?: string;
-    sessionState?: string;
-    createdAt: Date;
-    updatedAt: Date;
-}
-interface Experiment {
-    id: string;
-    name: string;
-    description?: string;
-    algorithm: BanditAlgorithm;
-    forgetting?: ForgettingConfig;
-    status: ExperimentStatus;
-    contentType: ContentType;
-    treatments: Treatment[];
-    context?: Record<string, any>;
-    bundleId?: string;
-    image?: string;
-    emoji?: string;
-    assignmentTtl: number;
-    companyId: string;
-    createdAt: Date;
-    updatedAt: Date;
-    endAt?: Date;
-    placement?: Placement;
-}
-interface Treatment {
-    id: string;
-    experimentId: string;
-    name: string;
-    description?: string;
-    config: VariantConfig;
-    weight?: number;
-    companyId: string;
-    createdAt: Date;
-}
-interface AlgorithmResult {
-    treatmentId: string;
-    confidence: number;
-    probabilityBest?: number;
-}
-interface BanditResult {
-    assignmentId: string;
-    treatmentId: string;
-    confidence: number;
-    probabilityBest?: number;
-    metadata?: Record<string, any>;
-}
-interface ContextualFeatures {
-    [key: string]: string | number | boolean;
-}
-declare enum ExperimentStatus {
-    DRAFT = "draft",
-    ACTIVE = "active",
-    PAUSED = "paused",
-    COMPLETED = "completed",
-    ARCHIVED = "archived"
-}
-interface TreatmentMetadata {
-    strategy?: string;
-    tone?: string;
-    ctaStyle?: string;
-    emotionalHook?: string;
-    reasoning?: string;
-    tags?: string[];
-    generated?: boolean;
-    generatedAt?: string;
-}
-interface VariantConfig {
-    content: string;
-    metadata?: TreatmentMetadata & Record<string, any>;
-}
-declare enum BanditAlgorithm {
-    THOMPSON_SAMPLING = "thompson_sampling",
-    CONTEXTUAL_LINEAR = "contextual_linear"
-}
-declare enum Posterior {
-    BETA = "beta",
-    NORMAL_GAMMA = "normal_gamma"
-}
-declare function normalizePosterior(posterior: string | null | undefined): Posterior;
-declare enum ForgettingMode {
-    NONE = "none",
-    DISCOUNTED = "discounted",
-    SLIDING_WINDOW = "sliding_window"
-}
-interface ForgettingConfig {
-    mode: ForgettingMode;
-    halfLifeMs?: number;
-    windowMs?: number;
-}
-declare const DEFAULT_HALF_LIFE_MS: number;
-declare const DEFAULT_WINDOW_MS: number;
-declare const STATIONARY: ForgettingConfig;
-declare function resolveForgetting(config?: Partial<ForgettingConfig> | null): ForgettingConfig;
-declare function normalizeAlgorithm(algorithm: string | null | undefined): BanditAlgorithm;
-declare enum ContentType {
-    PLAIN_TEXT = "plain_text",
-    MARKDOWN = "markdown",
-    HTML = "html",
-    CSS = "css",
-    JAVASCRIPT = "javascript",
-    JSON = "json",
-    IMAGE = "image",
-    VIDEO = "video",
-    AUDIO = "audio",
-    DOCUMENT = "document"
-}
-declare function getContentTypeCategory(contentType: ContentType): 'text' | 'code' | 'file';
-interface BanditConfig {
-    algorithm: BanditAlgorithm;
-    parameters: Record<string, any>;
-}
-interface ExperimentStats {
-    totalAssignments: number;
-    totalConversions: number;
-    conversionRate: number;
-    treatmentStats: Record<string, TreatmentStats>;
-}
-interface TreatmentStats {
-    assignments: number;
-    conversions: number;
-    conversionRate: number;
-    confidence: number;
-    lift?: number;
-}
-interface APIResponse<T = any> {
-    success: boolean;
-    data?: T;
-    error?: string;
-    timestamp: Date;
-}
-interface CreateExperimentRequest {
-    name: string;
-    description?: string;
-    algorithm: BanditAlgorithm;
-    contentType: ContentType;
-    algorithmConfig?: Record<string, any>;
-    treatments?: Omit<Treatment, 'id' | 'experimentId' | 'createdAt'>[];
-}
-interface AssignmentRequest {
-    experimentId: string;
-    userId: string;
-    context?: ContextualFeatures;
-    sessionId?: string;
-    pageUrl?: string;
-}
-interface TrackNamedEventRequest {
-    name: string;
-    category?: string;
-    value?: number;
-    metadata?: Record<string, any>;
-    sessionId: string;
-    userId?: string;
-    assignmentId?: string;
-}
-declare enum FunnelStatus {
-    DRAFT = "draft",
-    ACTIVE = "active",
-    PAUSED = "paused",
-    COMPLETED = "completed"
-}
-interface Funnel {
-    id: string;
-    name: string;
-    description?: string;
-    status: FunnelStatus;
-    inactivityTimeoutMs?: number;
-    revisionWindowMs?: number;
-    companyId: string;
-    createdAt: Date;
-    updatedAt: Date;
-}
-interface FunnelRewardRequest {
-    funnelId: string;
-    userId: string;
-    value: number;
-}
-interface ApiKey {
-    id: string;
-    name: string;
-    keyPrefix: string;
-    status: 'active' | 'revoked';
-    createdBy: string;
-    createdAt: Date;
-    lastUsedAt?: Date;
-    revokedAt?: Date;
-    revokedBy?: string;
-}
-interface CreateApiKeyRequest {
-    name: string;
-}
-interface CreateApiKeyResponse {
-    id: string;
-    key: string;
-    name: string;
-}
-type IdentifyMergeReason = 'user_signup' | 'email_verification' | 'social_login' | 'account_recovery' | 'manual';
-interface IdentifyUserRequest {
-    anonymousId: string;
-    identifiedUserId: string;
-    mergeReason?: IdentifyMergeReason;
-}
-interface IdentifyUserResponse {
-    anonymousId: string;
-    identifiedUserId: string;
-    alreadyMapped: boolean;
-}
-interface ResolvedIdentity {
-    canonicalId: string;
-    anonymousIds: string[];
-    isIdentified: boolean;
-}
-type BundleMode = 'factored' | 'joint';
-interface Bundle {
-    id: string;
-    name: string;
-    description?: string;
-    status: ExperimentStatus;
-    mode: BundleMode;
-    funnelId?: string;
-    assignmentTtl: number;
-    conversionWindowMs: number;
-    inactivityTimeoutMs?: number;
-    revisionWindowMs?: number;
-    companyId: string;
-    createdAt: Date;
-    updatedAt: Date;
-}
-interface BundleAssignmentRequest {
-    bundleId: string;
-    userId: string;
-    context?: ContextualFeatures;
-    sessionId?: string;
-    pageUrl?: string;
-}
-interface BundleSlotAssignment {
-    assignmentId: string;
-    experimentId: string;
-    treatmentId: string;
-    config: VariantConfig | Record<string, unknown>;
-}
-interface BundleAssignmentResponse {
-    bundleAssignmentId: string;
-    slots: Record<string, BundleSlotAssignment>;
-}
-interface SnapshotTreatment {
-    id: string;
-    name?: string;
-    config: unknown;
-    pct: number;
-}
-interface SnapshotExperiment {
-    mode: 'snapshot' | 'network';
-    assignmentTtl: number;
-    treatments: SnapshotTreatment[];
-    target?: SiteTarget;
-    funnelId?: string;
-}
-interface CompanySnapshot {
-    ttl: number;
-    generatedAt: number;
-    experiments: Record<string, SnapshotExperiment>;
-    goals?: Record<string, FunnelGoal>;
-}
+import { T as Treatment, C as ContextualFeatures, B as BundleAssignmentResponse, a as CompanySnapshot, S as SnapshotTreatment } from './decision-cookie-Mb4G_lTe.js';
+export { H as APIResponse, A as Account, g as AlgorithmResult, O as ApiKey, J as AssignmentRequest, l as BanditAlgorithm, y as BanditConfig, h as BanditResult, $ as Bundle, a0 as BundleAssignmentRequest, _ as BundleMode, a1 as BundleSlotAssignment, a9 as CONTENT_TYPE_BY_KIND, aH as ClickFunnelGoal, e as Company, w as ContentType, c as CookieDecision, d as CookieDecisions, Q as CreateApiKeyRequest, R as CreateApiKeyResponse, I as CreateExperimentRequest, D as DECISIONS_COOKIE, o as DEFAULT_HALF_LIFE_MS, q as DEFAULT_WINDOW_MS, E as Experiment, z as ExperimentStats, i as ExperimentStatus, m as ForgettingConfig, F as ForgettingMode, M as Funnel, al as FunnelGoal, N as FunnelRewardRequest, L as FunnelStatus, W as IdentifyMergeReason, X as IdentifyUserRequest, Y as IdentifyUserResponse, ac as ImageContent, ar as MAX_ALTERNATIVES, at as MAX_IMAGE_URL_LENGTH, ab as MAX_ORDERING_ITEMS, as as MAX_TEXT_ALTERNATIVE_LENGTH, aa as MIN_ORDERING_ITEMS, ad as OfferContent, aB as PICK_CHANNEL, aD as PICK_MODES, aC as PICK_PROTOCOL_VERSION, aF as PICK_REJECTIONS, aK as PICK_TOKEN_PREFIX, a6 as PLACEMENTS, a4 as PLACEMENTS_BY_KIND, aJ as PanelToPicker, au as PickDraft, aL as PickEnvelope, aE as PickMode, aG as PickRejection, av as PickState, ay as PickStep, aI as PickerToPanel, a5 as Placement, P as Posterior, Z as ResolvedIdentity, ai as SITE_TARGET_KINDS, t as STATIONARY, a2 as STOREFRONT_KINDS, aw as SUGGESTED_SITE_EXPERIMENTS, f as Session, ak as SiteTarget, aj as SiteTargetKind, b as SnapshotExperiment, a3 as StorefrontKind, K as TrackNamedEventRequest, ae as TreatmentContent, j as TreatmentMetadata, G as TreatmentStats, U as User, V as VISITOR_COOKIE, k as VariantConfig, x as getContentTypeCategory, aq as goalMatchesPage, a7 as isPlacement, af as isShopifyCdnUrl, a8 as kindOfPlacement, ax as moreExperimentsSentence, v as normalizeAlgorithm, ao as normalizeFunnelGoal, n as normalizePosterior, an as normalizeSiteTarget, aA as parseAlternative, p as parseDecisions, aO as parsePanelMessage, aN as parsePickerMessage, am as parseSiteContent, ag as parseTreatmentContent, aM as pickEnvelope, az as pickStep, r as readCookie, u as resolveForgetting, s as serializeDecisions, ah as serializeTreatmentConfig, ap as targetMatchesPage } from './decision-cookie-Mb4G_lTe.js';
 
 declare function validateTreatmentWeights(treatments: Treatment[]): boolean;
 declare function normalizeTreatmentWeights(treatments: Treatment[]): Treatment[];
@@ -689,6 +224,7 @@ interface BanditsClientConfig {
     batchSize?: number;
     flushInterval?: number;
     sessionTtl?: number;
+    visitorId?: string;
 }
 declare class BanditsRequestError extends Error {
     readonly status: number | undefined;
@@ -831,4 +367,4 @@ declare function reportPlanImpressions(plan: EmailPlan, recipientIds: string[],
     alreadyRecorded: boolean;
 }>;
 
-export { type APIResponse, type Account, type AlgorithmResult, type ApiKey, type Assignment, type AssignmentRequest, BanditAlgorithm, BanditsClient as BanditClient, type BanditConfig, type BanditResult, BanditsClient, type BanditsClientConfig, BanditsRequestError, type Bound, type Bundle, type BundleAssignmentRequest, type BundleAssignmentResponse, type BundleMode, type BundleSlotAssignment, type ButtonBlock, CONTENT_TYPE_BY_KIND, type ClickFunnelGoal, type Company, type CompanySnapshot, ContentType, type ContextualFeatures, type CreateApiKeyRequest, type CreateApiKeyResponse, type CreateExperimentRequest, DEFAULT_HALF_LIFE_MS, DEFAULT_SESSION_TTL_MS, DEFAULT_WINDOW_MS, type DividerBlock, EMAIL_TOKEN_PARAM, type EmailBlock, type EmailDocument, type EmailPlan, type EmailTokenPayload, type Experiment, type ExperimentStats, ExperimentStatus, type ForgettingConfig, ForgettingMode, type Funnel, type FunnelGoal, type FunnelRewardRequest, FunnelStatus, type HeadingBlock, type IdentifyMergeReason, type IdentifyUserRequest, type IdentifyUserResponse, type ImageBlock, type ImageContent, MAX_ALTERNATIVES, MAX_IMAGE_URL_LENGTH, MAX_ORDERING_ITEMS, MAX_TEXT_ALTERNATIVE_LENGTH, MIN_ORDERING_ITEMS, type OfferContent, PICK_CHANNEL, PICK_MODES, PICK_PROTOCOL_VERSION, PICK_REJECTIONS, PICK_TOKEN_PREFIX, PLACEMENTS, PLACEMENTS_BY_KIND, type PanelToPicker, type PickDraft, type PickEnvelope, type PickMode, type PickRejection, type PickState, type PickStep, type PickerToPanel, type Placement, type PlanArm, type PlanRenderResult, type PlanSlot, Posterior, type RenderEmailOptions, type RenderedDocument, type RenderedEmail, type ResolvedIdentity, type RewriteOptions, type RewriteResult, SCRIPT_PLATFORMS, SESSION_CREATED_AT_KEY, SESSION_ID_KEY, SITE_PLATFORMS, SITE_PLATFORM_IDS, SITE_TARGET_KINDS, STATIONARY, STOREFRONT_KINDS, SUGGESTED_SITE_EXPERIMENTS, type ScriptPlatform, type Session, type SessionOptions, type SigningKey, type SitePlatform, type SitePlatformId, type SitePlatformPath, type SiteTarget, type SiteTargetKind, type SlotBinding, SnapshotClient, type SnapshotClientConfig, type SnapshotExperiment, type SnapshotTreatment, type SpacerBlock, type StorefrontKind, type SyncAssignment, type TextBlock, type TrackNamedEventRequest, type Treatment, type TreatmentContent, type TreatmentMetadata, type TreatmentStats, type User, VISITOR_ID_KEY, type VariantConfig, type VerifiedToken, appendEmailToken, buildSubdomainUrl, calculateConfidenceInterval, extractDocumentSlots, extractEmailLinks, extractSlotNames, extractSubdomain, generateId, generateSubdomain, getContentTypeCategory, getOrCreateSessionId, getOrCreateVisitorId, goalMatchesPage, hashRecipient, impressionManifest, isPlacement, isShopifyCdnUrl, isSlotBinding, isValidEmail, isValidSubdomain, kindOfPlacement, matchesConversionPath, mintEmailToken, moreExperimentsSentence, normalizeAlgorithm, normalizeConversionPath, normalizeFunnelGoal, normalizePosterior, normalizeSiteTarget, normalizeTreatmentWeights, parseAlternative, parsePanelMessage, parsePickerMessage, parseSiteContent, parseTreatmentContent, pickArm, pickEnvelope, pickStep, pickTreatment, platformById, renderEmail, renderEmailDocument, renderFromPlan, reportPlanImpressions, resolveForgetting, rewriteEmailLinks, sampleCombination, sanitizeMetadata, serializeTreatmentConfig, shouldRefreshPlan, targetMatchesPage, uniformFor, validateTreatmentWeights, verifyEmailToken };
+export { type Assignment, BanditsClient as BanditClient, BanditsClient, type BanditsClientConfig, BanditsRequestError, type Bound, BundleAssignmentResponse, type ButtonBlock, CompanySnapshot, ContextualFeatures, DEFAULT_SESSION_TTL_MS, type DividerBlock, EMAIL_TOKEN_PARAM, type EmailBlock, type EmailDocument, type EmailPlan, type EmailTokenPayload, type HeadingBlock, type ImageBlock, type PlanArm, type PlanRenderResult, type PlanSlot, type RenderEmailOptions, type RenderedDocument, type RenderedEmail, type RewriteOptions, type RewriteResult, SCRIPT_PLATFORMS, SESSION_CREATED_AT_KEY, SESSION_ID_KEY, SITE_PLATFORMS, SITE_PLATFORM_IDS, type ScriptPlatform, type SessionOptions, type SigningKey, type SitePlatform, type SitePlatformId, type SitePlatformPath, type SlotBinding, SnapshotClient, type SnapshotClientConfig, SnapshotTreatment, type SpacerBlock, type SyncAssignment, type TextBlock, Treatment, VISITOR_ID_KEY, type VerifiedToken, appendEmailToken, buildSubdomainUrl, calculateConfidenceInterval, extractDocumentSlots, extractEmailLinks, extractSlotNames, extractSubdomain, generateId, generateSubdomain, getOrCreateSessionId, getOrCreateVisitorId, hashRecipient, impressionManifest, isSlotBinding, isValidEmail, isValidSubdomain, matchesConversionPath, mintEmailToken, normalizeConversionPath, normalizeTreatmentWeights, pickArm, pickTreatment, platformById, renderEmail, renderEmailDocument, renderFromPlan, reportPlanImpressions, rewriteEmailLinks, sampleCombination, sanitizeMetadata, shouldRefreshPlan, uniformFor, validateTreatmentWeights, verifyEmailToken };