@aws-amplify/geo 2.3.5 → 3.0.1-console-preview.67f944e.0

package/package.json

@@ -1,117 +1,134 @@
 {
-	"name": "@aws-amplify/geo",
-	"version": "2.3.5",
-	"description": "Geo category for aws-amplify",
-	"main": "./lib/index.js",
-	"module": "./lib-esm/index.js",
-	"typings": "./lib-esm/index.d.ts",
-	"react-native": {
-		"./lib/index": "./lib-esm/index.js"
-	},
-	"publishConfig": {
-		"access": "public"
-	},
-	"sideEffects": [
-		"./lib/geo/geo.js",
-		"./lib-esm/geo/geo.js"
-	],
-	"scripts": {
-		"test": "yarn run lint && jest -w 1 --coverage",
-		"test:size": "size-limit",
-		"build-with-test": "yarn test && yarn run build",
-		"build:cjs": "node ./build es5 && webpack && webpack --config ./webpack.config.dev.js",
-		"build:esm": "node ./build es6",
-		"build:cjs:watch": "node ./build es5 --watch",
-		"build:esm:watch": "rimraf lib-esm && node ./build es6 --watch",
-		"build": "yarn clean && yarn build:esm && yarn run build:cjs",
-		"clean": "npm run clean:size && rimraf lib-esm lib dist",
-		"clean:size": "rimraf dual-publish-tmp tmp*",
-		"format": "echo \"Not implemented\"",
-		"lint": "tslint '{__tests__,src}/**/*.ts' && npm run ts-coverage",
-		"ts-coverage": "typescript-coverage-report -p ./tsconfig.build.json -t 86.56"
-	},
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/aws-amplify/amplify-js.git"
-	},
-	"author": "Amazon Web Services",
-	"license": "Apache-2.0",
-	"bugs": {
-		"url": "https://github.com/aws/aws-amplify/issues"
-	},
-	"homepage": "https://aws-amplify.github.io/",
-	"files": [
-		"lib",
-		"lib-esm",
-		"src"
-	],
-	"dependencies": {
-		"@aws-amplify/core": "5.8.5",
-		"@aws-sdk/client-location": "3.186.3",
-		"@turf/boolean-clockwise": "6.5.0",
-		"camelcase-keys": "6.2.2",
-		"tslib": "^1.8.0"
-	},
-	"size-limit": [
-		{
-			"name": "Geo (top-level class)",
-			"path": "./lib-esm/index.js",
-			"import": "{ Amplify, Geo }",
-			"limit": "52.12 kB"
-		}
-	],
-	"jest": {
-		"globals": {
-			"ts-jest": {
-				"diagnostics": true,
-				"tsConfig": {
-					"lib": [
-						"es5",
-						"es2015",
-						"dom",
-						"esnext.asynciterable",
-						"es2019.object"
-					],
-					"allowJs": true,
-					"esModuleInterop": true,
-					"downlevelIteration": true
-				}
-			}
-		},
-		"transform": {
-			"^.+\\.(js|jsx|ts|tsx)$": "ts-jest"
-		},
-		"testRegex": "(/__tests__/.*|\\.(test|spec))\\.(tsx?|jsx?)$",
-		"testPathIgnorePatterns": [
-			"__tests__/model.ts",
-			"__tests__/schema.ts",
-			"__tests__/helpers.ts",
-			"__tests__/testData.ts",
-			"__tests__/testUtils.ts"
-		],
-		"moduleFileExtensions": [
-			"ts",
-			"tsx",
-			"js",
-			"json",
-			"jsx"
-		],
-		"testEnvironment": "jsdom",
-		"testURL": "http://localhost/",
-		"coverageThreshold": {
-			"global": {
-				"branches": 0,
-				"functions": 0,
-				"lines": 0,
-				"statements": 0
-			}
-		},
-		"coveragePathIgnorePatterns": [
-			"/node_modules/",
-			"dist",
-			"lib",
-			"lib-esm"
-		]
-	},
-	"gitHead": "c3a06153e3ffe05dd65485a22b1f99aabe9b3d83"
+  "name": "@aws-amplify/geo",
+  "version": "3.0.1-console-preview.67f944e.0+67f944e",
+  "description": "Geo category for aws-amplify",
+  "main": "./lib/index.js",
+  "module": "./lib-esm/index.js",
+  "typings": "./lib-esm/index.d.ts",
+  "react-native": {
+    "./lib/index": "./lib-esm/index.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": [
+    "./lib/geo/geo.js",
+    "./lib-esm/geo/geo.js"
+  ],
+  "scripts": {
+    "test": "yarn run lint && jest -w 1 --coverage",
+    "test:size": "size-limit",
+    "build-with-test": "yarn test && yarn run build",
+    "build:cjs": "rimraf lib && tsc -m commonjs --outDir lib && webpack && webpack --config ./webpack.config.dev.js",
+    "build:esm": "rimraf lib-esm && tsc -m esnext --outDir lib-esm",
+    "build:cjs:watch": "rimraf lib && tsc -m commonjs --outDir lib --watch",
+    "build:esm:watch": "rimraf lib-esm && tsc -m esnext --outDir lib-esm --watch",
+    "build": "yarn clean && yarn build:esm && yarn run build:cjs",
+    "clean": "npm run clean:size && rimraf lib-esm lib dist",
+    "clean:size": "rimraf dual-publish-tmp tmp*",
+    "format": "echo \"Not implemented\"",
+    "lint": "tslint '{__tests__,src}/**/*.ts' && npm run ts-coverage",
+    "ts-coverage": "typescript-coverage-report -p ./tsconfig.json -t 84.00"
+  },
+  "typesVersions": {
+    ">=4.0": {
+      "*": [
+        "./lib-esm/index.d.ts"
+      ],
+      "pinpoint": [
+        "./lib-esm/providers/pinpoint/AmazonLocationServiceProvider.d.ts"
+      ]
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/aws-amplify/amplify-js.git"
+  },
+  "author": "Amazon Web Services",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/aws/aws-amplify/issues"
+  },
+  "homepage": "https://aws-amplify.github.io/",
+  "files": [
+    "lib",
+    "lib-esm",
+    "src"
+  ],
+  "dependencies": {
+    "@aws-sdk/client-location": "3.398.0",
+    "@turf/boolean-clockwise": "6.5.0",
+    "camelcase-keys": "6.2.2",
+    "tslib": "^2.5.0"
+  },
+  "peerDependencies": {
+    "@aws-amplify/core": "6.0.1-console-preview.67f944e.0+67f944e"
+  },
+  "devDependencies": {
+    "@aws-amplify/core": "6.0.1-console-preview.67f944e.0+67f944e",
+    "typescript": "5.0.2"
+  },
+  "size-limit": [
+    {
+      "name": "Geo (top-level class)",
+      "path": "./lib-esm/index.js",
+      "import": "{ Amplify, Geo }",
+      "limit": "52.12 kB"
+    }
+  ],
+  "jest": {
+    "globals": {
+      "ts-jest": {
+        "diagnostics": true,
+        "tsConfig": {
+          "lib": [
+            "es5",
+            "es2015",
+            "dom",
+            "esnext.asynciterable",
+            "es2019.object"
+          ],
+          "allowJs": true,
+          "noEmitOnError": false,
+          "esModuleInterop": true,
+          "downlevelIteration": true
+        }
+      }
+    },
+    "transform": {
+      "^.+\\.(js|jsx|ts|tsx)$": "ts-jest"
+    },
+    "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(tsx?|jsx?)$",
+    "testPathIgnorePatterns": [
+      "__tests__/model.ts",
+      "__tests__/schema.ts",
+      "__tests__/helpers.ts",
+      "__tests__/testData.ts",
+      "__tests__/testUtils.ts"
+    ],
+    "moduleFileExtensions": [
+      "ts",
+      "tsx",
+      "js",
+      "json",
+      "jsx"
+    ],
+    "testEnvironment": "jsdom",
+    "testURL": "http://localhost/",
+    "coverageThreshold": {
+      "global": {
+        "branches": 0,
+        "functions": 0,
+        "lines": 0,
+        "statements": 0
+      }
+    },
+    "coveragePathIgnorePatterns": [
+      "node_modules",
+      "dist",
+      "lib",
+      "lib-esm"
+    ]
+  },
+  "gitHead": "67f944e08acb70d5edf6743f5d23a048db1a57ae"
 }

