@thryveai/theme-interfaces 1.5.23 → 1.5.24-beta3

package/default.config.js

@@ -0,0 +1,215 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var defaultConfig = {
+    adminPanelOnly: {
+        bannerName: "Wynshop New Retailer",
+        logoUrl: "https://wynshop.com/wp-content/uploads/2021/08/xWynshop_Font_logo_150x39.png.pagespeed.ic.3j0jIxPBvP.webp 1x",
+    },
+    advertSettings: {},
+    timeslotModalSettings: {
+        showOnAddToCart: false,
+        timeslotRequiredToAddToCart: false,
+        timeslotRequiredToViewCartReview: false,
+    },
+    accountPage: {
+        loyaltyTab: {
+            disabledEdit: false,
+            enabled: false,
+            loyaltyNumberLength: 11,
+            loyaltyNumberPrefix: "",
+            loyaltyValidationType: [],
+        },
+    },
+    additionalCharges: false,
+    addresses: {
+        addressValidationTypes: {
+            addressLine1: ["alphaNumeric", "required"],
+            addressLine2: ["alphaNumeric"],
+            city: ["alphaNumeric", "required"],
+            countyProvinceState: ["usState", "required"],
+            familyName: ["alphaOnly", "required"],
+            firstName: ["alphaOnly", "required"],
+            instructions: ["alphaNumeric"],
+            phoneNumber: ["usPhone", "required"],
+            postCode: ["usPostCode", "required"],
+        },
+        canadianAddressCompleteKey: undefined,
+        eircodeUrl: undefined,
+        integration: {
+            addNewAddressUrl: undefined,
+            deleteAddressUrl: undefined,
+            editAddressUrl: undefined,
+        },
+        useAddressValidation: true,
+    },
+    addressValidationTypes: {
+        addressLine1: ["alphaNumeric", "required"],
+        addressLine2: ["alphaNumeric"],
+        city: ["alphaNumeric", "required"],
+        countyProvinceState: ["usState", "required"],
+        familyName: ["alphaOnly", "required"],
+        firstName: ["alphaOnly", "required"],
+        instructions: ["alphaNumeric"],
+        phoneNumber: ["usPhone", "required"],
+        postCode: ["usPostCode", "required"],
+    },
+    addressIntegration: {
+        enabled: false,
+        addressFinderType: "AUS",
+        getAddressesUrl: "https://api.addressfinder.io/api/au/address/autocomplete/?key={AUS_ADDRESS_SERVICE_KEY}&secret={AUS_ADDRESS_SERVICE_SECRET}&q={searchQuery}&format=json&gnaf=1",
+        getLocationUrl: "https://api.addressfinder.io/api/au/address/metadata/?key={AUS_ADDRESS_SERVICE_KEY}&secret={AUS_ADDRESS_SERVICE_SECRET}&format=json&id={id}&au_paf=0&gps=0",
+    },
+    allowInStorePurchases: false,
+    allowPastPurchases: true,
+    buildNumber: "default",
+    cacheTimeMins: 1,
+    canadianAddressCompleteKey: undefined,
+    checkoutV1: false,
+    favoritesV1: false,
+    checkout: {
+        numericPhonePayload: false,
+    },
+    checkoutValidation: {
+        instructions: ["alphaNumeric"],
+        phoneNumber: ["usPhone", "required"],
+        smsNumber: [],
+    },
+    ctaButtons: null,
+    defaultCountry: "USA",
+    defaultSearchParams: {
+        page: "1",
+        q: "*",
+        skip: "0",
+        take: "30",
+    },
+    defaultShoppingMode: "pickup",
+    defaultStoreLocation: {
+        latitude: 0,
+        longitude: 0,
+    },
+    disableAddressOnDelivery: false,
+    disableTprPrice: false,
+    documentTitle: "ThryveAI Commerce",
+    eircode: undefined,
+    enable3dSecure: false,
+    enableGoogleTranslate: false,
+    enableNewsletterSignup: false,
+    enableNotifications: false,
+    enableVouchers: false,
+    errorLoggingLevel: "error",
+    externalStoreSelectorUrl: undefined,
+    features: { clientCache: false },
+    flipp: null,
+    gtmId: undefined,
+    hideTaxOnSummary: false,
+    houseAccountRegExValidation: ".",
+    idpTarget: "_self",
+    idpUrl: undefined,
+    instacartUrl: undefined,
+    isPlanningOnly: false,
+    layout: {
+        footerVersion: "default",
+    },
+    limitProductCardTitleHeight: true,
+    loggingLevelClient: "error",
+    loggingLevelServer: "error",
+    mainHeaderHeight: 110,
+    mapZoom: 8,
+    minimumCreditCardAmount: 1.0,
+    nutritionZone: "us",
+    paymentCards: {
+        AmExpCard: true,
+        DiscoverCard: true,
+        MasterCard: true,
+        VisaCard: true,
+    },
+    pdpDetailsLayout: {
+        desktop: { left: [], right: [] },
+        mobile: { left: [], right: [] },
+    },
+    productCardTitleHeight: 40,
+    registrationFields: [],
+    retailerCountry: "us",
+    retailerName: "default",
+    daysToRemainSignedIn: 30,
+    searchPreview: {
+        desktop: {
+            products: true,
+            suggestions: true,
+        },
+        mobile: {
+            products: true,
+            suggestions: true,
+        },
+    },
+    secondTierAuthorization: undefined,
+    showCheckoutPromoCode: true,
+    showImgOnOrder: false,
+    smsNotifications: {
+        enabled: false,
+        getEnrollmentUrl: "",
+        postEnrollmentUrl: "",
+    },
+    subHeaderHeight: 0,
+    promoTemplateVersion: 1,
+    useAddressValidation: true,
+    restrictMapPlacesResults: {
+        fetchNearStoresSettings: {
+            kmRange: 20,
+            totalTake: 30,
+        },
+    },
+    globalAnimations: {
+        confetti: {
+            enableConfettiAnimation: true,
+        },
+    },
+    googleAutocompleteSettings: {},
+    productCardv2: false,
+    productCards: {
+        gridRowLength: {
+            desktop: 5,
+            tablet: 3,
+            mobile: 1,
+        },
+        carouselsRowLength: {
+            desktop: 6,
+            tablet: 4,
+            mobile: 1,
+        },
+        productCard: {
+            enabled: false,
+            layouts: {
+                ContainersGrid: "default",
+                ContainersCarousel: "default",
+            },
+        },
+    },
+    sodiumWarning: {
+        isEnabled: false,
+        threshold: 2300,
+    },
+    specialRequestItems: false,
+    smartbanner: {
+        enabled: false,
+        author: "",
+        button: "",
+        buttonUrlApple: "",
+        buttonUrlGoogle: "",
+        closeLabel: "",
+        iconApple: "",
+        iconGoogle: "",
+        price: "",
+        priceSuffixApple: "",
+        priceSuffixGoogle: "",
+        title: "",
+    },
+    layouts: {
+        cartSummary: {
+            showTaxTotal: true,
+            showTaxGroups: true,
+        },
+        couponGallery: { enabled: false, galleryIsIframe: false },
+    },
+};
+exports.default = defaultConfig;

