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

package/lib-esm/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-esm/util.js

@@ -0,0 +1,137 @@
+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.
+ *
+ * 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.
+ */
+import booleanClockwise from '@turf/boolean-clockwise';
+export 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.');
+    }
+}
+export 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.");
+    }
+}
+export 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 (booleanClockwise(linearRing)) {
+        throw new Error(errorPrefix + "LinearRing coordinates must be wound counterclockwise");
+    }
+}
+export 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);
+    });
+}
+export 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);
+    });
+}
+//# sourceMappingURL=util.js.map

package/lib-esm/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;;;;;;;;;;;GAWG;AACH,OAAO,gBAAgB,MAAM,yBAAyB,CAAC;AAWvD,MAAM,UAAU,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;AAED,MAAM,UAAU,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;AAED,MAAM,UAAU,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,gBAAgB,CAAC,UAAU,CAAC,EAAE;QACjC,MAAM,IAAI,KAAK,CACX,WAAW,0DAAuD,CACrE,CAAC;KACF;AACF,CAAC;AAED,MAAM,UAAU,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;AAED,MAAM,UAAU,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"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@aws-amplify/geo",
-	"version": "1.2.5-unstable.7+5bcba275d",
+	"version": "1.3.0",
 	"description": "Geo category for aws-amplify",
 	"main": "./lib/index.js",
 	"module": "./lib-esm/index.js",
@@ -41,8 +41,9 @@
 	},
 	"homepage": "https://aws-amplify.github.io/",
 	"dependencies": {
-		"@aws-amplify/core": "4.5.1-unstable.7+5bcba275d",
+		"@aws-amplify/core": "4.5.1",
 		"@aws-sdk/client-location": "3.48.0",
+		"@turf/boolean-clockwise": "6.5.0",
 		"camelcase-keys": "6.2.2"
 	},
 	"jest": {
@@ -71,7 +72,8 @@
 			"__tests__/model.ts",
 			"__tests__/schema.ts",
 			"__tests__/helpers.ts",
-			"__tests__/data.ts"
+			"__tests__/testData.ts",
+			"__tests__/testUtils.ts"
 		],
 		"moduleFileExtensions": [
 			"ts",
@@ -97,5 +99,5 @@
 			"lib-esm"
 		]
 	},
-	"gitHead": "5bcba275d1678e0fb1a44ab6d25f97645b31409d"
+	"gitHead": "ccbe8c71a31a79827783d9834cf50fd8aec843af"
 }

package/src/Geo.ts

@@ -17,13 +17,24 @@ import {
 } from '@aws-amplify/core';
 import { AmazonLocationServiceProvider } from './Providers/AmazonLocationServiceProvider';
 
+import { validateCoordinates } from './util';
+
 import {
+	Place,
 	GeoConfig,
 	Coordinates,
 	SearchByTextOptions,
 	SearchByCoordinatesOptions,
 	GeoProvider,
 	MapStyle,
+	GeofenceId,
+	GeofenceInput,
+	GeofenceOptions,
+	SaveGeofencesResults,
+	Geofence,
+	ListGeofenceOptions,
+	ListGeofenceResults,
+	DeleteGeofencesResults,
 } from './types';
 
 const logger = new Logger('Geo');
@@ -142,7 +153,10 @@ export class GeoClass {
 	 * @param  {SearchByTextOptions} options? - Optional parameters to the search
 	 * @returns {Promise<Place[]>} - Promise resolves to a list of Places that match search parameters
 	 */
-	public async searchByText(text: string, options?: SearchByTextOptions) {
+	public async searchByText(
+		text: string,
+		options?: SearchByTextOptions
+	): Promise<Place[]> {
 		const { providerName = DEFAULT_PROVIDER } = options || {};
 		const prov = this.getPluggable(providerName);
 
@@ -163,17 +177,124 @@ export class GeoClass {
 	public async searchByCoordinates(
 		coordinates: Coordinates,
 		options?: SearchByCoordinatesOptions
-	) {
+	): Promise<Place> {
 		const { providerName = DEFAULT_PROVIDER } = options || {};
 		const prov = this.getPluggable(providerName);
 
+		const [lng, lat] = coordinates;
 		try {
+			validateCoordinates(lng, lat);
 			return await prov.searchByCoordinates(coordinates, options);
 		} catch (error) {
 			logger.debug(error);
 			throw error;
 		}
 	}
+
+	/**
+	 * Create geofences
+	 * @param geofences - Single or array of geofence objects to create
+	 * @param options? - Optional parameters for creating geofences
+	 * @returns {Promise<SaveGeofencesResults>} - Promise that resolves to an object with:
+	 *   successes: list of geofences successfully created
+	 *   errors: list of geofences that failed to create
+	 */
+	public async saveGeofences(
+		geofences: GeofenceInput | GeofenceInput[],
+		options?: GeofenceOptions
+	): Promise<SaveGeofencesResults> {
+		const { providerName = DEFAULT_PROVIDER } = options || {};
+		const prov = this.getPluggable(providerName);
+
+		// If single geofence input, make it an array for batch call
+		let geofenceInputArray;
+		if (!Array.isArray(geofences)) {
+			geofenceInputArray = [geofences];
+		} else {
+			geofenceInputArray = geofences;
+		}
+
+		try {
+			return await prov.saveGeofences(geofenceInputArray, options);
+		} 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
+	 */
+	public async getGeofence(
+		geofenceId: GeofenceId,
+		options?: GeofenceOptions
+	): Promise<Geofence> {
+		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
+	 * @returns {Promise<ListGeofencesResults>} - Promise that resolves to an object with:
+	 *   entries: list of geofences - 100 geofences are listed per page
+	 *   nextToken: token for next page of geofences
+	 */
+	public async listGeofences(
+		options?: ListGeofenceOptions
+	): Promise<ListGeofenceResults> {
+		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[]
+	 * @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
+	 */
+	public async deleteGeofences(
+		geofenceIds: string | string[],
+		options?: GeofenceOptions
+	): Promise<DeleteGeofencesResults> {
+		const { providerName = DEFAULT_PROVIDER } = options || {};
+		const prov = this.getPluggable(providerName);
+
+		// If single geofence input, make it an array for batch call
+		let geofenceIdsInputArray;
+		if (!Array.isArray(geofenceIds)) {
+			geofenceIdsInputArray = [geofenceIds];
+		} else {
+			geofenceIdsInputArray = geofenceIds;
+		}
+
+		//  Delete geofences
+		try {
+			return await prov.deleteGeofences(geofenceIdsInputArray, options);
+		} catch (error) {
+			logger.debug(error);
+			throw error;
+		}
+	}
 }
 
 export const Geo = new GeoClass();