@automattic/data-stores 3.1.2 → 3.2.1

package/src/purchases/types.ts

@@ -1,8 +1,8 @@
 import { PriceTierEntry } from '@automattic/calypso-products';
 
 export interface Purchase {
-	active?: boolean;
 	amount: number;
+	advertisedTotalUploadSpaceInGb?: number | null;
 	attachedToPurchaseId: number;
 	billPeriodDays: number;
 	billPeriodLabel: string;
@@ -11,8 +11,17 @@ export interface Purchase {
 	asyncPendingPaymentBlockIsSet: boolean;
 	canExplicitRenew: boolean;
 	canReenableAutoRenewal: boolean;
-	costToUnbundle: number;
+
+	/**
+	 * If this upgrade is a domain and a domain credit was used to purchase it,
+	 * and the plan is within its refund period, then `cost_to_unbundle_display`
+	 * will be the formatted amount of the amount that would be withheld to keep
+	 * the domain if the plan is cancelled.
+	 *
+	 * If there is nothing that would be withheld, this will be null.
+	 */
 	costToUnbundleText: string;
+
 	currencyCode: string;
 	currencySymbol: string;
 	description: string;
@@ -29,12 +38,24 @@ export interface Purchase {
 	domain: string;
 
 	domainRegistrationAgreementUrl: string | null;
-	error: null;
 	expiryDate: string;
+
+	/**
+	 * The expiry date in ISO 8601 (YYYY-MM-DD) if the payment method has one.
+	 */
+	paymentExpiryDate: string | undefined;
+
 	expiryStatus: string;
 	iapPurchaseManagementLink: string | null;
 	id: number;
+
+	/**
+	 * If this subscription is for a plan with a bundled domain, this will
+	 * contain the domain name for that domain subscription. Otherwise this will
+	 * be an empty string.
+	 */
 	includedDomain: string;
+
 	includedDomainPurchaseAmount: number;
 	introductoryOffer: PurchaseIntroductoryOffer | null;
 	isAutoRenewEnabled: boolean;
@@ -46,6 +67,7 @@ export interface Purchase {
 	isLocked: boolean;
 	isRechargeable: boolean;
 	isRefundable: boolean;
+	isWithinInitialRefundWindow: boolean;
 	isRenewable: boolean;
 	isRenewal: boolean;
 	isWooExpressTrial: boolean;
@@ -71,7 +93,6 @@ export interface Purchase {
 	productSlug: string;
 	productType: string;
 	purchaseRenewalQuantity: number | null;
-	purchaserId?: number;
 
 	/**
 	 * The refund amount for the purchase, not including bundled domains, as a
@@ -92,7 +113,7 @@ export interface Purchase {
 	 */
 	refundInteger: number;
 
-	refundOptions: RefundOptions | null;
+	refundOptions: RefundOptions[] | null;
 	refundPeriodInDays: number;
 
 	/**
@@ -162,9 +183,6 @@ export interface Purchase {
 	userId: number;
 	userIsOwner?: boolean;
 	partnerKeyId: number | undefined;
-	tagLine: string;
-	taxAmount: number | string | undefined;
-	taxText: string | undefined;
 
 	/**
 	 * The coupon code that will automatically apply on the next renewal.
@@ -175,6 +193,9 @@ export interface Purchase {
 	 * Example: If the discount is 10%, this will have the value `10`.
 	 */
 	autoRenewCouponDiscountPercentage: number | null;
+
+	isJetpackPlanOrProduct: boolean;
+	isAttachedToHoldingSite: boolean;
 }
 
 export interface PurchasePriceTier {
@@ -191,114 +212,7 @@ export interface RawPurchasePriceTierEntry extends PriceTierEntry {
 	maximum_price_monthly_display: never;
 }
 
-export interface RawPurchase {
-	ID: number | string;
-	active: boolean;
-	amount: number | string;
-	attached_to_purchase_id: number | string;
-	auto_renew_coupon_code: string | null;
-	auto_renew_coupon_discount_percentage: number | null;
-	bill_period_days: number | string;
-	bill_period_label: string;
-	most_recent_renew_date: string;
-	can_disable_auto_renew: boolean;
-	can_reenable_auto_renewal: boolean;
-	async_pending_payment_block_is_set: boolean;
-	can_explicit_renew: boolean;
-	cost_to_unbundle: undefined | number | string;
-	cost_to_unbundle_display: undefined | string;
-	price_text: string;
-	price_tier_list?: Array< RawPurchasePriceTierEntry >;
-	currency_code: string;
-	currency_symbol: string;
-	description: string;
-	domain: string;
-	domain_registration_agreement_url: string | undefined;
-	blog_created_date: string;
-	expiry_date: string;
-	expiry_status: string;
-	iap_purchase_management_link: string | null;
-	included_domain: string;
-	included_domain_purchase_amount: number;
-	introductory_offer: RawPurchaseIntroductoryOffer | null;
-	is_cancelable: boolean;
-	is_domain: boolean;
-	is_domain_registration: boolean;
-	is_hundred_year_domain: boolean;
-	is_locked: boolean;
-	is_iap_purchase: boolean;
-	is_rechargable: boolean;
-	is_refundable: boolean;
-	is_renewable: boolean;
-	is_renewal: boolean;
-	is_woo_express_trial: boolean;
-	meta: string | undefined;
-	ownership_id: number | undefined;
-	partner_name: string | undefined;
-	partner_slug: string | undefined;
-	partner_type: string | undefined;
-	partner_key_id: number | undefined;
-	payment_name: string;
-	payment_type:
-		| 'credit_card'
-		| 'paypal_direct'
-		| 'paypal'
-		| 'emergent-paywall'
-		| 'brazil-tef'
-		| string;
-	payment_card_display_brand: string | null;
-	payment_country_name: string;
-	payment_country_code: string | null;
-	stored_details_id: string | null;
-	pending_transfer: boolean;
-	product_id: number | string;
-	product_name: string;
-	product_slug: string;
-	product_type: string;
-	product_display_price: string;
-	price_integer: number;
-	purchaser_id?: number;
-	total_refund_amount: number | undefined;
-	total_refund_currency: string;
-	total_refund_integer: number;
-	total_refund_text: string;
-	refund_amount: number;
-	refund_integer: number;
-	refund_text: string;
-	refund_currency_symbol: string;
-	refund_options: RefundOptions | null;
-	refund_period_in_days: number;
-	regular_price_text: string;
-	regular_price_integer: number;
-	renew_date: string;
-	sale_amount: number | undefined;
-	sale_amount_integer: number | undefined;
-	blog_id: number | string;
-	blogname: string;
-	site_slug?: string;
-	subscribed_date: string;
-	subscription_status: 'active' | 'inactive';
-	tag_line: string;
-	tax_amount: number | string | undefined;
-	tax_text: string | undefined;
-	renewal_price_tier_usage_quantity: number | undefined | null;
-	user_id: number | string;
-	auto_renew: '1' | '0' | null;
-	payment_card_id: number | string | undefined;
-	payment_card_type: string | undefined;
-	payment_card_processor: string | undefined;
-	payment_details: string | undefined;
-	payment_expiry: string | undefined;
-}
-
-export type RawPurchaseCreditCard = RawPurchase & {
-	payment_type: 'credit_card';
-	payment_card_type: string;
-	payment_card_display_brand: string | null;
-	payment_card_processor: string;
-	payment_details: string | number;
-	payment_expiry: string;
-};
+export type { RawPurchase } from '@automattic/api-core';
 
 export interface RefundOptions {
 	to_product_id: number;
@@ -308,6 +222,7 @@ export interface RefundOptions {
 
 export interface RawPurchaseIntroductoryOffer {
 	cost_per_interval: number;
+	cost_per_interval_integer: number;
 	end_date: string;
 	interval_count: number;
 	interval_unit: string;
@@ -321,6 +236,7 @@ export interface RawPurchaseIntroductoryOffer {
 
 export interface PurchaseIntroductoryOffer {
 	costPerInterval: number;
+	costPerIntervalInteger: number;
 	endDate: string;
 	intervalCount: number;
 	intervalUnit: string;
@@ -338,6 +254,11 @@ export interface PurchasePayment {
 	countryCode: string | undefined | null;
 	countryName: string | undefined;
 	storedDetailsId: string | number | undefined | null;
+	/**
+	 * The expiry date in MM/YY if the payment method has one.
+	 *
+	 * Use `paymentExpiryDate` on the Purchase if possible as it will be more accurate.
+	 */
 	expiryDate?: string;
 	creditCard?: PurchasePaymentCreditCard;
 	paymentPartner?: string;
@@ -352,6 +273,11 @@ export type PurchasePaymentWithPayPal = PurchasePayment & {
 	countryName: string | undefined;
 	storedDetailsId: string | number;
 	type: string;
+	/**
+	 * The expiry date in MM/YY if the payment method has one.
+	 *
+	 * Use `paymentExpiryDate` on the Purchase if possible as it will be more accurate.
+	 */
 	expiryDate: string;
 };
 
@@ -374,5 +300,10 @@ export interface PurchasePaymentCreditCard {
 	displayBrand: string | null;
 	processor: string;
 	number: string;
+	/**
+	 * The expiry date in MM/YY if the payment method has one.
+	 *
+	 * Use `paymentExpiryDate` on the Purchase if possible as it will be more accurate.
+	 */
 	expiryDate: string;
 }

package/src/queries/use-all-domains-query.ts

@@ -1,6 +1,6 @@
 import { UseQueryOptions, useQuery } from '@tanstack/react-query';
 import { addQueryArgs } from '@wordpress/url';
-import wpcomRequest from 'wpcom-proxy-request';
+import wpcomRequest from '../wpcom-request';
 import type { DomainData } from './use-site-domains-query';
 
 // The data returned by the /all-domains endpoint only includes the basic data
@@ -30,10 +30,10 @@ export interface AllDomainsQueryFnData {
 	domains: PartialDomainData[];
 }
 
-export interface AllDomainsQueryArgs {
+export type AllDomainsQueryArgs = {
 	no_wpcom?: boolean;
 	resolve_status?: boolean;
-}
+};
 
 export const getAllDomainsQueryKey = ( queryArgs: AllDomainsQueryArgs = {} ) => [
 	'all-domains',

package/src/queries/use-bulk-domain-update-status-query.ts

@@ -1,130 +1,29 @@
+import {
+	type BulkDomainUpdateStatusQueryFnData,
+	type BulkDomainUpdateStatusResult,
+} from '@automattic/api-core';
+import { bulkDomainUpdateStatusQuery } from '@automattic/api-queries';
 import { type UseQueryOptions, useQuery } from '@tanstack/react-query';
-import wpcomRequest from 'wpcom-proxy-request';
-
-export interface BulkDomainUpdateStatus {
-	results: {
-		[ key: string ]: '' | 'success' | 'failed';
-	};
-	action: 'set_auto_renew' | 'update_contact_info';
-	created_at: number;
-	auto_renew?: boolean;
-	whois?: unknown;
-	transfer_lock?: boolean;
-}
-
-export interface BulkDomainUpdateStatusQueryFnData {
-	[ key: string ]: BulkDomainUpdateStatus;
-}
-
-export interface JobStatus {
-	id: string;
-	action: 'set_auto_renew' | 'update_contact_info';
-	created_at: number;
-	success: string[];
-	failed: string[];
-	pending: string[];
-	complete: boolean;
-	params: {
-		auto_renew?: boolean;
-		whois?: unknown;
-		transfer_lock?: boolean;
-	};
-}
-
-interface DomainUpdateRemoteStatus {
-	status: '' | 'success' | 'failed';
-	action: 'set_auto_renew' | 'update_contact_info';
-	created_at: number;
-	auto_renew?: boolean;
-	whois?: unknown;
-	transfer_lock?: boolean;
-}
-
-interface DomainUpdateDerivedStatus {
-	status: '';
-	message: string;
-	created_at: number;
-}
-
-export type DomainUpdateStatus = DomainUpdateRemoteStatus | DomainUpdateDerivedStatus;
 
 export const getBulkDomainUpdateStatusQueryKey = () => {
-	return [ 'domains', 'bulk-actions' ];
+	return bulkDomainUpdateStatusQuery().queryKey;
 };
 
-export interface BulkDomainUpdateStatusResult {
-	domainResults: Map< string, DomainUpdateStatus[] >;
-	completedJobs: JobStatus[];
-}
-
-export function useBulkDomainUpdateStatusQuery< TError = unknown >(
+export function useBulkDomainUpdateStatusQuery(
 	pollingInterval: number,
 	options: Omit<
-		UseQueryOptions< BulkDomainUpdateStatusQueryFnData, TError, BulkDomainUpdateStatusResult >,
+		UseQueryOptions<
+			BulkDomainUpdateStatusQueryFnData,
+			Error,
+			BulkDomainUpdateStatusResult,
+			string[]
+		>,
 		'queryKey'
 	> = {}
 ) {
 	return useQuery( {
-		queryFn: () =>
-			wpcomRequest< BulkDomainUpdateStatusQueryFnData >( {
-				path: '/domains/bulk-actions',
-				apiNamespace: 'wpcom/v2',
-			} ),
-		select: ( data ): BulkDomainUpdateStatusResult => {
-			// get top-level info about recent jobs
-			const allJobs: JobStatus[] = Object.keys( data ).map( ( jobId ) => {
-				const { action, created_at, results, ...rest } = data[ jobId ];
-				const success: string[] = [];
-				const failed: string[] = [];
-				const pending: string[] = [];
-
-				Object.entries( results ).forEach( ( entry ) => {
-					if ( entry[ 1 ] === 'success' ) {
-						success.push( entry[ 0 ] );
-					} else if ( entry[ 1 ] === 'failed' ) {
-						failed.push( entry[ 0 ] );
-					} else {
-						pending.push( entry[ 0 ] );
-					}
-				} );
-
-				return {
-					id: jobId,
-					action: action,
-					created_at: created_at,
-					success,
-					failed,
-					pending,
-					complete: pending.length === 0,
-					params: rest,
-				};
-			} );
-
-			// get domain-level updates that can be shown inline in the table rows
-			const domainResults = new Map< string, DomainUpdateStatus[] >();
-
-			Object.keys( data ).forEach( ( jobId ) => {
-				// only create domain-level results for jobs that
-				// are still running
-				if ( ! allJobs.find( ( job ) => job.id === jobId )?.complete ) {
-					const entry = data[ jobId ] as BulkDomainUpdateStatus;
-					const { results, ...rest } = entry;
-					Object.keys( results ).forEach( ( domain ) => {
-						if ( ! domainResults.has( domain ) ) {
-							domainResults.set( domain, [] );
-						}
-						const status = results[ domain ];
-						domainResults.get( domain )?.push( { ...rest, status } );
-					} );
-				}
-			} );
-
-			const completedJobs = allJobs.filter( ( job ) => job.complete );
-
-			return { domainResults, completedJobs };
-		},
+		...bulkDomainUpdateStatusQuery(),
 		refetchInterval: pollingInterval,
 		...options,
-		queryKey: getBulkDomainUpdateStatusQueryKey(),
 	} );
 }

package/src/queries/use-happiness-engineers-query.ts

@@ -1,5 +1,5 @@
 import { useQuery } from '@tanstack/react-query';
-import wpcomRequest from 'wpcom-proxy-request';
+import wpcomRequest from '../wpcom-request';
 
 export const useHappinessEngineersQuery = () =>
 	useQuery<

package/src/queries/use-launchpad.ts

@@ -3,7 +3,7 @@ import * as oauthToken from '@automattic/oauth-token';
 import { useMutation, useQuery, useQueryClient } from '@tanstack/react-query';
 import apiFetch from '@wordpress/api-fetch';
 import { addQueryArgs } from '@wordpress/url';
-import wpcomRequest, { canAccessWpcomApis } from 'wpcom-proxy-request';
+import wpcomRequest, { canAccessWpcomApis } from '../wpcom-request';
 
 interface APIFetchOptions {
 	global: boolean;

package/src/queries/use-site-domains-query.ts

@@ -1,5 +1,5 @@
 import { UseQueryOptions, useQuery } from '@tanstack/react-query';
-import wpcomRequest from 'wpcom-proxy-request';
+import wpcomRequest from '../wpcom-request';
 
 interface DnssecRecords {
 	dnskey?: string;

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

@@ -1,6 +1,6 @@
 import { useQuery } from '@tanstack/react-query';
-import wpcomRequest from 'wpcom-proxy-request';
 import { SiteIntent } from '../onboard';
+import wpcomRequest from '../wpcom-request';
 
 export function useSiteIntent( siteId: string | number | undefined ) {
 	return useQuery< {

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

@@ -1,6 +1,6 @@
 import { SiteDetails } from '@automattic/data-stores/src/site';
 import { UseQueryOptions, useQuery } from '@tanstack/react-query';
-import wpcomRequest from 'wpcom-proxy-request';
+import wpcomRequest from '../wpcom-request';
 
 export function useSiteQuery< TError = unknown, TData = SiteDetails >(
 	sourceSiteSlug: string | number | null | undefined,

package/src/reader/contexts/index.ts

@@ -1,7 +1,3 @@
-export {
-	UnsubscribedFeedsSearchProvider,
-	useUnsubscribedFeedsSearch,
-} from './unsubscribed-feeds-search';
 export {
 	SiteSubscriptionsQueryPropsProvider,
 	useSiteSubscriptionsQueryProps,

package/src/reader/helpers/index.ts

@@ -1,5 +1,5 @@
 import apiFetch, { APIFetchOptions } from '@wordpress/api-fetch';
-import wpcomRequest from 'wpcom-proxy-request';
+import wpcomRequest from '../../wpcom-request';
 import isValidId from './validators';
 
 type callApiParams = {
@@ -47,7 +47,7 @@ async function callApi< ReturnType >( {
 			? `https://public-api.wordpress.com/wpcom/v2${ path }`
 			: `https://public-api.wordpress.com/rest/v${ apiVersion }${ path }`;
 
-	return apiFetch( {
+	const res = await apiFetch( {
 		global: true,
 		path: apiPath,
 		apiVersion,
@@ -59,6 +59,7 @@ async function callApi< ReturnType >( {
 			'Content-Type': 'application/json',
 		},
 	} as APIFetchOptions );
+	return res as ReturnType;
 }
 
 interface PagedResult< T > {

package/src/reader/helpers/optimistic-update.ts

@@ -1,3 +1,4 @@
+import { getSiteSubscriptionsQueryKey } from '@automattic/api-queries';
 import { QueryClient } from '@tanstack/react-query';
 import { SiteSubscriptionDetails } from '../types';
 import { buildQueryKey } from './index';
@@ -66,7 +67,7 @@ const invalidateSiteSubscriptionDetails = (
 	queryClient: QueryClient,
 	{ blogId, subscriptionId, isLoggedIn, id }: SiteSubScriptionDetailsParameters
 ) => {
-	queryClient.invalidateQueries( { queryKey: [ 'read', 'site-subscriptions' ] } );
+	queryClient.invalidateQueries( { queryKey: getSiteSubscriptionsQueryKey() } );
 	queryClient.invalidateQueries( {
 		queryKey: buildQueryKey( [ 'read', 'site-subscription-details', blogId ], isLoggedIn, id ),
 	} );

package/src/reader/index.ts

@@ -17,6 +17,7 @@ import {
 } from './mutations';
 import {
 	siteSubscriptionsQueryKeyPrefix,
+	subscriptionsCountQueryKeyPrefix,
 	usePendingPostSubscriptionsQuery,
 	usePendingSiteSubscriptionsQuery,
 	usePostSubscriptionsQuery,
@@ -29,6 +30,7 @@ import {
 export const SubscriptionManager = {
 	SiteSubscriptionsQueryPropsProvider,
 	siteSubscriptionsQueryKeyPrefix,
+	subscriptionsCountQueryKeyPrefix,
 	useCacheKey,
 	useIsLoggedIn,
 	usePendingPostConfirmMutation,
@@ -63,8 +65,4 @@ export {
 	SiteSubscriptionsSortBy,
 } from './constants';
 export { callApi, isErrorResponse, isSiteSubscriptionDetails, isValidId } from './helpers';
-export { UnsubscribedFeedsSearchProvider, useUnsubscribedFeedsSearch } from './contexts';
-export { useReadFeedSearchQuery, useReadFeedSiteQuery, useReadFeedQuery } from './queries';
-
 export * from './types';
-export type { FeedItem } from './queries';