@automattic/data-stores 3.0.1 → 3.1.0-rc.2

package/src/launch/selectors.ts

@@ -1,86 +0,0 @@
-import { select } from '@wordpress/data';
-import { STORE_KEY as LAUNCH_STORE, PLANS_STORE } from './constants';
-import { LaunchSequence, LaunchStep } from './data';
-import type { Plans } from '..';
-import type * as DomainSuggestions from '../domain-suggestions';
-import type { State } from './reducer';
-import type { LaunchStepType } from './types';
-
-export const getLaunchSequence = (): typeof LaunchSequence => LaunchSequence;
-export const getLaunchStep = (): typeof LaunchStep => LaunchStep;
-
-export const getState = ( state: State ): State => state;
-export const hasPaidDomain = ( state: State ): boolean => {
-	if ( ! state.domain ) {
-		return false;
-	}
-	return ! state.domain.is_free; // @TODO: check if we are ever storing a paid domain
-};
-export const getSelectedDomain = ( state: State ): DomainSuggestions.DomainSuggestion | undefined =>
-	state.domain;
-export const getSelectedPlanProductId = ( state: State ): number | undefined => state.planProductId;
-
-/**
- * This returns the readonly value of the billing period.
- * This value is automatically inferred from the selected paid plan.
- * If the user picks a free plan, this value will remain unchanged and
- * will return the billing period of the previously selected paid plan.
- *
- * @param state the state
- */
-export const getLastPlanBillingPeriod = ( state: State ): Plans.PlanBillingPeriod =>
-	state.planBillingPeriod;
-
-export const isSelectedPlanPaid = ( state: State ): boolean =>
-	typeof state.planProductId !== 'undefined' &&
-	! select( PLANS_STORE ).isPlanProductFree( state.planProductId );
-
-// Check if a domain has been explicitly selected (including free subdomain)
-/**
- * Check if the user has selected a domain, including explicitly selecting the subdomain
- * This is useful for step/flow completion in the context of highlighting steps or enabling Launch button
- *
- * @param state State
- */
-export const hasSelectedDomainOrSubdomain = ( state: State ): boolean =>
-	!! getSelectedDomain( state ) || state.confirmedDomainSelection;
-
-// Completion status of steps is derived from the state of the launch flow
-// Warning: because it's using getEntityRecord it works only inside the editor
-export const isStepCompleted = ( state: State, step: LaunchStepType ): boolean => {
-	if ( step === LaunchStep.Plan ) {
-		return !! getSelectedPlanProductId( state );
-	}
-	if ( step === LaunchStep.Name ) {
-		const site: { title?: string } | undefined = select( 'core' ).getEntityRecord(
-			'root',
-			'site',
-			undefined
-		);
-		return !! site?.title;
-	}
-	if ( step === LaunchStep.Domain ) {
-		return select( LAUNCH_STORE ).hasSelectedDomainOrSubdomain();
-	}
-	return false;
-};
-
-// Check if all steps are completed except the last one
-export const isFlowCompleted = ( state: State ): boolean =>
-	LaunchSequence.slice( 0, LaunchSequence.length - 1 ).every( ( step ) =>
-		isStepCompleted( state, step )
-	);
-
-// Check if at least one step is completed
-export const isFlowStarted = ( state: State ): boolean =>
-	LaunchSequence.some( ( step ) => isStepCompleted( state, step ) );
-
-// Get first incomplete step
-export const getFirstIncompleteStep = ( state: State ): LaunchStepType | undefined =>
-	LaunchSequence.find( ( step ) => ! isStepCompleted( state, step ) );
-
-export const getSiteTitle = ( state: State ): string | undefined => state?.siteTitle;
-
-export const getCurrentStep = ( state: State ): string => state.step;
-
-export const getDomainSearch = ( state: State ): string => state.domainSearch;

package/src/launch/types.ts

@@ -1,4 +0,0 @@
-import type { LaunchStep } from './data';
-import type { ValuesType } from 'utility-types';
-
-export type LaunchStepType = ValuesType< typeof LaunchStep >;

