@aws-amplify/geo 3.0.21 → 3.0.22-unstable.bd1fefd.0

package/src/providers/location-service/AmazonLocationServiceProvider.ts

@@ -1,34 +1,33 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import camelcaseKeys from 'camelcase-keys';
-
-import { Amplify, fetchAuthSession, ConsoleLogger } from '@aws-amplify/core';
+import { Amplify, ConsoleLogger, fetchAuthSession } from '@aws-amplify/core';
 import { GeoAction } from '@aws-amplify/core/internals/utils';
 import {
-	Place as PlaceResult,
-	LocationClient,
-	SearchPlaceIndexForTextCommand,
-	SearchPlaceIndexForTextCommandInput,
-	SearchPlaceIndexForSuggestionsCommand,
-	SearchPlaceIndexForSuggestionsCommandInput,
-	SearchPlaceIndexForPositionCommand,
-	SearchPlaceIndexForPositionCommandInput,
+	BatchDeleteGeofenceCommand,
+	BatchDeleteGeofenceCommandInput,
+	BatchDeleteGeofenceCommandOutput,
 	BatchPutGeofenceCommand,
 	BatchPutGeofenceCommandInput,
-	BatchPutGeofenceRequestEntry,
 	BatchPutGeofenceCommandOutput,
-	GetPlaceCommand,
-	GetPlaceCommandInput,
-	GetPlaceCommandOutput,
+	BatchPutGeofenceRequestEntry,
 	GetGeofenceCommand,
 	GetGeofenceCommandInput,
 	GetGeofenceCommandOutput,
+	GetPlaceCommand,
+	GetPlaceCommandInput,
+	GetPlaceCommandOutput,
 	ListGeofencesCommand,
 	ListGeofencesCommandInput,
 	ListGeofencesCommandOutput,
-	BatchDeleteGeofenceCommand,
-	BatchDeleteGeofenceCommandInput,
-	BatchDeleteGeofenceCommandOutput,
+	LocationClient,
+	Place as PlaceResult,
+	SearchPlaceIndexForPositionCommand,
+	SearchPlaceIndexForPositionCommandInput,
+	SearchPlaceIndexForSuggestionsCommand,
+	SearchPlaceIndexForSuggestionsCommandInput,
+	SearchPlaceIndexForTextCommand,
+	SearchPlaceIndexForTextCommandInput,
 } from '@aws-sdk/client-location';
 
 import {
@@ -37,28 +36,27 @@ import {
 	validateGeofenceId,
 	validateGeofencesInput,
 } from '../../util';
-
 import {
-	GeoConfig,
-	SearchByTextOptions,
-	SearchByCoordinatesOptions,
-	GeoProvider,
-	Place,
+	AmazonLocationServiceBatchGeofenceErrorMessages,
+	AmazonLocationServiceDeleteGeofencesResults,
+	AmazonLocationServiceGeofence,
+	AmazonLocationServiceGeofenceOptions,
+	AmazonLocationServiceGeofenceStatus,
+	AmazonLocationServiceListGeofenceOptions,
 	AmazonLocationServiceMapStyle,
 	Coordinates,
-	SearchForSuggestionsResults,
+	GeoConfig,
+	GeoProvider,
 	GeofenceId,
 	GeofenceInput,
-	AmazonLocationServiceGeofenceOptions,
-	AmazonLocationServiceListGeofenceOptions,
+	GeofencePolygon,
 	ListGeofenceResults,
-	AmazonLocationServiceGeofenceStatus,
+	Place,
 	SaveGeofencesResults,
-	AmazonLocationServiceGeofence,
-	GeofencePolygon,
-	AmazonLocationServiceDeleteGeofencesResults,
+	SearchByCoordinatesOptions,
+	SearchByTextOptions,
+	SearchForSuggestionsResults,
 	searchByPlaceIdOptions,
-	AmazonLocationServiceBatchGeofenceErrorMessages,
 } from '../../types';
 
 const logger = new ConsoleLogger('AmazonLocationServiceProvider');
@@ -78,7 +76,7 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 	 * @param {Object} config - Configuration object for Geo
 	 */
 	constructor(config?: GeoConfig) {
-		this._config = config ? config : {};
+		this._config = config || {};
 		logger.debug('Geo Options', this._config);
 	}
 
@@ -107,10 +105,10 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 
 		const mapStyles: AmazonLocationServiceMapStyle[] = [];
 		const availableMaps = this._config.maps.items;
-		const region = this._config.region;
+		const { region } = this._config;
 
 		for (const mapName in availableMaps) {
-			const style = availableMaps[mapName].style;
+			const { style } = availableMaps[mapName];
 			mapStyles.push({ mapName, style, region });
 		}
 
@@ -125,8 +123,8 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		this._verifyMapResources();
 
 		const mapName = this._config.maps.default;
-		const style = this._config.maps.items[mapName].style;
-		const region = this._config.region;
+		const { style } = this._config.maps.items[mapName];
+		const { region } = this._config;
 
 		return { mapName, style, region };
 	}
