@uniformdev/context 19.135.0 → 19.135.1-alpha.11

package/dist/{types-WtfxfDct.d.mts → types-o4ZU_qKY.d.mts}

@@ -1,4 +1,5 @@
 import * as mitt from 'mitt';
+import { Emitter } from 'mitt';
 
 type Quirks = {
     [key: string]: string;
@@ -9,6 +10,9 @@ type Tests = {
 type ScoreVector = {
     [key: string]: number;
 };
+type Goals = {
+    [key: string]: boolean;
+};
 type EnrichmentData = {
     /** Enrichment category name */
     cat: string;
@@ -47,6 +51,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
@@ -84,13 +92,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 | SetPersonalizeVariantControlCommand;
+type StorageCommands = ModifyScoreCommand | ModifySessionScoreCommand | SetConsentCommand | SetQuirkCommand | SetTestCommand | IdentifyCommand | SetControlGroupCommand | SetPersonalizeVariantControlCommand | SetGoalCommand;
+/**
+ * Converts the goal specified.
+ */
+type SetGoalCommand = StorageCommand<'setgoal', {
+    goal: string;
+}>;
 /**
  * Changes the visitor's permanent score for a given dimension
  */
@@ -141,6 +159,7 @@ type SetPersonalizeVariantControlCommand = StorageCommand<'setpersonalizecontrol
     index: number;
     control: boolean;
 }>;
+declare const areCommandsEqual: (a: StorageCommands, b: StorageCommands) => boolean;
 
 type TransitionDataStoreOptions = {
     initialData?: Partial<VisitorData>;
@@ -152,6 +171,10 @@ type ServerToClientTransitionState = Pick<Partial<VisitorData>, 'quirks' | 'test
      * recomputation.
      */
     ssv?: ScoreVector;
+    /**
+     * Storage commands that the server
+     */
+    commands?: StorageCommands[];
 };
 declare const SERVER_STATE_ID = "__UNIFORM_DATA__";
 type TransitionDataStoreEvents = {
@@ -178,7 +201,7 @@ declare abstract class TransitionDataStore {
             (type: "*", handler: mitt.WildcardHandler<TransitionDataStoreEvents>): void;
         };
         off: {
-            <Key_1 extends "dataUpdatedAsync">(type: Key_1, handler?: mitt.Handler<TransitionDataStoreEvents[Key_1]> | undefined): void;
+            <Key extends "dataUpdatedAsync">(type: Key, handler?: mitt.Handler<TransitionDataStoreEvents[Key]> | undefined): void;
             (type: "*", handler: mitt.WildcardHandler<TransitionDataStoreEvents>): void;
         };
     };
@@ -260,6 +283,11 @@ type VisitorDataStoreOptions = {
     onServerTransitionReceived?: (state: ServerToClientTransitionState) => void;
     /** Called when a log message is emitted from the data store */
     onLogMessage?: (message: LogMessage) => void;
+    /**
+     * Optionally specify a prefix for all storage keys.
+     * Only required if using multiple Context instances on the same domain and need to separate them.
+     */
+    partitionKey?: string;
 };
 type VisitorDataStoreEvents = {
     /**
@@ -286,6 +314,14 @@ type VisitorDataStoreEvents = {
      * Fired when visitor control group membership is changed
      */
     controlGroupUpdated: Pick<VisitorData, 'controlGroup'>;
+    /**
+     * Fired when a goal is converted
+     */
+    goalConverted: {
+        goalId: string;
+    };
+    /** Fired when storage update commands are done executing */
+    commandsExecuted: StorageCommands[];
 };
 declare class VisitorDataStore {
     #private;
@@ -303,7 +339,7 @@ declare class VisitorDataStore {
             (type: "*", handler: mitt.WildcardHandler<VisitorDataStoreEvents>): void;
         };
         off: {
-            <Key_1 extends keyof VisitorDataStoreEvents>(type: Key_1, handler?: mitt.Handler<VisitorDataStoreEvents[Key_1]> | undefined): void;
+            <Key extends keyof VisitorDataStoreEvents>(type: Key, handler?: mitt.Handler<VisitorDataStoreEvents[Key]> | undefined): void;
             (type: "*", handler: mitt.WildcardHandler<VisitorDataStoreEvents>): void;
         };
     };
@@ -328,6 +364,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
      */
@@ -491,6 +528,7 @@ interface external {
                      */
                     dur: "s" | "p" | "t";
                     crit: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["RootSignalCriteriaGroup"];
+                    conversion?: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["Conversion"] | null;
                 };
                 RootSignalCriteriaGroup: {
                     /**
@@ -503,7 +541,7 @@ interface external {
                      * & = AND
                      * | = OR
                      *
-                     * Default is `&` if unspecified.
+                     * Default is `&` if unspecified
                      *
                      * @default &
                      * @enum {string}
@@ -512,6 +550,13 @@ interface external {
                     /** @description The criteria clauses that make up this grouping of criteria */
                     clauses: (external["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteriaGroup"] | external["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteria"])[];
                 };
+                Conversion: {
+                    /**
+                     * @description The frequency of the conversion event
+                     * @enum {string}
+                     */
+                    freq: "O";
+                };
                 SignalCriteriaGroup: {
                     /**
                      * @description Criteria type (Group of other criteria)
@@ -523,7 +568,7 @@ interface external {
                      * & = AND
                      * | = OR
                      *
-                     * Default is `&` if unspecified.
+                     * Default is `&` if unspecified
                      *
                      * @enum {string}
                      */
@@ -584,7 +629,7 @@ interface external {
                 };
                 /** @description Describes a match expression on a string */
                 StringMatch: {
-                    /** @description The right hand side of the match expression */
+                    /** @description The right-hand side of the match expression */
                     rhs: string;
                     /**
                      * @description The match operator
@@ -597,7 +642,7 @@ interface external {
                      * @enum {string}
                      */
                     op: "=" | "~" | "//" | "!=" | "!~" | "!//";
-                    /** @description The case sensitivity of the match. Defaults to false if unspecified. */
+                    /** @description The case sensitivity of the match. Defaults to false if unspecified */
                     cs?: boolean;
                 } | {
                     /**
@@ -611,7 +656,7 @@ interface external {
                 };
                 /** @description Describes a match expression on a number */
                 NumberMatch: {
-                    /** @description The right hand side of the match expression */
+                    /** @description The right-hand side of the match expression */
                     rhs: number;
                     /**
                      * @description The type of match to perform
@@ -624,7 +669,7 @@ interface external {
                      */
                     op: "=" | "<" | ">" | "!=";
                 };
-                /** @description Defines an aggregate dimension that is a grouping of other dimensions' scores; an intent or audience. */
+                /** @description Defines an aggregate dimension that is a grouping of other dimensions' scores; an intent or audience */
                 AggregateDimension: {
                     /** @description Input dimensions to the aggregate dimension */
                     inputs: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["AggregateDimensionInput"][];
@@ -638,7 +683,7 @@ interface external {
                      *
                      * Note that creating a cycle of aggregate dimensions is allowed, however
                      * the final score will _ignore_ the cycled aggregate dimension in the result.
-                     * This can be used to create mutually exclusive aggregates.
+                     * This can be used to create mutually exclusive aggregates
                      */
                     dim: string;
                     /**
@@ -646,7 +691,7 @@ interface external {
                      *
                      * '+' = add to the final score
                      * '-' = subtract from the final score
-                     * 'c' = clear the final score (if the input dimension has any score at all, this aggreate will have no score regardless of other inputs)
+                     * 'c' = clear the final score (if the input dimension has any score at all, this aggregate will have no score regardless of other inputs)
                      *
                      * Default if unspecified: '+'
                      *
@@ -949,7 +994,7 @@ type TestOptions<TVariant extends TestVariant> = {
 };
 declare const testVariations: <TVariant extends TestVariant>({ name, context, variations, onLogMessage, }: TestOptions<TVariant> & {
     context: Context;
-    onLogMessage?: ((message: LogMessage) => void) | undefined;
+    onLogMessage?: (message: LogMessage) => void;
 }) => TestResult<TVariant>;
 
 declare const CONTEXTUAL_EDITING_TEST_NAME = "contextual_editing_test";
@@ -962,6 +1007,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) */
@@ -1041,6 +1088,10 @@ interface ContextInstance {
     forget(fromAllDevices: boolean): Promise<void>;
     getServerToClientTransitionState(): ServerToClientTransitionState;
     readonly manifest: ManifestInstance;
+    events: {
+        on: Emitter<ContextEvents>['on'];
+        off: Emitter<ContextEvents>['off'];
+    };
     /** @deprecated */
     internal_processTestEvent(event: TestEvent): void;
     /** @deprecated */
@@ -1063,7 +1114,7 @@ declare class Context implements ContextInstance {
             (type: "*", handler: mitt.WildcardHandler<ContextEvents>): void;
         };
         off: {
-            <Key_1 extends keyof ContextEvents>(type: Key_1, handler?: mitt.Handler<ContextEvents[Key_1]> | undefined): void;
+            <Key extends keyof ContextEvents>(type: Key, handler?: mitt.Handler<ContextEvents[Key]> | undefined): void;
             (type: "*", handler: mitt.WildcardHandler<ContextEvents>): void;
         };
     };
@@ -1078,6 +1129,10 @@ declare class Context implements ContextInstance {
      * will NOT result in a recomputation of signal state.
      */
     update(newData: Partial<ContextState>): Promise<void>;
+    processServerCommands({ serverCommands, commands, }: {
+        serverCommands: StorageCommands[] | undefined;
+        commands: StorageCommands[];
+    }): Promise<void>;
     /** use test() instead */
     getTestVariantId(testName: string): string | null | undefined;
     /** use test() instead */
@@ -1170,7 +1225,12 @@ declare global {
     interface Window {
         /** Window var set by enableContextDevTools() to enable embedded devtools to receive Context instance and attach events to it. */
         __UNIFORM_DEVTOOLS_CONTEXT_INSTANCE__?: Context;
+        /**
+         * Window var set automatically that Uniform's contextual editing uses to respond to changes in the Context within its preview pane,
+         * for example quirks being set from within the preview.
+         */
+        __UNIFORM_CONTEXTUAL_EDITING_CONTEXT__?: Context;
     }
 }
 
-export { type TestOptions 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, testVariations as a0, type DimensionMatch as a1, type PersonalizeOptions as a2, personalizeVariations as a3, type BehaviorTag as a4, type PersonalizedVariant as a5, type PersonalizedResult as a6, type TestVariant as a7, type TestResult as a8, type StorageCommand as a9, type ModifyScoreCommand as aa, type ModifySessionScoreCommand as ab, type SetConsentCommand as ac, type SetQuirkCommand as ad, type SetTestCommand as ae, type IdentifyCommand as af, type SetControlGroupCommand as ag, type SetPersonalizeVariantControlCommand as ah, type ServerToClientTransitionState as ai, SERVER_STATE_ID as aj, type TransitionDataStoreEvents as ak, type DecayOptions as al, type VisitorDataStoreOptions as am, type VisitorDataStoreEvents as an, VisitorDataStore as ao, type Quirks as ap, type Tests as aq, type EnrichmentData as ar, type PersonalizeControlVariant as as, type PersonalizeVariants as at, type EventData as au, emptyVisitorData as av, type ContextState as aw, type ContextStateUpdate as ax, type paths as ay, 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 };
+export { type TestOptions 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, testVariations as a0, type DimensionMatch as a1, type PersonalizeOptions as a2, personalizeVariations as a3, type BehaviorTag as a4, type PersonalizedVariant as a5, type PersonalizedResult as a6, type TestVariant as a7, type TestResult as a8, type StorageCommand as a9, type ContextStateUpdate as aA, type GoalStateUpdate as aB, type paths as aC, type SetGoalCommand as aa, type ModifyScoreCommand as ab, type ModifySessionScoreCommand as ac, type SetConsentCommand as ad, type SetQuirkCommand as ae, type SetTestCommand as af, type IdentifyCommand as ag, type SetControlGroupCommand as ah, type SetPersonalizeVariantControlCommand as ai, areCommandsEqual as aj, type ServerToClientTransitionState as ak, SERVER_STATE_ID as al, type TransitionDataStoreEvents as am, type DecayOptions as an, type VisitorDataStoreOptions as ao, type VisitorDataStoreEvents as ap, VisitorDataStore as aq, type Quirks as ar, type Tests as as, type Goals as at, type EnrichmentData as au, type PersonalizeControlVariant as av, type PersonalizeVariants 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 };

package/dist/{types-WtfxfDct.d.ts → types-o4ZU_qKY.d.ts}

@@ -1,4 +1,5 @@
 import * as mitt from 'mitt';
+import { Emitter } from 'mitt';
 
 type Quirks = {
     [key: string]: string;
@@ -9,6 +10,9 @@ type Tests = {
 type ScoreVector = {
     [key: string]: number;
 };
+type Goals = {
+    [key: string]: boolean;
+};
 type EnrichmentData = {
     /** Enrichment category name */
     cat: string;
@@ -47,6 +51,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
@@ -84,13 +92,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 | SetPersonalizeVariantControlCommand;
+type StorageCommands = ModifyScoreCommand | ModifySessionScoreCommand | SetConsentCommand | SetQuirkCommand | SetTestCommand | IdentifyCommand | SetControlGroupCommand | SetPersonalizeVariantControlCommand | SetGoalCommand;
+/**
+ * Converts the goal specified.
+ */
+type SetGoalCommand = StorageCommand<'setgoal', {
+    goal: string;
+}>;
 /**
  * Changes the visitor's permanent score for a given dimension
  */
@@ -141,6 +159,7 @@ type SetPersonalizeVariantControlCommand = StorageCommand<'setpersonalizecontrol
     index: number;
     control: boolean;
 }>;
+declare const areCommandsEqual: (a: StorageCommands, b: StorageCommands) => boolean;
 
 type TransitionDataStoreOptions = {
     initialData?: Partial<VisitorData>;
@@ -152,6 +171,10 @@ type ServerToClientTransitionState = Pick<Partial<VisitorData>, 'quirks' | 'test
      * recomputation.
      */
     ssv?: ScoreVector;
+    /**
+     * Storage commands that the server
+     */
+    commands?: StorageCommands[];
 };
 declare const SERVER_STATE_ID = "__UNIFORM_DATA__";
 type TransitionDataStoreEvents = {
@@ -178,7 +201,7 @@ declare abstract class TransitionDataStore {
             (type: "*", handler: mitt.WildcardHandler<TransitionDataStoreEvents>): void;
         };
         off: {
-            <Key_1 extends "dataUpdatedAsync">(type: Key_1, handler?: mitt.Handler<TransitionDataStoreEvents[Key_1]> | undefined): void;
+            <Key extends "dataUpdatedAsync">(type: Key, handler?: mitt.Handler<TransitionDataStoreEvents[Key]> | undefined): void;
             (type: "*", handler: mitt.WildcardHandler<TransitionDataStoreEvents>): void;
         };
     };
@@ -260,6 +283,11 @@ type VisitorDataStoreOptions = {
     onServerTransitionReceived?: (state: ServerToClientTransitionState) => void;
     /** Called when a log message is emitted from the data store */
     onLogMessage?: (message: LogMessage) => void;
+    /**
+     * Optionally specify a prefix for all storage keys.
+     * Only required if using multiple Context instances on the same domain and need to separate them.
+     */
+    partitionKey?: string;
 };
 type VisitorDataStoreEvents = {
     /**
@@ -286,6 +314,14 @@ type VisitorDataStoreEvents = {
      * Fired when visitor control group membership is changed
      */
     controlGroupUpdated: Pick<VisitorData, 'controlGroup'>;
+    /**
+     * Fired when a goal is converted
+     */
+    goalConverted: {
+        goalId: string;
+    };
+    /** Fired when storage update commands are done executing */
+    commandsExecuted: StorageCommands[];
 };
 declare class VisitorDataStore {
     #private;
@@ -303,7 +339,7 @@ declare class VisitorDataStore {
             (type: "*", handler: mitt.WildcardHandler<VisitorDataStoreEvents>): void;
         };
         off: {
-            <Key_1 extends keyof VisitorDataStoreEvents>(type: Key_1, handler?: mitt.Handler<VisitorDataStoreEvents[Key_1]> | undefined): void;
+            <Key extends keyof VisitorDataStoreEvents>(type: Key, handler?: mitt.Handler<VisitorDataStoreEvents[Key]> | undefined): void;
             (type: "*", handler: mitt.WildcardHandler<VisitorDataStoreEvents>): void;
         };
     };
@@ -328,6 +364,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
      */
@@ -491,6 +528,7 @@ interface external {
                      */
                     dur: "s" | "p" | "t";
                     crit: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["RootSignalCriteriaGroup"];
+                    conversion?: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["Conversion"] | null;
                 };
                 RootSignalCriteriaGroup: {
                     /**
@@ -503,7 +541,7 @@ interface external {
                      * & = AND
                      * | = OR
                      *
-                     * Default is `&` if unspecified.
+                     * Default is `&` if unspecified
                      *
                      * @default &
                      * @enum {string}
@@ -512,6 +550,13 @@ interface external {
                     /** @description The criteria clauses that make up this grouping of criteria */
                     clauses: (external["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteriaGroup"] | external["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteria"])[];
                 };
+                Conversion: {
+                    /**
+                     * @description The frequency of the conversion event
+                     * @enum {string}
+                     */
+                    freq: "O";
+                };
                 SignalCriteriaGroup: {
                     /**
                      * @description Criteria type (Group of other criteria)
@@ -523,7 +568,7 @@ interface external {
                      * & = AND
                      * | = OR
                      *
-                     * Default is `&` if unspecified.
+                     * Default is `&` if unspecified
                      *
                      * @enum {string}
                      */
@@ -584,7 +629,7 @@ interface external {
                 };
                 /** @description Describes a match expression on a string */
                 StringMatch: {
-                    /** @description The right hand side of the match expression */
+                    /** @description The right-hand side of the match expression */
                     rhs: string;
                     /**
                      * @description The match operator
@@ -597,7 +642,7 @@ interface external {
                      * @enum {string}
                      */
                     op: "=" | "~" | "//" | "!=" | "!~" | "!//";
-                    /** @description The case sensitivity of the match. Defaults to false if unspecified. */
+                    /** @description The case sensitivity of the match. Defaults to false if unspecified */
                     cs?: boolean;
                 } | {
                     /**
@@ -611,7 +656,7 @@ interface external {
                 };
                 /** @description Describes a match expression on a number */
                 NumberMatch: {
-                    /** @description The right hand side of the match expression */
+                    /** @description The right-hand side of the match expression */
                     rhs: number;
                     /**
                      * @description The type of match to perform
@@ -624,7 +669,7 @@ interface external {
                      */
                     op: "=" | "<" | ">" | "!=";
                 };
-                /** @description Defines an aggregate dimension that is a grouping of other dimensions' scores; an intent or audience. */
+                /** @description Defines an aggregate dimension that is a grouping of other dimensions' scores; an intent or audience */
                 AggregateDimension: {
                     /** @description Input dimensions to the aggregate dimension */
                     inputs: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["AggregateDimensionInput"][];
@@ -638,7 +683,7 @@ interface external {
                      *
                      * Note that creating a cycle of aggregate dimensions is allowed, however
                      * the final score will _ignore_ the cycled aggregate dimension in the result.
-                     * This can be used to create mutually exclusive aggregates.
+                     * This can be used to create mutually exclusive aggregates
                      */
                     dim: string;
                     /**
@@ -646,7 +691,7 @@ interface external {
                      *
                      * '+' = add to the final score
                      * '-' = subtract from the final score
-                     * 'c' = clear the final score (if the input dimension has any score at all, this aggreate will have no score regardless of other inputs)
+                     * 'c' = clear the final score (if the input dimension has any score at all, this aggregate will have no score regardless of other inputs)
                      *
                      * Default if unspecified: '+'
                      *
@@ -949,7 +994,7 @@ type TestOptions<TVariant extends TestVariant> = {
 };
 declare const testVariations: <TVariant extends TestVariant>({ name, context, variations, onLogMessage, }: TestOptions<TVariant> & {
     context: Context;
-    onLogMessage?: ((message: LogMessage) => void) | undefined;
+    onLogMessage?: (message: LogMessage) => void;
 }) => TestResult<TVariant>;
 
 declare const CONTEXTUAL_EDITING_TEST_NAME = "contextual_editing_test";
@@ -962,6 +1007,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) */
@@ -1041,6 +1088,10 @@ interface ContextInstance {
     forget(fromAllDevices: boolean): Promise<void>;
     getServerToClientTransitionState(): ServerToClientTransitionState;
     readonly manifest: ManifestInstance;
+    events: {
+        on: Emitter<ContextEvents>['on'];
+        off: Emitter<ContextEvents>['off'];
+    };
     /** @deprecated */
     internal_processTestEvent(event: TestEvent): void;
     /** @deprecated */
@@ -1063,7 +1114,7 @@ declare class Context implements ContextInstance {
             (type: "*", handler: mitt.WildcardHandler<ContextEvents>): void;
         };
         off: {
-            <Key_1 extends keyof ContextEvents>(type: Key_1, handler?: mitt.Handler<ContextEvents[Key_1]> | undefined): void;
+            <Key extends keyof ContextEvents>(type: Key, handler?: mitt.Handler<ContextEvents[Key]> | undefined): void;
             (type: "*", handler: mitt.WildcardHandler<ContextEvents>): void;
         };
     };
@@ -1078,6 +1129,10 @@ declare class Context implements ContextInstance {
      * will NOT result in a recomputation of signal state.
      */
     update(newData: Partial<ContextState>): Promise<void>;
+    processServerCommands({ serverCommands, commands, }: {
+        serverCommands: StorageCommands[] | undefined;
+        commands: StorageCommands[];
+    }): Promise<void>;
     /** use test() instead */
     getTestVariantId(testName: string): string | null | undefined;
     /** use test() instead */
@@ -1170,7 +1225,12 @@ declare global {
     interface Window {
         /** Window var set by enableContextDevTools() to enable embedded devtools to receive Context instance and attach events to it. */
         __UNIFORM_DEVTOOLS_CONTEXT_INSTANCE__?: Context;
+        /**
+         * Window var set automatically that Uniform's contextual editing uses to respond to changes in the Context within its preview pane,
+         * for example quirks being set from within the preview.
+         */
+        __UNIFORM_CONTEXTUAL_EDITING_CONTEXT__?: Context;
     }
 }
 
-export { type TestOptions 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, testVariations as a0, type DimensionMatch as a1, type PersonalizeOptions as a2, personalizeVariations as a3, type BehaviorTag as a4, type PersonalizedVariant as a5, type PersonalizedResult as a6, type TestVariant as a7, type TestResult as a8, type StorageCommand as a9, type ModifyScoreCommand as aa, type ModifySessionScoreCommand as ab, type SetConsentCommand as ac, type SetQuirkCommand as ad, type SetTestCommand as ae, type IdentifyCommand as af, type SetControlGroupCommand as ag, type SetPersonalizeVariantControlCommand as ah, type ServerToClientTransitionState as ai, SERVER_STATE_ID as aj, type TransitionDataStoreEvents as ak, type DecayOptions as al, type VisitorDataStoreOptions as am, type VisitorDataStoreEvents as an, VisitorDataStore as ao, type Quirks as ap, type Tests as aq, type EnrichmentData as ar, type PersonalizeControlVariant as as, type PersonalizeVariants as at, type EventData as au, emptyVisitorData as av, type ContextState as aw, type ContextStateUpdate as ax, type paths as ay, 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 };
+export { type TestOptions 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, testVariations as a0, type DimensionMatch as a1, type PersonalizeOptions as a2, personalizeVariations as a3, type BehaviorTag as a4, type PersonalizedVariant as a5, type PersonalizedResult as a6, type TestVariant as a7, type TestResult as a8, type StorageCommand as a9, type ContextStateUpdate as aA, type GoalStateUpdate as aB, type paths as aC, type SetGoalCommand as aa, type ModifyScoreCommand as ab, type ModifySessionScoreCommand as ac, type SetConsentCommand as ad, type SetQuirkCommand as ae, type SetTestCommand as af, type IdentifyCommand as ag, type SetControlGroupCommand as ah, type SetPersonalizeVariantControlCommand as ai, areCommandsEqual as aj, type ServerToClientTransitionState as ak, SERVER_STATE_ID as al, type TransitionDataStoreEvents as am, type DecayOptions as an, type VisitorDataStoreOptions as ao, type VisitorDataStoreEvents as ap, VisitorDataStore as aq, type Quirks as ar, type Tests as as, type Goals as at, type EnrichmentData as au, type PersonalizeControlVariant as av, type PersonalizeVariants 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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/context",
-  "version": "19.135.0",
+  "version": "19.135.1-alpha.11+9f52e6cfd6",
   "description": "Uniform Context core package",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -51,14 +51,16 @@
   },
   "devDependencies": {
     "@types/js-cookie": "3.0.6",
+    "@types/uuid": "9.0.4",
     "benny": "3.7.1"
   },
   "dependencies": {
     "dequal": "^2.0.2",
     "js-cookie": "3.0.5",
-    "mitt": "^3.0.0",
+    "mitt": "^3.0.1",
     "p-limit": "^3.1.0",
-    "rfdc": "^1.3.0"
+    "rfdc": "^1.3.0",
+    "uuid": "9.0.1"
   },
   "files": [
     "/dist"
@@ -66,5 +68,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "741cd50843c92d550dbff2daffb3a6106a7a3f94"
+  "gitHead": "9f52e6cfd6e562e9c759735ba2a44378388a2a82"
 }