@automattic/data-stores 3.1.2 → 3.2.1

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

@@ -1,127 +0,0 @@
-import { select, subscribe } from '@wordpress/data';
-import wpcomRequest from 'wpcom-proxy-request';
-import { store } from '..';
-import { DataStatus } from '../constants';
-
-jest.mock( 'wpcom-proxy-request', () => ( {
-	__esModule: true,
-	default: jest.fn(),
-	requestAllBlogsAccess: jest.fn( () => Promise.resolve() ),
-} ) );
-
-const options = {
-	category_slug: undefined,
-	include_dotblogsubdomain: false,
-	include_wordpressdotcom: true,
-	locale: 'en',
-	quantity: 11,
-};
-const apiResponse = [
-	{
-		domain_name: 'test.site',
-		relevance: 1,
-		supports_privacy: true,
-		vendor: 'donuts',
-		match_reasons: [ 'tld-common', 'tld-exact' ],
-		product_id: 78,
-		product_slug: 'dotsite_domain',
-		cost: '$25',
-		raw_price: 25,
-		currency_code: 'USD',
-		unavailable: false,
-	},
-	{
-		domain_name: 'hot-test-site.com',
-		relevance: 1,
-		supports_privacy: true,
-		vendor: 'donuts',
-		match_reasons: [ 'tld-common' ],
-		product_id: 6,
-		product_slug: 'domain_reg',
-		cost: '$18',
-		raw_price: 18,
-		currency_code: 'USD',
-		unavailable: false,
-	},
-];
-
-beforeEach( () => {
-	( wpcomRequest as jest.Mock ).mockReset();
-} );
-
-describe( 'getDomainSuggestions', () => {
-	it( 'resolves the state via an API call and caches the resolver on success', async () => {
-		( wpcomRequest as jest.Mock ).mockResolvedValue( apiResponse );
-
-		const query = 'test query one';
-		const listenForStateUpdate = () => {
-			return new Promise< void >( ( resolve ) => {
-				const unsubscribe = subscribe( () => {
-					unsubscribe();
-					resolve();
-				} );
-			} );
-		};
-
-		// Status should be uninitialized before first call
-		expect( select( store ).getDomainState() ).toEqual( DataStatus.Uninitialized );
-
-		// First call returns undefined
-		expect( select( store ).getDomainSuggestions( query, options ) ).toEqual( undefined );
-
-		await listenForStateUpdate();
-
-		// Status should be pending while we wait for the response
-		expect( select( store ).getDomainState() ).toEqual( DataStatus.Pending );
-
-		await listenForStateUpdate();
-
-		// Status should be successful once we get the response
-		expect( select( store ).getDomainState() ).toEqual( DataStatus.Success );
-
-		// By the second call, the resolver will have resolved
-		expect( select( store ).getDomainSuggestions( query, options ) ).toEqual( apiResponse );
-
-		await listenForStateUpdate();
-
-		// The resolver should now be cached with an `isStarting` value of false
-
-		expect(
-			select( 'core/data' ).isResolving( store, 'getDomainSuggestions', [ query, options ] )
-		).toEqual( false );
-	} );
-} );
-
-describe( 'getDomainErrorMessage', () => {
-	it( 'should return null if no error message', () => {
-		expect( select( store ).getDomainErrorMessage() ).toEqual( null );
-	} );
-
-	it( 'should return correct error message if no suggestions are returned', async () => {
-		( wpcomRequest as jest.Mock ).mockResolvedValue( null );
-
-		const query = 'test query two';
-		const listenForStateUpdate = () => {
-			return new Promise< void >( ( resolve ) => {
-				const unsubscribe = subscribe( () => {
-					unsubscribe();
-					resolve();
-				} );
-			} );
-		};
-
-		// The error message should start off as a null value
-		expect( select( store ).getDomainErrorMessage() ).toBeFalsy();
-
-		// First call returns undefined
-		select( store ).getDomainSuggestions( query, options );
-		await listenForStateUpdate();
-
-		// By the second call, the resolver will have resolved
-		select( store ).getDomainSuggestions( query, options );
-		await listenForStateUpdate();
-
-		// The promise resolves null suggestions so we should now have an error message
-		expect( select( store ).getDomainErrorMessage() ).toBeTruthy();
-	} );
-} );

