@aws-amplify/analytics 7.0.1-console-preview.67f944e.0 → 7.0.1-console-preview.0bbe168.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/analytics",
-  "version": "7.0.1-console-preview.67f944e.0+67f944e",
+  "version": "7.0.1-console-preview.0bbe168.0+0bbe168",
   "description": "Analytics category of aws-amplify",
   "main": "./lib/index.js",
   "module": "./lib-esm/index.js",
@@ -35,6 +35,9 @@
       ],
       "kinesis": [
         "./lib-esm/providers/kinesis/index.d.ts"
+      ],
+      "kinesis-firehose": [
+        "./lib-esm/providers/kinesis-firehose/index.d.ts"
       ]
     }
   },
@@ -54,6 +57,11 @@
       "import": "./lib-esm/providers/kinesis/index.js",
       "require": "./lib/providers/kinesis/index.js"
     },
+    "./kinesis-firehose": {
+      "types": "./lib-esm/providers/kinesis-firehose/index.d.ts",
+      "import": "./lib-esm/providers/kinesis-firehose/index.js",
+      "require": "./lib/providers/kinesis-firehose/index.js"
+    },
     "./package.json": "./package.json"
   },
   "repository": {
@@ -71,17 +79,19 @@
     "lib-esm",
     "src",
     "pinpoint",
-    "kinesis"
+    "kinesis",
+    "kinesis-firehose"
   ],
   "dependencies": {
     "tslib": "^2.5.0",
     "uuid": "^9.0.0"
   },
   "peerDependencies": {
-    "@aws-amplify/core": "6.0.1-console-preview.67f944e.0+67f944e"
+    "@aws-amplify/core": "6.0.1-console-preview.0bbe168.0+0bbe168"
   },
   "devDependencies": {
-    "@aws-amplify/core": "6.0.1-console-preview.67f944e.0+67f944e",
+    "@aws-amplify/core": "6.0.1-console-preview.0bbe168.0+0bbe168",
+    "@aws-sdk/client-firehose": "3.398.0",
     "@aws-sdk/client-kinesis": "3.398.0",
     "@aws-sdk/types": "3.398.0",
     "@types/uuid": "^9.0.0",
@@ -131,5 +141,5 @@
       "<rootDir>/src/setupTests.ts"
     ]
   },
-  "gitHead": "67f944e08acb70d5edf6743f5d23a048db1a57ae"
+  "gitHead": "0bbe168c66929877174b331c71f7666bb16529d6"
 }

package/src/errors/validation.ts

@@ -6,7 +6,6 @@ import { AmplifyErrorMap } from '@aws-amplify/core/internals/utils';
 export enum AnalyticsValidationErrorCode {
 	NoAppId = 'NoAppId',
 	NoCredentials = 'NoCredentials',
-	NoEvent = 'NoEvent',
 	NoEventName = 'NoEventName',
 	NoRegion = 'NoRegion',
 }
@@ -19,9 +18,6 @@ export const validationErrorMap: AmplifyErrorMap<AnalyticsValidationErrorCode> =
 		[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.',
 		},

package/src/providers/kinesis-firehose/apis/index.ts

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

package/src/providers/kinesis-firehose/apis/record.ts

@@ -0,0 +1,8 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { RecordInput } from '../types';
+
+export const record = (input: RecordInput): void => {
+	throw new Error('Not Yet Implemented');
+};

package/src/providers/kinesis-firehose/index.ts

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

package/src/providers/kinesis-firehose/types/index.ts

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

package/src/providers/kinesis-firehose/types/inputs.ts

@@ -0,0 +1,4 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export type RecordInput = {};

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

@@ -17,32 +17,34 @@ import { resolveConfig, resolveCredentials } from '../utils';
  *  API.
  *
  * @throws service: {@link UpdateEndpointException} - Thrown when the underlying Pinpoint service returns an error.
- * @throws validation: {@link AnalyticsValidationErrorCode} - Thrown when the provided parameters or library 
+ * @throws validation: {@link AnalyticsValidationErrorCode} - Thrown when the provided parameters or library
  *  configuration is incorrect.
- * 
+ *
  * @returns A promise that will resolve when the operation is complete.
- * 
+ *
  * @example
  * ```ts
  * // Identify a user with Pinpoint
  * await identifyUser({
  *     userId,
  *     userProfile: {
- *         attributes: {
- *             email: [userEmail],
+ *         email: [userEmail]
+ *         customProperties: {
+ *             phoneNumber: ['555-555-5555'],
  *         },
  *     }
  * });
  * ```
- * 
+ *
  * @example
  * ```ts
  * // Identify a user with Pinpoint with some additional demographics
  * await identifyUser({
  *     userId,
  *     userProfile: {
- *         attributes: {
- *             email: [userEmail],
+ *         email: [userEmail]
+ *         customProperties: {
+ *             phoneNumber: ['555-555-5555'],
  *         },
  *         demographic: {
  *             platform: 'ios',
@@ -54,15 +56,18 @@ import { resolveConfig, resolveCredentials } from '../utils';
 export const identifyUser = async ({
 	userId,
 	userProfile,
+	options,
 }: IdentifyUserInput): Promise<void> => {
 	const { credentials, identityId } = await resolveCredentials();
 	const { appId, region } = resolveConfig();
+	const { userAttributes } = options?.serviceOptions ?? {};
 	updateEndpoint({
 		appId,
 		category: 'Analytics',
 		credentials,
 		identityId,
 		region,
+		userAttributes,
 		userId,
 		userProfile,
 		userAgentValue: getAnalyticsUserAgentString(AnalyticsAction.UpdateEndpoint),

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

@@ -21,40 +21,33 @@ const logger = new Logger('Analytics');
  *
  * @param {RecordInput} params The input object used to construct the request.
  *
- * @throws validation: {@link AnalyticsValidationErrorCode} - Thrown when the provided parameters or library 
+ * @throws validation: {@link AnalyticsValidationErrorCode} - Thrown when the provided parameters or library
  *  configuration is incorrect.
- * 
+ *
  * @example
  * ```ts
  * // Send an event to Pinpoint
