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

package/src/site/types.ts

@@ -1,6 +1,8 @@
-import type { DispatchFromMap } from '../mapped-types';
-import type { FeatureId } from '../wpcom-features';
+import { SiteGoal } from '../onboard';
+import * as selectors from './selectors';
 import type { ActionCreators } from './actions';
+import type { DispatchFromMap, SelectFromMap } from '../mapped-types';
+import type { FeatureId } from '../shared-types';
 
 export interface Dispatch {
 	dispatch: DispatchFromMap< ActionCreators >;
@@ -69,9 +71,30 @@ export interface CreateSiteParams {
 		wpcom_public_coming_soon?: number;
 		anchor_fm_podcast_id?: string;
 		is_blank_canvas?: boolean;
+		is_videopress_initial_purchase?: boolean;
+		wpcom_admin_interface?: string;
 	};
 }
 
+export interface P2ThumbnailElements {
+	color_link: string;
+	color_sidebar_background: string;
+	header_image: string | null;
+}
+
+export interface SiteFeatures {
+	/**
+	 * We don't have a `FeatureSlug` yet defined globally
+	 * @todo Features are being migrated to calypso-products in other work. Update the type here when one exists
+	 */
+	active: string[];
+	/**
+	 * We don't have a `FeatureSlug` yet defined globally
+	 * @todo Features are being migrated to calypso-products in other work. Update the type here when one exists
+	 */
+	available: Record< string, string[] >;
+}
+
 export interface SiteDetailsPlan {
 	product_id: number;
 	product_slug: string;
@@ -93,114 +116,190 @@ export interface DifmLiteSiteOptions {
 	selected_page_titles: string[];
 }
 
+// is_fse_active && is_fse_eligible properties have been deprecated and removed from SiteDetails interface
 export interface SiteDetails {
 	ID: number;
-	name: string | undefined;
-	description: string;
 	URL: string;
-	launch_status: string;
+	capabilities: SiteDetailsCapabilities;
+	description: string;
+	domain: string;
+	icon?: { ico: string; img: string; media_id: number };
+	is_coming_soon?: boolean;
+	is_multisite?: boolean;
+	is_private?: boolean;
+	is_deleted?: boolean;
+	is_vip?: boolean;
+	is_wpcom_atomic?: boolean;
+	is_wpcom_staging_site?: boolean;
+	is_a4a_client?: boolean;
+	is_a4a_dev_site?: boolean;
 	jetpack: boolean;
-	is_fse_eligible: boolean;
-	is_fse_active: boolean;
+	lang?: string;
+	launch_status: string;
+	locale: string;
 	logo: { id: string; sizes: string[]; url: string };
-	options: {
-		admin_url?: string;
-		advanced_seo_front_page_description?: string;
-		advanced_seo_title_formats?: string[];
-		ak_vp_bundle_enabled?: boolean;
-		allowed_file_types?: string[];
-		anchor_podcast?: boolean;
-		background_color?: boolean;
-		blog_public?: number;
-		created_at?: Date;
-		default_category?: number;
-		default_comment_status?: boolean;
-		default_likes_enabled?: boolean;
-		default_ping_status?: boolean;
-		default_post_format?: string;
-		default_sharing_status?: boolean;
-		design_type?: string;
-		difm_lite_site_options?: DifmLiteSiteOptions;
-		editing_toolkit_is_active?: boolean;
-		featured_images_enabled?: boolean;
-		frame_nonce?: string;
-		gmt_offset?: number;
-		header_image?: boolean;
-		headstart_is_fresh?: boolean;
-		headstart?: boolean;
-		image_default_link_type?: string;
-		image_large_height?: number;
-		image_large_width?: number;
-		image_medium_height?: number;
-		image_medium_width?: number;
-		image_thumbnail_crop?: number;
-		image_thumbnail_height?: number;
-		image_thumbnail_width?: number;
-		import_engine?: string;
-		is_automated_transfer?: boolean;
-		is_cloud_eligible?: boolean;
-		is_difm_lite_in_progress?: boolean;
-		is_domain_only?: boolean;
-		is_mapped_domain?: boolean;
-		is_pending_plan?: boolean;
-		is_redirect?: boolean;
-		is_wpcom_atomic?: boolean;
-		is_wpcom_store?: boolean;
-		is_wpforteams_site?: boolean;
-		jetpack_frame_nonce?: string;
-		login_url?: string;
-		p2_hub_blog_id?: number;
-		page_for_posts?: number;
-		page_on_front?: number;
-		permalink_structure?: string;
-		podcasting_archive?: boolean;
-		post_formats?: string[];
-		publicize_permanently_disabled?: boolean;
-		show_on_front?: string;
-		site_intent?: string;
-		site_segment?: string;
-		site_vertical_id?: string;
-		software_version?: string;
-		selected_features?: FeatureId[];
-		theme_slug?: string;
-		timezone?: string;
-		unmapped_url?: string;
-		upgraded_filetypes_enabled?: boolean;
-		verification_services_codes?: string;
-		videopress_enabled?: boolean;
-		videopress_storage_used?: number;
-		was_created_with_blank_canvas_design?: boolean;
-		woocommerce_is_active?: boolean;
-		wordads?: boolean;
-	};
+	name: string | undefined;
+	options?: SiteDetailsOptions;
+	p2_thumbnail_elements?: P2ThumbnailElements | null;
 	plan?: SiteDetailsPlan;
-	capabilities: {
-		edit_pages: boolean;
-		edit_posts: boolean;
-		edit_others_posts: boolean;
-		edit_others_pages: boolean;
-		delete_posts: boolean;
-		delete_others_posts: boolean;
-		edit_theme_options: boolean;
-		edit_users: boolean;
-		list_users: boolean;
-		manage_categories: boolean;
-		manage_options: boolean;
-		moderate_comments: boolean;
-		activate_wordads: boolean;
-		promote_users: boolean;
-		publish_posts: boolean;
-		upload_files: boolean;
-		delete_users: boolean;
-		remove_users: boolean;
-		own_site: boolean;
-		view_hosting: boolean;
-		view_stats: boolean;
-		activate_plugins: boolean;
-	};
+	products?: SiteDetailsPlan[];
+	single_user_site?: boolean;
+	site_owner?: number;
+	slug: string;
+	title: string;
+	visible?: boolean;
+	was_ecommerce_trial?: boolean;
+	was_upgraded_from_trial?: boolean;
+	was_migration_trial?: boolean;
+	was_hosting_trial?: boolean;
+	wpcom_url?: string;
+	user_interactions?: string[];
+
+	// Jetpack computed properties
+	canAutoupdateFiles?: boolean;
+	canUpdateFiles?: boolean;
+	isMainNetworkSite?: boolean;
+	isSecondaryNetworkSite?: boolean;
+
+	// Migration
+	site_migration?: SourceSiteMigrationBase;
 }
 
-export type SiteOption = keyof SiteDetails[ 'options' ];
+export enum SiteCapabilities {
+	ACTIVATE_PLUGINS = 'activate_plugins',
+	ACTIVATE_WORDADS = 'activate_wordads',
+	DELETE_OTHERS_POSTS = 'delete_others_posts',
+	DELETE_USERS = 'delete_users',
+	EDIT_OTHERS_PAGES = 'edit_others_pages',
+	EDIT_OTHERS_POSTS = 'edit_others_posts',
+	EDIT_PAGES = 'edit_pages',
+	EDIT_POSTS = 'edit_posts',
+	EDIT_THEME_OPTIONS = 'edit_theme_options',
+	EDIT_USERS = 'edit_users',
+	LIST_USERS = 'list_users',
+	MANAGE_CATEGORIES = 'manage_categories',
+	MANAGE_OPTIONS = 'manage_options',
+	MODERATE_COMMENTS = 'moderate_comments',
+	OWN_SITE = 'own_site',
+	PROMOTE_USERS = 'promote_users',
+	PUBLISH_POSTS = 'publish_posts',
+	REMOVE_USERS = 'remove_users',
+	UPLOAD_FILES = 'upload_files',
+	VIEW_HOSTING = 'view_hosting',
+	VIEW_STATS = 'view_stats',
+}
+
+export interface SiteDetailsCapabilities {
+	activate_plugins: boolean;
+	activate_wordads: boolean;
+	delete_others_posts: boolean;
+	delete_posts: boolean;
+	delete_users: boolean;
+	edit_others_pages: boolean;
+	edit_others_posts: boolean;
+	edit_pages: boolean;
+	edit_posts: boolean;
+	edit_theme_options: boolean;
+	edit_users: boolean;
+	list_users: boolean;
+	manage_categories: boolean;
+	manage_options: boolean;
+	moderate_comments: boolean;
+	own_site: boolean;
+	promote_users: boolean;
+	publish_posts: boolean;
+	remove_users: boolean;
+	upload_files: boolean;
+	update_plugins: boolean;
+	view_hosting: boolean;
+	view_stats: boolean;
+}
+
+export interface SiteDetailsOptions {
+	admin_url?: string;
+	advanced_seo_front_page_description?: string;
+	advanced_seo_title_formats?: string[];
+	ak_vp_bundle_enabled?: boolean | null;
+	allowed_file_types?: string[];
+	anchor_podcast?: boolean;
+	background_color?: boolean;
+	blog_public?: number;
+	created_at?: string;
+	default_category?: number;
+	default_comment_status?: boolean;
+	default_likes_enabled?: boolean;
+	default_ping_status?: boolean;
+	default_post_format?: string;
+	default_sharing_status?: boolean;
+	design_type?: string | null;
+	editing_toolkit_is_active?: boolean;
+	featured_images_enabled?: boolean;
+	frame_nonce?: string;
+	gmt_offset?: number;
+	header_image?: boolean;
+	headstart?: boolean;
+	headstart_is_fresh?: boolean;
+	image_default_link_type?: string;
+	image_large_height?: number;
+	image_large_width?: number;
+	image_medium_height?: number;
+	image_medium_width?: number;
+	image_thumbnail_crop?: number;
+	image_thumbnail_height?: number;
+	image_thumbnail_width?: number;
+	import_engine?: string | null;
+	is_automated_transfer?: boolean;
+	is_cloud_eligible?: boolean;
+	is_difm_lite_in_progress?: boolean;
+	is_domain_only?: boolean;
+	is_mapped_domain?: boolean;
+	is_pending_plan?: boolean;
+	is_redirect?: boolean;
+	is_wpcom_atomic?: boolean;
+	is_wpcom_simple?: boolean;
+	is_wpcom_store?: boolean;
+	is_wpforteams_site?: boolean;
+	jetpack_connection_active_plugins?: string[];
+	jetpack_frame_nonce?: string;
+	jetpack_version?: string | undefined;
+	login_url?: string;
+	p2_hub_blog_id?: number | null;
+	page_for_posts?: number;
+	page_on_front?: number;
+	permalink_structure?: string;
+	podcasting_archive?: boolean | null;
+	post_formats?: string[];
+	publicize_permanently_disabled?: boolean;
+	selected_features?: FeatureId[];
+	show_on_front?: string;
+	site_intent?: string;
+	site_goals?: SiteGoal[];
+	site_segment?: string | null;
+	site_vertical_id?: string | null;
+	software_version?: string;
+	theme_slug?: string;
+	timezone?: string;
+	unmapped_url?: string;
+	updated_at?: string;
+	upgraded_filetypes_enabled?: boolean;
+	verification_services_codes?: string | null;
+	videopress_enabled?: boolean;
+	videopress_storage_used?: number;
+	was_created_with_blank_canvas_design?: boolean;
+	woocommerce_is_active?: boolean;
+	wordads?: boolean;
+	launchpad_screen?: false | 'off' | 'full' | 'minimized';
+	launchpad_checklist_tasks_statuses?: LaunchPadCheckListTasksStatuses;
+	wpcom_production_blog_id?: number;
+	wpcom_staging_blog_ids?: number[];
+	can_blaze?: boolean;
+	blaze_ads_version?: string;
+	is_commercial?: boolean | null;
+	is_commercial_reasons?: string[];
+	wpcom_admin_interface?: string;
+}
+
+export type SiteOption = keyof NonNullable< SiteDetails[ 'options' ] >;
 
 export interface SiteError {
 	error: string;
@@ -213,33 +312,25 @@ export interface Cart {
 	blog_id: number;
 	cart_key: number;
 	coupon: string;
-	coupon_discounts: unknown[];
-	coupon_discounts_integer: unknown[];
 	is_coupon_applied: boolean;
-	has_bundle_credit: boolean;
 	next_domain_is_free: boolean;
 	next_domain_condition: string;
 	products: unknown[];
 	total_cost: number;
 	currency: string;
-	total_cost_display: string;
 	total_cost_integer: number;
 	temporary: boolean;
 	tax: unknown;
-	sub_total: number;
-	sub_total_display: string;
 	sub_total_integer: number;
 	total_tax: number;
-	total_tax_display: string;
 	total_tax_integer: number;
 	credits: number;
-	credits_display: string;
 	credits_integer: number;
 	allowed_payment_methods: unknown[];
-	create_new_blog: boolean;
 	messages: Record< 'errors' | 'success', unknown >;
 }
 
+/* eslint-disable @typescript-eslint/no-explicit-any */
 export interface Domain {
 	a_records_required_for_mapping?: string[];
 	primary_domain: boolean;
@@ -263,6 +354,7 @@ export interface Domain {
 	private_domain: boolean;
 	partner_domain: boolean;
 	wpcom_domain: boolean;
+	has_pending_contact_update: boolean;
 	has_zone: boolean;
 	is_renewable: boolean;
 	is_redeemable: boolean;
@@ -290,11 +382,14 @@ export interface Domain {
 	bundled_plan_subscription_id?: any;
 	product_slug?: any;
 	owner: string;
+	is_pending_icann_verification?: boolean;
+	is_mapped_to_atomic_site: boolean;
 }
 
 export interface SiteSettings {
 	[ key: string ]: any;
 }
+/* eslint-enable @typescript-eslint/no-explicit-any */
 
 export interface SiteLaunchState {
 	status: SiteLaunchStatus;
@@ -385,6 +480,7 @@ export enum AtomicSoftwareInstallStatus {
 	SUCCESS = 'success',
 	FAILURE = 'failure',
 }
+
 export type AtomicSoftwareInstallState = Record<
 	string,
 	{
@@ -392,9 +488,199 @@ export type AtomicSoftwareInstallState = Record<
 		error: AtomicSoftwareInstallError | undefined;
 	}
 >;
+
 export interface AtomicSoftwareInstallError {
 	name: string;
 	status: number;
 	message: string;
 	code: string;
 }
+
+interface PaletteColor {
+	slug: string;
+	color: string;
+	name: string;
+	default: string;
+}
+
+export interface GlobalStyles {
+	slug?: string;
+	title?: string;
+	settings: {
+		color: {
+			palette: {
+				default: PaletteColor[];
+				theme: PaletteColor[];
+			};
+		};
+	};
+	styles: {
+		[ key: string ]: unknown;
+	};
+}
+
+export interface LaunchPadCheckListTasksStatuses {
+	first_post_published?: boolean;
+	links_edited?: boolean;
+	site_launched?: boolean;
+	site_edited?: boolean;
+	video_uploaded?: boolean;
+	publish_first_course?: boolean;
+	domain_upsell_deferred?: boolean;
+	plan_selected?: boolean;
+	plan_completed?: boolean;
+}
+
+export interface ActiveTheme {
+	stylesheet: string;
+	_links: {
+		'wp:user-global-styles': { href: string }[];
+	};
+	global_styles_id: number | null;
+}
+
+export interface CurrentTheme {
+	id: string;
+}
+
+export type SiteSelect = SelectFromMap< typeof selectors >;
+
+export enum MigrationStatus {
+	UNKNOWN = 'unknown',
+	INACTIVE = 'inactive',
+	NEW = 'new',
+	BACKING_UP = 'backing-up',
+	BACKING_UP_QUEUED = 'backing-up-queued',
+	RESTORING = 'restoring',
+	DONE = 'done',
+	DONE_USER = 'done-user',
+	ERROR = 'error',
+}
+
+export enum MigrationStatusError {
+	OLD_JETPACK = 'old_jetpack',
+	FORBIDDEN = 'forbidden',
+	GENERIC = 'error',
+	SOURCE_SITE_MULTISITE = 'source_site_multisite',
+	SOURCE_SITE_IS_ATOMIC = 'source_site_is_atomic',
+	SOURCE_SITE_IS_PROTECTED = 'source_site_is_protected',
+	TARGET_SITE_IS_PROTECTED = 'target_site_is_protected',
+	NO_START_USER_ADMIN_ON_SOURCE = 'no_start_user_admin_on_source',
+	NO_START_USER_ADMIN_ON_TARGET = 'no_start_user_admin_on_target',
+	NO_START_SOURCE_IN_PROGRESS = 'no_start_source_in_progress',
+	NO_START_TARGET_IN_PROGRESS = 'no_start_target_in_progress',
+	WPCOM_MIGRATION_PLUGIN_INCOMPATIBLE = 'wpcom_migration_plugin_incompatible',
+
+	// Start of migration #1
+	ACTIVATE_REWIND = 'error-rewind-activate',
+	BACKUP_QUEUEING = 'error-backup-queue',
+
+	// Start of backup
+	// eslint-disable-next-line inclusive-language/use-inclusive-words
+	MISSING_SOURCE_MASTER_USER = 'error-get-master-user',
+
+	// During backup
+	NO_BACKUP_STATUS = 'error-backup-status',
+	BACKUP_SITE_NOT_ACCESSIBLE = 'error-backup-fail-not-accessible',
+	BACKUP_UNKNOWN = 'error-backup-fail-unknown',
+
+	// End of backup
+	WOA_GET_TRANSFER_RECORD = 'error-atomic-transfer-get',
+	MISSING_WOA_CREDENTIALS = 'error-credentials-atomic',
+
+	// Start of restore
+	RESTORE_QUEUE = 'error-restore-queue',
+	RESTORE_FAILED = 'error-restore-fail',
+
+	// During restore
+	RESTORE_STATUS = 'error-restore-status',
+
+	// End of restore
+	FIX_EXTERNAL_USER_ID = 'error-fix-external-user-id',
+	GET_SOURCE_EXTERNAL_USER_ID = 'error-get-external-user-id',
+	GET_USER_TOKEN = 'error-get-target-user-token',
+	UPDATE_TARGET_USER_TOKEN = 'error-update-target-user-token',
+
+	// Start of migration #2
+	// End of backup #2
+	WOA_TRANSFER = 'error-atomic-transfer',
+
+	// Miscellanous
+	GENERAL = 'error-general',
+	UNKNOWN = 'error-unknown',
+}
+
+export interface SourceSiteMigrationBase {
+	source_blog_id?: number;
+	error_status?: MigrationStatusError;
+	status: MigrationStatus;
+	last_modified: string;
+	// Migration meta
+	recent_migration?: boolean;
+	failed_backup_source?: boolean;
+	migration_status?: string;
+}
+
+export interface SourceSiteMigrationDetails extends SourceSiteMigrationBase {
+	target_blog_id?: number;
+	site_migration_id: number;
+	percent: number;
+	created: string;
+	is_atomic: boolean;
+	// Statistics
+	backup_percent?: number;
+	backup_size?: number;
+	backup_started?: string;
+	site_size?: number;
+	restore_percent?: number;
+	restore_message?: string;
+	restore_failure?: string;
+	restore_started?: number;
+	comments_count?: number;
+	plugins_count?: number;
+	posts_count?: number;
+	tables_count?: number;
+	themes_count?: number;
+	uploads_count?: number;
+	real_percent?: number;
+	wp_version?: string;
+	// Source site details
+	is_target_blog_admin?: boolean;
+	is_target_blog_upgraded?: boolean;
+	target_blog_slug?: string;
+	// Steps details
+	step?: number;
+	step_name?: string;
+	total_steps?: number;
+}
+
+export interface Page {
+	title: string;
+	content: string;
+}
+
+export interface AssembleSiteOptions {
+	homeHtml?: string;
+	headerHtml?: string;
+	footerHtml?: string;
+	pages?: Page[];
+	globalStyles?: GlobalStyles;
+	canReplaceContent?: boolean;
+	siteSetupOption?: string;
+}
+
+/**
+ * Site media storage from `/sites/[ siteIdOrSlug ]/media-storage` endpoint
+ */
+export interface RawSiteMediaStorage {
+	max_storage_bytes: number;
+	storage_used_bytes: number;
+}
+
+/**
+ * Site media storage transformed for frontend use
+ */
+export interface SiteMediaStorage {
+	maxStorageBytes: number;
+	storageUsedBytes: number;
+}

package/src/site/utils.ts

@@ -0,0 +1,38 @@
+export const createCustomHomeTemplateContent = (
+	stylesheet: string,
+	hasHeader: boolean,
+	hasFooter: boolean,
+	hasSections: boolean,
+	mainHtml = ''
+): string => {
+	const content: string[] = [];
+	if ( hasHeader ) {
+		content.push(
+			`<!-- wp:template-part {"slug":"header","tagName":"header","theme":"${ stylesheet }"} /-->`
+		);
+	}
+
+	if ( hasSections ) {
+		// blockGap":"0" removes the theme blockGap from the main group while allowing users to change it from the editor
+		content.push( `
+<!-- wp:group {"tagName":"main","style":{"spacing":{"blockGap":"0","margin":{"top":"0","bottom":"0"}}}} -->
+	<main class="wp-block-group" style="margin-top:0;margin-bottom:0">
+		${ mainHtml }
+	</main>
+<!-- /wp:group -->` );
+	}
+
+	if ( hasFooter ) {
+		content.push(
+			`<!-- wp:template-part {"slug":"footer","tagName":"footer","theme":"${ stylesheet }","className":"site-footer-container"} /-->`
+		);
+	}
+
+	if ( content.length ) {
+		return content.join( '\n' );
+	}
+
+	// If no layout is selected, return the paragraph block to start with blank content to avoid the StartModal showing.
+	// See https://github.com/WordPress/gutenberg/blob/343fd27a51ae549c013bc30f51f13aad235d0d4a/packages/edit-site/src/components/start-template-options/index.js#L162
+	return '<!-- wp:paragraph --><p></p><!-- /wp:paragraph -->';
+};

package/src/site-reset/index.ts

@@ -0,0 +1,3 @@
+export * from './use-site-reset-content-summary-query';
+export * from './use-site-reset-mutation';
+export * from './use-site-reset-status-query';

package/src/site-reset/test/use-site-reset-mutation.tsx

@@ -0,0 +1,76 @@
+/**
+ * @jest-environment jsdom
+ */
+import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
+import { waitFor } from '@testing-library/dom';
+import { renderHook } from '@testing-library/react';
+import React from 'react';
+import { act } from 'react-dom/test-utils';
+import wpcomRequest from 'wpcom-proxy-request';
+import { useSiteResetMutation } from '../use-site-reset-mutation';
+
+jest.mock( 'wpcom-proxy-request', () => ( {
+	__esModule: true,
+	default: jest.fn(),
+} ) );
+
+describe( 'use-site-reset-mutation hook', () => {
+	beforeEach( () => {
+		jest.clearAllMocks();
+	} );
+
+	test( 'returns success from the api', async () => {
+		const queryClient = new QueryClient( { defaultOptions: { queries: { retry: false } } } );
+		const wrapper = ( { children } ) => (
+			<QueryClientProvider client={ queryClient }>{ children }</QueryClientProvider>
+		);
+
+		const expected = {
+			success: true,
+		};
+
+		( wpcomRequest as jest.Mock ).mockImplementation( () => Promise.resolve( expected ) );
+
+		const { result } = renderHook( () => useSiteResetMutation(), {
+			wrapper,
+		} );
+
+		expect( result.current.isSuccess ).toBe( false );
+
+		act( () => {
+			result.current.resetSite( 123 );
+		} );
+
+		await waitFor( () => {
+			expect( result.current.isSuccess ).toBe( true );
+			expect( result.current.data ).toEqual( expected );
+		} );
+	} );
+
+	test( 'returns failure from the api', async () => {
+		const queryClient = new QueryClient();
+		const wrapper = ( { children } ) => (
+			<QueryClientProvider client={ queryClient }>{ children }</QueryClientProvider>
+		);
+
+		const error = {
+			code: 'Unauthorized',
+			message: 'Something went wrong',
+		};
+
+		( wpcomRequest as jest.Mock ).mockImplementation( () => Promise.reject( error ) );
+
+		const { result } = renderHook( () => useSiteResetMutation(), {
+			wrapper,
+		} );
+
+		act( () => {
+			result.current.resetSite( 123 );
+		} );
+
+		await waitFor( () => {
+			expect( result.current.isError ).toBe( true );
+			expect( result.current.error ).toEqual( error );
+		} );
+	} );
+} );