@aws-amplify/core 6.0.1-console-preview.5a31ca1.0 → 6.0.1-console-preview.8d88eef.0

package/lib-esm/types/errors.d.ts

@@ -1,4 +1,5 @@
 export declare enum AmplifyErrorCode {
+    NoEndpointId = "NoEndpointId",
     PlatformNotSupported = "PlatformNotSupported",
     Unknown = "Unknown"
 }

package/lib-esm/types/errors.js

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 export var AmplifyErrorCode;
 (function (AmplifyErrorCode) {
+    AmplifyErrorCode["NoEndpointId"] = "NoEndpointId";
     AmplifyErrorCode["PlatformNotSupported"] = "PlatformNotSupported";
     AmplifyErrorCode["Unknown"] = "Unknown";
 })(AmplifyErrorCode || (AmplifyErrorCode = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@aws-amplify/core",
-	"version": "6.0.1-console-preview.5a31ca1.0+5a31ca1",
+	"version": "6.0.1-console-preview.8d88eef.0+8d88eef",
 	"description": "Core category of aws-amplify",
 	"main": "./lib/index.js",
 	"module": "./lib-esm/index.js",
@@ -64,7 +64,7 @@
 		"uuid": "^9.0.0"
 	},
 	"devDependencies": {
-		"@aws-amplify/react-native": "1.0.1-console-preview.5a31ca1.0+5a31ca1",
+		"@aws-amplify/react-native": "1.0.1-console-preview.8d88eef.0+8d88eef",
 		"@types/js-cookie": "3.0.2",
 		"@types/uuid": "^9.0.0",
 		"find": "^0.2.7",
@@ -169,5 +169,5 @@
 			"lib-esm"
 		]
 	},
-	"gitHead": "5a31ca110861fbb0762e9c4d817064acd474f83f"
+	"gitHead": "8d88eef4137cef4fbe03d7d3683b5bec59feb7b8"
 }

package/src/Platform/types.ts

