@automattic/data-stores 2.0.1 → 3.0.0

package/src/onboard/reducer.ts

@@ -0,0 +1,340 @@
+import { combineReducers } from '@wordpress/data';
+import { GoalKey } from './constants';
+import type { DomainSuggestion } from '../domain-suggestions/types';
+import type { FeatureId } from '../wpcom-features/types';
+import type { OnboardAction } from './actions';
+// somewhat hacky, but resolves the circular dependency issue
+import type { Design, FontPair } from '@automattic/design-picker/src/types';
+import type { Reducer } from 'redux';
+
+const domain: Reducer< DomainSuggestion | undefined, OnboardAction > = ( state, action ) => {
+	if ( action.type === 'SET_DOMAIN' ) {
+		return action.domain;
+	}
+	if ( action.type === 'RESET_ONBOARD_STORE' ) {
+		return undefined;
+	}
+	return state;
+};
+
+const domainSearch: Reducer< string, OnboardAction > = ( state = '', action ) => {
+	if ( action.type === 'SET_DOMAIN_SEARCH_TERM' ) {
+		return action.domainSearch;
+	}
+	if ( action.type === 'RESET_ONBOARD_STORE' ) {
+		return '';
+	}
+	return state;
+};
+
+const domainCategory: Reducer< string | undefined, OnboardAction > = ( state, action ) => {
+	if ( action.type === 'SET_DOMAIN_CATEGORY' ) {
+		return action.domainCategory;
+	}
+	if ( action.type === 'RESET_ONBOARD_STORE' ) {
+		return undefined;
+	}
+	return state;
+};
+
+const hasUsedDomainsStep: Reducer< boolean, OnboardAction > = ( state = false, action ) => {
+	if ( action.type === 'SET_HAS_USED_DOMAINS_STEP' ) {
+		return action.hasUsedDomainsStep;
+	}
+	if ( action.type === 'RESET_ONBOARD_STORE' ) {
+		return false;
+	}
+	return state;
+};
+
+const hasUsedPlansStep: Reducer< boolean, OnboardAction > = ( state = false, action ) => {
+	if ( action.type === 'SET_HAS_USED_PLANS_STEP' ) {
+		return action.hasUsedPlansStep;
+	}
+	if ( action.type === 'RESET_ONBOARD_STORE' ) {
+		return false;
+	}
+	return state;
+};
+
+const isRedirecting: Reducer< boolean, OnboardAction > = ( state = false, action ) => {
+	if ( action.type === 'SET_IS_REDIRECTING' ) {
+		return action.isRedirecting;
+	}
+	// This reducer is intentionally not cleared by 'RESET_ONBOARD_STORE' to prevent
+	// a flash of the IntentGathering step after the store is reset.
+	return state;
+};
+
+const planProductId: Reducer< number | undefined, OnboardAction > = ( state, action ) => {
+	if ( action.type === 'SET_PLAN_PRODUCT_ID' ) {
+		return action.planProductId;
+	}
+	if ( action.type === 'RESET_ONBOARD_STORE' ) {
+		return undefined;
+	}
+	return state;
+};
+
+const randomizedDesigns: Reducer< { featured: Design[] }, OnboardAction > = (
+	state = { featured: [] },
+	action
+) => {
+	if ( action.type === 'SET_RANDOMIZED_DESIGNS' ) {
+		return action.randomizedDesigns;
+	}
+	if ( action.type === 'RESET_ONBOARD_STORE' ) {
+		return { featured: [] };
+	}
+	return state;
+};
+
+const selectedFonts: Reducer< FontPair | undefined, OnboardAction > = (
+	state = undefined,
+	action
+) => {
+	if ( action.type === 'SET_FONTS' ) {
+		return action.fonts;
+	}
+	if ( action.type === 'RESET_FONTS' || action.type === 'RESET_ONBOARD_STORE' ) {
+		return undefined;
+	}
+	return state;
+};
+
+const selectedDesign: Reducer< Design | undefined, OnboardAction > = ( state, action ) => {
+	if ( action.type === 'SET_SELECTED_DESIGN' ) {
+		return action.selectedDesign;
+	}
+	if ( action.type === 'RESET_ONBOARD_STORE' ) {
+		return undefined;
+	}
+	return state;
+};
+
+const selectedFeatures: Reducer< FeatureId[], OnboardAction > = (
+	state: FeatureId[] = [],
+	action
+) => {
+	if ( action.type === 'ADD_FEATURE' ) {
+		return [ ...state, action.featureId ];
+	}
+
+	if ( action.type === 'SET_DOMAIN' && action.domain && ! action.domain?.is_free ) {
+		return [ ...state, 'domain' ];
+	}
+
+	if ( action.type === 'SET_DOMAIN' && action.domain?.is_free ) {
+		return state.filter( ( id ) => id !== 'domain' );
+	}
+
+	if ( action.type === 'REMOVE_FEATURE' ) {
+		return state.filter( ( id ) => id !== action.featureId );
+	}
+
+	if ( action.type === 'RESET_ONBOARD_STORE' ) {
+		return [];
+	}
+
+	return state;
+};
+
+const selectedSite: Reducer< number | undefined, OnboardAction > = (
+	state = undefined,
+	action
+) => {
+	if ( action.type === 'SET_SELECTED_SITE' ) {
+		return action.selectedSite;
+	}
+	if ( action.type === 'RESET_ONBOARD_STORE' ) {
+		return undefined;
+	}
+	return state;
+};
+
+const showSignupDialog: Reducer< boolean, OnboardAction > = ( state = false, action ) => {
+	if ( action.type === 'SET_SHOW_SIGNUP_DIALOG' ) {
+		return action.showSignup;
+	}
+	if ( action.type === 'RESET_ONBOARD_STORE' ) {
+		return false;
+	}
+	return state;
+};
+
+const siteTitle: Reducer< string, OnboardAction > = ( state = '', action ) => {
+	if ( action.type === 'SET_SITE_TITLE' ) {
+		return action.siteTitle;
+	}
+	if ( action.type === 'RESET_ONBOARD_STORE' ) {
+		return '';
+	}
+	return state;
+};
+
+const anchorPodcastId: Reducer< string | null, OnboardAction > = ( state = '', action ) => {
+	if ( action.type === 'SET_ANCHOR_PODCAST_ID' ) {
+		return action.anchorPodcastId;
+	}
+	if ( action.type === 'RESET_ONBOARD_STORE' ) {
+		return '';
+	}
+	return state;
+};
+
+const anchorEpisodeId: Reducer< string | null, OnboardAction > = ( state = '', action ) => {
+	if ( action.type === 'SET_ANCHOR_PODCAST_EPISODE_ID' ) {
+		return action.anchorEpisodeId;
+	}
+	if ( action.type === 'RESET_ONBOARD_STORE' ) {
+		return '';
+	}
+	return state;
+};
+
+const anchorSpotifyUrl: Reducer< string | null, OnboardAction > = ( state = '', action ) => {
+	if ( action.type === 'SET_ANCHOR_PODCAST_SPOTIFY_URL' ) {
+		return action.anchorSpotifyUrl;
+	}
+	if ( action.type === 'RESET_ONBOARD_STORE' ) {
+		return '';
+	}
+	return state;
+};
+
+const hasOnboardingStarted: Reducer< boolean, OnboardAction > = ( state = false, action ) => {
+	if ( action.type === 'ONBOARDING_START' ) {
+		return true;
+	}
+	if ( action.type === 'RESET_ONBOARD_STORE' ) {
+		return false;
+	}
+	return state;
+};
+
+const lastLocation: Reducer< string, OnboardAction > = ( state = '', action ) => {
+	if ( action.type === 'SET_LAST_LOCATION' ) {
+		return action.path;
+	}
+	if ( action.type === 'RESET_ONBOARD_STORE' ) {
+		return '';
+	}
+	return state;
+};
+
+const intent: Reducer< string, OnboardAction > = ( state = '', action ) => {
+	if ( action.type === 'SET_INTENT' ) {
+		return action.intent;
+	}
+	if ( action.type === 'RESET_ONBOARD_STORE' ) {
+		return '';
+	}
+	return state;
+};
+
+const startingPoint: Reducer< string, OnboardAction > = ( state = '', action ) => {
+	if ( action.type === 'SET_STARTING_POINT' ) {
+		return action.startingPoint;
+	}
+	if ( action.type === 'RESET_ONBOARD_STORE' ) {
+		return '';
+	}
+	return state;
+};
+
+const storeType: Reducer< string, OnboardAction > = ( state = '', action ) => {
+	if ( action.type === 'SET_STORE_TYPE' ) {
+		return action.storeType;
+	}
+	if ( action.type === 'RESET_ONBOARD_STORE' ) {
+		return '';
+	}
+	return state;
+};
+
+const pendingAction: Reducer< undefined | ( () => Promise< any > ), OnboardAction > = (
+	state,
+	action
+) => {
+	if ( action.type === 'SET_PENDING_ACTION' ) {
+		return action.pendingAction;
+	}
+	if ( action.type === 'RESET_ONBOARD_STORE' ) {
+		return undefined;
+	}
+	return state;
+};
+
+const progress: Reducer< number, OnboardAction > = ( state = -1, action ) => {
+	if ( action.type === 'SET_PROGRESS' ) {
+		return action.progress;
+	}
+	if ( action.type === 'RESET_ONBOARD_STORE' ) {
+		return -1;
+	}
+	return state;
+};
+
+const progressTitle: Reducer< string | undefined, OnboardAction > = ( state, action ) => {
+	if ( action.type === 'SET_PROGRESS_TITLE' ) {
+		return action.progressTitle;
+	}
+	if ( action.type === 'RESET_ONBOARD_STORE' ) {
+		return undefined;
+	}
+	return state;
+};
+
+const stepProgress: Reducer< { count: number; progress: number } | undefined, OnboardAction > = (
+	state,
+	action
+) => {
+	if ( action.type === 'SET_STEP_PROGRESS' ) {
+		return action.stepProgress;
+	}
+	return state;
+};
+
+const goals: Reducer< GoalKey[], OnboardAction > = ( state = [], action ) => {
+	if ( action.type === 'SET_GOALS' ) {
+		return action.goals;
+	}
+	if ( action.type === 'RESET_ONBOARD_STORE' ) {
+		return [];
+	}
+	return state;
+};
+
+const reducer = combineReducers( {
+	anchorPodcastId,
+	anchorEpisodeId,
+	anchorSpotifyUrl,
+	domain,
+	domainSearch,
+	domainCategory,
+	isRedirecting,
+	hasUsedDomainsStep,
+	hasUsedPlansStep,
+	selectedFeatures,
+	storeType,
+	selectedFonts,
+	selectedDesign,
+	selectedSite,
+	siteTitle,
+	showSignupDialog,
+	planProductId,
+	randomizedDesigns,
+	hasOnboardingStarted,
+	lastLocation,
+	intent,
+	startingPoint,
+	pendingAction,
+	progress,
+	progressTitle,
+	stepProgress,
+	goals,
+} );
+
+export type State = ReturnType< typeof reducer >;
+
+export default reducer;