package/src/onboard/persist.ts

@@ -1,3 +0,0 @@
-import persistenceConfigFactory from '../persistence-config-factory';
-
-export default persistenceConfigFactory( 'WP_ONBOARD' );

package/src/persistence-config-factory/index.ts

@@ -1,86 +0,0 @@
-/*
-    Defines the options used for the @wp/data persistence plugin, 
-    which include a persistent storage implementation to add data expiration handling.
-*/
-
-/**
- * Creates a storage config for state persistence
- *
- * @param storageKey Unique key to the storage
- */
-export default function createPersistenceConfig( storageKey: string ) {
-	const PERSISTENCE_INTERVAL = 7 * 24 * 3600000; // days * hours in days * ms in hour
-	const STORAGE_KEY = storageKey;
-	const STORAGE_TS_KEY = storageKey + '_TS';
-
-	// A plain object fallback if localStorage is not available
-	const objStore: { [ key: string ]: string } = {};
-
-	const objStorage: Pick< Storage, 'getItem' | 'setItem' | 'removeItem' > = {
-		getItem( key ) {
-			if ( objStore.hasOwnProperty( key ) ) {
-				return objStore[ key ];
-			}
-
-			return null;
-		},
-		setItem( key, value ) {
-			objStore[ key ] = String( value );
-		},
-		removeItem( key ) {
-			delete objStore[ key ];
-		},
-	};
-
-	// Make sure localStorage support exists
-	const localStorageSupport = (): boolean => {
-		try {
-			window.localStorage.setItem( 'WP_ONBOARD_TEST', '1' );
-			window.localStorage.removeItem( 'WP_ONBOARD_TEST' );
-			return true;
-		} catch ( e ) {
-			return false;
-		}
-	};
-
-	// Choose the right storage implementation
-	const storageHandler = localStorageSupport() ? window.localStorage : objStorage;
-
-	// Persisted data expires after seven days
-	const isNotExpired = ( timestampStr: string ): boolean => {
-		const timestamp = Number( timestampStr );
-		return Boolean( timestamp ) && timestamp + PERSISTENCE_INTERVAL > Date.now();
-	};
-
-	// Check for "fresh" query param
-	const hasFreshParam = (): boolean => {
-		return new URLSearchParams( window.location.search ).has( 'fresh' );
-	};
-
-	// Handle data expiration by providing a storage object override to the @wp/data persistence plugin.
-	const storage: Pick< Storage, 'getItem' | 'setItem' > = {
-		getItem( key ) {
-			const timestamp = storageHandler.getItem( STORAGE_TS_KEY );
-
-			if ( timestamp && isNotExpired( timestamp ) && ! hasFreshParam() ) {
-				return storageHandler.getItem( key );
-			}
-
-			storageHandler.removeItem( STORAGE_KEY );
-			storageHandler.removeItem( STORAGE_TS_KEY );
-
-			return null;
-		},
-		setItem( key, value ) {
-			storageHandler.setItem( STORAGE_TS_KEY, JSON.stringify( Date.now() ) );
-			storageHandler.setItem( key, value );
-		},
-	};
-
-	const persistOptions = {
-		storageKey: STORAGE_KEY,
-		storage,
-	};
-
-	return persistOptions;
-}

package/src/queries/use-has-3rd-party-cookies.ts

@@ -1,42 +0,0 @@
-import { useEffect, useState } from 'react';
-
-/**
- * Cache the result for the entire session, since changing 3PC settings requires a refresh
- */
-let result: boolean | undefined;
-
-/**
- * Calls a widgets.wp.com endpoint from within an iframe to determine whether the user has 3rd party cookies allowed
- *
- * @returns true when cookies are allowed, false when not.
- */
-export function useHas3PC() {
-	const [ hasCookies, setHasCookies ] = useState( Boolean( result ) );
-
-	useEffect( () => {
-		const iframe = document.createElement( 'iframe' );
-
-		function handler( event: MessageEvent ) {
-			const { data } = event;
-			if ( data.type === 'widgets.wp.com-cookie-check' ) {
-				// cache the result
-				result = data.result;
-				setHasCookies( data.result );
-				window.removeEventListener( 'message', handler );
-				iframe.remove();
-			}
-		}
-
-		// only inject the iframe if the result isn't already cached
-		if ( result === undefined ) {
-			iframe.src = 'https://widgets.wp.com/calypso-happychat/check-cookies.html';
-			iframe.style.display = 'none';
-
-			window.addEventListener( 'message', handler );
-			document.body.appendChild( iframe );
-			return () => window.removeEventListener( 'message', handler );
-		}
-	}, [] );
-
-	return { hasCookies, isLoading: result === undefined };
-}

