@runbandit/sdk 3.0.0 → 3.1.1

package/dist/index.d.ts

@@ -366,7 +366,6 @@ interface CompanySnapshot {
     experiments: Record<string, SnapshotExperiment>;
 }
 
-declare function generateId(): string;
 declare function validateTreatmentWeights(treatments: Treatment[]): boolean;
 declare function normalizeTreatmentWeights(treatments: Treatment[]): Treatment[];
 declare function calculateConfidenceInterval(successes: number, trials: number, confidence?: number): {
@@ -493,6 +492,9 @@ interface RenderedDocument {
 }
 declare function renderEmailDocument(document: EmailDocument, slots: Record<string, string>): RenderedDocument;
 
+declare function normalizeConversionPath(input: string | undefined): string | undefined;
+declare function matchesConversionPath(pattern: string, pathname: string): boolean;
+
 interface BanditsClientConfig {
     apiUrl: string;
     apiKey: string;
@@ -513,9 +515,10 @@ declare class BanditsClient {
     private config;
     private namedEventQueue;
     private sessionId;
+    readonly visitorId: string;
     private flushTimer?;
     constructor(config: BanditsClientConfig);
-    getAssignment(experimentId: string, userId: string, context?: ContextualFeatures): Promise<Assignment>;
+    getAssignment(experimentId: string, userId?: string, context?: ContextualFeatures): Promise<Assignment>;
     trackNamedEvent(event: {
         name: string;
         category?: string;
@@ -530,6 +533,8 @@ declare class BanditsClient {
     identify(anonymousId: string, identifiedUserId: string, mergeReason?: 'user_signup' | 'email_verification' | 'social_login' | 'account_recovery' | 'manual'): Promise<void>;
     label(userId: string, labels: Record<string, string | boolean>): Promise<void>;
     trackFunnelReward(funnelId: string, userId: string, value: number): Promise<void>;
+    convert(funnelId: string, value?: number): Promise<void>;
+    convertOn(funnelId: string, pathPattern: string, value?: number): Promise<boolean>;
     getBundle(bundleId: string, userId: string, context?: ContextualFeatures): Promise<BundleAssignmentResponse>;
     trackBundleReward(bundleId: string, userId: string, value: number): Promise<void>;
     private generateId;
@@ -583,13 +588,16 @@ declare class SnapshotClient {
 
 declare const SESSION_ID_KEY = "bandits_session_id";
 declare const SESSION_CREATED_AT_KEY = "bandits_session_created_at";
+declare const VISITOR_ID_KEY = "bandits_visitor_id";
 declare const DEFAULT_SESSION_TTL_MS = 86400000;
+declare function generateId(): string;
 interface SessionOptions {
     storage?: Storage | null;
     now?: () => number;
     ttlMs?: number;
 }
 declare function getOrCreateSessionId(options?: SessionOptions): string;
+declare function getOrCreateVisitorId(storage: Storage | null | undefined): string;
 
 interface RewriteOptions {
     linkTable: string[];
@@ -632,4 +640,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, type Bound, type Bundle, type BundleAssignmentRequest, type BundleAssignmentResponse, type BundleMode, type BundleSlotAssignment, type ButtonBlock, CONTENT_TYPE_BY_KIND, 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 FunnelRewardRequest, FunnelStatus, type HeadingBlock, type IdentifyMergeReason, type IdentifyUserRequest, type IdentifyUserResponse, type ImageBlock, type ImageContent, MAX_ORDERING_ITEMS, MIN_ORDERING_ITEMS, type OfferContent, PLACEMENTS, PLACEMENTS_BY_KIND, type Placement, type PlanArm, type PlanRenderResult, type PlanSlot, Posterior, type RenderEmailOptions, type RenderedDocument, type RenderedEmail, type ResolvedIdentity, type RewriteOptions, type RewriteResult, SESSION_CREATED_AT_KEY, SESSION_ID_KEY, STATIONARY, STOREFRONT_KINDS, type Session, type SessionOptions, type SigningKey, 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, type VariantConfig, type VerifiedToken, appendEmailToken, buildSubdomainUrl, calculateConfidenceInterval, extractDocumentSlots, extractEmailLinks, extractSlotNames, extractSubdomain, generateId, generateSubdomain, getContentTypeCategory, getOrCreateSessionId, hashRecipient, impressionManifest, isPlacement, isShopifyCdnUrl, isSlotBinding, isValidEmail, isValidSubdomain, kindOfPlacement, mintEmailToken, normalizeAlgorithm, normalizePosterior, normalizeTreatmentWeights, parseTreatmentContent, pickArm, pickTreatment, renderEmail, renderEmailDocument, renderFromPlan, reportPlanImpressions, resolveForgetting, rewriteEmailLinks, sampleCombination, sanitizeMetadata, serializeTreatmentConfig, shouldRefreshPlan, uniformFor, validateTreatmentWeights, verifyEmailToken };
+export { type APIResponse, type Account, type AlgorithmResult, type ApiKey, type Assignment, type AssignmentRequest, BanditAlgorithm, BanditsClient as BanditClient, type BanditConfig, type BanditResult, BanditsClient, type BanditsClientConfig, type Bound, type Bundle, type BundleAssignmentRequest, type BundleAssignmentResponse, type BundleMode, type BundleSlotAssignment, type ButtonBlock, CONTENT_TYPE_BY_KIND, 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 FunnelRewardRequest, FunnelStatus, type HeadingBlock, type IdentifyMergeReason, type IdentifyUserRequest, type IdentifyUserResponse, type ImageBlock, type ImageContent, MAX_ORDERING_ITEMS, MIN_ORDERING_ITEMS, type OfferContent, PLACEMENTS, PLACEMENTS_BY_KIND, type Placement, type PlanArm, type PlanRenderResult, type PlanSlot, Posterior, type RenderEmailOptions, type RenderedDocument, type RenderedEmail, type ResolvedIdentity, type RewriteOptions, type RewriteResult, SESSION_CREATED_AT_KEY, SESSION_ID_KEY, STATIONARY, STOREFRONT_KINDS, type Session, type SessionOptions, type SigningKey, 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, hashRecipient, impressionManifest, isPlacement, isShopifyCdnUrl, isSlotBinding, isValidEmail, isValidSubdomain, kindOfPlacement, matchesConversionPath, mintEmailToken, normalizeAlgorithm, normalizeConversionPath, normalizePosterior, normalizeTreatmentWeights, parseTreatmentContent, pickArm, pickTreatment, renderEmail, renderEmailDocument, renderFromPlan, reportPlanImpressions, resolveForgetting, rewriteEmailLinks, sampleCombination, sanitizeMetadata, serializeTreatmentConfig, shouldRefreshPlan, uniformFor, validateTreatmentWeights, verifyEmailToken };