@uniformdev/context 19.79.0 → 19.79.1-alpha.7

package/dist/{types-9c370116.d.ts → types-hntTSVbk.d.mts}

@@ -9,6 +9,9 @@ type Tests = {
 type ScoreVector = {
     [key: string]: number;
 };
+type Goals = {
+    [key: string]: boolean;
+};
 type EnrichmentData = {
     /** Enrichment category name */
     cat: string;
@@ -40,6 +43,10 @@ type VisitorData = {
      * NOTE: Context.scores is more commonly correct to read scores instead of this value.
      */
     scores: ScoreVector;
+    /**
+     * Goals that this user has triggered.
+     */
+    goals?: Goals;
     /**
      * Whether consent has been given to store the visitor data
      * If false or not set: visitor data is stored in memory and is lost if the browser refreshes
@@ -73,13 +80,23 @@ type ContextStateUpdate = {
     visitor: VisitorData;
     scores: ScoreVector;
 };
+type GoalStateUpdate = {
+    scores: ScoreVector | undefined;
+    quirks: Quirks | undefined;
+};
 
 type StorageCommand<TID extends string = string, TData = unknown> = {
     type: TID;
     data: TData;
 };
 /** Commands that can be issued to alter the storage of Uniform Context data */
-type StorageCommands = ModifyScoreCommand | ModifySessionScoreCommand | SetConsentCommand | SetQuirkCommand | SetTestCommand | IdentifyCommand | SetControlGroupCommand;
+type StorageCommands = ModifyScoreCommand | ModifySessionScoreCommand | SetConsentCommand | SetQuirkCommand | SetTestCommand | IdentifyCommand | SetControlGroupCommand | SetGoalCommand;
+/**
+ * Converts the goal specified.
+ */
+type SetGoalCommand = StorageCommand<'setgoal', {
+    goal: string;
+}>;
 /**
  * Changes the visitor's permanent score for a given dimension
  */
@@ -270,6 +287,12 @@ type VisitorDataStoreEvents = {
      * Fired when visitor control group membership is changed
      */
     controlGroupUpdated: Pick<VisitorData, 'controlGroup'>;
+    /**
+     * Fired when a goal is converted
+     */
+    goalConverted: {
+        goalId: string;
+    };
 };
 declare class VisitorDataStore {
     #private;
@@ -312,6 +335,7 @@ declare class ManifestInstance {
     rollForControlGroup(): boolean;
     getTest(name: string): TestDefinition | undefined;
     computeSignals(update: ContextStateUpdate): StorageCommands[];
+    computeGoals(data: GoalStateUpdate): StorageCommands[];
     /**
      * Computes aggregated scores based on other dimensions
      */
@@ -383,6 +407,10 @@ interface components {
                 test?: {
                     [key: string]: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["Test"];
                 };
+                /** @description Goal settings */
+                goal?: {
+                    [key: string]: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["Goal"];
+                };
             };
         };
         PersonalizationManifest: {
@@ -643,6 +671,59 @@ interface external {
                     /** @description Winning variation ID - if set, the test will not run and this variation is shown to all visitors (the test is closed) */
                     wv?: string;
                 };
+                Goal: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalGoal"] | external["uniform-context-types.swagger.yml"]["components"]["schemas"]["EnrichmentGoal"] | external["uniform-context-types.swagger.yml"]["components"]["schemas"]["QuirkGoal"];
+                SignalGoal: {
+                    /** @enum {string} */
+                    type: "sig";
+                    id: string;
+                    /**
+                     * @description The type of match to perform
+                     * '=' = exact match
+                     * '!=' = not an exact match
+                     * '<' = less than match expression
+                     * '>' = greater than match expression
+                     *
+                     * @enum {string}
+                     */
+                    op: "=" | "<" | ">" | "!=";
+                    score: number;
+                };
+                EnrichmentGoal: {
+                    /** @enum {string} */
+                    type: "enr";
+                    cat: string;
+                    value: string;
+                    /**
+                     * @description The type of match to perform
+                     * '=' = exact match
+                     * '!=' = not an exact match
+                     * '<' = less than match expression
+                     * '>' = greater than match expression
+                     *
+                     * @enum {string}
+                     */
+                    op: "=" | "<" | ">" | "!=";
+                    score: number;
+                };
+                QuirkGoal: {
+                    /** @enum {string} */
+                    type: "qrk";
+                    id: string;
+                    /**
+                     * @description The match operator
+                     * '=' = exact match
+                     * '~' = contains match
+                     * '//' = regular expression match
+                     *
+                     * Any of the above can be prefixed with '!' to invert the match (i.e. != for 'not an exact match')
+                     *
+                     * @enum {string}
+                     */
+                    op: "=" | "~" | "//" | "!=" | "!~" | "!//";
+                    /** @description The case sensitivity of the match. Defaults to false if unspecified. */
+                    cs?: boolean;
+                    value: string;
+                };
             };
         };
         operations: {};
@@ -661,6 +742,10 @@ type NumberMatch = SharedTypes['NumberMatch'];
 type TestDefinition = SharedTypes['Test'];
 type AggregateDimension = SharedTypes['AggregateDimension'];
 type AggregateDimensionInput = SharedTypes['AggregateDimensionInput'];
+type Goal = SharedTypes['Goal'];
+type SignalGoal = SharedTypes['SignalGoal'];
+type EnrichmentGoal = SharedTypes['EnrichmentGoal'];
+type QuirkGoal = SharedTypes['QuirkGoal'];
 
 declare class GroupCriteriaEvaluator {
     #private;
@@ -939,6 +1024,8 @@ declare const CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID = "contextual_editing_
 type ContextPlugin = {
     logDrain?: LogDrain;
     init?: (context: Context) => () => void;
+    forget?: () => Promise<void> | void;
+    update?: (newData: Partial<ContextState>) => Promise<void> | void;
 };
 type ContextOptions = {
     /** The Context Manifest to load (from the Context API) */
@@ -1014,11 +1101,17 @@ interface ContextInstance {
     personalize<TVariant extends PersonalizedVariant>(options: PersonalizeOptions<TVariant>): PersonalizedResult<TVariant>;
     forget(fromAllDevices: boolean): Promise<void>;
     getServerToClientTransitionState(): ServerToClientTransitionState;
+    /** @deprecated - For internal use only */
+    internal_emitPersonalizationResult: (event: PersonalizationEvent) => void;
+    /** @deprecated - For internal use only */
+    internal_emitTestResult: (event: TestEvent) => void;
 }
 declare class Context implements ContextInstance {
     #private;
     readonly manifest: ManifestInstance;
     constructor(options: ContextOptions);
+    internal_emitPersonalizationResult(event: PersonalizationEvent): void;
+    internal_emitTestResult(event: TestEvent): void;
     /** Gets the current visitor's dimension score vector. */
     get scores(): Readonly<ScoreVector>;
     /** Gets the current visitor's quirks values. */
@@ -1137,4 +1230,4 @@ declare global {
     }
 }
 
-export { TestOptions as $, AggregateDimension as A, MessageFunc as B, ContextPlugin as C, DecayFunction as D, LogMessageSingle as E, LogMessageGroup as F, ManifestInstance as G, GroupCriteriaEvaluator as H, CriteriaEvaluatorResult as I, CriteriaEvaluatorParameters as J, SignalData as K, LogDrain as L, MessageCategory as M, ManifestV2 as N, OutputSeverity as O, PersonalizationEvent as P, PersonalizationManifest as Q, Signal as R, ScoreVector as S, TransitionDataStore as T, SignalCriteriaGroup as U, VisitorData as V, SignalCriteria as W, EnrichmentCategory as X, NumberMatch as Y, TestDefinition as Z, AggregateDimensionInput as _, StorageCommands as a, testVariations as a0, DimensionMatch as a1, PersonalizeOptions as a2, personalizeVariations as a3, BehaviorTag as a4, PersonalizedVariant as a5, PersonalizedResult as a6, TestVariant as a7, TestResult as a8, StorageCommand as a9, ModifyScoreCommand as aa, ModifySessionScoreCommand as ab, SetConsentCommand as ac, SetQuirkCommand as ad, SetTestCommand as ae, IdentifyCommand as af, SetControlGroupCommand as ag, ServerToClientTransitionState as ah, SERVER_STATE_ID as ai, TransitionDataStoreEvents as aj, DecayOptions as ak, VisitorDataStoreOptions as al, VisitorDataStoreEvents as am, VisitorDataStore as an, Quirks as ao, Tests as ap, EnrichmentData as aq, EventData as ar, emptyVisitorData as as, ContextState as at, ContextStateUpdate as au, paths as av, TransitionDataStoreOptions as b, CriteriaEvaluator as c, StringMatch as d, VariantMatchCriteria as e, LogMessage as f, DevToolsEvents as g, CONTEXTUAL_EDITING_TEST_NAME as h, CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID as i, ContextOptions as j, TestEvent as k, ContextEvents as l, ContextInstance as m, Context as n, DevToolsUiVersion as o, DevToolsState as p, DevToolsActions as q, DevToolsEvent as r, DevToolsLogEvent as s, DevToolsDataEvent as t, DevToolsHelloEvent as u, DevToolsUpdateEvent as v, DevToolsRawCommandsEvent as w, DevToolsForgetEvent as x, LogMessages as y, Severity as z };
+export { type Goal as $, type AggregateDimension as A, type MessageFunc as B, type ContextPlugin as C, type DecayFunction as D, type LogMessageSingle as E, type LogMessageGroup as F, ManifestInstance as G, GroupCriteriaEvaluator as H, type CriteriaEvaluatorResult as I, type CriteriaEvaluatorParameters as J, type SignalData as K, type LogDrain as L, type MessageCategory as M, type ManifestV2 as N, type OutputSeverity as O, type PersonalizationEvent as P, type PersonalizationManifest as Q, type Signal as R, type ScoreVector as S, TransitionDataStore as T, type SignalCriteriaGroup as U, type VisitorData as V, type SignalCriteria as W, type EnrichmentCategory as X, type NumberMatch as Y, type TestDefinition as Z, type AggregateDimensionInput as _, type StorageCommands as a, type SignalGoal as a0, type EnrichmentGoal as a1, type QuirkGoal as a2, type TestOptions as a3, testVariations as a4, type DimensionMatch as a5, type PersonalizeOptions as a6, personalizeVariations as a7, type BehaviorTag as a8, type PersonalizedVariant as a9, type ContextStateUpdate as aA, type GoalStateUpdate as aB, type paths as aC, type PersonalizedResult as aa, type TestVariant as ab, type TestResult as ac, type StorageCommand as ad, type SetGoalCommand as ae, type ModifyScoreCommand as af, type ModifySessionScoreCommand as ag, type SetConsentCommand as ah, type SetQuirkCommand as ai, type SetTestCommand as aj, type IdentifyCommand as ak, type SetControlGroupCommand as al, type ServerToClientTransitionState as am, SERVER_STATE_ID as an, type TransitionDataStoreEvents as ao, type DecayOptions as ap, type VisitorDataStoreOptions as aq, type VisitorDataStoreEvents as ar, VisitorDataStore as as, type Quirks as at, type Tests as au, type Goals as av, type EnrichmentData as aw, type EventData as ax, emptyVisitorData as ay, type ContextState as az, type TransitionDataStoreOptions as b, type CriteriaEvaluator as c, type StringMatch as d, type VariantMatchCriteria as e, type LogMessage as f, type DevToolsEvents as g, CONTEXTUAL_EDITING_TEST_NAME as h, CONTEXTUAL_EDITING_TEST_SELECTED_VARIANT_ID as i, type ContextOptions as j, type TestEvent as k, type ContextEvents as l, type ContextInstance as m, Context as n, type DevToolsUiVersion as o, type DevToolsState as p, type DevToolsActions as q, type DevToolsEvent as r, type DevToolsLogEvent as s, type DevToolsDataEvent as t, type DevToolsHelloEvent as u, type DevToolsUpdateEvent as v, type DevToolsRawCommandsEvent as w, type DevToolsForgetEvent as x, type LogMessages as y, type Severity as z };