@reactionary/core 0.11.1 → 0.12.0

package/src/schemas/models/analytics/envelope.model.d.ts

@@ -0,0 +1,565 @@
+import * as z from 'zod';
+import type { InferType } from '../../../zod-utils.js';
+export declare const AnalyticsPageSchema: z.ZodObject<{
+    url: z.ZodOptional<z.ZodString>;
+    title: z.ZodOptional<z.ZodString>;
+    referrer: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>;
+/**
+ * Request state captured at emit time. Dispatch happens later, after the session may have changed.
+ */
+export declare const EventContextSnapshotSchema: z.ZodObject<{
+    marketingIdentifier: z.ZodObject<{
+        key: z.ZodString;
+    }, z.core.$loose>;
+    identity: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"Anonymous">;
+    }, z.core.$loose>, z.ZodObject<{
+        id: z.ZodObject<{
+            userId: z.ZodString;
+        }, z.core.$loose>;
+        type: z.ZodLiteral<"Guest">;
+    }, z.core.$loose>, z.ZodObject<{
+        id: z.ZodObject<{
+            userId: z.ZodString;
+        }, z.core.$loose>;
+        type: z.ZodLiteral<"Registered">;
+    }, z.core.$loose>], "type">;
+    locale: z.ZodString;
+    currency: z.ZodEnum<{
+        AED: "AED";
+        AFN: "AFN";
+        ALL: "ALL";
+        AMD: "AMD";
+        ANG: "ANG";
+        AOA: "AOA";
+        ARS: "ARS";
+        AUD: "AUD";
+        AWG: "AWG";
+        AZN: "AZN";
+        BAM: "BAM";
+        BBD: "BBD";
+        BDT: "BDT";
+        BGN: "BGN";
+        BHD: "BHD";
+        BIF: "BIF";
+        BMD: "BMD";
+        BND: "BND";
+        BOB: "BOB";
+        BOV: "BOV";
+        BRL: "BRL";
+        BSD: "BSD";
+        BTN: "BTN";
+        BWP: "BWP";
+        BYN: "BYN";
+        BZD: "BZD";
+        CAD: "CAD";
+        CDF: "CDF";
+        CHE: "CHE";
+        CHF: "CHF";
+        CHW: "CHW";
+        CLF: "CLF";
+        CLP: "CLP";
+        CNY: "CNY";
+        COP: "COP";
+        COU: "COU";
+        CRC: "CRC";
+        CUC: "CUC";
+        CUP: "CUP";
+        CVE: "CVE";
+        CZK: "CZK";
+        DJF: "DJF";
+        DKK: "DKK";
+        DOP: "DOP";
+        DZD: "DZD";
+        EGP: "EGP";
+        ERN: "ERN";
+        ETB: "ETB";
+        EUR: "EUR";
+        FJD: "FJD";
+        FKP: "FKP";
+        GBP: "GBP";
+        GEL: "GEL";
+        GHS: "GHS";
+        GIP: "GIP";
+        GMD: "GMD";
+        GNF: "GNF";
+        GTQ: "GTQ";
+        GYD: "GYD";
+        HKD: "HKD";
+        HNL: "HNL";
+        HRK: "HRK";
+        HTG: "HTG";
+        HUF: "HUF";
+        IDR: "IDR";
+        ILS: "ILS";
+        INR: "INR";
+        IQD: "IQD";
+        IRR: "IRR";
+        ISK: "ISK";
+        JMD: "JMD";
+        JOD: "JOD";
+        JPY: "JPY";
+        KES: "KES";
+        KGS: "KGS";
+        KHR: "KHR";
+        KMF: "KMF";
+        KPW: "KPW";
+        KRW: "KRW";
+        KWD: "KWD";
+        KYD: "KYD";
+        KZT: "KZT";
+        LAK: "LAK";
+        LBP: "LBP";
+        LKR: "LKR";
+        LRD: "LRD";
+        LSL: "LSL";
+        LYD: "LYD";
+        MAD: "MAD";
+        MDL: "MDL";
+        MGA: "MGA";
+        MKD: "MKD";
+        MMK: "MMK";
+        MNT: "MNT";
+        MOP: "MOP";
+        MRU: "MRU";
+        MUR: "MUR";
+        MVR: "MVR";
+        MWK: "MWK";
+        MXN: "MXN";
+        MXV: "MXV";
+        MYR: "MYR";
+        MZN: "MZN";
+        NAD: "NAD";
+        NGN: "NGN";
+        NIO: "NIO";
+        NOK: "NOK";
+        NPR: "NPR";
+        NZD: "NZD";
+        OMR: "OMR";
+        PAB: "PAB";
+        PEN: "PEN";
+        PGK: "PGK";
+        PHP: "PHP";
+        PKR: "PKR";
+        PLN: "PLN";
+        PYG: "PYG";
+        QAR: "QAR";
+        RON: "RON";
+        RSD: "RSD";
+        RUB: "RUB";
+        RWF: "RWF";
+        SAR: "SAR";
+        SBD: "SBD";
+        SCR: "SCR";
+        SDG: "SDG";
+        SEK: "SEK";
+        SGD: "SGD";
+        SHP: "SHP";
+        SLE: "SLE";
+        SLL: "SLL";
+        SOS: "SOS";
+        SRD: "SRD";
+        SSP: "SSP";
+        STN: "STN";
+        SYP: "SYP";
+        SZL: "SZL";
+        THB: "THB";
+        TJS: "TJS";
+        TMT: "TMT";
+        TND: "TND";
+        TOP: "TOP";
+        TRY: "TRY";
+        TTD: "TTD";
+        TVD: "TVD";
+        TWD: "TWD";
+        TZS: "TZS";
+        UAH: "UAH";
+        UGX: "UGX";
+        USD: "USD";
+        USN: "USN";
+        UYI: "UYI";
+        UYU: "UYU";
+        UYW: "UYW";
+        UZS: "UZS";
+        VED: "VED";
+        VES: "VES";
+        VND: "VND";
+        VUV: "VUV";
+        WST: "WST";
+        XAF: "XAF";
+        XAG: "XAG";
+        XAU: "XAU";
+        XBA: "XBA";
+        XBB: "XBB";
+        XBC: "XBC";
+        XBD: "XBD";
+        XCD: "XCD";
+        XDR: "XDR";
+        XOF: "XOF";
+        XPD: "XPD";
+        XPF: "XPF";
+        XPT: "XPT";
+        XSU: "XSU";
+        XTS: "XTS";
+        XUA: "XUA";
+        XXX: "XXX";
+        YER: "YER";
+        ZAR: "ZAR";
+        ZMW: "ZMW";
+        ZWL: "ZWL";
+    }>;
+    consent: z.ZodOptional<z.ZodObject<{
+        analytics: z.ZodBoolean;
+        marketing: z.ZodBoolean;
+    }, z.core.$loose>>;
+    page: z.ZodOptional<z.ZodObject<{
+        url: z.ZodOptional<z.ZodString>;
+        title: z.ZodOptional<z.ZodString>;
+        referrer: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>>;
+    userAgent: z.ZodOptional<z.ZodString>;
+    clientIp: z.ZodOptional<z.ZodString>;
+    isBot: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$loose>;
+/**
+ * Fields shared by every event. The per-type `type` and `payload` are added by the event union.
+ */
+export declare const AnalyticsEventEnvelopeSchema: z.ZodObject<{
+    id: z.ZodString;
+    occurredAt: z.ZodISODateTime;
+    origin: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"search">;
+        identifier: z.ZodObject<{
+            term: z.ZodString;
+            facets: z.ZodArray<z.ZodObject<{
+                facet: z.ZodObject<{
+                    key: z.ZodString;
+                }, z.core.$loose>;
+                key: z.ZodString;
+            }, z.core.$strip>>;
+            filters: z.ZodArray<z.ZodString>;
+            paginationOptions: z.ZodObject<{
+                pageNumber: z.ZodDefault<z.ZodNumber>;
+                pageSize: z.ZodDefault<z.ZodNumber>;
+            }, z.core.$loose>;
+            categoryFilter: z.ZodOptional<z.ZodObject<{
+                facet: z.ZodObject<{
+                    key: z.ZodString;
+                }, z.core.$loose>;
+                key: z.ZodString;
+            }, z.core.$strip>>;
+            company: z.ZodOptional<z.ZodObject<{
+                taxIdentifier: z.ZodString;
+            }, z.core.$loose>>;
+        }, z.core.$loose>;
+        position: z.ZodInt;
+    }, z.core.$loose>, z.ZodObject<{
+        type: z.ZodLiteral<"autocomplete">;
+        term: z.ZodString;
+        position: z.ZodInt;
+    }, z.core.$loose>, z.ZodObject<{
+        type: z.ZodLiteral<"category">;
+        categoryId: z.ZodObject<{
+            key: z.ZodString;
+        }, z.core.$loose>;
+        filters: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            facet: z.ZodObject<{
+                key: z.ZodString;
+            }, z.core.$loose>;
+            key: z.ZodString;
+        }, z.core.$strip>>>;
+        position: z.ZodInt;
+    }, z.core.$loose>, z.ZodObject<{
+        type: z.ZodLiteral<"list">;
+        recommendationId: z.ZodOptional<z.ZodObject<{
+            key: z.ZodString;
+            algorithm: z.ZodString;
+        }, z.core.$loose>>;
+        carouselName: z.ZodString;
+        position: z.ZodInt;
+    }, z.core.$loose>, z.ZodObject<{
+        type: z.ZodLiteral<"associations">;
+        productId: z.ZodObject<{
+            key: z.ZodString;
+        }, z.core.$loose>;
+        kind: z.ZodEnum<{
+            related: "related";
+            "cross-sell": "cross-sell";
+            upsell: "upsell";
+            accessories: "accessories";
+        }>;
+        position: z.ZodInt;
+    }, z.core.$loose>, z.ZodObject<{
+        type: z.ZodLiteral<"product-list">;
+        listId: z.ZodObject<{
+            listType: z.ZodEnum<{
+                favorite: "favorite";
+                wish: "wish";
+                requisition: "requisition";
+                shopping: "shopping";
+            }>;
+            key: z.ZodString;
+            user: z.ZodOptional<z.ZodObject<{
+                userId: z.ZodString;
+            }, z.core.$loose>>;
+        }, z.core.$loose>;
+        position: z.ZodInt;
+    }, z.core.$loose>, z.ZodObject<{
+        type: z.ZodLiteral<"promotion">;
+        promotionId: z.ZodObject<{
+            key: z.ZodString;
+        }, z.core.$loose>;
+        slot: z.ZodString;
+    }, z.core.$loose>, z.ZodObject<{
+        type: z.ZodLiteral<"content">;
+        contentId: z.ZodString;
+        slot: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>, z.ZodObject<{
+        type: z.ZodLiteral<"cart">;
+        kind: z.ZodOptional<z.ZodEnum<{
+            upsell: "upsell";
+            page: "page";
+            "mini-cart": "mini-cart";
+        }>>;
+    }, z.core.$loose>, z.ZodObject<{
+        type: z.ZodLiteral<"order">;
+        orderId: z.ZodObject<{
+            key: z.ZodString;
+        }, z.core.$loose>;
+    }, z.core.$loose>, z.ZodObject<{
+        type: z.ZodLiteral<"quick-order">;
+        kind: z.ZodOptional<z.ZodEnum<{
+            "sku-entry": "sku-entry";
+            csv: "csv";
+            scan: "scan";
+        }>>;
+    }, z.core.$loose>, z.ZodObject<{
+        type: z.ZodLiteral<"pdp">;
+        readonly upstream: z.ZodOptional<z.ZodType<import("./origin.model.js").Origin>>;
+    }, z.core.$loose>, z.ZodObject<{
+        type: z.ZodLiteral<"direct">;
+    }, z.core.$loose>], "type">>;
+    properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    context: z.ZodObject<{
+        marketingIdentifier: z.ZodObject<{
+            key: z.ZodString;
+        }, z.core.$loose>;
+        identity: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            type: z.ZodLiteral<"Anonymous">;
+        }, z.core.$loose>, z.ZodObject<{
+            id: z.ZodObject<{
+                userId: z.ZodString;
+            }, z.core.$loose>;
+            type: z.ZodLiteral<"Guest">;
+        }, z.core.$loose>, z.ZodObject<{
+            id: z.ZodObject<{
+                userId: z.ZodString;
+            }, z.core.$loose>;
+            type: z.ZodLiteral<"Registered">;
+        }, z.core.$loose>], "type">;
+        locale: z.ZodString;
+        currency: z.ZodEnum<{
+            AED: "AED";
+            AFN: "AFN";
+            ALL: "ALL";
+            AMD: "AMD";
+            ANG: "ANG";
+            AOA: "AOA";
+            ARS: "ARS";
+            AUD: "AUD";
+            AWG: "AWG";
+            AZN: "AZN";
+            BAM: "BAM";
+            BBD: "BBD";
+            BDT: "BDT";
+            BGN: "BGN";
+            BHD: "BHD";
+            BIF: "BIF";
+            BMD: "BMD";
+            BND: "BND";
+            BOB: "BOB";
+            BOV: "BOV";
+            BRL: "BRL";
+            BSD: "BSD";
+            BTN: "BTN";
+            BWP: "BWP";
+            BYN: "BYN";
+            BZD: "BZD";
+            CAD: "CAD";
+            CDF: "CDF";
+            CHE: "CHE";
+            CHF: "CHF";
+            CHW: "CHW";
+            CLF: "CLF";
+            CLP: "CLP";
+            CNY: "CNY";
+            COP: "COP";
+            COU: "COU";
+            CRC: "CRC";
+            CUC: "CUC";
+            CUP: "CUP";
+            CVE: "CVE";
+            CZK: "CZK";
+            DJF: "DJF";
+            DKK: "DKK";
+            DOP: "DOP";
+            DZD: "DZD";
+            EGP: "EGP";
+            ERN: "ERN";
+            ETB: "ETB";
+            EUR: "EUR";
+            FJD: "FJD";
+            FKP: "FKP";
+            GBP: "GBP";
+            GEL: "GEL";
+            GHS: "GHS";
+            GIP: "GIP";
+            GMD: "GMD";
+            GNF: "GNF";
+            GTQ: "GTQ";
+            GYD: "GYD";
+            HKD: "HKD";
+            HNL: "HNL";
+            HRK: "HRK";
+            HTG: "HTG";
+            HUF: "HUF";
+            IDR: "IDR";
+            ILS: "ILS";
+            INR: "INR";
+            IQD: "IQD";
+            IRR: "IRR";
+            ISK: "ISK";
+            JMD: "JMD";
+            JOD: "JOD";
+            JPY: "JPY";
+            KES: "KES";
+            KGS: "KGS";
+            KHR: "KHR";
+            KMF: "KMF";
+            KPW: "KPW";
+            KRW: "KRW";
+            KWD: "KWD";
+            KYD: "KYD";
+            KZT: "KZT";
+            LAK: "LAK";
+            LBP: "LBP";
+            LKR: "LKR";
+            LRD: "LRD";
+            LSL: "LSL";
+            LYD: "LYD";
+            MAD: "MAD";
+            MDL: "MDL";
+            MGA: "MGA";
+            MKD: "MKD";
+            MMK: "MMK";
+            MNT: "MNT";
+            MOP: "MOP";
+            MRU: "MRU";
+            MUR: "MUR";
+            MVR: "MVR";
+            MWK: "MWK";
+            MXN: "MXN";
+            MXV: "MXV";
+            MYR: "MYR";
+            MZN: "MZN";
+            NAD: "NAD";
+            NGN: "NGN";
+            NIO: "NIO";
+            NOK: "NOK";
+            NPR: "NPR";
+            NZD: "NZD";
+            OMR: "OMR";
+            PAB: "PAB";
+            PEN: "PEN";
+            PGK: "PGK";
+            PHP: "PHP";
+            PKR: "PKR";
+            PLN: "PLN";
+            PYG: "PYG";
+            QAR: "QAR";
+            RON: "RON";
+            RSD: "RSD";
+            RUB: "RUB";
+            RWF: "RWF";
+            SAR: "SAR";
+            SBD: "SBD";
+            SCR: "SCR";
+            SDG: "SDG";
+            SEK: "SEK";
+            SGD: "SGD";
+            SHP: "SHP";
+            SLE: "SLE";
+            SLL: "SLL";
+            SOS: "SOS";
+            SRD: "SRD";
+            SSP: "SSP";
+            STN: "STN";
+            SYP: "SYP";
+            SZL: "SZL";
+            THB: "THB";
+            TJS: "TJS";
+            TMT: "TMT";
+            TND: "TND";
+            TOP: "TOP";
+            TRY: "TRY";
+            TTD: "TTD";
+            TVD: "TVD";
+            TWD: "TWD";
+            TZS: "TZS";
+            UAH: "UAH";
+            UGX: "UGX";
+            USD: "USD";
+            USN: "USN";
+            UYI: "UYI";
+            UYU: "UYU";
+            UYW: "UYW";
+            UZS: "UZS";
+            VED: "VED";
+            VES: "VES";
+            VND: "VND";
+            VUV: "VUV";
+            WST: "WST";
+            XAF: "XAF";
+            XAG: "XAG";
+            XAU: "XAU";
+            XBA: "XBA";
+            XBB: "XBB";
+            XBC: "XBC";
+            XBD: "XBD";
+            XCD: "XCD";
+            XDR: "XDR";
+            XOF: "XOF";
+            XPD: "XPD";
+            XPF: "XPF";
+            XPT: "XPT";
+            XSU: "XSU";
+            XTS: "XTS";
+            XUA: "XUA";
+            XXX: "XXX";
+            YER: "YER";
+            ZAR: "ZAR";
+            ZMW: "ZMW";
+            ZWL: "ZWL";
+        }>;
+        consent: z.ZodOptional<z.ZodObject<{
+            analytics: z.ZodBoolean;
+            marketing: z.ZodBoolean;
+        }, z.core.$loose>>;
+        page: z.ZodOptional<z.ZodObject<{
+            url: z.ZodOptional<z.ZodString>;
+            title: z.ZodOptional<z.ZodString>;
+            referrer: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>>;
+        userAgent: z.ZodOptional<z.ZodString>;
+        clientIp: z.ZodOptional<z.ZodString>;
+        isBot: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$loose>;
+}, z.core.$loose>;
+export declare const AnalyticsEventResultSchema: z.ZodObject<{
+    eventId: z.ZodString;
+}, z.core.$loose>;
+export type AnalyticsPage = InferType<typeof AnalyticsPageSchema>;
+export type EventContextSnapshot = InferType<typeof EventContextSnapshotSchema>;
+export type AnalyticsEventEnvelope = InferType<typeof AnalyticsEventEnvelopeSchema>;
+export type AnalyticsEventResult = InferType<typeof AnalyticsEventResultSchema>;