@aws-amplify/geo 1.1.13 → 1.1.14-beta.8

package/src/Providers/AmazonLocationServiceProvider.ts

@@ -18,9 +18,11 @@ import {
 } from '@aws-amplify/core';
 import {
 	Place as PlaceResult,
-	SearchPlaceIndexForTextCommandInput,
 	LocationClient,
 	SearchPlaceIndexForTextCommand,
+	SearchPlaceIndexForTextCommandInput,
+	SearchPlaceIndexForSuggestionsCommand,
+	SearchPlaceIndexForSuggestionsCommandInput,
 	SearchPlaceIndexForPositionCommand,
 	SearchPlaceIndexForPositionCommandInput,
 } from '@aws-sdk/client-location';
@@ -33,6 +35,7 @@ import {
 	Place,
 	AmazonLocationServiceMapStyle,
 	Coordinates,
+	SearchForSuggestionsResults,
 } from '../types';
 
 const logger = new Logger('AmazonLocationServiceProvider');
@@ -188,9 +191,85 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		const PascalResults: PlaceResult[] = response.Results.map(
 			result => result.Place
 		);
-		const results: Place[] = (camelcaseKeys(PascalResults, {
+		const results: Place[] = camelcaseKeys(PascalResults, {
 			deep: true,
-		}) as undefined) as Place[];
+		}) as undefined as Place[];
+
+		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;
 	}
@@ -247,9 +326,9 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		 * Here we want to flatten that to an array of results and change them to camelCase
 		 */
 		const PascalResults = response.Results.map(result => result.Place);
-		const results: Place = (camelcaseKeys(PascalResults[0], {
+		const results: Place = camelcaseKeys(PascalResults[0], {
 			deep: true,
-		}) as any) as Place;
+		}) as any as Place;
 
 		return results;
 	}

package/src/types/Geo.ts

@@ -97,3 +97,6 @@ export interface Place {
 	street?: string;
 	subRegion?: string;
 }
+
+// Return type for searchForSuggestions
+export type SearchForSuggestionsResults = string[];

package/src/types/Provider.ts

@@ -14,6 +14,7 @@
 import {
 	SearchByTextOptions,
 	SearchByCoordinatesOptions,
+	SearchForSuggestionsResults,
 	Coordinates,
 	Place,
 	MapStyle,
@@ -41,4 +42,9 @@ export interface GeoProvider {
 		coordinates: Coordinates,
 		options?: SearchByCoordinatesOptions
 	): Promise<Place>;
+
+	searchForSuggestions(
+		text: string,
+		options?: SearchByTextOptions
+	): Promise<SearchForSuggestionsResults>;
 }