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

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

@@ -1,4 +1,4 @@
-import { c as components, e as external } from './v2-manifest.swagger-d0899723';
+import { c as components, e as external } from './v2-manifest.swagger-ff2af13e';
 import * as mitt from 'mitt';
 
 declare type StorageCommand<TID extends string = string, TData = unknown> = {
@@ -192,25 +192,65 @@ declare abstract class TransitionDataStore {
     getClientTransitionState(): ServerToClientTransitionState | undefined;
 }
 
-declare type CookieAdapter = {
-    get: (name: string) => string | undefined;
-    set: (name: string, value: string) => void;
-    remove: (name: string) => void;
+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'];
+
+/**
+ * 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;
 };
-declare type DecayOptions = {
-    now: number;
-    lastUpd: number | undefined;
-    scores: ScoreVector;
-    sessionScores: ScoreVector;
+declare type CriteriaEvaluatorParameters = {
+    /** The update being made to the Context state */
+    update: ContextStateUpdate;
+    /** Current criteria to evaluate the update against */
+    criteria: SignalCriteria;
+    /**
+     * The storage commands that will be executed by this update.
+     * If the evaluation requires custom commands, push them into this parameter.
+     * NOTE: needing to use this is very rare and should be avoided if possible.
+     */
+    commands: StorageCommands[];
+    /** The parent signal containing the criteria we are evaluating */
+    signal: SignalData;
+    /** Function to emit log notices to the Context log */
+    onLogMessage?: (message: LogMessage) => void;
+};
+declare type SignalData = Signal & {
+    id: string;
 };
 /**
- * Computes decay of visitor scores over time.
- * NOTE: it is expected that this function mutates the incoming score vectors,
- * if it needs to apply score decay. The data store ensures immutability already.
- *
- * @returns true if any decay was applied, false otherwise
+ * A type that evaluates a signal criteria type and
+ * decides if it matches the current Context state or not.
  */
-declare type DecayFunction = (options: DecayOptions) => boolean;
+declare type CriteriaEvaluator = ((parameters: CriteriaEvaluatorParameters) => CriteriaEvaluatorResult) & {
+    /** If true the criteria will always execute even if a short-circuit would normally skip it */
+    alwaysExecute?: boolean;
+};
+
+declare class GroupCriteriaEvaluator {
+    #private;
+    constructor(criteriaEvaluators: Record<string, CriteriaEvaluator>);
+    evaluate(update: ContextStateUpdate, crit: SignalCriteriaGroup, commands: StorageCommands[], signal: SignalData, onLogMessage?: (message: LogMessage) => void): CriteriaEvaluatorResult;
+}
 
 /** Defines all error codes and their parameter(s)  */
 declare type LogMessages = {
@@ -232,6 +272,8 @@ declare type LogMessages = {
     102: MessageFunc<VisitorData>;
     /** Storage data was deleted bool: fromAllDevices */
     103: MessageFunc<boolean>;
+    /** Visitor was assigned or removed from control group */
+    104: MessageFunc<boolean>;
     /** Storage score was truncated to its cap */
     110: MessageFunc<{
         dim: string;
@@ -244,13 +286,51 @@ declare type LogMessages = {
     130: MessageFunc<ScoreVector>;
     /** Server to client transition data was discarded */
     131: MessageFunc;
-    /** Test did not exist */
+    /** Decay function executed */
+    140: MessageFunc<string>;
+    /** Signals evaluation beginning */
+    200: MessageFunc;
+    /** Evaluation of a specific signal beginning */
+    201: MessageFunc<SignalData>;
+    /** Evaluation of a group beginning */
+    202: MessageFunc<SignalCriteriaGroup>;
+    203: MessageFunc<{
+        criteria: SignalCriteria;
+        result: CriteriaEvaluatorResult;
+        explanation: string;
+    }>;
+    /** Result of evaluating a criteria group */
+    204: MessageFunc<CriteriaEvaluatorResult>;
+    /** Personalization placement executing */
+    300: MessageFunc<{
+        name: string;
+        take?: number;
+    }>;
+    /** Personalization placement testing variation */
+    301: MessageFunc<{
+        id: string;
+        op?: string;
+    }>;
+    /** Processed a personalization criteria */
+    302: MessageFunc<{
+        matched: boolean;
+        description: string;
+    }>;
+    /** Final result for a personalized variation */
+    303: MessageFunc<boolean>;
+    /** A/B test placement executing */
+    400: MessageFunc<string>;
+    /** A/B Test definition did not exist */
     401: MessageFunc<string>;
     /** Previously shown test variant no longer in variant data */
     402: MessageFunc<{
-        test: string;
-        variant: string;
+        missingVariant: string;
+        variants: string[];
     }>;
+    /** Selected a new A/B test variation */
+    403: MessageFunc<string>;
+    /** Displaying A/B test variation */
+    404: MessageFunc<string>;
     /** gtag was not present on the page to emit events to */
     700: MessageFunc;
     /** Enabled gtag event signal redirection */
@@ -258,15 +338,41 @@ declare type LogMessages = {
 };
 
 declare type Severity = 'debug' | 'info' | 'warn' | 'error';
+declare type MessageCategory = 'context' | 'storage' | 'testing' | 'personalization' | 'gtag' | 'signals';
 declare type OutputSeverity = Severity | 'none';
-declare type MessageFunc<TArg = void> = (arg: TArg) => [string, string, ...any];
-declare type LogMessage<TID extends keyof LogMessages = keyof LogMessages> = [
+declare type MessageFunc<TArg = void> = (arg: TArg) => [
+    /** Category of the message */
+    MessageCategory,
+    /** Log message text */
+    string,
+    /** Log message */
+    ...unknown[]
+];
+declare type LogMessage = LogMessageSingle | LogMessageGroup;
+declare type LogMessageSingle<TID extends keyof LogMessages = keyof LogMessages> = [
     severity: Severity,
     id: TID,
     ...args: Parameters<LogMessages[TID]>
 ];
+declare type LogMessageGroup<TID extends keyof LogMessages = keyof LogMessages> = [severity: Severity, id: TID, group: 'GROUP', ...args: Parameters<LogMessages[TID]>] | [severity: Severity, id: TID, group: 'ENDGROUP'];
 declare type LogDrain = (message: LogMessage) => void;
 
+declare type DecayOptions = {
+    now: number;
+    lastUpd: number | undefined;
+    scores: ScoreVector;
+    sessionScores: ScoreVector;
+    onLogMessage?: (message: LogMessage) => void;
+};
+/**
+ * Computes decay of visitor scores over time.
+ * NOTE: it is expected that this function mutates the incoming score vectors,
+ * if it needs to apply score decay. The data store ensures immutability already.
+ *
+ * @returns true if any decay was applied, false otherwise
+ */
+declare type DecayFunction = (options: DecayOptions) => boolean;
+
 declare type VisitorDataStoreOptions = {
     /** Transition storage used to transfer server or edge side execution state to the client. Unused for client side only. */
     transitionStore?: TransitionDataStore;
@@ -352,9 +458,10 @@ declare class VisitorDataStore {
 declare class ManifestInstance {
     #private;
     readonly data: ManifestV2;
-    constructor({ manifest, evaluator, }: {
+    constructor({ manifest, evaluator, onLogMessage, }: {
         manifest: ManifestV2;
         evaluator?: GroupCriteriaEvaluator;
+        onLogMessage?: (message: LogMessage) => void;
     });
     rollForControlGroup(): boolean;
     getTest(name: string): TestDefinition | undefined;
@@ -366,44 +473,6 @@ declare class ManifestInstance {
     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'];
-
-/**
- * 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.
- */
-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): CriteriaEvaluatorResult;
-}
-
 /** Content that is tagged for adding enrichment score when triggered by behavior (i.e. being shown that content) */
 declare type BehaviorTag = {
     beh?: EnrichmentData[];
@@ -484,8 +553,9 @@ declare type PersonalizeOptions<TVariant> = {
     variations: Iterable<TVariant>;
     /** Maximum number of variants to place (default: 1) */
     take?: number;
+    onLogMessage?: (message: LogMessage) => void;
 };
-declare function personalizeVariations<TVariant extends PersonalizedVariant>({ context, variations, take, }: PersonalizeOptions<TVariant> & {
+declare function personalizeVariations<TVariant extends PersonalizedVariant>({ name, context, variations, take, onLogMessage, }: PersonalizeOptions<TVariant> & {
     context: Context;
 }): PersonalizedResult<TVariant>;
 
@@ -542,8 +612,9 @@ declare type TestOptions<TVariant extends TestVariant> = {
     /** Variations that are being tested. */
     variations: TVariant[];
 };
-declare const testVariations: <TVariant extends TestVariant>({ name, context, variations, }: TestOptions<TVariant> & {
+declare const testVariations: <TVariant extends TestVariant>({ name, context, variations, onLogMessage, }: TestOptions<TVariant> & {
     context: Context;
+    onLogMessage?: ((message: LogMessage) => void) | undefined;
 }) => TestResult<TVariant>;
 
 /**
@@ -612,7 +683,7 @@ declare type ContextEvents = {
      * 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;
+    log: LogMessage | LogMessageGroup;
     /** Test variant has been selected */
     testResult: TestEvent;
     /** Personalization variants have been selected */
@@ -647,7 +718,9 @@ declare class Context implements Context {
      * will NOT result in a recomputation of signal state.
      */
     update(newData: Partial<ContextState>): Promise<void>;
+    /** use test() instead */
     getTestVariantId(testName: string): string | null | undefined;
+    /** use test() instead */
     setTestVariantId(testName: string, variantId: string): void;
     /**
      * Writes a message to the Context log sink.
@@ -729,4 +802,4 @@ declare global {
     }
 }
 
-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 };
+export { ContextEvents as $, AggregateDimension as A, SetTestCommand as B, ContextPlugin as C, DecayFunction as D, EnrichmentCategory as E, SetControlGroupCommand as F, GroupCriteriaEvaluator as G, DecayOptions as H, IdentifyCommand as I, VisitorDataStoreOptions as J, VisitorDataStoreEvents as K, LogDrain as L, ManifestInstance as M, NumberMatch as N, OutputSeverity as O, PersonalizationManifest as P, Quirks as Q, VisitorDataStore as R, StorageCommands as S, TransitionDataStore as T, ServerToClientTransitionState as U, VisitorData as V, SERVER_STATE_ID as W, TransitionDataStoreEvents as X, ContextOptions as Y, PersonalizationEvent as Z, TestEvent as _, TransitionDataStoreOptions as a, Context as a0, LogMessages as a1, Severity as a2, MessageCategory as a3, MessageFunc as a4, LogMessageSingle as a5, LogMessageGroup as a6, testVariations as a7, TestOptions as a8, PersonalizeOptions as a9, personalizeVariations as aa, DimensionMatch as ab, BehaviorTag as ac, PersonalizedVariant as ad, PersonalizedResult as ae, TestVariant as af, TestResult as ag, TaggedContent as ah, DevToolsUiVersion as ai, DevToolsState as aj, DevToolsActions as ak, DevToolsEvent as al, DevToolsEvents as am, DevToolsLogEvent as an, DevToolsDataEvent as ao, DevToolsHelloEvent as ap, DevToolsUpdateEvent as aq, DevToolsRawCommandsEvent as ar, DevToolsForgetEvent as as, CriteriaEvaluator as b, StringMatch as c, ScoreVector as d, VariantMatchCriteria as e, LogMessage as f, ManifestV2 as g, Signal as h, SignalCriteriaGroup as i, SignalCriteria as j, TestDefinition as k, AggregateDimensionInput as l, CriteriaEvaluatorResult as m, CriteriaEvaluatorParameters as n, SignalData as o, Tests as p, EnrichmentData as q, EventData as r, emptyVisitorData as s, ContextState as t, ContextStateUpdate as u, StorageCommand as v, ModifyScoreCommand as w, ModifySessionScoreCommand as x, SetConsentCommand as y, SetQuirkCommand as z };

package/dist/{v2-manifest.swagger-d0899723.d.ts → v2-manifest.swagger-ff2af13e.d.ts}

@@ -41,6 +41,15 @@ interface components {
     schemas: {
         ManifestV2: {
             project: {
+                /**
+                 * Format: uuid
+                 * @description is not present unless getting a preview manifest
+                 */
+                id?: string;
+                /** @description is not present unless getting a preview manifest */
+                name?: string;
+                /** @description is not present unless getting a preview manifest */
+                ui_version?: number;
                 pz?: components["schemas"]["PersonalizationManifest"];
                 /** @description A/B test settings */
                 test?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/context",
-  "version": "14.2.1-alpha.119+b726f7c20",
+  "version": "14.2.1-alpha.177+e3102741f",
   "description": "Uniform Context core package",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -49,14 +49,16 @@
     "benchmark:run": "node ./dist/storage.benchmark.js"
   },
   "devDependencies": {
+    "@types/js-cookie": "3.0.1",
     "@types/yargs": "17.0.9",
-    "@uniformdev/cli": "^14.2.1-alpha.119+b726f7c20",
+    "@uniformdev/cli": "^14.2.1-alpha.177+e3102741f",
     "benny": "3.7.1",
     "yargs": "17.3.1"
   },
   "dependencies": {
     "dequal": "^2.0.2",
     "isomorphic-unfetch": "^3.1.0",
+    "js-cookie": "3.0.1",
     "mitt": "^3.0.0",
     "p-limit": "^3.1.0",
     "rfdc": "^1.3.0"
@@ -64,5 +66,5 @@
   "files": [
     "/dist"
   ],
-  "gitHead": "b726f7c2068ba5527031277697f09965afad3e7a"
+  "gitHead": "e3102741f79fa495dba2796f59e3b2a6734c3c7e"
 }