@aws-amplify/geo 1.3.4 → 1.3.6-geo.14

package/src/Providers/AmazonLocationServiceProvider.ts

@@ -19,9 +19,11 @@ import {
 } from '@aws-amplify/core';
 import {
 	Place as PlaceResult,
-	SearchPlaceIndexForTextCommandInput,
 	LocationClient,
 	SearchPlaceIndexForTextCommand,
+	SearchPlaceIndexForTextCommandInput,
+	SearchPlaceIndexForSuggestionsCommand,
+	SearchPlaceIndexForSuggestionsCommandInput,
 	SearchPlaceIndexForPositionCommand,
 	SearchPlaceIndexForPositionCommandInput,
 	BatchPutGeofenceCommand,
@@ -45,6 +47,7 @@ import {
 	GeoConfig,
 	SearchByTextOptions,
 	SearchByCoordinatesOptions,
+	SearchForSuggestionsResults,
 	GeoProvider,
 	Place,
 	AmazonLocationServiceMapStyle,
@@ -221,6 +224,82 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		return results;
 	}
 
+	/**
+	 * Search for suggestions based on the input text
+	 * @param  {string} text - The text string that is to be searched for
+	 * @param  {SearchByTextOptions} options? - Optional parameters to the search
+	 * @returns {Promise<SearchForSuggestionsResults>} - Resolves to an array of search suggestion strings
+	 */
+
+	public async searchForSuggestions(
+		text: string,
+		options?: SearchByTextOptions
+	): Promise<SearchForSuggestionsResults> {
+		const credentialsOK = await this._ensureCredentials();
+		if (!credentialsOK) {
+			throw new Error('No credentials');
+		}
+
+		this._verifySearchIndex(options?.searchIndexName);
+
+		/**
+		 * Setup the searchInput
+		 */
+		const locationServiceInput: SearchPlaceIndexForSuggestionsCommandInput = {
+			Text: text,
+			IndexName: this._config.search_indices.default,
+		};
+
+		/**
+		 * Map search options to Amazon Location Service input object
+		 */
+		if (options) {
+			locationServiceInput.FilterCountries = options.countries;
+			locationServiceInput.MaxResults = options.maxResults;
+
+			if (options.searchIndexName) {
+				locationServiceInput.IndexName = options.searchIndexName;
+			}
+
+			if (options['biasPosition'] && options['searchAreaConstraints']) {
+				throw new Error(
+					'BiasPosition and SearchAreaConstraints are mutually exclusive, please remove one or the other from the options object'
+				);
+			}
+			if (options['biasPosition']) {
+				locationServiceInput.BiasPosition = options['biasPosition'];
+			}
+			if (options['searchAreaConstraints']) {
+				locationServiceInput.FilterBBox = options['searchAreaConstraints'];
+			}
+		}
+
+		const client = new LocationClient({
+			credentials: this._config.credentials,
+			region: this._config.region,
+			customUserAgent: getAmplifyUserAgent(),
+		});
+		const command = new SearchPlaceIndexForSuggestionsCommand(
+			locationServiceInput
+		);
+
+		let response;
+		try {
+			response = await client.send(command);
+		} catch (error) {
+			logger.debug(error);
+			throw error;
+		}
+
+		/**
+		 * The response from Amazon Location Service is a "Results" array of objects with a single `Text` item.
+		 * Here we want to flatten that to an array of just the strings from those `Text` items.
+		 */
+		const results = response.Results.map(result => result.Text);
+
+		return results;
+	}
+
 	/**
 	 * Reverse geocoding search via a coordinate point on the map
 	 * @param coordinates - Coordinates array for the search input

package/src/types/Geo.ts

@@ -84,6 +84,9 @@ export type SearchByCoordinatesOptions = {
 	providerName?: string;
 };
 
+// Return type for searchForSuggestions
+export type SearchForSuggestionsResults = string[];
+
 // Geometry object for Place points
 export type PlaceGeometry = {
 	point: Coordinates;

package/src/types/Provider.ts

@@ -13,6 +13,7 @@
 import {
 	SearchByTextOptions,
 	SearchByCoordinatesOptions,
+	SearchForSuggestionsResults,
 	Coordinates,
 	Place,
 	MapStyle,
@@ -51,6 +52,12 @@ export interface GeoProvider {
 		options?: SearchByCoordinatesOptions
 	): Promise<Place>;
 
+	// search for suggestions based on a text string
+	searchForSuggestions(
+		text: string,
+		options?: SearchByTextOptions
+	): Promise<SearchForSuggestionsResults>;
+
 	// create geofences
 	saveGeofences(
 		geofences: GeofenceInput[],