@aws-amplify/analytics 7.0.1-console-preview.7919075.0 → 7.0.1-console-preview.5dc0b68.0

package/{lib/types/Analytics.d.ts → lib-esm/types/analytics.d.ts}

@@ -56,11 +56,3 @@ export interface AutoTrackEventOpts {
     provider?: string;
     attributes?: AutoTrackAttributes;
 }
-export interface AnalyticsEvent {
-    name: string;
-    attributes?: EventAttributes;
-    metrics?: EventMetrics;
-    immediate?: boolean;
-}
-export { PersonalizeAnalyticsEvent } from './providers/AmazonPersonalizeProvider';
-export { KinesisAnalyticsEvent } from './providers/AWSKinesisProvider';

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

@@ -1,3 +1 @@
-export * from './Analytics';
-export * from './Provider';
-export * from './providers';
+export * from './analytics';

package/lib-esm/types/index.js

@@ -1,5 +1,3 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-export * from './Analytics';
-export * from './Provider';
-export * from './providers';
+export * from './analytics';

package/lib-esm/utils/{UserAgent.d.ts → userAgent.d.ts}

@@ -1,4 +1,4 @@
-import { AnalyticsAction } from '@aws-amplify/core';
+import { AnalyticsAction } from '@aws-amplify/core/internals/utils';
 import { UserAgent } from '@aws-sdk/types';
 export declare function getAnalyticsUserAgent(action: AnalyticsAction): UserAgent;
 export declare function getAnalyticsUserAgentString(action: AnalyticsAction): string;

package/lib-esm/utils/{UserAgent.js → userAgent.js}