package/src/Geo.ts

@@ -1,11 +1,8 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import {
-	Amplify,
-	ConsoleLogger as Logger,
-	parseAWSExports,
-} from '@aws-amplify/core';
-import { AmazonLocationServiceProvider } from './Providers/AmazonLocationServiceProvider';
+import { Amplify } from '@aws-amplify/core';
+import { ConsoleLogger as Logger } from '@aws-amplify/core/internals/utils';
+import { AmazonLocationServiceProvider } from './providers/location-service/AmazonLocationServiceProvider';
 
 import { validateCoordinates } from './util';
 
@@ -42,6 +39,15 @@ export class GeoClass {
 	constructor() {
 		this._config = {};
 		this._pluggables = [];
+
+		const amplifyConfig = Amplify.getConfig() ?? {};
+		this._config = Object.assign({}, this._config, amplifyConfig.Geo);
+
+		const locationProvider = new AmazonLocationServiceProvider(
+			amplifyConfig.Geo
+		);
+		this._pluggables.push(locationProvider);
+
 		logger.debug('Geo Options', this._config);
 	}
 
@@ -60,11 +66,6 @@ export class GeoClass {
 	public addPluggable(pluggable: GeoProvider) {
 		if (pluggable && pluggable.getCategory() === 'Geo') {
 			this._pluggables.push(pluggable);
-			const config = pluggable.configure(
-				this._config[pluggable.getProviderName()]
-			);
-
-			return config;
 		}
 	}
 
@@ -93,29 +94,6 @@ export class GeoClass {
 		return;
 	}
 
-	/**
-	 * Configure Geo
-	 * @param {Object} config - Configuration object for Geo
-	 * @return {Object} - Current configuration
-	 */
-	configure(config?) {
-		logger.debug('configure Geo');
-
-		if (!config) return this._config;
-
-		const amplifyConfig = parseAWSExports(config);
-		this._config = Object.assign({}, this._config, amplifyConfig.Geo, config);
-
-		this._pluggables.forEach(pluggable => {
-			pluggable.configure(this._config[pluggable.getProviderName()]);
-		});
-
-		if (this._pluggables.length === 0) {
-			this.addPluggable(new AmazonLocationServiceProvider());
-		}
-		return this._config;
-	}
-
 	/**
 	 * Get the map resources that are currently available through the provider
 	 * @param {string} provider
@@ -331,4 +309,3 @@ export class GeoClass {
 }
 
 export const Geo = new GeoClass();
-Amplify.register(Geo);

package/src/{Providers → providers/location-service}/AmazonLocationServiceProvider.ts

@@ -2,11 +2,11 @@
 // SPDX-License-Identifier: Apache-2.0
 import camelcaseKeys from 'camelcase-keys';
 
+import { Amplify, fetchAuthSession } from '@aws-amplify/core';
 import {
 	ConsoleLogger as Logger,
-	Credentials,
 	getAmplifyUserAgentObject,
-} from '@aws-amplify/core';
+} from '@aws-amplify/core/internals/utils';
 import {
 	Place as PlaceResult,
 	LocationClient,
@@ -38,7 +38,7 @@ import {
 	mapSearchOptions,
 	validateGeofenceId,
 	validateGeofencesInput,
-} from '../util';
+} from '../../util';
 
 import {
 	GeoConfig,
@@ -60,7 +60,8 @@ import {
 	GeofencePolygon,
 	AmazonLocationServiceDeleteGeofencesResults,
 	searchByPlaceIdOptions,
-} from '../types';
+	AmazonLocationServiceBatchGeofenceErrorMessages,
+} from '../../types';
 
 const logger = new Logger('AmazonLocationServiceProvider');
 
@@ -72,6 +73,7 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 	 * @private
 	 */
 	private _config;
+	private _credentials;
 
 	/**
 	 * Initialize Geo with AWS configurations
@@ -98,18 +100,6 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		return AmazonLocationServiceProvider.PROVIDER_NAME;
 	}
 
-	/**
-	 * Configure Geo part with aws configuration
-	 * @param {Object} config - Configuration of the Geo
-	 * @return {Object} - Current configuration
-	 */
-	public configure(config?): object {
-		logger.debug('configure Amazon Location Service Provider', config);
-		if (!config) return this._config;
-		this._config = Object.assign({}, this._config, config);
-		return this._config;
-	}
-
 	/**
 	 * Get the map resources that are currently available through the provider
 	 * @returns {AmazonLocationServiceMapStyle[]}- Array of available map resources
@@ -179,7 +169,7 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		}
 
 		const client = new LocationClient({
-			credentials: this._config.credentials,
+			credentials: this._credentials,
 			region: this._config.region,
 			customUserAgent: getAmplifyUserAgentObject(),
 		});
@@ -203,7 +193,7 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		);
 		const results: Place[] = camelcaseKeys(PascalResults, {
 			deep: true,
-		}) as undefined as Place[];
+		}) as unknown as Place[];
 
 		return results;
 	}
@@ -245,7 +235,7 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		}
 
 		const client = new LocationClient({
-			credentials: this._config.credentials,
+			credentials: this._credentials,
 			region: this._config.region,
 			customUserAgent: getAmplifyUserAgentObject(),
 		});
@@ -293,7 +283,7 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		this._verifyPlaceId(placeId);
 
 		const client = new LocationClient({
-			credentials: this._config.credentials,
+			credentials: this._credentials,
 			region: this._config.region,
 			customUserAgent: getAmplifyUserAgentObject(),
 		});
@@ -351,7 +341,7 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		}
 
 		const client = new LocationClient({
-			credentials: this._config.credentials,
+			credentials: this._credentials,
 			region: this._config.region,
 			customUserAgent: getAmplifyUserAgentObject(),
 		});
@@ -448,10 +438,10 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 					// If the API call fails, add the geofences to the errors array and move to next batch
 					batch.forEach(geofence => {
 						results.errors.push({
-							geofenceId: geofence.GeofenceId,
+							geofenceId: geofence.GeofenceId!,
 							error: {
 								code: 'APIConnectionError',
-								message: error.message,
+								message: (error as Error).message,
 							},
 						});
 					});
@@ -459,27 +449,25 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 				}
 
 				// Push all successes to results
-				response.Successes.forEach(success => {
+				response.Successes?.forEach(success => {
 					const { GeofenceId, CreateTime, UpdateTime } = success;
 					results.successes.push({
-						geofenceId: GeofenceId,
+						geofenceId: GeofenceId!,
 						createTime: CreateTime,
 						updateTime: UpdateTime,
 					});
 				});
 
 				// Push all errors to results
-				response.Errors.forEach(error => {
-					const {
-						Error: { Code, Message },
-						GeofenceId,
-					} = error;
+				response.Errors?.forEach(error => {
+					const { Error, GeofenceId } = error;
+					const { Code, Message } = Error!;
 					results.errors.push({
 						error: {
-							code: Code,
-							message: Message,
+							code: Code!,
+							message: Message!,
 						},
-						geofenceId: GeofenceId,
+						geofenceId: GeofenceId!,
 					});
 				});
 			})
@@ -515,7 +503,7 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 
 		// Create Amazon Location Service Client
 		const client = new LocationClient({
-			credentials: this._config.credentials,
+			credentials: this._credentials,
 			region: this._config.region,
 			customUserAgent: getAmplifyUserAgentObject(),
 		});
@@ -541,9 +529,9 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		const { GeofenceId, CreateTime, UpdateTime, Status, Geometry } = response;
 		const geofence: AmazonLocationServiceGeofence = {
 			createTime: CreateTime,
-			geofenceId: GeofenceId,
+			geofenceId: GeofenceId!,
 			geometry: {
-				polygon: Geometry.Polygon as GeofencePolygon,
+				polygon: Geometry!.Polygon as GeofencePolygon,
 			},
 			status: Status as AmazonLocationServiceGeofenceStatus,
 			updateTime: UpdateTime,
@@ -577,7 +565,7 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 
 		// Create Amazon Location Service Client
 		const client = new LocationClient({
-			credentials: this._config.credentials,
+			credentials: this._credentials,
 			region: this._config.region,
 			customUserAgent: getAmplifyUserAgentObject(),
 		});
@@ -607,21 +595,15 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		const { NextToken, Entries } = response;
 
 		const results: ListGeofenceResults = {
-			entries: Entries.map(
-				({
-					GeofenceId,
-					CreateTime,
-					UpdateTime,
-					Status,
-					Geometry: { Polygon },
-				}) => {
+			entries: Entries!.map(
+				({ GeofenceId, CreateTime, UpdateTime, Status, Geometry }) => {
 					return {
-						geofenceId: GeofenceId,
+						geofenceId: GeofenceId!,
 						createTime: CreateTime,
 						updateTime: UpdateTime,
 						status: Status,
 						geometry: {
-							polygon: Polygon as GeofencePolygon,
+							polygon: Geometry!.Polygon as GeofencePolygon,
 						},
 					};
 				}
@@ -693,8 +675,10 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 						const errorObject = {
 							geofenceId,
 							error: {
-								code: error.message,
-								message: error.message,
+								code: (error as Error)
+									.message as AmazonLocationServiceBatchGeofenceErrorMessages,
+								message: (error as Error)
+									.message as AmazonLocationServiceBatchGeofenceErrorMessages,
 							},
 						};
 						results.errors.push(errorObject);
@@ -718,11 +702,13 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 	 */
 	private async _ensureCredentials(): Promise<boolean> {
 		try {
-			const credentials = await Credentials.get();
+			const credentials = (await fetchAuthSession()).credentials;
 			if (!credentials) return false;
-			const cred = Credentials.shear(credentials);
-			logger.debug('Set credentials for storage. Credentials are:', cred);
-			this._config.credentials = cred;
+			logger.debug(
+				'Set credentials for storage. Credentials are:',
+				credentials
+			);
+			this._credentials = credentials;
 			return true;
 		} catch (error) {
 			logger.debug('Ensure credentials error. Credentials are:', error);
@@ -730,7 +716,18 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		}
 	}
 
+	private _refreshConfig() {
+		this._config = Amplify.getConfig().Geo?.LocationService;
+		if (!this._config) {
+			const errorString =
+				"No Geo configuration found in amplify config, run 'amplify add geo' to create one and run `amplify push` after";
+			logger.debug(errorString);
+			throw new Error(errorString);
+		}
+	}
+
 	private _verifyMapResources() {
+		this._refreshConfig();
 		if (!this._config.maps) {
 			const errorString =
 				"No map resources found in amplify config, run 'amplify add geo' to create one and run `amplify push` after";
@@ -746,8 +743,9 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 	}
 
 	private _verifySearchIndex(optionalSearchIndex?: string) {
+		this._refreshConfig();
 		if (
-			(!this._config.search_indices || !this._config.search_indices.default) &&
+			(!this._config.searchIndices || !this._config.searchIndices.default) &&
 			!optionalSearchIndex
 		) {
 			const errorString =
@@ -758,6 +756,7 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 	}
 
 	private _verifyGeofenceCollections(optionalGeofenceCollectionName?: string) {
+		this._refreshConfig();
 		if (
 			(!this._config.geofenceCollections ||
 				!this._config.geofenceCollections.default) &&
@@ -782,7 +781,7 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		};
 
 		const client = new LocationClient({
-			credentials: this._config.credentials,
+			credentials: this._credentials,
 			region: this._config.region,
 			customUserAgent: getAmplifyUserAgentObject(),
 		});
@@ -809,7 +808,7 @@ export class AmazonLocationServiceProvider implements GeoProvider {
 		};
 
 		const client = new LocationClient({
-			credentials: this._config.credentials,
+			credentials: this._credentials,
 			region: this._config.region,
 			customUserAgent: getAmplifyUserAgentObject(),
 		});

package/src/types/Geo.ts

@@ -1,23 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 // configuration shape for the Geo class
-export interface GeoConfig {
-	region?: string;
-	AmazonLocationService?: {
-		maps?: {
-			items: {};
-			default: string;
-		};
-		search_indices?: {
-			items: string[];
-			default: string;
-		};
-		geofenceCollections?: {
-			items: string[];
-			default: string;
-		};
-	};
-}
+export { GeoConfig } from '@aws-amplify/core';
 
 // Data held about maps in aws-exports
 export interface MapStyle {

package/src/types/Provider.ts

@@ -25,9 +25,6 @@ export interface GeoProvider {
 	// get provider name
 	getProviderName(): string;
 
-	// configure your provider
-	configure(config: object): object;
-
 	// get the available map resources
 	getAvailableMaps(): MapStyle[];