@aws-amplify/geo 2.1.4-api-v6.25 → 2.1.4-api-v6.29

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@aws-amplify/geo",
-	"version": "2.1.4-api-v6.25+6e3f5010b",
+	"version": "2.1.4-api-v6.29+98c172c32",
 	"description": "Geo category for aws-amplify",
 	"main": "./lib/index.js",
 	"module": "./lib-esm/index.js",
@@ -43,10 +43,11 @@
 	"files": [
 		"lib",
 		"lib-esm",
-		"src"
+		"src",
+		"internals"
 	],
 	"dependencies": {
-		"@aws-amplify/core": "5.5.3-api-v6.25+6e3f5010b",
+		"@aws-amplify/core": "5.5.3-api-v6.29+98c172c32",
 		"@aws-sdk/client-location": "3.186.3",
 		"@turf/boolean-clockwise": "6.5.0",
 		"camelcase-keys": "6.2.2",
@@ -57,7 +58,7 @@
 			"name": "Geo (top-level class)",
 			"path": "./lib-esm/index.js",
 			"import": "{ Amplify, Geo }",
-			"limit": "51.75 kB"
+			"limit": "52.1 kB"
 		}
 	],
 	"jest": {
@@ -113,5 +114,5 @@
 			"lib-esm"
 		]
 	},
-	"gitHead": "6e3f5010b235d1b12d81e410ee5652365294a615"
+	"gitHead": "98c172c32bc793b99b31442ea2d84829baea6e3c"
 }

package/src/Geo.ts

