@thryveai/theme-interfaces 2.3.16 → 2.4.0

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.
package/dist/index.d.ts CHANGED
@@ -11,15 +11,15 @@ import { IconNamesToFiles } from "./interfaces/icons.interfaces";
11
11
  import AllThemeTemplates from "./theme-templates";
12
12
  import { IAdminTemplateInputTypes, IAdminSettingsTemplate, IAdminSettingsTemplateSTS, IAdminImagesTemplateSFUI, IAdminThemeTemplateSFUI, IAdminThemeTemplateOptions, IAdminImagesTemplateSTS, IAdminControl, IAdminControlType, IThemeGenerator } from "./interfaces/admin-settings-interfaces";
13
13
  import { IAdminImagesControls, ISecondaryFaviconType } from "./interfaces/admin-images-interfaces";
14
- import { IDefaultRetailerSettings } from "./interfaces/default-settings.interfaces";
14
+ import { IDefaultRetailerSettingsVersion2 } from "./interfaces/default-settings.interfaces";
15
15
  import { IDefaultStsSettings } from "./interfaces/sts-settings.interfaces";
16
- import { IAdvertsData, PdpDetailsElementLayout, IScreenType, IProductCardLayoutObjects, IProductCardILayoutVersions, IProductCardILayoutTypes, ISearchPreview, IRetailerSettings, ISecondTierAuthorization, IFlippConfig, IFlippConfigV2, IFlippScriptUrls, IAllSettings, ISMSConfig, ICtaButtons, IAddressesSettings, IAccountPageSettings, ILayoutSettings, ILoggingLevel, IDefaultSearchParams, IDefaultStoreLocation, IDefaultCounty, IRetailerCountry, IRestrictMapPlaces, IValidationType, INutritionZone, IFooterTypes, IRegistrationFieldTypes, IRegistrationFieldNames, IValidateLength, IValidateMultipleLengths, IValidateDateRange, IRegistrationField, ICheckoutValidation, ISearchPreviewVisibility, IPaymentCards, IGlobalAnimations, ILayoutAnimationsConfetti, IGlobalCheckoutProps, IAddressIntegration, IAddressFinderType, IAdvertLeaderboards, IAdvertProductGrid, IAdvertSkyScrapers, IPageNamesForAdverts, IAddressValidationTypes, IAdvertSettings, IGoogleAutocompleteSettings, ITimeslotModalSettings, ISodiumWarning, IProductCardsProps, IProductDetailsPageLayout, ICartSummaryLayout, ISmartBanner, ICouponGalleryLayout, IPageAdvertsRow, IEntryModalVersion } from "./interfaces/retailer-settings.interfaces";
16
+ import { IAdvertsData, PdpDetailsElementLayout, IScreenType, IProductCardLayoutObjects, IProductCardILayoutVersions, IProductCardILayoutTypes, ISearchPreview, IRetailerSettings, ISecondTierAuthorization, IFlippConfig, IFlippConfigV2, IFlippScriptUrls, IAllSettings, ISMSConfig, ICtaButtons, IAddressesSettings, IAccountPageSettings, ILayoutSettings, ILoggingLevel, IDefaultSearchParams, IDefaultStoreLocation, IDefaultCounty, IRetailerCountry, IRestrictMapPlaces, IValidationType, INutritionZone, IFooterTypes, IRegistrationFieldTypes, IRegistrationFieldNames, IValidateLength, IValidateMultipleLengths, IValidateDateRange, IRegistrationField, ICheckoutValidation, ISearchPreviewVisibility, IPaymentCards, IGlobalAnimations, ILayoutAnimationsConfetti, IGlobalCheckoutProps, IAddressIntegration, IAddressFinderType, IAdvertLeaderboards, IAdvertProductGrid, IAdvertSkyScrapers, IPageNamesForAdverts, IAddressValidationTypes, IAdvertSettings, IGoogleAutocompleteSettings, ITimeslotModalSettings, ISodiumWarning, IProductCardsProps, IProductDetailsPageLayout, ICartSummaryLayout, ISmartBanner, ICouponGalleryLayout, IPageAdvertsRow, IEntryModalVersion, IAdminOnlyV2, IAccountPageV2, IAddressesSettingsV2, ICartSummaryV2, ICheckoutSettingsV2, IFeaturesV2, IPdpSettingsV2, IProductCardSettingsV2, ISiteSettingsV2 } from "./interfaces/retailer-settings.interfaces";
17
17
  import { IIconsObject, PaymentTypesLogos, PaymentCards, IconNames } from "./interfaces/icons.interfaces";
