Convert api-fetch package to TypeScript #67669
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
manzoorwanijk
added
[Type] Code Quality
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Size Change: -2 B (0%) Total Size: 1.91 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in 5274343. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/16641709143
|
There was a problem hiding this comment.
Pull Request Overview
This PR converts the api-fetch package to TypeScript while improving type definitions and updating corresponding unit tests. Key changes include converting JS files to TS with explicit type annotations, enhancing API fetch types based on the parse option, and updating test files with async FetchHandler type declarations.
Reviewed Changes
Copilot reviewed 22 out of 22 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/api-fetch/src/middlewares/user-locale.ts | Converted to TS with added import type and updated JSDoc. |
| packages/api-fetch/src/middlewares/theme-preview.ts | New TS implementation with type annotations. |
| packages/api-fetch/src/middlewares/theme-preview.js | Removed as part of the conversion. |
| packages/api-fetch/src/middlewares/test/* | Updated test files (user-locale, root-url, preloading, nonce, namespace-endpoint, media-upload, http-v1, fetch-all-middleware) to use async FetchHandler types. |
| packages/api-fetch/src/middlewares/root-url.ts | Converted to TS with updated URL handling. |
| packages/api-fetch/src/middlewares/preloading.ts | Added TS types and refined prepareResponse function. |
| packages/api-fetch/src/middlewares/nonce.ts | Converted to TS and improved middleware type signatures. |
| packages/api-fetch/src/middlewares/namespace-endpoint.ts | Updated middleware to TS with explicit type declarations. |
| packages/api-fetch/src/middlewares/media-upload.ts | Converted to TS with proper type definitions for request options and middleware logic. |
| packages/api-fetch/src/middlewares/http-v1.ts | Converted to TS with updated override logic and type safety. |
| packages/api-fetch/src/middlewares/fetch-all-middleware.ts | Updated to TS with improved type annotations and proper import changes. |
| packages/api-fetch/src/index.ts | Main entry point converted to TS with enhanced type definitions and middleware chaining logic. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Supercedes #67510, which got closed after I deleted my fork 🤦
What?
api-fetchpackage to TypeScriptparseoptionWhy?
Improve the DX
and fix an issue when used in ES ModulesHow?
By renaming the files and updating types
Testing Instructions