@automattic/data-stores 3.1.0 → 3.1.1

package/src/onboard/utils.ts

@@ -1,15 +1,12 @@
 import { SiteGoal, SiteIntent } from './constants';
 
-const INTENT_DECIDING_GOALS = [ SiteGoal.Write, SiteGoal.Sell, SiteGoal.Promote ] as const;
-type IntentDecidingGoal = ( typeof INTENT_DECIDING_GOALS )[ number ];
+interface Flags {
+	isIntentCreateCourseGoalEnabled?: boolean;
+}
 
-const GOAL_TO_INTENT_MAP: { [ key in IntentDecidingGoal ]: SiteIntent } = {
-	[ SiteGoal.Write ]: SiteIntent.Write,
-	[ SiteGoal.Sell ]: SiteIntent.Sell,
-	[ SiteGoal.Promote ]: SiteIntent.Build,
-};
+export const goalsToIntent = ( goals: SiteGoal[], flags?: Flags ): SiteIntent => {
+	const { isIntentCreateCourseGoalEnabled } = flags ?? {};
 
-export const goalsToIntent = ( goals: SiteGoal[] ): SiteIntent => {
 	// When DIFM and Import goals are selected together, DIFM Intent will have the priority and will be set.
 	if ( goals.includes( SiteGoal.DIFM ) ) {
 		return SiteIntent.DIFM;
@@ -19,8 +16,21 @@ export const goalsToIntent = ( goals: SiteGoal[] ): SiteIntent => {
 		return SiteIntent.Import;
 	}
 
+	if ( goals.includes( SiteGoal.Courses ) && isIntentCreateCourseGoalEnabled ) {
+		return SiteIntent.CreateCourseGoal;
+	}
+
+	// Newsletter flow
+	if ( goals.includes( SiteGoal.Newsletter ) ) {
+		return SiteIntent.NewsletterGoal;
+	}
+
 	// Prioritize Sell over Build and Write
-	if ( goals.includes( SiteGoal.Sell ) ) {
+	if (
+		goals.some( ( goal ) =>
+			[ SiteGoal.Sell, SiteGoal.SellDigital, SiteGoal.SellPhysical ].includes( goal )
+		)
+	) {
 		return SiteIntent.Sell;
 	}
 
@@ -29,12 +39,8 @@ export const goalsToIntent = ( goals: SiteGoal[] ): SiteIntent => {
 		return SiteIntent.Build;
 	}
 
-	const intentDecidingGoal = ( goals as IntentDecidingGoal[] ).find( ( goal ) =>
-		INTENT_DECIDING_GOALS.includes( goal )
-	);
-
-	if ( intentDecidingGoal ) {
-		return GOAL_TO_INTENT_MAP[ intentDecidingGoal ];
+	if ( goals.includes( SiteGoal.Write ) ) {
+		return SiteIntent.Write;
 	}
 
 	return SiteIntent.Build;

package/src/plans/constants.ts

@@ -71,4 +71,5 @@ export const PERIOD_LIST = [
 
 export const COST_OVERRIDE_REASONS = {
 	RECENT_PLAN_PRORATION: 'recent-plan-proration',
+	RECENT_DOMAIN_PRORATION: 'recent-domain-proration',
 };

package/src/plans/hooks/test/use-pricing-meta-for-grid-plans.ts

@@ -5,111 +5,130 @@
 /**
  * Default mock implementations
  */
-jest.mock( '@wordpress/data' );
-jest.mock( '@automattic/data-stores', () => ( {
-	Plans: {
-		usePlans: jest.fn(),
-		useSitePlans: jest.fn(),
-		useIntroOffers: jest.fn(),
-		useCurrentPlan: jest.fn(),
-	},
-	Purchases: {
-		useSitePurchaseById: jest.fn(),
-	},
+jest.mock( '@wordpress/data', () => ( {
+	useSelect: jest.fn(),
+	combineReducers: jest.fn(),
+	createReduxStore: jest.fn(),
+	createSelector: jest.fn(),
+	register: jest.fn(),
+	useDispatch: jest.fn(),
 } ) );
-
 jest.mock( '../../', () => ( {
 	usePlans: jest.fn(),
 	useSitePlans: jest.fn(),
 	useIntroOffers: jest.fn(),
 	useCurrentPlan: jest.fn(),
 } ) );
-
+jest.mock( '../../../add-ons', () => ( {
+	useStorageAddOns: jest.fn(),
+} ) );
 jest.mock( '../../../purchases', () => ( {
 	useSitePurchaseById: jest.fn(),
 } ) );
+jest.mock( '../../../wpcom-plans-ui', () => ( {
+	store: 'wpcom-plans-ui',
+} ) );
 
-import { PLAN_PERSONAL, PLAN_PREMIUM } from '@automattic/calypso-products';
+import { PLAN_PERSONAL, PLAN_BUSINESS } from '@automattic/calypso-products';
+import { useSelect } from '@wordpress/data';
 import * as Plans from '../../';
+import * as AddOns from '../../../add-ons';
+import { ADD_ON_50GB_STORAGE } from '../../../add-ons/constants';
+import { STORAGE_ADD_ONS_MOCK } from '../../../add-ons/mocks';
 import * as Purchases from '../../../purchases';
+import * as WpcomPlansUI from '../../../wpcom-plans-ui';
+import { COST_OVERRIDE_REASONS } from '../../constants';
 import usePricingMetaForGridPlans from '../use-pricing-meta-for-grid-plans';
 
+const siteId = 100;
+const SITE_PLANS = {
+	[ PLAN_BUSINESS ]: {
+		expiry: null,
+		pricing: {
+			billPeriod: 365,
+			currencyCode: 'USD',
+			originalPrice: {
+				full: 500,
+				monthly: 500,
+			},
+			discountedPrice: {
+				full: 250,
+				monthly: 250,
+			},
+		},
+	},
+};
+const PLANS = {
+	[ PLAN_BUSINESS ]: {
+		pricing: {
+			billPeriod: 365,
+			currencyCode: 'USD',
+			originalPrice: {
+				full: 500,
+				monthly: 500,
+			},
+			discountedPrice: {
+				full: 400,
+				monthly: 400,
+			},
+		},
+	},
+};
+const introOffer = {
+	formattedPrice: '$150',
+	rawPrice: {
+		monthly: 12.5,
+		full: 150,
+	},
+	isOfferComplete: false,
+	intervalUnit: 'year',
+	intervalCount: 1,
+};
+const useCheckPlanAvailabilityForPurchase = () => {
+	return {
+		[ PLAN_BUSINESS ]: true,
+		[ PLAN_PERSONAL ]: true,
+	};
+};
+
 describe( 'usePricingMetaForGridPlans', () => {
 	beforeEach( () => {
 		jest.clearAllMocks();
 		Purchases.useSitePurchaseById.mockImplementation( () => undefined );
 		Plans.useIntroOffers.mockImplementation( () => ( {
-			[ PLAN_PREMIUM ]: null,
+			[ PLAN_BUSINESS ]: null,
 		} ) );
 		Plans.usePlans.mockImplementation( () => ( {
 			isLoading: false,
-			data: {
-				[ PLAN_PREMIUM ]: {
-					pricing: {
-						billPeriod: 365,
-						currencyCode: 'USD',
-						originalPrice: {
-							full: 500,
-							monthly: 500,
-						},
-						discountedPrice: {
-							full: 400,
-							monthly: 400,
-						},
-					},
-				},
-			},
+			data: PLANS,
 		} ) );
 		Plans.useSitePlans.mockImplementation( () => ( {
 			isLoading: false,
-			data: {
-				[ PLAN_PREMIUM ]: {
-					expiry: null,
-					pricing: {
-						billPeriod: 365,
-						currencyCode: 'USD',
-						originalPrice: {
-							full: 500,
-							monthly: 500,
-						},
-						discountedPrice: {
-							full: 250,
-							monthly: 250,
-						},
-						costOverrides: [
-							{
-								overrideCode: 'recent-plan-proration',
-							},
-						],
-					},
-				},
-			},
+			data: SITE_PLANS,
 		} ) );
 		Plans.useCurrentPlan.mockImplementation( () => undefined );
+		AddOns.useStorageAddOns.mockImplementation( () => STORAGE_ADD_ONS_MOCK );
+	} );
+
+	afterAll( () => {
+		jest.clearAllMocks();
 	} );
 
 	it( 'should return the original price as the site plan price and discounted price as Null for the current plan', () => {
 		Plans.useCurrentPlan.mockImplementation( () => ( {
-			productSlug: PLAN_PREMIUM,
-			planSlug: PLAN_PREMIUM,
+			productSlug: PLAN_BUSINESS,
+			planSlug: PLAN_BUSINESS,
 		} ) );
 
-		const useCheckPlanAvailabilityForPurchase = () => {
-			return {
-				[ PLAN_PREMIUM ]: true,
-			};
-		};
-
 		const pricingMeta = usePricingMetaForGridPlans( {
-			planSlugs: [ PLAN_PREMIUM ],
-			storageAddOns: null,
-			siteId: 100,
+			planSlugs: [ PLAN_BUSINESS ],
+			siteId,
 			coupon: undefined,
 			useCheckPlanAvailabilityForPurchase,
 		} );
 
 		const expectedPricingMeta = {
-			[ PLAN_PREMIUM ]: {
+			[ PLAN_BUSINESS ]: {
 				originalPrice: {
 					full: 500,
 					monthly: 500,
@@ -121,7 +140,7 @@ describe( 'usePricingMetaForGridPlans', () => {
 				billingPeriod: 365,
 				currencyCode: 'USD',
 				expiry: null,
-				introOffer: null,
+				introOffer: undefined,
 			},
 		};
 
@@ -130,26 +149,19 @@ describe( 'usePricingMetaForGridPlans', () => {
 
 	it( 'should return the original price as the site plan price and discounted price as Null for plans not available for purchase', () => {
 		Plans.useCurrentPlan.mockImplementation( () => ( {
-			productSlug: PLAN_PREMIUM,
-			planSlug: PLAN_PREMIUM,
+			productSlug: PLAN_BUSINESS,
+			planSlug: PLAN_BUSINESS,
 		} ) );
 
-		const useCheckPlanAvailabilityForPurchase = () => {
-			return {
-				[ PLAN_PREMIUM ]: false,
-			};
-		};
-
 		const pricingMeta = usePricingMetaForGridPlans( {
-			planSlugs: [ PLAN_PREMIUM ],
-			storageAddOns: null,
-			siteId: 100,
+			planSlugs: [ PLAN_BUSINESS ],
+			siteId,
 			coupon: undefined,
 			useCheckPlanAvailabilityForPurchase,
 		} );
 
 		const expectedPricingMeta = {
-			[ PLAN_PREMIUM ]: {
+			[ PLAN_BUSINESS ]: {
 				originalPrice: {
 					full: 500,
 					monthly: 500,
@@ -161,7 +173,7 @@ describe( 'usePricingMetaForGridPlans', () => {
 				billingPeriod: 365,
 				currencyCode: 'USD',
 				expiry: null,
-				introOffer: null,
+				introOffer: undefined,
 			},
 		};
 
@@ -174,15 +186,8 @@ describe( 'usePricingMetaForGridPlans', () => {
 			planSlug: PLAN_PERSONAL,
 		} ) );
 
-		const useCheckPlanAvailabilityForPurchase = () => {
-			return {
-				[ PLAN_PREMIUM ]: true,
-				[ PLAN_PERSONAL ]: true,
-			};
-		};
-
 		const pricingMeta = usePricingMetaForGridPlans( {
-			planSlugs: [ PLAN_PREMIUM ],
+			planSlugs: [ PLAN_BUSINESS ],
 			storageAddOns: null,
 			siteId: undefined,
 			coupon: undefined,
@@ -190,7 +195,7 @@ describe( 'usePricingMetaForGridPlans', () => {
 		} );
 
 		const expectedPricingMeta = {
-			[ PLAN_PREMIUM ]: {
+			[ PLAN_BUSINESS ]: {
 				originalPrice: {
 					full: 500,
 					monthly: 500,
@@ -202,7 +207,7 @@ describe( 'usePricingMetaForGridPlans', () => {
 				billingPeriod: 365,
 				currencyCode: 'USD',
 				expiry: null,
-				introOffer: null,
+				introOffer: undefined,
 			},
 		};
 
@@ -215,24 +220,16 @@ describe( 'usePricingMetaForGridPlans', () => {
 			planSlug: PLAN_PERSONAL,
 		} ) );
 
-		const useCheckPlanAvailabilityForPurchase = () => {
-			return {
-				[ PLAN_PREMIUM ]: true,
-				[ PLAN_PERSONAL ]: true,
-			};
-		};
-
 		const pricingMeta = usePricingMetaForGridPlans( {
-			planSlugs: [ PLAN_PREMIUM ],
-			storageAddOns: null,
-			siteId: 100,
+			planSlugs: [ PLAN_BUSINESS ],
+			siteId,
 			coupon: undefined,
 			useCheckPlanAvailabilityForPurchase,
 			withProratedDiscounts: true,
 		} );
 
 		const expectedPricingMeta = {
-			[ PLAN_PREMIUM ]: {
+			[ PLAN_BUSINESS ]: {
 				originalPrice: {
 					full: 500,
 					monthly: 500,
@@ -244,49 +241,171 @@ describe( 'usePricingMetaForGridPlans', () => {
 				billingPeriod: 365,
 				currencyCode: 'USD',
 				expiry: null,
-				introOffer: null,
+				introOffer: undefined,
 			},
 		};
 
 		expect( pricingMeta ).toEqual( expectedPricingMeta );
 	} );
 
-	it( 'should return the original price and discounted price when site id is passed and withProratedDiscounts is false', () => {
-		Plans.useCurrentPlan.mockImplementation( () => ( {
-			productSlug: PLAN_PERSONAL,
-			planSlug: PLAN_PERSONAL,
-		} ) );
+	it.each( [
+		COST_OVERRIDE_REASONS.RECENT_PLAN_PRORATION,
+		COST_OVERRIDE_REASONS.RECENT_DOMAIN_PRORATION,
+	] )(
+		"should return the original price when site id is passed, cost override reason is '%s', and withProratedDiscounts is false",
+		( overrideCode ) => {
+			Plans.useCurrentPlan.mockImplementation( () => ( {
+				productSlug: PLAN_PERSONAL,
+				planSlug: PLAN_PERSONAL,
+			} ) );
+
+			Plans.useSitePlans.mockImplementation( () => ( {
+				isLoading: false,
+				data: {
+					[ PLAN_BUSINESS ]: {
+						...SITE_PLANS[ PLAN_BUSINESS ],
+						pricing: {
+							...SITE_PLANS[ PLAN_BUSINESS ].pricing,
+							costOverrides: [ { overrideCode } ],
+						},
+					},
+				},
+			} ) );
+
+			const pricingMeta = usePricingMetaForGridPlans( {
+				planSlugs: [ PLAN_BUSINESS ],
+				siteId,
+				coupon: undefined,
+				useCheckPlanAvailabilityForPurchase,
+				withProratedDiscounts: false,
+			} );
 
-		const useCheckPlanAvailabilityForPurchase = () => {
-			return {
-				[ PLAN_PREMIUM ]: true,
-				[ PLAN_PERSONAL ]: true,
+			const expectedPricingMeta = {
+				[ PLAN_BUSINESS ]: {
+					originalPrice: {
+						full: 500,
+						monthly: 500,
+					},
+					discountedPrice: {
+						full: null,
+						monthly: null,
+					},
+					billingPeriod: 365,
+					currencyCode: 'USD',
+					expiry: null,
+					introOffer: undefined,
+				},
 			};
+
+			expect( pricingMeta ).toEqual( expectedPricingMeta );
+		}
+	);
+
+	it( 'should return intro offer when available', () => {
+		Plans.useIntroOffers.mockImplementation( () => ( {
+			[ PLAN_BUSINESS ]: introOffer,
+		} ) );
+		Plans.useSitePlans.mockImplementation( () => ( {
+			isLoading: false,
+			data: {
+				[ PLAN_BUSINESS ]: {
+					...SITE_PLANS[ PLAN_BUSINESS ],
+					pricing: {
+						...SITE_PLANS[ PLAN_BUSINESS ].pricing,
+						introOffer,
+					},
+				},
+			},
+		} ) );
+
+		const pricingMeta = usePricingMetaForGridPlans( {
+			planSlugs: [ PLAN_BUSINESS ],
+			siteId,
+			coupon: undefined,
+			useCheckPlanAvailabilityForPurchase,
+		} );
+
+		const expectedPricingMeta = {
+			[ PLAN_BUSINESS ]: {
+				...SITE_PLANS[ PLAN_BUSINESS ].pricing,
+				billPeriod: undefined,
+				billingPeriod: SITE_PLANS[ PLAN_BUSINESS ].pricing.billPeriod,
+				expiry: null,
+				introOffer,
+			},
 		};
 
+		expect( pricingMeta ).toEqual( expectedPricingMeta );
+	} );
+
+	it( 'should return intro offer pricing and standard pricing adjusted by storage selection', () => {
+		Plans.useIntroOffers.mockImplementation( () => ( {
+			[ PLAN_BUSINESS ]: introOffer,
+		} ) );
+		Plans.useSitePlans.mockImplementation( () => ( {
+			isLoading: false,
+			data: {
+				[ PLAN_BUSINESS ]: {
+					...SITE_PLANS[ PLAN_BUSINESS ],
+					pricing: {
+						...SITE_PLANS[ PLAN_BUSINESS ].pricing,
+						introOffer,
+					},
+				},
+			},
+		} ) );
+		useSelect.mockImplementation( ( selectFunc ) => {
+			const select = ( store ) => {
+				if ( store === WpcomPlansUI.store ) {
+					return {
+						getSelectedStorageOptions: () => ( {
+							[ PLAN_BUSINESS ]: ADD_ON_50GB_STORAGE,
+						} ),
+					};
+				}
+
+				return null;
+			};
+
+			return selectFunc( select );
+		} );
+
 		const pricingMeta = usePricingMetaForGridPlans( {
-			planSlugs: [ PLAN_PREMIUM ],
-			storageAddOns: null,
-			siteId: 100,
+			planSlugs: [ PLAN_BUSINESS ],
+			reflectStorageSelectionInPlanPrices: true,
+			siteId,
 			coupon: undefined,
 			useCheckPlanAvailabilityForPurchase,
-			withProratedDiscounts: false,
 		} );
 
 		const expectedPricingMeta = {
-			[ PLAN_PREMIUM ]: {
+			[ PLAN_BUSINESS ]: {
 				originalPrice: {
-					full: 500,
-					monthly: 500,
+					full:
+						SITE_PLANS[ PLAN_BUSINESS ].pricing.originalPrice.full +
+						STORAGE_ADD_ONS_MOCK[ 0 ].prices.yearlyPrice,
+					monthly:
+						SITE_PLANS[ PLAN_BUSINESS ].pricing.originalPrice.monthly +
+						STORAGE_ADD_ONS_MOCK[ 0 ].prices.monthlyPrice,
 				},
 				discountedPrice: {
-					full: null,
-					monthly: null,
+					full:
+						SITE_PLANS[ PLAN_BUSINESS ].pricing.discountedPrice.full +
+						STORAGE_ADD_ONS_MOCK[ 0 ].prices.yearlyPrice,
+					monthly:
+						SITE_PLANS[ PLAN_BUSINESS ].pricing.discountedPrice.monthly +
+						STORAGE_ADD_ONS_MOCK[ 0 ].prices.monthlyPrice,
 				},
-				billingPeriod: 365,
-				currencyCode: 'USD',
+				billingPeriod: SITE_PLANS[ PLAN_BUSINESS ].pricing.billPeriod,
+				currencyCode: SITE_PLANS[ PLAN_BUSINESS ].pricing.currencyCode,
 				expiry: null,
-				introOffer: null,
+				introOffer: {
+					...introOffer,
+					rawPrice: {
+						monthly: 12.5 + STORAGE_ADD_ONS_MOCK[ 0 ].prices.monthlyPrice,
+						full: 150 + STORAGE_ADD_ONS_MOCK[ 0 ].prices.yearlyPrice,
+					},
+				},
 			},
 		};
 

package/src/plans/hooks/use-current-plan.ts

@@ -7,7 +7,7 @@ interface Props {
 }
 
 const useCurrentPlan = ( { siteId }: Props ): SitePlan | undefined => {
-	const sitePlans = useSitePlans( { siteId } );
+	const sitePlans = useSitePlans( { coupon: undefined, siteId } );
 
 	return useMemo(
 		() =>

package/src/plans/hooks/use-intro-offers.ts

@@ -20,7 +20,7 @@ interface Props {
  * or `undefined` if we haven't observed any metadata yet
  */
 const useIntroOffers = ( { siteId, coupon }: Props ): IntroOffersIndex | undefined => {
-	const sitePlans = useSitePlans( { siteId } );
+	const sitePlans = useSitePlans( { coupon: undefined, siteId } );
 	const plans = usePlans( { coupon } );
 
 	return useMemo( () => {