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

package/lib/util.d.ts

@@ -0,0 +1,6 @@
+import { Longitude, Latitude, GeofenceId, GeofenceInput, GeofencePolygon, LinearRing } from './types';
+export declare function validateCoordinates(lng: Longitude, lat: Latitude): void;
+export declare function validateGeofenceId(geofenceId: GeofenceId): void;
+export declare function validateLinearRing(linearRing: LinearRing, geofenceId?: GeofenceId): void;
+export declare function validatePolygon(polygon: GeofencePolygon, geofenceId?: GeofenceId): void;
+export declare function validateGeofencesInput(geofences: GeofenceInput[]): void;

package/lib/util.js

@@ -0,0 +1,147 @@
+"use strict";
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/*
+ * Copyright 2017-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
+var boolean_clockwise_1 = __importDefault(require("@turf/boolean-clockwise"));
+function validateCoordinates(lng, lat) {
+    if (!Number.isFinite(lng) || !Number.isFinite(lat)) {
+        throw new Error("Invalid coordinates: [" + lng + "," + lat + "]");
+    }
+    if (lat < -90 || 90 < lat) {
+        throw new Error('Latitude must be between -90 and 90 degrees inclusive.');
+    }
+    else if (lng < -180 || 180 < lng) {
+        throw new Error('Longitude must be between -180 and 180 degrees inclusive.');
+    }
+}
+exports.validateCoordinates = validateCoordinates;
+function validateGeofenceId(geofenceId) {
+    var geofenceIdRegex = /^[-._\p{L}\p{N}]+$/iu;
+    // Check if geofenceId is valid
+    if (!geofenceIdRegex.test(geofenceId)) {
+        throw new Error("Invalid geofenceId: '" + geofenceId + "' - IDs can only contain alphanumeric characters, hyphens, underscores and periods.");
+    }
+}
+exports.validateGeofenceId = validateGeofenceId;
+function validateLinearRing(linearRing, geofenceId) {
+    var errorPrefix = geofenceId ? geofenceId + ": " : '';
+    // Validate LinearRing size, must be at least 4 points
+    if (linearRing.length < 4) {
+        throw new Error(errorPrefix + "LinearRing must contain 4 or more coordinates.");
+    }
+    // Validate all coordinates are valid, error with which ones are bad
+    var badCoordinates = [];
+    linearRing.forEach(function (coordinates) {
+        try {
+            validateCoordinates(coordinates[0], coordinates[1]);
+        }
+        catch (error) {
+            badCoordinates.push({ coordinates: coordinates, error: error.message });
+        }
+    });
+    if (badCoordinates.length > 0) {
+        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
+    var _a = __read(linearRing[0], 2), lngA = _a[0], latA = _a[1];
+    var _b = __read(linearRing[linearRing.length - 1], 2), lngB = _b[0], latB = _b[1];
+    if (lngA !== lngB || latA !== latB) {
+        throw new Error(errorPrefix + "LinearRing's first and last coordinates are not the same");
+    }
+    if (boolean_clockwise_1.default(linearRing)) {
+        throw new Error(errorPrefix + "LinearRing coordinates must be wound counterclockwise");
+    }
+}
+exports.validateLinearRing = validateLinearRing;
+function validatePolygon(polygon, geofenceId) {
+    var errorPrefix = geofenceId ? geofenceId + ": " : '';
+    if (!Array.isArray(polygon)) {
+        throw new Error(errorPrefix + "Polygon is of incorrect structure. It should be an array of LinearRings");
+    }
+    if (polygon.length < 1) {
+        throw new Error(errorPrefix + "Polygon must have a single LinearRing array.");
+    }
+    if (polygon.length > 1) {
+        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) { return prev + linearRing.length; }, 0);
+    if (verticesCount > 1000) {
+        throw new Error(errorPrefix + "Polygon has more than the maximum 1000 vertices.");
+    }
+    polygon.forEach(function (linearRing) {
+        validateLinearRing(linearRing, geofenceId);
+    });
+}
+exports.validatePolygon = validatePolygon;
+function validateGeofencesInput(geofences) {
+    var geofenceIds = {};
+    geofences.forEach(function (geofence) {
+        // verify all required properties are present
+        // Validate geofenceId exists
+        if (!geofence.geofenceId) {
+            throw new Error("Geofence '" + geofence + "' is missing geofenceId");
+        }
+        var geofenceId = geofence.geofenceId;
+        validateGeofenceId(geofenceId);
+        // Validate geofenceId is unique
+        if (geofenceIds[geofenceId]) {
+            throw new Error("Duplicate geofenceId: " + geofenceId);
+        }
+        else {
+            geofenceIds[geofenceId] = true;
+        }
+        // Validate geometry exists
+        if (!geofence.geometry) {
+            throw new Error("Geofence '" + geofenceId + "' is missing geometry");
+        }
+        var geometry = geofence.geometry;
+        // Validate polygon exists
+        if (!geometry.polygon) {
+            throw new Error("Geofence '" + geofenceId + "' is missing geometry.polygon");
+        }
+        var polygon = geometry.polygon;
+        // Validate polygon length and structure
+        try {
+            validatePolygon(polygon, geofenceId);
+        }
+        catch (error) {
+            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
+        var _a = __read(polygon, 1), linearRing = _a[0];
+        validateLinearRing(linearRing, geofenceId);
+    });
+}
+exports.validateGeofencesInput = validateGeofencesInput;
+//# sourceMappingURL=util.js.map

package/lib/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;;;GAWG;AACH,8EAAuD;AAWvD,SAAgB,mBAAmB,CAAC,GAAc,EAAE,GAAa;IAChE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QACnD,MAAM,IAAI,KAAK,CAAC,2BAAyB,GAAG,SAAI,GAAG,MAAG,CAAC,CAAC;KACxD;IACD,IAAI,GAAG,GAAG,CAAC,EAAE,IAAI,EAAE,GAAG,GAAG,EAAE;QAC1B,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;KAC1E;SAAM,IAAI,GAAG,GAAG,CAAC,GAAG,IAAI,GAAG,GAAG,GAAG,EAAE;QACnC,MAAM,IAAI,KAAK,CACd,2DAA2D,CAC3D,CAAC;KACF;AACF,CAAC;AAXD,kDAWC;AAED,SAAgB,kBAAkB,CAAC,UAAsB;IACxD,IAAM,eAAe,GAAG,sBAAsB,CAAC;IAE/C,+BAA+B;IAC/B,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;QACtC,MAAM,IAAI,KAAK,CACd,0BAAwB,UAAU,wFAAqF,CACvH,CAAC;KACF;AACF,CAAC;AATD,gDASC;AAED,SAAgB,kBAAkB,CACjC,UAAsB,EACtB,UAAuB;IAEvB,IAAM,WAAW,GAAG,UAAU,CAAC,CAAC,CAAI,UAAU,OAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IACxD,sDAAsD;IACtD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;QAC1B,MAAM,IAAI,KAAK,CACX,WAAW,mDAAgD,CAC9D,CAAC;KACF;IAED,oEAAoE;IACpE,IAAM,cAAc,GAAG,EAAE,CAAC;IAC1B,UAAU,CAAC,OAAO,CAAC,UAAA,WAAW;QAC7B,IAAI;YACH,mBAAmB,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;SACpD;QAAC,OAAO,KAAK,EAAE;YACf,cAAc,CAAC,IAAI,CAAC,EAAE,WAAW,aAAA,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;SAC3D;IACF,CAAC,CAAC,CAAC;IACH,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE;QAC9B,MAAM,IAAI,KAAK,CACX,WAAW,gFAA2E,IAAI,CAAC,SAAS,CACtG,cAAc,CACZ,CACH,CAAC;KACF;IAED,mDAAmD;IAC7C,IAAA,6BAA4B,EAA3B,YAAI,EAAE,YAAqB,CAAC;IAC7B,IAAA,iDAAgD,EAA/C,YAAI,EAAE,YAAyC,CAAC;IAEvD,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,IAAI,EAAE;QACnC,MAAM,IAAI,KAAK,CACX,WAAW,6DAA0D,CACxE,CAAC;KACF;IAED,IAAI,2BAAgB,CAAC,UAAU,CAAC,EAAE;QACjC,MAAM,IAAI,KAAK,CACX,WAAW,0DAAuD,CACrE,CAAC;KACF;AACF,CAAC;AA5CD,gDA4CC;AAED,SAAgB,eAAe,CAC9B,OAAwB,EACxB,UAAuB;IAEvB,IAAM,WAAW,GAAG,UAAU,CAAC,CAAC,CAAI,UAAU,OAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IACxD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;QAC5B,MAAM,IAAI,KAAK,CACX,WAAW,4EAAyE,CACvF,CAAC;KACF;IACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;QACvB,MAAM,IAAI,KAAK,CACX,WAAW,iDAA8C,CAC5D,CAAC;KACF;IAED,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;QACvB,MAAM,IAAI,KAAK,CACX,WAAW,0LAAuL,CACrM,CAAC;KACF;IACD,IAAM,aAAa,GAAG,OAAO,CAAC,MAAM,CACnC,UAAC,IAAI,EAAE,UAAU,IAAK,OAAA,IAAI,GAAG,UAAU,CAAC,MAAM,EAAxB,CAAwB,EAC9C,CAAC,CACD,CAAC;IACF,IAAI,aAAa,GAAG,IAAI,EAAE;QACzB,MAAM,IAAI,KAAK,CACX,WAAW,qDAAkD,CAChE,CAAC;KACF;IACD,OAAO,CAAC,OAAO,CAAC,UAAA,UAAU;QACzB,kBAAkB,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;AACJ,CAAC;AAjCD,0CAiCC;AAED,SAAgB,sBAAsB,CAAC,SAA0B;IAChE,IAAM,WAAW,GAAG,EAAE,CAAC;IAEvB,SAAS,CAAC,OAAO,CAAC,UAAC,QAAuB;QACzC,6CAA6C;QAE7C,6BAA6B;QAC7B,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE;YACzB,MAAM,IAAI,KAAK,CAAC,eAAa,QAAQ,4BAAyB,CAAC,CAAC;SAChE;QACO,IAAA,gCAAU,CAAc;QAChC,kBAAkB,CAAC,UAAU,CAAC,CAAC;QAE/B,gCAAgC;QAChC,IAAI,WAAW,CAAC,UAAU,CAAC,EAAE;YAC5B,MAAM,IAAI,KAAK,CAAC,2BAAyB,UAAY,CAAC,CAAC;SACvD;aAAM;YACN,WAAW,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;SAC/B;QAED,2BAA2B;QAC3B,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;YACvB,MAAM,IAAI,KAAK,CAAC,eAAa,UAAU,0BAAuB,CAAC,CAAC;SAChE;QACO,IAAA,4BAAQ,CAAc;QAE9B,0BAA0B;QAC1B,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,eAAa,UAAU,kCAA+B,CAAC,CAAC;SACxE;QACO,IAAA,0BAAO,CAAc;QAE7B,wCAAwC;QACxC,IAAI;YACH,eAAe,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;SACrC;QAAC,OAAO,KAAK,EAAE;YACf,IACC,KAAK,CAAC,OAAO,CAAC,QAAQ,CACrB,kDAAkD,CAClD,EACA;gBACD,MAAM,IAAI,KAAK,CACd,eAAa,UAAU,iDAA8C,CACrE,CAAC;aACF;SACD;QAED,yDAAyD;QACnD,IAAA,uBAAsB,EAArB,kBAAqB,CAAC;QAC7B,kBAAkB,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;AACJ,CAAC;AAnDD,wDAmDC"}

package/lib-esm/Geo.d.ts

@@ -1,4 +1,4 @@
-import { GeoConfig, Coordinates, SearchByTextOptions, SearchByCoordinatesOptions, GeoProvider, MapStyle } from './types';
+import { Place, GeoConfig, Coordinates, SearchByTextOptions, SearchByCoordinatesOptions, GeoProvider, MapStyle, GeofenceId, GeofenceInput, GeofenceOptions, SaveGeofencesResults, Geofence, ListGeofenceOptions, ListGeofenceResults, DeleteGeofencesResults } from './types';
 export declare class GeoClass {
     static MODULE: string;
     /**
@@ -51,13 +51,46 @@ export declare class GeoClass {
      * @param  {SearchByTextOptions} options? - Optional parameters to the search
      * @returns {Promise<Place[]>} - Promise resolves to a list of Places that match search parameters
      */