package/src/queries/use-has-seen-whats-new-modal-query.ts

@@ -1,68 +0,0 @@
-import { useCallback } from 'react';
-import { useQuery, useQueryClient, useMutation } from 'react-query';
-import wpcomRequest from 'wpcom-proxy-request';
-
-interface HasSeenWhatsNewModal {
-	hasSeenWhatsNewModal: boolean;
-}
-
-interface HasSeenWhatsNewModalResult {
-	has_seen_whats_new_modal: boolean;
-}
-
-interface UpdateError {
-	message: string;
-	error: string;
-}
-
-export const useHasSeenWhatsNewModalQuery = ( siteId: number | null ) => {
-	const queryKey = 'has-seen-whats-new-modal';
-
-	const { data, isLoading } = useQuery< { has_seen_whats_new_modal: boolean } >(
-		queryKey,
-		() =>
-			wpcomRequest( {
-				path: `/sites/${ siteId }/block-editor/has-seen-whats-new-modal`,
-				apiNamespace: 'wpcom/v2',
-			} ),
-		{
-			enabled: !! siteId,
-			refetchOnWindowFocus: false,
-		}
-	);
-
-	const queryClient = useQueryClient();
-	const mutation = useMutation< HasSeenWhatsNewModalResult, UpdateError, HasSeenWhatsNewModal >(
-		( { hasSeenWhatsNewModal } ) =>
-			wpcomRequest( {
-				path: `/sites/${ siteId }/block-editor/has-seen-whats-new-modal`,
-				apiNamespace: 'wpcom/v2',
-				method: 'post',
-				body: {
-					has_seen_whats_new_modal: hasSeenWhatsNewModal,
-				},
-			} ),
-		{
-			onSuccess( data ) {
-				queryClient.setQueryData( queryKey, {
-					...data,
-				} );
-			},
-		}
-	);
-
-	const { mutateAsync } = mutation;
-
-	const setHasSeenWhatsNewModal = useCallback(
-		( hasSeenWhatsNewModal: boolean ) => {
-			return mutateAsync( { hasSeenWhatsNewModal } );
-		},
-		[ mutateAsync ]
-	);
-
-	return {
-		data,
-		isLoading,
-		setHasSeenWhatsNewModal,
-	};
-};

package/src/queries/use-site-analysis.ts

