@thryveai/theme-interfaces 2.3.15 → 2.3.16

package/dist/interfaces/icons.interfaces.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IconNamesToFiles = void 0;
+exports.IconNamesToFiles = {
+    AccountOutline: "account-outline",
+    AccountSolid: "account-solid",
+    Addresses: "addresses",
+    ArrowDown: "arrow-down",
+    ArrowRight: "arrow-right",
+    ArrowUpdown: "arrow-updown",
+    BarScan: "bar-scan",
+    Bell: "bell",
+    Blog: "blog",
+    Cart: "cart",
+    Check: "check",
+    ChevronDown: "chevron-down",
+    ChevronLeft: "chevron-left",
+    ChevronRight: "chevron-right",
+    ChevronUp: "chevron-up",
+    Circular: "circular",
+    Clear: "clear",
+    Close: "close",
+    Coupon: "coupon",
+    Dashboard: "dashboard",
+    DeliveryOutline: "delivery-outline",
+    DeliverySolid: "delivery-solid",
+    Dietary: "dietary",
+    DoubleArrows: "double-arrows",
+    Download: "download",
+    Dropship: "dropship",
+    Eco: "eco",
+    Edit: "edit",
+    Error: "error",
+    FaceHappy: "face-happy",
+    FaceSad: "face-sad",
+    Facebook: "facebook",
+    Fav: "fav",
+    FavSolid: "fav-solid",
+    Filter: "filter",
+    Flag: "flag",
+    Geolocate: "geolocate",
+    Hamburger: "hamburger",
+    Help: "help",
+    Home: "home",
+    Info: "info",
+    Instacart: "instacart",
+    Instagram: "instagram",
+    ItemLocation: "item-location",
+    ListCheck: "list-check",
+    ListItems: "list-items",
+    ListLarge: "list-large",
+    ListRemove: "list-remove",
+    ListSave: "list-save",
+    ListSearch: "list-search",
+    LocationPin: "location-pin",
+    LocationDistance: "location-distance",
+    LoyaltyCard: "loyaltycard",
+    Mail: "mail",
+    Minus: "minus",
+    MoreOptionsH: "more-options-h",
+    MoreOptionsV: "more-options-v",
+    Note: "note",
+    Notifications: "notifications",
+    NoteFilled: "note-filled",
+    Orders: "orders",
+    PastPurchases: "past-purchases",
+    Pause: "pause",
+    PaymentOutline: "payment-outline",
+    PaymentSolid: "payment-solid",
+    Phone: "phone",
+    PhoneMobile: "phone-mobile",
+    Pickup: "pickup",
+    PickupInfo: "pickup-info",
+    Pinterest: "pinterest",
+    Plus: "plus",
+    Print: "print",
+    PromoOutline: "promo-outline",
+    PromoSolid: "promo-solid",
+    RadioActive: "radio-active",
+    RadioEmpty: "radio-empty",
+    RecipeCalories: "recipe-calories",
+    RecipeCooktime: "recipe-cooktime",
+    RecipeIngredients: "recipe-ingredients",
+    RecipePreptime: "recipe-preptime",
+    RecipeServings: "recipe-servings",
+    Remove: "remove",
+    Reserve: "reserve",
+    ReserveTime: "reserve-time",
+    Search: "search",
+    SelectCheck: "select-check",
+    SelectEmpty: "select-empty",
+    SelectMark: "select-mark",
+    Send: "send",
+    Settings: "settings",
+    Share: "share",
+    SortGrid: "sort-grid",
+    SortList: "sort-list",
+    StarOutline: "star-outline",
+    StarSolid: "star-solid",
+    Substitute: "subtitute",
+    SubstituteBestmatch: "subtitute-bestmatch",
+    SubstituteNone: "subtitute-none",
+    SubstituteProduct: "subtitute-product",
+    Trash: "trash",
+    Twitter: "twitter",
+    Unavailable: "unavailable",
+    Voice: "voice",
+    Warning: "warning",
+    Youtube: "youtube",
+    YourLocation: "your-location",
+    GlutenFree: "Gluten-Free",
+    Local: "Local",
+    Organic: "Organic",
+    None: "None",
+    VisaLogo: "visa-logo",
+    MasterLogo: "master-card-logo",
+    VisaCard: "visa-card",
+    MasterCard: "master-card-card",
+    AmExpCard: "american-express-card",
+    DiscoverCard: "discover-card",
+    VisaVerified: "visa-verified",
+    MasterSecure: "master-card-secure",
+    Comodo: "comodo",
+};