-    searchByText(text: string, options?: SearchByTextOptions): Promise<import("./types").Place[]>;
+    searchByText(text: string, options?: SearchByTextOptions): Promise<Place[]>;
     /**
      * 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
      */
-    searchByCoordinates(coordinates: Coordinates, options?: SearchByCoordinatesOptions): Promise<import("./types").Place>;
+    searchByCoordinates(coordinates: Coordinates, options?: SearchByCoordinatesOptions): Promise<Place>;
+    /**
+     * Create geofences
+     * @param geofences - Single or array of geofence objects to create
+     * @param options? - Optional parameters for creating geofences
+     * @returns {Promise<SaveGeofencesResults>} - Promise that resolves to an object with:
+     *   successes: list of geofences successfully created
+     *   errors: list of geofences that failed to create
+     */
+    saveGeofences(geofences: GeofenceInput | GeofenceInput[], options?: GeofenceOptions): Promise<SaveGeofencesResults>;
+    /**
+     * 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
+     */
+    getGeofence(geofenceId: GeofenceId, options?: GeofenceOptions): Promise<Geofence>;
+    /**
+     * List geofences
+     * @param  options?: ListGeofenceOptions
+     * @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
+     */
+    listGeofences(options?: ListGeofenceOptions): Promise<ListGeofenceResults>;
+    /**
+     * Delete geofences
+     * @param geofenceIds: string|string[]
+     * @param options?: GeofenceOptions
+     * @returns {Promise<DeleteGeofencesResults>} - Promise that resolves to an object with:
+     *  successes: list of geofences successfully deleted
+     *  errors: list of geofences that failed to delete
+     */
+    deleteGeofences(geofenceIds: string | string[], options?: GeofenceOptions): Promise<DeleteGeofencesResults>;
 }
 export declare const Geo: GeoClass;

