@thryveai/theme-interfaces 2.3.13 → 2.3.16

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import DefaultImagesSFUI from './storefront/defaultImagesStorefront';
+import DefaultImagesSFUI from "./storefront/defaultImagesStorefront";
 import DefaultConfigSFUI from "./storefront/defaultSettingsStorefront";
 import DefaultThemeSFUI, { globalTheme, DefaultThemeColors } from "./storefront/defaultThemeStorefront";
 import DefaultConfigSTS from "./sts/defaultSettingsSts";
@@ -8,18 +8,18 @@ import { AdminImagesTemplateSFUI } from "./storefront/SFUIImagesTemplate.AdminUi
 import { AdminThemeTemplateSFUI, AdminThemeTemplateOptions } from "./storefront/SFUIThemesTemplate.AdminUi";
 import { AdminImagesTemplateSTS } from "./sts/STSImagesTemplate.AdminUi";
 import { IconNamesToFiles } from "./interfaces/icons.interfaces";
-import AllThemeTemplates from './theme-templates';
+import AllThemeTemplates from "./theme-templates";
 import { IAdminTemplateInputTypes, IAdminSettingsTemplate, IAdminSettingsTemplateSTS, IAdminImagesTemplateSFUI, IAdminThemeTemplateSFUI, IAdminThemeTemplateOptions, IAdminImagesTemplateSTS, IAdminControl, IAdminControlType, IThemeGenerator } from "./interfaces/admin-settings-interfaces";
 import { IAdminImagesControls, ISecondaryFaviconType } from "./interfaces/admin-images-interfaces";
 import { IDefaultRetailerSettings } from "./interfaces/default-settings.interfaces";
 import { IDefaultStsSettings } from "./interfaces/sts-settings.interfaces";
-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 } from "./interfaces/retailer-settings.interfaces";
+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";
 import { IIconsObject, PaymentTypesLogos, PaymentCards, IconNames } from "./interfaces/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 "./interfaces/theme.interfaces";
 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";
-export { DefaultConfigSFUI, DefaultConfigSTS, AllThemeTemplates, DefaultThemeSFUI, globalTheme, DefaultThemeColors, DefaultImagesSFUI, AdminSettingsTemplateSFUI, AdminSettingsTemplateSTS, AdminTemplateInputTypes, AdminImagesTemplateSFUI, AdminThemeTemplateSFUI, AdminThemeTemplateOptions, AdminImagesTemplateSTS, IconNamesToFiles };
-export { IAdminTemplateInputTypes, IAdminSettingsTemplate, IAdminSettingsTemplateSTS, IAdminControl, IAdminControlType, IThemeGenerator, IAdminImagesTemplateSFUI, IAdminImagesTemplateSTS, IAdminThemeTemplateSFUI, IAdminThemeTemplateOptions, IAdminImagesControls, ISecondaryFaviconType };
+export { DefaultConfigSFUI, DefaultConfigSTS, AllThemeTemplates, DefaultThemeSFUI, globalTheme, DefaultThemeColors, DefaultImagesSFUI, AdminSettingsTemplateSFUI, AdminSettingsTemplateSTS, AdminTemplateInputTypes, AdminImagesTemplateSFUI, AdminThemeTemplateSFUI, AdminThemeTemplateOptions, AdminImagesTemplateSTS, IconNamesToFiles, };
+export { IAdminTemplateInputTypes, IAdminSettingsTemplate, IAdminSettingsTemplateSTS, IAdminControl, IAdminControlType, IThemeGenerator, IAdminImagesTemplateSFUI, IAdminImagesTemplateSTS, IAdminThemeTemplateSFUI, IAdminThemeTemplateOptions, IAdminImagesControls, ISecondaryFaviconType, };
 export { IDefaultRetailerSettings, IDefaultStsSettings };
 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, };
-export { IIconsObject, PaymentTypesLogos, PaymentCards, IconNames, };
-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, ICouponGalleryLayout, IPageAdvertsRow, IScreenType, IProductCardLayoutObjects, IProductCardILayoutVersions, IProductCardILayoutTypes, IAdvertsData, };
+export { IIconsObject, PaymentTypesLogos, PaymentCards, IconNames };
+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, };

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

