@aws-amplify/geo 2.3.4-user-agent-backup.c6dfb36.0 → 2.3.4

package/src/internals/InternalGeo.ts

@@ -1,393 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-import {
-	Amplify,
-	CustomUserAgentDetails,
-	GeoAction,
-	ConsoleLogger as Logger,
-	parseAWSExports,
-} from '@aws-amplify/core';
-import { AmazonLocationServiceProvider } from '../Providers/AmazonLocationServiceProvider';
-
-import { validateCoordinates } from '../util';
-
-import {
-	Place,
-	GeoConfig,
-	Coordinates,
-	SearchByTextOptions,
-	SearchByCoordinatesOptions,
-	GeoProvider,
-	MapStyle,
-	GeofenceId,
-	GeofenceInput,
-	GeofenceOptions,
-	SaveGeofencesResults,
-	Geofence,
-	ListGeofenceOptions,
-	ListGeofenceResults,
-	DeleteGeofencesResults,
-	searchByPlaceIdOptions,
-} from '../types';
-import { getGeoUserAgentDetails } from './utils';
-
-const logger = new Logger('Geo');
-
-const DEFAULT_PROVIDER = 'AmazonLocationService';
-export class InternalGeoClass {
-	static MODULE = 'InternalGeo';
-	/**
-	 * @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
-	 * @returns {string} name of the module category
-	 */
-	public getModuleName() {
-		return InternalGeoClass.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
-	 * @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,
-		customUserAgentDetails?: CustomUserAgentDetails
-	): Promise<Place[]> {
-		const { providerName = DEFAULT_PROVIDER } = options || {};
-		const prov = this.getPluggable(providerName);
-
-		try {
-			return await prov.searchByText(
-				text,
-				options,
-				getGeoUserAgentDetails(GeoAction.SearchByText, customUserAgentDetails)
-			);
-		} catch (error) {
-			logger.debug(error);
-			throw error;
-		}
-	}
-
-	/**
-	 * Search for search term suggestions based on input text
-	 * @param  {string} text - The text string that is to be search 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,
-		customUserAgentDetails?: CustomUserAgentDetails
-	) {
-		const { providerName = DEFAULT_PROVIDER } = options || {};
-		const prov = this.getPluggable(providerName);
-
-		try {
-			return await prov.searchForSuggestions(
-				text,
-				options,
-				getGeoUserAgentDetails(
-					GeoAction.SearchForSuggestions,
-					customUserAgentDetails
-				)
-			);
-		} catch (error) {
-			logger.debug(error);
-			throw error;
-		}
-	}
-
-	/**
-	 * Search for location by unique ID
-	 * @param  {string} placeId - Unique ID of the location that is to be searched for
-	 * @param  {searchByPlaceIdOptions} options? - Optional parameters to the search
-	 * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-	 * @returns {Promise<Place>} - Resolves to a place with the given placeId
-	 */
-	public async searchByPlaceId(
-		placeId: string,
-		options?: searchByPlaceIdOptions,
-		customUserAgentDetails?: CustomUserAgentDetails
-	) {
-		const providerName = DEFAULT_PROVIDER;
-		const prov = this.getPluggable(providerName);
-
-		try {
-			return await prov.searchByPlaceId(
-				placeId,
-				options,
-				getGeoUserAgentDetails(
-					GeoAction.SearchByPlaceId,
-					customUserAgentDetails
-				)
-			);
-		} catch (error) {
-			logger.debug(error);
-			throw error;
-		}
-	}
-
-	/**
-	 * Reverse geocoding search via a coordinate point on the map
-	 * @param coordinates - Coordinates array for the search input
-	 * @param options - Options parameters for the search
-	 * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-	 * @returns {Promise<Place>} - Promise that resolves to a place matching search coordinates
-	 */
-	public async searchByCoordinates(
-		coordinates: Coordinates,
-		options?: SearchByCoordinatesOptions,
-		customUserAgentDetails?: CustomUserAgentDetails
-	): 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,
-				getGeoUserAgentDetails(GeoAction.SearchByCoordinates)
-			);
-		} catch (error) {
-			logger.debug(error);
-			throw error;
-		}
-	}
-
-	/**
-	 * Create geofences
-	 * @param geofences - Single or 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<SaveGeofencesResults>} - 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 | GeofenceInput[],
-		options?: GeofenceOptions,
-		customUserAgentDetails?: CustomUserAgentDetails
-	): 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,
-				getGeoUserAgentDetails(GeoAction.SaveGeofences, customUserAgentDetails)
-			);
-		} catch (error) {
-			logger.debug(error);
-			throw error;
-		}
-	}
-
-	/**
-	 * Get a single geofence by geofenceId
-	 * @param geofenceId: GeofenceId - The string id of the geofence to get
-	 * @param options?: GeofenceOptions - Optional parameters for getting a geofence
-	 * @param {CustomUserAgentDetails} customUserAgentDetails - Optional parameter to send user agent details
-	 * @returns Promise<Geofence> - Promise that resolves to a geofence object
-	 */
-	public async getGeofence(
-		geofenceId: GeofenceId,
-		options?: GeofenceOptions,
-		customUserAgentDetails?: CustomUserAgentDetails
-	): Promise<Geofence> {
-		const { providerName = DEFAULT_PROVIDER } = options || {};
-		const prov = this.getPluggable(providerName);
-
-		try {
-			return await prov.getGeofence(
-				geofenceId,
-				options,
-				getGeoUserAgentDetails(GeoAction.GetGeofence, customUserAgentDetails)
-			);
-		} catch (error) {
-			logger.debug(error);
-			throw error;
-		}
-	}
-
-	/**
-	 * List geofences
-	 * @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?: ListGeofenceOptions,
-		customUserAgentDetails?: CustomUserAgentDetails
-	): Promise<ListGeofenceResults> {
-		const { providerName = DEFAULT_PROVIDER } = options || {};
-		const prov = this.getPluggable(providerName);
-
-		try {
-			return await prov.listGeofences(
-				options,
-				getGeoUserAgentDetails(GeoAction.ListGeofences, customUserAgentDetails)
-			);
-		} catch (error) {
-			logger.debug(error);
-			throw error;
-		}
-	}
-
-	/**
-	 * Delete geofences
-	 * @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 | string[],
-		options?: GeofenceOptions,
-		customUserAgentDetails?: CustomUserAgentDetails
-	): 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,
-				getGeoUserAgentDetails(
-					GeoAction.DeleteGeofences,
-					customUserAgentDetails
-				)
-			);
-		} catch (error) {
-			logger.debug(error);
-			throw error;
-		}
-	}
-}
-
-export const InternalGeo = new InternalGeoClass();
-Amplify.register(InternalGeo);

package/src/internals/index.ts

@@ -1,3 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-export { InternalGeo } from './InternalGeo';

package/src/internals/utils.ts

@@ -1,15 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-
-import { Category, CustomUserAgentDetails, GeoAction } from '@aws-amplify/core';
-
-export const getGeoUserAgentDetails = (
-	action: GeoAction,
-	customUserAgentDetails?: CustomUserAgentDetails
-): CustomUserAgentDetails => {
-	return {
-		category: Category.Geo,
-		action,
-		...customUserAgentDetails,
-	};
-};