@@ -1,78 +0,0 @@
-import { useEffect, useState } from 'react';
-import { useDebounce } from 'use-debounce';
-import wpcomRequest from 'wpcom-proxy-request';
-import { SiteDetails } from '../site';
-
-type ResultType = 'WPCOM' | 'WPORG' | 'UNKNOWN' | 'NOT_OWNED_BY_USER' | 'UNKNOWN';
-
-export type AnalysisReport = {
-	result: ResultType;
-	site?: SiteDetails;
-};
-
-type Analysis = {
-	url: string;
-	platform: string;
-	meta: {
-		title: string;
-		favicon: string;
-	};
-	platform_data?: { is_wpcom: boolean };
-};
-
-// a simple way to check if a string is host to save on API calls
-function isHost( string: string | undefined ) {
-	if ( string ) {
-		return string.length > 4 && Boolean( string?.match( /\w{2,}\.\w{2,16}/ ) );
-	}
-	return false;
-}
-
-/**
- * Analyses a site to determine whether its a WPCOM site, and if yes, it would fetch and return the site information (SiteDetails).
- *
- * @param siteURL the site URL
- */
-export function useSiteAnalysis( siteURL: string | undefined ) {
-	const [ analysis, setAnalysis ] = useState< AnalysisReport | undefined >();
-	const [ debouncedSiteUrl ] = useDebounce( siteURL, 500 );
-
-	useEffect( () => {
-		setAnalysis( undefined );
-		if ( ! isHost( debouncedSiteUrl ) ) {
-			return;
-		}
-		if ( debouncedSiteUrl ) {
-			( async () => {
-				try {
-					const analysis = await wpcomRequest< Analysis >( {
-						path: `/imports/analyze-url?site_url=${ encodeURIComponent( debouncedSiteUrl ) }`,
-						apiNamespace: 'wpcom/v2',
-					} );
-
-					if ( analysis.platform_data?.is_wpcom ) {
-						try {
-							// if a wpcom site, get its info
-							const site = await wpcomRequest< SiteDetails >( {
-								path: '/sites/' + encodeURIComponent( debouncedSiteUrl ),
-								apiVersion: '1.1',
-							} );
-							setAnalysis( { site, result: 'WPCOM' } );
-						} catch ( error ) {
-							// wpcom site, but not owned by user
-							setAnalysis( { result: 'NOT_OWNED_BY_USER' } );
-						}
-					} else if ( analysis.platform === 'wordpress' ) {
-						setAnalysis( { result: 'WPORG' } );
-					} else {
-						setAnalysis( { result: 'UNKNOWN' } );
-					}
-				} catch ( error ) {
-					setAnalysis( { result: 'UNKNOWN' } );
-				}
-			} )();
-		}
-	}, [ debouncedSiteUrl ] );
-
-	return { ...analysis, isLoading: ! analysis };
-}

package/src/reader/actions.ts

@@ -1,20 +0,0 @@
-export interface ReaderTeam {
-	slug: string;
-	team: string;
-}
-
-export interface ReaderTeamsResponse {
-	number: number;
-	teams: ReaderTeam[];
-}
-
-export const fetchReaderTeamsSuccess = ( response: ReaderTeamsResponse ) =>
-	( {
-		type: 'FETCH_READER_TEAMS_SUCCESS',
-		response,
-	} as const );
-
-export type ReaderAction =
-	| ReturnType< typeof fetchReaderTeamsSuccess >
-	// Dummy action used during testing
-	| { type: 'DUMMY_ACTION' };

package/src/reader/persist.ts

@@ -1,3 +0,0 @@
-import persistenceConfigFactory from '../persistence-config-factory';
-
-export default persistenceConfigFactory( 'WP_READER' );

package/src/reader/reducer.ts

@@ -1,18 +0,0 @@
-import { combineReducers } from '@wordpress/data';
-import type { ReaderTeam, ReaderAction } from './actions';
-import type { Reducer } from 'redux';
-
-const teams: Reducer< ReaderTeam[] | null, ReaderAction > = ( state = null, action ) => {
-	if ( action.type === 'FETCH_READER_TEAMS_SUCCESS' ) {
-		return action.response.teams;
-	}
-	return state;
-};
-
-const reducer = combineReducers( {
-	teams,
-} );
-
-export type State = ReturnType< typeof reducer >;
-
-export default reducer;

package/src/reader/resolvers.ts

@@ -1,15 +0,0 @@
-import { wpcomRequest } from '../wpcom-request-controls';
-import { fetchReaderTeamsSuccess, ReaderTeamsResponse } from './actions';
-
-export function* isA8cTeamMember(): Generator {
-	try {
-		const response = yield wpcomRequest( {
-			method: 'GET',
-			path: '/read/teams',
-			apiVersion: '1.2',
-		} );
-		yield fetchReaderTeamsSuccess( response as ReaderTeamsResponse );
-	} catch {
-		// Ignore errors
-	}
-}

package/src/reader/selectors.ts

@@ -1,4 +0,0 @@
-import type { State } from './reducer';
-
-export const isA8cTeamMember = ( state: State ): boolean =>
-	!! ( state.teams || [] ).find( ( team ) => team.slug === 'a8c' );