package/lib-esm/Geo.js

@@ -34,6 +34,22 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
 /*
  * Copyright 2017-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  *
@@ -48,6 +64,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
  */
 import { Amplify, ConsoleLogger as Logger, parseMobileHubConfig, } from '@aws-amplify/core';
 import { AmazonLocationServiceProvider } from './Providers/AmazonLocationServiceProvider';
+import { validateCoordinates } from './util';
 var logger = new Logger('Geo');
 var DEFAULT_PROVIDER = 'AmazonLocationService';
 var GeoClass = /** @class */ (function () {
@@ -171,21 +188,152 @@ var GeoClass = /** @class */ (function () {
      */
     GeoClass.prototype.searchByCoordinates = function (coordinates, options) {
         return __awaiter(this, void 0, void 0, function () {
-            var _a, providerName, prov, error_2;
+            var _a, providerName, prov, _b, lng, lat, error_2;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        _a = (options || {}).providerName, providerName = _a === void 0 ? DEFAULT_PROVIDER : _a;
+                        prov = this.getPluggable(providerName);
+                        _b = __read(coordinates, 2), lng = _b[0], lat = _b[1];
+                        _c.label = 1;
+                    case 1:
+                        _c.trys.push([1, 3, , 4]);
+                        validateCoordinates(lng, lat);
+                        return [4 /*yield*/, prov.searchByCoordinates(coordinates, options)];
+                    case 2: return [2 /*return*/, _c.sent()];
+                    case 3:
+                        error_2 = _c.sent();
+                        logger.debug(error_2);
+                        throw error_2;
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Create geofences
+     * @param geofences - Single or array of geofence objects to create
+     * @param options? - Optional parameters for creating geofences
+     * @returns {Promise<SaveGeofencesResults>} - Promise that resolves to an object with:
+     *   successes: list of geofences successfully created
+     *   errors: list of geofences that failed to create
+     */
+    GeoClass.prototype.saveGeofences = function (geofences, options) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, providerName, prov, geofenceInputArray, error_3;
             return __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.searchByCoordinates(coordinates, options)];
+                        return [4 /*yield*/, prov.saveGeofences(geofenceInputArray, options)];
                     case 2: return [2 /*return*/, _b.sent()];
                     case 3:
-                        error_2 = _b.sent();
-                        logger.debug(error_2);
-                        throw error_2;
+                        error_3 = _b.sent();
+                        logger.debug(error_3);
+                        throw error_3;
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * 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 __awaiter(this, void 0, void 0, function () {
+            var _a, providerName, prov, error_4;
+            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.getGeofence(geofenceId, options)];
+                    case 2: return [2 /*return*/, _b.sent()];
+                    case 3:
+                        error_4 = _b.sent();
+                        logger.debug(error_4);
+                        throw error_4;
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * List geofences
+     * @param  options?: ListGeofenceOptions
+     * @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
+     */
+    GeoClass.prototype.listGeofences = function (options) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, providerName, prov, error_5;
+            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.listGeofences(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*/];
+                }
+            });
+        });
+    };
+    /**
+     * Delete geofences
+     * @param geofenceIds: string|string[]
+     * @param options?: GeofenceOptions
+     * @returns {Promise<DeleteGeofencesResults>} - Promise that resolves to an object with:
+     *  successes: list of geofences successfully deleted
+     *  errors: list of geofences that failed to delete
+     */
+    GeoClass.prototype.deleteGeofences = function (geofenceIds, options) {
+        return __awaiter(this, void 0, void 0, function () {
+            var _a, providerName, prov, geofenceIdsInputArray, error_6;
+            return __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_6 = _b.sent();
+                        logger.debug(error_6);
+                        throw error_6;
                     case 4: return [2 /*return*/];
                 }
             });

package/lib-esm/Geo.js.map

@@ -1 +1 @@
-{"version":3,"file":"Geo.js","sourceRoot":"","sources":["../src/Geo.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;;;GAWG;AACH,OAAO,EACN,OAAO,EACP,aAAa,IAAI,MAAM,EACvB,oBAAoB,GACpB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,6BAA6B,EAAE,MAAM,2CAA2C,CAAC;AAW1F,IAAM,MAAM,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;AAEjC,IAAM,gBAAgB,GAAG,uBAAuB,CAAC;AACjD;IAQC;QACC,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACI,gCAAa,GAApB;QACC,OAAO,QAAQ,CAAC,MAAM,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,+BAAY,GAAnB,UAAoB,SAAsB;QACzC,IAAI,SAAS,IAAI,SAAS,CAAC,WAAW,EAAE,KAAK,KAAK,EAAE;YACnD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACjC,IAAM,MAAM,GAAG,SAAS,CAAC,SAAS,CACjC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC,CACzC,CAAC;YAEF,OAAO,MAAM,CAAC;SACd;IACF,CAAC;IAED;;;OAGG;IACI,+BAAY,GAAnB,UAAoB,YAAoB;QACvC,IAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CACtC,UAAA,SAAS,IAAI,OAAA,SAAS,CAAC,eAAe,EAAE,KAAK,YAAY,EAA5C,CAA4C,CACzD,CAAC;QACF,IAAI,SAAS,KAAK,SAAS,EAAE;YAC5B,MAAM,CAAC,KAAK,CAAC,mCAAmC,EAAE,YAAY,CAAC,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;SAC3D;;YAAM,OAAO,SAAS,CAAC;IACzB,CAAC;IAED;;;OAGG;IACI,kCAAe,GAAtB,UAAuB,YAAoB;QAC1C,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CACzC,UAAA,SAAS,IAAI,OAAA,SAAS,CAAC,eAAe,EAAE,KAAK,YAAY,EAA5C,CAA4C,CACzD,CAAC;QACF,OAAO;IACR,CAAC;IAED;;;;OAIG;IACH,4BAAS,GAAT,UAAU,MAAO;QAAjB,iBAgBC;QAfA,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAE9B,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC,OAAO,CAAC;QAEjC,IAAM,aAAa,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC;QACnD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAE1E,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,UAAA,SAAS;YACjC,SAAS,CAAC,SAAS,CAAC,KAAI,CAAC,OAAO,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;YAClC,IAAI,CAAC,YAAY,CAAC,IAAI,6BAA6B,EAAE,CAAC,CAAC;SACvD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACI,mCAAgB,GAAvB,UAAwB,QAA2B;QAA3B,yBAAA,EAAA,2BAA2B;QAClD,IAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAEzC,OAAO,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACI,gCAAa,GAApB,UAAqB,QAA2B;QAA3B,yBAAA,EAAA,2BAA2B;QAC/C,IAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAEzC,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACU,+BAAY,GAAzB,UAA0B,IAAY,EAAE,OAA6B;;;;;;wBAC5D,KAAoC,CAAA,OAAO,IAAI,EAAE,CAAA,aAAlB,EAA/B,YAAY,mBAAG,gBAAgB,KAAA,CAAmB;wBACpD,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;;;;wBAGrC,qBAAM,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,EAAA;4BAA7C,sBAAO,SAAsC,EAAC;;;wBAE9C,MAAM,CAAC,KAAK,CAAC,OAAK,CAAC,CAAC;wBACpB,MAAM,OAAK,CAAC;;;;;KAEb;IAED;;;;;OAKG;IACU,sCAAmB,GAAhC,UACC,WAAwB,EACxB,OAAoC;;;;;;wBAE5B,KAAoC,CAAA,OAAO,IAAI,EAAE,CAAA,aAAlB,EAA/B,YAAY,mBAAG,gBAAgB,KAAA,CAAmB;wBACpD,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;;;;wBAGrC,qBAAM,IAAI,CAAC,mBAAmB,CAAC,WAAW,EAAE,OAAO,CAAC,EAAA;4BAA3D,sBAAO,SAAoD,EAAC;;;wBAE5D,MAAM,CAAC,KAAK,CAAC,OAAK,CAAC,CAAC;wBACpB,MAAM,OAAK,CAAC;;;;;KAEb;IA/IM,eAAM,GAAG,KAAK,CAAC;IAgJvB,eAAC;CAAA,AAjJD,IAiJC;SAjJY,QAAQ;AAmJrB,MAAM,CAAC,IAAM,GAAG,GAAG,IAAI,QAAQ,EAAE,CAAC;AAClC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC"}
+{"version":3,"file":"Geo.js","sourceRoot":"","sources":["../src/Geo.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;;;GAWG;AACH,OAAO,EACN,OAAO,EACP,aAAa,IAAI,MAAM,EACvB,oBAAoB,GACpB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,6BAA6B,EAAE,MAAM,2CAA2C,CAAC;AAE1F,OAAO,EAAE,mBAAmB,EAAE,MAAM,QAAQ,CAAC;AAoB7C,IAAM,MAAM,GAAG,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;AAEjC,IAAM,gBAAgB,GAAG,uBAAuB,CAAC;AACjD;IAQC;QACC,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;QAClB,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,MAAM,CAAC,KAAK,CAAC,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACI,gCAAa,GAApB;QACC,OAAO,QAAQ,CAAC,MAAM,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,+BAAY,GAAnB,UAAoB,SAAsB;QACzC,IAAI,SAAS,IAAI,SAAS,CAAC,WAAW,EAAE,KAAK,KAAK,EAAE;YACnD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACjC,IAAM,MAAM,GAAG,SAAS,CAAC,SAAS,CACjC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC,CACzC,CAAC;YAEF,OAAO,MAAM,CAAC;SACd;IACF,CAAC;IAED;;;OAGG;IACI,+BAAY,GAAnB,UAAoB,YAAoB;QACvC,IAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CACtC,UAAA,SAAS,IAAI,OAAA,SAAS,CAAC,eAAe,EAAE,KAAK,YAAY,EAA5C,CAA4C,CACzD,CAAC;QACF,IAAI,SAAS,KAAK,SAAS,EAAE;YAC5B,MAAM,CAAC,KAAK,CAAC,mCAAmC,EAAE,YAAY,CAAC,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;SAC3D;;YAAM,OAAO,SAAS,CAAC;IACzB,CAAC;IAED;;;OAGG;IACI,kCAAe,GAAtB,UAAuB,YAAoB;QAC1C,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CACzC,UAAA,SAAS,IAAI,OAAA,SAAS,CAAC,eAAe,EAAE,KAAK,YAAY,EAA5C,CAA4C,CACzD,CAAC;QACF,OAAO;IACR,CAAC;IAED;;;;OAIG;IACH,4BAAS,GAAT,UAAU,MAAO;QAAjB,iBAgBC;QAfA,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAE9B,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC,OAAO,CAAC;QAEjC,IAAM,aAAa,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC;QACnD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAE1E,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,UAAA,SAAS;YACjC,SAAS,CAAC,SAAS,CAAC,KAAI,CAAC,OAAO,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE;YAClC,IAAI,CAAC,YAAY,CAAC,IAAI,6BAA6B,EAAE,CAAC,CAAC;SACvD;QACD,OAAO,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACI,mCAAgB,GAAvB,UAAwB,QAA2B;QAA3B,yBAAA,EAAA,2BAA2B;QAClD,IAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAEzC,OAAO,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACI,gCAAa,GAApB,UAAqB,QAA2B;QAA3B,yBAAA,EAAA,2BAA2B;QAC/C,IAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAEzC,OAAO,IAAI,CAAC,aAAa,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACU,+BAAY,GAAzB,UACC,IAAY,EACZ,OAA6B;;;;;;wBAErB,KAAoC,CAAA,OAAO,IAAI,EAAE,CAAA,aAAlB,EAA/B,YAAY,mBAAG,gBAAgB,KAAA,CAAmB;wBACpD,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;;;;wBAGrC,qBAAM,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,EAAA;4BAA7C,sBAAO,SAAsC,EAAC;;;wBAE9C,MAAM,CAAC,KAAK,CAAC,OAAK,CAAC,CAAC;wBACpB,MAAM,OAAK,CAAC;;;;;KAEb;IAED;;;;;OAKG;IACU,sCAAmB,GAAhC,UACC,WAAwB,EACxB,OAAoC;;;;;;wBAE5B,KAAoC,CAAA,OAAO,IAAI,EAAE,CAAA,aAAlB,EAA/B,YAAY,mBAAG,gBAAgB,KAAA,CAAmB;wBACpD,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;wBAEvC,KAAA,OAAa,WAAW,IAAA,EAAvB,GAAG,QAAA,EAAE,GAAG,QAAA,CAAgB;;;;wBAE9B,mBAAmB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;wBACvB,qBAAM,IAAI,CAAC,mBAAmB,CAAC,WAAW,EAAE,OAAO,CAAC,EAAA;4BAA3D,sBAAO,SAAoD,EAAC;;;wBAE5D,MAAM,CAAC,KAAK,CAAC,OAAK,CAAC,CAAC;wBACpB,MAAM,OAAK,CAAC;;;;;KAEb;IAED;;;;;;;OAOG;IACU,gCAAa,GAA1B,UACC,SAA0C,EAC1C,OAAyB;;;;;;wBAEjB,KAAoC,CAAA,OAAO,IAAI,EAAE,CAAA,aAAlB,EAA/B,YAAY,mBAAG,gBAAgB,KAAA,CAAmB;wBACpD,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;wBAI7C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;4BAC9B,kBAAkB,GAAG,CAAC,SAAS,CAAC,CAAC;yBACjC;6BAAM;4BACN,kBAAkB,GAAG,SAAS,CAAC;yBAC/B;;;;wBAGO,qBAAM,IAAI,CAAC,aAAa,CAAC,kBAAkB,EAAE,OAAO,CAAC,EAAA;4BAA5D,sBAAO,SAAqD,EAAC;;;wBAE7D,MAAM,CAAC,KAAK,CAAC,OAAK,CAAC,CAAC;wBACpB,MAAM,OAAK,CAAC;;;;;KAEb;IAED;;;;;OAKG;IACU,8BAAW,GAAxB,UACC,UAAsB,EACtB,OAAyB;;;;;;wBAEjB,KAAoC,CAAA,OAAO,IAAI,EAAE,CAAA,aAAlB,EAA/B,YAAY,mBAAG,gBAAgB,KAAA,CAAmB;wBACpD,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;;;;wBAGrC,qBAAM,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,OAAO,CAAC,EAAA;4BAAlD,sBAAO,SAA2C,EAAC;;;wBAEnD,MAAM,CAAC,KAAK,CAAC,OAAK,CAAC,CAAC;wBACpB,MAAM,OAAK,CAAC;;;;;KAEb;IAED;;;;;;OAMG;IACU,gCAAa,GAA1B,UACC,OAA6B;;;;;;wBAErB,KAAoC,CAAA,OAAO,IAAI,EAAE,CAAA,aAAlB,EAA/B,YAAY,mBAAG,gBAAgB,KAAA,CAAmB;wBACpD,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;;;;wBAGrC,qBAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAA;4BAAxC,sBAAO,SAAiC,EAAC;;;wBAEzC,MAAM,CAAC,KAAK,CAAC,OAAK,CAAC,CAAC;wBACpB,MAAM,OAAK,CAAC;;;;;KAEb;IAED;;;;;;;OAOG;IACU,kCAAe,GAA5B,UACC,WAA8B,EAC9B,OAAyB;;;;;;wBAEjB,KAAoC,CAAA,OAAO,IAAI,EAAE,CAAA,aAAlB,EAA/B,YAAY,mBAAG,gBAAgB,KAAA,CAAmB;wBACpD,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;wBAI7C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;4BAChC,qBAAqB,GAAG,CAAC,WAAW,CAAC,CAAC;yBACtC;6BAAM;4BACN,qBAAqB,GAAG,WAAW,CAAC;yBACpC;;;;wBAIO,qBAAM,IAAI,CAAC,eAAe,CAAC,qBAAqB,EAAE,OAAO,CAAC,EAAA;4BAAjE,sBAAO,SAA0D,EAAC;;;wBAElE,MAAM,CAAC,KAAK,CAAC,OAAK,CAAC,CAAC;wBACpB,MAAM,OAAK,CAAC;;;;;KAEb;IA7PM,eAAM,GAAG,KAAK,CAAC;IA8PvB,eAAC;CAAA,AA/PD,IA+PC;SA/PY,QAAQ;AAiQrB,MAAM,CAAC,IAAM,GAAG,GAAG,IAAI,QAAQ,EAAE,CAAC;AAClC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC"}

package/lib-esm/Providers/AmazonLocationServiceProvider.d.ts

@@ -1,4 +1,4 @@
-import { GeoConfig, SearchByTextOptions, SearchByCoordinatesOptions, GeoProvider, Place, AmazonLocationServiceMapStyle, Coordinates } from '../types';
+import { GeoConfig, SearchByTextOptions, SearchByCoordinatesOptions, GeoProvider, Place, AmazonLocationServiceMapStyle, Coordinates, GeofenceId, GeofenceInput, AmazonLocationServiceGeofenceOptions, AmazonLocationServiceListGeofenceOptions, ListGeofenceResults, SaveGeofencesResults, AmazonLocationServiceGeofence, AmazonLocationServiceDeleteGeofencesResults } from '../types';
 export declare class AmazonLocationServiceProvider implements GeoProvider {
     static CATEGORY: string;
     static PROVIDER_NAME: string;
@@ -51,10 +51,46 @@ export declare class AmazonLocationServiceProvider implements GeoProvider {
      * @returns {Promise<Place>} - Promise that resolves to a place matching search coordinates
      */
     searchByCoordinates(coordinates: Coordinates, options?: SearchByCoordinatesOptions): Promise<Place>;
+    /**
+     * Create geofences inside of a geofence collection
+     * @param geofences - Array of geofence objects to create
+     * @param options? - Optional parameters for creating geofences
+     * @returns {Promise<AmazonLocationServiceSaveGeofencesResults>} - Promise that resolves to an object with:
+     *   successes: list of geofences successfully created
+     *   errors: list of geofences that failed to create
+     */
+    saveGeofences(geofences: GeofenceInput[], options?: AmazonLocationServiceGeofenceOptions): Promise<SaveGeofencesResults>;
+    /**
+     * Get geofence from a geofence collection
+     * @param geofenceId:string
+     * @param options?: Optional parameters for getGeofence
+     * @returns {Promise<AmazonLocationServiceGeofence>} - Promise that resolves to a geofence object
+     */
+    getGeofence(geofenceId: GeofenceId, options?: AmazonLocationServiceGeofenceOptions): Promise<AmazonLocationServiceGeofence>;
+    /**
+     * List geofences from a geofence collection
+     * @param  options?: ListGeofenceOptions
+     * @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
+     */
+    listGeofences(options?: AmazonLocationServiceListGeofenceOptions): Promise<ListGeofenceResults>;
+    /**
+     * Delete geofences from a geofence collection
+     * @param geofenceIds: string|string[]
+     * @param options?: GeofenceOptions
+     * @returns {Promise<DeleteGeofencesResults>} - Promise that resolves to an object with:
+     *  successes: list of geofences successfully deleted
+     *  errors: list of geofences that failed to delete
+     */
+    deleteGeofences(geofenceIds: string[], options?: AmazonLocationServiceGeofenceOptions): Promise<AmazonLocationServiceDeleteGeofencesResults>;
     /**
      * @private
      */
     private _ensureCredentials;
     private _verifyMapResources;
     private _verifySearchIndex;
+    private _verifyGeofenceCollections;
+    private _AmazonLocationServiceBatchPutGeofenceCall;
+    private _AmazonLocationServiceBatchDeleteGeofenceCall;
 }