@aws-amplify/geo 1.3.4 → 1.3.6-geo.14

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.3.5](https://github.com/aws-amplify/amplify-js/compare/@aws-amplify/geo@1.3.4...@aws-amplify/geo@1.3.5) (2022-05-24)
+
+**Note:** Version bump only for package @aws-amplify/geo
+
+
+
+
+
 ## [1.3.4](https://github.com/aws-amplify/amplify-js/compare/@aws-amplify/geo@1.3.3...@aws-amplify/geo@1.3.4) (2022-05-23)
 
 **Note:** Version bump only for package @aws-amplify/geo

package/dist/aws-amplify-geo.js

@@ -28963,6 +28963,50 @@ function () {
       });
     });
   };
+  /**
+   * 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 __awaiter(this, void 0, void 0, function () {
+      var _a, providerName, prov, error_2;
+
+      return __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*/
+            ];
+        }
+      });
+    });
+  };
   /**
    * Reverse geocoding search via a coordinate point on the map
    * @param coordinates - Coordinates array for the search input
@@ -28973,7 +29017,7 @@ function () {
 
   GeoClass.prototype.searchByCoordinates = function (coordinates, options) {
     return __awaiter(this, void 0, void 0, function () {
-      var _a, providerName, prov, _b, lng, lat, error_2;
+      var _a, providerName, prov, _b, lng, lat, error_3;
 
       return __generator(this, function (_c) {
         switch (_c.label) {
@@ -28997,9 +29041,9 @@ function () {
             , _c.sent()];
 
           case 3:
-            error_2 = _c.sent();
-            logger.debug(error_2);
-            throw error_2;
+            error_3 = _c.sent();
+            logger.debug(error_3);
+            throw error_3;
 
           case 4:
             return [2
@@ -29021,7 +29065,7 @@ function () {
 
   GeoClass.prototype.saveGeofences = function (geofences, options) {
     return __awaiter(this, void 0, void 0, function () {
-      var _a, providerName, prov, geofenceInputArray, error_3;
+      var _a, providerName, prov, geofenceInputArray, error_4;
 
       return __generator(this, function (_b) {
         switch (_b.label) {
@@ -29050,9 +29094,9 @@ function () {
             , _b.sent()];
 
           case 3:
-            error_3 = _b.sent();
-            logger.debug(error_3);
-            throw error_3;
+            error_4 = _b.sent();
+            logger.debug(error_4);
+            throw error_4;
 
           case 4:
             return [2
@@ -29072,7 +29116,7 @@ function () {
 
   GeoClass.prototype.getGeofence = function (geofenceId, options) {
     return __awaiter(this, void 0, void 0, function () {
-      var _a, providerName, prov, error_4;
+      var _a, providerName, prov, error_5;
 
       return __generator(this, function (_b) {
         switch (_b.label) {
@@ -29094,9 +29138,9 @@ function () {
             , _b.sent()];
 
           case 3:
-            error_4 = _b.sent();
-            logger.debug(error_4);
-            throw error_4;
+            error_5 = _b.sent();
+            logger.debug(error_5);
+            throw error_5;
 
           case 4:
             return [2
@@ -29117,7 +29161,7 @@ function () {
 
   GeoClass.prototype.listGeofences = function (options) {
     return __awaiter(this, void 0, void 0, function () {
-      var _a, providerName, prov, error_5;
+      var _a, providerName, prov, error_6;
 
       return __generator(this, function (_b) {
         switch (_b.label) {
@@ -29139,9 +29183,9 @@ function () {
             , _b.sent()];
 
           case 3:
-            error_5 = _b.sent();
-            logger.debug(error_5);
-            throw error_5;
+            error_6 = _b.sent();
+            logger.debug(error_6);
+            throw error_6;
 
           case 4:
             return [2
@@ -29163,7 +29207,7 @@ function () {
 
   GeoClass.prototype.deleteGeofences = function (geofenceIds, options) {
     return __awaiter(this, void 0, void 0, function () {
-      var _a, providerName, prov, geofenceIdsInputArray, error_6;
+      var _a, providerName, prov, geofenceIdsInputArray, error_7;
 
       return __generator(this, function (_b) {
         switch (_b.label) {
@@ -29192,9 +29236,9 @@ function () {
             , _b.sent()];
 
           case 3:
-            error_6 = _b.sent();
-            logger.debug(error_6);
-            throw error_6;
+            error_7 = _b.sent();
+            logger.debug(error_7);
+            throw error_7;
 
           case 4:
             return [2
@@ -29608,6 +29652,99 @@ function () {
       });
     });
   };
+  /**
+   * 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
+   */
+
+
+  AmazonLocationServiceProvider.prototype.searchForSuggestions = function (text, options) {
+    return __awaiter(this, void 0, void 0, function () {
+      var credentialsOK, locationServiceInput, client, command, response, error_2, results;
+      return __generator(this, function (_a) {
+        switch (_a.label) {
+          case 0:
+            return [4
+            /*yield*/
+            , this._ensureCredentials()];
+
+          case 1:
+            credentialsOK = _a.sent();
+
+            if (!credentialsOK) {
+              throw new Error('No credentials');
+            }
+
+            this._verifySearchIndex(options === null || options === void 0 ? void 0 : options.searchIndexName);
+
+            locationServiceInput = {
+              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'];
+              }
+            }
+
+            client = new _aws_sdk_client_location__WEBPACK_IMPORTED_MODULE_2__["LocationClient"]({
+              credentials: this._config.credentials,
+              region: this._config.region,
+              customUserAgent: Object(_aws_amplify_core__WEBPACK_IMPORTED_MODULE_1__["getAmplifyUserAgent"])()
+            });
+            command = new _aws_sdk_client_location__WEBPACK_IMPORTED_MODULE_2__["SearchPlaceIndexForSuggestionsCommand"](locationServiceInput);
+            _a.label = 2;
+
+          case 2:
+            _a.trys.push([2, 4,, 5]);
+
+            return [4
+            /*yield*/
+            , client.send(command)];
+
+          case 3:
+            response = _a.sent();
+            return [3
+            /*break*/
+            , 5];
+
+          case 4:
+            error_2 = _a.sent();
+            logger.debug(error_2);
+            throw error_2;
+
+          case 5:
+            results = response.Results.map(function (result) {
+              return result.Text;
+            });
+            return [2
+            /*return*/
+            , results];
+        }
+      });
+    });
+  };
   /**
    * Reverse geocoding search via a coordinate point on the map
    * @param coordinates - Coordinates array for the search input
@@ -29618,7 +29755,7 @@ function () {
 
   AmazonLocationServiceProvider.prototype.searchByCoordinates = function (coordinates, options) {
     return __awaiter(this, void 0, void 0, function () {
-      var credentialsOK, locationServiceInput, client, command, response, error_2, PascalResults, results;
+      var credentialsOK, locationServiceInput, client, command, response, error_3, PascalResults, results;
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
@@ -29670,9 +29807,9 @@ function () {
             , 5];
 
           case 4:
-            error_2 = _a.sent();
-            logger.debug(error_2);
-            throw error_2;
+            error_3 = _a.sent();
+            logger.debug(error_3);
+            throw error_3;
 
           case 5:
             PascalResults = response.Results.map(function (result) {
@@ -29756,7 +29893,7 @@ function () {
             /*yield*/
             , Promise.all(geofenceBatches.map(function (batch) {
               return __awaiter(_this, void 0, void 0, function () {
-                var response, error_3;
+                var response, error_4;
                 return __generator(this, function (_a) {
                   switch (_a.label) {
                     case 0:
@@ -29773,14 +29910,14 @@ function () {
                       , 3];
 
                     case 2:
-                      error_3 = _a.sent(); // If the API call fails, add the geofences to the errors array and move to next batch
+                      error_4 = _a.sent(); // If the API call fails, add the geofences to the errors array and move to next batch
 
                       batch.forEach(function (geofence) {
                         results.errors.push({
                           geofenceId: geofence.GeofenceId,
                           error: {
                             code: 'APIConnectionError',
-                            message: error_3.message
+                            message: error_4.message
                           }
                         });
                       });
@@ -29842,7 +29979,7 @@ function () {
 
   AmazonLocationServiceProvider.prototype.getGeofence = function (geofenceId, options) {
     return __awaiter(this, void 0, void 0, function () {
-      var credentialsOK, client, commandInput, command, response, error_4, GeofenceId, CreateTime, UpdateTime, Status, Geometry, geofence;
+      var credentialsOK, client, commandInput, command, response, error_5, GeofenceId, CreateTime, UpdateTime, Status, Geometry, geofence;
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
@@ -29892,9 +30029,9 @@ function () {
             , 5];
 
           case 4:
-            error_4 = _a.sent();
-            logger.debug(error_4);
-            throw error_4;
+            error_5 = _a.sent();
+            logger.debug(error_5);
+            throw error_5;
 
           case 5:
             GeofenceId = response.GeofenceId, CreateTime = response.CreateTime, UpdateTime = response.UpdateTime, Status = response.Status, Geometry = response.Geometry;
@@ -29925,7 +30062,7 @@ function () {
 
   AmazonLocationServiceProvider.prototype.listGeofences = function (options) {
     return __awaiter(this, void 0, void 0, function () {
-      var credentialsOK, client, listGeofencesInput, command, response, error_5, NextToken, Entries, results;
+      var credentialsOK, client, listGeofencesInput, command, response, error_6, NextToken, Entries, results;
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
@@ -29974,9 +30111,9 @@ function () {
             , 5];
 
           case 4:
-            error_5 = _a.sent();
-            logger.debug(error_5);
-            throw error_5;
+            error_6 = _a.sent();
+            logger.debug(error_6);
+            throw error_6;
 
           case 5:
             NextToken = response.NextToken, Entries = response.Entries;
@@ -30069,7 +30206,7 @@ function () {
             /*yield*/
             , Promise.all(geofenceIdBatches.map(function (batch) {
               return __awaiter(_this, void 0, void 0, function () {
-                var response, error_6, badGeofenceIds;
+                var response, error_7, badGeofenceIds;
 
                 var _a;
 
@@ -30089,14 +30226,14 @@ function () {
                       , 3];
 
                     case 2:
-                      error_6 = _b.sent(); // If the API call fails, add the geofences to the errors array and move to next batch
+                      error_7 = _b.sent(); // If the API call fails, add the geofences to the errors array and move to next batch
 
                       batch.forEach(function (geofenceId) {
                         var errorObject = {
                           geofenceId: geofenceId,
                           error: {
-                            code: error_6.message,
-                            message: error_6.message
+                            code: error_7.message,
+                            message: error_7.message
                           }
                         };
                         results.errors.push(errorObject);
@@ -30140,7 +30277,7 @@ function () {
 
   AmazonLocationServiceProvider.prototype._ensureCredentials = function () {
     return __awaiter(this, void 0, void 0, function () {
-      var credentials, cred, error_7;
+      var credentials, cred, error_8;
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
@@ -30163,8 +30300,8 @@ function () {
             , true];
 
           case 2:
-            error_7 = _a.sent();
-            logger.debug('Ensure credentials error. Credentials are:', error_7);
+            error_8 = _a.sent();
+            logger.debug('Ensure credentials error. Credentials are:', error_8);
             return [2
             /*return*/
             , false];
@@ -30210,7 +30347,7 @@ function () {
 
   AmazonLocationServiceProvider.prototype._AmazonLocationServiceBatchPutGeofenceCall = function (PascalGeofences, collectionName) {
     return __awaiter(this, void 0, void 0, function () {
-      var geofenceInput, client, command, response, error_8;
+      var geofenceInput, client, command, response, error_9;
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
@@ -30240,8 +30377,8 @@ function () {
             , 4];
 
           case 3:
-            error_8 = _a.sent();
-            throw error_8;
+            error_9 = _a.sent();
+            throw error_9;
 
           case 4:
             return [2
@@ -30254,7 +30391,7 @@ function () {
 
   AmazonLocationServiceProvider.prototype._AmazonLocationServiceBatchDeleteGeofenceCall = function (geofenceIds, collectionName) {
     return __awaiter(this, void 0, void 0, function () {
-      var deleteGeofencesInput, client, command, response, error_9;
+      var deleteGeofencesInput, client, command, response, error_10;
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
@@ -30284,8 +30421,8 @@ function () {
             , 4];
 
           case 3:
-            error_9 = _a.sent();
-            throw error_9;
+            error_10 = _a.sent();
+            throw error_10;
 
           case 4:
             return [2