package/src/reader/test/reader-store.test.ts

@@ -1,43 +0,0 @@
-import { dispatch, select } from '@wordpress/data';
-import waitForExpect from 'wait-for-expect';
-import wpcomRequest from 'wpcom-proxy-request';
-import { STORE_KEY } from '../constants';
-import { register } from '../index';
-import readerReducer from '../reducer';
-
-jest.mock( 'wpcom-proxy-request', () => ( {
-	__esModule: true,
-	default: jest.fn(),
-	requestAllBlogsAccess: jest.fn( () => Promise.resolve() ),
-} ) );
-
-beforeAll( () => {
-	register();
-} );
-
-beforeEach( () => {
-	// Reset the store back to default state
-	dispatch( STORE_KEY ).fetchReaderTeamsSuccess( { teams: null } as any );
-} );
-
-test( 'teams state defaults to `null`', () => {
-	const defaultState = readerReducer( undefined, { type: 'DUMMY_ACTION' } );
-	expect( defaultState.teams ).toBe( null );
-} );
-
-test( 'selecting isA8cTeamMember requests teams data from API', async () => {
-	( wpcomRequest as jest.Mock ).mockResolvedValue( {
-		count: 0,
-		teams: [ { name: '', slug: 'a8c' } ],
-	} );
-
-	const isTeamMember = select( STORE_KEY ).isA8cTeamMember();
-
-	// Returns false while response is loading
-	expect( isTeamMember ).toBe( false );
-
-	await waitForExpect( () => {
-		const isTeamMember = select( STORE_KEY ).isA8cTeamMember();
-		expect( isTeamMember ).toBe( true );
-	} );
-} );

package/src/starter-designs-queries/use-starter-designs-generated-query.ts

@@ -1,51 +0,0 @@
-import { stringify } from 'qs';
-import { useQuery, UseQueryResult, QueryOptions } from 'react-query';
-import wpcomRequest from 'wpcom-proxy-request';
-import type { StarterDesignsGenerated, StarterDesignsGeneratedQueryParams } from './types';
-import type { Design } from '@automattic/design-picker/src/types';
-
-interface Options extends QueryOptions< StarterDesignsGenerated[], unknown > {
-	enabled?: boolean;
-}
-
-export function useStarterDesignsGeneratedQuery(
-	queryParams: StarterDesignsGeneratedQueryParams,
-	queryOptions: Options = {}
-): UseQueryResult< Design[] > {
-	return useQuery(
-		[ 'starter-designs-generated', queryParams ],
-		() => fetchStarterDesignsGenerated( queryParams ),
-		{
-			select: ( response: StarterDesignsGenerated[] ) =>
-				response.map( apiStarterDesignsGeneratedToDesign ),
-			refetchOnMount: 'always',
-			staleTime: Infinity,
-			...queryOptions,
-		}
-	);
-}
-
-function fetchStarterDesignsGenerated(
-	queryParams: StarterDesignsGeneratedQueryParams
-): Promise< StarterDesignsGenerated[] > {
-	return wpcomRequest< StarterDesignsGenerated[] >( {
-		apiNamespace: 'wpcom/v2',
-		path: '/starter-designs/generated',
-		query: stringify( queryParams ),
-	} );
-}
-
-function apiStarterDesignsGeneratedToDesign( design: StarterDesignsGenerated ): Design {
-	const { slug, title, recipe } = design;
-
-	return {
-		slug,
-		title,
-		recipe,
-		is_premium: false,
-		categories: [],
-		features: [],
-		template: '',
-		theme: '',
-	};
-}

package/src/support-queries/types.ts

