@aws-amplify/geo 2.3.6-unstable.7762f1a.0 → 3.0.0

package/lib/Geo.d.ts

@@ -1,4 +1,4 @@
-import { Place, GeoConfig, Coordinates, SearchByTextOptions, SearchByCoordinatesOptions, GeoProvider, MapStyle, GeofenceId, GeofenceInput, GeofenceOptions, SaveGeofencesResults, Geofence, ListGeofenceOptions, ListGeofenceResults, DeleteGeofencesResults, searchByPlaceIdOptions } from './types';
+import { Place, Coordinates, SearchByTextOptions, SearchByCoordinatesOptions, GeoProvider, MapStyle, GeofenceId, GeofenceInput, GeofenceOptions, SaveGeofencesResults, Geofence, ListGeofenceOptions, ListGeofenceResults, DeleteGeofencesResults, searchByPlaceIdOptions } from './types';
 export declare class GeoClass {
     static MODULE: string;
     /**
@@ -16,7 +16,7 @@ export declare class GeoClass {
      * add plugin into Geo category
      * @param {Object} pluggable - an instance of the plugin
      */
-    addPluggable(pluggable: GeoProvider): object;
+    addPluggable(pluggable: GeoProvider): void;
     /**
      * Get the plugin object
      * @param providerName - the name of the plugin
@@ -27,12 +27,6 @@ export declare class GeoClass {
      * @param providerName - the name of the plugin
      */
     removePluggable(providerName: string): void;
-    /**
-     * Configure Geo
-     * @param {Object} config - Configuration object for Geo
-     * @return {Object} - Current configuration
-     */
-    configure(config?: any): GeoConfig;
     /**
      * Get the map resources that are currently available through the provider
      * @param {string} provider
@@ -65,7 +59,7 @@ export declare class GeoClass {
      * @param  {searchByPlaceIdOptions} options? - Optional parameters to the search
      * @returns {Promise<Place>} - Resolves to a place with the given placeId
      */
-    searchByPlaceId(placeId: string, options?: searchByPlaceIdOptions): Promise<Place>;
+    searchByPlaceId(placeId: string, options?: searchByPlaceIdOptions): Promise<Place | undefined>;
     /**
      * Reverse geocoding search via a coordinate point on the map
      * @param coordinates - Coordinates array for the search input

package/lib/Geo.js

@@ -1,212 +1,148 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var tslib_1 = require("tslib");
+exports.Geo = exports.GeoClass = void 0;
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-var core_1 = require("@aws-amplify/core");
-var AmazonLocationServiceProvider_1 = require("./Providers/AmazonLocationServiceProvider");
-var util_1 = require("./util");
-var logger = new core_1.ConsoleLogger('Geo');
-var DEFAULT_PROVIDER = 'AmazonLocationService';
-var GeoClass = /** @class */ (function () {
-    function GeoClass() {
+const core_1 = require("@aws-amplify/core");
+const AmazonLocationServiceProvider_1 = require("./providers/location-service/AmazonLocationServiceProvider");
+const util_1 = require("./util");
+const logger = new core_1.ConsoleLogger('Geo');
+const DEFAULT_PROVIDER = 'AmazonLocationService';
+class GeoClass {
+    constructor() {
         this._config = {};
         this._pluggables = [];
+        const amplifyConfig = core_1.Amplify.getConfig() ?? {};
+        this._config = Object.assign({}, this._config, amplifyConfig.Geo);
+        const locationProvider = new AmazonLocationServiceProvider_1.AmazonLocationServiceProvider(amplifyConfig.Geo);
+        this._pluggables.push(locationProvider);
         logger.debug('Geo Options', this._config);
     }
     /**
      * get the name of the module category
      * @returns {string} name of the module category
      */
-    GeoClass.prototype.getModuleName = function () {
+    getModuleName() {
         return GeoClass.MODULE;
-    };
+    }
     /**
      * add plugin into Geo category
      * @param {Object} pluggable - an instance of the plugin
      */
-    GeoClass.prototype.addPluggable = function (pluggable) {
+    addPluggable(pluggable) {
         if (pluggable && pluggable.getCategory() === 'Geo') {
             this._pluggables.push(pluggable);
-            var config = pluggable.configure(this._config[pluggable.getProviderName()]);
-            return config;
         }
-    };
+    }
     /**
      * Get the plugin object
      * @param providerName - the name of the plugin
      */
-    GeoClass.prototype.getPluggable = function (providerName) {
-        var pluggable = this._pluggables.find(function (pluggable) { return pluggable.getProviderName() === providerName; });
+    getPluggable(providerName) {
+        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
      */
-    GeoClass.prototype.removePluggable = function (providerName) {
-        this._pluggables = this._pluggables.filter(function (pluggable) { return pluggable.getProviderName() !== providerName; });
+    removePluggable(providerName) {
+        this._pluggables = this._pluggables.filter(pluggable => pluggable.getProviderName() !== providerName);
         return;
-    };
-    /**
-     * Configure Geo
-     * @param {Object} config - Configuration object for Geo
-     * @return {Object} - Current configuration
-     */
-    GeoClass.prototype.configure = function (config) {
-        var _this = this;
-        logger.debug('configure Geo');
-        if (!config)
-            return this._config;
-        var amplifyConfig = core_1.parseAWSExports(config);
-        this._config = Object.assign({}, this._config, amplifyConfig.Geo, config);
-        this._pluggables.forEach(function (pluggable) {
-            pluggable.configure(_this._config[pluggable.getProviderName()]);
-        });
-        if (this._pluggables.length === 0) {
-            this.addPluggable(new AmazonLocationServiceProvider_1.AmazonLocationServiceProvider());
-        }
-        return this._config;
-    };
+    }
     /**
      * Get the map resources that are currently available through the provider
      * @param {string} provider
      * @returns - Array of available map resources
      */
-    GeoClass.prototype.getAvailableMaps = function (provider) {
-        if (provider === void 0) { provider = DEFAULT_PROVIDER; }
-        var prov = this.getPluggable(provider);
+    getAvailableMaps(provider = DEFAULT_PROVIDER) {
+        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
      */
-    GeoClass.prototype.getDefaultMap = function (provider) {
-        if (provider === void 0) { provider = DEFAULT_PROVIDER; }
-        var prov = this.getPluggable(provider);
+    getDefaultMap(provider = DEFAULT_PROVIDER) {
+        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
      * @returns {Promise<Place[]>} - Promise resolves to a list of Places that match search parameters
      */
-    GeoClass.prototype.searchByText = function (text, options) {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var _a, providerName, prov, error_1;
-            return tslib_1.__generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        _a = (options || {}).providerName, providerName = _a === void 0 ? DEFAULT_PROVIDER : _a;
-                        prov = this.getPluggable(providerName);
-                        _b.label = 1;
-                    case 1:
-                        _b.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, prov.searchByText(text, options)];
-                    case 2: return [2 /*return*/, _b.sent()];
-                    case 3:
-                        error_1 = _b.sent();
-                        logger.debug(error_1);
-                        throw error_1;
-                    case 4: return [2 /*return*/];
-                }
-            });
-        });
-    };
+    async searchByText(text, options) {
+        const { providerName = DEFAULT_PROVIDER } = options || {};
+        const prov = this.getPluggable(providerName);
+        try {
+            return await prov.searchByText(text, options);
+        }
+        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
      * @returns {Promise<SearchForSuggestionsResults>} - Resolves to an array of search suggestion strings
      */
-    GeoClass.prototype.searchForSuggestions = function (text, options) {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var _a, providerName, prov, error_2;
-            return tslib_1.__generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        _a = (options || {}).providerName, providerName = _a === void 0 ? DEFAULT_PROVIDER : _a;
-                        prov = this.getPluggable(providerName);
-                        _b.label = 1;
-                    case 1:
-                        _b.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, prov.searchForSuggestions(text, options)];
-                    case 2: return [2 /*return*/, _b.sent()];
-                    case 3:
-                        error_2 = _b.sent();
-                        logger.debug(error_2);
-                        throw error_2;
-                    case 4: return [2 /*return*/];
-                }
-            });
-        });
-    };
+    async searchForSuggestions(text, options) {
+        const { providerName = DEFAULT_PROVIDER } = options || {};
+        const prov = this.getPluggable(providerName);
+        try {
+            return await prov.searchForSuggestions(text, options);
+        }
+        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
      * @returns {Promise<Place>} - Resolves to a place with the given placeId
      */
-    GeoClass.prototype.searchByPlaceId = function (placeId, options) {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var providerName, prov, error_3;
-            return tslib_1.__generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        providerName = DEFAULT_PROVIDER;
-                        prov = this.getPluggable(providerName);
-                        _a.label = 1;
-                    case 1:
-                        _a.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, prov.searchByPlaceId(placeId, options)];
-                    case 2: return [2 /*return*/, _a.sent()];
-                    case 3:
-                        error_3 = _a.sent();
-                        logger.debug(error_3);
-                        throw error_3;
-                    case 4: return [2 /*return*/];
-                }
-            });
-        });
-    };
+    async searchByPlaceId(placeId, options) {
+        const providerName = DEFAULT_PROVIDER;
+        const prov = this.getPluggable(providerName);
+        try {
+            return await prov.searchByPlaceId(placeId, options);
+        }
+        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
      * @returns {Promise<Place>} - Promise that resolves to a place matching search coordinates
      */
-    GeoClass.prototype.searchByCoordinates = function (coordinates, options) {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var _a, providerName, prov, _b, lng, lat, error_4;
-            return tslib_1.__generator(this, function (_c) {
-                switch (_c.label) {
-                    case 0:
-                        _a = (options || {}).providerName, providerName = _a === void 0 ? DEFAULT_PROVIDER : _a;
-                        prov = this.getPluggable(providerName);
-                        _b = tslib_1.__read(coordinates, 2), lng = _b[0], lat = _b[1];
-                        _c.label = 1;
-                    case 1:
-                        _c.trys.push([1, 3, , 4]);
-                        util_1.validateCoordinates(lng, lat);
-                        return [4 /*yield*/, prov.searchByCoordinates(coordinates, options)];
-                    case 2: return [2 /*return*/, _c.sent()];
-                    case 3:
-                        error_4 = _c.sent();
-                        logger.debug(error_4);
-                        throw error_4;
-                    case 4: return [2 /*return*/];
-                }
-            });
-        });
-    };
+    async searchByCoordinates(coordinates, options) {
+        const { providerName = DEFAULT_PROVIDER } = options || {};
+        const prov = this.getPluggable(providerName);
+        const [lng, lat] = coordinates;
+        try {
+            (0, util_1.validateCoordinates)(lng, lat);
+            return await prov.searchByCoordinates(coordinates, options);
+        }
+        catch (error) {
+            logger.debug(error);
+            throw error;
+        }
+    }
     /**
      * Create geofences
      * @param geofences - Single or array of geofence objects to create
@@ -215,62 +151,42 @@ var GeoClass = /** @class */ (function () {
      *   successes: list of geofences successfully created
      *   errors: list of geofences that failed to create
      */
-    GeoClass.prototype.saveGeofences = function (geofences, options) {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var _a, providerName, prov, geofenceInputArray, error_5;
-            return tslib_1.__generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        _a = (options || {}).providerName, providerName = _a === void 0 ? DEFAULT_PROVIDER : _a;
-                        prov = this.getPluggable(providerName);
-                        if (!Array.isArray(geofences)) {
-                            geofenceInputArray = [geofences];
-                        }
-                        else {
-                            geofenceInputArray = geofences;
-                        }
-                        _b.label = 1;
-                    case 1:
-                        _b.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, prov.saveGeofences(geofenceInputArray, options)];
-                    case 2: return [2 /*return*/, _b.sent()];
-                    case 3:
-                        error_5 = _b.sent();
-                        logger.debug(error_5);
-                        throw error_5;
-                    case 4: return [2 /*return*/];
-                }
-            });
-        });
-    };
+    async saveGeofences(geofences, options) {
+        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;
+        }
+    }
     /**
      * 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
      * @returns Promise<Geofence> - Promise that resolves to a geofence object
      */
