Skip to content

[mapbox__mapbox-sdk] Fix GeocodeV6Request.proximity type#74803

Open
ricardohsweiss wants to merge 2 commits intoDefinitelyTyped:masterfrom
ricardohsweiss:patch-1
Open

[mapbox__mapbox-sdk] Fix GeocodeV6Request.proximity type#74803
ricardohsweiss wants to merge 2 commits intoDefinitelyTyped:masterfrom
ricardohsweiss:patch-1

Conversation

@ricardohsweiss
Copy link
Copy Markdown

Please fill in this template.

  • Use a meaningful title for the pull request. Include the name of the package modified.
  • Test the change in your own code. (Compile and run.)
  • Add or edit tests to reflect the change.
  • Follow the advice from the readme.
  • Avoid common mistakes.
  • Run pnpm test mapbox__mapbox-sdk.

If changing an existing definition:

Summary

In @mapbox/mapbox-sdk/services/geocoding-v6, GeocodeV6Request.proximity is currently typed as Coordinates | "ip" where Coordinates resolves to an object shape ({ longitude, latitude, ... }) in this module.

At runtime, proximity accepts coordinate tuples ([longitude, latitude]) or "ip". This mismatch causes incorrect TypeScript errors for valid usage and forces downstream casts.

This PR updates the type to use MapiRequestCoordinates | "ip" for GeocodeV6Request.proximity, aligning the v6 request type with runtime behavior and the existing imported tuple coordinate type.

@typescript-bot
Copy link
Copy Markdown
Contributor

typescript-bot commented Mar 26, 2026

@ricardohsweiss Thank you for submitting this PR! I see this is your first time submitting to DefinitelyTyped 👋 — I'm the local bot who will help you through the process of getting things through.

This is a live comment that I will keep updated.

1 package in this PR

Code Reviews

Because you edited one package and updated the tests (👏), I can help you merge this PR once someone else signs off on it.

You can test the changes of this PR in the Playground.

Status

  • ✅ No merge conflicts
  • ✅ Continuous integration tests have passed
  • 🕐 Most recent commit is approved by type definition owners or DT maintainers

Once every item on this list is checked, I'll ask you for permission to merge and publish the changes.

Inactive

This PR has been inactive for 10 days.


Diagnostic Information: What the bot saw about this PR
{
  "type": "info",
  "now": "-",
  "pr_number": 74803,
  "author": "ricardohsweiss",
  "headCommitOid": "d6f30841e94815f3308ddc48d16bd56246c0e80f",
  "mergeBaseOid": "b18c0e77059402c2fd62a7483e00dfd2209bf776",
  "lastPushDate": "2026-03-26T15:32:42.000Z",
  "lastActivityDate": "2026-03-26T15:32:42.000Z",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Popular",
  "pkgInfo": [
    {
      "name": "mapbox__mapbox-sdk",
      "kind": "edit",
      "files": [
        {
          "path": "types/mapbox__mapbox-sdk/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/mapbox__mapbox-sdk/mapbox__mapbox-sdk-tests.ts",
          "kind": "test"
        }
      ],
      "owners": [
        "jeffbdye",
        "mikeomeara1",
        "chachan",
        "techieshark",
        "rroohhh"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Popular"
    }
  ],
  "reviews": [],
  "mainBotCommentID": 4136012792,
  "ciResult": "pass"
}

@typescript-bot typescript-bot added Popular package This PR affects a popular package (as counted by NPM download counts). Untested Change This PR does not touch tests labels Mar 26, 2026
@typescript-bot
Copy link
Copy Markdown
Contributor

🔔 @jeffbdye @mikeomeara1 @chachan @techieshark @rroohhh — please review this PR in the next few days. Be sure to explicitly select Approve or Request Changes in the GitHub UI so I know what's going on.

@typescript-bot typescript-bot removed the Untested Change This PR does not touch tests label Mar 26, 2026
@typescript-bot typescript-bot moved this from Needs Maintainer Review to Waiting for Code Reviews in Pull Request Status Board Mar 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Popular package This PR affects a popular package (as counted by NPM download counts).

Projects

Status: Waiting for Code Reviews

Development

Successfully merging this pull request may close these issues.

2 participants