@thryveai/theme-interfaces 2.4.0 → 2.4.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,13 +1,13 @@
1
- import { IAccountPageSettings, IAddressIntegration, IAddressValidationTypes, IAdvertSettings, ICheckoutValidation, ICtaButtons, IDefaultCounty, IDefaultSearchParams, IDefaultStoreLocation, IFeatureSwitch, IFlippConfig, IFlippConfigV2, IGlobalAnimations, IGlobalCheckoutProps, IGlobalLayouts, IGoogleAutocompleteSettings, ILayoutSettings, ILoggingLevel, INutritionZone, IPaymentCards, IProductCardsProps, IProductDetailsPageLayout, IRegistrationField, IRestrictMapPlaces, IRetailerCountry, ISearchPreviewVisibility, ISecondTierAuthorization, ISiteSettings, ISMSConfig, ISodiumWarning, ITimeslotModalSettings, IAccountPageV2, IAdminOnlyV2, IAddressesSettingsV2, ICartSummaryV2, IFeaturesV2, ICheckoutSettingsV2, IPdpSettingsV2, IProductCardSettingsV2, ISiteSettingsV2, IAddressesSettings } from "./retailer-settings.interfaces";
1
+ import { IAccountPageSettings, IAccountPageV2, IAddressIntegration, IAddressValidationTypes, IAddressesSettings, IAddressesSettingsV2, IAdminOnlyV2, IAdvertSettings, ICartSummaryV2, ICheckoutSettingsV2, ICheckoutValidation, ICtaButtons, IDefaultCounty, IDefaultSearchParams, IDefaultStoreLocation, IFeatureSwitch, IFeaturesV2, IFlippConfig, IFlippConfigV2, IGlobalAnimations, IGlobalCheckoutProps, IGlobalLayouts, IGoogleAutocompleteSettings, ILayoutSettings, ILoggingLevel, INutritionZone, IPaymentCards, IPdpSettingsV2, IProductCardSettingsV2, IProductCardsProps, IProductDetailsPageLayout, IRegistrationField, IRestrictMapPlaces, IRetailerCountry, ISMSConfig, ISearchPreviewVisibility, ISecondTierAuthorization, ISiteSettings, ISiteSettingsV2, ISodiumWarning, ITimeslotModalSettings } from "./retailer-settings.interfaces";
2
2
  export interface IDefaultRetailerSettings {
3
+ accountPage: IAccountPageSettings;
4
+ addressIntegration: IAddressIntegration;
5
+ addressValidationTypes: IAddressValidationTypes;
6
+ addresses: IAddressesSettings;
3
7
  adminPanelOnly: {
4
8
  bannerName: string;
5
9
  logoUrl: string;
6
10
  };
7
- accountPage: IAccountPageSettings;
8
- addressValidationTypes: IAddressValidationTypes;
9
- addressIntegration: IAddressIntegration;
10
- addresses: IAddressesSettings;
11
11
  advertSettings: IAdvertSettings;
12
12
  allowInStorePurchases: boolean;
13
13
  allowPastPurchases: boolean;
@@ -50,6 +50,7 @@ export interface IDefaultRetailerSettings {
50
50
  loggingLevelClient: ILoggingLevel;
51
51
  loggingLevelServer: ILoggingLevel;
52
52
  mainHeaderHeight: number;
53
+ maintainCustomerJourney: boolean;
53
54
  mapZoom: number;
54
55
  minimumCreditCardAmount: number;
55
56
  nutritionZone: INutritionZone;
@@ -65,9 +66,9 @@ export interface IDefaultRetailerSettings {
65
66
  retailerName: string;
66
67
  searchPreview: ISearchPreviewVisibility;
67
68
  secondTierAuthorization?: ISecondTierAuthorization;
68
- siteSettings: ISiteSettings;
69
69
  showCheckoutPromoCode: boolean;
70
70
  showImgOnOrder: boolean;
71
+ siteSettings: ISiteSettings;
71
72
  smsNotifications: ISMSConfig;
72
73
  sodiumWarning: ISodiumWarning;
73
74
  specialRequestItems: boolean;
@@ -76,9 +77,9 @@ export interface IDefaultRetailerSettings {
76
77
  useAddressValidation: boolean;
77
78
  }
78
79
  export interface IDefaultRetailerSettingsVersion2 {
79
- adminPanelOnly: IAdminOnlyV2;
80
80
  accountPage: IAccountPageV2;
81
81
  addressSettings: IAddressesSettingsV2;
82
+ adminPanelOnly: IAdminOnlyV2;
82
83
  cartSummary: ICartSummaryV2;
83
84
  checkout: ICheckoutSettingsV2;
84
85
  features: IFeaturesV2;
@@ -1,7 +1,7 @@
1
1
  export declare type IIconsObject = {
2
2
  [iconName in IconNames]: string;
3
3
  };
4
- export declare type PaymentTypesLogos = "VisaLogo" | "MasterLogo" | "DiscoverCard" | "AmExpCard" | "VisaVerified" | "MasterSecure" | "Comodo";
5
- export declare type PaymentCards = "VisaCard" | "MasterCard" | "DiscoverCard" | "AmExpCard";
6
- export declare type IconNames = "AccountOutline" | "AccountSolid" | "Addresses" | "ArrowDown" | "ArrowRight" | "ArrowUpdown" | "BarScan" | "Bell" | "Blog" | "Cart" | "Check" | "ChevronDown" | "ChevronLeft" | "ChevronRight" | "ChevronUp" | "Circular" | "Clear" | "Close" | "Coupon" | "Dashboard" | "DeliveryOutline" | "DeliverySolid" | "Dietary" | "DoubleArrows" | "Download" | "Dropship" | "Eco" | "Edit" | "Error" | "FaceHappy" | "FaceSad" | "Facebook" | "Fav" | "FavSolid" | "Filter" | "Flag" | "Geolocate" | "Hamburger" | "Help" | "Home" | "Info" | "Instacart" | "Instagram" | "ItemLocation" | "ListCheck" | "ListItems" | "ListLarge" | "ListRemove" | "ListSave" | "ListSearch" | "LocationPin" | "LocationDistance" | "LoyaltyCard" | "Mail" | "Minus" | "MoreOptionsH" | "MoreOptionsV" | "Note" | "Notifications" | "NoteFilled" | "Orders" | "PastPurchases" | "Pause" | "PaymentOutline" | "PaymentSolid" | "Phone" | "PhoneMobile" | "Pickup" | "PickupInfo" | "Pinterest" | "Plus" | "Print" | "PromoOutline" | "PromoSolid" | "RadioActive" | "RadioEmpty" | "RecipeCalories" | "RecipeCooktime" | "RecipeIngredients" | "RecipePreptime" | "RecipeServings" | "Remove" | "Reserve" | "ReserveTime" | "Search" | "SelectCheck" | "SelectEmpty" | "SelectMark" | "Send" | "Settings" | "Share" | "SortGrid" | "SortList" | "StarOutline" | "StarSolid" | "Substitute" | "SubstituteBestmatch" | "SubstituteNone" | "SubstituteProduct" | "Trash" | "Twitter" | "Unavailable" | "Voice" | "Warning" | "Youtube" | "YourLocation" | "GlutenFree" | "Local" | "Organic" | "None" | PaymentTypesLogos | PaymentCards;
4
+ export declare type PaymentTypesLogos = "AmExpCard" | "Comodo" | "DiscoverCard" | "MasterLogo" | "MasterSecure" | "VisaLogo" | "VisaVerified";
5
+ export declare type PaymentCards = "AmExpCard" | "DiscoverCard" | "MasterCard" | "VisaCard";
6
+ export declare type IconNames = "AccountOutline" | "AccountSolid" | "Addresses" | "ArrowDown" | "ArrowRight" | "ArrowUpdown" | "BarScan" | "Bell" | "Blog" | "Cart" | "Check" | "ChevronDown" | "ChevronLeft" | "ChevronRight" | "ChevronUp" | "Circular" | "Clear" | "Close" | "Coupon" | "Dashboard" | "DeliveryOutline" | "DeliverySolid" | "Dietary" | "DoubleArrows" | "Download" | "Dropship" | "Eco" | "Edit" | "Error" | "FaceHappy" | "FaceSad" | "Facebook" | "Fav" | "FavSolid" | "Filter" | "Flag" | "Geolocate" | "GlutenFree" | "Hamburger" | "Help" | "Home" | "Info" | "Instacart" | "Instagram" | "ItemLocation" | "ListCheck" | "ListItems" | "ListLarge" | "ListRemove" | "ListSave" | "ListSearch" | "Local" | "LocationDistance" | "LocationPin" | "LoyaltyCard" | "Mail" | "Minus" | "MoreOptionsH" | "MoreOptionsV" | "None" | "Note" | "NoteFilled" | "Notifications" | "Orders" | "Organic" | "PastPurchases" | "Pause" | "PaymentOutline" | "PaymentSolid" | "Phone" | "PhoneMobile" | "Pickup" | "PickupInfo" | "Pinterest" | "Plus" | "Print" | "PromoOutline" | "PromoSolid" | "RadioActive" | "RadioEmpty" | "RecipeCalories" | "RecipeCooktime" | "RecipeIngredients" | "RecipePreptime" | "RecipeServings" | "Remove" | "Reserve" | "ReserveTime" | "Search" | "SelectCheck" | "SelectEmpty" | "SelectMark" | "Send" | "Settings" | "Share" | "SodiumWarning" | "SortGrid" | "SortList" | "StarOutline" | "StarSolid" | "Substitute" | "SubstituteBestmatch" | "SubstituteNone" | "SubstituteProduct" | "Trash" | "Twitter" | "Unavailable" | "Voice" | "Warning" | "YourLocation" | "Youtube" | PaymentTypesLogos | PaymentCards;
7
7
  export declare const IconNamesToFiles: IIconsObject;
@@ -5,6 +5,7 @@ exports.IconNamesToFiles = {
5
5
  AccountOutline: "account-outline",
6
6
  AccountSolid: "account-solid",
7
7
  Addresses: "addresses",
8
+ AmExpCard: "american-express-card",
8
9
  ArrowDown: "arrow-down",
9
10
  ArrowRight: "arrow-right",
10
11
  ArrowUpdown: "arrow-updown",
@@ -20,11 +21,13 @@ exports.IconNamesToFiles = {
20
21
  Circular: "circular",
21
22
  Clear: "clear",
22
23
  Close: "close",
24
+ Comodo: "comodo",
23
25
  Coupon: "coupon",
24
26
  Dashboard: "dashboard",
25
27
  DeliveryOutline: "delivery-outline",
26
28
  DeliverySolid: "delivery-solid",
27
29
  Dietary: "dietary",
30
+ DiscoverCard: "discover-card",
28
31
  DoubleArrows: "double-arrows",
29
32
  Download: "download",
30
33
  Dropship: "dropship",
@@ -39,6 +42,7 @@ exports.IconNamesToFiles = {
39
42
  Filter: "filter",
40
43
  Flag: "flag",
41
44
  Geolocate: "geolocate",
45
+ GlutenFree: "Gluten-Free",
42
46
  Hamburger: "hamburger",
43
47
  Help: "help",
44
48
  Home: "home",
@@ -52,17 +56,23 @@ exports.IconNamesToFiles = {
52
56
  ListRemove: "list-remove",
53
57
  ListSave: "list-save",
54
58
  ListSearch: "list-search",
55
- LocationPin: "location-pin",
59
+ Local: "Local",
56
60
  LocationDistance: "location-distance",
61
+ LocationPin: "location-pin",
57
62
  LoyaltyCard: "loyaltycard",
58
63
  Mail: "mail",
64
+ MasterCard: "master-card-card",
65
+ MasterLogo: "master-card-logo",
66
+ MasterSecure: "master-card-secure",
59
67
  Minus: "minus",
60
68
  MoreOptionsH: "more-options-h",
61
69
  MoreOptionsV: "more-options-v",
70
+ None: "None",
62
71
  Note: "note",
63
- Notifications: "notifications",
64
72
  NoteFilled: "note-filled",
73
+ Notifications: "notifications",
65
74
  Orders: "orders",
75
+ Organic: "Organic",
66
76
  PastPurchases: "past-purchases",
67
77
  Pause: "pause",
68
78
  PaymentOutline: "payment-outline",
@@ -93,6 +103,7 @@ exports.IconNamesToFiles = {
93
103
  Send: "send",
94
104
  Settings: "settings",
95
105
  Share: "share",
106
+ SodiumWarning: "sodium-warning",
96
107
  SortGrid: "sort-grid",
97
108
  SortList: "sort-list",
98
109
  StarOutline: "star-outline",
@@ -104,21 +115,11 @@ exports.IconNamesToFiles = {
104
115
  Trash: "trash",
105
116
  Twitter: "twitter",
106
117
  Unavailable: "unavailable",
118
+ VisaCard: "visa-card",
119
+ VisaLogo: "visa-logo",
120
+ VisaVerified: "visa-verified",
107
121
  Voice: "voice",
108
122
  Warning: "warning",
109
- Youtube: "youtube",
110
123
  YourLocation: "your-location",
111
- GlutenFree: "Gluten-Free",
112
- Local: "Local",
113
- Organic: "Organic",
114
- None: "None",
115
- VisaLogo: "visa-logo",
116
- MasterLogo: "master-card-logo",
117
- VisaCard: "visa-card",
118
- MasterCard: "master-card-card",
119
- AmExpCard: "american-express-card",
120
- DiscoverCard: "discover-card",
121
- VisaVerified: "visa-verified",
122
- MasterSecure: "master-card-secure",
123
- Comodo: "comodo",
124
+ Youtube: "youtube",
124
125
  };
@@ -13,7 +13,6 @@ export interface IRetailerSettings {
13
13
  };
14
14
  useAddressValidation?: boolean;
15
15
  };
16
- TimeslotModalSettings?: ITimeslotModalSettings;
17
16
  addressValidationTypes?: IAddressValidationTypes;
18
17
  advertSettings?: IAdvertSettings;
19
18
  allowInStorePurchases?: boolean;
@@ -37,6 +36,7 @@ export interface IRetailerSettings {
37
36
  enableGoogleTranslate?: boolean;
38
37
  enableNewsletterSignup?: boolean;
39
38
  enableNotifications?: boolean;
39
+ entryModalVersion?: IEntryModalVersion;
40
40
  errorLoggingLevel?: ILoggingLevel;
41
41
  externalApps?: IExternalApps;
42
42
  externalStoreSelectorUrl?: string | undefined;
@@ -58,6 +58,7 @@ export interface IRetailerSettings {
58
58
  loggingLevelClient?: ILoggingLevel;
59
59
  loggingLevelServer?: ILoggingLevel;
60
60
  mainHeaderHeight?: number;
61
+ maintainCustomerJourney?: boolean;
61
62
  mapZoom?: number;
62
63
  minimumCreditCardAmount?: number;
63
64
  nutritionZone?: INutritionZone;
@@ -77,11 +78,11 @@ export interface IRetailerSettings {
77
78
  showImgOnOrder?: boolean;
78
79
  siteSettings?: ISiteSettings;
79
80
  smartBanner?: ISmartBanner;
80
- entryModalVersion?: IEntryModalVersion;
81
81
  smsNotifications?: ISMSConfig;
82
82
  sodiumWarning?: ISodiumWarning;
83
83
  specialRequestItems?: boolean;
84
84
  subHeaderHeight?: number;
85
+ TimeslotModalSettings?: ITimeslotModalSettings;
85
86
  useAddressValidation?: boolean;
86
87
  }
87
88
  export interface IFeatureSwitch {
@@ -324,6 +325,7 @@ export interface ISiteSettingsV2 {
324
325
  gtmId: string;
325
326
  isPlanningOnly: boolean;
326
327
  mainHeaderHeight: number;
328
+ maintainCustomerJourney: boolean;
327
329
  mapZoom: number;
328
330
  promoTemplateVersion: number;
329
331
  restrictMapPlacesResults: IRestrictMapPlaces;
@@ -259,9 +259,9 @@ var SiteSettingsChildren = {
259
259
  type: exports.AdminTemplateInputTypes.checkbox,
260
260
  },
261
261
  ctaButtons: {
262
- title: 'Call To Action Button Settings',
263
- description: 'Coming Soon',
264
- type: exports.AdminTemplateInputTypes.nullObject
262
+ title: "Call To Action Button Settings",
263
+ description: "Coming Soon",
264
+ type: exports.AdminTemplateInputTypes.nullObject,
265
265
  },
266
266
  daysToRemainSignedIn: {
267
267
  title: "Sign In Days",
@@ -324,6 +324,12 @@ var SiteSettingsChildren = {
324
324
  helpLink: "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/1594065051/Storefront+configuration+-+from+theme+repo",
325
325
  type: exports.AdminTemplateInputTypes.inputNumber,
326
326
  },
327
+ maintainCustomerJourney: {
328
+ title: "Maintain customer journey",
329
+ description: "Use to navigate back to the page you were after login/store selection etc...",
330
+ helpLink: "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/3373695163/Maintain+customer+journey",
331
+ type: exports.AdminTemplateInputTypes.checkbox,
332
+ },
327
333
  retailerCountry: {
328
334
  title: "Retailer country",
329
335
  description: "Select the retailer country",
@@ -408,15 +414,15 @@ var AccountPageSettingsChildren = {
408
414
  title: "Link Target",
409
415
  description: "Should the link open in the same or new tab?",
410
416
  type: exports.AdminTemplateInputTypes.dropdown,
411
- options: ["_self", "_blank"]
417
+ options: ["_self", "_blank"],
412
418
  },
413
419
  url: {
414
420
  title: "Link URL",
415
421
  description: "URL to link to My Account page",
416
422
  type: exports.AdminTemplateInputTypes.inputChar,
417
423
  },
418
- }
419
- }
424
+ },
425
+ },
420
426
  };
421
427
  var AddressSettingsChildren = {
422
428
  addressValidationTypes: {
@@ -536,12 +542,12 @@ var AddressSettingsChildren = {
536
542
  description: "",
537
543
  type: exports.AdminTemplateInputTypes.inputChar,
538
544
  },
539
- }
545
+ },
540
546
  },
541
547
  integration: {
542
- title: 'Address Integration Settings',
543
- description: 'Coming Soon',
544
- type: exports.AdminTemplateInputTypes.nullObject
548
+ title: "Address Integration Settings",
549
+ description: "Coming Soon",
550
+ type: exports.AdminTemplateInputTypes.nullObject,
545
551
  },
546
552
  useAddressValidation: {
547
553
  title: "useAddressValidation",
@@ -592,38 +598,38 @@ exports.AdminSettingsTemplateSFUI = {
592
598
  value: AccountPageSettingsChildren,
593
599
  },
594
600
  addressSettings: {
595
- title: 'Address Settings',
596
- description: 'Controls how the user can add an address',
601
+ title: "Address Settings",
602
+ description: "Controls how the user can add an address",
597
603
  type: exports.AdminTemplateInputTypes.collapsableObject,
598
- value: AddressSettingsChildren
604
+ value: AddressSettingsChildren,
599
605
  },
600
606
  cartSummary: {
601
- title: 'Cart & Order Summary',
602
- description: 'Settings for the Cart or Order Summary section',
607
+ title: "Cart & Order Summary",
608
+ description: "Settings for the Cart or Order Summary section",
603
609
  type: exports.AdminTemplateInputTypes.collapsableObject,
604
- value: CartSummarySettingsChildren
610
+ value: CartSummarySettingsChildren,
605
611
  },
606
612
  checkout: {
607
- title: 'Checkout Summary',
608
- description: 'Coming Soon',
609
- type: exports.AdminTemplateInputTypes.collapsableObject
613
+ title: "Checkout Summary",
614
+ description: "Coming Soon",
615
+ type: exports.AdminTemplateInputTypes.collapsableObject,
610
616
  },
611
617
  features: {
612
618
  title: "Features",
613
619
  description: "These are non-essential enhancements and integrations, the storefront will function without these.",
614
620
  type: exports.AdminTemplateInputTypes.collapsableObject,
615
621
  helpLink: "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/3304816658/Features",
616
- value: FeatureSettingsChildren
622
+ value: FeatureSettingsChildren,
617
623
  },
618
624
  pdpSettings: {
619
- title: 'Product Details Page Settings',
620
- description: 'Coming Soon',
621
- type: exports.AdminTemplateInputTypes.nullObject
625
+ title: "Product Details Page Settings",
626
+ description: "Coming Soon",
627
+ type: exports.AdminTemplateInputTypes.nullObject,
622
628
  },
623
629
  productCard: {
624
- title: 'Product Card Settings',
625
- description: 'Coming Soon',
626
- type: exports.AdminTemplateInputTypes.nullObject
630
+ title: "Product Card Settings",
631
+ description: "Coming Soon",
632
+ type: exports.AdminTemplateInputTypes.nullObject,
627
633
  },
628
634
  siteSettings: {
629
635
  title: "General Site Settings",
@@ -30,6 +30,7 @@ var DefaultConfigSFUI = {
30
30
  gtmId: "",
31
31
  isPlanningOnly: false,
32
32
  mapZoom: 8,
33
+ maintainCustomerJourney: true,
33
34
  promoTemplateVersion: 1,
34
35
  retailerCountry: "us",
35
36
  retailerName: "default",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@thryveai/theme-interfaces",
3
- "version": "2.4.0",
3
+ "version": "2.4.3",
4
4
  "description": "Shared interfaces and defaults for all Wynshop themed apps.",
5
5
  "scripts": {
6
6
  "build": "tsc",