@@ -1,28 +0,0 @@
-interface Availability {
-	presale: boolean;
-	precancellation: boolean;
-}
-
-export interface HappyChatAvailability {
-	locale: string;
-	isUserEligible: boolean;
-	supportLevel:
-		| 'free'
-		| 'personal'
-		| 'personal-with-legacy-chat'
-		| 'premium'
-		| 'pro'
-		| 'business'
-		| 'ecommerce'
-		| 'jetpack-paid'
-		| 'p2-plus';
-	nickname: string;
-	isClosed: boolean;
-	availability: Availability;
-}
-
-export interface OtherSupportAvailability {
-	is_user_eligible_for_upwork: boolean;
-	is_user_eligible_for_kayako: boolean;
-	is_user_eligible_for_directly: boolean;
-}

package/src/support-queries/use-sibyl-query.ts

@@ -1,31 +0,0 @@
-import config from '@automattic/calypso-config';
-import { useQuery } from 'react-query';
-import wpcomRequest from 'wpcom-proxy-request';
-
-type Result = {
-	id: string;
-	title: string;
-	description: string;
-	link: string;
-};
-
-const wpcomSupportBlog = config( 'wpcom_support_blog' ) as string;
-const jetpackSupportBlog = config( 'jetpack_support_blog' ) as string;
-
-export function useSibylQuery( query: string, isJetpackSite: boolean, isAtomic: boolean ) {
-	const site = ! isJetpackSite || isAtomic ? wpcomSupportBlog : jetpackSupportBlog;
-
-	return useQuery< Result[] >(
-		query,
-		async () =>
-			await wpcomRequest( {
-				path: '/help/qanda',
-				apiVersion: '1.1',
-				query: `query=${ encodeURIComponent( query ) }&site=${ encodeURIComponent( site ) }`,
-			} ),
-		{
-			refetchOnWindowFocus: false,
-			keepPreviousData: true,
-		}
-	);
-}

package/src/support-queries/use-submit-forums-topic.ts

@@ -1,56 +0,0 @@
-import { useMutation } from 'react-query';
-import wpcomRequest from 'wpcom-proxy-request';
-import { SiteDetails } from '../site';
-
-type ForumTopic = {
-	site?: SiteDetails;
-	message: string;
-	subject: string;
-	locale: string;
-	hideInfo: boolean;
-	userDeclaredSiteUrl?: string;
-};
-
-type Response = {
-	topic_URL: string;
-};
-
-export function useSubmitForumsMutation() {
-	return useMutation(
-		( { site, message, subject, locale, hideInfo, userDeclaredSiteUrl }: ForumTopic ) => {
-			const blogHelpMessages = [];
-
-			if ( site ) {
-				if ( site.jetpack ) {
-					blogHelpMessages.push( 'WP.com: Unknown' );
-					blogHelpMessages.push( 'Jetpack: Yes' );
-				} else {
-					blogHelpMessages.push( 'WP.com: Yes' );
-				}
-
-				blogHelpMessages.push( 'Correct account: yes' );
-			} else if ( userDeclaredSiteUrl ) {
-				blogHelpMessages.push( `Self-declared URL: ${ userDeclaredSiteUrl }` );
-			}
-
-			const forumMessage = message + '\n\n' + blogHelpMessages.join( '\n' );
-
-			const requestData = {
-				subject,
-				message: forumMessage,
-				locale,
-				client: 'help-center',
-				hide_blog_info: hideInfo,
-				blog_id: site?.ID,
-				blog_url: site?.URL,
-			};
-
-			return wpcomRequest< Response >( {
-				path: '/help/forums/support/topics/new',
-				apiVersion: '1.1',
-				method: 'POST',
-				body: requestData,
-			} );
-		}
-	);
-}

package/src/support-queries/use-submit-support-ticket.ts

@@ -1,21 +0,0 @@
-import { useMutation } from 'react-query';
-import wpcomRequest from 'wpcom-proxy-request';
-
-type Ticket = {
-	subject: string;
-	message: string;
-	locale: string;
-	client: string;
-	is_chat_overflow: boolean;
-};
-
-export function useSubmitTicketMutation() {
-	return useMutation( ( newTicket: Ticket ) =>
-		wpcomRequest( {
-			path: '/help/tickets/kayako/new',
-			apiVersion: '1.1',
-			method: 'POST',
-			body: newTicket,
-		} )
-	);
-}