@automattic/data-stores 2.0.0 → 3.0.1

package/src/domain-suggestions/actions.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import type {
 	DomainSuggestion,
 	DomainSuggestionQuery,

package/src/domain-suggestions/index.ts

@@ -1,18 +1,11 @@
-/**
- * External dependencies
- */
 import { registerStore } from '@wordpress/data';
-
-/**
- * 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 resolvers from './resolvers';
 import * as selectors from './selectors';
 import type { DispatchFromMap, SelectFromMap } from '../mapped-types';
-import { controls } from '../wpcom-request-controls';
 
 export * from './types';
 export * from './constants';

package/src/domain-suggestions/reducer.ts

@@ -1,16 +1,9 @@
-/**
- * External dependencies
- */
-import type { Reducer } from 'redux';
 import { combineReducers } from '@wordpress/data';
-
-/**
- * Internal dependencies
- */
-import type { DomainCategory, DomainSuggestionState, DomainAvailabilities } from './types';
 import { DataStatus } from './constants';
-import type { Action } from './actions';
 import { stringifyDomainQueryObject } from './utils';
+import type { Action } from './actions';
+import type { DomainCategory, DomainSuggestionState, DomainAvailabilities } from './types';
+import type { Reducer } from 'redux';
 
 const initialDomainSuggestionState: DomainSuggestionState = {
 	state: DataStatus.Uninitialized,

package/src/domain-suggestions/resolvers.ts

@@ -1,12 +1,7 @@
-/**
- * External dependencies
- */
-import { stringify } from 'qs';
 import { translate } from 'i18n-calypso';
-
-/**
- * Internal dependencies
- */
+import { stringify } from 'qs';
+import validator from 'validator';
+import { fetchAndParse, wpcomRequest } from '../wpcom-request-controls';
 import {
 	receiveCategories,
 	receiveDomainSuggestionsSuccess,
@@ -14,15 +9,24 @@ import {
 	fetchDomainSuggestions,
 	receiveDomainAvailability,
 } from './actions';
-import { fetchAndParse, wpcomRequest } from '../wpcom-request-controls';
 import { getFormattedPrice } from './utils';
-
 import type { DomainSuggestion, DomainSuggestionQuery } from './types';
 
-export const isAvailable = function* isAvailable( domainName: string ) {
-	const url = `https://public-api.wordpress.com/rest/v1.3/domains/${ encodeURIComponent(
+function getAvailabilityURL( domainName: string ) {
+	return `https://public-api.wordpress.com/rest/v1.3/domains/${ encodeURIComponent(
 		domainName
 	) }/is-available?is_cart_pre_check=true`;
+}
+
+function suggestionsLackThisFQDN( suggestions: DomainSuggestion[], domainName: string ) {
+	return (
+		validator.isFQDN( domainName ) &&
+		! suggestions.some( ( s ) => s.domain_name.toLowerCase() === domainName )
+	);
+}
+
+export const isAvailable = function* isAvailable( domainName: string ) {
+	const url = getAvailabilityURL( domainName );
 
 	try {
 		const { body } = yield fetchAndParse( url );
@@ -40,10 +44,10 @@ export const isAvailable = function* isAvailable( domainName: string ) {
 };
 
 export function* getCategories() {
-	const categories = yield fetchAndParse(
+	const { body } = yield fetchAndParse(
 		'https://public-api.wordpress.com/wpcom/v2/onboarding/domains/categories'
 	);
-	return receiveCategories( categories.body );
+	return receiveCategories( body );
 }
 
 export function* __internalGetDomainSuggestions( queryObject: DomainSuggestionQuery ) {
@@ -54,34 +58,53 @@ export function* __internalGetDomainSuggestions( queryObject: DomainSuggestionQu
 
 	yield fetchDomainSuggestions();
 
-	let suggestions;
 	try {
-		suggestions = yield wpcomRequest( {
+		const suggestions: DomainSuggestion[] = yield wpcomRequest( {
 			apiVersion: '1.1',
 			path: '/domains/suggestions',
 			query: stringify( queryObject ),
 		} );
+
+		if ( ! Array.isArray( suggestions ) ) {
+			// Other internal server errors
+			return receiveDomainSuggestionsError(
+				translate( 'Invalid response from the server' ) as string
+			);
+		}
+
+		// if the query is a FQDN and the results don't have it,
+		// this implies that the user is searching for an unavailable domain name
+		// TODO: query the availability endpoint to find the exact reason why it's unavailable
+		// all the possible responses can be found here https://github.com/Automattic/wp-calypso/blob/trunk/client/lib/domains/registration/availability-messages.js#L40-L390
+		if ( suggestionsLackThisFQDN( suggestions, queryObject.query ) ) {
+			const unavailableSuggestion: DomainSuggestion = {
+				domain_name: queryObject.query,
+				unavailable: true,
+				cost: '',
+				raw_price: 0,
+				currency_code: '',
+			};
+			suggestions.unshift( unavailableSuggestion );
+		}
+
+		const processedSuggestions = suggestions.map( ( suggestion: DomainSuggestion ) => {
+			if ( suggestion.unavailable ) {
+				return suggestion;
+			}
+			return {
+				...suggestion,
+				...( suggestion.raw_price &&
+					suggestion.currency_code && {
+						cost: getFormattedPrice( suggestion.raw_price, suggestion.currency_code ),
+					} ),
+			};
+		} );
+
+		return receiveDomainSuggestionsSuccess( queryObject, processedSuggestions );
 	} catch ( e ) {
 		// e.g. no connection, or JSON parsing error
 		return receiveDomainSuggestionsError(
-			e.message || ( translate( 'Error while fetching server response' ) as string )
+			( e as Error ).message || ( translate( 'Error while fetching server response' ) as string )
 		);
 	}
-
-	if ( ! suggestions || suggestions === '' ) {
-		// Other internal server errors
-		return receiveDomainSuggestionsError(
-			translate( 'Invalid response from the server' ) as string
-		);
-	}
-
-	const processedSuggestions = suggestions.map( ( suggestion: DomainSuggestion ) => ( {
-		...suggestion,
-		...( suggestion.raw_price &&
-			suggestion.currency_code && {
-				cost: getFormattedPrice( suggestion.raw_price, suggestion.currency_code ),
-			} ),
-	} ) );
-
-	return receiveDomainSuggestionsSuccess( queryObject, processedSuggestions );
 }

package/src/domain-suggestions/selectors.ts

@@ -1,12 +1,7 @@
-/**
- * External dependencies
- */
 import { select } from '@wordpress/data';
-
-/**
- * Internal dependencies
- */
 import { STORE_KEY, DataStatus } from './constants';
+import { stringifyDomainQueryObject, normalizeDomainSuggestionQuery } from './utils';
+import type { State } from './reducer';
 import type {
 	DomainAvailability,
 	DomainAvailabilities,
@@ -15,8 +10,6 @@ import type {
 	DomainSuggestionQuery,
 	DomainSuggestionSelectorOptions,
 } from './types';
-import type { State } from './reducer';
-import { stringifyDomainQueryObject, normalizeDomainSuggestionQuery } from './utils';
 
 export const getCategories = ( state: State ): DomainCategory[] => {
 	// Sort domain categories by tier, then by title.

package/src/domain-suggestions/test/reducer.ts

@@ -1,10 +1,6 @@
-/**
- * Internal dependencies
- */
-
+import { DataStatus } from '../constants';
 import { domainSuggestions } from '../reducer';
 import type { DomainSuggestionState, DomainSuggestion } from '../types';
-import { DataStatus } from '../constants';
 
 describe( 'domainSuggestions', () => {
 	const initialTimeStamp = Date.now();

package/src/domain-suggestions/test/selectors.ts

@@ -1,12 +1,5 @@
-/**
- * External dependencies
- */
 import { select, subscribe } from '@wordpress/data';
 import wpcomRequest from 'wpcom-proxy-request';
-
-/**
- * Internal dependencies
- */
 import { register } from '..';
 import { DataStatus } from '../constants';
 

package/src/domain-suggestions/types.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import type { DataStatus } from './constants';
 
 export interface DomainSuggestionQuery {
@@ -140,8 +137,12 @@ export interface DomainSuggestion {
 	 * Whether the domain requires HSTS
 	 */
 	hsts_required?: boolean;
-}
 
+	/**
+	 * Whether the domain is unavailable
+	 */
+	unavailable: boolean;
+}
 export interface DomainCategory {
 	/**
 	 * The domain category title

package/src/domain-suggestions/utils.ts

@@ -1,12 +1,5 @@
-/**
- * External dependencies
- */
-import deterministicStringify from 'fast-json-stable-stringify';
 import formatCurrency from '@automattic/format-currency';
-
-/**
- * Internal dependencies
- */
+import deterministicStringify from 'fast-json-stable-stringify';
 import type { DomainSuggestionQuery, DomainSuggestionSelectorOptions } from './types';
 
 /**
@@ -14,9 +7,8 @@ import type { DomainSuggestionQuery, DomainSuggestionSelectorOptions } from './t
  *
  * @see client/state/domains/suggestions/utils.js
  */
-export const stringifyDomainQueryObject: (
-	q: DomainSuggestionQuery
-) => string = deterministicStringify;
+export const stringifyDomainQueryObject: ( q: DomainSuggestionQuery ) => string =
+	deterministicStringify;
 
 /**
  * Formats the domain suggestion price according to 'format-currency' package rules

package/src/help-center/README.md

@@ -0,0 +1,11 @@
+# Help Center store
+
+This store includes behavior for handling the help center.
+
+## Usage
+
+```js
+import { HelpCenter } from '@automattic/data-stores';
+
+const HELPCENTER_STORE = HelpCenter.register();
+```

package/src/help-center/actions.ts

@@ -0,0 +1,72 @@
+import { SiteDetails } from '../site';
+
+export const setShowHelpCenter = ( show: boolean ) =>
+	( {
+		type: 'HELP_CENTER_SET_SHOW',
+		show,
+	} as const );
+
+export const setDirectlyData = ( data: { isLoaded: boolean; hasSession: boolean } ) =>
+	( {
+		type: 'HELP_CENTER_SET_DIRECTLY_DATA',
+		data,
+	} as const );
+
+export const setSite = ( site: SiteDetails | undefined ) =>
+	( {
+		type: 'HELP_CENTER_SET_SITE',
+		site,
+	} as const );
+
+export const setSubject = ( subject: string ) =>
+	( {
+		type: 'HELP_CENTER_SET_SUBJECT',
+		subject,
+	} as const );
+
+export const setMessage = ( message: string ) =>
+	( {
+		type: 'HELP_CENTER_SET_MESSAGE',
+		message,
+	} as const );
+
+export const setPopup = ( popup: Window ) =>
+	( {
+		type: 'HELP_CENTER_SET_POPUP',
+		popup,
+	} as const );
+
+export const resetPopup = () =>
+	( {
+		type: 'HELP_CENTER_RESET_POPUP',
+	} as const );
+
+export const setUserDeclaredSiteUrl = ( url: string ) =>
+	( {
+		type: 'HELP_CENTER_SET_USER_DECLARED_SITE_URL',
+		url,
+	} as const );
+
+export const setUserDeclaredSite = ( site: SiteDetails | undefined ) =>
+	( {
+		type: 'HELP_CENTER_SET_USER_DECLARED_SITE',
+		site,
+	} as const );
+
+export const resetStore = () =>
+	( {
+		type: 'HELP_CENTER_RESET_STORE',
+	} as const );
+
+export type HelpCenterAction = ReturnType<
+	| typeof setShowHelpCenter
+	| typeof setDirectlyData
+	| typeof setSite
+	| typeof setSubject
+	| typeof resetStore
+	| typeof setMessage
+	| typeof setUserDeclaredSite
+	| typeof setUserDeclaredSiteUrl
+	| typeof resetPopup
+	| typeof setPopup
+>;

package/src/help-center/constants.ts

@@ -0,0 +1 @@
+export const STORE_KEY = 'automattic/help-center';

package/src/help-center/index.ts

@@ -0,0 +1,30 @@
+import { registerStore } from '@wordpress/data';
+import { controls } from '@wordpress/data-controls';
+import * as actions from './actions';
+import { STORE_KEY } from './constants';
+import reducer, { State } from './reducer';
+import * as selectors from './selectors';
+export type { State };
+import type { SelectFromMap, DispatchFromMap } from '../mapped-types';
+
+let isRegistered = false;
+
+export function register(): typeof STORE_KEY {
+	if ( ! isRegistered ) {
+		registerStore< State >( STORE_KEY, {
+			actions,
+			reducer: reducer as any, // eslint-disable-line @typescript-eslint/no-explicit-any
+			controls,
+			selectors,
+			persist: [ 'site' ],
+		} );
+		isRegistered = true;
+	}
+
+	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/help-center/reducer.ts

@@ -0,0 +1,98 @@
+import { combineReducers } from '@wordpress/data';
+import { SiteDetails } from '../site';
+import type { HelpCenterAction } from './actions';
+import type { Reducer } from 'redux';
+
+const showHelpCenter: Reducer< boolean | undefined, HelpCenterAction > = ( state, action ) => {
+	switch ( action.type ) {
+		case 'HELP_CENTER_SET_SHOW':
+			return action.show;
+	}
+	return state;
+};
+
+const directlyData: Reducer<
+	{ isLoaded: boolean; hasSession: boolean } | undefined,
+	HelpCenterAction
+> = ( state, action ) => {
+	switch ( action.type ) {
+		case 'HELP_CENTER_SET_DIRECTLY_DATA':
+			return action.data;
+	}
+	return state;
+};
+
+const site: Reducer< SiteDetails | undefined, HelpCenterAction > = ( state, action ) => {
+	if ( action.type === 'HELP_CENTER_RESET_STORE' ) {
+		return undefined;
+	} else if ( action.type === 'HELP_CENTER_SET_SITE' ) {
+		return action.site;
+	}
+	return state;
+};
+
+const subject: Reducer< string | undefined, HelpCenterAction > = ( state, action ) => {
+	if ( action.type === 'HELP_CENTER_RESET_STORE' ) {
+		return undefined;
+	} else if ( action.type === 'HELP_CENTER_SET_SUBJECT' ) {
+		return action.subject;
+	}
+	return state;
+};
+
+const message: Reducer< string | undefined, HelpCenterAction > = ( state, action ) => {
+	if ( action.type === 'HELP_CENTER_RESET_STORE' ) {
+		return undefined;
+	} else if ( action.type === 'HELP_CENTER_SET_MESSAGE' ) {
+		return action.message;
+	}
+	return state;
+};
+
+const userDeclaredSiteUrl: Reducer< string | undefined, HelpCenterAction > = ( state, action ) => {
+	if ( action.type === 'HELP_CENTER_RESET_STORE' ) {
+		return undefined;
+	} else if ( action.type === 'HELP_CENTER_SET_USER_DECLARED_SITE_URL' ) {
+		return action.url;
+	}
+	return state;
+};
+
+const userDeclaredSite: Reducer< SiteDetails | undefined, HelpCenterAction > = (
+	state,
+	action
+) => {
+	if ( action.type === 'HELP_CENTER_RESET_STORE' ) {
+		return undefined;
+	} else if ( action.type === 'HELP_CENTER_SET_USER_DECLARED_SITE' ) {
+		return action.site;
+	}
+	return state;
+};
+
+const popup: Reducer< Window | undefined, HelpCenterAction > = ( state, action ) => {
+	if ( action.type === 'HELP_CENTER_SET_POPUP' ) {
+		return action.popup;
+	} else if (
+		action.type === 'HELP_CENTER_RESET_POPUP' ||
+		action.type === 'HELP_CENTER_RESET_STORE'
+	) {
+		return undefined;
+	}
+	return state;
+};
+
+const reducer = combineReducers( {
+	directlyData,
+	showHelpCenter,
+	site,
+	subject,
+	message,
+	userDeclaredSite,
+	userDeclaredSiteUrl,
+	popup,
+} );
+
+export type State = ReturnType< typeof reducer >;
+
+export default reducer;

package/src/help-center/selectors.ts

@@ -0,0 +1,10 @@
+import type { State } from './reducer';
+
+export const isHelpCenterShown = ( state: State ) => state.showHelpCenter;
+export const getSite = ( state: State ) => state.site;
+export const getSubject = ( state: State ) => state.subject;
+export const getMessage = ( state: State ) => state.message;
+export const getUserDeclaredSiteUrl = ( state: State ) => state.userDeclaredSiteUrl;
+export const getPopup = ( state: State ) => state.popup;
+export const getDirectly = ( state: State ) => state.directlyData;
+export const getUserDeclaredSite = ( state: State ) => state.userDeclaredSite;

package/src/i18n/actions.ts

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

package/src/i18n/index.ts

@@ -1,18 +1,11 @@
-/**
- * External dependencies
- */
-import { controls } from '@wordpress/data-controls';
 import { registerStore } from '@wordpress/data';
-import type { SelectFromMap, DispatchFromMap } from '../mapped-types';
-
-/**
- * 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 selectors from './selectors';
 import * as resolvers from './resolvers';
+import * as selectors from './selectors';
+import type { SelectFromMap, DispatchFromMap } from '../mapped-types';
 
 export type { State };
 export type { LocalizedLanguageNames } from './types';

package/src/i18n/reducer.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import type { I18nAction } from './actions';
 import type { LocalizedLanguageNames } from './types';
 

package/src/i18n/resolvers.ts

@@ -1,15 +1,12 @@
-/**
- * External dependencies
- */
 import { apiFetch } from '@wordpress/data-controls';
-import type { APIFetchOptions } from '@wordpress/api-fetch';
 import { addQueryArgs } from '@wordpress/url';
-
 import { setLocalizedLanguageNames } from './actions';
 import { LANGUAGE_NAMES_URL } from './constants';
+import type { LocalizedLanguageNames } from './types';
+import type { APIFetchOptions } from '@wordpress/api-fetch';
 
 export function* getLocalizedLanguageNames( locale: string ) {
-	const localizedLanguageNames = yield apiFetch( {
+	const localizedLanguageNames: LocalizedLanguageNames = yield apiFetch( {
 		url: addQueryArgs( LANGUAGE_NAMES_URL, { _locale: locale } ),
 		mode: 'cors',
 	} as APIFetchOptions );

package/src/i18n/selectors.ts

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import type { State } from './reducer';
 import type { LocalizedLanguageNames } from './types';
 

package/src/i18n/test/reducer.js

@@ -1,8 +1,5 @@
-/**
- * Internal dependencies
- */
-import reducer from '../reducer';
 import { setLocalizedLanguageNames } from '../actions';
+import reducer from '../reducer';
 
 describe( 'i18n reducer', () => {
 	describe( 'localizedLanguageNames', () => {

package/src/i18n/test/resolvers.js

@@ -1,15 +1,8 @@
-/**
- * External dependencies
- */
 import { apiFetch } from '@wordpress/data-controls';
 import { addQueryArgs } from '@wordpress/url';
-
-/**
- * Internal dependencies
- */
-import { getLocalizedLanguageNames } from '../resolvers';
 import { setLocalizedLanguageNames } from '../actions';
 import { LANGUAGE_NAMES_URL } from '../constants';
+import { getLocalizedLanguageNames } from '../resolvers';
 
 describe( 'i18n resolvers', () => {
 	describe( 'getLocalizedLanguageNames', () => {

package/src/i18n/test/selectors.js

@@ -1,6 +1,3 @@
-/**
- * Internal dependencies
- */
 import { getLocalizedLanguageNames } from '../selectors';
 
 describe( 'i18n selectors', () => {

package/src/index.ts

@@ -1,22 +1,37 @@
-/**
- * Internal dependencies
- */
 import * as Auth from './auth';
-import * as User from './user';
+import * as AutomatedTransferEligibility from './automated-transfer-eligibility';
 import * as DomainSuggestions from './domain-suggestions';
+import * as HelpCenter from './help-center';
+import * as I18n from './i18n';
+import * as Launch from './launch';
+import * as Onboard from './onboard';
 import persistenceConfigFactory from './persistence-config-factory';
 import * as Plans from './plans';
+import * as ProductsList from './products-list';
+import * as Reader from './reader';
 import * as Site from './site';
+import * as User from './user';
 import * as Verticals from './verticals';
-import * as Launch from './launch';
-import * as WPCOMFeatures from './wpcom-features';
 import * as VerticalsTemplates from './verticals-templates';
-import * as I18n from './i18n';
+import * as WPCOMFeatures from './wpcom-features';
+export { useHappinessEngineersQuery } from './queries/use-happiness-engineers-query';
+export { useHas3PC } from './queries/use-has-3rd-party-cookies';
+export { useSiteAnalysis } from './queries/use-site-analysis';
+export type { AnalysisReport } from './queries/use-site-analysis';
+export { useHasSeenWhatsNewModalQuery } from './queries/use-has-seen-whats-new-modal-query';
+export { useSiteIntent } from './queries/use-site-intent';
+export { useSupportAvailability } from './support-queries/use-support-availability';
+export { useSubmitTicketMutation } from './support-queries/use-submit-support-ticket';
+export { useSubmitForumsMutation } from './support-queries/use-submit-forums-topic';
+export { useStarterDesignsGeneratedQuery } from './starter-designs-queries/use-starter-designs-generated-query';
+export { useSibylQuery } from './support-queries/use-sibyl-query';
+export * from './site/types';
 
 export {
 	Auth,
 	User,
 	DomainSuggestions,
+	HelpCenter,
 	I18n,
 	Site,
 	Verticals,
@@ -24,10 +39,16 @@ export {
 	Plans,
 	Launch,
 	WPCOMFeatures,
+	Reader,
+	Onboard,
 	persistenceConfigFactory,
+	ProductsList,
+	AutomatedTransferEligibility,
 };
 
 /**
  * Helper types
  */
 export * from './mapped-types';
+export { getContextResults } from './contextual-help/contextual-help';
+export type { LinksForSection } from './contextual-help/contextual-help';