Skip to content

Commit

Permalink
Merge pull request #15 from zdila/geocoding-api-update
Browse files Browse the repository at this point in the history 
updated geocoding API
  • Loading branch information
@jonathanlurie
jonathanlurie authored Mar 3, 2023
2 parents ba8c80a + d000e78 commit 5fa2a6c
Show file tree
Hide file tree
Showing 74 changed files with 1,004 additions and 588 deletions.
87 changes: 55 additions & 32 deletions dist/maptiler-client.cjs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,30 @@ const customMessages$3 = {
400: "Query too long / Invalid parameters",
403: "Key is missing, invalid or restricted"
};
function addLanguageGeocodingOptions(searchParams, options) {
if (options.language == void 0) {
return;
}
const languages = Array.from(
new Set(
(Array.isArray(options.language) ? options.language : [options.language]).map(
(lang) => lang === LanguageGeocoding.AUTO ? getAutoLanguageGeocoding() : lang
)
)
).join(",");
searchParams.set("language", languages);
}
function addCommonForwardAndReverseGeocodingOptions(searchParams, options) {
var _a;
searchParams.set("key", (_a = options.apiKey) != null ? _a : config.apiKey);
if (options.limit != void 0) {
searchParams.set("limit", String(options.limit));
}
if (options.types != void 0) {
searchParams.set("types", options.types.join(","));
}
addLanguageGeocodingOptions(searchParams, options);
}
function forward(_0) {
return __async$3(this, arguments, function* (query, options = {}) {
var _a;
Expand All @@ -203,30 +227,27 @@ function forward(_0) {
`geocoding/${encodeURIComponent(query)}.json`,
defaults.maptilerApiURL
);
endpoint.searchParams.set("key", (_a = options.apiKey) != null ? _a : config.apiKey);
if ("bbox" in options) {
endpoint.searchParams.set("bbox", options.bbox.join(","));
const { searchParams } = endpoint;
addCommonForwardAndReverseGeocodingOptions(searchParams, options);
if (options.bbox != void 0) {
searchParams.set("bbox", options.bbox.join(","));
}
if ("proximity" in options) {
endpoint.searchParams.set("proximity", options.proximity.join(","));
if (options.proximity != void 0) {
searchParams.set("proximity", options.proximity.join(","));
}
if ("language" in options) {
const languages = Array.from(
new Set(
(Array.isArray(options.language) ? options.language : [options.language]).map(
(lang) => lang === LanguageGeocoding.AUTO ? getAutoLanguageGeocoding() : lang
)
)
).join(",");
endpoint.searchParams.set("language", languages);
if (options.country != void 0) {
searchParams.set("country", options.country.join(","));
}
if (options.fuzzyMatch != void 0) {
searchParams.set("fuzzyMatch", options.fuzzyMatch ? "true" : "false");
}
if (options.autocomplete != void 0) {
searchParams.set("autocomplete", options.autocomplete ? "true" : "false");
}
const urlWithParams = endpoint.toString();
const res = yield callFetch(urlWithParams);
if (!res.ok) {
throw new ServiceError(
res,
res.status in customMessages$3 ? customMessages$3[res.status] : ""
);
throw new ServiceError(res, (_a = customMessages$3[res.status]) != null ? _a : "");
}
const obj = yield res.json();
return obj;
Expand All @@ -242,24 +263,25 @@ function reverse(_0) {
`geocoding/${position[0]},${position[1]}.json`,
defaults.maptilerApiURL
);
endpoint.searchParams.set("key", (_a = options.apiKey) != null ? _a : config.apiKey);
if ("language" in options) {
const languages = Array.from(
new Set(
(Array.isArray(options.language) ? options.language : [options.language]).map(
(lang) => lang === LanguageGeocoding.AUTO ? getAutoLanguageGeocoding() : lang
)
)
).join(",");
endpoint.searchParams.set("language", languages);
addCommonForwardAndReverseGeocodingOptions(endpoint.searchParams, options);
const urlWithParams = endpoint.toString();
const res = yield callFetch(urlWithParams);
if (!res.ok) {
throw new ServiceError(res, (_a = customMessages$3[res.status]) != null ? _a : "");
}
const obj = yield res.json();
return obj;
});
}
function byId(_0) {
return __async$3(this, arguments, function* (id, options = {}) {
var _a;
const endpoint = new URL(`geocoding/${id}.json`, defaults.maptilerApiURL);
addLanguageGeocodingOptions(endpoint.searchParams, options);
const urlWithParams = endpoint.toString();
const res = yield callFetch(urlWithParams);
if (!res.ok) {
throw new ServiceError(
res,
res.status in customMessages$3 ? customMessages$3[res.status] : ""
);
throw new ServiceError(res, (_a = customMessages$3[res.status]) != null ? _a : "");
}
const obj = yield res.json();
return obj;
Expand All @@ -268,6 +290,7 @@ function reverse(_0) {
const geocoding = {
forward,
reverse,
byId,
language: LanguageGeocoding
};

Expand Down
2 changes: 1 addition & 1 deletion dist/maptiler-client.cjs.map
View file

Large diffs are not rendered by default.

81 changes: 53 additions & 28 deletions dist/maptiler-client.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,11 +103,27 @@ type Values<T> = T[keyof T];
*/
type LanguageGeocodingString = Values<typeof LanguageGeocoding>;

type GeocodingOptions = {
type LanguageGeocodingOptions = {
/**
* Custom mapTiler Cloud API key to use instead of the one in global `config`
* Prefer results in specific language. It’s possible to specify multiple values.
*/
language?: LanguageGeocodingString | Array<LanguageGeocodingString>;
};
type CommonForwardAndReverseGeocodingOptions = LanguageGeocodingOptions & {
/**
* Custom MapTiler Cloud API key to use instead of the one in global `config`
*/
apiKey?: string;
/**
* Maximum number of results to show. Must be between 1 and 10. Default is 5 for forward and 1 for reverse geocoding.
*/
limit?: number;
/**
* Filter of feature types to return. If not specified, all available feature types are returned.
*/
types?: ("country" | "region" | "subregion" | "county" | "joint_municipality" | "joint_submunicipality" | "municipality" | "municipal_district" | "locality" | "neighbourhood" | "place" | "postal_code" | "address")[];
};
type GeocodingOptions = CommonForwardAndReverseGeocodingOptions & {
/**
* Only search for results in the specified area.
*/
Expand All @@ -117,10 +133,21 @@ type GeocodingOptions = {
*/
proximity?: Position;
/**
* Prefer results in specific language. It’s possible to specify multiple values.
* Limit search to specific country/countries specified as list of Alpha-2 ISO 3166-1 codes.
*/
language?: LanguageGeocodingString | Array<LanguageGeocodingString>;
country?: string[];
/**
* Set to `false` to disable fuzzy (typo-tolerant) search. Default is `true`.
*/
fuzzyMatch?: boolean;
/**
* Set to `true` to use autocomplete, `false` to disable it.
* Default (`undefined`) is to combine autocomplete with non-autocomplete results.
*/
autocomplete?: boolean;
};
type ReverseGeocodingOptions = CommonForwardAndReverseGeocodingOptions;
type ByIdGeocodingOptions = LanguageGeocodingOptions;
type Coordinates = Position;
type FeatureHierarchy = {
/**
Expand Down Expand Up @@ -183,25 +210,25 @@ type GeocodingSearchResult = {
* @returns
*/
declare function forward(query: string, options?: GeocodingOptions): Promise<GeocodingSearchResult>;
type ReverseGeocodingOptions = {
/**
* Custom mapTiler Cloud API key to use instead of the one in global `config`
*/
apiKey?: string;
/**
* Prefer results in specific language. It’s possible to specify multiple values.
*/
language?: LanguageGeocodingString | Array<LanguageGeocodingString>;
};
/**
* Perform a reverse geocoding query to MapTiler API.
* Providing a longitude and latitude, this function returns a set of human readable information abou this place (country, city, street, etc.)
* Providing a longitude and latitude, this function returns a set of human readable information about this place (country, city, street, etc.)
* Learn more on the MapTiler API reference page: https://docs.maptiler.com/cloud/api/geocoding/#search-by-coordinates-reverse
* @param position
* @param options
* @returns
*/
declare function reverse(position: Position, options?: ReverseGeocodingOptions): Promise<GeocodingSearchResult>;
/**
* Perform a geocoding query to MapTiler API to obtain fature by its ID.
* Providing a feature ID, this function returns a feature which includes its full geometry.
* Note that the feature ID is not stable and it changes when the database is re-indexed.
* Learn more on the MapTiler API reference page: https://docs.maptiler.com/cloud/api/geocoding/#search-by-feature-id
* @param id
* @param options
* @returns
*/
declare function byId(id: string, options?: ByIdGeocodingOptions): Promise<GeocodingSearchResult>;
/**
* The **geocoding** namespace contains asynchronous functions to call the [MapTiler Geocoding API](https://docs.maptiler.com/cloud/api/geocoding/).
* The **Geocoding API** provides ways to get geographic coordinates from a human-readable search query of a place (forward geocoding)
Expand All @@ -210,6 +237,7 @@ declare function reverse(position: Position, options?: ReverseGeocodingOptions):
declare const geocoding: {
forward: typeof forward;
reverse: typeof reverse;
byId: typeof byId;
language: {
AUTO: string;
ALBANIAN: string;
Expand All @@ -229,18 +257,13 @@ declare const geocoding: {
ENGLISH: string;
ESPERANTO: string;
ESTONIAN: string;
/**
* Custom mapTiler Cloud API key to use instead of the one in global `config`
*/
FINNISH: string;
FRENCH: string;
FRISIAN: string;
GEORGIAN: string;
GERMAN: string;
GREEK: string;
HEBREW: string; /**
* Only search for results in the specified area.
*/
HEBREW: string;
HUNGARIAN: string;
ICELANDIC: string;
IRISH: string;
Expand All @@ -255,7 +278,9 @@ declare const geocoding: {
LUXEMBOURGISH: string;
MACEDONIAN: string;
MALTESE: string;
NORWEGIAN: string;
NORWEGIAN: string; /**
* Maximum number of results to show. Must be between 1 and 10. Default is 5 for forward and 1 for reverse geocoding.
*/
POLISH: string;
PORTUGUESE: string;
ROMANIAN: string;
Expand All @@ -279,7 +304,7 @@ declare const geocoding: {
*/
type GeolocationInfoOptions = {
/**
* Custom mapTiler Cloud API key to use instead of the one in global `config`
* Custom MapTiler Cloud API key to use instead of the one in global `config`
*/
apiKey?: string;
};
Expand Down Expand Up @@ -370,7 +395,7 @@ declare const geolocation: {

type CoordinatesSearchOptions = {
/**
* Custom mapTiler Cloud API key to use instead of the one in global `config`
* Custom MapTiler Cloud API key to use instead of the one in global `config`
*/
apiKey?: string;
/**
Expand Down Expand Up @@ -467,7 +492,7 @@ type CoordinateTransformResult = {
*/
type CoordinatesTransformOptions = {
/**
* Custom mapTiler Cloud API key to use instead of the one in global `config`
* Custom MapTiler Cloud API key to use instead of the one in global `config`
*/
apiKey?: string;
/**
Expand Down Expand Up @@ -505,7 +530,7 @@ declare const coordinates: {
*/
type GetDataOptions = {
/**
* Custom mapTiler Cloud API key to use instead of the one in global `config`
* Custom MapTiler Cloud API key to use instead of the one in global `config`
*/
apiKey?: string;
};
Expand Down Expand Up @@ -932,7 +957,7 @@ declare const MapStyle: MapStyleType;
*/
type StaticMapBaseOptions = {
/**
* Custom mapTiler Cloud API key to use instead of the one in global `config`
* Custom MapTiler Cloud API key to use instead of the one in global `config`
*/
apiKey?: string;
/**
Expand Down Expand Up @@ -1102,4 +1127,4 @@ declare class ServiceError extends Error {
constructor(res: Response, customMessage?: string);
}

export { AutomaticStaticMapOptions, BoundedStaticMapOptions, CenteredStaticMapOptions, ClientConfig, CoordinateExport, CoordinateGrid, CoordinateId, CoordinateSearch, CoordinateSearchResult, CoordinateTransformResult, CoordinateTransformation, Coordinates, CoordinatesSearchOptions, CoordinatesTransformOptions, FeatureHierarchy, FetchFunction, GeocodingFeature, GeocodingOptions, GeocodingSearchResult, GeolocationInfoOptions, GeolocationResult, GetDataOptions, LanguageGeocoding, LanguageGeocodingString, MapStyle, MapStylePreset, MapStyleType, MapStyleVariant, ReferenceMapStyle, ReverseGeocodingOptions, ServiceError, StaticMapBaseOptions, StaticMapMarker, XYZ, config, coordinates, data, expandMapStyle, geocoding, geolocation, mapStylePresetList, staticMaps };
export { AutomaticStaticMapOptions, BoundedStaticMapOptions, CenteredStaticMapOptions, ClientConfig, CommonForwardAndReverseGeocodingOptions, CoordinateExport, CoordinateGrid, CoordinateId, CoordinateSearch, CoordinateSearchResult, CoordinateTransformResult, CoordinateTransformation, Coordinates, CoordinatesSearchOptions, CoordinatesTransformOptions, FeatureHierarchy, FetchFunction, GeocodingFeature, GeocodingOptions, GeocodingSearchResult, GeolocationInfoOptions, GeolocationResult, GetDataOptions, LanguageGeocoding, LanguageGeocodingOptions, LanguageGeocodingString, MapStyle, MapStylePreset, MapStyleType, MapStyleVariant, ReferenceMapStyle, ReverseGeocodingOptions, ServiceError, StaticMapBaseOptions, StaticMapMarker, XYZ, config, coordinates, data, expandMapStyle, geocoding, geolocation, mapStylePresetList, staticMaps };
2 changes: 1 addition & 1 deletion dist/maptiler-client.min.mjs
View file

Large diffs are not rendered by default.

Loading

0 comments on commit 5fa2a6c

Please sign in to comment.