@uniformdev/context 20.75.1-alpha.16 → 20.76.2

package/dist/{types-C0Mthca3.d.ts → types-DovaM4gV.d.ts}

@@ -10,7 +10,7 @@ interface paths {
             cookie?: never;
         };
         /**
-         * @description Fetches the optimization Manifest for a given project.
+         * Fetches the optimization 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: {
@@ -25,7 +25,7 @@ interface paths {
             };
             requestBody?: never;
             responses: {
-                /** @description OK */
+                /** OK */
                 200: {
                     headers: {
                         [name: string]: unknown;
@@ -37,7 +37,7 @@ interface paths {
                 400: components["responses"]["BadRequestError"];
                 401: components["responses"]["UnauthorizedError"];
                 403: components["responses"]["ForbiddenError"];
-                /** @description No manifest has ever been published, and the API key does not have preview permissions */
+                /** No manifest has ever been published, and the API key does not have preview permissions */
                 404: {
                     headers: {
                         [name: string]: unknown;
@@ -53,7 +53,7 @@ interface paths {
         put?: never;
         post?: never;
         delete?: never;
-        /** @description Handles preflight requests. This endpoint allows CORS. */
+        /** Handles preflight requests. This endpoint allows CORS. */
         options: {
             parameters: {
                 query?: never;
@@ -63,7 +63,7 @@ interface paths {
             };
             requestBody?: never;
             responses: {
-                /** @description OK */
+                /** OK */
                 204: {
                     headers: {
                         [name: string]: unknown;
@@ -83,194 +83,194 @@ interface components {
             project: {
                 /**
                  * Format: uuid
-                 * @description is not present unless getting a preview manifest
+                 * is not present unless getting a preview manifest
                  */
                 id?: string;
-                /** @description is not present unless getting a preview manifest */
+                /** is not present unless getting a preview manifest */
                 name?: string;
-                /** @description is not present unless getting a preview manifest */
+                /** is not present unless getting a preview manifest */
                 ui_version?: number;
                 pz?: components["schemas"]["PersonalizationManifest"];
-                /** @description A/B test settings */
+                /** A/B test settings */
                 test?: {
                     [key: string]: components["schemas"]["Test"];
                 };
             };
         };
         PersonalizationManifest: {
-            /** @description Map of all signals defined for personalization criteria */
+            /** Map of all signals defined for personalization criteria */
             sig?: {
                 [key: string]: components["schemas"]["Signal"];
             };
-            /** @description Map of all enrichment categories defined for personalization criteria */
+            /** Map of all enrichment categories defined for personalization criteria */
             enr?: {
                 [key: string]: components["schemas"]["EnrichmentCategory"];
             };
-            /** @description Map of all aggregate dimensions (intents or audiences) defined for personalization criteria */
+            /** Map of all aggregate dimensions (intents or audiences) defined for personalization criteria */
             agg?: {
                 [key: string]: components["schemas"]["AggregateDimension"];
             };
-            /** @description Percentage of visitors that will be used as a personalization control group (not shown any personalization) */
+            /** Percentage of visitors that will be used as a personalization control group (not shown any personalization) */
             control?: number;
         };
         SignalCriteriaGroup: {
             /**
-             * @description Criteria type (Group of other criteria)
-             * @enum {string}
+             * Criteria type (Group of other criteria)
+
              */
             type: "G";
             /**
-             * @description The logical operator to apply to the criteria groups
+             * The logical operator to apply to the criteria groups
              *     & = AND
              *     | = OR
              *
              *     Default is `&` if unspecified
-             * @enum {string}
+
              */
             op?: "&" | "|";
-            /** @description The criteria clauses that make up this grouping of criteria */
+            /** The criteria clauses that make up this grouping of criteria */
             clauses: (components["schemas"]["SignalCriteriaGroup"] | components["schemas"]["SignalCriteria"])[];
         };
-        /** @description Describes a match expression on a string */
+        /** Describes a match expression on a string */
         StringMatch: {
-            /** @description The right-hand side of the match expression */
+            /** The right-hand side of the match expression */
             rhs: string;
             /**
-             * @description The match operator
+             * The match operator
              *     '=' = exact match
              *     '~' = contains match
              *     '//' = regular expression match
              *
              *     Any of the above can be prefixed with '!' to invert the match (i.e. != for 'not an exact match')
-             * @enum {string}
+
              */
             op: "=" | "~" | "//" | "!=" | "!~" | "!//";
-            /** @description The case sensitivity of the match. Defaults to false if unspecified */
+            /** The case sensitivity of the match. Defaults to false if unspecified */
             cs?: boolean;
         } | {
             /**
-             * @description The type of match to perform
+             * The type of match to perform
              *     '*' = exists with any value
              *     '!*' = does not exist
-             * @enum {string}
+
              */
             op: "*" | "!*";
         };
-        /** @description Matches a web cookie value */
+        /** Matches a web cookie value */
         CookieCriteria: {
             /** @enum {string} */
             type: "CK";
-            /** @description The name of the cookie to match */
+            /** The name of the cookie to match */
             cookieName: string;
-            /** @description The value to match the cookie against */
+            /** The value to match the cookie against */
             match: components["schemas"]["StringMatch"];
         };
-        /** @description Matches a URL query string parameter value */
+        /** Matches a URL query string parameter value */
         QueryStringCriteria: {
             /** @enum {string} */
             type: "QS";
-            /** @description The name of the query string parameter to match */
+            /** The name of the query string parameter to match */
             queryName: string;
-            /** @description The value to match the query string parameter against */
+            /** The value to match the query string parameter against */
             match: components["schemas"]["StringMatch"];
         };
-        /** @description Matches a visitor quirk key and value */
+        /** Matches a visitor quirk key and value */
         QuirkCriteria: {
             /** @enum {string} */
             type: "QK";
-            /** @description The name of the quirk key to match */
+            /** The name of the quirk key to match */
             key: string;
-            /** @description The quirk value to match against */
+            /** The quirk value to match against */
             match: components["schemas"]["StringMatch"];
         };
-        /** @description Matches an analytics event name being fired */
+        /** Matches an analytics event name being fired */
         EventCriteria: {
             /** @enum {string} */
             type: "EVT";
-            /** @description How to match the event name */
+            /** How to match the event name */
             event: components["schemas"]["StringMatch"];
         };
         /**
-         * @description Matches the current page's absolute path (i.e. /path/to/page.html)
+         * 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: {
             /** @enum {string} */
             type: "PV";
-            /** @description The page/route path to match as a page that has been visited */
+            /** The page/route path to match as a page that has been visited */
             path: components["schemas"]["StringMatch"];
         };
-        /** @description Describes a match expression on a number */
+        /** Describes a match expression on a number */
         NumberMatch: {
-            /** @description The right-hand side of the match expression */
+            /** The right-hand side of the match expression */
             rhs: number;
             /**
-             * @description The type of match to perform
+             * The type of match to perform
              *     '=' = exact match
              *     '!=' = not an exact match
              *     '<' = less than match expression
              *     '>' = greater than match expression
-             * @enum {string}
+
              */
             op: "=" | "<" | ">" | "!=";
         };
         PageViewCountCriteria: {
             /** @enum {string} */
             type: "PVC";
-            /** @description The expression to match the page view count against */
+            /** The expression to match the page view count against */
             match: components["schemas"]["NumberMatch"];
         };
         SignalCriteria: components["schemas"]["CookieCriteria"] | components["schemas"]["QueryStringCriteria"] | components["schemas"]["QuirkCriteria"] | components["schemas"]["EventCriteria"] | components["schemas"]["CurrentPageCriteria"] | components["schemas"]["PageViewCountCriteria"];
         RootSignalCriteriaGroup: {
             /**
-             * @description Criteria type (Group of other criteria)
-             * @enum {string}
+             * Criteria type (Group of other criteria)
+
              */
             type: "G";
             /**
-             * @description The logical operator to apply to the criteria groups
+             * The logical operator to apply to the criteria groups
              *     & = AND
              *     | = OR
              *
              *     Default is `&` if unspecified
-             * @default &
-             * @enum {string}
+             * @defaultValue &
+
              */
             op?: "&" | "|";
-            /** @description The criteria clauses that make up this grouping of criteria */
+            /** The criteria clauses that make up this grouping of criteria */
             clauses: (components["schemas"]["SignalCriteriaGroup"] | components["schemas"]["SignalCriteria"])[];
         };
         Conversion: {
             /**
-             * @description The frequency of the conversion event
-             * @enum {string}
+             * The frequency of the conversion event
+
              */
             freq: "O";
         };
         Signal: {
-            /** @description The signal strength per activation (each time its criteria are true, this score is added) */
+            /** 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 */
+            /** The maximum visitor score allowed for this signal */
             cap: number;
             /**
-             * @description How long the signal's score should persist
+             * 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)
-             * @enum {string}
+
              */
             dur: "s" | "p" | "t";
             crit: components["schemas"]["RootSignalCriteriaGroup"];
             conversion?: components["schemas"]["Conversion"] | null;
         };
         EnrichmentCategory: {
-            /** @description The maximum visitor score allowed for enrichment keys in this category */
+            /** The maximum visitor score allowed for enrichment keys in this category */
             cap: number;
         };
-        /** @description Defines an input dimension to an aggregate dimension */
+        /** Defines an input dimension to an aggregate dimension */
         AggregateDimensionInput: {
             /**
-             * @description Dimension name to reference as an input.
+             * 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.
              *
@@ -280,34 +280,34 @@ interface components {
              */
             dim: string;
             /**
-             * @description The sign of the input dimension controls how it affects the aggregate dimension's final score.
+             * 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 aggregate will have no score regardless of other inputs)
              *
              *     Default if unspecified: '+'
-             * @default +
-             * @enum {string}
+             * @defaultValue +
+
              */
             sign?: "+" | "-" | "c";
         };
-        /** @description Defines an aggregate dimension that is a grouping of other dimensions' scores; an intent or audience */
+        /** Defines an aggregate dimension that is a grouping of other dimensions' scores; an intent or audience */
         AggregateDimension: {
-            /** @description Input dimensions to the aggregate dimension */
+            /** Input dimensions to the aggregate dimension */
             inputs: components["schemas"]["AggregateDimensionInput"][];
         };
         Test: {
-            /** @description Winning variation ID - if set, the test will not run and this variation is shown to all visitors (the test is closed) */
+            /** Winning variation ID - if set, the test will not run and this variation is shown to all visitors (the test is closed) */
             wv?: string;
         };
         Error: {
-            /** @description Error message(s) that occurred while processing the request */
+            /** Error message(s) that occurred while processing the request */
             errorMessage?: string[] | string;
         };
     };
     responses: {
-        /** @description Request input validation failed */
+        /** Request input validation failed */
         BadRequestError: {
             headers: {
                 [name: string]: unknown;
@@ -316,7 +316,7 @@ interface components {
                 "application/json": components["schemas"]["Error"];
             };
         };
-        /** @description API key or token was not valid */
+        /** API key or token was not valid */
         UnauthorizedError: {
             headers: {
                 [name: string]: unknown;
@@ -325,7 +325,7 @@ interface components {
                 "application/json": components["schemas"]["Error"];
             };
         };
-        /** @description Permission was denied */
+        /** Permission was denied */
         ForbiddenError: {
             headers: {
                 [name: string]: unknown;
@@ -334,14 +334,14 @@ interface components {
                 "application/json": components["schemas"]["Error"];
             };
         };
-        /** @description Too many requests in allowed time period */
+        /** Too many requests in allowed time period */
         RateLimitError: {
             headers: {
                 [name: string]: unknown;
             };
             content?: never;
         };
-        /** @description Execution error occurred */
+        /** Execution error occurred */
         InternalServerError: {
             headers: {
                 [name: string]: unknown;
@@ -585,8 +585,8 @@ declare abstract class TransitionDataStore {
     };
     /**
      * Updates data in the transition storage.
-     * @param commands Commands to execute against existing stored value (event based stores)
-     * @param computedValue Pre-computed new value against existing value (object based stores)
+     * @param commands - Commands to execute against existing stored value (event based stores)
+     * @param computedValue - Pre-computed new value against existing value (object based stores)
      * @returns Resolved promise when the data has been updated
      */
     updateData(commands: StorageCommands[], computedValue: VisitorData): Promise<void>;
@@ -647,7 +647,7 @@ type VisitorDataStoreOptions = {
     /**
      * 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
+     * @defaultValue false - consent is not given for new visitors until they explicitly give it with an update command
      */
     defaultConsent?: boolean;
     /**
@@ -726,7 +726,7 @@ declare class VisitorDataStore {
     /**
      * 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
+     * @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>;
 }
@@ -961,12 +961,12 @@ type DimensionMatch = {
      * -: `l` is the weakest dimension in the score vector. This does not match if the dimension has no score at all.
      *
      * Comparison operators:
-     * >: `l` is greater than the right hand side expression
-     * >= : `l` is greater than or equal to the right hand side expression
-     * <: `l` is less than the right hand side expression
-     * <= : `l` is less than or equal to the right hand side expression
-     * =: `l` is equal to the right hand side expression
-     * !=: `l` is not equal to the right hand side expression
+     * `>: l` is greater than the right hand side expression
+     * `>= : l` is greater than or equal to the right hand side expression
+     * `<: l` is less than the right hand side expression
+     * `<=: l` is less than or equal to the right hand side expression
+     * `=: l` is equal to the right hand side expression
+     * `!=: l` is not equal to the right hand side expression
      */
     op: '+' | '-' | '>' | '>=' | '<' | '<=' | '=' | '!=' | '^';
     /**
@@ -1236,9 +1236,9 @@ interface ContextInstance {
         on: Emitter<ContextEvents>['on'];
         off: Emitter<ContextEvents>['off'];
     };
-    /** @deprecated */
+    /** @deprecated Internal API for test event processing; not for public use. */
     internal_processTestEvent(event: TestEvent): void;
-    /** @deprecated */
+    /** @deprecated Internal API for personalization event processing; not for public use. */
     internal_processPersonalizationEvent(event: PersonalizationEvent): void;
     /**
      * Gets the current canvas data
@@ -1304,7 +1304,7 @@ declare class Context implements ContextInstance {
     personalize<TVariant extends PersonalizedVariant<any>>(options: PersonalizeOptions<TVariant>): PersonalizedResult<TVariant>;
     /**
      * Forgets the visitor's data and resets the Context to its initial 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
+     * @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
      */
     forget(fromAllDevices: boolean): Promise<void>;
     /**
@@ -1313,9 +1313,9 @@ declare class Context implements ContextInstance {
      * Removes state from server-to-client if it came in initial state (cookies) to avoid double tracking on the client.
      */
     getServerToClientTransitionState(): ServerToClientTransitionState;
-    /** @deprecated */
+    /** @deprecated Internal API for test event processing; not for public use. */
     internal_processTestEvent(event: TestEvent): void;
-    /** @deprecated */
+    /** @deprecated Internal API for personalization event processing; not for public use. */
     internal_processPersonalizationEvent(event: PersonalizationEvent): void;
     /**
      * Gets the current canvas data

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/context",
-  "version": "20.75.1-alpha.16+4e56d1cd21",
+  "version": "20.76.2",
   "description": "Uniform Context core package",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -70,5 +70,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "4e56d1cd21f2d4a02b13d733e51fb71441cac298"
+  "gitHead": "d977f0afc2aa754b18053d9455e007712e712dbb"
 }