fix: add typesVersions so testing module resolves under classic TypeScript moduleResolution#764
Open
64johnlee wants to merge 1 commit into
Open
Conversation
…cript moduleResolution The exports map in package.json correctly declares the ./testing subpath, but TypeScript's moduleResolution: "node" (the default in most projects) does not read the exports field. This caused `getTestServer` and `getFunction` to appear not found when users imported @google-cloud/functions-framework/testing. Adding typesVersions instructs TypeScript to resolve the testing subpath to ./build/src/testing.d.ts regardless of moduleResolution setting, unblocking users on TypeScript <4.7 or projects that have not yet adopted node16/bundler module resolution. Fixes GoogleCloudPlatform#594 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
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
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.
Problem
The
./testingsubpath export is declared inexportscorrectly, but TypeScript's defaultmoduleResolution: "node"does not read theexportsfield inpackage.json. This means projects using the default (or older) TypeScript configuration get a type error when importing the testing utilities:Both
getTestServerandgetFunctionare affected.Root Cause
TypeScript only respects
exportssubpath maps whenmoduleResolutionis set to"node16","nodenext", or"bundler". Most projects still use"node"(the classic resolver), which only looks atmainandtypesat the package root.Fix
Add a
typesVersionsfield, which is the standard way to declare subpath type mappings for all TypeScript versions and moduleResolution modes:This is additive — projects already using
node16/bundlercontinue using theexportsmap; projects using classicnoderesolution now also work.Verification
After this change, the following import works without
moduleResolution: "node16":Fixes #594
🤖 Generated with Claude Code