package/src/domain-suggestions/types.ts

@@ -1,254 +0,0 @@
-import type { DataStatus } from './constants';
-
-export interface DomainSuggestionQuery {
-	/**
-	 * True to include .blog subdomain suggestions
-	 * @example
-	 * example.photo.blog
-	 */
-	include_dotblogsubdomain: boolean;
-
-	/**
-	 * True to include WordPress.com subdomain suggestions
-	 * @example
-	 * example.wordpress.com
-	 */
-	include_wordpressdotcom: boolean;
-
-	/**
-	 * True to include domains registered with wpcom in the response
-	 */
-	include_internal_move_eligible?: boolean;
-
-	/**
-	 * Localizes domain results, e.g., price format
-	 */
-	locale?: string;
-
-	/**
-	 * True to only provide a wordpress.com subdomain
-	 * @example
-	 * example.wordpress.com
-	 */
-	only_wordpressdotcom: boolean;
-
-	/**
-	 * Desired number of results
-	 */
-	quantity: number;
-
-	/**
-	 * Domain search term
-	 */
-	query: string;
-
-	recommendation_context?: string;
-
-	/**
-	 * Vendor
-	 */
-	vendor: string;
-
-	/**
-	 * The vertical id or slug
-	 */
-	vertical?: string;
-
-	/**
-	 * An array of tlds
-	 */
-	tlds?: readonly string[];
-
-	/**
-	 * Domain category slug
-	 */
-	category_slug?: string;
-}
-
-export type DomainName = string;
-
-export interface DomainSuggestion {
-	/**
-	 * The domain name
-	 * @example "example.com"
-	 */
-	domain_name: DomainName;
-
-	/**
-	 * Rendered formatted cost
-	 * @example "Free" or "€15.00"
-	 */
-	cost: string;
-
-	/**
-	 * Raw price
-	 * @example 40
-	 */
-	raw_price: number;
-
-	/**
-	 * Currency code
-	 * @example USD
-	 */
-	currency_code: string;
-
-	/**
-	 * Relevance as a percent: 0 <= relevance <= 1
-	 * @example 0.9
-	 */
-	relevance?: number;
-
-	/**
-	 * Whether the domain supports privacy
-	 */
-	supports_privacy?: boolean;
-
-	/**
-	 * The domain vendor
-	 */
-	vendor?: string;
-
-	/**
-	 * Reasons for suggestion the domain
-	 * @example [ "exact-match" ]
-	 */
-	match_reasons?: readonly string[];
-
-	/**
-	 * The product ID
-	 */
-	product_id?: number;
-
-	/**
-	 * The product slug
-	 */
-	product_slug?: string;
-
-	/**
-	 * Whether the domain is free
-	 */
-	is_free?: boolean;
-
-	/**
-	 * Whether the domain requires HSTS
-	 */
-	hsts_required?: boolean;
-
-	/**
-	 * Whether the domain requires to show the notice for .gay tld
-	 */
-	is_dot_gay_notice_required?: boolean;
-
-	/**
-	 * Whether the domain is unavailable
-	 */
-	unavailable: boolean;
-
-	isRecommended?: boolean;
-	isBestAlternative?: boolean;
-	is_premium?: boolean;
-}
-export interface DomainCategory {
-	/**
-	 * The domain category title
-	 */
-	title: string;
-
-	/**
-	 * The domain category slug
-	 */
-	slug: string;
-
-	/**
-	 * The domain category tier
-	 */
-	tier: number | null;
-}
-
-export interface DomainAvailability {
-	/**
-	 * The domain name the availability was checked for.
-	 */
-	domain_name: string;
-
-	/**
-	 * The mappability status of the domain.
-	 */
-	mappable: string;
-
-	/**
-	 * The availability status of the domain.
-	 */
-	status: string;
-
-	/**
-	 * Whether the domain supports privacy.
-	 */
-	supports_privacy: boolean;
-
-	/**
-	 * ID of the product
-	 */
-	product_id?: number;
-
-	/**
-	 * The product slug
-	 */
-	product_slug?: string;
-
-	/**
-	 * Rendered cost with currency
-	 * @example "€15.00"
-	 */
-	cost?: string;
-
-	/**
-	 * Vendor
-	 */
-	vendor?: string;
-
-	/**
-	 * Whether the domain requires HSTS
-	 */
-	hsts_required?: boolean;
-
-	/**
-	 * Whether the domain requires to show the notice for .gay tld
-	 */
-	is_dot_gay_notice_required?: boolean;
-}
-
-export type TimestampMS = ReturnType< typeof Date.now >;
-
-export type DomainSuggestions = Record< string, DomainSuggestion[] | undefined >;
-
-export interface DomainSuggestionState {
-	/**
-	 * The state of the DomainSuggestions e.g. pending, failure etc
-	 */
-	state: DataStatus;
-
-	/**
-	 * Domain suggestion data typically returned from the API
-	 */
-	data: DomainSuggestions;
-
-	/**
-	 * Error message
-	 */
-	errorMessage: string | null;
-
-	/**
-	 * Timestamp from last updated attempt
-	 */
-	lastUpdated: TimestampMS;
-
-	/**
-	 * Pending timestamp
-	 */
-	pendingSince: TimestampMS | undefined;
-}
-
-export type DomainAvailabilities = Record< string, DomainAvailability | undefined >;
-
-export type DomainSuggestionSelectorOptions = Partial< Exclude< DomainSuggestionQuery, 'query' > >;

