@automattic/data-stores 1.0.0-alpha.0 → 3.0.0

package/src/user/test/resolvers.ts

@@ -0,0 +1,88 @@
+/*
+ * These tests shouldn't require the jsdom environment,
+ * but we're waiting for this PR to merge:
+ * https://github.com/WordPress/gutenberg/pull/20486
+ *
+ * @jest-environment jsdom
+ */
+
+import { createResolvers } from '../resolvers';
+
+const { getCurrentUser } = createResolvers( { client_id: '', client_secret: '' } );
+
+describe( 'getCurrentUser', () => {
+	it( 'should return a receiveCurrentUser action object on success', async () => {
+		const apiResponse = {
+			ID: 1,
+			username: 'testusername',
+		};
+
+		const generator = getCurrentUser();
+
+		expect( generator.next().value ).toEqual( {
+			type: 'WPCOM_REQUEST',
+			request: {
+				path: '/me',
+				apiVersion: '1.1',
+			},
+		} );
+
+		const finalResult = generator.next( apiResponse );
+		expect( finalResult.value ).toEqual( {
+			type: 'RECEIVE_CURRENT_USER',
+			currentUser: apiResponse,
+		} );
+
+		expect( finalResult.done ).toBe( true );
+	} );
+
+	it( 'should return a receiveCurrentUserFailed action object on fail', async () => {
+		const apiResponse = {
+			error: 'authorization_required',
+			status: 403,
+			statusCode: 403,
+			name: 'AuthorizationRequiredError',
+			message: 'An active access token must be used to query information about the current user.',
+		};
+
+		const generator = getCurrentUser();
+
+		expect( generator.next().value ).toEqual( {
+			type: 'WPCOM_REQUEST',
+			request: {
+				path: '/me',
+				apiVersion: '1.1',
+			},
+		} );
+
+		const finalResult = generator.throw( apiResponse );
+		expect( finalResult.value ).toEqual( {
+			type: 'RECEIVE_CURRENT_USER_FAILED',
+		} );
+
+		expect( finalResult.done ).toBe( true );
+	} );
+
+	it( 'should return a receiveCurrentUser action object with server rendered currentUser when available', async () => {
+		const serverRenderedUser = {
+			ID: 2,
+			username: 'server-rendered-user',
+			display_name: 'server-rendered-user',
+			language: 'en',
+			localeSlug: 'en',
+			localeVariant: '',
+			locale_variant: '',
+		};
+		window.currentUser = serverRenderedUser;
+
+		const generator = getCurrentUser();
+
+		const finalResult = generator.next();
+		expect( finalResult.value ).toEqual( {
+			type: 'RECEIVE_CURRENT_USER',
+			currentUser: serverRenderedUser,
+		} );
+
+		expect( finalResult.done ).toBe( true );
+	} );
+} );

package/src/user/types.ts

