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

package/lib/apis/disable.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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 declare const disable: () => void;

package/lib/apis/disable.js

@@ -0,0 +1,14 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.disable = void 0;
+var utils_1 = require("../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.
+ */
+exports.disable = utils_1.disableAnalytics;

package/lib/apis/enable.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 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 declare const enable: () => void;

package/lib/apis/enable.js

@@ -0,0 +1,13 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.enable = void 0;
+var utils_1 = require("../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.
+ */
+exports.enable = utils_1.enableAnalytics;

package/lib/apis/index.d.ts

@@ -0,0 +1,2 @@
+export { enable } from './enable';
+export { disable } from './disable';

package/lib/apis/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.disable = exports.enable = void 0;
+var enable_1 = require("./enable");
+Object.defineProperty(exports, "enable", { enumerable: true, get: function () { return enable_1.enable; } });
+var disable_1 = require("./disable");
+Object.defineProperty(exports, "disable", { enumerable: true, get: function () { return disable_1.disable; } });

package/lib/index.d.ts

@@ -1,2 +1,3 @@
 export { record, identifyUser, RecordInput, IdentifyUserInput, } from './providers/pinpoint';
+export { enable, disable } from './apis';
 export { AnalyticsError } from './errors';

package/lib/index.js

@@ -2,9 +2,12 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AnalyticsError = exports.identifyUser = exports.record = void 0;
+exports.AnalyticsError = exports.disable = exports.enable = exports.identifyUser = exports.record = void 0;
 var pinpoint_1 = require("./providers/pinpoint");
 Object.defineProperty(exports, "record", { enumerable: true, get: function () { return pinpoint_1.record; } });
 Object.defineProperty(exports, "identifyUser", { enumerable: true, get: function () { return pinpoint_1.identifyUser; } });
+var apis_1 = require("./apis");
+Object.defineProperty(exports, "enable", { enumerable: true, get: function () { return apis_1.enable; } });
+Object.defineProperty(exports, "disable", { enumerable: true, get: function () { return apis_1.disable; } });
 var errors_1 = require("./errors");
 Object.defineProperty(exports, "AnalyticsError", { enumerable: true, get: function () { return errors_1.AnalyticsError; } });

package/lib/providers/kinesis/index.d.ts

@@ -1 +1 @@
-export * from './apis';
+export { record } from './apis';

package/lib/providers/kinesis/index.js

@@ -2,5 +2,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
-var tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./apis"), exports);
+exports.record = void 0;
+var apis_1 = require("./apis");
+Object.defineProperty(exports, "record", { enumerable: true, get: function () { return apis_1.record; } });

package/lib/providers/kinesis/types/index.d.ts

@@ -1 +1 @@
-export * from './inputs';
+export { RecordInput } from './inputs';

package/lib/providers/kinesis/types/index.js

@@ -2,5 +2,3 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
-var tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./inputs"), exports);

package/lib/providers/kinesis-firehose/index.d.ts

@@ -1 +1 @@
-export * from './apis';
+export { record } from './apis';

package/lib/providers/kinesis-firehose/index.js

@@ -2,5 +2,6 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
-var tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./apis"), exports);
+exports.record = void 0;
+var apis_1 = require("./apis");
+Object.defineProperty(exports, "record", { enumerable: true, get: function () { return apis_1.record; } });

package/lib/providers/kinesis-firehose/types/index.d.ts

@@ -1 +1 @@
-export * from './inputs';
+export { RecordInput } from './inputs';

package/lib/providers/kinesis-firehose/types/index.js

@@ -2,5 +2,3 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
-var tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./inputs"), exports);

package/lib/providers/personalize/apis/index.d.ts

@@ -0,0 +1 @@
+export { record } from './record';

package/lib/providers/personalize/apis/index.js

@@ -0,0 +1,7 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.record = void 0;
+var record_1 = require("./record");
+Object.defineProperty(exports, "record", { enumerable: true, get: function () { return record_1.record; } });

package/lib/providers/personalize/apis/record.d.ts

@@ -0,0 +1,2 @@
+import { RecordInput } from '../types';
+export declare const record: (input: RecordInput) => void;

package/lib/providers/personalize/apis/record.js

@@ -0,0 +1,9 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.record = void 0;
+var record = function (input) {
+    throw new Error('Not Yet Implemented');
+};
+exports.record = record;

package/lib/providers/personalize/index.d.ts

@@ -0,0 +1 @@
+export { record } from './apis';

package/lib/providers/personalize/index.js

@@ -0,0 +1,7 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.record = void 0;
+var apis_1 = require("./apis");
+Object.defineProperty(exports, "record", { enumerable: true, get: function () { return apis_1.record; } });

package/lib/providers/personalize/types/index.d.ts

@@ -0,0 +1 @@
+export { RecordInput } from './inputs';

package/lib/providers/personalize/types/index.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/providers/personalize/types/inputs.d.ts

@@ -0,0 +1 @@
+export type RecordInput = {};

package/lib/providers/personalize/types/inputs.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/providers/pinpoint/apis/identifyUser.js

@@ -6,8 +6,8 @@ exports.identifyUser = void 0;
 var tslib_1 = require("tslib");
 var utils_1 = require("@aws-amplify/core/internals/utils");
 var pinpoint_1 = require("@aws-amplify/core/internals/providers/pinpoint");
-var userAgent_1 = require("../../../utils/userAgent");
-var utils_2 = require("../utils");
+var utils_2 = require("../../../utils");
+var utils_3 = require("../utils");
 /**
  * Sends information about a user to Pinpoint. Sending user information allows you to associate a user to their user
  * profile and activities or actions in your application. Activity can be tracked across devices & platforms by using
@@ -60,10 +60,10 @@ var identifyUser = function (_a) {
         var _d;
         return tslib_1.__generator(this, function (_e) {
             switch (_e.label) {
-                case 0: return [4 /*yield*/, (0, utils_2.resolveCredentials)()];
+                case 0: return [4 /*yield*/, (0, utils_3.resolveCredentials)()];
                 case 1:
                     _b = _e.sent(), credentials = _b.credentials, identityId = _b.identityId;
-                    _c = (0, utils_2.resolveConfig)(), appId = _c.appId, region = _c.region;
+                    _c = (0, utils_3.resolveConfig)(), appId = _c.appId, region = _c.region;
                     userAttributes = ((_d = options === null || options === void 0 ? void 0 : options.serviceOptions) !== null && _d !== void 0 ? _d : {}).userAttributes;
                     (0, pinpoint_1.updateEndpoint)({
                         appId: appId,
@@ -74,7 +74,7 @@ var identifyUser = function (_a) {
                         userAttributes: userAttributes,
                         userId: userId,
                         userProfile: userProfile,
-                        userAgentValue: (0, userAgent_1.getAnalyticsUserAgentString)(utils_1.AnalyticsAction.UpdateEndpoint),
+                        userAgentValue: (0, utils_2.getAnalyticsUserAgentString)(utils_1.AnalyticsAction.UpdateEndpoint),
                     });
                     return [2 /*return*/];
             }

package/lib/providers/pinpoint/apis/record.js

@@ -6,8 +6,8 @@ exports.record = void 0;
 var utils_1 = require("@aws-amplify/core/internals/utils");
 var pinpoint_1 = require("@aws-amplify/core/internals/providers/pinpoint");
 var errors_1 = require("../../../errors");
-var userAgent_1 = require("../../../utils/userAgent");
-var utils_2 = require("../utils");
+var utils_2 = require("../../../utils");
+var utils_3 = require("../utils");
 var logger = new utils_1.ConsoleLogger('Analytics');
 /**
  * Records an Analytic event to Pinpoint. Events will be buffered and periodically sent to Pinpoint.
@@ -38,9 +38,13 @@ var logger = new utils_1.ConsoleLogger('Analytics');
  * ```
  */
 var record = function (input) {
-    var _a = (0, utils_2.resolveConfig)(), appId = _a.appId, region = _a.region;
+    var _a = (0, utils_3.resolveConfig)(), appId = _a.appId, region = _a.region;
+    if (!(0, utils_2.isAnalyticsEnabled)()) {
+        logger.debug('Analytics is disabled, event will not be recorded.');
+        return;
+    }
     (0, errors_1.assertValidationError)(!!input.name, errors_1.AnalyticsValidationErrorCode.NoEventName);
-    (0, utils_2.resolveCredentials)()
+    (0, utils_3.resolveCredentials)()
         .then(function (_a) {
         var credentials = _a.credentials, identityId = _a.identityId;
         (0, pinpoint_1.record)({
@@ -50,7 +54,7 @@ var record = function (input) {
             event: input,
             identityId: identityId,
             region: region,
-            userAgentValue: (0, userAgent_1.getAnalyticsUserAgentString)(utils_1.AnalyticsAction.Record),
+            userAgentValue: (0, utils_2.getAnalyticsUserAgentString)(utils_1.AnalyticsAction.Record),
         });
     })
         .catch(function (e) {