package/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/index.d.ts

@@ -2,6 +2,11 @@ import { IRetailerSettings, ISecondTierAuthorization, IFlippConfig, IFlippConfig
 import { IIconsObject, PaymentTypesLogos, PaymentCards, IconNames, IconNamesToFiles } from "./icons.interfaces";
 import { ITheme, IThemeScripts, IThemeImages, IThemeMetadata, IThemeFavicons, IThemeLogoPosition, IThemeLogoHeightsProps, IThemeLogoHeights, ISTSThemeInterface, IThemeFavicon, IThemeMetadataItem, IThemeInterface, IGlobalTheme, IColors, IInitializedEmptyTheme, IThemeAnimationConfettiPlaces, IThemeGlobalAnimations, IThemeAnimationsConfettiPlacesTypes, IThemeAnimationsConfettiProps, IEmbeddedFont, IEmbeddedFontSource } from "./theme.interfaces";
 import { IDefaultTheme, IDefaultThemeScripts, IDefaultThemeImages, IDefaultThemeMetadata, IDefaultThemeFavicons, IDefaultThemeLogoPosition, IDefaultThemeLogoHeightsProps, IDefaultThemeLogoHeights, ISTSDefaultThemeInterface, IDefaultThemeFavicon, IDefaultThemeMetadataItem, IDefaultThemeInterface, IGlobalDefaultTheme, IDefaultColors, IInitializedEmptyDefaultTheme, IDefaultThemeAnimationConfettiPlaces, IDefaultThemeGlobalAnimations, IDefaultThemeAnimationsConfettiPlacesTypes, IDefaultThemeAnimationsConfettiProps, IDefaultEmbeddedFont, IDefaultEmbeddedFontSource } from "./default-theme.interface";
+import AdminSettingsTemplate from "./admin-settings-template";
+import { AdminTemplateInputTypes } from "./admin.interfaces";
+import defaultConfig from "./default.config";
 export { IDefaultTheme, IDefaultThemeScripts, IDefaultThemeImages, IDefaultThemeMetadata, IDefaultThemeFavicons, IDefaultThemeLogoPosition, IDefaultThemeLogoHeightsProps, IDefaultThemeLogoHeights, ISTSDefaultThemeInterface, IDefaultThemeFavicon, IDefaultThemeMetadataItem, IDefaultThemeInterface, IGlobalDefaultTheme, IDefaultColors, IInitializedEmptyDefaultTheme, IDefaultThemeAnimationConfettiPlaces, IDefaultThemeGlobalAnimations, IDefaultThemeAnimationsConfettiPlacesTypes, IDefaultThemeAnimationsConfettiProps, IDefaultEmbeddedFont, IDefaultEmbeddedFontSource, ITheme, IThemeScripts, IThemeImages, IThemeMetadata, IThemeFavicons, IThemeLogoPosition, IThemeLogoHeightsProps, IThemeLogoHeights, ISTSThemeInterface, IThemeFavicon, IThemeMetadataItem, IThemeInterface, IGlobalTheme, IColors, IInitializedEmptyTheme, IThemeAnimationConfettiPlaces, IThemeGlobalAnimations, IThemeAnimationsConfettiPlacesTypes, IThemeAnimationsConfettiProps, IEmbeddedFont, IEmbeddedFontSource, };
 export { IIconsObject, PaymentTypesLogos, PaymentCards, IconNames, IconNamesToFiles, };
 export { IRetailerSettings, ISecondTierAuthorization, IFlippConfig, IFlippConfigV2, IFlippScriptUrls, IAllSettings, ISMSConfig, IDefaultRetailerSettings, ICtaButtons, IAddressesSettings, IAccountPageSettings, ILayoutSettings, ILoggingLevel, IDefaultSearchParams, IDefaultStoreLocation, IDefaultCounty, IRetailerCountry, IRestrictMapPlaces, IValidationType, INutritionZone, IFooterTypes, IRegistrationFieldTypes, IRegistrationFieldNames, IValidateLength, IValidateDateRange, IRegistrationField, ICheckoutValidation, ISearchPreviewVisibility, IPaymentCards, IGlobalAnimations, ILayoutAnimationsConfetti, IGlobalCheckoutProps, IAddressIntegration, IAddressFinderType, };
+export { AdminSettingsTemplate, AdminTemplateInputTypes };
+export { defaultConfig };

package/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultConfig = exports.AdminTemplateInputTypes = exports.AdminSettingsTemplate = exports.IconNamesToFiles = void 0;
+var icons_interfaces_1 = require("./icons.interfaces");
+Object.defineProperty(exports, "IconNamesToFiles", { enumerable: true, get: function () { return icons_interfaces_1.IconNamesToFiles; } });
+var admin_settings_template_1 = require("./admin-settings-template");
+exports.AdminSettingsTemplate = admin_settings_template_1.default;
+var admin_interfaces_1 = require("./admin.interfaces");
+Object.defineProperty(exports, "AdminTemplateInputTypes", { enumerable: true, get: function () { return admin_interfaces_1.AdminTemplateInputTypes; } });
+var default_config_1 = require("./default.config");
+exports.defaultConfig = default_config_1.default;

package/package.json

@@ -1,14 +1,14 @@
-{
-  "name": "@thryveai/theme-interfaces",
-  "version": "1.5.23",
-  "description": "Shared Interfaces for all ThryveAi storefront retailer themes.",
-  "scripts": {
-    "build": "tsc",
-    "push": "npm run build && npm publish"
-  },
-  "author": "Simon Markey",
-  "license": "ISC",
-  "devDependencies": {
-    "typescript": "4.5.4"
-  }
-}
+{
+  "name": "@thryveai/theme-interfaces",
+  "version": "1.5.24-beta3",
+  "description": "Shared Interfaces for all ThryveAi storefront retailer themes.",
+  "scripts": {
+    "build": "tsc",
+    "push": "npm run build && npm publish"
+  },
+  "author": "Simon Markey",
+  "license": "ISC",
+  "devDependencies": {
+    "typescript": "^4.6.3"
+  }
+}

package/retailer-settings.interfaces.d.ts

@@ -2,8 +2,6 @@ import { IconNames, PaymentCards } from "./icons.interfaces";
 export interface IRetailerSettings {
     accountPage?: IAccountPageSettings;
     additionalCharges?: boolean;
-    advertSettings?: IAdvertSettings;
-    TimeslotModalSettings?: ITimeslotModalSettings;
     addresses?: {
         addressValidationTypes?: IAddressValidationTypes;
         canadianAddressCompleteKey?: string | undefined;
@@ -15,8 +13,10 @@ export interface IRetailerSettings {
         };
         useAddressValidation?: boolean;
     };
+    TimeslotModalSettings?: ITimeslotModalSettings;
     addressIntegration?: IAddressIntegration;
     addressValidationTypes?: IAddressValidationTypes;
+    advertSettings?: IAdvertSettings;
     allowInStorePurchases?: boolean;
     allowPastPurchases?: boolean;
     buildNumber: string;
@@ -44,6 +44,7 @@ export interface IRetailerSettings {
     externalApps?: IExternalApps;
     externalStoreSelectorUrl?: string | undefined;
     favoritesV1?: boolean;
+    featureSwitch?: IFeatureSwitch;
     flipp?: IFlippConfig | IFlippConfigV2 | null;
     globalAnimations?: IGlobalAnimations;
     googleAutocompleteSettings?: IGoogleAutocompleteSettings;
@@ -55,6 +56,7 @@ export interface IRetailerSettings {
     instacartUrl?: string | undefined;
     isPlanningOnly?: boolean;
     layout?: ILayoutSettings;
+    layouts?: IGlobalLayouts;
     limitProductCardTitleHeight?: boolean;
     loggingLevelClient?: ILoggingLevel;
     loggingLevelServer?: ILoggingLevel;
@@ -65,6 +67,8 @@ export interface IRetailerSettings {
     paymentCards?: IPaymentCards;
     pdpDetailsLayout?: IProductDetailsPageLayout;
     productCardTitleHeight?: number;
+    productCards?: IProductCardsProps;
+    productCardv2?: boolean;
     promoTemplateVersion?: number;
     registrationFields?: IRegistrationField[];
     restrictMapPlacesResults?: IRestrictMapPlaces;
@@ -74,15 +78,12 @@ export interface IRetailerSettings {
     secondTierAuthorization?: ISecondTierAuthorization;
     showCheckoutPromoCode?: boolean;
     showImgOnOrder?: boolean;
+    smartBanner?: ISmartBanner;
     smsNotifications?: ISMSConfig;
     sodiumWarning?: ISodiumWarning;
     specialRequestItems?: boolean;
     subHeaderHeight?: number;
     useAddressValidation?: boolean;
-    productCards?: IProductCardsProps;
-    layouts?: IGlobalLayouts;
-    smartBanner?: ISmartBanner;
-    featureSwitch?: IFeatureSwitch;
 }
 export interface IFeatureSwitch {
     clientCache?: boolean;
@@ -181,6 +182,10 @@ export interface IAdvertSkyScrapers {
     skyscrapers?: IAdvertsData;
 }
 export interface IDefaultRetailerSettings {
+    adminPanelOnly: {
+        bannerName: string;
+        logoUrl: string;
+    };
     accountPage: IAccountPageSettings;
     additionalCharges: boolean;
     addressIntegration: IAddressIntegration;
@@ -213,6 +218,7 @@ export interface IDefaultRetailerSettings {
     errorLoggingLevel: ILoggingLevel;
     externalStoreSelectorUrl: string | undefined;
     favoritesV1: boolean;
+    features: IFeatureSwitch;
     flipp: IFlippConfig | IFlippConfigV2 | null;
     globalAnimations: IGlobalAnimations;
     googleAutocompleteSettings: IGoogleAutocompleteSettings;
@@ -224,6 +230,7 @@ export interface IDefaultRetailerSettings {
     instacartUrl: string | undefined;
     isPlanningOnly: boolean;
     layout: ILayoutSettings;
+    layouts: IGlobalLayouts;
     limitProductCardTitleHeight: boolean;
     loggingLevelClient: ILoggingLevel;
     loggingLevelServer: ILoggingLevel;
@@ -234,6 +241,8 @@ export interface IDefaultRetailerSettings {
     paymentCards: IPaymentCards;
     pdpDetailsLayout: IProductDetailsPageLayout;
     productCardTitleHeight: number;
+    productCards: IProductCardsProps;
+    productCardv2: boolean;
     promoTemplateVersion: number;
     registrationFields: IRegistrationField[];
     restrictMapPlacesResults: IRestrictMapPlaces;
@@ -243,16 +252,13 @@ export interface IDefaultRetailerSettings {
     secondTierAuthorization?: ISecondTierAuthorization;
     showCheckoutPromoCode: boolean;
     showImgOnOrder: boolean;
+    smartbanner: ISmartBanner;
     smsNotifications: ISMSConfig;
     sodiumWarning: ISodiumWarning;
     specialRequestItems: boolean;
     subHeaderHeight: number;
     timeslotModalSettings: ITimeslotModalSettings;
     useAddressValidation: boolean;
-    productCards: IProductCardsProps;
-    layouts: IGlobalLayouts;
-    smartbanner: ISmartBanner;
-    features: IFeatureSwitch;
 }
 export interface IGoogleAutocompleteSettings {
     types?: IGoogleAutocompleteTypes;

package/retailer-settings.interfaces.js

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

package/theme.interfaces.d.ts

@@ -141,6 +141,7 @@ export interface IThemeInterface {
         headerActionLinks?: IHeaderActionLinksProps;
         headerLinks?: IHeaderLinksProps;
         departments?: {
+            wrapCategoryTitle?: boolean;
             backgroundColor?: {
                 active?: string;
                 static?: string;

package/theme.interfaces.js

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