- * record({
- *     event: {
- * 	       name: eventName,
- *     }
- * })
+ * record({ name: eventName })
  * ```
- * 
+ *
  * @example
  * ```ts
  * // Send an event to Pinpoint with metrics & custom attributes
  * record({
- *     event: {
- *         name: eventName,
- *         attributes: {
- *             'my-attribute': attributeValue
- *         },
- *         metrics: {
- *             'my-metric': metricValue
- *         }
+ *     name: eventName,
+ *     attributes: {
+ *         'my-attribute': attributeValue
+ *     },
+ *     metrics: {
+ *         'my-metric': metricValue
  *     }
  * })
  * ```
  */
-export const record = ({ event }: RecordInput): void => {
+export const record = (input: RecordInput): void => {
 	const { appId, region } = resolveConfig();
 
-	assertValidationError(!!event, AnalyticsValidationErrorCode.NoEvent);
-	assertValidationError(!!event.name, AnalyticsValidationErrorCode.NoEventName);
+	assertValidationError(!!input.name, AnalyticsValidationErrorCode.NoEventName);
 
 	resolveCredentials()
 		.then(({ credentials, identityId }) => {
@@ -62,7 +55,7 @@ export const record = ({ event }: RecordInput): void => {
 				appId,
 				category: 'Analytics',
 				credentials,
-				event,
+				event: input,
 				identityId,
 				region,
 				userAgentValue: getAnalyticsUserAgentString(AnalyticsAction.Record),

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

@@ -3,3 +3,4 @@
 
 export { UpdateEndpointException } from './errors';
 export { RecordInput, IdentifyUserInput } from './inputs';
+export { IdentifyUserOptions } from './options';

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

@@ -1,30 +1,16 @@
 // 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';
+import { IdentifyUserOptions } from '.';
+import { AnalyticsIdentifyUserInput } from '../../../types';
 
 /**
  * Input type for Pinpoint record API.
  */
-export type RecordInput = {
-	/**
-	 * An event to send to the default Analytics provider.
-	 */
-	event: PinpointAnalyticsEvent;
-};
+export type RecordInput = PinpointAnalyticsEvent;
 
 /**
  * Input type for Pinpoint identifyUser API.
  */
-export type IdentifyUserInput = {
-	/**
-	 * A User ID associated to the current device.
-	 */
-	userId: string;
-
-	/**
-	 * Additional information about the user and their device.
-	 */
-	userProfile: UserProfile;
-};
+export type IdentifyUserInput = AnalyticsIdentifyUserInput<IdentifyUserOptions>;

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

@@ -0,0 +1,12 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { PinpointServiceOptions } from '@aws-amplify/core/internals/providers/pinpoint';
+
+/**
+ * Options specific to Pinpoint identityUser.
+ */
+export type IdentifyUserOptions = Pick<
+	PinpointServiceOptions,
+	'userAttributes'
+>;

package/src/types/analytics.ts

@@ -13,7 +13,7 @@ export interface EventMetrics {
 	[key: string]: number;
 }
 
-export interface pageViewTrackOpts {
+export interface PageViewTrackOpts {
 	enable: boolean;
 	type?: string;
 	eventName?: string;

package/src/types/index.ts

@@ -1,4 +1,18 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-export * from './analytics';
+export {
+	AutoTrackAttributes,
+	AutoTrackEventOpts,
+	AutoTrackPageViewOpts,
+	AutoTrackSessionOpts,
+	EventAttributes,
+	EventMetrics,
+	EventTrackOpts,
+	PageViewTrackOpts,
+	SessionTrackOpts,
+} from './analytics';
+
+export { AnalyticsServiceOptions } from './options';
+
+export { AnalyticsIdentifyUserInput } from './inputs';

package/src/types/inputs.ts

@@ -0,0 +1,29 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { UserProfile } from '@aws-amplify/core';
+import { AnalyticsServiceOptions } from '.';
+
+/**
+ * Input type for `identifyUser`.
+ */
+export type AnalyticsIdentifyUserInput<
+	ServiceOptions extends AnalyticsServiceOptions = AnalyticsServiceOptions
+> = {
+	/**
+	 * A User ID associated to the current device.
+	 */
+	userId: string;
+
+	/**
+	 * Additional information about the user and their device.
+	 */
+	userProfile: UserProfile;
+
+	/**
+	 * Options to be passed to the API.
+	 */
+	options?: {
+		serviceOptions?: ServiceOptions;
+	};
+};

package/src/types/options.ts

@@ -0,0 +1,7 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * Base type for service options.
+ */
+export type AnalyticsServiceOptions = any;