@@ -1,24 +1,35 @@
-/**
- * External dependencies
- */
-
-import { Action } from 'redux';
-
-export const enum ActionType {
-	CREATE_ACCOUNT = 'CREATE_ACCOUNT',
-	RECEIVE_CURRENT_USER = 'RECEIVE_CURRENT_USER',
-	RECEIVE_CURRENT_USER_FAILED = 'RECEIVE_CURRENT_USER_FAILED',
-	FETCH_CURRENT_USER = 'FETCH_CURRENT_USER',
-	RECEIVE_NEW_USER = 'RECEIVE_NEW_USER',
-	RECEIVE_NEW_USER_SUCCESS = 'RECEIVE_NEW_USER',
-	RECEIVE_NEW_USER_FAILED = 'RECEIVE_NEW_USER_FAILED',
-	FETCH_NEW_USER = 'FETCH_NEW_USER',
-}
+import type { Action } from 'redux';
 
 export interface CurrentUser {
 	ID: number;
 	display_name: string;
 	username: string;
+	email: string;
+	/**
+	 * The user's locale slug, e.g. `es`.
+	 */
+	language: string;
+
+	/**
+	 * The bootstraped user's locale slug, e.g. `es`.
+	 */
+	localeSlug: string;
+
+	/**
+	 * The user's locale variant, e.g. `es-mx`.
+	 * If there is no variant, `""` empty string is returned.
+	 */
+	locale_variant: string;
+
+	/**
+	 * The bootstrapped user's locale variant, e.g. `es-mx`.
+	 */
+	localeVariant: string;
+
+	/**
+	 * The user's existing sites count.
+	 */
+	site_count: number;
 }
 
 export interface NewUser {
@@ -34,7 +45,7 @@ export interface NewUserSuccessResponse {
 	username?: string;
 	signup_sandbox_username?: string;
 	user_id?: number;
-	signup_sandbox_user_id?: string;
+	signup_sandbox_user_id?: number;
 }
 
 export interface NewUserErrorResponse {
@@ -53,9 +64,13 @@ export interface CreateAccountParams {
 	is_passwordless?: boolean;
 	signup_flow_name?: string;
 	locale?: string;
+	'g-recaptcha-error'?: string;
+	'g-recaptcha-response'?: string;
 	extra?: {
 		first_name?: string;
 		last_name?: string;
+		username_hint: string | null | undefined;
+		is_anchor_fm_signup?: boolean | undefined;
 	};
 }
 

package/src/verticals/actions.ts

@@ -1,9 +1,8 @@
-/**
- * Internal dependencies
- */
-import { ActionType, Vertical } from './types';
+import type { Vertical } from './types';
 
 export const receiveVerticals = ( verticals: Vertical[] ) => ( {
-	type: ActionType.RECEIVE_VERTICALS as const,
+	type: 'RECEIVE_VERTICALS' as const,
 	verticals,
 } );
+
+export type Action = ReturnType< typeof receiveVerticals >;

package/src/verticals/index.ts

@@ -1,21 +1,14 @@
-/**
- * External dependencies
- */
-import { controls } from '@wordpress/data-controls';
 import { registerStore } from '@wordpress/data';
-
-/**
- * Internal dependencies
- */
+import { controls } from '@wordpress/data-controls';
+import * as actions from './actions';
 import { STORE_KEY } from './constants';
 import reducer, { State } from './reducer';
-import * as actions from './actions';
 import * as resolvers from './resolvers';
 import * as selectors from './selectors';
-import { DispatchFromMap, SelectFromMap } from '../mapped-types';
+import type { DispatchFromMap, SelectFromMap } from '../mapped-types';
 
-export * from './types';
-export { State };
+export type { Vertical } from './types';
+export type { State };
 
 let isRegistered = false;
 export function register(): typeof STORE_KEY {

package/src/verticals/reducer.ts

@@ -1,20 +1,10 @@
-/**
- * External dependencies
- */
-import { Reducer } from 'redux';
 import { combineReducers } from '@wordpress/data';
+import type { Action } from './actions';
+import type { Vertical } from './types';
+import type { Reducer } from 'redux';
 
-/**
- * Internal dependencies
- */
-import { ActionType, Vertical } from './types';
-import * as Actions from './actions';
-
-const verticals: Reducer< Vertical[], ReturnType< typeof Actions[ 'receiveVerticals' ] > > = (
-	state = [],
-	action
-) => {
-	if ( action.type === ActionType.RECEIVE_VERTICALS ) {
+const verticals: Reducer< Vertical[], Action > = ( state = [], action ) => {
+	if ( action.type === 'RECEIVE_VERTICALS' ) {
 		return action.verticals;
 	}
 	return state;

package/src/verticals/resolvers.ts

@@ -1,12 +1,6 @@
-/**
- * External dependencies
- */
 import { apiFetch } from '@wordpress/data-controls';
-
-/**
- * Internal dependencies
- */
 import { receiveVerticals } from './actions';
+import type { Vertical } from './types';
 
 /**
  * Fetch verticals from the verticals endpoint.
@@ -21,7 +15,7 @@ import { receiveVerticals } from './actions';
  */
 export function* getVerticals() {
 	const url = 'https://public-api.wordpress.com/wpcom/v2/verticals';
-	const verticals = yield apiFetch( { url } );
+	const verticals: Vertical[] = yield apiFetch( { url } );
 
 	// @TODO: validate and normalize verticals?
 

package/src/verticals/selectors.ts

@@ -1,7 +1,4 @@
-/**
- * Internal dependencies
- */
-import { State } from './reducer';
+import type { State } from './reducer';
 
 export const getState = ( state: State ) => state;
 export const getVerticals = ( state: State ) => state.verticals;

package/src/verticals/types.ts

@@ -1,13 +1,8 @@
-export const enum ActionType {
-	RECEIVE_VERTICALS = 'RECEIVE_VERTICALS',
-}
-
 /**
  * Representation of well-known verticals
  */
 export interface Vertical {
 	is_user_input_vertical: false;
-
 	vertical_id: string;
 	vertical_slug: string;
 	vertical_name: string;

package/src/verticals-templates/actions.ts

@@ -1,10 +1,9 @@
-/**
- * Internal dependencies
- */
-import { ActionType, Template } from './types';
+import type { Template } from './types';
 
 export const receiveTemplates = ( verticalId: string, templates: Template[] ) => ( {
-	type: ActionType.RECEIVE_TEMPLATES as const,
+	type: 'RECEIVE_TEMPLATES' as const,
 	verticalId,
 	templates,
 } );
+
+export type Action = ReturnType< typeof receiveTemplates >;

package/src/verticals-templates/index.ts

@@ -1,21 +1,14 @@
-/**
- * External dependencies
- */
-import { controls } from '@wordpress/data-controls';
 import { registerStore } from '@wordpress/data';
-
-/**
- * Internal dependencies
- */
+import { controls } from '@wordpress/data-controls';
+import * as actions from './actions';
 import { STORE_KEY } from './constants';
 import reducer, { State } from './reducer';
-import * as actions from './actions';
 import * as resolvers from './resolvers';
 import * as selectors from './selectors';
-import { DispatchFromMap, SelectFromMap } from '../mapped-types';
+import type { DispatchFromMap, SelectFromMap } from '../mapped-types';
 
 export * from './types';
-export { State };
+export type { State };
 
 let isRegistered = false;
 export function register(): typeof STORE_KEY {

package/src/verticals-templates/reducer.ts

@@ -1,20 +1,13 @@
-/**
- * External dependencies
- */
-import { Reducer } from 'redux';
 import { combineReducers } from '@wordpress/data';
+import type { Action } from './actions';
+import type { Template } from './types';
+import type { Reducer } from 'redux';
 
-/**
- * Internal dependencies
- */
-import { ActionType, Template } from './types';
-import * as Actions from './actions';
-
-const templates: Reducer<
-	Record< string, Template[] | undefined >,
-	ReturnType< typeof Actions[ 'receiveTemplates' ] >
-> = ( state = {}, action ) => {
-	if ( action.type === ActionType.RECEIVE_TEMPLATES ) {
+const templates: Reducer< Record< string, Template[] | undefined >, Action > = (
+	state = {},
+	action
+) => {
+	if ( action.type === 'RECEIVE_TEMPLATES' ) {
 		return {
 			...state,
 			[ action.verticalId ]: action.templates,

package/src/verticals-templates/resolvers.ts

@@ -1,18 +1,13 @@
-/**
- * External dependencies
- */
 import { apiFetch } from '@wordpress/data-controls';
-
-/**
- * Internal dependencies
- */
 import { receiveTemplates } from './actions';
+import type { getTemplates as getTemplatesSelector } from './selectors';
+import type { Template } from './types';
 
 export function* getTemplates(
 	// Resolver has the same signature as corresponding selector without the initial state argument
-	verticalId: Parameters< typeof import('./selectors')[ 'getTemplates' ] >[ 1 ]
+	verticalId: Parameters< typeof getTemplatesSelector >[ 1 ]
 ) {
-	const resp = yield apiFetch( {
+	const resp: { templates: Template[] } = yield apiFetch( {
 		url: `https://public-api.wordpress.com/wpcom/v2/verticals/${ verticalId }/templates`,
 	} );
 

package/src/verticals-templates/selectors.ts

@@ -1,7 +1,4 @@
-/**
- * Internal dependencies
- */
-import { State } from './reducer';
+import type { State } from './reducer';
 
 /**
  * Get template suggestions

package/src/verticals-templates/types.ts

@@ -1,7 +1,3 @@
-export const enum ActionType {
-	RECEIVE_TEMPLATES = 'RECEIVE_TEMPLATES',
-}
-
 export interface Template {
 	/**
 	 * Block-editor HTML (includes block style markup)

package/src/wpcom-features/constants.tsx

@@ -0,0 +1 @@
+export const STORE_KEY = 'automattic/wpcom-features';

package/src/wpcom-features/features-data.tsx

@@ -0,0 +1,44 @@
+import * as Plans from '../plans';
+import type { FeatureId, Feature } from './types';
+
+const {
+	TIMELESS_PLAN_PERSONAL,
+	TIMELESS_PLAN_PREMIUM,
+	TIMELESS_PLAN_BUSINESS,
+	TIMELESS_PLAN_ECOMMERCE,
+} = Plans;
+
+export const featuresList: Record< FeatureId, Feature > = {
+	domain: {
+		id: 'domain',
+		minSupportedPlan: TIMELESS_PLAN_PERSONAL,
+	},
+	store: {
+		id: 'store',
+		minSupportedPlan: TIMELESS_PLAN_ECOMMERCE,
+	},
+	seo: {
+		id: 'seo',
+		minSupportedPlan: TIMELESS_PLAN_BUSINESS,
+	},
+	plugins: {
+		id: 'plugins',
+		minSupportedPlan: TIMELESS_PLAN_BUSINESS,
+	},
+	'ad-free': {
+		id: 'ad-free',
+		minSupportedPlan: TIMELESS_PLAN_PERSONAL,
+	},
+	'image-storage': {
+		id: 'image-storage',
+		minSupportedPlan: TIMELESS_PLAN_PREMIUM,
+	},
+	'video-storage': {
+		id: 'video-storage',
+		minSupportedPlan: TIMELESS_PLAN_PREMIUM,
+	},
+	support: {
+		id: 'support',
+		minSupportedPlan: TIMELESS_PLAN_BUSINESS,
+	},
+};

package/src/wpcom-features/index.ts

@@ -0,0 +1,30 @@
+import { registerStore } from '@wordpress/data';
+import { controls } from '@wordpress/data-controls';
+import { STORE_KEY } from './constants';
+import reducer, { State } from './reducer';
+import * as selectors from './selectors';
+import type { SelectFromMap } from '../mapped-types';
+import type { Reducer, AnyAction } from 'redux';
+
+export type { State };
+export type { FeatureId, Feature } from './types';
+
+export { featuresList } from './features-data';
+
+let isRegistered = false;
+
+export function register(): typeof STORE_KEY {
+	if ( ! isRegistered ) {
+		isRegistered = true;
+		registerStore< State >( STORE_KEY, {
+			controls,
+			reducer: reducer as Reducer< State, AnyAction >,
+			selectors,
+		} );
+	}
+	return STORE_KEY;
+}
+
+declare module '@wordpress/data' {
+	function select( key: typeof STORE_KEY ): SelectFromMap< typeof selectors >;
+}

package/src/wpcom-features/reducer.ts

@@ -0,0 +1,11 @@
+import { featuresList } from './features-data';
+import type { Feature, FeatureId } from './types';
+import type { AnyAction, Reducer } from 'redux';
+
+export type State = Record< FeatureId, Feature >;
+
+const reducer: Reducer< State, AnyAction > = ( state = featuresList ) => {
+	return state;
+};
+
+export default reducer;

package/src/wpcom-features/selectors.ts

@@ -0,0 +1,24 @@
+import { plansOrder } from '../plans/constants';
+import type { PlanSlug } from '../plans';
+import type { State } from './reducer';
+import type { FeatureId } from './types';
+
+export const getAllFeatures = ( state: State ) => state;
+
+export const getRecommendedPlanSlug = (
+	state: State,
+	selectedFeatures: FeatureId[]
+): PlanSlug | undefined => {
+	const allFeatures = getAllFeatures( state );
+
+	if ( ! selectedFeatures.length ) return undefined;
+
+	return selectedFeatures.reduce( ( currentMinSupportedPlan, featureId ) => {
+		const featureMinSupportedPlan = allFeatures[ featureId ].minSupportedPlan;
+
+		return plansOrder.indexOf( featureMinSupportedPlan as never ) >
+			plansOrder.indexOf( currentMinSupportedPlan as never )
+			? featureMinSupportedPlan
+			: currentMinSupportedPlan;
+	}, allFeatures[ selectedFeatures[ 0 ] ].minSupportedPlan );
+};

package/src/wpcom-features/types.ts

@@ -0,0 +1,16 @@
+import type { PlanSlug } from '../plans';
+
+export type FeatureId =
+	| 'domain'
+	| 'store'
+	| 'seo'
+	| 'plugins'
+	| 'ad-free'
+	| 'image-storage'
+	| 'video-storage'
+	| 'support';
+
+export interface Feature {
+	id: FeatureId;
+	minSupportedPlan: PlanSlug;
+}

package/src/wpcom-request-controls/index.ts

@@ -0,0 +1,59 @@
+import wpcomProxyRequest, {
+	reloadProxy as triggerReloadProxy,
+	requestAllBlogsAccess as triggerRequestAllBlogsAccess,
+} from 'wpcom-proxy-request';
+
+type WpcomProxyRequestOptions = Parameters< typeof wpcomProxyRequest >[ 0 ];
+
+export const wpcomRequest = (
+	request: WpcomProxyRequestOptions
+): { type: 'WPCOM_REQUEST'; request: WpcomProxyRequestOptions } =>
+	( { type: 'WPCOM_REQUEST', request } as const );
+
+/**
+ * Action for performing a fetching using `window.fetch()` and parsing the response body.
+ * It's different from `apiFetch()` from
+ * `@wordpress/data-controls` in that it doesn't use any middleware to add extra parameters.
+ *
+ * @param resource the resource you wish to fetch
+ * @param options request options
+ */
+export const fetchAndParse = (
+	resource: Parameters< Window[ 'fetch' ] >[ 0 ],
+	options?: Parameters< Window[ 'fetch' ] >[ 1 ]
+) =>
+	( {
+		type: 'FETCH_AND_PARSE',
+		resource,
+		options,
+	} as const );
+
+export const reloadProxy = () =>
+	( {
+		type: 'RELOAD_PROXY',
+	} as const );
+
+export const requestAllBlogsAccess = () =>
+	( {
+		type: 'REQUEST_ALL_BLOGS_ACCESS',
+	} as const );
+
+export const wait = ( ms: number ) => ( { type: 'WAIT', ms } as const );
+
+export const controls = {
+	WPCOM_REQUEST: ( { request }: ReturnType< typeof wpcomRequest > ) => wpcomProxyRequest( request ),
+	FETCH_AND_PARSE: async ( { resource, options }: ReturnType< typeof fetchAndParse > ) => {
+		const response = await window.fetch( resource, options );
+
+		return {
+			ok: response.ok,
+			body: await response.json(),
+		};
+	},
+	RELOAD_PROXY: () => {
+		triggerReloadProxy();
+	},
+	REQUEST_ALL_BLOGS_ACCESS: () => triggerRequestAllBlogsAccess(),
+	WAIT: ( { ms }: ReturnType< typeof wait > ) =>
+		new Promise( ( resolve ) => setTimeout( resolve, ms ) ),
+} as const;