-    GeoClass.prototype.getGeofence = function (geofenceId, options) {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var _a, providerName, prov, error_6;
-            return tslib_1.__generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        _a = (options || {}).providerName, providerName = _a === void 0 ? DEFAULT_PROVIDER : _a;
-                        prov = this.getPluggable(providerName);
-                        _b.label = 1;
-                    case 1:
-                        _b.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, prov.getGeofence(geofenceId, options)];
-                    case 2: return [2 /*return*/, _b.sent()];
-                    case 3:
-                        error_6 = _b.sent();
-                        logger.debug(error_6);
-                        throw error_6;
-                    case 4: return [2 /*return*/];
-                }
-            });
-        });
-    };
+    async getGeofence(geofenceId, options) {
+        const { providerName = DEFAULT_PROVIDER } = options || {};
+        const prov = this.getPluggable(providerName);
+        try {
+            return await prov.getGeofence(geofenceId, options);
+        }
+        catch (error) {
+            logger.debug(error);
+            throw error;
+        }
+    }
     /**
      * List geofences
      * @param  options?: ListGeofenceOptions
@@ -278,28 +194,17 @@ var GeoClass = /** @class */ (function () {
      *   entries: list of geofences - 100 geofences are listed per page
      *   nextToken: token for next page of geofences
      */
-    GeoClass.prototype.listGeofences = function (options) {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var _a, providerName, prov, error_7;
-            return tslib_1.__generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        _a = (options || {}).providerName, providerName = _a === void 0 ? DEFAULT_PROVIDER : _a;
-                        prov = this.getPluggable(providerName);
-                        _b.label = 1;
-                    case 1:
-                        _b.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, prov.listGeofences(options)];
-                    case 2: return [2 /*return*/, _b.sent()];
-                    case 3:
-                        error_7 = _b.sent();
-                        logger.debug(error_7);
-                        throw error_7;
-                    case 4: return [2 /*return*/];
-                }
-            });
-        });
-    };
+    async listGeofences(options) {
+        const { providerName = DEFAULT_PROVIDER } = options || {};
+        const prov = this.getPluggable(providerName);
+        try {
+            return await prov.listGeofences(options);
+        }
+        catch (error) {
+            logger.debug(error);
+            throw error;
+        }
+    }
     /**
      * Delete geofences
      * @param geofenceIds: string|string[]
@@ -308,38 +213,27 @@ var GeoClass = /** @class */ (function () {
      *  successes: list of geofences successfully deleted
      *  errors: list of geofences that failed to delete
      */
-    GeoClass.prototype.deleteGeofences = function (geofenceIds, options) {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var _a, providerName, prov, geofenceIdsInputArray, error_8;
-            return tslib_1.__generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        _a = (options || {}).providerName, providerName = _a === void 0 ? DEFAULT_PROVIDER : _a;
-                        prov = this.getPluggable(providerName);
-                        if (!Array.isArray(geofenceIds)) {
-                            geofenceIdsInputArray = [geofenceIds];
-                        }
-                        else {
-                            geofenceIdsInputArray = geofenceIds;
-                        }
-                        _b.label = 1;
-                    case 1:
-                        _b.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, prov.deleteGeofences(geofenceIdsInputArray, options)];
-                    case 2: return [2 /*return*/, _b.sent()];
-                    case 3:
-                        error_8 = _b.sent();
-                        logger.debug(error_8);
-                        throw error_8;
-                    case 4: return [2 /*return*/];
-                }
-            });
-        });
-    };
-    GeoClass.MODULE = 'Geo';
-    return GeoClass;
-}());
+    async deleteGeofences(geofenceIds, options) {
+        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;
+        }
+    }
+}
+GeoClass.MODULE = 'Geo';
 exports.GeoClass = GeoClass;
 exports.Geo = new GeoClass();
