@uniformdev/context 12.2.1-alpha.177 → 14.2.1-alpha.119

package/dist/{types-1ad8439c.d.ts → types-d77228a6.d.ts}

@@ -1,3 +1,4 @@
+import { c as components, e as external } from './v2-manifest.swagger-d0899723';
 import * as mitt from 'mitt';
 
 declare type StorageCommand<TID extends string = string, TData = unknown> = {
@@ -99,9 +100,12 @@ declare type VisitorData = {
     controlGroup?: boolean;
 };
 declare const emptyVisitorData: () => VisitorData;
+/**
+ * Expresses a 'patch' to the Uniform Context state
+ */
 declare type ContextState = {
     cookies: Record<string, string>;
-    url: URL;
+    url?: URL;
     quirks: Quirks;
     enrichments: EnrichmentData[];
     events: EventData[];
@@ -220,6 +224,8 @@ declare type LogMessages = {
     3: MessageFunc<ScoreVector>;
     /** Context emitted updated quirks */
     4: MessageFunc<Quirks>;
+    /** Tried to set enrichment category that did not exist */
+    5: MessageFunc<EnrichmentData>;
     /** Storage received update commands */
     101: MessageFunc<StorageCommands[]>;
     /** Storage data was updated */
@@ -236,6 +242,8 @@ declare type LogMessages = {
     120: MessageFunc;
     /** Server to client transition score data was loaded */
     130: MessageFunc<ScoreVector>;
+    /** Server to client transition data was discarded */
+    131: MessageFunc;
     /** Test did not exist */
     401: MessageFunc<string>;
     /** Previously shown test variant no longer in variant data */
@@ -358,290 +366,6 @@ declare class ManifestInstance {
     getDimensionByKey(scoreKey: string): EnrichmentCategory | Signal | undefined;
 }
 
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
-interface paths {
-    "/api/v2/manifest": {
-        /**
-         * Fetches the Intent Manifest for a given project.
-         * If no manifest has ever been published, and an API key is used that has preview manifest permissions then the current preview manifest will be returned (in delivery format).
-         */
-        get: {
-            parameters: {
-                query: {
-                    preview?: boolean;
-                    projectId: string;
-                };
-            };
-            responses: {
-                /** OK */
-                200: {
-                    content: {
-                        "application/json": components["schemas"]["ManifestV2"];
-                    };
-                };
-                400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
-                401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
-                403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
-                /** No manifest has ever been published, and the API key does not have preview permissions */
-                404: {
-                    content: {
-                        "text/plain": string;
-                    };
-                };
-                429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
-                500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
-            };
-        };
-    };
-}
-interface components {
-    schemas: {
-        ManifestV2: {
-            project: {
-                pz?: components["schemas"]["PersonalizationManifest"];
-                /** @description A/B test settings */
-                test?: {
-                    [key: string]: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["Test"];
-                };
-            };
-        };
-        PersonalizationManifest: {
-            /** @description Map of all signals defined for personalization criteria */
-            sig?: {
-                [key: string]: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["Signal"];
-            };
-            /** @description Map of all enrichment categories defined for personalization criteria */
-            enr?: {
-                [key: string]: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["EnrichmentCategory"];
-            };
-            /** @description Map of all aggregate dimensions (intents or audiences) defined for personalization criteria */
-            agg?: {
-                [key: string]: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["AggregateDimension"];
-            };
-            /** @description Percentage of visitors that will be used as a personalization control group (not shown any personalization) */
-            control?: number;
-        };
-    };
-}
-interface external {
-    "swagger.yml": {
-        paths: {};
-        components: {
-            schemas: {
-                Error: {
-                    /** @description Error message(s) that occurred while processing the request */
-                    errorMessage?: string[] | string;
-                };
-            };
-            responses: {
-                /** Request input validation failed */
-                BadRequestError: {
-                    content: {
-                        "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
-                    };
-                };
-                /** API key or token was not valid */
-                UnauthorizedError: {
-                    content: {
-                        "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
-                    };
-                };
-                /** Permission was denied */
-                ForbiddenError: {
-                    content: {
-                        "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
-                    };
-                };
-                /** Too many requests in allowed time period */
-                RateLimitError: unknown;
-                /** Execution error occurred */
-                InternalServerError: unknown;
-            };
-        };
-        operations: {};
-    };
-    "uniform-context-types.swagger.yml": {
-        paths: {};
-        components: {
-            schemas: {
-                EnrichmentCategory: {
-                    /** @description The maximum visitor score allowed for enrichment keys in this category */
-                    cap: number;
-                };
-                PreviewSignal: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["Signal"] & {
-                    /** @description Friendly name of the signal */
-                    name: string;
-                    /** @description Description of the signal */
-                    description?: string;
-                };
-                Signal: {
-                    /** @description The signal strength per activation (each time its criteria are true, this score is added) */
-                    str: number;
-                    /** @description The maximum visitor score allowed for this signal */
-                    cap: number;
-                    /**
-                     * @description How long the signal's score should persist
-                     * 's' = current session (expires after a period of inactivity)
-                     * 'p' = permanent (expires as far in the future as possible, may be limited by browser security settings)
-                     * 't' = transient (score tracks the current state of the criteria every time scores are updated)
-                     */
-                    dur: "s" | "p" | "t";
-                    crit: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["RootSignalCriteriaGroup"];
-                };
-                RootSignalCriteriaGroup: {
-                    /** @description Criteria type (Group of other criteria) */
-                    type: "G";
-                    /**
-                     * @description The logical operator to apply to the criteria groups
-                     * & = AND
-                     * | = OR
-                     *
-                     * Default is `&` if unspecified.
-                     *
-                     * @default &
-                     */
-                    op?: "&" | "|";
-                    /** @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"])[];
-                };
-                SignalCriteriaGroup: {
-                    /** @description Criteria type (Group of other criteria) */
-                    type: "G";
-                    /**
-                     * @description The logical operator to apply to the criteria groups
-                     * & = AND
-                     * | = OR
-                     *
-                     * Default is `&` if unspecified.
-                     */
-                    op?: "&" | "|";
-                    /** @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"])[];
-                };
-                SignalCriteria: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["CookieCriteria"] | external["uniform-context-types.swagger.yml"]["components"]["schemas"]["QueryStringCriteria"] | external["uniform-context-types.swagger.yml"]["components"]["schemas"]["QuirkCriteria"] | external["uniform-context-types.swagger.yml"]["components"]["schemas"]["EventCriteria"] | external["uniform-context-types.swagger.yml"]["components"]["schemas"]["CurrentPageCriteria"] | external["uniform-context-types.swagger.yml"]["components"]["schemas"]["PageViewCountCriteria"];
-                /** @description Matches a URL query string parameter value */
-                QueryStringCriteria: {
-                    type: "QS";
-                    /** @description The name of the query string parameter to match */
-                    queryName: string;
-                    /** @description The value to match the query string parameter against */
-                    match: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
-                };
-                /** @description Matches a web cookie value */
-                CookieCriteria: {
-                    type: "CK";
-                    /** @description The name of the cookie to match */
-                    cookieName: string;
-                    /** @description The value to match the cookie against */
-                    match: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
-                };
-                /** @description Matches a visitor quirk key and value */
-                QuirkCriteria: {
-                    type: "QK";
-                    /** @description The name of the quirk key to match */
-                    key: string;
-                    /** @description The quirk value to match against */
-                    match: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
-                };
-                /** @description Matches an analytics event name being fired */
-                EventCriteria: {
-                    type: "EVT";
-                    /** @description How to match the event name */
-                    event: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
-                };
-                /**
-                 * @description Matches the current page's absolute path (i.e. /path/to/page.html)
-                 * Does not include the query string or protocol and hostname (i.e. NOT https://foo.com/path/to/page.html?query=something)
-                 */
-                CurrentPageCriteria: {
-                    type: "PV";
-                    /** @description The page/route path to match as a page that has been visited */
-                    path: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
-                };
-                PageViewCountCriteria: {
-                    type: "PVC";
-                    /** @description The expression to match the page view count against */
-                    match: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["NumberMatch"];
-                };
-                /** @description Describes a match expression on a string */
-                StringMatch: {
-                    /** @description The right hand side of the match expression */
-                    rhs: 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')
-                     */
-                    op: "=" | "~" | "//" | "!=" | "!~" | "!//";
-                    /** @description The case sensitivity of the match. Defaults to false if unspecified. */
-                    cs?: boolean;
-                } | {
-                    /**
-                     * @description The type of match to perform
-                     * '*' = exists with any value
-                     * '!*' = does not exist
-                     */
-                    op: "*" | "!*";
-                };
-                /** @description Describes a match expression on a number */
-                NumberMatch: {
-                    /** @description The right hand side of the match expression */
-                    rhs: number;
-                    /**
-                     * @description The type of match to perform
-                     * '=' = exact match
-                     * '!=' = not an exact match
-                     * '<' = less than match expression
-                     * '>' = greater than match expression
-                     */
-                    op: "=" | "<" | ">" | "!=";
-                };
-                /** @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"][];
-                };
-                /** @description Defines an input dimension to an aggregate dimension */
-                AggregateDimensionInput: {
-                    /**
-                     * @description Dimension name to reference as an input.
-                     * For enrichment inputs, use CATEGORY_KEY as the dimension.
-                     * Enrichments, signals, and other aggregate dimensions may be referenced.
-                     *
-                     * 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.
-                     */
-                    dim: string;
-                    /**
-                     * @description The sign of the input dimension controls how it affects the aggregate dimension's final score.
-                     *
-                     * '+' = 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)
-                     *
-                     * Default if unspecified: '+'
-                     *
-                     * @default +
-                     */
-                    sign?: "+" | "-" | "c";
-                };
-                Test: {
-                    /** @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;
-                };
-            };
-        };
-        operations: {};
-    };
-}
-
 declare type SharedTypes = external['uniform-context-types.swagger.yml']['components']['schemas'];
 declare type ManifestV2 = components['schemas']['ManifestV2'];
 declare type PersonalizationManifest = components['schemas']['PersonalizationManifest'];
@@ -655,17 +379,29 @@ declare type TestDefinition = SharedTypes['Test'];
 declare type AggregateDimension = SharedTypes['AggregateDimension'];
 declare type AggregateDimensionInput = SharedTypes['AggregateDimensionInput'];
 
+/**
+ * The result of evaluating a signal criteria.
+ */
+declare type CriteriaEvaluatorResult = {
+    /** Whether the criteria evaluated to true or not */
+    result: boolean;
+    /**
+     * Whether the value of the criteria changed from the previous state
+     * If ALL criteria on a signal have NOT changed, the signal is skipped
+     * and its score is left alone.
+     */
+    changed: boolean;
+};
 /**
  * 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 type CriteriaEvaluator = (update: ContextStateUpdate, criteria: SignalCriteria, commands: StorageCommands[], signal: Signal, dimension: string) => CriteriaEvaluatorResult;
 
 declare class GroupCriteriaEvaluator {
     #private;
     constructor(criteriaEvaluators: Record<string, CriteriaEvaluator>);
-    evaluate(update: ContextStateUpdate, crit: SignalCriteriaGroup, commands: StorageCommands[], signal: Signal, dimension: string): boolean;
+    evaluate(update: ContextStateUpdate, crit: SignalCriteriaGroup, commands: StorageCommands[], signal: Signal, dimension: string): CriteriaEvaluatorResult;
 }
 
 /** Content that is tagged for adding enrichment score when triggered by behavior (i.e. being shown that content) */
@@ -901,6 +637,15 @@ declare class Context implements Context {
         };
     };
     readonly storage: VisitorDataStore;
+    /**
+     * Updates the Context with new data of any sort, such as
+     * new URLs, cookies, quirks, and enrichments.
+     *
+     * Only properties that are set in the data parameter will be updated.
+     * Properties that do not result in a changed state,
+     * i.e. pushing the same URL or cookies as before,
+     * will NOT result in a recomputation of signal state.
+     */
     update(newData: Partial<ContextState>): Promise<void>;
     getTestVariantId(testName: string): string | null | undefined;
     setTestVariantId(testName: string, variantId: string): void;
@@ -984,4 +729,4 @@ declare global {
     }
 }
 
-export { Severity as $, AggregateDimension as A, VisitorDataStoreOptions as B, CookieAdapter as C, DecayFunction as D, EnrichmentCategory as E, VisitorDataStoreEvents as F, GroupCriteriaEvaluator as G, VisitorDataStore as H, IdentifyCommand as I, ServerToClientTransitionState as J, SERVER_STATE_ID as K, LogDrain as L, ManifestInstance as M, NumberMatch as N, OutputSeverity as O, PersonalizationManifest as P, Quirks as Q, TransitionDataStoreEvents as R, StorageCommands as S, TransitionDataStore as T, ContextOptions as U, VisitorData as V, PersonalizationEvent as W, TestEvent as X, ContextEvents as Y, Context as Z, LogMessages as _, TransitionDataStoreOptions as a, MessageFunc as a0, LogMessage as a1, testVariations as a2, TestOptions as a3, PersonalizeOptions as a4, personalizeVariations as a5, DimensionMatch as a6, BehaviorTag as a7, PersonalizedVariant as a8, PersonalizedResult as a9, TestVariant as aa, TestResult as ab, TaggedContent as ac, DevToolsUiVersion as ad, DevToolsState as ae, DevToolsActions as af, DevToolsEvent as ag, DevToolsEvents as ah, DevToolsLogEvent as ai, DevToolsDataEvent as aj, DevToolsHelloEvent as ak, DevToolsUpdateEvent as al, DevToolsRawCommandsEvent as am, DevToolsForgetEvent as an, paths as ao, ContextPlugin as b, CriteriaEvaluator as c, StringMatch as d, ScoreVector as e, VariantMatchCriteria as f, ManifestV2 as g, Signal as h, SignalCriteriaGroup as i, SignalCriteria as j, TestDefinition as k, AggregateDimensionInput as l, Tests as m, EnrichmentData as n, EventData as o, emptyVisitorData as p, ContextState as q, ContextStateUpdate as r, StorageCommand as s, ModifyScoreCommand as t, ModifySessionScoreCommand as u, SetConsentCommand as v, SetQuirkCommand as w, SetTestCommand as x, SetControlGroupCommand as y, DecayOptions as z };
+export { LogMessages as $, AggregateDimension as A, DecayOptions as B, CookieAdapter as C, DecayFunction as D, EnrichmentCategory as E, VisitorDataStoreOptions as F, GroupCriteriaEvaluator as G, VisitorDataStoreEvents as H, IdentifyCommand as I, VisitorDataStore as J, ServerToClientTransitionState as K, LogDrain as L, ManifestInstance as M, NumberMatch as N, OutputSeverity as O, PersonalizationManifest as P, Quirks as Q, SERVER_STATE_ID as R, StorageCommands as S, TransitionDataStore as T, TransitionDataStoreEvents as U, VisitorData as V, ContextOptions as W, PersonalizationEvent as X, TestEvent as Y, ContextEvents as Z, Context as _, TransitionDataStoreOptions as a, Severity as a0, MessageFunc as a1, LogMessage as a2, testVariations as a3, TestOptions as a4, PersonalizeOptions as a5, personalizeVariations as a6, DimensionMatch as a7, BehaviorTag as a8, PersonalizedVariant as a9, PersonalizedResult as aa, TestVariant as ab, TestResult as ac, TaggedContent as ad, DevToolsUiVersion as ae, DevToolsState as af, DevToolsActions as ag, DevToolsEvent as ah, DevToolsEvents as ai, DevToolsLogEvent as aj, DevToolsDataEvent as ak, DevToolsHelloEvent as al, DevToolsUpdateEvent as am, DevToolsRawCommandsEvent as an, DevToolsForgetEvent as ao, ContextPlugin as b, CriteriaEvaluator as c, StringMatch as d, ScoreVector as e, VariantMatchCriteria as f, ManifestV2 as g, Signal as h, SignalCriteriaGroup as i, SignalCriteria as j, TestDefinition as k, AggregateDimensionInput as l, CriteriaEvaluatorResult as m, Tests as n, EnrichmentData as o, EventData as p, emptyVisitorData as q, ContextState as r, ContextStateUpdate as s, StorageCommand as t, ModifyScoreCommand as u, ModifySessionScoreCommand as v, SetConsentCommand as w, SetQuirkCommand as x, SetTestCommand as y, SetControlGroupCommand as z };