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

package/src/apis/disable.ts

@@ -0,0 +1,13 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { disableAnalytics } from '../utils';
+
+/**
+ * Disables the Analytics category.
+ *
+ * @note
+ * When Analytics is disabled events will not be buffered or transmitted to your selected service. Any auto-tracking
+ * behavior that you have configured via `configureAutoTrack` will not have any effect while Analytics is disabled.
+ */
+export const disable = disableAnalytics;

package/src/apis/enable.ts

@@ -0,0 +1,12 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { enableAnalytics } from '../utils';
+
+/**
+ * Enables the Analytics category to permit the transmission of events.
+ *
+ * @note
+ * Analytics is enabled by default. You do not need to call this API unless you have disabled Analytics.
+ */
+export const enable = enableAnalytics;

package/src/apis/index.ts

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

package/src/index.ts

@@ -7,4 +7,5 @@ export {
 	RecordInput,
 	IdentifyUserInput,
 } from './providers/pinpoint';
+export { enable, disable } from './apis';
 export { AnalyticsError } from './errors';

package/src/providers/kinesis/index.ts

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

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

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

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

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

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

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

package/src/providers/personalize/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/personalize/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/personalize/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 './apis';

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

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

package/src/providers/personalize/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

@@ -4,7 +4,7 @@
 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 { getAnalyticsUserAgentString } from '../../../utils';
 import { IdentifyUserInput, UpdateEndpointException } from '../types';
 import { resolveConfig, resolveCredentials } from '../utils';
 

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

@@ -10,7 +10,10 @@ import {
 	AnalyticsValidationErrorCode,
 	assertValidationError,
 } from '../../../errors';
-import { getAnalyticsUserAgentString } from '../../../utils/userAgent';
+import {
+	getAnalyticsUserAgentString,
+	isAnalyticsEnabled,
+} from '../../../utils';
 import { RecordInput } from '../types';
 import { resolveConfig, resolveCredentials } from '../utils';
 
@@ -47,6 +50,11 @@ const logger = new Logger('Analytics');
 export const record = (input: RecordInput): void => {
 	const { appId, region } = resolveConfig();
 
+	if (!isAnalyticsEnabled()) {
+		logger.debug('Analytics is disabled, event will not be recorded.');
+		return;
+	}
+
 	assertValidationError(!!input.name, AnalyticsValidationErrorCode.NoEventName);
 
 	resolveCredentials()

package/src/utils/index.ts

@@ -0,0 +1,12 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export {
+	enableAnalytics,
+	disableAnalytics,
+	isAnalyticsEnabled,
+} from './statusHelpers';
+export {
+	getAnalyticsUserAgent,
+	getAnalyticsUserAgentString,
+} from './userAgent';

package/src/utils/statusHelpers.ts

@@ -0,0 +1,17 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+let analyticsEnabled = true;
+
+export const enableAnalytics = () => {
+	analyticsEnabled = true;
+};
+
+export const disableAnalytics = () => {
+	analyticsEnabled = false;
+};
+
+/**
+ * Returns the current status of the Analytics category.
+ */
+export const isAnalyticsEnabled = () => analyticsEnabled;