@uniformdev/context 19.195.0 → 19.195.1-alpha.2

package/dist/{types-o4ZU_qKY.d.mts → types-WXZBuJXL.d.mts}

@@ -372,50 +372,79 @@ 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).
-         */
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description 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;
                 };
+                header?: never;
+                path?: never;
+                cookie?: never;
             };
+            requestBody?: never;
             responses: {
-                /** OK */
+                /** @description OK */
                 200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
                     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 */
+                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 */
                 404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
                     content: {
                         "text/plain": string;
                     };
                 };
-                429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
-                500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
+                429: components["responses"]["RateLimitError"];
+                500: components["responses"]["InternalServerError"];
             };
         };
-        /** Handles preflight requests. This endpoint allows CORS. */
+        put?: never;
+        post?: never;
+        delete?: never;
+        /** @description Handles preflight requests. This endpoint allows CORS. */
         options: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
             responses: {
-                /** OK */
-                204: never;
+                /** @description OK */
+                204: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
             };
         };
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
 }
 interface components {
@@ -434,294 +463,284 @@ interface components {
                 pz?: components["schemas"]["PersonalizationManifest"];
                 /** @description A/B test settings */
                 test?: {
-                    [key: string]: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["Test"];
+                    [key: string]: 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"];
+                [key: string]: 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"];
+                [key: string]: 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"];
+                [key: string]: components["schemas"]["AggregateDimension"];
             };
             /** @description 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}
+             */
+            type: "G";
+            /**
+             * @description 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 */
+            clauses: (components["schemas"]["SignalCriteriaGroup"] | components["schemas"]["SignalCriteria"])[];
+        };
+        /** @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')
+             *
+             * @enum {string}
+             */
+            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
+             *
+             * @enum {string}
+             */
+            op: "*" | "!*";
+        };
+        /** @description Matches a web cookie value */
+        CookieCriteria: {
+            /** @enum {string} */
+            type: "CK";
+            /** @description The name of the cookie to match */
+            cookieName: string;
+            /** @description The value to match the cookie against */
+            match: components["schemas"]["StringMatch"];
+        };
+        /** @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;
+            /** @description The value to match the query string parameter against */
+            match: components["schemas"]["StringMatch"];
+        };
+        /** @description Matches a visitor quirk key and value */
+        QuirkCriteria: {
+            /** @enum {string} */
+            type: "QK";
+            /** @description The name of the quirk key to match */
+            key: string;
+            /** @description The quirk value to match against */
+            match: components["schemas"]["StringMatch"];
+        };
+        /** @description Matches an analytics event name being fired */
+        EventCriteria: {
+            /** @enum {string} */
+            type: "EVT";
+            /** @description How to match the event name */
+            event: 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: {
+            /** @enum {string} */
+            type: "PV";
+            /** @description 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 */
+        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
+             *
+             * @enum {string}
+             */
+            op: "=" | "<" | ">" | "!=";
+        };
+        PageViewCountCriteria: {
+            /** @enum {string} */
+            type: "PVC";
+            /** @description 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}
+             */
+            type: "G";
+            /**
+             * @description The logical operator to apply to the criteria groups
+             *     & = AND
+             *     | = OR
+             *
+             *     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"])[];
+        };
+        Conversion: {
+            /**
+             * @description The frequency of the conversion event
+             * @enum {string}
+             */
+            freq: "O";
+        };
+        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)
+             *
+             * @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 */
+            cap: number;
+        };
+        /** @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 aggregate will have no score regardless of other inputs)
+             *
+             *     Default if unspecified: '+'
+             *
+             * @default +
+             * @enum {string}
+             */
+            sign?: "+" | "-" | "c";
+        };
+        /** @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: 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) */
+            wv?: string;
+        };
+        Error: {
+            /** @description Error message(s) that occurred while processing the request */
+            errorMessage?: string[] | string;
+        };
     };