@@ -83,7 +83,14 @@ export enum DataStoreAction {
 	GraphQl = '2',
 }
 export enum GeoAction {
-	None = '0',
+	SearchByText = '0',
+	SearchByCoordinates = '1',
+	SearchForSuggestions = '2',
+	SearchByPlaceId = '3',
+	SaveGeofences = '4',
+	GetGeofence = '5',
+	ListGeofences = '6',
+	DeleteGeofences = '7',
 }
 export enum InAppMessagingAction {
 	SyncMessages = '1',
@@ -102,7 +109,8 @@ export enum PubSubAction {
 	Subscribe = '1',
 }
 export enum PushNotificationAction {
-	None = '0',
+	InitializePushNotifications = '1',
+	IdentifyUser = '2',
 }
 export enum StorageAction {
 	UploadData = '1',
@@ -166,31 +174,32 @@ export type CustomUserAgentStateMap = Record<string, CategoryUserAgentStateMap>;
 
 export type AdditionalDetails = [string, string?][];
 
-type StorageUserAgentInput = {
+export type StorageUserAgentInput = {
 	category: Category.Storage;
 	apis: StorageAction[];
+	additionalDetails: AdditionalDetails;
 };
 
-type AuthUserAgentInput = {
+export type AuthUserAgentInput = {
 	category: Category.Auth;
 	apis: AuthAction[];
+	additionalDetails: AdditionalDetails;
 };
 
-type InAppMessagingUserAgentInput = {
+export type InAppMessagingUserAgentInput = {
 	category: Category.InAppMessaging;
 	apis: InAppMessagingAction[];
+	additionalDetails: AdditionalDetails;
 };
 
-type GeoUserAgentInput = {
+export type GeoUserAgentInput = {
 	category: Category.Geo;
 	apis: GeoAction[];
+	additionalDetails: AdditionalDetails;
 };
 
-export type SetCustomUserAgentInput = (
+export type SetCustomUserAgentInput =
 	| StorageUserAgentInput
 	| AuthUserAgentInput
 	| InAppMessagingUserAgentInput
-	| GeoUserAgentInput
-) & {
-	additionalDetails: AdditionalDetails;
-};
+	| GeoUserAgentInput;

package/src/Platform/version.ts

@@ -1,2 +1,2 @@
 // generated by genversion
-export const version = '6.0.1-console-preview.5a31ca1.0+5a31ca1';
+export const version = '6.0.1-console-preview.8d88eef.0+8d88eef';

package/src/ServiceWorker/ServiceWorker.ts

@@ -3,9 +3,11 @@
 
 import { ConsoleLogger as Logger } from '../Logger';
 import { isBrowser } from '../utils';
-import { Amplify } from '../Amplify';
 import { AmplifyError } from '../errors';
 import { assert, ServiceWorkerErrorCode } from './errorHelpers';
+import { record } from '../providers/pinpoint';
+import { Amplify, fetchAuthSession } from '../singleton';
+
 /**
  * Provides a means to registering a service worker in the browser
  * and communicating with it via postMessage events.
@@ -205,15 +207,25 @@ export class ServiceWorkerClass {
 	 * https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorker/state
 	 **/
 	_setupListeners() {
-		this.serviceWorker.addEventListener('statechange', event => {
+		this.serviceWorker.addEventListener('statechange', async event => {
 			const currentState = this.serviceWorker.state;
 			this._logger.debug(`ServiceWorker statechange: ${currentState}`);
-			Amplify.Analytics;
-			if (isAmplifyWithAnalytics(Amplify)) {
-				(Amplify as AmplifyWithAnalytics).Analytics.record({
-					name: 'ServiceWorker',
-					attributes: {
-						state: currentState,
+
+			const { appId, region } = Amplify.getConfig().Analytics?.Pinpoint ?? {};
+			const { credentials } = await fetchAuthSession();
+
+			if (appId && region && credentials) {
+				// Pinpoint is configured, record an event
+				record({
+					appId,
+					region,
+					category: 'Core',
+					credentials,
+					event: {
+						name: 'ServiceWorker',
+						attributes: {
+							state: currentState,
+						},
 					},
 				});
 			}
@@ -223,12 +235,3 @@ export class ServiceWorkerClass {
 		});
 	}
 }
-
-type AmplifyWithAnalytics = {
-	Analytics: {
-		record: Function;
-	};
-};
-function isAmplifyWithAnalytics(amplify: any): amplify is AmplifyWithAnalytics {
-	return amplify.Analytics && typeof amplify.Analytics.record === 'function';
-}

package/src/ServiceWorker/index.ts

@@ -1,16 +1,4 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-/**
- * Copyright 2018 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.
- */
 
 export { ServiceWorkerClass as ServiceWorker } from './ServiceWorker';

package/src/errors/errorHelpers.ts

@@ -0,0 +1,20 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { createAssertionFunction } from './createAssertionFunction';
+import { AmplifyErrorCode, AmplifyErrorMap, AssertionFunction } from '../types';
+
+const amplifyErrorMap: AmplifyErrorMap<AmplifyErrorCode> = {
+	[AmplifyErrorCode.NoEndpointId]: {
+		message: 'Endpoint ID was not found and was unable to be created.',
+	},
+	[AmplifyErrorCode.PlatformNotSupported]: {
+		message: 'Function not supported on current platform.',
+	},
+	[AmplifyErrorCode.Unknown]: {
+		message: 'An unknown error occurred.',
+	},
+};
+
+export const assert: AssertionFunction<AmplifyErrorCode> =
+	createAssertionFunction(amplifyErrorMap);

package/src/errors/index.ts

@@ -4,3 +4,4 @@
 export { AmplifyError } from './AmplifyError';
 export { createAssertionFunction } from './createAssertionFunction';
 export { PlatformNotSupportedError } from './PlatformNotSupportedError';
+export { assert } from './errorHelpers';

package/src/index.ts

@@ -65,3 +65,9 @@ export { Cache } from './Cache';
 
 // Internationalization utilities
 export { I18n } from './I18n';
+
+// Logging utilities
+export { ConsoleLogger } from './Logger';
+
+// Service worker
+export { ServiceWorker } from './ServiceWorker';

package/src/libraryUtils.ts

@@ -40,12 +40,9 @@ export {
 	JwtPayload,
 	AuthStandardAttributeKey,
 	AuthVerifiableAttributeKey,
-	AWSCredentials
+	AWSCredentials,
 } from './singleton/Auth/types';
 
-// Logging utilities
-export { ConsoleLogger, ConsoleLogger as Logger } from './Logger';
-
 // Platform & user-agent utilities
 export {
 	Platform,
@@ -68,16 +65,14 @@ export {
 	PushNotificationAction,
 	StorageAction,
 	SetCustomUserAgentInput,
+	StorageUserAgentInput,
+	AuthUserAgentInput,
+	InAppMessagingUserAgentInput,
+	GeoUserAgentInput,
 } from './Platform/types';
 export { setCustomUserAgent } from './Platform/customUserAgent';
 
-// Service worker
-export { ServiceWorker } from './ServiceWorker';
-
-// Other utilities & constants
-export { BackgroundProcessManager } from './BackgroundProcessManager';
-export { Mutex } from './Mutex';
-export { Reachability } from './Reachability';
+// Error handling
 export {
 	AmplifyError,
 	PlatformNotSupportedError,
@@ -90,6 +85,11 @@ export {
 	AssertionFunction,
 	ServiceError,
 } from './types';
+
+// Other utilities & constants
+export { BackgroundProcessManager } from './BackgroundProcessManager';
+export { Mutex } from './Mutex';
+export { Reachability } from './Reachability';
 export {
 	INTERNAL_AWS_APPSYNC_REALTIME_PUBSUB_PROVIDER,
 	USER_AGENT_HEADER,

package/src/parseAWSExports.ts

@@ -1,11 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { ConsoleLogger as Logger } from './Logger';
-import {
-	OAuthConfig,
-	AuthStandardAttributeKey,
-	AuthConfigUserAttributes,
-} from './singleton/Auth/types';
+import { OAuthConfig, AuthConfigUserAttributes } from './singleton/Auth/types';
 import { ResourcesConfig } from './singleton/types';
 
 const logger = new Logger('parseAWSExports');
@@ -70,15 +66,24 @@ export const parseAWSExports = (
 	}
 
 	// Notifications
-	if (Notifications) {
-		if (Notifications.InAppMessaging?.AWSPinpoint) {
-			const { appId, region } = Notifications.InAppMessaging.AWSPinpoint;
-			amplifyConfig.Notifications = {
-				InAppMessaging: {
-					Pinpoint: {
-						appId,
-						region,
-					},
+	const { InAppMessaging, Push } = Notifications ?? {};
+	if (InAppMessaging?.AWSPinpoint || Push?.AWSPinpoint) {
+		amplifyConfig.Notifications = {};
+		if (InAppMessaging?.AWSPinpoint) {
+			const { appId, region } = InAppMessaging.AWSPinpoint;
+			amplifyConfig.Notifications.InAppMessaging = {
+				Pinpoint: {
+					appId,
+					region,
+				},
+			};
+		}
+		if (Push?.AWSPinpoint) {
+			const { appId, region } = Push.AWSPinpoint;
+			amplifyConfig.Notifications.PushNotification = {
+				Pinpoint: {
+					appId,
+					region,
 				},
 			};
 		}

package/src/providers/pinpoint/apis/record.ts

@@ -3,16 +3,14 @@
 
 import { amplifyUuid } from '../../../utils/amplifyUuid';
 import { PinpointRecordInput, PinpointSession } from '../types';
-import { getEndpointId } from '../utils';
+import { resolveEndpointId } from '../utils';
 import {
 	BUFFER_SIZE,
 	FLUSH_INTERVAL,
 	FLUSH_SIZE,
 	RESEND_LIMIT,
 } from '../utils/constants';
-import { updateEndpoint } from './updateEndpoint';
 import { getEventBuffer } from '../utils/getEventBuffer';
-import { AmplifyError } from '../../../errors';
 
 // TODO(v6) Refactor when we add support for session tracking & `autoTrack`
 let session: PinpointSession;
@@ -23,6 +21,7 @@ let session: PinpointSession;
 export const record = async ({
 	appId,
 	category,
+	channelType,
 	credentials,
 	event,
 	identityId,
@@ -31,7 +30,6 @@ export const record = async ({
 }: PinpointRecordInput): Promise<void> => {
 	const timestampISOString = new Date().toISOString();
 	const eventId = amplifyUuid();
-	let endpointId = await getEndpointId(appId, category);
 
 	// Prepare event buffer if required
 	const buffer = getEventBuffer({
@@ -46,27 +44,15 @@ export const record = async ({
 		userAgentValue,
 	});
 
-	// Prepare a Pinpoint endpoint via updateEndpoint if one does not already exist, which will generate and cache an
-	// endpoint ID between calls
-	if (!endpointId) {
-		await updateEndpoint({
-			appId,
-			category,
-			credentials,
-			identityId,
-			region,
-			userAgentValue,
-		});
-
-		endpointId = await getEndpointId(appId, category);
-	}
-
-	if (!endpointId) {
-		throw new AmplifyError({
-			name: 'ENDPOINT_NOT_CREATED',
-			message: 'Endpoint was not created.',
-		});
-	}
+	const endpointId = await resolveEndpointId({
+		appId,
+		category,
+		channelType,
+		credentials,
+		identityId,
+		region,
+		userAgentValue,
+	});
 
 	// Generate session if required
 	if (!session) {

package/src/providers/pinpoint/index.ts

@@ -2,5 +2,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
 export * from './apis';
-export { PinpointAnalyticsEvent, PinpointServiceOptions } from './types';
-export { getEndpointId } from './utils';
+export {
+	PinpointAnalyticsEvent,
+	PinpointServiceOptions,
+	UpdateEndpointException,
+} from './types';
+export { resolveEndpointId } from './utils';

package/src/providers/pinpoint/types/errors.ts

@@ -0,0 +1,12 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export enum UpdateEndpointException {
+	BadRequestException = 'BadRequestException',
+	ForbiddenException = 'ForbiddenException',
+	InternalServerErrorException = 'InternalServerErrorException',
+	MethodNotAllowedException = 'MethodNotAllowedException',
+	NotFoundException = 'NotFoundException',
+	PayloadTooLargeException = 'PayloadTooLargeException',
+	TooManyRequestsException = 'TooManyRequestsException',
+}

package/src/providers/pinpoint/types/index.ts

@@ -1,4 +1,5 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
+export { UpdateEndpointException } from './errors';
 export * from './pinpoint';

package/src/providers/pinpoint/types/pinpoint.ts

@@ -6,10 +6,11 @@ import { UserProfile } from '../../../types';
 
 export type SupportedCategory =
 	| 'Analytics'
+	| 'Core'
 	| 'InAppMessaging'
 	| 'PushNotification';
 
-export type SupportedChannelType = 'APNS' | 'APNS_SANDBOX' | 'GCM' | 'IN_APP';
+type SupportedChannelType = 'APNS' | 'APNS_SANDBOX' | 'GCM' | 'IN_APP';
 
 export type PinpointProviderConfig = {
 	Pinpoint?: {
@@ -39,6 +40,7 @@ export type PinpointAnalyticsEvent = {
 type PinpointCommonParameters = {
 	appId: string;
 	category: SupportedCategory;
+	channelType?: SupportedChannelType;
 	credentials: Required<AuthSession>['credentials'];
 	identityId?: AuthSession['identityId'];
 	region: string;
@@ -47,7 +49,6 @@ type PinpointCommonParameters = {
 
 export type PinpointUpdateEndpointInput = PinpointCommonParameters &
 	PinpointServiceOptions & {
-		channelType?: SupportedChannelType;
 		userId?: string;
 		userProfile?: UserProfile;
 	};

package/src/providers/pinpoint/utils/index.ts

@@ -4,3 +4,4 @@
 export { cacheEndpointId } from './cacheEndpointId';
 export { getCacheKey } from './getCacheKey';
 export { getEndpointId } from './getEndpointId';
+export { resolveEndpointId } from './resolveEndpointId';

package/src/providers/pinpoint/utils/resolveEndpointId.ts

@@ -0,0 +1,46 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { assert } from '../../../errors';
+import { AmplifyErrorCode } from '../../../types';
+import { updateEndpoint } from '../apis';
+import { PinpointUpdateEndpointInput } from '../types';
+import { getEndpointId } from './getEndpointId';
+
+/**
+ * Resolves an endpoint id from cache or prepare via updateEndpoint if one does not already exist,
+ * which will generate and cache an endpoint id between calls.
+ *
+ * @internal
+ */
+export const resolveEndpointId = async ({
+	address,
+	appId,
+	category,
+	channelType,
+	credentials,
+	identityId,
+	region,
+	userAgentValue,
+}: PinpointUpdateEndpointInput) => {
+	let endpointId = await getEndpointId(appId, category);
+
+	if (!endpointId) {
+		await updateEndpoint({
+			address,
+			appId,
+			category,
+			channelType,
+			credentials,
+			identityId,
+			region,
+			userAgentValue,
+		});
+
+		endpointId = await getEndpointId(appId, category);
+	}
+
+	assert(!!endpointId, AmplifyErrorCode.NoEndpointId);
+
+	return endpointId;
+};

package/src/singleton/Auth/types.ts

@@ -113,12 +113,12 @@ export type AuthIdentityPoolConfig = {
 	Cognito: CognitoIdentityPoolConfig & {
 		userPoolClientId?: never;
 		userPoolId?: never;
+		userPoolEndpoint?: never;
 		loginWith?: never;
 		signUpVerificationMethod?: never;
 		userAttributes?: never;
 		mfa?: never;
 		passwordFormat?: never;
-		endpoint?: never;
 	};
 };
 
@@ -137,6 +137,7 @@ export type AuthUserPoolConfig = {
 export type CognitoUserPoolConfig = {
 	userPoolClientId: string;
 	userPoolId: string;
+	userPoolEndpoint?: string;
 	signUpVerificationMethod?: 'code' | 'link';
 	loginWith?: {
 		oauth?: OAuthConfig;
@@ -157,7 +158,6 @@ export type CognitoUserPoolConfig = {
 		requireNumbers?: boolean;
 		requireSpecialCharacters?: boolean;
 	};
-	endpoint?: string;
 };
 
 export type OAuthConfig = {

package/src/singleton/Notifications/PushNotification/types.ts

@@ -0,0 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { PinpointProviderConfig } from '../../../providers/pinpoint/types';
+
+export type PushNotificationConfig = PinpointProviderConfig;

package/src/singleton/Notifications/types.ts

@@ -2,7 +2,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { InAppMessagingConfig } from './InAppMessaging/types';
+import { PushNotificationConfig } from './PushNotification/types';
 
 export type NotificationsConfig = {
-	InAppMessaging: InAppMessagingConfig;
+	InAppMessaging?: InAppMessagingConfig;
+	PushNotification?: PushNotificationConfig;
 };

package/src/types/errors.ts

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 export enum AmplifyErrorCode {
+	NoEndpointId = 'NoEndpointId',
 	PlatformNotSupported = 'PlatformNotSupported',
 	Unknown = 'Unknown',
 }

package/lib/Amplify.d.ts

@@ -1,29 +0,0 @@
-import { ConsoleLogger as LoggerClass } from './Logger';
-export declare class AmplifyClass {
-    private _components;
-    private _config;
-    private _modules;
-    Auth: null;
-    Analytics: null;
-    API: null;
-    Credentials: null;
-    Storage: null;
-    I18n: null;
-    Cache: null;
-    PubSub: null;
-    Interactions: null;
-    Pushnotification: null;
-    UI: null;
-    XR: null;
-    Predictions: null;
-    DataStore: null;
-    Geo: null;
-    Notifications: null;
-    Logger: typeof LoggerClass;
-    ServiceWorker: null;
-    get config(): any;
-    register(comp: any): void;
-    configure(config?: any): {};
-    addPluggable(pluggable: any): void;
-}
-export declare const Amplify: AmplifyClass;