package/src/domain-suggestions/utils.ts

@@ -1,50 +0,0 @@
-import { formatCurrency } from '@automattic/number-formatters';
-import deterministicStringify from 'fast-json-stable-stringify';
-import type { DomainSuggestionQuery, DomainSuggestionSelectorOptions } from './types';
-
-/**
- * Stable transform to an object key for storage and access.
- */
-export const stringifyDomainQueryObject: ( q: DomainSuggestionQuery ) => string =
-	deterministicStringify;
-
-/**
- * Formats the domain suggestion price according to 'format-currency' package rules
- * We use this for consistency in prices formats across plans and domains
- * @param price the domain suggestion raw price
- * @param currencyCode the currency code to be used when formatting price
- */
-export function getFormattedPrice( price: number, currencyCode: string ): string {
-	return formatCurrency( price, currencyCode, {
-		stripZeros: true,
-	} ) as string;
-}
-
-/**
- * Normalize domain query
- *
- * It's important to have a consistent, reproduceable representation of a domains query so that the result can be
- * stored and retrieved.
- * @param search       Domain search string
- * @param queryOptions Optional paramaters for the query
- * @returns Normalized query object
- */
-export function normalizeDomainSuggestionQuery(
-	search: string,
-	queryOptions: DomainSuggestionSelectorOptions
-): DomainSuggestionQuery {
-	return {
-		// Defaults
-		include_wordpressdotcom: queryOptions.only_wordpressdotcom || false,
-		include_dotblogsubdomain: false,
-		only_wordpressdotcom: false,
-		quantity: 5,
-		vendor: 'variation2_front',
-
-		// Merge options
-		...queryOptions,
-
-		// Add the search query
-		query: search.trim().toLocaleLowerCase(),
-	};
-}

package/src/reader/contexts/unsubscribed-feeds-search.tsx

