@aws-amplify/analytics 7.0.1-console-preview.4208d73.0 → 7.0.1-console-preview.431c340.0

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,8 +1,9 @@
 // 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.
@@ -14,17 +15,4 @@ export type RecordInput = {
 	event: 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 '.';
+
+/**
+ * Constructs an `identifyUser` input.
+ */
+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;