RTFDB-4842: Improve user input handling in "mapbox-gl-geocoder"

[pahuta]

• Add function to parse different spatial formats which can be used to configure localGeocoder function
• Add isValidTile, isValidQuadkey, tileToLngLat and quadkeyToTile helpers to lib/utils.js
• Use the parsed zoom when flying to a selected feature that has no bbox
• Fix the suggestion list not updating after cutting (Cmd/Ctrl+X) or undoing (Cmd/Ctrl+Z) a change to the search input

https://mapbox.atlassian.net/browse/RTFDB-4842

• briefly describe the changes in this PR
• write tests for all new functionality
• run npm run docs and commit changes to API.md
• update CHANGELOG.md with changes under main heading before merging

Parsing extended spatial formats when enabled:

parseExtendedSpatialFormats.mp4

Previous vs current behavior when user cut or undo search input value

cut_undo.mp4

[stepankuzmin]

Doesn't that break the externalGeocoder?

[pahuta]

No - that branch was already dead code for externalGeocoder before the removal. At that point externalGeocoderRes:

• holds an empty array (initial value) if the geocoding request failed the very first time
• holds a Promise (from this.options.externalGeocoder(...) || Promise.resolve([])), not a resolved array, so externalGeocoderRes.length was always undefined/falsy.

The condition could never be satisfied through the externalGeocoder side. So removing it doesn't change behavior for externalGeocoder at all.

[stepankuzmin]

Leftover?

[stepankuzmin]

If we want to have built-in local geocoders, we need to expose them so they are available on the imported object, e.g. something like:

const {slashSeparatedZoomLatLng, commaSeparatedLngLatZoom, tile, quadkey} = MapboxGeocoder.localGeocoders;

…and then we can use them like:

Suggested change

	var spatialFeatures = [
	spatialFormats.parseSlashSeparatedZoomLatLng(query),
	spatialFormats.parseCommaSeparatedLngLatZoom(query),
	spatialFormats.parseTile(query),
	spatialFormats.parseQuadkey(query)
	].filter(Boolean);
	return [
	slashSeparatedZoomLatLng(query),
	commaSeparatedLngLatZoom(query),
	tile(query),
	quadkey(query),
	coordinatesGeocoder(query)
	].filter(Boolean);

[stepankuzmin]

Suggested change

	var spatialFormats = require('../lib/spatial-formats');
	const {slashSeparatedZoomLatLng, commaSeparatedLngLatZoom, tile, quadkey} = MapboxGeocoder.localGeocoders;