@@ -306,7 +304,6 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		if (place) {
 			return camelcaseKeys(place, { deep: true }) as unknown as Place;
 		}
-		return;
 	}
 
 	/**
@@ -372,7 +369,7 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 	 * Create geofences inside of a geofence collection
 	 * @param geofences Array of geofence objects to create
 	 * @param options Optional parameters for creating geofences
-	 * @returns {Promise<AmazonLocationServiceSaveGeofencesResults>} - Promise that resolves to an object with:
+	 * @returns a promise that resolves to an object that conforms to {@link SaveGeofencesResults}:
 	 *   successes: list of geofences successfully created
 	 *   errors: list of geofences that failed to create
 	 */
@@ -443,14 +440,15 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 							},
 						});
 					});
+
 					return;
 				}
 
 				// Push all successes to results
 				response.Successes?.forEach(success => {
-					const { GeofenceId, CreateTime, UpdateTime } = success;
+					const { GeofenceId: geofenceId, CreateTime, UpdateTime } = success;
 					results.successes.push({
-						geofenceId: GeofenceId!,
+						geofenceId: geofenceId!,
 						createTime: CreateTime,
 						updateTime: UpdateTime,
 					});
@@ -458,14 +456,14 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 
 				// Push all errors to results
 				response.Errors?.forEach(error => {
-					const { Error, GeofenceId } = error;
+					const { Error, GeofenceId: geofenceId } = error;
 					const { Code, Message } = Error!;
 					results.errors.push({
 						error: {
 							code: Code!,
 							message: Message!,
 						},
-						geofenceId: GeofenceId!,
+						geofenceId: geofenceId!,
 					});
 				});
 			}),
@@ -524,10 +522,16 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		}
 
 		// Convert response to camelCase for return
-		const { GeofenceId, CreateTime, UpdateTime, Status, Geometry } = response;
+		const {
+			GeofenceId: responseGeofenceId,
+			CreateTime,
+			UpdateTime,
+			Status,
+			Geometry,
+		} = response;
 		const geofence: AmazonLocationServiceGeofence = {
 			createTime: CreateTime,
-			geofenceId: GeofenceId!,
+			geofenceId: responseGeofenceId!,
 			geometry: {
 				polygon: Geometry!.Polygon as GeofencePolygon,
 			},
@@ -541,7 +545,7 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 	/**
 	 * List geofences from a geofence collection
 	 * @param  options ListGeofenceOptions
-	 * @returns {Promise<ListGeofencesResults>} - Promise that resolves to an object with:
+	 * @returns a promise that resolves to an object that conforms to {@link ListGeofenceResults}:
 	 *   entries: list of geofences - 100 geofences are listed per page
 	 *   nextToken: token for next page of geofences
 	 */
@@ -594,9 +598,15 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 
 		const results: ListGeofenceResults = {
 			entries: Entries!.map(
-				({ GeofenceId, CreateTime, UpdateTime, Status, Geometry }) => {
+				({
+					GeofenceId: geofenceId,
+					CreateTime,
+					UpdateTime,
+					Status,
+					Geometry,
+				}) => {
 					return {
-						geofenceId: GeofenceId!,
+						geofenceId: geofenceId!,
 						createTime: CreateTime,
 						updateTime: UpdateTime,
 						status: Status,
@@ -616,7 +626,7 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 	 * Delete geofences from a geofence collection
 	 * @param geofenceIds string|string[]
 	 * @param options GeofenceOptions
-	 * @returns {Promise<DeleteGeofencesResults>} - Promise that resolves to an object with:
+	 * @returns a promise that resolves to an object that conforms to {@link AmazonLocationServiceDeleteGeofencesResults}:
 	 *  successes: list of geofences successfully deleted
 	 *  errors: list of geofences that failed to delete
 	 */
@@ -642,6 +652,8 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 			} catch (error) {
 				return true;
 			}
+
+			return false;
 		});
 		if (badGeofenceIds.length > 0) {
 			throw new Error(`Invalid geofence ids: ${badGeofenceIds.join(', ')}`);
@@ -681,17 +693,19 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 						};
 						results.errors.push(errorObject);
 					});
+
 					return;
 				}
 
