@uniformdev/context 12.2.1-alpha.135 → 12.2.1-alpha.170

package/dist/index.d.ts

@@ -110,7 +110,14 @@ declare type ContextStateUpdate = {
 declare type TransitionDataStoreOptions = {
     initialData?: Partial<VisitorData>;
 };
-declare type ServerToClientTransitionState = Pick<Partial<VisitorData>, 'quirks' | 'tests'>;
+declare type ServerToClientTransitionState = Pick<Partial<VisitorData>, 'quirks' | 'tests'> & {
+    /**
+     * Server Score Vector - the resultant scores _on the server side_ after the server/edge render completes
+     * Note that the client side does not trust these scores; they are only used until it's done with initial
+     * recomputation.
+     */
+    ssv?: ScoreVector;
+};
 declare const SERVER_STATE_ID = "__UNIFORM_DATA__";
 declare type TransitionDataStoreEvents = {
     /**
@@ -243,6 +250,232 @@ declare type DecayOptions = {
  */
 declare type DecayFunction = (options: DecayOptions) => boolean;
 
+/**
+ * Creates a new log drain that will log to the console.
+ * The log drain will only log event IDs, but is much smaller than the
+ * debug log drain.
+ *
+ * NOTE: you probably want enableConsoleLogDrain() instead of this function.
+ */
+declare function createConsoleLogDrain(level: OutputSeverity): LogDrain;
+/**
+ * Enables logging Context events to the browser console.
+ * Lightweight events with only the event ID are emitted.
+ */
+declare function enableConsoleLogDrain(level: OutputSeverity): ContextPlugin;
+
+/** Defines all error codes and their parameter(s)  */
+declare type LogMessages = {
+    /** Context constructed */
+    1: MessageFunc;
+    /** Context received data update */
+    2: MessageFunc<Partial<Omit<ContextState, 'url'> & {
+        url: string;
+    }>>;
+    /** Context emitted new score vector */
+    3: MessageFunc<ScoreVector>;
+    /** Context emitted updated quirks */
+    4: MessageFunc<Quirks>;
+    /** Storage received update commands */
+    101: MessageFunc<StorageCommands[]>;
+    /** Storage data was updated */
+    102: MessageFunc<VisitorData>;
+    /** Storage data was deleted bool: fromAllDevices */
+    103: MessageFunc<boolean>;
+    /** Storage score was truncated to its cap */
+    110: MessageFunc<{
+        dim: string;
+        score: number;
+        cap: number;
+    }>;
+    /** Storage visitor data expired and was cleared */
+    120: MessageFunc;
+    /** Server to client transition score data was loaded */
+    130: MessageFunc<ScoreVector>;
+    /** Placement does not have a name */
+    301: MessageFunc;
+    /** Test did not exist */
+    401: MessageFunc<string>;
+    /** Previously shown test variant no longer in variant data */
+    402: MessageFunc<{
+        test: string;
+        variant: string;
+    }>;
+    /** gtag was not present on the page to emit events to */
+    700: MessageFunc;
+    /** Enabled gtag event signal redirection */
+    701: MessageFunc;
+};
+
+declare type Severity = 'debug' | 'info' | 'warn' | 'error';
+declare type OutputSeverity = Severity | 'none';
+declare type MessageFunc<TArg = void> = (arg: TArg) => [string, string, ...any];
+declare type LogMessage<TID extends keyof LogMessages = keyof LogMessages> = [
+    severity: Severity,
+    id: TID,
+    ...args: Parameters<LogMessages[TID]>
+];
+declare type LogDrain = (message: LogMessage) => void;
+
+/**
+ * Creates a new log drain that will log full debug messages to the console.
+ * The debug log drain adds significant bundle size, but is useful for debugging.
+ *
+ * NOTE: you probably want enableDebugConsoleLogDrain() instead of this function.
+ */
+declare function createDebugConsoleLogDrain(level: OutputSeverity): LogDrain;
+/**
+ * Enables logging Context events to the browser console.
+ * Lightweight events with only the event ID are emitted.
+ */
+declare function enableDebugConsoleLogDrain(level: OutputSeverity): ContextPlugin;
+
+declare type VisitorDataStoreOptions = {
+    /** Transition storage used to transfer server or edge side execution state to the client. Unused for client side only. */
+    transitionStore?: TransitionDataStore;
+    /** Duration of a 'visit' measured by this number of milliseconds without performing any updates */
+    visitLifespan?: number;
+    /** Personalization manifest data. If set, the data store will automatically apply score caps in the manifest data. */
+    manifest?: ManifestInstance;
+    /** Allows decaying of scores over time based on time between visits. Default: no decay */
+    decay?: DecayFunction;
+    /**
+     * Sets the default value of storage consent for new unknown visitors.
+     * If storage consent is not given, only in-memory data will be stored which is lost when the browser leaves the page.
+     * @default false - consent is not given for new visitors until they explicitly give it with an update command
+     */
+    defaultConsent?: boolean;
+    /**
+     * Function called when server-to-client transfer state is loaded and contains server-side computed scores.
+     * These scores are used as a temporary shim for the current scores on the client side, until score computation
+     * is completed the first time (which occurs when the current url is fed into the Context).
+     *
+     * Because the feed of the URL may be marginally delayed (for example in React it's in an effect so it's a second render),
+     * one render might be done with _no_ scores unless we dropped the server scores in temporarily, resulting in a flash of unpersonalized content.
+     */
+    onServerTransitionScoresReceived?: (ssv: ScoreVector) => void;
+    /** Called when a log message is emitted from the data store */
+    onLogMessage?: (message: LogMessage) => void;
+};
+declare type VisitorDataStoreEvents = {
+    /**
+     * Fired when the stored data is updated.
+     * This is fired for any update, whether from integrated or transition storage.
+     * The event is NOT fired if an update does not result in any score changes.
+     */
+    scoresUpdated: Pick<VisitorData, 'scores' | 'sessionScores'>;
+    /**
+     * Fired when stored quirks are updated.
+     * This is fired for any update, whether from integrated or transition storage.
+     * The event is NOT fired if an update does not result in any quirk changes.
+     */
+    quirksUpdated: Pick<VisitorData, 'quirks'>;
+    /**
+     * Fired when test variant selection is updated.
+     */
+    testsUpdated: Pick<VisitorData, 'tests'>;
+    /**
+     * Fired when storage consent is changed
+     */
+    consentUpdated: Pick<VisitorData, 'consent'>;
+    /**
+     * Fired when visitor control group membership is changed
+     */
+    controlGroupUpdated: Pick<VisitorData, 'controlGroup'>;
+};
+declare class VisitorDataStore {
+    #private;
+    constructor(options: VisitorDataStoreOptions);
+    /** Gets the current visitor data. This property is always up to date. */
+    get data(): VisitorData;
+    get decayEnabled(): boolean;
+    /**
+     * Subscribe to events from storage
+     */
+    readonly events: {
+        on: {
+            <Key extends keyof VisitorDataStoreEvents>(type: Key, handler: mitt.Handler<VisitorDataStoreEvents[Key]>): void;
+            (type: "*", handler: mitt.WildcardHandler<VisitorDataStoreEvents>): void;
+        };
+        off: {
+            <Key_1 extends keyof VisitorDataStoreEvents>(type: Key_1, handler?: mitt.Handler<VisitorDataStoreEvents[Key_1]> | undefined): void;
+            (type: "*", handler: mitt.WildcardHandler<VisitorDataStoreEvents>): void;
+        };
+    };
+    /** Push data update command(s) into the visitor data */
+    updateData(commands: StorageCommands[]): Promise<void>;
+    /**
+     * Deletes visitor data (forgetting them)
+     * In most cases you should use forget() on the Context instead of this function, which also clears the Context state.
+     * @param fromAllDevices for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
+     */
+    delete(fromAllDevices: boolean): Promise<void>;
+}
+
+declare class ManifestInstance {
+    #private;
+    readonly data: ManifestV2;
+    constructor({ manifest, evaluator, }: {
+        manifest: ManifestV2;
+        evaluator?: GroupCriteriaEvaluator;
+    });
+    rollForControlGroup(): boolean;
+    getTest(name: string): TestDefinition | undefined;
+    computeSignals(update: ContextStateUpdate): StorageCommands[];
+    /**
+     * Computes aggregated scores based on other dimensions
+     */
+    computeAggregateDimensions(primitiveScores: ScoreVector): ScoreVector;
+    getDimensionByKey(scoreKey: string): EnrichmentCategory | Signal | undefined;
+}
+
+declare type SharedTypes = external['uniform-context-types.swagger.yml']['components']['schemas'];
+declare type ManifestV2 = components['schemas']['ManifestV2'];
+declare type PersonalizationManifest = components['schemas']['PersonalizationManifest'];
+declare type Signal = SharedTypes['Signal'];
+declare type SignalCriteriaGroup = SharedTypes['SignalCriteriaGroup'];
+declare type SignalCriteria = SharedTypes['SignalCriteria'];
+declare type EnrichmentCategory = SharedTypes['EnrichmentCategory'];
+declare type StringMatch = SharedTypes['StringMatch'];
+declare type NumberMatch = SharedTypes['NumberMatch'];
+declare type TestDefinition = SharedTypes['Test'];
+declare type AggregateDimension = SharedTypes['AggregateDimension'];
+declare type AggregateDimensionInput = SharedTypes['AggregateDimensionInput'];
+
+declare const cookieEvaluator: CriteriaEvaluator;
+
+declare const pageViewCountDimension: string;
+declare const pageViewCountEvaluator: CriteriaEvaluator;
+
+declare const queryStringEvaluator: CriteriaEvaluator;
+
+declare const quirkEvaluator: CriteriaEvaluator;
+
+declare const eventEvaluator: CriteriaEvaluator;
+
+declare const pageVisitedEvaluator: CriteriaEvaluator;
+
+/**
+ * A type that evaluates a signal criteria type and
+ * decides if it matches the current Context state or not.
+ * @returns {boolean} - true for a match, false for no match
+ * */
+declare type CriteriaEvaluator = (update: ContextStateUpdate, criteria: SignalCriteria, commands: StorageCommands[], signal: Signal, dimension: string) => boolean;
+
+declare class GroupCriteriaEvaluator {
+    #private;
+    constructor(criteriaEvaluators: Record<string, CriteriaEvaluator>);
+    evaluate(update: ContextStateUpdate, crit: SignalCriteriaGroup, commands: StorageCommands[], signal: Signal, dimension: string): boolean;
+}
+
+/** Tests if a StringMatch matches a string value */
+declare function isStringMatch(lhs: string | null | undefined, match: StringMatch): boolean;
+
+/** Computes aggregated scores based on other dimensions */
+declare function computeAggregateDimensions(primitiveScores: ScoreVector, aggregates: Record<string, AggregateDimension>): ScoreVector;
+
+declare function getEnrichmentVectorKey(category: string, value: string): string;
+
 /** Content that is tagged for adding enrichment score when triggered by behavior (i.e. being shown that content) */
 declare type BehaviorTag = {
     beh?: EnrichmentData[];
@@ -322,7 +555,7 @@ declare function personalizeVariations<TVariant extends PersonalizedVariant>({ c
     context: Context;
 }): PersonalizedResult<TVariant>;
 
-declare function evaluateVariantMatch(match: VariantMatchCriteria, vec: ScoreVector): boolean;
+declare function evaluateVariantMatch(match: VariantMatchCriteria | undefined | null, vec: ScoreVector): boolean;
 
 declare type VariantMatchCriteria = {
     /**
@@ -381,9 +614,27 @@ declare const testVariations: <TVariant extends TestVariant>({ name, context, va
     context: Context;
 }) => TestResult<TVariant>;
 
+/**
+ * Defines a plugin for Uniform Context.
+ * The plugin should attach event handlers in its creation function.
+ * @returns A function that detaches any event handlers when called
+ */
+declare type ContextPlugin = {
+    logDrain?: LogDrain;
+    init?: (context: Context) => () => void;
+};
 declare type ContextOptions = {
+    /** The Context Manifest to load (from the Context API) */
     manifest: ManifestV2;
-} & Omit<VisitorDataStoreOptions, 'manifest'>;
+    /**
+     * Context plugins to load at initialize time.
+     * Plugins that hook to the log event should be added here so that they can catch init-time log message events.
+     *
+     * Note that the Context passed to the plugin is not yet fully initialized, and is intended for event handler attachment
+     * only - don't call scores, update, etc on it. If you need to call these methods immediately, attach your plugin after initialisation.
+     */
+    plugins?: Array<ContextPlugin>;
+} & Omit<VisitorDataStoreOptions, 'manifest' | 'onServerTransitionScoresReceived'>;
 declare type PersonalizationEvent = {
     name: string;
     variantIds: string[];
@@ -406,7 +657,11 @@ declare type ContextEvents = {
      * (e.g. setting it to the same value it already has)
      */
     quirksUpdated: Quirks;
-    /** Fired when a log message is emitted from Context */
+    /**
+     * Fired when a log message is emitted from Context
+     * Note that event handlers attached to this event will not catch events
+     * logged during initialisation of the Context unless they are attached as plugins to the constructor.
+     */
     log: LogMessage;
     /** Test variant has been selected */
     testResult: TestEvent;
@@ -415,6 +670,7 @@ declare type ContextEvents = {
 };
 declare class Context implements Context {
     #private;
+    readonly manifest: ManifestInstance;
     constructor(options: ContextOptions);
     get scores(): Readonly<ScoreVector>;
     /**
@@ -450,183 +706,6 @@ declare class Context implements Context {
     forget(fromAllDevices: boolean): Promise<void>;
 }
 
-/** Defines all error codes and their parameter(s)  */
-declare type LogMessages = {
-    /** Context constructed */
-    1: MessageFunc<{
-        options: ContextOptions;
-        scores: ScoreVector;
-    }>;
-    /** Context received data update */
-    2: MessageFunc<Partial<ContextState>>;
-    /** Context emitted new score vector */
-    3: MessageFunc<ScoreVector>;
-    /** Context emitted updated quirks */
-    4: MessageFunc<Quirks>;
-    /** Storage received update commands */
-    101: MessageFunc<StorageCommands[]>;
-    /** Storage data was updated */
-    102: MessageFunc<VisitorData>;
-    /** Storage data was deleted bool: fromAllDevices */
-    103: MessageFunc<boolean>;
-    /** Storage score was truncated to its cap */
-    110: MessageFunc<{
-        dim: string;
-        score: number;
-        cap: number;
-    }>;
-    /** Storage visitor data expired and was cleared */
-    120: MessageFunc;
-    /** Placement does not have a name */
-    301: MessageFunc;
-    /** Test did not exist */
-    401: MessageFunc<string>;
-    /** Previously shown test variant no longer in variant data */
-    402: MessageFunc<{
-        test: string;
-        variant: string;
-    }>;
-    /** gtag was not present on the page to emit events to */
-    700: MessageFunc;
-    /** Enabled gtag event signal redirection */
-    701: MessageFunc;
-};
-
-declare type Severity = 'debug' | 'info' | 'warn' | 'error';
-declare type MessageFunc<TArg = void> = (arg: TArg) => [string, string, ...any];
-declare type LogMessage<TID extends keyof LogMessages = keyof LogMessages> = [
-    severity: Severity,
-    id: TID,
-    ...args: Parameters<LogMessages[TID]>
-];
-declare type LogDrain = (message: LogMessage) => void;
-
-declare const consoleLogDrain: LogDrain;
-
-declare const debugConsoleLogDrain: LogDrain;
-
-declare type VisitorDataStoreOptions = {
-    /** Transition storage used to transfer server or edge side execution state to the client. Unused for client side only. */
-    transitionStore?: TransitionDataStore;
-    /** Duration of a 'visit' measured by this number of milliseconds without performing any updates */
-    visitLifespan?: number;
-    /** Personalization manifest data. If set, the data store will automatically apply score caps in the manifest data. */
-    manifest?: ManifestInstance;
-    /** Allows decaying of scores over time based on time between visits. Default: no decay */
-    decay?: DecayFunction;
-    /**
-     * Sets the default value of storage consent for new unknown visitors.
-     * If storage consent is not given, only in-memory data will be stored which is lost when the browser leaves the page.
-     * @default false - consent is not given for new visitors until they explicitly give it with an update command
-     */
-    defaultConsent?: boolean;
-};
-declare type VisitorDataStoreEvents = {
-    /**
-     * Fired when the stored data is updated.
-     * This is fired for any update, whether from integrated or transition storage.
-     * The event is NOT fired if an update does not result in any score changes.
-     */
-    scoresUpdated: Pick<VisitorData, 'scores' | 'sessionScores'>;
-    /**
-     * Fired when stored quirks are updated.
-     * This is fired for any update, whether from integrated or transition storage.
-     * The event is NOT fired if an update does not result in any quirk changes.
-     */
-    quirksUpdated: Pick<VisitorData, 'quirks'>;
-    /** Fired when a log message is emitted from the data store */
-    log: LogMessage;
-};
-declare class VisitorDataStore {
-    #private;
-    constructor(options: VisitorDataStoreOptions);
-    /** Gets the current visitor data. This property is always up to date. */
-    get data(): VisitorData;
-    /**
-     * Subscribe to events from storage
-     */
-    readonly events: {
-        on: {
-            <Key extends keyof VisitorDataStoreEvents>(type: Key, handler: mitt.Handler<VisitorDataStoreEvents[Key]>): void;
-            (type: "*", handler: mitt.WildcardHandler<VisitorDataStoreEvents>): void;
-        };
-        off: {
-            <Key_1 extends keyof VisitorDataStoreEvents>(type: Key_1, handler?: mitt.Handler<VisitorDataStoreEvents[Key_1]> | undefined): void;
-            (type: "*", handler: mitt.WildcardHandler<VisitorDataStoreEvents>): void;
-        };
-    };
-    /** Push data update command(s) into the visitor data */
-    updateData(commands: StorageCommands[]): Promise<void>;
-    /**
-     * Deletes visitor data (forgetting them)
-     * In most cases you should use forget() on the Context instead of this function, which also clears the Context state.
-     * @param fromAllDevices for an identified user, whether to delete all their data (for the entire account) - true, or data for this device (sign out) - false
-     */
-    delete(fromAllDevices: boolean): Promise<void>;
-}
-
-declare class ManifestInstance {
-    #private;
-    constructor({ manifest, evaluator, }: {
-        manifest: ManifestV2;
-        evaluator?: GroupCriteriaEvaluator;
-    });
-    rollForControlGroup(): boolean;
-    getTest(name: string): TestDefinition | undefined;
-    computeSignals(update: ContextStateUpdate): StorageCommands[];
-    /**
-     * Computes aggregated scores based on other dimensions
-     */
-    computeAggregateDimensions(primitiveScores: ScoreVector): ScoreVector;
-    getDimensionByKey(scoreKey: string): EnrichmentCategory | Signal | undefined;
-    static getEnrichmentVectorKey(category: string, value: string): string;
-}
-
-declare type SharedTypes = external['uniform-context-types.swagger.yml']['components']['schemas'];
-declare type ManifestV2 = components['schemas']['ManifestV2'];
-declare type PersonalizationManifest = components['schemas']['PersonalizationManifest'];
-declare type Signal = SharedTypes['Signal'];
-declare type SignalCriteriaGroup = SharedTypes['SignalCriteriaGroup'];
-declare type SignalCriteria = SharedTypes['SignalCriteria'];
-declare type EnrichmentCategory = SharedTypes['EnrichmentCategory'];
-declare type StringMatch = SharedTypes['StringMatch'];
-declare type NumberMatch = SharedTypes['NumberMatch'];
-declare type TestDefinition = SharedTypes['Test'];
-declare type AggregateDimension = SharedTypes['AggregateDimension'];
-declare type AggregateDimensionInput = SharedTypes['AggregateDimensionInput'];
-
-declare const cookieEvaluator: CriteriaEvaluator;
-
-declare const pageViewCountDimension: string;
-declare const pageViewCountEvaluator: CriteriaEvaluator;
-
-declare const queryStringEvaluator: CriteriaEvaluator;
-
-declare const quirkEvaluator: CriteriaEvaluator;
-
-declare const eventEvaluator: CriteriaEvaluator;
-
-declare const pageVisitedEvaluator: CriteriaEvaluator;
-
-/**
- * A type that evaluates a signal criteria type and
- * decides if it matches the current Context state or not.
- * @returns {boolean} - true for a match, false for no match
- * */
-declare type CriteriaEvaluator = (update: ContextStateUpdate, criteria: SignalCriteria, commands: StorageCommands[], signal: Signal, dimension: string) => boolean;
-
-declare class GroupCriteriaEvaluator {
-    #private;
-    constructor(criteriaEvaluators: Record<string, CriteriaEvaluator>);
-    evaluate(update: ContextStateUpdate, crit: SignalCriteriaGroup, commands: StorageCommands[], signal: Signal, dimension: string): boolean;
-}
-
-/** Tests if a StringMatch matches a string value */
-declare function isStringMatch(lhs: string | null | undefined, match: StringMatch): boolean;
-
-/** Computes aggregated scores based on other dimensions */
-declare function computeAggregateDimensions(primitiveScores: ScoreVector, aggregates: Record<string, AggregateDimension>): ScoreVector;
-
 declare enum ScriptType {
     ListStart = "nesi-list-start",
     ListEnd = "nesi-list-end",
@@ -644,4 +723,76 @@ declare type EdgeTestComponentOptions = {
 };
 declare const EdgeNodeTagName = "nesitag";
 
-export { AggregateDimension, AggregateDimensionInput, BehaviorTag, Context, ContextEvents, ContextOptions, ContextState, ContextStateUpdate, CookieAdapter, CookieTransitionDataStore, CookieTransitionDataStoreOptions, CriteriaEvaluator, DecayFunction, DecayOptions, DimensionMatch, EdgeNodeTagName, EdgePersonalizeComponentOptions, EdgeTestComponentOptions, EdgeTransitionDataStore, EdgeTransitionDataStoreOptions, EnrichmentCategory, EnrichmentData, EventData, GroupCriteriaEvaluator, IdentifyCommand, LinearDecayOptions, LogDrain, LogMessage, LogMessages, ManifestInstance, ManifestV2, MessageFunc, ModifyScoreCommand, ModifySessionScoreCommand, NumberMatch, PersonalizationEvent, PersonalizationManifest, PersonalizeOptions, PersonalizedResult, PersonalizedVariant, Quirks, SERVER_STATE_ID, ScoreVector, ScriptType, ServerToClientTransitionState, SetConsentCommand, SetQuirkCommand, SetTestCommand, Severity, Signal, SignalCriteria, SignalCriteriaGroup, StorageCommand, StorageCommands, StringMatch, TaggedContent, TestDefinition, TestEvent, TestOptions, TestResult, TestVariant, Tests, TransitionDataStore, TransitionDataStoreEvents, TransitionDataStoreOptions, VariantMatchCriteria, VisitorData, VisitorDataStore, VisitorDataStoreEvents, VisitorDataStoreOptions, computeAggregateDimensions, consoleLogDrain, cookieEvaluator, createLinearDecay, debugConsoleLogDrain, emptyVisitorData, evaluateVariantMatch, eventEvaluator, isStringMatch, pageViewCountDimension, pageViewCountEvaluator, pageVisitedEvaluator, personalizeVariations, queryStringEvaluator, quirkEvaluator, testVariations };
+/**
+ * The version of the DevTools UI to load when in Chromium extension context.
+ * 1: Uniform Optimize.
+ * 2: Uniform Context.
+ */
+declare type DevToolsUiVersion = 1 | 2;
+/**
+ * The data state provided to the devtools for rendering.
+ */
+declare type DevToolsState = {
+    /** Current computed visitor scores (includes aggregates) */
+    scores: Readonly<ScoreVector>;
+    /** Current visitor data (includes quirks, raw scores, tests, consent, etc) */
+    data: Readonly<VisitorData>;
+    /** Personalization events that have fired since devtools started */
+    personalizations: Array<PersonalizationEvent>;
+    /** Test events that have fired since devtools started */
+    tests: Array<TestEvent>;
+    /** The Context manifest */
+    manifest: ManifestV2;
+};
+/** Mutations the DevTools can take on the data it receives */
+declare type DevToolsActions = {
+    /** Standard updates; maps to Context.update() */
+    update: (newData: Partial<ContextState>) => Promise<void>;
+    /** Raw updates to the storage subsystem. Maps to Context.storage.updateData() */
+    rawUpdate: (commands: StorageCommands[]) => Promise<void>;
+    /** Forget the current visitor and clear data on this device */
+    forget: () => Promise<void>;
+};
+declare type DevToolsEvent<Type extends string = string, TEventData = unknown> = {
+    /** The integration ID that is required */
+    type: Type;
+} & TEventData;
+declare type DevToolsEvents = DevToolsLogEvent | DevToolsDataEvent | DevToolsHelloEvent | DevToolsUpdateEvent | DevToolsRawCommandsEvent | DevToolsForgetEvent;
+/** A log message emitted as an event to the browser extension */
+declare type DevToolsLogEvent = DevToolsEvent<'uniform:context:log', {
+    message: LogMessage;
+}>;
+/** Emitted when data is updated in Context to the devtools */
+declare type DevToolsDataEvent = DevToolsEvent<'uniform:context:data', {
+    data: DevToolsState;
+}>;
+/** A hello message emitted as an event from the browser extension to test if the page contains Context */
+declare type DevToolsHelloEvent = DevToolsEvent<'uniform:context:hello', {
+    uiVersion: DevToolsUiVersion;
+}>;
+/** Devtools requests a normal update cycle (regular data update, re-eval signals, etc) */
+declare type DevToolsUpdateEvent = DevToolsEvent<'uniform-in:context:update', {
+    newData: Partial<ContextState>;
+}>;
+/** Devtools requests a raw update cycle (explicitly set scores of dimensions in durations, etc) */
+declare type DevToolsRawCommandsEvent = DevToolsEvent<'uniform-in:context:commands', {
+    commands: StorageCommands[];
+}>;
+/** A request to forget me from the DevTools */
+declare type DevToolsForgetEvent = DevToolsEvent<'uniform-in:context:forget', unknown>;
+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;
+    }
+}
+
+/**
+ * Enables a Context instance to feed data to the Uniform Context DevTools.
+ * DevTools can be hosted either as a Chromium extension, or as a standalone
+ * React app within a page and receive data once this plugin has been activated.
+ * @returns Function that when invoked detaches the event listeners and disables DevTools.
+ */
+declare function enableContextDevTools(): ContextPlugin;
+
+export { AggregateDimension, AggregateDimensionInput, BehaviorTag, Context, ContextEvents, ContextOptions, ContextPlugin, ContextState, ContextStateUpdate, CookieAdapter, CookieTransitionDataStore, CookieTransitionDataStoreOptions, CriteriaEvaluator, DecayFunction, DecayOptions, DevToolsActions, DevToolsDataEvent, DevToolsEvent, DevToolsEvents, DevToolsForgetEvent, DevToolsHelloEvent, DevToolsLogEvent, DevToolsRawCommandsEvent, DevToolsState, DevToolsUiVersion, DevToolsUpdateEvent, DimensionMatch, EdgeNodeTagName, EdgePersonalizeComponentOptions, EdgeTestComponentOptions, EdgeTransitionDataStore, EdgeTransitionDataStoreOptions, EnrichmentCategory, EnrichmentData, EventData, GroupCriteriaEvaluator, IdentifyCommand, LinearDecayOptions, LogDrain, LogMessage, LogMessages, ManifestInstance, ManifestV2, MessageFunc, ModifyScoreCommand, ModifySessionScoreCommand, NumberMatch, OutputSeverity, PersonalizationEvent, PersonalizationManifest, PersonalizeOptions, PersonalizedResult, PersonalizedVariant, Quirks, SERVER_STATE_ID, ScoreVector, ScriptType, ServerToClientTransitionState, SetConsentCommand, SetQuirkCommand, SetTestCommand, Severity, Signal, SignalCriteria, SignalCriteriaGroup, StorageCommand, StorageCommands, StringMatch, TaggedContent, TestDefinition, TestEvent, TestOptions, TestResult, TestVariant, Tests, TransitionDataStore, TransitionDataStoreEvents, TransitionDataStoreOptions, VariantMatchCriteria, VisitorData, VisitorDataStore, VisitorDataStoreEvents, VisitorDataStoreOptions, computeAggregateDimensions, cookieEvaluator, createConsoleLogDrain, createDebugConsoleLogDrain, createLinearDecay, emptyVisitorData, enableConsoleLogDrain, enableContextDevTools, enableDebugConsoleLogDrain, evaluateVariantMatch, eventEvaluator, getEnrichmentVectorKey, isStringMatch, pageViewCountDimension, pageViewCountEvaluator, pageVisitedEvaluator, personalizeVariations, queryStringEvaluator, quirkEvaluator, testVariations };