@@ -1,22 +1,11 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import {
-	Amplify,
-	ConsoleLogger as Logger,
-	parseAWSExports,
-} from '@aws-amplify/core';
-import { AmazonLocationServiceProvider } from './Providers/AmazonLocationServiceProvider';
-
-import { validateCoordinates } from './util';
-
+import { Amplify, ConsoleLogger as Logger } from '@aws-amplify/core';
 import {
 	Place,
-	GeoConfig,
 	Coordinates,
 	SearchByTextOptions,
 	SearchByCoordinatesOptions,
-	GeoProvider,
-	MapStyle,
 	GeofenceId,
 	GeofenceInput,
 	GeofenceOptions,
@@ -27,23 +16,10 @@ import {
 	DeleteGeofencesResults,
 	searchByPlaceIdOptions,
 } from './types';
+import { InternalGeoClass } from './internals/InternalGeo';
 
-const logger = new Logger('Geo');
-
-const DEFAULT_PROVIDER = 'AmazonLocationService';
-export class GeoClass {
+export class GeoClass extends InternalGeoClass {
 	static MODULE = 'Geo';
-	/**
-	 * @private
-	 */
-	private _config: GeoConfig;
-	private _pluggables: GeoProvider[];
-
-	constructor() {
-		this._config = {};
-		this._pluggables = [];
-		logger.debug('Geo Options', this._config);
-	}
 
 	/**
 	 * get the name of the module category
@@ -53,91 +29,6 @@ export class GeoClass {
 		return GeoClass.MODULE;
 	}
 
-	/**
-	 * add plugin into Geo category
-	 * @param {Object} pluggable - an instance of the plugin
-	 */
-	public addPluggable(pluggable: GeoProvider) {
-		if (pluggable && pluggable.getCategory() === 'Geo') {
-			this._pluggables.push(pluggable);
-			const config = pluggable.configure(
-				this._config[pluggable.getProviderName()]
-			);
-
-			return config;
-		}
-	}
-
-	/**
-	 * Get the plugin object
-	 * @param providerName - the name of the plugin
-	 */
-	public getPluggable(providerName: string) {
-		const pluggable = this._pluggables.find(
-			pluggable => pluggable.getProviderName() === providerName
-		);
-		if (pluggable === undefined) {
-			logger.debug('No plugin found with providerName', providerName);
-			throw new Error('No plugin found in Geo for the provider');
-		} else return pluggable;
-	}
-
-	/**
-	 * Remove the plugin object
-	 * @param providerName - the name of the plugin
-	 */
-	public removePluggable(providerName: string) {
-		this._pluggables = this._pluggables.filter(
-			pluggable => pluggable.getProviderName() !== providerName
-		);
-		return;
-	}
-
-	/**
-	 * Configure Geo
-	 * @param {Object} config - Configuration object for Geo
-	 * @return {Object} - Current configuration
-	 */
-	configure(config?) {
-		logger.debug('configure Geo');
-
-		if (!config) return this._config;
-
-		const amplifyConfig = parseAWSExports(config);
-		this._config = Object.assign({}, this._config, amplifyConfig.Geo, config);
-
-		this._pluggables.forEach(pluggable => {
-			pluggable.configure(this._config[pluggable.getProviderName()]);
-		});
-
-		if (this._pluggables.length === 0) {
-			this.addPluggable(new AmazonLocationServiceProvider());
-		}
-		return this._config;
-	}
-
-	/**
-	 * Get the map resources that are currently available through the provider
-	 * @param {string} provider
-	 * @returns - Array of available map resources
-	 */
-	public getAvailableMaps(provider = DEFAULT_PROVIDER): MapStyle[] {
-		const prov = this.getPluggable(provider);
-
-		return prov.getAvailableMaps();
-	}
-
-	/**
-	 * Get the map resource set as default in amplify config
-	 * @param {string} provider
-	 * @returns - Map resource set as the default in amplify config
-	 */
-	public getDefaultMap(provider = DEFAULT_PROVIDER): MapStyle {
-		const prov = this.getPluggable(provider);
-
-		return prov.getDefaultMap();
-	}
-
 	/**
 	 * Search by text input with optional parameters
 	 * @param  {string} text - The text string that is to be searched for
@@ -148,15 +39,7 @@ export class GeoClass {
 		text: string,
 		options?: SearchByTextOptions
 	): Promise<Place[]> {
-		const { providerName = DEFAULT_PROVIDER } = options || {};
-		const prov = this.getPluggable(providerName);
-
-		try {
-			return await prov.searchByText(text, options);
-		} catch (error) {
-			logger.debug(error);
-			throw error;
-		}
+		return super.searchByText(text, options);
 	}
 
 	/**
@@ -169,15 +52,7 @@ export class GeoClass {
 		text: string,
 		options?: SearchByTextOptions
 	) {
-		const { providerName = DEFAULT_PROVIDER } = options || {};
-		const prov = this.getPluggable(providerName);
-
-		try {
-			return await prov.searchForSuggestions(text, options);
-		} catch (error) {
-			logger.debug(error);
-			throw error;
-		}
+		return super.searchForSuggestions(text, options);
 	}
 
 	/**
@@ -190,15 +65,7 @@ export class GeoClass {
 		placeId: string,
 		options?: searchByPlaceIdOptions
 	) {
-		const providerName = DEFAULT_PROVIDER;
-		const prov = this.getPluggable(providerName);
-
-		try {
-			return await prov.searchByPlaceId(placeId, options);
-		} catch (error) {
-			logger.debug(error);
-			throw error;
-		}
+		return super.searchByPlaceId(placeId, options);
 	}
 
 	/**
@@ -211,17 +78,7 @@ export class GeoClass {
 		coordinates: Coordinates,
 		options?: SearchByCoordinatesOptions
 	): Promise<Place> {
-		const { providerName = DEFAULT_PROVIDER } = options || {};
-		const prov = this.getPluggable(providerName);
-
-		const [lng, lat] = coordinates;
-		try {
-			validateCoordinates(lng, lat);
-			return await prov.searchByCoordinates(coordinates, options);
-		} catch (error) {
-			logger.debug(error);
-			throw error;
-		}
+		return super.searchByCoordinates(coordinates, options);
 	}
 
 	/**
@@ -236,23 +93,7 @@ export class GeoClass {
 		geofences: GeofenceInput | GeofenceInput[],
 		options?: GeofenceOptions
 	): Promise<SaveGeofencesResults> {
-		const { providerName = DEFAULT_PROVIDER } = options || {};
-		const prov = this.getPluggable(providerName);
-
-		// If single geofence input, make it an array for batch call
-		let geofenceInputArray;
-		if (!Array.isArray(geofences)) {
-			geofenceInputArray = [geofences];
-		} else {
-			geofenceInputArray = geofences;
-		}
-
-		try {
-			return await prov.saveGeofences(geofenceInputArray, options);
-		} catch (error) {
-			logger.debug(error);
-			throw error;
-		}
+		return super.saveGeofences(geofences, options);
 	}
 
 	/**
@@ -265,15 +106,7 @@ export class GeoClass {
 		geofenceId: GeofenceId,
 		options?: GeofenceOptions
 	): Promise<Geofence> {
-		const { providerName = DEFAULT_PROVIDER } = options || {};
-		const prov = this.getPluggable(providerName);
-
-		try {
-			return await prov.getGeofence(geofenceId, options);
-		} catch (error) {
-			logger.debug(error);
-			throw error;
-		}
+		return super.getGeofence(geofenceId, options);
 	}
 
 	/**
@@ -286,15 +119,7 @@ export class GeoClass {
 	public async listGeofences(
 		options?: ListGeofenceOptions
 	): Promise<ListGeofenceResults> {
-		const { providerName = DEFAULT_PROVIDER } = options || {};
-		const prov = this.getPluggable(providerName);
-
-		try {
-			return await prov.listGeofences(options);
-		} catch (error) {
-			logger.debug(error);
-			throw error;
-		}
+		return super.listGeofences(options);
 	}
 
 	/**
@@ -309,24 +134,7 @@ export class GeoClass {
 		geofenceIds: string | string[],
 		options?: GeofenceOptions
 	): Promise<DeleteGeofencesResults> {
-		const { providerName = DEFAULT_PROVIDER } = options || {};
-		const prov = this.getPluggable(providerName);
-
-		// If single geofence input, make it an array for batch call
-		let geofenceIdsInputArray;
-		if (!Array.isArray(geofenceIds)) {
-			geofenceIdsInputArray = [geofenceIds];
-		} else {
-			geofenceIdsInputArray = geofenceIds;
-		}
-
-		//  Delete geofences
-		try {
-			return await prov.deleteGeofences(geofenceIdsInputArray, options);
-		} catch (error) {
-			logger.debug(error);
-			throw error;
-		}
+		return super.deleteGeofences(geofenceIds, options);
 	}
 }
 

package/src/Providers/AmazonLocationServiceProvider.ts

@@ -6,6 +6,7 @@ import {
 	ConsoleLogger as Logger,
 	Credentials,
 	getAmplifyUserAgentObject,
+	CustomUserAgentDetails,
 } from '@aws-amplify/core';
 import {
 	Place as PlaceResult,
@@ -147,11 +148,13 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 	 * Search by text input with optional parameters
 	 * @param  {string} text - The text string that is to be searched for
 	 * @param  {SearchByTextOptions} options? - Optional parameters to the search
+	 * @param  {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
 	 * @returns {Promise<Place[]>} - Promise resolves to a list of Places that match search parameters
 	 */
 	public async searchByText(
 		text: string,
-		options?: SearchByTextOptions
+		options?: SearchByTextOptions,
+		customUserAgentDetails?: CustomUserAgentDetails
 	): Promise<Place[]> {
 		const credentialsOK = await this._ensureCredentials();
 		if (!credentialsOK) {
@@ -181,7 +184,7 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		const client = new LocationClient({
 			credentials: this._config.credentials,
 			region: this._config.region,
-			customUserAgent: getAmplifyUserAgentObject(),
+			customUserAgent: getAmplifyUserAgentObject(customUserAgentDetails),
 		});
 		const command = new SearchPlaceIndexForTextCommand(locationServiceInput);
 
@@ -212,12 +215,14 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 	 * 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
+	 * @param  {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
 	 * @returns {Promise<SearchForSuggestionsResults>} - Resolves to an array of search suggestion strings
 	 */
 
 	public async searchForSuggestions(
 		text: string,
-		options?: SearchByTextOptions
+		options?: SearchByTextOptions,
+		customUserAgentDetails?: CustomUserAgentDetails
 	): Promise<SearchForSuggestionsResults> {
 		const credentialsOK = await this._ensureCredentials();
 		if (!credentialsOK) {
@@ -247,7 +252,7 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		const client = new LocationClient({
 			credentials: this._config.credentials,
 			region: this._config.region,
-			customUserAgent: getAmplifyUserAgentObject(),
+			customUserAgent: getAmplifyUserAgentObject(customUserAgentDetails),
 		});
 		const command = new SearchPlaceIndexForSuggestionsCommand(
 			locationServiceInput
@@ -282,7 +287,8 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 
 	public async searchByPlaceId(
 		placeId: string,
-		options?: searchByPlaceIdOptions
+		options?: searchByPlaceIdOptions,
+		customUserAgentDetails?: CustomUserAgentDetails
 	): Promise<Place | undefined> {
 		const credentialsOK = await this._ensureCredentials();
 		if (!credentialsOK) {
@@ -295,7 +301,7 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		const client = new LocationClient({
 			credentials: this._config.credentials,
 			region: this._config.region,
-			customUserAgent: getAmplifyUserAgentObject(),
+			customUserAgent: getAmplifyUserAgentObject(customUserAgentDetails),
 		});
 
 		const searchByPlaceIdInput: GetPlaceCommandInput = {
@@ -329,7 +335,8 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 	 */
 	public async searchByCoordinates(
 		coordinates: Coordinates,
-		options?: SearchByCoordinatesOptions
+		options?: SearchByCoordinatesOptions,
+		customUserAgentDetails?: CustomUserAgentDetails
 	): Promise<Place> {
 		const credentialsOK = await this._ensureCredentials();
 		if (!credentialsOK) {
@@ -353,7 +360,7 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		const client = new LocationClient({
 			credentials: this._config.credentials,
 			region: this._config.region,
-			customUserAgent: getAmplifyUserAgentObject(),
+			customUserAgent: getAmplifyUserAgentObject(customUserAgentDetails),
 		});
 		const command = new SearchPlaceIndexForPositionCommand(
 			locationServiceInput
@@ -384,13 +391,15 @@ 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
+	 * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
 	 * @returns {Promise<AmazonLocationServiceSaveGeofencesResults>} - Promise that resolves to an object with:
 	 *   successes: list of geofences successfully created
 	 *   errors: list of geofences that failed to create
 	 */
 	public async saveGeofences(
 		geofences: GeofenceInput[],
-		options?: AmazonLocationServiceGeofenceOptions
+		options?: AmazonLocationServiceGeofenceOptions,
+		customUserAgentDetails?: CustomUserAgentDetails
 	): Promise<SaveGeofencesResults> {
 		if (geofences.length < 1) {
 			throw new Error('Geofence input array is empty');
@@ -442,7 +451,8 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 				try {
 					response = await this._AmazonLocationServiceBatchPutGeofenceCall(
 						batch,
-						options?.collectionName || this._config.geofenceCollections.default
+						options?.collectionName || this._config.geofenceCollections.default,
+						customUserAgentDetails
 					);
 				} catch (error) {
 					// If the API call fails, add the geofences to the errors array and move to next batch
@@ -492,11 +502,13 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 	 * Get geofence from a geofence collection
 	 * @param geofenceId:string
 	 * @param options?: Optional parameters for getGeofence
+	 * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
 	 * @returns {Promise<AmazonLocationServiceGeofence>} - Promise that resolves to a geofence object
 	 */
 	public async getGeofence(
 		geofenceId: GeofenceId,
-		options?: AmazonLocationServiceGeofenceOptions
+		options?: AmazonLocationServiceGeofenceOptions,
+		customUserAgentDetails?: CustomUserAgentDetails
 	): Promise<AmazonLocationServiceGeofence> {
 		const credentialsOK = await this._ensureCredentials();
 		if (!credentialsOK) {
@@ -517,7 +529,7 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		const client = new LocationClient({
 			credentials: this._config.credentials,
 			region: this._config.region,
-			customUserAgent: getAmplifyUserAgentObject(),
+			customUserAgent: getAmplifyUserAgentObject(customUserAgentDetails),
 		});
 
 		// Create Amazon Location Service command
@@ -555,12 +567,14 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 	/**
 	 * List geofences from a geofence collection
 	 * @param  options?: ListGeofenceOptions
+	 * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
 	 * @returns {Promise<ListGeofencesResults>} - Promise that resolves to an object with:
 	 *   entries: list of geofences - 100 geofences are listed per page
 	 *   nextToken: token for next page of geofences
 	 */
 	public async listGeofences(
-		options?: AmazonLocationServiceListGeofenceOptions
+		options?: AmazonLocationServiceListGeofenceOptions,
+		customUserAgentDetails?: CustomUserAgentDetails
 	): Promise<ListGeofenceResults> {
 		const credentialsOK = await this._ensureCredentials();
 		if (!credentialsOK) {
@@ -579,7 +593,7 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		const client = new LocationClient({
 			credentials: this._config.credentials,
 			region: this._config.region,
-			customUserAgent: getAmplifyUserAgentObject(),
+			customUserAgent: getAmplifyUserAgentObject(customUserAgentDetails),
 		});
 
 		// Create Amazon Location Service input
@@ -636,13 +650,15 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 	 * Delete geofences from a geofence collection
 	 * @param geofenceIds: string|string[]
 	 * @param options?: GeofenceOptions
+	 * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
 	 * @returns {Promise<DeleteGeofencesResults>} - Promise that resolves to an object with:
 	 *  successes: list of geofences successfully deleted
 	 *  errors: list of geofences that failed to delete
 	 */
 	public async deleteGeofences(
 		geofenceIds: string[],
-		options?: AmazonLocationServiceGeofenceOptions
+		options?: AmazonLocationServiceGeofenceOptions,
+		customUserAgentDetails?: CustomUserAgentDetails
 	): Promise<AmazonLocationServiceDeleteGeofencesResults> {
 		if (geofenceIds.length < 1) {
 			throw new Error('GeofenceId input array is empty');
@@ -685,7 +701,8 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 				try {
 					response = await this._AmazonLocationServiceBatchDeleteGeofenceCall(
 						batch,
-						options?.collectionName || this._config.geofenceCollections.default
+						options?.collectionName || this._config.geofenceCollections.default,
+						customUserAgentDetails
 					);
 				} catch (error) {
 					// If the API call fails, add the geofences to the errors array and move to next batch
@@ -772,7 +789,8 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 
 	private async _AmazonLocationServiceBatchPutGeofenceCall(
 		PascalGeofences: BatchPutGeofenceRequestEntry[],
-		collectionName?: string
+		collectionName?: string,
+		customUserAgentDetails?: CustomUserAgentDetails
 	) {
 		// Create the BatchPutGeofence input
 		const geofenceInput: BatchPutGeofenceCommandInput = {
@@ -784,7 +802,7 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		const client = new LocationClient({
 			credentials: this._config.credentials,
 			region: this._config.region,
-			customUserAgent: getAmplifyUserAgentObject(),
+			customUserAgent: getAmplifyUserAgentObject(customUserAgentDetails),
 		});
 		const command = new BatchPutGeofenceCommand(geofenceInput);
 
@@ -799,7 +817,8 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 
 	private async _AmazonLocationServiceBatchDeleteGeofenceCall(
 		geofenceIds: string[],
-		collectionName?: string
+		collectionName?: string,
+		customUserAgentDetails?: CustomUserAgentDetails
 	): Promise<BatchDeleteGeofenceCommandOutput> {
 		// Create the BatchDeleteGeofence input
 		const deleteGeofencesInput: BatchDeleteGeofenceCommandInput = {
@@ -811,7 +830,7 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		const client = new LocationClient({
 			credentials: this._config.credentials,
 			region: this._config.region,
-			customUserAgent: getAmplifyUserAgentObject(),
+			customUserAgent: getAmplifyUserAgentObject(customUserAgentDetails),
 		});
 		const command = new BatchDeleteGeofenceCommand(deleteGeofencesInput);