-				const badGeofenceIds = response.Errors.map(
+				const targetBadGeofenceIds = response.Errors.map(
 					({ geofenceId }) => geofenceId,
 				);
 				results.successes.push(
-					...batch.filter(Id => !badGeofenceIds.includes(Id)),
+					...batch.filter(Id => !targetBadGeofenceIds.includes(Id)),
 				);
 			}),
 		);
+
 		return results;
 	}
 
@@ -700,16 +714,18 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 	 */
 	private async _ensureCredentials(): Promise<boolean> {
 		try {
-			const credentials = (await fetchAuthSession()).credentials;
+			const { credentials } = await fetchAuthSession();
 			if (!credentials) return false;
 			logger.debug(
 				'Set credentials for storage. Credentials are:',
 				credentials,
 			);
 			this._credentials = credentials;
+
 			return true;
 		} catch (error) {
 			logger.debug('Ensure credentials error. Credentials are:', error);
+
 			return false;
 		}
 	}
@@ -785,13 +801,7 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		});
 		const command = new BatchPutGeofenceCommand(geofenceInput);
 
-		let response: BatchPutGeofenceCommandOutput;
-		try {
-			response = await client.send(command);
-		} catch (error) {
-			throw error;
-		}
-		return response;
+		return client.send(command);
 	}
 
 	private async _AmazonLocationServiceBatchDeleteGeofenceCall(
@@ -812,12 +822,6 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		});
 		const command = new BatchDeleteGeofenceCommand(deleteGeofencesInput);
 
-		let response: BatchDeleteGeofenceCommandOutput;
-		try {
-			response = await client.send(command);
-		} catch (error) {
-			throw error;
-		}
-		return response;
+		return client.send(command);
 	}
 }

package/src/types/AmazonLocationServiceProvider.ts

@@ -1,12 +1,12 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import {
-	MapStyle,
-	GeofenceOptions,
-	ListGeofenceOptions,
-	Geofence,
 	DeleteGeofencesResults,
+	Geofence,
 	GeofenceError,
+	GeofenceOptions,
+	ListGeofenceOptions,
+	MapStyle,
 } from './Geo';
 
 // Maps

package/src/types/Geo.ts

@@ -53,20 +53,20 @@ export type SearchByTextOptions =
 	| SearchByTextOptionsWithSearchAreaConstraints;
 
 // Options object for searchByCoordinates
-export type SearchByCoordinatesOptions = {
+export interface SearchByCoordinatesOptions {
 	maxResults?: number;
 	searchIndexName?: string;
 	providerName?: string;
-};
+}
 
-export type searchByPlaceIdOptions = {
+export interface searchByPlaceIdOptions {
 	searchIndexName?: string;
-};
+}
 
 // Geometry object for Place points