@@ -1,35 +0,0 @@
-import React, { createContext, useContext, ReactNode, useMemo } from 'react';
-import useReadFeedSearchQuery, { FeedItem } from '../queries/use-read-feed-search-query';
-import { useSiteSubscriptionsQueryProps } from './site-subscriptions-query-props';
-
-type UnsubscribedFeedsSearch = {
-	feedItems: FeedItem[];
-	searchQueryResult: ReturnType< typeof useReadFeedSearchQuery >;
-};
-
-const UnsubscribedFeedsSearchContext = createContext< UnsubscribedFeedsSearch | undefined >(
-	undefined
-);
-
-export const UnsubscribedFeedsSearchProvider: React.FC< { children: ReactNode } > = ( {
-	children,
-} ) => {
-	const { searchTerm } = useSiteSubscriptionsQueryProps();
-	const searchQueryResult = useReadFeedSearchQuery( { query: searchTerm, excludeFollowed: true } );
-	const feedItems = useMemo( () => {
-		if ( searchTerm === '' ) {
-			return [];
-		}
-		return searchQueryResult.data?.pages?.[ 0 ]?.feeds || [];
-	}, [ searchTerm, searchQueryResult.data?.pages ] );
-
-	return (
-		<UnsubscribedFeedsSearchContext.Provider value={ { feedItems, searchQueryResult } }>
-			{ children }
-		</UnsubscribedFeedsSearchContext.Provider>
-	);
-};
-
-export const useUnsubscribedFeedsSearch = () => {
-	return useContext( UnsubscribedFeedsSearchContext );
-};

package/src/reader/queries/test/use-read-feed-search-query.tsx

@@ -1,55 +0,0 @@
-/**
- * @jest-environment jsdom
- */
-import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
-import { renderHook } from '@testing-library/react';
-import React from 'react';
-import wpcomRequest from 'wpcom-proxy-request';
-import useReadFeedSearchQuery, { FeedSort } from '../use-read-feed-search-query';
-
-jest.mock( 'wpcom-proxy-request', () => jest.fn() );
-
-describe( 'useReadFeedSearchQuery', () => {
-	beforeEach( () => {
-		jest.mocked( wpcomRequest ).mockResolvedValue( {
-			algorithm: 'example_algorithm',
-			feeds: [],
-			next_page: 'example_next_page',
-			total: 0,
-		} );
-	} );
-
-	afterEach( () => {
-		jest.clearAllMocks();
-	} );
-
-	it( 'should call wpcomRequest with correct parameters when query is defined', async () => {
-		const queryClient = new QueryClient();
-		const wrapper = ( { children } ) => (
-			<QueryClientProvider client={ queryClient }>{ children }</QueryClientProvider>
-		);
-
-		const query = 'example';
-		renderHook( () => useReadFeedSearchQuery( { query } ), { wrapper } );
-
-		expect( wpcomRequest ).toHaveBeenCalledWith( {
-			path: '/read/feed',
-			apiVersion: '1.1',
-			method: 'GET',
-			query: `q=${ encodeURIComponent( query ) }&exclude_followed=false&sort=${ encodeURIComponent(
-				FeedSort.Relevance
-			) }`,
-		} );
-	} );
-
-	it( 'should not call wpcomRequest when query is undefined', () => {
-		const queryClient = new QueryClient();
-		const wrapper = ( { children } ) => (
-			<QueryClientProvider client={ queryClient }>{ children }</QueryClientProvider>
-		);
-
-		renderHook( () => useReadFeedSearchQuery( {} ), { wrapper } );
-
-		expect( wpcomRequest ).not.toHaveBeenCalled();
-	} );
-} );

package/src/reader/queries/use-read-feed-query.ts

@@ -1,45 +0,0 @@
-import { useQuery } from '@tanstack/react-query';
-import wpcomRequest from 'wpcom-proxy-request';
-import { isValidId } from '../helpers';
-
-export type ReadFeedResponse = {
-	URL: string;
-	blog_ID: string;
-	description: string;
-	feed_ID: string;
-	feed_URL: string;
-	image: string;
-	is_following: boolean;
-	last_checked: string;
-	last_update: string;
-	marked_for_refresh: boolean;
-	meta: {
-		links: {
-			self: string;
-			[ key: string ]: string;
-		};
-	};
-	name: string;
-	next_refresh_time: string | null;
-	organization_id: number;
-	subscribe_URL: string;
-	subscribers_count: number;
-	unseen_count: number;
-	subscription_id?: number; // Only present if the user is subscribed to the feed.
-};
-
-const useReadFeedQuery = ( enabled: boolean, feedId?: number | string ) => {
-	return useQuery( {
-		queryKey: [ 'read', 'feeds', Number( feedId ) ],
-		queryFn: async () => {
-			return wpcomRequest< ReadFeedResponse >( {
-				path: `/read/feed/${ feedId }`,
-				apiVersion: '1.1',
-				method: 'GET',
-			} );
-		},
-		enabled: enabled && isValidId( feedId ),
-	} );
-};
-
-export default useReadFeedQuery;

