@wordpress/api-fetch 7.29.1-next.f34ab90e9.0 → 7.30.0

package/src/middlewares/{media-upload.js → media-upload.ts}

@@ -10,12 +10,13 @@ import {
 	parseAndThrowError,
 	parseResponseAndNormalizeError,
 } from '../utils/response';
+import type { APIFetchOptions, APIFetchMiddleware } from '../types';
 
 /**
- * @param {import('../types').APIFetchOptions} options
- * @return {boolean} True if the request is for media upload.
+ * @param options
+ * @return True if the request is for media upload.
  */
-function isMediaUploadRequest( options ) {
+function isMediaUploadRequest( options: APIFetchOptions ) {
 	const isCreateMethod = !! options.method && options.method === 'POST';
 	const isMediaEndpoint =
 		( !! options.path && options.path.indexOf( '/wp/v2/media' ) !== -1 ) ||
@@ -26,10 +27,10 @@ function isMediaUploadRequest( options ) {
 
 /**
  * Middleware handling media upload failures and retries.
- *
- * @type {import('../types').APIFetchMiddleware}
+ * @param options
+ * @param next
  */
-const mediaUploadMiddleware = ( options, next ) => {
+const mediaUploadMiddleware: APIFetchMiddleware = ( options, next ) => {
 	if ( ! isMediaUploadRequest( options ) ) {
 		return next( options );
 	}
@@ -38,10 +39,10 @@ const mediaUploadMiddleware = ( options, next ) => {
 	const maxRetries = 5;
 
 	/**
-	 * @param {string} attachmentId
-	 * @return {Promise<any>} Processed post response.
+	 * @param attachmentId
+	 * @return Processed post response.
 	 */
-	const postProcess = ( attachmentId ) => {
+	const postProcess = ( attachmentId: string ): Promise< any > => {
 		retries++;
 		return next( {
 			path: `/wp/v2/media/${ attachmentId }/post-process`,
@@ -62,9 +63,9 @@ const mediaUploadMiddleware = ( options, next ) => {
 	};
 
 	return next( { ...options, parse: false } )
-		.catch( ( response ) => {
+		.catch( ( response: Response ) => {
 			// `response` could actually be an error thrown by `defaultFetchHandler`.
-			if ( ! response.headers ) {
+			if ( ! ( response instanceof globalThis.Response ) ) {
 				return Promise.reject( response );
 			}
 
@@ -91,7 +92,7 @@ const mediaUploadMiddleware = ( options, next ) => {
 			}
 			return parseAndThrowError( response, options.parse );
 		} )
-		.then( ( response ) =>
+		.then( ( response: Response ) =>
 			parseResponseAndNormalizeError( response, options.parse )
 		);
 };

package/src/middlewares/{namespace-endpoint.js → namespace-endpoint.ts}

@@ -1,7 +1,12 @@
 /**
- * @type {import('../types').APIFetchMiddleware}
+ * Internal dependencies
  */
-const namespaceAndEndpointMiddleware = ( options, next ) => {
+import type { APIFetchMiddleware } from '../types';
+
+const namespaceAndEndpointMiddleware: APIFetchMiddleware = (
+	options,
+	next
+) => {
 	let path = options.path;
 	let namespaceTrimmed, endpointTrimmed;
 

package/src/middlewares/{nonce.js → nonce.ts}

@@ -1,12 +1,20 @@
 /**
- * @param {string} nonce
- * @return {import('../types').APIFetchMiddleware & { nonce: string }} A middleware to enhance a request with a nonce.
+ * Internal dependencies
  */
-function createNonceMiddleware( nonce ) {
-	/**
-	 * @type {import('../types').APIFetchMiddleware & { nonce: string }}
-	 */
-	const middleware = ( options, next ) => {
+import type { APIFetchMiddleware } from '../types';
+
+/**
+ * @param nonce
+ *
+ * @return  A middleware to enhance a request with a nonce.
+ */
+function createNonceMiddleware(
+	nonce: string
+): APIFetchMiddleware & { nonce: string } {
+	const middleware: APIFetchMiddleware & { nonce: string } = (
+		options,
+		next
+	) => {
 		const { headers = {} } = options;
 
 		// If an 'X-WP-Nonce' header (or any case-insensitive variation

package/src/middlewares/{preloading.js → preloading.ts}

@@ -4,10 +4,17 @@
 import { addQueryArgs, getQueryArgs, normalizePath } from '@wordpress/url';
 
 /**
- * @param {Record<string, any>} preloadedData
- * @return {import('../types').APIFetchMiddleware} Preloading middleware.
+ * Internal dependencies
  */
-function createPreloadingMiddleware( preloadedData ) {
+import type { APIFetchMiddleware } from '../types';
+
+/**
+ * @param preloadedData
+ * @return Preloading middleware.
+ */
+function createPreloadingMiddleware(
+	preloadedData: Record< string, any >
+): APIFetchMiddleware {
 	const cache = Object.fromEntries(
 		Object.entries( preloadedData ).map( ( [ path, data ] ) => [
 			normalizePath( path ),
@@ -17,7 +24,6 @@ function createPreloadingMiddleware( preloadedData ) {
 
 	return ( options, next ) => {
 		const { parse = true } = options;
-		/** @type {string | void} */
 		let rawPath = options.path;
 		if ( ! rawPath && options.url ) {
 			const { rest_route: pathFromQuery, ...queryArgs } = getQueryArgs(
@@ -63,11 +69,14 @@ function createPreloadingMiddleware( preloadedData ) {
 /**
  * This is a helper function that sends a success response.
  *
- * @param {Record<string, any>} responseData
- * @param {boolean}             parse
- * @return {Promise<any>} Promise with the response.
+ * @param responseData
+ * @param parse
+ * @return Promise with the response.
  */
-function prepareResponse( responseData, parse ) {
+function prepareResponse(
+	responseData: Record< string, any >,
+	parse: boolean
+) {
 	if ( parse ) {
 		return Promise.resolve( responseData.body );
 	}
@@ -82,12 +91,13 @@ function prepareResponse( responseData, parse ) {
 		);
 	} catch {
 		// See: https://github.com/WordPress/gutenberg/issues/67358#issuecomment-2621163926.
-		Object.entries( responseData.headers ).forEach( ( [ key, value ] ) => {
+		Object.entries(
+			responseData.headers as Record< string, string >
+		).forEach( ( [ key, value ] ) => {
 			if ( key.toLowerCase() === 'link' ) {
 				responseData.headers[ key ] = value.replace(
 					/<([^>]+)>/,
-					( /** @type {any} */ _, /** @type {string} */ url ) =>
-						`<${ encodeURI( url ) }>`
+					( _, url ) => `<${ encodeURI( url ) }>`
 				);
 			}
 		} );

package/src/middlewares/root-url.ts

@@ -0,0 +1,47 @@
+/**
+ * Internal dependencies
+ */
+import type { APIFetchMiddleware } from '../types';
+import namespaceAndEndpointMiddleware from './namespace-endpoint';
+
+/**
+ * @param rootURL
+ * @return  Root URL middleware.
+ */
+const createRootURLMiddleware =
+	( rootURL: string ): APIFetchMiddleware =>
+	( options, next ) => {
+		return namespaceAndEndpointMiddleware( options, ( optionsWithPath ) => {
+			let url = optionsWithPath.url;
+			let path = optionsWithPath.path;
+			let apiRoot;
+
+			if ( typeof path === 'string' ) {
+				apiRoot = rootURL;
+
+				if ( -1 !== rootURL.indexOf( '?' ) ) {
+					path = path.replace( '?', '&' );
+				}
+
+				path = path.replace( /^\//, '' );
+
+				// API root may already include query parameter prefix if site is
+				// configured to use plain permalinks.
+				if (
+					'string' === typeof apiRoot &&
+					-1 !== apiRoot.indexOf( '?' )
+				) {
+					path = path.replace( '?', '&' );
+				}
+
+				url = apiRoot + path;
+			}
+
+			return next( {
+				...optionsWithPath,
+				url,
+			} );
+		} );
+	};
+
+export default createRootURLMiddleware;

package/src/middlewares/test/{fetch-all-middleware.js → fetch-all-middleware.ts}

@@ -19,7 +19,7 @@ describe( 'Fetch All Middleware', () => {
 		expect.hasAssertions();
 		const originalOptions = { url: '/posts?per_page=-1' };
 		let counter = 1;
-		jest.doMock( '../../index.js', () => ( options ) => {
+		jest.doMock( '../../index.ts', () => ( options ) => {
 			const expectedUrl =
 				counter === 1
 					? '/posts?per_page=100'

package/src/middlewares/test/{http-v1.js → http-v1.ts}

@@ -1,15 +1,18 @@
 /**
  * Internal dependencies
  */
+import type { FetchHandler } from '../../types';
 import httpV1Middleware from '../http-v1';
 
 describe( 'HTTP v1 Middleware', () => {
 	it( 'should use a POST for a PUT requests', () => {
 		expect.hasAssertions();
 
-		const callback = ( options ) => {
+		const callback: FetchHandler = async ( options ) => {
 			expect( options.method ).toBe( 'POST' );
-			expect( options.headers[ 'X-HTTP-Method-Override' ] ).toBe( 'PUT' );
+			expect( options.headers![ 'X-HTTP-Method-Override' ] ).toBe(
+				'PUT'
+			);
 		};
 
 		httpV1Middleware( { method: 'PUT', data: {} }, callback );
@@ -19,7 +22,7 @@ describe( 'HTTP v1 Middleware', () => {
 		expect.hasAssertions();
 
 		const requestOptions = { method: 'GET', path: '/wp/v2/posts' };
-		const callback = ( options ) => {
+		const callback: FetchHandler = async ( options ) => {
 			expect( options ).toBe( requestOptions );
 		};
 
@@ -30,7 +33,7 @@ describe( 'HTTP v1 Middleware', () => {
 		expect.hasAssertions();
 
 		const requestOptions = { path: '/wp/v2/posts' };
-		const callback = ( options ) => {
+		const callback: FetchHandler = async ( options ) => {
 			expect( options ).toBe( requestOptions );
 		};
 

package/src/middlewares/test/{media-upload.js → media-upload.ts}

@@ -1,6 +1,7 @@
 /**
  * Internal dependencies
  */
+import type { FetchHandler } from '../../types';
 import mediaUploadMiddleware from '../media-upload';
 
 describe( 'Media Upload Middleware', () => {
@@ -8,7 +9,7 @@ describe( 'Media Upload Middleware', () => {
 		expect.hasAssertions();
 
 		const originalOptions = { path: '/wp/v2/media' };
-		const next = ( options ) => {
+		const next: FetchHandler = async ( options ) => {
 			expect( options ).toBe( originalOptions );
 		};
 

package/src/middlewares/test/{namespace-endpoint.js → namespace-endpoint.ts}

@@ -1,6 +1,7 @@
 /**
  * Internal dependencies
  */
+import type { FetchHandler } from '../../types';
 import namespaceEndpointMiddleware from '../namespace-endpoint';
 
 describe( 'Namespace & Endpoint middleware', () => {
@@ -12,7 +13,7 @@ describe( 'Namespace & Endpoint middleware', () => {
 			namespace: '/wp/v2',
 			endpoint: '/posts',
 		};
-		const callback = ( options ) => {
+		const callback: FetchHandler = async ( options ) => {
 			expect( options.path ).toBe( 'wp/v2/posts' );
 			expect( options.namespace ).toBeUndefined();
 			expect( options.endpoint ).toBeUndefined();

package/src/middlewares/test/{nonce.js → nonce.ts}

@@ -1,6 +1,7 @@
 /**
  * Internal dependencies
  */
+import type { FetchHandler } from '../../types';
 import createNonceMiddleware from '../nonce';
 
 describe( 'Nonce middleware', () => {
@@ -13,8 +14,8 @@ describe( 'Nonce middleware', () => {
 			method: 'GET',
 			path: '/wp/v2/posts',
 		};
-		const callback = ( options ) => {
-			expect( options.headers[ 'X-WP-Nonce' ] ).toBe( nonce );
+		const callback: FetchHandler = async ( options ) => {
+			expect( options.headers![ 'X-WP-Nonce' ] ).toBe( nonce );
 		};
 
 		nonceMiddleware( requestOptions, callback );
@@ -31,8 +32,8 @@ describe( 'Nonce middleware', () => {
 			headers: { 'X-WP-Nonce': 'existing nonce' },
 		};
 
-		const callback = ( options ) => {
-			expect( options.headers[ 'X-WP-Nonce' ] ).toBe( 'new nonce' );
+		const callback: FetchHandler = async ( options ) => {
+			expect( options.headers![ 'X-WP-Nonce' ] ).toBe( 'new nonce' );
 		};
 
 		nonceMiddleware( requestOptions, callback );

package/src/middlewares/test/{preloading.js → preloading.ts}

@@ -1,6 +1,7 @@
 /**
  * Internal dependencies
  */
+import type { FetchHandler } from '../../types';
 import createPreloadingMiddleware from '../preloading';
 
 describe( 'Preloading Middleware', () => {
@@ -23,7 +24,10 @@ describe( 'Preloading Middleware', () => {
 						path: 'wp/v2/posts',
 					};
 
-					const response = preloadingMiddleware( requestOptions );
+					const response = preloadingMiddleware(
+						requestOptions,
+						async () => {}
+					);
 					return response.then( ( value ) => {
 						expect( value ).toEqual( body );
 					} );
@@ -60,9 +64,12 @@ describe( 'Preloading Middleware', () => {
 					const noResponseMock =
 						'undefined' === typeof window.Response;
 					if ( noResponseMock ) {
+						// @ts-expect-error
 						window.Response = class {
 							constructor( body, options ) {
+								// @ts-expect-error
 								this.body = JSON.parse( body );
+								// @ts-expect-error
 								this.headers = options.headers;
 							}
 						};
@@ -92,8 +99,12 @@ describe( 'Preloading Middleware', () => {
 						parse: false,
 					};
 
-					const response = preloadingMiddleware( requestOptions );
+					const response = preloadingMiddleware(
+						requestOptions,
+						async () => {}
+					);
 					if ( noResponseMock ) {
+						// @ts-expect-error
 						delete window.Response;
 					}
 					return response.then( ( value ) => {
@@ -126,7 +137,10 @@ describe( 'Preloading Middleware', () => {
 						parse: true,
 					};
 
-					const response = preloadingMiddleware( requestOptions );
+					const response = preloadingMiddleware(
+						requestOptions,
+						async () => {}
+					);
 					return response.then( ( value ) => {
 						expect( value ).toEqual( body );
 					} );
@@ -172,7 +186,10 @@ describe( 'Preloading Middleware', () => {
 			path: 'wp/v2/demo-reverse-alphabetical?baz=quux&foo=bar',
 		};
 
-		let value = await preloadingMiddleware( requestOptions, () => {} );
+		let value = await preloadingMiddleware(
+			requestOptions,
+			async () => {}
+		);
 		expect( value ).toEqual( body );
 
 		requestOptions = {
@@ -180,7 +197,7 @@ describe( 'Preloading Middleware', () => {
 			path: 'wp/v2/demo-alphabetical?foo=bar&baz=quux',
 		};
 
-		value = await preloadingMiddleware( requestOptions, () => {} );
+		value = await preloadingMiddleware( requestOptions, async () => {} );
 		expect( value ).toEqual( body );
 	} );
 
@@ -196,7 +213,7 @@ describe( 'Preloading Middleware', () => {
 				method: 'GET',
 				path: '/?_fields=foo%2Cbar',
 			},
-			() => {}
+			async () => {}
 		);
 
 		expect( response ).toEqual( body );
@@ -214,7 +231,7 @@ describe( 'Preloading Middleware', () => {
 				method: 'GET',
 				url: '/index.php?rest_route=%2F',
 			},
-			() => {}
+			async () => {}
 		);
 
 		expect( response ).toEqual( body );
@@ -232,7 +249,7 @@ describe( 'Preloading Middleware', () => {
 				method: 'GET',
 				url: '/index.php?rest_route=%2F&_fields=foo%2Cbar',
 			},
-			() => {}
+			async () => {}
 		);
 
 		expect( response ).toEqual( body );
@@ -321,7 +338,7 @@ describe( 'Preloading Middleware', () => {
 			[ 'all empty', {} ],
 			[ 'method empty', { [ method ]: {} } ],
 		] )( '%s', ( label, preloadedData ) => {
-			it( 'should move to the next middleware if no preloaded data', () => {
+			it( 'should move to the next middleware if no preloaded data', async () => {
 				const preloadingMiddleware =
 					createPreloadingMiddleware( preloadedData );
 				const requestOptions = {
@@ -329,12 +346,15 @@ describe( 'Preloading Middleware', () => {
 					path: 'wp/v2/posts',
 				};
 
-				const callback = ( options ) => {
+				const callback: FetchHandler = async ( options ) => {
 					expect( options ).toBe( requestOptions );
 					return true;
 				};
 
-				const ret = preloadingMiddleware( requestOptions, callback );
+				const ret = await preloadingMiddleware(
+					requestOptions,
+					callback
+				);
 				expect( ret ).toBe( true );
 			} );
 		} );

package/src/middlewares/test/{root-url.js → root-url.ts}

@@ -1,6 +1,7 @@
 /**
  * Internal dependencies
  */
+import type { FetchHandler } from '../../types';
 import createRootUrlMiddleware from '../root-url';
 
 describe( 'Root URL middleware', () => {
@@ -13,7 +14,7 @@ describe( 'Root URL middleware', () => {
 			method: 'GET',
 			path: '/wp/v2/posts',
 		};
-		const callback = ( options ) => {
+		const callback: FetchHandler = async ( options ) => {
 			expect( options.url ).toBe(
 				'http://wp.org/wp-admin/rest/wp/v2/posts'
 			);

package/src/middlewares/test/{user-locale.js → user-locale.ts}

@@ -1,6 +1,7 @@
 /**
  * Internal dependencies
  */
+import type { FetchHandler } from '../../types';
 import userLocaleMiddleware from '../user-locale';
 
 describe( 'User locale middleware', () => {
@@ -12,7 +13,7 @@ describe( 'User locale middleware', () => {
 			path: '/wp/v2/posts',
 		};
 
-		const callback = ( options ) => {
+		const callback: FetchHandler = async ( options ) => {
 			expect( options.path ).toBe( '/wp/v2/posts?_locale=user' );
 		};
 
@@ -27,7 +28,7 @@ describe( 'User locale middleware', () => {
 			path: '/wp/v2/posts?foo=bar',
 		};
 
-		const callback = ( options ) => {
+		const callback: FetchHandler = async ( options ) => {
 			expect( options.path ).toBe( '/wp/v2/posts?foo=bar&_locale=user' );
 		};
 
@@ -42,7 +43,7 @@ describe( 'User locale middleware', () => {
 			path: '/wp/v2/posts?_locale=foo',
 		};
 
-		const callback = ( options ) => {
+		const callback: FetchHandler = async ( options ) => {
 			expect( options.path ).toBe( '/wp/v2/posts?_locale=foo' );
 		};
 
@@ -57,7 +58,7 @@ describe( 'User locale middleware', () => {
 			path: '/wp/v2/posts?foo=bar&_locale=foo',
 		};
 
-		const callback = ( options ) => {
+		const callback: FetchHandler = async ( options ) => {
 			expect( options.path ).toBe( '/wp/v2/posts?foo=bar&_locale=foo' );
 		};
 
@@ -72,7 +73,7 @@ describe( 'User locale middleware', () => {
 			url: 'http://wp.org/wp-json/wp/v2/posts',
 		};
 
-		const callback = ( options ) => {
+		const callback: FetchHandler = async ( options ) => {
 			expect( options.url ).toBe(
 				'http://wp.org/wp-json/wp/v2/posts?_locale=user'
 			);
@@ -89,7 +90,7 @@ describe( 'User locale middleware', () => {
 			url: 'http://wp.org/wp-json/wp/v2/posts?foo=bar',
 		};
 
-		const callback = ( options ) => {
+		const callback: FetchHandler = async ( options ) => {
 			expect( options.url ).toBe(
 				'http://wp.org/wp-json/wp/v2/posts?foo=bar&_locale=user'
 			);
@@ -106,7 +107,7 @@ describe( 'User locale middleware', () => {
 			url: 'http://wp.org/wp-json/wp/v2/posts?_locale=foo',
 		};
 
-		const callback = ( options ) => {
+		const callback: FetchHandler = async ( options ) => {
 			expect( options.url ).toBe(
 				'http://wp.org/wp-json/wp/v2/posts?_locale=foo'
 			);
@@ -123,7 +124,7 @@ describe( 'User locale middleware', () => {
 			url: 'http://wp.org/wp-json/wp/v2/posts?foo=bar&_locale=foo',
 		};
 
-		const callback = ( options ) => {
+		const callback: FetchHandler = async ( options ) => {
 			expect( options.url ).toBe(
 				'http://wp.org/wp-json/wp/v2/posts?foo=bar&_locale=foo'
 			);

package/src/middlewares/theme-preview.ts

@@ -0,0 +1,60 @@
+/**
+ * WordPress dependencies
+ */
+import { addQueryArgs, getQueryArg, removeQueryArgs } from '@wordpress/url';
+/**
+ * Internal dependencies
+ */
+import type { APIFetchMiddleware } from '../types';
+
+/**
+ * This appends a `wp_theme_preview` parameter to the REST API request URL if
+ * the admin URL contains a `theme` GET parameter.
+ *
+ * If the REST API request URL has contained the `wp_theme_preview` parameter as `''`,
+ * then bypass this middleware.
+ *
+ * @param themePath
+ * @return  Preloading middleware.
+ */
+const createThemePreviewMiddleware =
+	( themePath: Record< string, any > ): APIFetchMiddleware =>
+	( options, next ) => {
+		if ( typeof options.url === 'string' ) {
+			const wpThemePreview = getQueryArg(
+				options.url,
+				'wp_theme_preview'
+			);
+			if ( wpThemePreview === undefined ) {
+				options.url = addQueryArgs( options.url, {
+					wp_theme_preview: themePath,
+				} );
+			} else if ( wpThemePreview === '' ) {
+				options.url = removeQueryArgs(
+					options.url,
+					'wp_theme_preview'
+				);
+			}
+		}
+
+		if ( typeof options.path === 'string' ) {
+			const wpThemePreview = getQueryArg(
+				options.path,
+				'wp_theme_preview'
+			);
+			if ( wpThemePreview === undefined ) {
+				options.path = addQueryArgs( options.path, {
+					wp_theme_preview: themePath,
+				} );
+			} else if ( wpThemePreview === '' ) {
+				options.path = removeQueryArgs(
+					options.path,
+					'wp_theme_preview'
+				);
+			}
+		}
+
+		return next( options );
+	};
+
+export default createThemePreviewMiddleware;

package/src/middlewares/{user-locale.js → user-locale.ts}

@@ -4,9 +4,11 @@
 import { addQueryArgs, hasQueryArg } from '@wordpress/url';
 
 /**
- * @type {import('../types').APIFetchMiddleware}
+ * Internal dependencies
  */
-const userLocaleMiddleware = ( options, next ) => {
+import type { APIFetchMiddleware } from '../types';
+
+const userLocaleMiddleware: APIFetchMiddleware = ( options, next ) => {
 	if (
 		typeof options.url === 'string' &&
 		! hasQueryArg( options.url, '_locale' )