@@ -34,7 +34,7 @@ export declare type IAdminImagesTemplateSFUI = {
 export declare type IAdminThemeTemplateSFUI = {
     [key in IAdminThemeKeys]: IAdminControl;
 };
-declare type IAdminThemeKeys = 'colors';
+declare type IAdminThemeKeys = "colors";
 declare type IAdminImagesKeysSTS = "logos" | "stsCheckBox" | "stsFavicon";
 declare type IAdminImagesKeys = "icons" | "logos" | "confirmationPageImage" | "stsCheckBox" | "stsFavicon" | "favicon" | "rewards" | "verifySiteImage" | "missingImg";
 export interface IAdminThemeTemplateOptions {
@@ -46,6 +46,6 @@ export interface IAdminThemeTemplateOptions {
 export declare type IAllThemeTemplates = {
     [key in SupportThemeTemplates]: IThemeGenerator;
 };
-declare type SupportThemeTemplates = 'Default Storefront' | 'Default STS';
+declare type SupportThemeTemplates = "Default Storefront" | "Default STS";
 export declare type IThemeGenerator = (colors: IDefaultColors) => IDefaultThemeInterface;
 export {};

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

@@ -1,11 +1,10 @@
-import { IAccountPageSettings, IAddressesSettings, 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 } from "./retailer-settings.interfaces";
+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";
 export interface IDefaultRetailerSettings {
     adminPanelOnly: {
         bannerName: string;
         logoUrl: string;
     };
     accountPage: IAccountPageSettings;
-    addressIntegration: IAddressIntegration;
     addressValidationTypes: IAddressValidationTypes;
     addresses: IAddressesSettings;
     advertSettings: IAdvertSettings;
@@ -23,7 +22,6 @@ export interface IDefaultRetailerSettings {
     defaultSearchParams: IDefaultSearchParams;
     defaultShoppingMode: "pickup" | "planning" | "delivery";
     defaultStoreLocation: IDefaultStoreLocation;
-    disableAddressOnDelivery: boolean;
     disableTprPrice: boolean;
     documentTitle: string;
     eircode: string | undefined;

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

@@ -14,7 +14,6 @@ export interface IRetailerSettings {
         useAddressValidation?: boolean;
     };
     TimeslotModalSettings?: ITimeslotModalSettings;
-    addressIntegration?: IAddressIntegration;
     addressValidationTypes?: IAddressValidationTypes;
     advertSettings?: IAdvertSettings;
     allowInStorePurchases?: boolean;
@@ -31,7 +30,6 @@ export interface IRetailerSettings {
     defaultSearchParams?: IDefaultSearchParams;
     defaultShoppingMode?: "pickup" | "planning" | "delivery";
     defaultStoreLocation?: IDefaultStoreLocation;
-    disableAddressOnDelivery?: boolean;
     disableTprPrice?: boolean;
     documentTitle?: string;
     eircode?: string | null;
@@ -79,6 +77,7 @@ export interface IRetailerSettings {
     showImgOnOrder?: boolean;
     siteSettings?: ISiteSettings;
     smartBanner?: ISmartBanner;
+    entryModalVersion?: IEntryModalVersion;
     smsNotifications?: ISMSConfig;
     sodiumWarning?: ISodiumWarning;
     specialRequestItems?: boolean;
@@ -91,6 +90,8 @@ export interface IFeatureSwitch {
     vouchers: IVouchers;
     giftCards: IGiftCards;
     smartbanner: ISmartBanner;
+    entryModalVersion: IEntryModalVersion;
+    addressIntegration: IAddressIntegration;
 }
 export interface ISiteSettings {
     anonymousCart: boolean;
@@ -105,6 +106,7 @@ export interface IGiftCards {
     pinInputValidation: string;
     reCaptcha: boolean;
 }
+export declare type IEntryModalVersion = "entry" | "geolocation";
 export interface ISmartBanner {
     enabled: boolean;
     title: string;
@@ -329,9 +331,8 @@ export interface IGlobalCheckoutProps {
 }
 export interface IAddressIntegration {
     enabled: boolean;
-    getAddressesUrl: string;
-    getLocationUrl: string;
     addressFinderType: IAddressFinderType;
+    useForNewAddresses: boolean;
 }
 export declare type IAddressFinderType = "AUS" | "EU" | "IE" | "US" | "UK" | "CA";
 export interface IProductCardsProps {

package/dist/storefront/SFUISettingsTemplate.AdminUi.js

@@ -58,36 +58,6 @@ exports.AdminSettingsTemplateSFUI = {
             },
         },
     },
-    // addressIntegration: {
-    //   title: "Address Integration",
-    //   description: "Use external address integration",
-    //   helpLink:
-    //     "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/1594065051/Storefront+configuration+-+from+theme+repo",
-    //   type: AdminTemplateInputTypes.object,
-    //   value: {
-    //     enabled: {
-    //       title: "Enabled",
-    //       description: "Enables external address integration",
-    //       type: AdminTemplateInputTypes.checkbox,
-    //     },
-    //     getAddressesUrl: {
-    //       title: "Get Address Url",
-    //       description: "Set the get address url",
-    //       type: AdminTemplateInputTypes.inputChar,
-    //     },
-    //     getLocationUrl: {
-    //       title: "Get Location Url",
-    //       description: "Set the get location url",
-    //       type: AdminTemplateInputTypes.inputChar,
-    //     },
-    //     addressFinderType: {
-    //       title: "Address Finder Type",
-    //       description: "Select the address finder type",
-    //       type: AdminTemplateInputTypes.dropdown,
-    //       options: ["AUS", "EU", "IE", "US", "UK", "CA"],
-    //     },
-    //   },
-    // },
     // allowInStorePurchases: {
     //   title: "InStore Purchases",
     //   description:
@@ -423,6 +393,12 @@ exports.AdminSettingsTemplateSFUI = {
                     },
                 },
             },
+            entryModalVersion: {
+                title: "Set entry modal step",
+                description: "Set entry modal step setting.",
+                type: exports.AdminTemplateInputTypes.string,
+                helpLink: "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/3344302081/Entry+Modal+Version",
+            },
             smartbanner: {
                 title: "Smart Banner",
                 description: "Render smart banner on mobile views",
@@ -491,6 +467,30 @@ exports.AdminSettingsTemplateSFUI = {
                     },
                 },
             },
+            addressIntegration: {
+                title: "Address Integration",
+                description: "Use external address integration",
+                helpLink: "https://mi9retail.atlassian.net/wiki/spaces/FDS/pages/3346464807/Address+Integration",
+                type: exports.AdminTemplateInputTypes.object,
+                value: {
+                    enabled: {
+                        title: "Enabled",
+                        description: "Enables external address integration",
+                        type: exports.AdminTemplateInputTypes.checkbox,
+                    },
+                    addressFinderType: {
+                        title: "Address Finder Type",
+                        description: "Select the address finder type",
+                        type: exports.AdminTemplateInputTypes.dropdown,
+                        options: ["AUS", "EU", "IE", "US", "UK", "CA"],
+                    },
+                    useForNewAddresses: {
+                        title: "Use For New Addresses",
+                        description: "Use for creating new addresses on checkout",
+                        type: exports.AdminTemplateInputTypes.checkbox,
+                    },
+                },
+            },
         },
     },
     siteSettings: {

package/dist/storefront/defaultSettingsStorefront.js

@@ -52,19 +52,12 @@ var DefaultConfigSFUI = {
         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,
-    disableAddressOnDelivery: false,
     favoritesV1: false,
     checkout: {
         numericPhonePayload: false,
@@ -199,6 +192,7 @@ var DefaultConfigSFUI = {
             enabled: false,
             reCaptcha: false,
         },
+        entryModalVersion: "entry",
         smartbanner: {
             enabled: false,
             author: "",
@@ -213,6 +207,11 @@ var DefaultConfigSFUI = {
             priceSuffixGoogle: "",
             title: "",
         },
+        addressIntegration: {
+            enabled: false,
+            addressFinderType: "AUS",
+            useForNewAddresses: false,
+        },
     },
     siteSettings: {
         anonymousCart: false,

package/package.json

@@ -1,18 +1,18 @@
-{
-  "name": "@thryveai/theme-interfaces",
-  "version": "2.3.13",
-  "description": "Shared interfaces and defaults for all Wynshop themed apps.",
-  "scripts": {
-    "build": "tsc",
-    "push": "npm run build && npm publish"
-  },
-  "author": "Wynshop",
-  "license": "ISC",
-  "main": "dist",
-  "files": [
-    "dist"
-  ],
-  "devDependencies": {
-    "typescript": "4.6.3"
-  }
-}
+{
+  "name": "@thryveai/theme-interfaces",
+  "version": "2.3.16",
+  "description": "Shared interfaces and defaults for all Wynshop themed apps.",
+  "scripts": {
+    "build": "tsc",
+    "push": "npm run build && npm publish"
+  },
+  "author": "Wynshop",
+  "license": "ISC",
+  "main": "dist",
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "typescript": "4.6.3"
+  }
+}