package/src/reader/queries/use-read-feed-search-query.ts

@@ -1,72 +0,0 @@
-import { Railcar } from '@automattic/calypso-analytics';
-import { useInfiniteQuery } from '@tanstack/react-query';
-import { buildQueryString } from '@wordpress/url';
-import wpcomRequest from 'wpcom-proxy-request';
-
-export enum FeedSort {
-	LastUpdated = 'last_updated',
-	Relevance = 'relevance',
-}
-
-type ReadFeedSearchQueryProps = {
-	query?: string;
-	excludeFollowed?: boolean;
-	sort?: FeedSort;
-};
-
-export type FeedItem = {
-	URL?: string;
-	blog_ID?: string;
-	feed_ID?: string;
-	meta: {
-		links?: {
-			feed?: string;
-			site?: string;
-		};
-	};
-	railcar?: Railcar;
-	subscribe_URL: string;
-	subscribers_count?: number;
-	title?: string;
-};
-
-type FeedResponse = {
-	algorithm: string;
-	feeds: FeedItem[];
-	next_page: string;
-	total: number;
-};
-
-const useReadFeedSearchQuery = ( {
-	query,
-	excludeFollowed = false,
-	sort = FeedSort.Relevance,
-}: ReadFeedSearchQueryProps ) => {
-	return useInfiniteQuery( {
-		queryKey: [ 'read', 'feed', 'search', query, excludeFollowed, sort ],
-		queryFn: async ( { pageParam: pageParamQueryString } ) => {
-			if ( query === undefined ) {
-				return;
-			}
-
-			const urlQuery = buildQueryString( {
-				q: query,
-				exclude_followed: excludeFollowed,
-				sort,
-			} ).concat( pageParamQueryString ? `&${ pageParamQueryString }` : '' );
-
-			return wpcomRequest< FeedResponse >( {
-				path: '/read/feed',
-				apiVersion: '1.1',
-				method: 'GET',
-				query: urlQuery,
-			} );
-		},
-		enabled: Boolean( query ),
-		initialPageParam: '',
-		getNextPageParam: ( lastPage ) => lastPage?.next_page,
-		refetchOnWindowFocus: false,
-	} );
-};
-
-export default useReadFeedSearchQuery;

package/src/reader/queries/use-read-feed-site-query.ts

@@ -1,35 +0,0 @@
-import { useQuery } from '@tanstack/react-query';
-import { buildQueryString } from '@wordpress/url';
-import wpcomRequest from 'wpcom-proxy-request';
-
-export type ReadFeedSiteResponse = {
-	ID: number;
-	URL: string;
-	description: string;
-	feed_ID: number;
-	feed_URL?: string;
-	icon?: { ico: string; img: string };
-	is_following: boolean;
-};
-
-const urlQuery = buildQueryString( {
-	fields: [ 'ID', 'name', 'title', 'URL', 'icon', 'is_following', 'description' ].join( ',' ),
-	options: [ 'is_mapped_domain', 'unmapped_url', 'is_redirect' ].join( ',' ),
-} );
-
-const useReadFeedSiteQuery = ( siteId?: number ) => {
-	return useQuery( {
-		queryKey: [ 'read', 'sites', siteId, urlQuery ],
-		queryFn: async (): Promise< ReadFeedSiteResponse > => {
-			return wpcomRequest< ReadFeedSiteResponse >( {
-				path: `/read/sites/${ siteId }`,
-				query: urlQuery,
-				apiVersion: '1.1',
-				method: 'GET',
-			} );
-		},
-		enabled: typeof siteId === 'number' && siteId > 0,
-	} );
-};
-
-export default useReadFeedSiteQuery;