-}
-interface external {
-    "swagger.yml": {
-        paths: {};
-        components: {
-            schemas: {
-                Error: {
-                    /** @description Error message(s) that occurred while processing the request */
-                    errorMessage?: string[] | string;
-                };
+    responses: {
+        /** @description Request input validation failed */
+        BadRequestError: {
+            headers: {
+                [name: string]: unknown;
             };
-            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"];
-                    };
-                };
-                /** Resource not found */
-                NotFoundError: {
-                    content: {
-                        "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
-                    };
-                };
-                /** Too many requests in allowed time period */
-                RateLimitError: unknown;
-                /** Execution error occurred */
-                InternalServerError: unknown;
+            content: {
+                "application/json": components["schemas"]["Error"];
             };
         };
-        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)
-                     *
-                     * @enum {string}
-                     */
-                    dur: "s" | "p" | "t";
-                    crit: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["RootSignalCriteriaGroup"];
-                    conversion?: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["Conversion"] | null;
-                };
-                RootSignalCriteriaGroup: {
-                    /**
-                     * @description Criteria type (Group of other criteria)
-                     * @enum {string}
-                     */
-                    type: "G";
-                    /**
-                     * @description The logical operator to apply to the criteria groups
-                     * & = AND
-                     * | = OR
-                     *
-                     * 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"])[];
-                };
-                Conversion: {
-                    /**
-                     * @description The frequency of the conversion event
-                     * @enum {string}
-                     */
-                    freq: "O";
-                };
-                SignalCriteriaGroup: {
-                    /**
-                     * @description Criteria type (Group of other criteria)
-                     * @enum {string}
-                     */
-                    type: "G";
-                    /**
-                     * @description 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 */
-                    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: {
-                    /** @enum {string} */
-                    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: {
-                    /** @enum {string} */
-                    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: {
-                    /** @enum {string} */
-                    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: {
-                    /** @enum {string} */
-                    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: {
-                    /** @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"];
-                };
-                /** @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')
-                     *
-                     * @enum {string}
-                     */
-                    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
-                     *
-                     * @enum {string}
-                     */
-                    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
-                     *
-                     * @enum {string}
-                     */
-                    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 aggregate will have no score regardless of other inputs)
-                     *
-                     * Default if unspecified: '+'
-                     *
-                     * @default +
-                     * @enum {string}
-                     */
-                    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;
-                };
+        /** @description API key or token was not valid */
+        UnauthorizedError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
+        /** @description Permission was denied */
+        ForbiddenError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
+        /** @description Too many requests in allowed time period */
+        RateLimitError: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content?: never;
+        };
+        /** @description Execution error occurred */
+        InternalServerError: {
+            headers: {
+                [name: string]: unknown;
             };
+            content?: never;
         };
-        operations: {};
     };
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
 }
 
-type SharedTypes = external['uniform-context-types.swagger.yml']['components']['schemas'];
 type ManifestV2 = components['schemas']['ManifestV2'];
 type PersonalizationManifest = components['schemas']['PersonalizationManifest'];
-type Signal = SharedTypes['Signal'];
-type SignalCriteriaGroup = SharedTypes['SignalCriteriaGroup'];
-type SignalCriteria = SharedTypes['SignalCriteria'];
-type EnrichmentCategory = SharedTypes['EnrichmentCategory'];
-type StringMatch = SharedTypes['StringMatch'];
-type NumberMatch = SharedTypes['NumberMatch'];
-type TestDefinition = SharedTypes['Test'];
-type AggregateDimension = SharedTypes['AggregateDimension'];
-type AggregateDimensionInput = SharedTypes['AggregateDimensionInput'];
+type Signal = components['schemas']['Signal'];
+type SignalCriteriaGroup = components['schemas']['SignalCriteriaGroup'];
+type SignalCriteria = components['schemas']['SignalCriteria'];
+type EnrichmentCategory = components['schemas']['EnrichmentCategory'];
+type StringMatch = components['schemas']['StringMatch'];
+type NumberMatch = components['schemas']['NumberMatch'];
+type TestDefinition = components['schemas']['Test'];
+type AggregateDimension = components['schemas']['AggregateDimension'];
+type AggregateDimensionInput = components['schemas']['AggregateDimensionInput'];
 
 declare class GroupCriteriaEvaluator {
     #private;