package/src/onboard/selectors.ts

@@ -0,0 +1,48 @@
+import { isGoodDefaultDomainQuery } from '@automattic/domain-utils';
+import type { State } from './reducer';
+export const getAnchorPodcastId = ( state: State ) => state.anchorPodcastId;
+export const getAnchorEpisodeId = ( state: State ) => state.anchorEpisodeId;
+export const getAnchorSpotifyUrl = ( state: State ) => state.anchorSpotifyUrl;
+export const getIsRedirecting = ( state: State ) => state.isRedirecting;
+export const getPlanProductId = ( state: State ) => state.planProductId;
+export const getLastLocation = ( state: State ) => state.lastLocation;
+export const getRandomizedDesigns = ( state: State ) => state.randomizedDesigns;
+export const getSelectedDesign = ( state: State ) => state.selectedDesign;
+export const getSelectedDomain = ( state: State ) => state.domain;
+export const getSelectedFeatures = ( state: State ) => state.selectedFeatures;
+export const getSelectedFonts = ( state: State ) => state.selectedFonts;
+export const getSelectedSite = ( state: State ) => state.selectedSite;
+export const getSelectedSiteTitle = ( state: State ) => state.siteTitle;
+export const getIntent = ( state: State ) => state.intent;
+export const getStartingPoint = ( state: State ) => state.startingPoint;
+export const getStoreType = ( state: State ) => state.storeType;
+export const getPendingAction = ( state: State ) => state.pendingAction;
+export const getProgress = ( state: State ) => state.progress;
+export const getProgressTitle = ( state: State ) => state.progressTitle;
+export const getStepProgress = ( state: State ) => state.stepProgress;
+export const getGoals = ( state: State ) => state.goals;
+export const getState = ( state: State ) => state;
+export const hasPaidDesign = ( state: State ): boolean => {
+	if ( ! state.selectedDesign ) {
+		return false;
+	}
+	return state.selectedDesign.is_premium;
+};
+export const hasPaidDomain = ( state: State ): boolean => {
+	if ( ! state.domain ) {
+		return false;
+	}
+	return ! state.domain.is_free;
+};
+export const hasSiteTitle = ( state: State ) => state.siteTitle.trim().length > 1; // for valid domain results, we need at least 2 characters
+
+// Selectors dependent on other selectors (cannot be put in alphabetical order)
+export const getDomainSearch = ( state: State ) =>
+	state.domainSearch ||
+	( isGoodDefaultDomainQuery( getSelectedSiteTitle( state ) ) && getSelectedSiteTitle( state ) ) ||
+	undefined;
+
+export const hasSelectedDesign = ( state: State ) => !! state.selectedDesign;
+
+export const hasSelectedDesignWithoutFonts = ( state: State ) =>
+	hasSelectedDesign( state ) && ! state.selectedFonts;

