Skip to content

docs: list the remaining type renames in the v8 upgrade guide - #2619

Open
imkath wants to merge 1 commit into
visgl:masterfrom
imkath:docs/v8-upgrade-type-renames
Open

imkath wants to merge 1 commit into
visgl:masterfrom
imkath:docs/v8-upgrade-type-renames

Conversation

@imkath

@imkath imkath commented Oct 13, 2026

Copy link
Copy Markdown

Closes #2550.

The v8 section covers the *Layer and *SourceRaw renames but misses a few more, so code that compiled on 7.x breaks with no hint in the guide.

I diffed the type exports of 7.1.9 against 8.1.3 (/mapbox, /mapbox-legacy and /maplibre) and checked every old and new name with tsc:

  • added AnyLayer, AnySource, RasterSource, RasterDemSource and MapboxStyle to the existing table (RasterDEMSourceSpecification is spelled differently in mapbox-legacy)
  • a second table for the Mapbox-only names; /maplibre still exports the MapLayer*Event types
  • a note that the source classes are no longer re-exported
  • a note on LayerProps: the field wasn't removed, the type now includes CustomLayerInterface, so reading metadata needs a type !== 'custom' check

@greptile-apps

greptile-apps Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

RetriggerConfidence Score: 5/5

[Low impact] This documentation-only change appears safe to merge.

Summary

Expands the v8 upgrade guide with the remaining type renames.

  • The v8 guide lists more renamed style and source types.
  • The v8 guide lists renamed types for Mapbox imports.
  • The v8 guide points source-class imports to the base map packages.
  • The v8 guide shows how to check a layer before reading its metadata.

No actionable issues found.

Reviews (1) · Last reviewed commit: "docs: list the remaining type renames in..." · Reviewed by Greptile

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug] Missing info in upgrade guide

1 participant