@uniformdev/context 16.2.0 → 16.2.1-alpha.320

package/dist/{contextTypes-572b0d33.d.ts → contextTypes-0d7326f7.d.ts}

@@ -1,4 +1,4 @@
-import { p as paths$7 } from './v2-manifest.swagger-ff2af13e.js';
+import { p as paths$7 } from './v2-manifest.swagger-2ea6ebb4.js';
 
 /**
  * This file was auto-generated by openapi-typescript.
@@ -382,6 +382,8 @@ interface paths$4 {
                          * @description Skips updating aggregate inputs and upserts only the aggregate definition.
                          * Inputs data is still required, but is ignored and not saved or validated.
                          * Useful when creating aggregates that reference each other: Create the definitions, then the inputs.
+                         *
+                         * @default false
                          */
                         skipInputs?: boolean;
                     };
@@ -420,6 +422,8 @@ interface components$5 {
              * @description The type of aggregate
              * 0: Audience
              * 1: Intent
+             *
+             * @enum {number}
              */
             type: 0 | 1;
             inputs: external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["AggregateDimensionInput"][];
@@ -487,12 +491,17 @@ interface external$4 {
                      * '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: external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["RootSignalCriteriaGroup"];
                 };
                 RootSignalCriteriaGroup: {
-                    /** @description Criteria type (Group of other criteria) */
+                    /**
+                     * @description Criteria type (Group of other criteria)
+                     * @enum {string}
+                     */
                     type: "G";
                     /**
                      * @description The logical operator to apply to the criteria groups
@@ -502,13 +511,17 @@ interface external$4 {
                      * Default is `&` if unspecified.
                      *
                      * @default &
+                     * @enum {string}
                      */
                     op?: "&" | "|";
                     /** @description The criteria clauses that make up this grouping of criteria */
                     clauses: (external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteriaGroup"] | external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteria"])[];
                 };
                 SignalCriteriaGroup: {
-                    /** @description Criteria type (Group of other criteria) */
+                    /**
+                     * @description Criteria type (Group of other criteria)
+                     * @enum {string}
+                     */
                     type: "G";
                     /**
                      * @description The logical operator to apply to the criteria groups
@@ -516,6 +529,8 @@ interface external$4 {
                      * | = OR
                      *
                      * Default is `&` if unspecified.
+                     *
+                     * @enum {string}
                      */
                     op?: "&" | "|";
                     /** @description The criteria clauses that make up this grouping of criteria */
@@ -524,6 +539,7 @@ interface external$4 {
                 SignalCriteria: external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["CookieCriteria"] | external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["QueryStringCriteria"] | external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["QuirkCriteria"] | external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["EventCriteria"] | external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["CurrentPageCriteria"] | external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["PageViewCountCriteria"];
                 /** @description Matches a URL query string parameter value */
                 QueryStringCriteria: {
+                    /** @enum {string} */
                     type: "QS";
                     /** @description The name of the query string parameter to match */
                     queryName: string;
@@ -532,6 +548,7 @@ interface external$4 {
                 };
                 /** @description Matches a web cookie value */
                 CookieCriteria: {
+                    /** @enum {string} */
                     type: "CK";
                     /** @description The name of the cookie to match */
                     cookieName: string;
@@ -540,6 +557,7 @@ interface external$4 {
                 };
                 /** @description Matches a visitor quirk key and value */
                 QuirkCriteria: {
+                    /** @enum {string} */
                     type: "QK";
                     /** @description The name of the quirk key to match */
                     key: string;
@@ -548,6 +566,7 @@ interface external$4 {
                 };
                 /** @description Matches an analytics event name being fired */
                 EventCriteria: {
+                    /** @enum {string} */
                     type: "EVT";
                     /** @description How to match the event name */
                     event: external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
@@ -557,11 +576,13 @@ interface external$4 {
                  * 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 */
                     path: external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
                 };
                 PageViewCountCriteria: {
+                    /** @enum {string} */
                     type: "PVC";
                     /** @description The expression to match the page view count against */
                     match: external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["NumberMatch"];
@@ -577,6 +598,8 @@ interface external$4 {
                      * '//' = 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. */
@@ -586,6 +609,8 @@ interface external$4 {
                      * @description The type of match to perform
                      * '*' = exists with any value
                      * '!*' = does not exist
+                     *
+                     * @enum {string}
                      */
                     op: "*" | "!*";
                 };
@@ -599,6 +624,8 @@ interface external$4 {
                      * '!=' = not an exact match
                      * '<' = less than match expression
                      * '>' = greater than match expression
+                     *
+                     * @enum {string}
                      */
                     op: "=" | "<" | ">" | "!=";
                 };
@@ -629,6 +656,7 @@ interface external$4 {
                      * Default if unspecified: '+'
                      *
                      * @default +
+                     * @enum {string}
                      */
                     sign?: "+" | "-" | "c";
                 };
@@ -683,6 +711,8 @@ interface components$4 {
              * AGG: Aggregation (intent or audience)
              * ENR: Enrichment
              * SIG: Signal
+             *
+             * @enum {string}
              */
             category: "AGG" | "ENR" | "SIG";
             /**
@@ -957,6 +987,7 @@ interface components$2 {
             name: string;
             winning_variant_id?: string;
             default_variant_id?: string;
+            /** @default false */
             closed?: boolean;
         };
     };
@@ -1141,12 +1172,17 @@ interface external {
                      * '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: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["RootSignalCriteriaGroup"];
                 };
                 RootSignalCriteriaGroup: {
-                    /** @description Criteria type (Group of other criteria) */
+                    /**
+                     * @description Criteria type (Group of other criteria)
+                     * @enum {string}
+                     */
                     type: "G";
                     /**
                      * @description The logical operator to apply to the criteria groups
@@ -1156,13 +1192,17 @@ interface external {
                      * Default is `&` if unspecified.
                      *
                      * @default &
+                     * @enum {string}
                      */
                     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) */
+                    /**
+                     * @description Criteria type (Group of other criteria)
+                     * @enum {string}
+                     */
                     type: "G";
                     /**
                      * @description The logical operator to apply to the criteria groups
@@ -1170,6 +1210,8 @@ interface external {
                      * | = OR
                      *
                      * Default is `&` if unspecified.
+                     *
+                     * @enum {string}
                      */
                     op?: "&" | "|";
                     /** @description The criteria clauses that make up this grouping of criteria */
@@ -1178,6 +1220,7 @@ interface external {
                 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: {
+                    /** @enum {string} */
                     type: "QS";
                     /** @description The name of the query string parameter to match */
                     queryName: string;
@@ -1186,6 +1229,7 @@ interface external {
                 };
                 /** @description Matches a web cookie value */
                 CookieCriteria: {
+                    /** @enum {string} */
                     type: "CK";
                     /** @description The name of the cookie to match */
                     cookieName: string;
@@ -1194,6 +1238,7 @@ interface external {
                 };
                 /** @description Matches a visitor quirk key and value */
                 QuirkCriteria: {
+                    /** @enum {string} */
                     type: "QK";
                     /** @description The name of the quirk key to match */
                     key: string;
@@ -1202,6 +1247,7 @@ interface external {
                 };
                 /** @description Matches an analytics event name being fired */
                 EventCriteria: {
+                    /** @enum {string} */
                     type: "EVT";
                     /** @description How to match the event name */
                     event: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
@@ -1211,11 +1257,13 @@ interface external {
                  * 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 */
                     path: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
                 };
                 PageViewCountCriteria: {
+                    /** @enum {string} */
                     type: "PVC";
                     /** @description The expression to match the page view count against */
                     match: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["NumberMatch"];
@@ -1231,6 +1279,8 @@ interface external {
                      * '//' = 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. */
@@ -1240,6 +1290,8 @@ interface external {
                      * @description The type of match to perform
                      * '*' = exists with any value
                      * '!*' = does not exist
+                     *
+                     * @enum {string}
                      */
                     op: "*" | "!*";
                 };
@@ -1253,6 +1305,8 @@ interface external {
                      * '!=' = not an exact match
                      * '<' = less than match expression
                      * '>' = greater than match expression
+                     *
+                     * @enum {string}
                      */
                     op: "=" | "<" | ">" | "!=";
                 };
@@ -1283,6 +1337,7 @@ interface external {
                      * Default if unspecified: '+'
                      *
                      * @default +
+                     * @enum {string}
                      */
                     sign?: "+" | "-" | "c";
                 };
@@ -1318,12 +1373,17 @@ interface components {
              * '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"];
         };
         RootSignalCriteriaGroup: {
-            /** @description Criteria type (Group of other criteria) */
+            /**
+             * @description Criteria type (Group of other criteria)
+             * @enum {string}
+             */
             type: "G";
             /**
              * @description The logical operator to apply to the criteria groups
@@ -1333,13 +1393,17 @@ interface components {
              * Default is `&` if unspecified.
              *
              * @default &
+             * @enum {string}
              */
             op?: "&" | "|";
             /** @description The criteria clauses that make up this grouping of criteria */
             clauses: (components["schemas"]["SignalCriteriaGroup"] | components["schemas"]["SignalCriteria"])[];
         };
         SignalCriteriaGroup: {
-            /** @description Criteria type (Group of other criteria) */
+            /**
+             * @description Criteria type (Group of other criteria)
+             * @enum {string}
+             */
             type: "G";
             /**
              * @description The logical operator to apply to the criteria groups
@@ -1347,6 +1411,8 @@ interface components {
              * | = OR
              *
              * Default is `&` if unspecified.
+             *
+             * @enum {string}
              */
             op?: "&" | "|";
             /** @description The criteria clauses that make up this grouping of criteria */
@@ -1355,6 +1421,7 @@ interface components {
         SignalCriteria: components["schemas"]["CookieCriteria"] | components["schemas"]["QueryStringCriteria"] | components["schemas"]["QuirkCriteria"] | components["schemas"]["EventCriteria"] | components["schemas"]["CurrentPageCriteria"] | components["schemas"]["PageViewCountCriteria"];
         /** @description Matches a URL query string parameter value */
         QueryStringCriteria: {
+            /** @enum {string} */
             type: "QS";
             /** @description The name of the query string parameter to match */
             queryName: string;
@@ -1363,6 +1430,7 @@ interface components {
         };
         /** @description Matches a web cookie value */
         CookieCriteria: {
+            /** @enum {string} */
             type: "CK";
             /** @description The name of the cookie to match */
             cookieName: string;
@@ -1371,6 +1439,7 @@ interface components {
         };
         /** @description Matches a visitor quirk key and value */
         QuirkCriteria: {
+            /** @enum {string} */
             type: "QK";
             /** @description The name of the quirk key to match */
             key: string;
@@ -1379,6 +1448,7 @@ interface components {
         };
         /** @description Matches an analytics event name being fired */
         EventCriteria: {
+            /** @enum {string} */
             type: "EVT";
             /** @description How to match the event name */
             event: components["schemas"]["StringMatch"];
@@ -1388,11 +1458,13 @@ interface components {
          * 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 */
             path: components["schemas"]["StringMatch"];
         };
         PageViewCountCriteria: {
+            /** @enum {string} */
             type: "PVC";
             /** @description The expression to match the page view count against */
             match: components["schemas"]["NumberMatch"];
@@ -1408,6 +1480,8 @@ interface components {
              * '//' = 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. */
@@ -1417,6 +1491,8 @@ interface components {
              * @description The type of match to perform
              * '*' = exists with any value
              * '!*' = does not exist
+             *
+             * @enum {string}
              */
             op: "*" | "!*";
         };
@@ -1430,6 +1506,8 @@ interface components {
              * '!=' = not an exact match
              * '<' = less than match expression
              * '>' = greater than match expression
+             *
+             * @enum {string}
              */
             op: "=" | "<" | ">" | "!=";
         };
@@ -1460,6 +1538,7 @@ interface components {
              * Default if unspecified: '+'
              *
              * @default +
+             * @enum {string}
              */
             sign?: "+" | "-" | "c";
         };