package/src/plans/actions.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import type { Plan, PlanFeature, FeaturesByType, PlanProduct } from './types';
 
 type setFeaturesAction = {

package/src/plans/constants.ts

@@ -1,7 +1,3 @@
-/**
- * External dependencies
- */
-
 export const STORE_KEY = 'automattic/onboard/plans';
 
 export const FREE_PLAN_PRODUCT_ID = 1;

package/src/plans/index.ts

@@ -1,18 +1,11 @@
-/**
- * External dependencies
- */
 import { registerStore } from '@wordpress/data';
-import type { SelectFromMap, DispatchFromMap } from '../mapped-types';
-
-/**
- * Internal dependencies
- */
+import { controls } from '../wpcom-request-controls';
+import * as actions from './actions';
 import { STORE_KEY } from './constants';
 import reducer, { State } from './reducer';
-import * as actions from './actions';
-import * as selectors from './selectors';
 import * as resolvers from './resolvers';
-import { controls } from '../wpcom-request-controls';
+import * as selectors from './selectors';
+import type { SelectFromMap, DispatchFromMap } from '../mapped-types';
 
 export type { State };
 export type {

package/src/plans/mock/apis/features.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import type { FeaturesByType } from '../../types';
 
 // Individual Features

package/src/plans/mock/apis/plans.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import * as MockData from '../';
 import type {
 	PricedAPIPlanFree,
@@ -167,34 +164,8 @@ export const API_PLAN_PRICE_PREMIUM_ANNUALLY: MockPricedAPIPlanPaidAnnually = {
 	icon: 'https://s0.wordpress.com/i/store/plan-premium.png',
 	icon_active: 'https://s0.wordpress.com/i/store/plan-premium-active.png',
 	bundle_product_ids: [
-		9,
-		12,
-		45,
-		15,
-		5,
-		49,
-		50,
-		6,
-		46,
-		54,
-		56,
-		57,
-		58,
-		59,
-		60,
-		62,
-		63,
-		64,
-		65,
-		66,
-		67,
-		68,
-		72,
-		73,
-		74,
-		76,
-		75,
-		16,
+		9, 12, 45, 15, 5, 49, 50, 6, 46, 54, 56, 57, 58, 59, 60, 62, 63, 64, 65, 66, 67, 68, 72, 73, 74,
+		76, 75, 16,
 	],
 	bill_period_label: 'per year',
 	price: '€96',

package/src/plans/mock/store/features.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import * as MockData from '../';
 import type { PlanSimplifiedFeature, PlanFeature } from '../../types';
 

package/src/plans/mock/store/plans.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import * as MockData from '../';
 import type { Plan } from '../../types';
 

package/src/plans/mock/store/products.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import type { PlanProduct } from '../../types';
 
 // Plan products

package/src/plans/reducer.ts

@@ -1,14 +1,7 @@
-/**
- * External dependencies
- */
-import type { Reducer } from 'redux';
 import { combineReducers } from '@wordpress/data';
-
-/**
- * Internal dependencies
- */
 import type { PlanAction } from './actions';
 import type { Plan, PlanFeature, FeaturesByType, PlanProduct } from './types';
+import type { Reducer } from 'redux';
 
 // create a Locale type just for code readability
 type Locale = string;

package/src/plans/resolvers.ts

@@ -1,13 +1,15 @@
-/**
- * External dependencies
- */
-import { stringify } from 'qs';
 import formatCurrency from '@automattic/format-currency';
-
-/**
- * Internal dependencies
- */
+import { stringify } from 'qs';
+import { fetchAndParse, wpcomRequest } from '../wpcom-request-controls';
 import { setFeatures, setFeaturesByType, setPlanProducts, setPlans } from './actions';
+import {
+	TIMELESS_PLAN_FREE,
+	TIMELESS_PLAN_PREMIUM,
+	plansProductSlugs,
+	monthlySlugs,
+	annualSlugs,
+	FEATURE_IDS_THAT_REQUIRE_ANNUALLY_BILLED_PLAN,
+} from './constants';
 import type {
 	PricedAPIPlan,
 	APIPlanDetail,
@@ -19,15 +21,6 @@ import type {
 	PlanSlug,
 	DetailsAPIFeature,
 } from './types';
-import {
-	TIMELESS_PLAN_FREE,
-	TIMELESS_PLAN_PREMIUM,
-	plansProductSlugs,
-	monthlySlugs,
-	annualSlugs,
-	FEATURE_IDS_THAT_REQUIRE_ANNUALLY_BILLED_PLAN,
-} from './constants';
-import { fetchAndParse, wpcomRequest } from '../wpcom-request-controls';
 
 const MONTHLY_PLAN_BILLING_PERIOD = 31;
 

package/src/plans/selectors.ts

@@ -1,13 +1,5 @@
-/**
- * External dependencies
- */
 import { select } from '@wordpress/data';
 import deprecate from '@wordpress/deprecated';
-
-/**
- * Internal dependencies
- */
-import type { State } from './reducer';
 import {
 	DEFAULT_PAID_PLAN,
 	TIMELESS_PLAN_ECOMMERCE,
@@ -15,6 +7,7 @@ import {
 	STORE_KEY,
 	FREE_PLAN_PRODUCT_ID,
 } from './constants';
+import type { State } from './reducer';
 import type {
 	Plan,
 	PlanFeature,

package/src/plans/test/actions.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import * as Actions from '../actions';
 import * as MockData from '../mock';
 import { buildPlanFeaturesDict } from '../test-utils';

package/src/plans/test/reducer.ts

@@ -1,9 +1,6 @@
-/**
- * Internal dependencies
- */
-import reducer from '../reducer';
 import { setPlans, setFeaturesByType, setFeatures, setPlanProducts } from '../actions';
 import * as MockData from '../mock';
+import reducer from '../reducer';
 import { buildPlanFeaturesDict } from '../test-utils';
 
 const MOCK_LOCALE = 'test-locale';

package/src/plans/test/resolvers.ts

@@ -1,10 +1,6 @@
-/**
- * Internal dependencies
- */
-import { getSupportedPlans } from '../resolvers';
 import * as MockData from '../mock';
+import { getSupportedPlans } from '../resolvers';
 import { buildPlanFeaturesDict } from '../test-utils';
-
 import type { PricedAPIPlan } from '../types';
 
 // Don't need to mock specific functions for any tests, but mocking

package/src/plans/test/selectors.ts

@@ -1,15 +1,8 @@
-/**
- * External dependencies
- */
 import * as deprecate from '@wordpress/deprecated';
-
-/**
- * Internal dependencies
- */
-import * as Selectors from '../selectors';
+import { TIMELESS_PLAN_ECOMMERCE, TIMELESS_PLAN_FREE, FREE_PLAN_PRODUCT_ID } from '../constants';
 import * as MockData from '../mock';
+import * as Selectors from '../selectors';
 import { buildPlanFeaturesDict } from '../test-utils';
-import { TIMELESS_PLAN_ECOMMERCE, TIMELESS_PLAN_FREE, FREE_PLAN_PRODUCT_ID } from '../constants';
 import type { State } from '../reducer';
 
 // Test data

package/src/plans/test-utils/index.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import type { PlanFeature } from '../types';
 
 export const buildPlanFeaturesDict = (

package/src/plans/types.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import type { plansProductSlugs, plansSlugs } from './constants';
 
 export type StorePlanSlug = typeof plansProductSlugs[ number ];

package/src/products-list/actions.ts

@@ -0,0 +1,23 @@
+import type { ProductsList, ProductsListFailure } from './types';
+
+export const receiveProductsList = ( productsList: ProductsList ) => {
+	return {
+		type: 'PRODUCTS_LIST_RECEIVE' as const,
+		productsList,
+	};
+};
+
+export const requestProductsList = () => ( {
+	type: 'PRODUCTS_LIST_REQUEST' as const,
+} );
+
+export const receiveProductsListFailure = ( error: ProductsListFailure ) => ( {
+	type: 'PRODUCTS_LIST_REQUEST_FAILURE' as const,
+	error,
+} );
+
+export type Action =
+	| ReturnType<
+			typeof receiveProductsList | typeof requestProductsList | typeof receiveProductsListFailure
+	  >
+	| { type: 'TEST_ACTION' };

package/src/products-list/constants.ts

@@ -0,0 +1 @@
+export const STORE_KEY = 'automattic/products-list';