18
18
  import { ITheme, IThemeScripts, IThemeImages, IThemeMetadata, IThemeFavicons, IThemeLogoPosition, IThemeLogoHeightsProps, IThemeLogoHeights, ISTSThemeInterface, IThemeFavicon, IThemeMetadataItem, IThemeInterface, IGlobalTheme, IColors, IInitializedEmptyTheme, IThemeAnimationConfettiPlaces, IThemeGlobalAnimations, IThemeAnimationsConfettiPlacesTypes, IThemeAnimationsConfettiProps, IEmbeddedFont, IEmbeddedFontSource } from "./interfaces/theme.interfaces";
19
19
  import { IDefaultTheme, IDefaultThemeScripts, IDefaultThemeImages, IDefaultThemeMetadata, IDefaultThemeFavicons, IDefaultThemeLogoPosition, IDefaultThemeLogoHeightsProps, IDefaultThemeLogoHeights, ISTSDefaultThemeInterface, IDefaultThemeFavicon, IDefaultThemeMetadataItem, IDefaultThemeInterface, IGlobalDefaultTheme, IDefaultColors, IBrandColors, IUiColors, IInitializedEmptyDefaultTheme, IDefaultThemeAnimationConfettiPlaces, IDefaultThemeGlobalAnimations, IDefaultThemeAnimationsConfettiPlacesTypes, IDefaultThemeAnimationsConfettiProps, IDefaultEmbeddedFont, IDefaultEmbeddedFontSource, IIconPosition } from "./interfaces/default-theme.interface";
20
20
  export { DefaultConfigSFUI, DefaultConfigSTS, AllThemeTemplates, DefaultThemeSFUI, globalTheme, DefaultThemeColors, DefaultImagesSFUI, AdminSettingsTemplateSFUI, AdminSettingsTemplateSTS, AdminTemplateInputTypes, AdminImagesTemplateSFUI, AdminThemeTemplateSFUI, AdminThemeTemplateOptions, AdminImagesTemplateSTS, IconNamesToFiles, };
21
21
  export { IAdminTemplateInputTypes, IAdminSettingsTemplate, IAdminSettingsTemplateSTS, IAdminControl, IAdminControlType, IThemeGenerator, IAdminImagesTemplateSFUI, IAdminImagesTemplateSTS, IAdminThemeTemplateSFUI, IAdminThemeTemplateOptions, IAdminImagesControls, ISecondaryFaviconType, };
22
- export { IDefaultRetailerSettings, IDefaultStsSettings };
22
+ export { IDefaultRetailerSettingsVersion2, IDefaultStsSettings };
23
23
  export { IDefaultTheme, IDefaultThemeScripts, IDefaultThemeImages, IDefaultThemeMetadata, IDefaultThemeFavicons, IDefaultThemeLogoPosition, IDefaultThemeLogoHeightsProps, IDefaultThemeLogoHeights, ISTSDefaultThemeInterface, IDefaultThemeFavicon, IDefaultThemeMetadataItem, IDefaultThemeInterface, IGlobalDefaultTheme, IDefaultColors, IBrandColors, IUiColors, 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, IIconPosition, };
24
24
  export { IIconsObject, PaymentTypesLogos, PaymentCards, IconNames };