@@ -1,6 +1,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { Category, getAmplifyUserAgentObject, getAmplifyUserAgent, } from '@aws-amplify/core';
+import { Category, getAmplifyUserAgentObject, getAmplifyUserAgent, } from '@aws-amplify/core/internals/utils';
 export function getAnalyticsUserAgent(action) {
     return getAmplifyUserAgentObject({
         category: Category.Analytics,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/analytics",
-  "version": "7.0.1-console-preview.7919075.0+7919075",
+  "version": "7.0.1-console-preview.5dc0b68.0+5dc0b68",
   "description": "Analytics category of aws-amplify",
   "main": "./lib/index.js",
   "module": "./lib-esm/index.js",
@@ -15,7 +15,6 @@
   "scripts": {
     "test": "npm run lint && jest -w 1 --coverage",
     "test:watch": "tslint 'src/**/*.ts' && jest -w 1 --watch",
-    "test:size": "size-limit",
     "build-with-test": "npm run clean && npm test && tsc && webpack",
     "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",
@@ -26,12 +25,9 @@
     "clean:size": "rimraf dual-publish-tmp tmp*",
     "format": "echo \"Not implemented\"",
     "lint": "tslint 'src/**/*.ts' && npm run ts-coverage",
-    "ts-coverage": "typescript-coverage-report -p ./tsconfig.json -t 72.5"
-  },
-  "react-native": {
-    "./lib/index": "./lib-esm/index.js",
-    "./lib-esm/trackers": "./lib-esm/trackers/reactnative.js"
+    "ts-coverage": "typescript-coverage-report -p ./tsconfig.json -t 71.4"
   },
+  "react-native": "./lib-esm/index.js",
   "typesVersions": {
     ">=3.8": {
       "*": [
@@ -69,39 +65,22 @@
     "lib",
     "lib-esm",
     "src",
-    "**/package.json"
+    "pinpoint"
   ],
   "dependencies": {
-    "@aws-sdk/client-firehose": "3.388.0",
-    "@aws-sdk/client-kinesis": "3.388.0",
-    "@aws-sdk/client-personalize-events": "3.388.0",
-    "@aws-sdk/util-utf8-browser": "3.259.0",
     "lodash": "^4.17.20",
     "tslib": "^2.5.0",
     "uuid": "^9.0.0"
   },
   "peerDependencies": {
-    "@aws-amplify/core": "6.0.1-console-preview.7919075.0+7919075"
+    "@aws-amplify/core": "6.0.1-console-preview.5dc0b68.0+5dc0b68"
   },
   "devDependencies": {
-    "@aws-amplify/core": "6.0.1-console-preview.7919075.0+7919075",
+    "@aws-amplify/core": "6.0.1-console-preview.5dc0b68.0+5dc0b68",
     "@aws-sdk/types": "3.387.0",
+    "@types/uuid": "^9.0.0",
     "typescript": "5.0.2"
   },
-  "size-limit": [
-    {
-      "name": "Analytics (Pinpoint)",
-      "path": "./lib-esm/index.js",
-      "import": "{ Amplify, Analytics, AWSPinpointProvider }",
-      "limit": "31.57 kB"
-    },
-    {
-      "name": "Analytics (Kinesis)",
-      "path": "./lib-esm/index.js",
-      "import": "{ Amplify, Analytics, AWSKinesisProvider }",
-      "limit": "60.82 kB"
-    }
-  ],
   "jest": {
     "globals": {
       "ts-jest": {
@@ -115,6 +94,9 @@
     "transform": {
       "^.+\\.(js|jsx|ts|tsx)$": "ts-jest"
     },
+    "testPathIgnorePatterns": [
+      "/testUtils/"
+    ],
     "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(tsx?|jsx?)$",
     "moduleFileExtensions": [
       "ts",
@@ -143,5 +125,5 @@
       "<rootDir>/src/setupTests.ts"
     ]
   },
-  "gitHead": "79190755720763a764aa7650655016a6d7b41a11"
+  "gitHead": "5dc0b68f9d56006a92abc29aa4e7d8142e083387"
 }

package/src/errors/AnalyticsError.ts

@@ -0,0 +1,18 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { AmplifyError, ErrorParams } from '@aws-amplify/core/internals/utils';
+
+/**
+ * @internal
+ */
+export class AnalyticsError extends AmplifyError {
+	constructor(params: ErrorParams) {
+		super(params);
+
+		// Hack for making the custom error class work when transpiled to es5
+		// TODO: Delete the following 2 lines after we change the build target to >= es2015
+		this.constructor = AnalyticsError;
+		Object.setPrototypeOf(this, AnalyticsError.prototype);
+	}
+}

package/src/errors/assertValidationError.ts

@@ -0,0 +1,19 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { AnalyticsError } from './AnalyticsError';
+import { AnalyticsValidationErrorCode, validationErrorMap } from './validation';
+
+/**
+ * @internal
+ */
+export function assertValidationError(
+	assertion: boolean,
+	name: AnalyticsValidationErrorCode
+): asserts assertion {
+	const { message, recoverySuggestion } = validationErrorMap[name];
+
+	if (!assertion) {
+		throw new AnalyticsError({ name, message, recoverySuggestion });
+	}
+}

package/src/errors/index.ts

@@ -0,0 +1,6 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { AnalyticsError } from './AnalyticsError';
+export { assertValidationError } from './assertValidationError';
+export { AnalyticsValidationErrorCode, validationErrorMap } from './validation';

package/src/errors/validation.ts

@@ -0,0 +1,31 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { AmplifyErrorMap } from '@aws-amplify/core/internals/utils';
+
+export enum AnalyticsValidationErrorCode {
+	NoAppId = 'NoAppId',
+	NoCredentials = 'NoCredentials',
+	NoEvent = 'NoEvent',
+	NoEventName = 'NoEventName',
+	NoRegion = 'NoRegion',
+}
+
+export const validationErrorMap: AmplifyErrorMap<AnalyticsValidationErrorCode> =
+	{
+		[AnalyticsValidationErrorCode.NoAppId]: {
+			message: 'Missing application id.',
+		},
+		[AnalyticsValidationErrorCode.NoCredentials]: {
+			message: 'Credentials should not be empty.',
+		},
+		[AnalyticsValidationErrorCode.NoEvent]: {
+			message: 'An event is required to record.',
+		},
+		[AnalyticsValidationErrorCode.NoEventName]: {
+			message: 'Events must specify a name.',
+		},
+		[AnalyticsValidationErrorCode.NoRegion]: {
+			message: 'Missing region.',
+		},
+	};

package/src/index.ts

@@ -1,19 +1,4 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-// TODO(v6) Remove once all default provider functional APIs available
-export { Analytics } from './Analytics';
-export { AnalyticsProvider } from './types';
-export { AWSPinpointProvider } from './providers';
-
-// TODO(v6) Refactor as additional Analytics providers come online
-/*
-export {
-	AWSKinesisProvider,
-	AWSKinesisFirehoseProvider,
-	AmazonPersonalizeProvider,
-} from './providers';
-*/
-
-// Default provider types
 export * from './providers/pinpoint';

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

@@ -0,0 +1,35 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { AnalyticsAction } from '@aws-amplify/core/internals/utils';
+import { updateEndpoint } from '@aws-amplify/core/internals/providers/pinpoint';
+import { AnalyticsValidationErrorCode } from '../../../errors';
+import { getAnalyticsUserAgentString } from '../../../utils/userAgent';
+import { IdentifyUserParameters, UpdateEndpointException } from '../types';
+import { resolveConfig, resolveCredentials } from '../utils';
+
+/**
+ * Identifies the current user with Pinpoint.
+ *
+ * @param {IdentifyUserParameters} params parameters used to construct requests sent to Pinpoint's UpdateEndpoint API.
+ *
+ * @throws An {@link UpdateEndpointException} when the underlying Pinpoint service returns an error.
+ * @throws An {@link AnalyticsValidationErrorCode} when API call parameters are invalid.
+ */
+export const identifyUser = async ({
+	userId,
+	userProfile,
+}: IdentifyUserParameters): Promise<void> => {
+	const { credentials, identityId } = await resolveCredentials();
+	const { appId, region } = resolveConfig();
+	updateEndpoint({
+		appId,
+		category: 'Analytics',
+		credentials,
+		identityId,
+		region,
+		userId,
+		userProfile,
+		userAgentValue: getAnalyticsUserAgentString(AnalyticsAction.UpdateEndpoint),
+	});
+};

package/src/{utils/AppUtils.ts → providers/pinpoint/apis/index.ts}

@@ -1,7 +1,5 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-const isAppInForeground = () => {
-	return true;
-};
 
-export { isAppInForeground };
+export { record } from './record';
+export { identifyUser } from './identifyUser';

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

@@ -0,0 +1,50 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import {
+	AnalyticsAction,
+	ConsoleLogger as Logger,
+} from '@aws-amplify/core/internals/utils';
+import { record as recordCore } from '@aws-amplify/core/internals/providers/pinpoint';
+import {
+	AnalyticsValidationErrorCode,
+	assertValidationError,
+} from '../../../errors';
+import { getAnalyticsUserAgentString } from '../../../utils/userAgent';
+import { RecordParameters } from '../types/parameters';
+import { resolveConfig, resolveCredentials } from '../utils';
+
+const logger = new Logger('Analytics');
+
+/**
+ * Sends an event to Pinpoint.
+ *
+ * @param {RecordParameters} params Parameters used to construct the request.
+ *
+ * @throws An {@link AnalyticsValidationErrorCode} when there is an error in the parameters or configuration.
+ *
+ * @returns A promise that will resolve when the request is complete.
+ */
+export const record = ({ event }: RecordParameters): void => {
+	const { appId, region } = resolveConfig();
+
+	assertValidationError(!!event, AnalyticsValidationErrorCode.NoEvent);
+	assertValidationError(!!event.name, AnalyticsValidationErrorCode.NoEventName);
+
+	resolveCredentials()
+		.then(({ credentials, identityId }) => {
+			recordCore({
+				appId,
+				category: 'Analytics',
+				credentials,
+				event,
+				identityId,
+				region,
+				userAgentValue: getAnalyticsUserAgentString(AnalyticsAction.Record),
+			});
+		})
+		.catch(e => {
+			// An error occured while fetching credentials or persisting the event to the buffer
+			logger.warn('Failed to record event.', e);
+		});
+};

package/src/providers/pinpoint/index.ts

@@ -1,6 +1,4 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-// TODO(v6): Export Pinpoint functional APIs & types
-// Mock function to make exports work
-export const record = async () => {};
+export * from './apis';

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

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

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

@@ -0,0 +1,24 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { UserProfile } from '@aws-amplify/core';
+import { PinpointAnalyticsEvent } from '@aws-amplify/core/internals/providers/pinpoint';
+
+export type RecordParameters = {
+	/**
+	 * An event to send to the default Analytics provider.
+	 */
+	event: PinpointAnalyticsEvent;
+};
+
+export type IdentifyUserParameters = {
+	/**
+	 * A User ID associated to the current device.
+	 */
+	userId: string;
+
+	/**
+	 * Additional information about the user and their device.
+	 */
+	userProfile: UserProfile;
+};

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

@@ -0,0 +1,5 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { resolveConfig } from './resolveConfig';
+export { resolveCredentials } from './resolveCredentials';

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

@@ -0,0 +1,18 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { Amplify } from '@aws-amplify/core';
+import {
+	AnalyticsValidationErrorCode,
+	assertValidationError,
+} from '../../../errors';
+
+/**
+ * @internal
+ */
+export const resolveConfig = () => {
+	const { appId, region } = Amplify.getConfig().Analytics?.AWSPinpoint ?? {};
+	assertValidationError(!!appId, AnalyticsValidationErrorCode.NoAppId);
+	assertValidationError(!!region, AnalyticsValidationErrorCode.NoRegion);
+	return { appId, region };
+};

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

@@ -0,0 +1,20 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { fetchAuthSession } from '@aws-amplify/core';
+import {
+	AnalyticsValidationErrorCode,
+	assertValidationError,
+} from '../../../errors';
+
+/**
+ * @internal
+ */
+export const resolveCredentials = async () => {
+	const { credentials, identityId } = await fetchAuthSession();
+	assertValidationError(
+		!!credentials,
+		AnalyticsValidationErrorCode.NoCredentials
+	);
+	return { credentials, identityId };
+};

package/src/types/{Analytics.ts → analytics.ts}

@@ -1,6 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { ICredentials } from '@aws-amplify/core';
+
 /**
  * Analytics instance options
  */
@@ -75,13 +76,3 @@ export interface AutoTrackEventOpts {
 	provider?: string;
 	attributes?: AutoTrackAttributes;
 }
-
-export interface AnalyticsEvent {
-	name: string;
-	attributes?: EventAttributes;
-	metrics?: EventMetrics;
-	immediate?: boolean;
-}
-
-export { PersonalizeAnalyticsEvent } from './providers/AmazonPersonalizeProvider';
-export { KinesisAnalyticsEvent } from './providers/AWSKinesisProvider';

package/src/types/index.ts

@@ -1,6 +1,4 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-export * from './Analytics';
-export * from './Provider';
-export * from './providers';
+export * from './analytics';

package/src/utils/{UserAgent.ts → userAgent.ts}

@@ -5,7 +5,7 @@ import {
 	Category,
 	getAmplifyUserAgentObject,
 	getAmplifyUserAgent,
-} from '@aws-amplify/core';
+} from '@aws-amplify/core/internals/utils';
 import { UserAgent } from '@aws-sdk/types';
 
 export function getAnalyticsUserAgent(action: AnalyticsAction): UserAgent {

package/lib/Analytics.d.ts

@@ -1,87 +0,0 @@
-import { AnalyticsProvider, AnalyticsEvent, AutoTrackSessionOpts, AutoTrackPageViewOpts, AutoTrackEventOpts, PersonalizeAnalyticsEvent, KinesisAnalyticsEvent } from './types';
-import { PageViewTracker, EventTracker, SessionTracker } from './trackers';
-declare const trackers: {
-    pageView: typeof PageViewTracker;
-    event: typeof EventTracker;
-    session: typeof SessionTracker;
-};
-type TrackerTypes = keyof typeof trackers;
-/**
- * Provide mobile analytics client functions
- */
-export declare class AnalyticsClass {
-    private _config;
-    private _pluggables;
-    private _disabled;
-    private _trackers;
-    /**
-     * Initialize Analtyics
-     * @param config - Configuration of the Analytics
-     */
-    constructor();
-    getModuleName(): string;
-    /**
-     * configure Analytics
-     * @param {Object} config - Configuration of the Analytics
-     */
-    configure(config?: any): any;
-    /**
-     * add plugin into Analytics category
-     * @param pluggable - an instance of the plugin
-     */
-    addPluggable(pluggable: AnalyticsProvider): any;
-    /**
-     * Get the plugin object
-     * @param providerName - the name of the provider to be removed
-     */
-    getPluggable(providerName: string): AnalyticsProvider;
-    /**
-     * Remove the plugin object
-     * @param providerName - the name of the provider to be removed
-     */
-    removePluggable(providerName: string): void;
-    /**
-     * stop sending events
-     */
-    disable(): void;
-    /**
-     * start sending events
-     */
-    enable(): void;
-    /**
-     * Record Session start
-     * @param [provider] - name of the provider.
-     * @return - A promise which resolves if buffer doesn't overflow
-     */
-    startSession(provider?: string): Promise<unknown>;
-    /**
-     * Record Session stop
-     * @param [provider] - name of the provider.
-     * @return - A promise which resolves if buffer doesn't overflow
-     */
-    stopSession(provider?: string): Promise<unknown>;
-    /**
-     * Record one analytic event and send it to Pinpoint
-     * @param event - An object with the name of the event, attributes of the event and event metrics.
-     * @param [provider] - name of the provider.
-     */
-    record(event: AnalyticsEvent | PersonalizeAnalyticsEvent | KinesisAnalyticsEvent, provider?: string): Promise<unknown>;
-    updateEndpoint(attrs: {
-        [key: string]: any;
-    }, provider?: string): Promise<unknown>;
-    private _sendEvent;
-    /**
-     * Enable or disable auto tracking
-     * @param trackerType - The type of tracker to activate.
-     * @param [opts] - Auto tracking options.
-     */
-    autoTrack(trackerType: 'session', opts: AutoTrackSessionOpts): any;
-    autoTrack(trackerType: 'pageView', opts: AutoTrackPageViewOpts): any;
-    autoTrack(trackerType: 'event', opts: AutoTrackEventOpts): any;
-    autoTrack(trackerType: TrackerTypes, opts: {
-        provider: string;
-        [key: string]: any;
-    }): any;
-}
-export declare const Analytics: AnalyticsClass;
-export {};