package/dist/interfaces/retailer-settings.interfaces.d.ts

@@ -0,0 +1,371 @@
+import { IconNames, PaymentCards } from "./icons.interfaces";
+export interface IRetailerSettings {
+    accountPage?: IAccountPageSettings;
+    additionalCharges?: boolean;
+    addresses?: {
+        addressValidationTypes?: IAddressValidationTypes;
+        canadianAddressCompleteKey?: string | undefined;
+        eircodeUrl?: string | null;
+        integration?: {
+            addNewAddressUrl: string | undefined;
+            editAddressUrl: string | undefined;
+            deleteAddressUrl: string | undefined;
+        };
+        useAddressValidation?: boolean;
+    };
+    TimeslotModalSettings?: ITimeslotModalSettings;
+    addressValidationTypes?: IAddressValidationTypes;
+    advertSettings?: IAdvertSettings;
+    allowInStorePurchases?: boolean;
+    allowPastPurchases?: boolean;
+    buildNumber: string;
+    cacheTimeMins?: number;
+    canadianAddressCompleteKey?: string | undefined;
+    checkout?: IGlobalCheckoutProps;
+    checkoutV1?: boolean;
+    checkoutValidation?: ICheckoutValidation;
+    ctaButtons?: ICtaButtons;
+    daysToRemainSignedIn?: number;
+    defaultCountry?: IDefaultCounty;
+    defaultSearchParams?: IDefaultSearchParams;
+    defaultShoppingMode?: "pickup" | "planning" | "delivery";
+    defaultStoreLocation?: IDefaultStoreLocation;
+    disableTprPrice?: boolean;
+    documentTitle?: string;
+    eircode?: string | null;
+    enable3dSecure?: boolean;
+    enableGoogleTranslate?: boolean;
+    enableNewsletterSignup?: boolean;
+    enableNotifications?: boolean;
+    errorLoggingLevel?: ILoggingLevel;
+    externalApps?: IExternalApps;
+    externalStoreSelectorUrl?: string | undefined;
+    favoritesV1?: boolean;
+    featureSwitch?: IFeatureSwitch;
+    flipp?: IFlippConfig | IFlippConfigV2 | null;
+    globalAnimations?: IGlobalAnimations;
+    googleAutocompleteSettings?: IGoogleAutocompleteSettings;
+    gtmId?: undefined | string;
+    hideTaxOnSummary?: boolean;
+    houseAccountRegExValidation?: string;
+    idpTarget?: "_self" | "_blank";
+    idpUrl?: undefined | string;
+    instacartUrl?: string | undefined;
+    isPlanningOnly?: boolean;
+    layout?: ILayoutSettings;
+    layouts?: IGlobalLayouts;
+    limitProductCardTitleHeight?: boolean;
+    loggingLevelClient?: ILoggingLevel;
+    loggingLevelServer?: ILoggingLevel;
+    mainHeaderHeight?: number;
+    mapZoom?: number;
+    minimumCreditCardAmount?: number;
+    nutritionZone?: INutritionZone;
+    paymentCards?: IPaymentCards;
+    pdpDetailsLayout?: IProductDetailsPageLayout;
+    productCardTitleHeight?: number;
+    productCards?: IProductCardsProps;
+    productCardv2?: boolean;
+    promoTemplateVersion?: number;
+    registrationFields?: IRegistrationField[];
+    restrictMapPlacesResults?: IRestrictMapPlaces;
+    retailerCountry?: IRetailerCountry;
+    retailerName: string;
+    searchPreview?: ISearchPreviewVisibility;
+    secondTierAuthorization?: ISecondTierAuthorization;
+    showCheckoutPromoCode?: boolean;
+    showImgOnOrder?: boolean;
+    siteSettings?: ISiteSettings;
+    smartBanner?: ISmartBanner;
+    entryModalVersion?: IEntryModalVersion;
+    smsNotifications?: ISMSConfig;
+    sodiumWarning?: ISodiumWarning;
+    specialRequestItems?: boolean;
+    subHeaderHeight?: number;
+    useAddressValidation?: boolean;
+}
+export interface IFeatureSwitch {
+    additionalCharges: boolean;
+    clientCache: boolean;
+    vouchers: IVouchers;
+    giftCards: IGiftCards;
+    smartbanner: ISmartBanner;
+    entryModalVersion: IEntryModalVersion;
+    addressIntegration: IAddressIntegration;
+}
+export interface ISiteSettings {
+    anonymousCart: boolean;
+}
+export interface IVouchers {
+    enabled: boolean;
+    reCaptcha: boolean;
+}
+export interface IGiftCards {
+    enabled: boolean;
+    gitfCardInputValidation: string;
+    pinInputValidation: string;
+    reCaptcha: boolean;
+}
+export declare type IEntryModalVersion = "entry" | "geolocation";
+export interface ISmartBanner {
+    enabled: boolean;
+    title: string;
+    author: string;
+    price: string;
+    priceSuffixApple: string;
+    priceSuffixGoogle: string;
+    iconApple: string;
+    iconGoogle: string;
+    button: string;
+    buttonUrlApple: string;
+    buttonUrlGoogle: string;
+    closeLabel: string;
+}
+export interface IGlobalLayouts {
+    cartSummary: ICartSummaryLayout;
+    couponGallery: ICouponGalleryLayout;
+}
+export interface ICouponGalleryLayout {
+    enabled: boolean;
+    galleryIsIframe: boolean;
+}
+export interface ICartSummaryLayout {
+    showTaxTotal: boolean;
+    showTaxGroups: boolean;
+}
+export interface IExternalApps {
+    sts?: IExternalAppSTS;
+}
+export interface IExternalAppSTS {
+    customTermPolicy?: string;
+}
+export interface ISecondTierAuthorization {
+    time: undefined | null | number;
+    pages: string[];
+}
+export interface IFlippConfig {
+    version: 1;
+    production: boolean;
+    scriptUrl: IFlippScriptUrls;
+    retailer: "wakefernpricerite" | "saveonfoods" | "unitedsupermarkets" | "dearbornmarket" | "saveonfoods";
+    autoLocate: boolean;
+    useRequestedDomain: boolean;
+}
+export interface IFlippConfigV2 {
+    version: 2;
+    retailer: string;
+    merchantId: string;
+    accessToken: string;
+}
+export declare type IFlippScriptUrls = "circulars.priceritemarketplace" | "circulars.dearbornmarket" | "flyers.v8.commerce.mi9cloud" | "flyers.stg.v8.mywebgrocer" | "flyers.saveonfoods";
+export declare type IAllSettings = {
+    [envName in IEnvNames]: IRetailerSettings;
+};
+export interface ISMSConfig {
+    enabled: boolean;
+    getEnrollmentUrl: string;
+    postEnrollmentUrl: string;
+}
+export interface IPageAdvertsRow {
+    [row: number]: IAdvertsData;
+}
+export declare type IScreenType = "mobile" | "tablet" | "desktop";
+export interface ITimeslotModalSettings {
+    showOnAddToCart: boolean;
+    timeslotRequiredToAddToCart: boolean;
+    timeslotRequiredToViewCartReview: boolean;
+}
+export declare type IAdvertsData = {
+    [screen in IScreenType]?: string;
+};
+export declare type IAdvertSettings = {
+    page_homepage?: IAdvertLeaderboards;
+    page_search?: IAdvertLeaderboards & IAdvertProductGrid & IAdvertSkyScrapers;
+    page_cart?: IAdvertLeaderboards & IAdvertSkyScrapers;
+    "page_product-categories"?: IAdvertLeaderboards & IAdvertProductGrid & IAdvertSkyScrapers;
+    "page_product-listing"?: IAdvertLeaderboards & IAdvertProductGrid & IAdvertSkyScrapers;
+};
+export declare type IPageNamesForAdverts = {
+    [key in keyof IAdvertSettings]: string;
+};
+export interface IAdvertLeaderboards {
+    leaderboards?: IPageAdvertsRow;
+}
+export interface IAdvertProductGrid {
+    productGrid?: {
+        leaderboards?: IPageAdvertsRow;
+        productCardBanners?: IPageAdvertsRow;
+    };
+}
+export interface IAdvertSkyScrapers {
+    skyscrapers?: IAdvertsData;
+}
+export interface IGoogleAutocompleteSettings {
+    types?: IGoogleAutocompleteTypes;
+    bounds?: IGoogleAutocompleteBounds;
+    strictBounds?: boolean;
+    restrictCountries?: string[];
+}
+export interface IGoogleAutocompleteBounds {
+    east_longitude: number;
+    north_latitude: number;
+    south_latitude: number;
+    west_longitude: number;
+}
+export declare type IGoogleAutocompleteTypes = "geocode" | "address" | "establishment" | "(regions)" | "(cities)";
+export interface ICtaButtons {
+    iconAlignment: "left" | "right" | null;
+    iconName: IconNames;
+}
+export interface ISodiumWarning {
+    isEnabled: boolean;
+    threshold: number;
+}
+export interface IAddressesSettings {
+    addressValidationTypes: IAddressValidationTypes;
+    canadianAddressCompleteKey: string | undefined;
+    eircodeUrl: string | undefined;
+    integration: {
+        addNewAddressUrl: string | undefined;
+        editAddressUrl: string | undefined;
+        deleteAddressUrl: string | undefined;
+    };
+    useAddressValidation: boolean;
+}
+export interface IAccountPageSettings {
+    loyaltyTab: {
+        disabledEdit?: boolean;
+        enabled: boolean;
+        loyaltyNumberLength: number;
+        loyaltyNumberPrefix: string;
+        loyaltyValidationType: IValidationType[];
+    };
+}
+export interface ILayoutSettings {
+    footerVersion: IFooterTypes;
+}
+export declare type ILoggingLevel = "error" | "warning" | "info" | "debug";
+export interface IAddressValidationTypes {
+    addressLine1: IValidationType[];
+    addressLine2: IValidationType[];
+    city: IValidationType[];
+    countyProvinceState: IValidationType[];
+    familyName: IValidationType[];
+    firstName: IValidationType[];
+    instructions: IValidationType[];
+    phoneNumber: IValidationType[];
+    postCode: IValidationType[];
+}
+export interface IDefaultSearchParams {
+    q: string;
+    page: string;
+    skip: string;
+    take: string;
+}
+export interface IDefaultStoreLocation {
+    latitude: number;
+    longitude: number;
+}
+export declare type IDefaultCounty = "USA" | "Canada" | "Ireland" | "Australia" | string;
+export declare type IRetailerCountry = "us" | "ca" | "ie" | "au";
+export interface IRestrictMapPlaces {
+    country?: string | string[];
+    postalCode?: string;
+    route?: string;
+    locality?: string;
+    administrativeArea?: string;
+    fetchNearStoresSettings?: {
+        kmRange: number;
+        totalTake: number;
+    };
+}
+export declare type IValidationType = IValidateDateRange | IValidateLength | IValidateMultipleLengths | "alphaNumeric" | "alphaOnly" | "anyPhone" | "auPhone" | "auPostCode" | "auState" | "caPhone" | "caPostCode" | "caProvince" | "correctDate" | "email" | "ieCounty" | "iePhone" | "iePostCode" | "luhnValidation" | "noSpecialChar" | "numericOnly" | "password" | "required" | "usMobileNumber" | "usPhone" | "usPhone10Digits" | "usPostCode" | "usState" | "notWhiteSpacesOnly";
+export declare type IEnvNames = "dev" | "de2" | "qat" | "qa2" | "int" | "in2" | "lod" | "lo2" | "stg" | "st2" | "stagingConfig" | "productionConfig";
+export declare type INutritionZone = "us" | "eu" | "au" | "ca";
+export declare type IFooterTypes = "default" | "version2" | "version3" | "version4" | "version5";
+export declare type IValidateLength = {
+    _type: "less" | "more" | "exact";
+    length: number;
+};
+export declare type IValidateMultipleLengths = {
+    _type: "multi";
+    multiLength: number[];
+};
+export declare type IValidateDateRange = {
+    _type: "overYears";
+    overYears: number;
+};
+export declare type IRegistrationFieldTypes = "default" | "version2";
+export declare type IRegistrationFieldNames = "phone" | "loyaltyId" | "isAdultConfirmed" | "marketingConsent" | "dateOfBirth";
+export interface IRegistrationField {
+    name: IRegistrationFieldNames;
+    label: string;
+    placeholder: string;
+    designVersion: IRegistrationFieldTypes;
+    validationTypes: IValidationType[];
+}
+export interface ICheckoutValidation {
+    instructions: IValidationType[];
+    phoneNumber: IValidationType[];
+    smsNumber: IValidationType[];
+}
+export interface ISearchPreview {
+    suggestions: boolean;
+    products: boolean;
+}
+export interface ISearchPreviewVisibility {
+    desktop?: ISearchPreview;
+    mobile?: ISearchPreview;
+}
+export declare type IPaymentCards = {
+    [cardName in PaymentCards]: boolean;
+};
+export interface IGlobalAnimations {
+    confetti: ILayoutAnimationsConfetti;
+}
+export interface ILayoutAnimationsConfetti {
+    enableConfettiAnimation: boolean;
+}
+export interface IGlobalCheckoutProps {
+    numericPhonePayload: boolean;
+}
+export interface IAddressIntegration {
+    enabled: boolean;
+    addressFinderType: IAddressFinderType;
+    useForNewAddresses: boolean;
+}
+export declare type IAddressFinderType = "AUS" | "EU" | "IE" | "US" | "UK" | "CA";
+export interface IProductCardsProps {
+    gridRowLength: {
+        [key in IScreenType]: number;
+    };
+    carouselsRowLength: {
+        [key in IScreenType]: number;
+    };
+    productCard: {
+        enabled: boolean;
+        layouts: IProductCardLayouts;
+    };
+}
+export declare type IProductCardLayouts = {
+    ContainersGrid: "default";
+    ContainersCarousel: "default";
+};
+export declare type IProductCardLayoutObjects<T> = {
+    [Place in keyof IProductCardLayouts]: {
+        [key in IProductCardLayouts[Place]]: T;
+    };
+};
+export declare type IProductCardILayoutTypes = keyof IProductCardLayouts;
+export declare type IProductCardILayoutVersions = IProductCardLayouts[IProductCardILayoutTypes];
+export interface IProductDetailsPageLayout {
+    desktop: {
+        left: PdpDetailsElementLayout[];
+        right: PdpDetailsElementLayout[];
+    };
+    mobile: {
+        left: PdpDetailsElementLayout[];
+        right: PdpDetailsElementLayout[];
+    };
+}
+export declare type PdpDetailsElementLayout = "productNutrition" | "productIngredients" | "productDescription" | "sodiumWarning" | "productNumber" | "recommendations" | "productSalesInfo" | string;

package/dist/interfaces/retailer-settings.interfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/sts-settings.interfaces.d.ts

@@ -0,0 +1,6 @@
+export interface IDefaultStsSettings {
+    customTermPolicy: string;
+    gtmId: string;
+    hasEUTerms: boolean;
+    hasTwoStepRegistration: boolean;
+}

package/dist/interfaces/sts-settings.interfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });