@thryveai/theme-interfaces 1.4.13 → 1.5.0

package/src/interfaces/retailer-settings.interfaces.ts

@@ -1,460 +0,0 @@
-import { IconNames, PaymentCards } from './icons.interfaces';
-
-export interface IRetailerSettings {
-  accountPage?: IAccountPageSettings;
-  advertSettings?: IAdvertSettings;
-  TimeslotModalSettings?: ITimeslotModalSettings;
-  addresses?: {
-    addressValidationTypes?: IAddressValidationTypes;
-    canadianAddressCompleteKey?: string | undefined;
-    eircodeUrl?: string | null;
-    integration?: {
-      addNewAddressUrl: string | undefined;
-      editAddressUrl: string | undefined;
-      deleteAddressUrl: string | undefined;
-    };
-    useAddressValidation?: boolean;
-  };
-  addressIntegration?: IAddressIntegration;
-  addressValidationTypes?: IAddressValidationTypes;
-  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;
-  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;
-  limitProductCardTitleHeight?: boolean;
-  loggingLevelClient?: ILoggingLevel;
-  loggingLevelServer?: ILoggingLevel;
-  mainHeaderHeight?: number;
-  mapZoom?: number;
-  minimumCreditCardAmount?: number;
-  nutritionZone?: INutritionZone;
-  paymentCards?: IPaymentCards;
-  pdpDetailsLayout?: IPdpDetailsLayout;
-  productCardTitleHeight?: number;
-  promoTemplateVersion?: number;
-  registrationFields?: IRegistrationField[];
-  restrictMapPlacesResults?: IRestrictMapPlaces;
-  retailerCountry?: IRetailerCountry;
-  retailerName: string;
-  searchPreview?: ISearchPreviewVisibility;
-  secondTierAuthorization?: ISecondTierAuthorization;
-  showCheckoutPromoCode?: boolean;
-  showImgOnOrder?: boolean;
-  smsNotifications?: ISMSConfig;
-  sodiumWarning?: boolean;
-  subHeaderHeight?: number;
-  useAddressValidation?: 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; // true
-  scriptUrl: IFlippScriptUrls; // 'flyers.stg.v8.mywebgrocer'
-  retailer:
-    | 'wakefernpricerite'
-    | 'saveonfoods'
-    | 'unitedsupermarkets'
-    | 'dearbornmarket'
-    | 'saveonfoods';
-  autoLocate: boolean; // false
-  useRequestedDomain: boolean; // true - will change in prod
-}
-
-export interface IFlippConfigV2 {
-  version: 2;
-  retailer: string;
-  merchantId: string;
-  accessToken: string;
-}
-
-export type IFlippScriptUrls =
-  | 'circulars.priceritemarketplace'
-  | 'circulars.dearbornmarket'
-  | 'flyers.v8.commerce.mi9cloud'
-  | 'flyers.stg.v8.mywebgrocer'
-  | 'flyers.saveonfoods';
-
-export type IAllSettings = {
-  [envName in IEnvNames]: IRetailerSettings;
-};
-
-export interface ISMSConfig {
-  enabled: boolean;
-  getEnrollmentUrl: string;
-  postEnrollmentUrl: string;
-}
-
-export interface IPageAdvertsRow {
-  [row: number]: IAdvertsData;
-}
-export type IScreenType = 'mobile' | 'tablet' | 'desktop';
-
-export interface ITimeslotModalSettings {
-  showOnAddToCart: boolean;
-  timeslotRequiredToAddToCart: boolean;
-  timeslotRequiredToViewCartReview: boolean;
-}
-
-export type IAdvertsData = {
-  [screen in IScreenType]?: string;
-};
-export 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 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 IDefaultRetailerSettings {
-  accountPage: IAccountPageSettings;
-  addressIntegration: IAddressIntegration;
-  addressValidationTypes: IAddressValidationTypes;
-  addresses: IAddressesSettings;
-  advertSettings: IAdvertSettings;
-  allowInStorePurchases: boolean;
-  allowPastPurchases: boolean;
-  buildNumber: string;
-  cacheTimeMins: number;
-  canadianAddressCompleteKey: string | undefined;
-  checkout: IGlobalCheckoutProps;
-  checkoutV1: boolean;
-  checkoutValidation: ICheckoutValidation;
-  ctaButtons: ICtaButtons | null | undefined;
-  daysToRemainSignedIn: number;
-  defaultCountry: IDefaultCounty;
-  defaultSearchParams: IDefaultSearchParams;
-  defaultShoppingMode: 'pickup' | 'planning' | 'delivery';
-  defaultStoreLocation: IDefaultStoreLocation;
-  disableTprPrice: boolean;
-  documentTitle: string;
-  eircode: string | undefined;
-  enable3dSecure: boolean;
-  enableGoogleTranslate: boolean;
-  enableNewsletterSignup: boolean;
-  enableNotifications: boolean;
-  errorLoggingLevel: ILoggingLevel;
-  externalStoreSelectorUrl: string | undefined;
-  favoritesV1: boolean;
-  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;
-  limitProductCardTitleHeight: boolean;
-  loggingLevelClient: ILoggingLevel;
-  loggingLevelServer: ILoggingLevel;
-  mainHeaderHeight: number;
-  mapZoom: number;
-  minimumCreditCardAmount: number;
-  nutritionZone: INutritionZone;
-  paymentCards: IPaymentCards;
-  pdpDetailsLayout: IPdpDetailsLayout;
-  productCardTitleHeight: number;
-  promoTemplateVersion: number;
-  registrationFields: IRegistrationField[];
-  restrictMapPlacesResults: IRestrictMapPlaces;
-  retailerCountry: IRetailerCountry;
-  retailerName: string;
-  searchPreview: ISearchPreviewVisibility;
-  secondTierAuthorization?: ISecondTierAuthorization;
-  showCheckoutPromoCode: boolean;
-  showImgOnOrder: boolean;
-  smsNotifications: ISMSConfig;
-  sodiumWarning: boolean;
-  subHeaderHeight: number;
-  timeslotModalSettings: ITimeslotModalSettings;
-  useAddressValidation: boolean;
-}
-
-export interface IGoogleAutocompleteSettings {
-  types?: IGoogleAutocompleteTypes;
-  bounds?: IGoogleAutocompleteBounds;
-  strictBounds?: boolean;
-  restrictCountries?: string[];
-}
-
-interface IGoogleAutocompleteBounds {
-  south_latitude: number;
-  west_longitude: number;
-  north_latitude: number;
-  east_longitude: number;
-}
-
-type IGoogleAutocompleteTypes =
-  | 'geocode'
-  | 'address'
-  | 'establishment'
-  | '(regions)'
-  | '(cities)';
-
-export interface ICtaButtons {
-  iconAlignment: 'left' | 'right' | null;
-  iconName: IconNames;
-}
-
-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 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 type IDefaultCounty =
-  | 'USA'
-  | 'Canada'
-  | 'Ireland'
-  | 'Australia'
-  | string;
-
-export 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 type IValidationType =
-  | IValidateDateRange
-  | IValidateLength
-  | 'luhnValidation'
-  | 'alphaNumeric'
-  | 'alphaOnly'
-  | 'numericOnly'
-  | 'anyPhone'
-  | 'email'
-  | 'password'
-  | 'required'
-  | 'usPhone'
-  | 'usPhone10Digits'
-  | 'usMobileNumber'
-  | 'caPhone'
-  | 'auPhone'
-  | 'iePhone'
-  | 'caProvince'
-  | 'usState'
-  | 'auState'
-  | 'ieCounty'
-  | 'caPostCode'
-  | 'usPostCode'
-  | 'auPostCode'
-  | 'iePostCode'
-  | 'noSpecialChar'
-  | 'correctDate';
-
-// 'stagingConfig' & 'productionConfig' are for backwards compatibility.
-type IEnvNames =
-  | 'dev'
-  | 'de2'
-  | 'qat'
-  | 'qa2'
-  | 'int'
-  | 'in2'
-  | 'lod'
-  | 'lo2'
-  | 'stg'
-  | 'st2'
-  | 'stagingConfig'
-  | 'productionConfig';
-
-export type INutritionZone = 'us' | 'eu' | 'au' | 'ca';
-export type IFooterTypes =
-  | 'default'
-  | 'version2'
-  | 'version3'
-  | 'version4'
-  | 'version5';
-
-export type IValidateLength = {
-  _type: 'less' | 'more' | 'exact';
-  length: number;
-};
-export type IValidateDateRange = {
-  _type: 'overYears';
-  overYears: number;
-};
-
-export type IRegistrationFieldTypes = 'default' | 'version2';
-
-export 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[];
-}
-
-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;
-  getAddressesUrl: string;
-  getLocationUrl: string;
-  addressFinderType: IAddressFinderType;
-}
-
-export type IAddressFinderType = 'AUS' | 'EU' | 'IE' | 'US' | 'UK' | 'CA';
-
-export interface IPdpDetailsLayout {
-  desktop: string[];
-  mobileTab1: string[];
-  mobileTab2: string[];
-}