@automattic/plans-grid-next 1.0.0 → 1.0.1

package/src/lib/test/sort-plan-properties.ts

@@ -42,63 +42,81 @@ const planEcommerce = {
 const plansInDefaultOrder = [ planFree, planPersonal, planPremium, planBusiness, planEcommerce ];
 
 describe( 'sortPlans', () => {
-	it( 'should sort plans in descending order of value when current plan slug is personal', () => {
+	it( 'should return an empty array if no plans are provided', () => {
+		expect( sortPlans( [] ) ).toEqual( [] );
+	} );
+
+	it( 'should return the original order if no current plan is specified', () => {
+		expect( sortPlans( plansInDefaultOrder ) ).toEqual( plansInDefaultOrder );
+	} );
+
+	it( 'should return the original order if current plan is null', () => {
+		expect( sortPlans( plansInDefaultOrder, null ) ).toEqual( plansInDefaultOrder );
+	} );
+
+	it( 'should return the original order if current plan is undefined', () => {
+		expect( sortPlans( plansInDefaultOrder, undefined ) ).toEqual( plansInDefaultOrder );
+	} );
+
+	it( 'should return the original order if current plan is not found in the plans array', () => {
+		expect( sortPlans( plansInDefaultOrder, 'non-existent-plan' ) ).toEqual( plansInDefaultOrder );
+	} );
+
+	it( 'should prioritize the current plan when specified', () => {
+		// When personal plan is current
 		expect( sortPlans( plansInDefaultOrder, 'personal-bundle' ) ).toEqual( [
 			planPersonal,
+			planFree,
 			planPremium,
 			planBusiness,
 			planEcommerce,
-			planFree,
 		] );
-	} );
 
-	it( 'should sort plans in descending order of value when current plan slug is ecommerce', () => {
-		expect( sortPlans( plansInDefaultOrder, 'ecommerce-bundle' ) ).toEqual( [
-			planEcommerce,
-			planBusiness,
+		// When premium plan is current
+		expect( sortPlans( plansInDefaultOrder, 'value_bundle' ) ).toEqual( [
 			planPremium,
-			planPersonal,
 			planFree,
-		] );
-	} );
-
-	it( 'should show the popular plan first if current plan slug is empty', () => {
-		expect( sortPlans( plansInDefaultOrder ) ).toEqual( [
-			planPremium,
+			planPersonal,
 			planBusiness,
 			planEcommerce,
-			planPersonal,
-			planFree,
 		] );
-	} );
 
-	it( 'should show the popular plan first when current plan slug is empty', () => {
-		expect( sortPlans( plansInDefaultOrder ) ).toEqual( [
-			planPremium,
+		// When business plan is current
+		expect( sortPlans( plansInDefaultOrder, 'business-bundle' ) ).toEqual( [
 			planBusiness,
-			planEcommerce,
-			planPersonal,
 			planFree,
+			planPersonal,
+			planPremium,
+			planEcommerce,
 		] );
-	} );
 
-	it( 'should show the popular plan first if current plan slug is the free plan', () => {
-		expect( sortPlans( plansInDefaultOrder, 'free_plan' ) ).toEqual( [
-			planPremium,
-			planBusiness,
+		// When ecommerce plan is current
+		expect( sortPlans( plansInDefaultOrder, 'ecommerce-bundle' ) ).toEqual( [
 			planEcommerce,
-			planPersonal,
 			planFree,
+			planPersonal,
+			planPremium,
+			planBusiness,
 		] );
-	} );
 
-	it( 'should show the popular plan second if current plan slug is empty/free and user is on mobile', () => {
-		expect( sortPlans( plansInDefaultOrder, 'free_plan', true ) ).toEqual( [
+		// When free plan is current
+		expect( sortPlans( plansInDefaultOrder, 'free_plan' ) ).toEqual( [
+			planFree,
 			planPersonal,
 			planPremium,
 			planBusiness,
 			planEcommerce,
-			planFree,
 		] );
 	} );
+
+	it( 'should work with a single plan', () => {
+		const singlePlan = [ planFree ];
+		expect( sortPlans( singlePlan, 'free_plan' ) ).toEqual( [ planFree ] );
+	} );
+
+	it( 'should preserve the original array', () => {
+		const originalArray = [ ...plansInDefaultOrder ];
+		sortPlans( plansInDefaultOrder, 'personal-bundle' );
+		expect( plansInDefaultOrder ).toEqual( originalArray );
+	} );
 } );

package/src/types.ts

@@ -104,6 +104,7 @@ export interface CommonGridProps {
 	siteId?: number | null;
 	isInSignup: boolean;
 	isInAdmin: boolean;
+	isInSiteDashboard: boolean;
 	onStorageAddOnClick?: ( addOnSlug: AddOns.StorageAddOnSlug ) => void;
 	currentSitePlanSlug?: string | null;
 	hideUnavailableFeatures?: boolean; // used to hide features that are not available, instead of strike-through as explained in #76206