25
- export { PdpDetailsElementLayout, ISearchPreview, IRetailerSettings, ISecondTierAuthorization, IFlippConfig, IFlippConfigV2, IFlippScriptUrls, IAllSettings, ISMSConfig, ICtaButtons, IAddressesSettings, IAccountPageSettings, ILayoutSettings, ILoggingLevel, IDefaultSearchParams, IDefaultStoreLocation, IDefaultCounty, IRetailerCountry, IRestrictMapPlaces, IValidationType, INutritionZone, IFooterTypes, IRegistrationFieldTypes, IRegistrationFieldNames, IValidateLength, IValidateMultipleLengths, IValidateDateRange, IRegistrationField, ICheckoutValidation, ISearchPreviewVisibility, IPaymentCards, IGlobalAnimations, ILayoutAnimationsConfetti, IGlobalCheckoutProps, IAddressIntegration, IAddressFinderType, IAdvertLeaderboards, IAdvertProductGrid, IAdvertSkyScrapers, IPageNamesForAdverts, IAddressValidationTypes, IAdvertSettings, IGoogleAutocompleteSettings, ITimeslotModalSettings, ISodiumWarning, IProductCardsProps, IProductDetailsPageLayout, ICartSummaryLayout, ISmartBanner, IEntryModalVersion, ICouponGalleryLayout, IPageAdvertsRow, IScreenType, IProductCardLayoutObjects, IProductCardILayoutVersions, IProductCardILayoutTypes, IAdvertsData, };
25
+ export { PdpDetailsElementLayout, ISearchPreview, IRetailerSettings, ISecondTierAuthorization, IFlippConfig, IFlippConfigV2, IFlippScriptUrls, IAllSettings, ISMSConfig, ICtaButtons, IAddressesSettings, IAccountPageSettings, ILayoutSettings, ILoggingLevel, IDefaultSearchParams, IDefaultStoreLocation, IDefaultCounty, IRetailerCountry, IRestrictMapPlaces, IValidationType, INutritionZone, IFooterTypes, IRegistrationFieldTypes, IRegistrationFieldNames, IValidateLength, IValidateMultipleLengths, IValidateDateRange, IRegistrationField, ICheckoutValidation, ISearchPreviewVisibility, IPaymentCards, IGlobalAnimations, ILayoutAnimationsConfetti, IGlobalCheckoutProps, IAddressIntegration, IAddressFinderType, IAdvertLeaderboards, IAdvertProductGrid, IAdvertSkyScrapers, IPageNamesForAdverts, IAddressValidationTypes, IAdvertSettings, IGoogleAutocompleteSettings, ITimeslotModalSettings, ISodiumWarning, IProductCardsProps, IProductDetailsPageLayout, ICartSummaryLayout, ISmartBanner, IEntryModalVersion, ICouponGalleryLayout, IPageAdvertsRow, IScreenType, IProductCardLayoutObjects, IProductCardILayoutVersions, IProductCardILayoutTypes, IAdvertsData, IAdminOnlyV2, IAccountPageV2, IAddressesSettingsV2, ICartSummaryV2, ICheckoutSettingsV2, IFeaturesV2, IPdpSettingsV2, IProductCardSettingsV2, ISiteSettingsV2 };
@@ -5,8 +5,14 @@ export declare type IAdminTemplateInputTypes = {
5
5
  };
6
6
  export interface IAdminSettingsTemplate {
7
7
  adminPanelOnly: IAdminControl;
8
- siteSettings: IAdminControl;
8
+ accountPage: IAdminControl;
9
+ addressSettings: IAdminControl;
10
+ cartSummary: IAdminControl;
11
+ checkout: IAdminControl;
9
12
  features: IAdminControl;
13
+ pdpSettings: IAdminControl;
14
+ productCard: IAdminControl;
15
+ siteSettings: IAdminControl;
10
16
  }
