@automattic/data-stores 2.0.0 → 3.0.1

package/src/auth/selectors.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import type { State } from './reducer';
 
 export const getErrors = ( state: State ) => state.errors;

package/src/auth/test/actions.ts

@@ -6,9 +6,6 @@
  * @jest-environment jsdom
  */
 
-/**
- * Internal dependencies
- */
 import { createActions } from '../actions';
 import { STORE_KEY } from '../constants';
 

package/src/auth/test/flows.ts

@@ -6,19 +6,12 @@
  * @jest-environment jsdom
  */
 
-/**
- * External dependencies
- */
 import { dispatch, select } from '@wordpress/data';
+import nock from 'nock';
 import { parse } from 'qs';
+import waitForExpect from 'wait-for-expect';
 import wpcomRequest from 'wpcom-proxy-request';
 import 'jest-fetch-mock';
-import nock from 'nock';
-import waitForExpect from 'wait-for-expect';
-
-/**
- * Internal dependencies
- */
 import { register } from '..';
 
 jest.mock( '../constants', () => ( {

package/src/auth/test/reducer.ts

@@ -6,11 +6,8 @@
  * @jest-environment jsdom
  */
 
-/**
- * Internal dependencies
- */
-import { errors, loginFlowState, usernameOrEmail } from '../reducer';
 import { createActions } from '../actions';
+import { errors, loginFlowState, usernameOrEmail } from '../reducer';
 
 const { reset, receiveAuthOptions, clearErrors } = createActions( {
 	client_id: '',

package/src/automated-transfer-eligibility/actions.ts

@@ -0,0 +1,15 @@
+import { TransferEligibility } from './types';
+
+export const receiveTransferEligibility = (
+	transferEligibility: TransferEligibility,
+	siteId: number
+) => ( {
+	type: 'TRANSFER_ELIGIBILITY_RECEIVE' as const,
+	transferEligibility,
+	siteId,
+} );
+
+export type Action =
+	| ReturnType< typeof receiveTransferEligibility >
+	// Type added so we can dispatch actions in tests, but has no runtime cost
+	| { type: 'TEST_ACTION' };

package/src/automated-transfer-eligibility/constants.ts

@@ -0,0 +1,44 @@
+import { StatusMapping } from './types';
+
+export const STORE_KEY = 'automattic/automated-transfer-eligibility';
+
+const eligibilityHolds = {
+	BLOCKED_ATOMIC_TRANSFER: 'BLOCKED_ATOMIC_TRANSFER',
+	TRANSFER_ALREADY_EXISTS: 'TRANSFER_ALREADY_EXISTS',
+	NO_BUSINESS_PLAN: 'NO_BUSINESS_PLAN',
+	NO_JETPACK_SITES: 'NO_JETPACK_SITES',
+	NO_VIP_SITES: 'NO_VIP_SITES',
+	SITE_PRIVATE: 'SITE_PRIVATE',
+	// SITE_UNLAUNCHED is a client constant to differentiate between launched private sites, and unlaunched sites.
+	// See: client/state/data-layer/wpcom/sites/automated-transfer/eligibility/index.js
+	SITE_UNLAUNCHED: 'SITE_UNLAUNCHED',
+	SITE_GRAYLISTED: 'SITE_GRAYLISTED',
+	NON_ADMIN_USER: 'NON_ADMIN_USER',
+	NOT_RESOLVING_TO_WPCOM: 'NOT_RESOLVING_TO_WPCOM',
+	NO_SSL_CERTIFICATE: 'NO_SSL_CERTIFICATE',
+	EMAIL_UNVERIFIED: 'EMAIL_UNVERIFIED',
+	EXCESSIVE_DISK_SPACE: 'EXCESSIVE_DISK_SPACE',
+};
+
+/**
+ * Maps the constants used in the WordPress.com API with
+ * those used inside of Calypso. Somewhat redundant, this
+ * provides safety for when the API changes. We need not
+ * changes the constants in the Calypso side, only here
+ * in the code directly dealing with the API.
+ */
+
+export const statusMapping: StatusMapping = {
+	blocked_atomic_transfer: eligibilityHolds.BLOCKED_ATOMIC_TRANSFER,
+	transfer_already_exists: eligibilityHolds.TRANSFER_ALREADY_EXISTS,
+	no_business_plan: eligibilityHolds.NO_BUSINESS_PLAN,
+	no_jetpack_sites: eligibilityHolds.NO_JETPACK_SITES,
+	no_vip_sites: eligibilityHolds.NO_VIP_SITES,
+	site_private: eligibilityHolds.SITE_PRIVATE,
+	site_graylisted: eligibilityHolds.SITE_GRAYLISTED,
+	non_admin_user: eligibilityHolds.NON_ADMIN_USER,
+	not_resolving_to_wpcom: eligibilityHolds.NOT_RESOLVING_TO_WPCOM,
+	no_ssl_certificate: eligibilityHolds.NO_SSL_CERTIFICATE,
+	email_unverified: eligibilityHolds.EMAIL_UNVERIFIED,
+	excessive_disk_space: eligibilityHolds.EXCESSIVE_DISK_SPACE,
+};

package/src/automated-transfer-eligibility/index.ts

@@ -0,0 +1,33 @@
+import { registerStore } from '@wordpress/data';
+import * as actions from './actions';
+import { STORE_KEY } from './constants';
+import reducer from './reducer';
+import * as resolvers from './resolvers';
+import * as selectors from './selectors';
+import { State } from './types';
+import type { DispatchFromMap, SelectFromMap } from '../mapped-types';
+
+export * from './types';
+export type { State };
+export { STORE_KEY };
+
+let isRegistered = false;
+export function register(): typeof STORE_KEY {
+	if ( ! isRegistered ) {
+		isRegistered = true;
+		registerStore< State >( STORE_KEY, {
+			actions,
+			reducer,
+			resolvers,
+			// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+			// @ts-ignore Until createRegistrySelector is typed correctly
+			selectors,
+		} );
+	}
+	return STORE_KEY;
+}
+
+declare module '@wordpress/data' {
+	function dispatch( key: typeof STORE_KEY ): DispatchFromMap< typeof actions >;
+	function select( key: typeof STORE_KEY ): SelectFromMap< typeof selectors >;
+}

package/src/automated-transfer-eligibility/reducer.ts

@@ -0,0 +1,18 @@
+import { State } from './types';
+import type { Action } from './actions';
+import type { Reducer } from 'redux';
+
+export const transferEligibility: Reducer< State, Action > = ( state = {}, action ) => {
+	switch ( action.type ) {
+		case 'TRANSFER_ELIGIBILITY_RECEIVE': {
+			return {
+				...state,
+				[ action.siteId ]: action.transferEligibility,
+			};
+		}
+	}
+
+	return state;
+};
+
+export default transferEligibility;

package/src/automated-transfer-eligibility/resolvers.ts

@@ -0,0 +1,17 @@
+import wpcomRequest from 'wpcom-proxy-request';
+import { TransferEligibility, Dispatch } from './types';
+
+/**
+ * Requests the site's transfer eligibility from the WPCOM API.
+ *
+ * @param   {number} siteId The id of the site to retrieve
+ */
+export const getAutomatedTransferEligibility =
+	( siteId: number ) =>
+	async ( { dispatch }: Dispatch ) => {
+		const transferEligibility: TransferEligibility = await wpcomRequest( {
+			path: `/sites/${ siteId }/automated-transfers/eligibility`,
+			apiVersion: '1',
+		} );
+		dispatch.receiveTransferEligibility( transferEligibility, siteId );
+	};

package/src/automated-transfer-eligibility/selectors.ts

@@ -0,0 +1,97 @@
+import { createRegistrySelector } from '@wordpress/data';
+import { STORE_KEY, statusMapping } from './constants';
+import {
+	State,
+	TransferEligibilityWarning,
+	TransferEligibilityError,
+	TransferEligibility,
+} from './types';
+
+export const getAutomatedTransferEligibility = (
+	state: State,
+	siteId: number | null
+): TransferEligibility | null => {
+	if ( ! siteId ) {
+		return null;
+	}
+	return state[ siteId ];
+};
+
+export const getEligibilityHolds = createRegistrySelector(
+	( select ) =>
+		( state: State, siteId: number | null ): TransferEligibilityError[] | null => {
+			const transferEligibility = select( STORE_KEY ).getAutomatedTransferEligibility( siteId );
+
+			if ( ! transferEligibility ) {
+				return null;
+			}
+
+			const { errors } = transferEligibility;
+
+			if ( ! errors ) {
+				return null;
+			}
+
+			return errors.map( ( { code } ) => {
+				return statusMapping[ code ] ?? '';
+			} );
+		}
+);
+
+export const getEligibilityWarnings = createRegistrySelector(
+	( select ) =>
+		( state: State, siteId: number | null ): TransferEligibilityWarning[] | null => {
+			const transferEligibility = select( STORE_KEY ).getAutomatedTransferEligibility( siteId );
+
+			if ( ! transferEligibility ) {
+				return null;
+			}
+
+			const { warnings } = transferEligibility;
+
+			if ( ! warnings ) {
+				return null;
+			}
+
+			// combine plugin and theme warnings into one list
+			const combined = Object.values( warnings ).flat();
+
+			return combined.map( ( { description, name, supportUrl, id } ) => ( {
+				id,
+				name,
+				description,
+				supportUrl,
+			} ) );
+		}
+);
+
+export const getNonSubdomainWarnings = createRegistrySelector(
+	( select ) =>
+		( state: State, siteId: number | null ): TransferEligibilityWarning[] | null => {
+			// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+			// @ts-ignore Until createRegistrySelector is typed correctly
+			const eligibilityWarnings = select( STORE_KEY ).getEligibilityWarnings( siteId );
+
+			if ( ! eligibilityWarnings ) {
+				return null;
+			}
+
+			// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+			// @ts-ignore Until createRegistrySelector is typed correctly
+			return eligibilityWarnings?.filter( ( { id } ) => id !== 'wordpress_subdomain' ) ?? null;
+		}
+);
+
+export const getWpcomSubdomainWarning = createRegistrySelector(
+	( select ) =>
+		( state: State, siteId: number | null ): TransferEligibilityWarning | null => {
+			// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+			// @ts-ignore Until createRegistrySelector is typed correctly
+			const eligibilityWarnings = select( STORE_KEY ).getEligibilityWarnings( siteId );
+			// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+			// @ts-ignore Until createRegistrySelector is typed correctly
+			const warning = eligibilityWarnings?.find( ( { id } ) => id === 'wordpress_subdomain' );
+
+			return warning || null;
+		}
+);

package/src/automated-transfer-eligibility/test/reducer.ts

@@ -0,0 +1,60 @@
+import { transferEligibility } from '../reducer';
+import { TransferEligibility } from '../types';
+
+describe( 'reducer', () => {
+	it( 'returns the correct default state', () => {
+		const state = transferEligibility( undefined, { type: 'TEST_ACTION' } );
+		expect( state ).toEqual( {} );
+	} );
+
+	it( 'keys transfer eligibility by site id', () => {
+		let state = {};
+		const expectedTransferEligibility: TransferEligibility = {
+			errors: [],
+			warnings: {
+				plugins: [],
+				widgets: [],
+				subdomain: [],
+			},
+			is_eligible: false,
+		};
+		const updatedExpectedTransferEligibility: TransferEligibility = {
+			errors: [ { code: '1234', message: 'error 1234' } ],
+			warnings: {
+				plugins: [],
+				widgets: [],
+				subdomain: [],
+			},
+			is_eligible: true,
+		};
+
+		state = transferEligibility( state, {
+			type: 'TRANSFER_ELIGIBILITY_RECEIVE',
+			siteId: 1234,
+			transferEligibility: expectedTransferEligibility,
+		} );
+		expect( state ).toEqual( {
+			[ 1234 ]: expectedTransferEligibility,
+		} );
+
+		state = transferEligibility( state, {
+			type: 'TRANSFER_ELIGIBILITY_RECEIVE',
+			siteId: 4321,
+			transferEligibility: expectedTransferEligibility,
+		} );
+		expect( state ).toEqual( {
+			[ 1234 ]: expectedTransferEligibility,
+			[ 4321 ]: expectedTransferEligibility,
+		} );
+
+		state = transferEligibility( state, {
+			type: 'TRANSFER_ELIGIBILITY_RECEIVE',
+			siteId: 1234,
+			transferEligibility: updatedExpectedTransferEligibility,
+		} );
+		expect( state ).toEqual( {
+			[ 1234 ]: updatedExpectedTransferEligibility,
+			[ 4321 ]: expectedTransferEligibility,
+		} );
+	} );
+} );

package/src/automated-transfer-eligibility/types.ts

@@ -0,0 +1,42 @@
+import * as actions from './actions';
+import type { DispatchFromMap } from '../mapped-types';
+
+export interface Dispatch {
+	dispatch: DispatchFromMap< typeof actions >;
+}
+
+export interface TransferEligibilityError {
+	code: string;
+	message: string;
+}
+
+export interface TransferEligibilityWarning {
+	description: string;
+	id: string;
+	name: string;
+	supportUrl: string | undefined;
+}
+
+export interface TransferEligibilityWarningsType {
+	[ index: string ]: TransferEligibilityWarning[];
+
+	plugins: TransferEligibilityWarning[];
+	widgets: TransferEligibilityWarning[];
+	subdomain: TransferEligibilityWarning[];
+}
+
+export interface TransferEligibility {
+	[ index: number ]: TransferEligibility;
+
+	errors: TransferEligibilityError[];
+	is_eligible: boolean;
+	warnings: TransferEligibilityWarningsType;
+}
+
+export type State = {
+	[ key: number ]: TransferEligibility;
+};
+
+export interface StatusMapping {
+	[ key: string ]: any;
+}

package/src/contextual-help/constants.ts

@@ -0,0 +1,13 @@
+export const RESULT_ARTICLE = 'article';
+export const RESULT_TOUR = 'tour';
+export const RESULT_VIDEO = 'video';
+export const VIEW_CONTACT = 'contact';
+export const VIEW_RICH_RESULT = 'richresult';
+export const VIEW_FORUM = 'forums';
+export const SUPPORT_BLOG_ID = 9619154;
+
+export const SUPPORT_TYPE_CONTEXTUAL_HELP = 'contextual_help';
+export const SUPPORT_TYPE_API_HELP = 'api_help';
+export const SUPPORT_TYPE_ADMIN_SECTION = 'admin_section';
+
+export const SELL_INTENT = 'sell_intent';