-core_1.Amplify.register(exports.Geo);
-//# sourceMappingURL=Geo.js.map

package/lib/index.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Geo = void 0;
+const tslib_1 = require("tslib");
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 var Geo_1 = require("./Geo");
-exports.Geo = Geo_1.Geo;
-//# sourceMappingURL=index.js.map
+Object.defineProperty(exports, "Geo", { enumerable: true, get: function () { return Geo_1.Geo; } });
+tslib_1.__exportStar(require("./types"), exports);

package/{lib-esm/Providers → lib/providers/location-service}/AmazonLocationServiceProvider.d.ts

@@ -1,4 +1,4 @@
-import { GeoConfig, SearchByTextOptions, SearchByCoordinatesOptions, GeoProvider, Place, AmazonLocationServiceMapStyle, Coordinates, SearchForSuggestionsResults, GeofenceId, GeofenceInput, AmazonLocationServiceGeofenceOptions, AmazonLocationServiceListGeofenceOptions, ListGeofenceResults, SaveGeofencesResults, AmazonLocationServiceGeofence, AmazonLocationServiceDeleteGeofencesResults, searchByPlaceIdOptions } from '../types';
+import { GeoConfig, SearchByTextOptions, SearchByCoordinatesOptions, GeoProvider, Place, AmazonLocationServiceMapStyle, Coordinates, SearchForSuggestionsResults, GeofenceId, GeofenceInput, AmazonLocationServiceGeofenceOptions, AmazonLocationServiceListGeofenceOptions, ListGeofenceResults, SaveGeofencesResults, AmazonLocationServiceGeofence, AmazonLocationServiceDeleteGeofencesResults, searchByPlaceIdOptions } from '../../types';
 export declare class AmazonLocationServiceProvider implements GeoProvider {
     static CATEGORY: string;
     static PROVIDER_NAME: string;
@@ -6,6 +6,7 @@ export declare class AmazonLocationServiceProvider implements GeoProvider {
      * @private
      */
     private _config;
+    private _credentials;
     /**
      * Initialize Geo with AWS configurations
      * @param {Object} config - Configuration object for Geo
@@ -21,12 +22,6 @@ export declare class AmazonLocationServiceProvider implements GeoProvider {
      * @returns {string} name of the provider
      */
     getProviderName(): string;
-    /**
-     * Configure Geo part with aws configuration
-     * @param {Object} config - Configuration of the Geo
-     * @return {Object} - Current configuration
-     */
-    configure(config?: any): object;
     /**
      * Get the map resources that are currently available through the provider
      * @returns {AmazonLocationServiceMapStyle[]}- Array of available map resources
@@ -97,6 +92,7 @@ export declare class AmazonLocationServiceProvider implements GeoProvider {
      * @private
      */
     private _ensureCredentials;
+    private _refreshConfig;
     private _verifyMapResources;
     private _verifySearchIndex;
     private _verifyGeofenceCollections;