-export type PlaceGeometry = {
+export interface PlaceGeometry {
 	point: Coordinates;
-};
+}
 
 // Place object with locality information
 export interface Place {
@@ -88,38 +88,38 @@ export type LinearRing = Coordinates[];
 export type GeofencePolygon = LinearRing[];
 
 // Geometry object for Polygon
-export type PolygonGeometry = {
+export interface PolygonGeometry {
 	polygon: GeofencePolygon;
-};
+}
 
 export type GeofenceId = string;
 
 // Geofence object used as input for saveGeofences
-export type GeofenceInput = {
+export interface GeofenceInput {
 	geofenceId: GeofenceId;
 	geometry: PolygonGeometry;
-};
+}
 
 // Options object for saveGeofences
-export type GeofenceOptions = {
+export interface GeofenceOptions {
 	providerName?: string;
-};
+}
 
 // Error type for errors related to Geofence API calls
-export type GeofenceError = {
+export interface GeofenceError {
 	error: {
 		code: string;
 		message: string;
 	};
 	geofenceId: GeofenceId;
-};
+}
 
 // Base geofence object
-type GeofenceBase = {
+interface GeofenceBase {
 	geofenceId: GeofenceId;
 	createTime?: Date;
 	updateTime?: Date;
-};
+}
 
 // Results object for getGeofence
 export type Geofence = GeofenceBase & {
@@ -127,10 +127,10 @@ export type Geofence = GeofenceBase & {
 };
 
 // Results object for saveGeofences
-export type SaveGeofencesResults = {
+export interface SaveGeofencesResults {
 	successes: GeofenceBase[];
 	errors: GeofenceError[];
-};
+}
 
 // Options object for listGeofence
 export type ListGeofenceOptions = GeofenceOptions & {
@@ -138,21 +138,21 @@ export type ListGeofenceOptions = GeofenceOptions & {
 };
 
 // Results options for listGeofence
-export type ListGeofenceResults = {
+export interface ListGeofenceResults {
 	entries: Geofence[];
 	nextToken: string | undefined;
-};
+}
 
 // Results object for deleteGeofence
-export type DeleteGeofencesResults = {
+export interface DeleteGeofencesResults {
 	successes: GeofenceId[];
 	errors: GeofenceError[];
-};
+}
 
 // Return type for searchForSuggestions
 export type SearchForSuggestionsResults = SearchForSuggestionsResult[];
 
-export type SearchForSuggestionsResult = {
+export interface SearchForSuggestionsResult {
 	text: string;
 	placeId?: string;
-};
+}

package/src/types/Provider.ts

@@ -1,20 +1,20 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import {
-	SearchByTextOptions,
-	SearchByCoordinatesOptions,
-	SearchForSuggestionsResults,
 	Coordinates,
-	Place,
-	MapStyle,
+	DeleteGeofencesResults,
 	Geofence,
 	GeofenceId,
 	GeofenceInput,
 	GeofenceOptions,
 	ListGeofenceOptions,
 	ListGeofenceResults,
+	MapStyle,
+	Place,
 	SaveGeofencesResults,
-	DeleteGeofencesResults,
+	SearchByCoordinatesOptions,
+	SearchByTextOptions,
+	SearchForSuggestionsResults,
 	searchByPlaceIdOptions,
 } from './Geo';
 

package/src/util.ts

@@ -10,21 +10,21 @@ import {
 import { UserAgent } from '@aws-sdk/types';
 
 import {
-	Longitude,
-	Latitude,
 	GeofenceId,
 	GeofenceInput,
 	GeofencePolygon,
+	Latitude,
 	LinearRing,
+	Longitude,
 } from './types';
 
 export function validateCoordinates(lng: Longitude, lat: Latitude): void {
 	if (!Number.isFinite(lng) || !Number.isFinite(lat)) {
 		throw new Error(`Invalid coordinates: [${lng},${lat}]`);
 	}
-	if (lat < -90 || 90 < lat) {
+	if (lat < -90 || lat > 90) {
 		throw new Error('Latitude must be between -90 and 90 degrees inclusive.');
-	} else if (lng < -180 || 180 < lng) {
+	} else if (lng < -180 || lng > 180) {
 		throw new Error(
 			'Longitude must be between -180 and 180 degrees inclusive.',
 		);
@@ -186,17 +186,18 @@ export function mapSearchOptions(options, locationServiceInput) {
 		locationServiceModifiedInput.IndexName = options.searchIndexName;
 	}
 
-	if (options['biasPosition'] && options['searchAreaConstraints']) {
+	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']) {
-		locationServiceModifiedInput.BiasPosition = options['biasPosition'];
+	if (options.biasPosition) {
+		locationServiceModifiedInput.BiasPosition = options.biasPosition;
 	}
-	if (options['searchAreaConstraints']) {
-		locationServiceModifiedInput.FilterBBox = options['searchAreaConstraints'];
+	if (options.searchAreaConstraints) {
+		locationServiceModifiedInput.FilterBBox = options.searchAreaConstraints;
 	}
+
 	return locationServiceModifiedInput;
 }