@sprig-technologies/sprig-browser 2.23.0 → 2.23.2

package/dist/index.d.ts

@@ -1,3 +1,176 @@
+declare enum NOTIFICATION_TYPES {
+    ACTIVATE = "ACTIVATE:experiment, user_id,attributes, variation, event",
+    DECISION = "DECISION:type, userId, attributes, decisionInfo",
+    LOG_EVENT = "LOG_EVENT:logEvent",
+    OPTIMIZELY_CONFIG_UPDATE = "OPTIMIZELY_CONFIG_UPDATE",
+    TRACK = "TRACK:event_key, user_id, attributes, event_tags, event"
+}
+
+declare type UserAttributes = {
+    [name: string]: any;
+};
+declare type EventTags = {
+    [key: string]: string | number | null;
+};
+interface ListenerPayload {
+    userId: string;
+    attributes?: UserAttributes;
+}
+declare type NotificationListener<T extends ListenerPayload> = (notificationData: T) => void;
+interface NotificationCenter {
+    addNotificationListener<T extends ListenerPayload>(notificationType: string, callback: NotificationListener<T>): number;
+    removeNotificationListener(listenerId: number): boolean;
+    clearAllNotificationListeners(): void;
+    clearNotificationListeners(notificationType: NOTIFICATION_TYPES): void;
+}
+declare enum OptimizelyDecideOption {
+    DISABLE_DECISION_EVENT = "DISABLE_DECISION_EVENT",
+    ENABLED_FLAGS_ONLY = "ENABLED_FLAGS_ONLY",
+    IGNORE_USER_PROFILE_SERVICE = "IGNORE_USER_PROFILE_SERVICE",
+    INCLUDE_REASONS = "INCLUDE_REASONS",
+    EXCLUDE_VARIABLES = "EXCLUDE_VARIABLES"
+}
+/**
+ * Optimizely Config Entities
+ */
+interface OptimizelyExperiment {
+    id: string;
+    key: string;
+    audiences: string;
+    variationsMap: {
+        [variationKey: string]: OptimizelyVariation;
+    };
+}
+interface OptimizelyVariable {
+    id: string;
+    key: string;
+    type: string;
+    value: string;
+}
+interface Client {
+    notificationCenter: NotificationCenter;
+    createUserContext(userId: string, attributes?: UserAttributes): OptimizelyUserContext | null;
+    activate(experimentKey: string, userId: string, attributes?: UserAttributes): string | null;
+    track(eventKey: string, userId: string, attributes?: UserAttributes, eventTags?: EventTags): void;
+    getVariation(experimentKey: string, userId: string, attributes?: UserAttributes): string | null;
+    setForcedVariation(experimentKey: string, userId: string, variationKey: string | null): boolean;
+    getForcedVariation(experimentKey: string, userId: string): string | null;
+    isFeatureEnabled(featureKey: string, userId: string, attributes?: UserAttributes): boolean;
+    getEnabledFeatures(userId: string, attributes?: UserAttributes): string[];
+    getFeatureVariable(featureKey: string, variableKey: string, userId: string, attributes?: UserAttributes): unknown;
+    getFeatureVariableBoolean(featureKey: string, variableKey: string, userId: string, attributes?: UserAttributes): boolean | null;
+    getFeatureVariableDouble(featureKey: string, variableKey: string, userId: string, attributes?: UserAttributes): number | null;
+    getFeatureVariableInteger(featureKey: string, variableKey: string, userId: string, attributes?: UserAttributes): number | null;
+    getFeatureVariableString(featureKey: string, variableKey: string, userId: string, attributes?: UserAttributes): string | null;
+    getFeatureVariableJSON(featureKey: string, variableKey: string, userId: string, attributes?: UserAttributes): unknown;
+    getAllFeatureVariables(featureKey: string, userId: string, attributes?: UserAttributes): {
+        [variableKey: string]: unknown;
+    } | null;
+    getOptimizelyConfig(): OptimizelyConfig | null;
+    onReady(options?: {
+        timeout?: number;
+    }): Promise<{
+        success: boolean;
+        reason?: string;
+    }>;
+    close(): Promise<{
+        success: boolean;
+        reason?: string;
+    }>;
+}
+declare type OptimizelyExperimentsMap = {
+    [experimentKey: string]: OptimizelyExperiment;
+};
+declare type OptimizelyVariablesMap = {
+    [variableKey: string]: OptimizelyVariable;
+};
+declare type OptimizelyFeaturesMap = {
+    [featureKey: string]: OptimizelyFeature;
+};
+declare type OptimizelyAttribute = {
+    id: string;
+    key: string;
+};
+declare type OptimizelyAudience = {
+    id: string;
+    name: string;
+    conditions: string;
+};
+declare type OptimizelyEvent = {
+    id: string;
+    key: string;
+    experimentsIds: string[];
+};
+interface OptimizelyFeature {
+    id: string;
+    key: string;
+    experimentRules: OptimizelyExperiment[];
+    deliveryRules: OptimizelyExperiment[];
+    variablesMap: OptimizelyVariablesMap;
+    /**
+     * @deprecated Use experimentRules and deliveryRules
+     */
+    experimentsMap: OptimizelyExperimentsMap;
+}
+interface OptimizelyVariation {
+    id: string;
+    key: string;
+    featureEnabled?: boolean;
+    variablesMap: OptimizelyVariablesMap;
+}
+interface OptimizelyConfig {
+    environmentKey: string;
+    sdkKey: string;
+    revision: string;
+    /**
+     * This experimentsMap is for experiments of legacy projects only.
+     * For flag projects, experiment keys are not guaranteed to be unique
+     * across multiple flags, so this map may not include all experiments
+     * when keys conflict.
+     */
+    experimentsMap: OptimizelyExperimentsMap;
+    featuresMap: OptimizelyFeaturesMap;
+    attributes: OptimizelyAttribute[];
+    audiences: OptimizelyAudience[];
+    events: OptimizelyEvent[];
+    getDatafile(): string;
+}
+interface OptimizelyUserContext {
+    getUserId(): string;
+    getAttributes(): UserAttributes;
+    setAttribute(key: string, value: unknown): void;
+    decide(key: string, options?: OptimizelyDecideOption[]): OptimizelyDecision;
+    decideForKeys(keys: string[], options?: OptimizelyDecideOption[]): {
+        [key: string]: OptimizelyDecision;
+    };
+    decideAll(options?: OptimizelyDecideOption[]): {
+        [key: string]: OptimizelyDecision;
+    };
+    trackEvent(eventName: string, eventTags?: EventTags): void;
+    setForcedDecision(context: OptimizelyDecisionContext, decision: OptimizelyForcedDecision): boolean;
+    getForcedDecision(context: OptimizelyDecisionContext): OptimizelyForcedDecision | null;
+    removeForcedDecision(context: OptimizelyDecisionContext): boolean;
+    removeAllForcedDecisions(): boolean;
+}
+interface OptimizelyDecision {
+    variationKey: string | null;
+    enabled: boolean;
+    variables: {
+        [variableKey: string]: unknown;
+    };
+    ruleKey: string | null;
+    flagKey: string;
+    userContext: OptimizelyUserContext;
+    reasons: string[];
+}
+interface OptimizelyDecisionContext {
+    flagKey: string;
+    ruleKey?: string;
+}
+interface OptimizelyForcedDecision {
+    variationKey: string;
+}
+
 declare type EventMap = {
     [eventName: string]: Array<unknown>;
 };
@@ -699,6 +872,7 @@ interface Config {
     pageUrlEvents: PageUrlEvent[];
     path?: string;
     platform?: Platform;
+    previewKey?: string | null;
     replayNonce?: string;
     replaySettings?: object;
     requireUserIdForTracking: boolean;
@@ -729,6 +903,11 @@ declare enum SurveyState {
     NoSurvey = "no survey"
 }
 
+interface Experiment {
+    id: string;
+    variation?: string;
+}
+
 declare type QueueItem = [string, ...unknown[]] | (() => void);
 declare class SprigQueue {
     paused: boolean;
@@ -857,7 +1036,11 @@ declare namespace sprigConfig {
     }) => IdentifyResult;
     identifyAndTrack: (payload: TrackPayload) => IdentifyResult;
     importLaunchDarklyData: (data: Record<string, number>) => void;
-    integrateOptimizely: (strData: string) => void;
+    integrateOptimizely: (
+      strData: string | { experiments: Experiment[] },
+      isOverride?: boolean
+    ) => void;
+    integrateOptimizelyClient: (client: Client) => void;
     logoutUser: () => void;
     mute: () => void;
     previewSurvey: (surveyTemplateId: UUID) => void;