11
17
  export interface IAdminControl {
12
18
  title: string;
@@ -1,4 +1,4 @@
1
- import { IAccountPageSettings, IAddressesSettings, 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 } from "./retailer-settings.interfaces";
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";
2
2
  export interface IDefaultRetailerSettings {
3
3
  adminPanelOnly: {
4
4
  bannerName: string;
@@ -6,6 +6,7 @@ export interface IDefaultRetailerSettings {
6
6
  };
7
7
  accountPage: IAccountPageSettings;
8
8
  addressValidationTypes: IAddressValidationTypes;
9
+ addressIntegration: IAddressIntegration;
9
10
  addresses: IAddressesSettings;
10
11
  advertSettings: IAdvertSettings;
11
12
  allowInStorePurchases: boolean;
@@ -74,3 +75,14 @@ export interface IDefaultRetailerSettings {
74
75
  timeslotModalSettings: ITimeslotModalSettings;
75
76
  useAddressValidation: boolean;
76
77
  }
78
+ export interface IDefaultRetailerSettingsVersion2 {
79
+ adminPanelOnly: IAdminOnlyV2;
80
+ accountPage: IAccountPageV2;
81
+ addressSettings: IAddressesSettingsV2;
82
+ cartSummary: ICartSummaryV2;
83
+ checkout: ICheckoutSettingsV2;
84
+ features: IFeaturesV2;
85
+ pdpSettings: IPdpSettingsV2;
86
+ productCard: IProductCardSettingsV2;
87
+ siteSettings: ISiteSettingsV2;
88
+ }
@@ -1,2 +1,3 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ //IAddressIntegration
@@ -102,7 +102,7 @@ export interface IVouchers {
102
102
  }
103
103
  export interface IGiftCards {
104
104
  enabled: boolean;
105
- gitfCardInputValidation: string;
105
+ giftCardInputValidation: string;
106
106
  pinInputValidation: string;
107
107
  reCaptcha: boolean;
108
108
  }
@@ -223,14 +223,115 @@ export interface ISodiumWarning {
223
223
  }
224
224
  export interface IAddressesSettings {
225
225
  addressValidationTypes: IAddressValidationTypes;
226
- canadianAddressCompleteKey: string | undefined;
227
- eircodeUrl: string | undefined;
226
+ eircode: {
227
+ enabled: boolean;
228
+ url: string;
229
+ };
230
+ integration: {
231
+ enabled: boolean;
232
+ addressFinderType: IAddressFinderType;
233
+ addNewAddressUrl: string;
234
+ editAddressUrl: string;
235
+ deleteAddressUrl: string;
236
+ getLocationUrl: string;
237
+ getAddressesUrl: string;
238
+ };
239
+ useAddressValidation: boolean;
240
+ disableAddressOnDelivery: boolean;
241
+ }
242
+ export interface IAddressesSettingsV2 {
243
+ addressValidationTypes: IAddressValidationTypes;
244
+ eircode: {
245
+ enabled: boolean;
246
+ url: string;
247
+ };
228
248
  integration: {
229
- addNewAddressUrl: string | undefined;
230
- editAddressUrl: string | undefined;
231
- deleteAddressUrl: string | undefined;
249
+ enabled: boolean;
250
+ addressFinderType: IAddressFinderType;
251
+ useForNewAddresses: boolean;
252
+ addNewAddressUrl: string;
253
+ editAddressUrl: string;
254
+ deleteAddressUrl: string;
232
255
  };
233
256
  useAddressValidation: boolean;
257
+ disableAddressOnDelivery: boolean;
258
+ }
259
+ export interface ICartSummaryV2 {
260
+ showTaxTotal: boolean;
261
+ showTaxGroups: boolean;
262
+ hideTaxOnSummary: boolean;
263
+ }
264
+ export interface ICheckoutSettingsV2 {
265
+ numericPhonePayload: boolean;
266
+ houseAccountRegExValidation: string;
267
+ minimumCreditCardAmount: number;
268
+ paymentCards: IPaymentCards;
269
+ checkoutValidation: ICheckoutValidation;
270
+ }
271
+ export interface IFeaturesV2 {
272
+ additionalCharges: boolean;
273
+ clientCache: boolean;
274
+ vouchers: IVouchers;
275
+ giftCards: IGiftCards;
276
+ smartbanner: ISmartBanner;
277
+ entryModalVersion: IEntryModalVersion;
278
+ allowInStorePurchases: boolean;
279
+ allowPastPurchases: boolean;
280
+ advertSettings: IAdvertSettings;
281
+ enableGoogleTranslate: boolean;
282
+ enableNewsletterSignup: boolean;
283
+ enableNotifications: boolean;
284
+ externalStoreSelectorUrl: {
285
+ enabled: boolean;
286
+ url: string;
287
+ };
288
+ favoritesV1: boolean;
289
+ flipp: IFlippConfig | IFlippConfigV2 | null;
290
+ globalAnimations: IGlobalAnimations;
291
+ instacart: {
292
+ enabled: boolean;
293
+ url: string;
294
+ };
295
+ registrationFields: IRegistrationField[];
296
+ secondTierAuthorization?: ISecondTierAuthorization;
297
+ showCheckoutPromoCode: boolean;
298
+ showImgOnOrder: boolean;
299
+ smsNotifications: ISMSConfig;
300
+ specialRequestItems: boolean;
301
+ couponGallery: ICouponGalleryLayout;
302
+ }
303
+ export interface IPdpSettingsV2 {
304
+ nutritionZone: INutritionZone;
305
+ pdpDetailsLayout: IProductDetailsPageLayout;
306
+ sodiumWarning: ISodiumWarning;
307
+ }
308
+ export interface IProductCardSettingsV2 {
309
+ limitProductCardTitleHeight: boolean;
310
+ productCardTitleHeight: number;
311
+ productCards: IProductCardsProps;
312
+ }
313
+ export interface ISiteSettingsV2 {
314
+ anonymousCart: boolean;
315
+ ctaButtons: ICtaButtons | null | undefined;
316
+ daysToRemainSignedIn: number;
317
+ defaultCountry: IDefaultCounty;
318
+ defaultSearchParams: IDefaultSearchParams;
319
+ defaultShoppingMode: "pickup" | "planning" | "delivery";
320
+ defaultStoreLocation: IDefaultStoreLocation;
321
+ disableTprPrice: boolean;
322
+ footerVersion: IFooterTypes;
323
+ googleAutocompleteSettings: IGoogleAutocompleteSettings;
324
+ gtmId: string;
325
+ isPlanningOnly: boolean;
326
+ mainHeaderHeight: number;
327
+ mapZoom: number;
328
+ promoTemplateVersion: number;
329
+ restrictMapPlacesResults: IRestrictMapPlaces;
330
+ retailerCountry: IRetailerCountry;
331
+ retailerName: string;
332
+ searchPreview: ISearchPreviewVisibility;
333
+ subHeaderHeight: number;
334
+ timeslotModalSettings: ITimeslotModalSettings;
234
335
  }
235
336
  export interface IAccountPageSettings {
236
337
  loyaltyTab: {
@@ -255,6 +356,7 @@ export interface IAddressValidationTypes {
255
356
  instructions: IValidationType[];
256
357
  phoneNumber: IValidationType[];
257
358
  postCode: IValidationType[];
359
+ smsNumber: IValidationType[];
258
360
  }
259
361
  export interface IDefaultSearchParams {
260
362
  q: string;
@@ -320,6 +422,24 @@ export interface ISearchPreviewVisibility {
320
422
  export declare type IPaymentCards = {
321
423
  [cardName in PaymentCards]: boolean;
322
424
  };
425
+ export interface IAdminOnlyV2 {
426
+ bannerName: string;
427
+ logoUrl: string;
428
+ }
429
+ export interface IAccountPageV2 {
430
+ loyaltyTab: {
431
+ disabledEdit?: boolean;
432
+ enabled: boolean;
433
+ loyaltyNumberLength: number;
434
+ loyaltyNumberPrefix: string;
435
+ loyaltyValidationType: IValidationType[];
436
+ };
437
+ idp: {
438
+ enabled: boolean;
439
+ target: "_self" | "_blank";
440
+ url: string;
441
+ };
442
+ }
323
443
  export interface IGlobalAnimations {
324
444
  confetti: ILayoutAnimationsConfetti;
325
445
  }