@aws-amplify/geo 1.2.5-geo.7 → 1.2.5-unstable.10

package/dist/aws-amplify-geo.js

@@ -28933,50 +28933,6 @@ 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
@@ -28987,7 +28943,7 @@ function () {
 
   GeoClass.prototype.searchByCoordinates = function (coordinates, options) {
     return __awaiter(this, void 0, void 0, function () {
-      var _a, providerName, prov, _b, lng, lat, error_3;
+      var _a, providerName, prov, _b, lng, lat, error_2;
 
       return __generator(this, function (_c) {
         switch (_c.label) {
@@ -29011,9 +28967,9 @@ function () {
             , _c.sent()];
 
           case 3:
-            error_3 = _c.sent();
-            logger.debug(error_3);
-            throw error_3;
+            error_2 = _c.sent();
+            logger.debug(error_2);
+            throw error_2;
 
           case 4:
             return [2
@@ -29035,7 +28991,7 @@ function () {
 
   GeoClass.prototype.saveGeofences = function (geofences, options) {
     return __awaiter(this, void 0, void 0, function () {
-      var _a, providerName, prov, geofenceInputArray, error_4;
+      var _a, providerName, prov, geofenceInputArray, error_3;
 
       return __generator(this, function (_b) {
         switch (_b.label) {
@@ -29064,9 +29020,9 @@ function () {
             , _b.sent()];
 
           case 3:
-            error_4 = _b.sent();
-            logger.debug(error_4);
-            throw error_4;
+            error_3 = _b.sent();
+            logger.debug(error_3);
+            throw error_3;
 
           case 4:
             return [2
@@ -29078,15 +29034,15 @@ function () {
   };
   /**
    * Get a single geofence by geofenceId
-   * @param geofenceId: string
-   * @param options?: GeofenceOptions
+   * @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 __awaiter(this, void 0, void 0, function () {
-      var _a, providerName, prov, error_5;
+      var _a, providerName, prov, error_4;
 
       return __generator(this, function (_b) {
         switch (_b.label) {
@@ -29108,9 +29064,9 @@ function () {
             , _b.sent()];
 
           case 3:
-            error_5 = _b.sent();
-            logger.debug(error_5);
-            throw error_5;
+            error_4 = _b.sent();
+            logger.debug(error_4);
+            throw error_4;
 
           case 4:
             return [2
@@ -29131,7 +29087,7 @@ function () {
 
   GeoClass.prototype.listGeofences = function (options) {
     return __awaiter(this, void 0, void 0, function () {
-      var _a, providerName, prov, error_6;
+      var _a, providerName, prov, error_5;
 
       return __generator(this, function (_b) {
         switch (_b.label) {
@@ -29153,9 +29109,9 @@ function () {
             , _b.sent()];
 
           case 3:
-            error_6 = _b.sent();
-            logger.debug(error_6);
-            throw error_6;
+            error_5 = _b.sent();
+            logger.debug(error_5);
+            throw error_5;
 
           case 4:
             return [2
@@ -29177,7 +29133,7 @@ function () {
 
   GeoClass.prototype.deleteGeofences = function (geofenceIds, options) {
     return __awaiter(this, void 0, void 0, function () {
-      var _a, providerName, prov, geofenceIdsInputArray, error_7;
+      var _a, providerName, prov, geofenceIdsInputArray, error_6;
 
       return __generator(this, function (_b) {
         switch (_b.label) {
@@ -29206,9 +29162,9 @@ function () {
             , _b.sent()];
 
           case 3:
-            error_7 = _b.sent();
-            logger.debug(error_7);
-            throw error_7;
+            error_6 = _b.sent();
+            logger.debug(error_6);
+            throw error_6;
 
           case 4:
             return [2
@@ -29622,99 +29578,6 @@ 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
@@ -29725,7 +29588,7 @@ function () {
 
   AmazonLocationServiceProvider.prototype.searchByCoordinates = function (coordinates, options) {
     return __awaiter(this, void 0, void 0, function () {
-      var credentialsOK, locationServiceInput, client, command, response, error_3, PascalResults, results;
+      var credentialsOK, locationServiceInput, client, command, response, error_2, PascalResults, results;
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
@@ -29777,9 +29640,9 @@ function () {
             , 5];
 
           case 4:
-            error_3 = _a.sent();
-            logger.debug(error_3);
-            throw error_3;
+            error_2 = _a.sent();
+            logger.debug(error_2);
+            throw error_2;
 
           case 5:
             PascalResults = response.Results.map(function (result) {
@@ -29807,13 +29670,17 @@ function () {
 
   AmazonLocationServiceProvider.prototype.saveGeofences = function (geofences, options) {
     return __awaiter(this, void 0, void 0, function () {
-      var credentialsOK, PascalGeofences, results, batches;
+      var credentialsOK, PascalGeofences, results, geofenceBatches, apiLimit;
 
       var _this = this;
 
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
+            if (geofences.length < 1) {
+              throw new Error('Geofence input array is empty');
+            }
+
             return [4
             /*yield*/
             , this._ensureCredentials()];
@@ -29848,18 +29715,18 @@ function () {
               successes: [],
               errors: []
             };
-            batches = [];
+            geofenceBatches = [];
 
             while (PascalGeofences.length > 0) {
-              // Splice off 10 geofences from input clone due to Amazon Location Service API limit
-              batches.push(PascalGeofences.splice(0, 10));
+              apiLimit = 10;
+              geofenceBatches.push(PascalGeofences.splice(0, apiLimit));
             }
 
             return [4
             /*yield*/
-            , Promise.all(batches.map(function (batch) {
+            , Promise.all(geofenceBatches.map(function (batch) {
               return __awaiter(_this, void 0, void 0, function () {
-                var response, error_4;
+                var response, error_3;
                 return __generator(this, function (_a) {
                   switch (_a.label) {
                     case 0:
@@ -29876,14 +29743,14 @@ function () {
                       , 3];
 
                     case 2:
-                      error_4 = _a.sent(); // If the API call fails, add the geofences to the errors array and move to next batch
+                      error_3 = _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_4.message
+                            message: error_3.message
                           }
                         });
                       });
@@ -29945,7 +29812,7 @@ function () {
 
   AmazonLocationServiceProvider.prototype.getGeofence = function (geofenceId, options) {
     return __awaiter(this, void 0, void 0, function () {
-      var credentialsOK, client, commandInput, command, response, error_5, GeofenceId, CreateTime, UpdateTime, Status, Geometry, geofence;
+      var credentialsOK, client, commandInput, command, response, error_4, GeofenceId, CreateTime, UpdateTime, Status, Geometry, geofence;
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
@@ -29995,9 +29862,9 @@ function () {
             , 5];
 
           case 4:
-            error_5 = _a.sent();
-            logger.debug(error_5);
-            throw error_5;
+            error_4 = _a.sent();
+            logger.debug(error_4);
+            throw error_4;
 
           case 5:
             GeofenceId = response.GeofenceId, CreateTime = response.CreateTime, UpdateTime = response.UpdateTime, Status = response.Status, Geometry = response.Geometry;
@@ -30028,7 +29895,7 @@ function () {
 
   AmazonLocationServiceProvider.prototype.listGeofences = function (options) {
     return __awaiter(this, void 0, void 0, function () {
-      var credentialsOK, client, listGeofencesInput, command, response, error_6, NextToken, Entries, results;
+      var credentialsOK, client, listGeofencesInput, command, response, error_5, NextToken, Entries, results;
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
@@ -30077,9 +29944,9 @@ function () {
             , 5];
 
           case 4:
-            error_6 = _a.sent();
-            logger.debug(error_6);
-            throw error_6;
+            error_5 = _a.sent();
+            logger.debug(error_5);
+            throw error_5;
 
           case 5:
             NextToken = response.NextToken, Entries = response.Entries;
@@ -30121,13 +29988,17 @@ function () {
 
   AmazonLocationServiceProvider.prototype.deleteGeofences = function (geofenceIds, options) {
     return __awaiter(this, void 0, void 0, function () {
-      var credentialsOK, badGeofenceIds, results, batches, count;
+      var credentialsOK, badGeofenceIds, results, geofenceIdBatches, count;
 
       var _this = this;
 
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
+            if (geofenceIds.length < 1) {
+              throw new Error('GeofenceId input array is empty');
+            }
+
             return [4
             /*yield*/
             , this._ensureCredentials()];
@@ -30157,18 +30028,18 @@ function () {
               successes: [],
               errors: []
             };
-            batches = [];
+            geofenceIdBatches = [];
             count = 0;
 
             while (count < geofenceIds.length) {
-              batches.push(geofenceIds.slice(count, count += 10));
+              geofenceIdBatches.push(geofenceIds.slice(count, count += 10));
             }
 
             return [4
             /*yield*/
-            , Promise.all(batches.map(function (batch) {
+            , Promise.all(geofenceIdBatches.map(function (batch) {
               return __awaiter(_this, void 0, void 0, function () {
-                var response, error_7, badGeofenceIds;
+                var response, error_6, badGeofenceIds;
 
                 var _a;
 
@@ -30188,14 +30059,14 @@ function () {
                       , 3];
 
                     case 2:
-                      error_7 = _b.sent(); // If the API call fails, add the geofences to the errors array and move to next batch
+                      error_6 = _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_7.message,
-                            message: error_7.message
+                            code: error_6.message,
+                            message: error_6.message
                           }
                         };
                         results.errors.push(errorObject);
@@ -30239,7 +30110,7 @@ function () {
 
   AmazonLocationServiceProvider.prototype._ensureCredentials = function () {
     return __awaiter(this, void 0, void 0, function () {
-      var credentials, cred, error_8;
+      var credentials, cred, error_7;
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
@@ -30262,8 +30133,8 @@ function () {
             , true];
 
           case 2:
-            error_8 = _a.sent();
-            logger.debug('Ensure credentials error. Credentials are:', error_8);
+            error_7 = _a.sent();
+            logger.debug('Ensure credentials error. Credentials are:', error_7);
             return [2
             /*return*/
             , false];
@@ -30309,7 +30180,7 @@ function () {
 
   AmazonLocationServiceProvider.prototype._AmazonLocationServiceBatchPutGeofenceCall = function (PascalGeofences, collectionName) {
     return __awaiter(this, void 0, void 0, function () {
-      var geofenceInput, client, command, response, error_9;
+      var geofenceInput, client, command, response, error_8;
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
@@ -30339,8 +30210,8 @@ function () {
             , 4];
 
           case 3:
-            error_9 = _a.sent();
-            throw error_9;
+            error_8 = _a.sent();
+            throw error_8;
 
           case 4:
             return [2
@@ -30353,7 +30224,7 @@ function () {
 
   AmazonLocationServiceProvider.prototype._AmazonLocationServiceBatchDeleteGeofenceCall = function (geofenceIds, collectionName) {
     return __awaiter(this, void 0, void 0, function () {
-      var deleteGeofencesInput, client, command, response, error_10;
+      var deleteGeofencesInput, client, command, response, error_9;
       return __generator(this, function (_a) {
         switch (_a.label) {
           case 0:
@@ -30383,8 +30254,8 @@ function () {
             , 4];
 
           case 3:
-            error_10 = _a.sent();
-            throw error_10;
+            error_9 = _a.sent();
+            throw error_9;
 
           case 4:
             return [2
@@ -30481,9 +30352,9 @@ function validateCoordinates(lng, lat) {
     throw new Error("Invalid coordinates: [" + lng + "," + lat + "]");
   }
 
-  if (lat < -90 || lat > 90) {
+  if (lat < -90 || 90 < lat) {
     throw new Error('Latitude must be between -90 and 90 degrees inclusive.');
-  } else if (lng < -180 || lng > 180) {
+  } else if (lng < -180 || 180 < lng) {
     throw new Error('Longitude must be between -180 and 180 degrees inclusive.');
   }
 }
@@ -30495,9 +30366,10 @@ function validateGeofenceId(geofenceId) {
   }
 }
 function validateLinearRing(linearRing, geofenceId) {
-  // Validate LinearRing size, must be at least 4 points
+  var errorPrefix = geofenceId ? geofenceId + ": " : ''; // Validate LinearRing size, must be at least 4 points
+
   if (linearRing.length < 4) {
-    throw new Error(geofenceId + ": LinearRing must contain 4 or more coordinates.");
+    throw new Error(errorPrefix + "LinearRing must contain 4 or more coordinates.");
   } // Validate all coordinates are valid, error with which ones are bad
 
 
@@ -30514,7 +30386,7 @@ function validateLinearRing(linearRing, geofenceId) {
   });
 
   if (badCoordinates.length > 0) {
-    throw new Error(geofenceId + ": One or more of the coordinates in the Polygon LinearRing are not valid: " + JSON.stringify(badCoordinates));
+    throw new Error(errorPrefix + "One or more of the coordinates in the Polygon LinearRing are not valid: " + JSON.stringify(badCoordinates));
   } // Validate first and last coordinates are the same
 
 
@@ -30527,24 +30399,26 @@ function validateLinearRing(linearRing, geofenceId) {
       latB = _b[1];
 
   if (lngA !== lngB || latA !== latB) {
-    throw new Error(geofenceId + ": LinearRing's first and last coordinates are not the same");
+    throw new Error(errorPrefix + "LinearRing's first and last coordinates are not the same");
   }
 
   if (Object(_turf_boolean_clockwise__WEBPACK_IMPORTED_MODULE_0__["default"])(linearRing)) {
-    throw new Error(geofenceId + ": LinearRing coordinates must be wound counterclockwise");
+    throw new Error(errorPrefix + "LinearRing coordinates must be wound counterclockwise");
   }
 }
 function validatePolygon(polygon, geofenceId) {
+  var errorPrefix = geofenceId ? geofenceId + ": " : '';
+
   if (!Array.isArray(polygon)) {
-    throw new Error(geofenceId + ": Polygon is of incorrect structure. It should be an array of LinearRings");
+    throw new Error(errorPrefix + "Polygon is of incorrect structure. It should be an array of LinearRings");
   }
 
   if (polygon.length < 1) {
-    throw new Error(geofenceId + ": Polygon must have a single LinearRing array.");
+    throw new Error(errorPrefix + "Polygon must have a single LinearRing array.");
   }
 
   if (polygon.length > 1) {
-    throw new Error(geofenceId + ": Polygon must have a single LinearRing array. Note: We do not currently support polygons with holes, multipolygons, polygons that are wound clockwise, or that cross the antimeridian.");
+    throw new Error(errorPrefix + "Polygon must have a single LinearRing array. Note: We do not currently support polygons with holes, multipolygons, polygons that are wound clockwise, or that cross the antimeridian.");
   }
 
   var verticesCount = polygon.reduce(function (prev, linearRing) {
@@ -30552,8 +30426,12 @@ function validatePolygon(polygon, geofenceId) {
   }, 0);
 
   if (verticesCount > 1000) {
-    throw new Error(geofenceId + ": Polygon has more than the maximum 1000 vertices.");
+    throw new Error(errorPrefix + "Polygon has more than the maximum 1000 vertices.");
   }
+
+  polygon.forEach(function (linearRing) {
+    validateLinearRing(linearRing, geofenceId);
+  });
 }
 function validateGeofencesInput(geofences) {
   var geofenceIds = {};
@@ -30589,7 +30467,7 @@ function validateGeofencesInput(geofences) {
     try {
       validatePolygon(polygon, geofenceId);
     } catch (error) {
-      if (error.message === "Polygon has more than the maximum 1000 vertices.") {
+      if (error.message.includes('Polygon has more than the maximum 1000 vertices.')) {
         throw new Error("Geofence '" + geofenceId + "' has more than the maximum of 1000 vertices");
       }
     } // Validate LinearRing length, structure, and coordinates